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