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