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