Parse dpb_output_delay in SEI picture structure.
[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 libavcodec/h264.h
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 "dsputil.h"
32 #include "cabac.h"
33 #include "mpegvideo.h"
34 #include "h264pred.h"
35
36 #define interlaced_dct interlaced_dct_is_a_bad_name
37 #define mb_intra mb_intra_is_not_initialized_see_mb_type
38
39 #define LUMA_DC_BLOCK_INDEX   25
40 #define CHROMA_DC_BLOCK_INDEX 26
41
42 #define CHROMA_DC_COEFF_TOKEN_VLC_BITS 8
43 #define COEFF_TOKEN_VLC_BITS           8
44 #define TOTAL_ZEROS_VLC_BITS           9
45 #define CHROMA_DC_TOTAL_ZEROS_VLC_BITS 3
46 #define RUN_VLC_BITS                   3
47 #define RUN7_VLC_BITS                  6
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 /* Compiling in interlaced support reduces the speed
57  * of progressive decoding by about 2%. */
58 #define ALLOW_INTERLACE
59
60 #define ALLOW_NOCHROMA
61
62 /**
63  * The maximum number of slices supported by the decoder.
64  * must be a power of 2
65  */
66 #define MAX_SLICES 16
67
68 #ifdef ALLOW_INTERLACE
69 #define MB_MBAFF h->mb_mbaff
70 #define MB_FIELD h->mb_field_decoding_flag
71 #define FRAME_MBAFF h->mb_aff_frame
72 #define FIELD_PICTURE (s->picture_structure != PICT_FRAME)
73 #else
74 #define MB_MBAFF 0
75 #define MB_FIELD 0
76 #define FRAME_MBAFF 0
77 #define FIELD_PICTURE 0
78 #undef  IS_INTERLACED
79 #define IS_INTERLACED(mb_type) 0
80 #endif
81 #define FIELD_OR_MBAFF_PICTURE (FRAME_MBAFF || FIELD_PICTURE)
82
83 #ifdef ALLOW_NOCHROMA
84 #define CHROMA h->sps.chroma_format_idc
85 #else
86 #define CHROMA 1
87 #endif
88
89 #define EXTENDED_SAR          255
90
91 #define MB_TYPE_REF0       MB_TYPE_ACPRED //dirty but it fits in 16 bit
92 #define MB_TYPE_8x8DCT     0x01000000
93 #define IS_REF0(a)         ((a) & MB_TYPE_REF0)
94 #define IS_8x8DCT(a)       ((a) & MB_TYPE_8x8DCT)
95
96 /* NAL unit types */
97 enum {
98     NAL_SLICE=1,
99     NAL_DPA,
100     NAL_DPB,
101     NAL_DPC,
102     NAL_IDR_SLICE,
103     NAL_SEI,
104     NAL_SPS,
105     NAL_PPS,
106     NAL_AUD,
107     NAL_END_SEQUENCE,
108     NAL_END_STREAM,
109     NAL_FILLER_DATA,
110     NAL_SPS_EXT,
111     NAL_AUXILIARY_SLICE=19
112 };
113
114 /**
115  * SEI message types
116  */
117 typedef enum {
118     SEI_TYPE_PIC_TIMING              =  1, ///< picture timing
119     SEI_TYPE_USER_DATA_UNREGISTERED  =  5, ///< unregistered user data
120     SEI_TYPE_RECOVERY_POINT          =  6  ///< recovery point (frame # to decoder sync)
121 } SEI_Type;
122
123 /**
124  * pic_struct in picture timing SEI message
125  */
126 typedef enum {
127     SEI_PIC_STRUCT_FRAME             = 0, ///<  0: %frame
128     SEI_PIC_STRUCT_TOP_FIELD         = 1, ///<  1: top field
129     SEI_PIC_STRUCT_BOTTOM_FIELD      = 2, ///<  2: bottom field
130     SEI_PIC_STRUCT_TOP_BOTTOM        = 3, ///<  3: top field, bottom field, in that order
131     SEI_PIC_STRUCT_BOTTOM_TOP        = 4, ///<  4: bottom field, top field, in that order
132     SEI_PIC_STRUCT_TOP_BOTTOM_TOP    = 5, ///<  5: top field, bottom field, top field repeated, in that order
133     SEI_PIC_STRUCT_BOTTOM_TOP_BOTTOM = 6, ///<  6: bottom field, top field, bottom field repeated, in that order
134     SEI_PIC_STRUCT_FRAME_DOUBLING    = 7, ///<  7: %frame doubling
135     SEI_PIC_STRUCT_FRAME_TRIPLING    = 8  ///<  8: %frame tripling
136 } SEI_PicStructType;
137
138 /**
139  * Sequence parameter set
140  */
141 typedef struct SPS{
142
143     int profile_idc;
144     int level_idc;
145     int chroma_format_idc;
146     int transform_bypass;              ///< qpprime_y_zero_transform_bypass_flag
147     int log2_max_frame_num;            ///< log2_max_frame_num_minus4 + 4
148     int poc_type;                      ///< pic_order_cnt_type
149     int log2_max_poc_lsb;              ///< log2_max_pic_order_cnt_lsb_minus4
150     int delta_pic_order_always_zero_flag;
151     int offset_for_non_ref_pic;
152     int offset_for_top_to_bottom_field;
153     int poc_cycle_length;              ///< num_ref_frames_in_pic_order_cnt_cycle
154     int ref_frame_count;               ///< num_ref_frames
155     int gaps_in_frame_num_allowed_flag;
156     int mb_width;                      ///< pic_width_in_mbs_minus1 + 1
157     int mb_height;                     ///< pic_height_in_map_units_minus1 + 1
158     int frame_mbs_only_flag;
159     int mb_aff;                        ///<mb_adaptive_frame_field_flag
160     int direct_8x8_inference_flag;
161     int crop;                   ///< frame_cropping_flag
162     unsigned int crop_left;            ///< frame_cropping_rect_left_offset
163     unsigned int crop_right;           ///< frame_cropping_rect_right_offset
164     unsigned int crop_top;             ///< frame_cropping_rect_top_offset
165     unsigned int crop_bottom;          ///< frame_cropping_rect_bottom_offset
166     int vui_parameters_present_flag;
167     AVRational sar;
168     int timing_info_present_flag;
169     uint32_t num_units_in_tick;
170     uint32_t time_scale;
171     int fixed_frame_rate_flag;
172     short offset_for_ref_frame[256]; //FIXME dyn aloc?
173     int bitstream_restriction_flag;
174     int num_reorder_frames;
175     int scaling_matrix_present;
176     uint8_t scaling_matrix4[6][16];
177     uint8_t scaling_matrix8[2][64];
178     int nal_hrd_parameters_present_flag;
179     int vcl_hrd_parameters_present_flag;
180     int pic_struct_present_flag;
181     int time_offset_length;
182     int initial_cpb_removal_delay_length; ///< initial_cpb_removal_delay_length_minus1 +1
183     int cpb_removal_delay_length;      ///< cpb_removal_delay_length_minus1 + 1
184     int dpb_output_delay_length;       ///< dpb_output_delay_length_minus1 + 1
185     int bit_depth_luma;                ///< bit_depth_luma_minus8 + 8
186     int bit_depth_chroma;              ///< bit_depth_chroma_minus8 + 8
187     int residual_color_transform_flag; ///< residual_colour_transform_flag
188 }SPS;
189
190 /**
191  * Picture parameter set
192  */
193 typedef struct PPS{
194     unsigned int sps_id;
195     int cabac;                  ///< entropy_coding_mode_flag
196     int pic_order_present;      ///< pic_order_present_flag
197     int slice_group_count;      ///< num_slice_groups_minus1 + 1
198     int mb_slice_group_map_type;
199     unsigned int ref_count[2];  ///< num_ref_idx_l0/1_active_minus1 + 1
200     int weighted_pred;          ///< weighted_pred_flag
201     int weighted_bipred_idc;
202     int init_qp;                ///< pic_init_qp_minus26 + 26
203     int init_qs;                ///< pic_init_qs_minus26 + 26
204     int chroma_qp_index_offset[2];
205     int deblocking_filter_parameters_present; ///< deblocking_filter_parameters_present_flag
206     int constrained_intra_pred; ///< constrained_intra_pred_flag
207     int redundant_pic_cnt_present; ///< redundant_pic_cnt_present_flag
208     int transform_8x8_mode;     ///< transform_8x8_mode_flag
209     uint8_t scaling_matrix4[6][16];
210     uint8_t scaling_matrix8[2][64];
211     uint8_t chroma_qp_table[2][64];  ///< pre-scaled (with chroma_qp_index_offset) version of qp_table
212     int chroma_qp_diff;
213 }PPS;
214
215 /**
216  * Memory management control operation opcode.
217  */
218 typedef enum MMCOOpcode{
219     MMCO_END=0,
220     MMCO_SHORT2UNUSED,
221     MMCO_LONG2UNUSED,
222     MMCO_SHORT2LONG,
223     MMCO_SET_MAX_LONG,
224     MMCO_RESET,
225     MMCO_LONG,
226 } MMCOOpcode;
227
228 /**
229  * Memory management control operation.
230  */
231 typedef struct MMCO{
232     MMCOOpcode opcode;
233     int short_pic_num;  ///< pic_num without wrapping (pic_num & max_pic_num)
234     int long_arg;       ///< index, pic_num, or num long refs depending on opcode
235 } MMCO;
236
237 /**
238  * H264Context
239  */
240 typedef struct H264Context{
241     MpegEncContext s;
242     int nal_ref_idc;
243     int nal_unit_type;
244     uint8_t *rbsp_buffer[2];
245     unsigned int rbsp_buffer_size[2];
246
247     /**
248       * Used to parse AVC variant of h264
249       */
250     int is_avc; ///< this flag is != 0 if codec is avc1
251     int got_avcC; ///< flag used to parse avcC data only once
252     int nal_length_size; ///< Number of bytes used for nal length (1, 2 or 4)
253
254     int chroma_qp[2]; //QPc
255
256     int prev_mb_skipped;
257     int next_mb_skipped;
258
259     //prediction stuff
260     int chroma_pred_mode;
261     int intra16x16_pred_mode;
262
263     int top_mb_xy;
264     int left_mb_xy[2];
265
266     int8_t intra4x4_pred_mode_cache[5*8];
267     int8_t (*intra4x4_pred_mode)[8];
268     H264PredContext hpc;
269     unsigned int topleft_samples_available;
270     unsigned int top_samples_available;
271     unsigned int topright_samples_available;
272     unsigned int left_samples_available;
273     uint8_t (*top_borders[2])[16+2*8];
274     uint8_t left_border[2*(17+2*9)];
275
276     /**
277      * non zero coeff count cache.
278      * is 64 if not available.
279      */
280     DECLARE_ALIGNED_8(uint8_t, non_zero_count_cache[6*8]);
281     uint8_t (*non_zero_count)[16];
282
283     /**
284      * Motion vector cache.
285      */
286     DECLARE_ALIGNED_8(int16_t, mv_cache[2][5*8][2]);
287     DECLARE_ALIGNED_8(int8_t, ref_cache[2][5*8]);
288 #define LIST_NOT_USED -1 //FIXME rename?
289 #define PART_NOT_AVAILABLE -2
290
291     /**
292      * is 1 if the specific list MV&references are set to 0,0,-2.
293      */
294     int mv_cache_clean[2];
295
296     /**
297      * number of neighbors (top and/or left) that used 8x8 dct
298      */
299     int neighbor_transform_size;
300
301     /**
302      * block_offset[ 0..23] for frame macroblocks
303      * block_offset[24..47] for field macroblocks
304      */
305     int block_offset[2*(16+8)];
306
307     uint32_t *mb2b_xy; //FIXME are these 4 a good idea?
308     uint32_t *mb2b8_xy;
309     int b_stride; //FIXME use s->b4_stride
310     int b8_stride;
311
312     int mb_linesize;   ///< may be equal to s->linesize or s->linesize*2, for mbaff
313     int mb_uvlinesize;
314
315     int emu_edge_width;
316     int emu_edge_height;
317
318     int halfpel_flag;
319     int thirdpel_flag;
320
321     int unknown_svq3_flag;
322     int next_slice_index;
323
324     SPS *sps_buffers[MAX_SPS_COUNT];
325     SPS sps; ///< current sps
326
327     PPS *pps_buffers[MAX_PPS_COUNT];
328     /**
329      * current pps
330      */
331     PPS pps; //FIXME move to Picture perhaps? (->no) do we need that?
332
333     uint32_t dequant4_buffer[6][52][16];
334     uint32_t dequant8_buffer[2][52][64];
335     uint32_t (*dequant4_coeff[6])[16];
336     uint32_t (*dequant8_coeff[2])[64];
337     int dequant_coeff_pps;     ///< reinit tables when pps changes
338
339     int slice_num;
340     uint16_t *slice_table_base;
341     uint16_t *slice_table;     ///< slice_table_base + 2*mb_stride + 1
342     int slice_type;
343     int slice_type_nos;        ///< S free slice type (SI/SP are remapped to I/P)
344     int slice_type_fixed;
345
346     //interlacing specific flags
347     int mb_aff_frame;
348     int mb_field_decoding_flag;
349     int mb_mbaff;              ///< mb_aff_frame && mb_field_decoding_flag
350
351     uint16_t sub_mb_type[4];
352
353     //POC stuff
354     int poc_lsb;
355     int poc_msb;
356     int delta_poc_bottom;
357     int delta_poc[2];
358     int frame_num;
359     int prev_poc_msb;             ///< poc_msb of the last reference pic for POC type 0
360     int prev_poc_lsb;             ///< poc_lsb of the last reference pic for POC type 0
361     int frame_num_offset;         ///< for POC type 2
362     int prev_frame_num_offset;    ///< for POC type 2
363     int prev_frame_num;           ///< frame_num of the last pic for POC type 1/2
364
365     /**
366      * frame_num for frames or 2*frame_num+1 for field pics.
367      */
368     int curr_pic_num;
369
370     /**
371      * max_frame_num or 2*max_frame_num for field pics.
372      */
373     int max_pic_num;
374
375     //Weighted pred stuff
376     int use_weight;
377     int use_weight_chroma;
378     int luma_log2_weight_denom;
379     int chroma_log2_weight_denom;
380     int luma_weight[2][48];
381     int luma_offset[2][48];
382     int chroma_weight[2][48][2];
383     int chroma_offset[2][48][2];
384     int implicit_weight[48][48];
385
386     //deblock
387     int deblocking_filter;         ///< disable_deblocking_filter_idc with 1<->0
388     int slice_alpha_c0_offset;
389     int slice_beta_offset;
390
391     int redundant_pic_count;
392
393     int direct_spatial_mv_pred;
394     int dist_scale_factor[16];
395     int dist_scale_factor_field[2][32];
396     int map_col_to_list0[2][16+32];
397     int map_col_to_list0_field[2][2][16+32];
398
399     /**
400      * num_ref_idx_l0/1_active_minus1 + 1
401      */
402     unsigned int ref_count[2];   ///< counts frames or fields, depending on current mb mode
403     unsigned int list_count;
404     Picture *short_ref[32];
405     Picture *long_ref[32];
406     Picture default_ref_list[2][32]; ///< base reference list for all slices of a coded picture
407     Picture 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     Picture *delayed_pic[MAX_DELAYED_PIC_COUNT+2]; //FIXME size?
412     int outputed_poc;
413
414     /**
415      * memory management control operations buffer.
416      */
417     MMCO mmco[MAX_MMCO_COUNT];
418     int mmco_index;
419
420     int long_ref_count;  ///< number of actual long term references
421     int short_ref_count; ///< number of actual short term references
422
423     //data partitioning
424     GetBitContext intra_gb;
425     GetBitContext inter_gb;
426     GetBitContext *intra_gb_ptr;
427     GetBitContext *inter_gb_ptr;
428
429     DECLARE_ALIGNED_16(DCTELEM, mb[16*24]);
430     DCTELEM mb_padding[256];        ///< as mb is addressed by scantable[i] and scantable is uint8_t we can either check that i is not too large or ensure that there is some unused stuff after mb
431
432     /**
433      * Cabac
434      */
435     CABACContext cabac;
436     uint8_t      cabac_state[460];
437     int          cabac_init_idc;
438
439     /* 0x100 -> non null luma_dc, 0x80/0x40 -> non null chroma_dc (cb/cr), 0x?0 -> chroma_cbp(0,1,2), 0x0? luma_cbp */
440     uint16_t     *cbp_table;
441     int cbp;
442     int top_cbp;
443     int left_cbp;
444     /* chroma_pred_mode for i4x4 or i16x16, else 0 */
445     uint8_t     *chroma_pred_mode_table;
446     int         last_qscale_diff;
447     int16_t     (*mvd_table[2])[2];
448     DECLARE_ALIGNED_8(int16_t, mvd_cache[2][5*8][2]);
449     uint8_t     *direct_table;
450     uint8_t     direct_cache[5*8];
451
452     uint8_t zigzag_scan[16];
453     uint8_t zigzag_scan8x8[64];
454     uint8_t zigzag_scan8x8_cavlc[64];
455     uint8_t field_scan[16];
456     uint8_t field_scan8x8[64];
457     uint8_t field_scan8x8_cavlc[64];
458     const uint8_t *zigzag_scan_q0;
459     const uint8_t *zigzag_scan8x8_q0;
460     const uint8_t *zigzag_scan8x8_cavlc_q0;
461     const uint8_t *field_scan_q0;
462     const uint8_t *field_scan8x8_q0;
463     const uint8_t *field_scan8x8_cavlc_q0;
464
465     int x264_build;
466
467     /**
468      * @defgroup multithreading Members for slice based multithreading
469      * @{
470      */
471     struct H264Context *thread_context[MAX_THREADS];
472
473     /**
474      * current slice number, used to initalize slice_num of each thread/context
475      */
476     int current_slice;
477
478     /**
479      * Max number of threads / contexts.
480      * This is equal to AVCodecContext.thread_count unless
481      * multithreaded decoding is impossible, in which case it is
482      * reduced to 1.
483      */
484     int max_contexts;
485
486     /**
487      *  1 if the single thread fallback warning has already been
488      *  displayed, 0 otherwise.
489      */
490     int single_decode_warning;
491
492     int last_slice_type;
493     /** @} */
494
495     int mb_xy;
496
497     uint32_t svq3_watermark_key;
498
499     /**
500      * pic_struct in picture timing SEI message
501      */
502     SEI_PicStructType sei_pic_struct;
503
504     /**
505      * dpb_output_delay in picture timing SEI message, see H.264 C.2.2
506      */
507     int sei_dpb_output_delay;
508
509     /**
510      * recovery_frame_cnt from SEI message
511      *
512      * Set to -1 if no recovery point SEI message found or to number of frames
513      * before playback synchronizes. Frames having recovery point are key
514      * frames.
515      */
516     int sei_recovery_frame_cnt;
517
518     int is_complex;
519
520     int luma_weight_flag[2];   ///< 7.4.3.2 luma_weight_lX_flag
521     int chroma_weight_flag[2]; ///< 7.4.3.2 chroma_weight_lX_flag
522 }H264Context;
523
524 #endif /* AVCODEC_H264_H */