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

#include "techtype.h"
#include "stbdpc.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_ARGENTINA    (U32BIT)(('a' << 16) | ('r' << 8) | 'g')
#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_BOLIVIA      (U32BIT)(('b' << 16) | ('o' << 8) | 'l')
#define COUNTRY_CODE_BRAZIL       (U32BIT)(('b' << 16) | ('r' << 8) | 'a')
#define COUNTRY_CODE_CHILE        (U32BIT)(('c' << 16) | ('h' << 8) | 'l')
#define COUNTRY_CODE_CHINA        (U32BIT)(('c' << 16) | ('h' << 8) | 'i')
#define COUNTRY_CODE_COLOMBIA     (U32BIT)(('c' << 16) | ('o' << 8) | 'l')
#define COUNTRY_CODE_COSTARICA    (U32BIT)(('c' << 16) | ('r' << 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_DOMINICANREP (U32BIT)(('d' << 16) | ('m' << 8) | 'a')
#define COUNTRY_CODE_ECUADOR      (U32BIT)(('e' << 16) | ('c' << 8) | 'u')
#define COUNTRY_CODE_ELSALVADOR   (U32BIT)(('s' << 16) | ('l' << 8) | 'v')
#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_GUATEMALA    (U32BIT)(('g' << 16) | ('t' << 8) | 'm')
#define COUNTRY_CODE_HONDURAS     (U32BIT)(('h' << 16) | ('n' << 8) | 'd')
#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_MEXICO       (U32BIT)(('m' << 16) | ('e' << 8) | 'x')
#define COUNTRY_CODE_NETHERLANDS  (U32BIT)(('n' << 16) | ('l' << 8) | 'd')
#define COUNTRY_CODE_NICARAGUA    (U32BIT)(('n' << 16) | ('i' << 8) | 'c')
#define COUNTRY_CODE_PANAMA       (U32BIT)(('p' << 16) | ('a' << 8) | 'n')
#define COUNTRY_CODE_PERU         (U32BIT)(('p' << 16) | ('e' << 8) | 'r')
#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')
#define COUNTRY_CODE_VENEZUELA    (U32BIT)(('v' << 16) | ('e' << 8) | 'n')


// define language codes. (note these should all be lower-case - si handling converts received
// codes into lower-case when the tables are parsed)

#define ENGLISH_LANG_CODE              (('e' << 16) | ('n' << 8) | 'g')
#define WELSH1_LANG_CODE               (('w' << 16) | ('e' << 8) | 'l')
#define WELSH2_LANG_CODE               (('c' << 16) | ('y' << 8) | 'm')
#define GAELIC_LANG_CODE               (('g' << 16) | ('l' << 8) | 'a')
#define IRISH_LANG_CODE                (('g' << 16) | ('l' << 8) | 'e')
#define DUTCH1_LANG_CODE               (('n' << 16) | ('l' << 8) | 'd')
#define DUTCH2_LANG_CODE               (('d' << 16) | ('u' << 8) | 't')
#define GERMAN1_LANG_CODE              (('g' << 16) | ('e' << 8) | 'r')
#define GERMAN2_LANG_CODE              (('d' << 16) | ('e' << 8) | 'u')
#define FRENCH1_LANG_CODE              (('f' << 16) | ('r' << 8) | 'e')
#define FRENCH2_LANG_CODE              (('f' << 16) | ('r' << 8) | 'a')
#define RUSSIAN_LANG_CODE              (('r' << 16) | ('u' << 8) | 's')
#define SIMPLIFIED_CHINESE_LANG_CODE   (('c' << 16) | ('h' << 8) | 'i')
#define TRADITIONAL_CHINESE_LANG_CODE  (('c' << 16) | ('h' << 8) | 'i')
#define FINNISH_LANG_CODE              (('f' << 16) | ('i' << 8) | 'n')
#define SWEDISH_LANG_CODE              (('s' << 16) | ('w' << 8) | 'e')
#define NORWEGIAN_LANG_CODE            (('n' << 16) | ('o' << 8) | 'r')
#define DANISH_LANG_CODE               (('d' << 16) | ('a' << 8) | 'n')
#define MANDARIN_LANG_CODE             (('c' << 16) | ('m' << 8) | 'n')
#define CANTONESE_LANG_CODE            (('y' << 16) | ('u' << 8) | 'e')
#define MAORI1_LANG_CODE               (('m' << 16) | ('a' << 8) | 'o')
#define MAORI2_LANG_CODE               (('m' << 16) | ('r' << 8) | 'i')
#define JAPANESE_LANG_CODE             (('j' << 16) | ('p' << 8) | 'n')
#define ITALIAN_LANG_CODE              (('i' << 16) | ('t' << 8) | 'a')
#define SPANISH1_LANG_CODE             (('s' << 16) | ('p' << 8) | 'a')
#define SPANISH2_LANG_CODE             (('e' << 16) | ('s' << 8) | 'l')
#define KOREAN_LANG_CODE               (('k' << 16) | ('o' << 8) | 'r')
#define HINDI_LANG_CODE                (('h' << 16) | ('i' << 8) | 'n')
#define CZECH1_LANG_CODE               (('c' << 16) | ('z' << 8) | 'e')
#define CZECH2_LANG_CODE               (('c' << 16) | ('e' << 8) | 's')
#define SLOVAK1_LANG_CODE              (('s' << 16) | ('l' << 8) | 'k')
#define SLOVAK2_LANG_CODE              (('s' << 16) | ('l' << 8) | 'o')
#define AFRIKAANS_LANG_CODE            (('a' << 16) | ('f' << 8) | 'r')
#define NDEBELE_LANG_CODE              (('n' << 16) | ('b' << 8) | 'l')
#define NORTHERN_SOTHO_LANG_CODE       (('n' << 16) | ('s' << 8) | 'o')
#define SOUTHERN_SOTHO_LANG_CODE       (('s' << 16) | ('o' << 8) | 't')
#define SWATI_LANG_CODE                (('s' << 16) | ('s' << 8) | 'w')
#define TSONGA_LANG_CODE               (('t' << 16) | ('s' << 8) | 'o')
#define TSWANA_LANG_CODE               (('t' << 16) | ('s' << 8) | 'n')
#define VENDA_LANG_CODE                (('v' << 16) | ('e' << 8) | 'n')
#define XHOSA_LANG_CODE                (('x' << 16) | ('h' << 8) | 'o')
#define ZULU_LANG_CODE                 (('z' << 16) | ('u' << 8) | 'l')
#define CROATIAN_LANG_CODE             (('h' << 16) | ('r' << 8) | 'v')
#define HUNGARIAN_LANG_CODE            (('h' << 16) | ('u' << 8) | 'n')
#define LATVIAN_LANG_CODE              (('l' << 16) | ('a' << 8) | 'v')
#define LUXEMBOURGISH_LANG_CODE        (('l' << 16) | ('t' << 8) | 'z')
#define POLISH_LANG_CODE               (('p' << 16) | ('o' << 8) | 'l')
#define PORTUGUESE_LANG_CODE           (('p' << 16) | ('o' << 8) | 'r')
#define SERBIAN_LANG_CODE              (('s' << 16) | ('r' << 8) | 'p')
#define ROMANIAN1_LANG_CODE            (('r' << 16) | ('o' << 8) | 'n')
#define ROMANIAN2_LANG_CODE            (('r' << 16) | ('u' << 8) | 'm')
#define ALBANIAN1_LANG_CODE            (('s' << 16) | ('q' << 8) | 'i')
#define ALBANIAN2_LANG_CODE            (('a' << 16) | ('l' << 8) | 'b')
#define SLOVENE_LANG_CODE              (('s' << 16) | ('l' << 8) | 'v')
#define CATALAN_LANG_CODE              (('c' << 16) | ('a' << 8) | 't')
#define GALICIAN_LANG_CODE             (('g' << 16) | ('l' << 8) | 'g')
#define BASQUE1_LANG_CODE              (('e' << 16) | ('u' << 8) | 's')
#define BASQUE2_LANG_CODE              (('b' << 16) | ('a' << 8) | 'q')
#define UKRAINIAN_LANG_CODE            (('u' << 16) | ('k' << 8) | 'r')
#define UND_LANG_CODE                  (('u' << 16) | ('n' << 8) | 'd')

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

U32BIT ACFG_GetCountry(void);

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

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

U8BIT ACFG_GetNumRegions(U32BIT country_code);

BOOLEAN ACFG_GetRegionList(U32BIT country_code, U8BIT ***str_array_ptr, U8BIT *num_regions_ptr);

BOOLEAN ACFG_GetRegionCode(U32BIT country_code, U8BIT region_id, U8BIT *code_ptr);

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

U8BIT ACFG_GetCountryIndex(U32BIT country_code);

U8BIT ACFG_GetRegionId(void);

BOOLEAN ACFG_SetCountry(U32BIT country_code);

U8BIT ACFG_GetNumDbLanguages(U32BIT country_code);

BOOLEAN ACFG_GetDbLangList(U32BIT country_code, U8BIT ***str_array_ptr, U8BIT *num_langs_ptr);

U8BIT* ACFG_GetDbLangId(U32BIT country_code, 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_SetCountryIds(U32BIT country_code, 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(U32BIT country_code, ACFG_ANA_RF_CHANNEL_DATA **rf_chan_data_ptr,
   U16BIT *num_entries_ptr);

BOOLEAN ACFG_GetTerRfChannelTable(U32BIT country_code, ACFG_TER_RF_CHANNEL_DATA **rf_chan_data_ptr,
   U16BIT *num_entries_ptr);

BOOLEAN ACFG_GetCabRfChannelTable(U32BIT country_code, 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(U32BIT country_code);

U16BIT ACFG_GetFirstUnallocatedLcn(U32BIT country_code);

U16BIT ACFG_GetLastUnallocatedLcn(U32BIT country_code);

BOOLEAN ACFG_GetWatershedTimes(U32BIT country_code, U16BIT *start_time, U16BIT *end_time);

U16BIT ACFG_GetMinSatelliteScanFreq(U32BIT country_code);

U16BIT ACFG_GetMaxSatelliteScanFreq(U32BIT country_code);

U16BIT ACFG_GetSatelliteScanFreqInc(U32BIT country_code);

U16BIT* ACFG_GetSatelliteScanSymbolRates(U32BIT country_code);

U8BIT ACFG_GetSatelliteScanNumSymbolRates(U32BIT country_code);

BOOLEAN ACFG_GetSatelliteScanDvbS2(U32BIT country_code);

BOOLEAN ACFG_GetAerialPowerOptionReqd(U32BIT country_code);

BOOLEAN ACFG_GetDefaultAerialPower(U32BIT country_code);

BOOLEAN ACFG_GetAerialTuningScreenReqd(U32BIT country_code);

U8BIT* ACFG_GetEventContentTypes(U32BIT country_code);

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(U32BIT country_code);

void ACFG_SetTerrestrialLcnFunction(U32BIT country_code, AllocLcnFunc func_ptr);

AllocLcnFunc ACFG_GetCableLcnFunction(U32BIT country_code);

void ACFG_SetCableLcnFunction(U32BIT country_code, AllocLcnFunc func_ptr);

AllocLcnFunc ACFG_GetSatelliteLcnFunction(U32BIT country_code);

void ACFG_SetSatelliteLcnFunction(U32BIT country_code, AllocLcnFunc func_ptr);

DBTidyFunc ACFG_GetTerrestrialDBTidyFunction(U32BIT country_code);

DBTidyFunc ACFG_GetCableDBTidyFunction(U32BIT country_code);

DBTidyFunc ACFG_GetSatelliteDBTidyFunction(U32BIT country_code);

void ACFG_SetUndefinedLanguageBehaviour(U32BIT lang_code);

U32BIT ACFG_GetUndefinedLanguageBehaviour(void);

void ACFG_SetHostCountryLanguageModuleId(U32BIT module);

#endif //  _AP_CFG_H