dvb/inc/ap_cfg.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_CFG_H
#define _AP_CFG_H

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

#define ACFG_INVALID_REGION   255
#define ACFG_INVALID_LANG     255

/* Country codes - please add new countries in alphabetical order */
#define COUNTRY_CODE_AUSTRALIA   (U32BIT)(('a' << 16) | ('u' << 8) | 's')
#define COUNTRY_CODE_AUSTRIA     (U32BIT)(('a' << 16) | ('u' << 8) | 't')
#define COUNTRY_CODE_BELGIUM     (U32BIT)(('b' << 16) | ('e' << 8) | 'l')
#define COUNTRY_CODE_CHINA       (U32BIT)(('c' << 16) | ('h' << 8) | 'i')
#define COUNTRY_CODE_CROATIA     (U32BIT)(('h' << 16) | ('r' << 8) | 'v')
#define COUNTRY_CODE_CZECHREP    (U32BIT)(('c' << 16) | ('z' << 8) | 'e')
#define COUNTRY_CODE_FINLAND     (U32BIT)(('f' << 16) | ('i' << 8) | 'n')
#define COUNTRY_CODE_FRANCE      (U32BIT)(('f' << 16) | ('r' << 8) | 'a')
#define COUNTRY_CODE_GERMANY     (U32BIT)(('d' << 16) | ('e' << 8) | 'u')
#define COUNTRY_CODE_HUNGARY     (U32BIT)(('h' << 16) | ('u' << 8) | 'n')
#define COUNTRY_CODE_ITALY       (U32BIT)(('i' << 16) | ('t' << 8) | 'a')
#define COUNTRY_CODE_LATVIA      (U32BIT)(('l' << 16) | ('v' << 8) | 'a')
#define COUNTRY_CODE_LUXEMBOURG  (U32BIT)(('l' << 16) | ('u' << 8) | 'x')
#define COUNTRY_CODE_NETHERLANDS (U32BIT)(('n' << 16) | ('l' << 8) | 'd')
#define COUNTRY_CODE_POLAND      (U32BIT)(('p' << 16) | ('o' << 8) | 'l')
#define COUNTRY_CODE_PORTUGAL    (U32BIT)(('p' << 16) | ('o' << 8) | 'r')
#define COUNTRY_CODE_RUSSIA      (U32BIT)(('r' << 16) | ('u' << 8) | 's')
#define COUNTRY_CODE_SERBIA      (U32BIT)(('s' << 16) | ('r' << 8) | 'b')
#define COUNTRY_CODE_SLOVAKIA    (U32BIT)(('s' << 16) | ('v' << 8) | 'k')
#define COUNTRY_CODE_SLOVENIA    (U32BIT)(('s' << 16) | ('v' << 8) | 'n')
#define COUNTRY_CODE_SOUTHAFRICA (U32BIT)(('z' << 16) | ('a' << 8) | 'f')
#define COUNTRY_CODE_SPAIN       (U32BIT)(('e' << 16) | ('s' << 8) | 'p')
#define COUNTRY_CODE_SWEDEN      (U32BIT)(('s' << 16) | ('w' << 8) | 'e')
#define COUNTRY_CODE_SWITZERLAND (U32BIT)(('c' << 16) | ('h' << 8) | 'e')
#define COUNTRY_CODE_UK          (U32BIT)(('g' << 16) | ('b' << 8) | 'r')
#define COUNTRY_CODE_UKRAINE     (U32BIT)(('u' << 16) | ('k' << 8) | 'r')


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

/* Database lang definitions */
enum E_DB_LANGS
{
   ACFG_DB_LANG_ENGLISH,
   ACFG_DB_LANG_WELSH1,
   ACFG_DB_LANG_WELSH2,
   ACFG_DB_LANG_GAELIC,
   ACFG_DB_LANG_IRISH,
   ACFG_DB_LANG_DUTCH1,
   ACFG_DB_LANG_DUTCH2,
   ACFG_DB_LANG_GERMAN1,
   ACFG_DB_LANG_GERMAN2,
   ACFG_DB_LANG_FRENCH1,
   ACFG_DB_LANG_FRENCH2,
   ACFG_DB_LANG_RUSSIAN,
   ACFG_DB_LANG_SIMPLIFIED_CHINESE,
   ACFG_DB_LANG_TRADITIONAL_CHINESE,
   ACFG_DB_LANG_FINNISH,
   ACFG_DB_LANG_SWEDISH,
   ACFG_DB_LANG_NORWEGIAN,
   ACFG_DB_LANG_DANISH,
   ACFG_DB_LANG_MANDARIN,
   ACFG_DB_LANG_CANTONESE,
   ACFG_DB_LANG_MAORI1,
   ACFG_DB_LANG_MAORI2,
   ACFG_DB_LANG_JAPANESE,
   ACFG_DB_LANG_ITALIAN,
   ACFG_DB_LANG_SPANISH1,
   ACFG_DB_LANG_SPANISH2,
   ACFG_DB_LANG_KOREAN,
   ACFG_DB_LANG_HINDI,
   ACFG_DB_LANG_CZECH1,
   ACFG_DB_LANG_CZECH2,
   ACFG_DB_LANG_SLOVAK1,
   ACFG_DB_LANG_SLOVAK2,
   ACFG_DB_LANG_AFRIKAANS,
   ACFG_DB_LANG_NDEBELE,
   ACFG_DB_LANG_NORTHERN_SOTHO,
   ACFG_DB_LANG_SOUTHERN_SOTHO,
   ACFG_DB_LANG_SWATI,
   ACFG_DB_LANG_TSONGA,
   ACFG_DB_LANG_TSWANA,
   ACFG_DB_LANG_VENDA,
   ACFG_DB_LANG_XHOSA,
   ACFG_DB_LANG_ZULU,
   ACFG_DB_LANG_CROATIAN,
   ACFG_DB_LANG_HUNGARIAN,
   ACFG_DB_LANG_LATVIAN,
   ACFG_DB_LANG_LUXEMBOURGISH,
   ACFG_DB_LANG_POLISH,
   ACFG_DB_LANG_PORTUGUESE,
   ACFG_DB_LANG_SERBIAN,
   ACFG_DB_LANG_ROMANIAN1,
   ACFG_DB_LANG_ROMANIAN2,
   ACFG_DB_LANG_ALBANIAN1,
   ACFG_DB_LANG_ALBANIAN2,
   ACFG_DB_LANG_SLOVENE,
   ACFG_DB_LANG_CATALAN,
   ACFG_DB_LANG_GALICIAN,
   ACFG_DB_LANG_BASQUE1,
   ACFG_DB_LANG_BASQUE2,
   ACFG_DB_LANG_UKRAINIAN,
   ACFG_DB_LANG_UND,
   ACFG_NUM_DB_LANGUAGES
};


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

typedef struct ana_rf_channel_data
{
   U8BIT *name;
   U32BIT freq_hz;
} ACFG_ANA_RF_CHANNEL_DATA;

typedef struct ter_rf_channel_data
{
   U8BIT *name;
   U32BIT freq_hz;
   E_STB_DP_TBWIDTH bwidth;
   E_STB_DP_TMODE mode;
   E_STB_DP_TTYPE type;
} ACFG_TER_RF_CHANNEL_DATA;

typedef struct cab_rf_channel_data
{
   U8BIT *name;
   U32BIT freq_hz;
   E_STB_DP_CMODE mode;
   U16BIT symbol_rate;
} ACFG_CAB_RF_CHANNEL_DATA;

typedef BOOLEAN (*AllocLcnFunc)(E_STB_DP_SIGNAL_TYPE tuner_type);
typedef void (*DBTidyFunc)(E_STB_DP_SIGNAL_TYPE tuner_type, BOOLEAN search_completed, BOOLEAN manual);

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

U8BIT ACFG_GetNumCountries(void);

void ACFG_GetCountryList(U8BIT ***str_array_ptr, U8BIT *num_countries_ptr);

void ACFG_ReleaseCountryList(U8BIT **str_array, U8BIT num_countries);

U8BIT ACFG_GetNumRegions(U8BIT country_id);

BOOLEAN ACFG_GetRegionList(U8BIT country_id, U8BIT ***str_array_ptr, U8BIT *num_regions_ptr);

BOOLEAN ACFG_GetRegionCode(U8BIT country_id, U8BIT region_id, U8BIT *code_ptr);

void ACFG_ReleaseRegionList(U8BIT **str_array, U8BIT num_regions);

U8BIT ACFG_GetCountryId(void);

U8BIT ACFG_GetRegionId(void);

BOOLEAN ACFG_SetCountry(U32BIT country_code);

U8BIT ACFG_GetNumDbLanguages(U8BIT country_id);

BOOLEAN ACFG_GetDbLangList(U8BIT country_id, U8BIT ***str_array_ptr, U8BIT *num_langs_ptr);

U8BIT* ACFG_GetDbLangId(U8BIT country_id, U8BIT lang_entry);

void ACFG_ReleaseDbLangList(U8BIT **str_array, U8BIT num_langs);

U8BIT ACFG_ConvertLangCodeToId(U32BIT lang_code);

U32BIT ACFG_ConvertLangIdToCode(U8BIT lang_id);

void ACFG_SetCountryId(U8BIT country_id, U8BIT region_id, U8BIT audio_lang_id, U8BIT sub_lang_id);

U8BIT ACFG_GetPrimaryAudioLangId(void);

U8BIT ACFG_GetSecondaryAudioLangId(void);

U8BIT ACFG_GetPrimaryTextLangId(void);

U8BIT ACFG_GetSecondaryTextLangId(void);

void ACFG_SetPrimaryAudioLangId(U8BIT lang_id);

void ACFG_SetSecondaryAudioLangId(U8BIT lang_id);

void ACFG_SetPrimaryTextLangId(U8BIT lang_id);

void ACFG_SetSecondaryTextLangId(U8BIT lang_id);

U8BIT ACFG_GetDefaultSecondaryLangId(void);

BOOLEAN ACFG_GetAnaRfChannelTable(U8BIT country_id, ACFG_ANA_RF_CHANNEL_DATA **rf_chan_data_ptr, U16BIT *num_entries_ptr);

BOOLEAN ACFG_GetTerRfChannelTable(U8BIT country_id, ACFG_TER_RF_CHANNEL_DATA **rf_chan_data_ptr, U16BIT *num_entries_ptr);

BOOLEAN ACFG_GetCabRfChannelTable(U8BIT country_id, ACFG_CAB_RF_CHANNEL_DATA **rf_chan_data_ptr, U16BIT *num_entries_ptr);

void ACFG_SetCableChannelTable(ACFG_CAB_RF_CHANNEL_DATA *cable_channel_data, U16BIT number_channels);

U32BIT ACFG_GetCountryCode(U8BIT country_id);

U32BIT ACFG_GetPrivateDataSpecifier(U8BIT country_id);

U16BIT ACFG_GetFirstUnallocatedLcn(U8BIT country_id);

U16BIT ACFG_GetLastUnallocatedLcn(U8BIT country_id);

BOOLEAN ACFG_GetWatershedTimes(U8BIT country_id, U16BIT *start_time, U16BIT *end_time);

U16BIT ACFG_GetMinSatelliteScanFreq(U8BIT country_id);

U16BIT ACFG_GetMaxSatelliteScanFreq(U8BIT country_id);

U16BIT ACFG_GetSatelliteScanFreqInc(U8BIT country_id);

U16BIT* ACFG_GetSatelliteScanSymbolRates(U8BIT country_id);

U8BIT ACFG_GetSatelliteScanNumSymbolRates(U8BIT country_id);

BOOLEAN ACFG_GetSatelliteScanDvbS2(U8BIT country_id);

BOOLEAN ACFG_GetAerialPowerOptionReqd(U8BIT country_id);

BOOLEAN ACFG_GetDefaultAerialPower(U8BIT country_id);

BOOLEAN ACFG_GetAerialTuningScreenReqd(U8BIT country_id);

U8BIT* ACFG_GetEventContentTypes(U8BIT country_id);

void ACFG_SetBackgroundSearchTime(U16BIT start_time, U16BIT end_time);

void ACFG_GetBackgroundSearchTime(U16BIT *start_time, U16BIT *end_time);

void ACFG_SetBackgroundServiceSearch(BOOLEAN enabled);

BOOLEAN ACFG_GetBackgroundServiceSearch(void);

void ACFG_SetBackgroundSSUSearch(BOOLEAN enabled);

BOOLEAN ACFG_GetBackgroundSSUSearch(void);

BOOLEAN ACFG_IsNordigCountry(void);

U8BIT ACFG_GetEitUpdateTime(void);

U8BIT ACFG_GetEitSearchesPerDay(void);

AllocLcnFunc ACFG_GetTerrestrialLcnFunction(U8BIT country_id);

void ACFG_SetTerrestrialLcnFunction(U8BIT country_id, AllocLcnFunc func_ptr);

AllocLcnFunc ACFG_GetCableLcnFunction(U8BIT country_id);

void ACFG_SetCableLcnFunction(U8BIT country_id, AllocLcnFunc func_ptr);

AllocLcnFunc ACFG_GetSatelliteLcnFunction(U8BIT country_id);

void ACFG_SetSatelliteLcnFunction(U8BIT country_id, AllocLcnFunc func_ptr);

DBTidyFunc ACFG_GetTerrestrialDBTidyFunction(U8BIT country_id);

DBTidyFunc ACFG_GetCableDBTidyFunction(U8BIT country_id);

DBTidyFunc ACFG_GetSatelliteDBTidyFunction(U8BIT country_id);

#endif //  _AP_CFG_H