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