mh5presentable.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 "mh5profile.h"
#include "mh5presentable.h"
#include "mh5object.h"
#include "mh5classes.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---------------------------------------------*/

/*
 */

/*
     27.1 Attributes
     This subclause defines the inherited, exchanged and internal attributes for this class.
     27.1.1 Inherited attributes
     This class has all the attributes of its base class, with identical semantics.
     27.1.2 Own exchanged attributes
     This class defines no additional exchanged attribute.
     27.1.3 Own internal attributes
     This class defines no additional internal attribute.
     27.2 Events
     This class has the same events as its base class, with identical semantics.
     27.3 Internal behaviours
     The internal behaviours of this class have the same semantics as for its base class.
 */

/*
     27.4 Effect of MHEG-5 actions
     This class has the same set of MHEG-5 actions as its base class, with identical semantics, except as noted
     below (SetData). In addition, the following applicable MHEG-5 actions are defined:

     SetData
     Execute synchronously the following actions:
     1. Execute the SetData action as defined in the Ingredient class.
     2. If the Presentable is active, present it again immediately using the new
        value of Content.
     Provisions of use and syntax description are provided in the Ingredient class.

     Added this behaviour in SetData Action at Ingredient!!
 */

/*
     Run
     Execute the following actions:
     1. If the target Presentable is active, disregard this action.
     2. If the target Presentable is non-available or is inactive, apply the Activation
        behaviour of the Presentable.
 */
MHEG5ErrorCode MHEG5run(MHEG5Root *target, MHEG5GList *params)
{
   assert(target);

   if (!target->runningStatus)
   {
      switch (target->clazz)
      {
         case MHEG5BITMAP:
            MHEG5bitmapActivate((MHEG5Bitmap *) target);
            break;
         case MHEG5TEXT:
            MHEG5textActivate((MHEG5Text *) target);
            break;
         case MHEG5LINEART:
            MHEG5lineartActivate((MHEG5Lineart *) target);
            break;
         case MHEG5DYNAMICLINEART:
            MHEG5dynamicLineartActivate((MHEG5DynamicLineart *) target);
            break;
         case MHEG5RECTANGLE:
            MHEG5rectangleActivate((MHEG5Rectangle *) target);
            break;
         case MHEG5RESIDENTPROGRAM:
         case MHEG5REMOTEPROGRAM:
         case MHEG5INTERCHANGEDPROGRAM:
            MHEG5programActivate((MHEG5Program *) target);
            break;
         case MHEG5STREAM:
            MHEG5streamActivate((MHEG5Stream *) target);
            break;
         case MHEG5AUDIO:
            MHEG5audioActivate((MHEG5Audio *) target);
            break;
         case MHEG5VIDEO:
            MHEG5videoActivate((MHEG5Video *) target);
            break;
        #ifndef MHEG5PROFILE_UK1_06
         case MHEG5HOTSPOT:
            MHEG5hotspotActivate((MHEG5Hotspot *)target);
            break;
         case MHEG5PUSHBUTTON:
            MHEG5pushbuttonActivate((MHEG5Pushbutton *)target);
            break;
         case MHEG5SWITCHBUTTON:
            MHEG5switchbuttonActivate((MHEG5Switchbutton *)target);
            break;
         case MHEG5RTGRAPHICS:
            MHEG5rtgraphicsActivate((MHEG5RTGraphics *) target);
            break;
        #endif 
         case MHEG5TOKENGROUP:
            MHEG5tokenGroupActivate((MHEG5TokenGroup *)target);
            break;
         case MHEG5LISTGROUP:
            MHEG5listGroupActivate((MHEG5ListGroup *)target);
            break;
         case MHEG5ENTRYFIELD:
            MHEG5entryfieldActivate((MHEG5Entryfield *)target);
            break;
         case MHEG5HYPERTEXT:
            MHEG5hypertextActivate((MHEG5Hypertext *)target);
            break;
         case MHEG5SLIDER:
            MHEG5sliderActivate((MHEG5Slider *)target);
            break;
         case MHEG5SCENE:
         case MHEG5APPLICATION:
         case MHEG5LINK:
         case MHEG5BOOLEANVARIABLE:
         case MHEG5INTEGERVARIABLE:
         case MHEG5OCTETSTRINGVARIABLE:
         case MHEG5OBJECTREFVARIABLE:
         case MHEG5CONTENTREFVARIABLE:
         case MHEG5PALETTE:
         case MHEG5CURSORSHAPE:
         case MHEG5FONT:
         default:;
      }
   }
   return MHEG5ERR_NOERROR;
}

/*
     Stop
     Execute the following actions:
     1. If the target Presentable is inactive, disregard this action.
     2. If the target Presentable is active, apply the Deactivation behaviour of the
        Presentable.

     Provisions of use:
     The Target object shall be available.
 */
/*
     Stop   from Program Class
     Interrupt the execution of an external piece of procedural code.
     Execute the following sequence of actions:
     1. If the Program is inactive, disregard this action. Otherwise,
     2. Apply the Deactivation behaviour.

     Provisions of use:
     The Target object shall be an available Program object.
 */
MHEG5ErrorCode MHEG5stop(MHEG5Root *target, MHEG5GList *params)
{
   assert(target);

   if (target->runningStatus)
   {
      switch (target->clazz)
      {
         case MHEG5BITMAP:
            MHEG5bitmapDeactivate((MHEG5Bitmap *) target);
            break;
         case MHEG5TEXT:
            MHEG5textDeactivate((MHEG5Text *) target);
            break;
         case MHEG5LINEART:
            MHEG5lineartDeactivate((MHEG5Lineart *) target);
            break;
         case MHEG5DYNAMICLINEART:
            MHEG5dynamicLineartDeactivate((MHEG5DynamicLineart *) target);
            break;
         case MHEG5RECTANGLE:
            MHEG5rectangleDeactivate((MHEG5Rectangle *) target);
            break;
         case MHEG5RESIDENTPROGRAM:
         case MHEG5REMOTEPROGRAM:
         case MHEG5INTERCHANGEDPROGRAM:
            MHEG5programDeactivate((MHEG5Program *) target);
            break;
         case MHEG5STREAM:
            MHEG5streamDeactivate((MHEG5Stream *) target);
            break;
         case MHEG5AUDIO:
            MHEG5audioDeactivate((MHEG5Audio *) target);
            break;
         case MHEG5VIDEO:
            MHEG5videoDeactivate((MHEG5Video *) target);
            break;
        #ifndef MHEG5PROFILE_UK1_06
         case MHEG5HOTSPOT:
            MHEG5hotspotDeactivate((MHEG5Hotspot *)target);
            break;
         case MHEG5PUSHBUTTON:
            MHEG5pushbuttonDeactivate((MHEG5Pushbutton *)target);
            break;
         case MHEG5SWITCHBUTTON:
            MHEG5switchbuttonDeactivate((MHEG5Switchbutton *)target);
            break;
         case MHEG5RTGRAPHICS:
            MHEG5rtgraphicsDeactivate((MHEG5RTGraphics *) target);
            break;
        #endif 
         case MHEG5TOKENGROUP:
            MHEG5tokenGroupDeactivate((MHEG5TokenGroup *)target);
            break;
         case MHEG5LISTGROUP:
            MHEG5listGroupDeactivate((MHEG5ListGroup *)target);
            break;
         case MHEG5ENTRYFIELD:
            MHEG5entryfieldDeactivate((MHEG5Entryfield *)target);
            break;
         case MHEG5HYPERTEXT:
            MHEG5hypertextDeactivate((MHEG5Hypertext *)target);
            break;
         case MHEG5SLIDER:
            MHEG5sliderDeactivate((MHEG5Slider *)target);
            break;
         case MHEG5SCENE:
         case MHEG5APPLICATION:
         case MHEG5LINK:
         case MHEG5BOOLEANVARIABLE:
         case MHEG5INTEGERVARIABLE:
         case MHEG5OCTETSTRINGVARIABLE:
         case MHEG5OBJECTREFVARIABLE:
         case MHEG5CONTENTREFVARIABLE:
         case MHEG5PALETTE:
         case MHEG5CURSORSHAPE:
         case MHEG5FONT:
         default:;
      }
   }
   return MHEG5ERR_NOERROR;
}