fpa1_typ.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 <stdio.h>
#include <stdlib.h>

#include "vpa1_tgs.h"
#include "vpa1_rdf.h"

#include "fpa1_act.h"
#include "fpa1_boo.h"
#include "fpa1_cho.h"
#include "fpa1_con.h"
#include "fpa1_enu.h"
#include "fpa1_lnk.h"
#include "fpa1_ing.h"
#include "fpa1_int.h"
#include "fpa1_obj.h"
#include "fpa1_pos.h"
#include "fpa1_rdf.h"
#include "fpa1_sce.h"
#include "fpa1_seq.h"
#include "fpa1_str.h"
#include "fpa1_syn.h"
#include "fpa1_tok.h"
#include "fpa1_typ.h"

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

/*---constant definitions for this file--------------------------------------*/
#define NORM_SEQUENCE_TYPE                 (SEQUENCE_TYPE - MHEG5_TYPE)
#define NORM_EXTERNAL_REFERENCE_TYPE       (EXTERNAL_REFERENCE_TYPE - MHEG5_TYPE)
#define NORM_NEW_REFERENCED_CONTENT        (NEW_REFERENCED_CONTENT - MHEG5_TYPE)
#define NORM_NEW_TIMER                     (NEW_TIMER - MHEG5_TYPE)
#define NORM_NEXT_SCENE_TYPE               (NEXT_SCENE_TYPE - MHEG5_TYPE)
#define NORM_POINT_TYPE                    (POINT_TYPE - MHEG5_TYPE)
#define NORM_RATIONAL_TYPE                 (RATIONAL_TYPE - MHEG5_TYPE)
#define NORM_REFERENCED_CONTENT_TYPE       (REFERENCED_CONTENT_TYPE - MHEG5_TYPE)
#define NORM_TOKEN_GROUP_ITEM_TYPE         (TOKEN_GROUP_ITEM_TYPE - MHEG5_TYPE)
#define NORM_XY_POSITION_TYPE              (XY_POSITION_TYPE - MHEG5_TYPE)
#define NORM_SEQ_SIZE_OF_ACTION_SLOT       (SEQ_SIZE_OF_ACTION_SLOT - MHEG5_TYPE)
#define NORM_SEQ_SIZE_OF_ELEMENTARY_ACTION (SEQ_SIZE_OF_ELEMENTARY_ACTION - MHEG5_TYPE)
#define NORM_ACTION_CLASS_TYPE             (ACTION_CLASS_TYPE - MHEG5_TYPE)
#define NORM_SEQ_SIZE_OF_INTEGER           (SEQ_SIZE_OF_INTEGER - MHEG5_TYPE)
#define NORM_SEQ_SIZE_OF_PARAMETER         (SEQ_SIZE_OF_PARAMETER - MHEG5_TYPE)
#define NORM_SEQ_SIZE_OF_POINT             (SEQ_SIZE_OF_POINT - MHEG5_TYPE)
#define NORM_SEQ_SIZE_OF_OBJECT_REFERENCE  (SEQ_SIZE_OF_OBJECT_REFERENCE - MHEG5_TYPE)
#define NORM_INVALID_SEQ_TYPE              (INVALID_SEQ_TYPE - MHEG5_TYPE)
#define NORM_EVENT_TYPE                    (EVENT_TYPE - MHEG5_TYPE)
#define NORM_EVENT_DATA_TYPE               (EVENT_DATA_TYPE - MHEG5_TYPE)
#define NORM_EVENT_SOURCE_TYPE             (EVENT_SOURCE_TYPE - MHEG5_TYPE)
#define NORM_OBJECT_REFERENCE_TYPE         (OBJECT_REFERENCE_TYPE - MHEG5_TYPE)
#define NORM_ACTION_SLOT_TYPE              (ACTION_SLOT_TYPE - MHEG5_TYPE)
#define NORM_COMPARISON_VALUE_TYPE         (COMPARISON_VALUE_TYPE - MHEG5_TYPE)
#define NORM_CONN_TAG_OR_NULL_TYPE         (CONN_TAG_OR_NULL_TYPE - MHEG5_TYPE)
#define NORM_EMULATED_EVENT_DATA           (EMULATED_EVENT_DATA - MHEG5_TYPE)
#define NORM_GENERIC_BOOLEAN               (GENERIC_BOOLEAN - MHEG5_TYPE)
#define NORM_GENERIC_CONTENT_REFERENCE     (GENERIC_CONTENT_REFERENCE - MHEG5_TYPE)
#define NORM_GENERIC_INTEGER               (GENERIC_INTEGER - MHEG5_TYPE)
#define NORM_GENERIC_OBJECT_REFERENCE      (GENERIC_OBJECT_REFERENCE - MHEG5_TYPE)
#define NORM_GENERIC_OCTET_STRING          (GENERIC_OCTET_STRING - MHEG5_TYPE)
#define NORM_NEW_COLOUR                    (NEW_COLOUR - MHEG5_TYPE)
#define NORM_NEW_CONTENT                   (NEW_CONTENT - MHEG5_TYPE)
#define NORM_NEW_FONT                      (NEW_FONT - MHEG5_TYPE)
#define NORM_NEW_VARIABLE_VALUE            (NEW_VARIABLE_VALUE - MHEG5_TYPE)
#define NORM_PARAMETER_TYPE                (PARAMETER_TYPE - MHEG5_TYPE)
#define NORM_CONTENT_REFERENCE_TYPE        (CONTENT_REFERENCE_TYPE - MHEG5_TYPE)


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

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

/*---global function definitions---------------------------------------------*/
static fpa1_syntaxList* fpa1_typeSequence( int, vpa1_filePos );

static fpa1_syntaxList* fpa1_typeSequence( int whichType, vpa1_filePos filePosLimit )
{
   int tag;
   vpa1_filePos curFilePosition, nextTagPosition;

   fpa1_syntaxList *itemPtr = NULL;
   fpa1_syntaxList *childPtr = NULL;
   unsigned short childCnt[3] = { 0, 0, 0 };
   unsigned short startGenericDataCnt = fpa1_GenericDataCount;

   /* save current file position */
   curFilePosition = fpa1_rdfGetCurrentFilePosition();
   tag = fpa1_rdfGetTag();

   /* test for the correct leading tag */
   if (tag == SEQUENCE)
   {
      /* get next tag position */
      nextTagPosition = fpa1_rdfGetNextTagPosn();

      /* move to contents */
      fpa1_rdfMoveToContents();

      switch (whichType)
      {
         case NORM_EXTERNAL_REFERENCE_TYPE:
            childPtr = fpa1_sequenceParse( childCnt, extRefSeqCompArr, filePosLimit );
            /*extern ref is finally stored as one param, not as 'string' and 'int', so decrement by one */
            fpa1_GenericDataCount--;
            break;
         case NORM_NEW_REFERENCED_CONTENT:
            childPtr = fpa1_sequenceParse( childCnt, newRefConSeqCompArr, filePosLimit );
            break;
         case NORM_NEW_TIMER:
            childPtr = fpa1_sequenceParse( childCnt, newTimerSeqCompArr, filePosLimit );
            break;
         case NORM_NEXT_SCENE_TYPE:
            /* has MHEG5BRACKETOPEN, OCTETSTRING, INTEGER, MHEG5BRACKETCLOSE */
            fpa1_GenericDataCount += 4;
            childPtr = fpa1_sequenceParse( childCnt, nextSceneSeqCompArr, filePosLimit );
            break;
         case NORM_POINT_TYPE:
            /* MHEG5BRACKETOPEN, MHEG5BRACKETCLOSE*/
            fpa1_GenericDataCount += 2;
            childPtr = fpa1_sequenceParse( childCnt, pointSeqCompArr, filePosLimit );
            break;
         case NORM_RATIONAL_TYPE:
            childPtr = fpa1_sequenceParse( childCnt, rationalSeqCompArr, filePosLimit );
            break;
         case NORM_REFERENCED_CONTENT_TYPE:
            childPtr = fpa1_sequenceParse( childCnt, refCntSeqCompArr, filePosLimit );
            break;
         case NORM_TOKEN_GROUP_ITEM_TYPE:
            childPtr = fpa1_sequenceParse( childCnt, tokGrpItmsSeqCompArr, filePosLimit );
            break;
         case NORM_XY_POSITION_TYPE:
            childPtr = fpa1_sequenceParse( childCnt, xyPosSeqCompArr, filePosLimit );
            break;

         /* untagged SEQUENCE OF SIZE stuff */
         case NORM_SEQ_SIZE_OF_ACTION_SLOT:
            childPtr = fpa1_sequenceOfParse( childCnt, SEQ_OF_ACTION_SLOT, filePosLimit );
            break;
         case NORM_SEQ_SIZE_OF_ELEMENTARY_ACTION:
            childPtr = fpa1_sequenceOfParse( childCnt, SEQ_OF_ELEMENTARY_ACTION, filePosLimit );
            fpa1_GroupActionCount += *childCnt;
            fpa1_GroupParamCount += fpa1_GenericDataCount - startGenericDataCnt;
            break;
         case NORM_SEQ_SIZE_OF_INTEGER:
            childPtr = fpa1_sequenceOfParse( childCnt, SEQ_OF_INTEGER, filePosLimit );
            break;
         case NORM_SEQ_SIZE_OF_PARAMETER:
            childPtr = fpa1_sequenceOfParse( childCnt, SEQ_OF_PARAMETER, filePosLimit );
            break;
         case NORM_SEQ_SIZE_OF_POINT:
            /* MHEG5BRACKETOPEN, MHEG5BRACKETCLOSE*/
            fpa1_GenericDataCount += 2;
            childPtr = fpa1_sequenceOfParse( childCnt, SEQ_OF_POINT, filePosLimit );
            break;
         case NORM_SEQ_SIZE_OF_OBJECT_REFERENCE:
            /* MHEG5BRACKETOPEN, MHEG5BRACKETCLOSE*/
            fpa1_GenericDataCount += 2;
            childPtr = fpa1_sequenceOfParse( childCnt, SEQ_OF_OBJECT_REFERENCE, filePosLimit );
            break;
         default:
            childPtr = NULL;
            break;
      }

      if (childPtr != NULL)
      {
         /* success ! */

         /* create parent item - use MHEG5_TYPE as tag ID */
         itemPtr = fpa1_synCreateListItem( whichType + MHEG5_TYPE,
               curFilePosition,
               nextTagPosition );
         if (itemPtr != NULL)
         {
            itemPtr->children = childPtr;
            itemPtr->childCount[0] = childCnt[0];
            itemPtr->childCount[1] = childCnt[1];
            itemPtr->childCount[2] = childCnt[2];
            itemPtr->dataTotal = fpa1_GenericDataCount - startGenericDataCnt;
         }
      }
   }

   return itemPtr;
} /* fpa1_typeSequence() */

fpa1_syntaxList* fpa1_typeParse( int whichType, vpa1_filePos filePosLimit )
{
   fpa1_syntaxList *itemPtr;

   /* normalize whichType */
   whichType = whichType - MHEG5_TYPE;

   /* Do SEQUENCE types */
   if ((whichType > NORM_SEQUENCE_TYPE) &&
       (whichType < NORM_INVALID_SEQ_TYPE))
   {
      itemPtr = fpa1_typeSequence( whichType, filePosLimit );
   }
   else
   {
      /* do types without leading tag */
      switch (whichType)
      {
         /* ENUMERATED types */
         case NORM_EVENT_TYPE:
            itemPtr = fpa1_decodeEnumeratedType( filePosLimit );
            /* Tagged as Enumerated - distinguish it */
            if (itemPtr != NULL)
            {
               /* use MHEG5_TYPE as tag */
               itemPtr->tag = whichType + MHEG5_TYPE;
            }
            break;

         /* CHOICE types */
         case NORM_EVENT_DATA_TYPE:
            itemPtr = fpa1_choiceParse( evtDatChoiceCompArr );
            /* Untagged - distinguish it */
            if (itemPtr != NULL)
            {
               /* use MHEG5_TYPE as tag */
               itemPtr->tag = whichType + MHEG5_TYPE;
            }
            break;
         case NORM_EVENT_SOURCE_TYPE:
         case NORM_OBJECT_REFERENCE_TYPE:
            itemPtr = fpa1_choiceParse( objRefChoiceCompArr );
            if ((whichType == NORM_EVENT_SOURCE_TYPE) &&
                (itemPtr != NULL))
            {
               /* use MHEG5_TYPE as tag */
               itemPtr->tag = whichType + MHEG5_TYPE;
            }
            break;
         case NORM_ACTION_SLOT_TYPE:
            itemPtr = fpa1_choiceParse( actSlotChoiceCompArr );
            break;
         case NORM_COMPARISON_VALUE_TYPE:
            itemPtr = fpa1_choiceParse( compValueChoiceCompArr );
            break;
         case NORM_CONN_TAG_OR_NULL_TYPE:
            itemPtr = fpa1_choiceParse( connTagChoiceCompArr );
            break;
         case NORM_EMULATED_EVENT_DATA:
            itemPtr = fpa1_choiceParse( emulEvtDatChoiceCompArr );
            break;
         case NORM_GENERIC_BOOLEAN:
            itemPtr = fpa1_choiceParse( genBooleanChoiceCompArr );
            break;
         case NORM_GENERIC_CONTENT_REFERENCE:
            itemPtr = fpa1_choiceParse( genContRefChoiceCompArr );
            break;
         case NORM_GENERIC_INTEGER:
            itemPtr = fpa1_choiceParse( genIntChoiceCompArr );
            break;
         case NORM_GENERIC_OBJECT_REFERENCE:
            itemPtr = fpa1_choiceParse( genObjRefChoiceCompArr );
            break;
         case NORM_GENERIC_OCTET_STRING:
            itemPtr = fpa1_choiceParse( genOctStrChoiceCompArr );
            break;
         case NORM_NEW_COLOUR:
            itemPtr = fpa1_choiceParse( newColourChoiceCompArr );
            break;
         case NORM_NEW_CONTENT:
            itemPtr = fpa1_choiceParse( newContentChoiceCompArr );
            break;
         case NORM_NEW_FONT:
            itemPtr = fpa1_choiceParse( newFontChoiceCompArr );
            break;
         case NORM_PARAMETER_TYPE:
            itemPtr = fpa1_choiceParse( paramChoiceCompArr );
            break;

         /* STRING types */
         case NORM_CONTENT_REFERENCE_TYPE:
            /* Octet string  pretend it's a CHOICE of two elements */
            /* OCTETSTRING and CONTREF. The latter is due to an anomaly */
            /* in the Text conversion of GenericObjectReference */
            itemPtr = fpa1_choiceParse( octStrChoiceCompsArr );
            if (itemPtr != NULL)
            {
               /* force it to a string - due to Text conversion anomaly */
               /* in GenericContentReference                            */
               itemPtr->tag = OCTETSTRING;
            }

            break;

         default:
            itemPtr = NULL;
            break;
      }
   }

   return itemPtr;
}