git.sesse.net Git - ffmpeg/blob - 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  * @file h264.h
  24  * H.264 / AVC / MPEG4 part10 codec.
  25  * @author Michael Niedermayer <michaelni@gmx.at>
  26  */
  27
  28 #ifndef FFMPEG_H264_H
  29 #define FFMPEG_H264_H
  30
  31 #include "dsputil.h"
  32 #include "cabac.h"
  33 #include "mpegvideo.h"
  34 #include "h264pred.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 #define FIELD_PICTURE (s->picture_structure != PICT_FRAME)
  63 #else
  64 #define MB_MBAFF 0
  65 #define MB_FIELD 0
  66 #define FRAME_MBAFF 0
  67 #define FIELD_PICTURE 0
  68 #undef  IS_INTERLACED
  69 #define IS_INTERLACED(mb_type) 0
  70 #endif
  71 #define FIELD_OR_MBAFF_PICTURE (FRAME_MBAFF || FIELD_PICTURE)
  72
  73 #ifndef ENABLE_H264_ENCODER
  74 #define ENABLE_H264_ENCODER 0
  75 #endif
  76
  77 /**
  78  * Sequence parameter set
  79  */
  80 typedef struct SPS{
  81
  82     int profile_idc;
  83     int level_idc;
  84     int transform_bypass;              ///< qpprime_y_zero_transform_bypass_flag
  85     int log2_max_frame_num;            ///< log2_max_frame_num_minus4 + 4
  86     int poc_type;                      ///< pic_order_cnt_type
  87     int log2_max_poc_lsb;              ///< log2_max_pic_order_cnt_lsb_minus4
  88     int delta_pic_order_always_zero_flag;
  89     int offset_for_non_ref_pic;
  90     int offset_for_top_to_bottom_field;
  91     int poc_cycle_length;              ///< num_ref_frames_in_pic_order_cnt_cycle
  92     int ref_frame_count;               ///< num_ref_frames
  93     int gaps_in_frame_num_allowed_flag;
  94     int mb_width;                      ///< pic_width_in_mbs_minus1 + 1
  95     int mb_height;                     ///< pic_height_in_map_units_minus1 + 1
  96     int frame_mbs_only_flag;
  97     int mb_aff;                        ///<mb_adaptive_frame_field_flag
  98     int direct_8x8_inference_flag;
  99     int crop;                   ///< frame_cropping_flag
 100     unsigned int crop_left;            ///< frame_cropping_rect_left_offset
 101     unsigned int crop_right;           ///< frame_cropping_rect_right_offset
 102     unsigned int crop_top;             ///< frame_cropping_rect_top_offset
 103     unsigned int crop_bottom;          ///< frame_cropping_rect_bottom_offset
 104     int vui_parameters_present_flag;
 105     AVRational sar;
 106     int timing_info_present_flag;
 107     uint32_t num_units_in_tick;
 108     uint32_t time_scale;
 109     int fixed_frame_rate_flag;
 110     short offset_for_ref_frame[256]; //FIXME dyn aloc?
 111     int bitstream_restriction_flag;
 112     int num_reorder_frames;
 113     int scaling_matrix_present;
 114     uint8_t scaling_matrix4[6][16];
 115     uint8_t scaling_matrix8[2][64];
 116 }SPS;
 117
 118 /**
 119  * Picture parameter set
 120  */
 121 typedef struct PPS{
 122     unsigned int sps_id;
 123     int cabac;                  ///< entropy_coding_mode_flag
 124     int pic_order_present;      ///< pic_order_present_flag
 125     int slice_group_count;      ///< num_slice_groups_minus1 + 1
 126     int mb_slice_group_map_type;
 127     unsigned int ref_count[2];  ///< num_ref_idx_l0/1_active_minus1 + 1
 128     int weighted_pred;          ///< weighted_pred_flag
 129     int weighted_bipred_idc;
 130     int init_qp;                ///< pic_init_qp_minus26 + 26
 131     int init_qs;                ///< pic_init_qs_minus26 + 26
 132     int chroma_qp_index_offset[2];
 133     int deblocking_filter_parameters_present; ///< deblocking_filter_parameters_present_flag
 134     int constrained_intra_pred; ///< constrained_intra_pred_flag
 135     int redundant_pic_cnt_present; ///< redundant_pic_cnt_present_flag
 136     int transform_8x8_mode;     ///< transform_8x8_mode_flag
 137     uint8_t scaling_matrix4[6][16];
 138     uint8_t scaling_matrix8[2][64];
 139     uint8_t chroma_qp_table[2][256];  ///< pre-scaled (with chroma_qp_index_offset) version of qp_table
 140     int chroma_qp_diff;
 141 }PPS;
 142
 143 /**
 144  * Memory management control operation opcode.
 145  */
 146 typedef enum MMCOOpcode{
 147     MMCO_END=0,
 148     MMCO_SHORT2UNUSED,
 149     MMCO_LONG2UNUSED,
 150     MMCO_SHORT2LONG,
 151     MMCO_SET_MAX_LONG,
 152     MMCO_RESET,
 153     MMCO_LONG,
 154 } MMCOOpcode;
 155
 156 /**
 157  * Memory management control operation.
 158  */
 159 typedef struct MMCO{
 160     MMCOOpcode opcode;
 161     int short_pic_num;  ///< pic_num without wrapping (pic_num & max_pic_num)
 162     int long_arg;       ///< index, pic_num, or num long refs depending on opcode
 163 } MMCO;
 164
 165 /**
 166  * H264Context
 167  */
 168 typedef struct H264Context{
 169     MpegEncContext s;
 170     int nal_ref_idc;
 171     int nal_unit_type;
 172     uint8_t *rbsp_buffer[2];
 173     unsigned int rbsp_buffer_size[2];
 174
 175     /**
 176       * Used to parse AVC variant of h264
 177       */
 178     int is_avc; ///< this flag is != 0 if codec is avc1
 179     int got_avcC; ///< flag used to parse avcC data only once
 180     int nal_length_size; ///< Number of bytes used for nal length (1, 2 or 4)
 181
 182     int chroma_qp[2]; //QPc
 183
 184     int prev_mb_skipped;
 185     int next_mb_skipped;
 186
 187     //prediction stuff
 188     int chroma_pred_mode;
 189     int intra16x16_pred_mode;
 190
 191     int top_mb_xy;
 192     int left_mb_xy[2];
 193
 194     int8_t intra4x4_pred_mode_cache[5*8];
 195     int8_t (*intra4x4_pred_mode)[8];
 196     H264PredContext hpc;
 197     unsigned int topleft_samples_available;
 198     unsigned int top_samples_available;
 199     unsigned int topright_samples_available;
 200     unsigned int left_samples_available;
 201     uint8_t (*top_borders[2])[16+2*8];
 202     uint8_t left_border[2*(17+2*9)];
 203
 204     /**
 205      * non zero coeff count cache.
 206      * is 64 if not available.
 207      */
 208     DECLARE_ALIGNED_8(uint8_t, non_zero_count_cache[6*8]);
 209     uint8_t (*non_zero_count)[16];
 210
 211     /**
 212      * Motion vector cache.
 213      */
 214     DECLARE_ALIGNED_8(int16_t, mv_cache[2][5*8][2]);
 215     DECLARE_ALIGNED_8(int8_t, ref_cache[2][5*8]);
 216 #define LIST_NOT_USED -1 //FIXME rename?
 217 #define PART_NOT_AVAILABLE -2
 218
 219     /**
 220      * is 1 if the specific list MV&references are set to 0,0,-2.
 221      */
 222     int mv_cache_clean[2];
 223
 224     /**
 225      * number of neighbors (top and/or left) that used 8x8 dct
 226      */
 227     int neighbor_transform_size;
 228
 229     /**
 230      * block_offset[ 0..23] for frame macroblocks
 231      * block_offset[24..47] for field macroblocks
 232      */
 233     int block_offset[2*(16+8)];
 234
 235     uint32_t *mb2b_xy; //FIXME are these 4 a good idea?
 236     uint32_t *mb2b8_xy;
 237     int b_stride; //FIXME use s->b4_stride
 238     int b8_stride;
 239
 240     int mb_linesize;   ///< may be equal to s->linesize or s->linesize*2, for mbaff
 241     int mb_uvlinesize;
 242
 243     int emu_edge_width;
 244     int emu_edge_height;
 245
 246     int halfpel_flag;
 247     int thirdpel_flag;
 248
 249     int unknown_svq3_flag;
 250     int next_slice_index;
 251
 252     SPS *sps_buffers[MAX_SPS_COUNT];
 253     SPS sps; ///< current sps
 254
 255     PPS *pps_buffers[MAX_PPS_COUNT];
 256     /**
 257      * current pps
 258      */
 259     PPS pps; //FIXME move to Picture perhaps? (->no) do we need that?
 260
 261     uint32_t dequant4_buffer[6][52][16];
 262     uint32_t dequant8_buffer[2][52][64];
 263     uint32_t (*dequant4_coeff[6])[16];
 264     uint32_t (*dequant8_coeff[2])[64];
 265     int dequant_coeff_pps;     ///< reinit tables when pps changes
 266
 267     int slice_num;
 268     uint8_t *slice_table_base;
 269     uint8_t *slice_table;      ///< slice_table_base + 2*mb_stride + 1
 270     int slice_type;
 271     int slice_type_fixed;
 272
 273     //interlacing specific flags
 274     int mb_aff_frame;
 275     int mb_field_decoding_flag;
 276     int mb_mbaff;              ///< mb_aff_frame && mb_field_decoding_flag
 277
 278     unsigned int sub_mb_type[4];
 279
 280     //POC stuff
 281     int poc_lsb;
 282     int poc_msb;
 283     int delta_poc_bottom;
 284     int delta_poc[2];
 285     int frame_num;
 286     int prev_poc_msb;             ///< poc_msb of the last reference pic for POC type 0
 287     int prev_poc_lsb;             ///< poc_lsb of the last reference pic for POC type 0
 288     int frame_num_offset;         ///< for POC type 2
 289     int prev_frame_num_offset;    ///< for POC type 2
 290     int prev_frame_num;           ///< frame_num of the last pic for POC type 1/2
 291
 292     /**
 293      * frame_num for frames or 2*frame_num+1 for field pics.
 294      */
 295     int curr_pic_num;
 296
 297     /**
 298      * max_frame_num or 2*max_frame_num for field pics.
 299      */
 300     int max_pic_num;
 301
 302     //Weighted pred stuff
 303     int use_weight;
 304     int use_weight_chroma;
 305     int luma_log2_weight_denom;
 306     int chroma_log2_weight_denom;
 307     int luma_weight[2][48];
 308     int luma_offset[2][48];
 309     int chroma_weight[2][48][2];
 310     int chroma_offset[2][48][2];
 311     int implicit_weight[48][48];
 312
 313     //deblock
 314     int deblocking_filter;         ///< disable_deblocking_filter_idc with 1<->0
 315     int slice_alpha_c0_offset;
 316     int slice_beta_offset;
 317
 318     int redundant_pic_count;
 319
 320     int direct_spatial_mv_pred;
 321     int dist_scale_factor[16];
 322     int dist_scale_factor_field[32];
 323     int map_col_to_list0[2][16];
 324     int map_col_to_list0_field[2][32];
 325
 326     /**
 327      * num_ref_idx_l0/1_active_minus1 + 1
 328      */
 329     unsigned int ref_count[2];   ///< counts frames or fields, depending on current mb mode
 330     unsigned int list_count;
 331     Picture *short_ref[32];
 332     Picture *long_ref[32];
 333     Picture default_ref_list[2][32]; ///< base reference list for all slices of a coded picture
 334     Picture ref_list[2][48];         /**< 0..15: frame refs, 16..47: mbaff field refs.
 335                                           Reordered version of default_ref_list
 336                                           according to picture reordering in slice header */
 337     Picture *delayed_pic[18]; //FIXME size?
 338     Picture *delayed_output_pic;
 339
 340     /**
 341      * memory management control operations buffer.
 342      */
 343     MMCO mmco[MAX_MMCO_COUNT];
 344     int mmco_index;
 345
 346     int long_ref_count;  ///< number of actual long term references
 347     int short_ref_count; ///< number of actual short term references
 348
 349     //data partitioning
 350     GetBitContext intra_gb;
 351     GetBitContext inter_gb;
 352     GetBitContext *intra_gb_ptr;
 353     GetBitContext *inter_gb_ptr;
 354
 355     DECLARE_ALIGNED_16(DCTELEM, mb[16*24]);
 356     DCTELEM mb_padding[256];        ///< as mb is addressed by scantable[i] and scantable is uint8_t we can either check that i is not too large or ensure that there is some unused stuff after mb
 357
 358     /**
 359      * Cabac
 360      */
 361     CABACContext cabac;
 362     uint8_t      cabac_state[460];
 363     int          cabac_init_idc;
 364
 365     /* 0x100 -> non null luma_dc, 0x80/0x40 -> non null chroma_dc (cb/cr), 0x?0 -> chroma_cbp(0,1,2), 0x0? luma_cbp */
 366     uint16_t     *cbp_table;
 367     int cbp;
 368     int top_cbp;
 369     int left_cbp;
 370     /* chroma_pred_mode for i4x4 or i16x16, else 0 */
 371     uint8_t     *chroma_pred_mode_table;
 372     int         last_qscale_diff;
 373     int16_t     (*mvd_table[2])[2];
 374     DECLARE_ALIGNED_8(int16_t, mvd_cache[2][5*8][2]);
 375     uint8_t     *direct_table;
 376     uint8_t     direct_cache[5*8];
 377
 378     uint8_t zigzag_scan[16];
 379     uint8_t zigzag_scan8x8[64];
 380     uint8_t zigzag_scan8x8_cavlc[64];
 381     uint8_t field_scan[16];
 382     uint8_t field_scan8x8[64];
 383     uint8_t field_scan8x8_cavlc[64];
 384     const uint8_t *zigzag_scan_q0;
 385     const uint8_t *zigzag_scan8x8_q0;
 386     const uint8_t *zigzag_scan8x8_cavlc_q0;
 387     const uint8_t *field_scan_q0;
 388     const uint8_t *field_scan8x8_q0;
 389     const uint8_t *field_scan8x8_cavlc_q0;
 390
 391     int x264_build;
 392
 393     /**
 394      * @defgroup multithreading Members for slice based multithreading
 395      * @{
 396      */
 397     struct H264Context *thread_context[MAX_THREADS];
 398
 399     /**
 400      * current slice number, used to initalize slice_num of each thread/context
 401      */
 402     int current_slice;
 403
 404     /**
 405      * Max number of threads / contexts.
 406      * This is equal to AVCodecContext.thread_count unless
 407      * multithreaded decoding is impossible, in which case it is
 408      * reduced to 1.
 409      */
 410     int max_contexts;
 411
 412     /**
 413      *  1 if the single thread fallback warning has already been
 414      *  displayed, 0 otherwise.
 415      */
 416     int single_decode_warning;
 417
 418     int last_slice_type;
 419     /** @} */
 420
 421     int mb_xy;
 422
 423 }H264Context;
 424
 425 #endif /* FFMPEG_H264_H */