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