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