dsm_control.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 _DSMAPI_H
#define _DSMAPI_H

#include "siqfuncs.h"
#include "dmxtypes.h"
#include "dsm_types.h"
#include "stdfuncs.h"

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

/* Macro for API backward compatibiliy */
#define obtainSiDirect  controlFlags

/* Following flags to be use in 'controlFlags' */
/* Set GET_PMT_DIRECT_FROM_HW_FLAG when DSMCC should get PMT data from hardware,
 * rather than notifications from DVB stack using STB_SIRegisterPmtObserver */
#define GET_PMT_DIRECT_FROM_HW_FLAG    (1 << 0)

/* Set DISABLE_AUTO_CACHING_FLAG when DSMCC should not automaticaaly download
 * and cache data blocks of DSMCC modules */
#define DISABLE_AUTO_CACHING_FLAG      (2 << 0)

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

/*---Global type defs for public use-------------------------------------------*/


typedef void (*F_CarouselLoad)( H_ObjCarousel hOC, E_OCLoadStatus result, U32BIT carouselId );


typedef struct s_DsmccConfig
{
   /* DSMCC task priority value - passed to STB_OSCreateTask
    * The specified task priority value is used by the DSMCC task
    */
   U32BIT taskPriority;

   /* Size of internal section buffers memory pool in 4096 byte blocks. This is
    * used to provide data directly to DSM-CC instance. The task priority has a
    * direct influence over section buffer size. Lower task priority means larger
    * buffer pool requirements.
    * Minimum value: 100  (400 Kbytes)
    * Recommended:   200
    */
   U8BIT sectionBuffPoolSize;

   /* Size of section buffer manager cache in 64K byte blocks. This is separate
    * to sectionBuffPoolSize and this memory is used to store section data not
    * immediately required by DSM-CC instance. This facilitates faster DSM-CC file
    * loading - particularly when the number of hardware section filters is limited.
    * Minimum value: 0
    * Suggested value: 16
    */
   U8BIT sectionBuffCacheSize;

   /* It is manditory to set memAlloc and memFree */
   F_MemAlloc memAlloc;
   F_MemFree memFree;

   /* parsePmtDone is optional and may be set to NULL */
   F_PmtParseInit parsePmtInit;

   /* It is manditory to set at least one of the following
   * either parseDataBroadcastId or parseSsuSelectorBytes */
   F_ParseDataBcastId parseDataBroadcastId;
   F_ParseSsuSelectorBytes parseSsuSelectorBytes;

   /* parsePmtDone is optional and may be set to NULL */
   F_PmtParseDone parsePmtDone;

   /* It is manditory to set either 'carouselLoad' or the four functions in 'F_SsuConfig' */
   F_CarouselLoad carouselLoad;
   S_SsuConfig ssuFuncs;

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

   U32BIT controlFlags;
} S_DsmccConfig;


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

H_DsmControl DSMCC_Open( S_DsmccConfig *config );

void DSMCC_Close( H_DsmControl instance );

BOOLEAN DSMCC_Start( H_DsmControl instance, S_DvbLocator *locator,
   U32BIT boot_carousel_id, DMXREF dmxref );

void DSMCC_SetTunedTransportInfo( H_DsmControl instance, U16BIT onet_id,
   U16BIT tran_id, DMXREF dmxref );

BOOLEAN DSMCC_StartFs( H_DsmControl instance, U16BIT service_id, U32BIT carousel_id );

BOOLEAN DSMCC_StartSsu( H_DsmControl instance, U16BIT service_id, U32BIT oui );

BOOLEAN DSMCC_StartSsuWithPid( H_DsmControl instance, U16BIT pid, U32BIT oui );

void DSMCC_Stop( H_DsmControl instance, E_DsmRstMode mode );

void DSMCC_Reboot( H_DsmControl instance );

H_ObjCarousel DSMCC_CurrentCarousel( H_DsmControl dsmctrl );

U32BIT DSMCC_CurrentCarouselId( H_DsmControl dsmctrl );

BOOLEAN DSMCC_SetCurrentCarousel(H_DsmControl dsmctrl, H_ObjCarousel hOC);

void DSMCC_UnloadCarousel(H_DsmControl dsmctrl, H_ObjCarousel hOC, E_DsmRstMode mode);

void DSMCC_SiqCacheClearPmt( H_DsmControl dsmctrl, U16BIT serviceId );

const char* DSMCC_VersionString(void);

H_DsmControl DSMCC_FindInstance( U16BIT serviceId, DMXREF dmxref  );

void DSMCC_SetFileSystemCacheLimit( H_DsmControl dsmctrl, U32BIT cacheSize );

void DSMCC_SsuUnloadModule( H_DsmControl dsmctrl, H_DsmCarousel hCarousel,
   U32BIT moduleRef );


#endif /*_DSMAPI_H */