source/ics/src/stmr_queue.h

Go to the documentation of this file.

/*******************************************************************************
 * Copyright © 2014 The DTVKit Open Software Foundation Ltd (www.dtvkit.org)
 * Copyright © 2010 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 _STMR_QUEUE_H_
#define _STMR_QUEUE_H_

/*---includes for this file--------------------------------------------------*/

#include "techtype.h"
#include "mherrors.h"
#include "stmr_util.h"

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

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

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

typedef enum
{
   QUEUE_EVENT_ITEM_INSERTED,
   QUEUE_EVENT_ITEM_RELEASED
} MHEG5QueueEvent_t;

typedef struct sMHEG5QueueItem
{
   struct sMHEG5QueueItem *next;
   U32BIT requestId;
   U32BIT downloadId;
   U8BIT *data;
   U32BIT len;
   U32BIT offset;
   U64BIT position;
   U64BIT base;
   U32BIT timestamp;
   BOOLEAN last;
   U16BIT referenceCount;
} MHEG5QueueItem;

/*---Global variable declarations for public use-----------------------------*/

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


E_MhegErr MHEG5QueueInit(U8BIT *buffer, U32BIT bufferSize);


MHEG5QueueItem* MHEG5QueueAllocItem(U32BIT requestId, U32BIT len);


void MHEG5QueueInsertItem(MHEG5QueueItem *item);


MHEG5QueueItem* MHEG5QueueGetHeadItem(void);


BOOLEAN MHEG5QueueIsValidItem(MHEG5QueueItem *item);


void MHEG5QueueUpdateItem(MHEG5QueueItem *item, U32BIT processed);


void MHEG5QueueReleaseItem(MHEG5QueueItem *item);


U32BIT MHEG5QueueGetBufferedBytes(void);


void MHEG5QueueEnableStreaming(U32BIT requestId);


void MHEG5QueueDisableStreaming(void);


BOOLEAN MHEG5QueueIsStreamingEnabled(void);


void MHEG5QueueReleaseRequestItems(U32BIT requestId);


void MHEG5QueueReleaseAllItems(void);


void MHEG5QueueRegisterInsertCallback(void (*callback)(U32BIT downloadId,
      U64BIT base,
      U64BIT position,
      U32BIT len,
      BOOLEAN last));


void MHEG5QueueRegisterReleaseCallback(void (*callback)(U32BIT requestId,
      U64BIT base,
      U64BIT position,
      U32BIT len,
      BOOLEAN last));


void MHEG5QueueTerm(void);


#endif /*_STMR_QUEUE_H*/