memory leak fix by (Tom Dexter <devel at www dot digitalaudiorock dot com>)
[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
FB
14#include "common.h"
15
8026c3b5
AB
16#define LIBAVCODEC_VERSION_INT 0x000408
17#define LIBAVCODEC_VERSION "0.4.8"
9b56edf5
MN
18#define LIBAVCODEC_BUILD 4677
19#define LIBAVCODEC_BUILD_STR "4677"
4b1f4f23 20
ce2749d2
AB
21#define LIBAVCODEC_IDENT "FFmpeg" LIBAVCODEC_VERSION "b" LIBAVCODEC_BUILD_STR
22
de6d9b64
FB
23enum CodecID {
24 CODEC_ID_NONE,
25 CODEC_ID_MPEG1VIDEO,
029911d1 26 CODEC_ID_MPEG2VIDEO,
fb364ada 27 CODEC_ID_MPEG2VIDEO_XVMC,
de6d9b64
FB
28 CODEC_ID_H263,
29 CODEC_ID_RV10,
30 CODEC_ID_MP2,
9d36bdc9 31 CODEC_ID_MP3LAME,
81e0d0b4 32 CODEC_ID_VORBIS,
de6d9b64
FB
33 CODEC_ID_AC3,
34 CODEC_ID_MJPEG,
b135d9fb 35 CODEC_ID_MJPEGB,
b1e6b355 36 CODEC_ID_LJPEG,
bf89e6b1 37 CODEC_ID_MPEG4,
de6d9b64 38 CODEC_ID_RAWVIDEO,
84afee34
MN
39 CODEC_ID_MSMPEG4V1,
40 CODEC_ID_MSMPEG4V2,
41 CODEC_ID_MSMPEG4V3,
e1a9dbff 42 CODEC_ID_WMV1,
b50eef3a 43 CODEC_ID_WMV2,
de6d9b64
FB
44 CODEC_ID_H263P,
45 CODEC_ID_H263I,
d4f5d74a 46 CODEC_ID_FLV1,
be8ffec9 47 CODEC_ID_SVQ1,
8b82a956 48 CODEC_ID_SVQ3,
020fcc94
FB
49 CODEC_ID_DVVIDEO,
50 CODEC_ID_DVAUDIO,
bc8d1857
FB
51 CODEC_ID_WMAV1,
52 CODEC_ID_WMAV2,
3f95e843
FR
53 CODEC_ID_MACE3,
54 CODEC_ID_MACE6,
11f18faf 55 CODEC_ID_HUFFYUV,
f70f7c6d 56 CODEC_ID_CYUV,
0da71265 57 CODEC_ID_H264,
deabd4fd 58 CODEC_ID_INDEO3,
d86053a4 59 CODEC_ID_VP3,
280bd7b7
ZK
60 CODEC_ID_AAC,
61 CODEC_ID_MPEG4AAC,
3d2e8cce 62 CODEC_ID_ASV1,
9b56edf5 63 CODEC_ID_ASV2,
5e20f836 64 CODEC_ID_FFV1,
e2a7bb28 65 CODEC_ID_4XM,
be3564ed 66 CODEC_ID_VCR1,
3aff069b 67 CODEC_ID_CLJR,
c3bf0288 68 CODEC_ID_MDEC,
3ef8be2b
MM
69 CODEC_ID_ROQ,
70 CODEC_ID_INTERPLAY_VIDEO,
a96b68b7
FB
71
72 /* various pcm "codecs" */
73 CODEC_ID_PCM_S16LE,
74 CODEC_ID_PCM_S16BE,
75 CODEC_ID_PCM_U16LE,
76 CODEC_ID_PCM_U16BE,
77 CODEC_ID_PCM_S8,
78 CODEC_ID_PCM_U8,
79 CODEC_ID_PCM_MULAW,
80 CODEC_ID_PCM_ALAW,
0147f198
FR
81
82 /* various adpcm codecs */
83 CODEC_ID_ADPCM_IMA_QT,
84 CODEC_ID_ADPCM_IMA_WAV,
85 CODEC_ID_ADPCM_MS,
e2a7bb28 86 CODEC_ID_ADPCM_4XM,
891f64b3 87
88 /* AMR */
89 CODEC_ID_AMR_NB,
b8414bbd
NK
90 /* RealAudio codecs*/
91 CODEC_ID_RA_144,
92 CODEC_ID_RA_288,
3ef8be2b
MM
93
94 /* various DPCM codecs */
95 CODEC_ID_ROQ_DPCM,
96 CODEC_ID_INTERPLAY_DPCM,
de6d9b64 97};
e91df376 98#define CODEC_ID_MPEGVIDEO CODEC_ID_MPEG1VIDEO
de6d9b64
FB
99
100enum CodecType {
4a663d80 101 CODEC_TYPE_UNKNOWN = -1,
de6d9b64
FB
102 CODEC_TYPE_VIDEO,
103 CODEC_TYPE_AUDIO,
104};
105
64863965
MN
106/**
107 * Pixel format.
108 */
de6d9b64 109enum PixelFormat {
cd394651
MN
110 PIX_FMT_YUV420P, ///< Planar YUV 4:2:0 (1 Cr & Cb sample per 2x2 Y samples)
111 PIX_FMT_YUV422,
112 PIX_FMT_RGB24, ///< Packed pixel, 3 bytes per pixel, RGBRGB...
113 PIX_FMT_BGR24, ///< Packed pixel, 3 bytes per pixel, BGRBGR...
114 PIX_FMT_YUV422P, ///< Planar YUV 4:2:2 (1 Cr & Cb sample per 2x1 Y samples)
115 PIX_FMT_YUV444P, ///< Planar YUV 4:4:4 (1 Cr & Cb sample per 1x1 Y samples)
b1e6b355 116 PIX_FMT_RGBA32, ///< Packed pixel, 4 bytes per pixel, BGRABGRA...
cd394651
MN
117 PIX_FMT_YUV410P, ///< Planar YUV 4:1:0 (1 Cr & Cb sample per 4x4 Y samples)
118 PIX_FMT_YUV411P, ///< Planar YUV 4:1:1 (1 Cr & Cb sample per 4x1 Y samples)
64863965
MN
119 PIX_FMT_RGB565, ///< always stored in cpu endianness
120 PIX_FMT_RGB555, ///< always stored in cpu endianness, most significant bit to 1
dab64ebc 121 PIX_FMT_GRAY8,
64863965
MN
122 PIX_FMT_MONOWHITE, ///< 0 is white
123 PIX_FMT_MONOBLACK, ///< 0 is black
124 PIX_FMT_PAL8, ///< 8 bit with RGBA palette
cd394651
MN
125 PIX_FMT_YUVJ420P, ///< Planar YUV 4:2:0 full scale (jpeg)
126 PIX_FMT_YUVJ422P, ///< Planar YUV 4:2:2 full scale (jpeg)
127 PIX_FMT_YUVJ444P, ///< Planar YUV 4:4:4 full scale (jpeg)
fb364ada
IK
128 PIX_FMT_XVMC_MPEG2_MC,///< XVideo Motion Acceleration via common packet passing(xvmc_render.h)
129 PIX_FMT_XVMC_MPEG2_IDCT,
dab64ebc 130 PIX_FMT_NB,
de6d9b64
FB
131};
132
a96b68b7
FB
133/* currently unused, may be used if 24/32 bits samples ever supported */
134enum SampleFormat {
64863965 135 SAMPLE_FMT_S16 = 0, ///< signed 16 bits
a96b68b7
FB
136};
137
de6d9b64 138/* in bytes */
bc8d1857 139#define AVCODEC_MAX_AUDIO_FRAME_SIZE 131072
de6d9b64 140
d7425f59 141/**
cf713bb8
MN
142 * Required number of additionally allocated bytes at the end of the input bitstream for decoding.
143 * this is mainly needed because some optimized bitstream readers read
144 * 32 or 64 bit at once and could read over the end<br>
145 * Note, if the first 23 bits of the additional bytes are not 0 then damaged
146 * MPEG bitstreams could cause overread and segfault
d7425f59
MN
147 */
148#define FF_INPUT_BUFFER_PADDING_SIZE 8
149
e4986da9
J
150/* motion estimation type, EPZS by default */
151enum Motion_Est_ID {
101bea5f 152 ME_ZERO = 1,
e4986da9
J
153 ME_FULL,
154 ME_LOG,
155 ME_PHODS,
156 ME_EPZS,
157 ME_X1
158};
159
ce980a95
MN
160typedef struct RcOverride{
161 int start_frame;
162 int end_frame;
163 int qscale; // if this is 0 then quality_factor will be used instead
164 float quality_factor;
165} RcOverride;
166
101bea5f
J
167/* only for ME compatiblity with old apps */
168extern int motion_estimation_method;
169
e4986da9 170/* ME algos sorted by quality */
bc6caae2
J
171static const int Motion_Est_QTab[] = { ME_ZERO, ME_PHODS, ME_LOG,
172 ME_X1, ME_EPZS, ME_FULL };
de6d9b64 173
28db7fce 174
4e00e76b 175#define FF_MAX_B_FRAMES 8
9dbcbd92 176
a949d72e
MN
177/* encoding support
178 these flags can be passed in AVCodecContext.flags before initing
179 Note: note not everything is supported yet
180*/
de6d9b64 181
64863965
MN
182#define CODEC_FLAG_QSCALE 0x0002 ///< use fixed qscale
183#define CODEC_FLAG_4MV 0x0004 ///< 4 MV per MB allowed
184#define CODEC_FLAG_QPEL 0x0010 ///< use qpel MC
185#define CODEC_FLAG_GMC 0x0020 ///< use GMC
186#define CODEC_FLAG_PART 0x0080 ///< use data partitioning
9dbcbd92
MN
187/* parent program gurantees that the input for b-frame containing streams is not written to
188 for at least s->max_b_frames+1 frames, if this is not set than the input will be copied */
8b4c7dbc 189#define CODEC_FLAG_INPUT_PRESERVED 0x0100
64863965
MN
190#define CODEC_FLAG_PASS1 0x0200 ///< use internal 2pass ratecontrol in first pass mode
191#define CODEC_FLAG_PASS2 0x0400 ///< use internal 2pass ratecontrol in second pass mode
192#define CODEC_FLAG_EXTERN_HUFF 0x1000 ///< use external huffman table (for mjpeg)
193#define CODEC_FLAG_GRAY 0x2000 ///< only decode/encode grayscale
194#define CODEC_FLAG_EMU_EDGE 0x4000///< dont draw edges
195#define CODEC_FLAG_PSNR 0x8000 ///< error[?] variables will be set during encoding
196#define CODEC_FLAG_TRUNCATED 0x00010000 /** input bitstream might be truncated at a random location instead
d7425f59 197 of only at frame boundaries */
64863965
MN
198#define CODEC_FLAG_NORMALIZE_AQP 0x00020000 ///< normalize adaptive quantization
199#define CODEC_FLAG_INTERLACED_DCT 0x00040000 ///< use interlaced dct
3bb07d61 200#define CODEC_FLAG_LOW_DELAY 0x00080000 ///< force low delay
64863965
MN
201#define CODEC_FLAG_ALT_SCAN 0x00100000 ///< use alternate scan
202#define CODEC_FLAG_TRELLIS_QUANT 0x00200000 ///< use trellis quantization
203#define CODEC_FLAG_GLOBAL_HEADER 0x00400000 ///< place global headers in extradata instead of every keyframe
204#define CODEC_FLAG_BITEXACT 0x00800000 ///< use only bitexact stuff (except (i)dct)
21e59552 205/* Fx : Flag for h263+ extra options */
64863965
MN
206#define CODEC_FLAG_H263P_AIC 0x01000000 ///< Advanced intra coding
207#define CODEC_FLAG_H263P_UMV 0x02000000 ///< Unlimited motion vector
21e59552
MN
208/* For advanced prediction mode, we reuse the 4MV flag */
209/* Unsupported options :
210 * Syntax Arithmetic coding (SAC)
211 * Deblocking filter internal loop
212 * Slice structured
213 * Reference Picture Selection
214 * Independant Segment Decoding
215 * Alternative Inter * VLC
216 * Modified Quantization */
217/* /Fx */
bf89e6b1
FB
218/* codec capabilities */
219
64863965 220#define CODEC_CAP_DRAW_HORIZ_BAND 0x0001 ///< decoder can use draw_horiz_band callback
6814a25c
MN
221/**
222 * Codec uses get_buffer() for allocating buffers.
223 * direct rendering method 1
224 */
225#define CODEC_CAP_DR1 0x0002
917e06c8
FB
226/* if 'parse_only' field is true, then avcodec_parse_frame() can be
227 used */
228#define CODEC_CAP_PARSE_ONLY 0x0004
d7425f59 229#define CODEC_CAP_TRUNCATED 0x0008
bf89e6b1 230
492cd3a9 231#define FF_COMMON_FRAME \
b536d0aa
MN
232 /**\
233 * pointer to the picture planes.\
234 * this might be different from the first allocated byte\
235 * - encoding: \
236 * - decoding: \
237 */\
1e491e29
MN
238 uint8_t *data[4];\
239 int linesize[4];\
240 /**\
32db2b1d 241 * pointer to the first allocated byte of the picture. can be used in get_buffer/release_buffer\
1e491e29 242 * this isnt used by lavc unless the default get/release_buffer() is used\
64863965
MN
243 * - encoding: \
244 * - decoding: \
1e491e29
MN
245 */\
246 uint8_t *base[4];\
247 /**\
248 * 1 -> keyframe, 0-> not\
64863965
MN
249 * - encoding: set by lavc\
250 * - decoding: set by lavc\
1e491e29
MN
251 */\
252 int key_frame;\
253\
254 /**\
0da71265 255 * picture type of the frame, see ?_TYPE below.\
64863965
MN
256 * - encoding: set by lavc for coded_picture (and set by user for input)\
257 * - decoding: set by lavc\
1e491e29
MN
258 */\
259 int pict_type;\
260\
261 /**\
262 * presentation timestamp in micro seconds (time when frame should be shown to user)\
263 * if 0 then the frame_rate will be used as reference\
64863965
MN
264 * - encoding: MUST be set by user\
265 * - decoding: set by lavc\
1e491e29 266 */\
be6784dc 267 int64_t pts;\
1e491e29
MN
268\
269 /**\
270 * picture number in bitstream order.\
64863965
MN
271 * - encoding: set by\
272 * - decoding: set by lavc\
1e491e29
MN
273 */\
274 int coded_picture_number;\
275 /**\
1e491e29 276 * picture number in display order.\
64863965
MN
277 * - encoding: set by\
278 * - decoding: set by lavc\
1e491e29
MN
279 */\
280 int display_picture_number;\
281\
282 /**\
283 * quality (between 1 (good) and 31 (bad)) \
64863965
MN
284 * - encoding: set by lavc for coded_picture (and set by user for input)\
285 * - decoding: set by lavc\
1e491e29
MN
286 */\
287 float quality; \
288\
289 /**\
290 * buffer age (1->was last buffer and dint change, 2->..., ...).\
291 * set to something large if the buffer has not been used yet \
64863965
MN
292 * - encoding: unused\
293 * - decoding: MUST be set by get_buffer()\
1e491e29
MN
294 */\
295 int age;\
296\
297 /**\
298 * is this picture used as reference\
64863965
MN
299 * - encoding: unused\
300 * - decoding: set by lavc (before get_buffer() call))\
1e491e29
MN
301 */\
302 int reference;\
303\
304 /**\
305 * QP table\
64863965
MN
306 * - encoding: unused\
307 * - decoding: set by lavc\
1e491e29
MN
308 */\
309 int8_t *qscale_table;\
310 /**\
311 * QP store stride\
64863965
MN
312 * - encoding: unused\
313 * - decoding: set by lavc\
1e491e29
MN
314 */\
315 int qstride;\
316\
317 /**\
318 * mbskip_table[mb]>=1 if MB didnt change\
319 * stride= mb_width = (width+15)>>4\
64863965
MN
320 * - encoding: unused\
321 * - decoding: set by lavc\
1e491e29
MN
322 */\
323 uint8_t *mbskip_table;\
324\
325 /**\
326 * for some private data of the user\
64863965
MN
327 * - encoding: unused\
328 * - decoding: set by user\
1e491e29
MN
329 */\
330 void *opaque;\
140cb663
MN
331\
332 /**\
333 * error\
64863965
MN
334 * - encoding: set by lavc if flags&CODEC_FLAG_PSNR\
335 * - decoding: unused\
140cb663
MN
336 */\
337 uint64_t error[4];\
4e00e76b
MN
338\
339 /**\
340 * type of the buffer (to keep track of who has to dealloc data[*])\
64863965
MN
341 * - encoding: set by the one who allocs it\
342 * - decoding: set by the one who allocs it\
3db320ea 343 * Note: user allocated (direct rendering) & internal buffers can not coexist currently\
4e00e76b
MN
344 */\
345 int type;\
2ec23b6d
MN
346 \
347 /**\
348 * when decoding, this signal how much the picture must be delayed.\
349 * extra_delay = repeat_pict / (2*fps)\
64863965
MN
350 * - encoding: unused\
351 * - decoding: set by lavc\
2ec23b6d 352 */\
0426af31
MN
353 int repeat_pict;\
354 \
355 /**\
356 * \
357 */\
358 int qscale_type;\
2ec23b6d 359
0426af31
MN
360#define FF_QSCALE_TYPE_MPEG1 0
361#define FF_QSCALE_TYPE_MPEG2 1
4e00e76b
MN
362
363#define FF_BUFFER_TYPE_INTERNAL 1
9b56edf5
MN
364#define FF_BUFFER_TYPE_USER 2 ///< Direct rendering buffers (image is (de)allocated by user)
365#define FF_BUFFER_TYPE_SHARED 4 ///< buffer from somewher else, dont dealloc image (data/base)
366#define FF_BUFFER_TYPE_COPY 8 ///< just a (modified) copy of some other buffer, dont dealloc anything
4e00e76b 367
1e491e29 368
140cb663
MN
369#define FF_I_TYPE 1 // Intra
370#define FF_P_TYPE 2 // Predicted
371#define FF_B_TYPE 3 // Bi-dir predicted
372#define FF_S_TYPE 4 // S(GMC)-VOP MPEG4
0da71265
MN
373#define FF_SI_TYPE 5
374#define FF_SP_TYPE 6
1e491e29 375
0da71265
MN
376/**
377 * Audio Video Frame.
378 */
492cd3a9
MN
379typedef struct AVFrame {
380 FF_COMMON_FRAME
381} AVFrame;
1e491e29 382
14bea432 383#define DEFAULT_FRAME_RATE_BASE 1001000
d33c949c
MN
384
385/**
386 * main external api structure.
387 */
de6d9b64 388typedef struct AVCodecContext {
b71901e6 389 /**
64863965
MN
390 * the average bitrate.
391 * - encoding: set by user. unused for constant quantizer encoding
392 * - decoding: set by lavc. 0 or some bitrate if this info is available in the stream
b71901e6 393 */
de6d9b64 394 int bit_rate;
b71901e6
MN
395
396 /**
64863965 397 * number of bits the bitstream is allowed to diverge from the reference.
b71901e6 398 * the reference can be CBR (for CBR pass1) or VBR (for pass2)
64863965
MN
399 * - encoding: set by user. unused for constant quantizer encoding
400 * - decoding: unused
b71901e6
MN
401 */
402 int bit_rate_tolerance;
403
404 /**
64863965
MN
405 * CODEC_FLAG_*.
406 * - encoding: set by user.
407 * - decoding: set by user.
b71901e6 408 */
de6d9b64 409 int flags;
b71901e6
MN
410
411 /**
412 * some codecs needs additionnal format info. It is stored here
64863965
MN
413 * - encoding: set by user.
414 * - decoding: set by lavc. (FIXME is this ok?)
b71901e6
MN
415 */
416 int sub_id;
417
418 /**
64863965
MN
419 * motion estimation algorithm used for video coding.
420 * - encoding: MUST be set by user.
421 * - decoding: unused
b71901e6
MN
422 */
423 int me_method;
424
425 /**
64863965 426 * some codecs need / can use extra-data like huffman tables.
b71901e6
MN
427 * mjpeg: huffman tables
428 * rv10: additional flags
b704e742 429 * mpeg4: global headers (they can be in the bitstream or here)
64863965
MN
430 * - encoding: set/allocated/freed by lavc.
431 * - decoding: set/allocated/freed by user.
b71901e6 432 */
e84c31dc
A
433 void *extradata;
434 int extradata_size;
435
de6d9b64 436 /* video only */
b71901e6 437 /**
14bea432 438 * frames per sec multiplied by frame_rate_base.
b71901e6 439 * for variable fps this is the precission, so if the timestamps
14bea432 440 * can be specified in msec precssion then this is 1000*frame_rate_base
64863965
MN
441 * - encoding: MUST be set by user
442 * - decoding: set by lavc. 0 or the frame_rate if available
b71901e6
MN
443 */
444 int frame_rate;
14bea432
MN
445
446 /**
64863965
MN
447 * width / height.
448 * - encoding: MUST be set by user.
449 * - decoding: set by user, some codecs might override / change it during playback
b71901e6 450 */
de6d9b64 451 int width, height;
b71901e6 452
2efe097a
MN
453#define FF_ASPECT_SQUARE 1
454#define FF_ASPECT_4_3_625 2
455#define FF_ASPECT_4_3_525 3
456#define FF_ASPECT_16_9_625 4
457#define FF_ASPECT_16_9_525 5
e769f053 458#define FF_ASPECT_EXTENDED 15
b71901e6
MN
459
460 /**
64863965
MN
461 * the number of pictures in a group of pitures, or 0 for intra_only.
462 * - encoding: set by user.
463 * - decoding: unused
b71901e6
MN
464 */
465 int gop_size;
466
467 /**
64863965 468 * pixel format, see PIX_FMT_xxx.
36b58e85
RS
469 * - encoding: FIXME: used by ffmpeg to decide whether an pix_fmt
470 * conversion is in order. This only works for
471 * codecs with one supported pix_fmt, we should
472 * do something for a generic case as well.
64863965 473 * - decoding: set by lavc.
b71901e6 474 */
e4eadb4b 475 enum PixelFormat pix_fmt;
bdfcbbed
MK
476
477 /**
478 * Frame rate emulation. If not zero lower layer (i.e. format handler)
479 * has to read frames at native frame rate.
480 * - encoding: set by user.
481 * - decoding: unused.
482 */
483 int rate_emu;
484
b71901e6
MN
485 /**
486 * if non NULL, 'draw_horiz_band' is called by the libavcodec
487 * decoder to draw an horizontal band. It improve cache usage. Not
488 * all codecs can do that. You must check the codec capabilities
489 * before
64863965
MN
490 * - encoding: unused
491 * - decoding: set by user.
3bb07d61
MN
492 * @param height the height of the slice
493 * @param y the y position of the slice
494 * @param type 1->top field, 2->bottom field, 3->frame
495 * @param offset offset into the AVFrame.data from which the slice should be read
b71901e6 496 */
bf89e6b1 497 void (*draw_horiz_band)(struct AVCodecContext *s,
7a06ff14 498 AVFrame *src, int offset[4],
3bb07d61 499 int y, int type, int height);
bf89e6b1 500
de6d9b64 501 /* audio only */
64863965 502 int sample_rate; ///< samples per sec
de6d9b64 503 int channels;
64863965 504 int sample_fmt; ///< sample format, currenly unused
de6d9b64
FB
505
506 /* the following data should not be initialized */
64863965
MN
507 int frame_size; ///< in samples, initialized when calling 'init'
508 int frame_number; ///< audio or video frame number
509 int real_pict_num; ///< returns the real picture number of previous encoded frame
1e491e29 510
b71901e6 511 /**
b71901e6 512 * number of frames the decoded output will be delayed relative to
64863965
MN
513 * the encoded input.
514 * - encoding: set by lavc.
515 * - decoding: unused
b71901e6
MN
516 */
517 int delay;
1ff662cc 518
64863965
MN
519 /* - encoding parameters */
520 float qcompress; ///< amount of qscale change between easy & hard scenes (0.0-1.0)
521 float qblur; ///< amount of qscale smoothing over time (0.0-1.0)
b71901e6
MN
522
523 /**
64863965
MN
524 * minimum quantizer.
525 * - encoding: set by user.
526 * - decoding: unused
b71901e6
MN
527 */
528 int qmin;
529
530 /**
64863965
MN
531 * maximum quantizer.
532 * - encoding: set by user.
533 * - decoding: unused
b71901e6
MN
534 */
535 int qmax;
536
537 /**
64863965
MN
538 * maximum quantizer difference etween frames.
539 * - encoding: set by user.
540 * - decoding: unused
b71901e6
MN
541 */
542 int max_qdiff;
543
544 /**
64863965 545 * maximum number of b frames between non b frames.
b71901e6 546 * note: the output will be delayed by max_b_frames+1 relative to the input
64863965
MN
547 * - encoding: set by user.
548 * - decoding: unused
b71901e6
MN
549 */
550 int max_b_frames;
551
552 /**
64863965
MN
553 * qscale factor between ip and b frames.
554 * - encoding: set by user.
555 * - decoding: unused
b71901e6
MN
556 */
557 float b_quant_factor;
558
559 /** obsolete FIXME remove */
560 int rc_strategy;
8b4c7dbc 561 int b_frame_strategy;
9dbcbd92 562
b71901e6 563 /**
64863965
MN
564 * hurry up amount.
565 * - encoding: unused
566 * - decoding: set by user. 1-> skip b frames, 2-> skip idct/dequant too, 5-> skip everything except header
b71901e6
MN
567 */
568 int hurry_up;
2417652e 569
de6d9b64 570 struct AVCodec *codec;
b71901e6 571
de6d9b64
FB
572 void *priv_data;
573
644d98a4 574 /* The following data is for RTP friendly coding */
1f6b6e50 575 /* By now only H.263/H.263+/MPEG4 coder honours this */
644d98a4
J
576 int rtp_mode; /* 1 for activate RTP friendly-mode */
577 /* highers numbers represent more error-prone */
578 /* enviroments, by now just "1" exist */
579
580 int rtp_payload_size; /* The size of the RTP payload, the coder will */
581 /* do it's best to deliver a chunk with size */
582 /* below rtp_payload_size, the chunk will start */
583 /* with a start code on some codecs like H.263 */
584 /* This doesn't take account of any particular */
585 /* headers inside the transmited RTP payload */
81401c1f
J
586
587
588 /* The RTP callcack: This function is called */
589 /* every time the encoder as a packet to send */
590 /* Depends on the encoder if the data starts */
591 /* with a Start Code (it should) H.263 does */
592 void (*rtp_callback)(void *data, int size, int packet_number);
593
098eefe1
MN
594 /* statistics, used for 2-pass encoding */
595 int mv_bits;
596 int header_bits;
597 int i_tex_bits;
598 int p_tex_bits;
599 int i_count;
600 int p_count;
601 int skip_count;
b71901e6
MN
602 int misc_bits;
603
604 /**
64863965
MN
605 * number of bits used for the previously encoded frame.
606 * - encoding: set by lavc
7004ffb3 607 * - decoding: unused
b71901e6 608 */
098eefe1 609 int frame_bits;
7004ffb3 610
b71901e6 611 /**
64863965
MN
612 * private data of the user, can be used to carry app specific stuff.
613 * - encoding: set by user
614 * - decoding: set by user
b71901e6
MN
615 */
616 void *opaque;
617
de6d9b64 618 char codec_name[32];
4a663d80
PG
619 enum CodecType codec_type; /* see CODEC_TYPE_xxx */
620 enum CodecID codec_id; /* see CODEC_ID_xxx */
7004ffb3
MN
621
622 /**
623 * fourcc (LSB first, so "ABCD" -> ('D'<<24) + ('C'<<16) + ('B'<<8) + 'A').
624 * this is used to workaround some encoder bugs
bd5a6020 625 * - encoding: set by user, if not then the default based on codec_id will be used
7004ffb3
MN
626 * - decoding: set by user, will be converted to upper case by lavc during init
627 */
628 unsigned int codec_tag;
92ba5ffb 629
b71901e6 630 /**
64863965
MN
631 * workaround bugs in encoders which sometimes cannot be detected automatically.
632 * - encoding: unused
633 * - decoding: set by user
b71901e6
MN
634 */
635 int workaround_bugs;
64863965 636#define FF_BUG_AUTODETECT 1 ///< autodetection
4d2858de
MN
637#define FF_BUG_OLD_MSMPEG4 2
638#define FF_BUG_XVID_ILACE 4
639#define FF_BUG_UMP4 8
640#define FF_BUG_NO_PADDING 16
641#define FF_BUG_AC_VLC 32
03e93d35 642#define FF_BUG_QPEL_CHROMA 64
db794953 643#define FF_BUG_STD_QPEL 128
36df8805 644#define FF_BUG_QPEL_CHROMA2 256
c40c3482 645#define FF_BUG_DIRECT_BLOCKSIZE 512
1c6dcb0f 646#define FF_BUG_EDGE 1024
4d2858de
MN
647//#define FF_BUG_FAKE_SCALABILITY 16 //autodetection should work 100%
648
b71901e6 649 /**
64863965
MN
650 * luma single coeff elimination threshold.
651 * - encoding: set by user
652 * - decoding: unused
b71901e6 653 */
1f6b6e50 654 int luma_elim_threshold;
b71901e6
MN
655
656 /**
64863965
MN
657 * chroma single coeff elimination threshold.
658 * - encoding: set by user
659 * - decoding: unused
b71901e6 660 */
1f6b6e50 661 int chroma_elim_threshold;
b71901e6
MN
662
663 /**
64863965
MN
664 * strictly follow the std (MPEG4, ...).
665 * - encoding: set by user
666 * - decoding: unused
b71901e6
MN
667 */
668 int strict_std_compliance;
669
670 /**
64863965 671 * qscale offset between ip and b frames.
b3a391e8
MN
672 * if > 0 then the last p frame quantizer will be used (q= lastp_q*factor+offset)
673 * if < 0 then normal ratecontrol will be done (q= -normal_q*factor+offset)
64863965
MN
674 * - encoding: set by user.
675 * - decoding: unused
b71901e6
MN
676 */
677 float b_quant_offset;
678
679 /**
ce3bcaed 680 * error resilience higher values will detect more errors but may missdetect
64863965
MN
681 * some more or less valid parts as errors.
682 * - encoding: unused
683 * - decoding: set by user
b71901e6 684 */
1f6b6e50 685 int error_resilience;
ce3bcaed
MN
686#define FF_ER_CAREFULL 1
687#define FF_ER_COMPLIANT 2
688#define FF_ER_AGGRESSIVE 3
689#define FF_ER_VERY_AGGRESSIVE 4
ae72cda6 690
6b72ac63 691 /**
1e491e29
MN
692 * called at the beginning of each frame to get a buffer for it.
693 * if pic.reference is set then the frame will be read later by lavc
3bb07d61 694 * width and height should be rounded up to the next multiple of 16
64863965
MN
695 * - encoding: unused
696 * - decoding: set by lavc, user can override
b71901e6 697 */
492cd3a9 698 int (*get_buffer)(struct AVCodecContext *c, AVFrame *pic);
b71901e6
MN
699
700 /**
1e491e29
MN
701 * called to release buffers which where allocated with get_buffer.
702 * a released buffer can be reused in get_buffer()
703 * pic.data[*] must be set to NULL
64863965
MN
704 * - encoding: unused
705 * - decoding: set by lavc, user can override
b71901e6 706 */
492cd3a9 707 void (*release_buffer)(struct AVCodecContext *c, AVFrame *pic);
0fd90455 708
b71901e6 709 /**
64863965
MN
710 * is 1 if the decoded stream contains b frames, 0 otherwise.
711 * - encoding: unused
712 * - decoding: set by lavc
b71901e6
MN
713 */
714 int has_b_frames;
b71901e6 715
64863965 716 int block_align; ///< used by some WAV based audio codecs
ce980a95 717
64863965 718 int parse_only; /* - decoding only: if true, only parsing is done
917e06c8
FB
719 (function avcodec_parse_frame()). The frame
720 data is returned. Only MPEG codecs support this now. */
ce980a95 721
b71901e6 722 /**
e4eadb4b 723 * 0-> h263 quant 1-> mpeg quant.
64863965
MN
724 * - encoding: set by user.
725 * - decoding: unused
b71901e6
MN
726 */
727 int mpeg_quant;
ce980a95 728
b71901e6 729 /**
64863965
MN
730 * pass1 encoding statistics output buffer.
731 * - encoding: set by lavc
732 * - decoding: unused
b71901e6 733 */
64863965 734 char *stats_out;
b71901e6
MN
735
736 /**
737 * pass2 encoding statistics input buffer.
738 * concatenated stuff from stats_out of pass1 should be placed here
64863965
MN
739 * - encoding: allocated/set/freed by user
740 * - decoding: unused
b71901e6
MN
741 */
742 char *stats_in;
743
744 /**
64863965 745 * ratecontrol qmin qmax limiting method.
b71901e6 746 * 0-> clipping, 1-> use a nice continous function to limit qscale wthin qmin/qmax
64863965
MN
747 * - encoding: set by user.
748 * - decoding: unused
b71901e6 749 */
ce980a95 750 float rc_qsquish;
b71901e6 751
ce980a95
MN
752 float rc_qmod_amp;
753 int rc_qmod_freq;
b71901e6
MN
754
755 /**
64863965
MN
756 * ratecontrol override, see RcOverride.
757 * - encoding: allocated/set/freed by user.
758 * - decoding: unused
b71901e6 759 */
ce980a95
MN
760 RcOverride *rc_override;
761 int rc_override_count;
b71901e6
MN
762
763 /**
64863965
MN
764 * rate control equation.
765 * - encoding: set by user
766 * - decoding: unused
b71901e6 767 */
ce980a95 768 char *rc_eq;
b71901e6
MN
769
770 /**
64863965
MN
771 * maximum bitrate.
772 * - encoding: set by user.
773 * - decoding: unused
b71901e6 774 */
ce980a95 775 int rc_max_rate;
b71901e6
MN
776
777 /**
64863965
MN
778 * minimum bitrate.
779 * - encoding: set by user.
780 * - decoding: unused
b71901e6 781 */
ce980a95 782 int rc_min_rate;
b71901e6
MN
783
784 /**
64863965
MN
785 * decoder bitstream buffer size.
786 * - encoding: set by user.
787 * - decoding: unused
b71901e6 788 */
ce980a95
MN
789 int rc_buffer_size;
790 float rc_buffer_aggressivity;
b71901e6
MN
791
792 /**
64863965
MN
793 * qscale factor between p and i frames.
794 * - encoding: set by user.
795 * - decoding: unused
b71901e6
MN
796 */
797 float i_quant_factor;
798
799 /**
64863965 800 * qscale offset between p and i frames.
b3a391e8
MN
801 * if > 0 then the last p frame quantizer will be used (q= lastp_q*factor+offset)
802 * if < 0 then normal ratecontrol will be done (q= -normal_q*factor+offset)
64863965
MN
803 * - encoding: set by user.
804 * - decoding: unused
b71901e6
MN
805 */
806 float i_quant_offset;
807
808 /**
64863965
MN
809 * initial complexity for pass1 ratecontrol.
810 * - encoding: set by user.
811 * - decoding: unused
b71901e6 812 */
ce980a95 813 float rc_initial_cplx;
917e06c8 814
b71901e6 815 /**
64863965
MN
816 * dct algorithm, see FF_DCT_* below.
817 * - encoding: set by user
818 * - decoding: unused
b71901e6 819 */
28db7fce 820 int dct_algo;
c7e07931 821#define FF_DCT_AUTO 0
28db7fce 822#define FF_DCT_FASTINT 1
c7e07931
MO
823#define FF_DCT_INT 2
824#define FF_DCT_MMX 3
825#define FF_DCT_MLIB 4
05c4072b 826#define FF_DCT_ALTIVEC 5
c5d309f2
MN
827
828 /**
64863965
MN
829 * luminance masking (0-> disabled).
830 * - encoding: set by user
831 * - decoding: unused
c5d309f2
MN
832 */
833 float lumi_masking;
834
835 /**
64863965
MN
836 * temporary complexity masking (0-> disabled).
837 * - encoding: set by user
838 * - decoding: unused
c5d309f2
MN
839 */
840 float temporal_cplx_masking;
841
842 /**
64863965
MN
843 * spatial complexity masking (0-> disabled).
844 * - encoding: set by user
845 * - decoding: unused
c5d309f2
MN
846 */
847 float spatial_cplx_masking;
848
849 /**
64863965
MN
850 * p block masking (0-> disabled).
851 * - encoding: set by user
852 * - decoding: unused
c5d309f2
MN
853 */
854 float p_masking;
15415af4 855
5e746b99 856 /**
64863965
MN
857 * darkness masking (0-> disabled).
858 * - encoding: set by user
859 * - decoding: unused
5e746b99
MN
860 */
861 float dark_masking;
0c2dd16e 862
3a694b04
NK
863
864 /* for binary compatibility */
865 int unused;
866
0c2dd16e 867 /**
64863965
MN
868 * idct algorithm, see FF_IDCT_* below.
869 * - encoding: set by user
870 * - decoding: set by user
2ad1516a
MN
871 */
872 int idct_algo;
873#define FF_IDCT_AUTO 0
874#define FF_IDCT_INT 1
875#define FF_IDCT_SIMPLE 2
876#define FF_IDCT_SIMPLEMMX 3
877#define FF_IDCT_LIBMPEG2MMX 4
878#define FF_IDCT_PS2 5
879#define FF_IDCT_MLIB 6
880#define FF_IDCT_ARM 7
05c4072b 881#define FF_IDCT_ALTIVEC 8
b82cdc72 882#define FF_IDCT_SH4 9
bd7d1ea7 883#define FF_IDCT_SIMPLEARM 10
2ad1516a 884
144f0625 885 /**
64863965
MN
886 * slice count.
887 * - encoding: set by lavc
888 * - decoding: set by user (or 0)
144f0625
MN
889 */
890 int slice_count;
891 /**
64863965
MN
892 * slice offsets in the frame in bytes.
893 * - encoding: set/allocated by lavc
894 * - decoding: set/allocated by user (or NULL)
144f0625
MN
895 */
896 int *slice_offset;
897
4d2858de 898 /**
64863965
MN
899 * error concealment flags.
900 * - encoding: unused
901 * - decoding: set by user
4d2858de
MN
902 */
903 int error_concealment;
904#define FF_EC_GUESS_MVS 1
905#define FF_EC_DEBLOCK 2
906
6b72ac63 907 /**
bec89a84 908 * dsp_mask could be add used to disable unwanted CPU features
8350df97 909 * CPU features (i.e. MMX, SSE. ...)
bec89a84
ZK
910 *
911 * with FORCE flag you may instead enable given CPU features
912 * (Dangerous: usable in case of misdetection, improper usage however will
913 * result into program crash)
914 */
915 unsigned dsp_mask;
916#define FF_MM_FORCE 0x80000000 /* force usage of selected flags (OR) */
917 /* lower 16 bits - CPU features */
918#ifdef HAVE_MMX
919#define FF_MM_MMX 0x0001 /* standard MMX */
920#define FF_MM_3DNOW 0x0004 /* AMD 3DNOW */
921#define FF_MM_MMXEXT 0x0002 /* SSE integer functions or AMD MMX ext */
922#define FF_MM_SSE 0x0008 /* SSE functions */
923#define FF_MM_SSE2 0x0010 /* PIV SSE2 functions */
924#endif /* HAVE_MMX */
11f18faf
MN
925
926 /**
64863965
MN
927 * bits per sample/pixel from the demuxer (needed for huffyuv).
928 * - encoding: set by lavc
929 * - decoding: set by user
11f18faf
MN
930 */
931 int bits_per_sample;
932
933 /**
64863965
MN
934 * prediction method (needed for huffyuv).
935 * - encoding: set by user
936 * - decoding: unused
11f18faf
MN
937 */
938 int prediction_method;
939#define FF_PRED_LEFT 0
940#define FF_PRED_PLANE 1
941#define FF_PRED_MEDIAN 2
5d3cea3a
MN
942
943 /**
64863965
MN
944 * aspect ratio (0 if unknown).
945 * - encoding: set by user.
946 * - decoding: set by lavc.
5d3cea3a
MN
947 */
948 float aspect_ratio;
1e491e29
MN
949
950 /**
64863965
MN
951 * the picture in the bitstream.
952 * - encoding: set by lavc
953 * - decoding: set by lavc
1e491e29 954 */
492cd3a9 955 AVFrame *coded_frame;
c8c437bc
MN
956
957 /**
64863965
MN
958 * debug.
959 * - encoding: set by user.
960 * - decoding: set by user.
c8c437bc
MN
961 */
962 int debug;
963#define FF_DEBUG_PICT_INFO 1
964#define FF_DEBUG_RC 2
965#define FF_DEBUG_BITSTREAM 4
966#define FF_DEBUG_MB_TYPE 8
967#define FF_DEBUG_QP 16
968#define FF_DEBUG_MV 32
41773b73
MN
969#define FF_DEBUG_VIS_MV 0x00000040
970#define FF_DEBUG_SKIP 0x00000080
971#define FF_DEBUG_STARTCODE 0x00000100
972#define FF_DEBUG_PTS 0x00000200
46b4feec 973#define FF_DEBUG_ER 0x00000400
0da71265 974#define FF_DEBUG_MMCO 0x00000800
140cb663
MN
975
976 /**
64863965
MN
977 * error.
978 * - encoding: set by lavc if flags&CODEC_FLAG_PSNR
979 * - decoding: unused
140cb663
MN
980 */
981 uint64_t error[4];
17a70fde
MN
982
983 /**
64863965
MN
984 * minimum MB quantizer.
985 * - encoding: set by user.
986 * - decoding: unused
17a70fde
MN
987 */
988 int mb_qmin;
989
990 /**
64863965
MN
991 * maximum MB quantizer.
992 * - encoding: set by user.
993 * - decoding: unused
17a70fde
MN
994 */
995 int mb_qmax;
1457ab52
MN
996
997 /**
64863965
MN
998 * motion estimation compare function.
999 * - encoding: set by user.
1000 * - decoding: unused
1457ab52
MN
1001 */
1002 int me_cmp;
1003 /**
64863965
MN
1004 * subpixel motion estimation compare function.
1005 * - encoding: set by user.
1006 * - decoding: unused
1457ab52
MN
1007 */
1008 int me_sub_cmp;
1009 /**
64863965
MN
1010 * macroblock compare function (not supported yet).
1011 * - encoding: set by user.
1012 * - decoding: unused
1457ab52
MN
1013 */
1014 int mb_cmp;
1015#define FF_CMP_SAD 0
1016#define FF_CMP_SSE 1
1017#define FF_CMP_SATD 2
1018#define FF_CMP_DCT 3
1019#define FF_CMP_PSNR 4
1020#define FF_CMP_BIT 5
1021#define FF_CMP_RD 6
1022#define FF_CMP_ZERO 7
1023#define FF_CMP_CHROMA 256
1024
1025 /**
64863965
MN
1026 * ME diamond size & shape.
1027 * - encoding: set by user.
1028 * - decoding: unused
1457ab52
MN
1029 */
1030 int dia_size;
b07a5980
MN
1031
1032 /**
64863965
MN
1033 * amount of previous MV predictors (2a+1 x 2a+1 square).
1034 * - encoding: set by user.
1035 * - decoding: unused
b07a5980
MN
1036 */
1037 int last_predictor_count;
70ac76c0 1038
f5fb6b34 1039 /**
64863965
MN
1040 * pre pass for motion estimation.
1041 * - encoding: set by user.
1042 * - decoding: unused
f5fb6b34
MN
1043 */
1044 int pre_me;
b07a5980 1045
70ac76c0 1046 /**
64863965
MN
1047 * motion estimation pre pass compare function.
1048 * - encoding: set by user.
1049 * - decoding: unused
70ac76c0
MN
1050 */
1051 int me_pre_cmp;
826f429a 1052
70ac76c0 1053 /**
64863965
MN
1054 * ME pre pass diamond size & shape.
1055 * - encoding: set by user.
1056 * - decoding: unused
70ac76c0
MN
1057 */
1058 int pre_dia_size;
1059
826f429a 1060 /**
64863965
MN
1061 * subpel ME quality.
1062 * - encoding: set by user.
1063 * - decoding: unused
826f429a
MN
1064 */
1065 int me_subpel_quality;
1066
a33c7159 1067 /**
64863965 1068 * callback to negotiate the pixelFormat.
a33c7159
MN
1069 * @param fmt is the list of formats which are supported by the codec,
1070 * its terminated by -1 as 0 is a valid format, the formats are ordered by quality
1071 * the first is allways the native one
1072 * @return the choosen format
64863965
MN
1073 * - encoding: unused
1074 * - decoding: set by user, if not set then the native format will always be choosen
a33c7159
MN
1075 */
1076 enum PixelFormat (*get_format)(struct AVCodecContext *s, enum PixelFormat * fmt);
e2f9490e
FB
1077
1078 /**
1079 * DTG active format information (additionnal aspect ratio
1080 * information only used in DVB MPEG2 transport streams). 0 if
1081 * not set.
1082 *
64863965
MN
1083 * - encoding: unused.
1084 * - decoding: set by decoder
e2f9490e
FB
1085 */
1086 int dtg_active_format;
1087#define FF_DTG_AFD_SAME 8
1088#define FF_DTG_AFD_4_3 9
1089#define FF_DTG_AFD_16_9 10
1090#define FF_DTG_AFD_14_9 11
1091#define FF_DTG_AFD_4_3_SP_14_9 13
1092#define FF_DTG_AFD_16_9_SP_14_9 14
1093#define FF_DTG_AFD_SP_4_3 15
1094
ebbcdc9a
MN
1095 /**
1096 * Maximum motion estimation search range in subpel units.
1097 * if 0 then no limit
1098 *
64863965
MN
1099 * - encoding: set by user.
1100 * - decoding: unused.
ebbcdc9a 1101 */
59e0ac8e 1102 int me_range;
ebbcdc9a 1103
65f7062d
MN
1104 /**
1105 * frame_rate_base.
1106 * for variable fps this is 1
1107 * - encoding: set by user.
1108 * - decoding: set by lavc.
1109 * @todo move this after frame_rate
1110 */
65f7062d 1111
1984f635
MN
1112 int frame_rate_base;
1113 /**
1114 * intra quantizer bias.
1115 * - encoding: set by user.
1116 * - decoding: unused
1117 */
1118 int intra_quant_bias;
1119#define FF_DEFAULT_QUANT_BIAS 999999
1120
1121 /**
1122 * inter quantizer bias.
1123 * - encoding: set by user.
1124 * - decoding: unused
1125 */
1126 int inter_quant_bias;
5cd62665
ZK
1127
1128 /**
1129 * color table ID.
1130 * - encoding: unused.
1131 * - decoding: which clrtable should be used for 8bit RGB images
1132 * table have to be stored somewhere FIXME
1133 */
1134 int color_table_id;
1984f635 1135
d90cf87b
MN
1136 /**
1137 * internal_buffer count.
1138 * Dont touch, used by lavc default_get_buffer()
1139 */
1140 int internal_buffer_count;
1141
1142 /**
1143 * internal_buffers.
1144 * Dont touch, used by lavc default_get_buffer()
1145 */
1146 void *internal_buffer;
3d2e8cce
MN
1147
1148#define FF_QUALITY_SCALE 256
1149 /**
1150 * global quality for codecs which cannot change it per frame.
1151 * this should be proportional to MPEG1/2/4 qscale.
1152 * - encoding: set by user.
1153 * - decoding: unused
1154 */
1155 int global_quality;
11e659c2
MN
1156
1157#define FF_CODER_TYPE_VLC 0
1158#define FF_CODER_TYPE_AC 1
1159 /**
1160 * coder type
1161 * - encoding: set by user.
1162 * - decoding: unused
1163 */
1164 int coder_type;
1165
1166 /**
1167 * context model
1168 * - encoding: set by user.
1169 * - decoding: unused
1170 */
1171 int context_model;
3bb07d61
MN
1172
1173 /**
1174 * slice flags
1175 * - encoding: unused
1176 * - decoding: set by user.
1177 */
1178 int slice_flags;
1179#define SLICE_FLAG_CODED_ORDER 0x0001 ///< draw_horiz_band() is called in coded order instead of display
1180#define SLICE_FLAG_ALLOW_FIELD 0x0002 ///< allow draw_horiz_band() with field slices (MPEG2 field pics)
1181#define SLICE_FLAG_ALLOW_PLANE 0x0004 ///< allow draw_horiz_band() with 1 component at a time (SVQ1)
1182
fb364ada
IK
1183 /**
1184 * XVideo Motion Acceleration
1185 * - encoding: forbidden
1186 * - decoding: set by decoder
1187 */
1188 int xvmc_acceleration;
7d1c3fc1
MN
1189
1190 /**
1191 * macroblock decision mode
1192 * - encoding: set by user.
1193 * - decoding: unused
1194 */
1195 int mb_decision;
1196#define FF_MB_DECISION_SIMPLE 0 ///< uses mb_cmp
1197#define FF_MB_DECISION_BITS 1 ///< chooses the one which needs the fewest bits
1198#define FF_MB_DECISION_RD 2 ///< rate distoration
d6eb3c50
MN
1199
1200 /**
1201 * custom intra quantization matrix
1202 * - encoding: set by user, can be NULL
1203 * - decoding: set by lavc
1204 */
1205 uint16_t *intra_matrix;
1206
1207 /**
1208 * custom inter quantization matrix
1209 * - encoding: set by user, can be NULL
1210 * - decoding: set by lavc
1211 */
1212 uint16_t *inter_matrix;
7d1c3fc1 1213
de6d9b64
FB
1214} AVCodecContext;
1215
97d96aaa 1216
64863965
MN
1217/**
1218 * AVOption.
1219 */
97d96aaa
ZK
1220typedef struct AVOption {
1221 /** options' name */
1222 const char *name; /* if name is NULL, it indicates a link to next */
bec89a84
ZK
1223 /** short English text help or const struct AVOption* subpointer */
1224 const char *help; // const struct AVOption* sub;
97d96aaa
ZK
1225 /** offset to context structure where the parsed value should be stored */
1226 int offset;
1227 /** options' type */
1228 int type;
64863965
MN
1229#define FF_OPT_TYPE_BOOL 1 ///< boolean - true,1,on (or simply presence)
1230#define FF_OPT_TYPE_DOUBLE 2 ///< double
1231#define FF_OPT_TYPE_INT 3 ///< integer
1232#define FF_OPT_TYPE_STRING 4 ///< string (finished with \0)
1233#define FF_OPT_TYPE_MASK 0x1f ///< mask for types - upper bits are various flags
97d96aaa
ZK
1234//#define FF_OPT_TYPE_EXPERT 0x20 // flag for expert option
1235#define FF_OPT_TYPE_FLAG (FF_OPT_TYPE_BOOL | 0x40)
1236#define FF_OPT_TYPE_RCOVERRIDE (FF_OPT_TYPE_STRING | 0x80)
1237 /** min value (min == max -> no limits) */
1238 double min;
1239 /** maximum value for double/int */
1240 double max;
1241 /** default boo [0,1]l/double/int value */
1242 double defval;
1243 /**
1244 * default string value (with optional semicolon delimited extra option-list
1245 * i.e. option1;option2;option3
1246 * defval might select other then first argument as default
1247 */
1248 const char *defstr;
97d96aaa
ZK
1249#define FF_OPT_MAX_DEPTH 10
1250} AVOption;
1251
64863965 1252/**
bec89a84
ZK
1253 * Parse option(s) and sets fields in passed structure
1254 * @param strct structure where the parsed results will be written
1255 * @param list list with AVOptions
1256 * @param opts string with options for parsing
1257 */
1258int avoption_parse(void* strct, const AVOption* list, const char* opts);
1259
1260
1261/**
64863965
MN
1262 * AVCodec.
1263 */
de6d9b64 1264typedef struct AVCodec {
18f77016 1265 const char *name;
5d234974 1266 enum CodecType type;
de6d9b64
FB
1267 int id;
1268 int priv_data_size;
1269 int (*init)(AVCodecContext *);
0c1a9eda 1270 int (*encode)(AVCodecContext *, uint8_t *buf, int buf_size, void *data);
de6d9b64 1271 int (*close)(AVCodecContext *);
0fd90455 1272 int (*decode)(AVCodecContext *, void *outdata, int *outdata_size,
0c1a9eda 1273 uint8_t *buf, int buf_size);
bf89e6b1 1274 int capabilities;
97d96aaa 1275 const AVOption *options;
de6d9b64 1276 struct AVCodec *next;
7a06ff14 1277 void (*flush)(AVCodecContext *);
de6d9b64
FB
1278} AVCodec;
1279
97d96aaa 1280/**
d7425f59
MN
1281 * four components are given, that's all.
1282 * the last component is alpha
1283 */
de6d9b64 1284typedef struct AVPicture {
0c1a9eda 1285 uint8_t *data[4];
cd394651 1286 int linesize[4]; ///< number of bytes per line
de6d9b64
FB
1287} AVPicture;
1288
1289extern AVCodec ac3_encoder;
1290extern AVCodec mp2_encoder;
9d36bdc9 1291extern AVCodec mp3lame_encoder;
81e0d0b4 1292extern AVCodec oggvorbis_encoder;
de6d9b64 1293extern AVCodec mpeg1video_encoder;
029911d1 1294extern AVCodec mpeg2video_encoder;
de6d9b64
FB
1295extern AVCodec h263_encoder;
1296extern AVCodec h263p_encoder;
d4f5d74a 1297extern AVCodec flv_encoder;
de6d9b64
FB
1298extern AVCodec rv10_encoder;
1299extern AVCodec mjpeg_encoder;
b1e6b355 1300extern AVCodec ljpeg_encoder;
bf89e6b1 1301extern AVCodec mpeg4_encoder;
84afee34
MN
1302extern AVCodec msmpeg4v1_encoder;
1303extern AVCodec msmpeg4v2_encoder;
1304extern AVCodec msmpeg4v3_encoder;
0151a6f5
MN
1305extern AVCodec wmv1_encoder;
1306extern AVCodec wmv2_encoder;
11f18faf 1307extern AVCodec huffyuv_encoder;
0da71265 1308extern AVCodec h264_encoder;
3d2e8cce 1309extern AVCodec asv1_encoder;
9b56edf5 1310extern AVCodec asv2_encoder;
be3564ed 1311extern AVCodec vcr1_encoder;
5e20f836 1312extern AVCodec ffv1_encoder;
c3bf0288 1313extern AVCodec mdec_encoder;
de6d9b64
FB
1314
1315extern AVCodec h263_decoder;
bf89e6b1 1316extern AVCodec mpeg4_decoder;
84afee34
MN
1317extern AVCodec msmpeg4v1_decoder;
1318extern AVCodec msmpeg4v2_decoder;
1319extern AVCodec msmpeg4v3_decoder;
e1a9dbff 1320extern AVCodec wmv1_decoder;
0151a6f5 1321extern AVCodec wmv2_decoder;
922bc38d
MN
1322extern AVCodec mpeg1video_decoder;
1323extern AVCodec mpeg2video_decoder;
fb364ada 1324extern AVCodec mpeg_xvmc_decoder;
de6d9b64 1325extern AVCodec h263i_decoder;
d4f5d74a 1326extern AVCodec flv_decoder;
de6d9b64 1327extern AVCodec rv10_decoder;
be8ffec9 1328extern AVCodec svq1_decoder;
8b82a956 1329extern AVCodec svq3_decoder;
020fcc94
FB
1330extern AVCodec dvvideo_decoder;
1331extern AVCodec dvaudio_decoder;
bc8d1857
FB
1332extern AVCodec wmav1_decoder;
1333extern AVCodec wmav2_decoder;
4e66ab3b 1334extern AVCodec mjpeg_decoder;
b135d9fb 1335extern AVCodec mjpegb_decoder;
4b1f4f23 1336extern AVCodec mp2_decoder;
a96b68b7 1337extern AVCodec mp3_decoder;
3f95e843
FR
1338extern AVCodec mace3_decoder;
1339extern AVCodec mace6_decoder;
11f18faf 1340extern AVCodec huffyuv_decoder;
3aca208a 1341extern AVCodec oggvorbis_decoder;
f70f7c6d 1342extern AVCodec cyuv_decoder;
0da71265 1343extern AVCodec h264_decoder;
deabd4fd 1344extern AVCodec indeo3_decoder;
d86053a4 1345extern AVCodec vp3_decoder;
891f64b3 1346extern AVCodec amr_nb_decoder;
bc634f6f 1347extern AVCodec amr_nb_encoder;
280bd7b7
ZK
1348extern AVCodec aac_decoder;
1349extern AVCodec mpeg4aac_decoder;
3d2e8cce 1350extern AVCodec asv1_decoder;
9b56edf5 1351extern AVCodec asv2_decoder;
be3564ed 1352extern AVCodec vcr1_decoder;
3aff069b 1353extern AVCodec cljr_decoder;
5e20f836 1354extern AVCodec ffv1_decoder;
8809cfee 1355extern AVCodec fourxm_decoder;
c3bf0288 1356extern AVCodec mdec_decoder;
3ef8be2b
MM
1357extern AVCodec roq_decoder;
1358extern AVCodec interplay_video_decoder;
b8414bbd
NK
1359extern AVCodec ra_144_decoder;
1360extern AVCodec ra_288_decoder;
3ef8be2b
MM
1361extern AVCodec roq_dpcm_decoder;
1362extern AVCodec interplay_dpcm_decoder;
de6d9b64 1363
a96b68b7
FB
1364/* pcm codecs */
1365#define PCM_CODEC(id, name) \
1366extern AVCodec name ## _decoder; \
f11d3f23 1367extern AVCodec name ## _encoder
a96b68b7
FB
1368
1369PCM_CODEC(CODEC_ID_PCM_S16LE, pcm_s16le);
1370PCM_CODEC(CODEC_ID_PCM_S16BE, pcm_s16be);
1371PCM_CODEC(CODEC_ID_PCM_U16LE, pcm_u16le);
1372PCM_CODEC(CODEC_ID_PCM_U16BE, pcm_u16be);
1373PCM_CODEC(CODEC_ID_PCM_S8, pcm_s8);
1374PCM_CODEC(CODEC_ID_PCM_U8, pcm_u8);
1375PCM_CODEC(CODEC_ID_PCM_ALAW, pcm_alaw);
1376PCM_CODEC(CODEC_ID_PCM_MULAW, pcm_mulaw);
1377
0147f198
FR
1378/* adpcm codecs */
1379
1380PCM_CODEC(CODEC_ID_ADPCM_IMA_QT, adpcm_ima_qt);
1381PCM_CODEC(CODEC_ID_ADPCM_IMA_WAV, adpcm_ima_wav);
1382PCM_CODEC(CODEC_ID_ADPCM_MS, adpcm_ms);
4b465299 1383PCM_CODEC(CODEC_ID_ADPCM_4XM, adpcm_4xm);
0147f198 1384
a96b68b7
FB
1385#undef PCM_CODEC
1386
1387/* dummy raw video codec */
63167088
RS
1388extern AVCodec rawvideo_encoder;
1389extern AVCodec rawvideo_decoder;
de6d9b64
FB
1390
1391/* the following codecs use external GPL libs */
de6d9b64
FB
1392extern AVCodec ac3_decoder;
1393
1394/* resample.c */
1395
1396struct ReSampleContext;
1397
1398typedef struct ReSampleContext ReSampleContext;
1399
1400ReSampleContext *audio_resample_init(int output_channels, int input_channels,
1401 int output_rate, int input_rate);
1402int audio_resample(ReSampleContext *s, short *output, short *input, int nb_samples);
1403void audio_resample_close(ReSampleContext *s);
1404
1405/* YUV420 format is assumed ! */
1406
1407struct ImgReSampleContext;
1408
1409typedef struct ImgReSampleContext ImgReSampleContext;
1410
1411ImgReSampleContext *img_resample_init(int output_width, int output_height,
1412 int input_width, int input_height);
ab6d194a
MN
1413
1414ImgReSampleContext *img_resample_full_init(int owidth, int oheight,
1415 int iwidth, int iheight,
1416 int topBand, int bottomBand,
1417 int leftBand, int rightBand);
1418
de6d9b64
FB
1419void img_resample(ImgReSampleContext *s,
1420 AVPicture *output, AVPicture *input);
1421
1422void img_resample_close(ImgReSampleContext *s);
1423
0c1a9eda 1424int avpicture_fill(AVPicture *picture, uint8_t *ptr,
2d1a4094 1425 int pix_fmt, int width, int height);
63167088
RS
1426int avpicture_layout(AVPicture* src, int pix_fmt, int width, int height,
1427 unsigned char *dest, int dest_size);
219b06c6 1428int avpicture_get_size(int pix_fmt, int width, int height);
dab64ebc
FB
1429void avcodec_get_chroma_sub_sample(int pix_fmt, int *h_shift, int *v_shift);
1430const char *avcodec_get_pix_fmt_name(int pix_fmt);
63167088 1431enum PixelFormat avcodec_get_pix_fmt(const char* name);
219b06c6 1432
fab21997
FB
1433#define FF_LOSS_RESOLUTION 0x0001 /* loss due to resolution change */
1434#define FF_LOSS_DEPTH 0x0002 /* loss due to color depth change */
1435#define FF_LOSS_COLORSPACE 0x0004 /* loss due to color space conversion */
1436#define FF_LOSS_ALPHA 0x0008 /* loss of alpha bits */
1437#define FF_LOSS_COLORQUANT 0x0010 /* loss due to color quantization */
1438#define FF_LOSS_CHROMA 0x0020 /* loss of chroma (e.g. rgb to gray conversion) */
1439
1440int avcodec_get_pix_fmt_loss(int dst_pix_fmt, int src_pix_fmt,
1441 int has_alpha);
1442int avcodec_find_best_pix_fmt(int pix_fmt_mask, int src_pix_fmt,
1443 int has_alpha, int *loss_ptr);
1444
0469baf1
FB
1445#define FF_ALPHA_TRANSP 0x0001 /* image has some totally transparent pixels */
1446#define FF_ALPHA_SEMI_TRANSP 0x0002 /* image has some transparent pixels */
1447int img_get_alpha_info(AVPicture *src, int pix_fmt, int width, int height);
1448
219b06c6
FB
1449/* convert among pixel formats */
1450int img_convert(AVPicture *dst, int dst_pix_fmt,
1451 AVPicture *src, int pix_fmt,
1452 int width, int height);
1453
1454/* deinterlace a picture */
1455int avpicture_deinterlace(AVPicture *dst, AVPicture *src,
de6d9b64
FB
1456 int pix_fmt, int width, int height);
1457
1458/* external high level API */
1459
1460extern AVCodec *first_avcodec;
1461
156e5023 1462/* returns LIBAVCODEC_VERSION_INT constant */
51a49663 1463unsigned avcodec_version(void);
8bceb6af 1464/* returns LIBAVCODEC_BUILD constant */
51a49663 1465unsigned avcodec_build(void);
de6d9b64
FB
1466void avcodec_init(void);
1467
1468void register_avcodec(AVCodec *format);
1469AVCodec *avcodec_find_encoder(enum CodecID id);
98f3b098 1470AVCodec *avcodec_find_encoder_by_name(const char *name);
de6d9b64
FB
1471AVCodec *avcodec_find_decoder(enum CodecID id);
1472AVCodec *avcodec_find_decoder_by_name(const char *name);
1473void avcodec_string(char *buf, int buf_size, AVCodecContext *enc, int encode);
1474
1e491e29 1475void avcodec_get_context_defaults(AVCodecContext *s);
7ffbb60e 1476AVCodecContext *avcodec_alloc_context(void);
492cd3a9 1477AVFrame *avcodec_alloc_frame(void);
1e491e29 1478
492cd3a9
MN
1479int avcodec_default_get_buffer(AVCodecContext *s, AVFrame *pic);
1480void avcodec_default_release_buffer(AVCodecContext *s, AVFrame *pic);
d90cf87b 1481void avcodec_default_free_buffers(AVCodecContext *s);
1e491e29 1482
7a06ff14
MN
1483/**
1484 * opens / inits the AVCodecContext.
1485 * not thread save!
1486 */
de6d9b64 1487int avcodec_open(AVCodecContext *avctx, AVCodec *codec);
7a06ff14 1488
0c1a9eda 1489int avcodec_decode_audio(AVCodecContext *avctx, int16_t *samples,
de6d9b64 1490 int *frame_size_ptr,
0c1a9eda 1491 uint8_t *buf, int buf_size);
492cd3a9 1492int avcodec_decode_video(AVCodecContext *avctx, AVFrame *picture,
de6d9b64 1493 int *got_picture_ptr,
0c1a9eda
ZK
1494 uint8_t *buf, int buf_size);
1495int avcodec_parse_frame(AVCodecContext *avctx, uint8_t **pdata,
917e06c8 1496 int *data_size_ptr,
0c1a9eda
ZK
1497 uint8_t *buf, int buf_size);
1498int avcodec_encode_audio(AVCodecContext *avctx, uint8_t *buf, int buf_size,
de6d9b64 1499 const short *samples);
0c1a9eda 1500int avcodec_encode_video(AVCodecContext *avctx, uint8_t *buf, int buf_size,
492cd3a9 1501 const AVFrame *pict);
de6d9b64
FB
1502
1503int avcodec_close(AVCodecContext *avctx);
1504
1505void avcodec_register_all(void);
a96b68b7 1506
1c2a8c7f
MN
1507void avcodec_flush_buffers(AVCodecContext *avctx);
1508
14bea432 1509/* misc usefull functions */
d8085ea7
MN
1510
1511/**
1512 * returns a single letter to describe the picture type
1513 */
1514char av_get_pict_type_char(int pict_type);
1515
14bea432
MN
1516/**
1517 * reduce a fraction.
1518 * this is usefull for framerate calculations
1519 * @param max the maximum allowed for dst_nom & dst_den
1520 * @return 1 if exact, 0 otherwise
1521 */
1522int av_reduce(int *dst_nom, int *dst_den, int64_t nom, int64_t den, int64_t max);
1523
1524/**
1525 * rescale a 64bit integer.
1526 * a simple a*b/c isnt possible as it can overflow
1527 */
1528int64_t av_rescale(int64_t a, int b, int c);
628d601b 1529
628d601b 1530
e8f14793
ZK
1531/**
1532 * Interface for 0.5.0 version
1533 *
1534 * do not even think about it's usage for this moment
1535 */
1536
1537typedef struct {
64863965 1538 /// compressed size used from given memory buffer
e8f14793
ZK
1539 int size;
1540 /// I/P/B frame type
1541 int frame_type;
1542} avc_enc_result_t;
1543
1544/**
1545 * Commands
1546 * order can't be changed - once it was defined
1547 */
1548typedef enum {
1549 // general commands
1550 AVC_OPEN_BY_NAME = 0xACA000,
1551 AVC_OPEN_BY_CODEC_ID,
1552 AVC_OPEN_BY_FOURCC,
1553 AVC_CLOSE,
1554
1555 AVC_FLUSH,
1556 // pin - struct { uint8_t* src, uint_t src_size }
1557 // pout - struct { AVPicture* img, consumed_bytes,
1558 AVC_DECODE,
1559 // pin - struct { AVPicture* img, uint8_t* dest, uint_t dest_size }
1560 // pout - uint_t used_from_dest_size
1561 AVC_ENCODE,
1562
1563 // query/get video commands
1564 AVC_GET_VERSION = 0xACB000,
1565 AVC_GET_WIDTH,
1566 AVC_GET_HEIGHT,
1567 AVC_GET_DELAY,
1568 AVC_GET_QUANT_TABLE,
1569 // ...
1570
1571 // query/get audio commands
1572 AVC_GET_FRAME_SIZE = 0xABC000,
1573
1574 // maybe define some simple structure which
1575 // might be passed to the user - but they can't
1576 // contain any codec specific parts and these
1577 // calls are usualy necessary only few times
1578
1579 // set video commands
1580 AVC_SET_WIDTH = 0xACD000,
1581 AVC_SET_HEIGHT,
1582
1583 // set video encoding commands
1584 AVC_SET_FRAME_RATE = 0xACD800,
1585 AVC_SET_QUALITY,
1586 AVC_SET_HURRY_UP,
1587
1588 // set audio commands
1589 AVC_SET_SAMPLE_RATE = 0xACE000,
1590 AVC_SET_CHANNELS,
1591
1592} avc_cmd_t;
1593
1594/**
1595 * \param handle allocated private structure by libavcodec
1596 * for initialization pass NULL - will be returned pout
1597 * user is supposed to know nothing about its structure
1598 * \param cmd type of operation to be performed
1599 * \param pint input parameter
1600 * \param pout output parameter
1601 *
1602 * \returns command status - eventually for query command it might return
1603 * integer resulting value
1604 */
1605int avcodec(void* handle, avc_cmd_t cmd, void* pin, void* pout);
1606
544eb99c 1607/* memory */
e4eadb4b 1608void *av_malloc(unsigned int size);
18f77016 1609void *av_mallocz(unsigned int size);
8e1e6f31 1610void *av_realloc(void *ptr, unsigned int size);
544eb99c 1611void av_free(void *ptr);
8e1e6f31 1612char *av_strdup(const char *s);
544eb99c
FB
1613void __av_freep(void **ptr);
1614#define av_freep(p) __av_freep((void **)(p))
97d96aaa 1615void *av_fast_realloc(void *ptr, unsigned int *size, unsigned int min_size);
855ea723
ZK
1616/* for static data only */
1617/* call av_free_static to release all staticaly allocated tables */
628d601b 1618void av_free_static(void);
855ea723
ZK
1619void *__av_mallocz_static(void** location, unsigned int size);
1620#define av_mallocz_static(p, s) __av_mallocz_static((void **)(p), s)
544eb99c 1621
02d697aa
ZK
1622#ifdef __cplusplus
1623}
1624#endif
1625
a96b68b7 1626#endif /* AVCODEC_H */