source/classes/inc/mh5ingredient.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 © 2000 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 _MH5INGREDIENT_H
#define _MH5INGREDIENT_H

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

#include "mh5root.h"

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

#define MHEG5CHOOK_UNDEFINED 0xFFFF

/* Content preparation states assigned to 'cpState' */
#define CP_STATE_INITIAL   0
#define CP_STATE_PRELOAD   1
#define CP_STATE_CHANGED   2


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

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

typedef struct sMHEG5ContentBody
{
   MHEG5Bool referenced;
   union
   {
      MHEG5String included;
      struct
      {
         MHEG5String reference;
         MHEG5Int size;
         MHEG5Int priority;
      } referenced;
   } ref;
} MHEG5ContentBody;


typedef struct sMHEG5Ingredient
{
   /* Base class */
   MHEG5Root root;

   /* Exchanged attributes */
   MHEG5Int contentHook;
   MHEG5ContentBody originalContent;
   MHEG5Bool initiallyStopped;
   MHEG5Bool shared;

   /* Internal attributes */
   MHEG5ContentBody content;
   MHEG5Short cpState;

   /* Engine data */
   MHEG5Bool cloned;
   MHEG5Byte *data;
   MHEG5Int dataLen;
   void *ormHandle;
   struct sMHEG5Ingredient *next;
   struct sMHEG5Ingredient *prev;
   struct sMHEG5Ingredient *hnxt;
} MHEG5Ingredient;


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

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


/*
   Constructor
 */
void MHEG5ingredientInit(MHEG5Ingredient *ingredient);


void MHEG5ingredientFree(MHEG5Ingredient *ingredient);


/*
   Clone
 */
void MHEG5ingredientClone(MHEG5Ingredient *destination, MHEG5Ingredient *source);

/*
   Internal behaviours
 */
void MHEG5ingredientPrepare(MHEG5Ingredient *ingredient);


void MHEG5ingredientContentPrepare(MHEG5Ingredient *ingredient);


void MHEG5ingredientDestruct(MHEG5Ingredient *ingredient);


void MHEG5ingredientActivate(MHEG5Ingredient *ingredient);


void MHEG5ingredientDeactivate(MHEG5Ingredient *ingredient);

/*
   Actions
 */
MHEG5ErrorCode MHEG5setData(MHEG5Root *target, MHEG5GList *params);


MHEG5ErrorCode MHEG5clone(MHEG5Root *target, MHEG5GList *params);


MHEG5ErrorCode MHEG5preload(MHEG5Root *target, MHEG5GList *params);


MHEG5ErrorCode MHEG5unload(MHEG5Root *target, MHEG5GList *params);


#ifdef MH5PRINTOUT

void MHEG5ingredientPrint(MHEG5Ingredient *ingredient, char *out);


#endif /* MH5PRINTOUT */


#endif /*_MH5INGREDIENT_H*/