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