|
MHEG5
15.3.0
|
|
MHEG5
15.3.0
|
This file provides the control interface for MHEG5 engine. The use of this component MUST comply with the following sequence of events to ensure correct operation. 1. MHEG5_Open() - Initialise MHEG5 engine. 2. MHEG5_Start() - Start MHEG5 engine for a DVB service. More...
Go to the source code of this file.
Data Structures | |
| struct | S_MhegConfig |
Defines | |
| #define | SECTION_BUFFER_SIZE (4 * 1024) |
| #define | MHEG5_MIN_SECTION_BUFFERS (100) |
| #define | MHEG5_MIN_TASK_PRIORITY (4) |
| #define | NVM_STORE_SIZE_AU (64 * 1024) |
| #define | NVM_STORE_SIZE_SA (512 * 1024) |
| #define | AU_NVM_MINIMUM_SIZE ((1024 * 1024 * 2) + NVM_STORE_SIZE_AU) |
| #define | SA_NVM_MINIMUM_SIZE ((1024 * 1024 * 32) + NVM_STORE_SIZE_SA) |
| #define | ICS_DEFAULT_BUFFER_SIZE (3 * 1024 * 1024) |
| #define | ICS_MINIMUM_BUFFER_SIZE (768 * 1024) |
| #define | COLOUR_FORMAT_PALETTE 8 |
| #define | COLOUR_FORMAT_ARGB4444 16 |
| #define | COLOUR_FORMAT_ARGB7888 31 /* ST based platform */ |
| #define | COLOUR_FORMAT_ARGB8888 32 |
Typedefs | |
| typedef enum E_COUNTRY_PROFILE | E_MHEG_PROFILE |
Enumerations | |
| enum | E_COUNTRY_PROFILE { CPROFILE_NONE, CPROFILE_UK = (1 << 0), CPROFILE_NZ = (1 << 1), CPROFILE_AU = (1 << 2), CPROFILE_HK = (1 << 3), CPROFILE_SA = (1 << 4), CPROFILE_ALL = 0x1f, CPROFILE_FREESAT = (1 << 8) } |
| enum | E_MHEG5_CAPABILITES { VC_DEFAULT = 0, VC_SUPPORT_MHEG_NATIVE_APP = (1 << 0), VC_SUPPORT_MHEG_UK_PVR = (1 << 0), VC_SUPPORT_MHEG_PVR = (1 << 1), VC_SUPPORT_MHEG_NZ_PVR = (1 << 1), VC_SUPPORT_MHEG_AU_PVR = (1 << 2), VC_SUPPORT_MHEG_INTERACTION_CHANNEL = (1 << 3), VC_SUPPORT_MHEG_IC_STREAMING = (1 << 4), VC_SUPPORT_NON_LINEAR_PLAYBACK_KEYS = (1 << 5), VC_SUPPORT_MHEG_IC_STREAMING_HD = (1 << 6), VC_SUPPORT_OIPF_BROWSER_PROFILE = (1 << 7), VC_HD_VIDEO_NOT_SUPPORTED = (1 << 17), VC_SUBTITLES_NOT_SIMULTANEOUS = (1 << 18), VC_NO_VIDEO_OFF_SCREEN = (1 << 27), VC_NO_BITMAP_OFF_SCREEN = (1 << 28), VC_ONLY_SD_DOUBLE_SCALING = (1 << 29), VC_ONLY_SD_STANDARD_SCALING = (1 << 30), VC_ONLY_SD_QUARTER_SCALING = (1 << 31) } |
| enum | E_ChannelStartMode { CHANNEL_START_NORMAL, CHANNEL_START_QUIETLY, CHANNEL_START_QUIET_SHOW_INFO } |
Functions | |
| E_MhegErr | MHEG5_Open (S_MhegConfig *pSetup) |
| Initialise MHEG5 engine instance. The following will be performed as a result of a call to this function: | |
| E_MhegErr | MHEG5_Close (void) |
| Close MHEG engine. Free allocated MHEG5 engine memory region, and any other related resources. This is a synchronous blocking function. Must be called after MHEG5_Stop and normal use of MHEG5 engine has completed. | |
| E_MhegErr | MHEG5_Start (S32BIT serviceIndex, E_ChannelStartMode *quietMode) |
| This function starts MHEG5 engine on the current broadcast service. It will cause MHEG5 engine to start retrieving the associated service information (i.e. PMT) and launch an appropriate broadcast application. This should mean MHEG5 engine will mount an associated DSM-CC carousel for this application. If this should fail, MHEG5 engine will periodically try to mount the DSM-CC boot carousel in order to launch the default MHEG-5 auto boot application. This is a non-blocking function, which may return before completion. It should be called whenever a tuning process has completed and the external application is aware of a new broadcast service. | |
| E_MhegErr | MHEG5_Stop (void) |
| Tells MHEG5 engine to enter stop state (i.e. no broadcast service). This function should kill any currently running MHEG5 broadcast application, and release allocated memory and resources. This is a synchronous blocking function. | |
| E_MhegErr | MHEG5_Suspend (void) |
| Suspend MHEG5 engine (while there is no valid broadcast service). When the external application is performing a tune as requested by MHEG5, this function should be called as an alternative to MHEG5_Stop. This may or may not kill the running MHEG application. This suspend state will remain in effect until MHEG5_Start or MHEG5_Stop is called. This is a synchronous blocking function. | |
| E_MhegErr | MHEG5_Pause (void) |
| This allows MHEG5 engine to be paused whilst another application has display focus (such as an EPG). This is a synchronous blocking function. Section 16.9 of reference [1] discusses the behaviour for pausing the engine. This implementation is "Non-transparent". This may be called independently of start/stop of engine. | |
| E_MhegErr | MHEG5_Resume (void) |
| This allows Voyageer to be resumed after another application has had display focus (such as an EPG). This is a synchronous blocking function. Section 16.9 of reference [1] discusses the behaviour for pausing the engine. This implementation is "Non-transparent". This may be called independently of start/stop of engine. | |
| E_MhegErr | MHEG5_SetScreenResolution (U16BIT screenWidth, U16BIT screenHeight) |
| Sets the screen resolution to new size. This function is required when the external application wishes to change the screen resolution. This is a synchronous blocking function. It will return when MHEG5 engine has finished using the previous resolution. After returning from this function, MHEG5 engine will NOT refresh the OSD or AV until MHEG5_RestoreScreen() is called. | |
| E_MhegErr | MHEG5_SetSurfaceThreshold (S32BIT pixels) |
| Set the minimum number of pixels that force the MHEG-5 engine to release a surface immediately after it's been used (or blitted). When threshold is not applied, a surface remains until the MHEG-5 application unloads them (either directly or as part of scene/application tear-down). This function is only included in the compiled library when environment variable DTVKIT_MHEG5_SURFACE_THRESHOLD is not zero. | |
| void | MHEG5_RestoreScreen (void) |
| Refresh screen after resolution change with MHEG5_SetScreenResolution() This is a non-blocking function. | |
| void * | MHEG5_DsmccInstance (void) |
| Get the DSMCC instance handle. | |
| E_ChannelStartMode | MHEG5_GetTuningInfoMode (S32BIT serviceIndex) |
| Get the current tuning mode for the target service. This is only relevant when MHEG5 has requested a tune, and DVB has not yet tuned to that service. The return value will be the same as that given back by next call to MHEG5_Start(). | |
This file provides the control interface for MHEG5 engine. The use of this component MUST comply with the following sequence of events to ensure correct operation. 1. MHEG5_Open() - Initialise MHEG5 engine. 2. MHEG5_Start() - Start MHEG5 engine for a DVB service.
---------------------------------------------------------------- 3. Normal Operation - MHEG5 component interaction. ---------------------------------------------------------------- 4. MHEG5_Stop() - Stop MHEG5 engine running on DVB service. 5. MHEG5_Close() - Release all instance memory and resources. Generally provided functions are non-blocking (i.e. they will perform quickly). Functions without a post condition (no returned values), will either perform quickly, or copy passed data and return. Functions with a post condition (synchronously returned values) will perform quickly. Other functions that cannot perform quickly will copy passed data and return asynchronously through the specified asynchronous return path. References: [1] DTG UK D-Book 7 part A. [2] ISO/IEC 13818-1:2000 - Information technology -- Generic coding of moving pictures and associated audio information: Systems [3] ISO/IEC 13818-6:1998 - Information technology -- Generic coding of moving pictures and associated audio information -- Part 6: Extensions for DSM-CC
| E_MhegErr MHEG5_Close | ( | void | ) |
Close MHEG engine. Free allocated MHEG5 engine memory region, and any other related resources. This is a synchronous blocking function. Must be called after MHEG5_Stop and normal use of MHEG5 engine has completed.
Close MHEG engine. Free allocated MHEG5 engine memory region, and any other related resources. This is a synchronous blocking function. Must be called after MHEG5_Stop and normal use of MHEG5 engine has completed.
| void* MHEG5_DsmccInstance | ( | void | ) |
Get the DSMCC instance handle.
| E_ChannelStartMode MHEG5_GetTuningInfoMode | ( | S32BIT | serviceIndex | ) |
Get the current tuning mode for the target service. This is only relevant when MHEG5 has requested a tune, and DVB has not yet tuned to that service. The return value will be the same as that given back by next call to MHEG5_Start().
| serviceIndex | "Service Index" for the new service |
Get the current tuning mode for the target service. This is only relevant when MHEG5 has requested a tune, and DVB has not yet tuned to that service. The return value will be the same as that given back by next call to MHEG5_Start().
| serviceIndex | "Service Index" for the new service |
| E_MhegErr MHEG5_Open | ( | S_MhegConfig * | pSetup | ) |
Initialise MHEG5 engine instance. The following will be performed as a result of a call to this function:
| pSetup | Pointer configuration parameters. This defines many configuration options for MHEG5 engine |
| pSetup | Pointer configuration parameters. This defines many configuration options for MHEG5 |
| E_MhegErr MHEG5_Pause | ( | void | ) |
This allows MHEG5 engine to be paused whilst another application has display focus (such as an EPG). This is a synchronous blocking function. Section 16.9 of reference [1] discusses the behaviour for pausing the engine. This implementation is "Non-transparent". This may be called independently of start/stop of engine.
This allows MHEG5 engine to be paused whilst another application has display focus (such as an EPG). This is a synchronous blocking function. Section 16.9 of reference [1] discusses the behaviour for pausing the engine. This implementation is "Non-transparent". This may be called independently of start/stop of engine.
| None. |
| void MHEG5_RestoreScreen | ( | void | ) |
Refresh screen after resolution change with MHEG5_SetScreenResolution() This is a non-blocking function.
Refresh screen after resolution change with MHEG5_SetScreenResolution() This is a non-blocking function.
| None. |
| E_MhegErr MHEG5_Resume | ( | void | ) |
This allows Voyageer to be resumed after another application has had display focus (such as an EPG). This is a synchronous blocking function. Section 16.9 of reference [1] discusses the behaviour for pausing the engine. This implementation is "Non-transparent". This may be called independently of start/stop of engine.
This allows Voyageer to be resumed after another application has had display focus (such as an EPG). This is a synchronous blocking function. Section 16.9 of reference [1] discusses the behaviour for pausing the engine. This implementation is "Non-transparent". This may be called independently of start/stop of engine.
| None. |
| E_MhegErr MHEG5_SetScreenResolution | ( | U16BIT | screenWidth, |
| U16BIT | screenHeight | ||
| ) |
Sets the screen resolution to new size. This function is required when the external application wishes to change the screen resolution. This is a synchronous blocking function. It will return when MHEG5 engine has finished using the previous resolution. After returning from this function, MHEG5 engine will NOT refresh the OSD or AV until MHEG5_RestoreScreen() is called.
| screenWidth | New screen width |
| sreeenHeight | New screen height |
Sets the screen resolution to new size. This function is required when the external application wishes to change the screen resolution. This is a synchronous blocking function. It will return when MHEG5 engine has finished using the previous resolution. After returning from this function, MHEG5 engine will NOT refresh the OSD or AV until MHEG5_RestoreScreen() is called.
| None. |
| E_MhegErr MHEG5_SetSurfaceThreshold | ( | S32BIT | pixels | ) |
Set the minimum number of pixels that force the MHEG-5 engine to release a surface immediately after it's been used (or blitted). When threshold is not applied, a surface remains until the MHEG-5 application unloads them (either directly or as part of scene/application tear-down). This function is only included in the compiled library when environment variable DTVKIT_MHEG5_SURFACE_THRESHOLD is not zero.
| pixels | Number of pixels to be used as a threshold. Zero or negative number disables automatic destruction |
| E_MhegErr MHEG5_Start | ( | S32BIT | serviceIndex, |
| E_ChannelStartMode * | quietMode | ||
| ) |
This function starts MHEG5 engine on the current broadcast service. It will cause MHEG5 engine to start retrieving the associated service information (i.e. PMT) and launch an appropriate broadcast application. This should mean MHEG5 engine will mount an associated DSM-CC carousel for this application. If this should fail, MHEG5 engine will periodically try to mount the DSM-CC boot carousel in order to launch the default MHEG-5 auto boot application. This is a non-blocking function, which may return before completion. It should be called whenever a tuning process has completed and the external application is aware of a new broadcast service.
| serviceIndex | "Service Index" for the new service |
| quietMode | pointer to return channel change mode that MHEG5 requires of the external application. Can be NULL, if not interested in mode. |
| E_MhegErr MHEG5_Stop | ( | void | ) |
Tells MHEG5 engine to enter stop state (i.e. no broadcast service). This function should kill any currently running MHEG5 broadcast application, and release allocated memory and resources. This is a synchronous blocking function.
| E_MhegErr MHEG5_Suspend | ( | void | ) |
Suspend MHEG5 engine (while there is no valid broadcast service). When the external application is performing a tune as requested by MHEG5, this function should be called as an alternative to MHEG5_Stop. This may or may not kill the running MHEG application. This suspend state will remain in effect until MHEG5_Start or MHEG5_Stop is called. This is a synchronous blocking function.
1.7.6.1 
