mh5group.c

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
 *******************************************************************************/
/*---includes for this file--------------------------------------------------*/
#include <string.h>

#include "mh5profile.h"
#include "mh5group.h"
#include "mh5object.h"          /*for actions       */
#include "mh5classes.h"
#include "mh5queue.h"           /*Events            */
#include "mh5memory.h"          /*destruct          */
#include "mh5display.h"
#include "mh5debug.h"
#include "stb_os.h"
#include "glue_queue.h"
#include "glue_timers.h"
#include "glue_main.h"
#ifdef MH5PRINTOUT
#include "mh5final.h"
#endif
#ifdef SURFACE_THRESHOLD
#include "mg_api.h"
#endif

/*---constant definitions for this file--------------------------------------*/

/* UK profile - section "6.8.4 Timer count and granularity" says
 * should allow at least 16 concurrent timers, but DTG test does
 * try starting 24 timers, so that is what we will support.
 */
#define MAX_TIMERS       24
#define GROUP_CP_DEFAULT 127
#define ZERO_TIMER_HDL   ((void*)0x2EA02EA0)

#ifdef TRACING
extern int asn_bitmap_count;
extern int asn_group_item_count;
#endif

/*---local typedef structs for this file-------------------------------------*/

typedef struct _GroupTimer
{
   H_Timer t_handle;
   MHEG5Group *group_ptr;
   MHEG5Int timer_id;
} GroupTimer;

/*---local (static) variable declarations for this file----------------------*/

static MH5GroupId nextFreeGroupId = INVALID_GRP_REF;

static GroupTimer group_timers[MAX_TIMERS];
static void *group_mutex = NULL;
static MHEG5Int processing_timers = 0;

/*---local function definitions----------------------------------------------*/

/*---global function definitions---------------------------------------------*/

void MH5_GroupInit(void)
{
   memset(group_timers, 0, MAX_TIMERS * sizeof(GroupTimer));
   group_mutex = STB_OSCreateMutex();
   processing_timers = 0;
   TRACE(TSTATE, ("grp_mutex=%d", group_mutex))
}

/* debug */
#ifdef MH5PRINTOUT

void MHEG5groupPrint(MHEG5Group *group, char *out)
{
   MHEG5Ingredient *currItem;

   /* Inherited types */
   MHEG5indent(out);
   MHEG5classPrint(group->root.clazz, out);
   MHEG_PRINT(out, " (");
   MHEG5stringPrint(group->groupName, out);
   MHEG_PRINT(out, " 0 )");
   MHEG5newLine(out);
   MHEG5incIndent();

   /* Exchanged Attributes */
   /* if ( (group->standardID[0]!=2) || (group->standardID[1]!=19) )
    *{
    *    MHEG5indent(out);
    *    MHEG_PRINT(out,":StdID ");
    *    MHEG5intPrint(group->standardID[0], out);
    *    MHEG_PRINT(out,", ");
    *   MHEG5intPrint(group->standardID[1], out);
    *    MHEG5newLine(out);
    * }
    * if (group->standardVersion != 1)
    *  {
    *    MHEG5indent(out);
    *    MHEG_PRINT(out,":StdVersion ");
    *   MHEG5intPrint(group->standardVersion, out);
    *    MHEG5newLine(out);
    * }*/
   if (group->objectInformation.len)
   {
      MHEG5indent(out);
      MHEG_PRINT(out, ":ObjectInfo ");
      MHEG5stringPrint(group->objectInformation, out);
      MHEG5newLine(out);
   }
   if (group->onStartUp.a_ptr)
   {
      MHEG5indent(out);
      MHEG_PRINT(out, ":OnStartUp ");
      MHEG5actionPrint(group->onStartUp, out);
      MHEG5newLine(out);
   }
   if (group->onCloseDown.a_ptr)
   {
      MHEG5indent(out);
      MHEG_PRINT(out, ":OnCloseDown ");
      MHEG5actionPrint(group->onCloseDown, out);
      MHEG5newLine(out);
   }
   if (group->originalCachePriority != GROUP_CP_DEFAULT)
   {
      MHEG5indent(out);
      MHEG_PRINT(out, ":OrigGCPriority ");
      MHEG5intPrint(group->originalCachePriority, out);
      MHEG5newLine(out);
   }

   currItem = group->itemHead;
   if (currItem)
   {
      MHEG5indent(out);
      MHEG_PRINT(out, ":Items ( ");
      MHEG5newLine(out);
      MHEG5incIndent();
      do
      {
         MHEG5finalPrint((MHEG5Root *)currItem, out);
         currItem = currItem->next;
      }
      while (currItem != NULL);
      MHEG5decIndent();
      MHEG5indent(out);
      MHEG_PRINT(out, ")");
      MHEG5newLine(out);
   }
   /* local attributes */
   if (group->cachePriority != GROUP_CP_DEFAULT)
   {
      MHEG5indent(out);
      MHEG_PRINT(out, "// cachePriority ");
      MHEG5intPrint(group->cachePriority, out);
      MHEG5newLine(out);
   }
}

#endif /* MH5PRINTOUT */


void MHEG5groupAddItem(MHEG5Group *group, MHEG5Ingredient *item)
{
   unsigned int key;

   assert(group);
   assert(item);
   item->root.grp = group;
   item->next = 0;
   item->prev = group->itemTail;
   item->hnxt = 0;
   if (!group->itemTail)
   {
      group->itemHead = item;
   }
   else
   {
      group->itemTail->next = item;
   }
   group->itemTail = item;
   key = item->root.id & 0xff;
   item->hnxt = group->hashIngred[key];
   group->hashIngred[key] = item;
}

void MHEG5groupDelItem(MHEG5Group *group, MHEG5Ingredient *item)
{
   MHEG5Ingredient *s, **h;
   unsigned int key;

   assert(group);
   assert(item);
   s = group->itemHead;
   while (s)
   {
      if (s == item)
      {
         if (s->next)
         {
            s->next->prev = s->prev;
         }
         else
         {
            group->itemTail = s->prev;
         }
         if (s->prev)
         {
            s->prev->next = s->next;
         }
         else
         {
            group->itemHead = s->next;
         }
         break;
      }
      s = s->next;
   }

   if (s)
   {
      key = item->root.id & 0xff;
      h = &group->hashIngred[key];
      while (*h != s)
      {
         h = &(*h)->hnxt;
      }
      *h = s->hnxt;
   }
}

void MHEG5groupInit(MHEG5Group *group)
{
   int i;
   assert(group);

   MHEG5rootInit(&group->root);

   group->group_id = ++nextFreeGroupId;

   /*group->standardID[0] = 2;
    * group->standardID[1] = 19;
    * group->standardVersion = 1;*/
   /*group->magic = GROUP_MAGIC_NUM;*/
   group->cachePriority = GROUP_CP_DEFAULT;
   group->originalCachePriority = GROUP_CP_DEFAULT;
   group->itemTail = 0;
   group->itemHead = 0;
   for (i = 0; i != 256; i++)
   {
      group->hashIngred[i] = 0;
   }
}

void MHEG5groupFree(MHEG5Group *group)
{
   assert(group);

   MHEG5rootFree(&group->root);

   MHEG5stringDestruct(&group->objectInformation);

   MHEG5actionDestruct(group->onStartUp);
   group->onStartUp.a_ptr = 0;
   group->onStartUp.total = 0;

   MHEG5actionDestruct(group->onCloseDown);
   group->onCloseDown.a_ptr = 0;
   group->onCloseDown.total = 0;

   MHEG5stringDestruct(&group->groupName);
}

/*
     Internal behaviours
 */

void MHEG5groupPrepare(MHEG5Group *group)
{
   TRACER(int count = 0; )
   MHEG5Ingredient * item;

   if (group->onStartUp.a_ptr)
   {
      TRACE(TEVNTS, ("OnStartUp %p, %p", group, group->onStartUp))
      MHEG5queueResolveTargets( group->onStartUp );
   }
   if (group->onCloseDown.a_ptr)
   {
      TRACE(TEVNTS, ("onCloseDown %p, %p", group, group->onCloseDown))
      MHEG5queueResolveTargets( group->onCloseDown );
   }

   assert(group);
   item = group->itemHead;
   while (item)
   {
      TRACER(count++; )
      if (!item->initiallyStopped)
      {
         //TRACE(TFILE,("clzz=%d",item->root.clazz))
         switch (item->root.clazz)
         {
            case MHEG5SCENE:
            case MHEG5APPLICATION:
               ERROR_PRINT(("MHEG5groupPrepare: item is invalid class %d\n", item->root.clazz));
               break;
            case MHEG5LINK:
               MHEG5linkPrepare((MHEG5Link *) item);
               break;
            case MHEG5BITMAP:
               MHEG5bitmapPrepare((MHEG5Bitmap *) item);
               break;
            case MHEG5TEXT:
               MHEG5textPrepare((MHEG5Text *) item);
               break;
            case MHEG5LINEART:
               MHEG5lineartPrepare((MHEG5Lineart *) item);
               break;
            case MHEG5DYNAMICLINEART:
               MHEG5dynamicLineartPrepare((MHEG5DynamicLineart *) item);
               break;
            case MHEG5RECTANGLE:
               MHEG5rectanglePrepare((MHEG5Rectangle *) item);
               break;
            case MHEG5RESIDENTPROGRAM:
            case MHEG5REMOTEPROGRAM:
            case MHEG5INTERCHANGEDPROGRAM:
               MHEG5programPrepare((MHEG5Program *) item);
               break;
            case MHEG5BOOLEANVARIABLE:
               MHEG5booleanVariablePrepare((MHEG5BooleanVariable *)item);
               break;
            case MHEG5INTEGERVARIABLE:
               MHEG5integerVariablePrepare((MHEG5IntegerVariable *)item);
               break;
            case MHEG5OCTETSTRINGVARIABLE:
               MHEG5octetStringVariablePrepare((MHEG5OctetStringVariable *)item);
               break;
            case MHEG5OBJECTREFVARIABLE:
               MHEG5objectRefVariablePrepare((MHEG5ObjectRefVariable *)item);
               break;
            case MHEG5CONTENTREFVARIABLE:
               MHEG5contentVariablePrepare((MHEG5ContentVariable *)item);
               break;
            case MHEG5STREAM:
               MHEG5streamPrepare((MHEG5Stream *) item);
               break;
            case MHEG5AUDIO:
               /*MHEG5audioPrepare((MHEG5Audio *) item); <- done by parent stream */
               break;
            case MHEG5VIDEO:
               /*MHEG5videoPrepare((MHEG5Video *) item); <- done by parent stream */
               break;
         #ifndef MHEG5PROFILE_UK1_06
            case MHEG5HOTSPOT:
               MHEG5hotspotPrepare((MHEG5Hotspot *)item);
               break;
            case MHEG5PUSHBUTTON:
               MHEG5pushbuttonPrepare((MHEG5Pushbutton *)item);
               break;
            case MHEG5SWITCHBUTTON:
               MHEG5switchbuttonPrepare((MHEG5Switchbutton *)item);
               break;
            case MHEG5RTGRAPHICS:
               /*MHEG5rtgraphicsPrepare((MHEG5RTGraphics *) item); <- done by parent stream */
               break;
            case MHEG5PALETTE:
               MHEG5palettePrepare((MHEG5Palette *)item);
               break;
            case MHEG5CURSORSHAPE:
               MHEG5cursorShapePrepare((MHEG5CursorShape *)item);
               break;
         #endif 
            case MHEG5FONT:
               MHEG5fontPrepare((MHEG5Font *)item);
               break;
            case MHEG5TOKENGROUP:
               MHEG5tokenGroupPrepare((MHEG5TokenGroup *)item);
               break;
            case MHEG5LISTGROUP:
               MHEG5listGroupPrepare((MHEG5ListGroup *)item);
               break;
            case MHEG5ENTRYFIELD:
               MHEG5entryfieldPrepare((MHEG5Entryfield *)item);
               break;
            case MHEG5HYPERTEXT:
               MHEG5hypertextPrepare((MHEG5Hypertext *)item);
               break;
            case MHEG5SLIDER:
               MHEG5sliderPrepare((MHEG5Slider *)item);
               break;
            default:
               ERROR_PRINT(("INTERNAL ERROR: MHEG5groupPrepare Unrecognised class %d\n", item->root.clazz));
               assert(0);
         }
      }
      else if ((item->root.clazz == MHEG5RESIDENTPROGRAM) ||
               (item->root.clazz == MHEG5REMOTEPROGRAM) ||
               (item->root.clazz == MHEG5INTERCHANGEDPROGRAM))
      {
         if (((MHEG5Program *) item)->initiallyAvailable)
         {
            //TRACE(TFILE, ("clzz=%d", item->root.clazz))
            MHEG5programPrepare((MHEG5Program *) item);
         }
      }
      item = item->next;
   }
   group->cachePriority = group->originalCachePriority;

   MHEG5rootPrepare(&group->root);

   TRACE(TFILE, (" item count=%d grp_itm_cnt=%d asn_bmp_cnt=%d", count, asn_group_item_count, asn_bitmap_count))
}

void MHEG5groupDestruct(MHEG5Group *group)
{
   MHEG5Ingredient *item, *prev;
   int t_ndx;

   assert(group);

   if (group->onCloseDown.a_ptr && MH5GlueActiveState())
   {
      TRACE(TEVNTS, ("OnCloseDown %p, %p", group, group->onCloseDown))
      MHEG5actionListExecute( group, group->onCloseDown );
   }

   item = group->itemTail;
   while (item)
   {
      prev = item->prev;

      switch (item->root.clazz)
      {
         case MHEG5LINK:
            MHEG5linkDestruct((MHEG5Link *) item);
            MHEG5linkFree((MHEG5Link *)item);
            break;
         case MHEG5BITMAP:
            MHEG5bitmapDestruct((MHEG5Bitmap *) item);
            MHEG5bitmapFree((MHEG5Bitmap *)item);
            break;
         case MHEG5TEXT:
            MHEG5textDestruct((MHEG5Text *) item);
            MHEG5textFree((MHEG5Text *)item);
            break;
         case MHEG5LINEART:
            MHEG5lineartDestruct((MHEG5Lineart *) item);
            MHEG5lineartFree((MHEG5Lineart *)item);
            break;
         case MHEG5DYNAMICLINEART:
            MHEG5dynamicLineartDestruct((MHEG5DynamicLineart *) item);
            MHEG5dynamicLineartFree((MHEG5DynamicLineart *)item);
            break;
         case MHEG5RECTANGLE:
            MHEG5rectangleDestruct((MHEG5Rectangle *) item);
            MHEG5rectangleFree((MHEG5Rectangle *)item);
            break;
         case MHEG5RESIDENTPROGRAM:
         case MHEG5REMOTEPROGRAM:
         case MHEG5INTERCHANGEDPROGRAM:
            MHEG5programDestruct((MHEG5Program *) item);
            MHEG5programFree((MHEG5Program *)item);
            break;
         case MHEG5BOOLEANVARIABLE:
            MHEG5ingredientDestruct((MHEG5Ingredient *) item);
            MHEG5booleanVariableFree((MHEG5BooleanVariable *)item);
            break;
         case MHEG5INTEGERVARIABLE:
            MHEG5ingredientDestruct((MHEG5Ingredient *) item);
            MHEG5integerVariableFree((MHEG5IntegerVariable *)item);
            break;
         case MHEG5OCTETSTRINGVARIABLE:
            MHEG5octetStringVariableDestruct((MHEG5OctetStringVariable *) item);
            MHEG5octetStringVariableFree((MHEG5OctetStringVariable *)item);
            break;
         case MHEG5OBJECTREFVARIABLE:
            MHEG5ingredientDestruct((MHEG5Ingredient *) item);
            MHEG5objectRefVariableFree((MHEG5ObjectRefVariable *)item);
            break;
         case MHEG5CONTENTREFVARIABLE:
            MHEG5contentVariableDestruct((MHEG5ContentVariable *) item);
            MHEG5contentVariableFree((MHEG5ContentVariable *)item);
            break;
         case MHEG5STREAM:
            MHEG5streamDestruct((MHEG5Stream *) item);
            MHEG5streamFree((MHEG5Stream *)item);
            break;
         case MHEG5AUDIO:
            MHEG5audioDestruct((MHEG5Audio *) item);
            MHEG5audioFree((MHEG5Audio *)item);
            break;
         case MHEG5VIDEO:
            MHEG5videoDestruct((MHEG5Video *) item);
            MHEG5videoFree((MHEG5Video *)item);
            break;
      #ifndef MHEG5PROFILE_UK1_06
         case MHEG5HOTSPOT:
            MHEG5hotspotDestruct((MHEG5Hotspot *)item);
            MHEG5hotspotFree((MHEG5Hotspot *)item);
            break;
         case MHEG5PUSHBUTTON:
            MHEG5pushbuttonDestruct((MHEG5Pushbutton *)item);
            MHEG5pushbuttonFree((MHEG5Pushbutton *)item);
            break;
         case MHEG5SWITCHBUTTON:
            MHEG5switchbuttonDestruct((MHEG5Switchbutton *)item);
            MHEG5switchbuttonFree((MHEG5Switchbutton *)item);
            break;
         case MHEG5RTGRAPHICS:
            MHEG5rtgraphicsDestruct((MHEG5RTGraphics *) item);
            MHEG5rtgraphicsFree((MHEG5RTGraphics *)item);
            break;
         case MHEG5PALETTE:
            MHEG5paletteDestruct((MHEG5Palette *)item);
            MHEG5paletteFree((MHEG5Palette *)item);
            break;
         case MHEG5CURSORSHAPE:
            MHEG5cursorShapeDestruct((MHEG5CursorShape *)item);
            MHEG5cursorShapeFree((MHEG5CursorShape *)item);
            break;
      #endif 
         case MHEG5FONT:
            MHEG5fontDestruct((MHEG5Font *)item);
            MHEG5fontFree((MHEG5Font *)item);
            break;
         case MHEG5TOKENGROUP:
            MHEG5tokenGroupDestruct((MHEG5TokenGroup *)item);
            MHEG5tokenGroupFree((MHEG5TokenGroup *)item);
            break;
         case MHEG5LISTGROUP:
            MHEG5listGroupDestruct((MHEG5ListGroup *)item);
            MHEG5listGroupFree((MHEG5ListGroup *)item);
            break;
         case MHEG5ENTRYFIELD:
            MHEG5entryfieldDestruct((MHEG5Entryfield *)item);
            MHEG5entryfieldFree((MHEG5Entryfield *)item);
            break;
         case MHEG5HYPERTEXT:
            MHEG5hypertextDestruct((MHEG5Hypertext *)item);
            MHEG5hypertextFree((MHEG5Hypertext *)item);
            break;
         case MHEG5SLIDER:
            MHEG5sliderDestruct((MHEG5Slider *)item);
            MHEG5sliderFree((MHEG5Slider *)item);
            break;
         default:
            ERROR_PRINT(("INTERNAL ERROR: MHEG5groupDestruct Unrecognised class %d\n", item->root.clazz));
      }
      MHEG5freeMem(item);
      item = prev;
   }
   group->itemTail = 0;
   group->itemHead = 0;

   group->root.runningStatus = MHEG5FALSE;
   /* do we need to do? -> MHEG5groupDeactivate( group ); */

   for (t_ndx = 0; t_ndx != MAX_TIMERS; t_ndx++)
   {
      if (group_timers[t_ndx].group_ptr == group)
      {
         if (group_timers[t_ndx].t_handle != 0)
         {
            if (group_timers[t_ndx].t_handle != ZERO_TIMER_HDL)
            {
               mhegTimerDestroy( group_timers[t_ndx].t_handle );
            }
            group_timers[t_ndx].t_handle = 0;
         }
      }
   }

   MHEG5rootDestruct((MHEG5Root *) group);
}

void MHEG5groupActivate(MHEG5Group *group)
{
   MHEG5Ingredient *item;

   assert(group);

   if (!group->root.availabilityStatus)
   {
      MHEG5groupPrepare( group );
   }

   if (group->onStartUp.a_ptr)
   {
      TRACE(TEVNTS, ("OnStartUp %p, %p", group, group->onStartUp))
      MHEG5actionListExecute( group, group->onStartUp );
   }

   item = group->itemHead;

   while (item)
   {
      if (!item->initiallyStopped)
      {
         switch (item->root.clazz)
         {
            case MHEG5SCENE:
            case MHEG5APPLICATION:
               ERROR_PRINT(("MHEG5groupActivate: item is invalid class %d\n", item->root.clazz));
               break;
            case MHEG5LINK:
               MHEG5linkActivate((MHEG5Link *) item);
               break;
            case MHEG5BITMAP:
               MHEG5bitmapActivate((MHEG5Bitmap *) item);
               break;
            case MHEG5TEXT:
               MHEG5textActivate((MHEG5Text *) item);
               break;
            case MHEG5LINEART:
               MHEG5lineartActivate((MHEG5Lineart *) item);
               break;
            case MHEG5DYNAMICLINEART:
               MHEG5dynamicLineartActivate((MHEG5DynamicLineart *) item);
               break;
            case MHEG5RECTANGLE:
               MHEG5rectangleActivate((MHEG5Rectangle *) item);
               break;
            case MHEG5RESIDENTPROGRAM:
            case MHEG5REMOTEPROGRAM:
            case MHEG5INTERCHANGEDPROGRAM:
               MHEG5programActivate((MHEG5Program *) item);
               break;
            case MHEG5BOOLEANVARIABLE:
            case MHEG5INTEGERVARIABLE:
            case MHEG5OCTETSTRINGVARIABLE:
            case MHEG5OBJECTREFVARIABLE:
            case MHEG5CONTENTREFVARIABLE:
               MHEG5variableActivate((MHEG5Ingredient *) item);
               break;
            case MHEG5STREAM:
               MHEG5streamActivate((MHEG5Stream *) item);
               break;
            case MHEG5AUDIO:
               /*MHEG5audioActivate((MHEG5Audio *) item); <- done by parent stream */
               break;
            case MHEG5VIDEO:
               /*MHEG5videoActivate((MHEG5Video *) item); <- done by parent stream */
               break;
         #ifndef MHEG5PROFILE_UK1_06
            case MHEG5HOTSPOT:
               MHEG5hotspotActivate((MHEG5Hotspot *)item);
               break;
            case MHEG5PUSHBUTTON:
               MHEG5pushbuttonActivate((MHEG5Pushbutton *)item);
               break;
            case MHEG5SWITCHBUTTON:
               MHEG5switchbuttonActivate((MHEG5Switchbutton *)item);
               break;
            case MHEG5RTGRAPHICS:
               /*MHEG5rtgraphicsActivate((MHEG5RTGraphics *) item); <- done by parent stream */
               break;
            case MHEG5PALETTE:
               MHEG5paletteActivate((MHEG5Palette *)item);
               break;
            case MHEG5CURSORSHAPE:
               MHEG5cursorShapeActivate((MHEG5CursorShape *)item);
               break;
         #endif 
            case MHEG5FONT:
               MHEG5fontActivate((MHEG5Font *)item);
               break;
            case MHEG5TOKENGROUP:
               MHEG5tokenGroupActivate((MHEG5TokenGroup *)item);
               break;
            case MHEG5LISTGROUP:
               MHEG5listGroupActivate((MHEG5ListGroup *)item);
               break;
            case MHEG5ENTRYFIELD:
               MHEG5entryfieldActivate((MHEG5Entryfield *)item);
               break;
            case MHEG5HYPERTEXT:
               MHEG5hypertextActivate((MHEG5Hypertext *)item);
               break;
            case MHEG5SLIDER:
               MHEG5sliderActivate((MHEG5Slider *)item);
               break;
            default:
               ERROR_PRINT(("INTERNAL ERROR: MHEG5groupActivate Unrecognised class %d\n", item->root.clazz));
         }
      }
      item = item->next;
   }
   group->root.runningStatus = MHEG5TRUE;
   group->startTime = STB_OSGetClockMilliseconds();

   MHEG5sendSync((MHEG5Root *) group, MHEG5ISRUNNING, 0);
}

void MHEG5groupDeactivate(MHEG5Group *group)
{
   assert(group);
   if (group->root.runningStatus)
   {
      MHEG5Ingredient *item;
      MHEG5Application *ca = MHEG5getCurrentApplication();

      if (ca)
      {
         ca->lockCount++;
      }

      item = group->itemTail;

      while (item)
      {
         switch (item->root.clazz)
         {
            case MHEG5LINK:
               MHEG5linkDeactivate((MHEG5Link *) item);
               break;
            case MHEG5BITMAP:
               MHEG5bitmapDeactivate((MHEG5Bitmap *) item);
               break;
            case MHEG5TEXT:
               MHEG5textDeactivate((MHEG5Text *) item);
               break;
            case MHEG5LINEART:
               MHEG5lineartDeactivate((MHEG5Lineart *) item);
               break;
            case MHEG5DYNAMICLINEART:
               MHEG5dynamicLineartDeactivate((MHEG5DynamicLineart *) item);
               break;
            case MHEG5RECTANGLE:
               MHEG5rectangleDeactivate((MHEG5Rectangle *) item);
               break;
            case MHEG5RESIDENTPROGRAM:
            case MHEG5REMOTEPROGRAM:
            case MHEG5INTERCHANGEDPROGRAM:
               MHEG5programDeactivate((MHEG5Program *) item);
               break;
            case MHEG5BOOLEANVARIABLE:
            case MHEG5INTEGERVARIABLE:
            case MHEG5OCTETSTRINGVARIABLE:
            case MHEG5OBJECTREFVARIABLE:
            case MHEG5CONTENTREFVARIABLE:
               MHEG5variableDeactivate((MHEG5Ingredient *) item);
               break;
            case MHEG5STREAM:
               MHEG5streamDeactivate((MHEG5Stream *) item);
               break;
            case MHEG5AUDIO:
               MHEG5audioDeactivate((MHEG5Audio *) item);
               break;
            case MHEG5VIDEO:
               MHEG5videoDeactivate((MHEG5Video *) item);
               break;
      #ifndef MHEG5PROFILE_UK1_06
            case MHEG5HOTSPOT:
               MHEG5hotspotDeactivate((MHEG5Hotspot *)item);
               break;
            case MHEG5PUSHBUTTON:
               MHEG5pushbuttonDeactivate((MHEG5Pushbutton *)item);
               break;
            case MHEG5SWITCHBUTTON:
               MHEG5switchbuttonDeactivate((MHEG5Switchbutton *)item);
               break;
            case MHEG5RTGRAPHICS:
               MHEG5rtgraphicsDeactivate((MHEG5RTGraphics *) item);
               break;
            case MHEG5PALETTE:
               MHEG5paletteDeactivate((MHEG5Palette *)item);
               break;
            case MHEG5CURSORSHAPE:
               MHEG5cursorShapeDeactivate((MHEG5CursorShape *)item);
               break;
      #endif 
            case MHEG5FONT:
               MHEG5fontDeactivate((MHEG5Font *)item);
               break;
            case MHEG5TOKENGROUP:
               MHEG5tokenGroupDeactivate((MHEG5TokenGroup *)item);
               break;
            case MHEG5LISTGROUP:
               MHEG5listGroupDeactivate((MHEG5ListGroup *)item);
               break;
            case MHEG5ENTRYFIELD:
               MHEG5entryfieldDeactivate((MHEG5Entryfield *)item);
               break;
            case MHEG5HYPERTEXT:
               MHEG5hypertextDeactivate((MHEG5Hypertext *)item);
               break;
            case MHEG5SLIDER:
               MHEG5sliderDeactivate((MHEG5Slider *)item);
               break;
            default:
               ERROR_PRINT(("INTERNAL ERROR: MHEG5groupDeactivate Unrecognised class %d\n", item->root.clazz));
         }
         item = item->prev;
      }

      MHEG5rootDeactivate(&group->root);

      if (ca)
      {
         ca->lockCount--;
         if (ca->lockCount <= 0)
         {
            ca->lockCount = 0;
            MHEG5displayShowAll();
         }
      }
   }
}

/*
 *   Actions
 */

MHEG5ErrorCode MHEG5setCachePriority(MHEG5Root *target, MHEG5GList *params)
{
   MHEG5Int value = 0;

   assert(target);

   if (!params)
   {
      return MHEG5ERR_WRONGNUMBEROFPARAMS;
   }
   MHEG5resolveGenericInteger(params, &value);

   ((MHEG5Group *) target)->cachePriority = value;

   return MHEG5ERR_NOERROR;
}

static void MH5_GroupTimer( void *data )
{
   MHEG5TimerEventParams_t *params = (MHEG5TimerEventParams_t *)data;
   GroupTimer *gt = (GroupTimer *)params->callerRef;

   if (gt->t_handle == params->timerHandle)
   {
      if (params->triggered == TRUE) /* sanity check */
      {
         TRACE(TTIME, ("Main Timer fired, id=%ld hdl=%x", gt->timer_id, gt->t_handle))
         MHEG5sendEvent((MHEG5Root *) gt->group_ptr, MHEG5TIMERFIRED, gt->timer_id );
      }
      gt->t_handle = 0;
      gt->timer_id = 0;
      gt->group_ptr = 0;
   }
   else
   {
      TRACE(TTIME, ("Timer %ld Fired, but it was cancelled while fire event was waiting in Queue (0x%x 0x%x)",
                    gt->timer_id, gt->t_handle, params->timerHandle))
   }
   STB_OSMutexLock(group_mutex);
   processing_timers--;
   STB_OSMutexUnlock(group_mutex);
}

static void TimerCallback( BOOLEAN triggered, void *callerRef, H_Timer timerHandle )
{
   GroupTimer *gt = (GroupTimer *)callerRef;
   MHEG5eventMessage_t event;
   if (triggered)
   {
      TRACE(TTIME, ("Timer Callback, id=%ld hdl=%x thdl=%x", gt->timer_id, gt->t_handle, timerHandle))
      /* Send event to component task */
      event.proc_msg_func = MH5_GroupTimer;
      event.data_type = DT_VALUE;
      event.data.timer.triggered = triggered;
      event.data.timer.callerRef = callerRef;
      event.data.timer.timerHandle = (void *)timerHandle;
      STB_OSMutexLock(group_mutex);
      processing_timers++;
      STB_OSMutexUnlock(group_mutex);
      if (VQ_PutMsg(&event, PRTY_HIGH) != MHERR_OK)
      {
         TRACE(TERROR, ("VQ_PutMsg returned Error\n"))
         gt->t_handle = 0;
         gt->group_ptr = 0;
         gt->timer_id = 0;
         STB_OSMutexLock(group_mutex);
         processing_timers--;
         STB_OSMutexUnlock(group_mutex);
      }
   }
   else
   {
      TRACE(TTIME, ("Timer Cancelled, id=%ld hdl=%x thdl=%x", gt->timer_id, gt->t_handle, timerHandle))
      /* only get here with mheg task calling destroy timer */
      gt->t_handle = 0;
      gt->group_ptr = 0;
      gt->timer_id = 0;
   }
}

MHEG5ErrorCode MHEG5setTimer(MHEG5Root *target, MHEG5GList *params)
{
   MHEG5GList *thirdParam = 0, *fourthParam = 0;
   MHEG5Group *group = 0;
   MHEG5Int timerId = 0, timerValue = -1;
   MHEG5Bool absoluteTime = MHEG5FALSE;
   U32BIT currentTime;
   int t_ndx;

   assert(target);

   if (!params)
   {
      return MHEG5ERR_WRONGNUMBEROFPARAMS;
   }

   group = (MHEG5Group *) target;
   currentTime = STB_OSGetClockMilliseconds();

   thirdParam = MHEG5resolveGenericInteger(params, &timerId);

   for (t_ndx = 0; t_ndx != MAX_TIMERS; t_ndx++)
   {
      if ((group_timers[t_ndx].group_ptr == group) &&
          (group_timers[t_ndx].timer_id == timerId))
      {
         TRACE(TTIME, ("Cancel timer id=%ld ndx=%d hdl=%x", timerId, t_ndx, group_timers[t_ndx].t_handle))
         /* Cancel existing timer */
         if (group_timers[t_ndx].t_handle != 0)
         {
            if (group_timers[t_ndx].t_handle != ZERO_TIMER_HDL)
            {
               mhegTimerDestroy( group_timers[t_ndx].t_handle );
            }
            group_timers[t_ndx].t_handle = 0;
         }
         else
         {
            group_timers[t_ndx].group_ptr = 0;
            group_timers[t_ndx].timer_id = 0;
         }
         break;
      }
   }
   if (thirdParam)
   {
      /* TimerValue has been encoded */
      fourthParam = MHEG5resolveGenericInteger(thirdParam, &timerValue);
      if (fourthParam)
      {
         MHEG5resolveGenericBoolean(fourthParam, &absoluteTime);
         if (absoluteTime)
         {
            timerValue -= currentTime - group->startTime;
         }
      }
      for (t_ndx = 0; t_ndx != MAX_TIMERS; t_ndx++)
      {
         if (group_timers[t_ndx].t_handle == 0)
         {
            group_timers[t_ndx].group_ptr = group;
            group_timers[t_ndx].timer_id = timerId;
            if (timerValue > 0)
            {
               if (mhegTimerCreate((U32BIT) timerValue, (F_TimerCallback) TimerCallback,
                      (void *) &group_timers[t_ndx], &group_timers[t_ndx].t_handle ) != MHERR_OK)
               {
                  group_timers[t_ndx].group_ptr = 0;
                  group_timers[t_ndx].timer_id = 0;
               }
               TRACE(TTIME, ("Create timer id=%ld val=%ld,ndx=%d hdl=%x", timerId, timerValue, t_ndx, group_timers[t_ndx].t_handle))
            }
            else if (!absoluteTime && (timerValue == 0))
            {
               STB_OSMutexLock(group_mutex);
               timerValue = processing_timers;
               STB_OSMutexUnlock(group_mutex);
               if (timerValue)
               {
                  /* Other timer(s) are waiting to fire, so put this zero timer on queue to be processed after them */
                  TRACE(TTIME, ("Zero Timer fired, id=%ld, handle via queue", timerId))
                  group_timers[t_ndx].t_handle = ZERO_TIMER_HDL;
                  TimerCallback(TRUE, (void *) &group_timers[t_ndx], group_timers[t_ndx].t_handle);
               }
               else
               {
                  /* No other timers, so can short-circuit firing of timer */
                  TRACE(TTIME, ("Zero Timer fired, id=%ld, handle immediately", timerId))
                  MHEG5sendEvent((MHEG5Root *) group, MHEG5TIMERFIRED, timerId);
                  group_timers[t_ndx].group_ptr = 0;
                  group_timers[t_ndx].timer_id = 0;
               }
            }
            break;
         }
      }
   }

   return MHEG5ERR_NOERROR;
}

#ifdef SURFACE_THRESHOLD

void MHEG5groupDestroySurfaces(MHEG5Int pixels)
{
   MHEG5Group *group;
   MHEG5Int i;
   MHEG5Ingredient *ingredient;
   MHEG5Visible *visible;

   group = (MHEG5Group *)MHEG5getCurrentApplication();
   for (i = 0; group != NULL && i < 2; i++)
   {
      for (ingredient = group->itemHead; ingredient != NULL;
           ingredient = ingredient->next)
      {
         switch (ingredient->root.clazz)
         {
            case MHEG5RTGRAPHICS:
            case MHEG5BITMAP:
            case MHEG5TEXT:
            case MHEG5SLIDER:
            case MHEG5DYNAMICLINEART:
            case MHEG5RECTANGLE:
            case MHEG5ENTRYFIELD:
            case MHEG5HYPERTEXT:
            case MHEG5HOTSPOT:
            case MHEG5PUSHBUTTON:
            case MHEG5SWITCHBUTTON:
               /* Visible */
               visible = (MHEG5Visible *)ingredient;
               MG_ApplySurfaceThreshold(&visible->graphic_data, pixels);
               break;
            default:
               ;
         }
      }
      group = (MHEG5Group *)MHEG5getCurrentScene();
   }
}

#endif  /* SURFACE_THRESHOLD */