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