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