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