Merge commit '136034d86b5cb1819a2c3e6ecdfeb05dcba7140d'
[ffmpeg.git] / 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
24  * H.264 / AVC / MPEG4 part10 codec.
25  * @author Michael Niedermayer <michaelni@gmx.at>
26  */
27
28 #ifndef AVCODEC_H264_H
29 #define AVCODEC_H264_H
30
31 #include "libavutil/intreadwrite.h"
32 #include "cabac.h"
33 #include "dsputil.h"
34 #include "error_resilience.h"
35 #include "get_bits.h"
36 #include "mpegvideo.h"
37 #include "h264chroma.h"
38 #include "h264dsp.h"
39 #include "h264pred.h"
40 #include "h264qpel.h"
41 #include "rectangle.h"
42
43 #define H264_MAX_PICTURE_COUNT 36
44 #define H264_MAX_THREADS       32
45
46 #define MAX_SPS_COUNT          32
47 #define MAX_PPS_COUNT         256
48
49 #define MAX_MMCO_COUNT         66
50
51 #define MAX_DELAYED_PIC_COUNT  16
52
53 #define MAX_MBPAIR_SIZE (256*1024) // a tighter bound could be calculated if someone cares about a few bytes
54
55 /* Compiling in interlaced support reduces the speed
56  * of progressive decoding by about 2%. */
57 #define ALLOW_INTERLACE
58
59 #define FMO 0
60
61 /**
62  * The maximum number of slices supported by the decoder.
63  * must be a power of 2
64  */
65 #define MAX_SLICES 16
66
67 #ifdef ALLOW_INTERLACE
68 #define MB_MBAFF(h)    h->mb_mbaff
69 #define MB_FIELD(h)    h->mb_field_decoding_flag
70 #define FRAME_MBAFF(h) h->mb_aff_frame
71 #define FIELD_PICTURE(h) (h->picture_structure != PICT_FRAME)
72 #define LEFT_MBS 2
73 #define LTOP     0
74 #define LBOT     1
75 #define LEFT(i)  (i)
76 #else
77 #define MB_MBAFF(h)      0
78 #define MB_FIELD(h)      0
79 #define FRAME_MBAFF(h)   0
80 #define FIELD_PICTURE(h) 0
81 #undef  IS_INTERLACED
82 #define IS_INTERLACED(mb_type) 0
83 #define LEFT_MBS 1
84 #define LTOP     0
85 #define LBOT     0
86 #define LEFT(i)  0
87 #endif
88 #define FIELD_OR_MBAFF_PICTURE(h) (FRAME_MBAFF(h) || FIELD_PICTURE(h))
89
90 #ifndef CABAC
91 #define CABAC(h) h->pps.cabac
92 #endif
93
94 #define CHROMA(h)    (h->sps.chroma_format_idc)
95 #define CHROMA422(h) (h->sps.chroma_format_idc == 2)
96 #define CHROMA444(h) (h->sps.chroma_format_idc == 3)
97
98 #define EXTENDED_SAR       255
99
100 #define MB_TYPE_REF0       MB_TYPE_ACPRED // dirty but it fits in 16 bit
101 #define MB_TYPE_8x8DCT     0x01000000
102 #define IS_REF0(a)         ((a) & MB_TYPE_REF0)
103 #define IS_8x8DCT(a)       ((a) & MB_TYPE_8x8DCT)
104
105 #define QP_MAX_NUM (51 + 6*6)           // The maximum supported qp
106
107 /* NAL unit types */
108 enum {
109     NAL_SLICE           = 1,
110     NAL_DPA             = 2,
111     NAL_DPB             = 3,
112     NAL_DPC             = 4,
113     NAL_IDR_SLICE       = 5,
114     NAL_SEI             = 6,
115     NAL_SPS             = 7,
116     NAL_PPS             = 8,
117     NAL_AUD             = 9,
118     NAL_END_SEQUENCE    = 10,
119     NAL_END_STREAM      = 11,
120     NAL_FILLER_DATA     = 12,
121     NAL_SPS_EXT         = 13,
122     NAL_AUXILIARY_SLICE = 19,
123     NAL_FF_IGNORE       = 0xff0f001,
124 };
125
126 /**
127  * SEI message types
128  */
129 typedef enum {
130     SEI_TYPE_BUFFERING_PERIOD       = 0,   ///< buffering period (H.264, D.1.1)
131     SEI_TYPE_PIC_TIMING             = 1,   ///< picture timing
132     SEI_TYPE_USER_DATA_ITU_T_T35    = 4,   ///< user data registered by ITU-T Recommendation T.35
133     SEI_TYPE_USER_DATA_UNREGISTERED = 5,   ///< unregistered user data
134     SEI_TYPE_RECOVERY_POINT         = 6,   ///< recovery point (frame # to decoder sync)
135     SEI_TYPE_FRAME_PACKING          = 45,  ///< frame packing arrangement
136 } SEI_Type;
137
138 /**
139  * pic_struct in picture timing SEI message
140  */
141 typedef enum {
142     SEI_PIC_STRUCT_FRAME             = 0, ///<  0: %frame
143     SEI_PIC_STRUCT_TOP_FIELD         = 1, ///<  1: top field
144     SEI_PIC_STRUCT_BOTTOM_FIELD      = 2, ///<  2: bottom field
145     SEI_PIC_STRUCT_TOP_BOTTOM        = 3, ///<  3: top field, bottom field, in that order
146     SEI_PIC_STRUCT_BOTTOM_TOP        = 4, ///<  4: bottom field, top field, in that order
147     SEI_PIC_STRUCT_TOP_BOTTOM_TOP    = 5, ///<  5: top field, bottom field, top field repeated, in that order
148     SEI_PIC_STRUCT_BOTTOM_TOP_BOTTOM = 6, ///<  6: bottom field, top field, bottom field repeated, in that order
149     SEI_PIC_STRUCT_FRAME_DOUBLING    = 7, ///<  7: %frame doubling
150     SEI_PIC_STRUCT_FRAME_TRIPLING    = 8  ///<  8: %frame tripling
151 } SEI_PicStructType;
152
153 /**
154  * frame_packing_arrangement types
155  */
156 typedef enum {
157     SEI_FPA_TYPE_CHECKERBOARD        = 0,
158     SEI_FPA_TYPE_INTERLEAVE_COLUMN   = 1,
159     SEI_FPA_TYPE_INTERLEAVE_ROW      = 2,
160     SEI_FPA_TYPE_SIDE_BY_SIDE        = 3,
161     SEI_FPA_TYPE_TOP_BOTTOM          = 4,
162     SEI_FPA_TYPE_INTERLEAVE_TEMPORAL = 5,
163     SEI_FPA_TYPE_2D                  = 6,
164 } SEI_FpaType;
165
166 /**
167  * Sequence parameter set
168  */
169 typedef struct SPS {
170     unsigned int sps_id;
171     int profile_idc;
172     int level_idc;
173     int chroma_format_idc;
174     int transform_bypass;              ///< qpprime_y_zero_transform_bypass_flag
175     int log2_max_frame_num;            ///< log2_max_frame_num_minus4 + 4
176     int poc_type;                      ///< pic_order_cnt_type
177     int log2_max_poc_lsb;              ///< log2_max_pic_order_cnt_lsb_minus4
178     int delta_pic_order_always_zero_flag;
179     int offset_for_non_ref_pic;
180     int offset_for_top_to_bottom_field;
181     int poc_cycle_length;              ///< num_ref_frames_in_pic_order_cnt_cycle
182     int ref_frame_count;               ///< num_ref_frames
183     int gaps_in_frame_num_allowed_flag;
184     int mb_width;                      ///< pic_width_in_mbs_minus1 + 1
185     int mb_height;                     ///< pic_height_in_map_units_minus1 + 1
186     int frame_mbs_only_flag;
187     int mb_aff;                        ///< mb_adaptive_frame_field_flag
188     int direct_8x8_inference_flag;
189     int crop;                          ///< frame_cropping_flag
190
191     /* those 4 are already in luma samples */
192     unsigned int crop_left;            ///< frame_cropping_rect_left_offset
193     unsigned int crop_right;           ///< frame_cropping_rect_right_offset
194     unsigned int crop_top;             ///< frame_cropping_rect_top_offset
195     unsigned int crop_bottom;          ///< frame_cropping_rect_bottom_offset
196     int vui_parameters_present_flag;
197     AVRational sar;
198     int video_signal_type_present_flag;
199     int full_range;
200     int colour_description_present_flag;
201     enum AVColorPrimaries color_primaries;
202     enum AVColorTransferCharacteristic color_trc;
203     enum AVColorSpace colorspace;
204     int timing_info_present_flag;
205     uint32_t num_units_in_tick;
206     uint32_t time_scale;
207     int fixed_frame_rate_flag;
208     short offset_for_ref_frame[256]; // FIXME dyn aloc?
209     int bitstream_restriction_flag;
210     int num_reorder_frames;
211     int scaling_matrix_present;
212     uint8_t scaling_matrix4[6][16];
213     uint8_t scaling_matrix8[6][64];
214     int nal_hrd_parameters_present_flag;
215     int vcl_hrd_parameters_present_flag;
216     int pic_struct_present_flag;
217     int time_offset_length;
218     int cpb_cnt;                          ///< See H.264 E.1.2
219     int initial_cpb_removal_delay_length; ///< initial_cpb_removal_delay_length_minus1 + 1
220     int cpb_removal_delay_length;         ///< cpb_removal_delay_length_minus1 + 1
221     int dpb_output_delay_length;          ///< dpb_output_delay_length_minus1 + 1
222     int bit_depth_luma;                   ///< bit_depth_luma_minus8 + 8
223     int bit_depth_chroma;                 ///< bit_depth_chroma_minus8 + 8
224     int residual_color_transform_flag;    ///< residual_colour_transform_flag
225     int constraint_set_flags;             ///< constraint_set[0-3]_flag
226     int new;                              ///< flag to keep track if the decoder context needs re-init due to changed SPS
227 } SPS;
228
229 /**
230  * Picture parameter set
231  */
232 typedef struct PPS {
233     unsigned int sps_id;
234     int cabac;                  ///< entropy_coding_mode_flag
235     int pic_order_present;      ///< pic_order_present_flag
236     int slice_group_count;      ///< num_slice_groups_minus1 + 1
237     int mb_slice_group_map_type;
238     unsigned int ref_count[2];  ///< num_ref_idx_l0/1_active_minus1 + 1
239     int weighted_pred;          ///< weighted_pred_flag
240     int weighted_bipred_idc;
241     int init_qp;                ///< pic_init_qp_minus26 + 26
242     int init_qs;                ///< pic_init_qs_minus26 + 26
243     int chroma_qp_index_offset[2];
244     int deblocking_filter_parameters_present; ///< deblocking_filter_parameters_present_flag
245     int constrained_intra_pred;     ///< constrained_intra_pred_flag
246     int redundant_pic_cnt_present;  ///< redundant_pic_cnt_present_flag
247     int transform_8x8_mode;         ///< transform_8x8_mode_flag
248     uint8_t scaling_matrix4[6][16];
249     uint8_t scaling_matrix8[6][64];
250     uint8_t chroma_qp_table[2][QP_MAX_NUM+1];  ///< pre-scaled (with chroma_qp_index_offset) version of qp_table
251     int chroma_qp_diff;
252 } PPS;
253
254 /**
255  * Frame Packing Arrangement Type
256  */
257 typedef struct FPA {
258     int         frame_packing_arrangement_id;
259     int         frame_packing_arrangement_cancel_flag; ///< is previous arrangement canceled, -1 if never received
260     SEI_FpaType frame_packing_arrangement_type;
261     int         frame_packing_arrangement_repetition_period;
262     int         content_interpretation_type;
263     int         quincunx_sampling_flag;
264 } FPA;
265
266 /**
267  * Memory management control operation opcode.
268  */
269 typedef enum MMCOOpcode {
270     MMCO_END = 0,
271     MMCO_SHORT2UNUSED,
272     MMCO_LONG2UNUSED,
273     MMCO_SHORT2LONG,
274     MMCO_SET_MAX_LONG,
275     MMCO_RESET,
276     MMCO_LONG,
277 } MMCOOpcode;
278
279 /**
280  * Memory management control operation.
281  */
282 typedef struct MMCO {
283     MMCOOpcode opcode;
284     int short_pic_num;  ///< pic_num without wrapping (pic_num & max_pic_num)
285     int long_arg;       ///< index, pic_num, or num long refs depending on opcode
286 } MMCO;
287
288 typedef struct H264Picture {
289     struct AVFrame f;
290     ThreadFrame tf;
291
292     AVBufferRef *qscale_table_buf;
293     int8_t *qscale_table;
294
295     AVBufferRef *motion_val_buf[2];
296     int16_t (*motion_val[2])[2];
297
298     AVBufferRef *mb_type_buf;
299     uint32_t *mb_type;
300
301     AVBufferRef *hwaccel_priv_buf;
302     void *hwaccel_picture_private; ///< hardware accelerator private data
303
304     AVBufferRef *ref_index_buf[2];
305     int8_t *ref_index[2];
306
307     int field_poc[2];       ///< top/bottom POC
308     int poc;                ///< frame POC
309     int frame_num;          ///< frame_num (raw frame_num from slice header)
310     int mmco_reset;         /**< MMCO_RESET set this 1. Reordering code must
311                                  not mix pictures before and after MMCO_RESET. */
312     int pic_id;             /**< pic_num (short -> no wrap version of pic_num,
313                                  pic_num & max_pic_num; long -> long_pic_num) */
314     int long_ref;           ///< 1->long term reference 0->short term reference
315     int ref_poc[2][2][32];  ///< POCs of the frames used as reference (FIXME need per slice)
316     int ref_count[2][2];    ///< number of entries in ref_poc         (FIXME need per slice)
317     int mbaff;              ///< 1 -> MBAFF frame 0-> not MBAFF
318     int field_picture;      ///< whether or not picture was encoded in separate fields
319
320     int needs_realloc;      ///< picture needs to be reallocated (eg due to a frame size change)
321     int reference;
322     int recovered;          ///< picture at IDR or recovery point + recovery count
323     int invalid_gap;
324
325     int crop;
326     int crop_left;
327     int crop_top;
328 } H264Picture;
329
330 /**
331  * H264Context
332  */
333 typedef struct H264Context {
334     AVCodecContext *avctx;
335     VideoDSPContext vdsp;
336     H264DSPContext h264dsp;
337     H264ChromaContext h264chroma;
338     H264QpelContext h264qpel;
339     ParseContext parse_context;
340     GetBitContext gb;
341     DSPContext       dsp;
342     ERContext er;
343
344     H264Picture *DPB;
345     H264Picture *cur_pic_ptr;
346     H264Picture cur_pic;
347
348     int pixel_shift;    ///< 0 for 8-bit H264, 1 for high-bit-depth H264
349     int chroma_qp[2];   // QPc
350
351     int qp_thresh;      ///< QP threshold to skip loopfilter
352
353     /* coded dimensions -- 16 * mb w/h */
354     int width, height;
355     ptrdiff_t linesize, uvlinesize;
356     int chroma_x_shift, chroma_y_shift;
357
358     int qscale;
359     int droppable;
360     int data_partitioning;
361     int coded_picture_number;
362     int low_delay;
363
364     int context_initialized;
365     int flags;
366     int workaround_bugs;
367
368     int prev_mb_skipped;
369     int next_mb_skipped;
370
371     // prediction stuff
372     int chroma_pred_mode;
373     int intra16x16_pred_mode;
374
375     int topleft_mb_xy;
376     int top_mb_xy;
377     int topright_mb_xy;
378     int left_mb_xy[LEFT_MBS];
379
380     int topleft_type;
381     int top_type;
382     int topright_type;
383     int left_type[LEFT_MBS];
384
385     const uint8_t *left_block;
386     int topleft_partition;
387
388     int8_t intra4x4_pred_mode_cache[5 * 8];
389     int8_t(*intra4x4_pred_mode);
390     H264PredContext hpc;
391     unsigned int topleft_samples_available;
392     unsigned int top_samples_available;
393     unsigned int topright_samples_available;
394     unsigned int left_samples_available;
395     uint8_t (*top_borders[2])[(16 * 3) * 2];
396
397     /**
398      * non zero coeff count cache.
399      * is 64 if not available.
400      */
401     DECLARE_ALIGNED(8, uint8_t, non_zero_count_cache)[15 * 8];
402
403     uint8_t (*non_zero_count)[48];
404
405     /**
406      * Motion vector cache.
407      */
408     DECLARE_ALIGNED(16, int16_t, mv_cache)[2][5 * 8][2];
409     DECLARE_ALIGNED(8, int8_t, ref_cache)[2][5 * 8];
410 #define LIST_NOT_USED -1 // FIXME rename?
411 #define PART_NOT_AVAILABLE -2
412
413     /**
414      * number of neighbors (top and/or left) that used 8x8 dct
415      */
416     int neighbor_transform_size;
417
418     /**
419      * block_offset[ 0..23] for frame macroblocks
420      * block_offset[24..47] for field macroblocks
421      */
422     int block_offset[2 * (16 * 3)];
423
424     uint32_t *mb2b_xy;  // FIXME are these 4 a good idea?
425     uint32_t *mb2br_xy;
426     int b_stride;       // FIXME use s->b4_stride
427
428     ptrdiff_t mb_linesize;  ///< may be equal to s->linesize or s->linesize * 2, for mbaff
429     ptrdiff_t mb_uvlinesize;
430
431     unsigned current_sps_id; ///< id of the current SPS
432     SPS sps; ///< current sps
433     PPS pps; ///< current pps
434
435     int au_pps_id; ///< pps_id of current access unit
436
437     uint32_t dequant4_buffer[6][QP_MAX_NUM + 1][16]; // FIXME should these be moved down?
438     uint32_t dequant8_buffer[6][QP_MAX_NUM + 1][64];
439     uint32_t(*dequant4_coeff[6])[16];
440     uint32_t(*dequant8_coeff[6])[64];
441
442     int slice_num;
443     uint16_t *slice_table;      ///< slice_table_base + 2*mb_stride + 1
444     int slice_type;
445     int slice_type_nos;         ///< S free slice type (SI/SP are remapped to I/P)
446     int slice_type_fixed;
447
448     // interlacing specific flags
449     int mb_aff_frame;
450     int mb_field_decoding_flag;
451     int mb_mbaff;               ///< mb_aff_frame && mb_field_decoding_flag
452     int picture_structure;
453     int first_field;
454
455     DECLARE_ALIGNED(8, uint16_t, sub_mb_type)[4];
456
457     // Weighted pred stuff
458     int use_weight;
459     int use_weight_chroma;
460     int luma_log2_weight_denom;
461     int chroma_log2_weight_denom;
462     // The following 2 can be changed to int8_t but that causes 10cpu cycles speedloss
463     int luma_weight[48][2][2];
464     int chroma_weight[48][2][2][2];
465     int implicit_weight[48][48][2];
466
467     int direct_spatial_mv_pred;
468     int col_parity;
469     int col_fieldoff;
470     int dist_scale_factor[32];
471     int dist_scale_factor_field[2][32];
472     int map_col_to_list0[2][16 + 32];
473     int map_col_to_list0_field[2][2][16 + 32];
474
475     /**
476      * num_ref_idx_l0/1_active_minus1 + 1
477      */
478     unsigned int ref_count[2];          ///< counts frames or fields, depending on current mb mode
479     unsigned int list_count;
480     uint8_t *list_counts;               ///< Array of list_count per MB specifying the slice type
481     H264Picture ref_list[2][48];        /**< 0..15: frame refs, 16..47: mbaff field refs.
482                                          *   Reordered version of default_ref_list
483                                          *   according to picture reordering in slice header */
484     int ref2frm[MAX_SLICES][2][64];     ///< reference to frame number lists, used in the loop filter, the first 2 are for -2,-1
485
486     // data partitioning
487     GetBitContext intra_gb;
488     GetBitContext inter_gb;
489     GetBitContext *intra_gb_ptr;
490     GetBitContext *inter_gb_ptr;
491
492     const uint8_t *intra_pcm_ptr;
493     DECLARE_ALIGNED(16, int16_t, mb)[16 * 48 * 2]; ///< as a dct coeffecient is int32_t in high depth, we need to reserve twice the space.
494     DECLARE_ALIGNED(16, int16_t, mb_luma_dc)[3][16 * 2];
495     int16_t mb_padding[256 * 2];        ///< 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
496
497     /**
498      * Cabac
499      */
500     CABACContext cabac;
501     uint8_t cabac_state[1024];
502
503     /* 0x100 -> non null luma_dc, 0x80/0x40 -> non null chroma_dc (cb/cr), 0x?0 -> chroma_cbp(0, 1, 2), 0x0? luma_cbp */
504     uint16_t *cbp_table;
505     int cbp;
506     int top_cbp;
507     int left_cbp;
508     /* chroma_pred_mode for i4x4 or i16x16, else 0 */
509     uint8_t *chroma_pred_mode_table;
510     int last_qscale_diff;
511     uint8_t (*mvd_table[2])[2];
512     DECLARE_ALIGNED(16, uint8_t, mvd_cache)[2][5 * 8][2];
513     uint8_t *direct_table;
514     uint8_t direct_cache[5 * 8];
515
516     uint8_t zigzag_scan[16];
517     uint8_t zigzag_scan8x8[64];
518     uint8_t zigzag_scan8x8_cavlc[64];
519     uint8_t field_scan[16];
520     uint8_t field_scan8x8[64];
521     uint8_t field_scan8x8_cavlc[64];
522     uint8_t zigzag_scan_q0[16];
523     uint8_t zigzag_scan8x8_q0[64];
524     uint8_t zigzag_scan8x8_cavlc_q0[64];
525     uint8_t field_scan_q0[16];
526     uint8_t field_scan8x8_q0[64];
527     uint8_t field_scan8x8_cavlc_q0[64];
528
529     int x264_build;
530
531     int mb_x, mb_y;
532     int resync_mb_x;
533     int resync_mb_y;
534     int mb_skip_run;
535     int mb_height, mb_width;
536     int mb_stride;
537     int mb_num;
538     int mb_xy;
539
540     int is_complex;
541
542     // deblock
543     int deblocking_filter;          ///< disable_deblocking_filter_idc with 1 <-> 0
544     int slice_alpha_c0_offset;
545     int slice_beta_offset;
546
547     // =============================================================
548     // Things below are not used in the MB or more inner code
549
550     int nal_ref_idc;
551     int nal_unit_type;
552     uint8_t *rbsp_buffer[2];
553     unsigned int rbsp_buffer_size[2];
554
555     /**
556      * Used to parse AVC variant of h264
557      */
558     int is_avc;           ///< this flag is != 0 if codec is avc1
559     int nal_length_size;  ///< Number of bytes used for nal length (1, 2 or 4)
560     int got_first;        ///< this flag is != 0 if we've parsed a frame
561
562     int bit_depth_luma;         ///< luma bit depth from sps to detect changes
563     int chroma_format_idc;      ///< chroma format from sps to detect changes
564
565     SPS *sps_buffers[MAX_SPS_COUNT];
566     PPS *pps_buffers[MAX_PPS_COUNT];
567
568     int dequant_coeff_pps;      ///< reinit tables when pps changes
569
570     uint16_t *slice_table_base;
571
572     // POC stuff
573     int poc_lsb;
574     int poc_msb;
575     int delta_poc_bottom;
576     int delta_poc[2];
577     int frame_num;
578     int prev_poc_msb;           ///< poc_msb of the last reference pic for POC type 0
579     int prev_poc_lsb;           ///< poc_lsb of the last reference pic for POC type 0
580     int frame_num_offset;       ///< for POC type 2
581     int prev_frame_num_offset;  ///< for POC type 2
582     int prev_frame_num;         ///< frame_num of the last pic for POC type 1/2
583
584     /**
585      * frame_num for frames or 2 * frame_num + 1 for field pics.
586      */
587     int curr_pic_num;
588
589     /**
590      * max_frame_num or 2 * max_frame_num for field pics.
591      */
592     int max_pic_num;
593
594     int redundant_pic_count;
595
596     H264Picture default_ref_list[2][32]; ///< base reference list for all slices of a coded picture
597     H264Picture *short_ref[32];
598     H264Picture *long_ref[32];
599     H264Picture *delayed_pic[MAX_DELAYED_PIC_COUNT + 2]; // FIXME size?
600     int last_pocs[MAX_DELAYED_PIC_COUNT];
601     H264Picture *next_output_pic;
602     int outputed_poc;
603     int next_outputed_poc;
604
605     /**
606      * memory management control operations buffer.
607      */
608     MMCO mmco[MAX_MMCO_COUNT];
609     int mmco_index;
610     int mmco_reset;
611
612     int long_ref_count;     ///< number of actual long term references
613     int short_ref_count;    ///< number of actual short term references
614
615     int cabac_init_idc;
616
617     /**
618      * @name Members for slice based multithreading
619      * @{
620      */
621     struct H264Context *thread_context[H264_MAX_THREADS];
622
623     /**
624      * current slice number, used to initialize slice_num of each thread/context
625      */
626     int current_slice;
627
628     /**
629      * Max number of threads / contexts.
630      * This is equal to AVCodecContext.thread_count unless
631      * multithreaded decoding is impossible, in which case it is
632      * reduced to 1.
633      */
634     int max_contexts;
635
636     int slice_context_count;
637
638     /**
639      *  1 if the single thread fallback warning has already been
640      *  displayed, 0 otherwise.
641      */
642     int single_decode_warning;
643
644     enum AVPictureType pict_type;
645
646     int last_slice_type;
647     unsigned int last_ref_count[2];
648     /** @} */
649
650     /**
651      * pic_struct in picture timing SEI message
652      */
653     SEI_PicStructType sei_pic_struct;
654
655     /**
656      * Complement sei_pic_struct
657      * SEI_PIC_STRUCT_TOP_BOTTOM and SEI_PIC_STRUCT_BOTTOM_TOP indicate interlaced frames.
658      * However, soft telecined frames may have these values.
659      * This is used in an attempt to flag soft telecine progressive.
660      */
661     int prev_interlaced_frame;
662
663     /**
664      * frame_packing_arrangment SEI message
665      */
666     int sei_frame_packing_present;
667     int frame_packing_arrangement_type;
668     int content_interpretation_type;
669     int quincunx_subsampling;
670
671     /**
672      * Bit set of clock types for fields/frames in picture timing SEI message.
673      * For each found ct_type, appropriate bit is set (e.g., bit 1 for
674      * interlaced).
675      */
676     int sei_ct_type;
677
678     /**
679      * dpb_output_delay in picture timing SEI message, see H.264 C.2.2
680      */
681     int sei_dpb_output_delay;
682
683     /**
684      * cpb_removal_delay in picture timing SEI message, see H.264 C.1.2
685      */
686     int sei_cpb_removal_delay;
687
688     /**
689      * recovery_frame_cnt from SEI message
690      *
691      * Set to -1 if no recovery point SEI message found or to number of frames
692      * before playback synchronizes. Frames having recovery point are key
693      * frames.
694      */
695     int sei_recovery_frame_cnt;
696
697     /**
698      * Are the SEI recovery points looking valid.
699      */
700     int valid_recovery_point;
701
702     FPA sei_fpa;
703
704     /**
705      * recovery_frame is the frame_num at which the next frame should
706      * be fully constructed.
707      *
708      * Set to -1 when not expecting a recovery point.
709      */
710     int recovery_frame;
711
712 /**
713  * We have seen an IDR, so all the following frames in coded order are correctly
714  * decodable.
715  */
716 #define FRAME_RECOVERED_IDR  (1 << 0)
717 /**
718  * Sufficient number of frames have been decoded since a SEI recovery point,
719  * so all the following frames in presentation order are correct.
720  */
721 #define FRAME_RECOVERED_SEI  (1 << 1)
722
723     int frame_recovered;    ///< Initial frame has been completely recovered
724
725     int luma_weight_flag[2];    ///< 7.4.3.2 luma_weight_lX_flag
726     int chroma_weight_flag[2];  ///< 7.4.3.2 chroma_weight_lX_flag
727
728     // Timestamp stuff
729     int sei_buffering_period_present;   ///< Buffering period SEI flag
730     int initial_cpb_removal_delay[32];  ///< Initial timestamps for CPBs
731
732     int cur_chroma_format_idc;
733     uint8_t *bipred_scratchpad;
734
735     int16_t slice_row[MAX_SLICES]; ///< to detect when MAX_SLICES is too low
736
737     uint8_t parse_history[4];
738     int parse_history_count;
739     int parse_last_mb;
740     uint8_t *edge_emu_buffer;
741     int16_t *dc_val_base;
742
743     AVBufferPool *qscale_table_pool;
744     AVBufferPool *mb_type_pool;
745     AVBufferPool *motion_val_pool;
746     AVBufferPool *ref_index_pool;
747
748     /* Motion Estimation */
749     qpel_mc_func (*qpel_put)[16];
750     qpel_mc_func (*qpel_avg)[16];
751 } H264Context;
752
753 extern const uint8_t ff_h264_chroma_qp[7][QP_MAX_NUM + 1]; ///< One chroma qp table for each possible bit depth (8-14).
754 extern const uint16_t ff_h264_mb_sizes[4];
755
756 /**
757  * Decode SEI
758  */
759 int ff_h264_decode_sei(H264Context *h);
760
761 /**
762  * Decode SPS
763  */
764 int ff_h264_decode_seq_parameter_set(H264Context *h);
765
766 /**
767  * compute profile from sps
768  */
769 int ff_h264_get_profile(SPS *sps);
770
771 /**
772  * Decode PPS
773  */
774 int ff_h264_decode_picture_parameter_set(H264Context *h, int bit_length);
775
776 /**
777  * Decode a network abstraction layer unit.
778  * @param consumed is the number of bytes used as input
779  * @param length is the length of the array
780  * @param dst_length is the number of decoded bytes FIXME here
781  *                   or a decode rbsp tailing?
782  * @return decoded bytes, might be src+1 if no escapes
783  */
784 const uint8_t *ff_h264_decode_nal(H264Context *h, const uint8_t *src,
785                                   int *dst_length, int *consumed, int length);
786
787 /**
788  * Free any data that may have been allocated in the H264 context
789  * like SPS, PPS etc.
790  */
791 void ff_h264_free_context(H264Context *h);
792
793 /**
794  * Reconstruct bitstream slice_type.
795  */
796 int ff_h264_get_slice_type(const H264Context *h);
797
798 /**
799  * Allocate tables.
800  * needs width/height
801  */
802 int ff_h264_alloc_tables(H264Context *h);
803
804 /**
805  * Fill the default_ref_list.
806  */
807 int ff_h264_fill_default_ref_list(H264Context *h);
808
809 int ff_h264_decode_ref_pic_list_reordering(H264Context *h);
810 void ff_h264_fill_mbaff_ref_list(H264Context *h);
811 void ff_h264_remove_all_refs(H264Context *h);
812
813 /**
814  * Execute the reference picture marking (memory management control operations).
815  */
816 int ff_h264_execute_ref_pic_marking(H264Context *h, MMCO *mmco, int mmco_count);
817
818 int ff_h264_decode_ref_pic_marking(H264Context *h, GetBitContext *gb,
819                                    int first_slice);
820
821 int ff_generate_sliding_window_mmcos(H264Context *h, int first_slice);
822
823 /**
824  * Check if the top & left blocks are available if needed & change the
825  * dc mode so it only uses the available blocks.
826  */
827 int ff_h264_check_intra4x4_pred_mode(H264Context *h);
828
829 /**
830  * Check if the top & left blocks are available if needed & change the
831  * dc mode so it only uses the available blocks.
832  */
833 int ff_h264_check_intra_pred_mode(H264Context *h, int mode, int is_chroma);
834
835 void ff_h264_hl_decode_mb(H264Context *h);
836 int ff_h264_decode_extradata(H264Context *h, const uint8_t *buf, int size);
837 int ff_h264_decode_init(AVCodecContext *avctx);
838 void ff_h264_decode_init_vlc(void);
839
840 /**
841  * Decode a macroblock
842  * @return 0 if OK, ER_AC_ERROR / ER_DC_ERROR / ER_MV_ERROR on error
843  */
844 int ff_h264_decode_mb_cavlc(H264Context *h);
845
846 /**
847  * Decode a CABAC coded macroblock
848  * @return 0 if OK, ER_AC_ERROR / ER_DC_ERROR / ER_MV_ERROR on error
849  */
850 int ff_h264_decode_mb_cabac(H264Context *h);
851
852 void ff_h264_init_cabac_states(H264Context *h);
853
854 void ff_h264_direct_dist_scale_factor(H264Context *const h);
855 void ff_h264_direct_ref_list_init(H264Context *const h);
856 void ff_h264_pred_direct_motion(H264Context *const h, int *mb_type);
857
858 void ff_h264_filter_mb_fast(H264Context *h, int mb_x, int mb_y,
859                             uint8_t *img_y, uint8_t *img_cb, uint8_t *img_cr,
860                             unsigned int linesize, unsigned int uvlinesize);
861 void ff_h264_filter_mb(H264Context *h, int mb_x, int mb_y,
862                        uint8_t *img_y, uint8_t *img_cb, uint8_t *img_cr,
863                        unsigned int linesize, unsigned int uvlinesize);
864
865 /**
866  * Reset SEI values at the beginning of the frame.
867  *
868  * @param h H.264 context.
869  */
870 void ff_h264_reset_sei(H264Context *h);
871
872 /**
873  * Get stereo_mode string from the h264 frame_packing_arrangement
874  * @param h H.264 context.
875  */
876 const char* ff_h264_sei_stereo_mode(H264Context *h);
877
878 /*
879  * o-o o-o
880  *  / / /
881  * o-o o-o
882  *  ,---'
883  * o-o o-o
884  *  / / /
885  * o-o o-o
886  */
887
888 /* Scan8 organization:
889  *    0 1 2 3 4 5 6 7
890  * 0  DY    y y y y y
891  * 1        y Y Y Y Y
892  * 2        y Y Y Y Y
893  * 3        y Y Y Y Y
894  * 4        y Y Y Y Y
895  * 5  DU    u u u u u
896  * 6        u U U U U
897  * 7        u U U U U
898  * 8        u U U U U
899  * 9        u U U U U
900  * 10 DV    v v v v v
901  * 11       v V V V V
902  * 12       v V V V V
903  * 13       v V V V V
904  * 14       v V V V V
905  * DY/DU/DV are for luma/chroma DC.
906  */
907
908 #define LUMA_DC_BLOCK_INDEX   48
909 #define CHROMA_DC_BLOCK_INDEX 49
910
911 // This table must be here because scan8[constant] must be known at compiletime
912 static const uint8_t scan8[16 * 3 + 3] = {
913     4 +  1 * 8, 5 +  1 * 8, 4 +  2 * 8, 5 +  2 * 8,
914     6 +  1 * 8, 7 +  1 * 8, 6 +  2 * 8, 7 +  2 * 8,
915     4 +  3 * 8, 5 +  3 * 8, 4 +  4 * 8, 5 +  4 * 8,
916     6 +  3 * 8, 7 +  3 * 8, 6 +  4 * 8, 7 +  4 * 8,
917     4 +  6 * 8, 5 +  6 * 8, 4 +  7 * 8, 5 +  7 * 8,
918     6 +  6 * 8, 7 +  6 * 8, 6 +  7 * 8, 7 +  7 * 8,
919     4 +  8 * 8, 5 +  8 * 8, 4 +  9 * 8, 5 +  9 * 8,
920     6 +  8 * 8, 7 +  8 * 8, 6 +  9 * 8, 7 +  9 * 8,
921     4 + 11 * 8, 5 + 11 * 8, 4 + 12 * 8, 5 + 12 * 8,
922     6 + 11 * 8, 7 + 11 * 8, 6 + 12 * 8, 7 + 12 * 8,
923     4 + 13 * 8, 5 + 13 * 8, 4 + 14 * 8, 5 + 14 * 8,
924     6 + 13 * 8, 7 + 13 * 8, 6 + 14 * 8, 7 + 14 * 8,
925     0 +  0 * 8, 0 +  5 * 8, 0 + 10 * 8
926 };
927
928 static av_always_inline uint32_t pack16to32(int a, int b)
929 {
930 #if HAVE_BIGENDIAN
931     return (b & 0xFFFF) + (a << 16);
932 #else
933     return (a & 0xFFFF) + (b << 16);
934 #endif
935 }
936
937 static av_always_inline uint16_t pack8to16(int a, int b)
938 {
939 #if HAVE_BIGENDIAN
940     return (b & 0xFF) + (a << 8);
941 #else
942     return (a & 0xFF) + (b << 8);
943 #endif
944 }
945
946 /**
947  * Get the chroma qp.
948  */
949 static av_always_inline int get_chroma_qp(H264Context *h, int t, int qscale)
950 {
951     return h->pps.chroma_qp_table[t][qscale];
952 }
953
954 /**
955  * Get the predicted intra4x4 prediction mode.
956  */
957 static av_always_inline int pred_intra_mode(H264Context *h, int n)
958 {
959     const int index8 = scan8[n];
960     const int left   = h->intra4x4_pred_mode_cache[index8 - 1];
961     const int top    = h->intra4x4_pred_mode_cache[index8 - 8];
962     const int min    = FFMIN(left, top);
963
964     tprintf(h->avctx, "mode:%d %d min:%d\n", left, top, min);
965
966     if (min < 0)
967         return DC_PRED;
968     else
969         return min;
970 }
971
972 static av_always_inline void write_back_intra_pred_mode(H264Context *h)
973 {
974     int8_t *i4x4       = h->intra4x4_pred_mode + h->mb2br_xy[h->mb_xy];
975     int8_t *i4x4_cache = h->intra4x4_pred_mode_cache;
976
977     AV_COPY32(i4x4, i4x4_cache + 4 + 8 * 4);
978     i4x4[4] = i4x4_cache[7 + 8 * 3];
979     i4x4[5] = i4x4_cache[7 + 8 * 2];
980     i4x4[6] = i4x4_cache[7 + 8 * 1];
981 }
982
983 static av_always_inline void write_back_non_zero_count(H264Context *h)
984 {
985     const int mb_xy    = h->mb_xy;
986     uint8_t *nnz       = h->non_zero_count[mb_xy];
987     uint8_t *nnz_cache = h->non_zero_count_cache;
988
989     AV_COPY32(&nnz[ 0], &nnz_cache[4 + 8 * 1]);
990     AV_COPY32(&nnz[ 4], &nnz_cache[4 + 8 * 2]);
991     AV_COPY32(&nnz[ 8], &nnz_cache[4 + 8 * 3]);
992     AV_COPY32(&nnz[12], &nnz_cache[4 + 8 * 4]);
993     AV_COPY32(&nnz[16], &nnz_cache[4 + 8 * 6]);
994     AV_COPY32(&nnz[20], &nnz_cache[4 + 8 * 7]);
995     AV_COPY32(&nnz[32], &nnz_cache[4 + 8 * 11]);
996     AV_COPY32(&nnz[36], &nnz_cache[4 + 8 * 12]);
997
998     if (!h->chroma_y_shift) {
999         AV_COPY32(&nnz[24], &nnz_cache[4 + 8 * 8]);
1000         AV_COPY32(&nnz[28], &nnz_cache[4 + 8 * 9]);
1001         AV_COPY32(&nnz[40], &nnz_cache[4 + 8 * 13]);
1002         AV_COPY32(&nnz[44], &nnz_cache[4 + 8 * 14]);
1003     }
1004 }
1005
1006 static av_always_inline void write_back_motion_list(H264Context *h,
1007                                                     int b_stride,
1008                                                     int b_xy, int b8_xy,
1009                                                     int mb_type, int list)
1010 {
1011     int16_t(*mv_dst)[2] = &h->cur_pic.motion_val[list][b_xy];
1012     int16_t(*mv_src)[2] = &h->mv_cache[list][scan8[0]];
1013     AV_COPY128(mv_dst + 0 * b_stride, mv_src + 8 * 0);
1014     AV_COPY128(mv_dst + 1 * b_stride, mv_src + 8 * 1);
1015     AV_COPY128(mv_dst + 2 * b_stride, mv_src + 8 * 2);
1016     AV_COPY128(mv_dst + 3 * b_stride, mv_src + 8 * 3);
1017     if (CABAC(h)) {
1018         uint8_t (*mvd_dst)[2] = &h->mvd_table[list][FMO ? 8 * h->mb_xy
1019                                                         : h->mb2br_xy[h->mb_xy]];
1020         uint8_t(*mvd_src)[2]  = &h->mvd_cache[list][scan8[0]];
1021         if (IS_SKIP(mb_type)) {
1022             AV_ZERO128(mvd_dst);
1023         } else {
1024             AV_COPY64(mvd_dst, mvd_src + 8 * 3);
1025             AV_COPY16(mvd_dst + 3 + 3, mvd_src + 3 + 8 * 0);
1026             AV_COPY16(mvd_dst + 3 + 2, mvd_src + 3 + 8 * 1);
1027             AV_COPY16(mvd_dst + 3 + 1, mvd_src + 3 + 8 * 2);
1028         }
1029     }
1030
1031     {
1032         int8_t *ref_index = &h->cur_pic.ref_index[list][b8_xy];
1033         int8_t *ref_cache = h->ref_cache[list];
1034         ref_index[0 + 0 * 2] = ref_cache[scan8[0]];
1035         ref_index[1 + 0 * 2] = ref_cache[scan8[4]];
1036         ref_index[0 + 1 * 2] = ref_cache[scan8[8]];
1037         ref_index[1 + 1 * 2] = ref_cache[scan8[12]];
1038     }
1039 }
1040
1041 static av_always_inline void write_back_motion(H264Context *h, int mb_type)
1042 {
1043     const int b_stride      = h->b_stride;
1044     const int b_xy  = 4 * h->mb_x + 4 * h->mb_y * h->b_stride; // try mb2b(8)_xy
1045     const int b8_xy = 4 * h->mb_xy;
1046
1047     if (USES_LIST(mb_type, 0)) {
1048         write_back_motion_list(h, b_stride, b_xy, b8_xy, mb_type, 0);
1049     } else {
1050         fill_rectangle(&h->cur_pic.ref_index[0][b8_xy],
1051                        2, 2, 2, (uint8_t)LIST_NOT_USED, 1);
1052     }
1053     if (USES_LIST(mb_type, 1))
1054         write_back_motion_list(h, b_stride, b_xy, b8_xy, mb_type, 1);
1055
1056     if (h->slice_type_nos == AV_PICTURE_TYPE_B && CABAC(h)) {
1057         if (IS_8X8(mb_type)) {
1058             uint8_t *direct_table = &h->direct_table[4 * h->mb_xy];
1059             direct_table[1] = h->sub_mb_type[1] >> 1;
1060             direct_table[2] = h->sub_mb_type[2] >> 1;
1061             direct_table[3] = h->sub_mb_type[3] >> 1;
1062         }
1063     }
1064 }
1065
1066 static av_always_inline int get_dct8x8_allowed(H264Context *h)
1067 {
1068     if (h->sps.direct_8x8_inference_flag)
1069         return !(AV_RN64A(h->sub_mb_type) &
1070                  ((MB_TYPE_16x8 | MB_TYPE_8x16 | MB_TYPE_8x8) *
1071                   0x0001000100010001ULL));
1072     else
1073         return !(AV_RN64A(h->sub_mb_type) &
1074                  ((MB_TYPE_16x8 | MB_TYPE_8x16 | MB_TYPE_8x8 | MB_TYPE_DIRECT2) *
1075                   0x0001000100010001ULL));
1076 }
1077
1078 void ff_h264_draw_horiz_band(H264Context *h, int y, int height);
1079 int ff_init_poc(H264Context *h, int pic_field_poc[2], int *pic_poc);
1080 int ff_pred_weight_table(H264Context *h);
1081 int ff_set_ref_count(H264Context *h);
1082
1083 #endif /* AVCODEC_H264_H */