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