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