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