mh5action.h

Go to the documentation of this file.

/*******************************************************************************
 * Copyright © 2014 The DTVKit Open Software Foundation Ltd (www.dtvkit.org)
 * Copyright © 2004 Ocean Blue Software Ltd
 * Copyright © 2000 Koninklijke Philips Electronics N.V
 *
 * This file is part of a DTVKit Software Component
 * You are permitted to copy, modify or distribute this file subject to the terms
 * of the DTVKit 1.0 Licence which can be found in licence.txt or at www.dtvkit.org
 * 
 * THIS CODE AND INFORMATION ARE PROVIDED "AS IS" WITHOUT WARRANTY OF ANY KIND,
 * EITHER EXPRESSED OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE IMPLIED WARRANTIES
 * OF MERCHANTABILITY AND/OR FITNESS FOR A PARTICULAR PURPOSE.
 * 
 * If you or your organisation is not a member of DTVKit then you have access
 * to this source code outside of the terms of the licence agreement
 * and you are expected to delete this and any associated files immediately.
 * Further information on DTVKit, membership and terms can be found at www.dtvkit.org
 *******************************************************************************/
#ifndef _MH5ACTION_H
#define _MH5ACTION_H

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

#include "mh5root.h"

/*---Constant and macro definitions for public use---------------------------*/
#define MAX_EVENT_INDENT   64
#define MAX_EVENT_DLEVEL   256

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

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

/*
     Defined Actions as Enumeration
   Do not modifie the sequence - this is very important
   for the ASN1 Decoder
 */
typedef enum
{
   MHEG5NONEACTION,               /* 0 */
   MHEG5ACTIVATE,
   MHEG5ADD,
   MHEG5ADDITEM,
   MHEG5APPEND,
   MHEG5BRINGTOFRONT,
   MHEG5CALL,
   MHEG5CALLACTIONSLOT,
   MHEG5CLEAR,
   MHEG5CLONE,
   MHEG5CLOSECONNECTION,         /* 10 */
   MHEG5DEACTIVATE,
   MHEG5DELITEM,
   MHEG5DESELECT,
   MHEG5DESELECTITEM,
   MHEG5DIVIDE,
   MHEG5DRAWARC,
   MHEG5DRAWLINE,
   MHEG5DRAWOVAL,
   MHEG5DRAWPOLYGON,
   MHEG5DRAWPOLYLINE,            /* 20 */
   MHEG5DRAWRECTANGLE,
   MHEG5DRAWSECTOR,
   MHEG5FORK,
   MHEG5GETAVAILABILITYSTATUS,
   MHEG5GETBOXSIZE,
   MHEG5GETCELLITEM,
   MHEG5GETCURSORPOSITION,
   MHEG5GETENGINESUPPORT,
   MHEG5GETENTRYPOINT,
   MHEG5GETFILLCOLOUR,           /* 30 */
   MHEG5GETFIRSTITEM,
   MHEG5GETHIGHLIGHTSTATUS,
   MHEG5GETINTERACTIONSTATUS,
   MHEG5GETITEMSTATUS,
   MHEG5GETLABEL,
   MHEG5GETLASTANCHORFIRED,
   MHEG5GETLINECOLOUR,
   MHEG5GETLINESTYLE,
   MHEG5GETLINEWIDTH,
   MHEG5GETLISTITEM,             /* 40 */
   MHEG5GETLISTSIZE,
   MHEG5GETOVERWRITEMODE,
   MHEG5GETPORTION,
   MHEG5GETPOSITION,
   MHEG5GETRUNNINGSTATUS,
   MHEG5GETSELECTIONSTATUS,
   MHEG5GETSLIDERVALUE,
   MHEG5GETTEXTCONTENT,
   MHEG5GETTEXTDATA,
   MHEG5GETTOKENPOSITION,        /* 50 */
   MHEG5GETVOLUME,
   MHEG5LAUNCH,
   MHEG5LOCKSCREEN,
   MHEG5MODULO,
   MHEG5MOVE,
   MHEG5MOVETO,
   MHEG5MULTIPLY,
   MHEG5OPENCONNECTION,
   MHEG5PRELOAD,
   MHEG5PUTBEFORE,               /* 60 */
   MHEG5PUTBEHIND,
   MHEG5QUIT,
   MHEG5READPERSISTENT,
   MHEG5RUN,
   MHEG5SCALEBITMAP,
   MHEG5SCALEVIDEO,
   MHEG5SCROLLITEMS,
   MHEG5SELECT,
   MHEG5SELECTITEM,
   MHEG5SENDEVENT,               /* 70 */
   MHEG5SENDTOBACK,
   MHEG5SETBOXSIZE,
   MHEG5SETCACHEPRIORITY,
   MHEG5SETCOUNTERENDPOSITION,
   MHEG5SETCOUNTERPOSITION,
   MHEG5SETCOUNTERTRIGGER,
   MHEG5SETCURSORPOSITION,
   MHEG5SETCURSORSHAPE,
   MHEG5SETDATA,
   MHEG5SETENTRYPOINT,           /* 80 */
   MHEG5SETFILLCOLOUR,
   MHEG5SETFIRSTITEM,
   MHEG5SETFONTREF,
   MHEG5SETHIGHLIGHTSTATUS,
   MHEG5SETINTERACTIONSTATUS,
   MHEG5SETLABEL,
   MHEG5SETLINECOLOUR,
   MHEG5SETLINESTYLE,
   MHEG5SETLINEWIDTH,
   MHEG5SETOVERWRITEMODE,        /* 90 */
   MHEG5SETPALETTEREF,
   MHEG5SETPORTION,
   MHEG5SETPOSITION,
   MHEG5SETSLIDERVALUE,
   MHEG5SETSPEED,
   MHEG5SETTIMER,
   MHEG5SETTRANSPARENCY,
   MHEG5SETVARIABLE,
   MHEG5SETVOLUME,
   MHEG5SPAWN,                   /* 100 */
   MHEG5STEP,
   MHEG5STOP,
   MHEG5STOREPERSISTENT,
   MHEG5SUBTRACT,
   MHEG5TESTVARIABLE,
   MHEG5TOGGLE,
   MHEG5TOGGLEITEM,
   MHEG5TRANSITIONTO,
   MHEG5UNLOAD,
   MHEG5UNLOCKSCREEN,            /* 110 */
   ACTION_225, ACTION_226, ACTION_227, ACTION_228, ACTION_229, ACTION_230,
   ACTION_231, ACTION_232, ACTION_233, ACTION_234, ACTION_235, ACTION_236,
   MHEG5SETBACKGROUNDCOLOUR,      /* 123 */
   MHEG5SETCELLPOSITION,
   MHEG5SETINPUTREGISTER,
   MHEG5SETTEXTCOLOUR,
   MHEG5SETFONTATTRIBUTES,
   MHEG5SETVIDEODECODEOFFSET,
   MHEG5GETVIDEODECODEOFFSET,
   MHEG5GETFOCUSPOSITION,         /* 130 */
   MHEG5SETFOCUSPOSITION,
   MHEG5SETBITMAPDECODEOFFSET,
   MHEG5GETBITMAPDECODEOFFSET,
   MHEG5SETSLIDERPARAMETERS,
   ACTION_249,
   MHEG5SETDESKTOPCOLOUR,
   MHEG5GETCOUNTERPOSITION,
   MHEG5GETCOUNTERMAXPOSITION,
   ACTION_253,
   MHEG5SETINPUTMASK,             /* 140 */
   ACTION_LAST
} E_ElementryAction;

typedef MHEG5Short MHEG5ElemActionType;

/*
    Each Elementary Action consists of a Type Identifier, a List of Parameters and
    a Pointer to the next Elementary Action in the List
 */
typedef struct sMHEG5Action
{
   MHEG5Root *target;
   MHEG5GList *firstParam;
   MHEG5GList *origFirstParam;
   MHEG5ElemActionType type;
   MHEG5Boolean targetIsIndirect;
} MHEG5Action;

typedef struct sMHEG5ActionList
{
   MHEG5Action *a_ptr;
   MHEG5Int total;
} MHEG5ActionList;


/*---Global variable declarations for public use-----------------------------*/
#if defined(MH5PRINTOUT) || defined(TRACING)
extern int event_indent_num;
#endif

/*---Global Function prototypes for public use-------------------------------*/

/*
   Debug
 */
#ifdef MH5PRINTOUT
void MHEG5actionPrint(MHEG5ActionList actions, char *out);
#endif

/*
    Free the memory of a list of elementary actions
    The memory is allocated by the Text- or ASN.1 parser.
 */
void MHEG5actionDestruct(MHEG5ActionList actions);


#endif /*_MH5ACTION_H*/