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