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