source/dscore/src/objectCarousel.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 _OBJECTCAROUSEL_H_
#define _OBJECTCAROUSEL_H_


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

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

#ifdef __cplusplus
extern "C" {
#endif


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

#define OC_MAGIC            0x27BEC2A5
#define INVALID_DSI_TRANSACTION_ID 0xFFFFFFFF


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

typedef enum {
    OCS_INITIAL,
    OCS_PENDING_BOOTINFO,   /* -- waiting on SI Query for boot info */
    OCS_BOOTING,            /* -- DSI requested */
    OCS_BOOTED,             /* -- DSI (SRG info) acquired, SRG requested */
    OCS_LOADED,             /* -- SRG loaded */
    OCS_LOAD_FAILED         /* -- failed to boot or load */
} OcStatus_t;


typedef struct FileGroupList_s *pFileGroupList_t;

typedef struct s_ObjectCarousel
{
    S_LLObject              llData[NUM_LISTS_OBJECT_CAROUSEL];

    U32BIT                  magic;

    U32BIT                  carouselId;
    U32BIT                  dsiTransactionId;
    U16BIT                  service_id;

    /* -- DSI filter info */
    U16BIT                  dsiAssocTag;
    pSectionFilterInfo_t    pDsiSf;

    OcStatus_t              ocStatus;
    MemHandle               hPendingSiQueryRef; /* -- Only used initially */

    MemHandle               hLoadRequest;

    DeliveryParaTap_t       srgTap;
    ObjectLocation_t        srgObjLoc;
    pFileGroupList_t        pFileGroupList;

    MemHandle               hSrgDataCarousel;
    MemHandle               hSrgModule;

    U32BIT                  srgObjectOffset;
    ObjectDataInfo_t        srgObjectInfo;
    BOOLEAN                 srgObjectLoaded;

    BOOLEAN                 bOCLiteOptionsObjectProcessing;
    U16BIT                  loadedObjectCount;

    P_LLControl             llcOcDataCarousels;
    P_LLControl             llcOcDiiAcquires;
    P_LLControl             llcOcModuleAcquires;
    P_LLControl             llcOcPostponedLiteObjectLoads;
} ObjectCarousel_t;


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


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

clDsmErr_t ocCreate( pclDsmInstData_t idp,
                    U32BIT carouselId, pObjectCarousel_t *ppObjectCarousel );

void       ocDestroy( pclDsmInstData_t idp,
                    pObjectCarousel_t *ppObjectCarousel );

clDsmErr_t ocDiiAcquireStart( pclDsmInstData_t idp,
                pObjectCarousel_t pOC, MemHandle hDC, clDsmSFPriority_t sfPriority );

void ocDiiAcquireStop( pclDsmInstData_t idp,
                    pObjectCarousel_t pOC, MemHandle hDataCarousel );

clDsmErr_t ocModuleAcquireStart( pclDsmInstData_t idp,
                pObjectCarousel_t pOC, MemHandle hModule, clDsmSFPriority_t sfPriority );

void ocModuleAcquireStop( pclDsmInstData_t idp, pObjectCarousel_t pOC, MemHandle hModule );

pObjectCarousel_t ocListFindById( P_LLControl plcObjectCarousel, U16BIT service_id, U32BIT carouselId );

BOOLEAN ocListFind( P_LLControl pllcObjectCarousel, MemHandle hObjectCarousel );

clDsmErr_t ocUpdateSrgUserInfo( pclDsmInstData_t idp, pObjectCarousel_t pOC,
                                U8BIT* pSrgData, U16BIT usrInfoLen );

clDsmErr_t ocRetrieveFileGroups( pObjectCarousel_t pOC, U16BIT* total,
           S_CarouselInfoFileGroup **pGroups );

void ocReleaseFileGroups( pclDsmInstData_t idp, pObjectCarousel_t pOC, S_CarouselInfoFileGroup *groups );

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

#ifdef __cplusplus
}
#endif
#endif /* _OBJECTCAROUSEL_H_ */