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