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