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