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