using isnan instead of d==d, to signal correctly parsed option
[libav.git] / libavcodec / h264.h
CommitLineData
26b4fe82
AJ
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
26b4fe82
AJ
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"
c92a30bb 34#include "h264pred.h"
26b4fe82
AJ
35
36#define interlaced_dct interlaced_dct_is_a_bad_name
90b5b51e 37#define mb_intra mb_intra_is_not_initialized_see_mb_type
26b4fe82
AJ
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#else
63#define MB_MBAFF 0
64#define MB_FIELD 0
65#define FRAME_MBAFF 0
66#undef IS_INTERLACED
67#define IS_INTERLACED(mb_type) 0
68#endif
69
70/**
71 * Sequence parameter set
72 */
73typedef struct SPS{
74
75 int profile_idc;
76 int level_idc;
77 int transform_bypass; ///< qpprime_y_zero_transform_bypass_flag
78 int log2_max_frame_num; ///< log2_max_frame_num_minus4 + 4
79 int poc_type; ///< pic_order_cnt_type
80 int log2_max_poc_lsb; ///< log2_max_pic_order_cnt_lsb_minus4
81 int delta_pic_order_always_zero_flag;
82 int offset_for_non_ref_pic;
83 int offset_for_top_to_bottom_field;
84 int poc_cycle_length; ///< num_ref_frames_in_pic_order_cnt_cycle
85 int ref_frame_count; ///< num_ref_frames
86 int gaps_in_frame_num_allowed_flag;
87 int mb_width; ///< frame_width_in_mbs_minus1 + 1
88 int mb_height; ///< frame_height_in_mbs_minus1 + 1
89 int frame_mbs_only_flag;
90 int mb_aff; ///<mb_adaptive_frame_field_flag
91 int direct_8x8_inference_flag;
92 int crop; ///< frame_cropping_flag
93 int crop_left; ///< frame_cropping_rect_left_offset
94 int crop_right; ///< frame_cropping_rect_right_offset
95 int crop_top; ///< frame_cropping_rect_top_offset
96 int crop_bottom; ///< frame_cropping_rect_bottom_offset
97 int vui_parameters_present_flag;
98 AVRational sar;
99 int timing_info_present_flag;
100 uint32_t num_units_in_tick;
101 uint32_t time_scale;
102 int fixed_frame_rate_flag;
103 short offset_for_ref_frame[256]; //FIXME dyn aloc?
104 int bitstream_restriction_flag;
105 int num_reorder_frames;
106 int scaling_matrix_present;
107 uint8_t scaling_matrix4[6][16];
108 uint8_t scaling_matrix8[2][64];
109}SPS;
110
111/**
112 * Picture parameter set
113 */
114typedef struct PPS{
115 unsigned int sps_id;
116 int cabac; ///< entropy_coding_mode_flag
117 int pic_order_present; ///< pic_order_present_flag
118 int slice_group_count; ///< num_slice_groups_minus1 + 1
119 int mb_slice_group_map_type;
120 unsigned int ref_count[2]; ///< num_ref_idx_l0/1_active_minus1 + 1
121 int weighted_pred; ///< weighted_pred_flag
122 int weighted_bipred_idc;
123 int init_qp; ///< pic_init_qp_minus26 + 26
124 int init_qs; ///< pic_init_qs_minus26 + 26
4691a77d 125 int chroma_qp_index_offset[2];
26b4fe82
AJ
126 int deblocking_filter_parameters_present; ///< deblocking_filter_parameters_present_flag
127 int constrained_intra_pred; ///< constrained_intra_pred_flag
128 int redundant_pic_cnt_present; ///< redundant_pic_cnt_present_flag
129 int transform_8x8_mode; ///< transform_8x8_mode_flag
130 uint8_t scaling_matrix4[6][16];
131 uint8_t scaling_matrix8[2][64];
4691a77d
132 uint8_t chroma_qp_table[2][256]; ///< pre-scaled (with chroma_qp_index_offset) version of qp_table
133 int chroma_qp_diff;
26b4fe82
AJ
134}PPS;
135
136/**
137 * Memory management control operation opcode.
138 */
139typedef enum MMCOOpcode{
140 MMCO_END=0,
141 MMCO_SHORT2UNUSED,
142 MMCO_LONG2UNUSED,
143 MMCO_SHORT2LONG,
144 MMCO_SET_MAX_LONG,
145 MMCO_RESET,
146 MMCO_LONG,
147} MMCOOpcode;
148
149/**
150 * Memory management control operation.
151 */
152typedef struct MMCO{
153 MMCOOpcode opcode;
154 int short_frame_num;
155 int long_index;
156} MMCO;
157
158/**
159 * H264Context
160 */
161typedef struct H264Context{
162 MpegEncContext s;
163 int nal_ref_idc;
164 int nal_unit_type;
24456882
165 uint8_t *rbsp_buffer[2];
166 unsigned int rbsp_buffer_size[2];
26b4fe82
AJ
167
168 /**
169 * Used to parse AVC variant of h264
170 */
171 int is_avc; ///< this flag is != 0 if codec is avc1
172 int got_avcC; ///< flag used to parse avcC data only once
173 int nal_length_size; ///< Number of bytes used for nal length (1, 2 or 4)
174
4691a77d 175 int chroma_qp[2]; //QPc
26b4fe82
AJ
176
177 int prev_mb_skipped;
178 int next_mb_skipped;
179
180 //prediction stuff
181 int chroma_pred_mode;
182 int intra16x16_pred_mode;
183
184 int top_mb_xy;
185 int left_mb_xy[2];
186
187 int8_t intra4x4_pred_mode_cache[5*8];
188 int8_t (*intra4x4_pred_mode)[8];
c92a30bb 189 H264PredContext hpc;
26b4fe82
AJ
190 unsigned int topleft_samples_available;
191 unsigned int top_samples_available;
192 unsigned int topright_samples_available;
193 unsigned int left_samples_available;
194 uint8_t (*top_borders[2])[16+2*8];
195 uint8_t left_border[2*(17+2*9)];
196
197 /**
198 * non zero coeff count cache.
199 * is 64 if not available.
200 */
201 DECLARE_ALIGNED_8(uint8_t, non_zero_count_cache[6*8]);
202 uint8_t (*non_zero_count)[16];
203
204 /**
205 * Motion vector cache.
206 */
207 DECLARE_ALIGNED_8(int16_t, mv_cache[2][5*8][2]);
208 DECLARE_ALIGNED_8(int8_t, ref_cache[2][5*8]);
209#define LIST_NOT_USED -1 //FIXME rename?
210#define PART_NOT_AVAILABLE -2
211
212 /**
213 * is 1 if the specific list MV&references are set to 0,0,-2.
214 */
215 int mv_cache_clean[2];
216
217 /**
218 * number of neighbors (top and/or left) that used 8x8 dct
219 */
220 int neighbor_transform_size;
221
222 /**
223 * block_offset[ 0..23] for frame macroblocks
224 * block_offset[24..47] for field macroblocks
225 */
226 int block_offset[2*(16+8)];
227
228 uint32_t *mb2b_xy; //FIXME are these 4 a good idea?
229 uint32_t *mb2b8_xy;
230 int b_stride; //FIXME use s->b4_stride
231 int b8_stride;
232
233 int mb_linesize; ///< may be equal to s->linesize or s->linesize*2, for mbaff
234 int mb_uvlinesize;
235
236 int emu_edge_width;
237 int emu_edge_height;
238
239 int halfpel_flag;
240 int thirdpel_flag;
241
242 int unknown_svq3_flag;
243 int next_slice_index;
244
7978debd 245 SPS *sps_buffers[MAX_SPS_COUNT];
26b4fe82
AJ
246 SPS sps; ///< current sps
247
7978debd 248 PPS *pps_buffers[MAX_PPS_COUNT];
26b4fe82
AJ
249 /**
250 * current pps
251 */
252 PPS pps; //FIXME move to Picture perhaps? (->no) do we need that?
253
254 uint32_t dequant4_buffer[6][52][16];
255 uint32_t dequant8_buffer[2][52][64];
256 uint32_t (*dequant4_coeff[6])[16];
257 uint32_t (*dequant8_coeff[2])[64];
258 int dequant_coeff_pps; ///< reinit tables when pps changes
259
260 int slice_num;
261 uint8_t *slice_table_base;
262 uint8_t *slice_table; ///< slice_table_base + 2*mb_stride + 1
263 int slice_type;
264 int slice_type_fixed;
265
266 //interlacing specific flags
267 int mb_aff_frame;
268 int mb_field_decoding_flag;
269 int mb_mbaff; ///< mb_aff_frame && mb_field_decoding_flag
270
271 unsigned int sub_mb_type[4];
272
273 //POC stuff
274 int poc_lsb;
275 int poc_msb;
276 int delta_poc_bottom;
277 int delta_poc[2];
278 int frame_num;
279 int prev_poc_msb; ///< poc_msb of the last reference pic for POC type 0
280 int prev_poc_lsb; ///< poc_lsb of the last reference pic for POC type 0
281 int frame_num_offset; ///< for POC type 2
282 int prev_frame_num_offset; ///< for POC type 2
283 int prev_frame_num; ///< frame_num of the last pic for POC type 1/2
284
285 /**
286 * frame_num for frames or 2*frame_num for field pics.
287 */
288 int curr_pic_num;
289
290 /**
291 * max_frame_num or 2*max_frame_num for field pics.
292 */
293 int max_pic_num;
294
295 //Weighted pred stuff
296 int use_weight;
297 int use_weight_chroma;
298 int luma_log2_weight_denom;
299 int chroma_log2_weight_denom;
300 int luma_weight[2][48];
301 int luma_offset[2][48];
302 int chroma_weight[2][48][2];
303 int chroma_offset[2][48][2];
304 int implicit_weight[48][48];
305
306 //deblock
307 int deblocking_filter; ///< disable_deblocking_filter_idc with 1<->0
308 int slice_alpha_c0_offset;
309 int slice_beta_offset;
310
311 int redundant_pic_count;
312
313 int direct_spatial_mv_pred;
314 int dist_scale_factor[16];
315 int dist_scale_factor_field[32];
316 int map_col_to_list0[2][16];
317 int map_col_to_list0_field[2][32];
318
319 /**
320 * num_ref_idx_l0/1_active_minus1 + 1
321 */
322 unsigned int ref_count[2]; ///< counts frames or fields, depending on current mb mode
323 unsigned int list_count;
324 Picture *short_ref[32];
325 Picture *long_ref[32];
326 Picture default_ref_list[2][32];
327 Picture ref_list[2][48]; ///< 0..15: frame refs, 16..47: mbaff field refs
328 Picture *delayed_pic[18]; //FIXME size?
329 Picture *delayed_output_pic;
330
331 /**
332 * memory management control operations buffer.
333 */
334 MMCO mmco[MAX_MMCO_COUNT];
335 int mmco_index;
336
337 int long_ref_count; ///< number of actual long term references
338 int short_ref_count; ///< number of actual short term references
339
340 //data partitioning
341 GetBitContext intra_gb;
342 GetBitContext inter_gb;
343 GetBitContext *intra_gb_ptr;
344 GetBitContext *inter_gb_ptr;
345
346 DECLARE_ALIGNED_8(DCTELEM, mb[16*24]);
347 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
348
349 /**
350 * Cabac
351 */
352 CABACContext cabac;
353 uint8_t cabac_state[460];
354 int cabac_init_idc;
355
356 /* 0x100 -> non null luma_dc, 0x80/0x40 -> non null chroma_dc (cb/cr), 0x?0 -> chroma_cbp(0,1,2), 0x0? luma_cbp */
357 uint16_t *cbp_table;
358 int cbp;
359 int top_cbp;
360 int left_cbp;
361 /* chroma_pred_mode for i4x4 or i16x16, else 0 */
362 uint8_t *chroma_pred_mode_table;
363 int last_qscale_diff;
364 int16_t (*mvd_table[2])[2];
365 DECLARE_ALIGNED_8(int16_t, mvd_cache[2][5*8][2]);
366 uint8_t *direct_table;
367 uint8_t direct_cache[5*8];
368
369 uint8_t zigzag_scan[16];
370 uint8_t zigzag_scan8x8[64];
371 uint8_t zigzag_scan8x8_cavlc[64];
372 uint8_t field_scan[16];
373 uint8_t field_scan8x8[64];
374 uint8_t field_scan8x8_cavlc[64];
375 const uint8_t *zigzag_scan_q0;
376 const uint8_t *zigzag_scan8x8_q0;
377 const uint8_t *zigzag_scan8x8_cavlc_q0;
378 const uint8_t *field_scan_q0;
379 const uint8_t *field_scan8x8_q0;
380 const uint8_t *field_scan8x8_cavlc_q0;
381
382 int x264_build;
383}H264Context;
384
385#endif /* H264_H */