MHEG5  18.9.0
MHEG5 Documentation
Classes | Macros | Typedefs | Enumerations | Functions
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"
#include "build.h"

Go to the source code of this file.

Classes

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 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  E_PRFS {
  PRF_NDX_UK, PRF_NDX_NZ, PRF_NDX_AU, PRF_NDX_HK,
  PRF_TOTAL
}
 
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...
 
U8BITMH5_GetManufacturerString (void)
 Returns a pointer to a manufacturer specific platform U8BIT*. More...
 
U8BITMH5_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...
 
U8BITMH5_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

Definition in file mh5support.c.

Macro Definition Documentation

#define AU_MAX_FILE_LEN   (64 * 1024)

Definition at line 55 of file mh5support.c.

#define CLOSE_BRACKET   ')'

Definition at line 47 of file mh5support.c.

#define ENGINE_STRING_TOTAL   4

Definition at line 49 of file mh5support.c.

#define FREESAT_MAX_FILE_LEN   (256 * 1024)

Definition at line 53 of file mh5support.c.

#define FUNC_TYPE_ERROR   0xff

Definition at line 44 of file mh5support.c.

#define FUNC_TYPE_NONE   0

Definition at line 39 of file mh5support.c.

#define FUNC_TYPE_ONEINT   1

Definition at line 40 of file mh5support.c.

#define FUNC_TYPE_STRING   5

Definition at line 43 of file mh5support.c.

#define FUNC_TYPE_THRINT   3

Definition at line 42 of file mh5support.c.

#define FUNC_TYPE_TWOINT   2

Definition at line 41 of file mh5support.c.

#define MAX_USER_AGENT   255

Definition at line 51 of file mh5support.c.

#define OPEN_BRACKET   '('

Definition at line 46 of file mh5support.c.

#define SA_MAX_FILE_LEN   (512 * 1024)

Definition at line 56 of file mh5support.c.

#define UK_MAX_FILE_LEN   1024

Definition at line 54 of file mh5support.c.

Typedef Documentation

Enumeration Type Documentation

anonymous enum
Enumerator
MANF_STRING 
ENG_STRING 
DSM_STRING 
REV_STRING 

Definition at line 78 of file mh5support.c.

enum E_PRFS
Enumerator
PRF_NDX_UK 
PRF_NDX_NZ 
PRF_NDX_AU 
PRF_NDX_HK 
PRF_TOTAL 

Definition at line 60 of file mh5support.c.

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 

Definition at line 102 of file mh5support.c.

Function Documentation

E_ProfileId MH5_GetCurrentProfile ( void  )

Get current profile - CI plus or broadcast.

Returns
void

Definition at line 551 of file mh5support.c.

MHEG5Bool MH5_GetEngineSupport ( MHEG5String  feature)

Used by the GetEngineSupport action.

Parameters
featureGet engine support sting to test
Returns
MHEG5Bool - True if supported

Definition at line 584 of file mh5support.c.

U8BIT* MH5_GetEngineVersionString ( void  )

Returns a pointer to the engine version string U8BIT*.

Returns
Pointer to a manufacturer specific platform U8BIT*.

Definition at line 414 of file mh5support.c.

U8BIT* MH5_GetManufacturerString ( void  )

Returns a pointer to a manufacturer specific platform U8BIT*.

Returns
Pointer to a manufacturer specific platform U8BIT*.

Definition at line 405 of file mh5support.c.

U8BIT* MH5_GetUserAgent ( void  )

Return the "User Agent" string for the engine.

Returns
User agent string for the engine

Definition at line 1552 of file mh5support.c.

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

Definition at line 574 of file mh5support.c.

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
profileProfile
Returns
void

Definition at line 528 of file mh5support.c.

MHEG5Bool MH5_SupportFontClass ( void  )

Return whether font class is supported by current profile.

Returns
TRUE if supported

Definition at line 560 of file mh5support.c.

MHEG5Bool MH5_SupportHDGraphics ( void  )

Returns whether supporting HD Graphics extension.

Returns
TRUE is supported

Definition at line 465 of file mh5support.c.

MHEG5Bool MH5_SupportHDVideo ( void  )

Returns whether supporting HD Video extension.

Returns
TRUE is supported

Definition at line 474 of file mh5support.c.

MHEG5Bool MH5_SupportICStreaming ( void  )

Return whether Interaction channel Streaming is supported.

Returns
TRUE if supported

Definition at line 436 of file mh5support.c.

E_MhegErr MH5_SupportInitialise ( S_MhegConfig pConfig)

Initialise support module - called when 'Open' engine.

Parameters
pSetupStructure passed to MHEG5_Open()
Returns
void

Definition at line 235 of file mh5support.c.

MHEG5Bool MH5_SupportInteractionChannel ( void  )

Return whether Interaction channel is supported by current profile.

Returns
TRUE if supported

Definition at line 423 of file mh5support.c.

MHEG5Bool MH5_SupportMhegProfile ( E_MHEG_PROFILE  profile)

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

Returns
void

Definition at line 451 of file mh5support.c.

MHEG5Bool MH5_SupportNativeApplication ( void  )

Return whether Native Application extension is supported.

Returns
TRUE if supported

Definition at line 483 of file mh5support.c.

MHEG5Bool MH5_SupportPVRExtension ( void  )

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

Returns
TRUE if supported

Definition at line 498 of file mh5support.c.

MHEG5Bool MH5_SupportServiceInfoExtension ( void  )

Return whether Service Info extension is supported.

Returns
TRUE if supported

Definition at line 513 of file mh5support.c.

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

Definition at line 709 of file mh5support.c.

const char* MHEG5RevisionString ( void  )

Definition at line 225 of file mh5support.c.

const char* MHEG5VersionString ( void  )

Definition at line 220 of file mh5support.c.