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