Partial PAFF implementation at macroblock level.
[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 h264.h
24  * H.264 / AVC / MPEG4 part10 codec.
25  * @author Michael Niedermayer <michaelni@gmx.at>
26  */
27
28 #ifndef H264_H
29 #define H264_H
30
31 #include "dsputil.h"
32 #include "cabac.h"
33 #include "mpegvideo.h"
34 #include "h264pred.h"
35
36 #define interlaced_dct interlaced_dct_is_a_bad_name
37 #define mb_intra mb_intra_is_not_initialized_see_mb_type
38
39 #define LUMA_DC_BLOCK_INDEX   25
40 #define CHROMA_DC_BLOCK_INDEX 26
41
42 #define CHROMA_DC_COEFF_TOKEN_VLC_BITS 8
43 #define COEFF_TOKEN_VLC_BITS           8
44 #define TOTAL_ZEROS_VLC_BITS           9
45 #define CHROMA_DC_TOTAL_ZEROS_VLC_BITS 3
46 #define RUN_VLC_BITS                   3
47 #define RUN7_VLC_BITS                  6
48
49 #define MAX_SPS_COUNT 32
50 #define MAX_PPS_COUNT 256
51
52 #define MAX_MMCO_COUNT 66
53
54 /* Compiling in interlaced support reduces the speed
55  * of progressive decoding by about 2%. */
56 #define ALLOW_INTERLACE
57
58 #ifdef ALLOW_INTERLACE
59 #define MB_MBAFF h->mb_mbaff
60 #define MB_FIELD h->mb_field_decoding_flag
61 #define FRAME_MBAFF h->mb_aff_frame
62 #define FIELD_PICTURE 0
63 #else
64 #define MB_MBAFF 0
65 #define MB_FIELD 0
66 #define FRAME_MBAFF 0
67 #define FIELD_PICTURE 0
68 #undef  IS_INTERLACED
69 #define IS_INTERLACED(mb_type) 0
70 #endif
71
72 /**
73  * Sequence parameter set
74  */
75 typedef struct SPS{
76
77     int profile_idc;
78     int level_idc;
79     int transform_bypass;              ///< qpprime_y_zero_transform_bypass_flag
80     int log2_max_frame_num;            ///< log2_max_frame_num_minus4 + 4
81     int poc_type;                      ///< pic_order_cnt_type
82     int log2_max_poc_lsb;              ///< log2_max_pic_order_cnt_lsb_minus4
83     int delta_pic_order_always_zero_flag;
84     int offset_for_non_ref_pic;
85     int offset_for_top_to_bottom_field;
86     int poc_cycle_length;              ///< num_ref_frames_in_pic_order_cnt_cycle
87     int ref_frame_count;               ///< num_ref_frames
88     int gaps_in_frame_num_allowed_flag;
89     int mb_width;                      ///< pic_width_in_mbs_minus1 + 1
90     int mb_height;                     ///< pic_height_in_map_units_minus1 + 1
91     int frame_mbs_only_flag;
92     int mb_aff;                        ///<mb_adaptive_frame_field_flag
93     int direct_8x8_inference_flag;
94     int crop;                   ///< frame_cropping_flag
95     int crop_left;              ///< frame_cropping_rect_left_offset
96     int crop_right;             ///< frame_cropping_rect_right_offset
97     int crop_top;               ///< frame_cropping_rect_top_offset
98     int crop_bottom;            ///< frame_cropping_rect_bottom_offset
99     int vui_parameters_present_flag;
100     AVRational sar;
101     int timing_info_present_flag;
102     uint32_t num_units_in_tick;
103     uint32_t time_scale;
104     int fixed_frame_rate_flag;
105     short offset_for_ref_frame[256]; //FIXME dyn aloc?
106     int bitstream_restriction_flag;
107     int num_reorder_frames;
108     int scaling_matrix_present;
109     uint8_t scaling_matrix4[6][16];
110     uint8_t scaling_matrix8[2][64];
111 }SPS;
112
113 /**
114  * Picture parameter set
115  */
116 typedef struct PPS{
117     unsigned int sps_id;
118     int cabac;                  ///< entropy_coding_mode_flag
119     int pic_order_present;      ///< pic_order_present_flag
120     int slice_group_count;      ///< num_slice_groups_minus1 + 1
121     int mb_slice_group_map_type;
122     unsigned int ref_count[2];  ///< num_ref_idx_l0/1_active_minus1 + 1
123     int weighted_pred;          ///< weighted_pred_flag
124     int weighted_bipred_idc;
125     int init_qp;                ///< pic_init_qp_minus26 + 26
126     int init_qs;                ///< pic_init_qs_minus26 + 26
127     int chroma_qp_index_offset[2];
128     int deblocking_filter_parameters_present; ///< deblocking_filter_parameters_present_flag
129     int constrained_intra_pred; ///< constrained_intra_pred_flag
130     int redundant_pic_cnt_present; ///< redundant_pic_cnt_present_flag
131     int transform_8x8_mode;     ///< transform_8x8_mode_flag
132     uint8_t scaling_matrix4[6][16];
133     uint8_t scaling_matrix8[2][64];
134     uint8_t chroma_qp_table[2][256];  ///< pre-scaled (with chroma_qp_index_offset) version of qp_table
135     int chroma_qp_diff;
136 }PPS;
137
138 /**
139  * Memory management control operation opcode.
140  */
141 typedef enum MMCOOpcode{
142     MMCO_END=0,
143     MMCO_SHORT2UNUSED,
144     MMCO_LONG2UNUSED,
145     MMCO_SHORT2LONG,
146     MMCO_SET_MAX_LONG,
147     MMCO_RESET,
148     MMCO_LONG,
149 } MMCOOpcode;
150
151 /**
152  * Memory management control operation.
153  */
154 typedef struct MMCO{
155     MMCOOpcode opcode;
156     int short_pic_num;  ///< pic_num without wrapping (pic_num & max_pic_num)
157     int long_arg;       ///< index, pic_num, or num long refs depending on opcode
158 } MMCO;
159
160 /**
161  * H264Context
162  */
163 typedef struct H264Context{
164     MpegEncContext s;
165     int nal_ref_idc;
166     int nal_unit_type;
167     uint8_t *rbsp_buffer[2];
168     unsigned int rbsp_buffer_size[2];
169
170     /**
171       * Used to parse AVC variant of h264
172       */
173     int is_avc; ///< this flag is != 0 if codec is avc1
174     int got_avcC; ///< flag used to parse avcC data only once
175     int nal_length_size; ///< Number of bytes used for nal length (1, 2 or 4)
176
177     int chroma_qp[2]; //QPc
178
179     int prev_mb_skipped;
180     int next_mb_skipped;
181
182     //prediction stuff
183     int chroma_pred_mode;
184     int intra16x16_pred_mode;
185
186     int top_mb_xy;
187     int left_mb_xy[2];
188
189     int8_t intra4x4_pred_mode_cache[5*8];
190     int8_t (*intra4x4_pred_mode)[8];
191     H264PredContext hpc;
192     unsigned int topleft_samples_available;
193     unsigned int top_samples_available;
194     unsigned int topright_samples_available;
195     unsigned int left_samples_available;
196     uint8_t (*top_borders[2])[16+2*8];
197     uint8_t left_border[2*(17+2*9)];
198
199     /**
200      * non zero coeff count cache.
201      * is 64 if not available.
202      */
203     DECLARE_ALIGNED_8(uint8_t, non_zero_count_cache[6*8]);
204     uint8_t (*non_zero_count)[16];
205
206     /**
207      * Motion vector cache.
208      */
209     DECLARE_ALIGNED_8(int16_t, mv_cache[2][5*8][2]);
210     DECLARE_ALIGNED_8(int8_t, ref_cache[2][5*8]);
211 #define LIST_NOT_USED -1 //FIXME rename?
212 #define PART_NOT_AVAILABLE -2
213
214     /**
215      * is 1 if the specific list MV&references are set to 0,0,-2.
216      */
217     int mv_cache_clean[2];
218
219     /**
220      * number of neighbors (top and/or left) that used 8x8 dct
221      */
222     int neighbor_transform_size;
223
224     /**
225      * block_offset[ 0..23] for frame macroblocks
226      * block_offset[24..47] for field macroblocks
227      */
228     int block_offset[2*(16+8)];
229
230     uint32_t *mb2b_xy; //FIXME are these 4 a good idea?
231     uint32_t *mb2b8_xy;
232     int b_stride; //FIXME use s->b4_stride
233     int b8_stride;
234
235     int mb_linesize;   ///< may be equal to s->linesize or s->linesize*2, for mbaff
236     int mb_uvlinesize;
237
238     int emu_edge_width;
239     int emu_edge_height;
240
241     int halfpel_flag;
242     int thirdpel_flag;
243
244     int unknown_svq3_flag;
245     int next_slice_index;
246
247     SPS *sps_buffers[MAX_SPS_COUNT];
248     SPS sps; ///< current sps
249
250     PPS *pps_buffers[MAX_PPS_COUNT];
251     /**
252      * current pps
253      */
254     PPS pps; //FIXME move to Picture perhaps? (->no) do we need that?
255
256     uint32_t dequant4_buffer[6][52][16];
257     uint32_t dequant8_buffer[2][52][64];
258     uint32_t (*dequant4_coeff[6])[16];
259     uint32_t (*dequant8_coeff[2])[64];
260     int dequant_coeff_pps;     ///< reinit tables when pps changes
261
262     int slice_num;
263     uint8_t *slice_table_base;
264     uint8_t *slice_table;      ///< slice_table_base + 2*mb_stride + 1
265     int slice_type;
266     int slice_type_fixed;
267
268     //interlacing specific flags
269     int mb_aff_frame;
270     int mb_field_decoding_flag;
271     int mb_mbaff;              ///< mb_aff_frame && mb_field_decoding_flag
272
273     unsigned int sub_mb_type[4];
274
275     //POC stuff
276     int poc_lsb;
277     int poc_msb;
278     int delta_poc_bottom;
279     int delta_poc[2];
280     int frame_num;
281     int prev_poc_msb;             ///< poc_msb of the last reference pic for POC type 0
282     int prev_poc_lsb;             ///< poc_lsb of the last reference pic for POC type 0
283     int frame_num_offset;         ///< for POC type 2
284     int prev_frame_num_offset;    ///< for POC type 2
285     int prev_frame_num;           ///< frame_num of the last pic for POC type 1/2
286
287     /**
288      * frame_num for frames or 2*frame_num for field pics.
289      */
290     int curr_pic_num;
291
292     /**
293      * max_frame_num or 2*max_frame_num for field pics.
294      */
295     int max_pic_num;
296
297     //Weighted pred stuff
298     int use_weight;
299     int use_weight_chroma;
300     int luma_log2_weight_denom;
301     int chroma_log2_weight_denom;
302     int luma_weight[2][48];
303     int luma_offset[2][48];
304     int chroma_weight[2][48][2];
305     int chroma_offset[2][48][2];
306     int implicit_weight[48][48];
307
308     //deblock
309     int deblocking_filter;         ///< disable_deblocking_filter_idc with 1<->0
310     int slice_alpha_c0_offset;
311     int slice_beta_offset;
312
313     int redundant_pic_count;
314
315     int direct_spatial_mv_pred;
316     int dist_scale_factor[16];
317     int dist_scale_factor_field[32];
318     int map_col_to_list0[2][16];
319     int map_col_to_list0_field[2][32];
320
321     /**
322      * num_ref_idx_l0/1_active_minus1 + 1
323      */
324     unsigned int ref_count[2];   ///< counts frames or fields, depending on current mb mode
325     unsigned int list_count;
326     Picture *short_ref[32];
327     Picture *long_ref[32];
328     Picture default_ref_list[2][32]; ///< base reference list for all slices of a coded picture
329     Picture ref_list[2][48];         /**< 0..15: frame refs, 16..47: mbaff field refs.
330                                           Reordered version of default_ref_list
331                                           according to picture reordering in slice header */
332     Picture *delayed_pic[18]; //FIXME size?
333     Picture *delayed_output_pic;
334
335     /**
336      * memory management control operations buffer.
337      */
338     MMCO mmco[MAX_MMCO_COUNT];
339     int mmco_index;
340
341     int long_ref_count;  ///< number of actual long term references
342     int short_ref_count; ///< number of actual short term references
343
344     //data partitioning
345     GetBitContext intra_gb;
346     GetBitContext inter_gb;
347     GetBitContext *intra_gb_ptr;
348     GetBitContext *inter_gb_ptr;
349
350     DECLARE_ALIGNED_8(DCTELEM, mb[16*24]);
351     DCTELEM mb_padding[256];        ///< as mb is addressed by scantable[i] and scantable is uint8_t we can either check that i is not to large or ensure that there is some unused stuff after mb
352
353     /**
354      * Cabac
355      */
356     CABACContext cabac;
357     uint8_t      cabac_state[460];
358     int          cabac_init_idc;
359
360     /* 0x100 -> non null luma_dc, 0x80/0x40 -> non null chroma_dc (cb/cr), 0x?0 -> chroma_cbp(0,1,2), 0x0? luma_cbp */
361     uint16_t     *cbp_table;
362     int cbp;
363     int top_cbp;
364     int left_cbp;
365     /* chroma_pred_mode for i4x4 or i16x16, else 0 */
366     uint8_t     *chroma_pred_mode_table;
367     int         last_qscale_diff;
368     int16_t     (*mvd_table[2])[2];
369     DECLARE_ALIGNED_8(int16_t, mvd_cache[2][5*8][2]);
370     uint8_t     *direct_table;
371     uint8_t     direct_cache[5*8];
372
373     uint8_t zigzag_scan[16];
374     uint8_t zigzag_scan8x8[64];
375     uint8_t zigzag_scan8x8_cavlc[64];
376     uint8_t field_scan[16];
377     uint8_t field_scan8x8[64];
378     uint8_t field_scan8x8_cavlc[64];
379     const uint8_t *zigzag_scan_q0;
380     const uint8_t *zigzag_scan8x8_q0;
381     const uint8_t *zigzag_scan8x8_cavlc_q0;
382     const uint8_t *field_scan_q0;
383     const uint8_t *field_scan8x8_q0;
384     const uint8_t *field_scan8x8_cavlc_q0;
385
386     int x264_build;
387
388     /**
389      * @defgroup multithreading Members for slice based multithreading
390      * @{
391      */
392     struct H264Context *thread_context[MAX_THREADS];
393
394     /**
395      * current slice number, used to initalize slice_num of each thread/context
396      */
397     int current_slice;
398
399     /**
400      * Max number of threads / contexts.
401      * This is equal to AVCodecContext.thread_count unless
402      * multithreaded decoding is impossible, in which case it is
403      * reduced to 1.
404      */
405     int max_contexts;
406
407     /**
408      *  1 if the single thread fallback warning has already been
409      *  displayed, 0 otherwise.
410      */
411     int single_decode_warning;
412
413     int last_slice_type;
414     /** @} */
415
416 }H264Context;
417
418 #endif /* H264_H */