example using video encoder latency
[libav.git] / libavcodec / avcodec.h
CommitLineData
a96b68b7
FB
1#ifndef AVCODEC_H
2#define AVCODEC_H
3
36df8805
MN
4/**
5 * @file avcodec.h
d33c949c 6 * external api header.
36df8805
MN
7 */
8
9
02d697aa
ZK
10#ifdef __cplusplus
11extern "C" {
12#endif
13
de6d9b64
FB
14#include "common.h"
15
8026c3b5
AB
16#define LIBAVCODEC_VERSION_INT 0x000408
17#define LIBAVCODEC_VERSION "0.4.8"
dcedf586
FB
18#define LIBAVCODEC_BUILD 4678
19#define LIBAVCODEC_BUILD_STR "4678"
4b1f4f23 20
ce2749d2
AB
21#define LIBAVCODEC_IDENT "FFmpeg" LIBAVCODEC_VERSION "b" LIBAVCODEC_BUILD_STR
22
de6d9b64
FB
23enum CodecID {
24 CODEC_ID_NONE,
25 CODEC_ID_MPEG1VIDEO,
dcedf586 26 CODEC_ID_MPEG2VIDEO, /* prefered ID for MPEG Video 1 or 2 decoding */
fb364ada 27 CODEC_ID_MPEG2VIDEO_XVMC,
de6d9b64
FB
28 CODEC_ID_H263,
29 CODEC_ID_RV10,
30 CODEC_ID_MP2,
dcedf586 31 CODEC_ID_MP3, /* prefered ID for MPEG Audio layer 1, 2 or3 decoding */
81e0d0b4 32 CODEC_ID_VORBIS,
de6d9b64
FB
33 CODEC_ID_AC3,
34 CODEC_ID_MJPEG,
b135d9fb 35 CODEC_ID_MJPEGB,
b1e6b355 36 CODEC_ID_LJPEG,
bf89e6b1 37 CODEC_ID_MPEG4,
de6d9b64 38 CODEC_ID_RAWVIDEO,
84afee34
MN
39 CODEC_ID_MSMPEG4V1,
40 CODEC_ID_MSMPEG4V2,
41 CODEC_ID_MSMPEG4V3,
e1a9dbff 42 CODEC_ID_WMV1,
b50eef3a 43 CODEC_ID_WMV2,
de6d9b64
FB
44 CODEC_ID_H263P,
45 CODEC_ID_H263I,
d4f5d74a 46 CODEC_ID_FLV1,
be8ffec9 47 CODEC_ID_SVQ1,
8b82a956 48 CODEC_ID_SVQ3,
020fcc94
FB
49 CODEC_ID_DVVIDEO,
50 CODEC_ID_DVAUDIO,
bc8d1857
FB
51 CODEC_ID_WMAV1,
52 CODEC_ID_WMAV2,
3f95e843
FR
53 CODEC_ID_MACE3,
54 CODEC_ID_MACE6,
11f18faf 55 CODEC_ID_HUFFYUV,
f70f7c6d 56 CODEC_ID_CYUV,
0da71265 57 CODEC_ID_H264,
deabd4fd 58 CODEC_ID_INDEO3,
d86053a4 59 CODEC_ID_VP3,
280bd7b7
ZK
60 CODEC_ID_AAC,
61 CODEC_ID_MPEG4AAC,
3d2e8cce 62 CODEC_ID_ASV1,
9b56edf5 63 CODEC_ID_ASV2,
5e20f836 64 CODEC_ID_FFV1,
e2a7bb28 65 CODEC_ID_4XM,
be3564ed 66 CODEC_ID_VCR1,
3aff069b 67 CODEC_ID_CLJR,
c3bf0288 68 CODEC_ID_MDEC,
3ef8be2b
MM
69 CODEC_ID_ROQ,
70 CODEC_ID_INTERPLAY_VIDEO,
9937e686
MM
71 CODEC_ID_XAN_WC3,
72 CODEC_ID_XAN_WC4,
a96b68b7
FB
73
74 /* various pcm "codecs" */
75 CODEC_ID_PCM_S16LE,
76 CODEC_ID_PCM_S16BE,
77 CODEC_ID_PCM_U16LE,
78 CODEC_ID_PCM_U16BE,
79 CODEC_ID_PCM_S8,
80 CODEC_ID_PCM_U8,
81 CODEC_ID_PCM_MULAW,
82 CODEC_ID_PCM_ALAW,
0147f198
FR
83
84 /* various adpcm codecs */
85 CODEC_ID_ADPCM_IMA_QT,
86 CODEC_ID_ADPCM_IMA_WAV,
9937e686
MM
87 CODEC_ID_ADPCM_IMA_DK3,
88 CODEC_ID_ADPCM_IMA_DK4,
0147f198 89 CODEC_ID_ADPCM_MS,
e2a7bb28 90 CODEC_ID_ADPCM_4XM,
891f64b3 91
92 /* AMR */
93 CODEC_ID_AMR_NB,
b8414bbd
NK
94 /* RealAudio codecs*/
95 CODEC_ID_RA_144,
96 CODEC_ID_RA_288,
3ef8be2b
MM
97
98 /* various DPCM codecs */
99 CODEC_ID_ROQ_DPCM,
100 CODEC_ID_INTERPLAY_DPCM,
9937e686 101 CODEC_ID_XAN_DPCM,
de6d9b64 102};
dcedf586
FB
103
104/* CODEC_ID_MP3LAME is absolete */
105#define CODEC_ID_MP3LAME CODEC_ID_MP3
de6d9b64
FB
106
107enum CodecType {
4a663d80 108 CODEC_TYPE_UNKNOWN = -1,
de6d9b64
FB
109 CODEC_TYPE_VIDEO,
110 CODEC_TYPE_AUDIO,
111};
112
64863965
MN
113/**
114 * Pixel format.
115 */
de6d9b64 116enum PixelFormat {
cd394651
MN
117 PIX_FMT_YUV420P, ///< Planar YUV 4:2:0 (1 Cr & Cb sample per 2x2 Y samples)
118 PIX_FMT_YUV422,
119 PIX_FMT_RGB24, ///< Packed pixel, 3 bytes per pixel, RGBRGB...
120 PIX_FMT_BGR24, ///< Packed pixel, 3 bytes per pixel, BGRBGR...
121 PIX_FMT_YUV422P, ///< Planar YUV 4:2:2 (1 Cr & Cb sample per 2x1 Y samples)
122 PIX_FMT_YUV444P, ///< Planar YUV 4:4:4 (1 Cr & Cb sample per 1x1 Y samples)
b1e6b355 123 PIX_FMT_RGBA32, ///< Packed pixel, 4 bytes per pixel, BGRABGRA...
cd394651
MN
124 PIX_FMT_YUV410P, ///< Planar YUV 4:1:0 (1 Cr & Cb sample per 4x4 Y samples)
125 PIX_FMT_YUV411P, ///< Planar YUV 4:1:1 (1 Cr & Cb sample per 4x1 Y samples)
64863965
MN
126 PIX_FMT_RGB565, ///< always stored in cpu endianness
127 PIX_FMT_RGB555, ///< always stored in cpu endianness, most significant bit to 1
dab64ebc 128 PIX_FMT_GRAY8,
64863965
MN
129 PIX_FMT_MONOWHITE, ///< 0 is white
130 PIX_FMT_MONOBLACK, ///< 0 is black
131 PIX_FMT_PAL8, ///< 8 bit with RGBA palette
cd394651
MN
132 PIX_FMT_YUVJ420P, ///< Planar YUV 4:2:0 full scale (jpeg)
133 PIX_FMT_YUVJ422P, ///< Planar YUV 4:2:2 full scale (jpeg)
134 PIX_FMT_YUVJ444P, ///< Planar YUV 4:4:4 full scale (jpeg)
fb364ada
IK
135 PIX_FMT_XVMC_MPEG2_MC,///< XVideo Motion Acceleration via common packet passing(xvmc_render.h)
136 PIX_FMT_XVMC_MPEG2_IDCT,
dab64ebc 137 PIX_FMT_NB,
de6d9b64
FB
138};
139
a96b68b7
FB
140/* currently unused, may be used if 24/32 bits samples ever supported */
141enum SampleFormat {
64863965 142 SAMPLE_FMT_S16 = 0, ///< signed 16 bits
a96b68b7
FB
143};
144
de6d9b64 145/* in bytes */
bc8d1857 146#define AVCODEC_MAX_AUDIO_FRAME_SIZE 131072
de6d9b64 147
d7425f59 148/**
cf713bb8
MN
149 * Required number of additionally allocated bytes at the end of the input bitstream for decoding.
150 * this is mainly needed because some optimized bitstream readers read
151 * 32 or 64 bit at once and could read over the end<br>
152 * Note, if the first 23 bits of the additional bytes are not 0 then damaged
153 * MPEG bitstreams could cause overread and segfault
d7425f59
MN
154 */
155#define FF_INPUT_BUFFER_PADDING_SIZE 8
156
e4986da9
J
157/* motion estimation type, EPZS by default */
158enum Motion_Est_ID {
101bea5f 159 ME_ZERO = 1,
e4986da9
J
160 ME_FULL,
161 ME_LOG,
162 ME_PHODS,
163 ME_EPZS,
164 ME_X1
165};
166
ce980a95
MN
167typedef struct RcOverride{
168 int start_frame;
169 int end_frame;
170 int qscale; // if this is 0 then quality_factor will be used instead
171 float quality_factor;
172} RcOverride;
173
101bea5f
J
174/* only for ME compatiblity with old apps */
175extern int motion_estimation_method;
176
e4986da9 177/* ME algos sorted by quality */
bc6caae2
J
178static const int Motion_Est_QTab[] = { ME_ZERO, ME_PHODS, ME_LOG,
179 ME_X1, ME_EPZS, ME_FULL };
de6d9b64 180
28db7fce 181
4e00e76b 182#define FF_MAX_B_FRAMES 8
9dbcbd92 183
a949d72e
MN
184/* encoding support
185 these flags can be passed in AVCodecContext.flags before initing
186 Note: note not everything is supported yet
187*/
de6d9b64 188
64863965
MN
189#define CODEC_FLAG_QSCALE 0x0002 ///< use fixed qscale
190#define CODEC_FLAG_4MV 0x0004 ///< 4 MV per MB allowed
191#define CODEC_FLAG_QPEL 0x0010 ///< use qpel MC
192#define CODEC_FLAG_GMC 0x0020 ///< use GMC
193#define CODEC_FLAG_PART 0x0080 ///< use data partitioning
9dbcbd92
MN
194/* parent program gurantees that the input for b-frame containing streams is not written to
195 for at least s->max_b_frames+1 frames, if this is not set than the input will be copied */
8b4c7dbc 196#define CODEC_FLAG_INPUT_PRESERVED 0x0100
64863965
MN
197#define CODEC_FLAG_PASS1 0x0200 ///< use internal 2pass ratecontrol in first pass mode
198#define CODEC_FLAG_PASS2 0x0400 ///< use internal 2pass ratecontrol in second pass mode
199#define CODEC_FLAG_EXTERN_HUFF 0x1000 ///< use external huffman table (for mjpeg)
200#define CODEC_FLAG_GRAY 0x2000 ///< only decode/encode grayscale
201#define CODEC_FLAG_EMU_EDGE 0x4000///< dont draw edges
202#define CODEC_FLAG_PSNR 0x8000 ///< error[?] variables will be set during encoding
203#define CODEC_FLAG_TRUNCATED 0x00010000 /** input bitstream might be truncated at a random location instead
d7425f59 204 of only at frame boundaries */
64863965
MN
205#define CODEC_FLAG_NORMALIZE_AQP 0x00020000 ///< normalize adaptive quantization
206#define CODEC_FLAG_INTERLACED_DCT 0x00040000 ///< use interlaced dct
3bb07d61 207#define CODEC_FLAG_LOW_DELAY 0x00080000 ///< force low delay
64863965
MN
208#define CODEC_FLAG_ALT_SCAN 0x00100000 ///< use alternate scan
209#define CODEC_FLAG_TRELLIS_QUANT 0x00200000 ///< use trellis quantization
210#define CODEC_FLAG_GLOBAL_HEADER 0x00400000 ///< place global headers in extradata instead of every keyframe
211#define CODEC_FLAG_BITEXACT 0x00800000 ///< use only bitexact stuff (except (i)dct)
21e59552 212/* Fx : Flag for h263+ extra options */
64863965
MN
213#define CODEC_FLAG_H263P_AIC 0x01000000 ///< Advanced intra coding
214#define CODEC_FLAG_H263P_UMV 0x02000000 ///< Unlimited motion vector
21e59552
MN
215/* For advanced prediction mode, we reuse the 4MV flag */
216/* Unsupported options :
217 * Syntax Arithmetic coding (SAC)
218 * Deblocking filter internal loop
219 * Slice structured
220 * Reference Picture Selection
221 * Independant Segment Decoding
222 * Alternative Inter * VLC
223 * Modified Quantization */
224/* /Fx */
bf89e6b1
FB
225/* codec capabilities */
226
64863965 227#define CODEC_CAP_DRAW_HORIZ_BAND 0x0001 ///< decoder can use draw_horiz_band callback
6814a25c
MN
228/**
229 * Codec uses get_buffer() for allocating buffers.
230 * direct rendering method 1
231 */
232#define CODEC_CAP_DR1 0x0002
917e06c8
FB
233/* if 'parse_only' field is true, then avcodec_parse_frame() can be
234 used */
235#define CODEC_CAP_PARSE_ONLY 0x0004
d7425f59 236#define CODEC_CAP_TRUNCATED 0x0008
bf89e6b1 237
492cd3a9 238#define FF_COMMON_FRAME \
b536d0aa
MN
239 /**\
240 * pointer to the picture planes.\
241 * this might be different from the first allocated byte\
242 * - encoding: \
243 * - decoding: \
244 */\
1e491e29
MN
245 uint8_t *data[4];\
246 int linesize[4];\
247 /**\
32db2b1d 248 * pointer to the first allocated byte of the picture. can be used in get_buffer/release_buffer\
1e491e29 249 * this isnt used by lavc unless the default get/release_buffer() is used\
64863965
MN
250 * - encoding: \
251 * - decoding: \
1e491e29
MN
252 */\
253 uint8_t *base[4];\
254 /**\
255 * 1 -> keyframe, 0-> not\
64863965
MN
256 * - encoding: set by lavc\
257 * - decoding: set by lavc\
1e491e29
MN
258 */\
259 int key_frame;\
260\
261 /**\
0da71265 262 * picture type of the frame, see ?_TYPE below.\
64863965
MN
263 * - encoding: set by lavc for coded_picture (and set by user for input)\
264 * - decoding: set by lavc\
1e491e29
MN
265 */\
266 int pict_type;\
267\
268 /**\
269 * presentation timestamp in micro seconds (time when frame should be shown to user)\
270 * if 0 then the frame_rate will be used as reference\
64863965
MN
271 * - encoding: MUST be set by user\
272 * - decoding: set by lavc\
1e491e29 273 */\
be6784dc 274 int64_t pts;\
1e491e29
MN
275\
276 /**\
277 * picture number in bitstream order.\
64863965
MN
278 * - encoding: set by\
279 * - decoding: set by lavc\
1e491e29
MN
280 */\
281 int coded_picture_number;\
282 /**\
1e491e29 283 * picture number in display order.\
64863965
MN
284 * - encoding: set by\
285 * - decoding: set by lavc\
1e491e29
MN
286 */\
287 int display_picture_number;\
288\
289 /**\
290 * quality (between 1 (good) and 31 (bad)) \
64863965
MN
291 * - encoding: set by lavc for coded_picture (and set by user for input)\
292 * - decoding: set by lavc\
1e491e29
MN
293 */\
294 float quality; \
295\
296 /**\
297 * buffer age (1->was last buffer and dint change, 2->..., ...).\
298 * set to something large if the buffer has not been used yet \
64863965
MN
299 * - encoding: unused\
300 * - decoding: MUST be set by get_buffer()\
1e491e29
MN
301 */\
302 int age;\
303\
304 /**\
305 * is this picture used as reference\
64863965
MN
306 * - encoding: unused\
307 * - decoding: set by lavc (before get_buffer() call))\
1e491e29
MN
308 */\
309 int reference;\
310\
311 /**\
312 * QP table\
64863965
MN
313 * - encoding: unused\
314 * - decoding: set by lavc\
1e491e29
MN
315 */\
316 int8_t *qscale_table;\
317 /**\
318 * QP store stride\
64863965
MN
319 * - encoding: unused\
320 * - decoding: set by lavc\
1e491e29
MN
321 */\
322 int qstride;\
323\
324 /**\
325 * mbskip_table[mb]>=1 if MB didnt change\
326 * stride= mb_width = (width+15)>>4\
64863965
MN
327 * - encoding: unused\
328 * - decoding: set by lavc\
1e491e29
MN
329 */\
330 uint8_t *mbskip_table;\
331\
332 /**\
333 * for some private data of the user\
64863965
MN
334 * - encoding: unused\
335 * - decoding: set by user\
1e491e29
MN
336 */\
337 void *opaque;\
140cb663
MN
338\
339 /**\
340 * error\
64863965
MN
341 * - encoding: set by lavc if flags&CODEC_FLAG_PSNR\
342 * - decoding: unused\
140cb663
MN
343 */\
344 uint64_t error[4];\
4e00e76b
MN
345\
346 /**\
347 * type of the buffer (to keep track of who has to dealloc data[*])\
64863965
MN
348 * - encoding: set by the one who allocs it\
349 * - decoding: set by the one who allocs it\
3db320ea 350 * Note: user allocated (direct rendering) & internal buffers can not coexist currently\
4e00e76b
MN
351 */\
352 int type;\
2ec23b6d
MN
353 \
354 /**\
355 * when decoding, this signal how much the picture must be delayed.\
356 * extra_delay = repeat_pict / (2*fps)\
64863965
MN
357 * - encoding: unused\
358 * - decoding: set by lavc\
2ec23b6d 359 */\
0426af31
MN
360 int repeat_pict;\
361 \
362 /**\
363 * \
364 */\
365 int qscale_type;\
2ec23b6d 366
0426af31
MN
367#define FF_QSCALE_TYPE_MPEG1 0
368#define FF_QSCALE_TYPE_MPEG2 1
4e00e76b
MN
369
370#define FF_BUFFER_TYPE_INTERNAL 1
9b56edf5
MN
371#define FF_BUFFER_TYPE_USER 2 ///< Direct rendering buffers (image is (de)allocated by user)
372#define FF_BUFFER_TYPE_SHARED 4 ///< buffer from somewher else, dont dealloc image (data/base)
373#define FF_BUFFER_TYPE_COPY 8 ///< just a (modified) copy of some other buffer, dont dealloc anything
4e00e76b 374
1e491e29 375
140cb663
MN
376#define FF_I_TYPE 1 // Intra
377#define FF_P_TYPE 2 // Predicted
378#define FF_B_TYPE 3 // Bi-dir predicted
379#define FF_S_TYPE 4 // S(GMC)-VOP MPEG4
0da71265
MN
380#define FF_SI_TYPE 5
381#define FF_SP_TYPE 6
1e491e29 382
0da71265
MN
383/**
384 * Audio Video Frame.
385 */
492cd3a9
MN
386typedef struct AVFrame {
387 FF_COMMON_FRAME
388} AVFrame;
1e491e29 389
14bea432 390#define DEFAULT_FRAME_RATE_BASE 1001000
d33c949c
MN
391
392/**
393 * main external api structure.
394 */
de6d9b64 395typedef struct AVCodecContext {
b71901e6 396 /**
64863965
MN
397 * the average bitrate.
398 * - encoding: set by user. unused for constant quantizer encoding
399 * - decoding: set by lavc. 0 or some bitrate if this info is available in the stream
b71901e6 400 */
de6d9b64 401 int bit_rate;
b71901e6
MN
402
403 /**
64863965 404 * number of bits the bitstream is allowed to diverge from the reference.
b71901e6 405 * the reference can be CBR (for CBR pass1) or VBR (for pass2)
64863965
MN
406 * - encoding: set by user. unused for constant quantizer encoding
407 * - decoding: unused
b71901e6
MN
408 */
409 int bit_rate_tolerance;
410
411 /**
64863965
MN
412 * CODEC_FLAG_*.
413 * - encoding: set by user.
414 * - decoding: set by user.
b71901e6 415 */
de6d9b64 416 int flags;
b71901e6
MN
417
418 /**
419 * some codecs needs additionnal format info. It is stored here
64863965
MN
420 * - encoding: set by user.
421 * - decoding: set by lavc. (FIXME is this ok?)
b71901e6
MN
422 */
423 int sub_id;
424
425 /**
64863965
MN
426 * motion estimation algorithm used for video coding.
427 * - encoding: MUST be set by user.
428 * - decoding: unused
b71901e6
MN
429 */
430 int me_method;
431
432 /**
64863965 433 * some codecs need / can use extra-data like huffman tables.
b71901e6
MN
434 * mjpeg: huffman tables
435 * rv10: additional flags
b704e742 436 * mpeg4: global headers (they can be in the bitstream or here)
64863965
MN
437 * - encoding: set/allocated/freed by lavc.
438 * - decoding: set/allocated/freed by user.
b71901e6 439 */
e84c31dc
A
440 void *extradata;
441 int extradata_size;
442
de6d9b64 443 /* video only */
b71901e6 444 /**
14bea432 445 * frames per sec multiplied by frame_rate_base.
b71901e6 446 * for variable fps this is the precission, so if the timestamps
14bea432 447 * can be specified in msec precssion then this is 1000*frame_rate_base
64863965
MN
448 * - encoding: MUST be set by user
449 * - decoding: set by lavc. 0 or the frame_rate if available
b71901e6
MN
450 */
451 int frame_rate;
14bea432
MN
452
453 /**
64863965
MN
454 * width / height.
455 * - encoding: MUST be set by user.
456 * - decoding: set by user, some codecs might override / change it during playback
b71901e6 457 */
de6d9b64 458 int width, height;
b71901e6 459
2efe097a
MN
460#define FF_ASPECT_SQUARE 1
461#define FF_ASPECT_4_3_625 2
462#define FF_ASPECT_4_3_525 3
463#define FF_ASPECT_16_9_625 4
464#define FF_ASPECT_16_9_525 5
e769f053 465#define FF_ASPECT_EXTENDED 15
b71901e6
MN
466
467 /**
64863965
MN
468 * the number of pictures in a group of pitures, or 0 for intra_only.
469 * - encoding: set by user.
470 * - decoding: unused
b71901e6
MN
471 */
472 int gop_size;
473
474 /**
64863965 475 * pixel format, see PIX_FMT_xxx.
36b58e85
RS
476 * - encoding: FIXME: used by ffmpeg to decide whether an pix_fmt
477 * conversion is in order. This only works for
478 * codecs with one supported pix_fmt, we should
479 * do something for a generic case as well.
64863965 480 * - decoding: set by lavc.
b71901e6 481 */
e4eadb4b 482 enum PixelFormat pix_fmt;
bdfcbbed
MK
483
484 /**
485 * Frame rate emulation. If not zero lower layer (i.e. format handler)
486 * has to read frames at native frame rate.
487 * - encoding: set by user.
488 * - decoding: unused.
489 */
490 int rate_emu;
491
b71901e6
MN
492 /**
493 * if non NULL, 'draw_horiz_band' is called by the libavcodec
494 * decoder to draw an horizontal band. It improve cache usage. Not
495 * all codecs can do that. You must check the codec capabilities
496 * before
64863965
MN
497 * - encoding: unused
498 * - decoding: set by user.
3bb07d61
MN
499 * @param height the height of the slice
500 * @param y the y position of the slice
501 * @param type 1->top field, 2->bottom field, 3->frame
502 * @param offset offset into the AVFrame.data from which the slice should be read
b71901e6 503 */
bf89e6b1 504 void (*draw_horiz_band)(struct AVCodecContext *s,
7a06ff14 505 AVFrame *src, int offset[4],
3bb07d61 506 int y, int type, int height);
bf89e6b1 507
de6d9b64 508 /* audio only */
64863965 509 int sample_rate; ///< samples per sec
de6d9b64 510 int channels;
64863965 511 int sample_fmt; ///< sample format, currenly unused
de6d9b64
FB
512
513 /* the following data should not be initialized */
64863965
MN
514 int frame_size; ///< in samples, initialized when calling 'init'
515 int frame_number; ///< audio or video frame number
516 int real_pict_num; ///< returns the real picture number of previous encoded frame
1e491e29 517
b71901e6 518 /**
b71901e6 519 * number of frames the decoded output will be delayed relative to
64863965
MN
520 * the encoded input.
521 * - encoding: set by lavc.
522 * - decoding: unused
b71901e6
MN
523 */
524 int delay;
1ff662cc 525
64863965
MN
526 /* - encoding parameters */
527 float qcompress; ///< amount of qscale change between easy & hard scenes (0.0-1.0)
528 float qblur; ///< amount of qscale smoothing over time (0.0-1.0)
b71901e6
MN
529
530 /**
64863965
MN
531 * minimum quantizer.
532 * - encoding: set by user.
533 * - decoding: unused
b71901e6
MN
534 */
535 int qmin;
536
537 /**
64863965
MN
538 * maximum quantizer.
539 * - encoding: set by user.
540 * - decoding: unused
b71901e6
MN
541 */
542 int qmax;
543
544 /**
64863965
MN
545 * maximum quantizer difference etween frames.
546 * - encoding: set by user.
547 * - decoding: unused
b71901e6
MN
548 */
549 int max_qdiff;
550
551 /**
64863965 552 * maximum number of b frames between non b frames.
b71901e6 553 * note: the output will be delayed by max_b_frames+1 relative to the input
64863965
MN
554 * - encoding: set by user.
555 * - decoding: unused
b71901e6
MN
556 */
557 int max_b_frames;
558
559 /**
64863965
MN
560 * qscale factor between ip and b frames.
561 * - encoding: set by user.
562 * - decoding: unused
b71901e6
MN
563 */
564 float b_quant_factor;
565
566 /** obsolete FIXME remove */
567 int rc_strategy;
8b4c7dbc 568 int b_frame_strategy;
9dbcbd92 569
b71901e6 570 /**
64863965
MN
571 * hurry up amount.
572 * - encoding: unused
573 * - decoding: set by user. 1-> skip b frames, 2-> skip idct/dequant too, 5-> skip everything except header
b71901e6
MN
574 */
575 int hurry_up;
2417652e 576
de6d9b64 577 struct AVCodec *codec;
b71901e6 578
de6d9b64
FB
579 void *priv_data;
580
644d98a4 581 /* The following data is for RTP friendly coding */
1f6b6e50 582 /* By now only H.263/H.263+/MPEG4 coder honours this */
644d98a4
J
583 int rtp_mode; /* 1 for activate RTP friendly-mode */
584 /* highers numbers represent more error-prone */
585 /* enviroments, by now just "1" exist */
586
587 int rtp_payload_size; /* The size of the RTP payload, the coder will */
588 /* do it's best to deliver a chunk with size */
589 /* below rtp_payload_size, the chunk will start */
590 /* with a start code on some codecs like H.263 */
591 /* This doesn't take account of any particular */
592 /* headers inside the transmited RTP payload */
81401c1f
J
593
594
595 /* The RTP callcack: This function is called */
596 /* every time the encoder as a packet to send */
597 /* Depends on the encoder if the data starts */
598 /* with a Start Code (it should) H.263 does */
599 void (*rtp_callback)(void *data, int size, int packet_number);
600
098eefe1
MN
601 /* statistics, used for 2-pass encoding */
602 int mv_bits;
603 int header_bits;
604 int i_tex_bits;
605 int p_tex_bits;
606 int i_count;
607 int p_count;
608 int skip_count;
b71901e6
MN
609 int misc_bits;
610
611 /**
64863965
MN
612 * number of bits used for the previously encoded frame.
613 * - encoding: set by lavc
7004ffb3 614 * - decoding: unused
b71901e6 615 */
098eefe1 616 int frame_bits;
7004ffb3 617
b71901e6 618 /**
64863965
MN
619 * private data of the user, can be used to carry app specific stuff.
620 * - encoding: set by user
621 * - decoding: set by user
b71901e6
MN
622 */
623 void *opaque;
624
de6d9b64 625 char codec_name[32];
4a663d80
PG
626 enum CodecType codec_type; /* see CODEC_TYPE_xxx */
627 enum CodecID codec_id; /* see CODEC_ID_xxx */
7004ffb3
MN
628
629 /**
630 * fourcc (LSB first, so "ABCD" -> ('D'<<24) + ('C'<<16) + ('B'<<8) + 'A').
631 * this is used to workaround some encoder bugs
bd5a6020 632 * - encoding: set by user, if not then the default based on codec_id will be used
7004ffb3
MN
633 * - decoding: set by user, will be converted to upper case by lavc during init
634 */
635 unsigned int codec_tag;
92ba5ffb 636
b71901e6 637 /**
64863965
MN
638 * workaround bugs in encoders which sometimes cannot be detected automatically.
639 * - encoding: unused
640 * - decoding: set by user
b71901e6
MN
641 */
642 int workaround_bugs;
64863965 643#define FF_BUG_AUTODETECT 1 ///< autodetection
4d2858de
MN
644#define FF_BUG_OLD_MSMPEG4 2
645#define FF_BUG_XVID_ILACE 4
646#define FF_BUG_UMP4 8
647#define FF_BUG_NO_PADDING 16
648#define FF_BUG_AC_VLC 32
03e93d35 649#define FF_BUG_QPEL_CHROMA 64
db794953 650#define FF_BUG_STD_QPEL 128
36df8805 651#define FF_BUG_QPEL_CHROMA2 256
c40c3482 652#define FF_BUG_DIRECT_BLOCKSIZE 512
1c6dcb0f 653#define FF_BUG_EDGE 1024
4d2858de
MN
654//#define FF_BUG_FAKE_SCALABILITY 16 //autodetection should work 100%
655
b71901e6 656 /**
64863965
MN
657 * luma single coeff elimination threshold.
658 * - encoding: set by user
659 * - decoding: unused
b71901e6 660 */
1f6b6e50 661 int luma_elim_threshold;
b71901e6
MN
662
663 /**
64863965
MN
664 * chroma single coeff elimination threshold.
665 * - encoding: set by user
666 * - decoding: unused
b71901e6 667 */
1f6b6e50 668 int chroma_elim_threshold;
b71901e6
MN
669
670 /**
64863965
MN
671 * strictly follow the std (MPEG4, ...).
672 * - encoding: set by user
673 * - decoding: unused
b71901e6
MN
674 */
675 int strict_std_compliance;
676
677 /**
64863965 678 * qscale offset between ip and b frames.
b3a391e8
MN
679 * if > 0 then the last p frame quantizer will be used (q= lastp_q*factor+offset)
680 * if < 0 then normal ratecontrol will be done (q= -normal_q*factor+offset)
64863965
MN
681 * - encoding: set by user.
682 * - decoding: unused
b71901e6
MN
683 */
684 float b_quant_offset;
685
686 /**
ce3bcaed 687 * error resilience higher values will detect more errors but may missdetect
64863965
MN
688 * some more or less valid parts as errors.
689 * - encoding: unused
690 * - decoding: set by user
b71901e6 691 */
1f6b6e50 692 int error_resilience;
ce3bcaed
MN
693#define FF_ER_CAREFULL 1
694#define FF_ER_COMPLIANT 2
695#define FF_ER_AGGRESSIVE 3
696#define FF_ER_VERY_AGGRESSIVE 4
ae72cda6 697
6b72ac63 698 /**
1e491e29
MN
699 * called at the beginning of each frame to get a buffer for it.
700 * if pic.reference is set then the frame will be read later by lavc
3bb07d61 701 * width and height should be rounded up to the next multiple of 16
64863965
MN
702 * - encoding: unused
703 * - decoding: set by lavc, user can override
b71901e6 704 */
492cd3a9 705 int (*get_buffer)(struct AVCodecContext *c, AVFrame *pic);
b71901e6
MN
706
707 /**
1e491e29
MN
708 * called to release buffers which where allocated with get_buffer.
709 * a released buffer can be reused in get_buffer()
710 * pic.data[*] must be set to NULL
64863965
MN
711 * - encoding: unused
712 * - decoding: set by lavc, user can override
b71901e6 713 */
492cd3a9 714 void (*release_buffer)(struct AVCodecContext *c, AVFrame *pic);
0fd90455 715
b71901e6 716 /**
64863965
MN
717 * is 1 if the decoded stream contains b frames, 0 otherwise.
718 * - encoding: unused
719 * - decoding: set by lavc
b71901e6
MN
720 */
721 int has_b_frames;
b71901e6 722
64863965 723 int block_align; ///< used by some WAV based audio codecs
ce980a95 724
64863965 725 int parse_only; /* - decoding only: if true, only parsing is done
917e06c8
FB
726 (function avcodec_parse_frame()). The frame
727 data is returned. Only MPEG codecs support this now. */
ce980a95 728
b71901e6 729 /**
e4eadb4b 730 * 0-> h263 quant 1-> mpeg quant.
64863965
MN
731 * - encoding: set by user.
732 * - decoding: unused
b71901e6
MN
733 */
734 int mpeg_quant;
ce980a95 735
b71901e6 736 /**
64863965
MN
737 * pass1 encoding statistics output buffer.
738 * - encoding: set by lavc
739 * - decoding: unused
b71901e6 740 */
64863965 741 char *stats_out;
b71901e6
MN
742
743 /**
744 * pass2 encoding statistics input buffer.
745 * concatenated stuff from stats_out of pass1 should be placed here
64863965
MN
746 * - encoding: allocated/set/freed by user
747 * - decoding: unused
b71901e6
MN
748 */
749 char *stats_in;
750
751 /**
64863965 752 * ratecontrol qmin qmax limiting method.
b71901e6 753 * 0-> clipping, 1-> use a nice continous function to limit qscale wthin qmin/qmax
64863965
MN
754 * - encoding: set by user.
755 * - decoding: unused
b71901e6 756 */
ce980a95 757 float rc_qsquish;
b71901e6 758
ce980a95
MN
759 float rc_qmod_amp;
760 int rc_qmod_freq;
b71901e6
MN
761
762 /**
64863965
MN
763 * ratecontrol override, see RcOverride.
764 * - encoding: allocated/set/freed by user.
765 * - decoding: unused
b71901e6 766 */
ce980a95
MN
767 RcOverride *rc_override;
768 int rc_override_count;
b71901e6
MN
769
770 /**
64863965
MN
771 * rate control equation.
772 * - encoding: set by user
773 * - decoding: unused
b71901e6 774 */
ce980a95 775 char *rc_eq;
b71901e6
MN
776
777 /**
64863965
MN
778 * maximum bitrate.
779 * - encoding: set by user.
780 * - decoding: unused
b71901e6 781 */
ce980a95 782 int rc_max_rate;
b71901e6
MN
783
784 /**
64863965
MN
785 * minimum bitrate.
786 * - encoding: set by user.
787 * - decoding: unused
b71901e6 788 */
ce980a95 789 int rc_min_rate;
b71901e6
MN
790
791 /**
64863965
MN
792 * decoder bitstream buffer size.
793 * - encoding: set by user.
794 * - decoding: unused
b71901e6 795 */
ce980a95
MN
796 int rc_buffer_size;
797 float rc_buffer_aggressivity;
b71901e6
MN
798
799 /**
64863965
MN
800 * qscale factor between p and i frames.
801 * - encoding: set by user.
802 * - decoding: unused
b71901e6
MN
803 */
804 float i_quant_factor;
805
806 /**
64863965 807 * qscale offset between p and i frames.
b3a391e8
MN
808 * if > 0 then the last p frame quantizer will be used (q= lastp_q*factor+offset)
809 * if < 0 then normal ratecontrol will be done (q= -normal_q*factor+offset)
64863965
MN
810 * - encoding: set by user.
811 * - decoding: unused
b71901e6
MN
812 */
813 float i_quant_offset;
814
815 /**
64863965
MN
816 * initial complexity for pass1 ratecontrol.
817 * - encoding: set by user.
818 * - decoding: unused
b71901e6 819 */
ce980a95 820 float rc_initial_cplx;
917e06c8 821
b71901e6 822 /**
64863965
MN
823 * dct algorithm, see FF_DCT_* below.
824 * - encoding: set by user
825 * - decoding: unused
b71901e6 826 */
28db7fce 827 int dct_algo;
c7e07931 828#define FF_DCT_AUTO 0
28db7fce 829#define FF_DCT_FASTINT 1
c7e07931
MO
830#define FF_DCT_INT 2
831#define FF_DCT_MMX 3
832#define FF_DCT_MLIB 4
05c4072b 833#define FF_DCT_ALTIVEC 5
c5d309f2
MN
834
835 /**
64863965
MN
836 * luminance masking (0-> disabled).
837 * - encoding: set by user
838 * - decoding: unused
c5d309f2
MN
839 */
840 float lumi_masking;
841
842 /**
64863965
MN
843 * temporary complexity masking (0-> disabled).
844 * - encoding: set by user
845 * - decoding: unused
c5d309f2
MN
846 */
847 float temporal_cplx_masking;
848
849 /**
64863965
MN
850 * spatial complexity masking (0-> disabled).
851 * - encoding: set by user
852 * - decoding: unused
c5d309f2
MN
853 */
854 float spatial_cplx_masking;
855
856 /**
64863965
MN
857 * p block masking (0-> disabled).
858 * - encoding: set by user
859 * - decoding: unused
c5d309f2
MN
860 */
861 float p_masking;
15415af4 862
5e746b99 863 /**
64863965
MN
864 * darkness masking (0-> disabled).
865 * - encoding: set by user
866 * - decoding: unused
5e746b99
MN
867 */
868 float dark_masking;
0c2dd16e 869
3a694b04
NK
870
871 /* for binary compatibility */
872 int unused;
873
0c2dd16e 874 /**
64863965
MN
875 * idct algorithm, see FF_IDCT_* below.
876 * - encoding: set by user
877 * - decoding: set by user
2ad1516a
MN
878 */
879 int idct_algo;
880#define FF_IDCT_AUTO 0
881#define FF_IDCT_INT 1
882#define FF_IDCT_SIMPLE 2
883#define FF_IDCT_SIMPLEMMX 3
884#define FF_IDCT_LIBMPEG2MMX 4
885#define FF_IDCT_PS2 5
886#define FF_IDCT_MLIB 6
887#define FF_IDCT_ARM 7
05c4072b 888#define FF_IDCT_ALTIVEC 8
b82cdc72 889#define FF_IDCT_SH4 9
bd7d1ea7 890#define FF_IDCT_SIMPLEARM 10
2ad1516a 891
144f0625 892 /**
64863965
MN
893 * slice count.
894 * - encoding: set by lavc
895 * - decoding: set by user (or 0)
144f0625
MN
896 */
897 int slice_count;
898 /**
64863965
MN
899 * slice offsets in the frame in bytes.
900 * - encoding: set/allocated by lavc
901 * - decoding: set/allocated by user (or NULL)
144f0625
MN
902 */
903 int *slice_offset;
904
4d2858de 905 /**
64863965
MN
906 * error concealment flags.
907 * - encoding: unused
908 * - decoding: set by user
4d2858de
MN
909 */
910 int error_concealment;
911#define FF_EC_GUESS_MVS 1
912#define FF_EC_DEBLOCK 2
913
6b72ac63 914 /**
bec89a84 915 * dsp_mask could be add used to disable unwanted CPU features
8350df97 916 * CPU features (i.e. MMX, SSE. ...)
bec89a84
ZK
917 *
918 * with FORCE flag you may instead enable given CPU features
919 * (Dangerous: usable in case of misdetection, improper usage however will
920 * result into program crash)
921 */
922 unsigned dsp_mask;
923#define FF_MM_FORCE 0x80000000 /* force usage of selected flags (OR) */
924 /* lower 16 bits - CPU features */
925#ifdef HAVE_MMX
926#define FF_MM_MMX 0x0001 /* standard MMX */
927#define FF_MM_3DNOW 0x0004 /* AMD 3DNOW */
928#define FF_MM_MMXEXT 0x0002 /* SSE integer functions or AMD MMX ext */
929#define FF_MM_SSE 0x0008 /* SSE functions */
930#define FF_MM_SSE2 0x0010 /* PIV SSE2 functions */
931#endif /* HAVE_MMX */
11f18faf
MN
932
933 /**
64863965
MN
934 * bits per sample/pixel from the demuxer (needed for huffyuv).
935 * - encoding: set by lavc
936 * - decoding: set by user
11f18faf
MN
937 */
938 int bits_per_sample;
939
940 /**
64863965
MN
941 * prediction method (needed for huffyuv).
942 * - encoding: set by user
943 * - decoding: unused
11f18faf
MN
944 */
945 int prediction_method;
946#define FF_PRED_LEFT 0
947#define FF_PRED_PLANE 1
948#define FF_PRED_MEDIAN 2
5d3cea3a
MN
949
950 /**
64863965
MN
951 * aspect ratio (0 if unknown).
952 * - encoding: set by user.
953 * - decoding: set by lavc.
5d3cea3a
MN
954 */
955 float aspect_ratio;
1e491e29
MN
956
957 /**
64863965
MN
958 * the picture in the bitstream.
959 * - encoding: set by lavc
960 * - decoding: set by lavc
1e491e29 961 */
492cd3a9 962 AVFrame *coded_frame;
c8c437bc
MN
963
964 /**
64863965
MN
965 * debug.
966 * - encoding: set by user.
967 * - decoding: set by user.
c8c437bc
MN
968 */
969 int debug;
970#define FF_DEBUG_PICT_INFO 1
971#define FF_DEBUG_RC 2
972#define FF_DEBUG_BITSTREAM 4
973#define FF_DEBUG_MB_TYPE 8
974#define FF_DEBUG_QP 16
975#define FF_DEBUG_MV 32
41773b73
MN
976#define FF_DEBUG_VIS_MV 0x00000040
977#define FF_DEBUG_SKIP 0x00000080
978#define FF_DEBUG_STARTCODE 0x00000100
979#define FF_DEBUG_PTS 0x00000200
46b4feec 980#define FF_DEBUG_ER 0x00000400
0da71265 981#define FF_DEBUG_MMCO 0x00000800
8fc6c2b5 982#define FF_DEBUG_BUGS 0x00001000
140cb663
MN
983
984 /**
64863965
MN
985 * error.
986 * - encoding: set by lavc if flags&CODEC_FLAG_PSNR
987 * - decoding: unused
140cb663
MN
988 */
989 uint64_t error[4];
17a70fde
MN
990
991 /**
64863965
MN
992 * minimum MB quantizer.
993 * - encoding: set by user.
994 * - decoding: unused
17a70fde
MN
995 */
996 int mb_qmin;
997
998 /**
64863965
MN
999 * maximum MB quantizer.
1000 * - encoding: set by user.
1001 * - decoding: unused
17a70fde
MN
1002 */
1003 int mb_qmax;
1457ab52
MN
1004
1005 /**
64863965
MN
1006 * motion estimation compare function.
1007 * - encoding: set by user.
1008 * - decoding: unused
1457ab52
MN
1009 */
1010 int me_cmp;
1011 /**
64863965
MN
1012 * subpixel motion estimation compare function.
1013 * - encoding: set by user.
1014 * - decoding: unused
1457ab52
MN
1015 */
1016 int me_sub_cmp;
1017 /**
64863965
MN
1018 * macroblock compare function (not supported yet).
1019 * - encoding: set by user.
1020 * - decoding: unused
1457ab52
MN
1021 */
1022 int mb_cmp;
1023#define FF_CMP_SAD 0
1024#define FF_CMP_SSE 1
1025#define FF_CMP_SATD 2
1026#define FF_CMP_DCT 3
1027#define FF_CMP_PSNR 4
1028#define FF_CMP_BIT 5
1029#define FF_CMP_RD 6
1030#define FF_CMP_ZERO 7
1031#define FF_CMP_CHROMA 256
1032
1033 /**
64863965
MN
1034 * ME diamond size & shape.
1035 * - encoding: set by user.
1036 * - decoding: unused
1457ab52
MN
1037 */
1038 int dia_size;
b07a5980
MN
1039
1040 /**
64863965
MN
1041 * amount of previous MV predictors (2a+1 x 2a+1 square).
1042 * - encoding: set by user.
1043 * - decoding: unused
b07a5980
MN
1044 */
1045 int last_predictor_count;
70ac76c0 1046
f5fb6b34 1047 /**
64863965
MN
1048 * pre pass for motion estimation.
1049 * - encoding: set by user.
1050 * - decoding: unused
f5fb6b34
MN
1051 */
1052 int pre_me;
b07a5980 1053
70ac76c0 1054 /**
64863965
MN
1055 * motion estimation pre pass compare function.
1056 * - encoding: set by user.
1057 * - decoding: unused
70ac76c0
MN
1058 */
1059 int me_pre_cmp;
826f429a 1060
70ac76c0 1061 /**
64863965
MN
1062 * ME pre pass diamond size & shape.
1063 * - encoding: set by user.
1064 * - decoding: unused
70ac76c0
MN
1065 */
1066 int pre_dia_size;
1067
826f429a 1068 /**
64863965
MN
1069 * subpel ME quality.
1070 * - encoding: set by user.
1071 * - decoding: unused
826f429a
MN
1072 */
1073 int me_subpel_quality;
1074
a33c7159 1075 /**
64863965 1076 * callback to negotiate the pixelFormat.
a33c7159
MN
1077 * @param fmt is the list of formats which are supported by the codec,
1078 * its terminated by -1 as 0 is a valid format, the formats are ordered by quality
1079 * the first is allways the native one
1080 * @return the choosen format
64863965
MN
1081 * - encoding: unused
1082 * - decoding: set by user, if not set then the native format will always be choosen
a33c7159
MN
1083 */
1084 enum PixelFormat (*get_format)(struct AVCodecContext *s, enum PixelFormat * fmt);
e2f9490e
FB
1085
1086 /**
1087 * DTG active format information (additionnal aspect ratio
1088 * information only used in DVB MPEG2 transport streams). 0 if
1089 * not set.
1090 *
64863965
MN
1091 * - encoding: unused.
1092 * - decoding: set by decoder
e2f9490e
FB
1093 */
1094 int dtg_active_format;
1095#define FF_DTG_AFD_SAME 8
1096#define FF_DTG_AFD_4_3 9
1097#define FF_DTG_AFD_16_9 10
1098#define FF_DTG_AFD_14_9 11
1099#define FF_DTG_AFD_4_3_SP_14_9 13
1100#define FF_DTG_AFD_16_9_SP_14_9 14
1101#define FF_DTG_AFD_SP_4_3 15
1102
ebbcdc9a
MN
1103 /**
1104 * Maximum motion estimation search range in subpel units.
1105 * if 0 then no limit
1106 *
64863965
MN
1107 * - encoding: set by user.
1108 * - decoding: unused.
ebbcdc9a 1109 */
59e0ac8e 1110 int me_range;
ebbcdc9a 1111
65f7062d
MN
1112 /**
1113 * frame_rate_base.
1114 * for variable fps this is 1
1115 * - encoding: set by user.
1116 * - decoding: set by lavc.
1117 * @todo move this after frame_rate
1118 */
65f7062d 1119
1984f635
MN
1120 int frame_rate_base;
1121 /**
1122 * intra quantizer bias.
1123 * - encoding: set by user.
1124 * - decoding: unused
1125 */
1126 int intra_quant_bias;
1127#define FF_DEFAULT_QUANT_BIAS 999999
1128
1129 /**
1130 * inter quantizer bias.
1131 * - encoding: set by user.
1132 * - decoding: unused
1133 */
1134 int inter_quant_bias;
5cd62665
ZK
1135
1136 /**
1137 * color table ID.
1138 * - encoding: unused.
1139 * - decoding: which clrtable should be used for 8bit RGB images
1140 * table have to be stored somewhere FIXME
1141 */
1142 int color_table_id;
1984f635 1143
d90cf87b
MN
1144 /**
1145 * internal_buffer count.
1146 * Dont touch, used by lavc default_get_buffer()
1147 */
1148 int internal_buffer_count;
1149
1150 /**
1151 * internal_buffers.
1152 * Dont touch, used by lavc default_get_buffer()
1153 */
1154 void *internal_buffer;
3d2e8cce
MN
1155
1156#define FF_QUALITY_SCALE 256
1157 /**
1158 * global quality for codecs which cannot change it per frame.
1159 * this should be proportional to MPEG1/2/4 qscale.
1160 * - encoding: set by user.
1161 * - decoding: unused
1162 */
1163 int global_quality;
11e659c2
MN
1164
1165#define FF_CODER_TYPE_VLC 0
1166#define FF_CODER_TYPE_AC 1
1167 /**
1168 * coder type
1169 * - encoding: set by user.
1170 * - decoding: unused
1171 */
1172 int coder_type;
1173
1174 /**
1175 * context model
1176 * - encoding: set by user.
1177 * - decoding: unused
1178 */
1179 int context_model;
3bb07d61
MN
1180
1181 /**
1182 * slice flags
1183 * - encoding: unused
1184 * - decoding: set by user.
1185 */
1186 int slice_flags;
1187#define SLICE_FLAG_CODED_ORDER 0x0001 ///< draw_horiz_band() is called in coded order instead of display
1188#define SLICE_FLAG_ALLOW_FIELD 0x0002 ///< allow draw_horiz_band() with field slices (MPEG2 field pics)
1189#define SLICE_FLAG_ALLOW_PLANE 0x0004 ///< allow draw_horiz_band() with 1 component at a time (SVQ1)
1190
fb364ada
IK
1191 /**
1192 * XVideo Motion Acceleration
1193 * - encoding: forbidden
1194 * - decoding: set by decoder
1195 */
1196 int xvmc_acceleration;
7d1c3fc1
MN
1197
1198 /**
1199 * macroblock decision mode
1200 * - encoding: set by user.
1201 * - decoding: unused
1202 */
1203 int mb_decision;
1204#define FF_MB_DECISION_SIMPLE 0 ///< uses mb_cmp
1205#define FF_MB_DECISION_BITS 1 ///< chooses the one which needs the fewest bits
1206#define FF_MB_DECISION_RD 2 ///< rate distoration
d6eb3c50
MN
1207
1208 /**
1209 * custom intra quantization matrix
1210 * - encoding: set by user, can be NULL
1211 * - decoding: set by lavc
1212 */
1213 uint16_t *intra_matrix;
1214
1215 /**
1216 * custom inter quantization matrix
1217 * - encoding: set by user, can be NULL
1218 * - decoding: set by lavc
1219 */
1220 uint16_t *inter_matrix;
7d1c3fc1 1221
de6d9b64
FB
1222} AVCodecContext;
1223
97d96aaa 1224
64863965
MN
1225/**
1226 * AVOption.
1227 */
97d96aaa
ZK
1228typedef struct AVOption {
1229 /** options' name */
1230 const char *name; /* if name is NULL, it indicates a link to next */
bec89a84
ZK
1231 /** short English text help or const struct AVOption* subpointer */
1232 const char *help; // const struct AVOption* sub;
97d96aaa
ZK
1233 /** offset to context structure where the parsed value should be stored */
1234 int offset;
1235 /** options' type */
1236 int type;
64863965
MN
1237#define FF_OPT_TYPE_BOOL 1 ///< boolean - true,1,on (or simply presence)
1238#define FF_OPT_TYPE_DOUBLE 2 ///< double
1239#define FF_OPT_TYPE_INT 3 ///< integer
1240#define FF_OPT_TYPE_STRING 4 ///< string (finished with \0)
1241#define FF_OPT_TYPE_MASK 0x1f ///< mask for types - upper bits are various flags
97d96aaa
ZK
1242//#define FF_OPT_TYPE_EXPERT 0x20 // flag for expert option
1243#define FF_OPT_TYPE_FLAG (FF_OPT_TYPE_BOOL | 0x40)
1244#define FF_OPT_TYPE_RCOVERRIDE (FF_OPT_TYPE_STRING | 0x80)
1245 /** min value (min == max -> no limits) */
1246 double min;
1247 /** maximum value for double/int */
1248 double max;
1249 /** default boo [0,1]l/double/int value */
1250 double defval;
1251 /**
1252 * default string value (with optional semicolon delimited extra option-list
1253 * i.e. option1;option2;option3
1254 * defval might select other then first argument as default
1255 */
1256 const char *defstr;
97d96aaa
ZK
1257#define FF_OPT_MAX_DEPTH 10
1258} AVOption;
1259
64863965 1260/**
bec89a84
ZK
1261 * Parse option(s) and sets fields in passed structure
1262 * @param strct structure where the parsed results will be written
1263 * @param list list with AVOptions
1264 * @param opts string with options for parsing
1265 */
1266int avoption_parse(void* strct, const AVOption* list, const char* opts);
1267
1268
1269/**
64863965
MN
1270 * AVCodec.
1271 */
de6d9b64 1272typedef struct AVCodec {
18f77016 1273 const char *name;
5d234974 1274 enum CodecType type;
de6d9b64
FB
1275 int id;
1276 int priv_data_size;
1277 int (*init)(AVCodecContext *);
0c1a9eda 1278 int (*encode)(AVCodecContext *, uint8_t *buf, int buf_size, void *data);
de6d9b64 1279 int (*close)(AVCodecContext *);
0fd90455 1280 int (*decode)(AVCodecContext *, void *outdata, int *outdata_size,
0c1a9eda 1281 uint8_t *buf, int buf_size);
bf89e6b1 1282 int capabilities;
97d96aaa 1283 const AVOption *options;
de6d9b64 1284 struct AVCodec *next;
7a06ff14 1285 void (*flush)(AVCodecContext *);
de6d9b64
FB
1286} AVCodec;
1287
97d96aaa 1288/**
d7425f59
MN
1289 * four components are given, that's all.
1290 * the last component is alpha
1291 */
de6d9b64 1292typedef struct AVPicture {
0c1a9eda 1293 uint8_t *data[4];
cd394651 1294 int linesize[4]; ///< number of bytes per line
de6d9b64
FB
1295} AVPicture;
1296
1297extern AVCodec ac3_encoder;
1298extern AVCodec mp2_encoder;
9d36bdc9 1299extern AVCodec mp3lame_encoder;
81e0d0b4 1300extern AVCodec oggvorbis_encoder;
de6d9b64 1301extern AVCodec mpeg1video_encoder;
029911d1 1302extern AVCodec mpeg2video_encoder;
de6d9b64
FB
1303extern AVCodec h263_encoder;
1304extern AVCodec h263p_encoder;
d4f5d74a 1305extern AVCodec flv_encoder;
de6d9b64
FB
1306extern AVCodec rv10_encoder;
1307extern AVCodec mjpeg_encoder;
b1e6b355 1308extern AVCodec ljpeg_encoder;
bf89e6b1 1309extern AVCodec mpeg4_encoder;
84afee34
MN
1310extern AVCodec msmpeg4v1_encoder;
1311extern AVCodec msmpeg4v2_encoder;
1312extern AVCodec msmpeg4v3_encoder;
0151a6f5
MN
1313extern AVCodec wmv1_encoder;
1314extern AVCodec wmv2_encoder;
11f18faf 1315extern AVCodec huffyuv_encoder;
0da71265 1316extern AVCodec h264_encoder;
3d2e8cce 1317extern AVCodec asv1_encoder;
9b56edf5 1318extern AVCodec asv2_encoder;
be3564ed 1319extern AVCodec vcr1_encoder;
5e20f836 1320extern AVCodec ffv1_encoder;
c3bf0288 1321extern AVCodec mdec_encoder;
de6d9b64
FB
1322
1323extern AVCodec h263_decoder;
bf89e6b1 1324extern AVCodec mpeg4_decoder;
84afee34
MN
1325extern AVCodec msmpeg4v1_decoder;
1326extern AVCodec msmpeg4v2_decoder;
1327extern AVCodec msmpeg4v3_decoder;
e1a9dbff 1328extern AVCodec wmv1_decoder;
0151a6f5 1329extern AVCodec wmv2_decoder;
922bc38d
MN
1330extern AVCodec mpeg1video_decoder;
1331extern AVCodec mpeg2video_decoder;
fb364ada 1332extern AVCodec mpeg_xvmc_decoder;
de6d9b64 1333extern AVCodec h263i_decoder;
d4f5d74a 1334extern AVCodec flv_decoder;
de6d9b64 1335extern AVCodec rv10_decoder;
be8ffec9 1336extern AVCodec svq1_decoder;
8b82a956 1337extern AVCodec svq3_decoder;
020fcc94
FB
1338extern AVCodec dvvideo_decoder;
1339extern AVCodec dvaudio_decoder;
bc8d1857
FB
1340extern AVCodec wmav1_decoder;
1341extern AVCodec wmav2_decoder;
4e66ab3b 1342extern AVCodec mjpeg_decoder;
b135d9fb 1343extern AVCodec mjpegb_decoder;
4b1f4f23 1344extern AVCodec mp2_decoder;
a96b68b7 1345extern AVCodec mp3_decoder;
3f95e843
FR
1346extern AVCodec mace3_decoder;
1347extern AVCodec mace6_decoder;
11f18faf 1348extern AVCodec huffyuv_decoder;
3aca208a 1349extern AVCodec oggvorbis_decoder;
f70f7c6d 1350extern AVCodec cyuv_decoder;
0da71265 1351extern AVCodec h264_decoder;
deabd4fd 1352extern AVCodec indeo3_decoder;
d86053a4 1353extern AVCodec vp3_decoder;
891f64b3 1354extern AVCodec amr_nb_decoder;
bc634f6f 1355extern AVCodec amr_nb_encoder;
280bd7b7
ZK
1356extern AVCodec aac_decoder;
1357extern AVCodec mpeg4aac_decoder;
3d2e8cce 1358extern AVCodec asv1_decoder;
9b56edf5 1359extern AVCodec asv2_decoder;
be3564ed 1360extern AVCodec vcr1_decoder;
3aff069b 1361extern AVCodec cljr_decoder;
5e20f836 1362extern AVCodec ffv1_decoder;
8809cfee 1363extern AVCodec fourxm_decoder;
c3bf0288 1364extern AVCodec mdec_decoder;
3ef8be2b
MM
1365extern AVCodec roq_decoder;
1366extern AVCodec interplay_video_decoder;
9937e686 1367extern AVCodec xan_wc3_decoder;
b8414bbd
NK
1368extern AVCodec ra_144_decoder;
1369extern AVCodec ra_288_decoder;
3ef8be2b
MM
1370extern AVCodec roq_dpcm_decoder;
1371extern AVCodec interplay_dpcm_decoder;
9937e686 1372extern AVCodec xan_dpcm_decoder;
de6d9b64 1373
a96b68b7
FB
1374/* pcm codecs */
1375#define PCM_CODEC(id, name) \
1376extern AVCodec name ## _decoder; \
f11d3f23 1377extern AVCodec name ## _encoder
a96b68b7
FB
1378
1379PCM_CODEC(CODEC_ID_PCM_S16LE, pcm_s16le);
1380PCM_CODEC(CODEC_ID_PCM_S16BE, pcm_s16be);
1381PCM_CODEC(CODEC_ID_PCM_U16LE, pcm_u16le);
1382PCM_CODEC(CODEC_ID_PCM_U16BE, pcm_u16be);
1383PCM_CODEC(CODEC_ID_PCM_S8, pcm_s8);
1384PCM_CODEC(CODEC_ID_PCM_U8, pcm_u8);
1385PCM_CODEC(CODEC_ID_PCM_ALAW, pcm_alaw);
1386PCM_CODEC(CODEC_ID_PCM_MULAW, pcm_mulaw);
1387
0147f198
FR
1388/* adpcm codecs */
1389
1390PCM_CODEC(CODEC_ID_ADPCM_IMA_QT, adpcm_ima_qt);
1391PCM_CODEC(CODEC_ID_ADPCM_IMA_WAV, adpcm_ima_wav);
9937e686
MM
1392PCM_CODEC(CODEC_ID_ADPCM_IMA_DK3, adpcm_ima_dk3);
1393PCM_CODEC(CODEC_ID_ADPCM_IMA_DK4, adpcm_ima_dk4);
0147f198 1394PCM_CODEC(CODEC_ID_ADPCM_MS, adpcm_ms);
4b465299 1395PCM_CODEC(CODEC_ID_ADPCM_4XM, adpcm_4xm);
0147f198 1396
a96b68b7
FB
1397#undef PCM_CODEC
1398
1399/* dummy raw video codec */
63167088
RS
1400extern AVCodec rawvideo_encoder;
1401extern AVCodec rawvideo_decoder;
de6d9b64
FB
1402
1403/* the following codecs use external GPL libs */
de6d9b64
FB
1404extern AVCodec ac3_decoder;
1405
1406/* resample.c */
1407
1408struct ReSampleContext;
1409
1410typedef struct ReSampleContext ReSampleContext;
1411
1412ReSampleContext *audio_resample_init(int output_channels, int input_channels,
1413 int output_rate, int input_rate);
1414int audio_resample(ReSampleContext *s, short *output, short *input, int nb_samples);
1415void audio_resample_close(ReSampleContext *s);
1416
1417/* YUV420 format is assumed ! */
1418
1419struct ImgReSampleContext;
1420
1421typedef struct ImgReSampleContext ImgReSampleContext;
1422
1423ImgReSampleContext *img_resample_init(int output_width, int output_height,
1424 int input_width, int input_height);
ab6d194a
MN
1425
1426ImgReSampleContext *img_resample_full_init(int owidth, int oheight,
1427 int iwidth, int iheight,
1428 int topBand, int bottomBand,
1429 int leftBand, int rightBand);
1430
de6d9b64
FB
1431void img_resample(ImgReSampleContext *s,
1432 AVPicture *output, AVPicture *input);
1433
1434void img_resample_close(ImgReSampleContext *s);
1435
0c1a9eda 1436int avpicture_fill(AVPicture *picture, uint8_t *ptr,
2d1a4094 1437 int pix_fmt, int width, int height);
63167088
RS
1438int avpicture_layout(AVPicture* src, int pix_fmt, int width, int height,
1439 unsigned char *dest, int dest_size);
219b06c6 1440int avpicture_get_size(int pix_fmt, int width, int height);
dab64ebc
FB
1441void avcodec_get_chroma_sub_sample(int pix_fmt, int *h_shift, int *v_shift);
1442const char *avcodec_get_pix_fmt_name(int pix_fmt);
63167088 1443enum PixelFormat avcodec_get_pix_fmt(const char* name);
219b06c6 1444
fab21997
FB
1445#define FF_LOSS_RESOLUTION 0x0001 /* loss due to resolution change */
1446#define FF_LOSS_DEPTH 0x0002 /* loss due to color depth change */
1447#define FF_LOSS_COLORSPACE 0x0004 /* loss due to color space conversion */
1448#define FF_LOSS_ALPHA 0x0008 /* loss of alpha bits */
1449#define FF_LOSS_COLORQUANT 0x0010 /* loss due to color quantization */
1450#define FF_LOSS_CHROMA 0x0020 /* loss of chroma (e.g. rgb to gray conversion) */
1451
1452int avcodec_get_pix_fmt_loss(int dst_pix_fmt, int src_pix_fmt,
1453 int has_alpha);
1454int avcodec_find_best_pix_fmt(int pix_fmt_mask, int src_pix_fmt,
1455 int has_alpha, int *loss_ptr);
1456
0469baf1
FB
1457#define FF_ALPHA_TRANSP 0x0001 /* image has some totally transparent pixels */
1458#define FF_ALPHA_SEMI_TRANSP 0x0002 /* image has some transparent pixels */
1459int img_get_alpha_info(AVPicture *src, int pix_fmt, int width, int height);
1460
219b06c6
FB
1461/* convert among pixel formats */
1462int img_convert(AVPicture *dst, int dst_pix_fmt,
1463 AVPicture *src, int pix_fmt,
1464 int width, int height);
1465
1466/* deinterlace a picture */
1467int avpicture_deinterlace(AVPicture *dst, AVPicture *src,
de6d9b64
FB
1468 int pix_fmt, int width, int height);
1469
1470/* external high level API */
1471
1472extern AVCodec *first_avcodec;
1473
156e5023 1474/* returns LIBAVCODEC_VERSION_INT constant */
51a49663 1475unsigned avcodec_version(void);
8bceb6af 1476/* returns LIBAVCODEC_BUILD constant */
51a49663 1477unsigned avcodec_build(void);
de6d9b64
FB
1478void avcodec_init(void);
1479
1480void register_avcodec(AVCodec *format);
1481AVCodec *avcodec_find_encoder(enum CodecID id);
98f3b098 1482AVCodec *avcodec_find_encoder_by_name(const char *name);
de6d9b64
FB
1483AVCodec *avcodec_find_decoder(enum CodecID id);
1484AVCodec *avcodec_find_decoder_by_name(const char *name);
1485void avcodec_string(char *buf, int buf_size, AVCodecContext *enc, int encode);
1486
1e491e29 1487void avcodec_get_context_defaults(AVCodecContext *s);
7ffbb60e 1488AVCodecContext *avcodec_alloc_context(void);
492cd3a9 1489AVFrame *avcodec_alloc_frame(void);
1e491e29 1490
492cd3a9
MN
1491int avcodec_default_get_buffer(AVCodecContext *s, AVFrame *pic);
1492void avcodec_default_release_buffer(AVCodecContext *s, AVFrame *pic);
d90cf87b 1493void avcodec_default_free_buffers(AVCodecContext *s);
1e491e29 1494
7a06ff14
MN
1495/**
1496 * opens / inits the AVCodecContext.
1497 * not thread save!
1498 */
de6d9b64 1499int avcodec_open(AVCodecContext *avctx, AVCodec *codec);
7a06ff14 1500
0c1a9eda 1501int avcodec_decode_audio(AVCodecContext *avctx, int16_t *samples,
de6d9b64 1502 int *frame_size_ptr,
0c1a9eda 1503 uint8_t *buf, int buf_size);
492cd3a9 1504int avcodec_decode_video(AVCodecContext *avctx, AVFrame *picture,
de6d9b64 1505 int *got_picture_ptr,
0c1a9eda
ZK
1506 uint8_t *buf, int buf_size);
1507int avcodec_parse_frame(AVCodecContext *avctx, uint8_t **pdata,
917e06c8 1508 int *data_size_ptr,
0c1a9eda
ZK
1509 uint8_t *buf, int buf_size);
1510int avcodec_encode_audio(AVCodecContext *avctx, uint8_t *buf, int buf_size,
de6d9b64 1511 const short *samples);
0c1a9eda 1512int avcodec_encode_video(AVCodecContext *avctx, uint8_t *buf, int buf_size,
492cd3a9 1513 const AVFrame *pict);
de6d9b64
FB
1514
1515int avcodec_close(AVCodecContext *avctx);
1516
1517void avcodec_register_all(void);
a96b68b7 1518
1c2a8c7f
MN
1519void avcodec_flush_buffers(AVCodecContext *avctx);
1520
14bea432 1521/* misc usefull functions */
d8085ea7
MN
1522
1523/**
1524 * returns a single letter to describe the picture type
1525 */
1526char av_get_pict_type_char(int pict_type);
1527
14bea432
MN
1528/**
1529 * reduce a fraction.
1530 * this is usefull for framerate calculations
1531 * @param max the maximum allowed for dst_nom & dst_den
1532 * @return 1 if exact, 0 otherwise
1533 */
1534int av_reduce(int *dst_nom, int *dst_den, int64_t nom, int64_t den, int64_t max);
1535
1536/**
1537 * rescale a 64bit integer.
1538 * a simple a*b/c isnt possible as it can overflow
1539 */
1540int64_t av_rescale(int64_t a, int b, int c);
628d601b 1541
628d601b 1542
e8f14793
ZK
1543/**
1544 * Interface for 0.5.0 version
1545 *
1546 * do not even think about it's usage for this moment
1547 */
1548
1549typedef struct {
64863965 1550 /// compressed size used from given memory buffer
e8f14793
ZK
1551 int size;
1552 /// I/P/B frame type
1553 int frame_type;
1554} avc_enc_result_t;
1555
1556/**
1557 * Commands
1558 * order can't be changed - once it was defined
1559 */
1560typedef enum {
1561 // general commands
1562 AVC_OPEN_BY_NAME = 0xACA000,
1563 AVC_OPEN_BY_CODEC_ID,
1564 AVC_OPEN_BY_FOURCC,
1565 AVC_CLOSE,
1566
1567 AVC_FLUSH,
1568 // pin - struct { uint8_t* src, uint_t src_size }
1569 // pout - struct { AVPicture* img, consumed_bytes,
1570 AVC_DECODE,
1571 // pin - struct { AVPicture* img, uint8_t* dest, uint_t dest_size }
1572 // pout - uint_t used_from_dest_size
1573 AVC_ENCODE,
1574
1575 // query/get video commands
1576 AVC_GET_VERSION = 0xACB000,
1577 AVC_GET_WIDTH,
1578 AVC_GET_HEIGHT,
1579 AVC_GET_DELAY,
1580 AVC_GET_QUANT_TABLE,
1581 // ...
1582
1583 // query/get audio commands
1584 AVC_GET_FRAME_SIZE = 0xABC000,
1585
1586 // maybe define some simple structure which
1587 // might be passed to the user - but they can't
1588 // contain any codec specific parts and these
1589 // calls are usualy necessary only few times
1590
1591 // set video commands
1592 AVC_SET_WIDTH = 0xACD000,
1593 AVC_SET_HEIGHT,
1594
1595 // set video encoding commands
1596 AVC_SET_FRAME_RATE = 0xACD800,
1597 AVC_SET_QUALITY,
1598 AVC_SET_HURRY_UP,
1599
1600 // set audio commands
1601 AVC_SET_SAMPLE_RATE = 0xACE000,
1602 AVC_SET_CHANNELS,
1603
1604} avc_cmd_t;
1605
1606/**
1607 * \param handle allocated private structure by libavcodec
1608 * for initialization pass NULL - will be returned pout
1609 * user is supposed to know nothing about its structure
1610 * \param cmd type of operation to be performed
1611 * \param pint input parameter
1612 * \param pout output parameter
1613 *
1614 * \returns command status - eventually for query command it might return
1615 * integer resulting value
1616 */
1617int avcodec(void* handle, avc_cmd_t cmd, void* pin, void* pout);
1618
544eb99c 1619/* memory */
e4eadb4b 1620void *av_malloc(unsigned int size);
18f77016 1621void *av_mallocz(unsigned int size);
8e1e6f31 1622void *av_realloc(void *ptr, unsigned int size);
544eb99c 1623void av_free(void *ptr);
8e1e6f31 1624char *av_strdup(const char *s);
544eb99c
FB
1625void __av_freep(void **ptr);
1626#define av_freep(p) __av_freep((void **)(p))
97d96aaa 1627void *av_fast_realloc(void *ptr, unsigned int *size, unsigned int min_size);
855ea723
ZK
1628/* for static data only */
1629/* call av_free_static to release all staticaly allocated tables */
628d601b 1630void av_free_static(void);
855ea723
ZK
1631void *__av_mallocz_static(void** location, unsigned int size);
1632#define av_mallocz_static(p, s) __av_mallocz_static((void **)(p), s)
544eb99c 1633
02d697aa
ZK
1634#ifdef __cplusplus
1635}
1636#endif
1637
a96b68b7 1638#endif /* AVCODEC_H */