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