siqfuncs.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
 *******************************************************************************/
#ifndef _SIQFUNCS_H
#define _SIQFUNCS_H

typedef void*  H_PmtRef;

/*!****************************************************************************
 * @brief   Inform the DSM-CC client that parsing of PMT data is about to start
 *          The return value is passed to subsequent PMT parsing call back
 *          functions: i.e. F_ParseDataBcastId and F_PmtParseDone
 * @param   U16BIT     serviceId    Service id of the PMT
 * @return  H_PmtRef  - handle or user data of client
 ******************************************************************************/
typedef H_PmtRef (*F_PmtParseInit)( U16BIT serviceId );

/*!****************************************************************************
 * @brief   Parse data broadcast id descriptor for recognised application(s)
 *          SIQ wants to know whether this PMT stream can be used to launch
 *          a DSM-CC boot carousel. When there is more than one choice, SIQ
 *          chooses the PMT stream that had the highest preference value
 *          returned by this function.
 *          Note that this may be called multiple times for a PMT stream,
 *          and always called from within SIQ_ProcessPmt().
 *          Service ID and carousel ID are provided for convenience and are
 *          not required for a basic implementation of this function.
 * @param   H_PmtRef   pmtref       reference supplied by F_PmtParseInit
 * @param   U32BIT     carouselId   Carousel associated with this descriptor
 * @param   U8BIT*     dbcPtr       Pointer to data broadcast id descriptor
 * @param   U8BIT      dbcLen       Length of data broadcast id descriptor
 * @return  U32BIT - Preference value for this data broadcast id and
 *          associated application type. Zero means that data broadcast id or
 *          application type is not recognised, and SIQ will ignore it.
 ******************************************************************************/
typedef U32BIT (*F_ParseDataBcastId)( H_PmtRef pmtref, U32BIT carouselId,
                                      U8BIT* dbcPtr, U8BIT dbcLen );

/*!****************************************************************************
 * @brief   Inform the DSM-CC client that parsing of PMT data has completed
 * @param   H_PmtRef pmtref reference supplied by F_PmtParseInit
 * @return  void
 ******************************************************************************/
typedef void (*F_PmtParseDone)( H_PmtRef pmtref );

/*!****************************************************************************
 * @brief   Callback to inform of first or changed AIT info in PMT
 * @param   U16BIT     serviceId    Service id.
 * @param   U16BIT     type         Type of AIT application
 * @param   U16BIT     pid          PID containing AIT
 * @param   U8BIT      version      Current AIT version
 * @return  void
 ******************************************************************************/
typedef void (*F_NotifyAitInfo)( U16BIT serviceId, U16BIT appType,
                                 U16BIT pid, U8BIT version );

#endif //_SIQFUNCS_H