ap_cntrl.h

Go to the documentation of this file.

/*******************************************************************************
 * Copyright © 2014 The DTVKit Open Software Foundation Ltd (www.dtvkit.org)
 * Copyright © 2004 Ocean Blue Software Ltd
 *
 * This file is part of a DTVKit Software Component
 * You are permitted to copy, modify or distribute this file subject to the terms
 * of the DTVKit 1.0 Licence which can be found in licence.txt or at www.dtvkit.org
 *
 * THIS CODE AND INFORMATION ARE PROVIDED "AS IS" WITHOUT WARRANTY OF ANY KIND,
 * EITHER EXPRESSED OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE IMPLIED WARRANTIES
 * OF MERCHANTABILITY AND/OR FITNESS FOR A PARTICULAR PURPOSE.
 *
 * If you or your organisation is not a member of DTVKit then you have access
 * to this source code outside of the terms of the licence agreement
 * and you are expected to delete this and any associated files immediately.
 * Further information on DTVKit, membership and terms can be found at www.dtvkit.org
 *******************************************************************************/
// pre-processor mechanism so multiple inclusions don't cause compilation error

#ifndef _AP_CNTRL_H
#define _AP_CNTRL_H

#include "techtype.h"
#include "ap_common.h"
#include "stbhwav.h"
#include "stbhwdmx.h"
#include "vtctype.h"
#include "stbdpc.h"

#ifdef INCLUDE_OTA_SSU
#include "stbota.h"
#endif

#include "ap_si.h"

//---Constant and macro definitions for public use-----------------------------


//---Enumerations for public use-----------------------------------------------

typedef enum
{
   ACTL_SI_NO_SEARCH,
   ACTL_SI_CHANNEL_SEARCH,
   ACTL_SI_CHANNEL_SEARCH_NO_NIT,
   ACTL_SI_STARTUP_SEARCH,
   ACTL_SI_EVENT_PF_SEARCH,
   ACTL_SI_EVENT_SCHED_SEARCH,
   ACTL_SI_EVENT_PF_SCHED_SEARCH,
   ACTL_SI_DVB_SSU_SEARCH,
   ACTL_SI_TOT_SEARCH,
   ACTL_SI_USER_DEFINED
} E_ACTL_SI_SRCH_REQD;

typedef enum
{
   ACTL_FREQ_SEARCH,
   ACTL_NETWORK_SEARCH,
   ACTL_NETWORK_SEARCH_ALL_NITS
} E_ACTL_SEARCH_TYPE;

typedef enum
{
   ACTL_EVENT_SEARCH_PF,
   ACTL_EVENT_SEARCH_SCHED,
   ACTL_EVENT_SEARCH_PF_SCHED
} E_ACTL_EVENT_SEARCH;

typedef enum
{
   ACTL_STANDBY_MODE,
   ACTL_STANDBY_SCART_MODE,
   ACTL_TV_MODE,
   ACTL_SCART_MODE,
   ACTL_INT_DVD_MODE
} E_ACTL_AV_MODE;

typedef enum
{
   ACTL_NO_CHANGE,
   ACTL_AUDIO_CHANGE,
   ACTL_ADESC_CHANGE,
   ACTL_BOTH_CHANGED
} E_ACTL_DECODE_CHANGE;

typedef enum
{
   ACTL_PATH_PURPOSE_RECORDING,
   ACTL_PATH_PURPOSE_LIVE,
   ACTL_PATH_PURPOSE_MONITOR_SI,
   ACTL_PATH_PURPOSE_STREAM_LIVE,
   ACTL_PATH_PURPOSE_STREAM_RECORD,
   ACTL_PATH_PURPOSE_NONE
} E_ACTL_PATH_PURPOSE;


//---Global type defs for public use-------------------------------------------
typedef struct
{
   S8BIT offset;
   E_STB_DP_ANALOG_VIDEO_TYPE vtype;
} S_MANUAL_ANA_TUNING_PARAMS;

typedef struct
{
   E_STB_DP_TBWIDTH bwidth;
   E_STB_DP_TMODE mode;
   E_STB_DP_TTYPE type;
   U8BIT plp_id;
} S_MANUAL_TERR_TUNING_PARAMS;

typedef struct
{
   E_STB_DP_CMODE mode;
   U16BIT symbol_rate;
} S_MANUAL_CABLE_TUNING_PARAMS;

typedef struct
{
   void *satellite;
   E_STB_DP_POLARITY polarity;
   U16BIT symbol_rate;
   E_STB_DP_FEC fec;
   BOOLEAN dvb_s2;
   E_STB_DP_MODULATION modulation;
} S_MANUAL_SAT_TUNING_PARAMS;

typedef struct
{
   /* The full null-terminated URL string for an IP service.
    * This string will not be freed but a copy will be made internally when needed,
    * so this string can be freed by a caller when the function it's passed to returns. */
   U8BIT *url;
   U16BIT port;
   E_STB_DP_FEC_LAYER fec_layer;
   S_STB_DP_FEC_LAYER_INFO fec_info;
} S_MANUAL_IP_TUNING_PARAMS;

typedef struct
{
   U32BIT freq;
   union
   {
      S_MANUAL_ANA_TUNING_PARAMS ana;
      S_MANUAL_TERR_TUNING_PARAMS terr;
      S_MANUAL_CABLE_TUNING_PARAMS cab;
      S_MANUAL_SAT_TUNING_PARAMS sat;
      S_MANUAL_IP_TUNING_PARAMS ip;
   } u;
} S_MANUAL_TUNING_PARAMS;


typedef struct
{
   E_STB_DP_RES_OWNER owner;
   void *data;
   U32BIT data_size;
} S_ACTL_OWNER_INFO;


//---Global type defs for public use-------------------------------------------

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

typedef U16BIT (*F_ServiceGetSubtitlePid)(void *serv_ptr, ADB_SUBT_INFO *subt_info);

typedef U16BIT (*F_GetExtraPidList)(E_ACTL_PATH_PURPOSE purpose, void *serv_ptr, U8BIT *pmt_data,
   U16BIT pmt_length, S_DMX_PID_INFO **pid_array);


//---Global Function prototypes for public use---------------------------------

BOOLEAN ACTL_StartServiceSearch(E_STB_DP_SIGNAL_TYPE tuner_type, E_ACTL_SEARCH_TYPE type);

BOOLEAN ACTL_IsTargetRegionRequired(void);

void ACTL_StopServiceSearch(void);

BOOLEAN ACTL_StartStartupSearch(void);

#ifdef INCLUDE_OTA_SSU

BOOLEAN ACTL_StartOTAUpdate(U8BIT path, void *transport, U16BIT serv_id,
   F_SSU_VERSION_CALLBACK version_callback);

void ACTL_ContinueOTAUpdate(BOOLEAN do_update);

void ACTL_StopOTAUpdate(void);

BOOLEAN ACTL_StartSSUSearch(E_STB_DP_SIGNAL_TYPE tuner_type, F_SSU_VERSION_CALLBACK version_callback);

#endif /* INCLUDE_OTA_SSU */

BOOLEAN ACTL_StartTotSearch(E_STB_DP_SIGNAL_TYPE tuner_type);

void ACTL_StopTotSearch(void);

BOOLEAN ACTL_StartEitSearch(E_STB_DP_SIGNAL_TYPE tuner_type, E_ACTL_EVENT_SEARCH search_type);

void ACTL_StopEitSearch(void);

BOOLEAN ACTL_IsSearchComplete(void);

U8BIT ACTL_GetSearchProgress(void);

U8BIT ACTL_GetServiceSearchPath(void);


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

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

void ACTL_FinishManualSearch(void);

U8BIT ACTL_AcquirePathForService(void *s_ptr, E_ACTL_PATH_PURPOSE purpose, S_ACTL_OWNER_INFO *owner);

void ACTL_ReleaseLivePathForService(void *s_ptr, E_STB_DP_RES_OWNER owner);

BOOLEAN ACTL_ReleasePath(U8BIT path);

BOOLEAN ACTL_AcquirePathOwnership(U8BIT path, S_ACTL_OWNER_INFO *owner_info);

BOOLEAN ACTL_ReleasePathOwnership(U8BIT path, E_STB_DP_RES_OWNER owner);

BOOLEAN ACTL_CanServiceBeViewed(void *s_ptr);

void* ACTL_GetCurrentSatellite(U8BIT path);

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

U8BIT ACTL_TuneToService(U8BIT path, S_ACTL_OWNER_INFO *owner_info, void *s_ptr,
   BOOLEAN override_lock, E_ACTL_PATH_PURPOSE purpose);

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);

BOOLEAN ACTL_IsTuned(U8BIT path);

void ACTL_TuneOff(U8BIT path);

void ACTL_DecodeOff(U8BIT path);

void ACTL_ReTuneAudio(void);

void ACTL_ReTuneSubtitles(void);

BOOLEAN ACTL_HasDecodingStarted(U8BIT path);

BOOLEAN ACTL_IsDecodingLocked(U8BIT path);

void ACTL_ReleaseChannelLock(void);

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

BOOLEAN ACTL_TuneToRfChanArrayAnalogEntry(U8BIT path, U16BIT id);

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

void ACTL_SetStandbyGracePeriod(U16BIT num_seconds);

void ACTL_EnterStandby(void);

void ACTL_LeaveStandby(void *s_ptr, BOOLEAN tune_to_service);

void ACTL_SetStandbyState(BOOLEAN state);

void ACTL_SetStandbyVCRActive(void);

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

void ACTL_SetTVAspectRatio(E_STB_AV_ASPECT_RATIO aspect_ratio);

E_STB_AV_ASPECT_RATIO ACTL_GetTVAspectRatio(void);

void ACTL_SetTVAspectMode(E_STB_AV_ASPECT_MODE aspect_mode);

E_STB_AV_ASPECT_MODE ACTL_GetTVAspectMode(void);

void ACTL_SetTVAspectConversion(E_STB_AV_ASPECT_RATIO aspect_ratio, E_STB_AV_ASPECT_MODE aspect_mode);

E_STB_AV_VIDEO_FORMAT ACTL_GetActualVideoMode(U16BIT *width, U16BIT *height);

void ACTL_HDMIConnected(void);

void ACTL_HDMIDisconnected(void);

BOOLEAN ACTL_IsHDMIConnected(void);

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

void ACTL_UpdateVideoMode(E_STB_AV_ASPECT_RATIO aspect, BOOLEAN force);

void ACTL_ApplyHDCP(void *s_ptr);

E_ACTL_AV_MODE ACTL_GetAvModeStatus(void);

/* RF channel details utility functions */

U16BIT ACTL_GetNumRfChanArrayEntries(E_STB_DP_SIGNAL_TYPE tuner_type);

U8BIT* ACTL_GetRfChanName(E_STB_DP_SIGNAL_TYPE tuner_type, U16BIT id);

U8BIT* ACTL_GetRfNameFromFreq(E_STB_DP_SIGNAL_TYPE tuner_type, U32BIT freq_hz);

U32BIT ACTL_GetRfChanFreqHz(E_STB_DP_SIGNAL_TYPE tuner_type, U16BIT id);

U16BIT ACTL_GetRfSymbolRate(E_STB_DP_SIGNAL_TYPE tuner_type, U16BIT id);

U8BIT ACTL_GetRfModulation(E_STB_DP_SIGNAL_TYPE tuner_type, U16BIT id);

E_STB_DP_TTYPE ACTL_GetTerRfChanType(U16BIT id);

#ifdef COMMON_INTERFACE
/* CI functions */

void ACTL_TuneToCIService(U8BIT path, S_ACTL_OWNER_INFO *owner_info, void *s_ptr, E_APP_SI_MODE si_mode);

void ACTL_ContinueCIPLUSTune(U8BIT path, BOOLEAN continue_tuning);
#endif

void ACTL_EnableCiModule(void);

void ACTL_DisableCiModule(void);

BOOLEAN ACTL_IsCiUiRequired(void);

BOOLEAN ACTL_GetDecodePausedState(U8BIT path);

BOOLEAN ACTL_StartSubtitles(void);

void ACTL_PauseSubtitles(void);

void ACTL_ResumeSubtitles(void);

void ACTL_StopSubtitles(void);

BOOLEAN ACTL_SuppressSubtitles(BOOLEAN suppress);

BOOLEAN ACTL_AreSubtitlesDisplayed(void);

BOOLEAN ACTL_AreSubtitlesStarted(void);

BOOLEAN ACTL_IsAudioDescriptionOn(void);

BOOLEAN ACTL_StartAudioDescription(U8BIT path);

void ACTL_StopAudioDescription(U8BIT path);

void ACTL_SetADVolume(U8BIT volume);

void ACTL_SetParentalControl(BOOLEAN enabled);

BOOLEAN ACTL_ParentalControlEnabled(void);

void ACTL_SetParentalControlAge(U8BIT age);

U8BIT ACTL_GetParentalControlAge(void);

void ACTL_ApplyParentalControl(U8BIT path, void *s_ptr);

#ifdef FREEVIEW_PLAYBACK

BOOLEAN ACTL_IsTrailerBookingAvailable(void *serv_ptr);
#endif

void ACTL_SetupPlayback(void);

void ACTL_StartPlayback(void *s_ptr);

U8BIT ACTL_GetActivePath(void);

void ACTL_StartDecoding(U8BIT path, void *s_ptr);

void ACTL_SetMhegAVControl(BOOLEAN control);

void ACTL_SetMhegSubtitlePidFunc(F_ServiceGetSubtitlePid func);

void ACTL_SetVolumeAdjustment(S8BIT scaling);

U8BIT ACTL_GetVolume(void);

U8BIT ACTL_SetVolume(U8BIT volume);

U8BIT ACTL_ChangeVolume(S8BIT volume_change);

void ACTL_SetMute(BOOLEAN mute);

BOOLEAN ACTL_ToggleMute(void);

BOOLEAN ACTL_IsMuted(void);

BOOLEAN ACTL_SetActiveProfile(void *profile);


E_ACTL_DECODE_CHANGE ACTL_SetupAudioDecoding(U8BIT path, void *s_ptr);

void ACTL_SetExtraPidListCallback(F_GetExtraPidList pidlist_callback);


//---Function prototypes for internal use---------------------------------

void ACTL_InitialiseAppControl(void);

void ACTL_ActionEvent(U32BIT event, void *event_data);

BOOLEAN ACTL_CheckLiveServiceChange(void);

BOOLEAN ACTL_HandlePrivateTimerEvent(U32BIT timer_handle);

void ACTL_SetAnalogChanIdString(U8BIT *str_ptr);

void ACTL_AllowAnalogVideo(BOOLEAN allow_analog_video);

#endif //  _AP_CNTRL_H