ap_dbdef.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
 *******************************************************************************/
#ifndef _AP_DBDEF_H
#define _AP_DBDEF_H

#include "techtype.h"
#include "stbsiflt.h"
#include "stbsitab.h"
#include "stbllist.h"
#include "ap_cfg.h"
#include "ap_tmr.h"
#include "ap_dbacc.h"

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

#define ADB_LANG_CODE_UNDEF            0x756e64
#define ADB_LANG_CODE_QAA              0x716161
#define ADB_LANG_CODE_NAR              0x6e6172

/* DVB SI descriptor tags */
#define LINKAGE_DTAG                   0x4a
#define SHORT_EVENT_DTAG               0x4d
#define EXTENDED_EVENT_DTAG            0x4e
#define COMPONENT_DTAG                 0x50
#define CONTENT_DTAG                   0x54
#define PARENTAL_RATING_DTAG           0x55
#define PRIVATE_DATA_SPEC_DTAG         0x5f
#define CONT_ID_DESC_DTAG              0x76
#define FTA_CONTENT_DESC_DTAG          0x7e
#define EXTENSION_DTAG                 0x7f
#define USER_DEFINED_DTAG_0x85         0x85
#define USER_DEFINED_DTAG_0x89         0x89

#define LINK_TYPE_EVENT                0x0d
#define LINK_TYPE_EXT_EVENT            0x0e

#define INVALID_FREESAT_SERV_ID        0x8000

/* Content identifier descriptor CRID types */
#define TVA_PROGRAMME_CRID             0x01
#define TVA_SERIES_CRID                0x02
#define TVA_RECOMMENDATION_CRID        0x03

#define UK_PROGRAMME_CRID              0x31
#define UK_SERIES_CRID                 0x32
#define UK_RECOMMENDATION_CRID         0x33

//---Enumerations for public use-----------------------------------------------
typedef enum
{
   STREAM_MATCH_EXACT,
   STREAM_MATCH_ASPECT,
   STREAM_MATCH_LANG,
   STREAM_MATCH_TYPE,
   STREAM_MATCH_NOT_ZERO,
   STREAM_MATCH_NONE
} E_STREAM_MATCH_TYPE;

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

// Database structures - strings
typedef struct adb_string
{
   U32BIT lang_code;
   U16BIT nbytes;
   U8BIT *str_ptr;
} ADB_STRING;


//--------------------------------------------------
// Database structures - satellite records
typedef struct adb_lnb_rec
{
   LINK_LIST_PTR_BLK ptrs;
   void *dba_rec;

   E_STB_DP_LNB_TYPE type;
   E_STB_DP_LNB_POWER power;
   BOOLEAN is_22k;
   BOOLEAN is_12v;
   BOOLEAN is_pulse_posn;
   BOOLEAN is_diseqc_posn;
   E_STB_DP_DISEQC_TONE diseqc_tone;
   E_STB_DP_DISEQC_CSWITCH c_switch;
   U8BIT u_switch;            // 0 to 16 inclusive
   BOOLEAN is_smatv;
   U8BIT diseqc_repeats;      // 0 to 3 inclusive
   U32BIT unicable_if;
   U8BIT unicable_chan;
   ADB_STRING *name;
} ADB_LNB_REC;

typedef struct adb_bat_version_rec
{
   struct adb_bat_version_rec *next;
   U16BIT bouquet_id;
   U8BIT version;
} ADB_BAT_VERSION_REC;

typedef struct adb_satellite_rec
{
   LINK_LIST_PTR_BLK ptrs;
   void *dba_rec;

   ADB_LNB_REC *lnb;
   ADB_STRING *name;
   U16BIT dish_pos;
   U16BIT long_pos;           // 0 to 1800 inclusive
   BOOLEAN east_west;         // 0=West,1=East

   BOOLEAN has_fta_desc;
   BOOLEAN do_not_scramble;
   ADB_STRING *def_authority;

   ADB_BAT_VERSION_REC *bat_version_list;
} ADB_SATELLITE_REC;

typedef struct adb_lnb_band_rec
{
   LINK_LIST_PTR_BLK ptrs;
   void *dba_rec;

   ADB_LNB_REC *lnb;
   S_STB_DP_LNB_BAND band_params;
} ADB_LNB_BAND_REC;


//--------------------------------------------------
// Database structures - network records
typedef struct adb_network_rec
{
   LINK_LIST_PTR_BLK ptrs;
   void *dba_rec;

   U16BIT net_id;
   U8BIT nit_version;
   BOOLEAN nit_version_changed;

   ADB_STRING *name_str;
   ADB_STRING *name_array[ACFG_NUM_DB_LANGUAGES];
   BOOLEAN has_fta_desc;
   BOOLEAN do_not_scramble;
   SI_NIT_TARGET_REGION_NAME_DESC *target_region_name_list;
   SI_TARGET_REGION_DESC *target_region_list;
   SI_LINKAGE_DESC_ENTRY *last_linkage_entry;
   SI_LINKAGE_DESC_ENTRY *linkage_desc_list;
   U16BIT num_linkage_entries;
   ADB_STRING *def_authority;
   ADB_SATELLITE_REC *satellite;
   ADB_PROFILE_TYPE profile_type;

#ifdef COMMON_INTERFACE
   BOOLEAN module_present;
   U32BIT module;
   U16BIT cicam_onet_id;
   U32BIT cicam_identifier;
   BOOLEAN op_search_required;
   U16BIT op_search_date;
   U16BIT op_search_time;
   ADB_STRING *profile_name;
   U8BIT fav_list_id;
#endif
} ADB_NETWORK_REC;


//--------------------------------------------------
// Database structures - transport records
typedef struct adb_pmt_version_rec
{
   struct adb_pmt_version_rec *next;
   U16BIT serv_id;
   U8BIT version;
} ADB_PMT_VERSION_REC;

typedef struct adb_transport_rec
{
   LINK_LIST_PTR_BLK ptrs;
   void *dba_rec;

   U16BIT tran_id;
   U16BIT orig_net_id;
   U32BIT frequency;
   ADB_NETWORK_REC *network;
   E_STB_DP_SIGNAL_TYPE sig_type;
   U16BIT signal_level_at_search;

   U8BIT num_additional_frequencies;
   U32BIT *additional_frequencies;

   /* The following union is accessed based on sig_type */
   union
   {
      struct _analog_trans_rec
      {
         S8BIT freq_offset;
         E_STB_DP_ANALOG_VIDEO_TYPE vtype;
      } anal;
      struct _terr_trans_rec
      {
         E_STB_DP_TBWIDTH bwidth;
         E_STB_DP_TMODE tmode;
         E_STB_DP_TTYPE terr_type;
         U8BIT plp_id;
         S8BIT freq_offset;
         E_STB_TUNE_TCONST constellation;
         E_STB_TUNE_THIERARCHY hierarchy;
         E_STB_TUNE_TCODERATE lp_code_rate;
         E_STB_TUNE_TCODERATE hp_code_rate;
         E_STB_TUNE_TGUARDINT guard_int;
         SI_TARGET_REGION_DESC *target_region_list;
      } terr;
      struct _cable_trans_rec
      {
         E_STB_DP_CMODE cmode;
         U16BIT symbol_rate;
      } cab;
      struct _sat_trans_rec
      {
         U16BIT symbol_rate;
         E_STB_DP_POLARITY polarity;
         E_STB_DP_FEC fec_code;
         E_STB_DP_FEC_TYPE fec_type;
         BOOLEAN dvb_s2;
         E_STB_DP_MODULATION modulation;
      } sat;
   } u;

   U8BIT pat_version;
   BOOLEAN sdt_received;
   BOOLEAN sdt_version_changed;
   U8BIT sdt_version;
   ADB_PMT_VERSION_REC *pmt_version_list;
   BOOLEAN has_fta_desc;
   BOOLEAN do_not_scramble;
   ADB_STRING *def_authority;
   BOOLEAN searched;
   BOOLEAN available;
} ADB_TRANSPORT_REC;

//--------------------------------------------------------
// Database structures - service, event and stream records

typedef struct adb_audio_stream_data
{
   U32BIT lang_code;
   ADB_AUDIO_TYPE type;
   E_STB_DP_AUDIO_MODE mode;
} ADB_AUDIO_STREAM_DATA;

typedef struct adb_subtitle_stream_data
{
   U32BIT lang_code;
   ADB_SUBTITLE_TYPE type;
   U16BIT composition_page;
   U16BIT ancillary_page;
} ADB_SUBTITLE_STREAM_DATA;

typedef struct adb_ttext_stream_data
{
   U32BIT lang_code;
   U8BIT type;
   U8BIT magazine;
   U8BIT page;
} ADB_TTEXT_STREAM_DATA;

typedef union adb_stream_data
{
   ADB_AUDIO_STREAM_DATA audio;
   ADB_SUBTITLE_STREAM_DATA subtitle;
   ADB_TTEXT_STREAM_DATA ttext;
} ADB_STREAM_DATA;

typedef struct adb_stream_rec
{
   struct adb_stream_rec *next;
   ADB_STREAM_TYPE type;
   U8BIT *tag_array;
   U8BIT num_tags;
   U16BIT pid;
   BOOLEAN in_use;
   ADB_STREAM_DATA data;
   BOOLEAN has_ca_descriptor;
} ADB_STREAM_REC;

typedef struct adb_event_desc
{
   U8BIT *desc_data;
   struct adb_event_desc *next;
} ADB_EVENT_DESC;

typedef struct adb_event_rec
{
   struct adb_event_rec *next;
   void *dba_rec;

   U16BIT event_id;
   U32DHMS start;
   U32DHMS duration;
   U8BIT running_status;
   BOOLEAN free_to_air;
   U8BIT version;

   /* Keep values parsed from the content management descriptor that are used by DVBCore */
   BOOLEAN has_content_management_desc;
   BOOLEAN do_not_scramble;

   ADB_EVENT_DESC *desc_list_head;
   ADB_EVENT_DESC *desc_list_tail;
} ADB_EVENT_REC;

typedef struct adb_alt_serv_rec
{
   struct adb_alt_serv_rec *next;
   U16BIT onet_id;
   U16BIT tran_id;
   U16BIT serv_id;
   U8BIT link_type;
} ADB_ALT_SERV_REC;

typedef enum
{
   ICON_TYPE_PNG,
   ICON_TYPE_JPEG
} E_ICON_TYPE;

typedef struct adb_icon_image
{
   struct adb_icon_image *next;
   U8BIT icon_id;
   BOOLEAN position_defined;
   E_ICON_COORD_SYSTEM coord_system;
   U16BIT x_pos;
   U16BIT y_pos;
   U16BIT width;
   U16BIT height;
   E_ICON_TYPE icon_type;
   E_ICON_TRANSPORT_MODE transport_mode;
   U8BIT *icon_url;
   U32BIT data_len;
   U8BIT *icon_data;
   void (*destroy_func)(void *);
   void *dsm_handle;
} ADB_IMAGE_ICON;

typedef struct adb_rct_link_info
{
   struct adb_rct_link_info *next;
   BOOLEAN is_group_trailer;
   U8BIT *uri_string;
   BOOLEAN can_use_default_icon;
   U8BIT icon_id;
   ADB_STRING *promo_text[ACFG_NUM_DB_LANGUAGES];
   ADB_STRING *event_name;
} ADB_RCT_LINK_INFO;

typedef struct
{
   U8BIT type;
   U8BIT mode;
   ADB_STRING *text;
} ADB_GUIDANCE_DESC;

typedef struct adb_service_rec
{
   LINK_LIST_PTR_BLK ptrs;
   void *dba_rec;

   ADB_TRANSPORT_REC *transport;
   ADB_SERVICE_TYPE serv_type;
   U16BIT serv_id;
   U16BIT serv_lcn;
   U16BIT allocated_lcn;
   U16BIT old_allocated_lcn;
   ADB_STRING *name_str;
   ADB_STRING *provider_str;
   ADB_STRING *short_name_str;
   ADB_STRING *short_name_array[ACFG_NUM_DB_LANGUAGES];
   ADB_STRING *name_array[ACFG_NUM_DB_LANGUAGES][ADB_NUM_SERV_NAME_IDS];
   ADB_STRING *provider_array[ACFG_NUM_DB_LANGUAGES];
   ADB_GUIDANCE_DESC guidance[ACFG_NUM_DB_LANGUAGES];
   ADB_STREAM_REC *stream_list;
   ADB_ALT_SERV_REC *alt_serv_list;
   U8BIT fav_groups;
   BOOLEAN deleted;

   BOOLEAN sched_disabled;
   BOOLEAN now_next_disabled;

   BOOLEAN eit_now_next_avail;
   ADB_EVENT_REC *now_event;
   ADB_EVENT_REC *next_event;

   BOOLEAN eit_sched_avail;
   U16BIT num_events_in_schedule;
   ADB_EVENT_REC *event_schedule;

   BOOLEAN pmt_received;

   U16BIT pcr_pid;
   U16BIT video_pid;
   U16BIT audio_pid;
   U16BIT ad_pid;
   U16BIT ttext_pid;
   U8BIT ttext_mag;
   U8BIT ttext_page;
   U16BIT subtitle_pid;
   U16BIT subtitle_cpage;
   U16BIT subtitle_apage;
   ADB_STREAM_TYPE video_type;
   ADB_STREAM_TYPE audio_type;

   BOOLEAN reqd_audio_valid;
   U32BIT reqd_audio_lang_code;
   ADB_AUDIO_TYPE reqd_audio_type;
   ADB_STREAM_TYPE reqd_stream_type;
   U16BIT reqd_audio_pid;
   BOOLEAN reqd_subtitle_valid;
   U32BIT reqd_subtitle_lang_code;
   ADB_SUBTITLE_TYPE reqd_subtitle_type;
   BOOLEAN reqd_ttext_valid;
   U32BIT reqd_ttext_lang_code;
   ADB_TELETEXT_TYPE reqd_ttext_type;

   BOOLEAN found;             /* Used during service search */
   U8BIT running_status;
   BOOLEAN not_running;
   BOOLEAN unavailable;
   BOOLEAN new_service;
   BOOLEAN locked;
   BOOLEAN hidden;
   BOOLEAN selectable;
   BOOLEAN lcn_editable;
   BOOLEAN scrambled;

   BOOLEAN has_fta_desc;
   BOOLEAN do_not_scramble;
   U8BIT content_protection_level;

   SI_TARGET_REGION_DESC *target_region_list;

   ADB_STRING *def_authority;

   U16BIT rct_pid;
   ADB_RCT_LINK_INFO *rct_link_list;
   ADB_IMAGE_ICON *icon_list;

#ifdef COMMON_INTERFACE
   BOOLEAN sdt_received;
   U8BIT *ci_protection_desc;
   U32BIT ci_prot_last_update;
#endif
   U8BIT *pmt_data;
   U16BIT pmt_data_len;
   U16BIT pmt_pid;
   SI_LINKAGE_DESC_ENTRY *last_linkage_entry;
   SI_LINKAGE_DESC_ENTRY *linkage_desc_list;
   U16BIT num_linkage_entries;
   SI_LCN_DESC *hd_lcn_desc;

   BOOLEAN has_ca_descriptor;

   /* Freesat specific values */
   U16BIT freesat_id;
   U16BIT region_id;

   U16BIT bat_pid;
   U16BIT eit_pf_pid;
   U16BIT eit_pf_plus_pid;
   U16BIT eit_sched_pid;
   U16BIT nit_pid;
   U16BIT sdt_pid;
   U16BIT tdt_pid;
   U16BIT tot_pid;
#ifdef INTEGRATE_HBBTV
   U16BIT ait_pid;
#endif
} ADB_SERVICE_REC;


//--------------------------------------------------------
// Database structures - crid records

typedef struct adb_crid_record
{
   LINK_LIST_PTR_BLK ptrs;
   void *dba_rec;

   U16BIT eit_date;           /* The date the CRID was last seen in the EITs */
   BOOLEAN series_flag;       /* The CRID represents a series */
   BOOLEAN recommended_flag;  /* The CRID represents a recommended programme or series */
   BOOLEAN do_not_delete;     /* TRUE if any recordings created from this CRID are to be locked */
   U32DHMS date_time;         /* Date to be used when searching for a split event */
   U16BIT serv_id;            /* Service to be used when searching for a split event */
   ADB_STRING *name_str;      /* Programme name for series/recommendations */
   ADB_STRING *crid_str;      /* CRID string */
} ADB_CRID_REC;


//--------------------------------------------------------
// Database structures - favourite lists

typedef struct adb_favserv_rec
{
   LINK_LIST_PTR_BLK ptrs;       /* prev/next service in favourite list */
   void *dba_rec;

   ADB_SERVICE_REC *serv_ptr;
   U8BIT list_id;                /* Id of the fav list this service is in */
   U16BIT index;                 /* Defines the position of this service in the list */
} ADB_FAVSERV_REC;

typedef struct adb_favlist_rec
{
   LINK_LIST_PTR_BLK ptrs;       /* List of favourite lists */
   void *dba_rec;

   U8BIT list_id;                /* Unique id for a list */
   U8BIT index;                  /* Defines the position of this list in the favourite lists */
   U32BIT user_data;             /* User defined value stored with the list */
   ADB_STRING *name;
   LINK_LIST_HEADER serv_list;   /* List of service in this favourite list */
} ADB_FAVLIST_REC;

//--------------------------------------------------------
// Database structures - timers

typedef struct
{
   BOOLEAN change_service;
   U16BIT service_id;
   U16BIT transport_id;
   U16BIT orig_net_id;
   BOOLEAN ramp_volume;
} ADB_ALARM_REC;

typedef struct
{
   U32DHMS duration;
   BOOLEAN event_triggered;
   U16BIT event_id;
   U16BIT service_id;
   U16BIT transport_id;
   U16BIT orig_net_id;
   U8BIT prog_crid[TMR_PVR_CRID_LEN_MAX];
   U8BIT other_crid[TMR_PVR_CRID_LEN_MAX];
   U16BIT disk_id;
   BOOLEAN recommendation;
   U16BIT notify_time;
   BOOLEAN notified;
   U8BIT path;
   U32BIT recording_handle;
   U8BIT additional_info[TMR_PVR_ADDINFO_LEN_MAX];
   BOOLEAN has_start_padding;
   S32BIT start_padding;
   BOOLEAN has_end_padding;
   S32BIT end_padding;
   BOOLEAN do_not_delete;
   BOOLEAN programme_started;
   BOOLEAN programme_finished;
} ADB_PVR_RECORD_REC;

typedef struct
{
   LINK_LIST_PTR_BLK ptrs;
   void *dba_rec;

   U32BIT handle;
   E_TIMER_TYPE type;
   U32DHMS start_time;
   U8BIT name[TMR_MAX_NAME_LENGTH];
   E_TIMER_FREQ frequency;

   BOOLEAN expired;
   BOOLEAN starting;
   BOOLEAN started;
   BOOLEAN selected;
   BOOLEAN missed;
   union
   {
      ADB_ALARM_REC alarm;
      ADB_PVR_RECORD_REC record;
   } u;
} ADB_TIMER_REC;

#ifdef COMMON_INTERFACE
typedef struct
{
   LINK_LIST_PTR_BLK ptrs;
   void *dba_rec;

   U32BIT cicam_identifier;
   U32BIT timer_handle;
} ADB_CICAM_TIMER_REC;
#endif

/* Internal structure used to pass events to an application.
 * The application handles these as void* handles */
typedef struct s_event
{
   void *serv_ptr;
   U16BIT event_id;
} S_EVENT;


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

void DBDEF_Initialise(void);

void DBDEF_RequestAccess(void);

void DBDEF_ReleaseAccess(void);

BOOLEAN DBDEF_LoadDatabase(U8BIT *db_pathname);
void DBDEF_DeleteAllRecords(void);
BOOLEAN DBDEF_SaveDatabase(void);

void DBDEF_DeleteRecordsForTunerType(E_STB_DP_SIGNAL_TYPE tuner_type, void *satellite);

void DBDEF_DeleteServiceRec(ADB_SERVICE_REC *s_ptr);
U16BIT DBDEF_NumStreamsInList(ADB_STREAM_REC *slist);
ADB_STREAM_REC* DBDEF_CopyStreamList(ADB_STREAM_REC *slist);
void DBDEF_DeleteStreamList(ADB_STREAM_REC *slist);
void DBDEF_DeleteAltServList(ADB_ALT_SERV_REC *aslist);

void DBDEF_DeleteRCTLinks(ADB_RCT_LINK_INFO *links);
void DBDEF_DeleteImageIcons(ADB_IMAGE_ICON *icon_list);

void DBDEF_SortServicesByLcn(void);

BOOLEAN DBDEF_AllocateLcns(E_STB_DP_SIGNAL_TYPE tuner_type, BOOLEAN assign_lcns);
BOOLEAN DBDEF_AllocateLcnsDefault(E_STB_DP_SIGNAL_TYPE tuner_type);
#ifdef COUNTRY_UK
BOOLEAN DBDEF_AllocateLcnsUK(E_STB_DP_SIGNAL_TYPE tuner_type);
#endif
#ifdef COUNTRY_FINLAND
BOOLEAN DBDEF_AllocateLcnsFinland(E_STB_DP_SIGNAL_TYPE tuner_type);
#endif
#ifdef COUNTRY_IRELAND
BOOLEAN DBDEF_AllocateLcnsIreland(E_STB_DP_SIGNAL_TYPE tuner_type);
#endif

U16BIT DBDEF_GetNumLNBs(void);

ADB_LNB_REC* DBDEF_AddLNB(E_STB_DP_LNB_TYPE type, ADB_STRING *name);

BOOLEAN DBDEF_SetLNBPower(ADB_LNB_REC *lnb, E_STB_DP_LNB_POWER power);

BOOLEAN DBDEF_SetLNB22k(ADB_LNB_REC *lnb, BOOLEAN is_22k);

BOOLEAN DBDEF_SetLNB12V(ADB_LNB_REC *lnb, BOOLEAN is_12v);

BOOLEAN DBDEF_SetLNBPulsePosition(ADB_LNB_REC *lnb, BOOLEAN is_pulse_posn);

BOOLEAN DBDEF_SetLNBDiSEqCPosition(ADB_LNB_REC *lnb, BOOLEAN is_diseqc_posn);

BOOLEAN DBDEF_SetLNBDiSEqCTone(ADB_LNB_REC *lnb, E_STB_DP_DISEQC_TONE diseqc_tone);

BOOLEAN DBDEF_SetLNBCSwitch(ADB_LNB_REC *lnb, E_STB_DP_DISEQC_CSWITCH cswitch);

BOOLEAN DBDEF_SetLNBUSwitch(ADB_LNB_REC *lnb, U8BIT uswitch);

BOOLEAN DBDEF_SetLNBSmatv(ADB_LNB_REC *lnb, BOOLEAN is_smatv);

BOOLEAN DBDEF_SetLNBRepeats(ADB_LNB_REC *lnb, U8BIT repeats);

BOOLEAN DBDEF_SetLNBUnicable(ADB_LNB_REC *lnb, U32BIT inter_freq, U8BIT chan);

ADB_LNB_REC* DBDEF_GetNextLNBRec(ADB_LNB_REC *lnb_ptr);

U16BIT DBDEF_GetNumSatellites(void);

ADB_SATELLITE_REC* DBDEF_AddSatelliteRec(ADB_STRING *name_str, U16BIT dish_pos, U16BIT long_pos,
   BOOLEAN east_west, ADB_LNB_REC *associated_lnb);

ADB_SATELLITE_REC* DBDEF_GetNextSatelliteRec(ADB_SATELLITE_REC *sat_ptr);

U16BIT DBDEF_GetNumLNBBands(void);

ADB_LNB_BAND_REC* DBDEF_AddLNBBandRec(S_STB_DP_LNB_BAND *band_parameters, ADB_LNB_REC *associated_lnb);

ADB_LNB_BAND_REC* DBDEF_GetNextLNBBandRec(ADB_LNB_BAND_REC *band_ptr);

void DBDEF_DeleteLNBBandRec(ADB_LNB_BAND_REC *band_ptr);

U16BIT DBDEF_GetNumNetworks(void);

ADB_NETWORK_REC* DBDEF_AddNetworkRec(U16BIT net_id, ADB_SATELLITE_REC *satellite);

void DBDEF_DeleteNetworkRec(ADB_NETWORK_REC *n_ptr);

void DBDEF_SetNetworkName(ADB_NETWORK_REC *n_ptr, U8BIT *name);

ADB_NETWORK_REC* DBDEF_FindNetworkRec(U16BIT net_id, ADB_SATELLITE_REC *satellite);

ADB_NETWORK_REC* DBDEF_GetNextNetworkRec(ADB_NETWORK_REC *n_ptr);

U16BIT DBDEF_GetNumTransports(void);

ADB_TRANSPORT_REC* DBDEF_GetNextTransportRec(ADB_TRANSPORT_REC *t_ptr);

ADB_TRANSPORT_REC* DBDEF_AddTerrestrialTransportRec(U32BIT freq_hz, U8BIT plp_id,
   ADB_NETWORK_REC *network);
ADB_TRANSPORT_REC* DBDEF_FindTerrestrialTransportRec(U32BIT freq_hz, U8BIT plp_id);

ADB_TRANSPORT_REC* DBDEF_AddCableTransportRec(U32BIT freq_hz, U32BIT symbol_rate,
   ADB_NETWORK_REC *network);
ADB_TRANSPORT_REC* DBDEF_FindCableTransportRec(U32BIT freq_hz, U32BIT symbol_rate);

void DBDEF_SetCableTransportSymbolRate(ADB_TRANSPORT_REC *t_ptr, U16BIT symbol_rate);
void DBDEF_SetCableTransportMode(ADB_TRANSPORT_REC *t_ptr, E_STB_DP_CMODE cmode);

ADB_TRANSPORT_REC* DBDEF_AddSatTransportRec(U32BIT freq_hz, U16BIT symbol_rate,
   E_STB_DP_POLARITY polarity, BOOLEAN dvb_s2, E_STB_DP_MODULATION modulation,
   ADB_NETWORK_REC *network);

ADB_TRANSPORT_REC* DBDEF_FindSatTransportRec(U32BIT freq_hz, U16BIT symbol_rate,
   E_STB_DP_POLARITY polarity, BOOLEAN dvb_s2, E_STB_DP_MODULATION modulation, void *satellite);

#ifdef COMMON_INTERFACE

ADB_TRANSPORT_REC* DBDEF_AddVirtualTransportRec(ADB_NETWORK_REC *network);
#endif

void DBDEF_SetSatTransportTuningParams(ADB_TRANSPORT_REC *t_ptr, U32BIT freq_hz,
   U16BIT symbol_rate, E_STB_DP_POLARITY polarity, BOOLEAN dvb_s2, E_STB_DP_MODULATION modulation,
   ADB_NETWORK_REC *network);

ADB_TRANSPORT_REC* DBDEF_FindTransportRecByIds(ADB_TRANSPORT_REC *transp, U32BIT net_id,
   U32BIT onet_id, U32BIT tran_id);

void DBDEF_SetTransportTransportId(ADB_TRANSPORT_REC *t_ptr, U16BIT tran_id);

void DBDEF_SetTransportOrigNetworkId(ADB_TRANSPORT_REC *t_ptr, U16BIT orig_net_id);

void DBDEF_GetTransportAdditionalFrequencies(ADB_TRANSPORT_REC *t_ptr, U8BIT *num_freqs, U32BIT **freqs);

void DBDEF_DeleteTransportRec(ADB_TRANSPORT_REC *t_ptr);

void DBDEF_ClearTableVersionHistory(ADB_TRANSPORT_REC *t_ptr);

U16BIT DBDEF_GetNumServices(void);

ADB_SERVICE_REC* DBDEF_GetNextServiceRec(ADB_SERVICE_REC *s_ptr);

ADB_SERVICE_REC* DBDEF_GetPrevServiceRec(ADB_SERVICE_REC *s_ptr);

ADB_SERVICE_REC* DBDEF_AddServiceRec(U16BIT serv_id, ADB_TRANSPORT_REC *t_ptr);

ADB_SERVICE_REC* DBDEF_CopyServiceRec(ADB_SERVICE_REC *orig_serv);

BOOLEAN DBDEF_SetServiceName(ADB_SERVICE_REC *s_ptr, U8BIT *name);

BOOLEAN DBDEF_SetServiceShortName(ADB_SERVICE_REC *s_ptr, U8BIT *name);

BOOLEAN DBDEF_SetServiceProviderName(ADB_SERVICE_REC *s_ptr, U8BIT *name);

BOOLEAN DBDEF_SetServiceType(ADB_SERVICE_REC *s_ptr, ADB_SERVICE_TYPE serv_type);

void DBDEF_SaveServiceEventSchedule(ADB_SERVICE_REC *s_ptr);

ADB_SERVICE_REC* DBDEF_GetNextServiceOnTransport(ADB_SERVICE_REC *s_ptr, ADB_TRANSPORT_REC *t_ptr);

ADB_SERVICE_REC* DBDEF_FindServiceRec(U16BIT serv_id, ADB_TRANSPORT_REC *t_ptr);

ADB_SERVICE_REC* DBDEF_FindServiceRecByIds(ADB_SERVICE_REC *servp, U32BIT net_id, U32BIT onet_id,
   U32BIT tran_id, U32BIT serv_id);

ADB_SERVICE_REC* DBDEF_FindServiceRecByLcn(U16BIT lcn, ADB_TRANSPORT_REC *t_ptr, BOOLEAN allocated_lcn);

ADB_SERVICE_REC* DBDEF_FindServiceRecByFreesatId(ADB_SERVICE_REC *servp, U16BIT freesat_id);

U16BIT DBDEF_GetReqdAudioPid(ADB_SERVICE_REC *s_ptr, E_STB_DP_AUDIO_MODE *audio_mode, ADB_STREAM_TYPE *audio_type);
U16BIT DBDEF_GetReqdADPid(ADB_SERVICE_REC *s_ptr, E_STB_DP_AUDIO_MODE *ad_mode, ADB_STREAM_TYPE *ad_type,
   BOOLEAN *broadcast_mix);
E_STREAM_MATCH_TYPE DBDEF_GetReqdTtextPid(ADB_SERVICE_REC *s_ptr, BOOLEAN for_subtitles, U16BIT *pid_ptr,
   U8BIT *magazine, U8BIT *page);
E_STREAM_MATCH_TYPE DBDEF_GetReqdSubtitleParams(ADB_SERVICE_REC *s_ptr, U16BIT *pid_ptr,
   U16BIT *cpage_ptr, U16BIT *apage_ptr);
U16BIT DBDEF_GetReqdVideoPid(ADB_SERVICE_REC *s_ptr, ADB_STREAM_TYPE *video_type);

ADB_STRING* DBDEF_GetServiceName(ADB_SERVICE_REC *s_ptr, BOOLEAN short_name, BOOLEAN pref_name);

ADB_STRING* DBDEF_GetServiceProviderName(ADB_SERVICE_REC *s_ptr);

void DBDEF_SetServiceDeletedFlag(ADB_SERVICE_REC *s_ptr, BOOLEAN deleted);

U16BIT DBDEF_GetNumDeletedServices(E_STB_DP_SIGNAL_TYPE tuner_type);

U16BIT DBDEF_GetDeletedServiceList(E_STB_DP_SIGNAL_TYPE tuner_type, void ***slist_ptr);

BOOLEAN DBDEF_AddAnalogService(void);
void DBDEF_SetAnalogServiceName(ADB_SERVICE_REC *s_ptr, U8BIT *new_name, U8BIT new_len);
void DBDEF_SetServicePmtPid(ADB_SERVICE_REC *s_ptr, U16BIT pmt_pid);
U16BIT DBDEF_GetServicePmtPid(ADB_SERVICE_REC *s_ptr);

void DBDEF_SetServiceFavGroups(ADB_SERVICE_REC *s_ptr, U8BIT groups);

ADB_EVENT_REC* DBDEF_FindScheduleEventById(ADB_SERVICE_REC *s_ptr, U16BIT event_id);

ADB_EVENT_DESC* DBDEF_FindEventDescriptor(ADB_EVENT_DESC *start_desc, U8BIT desc_tag,
   U32BIT private_data_specifier);

U8BIT* DBDEF_GetEventName(ADB_EVENT_REC *e_ptr);

U8BIT* DBDEF_GetEventDescription(ADB_EVENT_REC *e_ptr);

U8BIT* DBDEF_GetEventExtendedDescription(ADB_EVENT_REC *e_ptr);

ADB_EVENT_ITEMIZED_INFO* DBDEF_GetEventItemizedDescription(ADB_EVENT_REC *e_ptr, U16BIT *num_items_ptr);

U8BIT* DBDEF_GetEventGuidance(ADB_EVENT_REC *e_ptr, ADB_SERVICE_REC *s_ptr, U8BIT *type, U8BIT *mode);

U8BIT* DBDEF_GetServiceGuidanceData(ADB_SERVICE_REC *s_ptr, U8BIT *type, U8BIT *mode);

U8BIT* DBDEF_GetServiceGuidance(ADB_SERVICE_REC *s_ptr);

U8BIT DBDEF_GetEventParentalAge(ADB_EVENT_REC *e_ptr);

BOOLEAN DBDEF_GetEventAudioDescriptionFlag(ADB_EVENT_REC *e_ptr);

BOOLEAN DBDEF_GetEventHDLinkageInfo(ADB_EVENT_REC *e_ptr, BOOLEAN verify_event, BOOLEAN only_simulcast,
   ADB_SERVICE_REC **hd_serv_ptr, ADB_EVENT_REC **hd_event_ptr);

U8BIT DBDEF_GetEventComponentList(ADB_EVENT_REC *e_ptr, ADB_EVENT_COMPONENT_INFO **component_list);

BOOLEAN DBDEF_GetEventSubtitlesAvailFlag(ADB_EVENT_REC *e_ptr);

ADB_EVENT_CONTENT DBDEF_GetEventGenre(ADB_EVENT_REC *e_ptr, ADB_SERVICE_REC *s_ptr);

U8BIT* DBDEF_GetEventContentData(ADB_EVENT_REC *e_ptr, U8BIT *p_len);

U8BIT* DBDEF_GetEventCrid(ADB_SERVICE_REC *serv_ptr, ADB_EVENT_REC *e_ptr, U8BIT crid_type, U8BIT index);

U8BIT DBDEF_NumberOfCridsOfType(ADB_EVENT_REC *e_ptr, U8BIT crid_type);

U8BIT* DBDEF_GetFullCrid(ADB_SERVICE_REC *serv_ptr, U8BIT *event_str);

U8BIT* DBDEF_GetServiceDefaultAuthority(ADB_SERVICE_REC *s_ptr);

void DBDEF_DeleteEventList(ADB_EVENT_REC *elist);

void DBDEF_SetTunedNetwork(U8BIT path, ADB_NETWORK_REC *n_ptr);
ADB_NETWORK_REC* DBDEF_GetTunedNetwork(U8BIT path);

void DBDEF_SetTunedTransport(U8BIT path, ADB_TRANSPORT_REC *t_ptr);
ADB_TRANSPORT_REC* DBDEF_GetTunedTransport(U8BIT path);
void DBDEF_SetTunedService(U8BIT path, ADB_SERVICE_REC *s_ptr);
ADB_SERVICE_REC* DBDEF_GetTunedService(U8BIT path);

void DBDEF_SetTextLang(U8BIT *lang_ids);
U8BIT* DBDEF_GetTextLang(void);
void DBDEF_SetSecondaryTextLang(U8BIT *lang_ids);
U8BIT* DBDEF_GetSecondaryTextLang(void);
void DBDEF_SetAudioLang(U8BIT *lang_ids);
U8BIT* DBDEF_GetAudioLang(void);
U8BIT* DBDEF_GetSecondaryAudioLang(void);
void DBDEF_SetSecondaryAudioLang(U8BIT *lang_ids);

void DBDEF_TidyDatabaseAfterSearch(E_STB_DP_SIGNAL_TYPE tuner_type, void *satellite,
   BOOLEAN search_completed, BOOLEAN manual);

void DBDEF_TidyDatabaseNordig(E_STB_DP_SIGNAL_TYPE tuner_type, BOOLEAN search_completed, BOOLEAN manual);
void DBDEF_TidyDatabaseUK(E_STB_DP_SIGNAL_TYPE tuner_type, BOOLEAN search_completed, BOOLEAN manual);
void DBDEF_TidyDatabaseSatUK(E_STB_DP_SIGNAL_TYPE tuner_type, BOOLEAN search_completed, BOOLEAN manual);
void DBDEF_TidyDatabaseDefault(E_STB_DP_SIGNAL_TYPE tuner_type, BOOLEAN search_completed, BOOLEAN manual);

void DBDEF_RemoveEmptyTransports(E_STB_DP_SIGNAL_TYPE tuner_type, void *satellite);

void DBDEF_DeleteLinkageDescripterArray(SI_LINKAGE_DESC_ENTRY *list_ptr);

ADB_CRID_REC* DBDEF_AddCridRecord(U8BIT *crid, BOOLEAN series, BOOLEAN recommended);

void DBDEF_SetCridDateTime(ADB_CRID_REC *c_ptr, U32DHMS date_time);

void DBDEF_SetCridService(ADB_CRID_REC *c_ptr, U16BIT serv_id);

void DBDEF_SetCridProgrammeName(ADB_CRID_REC *c_ptr, U8BIT *prog_name);

void DBDEF_SetCridDoNotDelete(ADB_CRID_REC *c_ptr, BOOLEAN do_not_delete);

void DBDEF_UpdateCridEitDate(ADB_CRID_REC *c_ptr);

void DBDEF_DeleteCridRecord(ADB_CRID_REC *c_ptr);

U16BIT DBDEF_GetNumCridRecords(void);

ADB_CRID_REC* DBDEF_GetNextCridRecord(ADB_CRID_REC *c_ptr);

BOOLEAN DBDEF_IsValidCridRecord(ADB_CRID_REC *c_ptr);

U16BIT DBDEF_GetNumFavouriteLists(void);

ADB_FAVLIST_REC* DBDEF_AddFavouriteList(U8BIT list_id, U8BIT *name, U32BIT user_data, S16BIT index);

ADB_FAVLIST_REC* DBDEF_GetNextFavouriteList(ADB_FAVLIST_REC *fav_list);

ADB_FAVLIST_REC* DBDEF_FindFavouriteList(U8BIT list_id);

void DBDEF_SetFavouriteListUserData(ADB_FAVLIST_REC *fav_list, U32BIT user_data);

void DBDEF_MoveFavouriteListTo(ADB_FAVLIST_REC *fav_list, S16BIT index);

void DBDEF_DeleteFavouriteList(ADB_FAVLIST_REC *fav_list);

U16BIT DBDEF_GetNumServicesInFavouriteList(ADB_FAVLIST_REC *fav_list);

ADB_FAVSERV_REC* DBDEF_AddServiceToFavouriteList(ADB_FAVLIST_REC *fav_list,
   ADB_SERVICE_REC *serv_ptr, S16BIT index);

ADB_FAVSERV_REC* DBDEF_FindServiceInFavouriteList(ADB_FAVLIST_REC *fav_list, void *serv_ptr);

ADB_FAVSERV_REC* DBDEF_GetNextServiceFromFavouriteList(ADB_FAVLIST_REC *fav_list,
   ADB_FAVSERV_REC *fav_serv);

ADB_FAVSERV_REC* DBDEF_GetPrevServiceFromFavouriteList(ADB_FAVLIST_REC *fav_list,
   ADB_FAVSERV_REC *fav_serv);

void DBDEF_MoveFavouriteListServiceTo(ADB_FAVLIST_REC *fav_list, ADB_FAVSERV_REC *fav_serv,
   S16BIT index);

void DBDEF_DeleteServiceFromFavouriteList(ADB_FAVLIST_REC *fav_list, ADB_FAVSERV_REC *fav_serv);

void DBDEF_DeleteAllServicesFromFavouriteList(ADB_FAVLIST_REC *fav_list);

void DBDEF_SetFavouriteListName(ADB_FAVLIST_REC *f_ptr, U8BIT *name);

BOOLEAN DBDEF_ServiceForTunerType(ADB_SERVICE_REC *s_ptr, E_STB_DP_SIGNAL_TYPE tuner_type, void *satellite);

BOOLEAN DBDEF_TransportForTunerType(ADB_TRANSPORT_REC *t_ptr, E_STB_DP_SIGNAL_TYPE tuner_type, void *satellite);

ADB_TIMER_REC* DBDEF_AddTimerRec(BOOLEAN store_in_nvm);

ADB_TIMER_REC* DBDEF_FindTimerRec(U32BIT handle);

ADB_TIMER_REC* DBDEF_GetNextTimerRec(ADB_TIMER_REC *timer_ptr);

void DBDEF_SortTimers(BOOLEAN date_time_order);

void DBDEF_DeleteTimerRec(ADB_TIMER_REC *timer);

U16BIT DBDEF_GetNumProfiles(void);

U16BIT DBDEF_GetProfileList(void ***profile_list, U16BIT *active_profile);

void DBDEF_ReleaseProfileList(void **profile_list, U16BIT num_profiles);

BOOLEAN DBDEF_IsActiveProfile(ADB_NETWORK_REC *profile);

ADB_PROFILE_TYPE DBDEF_GetCurrentProfileType(void);

void DBDEF_SelectBroadcastProfile(void);

void DBDEF_PushBroadcastProfile(void);

#ifdef COMMON_INTERFACE

void DBDEF_SelectCIPlusProfile(U16BIT onet_id, U32BIT cicam_id);

void DBDEF_PushCIPlusProfile(U16BIT onet_id, U32BIT cicam_id);
#endif

void DBDEF_PopProfile(void);

BOOLEAN DBDEF_ServiceInProfile(ADB_SERVICE_REC *s_ptr);

BOOLEAN DBDEF_TransportInProfile(ADB_TRANSPORT_REC *t_ptr);

BOOLEAN DBDEF_NetworkInProfile(ADB_NETWORK_REC *n_ptr);

#ifdef COMMON_INTERFACE
ADB_NETWORK_REC* DBDEF_FindNetworkForCIPlusProfile(U16BIT cicam_onet_id, U32BIT cicam_identifier);
ADB_NETWORK_REC* DBDEF_FindNetworkForCIPlusModule(U32BIT module);

ADB_NETWORK_REC *DBDEF_GetCurrentCIPlusProfile(void);

ADB_CICAM_TIMER_REC* DBDEF_AddCicamTimer(U32BIT cicam_id, U32BIT timer_handle);

void DBDEF_DeleteCicamTimerRec(ADB_CICAM_TIMER_REC *cicam_timer_ptr);

ADB_CICAM_TIMER_REC* DBDEF_GetNextCicamTimerRec(ADB_CICAM_TIMER_REC *cicam_timer_ptr);

ADB_CICAM_TIMER_REC* DBDEF_FindCicamTimer(U32BIT cicam_id);

ADB_CICAM_TIMER_REC* DBDEF_FindCicamTimerByHandle(U32BIT handle);

#endif

ADB_NETWORK_REC* DBDEF_FindOrAddPrivateNetwork(void *satellite);

#ifdef DEBUG_PRINT_DATABASE
void DBDEF_PrintAllRecords(void);
#endif

ADB_STRING* DBDEF_MakeString(U32BIT lang_code, U8BIT *str_ptr, U16BIT nbytes);

ADB_STRING* DBDEF_CopyString(ADB_STRING *src_str);

ADB_STRING* DBDEF_ConcatSIString(ADB_STRING *str1, SI_STRING_DESC *str2);

void DBDEF_ReleaseString(ADB_STRING *string);

#endif //  _AP_DBDEF_H

//*****************************************************************************
// End of file
//*****************************************************************************