MHEG5  15.3.0
source/core/inc/mh5misc.h File Reference

Miscellaneous. More...

#include "mh5base.h"
#include "dvblocator.h"

Go to the source code of this file.

Functions

MHEG5Bool MHEG5parseUrl (U8BIT *buffer, U32BIT length, S_DVB_LOCATOR *multiplexRef)
 Parse a DAVIC style multiplex reference or UK-DTT inherritance format URL. This can be one of the following forms: rec://svc/cur rec://svc/def rec://svc/lcn/# dvb://original_network_id.[transport_stream_id].service_id[.*].
MHEG5Int MHEG5GetServiceIndex (MHEG5String *serviceReference)
 Ref:[1] - 3.10.6.1 and [1] - 3.10.6.3 Get the serviceIndex, a positive integer which is used to reference a service, based on the DVB URL (MHEG5_dvbLocator). NONE.
void MHEG5SetSubtitleMode (MHEG5Bool subtitleOn)
 Set the current subtitle display mode to be either On or Off, Should only have an impact if subtitles can be displayed simultaneously with MHEG. This function is used by the SetSubtitleMode resident program. See UK1.06 profile section 3.10.8.4.
MHEG5String MHEG5GetBootInfo (MHEG5Bool *InfoResultVal)
 Tell whether a network_boot_info sub-descriptor has been found and received. If so, returns the value of the NB_info field of the network_boot_info sub-descriptor. This function is used by the GetBootInfo resident program. See UK1.06 profile section 3.10.7.3.
MHEG5Int MHEG5GetDisplayAspectRatio (void)
 Reads the format of the connected display (4:3 or 16:9) This function is used by the GetDisplayAspectRatio resident program. See UK1.06 profile section 3.10.8.3.
MHEG5Bool MHEG5VideoToGraphics (MHEG5Int videoXval, MHEG5Int videoYval, MHEG5Int *graphicsXVal, MHEG5Int *graphicsYVal)
 Calculate the graphical co-ordinate from a given video coordinate (should take into account the current setting of the receiver regards video settings) This function is used by the VideoToGraphics resident program. See UK1.06 profile section 3.10.8.1.
MHEG5Bool MHEG5GetBasicSI (MHEG5Int serviceIndex, MHEG5Int *networkID, MHEG5Int *origNetworkID, MHEG5Int *transportStreamID, MHEG5Int *serviceID)
 Returns a series of integers representing basic Service Information (SI) about a service. The service is identified by means of a receiver specific "ServiceIndex". This integer can be determined by means of the SI_GetServiceIndex resident program (see 3.10.6.1, "SI_GetServiceIndex", on page 3-20). This function is used by the SI_TuneIndexInfo resident program. See UK1.06 profile section 3.10.6.3.
MHEG5Bool MHEG5RequestMPEGDecoder (MHEG5Bool request)
 Requests exclusive access to a MPEG decoder and video plane to display I-frames. The MPEG decoder shall be available when no other application environment is active. This function is used by the RequestMPEGDecoder resident program. See CI+ specification section 12.3.6.1.
void MHEG5SuppressMHEGGraphics (MHEG5Bool request)
 Request that the external application toggles between showing MHEG graphics or subtitles This function is used by the SuppressMHEGGraphics resident program. See CI+ specification section 12.8.1.2.
void MHEG5restoreReceiverDefaults (void)
 Restore receiver defaults as described in section 3.12.10 of the 1.06 profile.
MHEG5Bool MHEG5getICSupport (MHEG5Int val)
 Determines whether the system supports Interaction channel.

Detailed Description

Miscellaneous.

Date:
19/12/2001
Author:
iwillis

Function Documentation

MHEG5Bool MHEG5GetBasicSI ( MHEG5Int  serviceIndex,
MHEG5Int *  networkID,
MHEG5Int *  origNetworkID,
MHEG5Int *  transportStreamID,
MHEG5Int *  serviceID 
)

Returns a series of integers representing basic Service Information (SI) about a service. The service is identified by means of a receiver specific "ServiceIndex". This integer can be determined by means of the SI_GetServiceIndex resident program (see 3.10.6.1, "SI_GetServiceIndex", on page 3-20). This function is used by the SI_TuneIndexInfo resident program. See UK1.06 profile section 3.10.6.3.

Parameters:
serviceIndexReceiver-specific identifier for service
networkIDNetwork ID associated to the given service index
origNetworkIDOriginal network ID associated to the given service index
transportStreamIDTransport stream ID associated to the given service index
serviceIDService ID associated to the given service index
Returns:
Boolean MHEG5TRUE - service available. MHEG5FALSE - service not available.
MHEG5String MHEG5GetBootInfo ( MHEG5Bool *  InfoResultVal)

Tell whether a network_boot_info sub-descriptor has been found and received. If so, returns the value of the NB_info field of the network_boot_info sub-descriptor. This function is used by the GetBootInfo resident program. See UK1.06 profile section 3.10.7.3.

Returns:
None
MHEG5Int MHEG5GetDisplayAspectRatio ( void  )

Reads the format of the connected display (4:3 or 16:9) This function is used by the GetDisplayAspectRatio resident program. See UK1.06 profile section 3.10.8.3.

Parameters:
modeValThe required mode of the display
Returns:
None.

Reads the format of the connected display (4:3 or 16:9) This function is used by the GetDisplayAspectRatio resident program. See UK1.06 profile section 3.10.8.3.

Returns:
None
MHEG5Bool MHEG5getICSupport ( MHEG5Int  val)

Determines whether the system supports Interaction channel.

Parameters:
valThe value 0 - IC, 1 - ICS
Returns:
True if the system supports it, else False.
MHEG5Int MHEG5GetServiceIndex ( MHEG5String serviceReference)

Ref:[1] - 3.10.6.1 and [1] - 3.10.6.3 Get the serviceIndex, a positive integer which is used to reference a service, based on the DVB URL (MHEG5_dvbLocator). NONE.

Parameters:
serviceReferenceServiceReference defines a Stream using the URL format defined in DAVIC 1.3 part 9 paragraph 9.5. See also 8, "Name Mapping", on page 8-1
Returns:
serviceIndex. On error, an error value indicating one of the following: -1 (serviceIndex is unavailable for the given dvbLocator).
MHEG5Bool MHEG5parseUrl ( U8BIT *  buffer,
U32BIT  length,
S_DVB_LOCATOR multiplexRef 
)

Parse a DAVIC style multiplex reference or UK-DTT inherritance format URL. This can be one of the following forms: rec://svc/cur rec://svc/def rec://svc/lcn/# dvb://original_network_id.[transport_stream_id].service_id[.*].

Parameters:
bufferPointer to character buffer containing the URL string
lengthLength of character buffer
multiplexRefMultiplex reference extracted from the URL string
Returns:
MHEG5TRUE if URL could be decoded, else MHEG5FALSE
MHEG5Bool MHEG5RequestMPEGDecoder ( MHEG5Bool  request)

Requests exclusive access to a MPEG decoder and video plane to display I-frames. The MPEG decoder shall be available when no other application environment is active. This function is used by the RequestMPEGDecoder resident program. See CI+ specification section 12.3.6.1.

Parameters:
requestMHEG5TRUE to request access to the MPEG decoder, MHEG5FALSE to release the MPEG decoder
Returns:
Boolean MHEG5TRUE - MPEG decoder is available MHEG5FALSE - MPEG decoder is not available

Restore receiver defaults as described in section 3.12.10 of the 1.06 profile.

Returns:
None.
void MHEG5SetSubtitleMode ( MHEG5Bool  subtitleOn)

Set the current subtitle display mode to be either On or Off, Should only have an impact if subtitles can be displayed simultaneously with MHEG. This function is used by the SetSubtitleMode resident program. See UK1.06 profile section 3.10.8.4.

Returns:
None
void MHEG5SuppressMHEGGraphics ( MHEG5Bool  request)

Request that the external application toggles between showing MHEG graphics or subtitles This function is used by the SuppressMHEGGraphics resident program. See CI+ specification section 12.8.1.2.

Parameters:
requestMHEG5TRUE to request that the application supresses MHEG graphics, MHEG5FALSE to request that the application enables MHEG graphics
Returns:
Nothing
MHEG5Bool MHEG5VideoToGraphics ( MHEG5Int  videoXval,
MHEG5Int  videoYval,
MHEG5Int *  graphicsXVal,
MHEG5Int *  graphicsYVal 
)

Calculate the graphical co-ordinate from a given video coordinate (should take into account the current setting of the receiver regards video settings) This function is used by the VideoToGraphics resident program. See UK1.06 profile section 3.10.8.1.

Parameters:
videoXvalX value in video coordinate space
videoYvalY value in video coordinate space
graphicsXValX value in graphical coordinate space
graphicsYValX value in graphical coordinate space
Returns:
TRUE if successful, else FALSE.
 All Data Structures Files Functions Variables Typedefs Defines