mh5root.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 "mh5base.h"            /* Base Types       */
#include "mh5queue.h"           /* Events           */
#include "mh5object.h"          /* Resolve Objects  */
#include "mh5variable.h"        /* For Actions      */
#include "mh5final.h"
#include "mh5debug.h"


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


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

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

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

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

#ifdef MH5PRINTOUT

void MHEG5rootPrint(MHEG5Root *root, char *out)
{
   MHEG5indent(out);
   MHEG5classPrint(root->clazz, out);
   MHEG_PRINT(out, " ");
   MHEG5intPrint(root->id, out);
   MHEG5newLine(out);
   MHEG5incIndent();
/*
   if (root->runningStatus)
   {
      MHEG5indent(out);
      MHEG_PRINT(out,"// RunningStatus:\tTrue");
      MHEG5newLine(out);
   }
   if (root->availabilityStatus)
   {
      MHEG5indent(out);
      MHEG_PRINT(out,"// AvailabilityStatus:\tTrue");
      MHEG5newLine(out);
   }
 */
}

#endif


void MHEG5rootInit(MHEG5Root *root)
{
   assert(root);
}

void MHEG5rootFree(MHEG5Root *root)
{
   assert(root);
}

void MHEG5rootClone(MHEG5Root *destination, MHEG5Root *source)
{
   assert(source);
   assert(destination);

   destination->clazz = source->clazz;
   destination->id = source->id;
}

void MHEG5rootPrepare(MHEG5Root *root)
{
   CALL_PRINT((">> MHEG5rootPrepare(%p)\n", root));

   assert(root);
   /*steps 1 - 3 should have already been done */
   /* 1. If the AvailabilityStatus attribute of the object is True, abort the behaviour. */
   assert( !root->availabilityStatus );
   /* Otherwise:
    * 2. Retrieve the object from an entity outside the engine.
    *    - note - entity already retreived.
    */
   /* 3. Set each internal attribute of the object to its initial value. */

   /* 4. Set the AvailabilityStatus attribute to True. */
   root->availabilityStatus = MHEG5TRUE;

   /* 5. Generate an IsAvailable event. */
   MHEG5sendSync(root, MHEG5ISAVAILABLE, 0);

   /* 6. Perform the ContentPreparation behaviour.
    * ... done in MHEG5ingredientPrepare()
    */

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

void MHEG5rootActivate(MHEG5Root *root)
{
   assert(root);
   /* next bit should already have been done is sub-classes
      if (! root->availabilityStatus) {
       MHEG5finalPrepare(root);
      }*/
   assert(root->availabilityStatus);
}

void MHEG5rootDeactivate(MHEG5Root *root)
{
   assert(root);
   if (!root->runningStatus)
      return;
   root->runningStatus = MHEG5FALSE;
   MHEG5sendSync(root, MHEG5ISSTOPPED, 0);
}

void MHEG5rootDestruct(MHEG5Root *root)
{
   assert(root);
   if (!root->availabilityStatus)
   {
      return;
   }
   if (root->runningStatus)
   {
      MHEG5finalDeactivate(root);
   }
   root->availabilityStatus = MHEG5FALSE;
   MHEG5sendSync(root, MHEG5ISDELETED, 0);
}

/*
 *   Actions
 */


MHEG5ErrorCode MHEG5getAvailabilityStatus(MHEG5Root *target, MHEG5GList *params)
{
   MHEG5Root *statusVar = 0;

   assert(target);

   if (!params)
   {
      return MHEG5ERR_WRONGNUMBEROFPARAMS;
   }
   MHEG5resolveORef(params, &statusVar);
   if (!statusVar)
   {
      return MHEG5ERR_WRONGNUMBEROFPARAMS;
   }
   if (statusVar->clazz != MHEG5BOOLEANVARIABLE)
   {
      return MHEG5ERR_WRONGPARAM;
   }
   if (!statusVar->runningStatus)
   {
      return MHEG5ERR_PARAMNOTACTIVE;
   }

   if ((target) && (target->availabilityStatus))
   {
      ((MHEG5BooleanVariable *) statusVar)->value = MHEG5TRUE;
   }
   else
   {
      ((MHEG5BooleanVariable *) statusVar)->value = MHEG5FALSE;
   }

   return MHEG5ERR_NOERROR;
}

MHEG5ErrorCode MHEG5getRunningStatus(MHEG5Root *target, MHEG5GList *params)
{
   MHEG5Root *statusVar = 0;

   assert(target);

   if (!params)
   {
      return MHEG5ERR_WRONGNUMBEROFPARAMS;
   }
   MHEG5resolveORef(params, &statusVar);
   if (!statusVar)
   {
      return MHEG5ERR_WRONGNUMBEROFPARAMS;
   }

   if (statusVar->clazz != MHEG5BOOLEANVARIABLE)
   {
      return MHEG5ERR_WRONGPARAM;
   }

   if (!((MHEG5BooleanVariable *) statusVar)->ingredient.root.runningStatus)
   {
      return MHEG5ERR_PARAMNOTACTIVE;
   }

   ((MHEG5BooleanVariable *) statusVar)->value = target->runningStatus;

   return MHEG5ERR_NOERROR;
}