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