mh5support.c File Reference

Engine support utility functions for MHEG5. More...

#include <string.h>
#include "mh5support.h"
#include "mh5debug.h"
#include "mh5memory.h"
#include "mh5profile.h"
#include "mheg5_control.h"
#include "mg_fontapi.h"
#include "mg_osd.h"
#include "mheg5_version.h"

Data Structures
struct	s_EngineSupportTable
struct	S_PROFILE_STRING

Macros
#define	FUNC_TYPE_NONE   0
#define	FUNC_TYPE_ONEINT   1
#define	FUNC_TYPE_TWOINT   2
#define	FUNC_TYPE_THRINT   3
#define	FUNC_TYPE_STRING   5
#define	FUNC_TYPE_ERROR   0xff
#define	OPEN_BRACKET   '('
#define	CLOSE_BRACKET   ')'
#define	ENGINE_STRING_TOTAL   4
#define	PRF_NDX_CIPLUS   0
#define	PRF_NDX_UK   1
#define	PRF_NDX_NZ   2
#define	PRF_NDX_AU   3
#define	PRF_NDX_HK   4
#define	PRF_NDX_FS   5
#define	PROFILE_STRING_TOTAL   6
#define	MAX_USER_AGENT   255
#define	FREESAT_MAX_FILE_LEN   (256 * 1024)
#define	UK_MAX_FILE_LEN   1024
#define	AU_MAX_FILE_LEN   (64 * 1024)
#define	SA_MAX_FILE_LEN   (512 * 1024)

Typedefs
typedef struct s_EngineSupportTable	S_EngineSupportTable

Enumerations
enum	{ MANF_STRING, ENG_STRING, DSM_STRING, REV_STRING }
enum	E_ScalingCapabilities {   MHEG5_SCALE_CAPS_QUARTER, MHEG5_SCALE_CAPS_STANDARD, MHEG5_SCALE_CAPS_DOUBLE, MHEG5_SCALE_CAPS_HDGRAPHICS,   MHEG5_SCALE_CAPS_HDVIDEO, MHEG5_SCALE_CAPS_HDGRAPHICS_AND_HDVIDEO }

Functions
const char *	MHEG5VersionString (void)
const char *	MHEG5RevisionString (void)
E_MhegErr	MH5_SupportInitialise (S_MhegConfig *pConfig)
	Initialise support module - called when 'Open' engine. More...
U8BIT *	MH5_GetManufacturerString (void)
	Returns a pointer to a manufacturer specific platform U8BIT*. More...
U8BIT *	MH5_GetEngineVersionString (void)
	Returns a pointer to the engine version string U8BIT*. More...
MHEG5Bool	MH5_SupportInteractionChannel (void)
	Return whether Interaction channel is supported by current profile. More...
MHEG5Bool	MH5_SupportICStreaming (void)
	Return whether Interaction channel Streaming is supported. More...
MHEG5Bool	MH5_SupportMhegProfile (E_MHEG_PROFILE profile)
	Return whether Mheg profile (UK, NZ, AU, HK, SA, FREESAT) is currently supported. More...
MHEG5Bool	MH5_SupportHDGraphics (void)
	Returns whether supporting HD Graphics extension. More...
MHEG5Bool	MH5_SupportHDVideo (void)
	Returns whether supporting HD Video extension. More...
MHEG5Bool	MH5_SupportNativeApplication (void)
	Return whether Native Application extension is supported. More...
MHEG5Bool	MH5_SupportPVRExtension (void)
	Return whether PVR extension (ETSI, and originally NZ) is supported. More...
MHEG5Bool	MH5_SupportServiceInfoExtension (void)
	Return whether Service Info extension is supported. More...
void	MH5_SetCurrentProfile (E_ProfileId profile)
	Set current profile - CI plus or broadcast (Could extend this fnc to distuinguish between UK/HK/NZ/AU etc) More...
E_ProfileId	MH5_GetCurrentProfile (void)
	Get current profile - CI plus or broadcast. More...
MHEG5Bool	MH5_SupportFontClass (void)
	Return whether font class is supported by current profile. More...
MHEG5Int	MH5_MaxStorageFileLength (void)
	Return maximum length of file for persistent storage depending on supported profiles (e.g. for just UK, it is 1024) More...
MHEG5Bool	MH5_GetEngineSupport (MHEG5String feature)
	Used by the GetEngineSupport action. More...
MHEG5String	MH5_WhoAmI (void)
	Used by the WhoAmI resident program to obtain WhoAmI string. See UK1.06 profile section 3.10.10.1. More...
U8BIT *	MH5_GetUserAgent (void)
	Return the "User Agent" string for the engine. More...

Detailed Description

Engine support utility functions for MHEG5.

Date

01/10/2010

Author

Adam Sturtridge

Macro Definition Documentation

#define AU_MAX_FILE_LEN   (64 * 1024)

#define CLOSE_BRACKET   ')'

#define ENGINE_STRING_TOTAL   4

#define FREESAT_MAX_FILE_LEN   (256 * 1024)

#define FUNC_TYPE_ERROR   0xff

#define FUNC_TYPE_NONE   0

#define FUNC_TYPE_ONEINT   1

#define FUNC_TYPE_STRING   5

#define FUNC_TYPE_THRINT   3

#define FUNC_TYPE_TWOINT   2

#define MAX_USER_AGENT   255

#define OPEN_BRACKET   '('

#define PRF_NDX_AU   3

#define PRF_NDX_CIPLUS   0

#define PRF_NDX_FS   5

#define PRF_NDX_HK   4

#define PRF_NDX_NZ   2

#define PRF_NDX_UK   1

#define PROFILE_STRING_TOTAL   6

#define SA_MAX_FILE_LEN   (512 * 1024)

#define UK_MAX_FILE_LEN   1024

Typedef Documentation

typedef struct s_EngineSupportTable S_EngineSupportTable

Enumeration Type Documentation

anonymous enum

Enumerator
MANF_STRING
ENG_STRING
DSM_STRING
REV_STRING

enum E_ScalingCapabilities

Enumerator
MHEG5_SCALE_CAPS_QUARTER
MHEG5_SCALE_CAPS_STANDARD
MHEG5_SCALE_CAPS_DOUBLE
MHEG5_SCALE_CAPS_HDGRAPHICS
MHEG5_SCALE_CAPS_HDVIDEO
MHEG5_SCALE_CAPS_HDGRAPHICS_AND_HDVIDEO

Function Documentation

E_ProfileId MH5_GetCurrentProfile

(

void

)

Get current profile - CI plus or broadcast.

Returns

void

MHEG5Bool MH5_GetEngineSupport

(

MHEG5String

feature

)

Used by the GetEngineSupport action.

Parameters

feature

Get engine support sting to test

Returns

MHEG5Bool - True if supported

U8BIT* MH5_GetEngineVersionString

(

void

)

Returns a pointer to the engine version string U8BIT*.

Returns

Pointer to a manufacturer specific platform U8BIT*.

U8BIT* MH5_GetManufacturerString

(

void

)

Returns a pointer to a manufacturer specific platform U8BIT*.

Returns

Pointer to a manufacturer specific platform U8BIT*.

U8BIT* MH5_GetUserAgent

(

void

)

Return the "User Agent" string for the engine.

Returns

User agent string for the engine

MHEG5Int MH5_MaxStorageFileLength

(

void

)

Return maximum length of file for persistent storage depending on supported profiles (e.g. for just UK, it is 1024)

Returns

int

void MH5_SetCurrentProfile

(

E_ProfileId

profile

)

Set current profile - CI plus or broadcast (Could extend this fnc to distuinguish between UK/HK/NZ/AU etc)

Parameters

profile

Profile

Returns

void

MHEG5Bool MH5_SupportFontClass

(

void

)

Return whether font class is supported by current profile.

Returns

TRUE if supported

MHEG5Bool MH5_SupportHDGraphics

(

void

)

Returns whether supporting HD Graphics extension.

Returns

TRUE is supported

MHEG5Bool MH5_SupportHDVideo

(

void

)

Returns whether supporting HD Video extension.

Returns

TRUE is supported

MHEG5Bool MH5_SupportICStreaming

(

void

)

Return whether Interaction channel Streaming is supported.

Returns

TRUE if supported

E_MhegErr MH5_SupportInitialise

(

S_MhegConfig *

pConfig

)

Initialise support module - called when 'Open' engine.

Parameters

pSetup

Structure passed to MHEG5_Open()

Returns

void

MHEG5Bool MH5_SupportInteractionChannel

(

void

)

Return whether Interaction channel is supported by current profile.

Returns

TRUE if supported

MHEG5Bool MH5_SupportMhegProfile

(

E_MHEG_PROFILE

profile

)

Return whether Mheg profile (UK, NZ, AU, HK, SA, FREESAT) is currently supported.

Returns

void

MHEG5Bool MH5_SupportNativeApplication

(

void

)

Return whether Native Application extension is supported.

Returns

TRUE if supported

MHEG5Bool MH5_SupportPVRExtension

(

void

)

Return whether PVR extension (ETSI, and originally NZ) is supported.

Returns

TRUE if supported

MHEG5Bool MH5_SupportServiceInfoExtension

(

void

)

Return whether Service Info extension is supported.

Returns

TRUE if supported

MHEG5String MH5_WhoAmI

(

void

)

Used by the WhoAmI resident program to obtain WhoAmI string. See UK1.06 profile section 3.10.10.1.

Returns

the WhoAmI string

const char* MHEG5RevisionString

(

void

)

const char* MHEG5VersionString

(

void

)