midware/stb/inc/stbebutt.h File Reference

Header file - EBU Teletext driver. More...

Go to the source code of this file.

Data Structures
struct	s_ebutt_font
Typedefs
typedef enum e_ebutt_event	E_EBUTT_EVENT
typedef enum e_ebutt_caching_method	E_EBUTT_CACHING_METHOD
typedef enum e_ebutt_character_set_designation	E_EBUTT_CHARACTER_SET_DESIGNATION
typedef struct s_ebutt_font	S_EBUTT_FONT
Enumerations
enum	e_ebutt_event {   EBUTT_EVENT_QUICK_NAVIGATE_1, EBUTT_EVENT_QUICK_NAVIGATE_2, EBUTT_EVENT_QUICK_NAVIGATE_3, EBUTT_EVENT_QUICK_NAVIGATE_4,   EBUTT_EVENT_0, EBUTT_EVENT_1, EBUTT_EVENT_2, EBUTT_EVENT_3,   EBUTT_EVENT_4, EBUTT_EVENT_5, EBUTT_EVENT_6, EBUTT_EVENT_7,   EBUTT_EVENT_8, EBUTT_EVENT_9, EBUTT_EVENT_INDEXPAGE, EBUTT_EVENT_NEXTPAGE,   EBUTT_EVENT_PREVIOUSPAGE, EBUTT_EVENT_NEXTSUBPAGE, EBUTT_EVENT_PREVIOUSSUBPAGE, EBUTT_EVENT_BACKPAGE,   EBUTT_EVENT_FORWARDPAGE, EBUTT_EVENT_HOLD, EBUTT_EVENT_REVEAL, EBUTT_EVENT_CLEAR,   EBUTT_EVENT_MIX_VIDEO, EBUTT_EVENT_DOUBLE_HEIGHT, EBUTT_EVENT_DOUBLE_SCROLL_UP, EBUTT_EVENT_DOUBLE_SCROLL_DOWN,   EBUTT_EVENT_TIMER }
enum	e_ebutt_caching_method {   EBUTT_CACHING_METHOD_NONE = 0, EBUTT_CACHING_METHOD_PREVIOUS_NEXT, EBUTT_CACHING_METHOD_HISTORY, EBUTT_CACHING_METHOD_NAVIGATION,   EBUTT_CACHING_METHOD_NAVIGATION_TREE, EBUTT_CACHING_METHOD_ALL }
enum	e_ebutt_character_set_designation {   EBUTT_CHARACTER_SET_DESIGNATION_LATIN_DEFAULT = 0, EBUTT_CHARACTER_SET_DESIGNATION_LATIN_POLISH = 1, EBUTT_CHARACTER_SET_DESIGNATION_LATIN_TURKISH = 2, EBUTT_CHARACTER_SET_DESIGNATION_LATIN_SERBIAN_RUMANIAN = 3,   EBUTT_CHARACTER_SET_DESIGNATION_CYRILLIC = 4, EBUTT_CHARACTER_SET_DESIGNATION_GREEK_TURKISH = 6, EBUTT_CHARACTER_SET_DESIGNATION_LATIN_ARABIC = 8, EBUTT_CHARACTER_SET_DESIGNATION_HEBREW_ARABIC = 10 }
Functions
BOOLEAN	STB_EBUTT_Initialise (void)
void	STB_EBUTT_Kill (U8BIT path)
void	STB_EBUTT_Start (U8BIT path, U16BIT text_pid, U8BIT magazine, U8BIT page)
void	STB_EBUTT_Stop (U8BIT path, BOOLEAN reset_cache)
BOOLEAN	STB_EBUTT_InjectData (U8BIT *data_ptr, U32BIT data_length)
	Allows teletext PES data packets to be injected by an external module, which will be decoded and displayed.
BOOLEAN	STB_EBUTT_Show (E_EBUTT_CHARACTER_SET_DESIGNATION character_set_designation, BOOLEAN navigate_to_index_page, BOOLEAN show_header)
void	STB_EBUTT_Hide (void)
void	STB_EBUTT_SetCacheMethod (E_EBUTT_CACHING_METHOD ebutt_caching_method)
void	STB_EBUTT_NotifyEvent (E_EBUTT_EVENT event_type)
void	STB_EBUTT_NotifyServiceChange (void)
void	STB_EBUTT_SetDisplayBrightness (U8BIT gun_intensity)
void	STB_EBUTT_IncreaseDisplayBrightness (void)
void	STB_EBUTT_DecreaseDisplayBrightness (void)
void	STB_EBUTT_SetDisplayAntiAliasing (U8BIT antialias_level)
void	STB_EBUTT_IncreaseDisplayAntiAliasing (void)
void	STB_EBUTT_DecreaseDisplayAntiAliasing (void)
void	STB_EBUTT_SetDisplayMixTransparency (U8BIT transparency_level)
void	STB_EBUTT_IncreaseDisplayMixTransparency (void)
void	STB_EBUTT_DecreaseDisplayMixTransparency (void)
BOOLEAN	STB_EBUTT_IsDisplayHeld (void)
BOOLEAN	STB_EBUTT_IsDisplayDoubleHeight (void)
Variables
const S_EBUTT_FONT *const	ebutt_font_ptr

---

Detailed Description

Header file - EBU Teletext driver.

Date:

04/02/2004

Author:

Ocean Blue

---

Function Documentation

BOOLEAN STB_EBUTT_InjectData	(	U8BIT *	data_ptr,
		U32BIT	data_length
	)

Allows teletext PES data packets to be injected by an external module, which will be decoded and displayed.

**************************************************************************

Parameters:

data_ptr	- pointer to first whole PES packet data
data_length	- number of bytes of data provided

Returns:

TRUE if the data is valid EBU teletext PES data, FALSE otherwise