libavcodec/h264.h

   1 /*
   2  * H.26L/H.264/AVC/JVT/14496-10/... encoder/decoder
   3  * Copyright (c) 2003 Michael Niedermayer <michaelni@gmx.at>
   4  *
   5  * This file is part of FFmpeg.
   6  *
   7  * FFmpeg is free software; you can redistribute it and/or
   8  * modify it under the terms of the GNU Lesser General Public
   9  * License as published by the Free Software Foundation; either
  10  * version 2.1 of the License, or (at your option) any later version.
  11  *
  12  * FFmpeg is distributed in the hope that it will be useful,
  13  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  14  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  15  * Lesser General Public License for more details.
  16  *
  17  * You should have received a copy of the GNU Lesser General Public
  18  * License along with FFmpeg; if not, write to the Free Software
  19  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
  20  *
  21  */
  22
  23 /**
  24  * @file h264.h
  25  * H.264 / AVC / MPEG4 part10 codec.
  26  * @author Michael Niedermayer <michaelni@gmx.at>
  27  */
  28
  29 #ifndef H264_H
  30 #define H264_H
  31
  32 #include "dsputil.h"
  33 #include "cabac.h"
  34 #include "mpegvideo.h"
  35
  36 #define interlaced_dct interlaced_dct_is_a_bad_name
  37 #define mb_intra mb_intra_is_not_initialized_see_mb_type
  38
  39 #define LUMA_DC_BLOCK_INDEX   25
  40 #define CHROMA_DC_BLOCK_INDEX 26
  41
  42 #define CHROMA_DC_COEFF_TOKEN_VLC_BITS 8
  43 #define COEFF_TOKEN_VLC_BITS           8
  44 #define TOTAL_ZEROS_VLC_BITS           9
  45 #define CHROMA_DC_TOTAL_ZEROS_VLC_BITS 3
  46 #define RUN_VLC_BITS                   3
  47 #define RUN7_VLC_BITS                  6
  48
  49 #define MAX_SPS_COUNT 32
  50 #define MAX_PPS_COUNT 256
  51
  52 #define MAX_MMCO_COUNT 66
  53
  54 /* Compiling in interlaced support reduces the speed
  55  * of progressive decoding by about 2%. */
  56 #define ALLOW_INTERLACE
  57
  58 #ifdef ALLOW_INTERLACE
  59 #define MB_MBAFF h->mb_mbaff
  60 #define MB_FIELD h->mb_field_decoding_flag
  61 #define FRAME_MBAFF h->mb_aff_frame
  62 #else
  63 #define MB_MBAFF 0
  64 #define MB_FIELD 0
  65 #define FRAME_MBAFF 0
  66 #undef  IS_INTERLACED
  67 #define IS_INTERLACED(mb_type) 0
  68 #endif
  69
  70 /**
  71  * Sequence parameter set
  72  */
  73 typedef struct SPS{
  74
  75     int profile_idc;
  76     int level_idc;
  77     int transform_bypass;              ///< qpprime_y_zero_transform_bypass_flag
  78     int log2_max_frame_num;            ///< log2_max_frame_num_minus4 + 4
  79     int poc_type;                      ///< pic_order_cnt_type
  80     int log2_max_poc_lsb;              ///< log2_max_pic_order_cnt_lsb_minus4
  81     int delta_pic_order_always_zero_flag;
  82     int offset_for_non_ref_pic;
  83     int offset_for_top_to_bottom_field;
  84     int poc_cycle_length;              ///< num_ref_frames_in_pic_order_cnt_cycle
  85     int ref_frame_count;               ///< num_ref_frames
  86     int gaps_in_frame_num_allowed_flag;
  87     int mb_width;                      ///< frame_width_in_mbs_minus1 + 1
  88     int mb_height;                     ///< frame_height_in_mbs_minus1 + 1
  89     int frame_mbs_only_flag;
  90     int mb_aff;                        ///<mb_adaptive_frame_field_flag
  91     int direct_8x8_inference_flag;
  92     int crop;                   ///< frame_cropping_flag
  93     int crop_left;              ///< frame_cropping_rect_left_offset
  94     int crop_right;             ///< frame_cropping_rect_right_offset
  95     int crop_top;               ///< frame_cropping_rect_top_offset
  96     int crop_bottom;            ///< frame_cropping_rect_bottom_offset
  97     int vui_parameters_present_flag;
  98     AVRational sar;
  99     int timing_info_present_flag;
 100     uint32_t num_units_in_tick;
 101     uint32_t time_scale;
 102     int fixed_frame_rate_flag;
 103     short offset_for_ref_frame[256]; //FIXME dyn aloc?
 104     int bitstream_restriction_flag;
 105     int num_reorder_frames;
 106     int scaling_matrix_present;
 107     uint8_t scaling_matrix4[6][16];
 108     uint8_t scaling_matrix8[2][64];
 109 }SPS;
 110
 111 /**
 112  * Picture parameter set
 113  */
 114 typedef struct PPS{
 115     unsigned int sps_id;
 116     int cabac;                  ///< entropy_coding_mode_flag
 117     int pic_order_present;      ///< pic_order_present_flag
 118     int slice_group_count;      ///< num_slice_groups_minus1 + 1
 119     int mb_slice_group_map_type;
 120     unsigned int ref_count[2];  ///< num_ref_idx_l0/1_active_minus1 + 1
 121     int weighted_pred;          ///< weighted_pred_flag
 122     int weighted_bipred_idc;
 123     int init_qp;                ///< pic_init_qp_minus26 + 26
 124     int init_qs;                ///< pic_init_qs_minus26 + 26
 125     int chroma_qp_index_offset;
 126     int deblocking_filter_parameters_present; ///< deblocking_filter_parameters_present_flag
 127     int constrained_intra_pred; ///< constrained_intra_pred_flag
 128     int redundant_pic_cnt_present; ///< redundant_pic_cnt_present_flag
 129     int transform_8x8_mode;     ///< transform_8x8_mode_flag
 130     uint8_t scaling_matrix4[6][16];
 131     uint8_t scaling_matrix8[2][64];
 132 }PPS;
 133
 134 /**
 135  * Memory management control operation opcode.
 136  */
 137 typedef enum MMCOOpcode{
 138     MMCO_END=0,
 139     MMCO_SHORT2UNUSED,
 140     MMCO_LONG2UNUSED,
 141     MMCO_SHORT2LONG,
 142     MMCO_SET_MAX_LONG,
 143     MMCO_RESET,
 144     MMCO_LONG,
 145 } MMCOOpcode;
 146
 147 /**
 148  * Memory management control operation.
 149  */
 150 typedef struct MMCO{
 151     MMCOOpcode opcode;
 152     int short_frame_num;
 153     int long_index;
 154 } MMCO;
 155
 156 /**
 157  * H264Context
 158  */
 159 typedef struct H264Context{
 160     MpegEncContext s;
 161     int nal_ref_idc;
 162     int nal_unit_type;
 163     uint8_t *rbsp_buffer;
 164     unsigned int rbsp_buffer_size;
 165
 166     /**
 167       * Used to parse AVC variant of h264
 168       */
 169     int is_avc; ///< this flag is != 0 if codec is avc1
 170     int got_avcC; ///< flag used to parse avcC data only once
 171     int nal_length_size; ///< Number of bytes used for nal length (1, 2 or 4)
 172
 173     int chroma_qp; //QPc
 174
 175     int prev_mb_skipped;
 176     int next_mb_skipped;
 177
 178     //prediction stuff
 179     int chroma_pred_mode;
 180     int intra16x16_pred_mode;
 181
 182     int top_mb_xy;
 183     int left_mb_xy[2];
 184
 185     int8_t intra4x4_pred_mode_cache[5*8];
 186     int8_t (*intra4x4_pred_mode)[8];
 187     void (*pred4x4  [9+3])(uint8_t *src, uint8_t *topright, int stride);//FIXME move to dsp?
 188     void (*pred8x8l [9+3])(uint8_t *src, int topleft, int topright, int stride);
 189     void (*pred8x8  [4+3])(uint8_t *src, int stride);
 190     void (*pred16x16[4+3])(uint8_t *src, int stride);
 191     unsigned int topleft_samples_available;
 192     unsigned int top_samples_available;
 193     unsigned int topright_samples_available;
 194     unsigned int left_samples_available;
 195     uint8_t (*top_borders[2])[16+2*8];
 196     uint8_t left_border[2*(17+2*9)];
 197
 198     /**
 199      * non zero coeff count cache.
 200      * is 64 if not available.
 201      */
 202     DECLARE_ALIGNED_8(uint8_t, non_zero_count_cache[6*8]);
 203     uint8_t (*non_zero_count)[16];
 204
 205     /**
 206      * Motion vector cache.
 207      */
 208     DECLARE_ALIGNED_8(int16_t, mv_cache[2][5*8][2]);
 209     DECLARE_ALIGNED_8(int8_t, ref_cache[2][5*8]);
 210 #define LIST_NOT_USED -1 //FIXME rename?
 211 #define PART_NOT_AVAILABLE -2
 212
 213     /**
 214      * is 1 if the specific list MV&references are set to 0,0,-2.
 215      */
 216     int mv_cache_clean[2];
 217
 218     /**
 219      * number of neighbors (top and/or left) that used 8x8 dct
 220      */
 221     int neighbor_transform_size;
 222
 223     /**
 224      * block_offset[ 0..23] for frame macroblocks
 225      * block_offset[24..47] for field macroblocks
 226      */
 227     int block_offset[2*(16+8)];
 228
 229     uint32_t *mb2b_xy; //FIXME are these 4 a good idea?
 230     uint32_t *mb2b8_xy;
 231     int b_stride; //FIXME use s->b4_stride
 232     int b8_stride;
 233
 234     int mb_linesize;   ///< may be equal to s->linesize or s->linesize*2, for mbaff
 235     int mb_uvlinesize;
 236
 237     int emu_edge_width;
 238     int emu_edge_height;
 239
 240     int halfpel_flag;
 241     int thirdpel_flag;
 242
 243     int unknown_svq3_flag;
 244     int next_slice_index;
 245
 246     SPS *sps_buffers[MAX_SPS_COUNT];
 247     SPS sps; ///< current sps
 248
 249     PPS *pps_buffers[MAX_PPS_COUNT];
 250     /**
 251      * current pps
 252      */
 253     PPS pps; //FIXME move to Picture perhaps? (->no) do we need that?
 254
 255     uint32_t dequant4_buffer[6][52][16];
 256     uint32_t dequant8_buffer[2][52][64];
 257     uint32_t (*dequant4_coeff[6])[16];
 258     uint32_t (*dequant8_coeff[2])[64];
 259     int dequant_coeff_pps;     ///< reinit tables when pps changes
 260
 261     int slice_num;
 262     uint8_t *slice_table_base;
 263     uint8_t *slice_table;      ///< slice_table_base + 2*mb_stride + 1
 264     int slice_type;
 265     int slice_type_fixed;
 266
 267     //interlacing specific flags
 268     int mb_aff_frame;
 269     int mb_field_decoding_flag;
 270     int mb_mbaff;              ///< mb_aff_frame && mb_field_decoding_flag
 271
 272     unsigned int sub_mb_type[4];
 273
 274     //POC stuff
 275     int poc_lsb;
 276     int poc_msb;
 277     int delta_poc_bottom;
 278     int delta_poc[2];
 279     int frame_num;
 280     int prev_poc_msb;             ///< poc_msb of the last reference pic for POC type 0
 281     int prev_poc_lsb;             ///< poc_lsb of the last reference pic for POC type 0
 282     int frame_num_offset;         ///< for POC type 2
 283     int prev_frame_num_offset;    ///< for POC type 2
 284     int prev_frame_num;           ///< frame_num of the last pic for POC type 1/2
 285
 286     /**
 287      * frame_num for frames or 2*frame_num for field pics.
 288      */
 289     int curr_pic_num;
 290
 291     /**
 292      * max_frame_num or 2*max_frame_num for field pics.
 293      */
 294     int max_pic_num;
 295
 296     //Weighted pred stuff
 297     int use_weight;
 298     int use_weight_chroma;
 299     int luma_log2_weight_denom;
 300     int chroma_log2_weight_denom;
 301     int luma_weight[2][48];
 302     int luma_offset[2][48];
 303     int chroma_weight[2][48][2];
 304     int chroma_offset[2][48][2];
 305     int implicit_weight[48][48];
 306
 307     //deblock
 308     int deblocking_filter;         ///< disable_deblocking_filter_idc with 1<->0
 309     int slice_alpha_c0_offset;
 310     int slice_beta_offset;
 311
 312     int redundant_pic_count;
 313
 314     int direct_spatial_mv_pred;
 315     int dist_scale_factor[16];
 316     int dist_scale_factor_field[32];
 317     int map_col_to_list0[2][16];
 318     int map_col_to_list0_field[2][32];
 319
 320     /**
 321      * num_ref_idx_l0/1_active_minus1 + 1
 322      */
 323     unsigned int ref_count[2];   ///< counts frames or fields, depending on current mb mode
 324     unsigned int list_count;
 325     Picture *short_ref[32];
 326     Picture *long_ref[32];
 327     Picture default_ref_list[2][32];
 328     Picture ref_list[2][48];     ///< 0..15: frame refs, 16..47: mbaff field refs
 329     Picture *delayed_pic[18]; //FIXME size?
 330     Picture *delayed_output_pic;
 331
 332     /**
 333      * memory management control operations buffer.
 334      */
 335     MMCO mmco[MAX_MMCO_COUNT];
 336     int mmco_index;
 337
 338     int long_ref_count;  ///< number of actual long term references
 339     int short_ref_count; ///< number of actual short term references
 340
 341     //data partitioning
 342     GetBitContext intra_gb;
 343     GetBitContext inter_gb;
 344     GetBitContext *intra_gb_ptr;
 345     GetBitContext *inter_gb_ptr;
 346
 347     DECLARE_ALIGNED_8(DCTELEM, mb[16*24]);
 348     DCTELEM mb_padding[256];        ///< as mb is addressed by scantable[i] and scantable is uint8_t we can either check that i is not to large or ensure that there is some unused stuff after mb
 349
 350     /**
 351      * Cabac
 352      */
 353     CABACContext cabac;
 354     uint8_t      cabac_state[460];
 355     int          cabac_init_idc;
 356
 357     /* 0x100 -> non null luma_dc, 0x80/0x40 -> non null chroma_dc (cb/cr), 0x?0 -> chroma_cbp(0,1,2), 0x0? luma_cbp */
 358     uint16_t     *cbp_table;
 359     int cbp;
 360     int top_cbp;
 361     int left_cbp;
 362     /* chroma_pred_mode for i4x4 or i16x16, else 0 */
 363     uint8_t     *chroma_pred_mode_table;
 364     int         last_qscale_diff;
 365     int16_t     (*mvd_table[2])[2];
 366     DECLARE_ALIGNED_8(int16_t, mvd_cache[2][5*8][2]);
 367     uint8_t     *direct_table;
 368     uint8_t     direct_cache[5*8];
 369
 370     uint8_t zigzag_scan[16];
 371     uint8_t zigzag_scan8x8[64];
 372     uint8_t zigzag_scan8x8_cavlc[64];
 373     uint8_t field_scan[16];
 374     uint8_t field_scan8x8[64];
 375     uint8_t field_scan8x8_cavlc[64];
 376     const uint8_t *zigzag_scan_q0;
 377     const uint8_t *zigzag_scan8x8_q0;
 378     const uint8_t *zigzag_scan8x8_cavlc_q0;
 379     const uint8_t *field_scan_q0;
 380     const uint8_t *field_scan8x8_q0;
 381     const uint8_t *field_scan8x8_cavlc_q0;
 382
 383     int x264_build;
 384 }H264Context;
 385
 386 #endif /* H264_H */