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