mh5group.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 _MH5GROUP_H
#define _MH5GROUP_H

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

#include "mh5action.h"
#include "mh5ingredient.h"

/*---Constant and macro definitions for public use---------------------------*/
#define GRP_HASH_TABLE_SIZE 251
/*#define GROUP_MAGIC_NUM     0x970db5f0*/

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

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

typedef struct sMHEG5Group
{
   /* Base classe */
   MHEG5Root root;

   /* Exchanged attributes */
   MHEG5String groupName;
   MH5GroupId group_id;
   /*U32BIT        magic;*/
   /*MHEG5Int      standardID[2];  *
    * MHEG5Int      standardVersion;*/
   MHEG5String objectInformation;
   MHEG5ActionList onStartUp;
   MHEG5ActionList onCloseDown;
   MHEG5Int originalCachePriority;
   MHEG5Ingredient *itemHead;
   MHEG5Ingredient *itemTail;
   MHEG5Ingredient *hashIngred[256];

   /* Internal attributes */
   MHEG5Int cachePriority;

   /* Engine data */
   unsigned long startTime;
} MHEG5Group;

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

/*---Global Function prototypes for public use-------------------------------*/
#ifdef MH5PRINTOUT

void MHEG5groupPrint(MHEG5Group *group, char *out);

#endif /* MH5PRINTOUT */

void MHEG5groupAddItem(MHEG5Group *group, MHEG5Ingredient *item);

void MHEG5groupDelItem(MHEG5Group *group, MHEG5Ingredient *item);

/*
     Constructor
 */
void MHEG5groupInit(MHEG5Group *group);


void MHEG5groupFree(MHEG5Group *group);


/*
     Internal behaviours
 */
void MHEG5groupPrepare(MHEG5Group *group);


void MHEG5groupDestruct(MHEG5Group *group);


void MHEG5groupActivate(MHEG5Group *group);


void MHEG5groupDeactivate(MHEG5Group *group);

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

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

void MH5_GroupInit(void);

#ifdef INCLUDE_SURFACE_THRESHOLD

void MHEG5groupDestroySurfaces(MHEG5Int pixels);
#endif  /* INCLUDE_SURFACE_THRESHOLD */

#endif /*_MH5GROUP_H*/