source/dsiq/inc/dsiq.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
 *******************************************************************************/
#ifndef _DSIQ_H_
#define _DSIQ_H_

#include "cldsmtypes.h"
#include "dmxtypes.h"
#include "stdfuncs.h"
#include "siqfuncs.h"
#include "dsm_debug.h"

#define UNKNOWN_AIT_TYPE   0x7FFF
#define UNKNOWN_AIT_VERS   0x7F

typedef enum {
   SIQ_ERROR,
   SIQ_IGNORE,
   SIQ_UPDATE
} E_SIQ_STATUS;

/*------------------- Functions supplied to SIQ at setup ---------------------*/

typedef int (*F_DvpRequestPmt)( void* pmtref, U16BIT serviceId, U16BIT pmtpid );

typedef void (*F_DvpCancelPmt)( void* pmtref, U16BIT serviceId );


/*---------------- Setup structure for SIQ initialisation --------------------*/

typedef struct
{
   /* First five functions here are manditory */
   F_MemAlloc           memAlloc;
   F_MemFree            memFree;

   F_DvpRequestPmt      dvpRequestPmt;
   F_DvpCancelPmt       dvpCancelPmt;
   void*                pmtref;

   F_PmtParseInit       parsePmtInit;
   F_ParseDataBcastId   parseDataBroadcastId;
   F_PmtParseDone       parsePmtDone;

   /* notifyAitInfo is optional and may be set to NULL */
   F_NotifyAitInfo      notifyAitInfo;

   /* errPrintf and dbgPrintf functions are only used in a debug build.
    * These are optional and may be set to NULL */
   F_Printf             errPrintf;
   F_Printf             dbgPrintf;

   /* dbgState controls type of debug output for dbgPrintf
    * For valid debug filter states see above */
   U32BIT               dbgState;

} S_SiqSetup;


typedef struct s_SiqCachePat  *H_SiqCachePat;
typedef struct s_SiqCachePmt  *H_SiqCachePmt;
typedef struct s_SiqPmtTable  *H_SiqPmtTable;

/*----------------------- Functions that configure SIQ -----------------------*/

H_SiqInstance SIQ_CreateInstance( S_SiqSetup* pSetup );

void SIQ_DestroyInstance( H_SiqInstance siq );

void SIQ_SetDebugConfig( H_SiqInstance siq,  F_Printf errPrintf,
                         F_Printf dbgPrintf, U32BIT dbgState );

void SIQ_SetDebugState( H_SiqInstance siq, U32BIT dbgState );

void SIQ_SetDsmInstance( H_SiqInstance siq, clDsmInstHandle_t dsm );


/*------------------ Functions that update SIQ from DVB ----------------------*/

void SIQ_UpdatePat( H_SiqInstance siq, U8BIT* dptr );

void SIQ_TransportChanged( H_SiqInstance siq, U16BIT origNetworkId, U16BIT transportId );

E_SIQ_STATUS SIQ_RequirePmt( H_SiqInstance siq, U8BIT *pmt,
   U16BIT *pSid, U8BIT *pVer );

void SIQ_ServiceRemoved( H_SiqInstance siq, U16BIT serviceId );

H_SiqPmtTable SIQ_ParsePmt( H_SiqInstance siq, U8BIT *pmt );

void SIQ_ProcessPmt( H_SiqInstance siq, H_SiqPmtTable hNewTable,
   U16BIT serviceId, U8BIT version );

void SIQ_CacheClearPmt( H_SiqInstance siq, U16BIT serviceId );


/*----------------- Functions provided to DSM-CC component -------------------*/

clDsmErr_t SIQ_RequestQueryStart( H_SiqInstance siq, pclDsmSIQuery_t pQuery,
   clDsmSIQueryRef_t clDsmSIQueryRef, void* clDsmSIUserData,
   clDsmSIQueryResult_t *pResult );

void SIQ_RequestQueryStop(  H_SiqInstance siq,
   void* queryHandle, clDsmSIQueryRef_t clDsmSIQueryRef );

clDsmErr_t SIQ_ServiceInfoChangeSubscribe( H_SiqInstance siq, U16BIT serviceId );

void SIQ_ServiceInfoChangeUnsubscribe( H_SiqInstance siq, U16BIT serviceId );

#endif /*_DSIQ_H_*/