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