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