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
27 * Libavcodec external API header
31 #include "libavutil/samplefmt.h"
32 #include "libavutil/attributes.h"
33 #include "libavutil/avutil.h"
34 #include "libavutil/buffer.h"
35 #include "libavutil/cpu.h"
36 #include "libavutil/channel_layout.h"
37 #include "libavutil/dict.h"
38 #include "libavutil/frame.h"
39 #include "libavutil/log.h"
40 #include "libavutil/pixfmt.h"
41 #include "libavutil/rational.h"
46 * @defgroup libavc Encoding/Decoding Library
49 * @defgroup lavc_decoding Decoding
53 * @defgroup lavc_encoding Encoding
57 * @defgroup lavc_codec Codecs
59 * @defgroup lavc_codec_native Native Codecs
62 * @defgroup lavc_codec_wrappers External library wrappers
65 * @defgroup lavc_codec_hwaccel Hardware Accelerators bridge
69 * @defgroup lavc_internal Internal
77 * @defgroup lavc_encdec send/receive encoding and decoding API overview
80 * The avcodec_send_packet()/avcodec_receive_frame()/avcodec_send_frame()/
81 * avcodec_receive_packet() functions provide an encode/decode API, which
82 * decouples input and output.
84 * The API is very similar for encoding/decoding and audio/video, and works as
86 * - Set up and open the AVCodecContext as usual.
88 * - For decoding, call avcodec_send_packet() to give the decoder raw
89 * compressed data in an AVPacket.
90 * - For encoding, call avcodec_send_frame() to give the decoder an AVFrame
91 * containing uncompressed audio or video.
92 * In both cases, it is recommended that AVPackets and AVFrames are
93 * refcounted, or libavcodec might have to copy the input data. (libavformat
94 * always returns refcounted AVPackets, and av_frame_get_buffer() allocates
95 * refcounted AVFrames.)
96 * - Receive output in a loop. Periodically call one of the avcodec_receive_*()
97 * functions and process their output:
98 * - For decoding, call avcodec_receive_frame(). On success, it will return
99 * an AVFrame containing uncompressed audio or video data.
100 * - For encoding, call avcodec_receive_packet(). On success, it will return
101 * an AVPacket with a compressed frame.
102 * Repeat this call until it returns AVERROR(EAGAIN) or an error. The
103 * AVERROR(EAGAIN) return value means that new input data is required to
104 * return new output. In this case, continue with sending input. For each
105 * input frame/packet, the codec will typically return 1 output frame/packet,
106 * but it can also be 0 or more than 1.
108 * At the beginning of decoding or encoding, the codec might accept multiple
109 * input frames/packets without returning a frame, until its internal buffers
110 * are filled. This situation is handled transparently if you follow the steps
113 * End of stream situations. These require "flushing" (aka draining) the codec,
114 * as the codec might buffer multiple frames or packets internally for
115 * performance or out of necessity (consider B-frames).
116 * This is handled as follows:
117 * - Instead of valid input, send NULL to the avcodec_send_packet() (decoding)
118 * or avcodec_send_frame() (encoding) functions. This will enter draining
120 * - Call avcodec_receive_frame() (decoding) or avcodec_receive_packet()
121 * (encoding) in a loop until AVERROR_EOF is returned. The functions will
122 * not return AVERROR(EAGAIN), unless you forgot to enter draining mode.
123 * - Before decoding can be resumed again, the codec has to be reset with
124 * avcodec_flush_buffers().
126 * Using the API as outlined above is highly recommended. But it is also
127 * possible to call functions outside of this rigid schema. For example, you can
128 * call avcodec_send_packet() repeatedly without calling
129 * avcodec_receive_frame(). In this case, avcodec_send_packet() will succeed
130 * until the codec's internal buffer has been filled up (which is typically of
131 * size 1 per output frame, after initial input), and then reject input with
132 * AVERROR(EAGAIN). Once it starts rejecting input, you have no choice but to
133 * read at least some output.
135 * Not all codecs will follow a rigid and predictable dataflow; the only
136 * guarantee is that an AVERROR(EAGAIN) return value on a send/receive call on
137 * one end implies that a receive/send call on the other end will succeed. In
138 * general, no codec will permit unlimited buffering of input or output.
140 * This API replaces the following legacy functions:
141 * - avcodec_decode_video2() and avcodec_decode_audio4():
142 * Use avcodec_send_packet() to feed input to the decoder, then use
143 * avcodec_receive_frame() to receive decoded frames after each packet.
144 * Unlike with the old video decoding API, multiple frames might result from
145 * a packet. For audio, splitting the input packet into frames by partially
146 * decoding packets becomes transparent to the API user. You never need to
147 * feed an AVPacket to the API twice.
148 * Additionally, sending a flush/draining packet is required only once.
149 * - avcodec_encode_video2()/avcodec_encode_audio2():
150 * Use avcodec_send_frame() to feed input to the encoder, then use
151 * avcodec_receive_packet() to receive encoded packets.
152 * Providing user-allocated buffers for avcodec_receive_packet() is not
154 * - The new API does not handle subtitles yet.
156 * Mixing new and old function calls on the same AVCodecContext is not allowed,
157 * and will result in undefined behavior.
159 * Some codecs might require using the new API; using the old API will return
160 * an error when calling it.
165 * @defgroup lavc_core Core functions/structures.
168 * Basic definitions, functions for querying libavcodec capabilities,
169 * allocating core structures, etc.
175 * Identify the syntax and semantics of the bitstream.
176 * The principle is roughly:
177 * Two decoders with the same ID can decode the same streams.
178 * Two encoders with the same ID can encode compatible streams.
179 * There may be slight deviations from the principle due to implementation
182 * If you add a codec ID to this list, add it so that
183 * 1. no value of an existing codec ID changes (that would break ABI),
184 * 2. it is as close as possible to similar codecs
186 * After adding new codec IDs, do not forget to add an entry to the codec
187 * descriptor list and bump libavcodec minor version.
193 AV_CODEC_ID_MPEG1VIDEO,
194 AV_CODEC_ID_MPEG2VIDEO, ///< preferred ID for MPEG-1/2 video decoding
196 AV_CODEC_ID_MPEG2VIDEO_XVMC,
197 #endif /* FF_API_XVMC */
208 AV_CODEC_ID_RAWVIDEO,
209 AV_CODEC_ID_MSMPEG4V1,
210 AV_CODEC_ID_MSMPEG4V2,
211 AV_CODEC_ID_MSMPEG4V3,
234 AV_CODEC_ID_INTERPLAY_VIDEO,
241 AV_CODEC_ID_MSVIDEO1,
246 AV_CODEC_ID_TRUEMOTION1,
247 AV_CODEC_ID_VMDVIDEO,
272 AV_CODEC_ID_TRUEMOTION2,
278 AV_CODEC_ID_SMACKVIDEO,
283 AV_CODEC_ID_JPEG2000,
289 AV_CODEC_ID_DSICINVIDEO,
290 AV_CODEC_ID_TIERTEXSEQVIDEO,
298 AV_CODEC_ID_BETHSOFTVID,
310 AV_CODEC_ID_ESCAPE124,
314 AV_CODEC_ID_MOTIONPIXELS,
326 AV_CODEC_ID_FLASHSV2,
327 AV_CODEC_ID_CDGRAPHICS,
330 AV_CODEC_ID_BINKVIDEO,
331 AV_CODEC_ID_IFF_ILBM,
332 #define AV_CODEC_ID_IFF_BYTERUN1 AV_CODEC_ID_IFF_ILBM
338 AV_CODEC_ID_A64_MULTI,
339 AV_CODEC_ID_A64_MULTI5,
342 AV_CODEC_ID_LAGARITH,
346 AV_CODEC_ID_WMV3IMAGE,
347 AV_CODEC_ID_VC1IMAGE,
349 AV_CODEC_ID_BMV_VIDEO,
356 AV_CODEC_ID_ZEROCODEC,
365 AV_CODEC_ID_ESCAPE130,
368 AV_CODEC_ID_HNM4_VIDEO,
370 #define AV_CODEC_ID_H265 AV_CODEC_ID_HEVC
372 AV_CODEC_ID_ALIAS_PIX,
373 AV_CODEC_ID_BRENDER_PIX,
374 AV_CODEC_ID_PAF_VIDEO,
387 AV_CODEC_ID_SCREENPRESSO,
390 AV_CODEC_ID_Y41P = 0x8000,
395 AV_CODEC_ID_TARGA_Y216,
407 AV_CODEC_ID_TRUEMOTION2RT,
409 AV_CODEC_ID_MAGICYUV,
410 AV_CODEC_ID_SHEERVIDEO,
413 /* various PCM "codecs" */
414 AV_CODEC_ID_FIRST_AUDIO = 0x10000, ///< A dummy id pointing at the start of audio codecs
415 AV_CODEC_ID_PCM_S16LE = 0x10000,
416 AV_CODEC_ID_PCM_S16BE,
417 AV_CODEC_ID_PCM_U16LE,
418 AV_CODEC_ID_PCM_U16BE,
421 AV_CODEC_ID_PCM_MULAW,
422 AV_CODEC_ID_PCM_ALAW,
423 AV_CODEC_ID_PCM_S32LE,
424 AV_CODEC_ID_PCM_S32BE,
425 AV_CODEC_ID_PCM_U32LE,
426 AV_CODEC_ID_PCM_U32BE,
427 AV_CODEC_ID_PCM_S24LE,
428 AV_CODEC_ID_PCM_S24BE,
429 AV_CODEC_ID_PCM_U24LE,
430 AV_CODEC_ID_PCM_U24BE,
431 AV_CODEC_ID_PCM_S24DAUD,
432 AV_CODEC_ID_PCM_ZORK,
433 AV_CODEC_ID_PCM_S16LE_PLANAR,
435 AV_CODEC_ID_PCM_F32BE,
436 AV_CODEC_ID_PCM_F32LE,
437 AV_CODEC_ID_PCM_F64BE,
438 AV_CODEC_ID_PCM_F64LE,
439 AV_CODEC_ID_PCM_BLURAY,
442 AV_CODEC_ID_PCM_S8_PLANAR,
443 AV_CODEC_ID_PCM_S24LE_PLANAR,
444 AV_CODEC_ID_PCM_S32LE_PLANAR,
445 AV_CODEC_ID_PCM_S16BE_PLANAR,
446 /* new PCM "codecs" should be added right below this line starting with
447 * an explicit value of for example 0x10800
450 /* various ADPCM codecs */
451 AV_CODEC_ID_ADPCM_IMA_QT = 0x11000,
452 AV_CODEC_ID_ADPCM_IMA_WAV,
453 AV_CODEC_ID_ADPCM_IMA_DK3,
454 AV_CODEC_ID_ADPCM_IMA_DK4,
455 AV_CODEC_ID_ADPCM_IMA_WS,
456 AV_CODEC_ID_ADPCM_IMA_SMJPEG,
457 AV_CODEC_ID_ADPCM_MS,
458 AV_CODEC_ID_ADPCM_4XM,
459 AV_CODEC_ID_ADPCM_XA,
460 AV_CODEC_ID_ADPCM_ADX,
461 AV_CODEC_ID_ADPCM_EA,
462 AV_CODEC_ID_ADPCM_G726,
463 AV_CODEC_ID_ADPCM_CT,
464 AV_CODEC_ID_ADPCM_SWF,
465 AV_CODEC_ID_ADPCM_YAMAHA,
466 AV_CODEC_ID_ADPCM_SBPRO_4,
467 AV_CODEC_ID_ADPCM_SBPRO_3,
468 AV_CODEC_ID_ADPCM_SBPRO_2,
469 AV_CODEC_ID_ADPCM_THP,
470 AV_CODEC_ID_ADPCM_IMA_AMV,
471 AV_CODEC_ID_ADPCM_EA_R1,
472 AV_CODEC_ID_ADPCM_EA_R3,
473 AV_CODEC_ID_ADPCM_EA_R2,
474 AV_CODEC_ID_ADPCM_IMA_EA_SEAD,
475 AV_CODEC_ID_ADPCM_IMA_EA_EACS,
476 AV_CODEC_ID_ADPCM_EA_XAS,
477 AV_CODEC_ID_ADPCM_EA_MAXIS_XA,
478 AV_CODEC_ID_ADPCM_IMA_ISS,
479 AV_CODEC_ID_ADPCM_G722,
480 AV_CODEC_ID_ADPCM_IMA_APC,
481 AV_CODEC_ID_ADPCM_VIMA,
482 #if FF_API_VIMA_DECODER
483 AV_CODEC_ID_VIMA = AV_CODEC_ID_ADPCM_VIMA,
486 AV_CODEC_ID_ADPCM_AFC = 0x11800,
487 AV_CODEC_ID_ADPCM_IMA_OKI,
488 AV_CODEC_ID_ADPCM_DTK,
489 AV_CODEC_ID_ADPCM_IMA_RAD,
490 AV_CODEC_ID_ADPCM_G726LE,
491 AV_CODEC_ID_ADPCM_THP_LE,
492 AV_CODEC_ID_ADPCM_PSX,
493 AV_CODEC_ID_ADPCM_AICA,
494 AV_CODEC_ID_ADPCM_IMA_DAT4,
495 AV_CODEC_ID_ADPCM_MTAF,
498 AV_CODEC_ID_AMR_NB = 0x12000,
501 /* RealAudio codecs*/
502 AV_CODEC_ID_RA_144 = 0x13000,
505 /* various DPCM codecs */
506 AV_CODEC_ID_ROQ_DPCM = 0x14000,
507 AV_CODEC_ID_INTERPLAY_DPCM,
508 AV_CODEC_ID_XAN_DPCM,
509 AV_CODEC_ID_SOL_DPCM,
511 AV_CODEC_ID_SDX2_DPCM = 0x14800,
514 AV_CODEC_ID_MP2 = 0x15000,
515 AV_CODEC_ID_MP3, ///< preferred ID for decoding MPEG audio layer 1, 2 or 3
525 AV_CODEC_ID_VMDAUDIO,
531 AV_CODEC_ID_WESTWOOD_SND1,
532 AV_CODEC_ID_GSM, ///< as in Berlin toast format
535 AV_CODEC_ID_TRUESPEECH,
537 AV_CODEC_ID_SMACKAUDIO,
540 AV_CODEC_ID_DSICINAUDIO,
542 AV_CODEC_ID_MUSEPACK7,
544 AV_CODEC_ID_GSM_MS, /* as found in WAV */
550 AV_CODEC_ID_NELLYMOSER,
551 AV_CODEC_ID_MUSEPACK8,
553 AV_CODEC_ID_WMAVOICE,
555 AV_CODEC_ID_WMALOSSLESS,
564 AV_CODEC_ID_BINKAUDIO_RDFT,
565 AV_CODEC_ID_BINKAUDIO_DCT,
566 AV_CODEC_ID_AAC_LATM,
571 AV_CODEC_ID_8SVX_EXP,
572 AV_CODEC_ID_8SVX_FIB,
573 AV_CODEC_ID_BMV_AUDIO,
578 AV_CODEC_ID_COMFORT_NOISE,
580 AV_CODEC_ID_METASOUND,
581 AV_CODEC_ID_PAF_AUDIO,
585 AV_CODEC_ID_FFWAVESYNTH = 0x15800,
587 AV_CODEC_ID_SONIC_LS,
590 AV_CODEC_ID_DSD_LSBF,
591 AV_CODEC_ID_DSD_MSBF,
592 AV_CODEC_ID_DSD_LSBF_PLANAR,
593 AV_CODEC_ID_DSD_MSBF_PLANAR,
595 AV_CODEC_ID_INTERPLAY_ACM,
600 /* subtitle codecs */
601 AV_CODEC_ID_FIRST_SUBTITLE = 0x17000, ///< A dummy ID pointing at the start of subtitle codecs.
602 AV_CODEC_ID_DVD_SUBTITLE = 0x17000,
603 AV_CODEC_ID_DVB_SUBTITLE,
604 AV_CODEC_ID_TEXT, ///< raw UTF-8 text
607 AV_CODEC_ID_MOV_TEXT,
608 AV_CODEC_ID_HDMV_PGS_SUBTITLE,
609 AV_CODEC_ID_DVB_TELETEXT,
612 AV_CODEC_ID_MICRODVD = 0x17800,
616 AV_CODEC_ID_REALTEXT,
618 AV_CODEC_ID_SUBVIEWER1,
619 AV_CODEC_ID_SUBVIEWER,
626 AV_CODEC_ID_HDMV_TEXT_SUBTITLE,
628 /* other specific kind of codecs (generally used for attachments) */
629 AV_CODEC_ID_FIRST_UNKNOWN = 0x18000, ///< A dummy ID pointing at the start of various fake codecs.
630 AV_CODEC_ID_TTF = 0x18000,
632 AV_CODEC_ID_BINTEXT = 0x18800,
636 AV_CODEC_ID_SMPTE_KLV,
638 AV_CODEC_ID_TIMED_ID3,
639 AV_CODEC_ID_BIN_DATA,
642 AV_CODEC_ID_PROBE = 0x19000, ///< codec_id is not known (like AV_CODEC_ID_NONE) but lavf should attempt to identify it
644 AV_CODEC_ID_MPEG2TS = 0x20000, /**< _FAKE_ codec to indicate a raw MPEG-2 TS
645 * stream (only used by libavformat) */
646 AV_CODEC_ID_MPEG4SYSTEMS = 0x20001, /**< _FAKE_ codec to indicate a MPEG-4 Systems
647 * stream (only used by libavformat) */
648 AV_CODEC_ID_FFMETADATA = 0x21000, ///< Dummy codec for streams containing only metadata information.
649 AV_CODEC_ID_WRAPPED_AVFRAME = 0x21001, ///< Passthrough codec, AVFrames wrapped in AVPacket
653 * This struct describes the properties of a single codec described by an
655 * @see avcodec_descriptor_get()
657 typedef struct AVCodecDescriptor {
659 enum AVMediaType type;
661 * Name of the codec described by this descriptor. It is non-empty and
662 * unique for each codec descriptor. It should contain alphanumeric
663 * characters and '_' only.
667 * A more descriptive name for this codec. May be NULL.
669 const char *long_name;
671 * Codec properties, a combination of AV_CODEC_PROP_* flags.
675 * MIME type(s) associated with the codec.
676 * May be NULL; if not, a NULL-terminated array of MIME types.
677 * The first item is always non-NULL and is the preferred MIME type.
679 const char *const *mime_types;
681 * If non-NULL, an array of profiles recognized for this codec.
682 * Terminated with FF_PROFILE_UNKNOWN.
684 const struct AVProfile *profiles;
688 * Codec uses only intra compression.
691 #define AV_CODEC_PROP_INTRA_ONLY (1 << 0)
693 * Codec supports lossy compression. Audio and video codecs only.
694 * @note a codec may support both lossy and lossless
697 #define AV_CODEC_PROP_LOSSY (1 << 1)
699 * Codec supports lossless compression. Audio and video codecs only.
701 #define AV_CODEC_PROP_LOSSLESS (1 << 2)
703 * Codec supports frame reordering. That is, the coded order (the order in which
704 * the encoded packets are output by the encoders / stored / input to the
705 * decoders) may be different from the presentation order of the corresponding
708 * For codecs that do not have this property set, PTS and DTS should always be
711 #define AV_CODEC_PROP_REORDER (1 << 3)
713 * Subtitle codec is bitmap based
714 * Decoded AVSubtitle data can be read from the AVSubtitleRect->pict field.
716 #define AV_CODEC_PROP_BITMAP_SUB (1 << 16)
718 * Subtitle codec is text based.
719 * Decoded AVSubtitle data can be read from the AVSubtitleRect->ass field.
721 #define AV_CODEC_PROP_TEXT_SUB (1 << 17)
724 * @ingroup lavc_decoding
725 * Required number of additionally allocated bytes at the end of the input bitstream for decoding.
726 * This is mainly needed because some optimized bitstream readers read
727 * 32 or 64 bit at once and could read over the end.<br>
728 * Note: If the first 23 bits of the additional bytes are not 0, then damaged
729 * MPEG bitstreams could cause overread and segfault.
731 #define AV_INPUT_BUFFER_PADDING_SIZE 32
734 * @ingroup lavc_encoding
735 * minimum encoding buffer size
736 * Used to avoid some checks during header writing.
738 #define AV_INPUT_BUFFER_MIN_SIZE 16384
740 #if FF_API_WITHOUT_PREFIX
742 * @deprecated use AV_INPUT_BUFFER_PADDING_SIZE instead
744 #define FF_INPUT_BUFFER_PADDING_SIZE 32
747 * @deprecated use AV_INPUT_BUFFER_MIN_SIZE instead
749 #define FF_MIN_BUFFER_SIZE 16384
750 #endif /* FF_API_WITHOUT_PREFIX */
753 * @ingroup lavc_encoding
754 * motion estimation type.
755 * @deprecated use codec private option instead
757 #if FF_API_MOTION_EST
759 ME_ZERO = 1, ///< no search, that is use 0,0 vector whenever one is needed
763 ME_EPZS, ///< enhanced predictive zonal search
764 ME_X1, ///< reserved for experiments
765 ME_HEX, ///< hexagon based search
766 ME_UMH, ///< uneven multi-hexagon search
767 ME_TESA, ///< transformed exhaustive search algorithm
768 ME_ITER=50, ///< iterative search
773 * @ingroup lavc_decoding
776 /* We leave some space between them for extensions (drop some
777 * keyframes for intra-only or drop just some bidir frames). */
778 AVDISCARD_NONE =-16, ///< discard nothing
779 AVDISCARD_DEFAULT = 0, ///< discard useless packets like 0 size packets in avi
780 AVDISCARD_NONREF = 8, ///< discard all non reference
781 AVDISCARD_BIDIR = 16, ///< discard all bidirectional frames
782 AVDISCARD_NONINTRA= 24, ///< discard all non intra frames
783 AVDISCARD_NONKEY = 32, ///< discard all frames except keyframes
784 AVDISCARD_ALL = 48, ///< discard all
787 enum AVAudioServiceType {
788 AV_AUDIO_SERVICE_TYPE_MAIN = 0,
789 AV_AUDIO_SERVICE_TYPE_EFFECTS = 1,
790 AV_AUDIO_SERVICE_TYPE_VISUALLY_IMPAIRED = 2,
791 AV_AUDIO_SERVICE_TYPE_HEARING_IMPAIRED = 3,
792 AV_AUDIO_SERVICE_TYPE_DIALOGUE = 4,
793 AV_AUDIO_SERVICE_TYPE_COMMENTARY = 5,
794 AV_AUDIO_SERVICE_TYPE_EMERGENCY = 6,
795 AV_AUDIO_SERVICE_TYPE_VOICE_OVER = 7,
796 AV_AUDIO_SERVICE_TYPE_KARAOKE = 8,
797 AV_AUDIO_SERVICE_TYPE_NB , ///< Not part of ABI
801 * @ingroup lavc_encoding
803 typedef struct RcOverride{
806 int qscale; // If this is 0 then quality_factor will be used instead.
807 float quality_factor;
810 #if FF_API_MAX_BFRAMES
812 * @deprecated there is no libavcodec-wide limit on the number of B-frames
814 #define FF_MAX_B_FRAMES 16
818 These flags can be passed in AVCodecContext.flags before initialization.
819 Note: Not everything is supported yet.
823 * Allow decoders to produce frames with data planes that are not aligned
824 * to CPU requirements (e.g. due to cropping).
826 #define AV_CODEC_FLAG_UNALIGNED (1 << 0)
830 #define AV_CODEC_FLAG_QSCALE (1 << 1)
832 * 4 MV per MB allowed / advanced prediction for H.263.
834 #define AV_CODEC_FLAG_4MV (1 << 2)
836 * Output even those frames that might be corrupted.
838 #define AV_CODEC_FLAG_OUTPUT_CORRUPT (1 << 3)
842 #define AV_CODEC_FLAG_QPEL (1 << 4)
844 * Use internal 2pass ratecontrol in first pass mode.
846 #define AV_CODEC_FLAG_PASS1 (1 << 9)
848 * Use internal 2pass ratecontrol in second pass mode.
850 #define AV_CODEC_FLAG_PASS2 (1 << 10)
854 #define AV_CODEC_FLAG_LOOP_FILTER (1 << 11)
856 * Only decode/encode grayscale.
858 #define AV_CODEC_FLAG_GRAY (1 << 13)
860 * error[?] variables will be set during encoding.
862 #define AV_CODEC_FLAG_PSNR (1 << 15)
864 * Input bitstream might be truncated at a random location
865 * instead of only at frame boundaries.
867 #define AV_CODEC_FLAG_TRUNCATED (1 << 16)
869 * Use interlaced DCT.
871 #define AV_CODEC_FLAG_INTERLACED_DCT (1 << 18)
875 #define AV_CODEC_FLAG_LOW_DELAY (1 << 19)
877 * Place global headers in extradata instead of every keyframe.
879 #define AV_CODEC_FLAG_GLOBAL_HEADER (1 << 22)
881 * Use only bitexact stuff (except (I)DCT).
883 #define AV_CODEC_FLAG_BITEXACT (1 << 23)
884 /* Fx : Flag for H.263+ extra options */
886 * H.263 advanced intra coding / MPEG-4 AC prediction
888 #define AV_CODEC_FLAG_AC_PRED (1 << 24)
890 * interlaced motion estimation
892 #define AV_CODEC_FLAG_INTERLACED_ME (1 << 29)
893 #define AV_CODEC_FLAG_CLOSED_GOP (1U << 31)
896 * Allow non spec compliant speedup tricks.
898 #define AV_CODEC_FLAG2_FAST (1 << 0)
900 * Skip bitstream encoding.
902 #define AV_CODEC_FLAG2_NO_OUTPUT (1 << 2)
904 * Place global headers at every keyframe instead of in extradata.
906 #define AV_CODEC_FLAG2_LOCAL_HEADER (1 << 3)
909 * timecode is in drop frame format. DEPRECATED!!!!
911 #define AV_CODEC_FLAG2_DROP_FRAME_TIMECODE (1 << 13)
914 * Input bitstream might be truncated at a packet boundaries
915 * instead of only at frame boundaries.
917 #define AV_CODEC_FLAG2_CHUNKS (1 << 15)
919 * Discard cropping information from SPS.
921 #define AV_CODEC_FLAG2_IGNORE_CROP (1 << 16)
924 * Show all frames before the first keyframe
926 #define AV_CODEC_FLAG2_SHOW_ALL (1 << 22)
928 * Export motion vectors through frame side data
930 #define AV_CODEC_FLAG2_EXPORT_MVS (1 << 28)
932 * Do not skip samples and export skip information as frame side data
934 #define AV_CODEC_FLAG2_SKIP_MANUAL (1 << 29)
936 * Do not reset ASS ReadOrder field on flush (subtitles decoding)
938 #define AV_CODEC_FLAG2_RO_FLUSH_NOOP (1 << 30)
940 /* Unsupported options :
941 * Syntax Arithmetic coding (SAC)
942 * Reference Picture Selection
943 * Independent Segment Decoding */
945 /* codec capabilities */
948 * Decoder can use draw_horiz_band callback.
950 #define AV_CODEC_CAP_DRAW_HORIZ_BAND (1 << 0)
952 * Codec uses get_buffer() for allocating buffers and supports custom allocators.
953 * If not set, it might not use get_buffer() at all or use operations that
954 * assume the buffer was allocated by avcodec_default_get_buffer.
956 #define AV_CODEC_CAP_DR1 (1 << 1)
957 #define AV_CODEC_CAP_TRUNCATED (1 << 3)
959 * Encoder or decoder requires flushing with NULL input at the end in order to
960 * give the complete and correct output.
962 * NOTE: If this flag is not set, the codec is guaranteed to never be fed with
963 * with NULL data. The user can still send NULL data to the public encode
964 * or decode function, but libavcodec will not pass it along to the codec
965 * unless this flag is set.
968 * The decoder has a non-zero delay and needs to be fed with avpkt->data=NULL,
969 * avpkt->size=0 at the end to get the delayed data until the decoder no longer
973 * The encoder needs to be fed with NULL data at the end of encoding until the
974 * encoder no longer returns data.
976 * NOTE: For encoders implementing the AVCodec.encode2() function, setting this
977 * flag also means that the encoder must set the pts and duration for
978 * each output packet. If this flag is not set, the pts and duration will
979 * be determined by libavcodec from the input frame.
981 #define AV_CODEC_CAP_DELAY (1 << 5)
983 * Codec can be fed a final frame with a smaller size.
984 * This can be used to prevent truncation of the last audio samples.
986 #define AV_CODEC_CAP_SMALL_LAST_FRAME (1 << 6)
990 * Codec can export data for HW decoding (VDPAU).
992 #define AV_CODEC_CAP_HWACCEL_VDPAU (1 << 7)
996 * Codec can output multiple frames per AVPacket
997 * Normally demuxers return one frame at a time, demuxers which do not do
998 * are connected to a parser to split what they return into proper frames.
999 * This flag is reserved to the very rare category of codecs which have a
1000 * bitstream that cannot be split into frames without timeconsuming
1001 * operations like full decoding. Demuxers carrying such bitstreams thus
1002 * may return multiple frames in a packet. This has many disadvantages like
1003 * prohibiting stream copy in many cases thus it should only be considered
1006 #define AV_CODEC_CAP_SUBFRAMES (1 << 8)
1008 * Codec is experimental and is thus avoided in favor of non experimental
1011 #define AV_CODEC_CAP_EXPERIMENTAL (1 << 9)
1013 * Codec should fill in channel configuration and samplerate instead of container
1015 #define AV_CODEC_CAP_CHANNEL_CONF (1 << 10)
1017 * Codec supports frame-level multithreading.
1019 #define AV_CODEC_CAP_FRAME_THREADS (1 << 12)
1021 * Codec supports slice-based (or partition-based) multithreading.
1023 #define AV_CODEC_CAP_SLICE_THREADS (1 << 13)
1025 * Codec supports changed parameters at any point.
1027 #define AV_CODEC_CAP_PARAM_CHANGE (1 << 14)
1029 * Codec supports avctx->thread_count == 0 (auto).
1031 #define AV_CODEC_CAP_AUTO_THREADS (1 << 15)
1033 * Audio encoder supports receiving a different number of samples in each call.
1035 #define AV_CODEC_CAP_VARIABLE_FRAME_SIZE (1 << 16)
1037 * Codec is intra only.
1039 #define AV_CODEC_CAP_INTRA_ONLY 0x40000000
1041 * Codec is lossless.
1043 #define AV_CODEC_CAP_LOSSLESS 0x80000000
1046 #if FF_API_WITHOUT_PREFIX
1048 * Allow decoders to produce frames with data planes that are not aligned
1049 * to CPU requirements (e.g. due to cropping).
1051 #define CODEC_FLAG_UNALIGNED AV_CODEC_FLAG_UNALIGNED
1052 #define CODEC_FLAG_QSCALE AV_CODEC_FLAG_QSCALE
1053 #define CODEC_FLAG_4MV AV_CODEC_FLAG_4MV
1054 #define CODEC_FLAG_OUTPUT_CORRUPT AV_CODEC_FLAG_OUTPUT_CORRUPT
1055 #define CODEC_FLAG_QPEL AV_CODEC_FLAG_QPEL
1058 * @deprecated use the "gmc" private option of the libxvid encoder
1060 #define CODEC_FLAG_GMC 0x0020 ///< Use GMC.
1064 * @deprecated use the flag "mv0" in the "mpv_flags" private option of the
1065 * mpegvideo encoders
1067 #define CODEC_FLAG_MV0 0x0040
1069 #if FF_API_INPUT_PRESERVED
1071 * @deprecated passing reference-counted frames to the encoders replaces this
1074 #define CODEC_FLAG_INPUT_PRESERVED 0x0100
1076 #define CODEC_FLAG_PASS1 AV_CODEC_FLAG_PASS1
1077 #define CODEC_FLAG_PASS2 AV_CODEC_FLAG_PASS2
1078 #define CODEC_FLAG_GRAY AV_CODEC_FLAG_GRAY
1081 * @deprecated edges are not used/required anymore. I.e. this flag is now always
1084 #define CODEC_FLAG_EMU_EDGE 0x4000
1086 #define CODEC_FLAG_PSNR AV_CODEC_FLAG_PSNR
1087 #define CODEC_FLAG_TRUNCATED AV_CODEC_FLAG_TRUNCATED
1089 #if FF_API_NORMALIZE_AQP
1091 * @deprecated use the flag "naq" in the "mpv_flags" private option of the
1092 * mpegvideo encoders
1094 #define CODEC_FLAG_NORMALIZE_AQP 0x00020000
1096 #define CODEC_FLAG_INTERLACED_DCT AV_CODEC_FLAG_INTERLACED_DCT
1097 #define CODEC_FLAG_LOW_DELAY AV_CODEC_FLAG_LOW_DELAY
1098 #define CODEC_FLAG_GLOBAL_HEADER AV_CODEC_FLAG_GLOBAL_HEADER
1099 #define CODEC_FLAG_BITEXACT AV_CODEC_FLAG_BITEXACT
1100 #define CODEC_FLAG_AC_PRED AV_CODEC_FLAG_AC_PRED
1101 #define CODEC_FLAG_LOOP_FILTER AV_CODEC_FLAG_LOOP_FILTER
1102 #define CODEC_FLAG_INTERLACED_ME AV_CODEC_FLAG_INTERLACED_ME
1103 #define CODEC_FLAG_CLOSED_GOP AV_CODEC_FLAG_CLOSED_GOP
1104 #define CODEC_FLAG2_FAST AV_CODEC_FLAG2_FAST
1105 #define CODEC_FLAG2_NO_OUTPUT AV_CODEC_FLAG2_NO_OUTPUT
1106 #define CODEC_FLAG2_LOCAL_HEADER AV_CODEC_FLAG2_LOCAL_HEADER
1107 #define CODEC_FLAG2_DROP_FRAME_TIMECODE AV_CODEC_FLAG2_DROP_FRAME_TIMECODE
1108 #define CODEC_FLAG2_IGNORE_CROP AV_CODEC_FLAG2_IGNORE_CROP
1110 #define CODEC_FLAG2_CHUNKS AV_CODEC_FLAG2_CHUNKS
1111 #define CODEC_FLAG2_SHOW_ALL AV_CODEC_FLAG2_SHOW_ALL
1112 #define CODEC_FLAG2_EXPORT_MVS AV_CODEC_FLAG2_EXPORT_MVS
1113 #define CODEC_FLAG2_SKIP_MANUAL AV_CODEC_FLAG2_SKIP_MANUAL
1115 /* Unsupported options :
1116 * Syntax Arithmetic coding (SAC)
1117 * Reference Picture Selection
1118 * Independent Segment Decoding */
1120 /* codec capabilities */
1122 #define CODEC_CAP_DRAW_HORIZ_BAND AV_CODEC_CAP_DRAW_HORIZ_BAND ///< Decoder can use draw_horiz_band callback.
1124 * Codec uses get_buffer() for allocating buffers and supports custom allocators.
1125 * If not set, it might not use get_buffer() at all or use operations that
1126 * assume the buffer was allocated by avcodec_default_get_buffer.
1128 #define CODEC_CAP_DR1 AV_CODEC_CAP_DR1
1129 #define CODEC_CAP_TRUNCATED AV_CODEC_CAP_TRUNCATED
1131 /* Codec can export data for HW decoding. This flag indicates that
1132 * the codec would call get_format() with list that might contain HW accelerated
1133 * pixel formats (XvMC, VDPAU, VAAPI, etc). The application can pick any of them
1134 * including raw image format.
1135 * The application can use the passed context to determine bitstream version,
1136 * chroma format, resolution etc.
1138 #define CODEC_CAP_HWACCEL 0x0010
1139 #endif /* FF_API_XVMC */
1141 * Encoder or decoder requires flushing with NULL input at the end in order to
1142 * give the complete and correct output.
1144 * NOTE: If this flag is not set, the codec is guaranteed to never be fed with
1145 * with NULL data. The user can still send NULL data to the public encode
1146 * or decode function, but libavcodec will not pass it along to the codec
1147 * unless this flag is set.
1150 * The decoder has a non-zero delay and needs to be fed with avpkt->data=NULL,
1151 * avpkt->size=0 at the end to get the delayed data until the decoder no longer
1155 * The encoder needs to be fed with NULL data at the end of encoding until the
1156 * encoder no longer returns data.
1158 * NOTE: For encoders implementing the AVCodec.encode2() function, setting this
1159 * flag also means that the encoder must set the pts and duration for
1160 * each output packet. If this flag is not set, the pts and duration will
1161 * be determined by libavcodec from the input frame.
1163 #define CODEC_CAP_DELAY AV_CODEC_CAP_DELAY
1165 * Codec can be fed a final frame with a smaller size.
1166 * This can be used to prevent truncation of the last audio samples.
1168 #define CODEC_CAP_SMALL_LAST_FRAME AV_CODEC_CAP_SMALL_LAST_FRAME
1169 #if FF_API_CAP_VDPAU
1171 * Codec can export data for HW decoding (VDPAU).
1173 #define CODEC_CAP_HWACCEL_VDPAU AV_CODEC_CAP_HWACCEL_VDPAU
1176 * Codec can output multiple frames per AVPacket
1177 * Normally demuxers return one frame at a time, demuxers which do not do
1178 * are connected to a parser to split what they return into proper frames.
1179 * This flag is reserved to the very rare category of codecs which have a
1180 * bitstream that cannot be split into frames without timeconsuming
1181 * operations like full decoding. Demuxers carrying such bitstreams thus
1182 * may return multiple frames in a packet. This has many disadvantages like
1183 * prohibiting stream copy in many cases thus it should only be considered
1186 #define CODEC_CAP_SUBFRAMES AV_CODEC_CAP_SUBFRAMES
1188 * Codec is experimental and is thus avoided in favor of non experimental
1191 #define CODEC_CAP_EXPERIMENTAL AV_CODEC_CAP_EXPERIMENTAL
1193 * Codec should fill in channel configuration and samplerate instead of container
1195 #define CODEC_CAP_CHANNEL_CONF AV_CODEC_CAP_CHANNEL_CONF
1196 #if FF_API_NEG_LINESIZES
1198 * @deprecated no codecs use this capability
1200 #define CODEC_CAP_NEG_LINESIZES 0x0800
1203 * Codec supports frame-level multithreading.
1205 #define CODEC_CAP_FRAME_THREADS AV_CODEC_CAP_FRAME_THREADS
1207 * Codec supports slice-based (or partition-based) multithreading.
1209 #define CODEC_CAP_SLICE_THREADS AV_CODEC_CAP_SLICE_THREADS
1211 * Codec supports changed parameters at any point.
1213 #define CODEC_CAP_PARAM_CHANGE AV_CODEC_CAP_PARAM_CHANGE
1215 * Codec supports avctx->thread_count == 0 (auto).
1217 #define CODEC_CAP_AUTO_THREADS AV_CODEC_CAP_AUTO_THREADS
1219 * Audio encoder supports receiving a different number of samples in each call.
1221 #define CODEC_CAP_VARIABLE_FRAME_SIZE AV_CODEC_CAP_VARIABLE_FRAME_SIZE
1223 * Codec is intra only.
1225 #define CODEC_CAP_INTRA_ONLY AV_CODEC_CAP_INTRA_ONLY
1227 * Codec is lossless.
1229 #define CODEC_CAP_LOSSLESS AV_CODEC_CAP_LOSSLESS
1232 * HWAccel is experimental and is thus avoided in favor of non experimental
1235 #define HWACCEL_CODEC_CAP_EXPERIMENTAL 0x0200
1236 #endif /* FF_API_WITHOUT_PREFIX */
1239 //The following defines may change, don't expect compatibility if you use them.
1240 #define MB_TYPE_INTRA4x4 0x0001
1241 #define MB_TYPE_INTRA16x16 0x0002 //FIXME H.264-specific
1242 #define MB_TYPE_INTRA_PCM 0x0004 //FIXME H.264-specific
1243 #define MB_TYPE_16x16 0x0008
1244 #define MB_TYPE_16x8 0x0010
1245 #define MB_TYPE_8x16 0x0020
1246 #define MB_TYPE_8x8 0x0040
1247 #define MB_TYPE_INTERLACED 0x0080
1248 #define MB_TYPE_DIRECT2 0x0100 //FIXME
1249 #define MB_TYPE_ACPRED 0x0200
1250 #define MB_TYPE_GMC 0x0400
1251 #define MB_TYPE_SKIP 0x0800
1252 #define MB_TYPE_P0L0 0x1000
1253 #define MB_TYPE_P1L0 0x2000
1254 #define MB_TYPE_P0L1 0x4000
1255 #define MB_TYPE_P1L1 0x8000
1256 #define MB_TYPE_L0 (MB_TYPE_P0L0 | MB_TYPE_P1L0)
1257 #define MB_TYPE_L1 (MB_TYPE_P0L1 | MB_TYPE_P1L1)
1258 #define MB_TYPE_L0L1 (MB_TYPE_L0 | MB_TYPE_L1)
1259 #define MB_TYPE_QUANT 0x00010000
1260 #define MB_TYPE_CBP 0x00020000
1261 // Note bits 24-31 are reserved for codec specific use (H.264 ref0, MPEG-1 0mv, ...)
1266 * This specifies the area which should be displayed.
1267 * Note there may be multiple such areas for one frame.
1269 typedef struct AVPanScan{
1272 * - encoding: Set by user.
1273 * - decoding: Set by libavcodec.
1278 * width and height in 1/16 pel
1279 * - encoding: Set by user.
1280 * - decoding: Set by libavcodec.
1286 * position of the top left corner in 1/16 pel for up to 3 fields/frames
1287 * - encoding: Set by user.
1288 * - decoding: Set by libavcodec.
1290 int16_t position[3][2];
1294 * This structure describes the bitrate properties of an encoded bitstream. It
1295 * roughly corresponds to a subset the VBV parameters for MPEG-2 or HRD
1296 * parameters for H.264/HEVC.
1298 typedef struct AVCPBProperties {
1300 * Maximum bitrate of the stream, in bits per second.
1301 * Zero if unknown or unspecified.
1305 * Minimum bitrate of the stream, in bits per second.
1306 * Zero if unknown or unspecified.
1310 * Average bitrate of the stream, in bits per second.
1311 * Zero if unknown or unspecified.
1316 * The size of the buffer to which the ratecontrol is applied, in bits.
1317 * Zero if unknown or unspecified.
1322 * The delay between the time the packet this structure is associated with
1323 * is received and the time when it should be decoded, in periods of a 27MHz
1326 * UINT64_MAX when unknown or unspecified.
1331 #if FF_API_QSCALE_TYPE
1332 #define FF_QSCALE_TYPE_MPEG1 0
1333 #define FF_QSCALE_TYPE_MPEG2 1
1334 #define FF_QSCALE_TYPE_H264 2
1335 #define FF_QSCALE_TYPE_VP56 3
1339 * The decoder will keep a reference to the frame and may reuse it later.
1341 #define AV_GET_BUFFER_FLAG_REF (1 << 0)
1344 * @defgroup lavc_packet AVPacket
1346 * Types and functions for working with AVPacket.
1349 enum AVPacketSideDataType {
1350 AV_PKT_DATA_PALETTE,
1351 AV_PKT_DATA_NEW_EXTRADATA,
1354 * An AV_PKT_DATA_PARAM_CHANGE side data packet is laid out as follows:
1357 * if (param_flags & AV_SIDE_DATA_PARAM_CHANGE_CHANNEL_COUNT)
1358 * s32le channel_count
1359 * if (param_flags & AV_SIDE_DATA_PARAM_CHANGE_CHANNEL_LAYOUT)
1360 * u64le channel_layout
1361 * if (param_flags & AV_SIDE_DATA_PARAM_CHANGE_SAMPLE_RATE)
1363 * if (param_flags & AV_SIDE_DATA_PARAM_CHANGE_DIMENSIONS)
1368 AV_PKT_DATA_PARAM_CHANGE,
1371 * An AV_PKT_DATA_H263_MB_INFO side data packet contains a number of
1372 * structures with info about macroblocks relevant to splitting the
1373 * packet into smaller packets on macroblock edges (e.g. as for RFC 2190).
1374 * That is, it does not necessarily contain info about all macroblocks,
1375 * as long as the distance between macroblocks in the info is smaller
1376 * than the target payload size.
1377 * Each MB info structure is 12 bytes, and is laid out as follows:
1379 * u32le bit offset from the start of the packet
1380 * u8 current quantizer at the start of the macroblock
1382 * u16le macroblock address within the GOB
1383 * u8 horizontal MV predictor
1384 * u8 vertical MV predictor
1385 * u8 horizontal MV predictor for block number 3
1386 * u8 vertical MV predictor for block number 3
1389 AV_PKT_DATA_H263_MB_INFO,
1392 * This side data should be associated with an audio stream and contains
1393 * ReplayGain information in form of the AVReplayGain struct.
1395 AV_PKT_DATA_REPLAYGAIN,
1398 * This side data contains a 3x3 transformation matrix describing an affine
1399 * transformation that needs to be applied to the decoded video frames for
1400 * correct presentation.
1402 * See libavutil/display.h for a detailed description of the data.
1404 AV_PKT_DATA_DISPLAYMATRIX,
1407 * This side data should be associated with a video stream and contains
1408 * Stereoscopic 3D information in form of the AVStereo3D struct.
1410 AV_PKT_DATA_STEREO3D,
1413 * This side data should be associated with an audio stream and corresponds
1414 * to enum AVAudioServiceType.
1416 AV_PKT_DATA_AUDIO_SERVICE_TYPE,
1419 * This side data contains quality related information from the encoder.
1421 * u32le quality factor of the compressed frame. Allowed range is between 1 (good) and FF_LAMBDA_MAX (bad).
1425 * u64le[error count] sum of squared differences between encoder in and output
1428 AV_PKT_DATA_QUALITY_STATS,
1431 * This side data contains an integer value representing the stream index
1432 * of a "fallback" track. A fallback track indicates an alternate
1433 * track to use when the current track can not be decoded for some reason.
1434 * e.g. no decoder available for codec.
1436 AV_PKT_DATA_FALLBACK_TRACK,
1439 * This side data corresponds to the AVCPBProperties struct.
1441 AV_PKT_DATA_CPB_PROPERTIES,
1444 * Recommmends skipping the specified number of samples
1446 * u32le number of samples to skip from start of this packet
1447 * u32le number of samples to skip from end of this packet
1448 * u8 reason for start skip
1449 * u8 reason for end skip (0=padding silence, 1=convergence)
1452 AV_PKT_DATA_SKIP_SAMPLES=70,
1455 * An AV_PKT_DATA_JP_DUALMONO side data packet indicates that
1456 * the packet may contain "dual mono" audio specific to Japanese DTV
1457 * and if it is true, recommends only the selected channel to be used.
1459 * u8 selected channels (0=mail/left, 1=sub/right, 2=both)
1462 AV_PKT_DATA_JP_DUALMONO,
1465 * A list of zero terminated key/value strings. There is no end marker for
1466 * the list, so it is required to rely on the side data size to stop.
1468 AV_PKT_DATA_STRINGS_METADATA,
1471 * Subtitle event position
1479 AV_PKT_DATA_SUBTITLE_POSITION,
1482 * Data found in BlockAdditional element of matroska container. There is
1483 * no end marker for the data, so it is required to rely on the side data
1484 * size to recognize the end. 8 byte id (as found in BlockAddId) followed
1487 AV_PKT_DATA_MATROSKA_BLOCKADDITIONAL,
1490 * The optional first identifier line of a WebVTT cue.
1492 AV_PKT_DATA_WEBVTT_IDENTIFIER,
1495 * The optional settings (rendering instructions) that immediately
1496 * follow the timestamp specifier of a WebVTT cue.
1498 AV_PKT_DATA_WEBVTT_SETTINGS,
1501 * A list of zero terminated key/value strings. There is no end marker for
1502 * the list, so it is required to rely on the side data size to stop. This
1503 * side data includes updated metadata which appeared in the stream.
1505 AV_PKT_DATA_METADATA_UPDATE,
1508 * MPEGTS stream ID, this is required to pass the stream ID
1509 * information from the demuxer to the corresponding muxer.
1511 AV_PKT_DATA_MPEGTS_STREAM_ID,
1514 * Mastering display metadata (based on SMPTE-2086:2014). This metadata
1515 * should be associated with a video stream and containts data in the form
1516 * of the AVMasteringDisplayMetadata struct.
1518 AV_PKT_DATA_MASTERING_DISPLAY_METADATA
1521 #define AV_PKT_DATA_QUALITY_FACTOR AV_PKT_DATA_QUALITY_STATS //DEPRECATED
1523 typedef struct AVPacketSideData {
1526 enum AVPacketSideDataType type;
1530 * This structure stores compressed data. It is typically exported by demuxers
1531 * and then passed as input to decoders, or received as output from encoders and
1532 * then passed to muxers.
1534 * For video, it should typically contain one compressed frame. For audio it may
1535 * contain several compressed frames. Encoders are allowed to output empty
1536 * packets, with no compressed data, containing only side data
1537 * (e.g. to update some stream parameters at the end of encoding).
1539 * AVPacket is one of the few structs in FFmpeg, whose size is a part of public
1540 * ABI. Thus it may be allocated on stack and no new fields can be added to it
1541 * without libavcodec and libavformat major bump.
1543 * The semantics of data ownership depends on the buf field.
1544 * If it is set, the packet data is dynamically allocated and is
1545 * valid indefinitely until a call to av_packet_unref() reduces the
1546 * reference count to 0.
1548 * If the buf field is not set av_packet_ref() would make a copy instead
1549 * of increasing the reference count.
1551 * The side data is always allocated with av_malloc(), copied by
1552 * av_packet_ref() and freed by av_packet_unref().
1554 * @see av_packet_ref
1555 * @see av_packet_unref
1557 typedef struct AVPacket {
1559 * A reference to the reference-counted buffer where the packet data is
1561 * May be NULL, then the packet data is not reference-counted.
1565 * Presentation timestamp in AVStream->time_base units; the time at which
1566 * the decompressed packet will be presented to the user.
1567 * Can be AV_NOPTS_VALUE if it is not stored in the file.
1568 * pts MUST be larger or equal to dts as presentation cannot happen before
1569 * decompression, unless one wants to view hex dumps. Some formats misuse
1570 * the terms dts and pts/cts to mean something different. Such timestamps
1571 * must be converted to true pts/dts before they are stored in AVPacket.
1575 * Decompression timestamp in AVStream->time_base units; the time at which
1576 * the packet is decompressed.
1577 * Can be AV_NOPTS_VALUE if it is not stored in the file.
1584 * A combination of AV_PKT_FLAG values
1588 * Additional packet data that can be provided by the container.
1589 * Packet can contain several types of side information.
1591 AVPacketSideData *side_data;
1592 int side_data_elems;
1595 * Duration of this packet in AVStream->time_base units, 0 if unknown.
1596 * Equals next_pts - this_pts in presentation order.
1600 int64_t pos; ///< byte position in stream, -1 if unknown
1602 #if FF_API_CONVERGENCE_DURATION
1604 * @deprecated Same as the duration field, but as int64_t. This was required
1605 * for Matroska subtitles, whose duration values could overflow when the
1606 * duration field was still an int.
1608 attribute_deprecated
1609 int64_t convergence_duration;
1612 #define AV_PKT_FLAG_KEY 0x0001 ///< The packet contains a keyframe
1613 #define AV_PKT_FLAG_CORRUPT 0x0002 ///< The packet content is corrupted
1615 enum AVSideDataParamChangeFlags {
1616 AV_SIDE_DATA_PARAM_CHANGE_CHANNEL_COUNT = 0x0001,
1617 AV_SIDE_DATA_PARAM_CHANGE_CHANNEL_LAYOUT = 0x0002,
1618 AV_SIDE_DATA_PARAM_CHANGE_SAMPLE_RATE = 0x0004,
1619 AV_SIDE_DATA_PARAM_CHANGE_DIMENSIONS = 0x0008,
1625 struct AVCodecInternal;
1629 AV_FIELD_PROGRESSIVE,
1630 AV_FIELD_TT, //< Top coded_first, top displayed first
1631 AV_FIELD_BB, //< Bottom coded first, bottom displayed first
1632 AV_FIELD_TB, //< Top coded first, bottom displayed first
1633 AV_FIELD_BT, //< Bottom coded first, top displayed first
1637 * main external API structure.
1638 * New fields can be added to the end with minor version bumps.
1639 * Removal, reordering and changes to existing fields require a major
1641 * Please use AVOptions (av_opt* / av_set/get*()) to access these fields from user
1643 * The name string for AVOptions options matches the associated command line
1644 * parameter name and can be found in libavcodec/options_table.h
1645 * The AVOption/command line parameter names differ in some cases from the C
1646 * structure field names for historic reasons or brevity.
1647 * sizeof(AVCodecContext) must not be used outside libav*.
1649 typedef struct AVCodecContext {
1651 * information on struct for av_log
1652 * - set by avcodec_alloc_context3
1654 const AVClass *av_class;
1655 int log_level_offset;
1657 enum AVMediaType codec_type; /* see AVMEDIA_TYPE_xxx */
1658 const struct AVCodec *codec;
1659 #if FF_API_CODEC_NAME
1661 * @deprecated this field is not used for anything in libavcodec
1663 attribute_deprecated
1664 char codec_name[32];
1666 enum AVCodecID codec_id; /* see AV_CODEC_ID_xxx */
1669 * fourcc (LSB first, so "ABCD" -> ('D'<<24) + ('C'<<16) + ('B'<<8) + 'A').
1670 * This is used to work around some encoder bugs.
1671 * A demuxer should set this to what is stored in the field used to identify the codec.
1672 * If there are multiple such fields in a container then the demuxer should choose the one
1673 * which maximizes the information about the used codec.
1674 * If the codec tag field in a container is larger than 32 bits then the demuxer should
1675 * remap the longer ID to 32 bits with a table or other structure. Alternatively a new
1676 * extra_codec_tag + size could be added but for this a clear advantage must be demonstrated
1678 * - encoding: Set by user, if not then the default based on codec_id will be used.
1679 * - decoding: Set by user, will be converted to uppercase by libavcodec during init.
1681 unsigned int codec_tag;
1683 #if FF_API_STREAM_CODEC_TAG
1685 * @deprecated this field is unused
1687 attribute_deprecated
1688 unsigned int stream_codec_tag;
1694 * Private context used for internal data.
1696 * Unlike priv_data, this is not codec-specific. It is used in general
1697 * libavcodec functions.
1699 struct AVCodecInternal *internal;
1702 * Private data of the user, can be used to carry app specific stuff.
1703 * - encoding: Set by user.
1704 * - decoding: Set by user.
1709 * the average bitrate
1710 * - encoding: Set by user; unused for constant quantizer encoding.
1711 * - decoding: Set by user, may be overwritten by libavcodec
1712 * if this info is available in the stream
1717 * number of bits the bitstream is allowed to diverge from the reference.
1718 * the reference can be CBR (for CBR pass1) or VBR (for pass2)
1719 * - encoding: Set by user; unused for constant quantizer encoding.
1720 * - decoding: unused
1722 int bit_rate_tolerance;
1725 * Global quality for codecs which cannot change it per frame.
1726 * This should be proportional to MPEG-1/2/4 qscale.
1727 * - encoding: Set by user.
1728 * - decoding: unused
1733 * - encoding: Set by user.
1734 * - decoding: unused
1736 int compression_level;
1737 #define FF_COMPRESSION_DEFAULT -1
1741 * - encoding: Set by user.
1742 * - decoding: Set by user.
1748 * - encoding: Set by user.
1749 * - decoding: Set by user.
1754 * some codecs need / can use extradata like Huffman tables.
1755 * MJPEG: Huffman tables
1756 * rv10: additional flags
1757 * MPEG-4: global headers (they can be in the bitstream or here)
1758 * The allocated memory should be AV_INPUT_BUFFER_PADDING_SIZE bytes larger
1759 * than extradata_size to avoid problems if it is read with the bitstream reader.
1760 * The bytewise contents of extradata must not depend on the architecture or CPU endianness.
1761 * - encoding: Set/allocated/freed by libavcodec.
1762 * - decoding: Set/allocated/freed by user.
1768 * This is the fundamental unit of time (in seconds) in terms
1769 * of which frame timestamps are represented. For fixed-fps content,
1770 * timebase should be 1/framerate and timestamp increments should be
1772 * This often, but not always is the inverse of the frame rate or field rate
1773 * for video. 1/time_base is not the average frame rate if the frame rate is not
1776 * Like containers, elementary streams also can store timestamps, 1/time_base
1777 * is the unit in which these timestamps are specified.
1778 * As example of such codec time base see ISO/IEC 14496-2:2001(E)
1779 * vop_time_increment_resolution and fixed_vop_rate
1780 * (fixed_vop_rate == 0 implies that it is different from the framerate)
1782 * - encoding: MUST be set by user.
1783 * - decoding: the use of this field for decoding is deprecated.
1784 * Use framerate instead.
1786 AVRational time_base;
1789 * For some codecs, the time base is closer to the field rate than the frame rate.
1790 * Most notably, H.264 and MPEG-2 specify time_base as half of frame duration
1791 * if no telecine is used ...
1793 * Set to time_base ticks per frame. Default 1, e.g., H.264/MPEG-2 set it to 2.
1795 int ticks_per_frame;
1800 * Encoding: Number of frames delay there will be from the encoder input to
1801 * the decoder output. (we assume the decoder matches the spec)
1802 * Decoding: Number of frames delay in addition to what a standard decoder
1803 * as specified in the spec would produce.
1806 * Number of frames the decoded output will be delayed relative to the
1810 * For encoding, this field is unused (see initial_padding).
1812 * For decoding, this is the number of samples the decoder needs to
1813 * output before the decoder's output is valid. When seeking, you should
1814 * start decoding this many samples prior to your desired seek point.
1816 * - encoding: Set by libavcodec.
1817 * - decoding: Set by libavcodec.
1824 * picture width / height.
1826 * @note Those fields may not match the values of the last
1827 * AVFrame output by avcodec_decode_video2 due frame
1830 * - encoding: MUST be set by user.
1831 * - decoding: May be set by the user before opening the decoder if known e.g.
1832 * from the container. Some decoders will require the dimensions
1833 * to be set by the caller. During decoding, the decoder may
1834 * overwrite those values as required while parsing the data.
1839 * Bitstream width / height, may be different from width/height e.g. when
1840 * the decoded frame is cropped before being output or lowres is enabled.
1842 * @note Those field may not match the value of the last
1843 * AVFrame output by avcodec_receive_frame() due frame
1846 * - encoding: unused
1847 * - decoding: May be set by the user before opening the decoder if known
1848 * e.g. from the container. During decoding, the decoder may
1849 * overwrite those values as required while parsing the data.
1851 int coded_width, coded_height;
1853 #if FF_API_ASPECT_EXTENDED
1854 #define FF_ASPECT_EXTENDED 15
1858 * the number of pictures in a group of pictures, or 0 for intra_only
1859 * - encoding: Set by user.
1860 * - decoding: unused
1865 * Pixel format, see AV_PIX_FMT_xxx.
1866 * May be set by the demuxer if known from headers.
1867 * May be overridden by the decoder if it knows better.
1869 * @note This field may not match the value of the last
1870 * AVFrame output by avcodec_receive_frame() due frame
1873 * - encoding: Set by user.
1874 * - decoding: Set by user if known, overridden by libavcodec while
1877 enum AVPixelFormat pix_fmt;
1879 #if FF_API_MOTION_EST
1881 * This option does nothing
1882 * @deprecated use codec private options instead
1884 attribute_deprecated int me_method;
1888 * If non NULL, 'draw_horiz_band' is called by the libavcodec
1889 * decoder to draw a horizontal band. It improves cache usage. Not
1890 * all codecs can do that. You must check the codec capabilities
1892 * When multithreading is used, it may be called from multiple threads
1893 * at the same time; threads might draw different parts of the same AVFrame,
1894 * or multiple AVFrames, and there is no guarantee that slices will be drawn
1896 * The function is also used by hardware acceleration APIs.
1897 * It is called at least once during frame decoding to pass
1898 * the data needed for hardware render.
1899 * In that mode instead of pixel data, AVFrame points to
1900 * a structure specific to the acceleration API. The application
1901 * reads the structure and can change some fields to indicate progress
1903 * - encoding: unused
1904 * - decoding: Set by user.
1905 * @param height the height of the slice
1906 * @param y the y position of the slice
1907 * @param type 1->top field, 2->bottom field, 3->frame
1908 * @param offset offset into the AVFrame.data from which the slice should be read
1910 void (*draw_horiz_band)(struct AVCodecContext *s,
1911 const AVFrame *src, int offset[AV_NUM_DATA_POINTERS],
1912 int y, int type, int height);
1915 * callback to negotiate the pixelFormat
1916 * @param fmt is the list of formats which are supported by the codec,
1917 * it is terminated by -1 as 0 is a valid format, the formats are ordered by quality.
1918 * The first is always the native one.
1919 * @note The callback may be called again immediately if initialization for
1920 * the selected (hardware-accelerated) pixel format failed.
1921 * @warning Behavior is undefined if the callback returns a value not
1922 * in the fmt list of formats.
1923 * @return the chosen format
1924 * - encoding: unused
1925 * - decoding: Set by user, if not set the native format will be chosen.
1927 enum AVPixelFormat (*get_format)(struct AVCodecContext *s, const enum AVPixelFormat * fmt);
1930 * maximum number of B-frames between non-B-frames
1931 * Note: The output will be delayed by max_b_frames+1 relative to the input.
1932 * - encoding: Set by user.
1933 * - decoding: unused
1938 * qscale factor between IP and B-frames
1939 * If > 0 then the last P-frame quantizer will be used (q= lastp_q*factor+offset).
1940 * If < 0 then normal ratecontrol will be done (q= -normal_q*factor+offset).
1941 * - encoding: Set by user.
1942 * - decoding: unused
1944 float b_quant_factor;
1946 #if FF_API_RC_STRATEGY
1947 /** @deprecated use codec private option instead */
1948 attribute_deprecated int rc_strategy;
1949 #define FF_RC_STRATEGY_XVID 1
1952 #if FF_API_PRIVATE_OPT
1953 /** @deprecated use encoder private options instead */
1954 attribute_deprecated
1955 int b_frame_strategy;
1959 * qscale offset between IP and B-frames
1960 * - encoding: Set by user.
1961 * - decoding: unused
1963 float b_quant_offset;
1966 * Size of the frame reordering buffer in the decoder.
1967 * For MPEG-2 it is 1 IPB or 0 low delay IP.
1968 * - encoding: Set by libavcodec.
1969 * - decoding: Set by libavcodec.
1973 #if FF_API_PRIVATE_OPT
1974 /** @deprecated use encoder private options instead */
1975 attribute_deprecated
1980 * qscale factor between P- and I-frames
1981 * If > 0 then the last P-frame quantizer will be used (q = lastp_q * factor + offset).
1982 * If < 0 then normal ratecontrol will be done (q= -normal_q*factor+offset).
1983 * - encoding: Set by user.
1984 * - decoding: unused
1986 float i_quant_factor;
1989 * qscale offset between P and I-frames
1990 * - encoding: Set by user.
1991 * - decoding: unused
1993 float i_quant_offset;
1996 * luminance masking (0-> disabled)
1997 * - encoding: Set by user.
1998 * - decoding: unused
2003 * temporary complexity masking (0-> disabled)
2004 * - encoding: Set by user.
2005 * - decoding: unused
2007 float temporal_cplx_masking;
2010 * spatial complexity masking (0-> disabled)
2011 * - encoding: Set by user.
2012 * - decoding: unused
2014 float spatial_cplx_masking;
2017 * p block masking (0-> disabled)
2018 * - encoding: Set by user.
2019 * - decoding: unused
2024 * darkness masking (0-> disabled)
2025 * - encoding: Set by user.
2026 * - decoding: unused
2032 * - encoding: Set by libavcodec.
2033 * - decoding: Set by user (or 0).
2037 #if FF_API_PRIVATE_OPT
2038 /** @deprecated use encoder private options instead */
2039 attribute_deprecated
2040 int prediction_method;
2041 #define FF_PRED_LEFT 0
2042 #define FF_PRED_PLANE 1
2043 #define FF_PRED_MEDIAN 2
2047 * slice offsets in the frame in bytes
2048 * - encoding: Set/allocated by libavcodec.
2049 * - decoding: Set/allocated by user (or NULL).
2054 * sample aspect ratio (0 if unknown)
2055 * That is the width of a pixel divided by the height of the pixel.
2056 * Numerator and denominator must be relatively prime and smaller than 256 for some video standards.
2057 * - encoding: Set by user.
2058 * - decoding: Set by libavcodec.
2060 AVRational sample_aspect_ratio;
2063 * motion estimation comparison function
2064 * - encoding: Set by user.
2065 * - decoding: unused
2069 * subpixel motion estimation comparison function
2070 * - encoding: Set by user.
2071 * - decoding: unused
2075 * macroblock comparison function (not supported yet)
2076 * - encoding: Set by user.
2077 * - decoding: unused
2081 * interlaced DCT comparison function
2082 * - encoding: Set by user.
2083 * - decoding: unused
2086 #define FF_CMP_SAD 0
2087 #define FF_CMP_SSE 1
2088 #define FF_CMP_SATD 2
2089 #define FF_CMP_DCT 3
2090 #define FF_CMP_PSNR 4
2091 #define FF_CMP_BIT 5
2093 #define FF_CMP_ZERO 7
2094 #define FF_CMP_VSAD 8
2095 #define FF_CMP_VSSE 9
2096 #define FF_CMP_NSSE 10
2097 #define FF_CMP_W53 11
2098 #define FF_CMP_W97 12
2099 #define FF_CMP_DCTMAX 13
2100 #define FF_CMP_DCT264 14
2101 #define FF_CMP_CHROMA 256
2104 * ME diamond size & shape
2105 * - encoding: Set by user.
2106 * - decoding: unused
2111 * amount of previous MV predictors (2a+1 x 2a+1 square)
2112 * - encoding: Set by user.
2113 * - decoding: unused
2115 int last_predictor_count;
2117 #if FF_API_PRIVATE_OPT
2118 /** @deprecated use encoder private options instead */
2119 attribute_deprecated
2124 * motion estimation prepass comparison function
2125 * - encoding: Set by user.
2126 * - decoding: unused
2131 * ME prepass diamond size & shape
2132 * - encoding: Set by user.
2133 * - decoding: unused
2139 * - encoding: Set by user.
2140 * - decoding: unused
2142 int me_subpel_quality;
2146 * DTG active format information (additional aspect ratio
2147 * information only used in DVB MPEG-2 transport streams)
2150 * - encoding: unused
2151 * - decoding: Set by decoder.
2152 * @deprecated Deprecated in favor of AVSideData
2154 attribute_deprecated int dtg_active_format;
2155 #define FF_DTG_AFD_SAME 8
2156 #define FF_DTG_AFD_4_3 9
2157 #define FF_DTG_AFD_16_9 10
2158 #define FF_DTG_AFD_14_9 11
2159 #define FF_DTG_AFD_4_3_SP_14_9 13
2160 #define FF_DTG_AFD_16_9_SP_14_9 14
2161 #define FF_DTG_AFD_SP_4_3 15
2162 #endif /* FF_API_AFD */
2165 * maximum motion estimation search range in subpel units
2166 * If 0 then no limit.
2168 * - encoding: Set by user.
2169 * - decoding: unused
2173 #if FF_API_QUANT_BIAS
2175 * @deprecated use encoder private option instead
2177 attribute_deprecated int intra_quant_bias;
2178 #define FF_DEFAULT_QUANT_BIAS 999999
2181 * @deprecated use encoder private option instead
2183 attribute_deprecated int inter_quant_bias;
2188 * - encoding: unused
2189 * - decoding: Set by user.
2192 #define SLICE_FLAG_CODED_ORDER 0x0001 ///< draw_horiz_band() is called in coded order instead of display
2193 #define SLICE_FLAG_ALLOW_FIELD 0x0002 ///< allow draw_horiz_band() with field slices (MPEG-2 field pics)
2194 #define SLICE_FLAG_ALLOW_PLANE 0x0004 ///< allow draw_horiz_band() with 1 component at a time (SVQ1)
2198 * XVideo Motion Acceleration
2199 * - encoding: forbidden
2200 * - decoding: set by decoder
2201 * @deprecated XvMC doesn't need it anymore.
2203 attribute_deprecated int xvmc_acceleration;
2204 #endif /* FF_API_XVMC */
2207 * macroblock decision mode
2208 * - encoding: Set by user.
2209 * - decoding: unused
2212 #define FF_MB_DECISION_SIMPLE 0 ///< uses mb_cmp
2213 #define FF_MB_DECISION_BITS 1 ///< chooses the one which needs the fewest bits
2214 #define FF_MB_DECISION_RD 2 ///< rate distortion
2217 * custom intra quantization matrix
2218 * - encoding: Set by user, can be NULL.
2219 * - decoding: Set by libavcodec.
2221 uint16_t *intra_matrix;
2224 * custom inter quantization matrix
2225 * - encoding: Set by user, can be NULL.
2226 * - decoding: Set by libavcodec.
2228 uint16_t *inter_matrix;
2230 #if FF_API_PRIVATE_OPT
2231 /** @deprecated use encoder private options instead */
2232 attribute_deprecated
2233 int scenechange_threshold;
2235 /** @deprecated use encoder private options instead */
2236 attribute_deprecated
2237 int noise_reduction;
2242 * @deprecated this field is unused
2244 attribute_deprecated
2248 * @deprecated this field is unused
2250 attribute_deprecated
2255 * precision of the intra DC coefficient - 8
2256 * - encoding: Set by user.
2257 * - decoding: Set by libavcodec
2259 int intra_dc_precision;
2262 * Number of macroblock rows at the top which are skipped.
2263 * - encoding: unused
2264 * - decoding: Set by user.
2269 * Number of macroblock rows at the bottom which are skipped.
2270 * - encoding: unused
2271 * - decoding: Set by user.
2277 * @deprecated use encoder private options instead
2279 attribute_deprecated
2280 float border_masking;
2284 * minimum MB Lagrange multiplier
2285 * - encoding: Set by user.
2286 * - decoding: unused
2291 * maximum MB Lagrange multiplier
2292 * - encoding: Set by user.
2293 * - decoding: unused
2297 #if FF_API_PRIVATE_OPT
2299 * @deprecated use encoder private options instead
2301 attribute_deprecated
2302 int me_penalty_compensation;
2306 * - encoding: Set by user.
2307 * - decoding: unused
2311 #if FF_API_PRIVATE_OPT
2312 /** @deprecated use encoder private options instead */
2313 attribute_deprecated
2319 * - encoding: Set by user.
2320 * - decoding: unused
2325 * number of reference frames
2326 * - encoding: Set by user.
2327 * - decoding: Set by lavc.
2331 #if FF_API_PRIVATE_OPT
2332 /** @deprecated use encoder private options instead */
2333 attribute_deprecated
2337 #if FF_API_UNUSED_MEMBERS
2339 * Multiplied by qscale for each frame and added to scene_change_score.
2340 * - encoding: Set by user.
2341 * - decoding: unused
2343 attribute_deprecated int scenechange_factor;
2347 * Note: Value depends upon the compare function used for fullpel ME.
2348 * - encoding: Set by user.
2349 * - decoding: unused
2353 #if FF_API_PRIVATE_OPT
2354 /** @deprecated use encoder private options instead */
2355 attribute_deprecated
2360 * Chromaticity coordinates of the source primaries.
2361 * - encoding: Set by user
2362 * - decoding: Set by libavcodec
2364 enum AVColorPrimaries color_primaries;
2367 * Color Transfer Characteristic.
2368 * - encoding: Set by user
2369 * - decoding: Set by libavcodec
2371 enum AVColorTransferCharacteristic color_trc;
2374 * YUV colorspace type.
2375 * - encoding: Set by user
2376 * - decoding: Set by libavcodec
2378 enum AVColorSpace colorspace;
2381 * MPEG vs JPEG YUV range.
2382 * - encoding: Set by user
2383 * - decoding: Set by libavcodec
2385 enum AVColorRange color_range;
2388 * This defines the location of chroma samples.
2389 * - encoding: Set by user
2390 * - decoding: Set by libavcodec
2392 enum AVChromaLocation chroma_sample_location;
2396 * Indicates number of picture subdivisions. Used for parallelized
2398 * - encoding: Set by user
2399 * - decoding: unused
2404 * - encoding: set by libavcodec
2405 * - decoding: Set by user.
2407 enum AVFieldOrder field_order;
2410 int sample_rate; ///< samples per second
2411 int channels; ///< number of audio channels
2414 * audio sample format
2415 * - encoding: Set by user.
2416 * - decoding: Set by libavcodec.
2418 enum AVSampleFormat sample_fmt; ///< sample format
2420 /* The following data should not be initialized. */
2422 * Number of samples per channel in an audio frame.
2424 * - encoding: set by libavcodec in avcodec_open2(). Each submitted frame
2425 * except the last must contain exactly frame_size samples per channel.
2426 * May be 0 when the codec has AV_CODEC_CAP_VARIABLE_FRAME_SIZE set, then the
2427 * frame size is not restricted.
2428 * - decoding: may be set by some decoders to indicate constant frame size
2433 * Frame counter, set by libavcodec.
2435 * - decoding: total number of frames returned from the decoder so far.
2436 * - encoding: total number of frames passed to the encoder so far.
2438 * @note the counter is not incremented if encoding/decoding resulted in
2444 * number of bytes per packet if constant and known or 0
2445 * Used by some WAV based audio codecs.
2450 * Audio cutoff bandwidth (0 means "automatic")
2451 * - encoding: Set by user.
2452 * - decoding: unused
2457 * Audio channel layout.
2458 * - encoding: set by user.
2459 * - decoding: set by user, may be overwritten by libavcodec.
2461 uint64_t channel_layout;
2464 * Request decoder to use this channel layout if it can (0 for default)
2465 * - encoding: unused
2466 * - decoding: Set by user.
2468 uint64_t request_channel_layout;
2471 * Type of service that the audio stream conveys.
2472 * - encoding: Set by user.
2473 * - decoding: Set by libavcodec.
2475 enum AVAudioServiceType audio_service_type;
2478 * desired sample format
2479 * - encoding: Not used.
2480 * - decoding: Set by user.
2481 * Decoder will decode to this format if it can.
2483 enum AVSampleFormat request_sample_fmt;
2486 * This callback is called at the beginning of each frame to get data
2487 * buffer(s) for it. There may be one contiguous buffer for all the data or
2488 * there may be a buffer per each data plane or anything in between. What
2489 * this means is, you may set however many entries in buf[] you feel necessary.
2490 * Each buffer must be reference-counted using the AVBuffer API (see description
2493 * The following fields will be set in the frame before this callback is
2496 * - width, height (video only)
2497 * - sample_rate, channel_layout, nb_samples (audio only)
2498 * Their values may differ from the corresponding values in
2499 * AVCodecContext. This callback must use the frame values, not the codec
2500 * context values, to calculate the required buffer size.
2502 * This callback must fill the following fields in the frame:
2506 * * if the data is planar audio with more than 8 channels, then this
2507 * callback must allocate and fill extended_data to contain all pointers
2508 * to all data planes. data[] must hold as many pointers as it can.
2509 * extended_data must be allocated with av_malloc() and will be freed in
2511 * * otherwise extended_data must point to data
2512 * - buf[] must contain one or more pointers to AVBufferRef structures. Each of
2513 * the frame's data and extended_data pointers must be contained in these. That
2514 * is, one AVBufferRef for each allocated chunk of memory, not necessarily one
2515 * AVBufferRef per data[] entry. See: av_buffer_create(), av_buffer_alloc(),
2516 * and av_buffer_ref().
2517 * - extended_buf and nb_extended_buf must be allocated with av_malloc() by
2518 * this callback and filled with the extra buffers if there are more
2519 * buffers than buf[] can hold. extended_buf will be freed in
2522 * If AV_CODEC_CAP_DR1 is not set then get_buffer2() must call
2523 * avcodec_default_get_buffer2() instead of providing buffers allocated by
2526 * Each data plane must be aligned to the maximum required by the target
2529 * @see avcodec_default_get_buffer2()
2533 * If AV_GET_BUFFER_FLAG_REF is set in flags then the frame may be reused
2534 * (read and/or written to if it is writable) later by libavcodec.
2536 * avcodec_align_dimensions2() should be used to find the required width and
2537 * height, as they normally need to be rounded up to the next multiple of 16.
2539 * Some decoders do not support linesizes changing between frames.
2541 * If frame multithreading is used and thread_safe_callbacks is set,
2542 * this callback may be called from a different thread, but not from more
2543 * than one at once. Does not need to be reentrant.
2545 * @see avcodec_align_dimensions2()
2549 * Decoders request a buffer of a particular size by setting
2550 * AVFrame.nb_samples prior to calling get_buffer2(). The decoder may,
2551 * however, utilize only part of the buffer by setting AVFrame.nb_samples
2552 * to a smaller value in the output frame.
2554 * As a convenience, av_samples_get_buffer_size() and
2555 * av_samples_fill_arrays() in libavutil may be used by custom get_buffer2()
2556 * functions to find the required data size and to fill data pointers and
2557 * linesize. In AVFrame.linesize, only linesize[0] may be set for audio
2558 * since all planes must be the same size.
2560 * @see av_samples_get_buffer_size(), av_samples_fill_arrays()
2562 * - encoding: unused
2563 * - decoding: Set by libavcodec, user can override.
2565 int (*get_buffer2)(struct AVCodecContext *s, AVFrame *frame, int flags);
2568 * If non-zero, the decoded audio and video frames returned from
2569 * avcodec_decode_video2() and avcodec_decode_audio4() are reference-counted
2570 * and are valid indefinitely. The caller must free them with
2571 * av_frame_unref() when they are not needed anymore.
2572 * Otherwise, the decoded frames must not be freed by the caller and are
2573 * only valid until the next decode call.
2575 * This is always automatically enabled if avcodec_receive_frame() is used.
2577 * - encoding: unused
2578 * - decoding: set by the caller before avcodec_open2().
2580 int refcounted_frames;
2582 /* - encoding parameters */
2583 float qcompress; ///< amount of qscale change between easy & hard scenes (0.0-1.0)
2584 float qblur; ///< amount of qscale smoothing over time (0.0-1.0)
2588 * - encoding: Set by user.
2589 * - decoding: unused
2595 * - encoding: Set by user.
2596 * - decoding: unused
2601 * maximum quantizer difference between frames
2602 * - encoding: Set by user.
2603 * - decoding: unused
2609 * @deprecated use encoder private options instead
2611 attribute_deprecated
2614 attribute_deprecated
2616 attribute_deprecated
2621 * decoder bitstream buffer size
2622 * - encoding: Set by user.
2623 * - decoding: unused
2628 * ratecontrol override, see RcOverride
2629 * - encoding: Allocated/set/freed by user.
2630 * - decoding: unused
2632 int rc_override_count;
2633 RcOverride *rc_override;
2637 * @deprecated use encoder private options instead
2639 attribute_deprecated
2645 * - encoding: Set by user.
2646 * - decoding: Set by user, may be overwritten by libavcodec.
2648 int64_t rc_max_rate;
2652 * - encoding: Set by user.
2653 * - decoding: unused
2655 int64_t rc_min_rate;
2659 * @deprecated use encoder private options instead
2661 attribute_deprecated
2662 float rc_buffer_aggressivity;
2664 attribute_deprecated
2665 float rc_initial_cplx;
2669 * Ratecontrol attempt to use, at maximum, <value> of what can be used without an underflow.
2670 * - encoding: Set by user.
2671 * - decoding: unused.
2673 float rc_max_available_vbv_use;
2676 * Ratecontrol attempt to use, at least, <value> times the amount needed to prevent a vbv overflow.
2677 * - encoding: Set by user.
2678 * - decoding: unused.
2680 float rc_min_vbv_overflow_use;
2683 * Number of bits which should be loaded into the rc buffer before decoding starts.
2684 * - encoding: Set by user.
2685 * - decoding: unused
2687 int rc_initial_buffer_occupancy;
2689 #if FF_API_CODER_TYPE
2690 #define FF_CODER_TYPE_VLC 0
2691 #define FF_CODER_TYPE_AC 1
2692 #define FF_CODER_TYPE_RAW 2
2693 #define FF_CODER_TYPE_RLE 3
2694 #if FF_API_UNUSED_MEMBERS
2695 #define FF_CODER_TYPE_DEFLATE 4
2696 #endif /* FF_API_UNUSED_MEMBERS */
2698 * @deprecated use encoder private options instead
2700 attribute_deprecated
2702 #endif /* FF_API_CODER_TYPE */
2704 #if FF_API_PRIVATE_OPT
2705 /** @deprecated use encoder private options instead */
2706 attribute_deprecated
2712 * @deprecated use encoder private options instead
2714 attribute_deprecated
2718 * @deprecated use encoder private options instead
2720 attribute_deprecated
2724 #if FF_API_PRIVATE_OPT
2725 /** @deprecated use encoder private options instead */
2726 attribute_deprecated
2727 int frame_skip_threshold;
2729 /** @deprecated use encoder private options instead */
2730 attribute_deprecated
2731 int frame_skip_factor;
2733 /** @deprecated use encoder private options instead */
2734 attribute_deprecated
2737 /** @deprecated use encoder private options instead */
2738 attribute_deprecated
2740 #endif /* FF_API_PRIVATE_OPT */
2743 * trellis RD quantization
2744 * - encoding: Set by user.
2745 * - decoding: unused
2749 #if FF_API_PRIVATE_OPT
2750 /** @deprecated use encoder private options instead */
2751 attribute_deprecated
2752 int min_prediction_order;
2754 /** @deprecated use encoder private options instead */
2755 attribute_deprecated
2756 int max_prediction_order;
2758 /** @deprecated use encoder private options instead */
2759 attribute_deprecated
2760 int64_t timecode_frame_start;
2763 #if FF_API_RTP_CALLBACK
2765 * @deprecated unused
2767 /* The RTP callback: This function is called */
2768 /* every time the encoder has a packet to send. */
2769 /* It depends on the encoder if the data starts */
2770 /* with a Start Code (it should). H.263 does. */
2771 /* mb_nb contains the number of macroblocks */
2772 /* encoded in the RTP payload. */
2773 attribute_deprecated
2774 void (*rtp_callback)(struct AVCodecContext *avctx, void *data, int size, int mb_nb);
2777 #if FF_API_PRIVATE_OPT
2778 /** @deprecated use encoder private options instead */
2779 attribute_deprecated
2780 int rtp_payload_size; /* The size of the RTP payload: the coder will */
2781 /* do its best to deliver a chunk with size */
2782 /* below rtp_payload_size, the chunk will start */
2783 /* with a start code on some codecs like H.263. */
2784 /* This doesn't take account of any particular */
2785 /* headers inside the transmitted RTP payload. */
2788 #if FF_API_STAT_BITS
2789 /* statistics, used for 2-pass encoding */
2790 attribute_deprecated
2792 attribute_deprecated
2794 attribute_deprecated
2796 attribute_deprecated
2798 attribute_deprecated
2800 attribute_deprecated
2802 attribute_deprecated
2804 attribute_deprecated
2807 /** @deprecated this field is unused */
2808 attribute_deprecated
2813 * pass1 encoding statistics output buffer
2814 * - encoding: Set by libavcodec.
2815 * - decoding: unused
2820 * pass2 encoding statistics input buffer
2821 * Concatenated stuff from stats_out of pass1 should be placed here.
2822 * - encoding: Allocated/set/freed by user.
2823 * - decoding: unused
2828 * Work around bugs in encoders which sometimes cannot be detected automatically.
2829 * - encoding: Set by user
2830 * - decoding: Set by user
2832 int workaround_bugs;
2833 #define FF_BUG_AUTODETECT 1 ///< autodetection
2834 #if FF_API_OLD_MSMPEG4
2835 #define FF_BUG_OLD_MSMPEG4 2
2837 #define FF_BUG_XVID_ILACE 4
2838 #define FF_BUG_UMP4 8
2839 #define FF_BUG_NO_PADDING 16
2840 #define FF_BUG_AMV 32
2842 #define FF_BUG_AC_VLC 0 ///< Will be removed, libavcodec can now handle these non-compliant files by default.
2844 #define FF_BUG_QPEL_CHROMA 64
2845 #define FF_BUG_STD_QPEL 128
2846 #define FF_BUG_QPEL_CHROMA2 256
2847 #define FF_BUG_DIRECT_BLOCKSIZE 512
2848 #define FF_BUG_EDGE 1024
2849 #define FF_BUG_HPEL_CHROMA 2048
2850 #define FF_BUG_DC_CLIP 4096
2851 #define FF_BUG_MS 8192 ///< Work around various bugs in Microsoft's broken decoders.
2852 #define FF_BUG_TRUNCATED 16384
2855 * strictly follow the standard (MPEG-4, ...).
2856 * - encoding: Set by user.
2857 * - decoding: Set by user.
2858 * Setting this to STRICT or higher means the encoder and decoder will
2859 * generally do stupid things, whereas setting it to unofficial or lower
2860 * will mean the encoder might produce output that is not supported by all
2861 * spec-compliant decoders. Decoders don't differentiate between normal,
2862 * unofficial and experimental (that is, they always try to decode things
2863 * when they can) unless they are explicitly asked to behave stupidly
2864 * (=strictly conform to the specs)
2866 int strict_std_compliance;
2867 #define FF_COMPLIANCE_VERY_STRICT 2 ///< Strictly conform to an older more strict version of the spec or reference software.
2868 #define FF_COMPLIANCE_STRICT 1 ///< Strictly conform to all the things in the spec no matter what consequences.
2869 #define FF_COMPLIANCE_NORMAL 0
2870 #define FF_COMPLIANCE_UNOFFICIAL -1 ///< Allow unofficial extensions
2871 #define FF_COMPLIANCE_EXPERIMENTAL -2 ///< Allow nonstandardized experimental things.
2874 * error concealment flags
2875 * - encoding: unused
2876 * - decoding: Set by user.
2878 int error_concealment;
2879 #define FF_EC_GUESS_MVS 1
2880 #define FF_EC_DEBLOCK 2
2881 #define FF_EC_FAVOR_INTER 256
2885 * - encoding: Set by user.
2886 * - decoding: Set by user.
2889 #define FF_DEBUG_PICT_INFO 1
2890 #define FF_DEBUG_RC 2
2891 #define FF_DEBUG_BITSTREAM 4
2892 #define FF_DEBUG_MB_TYPE 8
2893 #define FF_DEBUG_QP 16
2896 * @deprecated this option does nothing
2898 #define FF_DEBUG_MV 32
2900 #define FF_DEBUG_DCT_COEFF 0x00000040
2901 #define FF_DEBUG_SKIP 0x00000080
2902 #define FF_DEBUG_STARTCODE 0x00000100
2903 #if FF_API_UNUSED_MEMBERS
2904 #define FF_DEBUG_PTS 0x00000200
2905 #endif /* FF_API_UNUSED_MEMBERS */
2906 #define FF_DEBUG_ER 0x00000400
2907 #define FF_DEBUG_MMCO 0x00000800
2908 #define FF_DEBUG_BUGS 0x00001000
2910 #define FF_DEBUG_VIS_QP 0x00002000 ///< only access through AVOptions from outside libavcodec
2911 #define FF_DEBUG_VIS_MB_TYPE 0x00004000 ///< only access through AVOptions from outside libavcodec
2913 #define FF_DEBUG_BUFFERS 0x00008000
2914 #define FF_DEBUG_THREADS 0x00010000
2915 #define FF_DEBUG_GREEN_MD 0x00800000
2916 #define FF_DEBUG_NOMC 0x01000000
2921 * Code outside libavcodec should access this field using AVOptions
2922 * - encoding: Set by user.
2923 * - decoding: Set by user.
2926 #define FF_DEBUG_VIS_MV_P_FOR 0x00000001 // visualize forward predicted MVs of P-frames
2927 #define FF_DEBUG_VIS_MV_B_FOR 0x00000002 // visualize forward predicted MVs of B-frames
2928 #define FF_DEBUG_VIS_MV_B_BACK 0x00000004 // visualize backward predicted MVs of B-frames
2932 * Error recognition; may misdetect some more or less valid parts as errors.
2933 * - encoding: unused
2934 * - decoding: Set by user.
2936 int err_recognition;
2939 * Verify checksums embedded in the bitstream (could be of either encoded or
2940 * decoded data, depending on the codec) and print an error message on mismatch.
2941 * If AV_EF_EXPLODE is also set, a mismatching checksum will result in the
2942 * decoder returning an error.
2944 #define AV_EF_CRCCHECK (1<<0)
2945 #define AV_EF_BITSTREAM (1<<1) ///< detect bitstream specification deviations
2946 #define AV_EF_BUFFER (1<<2) ///< detect improper bitstream length
2947 #define AV_EF_EXPLODE (1<<3) ///< abort decoding on minor error detection
2949 #define AV_EF_IGNORE_ERR (1<<15) ///< ignore errors and continue
2950 #define AV_EF_CAREFUL (1<<16) ///< consider things that violate the spec, are fast to calculate and have not been seen in the wild as errors
2951 #define AV_EF_COMPLIANT (1<<17) ///< consider all spec non compliances as errors
2952 #define AV_EF_AGGRESSIVE (1<<18) ///< consider things that a sane encoder should not do as an error
2956 * opaque 64-bit number (generally a PTS) that will be reordered and
2957 * output in AVFrame.reordered_opaque
2958 * - encoding: unused
2959 * - decoding: Set by user.
2961 int64_t reordered_opaque;
2964 * Hardware accelerator in use
2965 * - encoding: unused.
2966 * - decoding: Set by libavcodec
2968 struct AVHWAccel *hwaccel;
2971 * Hardware accelerator context.
2972 * For some hardware accelerators, a global context needs to be
2973 * provided by the user. In that case, this holds display-dependent
2974 * data FFmpeg cannot instantiate itself. Please refer to the
2975 * FFmpeg HW accelerator documentation to know how to fill this
2976 * is. e.g. for VA API, this is a struct vaapi_context.
2977 * - encoding: unused
2978 * - decoding: Set by user
2980 void *hwaccel_context;
2984 * - encoding: Set by libavcodec if flags & AV_CODEC_FLAG_PSNR.
2985 * - decoding: unused
2987 uint64_t error[AV_NUM_DATA_POINTERS];
2990 * DCT algorithm, see FF_DCT_* below
2991 * - encoding: Set by user.
2992 * - decoding: unused
2995 #define FF_DCT_AUTO 0
2996 #define FF_DCT_FASTINT 1
2997 #define FF_DCT_INT 2
2998 #define FF_DCT_MMX 3
2999 #define FF_DCT_ALTIVEC 5
3000 #define FF_DCT_FAAN 6
3003 * IDCT algorithm, see FF_IDCT_* below.
3004 * - encoding: Set by user.
3005 * - decoding: Set by user.
3008 #define FF_IDCT_AUTO 0
3009 #define FF_IDCT_INT 1
3010 #define FF_IDCT_SIMPLE 2
3011 #define FF_IDCT_SIMPLEMMX 3
3012 #define FF_IDCT_ARM 7
3013 #define FF_IDCT_ALTIVEC 8
3015 #define FF_IDCT_SH4 9
3017 #define FF_IDCT_SIMPLEARM 10
3018 #if FF_API_UNUSED_MEMBERS
3019 #define FF_IDCT_IPP 13
3020 #endif /* FF_API_UNUSED_MEMBERS */
3021 #define FF_IDCT_XVID 14
3022 #if FF_API_IDCT_XVIDMMX
3023 #define FF_IDCT_XVIDMMX 14
3024 #endif /* FF_API_IDCT_XVIDMMX */
3025 #define FF_IDCT_SIMPLEARMV5TE 16
3026 #define FF_IDCT_SIMPLEARMV6 17
3027 #if FF_API_ARCH_SPARC
3028 #define FF_IDCT_SIMPLEVIS 18
3030 #define FF_IDCT_FAAN 20
3031 #define FF_IDCT_SIMPLENEON 22
3032 #if FF_API_ARCH_ALPHA
3033 #define FF_IDCT_SIMPLEALPHA 23
3035 #define FF_IDCT_SIMPLEAUTO 128
3038 * bits per sample/pixel from the demuxer (needed for huffyuv).
3039 * - encoding: Set by libavcodec.
3040 * - decoding: Set by user.
3042 int bits_per_coded_sample;
3045 * Bits per sample/pixel of internal libavcodec pixel/sample format.
3046 * - encoding: set by user.
3047 * - decoding: set by libavcodec.
3049 int bits_per_raw_sample;
3053 * low resolution decoding, 1-> 1/2 size, 2->1/4 size
3054 * - encoding: unused
3055 * - decoding: Set by user.
3056 * Code outside libavcodec should access this field using:
3057 * av_codec_{get,set}_lowres(avctx)
3062 #if FF_API_CODED_FRAME
3064 * the picture in the bitstream
3065 * - encoding: Set by libavcodec.
3066 * - decoding: unused
3068 * @deprecated use the quality factor packet side data instead
3070 attribute_deprecated AVFrame *coded_frame;
3075 * is used to decide how many independent tasks should be passed to execute()
3076 * - encoding: Set by user.
3077 * - decoding: Set by user.
3082 * Which multithreading methods to use.
3083 * Use of FF_THREAD_FRAME will increase decoding delay by one frame per thread,
3084 * so clients which cannot provide future frames should not use it.
3086 * - encoding: Set by user, otherwise the default is used.
3087 * - decoding: Set by user, otherwise the default is used.
3090 #define FF_THREAD_FRAME 1 ///< Decode more than one frame at once
3091 #define FF_THREAD_SLICE 2 ///< Decode more than one part of a single frame at once
3094 * Which multithreading methods are in use by the codec.
3095 * - encoding: Set by libavcodec.
3096 * - decoding: Set by libavcodec.
3098 int active_thread_type;
3101 * Set by the client if its custom get_buffer() callback can be called
3102 * synchronously from another thread, which allows faster multithreaded decoding.
3103 * draw_horiz_band() will be called from other threads regardless of this setting.
3104 * Ignored if the default get_buffer() is used.
3105 * - encoding: Set by user.
3106 * - decoding: Set by user.
3108 int thread_safe_callbacks;
3111 * The codec may call this to execute several independent things.
3112 * It will return only after finishing all tasks.
3113 * The user may replace this with some multithreaded implementation,
3114 * the default implementation will execute the parts serially.
3115 * @param count the number of things to execute
3116 * - encoding: Set by libavcodec, user can override.
3117 * - decoding: Set by libavcodec, user can override.
3119 int (*execute)(struct AVCodecContext *c, int (*func)(struct AVCodecContext *c2, void *arg), void *arg2, int *ret, int count, int size);
3122 * The codec may call this to execute several independent things.
3123 * It will return only after finishing all tasks.
3124 * The user may replace this with some multithreaded implementation,
3125 * the default implementation will execute the parts serially.
3126 * Also see avcodec_thread_init and e.g. the --enable-pthread configure option.
3127 * @param c context passed also to func
3128 * @param count the number of things to execute
3129 * @param arg2 argument passed unchanged to func
3130 * @param ret return values of executed functions, must have space for "count" values. May be NULL.
3131 * @param func function that will be called count times, with jobnr from 0 to count-1.
3132 * threadnr will be in the range 0 to c->thread_count-1 < MAX_THREADS and so that no
3133 * two instances of func executing at the same time will have the same threadnr.
3134 * @return always 0 currently, but code should handle a future improvement where when any call to func
3135 * returns < 0 no further calls to func may be done and < 0 is returned.
3136 * - encoding: Set by libavcodec, user can override.
3137 * - decoding: Set by libavcodec, user can override.
3139 int (*execute2)(struct AVCodecContext *c, int (*func)(struct AVCodecContext *c2, void *arg, int jobnr, int threadnr), void *arg2, int *ret, int count);
3142 * noise vs. sse weight for the nsse comparison function
3143 * - encoding: Set by user.
3144 * - decoding: unused
3150 * - encoding: Set by user.
3151 * - decoding: Set by libavcodec.
3154 #define FF_PROFILE_UNKNOWN -99
3155 #define FF_PROFILE_RESERVED -100
3157 #define FF_PROFILE_AAC_MAIN 0
3158 #define FF_PROFILE_AAC_LOW 1
3159 #define FF_PROFILE_AAC_SSR 2
3160 #define FF_PROFILE_AAC_LTP 3
3161 #define FF_PROFILE_AAC_HE 4
3162 #define FF_PROFILE_AAC_HE_V2 28
3163 #define FF_PROFILE_AAC_LD 22
3164 #define FF_PROFILE_AAC_ELD 38
3165 #define FF_PROFILE_MPEG2_AAC_LOW 128
3166 #define FF_PROFILE_MPEG2_AAC_HE 131
3168 #define FF_PROFILE_DTS 20
3169 #define FF_PROFILE_DTS_ES 30
3170 #define FF_PROFILE_DTS_96_24 40
3171 #define FF_PROFILE_DTS_HD_HRA 50
3172 #define FF_PROFILE_DTS_HD_MA 60
3173 #define FF_PROFILE_DTS_EXPRESS 70
3175 #define FF_PROFILE_MPEG2_422 0
3176 #define FF_PROFILE_MPEG2_HIGH 1
3177 #define FF_PROFILE_MPEG2_SS 2
3178 #define FF_PROFILE_MPEG2_SNR_SCALABLE 3
3179 #define FF_PROFILE_MPEG2_MAIN 4
3180 #define FF_PROFILE_MPEG2_SIMPLE 5
3182 #define FF_PROFILE_H264_CONSTRAINED (1<<9) // 8+1; constraint_set1_flag
3183 #define FF_PROFILE_H264_INTRA (1<<11) // 8+3; constraint_set3_flag
3185 #define FF_PROFILE_H264_BASELINE 66
3186 #define FF_PROFILE_H264_CONSTRAINED_BASELINE (66|FF_PROFILE_H264_CONSTRAINED)
3187 #define FF_PROFILE_H264_MAIN 77
3188 #define FF_PROFILE_H264_EXTENDED 88
3189 #define FF_PROFILE_H264_HIGH 100
3190 #define FF_PROFILE_H264_HIGH_10 110
3191 #define FF_PROFILE_H264_HIGH_10_INTRA (110|FF_PROFILE_H264_INTRA)
3192 #define FF_PROFILE_H264_HIGH_422 122
3193 #define FF_PROFILE_H264_HIGH_422_INTRA (122|FF_PROFILE_H264_INTRA)
3194 #define FF_PROFILE_H264_HIGH_444 144
3195 #define FF_PROFILE_H264_HIGH_444_PREDICTIVE 244
3196 #define FF_PROFILE_H264_HIGH_444_INTRA (244|FF_PROFILE_H264_INTRA)
3197 #define FF_PROFILE_H264_CAVLC_444 44
3199 #define FF_PROFILE_VC1_SIMPLE 0
3200 #define FF_PROFILE_VC1_MAIN 1
3201 #define FF_PROFILE_VC1_COMPLEX 2
3202 #define FF_PROFILE_VC1_ADVANCED 3
3204 #define FF_PROFILE_MPEG4_SIMPLE 0
3205 #define FF_PROFILE_MPEG4_SIMPLE_SCALABLE 1
3206 #define FF_PROFILE_MPEG4_CORE 2
3207 #define FF_PROFILE_MPEG4_MAIN 3
3208 #define FF_PROFILE_MPEG4_N_BIT 4
3209 #define FF_PROFILE_MPEG4_SCALABLE_TEXTURE 5
3210 #define FF_PROFILE_MPEG4_SIMPLE_FACE_ANIMATION 6
3211 #define FF_PROFILE_MPEG4_BASIC_ANIMATED_TEXTURE 7
3212 #define FF_PROFILE_MPEG4_HYBRID 8
3213 #define FF_PROFILE_MPEG4_ADVANCED_REAL_TIME 9
3214 #define FF_PROFILE_MPEG4_CORE_SCALABLE 10
3215 #define FF_PROFILE_MPEG4_ADVANCED_CODING 11
3216 #define FF_PROFILE_MPEG4_ADVANCED_CORE 12
3217 #define FF_PROFILE_MPEG4_ADVANCED_SCALABLE_TEXTURE 13
3218 #define FF_PROFILE_MPEG4_SIMPLE_STUDIO 14
3219 #define FF_PROFILE_MPEG4_ADVANCED_SIMPLE 15
3221 #define FF_PROFILE_JPEG2000_CSTREAM_RESTRICTION_0 0
3222 #define FF_PROFILE_JPEG2000_CSTREAM_RESTRICTION_1 1
3223 #define FF_PROFILE_JPEG2000_CSTREAM_NO_RESTRICTION 2
3224 #define FF_PROFILE_JPEG2000_DCINEMA_2K 3
3225 #define FF_PROFILE_JPEG2000_DCINEMA_4K 4
3227 #define FF_PROFILE_VP9_0 0
3228 #define FF_PROFILE_VP9_1 1
3229 #define FF_PROFILE_VP9_2 2
3230 #define FF_PROFILE_VP9_3 3
3232 #define FF_PROFILE_HEVC_MAIN 1
3233 #define FF_PROFILE_HEVC_MAIN_10 2
3234 #define FF_PROFILE_HEVC_MAIN_STILL_PICTURE 3
3235 #define FF_PROFILE_HEVC_REXT 4
3239 * - encoding: Set by user.
3240 * - decoding: Set by libavcodec.
3243 #define FF_LEVEL_UNKNOWN -99
3246 * Skip loop filtering for selected frames.
3247 * - encoding: unused
3248 * - decoding: Set by user.
3250 enum AVDiscard skip_loop_filter;
3253 * Skip IDCT/dequantization for selected frames.
3254 * - encoding: unused
3255 * - decoding: Set by user.
3257 enum AVDiscard skip_idct;
3260 * Skip decoding for selected frames.
3261 * - encoding: unused
3262 * - decoding: Set by user.
3264 enum AVDiscard skip_frame;
3267 * Header containing style information for text subtitles.
3268 * For SUBTITLE_ASS subtitle type, it should contain the whole ASS
3269 * [Script Info] and [V4+ Styles] section, plus the [Events] line and
3270 * the Format line following. It shouldn't include any Dialogue line.
3271 * - encoding: Set/allocated/freed by user (before avcodec_open2())
3272 * - decoding: Set/allocated/freed by libavcodec (by avcodec_open2())
3274 uint8_t *subtitle_header;
3275 int subtitle_header_size;
3277 #if FF_API_ERROR_RATE
3279 * @deprecated use the 'error_rate' private AVOption of the mpegvideo
3282 attribute_deprecated
3286 #if FF_API_VBV_DELAY
3288 * VBV delay coded in the last frame (in periods of a 27 MHz clock).
3289 * Used for compliant TS muxing.
3290 * - encoding: Set by libavcodec.
3291 * - decoding: unused.
3292 * @deprecated this value is now exported as a part of
3293 * AV_PKT_DATA_CPB_PROPERTIES packet side data
3295 attribute_deprecated
3299 #if FF_API_SIDEDATA_ONLY_PKT
3301 * Encoding only and set by default. Allow encoders to output packets
3302 * that do not contain any encoded data, only side data.
3304 * Some encoders need to output such packets, e.g. to update some stream
3305 * parameters at the end of encoding.
3307 * @deprecated this field disables the default behaviour and
3308 * it is kept only for compatibility.
3310 attribute_deprecated
3311 int side_data_only_packets;
3315 * Audio only. The number of "priming" samples (padding) inserted by the
3316 * encoder at the beginning of the audio. I.e. this number of leading
3317 * decoded samples must be discarded by the caller to get the original audio
3318 * without leading padding.
3320 * - decoding: unused
3321 * - encoding: Set by libavcodec. The timestamps on the output packets are
3322 * adjusted by the encoder so that they always refer to the
3323 * first sample of the data actually contained in the packet,
3324 * including any added padding. E.g. if the timebase is
3325 * 1/samplerate and the timestamp of the first input sample is
3326 * 0, the timestamp of the first output packet will be
3329 int initial_padding;
3332 * - decoding: For codecs that store a framerate value in the compressed
3333 * bitstream, the decoder may export it here. { 0, 1} when
3335 * - encoding: May be used to signal the framerate of CFR content to an
3338 AVRational framerate;
3341 * Nominal unaccelerated pixel format, see AV_PIX_FMT_xxx.
3342 * - encoding: unused.
3343 * - decoding: Set by libavcodec before calling get_format()
3345 enum AVPixelFormat sw_pix_fmt;
3348 * Timebase in which pkt_dts/pts and AVPacket.dts/pts are.
3349 * Code outside libavcodec should access this field using:
3350 * av_codec_{get,set}_pkt_timebase(avctx)
3351 * - encoding unused.
3352 * - decoding set by user.
3354 AVRational pkt_timebase;
3358 * Code outside libavcodec should access this field using:
3359 * av_codec_{get,set}_codec_descriptor(avctx)
3360 * - encoding: unused.
3361 * - decoding: set by libavcodec.
3363 const AVCodecDescriptor *codec_descriptor;
3367 * low resolution decoding, 1-> 1/2 size, 2->1/4 size
3368 * - encoding: unused
3369 * - decoding: Set by user.
3370 * Code outside libavcodec should access this field using:
3371 * av_codec_{get,set}_lowres(avctx)
3377 * Current statistics for PTS correction.
3378 * - decoding: maintained and used by libavcodec, not intended to be used by user apps
3379 * - encoding: unused
3381 int64_t pts_correction_num_faulty_pts; /// Number of incorrect PTS values so far
3382 int64_t pts_correction_num_faulty_dts; /// Number of incorrect DTS values so far
3383 int64_t pts_correction_last_pts; /// PTS of the last frame
3384 int64_t pts_correction_last_dts; /// DTS of the last frame
3387 * Character encoding of the input subtitles file.
3388 * - decoding: set by user
3389 * - encoding: unused
3394 * Subtitles character encoding mode. Formats or codecs might be adjusting
3395 * this setting (if they are doing the conversion themselves for instance).
3396 * - decoding: set by libavcodec
3397 * - encoding: unused
3399 int sub_charenc_mode;
3400 #define FF_SUB_CHARENC_MODE_DO_NOTHING -1 ///< do nothing (demuxer outputs a stream supposed to be already in UTF-8, or the codec is bitmap for instance)
3401 #define FF_SUB_CHARENC_MODE_AUTOMATIC 0 ///< libavcodec will select the mode itself
3402 #define FF_SUB_CHARENC_MODE_PRE_DECODER 1 ///< the AVPacket data needs to be recoded to UTF-8 before being fed to the decoder, requires iconv
3405 * Skip processing alpha if supported by codec.
3406 * Note that if the format uses pre-multiplied alpha (common with VP6,
3407 * and recommended due to better video quality/compression)
3408 * the image will look as if alpha-blended onto a black background.
3409 * However for formats that do not use pre-multiplied alpha
3410 * there might be serious artefacts (though e.g. libswscale currently
3411 * assumes pre-multiplied alpha anyway).
3412 * Code outside libavcodec should access this field using AVOptions
3414 * - decoding: set by user
3415 * - encoding: unused
3420 * Number of samples to skip after a discontinuity
3421 * - decoding: unused
3422 * - encoding: set by libavcodec
3426 #if !FF_API_DEBUG_MV
3428 * debug motion vectors
3429 * Code outside libavcodec should access this field using AVOptions
3430 * - encoding: Set by user.
3431 * - decoding: Set by user.
3434 #define FF_DEBUG_VIS_MV_P_FOR 0x00000001 //visualize forward predicted MVs of P frames
3435 #define FF_DEBUG_VIS_MV_B_FOR 0x00000002 //visualize forward predicted MVs of B frames
3436 #define FF_DEBUG_VIS_MV_B_BACK 0x00000004 //visualize backward predicted MVs of B frames
3440 * custom intra quantization matrix
3441 * Code outside libavcodec should access this field using av_codec_g/set_chroma_intra_matrix()
3442 * - encoding: Set by user, can be NULL.
3443 * - decoding: unused.
3445 uint16_t *chroma_intra_matrix;
3448 * dump format separator.
3449 * can be ", " or "\n " or anything else
3450 * Code outside libavcodec should access this field using AVOptions
3451 * (NO direct access).
3452 * - encoding: Set by user.
3453 * - decoding: Set by user.
3455 uint8_t *dump_separator;
3458 * ',' separated list of allowed decoders.
3459 * If NULL then all are allowed
3460 * - encoding: unused
3461 * - decoding: set by user through AVOPtions (NO direct access)
3463 char *codec_whitelist;
3466 * Properties of the stream that gets decoded
3467 * To be accessed through av_codec_get_properties() (NO direct access)
3468 * - encoding: unused
3469 * - decoding: set by libavcodec
3471 unsigned properties;
3472 #define FF_CODEC_PROPERTY_LOSSLESS 0x00000001
3473 #define FF_CODEC_PROPERTY_CLOSED_CAPTIONS 0x00000002
3476 * Additional data associated with the entire coded stream.
3478 * - decoding: unused
3479 * - encoding: may be set by libavcodec after avcodec_open2().
3481 AVPacketSideData *coded_side_data;
3482 int nb_coded_side_data;
3487 * For hardware encoders configured to use a hwaccel pixel format, this
3488 * field should be set by the caller to a reference to the AVHWFramesContext
3489 * describing input frames. AVHWFramesContext.format must be equal to
3490 * AVCodecContext.pix_fmt.
3492 * This field should be set before avcodec_open2() is called and is
3493 * afterwards owned and managed by libavcodec.
3495 AVBufferRef *hw_frames_ctx;
3498 * Control the form of AVSubtitle.rects[N]->ass
3499 * - decoding: set by user
3500 * - encoding: unused
3502 int sub_text_format;
3503 #define FF_SUB_TEXT_FMT_ASS 0
3504 #if FF_API_ASS_TIMING
3505 #define FF_SUB_TEXT_FMT_ASS_WITH_TIMINGS 1
3510 AVRational av_codec_get_pkt_timebase (const AVCodecContext *avctx);
3511 void av_codec_set_pkt_timebase (AVCodecContext *avctx, AVRational val);
3513 const AVCodecDescriptor *av_codec_get_codec_descriptor(const AVCodecContext *avctx);
3514 void av_codec_set_codec_descriptor(AVCodecContext *avctx, const AVCodecDescriptor *desc);
3516 unsigned av_codec_get_codec_properties(const AVCodecContext *avctx);
3518 int av_codec_get_lowres(const AVCodecContext *avctx);
3519 void av_codec_set_lowres(AVCodecContext *avctx, int val);
3521 int av_codec_get_seek_preroll(const AVCodecContext *avctx);
3522 void av_codec_set_seek_preroll(AVCodecContext *avctx, int val);
3524 uint16_t *av_codec_get_chroma_intra_matrix(const AVCodecContext *avctx);
3525 void av_codec_set_chroma_intra_matrix(AVCodecContext *avctx, uint16_t *val);
3530 typedef struct AVProfile {
3532 const char *name; ///< short name for the profile
3535 typedef struct AVCodecDefault AVCodecDefault;
3542 typedef struct AVCodec {
3544 * Name of the codec implementation.
3545 * The name is globally unique among encoders and among decoders (but an
3546 * encoder and a decoder can share the same name).
3547 * This is the primary way to find a codec from the user perspective.
3551 * Descriptive name for the codec, meant to be more human readable than name.
3552 * You should use the NULL_IF_CONFIG_SMALL() macro to define it.
3554 const char *long_name;
3555 enum AVMediaType type;
3558 * Codec capabilities.
3559 * see AV_CODEC_CAP_*
3562 const AVRational *supported_framerates; ///< array of supported framerates, or NULL if any, array is terminated by {0,0}
3563 const enum AVPixelFormat *pix_fmts; ///< array of supported pixel formats, or NULL if unknown, array is terminated by -1
3564 const int *supported_samplerates; ///< array of supported audio samplerates, or NULL if unknown, array is terminated by 0
3565 const enum AVSampleFormat *sample_fmts; ///< array of supported sample formats, or NULL if unknown, array is terminated by -1
3566 const uint64_t *channel_layouts; ///< array of support channel layouts, or NULL if unknown. array is terminated by 0
3567 uint8_t max_lowres; ///< maximum value for lowres supported by the decoder, no direct access, use av_codec_get_max_lowres()
3568 const AVClass *priv_class; ///< AVClass for the private context
3569 const AVProfile *profiles; ///< array of recognized profiles, or NULL if unknown, array is terminated by {FF_PROFILE_UNKNOWN}
3571 /*****************************************************************
3572 * No fields below this line are part of the public API. They
3573 * may not be used outside of libavcodec and can be changed and
3575 * New public fields should be added right above.
3576 *****************************************************************
3579 struct AVCodec *next;
3581 * @name Frame-level threading support functions
3585 * If defined, called on thread contexts when they are created.
3586 * If the codec allocates writable tables in init(), re-allocate them here.
3587 * priv_data will be set to a copy of the original.
3589 int (*init_thread_copy)(AVCodecContext *);
3591 * Copy necessary context variables from a previous thread context to the current one.
3592 * If not defined, the next thread will start automatically; otherwise, the codec
3593 * must call ff_thread_finish_setup().
3595 * dst and src will (rarely) point to the same context, in which case memcpy should be skipped.
3597 int (*update_thread_context)(AVCodecContext *dst, const AVCodecContext *src);
3601 * Private codec-specific defaults.
3603 const AVCodecDefault *defaults;
3606 * Initialize codec static data, called from avcodec_register().
3608 void (*init_static_data)(struct AVCodec *codec);
3610 int (*init)(AVCodecContext *);
3611 int (*encode_sub)(AVCodecContext *, uint8_t *buf, int buf_size,
3612 const struct AVSubtitle *sub);
3614 * Encode data to an AVPacket.
3616 * @param avctx codec context
3617 * @param avpkt output AVPacket (may contain a user-provided buffer)
3618 * @param[in] frame AVFrame containing the raw data to be encoded
3619 * @param[out] got_packet_ptr encoder sets to 0 or 1 to indicate that a
3620 * non-empty packet was returned in avpkt.
3621 * @return 0 on success, negative error code on failure
3623 int (*encode2)(AVCodecContext *avctx, AVPacket *avpkt, const AVFrame *frame,
3624 int *got_packet_ptr);
3625 int (*decode)(AVCodecContext *, void *outdata, int *outdata_size, AVPacket *avpkt);
3626 int (*close)(AVCodecContext *);
3628 * Decode/encode API with decoupled packet/frame dataflow. The API is the
3629 * same as the avcodec_ prefixed APIs (avcodec_send_frame() etc.), except
3631 * - never called if the codec is closed or the wrong type,
3632 * - AVPacket parameter change side data is applied right before calling
3633 * AVCodec->send_packet,
3634 * - if AV_CODEC_CAP_DELAY is not set, drain packets or frames are never sent,
3635 * - only one drain packet is ever passed down (until the next flush()),
3636 * - a drain AVPacket is always NULL (no need to check for avpkt->size).
3638 int (*send_frame)(AVCodecContext *avctx, const AVFrame *frame);
3639 int (*send_packet)(AVCodecContext *avctx, const AVPacket *avpkt);
3640 int (*receive_frame)(AVCodecContext *avctx, AVFrame *frame);
3641 int (*receive_packet)(AVCodecContext *avctx, AVPacket *avpkt);
3644 * Will be called when seeking
3646 void (*flush)(AVCodecContext *);
3648 * Internal codec capabilities.
3649 * See FF_CODEC_CAP_* in internal.h
3654 int av_codec_get_max_lowres(const AVCodec *codec);
3656 struct MpegEncContext;
3659 * @defgroup lavc_hwaccel AVHWAccel
3662 typedef struct AVHWAccel {
3664 * Name of the hardware accelerated codec.
3665 * The name is globally unique among encoders and among decoders (but an
3666 * encoder and a decoder can share the same name).
3671 * Type of codec implemented by the hardware accelerator.
3673 * See AVMEDIA_TYPE_xxx
3675 enum AVMediaType type;
3678 * Codec implemented by the hardware accelerator.
3680 * See AV_CODEC_ID_xxx
3685 * Supported pixel format.
3687 * Only hardware accelerated formats are supported here.
3689 enum AVPixelFormat pix_fmt;
3692 * Hardware accelerated codec capabilities.
3693 * see HWACCEL_CODEC_CAP_*
3697 /*****************************************************************
3698 * No fields below this line are part of the public API. They
3699 * may not be used outside of libavcodec and can be changed and
3701 * New public fields should be added right above.
3702 *****************************************************************
3704 struct AVHWAccel *next;
3707 * Allocate a custom buffer
3709 int (*alloc_frame)(AVCodecContext *avctx, AVFrame *frame);
3712 * Called at the beginning of each frame or field picture.
3714 * Meaningful frame information (codec specific) is guaranteed to
3715 * be parsed at this point. This function is mandatory.
3717 * Note that buf can be NULL along with buf_size set to 0.
3718 * Otherwise, this means the whole frame is available at this point.
3720 * @param avctx the codec context
3721 * @param buf the frame data buffer base
3722 * @param buf_size the size of the frame in bytes
3723 * @return zero if successful, a negative value otherwise
3725 int (*start_frame)(AVCodecContext *avctx, const uint8_t *buf, uint32_t buf_size);
3728 * Callback for each slice.
3730 * Meaningful slice information (codec specific) is guaranteed to
3731 * be parsed at this point. This function is mandatory.
3732 * The only exception is XvMC, that works on MB level.
3734 * @param avctx the codec context
3735 * @param buf the slice data buffer base
3736 * @param buf_size the size of the slice in bytes
3737 * @return zero if successful, a negative value otherwise
3739 int (*decode_slice)(AVCodecContext *avctx, const uint8_t *buf, uint32_t buf_size);
3742 * Called at the end of each frame or field picture.
3744 * The whole picture is parsed at this point and can now be sent
3745 * to the hardware accelerator. This function is mandatory.
3747 * @param avctx the codec context
3748 * @return zero if successful, a negative value otherwise
3750 int (*end_frame)(AVCodecContext *avctx);
3753 * Size of per-frame hardware accelerator private data.
3755 * Private data is allocated with av_mallocz() before
3756 * AVCodecContext.get_buffer() and deallocated after
3757 * AVCodecContext.release_buffer().
3759 int frame_priv_data_size;
3762 * Called for every Macroblock in a slice.
3764 * XvMC uses it to replace the ff_mpv_decode_mb().
3765 * Instead of decoding to raw picture, MB parameters are
3766 * stored in an array provided by the video driver.
3768 * @param s the mpeg context
3770 void (*decode_mb)(struct MpegEncContext *s);
3773 * Initialize the hwaccel private data.
3775 * This will be called from ff_get_format(), after hwaccel and
3776 * hwaccel_context are set and the hwaccel private data in AVCodecInternal
3779 int (*init)(AVCodecContext *avctx);
3782 * Uninitialize the hwaccel private data.
3784 * This will be called from get_format() or avcodec_close(), after hwaccel
3785 * and hwaccel_context are already uninitialized.
3787 int (*uninit)(AVCodecContext *avctx);
3790 * Size of the private data to allocate in
3791 * AVCodecInternal.hwaccel_priv_data.
3797 * Hardware acceleration should be used for decoding even if the codec level
3798 * used is unknown or higher than the maximum supported level reported by the
3801 * It's generally a good idea to pass this flag unless you have a specific
3802 * reason not to, as hardware tends to under-report supported levels.
3804 #define AV_HWACCEL_FLAG_IGNORE_LEVEL (1 << 0)
3807 * Hardware acceleration can output YUV pixel formats with a different chroma
3808 * sampling than 4:2:0 and/or other than 8 bits per component.
3810 #define AV_HWACCEL_FLAG_ALLOW_HIGH_DEPTH (1 << 1)
3816 #if FF_API_AVPICTURE
3818 * @defgroup lavc_picture AVPicture
3820 * Functions for working with AVPicture
3825 * Picture data structure.
3827 * Up to four components can be stored into it, the last component is
3829 * @deprecated use AVFrame or imgutils functions instead
3831 typedef struct AVPicture {
3832 attribute_deprecated
3833 uint8_t *data[AV_NUM_DATA_POINTERS]; ///< pointers to the image data planes
3834 attribute_deprecated
3835 int linesize[AV_NUM_DATA_POINTERS]; ///< number of bytes per line