ap_si.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_SI_H
#define _AP_SI_H

#include "techtype.h"
#include "stbsiflt.h"
#include "stbsitab.h"

/* quality and strength are on a scale 0 to 10 */
#define GET_SIGNAL_STATUS(quality, strength) (((quality) & 0x0a) << 4 | ((strength) & 0x0a))
#define BAD_SIGNAL_STATUS 0xff

#define GET_SIGNAL_QUALITY(status) ((status) >> 4)
#define GET_SIGNAL_STRENGTH(status) ((status) & 0x0f)

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

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

typedef enum
{
   APP_SI_MODE_NO_SI,
   APP_SI_MODE_CHANNEL_SEARCH,            // use STB_DPSetSearchMode(0, TRUE);
   APP_SI_MODE_CHANNEL_SEARCH_NO_NIT,     // use STB_DPSetSearchMode(0, TRUE);
   APP_SI_MODE_STARTUP_SEARCH,            // use STB_DPSetSearchMode(0, TRUE);
   APP_SI_MODE_EVENT_SCHED_SEARCH,        // use STB_DPSetSearchMode(0, TRUE);
   APP_SI_MODE_DVB_SSU_SEARCH,            // use STB_DPSetSearchMode(0, TRUE);
   APP_SI_MODE_UPDATE,                    // use STB_DPSetSearchMode(0, FALSE);
   APP_SI_MODE_CIPLUS_UPDATE,             // use STB_DPSetSearchMode(0, FALSE);
   APP_SI_MODE_CIPLUS_NO_PAT_PMT,         // use STB_DPSetSearchMode(0, FALSE);
   APP_SI_MODE_TOT_SEARCH,                // use STB_DPSetSearchMode(0, TRUE);
   APP_SI_MODE_USER_DEFINED
} E_APP_SI_MODE;

typedef enum
{
   SEARCH_SERVICE_TYPE_ADVANCED_CODEC = 0x0001,    /* Advanced codec services - H264, AC-3, AAC, etc */
   SEARCH_SERVICE_TYPE_HD = 0x0002,                /* Services defined as HD, including MPEG2 HD */
   SEARCH_SERVICE_TYPE_HEVC = 0x0004,              /* HEVC codec services */

   SEARCH_SERVICE_TYPE_FREE_TO_AIR = 0x4000,
   SEARCH_SERVICE_TYPE_ENCRYPTED = 0x8000,

   SEARCH_SERVICE_TYPE_FTA = (SEARCH_SERVICE_TYPE_FREE_TO_AIR | 0x3fff),
   SEARCH_SERVICE_TYPE_SCRAMBLED = (SEARCH_SERVICE_TYPE_ENCRYPTED | 0x3fff),
   SEARCH_SERVICE_TYPE_ALL = 0xffff
} E_SEARCH_SERVICE_TYPE;

typedef enum
{
   UPDATE_MODE_DEFAULT,
   UPDATE_MODE_AUTOMATIC
} E_SERVICE_UPDATE_MODE;

typedef enum
{
   SORT_ADD_TO_END,
   SORT_ADD_TO_BEGINNING,
   SORT_BY_LCN,
} E_SORT_ORDER;

/* Events passed to SI managers */
typedef enum
{
   APP_SI_START_MANAGER = 0x0001,
   APP_SI_STOP_MANAGER = 0x0002,
   APP_SI_CHANNEL_CHANGE = 0x0003,

   APP_SI_PAT_RECEIVED = 0x0011,
   APP_SI_PMT_RECEIVED = 0x0012,
   APP_SI_SDT_RECEIVED = 0x0013,
   APP_SI_NIT_RECEIVED = 0x0014,
   APP_SI_EIT_RECEIVED = 0x0015,
   APP_SI_TOT_RECEIVED = 0x0016,
   APP_SI_TDT_RECEIVED = 0x0017,
   APP_SI_CAT_RECEIVED = 0x0018,
   APP_SI_RCT_RECEIVED = 0x0019,
   APP_SI_AIT_RECEIVED = 0x001A,
   APP_SI_BAT_RECEIVED = 0x0020,

   APP_SI_PAT_TIMEOUT = 0x0031,
   APP_SI_PMT_TIMEOUT = 0x0032,
   APP_SI_SDT_TIMEOUT = 0x0033,
   APP_SI_NIT_TIMEOUT = 0x0034,
   APP_SI_EIT_TIMEOUT = 0x0035,
   APP_SI_TOT_TIMEOUT = 0x0036,
   APP_SI_TDT_TIMEOUT = 0x0037,
   APP_SI_CAT_TIMEOUT = 0x0038,
   APP_SI_SCHED_TIMEOUT = 0x0039,
   APP_SI_BAT_TIMEOUT = 0x0040,

   APP_SI_PMT_UPDATE = 0x0051,
   APP_SI_UPDATE_DELAY_EXPIRED = 0x0052,
   APP_SI_STOP_PMT_REPORTING = 0x0053,

   APP_SI_USER_DEFINED_EVENT = 0x0100
} E_APP_SI_EVENT_CODE;

typedef enum {
   APP_SI_EIT_JOURNAL_TYPE_CLEAR,
   APP_SI_EIT_JOURNAL_TYPE_ADD,
   APP_SI_EIT_JOURNAL_TYPE_DELETE,
   APP_SI_EIT_JOURNAL_TYPE_UPDATE,
   APP_SI_EIT_JOURNAL_TYPE_EXPIRE
} E_APP_SI_EIT_JOURNAL_TYPE;

typedef struct s_app_si_eit_journal
{
   E_APP_SI_EIT_JOURNAL_TYPE type;
   U16BIT orig_net_id;
   U16BIT tran_id;
   U16BIT serv_id;
   U16BIT allocated_lcn;
   BOOLEAN is_sched;
   U16BIT event_id;
} S_APP_SI_EIT_SCHED_UPDATE;


//---Global type defs for public use-------------------------------------------
typedef BOOLEAN (*F_SIManager)(U8BIT, U32BIT, SI_TABLE_RECORD *);   /* Type of SI manager function */
typedef void (*F_EitParser)(U8BIT, U8BIT, U8BIT *, U32BIT, void *);
typedef void (*F_BatTableUpdate)(U8BIT, SI_BAT_TABLE *, SI_TABLE_RECORD *);
typedef void (*F_EitTableUpdate)(U8BIT, SI_TABLE_RECORD *);
typedef void (*F_NitTableUpdate)(U8BIT, SI_NIT_TABLE *, SI_TABLE_RECORD *);
typedef void (*F_PmtTableUpdate)(U8BIT, SI_PMT_TABLE *, SI_TABLE_RECORD *, void *);
typedef void (*F_SdtTableUpdate)(U8BIT, SI_SDT_TABLE *, SI_TABLE_RECORD *);

typedef void (*F_EitSchedUpdateCB)(S_APP_SI_EIT_SCHED_UPDATE *update);


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

BOOLEAN ASI_CheckForServiceChange(void);

void ASI_SetSearchServiceType(E_SEARCH_SERVICE_TYPE service_type);

void ASI_SetServiceUpdateMode(E_SERVICE_UPDATE_MODE update_mode, E_SORT_ORDER sort_order);

void ASI_AddServiceToPmtList(U16BIT service_id);

void ASI_RemoveServiceFromPmtList(U16BIT service_id);

void ASI_ClearPmtList(void);

void ASI_ProcessPmt(U8BIT path, void *s_ptr, U8BIT *pmt_data);

void ASI_SetEITScheduleLimit(U16BIT limit_hours);

U16BIT ASI_GetEITScheduleLimit(void);

void ASI_EnableBatCollection(BOOLEAN use_bats, U16BIT *bouquet_ids, U16BIT num_ids);

void* ASI_GetNextOTALocation(void *network, void *prev_location, U16BIT *onid_ptr,
   U16BIT *tid_ptr, U16BIT *sid_ptr);

void ASI_RefuseSSU(BOOLEAN refuse);

BOOLEAN ASI_SSURefused(void);

void ASI_SSUSetMandatory(BOOLEAN mandatory);

BOOLEAN ASI_SSUGetMandatory(void);


//---Global Function prototypes for internal use---------------------------------
void ASI_InitialiseAppSi(void);

void ASI_SetAppSiMode(U8BIT path, E_APP_SI_MODE si_mode);

U16BIT ASI_GetPmtPid(U16BIT serv_id, U16BIT ts_id, U16BIT on_id);

void ASI_StopPmtReporting(U8BIT path);

BOOLEAN ASI_PmtReported(U8BIT path);

void ASI_SetStandbyState(BOOLEAN standby_state);

void ASI_RestartCatFilter(U8BIT path);

void ASI_RestartNitFilter(U8BIT path);

void ASI_RestartSdtFilter(U8BIT path);

void ASI_RestartBatFilter(U8BIT path);

void ASI_RestartTotFilter(U8BIT path);

void ASI_RestartTdtFilter(U8BIT path);

void ASI_RestartSITables(U8BIT path, BOOLEAN use_standard_pids);

void ASI_SetEITParserFunction(F_EitParser parser_func);

void ASI_SetUpdateBatFunction(F_BatTableUpdate update_func);

void ASI_SetUpdateEitFunction(F_EitTableUpdate update_func);

void ASI_SetUpdateNitFunction(F_NitTableUpdate update_func);

void ASI_SetUpdatePmtFunction(F_PmtTableUpdate update_func);

void ASI_SetUpdateSdtFunction(F_SdtTableUpdate update_func);

void ASI_ProcessEitTable(SI_TABLE_RECORD *table_rec, BOOLEAN playback);

void ASI_RegisterEitSchedUpdateCallback(F_EitSchedUpdateCB sched_update_callback);

void ASI_NotifyEitSchedUpdate(void *serv_ptr, U16BIT event_id, E_APP_SI_EIT_JOURNAL_TYPE type);

void ASI_ProcessTotTable(SI_TABLE_RECORD *table_rec);

void ASI_ProcessTdtTable(SI_TABLE_RECORD *table_rec);

#endif