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