![]() |
DVBCore
22.3.0
Open Source DVB Engine
|
Application stb layer control. More...
#include "techtype.h"
#include "ap_common.h"
#include "stbhwav.h"
#include "stbhwdmx.h"
#include "vtctype.h"
#include "stbdpc.h"
#include "ap_si.h"
Go to the source code of this file.
Classes | |
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_IP_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. More... | |
typedef U16BIT(* | F_ServiceGetSubtitlePid) (void *serv_ptr, ADB_SUBT_INFO *subt_info) |
Function pointer definition: Determines subtitle PID and whether it is DVB or teletext, for the given service. More... | |
typedef U16BIT(* | F_GetExtraPidList) (E_ACTL_PATH_PURPOSE purpose, void *serv_ptr, U8BIT *pmt_data, U16BIT pmt_length, S_DMX_PID_INFO **pid_array) |
Prototype for a function that's called to return an array of PIDs that need to be included for a service, in addition to the usual ones for audio, video, subtitles, PMT, etc. More... | |
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. More... | |
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. More... | |
void | ACTL_StopServiceSearch (void) |
Function to stop the service search before it completes. | |
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. More... | |
BOOLEAN | ACTL_StartTotSearch (E_STB_DP_SIGNAL_TYPE tuner_type) |
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. More... | |
void | ACTL_StopTotSearch (void) |
Function to stop the TOT search before it completes. | |
BOOLEAN | ACTL_StartEitSearch (E_STB_DP_SIGNAL_TYPE tuner_type, E_ACTL_EVENT_SEARCH search_type) |
Entry point for starting an EIT search. More... | |
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. More... | |
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. More... | |
U8BIT | ACTL_GetServiceSearchPath (void) |
Returns path used buy currently running search. This works for any of the available types of searches, but the scope for providing path on anything other than the service searches is fairly limited. More... | |
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. More... | |
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. More... | |
void | ACTL_FinishManualSearch (void) |
Function to be called when a manual service search has completed, or is being stopped. | |
U8BIT | ACTL_AcquirePathForService (void *s_ptr, E_ACTL_PATH_PURPOSE purpose, S_ACTL_OWNER_INFO *owner) |
Acquires a decode path suitable for tuning to the given service. More... | |
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. More... | |
BOOLEAN | ACTL_ReleasePath (U8BIT path) |
Releases the decode path and all resources no longer needed. The path may not be released if the path is owned by a module. More... | |
BOOLEAN | ACTL_AcquirePathOwnership (U8BIT path, S_ACTL_OWNER_INFO *owner_info) |
Attempts to take ownership of the given path (used by CI+) More... | |
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+) More... | |
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+. More... | |
void * | ACTL_GetCurrentSatellite (U8BIT path) |
Returns the current satellite being used by the given decode path. More... | |
U8BIT | 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. More... | |
U8BIT | ACTL_TuneToService (U8BIT path, S_ACTL_OWNER_INFO *owner_info, void *s_ptr, BOOLEAN override_lock, E_ACTL_PATH_PURPOSE purpose) |
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. More... | |
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. More... | |
BOOLEAN | ACTL_IsTuned (U8BIT path) |
Returns whether the given path is currently tuned. More... | |
void | ACTL_TuneOff (U8BIT path) |
Stops tuning on the given path. More... | |
void | ACTL_DecodeOff (U8BIT path) |
Stops decoding on the given path. More... | |
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. More... | |
BOOLEAN | ACTL_IsDecodingLocked (U8BIT path) |
Returns whether decoding is locked, due to parental locking, on the given path. More... | |
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. More... | |
BOOLEAN | ACTL_TuneToRfChanArrayAnalogEntry (U8BIT path, U16BIT id) |
Tunes to the specified rf channel array entry in analogue mode. More... | |
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. More... | |
void | ACTL_SetStandbyGracePeriod (U16BIT num_seconds) |
Sets a grace period during which a system will enter active standby before going into passive or low power standby. This allows a system to be brought back out of standby quickly for a period of time. More... | |
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. More... | |
void | ACTL_SetStandbyState (BOOLEAN state) |
Reports the standby state to the A/V output controller. More... | |
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. More... | |
void | ACTL_SetTVAspectRatio (E_STB_AV_ASPECT_RATIO aspect_ratio) |
Used to set the TV aspect ratio. More... | |
E_STB_AV_ASPECT_RATIO | ACTL_GetTVAspectRatio (void) |
Returns the current TV aspect ratio. More... | |
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. More... | |
E_STB_AV_ASPECT_MODE | ACTL_GetTVAspectMode (void) |
Returns the current TV aspect mode. More... | |
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. More... | |
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. More... | |
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. As this function also re evaluates if HDMI should be disabled based on the HDCP status, it depends on the event only having being sent after HDCP authentication has finished. | |
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. More... | |
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. More... | |
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. More... | |
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. More... | |
E_ACTL_AV_MODE | ACTL_GetAvModeStatus (void) |
Returns av_mode. More... | |
U16BIT | ACTL_GetNumRfChanArrayEntries (E_STB_DP_SIGNAL_TYPE tuner_type) |
Returns the number of entries in the rf channel table. More... | |
U8BIT * | ACTL_GetRfChanName (E_STB_DP_SIGNAL_TYPE tuner_type, U16BIT id) |
Returns a pointer to the channel name. More... | |
U8BIT * | ACTL_GetRfNameFromFreq (E_STB_DP_SIGNAL_TYPE tuner_type, U32BIT freq_hz) |
Returns the rf name appropriate to the frequency specified. More... | |
U32BIT | ACTL_GetRfChanFreqHz (E_STB_DP_SIGNAL_TYPE tuner_type, U16BIT id) |
Returns a pointer to the channel name. More... | |
U16BIT | ACTL_GetRfSymbolRate (E_STB_DP_SIGNAL_TYPE tuner_type, U16BIT id) |
Returns the channel symbol rate. More... | |
U8BIT | ACTL_GetRfModulation (E_STB_DP_SIGNAL_TYPE tuner_type, U16BIT id) |
Returns the modulation mode. More... | |
E_STB_DP_TTYPE | ACTL_GetTerRfChanType (U16BIT id) |
Returns the terrestrial type (T or T2) for the given channel id. More... | |
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. More... | |
BOOLEAN | ACTL_GetDecodePausedState (U8BIT path) |
Gets user paused flag value. More... | |
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. More... | |
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_SuppressSubtitles (BOOLEAN suppress) |
Stops subtitles being displayed if another OSD requires them to be hidden, such as CI+. More... | |
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. More... | |
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. More... | |
void | ACTL_StopAudioDescription (U8BIT path) |
Stops AD decoding. More... | |
void | ACTL_SetADVolume (U8BIT volume) |
Sets the AD volume. More... | |
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. More... | |
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. More... | |
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. More... | |
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. More... | |
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. More... | |
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. More... | |
U8BIT | ACTL_GetActivePath (void) |
Returns the active path (live, playback, etc...), i.e. the one using the decoders. More... | |
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. More... | |
void | ACTL_SetMhegAVControl (BOOLEAN control) |
Sets the MHEG5 audio volume adjust to be applied. More... | |
void | ACTL_SetMhegSubtitlePidFunc (F_ServiceGetSubtitlePid func) |
Sets function retrieve Subtitle PID and info. Allows external MHEG5 module to override the default function ADB_ServiceGetSubtitlePid. More... | |
void | ACTL_SetVolumeAdjustment (S8BIT scaling) |
Sets the MHEG5 audio volume adjust to be applied. More... | |
U8BIT | ACTL_GetVolume (void) |
Returns the current audio volume. More... | |
U8BIT | ACTL_SetVolume (U8BIT volume) |
Sets the main audio volume and returns the new volume. More... | |
U8BIT | ACTL_ChangeVolume (S8BIT volume_change) |
Changes the main audio volume and returns the new volume. More... | |
void | ACTL_SetMute (BOOLEAN mute) |
Sets the audio mute state. More... | |
BOOLEAN | ACTL_ToggleMute (void) |
Toggles the current mute state and returns the new mute setting. More... | |
BOOLEAN | ACTL_IsMuted (void) |
Returns the muted state of the audio. More... | |
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. More... | |
E_ACTL_DECODE_CHANGE | ACTL_SetupAudioDecoding (U8BIT path, void *s_ptr) |
Setup default audio decoding params on current tuned service Can be used by external module (e.g. MHEG5) More... | |
void | ACTL_SetExtraPidListCallback (F_GetExtraPidList pidlist_callback) |
Sets the callback function that will be used to get the extra PIDs to be included when a service is streamed. More... | |
void | ACTL_InitialiseAppControl (void) |
Control system initialisation. | |
void | ACTL_ActionEvent (U32BIT event, void *event_data) |
Actions external events. More... | |
BOOLEAN | ACTL_CheckLiveServiceChange (void) |
Checks whether the service tuned to on the live path has changed and informs the UI if it has. More... | |
BOOLEAN | ACTL_HandlePrivateTimerEvent (U32BIT timer_handle) |
Handles all the private timer events. More... | |
void | ACTL_SetAnalogChanIdString (U8BIT *str_ptr) |
sends string to be displayed via pixelworks if it has changed (Must not send message to PixelWorks if there is no need - it is too slow) More... | |
void | ACTL_AllowAnalogVideo (BOOLEAN allow_analog_video) |
Enables or disables analog video display. More... | |
Application stb layer control.
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.
user_data | user defined data passed when the file was requested |
file_data | data |
data_size | number of bytes of data |
typedef U16BIT(* F_GetExtraPidList) (E_ACTL_PATH_PURPOSE purpose, void *serv_ptr, U8BIT *pmt_data, U16BIT pmt_length, S_DMX_PID_INFO **pid_array) |
Prototype for a function that's called to return an array of PIDs that need to be included for a service, in addition to the usual ones for audio, video, subtitles, PMT, etc.
serv_ptr | handle of the service to be viewed |
pmt_data | pointer to the raw PMT data for the service. This must not be changed or deleted |
pmt_length | number of bytes in the PMT |
pid_array | pointer to an array that the function should allocate containing the PID details. The array will be freed using STB_AppFreeMemory, so should be allocated using STB_AppGetMemory. |
typedef U16BIT(* F_ServiceGetSubtitlePid) (void *serv_ptr, ADB_SUBT_INFO *subt_info) |
Function pointer definition: Determines subtitle PID and whether it is DVB or teletext, for the given service.
serv_ptr | service |
subt_info | pointer to ADB_SUBT_INFO for extra info on subtitles |
U8BIT ACTL_AcquirePathForService | ( | void * | s_ptr, |
E_ACTL_PATH_PURPOSE | purpose, | ||
S_ACTL_OWNER_INFO * | owner_info | ||
) |
Acquires a decode path suitable for tuning to the given service.
s_ptr | the service the decode path will be used for |
purpose | the purpose the path is being acquired, live, recording, etc |
owner_info | owner of the acquired path, should be NULL for live TV (used by CI+) |
BOOLEAN ACTL_AcquirePathOwnership | ( | U8BIT | path, |
S_ACTL_OWNER_INFO * | owner_info | ||
) |
Attempts to take ownership of the given path (used by CI+)
path | decode path to be owned |
owner_info | owner info for the path |
void ACTL_ActionEvent | ( | U32BIT | event, |
void * | event_data | ||
) |
Actions external events.
event | the event to be handled |
void ACTL_AllowAnalogVideo | ( | BOOLEAN | allow_analog_video | ) |
Enables or disables analog video display.
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.
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.
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+.
s_ptr | service being checked |
U8BIT ACTL_ChangeVolume | ( | S8BIT | volume_change | ) |
Changes the main audio volume and returns the new volume.
volume_change | signed value giving change in volume to be applied |
BOOLEAN ACTL_CheckLiveServiceChange | ( | void | ) |
Checks whether the service tuned to on the live path has changed and informs the UI if it has.
void ACTL_DecodeOff | ( | U8BIT | path | ) |
Stops decoding on the given path.
path | decode path |
U8BIT ACTL_GetActivePath | ( | void | ) |
Returns the active path (live, playback, etc...), i.e. the one using the decoders.
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.
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 |
E_ACTL_AV_MODE ACTL_GetAvModeStatus | ( | void | ) |
Returns av_mode.
void* ACTL_GetCurrentSatellite | ( | U8BIT | path | ) |
Returns the current satellite being used by the given decode path.
path | decode path |
BOOLEAN ACTL_GetDecodePausedState | ( | U8BIT | path | ) |
Gets user paused flag value.
path decode path
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.
video_formats | pointer to an array of video formats. |
current_index | used to return index of currently selected video format |
U16BIT ACTL_GetNumRfChanArrayEntries | ( | E_STB_DP_SIGNAL_TYPE | tuner_type | ) |
Returns the number of entries in the rf channel table.
tuner_type | tuner type |
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.
U32BIT ACTL_GetRfChanFreqHz | ( | E_STB_DP_SIGNAL_TYPE | tuner_type, |
U16BIT | id | ||
) |
Returns a pointer to the channel name.
tuner_type | tuner type |
id | index in the channel table for the current country |
U8BIT* ACTL_GetRfChanName | ( | E_STB_DP_SIGNAL_TYPE | tuner_type, |
U16BIT | id | ||
) |
Returns a pointer to the channel name.
tuner_type | tuner type |
id | index in the channel table for the current country |
U8BIT ACTL_GetRfModulation | ( | E_STB_DP_SIGNAL_TYPE | tuner_type, |
U16BIT | id | ||
) |
Returns the modulation mode.
tuner_type | tuner type |
id | index in the channel table for the current country |
U8BIT* ACTL_GetRfNameFromFreq | ( | E_STB_DP_SIGNAL_TYPE | tuner_type, |
U32BIT | freq_hz | ||
) |
Returns the rf name appropriate to the frequency specified.
tuner_type | tuner type |
freq_hz | frequency in hz |
U16BIT ACTL_GetRfSymbolRate | ( | E_STB_DP_SIGNAL_TYPE | tuner_type, |
U16BIT | id | ||
) |
Returns the channel symbol rate.
tuner_type | tuner type |
id | index in the channel table for the current country |
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.
U8BIT ACTL_GetServiceSearchPath | ( | void | ) |
Returns path used buy currently running search. This works for any of the available types of searches, but the scope for providing path on anything other than the service searches is fairly limited.
E_STB_DP_TTYPE ACTL_GetTerRfChanType | ( | U16BIT | id | ) |
Returns the terrestrial type (T or T2) for the given channel id.
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.
E_STB_AV_ASPECT_RATIO ACTL_GetTVAspectRatio | ( | void | ) |
Returns the current TV aspect ratio.
U8BIT ACTL_GetVolume | ( | void | ) |
Returns the current audio volume.
BOOLEAN ACTL_HandlePrivateTimerEvent | ( | U32BIT | timer_handle | ) |
Handles all the private timer events.
timer_handle | timer handle |
BOOLEAN ACTL_HasDecodingStarted | ( | U8BIT | path | ) |
Returns whether decoding has been started on the given path.
path | decode path |
BOOLEAN ACTL_IsAudioDescriptionOn | ( | void | ) |
Returns whether audio description has been turned on.
BOOLEAN ACTL_IsCiUiRequired | ( | void | ) |
Returns state of ci_ui_required flag.
BOOLEAN ACTL_IsDecodingLocked | ( | U8BIT | path | ) |
Returns whether decoding is locked, due to parental locking, on the given path.
path | decode path |
BOOLEAN ACTL_IsHDMIConnected | ( | void | ) |
Returns whether the HDMI is connected or not.
BOOLEAN ACTL_IsMuted | ( | void | ) |
Returns the muted state of the audio.
BOOLEAN ACTL_IsSearchComplete | ( | void | ) |
Returns TRUE if current search has finished. This works for any of the available types of searches.
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.
BOOLEAN ACTL_IsTuned | ( | U8BIT | path | ) |
Returns whether the given path is currently tuned.
path | decode path |
void ACTL_LeaveStandby | ( | void * | s_ptr, |
BOOLEAN | tune_to_service | ||
) |
Brings the DVB out of standby mode.
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.
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.
s_ptr | service pointer |
owner | owner requesting the path to be released |
BOOLEAN ACTL_ReleasePath | ( | U8BIT | path | ) |
Releases the decode path and all resources no longer needed. The path may not be released if the path is owned by a module.
path | decode path |
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+)
path | decode path |
owner | owner releasing ownership |
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.
profile | profile to be set |
void ACTL_SetADVolume | ( | U8BIT | volume | ) |
Sets the AD volume.
volume | AD volume as a percentage |
void ACTL_SetAnalogChanIdString | ( | U8BIT * | str_ptr | ) |
sends string to be displayed via pixelworks if it has changed (Must not send message to PixelWorks if there is no need - it is too slow)
U8BIT* | str_ptr |
void ACTL_SetExtraPidListCallback | ( | F_GetExtraPidList | pidlist_callback | ) |
Sets the callback function that will be used to get the extra PIDs to be included when a service is streamed.
pidlist_callback | pointer to the callback function |
void ACTL_SetMhegAVControl | ( | BOOLEAN | control | ) |
Sets the MHEG5 audio volume adjust to be applied.
control | TRUE if MHEG has control of Audio/Video |
void ACTL_SetMhegSubtitlePidFunc | ( | F_ServiceGetSubtitlePid | func | ) |
Sets function retrieve Subtitle PID and info. Allows external MHEG5 module to override the default function ADB_ServiceGetSubtitlePid.
func | Function to get subtitle info, NULL if use default |
void ACTL_SetMute | ( | BOOLEAN | mute | ) |
Sets the audio mute state.
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.
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.
age | DVB SI age to be set |
void ACTL_SetStandbyGracePeriod | ( | U16BIT | num_seconds | ) |
Sets a grace period during which a system will enter active standby before going into passive or low power standby. This allows a system to be brought back out of standby quickly for a period of time.
num_seconds | grace period in seconds |
void ACTL_SetStandbyState | ( | BOOLEAN | state | ) |
Reports the standby state to the A/V output controller.
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.
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.
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.
aspect_ratio | TV aspect ratio, e.g. 4:3 |
E_ACTL_DECODE_CHANGE ACTL_SetupAudioDecoding | ( | U8BIT | path, |
void * | s_ptr | ||
) |
Setup default audio decoding params on current tuned service Can be used by external module (e.g. MHEG5)
path | decode path to be owned |
s_ptr | service pointer |
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.
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.
volume | unsigned value giving volume to be applied |
void ACTL_SetVolumeAdjustment | ( | S8BIT | scaling | ) |
Sets the MHEG5 audio volume adjust to be applied.
scaling | the volume scaling from -100% to 100% |
Sets the MHEG5 audio volume adjust to be applied.
Adjusting | the volume from -100% to 100%, i.e. adjusting it to silent or double. |
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.
path | decode path |
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.
path | decode path |
s_ptr | service |
BOOLEAN ACTL_StartEitSearch | ( | E_STB_DP_SIGNAL_TYPE | tuner_type, |
E_ACTL_EVENT_SEARCH | search_type | ||
) |
Entry point for starting an EIT search.
tuner_type | limit the search to transports of this tuner type; pass as SIGNAL_NONE for all transports |
search_type | event search type to be performed, p/f only, sched only, or both |
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.
tuner_type | tuner type to be used for the search |
tuning_params | user defined tuning parameters |
type | type of service search to be performed |
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.
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 |
void ACTL_StartPlayback | ( | void * | s_ptr | ) |
Start streaming the specified service.
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.
tuner_type | tuner type that defines the search to be performed |
type | type of service search to be performed |
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_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.
BOOLEAN ACTL_StartTotSearch | ( | E_STB_DP_SIGNAL_TYPE | tuner_type | ) |
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.
tuner_type | restrict TOT search to transports of the given type; SIGNAL_NONE means all available transports will be used. |
void ACTL_StopAudioDescription | ( | U8BIT | path | ) |
Stops AD decoding.
path | decode path |
BOOLEAN ACTL_SuppressSubtitles | ( | BOOLEAN | suppress | ) |
Stops subtitles being displayed if another OSD requires them to be hidden, such as CI+.
BOOLEAN ACTL_ToggleMute | ( | void | ) |
Toggles the current mute state and returns the new mute setting.
void ACTL_TuneOff | ( | U8BIT | path | ) |
Stops tuning on the given path.
path | decode path |
BOOLEAN ACTL_TuneToRfChanArrayAnalogEntry | ( | U8BIT | path, |
U16BIT | id | ||
) |
Tunes to the specified rf channel array entry in analogue mode.
path | decode path id index in the analogue channel table for the current country |
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.
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 |
U8BIT ACTL_TuneToService | ( | U8BIT | path, |
S_ACTL_OWNER_INFO * | owner_info, | ||
void * | s_ptr, | ||
BOOLEAN | override_lock, | ||
E_ACTL_PATH_PURPOSE | purpose | ||
) |
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.
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. |
purpose | if no decode path is given then this is the purpose that will be used to acquire one |
U8BIT 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.
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.
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 |
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.
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. |
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.
aspect | TV aspect ratio, e.g. 4:3 or 16:9 |
force | forces resolution update when TRUE |
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.
aspect | TV aspect ratio, e.g. 4:3 or 16:9 |
force | forces resolution update when TRUE |