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