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
21 #ifndef AVCODEC_AVCODEC_H
22 #define AVCODEC_AVCODEC_H
30 #include "libavutil/samplefmt.h"
31 #include "libavutil/avutil.h"
32 #include "libavutil/cpu.h"
33 #include "libavutil/dict.h"
34 #include "libavutil/log.h"
35 #include "libavutil/pixfmt.h"
36 #include "libavutil/rational.h"
37 #include "libavutil/audioconvert.h"
39 #include "libavcodec/version.h"
41 * @defgroup libavc Encoding/Decoding Library
44 * @defgroup lavc_decoding Decoding
48 * @defgroup lavc_encoding Encoding
52 * @defgroup lavc_codec Codecs
54 * @defgroup lavc_codec_native Native Codecs
57 * @defgroup lavc_codec_wrappers External library wrappers
60 * @defgroup lavc_codec_hwaccel Hardware Accelerators bridge
64 * @defgroup lavc_internal Internal
72 * @defgroup lavc_core Core functions/structures.
75 * Basic definitions, functions for querying libavcodec capabilities,
76 * allocating core structures, etc.
81 * Identify the syntax and semantics of the bitstream.
82 * The principle is roughly:
83 * Two decoders with the same ID can decode the same streams.
84 * Two encoders with the same ID can encode compatible streams.
85 * There may be slight deviations from the principle due to implementation
88 * If you add a codec ID to this list, add it so that
89 * 1. no value of a existing codec ID changes (that would break ABI),
90 * 2. Give it a value which when taken as ASCII is recognized uniquely by a human as this specific codec.
91 * This ensures that 2 forks can independently add CodecIDs without producing conflicts.
98 CODEC_ID_MPEG2VIDEO, ///< preferred ID for MPEG-1/2 video decoding
99 CODEC_ID_MPEG2VIDEO_XVMC,
136 CODEC_ID_INTERPLAY_VIDEO,
148 CODEC_ID_TRUEMOTION1,
175 CODEC_ID_TRUEMOTION2,
192 CODEC_ID_DSICINVIDEO,
193 CODEC_ID_TIERTEXSEQVIDEO,
201 CODEC_ID_BETHSOFTVID,
217 CODEC_ID_MOTIONPIXELS,
235 CODEC_ID_IFF_BYTERUN1,
261 CODEC_ID_Y41P = MKBETAG('Y','4','1','P'),
262 CODEC_ID_ESCAPE130 = MKBETAG('E','1','3','0'),
263 CODEC_ID_EXR = MKBETAG('0','E','X','R'),
264 CODEC_ID_AVRP = MKBETAG('A','V','R','P'),
266 CODEC_ID_G2M = MKBETAG( 0 ,'G','2','M'),
267 CODEC_ID_AVUI = MKBETAG('A','V','U','I'),
268 CODEC_ID_AYUV = MKBETAG('A','Y','U','V'),
269 CODEC_ID_V308 = MKBETAG('V','3','0','8'),
270 CODEC_ID_V408 = MKBETAG('V','4','0','8'),
271 CODEC_ID_YUV4 = MKBETAG('Y','U','V','4'),
272 CODEC_ID_SANM = MKBETAG('S','A','N','M'),
274 /* various PCM "codecs" */
275 CODEC_ID_FIRST_AUDIO = 0x10000, ///< A dummy id pointing at the start of audio codecs
276 CODEC_ID_PCM_S16LE = 0x10000,
292 CODEC_ID_PCM_S24DAUD,
294 CODEC_ID_PCM_S16LE_PLANAR,
303 CODEC_ID_PCM_S8_PLANAR,
305 /* various ADPCM codecs */
306 CODEC_ID_ADPCM_IMA_QT = 0x11000,
307 CODEC_ID_ADPCM_IMA_WAV,
308 CODEC_ID_ADPCM_IMA_DK3,
309 CODEC_ID_ADPCM_IMA_DK4,
310 CODEC_ID_ADPCM_IMA_WS,
311 CODEC_ID_ADPCM_IMA_SMJPEG,
320 CODEC_ID_ADPCM_YAMAHA,
321 CODEC_ID_ADPCM_SBPRO_4,
322 CODEC_ID_ADPCM_SBPRO_3,
323 CODEC_ID_ADPCM_SBPRO_2,
325 CODEC_ID_ADPCM_IMA_AMV,
326 CODEC_ID_ADPCM_EA_R1,
327 CODEC_ID_ADPCM_EA_R3,
328 CODEC_ID_ADPCM_EA_R2,
329 CODEC_ID_ADPCM_IMA_EA_SEAD,
330 CODEC_ID_ADPCM_IMA_EA_EACS,
331 CODEC_ID_ADPCM_EA_XAS,
332 CODEC_ID_ADPCM_EA_MAXIS_XA,
333 CODEC_ID_ADPCM_IMA_ISS,
335 CODEC_ID_ADPCM_IMA_APC,
336 CODEC_ID_VIMA = MKBETAG('V','I','M','A'),
339 CODEC_ID_AMR_NB = 0x12000,
342 /* RealAudio codecs*/
343 CODEC_ID_RA_144 = 0x13000,
346 /* various DPCM codecs */
347 CODEC_ID_ROQ_DPCM = 0x14000,
348 CODEC_ID_INTERPLAY_DPCM,
353 CODEC_ID_MP2 = 0x15000,
354 CODEC_ID_MP3, ///< preferred ID for decoding MPEG audio layer 1, 2 or 3
370 CODEC_ID_WESTWOOD_SND1,
371 CODEC_ID_GSM, ///< as in Berlin toast format
379 CODEC_ID_DSICINAUDIO,
383 CODEC_ID_GSM_MS, /* as found in WAV */
392 CODEC_ID_WMALOSSLESS,
401 CODEC_ID_BINKAUDIO_RDFT,
402 CODEC_ID_BINKAUDIO_DCT,
414 CODEC_ID_FFWAVESYNTH = MKBETAG('F','F','W','S'),
415 CODEC_ID_8SVX_RAW = MKBETAG('8','S','V','X'),
416 CODEC_ID_SONIC = MKBETAG('S','O','N','C'),
417 CODEC_ID_SONIC_LS = MKBETAG('S','O','N','L'),
419 /* subtitle codecs */
420 CODEC_ID_FIRST_SUBTITLE = 0x17000, ///< A dummy ID pointing at the start of subtitle codecs.
421 CODEC_ID_DVD_SUBTITLE = 0x17000,
422 CODEC_ID_DVB_SUBTITLE,
423 CODEC_ID_TEXT, ///< raw UTF-8 text
427 CODEC_ID_HDMV_PGS_SUBTITLE,
428 CODEC_ID_DVB_TELETEXT,
430 CODEC_ID_MICRODVD = MKBETAG('m','D','V','D'),
431 CODEC_ID_EIA_608 = MKBETAG('c','6','0','8'),
432 CODEC_ID_JACOSUB = MKBETAG('J','S','U','B'),
434 /* other specific kind of codecs (generally used for attachments) */
435 CODEC_ID_FIRST_UNKNOWN = 0x18000, ///< A dummy ID pointing at the start of various fake codecs.
436 CODEC_ID_TTF = 0x18000,
437 CODEC_ID_BINTEXT = MKBETAG('B','T','X','T'),
438 CODEC_ID_XBIN = MKBETAG('X','B','I','N'),
439 CODEC_ID_IDF = MKBETAG( 0 ,'I','D','F'),
441 CODEC_ID_PROBE = 0x19000, ///< codec_id is not known (like CODEC_ID_NONE) but lavf should attempt to identify it
443 CODEC_ID_MPEG2TS = 0x20000, /**< _FAKE_ codec to indicate a raw MPEG-2 TS
444 * stream (only used by libavformat) */
445 CODEC_ID_MPEG4SYSTEMS = 0x20001, /**< _FAKE_ codec to indicate a MPEG-4 Systems
446 * stream (only used by libavformat) */
447 CODEC_ID_FFMETADATA = 0x21000, ///< Dummy codec for streams containing only metadata information.
450 #if FF_API_OLD_DECODE_AUDIO
452 #define AVCODEC_MAX_AUDIO_FRAME_SIZE 192000 // 1 second of 48khz 32bit audio
456 * @ingroup lavc_decoding
457 * Required number of additionally allocated bytes at the end of the input bitstream for decoding.
458 * This is mainly needed because some optimized bitstream readers read
459 * 32 or 64 bit at once and could read over the end.<br>
460 * Note: If the first 23 bits of the additional bytes are not 0, then damaged
461 * MPEG bitstreams could cause overread and segfault.
463 #define FF_INPUT_BUFFER_PADDING_SIZE 16
466 * @ingroup lavc_encoding
467 * minimum encoding buffer size
468 * Used to avoid some checks during header writing.
470 #define FF_MIN_BUFFER_SIZE 16384
474 * @ingroup lavc_encoding
475 * motion estimation type.
478 ME_ZERO = 1, ///< no search, that is use 0,0 vector whenever one is needed
482 ME_EPZS, ///< enhanced predictive zonal search
483 ME_X1, ///< reserved for experiments
484 ME_HEX, ///< hexagon based search
485 ME_UMH, ///< uneven multi-hexagon search
486 ME_ITER, ///< iterative search
487 ME_TESA, ///< transformed exhaustive search algorithm
491 * @ingroup lavc_decoding
494 /* We leave some space between them for extensions (drop some
495 * keyframes for intra-only or drop just some bidir frames). */
496 AVDISCARD_NONE =-16, ///< discard nothing
497 AVDISCARD_DEFAULT = 0, ///< discard useless packets like 0 size packets in avi
498 AVDISCARD_NONREF = 8, ///< discard all non reference
499 AVDISCARD_BIDIR = 16, ///< discard all bidirectional frames
500 AVDISCARD_NONKEY = 32, ///< discard all frames except keyframes
501 AVDISCARD_ALL = 48, ///< discard all
504 enum AVColorPrimaries{
505 AVCOL_PRI_BT709 = 1, ///< also ITU-R BT1361 / IEC 61966-2-4 / SMPTE RP177 Annex B
506 AVCOL_PRI_UNSPECIFIED = 2,
507 AVCOL_PRI_BT470M = 4,
508 AVCOL_PRI_BT470BG = 5, ///< also ITU-R BT601-6 625 / ITU-R BT1358 625 / ITU-R BT1700 625 PAL & SECAM
509 AVCOL_PRI_SMPTE170M = 6, ///< also ITU-R BT601-6 525 / ITU-R BT1358 525 / ITU-R BT1700 NTSC
510 AVCOL_PRI_SMPTE240M = 7, ///< functionally identical to above
512 AVCOL_PRI_NB , ///< Not part of ABI
515 enum AVColorTransferCharacteristic{
516 AVCOL_TRC_BT709 = 1, ///< also ITU-R BT1361
517 AVCOL_TRC_UNSPECIFIED = 2,
518 AVCOL_TRC_GAMMA22 = 4, ///< also ITU-R BT470M / ITU-R BT1700 625 PAL & SECAM
519 AVCOL_TRC_GAMMA28 = 5, ///< also ITU-R BT470BG
520 AVCOL_TRC_SMPTE240M = 7,
521 AVCOL_TRC_NB , ///< Not part of ABI
526 AVCOL_SPC_BT709 = 1, ///< also ITU-R BT1361 / IEC 61966-2-4 xvYCC709 / SMPTE RP177 Annex B
527 AVCOL_SPC_UNSPECIFIED = 2,
529 AVCOL_SPC_BT470BG = 5, ///< also ITU-R BT601-6 625 / ITU-R BT1358 625 / ITU-R BT1700 625 PAL & SECAM / IEC 61966-2-4 xvYCC601
530 AVCOL_SPC_SMPTE170M = 6, ///< also ITU-R BT601-6 525 / ITU-R BT1358 525 / ITU-R BT1700 NTSC / functionally identical to above
531 AVCOL_SPC_SMPTE240M = 7,
532 AVCOL_SPC_YCOCG = 8, ///< Used by Dirac / VC-2 and H.264 FRext, see ITU-T SG16
533 AVCOL_SPC_NB , ///< Not part of ABI
535 #define AVCOL_SPC_YCGCO AVCOL_SPC_YCOCG
538 AVCOL_RANGE_UNSPECIFIED = 0,
539 AVCOL_RANGE_MPEG = 1, ///< the normal 219*2^(n-8) "MPEG" YUV ranges
540 AVCOL_RANGE_JPEG = 2, ///< the normal 2^n-1 "JPEG" YUV ranges
541 AVCOL_RANGE_NB , ///< Not part of ABI
545 * X X 3 4 X X are luma samples,
546 * 1 2 1-6 are possible chroma positions
547 * X X 5 6 X 0 is undefined/unknown position
549 enum AVChromaLocation{
550 AVCHROMA_LOC_UNSPECIFIED = 0,
551 AVCHROMA_LOC_LEFT = 1, ///< mpeg2/4, h264 default
552 AVCHROMA_LOC_CENTER = 2, ///< mpeg1, jpeg, h263
553 AVCHROMA_LOC_TOPLEFT = 3, ///< DV
554 AVCHROMA_LOC_TOP = 4,
555 AVCHROMA_LOC_BOTTOMLEFT = 5,
556 AVCHROMA_LOC_BOTTOM = 6,
557 AVCHROMA_LOC_NB , ///< Not part of ABI
560 enum AVAudioServiceType {
561 AV_AUDIO_SERVICE_TYPE_MAIN = 0,
562 AV_AUDIO_SERVICE_TYPE_EFFECTS = 1,
563 AV_AUDIO_SERVICE_TYPE_VISUALLY_IMPAIRED = 2,
564 AV_AUDIO_SERVICE_TYPE_HEARING_IMPAIRED = 3,
565 AV_AUDIO_SERVICE_TYPE_DIALOGUE = 4,
566 AV_AUDIO_SERVICE_TYPE_COMMENTARY = 5,
567 AV_AUDIO_SERVICE_TYPE_EMERGENCY = 6,
568 AV_AUDIO_SERVICE_TYPE_VOICE_OVER = 7,
569 AV_AUDIO_SERVICE_TYPE_KARAOKE = 8,
570 AV_AUDIO_SERVICE_TYPE_NB , ///< Not part of ABI
574 * @ingroup lavc_encoding
576 typedef struct RcOverride{
579 int qscale; // If this is 0 then quality_factor will be used instead.
580 float quality_factor;
583 #define FF_MAX_B_FRAMES 16
586 These flags can be passed in AVCodecContext.flags before initialization.
587 Note: Not everything is supported yet.
590 #define CODEC_FLAG_QSCALE 0x0002 ///< Use fixed qscale.
591 #define CODEC_FLAG_4MV 0x0004 ///< 4 MV per MB allowed / advanced prediction for H.263.
592 #define CODEC_FLAG_QPEL 0x0010 ///< Use qpel MC.
593 #define CODEC_FLAG_GMC 0x0020 ///< Use GMC.
594 #define CODEC_FLAG_MV0 0x0040 ///< Always try a MB with MV=<0,0>.
596 * The parent program guarantees that the input for B-frames containing
597 * streams is not written to for at least s->max_b_frames+1 frames, if
598 * this is not set the input will be copied.
600 #define CODEC_FLAG_INPUT_PRESERVED 0x0100
601 #define CODEC_FLAG_PASS1 0x0200 ///< Use internal 2pass ratecontrol in first pass mode.
602 #define CODEC_FLAG_PASS2 0x0400 ///< Use internal 2pass ratecontrol in second pass mode.
603 #define CODEC_FLAG_GRAY 0x2000 ///< Only decode/encode grayscale.
604 #define CODEC_FLAG_EMU_EDGE 0x4000 ///< Don't draw edges.
605 #define CODEC_FLAG_PSNR 0x8000 ///< error[?] variables will be set during encoding.
606 #define CODEC_FLAG_TRUNCATED 0x00010000 /** Input bitstream might be truncated at a random
607 location instead of only at frame boundaries. */
608 #define CODEC_FLAG_NORMALIZE_AQP 0x00020000 ///< Normalize adaptive quantization.
609 #define CODEC_FLAG_INTERLACED_DCT 0x00040000 ///< Use interlaced DCT.
610 #define CODEC_FLAG_LOW_DELAY 0x00080000 ///< Force low delay.
611 #define CODEC_FLAG_GLOBAL_HEADER 0x00400000 ///< Place global headers in extradata instead of every keyframe.
612 #define CODEC_FLAG_BITEXACT 0x00800000 ///< Use only bitexact stuff (except (I)DCT).
613 /* Fx : Flag for h263+ extra options */
614 #define CODEC_FLAG_AC_PRED 0x01000000 ///< H.263 advanced intra coding / MPEG-4 AC prediction
615 #define CODEC_FLAG_LOOP_FILTER 0x00000800 ///< loop filter
616 #define CODEC_FLAG_INTERLACED_ME 0x20000000 ///< interlaced motion estimation
617 #define CODEC_FLAG_CLOSED_GOP 0x80000000
618 #define CODEC_FLAG2_FAST 0x00000001 ///< Allow non spec compliant speedup tricks.
619 #define CODEC_FLAG2_NO_OUTPUT 0x00000004 ///< Skip bitstream encoding.
620 #define CODEC_FLAG2_LOCAL_HEADER 0x00000008 ///< Place global headers at every keyframe instead of in extradata.
621 #define CODEC_FLAG2_DROP_FRAME_TIMECODE 0x00002000 ///< timecode is in drop frame format. DEPRECATED!!!!
622 #if FF_API_MPV_GLOBAL_OPTS
623 #define CODEC_FLAG_CBP_RD 0x04000000 ///< Use rate distortion optimization for cbp.
624 #define CODEC_FLAG_QP_RD 0x08000000 ///< Use rate distortion optimization for qp selectioon.
625 #define CODEC_FLAG2_STRICT_GOP 0x00000002 ///< Strictly enforce GOP size.
626 #define CODEC_FLAG2_SKIP_RD 0x00004000 ///< RD optimal MB level residual skipping
628 #define CODEC_FLAG2_CHUNKS 0x00008000 ///< Input bitstream might be truncated at a packet boundaries instead of only at frame boundaries.
629 #define CODEC_FLAG2_SHOW_ALL 0x00400000 ///< Show all frames before the first keyframe
631 /* Unsupported options :
632 * Syntax Arithmetic coding (SAC)
633 * Reference Picture Selection
634 * Independent Segment Decoding */
636 /* codec capabilities */
638 #define CODEC_CAP_DRAW_HORIZ_BAND 0x0001 ///< Decoder can use draw_horiz_band callback.
640 * Codec uses get_buffer() for allocating buffers and supports custom allocators.
641 * If not set, it might not use get_buffer() at all or use operations that
642 * assume the buffer was allocated by avcodec_default_get_buffer.
644 #define CODEC_CAP_DR1 0x0002
645 #define CODEC_CAP_TRUNCATED 0x0008
646 /* Codec can export data for HW decoding (XvMC). */
647 #define CODEC_CAP_HWACCEL 0x0010
649 * Encoder or decoder requires flushing with NULL input at the end in order to
650 * give the complete and correct output.
652 * NOTE: If this flag is not set, the codec is guaranteed to never be fed with
653 * with NULL data. The user can still send NULL data to the public encode
654 * or decode function, but libavcodec will not pass it along to the codec
655 * unless this flag is set.
658 * The decoder has a non-zero delay and needs to be fed with avpkt->data=NULL,
659 * avpkt->size=0 at the end to get the delayed data until the decoder no longer
663 * The encoder needs to be fed with NULL data at the end of encoding until the
664 * encoder no longer returns data.
666 * NOTE: For encoders implementing the AVCodec.encode2() function, setting this
667 * flag also means that the encoder must set the pts and duration for
668 * each output packet. If this flag is not set, the pts and duration will
669 * be determined by libavcodec from the input frame.
671 #define CODEC_CAP_DELAY 0x0020
673 * Codec can be fed a final frame with a smaller size.
674 * This can be used to prevent truncation of the last audio samples.
676 #define CODEC_CAP_SMALL_LAST_FRAME 0x0040
678 * Codec can export data for HW decoding (VDPAU).
680 #define CODEC_CAP_HWACCEL_VDPAU 0x0080
682 * Codec can output multiple frames per AVPacket
683 * Normally demuxers return one frame at a time, demuxers which do not do
684 * are connected to a parser to split what they return into proper frames.
685 * This flag is reserved to the very rare category of codecs which have a
686 * bitstream that cannot be split into frames without timeconsuming
687 * operations like full decoding. Demuxers carring such bitstreams thus
688 * may return multiple frames in a packet. This has many disadvantages like
689 * prohibiting stream copy in many cases thus it should only be considered
692 #define CODEC_CAP_SUBFRAMES 0x0100
694 * Codec is experimental and is thus avoided in favor of non experimental
697 #define CODEC_CAP_EXPERIMENTAL 0x0200
699 * Codec should fill in channel configuration and samplerate instead of container
701 #define CODEC_CAP_CHANNEL_CONF 0x0400
704 * Codec is able to deal with negative linesizes
706 #define CODEC_CAP_NEG_LINESIZES 0x0800
709 * Codec supports frame-level multithreading.
711 #define CODEC_CAP_FRAME_THREADS 0x1000
713 * Codec supports slice-based (or partition-based) multithreading.
715 #define CODEC_CAP_SLICE_THREADS 0x2000
717 * Codec supports changed parameters at any point.
719 #define CODEC_CAP_PARAM_CHANGE 0x4000
721 * Codec supports avctx->thread_count == 0 (auto).
723 #define CODEC_CAP_AUTO_THREADS 0x8000
725 * Audio encoder supports receiving a different number of samples in each call.
727 #define CODEC_CAP_VARIABLE_FRAME_SIZE 0x10000
729 * Codec is intra only.
731 #define CODEC_CAP_INTRA_ONLY 0x40000000
735 #define CODEC_CAP_LOSSLESS 0x80000000
737 //The following defines may change, don't expect compatibility if you use them.
738 #define MB_TYPE_INTRA4x4 0x0001
739 #define MB_TYPE_INTRA16x16 0x0002 //FIXME H.264-specific
740 #define MB_TYPE_INTRA_PCM 0x0004 //FIXME H.264-specific
741 #define MB_TYPE_16x16 0x0008
742 #define MB_TYPE_16x8 0x0010
743 #define MB_TYPE_8x16 0x0020
744 #define MB_TYPE_8x8 0x0040
745 #define MB_TYPE_INTERLACED 0x0080
746 #define MB_TYPE_DIRECT2 0x0100 //FIXME
747 #define MB_TYPE_ACPRED 0x0200
748 #define MB_TYPE_GMC 0x0400
749 #define MB_TYPE_SKIP 0x0800
750 #define MB_TYPE_P0L0 0x1000
751 #define MB_TYPE_P1L0 0x2000
752 #define MB_TYPE_P0L1 0x4000
753 #define MB_TYPE_P1L1 0x8000
754 #define MB_TYPE_L0 (MB_TYPE_P0L0 | MB_TYPE_P1L0)
755 #define MB_TYPE_L1 (MB_TYPE_P0L1 | MB_TYPE_P1L1)
756 #define MB_TYPE_L0L1 (MB_TYPE_L0 | MB_TYPE_L1)
757 #define MB_TYPE_QUANT 0x00010000
758 #define MB_TYPE_CBP 0x00020000
759 //Note bits 24-31 are reserved for codec specific use (h264 ref0, mpeg1 0mv, ...)
763 * This specifies the area which should be displayed.
764 * Note there may be multiple such areas for one frame.
766 typedef struct AVPanScan{
769 * - encoding: Set by user.
770 * - decoding: Set by libavcodec.
775 * width and height in 1/16 pel
776 * - encoding: Set by user.
777 * - decoding: Set by libavcodec.
783 * position of the top left corner in 1/16 pel for up to 3 fields/frames
784 * - encoding: Set by user.
785 * - decoding: Set by libavcodec.
787 int16_t position[3][2];
790 #define FF_QSCALE_TYPE_MPEG1 0
791 #define FF_QSCALE_TYPE_MPEG2 1
792 #define FF_QSCALE_TYPE_H264 2
793 #define FF_QSCALE_TYPE_VP56 3
795 #define FF_BUFFER_TYPE_INTERNAL 1
796 #define FF_BUFFER_TYPE_USER 2 ///< direct rendering buffers (image is (de)allocated by user)
797 #define FF_BUFFER_TYPE_SHARED 4 ///< Buffer from somewhere else; don't deallocate image (data/base), all other tables are not shared.
798 #define FF_BUFFER_TYPE_COPY 8 ///< Just a (modified) copy of some other buffer, don't deallocate anything.
800 #define FF_BUFFER_HINTS_VALID 0x01 // Buffer hints value is meaningful (if 0 ignore).
801 #define FF_BUFFER_HINTS_READABLE 0x02 // Codec will read from buffer.
802 #define FF_BUFFER_HINTS_PRESERVE 0x04 // User must not alter buffer content.
803 #define FF_BUFFER_HINTS_REUSABLE 0x08 // Codec will reuse the buffer (update).
806 * @defgroup lavc_packet AVPacket
808 * Types and functions for working with AVPacket.
811 enum AVPacketSideDataType {
813 AV_PKT_DATA_NEW_EXTRADATA,
816 * An AV_PKT_DATA_PARAM_CHANGE side data packet is laid out as follows:
819 * if (param_flags & AV_SIDE_DATA_PARAM_CHANGE_CHANNEL_COUNT)
820 * s32le channel_count
821 * if (param_flags & AV_SIDE_DATA_PARAM_CHANGE_CHANNEL_LAYOUT)
822 * u64le channel_layout
823 * if (param_flags & AV_SIDE_DATA_PARAM_CHANGE_SAMPLE_RATE)
825 * if (param_flags & AV_SIDE_DATA_PARAM_CHANGE_DIMENSIONS)
830 AV_PKT_DATA_PARAM_CHANGE,
833 * An AV_PKT_DATA_H263_MB_INFO side data packet contains a number of
834 * structures with info about macroblocks relevant to splitting the
835 * packet into smaller packets on macroblock edges (e.g. as for RFC 2190).
836 * That is, it does not necessarily contain info about all macroblocks,
837 * as long as the distance between macroblocks in the info is smaller
838 * than the target payload size.
839 * Each MB info structure is 12 bytes, and is laid out as follows:
841 * u32le bit offset from the start of the packet
842 * u8 current quantizer at the start of the macroblock
844 * u16le macroblock address within the GOB
845 * u8 horizontal MV predictor
846 * u8 vertical MV predictor
847 * u8 horizontal MV predictor for block number 3
848 * u8 vertical MV predictor for block number 3
851 AV_PKT_DATA_H263_MB_INFO,
854 typedef struct AVPacket {
856 * Presentation timestamp in AVStream->time_base units; the time at which
857 * the decompressed packet will be presented to the user.
858 * Can be AV_NOPTS_VALUE if it is not stored in the file.
859 * pts MUST be larger or equal to dts as presentation cannot happen before
860 * decompression, unless one wants to view hex dumps. Some formats misuse
861 * the terms dts and pts/cts to mean something different. Such timestamps
862 * must be converted to true pts/dts before they are stored in AVPacket.
866 * Decompression timestamp in AVStream->time_base units; the time at which
867 * the packet is decompressed.
868 * Can be AV_NOPTS_VALUE if it is not stored in the file.
875 * A combination of AV_PKT_FLAG values
879 * Additional packet data that can be provided by the container.
880 * Packet can contain several types of side information.
885 enum AVPacketSideDataType type;
890 * Duration of this packet in AVStream->time_base units, 0 if unknown.
891 * Equals next_pts - this_pts in presentation order.
894 void (*destruct)(struct AVPacket *);
896 int64_t pos; ///< byte position in stream, -1 if unknown
899 * Time difference in AVStream->time_base units from the pts of this
900 * packet to the point at which the output from the decoder has converged
901 * independent from the availability of previous frames. That is, the
902 * frames are virtually identical no matter if decoding started from
903 * the very first frame or from this keyframe.
904 * Is AV_NOPTS_VALUE if unknown.
905 * This field is not the display duration of the current packet.
906 * This field has no meaning if the packet does not have AV_PKT_FLAG_KEY
909 * The purpose of this field is to allow seeking in streams that have no
910 * keyframes in the conventional sense. It corresponds to the
911 * recovery point SEI in H.264 and match_time_delta in NUT. It is also
912 * essential for some types of subtitle streams to ensure that all
913 * subtitles are correctly displayed after seeking.
915 int64_t convergence_duration;
917 #define AV_PKT_FLAG_KEY 0x0001 ///< The packet contains a keyframe
918 #define AV_PKT_FLAG_CORRUPT 0x0002 ///< The packet content is corrupted
920 enum AVSideDataParamChangeFlags {
921 AV_SIDE_DATA_PARAM_CHANGE_CHANNEL_COUNT = 0x0001,
922 AV_SIDE_DATA_PARAM_CHANGE_CHANNEL_LAYOUT = 0x0002,
923 AV_SIDE_DATA_PARAM_CHANGE_SAMPLE_RATE = 0x0004,
924 AV_SIDE_DATA_PARAM_CHANGE_DIMENSIONS = 0x0008,
932 * New fields can be added to the end of AVFRAME with minor version
933 * bumps. Similarly fields that are marked as to be only accessed by
934 * av_opt_ptr() can be reordered. This allows 2 forks to add fields
935 * without breaking compatibility with each other.
936 * Removal, reordering and changes in the remaining cases require
937 * a major version bump.
938 * sizeof(AVFrame) must not be used outside libavcodec.
940 typedef struct AVFrame {
941 #define AV_NUM_DATA_POINTERS 8
943 * pointer to the picture/channel planes.
944 * This might be different from the first allocated byte
945 * - encoding: Set by user
946 * - decoding: set by AVCodecContext.get_buffer()
948 uint8_t *data[AV_NUM_DATA_POINTERS];
951 * Size, in bytes, of the data for each picture/channel plane.
953 * For audio, only linesize[0] may be set. For planar audio, each channel
954 * plane must be the same size.
956 * - encoding: Set by user
957 * - decoding: set by AVCodecContext.get_buffer()
959 int linesize[AV_NUM_DATA_POINTERS];
962 * pointers to the data planes/channels.
964 * For video, this should simply point to data[].
966 * For planar audio, each channel has a separate data pointer, and
967 * linesize[0] contains the size of each channel buffer.
968 * For packed audio, there is just one data pointer, and linesize[0]
969 * contains the total size of the buffer for all channels.
971 * Note: Both data and extended_data will always be set by get_buffer(),
972 * but for planar audio with more channels that can fit in data,
973 * extended_data must be used by the decoder in order to access all
977 * decoding: set by AVCodecContext.get_buffer()
979 uint8_t **extended_data;
982 * width and height of the video frame
984 * - decoding: Read by user.
989 * number of audio samples (per channel) described by this frame
990 * - encoding: Set by user
991 * - decoding: Set by libavcodec
996 * format of the frame, -1 if unknown or unset
997 * Values correspond to enum PixelFormat for video frames,
998 * enum AVSampleFormat for audio)
1000 * - decoding: Read by user.
1005 * 1 -> keyframe, 0-> not
1006 * - encoding: Set by libavcodec.
1007 * - decoding: Set by libavcodec.
1012 * Picture type of the frame, see ?_TYPE below.
1013 * - encoding: Set by libavcodec. for coded_picture (and set by user for input).
1014 * - decoding: Set by libavcodec.
1016 enum AVPictureType pict_type;
1019 * pointer to the first allocated byte of the picture. Can be used in get_buffer/release_buffer.
1020 * This isn't used by libavcodec unless the default get/release_buffer() is used.
1024 uint8_t *base[AV_NUM_DATA_POINTERS];
1027 * sample aspect ratio for the video frame, 0/1 if unknown/unspecified
1028 * - encoding: unused
1029 * - decoding: Read by user.
1031 AVRational sample_aspect_ratio;
1034 * presentation timestamp in time_base units (time when frame should be shown to user)
1035 * If AV_NOPTS_VALUE then frame_rate = 1/time_base will be assumed.
1036 * - encoding: MUST be set by user.
1037 * - decoding: Set by libavcodec.
1042 * reordered pts from the last AVPacket that has been input into the decoder
1043 * - encoding: unused
1044 * - decoding: Read by user.
1049 * dts from the last AVPacket that has been input into the decoder
1050 * - encoding: unused
1051 * - decoding: Read by user.
1056 * picture number in bitstream order
1057 * - encoding: set by
1058 * - decoding: Set by libavcodec.
1060 int coded_picture_number;
1062 * picture number in display order
1063 * - encoding: set by
1064 * - decoding: Set by libavcodec.
1066 int display_picture_number;
1069 * quality (between 1 (good) and FF_LAMBDA_MAX (bad))
1070 * - encoding: Set by libavcodec. for coded_picture (and set by user for input).
1071 * - decoding: Set by libavcodec.
1076 * is this picture used as reference
1077 * The values for this are the same as the MpegEncContext.picture_structure
1078 * variable, that is 1->top field, 2->bottom field, 3->frame/both fields.
1079 * Set to 4 for delayed, non-reference frames.
1080 * - encoding: unused
1081 * - decoding: Set by libavcodec. (before get_buffer() call)).
1087 * - encoding: unused
1088 * - decoding: Set by libavcodec.
1090 int8_t *qscale_table;
1093 * - encoding: unused
1094 * - decoding: Set by libavcodec.
1104 * mbskip_table[mb]>=1 if MB didn't change
1105 * stride= mb_width = (width+15)>>4
1106 * - encoding: unused
1107 * - decoding: Set by libavcodec.
1109 uint8_t *mbskip_table;
1112 * motion vector table
1115 * int mv_sample_log2= 4 - motion_subsample_log2;
1116 * int mb_width= (width+15)>>4;
1117 * int mv_stride= (mb_width << mv_sample_log2) + 1;
1118 * motion_val[direction][x + y*mv_stride][0->mv_x, 1->mv_y];
1120 * - encoding: Set by user.
1121 * - decoding: Set by libavcodec.
1123 int16_t (*motion_val[2])[2];
1126 * macroblock type table
1127 * mb_type_base + mb_width + 2
1128 * - encoding: Set by user.
1129 * - decoding: Set by libavcodec.
1135 * - encoding: unused
1136 * - decoding: Set by libavcodec.
1141 * motion reference frame index
1142 * the order in which these are stored can depend on the codec.
1143 * - encoding: Set by user.
1144 * - decoding: Set by libavcodec.
1146 int8_t *ref_index[2];
1149 * for some private data of the user
1150 * - encoding: unused
1151 * - decoding: Set by user.
1157 * - encoding: Set by libavcodec. if flags&CODEC_FLAG_PSNR.
1158 * - decoding: unused
1160 uint64_t error[AV_NUM_DATA_POINTERS];
1163 * type of the buffer (to keep track of who has to deallocate data[*])
1164 * - encoding: Set by the one who allocates it.
1165 * - decoding: Set by the one who allocates it.
1166 * Note: User allocated (direct rendering) & internal buffers cannot coexist currently.
1171 * When decoding, this signals how much the picture must be delayed.
1172 * extra_delay = repeat_pict / (2*fps)
1173 * - encoding: unused
1174 * - decoding: Set by libavcodec.
1179 * The content of the picture is interlaced.
1180 * - encoding: Set by user.
1181 * - decoding: Set by libavcodec. (default 0)
1183 int interlaced_frame;
1186 * If the content is interlaced, is top field displayed first.
1187 * - encoding: Set by user.
1188 * - decoding: Set by libavcodec.
1190 int top_field_first;
1193 * Tell user application that palette has changed from previous frame.
1194 * - encoding: ??? (no palette-enabled encoder yet)
1195 * - decoding: Set by libavcodec. (default 0).
1197 int palette_has_changed;
1200 * codec suggestion on buffer type if != 0
1201 * - encoding: unused
1202 * - decoding: Set by libavcodec. (before get_buffer() call)).
1208 * - encoding: Set by user.
1209 * - decoding: Set by libavcodec.
1211 AVPanScan *pan_scan;
1214 * reordered opaque 64bit (generally an integer or a double precision float
1215 * PTS but can be anything).
1216 * The user sets AVCodecContext.reordered_opaque to represent the input at
1218 * the decoder reorders values as needed and sets AVFrame.reordered_opaque
1219 * to exactly one of the values provided by the user through AVCodecContext.reordered_opaque
1220 * @deprecated in favor of pkt_pts
1221 * - encoding: unused
1222 * - decoding: Read by user.
1224 int64_t reordered_opaque;
1227 * hardware accelerator private data (FFmpeg-allocated)
1228 * - encoding: unused
1229 * - decoding: Set by libavcodec
1231 void *hwaccel_picture_private;
1234 * the AVCodecContext which ff_thread_get_buffer() was last called on
1235 * - encoding: Set by libavcodec.
1236 * - decoding: Set by libavcodec.
1238 struct AVCodecContext *owner;
1241 * used by multithreading to store frame-specific info
1242 * - encoding: Set by libavcodec.
1243 * - decoding: Set by libavcodec.
1245 void *thread_opaque;
1248 * log2 of the size of the block which a single vector in motion_val represents:
1249 * (4->16x16, 3->8x8, 2-> 4x4, 1-> 2x2)
1250 * - encoding: unused
1251 * - decoding: Set by libavcodec.
1253 uint8_t motion_subsample_log2;
1256 * Sample rate of the audio data.
1258 * - encoding: unused
1259 * - decoding: read by user
1264 * Channel layout of the audio data.
1266 * - encoding: unused
1267 * - decoding: read by user.
1269 uint64_t channel_layout;
1272 * frame timestamp estimated using various heuristics, in stream time base
1273 * Code outside libavcodec should access this field using:
1274 * av_frame_get_best_effort_timestamp(frame)
1275 * - encoding: unused
1276 * - decoding: set by libavcodec, read by user.
1278 int64_t best_effort_timestamp;
1281 * reordered pos from the last AVPacket that has been input into the decoder
1282 * Code outside libavcodec should access this field using:
1283 * av_frame_get_pkt_pos(frame)
1284 * - encoding: unused
1285 * - decoding: Read by user.
1290 * duration of the corresponding packet, expressed in
1291 * AVStream->time_base units, 0 if unknown.
1292 * Code outside libavcodec should access this field using:
1293 * av_frame_get_pkt_duration(frame)
1294 * - encoding: unused
1295 * - decoding: Read by user.
1297 int64_t pkt_duration;
1301 * Accessors for some AVFrame fields.
1302 * The position of these field in the structure is not part of the ABI,
1303 * they should not be accessed directly outside libavcodec.
1305 int64_t av_frame_get_best_effort_timestamp(const AVFrame *frame);
1306 int64_t av_frame_get_pkt_duration (const AVFrame *frame);
1307 int64_t av_frame_get_pkt_pos (const AVFrame *frame);
1308 int64_t av_frame_get_channel_layout (const AVFrame *frame);
1309 int av_frame_get_sample_rate (const AVFrame *frame);
1310 void av_frame_set_best_effort_timestamp(AVFrame *frame, int64_t val);
1311 void av_frame_set_pkt_duration (AVFrame *frame, int64_t val);
1312 void av_frame_set_pkt_pos (AVFrame *frame, int64_t val);
1313 void av_frame_set_channel_layout (AVFrame *frame, int64_t val);
1314 void av_frame_set_sample_rate (AVFrame *frame, int val);
1316 struct AVCodecInternal;
1320 AV_FIELD_PROGRESSIVE,
1321 AV_FIELD_TT, //< Top coded_first, top displayed first
1322 AV_FIELD_BB, //< Bottom coded first, bottom displayed first
1323 AV_FIELD_TB, //< Top coded first, bottom displayed first
1324 AV_FIELD_BT, //< Bottom coded first, top displayed first
1328 * main external API structure.
1329 * New fields can be added to the end with minor version bumps.
1330 * Removal, reordering and changes to existing fields require a major
1332 * Please use AVOptions (av_opt* / av_set/get*()) to access these fields from user
1334 * sizeof(AVCodecContext) must not be used outside libav*.
1336 typedef struct AVCodecContext {
1338 * information on struct for av_log
1339 * - set by avcodec_alloc_context3
1341 const AVClass *av_class;
1342 int log_level_offset;
1344 enum AVMediaType codec_type; /* see AVMEDIA_TYPE_xxx */
1345 struct AVCodec *codec;
1346 char codec_name[32];
1347 enum CodecID codec_id; /* see CODEC_ID_xxx */
1350 * fourcc (LSB first, so "ABCD" -> ('D'<<24) + ('C'<<16) + ('B'<<8) + 'A').
1351 * This is used to work around some encoder bugs.
1352 * A demuxer should set this to what is stored in the field used to identify the codec.
1353 * If there are multiple such fields in a container then the demuxer should choose the one
1354 * which maximizes the information about the used codec.
1355 * If the codec tag field in a container is larger than 32 bits then the demuxer should
1356 * remap the longer ID to 32 bits with a table or other structure. Alternatively a new
1357 * extra_codec_tag + size could be added but for this a clear advantage must be demonstrated
1359 * - encoding: Set by user, if not then the default based on codec_id will be used.
1360 * - decoding: Set by user, will be converted to uppercase by libavcodec during init.
1362 unsigned int codec_tag;
1365 * fourcc from the AVI stream header (LSB first, so "ABCD" -> ('D'<<24) + ('C'<<16) + ('B'<<8) + 'A').
1366 * This is used to work around some encoder bugs.
1367 * - encoding: unused
1368 * - decoding: Set by user, will be converted to uppercase by libavcodec during init.
1370 unsigned int stream_codec_tag;
1374 * @deprecated this field is unused
1376 attribute_deprecated int sub_id;
1382 * Private context used for internal data.
1384 * Unlike priv_data, this is not codec-specific. It is used in general
1385 * libavcodec functions.
1387 struct AVCodecInternal *internal;
1390 * Private data of the user, can be used to carry app specific stuff.
1391 * - encoding: Set by user.
1392 * - decoding: Set by user.
1397 * the average bitrate
1398 * - encoding: Set by user; unused for constant quantizer encoding.
1399 * - decoding: Set by libavcodec. 0 or some bitrate if this info is available in the stream.
1404 * number of bits the bitstream is allowed to diverge from the reference.
1405 * the reference can be CBR (for CBR pass1) or VBR (for pass2)
1406 * - encoding: Set by user; unused for constant quantizer encoding.
1407 * - decoding: unused
1409 int bit_rate_tolerance;
1412 * Global quality for codecs which cannot change it per frame.
1413 * This should be proportional to MPEG-1/2/4 qscale.
1414 * - encoding: Set by user.
1415 * - decoding: unused
1420 * - encoding: Set by user.
1421 * - decoding: unused
1423 int compression_level;
1424 #define FF_COMPRESSION_DEFAULT -1
1428 * - encoding: Set by user.
1429 * - decoding: Set by user.
1435 * - encoding: Set by user.
1436 * - decoding: Set by user.
1441 * some codecs need / can use extradata like Huffman tables.
1442 * mjpeg: Huffman tables
1443 * rv10: additional flags
1444 * mpeg4: global headers (they can be in the bitstream or here)
1445 * The allocated memory should be FF_INPUT_BUFFER_PADDING_SIZE bytes larger
1446 * than extradata_size to avoid prolems if it is read with the bitstream reader.
1447 * The bytewise contents of extradata must not depend on the architecture or CPU endianness.
1448 * - encoding: Set/allocated/freed by libavcodec.
1449 * - decoding: Set/allocated/freed by user.
1455 * This is the fundamental unit of time (in seconds) in terms
1456 * of which frame timestamps are represented. For fixed-fps content,
1457 * timebase should be 1/framerate and timestamp increments should be
1459 * - encoding: MUST be set by user.
1460 * - decoding: Set by libavcodec.
1462 AVRational time_base;
1465 * For some codecs, the time base is closer to the field rate than the frame rate.
1466 * Most notably, H.264 and MPEG-2 specify time_base as half of frame duration
1467 * if no telecine is used ...
1469 * Set to time_base ticks per frame. Default 1, e.g., H.264/MPEG-2 set it to 2.
1471 int ticks_per_frame;
1474 * Encoding: Number of frames delay there will be from the encoder input to
1475 * the decoder output. (we assume the decoder matches the spec)
1476 * Decoding: Number of frames delay in addition to what a standard decoder
1477 * as specified in the spec would produce.
1480 * Number of frames the decoded output will be delayed relative to the
1484 * Number of "priming" samples added to the beginning of the stream
1485 * during encoding. The decoded output will be delayed by this many
1486 * samples relative to the input to the encoder. Note that this field is
1487 * purely informational and does not directly affect the pts output by
1488 * the encoder, which should always be based on the actual presentation
1489 * time, including any delay.
1491 * - encoding: Set by libavcodec.
1492 * - decoding: Set by libavcodec.
1499 * picture width / height.
1500 * - encoding: MUST be set by user.
1501 * - decoding: Set by libavcodec.
1502 * Note: For compatibility it is possible to set this instead of
1503 * coded_width/height before decoding.
1508 * Bitstream width / height, may be different from width/height if lowres enabled.
1509 * - encoding: unused
1510 * - decoding: Set by user before init if known. Codec should override / dynamically change if needed.
1512 int coded_width, coded_height;
1514 #define FF_ASPECT_EXTENDED 15
1517 * the number of pictures in a group of pictures, or 0 for intra_only
1518 * - encoding: Set by user.
1519 * - decoding: unused
1524 * Pixel format, see PIX_FMT_xxx.
1525 * May be set by the demuxer if known from headers.
1526 * May be overriden by the decoder if it knows better.
1527 * - encoding: Set by user.
1528 * - decoding: Set by user if known, overridden by libavcodec if known
1530 enum PixelFormat pix_fmt;
1533 * Motion estimation algorithm used for video coding.
1534 * 1 (zero), 2 (full), 3 (log), 4 (phods), 5 (epzs), 6 (x1), 7 (hex),
1535 * 8 (umh), 9 (iter), 10 (tesa) [7, 8, 10 are x264 specific, 9 is snow specific]
1536 * - encoding: MUST be set by user.
1537 * - decoding: unused
1542 * If non NULL, 'draw_horiz_band' is called by the libavcodec
1543 * decoder to draw a horizontal band. It improves cache usage. Not
1544 * all codecs can do that. You must check the codec capabilities
1546 * When multithreading is used, it may be called from multiple threads
1547 * at the same time; threads might draw different parts of the same AVFrame,
1548 * or multiple AVFrames, and there is no guarantee that slices will be drawn
1550 * The function is also used by hardware acceleration APIs.
1551 * It is called at least once during frame decoding to pass
1552 * the data needed for hardware render.
1553 * In that mode instead of pixel data, AVFrame points to
1554 * a structure specific to the acceleration API. The application
1555 * reads the structure and can change some fields to indicate progress
1557 * - encoding: unused
1558 * - decoding: Set by user.
1559 * @param height the height of the slice
1560 * @param y the y position of the slice
1561 * @param type 1->top field, 2->bottom field, 3->frame
1562 * @param offset offset into the AVFrame.data from which the slice should be read
1564 void (*draw_horiz_band)(struct AVCodecContext *s,
1565 const AVFrame *src, int offset[AV_NUM_DATA_POINTERS],
1566 int y, int type, int height);
1569 * callback to negotiate the pixelFormat
1570 * @param fmt is the list of formats which are supported by the codec,
1571 * it is terminated by -1 as 0 is a valid format, the formats are ordered by quality.
1572 * The first is always the native one.
1573 * @return the chosen format
1574 * - encoding: unused
1575 * - decoding: Set by user, if not set the native format will be chosen.
1577 enum PixelFormat (*get_format)(struct AVCodecContext *s, const enum PixelFormat * fmt);
1580 * maximum number of B-frames between non-B-frames
1581 * Note: The output will be delayed by max_b_frames+1 relative to the input.
1582 * - encoding: Set by user.
1583 * - decoding: unused
1588 * qscale factor between IP and B-frames
1589 * If > 0 then the last P-frame quantizer will be used (q= lastp_q*factor+offset).
1590 * If < 0 then normal ratecontrol will be done (q= -normal_q*factor+offset).
1591 * - encoding: Set by user.
1592 * - decoding: unused
1594 float b_quant_factor;
1596 /** obsolete FIXME remove */
1598 #define FF_RC_STRATEGY_XVID 1
1600 int b_frame_strategy;
1602 #if FF_API_MPV_GLOBAL_OPTS
1604 * luma single coefficient elimination threshold
1605 * - encoding: Set by user.
1606 * - decoding: unused
1608 attribute_deprecated int luma_elim_threshold;
1611 * chroma single coeff elimination threshold
1612 * - encoding: Set by user.
1613 * - decoding: unused
1615 attribute_deprecated int chroma_elim_threshold;
1619 * qscale offset between IP and B-frames
1620 * - encoding: Set by user.
1621 * - decoding: unused
1623 float b_quant_offset;
1626 * Size of the frame reordering buffer in the decoder.
1627 * For MPEG-2 it is 1 IPB or 0 low delay IP.
1628 * - encoding: Set by libavcodec.
1629 * - decoding: Set by libavcodec.
1634 * 0-> h263 quant 1-> mpeg quant
1635 * - encoding: Set by user.
1636 * - decoding: unused
1641 * qscale factor between P and I-frames
1642 * If > 0 then the last p frame quantizer will be used (q= lastp_q*factor+offset).
1643 * If < 0 then normal ratecontrol will be done (q= -normal_q*factor+offset).
1644 * - encoding: Set by user.
1645 * - decoding: unused
1647 float i_quant_factor;
1650 * qscale offset between P and I-frames
1651 * - encoding: Set by user.
1652 * - decoding: unused
1654 float i_quant_offset;
1657 * luminance masking (0-> disabled)
1658 * - encoding: Set by user.
1659 * - decoding: unused
1664 * temporary complexity masking (0-> disabled)
1665 * - encoding: Set by user.
1666 * - decoding: unused
1668 float temporal_cplx_masking;
1671 * spatial complexity masking (0-> disabled)
1672 * - encoding: Set by user.
1673 * - decoding: unused
1675 float spatial_cplx_masking;
1678 * p block masking (0-> disabled)
1679 * - encoding: Set by user.
1680 * - decoding: unused
1685 * darkness masking (0-> disabled)
1686 * - encoding: Set by user.
1687 * - decoding: unused
1693 * - encoding: Set by libavcodec.
1694 * - decoding: Set by user (or 0).
1698 * prediction method (needed for huffyuv)
1699 * - encoding: Set by user.
1700 * - decoding: unused
1702 int prediction_method;
1703 #define FF_PRED_LEFT 0
1704 #define FF_PRED_PLANE 1
1705 #define FF_PRED_MEDIAN 2
1708 * slice offsets in the frame in bytes
1709 * - encoding: Set/allocated by libavcodec.
1710 * - decoding: Set/allocated by user (or NULL).
1715 * sample aspect ratio (0 if unknown)
1716 * That is the width of a pixel divided by the height of the pixel.
1717 * Numerator and denominator must be relatively prime and smaller than 256 for some video standards.
1718 * - encoding: Set by user.
1719 * - decoding: Set by libavcodec.
1721 AVRational sample_aspect_ratio;
1724 * motion estimation comparison function
1725 * - encoding: Set by user.
1726 * - decoding: unused
1730 * subpixel motion estimation comparison function
1731 * - encoding: Set by user.
1732 * - decoding: unused
1736 * macroblock comparison function (not supported yet)
1737 * - encoding: Set by user.
1738 * - decoding: unused
1742 * interlaced DCT comparison function
1743 * - encoding: Set by user.
1744 * - decoding: unused
1747 #define FF_CMP_SAD 0
1748 #define FF_CMP_SSE 1
1749 #define FF_CMP_SATD 2
1750 #define FF_CMP_DCT 3
1751 #define FF_CMP_PSNR 4
1752 #define FF_CMP_BIT 5
1754 #define FF_CMP_ZERO 7
1755 #define FF_CMP_VSAD 8
1756 #define FF_CMP_VSSE 9
1757 #define FF_CMP_NSSE 10
1758 #define FF_CMP_W53 11
1759 #define FF_CMP_W97 12
1760 #define FF_CMP_DCTMAX 13
1761 #define FF_CMP_DCT264 14
1762 #define FF_CMP_CHROMA 256
1765 * ME diamond size & shape
1766 * - encoding: Set by user.
1767 * - decoding: unused
1772 * amount of previous MV predictors (2a+1 x 2a+1 square)
1773 * - encoding: Set by user.
1774 * - decoding: unused
1776 int last_predictor_count;
1779 * prepass for motion estimation
1780 * - encoding: Set by user.
1781 * - decoding: unused
1786 * motion estimation prepass comparison function
1787 * - encoding: Set by user.
1788 * - decoding: unused
1793 * ME prepass diamond size & shape
1794 * - encoding: Set by user.
1795 * - decoding: unused
1801 * - encoding: Set by user.
1802 * - decoding: unused
1804 int me_subpel_quality;
1807 * DTG active format information (additional aspect ratio
1808 * information only used in DVB MPEG-2 transport streams)
1811 * - encoding: unused
1812 * - decoding: Set by decoder.
1814 int dtg_active_format;
1815 #define FF_DTG_AFD_SAME 8
1816 #define FF_DTG_AFD_4_3 9
1817 #define FF_DTG_AFD_16_9 10
1818 #define FF_DTG_AFD_14_9 11
1819 #define FF_DTG_AFD_4_3_SP_14_9 13
1820 #define FF_DTG_AFD_16_9_SP_14_9 14
1821 #define FF_DTG_AFD_SP_4_3 15
1824 * maximum motion estimation search range in subpel units
1825 * If 0 then no limit.
1827 * - encoding: Set by user.
1828 * - decoding: unused
1833 * intra quantizer bias
1834 * - encoding: Set by user.
1835 * - decoding: unused
1837 int intra_quant_bias;
1838 #define FF_DEFAULT_QUANT_BIAS 999999
1841 * inter quantizer bias
1842 * - encoding: Set by user.
1843 * - decoding: unused
1845 int inter_quant_bias;
1847 #if FF_API_COLOR_TABLE_ID
1850 * - encoding: unused
1851 * - decoding: Which clrtable should be used for 8bit RGB images.
1852 * Tables have to be stored somewhere. FIXME
1854 attribute_deprecated int color_table_id;
1859 * - encoding: unused
1860 * - decoding: Set by user.
1863 #define SLICE_FLAG_CODED_ORDER 0x0001 ///< draw_horiz_band() is called in coded order instead of display
1864 #define SLICE_FLAG_ALLOW_FIELD 0x0002 ///< allow draw_horiz_band() with field slices (MPEG2 field pics)
1865 #define SLICE_FLAG_ALLOW_PLANE 0x0004 ///< allow draw_horiz_band() with 1 component at a time (SVQ1)
1868 * XVideo Motion Acceleration
1869 * - encoding: forbidden
1870 * - decoding: set by decoder
1872 int xvmc_acceleration;
1875 * macroblock decision mode
1876 * - encoding: Set by user.
1877 * - decoding: unused
1880 #define FF_MB_DECISION_SIMPLE 0 ///< uses mb_cmp
1881 #define FF_MB_DECISION_BITS 1 ///< chooses the one which needs the fewest bits
1882 #define FF_MB_DECISION_RD 2 ///< rate distortion
1885 * custom intra quantization matrix
1886 * - encoding: Set by user, can be NULL.
1887 * - decoding: Set by libavcodec.
1889 uint16_t *intra_matrix;
1892 * custom inter quantization matrix
1893 * - encoding: Set by user, can be NULL.
1894 * - decoding: Set by libavcodec.
1896 uint16_t *inter_matrix;
1899 * scene change detection threshold
1900 * 0 is default, larger means fewer detected scene changes.
1901 * - encoding: Set by user.
1902 * - decoding: unused
1904 int scenechange_threshold;
1907 * noise reduction strength
1908 * - encoding: Set by user.
1909 * - decoding: unused
1911 int noise_reduction;
1913 #if FF_API_INTER_THRESHOLD
1915 * @deprecated this field is unused
1917 attribute_deprecated int inter_threshold;
1920 #if FF_API_MPV_GLOBAL_OPTS
1922 * @deprecated use mpegvideo private options instead
1924 attribute_deprecated int quantizer_noise_shaping;
1928 * Motion estimation threshold below which no motion estimation is
1929 * performed, but instead the user specified motion vectors are used.
1931 * - encoding: Set by user.
1932 * - decoding: unused
1937 * Macroblock threshold below which the user specified macroblock types will be used.
1938 * - encoding: Set by user.
1939 * - decoding: unused
1944 * precision of the intra DC coefficient - 8
1945 * - encoding: Set by user.
1946 * - decoding: unused
1948 int intra_dc_precision;
1951 * Number of macroblock rows at the top which are skipped.
1952 * - encoding: unused
1953 * - decoding: Set by user.
1958 * Number of macroblock rows at the bottom which are skipped.
1959 * - encoding: unused
1960 * - decoding: Set by user.
1965 * Border processing masking, raises the quantizer for mbs on the borders
1967 * - encoding: Set by user.
1968 * - decoding: unused
1970 float border_masking;
1973 * minimum MB lagrange multipler
1974 * - encoding: Set by user.
1975 * - decoding: unused
1980 * maximum MB lagrange multipler
1981 * - encoding: Set by user.
1982 * - decoding: unused
1988 * - encoding: Set by user.
1989 * - decoding: unused
1991 int me_penalty_compensation;
1995 * - encoding: Set by user.
1996 * - decoding: unused
2002 * - encoding: Set by user.
2003 * - decoding: unused
2009 * - encoding: Set by user.
2010 * - decoding: unused
2015 * number of reference frames
2016 * - encoding: Set by user.
2017 * - decoding: Set by lavc.
2022 * chroma qp offset from luma
2023 * - encoding: Set by user.
2024 * - decoding: unused
2029 * Multiplied by qscale for each frame and added to scene_change_score.
2030 * - encoding: Set by user.
2031 * - decoding: unused
2033 int scenechange_factor;
2037 * Note: Value depends upon the compare function used for fullpel ME.
2038 * - encoding: Set by user.
2039 * - decoding: unused
2044 * Adjust sensitivity of b_frame_strategy 1.
2045 * - encoding: Set by user.
2046 * - decoding: unused
2051 * Chromaticity coordinates of the source primaries.
2052 * - encoding: Set by user
2053 * - decoding: Set by libavcodec
2055 enum AVColorPrimaries color_primaries;
2058 * Color Transfer Characteristic.
2059 * - encoding: Set by user
2060 * - decoding: Set by libavcodec
2062 enum AVColorTransferCharacteristic color_trc;
2065 * YUV colorspace type.
2066 * - encoding: Set by user
2067 * - decoding: Set by libavcodec
2069 enum AVColorSpace colorspace;
2072 * MPEG vs JPEG YUV range.
2073 * - encoding: Set by user
2074 * - decoding: Set by libavcodec
2076 enum AVColorRange color_range;
2079 * This defines the location of chroma samples.
2080 * - encoding: Set by user
2081 * - decoding: Set by libavcodec
2083 enum AVChromaLocation chroma_sample_location;
2087 * Indicates number of picture subdivisions. Used for parallelized
2089 * - encoding: Set by user
2090 * - decoding: unused
2095 * - encoding: set by libavcodec
2096 * - decoding: Set by libavcodec
2098 enum AVFieldOrder field_order;
2101 int sample_rate; ///< samples per second
2102 int channels; ///< number of audio channels
2105 * audio sample format
2106 * - encoding: Set by user.
2107 * - decoding: Set by libavcodec.
2109 enum AVSampleFormat sample_fmt; ///< sample format
2111 /* The following data should not be initialized. */
2113 * Samples per packet, initialized when calling 'init'.
2118 * Frame counter, set by libavcodec.
2120 * - decoding: total number of frames returned from the decoder so far.
2121 * - encoding: total number of frames passed to the encoder so far.
2123 * @note the counter is not incremented if encoding/decoding resulted in
2129 * number of bytes per packet if constant and known or 0
2130 * Used by some WAV based audio codecs.
2135 * Audio cutoff bandwidth (0 means "automatic")
2136 * - encoding: Set by user.
2137 * - decoding: unused
2141 #if FF_API_REQUEST_CHANNELS
2143 * Decoder should decode to this many channels if it can (0 for default)
2144 * - encoding: unused
2145 * - decoding: Set by user.
2146 * @deprecated Deprecated in favor of request_channel_layout.
2148 int request_channels;
2152 * Audio channel layout.
2153 * - encoding: set by user.
2154 * - decoding: set by user, may be overwritten by libavcodec.
2156 uint64_t channel_layout;
2159 * Request decoder to use this channel layout if it can (0 for default)
2160 * - encoding: unused
2161 * - decoding: Set by user.
2163 uint64_t request_channel_layout;
2166 * Type of service that the audio stream conveys.
2167 * - encoding: Set by user.
2168 * - decoding: Set by libavcodec.
2170 enum AVAudioServiceType audio_service_type;
2173 * desired sample format
2174 * - encoding: Not used.
2175 * - decoding: Set by user.
2176 * Decoder will decode to this format if it can.
2178 enum AVSampleFormat request_sample_fmt;
2181 * Called at the beginning of each frame to get a buffer for it.
2183 * The function will set AVFrame.data[], AVFrame.linesize[].
2184 * AVFrame.extended_data[] must also be set, but it should be the same as
2185 * AVFrame.data[] except for planar audio with more channels than can fit
2186 * in AVFrame.data[]. In that case, AVFrame.data[] shall still contain as
2187 * many data pointers as it can hold.
2189 * if CODEC_CAP_DR1 is not set then get_buffer() must call
2190 * avcodec_default_get_buffer() instead of providing buffers allocated by
2193 * AVFrame.data[] should be 32- or 16-byte-aligned unless the CPU doesn't
2194 * need it. avcodec_default_get_buffer() aligns the output buffer properly,
2195 * but if get_buffer() is overridden then alignment considerations should
2196 * be taken into account.
2198 * @see avcodec_default_get_buffer()
2202 * If pic.reference is set then the frame will be read later by libavcodec.
2203 * avcodec_align_dimensions2() should be used to find the required width and
2204 * height, as they normally need to be rounded up to the next multiple of 16.
2206 * If frame multithreading is used and thread_safe_callbacks is set,
2207 * it may be called from a different thread, but not from more than one at
2208 * once. Does not need to be reentrant.
2210 * @see release_buffer(), reget_buffer()
2211 * @see avcodec_align_dimensions2()
2215 * Decoders request a buffer of a particular size by setting
2216 * AVFrame.nb_samples prior to calling get_buffer(). The decoder may,
2217 * however, utilize only part of the buffer by setting AVFrame.nb_samples
2218 * to a smaller value in the output frame.
2220 * Decoders cannot use the buffer after returning from
2221 * avcodec_decode_audio4(), so they will not call release_buffer(), as it
2222 * is assumed to be released immediately upon return.
2224 * As a convenience, av_samples_get_buffer_size() and
2225 * av_samples_fill_arrays() in libavutil may be used by custom get_buffer()
2226 * functions to find the required data size and to fill data pointers and
2227 * linesize. In AVFrame.linesize, only linesize[0] may be set for audio
2228 * since all planes must be the same size.
2230 * @see av_samples_get_buffer_size(), av_samples_fill_arrays()
2232 * - encoding: unused
2233 * - decoding: Set by libavcodec, user can override.
2235 int (*get_buffer)(struct AVCodecContext *c, AVFrame *pic);
2238 * Called to release buffers which were allocated with get_buffer.
2239 * A released buffer can be reused in get_buffer().
2240 * pic.data[*] must be set to NULL.
2241 * May be called from a different thread if frame multithreading is used,
2242 * but not by more than one thread at once, so does not need to be reentrant.
2243 * - encoding: unused
2244 * - decoding: Set by libavcodec, user can override.
2246 void (*release_buffer)(struct AVCodecContext *c, AVFrame *pic);
2249 * Called at the beginning of a frame to get cr buffer for it.
2250 * Buffer type (size, hints) must be the same. libavcodec won't check it.
2251 * libavcodec will pass previous buffer in pic, function should return
2252 * same buffer or new buffer with old frame "painted" into it.
2253 * If pic.data[0] == NULL must behave like get_buffer().
2254 * if CODEC_CAP_DR1 is not set then reget_buffer() must call
2255 * avcodec_default_reget_buffer() instead of providing buffers allocated by
2257 * - encoding: unused
2258 * - decoding: Set by libavcodec, user can override.
2260 int (*reget_buffer)(struct AVCodecContext *c, AVFrame *pic);
2263 /* - encoding parameters */
2264 float qcompress; ///< amount of qscale change between easy & hard scenes (0.0-1.0)
2265 float qblur; ///< amount of qscale smoothing over time (0.0-1.0)
2269 * - encoding: Set by user.
2270 * - decoding: unused
2276 * - encoding: Set by user.
2277 * - decoding: unused
2282 * maximum quantizer difference between frames
2283 * - encoding: Set by user.
2284 * - decoding: unused
2289 * ratecontrol qmin qmax limiting method
2290 * 0-> clipping, 1-> use a nice continous function to limit qscale wthin qmin/qmax.
2291 * - encoding: Set by user.
2292 * - decoding: unused
2300 * decoder bitstream buffer size
2301 * - encoding: Set by user.
2302 * - decoding: unused
2307 * ratecontrol override, see RcOverride
2308 * - encoding: Allocated/set/freed by user.
2309 * - decoding: unused
2311 int rc_override_count;
2312 RcOverride *rc_override;
2315 * rate control equation
2316 * - encoding: Set by user
2317 * - decoding: unused
2323 * - encoding: Set by user.
2324 * - decoding: unused
2330 * - encoding: Set by user.
2331 * - decoding: unused
2335 float rc_buffer_aggressivity;
2338 * initial complexity for pass1 ratecontrol
2339 * - encoding: Set by user.
2340 * - decoding: unused
2342 float rc_initial_cplx;
2345 * Ratecontrol attempt to use, at maximum, <value> of what can be used without an underflow.
2346 * - encoding: Set by user.
2347 * - decoding: unused.
2349 float rc_max_available_vbv_use;
2352 * Ratecontrol attempt to use, at least, <value> times the amount needed to prevent a vbv overflow.
2353 * - encoding: Set by user.
2354 * - decoding: unused.
2356 float rc_min_vbv_overflow_use;
2359 * Number of bits which should be loaded into the rc buffer before decoding starts.
2360 * - encoding: Set by user.
2361 * - decoding: unused
2363 int rc_initial_buffer_occupancy;
2365 #define FF_CODER_TYPE_VLC 0
2366 #define FF_CODER_TYPE_AC 1
2367 #define FF_CODER_TYPE_RAW 2
2368 #define FF_CODER_TYPE_RLE 3
2369 #define FF_CODER_TYPE_DEFLATE 4
2372 * - encoding: Set by user.
2373 * - decoding: unused
2379 * - encoding: Set by user.
2380 * - decoding: unused
2385 * minimum Lagrange multipler
2386 * - encoding: Set by user.
2387 * - decoding: unused
2392 * maximum Lagrange multipler
2393 * - encoding: Set by user.
2394 * - decoding: unused
2399 * frame skip threshold
2400 * - encoding: Set by user.
2401 * - decoding: unused
2403 int frame_skip_threshold;
2407 * - encoding: Set by user.
2408 * - decoding: unused
2410 int frame_skip_factor;
2413 * frame skip exponent
2414 * - encoding: Set by user.
2415 * - decoding: unused
2420 * frame skip comparison function
2421 * - encoding: Set by user.
2422 * - decoding: unused
2427 * trellis RD quantization
2428 * - encoding: Set by user.
2429 * - decoding: unused
2434 * - encoding: Set by user.
2435 * - decoding: unused
2437 int min_prediction_order;
2440 * - encoding: Set by user.
2441 * - decoding: unused
2443 int max_prediction_order;
2446 * GOP timecode frame start number
2447 * - encoding: Set by user, in non drop frame format
2448 * - decoding: Set by libavcodec (timecode in the 25 bits format, -1 if unset)
2450 int64_t timecode_frame_start;
2452 /* The RTP callback: This function is called */
2453 /* every time the encoder has a packet to send. */
2454 /* It depends on the encoder if the data starts */
2455 /* with a Start Code (it should). H.263 does. */
2456 /* mb_nb contains the number of macroblocks */
2457 /* encoded in the RTP payload. */
2458 void (*rtp_callback)(struct AVCodecContext *avctx, void *data, int size, int mb_nb);
2460 int rtp_payload_size; /* The size of the RTP payload: the coder will */
2461 /* do its best to deliver a chunk with size */
2462 /* below rtp_payload_size, the chunk will start */
2463 /* with a start code on some codecs like H.263. */
2464 /* This doesn't take account of any particular */
2465 /* headers inside the transmitted RTP payload. */
2467 /* statistics, used for 2-pass encoding */
2478 * number of bits used for the previously encoded frame
2479 * - encoding: Set by libavcodec.
2480 * - decoding: unused
2485 * pass1 encoding statistics output buffer
2486 * - encoding: Set by libavcodec.
2487 * - decoding: unused
2492 * pass2 encoding statistics input buffer
2493 * Concatenated stuff from stats_out of pass1 should be placed here.
2494 * - encoding: Allocated/set/freed by user.
2495 * - decoding: unused
2500 * Work around bugs in encoders which sometimes cannot be detected automatically.
2501 * - encoding: Set by user
2502 * - decoding: Set by user
2504 int workaround_bugs;
2505 #define FF_BUG_AUTODETECT 1 ///< autodetection
2506 #define FF_BUG_OLD_MSMPEG4 2
2507 #define FF_BUG_XVID_ILACE 4
2508 #define FF_BUG_UMP4 8
2509 #define FF_BUG_NO_PADDING 16
2510 #define FF_BUG_AMV 32
2511 #define FF_BUG_AC_VLC 0 ///< Will be removed, libavcodec can now handle these non-compliant files by default.
2512 #define FF_BUG_QPEL_CHROMA 64
2513 #define FF_BUG_STD_QPEL 128
2514 #define FF_BUG_QPEL_CHROMA2 256
2515 #define FF_BUG_DIRECT_BLOCKSIZE 512
2516 #define FF_BUG_EDGE 1024
2517 #define FF_BUG_HPEL_CHROMA 2048
2518 #define FF_BUG_DC_CLIP 4096
2519 #define FF_BUG_MS 8192 ///< Work around various bugs in Microsoft's broken decoders.
2520 #define FF_BUG_TRUNCATED 16384
2523 * strictly follow the standard (MPEG4, ...).
2524 * - encoding: Set by user.
2525 * - decoding: Set by user.
2526 * Setting this to STRICT or higher means the encoder and decoder will
2527 * generally do stupid things, whereas setting it to unofficial or lower
2528 * will mean the encoder might produce output that is not supported by all
2529 * spec-compliant decoders. Decoders don't differentiate between normal,
2530 * unofficial and experimental (that is, they always try to decode things
2531 * when they can) unless they are explicitly asked to behave stupidly
2532 * (=strictly conform to the specs)
2534 int strict_std_compliance;
2535 #define FF_COMPLIANCE_VERY_STRICT 2 ///< Strictly conform to an older more strict version of the spec or reference software.
2536 #define FF_COMPLIANCE_STRICT 1 ///< Strictly conform to all the things in the spec no matter what consequences.
2537 #define FF_COMPLIANCE_NORMAL 0
2538 #define FF_COMPLIANCE_UNOFFICIAL -1 ///< Allow unofficial extensions
2539 #define FF_COMPLIANCE_EXPERIMENTAL -2 ///< Allow nonstandardized experimental things.
2542 * error concealment flags
2543 * - encoding: unused
2544 * - decoding: Set by user.
2546 int error_concealment;
2547 #define FF_EC_GUESS_MVS 1
2548 #define FF_EC_DEBLOCK 2
2552 * - encoding: Set by user.
2553 * - decoding: Set by user.
2556 #define FF_DEBUG_PICT_INFO 1
2557 #define FF_DEBUG_RC 2
2558 #define FF_DEBUG_BITSTREAM 4
2559 #define FF_DEBUG_MB_TYPE 8
2560 #define FF_DEBUG_QP 16
2561 #define FF_DEBUG_MV 32
2562 #define FF_DEBUG_DCT_COEFF 0x00000040
2563 #define FF_DEBUG_SKIP 0x00000080
2564 #define FF_DEBUG_STARTCODE 0x00000100
2565 #define FF_DEBUG_PTS 0x00000200
2566 #define FF_DEBUG_ER 0x00000400
2567 #define FF_DEBUG_MMCO 0x00000800
2568 #define FF_DEBUG_BUGS 0x00001000
2569 #define FF_DEBUG_VIS_QP 0x00002000
2570 #define FF_DEBUG_VIS_MB_TYPE 0x00004000
2571 #define FF_DEBUG_BUFFERS 0x00008000
2572 #define FF_DEBUG_THREADS 0x00010000
2576 * - encoding: Set by user.
2577 * - decoding: Set by user.
2580 #define FF_DEBUG_VIS_MV_P_FOR 0x00000001 //visualize forward predicted MVs of P frames
2581 #define FF_DEBUG_VIS_MV_B_FOR 0x00000002 //visualize forward predicted MVs of B frames
2582 #define FF_DEBUG_VIS_MV_B_BACK 0x00000004 //visualize backward predicted MVs of B frames
2585 * Error recognition; may misdetect some more or less valid parts as errors.
2586 * - encoding: unused
2587 * - decoding: Set by user.
2589 int err_recognition;
2590 #define AV_EF_CRCCHECK (1<<0)
2591 #define AV_EF_BITSTREAM (1<<1)
2592 #define AV_EF_BUFFER (1<<2)
2593 #define AV_EF_EXPLODE (1<<3)
2595 #define AV_EF_CAREFUL (1<<16)
2596 #define AV_EF_COMPLIANT (1<<17)
2597 #define AV_EF_AGGRESSIVE (1<<18)
2601 * opaque 64bit number (generally a PTS) that will be reordered and
2602 * output in AVFrame.reordered_opaque
2603 * @deprecated in favor of pkt_pts
2604 * - encoding: unused
2605 * - decoding: Set by user.
2607 int64_t reordered_opaque;
2610 * Hardware accelerator in use
2611 * - encoding: unused.
2612 * - decoding: Set by libavcodec
2614 struct AVHWAccel *hwaccel;
2617 * Hardware accelerator context.
2618 * For some hardware accelerators, a global context needs to be
2619 * provided by the user. In that case, this holds display-dependent
2620 * data FFmpeg cannot instantiate itself. Please refer to the
2621 * FFmpeg HW accelerator documentation to know how to fill this
2622 * is. e.g. for VA API, this is a struct vaapi_context.
2623 * - encoding: unused
2624 * - decoding: Set by user
2626 void *hwaccel_context;
2630 * - encoding: Set by libavcodec if flags&CODEC_FLAG_PSNR.
2631 * - decoding: unused
2633 uint64_t error[AV_NUM_DATA_POINTERS];
2636 * DCT algorithm, see FF_DCT_* below
2637 * - encoding: Set by user.
2638 * - decoding: unused
2641 #define FF_DCT_AUTO 0
2642 #define FF_DCT_FASTINT 1
2643 #define FF_DCT_INT 2
2644 #define FF_DCT_MMX 3
2645 #define FF_DCT_ALTIVEC 5
2646 #define FF_DCT_FAAN 6
2649 * IDCT algorithm, see FF_IDCT_* below.
2650 * - encoding: Set by user.
2651 * - decoding: Set by user.
2654 #define FF_IDCT_AUTO 0
2655 #define FF_IDCT_INT 1
2656 #define FF_IDCT_SIMPLE 2
2657 #define FF_IDCT_SIMPLEMMX 3
2658 #define FF_IDCT_LIBMPEG2MMX 4
2659 #define FF_IDCT_MMI 5
2660 #define FF_IDCT_ARM 7
2661 #define FF_IDCT_ALTIVEC 8
2662 #define FF_IDCT_SH4 9
2663 #define FF_IDCT_SIMPLEARM 10
2664 #define FF_IDCT_H264 11
2665 #define FF_IDCT_VP3 12
2666 #define FF_IDCT_IPP 13
2667 #define FF_IDCT_XVIDMMX 14
2668 #define FF_IDCT_CAVS 15
2669 #define FF_IDCT_SIMPLEARMV5TE 16
2670 #define FF_IDCT_SIMPLEARMV6 17
2671 #define FF_IDCT_SIMPLEVIS 18
2672 #define FF_IDCT_WMV2 19
2673 #define FF_IDCT_FAAN 20
2674 #define FF_IDCT_EA 21
2675 #define FF_IDCT_SIMPLENEON 22
2676 #define FF_IDCT_SIMPLEALPHA 23
2677 #define FF_IDCT_BINK 24
2682 * @deprecated use av_set_cpu_flags_mask() instead.
2684 attribute_deprecated unsigned dsp_mask;
2688 * bits per sample/pixel from the demuxer (needed for huffyuv).
2689 * - encoding: Set by libavcodec.
2690 * - decoding: Set by user.
2692 int bits_per_coded_sample;
2695 * Bits per sample/pixel of internal libavcodec pixel/sample format.
2696 * - encoding: set by user.
2697 * - decoding: set by libavcodec.
2699 int bits_per_raw_sample;
2702 * low resolution decoding, 1-> 1/2 size, 2->1/4 size
2703 * - encoding: unused
2704 * - decoding: Set by user.
2709 * the picture in the bitstream
2710 * - encoding: Set by libavcodec.
2711 * - decoding: Set by libavcodec.
2713 AVFrame *coded_frame;
2717 * is used to decide how many independent tasks should be passed to execute()
2718 * - encoding: Set by user.
2719 * - decoding: Set by user.
2724 * Which multithreading methods to use.
2725 * Use of FF_THREAD_FRAME will increase decoding delay by one frame per thread,
2726 * so clients which cannot provide future frames should not use it.
2728 * - encoding: Set by user, otherwise the default is used.
2729 * - decoding: Set by user, otherwise the default is used.
2732 #define FF_THREAD_FRAME 1 ///< Decode more than one frame at once
2733 #define FF_THREAD_SLICE 2 ///< Decode more than one part of a single frame at once
2736 * Which multithreading methods are in use by the codec.
2737 * - encoding: Set by libavcodec.
2738 * - decoding: Set by libavcodec.
2740 int active_thread_type;
2743 * Set by the client if its custom get_buffer() callback can be called
2744 * synchronously from another thread, which allows faster multithreaded decoding.
2745 * draw_horiz_band() will be called from other threads regardless of this setting.
2746 * Ignored if the default get_buffer() is used.
2747 * - encoding: Set by user.
2748 * - decoding: Set by user.
2750 int thread_safe_callbacks;
2753 * The codec may call this to execute several independent things.
2754 * It will return only after finishing all tasks.
2755 * The user may replace this with some multithreaded implementation,
2756 * the default implementation will execute the parts serially.
2757 * @param count the number of things to execute
2758 * - encoding: Set by libavcodec, user can override.
2759 * - decoding: Set by libavcodec, user can override.
2761 int (*execute)(struct AVCodecContext *c, int (*func)(struct AVCodecContext *c2, void *arg), void *arg2, int *ret, int count, int size);
2764 * The codec may call this to execute several independent things.
2765 * It will return only after finishing all tasks.
2766 * The user may replace this with some multithreaded implementation,
2767 * the default implementation will execute the parts serially.
2768 * Also see avcodec_thread_init and e.g. the --enable-pthread configure option.
2769 * @param c context passed also to func
2770 * @param count the number of things to execute
2771 * @param arg2 argument passed unchanged to func
2772 * @param ret return values of executed functions, must have space for "count" values. May be NULL.
2773 * @param func function that will be called count times, with jobnr from 0 to count-1.
2774 * threadnr will be in the range 0 to c->thread_count-1 < MAX_THREADS and so that no
2775 * two instances of func executing at the same time will have the same threadnr.
2776 * @return always 0 currently, but code should handle a future improvement where when any call to func
2777 * returns < 0 no further calls to func may be done and < 0 is returned.
2778 * - encoding: Set by libavcodec, user can override.
2779 * - decoding: Set by libavcodec, user can override.
2781 int (*execute2)(struct AVCodecContext *c, int (*func)(struct AVCodecContext *c2, void *arg, int jobnr, int threadnr), void *arg2, int *ret, int count);
2785 * Can be used by execute() to store some per AVCodecContext stuff.
2786 * - encoding: set by execute()
2787 * - decoding: set by execute()
2789 void *thread_opaque;
2792 * noise vs. sse weight for the nsse comparsion function
2793 * - encoding: Set by user.
2794 * - decoding: unused
2800 * - encoding: Set by user.
2801 * - decoding: Set by libavcodec.
2804 #define FF_PROFILE_UNKNOWN -99
2805 #define FF_PROFILE_RESERVED -100
2807 #define FF_PROFILE_AAC_MAIN 0
2808 #define FF_PROFILE_AAC_LOW 1
2809 #define FF_PROFILE_AAC_SSR 2
2810 #define FF_PROFILE_AAC_LTP 3
2812 #define FF_PROFILE_DTS 20
2813 #define FF_PROFILE_DTS_ES 30
2814 #define FF_PROFILE_DTS_96_24 40
2815 #define FF_PROFILE_DTS_HD_HRA 50
2816 #define FF_PROFILE_DTS_HD_MA 60
2818 #define FF_PROFILE_MPEG2_422 0
2819 #define FF_PROFILE_MPEG2_HIGH 1
2820 #define FF_PROFILE_MPEG2_SS 2
2821 #define FF_PROFILE_MPEG2_SNR_SCALABLE 3
2822 #define FF_PROFILE_MPEG2_MAIN 4
2823 #define FF_PROFILE_MPEG2_SIMPLE 5
2825 #define FF_PROFILE_H264_CONSTRAINED (1<<9) // 8+1; constraint_set1_flag
2826 #define FF_PROFILE_H264_INTRA (1<<11) // 8+3; constraint_set3_flag
2828 #define FF_PROFILE_H264_BASELINE 66
2829 #define FF_PROFILE_H264_CONSTRAINED_BASELINE (66|FF_PROFILE_H264_CONSTRAINED)
2830 #define FF_PROFILE_H264_MAIN 77
2831 #define FF_PROFILE_H264_EXTENDED 88
2832 #define FF_PROFILE_H264_HIGH 100
2833 #define FF_PROFILE_H264_HIGH_10 110
2834 #define FF_PROFILE_H264_HIGH_10_INTRA (110|FF_PROFILE_H264_INTRA)
2835 #define FF_PROFILE_H264_HIGH_422 122
2836 #define FF_PROFILE_H264_HIGH_422_INTRA (122|FF_PROFILE_H264_INTRA)
2837 #define FF_PROFILE_H264_HIGH_444 144
2838 #define FF_PROFILE_H264_HIGH_444_PREDICTIVE 244
2839 #define FF_PROFILE_H264_HIGH_444_INTRA (244|FF_PROFILE_H264_INTRA)
2840 #define FF_PROFILE_H264_CAVLC_444 44
2842 #define FF_PROFILE_VC1_SIMPLE 0
2843 #define FF_PROFILE_VC1_MAIN 1
2844 #define FF_PROFILE_VC1_COMPLEX 2
2845 #define FF_PROFILE_VC1_ADVANCED 3
2847 #define FF_PROFILE_MPEG4_SIMPLE 0
2848 #define FF_PROFILE_MPEG4_SIMPLE_SCALABLE 1
2849 #define FF_PROFILE_MPEG4_CORE 2
2850 #define FF_PROFILE_MPEG4_MAIN 3
2851 #define FF_PROFILE_MPEG4_N_BIT 4
2852 #define FF_PROFILE_MPEG4_SCALABLE_TEXTURE 5
2853 #define FF_PROFILE_MPEG4_SIMPLE_FACE_ANIMATION 6
2854 #define FF_PROFILE_MPEG4_BASIC_ANIMATED_TEXTURE 7
2855 #define FF_PROFILE_MPEG4_HYBRID 8
2856 #define FF_PROFILE_MPEG4_ADVANCED_REAL_TIME 9
2857 #define FF_PROFILE_MPEG4_CORE_SCALABLE 10
2858 #define FF_PROFILE_MPEG4_ADVANCED_CODING 11
2859 #define FF_PROFILE_MPEG4_ADVANCED_CORE 12
2860 #define FF_PROFILE_MPEG4_ADVANCED_SCALABLE_TEXTURE 13
2861 #define FF_PROFILE_MPEG4_SIMPLE_STUDIO 14
2862 #define FF_PROFILE_MPEG4_ADVANCED_SIMPLE 15
2866 * - encoding: Set by user.
2867 * - decoding: Set by libavcodec.
2870 #define FF_LEVEL_UNKNOWN -99
2874 * - encoding: unused
2875 * - decoding: Set by user.
2877 enum AVDiscard skip_loop_filter;
2881 * - encoding: unused
2882 * - decoding: Set by user.
2884 enum AVDiscard skip_idct;
2888 * - encoding: unused
2889 * - decoding: Set by user.
2891 enum AVDiscard skip_frame;
2894 * Header containing style information for text subtitles.
2895 * For SUBTITLE_ASS subtitle type, it should contain the whole ASS
2896 * [Script Info] and [V4+ Styles] section, plus the [Events] line and
2897 * the Format line following. It shouldn't include any Dialogue line.
2898 * - encoding: Set/allocated/freed by user (before avcodec_open2())
2899 * - decoding: Set/allocated/freed by libavcodec (by avcodec_open2())
2901 uint8_t *subtitle_header;
2902 int subtitle_header_size;
2905 * Simulates errors in the bitstream to test error concealment.
2906 * - encoding: Set by user.
2907 * - decoding: unused
2912 * Current packet as passed into the decoder, to avoid having
2913 * to pass the packet into every function. Currently only valid
2914 * inside lavc and get/release_buffer callbacks.
2915 * - decoding: set by avcodec_decode_*, read by get_buffer() for setting pkt_pts
2916 * - encoding: unused
2921 * VBV delay coded in the last frame (in periods of a 27 MHz clock).
2922 * Used for compliant TS muxing.
2923 * - encoding: Set by libavcodec.
2924 * - decoding: unused.
2929 * Current statistics for PTS correction.
2930 * - decoding: maintained and used by libavcodec, not intended to be used by user apps
2931 * - encoding: unused
2933 int64_t pts_correction_num_faulty_pts; /// Number of incorrect PTS values so far
2934 int64_t pts_correction_num_faulty_dts; /// Number of incorrect DTS values so far
2935 int64_t pts_correction_last_pts; /// PTS of the last frame
2936 int64_t pts_correction_last_dts; /// DTS of the last frame
2942 typedef struct AVProfile {
2944 const char *name; ///< short name for the profile
2947 typedef struct AVCodecDefault AVCodecDefault;
2952 typedef struct AVCodec {
2954 * Name of the codec implementation.
2955 * The name is globally unique among encoders and among decoders (but an
2956 * encoder and a decoder can share the same name).
2957 * This is the primary way to find a codec from the user perspective.
2961 * Descriptive name for the codec, meant to be more human readable than name.
2962 * You should use the NULL_IF_CONFIG_SMALL() macro to define it.
2964 const char *long_name;
2965 enum AVMediaType type;
2968 * Codec capabilities.
2972 const AVRational *supported_framerates; ///< array of supported framerates, or NULL if any, array is terminated by {0,0}
2973 const enum PixelFormat *pix_fmts; ///< array of supported pixel formats, or NULL if unknown, array is terminated by -1
2974 const int *supported_samplerates; ///< array of supported audio samplerates, or NULL if unknown, array is terminated by 0
2975 const enum AVSampleFormat *sample_fmts; ///< array of supported sample formats, or NULL if unknown, array is terminated by -1
2976 const uint64_t *channel_layouts; ///< array of support channel layouts, or NULL if unknown. array is terminated by 0
2977 uint8_t max_lowres; ///< maximum value for lowres supported by the decoder
2978 const AVClass *priv_class; ///< AVClass for the private context
2979 const AVProfile *profiles; ///< array of recognized profiles, or NULL if unknown, array is terminated by {FF_PROFILE_UNKNOWN}
2981 /*****************************************************************
2982 * No fields below this line are part of the public API. They
2983 * may not be used outside of libavcodec and can be changed and
2985 * New public fields should be added right above.
2986 *****************************************************************
2989 struct AVCodec *next;
2991 * @name Frame-level threading support functions
2995 * If defined, called on thread contexts when they are created.
2996 * If the codec allocates writable tables in init(), re-allocate them here.
2997 * priv_data will be set to a copy of the original.
2999 int (*init_thread_copy)(AVCodecContext *);
3001 * Copy necessary context variables from a previous thread context to the current one.
3002 * If not defined, the next thread will start automatically; otherwise, the codec
3003 * must call ff_thread_finish_setup().
3005 * dst and src will (rarely) point to the same context, in which case memcpy should be skipped.
3007 int (*update_thread_context)(AVCodecContext *dst, const AVCodecContext *src);
3011 * Private codec-specific defaults.
3013 const AVCodecDefault *defaults;
3016 * Initialize codec static data, called from avcodec_register().
3018 void (*init_static_data)(struct AVCodec *codec);
3020 int (*init)(AVCodecContext *);
3021 int (*encode)(AVCodecContext *, uint8_t *buf, int buf_size, void *data);
3023 * Encode data to an AVPacket.
3025 * @param avctx codec context
3026 * @param avpkt output AVPacket (may contain a user-provided buffer)
3027 * @param[in] frame AVFrame containing the raw data to be encoded
3028 * @param[out] got_packet_ptr encoder sets to 0 or 1 to indicate that a
3029 * non-empty packet was returned in avpkt.
3030 * @return 0 on success, negative error code on failure
3032 int (*encode2)(AVCodecContext *avctx, AVPacket *avpkt, const AVFrame *frame,
3033 int *got_packet_ptr);
3034 int (*decode)(AVCodecContext *, void *outdata, int *outdata_size, AVPacket *avpkt);
3035 int (*close)(AVCodecContext *);
3038 * Will be called when seeking
3040 void (*flush)(AVCodecContext *);
3046 typedef struct AVHWAccel {
3048 * Name of the hardware accelerated codec.
3049 * The name is globally unique among encoders and among decoders (but an
3050 * encoder and a decoder can share the same name).
3055 * Type of codec implemented by the hardware accelerator.
3057 * See AVMEDIA_TYPE_xxx
3059 enum AVMediaType type;
3062 * Codec implemented by the hardware accelerator.
3069 * Supported pixel format.
3071 * Only hardware accelerated formats are supported here.
3073 enum PixelFormat pix_fmt;
3076 * Hardware accelerated codec capabilities.
3077 * see FF_HWACCEL_CODEC_CAP_*
3081 struct AVHWAccel *next;
3084 * Called at the beginning of each frame or field picture.
3086 * Meaningful frame information (codec specific) is guaranteed to
3087 * be parsed at this point. This function is mandatory.
3089 * Note that buf can be NULL along with buf_size set to 0.
3090 * Otherwise, this means the whole frame is available at this point.
3092 * @param avctx the codec context
3093 * @param buf the frame data buffer base
3094 * @param buf_size the size of the frame in bytes
3095 * @return zero if successful, a negative value otherwise
3097 int (*start_frame)(AVCodecContext *avctx, const uint8_t *buf, uint32_t buf_size);
3100 * Callback for each slice.
3102 * Meaningful slice information (codec specific) is guaranteed to
3103 * be parsed at this point. This function is mandatory.
3105 * @param avctx the codec context
3106 * @param buf the slice data buffer base
3107 * @param buf_size the size of the slice in bytes
3108 * @return zero if successful, a negative value otherwise
3110 int (*decode_slice)(AVCodecContext *avctx, const uint8_t *buf, uint32_t buf_size);
3113 * Called at the end of each frame or field picture.
3115 * The whole picture is parsed at this point and can now be sent
3116 * to the hardware accelerator. This function is mandatory.
3118 * @param avctx the codec context
3119 * @return zero if successful, a negative value otherwise
3121 int (*end_frame)(AVCodecContext *avctx);
3124 * Size of HW accelerator private data.
3126 * Private data is allocated with av_mallocz() before
3127 * AVCodecContext.get_buffer() and deallocated after
3128 * AVCodecContext.release_buffer().
3134 * @defgroup lavc_picture AVPicture
3136 * Functions for working with AVPicture
3141 * four components are given, that's all.
3142 * the last component is alpha
3144 typedef struct AVPicture {
3145 uint8_t *data[AV_NUM_DATA_POINTERS];
3146 int linesize[AV_NUM_DATA_POINTERS]; ///< number of bytes per line
3153 enum AVSubtitleType {
3156 SUBTITLE_BITMAP, ///< A bitmap, pict will be set
3159 * Plain text, the text field must be set by the decoder and is
3160 * authoritative. ass and pict fields may contain approximations.
3165 * Formatted text, the ass field must be set by the decoder and is
3166 * authoritative. pict and text fields may contain approximations.
3171 typedef struct AVSubtitleRect {
3172 int x; ///< top left corner of pict, undefined when pict is not set
3173 int y; ///< top left corner of pict, undefined when pict is not set
3174 int w; ///< width of pict, undefined when pict is not set
3175 int h; ///< height of pict, undefined when pict is not set
3176 int nb_colors; ///< number of colors in pict, undefined when pict is not set
3179 * data+linesize for the bitmap of this subtitle.
3180 * can be set for text/ass as well once they where rendered
3183 enum AVSubtitleType type;
3185 char *text; ///< 0 terminated plain UTF-8 text
3188 * 0 terminated ASS/SSA compatible event line.
3189 * The pressentation of this is unaffected by the other values in this
3195 * 1 indicates this subtitle is a forced subtitle.
3196 * A forced subtitle should be displayed even when subtitles are hidden.
3201 typedef struct AVSubtitle {
3202 uint16_t format; /* 0 = graphics */
3203 uint32_t start_display_time; /* relative to packet pts, in ms */
3204 uint32_t end_display_time; /* relative to packet pts, in ms */
3206 AVSubtitleRect **rects;
3207 int64_t pts; ///< Same as packet pts, in AV_TIME_BASE
3211 * If c is NULL, returns the first registered codec,
3212 * if c is non-NULL, returns the next registered codec after c,
3213 * or NULL if c is the last one.
3215 AVCodec *av_codec_next(AVCodec *c);
3218 * Return the LIBAVCODEC_VERSION_INT constant.
3220 unsigned avcodec_version(void);
3223 * Return the libavcodec build-time configuration.
3225 const char *avcodec_configuration(void);
3228 * Return the libavcodec license.
3230 const char *avcodec_license(void);
3233 * Register the codec codec and initialize libavcodec.
3235 * @warning either this function or avcodec_register_all() must be called
3236 * before any other libavcodec functions.
3238 * @see avcodec_register_all()
3240 void avcodec_register(AVCodec *codec);
3243 * Register all the codecs, parsers and bitstream filters which were enabled at
3244 * configuration time. If you do not call this function you can select exactly
3245 * which formats you want to support, by using the individual registration
3248 * @see avcodec_register
3249 * @see av_register_codec_parser
3250 * @see av_register_bitstream_filter
3252 void avcodec_register_all(void);
3255 #if FF_API_ALLOC_CONTEXT
3257 * Allocate an AVCodecContext and set its fields to default values. The
3258 * resulting struct can be deallocated by simply calling av_free().
3260 * @return An AVCodecContext filled with default values or NULL on failure.
3261 * @see avcodec_get_context_defaults
3263 * @deprecated use avcodec_alloc_context3()
3265 attribute_deprecated
3266 AVCodecContext *avcodec_alloc_context(void);
3268 /** THIS FUNCTION IS NOT YET PART OF THE PUBLIC API!
3269 * we WILL change its arguments and name a few times! */
3270 attribute_deprecated
3271 AVCodecContext *avcodec_alloc_context2(enum AVMediaType);
3274 * Set the fields of the given AVCodecContext to default values.
3276 * @param s The AVCodecContext of which the fields should be set to default values.
3277 * @deprecated use avcodec_get_context_defaults3
3279 attribute_deprecated
3280 void avcodec_get_context_defaults(AVCodecContext *s);
3282 /** THIS FUNCTION IS NOT YET PART OF THE PUBLIC API!
3283 * we WILL change its arguments and name a few times! */
3284 attribute_deprecated
3285 void avcodec_get_context_defaults2(AVCodecContext *s, enum AVMediaType);
3289 * Allocate an AVCodecContext and set its fields to default values. The
3290 * resulting struct can be deallocated by calling avcodec_close() on it followed
3293 * @param codec if non-NULL, allocate private data and initialize defaults
3294 * for the given codec. It is illegal to then call avcodec_open2()
3295 * with a different codec.
3296 * If NULL, then the codec-specific defaults won't be initialized,
3297 * which may result in suboptimal default settings (this is
3298 * important mainly for encoders, e.g. libx264).
3300 * @return An AVCodecContext filled with default values or NULL on failure.
3301 * @see avcodec_get_context_defaults
3303 AVCodecContext *avcodec_alloc_context3(AVCodec *codec);
3306 * Set the fields of the given AVCodecContext to default values corresponding
3307 * to the given codec (defaults may be codec-dependent).
3309 * Do not call this function if a non-NULL codec has been passed
3310 * to avcodec_alloc_context3() that allocated this AVCodecContext.
3311 * If codec is non-NULL, it is illegal to call avcodec_open2() with a
3312 * different codec on this AVCodecContext.
3314 int avcodec_get_context_defaults3(AVCodecContext *s, AVCodec *codec);
3317 * Get the AVClass for AVCodecContext. It can be used in combination with
3318 * AV_OPT_SEARCH_FAKE_OBJ for examining options.
3320 * @see av_opt_find().
3322 const AVClass *avcodec_get_class(void);
3325 * Get the AVClass for AVFrame. It can be used in combination with
3326 * AV_OPT_SEARCH_FAKE_OBJ for examining options.
3328 * @see av_opt_find().
3330 const AVClass *avcodec_get_frame_class(void);
3333 * Get the AVClass for AVSubtitleRect. It can be used in combination with
3334 * AV_OPT_SEARCH_FAKE_OBJ for examining options.
3336 * @see av_opt_find().
3338 const AVClass *avcodec_get_subtitle_rect_class(void);
3341 * Copy the settings of the source AVCodecContext into the destination
3342 * AVCodecContext. The resulting destination codec context will be
3343 * unopened, i.e. you are required to call avcodec_open2() before you
3344 * can use this AVCodecContext to decode/encode video/audio data.
3346 * @param dest target codec context, should be initialized with
3347 * avcodec_alloc_context3(), but otherwise uninitialized
3348 * @param src source codec context
3349 * @return AVERROR() on error (e.g. memory allocation error), 0 on success
3351 int avcodec_copy_context(AVCodecContext *dest, const AVCodecContext *src);
3354 * Allocate an AVFrame and set its fields to default values. The resulting
3355 * struct can be deallocated by simply calling av_free().
3357 * @return An AVFrame filled with default values or NULL on failure.
3358 * @see avcodec_get_frame_defaults
3360 AVFrame *avcodec_alloc_frame(void);
3363 * Set the fields of the given AVFrame to default values.
3365 * @param pic The AVFrame of which the fields should be set to default values.
3367 void avcodec_get_frame_defaults(AVFrame *pic);
3369 #if FF_API_AVCODEC_OPEN
3371 * Initialize the AVCodecContext to use the given AVCodec. Prior to using this
3372 * function the context has to be allocated.
3374 * The functions avcodec_find_decoder_by_name(), avcodec_find_encoder_by_name(),
3375 * avcodec_find_decoder() and avcodec_find_encoder() provide an easy way for
3376 * retrieving a codec.
3378 * @warning This function is not thread safe!
3381 * avcodec_register_all();
3382 * codec = avcodec_find_decoder(CODEC_ID_H264);
3386 * context = avcodec_alloc_context3(codec);
3388 * if (avcodec_open(context, codec) < 0)
3392 * @param avctx The context which will be set up to use the given codec.
3393 * @param codec The codec to use within the context.
3394 * @return zero on success, a negative value on error
3395 * @see avcodec_alloc_context3, avcodec_find_decoder, avcodec_find_encoder, avcodec_close
3397 * @deprecated use avcodec_open2
3399 attribute_deprecated
3400 int avcodec_open(AVCodecContext *avctx, AVCodec *codec);
3404 * Initialize the AVCodecContext to use the given AVCodec. Prior to using this
3405 * function the context has to be allocated with avcodec_alloc_context3().
3407 * The functions avcodec_find_decoder_by_name(), avcodec_find_encoder_by_name(),
3408 * avcodec_find_decoder() and avcodec_find_encoder() provide an easy way for
3409 * retrieving a codec.
3411 * @warning This function is not thread safe!
3414 * avcodec_register_all();
3415 * av_dict_set(&opts, "b", "2.5M", 0);
3416 * codec = avcodec_find_decoder(CODEC_ID_H264);
3420 * context = avcodec_alloc_context3(codec);
3422 * if (avcodec_open2(context, codec, opts) < 0)
3426 * @param avctx The context to initialize.
3427 * @param codec The codec to open this context for. If a non-NULL codec has been
3428 * previously passed to avcodec_alloc_context3() or
3429 * avcodec_get_context_defaults3() for this context, then this
3430 * parameter MUST be either NULL or equal to the previously passed
3432 * @param options A dictionary filled with AVCodecContext and codec-private options.
3433 * On return this object will be filled with options that were not found.
3435 * @return zero on success, a negative value on error
3436 * @see avcodec_alloc_context3(), avcodec_find_decoder(), avcodec_find_encoder(),
3437 * av_dict_set(), av_opt_find().
3439 int avcodec_open2(AVCodecContext *avctx, AVCodec *codec, AVDictionary **options);
3442 * Close a given AVCodecContext and free all the data associated with it
3443 * (but not the AVCodecContext itself).
3445 * Calling this function on an AVCodecContext that hasn't been opened will free
3446 * the codec-specific data allocated in avcodec_alloc_context3() /
3447 * avcodec_get_context_defaults3() with a non-NULL codec. Subsequent calls will
3450 int avcodec_close(AVCodecContext *avctx);
3453 * Free all allocated data in the given subtitle struct.
3455 * @param sub AVSubtitle to free.
3457 void avsubtitle_free(AVSubtitle *sub);
3464 * @addtogroup lavc_packet
3469 * @deprecated use NULL instead
3471 attribute_deprecated void av_destruct_packet_nofree(AVPacket *pkt);
3474 * Default packet destructor.
3476 void av_destruct_packet(AVPacket *pkt);
3479 * Initialize optional fields of a packet with default values.
3481 * Note, this does not touch the data and size members, which have to be
3482 * initialized separately.
3486 void av_init_packet(AVPacket *pkt);
3489 * Allocate the payload of a packet and initialize its fields with
3493 * @param size wanted payload size
3494 * @return 0 if OK, AVERROR_xxx otherwise
3496 int av_new_packet(AVPacket *pkt, int size);
3499 * Reduce packet size, correctly zeroing padding
3502 * @param size new size
3504 void av_shrink_packet(AVPacket *pkt, int size);
3507 * Increase packet size, correctly zeroing padding
3510 * @param grow_by number of bytes by which to increase the size of the packet
3512 int av_grow_packet(AVPacket *pkt, int grow_by);
3515 * @warning This is a hack - the packet memory allocation stuff is broken. The
3516 * packet is allocated if it was not really allocated.
3518 int av_dup_packet(AVPacket *pkt);
3523 * @param pkt packet to free
3525 void av_free_packet(AVPacket *pkt);
3528 * Allocate new information of a packet.
3531 * @param type side information type
3532 * @param size side information size
3533 * @return pointer to fresh allocated data or NULL otherwise
3535 uint8_t* av_packet_new_side_data(AVPacket *pkt, enum AVPacketSideDataType type,
3539 * Shrink the already allocated side data buffer
3542 * @param type side information type
3543 * @param size new side information size
3544 * @return 0 on success, < 0 on failure
3546 int av_packet_shrink_side_data(AVPacket *pkt, enum AVPacketSideDataType type,
3550 * Get side information from packet.
3553 * @param type desired side information type
3554 * @param size pointer for side information size to store (optional)
3555 * @return pointer to data if present or NULL otherwise
3557 uint8_t* av_packet_get_side_data(AVPacket *pkt, enum AVPacketSideDataType type,
3560 int av_packet_merge_side_data(AVPacket *pkt);
3562 int av_packet_split_side_data(AVPacket *pkt);
3570 * @addtogroup lavc_decoding
3575 * Find a registered decoder with a matching codec ID.
3577 * @param id CodecID of the requested decoder
3578 * @return A decoder if one was found, NULL otherwise.
3580 AVCodec *avcodec_find_decoder(enum CodecID id);
3583 * Find a registered decoder with the specified name.
3585 * @param name name of the requested decoder
3586 * @return A decoder if one was found, NULL otherwise.
3588 AVCodec *avcodec_find_decoder_by_name(const char *name);
3590 int avcodec_default_get_buffer(AVCodecContext *s, AVFrame *pic);
3591 void avcodec_default_release_buffer(AVCodecContext *s, AVFrame *pic);
3592 int avcodec_default_reget_buffer(AVCodecContext *s, AVFrame *pic);
3595 * Return the amount of padding in pixels which the get_buffer callback must
3596 * provide around the edge of the image for codecs which do not have the
3597 * CODEC_FLAG_EMU_EDGE flag.
3599 * @return Required padding in pixels.
3601 unsigned avcodec_get_edge_width(void);
3604 * Modify width and height values so that they will result in a memory
3605 * buffer that is acceptable for the codec if you do not use any horizontal
3608 * May only be used if a codec with CODEC_CAP_DR1 has been opened.
3609 * If CODEC_FLAG_EMU_EDGE is not set, the dimensions must have been increased
3610 * according to avcodec_get_edge_width() before.
3612 void avcodec_align_dimensions(AVCodecContext *s, int *width, int *height);
3615 * Modify width and height values so that they will result in a memory
3616 * buffer that is acceptable for the codec if you also ensure that all
3617 * line sizes are a multiple of the respective linesize_align[i].
3619 * May only be used if a codec with CODEC_CAP_DR1 has been opened.
3620 * If CODEC_FLAG_EMU_EDGE is not set, the dimensions must have been increased
3621 * according to avcodec_get_edge_width() before.
3623 void avcodec_align_dimensions2(AVCodecContext *s, int *width, int *height,
3624 int linesize_align[AV_NUM_DATA_POINTERS]);
3626 #if FF_API_OLD_DECODE_AUDIO
3628 * Wrapper function which calls avcodec_decode_audio4.
3630 * @deprecated Use avcodec_decode_audio4 instead.
3632 * Decode the audio frame of size avpkt->size from avpkt->data into samples.
3633 * Some decoders may support multiple frames in a single AVPacket, such
3634 * decoders would then just decode the first frame. In this case,
3635 * avcodec_decode_audio3 has to be called again with an AVPacket that contains
3636 * the remaining data in order to decode the second frame etc.
3638 * could be outputted, frame_size_ptr is zero. Otherwise, it is the
3639 * decompressed frame size in bytes.
3641 * @warning You must set frame_size_ptr to the allocated size of the
3642 * output buffer before calling avcodec_decode_audio3().
3644 * @warning The input buffer must be FF_INPUT_BUFFER_PADDING_SIZE larger than
3645 * the actual read bytes because some optimized bitstream readers read 32 or 64
3646 * bits at once and could read over the end.
3648 * @warning The end of the input buffer avpkt->data should be set to 0 to ensure that
3649 * no overreading happens for damaged MPEG streams.
3651 * @warning You must not provide a custom get_buffer() when using
3652 * avcodec_decode_audio3(). Doing so will override it with
3653 * avcodec_default_get_buffer. Use avcodec_decode_audio4() instead,
3654 * which does allow the application to provide a custom get_buffer().
3656 * @note You might have to align the input buffer avpkt->data and output buffer
3657 * samples. The alignment requirements depend on the CPU: On some CPUs it isn't
3658 * necessary at all, on others it won't work at all if not aligned and on others
3659 * it will work but it will have an impact on performance.
3661 * In practice, avpkt->data should have 4 byte alignment at minimum and
3662 * samples should be 16 byte aligned unless the CPU doesn't need it
3663 * (AltiVec and SSE do).
3665 * @note Codecs which have the CODEC_CAP_DELAY capability set have a delay
3666 * between input and output, these need to be fed with avpkt->data=NULL,
3667 * avpkt->size=0 at the end to return the remaining frames.
3669 * @param avctx the codec context
3670 * @param[out] samples the output buffer, sample type in avctx->sample_fmt
3671 * If the sample format is planar, each channel plane will
3672 * be the same size, with no padding between channels.
3673 * @param[in,out] frame_size_ptr the output buffer size in bytes
3674 * @param[in] avpkt The input AVPacket containing the input buffer.
3675 * You can create such packet with av_init_packet() and by then setting
3676 * data and size, some decoders might in addition need other fields.
3677 * All decoders are designed to use the least fields possible though.
3678 * @return On error a negative value is returned, otherwise the number of bytes
3679 * used or zero if no frame data was decompressed (used) from the input AVPacket.
3681 attribute_deprecated int avcodec_decode_audio3(AVCodecContext *avctx, int16_t *samples,
3682 int *frame_size_ptr,
3687 * Decode the audio frame of size avpkt->size from avpkt->data into frame.
3689 * Some decoders may support multiple frames in a single AVPacket. Such
3690 * decoders would then just decode the first frame. In this case,
3691 * avcodec_decode_audio4 has to be called again with an AVPacket containing
3692 * the remaining data in order to decode the second frame, etc...
3693 * Even if no frames are returned, the packet needs to be fed to the decoder
3694 * with remaining data until it is completely consumed or an error occurs.
3696 * @warning The input buffer, avpkt->data must be FF_INPUT_BUFFER_PADDING_SIZE
3697 * larger than the actual read bytes because some optimized bitstream
3698 * readers read 32 or 64 bits at once and could read over the end.
3700 * @note You might have to align the input buffer. The alignment requirements
3701 * depend on the CPU and the decoder.
3703 * @param avctx the codec context
3704 * @param[out] frame The AVFrame in which to store decoded audio samples.
3705 * Decoders request a buffer of a particular size by setting
3706 * AVFrame.nb_samples prior to calling get_buffer(). The
3707 * decoder may, however, only utilize part of the buffer by
3708 * setting AVFrame.nb_samples to a smaller value in the
3710 * @param[out] got_frame_ptr Zero if no frame could be decoded, otherwise it is
3712 * @param[in] avpkt The input AVPacket containing the input buffer.
3713 * At least avpkt->data and avpkt->size should be set. Some
3714 * decoders might also require additional fields to be set.
3715 * @return A negative error code is returned if an error occurred during
3716 * decoding, otherwise the number of bytes consumed from the input
3717 * AVPacket is returned.
3719 int avcodec_decode_audio4(AVCodecContext *avctx, AVFrame *frame,
3720 int *got_frame_ptr, const AVPacket *avpkt);
3723 * Decode the video frame of size avpkt->size from avpkt->data into picture.
3724 * Some decoders may support multiple frames in a single AVPacket, such
3725 * decoders would then just decode the first frame.
3727 * @warning The input buffer must be FF_INPUT_BUFFER_PADDING_SIZE larger than
3728 * the actual read bytes because some optimized bitstream readers read 32 or 64
3729 * bits at once and could read over the end.
3731 * @warning The end of the input buffer buf should be set to 0 to ensure that
3732 * no overreading happens for damaged MPEG streams.
3734 * @note You might have to align the input buffer avpkt->data.
3735 * The alignment requirements depend on the CPU: on some CPUs it isn't
3736 * necessary at all, on others it won't work at all if not aligned and on others
3737 * it will work but it will have an impact on performance.
3739 * In practice, avpkt->data should have 4 byte alignment at minimum.
3741 * @note Codecs which have the CODEC_CAP_DELAY capability set have a delay
3742 * between input and output, these need to be fed with avpkt->data=NULL,
3743 * avpkt->size=0 at the end to return the remaining frames.
3745 * @param avctx the codec context
3746 * @param[out] picture The AVFrame in which the decoded video frame will be stored.
3747 * Use avcodec_alloc_frame to get an AVFrame, the codec will
3748 * allocate memory for the actual bitmap.
3749 * with default get/release_buffer(), the decoder frees/reuses the bitmap as it sees fit.
3750 * with overridden get/release_buffer() (needs CODEC_CAP_DR1) the user decides into what buffer the decoder
3751 * decodes and the decoder tells the user once it does not need the data anymore,
3752 * the user app can at this point free/reuse/keep the memory as it sees fit.
3754 * @param[in] avpkt The input AVpacket containing the input buffer.
3755 * You can create such packet with av_init_packet() and by then setting
3756 * data and size, some decoders might in addition need other fields like
3757 * flags&AV_PKT_FLAG_KEY. All decoders are designed to use the least
3759 * @param[in,out] got_picture_ptr Zero if no frame could be decompressed, otherwise, it is nonzero.
3760 * @return On error a negative value is returned, otherwise the number of bytes
3761 * used or zero if no frame could be decompressed.
3763 int avcodec_decode_video2(AVCodecContext *avctx, AVFrame *picture,
3764 int *got_picture_ptr,
3765 const AVPacket *avpkt);
3768 * Decode a subtitle message.
3769 * Return a negative value on error, otherwise return the number of bytes used.
3770 * If no subtitle could be decompressed, got_sub_ptr is zero.
3771 * Otherwise, the subtitle is stored in *sub.
3772 * Note that CODEC_CAP_DR1 is not available for subtitle codecs. This is for
3773 * simplicity, because the performance difference is expect to be negligible
3774 * and reusing a get_buffer written for video codecs would probably perform badly
3775 * due to a potentially very different allocation pattern.
3777 * @param avctx the codec context
3778 * @param[out] sub The AVSubtitle in which the decoded subtitle will be stored, must be
3779 freed with avsubtitle_free if *got_sub_ptr is set.
3780 * @param[in,out] got_sub_ptr Zero if no subtitle could be decompressed, otherwise, it is nonzero.
3781 * @param[in] avpkt The input AVPacket containing the input buffer.
3783 int avcodec_decode_subtitle2(AVCodecContext *avctx, AVSubtitle *sub,
3788 * @defgroup lavc_parsing Frame parsing
3792 typedef struct AVCodecParserContext {
3794 struct AVCodecParser *parser;
3795 int64_t frame_offset; /* offset of the current frame */
3796 int64_t cur_offset; /* current offset
3797 (incremented by each av_parser_parse()) */
3798 int64_t next_frame_offset; /* offset of the next frame */
3800 int pict_type; /* XXX: Put it back in AVCodecContext. */
3802 * This field is used for proper frame duration computation in lavf.
3803 * It signals, how much longer the frame duration of the current frame
3804 * is compared to normal frame duration.
3806 * frame_duration = (1 + repeat_pict) * time_base
3808 * It is used by codecs like H.264 to display telecined material.
3810 int repeat_pict; /* XXX: Put it back in AVCodecContext. */
3811 int64_t pts; /* pts of the current frame */
3812 int64_t dts; /* dts of the current frame */
3817 int fetch_timestamp;
3819 #define AV_PARSER_PTS_NB 4
3820 int cur_frame_start_index;
3821 int64_t cur_frame_offset[AV_PARSER_PTS_NB];
3822 int64_t cur_frame_pts[AV_PARSER_PTS_NB];
3823 int64_t cur_frame_dts[AV_PARSER_PTS_NB];
3826 #define PARSER_FLAG_COMPLETE_FRAMES 0x0001
3827 #define PARSER_FLAG_ONCE 0x0002
3828 /// Set if the parser has a valid file offset
3829 #define PARSER_FLAG_FETCHED_OFFSET 0x0004
3830 #define PARSER_FLAG_USE_CODEC_TS 0x1000
3832 int64_t offset; ///< byte offset from starting packet start
3833 int64_t cur_frame_end[AV_PARSER_PTS_NB];
3836 * Set by parser to 1 for key frames and 0 for non-key frames.
3837 * It is initialized to -1, so if the parser doesn't set this flag,
3838 * old-style fallback using AV_PICTURE_TYPE_I picture type as key frames
3844 * Time difference in stream time base units from the pts of this
3845 * packet to the point at which the output from the decoder has converged
3846 * independent from the availability of previous frames. That is, the
3847 * frames are virtually identical no matter if decoding started from
3848 * the very first frame or from this keyframe.
3849 * Is AV_NOPTS_VALUE if unknown.
3850 * This field is not the display duration of the current frame.
3851 * This field has no meaning if the packet does not have AV_PKT_FLAG_KEY
3854 * The purpose of this field is to allow seeking in streams that have no
3855 * keyframes in the conventional sense. It corresponds to the
3856 * recovery point SEI in H.264 and match_time_delta in NUT. It is also
3857 * essential for some types of subtitle streams to ensure that all
3858 * subtitles are correctly displayed after seeking.
3860 int64_t convergence_duration;
3862 // Timestamp generation support:
3864 * Synchronization point for start of timestamp generation.
3866 * Set to >0 for sync point, 0 for no sync point and <0 for undefined
3869 * For example, this corresponds to presence of H.264 buffering period
3875 * Offset of the current timestamp against last timestamp sync point in
3876 * units of AVCodecContext.time_base.
3878 * Set to INT_MIN when dts_sync_point unused. Otherwise, it must
3879 * contain a valid timestamp offset.
3881 * Note that the timestamp of sync point has usually a nonzero
3882 * dts_ref_dts_delta, which refers to the previous sync point. Offset of
3883 * the next frame after timestamp sync point will be usually 1.
3885 * For example, this corresponds to H.264 cpb_removal_delay.
3887 int dts_ref_dts_delta;
3890 * Presentation delay of current frame in units of AVCodecContext.time_base.
3892 * Set to INT_MIN when dts_sync_point unused. Otherwise, it must
3893 * contain valid non-negative timestamp delta (presentation time of a frame
3894 * must not lie in the past).
3896 * This delay represents the difference between decoding and presentation
3897 * time of the frame.
3899 * For example, this corresponds to H.264 dpb_output_delay.
3904 * Position of the packet in file.
3906 * Analogous to cur_frame_pts/dts
3908 int64_t cur_frame_pos[AV_PARSER_PTS_NB];
3911 * Byte position of currently parsed frame in stream.
3916 * Previous frame byte position.
3921 * Duration of the current frame.
3922 * For audio, this is in units of 1 / AVCodecContext.sample_rate.
3923 * For all other types, this is in units of AVCodecContext.time_base.
3926 } AVCodecParserContext;
3928 typedef struct AVCodecParser {
3929 int codec_ids[5]; /* several codec IDs are permitted */
3931 int (*parser_init)(AVCodecParserContext *s);
3932 int (*parser_parse)(AVCodecParserContext *s,
3933 AVCodecContext *avctx,
3934 const uint8_t **poutbuf, int *poutbuf_size,
3935 const uint8_t *buf, int buf_size);
3936 void (*parser_close)(AVCodecParserContext *s);
3937 int (*split)(AVCodecContext *avctx, const uint8_t *buf, int buf_size);
3938 struct AVCodecParser *next;
3941 AVCodecParser *av_parser_next(AVCodecParser *c);
3943 void av_register_codec_parser(AVCodecParser *parser);
3944 AVCodecParserContext *av_parser_init(int codec_id);
3949 * @param s parser context.
3950 * @param avctx codec context.
3951 * @param poutbuf set to pointer to parsed buffer or NULL if not yet finished.
3952 * @param poutbuf_size set to size of parsed buffer or zero if not yet finished.
3953 * @param buf input buffer.
3954 * @param buf_size input length, to signal EOF, this should be 0 (so that the last frame can be output).
3955 * @param pts input presentation timestamp.
3956 * @param dts input decoding timestamp.
3957 * @param pos input byte position in stream.
3958 * @return the number of bytes of the input bitstream used.
3963 * len = av_parser_parse2(myparser, AVCodecContext, &data, &size,
3970 * decode_frame(data, size);
3974 int av_parser_parse2(AVCodecParserContext *s,
3975 AVCodecContext *avctx,
3976 uint8_t **poutbuf, int *poutbuf_size,
3977 const uint8_t *buf, int buf_size,
3978 int64_t pts, int64_t dts,
3981 int av_parser_change(AVCodecParserContext *s,
3982 AVCodecContext *avctx,
3983 uint8_t **poutbuf, int *poutbuf_size,
3984 const uint8_t *buf, int buf_size, int keyframe);
3985 void av_parser_close(AVCodecParserContext *s);
3993 * @addtogroup lavc_encoding
3998 * Find a registered encoder with a matching codec ID.
4000 * @param id CodecID of the requested encoder
4001 * @return An encoder if one was found, NULL otherwise.
4003 AVCodec *avcodec_find_encoder(enum CodecID id);
4006 * Find a registered encoder with the specified name.
4008 * @param name name of the requested encoder
4009 * @return An encoder if one was found, NULL otherwise.
4011 AVCodec *avcodec_find_encoder_by_name(const char *name);
4013 #if FF_API_OLD_ENCODE_AUDIO
4015 * Encode an audio frame from samples into buf.
4017 * @deprecated Use avcodec_encode_audio2 instead.
4019 * @note The output buffer should be at least FF_MIN_BUFFER_SIZE bytes large.
4020 * However, for codecs with avctx->frame_size equal to 0 (e.g. PCM) the user
4021 * will know how much space is needed because it depends on the value passed
4022 * in buf_size as described below. In that case a lower value can be used.
4024 * @param avctx the codec context
4025 * @param[out] buf the output buffer
4026 * @param[in] buf_size the output buffer size
4027 * @param[in] samples the input buffer containing the samples
4028 * The number of samples read from this buffer is frame_size*channels,
4029 * both of which are defined in avctx.
4030 * For codecs which have avctx->frame_size equal to 0 (e.g. PCM) the number of
4031 * samples read from samples is equal to:
4032 * buf_size * 8 / (avctx->channels * av_get_bits_per_sample(avctx->codec_id))
4033 * This also implies that av_get_bits_per_sample() must not return 0 for these
4035 * @return On error a negative value is returned, on success zero or the number
4036 * of bytes used to encode the data read from the input buffer.
4038 int attribute_deprecated avcodec_encode_audio(AVCodecContext *avctx,
4039 uint8_t *buf, int buf_size,
4040 const short *samples);
4044 * Encode a frame of audio.
4046 * Takes input samples from frame and writes the next output packet, if
4047 * available, to avpkt. The output packet does not necessarily contain data for
4048 * the most recent frame, as encoders can delay, split, and combine input frames
4049 * internally as needed.
4051 * @param avctx codec context
4052 * @param avpkt output AVPacket.
4053 * The user can supply an output buffer by setting
4054 * avpkt->data and avpkt->size prior to calling the
4055 * function, but if the size of the user-provided data is not
4056 * large enough, encoding will fail. All other AVPacket fields
4057 * will be reset by the encoder using av_init_packet(). If
4058 * avpkt->data is NULL, the encoder will allocate it.
4059 * The encoder will set avpkt->size to the size of the
4062 * If this function fails or produces no output, avpkt will be
4063 * freed using av_free_packet() (i.e. avpkt->destruct will be
4064 * called to free the user supplied buffer).
4065 * @param[in] frame AVFrame containing the raw audio data to be encoded.
4066 * May be NULL when flushing an encoder that has the
4067 * CODEC_CAP_DELAY capability set.
4068 * If CODEC_CAP_VARIABLE_FRAME_SIZE is set, then each frame
4069 * can have any number of samples.
4070 * If it is not set, frame->nb_samples must be equal to
4071 * avctx->frame_size for all frames except the last.
4072 * The final frame may be smaller than avctx->frame_size.
4073 * @param[out] got_packet_ptr This field is set to 1 by libavcodec if the
4074 * output packet is non-empty, and to 0 if it is
4075 * empty. If the function returns an error, the
4076 * packet can be assumed to be invalid, and the
4077 * value of got_packet_ptr is undefined and should
4079 * @return 0 on success, negative error code on failure
4081 int avcodec_encode_audio2(AVCodecContext *avctx, AVPacket *avpkt,
4082 const AVFrame *frame, int *got_packet_ptr);
4084 #if FF_API_OLD_ENCODE_VIDEO
4086 * @deprecated use avcodec_encode_video2() instead.
4088 * Encode a video frame from pict into buf.
4089 * The input picture should be
4090 * stored using a specific format, namely avctx.pix_fmt.
4092 * @param avctx the codec context
4093 * @param[out] buf the output buffer for the bitstream of encoded frame
4094 * @param[in] buf_size the size of the output buffer in bytes
4095 * @param[in] pict the input picture to encode
4096 * @return On error a negative value is returned, on success zero or the number
4097 * of bytes used from the output buffer.
4099 attribute_deprecated
4100 int avcodec_encode_video(AVCodecContext *avctx, uint8_t *buf, int buf_size,
4101 const AVFrame *pict);
4105 * Encode a frame of video.
4107 * Takes input raw video data from frame and writes the next output packet, if
4108 * available, to avpkt. The output packet does not necessarily contain data for
4109 * the most recent frame, as encoders can delay and reorder input frames
4110 * internally as needed.
4112 * @param avctx codec context
4113 * @param avpkt output AVPacket.
4114 * The user can supply an output buffer by setting
4115 * avpkt->data and avpkt->size prior to calling the
4116 * function, but if the size of the user-provided data is not
4117 * large enough, encoding will fail. All other AVPacket fields
4118 * will be reset by the encoder using av_init_packet(). If
4119 * avpkt->data is NULL, the encoder will allocate it.
4120 * The encoder will set avpkt->size to the size of the
4121 * output packet. The returned data (if any) belongs to the
4122 * caller, he is responsible for freeing it.
4124 * If this function fails or produces no output, avpkt will be
4125 * freed using av_free_packet() (i.e. avpkt->destruct will be
4126 * called to free the user supplied buffer).
4127 * @param[in] frame AVFrame containing the raw video data to be encoded.
4128 * May be NULL when flushing an encoder that has the
4129 * CODEC_CAP_DELAY capability set.
4130 * @param[out] got_packet_ptr This field is set to 1 by libavcodec if the
4131 * output packet is non-empty, and to 0 if it is
4132 * empty. If the function returns an error, the
4133 * packet can be assumed to be invalid, and the
4134 * value of got_packet_ptr is undefined and should
4136 * @return 0 on success, negative error code on failure
4138 int avcodec_encode_video2(AVCodecContext *avctx, AVPacket *avpkt,
4139 const AVFrame *frame, int *got_packet_ptr);
4141 int avcodec_encode_subtitle(AVCodecContext *avctx, uint8_t *buf, int buf_size,
4142 const AVSubtitle *sub);
4150 * @defgroup lavc_resample Audio resampling
4155 struct ReSampleContext;
4156 struct AVResampleContext;
4158 typedef struct ReSampleContext ReSampleContext;
4161 * Initialize audio resampling context.
4163 * @param output_channels number of output channels
4164 * @param input_channels number of input channels
4165 * @param output_rate output sample rate
4166 * @param input_rate input sample rate
4167 * @param sample_fmt_out requested output sample format
4168 * @param sample_fmt_in input sample format
4169 * @param filter_length length of each FIR filter in the filterbank relative to the cutoff frequency
4170 * @param log2_phase_count log2 of the number of entries in the polyphase filterbank
4171 * @param linear if 1 then the used FIR filter will be linearly interpolated
4172 between the 2 closest, if 0 the closest will be used
4173 * @param cutoff cutoff frequency, 1.0 corresponds to half the output sampling rate
4174 * @return allocated ReSampleContext, NULL if error occurred
4176 ReSampleContext *av_audio_resample_init(int output_channels, int input_channels,
4177 int output_rate, int input_rate,
4178 enum AVSampleFormat sample_fmt_out,
4179 enum AVSampleFormat sample_fmt_in,
4180 int filter_length, int log2_phase_count,
4181 int linear, double cutoff);
4183 int audio_resample(ReSampleContext *s, short *output, short *input, int nb_samples);
4186 * Free resample context.
4188 * @param s a non-NULL pointer to a resample context previously
4189 * created with av_audio_resample_init()
4191 void audio_resample_close(ReSampleContext *s);
4195 * Initialize an audio resampler.
4196 * Note, if either rate is not an integer then simply scale both rates up so they are.
4197 * @param filter_length length of each FIR filter in the filterbank relative to the cutoff freq
4198 * @param log2_phase_count log2 of the number of entries in the polyphase filterbank
4199 * @param linear If 1 then the used FIR filter will be linearly interpolated
4200 between the 2 closest, if 0 the closest will be used
4201 * @param cutoff cutoff frequency, 1.0 corresponds to half the output sampling rate
4203 struct AVResampleContext *av_resample_init(int out_rate, int in_rate, int filter_length, int log2_phase_count, int linear, double cutoff);
4206 * Resample an array of samples using a previously configured context.
4207 * @param src an array of unconsumed samples
4208 * @param consumed the number of samples of src which have been consumed are returned here
4209 * @param src_size the number of unconsumed samples available
4210 * @param dst_size the amount of space in samples available in dst
4211 * @param update_ctx If this is 0 then the context will not be modified, that way several channels can be resampled with the same context.
4212 * @return the number of samples written in dst or -1 if an error occurred
4214 int av_resample(struct AVResampleContext *c, short *dst, short *src, int *consumed, int src_size, int dst_size, int update_ctx);
4218 * Compensate samplerate/timestamp drift. The compensation is done by changing
4219 * the resampler parameters, so no audible clicks or similar distortions occur
4220 * @param compensation_distance distance in output samples over which the compensation should be performed
4221 * @param sample_delta number of output samples which should be output less
4223 * example: av_resample_compensate(c, 10, 500)
4224 * here instead of 510 samples only 500 samples would be output
4226 * note, due to rounding the actual compensation might be slightly different,
4227 * especially if the compensation_distance is large and the in_rate used during init is small
4229 void av_resample_compensate(struct AVResampleContext *c, int sample_delta, int compensation_distance);
4230 void av_resample_close(struct AVResampleContext *c);
4237 * @addtogroup lavc_picture
4242 * Allocate memory for a picture. Call avpicture_free() to free it.
4244 * @see avpicture_fill()
4246 * @param picture the picture to be filled in
4247 * @param pix_fmt the format of the picture
4248 * @param width the width of the picture
4249 * @param height the height of the picture
4250 * @return zero if successful, a negative value if not
4252 int avpicture_alloc(AVPicture *picture, enum PixelFormat pix_fmt, int width, int height);
4255 * Free a picture previously allocated by avpicture_alloc().
4256 * The data buffer used by the AVPicture is freed, but the AVPicture structure
4259 * @param picture the AVPicture to be freed
4261 void avpicture_free(AVPicture *picture);
4264 * Fill in the AVPicture fields, always assume a linesize alignment of
4267 * @see av_image_fill_arrays()
4269 int avpicture_fill(AVPicture *picture, uint8_t *ptr,
4270 enum PixelFormat pix_fmt, int width, int height);
4273 * Copy pixel data from an AVPicture into a buffer, always assume a
4274 * linesize alignment of 1.
4276 * @see av_image_copy_to_buffer()
4278 int avpicture_layout(const AVPicture* src, enum PixelFormat pix_fmt, int width, int height,
4279 unsigned char *dest, int dest_size);
4282 * Calculate the size in bytes that a picture of the given width and height
4283 * would occupy if stored in the given picture format.
4284 * Always assume a linesize alignment of 1.
4286 * @see av_image_get_buffer_size().
4288 int avpicture_get_size(enum PixelFormat pix_fmt, int width, int height);
4291 * deinterlace - if not supported return -1
4293 int avpicture_deinterlace(AVPicture *dst, const AVPicture *src,
4294 enum PixelFormat pix_fmt, int width, int height);
4296 * Copy image src to dst. Wraps av_image_copy().
4298 void av_picture_copy(AVPicture *dst, const AVPicture *src,
4299 enum PixelFormat pix_fmt, int width, int height);
4302 * Crop image top and left side.
4304 int av_picture_crop(AVPicture *dst, const AVPicture *src,
4305 enum PixelFormat pix_fmt, int top_band, int left_band);
4310 int av_picture_pad(AVPicture *dst, const AVPicture *src, int height, int width, enum PixelFormat pix_fmt,
4311 int padtop, int padbottom, int padleft, int padright, int *color);
4318 * @defgroup lavc_misc Utility functions
4321 * Miscellaneous utility functions related to both encoding and decoding
4327 * @defgroup lavc_misc_pixfmt Pixel formats
4329 * Functions for working with pixel formats.
4333 void avcodec_get_chroma_sub_sample(enum PixelFormat pix_fmt, int *h_shift, int *v_shift);
4336 * Return a value representing the fourCC code associated to the
4337 * pixel format pix_fmt, or 0 if no associated fourCC code can be
4340 unsigned int avcodec_pix_fmt_to_codec_tag(enum PixelFormat pix_fmt);
4342 #define FF_LOSS_RESOLUTION 0x0001 /**< loss due to resolution change */
4343 #define FF_LOSS_DEPTH 0x0002 /**< loss due to color depth change */
4344 #define FF_LOSS_COLORSPACE 0x0004 /**< loss due to color space conversion */
4345 #define FF_LOSS_ALPHA 0x0008 /**< loss of alpha bits */
4346 #define FF_LOSS_COLORQUANT 0x0010 /**< loss due to color quantization */
4347 #define FF_LOSS_CHROMA 0x0020 /**< loss of chroma (e.g. RGB to gray conversion) */
4350 * Compute what kind of losses will occur when converting from one specific
4351 * pixel format to another.
4352 * When converting from one pixel format to another, information loss may occur.
4353 * For example, when converting from RGB24 to GRAY, the color information will
4354 * be lost. Similarly, other losses occur when converting from some formats to
4355 * other formats. These losses can involve loss of chroma, but also loss of
4356 * resolution, loss of color depth, loss due to the color space conversion, loss
4357 * of the alpha bits or loss due to color quantization.
4358 * avcodec_get_fix_fmt_loss() informs you about the various types of losses
4359 * which will occur when converting from one pixel format to another.
4361 * @param[in] dst_pix_fmt destination pixel format
4362 * @param[in] src_pix_fmt source pixel format
4363 * @param[in] has_alpha Whether the source pixel format alpha channel is used.
4364 * @return Combination of flags informing you what kind of losses will occur
4365 * (maximum loss for an invalid dst_pix_fmt).
4367 int avcodec_get_pix_fmt_loss(enum PixelFormat dst_pix_fmt, enum PixelFormat src_pix_fmt,
4371 * Find the best pixel format to convert to given a certain source pixel
4372 * format. When converting from one pixel format to another, information loss
4373 * may occur. For example, when converting from RGB24 to GRAY, the color
4374 * information will be lost. Similarly, other losses occur when converting from
4375 * some formats to other formats. avcodec_find_best_pix_fmt() searches which of
4376 * the given pixel formats should be used to suffer the least amount of loss.
4377 * The pixel formats from which it chooses one, are determined by the
4378 * pix_fmt_mask parameter.
4380 * Note, only the first 64 pixel formats will fit in pix_fmt_mask.
4383 * src_pix_fmt = PIX_FMT_YUV420P;
4384 * pix_fmt_mask = (1 << PIX_FMT_YUV422P) | (1 << PIX_FMT_RGB24);
4385 * dst_pix_fmt = avcodec_find_best_pix_fmt(pix_fmt_mask, src_pix_fmt, alpha, &loss);
4388 * @param[in] pix_fmt_mask bitmask determining which pixel format to choose from
4389 * @param[in] src_pix_fmt source pixel format
4390 * @param[in] has_alpha Whether the source pixel format alpha channel is used.
4391 * @param[out] loss_ptr Combination of flags informing you what kind of losses will occur.
4392 * @return The best pixel format to convert to or -1 if none was found.
4394 enum PixelFormat avcodec_find_best_pix_fmt(int64_t pix_fmt_mask, enum PixelFormat src_pix_fmt,
4395 int has_alpha, int *loss_ptr);
4398 * Find the best pixel format to convert to given a certain source pixel
4399 * format and a selection of two destination pixel formats. When converting from
4400 * one pixel format to another, information loss may occur. For example, when converting
4401 * from RGB24 to GRAY, the color information will be lost. Similarly, other losses occur when
4402 * converting from some formats to other formats. avcodec_find_best_pix_fmt2() selects which of
4403 * the given pixel formats should be used to suffer the least amount of loss.
4405 * If one of the destination formats is PIX_FMT_NONE the other pixel format (if valid) will be
4409 * src_pix_fmt = PIX_FMT_YUV420P;
4410 * dst_pix_fmt1= PIX_FMT_RGB24;
4411 * dst_pix_fmt2= PIX_FMT_GRAY8;
4412 * dst_pix_fmt3= PIX_FMT_RGB8;
4413 * loss= FF_LOSS_CHROMA; // don't care about chroma loss, so chroma loss will be ignored.
4414 * dst_pix_fmt = avcodec_find_best_pix_fmt2(dst_pix_fmt1, dst_pix_fmt2, src_pix_fmt, alpha, &loss);
4415 * dst_pix_fmt = avcodec_find_best_pix_fmt2(dst_pix_fmt, dst_pix_fmt3, src_pix_fmt, alpha, &loss);
4418 * @param[in] dst_pix_fmt1 One of the two destination pixel formats to choose from
4419 * @param[in] dst_pix_fmt2 The other of the two destination pixel formats to choose from
4420 * @param[in] src_pix_fmt Source pixel format
4421 * @param[in] has_alpha Whether the source pixel format alpha channel is used.
4422 * @param[in, out] loss_ptr Combination of loss flags. In: selects which of the losses to ignore, i.e.
4423 * NULL or value of zero means we care about all losses. Out: the loss
4424 * that occurs when converting from src to selected dst pixel format.
4425 * @return The best pixel format to convert to or -1 if none was found.
4427 enum PixelFormat avcodec_find_best_pix_fmt2(enum PixelFormat dst_pix_fmt1, enum PixelFormat dst_pix_fmt2,
4428 enum PixelFormat src_pix_fmt, int has_alpha, int *loss_ptr);
4430 enum PixelFormat avcodec_default_get_format(struct AVCodecContext *s, const enum PixelFormat * fmt);
4436 void avcodec_set_dimensions(AVCodecContext *s, int width, int height);
4439 * Put a string representing the codec tag codec_tag in buf.
4441 * @param buf_size size in bytes of buf
4442 * @return the length of the string that would have been generated if
4443 * enough space had been available, excluding the trailing null
4445 size_t av_get_codec_tag_string(char *buf, size_t buf_size, unsigned int codec_tag);
4447 void avcodec_string(char *buf, int buf_size, AVCodecContext *enc, int encode);
4450 * Return a name for the specified profile, if available.
4452 * @param codec the codec that is searched for the given profile
4453 * @param profile the profile value for which a name is requested
4454 * @return A name for the profile if found, NULL otherwise.
4456 const char *av_get_profile_name(const AVCodec *codec, int profile);
4458 int avcodec_default_execute(AVCodecContext *c, int (*func)(AVCodecContext *c2, void *arg2),void *arg, int *ret, int count, int size);
4459 int avcodec_default_execute2(AVCodecContext *c, int (*func)(AVCodecContext *c2, void *arg2, int, int),void *arg, int *ret, int count);
4460 //FIXME func typedef
4463 * Fill audio frame data and linesize.
4464 * AVFrame extended_data channel pointers are allocated if necessary for
4467 * @param frame the AVFrame
4468 * frame->nb_samples must be set prior to calling the
4469 * function. This function fills in frame->data,
4470 * frame->extended_data, frame->linesize[0].
4471 * @param nb_channels channel count
4472 * @param sample_fmt sample format
4473 * @param buf buffer to use for frame data
4474 * @param buf_size size of buffer
4475 * @param align plane size sample alignment (0 = default)
4476 * @return 0 on success, negative error code on failure
4478 int avcodec_fill_audio_frame(AVFrame *frame, int nb_channels,
4479 enum AVSampleFormat sample_fmt, const uint8_t *buf,
4480 int buf_size, int align);
4483 * Flush buffers, should be called when seeking or when switching to a different stream.
4485 void avcodec_flush_buffers(AVCodecContext *avctx);
4487 void avcodec_default_free_buffers(AVCodecContext *s);
4490 * Return codec bits per sample.
4492 * @param[in] codec_id the codec
4493 * @return Number of bits per sample or zero if unknown for the given codec.
4495 int av_get_bits_per_sample(enum CodecID codec_id);
4498 * Return the PCM codec associated with a sample format.
4499 * @param be endianness, 0 for little, 1 for big,
4500 * -1 (or anything else) for native
4501 * @return CODEC_ID_PCM_* or CODEC_ID_NONE
4503 enum CodecID av_get_pcm_codec(enum AVSampleFormat fmt, int be);
4506 * Return codec bits per sample.
4507 * Only return non-zero if the bits per sample is exactly correct, not an
4510 * @param[in] codec_id the codec
4511 * @return Number of bits per sample or zero if unknown for the given codec.
4513 int av_get_exact_bits_per_sample(enum CodecID codec_id);
4516 * Return audio frame duration.
4518 * @param avctx codec context
4519 * @param frame_bytes size of the frame, or 0 if unknown
4520 * @return frame duration, in samples, if known. 0 if not able to
4523 int av_get_audio_frame_duration(AVCodecContext *avctx, int frame_bytes);
4526 typedef struct AVBitStreamFilterContext {
4528 struct AVBitStreamFilter *filter;
4529 AVCodecParserContext *parser;
4530 struct AVBitStreamFilterContext *next;
4531 } AVBitStreamFilterContext;
4534 typedef struct AVBitStreamFilter {
4537 int (*filter)(AVBitStreamFilterContext *bsfc,
4538 AVCodecContext *avctx, const char *args,
4539 uint8_t **poutbuf, int *poutbuf_size,
4540 const uint8_t *buf, int buf_size, int keyframe);
4541 void (*close)(AVBitStreamFilterContext *bsfc);
4542 struct AVBitStreamFilter *next;
4543 } AVBitStreamFilter;
4545 void av_register_bitstream_filter(AVBitStreamFilter *bsf);
4546 AVBitStreamFilterContext *av_bitstream_filter_init(const char *name);
4547 int av_bitstream_filter_filter(AVBitStreamFilterContext *bsfc,
4548 AVCodecContext *avctx, const char *args,
4549 uint8_t **poutbuf, int *poutbuf_size,
4550 const uint8_t *buf, int buf_size, int keyframe);
4551 void av_bitstream_filter_close(AVBitStreamFilterContext *bsf);
4553 AVBitStreamFilter *av_bitstream_filter_next(AVBitStreamFilter *f);
4558 * Reallocate the given block if it is not large enough, otherwise do nothing.
4562 void *av_fast_realloc(void *ptr, unsigned int *size, size_t min_size);
4565 * Allocate a buffer, reusing the given one if large enough.
4567 * Contrary to av_fast_realloc the current buffer contents might not be
4568 * preserved and on error the old buffer is freed, thus no special
4569 * handling to avoid memleaks is necessary.
4571 * @param ptr pointer to pointer to already allocated buffer, overwritten with pointer to new buffer
4572 * @param size size of the buffer *ptr points to
4573 * @param min_size minimum size of *ptr buffer after returning, *ptr will be NULL and
4574 * *size 0 if an error occurred.
4576 void av_fast_malloc(void *ptr, unsigned int *size, size_t min_size);
4579 * Same behaviour av_fast_malloc but the buffer has additional
4580 * FF_INPUT_PADDING_SIZE at the end which will will always be 0.
4582 * In addition the whole buffer will initially and after resizes
4583 * be 0-initialized so that no uninitialized data will ever appear.
4585 void av_fast_padded_malloc(void *ptr, unsigned int *size, size_t min_size);
4588 * Encode extradata length to a buffer. Used by xiph codecs.
4590 * @param s buffer to write to; must be at least (v/255+1) bytes long
4591 * @param v size of extradata in bytes
4592 * @return number of bytes written to the buffer.
4594 unsigned int av_xiphlacing(unsigned char *s, unsigned int v);
4597 * Log a generic warning message about a missing feature. This function is
4598 * intended to be used internally by FFmpeg (libavcodec, libavformat, etc.)
4599 * only, and would normally not be used by applications.
4600 * @param[in] avc a pointer to an arbitrary struct of which the first field is
4601 * a pointer to an AVClass struct
4602 * @param[in] feature string containing the name of the missing feature
4603 * @param[in] want_sample indicates if samples are wanted which exhibit this feature.
4604 * If want_sample is non-zero, additional verbage will be added to the log
4605 * message which tells the user how to report samples to the development
4608 void av_log_missing_feature(void *avc, const char *feature, int want_sample);
4611 * Log a generic warning message asking for a sample. This function is
4612 * intended to be used internally by FFmpeg (libavcodec, libavformat, etc.)
4613 * only, and would normally not be used by applications.
4614 * @param[in] avc a pointer to an arbitrary struct of which the first field is
4615 * a pointer to an AVClass struct
4616 * @param[in] msg string containing an optional message, or NULL if no message
4618 void av_log_ask_for_sample(void *avc, const char *msg, ...) av_printf_format(2, 3);
4621 * Register the hardware accelerator hwaccel.
4623 void av_register_hwaccel(AVHWAccel *hwaccel);
4626 * If hwaccel is NULL, returns the first registered hardware accelerator,
4627 * if hwaccel is non-NULL, returns the next registered hardware accelerator
4628 * after hwaccel, or NULL if hwaccel is the last one.
4630 AVHWAccel *av_hwaccel_next(AVHWAccel *hwaccel);
4634 * Lock operation used by lockmgr
4637 AV_LOCK_CREATE, ///< Create a mutex
4638 AV_LOCK_OBTAIN, ///< Lock the mutex
4639 AV_LOCK_RELEASE, ///< Unlock the mutex
4640 AV_LOCK_DESTROY, ///< Free mutex resources
4644 * Register a user provided lock manager supporting the operations
4645 * specified by AVLockOp. mutex points to a (void *) where the
4646 * lockmgr should store/get a pointer to a user allocated mutex. It's
4647 * NULL upon AV_LOCK_CREATE and != NULL for all other ops.
4649 * @param cb User defined callback. Note: FFmpeg may invoke calls to this
4650 * callback during the call to av_lockmgr_register().
4651 * Thus, the application must be prepared to handle that.
4652 * If cb is set to NULL the lockmgr will be unregistered.
4653 * Also note that during unregistration the previously registered
4654 * lockmgr callback may also be invoked.
4656 int av_lockmgr_register(int (*cb)(void **mutex, enum AVLockOp op));
4659 * Get the type of the given codec.
4661 enum AVMediaType avcodec_get_type(enum CodecID codec_id);
4664 * Get the name of a codec.
4665 * @return a static string identifying the codec; never NULL
4667 const char *avcodec_get_name(enum CodecID id);
4670 * @return a positive value if s is open (i.e. avcodec_open2() was called on it
4671 * with no corresponding avcodec_close()), 0 otherwise.
4673 int avcodec_is_open(AVCodecContext *s);
4676 * @return a non-zero number if codec is an encoder, zero otherwise
4678 int av_codec_is_encoder(AVCodec *codec);
4681 * @return a non-zero number if codec is a decoder, zero otherwise
4683 int av_codec_is_decoder(AVCodec *codec);
4689 #endif /* AVCODEC_AVCODEC_H */