source/dscore/src/module.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 _MODULE_H_
#define _MODULE_H_


/*--------------------------------  Includes  --------------------------------*/
#include "clDsmSystem.h"

#include "linkList.h"
#include "sectionFilter.h"

#ifdef __cplusplus
extern "C" {
#endif


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


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

/* -- NB. This is only here to allow debug checking of size from clDsmMain */
typedef struct {
    U16BIT    numBlocks;
    U16BIT    blocksRqd;
    U32BIT    downloadSize;
    U16BIT    blockSize;
    U8BIT     blockRcvdRegister[(MAX_BLOCKS_IN_MODULE + 7)/8]; /* -- round up */
    MemHandle hModuleData;
} ModuleBuilder_t, *pModuleBuilder_t;


typedef enum {
    MS_INITIAL,         /* -- transient state */
    MS_PENDING_INFO,    /* -- waiting for DII info */
    MS_PENDING_DDB,     /* -- DII info available, waiting for first DDB */
    MS_BUILDING,        /* -- first DDB received */
    MS_CACHED,          /* -- module complete (compressed or decompressed) */
    MS_ACQ_FAILED,      /* -- acquisition failed due to decompress failure
                           -- (transient state)*/
    MS_ACQ_ABORTED,     /* -- acquisition aborted due to multiple decompress
                           -- failures */
    MS_EXPIRED          /* -- module stale (out of date) but still in use (ie.
                           -- has loaded object(s)) */
} ModuleStatus_t;


/* -- Default = UK MHEG profile 1 settings */
typedef struct {
  U32BIT              moduleTimeout;
  U32BIT              blockTimeout;
  U32BIT              minBlockTime;
  ObjectTap_t         tap;
  /* MHP only requires following */
  BOOLEAN             compressed;
  U32BIT              originalSize;
} ModuleInfoProfile_t, *pModuleInfoProfile_t;


typedef struct {
    U16BIT              moduleId;
    U16BIT              blockSize;
#ifndef NDEBUG
    U32BIT              blkRcvd;
#endif
    U32BIT              moduleSize;
    ModuleInfoProfile_t profileInfo;
    U8BIT               version;
    U8BIT               priority;
    U8BIT               transparency;
} ModuleInfo_t, *pModuleInfo_t;


typedef struct s_Module {
    S_LLObject          llData[NUM_LISTS_MODULE];
    ModuleInfo_t        moduleInfo;
    ModuleStatus_t      status;

    /* -- DDB filter info */
    pSectionFilterInfo_t  pDdbSf;

    U16BIT              currentUseCount;            /* -- Limited by design */
    U16BIT              decompressFailureCount;     /* -- Limited by MAX_MODULE_DECOMPRESS_FAILURES */

    U16BIT              openCount;                  /* -- Limited by NUM_OPEN_DSM_OBJECTS_MAX */

    U32BIT              loadedCount;                /* -- Limited only by memory */
    U32BIT              clientRequestCount;         /* -- Limited only by memory */

    /* -- NOT CURRENTLY USED - Intended for making more intelligent
       -- decisions on whether to cache decompressed or not */
    U32BIT              numDirObjs;

    /* -- NB. Module inherits 'highest priority' caching rules of
       -- any object loaded from the module */
    clDsmCachingRules_t cachingRules;

    MemHandle           hModuleBuilder;
    MemHandle           hCompModuleData;
    MemHandle           hModuleData;

    P_LLControl         llcLoadRequests;
} Module_t;


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


/*---------------------------  Exported Prototypes  --------------------------*/
#ifdef DSM_NO_MEM_CONTEXT
#define moduleUse( x, a )                   moduleUse( a )
#define moduleUnUse( x, a )                 moduleUnUse( a )
#endif


clDsmErr_t moduleCreate( pclDsmInstData_t idp,
                    U16BIT moduleId, MemHandle *phModule );

void       moduleDestroy( pclDsmInstData_t idp, MemHandle *phModule );

void       moduleUse( DSM_CONTEXT_DEFN, MemHandle hModule );

void       moduleUnUse( DSM_CONTEXT_DEFN, MemHandle hModule );

void       moduleResetState( pclDsmInstData_t idp,
                    pModule_t pModule, ModuleStatus_t reqdState );

clDsmErr_t moduleBuild( pclDsmInstData_t idp,
                    MemHandle hModule, U8BIT* pDDBMsgPayload,
                    U16BIT ddbMsgPayloadLen, BOOLEAN *pCompleted );

/* Generic module list functions */
MemHandle moduleListFindById( P_LLControl pModuleList, U16BIT moduleId );


/*----------------------------------------------------------------------------*/
#ifdef __cplusplus
}
#endif
#endif /* _MODULE_H_ */