DVBCore  22.11.0
Open Source DVB Engine
ap_cntrl.h
Go to the documentation of this file.
1 /*******************************************************************************
2  * Copyright © 2014 The DTVKit Open Software Foundation Ltd (www.dtvkit.org)
3  * Copyright © 2004 Ocean Blue Software Ltd
4  *
5  * This file is part of a DTVKit Software Component
6  * You are permitted to copy, modify or distribute this file subject to the terms
7  * of the DTVKit 1.0 Licence which can be found in licence.txt or at www.dtvkit.org
8  *
9  * THIS CODE AND INFORMATION ARE PROVIDED "AS IS" WITHOUT WARRANTY OF ANY KIND,
10  * EITHER EXPRESSED OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE IMPLIED WARRANTIES
11  * OF MERCHANTABILITY AND/OR FITNESS FOR A PARTICULAR PURPOSE.
12  *
13  * If you or your organisation is not a member of DTVKit then you have access
14  * to this source code outside of the terms of the licence agreement
15  * and you are expected to delete this and any associated files immediately.
16  * Further information on DTVKit, membership and terms can be found at www.dtvkit.org
17  *******************************************************************************/
24 // pre-processor mechanism so multiple inclusions don't cause compilation error
25 
26 #ifndef _AP_CNTRL_H
27 #define _AP_CNTRL_H
28 
29 #include "techtype.h"
30 #include "ap_common.h"
31 #include "stbhwav.h"
32 #include "stbhwdmx.h"
33 #include "vtctype.h"
34 #include "stbdpc.h"
35 
36 #ifdef INCLUDE_OTA_SSU
37 #include "stbota.h"
38 #endif
39 
40 #ifdef INTEGRATE_HBBTV
41 #include "hbbtv_api.h"
42 #endif
43 
44 #include "ap_si.h"
45 
46 //---Constant and macro definitions for public use-----------------------------
47 
48 
49 //---Enumerations for public use-----------------------------------------------
50 
51 typedef enum
52 {
53  ACTL_SI_NO_SEARCH,
54  ACTL_SI_CHANNEL_SEARCH,
55  ACTL_SI_CHANNEL_SEARCH_NO_NIT,
56  ACTL_SI_STARTUP_SEARCH,
57  ACTL_SI_EVENT_PF_SEARCH,
58  ACTL_SI_EVENT_SCHED_SEARCH,
59  ACTL_SI_EVENT_PF_SCHED_SEARCH,
60  ACTL_SI_DVB_SSU_SEARCH,
61  ACTL_SI_TOT_SEARCH,
62  ACTL_SI_USER_DEFINED
63 } E_ACTL_SI_SRCH_REQD;
64 
65 typedef enum
66 {
67  ACTL_FREQ_SEARCH,
68  ACTL_NETWORK_SEARCH,
69  ACTL_NETWORK_SEARCH_ALL_NITS
70 } E_ACTL_SEARCH_TYPE;
71 
72 typedef enum
73 {
74  ACTL_EVENT_SEARCH_PF,
75  ACTL_EVENT_SEARCH_SCHED,
76  ACTL_EVENT_SEARCH_PF_SCHED
77 } E_ACTL_EVENT_SEARCH;
78 
79 typedef enum
80 {
81  ACTL_STANDBY_MODE,
82  ACTL_STANDBY_SCART_MODE,
83  ACTL_TV_MODE,
84  ACTL_SCART_MODE,
85  ACTL_INT_DVD_MODE
86 } E_ACTL_AV_MODE;
87 
88 typedef enum
89 {
90  ACTL_NO_CHANGE,
91  ACTL_AUDIO_CHANGE,
92  ACTL_ADESC_CHANGE,
93  ACTL_BOTH_CHANGED
94 } E_ACTL_DECODE_CHANGE;
95 
96 typedef enum
97 {
98  ACTL_PATH_PURPOSE_RECORDING,
99  ACTL_PATH_PURPOSE_LIVE,
100  ACTL_PATH_PURPOSE_MONITOR_SI,
101  ACTL_PATH_PURPOSE_STREAM_LIVE,
102  ACTL_PATH_PURPOSE_STREAM_RECORD,
103  ACTL_PATH_PURPOSE_NONE
104 } E_ACTL_PATH_PURPOSE;
105 
106 
107 //---Global type defs for public use-------------------------------------------
108 typedef struct
109 {
110  S8BIT offset;
111  E_STB_DP_ANALOG_VIDEO_TYPE vtype;
113 
114 typedef struct
115 {
116  E_STB_DP_TBWIDTH bwidth;
117  E_STB_DP_TMODE mode;
118  E_STB_DP_TTYPE type;
119  U8BIT plp_id;
121 
122 typedef struct
123 {
124  E_STB_DP_CMODE mode;
125  U16BIT symbol_rate;
127 
128 typedef struct
129 {
130  void *satellite;
131  E_STB_DP_POLARITY polarity;
132  U16BIT symbol_rate;
133  E_STB_DP_FEC fec;
134  BOOLEAN dvb_s2;
135  E_STB_DP_MODULATION modulation;
137 
138 typedef struct
139 {
140  /* The full null-terminated URL string for an IP service.
141  * This string will not be freed but a copy will be made internally when needed,
142  * so this string can be freed by a caller when the function it's passed to returns. */
143  U8BIT *url;
144  U16BIT port;
145  E_STB_DP_FEC_LAYER fec_layer;
146  S_STB_DP_FEC_LAYER_INFO fec_info;
148 
149 typedef struct
150 {
151  U32BIT freq;
152  union
153  {
159  } u;
161 
162 
163 typedef struct
164 {
165  E_STB_DP_RES_OWNER owner;
166  void *data;
167  U32BIT data_size;
169 
170 
171 //---Global type defs for public use-------------------------------------------
172 
180 typedef void (*DSM_FILE_CALLBACK)(void *user_data, U8BIT *file_data, U32BIT data_size);
181 
189 typedef U16BIT (*F_ServiceGetSubtitlePid)(void *serv_ptr, ADB_SUBT_INFO *subt_info);
190 
201 typedef U16BIT (*F_GetExtraPidList)(E_ACTL_PATH_PURPOSE purpose, void *serv_ptr, U8BIT *pmt_data,
202  U16BIT pmt_length, S_DMX_PID_INFO **pid_array);
203 
204 
205 //---Global Function prototypes for public use---------------------------------
206 
214 BOOLEAN ACTL_StartServiceSearch(E_STB_DP_SIGNAL_TYPE tuner_type, E_ACTL_SEARCH_TYPE type);
215 
222 BOOLEAN ACTL_IsTargetRegionRequired(void);
223 
227 void ACTL_StopServiceSearch(void);
228 
235 BOOLEAN ACTL_StartStartupSearch(void);
236 
237 #ifdef INCLUDE_OTA_SSU
238 
251 BOOLEAN ACTL_StartOTAUpdate(U8BIT path, void *transport, U16BIT serv_id,
252  F_SSU_VERSION_CALLBACK version_callback);
253 
259 void ACTL_ContinueOTAUpdate(BOOLEAN do_update);
260 
264 void ACTL_StopOTAUpdate(void);
265 
275 BOOLEAN ACTL_StartSSUSearch(E_STB_DP_SIGNAL_TYPE tuner_type, F_SSU_VERSION_CALLBACK version_callback);
276 
277 #endif /* INCLUDE_OTA_SSU */
278 
286 BOOLEAN ACTL_StartTotSearch(E_STB_DP_SIGNAL_TYPE tuner_type);
287 
291 void ACTL_StopTotSearch(void);
292 
300 BOOLEAN ACTL_StartEitSearch(E_STB_DP_SIGNAL_TYPE tuner_type, E_ACTL_EVENT_SEARCH search_type);
301 
305 void ACTL_StopEitSearch(void);
306 
312 BOOLEAN ACTL_IsSearchComplete(void);
313 
321 U8BIT ACTL_GetSearchProgress(void);
322 
330 U8BIT ACTL_GetServiceSearchPath(void);
331 
332 
341 BOOLEAN ACTL_StartManualSearchById(E_STB_DP_SIGNAL_TYPE tuner_type, U16BIT chan_id,
342  BOOLEAN start_search);
343 
352 BOOLEAN ACTL_StartManualSearch(E_STB_DP_SIGNAL_TYPE tuner_type,
353  S_MANUAL_TUNING_PARAMS *tuning_params, E_ACTL_SEARCH_TYPE type);
354 
359 void ACTL_FinishManualSearch(void);
360 
368 U8BIT ACTL_AcquirePathForService(void *s_ptr, E_ACTL_PATH_PURPOSE purpose, S_ACTL_OWNER_INFO *owner);
369 
375 void ACTL_ReleaseLivePathForService(void *s_ptr, E_STB_DP_RES_OWNER owner);
376 
383 BOOLEAN ACTL_ReleasePath(U8BIT path);
384 
391 BOOLEAN ACTL_AcquirePathOwnership(U8BIT path, S_ACTL_OWNER_INFO *owner_info);
392 
400 BOOLEAN ACTL_ReleasePathOwnership(U8BIT path, E_STB_DP_RES_OWNER owner);
401 
409 BOOLEAN ACTL_CanServiceBeViewed(void *s_ptr);
410 
416 void* ACTL_GetCurrentSatellite(U8BIT path);
417 
430 U8BIT ACTL_TuneToTransport(U8BIT path, S_ACTL_OWNER_INFO *owner_info, void *t_ptr,
431  E_ACTL_SI_SRCH_REQD reqd_si, BOOLEAN relock_on);
432 
446 U8BIT ACTL_TuneToService(U8BIT path, S_ACTL_OWNER_INFO *owner_info, void *s_ptr,
447  BOOLEAN override_lock, E_ACTL_PATH_PURPOSE purpose);
448 
465 BOOLEAN ACTL_TuneUsingDSD(U8BIT path, SI_DELIVERY_SYS_DESC_TYPE dsd_type,
466  SI_DELIVERY_SYS_DESC *dsd, U16BIT service_id, E_ACTL_SI_SRCH_REQD reqd_si);
467 
473 BOOLEAN ACTL_IsTuned(U8BIT path);
474 
479 void ACTL_TuneOff(U8BIT path);
480 
485 void ACTL_DecodeOff(U8BIT path);
486 
491 void ACTL_ReTuneAudio(void);
492 
497 void ACTL_ReTuneSubtitles(void);
498 
504 BOOLEAN ACTL_HasDecodingStarted(U8BIT path);
505 
511 BOOLEAN ACTL_IsDecodingLocked(U8BIT path);
512 
517 void ACTL_ReleaseChannelLock(void);
518 
527 BOOLEAN ACTL_TuneToRfChanArrayEntry(U8BIT path, U16BIT id, E_ACTL_SI_SRCH_REQD reqd_si, BOOLEAN relock_on);
528 
535 BOOLEAN ACTL_TuneToRfChanArrayAnalogEntry(U8BIT path, U16BIT id);
536 
545 BOOLEAN ACTL_TuneToUserDefinedParams(U8BIT path, S_MANUAL_TUNING_PARAMS *tuning_params,
546  E_ACTL_SI_SRCH_REQD reqd_si, BOOLEAN relock_on);
547 
554 void ACTL_SetStandbyGracePeriod(U16BIT num_seconds);
555 
560 void ACTL_EnterStandby(void);
561 
569 void ACTL_LeaveStandby(void *s_ptr, BOOLEAN tune_to_service);
570 
575 void ACTL_SetStandbyState(BOOLEAN state);
576 
580 void ACTL_SetStandbyVCRActive(void);
581 
590 void ACTL_SetVideoWindow(S16BIT win_x, S16BIT win_y, U16BIT win_width, U16BIT win_height);
591 
596 void ACTL_SetTVAspectRatio(E_STB_AV_ASPECT_RATIO aspect_ratio);
597 
602 E_STB_AV_ASPECT_RATIO ACTL_GetTVAspectRatio(void);
603 
610 void ACTL_SetTVAspectMode(E_STB_AV_ASPECT_MODE aspect_mode);
611 
616 E_STB_AV_ASPECT_MODE ACTL_GetTVAspectMode(void);
617 
625 void ACTL_SetTVAspectConversion(E_STB_AV_ASPECT_RATIO aspect_ratio, E_STB_AV_ASPECT_MODE aspect_mode);
626 
634 E_STB_AV_VIDEO_FORMAT ACTL_GetActualVideoMode(U16BIT *width, U16BIT *height);
635 
643 void ACTL_HDMIConnected(void);
644 
649 void ACTL_HDMIDisconnected(void);
650 
655 BOOLEAN ACTL_IsHDMIConnected(void);
656 
666 U16BIT ACTL_GetHDMIResolutions(E_STB_AV_VIDEO_FORMAT **video_formats, U16BIT *current_index);
667 
676 void ACTL_UpdateVideoMode(E_STB_AV_ASPECT_RATIO aspect, BOOLEAN force);
677 
684 void ACTL_ApplyHDCP(void *s_ptr);
685 
690 E_ACTL_AV_MODE ACTL_GetAvModeStatus(void);
691 
692 /* RF channel details utility functions */
693 
699 U16BIT ACTL_GetNumRfChanArrayEntries(E_STB_DP_SIGNAL_TYPE tuner_type);
700 
707 U8BIT* ACTL_GetRfChanName(E_STB_DP_SIGNAL_TYPE tuner_type, U16BIT id);
708 
715 U8BIT* ACTL_GetRfNameFromFreq(E_STB_DP_SIGNAL_TYPE tuner_type, U32BIT freq_hz);
716 
723 U32BIT ACTL_GetRfChanFreqHz(E_STB_DP_SIGNAL_TYPE tuner_type, U16BIT id);
724 
731 U16BIT ACTL_GetRfSymbolRate(E_STB_DP_SIGNAL_TYPE tuner_type, U16BIT id);
732 
739 U8BIT ACTL_GetRfModulation(E_STB_DP_SIGNAL_TYPE tuner_type, U16BIT id);
740 
746 E_STB_DP_TTYPE ACTL_GetTerRfChanType(U16BIT id);
747 
748 #ifdef COMMON_INTERFACE
749 /* CI functions */
750 
759 void ACTL_TuneToCIService(U8BIT path, S_ACTL_OWNER_INFO *owner_info, void *s_ptr, E_APP_SI_MODE si_mode);
760 
768 void ACTL_ContinueCIPLUSTune(U8BIT path, BOOLEAN continue_tuning);
769 #endif
770 
774 void ACTL_EnableCiModule(void);
775 
779 void ACTL_DisableCiModule(void);
780 
785 BOOLEAN ACTL_IsCiUiRequired(void);
786 
792 BOOLEAN ACTL_GetDecodePausedState(U8BIT path);
793 
800 BOOLEAN ACTL_StartSubtitles(void);
801 
805 void ACTL_PauseSubtitles(void);
806 
810 void ACTL_ResumeSubtitles(void);
811 
815 void ACTL_StopSubtitles(void);
816 
822 BOOLEAN ACTL_SuppressSubtitles(BOOLEAN suppress);
823 
827 BOOLEAN ACTL_AreSubtitlesDisplayed(void);
828 
832 BOOLEAN ACTL_AreSubtitlesStarted(void);
833 
838 BOOLEAN ACTL_IsAudioDescriptionOn(void);
839 
847 BOOLEAN ACTL_StartAudioDescription(U8BIT path);
848 
853 void ACTL_StopAudioDescription(U8BIT path);
854 
859 void ACTL_SetADVolume(U8BIT volume);
860 
868 void ACTL_SetParentalControl(BOOLEAN enabled);
869 
875 BOOLEAN ACTL_ParentalControlEnabled(void);
876 
883 void ACTL_SetParentalControlAge(U8BIT age);
884 
890 U8BIT ACTL_GetParentalControlAge(void);
891 
898 void ACTL_ApplyParentalControl(U8BIT path, void *s_ptr);
899 
900 #ifdef FREEVIEW_PLAYBACK
901 
907 BOOLEAN ACTL_IsTrailerBookingAvailable(void *serv_ptr);
908 #endif
909 
913 void ACTL_SetupPlayback(void);
914 
919 void ACTL_StartPlayback(void *s_ptr);
920 
925 U8BIT ACTL_GetActivePath(void);
926 
934 void ACTL_StartDecoding(U8BIT path, void *s_ptr);
935 
940 void ACTL_SetMhegAVControl(BOOLEAN control);
941 
948 
953 void ACTL_SetVolumeAdjustment(S8BIT scaling);
954 
959 U8BIT ACTL_GetVolume(void);
960 
966 U8BIT ACTL_SetVolume(U8BIT volume);
967 
973 U8BIT ACTL_ChangeVolume(S8BIT volume_change);
974 
979 void ACTL_SetMute(BOOLEAN mute);
980 
985 BOOLEAN ACTL_ToggleMute(void);
986 
991 BOOLEAN ACTL_IsMuted(void);
992 
1000 BOOLEAN ACTL_SetActiveProfile(void *profile);
1001 
1002 
1010 E_ACTL_DECODE_CHANGE ACTL_SetupAudioDecoding(U8BIT path, void *s_ptr);
1011 
1017 void ACTL_SetExtraPidListCallback(F_GetExtraPidList pidlist_callback);
1018 
1019 
1020 //---Function prototypes for internal use---------------------------------
1021 
1025 void ACTL_InitialiseAppControl(void);
1026 
1031 void ACTL_ActionEvent(U32BIT event, void *event_data);
1032 
1038 BOOLEAN ACTL_CheckLiveServiceChange(void);
1039 
1045 BOOLEAN ACTL_HandlePrivateTimerEvent(U32BIT timer_handle);
1046 
1047 void ACTL_SetAnalogChanIdString(U8BIT *str_ptr);
1048 
1053 void ACTL_AllowAnalogVideo(BOOLEAN allow_analog_video);
1054 
1055 #ifdef INTEGRATE_HBBTV
1056 
1062 void ACTL_HbbtvNotifyChannelChangeStatus(U8BIT path, void *service, E_HBBTV_CHANNEL_CHANGE_STATUS status);
1063 #endif
1064 
1065 #endif // _AP_CNTRL_H
E_STB_AV_ASPECT_RATIO ACTL_GetTVAspectRatio(void)
Returns the current TV aspect ratio.
Definition: ap_cntrl.c:2475
void ACTL_SetMhegAVControl(BOOLEAN control)
Sets the MHEG5 audio volume adjust to be applied.
Definition: ap_cntrl.c:4921
BOOLEAN ACTL_HasDecodingStarted(U8BIT path)
Returns whether decoding has been started on the given path.
Definition: ap_cntrl.c:2312
BOOLEAN ACTL_CheckLiveServiceChange(void)
Checks whether the service tuned to on the live path has changed and informs the UI if it has...
Definition: ap_cntrl.c:5670
U8BIT ACTL_ChangeVolume(S8BIT volume_change)
Changes the main audio volume and returns the new volume.
Definition: ap_cntrl.c:5008
Definition: ap_cntrl.h:108
BOOLEAN ACTL_HandlePrivateTimerEvent(U32BIT timer_handle)
Handles all the private timer events.
Definition: ap_cntrl.c:1022
API interfacing the midware with Intellibyte loader library.
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.
Definition: ap_cntrl.h:189
void ACTL_ApplyParentalControl(U8BIT path, void *s_ptr)
Checks the parental control for the current event on the given service to determine whether decoding ...
Definition: ap_cntrl.c:3329
Definition: ap_cntrl.h:149
void ACTL_StopEitSearch(void)
Function to stop the EIT search before it completes.
Definition: ap_cntrl.c:4412
void ACTL_ActionEvent(U32BIT event, void *event_data)
Actions external events.
Definition: ap_cntrl.c:522
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 t...
Definition: ap_cntrl.c:2518
void ACTL_SetVolumeAdjustment(S8BIT scaling)
Sets the MHEG5 audio volume adjust to be applied.
Definition: ap_cntrl.c:4949
void ACTL_PauseSubtitles(void)
Disables the display of subtitles but processing continues.
Definition: ap_cntrl.c:3669
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 s...
Definition: ap_cntrl.c:5831
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.
Definition: ap_cntrl.c:5145
void ACTL_StopTotSearch(void)
Function to stop the TOT search before it completes.
Definition: ap_cntrl.c:4270
U32BIT ACTL_GetRfChanFreqHz(E_STB_DP_SIGNAL_TYPE tuner_type, U16BIT id)
Returns a pointer to the channel name.
Definition: ap_cntrl.c:1316
Header file - macros and function prototypes for public use.
void ACTL_TuneOff(U8BIT path)
Stops tuning on the given path.
Definition: ap_cntrl.c:2196
U8BIT * ACTL_GetRfNameFromFreq(E_STB_DP_SIGNAL_TYPE tuner_type, U32BIT freq_hz)
Returns the rf name appropriate to the frequency specified.
Definition: ap_cntrl.c:1367
BOOLEAN ACTL_StartStartupSearch(void)
Function to start the startup search when booting from cold. This search checks the validity of the s...
Definition: ap_cntrl.c:4101
BOOLEAN ACTL_IsAudioDescriptionOn(void)
Returns whether audio description has been turned on.
Definition: ap_cntrl.c:2825
void ACTL_ReleaseChannelLock(void)
Releases the lock on a channel after decoding has been blocked due to the service being parental lock...
Definition: ap_cntrl.c:2245
U8BIT * ACTL_GetRfChanName(E_STB_DP_SIGNAL_TYPE tuner_type, U16BIT id)
Returns a pointer to the channel name.
Definition: ap_cntrl.c:1193
void ACTL_AllowAnalogVideo(BOOLEAN allow_analog_video)
Enables or disables analog video display.
Definition: ap_cntrl.c:2802
BOOLEAN ACTL_AreSubtitlesDisplayed(void)
Returns whether subtitles are being displayed.
Definition: ap_cntrl.c:3803
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...
Definition: ap_cntrl.c:4214
U8BIT ACTL_GetParentalControlAge(void)
Returns the current age set for parental control. 0 will be returned if parental control is disabled ...
Definition: ap_cntrl.c:3306
void ACTL_ResumeSubtitles(void)
Resumes the display of subtitles after they've been paused.
Definition: ap_cntrl.c:3704
void ACTL_InitialiseAppControl(void)
Control system initialisation.
Definition: ap_cntrl.c:456
BOOLEAN ACTL_TuneToRfChanArrayAnalogEntry(U8BIT path, U16BIT id)
Tunes to the specified rf channel array entry in analogue mode.
Definition: ap_cntrl.c:1571
Definition: ap_common.h:63
E_STB_DP_TTYPE ACTL_GetTerRfChanType(U16BIT id)
Returns the terrestrial type (T or T2) for the given channel id.
Definition: ap_cntrl.c:1435
void ACTL_SetStandbyVCRActive(void)
Reports standby state to the a/v output control state machine.
Definition: ap_cntrl.c:2378
BOOLEAN ACTL_IsHDMIConnected(void)
Returns whether the HDMI is connected or not.
Definition: ap_cntrl.c:3136
Header file - Function prototypes for A/V control.
BOOLEAN ACTL_CanServiceBeViewed(void *s_ptr)
Checks whether there's a tuner available to view the given service. This takes into account whether t...
Definition: ap_cntrl.c:5273
Definition: stbdpc.h:308
void ACTL_StopAudioDescription(U8BIT path)
Stops AD decoding.
Definition: ap_cntrl.c:2889
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.
Definition: ap_cntrl.c:3616
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 fo...
Definition: ap_cntrl.c:2928
BOOLEAN ACTL_SuppressSubtitles(BOOLEAN suppress)
Stops subtitles being displayed if another OSD requires them to be hidden, such as CI+...
Definition: ap_cntrl.c:3598
U8BIT ACTL_GetServiceSearchPath(void)
Returns path used buy currently running search. This works for any of the available types of searches...
Definition: ap_cntrl.c:4555
Header file - Function prototypes for A/V control.
void ACTL_ReTuneSubtitles(void)
Stops and restarts subtitle decoding on the live path. This may be required due to a change in langua...
Definition: ap_cntrl.c:2291
void ACTL_SetMute(BOOLEAN mute)
Sets the audio mute state.
Definition: ap_cntrl.c:5055
BOOLEAN ACTL_IsSearchComplete(void)
Returns TRUE if current search has finished. This works for any of the available types of searches...
Definition: ap_cntrl.c:4437
BOOLEAN ACTL_IsTargetRegionRequired(void)
When the search has completed, this function should be called to see whether the target region UI sho...
Definition: ap_cntrl.c:4060
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.
Definition: ap_cntrl.c:5310
void ACTL_SetStandbyState(BOOLEAN state)
Reports the standby state to the A/V output controller.
Definition: ap_cntrl.c:2353
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.
Definition: ap_cntrl.c:5113
Definition: ap_cntrl.h:138
BOOLEAN ACTL_ParentalControlEnabled(void)
Returns whether parental control is enabled. This will also return TRUE if parental control has been ...
Definition: ap_cntrl.c:3257
BOOLEAN ACTL_StartAudioDescription(U8BIT path)
Starts decoding an audio description stream, if available, on the given path. If AD isn't currently a...
Definition: ap_cntrl.c:2839
void ACTL_SetParentalControl(BOOLEAN enabled)
Enables or disables parental control. This enables or disables locking on a per channel basis...
Definition: ap_cntrl.c:3226
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.
Definition: ap_cntrl.c:1618
void ACTL_SetAnalogChanIdString(U8BIT *str_ptr)
sends string to be displayed via pixelworks if it has changed (Must not send message to PixelWorks if...
Definition: ap_cntrl.c:2737
void ACTL_ApplyHDCP(void *s_ptr)
Checks content protection requirements for the current event on the given service to determine whethe...
Definition: ap_cntrl.c:3453
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...
Definition: ap_cntrl.c:4636
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...
Definition: ap_cntrl.c:3153
BOOLEAN ACTL_IsDecodingLocked(U8BIT path)
Returns whether decoding is locked, due to parental locking, on the given path.
Definition: ap_cntrl.c:2333
U8BIT ACTL_GetSearchProgress(void)
Returns search progress as a percentage. This works for any of the available types of searches...
Definition: ap_cntrl.c:4451
Definition: ap_cntrl.h:128
void ACTL_SetMhegSubtitlePidFunc(F_ServiceGetSubtitlePid func)
Sets function retrieve Subtitle PID and info. Allows external MHEG5 module to override the default fu...
Definition: ap_cntrl.c:4933
void ACTL_FinishManualSearch(void)
Function to be called when a manual service search has completed, or is being stopped.
Definition: ap_cntrl.c:4738
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...
Definition: ap_cntrl.c:3874
void ACTL_LeaveStandby(void *s_ptr, BOOLEAN tune_to_service)
Brings the DVB out of standby mode.
Definition: ap_cntrl.c:5478
BOOLEAN ACTL_AreSubtitlesStarted(void)
Returns whether subtitles have been started, even if they aren't being displayed. ...
Definition: ap_cntrl.c:3813
BOOLEAN ACTL_ReleasePath(U8BIT path)
Releases the decode path and all resources no longer needed. The path may not be released if the path...
Definition: ap_cntrl.c:5170
void ACTL_SetStandbyGracePeriod(U16BIT num_seconds)
Sets a grace period during which a system will enter active standby before going into passive or low ...
Definition: ap_cntrl.c:5299
void ACTL_StartPlayback(void *s_ptr)
Start streaming the specified service.
Definition: ap_cntrl.c:2138
BOOLEAN ACTL_IsMuted(void)
Returns the muted state of the audio.
Definition: ap_cntrl.c:5099
BOOLEAN ACTL_GetDecodePausedState(U8BIT path)
Gets user paused flag value.
Definition: ap_cntrl.c:2718
U16BIT ACTL_GetRfSymbolRate(E_STB_DP_SIGNAL_TYPE tuner_type, U16BIT id)
Returns the channel symbol rate.
Definition: ap_cntrl.c:1244
BOOLEAN ACTL_StartEitSearch(E_STB_DP_SIGNAL_TYPE tuner_type, E_ACTL_EVENT_SEARCH search_type)
Entry point for starting an EIT search.
Definition: ap_cntrl.c:4295
BOOLEAN ACTL_IsTuned(U8BIT path)
Returns whether the given path is currently tuned.
Definition: ap_cntrl.c:2090
application level SI task
BOOLEAN ACTL_IsTrailerBookingAvailable(void *serv_ptr)
Returns whether trailer booking is available based on whether it's enabled and the number of links cu...
Definition: ap_cntrl.c:3826
void ACTL_SetupPlayback(void)
Starts the SI to acquire the PMT and fill the ip service in.
Definition: ap_cntrl.c:2111
void ACTL_DisableCiModule(void)
Disables CI module.
Definition: ap_cntrl.c:2693
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 ...
Definition: ap_cntrl.c:1681
Definition: ap_cntrl.h:163
System Wide Global Technical Data Type Definitions.
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 rati...
Definition: ap_cntrl.c:2488
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...
Definition: ap_cntrl.c:2428
BOOLEAN ACTL_ToggleMute(void)
Toggles the current mute state and returns the new mute setting.
Definition: ap_cntrl.c:5076
Application level HBBTV callback functions.
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...
Definition: ap_cntrl.c:5240
void ACTL_HDMIDisconnected(void)
Sets flag to indicate HDMI is now disconnected. This function is called by the event task when the HD...
Definition: ap_cntrl.c:3124
U8BIT ACTL_SetVolume(U8BIT volume)
Sets the main audio volume and returns the new volume.
Definition: ap_cntrl.c:4981
Definition: ap_cntrl.h:122
void ACTL_ReTuneAudio(void)
Stops and restarts audio decoding on the live path. This may be required due to a change in language ...
Definition: ap_cntrl.c:2271
BOOLEAN ACTL_IsCiUiRequired(void)
Returns state of ci_ui_required flag.
Definition: ap_cntrl.c:2706
E_ACTL_AV_MODE ACTL_GetAvModeStatus(void)
Returns av_mode.
Definition: ap_cntrl.c:2542
void ACTL_StopSubtitles(void)
Stops subtitles from being displayed and processed.
Definition: ap_cntrl.c:3753
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.
Definition: ap_cntrl.c:3283
Definition: stbsitab.h:517
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 operat...
Definition: ap_cntrl.c:3026
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...
Definition: ap_cntrl.c:4568
U16BIT ACTL_GetNumRfChanArrayEntries(E_STB_DP_SIGNAL_TYPE tuner_type)
Returns the number of entries in the rf channel table.
Definition: ap_cntrl.c:1155
void ACTL_HDMIConnected(void)
Checks that the selected HDMI resolution mode is supported and, if not, chooses the best one availabl...
Definition: ap_cntrl.c:3077
application level common header
void ACTL_EnableCiModule(void)
Enables CI module.
Definition: ap_cntrl.c:2681
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.
Definition: ap_cntrl.c:1500
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 u...
Definition: ap_cntrl.c:2175
U8BIT ACTL_GetActivePath(void)
Returns the active path (live, playback, etc...), i.e. the one using the decoders.
Definition: ap_cntrl.c:3850
Definition: ap_cntrl.h:114
U8BIT ACTL_GetVolume(void)
Returns the current audio volume.
Definition: ap_cntrl.c:4969
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 sys...
Definition: ap_cntrl.c:1982
void ACTL_DecodeOff(U8BIT path)
Stops decoding on the given path.
Definition: ap_cntrl.c:2223
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...
Definition: ap_cntrl.c:1749
void ACTL_StopServiceSearch(void)
Function to stop the service search before it completes.
Definition: ap_cntrl.c:4085
Header file - Function prototypes for Demux control.
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...
Definition: ap_cntrl.c:5767
BOOLEAN ACTL_AcquirePathOwnership(U8BIT path, S_ACTL_OWNER_INFO *owner_info)
Attempts to take ownership of the given path (used by CI+)
Definition: ap_cntrl.c:5207
void ACTL_SetADVolume(U8BIT volume)
Sets the AD volume.
Definition: ap_cntrl.c:2910
void ACTL_SetTVAspectRatio(E_STB_AV_ASPECT_RATIO aspect_ratio)
Used to set the TV aspect ratio.
Definition: ap_cntrl.c:2454
Definition: stbhwdmx.h:105
void * ACTL_GetCurrentSatellite(U8BIT path)
Returns the current satellite being used by the given decode path.
Definition: ap_cntrl.c:1130
U8BIT ACTL_GetRfModulation(E_STB_DP_SIGNAL_TYPE tuner_type, U16BIT id)
Returns the modulation mode.
Definition: ap_cntrl.c:1280
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 serv...
Definition: ap_cntrl.h:201
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...
Definition: ap_cntrl.h:180
E_STB_AV_ASPECT_MODE ACTL_GetTVAspectMode(void)
Returns the current TV aspect mode.
Definition: ap_cntrl.c:2504
BOOLEAN ACTL_SetActiveProfile(void *profile)
Sets the current profile. (CI+ only) If the profile is being set to CI+ profile and the necessary CAM...
Definition: ap_cntrl.c:5709