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