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