fpa1_syn.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  _FPA1_SYN_H
#define  _FPA1_SYN_H

/*---includes for this file--------------------------------------------------*/
#include "vpa1_sys.h"
#include "mh5base.h"

/*---Constant and macro definitions for public use---------------------------*/
#define SYN_NEEDED   0
#define SYN_OPTIONAL 1
#define SYN_DEFAULT  2

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

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

union synItemData
{
   MHEG5Bool boolData;
   MHEG5Int intData;
   MHEG5String stringData;
};
typedef union synItemData syntaxItemData;

struct fpa1_syntaxItem
{
   struct fpa1_syntaxItem *next;
   struct fpa1_syntaxItem *children;
   int tag;
   vpa1_filePos tagPosition;
   vpa1_filePos nextTagPosition;
   syntaxItemData data;
   int dataType;                    /* 0=none, 1=Bool, 2=Int, 4=String */
   unsigned short childCount[3];
   unsigned short dataTotal;
};

typedef struct fpa1_syntaxItem fpa1_syntaxList;

/*---Global variable declarations for public use-----------------------------*/

/*---Global Function prototypes for public use-------------------------------*/
fpa1_syntaxList *fpa1_synGetAllTags( vpa1_filePos );
fpa1_syntaxList* fpa1_synAddItemToStartOfList( fpa1_syntaxList *,
   fpa1_syntaxList * );
fpa1_syntaxList* fpa1_synAddItemToList( fpa1_syntaxList *,
   fpa1_syntaxList * );
fpa1_syntaxList *fpa1_synCreateListItem( int,
                                         vpa1_filePos,
                                         vpa1_filePos );
fpa1_syntaxList* fpa1_synFreeFirstItem( fpa1_syntaxList * );
void                fpa1_synFreeList( fpa1_syntaxList * );
fpa1_syntaxList *fpa1_synGetUnknowns( vpa1_filePos,
                                      vpa1_filePos,
                                      fpa1_syntaxList * );
fpa1_syntaxList* fpa1_synRemoveItemFromList( fpa1_syntaxList *,
   fpa1_syntaxList * );

#endif /*_FPA1_SYN_H*/