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"

Go to the source code of this file.

Enumerations
enum	E_StopAction { STOP_ACTION_CLEAR_DSMCC, STOP_ACTION_MHEG_TUNE }

Functions
E_MhegErr	MHEG5Initialise (S_MhegConfig *cfg_params)
	initialise MHEG5 component More...
void	MHEG5_Terminate (void)
	Terminate MHEG5 component. More...
void	MHEG5engineStart (U8BIT *application, BOOLEAN isCi)
	Start the engine with the initial application. More...
void	MHEG5engineTerminate (void)
	Force the engine to terminate. More...
BOOLEAN	MHEG5engineDsmTerminate (void)
	Force the engine to terminate any DSM-CC based MHEG application. 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	MHEG5ProcessDsmccBooted (void *carousel)
void	MHEG5NotifyServiceInfoChanged (U16BIT service_id)
void	MHEG5StartReboot (void *dummy)
E_MhegErr	MHEG5ResetResolution (U16BIT screenWidth, U16BIT screenHeight)
void	MHEG5RefreshDisplay (void)
void	MHEG5NotifyCarouselUnload (void *carousel)
void	MHEG5AutoPathComplete (E_FsStatus result)
void	MHEG5CiAckData (U8BIT *pData)
	Acknowledge receipt of the data or message from the CI, so that the CI component can free or reuse the memory. This function is invoked after data has been returned from the CI component as a result of a call to either DVB_MhegCiGetFile() or DVB_MhegCiSendMessage() This MUST be a non-blocking function. See functions DVB_MhegCiGetFile() and DVB_MhegCiSendMessage(). 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	MHEG5TuningInfoMode (S32BIT serviceIndex)
U32BIT	MHEG5tuneProcess (S_DvbLocator *pDvbLoc, S32BIT serviceIndex)

Detailed Description

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

Date

30/08/2004

Author

Adam Sturtridge

Enumeration Type Documentation

enum E_StopAction

Enumerator
STOP_ACTION_CLEAR_DSMCC
STOP_ACTION_MHEG_TUNE

Function Documentation

void MHEG5_Terminate

(

void

)

Terminate MHEG5 component.

Returns

none

void MHEG5AutoPathComplete

(

E_FsStatus

result

)

void MHEG5CiAckData

(

U8BIT *

pData

)

Acknowledge receipt of the data or message from the CI, so that the CI component can free or reuse the memory. This function is invoked after data has been returned from the CI component as a result of a call to either DVB_MhegCiGetFile() or DVB_MhegCiSendMessage() This MUST be a non-blocking function. See functions DVB_MhegCiGetFile() and DVB_MhegCiSendMessage().

Parameters

pData

Reference to the memory location of the data or message.

Returns

The following return values are allowed from this function (see note [a]): MHERR_OK - Success. MHERR_BAD_PARAMETER - Invalid parameter. MHERR_OTHER - Controlling application specific error. The return value from this function is for debug purposes only and will be ignored in retail mode.

BOOLEAN MHEG5engineDsmTerminate

(

void

)

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

Returns

TRUE if app existed and was terminated.

BOOLEAN MHEG5engineIsCiAppRunning

(

void

)

Returns

TRUE if CI app exists

void MHEG5engineStart	(	U8BIT *	app_name,
		BOOLEAN	isCi
	)

Start the engine with the initial application.

Parameters

application

Start application name and path.

Returns

0 on success <0 on failure

Parameters

application

Start application name and path.

Returns

void

void MHEG5engineTerminate

(

void

)

Force the engine to terminate.

Returns

none

None.

U8BIT MHEG5HandleEngineStopAction

(

U8BIT

action

)

E_MhegErr MHEG5Initialise

(

S_MhegConfig *

cfg_params

)

initialise MHEG5 component

Returns

MHERR_OK - success MHERR_INTERNAL - failure

void MHEG5NotifyCarouselUnload

(

void *

carousel

)

void MHEG5NotifyEngineQuit

(

void

)

void MHEG5NotifyEngineStarted

(

void

)

void MHEG5NotifyEngineStartFailed

(

void

)

void MHEG5NotifyServiceInfoChanged

(

U16BIT

service_id

)

void MHEG5Pause

(

void

)

BOOLEAN MHEG5ProcessAutoBoot

(

void

)

void MHEG5ProcessDsmccBooted

(

void *

carousel

)

void MHEG5RefreshDisplay

(

void

)

E_MhegErr MHEG5ResetResolution	(	U16BIT	screenWidth,
		U16BIT	screenHeight
	)

void MHEG5Resume

(

void

)

void MHEG5StartReboot

(

void *

dummy

)

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
	)

E_ChannelStartMode MHEG5TuningInfoMode

(

S32BIT

serviceIndex

)