source/dscore/src/sectionFilter.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
 * Copyright © 2001 Koninklijke Philips Electronics N.V
 *
 * 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 _SECTIONFILTER_H_
#define _SECTIONFILTER_H_


/*--------------------------------  Includes  --------------------------------*/

#include "clDsmSystem.h"


#ifdef __cplusplus
extern "C" {
#endif


/*-----------------------------  Exported Macros  ----------------------------*/

#define SF_MAGIC    0xE5D072A3


/*------------------------------  Exported Types  ----------------------------*/

/* -- Internal section filter types */

typedef enum {
    SFK_NONE = 0,
    SFK_DSI,
    SFK_DII,
    SFK_DII_NEXT,
    SFK_DDB,
    SFK_STREAM_DESCR
} SectionFilterKind_t, *pSectionFilterKind_t;


typedef enum {
    SFA_INITIAL = 0,
    SFA_PENDING,
    SFA_COMMITTED,
    SFA_ABORTED
} SfAddStatus_t, *pSfAddStatus_t;


typedef struct _SectionFilterInfo_t SectionFilterInfo_t, *pSectionFilterInfo_t;

struct _SectionFilterInfo_t
{
   clDsmSFilter_t          filter;

   U32BIT                  handle;

   SectionFilterKind_t     targetKind;

   SfAddStatus_t           status;

   /* -- Handle of relevant OC */
   /* -- NB. Duplicate of target handle when targetKind is SFK_DSI */
   pObjectCarousel_t   pObjCarousel;

   U16BIT      serviceId;

   /* -- carouselId, moduleId or transactionId */
   U32BIT      targetId;

   /* -- hObjectCarousel, hModule or hDataCarousel */
   MemHandle   hTarget;

   /* -- Timer management */
   clDsmTimerManagement_t  tms;

   pSectionFilterInfo_t nextBlock;

   /* -- Following fields are never required simultaneously */
   union {
     MemHandle  hPendingSiQueryRef; /* -- Use when SFA_PENDING */
     void*      filterHandle;       /* -- Use when SFA_COMMITTED */
   } u;
};


/*------------------------------  Exported Data  -----------------------------*/


/*---------------------------  Exported Prototypes  --------------------------*/

clDsmErr_t createSectionFilterHeap( pclDsmInstData_t idp,
    /*O*/ void* *pSectionFilterHeap, U32BIT *pHeapSize );

void resetSectionFilterHeap( pclDsmInstData_t idp );

clDsmErr_t sectionFilterStart( pclDsmInstData_t idp, pObjectCarousel_t pOC,
    /*I*/ SectionFilterKind_t sfKind, MemHandle hSfTarget,
          clDsmSFPriority_t sfPriority, U16BIT service_id,
    /*O*/ pSectionFilterInfo_t *pSectionFilter );

clDsmErr_t sectionFilterUpdatePriority( pclDsmInstData_t idp,
    /*I*/ pSectionFilterInfo_t pSF, clDsmSFPriority_t newSfPriority,
          BOOLEAN latchHighest );

clDsmErr_t sectionFilterCommit( pclDsmInstData_t idp,
    /*I*/ pSectionFilterInfo_t pSectionFilter );

void sectionFilterStop( pclDsmInstData_t idp,
    /*IO*/ pSectionFilterInfo_t *pSectionFilter );

void sectionFilterAbortDependants( pclDsmInstData_t idp,
    /*I*/ pSectionFilterInfo_t pSectionFilter );

pSectionFilterInfo_t sectionFilterRetrieve( pclDsmInstData_t idp, U32BIT handle );

/*----------------------------------------------------------------------------*/

#ifdef __cplusplus
}
#endif
#endif /* _SECTIONFILTER_H_ */