70539bbd589b1ecf94f0787a53f2acedd75f5489
[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
328     int crop;
329     int crop_left;
330     int crop_top;
331 } H264Picture;
332
333 /**
334  * H264Context
335  */
336 typedef struct H264Context {
337     AVCodecContext *avctx;
338     VideoDSPContext vdsp;
339     H264DSPContext h264dsp;
340     H264ChromaContext h264chroma;
341     H264QpelContext h264qpel;
342     ParseContext parse_context;
343     GetBitContext gb;
344     DSPContext       dsp;
345     ERContext er;
346
347     H264Picture *DPB;
348     H264Picture *cur_pic_ptr;
349     H264Picture cur_pic;
350
351     int pixel_shift;    ///< 0 for 8-bit H264, 1 for high-bit-depth H264
352     int chroma_qp[2];   // QPc
353
354     int qp_thresh;      ///< QP threshold to skip loopfilter
355
356     /* coded dimensions -- 16 * mb w/h */
357     int width, height;
358     ptrdiff_t linesize, uvlinesize;
359     int chroma_x_shift, chroma_y_shift;
360
361     int qscale;
362     int droppable;
363     int data_partitioning;
364     int coded_picture_number;
365     int low_delay;
366
367     int context_initialized;
368     int flags;
369     int workaround_bugs;
370
371     int prev_mb_skipped;
372     int next_mb_skipped;
373
374     // prediction stuff
375     int chroma_pred_mode;
376     int intra16x16_pred_mode;
377
378     int topleft_mb_xy;
379     int top_mb_xy;
380     int topright_mb_xy;
381     int left_mb_xy[LEFT_MBS];
382
383     int topleft_type;
384     int top_type;
385     int topright_type;
386     int left_type[LEFT_MBS];
387
388     const uint8_t *left_block;
389     int topleft_partition;
390
391     int8_t intra4x4_pred_mode_cache[5 * 8];
392     int8_t(*intra4x4_pred_mode);
393     H264PredContext hpc;
394     unsigned int topleft_samples_available;
395     unsigned int top_samples_available;
396     unsigned int topright_samples_available;
397     unsigned int left_samples_available;
398     uint8_t (*top_borders[2])[(16 * 3) * 2];
399
400     /**
401      * non zero coeff count cache.
402      * is 64 if not available.
403      */
404     DECLARE_ALIGNED(8, uint8_t, non_zero_count_cache)[15 * 8];
405
406     uint8_t (*non_zero_count)[48];
407
408     /**
409      * Motion vector cache.
410      */
411     DECLARE_ALIGNED(16, int16_t, mv_cache)[2][5 * 8][2];
412     DECLARE_ALIGNED(8, int8_t, ref_cache)[2][5 * 8];
413 #define LIST_NOT_USED -1 // FIXME rename?
414 #define PART_NOT_AVAILABLE -2
415
416     /**
417      * number of neighbors (top and/or left) that used 8x8 dct
418      */
419     int neighbor_transform_size;
420
421     /**
422      * block_offset[ 0..23] for frame macroblocks
423      * block_offset[24..47] for field macroblocks
424      */
425     int block_offset[2 * (16 * 3)];
426
427     uint32_t *mb2b_xy;  // FIXME are these 4 a good idea?
428     uint32_t *mb2br_xy;
429     int b_stride;       // FIXME use s->b4_stride
430
431     ptrdiff_t mb_linesize;  ///< may be equal to s->linesize or s->linesize * 2, for mbaff
432     ptrdiff_t mb_uvlinesize;
433
434     unsigned current_sps_id; ///< id of the current SPS
435     SPS sps; ///< current sps
436     PPS pps; ///< current pps
437
438     int au_pps_id; ///< pps_id of current access unit
439
440     uint32_t dequant4_buffer[6][QP_MAX_NUM + 1][16]; // FIXME should these be moved down?
441     uint32_t dequant8_buffer[6][QP_MAX_NUM + 1][64];
442     uint32_t(*dequant4_coeff[6])[16];
443     uint32_t(*dequant8_coeff[6])[64];
444
445     int slice_num;
446     uint16_t *slice_table;      ///< slice_table_base + 2*mb_stride + 1
447     int slice_type;
448     int slice_type_nos;         ///< S free slice type (SI/SP are remapped to I/P)
449     int slice_type_fixed;
450
451     // interlacing specific flags
452     int mb_aff_frame;
453     int mb_field_decoding_flag;
454     int mb_mbaff;               ///< mb_aff_frame && mb_field_decoding_flag
455     int picture_structure;
456     int first_field;
457
458     DECLARE_ALIGNED(8, uint16_t, sub_mb_type)[4];
459
460     // Weighted pred stuff
461     int use_weight;
462     int use_weight_chroma;
463     int luma_log2_weight_denom;
464     int chroma_log2_weight_denom;
465     // The following 2 can be changed to int8_t but that causes 10cpu cycles speedloss
466     int luma_weight[48][2][2];
467     int chroma_weight[48][2][2][2];
468     int implicit_weight[48][48][2];
469
470     int direct_spatial_mv_pred;
471     int col_parity;
472     int col_fieldoff;
473     int dist_scale_factor[32];
474     int dist_scale_factor_field[2][32];
475     int map_col_to_list0[2][16 + 32];
476     int map_col_to_list0_field[2][2][16 + 32];
477
478     /**
479      * num_ref_idx_l0/1_active_minus1 + 1
480      */
481     unsigned int ref_count[2];          ///< counts frames or fields, depending on current mb mode
482     unsigned int list_count;
483     uint8_t *list_counts;               ///< Array of list_count per MB specifying the slice type
484     H264Picture ref_list[2][48];        /**< 0..15: frame refs, 16..47: mbaff field refs.
485                                          *   Reordered version of default_ref_list
486                                          *   according to picture reordering in slice header */
487     int ref2frm[MAX_SLICES][2][64];     ///< reference to frame number lists, used in the loop filter, the first 2 are for -2,-1
488
489     // data partitioning
490     GetBitContext intra_gb;
491     GetBitContext inter_gb;
492     GetBitContext *intra_gb_ptr;
493     GetBitContext *inter_gb_ptr;
494
495     const uint8_t *intra_pcm_ptr;
496     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.
497     DECLARE_ALIGNED(16, int16_t, mb_luma_dc)[3][16 * 2];
498     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
499
500     /**
501      * Cabac
502      */
503     CABACContext cabac;
504     uint8_t cabac_state[1024];
505
506     /* 0x100 -> non null luma_dc, 0x80/0x40 -> non null chroma_dc (cb/cr), 0x?0 -> chroma_cbp(0, 1, 2), 0x0? luma_cbp */
507     uint16_t *cbp_table;
508     int cbp;
509     int top_cbp;
510     int left_cbp;
511     /* chroma_pred_mode for i4x4 or i16x16, else 0 */
512     uint8_t *chroma_pred_mode_table;
513     int last_qscale_diff;
514     uint8_t (*mvd_table[2])[2];
515     DECLARE_ALIGNED(16, uint8_t, mvd_cache)[2][5 * 8][2];
516     uint8_t *direct_table;
517     uint8_t direct_cache[5 * 8];
518
519     uint8_t zigzag_scan[16];
520     uint8_t zigzag_scan8x8[64];
521     uint8_t zigzag_scan8x8_cavlc[64];
522     uint8_t field_scan[16];
523     uint8_t field_scan8x8[64];
524     uint8_t field_scan8x8_cavlc[64];
525     uint8_t zigzag_scan_q0[16];
526     uint8_t zigzag_scan8x8_q0[64];
527     uint8_t zigzag_scan8x8_cavlc_q0[64];
528     uint8_t field_scan_q0[16];
529     uint8_t field_scan8x8_q0[64];
530     uint8_t field_scan8x8_cavlc_q0[64];
531
532     int x264_build;
533
534     int mb_x, mb_y;
535     int resync_mb_x;
536     int resync_mb_y;
537     int mb_skip_run;
538     int mb_height, mb_width;
539     int mb_stride;
540     int mb_num;
541     int mb_xy;
542
543     int is_complex;
544
545     // deblock
546     int deblocking_filter;          ///< disable_deblocking_filter_idc with 1 <-> 0
547     int slice_alpha_c0_offset;
548     int slice_beta_offset;
549
550     // =============================================================
551     // Things below are not used in the MB or more inner code
552
553     int nal_ref_idc;
554     int nal_unit_type;
555     uint8_t *rbsp_buffer[2];
556     unsigned int rbsp_buffer_size[2];
557
558     /**
559      * Used to parse AVC variant of h264
560      */
561     int is_avc;           ///< this flag is != 0 if codec is avc1
562     int nal_length_size;  ///< Number of bytes used for nal length (1, 2 or 4)
563     int got_first;        ///< this flag is != 0 if we've parsed a frame
564
565     int bit_depth_luma;         ///< luma bit depth from sps to detect changes
566     int chroma_format_idc;      ///< chroma format from sps to detect changes
567
568     SPS *sps_buffers[MAX_SPS_COUNT];
569     PPS *pps_buffers[MAX_PPS_COUNT];
570
571     int dequant_coeff_pps;      ///< reinit tables when pps changes
572
573     uint16_t *slice_table_base;
574
575     // POC stuff
576     int poc_lsb;
577     int poc_msb;
578     int delta_poc_bottom;
579     int delta_poc[2];
580     int frame_num;
581     int prev_poc_msb;           ///< poc_msb of the last reference pic for POC type 0
582     int prev_poc_lsb;           ///< poc_lsb of the last reference pic for POC type 0
583     int frame_num_offset;       ///< for POC type 2
584     int prev_frame_num_offset;  ///< for POC type 2
585     int prev_frame_num;         ///< frame_num of the last pic for POC type 1/2
586
587     /**
588      * frame_num for frames or 2 * frame_num + 1 for field pics.
589      */
590     int curr_pic_num;
591
592     /**
593      * max_frame_num or 2 * max_frame_num for field pics.
594      */
595     int max_pic_num;
596
597     int redundant_pic_count;
598
599     H264Picture default_ref_list[2][32]; ///< base reference list for all slices of a coded picture
600     H264Picture *short_ref[32];
601     H264Picture *long_ref[32];
602     H264Picture *delayed_pic[MAX_DELAYED_PIC_COUNT + 2]; // FIXME size?
603     int last_pocs[MAX_DELAYED_PIC_COUNT];
604     H264Picture *next_output_pic;
605     int outputed_poc;
606     int next_outputed_poc;
607
608     /**
609      * memory management control operations buffer.
610      */
611     MMCO mmco[MAX_MMCO_COUNT];
612     int mmco_index;
613     int mmco_reset;
614
615     int long_ref_count;     ///< number of actual long term references
616     int short_ref_count;    ///< number of actual short term references
617
618     int cabac_init_idc;
619
620     /**
621      * @name Members for slice based multithreading
622      * @{
623      */
624     struct H264Context *thread_context[H264_MAX_THREADS];
625
626     /**
627      * current slice number, used to initialize slice_num of each thread/context
628      */
629     int current_slice;
630
631     /**
632      * Max number of threads / contexts.
633      * This is equal to AVCodecContext.thread_count unless
634      * multithreaded decoding is impossible, in which case it is
635      * reduced to 1.
636      */
637     int max_contexts;
638
639     int slice_context_count;
640
641     /**
642      *  1 if the single thread fallback warning has already been
643      *  displayed, 0 otherwise.
644      */
645     int single_decode_warning;
646
647     enum AVPictureType pict_type;
648
649     int last_slice_type;
650     unsigned int last_ref_count[2];
651     /** @} */
652
653     /**
654      * pic_struct in picture timing SEI message
655      */
656     SEI_PicStructType sei_pic_struct;
657
658     /**
659      * Complement sei_pic_struct
660      * SEI_PIC_STRUCT_TOP_BOTTOM and SEI_PIC_STRUCT_BOTTOM_TOP indicate interlaced frames.
661      * However, soft telecined frames may have these values.
662      * This is used in an attempt to flag soft telecine progressive.
663      */
664     int prev_interlaced_frame;
665
666     /**
667      * frame_packing_arrangment SEI message
668      */
669     int sei_frame_packing_present;
670     int frame_packing_arrangement_type;
671     int content_interpretation_type;
672     int quincunx_subsampling;
673
674     /**
675      * Bit set of clock types for fields/frames in picture timing SEI message.
676      * For each found ct_type, appropriate bit is set (e.g., bit 1 for
677      * interlaced).
678      */
679     int sei_ct_type;
680
681     /**
682      * dpb_output_delay in picture timing SEI message, see H.264 C.2.2
683      */
684     int sei_dpb_output_delay;
685
686     /**
687      * cpb_removal_delay in picture timing SEI message, see H.264 C.1.2
688      */
689     int sei_cpb_removal_delay;
690
691     /**
692      * recovery_frame_cnt from SEI message
693      *
694      * Set to -1 if no recovery point SEI message found or to number of frames
695      * before playback synchronizes. Frames having recovery point are key
696      * frames.
697      */
698     int sei_recovery_frame_cnt;
699
700     /**
701      * Are the SEI recovery points looking valid.
702      */
703     int valid_recovery_point;
704
705     FPA sei_fpa;
706
707     /**
708      * recovery_frame is the frame_num at which the next frame should
709      * be fully constructed.
710      *
711      * Set to -1 when not expecting a recovery point.
712      */
713     int recovery_frame;
714
715 /**
716  * We have seen an IDR, so all the following frames in coded order are correctly
717  * decodable.
718  */
719 #define FRAME_RECOVERED_IDR  (1 << 0)
720 /**
721  * Sufficient number of frames have been decoded since a SEI recovery point,
722  * so all the following frames in presentation order are correct.
723  */
724 #define FRAME_RECOVERED_SEI  (1 << 1)
725
726     int frame_recovered;    ///< Initial frame has been completely recovered
727
728     int luma_weight_flag[2];    ///< 7.4.3.2 luma_weight_lX_flag
729     int chroma_weight_flag[2];  ///< 7.4.3.2 chroma_weight_lX_flag
730
731     // Timestamp stuff
732     int sei_buffering_period_present;   ///< Buffering period SEI flag
733     int initial_cpb_removal_delay[32];  ///< Initial timestamps for CPBs
734
735     int cur_chroma_format_idc;
736     uint8_t *bipred_scratchpad;
737
738     int16_t slice_row[MAX_SLICES]; ///< to detect when MAX_SLICES is too low
739
740     uint8_t parse_history[4];
741     int parse_history_count;
742     int parse_last_mb;
743     uint8_t *edge_emu_buffer;
744     int16_t *dc_val_base;
745
746     AVBufferPool *qscale_table_pool;
747     AVBufferPool *mb_type_pool;
748     AVBufferPool *motion_val_pool;
749     AVBufferPool *ref_index_pool;
750
751     /* Motion Estimation */
752     qpel_mc_func (*qpel_put)[16];
753     qpel_mc_func (*qpel_avg)[16];
754 } H264Context;
755
756 extern const uint8_t ff_h264_chroma_qp[7][QP_MAX_NUM + 1]; ///< One chroma qp table for each possible bit depth (8-14).
757 extern const uint16_t ff_h264_mb_sizes[4];
758
759 /**
760  * Decode SEI
761  */
762 int ff_h264_decode_sei(H264Context *h);
763
764 /**
765  * Decode SPS
766  */
767 int ff_h264_decode_seq_parameter_set(H264Context *h);
768
769 /**
770  * compute profile from sps
771  */
772 int ff_h264_get_profile(SPS *sps);
773
774 /**
775  * Decode PPS
776  */
777 int ff_h264_decode_picture_parameter_set(H264Context *h, int bit_length);
778
779 /**
780  * Decode a network abstraction layer unit.
781  * @param consumed is the number of bytes used as input
782  * @param length is the length of the array
783  * @param dst_length is the number of decoded bytes FIXME here
784  *                   or a decode rbsp tailing?
785  * @return decoded bytes, might be src+1 if no escapes
786  */
787 const uint8_t *ff_h264_decode_nal(H264Context *h, const uint8_t *src,
788                                   int *dst_length, int *consumed, int length);
789
790 /**
791  * Free any data that may have been allocated in the H264 context
792  * like SPS, PPS etc.
793  */
794 void ff_h264_free_context(H264Context *h);
795
796 /**
797  * Reconstruct bitstream slice_type.
798  */
799 int ff_h264_get_slice_type(const H264Context *h);
800
801 /**
802  * Allocate tables.
803  * needs width/height
804  */
805 int ff_h264_alloc_tables(H264Context *h);
806
807 /**
808  * Fill the default_ref_list.
809  */
810 int ff_h264_fill_default_ref_list(H264Context *h);
811
812 int ff_h264_decode_ref_pic_list_reordering(H264Context *h);
813 void ff_h264_fill_mbaff_ref_list(H264Context *h);
814 void ff_h264_remove_all_refs(H264Context *h);
815
816 /**
817  * Execute the reference picture marking (memory management control operations).
818  */
819 int ff_h264_execute_ref_pic_marking(H264Context *h, MMCO *mmco, int mmco_count);
820
821 int ff_h264_decode_ref_pic_marking(H264Context *h, GetBitContext *gb,
822                                    int first_slice);
823
824 int ff_generate_sliding_window_mmcos(H264Context *h, int first_slice);
825
826 /**
827  * Check if the top & left blocks are available if needed & change the
828  * dc mode so it only uses the available blocks.
829  */
830 int ff_h264_check_intra4x4_pred_mode(H264Context *h);
831
832 /**
833  * Check if the top & left blocks are available if needed & change the
834  * dc mode so it only uses the available blocks.
835  */
836 int ff_h264_check_intra_pred_mode(H264Context *h, int mode, int is_chroma);
837
838 void ff_h264_hl_decode_mb(H264Context *h);
839 int ff_h264_decode_extradata(H264Context *h, const uint8_t *buf, int size);
840 int ff_h264_decode_init(AVCodecContext *avctx);
841 void ff_h264_decode_init_vlc(void);
842
843 /**
844  * Decode a macroblock
845  * @return 0 if OK, ER_AC_ERROR / ER_DC_ERROR / ER_MV_ERROR on error
846  */
847 int ff_h264_decode_mb_cavlc(H264Context *h);
848
849 /**
850  * Decode a CABAC coded macroblock
851  * @return 0 if OK, ER_AC_ERROR / ER_DC_ERROR / ER_MV_ERROR on error
852  */
853 int ff_h264_decode_mb_cabac(H264Context *h);
854
855 void ff_h264_init_cabac_states(H264Context *h);
856
857 void h264_init_dequant_tables(H264Context *h);
858
859 void ff_h264_direct_dist_scale_factor(H264Context *const h);
860 void ff_h264_direct_ref_list_init(H264Context *const h);
861 void ff_h264_pred_direct_motion(H264Context *const h, int *mb_type);
862
863 void ff_h264_filter_mb_fast(H264Context *h, int mb_x, int mb_y,
864                             uint8_t *img_y, uint8_t *img_cb, uint8_t *img_cr,
865                             unsigned int linesize, unsigned int uvlinesize);
866 void ff_h264_filter_mb(H264Context *h, int mb_x, int mb_y,
867                        uint8_t *img_y, uint8_t *img_cb, uint8_t *img_cr,
868                        unsigned int linesize, unsigned int uvlinesize);
869
870 /**
871  * Reset SEI values at the beginning of the frame.
872  *
873  * @param h H.264 context.
874  */
875 void ff_h264_reset_sei(H264Context *h);
876
877 /**
878  * Get stereo_mode string from the h264 frame_packing_arrangement
879  * @param h H.264 context.
880  */
881 const char* ff_h264_sei_stereo_mode(H264Context *h);
882
883 /*
884  * o-o o-o
885  *  / / /
886  * o-o o-o
887  *  ,---'
888  * o-o o-o
889  *  / / /
890  * o-o o-o
891  */
892
893 /* Scan8 organization:
894  *    0 1 2 3 4 5 6 7
895  * 0  DY    y y y y y
896  * 1        y Y Y Y Y
897  * 2        y Y Y Y Y
898  * 3        y Y Y Y Y
899  * 4        y Y Y Y Y
900  * 5  DU    u u u u u
901  * 6        u U U U U
902  * 7        u U U U U
903  * 8        u U U U U
904  * 9        u U U U U
905  * 10 DV    v v v v v
906  * 11       v V V V V
907  * 12       v V V V V
908  * 13       v V V V V
909  * 14       v V V V V
910  * DY/DU/DV are for luma/chroma DC.
911  */
912
913 #define LUMA_DC_BLOCK_INDEX   48
914 #define CHROMA_DC_BLOCK_INDEX 49
915
916 // This table must be here because scan8[constant] must be known at compiletime
917 static const uint8_t scan8[16 * 3 + 3] = {
918     4 +  1 * 8, 5 +  1 * 8, 4 +  2 * 8, 5 +  2 * 8,
919     6 +  1 * 8, 7 +  1 * 8, 6 +  2 * 8, 7 +  2 * 8,
920     4 +  3 * 8, 5 +  3 * 8, 4 +  4 * 8, 5 +  4 * 8,
921     6 +  3 * 8, 7 +  3 * 8, 6 +  4 * 8, 7 +  4 * 8,
922     4 +  6 * 8, 5 +  6 * 8, 4 +  7 * 8, 5 +  7 * 8,
923     6 +  6 * 8, 7 +  6 * 8, 6 +  7 * 8, 7 +  7 * 8,
924     4 +  8 * 8, 5 +  8 * 8, 4 +  9 * 8, 5 +  9 * 8,
925     6 +  8 * 8, 7 +  8 * 8, 6 +  9 * 8, 7 +  9 * 8,
926     4 + 11 * 8, 5 + 11 * 8, 4 + 12 * 8, 5 + 12 * 8,
927     6 + 11 * 8, 7 + 11 * 8, 6 + 12 * 8, 7 + 12 * 8,
928     4 + 13 * 8, 5 + 13 * 8, 4 + 14 * 8, 5 + 14 * 8,
929     6 + 13 * 8, 7 + 13 * 8, 6 + 14 * 8, 7 + 14 * 8,
930     0 +  0 * 8, 0 +  5 * 8, 0 + 10 * 8
931 };
932
933 static av_always_inline uint32_t pack16to32(int a, int b)
934 {
935 #if HAVE_BIGENDIAN
936     return (b & 0xFFFF) + (a << 16);
937 #else
938     return (a & 0xFFFF) + (b << 16);
939 #endif
940 }
941
942 static av_always_inline uint16_t pack8to16(int a, int b)
943 {
944 #if HAVE_BIGENDIAN
945     return (b & 0xFF) + (a << 8);
946 #else
947     return (a & 0xFF) + (b << 8);
948 #endif
949 }
950
951 /**
952  * Get the chroma qp.
953  */
954 static av_always_inline int get_chroma_qp(H264Context *h, int t, int qscale)
955 {
956     return h->pps.chroma_qp_table[t][qscale];
957 }
958
959 /**
960  * Get the predicted intra4x4 prediction mode.
961  */
962 static av_always_inline int pred_intra_mode(H264Context *h, int n)
963 {
964     const int index8 = scan8[n];
965     const int left   = h->intra4x4_pred_mode_cache[index8 - 1];
966     const int top    = h->intra4x4_pred_mode_cache[index8 - 8];
967     const int min    = FFMIN(left, top);
968
969     tprintf(h->avctx, "mode:%d %d min:%d\n", left, top, min);
970
971     if (min < 0)
972         return DC_PRED;
973     else
974         return min;
975 }
976
977 static av_always_inline void write_back_intra_pred_mode(H264Context *h)
978 {
979     int8_t *i4x4       = h->intra4x4_pred_mode + h->mb2br_xy[h->mb_xy];
980     int8_t *i4x4_cache = h->intra4x4_pred_mode_cache;
981
982     AV_COPY32(i4x4, i4x4_cache + 4 + 8 * 4);
983     i4x4[4] = i4x4_cache[7 + 8 * 3];
984     i4x4[5] = i4x4_cache[7 + 8 * 2];
985     i4x4[6] = i4x4_cache[7 + 8 * 1];
986 }
987
988 static av_always_inline void write_back_non_zero_count(H264Context *h)
989 {
990     const int mb_xy    = h->mb_xy;
991     uint8_t *nnz       = h->non_zero_count[mb_xy];
992     uint8_t *nnz_cache = h->non_zero_count_cache;
993
994     AV_COPY32(&nnz[ 0], &nnz_cache[4 + 8 * 1]);
995     AV_COPY32(&nnz[ 4], &nnz_cache[4 + 8 * 2]);
996     AV_COPY32(&nnz[ 8], &nnz_cache[4 + 8 * 3]);
997     AV_COPY32(&nnz[12], &nnz_cache[4 + 8 * 4]);
998     AV_COPY32(&nnz[16], &nnz_cache[4 + 8 * 6]);
999     AV_COPY32(&nnz[20], &nnz_cache[4 + 8 * 7]);
1000     AV_COPY32(&nnz[32], &nnz_cache[4 + 8 * 11]);
1001     AV_COPY32(&nnz[36], &nnz_cache[4 + 8 * 12]);
1002
1003     if (!h->chroma_y_shift) {
1004         AV_COPY32(&nnz[24], &nnz_cache[4 + 8 * 8]);
1005         AV_COPY32(&nnz[28], &nnz_cache[4 + 8 * 9]);
1006         AV_COPY32(&nnz[40], &nnz_cache[4 + 8 * 13]);
1007         AV_COPY32(&nnz[44], &nnz_cache[4 + 8 * 14]);
1008     }
1009 }
1010
1011 static av_always_inline void write_back_motion_list(H264Context *h,
1012                                                     int b_stride,
1013                                                     int b_xy, int b8_xy,
1014                                                     int mb_type, int list)
1015 {
1016     int16_t(*mv_dst)[2] = &h->cur_pic.motion_val[list][b_xy];
1017     int16_t(*mv_src)[2] = &h->mv_cache[list][scan8[0]];
1018     AV_COPY128(mv_dst + 0 * b_stride, mv_src + 8 * 0);
1019     AV_COPY128(mv_dst + 1 * b_stride, mv_src + 8 * 1);
1020     AV_COPY128(mv_dst + 2 * b_stride, mv_src + 8 * 2);
1021     AV_COPY128(mv_dst + 3 * b_stride, mv_src + 8 * 3);
1022     if (CABAC(h)) {
1023         uint8_t (*mvd_dst)[2] = &h->mvd_table[list][FMO ? 8 * h->mb_xy
1024                                                         : h->mb2br_xy[h->mb_xy]];
1025         uint8_t(*mvd_src)[2]  = &h->mvd_cache[list][scan8[0]];
1026         if (IS_SKIP(mb_type)) {
1027             AV_ZERO128(mvd_dst);
1028         } else {
1029             AV_COPY64(mvd_dst, mvd_src + 8 * 3);
1030             AV_COPY16(mvd_dst + 3 + 3, mvd_src + 3 + 8 * 0);
1031             AV_COPY16(mvd_dst + 3 + 2, mvd_src + 3 + 8 * 1);
1032             AV_COPY16(mvd_dst + 3 + 1, mvd_src + 3 + 8 * 2);
1033         }
1034     }
1035
1036     {
1037         int8_t *ref_index = &h->cur_pic.ref_index[list][b8_xy];
1038         int8_t *ref_cache = h->ref_cache[list];
1039         ref_index[0 + 0 * 2] = ref_cache[scan8[0]];
1040         ref_index[1 + 0 * 2] = ref_cache[scan8[4]];
1041         ref_index[0 + 1 * 2] = ref_cache[scan8[8]];
1042         ref_index[1 + 1 * 2] = ref_cache[scan8[12]];
1043     }
1044 }
1045
1046 static av_always_inline void write_back_motion(H264Context *h, int mb_type)
1047 {
1048     const int b_stride      = h->b_stride;
1049     const int b_xy  = 4 * h->mb_x + 4 * h->mb_y * h->b_stride; // try mb2b(8)_xy
1050     const int b8_xy = 4 * h->mb_xy;
1051
1052     if (USES_LIST(mb_type, 0)) {
1053         write_back_motion_list(h, b_stride, b_xy, b8_xy, mb_type, 0);
1054     } else {
1055         fill_rectangle(&h->cur_pic.ref_index[0][b8_xy],
1056                        2, 2, 2, (uint8_t)LIST_NOT_USED, 1);
1057     }
1058     if (USES_LIST(mb_type, 1))
1059         write_back_motion_list(h, b_stride, b_xy, b8_xy, mb_type, 1);
1060
1061     if (h->slice_type_nos == AV_PICTURE_TYPE_B && CABAC(h)) {
1062         if (IS_8X8(mb_type)) {
1063             uint8_t *direct_table = &h->direct_table[4 * h->mb_xy];
1064             direct_table[1] = h->sub_mb_type[1] >> 1;
1065             direct_table[2] = h->sub_mb_type[2] >> 1;
1066             direct_table[3] = h->sub_mb_type[3] >> 1;
1067         }
1068     }
1069 }
1070
1071 static av_always_inline int get_dct8x8_allowed(H264Context *h)
1072 {
1073     if (h->sps.direct_8x8_inference_flag)
1074         return !(AV_RN64A(h->sub_mb_type) &
1075                  ((MB_TYPE_16x8 | MB_TYPE_8x16 | MB_TYPE_8x8) *
1076                   0x0001000100010001ULL));
1077     else
1078         return !(AV_RN64A(h->sub_mb_type) &
1079                  ((MB_TYPE_16x8 | MB_TYPE_8x16 | MB_TYPE_8x8 | MB_TYPE_DIRECT2) *
1080                   0x0001000100010001ULL));
1081 }
1082
1083 int ff_h264_field_end(H264Context *h, int in_setup);
1084
1085 int ff_h264_ref_picture(H264Context *h, H264Picture *dst, H264Picture *src);
1086 void ff_h264_unref_picture(H264Context *h, H264Picture *pic);
1087
1088 int ff_h264_context_init(H264Context *h);
1089 int ff_h264_set_parameter_from_sps(H264Context *h);
1090
1091 void ff_h264_draw_horiz_band(H264Context *h, int y, int height);
1092 int ff_init_poc(H264Context *h, int pic_field_poc[2], int *pic_poc);
1093 int ff_pred_weight_table(H264Context *h);
1094 int ff_set_ref_count(H264Context *h);
1095
1096 int ff_h264_decode_slice_header(H264Context *h, H264Context *h0);
1097 int ff_h264_execute_decode_slices(H264Context *h, unsigned context_count);
1098 int ff_h264_update_thread_context(AVCodecContext *dst,
1099                                   const AVCodecContext *src);
1100
1101 void ff_h264_flush_change(H264Context *h);
1102
1103 void ff_h264_free_tables(H264Context *h, int free_rbsp);
1104
1105 void ff_h264_set_erpic(ERPicture *dst, H264Picture *src);
1106
1107 #endif /* AVCODEC_H264_H */