(STB) can call directly. They build the interface to the MHEG5 engine. This file defines the api to the MHEG engine and the functions the engine needs from the system to run properly. All engine specific functions start with |MHEG5|, all system specific functions start with |OSD|. More...

#include "mheg5_events.h"
#include "dvb_service.h"
#include "dvb_native.h"
#include "mh5application.h"
#include "mh5scene.h"
#include "mh5queue.h"
#include "glue_memory.h"
#include "glue_queue.h"
#include "glue_timers.h"
#include "glue_main.h"
#include "glue_debug.h"
#include "mh5display.h"
#include "mh5fileorm.h"
#include "mh5misc.h"
#include "mh5streamevent.h"
#include "mh5gate.h"
#include "mg_osd.h"
#include "mg_api.h"
#include "dvb_video.h"
#include "dvb_audio.h"
#include "mh5storage.h"
#include "glue_dsmcc.h"
#include "dsm_control.h"
#include "mh5control.h"
#include "mh5keypress.h"
#include "mheg5_ci.h"

Macros
#define	MAX_HANDLERS 2

#define	ENG_STAT_STRING()

#define	TINFO_QUIET_BIT 0x01

#define	TINFO_NON_DESTRUCT_BIT 0x02

#define	TINFO_EXPLICIT_CRSL_BIT 0x04

#define	TINFO_MAP_CRSL_INIT_BIT 0x08

#define	TINFO_NATIVE_APP_BIT 0x10

#define	LC_STATE_NONE 0x00

#define	LC_STATE_QUIET TINFO_QUIET_BIT

#define	LC_STATE_NDT_ENABLE TINFO_NON_DESTRUCT_BIT

#define	LC_STATE_NATIVE_APP TINFO_NATIVE_APP_BIT

#define	LC_STATE_MHG_TUNING 0x80

#define	INVALID_CI_MODULE 0xFFFFFFFF

#define	InformCiAppStopped(sc)

#define	CI_APP_ABORT_SYSTEM 0x02

Enumerations
enum	E_ENGINE_STATUS { ENG_STOPPED, ENG_DSM_STARTING, ENG_DSM_STARTED, ENG_CI_STARTING, ENG_CI_STARTED }

enum	E_SPECIAL_APP { SA_NORMAL, SA_EPG, SA_INFO, SA_LIST }

Functions
int	ASN1_MemInit (void)

void	ASN1_MemExit (void)

E_MhegErr	MHEG5Initialise (S_MhegConfig *cfg_params)
	initialise MHEG5 component More...

void	MHEG5_Terminate (void)
	Terminate MHEG5 component. More...

void	MHEG5RefreshDisplay (void)

E_MhegErr	MHEG5ResetResolution (U16BIT screenWidth, U16BIT screenHeight)

void	MHEG5NotifyEvent (E_MhegEvent event, U32BIT data)

BOOLEAN	MHEG5_DvbRegisterEventHandler (F_NotifyMhegEvent handler)

void	MHEG5_DvbUnregisterEventHandler (F_NotifyMhegEvent handler)

void	MHEG5engineStart (U8BIT *app_name, BOOLEAN isCi, BOOLEAN special)
	Start the engine with the initial application. More...

void	MHEG5NotifyEngineStarted (void)

void	MHEG5NotifyCarouselBooted (S_DsmccEvent *param)

void	MHEG5AutoPathComplete (E_FsStatus result)

void	MHEG5NotifyEngineStartFailed (void)

void	MHEG5NotifyEngineQuit (void)

void	MHEG5engineTerminate (void)
	Force the engine to terminate. More...

void	MHEG5engineDsmTerminate (void)
	Force the engine to terminate any DSM-CC based MHEG application. More...

MHEG5Bool	MHEG5TuneIndex (MHEG5Int serviceIndex)
	Ref: [1] - 3.10.6.2 Tune to the specified service. If the tuner fails to tune to the service it should attempt to return to the previous tuned service. If tuning to previously tuned service fails, the receiver shall allow the user to choose another service. More...

void	MHEG5TuneIndexInfo (MHEG5Int tuneInfo)
	Sets the way the application expects the receiver is to perform all subsequence application initiated tuning. Normal (0) means subsequent tuning will be performed as if the user had tuned via the remote control. Silently (1) means subsequent tuning will be performed without showing any OSD (channel info banner) and the user initiating a channel change will use the source channel as the reference point This function is used by the SI_TuneIndexInfo resident program. See UK1.06 profile section 3.10.6.4. More...

E_ChannelStartMode	MHEG5_GetTuningInfoMode (S32BIT serviceIndex)
	Get the current tuning mode for the target service. This is only relevant when MHEG5 has requested a tune, and DVB has not yet tuned to that service. More...

U32BIT	MHEG5tuneProcess (S_DvbLocator *pDvbLoc, S32BIT serviceIndex)

void	MHEG5NotifyCarouselLoaded (S_DsmccEvent *param)

void	MHEG5NotifyCarouselUnload (S_DsmccEvent *param)

BOOLEAN	MHEG5isProcessingNDT (BOOLEAN *native_app_ok)

U8BIT	MHEG5HandleEngineStopAction (U8BIT action)

BOOLEAN	MHEG5engineIsCiAppRunning (void)

void	MHEG5StartReboot (void *param)

void	MHEG5Pause (void)

void	MHEG5Resume (void)

void	MHEG5RefreshStreams (U16BIT service_id)

void	MHEG5RefreshDefaultAudio (void)

Detailed Description

(STB) can call directly. They build the interface to the MHEG5 engine. This file defines the api to the MHEG engine and the functions the engine needs from the system to run properly. All engine specific functions start with |MHEG5|, all system specific functions start with |OSD|.

Date: 01/02/2002

Author: R.Freeman

Definition in file mh5control.c.

Macro Definition Documentation

#define CI_APP_ABORT_SYSTEM 0x02

Definition at line 124 of file mh5control.c.

#define ENG_STAT_STRING ( )

Value:

(mheg_engine_status == ENG_STOPPED) ? "STOPPED" : \
   (mheg_engine_status == ENG_DSM_STARTING) ? "STARTING DSM" : \
   (mheg_engine_status == ENG_DSM_STARTED) ? "STARTED DSM" : \
   (mheg_engine_status == ENG_CI_STARTING) ? "STARTING CI" : "STARTED CI"

Definition at line 103 of file mh5control.c.

#define InformCiAppStopped ( sc )

Definition at line 123 of file mh5control.c.

#define INVALID_CI_MODULE 0xFFFFFFFF

Definition at line 120 of file mh5control.c.

#define LC_STATE_MHG_TUNING 0x80

Definition at line 118 of file mh5control.c.

#define LC_STATE_NATIVE_APP TINFO_NATIVE_APP_BIT

Definition at line 117 of file mh5control.c.

#define LC_STATE_NDT_ENABLE TINFO_NON_DESTRUCT_BIT

Definition at line 116 of file mh5control.c.

#define LC_STATE_NONE 0x00

Definition at line 114 of file mh5control.c.

#define LC_STATE_QUIET TINFO_QUIET_BIT

Definition at line 115 of file mh5control.c.

#define MAX_HANDLERS 2

Definition at line 101 of file mh5control.c.

#define TINFO_EXPLICIT_CRSL_BIT 0x04

Definition at line 110 of file mh5control.c.

#define TINFO_MAP_CRSL_INIT_BIT 0x08

Definition at line 111 of file mh5control.c.

#define TINFO_NATIVE_APP_BIT 0x10

Definition at line 112 of file mh5control.c.

#define TINFO_NON_DESTRUCT_BIT 0x02

Definition at line 109 of file mh5control.c.

#define TINFO_QUIET_BIT 0x01

Definition at line 108 of file mh5control.c.

Enumeration Type Documentation

enum E_ENGINE_STATUS

Enumerator
ENG_STOPPED
ENG_DSM_STARTING
ENG_DSM_STARTED
ENG_CI_STARTING
ENG_CI_STARTED

Definition at line 132 of file mh5control.c.

enum E_SPECIAL_APP

Enumerator
SA_NORMAL
SA_EPG
SA_INFO
SA_LIST

Definition at line 150 of file mh5control.c.

Function Documentation

void ASN1_MemExit ( void )

Definition at line 233 of file fpa1_BlockAlloc.c.

int ASN1_MemInit ( void )

Definition at line 220 of file fpa1_BlockAlloc.c.

BOOLEAN MHEG5_DvbRegisterEventHandler ( F_NotifyMhegEvent handler )

Definition at line 413 of file mh5control.c.

void MHEG5_DvbUnregisterEventHandler ( F_NotifyMhegEvent handler )

Definition at line 427 of file mh5control.c.

E_ChannelStartMode MHEG5_GetTuningInfoMode ( S32BIT serviceIndex )

Get the current tuning mode for the target service. This is only relevant when MHEG5 has requested a tune, and DVB has not yet tuned to that service.

Get the current tuning mode for the target service. This is only relevant when MHEG5 has requested a tune, and DVB has not yet tuned to that service. The return value will be the same as that given back by next call to MHEG5_Start().

Parameters

serviceIndex "Service Index" for the new service

Returns: E_ChannelStartMode

Definition at line 934 of file mh5control.c.

void MHEG5_Terminate ( void )

Terminate MHEG5 component.

Returns: none

Definition at line 263 of file mh5control.c.

void MHEG5AutoPathComplete ( E_FsStatus result )

Definition at line 586 of file mh5control.c.

void MHEG5engineDsmTerminate ( void )

Force the engine to terminate any DSM-CC based MHEG application.

Returns: none

Definition at line 831 of file mh5control.c.

BOOLEAN MHEG5engineIsCiAppRunning ( void )

Returns: TRUE if CI app exists

Definition at line 1158 of file mh5control.c.

void MHEG5engineStart	(	U8BIT *	app_name,
		BOOLEAN	isCi,
		BOOLEAN	special
	)

Start the engine with the initial application.

Parameters

app_name	Name of initial application
isCi	TRUE if started from StartCIApp
special	TRUE when special App (EPG/Info/Slist App)

Returns: void

Definition at line 447 of file mh5control.c.

void MHEG5engineTerminate ( void )

Force the engine to terminate.

Returns: None.

Definition at line 712 of file mh5control.c.

U8BIT MHEG5HandleEngineStopAction ( U8BIT action )

Definition at line 1096 of file mh5control.c.

E_MhegErr MHEG5Initialise ( S_MhegConfig * cfg_params )

initialise MHEG5 component

Returns: MHERR_OK - success MHERR_INTERNAL - failure

Definition at line 203 of file mh5control.c.

BOOLEAN MHEG5isProcessingNDT ( BOOLEAN * native_app_ok )

Definition at line 1074 of file mh5control.c.

void MHEG5NotifyCarouselBooted ( S_DsmccEvent * param )

Definition at line 564 of file mh5control.c.

void MHEG5NotifyCarouselLoaded ( S_DsmccEvent * param )

Definition at line 1037 of file mh5control.c.

void MHEG5NotifyCarouselUnload ( S_DsmccEvent * param )

Definition at line 1061 of file mh5control.c.

void MHEG5NotifyEngineQuit ( void )

Definition at line 679 of file mh5control.c.

void MHEG5NotifyEngineStarted ( void )

Definition at line 545 of file mh5control.c.

void MHEG5NotifyEngineStartFailed ( void )

Definition at line 640 of file mh5control.c.

void MHEG5NotifyEvent	(	E_MhegEvent	event,
		U32BIT	data
	)

Definition at line 401 of file mh5control.c.

void MHEG5Pause ( void )

Definition at line 1183 of file mh5control.c.

void MHEG5RefreshDefaultAudio ( void )

Definition at line 1232 of file mh5control.c.

void MHEG5RefreshDisplay ( void )

Definition at line 285 of file mh5control.c.

void MHEG5RefreshStreams ( U16BIT service_id )

Definition at line 1211 of file mh5control.c.

E_MhegErr MHEG5ResetResolution	(	U16BIT	screenWidth,
		U16BIT	screenHeight
	)

Definition at line 329 of file mh5control.c.

void MHEG5Resume ( void )

Definition at line 1191 of file mh5control.c.

void MHEG5StartReboot ( void * param )

Definition at line 1164 of file mh5control.c.

MHEG5Bool MHEG5TuneIndex ( MHEG5Int serviceIndex )

Ref: [1] - 3.10.6.2 Tune to the specified service. If the tuner fails to tune to the service it should attempt to return to the previous tuned service. If tuning to previously tuned service fails, the receiver shall allow the user to choose another service.

Parameters

serviceIndex The service to which the tuner is to attempt to tune.

Returns: Boolean MHEG5TRUE - service available. MHEG5FALSE - service not available.

Definition at line 852 of file mh5control.c.

void MHEG5TuneIndexInfo ( MHEG5Int tuneInfo )

Sets the way the application expects the receiver is to perform all subsequence application initiated tuning. Normal (0) means subsequent tuning will be performed as if the user had tuned via the remote control. Silently (1) means subsequent tuning will be performed without showing any OSD (channel info banner) and the user initiating a channel change will use the source channel as the reference point This function is used by the SI_TuneIndexInfo resident program. See UK1.06 profile section 3.10.6.4.

Parameters

tuneInfo tuning information

Returns: TRUE if successful, else FALSE.

Definition at line 882 of file mh5control.c.

U32BIT MHEG5tuneProcess	(	S_DvbLocator *	pDvbLoc,
		S32BIT	serviceIndex
	)

Definition at line 955 of file mh5control.c.

Macros

Enumerations

Functions

Detailed Description

Macro Definition Documentation

Enumeration Type Documentation

Function Documentation