dvb/inc/ap_cntrl.h File Reference

Application stb layer control. More...

#include "stbhwav.h"
#include "vtctype.h"
#include "stbdpc.h"
#include "ap_si.h"

Include dependency graph for ap_cntrl.h:

Go to the source code of this file.

Data Structures
struct	S_MANUAL_ANA_TUNING_PARAMS
struct	S_MANUAL_TERR_TUNING_PARAMS
struct	S_MANUAL_CABLE_TUNING_PARAMS
struct	S_MANUAL_SAT_TUNING_PARAMS
struct	S_MANUAL_TUNING_PARAMS
struct	S_ACTL_OWNER_INFO
Typedefs
typedef void(*	DSM_FILE_CALLBACK )(void *user_data, U8BIT *file_data, U32BIT data_size)
	Prototype for function that's called when a file requested from a DSM-CC carousel is received.
Enumerations
enum	E_ACTL_SI_SRCH_REQD {   ACTL_SI_NO_SEARCH, ACTL_SI_CHANNEL_SEARCH, ACTL_SI_CHANNEL_SEARCH_NO_NIT, ACTL_SI_STARTUP_SEARCH,   ACTL_SI_EVENT_SCHED_SEARCH, ACTL_SI_DVB_SSU_SEARCH, ACTL_SI_TOT_SEARCH, ACTL_SI_USER_DEFINED }
enum	E_ACTL_SEARCH_TYPE { ACTL_FREQ_SEARCH, ACTL_NETWORK_SEARCH }
enum	E_ACTL_AV_MODE {   ACTL_STANDBY_MODE, ACTL_STANDBY_SCART_MODE, ACTL_TV_MODE, ACTL_SCART_MODE,   ACTL_INT_DVD_MODE }
Functions
BOOLEAN	ACTL_StartServiceSearch (E_STB_DP_SIGNAL_TYPE tuner_type, E_ACTL_SEARCH_TYPE type)
	Entry point for starting a service search for a full retune or to update the existing service lineup.
BOOLEAN	ACTL_IsTargetRegionRequired (void)
	When the search has completed, this function should be called to see whether the target region UI should be presented. This is only needed for DVB-T/T2 searches.
void	ACTL_StopServiceSearch (void)
	Function to stop the service search before it completes.
void	ACTL_CompleteServiceSearch (void)
	Function to complete a service search after an operation has completed that allows the LCNs to be assigned (e.g. after the target region has been selected).
BOOLEAN	ACTL_StartStartupSearch (void)
	Function to start the startup search when booting from cold. This search checks the validity of the services contained in the database. It's only valid for DVB-T/T2 and DVB-C.
BOOLEAN	ACTL_StartSSUSearch (void)
	Function to start a search to see if there's an SSU available.
BOOLEAN	ACTL_StartTotSearch (void)
	Function to start a TOT search which is required to set the system clock when starting from power off if a real-time clock isn't available.
void	ACTL_StopTotSearch (void)
	Function to stop the TOT search before it completes.
BOOLEAN	ACTL_StartEitSearch (void)
	Entry point for starting an EIT search.
void	ACTL_StopEitSearch (void)
	Function to stop the EIT search before it completes.
BOOLEAN	ACTL_IsSearchComplete (void)
	Returns TRUE if current search has finished. This works for any of the available types of searches.
U8BIT	ACTL_GetSearchProgress (void)
	Returns search progress as a percentage. This works for any of the available types of searches, but the scope for providing progress on anything other than the service searches is fairly limited.
BOOLEAN	ACTL_StartManualSearchById (E_STB_DP_SIGNAL_TYPE tuner_type, U16BIT chan_id, BOOLEAN start_search)
	Start a service search on, or just tune to, a transport, using chan_id as an index into the country's tuning table.
BOOLEAN	ACTL_StartManualSearch (E_STB_DP_SIGNAL_TYPE tuner_type, S_MANUAL_TUNING_PARAMS *tuning_params, E_ACTL_SEARCH_TYPE type)
	Start a service search on, or just tune to, the transport defined by the given tuning parameters.
void	ACTL_FinishManualSearch (void)
	Function to be called when a manual service search has completed, or is being stopped.
BOOLEAN	ACTL_StartSSUUpdate (void *t_ptr)
	Starts an SSU update on the given transport. The update may still fail if the transport is later found not to contain an update for the system. If the update isn't mandatory then the process must be continued to actually perform the update.
void	ACTL_FinishSSUUpdate (BOOLEAN do_update)
	Once an update has been found or not then this function must be called to continue or terminate the update.
U8BIT	ACTL_AcquireLivePathForService (void *s_ptr, S_ACTL_OWNER_INFO *owner)
	Acquires a decode path for viewing a live signal for the given service.
void	ACTL_ReleaseLivePathForService (void *s_ptr, E_STB_DP_RES_OWNER owner)
	Finds the path being used to view the given service and releases it.
BOOLEAN	ACTL_AcquirePathOwnership (U8BIT path, S_ACTL_OWNER_INFO *owner_info)
	Attempts to take ownership of the given path (used by CI+)
BOOLEAN	ACTL_ReleasePathOwnership (U8BIT path, E_STB_DP_RES_OWNER owner)
	Releases ownership of the path, and frees any associated data, if the given owner is the path's owner (used by CI+)
BOOLEAN	ACTL_CanServiceBeViewed (void *s_ptr)
	Checks whether there's a tuner available to view the given service. This takes into account whether tuners are being used for recording or have been acquired by CI+.
void *	ACTL_GetCurrentSatellite (U8BIT path)
	Returns the current satellite being used by the given decode path.
void	ACTL_TuneToTransport (U8BIT path, S_ACTL_OWNER_INFO *owner_info, void *t_ptr, E_ACTL_SI_SRCH_REQD reqd_si, BOOLEAN relock_on)
	Tunes to the given transport and sets the type of SI monitoring that will be started when the tuning completes.
U8BIT	ACTL_TuneToService (U8BIT path, S_ACTL_OWNER_INFO *owner_info, void *s_ptr, BOOLEAN override_lock, BOOLEAN for_live)
	Starts the process of tuning to the specified service. If the service is to be tuned on the live path, then path should be passed as INVALID_RES_ID to ensure that any CI+ resource handling is performed.
BOOLEAN	ACTL_TuneUsingDSD (U8BIT path, SI_DELIVERY_SYS_DESC_TYPE dsd_type, SI_DELIVERY_SYS_DESC *dsd, U16BIT service_id, E_ACTL_SI_SRCH_REQD reqd_si)
	Starts the process of tuning to a given transport or service that's defined by the given delivery system descriptor. If the DSD defines a transport that doesn't currently exist, then one will be created, and if a service_id is given and a service with this ID doesn't exist on the transport, then one will be created, but will be marked as hidden and non-selectable so it won't appear to a user.
BOOLEAN	ACTL_IsTuned (U8BIT path)
	Returns whether the given path is currently tuned.
void	ACTL_TuneOff (U8BIT path)
	Stops tuning on the given path.
void	ACTL_DecodeOff (U8BIT path)
	Stops decoding on the given path.
void	ACTL_ReTuneAudio (void)
	Stops and restarts audio decoding on the live path. This may be required due to a change in language preferences, or some other audio setting.
void	ACTL_ReTuneSubtitles (void)
	Stops and restarts subtitle decoding on the live path. This may be required due to a change in language preferences, or some other setting.
BOOLEAN	ACTL_HasDecodingStarted (U8BIT path)
	Returns whether decoding has been started on the given path.
BOOLEAN	ACTL_IsDecodingLocked (U8BIT path)
	Returns whether decoding is locked, due to parental locking, on the given path.
void	ACTL_ReleaseChannelLock (void)
	Releases the lock on a channel after decoding has been blocked due to the service being parental locked, after which decoding will be started.
BOOLEAN	ACTL_TuneToRfChanArrayEntry (U8BIT path, U16BIT id, E_ACTL_SI_SRCH_REQD reqd_si, BOOLEAN relock_on)
	Tunes to the specified rf channel array entry for DVB-T and DVB-C.
BOOLEAN	ACTL_TuneToRfChanArrayAnalogEntry (U8BIT path, U16BIT id)
	Tunes to the specified rf channel array entry in analogue mode.
BOOLEAN	ACTL_TuneToUserDefinedParams (U8BIT path, S_MANUAL_TUNING_PARAMS *tuning_params, E_ACTL_SI_SRCH_REQD reqd_si, BOOLEAN relock_on)
	Tunes to the given set of tuning parameters.
void	ACTL_EnterStandby (void)
	Puts DVB into standby mode. It will continue to monitor SI for recordings, SSU updates, etc., unless it goes into low power standby.
void	ACTL_LeaveStandby (void *s_ptr, BOOLEAN tune_to_service)
	Brings the DVB out of standby mode.
void	ACTL_SetStandbyState (BOOLEAN state)
	Reports the standby state to the A/V output controller.
void	ACTL_SetStandbyVCRActive (void)
	Reports standby state to the a/v output control state machine.
void	ACTL_SetVideoWindow (S16BIT win_x, S16BIT win_y, U16BIT win_width, U16BIT win_height)
	Sets the video window to the size specified. Coordinates are relative to the screen resolution.
void	ACTL_SetTVAspectRatio (E_STB_AV_ASPECT_RATIO aspect_ratio)
	Used to set the TV aspect ratio.
E_STB_AV_ASPECT_RATIO	ACTL_GetTVAspectRatio (void)
	Returns the current TV aspect ratio.
void	ACTL_SetTVAspectMode (E_STB_AV_ASPECT_MODE aspect_mode)
	Used to set the TV aspect mode which defines how the video will be displayed based on the aspect ratio of the TV and video, along with some other factors.
E_STB_AV_ASPECT_MODE	ACTL_GetTVAspectMode (void)
	Returns the current TV aspect mode.
void	ACTL_SetTVAspectConversion (E_STB_AV_ASPECT_RATIO aspect_ratio, E_STB_AV_ASPECT_MODE aspect_mode)
	Used to set the aspect conversion applied to the video based on the TV aspect ratio and aspect mode to be applied. The given settings will also be saved.
E_STB_AV_VIDEO_FORMAT	ACTL_GetActualVideoMode (U16BIT *width, U16BIT *height)
	Reads the saved video format and returns the best mode available if it's set to AUTO or is invalid for the currently connected TV.
void	ACTL_HDMIConnected (void)
	Checks that the selected HDMI resolution mode is supported and, if not, chooses the best one available. This function is called by the event task when the HDMI connected event is received.
void	ACTL_HDMIDisconnected (void)
	Sets flag to indicate HDMI is now disconnected. This function is called by the event task when the HDMI disconnected event is received.
BOOLEAN	ACTL_IsHDMIConnected (void)
	Returns whether the HDMI is connected or not.
U16BIT	ACTL_GetHDMIResolutions (E_STB_AV_VIDEO_FORMAT **video_formats, U16BIT *current_index)
	Returns an array of valid HDMI resolutions and the index of the currently selected format. The final entry in each array will be the auto video format.
void	ACTL_UpdateVideoMode (E_STB_AV_ASPECT_RATIO aspect, BOOLEAN force)
	Update video mode sets Voyager resolution as well as platform Also, stops subtitles during the operation. If HDMI resolution mode is not supported, it chooses the best one available.
void	ACTL_ApplyHDCP (void *s_ptr)
	Checks content protection requirements for the current event on the given service to determine whether HDCP has to be used. The HDMI output will be enabled/disabled accordingly.
E_ACTL_AV_MODE	ACTL_GetAvModeStatus (void)
	Returns av_mode.
U16BIT	ACTL_GetNumRfChanArrayEntries (E_STB_DP_SIGNAL_TYPE tuner_type)
	Returns the number of entries in the rf channel table.
U8BIT *	ACTL_GetRfChanName (E_STB_DP_SIGNAL_TYPE tuner_type, U16BIT id)
	Returns a pointer to the channel name.
U8BIT *	ACTL_GetRfNameFromFreq (E_STB_DP_SIGNAL_TYPE tuner_type, U32BIT freq_hz)
	Returns the rf name appropriate to the frequency specified.
U32BIT	ACTL_GetRfChanFreqHz (E_STB_DP_SIGNAL_TYPE tuner_type, U16BIT id)
	Returns a pointer to the channel name.
U16BIT	ACTL_GetRfSymbolRate (E_STB_DP_SIGNAL_TYPE tuner_type, U16BIT id)
	Returns the channel symbol rate.
U8BIT	ACTL_GetRfModulation (E_STB_DP_SIGNAL_TYPE tuner_type, U16BIT id)
	Returns the modulation mode.
E_STB_DP_TTYPE	ACTL_GetTerRfChanType (U16BIT id)
	Returns the terrestrial type (T or T2) for the given channel id.
void	ACTL_EnableCiModule (void)
	Enables CI module.
void	ACTL_DisableCiModule (void)
	Disables CI module.
BOOLEAN	ACTL_IsCiUiRequired (void)
	Returns state of ci_ui_required flag.
BOOLEAN	ACTL_GetDecodePausedState (U8BIT path)
	Gets user paused flag value.
BOOLEAN	ACTL_StartSubtitles (void)
	Starts subtitle processing and display if the current service has valid subtitle data. If DVB subtitles aren't available, teletext will be used if available.
void	ACTL_PauseSubtitles (void)
	Disables the display of subtitles but processing continues.
void	ACTL_ResumeSubtitles (void)
	Resumes the display of subtitles after they've been paused.
void	ACTL_StopSubtitles (void)
	Stops subtitles from being displayed and processed.
BOOLEAN	ACTL_AreSubtitlesDisplayed (void)
	Returns whether subtitles are being displayed.
BOOLEAN	ACTL_AreSubtitlesStarted (void)
	Returns whether subtitles have been started, even if they aren't being displayed.
BOOLEAN	ACTL_IsAudioDescriptionOn (void)
	Returns whether audio description has been turned on.
BOOLEAN	ACTL_StartAudioDescription (U8BIT path)
	Starts decoding an audio description stream, if available, on the given path. If AD isn't currently available it will be marked as enabled and started when it becomes available.
void	ACTL_StopAudioDescription (U8BIT path)
	Stops AD decoding.
void	ACTL_SetADVolume (U8BIT volume)
	Sets the AD volume.
void	ACTL_SetParentalControl (BOOLEAN enabled)
	Enables or disables parental control. This enables or disables locking on a per channel basis. If an age has previously been set, this will override the setting, effectively turning off age related blockign of channels.
BOOLEAN	ACTL_ParentalControlEnabled (void)
	Returns whether parental control is enabled. This will also return TRUE if parental control has been set to a valid age.
void	ACTL_SetParentalControlAge (U8BIT age)
	Sets the age (valid values 4-18) at which parental control will be will be applied. If the age is invalid, no change will be made to the current setting.
U8BIT	ACTL_GetParentalControlAge (void)
	Returns the current age set for parental control. 0 will be returned if parental control is disabled or no age is set.
void	ACTL_ApplyParentalControl (U8BIT path, void *s_ptr)
	Checks the parental control for the current event on the given service to determine whether decoding should be locked.
void	ACTL_SetupPlayback (void)
	Starts the SI to acquire the PMT and fill the ip service in.
void	ACTL_StartPlayback (void *s_ptr)
	Start streaming the specified service.
U8BIT	ACTL_GetActivePath (void)
	Returns the active path (live, playback, etc...), i.e. the one using the decoders.
void	ACTL_StartDecoding (U8BIT path, void *s_ptr)
	Sets up and starts decoding for the given service. This is used for PVR playback, but could also be used to start decoding for other non-broadcast services.
void	ACTL_SetMhegAVControl (BOOLEAN control)
	Sets the MHEG5 audio volume adjust to be applied.
void	ACTL_SetMhegVolumeAdjustment (S8BIT volume)
	Sets the MHEG5 audio volume adjust to be applied.
U8BIT	ACTL_GetVolume (void)
	Returns the current audio volume.
U8BIT	ACTL_SetVolume (U8BIT volume)
	Sets the main audio volume and returns the new volume.
U8BIT	ACTL_ChangeVolume (S8BIT volume_change)
	Changes the main audio volume and returns the new volume.
void	ACTL_SetMute (BOOLEAN mute)
	Sets the audio mute state.
BOOLEAN	ACTL_ToggleMute (void)
	Toggles the current mute state and returns the new mute setting.
BOOLEAN	ACTL_IsMuted (void)
	Returns the muted state of the audio.
BOOLEAN	ACTL_SetActiveProfile (void *profile)
	Sets the current profile. (CI+ only) If the profile is being set to CI+ profile and the necessary CAM isn't present, then setting the profile will fail.
void	ACTL_InitialiseAppControl (void)
	Control system initialisation.
void	ACTL_ActionEvent (U32BIT event, void *event_data)
	Actions external events.
BOOLEAN	ACTL_CheckLiveServiceChange (void)
	Checks whether the service tuned to on the live path has changed and informs the UI if it has.
BOOLEAN	ACTL_HandlePrivateTimerEvent (U32BIT timer_handle)
	Handles all the private timer events.
void	ACTL_SetAnalogChanIdString (U8BIT *str_ptr)
void	ACTL_AllowAnalogVideo (BOOLEAN allow_analog_video)
	Enables or disables analog video display.

---

Detailed Description

Application stb layer control.

Date:

18/03/2003

---

Typedef Documentation

typedef void(* DSM_FILE_CALLBACK)(void *user_data, U8BIT *file_data, U32BIT data_size)

Prototype for function that's called when a file requested from a DSM-CC carousel is received.

Parameters:

user_data	user defined data passed when the file was requested
file_data	data
data_size	number of bytes of data

---

Function Documentation

U8BIT ACTL_AcquireLivePathForService	(	void *	s_ptr,
		S_ACTL_OWNER_INFO *	owner
	)

Acquires a decode path for viewing a live signal for the given service.

Parameters:

s_ptr	the service the decode path will be used for
owner_info	owner of the acquired path, should be NULL for live TV (used by CI+)

Returns:

ID of path or INVALID_RES_ID on failure

BOOLEAN ACTL_AcquirePathOwnership	(	U8BIT	path,
		S_ACTL_OWNER_INFO *	owner_info
	)

Attempts to take ownership of the given path (used by CI+)

Parameters:

path	decode path to be owned
owner_info	owner info for the path

Returns:

TRUE if the ownership is set, FALSE otherwise

void ACTL_ActionEvent	(	U32BIT	event,
		void *	event_data
	)

Actions external events.

Parameters:

event

the event to be handled

void ACTL_AllowAnalogVideo

(

BOOLEAN

allow_analog_video

)

Enables or disables analog video display.

Parameters:

allow_analog_video

if TRUE analog video is enabled, otherwise disabled

void ACTL_ApplyHDCP

(

void *

s_ptr

)

Checks content protection requirements for the current event on the given service to determine whether HDCP has to be used. The HDMI output will be enabled/disabled accordingly.

Parameters:

s_ptr

service

void ACTL_ApplyParentalControl	(	U8BIT	path,
		void *	s_ptr
	)

Checks the parental control for the current event on the given service to determine whether decoding should be locked.

Parameters:

path	decode path
s_ptr	service

BOOLEAN ACTL_CanServiceBeViewed

(

void *

s_ptr

)

Checks whether there's a tuner available to view the given service. This takes into account whether tuners are being used for recording or have been acquired by CI+.

Parameters:

s_ptr

service being checked

Returns:

TRUE if service can be viewed, FALSE otherwise

U8BIT ACTL_ChangeVolume

(

S8BIT

volume_change

)

Changes the main audio volume and returns the new volume.

Parameters:

volume_change

signed value giving change in volume to be applied

Returns:

The new volume on a scale of 0-100.

BOOLEAN ACTL_CheckLiveServiceChange

(

void

)

Checks whether the service tuned to on the live path has changed and informs the UI if it has.

Returns:

TRUE if the service has changed, FALSE otherwise

void ACTL_DecodeOff

(

U8BIT

path

)

Stops decoding on the given path.

Parameters:

path	decode path

void ACTL_FinishSSUUpdate

(

BOOLEAN

do_update

)

Once an update has been found or not then this function must be called to continue or terminate the update.

Parameters:

do_update

TRUE if the update is to be downloaded and installed, FALSE otherwise

U8BIT ACTL_GetActivePath

(

void

)

Returns the active path (live, playback, etc...), i.e. the one using the decoders.

Returns:

active path

E_STB_AV_VIDEO_FORMAT ACTL_GetActualVideoMode	(	U16BIT *	width,
		U16BIT *	height
	)

Reads the saved video format and returns the best mode available if it's set to AUTO or is invalid for the currently connected TV.

Parameters:

width	returns the new video width if saved mode isn't valid, can be NULL
height	returns the new video height if saved mode isn't valid, can be NULL

Returns:

current video mode, or best video mode available

E_ACTL_AV_MODE ACTL_GetAvModeStatus

(

void

)

Returns av_mode.

Returns:

Scart AV status

void* ACTL_GetCurrentSatellite

(

U8BIT

path

)

Returns the current satellite being used by the given decode path.

Parameters:

path	decode path

Returns:

Pointer to satellite

BOOLEAN ACTL_GetDecodePausedState

(

U8BIT

path

)

Gets user paused flag value.

path decode path

Returns:

TRUE if the subtitles are in paused mode, FALSE otherwise

U16BIT ACTL_GetHDMIResolutions	(	E_STB_AV_VIDEO_FORMAT **	video_formats,
		U16BIT *	current_index
	)

Returns an array of valid HDMI resolutions and the index of the currently selected format. The final entry in each array will be the auto video format.

Parameters:

video_formats	pointer to an array of video formats.
current_index	used to return index of currently selected video format

Returns:

Size of returned arrays, will always be at least 1

U16BIT ACTL_GetNumRfChanArrayEntries

(

E_STB_DP_SIGNAL_TYPE

tuner_type

)

Returns the number of entries in the rf channel table.

Parameters:

tuner_type

tuner type

Returns:

number of entries in the channel table for the present country

U8BIT ACTL_GetParentalControlAge

(

void

)

Returns the current age set for parental control. 0 will be returned if parental control is disabled or no age is set.

Returns:

age in the range 4-18, or 0

U32BIT ACTL_GetRfChanFreqHz	(	E_STB_DP_SIGNAL_TYPE	tuner_type,
		U16BIT	id
	)

Returns a pointer to the channel name.

Parameters:

tuner_type	tuner type
id	index in the channel table for the current country

Returns:

pointer to the const name string

U8BIT* ACTL_GetRfChanName	(	E_STB_DP_SIGNAL_TYPE	tuner_type,
		U16BIT	id
	)

Returns a pointer to the channel name.

Parameters:

tuner_type	tuner type
id	index in the channel table for the current country

Returns:

pointer to the const name string

U8BIT ACTL_GetRfModulation	(	E_STB_DP_SIGNAL_TYPE	tuner_type,
		U16BIT	id
	)

Returns the modulation mode.

Parameters:

tuner_type	tuner type
id	index in the channel table for the current country

Returns:

Modulation mode (E_STB_DP_TMODE or E_STB_DP_CMODE depending on the tuner type

U8BIT* ACTL_GetRfNameFromFreq	(	E_STB_DP_SIGNAL_TYPE	tuner_type,
		U32BIT	freq_hz
	)

Returns the rf name appropriate to the frequency specified.

Parameters:

tuner_type	tuner type
freq_hz	frequency in hz

Returns:

pointer to the const name string, or NULL if not found

U16BIT ACTL_GetRfSymbolRate	(	E_STB_DP_SIGNAL_TYPE	tuner_type,
		U16BIT	id
	)

Returns the channel symbol rate.

Parameters:

tuner_type	tuner type
id	index in the channel table for the current country

Returns:

symbol rate of selected id

U8BIT ACTL_GetSearchProgress

(

void

)

Returns search progress as a percentage. This works for any of the available types of searches, but the scope for providing progress on anything other than the service searches is fairly limited.

Returns:

Percent complete, 0 if not started

E_STB_DP_TTYPE ACTL_GetTerRfChanType

(

U16BIT

id

)

Returns the terrestrial type (T or T2) for the given channel id.

Parameters:

id	index in the terrestrial channel table for the current country
terrestrial	type for the channel

E_STB_AV_ASPECT_MODE ACTL_GetTVAspectMode

(

void

)

Returns the current TV aspect mode.

Returns:

aspect mode

E_STB_AV_ASPECT_RATIO ACTL_GetTVAspectRatio

(

void

)

Returns the current TV aspect ratio.

Returns:

aspect ratio

U8BIT ACTL_GetVolume

(

void

)

Returns the current audio volume.

Returns:

The current volume on a scale of 0-100.

BOOLEAN ACTL_HandlePrivateTimerEvent

(

U32BIT

timer_handle

)

Handles all the private timer events.

Parameters:

timer_handle

timer handle

Returns:

TRUE if the timer event has been handled, FALSE otherwise

BOOLEAN ACTL_HasDecodingStarted

(

U8BIT

path

)

Returns whether decoding has been started on the given path.

Parameters:

path	decode path

Returns:

TRUE if decoding has started, FALSE otherwise

BOOLEAN ACTL_IsAudioDescriptionOn

(

void

)

Returns whether audio description has been turned on.

Returns:

TRUE if AD is on

BOOLEAN ACTL_IsCiUiRequired

(

void

)

Returns state of ci_ui_required flag.

Returns:

TRUE if CI OPEN event has been received

BOOLEAN ACTL_IsDecodingLocked

(

U8BIT

path

)

Returns whether decoding is locked, due to parental locking, on the given path.

Parameters:

path	decode path

Returns:

TRUE if decoding is locked, FALSE otherwise

BOOLEAN ACTL_IsHDMIConnected

(

void

)

Returns whether the HDMI is connected or not.

Returns:

TRUE if the HDMI is connected, FALSE otherwise

BOOLEAN ACTL_IsMuted

(

void

)

Returns the muted state of the audio.

Returns:

TRUE if muted, FALSE otherwise

BOOLEAN ACTL_IsSearchComplete

(

void

)

Returns TRUE if current search has finished. This works for any of the available types of searches.

Returns:

TRUE if search has finished, FALSE otherwise

BOOLEAN ACTL_IsTargetRegionRequired

(

void

)

When the search has completed, this function should be called to see whether the target region UI should be presented. This is only needed for DVB-T/T2 searches.

Returns:

TRUE if target region UI is required, FALSE otherwise

BOOLEAN ACTL_IsTuned

(

U8BIT

path

)

Returns whether the given path is currently tuned.

Parameters:

path	decode path

Returns:

TRUE if tuned, FALSE otherwise

void ACTL_LeaveStandby	(	void *	s_ptr,
		BOOLEAN	tune_to_service
	)

Brings the DVB out of standby mode.

Parameters:

s_ptr	service to be tuned to for live viewing. If NULL then the last service viewed will be restored
tune_to_service	if s_ptr is NULL then this boolean is used to define whether to tune to the last service viewed

BOOLEAN ACTL_ParentalControlEnabled

(

void

)

Returns whether parental control is enabled. This will also return TRUE if parental control has been set to a valid age.

Returns:

TRUE if parental control is enabled, FALSE otherwise

void ACTL_ReleaseLivePathForService	(	void *	s_ptr,
		E_STB_DP_RES_OWNER	owner
	)

Finds the path being used to view the given service and releases it.

Parameters:

s_ptr	service pointer
owner	owner requesting the path to be released

BOOLEAN ACTL_ReleasePathOwnership	(	U8BIT	path,
		E_STB_DP_RES_OWNER	owner
	)

Releases ownership of the path, and frees any associated data, if the given owner is the path's owner (used by CI+)

Parameters:

path	decode path
owner	owner releasing ownership

Returns:

TRUE if the ownership is released or the path isn't owned, FALSE otherwise

BOOLEAN ACTL_SetActiveProfile

(

void *

profile

)

Sets the current profile. (CI+ only) If the profile is being set to CI+ profile and the necessary CAM isn't present, then setting the profile will fail.

Parameters:

profile

profile to be set

Returns:

TRUE if the profile is set successfully, FALSE otherwise

void ACTL_SetADVolume

(

U8BIT

volume

)

Sets the AD volume.

Parameters:

volume

AD volume as a percentage

void ACTL_SetMhegAVControl

(

BOOLEAN

control

)

Sets the MHEG5 audio volume adjust to be applied.

Parameters:

control

TRUE if MHEG has control of Audio/Video

void ACTL_SetMhegVolumeAdjustment

(

S8BIT

volume

)

Sets the MHEG5 audio volume adjust to be applied.

Parameters:

volume

volume on a scale of -127 to 128.

void ACTL_SetMute

(

BOOLEAN

mute

)

Sets the audio mute state.

Parameters:

mute	TRUE to set mute, FALSE otherwise

void ACTL_SetParentalControl

(

BOOLEAN

enabled

)

Enables or disables parental control. This enables or disables locking on a per channel basis. If an age has previously been set, this will override the setting, effectively turning off age related blockign of channels.

Parameters:

enabled

TRUE if parental control is to be enabled

void ACTL_SetParentalControlAge

(

U8BIT

age

)

Sets the age (valid values 4-18) at which parental control will be will be applied. If the age is invalid, no change will be made to the current setting.

Parameters:

age	DVB SI age to be set

void ACTL_SetStandbyState

(

BOOLEAN

state

)

Reports the standby state to the A/V output controller.

Parameters:

state

TRUE for standby is on, FALSE for standby is off

void ACTL_SetTVAspectConversion	(	E_STB_AV_ASPECT_RATIO	aspect_ratio,
		E_STB_AV_ASPECT_MODE	aspect_mode
	)

Used to set the aspect conversion applied to the video based on the TV aspect ratio and aspect mode to be applied. The given settings will also be saved.

Parameters:

aspect_ratio	TV aspect ratio, e.g. 4:3
aspect_mode	TV aspect mode, e.g. letterbox

void ACTL_SetTVAspectMode

(

E_STB_AV_ASPECT_MODE

aspect_mode

)

Used to set the TV aspect mode which defines how the video will be displayed based on the aspect ratio of the TV and video, along with some other factors.

Parameters:

aspect_mode

TV aspect mode, e.g. letterbox

void ACTL_SetTVAspectRatio

(

E_STB_AV_ASPECT_RATIO

aspect_ratio

)

Used to set the TV aspect ratio.

Parameters:

aspect_ratio

TV aspect ratio, e.g. 4:3

void ACTL_SetVideoWindow	(	S16BIT	win_x,
		S16BIT	win_y,
		U16BIT	win_width,
		U16BIT	win_height
	)

Sets the video window to the size specified. Coordinates are relative to the screen resolution.

Parameters:

win_x	window X position
win_y	window Y position
win_width	window width (0 for full screen)
win_height	window height (0 for full screen)

U8BIT ACTL_SetVolume

(

U8BIT

volume

)

Sets the main audio volume and returns the new volume.

Parameters:

volume

unsigned value giving volume to be applied

Returns:

The new volume on a scale of 0-100.

BOOLEAN ACTL_StartAudioDescription

(

U8BIT

path

)

Starts decoding an audio description stream, if available, on the given path. If AD isn't currently available it will be marked as enabled and started when it becomes available.

Parameters:

path	decode path

Returns:

TRUE if AD is turned on, FALSE otherwise

void ACTL_StartDecoding	(	U8BIT	path,
		void *	s_ptr
	)

Sets up and starts decoding for the given service. This is used for PVR playback, but could also be used to start decoding for other non-broadcast services.

Parameters:

path	decode path
s_ptr	service

BOOLEAN ACTL_StartEitSearch

(

void

)

Entry point for starting an EIT search.

Returns:

TRUE if search starts successfully, FALSE otherwise

BOOLEAN ACTL_StartManualSearch	(	E_STB_DP_SIGNAL_TYPE	tuner_type,
		S_MANUAL_TUNING_PARAMS *	tuning_params,
		E_ACTL_SEARCH_TYPE	type
	)

Start a service search on, or just tune to, the transport defined by the given tuning parameters.

Parameters:

tuner_type	tuner type to be used for the search
tuning_params	user defined tuning parameters
type	type of service search to be performed

Returns:

TRUE if the search is started successfully, FALSE otherwise

BOOLEAN ACTL_StartManualSearchById	(	E_STB_DP_SIGNAL_TYPE	tuner_type,
		U16BIT	chan_id,
		BOOLEAN	start_search
	)

Start a service search on, or just tune to, a transport, using chan_id as an index into the country's tuning table.

Parameters:

tuner_type	tuner type to be used for the search
chan_id	index into the country's channel array to tune to
start_search	TRUE if a service search is to be started, otherwise just tune

Returns:

TRUE on success, FALSE otherwise

void ACTL_StartPlayback

(

void *

s_ptr

)

Start streaming the specified service.

Parameters:

s_ptr

the pointer to the service structure containing all the information

BOOLEAN ACTL_StartServiceSearch	(	E_STB_DP_SIGNAL_TYPE	tuner_type,
		E_ACTL_SEARCH_TYPE	type
	)

Entry point for starting a service search for a full retune or to update the existing service lineup.

Parameters:

tuner_type	tuner type that defines the search to be performed
type	type of service search to be performed

Returns:

TRUE if search starts successfully, FALSE otherwise

BOOLEAN ACTL_StartSSUSearch

(

void

)

Function to start a search to see if there's an SSU available.

Returns:

TRUE if the search is started, FALSE otherwise

BOOLEAN ACTL_StartSSUUpdate

(

void *

t_ptr

)

Starts an SSU update on the given transport. The update may still fail if the transport is later found not to contain an update for the system. If the update isn't mandatory then the process must be continued to actually perform the update.

Parameters:

t_ptr

transport containing the SSU

Returns:

TRUE if the SSU update process starts, FALSE otherwise

BOOLEAN ACTL_StartStartupSearch

(

void

)

Function to start the startup search when booting from cold. This search checks the validity of the services contained in the database. It's only valid for DVB-T/T2 and DVB-C.

Returns:

TRUE if the search is started, FALSE otherwise

BOOLEAN ACTL_StartSubtitles

(

void

)

Starts subtitle processing and display if the current service has valid subtitle data. If DVB subtitles aren't available, teletext will be used if available.

Returns:

TRUE if started, FALSE otherwise

BOOLEAN ACTL_StartTotSearch

(

void

)

Function to start a TOT search which is required to set the system clock when starting from power off if a real-time clock isn't available.

Returns:

TRUE if the search is started, FALSE otherwise

void ACTL_StopAudioDescription

(

U8BIT

path

)

Stops AD decoding.

Parameters:

path	decode path

BOOLEAN ACTL_ToggleMute

(

void

)

Toggles the current mute state and returns the new mute setting.

Returns:

The new mute setting, TRUE = muted

void ACTL_TuneOff

(

U8BIT

path

)

Stops tuning on the given path.

Parameters:

path	decode path

BOOLEAN ACTL_TuneToRfChanArrayAnalogEntry	(	U8BIT	path,
		U16BIT	id
	)

Tunes to the specified rf channel array entry in analogue mode.

Parameters:

path	decode path id index in the analogue channel table for the current country

Returns:

TRUE if id valid, FALSE otherwise

BOOLEAN ACTL_TuneToRfChanArrayEntry	(	U8BIT	path,
		U16BIT	id,
		E_ACTL_SI_SRCH_REQD	reqd_si,
		BOOLEAN	relock_on
	)

Tunes to the specified rf channel array entry for DVB-T and DVB-C.

Parameters:

path	decode path
id	index in the current channel table (for the current signal type and country)
reqd_si	the type of SI handling required
relock_on	if FALSE auto relock will be turned off before tuning, otherwise it will be on

Returns:

TRUE if id valid, FALSE otherwise

U8BIT ACTL_TuneToService	(	U8BIT	path,
		S_ACTL_OWNER_INFO *	owner_info,
		void *	s_ptr,
		BOOLEAN	override_lock,
		BOOLEAN	for_live
	)

Starts the process of tuning to the specified service. If the service is to be tuned on the live path, then path should be passed as INVALID_RES_ID to ensure that any CI+ resource handling is performed.

Parameters:

path	decode path, INVALID_RES_ID for the live path
owner_info	owner module requesting the tune, can be NULL (used by CI+)
s_ptr	required service
override_lock	TRUE if parental lock settings are to be ignored.
for_live	FALSE for recording, TRUE otherwise

Returns:

decode path that is being used to tune to the service. Returning INVALID_RES_ID means the path couldn't be acquired immediately and doesn't mean that it has failed

void ACTL_TuneToTransport	(	U8BIT	path,
		S_ACTL_OWNER_INFO *	owner_info,
		void *	t_ptr,
		E_ACTL_SI_SRCH_REQD	reqd_si,
		BOOLEAN	relock_on
	)

Tunes to the given transport and sets the type of SI monitoring that will be started when the tuning completes.

Parameters:

path	decode path, use INVALID_RES_ID to allow the DVB to acquire an appropriate path
owner_info	owner info for the path, can be NULL (used by CI+)
t_ptr	transport to tune to
reqd_si	type of SI monitoring to be started when tuned
relock_on	TRUE if the tuner is to attempt to relock if the signal is lost

BOOLEAN ACTL_TuneToUserDefinedParams	(	U8BIT	path,
		S_MANUAL_TUNING_PARAMS *	tuning_params,
		E_ACTL_SI_SRCH_REQD	reqd_si,
		BOOLEAN	relock_on
	)

Tunes to the given set of tuning parameters.

Parameters:

path	decode path
tuning_params	tuning parameters to be used
reqd_si	SI search mode to be used if tuning is successful
relock_on	defines whether the tuner is to attempt to relock if lock is lost

Returns:

TRUE if tuning is started, FALSE otherwise

BOOLEAN ACTL_TuneUsingDSD	(	U8BIT	path,
		SI_DELIVERY_SYS_DESC_TYPE	dsd_type,
		SI_DELIVERY_SYS_DESC *	dsd,
		U16BIT	service_id,
		E_ACTL_SI_SRCH_REQD	reqd_si
	)

Starts the process of tuning to a given transport or service that's defined by the given delivery system descriptor. If the DSD defines a transport that doesn't currently exist, then one will be created, and if a service_id is given and a service with this ID doesn't exist on the transport, then one will be created, but will be marked as hidden and non-selectable so it won't appear to a user.

Parameters:

path	decode path to be tuned, must be valid
dsd_type	delivery system descriptor type (T, C or S)
dsd	delivery system descriptor
service_id	pass as 0 if just tuning to a transport
reqd_si	SI processing mode that should be selected when tuned. If tuning to a service the normal UPDATE mode will be used and this setting will be ignored.

Returns:

TRUE if the tune operation is started, FALSE otherwise

void ACTL_UpdateVideoMode	(	E_STB_AV_ASPECT_RATIO	aspect,
		BOOLEAN	force
	)

Update video mode sets Voyager resolution as well as platform Also, stops subtitles during the operation. If HDMI resolution mode is not supported, it chooses the best one available.

Parameters:

aspect	TV aspect ratio, e.g. 4:3 or 16:9
force	forces resolution update when TRUE