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