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