mh5control.h File Reference

Implement MHEG5 engine control functions (i.e. start/stop etc) More...

#include "dvb_misc.h"
#include "mh5base.h"
#include "mheg5_control.h"
#include "fs_types.h"
#include "glue_queue.h"

Go to the source code of this file.

Macros
#define	ISO_639_LANG_CODE_UND   (U32BIT)(('u'<<16)|('n'<<8)|'d')/*0x756E64*/
#define	UND_LANGUAGE_CODE   ISO_639_LANG_CODE_UND

Enumerations
enum	E_StopAction { STOP_ACTION_CLEAR_DSMCC, STOP_ACTION_MHEG_TUNE, STOP_ACTION_CI_PLUS_NDT }

Functions
E_MhegErr	MHEG5Initialise (S_MhegConfig *cfg_params)
	initialise MHEG5 component More...
void	MHEG5_Terminate (void)
	Terminate MHEG5 component. More...
void	MHEG5engineStart (U8BIT *app_name, BOOLEAN isCi, BOOLEAN special)
	Start the engine with the initial application. More...
void	MHEG5engineTerminate (void)
	Force the engine to terminate. More...
BOOLEAN	MHEG5engineIsCiAppRunning (void)
void	MHEG5Pause (void)
void	MHEG5Resume (void)
U8BIT	MHEG5HandleEngineStopAction (U8BIT action)
void	MHEG5NotifyEngineStarted (void)
void	MHEG5NotifyEngineStartFailed (void)
void	MHEG5NotifyEngineQuit (void)
BOOLEAN	MHEG5ProcessAutoBoot (void)
void	MHEG5StartReboot (void *dummy)
E_MhegErr	MHEG5ResetResolution (U16BIT screenWidth, U16BIT screenHeight)
void	MHEG5RefreshDisplay (void)
void	MHEG5RefreshDefaultAudio (void)
void	MHEG5NotifyCarouselBooted (S_DsmccEvent *param)
void	MHEG5NotifyCarouselLoaded (S_DsmccEvent *param)
void	MHEG5NotifyCarouselUnload (S_DsmccEvent *param)
void	MHEG5AutoPathComplete (E_FsStatus result)
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...
void	MHEG5RefreshStreams (U16BIT service_id)
U32BIT	MHEG5tuneProcess (S_DvbLocator *pDvbLoc, S32BIT serviceIndex)
	Process the current tune for the target service. This is relevant when MHEG5 or CICAM has requested a tune, and DVB is notifying the tune has occured. More...

Detailed Description

Implement MHEG5 engine control functions (i.e. start/stop etc)

Date

30/08/2004

Author

Adam Sturtridge

Function Documentation

void MHEG5_Terminate

(

void

)

Terminate MHEG5 component.

Returns

none

void MHEG5engineDsmTerminate

(

void

)

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

Returns

none

BOOLEAN MHEG5engineIsCiAppRunning

(

void

)

Returns

TRUE if CI app exists

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

void MHEG5engineTerminate

(

void

)

Force the engine to terminate.

Returns

none

None.

E_MhegErr MHEG5Initialise

(

S_MhegConfig *

cfg_params

)

initialise MHEG5 component

Returns

MHERR_OK - success MHERR_INTERNAL - failure

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.

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 sucessful, else FALSE.

Parameters

tuneInfo

tuning information

Returns

TRUE if successful, else FALSE.

U32BIT MHEG5tuneProcess	(	S_DvbLocator *	pDvbLoc,
		S32BIT	serviceIndex
	)

Process the current tune for the target service. This is relevant when MHEG5 or CICAM has requested a tune, and DVB is notifying the tune has occured.

Parameters

pDvbLoc	DVB locator for the new service
serviceIndex	"Service Index" for the new service

Returns

carousel ID