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