/*

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

* Header for the video demultiplexer module.

*

*/

#ifndef _VIDDEMUX_H_

#define _VIDDEMUX_H_

#include "epoclib.h"

#include "biblin.h"

#include "dlist.h"

#include "vdc263.h" /* for vdxPictureHeader_t and vdxSEI_t */

class CMPEG4Transcoder;

/*

 * Defines

 */

/* General return values */

// unify error codes

#define VDX_OK_BUT_BIT_ERROR  H263D_OK_BUT_BIT_ERROR     /* Handled portion of the bistream

                                       contains a bit error */

#define VDX_OK         H263D_OK     /* Everything ok */

#define VDX_ERR     H263D_ERROR     /* Everything ok */

#define VDX_ERR_NOT_SUPPORTED H263D_ERROR    /* Some bit combination (in header)

                                       occurs which is not supported by the 

                                       implementetion */

#define VDX_ERR_BIB  H263D_ERROR    /* Bit Buffer module returned an error */

/* Picture types */

#define VDX_PIC_TYPE_I     0

#define VDX_PIC_TYPE_P     1

#define VDX_PIC_TYPE_PB    8

#define VDX_PIC_TYPE_IPB   2

#define VDX_PIC_TYPE_B     3

#define VDX_PIC_TYPE_EI    4

#define VDX_PIC_TYPE_EP    5

#define VDX_VOP_TYPE_I     0 /* MPEG-4 Intra Picture */

#define VDX_VOP_TYPE_P     1 /* MPEG-4 Inter Picture */

#define VDX_VOP_NOT_CODED -1 /* MPEG-4 Not Coded Picture 

                                (only the time_increment is present) */

/* Reference Picture Selection modes */

#define VDX_RPS_MODE_NO_MSGS     0

#define VDX_RPS_MODE_ACK         1

#define VDX_RPS_MODE_NACK        2

#define VDX_RPS_MODE_BOTH_MSGS   3

/* Macroblock classes */

#define VDX_MB_INTER    1

#define VDX_MB_INTRA    2

#define MAX_USER_DATA_LENGTH 512    /* The maximum allocated memory for 

                                       user data (UD). Only this much of the UD

                                       from the bitstream is stored */

/*

 * Typedefs

 */

/*

 * vdxVolHeader_t

 */

/* {{-output"vdxVolHeader_t_info.txt" -ignore"*" -noCR}}

   The vdxGetVolHeader function uses this structure to return VOL header data.

   /MPEG-4/

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

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

typedef struct {

   int profile_level;       /* Indicates the Level (1,2 or 3) of the Simple

                               Profile the Video Object conforms to */

   int vo_priority;         /* Priority assigned to the Video Object 

                               a value between 1(lowest)-7(highest).

                               If not in the bitstream, set to zero */

   int vo_id;               /* id of the Video Object */

   int vol_id;              /* id of the Video Object Layer */

   int random_accessible_vol; 

                            /* set to 1 if all the VOPs in the stream are

                                 I-VOP. */

   int pixel_aspect_ratio;  /* see. MPEG-4 visual spec. pp. 71 */

   int time_increment_resolution;

                            /* Resolution to interpret the time_increment 

                               fields in the VOP headers */

   int lumWidth;            /* Frame width of the Y component in pixels */

   int lumHeight;           /* Frame height of the Y component in pixels */

   u_char error_res_disable;/* Flag ON if no resynchronization markers are

                               used inside frames. 

                               When OFF it doesn't mean they ARE used. */

   u_char data_partitioned; /* Flag indicating if data partitioning inside 

                               a VP is used or not. */

   u_char reversible_vlc;   /* flag indicating the usage of reversible 

                               VLC codes */

   /* the following parameters concern the input video signal,

      see MPEG-4 visual spec. pp. 66-70, and "Note" in viddemux_mpeg.c 

      Not used in the current implementatnion. */

   int video_format;

   int video_range;

   int colour_primaries;    

   int transfer_characteristics;

   int matrix_coefficients;

   /* the following parameters are used in the Video Buffering Verifier

      (Annex D) to monitor the input bit buffer, complexity, memory buffer

      used in the decoding process. The conformance of a stream can be checked

      using these parameters. 

      Not used in the current implementatnion. */

   u_int32 bit_rate;

   u_int32 vbv_buffer_size;

   u_int32 vbv_occupancy;

   char *user_data;         /* User Data if available */

   int user_data_length;    /* Length of the recieved user data */

   u_char fixed_vop_rate;       /* fixed vop rate indication, added for transcoding */

} vdxVolHeader_t;

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

/*

 * vdxGovHeader_t

 */

/* {{-output"vdxGovHeader_t_info.txt" -ignore"*" -noCR}}

   The vdxGetGovHeader function uses this structure to return GOV header data.

   /MPEG-4/

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

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

typedef struct {

   int time_stamp;              /* The time stamp value in the GOV Header */

   u_char closed_gov;           /* only important if B-VOPs can be in the stream */

   u_char broken_link;          /* only important if B-VOPs can be in the stream */

   char *user_data;             /* User Data if available */

   int user_data_length;        /* Length of the recieved user data */

} vdxGovHeader_t;

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

/*

 * vdxGetVopHeaderInputParam_t

 */

/* {{-output"vdxGetVopHeaderInputParam_t_info.txt" -ignore"*" -noCR}}

   This structure is used to pass input parameters to

   the vdxGetVopHeader function. /MPEG-4/

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

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

typedef struct {

    int time_increment_resolution; /* resolution of the time increment field */

} vdxGetVopHeaderInputParam_t;

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

/*

 * vdxVopHeader_t

 */

/* {{-output"vdxVopHeader_t_info.txt" -ignore"*" -noCR}}

   The vdxGetVopHeader function uses this structure to return the picture

   header parameters. /MPEG-4/

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

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

typedef struct {

    int time_base_incr;         /* Increment of the modulo time base from the

                                   previous VOP or GOV header in seconds */

    int time_inc;             /* Time increment value of the current VOP,

                                   plus the modulo time base = absolute time */

    u_char vop_coded;           /* Flag: 1 - VOP coded;

                                         0 - VOP not coded/skipped */

    int coding_type;            /* VOP coding type is one of the following:

                                       VDX_VOP_TYPE_I       MPEG-4 INTRA

                                       VDX_VOP_TYPE_P       MPEG-4 INTER */

    int rounding_type;          /* Rounding of the sub-pixel predictor

                                   calculations: 0 or 1. */

    int intra_dc_vlc_thr;       /* QP dependent switch control of coding the

                                   Intra DC coefficient as separate/optimized or

                                   as the other Intra AC. (0..7) */

    int quant;                  /* Initial Quantizer value */

    int fcode_forward;          /* For P-VOPs Motion Vector range control

                                   1: [-16,16] .. 7:[-1024,1024] */

} vdxVopHeader_t;

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

/*

 * vdxGetVideoPacketHeaderInputParam_t

 */

/* {{-output"vdxGetVideoPacketHeaderInputParam_t_info.txt" -ignore"*" -noCR}}

   This structure is used to pass input parameters to

   the vdxGetVideoPacketHeader function. /MPEG-4/

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

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

typedef struct {

    int fcode_forward;          /* used for determining the resync_marker

                                   length */

    int time_increment_resolution; /* resolution of the time increment field */

    int numOfMBs;               /* Number of MBs in a VOP */

} vdxGetVideoPacketHeaderInputParam_t;

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

/*

 * vdxVideoPacketHeader_t

 */

/* {{-output"vdxVideoPacketHeader_t_info.txt" -ignore"*" -noCR}}

   The vdxGetVideoPacketHeader function uses this structure to return the

   Number of the immediately following MB in the VOP and optionally confirm

   header parameters. /MPEG-4/

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

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

typedef struct {

    int currMBNum;              /* Number of the immediately following MB */

    int quant;                  /* Quantizer used for the following MB */

    u_char fHEC;                /* Flag for header extension code */

    int time_base_incr;         /* Increment of the modulo time base from the

                                   previous VOP or GOV header in seconds */

    int time_inc;             /* Time increment value of the current VOP,

                                   plus the modulo time base = absolute time */

    int coding_type;            /* VOP coding type is one of the following:

                                       VDX_VOP_TYPE_I       MPEG-4 INTRA

                                       VDX_VOP_TYPE_P       MPEG-4 INTER */

    int intra_dc_vlc_thr;       /* QP dependent switch control of coding the

                                   Intra DC coefficient as separate/optimized or

                                   as the other Intra AC. (0..7) */

    int fcode_forward;          /* For P-VOPs Motion Vector range control

                                   1: [-16,16] .. 7:[-1024,1024] */

} vdxVideoPacketHeader_t;

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

/*

 * vdxGetPictureHeaderInputParam_t

 */

/* {{-output"vdxGetPictureHeaderInputParam_t_info.txt" -ignore"*" -noCR}}

   This structure is used to pass input parameters to

   the vdxGetPictureHeader function.

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

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

typedef struct {

   int numStuffBits;             /* Number of stuffing bits before PSC */

   int fCustomPCF;               /* Non-zero if custom picture clock frequency

                                    is allowed. Otherwise zero. */

   int fScalabilityMode;         /* Non-zero if the Temporal, SNR, and Spatial

                                    Scalability mode (Annex O) is in use.

                                    Otherwise zero. */

   int fRPS;                     /* Non-zero if the Refence Picture Selection

                                    mode (Annex N) is in use. Otherwise zero. */

   bibFlushBits_t flushBits;     /* Pointers for bit buffer functions. */

   bibGetBits_t getBits;         /* Needed to provide a possibly different */

   bibShowBits_t showBits;       /* input mechanism for normal reading from

                                    incoming bit-stream and for parsing

                                    a picture header copy */

} vdxGetPictureHeaderInputParam_t;

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

/*

 * vdxPictureHeader_t

 * Defined in vdc263.h because Video Decoder Core exports the data structure.

 */

/*

 * vdxSEI_t

 * Defined in vdc263.h because Video Decoder Core exports the data structure.

 */

/*

 * vdxGetGOBHeaderInputParam_t

 */

/* {{-output"vdxGetGOBHeaderInputParam_t_info.txt" -ignore"*" -noCR}}

   This structure is used to pass input parameters to

   the vdxGetGOBHeader function.

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

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

typedef struct {

   int numStuffBits;             /* Number of stuffing bits before PSC */

   int fCustomPCF;               /* Non-zero if custom picture clock frequency

                                    is allowed. Otherwise zero. */

   int fCPM;                     /* Non-zero if the Continuous Presence

                                    Multipoint feature (Annex C) is in use.

                                    Otherwise zero. */

   int fRPS;                     /* Non-zero if the Refence Picture Selection

                                    mode (Annex N) is in use. Otherwise zero. */

} vdxGetGOBHeaderInputParam_t;

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

/*

 * vdxGOBHeader_t

 */

/* {{-output"vdxGOBHeader_t_info.txt" -ignore"*" -noCR}}

   The vdxGetGOBHeader function uses this structure to return the GOB

   header parameters.

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

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

typedef struct {

   int gn;                       /* Group Number (GN) field */

   int gfid;                     /* GOB Frame ID (GFID) field */

   int gquant;                   /* Quantizer Information (GQUANT) field */

   /* If CPM (Annex C) is in use */

      int gsbi;                  /* GOB Sub-Bitstream Indicator (GSBI) field */

   /* If the Reference Picture Selection mode is in use */

      int tri;                   /* Temporal Reference Indicator (TRI) field */

      int trpi;                  /* Temporal Reference for Prediction

                                    Indicator (TRPI) field */

      /* If tri == 1 */

         int tr;                 /* Temporal Reference (TR) field */

      /* If trpi == 1 */

         int trp;                /* Temporal Reference for Prediction (TRP) 

                                    field */

} vdxGOBHeader_t;

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

/*

 * vdxGetSliceHeaderInputParam_t

 */

/* {{-output"vdxGetSliceHeaderInputParam_t_info.txt" -ignore"*" -noCR}}

   This structure is used to pass input parameters to

   the vdxGetSliceHeader function.

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

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

typedef struct {

   int sliceHeaderAfterPSC;      /* If the slice follows a PSC, the value 

                                    should be 1 */ 

   int numStuffBits;             /* Number of stuffing bits before SSC */

   int fCPM;                     /* Non-zero if the Continuous Presence

                                    Multipoint feature (Annex C) is in use.

                                    Otherwise zero. */

   int fRPS;                     /* Non-zero if the Refence Picture Selection

                                    mode (Annex N) is in use. Otherwise zero. */

   int mbaFieldWidth;            /* MBA Field width */

   int mbaMaxValue;              /* MBA maximum value. See Table K.2/H.263 */

   int fRectangularSlices;       /* 0 = free-running slices, 

                                    1 = rectangular slices */

   int swiFieldWidth;            /* SWI Field width */

   int swiMaxValue;              /* SWI maximum value. See Table K.3/H.263 */

} vdxGetSliceHeaderInputParam_t;

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

/*

 * vdxSliceHeader_t

 */

/* {{-output"vdxSliceHeader_t_info.txt" -ignore"*" -noCR}}

   The vdxGetSliceHeader function uses this structure to return the Slice

   header parameters.

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

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

typedef struct {

   /* If CPM (Annex C) is in use */

      int ssbi;                   /* Slice Sub-Bitstream Indicator (SSBI) */

      int gn;                    /* Group Number (GN) field */

      int sbn;                   /* Sub-Bitstream number */

   int mba;                      /* Macroblock Address (MBA) */

   /* If not the slice just after the PSC */

      int squant;                /* Quantizer Inforation (SQUANT) */

   /* If fRectangularSlices */

      int swi;                   /* Slice Width Indication in Macroblocks (SWI)*/

   int gfid;                     /* GOB Frame ID (GFID) field */

   /* If the Reference Picture Selection mode is in use */

      int tri;                   /* Temporal Reference Indicator (TRI) field */

      int trpi;                  /* Temporal Reference for Prediction

                                    Indicator (TRPI) field */

      /* If tri == 1 */

         int tr;                 /* Temporal Reference (TR) field */

      /* If trpi == 1 */

         int trp;                /* Temporal Reference for Prediction (TRP) 

                                    field */

} vdxSliceHeader_t;

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

/*

 * vdxGetIMBLayerInputParam_t

 */

/* {{-output"vdxGetIMBLayerInputParam_t_info.txt" -ignore"*" -noCR}}

   This structure is used to pass input parameters to

   the vdxGetIMBLayer function.

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

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

typedef struct {

   int fMQ;                      /* Modified Quantization */

   int quant;                    /* Current QUANT */

   int fAIC;                     /* Advanced Intra Coding Flag */

   int fSS;                      /* Slice Structured Mode Flag */

   u_char fMPEG4;                /* MPEG4 or H.263 */

} vdxGetIMBLayerInputParam_t;

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

/*

 * vdxGetDataPartitionedIMBLayerInputParam_t

 */

/* {{-output"vdxGetDataPartitionedIMBLayerInputParam_t_info.txt" -ignore"*" -noCR}}

   This structure is used to pass input parameters to

   the vdxGetDataPartitionedIMBLayer function. /MPEG-4/

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

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

typedef struct {

   int intra_dc_vlc_thr;

   int quant;                    /* Current QUANT */

} vdxGetDataPartitionedIMBLayerInputParam_t;

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

/*

 * vdxIMBLayer_t

 */

/* {{-output"vdxIMBLayer_t_info.txt" -ignore"*" -noCR}}

   The vdxGetIMBLayer function uses this structure to return

   the macroblock header parameters.

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

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

typedef struct {

	int mcbpc;                     /* Macroblock type and the coded block 

																    pattern for chrominance */

   int cbpc;                     /* Coded Block Pattern for Chrominance,

                                    bit 1 is for U and bit 0 is for V,

                                    use vdxIsUCoded and vdxIsVCoded macros 

                                    to access this value */

   int cbpy;                     /* Coded Block Pattern for Luminance,

                                    bit 3 is for block 1, ..., 

                                    bit 0 is for block 4,

                                    use vdxIsYCoded macro to access this 

                                    value */

/*** MPEG-4 REVISION ***/

   u_char ac_pred_flag;          /* "1" AC prediction used, "0" not */

/*** End MPEG-4 REVISION ***/

   int quant;                    /* New (possibly updated) QUANT */

   int predMode;                 /* Prediction Mode used in Annex I

                                    0 (DC Only)

                                    1 (Vertical DC&AC)