source/core/inc/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.

Defines
#define	UND_LANGUAGE_CODE   (U32BIT)(('u'<<16)|('n'<<8)|'d')
Enumerations
enum	E_StopAction { STOP_ACTION_CLEAR_DSMCC, STOP_ACTION_MHEG_TUNE }
Functions
E_MhegErr	MHEG5Initialise (S_MhegConfig *cfg_params)
	initialise MHEG5 component
void	MHEG5_Terminate (void)
	Terminate MHEG5 component.
void	MHEG5engineStart (U8BIT *application, BOOLEAN isCi)
	Start the engine with the initial application.
void	MHEG5engineTerminate (void)
	Force the engine to terminate.
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	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().
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.
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.
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.
U32BIT	MHEG5tuneProcess (S_DvbLocator *pDvbLoc, S32BIT serviceIndex)
void	MHEG5RefreshStreams (U16BIT service_id)

---

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 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.

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
	)

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.

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.