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