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