MHEG5 1.0
DTVKit MHEG5 1.0 API Documentation
 All Data Structures Files Functions Variables Typedefs Enumerations Enumerator Macros Pages
Data Structures | Macros | Typedefs | Enumerations | Functions
mh5base.h File Reference

Basis MHEG5 data types. More...

#include <stdio.h>
#include "techtype.h"
#include "glue_debug.h"

Go to the source code of this file.

Data Structures

struct  SMHEG5IntPair
 
struct  sMHEG5String
 
struct  sMH5GroupRef
 
struct  sMHEG5ObjectReference
 
struct  MHEG5Generic
 
struct  sMHEG5GList
 
struct  sParamList
 
struct  sMHEG5FontBody
 

Macros

#define MHEG5FALSE   (0)
 
#define MHEG5TRUE   (-1)
 
#define MHEG5strncmp(a, b, n)   strncmp((char *)a, (char *)b, n)
 
#define MHEG5strcmp(a, b)   strcmp((char *)a, (char *)b)
 
#define INVALID_GRP_REF   0
 

Typedefs

typedef short MHEG5Bool
 
typedef short MHEG5Short
 
typedef long MHEG5Int
 
typedef unsigned char MHEG5Byte
 
typedef struct SMHEG5IntPair MHEG5IntPair
 
typedef struct sMHEG5String MHEG5String
 
typedef struct sMHEG5Group sMHEG5Group
 
typedef MHEG5Int MH5GroupId
 
typedef struct sMHEG5Group * MH5GroupPtr
 
typedef struct sMH5GroupRef MH5GroupRef
 
typedef struct
sMHEG5ObjectReference 		MHEG5ObjectReference
 
typedef MHEG5Bool MHEG5Boolean
 
typedef struct sMHEG5GList MHEG5GList
 
typedef MHEG5Generic MHEG5Colour
 
typedef struct sParamList ParamList
 
typedef struct sMHEG5FontBody MHEG5FontBody
 

Enumerations

enum  MHEG5EventType {
  MHEG5NONEEVENT, MHEG5ISAVAILABLE, MHEG5ISDELETED, MHEG5ISRUNNING,
  MHEG5ISSTOPPED, MHEG5TOKENMOVEDFROM, MHEG5TOKENMOVEDTO, MHEG5HIGHLIGHTON,
  MHEG5HIGHLIGHTOFF, MHEG5ISSELECTED, MHEG5ISDESELECTED, MHEG5TESTEVENT,
  MHEG5HEADITEMS, MHEG5TAILITEMS, MHEG5FIRSTITEMPRESENTED, MHEG5ITEMSELECTED,
  MHEG5ITEMDESELECTED, MHEG5LASTITEMPRESENTED, MHEG5ANCHORFIRED, MHEG5ASYNCHSTOPPED,
  MHEG5CONTENTAVAILABLE, MHEG5COUNTERTRIGGER, MHEG5CURSORENTER, MHEG5CURSORLEAVE,
  MHEG5ENGINEEVENT, MHEG5ENTRYFIELDFULL, MHEG5FOCUSMOVED, MHEG5INTERACTIONCOMPLETED,
  MHEG5SLIDERVALUECHANGED, MHEG5STREAMEVENT, MHEG5STREAMPLAYING, MHEG5STREAMSTOPPED,
  MHEG5TIMERFIRED, MHEG5USERINPUT, MHEG5LASTEVENT
}
 
enum  E_ParamTypes {
  MHEG5NONE, MHEG5INT, MHEG5BOOL, MHEG5NULL,
  MHEG5OCTETSTRING, MHEG5BRACKETOPEN, MHEG5BRACKETCLOSE, MHEG5EVENT,
  MHEG5CONTENTREF, MHEG5INTPAIR, MHEG5OBJECTREF, MHEG5OBJREFEXT,
  MHEG5CONTENTSIZE, MHEG5CONTENTCCP
}
 
enum  MHEG5Final {
  MHEG5SCENE, MHEG5APPLICATION, MHEG5LINK, MHEG5PALETTE,
  MHEG5CURSORSHAPE, MHEG5FONT, MHEG5RESIDENTPROGRAM, MHEG5REMOTEPROGRAM,
  MHEG5INTERCHANGEDPROGRAM, MHEG5BOOLEANVARIABLE, MHEG5INTEGERVARIABLE, MHEG5OCTETSTRINGVARIABLE,
  MHEG5OBJECTREFVARIABLE, MHEG5CONTENTREFVARIABLE, MHEG5STREAM, MHEG5AUDIO,
  MHEG5TOKENGROUP, MHEG5LISTGROUP, MHEG5RTGRAPHICS, MHEG5LINEART,
  MHEG5BITMAP, MHEG5TEXT, MHEG5VIDEO, MHEG5SLIDER,
  MHEG5DYNAMICLINEART, MHEG5RECTANGLE, MHEG5ENTRYFIELD, MHEG5HYPERTEXT,
  MHEG5HOTSPOT, MHEG5PUSHBUTTON, MHEG5SWITCHBUTTON
}
 
enum  MHEG5Orientation { MHEG5LEFT, MHEG5RIGHT, MHEG5UP, MHEG5DOWN }
 
enum  MHEG5SliderStyle { MHEG5NORMAL, MHEG5THERMOMETER, MHEG5PROPORTIONAL }
 
enum  MHEG5PushbuttonStyle { MHEG5PUSHBUTTONS, MHEG5RADIOBUTTON, MHEG5CHECKBOX }
 
enum  MHEG5ErrorCode {
  MHEG5ERR_NOERROR, MHEG5ERR_NOTYETSUPPORTED, MHEG5ERR_NOTSUPPORTEDBYPROFILE, MHEG5ERR_WRONGNUMBEROFPARAMS,
  MHEG5ERR_TARGETNOTAVAILABLE, MHEG5ERR_WRONGTARGET, MHEG5ERR_REFERENCEDPARAMNOTAVAILABLE, MHEG5ERR_WRONGPARAM,
  MHEG5ERR_PARAMNOTACTIVE, MHEG5ERR_NOSCENE, MHEG5ERR_TARGETNOTACTIVE, MHEG5ERR_NOSUCHITEM,
  MHEG5ERR_NOSUCHSLOT, MHEG5ERR_IGNORE_ACTION
}
 
enum  MHEG5SceneRatio_t { SCENE_RATIO_16x9, SCENE_RATIO_4x3, SCENE_RATIO_UNSPECIFIED }
 

Functions

MHEG5String MHEG5stringCopy (MHEG5String source)
 <Function description>=""> More...
 
MHEG5String MHEG5stringCopyChr (const char *source)
 Copy the C-String source to a MHEG5String. More...
 
MHEG5String MHEG5stringCat (MHEG5String string1, MHEG5String string2)
 Concatenate two MHEG5Strings. More...
 
void MHEG5stringDestruct (MHEG5String *item)
 Destruct a MHEG5String. More...
 
MHEG5Int MHEG5strToInt (MHEG5String string)
 Convert a MHEG5String to a MHEG5Integer. More...
 
MHEG5Bool MHEG5stringEqual (MHEG5String *s1, MHEG5String *s2)
 Compare two Strings (case sensitive!) More...
 
MHEG5String MHEG5intToStr (MHEG5Int i)
 Convert MHEG5Int to MHEG5String. More...
 
void MHEG5genericInit (MHEG5Generic *item)
 Initialize an empty MHEG5Generic. More...
 
void MHEG5genericSet (MHEG5Generic *item, MHEG5Int initialValue)
 Set a MHEG5Generic to the MHEG5Int value. More...
 
void MHEG5genericBSet (MHEG5Generic *item, MHEG5Bool initialValue)
 Set a MHEG5Generic to the MHEG5Bool value. More...
 
void MHEG5genericSSet (MHEG5Generic *item, char *initialValue)
 
void MHEG5genericDestruct (MHEG5Generic *item)
 Destruct a MHEG5Generic. More...
 
MHEG5Bool MHEG5genericEqual (MHEG5Generic *g1, MHEG5Generic *g2)
 Compare two generic Variables. More...
 
void MHEG5genericCopy (MHEG5Generic *dest, MHEG5Generic *src)
 Copy a MHEG5Generic. More...
 
void MHEG5gListDestruct (MHEG5GList *item)
 Destruct a list of MHEG5Generic objects. More...
 
MHEG5GList * MHEG5gListCopy (MHEG5GList *list)
 Copy a list of MHEG5Generic objects. More...
 
void MHEG5colourInit (MHEG5Colour *item, MHEG5Int initialValue)
 Initialize a MHEG5Colour with the initial value MHEG5Int. More...
 
void MHEG5colourDestruct (MHEG5Colour *item)
 Destruct a MHEG5Colour object. More...
 
unsigned long MHEG5random (void)
 Calculate and return a psuedo random number. More...
 
char * MHEG5safeStrcat (char *dest, size_t destLength, const char *source)
 Perform a standard strcat restricted to the length of the destination. The dest string will always be null terminated. More...
 

Detailed Description

Basis MHEG5 data types.

Date
14/01/2002
Author
iwillis

Macro Definition Documentation

#define INVALID_GRP_REF   0
#define MHEG5FALSE   (0)
#define MHEG5strcmp (   a,
  b 
)    strcmp((char *)a, (char *)b)
#define MHEG5strncmp (   a,
  b,
  n 
)    strncmp((char *)a, (char *)b, n)
#define MHEG5TRUE   (-1)

Typedef Documentation

typedef MHEG5Int MH5GroupId
typedef struct sMHEG5Group* MH5GroupPtr
typedef struct sMH5GroupRef MH5GroupRef
typedef short MHEG5Bool
typedef MHEG5Bool MHEG5Boolean
typedef unsigned char MHEG5Byte
typedef MHEG5Generic MHEG5Colour
typedef struct sMHEG5FontBody MHEG5FontBody
typedef struct sMHEG5GList MHEG5GList
typedef long MHEG5Int
typedef struct SMHEG5IntPair MHEG5IntPair
typedef struct sMHEG5ObjectReference MHEG5ObjectReference
typedef short MHEG5Short
typedef struct sMHEG5String MHEG5String
typedef struct sParamList ParamList
typedef struct sMHEG5Group sMHEG5Group

Enumeration Type Documentation

enum E_ParamTypes
Enumerator
MHEG5NONE 
MHEG5INT 
MHEG5BOOL 
MHEG5NULL 
MHEG5OCTETSTRING 
MHEG5BRACKETOPEN 
MHEG5BRACKETCLOSE 
MHEG5EVENT 
MHEG5CONTENTREF 
MHEG5INTPAIR 
MHEG5OBJECTREF 
MHEG5OBJREFEXT 
MHEG5CONTENTSIZE 
MHEG5CONTENTCCP 
enum MHEG5ErrorCode
Enumerator
MHEG5ERR_NOERROR 
MHEG5ERR_NOTYETSUPPORTED 
MHEG5ERR_NOTSUPPORTEDBYPROFILE 
MHEG5ERR_WRONGNUMBEROFPARAMS 
MHEG5ERR_TARGETNOTAVAILABLE 
MHEG5ERR_WRONGTARGET 
MHEG5ERR_REFERENCEDPARAMNOTAVAILABLE 
MHEG5ERR_WRONGPARAM 
MHEG5ERR_PARAMNOTACTIVE 
MHEG5ERR_NOSCENE 
MHEG5ERR_TARGETNOTACTIVE 
MHEG5ERR_NOSUCHITEM 
MHEG5ERR_NOSUCHSLOT 
MHEG5ERR_IGNORE_ACTION 
enum MHEG5EventType
Enumerator
MHEG5NONEEVENT 
MHEG5ISAVAILABLE 
MHEG5ISDELETED 
MHEG5ISRUNNING 
MHEG5ISSTOPPED 
MHEG5TOKENMOVEDFROM 
MHEG5TOKENMOVEDTO 
MHEG5HIGHLIGHTON 
MHEG5HIGHLIGHTOFF 
MHEG5ISSELECTED 
MHEG5ISDESELECTED 
MHEG5TESTEVENT 
MHEG5HEADITEMS 
MHEG5TAILITEMS 
MHEG5FIRSTITEMPRESENTED 
MHEG5ITEMSELECTED 
MHEG5ITEMDESELECTED 
MHEG5LASTITEMPRESENTED 
MHEG5ANCHORFIRED 
MHEG5ASYNCHSTOPPED 
MHEG5CONTENTAVAILABLE 
MHEG5COUNTERTRIGGER 
MHEG5CURSORENTER 
MHEG5CURSORLEAVE 
MHEG5ENGINEEVENT 
MHEG5ENTRYFIELDFULL 
MHEG5FOCUSMOVED 
MHEG5INTERACTIONCOMPLETED 
MHEG5SLIDERVALUECHANGED 
MHEG5STREAMEVENT 
MHEG5STREAMPLAYING 
MHEG5STREAMSTOPPED 
MHEG5TIMERFIRED 
MHEG5USERINPUT 
MHEG5LASTEVENT 
enum MHEG5Final
Enumerator
MHEG5SCENE 
MHEG5APPLICATION 
MHEG5LINK 
MHEG5PALETTE 
MHEG5CURSORSHAPE 
MHEG5FONT 
MHEG5RESIDENTPROGRAM 
MHEG5REMOTEPROGRAM 
MHEG5INTERCHANGEDPROGRAM 
MHEG5BOOLEANVARIABLE 
MHEG5INTEGERVARIABLE 
MHEG5OCTETSTRINGVARIABLE 
MHEG5OBJECTREFVARIABLE 
MHEG5CONTENTREFVARIABLE 
MHEG5STREAM 
MHEG5AUDIO 
MHEG5TOKENGROUP 
MHEG5LISTGROUP 
MHEG5RTGRAPHICS 
MHEG5LINEART 
MHEG5BITMAP 
MHEG5TEXT 
MHEG5VIDEO 
MHEG5SLIDER 
MHEG5DYNAMICLINEART 
MHEG5RECTANGLE 
MHEG5ENTRYFIELD 
MHEG5HYPERTEXT 
MHEG5HOTSPOT 
MHEG5PUSHBUTTON 
MHEG5SWITCHBUTTON 
enum MHEG5Orientation
Enumerator
MHEG5LEFT 
MHEG5RIGHT 
MHEG5UP 
MHEG5DOWN 
enum MHEG5PushbuttonStyle
Enumerator
MHEG5PUSHBUTTONS 
MHEG5RADIOBUTTON 
MHEG5CHECKBOX 
enum MHEG5SceneRatio_t
Enumerator
SCENE_RATIO_16x9 
SCENE_RATIO_4x3 
SCENE_RATIO_UNSPECIFIED 
enum MHEG5SliderStyle
Enumerator
MHEG5NORMAL 
MHEG5THERMOMETER 
MHEG5PROPORTIONAL 

Function Documentation

void MHEG5colourDestruct ( MHEG5Colour *  item)

Destruct a MHEG5Colour object.

Parameters
MHEG5Colour* item
Returns
void
void MHEG5colourInit ( MHEG5Colour *  item,
MHEG5Int  initialValue 
)

Initialize a MHEG5Colour with the initial value MHEG5Int.

Parameters
MHEG5Colour* item
MHEG5IntinitialValue
Returns
void
void MHEG5genericBSet ( MHEG5Generic *  item,
MHEG5Bool  initialValue 
)

Set a MHEG5Generic to the MHEG5Bool value.

Parameters
MHEG5Generic* item
MHEG5BoolinitialValue
Returns
void
void MHEG5genericCopy ( MHEG5Generic *  dest,
MHEG5Generic *  src 
)

Copy a MHEG5Generic.

Parameters
MHEG5Generic* dest
MHEG5Generic* src
Returns
void
void MHEG5genericDestruct ( MHEG5Generic *  item)

Destruct a MHEG5Generic.

Parameters
MHEG5Generic* item
Returns
void
MHEG5Bool MHEG5genericEqual ( MHEG5Generic *  g1,
MHEG5Generic *  g2 
)

Compare two generic Variables.

Parameters
MHEG5Generic* g1
MHEG5Generic* g2
Returns
MHEG5Bool MHEG5Bool
void MHEG5genericInit ( MHEG5Generic *  item)

Initialize an empty MHEG5Generic.

Parameters
MHEG5Generic* item
Returns
void
void MHEG5genericSet ( MHEG5Generic *  item,
MHEG5Int  initialValue 
)

Set a MHEG5Generic to the MHEG5Int value.

Parameters
MHEG5Generic* item
MHEG5IntinitialValue
Returns
void
void MHEG5genericSSet ( MHEG5Generic *  item,
char *  initialValue 
)
MHEG5GList* MHEG5gListCopy ( MHEG5GList *  list)

Copy a list of MHEG5Generic objects.

Parameters
MHEG5GList*list
Returns
MHEG5GList * Pointer to the first element of the new MHEG5GList
void MHEG5gListDestruct ( MHEG5GList *  item)

Destruct a list of MHEG5Generic objects.

Parameters
MHEG5GList*item
Returns
void
MHEG5String MHEG5intToStr ( MHEG5Int  i)

Convert MHEG5Int to MHEG5String.

Parameters
MHEG5Inti
Returns
MHEG5String MHEG5String
unsigned long MHEG5random ( void  )

Calculate and return a psuedo random number.

Returns
Next random number in the sequence
char* MHEG5safeStrcat ( char *  dest,
size_t  destLength,
const char *  source 
)

Perform a standard strcat restricted to the length of the destination. The dest string will always be null terminated.

Parameters
destDestination to concatenate string to.
destLengthMaximum length of the destination string, including null termination.
sourceNull terminated string to concatenate with the destination.
Returns
Pointer to dest
MHEG5String MHEG5stringCat ( MHEG5String  source1,
MHEG5String  source2 
)

Concatenate two MHEG5Strings.

Parameters
MHEG5Stringsource1
MHEG5Stringsource2
Returns
MHEG5String MHEG5String
MHEG5String MHEG5stringCopy ( MHEG5String  source)

<Function description>="">

Returns
<Return value>="">
<Return value>=""> Copy a MHEG5String and return the new MHEG5String
Parameters
MHEG5Stringsource
Returns
MHEG5String MHEG5String
MHEG5String MHEG5stringCopyChr ( const char *  source)

Copy the C-String source to a MHEG5String.

Parameters
char*source
Returns
MHEG5String MHEG5String
void MHEG5stringDestruct ( MHEG5String *  item)

Destruct a MHEG5String.

Parameters
MHEG5Stringitem
Returns
void
MHEG5Bool MHEG5stringEqual ( MHEG5String *  s1,
MHEG5String *  s2 
)

Compare two Strings (case sensitive!)

Parameters
MHEG5Strings1
MHEG5Strings2
Returns
MHEG5Bool MHEG5Bool
MHEG5Int MHEG5strToInt ( MHEG5String  string)

Convert a MHEG5String to a MHEG5Integer.

Parameters
MHEG5Stringstring
Returns
MHEG5Int MHEG5Int