mh5application.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 "mh5application.h"
#include "mh5object.h"          /* for actions                      */
#include "mh5variable.h"        /* for actions                      */
#include "mh5memory.h"          /* for constructor/destructor       */
#include "mh5queue.h"           /* Events                           */
#include "mh5display.h"         /* UnlockScreen                     */
#include "mh5fileorm.h"
#include "mh5storage.h"
#include "mh5gate.h"
#include "mh5debug.h"
#include "mh5misc.h"
#include "glue_queue.h"
#include "glue_main.h"
#include "fpa1_parserInvoke.h"
#include "tmcolor.h"
#include "mh5profile.h"
#include "mh5support.h"
#include "mh5control.h"
#ifdef INCLUDE_IC
#include "mh5hfs.h"
#include "mh5tls.h"
#include "mh5access.h"
#endif
#ifndef CI_PLUS_ONLY
#include "glue_dsmcc.h"
#include "dsm_control.h"
#endif

#include <string.h>
#include <time.h>

#ifdef INCLUDE_TPS
#include "mh5tps.h"
#endif

#ifdef INCLUDE_NVM
#ifdef INCLUDE_FREESAT
#error Cannot define INCLUDE_NVM and INCLUDE_FREESAT in the same build
#endif
#include "mh5nvm.h"
#define WRITE_BUFFER_MAX (64 * 1024)

#elif defined(INCLUDE_FREESAT)
#define WRITE_BUFFER_MAX (64 * 1024)
#include "mh5fsnvm.h"

#else
#define WRITE_BUFFER_MAX (2 * 1024)
#endif

#ifdef ASN1TEST
   #include "asn1_testHarness.h"
#endif

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


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

typedef struct sMHEG5applStackItem
{
   MHEG5String app_name;
   void *carousel_handle;
   MHEG5Bool spawned;
} MHEG5AppStackItem;

typedef struct s_boot_data
{
   E_FS_ORIGIN origin;
   U32BIT stage;
} S_BOOT_DATA;

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

static const MHEG5String boot_origins[] = {
   { 6, (U8BIT *)"DSM://" },
   { 5, (U8BIT *)"CI://" },
   { 9, (U8BIT *)"hybrid://" }
};

static MHEG5Application *currentApplication = 0;
static MHEG5Bool Restarted = MHEG5FALSE;
static void *BootupFileOrmHandle = NULL;
/*
   strict Application Stack Size for 5 Applications
   important for strict DTG compliance
 */
#define MAX_APPS 6

static MHEG5String launchAppName;
static MHEG5AppStackItem applStack[MAX_APPS];
static U16BIT applStackCount = 0;


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

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

#ifdef MH5PRINTOUT
int mheg_trace_source = 1;
void MHEG5fontBodyPrint(MHEG5FontBody fontBody, char *out)
{
   if (fontBody.ref.included.len != 0)
   {
      MHEG5indent(out);
      MHEG_PRINT(out, ":Font ");
      if (fontBody.referenced == MHEG5TRUE)
      {
         if (fontBody.ref.referenced.grp.len)
         {
            MHEG5stringPrint(*((MHEG5String *)&fontBody.ref.referenced.grp), out);
         }
         else
         {
            MHEG5stringPrint(((MHEG5Group *)fontBody.ref.referenced.grp.ptr.group)->groupName, out);
         }
         MHEG_PRINT(out, ", ");
         MHEG5intPrint(fontBody.ref.referenced.id, out);
      }
      else
      {
         MHEG5stringPrint(fontBody.ref.included, out);
      }
      MHEG5newLine(out);
   }
}

void MHEG5applicationPrint(MHEG5Application *application, char *out)
{
   MHEG5String path;
   int save_indent = MHEG5setIndent(0);

   path = MHEG5convertGID(&application->group.groupName);
   STB_DebugLogOpen(path.data);
   MHEG5stringDestruct(&path);

   /* inherited class */
   MHEG5groupPrint(&application->group, out);

   /* exchanged attributes */
   if (application->onSpawnCloseDown.a_ptr)
   {
      MHEG5indent(out);
      MHEG_PRINT(out, ":OnSpawnCloseDown ");
      MHEG5actionPrint(application->onSpawnCloseDown, out);
      MHEG5newLine(out);
   }
   if (application->onRestart.a_ptr)
   {
      MHEG5indent(out);
      MHEG_PRINT(out, ":OnRestart ");
      MHEG5actionPrint(application->onRestart, out);
      MHEG5newLine(out);
   }

   if (application->characterSet != 10)
   {
      MHEG5indent(out);
      MHEG_PRINT(out, ":CharacterSet ");
      MHEG5intPrint(application->characterSet, out);
      MHEG5newLine(out);
   }
   if (application->backgroundColour.value.i != OSDgetColour(TRANSPARENTCOLOR))
   {
      MHEG5indent(out);
      MHEG_PRINT(out, ":BackgroundColour ");
      MHEG5colourPrint(application->backgroundColour, out);
      MHEG5newLine(out);
   }

   MHEG5indent(out);
   MHEG_PRINT(out, ":TextColour ");
   MHEG5colourPrint(application->textColour, out);
   MHEG5newLine(out);

   MHEG5fontBodyPrint(application->fontBody, out);

   MHEG5indent(out);
   MHEG_PRINT(out, ":FontAttributes ");
   MHEG5stringPrint(application->fontAttributes, out);
   MHEG5newLine(out);

   MHEG5indent(out);
   MHEG_PRINT(out, ":BitmapCHook ");
   MHEG5intPrint(application->bitmapContentHook, out);
   MHEG5newLine(out);

   if (application->streamContentHook != 10)
   {
      MHEG5indent(out);
      MHEG_PRINT(out, ":StreamCHook: ");
      MHEG5intPrint(application->streamContentHook, out);
      MHEG5newLine(out);
   }
   if (application->textContentHook != 10)
   {
      MHEG5indent(out);
      MHEG_PRINT(out, ":TextCHook: ");
      MHEG5intPrint(application->textContentHook, out);
      MHEG5newLine(out);
   }
   if (application->lineArtContentHook != 0)
   {
      MHEG5indent(out);
      MHEG_PRINT(out, ":lineArtCHook: ");
      MHEG5intPrint(application->lineArtContentHook, out);
      MHEG5newLine(out);
   }
/*
   MHEG5indent(out);
   MHEG_PRINT(out,":InterchgPrgCHook ");
   MHEG5intPrint(application->interchangedProgramContentHook,out);
   MHEG5newLine(out);
   MHEG5indent(out);
   MHEG_PRINT(out,":buttonRefColour: ");
   MHEG5colourPrint(application->buttonRefColour,out);
   MHEG5newLine(out);

   MHEG5indent(out);
   MHEG_PRINT(out,":highlightRefColour: ");
   MHEG5colourPrint(application->highlightRefColour,out);
   MHEG5newLine(out);

   MHEG5indent(out);
   MHEG_PRINT(out,":sliderRefColour: ");
   MHEG5colourPrint(application->sliderRefColour,out);
   MHEG5newLine(out);
 */

   MHEG5decIndent();
   MHEG5indent(out);
   MHEG_PRINT(out, "}");
   MHEG5newLine(out);

   STB_DebugLogClose();
   MHEG5setIndent(save_indent);
}

#endif /* MH5PRINTOUT */

static void MHEG5unloadApp(void)
{
   #ifndef CI_PLUS_ONLY
   H_DsmControl dsmcc;
   H_ObjCarousel carousel;
   U16BIT sp;
   BOOLEAN changed;
   #endif

   assert( applStackCount != 0 );

#ifndef CI_PLUS_ONLY
   dsmcc = MHEG5_DsmccInstance();
   carousel = applStack[applStackCount].carousel_handle;

   assert( DSMCC_CurrentCarousel(dsmcc) == carousel );

   changed = (applStack[applStackCount - 1].carousel_handle != carousel) ? TRUE : FALSE;

   TRACE(TFILE, ("crsl_hdl=%p stk=%d name=%s", carousel, applStackCount, applStack[applStackCount].app_name.data))

   for (sp = 0; sp != applStackCount; sp++)
   {
      if (applStack[sp].carousel_handle == carousel)
      {
         /* Another application is using it - don't unload */
         carousel = NULL;
         break;
      }
   }
   if (carousel)
   {
      TRACE(TFILE, ("unload crsl_hdl=%p", carousel))
      applStack[applStackCount].carousel_handle = NULL;
      DSMCC_UnloadCarousel( dsmcc, carousel, RST_MODE_FORCE );
      #ifdef INCLUDE_IC
      MHEG5ClearTlsCertStore();
      #endif
   }
#endif

   MHEG5stringDestruct( &applStack[applStackCount].app_name );
   applStackCount--;

   #ifndef CI_PLUS_ONLY
   if (changed)
   {
      DSMCC_SetCurrentCarousel( dsmcc, applStack[applStackCount].carousel_handle );
   }
   #endif
}

#ifndef CI_PLUS_ONLY
void MHEG5applicationCarouselUnload( void *carousel, BOOLEAN isNdt )
{
   U16BIT sp, i;
   sp = 0;
   while (sp != applStackCount)
   {
      if (applStack[sp].carousel_handle == carousel)
      {
         MHEG5stringDestruct( &applStack[sp].app_name );
         for (i = sp; i != applStackCount; i++)
         {
            applStack[i] = applStack[i + 1];
         }
         applStack[applStackCount].app_name.data = NULL;
         applStack[applStackCount].app_name.len = 0;
         applStack[applStackCount].carousel_handle = NULL;
         applStackCount--;
      }
      else
      {
         sp++;
      }
   }
   if (applStack[applStackCount].carousel_handle == carousel)
   {
      applStack[applStackCount].carousel_handle = NULL;
      if (currentApplication != NULL && !isNdt)
      {
         MHEG5StartReboot(NULL);
      }
   }
}

void MHEG5applicationNDTcarouselAttach(void *carousel)
{
   TRACE(TFILE | TTUNE, ("****** app name len=%d Carousel=%p *******",
                         applStack[0].app_name.len, carousel))
   if (applStack[0].app_name.len)   /* just check it has a name */
   {
      applStack[0].carousel_handle = carousel;
   }
}

#endif

/* Clear the application stack */
void MHEG5applicationStackClear( BOOLEAN isNdt )
{
   MHEG5String appstr;
   int asc;
#ifndef CI_PLUS_ONLY
   H_ObjCarousel carousel;
   E_DsmRstMode mode = (isNdt) ? RST_MODE_PENDING : RST_MODE_FORCE;
#endif

   TRACE(TFILE | TTUNE, ("clearing app stack cnt=%d isNdt=%d", applStackCount, isNdt))
   appstr = applStack[applStackCount].app_name;
   applStack[applStackCount].app_name.data = NULL;
   applStack[applStackCount].app_name.len = 0;

   asc = (int)applStackCount;
   while (asc--)
   {
     #ifndef CI_PLUS_ONLY
      if (applStack[asc].carousel_handle != NULL)
      {
         TRACE(TFILE, ("asc=%d unload crsl_hdl=%p sa=%d", asc, applStack[asc].carousel_handle))
         carousel = applStack[asc].carousel_handle;
         applStack[asc].carousel_handle = NULL;
         DSMCC_UnloadCarousel( MHEG5_DsmccInstance(), carousel, mode );
         #ifdef INCLUDE_IC
         MHEG5ClearTlsCertStore();
         #endif
      }
     #else
      MHEG5stringDestruct( &applStack[asc].app_name );
     #endif  /* !CI_PLUS_ONLY */
   }
   if (isNdt)
   {
      applStack[0].app_name = appstr;
   }
   else
   {
      MHEG5stringDestruct( &appstr );
      currentApplication = 0;
   }
   applStackCount = 0;
   applStack[0].spawned = MHEG5FALSE;
   Restarted = MHEG5FALSE;
}

static U32BIT storageSizeForVariable(MHEG5Ingredient *v)
{
   U32BIT len;
   switch (((MHEG5Root *)v)->clazz)
   {
      case MHEG5CONTENTREFVARIABLE:
         len = ((MHEG5ContentVariable *) v)->contentData.len;
         len += sizeof(MHEG5Int);
         break;
      case MHEG5INTEGERVARIABLE:
         len = sizeof(MHEG5Int);
         break;
      case MHEG5BOOLEANVARIABLE:
         len = 1;
         break;
      case MHEG5OCTETSTRINGVARIABLE:
         len = ((MHEG5OctetStringVariable *) v)->value.len;
         len += sizeof(MHEG5Int);
         break;
      case MHEG5OBJECTREFVARIABLE:
         len = ((MHEG5ObjectRefVariable *) v)->valueGrp.len;
         len += sizeof(MHEG5Int) * 2;
         break;
      default:
         len = 0;
   }
   return len;
}

static void ClearGroupTargets(MHEG5ActionList actions, MHEG5Group *group)
{
   while (actions.total != 0)
   {
      /* Check if the target has been resolved and is an ingredient of
       * the given group, but not the group itself
       */
      if ((actions.a_ptr->target != NULL) &&
          (actions.a_ptr->target != (MHEG5Root *)group) &&
          (actions.a_ptr->target->grp == group))
      {
         /* "Unresolve" target */
         actions.a_ptr->firstParam = actions.a_ptr->origFirstParam;
         actions.a_ptr->target = NULL;
      }
      else if (actions.a_ptr->target == NULL)
      {
         /* Prepare link to be resolved again */
         actions.a_ptr->firstParam = actions.a_ptr->origFirstParam;
      }

      /* Move to next action */
      actions.a_ptr++;
      actions.total--;
   }
}

MHEG5Application* MHEG5getCurrentApplication(void)
{
   return currentApplication;
}

static void MHEG5applicationRetrieved( void *userData, S_CONTENT *content )
{
   MHEG5Scene *scene;
   MHEG5Application *application, *newApplication;
   MHEG5String path;
   E_ProfileId currentProfileId, newProfileId;

   TRACE(TMHBOOT | TFILE | TEVNTS, ("(%.*s)", (int)launchAppName.len, launchAppName.data))

   if (userData == NULL)
   {
      /* When userData is NULL we are NOT launching the Boot aaplication. So
       * event processing was disabled when the file load was initiated. Re-enable
       * event processing now to allow queued actions to execute.
       */
      MHEG5enableEventProcessing(MHEG5TRUE);
   }

   assert( content->data );

   /* BUG FIX - set working dir before parsing new application. Use gid used
    * to locate file, not gid from within script, since this may start with
    * "~/" or "/"
    */
   MHEG5setWorkingDir(launchAppName);

   /* Set profile - this is used while parsing the application, so must
    * be set before parsing. If parsing fails, the old profile is restored
    */
   currentProfileId = MH5_GetCurrentProfile();

   TRACE(TFILE, ("Got App (datalen=%ld)", (long)content->size))
   TRACE_MEM();

   if (*(content->data) == 0xA0) /* ASN1 */
   {
      /* Check profile to use (depends on GroupId) */
      newProfileId = PROFILE_BROADCAST;
      if (launchAppName.len >= 5)
      {
         if (memcmp(launchAppName.data, "CI://", 5) == 0)
         {
            /* CI:// application, use CI+ profile */
            newProfileId = PROFILE_CI_PLUS;
         }
      }
      MH5_SetCurrentProfile( newProfileId );

      newApplication = asn1_parseApplication( content->data, content->size );
      #ifdef MH5PRINTOUT
      if (mheg_trace_source)
         MHEG5applicationPrint(newApplication, 0);
      #endif
   }
   else /* TEXT */
   {
      TRACE(TERROR, ("This application is Text, and not ASN1 encoded!"))
      newApplication = NULL;
   }

   if (!newApplication)
   {
      TRACE(TERROR, ("Failed to parse application (%.*s)", (int)launchAppName.len, launchAppName.data))

      /* Revert to old profile */
      MH5_SetCurrentProfile( currentProfileId );

      /* Application did not parse; revert to old Event cache,
       */
      if (currentApplication)
      {
         if ((applStackCount > 0) && (applStack[applStackCount].spawned))
         {
            /* spawn failed */
            applStackCount--;
         }
      }

      MHEG5stringDestruct( &launchAppName );

      if (applStack[applStackCount].app_name.len)
      {
         /* reset working directory back to that for old and valid app, as the parse failed */
         MHEG5setWorkingDir(applStack[applStackCount].app_name);
      }
   }
   else    /* Application is valid */
   {
      MHEG5FileOrmReset(MHEG5_FILE_ORM_RESET_ALL_OBJECTS);

      application = currentApplication;
      if (application == NULL)
      {
         if (!Restarted && currentApplication == NULL)
         {
            /* Notify that a boot MHEG-5 Application has been launched. */
            MHEG5NotifyEngineStarted();
         }
      }
      else
      {
         if (applStackCount != 0 &&
             (applStack[applStackCount].spawned) &&
             (application->onSpawnCloseDown.a_ptr != NULL))
         {
            assert( MH5GlueActiveState() == TRUE );
            TRACE(TEVNTS, ("onSpawnCloseDown %p, %p", application, application->onSpawnCloseDown))
            MHEG5actionListExecute((MHEG5Group *)application, application->onSpawnCloseDown );
         }
         /* During destruction of an application triggered by Quit, Launch
          * or Spawn actions, any stream decoder associated with Stream
          * objects are not stopped. See UK1.05 section 6.3.4
          */
         application->streamContinuanceFlag = MHEG5TRUE;
      }

   #ifdef INCLUDE_IC
      if (applStackCount != 0 && applStack[applStackCount].spawned)
      {
         /* When spawning an application, the hybrid file system
          * should be saved
          */
         MHEG5PushHybridFileSystem();
      }
   #endif

      /* delete any old launch app name and save the new one */
      MHEG5stringDestruct( &applStack[applStackCount].app_name );
      applStack[applStackCount].app_name = launchAppName;

   #ifndef CI_PLUS_ONLY
      applStack[applStackCount].carousel_handle = DSMCC_CurrentCarousel( MHEG5_DsmccInstance());
   #endif

      /* Make the new application GID an absolute reference */
      path = MHEG5convertGID(&newApplication->group.groupName);
      MHEG5stringDestruct(&newApplication->group.groupName);
      newApplication->group.groupName = path;

      /* Prevent event processing while we destruct the scene and application */
      MHEG5stopEventsAndResetQueue();

      scene = MHEG5getCurrentScene();
      if (scene != 0)
      {
         MHEG5sceneDestruct(scene);
         MHEG5sceneFree(scene);
         MHEG5freeMem(scene);
      }

      if (application != 0)
      {
         MHEG5applicationDestruct(application);
         MHEG5applicationFree(application);
         MHEG5freeMem(application);
      }

      TRACE((TFILE | TPERFORM | TMEMORY), ("Stopped any App"))
      TRACE_MEM();
      #ifdef MHG_TRACK_MEM
      mh5emt_print(0xfe /*(1<<SRCMEM_OSD)|(1<<SRCMEM_APP)*/);
      #endif

      /* Reset receiver to default state */
      MHEG5restoreReceiverDefaults();

      /* Enable event processing again */
      MHEG5queueEvents();

      /* Move on to new application */
      currentApplication = newApplication;

      /* The application can forget that it was spawned */
      applStack[applStackCount].spawned = MHEG5FALSE;

      TRACE((TFILE | TPERFORM), ("Preparing %.*s", (int)newApplication->group.groupName.len, (char *)newApplication->group.groupName.data))
      MHEG5applicationPrepare(currentApplication);

      if (MH5GlueActiveState() == TRUE)
      {
         TRACE((TFILE | TPERFORM), ("Running App"))
         MHEG5ActivateCurrentApplication();
         TRACE((TFILE | TPERFORM), ("Started App"))
         TRACE_MEM();
      }
   }
   launchAppName.len = 0;
   launchAppName.data = 0;
   BootupFileOrmHandle = NULL;
}

/*
     Display Stack
 */


MHEG5Root* MHEG5displayStackGetVisible(MHEG5DisplayStackItem *item)
{
   assert(item);
   return item->item;
}

MHEG5DisplayStackItem* MHEG5displayStackBottom(void)
{
   if (!currentApplication)
   {
      return 0;
   }
   return currentApplication->displayStackBottom;
}

MHEG5DisplayStackItem* MHEG5displayStackPrev(MHEG5DisplayStackItem *item)
{
   assert(item);
   return item->prev;
}

MHEG5DisplayStackItem* MHEG5displayStackPrevVisible(MHEG5Root *visible)
{
   MHEG5DisplayStackItem *s;

   assert(visible);
   if (!currentApplication)
   {
      return 0;
   }
   s = currentApplication->displayStackTop;
   while (s && (s->item != visible))
   {
      s = s->next;
   }
   return s;
}

void MHEG5displayStackAdd(MHEG5Root *visible, MHEG5Bool atTop)
{
   MHEG5DisplayStackItem *s;

   CALL_PRINT((">> MHEG5displayStackAdd(%p %d)\n", visible, atTop));

   assert(visible);

   if (visible->clazz == MHEG5RTGRAPHICS)
   {
      /* RTGraphics objects are not added to the display stack. They cannot be
       * displayed independantly of a running VIdeo object
       */
      return;
   }

   if (!currentApplication)
   {
      WARNING_PRINT(("MHEG5displayStackAdd : currentApplication == Null\n"));
      CALL_PRINT(("<< MHEG5displayStackAdd\n"));
      return;
   }
   s = currentApplication->displayStackTop;
   while (s)
   {
      assert(s->item);
      if (s->item == visible)
      {
         DEBUG_PRINT(("MHEG5displayStackAdd : Item already in display stack\n"));
         CALL_PRINT(("<< MHEG5displayStackAdd\n"));
         return;
      }
      s = s->next;
   }
   s = (MHEG5DisplayStackItem *) MHEG5getMem(sizeof(MHEG5DisplayStackItem));
   if (!s)
   {
      ERROR_PRINT(("MHEG5displayStackAdd : MHEG5getMem failed\n"));
      CALL_PRINT(("<< MHEG5displayStackAdd\n"));
      return;
   }
   s->item = visible;
   s->next = 0;
   s->prev = 0;
   if (atTop == MHEG5TRUE)
   {
      if (currentApplication->displayStackTop)
      {
         currentApplication->displayStackTop->prev = s;
         s->next = currentApplication->displayStackTop;
         currentApplication->displayStackTop = s;
      }
      else
      {
         currentApplication->displayStackBottom = s;
         currentApplication->displayStackTop = s;
      }
   }
   else
   {
      if (currentApplication->displayStackBottom)
      {
         currentApplication->displayStackBottom->next = s;
         s->prev = currentApplication->displayStackBottom;
         currentApplication->displayStackBottom = s;
      }
      else
      {
         currentApplication->displayStackBottom = s;
         currentApplication->displayStackTop = s;
      }
   }

   CALL_PRINT(("<< MHEG5displayStackAdd\n"));
}

MHEG5Bool MHEG5displayStackDelete(MHEG5Root *visible)
{
   MHEG5DisplayStackItem *s;

   CALL_PRINT((">> MHEG5displayStackDelete(%p)\n", visible));

   assert(visible);
   if (!currentApplication)
   {
      WARNING_PRINT(("MHEG5displayStackDelete : currentApplication == Null\n"));
      CALL_PRINT(("<< MHEG5displayStackDelete MHEG5FALSE\n"));
      return MHEG5FALSE;
   }
   s = currentApplication->displayStackTop;
   while (s)
   {
      assert(s->item);
      if (s->item == visible)
      {
         if (s->prev)
         {
            s->prev->next = s->next;
         }
         else
         {
            currentApplication->displayStackTop = s->next;
         }
         if (s->next)
         {
            s->next->prev = s->prev;
         }
         else
         {
            currentApplication->displayStackBottom = s->prev;
         }
         MHEG5freeMem(s);
         CALL_PRINT(("<< MHEG5displayStackDelete MHEG5TRUE\n"));
         return MHEG5TRUE;
      }
      s = s->next;
   }

   CALL_PRINT(("<< MHEG5displayStackDelete MHEG5FALSE\n"));
   return MHEG5FALSE;
}

void MHEG5displayStackToTop(MHEG5Root *visible)
{
   CALL_PRINT((">> MHEG5displayStackToTop(%p)\n", visible));

   assert(visible);

   MHEG5displayStackDelete(visible);
   MHEG5displayStackAdd(visible, MHEG5TRUE);

   CALL_PRINT(("<< MHEG5displayStackToTop\n"));
}

void MHEG5displayStackToBottom(MHEG5Root *visible)
{
   CALL_PRINT((">> MHEG5displayStackToBottom(%p)\n", visible));

   assert(visible);

   MHEG5displayStackDelete(visible);
   MHEG5displayStackAdd(visible, MHEG5FALSE);

   CALL_PRINT(("<< MHEG5displayStackToBottom\n"));
}

void MHEG5displayStackPutBefore(MHEG5Root *target, MHEG5Root *refVisible)
{
   MHEG5DisplayStackItem *s, *w;

   CALL_PRINT((">> MHEG5displayStackPutBefore(%p, %p)\n", target, refVisible));

   assert(target);
   assert(refVisible);

   if (!currentApplication)
   {
      WARNING_PRINT(("MHEG5displayStackPutBefore : currentApplication == Null\n"));
      CALL_PRINT(("<< MHEG5displayStackPutBefore\n"));
      return;
   }
   if (target == refVisible)
   {
      WARNING_PRINT(("MHEG5displayStackPutBefore : target == refVisible\n"));
      CALL_PRINT(("<< MHEG5displayStackPutBefore\n"));
      return;
   }
   w = currentApplication->displayStackTop;
   s = (MHEG5DisplayStackItem *) MHEG5getMem(sizeof(MHEG5DisplayStackItem));
   if (!s)
   {
      CALL_PRINT(("<< MHEG5displayStackPutBefore\n"));
      return;
   }
   s->item = target;
   s->next = 0;
   s->prev = 0;
   while (w)
   {
      assert(w->item);
      if (w->item == refVisible)
      {
         /* Found refVisible in display stack */
         if (MHEG5displayStackDelete(target))
         {
            /* Target existed in the display stack. Reinsert */
            if (w->prev)
            {
               s->prev = w->prev;
               s->next = w;
               s->prev->next = s;
               w->prev = s;
            }
            else
            {
               s->next = w;
               w->prev = s;
               currentApplication->displayStackTop = s;
            }
         }
         CALL_PRINT(("<< MHEG5displayStackPutBefore\n"));
         return;
      }
      w = w->next;
   }

   /* Unable to find refVisible in display stack. */
   MHEG5freeMem(s);

   WARNING_PRINT(("MHEG5displayStackPutBefore : Unable to find refVisible in display stack\n"));
   CALL_PRINT(("<< MHEG5displayStackPutBefore\n"));
}

void MHEG5displayStackPutBehind(MHEG5Root *target, MHEG5Root *refVisible)
{
   MHEG5DisplayStackItem *s, *w;

   CALL_PRINT((">> MHEG5displayStackPutBehind(%p, %p)\n", target, refVisible));

   assert(target);
   assert(refVisible);
   if (!currentApplication)
   {
      WARNING_PRINT(("MHEG5displayStackPutBehind : currentApplication == Null\n"));
      CALL_PRINT(("<< MHEG5displayStackPutBehind\n"));
      return;
   }
   if (target == refVisible)
   {
      WARNING_PRINT(("MHEG5displayStackPutBehind : target == refVisible\n"));
      CALL_PRINT(("<< MHEG5displayStackPutBehind\n"));
      return;
   }
   w = currentApplication->displayStackTop;
   s = (MHEG5DisplayStackItem *) MHEG5getMem(sizeof(MHEG5DisplayStackItem));
   if (!s)
   {
      CALL_PRINT(("<< MHEG5displayStackPutBehind\n"));
      return;
   }
   s->item = target;
   s->next = 0;
   s->prev = 0;
   while (w)
   {
      assert(w->item);
      if (w->item == refVisible)
      {
         /* Found refVisible in display stack */
         if (MHEG5displayStackDelete(target))
         {
            /* Target existed in the display stack. Reinsert */
            if (w->next)
            {
               s->next = w->next;
               s->prev = w;
               s->next->prev = s;
               w->next = s;
            }
            else
            {
               s->prev = w;
               w->next = s;
               currentApplication->displayStackBottom = s;
            }
         }
         CALL_PRINT(("<< MHEG5displayStackPutBehind\n"));
         return;
      }
      w = w->next;
   }

   /* Unable to find refVisible in display stack. */
   MHEG5freeMem(s);

   WARNING_PRINT(("MHEG5displayStackPutBehind : Unable to find refVisible in display stack\n"));
   CALL_PRINT(("<< MHEG5displayStackPutBehind\n"));
}

void MHEG5applicationInit(MHEG5Application *application)
{
   assert(application);

   MHEG5groupInit(&application->group);

   MHEG5colourInit(&application->backgroundColour, OSDgetColour(TRANSPARENTCOLOR));
   MHEG5colourInit(&application->textColour, OSDgetColour(DEFAULTTEXTCOLOR));
   MHEG5colourInit(&application->buttonRefColour, OSDgetColour(DEFAULTBUTTONCOLOR));
   MHEG5colourInit(&application->highlightRefColour, OSDgetColour(DEFAULTHIGHLIGHTCOLOR));
   MHEG5colourInit(&application->sliderRefColour, OSDgetColour(DEFAULTSLIDERCOLOR));
   MHEG5colourInit(&application->desktopColour, OSDgetColour(DEFAULTDESKTOPCOLOUR));

   /* Choose some sensible defaults for the following values. These are no
    * specified by MHEG5 specification, but have been added for defensive
    * receiver behaviour.
    */
   application->characterSet = 10;
   application->bitmapContentHook = 4;
   application->streamContentHook = 10;
   application->textContentHook = 10;
}

void MHEG5applicationFree(MHEG5Application *application)
{
   assert(application);

   MHEG5groupFree(&application->group);

   MHEG5actionDestruct(application->onSpawnCloseDown);
   MHEG5actionDestruct(application->onRestart);
   MHEG5colourDestruct(&application->backgroundColour);
   MHEG5colourDestruct(&application->textColour);
   if (application->fontBody.referenced)
   {
      if (application->fontBody.ref.referenced.grp.len)
      {
         MHEG5stringDestruct((MHEG5String *)&application->fontBody.ref.referenced.grp);
      }
   }
   else
   {
      MHEG5stringDestruct(&application->fontBody.ref.included);
   }
   MHEG5stringDestruct(&application->fontAttributes);
   MHEG5colourDestruct(&application->buttonRefColour);
   MHEG5colourDestruct(&application->highlightRefColour);
   MHEG5colourDestruct(&application->sliderRefColour);
}

void MHEG5applicationPrepare(MHEG5Application *application)
{
   int mcnt;
   MHEG5Ingredient *item;
   MHEG5Bool foundAudio = MHEG5FALSE;
   MHEG5Bool foundVideo = MHEG5FALSE;
#ifndef MHEG5PROFILE_UK1_06
   MHEG5Bool foundRTGraphics = MHEG5FALSE;
#endif

   assert(application);

   application->lockCount = 0;

   if (application->onSpawnCloseDown.a_ptr)
   {
      TRACE(TEVNTS, ("onSpawnCloseDown %p, %p", application, application->onSpawnCloseDown))
      MHEG5queueResolveTargets( application->onSpawnCloseDown );
   }
   if (application->onRestart.a_ptr)
   {
      TRACE(TEVNTS, ("onRestart %p, %p", application, application->onRestart))
      MHEG5queueResolveTargets( application->onRestart );
   }

   /* Call base class preparation */
   MHEG5groupPrepare(&application->group);

   /* Check for stream decoder components that are not present in the new
    * application and deactivate any that have been continued from the previous
    * application. See section 6.3.3 and 6.3.4 of UK profile 1.05
    */
   item = application->group.itemHead;
   while (item)
   {
      /* Check whether this item is an initially active stream object */
      if ((item->root.clazz == MHEG5STREAM) && (!item->initiallyStopped))
      {
         /* Search all multiplex items of the stream object for initially
          * active multiplex objects.
          */
         mcnt = 0;
         while ((mcnt != MAX_MLTPLX) && (((MHEG5Stream *)item)->multiplex[mcnt]))
         {
            if (!((MHEG5Stream *)item)->multiplex[mcnt]->initiallyStopped)
            {
               switch (((MHEG5Stream *)item)->multiplex[mcnt]->root.clazz)
               {
                  case MHEG5AUDIO:
                     /* Found an audio object */
                     foundAudio = MHEG5TRUE;
                     break;
                  case MHEG5VIDEO:
                     /* Found a video object */
                     foundVideo = MHEG5TRUE;
                     break;
                  #ifndef MHEG5PROFILE_UK1_06
                  case MHEG5RTGRAPHICS:
                     /* Found an RTGraphics object */
                     foundRTGraphics = MHEG5TRUE;
                     break;
                  #endif
                  default:
                     ERROR_PRINT(("ERROR: Unexpected object in stream multiplex\n"));
                     break;
               }
            }
            mcnt++;
         }
      }
      item = item->next;
   }

   if (!foundAudio)
   {
      /* There are no Audio objects currently active. Stop audio media
       * decoders.
       */
      MHEG5displayAudioStop();
   }

   if (!foundVideo)
   {
      /* There are no Video objects currently active. Stop video media
       * decoders.
       */
      MHEG5displayVideoStop();
   }

#ifndef MHEG5PROFILE_UK1_06
   if (!foundRTGraphics)
   {
      /* There are no RTGraphics objects currently active. Stop RTGraphics
       * media decoders.
       */
      MHEG5displayRtgraphicsStop();
   }
#endif
}

void MHEG5applicationDestruct(MHEG5Application *application)
{
   MHEG5DisplayStackItem *t;

   if (!application)
   {
      return;
   }
#ifdef INCLUDE_TPS
   MHEG5TpsClose();
#endif
#if defined(INCLUDE_CI_PLUS)
   MHEG5SuppressMHEGGraphics(MHEG5FALSE);
#endif
   MHEG5groupDestruct(&application->group);

   while (application->displayStackTop)
   {
      t = application->displayStackTop;
      application->displayStackTop = application->displayStackTop->next;
      MHEG5freeMem(t);
   }
   application->displayStackBottom = 0;

   if (application == currentApplication)
   {
      currentApplication = 0;

      /* Could check that there are no links in the active Link list. */
      /*
         MHEG5EventType et;
         for (et=MHEG5NONEEVENT;et!=MHEG5LASTEVENT;et++)
         assert(MHEG5linkGetActiveLinks(et) == 0);
       */
   }
}

void MHEG5ActivateCurrentApplication(void)
{
   if (!currentApplication->group.root.runningStatus)
   {
      /* Clear the screen */
      MHEG5displayClear();

      /* Streams should only be synchronised when IsRunning has been
       * processed.
       */
      MHEG5displayLockStreams();
      MHEG5groupActivate(&currentApplication->group);

      /* Execute the OnRestart elementary action of the newly activated
       * Application object
       */
      if ((Restarted) && (currentApplication->onRestart.a_ptr != NULL))
      {
         TRACE(TEVNTS, ("onRestart %p, %p", currentApplication, currentApplication->onRestart))
         MHEG5actionListExecute((MHEG5Group *)currentApplication, currentApplication->onRestart );
      }
      Restarted = MHEG5FALSE;
   }
}

void MHEG5applicationDeactivate(MHEG5Application *application)
{
   assert(application);
   /*
        ToDo: CloseConnection
    */
#ifdef MHEG5LOG
   MHEG5LogPrintf(MHEG5CALLS, "App Deactivate ");
   MHEG5LogPrintObjectPtr(MHEG5CALLS, (MHEG5Root *) application);
   MHEG5LogPrintf(MHEG5CALLS, "\n");
#endif

   MHEG5groupDeactivate(&application->group);
}

/*
     Actions
 */
MHEG5ErrorCode MHEG5storePersistent(MHEG5Root *target, MHEG5GList *params)
{
   MHEG5Root *rc = 0, *param = 0;
   MHEG5GList *thirdParam, *lastParam;
   char *buf = NULL;
   MHEG5Int error = 0, pos = 0;
   MHEG5String fn;
   MHEG5Bool invalidString;
   MHEG5ErrorCode returnCode = MHEG5ERR_NOERROR;

   MHEG5Root *peek_param;  /*Used for peeking at parameters to find buffer length*/
   MHEG5GList *nextParam;
   U32BIT buffer_length = 0;
#ifdef INCLUDE_FREESAT
   MHEG5Int expires = -1;
   MHEG5Int priority = -1;
#endif
   assert(target);

   if (target != (MHEG5Root *) currentApplication)
   {
      return MHEG5ERR_WRONGTARGET;
   }
   if (!params)
   {
      return MHEG5ERR_WRONGNUMBEROFPARAMS;
   }
   thirdParam = MHEG5resolveORef(params, &rc);
   if (!rc)
   {
      return MHEG5ERR_REFERENCEDPARAMNOTAVAILABLE;
   }
   if (rc->clazz != MHEG5BOOLEANVARIABLE)
   {
      return MHEG5ERR_WRONGPARAM;
   }
   if (!thirdParam)
   {
      return MHEG5ERR_WRONGNUMBEROFPARAMS;
   }
   if (thirdParam->generic.type != MHEG5BRACKETOPEN)
   {
      return MHEG5ERR_WRONGPARAM;
   }

   ((MHEG5BooleanVariable *) rc)->value = MHEG5FALSE;

   /* Find the end of the variable list so that we can get the file name */
   lastParam = thirdParam;
   while (lastParam->next)
   {
      lastParam = lastParam->next;
   }

   /* Get the file name */
   fn.len = 0;
   MHEG5resolveGenericOctetString(lastParam, &fn, &invalidString);
   if ((invalidString) || (fn.len == 0))
   {
      /* Parameter was not an octet string or a zero length string */
      return MHEG5ERR_WRONGPARAM;
   }
   thirdParam = thirdParam->next;
#ifdef INCLUDE_FREESAT
   if (MH5_SupportMhegProfile(CPROFILE_FREESAT) &&
       fn.len >= 6 && memcmp(fn.data, "nvm://", 6) == 0)
   {
      if (thirdParam && (thirdParam->generic.type != MHEG5BRACKETCLOSE))
      {
         thirdParam = MHEG5resolveORef(thirdParam, &param);
         if (param->clazz == MHEG5INTEGERVARIABLE)
         {
            expires = ((MHEG5IntegerVariable *)param)->value;
         }
      }
      if (thirdParam && (thirdParam->generic.type != MHEG5BRACKETCLOSE))
      {
         thirdParam = MHEG5resolveORef(thirdParam, &param);
         if (param->clazz == MHEG5INTEGERVARIABLE)
         {
            priority = ((MHEG5IntegerVariable *)param)->value;
         }
      }
   }
#endif

   peek_param = param;
   nextParam = thirdParam;
   while (nextParam && (nextParam->generic.type != MHEG5BRACKETCLOSE))
   {
      nextParam = MHEG5resolveORef(nextParam, &peek_param);
      if (!peek_param)
      {
         return MHEG5ERR_WRONGPARAM;
      }
      buffer_length += storageSizeForVariable((MHEG5Ingredient *)peek_param);
   }
   if (buffer_length > (U32BIT)MH5_MaxStorageFileLength())
   {
      return MHEG5ERR_WRONGPARAM;
   }
   buf = MHEG5getMem(buffer_length);
   if (buf != NULL)
   {
      while (thirdParam && (thirdParam->generic.type != MHEG5BRACKETCLOSE))
      {
         thirdParam = MHEG5resolveORef(thirdParam, &param);
         error = MHEG5variableStore((MHEG5Ingredient *)param, &buf[pos], buffer_length - pos);
         if (error < 0)
         {
            ((MHEG5BooleanVariable *) rc)->value = MHEG5FALSE;
            MHEG5freeMem(buf);
            return MHEG5ERR_NOERROR;
         }
         pos += error;
      }

      if (fn.len > 6 && memcmp(fn.data, "ram://", 6) == 0)
      {
         ((MHEG5BooleanVariable *) rc)->value = MHEG5storageWrite(fn, buf, pos);
         returnCode = MHEG5ERR_NOERROR;
      }
#ifdef INCLUDE_NVM
      else if (!MH5_SupportMhegProfile(CPROFILE_FREESAT) &&
               fn.len >= 6 && memcmp(fn.data, "nvm://", 6) == 0)
      {
         fn.data += 6; fn.len -= 6;
         ((MHEG5BooleanVariable *) rc)->value = MHEG5nvmWrite(fn, buf, pos);
         returnCode = MHEG5ERR_NOERROR;
      }
#endif  /*INCLUDE_NVM*/
#ifdef INCLUDE_TPS
      else if (fn.len >= 6 && memcmp(fn.data, "pst://", 6) == 0)
      {
         fn.data += 6;
         fn.len -= 6;
         ((MHEG5BooleanVariable *) rc)->value = MHEG5TpsWrite(fn, buf, pos);
         returnCode = MHEG5ERR_NOERROR;
      }
#endif  /*INCLUDE_TPS*/
#ifdef INCLUDE_FREESAT
      else if (MH5_SupportMhegProfile(CPROFILE_FREESAT) &&
               fn.len >= 6 && memcmp(fn.data, "nvm://", 6) == 0)
      {
         fn.data += 6; fn.len -= 6;
         ((MHEG5BooleanVariable *) rc)->value = MHEG5FSnvmWrite(fn, buf, pos, expires, priority);
         returnCode = MHEG5ERR_NOERROR;
      }
#endif  /*INCLUDE_FREESAT*/
      else
      {
         ((MHEG5BooleanVariable *) rc)->value = MHEG5FALSE;
         returnCode = MHEG5ERR_WRONGPARAM;
      }
      if (buf)
      {
         MHEG5freeMem(buf);
      }
   }
   return returnCode;
}

MHEG5ErrorCode MHEG5readPersistent(MHEG5Root *target, MHEG5GList *params)
{
   MHEG5Root *rc = 0, *param = 0;
   MHEG5GList *thirdParam, *lastParam;
   char *buf;
   MHEG5Int len;
   MHEG5Int error = 0, pos = 0;
   MHEG5Bool getSuccess = MHEG5FALSE;
   MHEG5String fn;
   MHEG5Bool invalidString;
   MHEG5Int maximum_len;
#ifdef INCLUDE_FREESAT
   MHEG5String short_fn;
   MHEG5Int expires;
   MHEG5Int priority;
#endif
   assert(target);

   if (target != (MHEG5Root *) currentApplication)
   {
      return MHEG5ERR_WRONGTARGET;
   }
   if (!params)
   {
      return MHEG5ERR_WRONGNUMBEROFPARAMS;
   }
   thirdParam = MHEG5resolveORef(params, &rc);
   if (!rc)
   {
      return MHEG5ERR_REFERENCEDPARAMNOTAVAILABLE;
   }
   if (rc->clazz != MHEG5BOOLEANVARIABLE)
   {
      return MHEG5ERR_WRONGPARAM;
   }
   if (!thirdParam)
   {
      return MHEG5ERR_WRONGNUMBEROFPARAMS;
   }
   if (thirdParam->generic.type != MHEG5BRACKETOPEN)
   {
      return MHEG5ERR_WRONGPARAM;
   }
   thirdParam = thirdParam->next;
   if (!thirdParam)
   {
      return MHEG5ERR_WRONGNUMBEROFPARAMS;
   }

   /* Find the end of the variable list so that we can get the file name */
   lastParam = thirdParam;
   while (lastParam->next)
   {
      lastParam = lastParam->next;
   }

   /* Get the file name */
   fn.len = 0;
   MHEG5resolveGenericOctetString(lastParam, &fn, &invalidString);
   if ((invalidString) || (fn.len == 0))
   {
      /* Parameter was not an octet string or a zero length string */
      return MHEG5ERR_WRONGPARAM;
   }

   if (fn.len > 6 && memcmp(fn.data, "ram://", 6) == 0)
   {
      getSuccess = MHEG5storageRead(fn, (void **) &buf, &len);
   }
#ifdef INCLUDE_NVM
   else if (!MH5_SupportMhegProfile(CPROFILE_FREESAT) &&
            fn.len >= 6 && memcmp(fn.data, "nvm://", 6) == 0)
   {
      fn.data += 6; fn.len -= 6;
      getSuccess = MHEG5nvmRead(fn, (void **) &buf, &len);
   }
#endif /*INCLUDE_NVM */
#ifdef INCLUDE_FREESAT
   else if (MH5_SupportMhegProfile(CPROFILE_FREESAT) &&
            fn.len >= 6 && memcmp(fn.data, "nvm://", 6) == 0)
   {
      short_fn.data = fn.data + 6;
      short_fn.len = fn.len - 6;
      getSuccess = MHEG5FSnvmRead(short_fn, (void **) &buf, &len, &expires, &priority);
   }
#endif /*INCLUDE_FREESAT */
#ifdef INCLUDE_TPS
   else if (fn.len >= 6 && memcmp(fn.data, "pst://", 6) == 0)
   {
      fn.data += 6;
      fn.len -= 6;
      getSuccess = MHEG5TpsRead(fn, (void **) &buf, &len);
   }
#endif /*INCLUDE_TPS */
   if (!getSuccess)
   {
      ((MHEG5BooleanVariable *) rc)->value = MHEG5FALSE;
      return MHEG5ERR_NOERROR;
   }
   maximum_len = MH5_MaxStorageFileLength();
#ifdef INCLUDE_FREESAT
   if (MH5_SupportMhegProfile(CPROFILE_FREESAT) &&
       fn.len >= 6 && memcmp(fn.data, "nvm://", 6) == 0)
   {
      if (thirdParam && (thirdParam->generic.type != MHEG5BRACKETCLOSE))
      {
         thirdParam = MHEG5resolveORef(thirdParam, &param);
         error = MHEG5variableRead((MHEG5Ingredient *)param, (void *)&expires, maximum_len);
         if (error < 0)
         {
            ((MHEG5BooleanVariable *) rc)->value = MHEG5FALSE;
            return MHEG5ERR_NOERROR;
         }
      }
      if (thirdParam && (thirdParam->generic.type != MHEG5BRACKETCLOSE))
      {
         thirdParam = MHEG5resolveORef(thirdParam, &param);
         error = MHEG5variableRead((MHEG5Ingredient *)param, (void *)&priority, maximum_len);
         if (error < 0)
         {
            ((MHEG5BooleanVariable *) rc)->value = MHEG5FALSE;
            return MHEG5ERR_NOERROR;
         }
      }
   }
#endif
   /* Now start reading the variables to copy into */
   while (thirdParam && (thirdParam->generic.type != MHEG5BRACKETCLOSE))
   {
      thirdParam = MHEG5resolveORef(thirdParam, &param);
      if (pos >= len)
      {
         /* Too many parameters to read, not enough data */
         return MHEG5ERR_WRONGNUMBEROFPARAMS;
      }
      error = MHEG5variableRead((MHEG5Ingredient *)param, &buf[pos], maximum_len);
      if (error < 0)
      {
         ((MHEG5BooleanVariable *) rc)->value = MHEG5FALSE;
         return MHEG5ERR_NOERROR;
      }
      pos += error;
   }
   ((MHEG5BooleanVariable *) rc)->value = MHEG5TRUE;
   return MHEG5ERR_NOERROR;
}

static void MHEG5applicationRetrieveFail( void *userData )
{
   USE_UNWANTED_PARAM(userData);

   /* Re-enable event processing following a failed Application Launch/Spawn/Quit */
   MHEG5enableEventProcessing(MHEG5TRUE);
   if (currentApplication)
   {
      /* Raise a GroupIDRefError engine event */
      MHEG5sendEvent((MHEG5Root *)currentApplication, MHEG5ENGINEEVENT, EE_GROUP_ID_REF_ERROR );
   }

   TRACE(TERROR, ("%d, Failed to retrieve App %.*s", applStackCount, (int)launchAppName.len, launchAppName.data))

   assert( launchAppName.len );

   if (applStackCount == 0)
   {
      if (applStack[0].app_name.data == launchAppName.data)
      {
      #ifndef CI_PLUS_ONLY
         if (applStack[0].carousel_handle != NULL)
         {
            /* NDT app had spawned app2 which then quit,
             * the original NDT app is not on carousel so do reboot */
            MHEG5StartReboot(NULL);
         }
      #endif
         applStack[0].app_name.data = NULL;
      }
   }
   else if (applStack[applStackCount].spawned)
   {
      /* spawn failed */
      applStackCount--;
   }

   MHEG5stringDestruct( &launchAppName );
}

static void MHEG5applicationBootFail( void *userData )
{
   S_BOOT_DATA *pBootData = (S_BOOT_DATA *)userData;
   U32BIT stage = pBootData->stage;
   MHEG5String oldName = launchAppName;

   TRACE(TMHBOOT, ("%d, Failed to retrieve App %.*s", applStackCount, (int)launchAppName.len, launchAppName.data))

   assert( pBootData );
   assert( launchAppName.len );
   assert( currentApplication == NULL );
   assert( applStackCount == 0 );
   assert( pBootData->origin < 3 );

   switch (stage)
   {
      case 0: launchAppName.len = oldName.len + 2; break;
      case 1: launchAppName.len = oldName.len + 6; break;
      case 2: launchAppName.len = boot_origins[pBootData->origin].len + 1; break;
      case 3: launchAppName.len = boot_origins[pBootData->origin].len + 7; break;
      default: launchAppName.len = 0;
   }
   if (launchAppName.len)
   {
      launchAppName.data = (MHEG5Byte *) STR_DataAlloc( launchAppName.len );
      if (launchAppName.data == 0)
      {
         TRACE(TERROR, ("Out of Memory"))
         launchAppName.len = 0;
         MHEG5stringDestruct( &oldName );
      }
      else
      {
         switch (stage)
         {
            case 0:
               memcpy(launchAppName.data, oldName.data, oldName.len);
               launchAppName.data[oldName.len] = '/';
               launchAppName.data[oldName.len + 1] = 'a';
               break;

            case 1:
               memcpy(launchAppName.data, oldName.data, oldName.len);
               launchAppName.data[oldName.len - 1] = '\0'; /* overwrite 'a' */
               strcat((char *)launchAppName.data, "startup");
               break;

            case 2:
               strcpy((char *)launchAppName.data, (char *)boot_origins[pBootData->origin].data );
               strcat((char *)launchAppName.data, "a");
               break;

            case 3:
               strcpy((char *)launchAppName.data, (char *)boot_origins[pBootData->origin].data );
               strcat((char *)launchAppName.data, "startup");
               break;

            default:
               assert( 0 );
         }
      }
      pBootData->stage++;
      MHEG5stringDestruct( &oldName );

      BootupFileOrmHandle = MHEG5FileOrmGet( launchAppName, FRP_APPLICATION | FRP_CACHE_DEFAULT,
            (void *)pBootData, MHEG5applicationRetrieved, MHEG5applicationBootFail );
   }
   else
   {
      MHEG5stringDestruct( &oldName );
      /* Notify that we were unable to find the startup application */
      MHEG5NotifyEngineStartFailed();
   }
   BootupFileOrmHandle = NULL;
}

MHEG5ErrorCode MHEG5applicationLaunch(MHEG5String gname, MHEG5Int id)
{
   MHEG5ErrorCode err = MHEG5ERR_NOERROR;
   TRACE((TFILE | TPERFORM), ("Launch App %.*s", (int)gname.len, gname.data))

   USE_UNWANTED_PARAM(id);

   assert( launchAppName.len == 0 );

   launchAppName = MHEG5convertGID( &gname );

   if (launchAppName.len == 0)
   {
      ERROR_PRINT(("ERROR: MHEG5Applaunch - failed to resolve path\n"));
      if (currentApplication != NULL)
      {
         /* Generate GroupIDRefError EngineEvent */
         MHEG5sendEvent((MHEG5Root *)currentApplication, MHEG5ENGINEEVENT, 2);
      }
      err = MHEG5ERR_IGNORE_ACTION; /*could have something else*/
   }
   else
   {
      assert( launchAppName.data );

      /* The file retrieval process is asynchronous, but any queued actions
       * should not be processed until the file is loaded. Therefore we
       * disable event processing whilst loading this file.
       */
      MHEG5enableEventProcessing(MHEG5FALSE);

      TRACE(TFILE | TEVNTS, ("(%.*s)", (int)launchAppName.len, launchAppName.data))

      /* Retreive the file. We do not know the content cache priority yet, so
       * use the default
       */
         (void) MHEG5FileOrmGet( launchAppName, FRP_APPLICATION | FRP_CACHE_DEFAULT,
         NULL, MHEG5applicationRetrieved, MHEG5applicationRetrieveFail );
   }
   return err;
}

MHEG5ErrorCode MHEG5applicationBootup( char *app_name, BOOLEAN single )
{
   static S_BOOT_DATA BootData;
   MHEG5String name;
   MHEG5ErrorCode err = MHEG5ERR_NOERROR;

#ifndef NDEBUG
   assert( currentApplication == NULL );
#else
   if (currentApplication != NULL)
   {
      return MHEG5ERR_NOERROR;
   }
#endif

   /* Check provided appliction name not blank */
   if ((app_name == NULL) || (strlen(app_name) == 0))
   {
      BootData.stage = 3;
      #ifdef INCLUDE_IC
      if (MH5_SupportInteractionChannel())
      {
         BootData.origin = ORIGIN_HYBRID;
      }
      else
      #endif
      {
         BootData.origin = ORIGIN_DSM;
      }

      launchAppName.len = boot_origins[BootData.origin].len + 1;

      launchAppName.data = (MHEG5Byte *) STR_DataAlloc( launchAppName.len );
      if (launchAppName.data == 0)
      {
         TRACE(TERROR, ("Out of Memory"))
         launchAppName.len = 0;
      }
      else
      {
         strcpy((char *)launchAppName.data, (char *)boot_origins[BootData.origin].data );
         strcat((char *)launchAppName.data, "a" );
      }
   }
   else
   {
      name.len = 0;
      /* Replace all '\' with '/' */
      while (app_name[name.len] != '\0')
      {
         if (app_name[name.len] == '\\')
         {
            app_name[name.len] = '/';
         }
         name.len++;
      }

      /* Remove all '/' from end of application name */
      while (name.len != 0 && app_name[name.len - 1] == '/')
      {
         name.len--;
         app_name[name.len] = '\0';
      }

      name.data = (MHEG5Byte *)app_name;

      /* Convert using name mapping rules */
      launchAppName = MHEG5convertGIDGetOrigin( &name, &BootData.origin );
      if (launchAppName.len != 0)
      {
         if ( BootData.origin == ORIGIN_CI || single )
         {
            BootData.stage = 4;
         }
         else
         {
            /* DSM-CC or hybrid origin */
            BootData.stage = 0;
         }
      }
   }
   TRACE(TMHBOOT | TFILE, ("(%.*s)", (int)launchAppName.len, launchAppName.data))
   if (launchAppName.len)
   {
      MHEG5setWorkingDir( launchAppName );
      BootupFileOrmHandle = MHEG5FileOrmGet( launchAppName, FRP_APPLICATION | FRP_CACHE_DEFAULT,
            &BootData, MHEG5applicationRetrieved, MHEG5applicationBootFail );
   }
   else
   {
      err = MHEG5ERR_TARGETNOTAVAILABLE;
      TRACE(TERROR, (""))
   }
   return err;
}

void MHEG5applicationBootAbort( void )
{
   if (BootupFileOrmHandle != NULL)
   {
      MHEG5FileOrmClear( BootupFileOrmHandle );

      MHEG5stringDestruct( &launchAppName );
   }
}

void MHEG5applicationClearGroupTargets(MHEG5Application *application,
   MHEG5Group *group)
{
   MHEG5Ingredient *item;
   MHEG5Link *link;

   /* Check every link */
   item = application->group.itemHead;
   while (item)
   {
      /* Check whether this item is an initially active stream object */
      if ((item->root.clazz == MHEG5LINK) &&
          (item->root.availabilityStatus == MHEG5TRUE))
      {
         link = (MHEG5Link *)item;
         ClearGroupTargets(link->linkEffect, group);
      }
      item = item->next;
   }

   /* Check OnSpawnCloseDown */
   ClearGroupTargets(application->onSpawnCloseDown, group);

   /* Check OnRestart */
   ClearGroupTargets(application->onRestart, group);
}

void MHEG5applicationResolveTargets(MHEG5Application *application)
{
   MHEG5Ingredient *item;
   MHEG5Link *link;

   /* Check every link */
   item = application->group.itemHead;
   while (item)
   {
      /* Check whether this item is an initially active stream object */
      if ((item->root.clazz == MHEG5LINK) &&
          (item->root.availabilityStatus == MHEG5TRUE))
      {
         link = (MHEG5Link *)item;
         MHEG5queueResolveTargets(link->linkEffect);
      }
      item = item->next;
   }

   /* Check OnSpawnCloseDown */
   MHEG5queueResolveTargets(application->onSpawnCloseDown);

   /* Check OnRestart */
   MHEG5queueResolveTargets(application->onRestart);
}

MHEG5ErrorCode MHEG5launch(MHEG5Root *target, MHEG5GList *params)
{
   MH5GroupRef gref;
   MHEG5Int id = 0;
   MHEG5ErrorCode err;

   /* Resolve a generic object reference, returning groupName and Id of the
    * reference
    */
   MHEG5resolveGenericORefProper(params, &gref, &id);

   if ((id != 0) || (gref.len == 0))
   {
      ERROR_PRINT(("ERROR: MHEG5launch - id not zero (%ld) or name len zero (%ld)\n", id, gref.len));
      err = MHEG5ERR_IGNORE_ACTION;   /*could have something else*/
   }
   else if (currentApplication && MHEG5sameGroup(&currentApplication->group, gref))
   {
      /* Ignore a Spawn to the currently running Application */
      WARNING_PRINT(("MHEG5launch - abort, application already active\n"));
      err = MHEG5ERR_IGNORE_ACTION;
   }
   else
   {
      MHEG5String name;
      name.len = gref.len;
      name.data = gref.ptr.name;
      TRACE((TFILE | TPERFORM), ("launch app %.*s id=%ld", (int)name.len, name.data, id))
      err = MHEG5applicationLaunch( name, id);
   }
   return err;
}

MHEG5ErrorCode MHEG5spawn(MHEG5Root *target, MHEG5GList *params)
{
   MHEG5ErrorCode err = MHEG5ERR_IGNORE_ACTION;

   if (applStackCount < (MAX_APPS - 1))
   {
      applStackCount++;
      applStack[applStackCount].app_name.len = 0;
      applStack[applStackCount].app_name.data = NULL;
      applStack[applStackCount].carousel_handle = NULL;
      applStack[applStackCount].spawned = MHEG5TRUE;

      err = MHEG5launch(target, params);
      if (err != MHEG5ERR_NOERROR)
      {
         /* Spawn failed, restore stack pointer */
         applStackCount--;
      }
   }
   else
   {
      /* stack is full, launch instead */
      err = MHEG5launch(target, params);
   }

   return err;
}

MHEG5ErrorCode MHEG5quit(MHEG5Root *target, MHEG5GList *params)
{
   assert(target);

   if (target != (MHEG5Root *) currentApplication)
   {
      return MHEG5ERR_WRONGTARGET;
   }

   MHEG5quitApp();

   return MHEG5ERR_NOERROR;
}

void MHEG5quitApp(void)
{
   MHEG5Scene *scene;
   MHEG5Application *application;

   /* Prevent event processing while we destruct the scene and application,
    * And reset the event and action queues*/
   MHEG5stopEventsAndResetQueue();

   /* 1. Apply the Destruction behaviour of the currently active
    * Scene object, if any.
    */
   scene = MHEG5getCurrentScene();
   if (scene != 0)
   {
      MHEG5sceneDestruct(scene);
      MHEG5sceneFree(scene);
      MHEG5freeMem(scene);
   }

   /* 2. Apply the Destruction behaviour of the target Application
    * object.
    */
   application = currentApplication;
   if (application != 0)
   {
      /* During destruction of an application triggered by Quit, Launch
       * or Spawn actions, any stream decoder associated with Stream
       * objects are not stopped. See UK1.05 section 6.3.4
       */
      application->streamContinuanceFlag = MHEG5TRUE;
      MHEG5applicationDestruct(application);
      MHEG5applicationFree(application);
      MHEG5freeMem(application);
      currentApplication = NULL;
   }

#ifdef MHG_TRACK_MEM
   /* -- Debug code - print engine memory tracking state */
   TRACE(TMEMORY, ("quit app done"))
   mh5emt_print(1 << SRCMEM_APP);
#endif

   /* Reset receiver to default state */
   MHEG5restoreReceiverDefaults();

   /* Enable event processing again */
   MHEG5queueEvents();

   if (applStackCount != 0)
   {
      MHEG5unloadApp();

      /* We have popped an Application from the stack. Now restart it. */
      Restarted = MHEG5TRUE;

      /* Launch the application that we have just popped off the stack */
      MHEG5FileOrmReset(MHEG5_FILE_ORM_RESET_ALL_OBJECTS);
      TRACE(TFILE, ("relaunching App"))
      MHEG5enableEventProcessing(MHEG5FALSE);
      launchAppName = applStack[applStackCount].app_name;
      applStack[applStackCount].app_name.len = 0;   /* launchAppName owns the data for now */
        #ifdef INCLUDE_IC
      MHEG5PopHybridFileSystem();
        #endif
      (void)MHEG5FileOrmGet( launchAppName, FRP_APPLICATION | FRP_CACHE_DEFAULT, NULL,
         MHEG5applicationRetrieved, MHEG5applicationRetrieveFail );
   }
   else
   {
      /* The application stack is empty. */
      TRACE(TFILE, ("Restart Boot App"))

      /* Clear any outstanding file requests */
      MHEG5FileOrmReset(MHEG5_FILE_ORM_RESET_ALL_OBJECTS);

      /* Reset the media decoders to their default state */
      MHEG5displayResetStreamDecoders(TRUE);

      /* Clear current service */
      MHEG5streamClearCurrentService();

      /* Notify that the final Application has Quit. */
      MHEG5NotifyEngineQuit();

      MHEG5displayClear();

      MHEG5StartReboot(NULL);
   }
}

MHEG5ErrorCode MHEG5lockScreen(MHEG5Root *target, MHEG5GList *params)
{
   assert(target);

   if (target != (MHEG5Root *) currentApplication)
   {
      return MHEG5ERR_WRONGTARGET;
   }

   DEBUG_PRINT(("   Old lockCount is %d\n", currentApplication->lockCount));

   if (currentApplication->lockCount <= 0)
   {
      currentApplication->lockCount = 0;

      /* Update the on screen display before locking the screen */
      MHEG5displayUpdate();
   }
   currentApplication->lockCount++;
   DEBUG_PRINT(("   New lockCount is %d\n", currentApplication->lockCount));

   return MHEG5ERR_NOERROR;
}

MHEG5ErrorCode MHEG5unlockScreen(MHEG5Root *target, MHEG5GList *params)
{
   assert(target);

   if (target != (MHEG5Root *) currentApplication)
   {
      return MHEG5ERR_WRONGTARGET;
   }

   DEBUG_PRINT(("   Old lockCount is %d\n", currentApplication->lockCount));

   currentApplication->lockCount--;
   if (currentApplication->lockCount < 0)
   {
      currentApplication->lockCount = 0;
   }
   DEBUG_PRINT(("   New lockCount is %d\n", currentApplication->lockCount));

   return MHEG5ERR_NOERROR;
}

#ifndef MHEG5PROFILE_UK1_06

MHEG5ErrorCode MHEG5openConnection(MHEG5Root *target, MHEG5GList *params)
{
   USE_UNWANTED_PARAM(params);
   return MHEG5ERR_NOTSUPPORTEDBYPROFILE;
}

MHEG5ErrorCode MHEG5closeConnection(MHEG5Root *target, MHEG5GList *params)
{
   USE_UNWANTED_PARAM(params);
   return MHEG5ERR_NOTSUPPORTEDBYPROFILE;
}

#endif 
MHEG5ErrorCode MHEG5getEngineSupport(MHEG5Root *target, MHEG5GList *params)
{
   MHEG5GList *thirdParam = 0;
   MHEG5Root *bVar;
   MHEG5String feature;
   MHEG5Bool invalidString;

   assert(target);

   if (target != (MHEG5Root *) currentApplication)
   {
      return MHEG5ERR_WRONGTARGET;
   }
   if (!params)
   {
      return MHEG5ERR_WRONGNUMBEROFPARAMS;
   }
   thirdParam = MHEG5resolveGenericOctetString(params, &feature, &invalidString);
   if (invalidString)
   {
      /* Parameter was not an octet string */
      return MHEG5ERR_WRONGPARAM;
   }
   if (!thirdParam)
   {
      return MHEG5ERR_WRONGNUMBEROFPARAMS;
   }
   MHEG5resolveORef(thirdParam, &bVar);
   if (!bVar)
   {
      return MHEG5ERR_WRONGNUMBEROFPARAMS;
   }
   if (bVar->clazz != MHEG5BOOLEANVARIABLE)
   {
      return MHEG5ERR_WRONGPARAM;
   }

   if (feature.len < 3)
   {
      ((MHEG5BooleanVariable *) bVar)->value = MHEG5FALSE;
   }
   else
   {
      ((MHEG5BooleanVariable *) bVar)->value = MH5_GetEngineSupport( feature );
   }

   return MHEG5ERR_NOERROR;
}

MHEG5ErrorCode MHEG5setDesktopColour(MHEG5Root *target, MHEG5GList *params)
{
   MHEG5Colour newDesktopColour;

   assert(target);

   if (target != (MHEG5Root *) currentApplication)
   {
      return MHEG5ERR_WRONGTARGET;
   }
   if (!params)
      return MHEG5ERR_WRONGNUMBEROFPARAMS;
   MHEG5resolveGenericGeneric(params, &newDesktopColour);

   MHEG5genericCopy(&currentApplication->desktopColour, &newDesktopColour);

   MHEG5displayShowAll();

   return MHEG5ERR_NOERROR;
}