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