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