binary compatibility fix
[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
16 #define LIBAVCODEC_VERSION_INT 0x000406
17 #define LIBAVCODEC_VERSION "0.4.6"
18 #define LIBAVCODEC_BUILD 4662
19 #define LIBAVCODEC_BUILD_STR "4662"
20
21 #define LIBAVCODEC_IDENT "FFmpeg" LIBAVCODEC_VERSION "b" LIBAVCODEC_BUILD_STR
22
23 enum CodecID {
24 CODEC_ID_NONE,
25 CODEC_ID_MPEG1VIDEO,
26 CODEC_ID_H263,
27 CODEC_ID_RV10,
28 CODEC_ID_MP2,
29 CODEC_ID_MP3LAME,
30 CODEC_ID_VORBIS,
31 CODEC_ID_AC3,
32 CODEC_ID_MJPEG,
33 CODEC_ID_MJPEGB,
34 CODEC_ID_MPEG4,
35 CODEC_ID_RAWVIDEO,
36 CODEC_ID_MSMPEG4V1,
37 CODEC_ID_MSMPEG4V2,
38 CODEC_ID_MSMPEG4V3,
39 CODEC_ID_WMV1,
40 CODEC_ID_WMV2,
41 CODEC_ID_H263P,
42 CODEC_ID_H263I,
43 CODEC_ID_SVQ1,
44 CODEC_ID_DVVIDEO,
45 CODEC_ID_DVAUDIO,
46 CODEC_ID_WMAV1,
47 CODEC_ID_WMAV2,
48 CODEC_ID_MACE3,
49 CODEC_ID_MACE6,
50 CODEC_ID_HUFFYUV,
51 CODEC_ID_CYUV,
52
53 /* various pcm "codecs" */
54 CODEC_ID_PCM_S16LE,
55 CODEC_ID_PCM_S16BE,
56 CODEC_ID_PCM_U16LE,
57 CODEC_ID_PCM_U16BE,
58 CODEC_ID_PCM_S8,
59 CODEC_ID_PCM_U8,
60 CODEC_ID_PCM_MULAW,
61 CODEC_ID_PCM_ALAW,
62
63 /* various adpcm codecs */
64 CODEC_ID_ADPCM_IMA_QT,
65 CODEC_ID_ADPCM_IMA_WAV,
66 CODEC_ID_ADPCM_MS,
67 };
68
69 enum CodecType {
70 CODEC_TYPE_UNKNOWN = -1,
71 CODEC_TYPE_VIDEO,
72 CODEC_TYPE_AUDIO,
73 };
74
75 /**
76 * Pixel format.
77 */
78 enum PixelFormat {
79 PIX_FMT_YUV420P,
80 PIX_FMT_YUV422,
81 PIX_FMT_RGB24, ///< 3 bytes, R is first
82 PIX_FMT_BGR24, ///< 3 bytes, B is first
83 PIX_FMT_YUV422P,
84 PIX_FMT_YUV444P,
85 PIX_FMT_RGBA32, ///< always stored in cpu endianness
86 PIX_FMT_YUV410P,
87 PIX_FMT_YUV411P,
88 PIX_FMT_RGB565, ///< always stored in cpu endianness
89 PIX_FMT_RGB555, ///< always stored in cpu endianness, most significant bit to 1
90 PIX_FMT_GRAY8,
91 PIX_FMT_MONOWHITE, ///< 0 is white
92 PIX_FMT_MONOBLACK, ///< 0 is black
93 PIX_FMT_PAL8, ///< 8 bit with RGBA palette
94 PIX_FMT_NB,
95 };
96
97 /* currently unused, may be used if 24/32 bits samples ever supported */
98 enum SampleFormat {
99 SAMPLE_FMT_S16 = 0, ///< signed 16 bits
100 };
101
102 /* in bytes */
103 #define AVCODEC_MAX_AUDIO_FRAME_SIZE 131072
104
105 /**
106 * Required number of zero bytes at the end of the input bitstream for decoding.
107 * to avoid overreading (and possibly segfaulting)
108 */
109 #define FF_INPUT_BUFFER_PADDING_SIZE 8
110
111 /* motion estimation type, EPZS by default */
112 enum Motion_Est_ID {
113 ME_ZERO = 1,
114 ME_FULL,
115 ME_LOG,
116 ME_PHODS,
117 ME_EPZS,
118 ME_X1
119 };
120
121 typedef struct RcOverride{
122 int start_frame;
123 int end_frame;
124 int qscale; // if this is 0 then quality_factor will be used instead
125 float quality_factor;
126 } RcOverride;
127
128 /* only for ME compatiblity with old apps */
129 extern int motion_estimation_method;
130
131 /* ME algos sorted by quality */
132 static const int Motion_Est_QTab[] = { ME_ZERO, ME_PHODS, ME_LOG,
133 ME_X1, ME_EPZS, ME_FULL };
134
135
136 #define FF_MAX_B_FRAMES 8
137
138 /* encoding support
139 these flags can be passed in AVCodecContext.flags before initing
140 Note: note not everything is supported yet
141 */
142
143 #define CODEC_FLAG_HQ 0x0001 ///< brute force MB-type decission mode (slow)
144 #define CODEC_FLAG_QSCALE 0x0002 ///< use fixed qscale
145 #define CODEC_FLAG_4MV 0x0004 ///< 4 MV per MB allowed
146 #define CODEC_FLAG_QPEL 0x0010 ///< use qpel MC
147 #define CODEC_FLAG_GMC 0x0020 ///< use GMC
148 #define CODEC_FLAG_PART 0x0080 ///< use data partitioning
149 /* parent program gurantees that the input for b-frame containing streams is not written to
150 for at least s->max_b_frames+1 frames, if this is not set than the input will be copied */
151 #define CODEC_FLAG_INPUT_PRESERVED 0x0100
152 #define CODEC_FLAG_PASS1 0x0200 ///< use internal 2pass ratecontrol in first pass mode
153 #define CODEC_FLAG_PASS2 0x0400 ///< use internal 2pass ratecontrol in second pass mode
154 #define CODEC_FLAG_EXTERN_HUFF 0x1000 ///< use external huffman table (for mjpeg)
155 #define CODEC_FLAG_GRAY 0x2000 ///< only decode/encode grayscale
156 #define CODEC_FLAG_EMU_EDGE 0x4000///< dont draw edges
157 #define CODEC_FLAG_PSNR 0x8000 ///< error[?] variables will be set during encoding
158 #define CODEC_FLAG_TRUNCATED 0x00010000 /** input bitstream might be truncated at a random location instead
159 of only at frame boundaries */
160 #define CODEC_FLAG_NORMALIZE_AQP 0x00020000 ///< normalize adaptive quantization
161 #define CODEC_FLAG_INTERLACED_DCT 0x00040000 ///< use interlaced dct
162 #define CODEC_FLAG_LOW_DELAY 0x00080000 ///< force low delay / will fail on b frames
163 #define CODEC_FLAG_ALT_SCAN 0x00100000 ///< use alternate scan
164 #define CODEC_FLAG_TRELLIS_QUANT 0x00200000 ///< use trellis quantization
165 #define CODEC_FLAG_GLOBAL_HEADER 0x00400000 ///< place global headers in extradata instead of every keyframe
166 #define CODEC_FLAG_BITEXACT 0x00800000 ///< use only bitexact stuff (except (i)dct)
167 /* Fx : Flag for h263+ extra options */
168 #define CODEC_FLAG_H263P_AIC 0x01000000 ///< Advanced intra coding
169 #define CODEC_FLAG_H263P_UMV 0x02000000 ///< Unlimited motion vector
170 /* For advanced prediction mode, we reuse the 4MV flag */
171 /* Unsupported options :
172 * Syntax Arithmetic coding (SAC)
173 * Deblocking filter internal loop
174 * Slice structured
175 * Reference Picture Selection
176 * Independant Segment Decoding
177 * Alternative Inter * VLC
178 * Modified Quantization */
179 /* /Fx */
180 /* codec capabilities */
181
182 #define CODEC_CAP_DRAW_HORIZ_BAND 0x0001 ///< decoder can use draw_horiz_band callback
183 #define CODEC_CAP_DR1 0x0002 ///< direct rendering method 1
184 /* if 'parse_only' field is true, then avcodec_parse_frame() can be
185 used */
186 #define CODEC_CAP_PARSE_ONLY 0x0004
187 #define CODEC_CAP_TRUNCATED 0x0008
188
189 #define FF_COMMON_FRAME \
190 /**\
191 * pointer to the picture planes.\
192 * this might be different from the first allocated byte\
193 * - encoding: \
194 * - decoding: \
195 */\
196 uint8_t *data[4];\
197 int linesize[4];\
198 /**\
199 * pointer to the first allocated byte of the picture. can be used in get_buffer/release_buffer\
200 * this isnt used by lavc unless the default get/release_buffer() is used\
201 * - encoding: \
202 * - decoding: \
203 */\
204 uint8_t *base[4];\
205 /**\
206 * 1 -> keyframe, 0-> not\
207 * - encoding: set by lavc\
208 * - decoding: set by lavc\
209 */\
210 int key_frame;\
211 \
212 /**\
213 * picture type of the frame, see ?_TYPE below\
214 * - encoding: set by lavc for coded_picture (and set by user for input)\
215 * - decoding: set by lavc\
216 */\
217 int pict_type;\
218 \
219 /**\
220 * presentation timestamp in micro seconds (time when frame should be shown to user)\
221 * if 0 then the frame_rate will be used as reference\
222 * - encoding: MUST be set by user\
223 * - decoding: set by lavc\
224 */\
225 long long int pts;\
226 \
227 /**\
228 * picture number in bitstream order.\
229 * - encoding: set by\
230 * - decoding: set by lavc\
231 */\
232 int coded_picture_number;\
233 /**\
234 * picture number in display order.\
235 * - encoding: set by\
236 * - decoding: set by lavc\
237 */\
238 int display_picture_number;\
239 \
240 /**\
241 * quality (between 1 (good) and 31 (bad)) \
242 * - encoding: set by lavc for coded_picture (and set by user for input)\
243 * - decoding: set by lavc\
244 */\
245 float quality; \
246 \
247 /**\
248 * buffer age (1->was last buffer and dint change, 2->..., ...).\
249 * set to something large if the buffer has not been used yet \
250 * - encoding: unused\
251 * - decoding: MUST be set by get_buffer()\
252 */\
253 int age;\
254 \
255 /**\
256 * is this picture used as reference\
257 * - encoding: unused\
258 * - decoding: set by lavc (before get_buffer() call))\
259 */\
260 int reference;\
261 \
262 /**\
263 * QP table\
264 * - encoding: unused\
265 * - decoding: set by lavc\
266 */\
267 int8_t *qscale_table;\
268 /**\
269 * QP store stride\
270 * - encoding: unused\
271 * - decoding: set by lavc\
272 */\
273 int qstride;\
274 \
275 /**\
276 * mbskip_table[mb]>=1 if MB didnt change\
277 * stride= mb_width = (width+15)>>4\
278 * - encoding: unused\
279 * - decoding: set by lavc\
280 */\
281 uint8_t *mbskip_table;\
282 \
283 /**\
284 * for some private data of the user\
285 * - encoding: unused\
286 * - decoding: set by user\
287 */\
288 void *opaque;\
289 \
290 /**\
291 * error\
292 * - encoding: set by lavc if flags&CODEC_FLAG_PSNR\
293 * - decoding: unused\
294 */\
295 uint64_t error[4];\
296 \
297 /**\
298 * type of the buffer (to keep track of who has to dealloc data[*])\
299 * - encoding: set by the one who allocs it\
300 * - decoding: set by the one who allocs it\
301 * Note: user allocated (direct rendering) & internal buffers can not coexist currently\
302 */\
303 int type;\
304 \
305 /**\
306 * when decoding, this signal how much the picture must be delayed.\
307 * extra_delay = repeat_pict / (2*fps)\
308 * - encoding: unused\
309 * - decoding: set by lavc\
310 */\
311 int repeat_pict;
312
313
314 #define FF_BUFFER_TYPE_INTERNAL 1
315 #define FF_BUFFER_TYPE_USER 2 ///< Direct rendering buffers
316 #define FF_BUFFER_TYPE_SHARED 4 ///< buffer from somewher else, dont dealloc
317
318
319 #define FF_I_TYPE 1 // Intra
320 #define FF_P_TYPE 2 // Predicted
321 #define FF_B_TYPE 3 // Bi-dir predicted
322 #define FF_S_TYPE 4 // S(GMC)-VOP MPEG4
323
324 typedef struct AVFrame {
325 FF_COMMON_FRAME
326 } AVFrame;
327
328 #define DEFAULT_FRAME_RATE_BASE 1001000
329
330 /**
331 * main external api structure.
332 */
333 typedef struct AVCodecContext {
334 /**
335 * the average bitrate.
336 * - encoding: set by user. unused for constant quantizer encoding
337 * - decoding: set by lavc. 0 or some bitrate if this info is available in the stream
338 */
339 int bit_rate;
340
341 /**
342 * number of bits the bitstream is allowed to diverge from the reference.
343 * the reference can be CBR (for CBR pass1) or VBR (for pass2)
344 * - encoding: set by user. unused for constant quantizer encoding
345 * - decoding: unused
346 */
347 int bit_rate_tolerance;
348
349 /**
350 * CODEC_FLAG_*.
351 * - encoding: set by user.
352 * - decoding: set by user.
353 */
354 int flags;
355
356 /**
357 * some codecs needs additionnal format info. It is stored here
358 * - encoding: set by user.
359 * - decoding: set by lavc. (FIXME is this ok?)
360 */
361 int sub_id;
362
363 /**
364 * motion estimation algorithm used for video coding.
365 * - encoding: MUST be set by user.
366 * - decoding: unused
367 */
368 int me_method;
369
370 /**
371 * some codecs need / can use extra-data like huffman tables.
372 * mjpeg: huffman tables
373 * rv10: additional flags
374 * mpeg4: global headers (they can be in the bitstream or here)
375 * - encoding: set/allocated/freed by lavc.
376 * - decoding: set/allocated/freed by user.
377 */
378 void *extradata;
379 int extradata_size;
380
381 /* video only */
382 /**
383 * frames per sec multiplied by frame_rate_base.
384 * for variable fps this is the precission, so if the timestamps
385 * can be specified in msec precssion then this is 1000*frame_rate_base
386 * - encoding: MUST be set by user
387 * - decoding: set by lavc. 0 or the frame_rate if available
388 */
389 int frame_rate;
390
391 /**
392 * width / height.
393 * - encoding: MUST be set by user.
394 * - decoding: set by user, some codecs might override / change it during playback
395 */
396 int width, height;
397
398 #define FF_ASPECT_SQUARE 1
399 #define FF_ASPECT_4_3_625 2
400 #define FF_ASPECT_4_3_525 3
401 #define FF_ASPECT_16_9_625 4
402 #define FF_ASPECT_16_9_525 5
403 #define FF_ASPECT_EXTENDED 15
404
405 /**
406 * the number of pictures in a group of pitures, or 0 for intra_only.
407 * - encoding: set by user.
408 * - decoding: unused
409 */
410 int gop_size;
411
412 /**
413 * pixel format, see PIX_FMT_xxx.
414 * - encoding: unused
415 * - decoding: set by lavc.
416 */
417 enum PixelFormat pix_fmt;
418
419 /**
420 * Frame rate emulation. If not zero lower layer (i.e. format handler)
421 * has to read frames at native frame rate.
422 * - encoding: set by user.
423 * - decoding: unused.
424 */
425 int rate_emu;
426
427 /**
428 * if non NULL, 'draw_horiz_band' is called by the libavcodec
429 * decoder to draw an horizontal band. It improve cache usage. Not
430 * all codecs can do that. You must check the codec capabilities
431 * before
432 * - encoding: unused
433 * - decoding: set by user.
434 */
435 void (*draw_horiz_band)(struct AVCodecContext *s,
436 uint8_t **src_ptr, int linesize,
437 int y, int width, int height);
438
439 /* audio only */
440 int sample_rate; ///< samples per sec
441 int channels;
442 int sample_fmt; ///< sample format, currenly unused
443
444 /* the following data should not be initialized */
445 int frame_size; ///< in samples, initialized when calling 'init'
446 int frame_number; ///< audio or video frame number
447 int real_pict_num; ///< returns the real picture number of previous encoded frame
448
449 /**
450 * number of frames the decoded output will be delayed relative to
451 * the encoded input.
452 * - encoding: set by lavc.
453 * - decoding: unused
454 */
455 int delay;
456
457 /* - encoding parameters */
458 float qcompress; ///< amount of qscale change between easy & hard scenes (0.0-1.0)
459 float qblur; ///< amount of qscale smoothing over time (0.0-1.0)
460
461 /**
462 * minimum quantizer.
463 * - encoding: set by user.
464 * - decoding: unused
465 */
466 int qmin;
467
468 /**
469 * maximum quantizer.
470 * - encoding: set by user.
471 * - decoding: unused
472 */
473 int qmax;
474
475 /**
476 * maximum quantizer difference etween frames.
477 * - encoding: set by user.
478 * - decoding: unused
479 */
480 int max_qdiff;
481
482 /**
483 * maximum number of b frames between non b frames.
484 * note: the output will be delayed by max_b_frames+1 relative to the input
485 * - encoding: set by user.
486 * - decoding: unused
487 */
488 int max_b_frames;
489
490 /**
491 * qscale factor between ip and b frames.
492 * - encoding: set by user.
493 * - decoding: unused
494 */
495 float b_quant_factor;
496
497 /** obsolete FIXME remove */
498 int rc_strategy;
499 int b_frame_strategy;
500
501 /**
502 * hurry up amount.
503 * - encoding: unused
504 * - decoding: set by user. 1-> skip b frames, 2-> skip idct/dequant too, 5-> skip everything except header
505 */
506 int hurry_up;
507
508 struct AVCodec *codec;
509
510 void *priv_data;
511
512 /* The following data is for RTP friendly coding */
513 /* By now only H.263/H.263+/MPEG4 coder honours this */
514 int rtp_mode; /* 1 for activate RTP friendly-mode */
515 /* highers numbers represent more error-prone */
516 /* enviroments, by now just "1" exist */
517
518 int rtp_payload_size; /* The size of the RTP payload, the coder will */
519 /* do it's best to deliver a chunk with size */
520 /* below rtp_payload_size, the chunk will start */
521 /* with a start code on some codecs like H.263 */
522 /* This doesn't take account of any particular */
523 /* headers inside the transmited RTP payload */
524
525
526 /* The RTP callcack: This function is called */
527 /* every time the encoder as a packet to send */
528 /* Depends on the encoder if the data starts */
529 /* with a Start Code (it should) H.263 does */
530 void (*rtp_callback)(void *data, int size, int packet_number);
531
532 /* statistics, used for 2-pass encoding */
533 int mv_bits;
534 int header_bits;
535 int i_tex_bits;
536 int p_tex_bits;
537 int i_count;
538 int p_count;
539 int skip_count;
540 int misc_bits;
541
542 /**
543 * number of bits used for the previously encoded frame.
544 * - encoding: set by lavc
545 * - decoding: unused
546 */
547 int frame_bits;
548
549 /**
550 * private data of the user, can be used to carry app specific stuff.
551 * - encoding: set by user
552 * - decoding: set by user
553 */
554 void *opaque;
555
556 char codec_name[32];
557 enum CodecType codec_type; /* see CODEC_TYPE_xxx */
558 enum CodecID codec_id; /* see CODEC_ID_xxx */
559
560 /**
561 * fourcc (LSB first, so "ABCD" -> ('D'<<24) + ('C'<<16) + ('B'<<8) + 'A').
562 * this is used to workaround some encoder bugs
563 * - encoding: unused
564 * - decoding: set by user, will be converted to upper case by lavc during init
565 */
566 unsigned int codec_tag;
567
568 /**
569 * workaround bugs in encoders which sometimes cannot be detected automatically.
570 * - encoding: unused
571 * - decoding: set by user
572 */
573 int workaround_bugs;
574 #define FF_BUG_AUTODETECT 1 ///< autodetection
575 #define FF_BUG_OLD_MSMPEG4 2
576 #define FF_BUG_XVID_ILACE 4
577 #define FF_BUG_UMP4 8
578 #define FF_BUG_NO_PADDING 16
579 #define FF_BUG_AC_VLC 32
580 #define FF_BUG_QPEL_CHROMA 64
581 #define FF_BUG_STD_QPEL 128
582 #define FF_BUG_QPEL_CHROMA2 256
583 #define FF_BUG_DIRECT_BLOCKSIZE 512
584 #define FF_BUG_EDGE 1024
585 //#define FF_BUG_FAKE_SCALABILITY 16 //autodetection should work 100%
586
587 /**
588 * luma single coeff elimination threshold.
589 * - encoding: set by user
590 * - decoding: unused
591 */
592 int luma_elim_threshold;
593
594 /**
595 * chroma single coeff elimination threshold.
596 * - encoding: set by user
597 * - decoding: unused
598 */
599 int chroma_elim_threshold;
600
601 /**
602 * strictly follow the std (MPEG4, ...).
603 * - encoding: set by user
604 * - decoding: unused
605 */
606 int strict_std_compliance;
607
608 /**
609 * qscale offset between ip and b frames.
610 * if > 0 then the last p frame quantizer will be used (q= lastp_q*factor+offset)
611 * if < 0 then normal ratecontrol will be done (q= -normal_q*factor+offset)
612 * - encoding: set by user.
613 * - decoding: unused
614 */
615 float b_quant_offset;
616
617 /**
618 * error resilience higher values will detect more errors but may missdetect
619 * some more or less valid parts as errors.
620 * - encoding: unused
621 * - decoding: set by user
622 */
623 int error_resilience;
624 #define FF_ER_CAREFULL 1
625 #define FF_ER_COMPLIANT 2
626 #define FF_ER_AGGRESSIVE 3
627 #define FF_ER_VERY_AGGRESSIVE 4
628
629 /**
630 * called at the beginning of each frame to get a buffer for it.
631 * if pic.reference is set then the frame will be read later by lavc
632 * - encoding: unused
633 * - decoding: set by lavc, user can override
634 */
635 int (*get_buffer)(struct AVCodecContext *c, AVFrame *pic);
636
637 /**
638 * called to release buffers which where allocated with get_buffer.
639 * a released buffer can be reused in get_buffer()
640 * pic.data[*] must be set to NULL
641 * - encoding: unused
642 * - decoding: set by lavc, user can override
643 */
644 void (*release_buffer)(struct AVCodecContext *c, AVFrame *pic);
645
646 /**
647 * is 1 if the decoded stream contains b frames, 0 otherwise.
648 * - encoding: unused
649 * - decoding: set by lavc
650 */
651 int has_b_frames;
652
653 int block_align; ///< used by some WAV based audio codecs
654
655 int parse_only; /* - decoding only: if true, only parsing is done
656 (function avcodec_parse_frame()). The frame
657 data is returned. Only MPEG codecs support this now. */
658
659 /**
660 * 0-> h263 quant 1-> mpeg quant.
661 * - encoding: set by user.
662 * - decoding: unused
663 */
664 int mpeg_quant;
665
666 /**
667 * pass1 encoding statistics output buffer.
668 * - encoding: set by lavc
669 * - decoding: unused
670 */
671 char *stats_out;
672
673 /**
674 * pass2 encoding statistics input buffer.
675 * concatenated stuff from stats_out of pass1 should be placed here
676 * - encoding: allocated/set/freed by user
677 * - decoding: unused
678 */
679 char *stats_in;
680
681 /**
682 * ratecontrol qmin qmax limiting method.
683 * 0-> clipping, 1-> use a nice continous function to limit qscale wthin qmin/qmax
684 * - encoding: set by user.
685 * - decoding: unused
686 */
687 float rc_qsquish;
688
689 float rc_qmod_amp;
690 int rc_qmod_freq;
691
692 /**
693 * ratecontrol override, see RcOverride.
694 * - encoding: allocated/set/freed by user.
695 * - decoding: unused
696 */
697 RcOverride *rc_override;
698 int rc_override_count;
699
700 /**
701 * rate control equation.
702 * - encoding: set by user
703 * - decoding: unused
704 */
705 char *rc_eq;
706
707 /**
708 * maximum bitrate.
709 * - encoding: set by user.
710 * - decoding: unused
711 */
712 int rc_max_rate;
713
714 /**
715 * minimum bitrate.
716 * - encoding: set by user.
717 * - decoding: unused
718 */
719 int rc_min_rate;
720
721 /**
722 * decoder bitstream buffer size.
723 * - encoding: set by user.
724 * - decoding: unused
725 */
726 int rc_buffer_size;
727 float rc_buffer_aggressivity;
728
729 /**
730 * qscale factor between p and i frames.
731 * - encoding: set by user.
732 * - decoding: unused
733 */
734 float i_quant_factor;
735
736 /**
737 * qscale offset between p and i frames.
738 * if > 0 then the last p frame quantizer will be used (q= lastp_q*factor+offset)
739 * if < 0 then normal ratecontrol will be done (q= -normal_q*factor+offset)
740 * - encoding: set by user.
741 * - decoding: unused
742 */
743 float i_quant_offset;
744
745 /**
746 * initial complexity for pass1 ratecontrol.
747 * - encoding: set by user.
748 * - decoding: unused
749 */
750 float rc_initial_cplx;
751
752 /**
753 * dct algorithm, see FF_DCT_* below.
754 * - encoding: set by user
755 * - decoding: unused
756 */
757 int dct_algo;
758 #define FF_DCT_AUTO 0
759 #define FF_DCT_FASTINT 1
760 #define FF_DCT_INT 2
761 #define FF_DCT_MMX 3
762 #define FF_DCT_MLIB 4
763 #define FF_DCT_ALTIVEC 5
764
765 /**
766 * luminance masking (0-> disabled).
767 * - encoding: set by user
768 * - decoding: unused
769 */
770 float lumi_masking;
771
772 /**
773 * temporary complexity masking (0-> disabled).
774 * - encoding: set by user
775 * - decoding: unused
776 */
777 float temporal_cplx_masking;
778
779 /**
780 * spatial complexity masking (0-> disabled).
781 * - encoding: set by user
782 * - decoding: unused
783 */
784 float spatial_cplx_masking;
785
786 /**
787 * p block masking (0-> disabled).
788 * - encoding: set by user
789 * - decoding: unused
790 */
791 float p_masking;
792
793 /**
794 * darkness masking (0-> disabled).
795 * - encoding: set by user
796 * - decoding: unused
797 */
798 float dark_masking;
799
800 /**
801 * idct algorithm, see FF_IDCT_* below.
802 * - encoding: set by user
803 * - decoding: set by user
804 */
805 int idct_algo;
806 #define FF_IDCT_AUTO 0
807 #define FF_IDCT_INT 1
808 #define FF_IDCT_SIMPLE 2
809 #define FF_IDCT_SIMPLEMMX 3
810 #define FF_IDCT_LIBMPEG2MMX 4
811 #define FF_IDCT_PS2 5
812 #define FF_IDCT_MLIB 6
813 #define FF_IDCT_ARM 7
814 #define FF_IDCT_ALTIVEC 8
815
816 /**
817 * slice count.
818 * - encoding: set by lavc
819 * - decoding: set by user (or 0)
820 */
821 int slice_count;
822 /**
823 * slice offsets in the frame in bytes.
824 * - encoding: set/allocated by lavc
825 * - decoding: set/allocated by user (or NULL)
826 */
827 int *slice_offset;
828
829 /**
830 * error concealment flags.
831 * - encoding: unused
832 * - decoding: set by user
833 */
834 int error_concealment;
835 #define FF_EC_GUESS_MVS 1
836 #define FF_EC_DEBLOCK 2
837
838 /**
839 * dsp_mask could be add used to disable unwanted CPU features
840 * CPU features (i.e. MMX, SSE. ...)
841 *
842 * with FORCE flag you may instead enable given CPU features
843 * (Dangerous: usable in case of misdetection, improper usage however will
844 * result into program crash)
845 */
846 unsigned dsp_mask;
847 #define FF_MM_FORCE 0x80000000 /* force usage of selected flags (OR) */
848 /* lower 16 bits - CPU features */
849 #ifdef HAVE_MMX
850 #define FF_MM_MMX 0x0001 /* standard MMX */
851 #define FF_MM_3DNOW 0x0004 /* AMD 3DNOW */
852 #define FF_MM_MMXEXT 0x0002 /* SSE integer functions or AMD MMX ext */
853 #define FF_MM_SSE 0x0008 /* SSE functions */
854 #define FF_MM_SSE2 0x0010 /* PIV SSE2 functions */
855 #endif /* HAVE_MMX */
856
857 /**
858 * bits per sample/pixel from the demuxer (needed for huffyuv).
859 * - encoding: set by lavc
860 * - decoding: set by user
861 */
862 int bits_per_sample;
863
864 /**
865 * prediction method (needed for huffyuv).
866 * - encoding: set by user
867 * - decoding: unused
868 */
869 int prediction_method;
870 #define FF_PRED_LEFT 0
871 #define FF_PRED_PLANE 1
872 #define FF_PRED_MEDIAN 2
873
874 /**
875 * aspect ratio (0 if unknown).
876 * - encoding: set by user.
877 * - decoding: set by lavc.
878 */
879 float aspect_ratio;
880
881 /**
882 * the picture in the bitstream.
883 * - encoding: set by lavc
884 * - decoding: set by lavc
885 */
886 AVFrame *coded_frame;
887
888 /**
889 * debug.
890 * - encoding: set by user.
891 * - decoding: set by user.
892 */
893 int debug;
894 #define FF_DEBUG_PICT_INFO 1
895 #define FF_DEBUG_RC 2
896 #define FF_DEBUG_BITSTREAM 4
897 #define FF_DEBUG_MB_TYPE 8
898 #define FF_DEBUG_QP 16
899 #define FF_DEBUG_MV 32
900 #define FF_DEBUG_VIS_MV 0x00000040
901 #define FF_DEBUG_SKIP 0x00000080
902 #define FF_DEBUG_STARTCODE 0x00000100
903 #define FF_DEBUG_PTS 0x00000200
904 #define FF_DEBUG_ER 0x00000400
905
906 /**
907 * error.
908 * - encoding: set by lavc if flags&CODEC_FLAG_PSNR
909 * - decoding: unused
910 */
911 uint64_t error[4];
912
913 /**
914 * minimum MB quantizer.
915 * - encoding: set by user.
916 * - decoding: unused
917 */
918 int mb_qmin;
919
920 /**
921 * maximum MB quantizer.
922 * - encoding: set by user.
923 * - decoding: unused
924 */
925 int mb_qmax;
926
927 /**
928 * motion estimation compare function.
929 * - encoding: set by user.
930 * - decoding: unused
931 */
932 int me_cmp;
933 /**
934 * subpixel motion estimation compare function.
935 * - encoding: set by user.
936 * - decoding: unused
937 */
938 int me_sub_cmp;
939 /**
940 * macroblock compare function (not supported yet).
941 * - encoding: set by user.
942 * - decoding: unused
943 */
944 int mb_cmp;
945 #define FF_CMP_SAD 0
946 #define FF_CMP_SSE 1
947 #define FF_CMP_SATD 2
948 #define FF_CMP_DCT 3
949 #define FF_CMP_PSNR 4
950 #define FF_CMP_BIT 5
951 #define FF_CMP_RD 6
952 #define FF_CMP_ZERO 7
953 #define FF_CMP_CHROMA 256
954
955 /**
956 * ME diamond size & shape.
957 * - encoding: set by user.
958 * - decoding: unused
959 */
960 int dia_size;
961
962 /**
963 * amount of previous MV predictors (2a+1 x 2a+1 square).
964 * - encoding: set by user.
965 * - decoding: unused
966 */
967 int last_predictor_count;
968
969 /**
970 * pre pass for motion estimation.
971 * - encoding: set by user.
972 * - decoding: unused
973 */
974 int pre_me;
975
976 /**
977 * motion estimation pre pass compare function.
978 * - encoding: set by user.
979 * - decoding: unused
980 */
981 int me_pre_cmp;
982
983 /**
984 * ME pre pass diamond size & shape.
985 * - encoding: set by user.
986 * - decoding: unused
987 */
988 int pre_dia_size;
989
990 /**
991 * subpel ME quality.
992 * - encoding: set by user.
993 * - decoding: unused
994 */
995 int me_subpel_quality;
996
997 /**
998 * callback to negotiate the pixelFormat.
999 * @param fmt is the list of formats which are supported by the codec,
1000 * its terminated by -1 as 0 is a valid format, the formats are ordered by quality
1001 * the first is allways the native one
1002 * @return the choosen format
1003 * - encoding: unused
1004 * - decoding: set by user, if not set then the native format will always be choosen
1005 */
1006 enum PixelFormat (*get_format)(struct AVCodecContext *s, enum PixelFormat * fmt);
1007
1008 /**
1009 * DTG active format information (additionnal aspect ratio
1010 * information only used in DVB MPEG2 transport streams). 0 if
1011 * not set.
1012 *
1013 * - encoding: unused.
1014 * - decoding: set by decoder
1015 */
1016 int dtg_active_format;
1017 #define FF_DTG_AFD_SAME 8
1018 #define FF_DTG_AFD_4_3 9
1019 #define FF_DTG_AFD_16_9 10
1020 #define FF_DTG_AFD_14_9 11
1021 #define FF_DTG_AFD_4_3_SP_14_9 13
1022 #define FF_DTG_AFD_16_9_SP_14_9 14
1023 #define FF_DTG_AFD_SP_4_3 15
1024
1025 /**
1026 * Maximum motion estimation search range in subpel units.
1027 * if 0 then no limit
1028 *
1029 * - encoding: set by user.
1030 * - decoding: unused.
1031 */
1032 int me_range;
1033
1034 /**
1035 * frame_rate_base.
1036 * for variable fps this is 1
1037 * - encoding: set by user.
1038 * - decoding: set by lavc.
1039 * @todo move this after frame_rate
1040 */
1041 int frame_rate_base;
1042
1043 } AVCodecContext;
1044
1045
1046 /**
1047 * AVOption.
1048 */
1049 typedef struct AVOption {
1050 /** options' name */
1051 const char *name; /* if name is NULL, it indicates a link to next */
1052 /** short English text help or const struct AVOption* subpointer */
1053 const char *help; // const struct AVOption* sub;
1054 /** offset to context structure where the parsed value should be stored */
1055 int offset;
1056 /** options' type */
1057 int type;
1058 #define FF_OPT_TYPE_BOOL 1 ///< boolean - true,1,on (or simply presence)
1059 #define FF_OPT_TYPE_DOUBLE 2 ///< double
1060 #define FF_OPT_TYPE_INT 3 ///< integer
1061 #define FF_OPT_TYPE_STRING 4 ///< string (finished with \0)
1062 #define FF_OPT_TYPE_MASK 0x1f ///< mask for types - upper bits are various flags
1063 //#define FF_OPT_TYPE_EXPERT 0x20 // flag for expert option
1064 #define FF_OPT_TYPE_FLAG (FF_OPT_TYPE_BOOL | 0x40)
1065 #define FF_OPT_TYPE_RCOVERRIDE (FF_OPT_TYPE_STRING | 0x80)
1066 /** min value (min == max -> no limits) */
1067 double min;
1068 /** maximum value for double/int */
1069 double max;
1070 /** default boo [0,1]l/double/int value */
1071 double defval;
1072 /**
1073 * default string value (with optional semicolon delimited extra option-list
1074 * i.e. option1;option2;option3
1075 * defval might select other then first argument as default
1076 */
1077 const char *defstr;
1078 #define FF_OPT_MAX_DEPTH 10
1079 } AVOption;
1080
1081 /**
1082 * Parse option(s) and sets fields in passed structure
1083 * @param strct structure where the parsed results will be written
1084 * @param list list with AVOptions
1085 * @param opts string with options for parsing
1086 */
1087 int avoption_parse(void* strct, const AVOption* list, const char* opts);
1088
1089
1090 /**
1091 * AVCodec.
1092 */
1093 typedef struct AVCodec {
1094 const char *name;
1095 int type;
1096 int id;
1097 int priv_data_size;
1098 int (*init)(AVCodecContext *);
1099 int (*encode)(AVCodecContext *, uint8_t *buf, int buf_size, void *data);
1100 int (*close)(AVCodecContext *);
1101 int (*decode)(AVCodecContext *, void *outdata, int *outdata_size,
1102 uint8_t *buf, int buf_size);
1103 int capabilities;
1104 const AVOption *options;
1105 struct AVCodec *next;
1106 } AVCodec;
1107
1108 /**
1109 * four components are given, that's all.
1110 * the last component is alpha
1111 */
1112 typedef struct AVPicture {
1113 uint8_t *data[4];
1114 int linesize[4];
1115 } AVPicture;
1116
1117 extern AVCodec ac3_encoder;
1118 extern AVCodec mp2_encoder;
1119 extern AVCodec mp3lame_encoder;
1120 extern AVCodec oggvorbis_encoder;
1121 extern AVCodec mpeg1video_encoder;
1122 extern AVCodec h263_encoder;
1123 extern AVCodec h263p_encoder;
1124 extern AVCodec rv10_encoder;
1125 extern AVCodec mjpeg_encoder;
1126 extern AVCodec mpeg4_encoder;
1127 extern AVCodec msmpeg4v1_encoder;
1128 extern AVCodec msmpeg4v2_encoder;
1129 extern AVCodec msmpeg4v3_encoder;
1130 extern AVCodec wmv1_encoder;
1131 extern AVCodec wmv2_encoder;
1132 extern AVCodec huffyuv_encoder;
1133
1134 extern AVCodec h263_decoder;
1135 extern AVCodec mpeg4_decoder;
1136 extern AVCodec msmpeg4v1_decoder;
1137 extern AVCodec msmpeg4v2_decoder;
1138 extern AVCodec msmpeg4v3_decoder;
1139 extern AVCodec wmv1_decoder;
1140 extern AVCodec wmv2_decoder;
1141 extern AVCodec mpeg_decoder;
1142 extern AVCodec h263i_decoder;
1143 extern AVCodec rv10_decoder;
1144 extern AVCodec svq1_decoder;
1145 extern AVCodec dvvideo_decoder;
1146 extern AVCodec dvaudio_decoder;
1147 extern AVCodec wmav1_decoder;
1148 extern AVCodec wmav2_decoder;
1149 extern AVCodec mjpeg_decoder;
1150 extern AVCodec mjpegb_decoder;
1151 extern AVCodec mp2_decoder;
1152 extern AVCodec mp3_decoder;
1153 extern AVCodec mace3_decoder;
1154 extern AVCodec mace6_decoder;
1155 extern AVCodec huffyuv_decoder;
1156 extern AVCodec oggvorbis_decoder;
1157 extern AVCodec cyuv_decoder;
1158
1159 /* pcm codecs */
1160 #define PCM_CODEC(id, name) \
1161 extern AVCodec name ## _decoder; \
1162 extern AVCodec name ## _encoder
1163
1164 PCM_CODEC(CODEC_ID_PCM_S16LE, pcm_s16le);
1165 PCM_CODEC(CODEC_ID_PCM_S16BE, pcm_s16be);
1166 PCM_CODEC(CODEC_ID_PCM_U16LE, pcm_u16le);
1167 PCM_CODEC(CODEC_ID_PCM_U16BE, pcm_u16be);
1168 PCM_CODEC(CODEC_ID_PCM_S8, pcm_s8);
1169 PCM_CODEC(CODEC_ID_PCM_U8, pcm_u8);
1170 PCM_CODEC(CODEC_ID_PCM_ALAW, pcm_alaw);
1171 PCM_CODEC(CODEC_ID_PCM_MULAW, pcm_mulaw);
1172
1173 /* adpcm codecs */
1174
1175 PCM_CODEC(CODEC_ID_ADPCM_IMA_QT, adpcm_ima_qt);
1176 PCM_CODEC(CODEC_ID_ADPCM_IMA_WAV, adpcm_ima_wav);
1177 PCM_CODEC(CODEC_ID_ADPCM_MS, adpcm_ms);
1178
1179 #undef PCM_CODEC
1180
1181 /* dummy raw video codec */
1182 extern AVCodec rawvideo_codec;
1183
1184 /* the following codecs use external GPL libs */
1185 extern AVCodec ac3_decoder;
1186
1187 /* resample.c */
1188
1189 struct ReSampleContext;
1190
1191 typedef struct ReSampleContext ReSampleContext;
1192
1193 ReSampleContext *audio_resample_init(int output_channels, int input_channels,
1194 int output_rate, int input_rate);
1195 int audio_resample(ReSampleContext *s, short *output, short *input, int nb_samples);
1196 void audio_resample_close(ReSampleContext *s);
1197
1198 /* YUV420 format is assumed ! */
1199
1200 struct ImgReSampleContext;
1201
1202 typedef struct ImgReSampleContext ImgReSampleContext;
1203
1204 ImgReSampleContext *img_resample_init(int output_width, int output_height,
1205 int input_width, int input_height);
1206
1207 ImgReSampleContext *img_resample_full_init(int owidth, int oheight,
1208 int iwidth, int iheight,
1209 int topBand, int bottomBand,
1210 int leftBand, int rightBand);
1211
1212 void img_resample(ImgReSampleContext *s,
1213 AVPicture *output, AVPicture *input);
1214
1215 void img_resample_close(ImgReSampleContext *s);
1216
1217 int avpicture_fill(AVPicture *picture, uint8_t *ptr,
1218 int pix_fmt, int width, int height);
1219 int avpicture_get_size(int pix_fmt, int width, int height);
1220 void avcodec_get_chroma_sub_sample(int pix_fmt, int *h_shift, int *v_shift);
1221 const char *avcodec_get_pix_fmt_name(int pix_fmt);
1222
1223 /* convert among pixel formats */
1224 int img_convert(AVPicture *dst, int dst_pix_fmt,
1225 AVPicture *src, int pix_fmt,
1226 int width, int height);
1227
1228 /* deinterlace a picture */
1229 int avpicture_deinterlace(AVPicture *dst, AVPicture *src,
1230 int pix_fmt, int width, int height);
1231
1232 /* external high level API */
1233
1234 extern AVCodec *first_avcodec;
1235
1236 /* returns LIBAVCODEC_VERSION_INT constant */
1237 unsigned avcodec_version(void);
1238 /* returns LIBAVCODEC_BUILD constant */
1239 unsigned avcodec_build(void);
1240 void avcodec_init(void);
1241
1242 void register_avcodec(AVCodec *format);
1243 AVCodec *avcodec_find_encoder(enum CodecID id);
1244 AVCodec *avcodec_find_encoder_by_name(const char *name);
1245 AVCodec *avcodec_find_decoder(enum CodecID id);
1246 AVCodec *avcodec_find_decoder_by_name(const char *name);
1247 void avcodec_string(char *buf, int buf_size, AVCodecContext *enc, int encode);
1248
1249 void avcodec_get_context_defaults(AVCodecContext *s);
1250 AVCodecContext *avcodec_alloc_context(void);
1251 AVFrame *avcodec_alloc_frame(void);
1252
1253 int avcodec_default_get_buffer(AVCodecContext *s, AVFrame *pic);
1254 void avcodec_default_release_buffer(AVCodecContext *s, AVFrame *pic);
1255
1256 int avcodec_open(AVCodecContext *avctx, AVCodec *codec);
1257 int avcodec_decode_audio(AVCodecContext *avctx, int16_t *samples,
1258 int *frame_size_ptr,
1259 uint8_t *buf, int buf_size);
1260 int avcodec_decode_video(AVCodecContext *avctx, AVFrame *picture,
1261 int *got_picture_ptr,
1262 uint8_t *buf, int buf_size);
1263 int avcodec_parse_frame(AVCodecContext *avctx, uint8_t **pdata,
1264 int *data_size_ptr,
1265 uint8_t *buf, int buf_size);
1266 int avcodec_encode_audio(AVCodecContext *avctx, uint8_t *buf, int buf_size,
1267 const short *samples);
1268 int avcodec_encode_video(AVCodecContext *avctx, uint8_t *buf, int buf_size,
1269 const AVFrame *pict);
1270
1271 int avcodec_close(AVCodecContext *avctx);
1272
1273 void avcodec_register_all(void);
1274
1275 void avcodec_flush_buffers(AVCodecContext *avctx);
1276
1277 /* misc usefull functions */
1278 /**
1279 * reduce a fraction.
1280 * this is usefull for framerate calculations
1281 * @param max the maximum allowed for dst_nom & dst_den
1282 * @return 1 if exact, 0 otherwise
1283 */
1284 int av_reduce(int *dst_nom, int *dst_den, int64_t nom, int64_t den, int64_t max);
1285
1286 /**
1287 * rescale a 64bit integer.
1288 * a simple a*b/c isnt possible as it can overflow
1289 */
1290 int64_t av_rescale(int64_t a, int b, int c);
1291
1292
1293 /**
1294 * Interface for 0.5.0 version
1295 *
1296 * do not even think about it's usage for this moment
1297 */
1298
1299 typedef struct {
1300 /// compressed size used from given memory buffer
1301 int size;
1302 /// I/P/B frame type
1303 int frame_type;
1304 } avc_enc_result_t;
1305
1306 /**
1307 * Commands
1308 * order can't be changed - once it was defined
1309 */
1310 typedef enum {
1311 // general commands
1312 AVC_OPEN_BY_NAME = 0xACA000,
1313 AVC_OPEN_BY_CODEC_ID,
1314 AVC_OPEN_BY_FOURCC,
1315 AVC_CLOSE,
1316
1317 AVC_FLUSH,
1318 // pin - struct { uint8_t* src, uint_t src_size }
1319 // pout - struct { AVPicture* img, consumed_bytes,
1320 AVC_DECODE,
1321 // pin - struct { AVPicture* img, uint8_t* dest, uint_t dest_size }
1322 // pout - uint_t used_from_dest_size
1323 AVC_ENCODE,
1324
1325 // query/get video commands
1326 AVC_GET_VERSION = 0xACB000,
1327 AVC_GET_WIDTH,
1328 AVC_GET_HEIGHT,
1329 AVC_GET_DELAY,
1330 AVC_GET_QUANT_TABLE,
1331 // ...
1332
1333 // query/get audio commands
1334 AVC_GET_FRAME_SIZE = 0xABC000,
1335
1336 // maybe define some simple structure which
1337 // might be passed to the user - but they can't
1338 // contain any codec specific parts and these
1339 // calls are usualy necessary only few times
1340
1341 // set video commands
1342 AVC_SET_WIDTH = 0xACD000,
1343 AVC_SET_HEIGHT,
1344
1345 // set video encoding commands
1346 AVC_SET_FRAME_RATE = 0xACD800,
1347 AVC_SET_QUALITY,
1348 AVC_SET_HURRY_UP,
1349
1350 // set audio commands
1351 AVC_SET_SAMPLE_RATE = 0xACE000,
1352 AVC_SET_CHANNELS,
1353
1354 } avc_cmd_t;
1355
1356 /**
1357 * \param handle allocated private structure by libavcodec
1358 * for initialization pass NULL - will be returned pout
1359 * user is supposed to know nothing about its structure
1360 * \param cmd type of operation to be performed
1361 * \param pint input parameter
1362 * \param pout output parameter
1363 *
1364 * \returns command status - eventually for query command it might return
1365 * integer resulting value
1366 */
1367 int avcodec(void* handle, avc_cmd_t cmd, void* pin, void* pout);
1368
1369 /* memory */
1370 void *av_malloc(unsigned int size);
1371 void *av_mallocz(unsigned int size);
1372 void *av_realloc(void *ptr, unsigned int size);
1373 void av_free(void *ptr);
1374 char *av_strdup(const char *s);
1375 void __av_freep(void **ptr);
1376 #define av_freep(p) __av_freep((void **)(p))
1377 void *av_fast_realloc(void *ptr, unsigned int *size, unsigned int min_size);
1378 /* for static data only */
1379 /* call av_free_static to release all staticaly allocated tables */
1380 void av_free_static(void);
1381 void *__av_mallocz_static(void** location, unsigned int size);
1382 #define av_mallocz_static(p, s) __av_mallocz_static((void **)(p), s)
1383
1384 #ifdef __cplusplus
1385 }
1386 #endif
1387
1388 #endif /* AVCODEC_H */