exported mpa_decode_header for new parser API
[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"
074c4ca7 19#define LIBAVCODEC_BUILD 4691
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,
1dc1ed99 86 CODEC_ID_8BPS,
11e29a41 87 CODEC_ID_SMC,
a96b68b7
FB
88
89 /* various pcm "codecs" */
90 CODEC_ID_PCM_S16LE,
91 CODEC_ID_PCM_S16BE,
92 CODEC_ID_PCM_U16LE,
93 CODEC_ID_PCM_U16BE,
94 CODEC_ID_PCM_S8,
95 CODEC_ID_PCM_U8,
96 CODEC_ID_PCM_MULAW,
97 CODEC_ID_PCM_ALAW,
0147f198
FR
98
99 /* various adpcm codecs */
100 CODEC_ID_ADPCM_IMA_QT,
101 CODEC_ID_ADPCM_IMA_WAV,
9937e686
MM
102 CODEC_ID_ADPCM_IMA_DK3,
103 CODEC_ID_ADPCM_IMA_DK4,
2fdf638b 104 CODEC_ID_ADPCM_IMA_WS,
0147f198 105 CODEC_ID_ADPCM_MS,
e2a7bb28 106 CODEC_ID_ADPCM_4XM,
fc384777
MM
107 CODEC_ID_ADPCM_XA,
108 CODEC_ID_ADPCM_ADX,
891f64b3 109
110 /* AMR */
111 CODEC_ID_AMR_NB,
d663a1fd
MN
112 CODEC_ID_AMR_WB,
113
b8414bbd
NK
114 /* RealAudio codecs*/
115 CODEC_ID_RA_144,
116 CODEC_ID_RA_288,
3ef8be2b
MM
117
118 /* various DPCM codecs */
119 CODEC_ID_ROQ_DPCM,
120 CODEC_ID_INTERPLAY_DPCM,
9937e686 121 CODEC_ID_XAN_DPCM,
985180a1
FB
122
123 CODEC_ID_MPEG2TS, /* _FAKE_ codec to indicate a raw MPEG2 transport
124 stream (only used by libavformat) */
de6d9b64 125};
dcedf586
FB
126
127/* CODEC_ID_MP3LAME is absolete */
128#define CODEC_ID_MP3LAME CODEC_ID_MP3
de6d9b64
FB
129
130enum CodecType {
4a663d80 131 CODEC_TYPE_UNKNOWN = -1,
de6d9b64
FB
132 CODEC_TYPE_VIDEO,
133 CODEC_TYPE_AUDIO,
985180a1 134 CODEC_TYPE_DATA,
de6d9b64
FB
135};
136
64863965 137/**
0f371e3e
MM
138 * Pixel format. Notes:
139 *
140 * PIX_FMT_RGBA32 is handled in an endian-specific manner. A RGBA
141 * color is put together as:
142 * (A << 24) | (R << 16) | (G << 8) | B
143 * This is stored as BGRA on little endian CPU architectures and ARGB on
144 * big endian CPUs.
145 *
146 * When the pixel format is palettized RGB (PIX_FMT_PAL8), the palettized
147 * image data is stored in AVFrame.data[0]. The palette is transported in
148 * AVFrame.data[1] and, is 1024 bytes long (256 4-byte entries) and is
149 * formatted the same as in PIX_FMT_RGBA32 described above (i.e., it is
fc384777
MM
150 * also endian-specific). Note also that the individual RGB palette
151 * components stored in AVFrame.data[1] should be in the range 0..255.
152 * This is important as many custom PAL8 video codecs that were designed
153 * to run on the IBM VGA graphics adapter use 6-bit palette components.
64863965 154 */
de6d9b64 155enum PixelFormat {
cd394651
MN
156 PIX_FMT_YUV420P, ///< Planar YUV 4:2:0 (1 Cr & Cb sample per 2x2 Y samples)
157 PIX_FMT_YUV422,
158 PIX_FMT_RGB24, ///< Packed pixel, 3 bytes per pixel, RGBRGB...
159 PIX_FMT_BGR24, ///< Packed pixel, 3 bytes per pixel, BGRBGR...
160 PIX_FMT_YUV422P, ///< Planar YUV 4:2:2 (1 Cr & Cb sample per 2x1 Y samples)
161 PIX_FMT_YUV444P, ///< Planar YUV 4:4:4 (1 Cr & Cb sample per 1x1 Y samples)
0f371e3e 162 PIX_FMT_RGBA32, ///< Packed pixel, 4 bytes per pixel, BGRABGRA..., stored in cpu endianness
cd394651
MN
163 PIX_FMT_YUV410P, ///< Planar YUV 4:1:0 (1 Cr & Cb sample per 4x4 Y samples)
164 PIX_FMT_YUV411P, ///< Planar YUV 4:1:1 (1 Cr & Cb sample per 4x1 Y samples)
64863965
MN
165 PIX_FMT_RGB565, ///< always stored in cpu endianness
166 PIX_FMT_RGB555, ///< always stored in cpu endianness, most significant bit to 1
dab64ebc 167 PIX_FMT_GRAY8,
64863965
MN
168 PIX_FMT_MONOWHITE, ///< 0 is white
169 PIX_FMT_MONOBLACK, ///< 0 is black
170 PIX_FMT_PAL8, ///< 8 bit with RGBA palette
cd394651
MN
171 PIX_FMT_YUVJ420P, ///< Planar YUV 4:2:0 full scale (jpeg)
172 PIX_FMT_YUVJ422P, ///< Planar YUV 4:2:2 full scale (jpeg)
173 PIX_FMT_YUVJ444P, ///< Planar YUV 4:4:4 full scale (jpeg)
fb364ada
IK
174 PIX_FMT_XVMC_MPEG2_MC,///< XVideo Motion Acceleration via common packet passing(xvmc_render.h)
175 PIX_FMT_XVMC_MPEG2_IDCT,
dab64ebc 176 PIX_FMT_NB,
de6d9b64
FB
177};
178
a96b68b7
FB
179/* currently unused, may be used if 24/32 bits samples ever supported */
180enum SampleFormat {
64863965 181 SAMPLE_FMT_S16 = 0, ///< signed 16 bits
a96b68b7
FB
182};
183
de6d9b64 184/* in bytes */
bc8d1857 185#define AVCODEC_MAX_AUDIO_FRAME_SIZE 131072
de6d9b64 186
d7425f59 187/**
cf713bb8
MN
188 * Required number of additionally allocated bytes at the end of the input bitstream for decoding.
189 * this is mainly needed because some optimized bitstream readers read
190 * 32 or 64 bit at once and could read over the end<br>
191 * Note, if the first 23 bits of the additional bytes are not 0 then damaged
192 * MPEG bitstreams could cause overread and segfault
d7425f59
MN
193 */
194#define FF_INPUT_BUFFER_PADDING_SIZE 8
195
e4986da9
J
196/* motion estimation type, EPZS by default */
197enum Motion_Est_ID {
101bea5f 198 ME_ZERO = 1,
e4986da9
J
199 ME_FULL,
200 ME_LOG,
201 ME_PHODS,
202 ME_EPZS,
203 ME_X1
204};
205
ce980a95
MN
206typedef struct RcOverride{
207 int start_frame;
208 int end_frame;
209 int qscale; // if this is 0 then quality_factor will be used instead
210 float quality_factor;
211} RcOverride;
212
101bea5f
J
213/* only for ME compatiblity with old apps */
214extern int motion_estimation_method;
215
e4986da9 216/* ME algos sorted by quality */
8d8c0294 217//FIXME remove IMHO
dc7cb06a
DC
218static const __attribute__((unused)) int Motion_Est_QTab[] =
219 { ME_ZERO, ME_PHODS, ME_LOG, ME_X1, ME_EPZS, ME_FULL };
de6d9b64 220
28db7fce 221
4e00e76b 222#define FF_MAX_B_FRAMES 8
9dbcbd92 223
a949d72e
MN
224/* encoding support
225 these flags can be passed in AVCodecContext.flags before initing
226 Note: note not everything is supported yet
227*/
de6d9b64 228
64863965
MN
229#define CODEC_FLAG_QSCALE 0x0002 ///< use fixed qscale
230#define CODEC_FLAG_4MV 0x0004 ///< 4 MV per MB allowed
231#define CODEC_FLAG_QPEL 0x0010 ///< use qpel MC
232#define CODEC_FLAG_GMC 0x0020 ///< use GMC
ca7d05d5 233#define CODEC_FLAG_MV0 0x0040 ///< always try a MB with MV=<0,0>
64863965 234#define CODEC_FLAG_PART 0x0080 ///< use data partitioning
9dbcbd92
MN
235/* parent program gurantees that the input for b-frame containing streams is not written to
236 for at least s->max_b_frames+1 frames, if this is not set than the input will be copied */
8b4c7dbc 237#define CODEC_FLAG_INPUT_PRESERVED 0x0100
64863965
MN
238#define CODEC_FLAG_PASS1 0x0200 ///< use internal 2pass ratecontrol in first pass mode
239#define CODEC_FLAG_PASS2 0x0400 ///< use internal 2pass ratecontrol in second pass mode
240#define CODEC_FLAG_EXTERN_HUFF 0x1000 ///< use external huffman table (for mjpeg)
241#define CODEC_FLAG_GRAY 0x2000 ///< only decode/encode grayscale
242#define CODEC_FLAG_EMU_EDGE 0x4000///< dont draw edges
243#define CODEC_FLAG_PSNR 0x8000 ///< error[?] variables will be set during encoding
244#define CODEC_FLAG_TRUNCATED 0x00010000 /** input bitstream might be truncated at a random location instead
d7425f59 245 of only at frame boundaries */
64863965
MN
246#define CODEC_FLAG_NORMALIZE_AQP 0x00020000 ///< normalize adaptive quantization
247#define CODEC_FLAG_INTERLACED_DCT 0x00040000 ///< use interlaced dct
3bb07d61 248#define CODEC_FLAG_LOW_DELAY 0x00080000 ///< force low delay
64863965
MN
249#define CODEC_FLAG_ALT_SCAN 0x00100000 ///< use alternate scan
250#define CODEC_FLAG_TRELLIS_QUANT 0x00200000 ///< use trellis quantization
251#define CODEC_FLAG_GLOBAL_HEADER 0x00400000 ///< place global headers in extradata instead of every keyframe
252#define CODEC_FLAG_BITEXACT 0x00800000 ///< use only bitexact stuff (except (i)dct)
21e59552 253/* Fx : Flag for h263+ extra options */
8d8c0294
MN
254#define CODEC_FLAG_H263P_AIC 0x01000000 ///< H263 Advanced intra coding / MPEG4 AC prediction (remove this)
255#define CODEC_FLAG_AC_PRED 0x01000000 ///< H263 Advanced intra coding / MPEG4 AC prediction
64863965 256#define CODEC_FLAG_H263P_UMV 0x02000000 ///< Unlimited motion vector
f2f6134b 257#define CODEC_FLAG_CBP_RD 0x04000000 ///< use rate distortion optimization for cbp
21e59552
MN
258/* For advanced prediction mode, we reuse the 4MV flag */
259/* Unsupported options :
260 * Syntax Arithmetic coding (SAC)
261 * Deblocking filter internal loop
262 * Slice structured
263 * Reference Picture Selection
264 * Independant Segment Decoding
265 * Alternative Inter * VLC
266 * Modified Quantization */
267/* /Fx */
bf89e6b1
FB
268/* codec capabilities */
269
64863965 270#define CODEC_CAP_DRAW_HORIZ_BAND 0x0001 ///< decoder can use draw_horiz_band callback
6814a25c
MN
271/**
272 * Codec uses get_buffer() for allocating buffers.
273 * direct rendering method 1
274 */
275#define CODEC_CAP_DR1 0x0002
917e06c8
FB
276/* if 'parse_only' field is true, then avcodec_parse_frame() can be
277 used */
278#define CODEC_CAP_PARSE_ONLY 0x0004
d7425f59 279#define CODEC_CAP_TRUNCATED 0x0008
074c4ca7
RT
280/*
281 * Codec can use conditional replenishment if available.
282 */
283#define CODEC_CAP_CR 0x0010
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
644d98a4 696 /* The following data is for RTP friendly coding */
1f6b6e50 697 /* By now only H.263/H.263+/MPEG4 coder honours this */
644d98a4
J
698 int rtp_mode; /* 1 for activate RTP friendly-mode */
699 /* highers numbers represent more error-prone */
700 /* enviroments, by now just "1" exist */
701
702 int rtp_payload_size; /* The size of the RTP payload, the coder will */
703 /* do it's best to deliver a chunk with size */
704 /* below rtp_payload_size, the chunk will start */
705 /* with a start code on some codecs like H.263 */
706 /* This doesn't take account of any particular */
707 /* headers inside the transmited RTP payload */
81401c1f
J
708
709
710 /* The RTP callcack: This function is called */
711 /* every time the encoder as a packet to send */
712 /* Depends on the encoder if the data starts */
713 /* with a Start Code (it should) H.263 does */
714 void (*rtp_callback)(void *data, int size, int packet_number);
715
098eefe1
MN
716 /* statistics, used for 2-pass encoding */
717 int mv_bits;
718 int header_bits;
719 int i_tex_bits;
720 int p_tex_bits;
721 int i_count;
722 int p_count;
723 int skip_count;
b71901e6
MN
724 int misc_bits;
725
726 /**
64863965
MN
727 * number of bits used for the previously encoded frame.
728 * - encoding: set by lavc
7004ffb3 729 * - decoding: unused
b71901e6 730 */
098eefe1 731 int frame_bits;
7004ffb3 732
b71901e6 733 /**
64863965
MN
734 * private data of the user, can be used to carry app specific stuff.
735 * - encoding: set by user
736 * - decoding: set by user
b71901e6
MN
737 */
738 void *opaque;
739
de6d9b64 740 char codec_name[32];
4a663d80
PG
741 enum CodecType codec_type; /* see CODEC_TYPE_xxx */
742 enum CodecID codec_id; /* see CODEC_ID_xxx */
7004ffb3
MN
743
744 /**
745 * fourcc (LSB first, so "ABCD" -> ('D'<<24) + ('C'<<16) + ('B'<<8) + 'A').
746 * this is used to workaround some encoder bugs
bd5a6020 747 * - encoding: set by user, if not then the default based on codec_id will be used
7004ffb3
MN
748 * - decoding: set by user, will be converted to upper case by lavc during init
749 */
750 unsigned int codec_tag;
92ba5ffb 751
b71901e6 752 /**
64863965
MN
753 * workaround bugs in encoders which sometimes cannot be detected automatically.
754 * - encoding: unused
755 * - decoding: set by user
b71901e6
MN
756 */
757 int workaround_bugs;
64863965 758#define FF_BUG_AUTODETECT 1 ///< autodetection
4d2858de
MN
759#define FF_BUG_OLD_MSMPEG4 2
760#define FF_BUG_XVID_ILACE 4
761#define FF_BUG_UMP4 8
762#define FF_BUG_NO_PADDING 16
ac0c6638 763#define FF_BUG_AC_VLC 0 ///< will be removed, libavcodec can now handle these non compliant files by default
03e93d35 764#define FF_BUG_QPEL_CHROMA 64
db794953 765#define FF_BUG_STD_QPEL 128
36df8805 766#define FF_BUG_QPEL_CHROMA2 256
c40c3482 767#define FF_BUG_DIRECT_BLOCKSIZE 512
1c6dcb0f 768#define FF_BUG_EDGE 1024
4d2858de
MN
769//#define FF_BUG_FAKE_SCALABILITY 16 //autodetection should work 100%
770
b71901e6 771 /**
64863965
MN
772 * luma single coeff elimination threshold.
773 * - encoding: set by user
774 * - decoding: unused
b71901e6 775 */
1f6b6e50 776 int luma_elim_threshold;
b71901e6
MN
777
778 /**
64863965
MN
779 * chroma single coeff elimination threshold.
780 * - encoding: set by user
781 * - decoding: unused
b71901e6 782 */
1f6b6e50 783 int chroma_elim_threshold;
b71901e6
MN
784
785 /**
64863965
MN
786 * strictly follow the std (MPEG4, ...).
787 * - encoding: set by user
788 * - decoding: unused
b71901e6
MN
789 */
790 int strict_std_compliance;
791
792 /**
64863965 793 * qscale offset between ip and b frames.
b3a391e8
MN
794 * if > 0 then the last p frame quantizer will be used (q= lastp_q*factor+offset)
795 * if < 0 then normal ratecontrol will be done (q= -normal_q*factor+offset)
64863965
MN
796 * - encoding: set by user.
797 * - decoding: unused
b71901e6
MN
798 */
799 float b_quant_offset;
800
801 /**
ce3bcaed 802 * error resilience higher values will detect more errors but may missdetect
64863965
MN
803 * some more or less valid parts as errors.
804 * - encoding: unused
805 * - decoding: set by user
b71901e6 806 */
1f6b6e50 807 int error_resilience;
ce3bcaed
MN
808#define FF_ER_CAREFULL 1
809#define FF_ER_COMPLIANT 2
810#define FF_ER_AGGRESSIVE 3
811#define FF_ER_VERY_AGGRESSIVE 4
ae72cda6 812
6b72ac63 813 /**
1e491e29
MN
814 * called at the beginning of each frame to get a buffer for it.
815 * if pic.reference is set then the frame will be read later by lavc
3bb07d61 816 * width and height should be rounded up to the next multiple of 16
64863965
MN
817 * - encoding: unused
818 * - decoding: set by lavc, user can override
b71901e6 819 */
492cd3a9 820 int (*get_buffer)(struct AVCodecContext *c, AVFrame *pic);
b71901e6
MN
821
822 /**
1e491e29
MN
823 * called to release buffers which where allocated with get_buffer.
824 * a released buffer can be reused in get_buffer()
825 * pic.data[*] must be set to NULL
64863965
MN
826 * - encoding: unused
827 * - decoding: set by lavc, user can override
b71901e6 828 */
492cd3a9 829 void (*release_buffer)(struct AVCodecContext *c, AVFrame *pic);
0fd90455 830
b71901e6 831 /**
64863965
MN
832 * is 1 if the decoded stream contains b frames, 0 otherwise.
833 * - encoding: unused
834 * - decoding: set by lavc
b71901e6
MN
835 */
836 int has_b_frames;
b71901e6 837
64863965 838 int block_align; ///< used by some WAV based audio codecs
ce980a95 839
64863965 840 int parse_only; /* - decoding only: if true, only parsing is done
917e06c8
FB
841 (function avcodec_parse_frame()). The frame
842 data is returned. Only MPEG codecs support this now. */
ce980a95 843
b71901e6 844 /**
e4eadb4b 845 * 0-> h263 quant 1-> mpeg quant.
64863965
MN
846 * - encoding: set by user.
847 * - decoding: unused
b71901e6
MN
848 */
849 int mpeg_quant;
ce980a95 850
b71901e6 851 /**
64863965
MN
852 * pass1 encoding statistics output buffer.
853 * - encoding: set by lavc
854 * - decoding: unused
b71901e6 855 */
64863965 856 char *stats_out;
b71901e6
MN
857
858 /**
859 * pass2 encoding statistics input buffer.
860 * concatenated stuff from stats_out of pass1 should be placed here
64863965
MN
861 * - encoding: allocated/set/freed by user
862 * - decoding: unused
b71901e6
MN
863 */
864 char *stats_in;
865
866 /**
64863965 867 * ratecontrol qmin qmax limiting method.
b71901e6 868 * 0-> clipping, 1-> use a nice continous function to limit qscale wthin qmin/qmax
64863965
MN
869 * - encoding: set by user.
870 * - decoding: unused
b71901e6 871 */
ce980a95 872 float rc_qsquish;
b71901e6 873
ce980a95
MN
874 float rc_qmod_amp;
875 int rc_qmod_freq;
b71901e6
MN
876
877 /**
64863965
MN
878 * ratecontrol override, see RcOverride.
879 * - encoding: allocated/set/freed by user.
880 * - decoding: unused
b71901e6 881 */
ce980a95
MN
882 RcOverride *rc_override;
883 int rc_override_count;
b71901e6
MN
884
885 /**
64863965
MN
886 * rate control equation.
887 * - encoding: set by user
888 * - decoding: unused
b71901e6 889 */
ce980a95 890 char *rc_eq;
b71901e6
MN
891
892 /**
64863965
MN
893 * maximum bitrate.
894 * - encoding: set by user.
895 * - decoding: unused
b71901e6 896 */
ce980a95 897 int rc_max_rate;
b71901e6
MN
898
899 /**
64863965
MN
900 * minimum bitrate.
901 * - encoding: set by user.
902 * - decoding: unused
b71901e6 903 */
ce980a95 904 int rc_min_rate;
b71901e6
MN
905
906 /**
64863965
MN
907 * decoder bitstream buffer size.
908 * - encoding: set by user.
909 * - decoding: unused
b71901e6 910 */
ce980a95
MN
911 int rc_buffer_size;
912 float rc_buffer_aggressivity;
b71901e6
MN
913
914 /**
64863965
MN
915 * qscale factor between p and i frames.
916 * - encoding: set by user.
917 * - decoding: unused
b71901e6
MN
918 */
919 float i_quant_factor;
920
921 /**
64863965 922 * qscale offset between p and i frames.
b3a391e8
MN
923 * if > 0 then the last p frame quantizer will be used (q= lastp_q*factor+offset)
924 * if < 0 then normal ratecontrol will be done (q= -normal_q*factor+offset)
64863965
MN
925 * - encoding: set by user.
926 * - decoding: unused
b71901e6
MN
927 */
928 float i_quant_offset;
929
930 /**
64863965
MN
931 * initial complexity for pass1 ratecontrol.
932 * - encoding: set by user.
933 * - decoding: unused
b71901e6 934 */
ce980a95 935 float rc_initial_cplx;
917e06c8 936
b71901e6 937 /**
64863965
MN
938 * dct algorithm, see FF_DCT_* below.
939 * - encoding: set by user
940 * - decoding: unused
b71901e6 941 */
28db7fce 942 int dct_algo;
c7e07931 943#define FF_DCT_AUTO 0
28db7fce 944#define FF_DCT_FASTINT 1
c7e07931
MO
945#define FF_DCT_INT 2
946#define FF_DCT_MMX 3
947#define FF_DCT_MLIB 4
05c4072b 948#define FF_DCT_ALTIVEC 5
65e4c8c9 949#define FF_DCT_FAAN 6
c5d309f2
MN
950
951 /**
64863965
MN
952 * luminance masking (0-> disabled).
953 * - encoding: set by user
954 * - decoding: unused
c5d309f2
MN
955 */
956 float lumi_masking;
957
958 /**
64863965
MN
959 * temporary complexity masking (0-> disabled).
960 * - encoding: set by user
961 * - decoding: unused
c5d309f2
MN
962 */
963 float temporal_cplx_masking;
964
965 /**
64863965
MN
966 * spatial complexity masking (0-> disabled).
967 * - encoding: set by user
968 * - decoding: unused
c5d309f2
MN
969 */
970 float spatial_cplx_masking;
971
972 /**
64863965
MN
973 * p block masking (0-> disabled).
974 * - encoding: set by user
975 * - decoding: unused
c5d309f2
MN
976 */
977 float p_masking;
15415af4 978
5e746b99 979 /**
64863965
MN
980 * darkness masking (0-> disabled).
981 * - encoding: set by user
982 * - decoding: unused
5e746b99
MN
983 */
984 float dark_masking;
0c2dd16e 985
3a694b04
NK
986
987 /* for binary compatibility */
988 int unused;
989
0c2dd16e 990 /**
64863965
MN
991 * idct algorithm, see FF_IDCT_* below.
992 * - encoding: set by user
993 * - decoding: set by user
2ad1516a
MN
994 */
995 int idct_algo;
996#define FF_IDCT_AUTO 0
997#define FF_IDCT_INT 1
998#define FF_IDCT_SIMPLE 2
999#define FF_IDCT_SIMPLEMMX 3
1000#define FF_IDCT_LIBMPEG2MMX 4
1001#define FF_IDCT_PS2 5
1002#define FF_IDCT_MLIB 6
1003#define FF_IDCT_ARM 7
05c4072b 1004#define FF_IDCT_ALTIVEC 8
b82cdc72 1005#define FF_IDCT_SH4 9
bd7d1ea7 1006#define FF_IDCT_SIMPLEARM 10
2ad1516a 1007
144f0625 1008 /**
64863965
MN
1009 * slice count.
1010 * - encoding: set by lavc
1011 * - decoding: set by user (or 0)
144f0625
MN
1012 */
1013 int slice_count;
1014 /**
64863965
MN
1015 * slice offsets in the frame in bytes.
1016 * - encoding: set/allocated by lavc
1017 * - decoding: set/allocated by user (or NULL)
144f0625
MN
1018 */
1019 int *slice_offset;
1020
4d2858de 1021 /**
64863965
MN
1022 * error concealment flags.
1023 * - encoding: unused
1024 * - decoding: set by user
4d2858de
MN
1025 */
1026 int error_concealment;
1027#define FF_EC_GUESS_MVS 1
1028#define FF_EC_DEBLOCK 2
1029
6b72ac63 1030 /**
bec89a84 1031 * dsp_mask could be add used to disable unwanted CPU features
8350df97 1032 * CPU features (i.e. MMX, SSE. ...)
bec89a84
ZK
1033 *
1034 * with FORCE flag you may instead enable given CPU features
1035 * (Dangerous: usable in case of misdetection, improper usage however will
1036 * result into program crash)
1037 */
1038 unsigned dsp_mask;
1039#define FF_MM_FORCE 0x80000000 /* force usage of selected flags (OR) */
1040 /* lower 16 bits - CPU features */
1041#ifdef HAVE_MMX
1042#define FF_MM_MMX 0x0001 /* standard MMX */
1043#define FF_MM_3DNOW 0x0004 /* AMD 3DNOW */
1044#define FF_MM_MMXEXT 0x0002 /* SSE integer functions or AMD MMX ext */
1045#define FF_MM_SSE 0x0008 /* SSE functions */
1046#define FF_MM_SSE2 0x0010 /* PIV SSE2 functions */
1047#endif /* HAVE_MMX */
11f18faf
MN
1048
1049 /**
64863965
MN
1050 * bits per sample/pixel from the demuxer (needed for huffyuv).
1051 * - encoding: set by lavc
1052 * - decoding: set by user
11f18faf
MN
1053 */
1054 int bits_per_sample;
1055
1056 /**
64863965
MN
1057 * prediction method (needed for huffyuv).
1058 * - encoding: set by user
1059 * - decoding: unused
11f18faf
MN
1060 */
1061 int prediction_method;
1062#define FF_PRED_LEFT 0
1063#define FF_PRED_PLANE 1
1064#define FF_PRED_MEDIAN 2
5d3cea3a
MN
1065
1066 /**
5ff85f1d 1067 * sample aspect ratio (0 if unknown).
64863965
MN
1068 * - encoding: set by user.
1069 * - decoding: set by lavc.
5d3cea3a 1070 */
5ff85f1d 1071 AVRational sample_aspect_ratio;
1e491e29
MN
1072
1073 /**
64863965
MN
1074 * the picture in the bitstream.
1075 * - encoding: set by lavc
1076 * - decoding: set by lavc
1e491e29 1077 */
492cd3a9 1078 AVFrame *coded_frame;
c8c437bc
MN
1079
1080 /**
64863965
MN
1081 * debug.
1082 * - encoding: set by user.
1083 * - decoding: set by user.
c8c437bc
MN
1084 */
1085 int debug;
1086#define FF_DEBUG_PICT_INFO 1
1087#define FF_DEBUG_RC 2
1088#define FF_DEBUG_BITSTREAM 4
1089#define FF_DEBUG_MB_TYPE 8
1090#define FF_DEBUG_QP 16
1091#define FF_DEBUG_MV 32
41773b73
MN
1092#define FF_DEBUG_VIS_MV 0x00000040
1093#define FF_DEBUG_SKIP 0x00000080
1094#define FF_DEBUG_STARTCODE 0x00000100
1095#define FF_DEBUG_PTS 0x00000200
46b4feec 1096#define FF_DEBUG_ER 0x00000400
0da71265 1097#define FF_DEBUG_MMCO 0x00000800
8fc6c2b5 1098#define FF_DEBUG_BUGS 0x00001000
140cb663
MN
1099
1100 /**
64863965
MN
1101 * error.
1102 * - encoding: set by lavc if flags&CODEC_FLAG_PSNR
1103 * - decoding: unused
140cb663
MN
1104 */
1105 uint64_t error[4];
17a70fde
MN
1106
1107 /**
64863965
MN
1108 * minimum MB quantizer.
1109 * - encoding: set by user.
1110 * - decoding: unused
17a70fde
MN
1111 */
1112 int mb_qmin;
1113
1114 /**
64863965
MN
1115 * maximum MB quantizer.
1116 * - encoding: set by user.
1117 * - decoding: unused
17a70fde
MN
1118 */
1119 int mb_qmax;
1457ab52
MN
1120
1121 /**
64863965
MN
1122 * motion estimation compare function.
1123 * - encoding: set by user.
1124 * - decoding: unused
1457ab52
MN
1125 */
1126 int me_cmp;
1127 /**
64863965
MN
1128 * subpixel motion estimation compare function.
1129 * - encoding: set by user.
1130 * - decoding: unused
1457ab52
MN
1131 */
1132 int me_sub_cmp;
1133 /**
64863965
MN
1134 * macroblock compare function (not supported yet).
1135 * - encoding: set by user.
1136 * - decoding: unused
1457ab52
MN
1137 */
1138 int mb_cmp;
1139#define FF_CMP_SAD 0
1140#define FF_CMP_SSE 1
1141#define FF_CMP_SATD 2
1142#define FF_CMP_DCT 3
1143#define FF_CMP_PSNR 4
1144#define FF_CMP_BIT 5
1145#define FF_CMP_RD 6
1146#define FF_CMP_ZERO 7
1147#define FF_CMP_CHROMA 256
1148
1149 /**
64863965
MN
1150 * ME diamond size & shape.
1151 * - encoding: set by user.
1152 * - decoding: unused
1457ab52
MN
1153 */
1154 int dia_size;
b07a5980
MN
1155
1156 /**
64863965
MN
1157 * amount of previous MV predictors (2a+1 x 2a+1 square).
1158 * - encoding: set by user.
1159 * - decoding: unused
b07a5980
MN
1160 */
1161 int last_predictor_count;
70ac76c0 1162
f5fb6b34 1163 /**
64863965
MN
1164 * pre pass for motion estimation.
1165 * - encoding: set by user.
1166 * - decoding: unused
f5fb6b34
MN
1167 */
1168 int pre_me;
b07a5980 1169
70ac76c0 1170 /**
64863965
MN
1171 * motion estimation pre pass compare function.
1172 * - encoding: set by user.
1173 * - decoding: unused
70ac76c0
MN
1174 */
1175 int me_pre_cmp;
826f429a 1176
70ac76c0 1177 /**
64863965
MN
1178 * ME pre pass diamond size & shape.
1179 * - encoding: set by user.
1180 * - decoding: unused
70ac76c0
MN
1181 */
1182 int pre_dia_size;
1183
826f429a 1184 /**
64863965
MN
1185 * subpel ME quality.
1186 * - encoding: set by user.
1187 * - decoding: unused
826f429a
MN
1188 */
1189 int me_subpel_quality;
1190
a33c7159 1191 /**
64863965 1192 * callback to negotiate the pixelFormat.
a33c7159
MN
1193 * @param fmt is the list of formats which are supported by the codec,
1194 * its terminated by -1 as 0 is a valid format, the formats are ordered by quality
1195 * the first is allways the native one
1196 * @return the choosen format
64863965
MN
1197 * - encoding: unused
1198 * - decoding: set by user, if not set then the native format will always be choosen
a33c7159
MN
1199 */
1200 enum PixelFormat (*get_format)(struct AVCodecContext *s, enum PixelFormat * fmt);
e2f9490e
FB
1201
1202 /**
1203 * DTG active format information (additionnal aspect ratio
1204 * information only used in DVB MPEG2 transport streams). 0 if
1205 * not set.
1206 *
64863965
MN
1207 * - encoding: unused.
1208 * - decoding: set by decoder
e2f9490e
FB
1209 */
1210 int dtg_active_format;
1211#define FF_DTG_AFD_SAME 8
1212#define FF_DTG_AFD_4_3 9
1213#define FF_DTG_AFD_16_9 10
1214#define FF_DTG_AFD_14_9 11
1215#define FF_DTG_AFD_4_3_SP_14_9 13
1216#define FF_DTG_AFD_16_9_SP_14_9 14
1217#define FF_DTG_AFD_SP_4_3 15
1218
ebbcdc9a
MN
1219 /**
1220 * Maximum motion estimation search range in subpel units.
1221 * if 0 then no limit
1222 *
64863965
MN
1223 * - encoding: set by user.
1224 * - decoding: unused.
ebbcdc9a 1225 */
59e0ac8e 1226 int me_range;
ebbcdc9a 1227
65f7062d
MN
1228 /**
1229 * frame_rate_base.
1230 * for variable fps this is 1
1231 * - encoding: set by user.
1232 * - decoding: set by lavc.
1233 * @todo move this after frame_rate
1234 */
65f7062d 1235
1984f635
MN
1236 int frame_rate_base;
1237 /**
1238 * intra quantizer bias.
1239 * - encoding: set by user.
1240 * - decoding: unused
1241 */
1242 int intra_quant_bias;
1243#define FF_DEFAULT_QUANT_BIAS 999999
1244
1245 /**
1246 * inter quantizer bias.
1247 * - encoding: set by user.
1248 * - decoding: unused
1249 */
1250 int inter_quant_bias;
5cd62665
ZK
1251
1252 /**
1253 * color table ID.
1254 * - encoding: unused.
1255 * - decoding: which clrtable should be used for 8bit RGB images
1256 * table have to be stored somewhere FIXME
1257 */
1258 int color_table_id;
1984f635 1259
d90cf87b
MN
1260 /**
1261 * internal_buffer count.
1262 * Dont touch, used by lavc default_get_buffer()
1263 */
1264 int internal_buffer_count;
1265
1266 /**
1267 * internal_buffers.
1268 * Dont touch, used by lavc default_get_buffer()
1269 */
1270 void *internal_buffer;
158c7f05
MN
1271
1272#define FF_LAMBDA_SHIFT 7
1273#define FF_LAMBDA_SCALE (1<<FF_LAMBDA_SHIFT)
1274#define FF_QP2LAMBDA 118 ///< factor to convert from H.263 QP to lambda
1275#define FF_LAMBDA_MAX (256*128-1)
1276
1277#define FF_QUALITY_SCALE FF_LAMBDA_SCALE //FIXME maybe remove
3d2e8cce
MN
1278 /**
1279 * global quality for codecs which cannot change it per frame.
1280 * this should be proportional to MPEG1/2/4 qscale.
1281 * - encoding: set by user.
1282 * - decoding: unused
1283 */
1284 int global_quality;
11e659c2
MN
1285
1286#define FF_CODER_TYPE_VLC 0
1287#define FF_CODER_TYPE_AC 1
1288 /**
1289 * coder type
1290 * - encoding: set by user.
1291 * - decoding: unused
1292 */
1293 int coder_type;
1294
1295 /**
1296 * context model
1297 * - encoding: set by user.
1298 * - decoding: unused
1299 */
1300 int context_model;
3bb07d61
MN
1301
1302 /**
1303 * slice flags
1304 * - encoding: unused
1305 * - decoding: set by user.
1306 */
1307 int slice_flags;
1308#define SLICE_FLAG_CODED_ORDER 0x0001 ///< draw_horiz_band() is called in coded order instead of display
1309#define SLICE_FLAG_ALLOW_FIELD 0x0002 ///< allow draw_horiz_band() with field slices (MPEG2 field pics)
1310#define SLICE_FLAG_ALLOW_PLANE 0x0004 ///< allow draw_horiz_band() with 1 component at a time (SVQ1)
1311
fb364ada
IK
1312 /**
1313 * XVideo Motion Acceleration
1314 * - encoding: forbidden
1315 * - decoding: set by decoder
1316 */
1317 int xvmc_acceleration;
7d1c3fc1
MN
1318
1319 /**
1320 * macroblock decision mode
1321 * - encoding: set by user.
1322 * - decoding: unused
1323 */
1324 int mb_decision;
1325#define FF_MB_DECISION_SIMPLE 0 ///< uses mb_cmp
1326#define FF_MB_DECISION_BITS 1 ///< chooses the one which needs the fewest bits
1327#define FF_MB_DECISION_RD 2 ///< rate distoration
d6eb3c50
MN
1328
1329 /**
1330 * custom intra quantization matrix
1331 * - encoding: set by user, can be NULL
1332 * - decoding: set by lavc
1333 */
1334 uint16_t *intra_matrix;
1335
1336 /**
1337 * custom inter quantization matrix
1338 * - encoding: set by user, can be NULL
1339 * - decoding: set by lavc
1340 */
1341 uint16_t *inter_matrix;
7d1c3fc1 1342
541ae140
MN
1343 /**
1344 * fourcc from the AVI stream header (LSB first, so "ABCD" -> ('D'<<24) + ('C'<<16) + ('B'<<8) + 'A').
1345 * this is used to workaround some encoder bugs
1346 * - encoding: unused
1347 * - decoding: set by user, will be converted to upper case by lavc during init
1348 */
1349 unsigned int stream_codec_tag;
05fbd0a2
MN
1350
1351 /**
1352 * scene change detection threshold.
1353 * 0 is default, larger means fewer detected scene changes
1354 * - encoding: set by user.
1355 * - decoding: unused
1356 */
1357 int scenechange_threshold;
158c7f05
MN
1358
1359 /**
1360 * minimum lagrange multipler
1361 * - encoding: set by user.
1362 * - decoding: unused
1363 */
1364 int lmin;
1365
1366 /**
1367 * maximum lagrange multipler
1368 * - encoding: set by user.
1369 * - decoding: unused
1370 */
1371 int lmax;
2a2bbcb0
MM
1372
1373 /**
1374 * Palette control structure
1375 * - encoding: ??? (no palette-enabled encoder yet)
1376 * - decoding: set by user.
1377 */
1378 struct AVPaletteControl *palctrl;
821cb11f
MN
1379
1380 /**
1381 * noise reduction strength
1382 * - encoding: set by user.
1383 * - decoding: unused
1384 */
1385 int noise_reduction;
fa384dcc 1386
074c4ca7
RT
1387 /**
1388 * Conditional replenishment support
1389 * - encoding: unused
1390 * - decoding: set by user, if 1 user can allocate reusable buffers
1391 */
1392 int cr_available;
1393
de6d9b64
FB
1394} AVCodecContext;
1395
97d96aaa 1396
64863965
MN
1397/**
1398 * AVOption.
1399 */
97d96aaa
ZK
1400typedef struct AVOption {
1401 /** options' name */
1402 const char *name; /* if name is NULL, it indicates a link to next */
bec89a84
ZK
1403 /** short English text help or const struct AVOption* subpointer */
1404 const char *help; // const struct AVOption* sub;
97d96aaa
ZK
1405 /** offset to context structure where the parsed value should be stored */
1406 int offset;
1407 /** options' type */
1408 int type;
64863965
MN
1409#define FF_OPT_TYPE_BOOL 1 ///< boolean - true,1,on (or simply presence)
1410#define FF_OPT_TYPE_DOUBLE 2 ///< double
1411#define FF_OPT_TYPE_INT 3 ///< integer
1412#define FF_OPT_TYPE_STRING 4 ///< string (finished with \0)
1413#define FF_OPT_TYPE_MASK 0x1f ///< mask for types - upper bits are various flags
97d96aaa
ZK
1414//#define FF_OPT_TYPE_EXPERT 0x20 // flag for expert option
1415#define FF_OPT_TYPE_FLAG (FF_OPT_TYPE_BOOL | 0x40)
1416#define FF_OPT_TYPE_RCOVERRIDE (FF_OPT_TYPE_STRING | 0x80)
1417 /** min value (min == max -> no limits) */
1418 double min;
1419 /** maximum value for double/int */
1420 double max;
1421 /** default boo [0,1]l/double/int value */
1422 double defval;
1423 /**
1424 * default string value (with optional semicolon delimited extra option-list
1425 * i.e. option1;option2;option3
1426 * defval might select other then first argument as default
1427 */
1428 const char *defstr;
97d96aaa
ZK
1429#define FF_OPT_MAX_DEPTH 10
1430} AVOption;
1431
64863965 1432/**
bec89a84
ZK
1433 * Parse option(s) and sets fields in passed structure
1434 * @param strct structure where the parsed results will be written
1435 * @param list list with AVOptions
1436 * @param opts string with options for parsing
1437 */
1438int avoption_parse(void* strct, const AVOption* list, const char* opts);
1439
1440
1441/**
64863965
MN
1442 * AVCodec.
1443 */
de6d9b64 1444typedef struct AVCodec {
18f77016 1445 const char *name;
5d234974 1446 enum CodecType type;
de6d9b64
FB
1447 int id;
1448 int priv_data_size;
1449 int (*init)(AVCodecContext *);
0c1a9eda 1450 int (*encode)(AVCodecContext *, uint8_t *buf, int buf_size, void *data);
de6d9b64 1451 int (*close)(AVCodecContext *);
0fd90455 1452 int (*decode)(AVCodecContext *, void *outdata, int *outdata_size,
0c1a9eda 1453 uint8_t *buf, int buf_size);
bf89e6b1 1454 int capabilities;
97d96aaa 1455 const AVOption *options;
de6d9b64 1456 struct AVCodec *next;
7a06ff14 1457 void (*flush)(AVCodecContext *);
de6d9b64
FB
1458} AVCodec;
1459
97d96aaa 1460/**
d7425f59
MN
1461 * four components are given, that's all.
1462 * the last component is alpha
1463 */
de6d9b64 1464typedef struct AVPicture {
0c1a9eda 1465 uint8_t *data[4];
cd394651 1466 int linesize[4]; ///< number of bytes per line
de6d9b64
FB
1467} AVPicture;
1468
ba118447
MM
1469/**
1470 * AVPaletteControl
1471 * This structure defines a method for communicating palette changes
1472 * between and demuxer and a decoder.
1473 */
2e99641b 1474#define AVPALETTE_SIZE 1024
432d84c3 1475#define AVPALETTE_COUNT 256
ba118447
MM
1476typedef struct AVPaletteControl {
1477
1478 /* demuxer sets this to 1 to indicate the palette has changed;
1479 * decoder resets to 0 */
1480 int palette_changed;
1481
2a2bbcb0
MM
1482 /* 4-byte ARGB palette entries, stored in native byte order; note that
1483 * the individual palette components should be on a 8-bit scale; if
1484 * the palette data comes from a IBM VGA native format, the component
1485 * data is probably 6 bits in size and needs to be scaled */
2e99641b 1486 unsigned int palette[AVPALETTE_COUNT];
ba118447
MM
1487
1488} AVPaletteControl;
1489
de6d9b64
FB
1490extern AVCodec ac3_encoder;
1491extern AVCodec mp2_encoder;
9d36bdc9 1492extern AVCodec mp3lame_encoder;
81e0d0b4 1493extern AVCodec oggvorbis_encoder;
29d48296 1494extern AVCodec faac_encoder;
de6d9b64 1495extern AVCodec mpeg1video_encoder;
029911d1 1496extern AVCodec mpeg2video_encoder;
de6d9b64
FB
1497extern AVCodec h263_encoder;
1498extern AVCodec h263p_encoder;
d4f5d74a 1499extern AVCodec flv_encoder;
de6d9b64
FB
1500extern AVCodec rv10_encoder;
1501extern AVCodec mjpeg_encoder;
b1e6b355 1502extern AVCodec ljpeg_encoder;
bf89e6b1 1503extern AVCodec mpeg4_encoder;
84afee34
MN
1504extern AVCodec msmpeg4v1_encoder;
1505extern AVCodec msmpeg4v2_encoder;
1506extern AVCodec msmpeg4v3_encoder;
0151a6f5
MN
1507extern AVCodec wmv1_encoder;
1508extern AVCodec wmv2_encoder;
11f18faf 1509extern AVCodec huffyuv_encoder;
0da71265 1510extern AVCodec h264_encoder;
3d2e8cce 1511extern AVCodec asv1_encoder;
9b56edf5 1512extern AVCodec asv2_encoder;
be3564ed 1513extern AVCodec vcr1_encoder;
5e20f836 1514extern AVCodec ffv1_encoder;
c3bf0288 1515extern AVCodec mdec_encoder;
de6d9b64
FB
1516
1517extern AVCodec h263_decoder;
bf89e6b1 1518extern AVCodec mpeg4_decoder;
84afee34
MN
1519extern AVCodec msmpeg4v1_decoder;
1520extern AVCodec msmpeg4v2_decoder;
1521extern AVCodec msmpeg4v3_decoder;
e1a9dbff 1522extern AVCodec wmv1_decoder;
0151a6f5 1523extern AVCodec wmv2_decoder;
922bc38d
MN
1524extern AVCodec mpeg1video_decoder;
1525extern AVCodec mpeg2video_decoder;
fb364ada 1526extern AVCodec mpeg_xvmc_decoder;
de6d9b64 1527extern AVCodec h263i_decoder;
d4f5d74a 1528extern AVCodec flv_decoder;
de6d9b64 1529extern AVCodec rv10_decoder;
be8ffec9 1530extern AVCodec svq1_decoder;
8b82a956 1531extern AVCodec svq3_decoder;
020fcc94 1532extern AVCodec dvvideo_decoder;
bc8d1857
FB
1533extern AVCodec wmav1_decoder;
1534extern AVCodec wmav2_decoder;
4e66ab3b 1535extern AVCodec mjpeg_decoder;
b135d9fb 1536extern AVCodec mjpegb_decoder;
5e83dec4 1537extern AVCodec sp5x_decoder;
4b1f4f23 1538extern AVCodec mp2_decoder;
a96b68b7 1539extern AVCodec mp3_decoder;
3f95e843
FR
1540extern AVCodec mace3_decoder;
1541extern AVCodec mace6_decoder;
11f18faf 1542extern AVCodec huffyuv_decoder;
3aca208a 1543extern AVCodec oggvorbis_decoder;
f70f7c6d 1544extern AVCodec cyuv_decoder;
0da71265 1545extern AVCodec h264_decoder;
deabd4fd 1546extern AVCodec indeo3_decoder;
d86053a4 1547extern AVCodec vp3_decoder;
f44ee2c3 1548extern AVCodec theora_decoder;
891f64b3 1549extern AVCodec amr_nb_decoder;
bc634f6f 1550extern AVCodec amr_nb_encoder;
d663a1fd
MN
1551extern AVCodec amr_wb_encoder;
1552extern AVCodec amr_wb_decoder;
280bd7b7
ZK
1553extern AVCodec aac_decoder;
1554extern AVCodec mpeg4aac_decoder;
3d2e8cce 1555extern AVCodec asv1_decoder;
9b56edf5 1556extern AVCodec asv2_decoder;
be3564ed 1557extern AVCodec vcr1_decoder;
3aff069b 1558extern AVCodec cljr_decoder;
5e20f836 1559extern AVCodec ffv1_decoder;
8809cfee 1560extern AVCodec fourxm_decoder;
c3bf0288 1561extern AVCodec mdec_decoder;
3ef8be2b
MM
1562extern AVCodec roq_decoder;
1563extern AVCodec interplay_video_decoder;
9937e686 1564extern AVCodec xan_wc3_decoder;
2fdf638b
MM
1565extern AVCodec rpza_decoder;
1566extern AVCodec cinepak_decoder;
1567extern AVCodec msrle_decoder;
1568extern AVCodec msvideo1_decoder;
6955a882 1569extern AVCodec vqa_decoder;
4120a53a 1570extern AVCodec idcin_decoder;
1dc1ed99 1571extern AVCodec eightbps_decoder;
11e29a41 1572extern AVCodec smc_decoder;
b8414bbd
NK
1573extern AVCodec ra_144_decoder;
1574extern AVCodec ra_288_decoder;
3ef8be2b
MM
1575extern AVCodec roq_dpcm_decoder;
1576extern AVCodec interplay_dpcm_decoder;
9937e686 1577extern AVCodec xan_dpcm_decoder;
de6d9b64 1578
a96b68b7
FB
1579/* pcm codecs */
1580#define PCM_CODEC(id, name) \
1581extern AVCodec name ## _decoder; \
f11d3f23 1582extern AVCodec name ## _encoder
a96b68b7
FB
1583
1584PCM_CODEC(CODEC_ID_PCM_S16LE, pcm_s16le);
1585PCM_CODEC(CODEC_ID_PCM_S16BE, pcm_s16be);
1586PCM_CODEC(CODEC_ID_PCM_U16LE, pcm_u16le);
1587PCM_CODEC(CODEC_ID_PCM_U16BE, pcm_u16be);
1588PCM_CODEC(CODEC_ID_PCM_S8, pcm_s8);
1589PCM_CODEC(CODEC_ID_PCM_U8, pcm_u8);
1590PCM_CODEC(CODEC_ID_PCM_ALAW, pcm_alaw);
1591PCM_CODEC(CODEC_ID_PCM_MULAW, pcm_mulaw);
1592
0147f198
FR
1593/* adpcm codecs */
1594
1595PCM_CODEC(CODEC_ID_ADPCM_IMA_QT, adpcm_ima_qt);
1596PCM_CODEC(CODEC_ID_ADPCM_IMA_WAV, adpcm_ima_wav);
9937e686
MM
1597PCM_CODEC(CODEC_ID_ADPCM_IMA_DK3, adpcm_ima_dk3);
1598PCM_CODEC(CODEC_ID_ADPCM_IMA_DK4, adpcm_ima_dk4);
2fdf638b 1599PCM_CODEC(CODEC_ID_ADPCM_IMA_WS, adpcm_ima_ws);
0147f198 1600PCM_CODEC(CODEC_ID_ADPCM_MS, adpcm_ms);
4b465299 1601PCM_CODEC(CODEC_ID_ADPCM_4XM, adpcm_4xm);
fc384777
MM
1602PCM_CODEC(CODEC_ID_ADPCM_XA, adpcm_xa);
1603PCM_CODEC(CODEC_ID_ADPCM_ADX, adpcm_adx);
0147f198 1604
a96b68b7
FB
1605#undef PCM_CODEC
1606
1607/* dummy raw video codec */
63167088
RS
1608extern AVCodec rawvideo_encoder;
1609extern AVCodec rawvideo_decoder;
de6d9b64
FB
1610
1611/* the following codecs use external GPL libs */
de6d9b64
FB
1612extern AVCodec ac3_decoder;
1613
1614/* resample.c */
1615
1616struct ReSampleContext;
1617
1618typedef struct ReSampleContext ReSampleContext;
1619
1620ReSampleContext *audio_resample_init(int output_channels, int input_channels,
1621 int output_rate, int input_rate);
1622int audio_resample(ReSampleContext *s, short *output, short *input, int nb_samples);
1623void audio_resample_close(ReSampleContext *s);
1624
1625/* YUV420 format is assumed ! */
1626
1627struct ImgReSampleContext;
1628
1629typedef struct ImgReSampleContext ImgReSampleContext;
1630
1631ImgReSampleContext *img_resample_init(int output_width, int output_height,
1632 int input_width, int input_height);
ab6d194a
MN
1633
1634ImgReSampleContext *img_resample_full_init(int owidth, int oheight,
1635 int iwidth, int iheight,
1636 int topBand, int bottomBand,
1637 int leftBand, int rightBand);
1638
de6d9b64 1639void img_resample(ImgReSampleContext *s,
da64ecc3 1640 AVPicture *output, const AVPicture *input);
de6d9b64
FB
1641
1642void img_resample_close(ImgReSampleContext *s);
1643
75917b88
DH
1644/**
1645 * Allocate memory for a picture. Call avpicture_free to free it.
1646 *
1647 * @param picture the picture to be filled in.
1648 * @param pix_fmt the format of the picture.
1649 * @param width the width of the picture.
1650 * @param height the height of the picture.
1651 * @return 0 if successful, -1 if not.
1652 */
1653int avpicture_alloc(AVPicture *picture, int pix_fmt, int width, int height);
1654
1655/* Free a picture previously allocated by avpicture_alloc. */
1656void avpicture_free(AVPicture *picture);
1657
0c1a9eda 1658int avpicture_fill(AVPicture *picture, uint8_t *ptr,
2d1a4094 1659 int pix_fmt, int width, int height);
da64ecc3 1660int avpicture_layout(const AVPicture* src, int pix_fmt, int width, int height,
63167088 1661 unsigned char *dest, int dest_size);
219b06c6 1662int avpicture_get_size(int pix_fmt, int width, int height);
dab64ebc
FB
1663void avcodec_get_chroma_sub_sample(int pix_fmt, int *h_shift, int *v_shift);
1664const char *avcodec_get_pix_fmt_name(int pix_fmt);
63167088 1665enum PixelFormat avcodec_get_pix_fmt(const char* name);
219b06c6 1666
fab21997
FB
1667#define FF_LOSS_RESOLUTION 0x0001 /* loss due to resolution change */
1668#define FF_LOSS_DEPTH 0x0002 /* loss due to color depth change */
1669#define FF_LOSS_COLORSPACE 0x0004 /* loss due to color space conversion */
1670#define FF_LOSS_ALPHA 0x0008 /* loss of alpha bits */
1671#define FF_LOSS_COLORQUANT 0x0010 /* loss due to color quantization */
1672#define FF_LOSS_CHROMA 0x0020 /* loss of chroma (e.g. rgb to gray conversion) */
1673
1674int avcodec_get_pix_fmt_loss(int dst_pix_fmt, int src_pix_fmt,
1675 int has_alpha);
1676int avcodec_find_best_pix_fmt(int pix_fmt_mask, int src_pix_fmt,
1677 int has_alpha, int *loss_ptr);
1678
0469baf1
FB
1679#define FF_ALPHA_TRANSP 0x0001 /* image has some totally transparent pixels */
1680#define FF_ALPHA_SEMI_TRANSP 0x0002 /* image has some transparent pixels */
da64ecc3
DH
1681int img_get_alpha_info(const AVPicture *src,
1682 int pix_fmt, int width, int height);
0469baf1 1683
219b06c6
FB
1684/* convert among pixel formats */
1685int img_convert(AVPicture *dst, int dst_pix_fmt,
da64ecc3 1686 const AVPicture *src, int pix_fmt,
219b06c6
FB
1687 int width, int height);
1688
1689/* deinterlace a picture */
da64ecc3 1690int avpicture_deinterlace(AVPicture *dst, const AVPicture *src,
de6d9b64
FB
1691 int pix_fmt, int width, int height);
1692
1693/* external high level API */
1694
1695extern AVCodec *first_avcodec;
1696
156e5023 1697/* returns LIBAVCODEC_VERSION_INT constant */
51a49663 1698unsigned avcodec_version(void);
8bceb6af 1699/* returns LIBAVCODEC_BUILD constant */
51a49663 1700unsigned avcodec_build(void);
de6d9b64
FB
1701void avcodec_init(void);
1702
1703void register_avcodec(AVCodec *format);
1704AVCodec *avcodec_find_encoder(enum CodecID id);
98f3b098 1705AVCodec *avcodec_find_encoder_by_name(const char *name);
de6d9b64
FB
1706AVCodec *avcodec_find_decoder(enum CodecID id);
1707AVCodec *avcodec_find_decoder_by_name(const char *name);
1708void avcodec_string(char *buf, int buf_size, AVCodecContext *enc, int encode);
1709
1e491e29 1710void avcodec_get_context_defaults(AVCodecContext *s);
7ffbb60e 1711AVCodecContext *avcodec_alloc_context(void);
492cd3a9 1712AVFrame *avcodec_alloc_frame(void);
1e491e29 1713
492cd3a9
MN
1714int avcodec_default_get_buffer(AVCodecContext *s, AVFrame *pic);
1715void avcodec_default_release_buffer(AVCodecContext *s, AVFrame *pic);
d90cf87b 1716void avcodec_default_free_buffers(AVCodecContext *s);
1e491e29 1717
7a06ff14
MN
1718/**
1719 * opens / inits the AVCodecContext.
1720 * not thread save!
1721 */
de6d9b64 1722int avcodec_open(AVCodecContext *avctx, AVCodec *codec);
7a06ff14 1723
0c1a9eda 1724int avcodec_decode_audio(AVCodecContext *avctx, int16_t *samples,
de6d9b64 1725 int *frame_size_ptr,
0c1a9eda 1726 uint8_t *buf, int buf_size);
492cd3a9 1727int avcodec_decode_video(AVCodecContext *avctx, AVFrame *picture,
de6d9b64 1728 int *got_picture_ptr,
0c1a9eda
ZK
1729 uint8_t *buf, int buf_size);
1730int avcodec_parse_frame(AVCodecContext *avctx, uint8_t **pdata,
917e06c8 1731 int *data_size_ptr,
0c1a9eda
ZK
1732 uint8_t *buf, int buf_size);
1733int avcodec_encode_audio(AVCodecContext *avctx, uint8_t *buf, int buf_size,
de6d9b64 1734 const short *samples);
0c1a9eda 1735int avcodec_encode_video(AVCodecContext *avctx, uint8_t *buf, int buf_size,
492cd3a9 1736 const AVFrame *pict);
de6d9b64
FB
1737
1738int avcodec_close(AVCodecContext *avctx);
1739
1740void avcodec_register_all(void);
a96b68b7 1741
1c2a8c7f
MN
1742void avcodec_flush_buffers(AVCodecContext *avctx);
1743
14bea432 1744/* misc usefull functions */
d8085ea7
MN
1745
1746/**
1747 * returns a single letter to describe the picture type
1748 */
1749char av_get_pict_type_char(int pict_type);
1750
14bea432
MN
1751/**
1752 * reduce a fraction.
1753 * this is usefull for framerate calculations
1754 * @param max the maximum allowed for dst_nom & dst_den
1755 * @return 1 if exact, 0 otherwise
1756 */
1757int av_reduce(int *dst_nom, int *dst_den, int64_t nom, int64_t den, int64_t max);
1758
1759/**
1760 * rescale a 64bit integer.
1761 * a simple a*b/c isnt possible as it can overflow
1762 */
1763int64_t av_rescale(int64_t a, int b, int c);
628d601b 1764
628d601b 1765
e8f14793
ZK
1766/**
1767 * Interface for 0.5.0 version
1768 *
1769 * do not even think about it's usage for this moment
1770 */
1771
1772typedef struct {
64863965 1773 /// compressed size used from given memory buffer
e8f14793
ZK
1774 int size;
1775 /// I/P/B frame type
1776 int frame_type;
1777} avc_enc_result_t;
1778
1779/**
1780 * Commands
1781 * order can't be changed - once it was defined
1782 */
1783typedef enum {
1784 // general commands
1785 AVC_OPEN_BY_NAME = 0xACA000,
1786 AVC_OPEN_BY_CODEC_ID,
1787 AVC_OPEN_BY_FOURCC,
1788 AVC_CLOSE,
1789
1790 AVC_FLUSH,
1791 // pin - struct { uint8_t* src, uint_t src_size }
1792 // pout - struct { AVPicture* img, consumed_bytes,
1793 AVC_DECODE,
1794 // pin - struct { AVPicture* img, uint8_t* dest, uint_t dest_size }
1795 // pout - uint_t used_from_dest_size
1796 AVC_ENCODE,
1797
1798 // query/get video commands
1799 AVC_GET_VERSION = 0xACB000,
1800 AVC_GET_WIDTH,
1801 AVC_GET_HEIGHT,
1802 AVC_GET_DELAY,
1803 AVC_GET_QUANT_TABLE,
1804 // ...
1805
1806 // query/get audio commands
1807 AVC_GET_FRAME_SIZE = 0xABC000,
1808
1809 // maybe define some simple structure which
1810 // might be passed to the user - but they can't
1811 // contain any codec specific parts and these
1812 // calls are usualy necessary only few times
1813
1814 // set video commands
1815 AVC_SET_WIDTH = 0xACD000,
1816 AVC_SET_HEIGHT,
1817
1818 // set video encoding commands
1819 AVC_SET_FRAME_RATE = 0xACD800,
1820 AVC_SET_QUALITY,
1821 AVC_SET_HURRY_UP,
1822
1823 // set audio commands
1824 AVC_SET_SAMPLE_RATE = 0xACE000,
1825 AVC_SET_CHANNELS,
1826
1827} avc_cmd_t;
1828
1829/**
1830 * \param handle allocated private structure by libavcodec
1831 * for initialization pass NULL - will be returned pout
1832 * user is supposed to know nothing about its structure
1833 * \param cmd type of operation to be performed
1834 * \param pint input parameter
1835 * \param pout output parameter
1836 *
1837 * \returns command status - eventually for query command it might return
1838 * integer resulting value
1839 */
1840int avcodec(void* handle, avc_cmd_t cmd, void* pin, void* pout);
1841
544eb99c 1842/* memory */
e4eadb4b 1843void *av_malloc(unsigned int size);
18f77016 1844void *av_mallocz(unsigned int size);
8e1e6f31 1845void *av_realloc(void *ptr, unsigned int size);
544eb99c 1846void av_free(void *ptr);
8e1e6f31 1847char *av_strdup(const char *s);
544eb99c
FB
1848void __av_freep(void **ptr);
1849#define av_freep(p) __av_freep((void **)(p))
97d96aaa 1850void *av_fast_realloc(void *ptr, unsigned int *size, unsigned int min_size);
855ea723
ZK
1851/* for static data only */
1852/* call av_free_static to release all staticaly allocated tables */
628d601b 1853void av_free_static(void);
855ea723
ZK
1854void *__av_mallocz_static(void** location, unsigned int size);
1855#define av_mallocz_static(p, s) __av_mallocz_static((void **)(p), s)
544eb99c 1856
fc384777
MM
1857/* add by bero : in adx.c */
1858int is_adx(const unsigned char *buf,size_t bufsize);
1859
9b879566
MB
1860/* av_log API */
1861
1862#include <stdarg.h>
1863
1864#define AV_LOG_ERROR 0
1865#define AV_LOG_INFO 1
1866#define AV_LOG_DEBUG 2
1867
1868extern void av_log(AVCodecContext*, int level, const char *fmt, ...) __attribute__ ((__format__ (__printf__, 3, 4)));
1869extern void av_vlog(AVCodecContext*, int level, const char *fmt, va_list);
1870extern int av_log_get_level(void);
1871extern void av_log_set_level(int);
1872extern void av_log_set_callback(void (*)(AVCodecContext*, int, const char*, va_list));
1873
1874#undef AV_LOG_TRAP_PRINTF
1875#ifdef AV_LOG_TRAP_PRINTF
1876#define printf DO NOT USE
1877#define fprintf DO NOT USE
1878#undef stderr
1879#define stderr DO NOT USE
1880#endif
1881
02d697aa
ZK
1882#ifdef __cplusplus
1883}
1884#endif
1885
a96b68b7 1886#endif /* AVCODEC_H */