/*

* Copyright (c) 2010 Ixonos Plc.

* All rights reserved.

* This component and the accompanying materials are made available

* under the terms of the "Eclipse Public License v1.0"

* which accompanies this distribution, and is available

* at the URL "http://www.eclipse.org/legal/epl-v10.html".

*

* Initial Contributors:

* Nokia Corporation - Initial contribution

*

* Contributors:

* Ixonos Plc

*

* Description:  

* H.263 bitstream parsing.

*

*/

/*

 * Includes

 */

#include "h263dConfig.h"

#include "viddemux.h"

#include "vdxint.h"

#include "debug.h"

#include "biblin.h"

/* MVE */

#include "MPEG4Transcoder.h"

/*

 * Defines

 */

#ifdef DEB_STDOUT

/* Use back-channel debug output file when printing back-channel related 

   messages. */

#include <stdio.h>

extern FILE *bcmDebFile;

#endif

/*

 * Module-scope typedefs

 */

/* Another type for VLC (variable length code) lookup tables used in 

   Annex I implementation.*/

typedef struct {

   u_char LAST;   /* see section 5.4.2 of the H.263 recommendation */

   u_char RUN;    /* to understand LAST, RUN and LEVEL */

   u_char LEVEL;

   u_char len;    /* actual length of code in bits */

} vdxVLCTableNew_t;

/*

 * Global constants

 */

/* Used to convert a luminance block index defined in section 4.2.1

   of the H.263 recommendation to a coded block pattern mask (see sections

   5.3.4 and 5.3.5 of the H.263 recommendation. 

   See also macros section in viddemux.h. */

const int vdxBlockIndexToCBPYMask[5] = {0, 8, 4, 2, 1};

const int vdxYBlockIndexToCBPBMask[5] = {0, 32, 16, 8, 4};

/*

 * Local function prototypes

 */

/* Picture Layer */

static int vdxActAfterIncorrectSEI(

   bibBuffer_t *inBuffer,

   int fPLUSPTYPE,

   int *fLast,

   int *bitErrorIndication);

static void vdxStandardSourceFormatToFrameSize(int sourceFormat, int *width, int *height);

/* Slice Layer */

int vdxFrameSizeToPictureFormat(int width, int height);

/* Macroblock Layer */

static int vdxGetIntraMode(bibBuffer_t *inBuffer,int *index,

   int *bitErrorIndication);

static int vdxUMVGetMVD(bibBuffer_t *inBuffer,int *mvdx10,

   int *bitErrorIndication);

static int vdxGetNormalMODB(bibBuffer_t *inBuffer, int *index, 

   int *bitErrorIndication);

static int vdxGetImpPBMODB(bibBuffer_t *inBuffer, int *index,

   int *bitErrorIndication);

/*

 * Picture Layer Global Functions

 */

/* {{-output"vdxGetPictureHeader.txt"}} */

/*

 * vdxGetPictureHeader

 *    

 *

 * Parameters:

 *    inBuffer                   pointer to bit buffer instance

 *    inpParam                   input parameters

 *    header                     output parameters: picture header

 *    bitErrorIndication         non-zero if a bit error has been detected

 *                               within the bits accessed in this function,

 *                               see biterr.h for possible values

 *

 * Function:

 *    This function reads the H.263 picture header.

 *

 * Returns:

 *    VDX_OK                     the function was successful

 *    VDX_OK_BUT_BIT_ERROR       the function behaved normally, but a bit error

 *                               occured

 *    VDX_ERR_BIB                an error occured when accessing bit buffer

 *

 *    

 */

int vdxGetPictureHeader(

   bibBuffer_t *inBuffer, 

   const vdxGetPictureHeaderInputParam_t *inpParam,

   vdxPictureHeader_t *header,

   int *bitErrorIndication)

/* {{-output"vdxGetPictureHeader.txt"}} */

{

   bibFlushBits_t

      flushBits;

   bibGetBits_t

      getBits;

   int

      numBitsGot,

      bits1To5OfPTYPE,

      sourceFormat;

   int16

      bibError = 0;

   u_int32 tmp = 0;          /* temporary variable for reading some redundant bits */

   vdxAssert(inBuffer != NULL);

   vdxAssert(inpParam != NULL);

   vdxAssert(inpParam->flushBits != NULL);

   vdxAssert(inpParam->getBits != NULL);

   vdxAssert(header != NULL);

   vdxAssert(bitErrorIndication != NULL);

   flushBits = inpParam->flushBits;

   getBits = inpParam->getBits;

   memset(header, 0, sizeof(vdxPictureHeader_t));

   *bitErrorIndication = 0;

   /* Assume that the existence of a PSC has been checked,

      it is the next code in the buffer, and

      its byte alignment has been checked */

   /* Flush stuffing (PSTUF) */

   if (inpParam->numStuffBits) {

      flushBits(inpParam->numStuffBits, inBuffer, &numBitsGot, bitErrorIndication, &bibError);

   }

   /* Flush PSC */

   flushBits(22, inBuffer, &numBitsGot, bitErrorIndication, &bibError);

   /* PSC cannot contain fatal bit errors (checked earlier) */

   header->numBits += 22;

   *bitErrorIndication = 0;   

   /* TR */

   header->tr = (int) getBits(8, inBuffer, &numBitsGot, bitErrorIndication,

      &bibError);

   header->numBits += 8;

   #ifdef DEB_STDOUT

      if (bcmDebFile)

         deb1f(bcmDebFile, "TR %d\n", header->tr);

   #endif

   /* The first 5 bits from PTYPE */

   bits1To5OfPTYPE = (int) getBits(5, inBuffer, &numBitsGot,

      bitErrorIndication, &bibError);

   header->numBits += 5;

   /* PTYPE bit 1 should be 1 */

   if ((bits1To5OfPTYPE & 16) == 0 ) {

      deb0p("ERROR. PTYPE bit 1 invalid.\n");

      goto exitAfterBitError;

   }

   /* PTYPE bit 2 should be 0 for distinction with H.261 */

   if (bits1To5OfPTYPE & 8) {

      deb0p("ERROR. PTYPE bit 2 indicates H.261.\n");

      goto exitAfterBitError;

   }

   /* PTYPE bit 3, Split Screen Indicator */

   header->fSplitScreen = ((bits1To5OfPTYPE & 4) > 0);

   /* PTYPE bit 4, Document camera indicator */

   header->fDocumentCamera = ((bits1To5OfPTYPE & 2) > 0);

   /* PTYPE bit 5, Freeze Picture Release */

   header->fFreezePictureRelease = (bits1To5OfPTYPE & 1);

   /* PTYPE bits 6 - 8, Source Format */

   sourceFormat = (int) getBits(3, inBuffer, &numBitsGot,

      bitErrorIndication, &bibError);

   header->numBits += 3;

   /* If H.263 version 1 */

   if (sourceFormat >= 1 && sourceFormat <= 5) {

      int bits9To13OfPTYPE;

      header->fPLUSPTYPE = 0;

      vdxStandardSourceFormatToFrameSize(sourceFormat, &header->lumWidth, &header->lumHeight);

      /* PTYPE bits 9 - 13 */

      bits9To13OfPTYPE = (int) getBits(5, inBuffer, &numBitsGot,

         bitErrorIndication, &bibError);

      header->numBits += 5;

      /* PTYPE bit 9, Picture coding type */

      header->pictureType = ((bits9To13OfPTYPE & 16) > 0);

      /* PTYPE bit 10, Unrestricted motion vector mode */

      header->fUMV = ((bits9To13OfPTYPE & 8) > 0);

      /* PTYPE bit 11, Syntax-based Arithmetic Coding mode */

      header->fSAC = ((bits9To13OfPTYPE & 4) > 0);

      /* PTYPE bit 12, Advanced prediction mode */

      header->fAP = ((bits9To13OfPTYPE & 2) > 0);

      /* PTYPE bit 13, PB-frames mode */

      /* If PTYPE bit 9 indicates a P-picture */

      if (header->pictureType) {

         /* Check if it is actually a PB-picture */

         if (bits9To13OfPTYPE & 1)

            header->pictureType = VDX_PIC_TYPE_PB;

      }

      /* Else PTYPE bit 9 indicates an I-picture */

      else {

         /* Check that bit 13 is 0 */

         if (bits9To13OfPTYPE & 1) {

            deb0p("ERROR. PTYPE bit 9 and 13 mismatch.\n");

            goto exitAfterBitError;

         }

      }

   }

   /* Else if H.263 version 2 (PLUSPTYPE) */

   else if (sourceFormat == 7) {

      int bits4To9OfMPPTYPE;

      header->fPLUSPTYPE = 1;

      /* UFEP */

      header->ufep = (int) getBits(3, inBuffer, &numBitsGot,

         bitErrorIndication, &bibError);

      header->numBits += 3;

      if (header->ufep > 1) {

         deb0p("ERROR. UFEP illegal.\n");

         goto exitAfterBitError;

      }

      /* If UFEP = '001' */

      if (header->ufep) {

         int bits4To18OfOPPTYPE;

         /* OPPTYPE bits 1 - 3, Source format */

         sourceFormat = (int) getBits(3, inBuffer, &numBitsGot,

            bitErrorIndication, &bibError);

         header->numBits += 3;

         if (sourceFormat >= 1 && sourceFormat <= 5) {

            header->fCustomSourceFormat = 0;

            vdxStandardSourceFormatToFrameSize(sourceFormat, 

               &header->lumWidth, &header->lumHeight);

         }

         else if (sourceFormat == 6)

            header->fCustomSourceFormat = 1;

         else {

            deb0p("ERROR. Source format illegal.\n");

            goto exitAfterBitError;

         }

         /* OPPTYPE bits 4 - 18 */

         bits4To18OfOPPTYPE = (int) getBits(15, inBuffer, &numBitsGot,

            bitErrorIndication, &bibError);

         header->numBits += 15;

         /* OPPTYPE bit 4, Custom PCF */

         header->fCustomPCF = ((bits4To18OfOPPTYPE & 0x4000) > 0);

         /* OPPTYPE bit 5, Unrestricted Motion Vector mode */

         header->fUMV = ((bits4To18OfOPPTYPE & 0x2000) > 0);

         /* OPPTYPE bit 6, Syntax-based Arithmetic Coding mode */

         header->fSAC = ((bits4To18OfOPPTYPE & 0x1000) > 0);

         /* OPPTYPE bit 7, Advanced Prediction mode */

         header->fAP = ((bits4To18OfOPPTYPE & 0x0800) > 0);

         /* OPPTYPE bit 8, Advanced INTRA Coding mode */

         header->fAIC = ((bits4To18OfOPPTYPE & 0x0400) > 0);

         /* OPPTYPE bit 9, Deblocking filter mode */

         header->fDF = ((bits4To18OfOPPTYPE & 0x0200) > 0);

         /* OPPTYPE bit 10, Slice Structured mode */

         header->fSS = ((bits4To18OfOPPTYPE & 0x0100) > 0);

         /* OPPTYPE bit 11, Reference Picture Selection mode */

         header->fRPS = ((bits4To18OfOPPTYPE & 0x0080) > 0);

         /* OPPTYPE bit 12, Independent Segment Decoding mode */

         header->fISD = ((bits4To18OfOPPTYPE & 0x0040) > 0);

         /* OPPTYPE bit 13, Alternative Inter VLC mode */

         header->fAIV = ((bits4To18OfOPPTYPE & 0x0020) > 0);

         /* OPPTYPE bit 14, Modified Quantization mode */

         header->fMQ = ((bits4To18OfOPPTYPE & 0x0010) > 0);

         /* OPPTYPE bits 15 - 18 must be '1000' */

         if ((bits4To18OfOPPTYPE & 0x000F) != 8) {

            deb0p("ERROR. OPPTYPE bits 15 - 18 illegal.\n");

            goto exitAfterBitError;

         }

         /* Mode interaction restrictions, see section 5.1.4.6 of 

            the H.263 recommendation */

         if (header->fSAC && (header->fAIV || header->fMQ || header->fUMV)) {

            deb0p("ERROR. Illegal bit pattern (section 5.1.4.6).\n");

            goto exitAfterBitError;

         }

      }

      /* MPPTYPE, bits 1 - 3, Picture type code */

      header->pictureType = (int) getBits(3, inBuffer, &numBitsGot,

         bitErrorIndication, &bibError);

      header->numBits += 3;

      if (header->pictureType >= 6) {

         deb0p("ERROR. Picture type code illegal.\n");

         goto exitAfterBitError;

      }

      /* MPPTYPE, bits 4 - 9 */

      bits4To9OfMPPTYPE = (int) getBits(6, inBuffer, &numBitsGot,

         bitErrorIndication, &bibError);

      header->numBits += 6;

      /* MPPTYPE bit 4, Reference Picture Resampling mode */

      header->fRPR = ((bits4To9OfMPPTYPE & 32) > 0);

      /* MPPTYPE bit 5, Reduced-Resolution Update mode */

      header->fRRU = ((bits4To9OfMPPTYPE & 16) > 0);

      /* RPR/RRU must not be set for I or EI-pictures.

         (See section 5.1.4.5 of the H.263 recommendation.) */

      if ((header->fRPR || header->fRRU) &&

         (header->pictureType == VDX_PIC_TYPE_I || 

            header->pictureType == VDX_PIC_TYPE_EI)) {

         deb0p("ERROR. RPR or RRU is set for I or EI.\n");

         goto exitAfterBitError;

      }

      /* MPPTYPE bit 6, Rounding type */

      header->rtype = ((bits4To9OfMPPTYPE & 8) > 0);

      /* RTYPE must be 0 if other than P, Improved PB or EP picture

         (see section 5.1.4.3 of the H.263 recommendation */

      /* MPPTYPE bits 7 - 9, must be '001' */

      if ((bits4To9OfMPPTYPE & 7) != 1) {

         deb0p("ERROR. MPPTYPE bits 7 - 9 illegal.\n");

         goto exitAfterBitError;

      }

      /* CPM */

      header->cpm = (int) getBits(1, inBuffer, &numBitsGot,

         bitErrorIndication, &bibError);

      header->numBits += 1;

      if (header->cpm) {

         /* PSBI */

         header->psbi = (int) getBits(2, inBuffer, &numBitsGot,

            bitErrorIndication, &bibError);

         header->numBits += 2;

      }

      if (header->fCustomSourceFormat) {

         int parCode, fExtendedPAR = 0, pwi, phi;

         /* CPFMT bits 1 - 4, Pixel Aspect Ratio code */

         parCode = (int) getBits(4, inBuffer, &numBitsGot,

            bitErrorIndication, &bibError);

         header->numBits += 4;

         switch (parCode) {

            case 1: /* Square */

               header->parWidth = 1;

               header->parHeight = 1;

               break;

            case 2: /* CIF for 4:3 picture */

               header->parWidth = 12;

               header->parHeight = 11;

               break;

            case 3: /* 525-type for 4:3 picture */

               header->parWidth = 10;

               header->parHeight = 11;

               break;

            case 4: /* CIF stretched for 16:9 picture */

               header->parWidth = 16;

               header->parHeight = 11;

               break;

            case 5: /* 525-type stretched for 16:9 picture */

               header->parWidth = 40;

               header->parHeight = 33;

               break;

            case 15: /* extended PAR */

               fExtendedPAR = 1;

               break;

            default:

               deb0p("ERROR. PAR code illegal.\n");

               goto exitAfterBitError;

         }

         /* CPFMT bits 5 - 13, picture width indication */

         pwi = (int) getBits(9, inBuffer, &numBitsGot,

            bitErrorIndication, &bibError);

         header->numBits += 9;

         header->lumWidth = ((pwi + 1) <<2 /** 4*/);

         /* CPFMT bit 14 must be 1 */

         tmp = getBits(1, inBuffer, &numBitsGot, bitErrorIndication, &bibError);

         header->numBits += 1;

         if ( tmp == 0 ) {

            deb0p("ERROR. CPFMT bit 14 is 0.\n");

            goto exitAfterBitError;

         }

         /* CPFMT bits 15 - 23, picture height indication */

         phi = (int) getBits(9, inBuffer, &numBitsGot,

            bitErrorIndication, &bibError);

         header->numBits += 9;

         if (phi == 0 || phi > 288) {

            deb0p("ERROR. PHI illegal.\n");

            goto exitAfterBitError;

         }

         header->lumHeight = (phi <<2 /** 4*/);

         if (fExtendedPAR) {

            /* EPAR bits 1 - 8, PAR Width */

            header->parWidth = (int) getBits(8, inBuffer, &numBitsGot,

               bitErrorIndication, &bibError);

            header->numBits += 8;

            if (header->parWidth == 0) {

               deb0p("ERROR. PAR width illegal.\n");

               goto exitAfterBitError;

            }

            /* EPAR bits 9 - 16, PAR Height */

            header->parHeight = (int) getBits(8, inBuffer, &numBitsGot,

               bitErrorIndication, &bibError);

            header->numBits += 8;

            if (header->parHeight == 0) {

               deb0p("ERROR. PAR height illegal.\n");

               goto exitAfterBitError;

            }

         }

      } /* endif (customSourceFormat) */

      if (header->fCustomPCF) {

         int clockConversionCode;

         u_int32 clockDivisor, conversionFactor;