dba.h

Go to the documentation of this file.

/*******************************************************************************
 * Copyright © 2014 The DTVKit Open Software Foundation Ltd (www.dtvkit.org)
 * Copyright © 2013 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 _DBA_H
#define _DBA_H
 
#include "techtype.h"
 
//---Constant and macro definitions for public use-----------------------------
 
/* Field IDs MUST be unique but need not be contiguous within records range 0x0000 to 0xffff
 * some fields are used in more than one record spare IDs are left for future expansion. */
 
/* Fields common to more than one record type */
#define DBA_FIELD_PARENT                        0x0100
#define DBA_FIELD_REC_NAME                      0x0101
#define DBA_FIELD_ORIG_NET_ID                   0x0102
#define DBA_FIELD_NET_ID                        0x0103
#define DBA_FIELD_TRANSPORT_ID                  0x0104
#define DBA_FIELD_SERVICE_ID                    0x0105
#define DBA_FIELD_VERSION                       0x0106
#define DBA_FIELD_URL                           0x0107
 
/* Fields in LNB records */
#define DBA_FIELD_LNB_TYPE                      0x0202
#define DBA_FIELD_LNB_22K                       0x0203
#define DBA_FIELD_LNB_12V                       0x0204
#define DBA_FIELD_LNB_PULSEPOSN                 0x0205
#define DBA_FIELD_LNB_DISPOSN                   0x0206
#define DBA_FIELD_LNB_DISTONE                   0x0207
#define DBA_FIELD_LNB_DISCSWITCH                0x0208
#define DBA_FIELD_LNB_DISUSWITCH                0x0209
#define DBA_FIELD_LNB_DISSMATV                  0x020a
#define DBA_FIELD_LNB_DISREPEAT                 0x020b
#define DBA_FIELD_LNB_UNICABLEFREQ              0x020c
#define DBA_FIELD_LNB_UNICABLECHAN              0x020d
#define DBA_FIELD_LNB_POWER                     0x020e
#define DBA_FIELD_LNB_NAME                      0x020f
 
/* Fields in satellite records */
#define DBA_FIELD_SAT_DISH                      0x0300
#define DBA_FIELD_SAT_LONGWE                    0x0301
#define DBA_FIELD_SAT_LONGPOS                   0x0302
 
/* Fields in network records */
#define DBA_FIELD_PROFILE_TYPE                  0x0401
#define DBA_FIELD_PROFILE_CAM_ID                0x0402
#define DBA_FIELD_PROFILE_NAME                  0x0403
#define DBA_FIELD_OPERATOR_SEARCH               0x0404
#define DBA_FIELD_OP_SEARCH_DATE                0x0405
#define DBA_FIELD_OP_SEARCH_TIME                0x0406
 
/* Fields common to transport records */
#define DBA_FIELD_TRAN_FREQ                     0x0500
#define DBA_FIELD_TRAN_SRATE                    0x0501
#define DBA_FIELD_TRAN_SIGNAL_STRENGTH          0x0502
#define DBA_FIELD_TRAN_SIGNAL_QUALITY           0x0503
 
/* Fields in satellite transport records */
#define DBA_FIELD_STRAN_POL                     0x0600
#define DBA_FIELD_STRAN_FEC                     0x0601
#define DBA_FIELD_STRAN_DVBS2                   0x0602
#define DBA_FIELD_STRAN_MODULATION              0x0603
 
/* Fields in terrestrial transport records */
#define DBA_FIELD_TTRAN_MODE                    0x0700
#define DBA_FIELD_TTRAN_TERR_TYPE               0x0701
#define DBA_FIELD_TTRAN_PLP_ID                  0x0702
#define DBA_FIELD_TTRAN_BWIDTH                  0x0703
 
/* Fields in cable transport records */
#define DBA_FIELD_CTRAN_MODE                    0x0800
 
/* Fields common to service records */
#define DBA_FIELD_SERV_ID                       0x0900
#define DBA_FIELD_SERV_TYPE                     0x0901
#define DBA_FIELD_SERV_LCN                      0x0902
#define DBA_FIELD_SERV_REQ_LCN                  0x0903
#define DBA_FIELD_SERV_HIDDEN                   0x0904
#define DBA_FIELD_SERV_SELECTABLE               0x0905
#define DBA_FIELD_SERV_LOCKED                   0x0906
#define DBA_FIELD_SERV_SCHED_DISABLED           0x0907
#define DBA_FIELD_SERV_NOWNEXT_DISABLED         0x0908
#define DBA_FIELD_SERV_FAV_GROUPS               0x0909
#define DBA_FIELD_SERV_FREESAT_ID               0x090a
#define DBA_FIELD_SERV_REGION_ID                0x090b
#define DBA_FIELD_SERV_LCN_EDITABLE             0x090c
#define DBA_FIELD_SERV_DELETED                  0x090d
#define DBA_FIELD_SERV_PORT                     0x090e
#define DBA_FIELD_SERV_FEC_LAYER                0x090f
#define DBA_FIELD_SERV_FEC_PORT1                0x0910
#define DBA_FIELD_SERV_FEC_PORT2                0x0911
 
/* Fields in timer records */
#define DBA_FIELD_TIMER_HANDLE                  0x0a00
#define DBA_FIELD_TIMER_STARTTIME               0x0a01
#define DBA_FIELD_TIMER_DURATION                0x0a02
#define DBA_FIELD_TIMER_TYPE                    0x0a03
#define DBA_FIELD_TIMER_FREQUENCY               0x0a04
#define DBA_FIELD_TIMER_RAMPVOLUME              0x0a05
#define DBA_FIELD_TIMER_EVENTID                 0x0a06
#define DBA_FIELD_TIMER_NOTIFY_TIME             0x0a07
#define DBA_FIELD_TIMER_CRID                    0x0a08
#define DBA_FIELD_TIMER_DISKID                  0x0a09
#define DBA_FIELD_TIMER_OTHERCRID               0x0a0a
#define DBA_FIELD_TIMER_MISSED                  0x0a0b
#define DBA_FIELD_TIMER_EVENT_TRIGGERED         0x0a0c
#define DBA_FIELD_TIMER_ADDITIONAL_INFO         0x0a0d
#define DBA_FIELD_TIMER_START_PADDING           0x0a0e
#define DBA_FIELD_TIMER_END_PADDING             0x0a0f
#define DBA_FIELD_TIMER_DO_NOT_DELETE           0x0a10
 
/* Fields in CRID records */
#define DBA_FIELD_CRID_EIT_DATE                 0x0b00
#define DBA_FIELD_CRID_SERIES                   0x0b01
#define DBA_FIELD_CRID_RECOMMENDED              0x0b02
#define DBA_FIELD_CRID_DO_NOT_DELETE            0x0b03
 
/* Fields in favourite lists and favourite services */
#define DBA_FIELD_FAVLIST_ID                    0x0c00
#define DBA_FIELD_FAVLIST_INDEX                 0x0c01
#define DBA_FIELD_FAVLIST_USER_DATA             0x0c02
 
/* Fields used to store event information */
#define DBA_FIELD_EVENT_STARTTIME               0x0d00
#define DBA_FIELD_EVENT_DURATION                0x0d01
#define DBA_FIELD_EVENT_ID                      0x0d02
#define DBA_FIELD_EVENT_CONTENT                 0x0d03
#define DBA_FIELD_EVENT_AGE_RATING              0x0d04
#define DBA_FIELD_EVENT_SCRAMBLED               0x0d05
#define DBA_FIELD_EVENT_SUBTITLES               0x0d06
#define DBA_FIELD_EVENT_AUDIO_DESC              0x0d07
#define DBA_FIELD_EVENT_FREE_TO_AIR             0x0d08
#define DBA_FIELD_EVENT_DO_NOT_SCRAMBLE         0x0d09
#define DBA_FIELD_EVENT_NAME                    0x0d0a
#define DBA_FIELD_EVENT_DESCRIPTION             0x0d0b
#define DBA_FIELD_EVENT_EXTENDED_DESC           0x0d0c
#define DBA_FIELD_EVENT_GUIDANCE                0x0d0d
#define DBA_FIELD_EVENT_CONTENT_DATA            0x0d0e
 
/* Fields in LNB band records */
#define DBA_FIELD_BAND_POLARITY                 0x0e00
#define DBA_FIELD_BAND_MIN_FREQUENCY            0x0e01
#define DBA_FIELD_BAND_MAX_FREQUENCY            0x0e02
#define DBA_FIELD_BAND_LOCAL_OSC_FREQUENCY      0x0e03
#define DBA_FIELD_BAND_LNB_VOLTAGE              0x0e04
#define DBA_FIELD_BAND_22_KHZ                   0x0e05
 
 
//---Enumerations for public use-----------------------------------------------
 
/* Set of record types supported by the database, though not all types may be supported
 * by all database implementations */
typedef enum
{
   DBA_RECORD_LNB = 0,
   DBA_RECORD_SATELLITE,
   DBA_RECORD_NETWORK,
   DBA_RECORD_SAT_TRANSPORT,
   DBA_RECORD_TERR_TRANSPORT,
   DBA_RECORD_CAB_TRANSPORT,
   DBA_RECORD_SERVICE,
   DBA_RECORD_TIMER,
   DBA_RECORD_CRID,
   DBA_RECORD_FAV_LIST,
   DBA_RECORD_FAV_SERV,
   DBA_RECORD_LNB_BAND,
   DBA_RECORD_CICAM_TIMER,
   DBA_RECORD_IP_TRANSPORT,
   /*DBA_RECORD_EVENT,*/
   DBA_NUM_RECORDS               /* This must be the last value in the enum */
} E_DBA_RECORDS;
 
 
//---Global type defs for public use-------------------------------------------
 
//---Global Function prototypes for public use---------------------------------
 
BOOLEAN DBA_Initialise(void);
 
void DBA_Terminate(void);
 
BOOLEAN DBA_LoadDatabase(U8BIT *pathname);
 
BOOLEAN DBA_SaveDatabase(void);
 
BOOLEAN DBA_ClearDatabase(void);
 
BOOLEAN DBA_BackupDatabase(U8BIT *pathname);
 
BOOLEAN DBA_CanRestoreDatabase(void);
 
BOOLEAN DBA_RestoreDatabase(void);
 
void DBA_EraseBackupDatabase(void);
 
BOOLEAN DBA_ExportToXML(U8BIT *xml_pathname);
 
BOOLEAN DBA_ImportFromXML(U8BIT *xml_pathname);
 
void DBA_LockDatabase(void);
 
void DBA_UnlockDatabase(void);
 
U8BIT* DBA_DatabaseVersion(void);
 
U32BIT DBA_DatabaseFileSize(U32BIT *max_size);
 
void* DBA_CreateRecord(U32BIT record_id, void *parent);
 
void DBA_DestroyRecord(void *record);
 
void* DBA_FindRecord(U32BIT record_id, void *parent, void *last_rec);
 
void DBA_SetRecordParent(void *record, void *parent);
 
void* DBA_GetRecordParent(void *record);
 
void DBA_SaveRecord(void *record);
 
BOOLEAN DBA_SetFieldValue(void *record, U32BIT field_id, U32BIT value);
 
BOOLEAN DBA_SetFieldString(void *record, U32BIT field_id, U8BIT *string, U16BIT num_bytes);
 
BOOLEAN DBA_SetFieldLangString(void *record, U32BIT field_id, U32BIT lang_code, U8BIT *string,
   U16BIT num_bytes);
 
BOOLEAN DBA_SetFieldData(void *record, U32BIT field_id, U8BIT *data, U16BIT num_bytes);
 
BOOLEAN DBA_GetFieldValue(void *record, U32BIT field_id, U32BIT *value);
 
BOOLEAN DBA_GetFieldString(void *record, U32BIT field_id, U8BIT **string, U16BIT *num_bytes);
 
BOOLEAN DBA_GetFieldLangString(void *record, U32BIT field_id, U32BIT lang_code, U8BIT **string,
   U16BIT *num_bytes);
 
BOOLEAN DBA_GetFieldData(void *record, U32BIT field_id, U8BIT **data, U16BIT *num_bytes);
 
U32BIT DBA_DataBlockSize(U32BIT data_block_id);
 
U32BIT DBA_DataBlockRead(U32BIT data_block_id, U8BIT *data, U32BIT max_num_bytes);
 
BOOLEAN DBA_DataBlockWrite(U32BIT data_block_id, U8BIT *data, U32BIT num_bytes);
 
#endif /* _DBA_H */