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