2 * copyright (c) 2001 Fabrice Bellard
4 * This file is part of FFmpeg.
6 * FFmpeg is free software; you can redistribute it and/or
7 * modify it under the terms of the GNU Lesser General Public
8 * License as published by the Free Software Foundation; either
9 * version 2.1 of the License, or (at your option) any later version.
11 * FFmpeg is distributed in the hope that it will be useful,
12 * but WITHOUT ANY WARRANTY; without even the implied warranty of
13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
14 * Lesser General Public License for more details.
16 * You should have received a copy of the GNU Lesser General Public
17 * License along with FFmpeg; if not, write to the Free Software
18 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
31 #include <sys/types.h> /* size_t */
33 #define AV_STRINGIFY(s) AV_TOSTRING(s)
34 #define AV_TOSTRING(s) #s
36 #define LIBAVCODEC_VERSION_INT ((51<<16)+(45<<8)+0)
37 #define LIBAVCODEC_VERSION 51.45.0
38 #define LIBAVCODEC_BUILD LIBAVCODEC_VERSION_INT
40 #define LIBAVCODEC_IDENT "Lavc" AV_STRINGIFY(LIBAVCODEC_VERSION)
42 #define AV_NOPTS_VALUE INT64_C(0x8000000000000000)
43 #define AV_TIME_BASE 1000000
44 #define AV_TIME_BASE_Q (AVRational){1, AV_TIME_BASE}
47 * Identifies the syntax and semantics of the bitstream.
48 * The principle is roughly:
49 * Two decoders with the same ID can decode the same streams.
50 * Two encoders with the same ID can encode compatible streams.
51 * There may be slight deviations from the principle due to implementation
54 * If you add a codec ID to this list, add it so that
55 * 1. no value of a existing codec ID changes (that would break ABI),
56 * 2. it is as close as possible to similar codecs.
61 CODEC_ID_MPEG2VIDEO, /* preferred ID for MPEG-1/2 video decoding */
62 CODEC_ID_MPEG2VIDEO_XVMC,
99 CODEC_ID_INTERPLAY_VIDEO,
111 CODEC_ID_TRUEMOTION1,
139 CODEC_ID_TRUEMOTION2,
156 CODEC_ID_DSICINVIDEO,
157 CODEC_ID_TIERTEXSEQVIDEO,
166 CODEC_ID_BETHSOFTVID,
172 /* various PCM "codecs" */
173 CODEC_ID_PCM_S16LE= 0x10000,
189 CODEC_ID_PCM_S24DAUD,
192 /* various ADPCM codecs */
193 CODEC_ID_ADPCM_IMA_QT= 0x11000,
194 CODEC_ID_ADPCM_IMA_WAV,
195 CODEC_ID_ADPCM_IMA_DK3,
196 CODEC_ID_ADPCM_IMA_DK4,
197 CODEC_ID_ADPCM_IMA_WS,
198 CODEC_ID_ADPCM_IMA_SMJPEG,
207 CODEC_ID_ADPCM_YAMAHA,
208 CODEC_ID_ADPCM_SBPRO_4,
209 CODEC_ID_ADPCM_SBPRO_3,
210 CODEC_ID_ADPCM_SBPRO_2,
212 CODEC_ID_ADPCM_IMA_AMV,
215 CODEC_ID_AMR_NB= 0x12000,
218 /* RealAudio codecs*/
219 CODEC_ID_RA_144= 0x13000,
222 /* various DPCM codecs */
223 CODEC_ID_ROQ_DPCM= 0x14000,
224 CODEC_ID_INTERPLAY_DPCM,
228 CODEC_ID_MP2= 0x15000,
229 CODEC_ID_MP3, /* preferred ID for decoding MPEG audio layer 1, 2 or 3 */
231 #if LIBAVCODEC_VERSION_INT < ((52<<16)+(0<<8)+0)
250 CODEC_ID_WESTWOOD_SND1,
251 CODEC_ID_GSM, /* as in Berlin toast format */
259 CODEC_ID_DSICINAUDIO,
263 CODEC_ID_GSM_MS, /* as found in WAV */
268 /* subtitle codecs */
269 CODEC_ID_DVD_SUBTITLE= 0x17000,
270 CODEC_ID_DVB_SUBTITLE,
271 CODEC_ID_TEXT, /* raw UTF-8 text */
274 CODEC_ID_MPEG2TS= 0x20000, /* _FAKE_ codec to indicate a raw MPEG-2 TS
275 * stream (only used by libavformat) */
278 #if LIBAVCODEC_VERSION_INT < ((52<<16)+(0<<8)+0)
279 /* CODEC_ID_MP3LAME is obsolete */
280 #define CODEC_ID_MP3LAME CODEC_ID_MP3
281 #define CODEC_ID_MPEG4AAC CODEC_ID_AAC
285 CODEC_TYPE_UNKNOWN = -1,
293 /* Currently unused, may be used if 24/32 bits samples are ever supported. */
294 /* all in native-endian format */
296 SAMPLE_FMT_NONE = -1,
297 SAMPLE_FMT_U8, ///< unsigned 8 bits
298 SAMPLE_FMT_S16, ///< signed 16 bits
299 SAMPLE_FMT_S24, ///< signed 24 bits
300 SAMPLE_FMT_S32, ///< signed 32 bits
301 SAMPLE_FMT_FLT, ///< float
305 #define AVCODEC_MAX_AUDIO_FRAME_SIZE 192000 // 1 second of 48khz 32bit audio
308 * Required number of additionally allocated bytes at the end of the input bitstream for decoding.
309 * This is mainly needed because some optimized bitstream readers read
310 * 32 or 64 bit at once and could read over the end.<br>
311 * Note: If the first 23 bits of the additional bytes are not 0, then damaged
312 * MPEG bitstreams could cause overread and segfault.
314 #define FF_INPUT_BUFFER_PADDING_SIZE 8
317 * minimum encoding buffer size
318 * Used to avoid some checks during header writing.
320 #define FF_MIN_BUFFER_SIZE 16384
322 /* motion estimation type, EPZS by default */
336 /* We leave some space between them for extensions (drop some
337 * keyframes for intra-only or drop just some bidir frames). */
338 AVDISCARD_NONE =-16, ///< discard nothing
339 AVDISCARD_DEFAULT= 0, ///< discard useless packets like 0 size packets in avi
340 AVDISCARD_NONREF = 8, ///< discard all non reference
341 AVDISCARD_BIDIR = 16, ///< discard all bidirectional frames
342 AVDISCARD_NONKEY = 32, ///< discard all frames except keyframes
343 AVDISCARD_ALL = 48, ///< discard all
346 typedef struct RcOverride{
349 int qscale; // If this is 0 then quality_factor will be used instead.
350 float quality_factor;
353 #define FF_MAX_B_FRAMES 16
356 These flags can be passed in AVCodecContext.flags before initialization.
357 Note: Not everything is supported yet.
360 #define CODEC_FLAG_QSCALE 0x0002 ///< Use fixed qscale.
361 #define CODEC_FLAG_4MV 0x0004 ///< 4 MV per MB allowed / advanced prediction for H.263.
362 #define CODEC_FLAG_QPEL 0x0010 ///< Use qpel MC.
363 #define CODEC_FLAG_GMC 0x0020 ///< Use GMC.
364 #define CODEC_FLAG_MV0 0x0040 ///< Always try a MB with MV=<0,0>.
365 #define CODEC_FLAG_PART 0x0080 ///< Use data partitioning.
366 /* The parent program guarantees that the input for B-frames containing
367 * streams is not written to for at least s->max_b_frames+1 frames, if
368 * this is not set the input will be copied. */
369 #define CODEC_FLAG_INPUT_PRESERVED 0x0100
370 #define CODEC_FLAG_PASS1 0x0200 ///< Use internal 2pass ratecontrol in first pass mode.
371 #define CODEC_FLAG_PASS2 0x0400 ///< Use internal 2pass ratecontrol in second pass mode.
372 #define CODEC_FLAG_EXTERN_HUFF 0x1000 ///< Use external Huffman table (for MJPEG).
373 #define CODEC_FLAG_GRAY 0x2000 ///< Only decode/encode grayscale.
374 #define CODEC_FLAG_EMU_EDGE 0x4000 ///< Don't draw edges.
375 #define CODEC_FLAG_PSNR 0x8000 ///< error[?] variables will be set during encoding.
376 #define CODEC_FLAG_TRUNCATED 0x00010000 /** Input bitstream might be truncated at a random
377 location instead of only at frame boundaries. */
378 #define CODEC_FLAG_NORMALIZE_AQP 0x00020000 ///< Normalize adaptive quantization.
379 #define CODEC_FLAG_INTERLACED_DCT 0x00040000 ///< Use interlaced DCT.
380 #define CODEC_FLAG_LOW_DELAY 0x00080000 ///< Force low delay.
381 #define CODEC_FLAG_ALT_SCAN 0x00100000 ///< Use alternate scan.
382 #define CODEC_FLAG_TRELLIS_QUANT 0x00200000 ///< Use trellis quantization.
383 #define CODEC_FLAG_GLOBAL_HEADER 0x00400000 ///< Place global headers in extradata instead of every keyframe.
384 #define CODEC_FLAG_BITEXACT 0x00800000 ///< Use only bitexact stuff (except (I)DCT).
385 /* Fx : Flag for h263+ extra options */
386 #if LIBAVCODEC_VERSION_INT < ((52<<16)+(0<<8)+0)
387 #define CODEC_FLAG_H263P_AIC 0x01000000 ///< H.263 advanced intra coding / MPEG-4 AC prediction (remove this)
389 #define CODEC_FLAG_AC_PRED 0x01000000 ///< H.263 advanced intra coding / MPEG-4 AC prediction
390 #define CODEC_FLAG_H263P_UMV 0x02000000 ///< unlimited motion vector
391 #define CODEC_FLAG_CBP_RD 0x04000000 ///< Use rate distortion optimization for cbp.
392 #define CODEC_FLAG_QP_RD 0x08000000 ///< Use rate distortion optimization for qp selectioon.
393 #define CODEC_FLAG_H263P_AIV 0x00000008 ///< H.263 alternative inter VLC
394 #define CODEC_FLAG_OBMC 0x00000001 ///< OBMC
395 #define CODEC_FLAG_LOOP_FILTER 0x00000800 ///< loop filter
396 #define CODEC_FLAG_H263P_SLICE_STRUCT 0x10000000
397 #define CODEC_FLAG_INTERLACED_ME 0x20000000 ///< interlaced motion estimation
398 #define CODEC_FLAG_SVCD_SCAN_OFFSET 0x40000000 ///< Will reserve space for SVCD scan offset user data.
399 #define CODEC_FLAG_CLOSED_GOP ((int)0x80000000)
400 #define CODEC_FLAG2_FAST 0x00000001 ///< Allow non spec compliant speedup tricks.
401 #define CODEC_FLAG2_STRICT_GOP 0x00000002 ///< Strictly enforce GOP size.
402 #define CODEC_FLAG2_NO_OUTPUT 0x00000004 ///< Skip bitstream encoding.
403 #define CODEC_FLAG2_LOCAL_HEADER 0x00000008 ///< Place global headers at every keyframe instead of in extradata.
404 #define CODEC_FLAG2_BPYRAMID 0x00000010 ///< H.264 allow B-frames to be used as references.
405 #define CODEC_FLAG2_WPRED 0x00000020 ///< H.264 weighted biprediction for B-frames
406 #define CODEC_FLAG2_MIXED_REFS 0x00000040 ///< H.264 one reference per partition, as opposed to one reference per macroblock
407 #define CODEC_FLAG2_8X8DCT 0x00000080 ///< H.264 high profile 8x8 transform
408 #define CODEC_FLAG2_FASTPSKIP 0x00000100 ///< H.264 fast pskip
409 #define CODEC_FLAG2_AUD 0x00000200 ///< H.264 access unit delimiters
410 #define CODEC_FLAG2_BRDO 0x00000400 ///< B-frame rate-distortion optimization
411 #define CODEC_FLAG2_INTRA_VLC 0x00000800 ///< Use MPEG-2 intra VLC table.
412 #define CODEC_FLAG2_MEMC_ONLY 0x00001000 ///< Only do ME/MC (I frames -> ref, P frame -> ME+MC).
413 #define CODEC_FLAG2_DROP_FRAME_TIMECODE 0x00002000 ///< timecode is in drop frame format.
414 #define CODEC_FLAG2_SKIP_RD 0x00004000 ///< RD optimal MB level residual skipping
415 #define CODEC_FLAG2_CHUNKS 0x00008000 ///< Input bitstream might be truncated at a packet boundaries instead of only at frame boundaries.
416 #define CODEC_FLAG2_NON_LINEAR_QUANT 0x00010000 ///< Use MPEG-2 nonlinear quantizer.
418 /* Unsupported options :
419 * Syntax Arithmetic coding (SAC)
420 * Reference Picture Selection
421 * Independent Segment Decoding */
423 /* codec capabilities */
425 #define CODEC_CAP_DRAW_HORIZ_BAND 0x0001 ///< Decoder can use draw_horiz_band callback.
427 * Codec uses get_buffer() for allocating buffers.
428 * direct rendering method 1
430 #define CODEC_CAP_DR1 0x0002
431 /* If 'parse_only' field is true, then avcodec_parse_frame() can be used. */
432 #define CODEC_CAP_PARSE_ONLY 0x0004
433 #define CODEC_CAP_TRUNCATED 0x0008
434 /* Codec can export data for HW decoding (XvMC). */
435 #define CODEC_CAP_HWACCEL 0x0010
437 * Codec has a nonzero delay and needs to be fed with NULL at the end to get the delayed data.
438 * If this is not set, the codec is guaranteed to never be fed with NULL data.
440 #define CODEC_CAP_DELAY 0x0020
442 * Codec can be fed a final frame with a smaller size.
443 * This can be used to prevent truncation of the last audio samples.
445 #define CODEC_CAP_SMALL_LAST_FRAME 0x0040
447 //The following defines may change, don't expect compatibility if you use them.
448 #define MB_TYPE_INTRA4x4 0x0001
449 #define MB_TYPE_INTRA16x16 0x0002 //FIXME H.264-specific
450 #define MB_TYPE_INTRA_PCM 0x0004 //FIXME H.264-specific
451 #define MB_TYPE_16x16 0x0008
452 #define MB_TYPE_16x8 0x0010
453 #define MB_TYPE_8x16 0x0020
454 #define MB_TYPE_8x8 0x0040
455 #define MB_TYPE_INTERLACED 0x0080
456 #define MB_TYPE_DIRECT2 0x0100 //FIXME
457 #define MB_TYPE_ACPRED 0x0200
458 #define MB_TYPE_GMC 0x0400
459 #define MB_TYPE_SKIP 0x0800
460 #define MB_TYPE_P0L0 0x1000
461 #define MB_TYPE_P1L0 0x2000
462 #define MB_TYPE_P0L1 0x4000
463 #define MB_TYPE_P1L1 0x8000
464 #define MB_TYPE_L0 (MB_TYPE_P0L0 | MB_TYPE_P1L0)
465 #define MB_TYPE_L1 (MB_TYPE_P0L1 | MB_TYPE_P1L1)
466 #define MB_TYPE_L0L1 (MB_TYPE_L0 | MB_TYPE_L1)
467 #define MB_TYPE_QUANT 0x00010000
468 #define MB_TYPE_CBP 0x00020000
469 //Note bits 24-31 are reserved for codec specific use (h264 ref0, mpeg1 0mv, ...)
473 * This specifies the area which should be displayed.
474 * Note there may be multiple such areas for one frame.
476 typedef struct AVPanScan{
479 * - encoding: Set by user.
480 * - decoding: Set by libavcodec.
485 * width and height in 1/16 pel
486 * - encoding: Set by user.
487 * - decoding: Set by libavcodec.
493 * position of the top left corner in 1/16 pel for up to 3 fields/frames
494 * - encoding: Set by user.
495 * - decoding: Set by libavcodec.
497 int16_t position[3][2];
500 #define FF_COMMON_FRAME \
502 * pointer to the picture planes.\
503 * This might be different from the first allocated byte\
510 * pointer to the first allocated byte of the picture. Can be used in get_buffer/release_buffer.\
511 * This isn't used by libavcodec unless the default get/release_buffer() is used.\
517 * 1 -> keyframe, 0-> not\
518 * - encoding: Set by libavcodec.\
519 * - decoding: Set by libavcodec.\
524 * Picture type of the frame, see ?_TYPE below.\
525 * - encoding: Set by libavcodec. for coded_picture (and set by user for input).\
526 * - decoding: Set by libavcodec.\
531 * presentation timestamp in time_base units (time when frame should be shown to user)\
532 * If AV_NOPTS_VALUE then frame_rate = 1/time_base will be assumed.\
533 * - encoding: MUST be set by user.\
534 * - decoding: Set by libavcodec.\
539 * picture number in bitstream order\
540 * - encoding: set by\
541 * - decoding: Set by libavcodec.\
543 int coded_picture_number;\
545 * picture number in display order\
546 * - encoding: set by\
547 * - decoding: Set by libavcodec.\
549 int display_picture_number;\
552 * quality (between 1 (good) and FF_LAMBDA_MAX (bad)) \
553 * - encoding: Set by libavcodec. for coded_picture (and set by user for input).\
554 * - decoding: Set by libavcodec.\
559 * buffer age (1->was last buffer and dint change, 2->..., ...).\
560 * Set to INT_MAX if the buffer has not been used yet.\
561 * - encoding: unused\
562 * - decoding: MUST be set by get_buffer().\
567 * is this picture used as reference\
568 * - encoding: unused\
569 * - decoding: Set by libavcodec. (before get_buffer() call)).\
575 * - encoding: unused\
576 * - decoding: Set by libavcodec.\
578 int8_t *qscale_table;\
581 * - encoding: unused\
582 * - decoding: Set by libavcodec.\
587 * mbskip_table[mb]>=1 if MB didn't change\
588 * stride= mb_width = (width+15)>>4\
589 * - encoding: unused\
590 * - decoding: Set by libavcodec.\
592 uint8_t *mbskip_table;\
595 * motion vector table\
598 * int mv_sample_log2= 4 - motion_subsample_log2;\
599 * int mb_width= (width+15)>>4;\
600 * int mv_stride= (mb_width << mv_sample_log2) + 1;\
601 * motion_val[direction][x + y*mv_stride][0->mv_x, 1->mv_y];\
603 * - encoding: Set by user.\
604 * - decoding: Set by libavcodec.\
606 int16_t (*motion_val[2])[2];\
609 * macroblock type table\
610 * mb_type_base + mb_width + 2\
611 * - encoding: Set by user.\
612 * - decoding: Set by libavcodec.\
617 * log2 of the size of the block which a single vector in motion_val represents: \
618 * (4->16x16, 3->8x8, 2-> 4x4, 1-> 2x2)\
619 * - encoding: unused\
620 * - decoding: Set by libavcodec.\
622 uint8_t motion_subsample_log2;\
625 * for some private data of the user\
626 * - encoding: unused\
627 * - decoding: Set by user.\
633 * - encoding: Set by libavcodec. if flags&CODEC_FLAG_PSNR.\
634 * - decoding: unused\
639 * type of the buffer (to keep track of who has to deallocate data[*])\
640 * - encoding: Set by the one who allocates it.\
641 * - decoding: Set by the one who allocates it.\
642 * Note: User allocated (direct rendering) & internal buffers cannot coexist currently.\
647 * When decoding, this signals how much the picture must be delayed.\
648 * extra_delay = repeat_pict / (2*fps)\
649 * - encoding: unused\
650 * - decoding: Set by libavcodec.\
660 * The content of the picture is interlaced.\
661 * - encoding: Set by user.\
662 * - decoding: Set by libavcodec. (default 0)\
664 int interlaced_frame;\
667 * If the content is interlaced, is top field displayed first.\
668 * - encoding: Set by user.\
669 * - decoding: Set by libavcodec.\
671 int top_field_first;\
675 * - encoding: Set by user.\
676 * - decoding: Set by libavcodec.\
678 AVPanScan *pan_scan;\
681 * Tell user application that palette has changed from previous frame.\
682 * - encoding: ??? (no palette-enabled encoder yet)\
683 * - decoding: Set by libavcodec. (default 0).\
685 int palette_has_changed;\
688 * codec suggestion on buffer type if != 0\
689 * - encoding: unused\
690 * - decoding: Set by libavcodec. (before get_buffer() call)).\
696 * - encoding: unused\
697 * - decoding: Set by libavcodec.\
702 * motion referece frame index\
703 * - encoding: Set by user.\
704 * - decoding: Set by libavcodec.\
706 int8_t *ref_index[2];
708 #define FF_QSCALE_TYPE_MPEG1 0
709 #define FF_QSCALE_TYPE_MPEG2 1
710 #define FF_QSCALE_TYPE_H264 2
712 #define FF_BUFFER_TYPE_INTERNAL 1
713 #define FF_BUFFER_TYPE_USER 2 ///< direct rendering buffers (image is (de)allocated by user)
714 #define FF_BUFFER_TYPE_SHARED 4 ///< Buffer from somewhere else; don't deallocate image (data/base), all other tables are not shared.
715 #define FF_BUFFER_TYPE_COPY 8 ///< Just a (modified) copy of some other buffer, don't deallocate anything.
718 #define FF_I_TYPE 1 // Intra
719 #define FF_P_TYPE 2 // Predicted
720 #define FF_B_TYPE 3 // Bi-dir predicted
721 #define FF_S_TYPE 4 // S(GMC)-VOP MPEG4
725 #define FF_BUFFER_HINTS_VALID 0x01 // Buffer hints value is meaningful (if 0 ignore).
726 #define FF_BUFFER_HINTS_READABLE 0x02 // Codec will read from buffer.
727 #define FF_BUFFER_HINTS_PRESERVE 0x04 // User must not alter buffer content.
728 #define FF_BUFFER_HINTS_REUSABLE 0x08 // Codec will reuse the buffer (update).
733 typedef struct AVFrame {
737 #define DEFAULT_FRAME_RATE_BASE 1001000
740 * main external API structure
742 typedef struct AVCodecContext {
744 * information on struct for av_log
745 * - set by avcodec_alloc_context
749 * the average bitrate
750 * - encoding: Set by user; unused for constant quantizer encoding.
751 * - decoding: Set by libavcodec. 0 or some bitrate if this info is available in the stream.
756 * number of bits the bitstream is allowed to diverge from the reference.
757 * the reference can be CBR (for CBR pass1) or VBR (for pass2)
758 * - encoding: Set by user; unused for constant quantizer encoding.
761 int bit_rate_tolerance;
765 * - encoding: Set by user.
766 * - decoding: Set by user.
771 * Some codecs need additional format info. It is stored here.
772 * If any muxer uses this then ALL demuxers/parsers AND encoders for the
773 * specific codec MUST set it correctly otherwise stream copy breaks.
774 * In general use of this field by muxers is not recommanded.
775 * - encoding: Set by libavcodec.
776 * - decoding: Set by libavcodec. (FIXME: Is this OK?)
781 * Motion estimation algorithm used for video coding.
782 * 1 (zero), 2 (full), 3 (log), 4 (phods), 5 (epzs), 6 (x1), 7 (hex),
783 * 8 (umh), 9 (iter) [7, 8 are x264 specific, 9 is snow specific]
784 * - encoding: MUST be set by user.
790 * some codecs need / can use extradata like Huffman tables.
791 * mjpeg: Huffman tables
792 * rv10: additional flags
793 * mpeg4: global headers (they can be in the bitstream or here)
794 * The allocated memory should be FF_INPUT_BUFFER_PADDING_SIZE bytes larger
795 * than extradata_size to avoid prolems if it is read with the bitstream reader.
796 * The bytewise contents of extradata must not depend on the architecture or CPU endianness.
797 * - encoding: Set/allocated/freed by libavcodec.
798 * - decoding: Set/allocated/freed by user.
804 * This is the fundamental unit of time (in seconds) in terms
805 * of which frame timestamps are represented. For fixed-fps content,
806 * timebase should be 1/framerate and timestamp increments should be
808 * - encoding: MUST be set by user.
809 * - decoding: Set by libavcodec.
811 AVRational time_base;
815 * picture width / height.
816 * - encoding: MUST be set by user.
817 * - decoding: Set by libavcodec.
818 * Note: For compatibility it is possible to set this instead of
819 * coded_width/height before decoding.
823 #define FF_ASPECT_EXTENDED 15
826 * the number of pictures in a group of pictures, or 0 for intra_only
827 * - encoding: Set by user.
833 * Pixel format, see PIX_FMT_xxx.
834 * - encoding: Set by user.
835 * - decoding: Set by libavcodec.
837 enum PixelFormat pix_fmt;
840 * Frame rate emulation. If not zero, the lower layer (i.e. format handler)
841 * has to read frames at native frame rate.
842 * - encoding: Set by user.
848 * If non NULL, 'draw_horiz_band' is called by the libavcodec
849 * decoder to draw a horizontal band. It improves cache usage. Not
850 * all codecs can do that. You must check the codec capabilities
853 * - decoding: Set by user.
854 * @param height the height of the slice
855 * @param y the y position of the slice
856 * @param type 1->top field, 2->bottom field, 3->frame
857 * @param offset offset into the AVFrame.data from which the slice should be read
859 void (*draw_horiz_band)(struct AVCodecContext *s,
860 const AVFrame *src, int offset[4],
861 int y, int type, int height);
864 int sample_rate; ///< samples per second
868 * audio sample format
869 * - encoding: Set by user.
870 * - decoding: Set by libavcodec.
872 enum SampleFormat sample_fmt; ///< sample format, currently unused
874 /* The following data should not be initialized. */
876 * Samples per packet, initialized when calling 'init'.
879 int frame_number; ///< audio or video frame number
880 int real_pict_num; ///< Returns the real picture number of previous encoded frame.
883 * Number of frames the decoded output will be delayed relative to
885 * - encoding: Set by libavcodec.
890 /* - encoding parameters */
891 float qcompress; ///< amount of qscale change between easy & hard scenes (0.0-1.0)
892 float qblur; ///< amount of qscale smoothing over time (0.0-1.0)
896 * - encoding: Set by user.
903 * - encoding: Set by user.
909 * maximum quantizer difference between frames
910 * - encoding: Set by user.
916 * maximum number of B-frames between non-B-frames
917 * Note: The output will be delayed by max_b_frames+1 relative to the input.
918 * - encoding: Set by user.
924 * qscale factor between IP and B-frames
925 * - encoding: Set by user.
928 float b_quant_factor;
930 /** obsolete FIXME remove */
932 #define FF_RC_STRATEGY_XVID 1
934 int b_frame_strategy;
939 * - decoding: Set by user. 1-> Skip B-frames, 2-> Skip IDCT/dequant too, 5-> Skip everything except header
940 * @deprecated Deprecated in favor of skip_idct and skip_frame.
944 struct AVCodec *codec;
948 #if LIBAVCODEC_VERSION_INT < ((52<<16)+(0<<8)+0)
949 /* unused, FIXME remove*/
953 int rtp_payload_size; /* The size of the RTP payload: the coder will */
954 /* do its best to deliver a chunk with size */
955 /* below rtp_payload_size, the chunk will start */
956 /* with a start code on some codecs like H.263. */
957 /* This doesn't take account of any particular */
958 /* headers inside the transmitted RTP payload. */
961 /* The RTP callback: This function is called */
962 /* every time the encoder has a packet to send. */
963 /* It depends on the encoder if the data starts */
964 /* with a Start Code (it should). H.263 does. */
965 /* mb_nb contains the number of macroblocks */
966 /* encoded in the RTP payload. */
967 void (*rtp_callback)(struct AVCodecContext *avctx, void *data, int size, int mb_nb);
969 /* statistics, used for 2-pass encoding */
980 * number of bits used for the previously encoded frame
981 * - encoding: Set by libavcodec.
987 * Private data of the user, can be used to carry app specific stuff.
988 * - encoding: Set by user.
989 * - decoding: Set by user.
994 enum CodecType codec_type; /* see CODEC_TYPE_xxx */
995 enum CodecID codec_id; /* see CODEC_ID_xxx */
998 * fourcc (LSB first, so "ABCD" -> ('D'<<24) + ('C'<<16) + ('B'<<8) + 'A').
999 * This is used to work around some encoder bugs.
1000 * A demuxer should set this to what is stored in the field used to identify the codec.
1001 * If there are multiple such fields in a container then the demuxer should choose the one
1002 * which maximizes the information about the used codec.
1003 * If the codec tag field in a container is larger then 32 bits then the demuxer should
1004 * remap the longer ID to 32 bits with a table or other structure. Alternatively a new
1005 * extra_codec_tag + size could be added but for this a clear advantage must be demonstrated
1007 * - encoding: Set by user, if not then the default based on codec_id will be used.
1008 * - decoding: Set by user, will be converted to uppercase by libavcodec during init.
1010 unsigned int codec_tag;
1013 * Work around bugs in encoders which sometimes cannot be detected automatically.
1014 * - encoding: Set by user
1015 * - decoding: Set by user
1017 int workaround_bugs;
1018 #define FF_BUG_AUTODETECT 1 ///< autodetection
1019 #define FF_BUG_OLD_MSMPEG4 2
1020 #define FF_BUG_XVID_ILACE 4
1021 #define FF_BUG_UMP4 8
1022 #define FF_BUG_NO_PADDING 16
1023 #define FF_BUG_AMV 32
1024 #define FF_BUG_AC_VLC 0 ///< Will be removed, libavcodec can now handle these non-compliant files by default.
1025 #define FF_BUG_QPEL_CHROMA 64
1026 #define FF_BUG_STD_QPEL 128
1027 #define FF_BUG_QPEL_CHROMA2 256
1028 #define FF_BUG_DIRECT_BLOCKSIZE 512
1029 #define FF_BUG_EDGE 1024
1030 #define FF_BUG_HPEL_CHROMA 2048
1031 #define FF_BUG_DC_CLIP 4096
1032 #define FF_BUG_MS 8192 ///< Work around various bugs in Microsoft's broken decoders.
1033 //#define FF_BUG_FAKE_SCALABILITY 16 //Autodetection should work 100%.
1036 * luma single coefficient elimination threshold
1037 * - encoding: Set by user.
1038 * - decoding: unused
1040 int luma_elim_threshold;
1043 * chroma single coeff elimination threshold
1044 * - encoding: Set by user.
1045 * - decoding: unused
1047 int chroma_elim_threshold;
1050 * strictly follow the standard (MPEG4, ...).
1051 * - encoding: Set by user.
1052 * - decoding: unused
1054 int strict_std_compliance;
1055 #define FF_COMPLIANCE_VERY_STRICT 2 ///< Strictly conform to a older more strict version of the spec or reference software.
1056 #define FF_COMPLIANCE_STRICT 1 ///< Strictly conform to all the things in the spec no matter what consequences.
1057 #define FF_COMPLIANCE_NORMAL 0
1058 #define FF_COMPLIANCE_INOFFICIAL -1 ///< Allow inofficial extensions.
1059 #define FF_COMPLIANCE_EXPERIMENTAL -2 ///< Allow nonstandardized experimental things.
1062 * qscale offset between IP and B-frames
1063 * If > 0 then the last P-frame quantizer will be used (q= lastp_q*factor+offset).
1064 * If < 0 then normal ratecontrol will be done (q= -normal_q*factor+offset).
1065 * - encoding: Set by user.
1066 * - decoding: unused
1068 float b_quant_offset;
1071 * Error resilience; higher values will detect more errors but may
1072 * misdetect some more or less valid parts as errors.
1073 * - encoding: unused
1074 * - decoding: Set by user.
1076 int error_resilience;
1077 #define FF_ER_CAREFUL 1
1078 #define FF_ER_COMPLIANT 2
1079 #define FF_ER_AGGRESSIVE 3
1080 #define FF_ER_VERY_AGGRESSIVE 4
1083 * Called at the beginning of each frame to get a buffer for it.
1084 * If pic.reference is set then the frame will be read later by libavcodec.
1085 * avcodec_align_dimensions() should be used to find the required width and
1086 * height, as they normally need to be rounded up to the next multiple of 16.
1087 * - encoding: unused
1088 * - decoding: Set by libavcodec., user can override.
1090 int (*get_buffer)(struct AVCodecContext *c, AVFrame *pic);
1093 * Called to release buffers which where allocated with get_buffer.
1094 * A released buffer can be reused in get_buffer().
1095 * pic.data[*] must be set to NULL.
1096 * - encoding: unused
1097 * - decoding: Set by libavcodec., user can override.
1099 void (*release_buffer)(struct AVCodecContext *c, AVFrame *pic);
1102 * If 1 the stream has a 1 frame delay during decoding.
1103 * - encoding: Set by libavcodec.
1104 * - decoding: Set by libavcodec.
1109 * number of bytes per packet if constant and known or 0
1110 * Used by some WAV based audio codecs.
1114 int parse_only; /* - decoding only: If true, only parsing is done
1115 (function avcodec_parse_frame()). The frame
1116 data is returned. Only MPEG codecs support this now. */
1119 * 0-> h263 quant 1-> mpeg quant
1120 * - encoding: Set by user.
1121 * - decoding: unused
1126 * pass1 encoding statistics output buffer
1127 * - encoding: Set by libavcodec.
1128 * - decoding: unused
1133 * pass2 encoding statistics input buffer
1134 * Concatenated stuff from stats_out of pass1 should be placed here.
1135 * - encoding: Allocated/set/freed by user.
1136 * - decoding: unused
1141 * ratecontrol qmin qmax limiting method
1142 * 0-> clipping, 1-> use a nice continous function to limit qscale wthin qmin/qmax.
1143 * - encoding: Set by user.
1144 * - decoding: unused
1152 * ratecontrol override, see RcOverride
1153 * - encoding: Allocated/set/freed by user.
1154 * - decoding: unused
1156 RcOverride *rc_override;
1157 int rc_override_count;
1160 * rate control equation
1161 * - encoding: Set by user
1162 * - decoding: unused
1168 * - encoding: Set by user.
1169 * - decoding: unused
1175 * - encoding: Set by user.
1176 * - decoding: unused
1181 * decoder bitstream buffer size
1182 * - encoding: Set by user.
1183 * - decoding: unused
1186 float rc_buffer_aggressivity;
1189 * qscale factor between P and I-frames
1190 * If > 0 then the last p frame quantizer will be used (q= lastp_q*factor+offset).
1191 * If < 0 then normal ratecontrol will be done (q= -normal_q*factor+offset).
1192 * - encoding: Set by user.
1193 * - decoding: unused
1195 float i_quant_factor;
1198 * qscale offset between P and I-frames
1199 * - encoding: Set by user.
1200 * - decoding: unused
1202 float i_quant_offset;
1205 * initial complexity for pass1 ratecontrol
1206 * - encoding: Set by user.
1207 * - decoding: unused
1209 float rc_initial_cplx;
1212 * DCT algorithm, see FF_DCT_* below
1213 * - encoding: Set by user.
1214 * - decoding: unused
1217 #define FF_DCT_AUTO 0
1218 #define FF_DCT_FASTINT 1
1219 #define FF_DCT_INT 2
1220 #define FF_DCT_MMX 3
1221 #define FF_DCT_MLIB 4
1222 #define FF_DCT_ALTIVEC 5
1223 #define FF_DCT_FAAN 6
1226 * luminance masking (0-> disabled)
1227 * - encoding: Set by user.
1228 * - decoding: unused
1233 * temporary complexity masking (0-> disabled)
1234 * - encoding: Set by user.
1235 * - decoding: unused
1237 float temporal_cplx_masking;
1240 * spatial complexity masking (0-> disabled)
1241 * - encoding: Set by user.
1242 * - decoding: unused
1244 float spatial_cplx_masking;
1247 * p block masking (0-> disabled)
1248 * - encoding: Set by user.
1249 * - decoding: unused
1254 * darkness masking (0-> disabled)
1255 * - encoding: Set by user.
1256 * - decoding: unused
1261 /* for binary compatibility */
1265 * IDCT algorithm, see FF_IDCT_* below.
1266 * - encoding: Set by user.
1267 * - decoding: Set by user.
1270 #define FF_IDCT_AUTO 0
1271 #define FF_IDCT_INT 1
1272 #define FF_IDCT_SIMPLE 2
1273 #define FF_IDCT_SIMPLEMMX 3
1274 #define FF_IDCT_LIBMPEG2MMX 4
1275 #define FF_IDCT_PS2 5
1276 #define FF_IDCT_MLIB 6
1277 #define FF_IDCT_ARM 7
1278 #define FF_IDCT_ALTIVEC 8
1279 #define FF_IDCT_SH4 9
1280 #define FF_IDCT_SIMPLEARM 10
1281 #define FF_IDCT_H264 11
1282 #define FF_IDCT_VP3 12
1283 #define FF_IDCT_IPP 13
1284 #define FF_IDCT_XVIDMMX 14
1285 #define FF_IDCT_CAVS 15
1286 #define FF_IDCT_SIMPLEARMV5TE 16
1287 #define FF_IDCT_SIMPLEARMV6 17
1288 #define FF_IDCT_SIMPLEVIS 18
1292 * - encoding: Set by libavcodec.
1293 * - decoding: Set by user (or 0).
1297 * slice offsets in the frame in bytes
1298 * - encoding: Set/allocated by libavcodec.
1299 * - decoding: Set/allocated by user (or NULL).
1304 * error concealment flags
1305 * - encoding: unused
1306 * - decoding: Set by user.
1308 int error_concealment;
1309 #define FF_EC_GUESS_MVS 1
1310 #define FF_EC_DEBLOCK 2
1313 * dsp_mask could be add used to disable unwanted CPU features
1314 * CPU features (i.e. MMX, SSE. ...)
1316 * With the FORCE flag you may instead enable given CPU features.
1317 * (Dangerous: Usable in case of misdetection, improper usage however will
1318 * result into program crash.)
1321 #define FF_MM_FORCE 0x80000000 /* Force usage of selected flags (OR) */
1322 /* lower 16 bits - CPU features */
1323 #define FF_MM_MMX 0x0001 /* standard MMX */
1324 #define FF_MM_3DNOW 0x0004 /* AMD 3DNOW */
1325 #define FF_MM_MMXEXT 0x0002 /* SSE integer functions or AMD MMX ext */
1326 #define FF_MM_SSE 0x0008 /* SSE functions */
1327 #define FF_MM_SSE2 0x0010 /* PIV SSE2 functions */
1328 #define FF_MM_3DNOWEXT 0x0020 /* AMD 3DNowExt */
1329 #define FF_MM_SSE3 0x0040 /* Prescott SSE3 functions */
1330 #define FF_MM_SSSE3 0x0080 /* Conroe SSSE3 functions */
1331 #define FF_MM_IWMMXT 0x0100 /* XScale IWMMXT */
1334 * bits per sample/pixel from the demuxer (needed for huffyuv).
1335 * - encoding: Set by libavcodec.
1336 * - decoding: Set by user.
1338 int bits_per_sample;
1341 * prediction method (needed for huffyuv)
1342 * - encoding: Set by user.
1343 * - decoding: unused
1345 int prediction_method;
1346 #define FF_PRED_LEFT 0
1347 #define FF_PRED_PLANE 1
1348 #define FF_PRED_MEDIAN 2
1351 * sample aspect ratio (0 if unknown)
1352 * Numerator and denominator must be relatively prime and smaller than 256 for some video standards.
1353 * - encoding: Set by user.
1354 * - decoding: Set by libavcodec.
1356 AVRational sample_aspect_ratio;
1359 * the picture in the bitstream
1360 * - encoding: Set by libavcodec.
1361 * - decoding: Set by libavcodec.
1363 AVFrame *coded_frame;
1367 * - encoding: Set by user.
1368 * - decoding: Set by user.
1371 #define FF_DEBUG_PICT_INFO 1
1372 #define FF_DEBUG_RC 2
1373 #define FF_DEBUG_BITSTREAM 4
1374 #define FF_DEBUG_MB_TYPE 8
1375 #define FF_DEBUG_QP 16
1376 #define FF_DEBUG_MV 32
1377 #define FF_DEBUG_DCT_COEFF 0x00000040
1378 #define FF_DEBUG_SKIP 0x00000080
1379 #define FF_DEBUG_STARTCODE 0x00000100
1380 #define FF_DEBUG_PTS 0x00000200
1381 #define FF_DEBUG_ER 0x00000400
1382 #define FF_DEBUG_MMCO 0x00000800
1383 #define FF_DEBUG_BUGS 0x00001000
1384 #define FF_DEBUG_VIS_QP 0x00002000
1385 #define FF_DEBUG_VIS_MB_TYPE 0x00004000
1389 * - encoding: Set by user.
1390 * - decoding: Set by user.
1393 #define FF_DEBUG_VIS_MV_P_FOR 0x00000001 //visualize forward predicted MVs of P frames
1394 #define FF_DEBUG_VIS_MV_B_FOR 0x00000002 //visualize forward predicted MVs of B frames
1395 #define FF_DEBUG_VIS_MV_B_BACK 0x00000004 //visualize backward predicted MVs of B frames
1399 * - encoding: Set by libavcodec if flags&CODEC_FLAG_PSNR.
1400 * - decoding: unused
1405 * minimum MB quantizer
1406 * - encoding: unused
1407 * - decoding: unused
1412 * maximum MB quantizer
1413 * - encoding: unused
1414 * - decoding: unused
1419 * motion estimation comparison function
1420 * - encoding: Set by user.
1421 * - decoding: unused
1425 * subpixel motion estimation comparison function
1426 * - encoding: Set by user.
1427 * - decoding: unused
1431 * macroblock comparison function (not supported yet)
1432 * - encoding: Set by user.
1433 * - decoding: unused
1437 * interlaced DCT comparison function
1438 * - encoding: Set by user.
1439 * - decoding: unused
1442 #define FF_CMP_SAD 0
1443 #define FF_CMP_SSE 1
1444 #define FF_CMP_SATD 2
1445 #define FF_CMP_DCT 3
1446 #define FF_CMP_PSNR 4
1447 #define FF_CMP_BIT 5
1449 #define FF_CMP_ZERO 7
1450 #define FF_CMP_VSAD 8
1451 #define FF_CMP_VSSE 9
1452 #define FF_CMP_NSSE 10
1453 #define FF_CMP_W53 11
1454 #define FF_CMP_W97 12
1455 #define FF_CMP_DCTMAX 13
1456 #define FF_CMP_DCT264 14
1457 #define FF_CMP_CHROMA 256
1460 * ME diamond size & shape
1461 * - encoding: Set by user.
1462 * - decoding: unused
1467 * amount of previous MV predictors (2a+1 x 2a+1 square)
1468 * - encoding: Set by user.
1469 * - decoding: unused
1471 int last_predictor_count;
1474 * prepass for motion estimation
1475 * - encoding: Set by user.
1476 * - decoding: unused
1481 * motion estimation prepass comparison function
1482 * - encoding: Set by user.
1483 * - decoding: unused
1488 * ME prepass diamond size & shape
1489 * - encoding: Set by user.
1490 * - decoding: unused
1496 * - encoding: Set by user.
1497 * - decoding: unused
1499 int me_subpel_quality;
1502 * callback to negotiate the pixelFormat
1503 * @param fmt is the list of formats which are supported by the codec,
1504 * it is terminated by -1 as 0 is a valid format, the formats are ordered by quality.
1505 * The first is always the native one.
1506 * @return the chosen format
1507 * - encoding: unused
1508 * - decoding: Set by user, if not set the native format will be chosen.
1510 enum PixelFormat (*get_format)(struct AVCodecContext *s, const enum PixelFormat * fmt);
1513 * DTG active format information (additional aspect ratio
1514 * information only used in DVB MPEG-2 transport streams)
1517 * - encoding: unused
1518 * - decoding: Set by decoder.
1520 int dtg_active_format;
1521 #define FF_DTG_AFD_SAME 8
1522 #define FF_DTG_AFD_4_3 9
1523 #define FF_DTG_AFD_16_9 10
1524 #define FF_DTG_AFD_14_9 11
1525 #define FF_DTG_AFD_4_3_SP_14_9 13
1526 #define FF_DTG_AFD_16_9_SP_14_9 14
1527 #define FF_DTG_AFD_SP_4_3 15
1530 * maximum motion estimation search range in subpel units
1531 * If 0 then no limit.
1533 * - encoding: Set by user.
1534 * - decoding: unused
1539 * intra quantizer bias
1540 * - encoding: Set by user.
1541 * - decoding: unused
1543 int intra_quant_bias;
1544 #define FF_DEFAULT_QUANT_BIAS 999999
1547 * inter quantizer bias
1548 * - encoding: Set by user.
1549 * - decoding: unused
1551 int inter_quant_bias;
1555 * - encoding: unused
1556 * - decoding: Which clrtable should be used for 8bit RGB images.
1557 * Tables have to be stored somewhere. FIXME
1562 * internal_buffer count
1563 * Don't touch, used by libavcodec default_get_buffer().
1565 int internal_buffer_count;
1569 * Don't touch, used by libavcodec default_get_buffer().
1571 void *internal_buffer;
1573 #define FF_LAMBDA_SHIFT 7
1574 #define FF_LAMBDA_SCALE (1<<FF_LAMBDA_SHIFT)
1575 #define FF_QP2LAMBDA 118 ///< factor to convert from H.263 QP to lambda
1576 #define FF_LAMBDA_MAX (256*128-1)
1578 #define FF_QUALITY_SCALE FF_LAMBDA_SCALE //FIXME maybe remove
1580 * Global quality for codecs which cannot change it per frame.
1581 * This should be proportional to MPEG-1/2/4 qscale.
1582 * - encoding: Set by user.
1583 * - decoding: unused
1587 #define FF_CODER_TYPE_VLC 0
1588 #define FF_CODER_TYPE_AC 1
1589 #define FF_CODER_TYPE_RAW 2
1590 #define FF_CODER_TYPE_RLE 3
1591 #define FF_CODER_TYPE_DEFLATE 4
1594 * - encoding: Set by user.
1595 * - decoding: unused
1601 * - encoding: Set by user.
1602 * - decoding: unused
1608 * - encoding: unused
1609 * - decoding: Set by user.
1611 uint8_t * (*realloc)(struct AVCodecContext *s, uint8_t *buf, int buf_size);
1616 * - encoding: unused
1617 * - decoding: Set by user.
1620 #define SLICE_FLAG_CODED_ORDER 0x0001 ///< draw_horiz_band() is called in coded order instead of display
1621 #define SLICE_FLAG_ALLOW_FIELD 0x0002 ///< allow draw_horiz_band() with field slices (MPEG2 field pics)
1622 #define SLICE_FLAG_ALLOW_PLANE 0x0004 ///< allow draw_horiz_band() with 1 component at a time (SVQ1)
1625 * XVideo Motion Acceleration
1626 * - encoding: forbidden
1627 * - decoding: set by decoder
1629 int xvmc_acceleration;
1632 * macroblock decision mode
1633 * - encoding: Set by user.
1634 * - decoding: unused
1637 #define FF_MB_DECISION_SIMPLE 0 ///< uses mb_cmp
1638 #define FF_MB_DECISION_BITS 1 ///< chooses the one which needs the fewest bits
1639 #define FF_MB_DECISION_RD 2 ///< rate distoration
1642 * custom intra quantization matrix
1643 * - encoding: Set by user, can be NULL.
1644 * - decoding: Set by libavcodec.
1646 uint16_t *intra_matrix;
1649 * custom inter quantization matrix
1650 * - encoding: Set by user, can be NULL.
1651 * - decoding: Set by libavcodec.
1653 uint16_t *inter_matrix;
1656 * fourcc from the AVI stream header (LSB first, so "ABCD" -> ('D'<<24) + ('C'<<16) + ('B'<<8) + 'A').
1657 * This is used to work around some encoder bugs.
1658 * - encoding: unused
1659 * - decoding: Set by user, will be converted to uppercase by libavcodec during init.
1661 unsigned int stream_codec_tag;
1664 * scene change detection threshold
1665 * 0 is default, larger means fewer detected scene changes.
1666 * - encoding: Set by user.
1667 * - decoding: unused
1669 int scenechange_threshold;
1672 * minimum Lagrange multipler
1673 * - encoding: Set by user.
1674 * - decoding: unused
1679 * maximum Lagrange multipler
1680 * - encoding: Set by user.
1681 * - decoding: unused
1686 * palette control structure
1687 * - encoding: ??? (no palette-enabled encoder yet)
1688 * - decoding: Set by user.
1690 struct AVPaletteControl *palctrl;
1693 * noise reduction strength
1694 * - encoding: Set by user.
1695 * - decoding: unused
1697 int noise_reduction;
1700 * Called at the beginning of a frame to get cr buffer for it.
1701 * Buffer type (size, hints) must be the same. libavcodec won't check it.
1702 * libavcodec will pass previous buffer in pic, function should return
1703 * same buffer or new buffer with old frame "painted" into it.
1704 * If pic.data[0] == NULL must behave like get_buffer().
1705 * - encoding: unused
1706 * - decoding: Set by libavcodec., user can override
1708 int (*reget_buffer)(struct AVCodecContext *c, AVFrame *pic);
1711 * Number of bits which should be loaded into the rc buffer before decoding starts.
1712 * - encoding: Set by user.
1713 * - decoding: unused
1715 int rc_initial_buffer_occupancy;
1719 * - encoding: Set by user.
1720 * - decoding: unused
1722 int inter_threshold;
1726 * - encoding: Set by user.
1727 * - decoding: Set by user.
1732 * Simulates errors in the bitstream to test error concealment.
1733 * - encoding: Set by user.
1734 * - decoding: unused
1739 * MP3 antialias algorithm, see FF_AA_* below.
1740 * - encoding: unused
1741 * - decoding: Set by user.
1744 #define FF_AA_AUTO 0
1745 #define FF_AA_FASTINT 1 //not implemented yet
1747 #define FF_AA_FLOAT 3
1749 * quantizer noise shaping
1750 * - encoding: Set by user.
1751 * - decoding: unused
1753 int quantizer_noise_shaping;
1757 * is used to decide how many independent tasks should be passed to execute()
1758 * - encoding: Set by user.
1759 * - decoding: Set by user.
1764 * The codec may call this to execute several independent things.
1765 * It will return only after finishing all tasks.
1766 * The user may replace this with some multithreaded implementation,
1767 * the default implementation will execute the parts serially.
1768 * @param count the number of things to execute
1769 * - encoding: Set by libavcodec, user can override.
1770 * - decoding: Set by libavcodec, user can override.
1772 int (*execute)(struct AVCodecContext *c, int (*func)(struct AVCodecContext *c2, void *arg), void **arg2, int *ret, int count);
1776 * Can be used by execute() to store some per AVCodecContext stuff.
1777 * - encoding: set by execute()
1778 * - decoding: set by execute()
1780 void *thread_opaque;
1783 * Motion estimation threshold below which no motion estimation is
1784 * performed, but instead the user specified motion vectors are used.
1786 * - encoding: Set by user.
1787 * - decoding: unused
1792 * Macroblock threshold below which the user specified macroblock types will be used.
1793 * - encoding: Set by user.
1794 * - decoding: unused
1799 * precision of the intra DC coefficient - 8
1800 * - encoding: Set by user.
1801 * - decoding: unused
1803 int intra_dc_precision;
1806 * noise vs. sse weight for the nsse comparsion function
1807 * - encoding: Set by user.
1808 * - decoding: unused
1813 * Number of macroblock rows at the top which are skipped.
1814 * - encoding: unused
1815 * - decoding: Set by user.
1820 * Number of macroblock rows at the bottom which are skipped.
1821 * - encoding: unused
1822 * - decoding: Set by user.
1828 * - encoding: Set by user.
1829 * - decoding: Set by libavcodec.
1832 #define FF_PROFILE_UNKNOWN -99
1833 #define FF_PROFILE_AAC_MAIN 0
1834 #define FF_PROFILE_AAC_LOW 1
1835 #define FF_PROFILE_AAC_SSR 2
1836 #define FF_PROFILE_AAC_LTP 3
1840 * - encoding: Set by user.
1841 * - decoding: Set by libavcodec.
1844 #define FF_LEVEL_UNKNOWN -99
1847 * low resolution decoding, 1-> 1/2 size, 2->1/4 size
1848 * - encoding: unused
1849 * - decoding: Set by user.
1854 * Bitstream width / height, may be different from width/height if lowres
1855 * or other things are used.
1856 * - encoding: unused
1857 * - decoding: Set by user before init if known. Codec should override / dynamically change if needed.
1859 int coded_width, coded_height;
1862 * frame skip threshold
1863 * - encoding: Set by user.
1864 * - decoding: unused
1866 int frame_skip_threshold;
1870 * - encoding: Set by user.
1871 * - decoding: unused
1873 int frame_skip_factor;
1876 * frame skip exponent
1877 * - encoding: Set by user.
1878 * - decoding: unused
1883 * frame skip comparison function
1884 * - encoding: Set by user.
1885 * - decoding: unused
1890 * Border processing masking, raises the quantizer for mbs on the borders
1892 * - encoding: Set by user.
1893 * - decoding: unused
1895 float border_masking;
1898 * minimum MB lagrange multipler
1899 * - encoding: Set by user.
1900 * - decoding: unused
1905 * maximum MB lagrange multipler
1906 * - encoding: Set by user.
1907 * - decoding: unused
1913 * - encoding: Set by user.
1914 * - decoding: unused
1916 int me_penalty_compensation;
1920 * - encoding: unused
1921 * - decoding: Set by user.
1923 enum AVDiscard skip_loop_filter;
1927 * - encoding: unused
1928 * - decoding: Set by user.
1930 enum AVDiscard skip_idct;
1934 * - encoding: unused
1935 * - decoding: Set by user.
1937 enum AVDiscard skip_frame;
1941 * - encoding: Set by user.
1942 * - decoding: unused
1948 * - encoding: Set by user.
1949 * - decoding: unused
1954 * constant rate factor - quality-based VBR - values ~correspond to qps
1955 * - encoding: Set by user.
1956 * - decoding: unused
1961 * constant quantization parameter rate control method
1962 * - encoding: Set by user.
1963 * - decoding: unused
1969 * - encoding: Set by user.
1970 * - decoding: unused
1975 * number of reference frames
1976 * - encoding: Set by user.
1977 * - decoding: unused
1982 * chroma qp offset from luma
1983 * - encoding: Set by user.
1984 * - decoding: unused
1989 * Influences how often B-frames are used.
1990 * - encoding: Set by user.
1991 * - decoding: unused
1996 * trellis RD quantization
1997 * - encoding: Set by user.
1998 * - decoding: unused
2003 * Reduce fluctuations in qp (before curve compression).
2004 * - encoding: Set by user.
2005 * - decoding: unused
2007 float complexityblur;
2010 * in-loop deblocking filter alphac0 parameter
2011 * alpha is in the range -6...6
2012 * - encoding: Set by user.
2013 * - decoding: unused
2018 * in-loop deblocking filter beta parameter
2019 * beta is in the range -6...6
2020 * - encoding: Set by user.
2021 * - decoding: unused
2026 * macroblock subpartition sizes to consider - p8x8, p4x4, b8x8, i8x8, i4x4
2027 * - encoding: Set by user.
2028 * - decoding: unused
2031 #define X264_PART_I4X4 0x001 /* Analyse i4x4 */
2032 #define X264_PART_I8X8 0x002 /* Analyse i8x8 (requires 8x8 transform) */
2033 #define X264_PART_P8X8 0x010 /* Analyse p16x8, p8x16 and p8x8 */
2034 #define X264_PART_P4X4 0x020 /* Analyse p8x4, p4x8, p4x4 */
2035 #define X264_PART_B8X8 0x100 /* Analyse b16x8, b8x16 and b8x8 */
2038 * direct MV prediction mode - 0 (none), 1 (spatial), 2 (temporal)
2039 * - encoding: Set by user.
2040 * - decoding: unused
2045 * Audio cutoff bandwidth (0 means "automatic"), currently used only by FAAC.
2046 * - encoding: Set by user.
2047 * - decoding: unused
2052 * Multiplied by qscale for each frame and added to scene_change_score.
2053 * - encoding: Set by user.
2054 * - decoding: unused
2056 int scenechange_factor;
2060 * Note: Value depends upon the compare function used for fullpel ME.
2061 * - encoding: Set by user.
2062 * - decoding: unused
2067 * Adjusts sensitivity of b_frame_strategy 1.
2068 * - encoding: Set by user.
2069 * - decoding: unused
2074 * - encoding: Set by user.
2075 * - decoding: unused
2077 int compression_level;
2078 #define FF_COMPRESSION_DEFAULT -1
2081 * Sets whether to use LPC mode - used by FLAC encoder.
2082 * - encoding: Set by user.
2083 * - decoding: unused
2088 * LPC coefficient precision - used by FLAC encoder
2089 * - encoding: Set by user.
2090 * - decoding: unused
2092 int lpc_coeff_precision;
2095 * - encoding: Set by user.
2096 * - decoding: unused
2098 int min_prediction_order;
2101 * - encoding: Set by user.
2102 * - decoding: unused
2104 int max_prediction_order;
2107 * search method for selecting prediction order
2108 * - encoding: Set by user.
2109 * - decoding: unused
2111 int prediction_order_method;
2114 * - encoding: Set by user.
2115 * - decoding: unused
2117 int min_partition_order;
2120 * - encoding: Set by user.
2121 * - decoding: unused
2123 int max_partition_order;
2126 * GOP timecode frame start number, in non drop frame format
2127 * - encoding: Set by user.
2128 * - decoding: unused
2130 int64_t timecode_frame_start;
2133 * Decoder should decode to this many channels if it can (0 for default)
2134 * - encoding: unused
2135 * - decoding: Set by user.
2137 int request_channels;
2143 typedef struct AVCodec {
2145 * Name of the codec implementation.
2146 * The name is globally unique among encoders and among decoders (but an
2147 * encoder and a decoder can share the same name).
2148 * This is the primary way to find a codec from the user perspective.
2151 enum CodecType type;
2154 int (*init)(AVCodecContext *);
2155 int (*encode)(AVCodecContext *, uint8_t *buf, int buf_size, void *data);
2156 int (*close)(AVCodecContext *);
2157 int (*decode)(AVCodecContext *, void *outdata, int *outdata_size,
2158 uint8_t *buf, int buf_size);
2160 struct AVCodec *next;
2161 void (*flush)(AVCodecContext *);
2162 const AVRational *supported_framerates; ///array of supported framerates, or NULL if any, array is terminated by {0,0}
2163 const enum PixelFormat *pix_fmts; ///array of supported pixel formats, or NULL if unknown, array is terminanted by -1
2167 * four components are given, that's all.
2168 * the last component is alpha
2170 typedef struct AVPicture {
2172 int linesize[4]; ///< number of bytes per line
2177 * This structure defines a method for communicating palette changes
2178 * between and demuxer and a decoder.
2180 * @deprecated Use AVPacket to send palette changes instead.
2181 * This is totally broken.
2183 #define AVPALETTE_SIZE 1024
2184 #define AVPALETTE_COUNT 256
2185 typedef struct AVPaletteControl {
2187 /* Demuxer sets this to 1 to indicate the palette has changed;
2188 * decoder resets to 0. */
2189 int palette_changed;
2191 /* 4-byte ARGB palette entries, stored in native byte order; note that
2192 * the individual palette components should be on a 8-bit scale; if
2193 * the palette data comes from an IBM VGA native format, the component
2194 * data is probably 6 bits in size and needs to be scaled. */
2195 unsigned int palette[AVPALETTE_COUNT];
2197 } AVPaletteControl attribute_deprecated;
2199 typedef struct AVSubtitleRect {
2206 uint32_t *rgba_palette;
2210 typedef struct AVSubtitle {
2211 uint16_t format; /* 0 = graphics */
2212 uint32_t start_display_time; /* relative to packet pts, in ms */
2213 uint32_t end_display_time; /* relative to packet pts, in ms */
2215 AVSubtitleRect *rects;
2221 struct ReSampleContext;
2222 struct AVResampleContext;
2224 typedef struct ReSampleContext ReSampleContext;
2226 ReSampleContext *audio_resample_init(int output_channels, int input_channels,
2227 int output_rate, int input_rate);
2228 int audio_resample(ReSampleContext *s, short *output, short *input, int nb_samples);
2229 void audio_resample_close(ReSampleContext *s);
2231 struct AVResampleContext *av_resample_init(int out_rate, int in_rate, int filter_length, int log2_phase_count, int linear, double cutoff);
2232 int av_resample(struct AVResampleContext *c, short *dst, short *src, int *consumed, int src_size, int dst_size, int update_ctx);
2233 void av_resample_compensate(struct AVResampleContext *c, int sample_delta, int compensation_distance);
2234 void av_resample_close(struct AVResampleContext *c);
2236 #if LIBAVCODEC_VERSION_INT < ((52<<16)+(0<<8)+0)
2237 /* YUV420 format is assumed ! */
2240 * @deprecated Use the software scaler (swscale) instead.
2242 typedef struct ImgReSampleContext ImgReSampleContext attribute_deprecated;
2245 * @deprecated Use the software scaler (swscale) instead.
2247 attribute_deprecated ImgReSampleContext *img_resample_init(int output_width, int output_height,
2248 int input_width, int input_height);
2251 * @deprecated Use the software scaler (swscale) instead.
2253 attribute_deprecated ImgReSampleContext *img_resample_full_init(int owidth, int oheight,
2254 int iwidth, int iheight,
2255 int topBand, int bottomBand,
2256 int leftBand, int rightBand,
2257 int padtop, int padbottom,
2258 int padleft, int padright);
2261 * @deprecated Use the software scaler (swscale) instead.
2263 attribute_deprecated void img_resample(struct ImgReSampleContext *s,
2264 AVPicture *output, const AVPicture *input);
2267 * @deprecated Use the software scaler (swscale) instead.
2269 attribute_deprecated void img_resample_close(struct ImgReSampleContext *s);
2274 * Allocate memory for a picture. Call avpicture_free to free it.
2276 * @param picture the picture to be filled in
2277 * @param pix_fmt the format of the picture
2278 * @param width the width of the picture
2279 * @param height the height of the picture
2280 * @return zero if successful, a negative value if not
2282 int avpicture_alloc(AVPicture *picture, int pix_fmt, int width, int height);
2285 * Free a picture previously allocated by avpicture_alloc().
2287 * @param picture the AVPicture to be freed
2289 void avpicture_free(AVPicture *picture);
2292 * Fill in the AVPicture fields.
2293 * The fields of the given AVPicture are filled in by using the 'ptr' address
2294 * which points to the image data buffer. Depending on the specified picture
2295 * format, one or multiple image data pointers and line sizes will be set.
2296 * If a planar format is specified, several pointers will be set pointing to
2297 * the different picture planes and the line sizes of the different planes
2298 * will be stored in the lines_sizes array.
2300 * @param picture AVPicture whose fields are to be filled in
2301 * @param ptr Buffer which will contain or contains the actual image data
2302 * @param pix_fmt The format in which the picture data is stored.
2303 * @param width the width of the image in pixels
2304 * @param height the height of the image in pixels
2305 * @return size of the image data in bytes
2307 int avpicture_fill(AVPicture *picture, uint8_t *ptr,
2308 int pix_fmt, int width, int height);
2309 int avpicture_layout(const AVPicture* src, int pix_fmt, int width, int height,
2310 unsigned char *dest, int dest_size);
2313 * Calculate the size in bytes that a picture of the given width and height
2314 * would occupy if stored in the given picture format.
2316 * @param pix_fmt the given picture format
2317 * @param width the width of the image
2318 * @param height the height of the image
2319 * @return Image data size in bytes
2321 int avpicture_get_size(int pix_fmt, int width, int height);
2322 void avcodec_get_chroma_sub_sample(int pix_fmt, int *h_shift, int *v_shift);
2323 const char *avcodec_get_pix_fmt_name(int pix_fmt);
2324 void avcodec_set_dimensions(AVCodecContext *s, int width, int height);
2325 enum PixelFormat avcodec_get_pix_fmt(const char* name);
2326 unsigned int avcodec_pix_fmt_to_codec_tag(enum PixelFormat p);
2328 #define FF_LOSS_RESOLUTION 0x0001 /**< loss due to resolution change */
2329 #define FF_LOSS_DEPTH 0x0002 /**< loss due to color depth change */
2330 #define FF_LOSS_COLORSPACE 0x0004 /**< loss due to color space conversion */
2331 #define FF_LOSS_ALPHA 0x0008 /**< loss of alpha bits */
2332 #define FF_LOSS_COLORQUANT 0x0010 /**< loss due to color quantization */
2333 #define FF_LOSS_CHROMA 0x0020 /**< loss of chroma (e.g. RGB to gray conversion) */
2336 * Computes what kind of losses will occur when converting from one specific
2337 * pixel format to another.
2338 * When converting from one pixel format to another, information loss may occur.
2339 * For example, when converting from RGB24 to GRAY, the color information will
2340 * be lost. Similarly, other losses occur when converting from some formats to
2341 * other formats. These losses can involve loss of chroma, but also loss of
2342 * resolution, loss of color depth, loss due to the color space conversion, loss
2343 * of the alpha bits or loss due to color quantization.
2344 * avcodec_get_fix_fmt_loss() informs you about the various types of losses
2345 * which will occur when converting from one pixel format to another.
2347 * @param[in] dst_pix_fmt destination pixel format
2348 * @param[in] src_pix_fmt source pixel format
2349 * @param[in] has_alpha Whether the source pixel format alpha channel is used.
2350 * @return Combination of flags informing you what kind of losses will occur.
2352 int avcodec_get_pix_fmt_loss(int dst_pix_fmt, int src_pix_fmt,
2356 * Finds the best pixel format to convert to given a certain source pixel
2357 * format. When converting from one pixel format to another, information loss
2358 * may occur. For example, when converting from RGB24 to GRAY, the color
2359 * information will be lost. Similarly, other losses occur when converting from
2360 * some formats to other formats. avcodec_find_best_pix_fmt() searches which of
2361 * the given pixel formats should be used to suffer the least amount of loss.
2362 * The pixel formats from which it chooses one, are determined by the
2363 * \p pix_fmt_mask parameter.
2366 * src_pix_fmt = PIX_FMT_YUV420P;
2367 * pix_fmt_mask = (1 << PIX_FMT_YUV422P) || (1 << PIX_FMT_RGB24);
2368 * dst_pix_fmt = avcodec_find_best_pix_fmt(pix_fmt_mask, src_pix_fmt, alpha, &loss);
2371 * @param[in] pix_fmt_mask bitmask determining which pixel format to choose from
2372 * @param[in] src_pix_fmt source pixel format
2373 * @param[in] has_alpha Whether the source pixel format alpha channel is used.
2374 * @param[out] loss_ptr Combination of flags informing you what kind of losses will occur.
2375 * @return The best pixel format to convert to or -1 if none was found.
2377 int avcodec_find_best_pix_fmt(int pix_fmt_mask, int src_pix_fmt,
2378 int has_alpha, int *loss_ptr);
2382 * Print in buf the string corresponding to the pixel format with
2383 * number pix_fmt, or an header if pix_fmt is negative.
2385 * @param buf[in] the buffer where to write the string
2386 * @param buf_size[in] the size of buf
2387 * @param pix_fmt[in] the number of the pixel format to print the corresponding info string, or
2388 * a negative value to print the corresponding header.
2389 * Meaningful values for obtaining a pixel format info vary from 0 to PIX_FMT_NB -1.
2391 void avcodec_pix_fmt_string (char *buf, int buf_size, int pix_fmt);
2393 #define FF_ALPHA_TRANSP 0x0001 /* image has some totally transparent pixels */
2394 #define FF_ALPHA_SEMI_TRANSP 0x0002 /* image has some transparent pixels */
2397 * Tell if an image really has transparent alpha values.
2398 * @return ored mask of FF_ALPHA_xxx constants
2400 int img_get_alpha_info(const AVPicture *src,
2401 int pix_fmt, int width, int height);
2403 #if LIBAVCODEC_VERSION_INT < ((52<<16)+(0<<8)+0)
2405 * convert among pixel formats
2406 * @deprecated Use the software scaler (swscale) instead.
2408 attribute_deprecated int img_convert(AVPicture *dst, int dst_pix_fmt,
2409 const AVPicture *src, int pix_fmt,
2410 int width, int height);
2413 /* deinterlace a picture */
2414 /* deinterlace - if not supported return -1 */
2415 int avpicture_deinterlace(AVPicture *dst, const AVPicture *src,
2416 int pix_fmt, int width, int height);
2418 /* external high level API */
2420 extern AVCodec *first_avcodec;
2422 /* returns LIBAVCODEC_VERSION_INT constant */
2423 unsigned avcodec_version(void);
2424 /* returns LIBAVCODEC_BUILD constant */
2425 unsigned avcodec_build(void);
2428 * Initializes libavcodec.
2430 * @warning This function \e must be called before any other libavcodec
2433 void avcodec_init(void);
2435 void register_avcodec(AVCodec *format);
2438 * Finds an encoder with a matching codec ID.
2440 * @param id CodecID of the requested encoder
2441 * @return An encoder if one was found, NULL otherwise.
2443 AVCodec *avcodec_find_encoder(enum CodecID id);
2446 * Finds an encoder with the specified name.
2448 * @param name name of the requested encoder
2449 * @return An encoder if one was found, NULL otherwise.
2451 AVCodec *avcodec_find_encoder_by_name(const char *name);
2454 * Finds a decoder with a matching codec ID.
2456 * @param id CodecID of the requested decoder
2457 * @return A decoder if one was found, NULL otherwise.
2459 AVCodec *avcodec_find_decoder(enum CodecID id);
2462 * Finds an decoder with the specified name.
2464 * @param name name of the requested decoder
2465 * @return A decoder if one was found, NULL otherwise.
2467 AVCodec *avcodec_find_decoder_by_name(const char *name);
2468 void avcodec_string(char *buf, int buf_size, AVCodecContext *enc, int encode);
2471 * Sets the fields of the given AVCodecContext to default values.
2473 * @param s The AVCodecContext of which the fields should be set to default values.
2475 void avcodec_get_context_defaults(AVCodecContext *s);
2477 /** THIS FUNCTION IS NOT YET PART OF THE PUBLIC API!
2478 * we WILL change its arguments and name a few times! */
2479 void avcodec_get_context_defaults2(AVCodecContext *s, enum CodecType);
2482 * Allocates an AVCodecContext and sets its fields to default values. The
2483 * resulting struct can be deallocated by simply calling av_free().
2485 * @return An AVCodecContext filled with default values or NULL on failure.
2486 * @see avcodec_get_context_defaults
2488 AVCodecContext *avcodec_alloc_context(void);
2490 /** THIS FUNCTION IS NOT YET PART OF THE PUBLIC API!
2491 * we WILL change its arguments and name a few times! */
2492 AVCodecContext *avcodec_alloc_context2(enum CodecType);
2495 * Sets the fields of the given AVFrame to default values.
2497 * @param pic The AVFrame of which the fields should be set to default values.
2499 void avcodec_get_frame_defaults(AVFrame *pic);
2502 * Allocates an AVFrame and sets its fields to default values. The resulting
2503 * struct can be deallocated by simply calling av_free().
2505 * @return An AVFrame filled with default values or NULL on failure.
2506 * @see avcodec_get_frame_defaults
2508 AVFrame *avcodec_alloc_frame(void);
2510 int avcodec_default_get_buffer(AVCodecContext *s, AVFrame *pic);
2511 void avcodec_default_release_buffer(AVCodecContext *s, AVFrame *pic);
2512 int avcodec_default_reget_buffer(AVCodecContext *s, AVFrame *pic);
2513 void avcodec_align_dimensions(AVCodecContext *s, int *width, int *height);
2516 * Checks if the given dimension of a picture is valid, meaning that all
2517 * bytes of the picture can be addressed with a signed int.
2519 * @param[in] w Width of the picture.
2520 * @param[in] h Height of the picture.
2521 * @return Zero if valid, a negative value if invalid.
2523 int avcodec_check_dimensions(void *av_log_ctx, unsigned int w, unsigned int h);
2524 enum PixelFormat avcodec_default_get_format(struct AVCodecContext *s, const enum PixelFormat * fmt);
2526 int avcodec_thread_init(AVCodecContext *s, int thread_count);
2527 void avcodec_thread_free(AVCodecContext *s);
2528 int avcodec_thread_execute(AVCodecContext *s, int (*func)(AVCodecContext *c2, void *arg2),void **arg, int *ret, int count);
2529 int avcodec_default_execute(AVCodecContext *c, int (*func)(AVCodecContext *c2, void *arg2),void **arg, int *ret, int count);
2530 //FIXME func typedef
2533 * Initializes the AVCodecContext to use the given AVCodec. Prior to using this
2534 * function the context has to be allocated.
2536 * The functions avcodec_find_decoder_by_name(), avcodec_find_encoder_by_name(),
2537 * avcodec_find_decoder() and avcodec_find_encoder() provide an easy way for
2538 * retrieving a codec.
2540 * @warning This function is not thread safe!
2543 * avcodec_register_all();
2544 * codec = avcodec_find_decoder(CODEC_ID_H264);
2548 * context = avcodec_alloc_context();
2550 * if (avcodec_open(context, codec) < 0)
2554 * @param avctx The context which will be set up to use the given codec.
2555 * @param codec The codec to use within the context.
2556 * @return zero on success, a negative value on error
2557 * @see avcodec_alloc_context, avcodec_find_decoder, avcodec_find_encoder
2559 int avcodec_open(AVCodecContext *avctx, AVCodec *codec);
2562 * @deprecated Use avcodec_decode_audio2() instead.
2564 attribute_deprecated int avcodec_decode_audio(AVCodecContext *avctx, int16_t *samples,
2565 int *frame_size_ptr,
2566 uint8_t *buf, int buf_size);
2569 * Decodes an audio frame from \p buf into \p samples.
2570 * The avcodec_decode_audio2() function decodes an audio frame from the input
2571 * buffer \p buf of size \p buf_size. To decode it, it makes use of the
2572 * audio codec which was coupled with \p avctx using avcodec_open(). The
2573 * resulting decoded frame is stored in output buffer \p samples. If no frame
2574 * could be decompressed, \p frame_size_ptr is zero. Otherwise, it is the
2575 * decompressed frame size in \e bytes.
2577 * @warning You \e must set \p frame_size_ptr to the allocated size of the
2578 * output buffer before calling avcodec_decode_audio2().
2580 * @warning The input buffer must be \c FF_INPUT_BUFFER_PADDING_SIZE larger than
2581 * the actual read bytes because some optimized bitstream readers read 32 or 64
2582 * bits at once and could read over the end.
2584 * @warning The end of the input buffer \p buf should be set to 0 to ensure that
2585 * no overreading happens for damaged MPEG streams.
2587 * @note You might have to align the input buffer \p buf and output buffer \p
2588 * samples. The alignment requirements depend on the CPU: On some CPUs it isn't
2589 * necessary at all, on others it won't work at all if not aligned and on others
2590 * it will work but it will have an impact on performance. In practice, the
2591 * bitstream should have 4 byte alignment at minimum and all sample data should
2592 * be 16 byte aligned unless the CPU doesn't need it (AltiVec and SSE do). If
2593 * the linesize is not a multiple of 16 then there's no sense in aligning the
2594 * start of the buffer to 16.
2596 * @param avctx the codec context
2597 * @param[out] samples the output buffer
2598 * @param[in,out] frame_size_ptr the output buffer size in bytes
2599 * @param[in] buf the input buffer
2600 * @param[in] buf_size the input buffer size in bytes
2601 * @return On error a negative value is returned, otherwise the number of bytes
2602 * used or zero if no frame could be decompressed.
2604 int avcodec_decode_audio2(AVCodecContext *avctx, int16_t *samples,
2605 int *frame_size_ptr,
2606 uint8_t *buf, int buf_size);
2609 * Decodes a video frame from \p buf into \p picture.
2610 * The avcodec_decode_video() function decodes a video frame from the input
2611 * buffer \p buf of size \p buf_size. To decode it, it makes use of the
2612 * video codec which was coupled with \p avctx using avcodec_open(). The
2613 * resulting decoded frame is stored in \p picture.
2615 * @warning The input buffer must be \c FF_INPUT_BUFFER_PADDING_SIZE larger than
2616 * the actual read bytes because some optimized bitstream readers read 32 or 64
2617 * bits at once and could read over the end.
2619 * @warning The end of the input buffer \p buf should be set to 0 to ensure that
2620 * no overreading happens for damaged MPEG streams.
2622 * @note You might have to align the input buffer \p buf and output buffer \p
2623 * samples. The alignment requirements depend on the CPU: on some CPUs it isn't
2624 * necessary at all, on others it won't work at all if not aligned and on others
2625 * it will work but it will have an impact on performance. In practice, the
2626 * bitstream should have 4 byte alignment at minimum and all sample data should
2627 * be 16 byte aligned unless the CPU doesn't need it (AltiVec and SSE do). If
2628 * the linesize is not a multiple of 16 then there's no sense in aligning the
2629 * start of the buffer to 16.
2631 * @param avctx the codec context
2632 * @param[out] picture The AVFrame in which the decoded video frame will be stored.
2633 * @param[in] buf the input buffer
2634 * @param[in] buf_size the size of the input buffer in bytes
2635 * @param[in,out] got_picture_ptr Zero if no frame could be decompressed, otherwise, it is nonzero.
2636 * @return On error a negative value is returned, otherwise the number of bytes
2637 * used or zero if no frame could be decompressed.
2639 int avcodec_decode_video(AVCodecContext *avctx, AVFrame *picture,
2640 int *got_picture_ptr,
2641 uint8_t *buf, int buf_size);
2643 /* Decode a subtitle message. Return -1 if error, otherwise return the
2644 * number of bytes used. If no subtitle could be decompressed,
2645 * got_sub_ptr is zero. Otherwise, the subtitle is stored in *sub. */
2646 int avcodec_decode_subtitle(AVCodecContext *avctx, AVSubtitle *sub,
2648 const uint8_t *buf, int buf_size);
2649 int avcodec_parse_frame(AVCodecContext *avctx, uint8_t **pdata,
2651 uint8_t *buf, int buf_size);
2654 * Encodes an audio frame from \p samples into \p buf.
2655 * The avcodec_encode_audio() function encodes an audio frame from the input
2656 * buffer \p samples. To encode it, it makes use of the audio codec which was
2657 * coupled with \p avctx using avcodec_open(). The resulting encoded frame is
2658 * stored in output buffer \p buf.
2660 * @note The output buffer should be at least \c FF_MIN_BUFFER_SIZE bytes large.
2662 * @param avctx the codec context
2663 * @param[out] buf the output buffer
2664 * @param[in] buf_size the output buffer size
2665 * @param[in] samples the input buffer containing the samples
2666 * @return On error a negative value is returned, on succes zero or the number
2667 * of bytes used from the input buffer.
2669 int avcodec_encode_audio(AVCodecContext *avctx, uint8_t *buf, int buf_size,
2670 const short *samples);
2673 * Encodes a video frame from \p pict into \p buf.
2674 * The avcodec_encode_video() function encodes a video frame from the input
2675 * \p pict. To encode it, it makes use of the video codec which was coupled with
2676 * \p avctx using avcodec_open(). The resulting encoded bytes representing the
2677 * frame are stored in the output buffer \p buf. The input picture should be
2678 * stored using a specific format, namely \c avctx.pix_fmt.
2680 * @param avctx the codec context
2681 * @param[out] buf the output buffer for the bitstream of encoded frame
2682 * @param[in] buf_size the size of the output buffer in bytes
2683 * @param[in] pict the input picture to encode
2684 * @return On error a negative value is returned, on success zero or the number
2685 * of bytes used from the input buffer.
2687 int avcodec_encode_video(AVCodecContext *avctx, uint8_t *buf, int buf_size,
2688 const AVFrame *pict);
2689 int avcodec_encode_subtitle(AVCodecContext *avctx, uint8_t *buf, int buf_size,
2690 const AVSubtitle *sub);
2692 int avcodec_close(AVCodecContext *avctx);
2694 void avcodec_register_all(void);
2697 * Flush buffers, should be called when seeking or when switching to a different stream.
2699 void avcodec_flush_buffers(AVCodecContext *avctx);
2701 void avcodec_default_free_buffers(AVCodecContext *s);
2703 /* misc useful functions */
2706 * Returns a single letter to describe the given picture type \p pict_type.
2708 * @param[in] pict_type the picture type
2709 * @return A single character representing the picture type.
2711 char av_get_pict_type_char(int pict_type);
2714 * Returns codec bits per sample.
2716 * @param[in] codec_id the codec
2717 * @return Number of bits per sample or zero if unknown for the given codec.
2719 int av_get_bits_per_sample(enum CodecID codec_id);
2722 * Returns sample format bits per sample.
2724 * @param[in] sample_fmt the sample format
2725 * @return Number of bits per sample or zero if unknown for the given sample format.
2727 int av_get_bits_per_sample_format(enum SampleFormat sample_fmt);
2730 typedef struct AVCodecParserContext {
2732 struct AVCodecParser *parser;
2733 int64_t frame_offset; /* offset of the current frame */
2734 int64_t cur_offset; /* current offset
2735 (incremented by each av_parser_parse()) */
2736 int64_t last_frame_offset; /* offset of the last frame */
2738 int pict_type; /* XXX: Put it back in AVCodecContext. */
2739 int repeat_pict; /* XXX: Put it back in AVCodecContext. */
2740 int64_t pts; /* pts of the current frame */
2741 int64_t dts; /* dts of the current frame */
2746 int fetch_timestamp;
2748 #define AV_PARSER_PTS_NB 4
2749 int cur_frame_start_index;
2750 int64_t cur_frame_offset[AV_PARSER_PTS_NB];
2751 int64_t cur_frame_pts[AV_PARSER_PTS_NB];
2752 int64_t cur_frame_dts[AV_PARSER_PTS_NB];
2755 #define PARSER_FLAG_COMPLETE_FRAMES 0x0001
2757 int64_t offset; ///< byte offset from starting packet start
2758 int64_t last_offset;
2759 } AVCodecParserContext;
2761 typedef struct AVCodecParser {
2762 int codec_ids[5]; /* several codec IDs are permitted */
2764 int (*parser_init)(AVCodecParserContext *s);
2765 int (*parser_parse)(AVCodecParserContext *s,
2766 AVCodecContext *avctx,
2767 const uint8_t **poutbuf, int *poutbuf_size,
2768 const uint8_t *buf, int buf_size);
2769 void (*parser_close)(AVCodecParserContext *s);
2770 int (*split)(AVCodecContext *avctx, const uint8_t *buf, int buf_size);
2771 struct AVCodecParser *next;
2774 extern AVCodecParser *av_first_parser;
2776 void av_register_codec_parser(AVCodecParser *parser);
2777 AVCodecParserContext *av_parser_init(int codec_id);
2778 int av_parser_parse(AVCodecParserContext *s,
2779 AVCodecContext *avctx,
2780 uint8_t **poutbuf, int *poutbuf_size,
2781 const uint8_t *buf, int buf_size,
2782 int64_t pts, int64_t dts);
2783 int av_parser_change(AVCodecParserContext *s,
2784 AVCodecContext *avctx,
2785 uint8_t **poutbuf, int *poutbuf_size,
2786 const uint8_t *buf, int buf_size, int keyframe);
2787 void av_parser_close(AVCodecParserContext *s);
2790 typedef struct AVBitStreamFilterContext {
2792 struct AVBitStreamFilter *filter;
2793 AVCodecParserContext *parser;
2794 struct AVBitStreamFilterContext *next;
2795 } AVBitStreamFilterContext;
2798 typedef struct AVBitStreamFilter {
2801 int (*filter)(AVBitStreamFilterContext *bsfc,
2802 AVCodecContext *avctx, const char *args,
2803 uint8_t **poutbuf, int *poutbuf_size,
2804 const uint8_t *buf, int buf_size, int keyframe);
2805 void (*close)(AVBitStreamFilterContext *bsfc);
2806 struct AVBitStreamFilter *next;
2807 } AVBitStreamFilter;
2809 void av_register_bitstream_filter(AVBitStreamFilter *bsf);
2810 AVBitStreamFilterContext *av_bitstream_filter_init(const char *name);
2811 int av_bitstream_filter_filter(AVBitStreamFilterContext *bsfc,
2812 AVCodecContext *avctx, const char *args,
2813 uint8_t **poutbuf, int *poutbuf_size,
2814 const uint8_t *buf, int buf_size, int keyframe);
2815 void av_bitstream_filter_close(AVBitStreamFilterContext *bsf);
2821 * Reallocates the given block if it is not large enough, otherwise it
2826 void *av_fast_realloc(void *ptr, unsigned int *size, unsigned int min_size);
2828 /* for static data only */
2831 * Frees all static arrays and resets their pointers to 0.
2832 * Call this function to release all statically allocated tables.
2834 * @deprecated. Code which uses av_free_static is broken/misdesigned
2835 * and should correctly use static arrays
2838 attribute_deprecated void av_free_static(void);
2841 * Allocation of static arrays.
2843 * @warning Do not use for normal allocation.
2845 * @param[in] size The amount of memory you need in bytes.
2846 * @return block of memory of the requested size
2847 * @deprecated. Code which uses av_mallocz_static is broken/misdesigned
2848 * and should correctly use static arrays
2850 attribute_deprecated void *av_mallocz_static(unsigned int size);
2853 * Copy image 'src' to 'dst'.
2855 void av_picture_copy(AVPicture *dst, const AVPicture *src,
2856 int pix_fmt, int width, int height);
2859 * Crop image top and left side.
2861 int av_picture_crop(AVPicture *dst, const AVPicture *src,
2862 int pix_fmt, int top_band, int left_band);
2867 int av_picture_pad(AVPicture *dst, const AVPicture *src, int height, int width, int pix_fmt,
2868 int padtop, int padbottom, int padleft, int padright, int *color);
2870 #if LIBAVCODEC_VERSION_INT < ((52<<16)+(0<<8)+0)
2872 * @deprecated Use the software scaler (swscale) instead.
2874 attribute_deprecated void img_copy(AVPicture *dst, const AVPicture *src,
2875 int pix_fmt, int width, int height);
2878 * @deprecated Use the software scaler (swscale) instead.
2880 attribute_deprecated int img_crop(AVPicture *dst, const AVPicture *src,
2881 int pix_fmt, int top_band, int left_band);
2884 * @deprecated Use the software scaler (swscale) instead.
2886 attribute_deprecated int img_pad(AVPicture *dst, const AVPicture *src, int height, int width, int pix_fmt,
2887 int padtop, int padbottom, int padleft, int padright, int *color);
2890 extern unsigned int av_xiphlacing(unsigned char *s, unsigned int v);
2893 * Parses \p str and put in \p width_ptr and \p height_ptr the detected values.
2895 * @return 0 in case of a successful parsing, a negative value otherwise
2896 * @param[in] str the string to parse: it has to be a string in the format
2897 * <width>x<height> or a valid video frame size abbreviation.
2898 * @param[in,out] width_ptr pointer to the variable which will contain the detected
2900 * @param[in,out] height_ptr pointer to the variable which will contain the detected
2901 * frame height value
2903 int av_parse_video_frame_size(int *width_ptr, int *height_ptr, const char *str);
2906 * Parses \p str and put in \p frame_rate the detected values.
2908 * @return 0 in case of a successful parsing, a negative value otherwise
2909 * @param[in] str the string to parse: it has to be a string in the format
2910 * <frame_rate_nom>/<frame_rate_den>, a float number or a valid video rate abbreviation
2911 * @param[in,out] frame_rate pointer to the AVRational which will contain the detected
2914 int av_parse_video_frame_rate(AVRational *frame_rate, const char *str);
2916 /* error handling */
2918 #define AVERROR(e) (-(e)) /**< Returns a negative error code from a POSIX error code, to return from library functions. */
2919 #define AVUNERROR(e) (-(e)) /**< Returns a POSIX error code from a library function error return value. */
2921 /* Some platforms have E* and errno already negated. */
2922 #define AVERROR(e) (e)
2923 #define AVUNERROR(e) (e)
2925 #define AVERROR_UNKNOWN AVERROR(EINVAL) /**< unknown error */
2926 #define AVERROR_IO AVERROR(EIO) /**< I/O error */
2927 #define AVERROR_NUMEXPECTED AVERROR(EDOM) /**< Number syntax expected in filename. */
2928 #define AVERROR_INVALIDDATA AVERROR(EINVAL) /**< invalid data found */
2929 #define AVERROR_NOMEM AVERROR(ENOMEM) /**< not enough memory */
2930 #define AVERROR_NOFMT AVERROR(EILSEQ) /**< unknown format */
2931 #define AVERROR_NOTSUPP AVERROR(ENOSYS) /**< Operation not supported. */
2932 #define AVERROR_NOENT AVERROR(ENOENT) /**< No such file or directory. */
2933 #define AVERROR_PATCHWELCOME -MKTAG('P','A','W','E') /**< Not yet implemented in FFmpeg. Patches welcome. */
2935 #endif /* AVCODEC_H */