/*

* 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:  

* MPEG-4 bitstream parsing.

*

*/

/*

 * Includes

 */

#include "h263dConfig.h"

#include "viddemux.h"

#include "vdxint.h"

#include "mpegcons.h"

#include "sync.h"

#include "vdcaic.h"

#include "zigzag.h"

#include "debug.h"

#include "biblin.h"

/* MVE */

#include "MPEG4Transcoder.h"

// <--

/*

 * Local function prototypes

 */

/* Macroblock Layer */

static int vdxGetIntraDCSize(bibBuffer_t *inBuffer, int compnum, int *IntraDCSize, 

   int *bitErrorIndication);

static int vdxGetRVLCIndex(u_int32 bits, u_int32 *index, int *length, int intra_luma,

   int *bitErrorIndication);

/*

 * Picture Layer Global Functions

 */

/*

 *

 * vdxGetVolHeader

 *

 * Parameters:

 *    inBuffer                   pointer to bit buffer instance

 *    header                     output parameters: VOL 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 VO and VOL header from inBuffer.

 *

 * 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

 *    VDX_ERR_NO_START_CODE      if start code is not found

 *    VDX_ERR_NOT_SUPPORTED      if VOL header 

 *

 *    

 */

int vdxGetVolHeader(

   bibBuffer_t *inBuffer,

   vdxVolHeader_t *header,

   int *bitErrorIndication,

   int getInfo, int *aByteIndex, int *aBitIndex, CMPEG4Transcoder *hTranscoder)

{

   int bitsGot, sncCode, fUseDefaultVBVParams = 0, num_bits;

   int16 bibError = 0;

   u_int32 bits;

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

   *bitErrorIndication = 0;

   /* if Visual Object Sequence Start Code is present */

   bits = bibShowBits(MP4_VOS_START_CODE_LENGTH, inBuffer, &bitsGot, bitErrorIndication, &bibError);

   if (bits == MP4_VOS_START_CODE) {

      /* vos_start_code */

      bibFlushBits(MP4_VOS_START_CODE_LENGTH, inBuffer, &bitsGot, bitErrorIndication, &bibError);

      /* profile_and_level_indication (8 bits) */

      bits = bibGetBits(8, inBuffer, &bitsGot, bitErrorIndication, &bibError);

      /* If fatal bit error occurred (lost segment/packet etc.) */

      /*   

           1: Simple Profile Level 1   (from ISO/IEC 14496-2:1999/FPDAM4 [N4350] July 2001)

           2: Simple Profile Level 2   (from ISO/IEC 14496-2:1999/FPDAM4 [N4350] July 2001) 

           3: Simple Profile Level 3   (from ISO/IEC 14496-2:1999/FPDAM4 [N4350] July 2001) 

           8: Simple Profile Level 0   (from ISO/IEC 14496-2:1999/FPDAM4 [N5743] July 2003)

           9: Simple Profile Level 0b  (from ISO/IEC 14496-2:1999/FPDAM4 [N5743] July 2003)

      */

#if 0

      // Disabled since some clips have this set incorrectly, and this is not used for anything important.

      // Only simple profile clips seem to be available so this should not cause any harm.

      // Further, it is still checked in vedVolReader which is always used before editing. It is not checked only when creating thumbnails

      if (bits != 1 && bits != 2 && bits != 3 && bits != 8 && bits != 9) {

         /* this is not a supported simple profile stream */

         deb("vdxGetMPEGVolHeader: ERROR - This is not a supported simple profile stream\n");

         goto notSupported;

      }

#endif

      if (bits != 8 && bits != 9) 

        header->profile_level = (int) bits;

      else

        header->profile_level = 0;

      /* User data if available */

      bits = bibShowBits(32, inBuffer, &bitsGot, bitErrorIndication, &bibError);

      if (bits == MP4_USER_DATA_START_CODE)

      {

           if (!header->user_data) {

               header->user_data = (char *) malloc(MAX_USER_DATA_LENGTH);

               header->user_data_length = 0;

           }

           if (vdxGetUserData(inBuffer, header->user_data, &(header->user_data_length), bitErrorIndication) != VDX_OK)

               /* also bibError will be handled in exitAfterBitError */

               goto exitAfterBitError;               

       }

   }

   /* if Visual Object Start Code is present */

   bits = bibShowBits(MP4_VO_START_CODE_LENGTH, inBuffer, &bitsGot, bitErrorIndication, &bibError);

   if (bits == MP4_VO_START_CODE) {

      /* visual_object_start_code */

      bibFlushBits(MP4_VO_START_CODE_LENGTH, inBuffer, &bitsGot, bitErrorIndication, &bibError);

      /* is_visual_object_identifier (1 bit) */

      bits = bibGetBits(1, inBuffer, &bitsGot, bitErrorIndication, &bibError);

      if (bits) {

         /* visual_object_ver_id (4 bits) */

         bits = bibGetBits(4, inBuffer, &bitsGot, bitErrorIndication, &bibError);

         if (bits != 1) {

            /* this is not an MPEG-4 version 1 stream */

            deb("vdxGetMPEGVolHeader: ERROR - This is not an MPEG-4 version 1 stream\n");

            goto notSupported;

         }

         /* visual_object_priority (3 bits) */

         bits = bibGetBits(3, inBuffer, &bitsGot, bitErrorIndication, &bibError);

         header->vo_priority = (int) bits;

      } else {

         header->vo_priority = 0;

      }

      /* visual_object_type (4 bits) */

      bits = bibGetBits(4, inBuffer, &bitsGot, bitErrorIndication, &bibError);

      if (bits != 1) {

         /* this is not a video object */

         deb("vdxGetMPEGVolHeader: ERROR - This is not a video object\n");

         goto notSupported;

      }

      /* is_video_signal_type (1 bit) */

      bits = bibGetBits(1, inBuffer, &bitsGot, bitErrorIndication, &bibError);

      if (bits) {

           /* Note: The following fields in the bitstream give information about the 

              video signal type before encoding. These parameters don't influence the 

              decoding algorithm, but the composition at the output of the video decoder.

              There is no normative requirement however to utilize this information 

              during composition, therefore until a way to utilize them is found in

              MoViDe, these fields are just dummyly read, but not interpreted.

              For interpretation see the MPEG-4 Visual standard */

         /* video_format (3 bits) */

         bits = bibGetBits(3, inBuffer, &bitsGot, bitErrorIndication, &bibError);

         header->video_format = (int) bits;

         /* video_range (1 bit) */

         bits = bibGetBits(1, inBuffer, &bitsGot, bitErrorIndication, &bibError);

         header->video_range = (int) bits;

         /* colour_description (1 bit) */

         bits = bibGetBits(1, inBuffer, &bitsGot, bitErrorIndication, &bibError);

         if (bits) {

            /* colour_primaries (8 bits) */

            bits = bibGetBits(8, inBuffer, &bitsGot, bitErrorIndication, &bibError);

            header->colour_primaries = (int) bits;

            /* transfer_characteristics (8 bits) */

            bits = bibGetBits(8, inBuffer, &bitsGot, bitErrorIndication, &bibError);

            header->transfer_characteristics = (int) bits;

            /* matrix_coefficients (8 bits) */

            bits = bibGetBits(8, inBuffer, &bitsGot, bitErrorIndication, &bibError);

            header->matrix_coefficients = (int) bits;

         } else {

            header->colour_primaries = 1; /* default: ITU-R BT.709 */

            header->transfer_characteristics = 1; /* default: ITU-R BT.709 */

            header->matrix_coefficients = 1; /* default: ITU-R BT.709 */

         }

      } else {

         /* default values */

         header->video_format = 5; /* Unspecified video format */

         header->video_range = 0; /* Y range 16-235 pixel values */

         header->colour_primaries = 1; /* ITU-R BT.709 */

         header->transfer_characteristics = 1; /* ITU-R BT.709 */

         header->matrix_coefficients = 1; /* ITU-R BT.709 */

      }

      /* check the next start code */

      sncCode = sncCheckMpegSync(inBuffer, 0, &bibError);

      /* If User data is available */

      if (sncCode == SNC_USERDATA)

      {

         if (!header->user_data) {

            header->user_data = (char *) malloc(MAX_USER_DATA_LENGTH);

            header->user_data_length = 0;

         }

         if (vdxGetUserData(inBuffer, header->user_data, &(header->user_data_length), bitErrorIndication) != VDX_OK)

            /* also bibError will be handled in exitAfterBitError */

            goto exitAfterBitError;      

      } else if (sncCode != SNC_VID) {

         deb("vdxGetMPEGVolHeader: ERROR. No Start code after VO header\n");

         goto exitAfterBitError;

      }

   }

   /* if Video Object Start Code is present */

   bits = bibShowBits(MP4_VID_START_CODE_LENGTH, inBuffer, &bitsGot, bitErrorIndication, &bibError);

   if (bits == MP4_VID_START_CODE) {

       /* video_object_start_code */

      bibFlushBits(MP4_VID_START_CODE_LENGTH, inBuffer, &bitsGot, bitErrorIndication, &bibError);

      /* video_object_id */

      bits = bibGetBits(MP4_VID_ID_CODE_LENGTH, inBuffer, &bitsGot, bitErrorIndication, &bibError);

      header->vo_id = (int) bits;

   }

   /* MVE */

   /* dummy indication of the position before VOL start code, only for recoginition of shortheader */

   if (!getInfo)

   {

       hTranscoder->ErrorResilienceInfo(NULL, inBuffer->getIndex, inBuffer->bitIndex);

   }

   /* vol_start_code */

   bits = bibShowBits(MP4_VOL_START_CODE_LENGTH, inBuffer, &bitsGot, bitErrorIndication, &bibError);

   if(bits != MP4_VOL_START_CODE)

   {

      /* If H.263 PSC, this is a short header stream, i.e. H.263 baseline */

      if ( (bits >> 6) == 32 ) {

         return VDX_OK;

      } else {      

         deb("vdxGetMPEGVolHeader: ERROR - Bitstream does not start with MP4_VOL_START_CODE\n");

         goto exitAfterBitError;

      }  

   }

   bibFlushBits(MP4_VOL_START_CODE_LENGTH, inBuffer, &bitsGot, bitErrorIndication, &bibError);

   /* vol_id */

   bits = bibGetBits(MP4_VOL_ID_CODE_LENGTH, inBuffer, &bitsGot, bitErrorIndication, &bibError);

   header->vol_id = (int) bits;

   /* random_accessible_vol (1 bit) */

   bits = bibGetBits(1, inBuffer, &bitsGot, bitErrorIndication, &bibError);

   header->random_accessible_vol = (u_char) bits;

   /* video_object_type_indication (8 bits) */

   bits = bibGetBits(8, inBuffer, &bitsGot, bitErrorIndication, &bibError);

   if (bits != 1) {

       /* this is not a simple video object stream */

       deb("vdxGetMPEGVolHeader: ERROR - This is not a simple video object stream\n");

       goto notSupported;

   }

   /* is_object_layer_identifier (1 bit) */

   bits = bibGetBits(1, inBuffer, &bitsGot, bitErrorIndication, &bibError);

   if (bits) {

      /* video_object_layer_verid (4 bits) */

      bits = bibGetBits(4, inBuffer, &bitsGot, bitErrorIndication, &bibError);

      if (bits != 1) {

         /* this is not an MPEG-4 version 1 stream */

         deb("vdxGetMPEGVolHeader: ERROR - This is not an MPEG-4 version 1 stream\n");

         goto notSupported;

      }

      /* video_object_layer_priority (3 bits) */

      bits = bibGetBits(3, inBuffer, &bitsGot, bitErrorIndication, &bibError);

      header->vo_priority = (int) bits;

   } 

   /* aspect_ratio_info: `0010`- 12:11 (625-type for 4:3 picture) */

   bits = bibGetBits(4, inBuffer, &bitsGot, bitErrorIndication, &bibError);

   header->pixel_aspect_ratio = (int) bits;

   /* extended par */

   if (bits == 15) { 

      /* par_width */

      bits = bibGetBits(8, inBuffer, &bitsGot, bitErrorIndication, &bibError);

      /* par_height */

      bits = bibGetBits(8, inBuffer, &bitsGot, bitErrorIndication, &bibError);

   }

   /* vol_control_parameters flag */

   bits = bibGetBits(1, inBuffer, &bitsGot, bitErrorIndication, &bibError);

   if (bits) {

      /* chroma_format (2 bits) */

      bits = bibGetBits(2, inBuffer, &bitsGot, bitErrorIndication, &bibError);

      if (bits != 1) {

         goto exitAfterBitError;

      }

      /* low_delay (1 bits) */

      bits = bibGetBits(1, inBuffer, &bitsGot, bitErrorIndication, &bibError);

      /* vbv_parameters (1 bits) */

      bits = bibGetBits(1, inBuffer, &bitsGot, bitErrorIndication, &bibError);

      if (bits) {

         /* first_half_bitrate (15 bits) */

         bits = bibGetBits(15, inBuffer, &bitsGot, bitErrorIndication, &bibError);

         header->bit_rate = (bits << 15);

         /* marker_bit */

         if (!bibGetBits(1, inBuffer, &bitsGot, bitErrorIndication, &bibError))

            goto exitAfterBitError;

         /* latter_half_bitrate (15 bits) */

         bits = bibGetBits(15, inBuffer, &bitsGot, bitErrorIndication, &bibError);

         header->bit_rate += bits;

         header->bit_rate *= 400;

         /* marker_bit */

         if (!bibGetBits(1, inBuffer, &bitsGot, bitErrorIndication, &bibError))

            goto exitAfterBitError;

         /* first_half_vbv_buffer_size (15 bits) */

         bits = bibGetBits(15, inBuffer, &bitsGot, bitErrorIndication, &bibError);

         header->vbv_buffer_size = (bits << 3);

         /* marker_bit */

         if (!bibGetBits(1, inBuffer, &bitsGot, bitErrorIndication, &bibError))

            goto exitAfterBitError;

         /* latter_half_vbv_buffer_size (3 bits) */

         bits = bibGetBits(3, inBuffer, &bitsGot, bitErrorIndication, &bibError);

         header->vbv_buffer_size += bits;

         header->vbv_buffer_size <<= 14 /**= 16384*/;

         /* first_half_vbv_occupancy (11 bits) */

         bits = bibGetBits(11, inBuffer, &bitsGot, bitErrorIndication, &bibError);

         header->vbv_occupancy = (bits << 15);

         /* marker_bit */

         if (!bibGetBits(1, inBuffer, &bitsGot, bitErrorIndication, &bibError))

            goto exitAfterBitError;

         /* latter_half_vbv_occupancy (15 bits) */

         bits = bibGetBits(15, inBuffer, &bitsGot, bitErrorIndication, &bibError);

         header->vbv_occupancy += bits;

         header->vbv_occupancy <<= 6 /**= 64*/;

         /* marker_bit */

         if (!bibGetBits(1, inBuffer, &bitsGot, bitErrorIndication, &bibError))

            goto exitAfterBitError;

      } else {

         fUseDefaultVBVParams = 1;

      }

   } else {

      fUseDefaultVBVParams = 1;

   }

   if (fUseDefaultVBVParams) {

      /* default values */

      header->vbv_buffer_size = 

        ((header->profile_level == 0 || header->profile_level == 1) ? 5 : 20);

      header->vbv_occupancy = header->vbv_buffer_size*170;

      header->bit_rate = 

        ((header->profile_level == 0 || header->profile_level == 1) ? 64 : 

        ((header->profile_level == 2) ? 128 : 384));

      header->vbv_occupancy <<= 6 /**= 64*/;

      header->vbv_buffer_size <<= 14 /**= 16384*/;

      header->bit_rate <<= 10 /**= 1024*/;

   }

   /* vol_shape (2 bits) */

   bits = bibGetBits(2, inBuffer, &bitsGot, bitErrorIndication, &bibError);

   /* rectangular_shape = '00' */

   if (bits != 0) {

      deb("vdxGetMPEGVolHeader: ERROR - Not rectangular shape is not supported\n");

      goto notSupported;

   }

   /* marker_bit */

   if (!bibGetBits(1, inBuffer, &bitsGot, bitErrorIndication, &bibError))

      goto exitAfterBitError;

   /* MVE */

   if (!getInfo)

   {

       hTranscoder->MPEG4TimerResolution(inBuffer->getIndex, inBuffer->bitIndex);

   }

   /* time_increment_resolution */

   bits = bibGetBits(16, inBuffer, &bitsGot, bitErrorIndication, &bibError);

   header->time_increment_resolution = (int) bits;

   /* marker_bit */

   if (!bibGetBits(1, inBuffer, &bitsGot, bitErrorIndication, &bibError))

      goto exitAfterBitError;

   /* fixed_vop_rate */

   bits = bibGetBits(1, inBuffer, &bitsGot, bitErrorIndication, &bibError);

   /* MVE */

   header->fixed_vop_rate = (u_char)bits;

   /* fixed_vop_time_increment (1-15 bits) */

   if (bits) {

      for (num_bits = 1; ((header->time_increment_resolution-1) >> num_bits) != 0; num_bits++)

        {

        }

      bits = bibGetBits(num_bits, inBuffer, &bitsGot, bitErrorIndication, &bibError);

   }

   /* if rectangular_shape !always! */

   /* marker_bit */

   if (!bibGetBits(1, inBuffer, &bitsGot, bitErrorIndication, &bibError))

      goto exitAfterBitError;

   /* vol_width (13 bits) */

   bits = bibGetBits(13, inBuffer, &bitsGot, bitErrorIndication, &bibError);

   header->lumWidth = (int) bits;

   /* marker_bit */

   if (!bibGetBits(1, inBuffer, &bitsGot, bitErrorIndication, &bibError))

      goto exitAfterBitError;

   /* vol_height (13 bits) */

   bits = bibGetBits(13, inBuffer, &bitsGot, bitErrorIndication, &bibError);

   header->lumHeight = (int) bits;

   /* endif rectangular_shape */

   /* marker_bit */

   if (!bibGetBits(1, inBuffer, &bitsGot, bitErrorIndication, &bibError))

      goto exitAfterBitError;

   /* interlaced (1 bit) */

   bits = bibGetBits(1, inBuffer, &bitsGot, bitErrorIndication, &bibError);

   if (bits)

   {

      deb("vdxGetMPEGVolHeader: ERROR - Interlaced VOP not supported\n");

      goto notSupported;

   }

   /* OBMC_disable */

   bits = bibGetBits(1, inBuffer, &bitsGot, bitErrorIndication, &bibError);

   if (!bits) {

     deb("vdxGetMPEGVolHeader: ERROR - Overlapped motion compensation not supported\n");

     goto notSupported;

   }

   /* sprite_enable (1 bit) */

   bits = bibGetBits(1, inBuffer, &bitsGot, bitErrorIndication, &bibError);

   if (bits) {

     deb("vdxGetMPEGVolHeader: ERROR - Sprites not supported\n");

     goto notSupported;

   }

   /* not_8_bit (1 bit) */

   bits = bibGetBits(1, inBuffer, &bitsGot, bitErrorIndication, &bibError);

   if (bits) {

     deb("vdxGetMPEGVolHeader: ERROR - Not 8 bits/pixel not supported\n");

     goto notSupported;

   }

   /* quant_type (1 bit) */

   bits = bibGetBits(1, inBuffer, &bitsGot, bitErrorIndication, &bibError);

   if (bits) {

     deb("vdxGetMPEGVolHeader: ERROR - H.263/MPEG-2 Quant Table switch not supported\n");

     goto notSupported;

   }

   /* complexity_estimation_disable (1 bit) */

   bits = bibGetBits(1, inBuffer, &bitsGot, bitErrorIndication, &bibError);

   if (!bits) {

     deb("vdxGetMPEGVolHeader: ERROR - Complexity estimation header not supported\n");

     goto notSupported;

   }

   /* MVE */

   if (!getInfo)

   {

       hTranscoder->ErrorResilienceInfo(NULL, inBuffer->getIndex, inBuffer->bitIndex);

   }

   else

   {