dvb/inc/ap_cfg.h File Reference

Application configuration. More...

Go to the source code of this file.

Data Structures
struct	ana_rf_channel_data
struct	ter_rf_channel_data
struct	cab_rf_channel_data
Defines
#define	ACFG_INVALID_REGION   255
#define	ACFG_INVALID_LANG   255
#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')
Typedefs
typedef struct ana_rf_channel_data	ACFG_ANA_RF_CHANNEL_DATA
typedef struct ter_rf_channel_data	ACFG_TER_RF_CHANNEL_DATA
typedef struct cab_rf_channel_data	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)
Enumerations
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 }
Functions
U8BIT	ACFG_GetNumCountries (void)
	Returns the number of country configurations included in the DVB stack.
void	ACFG_GetCountryList (U8BIT ***str_array_ptr, U8BIT *num_countries_ptr)
	Returns an array containing the names of all the countries included in the DVB. The index into this array is referred to as the country_id. The returned array should be freed using ACFG_ReleaseCountryList.
void	ACFG_ReleaseCountryList (U8BIT **str_array, U8BIT num_countries)
	Frees a country list previously acquired using ACFG_GetCountryList.
U8BIT	ACFG_GetNumRegions (U8BIT country_id)
	Returns the number of regions in the given country.
BOOLEAN	ACFG_GetRegionList (U8BIT country_id, U8BIT ***str_array_ptr, U8BIT *num_regions_ptr)
	Returns an array of pointers to strings containing the region names for the given country index. The index into this array is the region_id. The array is allocated by this function and should be freed using ACFG_ReleaseRegionList.
BOOLEAN	ACFG_GetRegionCode (U8BIT country_id, U8BIT region_id, U8BIT *code_ptr)
	Returns the region code that identifies the given region.
void	ACFG_ReleaseRegionList (U8BIT **str_array, U8BIT num_regions)
	Frees the region array previously acquired using ACFG_GetRegionList.
U8BIT	ACFG_GetCountryId (void)
	Returns the internal ID of the country the DVB is configured for.
U8BIT	ACFG_GetRegionId (void)
	Returns the internal ID of the region the DVB is configured for.
BOOLEAN	ACFG_SetCountry (U32BIT country_code)
	Sets the current country and sets default values for region and language.
U8BIT	ACFG_GetNumDbLanguages (U8BIT country_id)
	Returns the number of languages defined for the given country that can be used for audio and subtitles/teletext.
BOOLEAN	ACFG_GetDbLangList (U8BIT country_id, U8BIT ***str_array_ptr, U8BIT *num_langs_ptr)
	Returns an array of pointers to strings containing the available language names for the given country index. The index into this array is the lang_id used when getting and setting audio and text language ids. The array is allocated by this function and should be freed using ACFG_ReleaseDbLangList.
U8BIT *	ACFG_GetDbLangId (U8BIT country_id, U8BIT lang_entry)
	Returns an array of language ids for a given country and index into the language array. A language id is one of the ACFG_DB_LANG_XXXX values above and there might be more than one for a given language. For example german language has two ids associated to it: ACFG_DB_LANG_GERMAN1 and ACFG_DB_LANG_GERMAN2 because german language can have two different codes, 'deu' and 'ger'. See also functions ACFG_ConvertLangIdToCode and ACFG_ConvertLangCodeToId. The returned pointer is an internal array and must not be freed.
void	ACFG_ReleaseDbLangList (U8BIT **str_array, U8BIT num_langs)
	Frees the language array previously acquired using ACFG_GetDbLangList.
U8BIT	ACFG_ConvertLangCodeToId (U32BIT lang_code)
	Returns the language id for the given language code.
U32BIT	ACFG_ConvertLangIdToCode (U8BIT lang_id)
	Returns the language code for the given language id.
void	ACFG_SetCountryId (U8BIT country_id, U8BIT region_id, U8BIT audio_lang_id, U8BIT sub_lang_id)
	Saves the configured country and changes settings related to the country.
U8BIT	ACFG_GetPrimaryAudioLangId (void)
	Returns the primary audio language ID.
U8BIT	ACFG_GetSecondaryAudioLangId (void)
	Returns the secondary audio language ID.
U8BIT	ACFG_GetPrimaryTextLangId (void)
	Returns the primary DVB subtitle/teletext language ID.
U8BIT	ACFG_GetSecondaryTextLangId (void)
	Returns the secondary DVB subtitle/teletext language ID.
void	ACFG_SetPrimaryAudioLangId (U8BIT lang_id)
	Sets the primary language id to be used for audio. This is the language that will be chosen first, if available.
void	ACFG_SetSecondaryAudioLangId (U8BIT lang_id)
	Sets the secondary language id to be used for audio.
void	ACFG_SetPrimaryTextLangId (U8BIT lang_id)
	Sets the primary language id to be used for teletext/subtitles.
void	ACFG_SetSecondaryTextLangId (U8BIT lang_id)
	Sets the secondary language id to be used for teletext/subtitles.
U8BIT	ACFG_GetDefaultSecondaryLangId (void)
	Returns the default secondary language for audio and subtitles as defined for the selected country. This is used for countries that don't use the secondary language, but expect a defined language to be used if the primary one isn't available.
BOOLEAN	ACFG_GetAnaRfChannelTable (U8BIT country_id, ACFG_ANA_RF_CHANNEL_DATA **rf_chan_data_ptr, U16BIT *num_entries_ptr)
	Returns a pointer to the channel table for an analog tuner for the given country.
BOOLEAN	ACFG_GetTerRfChannelTable (U8BIT country_id, ACFG_TER_RF_CHANNEL_DATA **rf_chan_data_ptr, U16BIT *num_entries_ptr)
	Returns a pointer to the channel table for a terrestrial tuner for the given country.
BOOLEAN	ACFG_GetCabRfChannelTable (U8BIT country_id, ACFG_CAB_RF_CHANNEL_DATA **rf_chan_data_ptr, U16BIT *num_entries_ptr)
	Returns a pointer to the channel table for a cable tuner for the given country.
void	ACFG_SetCableChannelTable (ACFG_CAB_RF_CHANNEL_DATA *cable_channel_data, U16BIT number_channels)
	Replaces the cable tuning table for the current country with the one provided.
U32BIT	ACFG_GetCountryCode (U8BIT country_id)
	Returns the country code for the given country_id.
U32BIT	ACFG_GetPrivateDataSpecifier (U8BIT country_id)
	Returns the private data specifier value for the given country.
U16BIT	ACFG_GetFirstUnallocatedLcn (U8BIT country_id)
	Returns the first LCN that should be used when assigning LCNs to services that don't appear in an LCN descriptor, or can't be assigned their desired LCN.
U16BIT	ACFG_GetLastUnallocatedLcn (U8BIT country_id)
	Returns the last LCN that should be used when assigning LCNs to services that don't appear in an LCN descriptor, or can't be assigned their desired LCN.
BOOLEAN	ACFG_GetWatershedTimes (U8BIT country_id, U16BIT *start_time, U16BIT *end_time)
	Get the start and end times of the watershed hours for a country.
U16BIT	ACFG_GetMinSatelliteScanFreq (U8BIT country_id)
	Returns the minimum frequency to be used when performing a satellite based frequency scan in the given country.
U16BIT	ACFG_GetMaxSatelliteScanFreq (U8BIT country_id)
	Returns the maximum frequency to be used when performing a satellite based frequency scan in the given country.
U16BIT	ACFG_GetSatelliteScanFreqInc (U8BIT country_id)
	Returns the increment frequency to be used when performing a satellite based frequency scan in the given country.
U16BIT *	ACFG_GetSatelliteScanSymbolRates (U8BIT country_id)
	Returns a fixed array of symbol rates to be used when performing a satellite based frequency scan in the given country.
U8BIT	ACFG_GetSatelliteScanNumSymbolRates (U8BIT country_id)
	Returns the number of items in the fixed array of symbol rates to be used when performing a satellite based frequency scan in the given country.
BOOLEAN	ACFG_GetSatelliteScanDvbS2 (U8BIT country_id)
	Returns whether DVB-S2 should be included when performing a satellite based frequency scan in the given country.
BOOLEAN	ACFG_GetAerialPowerOptionReqd (U8BIT country_id)
	Returns whether the aerial power option is required for DVB-T/T2 for the given country.
BOOLEAN	ACFG_GetDefaultAerialPower (U8BIT country_id)
	Returns the default aerial power option setting for DVB-T/T2 for the given country.
BOOLEAN	ACFG_GetAerialTuningScreenReqd (U8BIT country_id)
	Returns whether an aerial tuning screen should be presented by the interface before performing a DVB-T/T2 scan for services for the given country.
U8BIT *	ACFG_GetEventContentTypes (U8BIT country_id)
	Returns the event content types for the given country. This defines how the content type value broadcast as part of the EIT is to be interpreted.
void	ACFG_SetBackgroundSearchTime (U16BIT start_time, U16BIT end_time)
	Sets the start and end times during which background searches are allowed run when in standby.
void	ACFG_GetBackgroundSearchTime (U16BIT *start_time, U16BIT *end_time)
	Gets the background start and end search times.
void	ACFG_SetBackgroundServiceSearch (BOOLEAN enabled)
	Enables or disables the background service search when in standby.
BOOLEAN	ACFG_GetBackgroundServiceSearch (void)
	Returns whether the background service search is enabled or not.
void	ACFG_SetBackgroundSSUSearch (BOOLEAN enabled)
	Enables or disables the background SSU search when in standby.
BOOLEAN	ACFG_GetBackgroundSSUSearch (void)
	Returns whether the background SSU search is enabled or not.
BOOLEAN	ACFG_IsNordigCountry (void)
	Returns whether the current country requires Nordig compliance for SI.
U8BIT	ACFG_GetEitUpdateTime (void)
	Returns the number of minutes after which all the events should have been received during an EIT search. This is the EIT repetition time.
U8BIT	ACFG_GetEitSearchesPerDay (void)
	Returns the number of EIT searches that should be performed per day when the box is in standby.
AllocLcnFunc	ACFG_GetTerrestrialLcnFunction (U8BIT country_id)
	Returns a pointer to a function that's used to assign LCNs following a DVB-T/T2 scan for the given country.
void	ACFG_SetTerrestrialLcnFunction (U8BIT country_id, AllocLcnFunc func_ptr)
	Overrides an existing DVB-T/T2 LCN allocation function for the given country.
AllocLcnFunc	ACFG_GetCableLcnFunction (U8BIT country_id)
	Returns a pointer to a function that's used to assign LCNs following a DVB-C scan for the given country.
void	ACFG_SetCableLcnFunction (U8BIT country_id, AllocLcnFunc func_ptr)
	Overrides an existing DVB-C LCN allocation function for the given country.
AllocLcnFunc	ACFG_GetSatelliteLcnFunction (U8BIT country_id)
	Returns a pointer to a function that's used to assign LCNs following a DVB-S/S2 scan for the given country.
void	ACFG_SetSatelliteLcnFunction (U8BIT country_id, AllocLcnFunc func_ptr)
	Overrides an existing DVB-S/S2 LCN allocation function for the given country.
DBTidyFunc	ACFG_GetTerrestrialDBTidyFunction (U8BIT country_id)
	Returns a pointer to a function that's used to tidy up the database following a DVB-T/T2 scan for the given country.
DBTidyFunc	ACFG_GetCableDBTidyFunction (U8BIT country_id)
	Returns a pointer to a function that's used to tidy up the database following a DVB-C scan for the given country.
DBTidyFunc	ACFG_GetSatelliteDBTidyFunction (U8BIT country_id)
	Returns a pointer to a function that's used to tidy up the database following a DVB-S/S2 scan for the given country.

---

Detailed Description

Application configuration.

Date:

5/04/2004

Author:

Ocean Blue

---

Function Documentation

U8BIT ACFG_ConvertLangCodeToId

(

U32BIT

lang_code

)

Returns the language id for the given language code.

Parameters:

lang_code

language code

Returns:

language id, or ACFG_INVALID_LANG if language code isn't found

U32BIT ACFG_ConvertLangIdToCode

(

U8BIT

lang_id

)

Returns the language code for the given language id.

Parameters:

lang_id

language id

Returns:

language code, or 0 if language id isn't valid

BOOLEAN ACFG_GetAerialPowerOptionReqd

(

U8BIT

country_id

)

Returns whether the aerial power option is required for DVB-T/T2 for the given country.

Parameters:

country_id

country id

Returns:

TRUE if required, FALSE otherwise

BOOLEAN ACFG_GetAerialTuningScreenReqd

(

U8BIT

country_id

)

Returns whether an aerial tuning screen should be presented by the interface before performing a DVB-T/T2 scan for services for the given country.

Parameters:

country_id

country id

Returns:

TRUE if required, FALSE otherwise

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

Returns a pointer to the channel table for an analog tuner for the given country.

Parameters:

country_id	country whose table is to be returned
rf_chan_data_ptr	returned pointer to the channel table
num_entries_ptr	number of entries in the returned channel table

Returns:

TRUE if the country is valid and data is returned, FALSE otherwise

void ACFG_GetBackgroundSearchTime	(	U16BIT *	start_time,
		U16BIT *	end_time
	)

Gets the background start and end search times.

Parameters:

start_time	return start time in minutes since midnight
end_time	return end time in minutes

BOOLEAN ACFG_GetBackgroundServiceSearch

(

void

)

Returns whether the background service search is enabled or not.

Returns:

TRUE if enabled, FALSE otherwise

BOOLEAN ACFG_GetBackgroundSSUSearch

(

void

)

Returns whether the background SSU search is enabled or not.

Returns:

TRUE if enabled, FALSE otherwise

DBTidyFunc ACFG_GetCableDBTidyFunction

(

U8BIT

country_id

)

Returns a pointer to a function that's used to tidy up the database following a DVB-C scan for the given country.

Returns:

pointer to function, or NULL

AllocLcnFunc ACFG_GetCableLcnFunction

(

U8BIT

country_id

)

Returns a pointer to a function that's used to assign LCNs following a DVB-C scan for the given country.

Parameters:

country_id

country id

Returns:

pointer to function, or NULL

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

Returns a pointer to the channel table for a cable tuner for the given country.

Parameters:

country_id	country whose table is to be returned
rf_chan_data_ptr	returned pointer to the channel table
num_entries_ptr	number of entries in the returned channel table

Returns:

TRUE if the country is valid and data is returned, FALSE otherwise

U32BIT ACFG_GetCountryCode

(

U8BIT

country_id

)

Returns the country code for the given country_id.

Parameters:

country_id

coutry index

Returns:

country code, or 0 if country id isn't valid

U8BIT ACFG_GetCountryId

(

void

)

Returns the internal ID of the country the DVB is configured for.

Returns:

country id

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

Returns an array containing the names of all the countries included in the DVB. The index into this array is referred to as the country_id. The returned array should be freed using ACFG_ReleaseCountryList.

Parameters:

str_array_ptr	pointer to an allocated array of static UTF-8 strings
num_countries_ptr	pointer to the number of countries in the returned array

U8BIT* ACFG_GetDbLangId	(	U8BIT	country_id,
		U8BIT	lang_entry
	)

Returns an array of language ids for a given country and index into the language array. A language id is one of the ACFG_DB_LANG_XXXX values above and there might be more than one for a given language. For example german language has two ids associated to it: ACFG_DB_LANG_GERMAN1 and ACFG_DB_LANG_GERMAN2 because german language can have two different codes, 'deu' and 'ger'. See also functions ACFG_ConvertLangIdToCode and ACFG_ConvertLangCodeToId. The returned pointer is an internal array and must not be freed.

Parameters:

country_id	country index
lang_entry	index into the language array

Returns:

pointer to the array of language ids, or NULL if either of the indices are invalid.

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

Returns an array of pointers to strings containing the available language names for the given country index. The index into this array is the lang_id used when getting and setting audio and text language ids. The array is allocated by this function and should be freed using ACFG_ReleaseDbLangList.

Parameters:

country_id	country index
str_array_ptr	pointer to an allocated array of static UTF-8 strings
num_langs_ptr	pointer to the number of languages in the returned array

Returns:

TRUE if the country_id is valid

BOOLEAN ACFG_GetDefaultAerialPower

(

U8BIT

country_id

)

Returns the default aerial power option setting for DVB-T/T2 for the given country.

Parameters:

country_id

country id

Returns:

TRUE or FALSE

U8BIT ACFG_GetDefaultSecondaryLangId

(

void

)

Returns the default secondary language for audio and subtitles as defined for the selected country. This is used for countries that don't use the secondary language, but expect a defined language to be used if the primary one isn't available.

Returns:

language id, or ACFG_INVALID_LANG when the value is not defined

U8BIT ACFG_GetEitSearchesPerDay

(

void

)

Returns the number of EIT searches that should be performed per day when the box is in standby.

Returns:

number of times

U8BIT ACFG_GetEitUpdateTime

(

void

)

Returns the number of minutes after which all the events should have been received during an EIT search. This is the EIT repetition time.

Returns:

time in minutes

U8BIT* ACFG_GetEventContentTypes

(

U8BIT

country_id

)

Returns the event content types for the given country. This defines how the content type value broadcast as part of the EIT is to be interpreted.

Parameters:

country_id

country id

Returns:

pointer to the content type array. The index of this array is level_1 from the event content descriptors in the EIT and its elements are of type ADB_EVENT_CONTENT, defined in ap_dbacc.h

U16BIT ACFG_GetFirstUnallocatedLcn

(

U8BIT

country_id

)

Returns the first LCN that should be used when assigning LCNs to services that don't appear in an LCN descriptor, or can't be assigned their desired LCN.

Parameters:

country_id

coutry index

Returns:

LCN; 0 if country isn't valid

U16BIT ACFG_GetLastUnallocatedLcn

(

U8BIT

country_id

)

Returns the last LCN that should be used when assigning LCNs to services that don't appear in an LCN descriptor, or can't be assigned their desired LCN.

Parameters:

country_id

coutry index

Returns:

LCN; 0 if country isn't valid

U16BIT ACFG_GetMaxSatelliteScanFreq

(

U8BIT

country_id

)

Returns the maximum frequency to be used when performing a satellite based frequency scan in the given country.

Parameters:

country_id

country id

Returns:

frequency in MHz; 0 if undefined or country is invalid

U16BIT ACFG_GetMinSatelliteScanFreq

(

U8BIT

country_id

)

Returns the minimum frequency to be used when performing a satellite based frequency scan in the given country.

Parameters:

country_id

country id

Returns:

frequency in MHz; 0 if undefined or country is invalid

U8BIT ACFG_GetNumCountries

(

void

)

Returns the number of country configurations included in the DVB stack.

Returns:

number of countries

U8BIT ACFG_GetNumDbLanguages

(

U8BIT

country_id

)

Returns the number of languages defined for the given country that can be used for audio and subtitles/teletext.

Parameters:

country_id

country index

Returns:

number of available languages

U8BIT ACFG_GetNumRegions

(

U8BIT

country_id

)

Returns the number of regions in the given country.

Parameters:

country_id

country index

Returns:

number of regions

U8BIT ACFG_GetPrimaryAudioLangId

(

void

)

Returns the primary audio language ID.

Returns:

language id

U8BIT ACFG_GetPrimaryTextLangId

(

void

)

Returns the primary DVB subtitle/teletext language ID.

Returns:

language id

U32BIT ACFG_GetPrivateDataSpecifier

(

U8BIT

country_id

)

Returns the private data specifier value for the given country.

Parameters:

country_id

coutry index

Returns:

private data specifier value; 0 if one isn't defined for the country or country id isn't valid

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

Returns the region code that identifies the given region.

Parameters:

country_id	country index
region_id	region index
code_ptr	pointer to value in which the code will be returned

Returns:

TRUE if the country and region indices are valid, FALSE otherwise

U8BIT ACFG_GetRegionId

(

void

)

Returns the internal ID of the region the DVB is configured for.

Returns:

region id

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

Returns an array of pointers to strings containing the region names for the given country index. The index into this array is the region_id. The array is allocated by this function and should be freed using ACFG_ReleaseRegionList.

Parameters:

country_id	country index
str_array_ptr	pointer to an allocated array of static UTF-8 strings
num_regions_ptr	pointer to the number of regions in the returned array

Returns:

TRUE if the country_id is valid

DBTidyFunc ACFG_GetSatelliteDBTidyFunction

(

U8BIT

country_id

)

Returns a pointer to a function that's used to tidy up the database following a DVB-S/S2 scan for the given country.

Returns:

pointer to function, or NULL

AllocLcnFunc ACFG_GetSatelliteLcnFunction

(

U8BIT

country_id

)

Returns a pointer to a function that's used to assign LCNs following a DVB-S/S2 scan for the given country.

Parameters:

country_id

country id

Returns:

pointer to function, or NULL

BOOLEAN ACFG_GetSatelliteScanDvbS2

(

U8BIT

country_id

)

Returns whether DVB-S2 should be included when performing a satellite based frequency scan in the given country.

Parameters:

country_id

country id

Returns:

TRUE if DVB-S2 should be used, FALSE otherwise

U16BIT ACFG_GetSatelliteScanFreqInc

(

U8BIT

country_id

)

Returns the increment frequency to be used when performing a satellite based frequency scan in the given country.

Parameters:

country_id

country id

Returns:

frequency in MHz; 0 if undefined or country is invalid

U8BIT ACFG_GetSatelliteScanNumSymbolRates

(

U8BIT

country_id

)

Returns the number of items in the fixed array of symbol rates to be used when performing a satellite based frequency scan in the given country.

Parameters:

country_id

country id

Returns:

number of symbol rates; 0 if undefined or country is invalid

U16BIT* ACFG_GetSatelliteScanSymbolRates

(

U8BIT

country_id

)

Returns a fixed array of symbol rates to be used when performing a satellite based frequency scan in the given country.

Parameters:

country_id

country id

Returns:

array of symbol rates in Kbps; NULL if undefined or country is invalid

U8BIT ACFG_GetSecondaryAudioLangId

(

void

)

Returns the secondary audio language ID.

Returns:

language id

U8BIT ACFG_GetSecondaryTextLangId

(

void

)

Returns the secondary DVB subtitle/teletext language ID.

Returns:

language id

DBTidyFunc ACFG_GetTerrestrialDBTidyFunction

(

U8BIT

country_id

)

Returns a pointer to a function that's used to tidy up the database following a DVB-T/T2 scan for the given country.

Returns:

pointer to function, or NULL

AllocLcnFunc ACFG_GetTerrestrialLcnFunction

(

U8BIT

country_id

)

Returns a pointer to a function that's used to assign LCNs following a DVB-T/T2 scan for the given country.

Parameters:

country_id

country id

Returns:

pointer to function, or NULL

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

Returns a pointer to the channel table for a terrestrial tuner for the given country.

Parameters:

country_id	country whose table is to be returned
rf_chan_data_ptr	returned pointer to the channel table
num_entries_ptr	number of entries in the returned channel table

Returns:

TRUE if the country is valid and data is returned, FALSE otherwise

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

Get the start and end times of the watershed hours for a country.

Parameters:

country_id	country id
start_time	returns the start time in minutes since midnight
end_time	returns the end time in minutes since midnight

Returns:

TRUE if the start and end times are valid and have been returned, FALSE otherwise

BOOLEAN ACFG_IsNordigCountry

(

void

)

Returns whether the current country requires Nordig compliance for SI.

Returns:

TRUE if Nordig, FALSE otherwise

void ACFG_ReleaseCountryList	(	U8BIT **	str_array,
		U8BIT	num_countries
	)

Frees a country list previously acquired using ACFG_GetCountryList.

Parameters:

str_array	array to be freed
num_countries	number of items in the array

void ACFG_ReleaseDbLangList	(	U8BIT **	str_array,
		U8BIT	num_langs
	)

Frees the language array previously acquired using ACFG_GetDbLangList.

Parameters:

str_array	array of lang names to be freed
num_langs	number of names in the array

void ACFG_ReleaseRegionList	(	U8BIT **	str_array,
		U8BIT	num_regions
	)

Frees the region array previously acquired using ACFG_GetRegionList.

Parameters:

str_array	array to be freed
num_regions	number of items in the array

void ACFG_SetBackgroundSearchTime	(	U16BIT	start_time,
		U16BIT	end_time
	)

Sets the start and end times during which background searches are allowed run when in standby.

Parameters:

start_time	start time in minutes since midnight
end_time	end time in minutes

void ACFG_SetBackgroundServiceSearch

(

BOOLEAN

enabled

)

Enables or disables the background service search when in standby.

Parameters:

enabled

TRUE to enable, FALSE to disable

void ACFG_SetBackgroundSSUSearch

(

BOOLEAN

enabled

)

Enables or disables the background SSU search when in standby.

Parameters:

enabled

TRUE to enable, FALSE to disable

void ACFG_SetCableChannelTable	(	ACFG_CAB_RF_CHANNEL_DATA *	cable_channel_data,
		U16BIT	number_channels
	)

Replaces the cable tuning table for the current country with the one provided.

Parameters:

cable_channel_data	pointer to the new table to point
number_channels	number of entries in the channel table

void ACFG_SetCableLcnFunction	(	U8BIT	country_id,
		AllocLcnFunc	func_ptr
	)

Overrides an existing DVB-C LCN allocation function for the given country.

Parameters:

country_id	country id
pointer	to function, can be NULL if no function is to be called

BOOLEAN ACFG_SetCountry

(

U32BIT

country_code

)

Sets the current country and sets default values for region and language.

Parameters:

country_code

country code, as defined above (see COUNTRY_CODE_* defines)

Returns:

TRUE if country is known, FALSE otherwise

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

Saves the configured country and changes settings related to the country.

Parameters:

country_id	ID of country
region_id	ID of region in country, if appropriate
audio_lang_id	ID of language to be used for audio
sub_lang_id	ID of language to be used for subtitles/teletext

void ACFG_SetPrimaryAudioLangId

(

U8BIT

lang_id

)

Sets the primary language id to be used for audio. This is the language that will be chosen first, if available.

Parameters:

lang_id

language id

void ACFG_SetPrimaryTextLangId

(

U8BIT

lang_id

)

Sets the primary language id to be used for teletext/subtitles.

Parameters:

lang_id

language id

void ACFG_SetSatelliteLcnFunction	(	U8BIT	country_id,
		AllocLcnFunc	func_ptr
	)

Overrides an existing DVB-S/S2 LCN allocation function for the given country.

Parameters:

country_id	country id
pointer	to function, can be NULL if no function is to be called

void ACFG_SetSecondaryAudioLangId

(

U8BIT

lang_id

)

Sets the secondary language id to be used for audio.

Parameters:

lang_id

language id

void ACFG_SetSecondaryTextLangId

(

U8BIT

lang_id

)

Sets the secondary language id to be used for teletext/subtitles.

Parameters:

lang_id

language id

void ACFG_SetTerrestrialLcnFunction	(	U8BIT	country_id,
		AllocLcnFunc	func_ptr
	)

Overrides an existing DVB-T/T2 LCN allocation function for the given country.

Parameters:

country_id	country id
pointer	to function, can be NULL if no function is to be called