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,
412 /* various PCM "codecs" */
413 AV_CODEC_ID_FIRST_AUDIO = 0x10000, ///< A dummy id pointing at the start of audio codecs
414 AV_CODEC_ID_PCM_S16LE = 0x10000,
415 AV_CODEC_ID_PCM_S16BE,
416 AV_CODEC_ID_PCM_U16LE,
417 AV_CODEC_ID_PCM_U16BE,
420 AV_CODEC_ID_PCM_MULAW,
421 AV_CODEC_ID_PCM_ALAW,
422 AV_CODEC_ID_PCM_S32LE,
423 AV_CODEC_ID_PCM_S32BE,
424 AV_CODEC_ID_PCM_U32LE,
425 AV_CODEC_ID_PCM_U32BE,
426 AV_CODEC_ID_PCM_S24LE,
427 AV_CODEC_ID_PCM_S24BE,
428 AV_CODEC_ID_PCM_U24LE,
429 AV_CODEC_ID_PCM_U24BE,
430 AV_CODEC_ID_PCM_S24DAUD,
431 AV_CODEC_ID_PCM_ZORK,
432 AV_CODEC_ID_PCM_S16LE_PLANAR,
434 AV_CODEC_ID_PCM_F32BE,
435 AV_CODEC_ID_PCM_F32LE,
436 AV_CODEC_ID_PCM_F64BE,
437 AV_CODEC_ID_PCM_F64LE,
438 AV_CODEC_ID_PCM_BLURAY,
441 AV_CODEC_ID_PCM_S8_PLANAR,
442 AV_CODEC_ID_PCM_S24LE_PLANAR,
443 AV_CODEC_ID_PCM_S32LE_PLANAR,
444 AV_CODEC_ID_PCM_S16BE_PLANAR,
445 /* new PCM "codecs" should be added right below this line starting with
446 * an explicit value of for example 0x10800
449 /* various ADPCM codecs */
450 AV_CODEC_ID_ADPCM_IMA_QT = 0x11000,
451 AV_CODEC_ID_ADPCM_IMA_WAV,
452 AV_CODEC_ID_ADPCM_IMA_DK3,
453 AV_CODEC_ID_ADPCM_IMA_DK4,
454 AV_CODEC_ID_ADPCM_IMA_WS,
455 AV_CODEC_ID_ADPCM_IMA_SMJPEG,
456 AV_CODEC_ID_ADPCM_MS,
457 AV_CODEC_ID_ADPCM_4XM,
458 AV_CODEC_ID_ADPCM_XA,
459 AV_CODEC_ID_ADPCM_ADX,
460 AV_CODEC_ID_ADPCM_EA,
461 AV_CODEC_ID_ADPCM_G726,
462 AV_CODEC_ID_ADPCM_CT,
463 AV_CODEC_ID_ADPCM_SWF,
464 AV_CODEC_ID_ADPCM_YAMAHA,
465 AV_CODEC_ID_ADPCM_SBPRO_4,
466 AV_CODEC_ID_ADPCM_SBPRO_3,
467 AV_CODEC_ID_ADPCM_SBPRO_2,
468 AV_CODEC_ID_ADPCM_THP,
469 AV_CODEC_ID_ADPCM_IMA_AMV,
470 AV_CODEC_ID_ADPCM_EA_R1,
471 AV_CODEC_ID_ADPCM_EA_R3,
472 AV_CODEC_ID_ADPCM_EA_R2,
473 AV_CODEC_ID_ADPCM_IMA_EA_SEAD,
474 AV_CODEC_ID_ADPCM_IMA_EA_EACS,
475 AV_CODEC_ID_ADPCM_EA_XAS,
476 AV_CODEC_ID_ADPCM_EA_MAXIS_XA,
477 AV_CODEC_ID_ADPCM_IMA_ISS,
478 AV_CODEC_ID_ADPCM_G722,
479 AV_CODEC_ID_ADPCM_IMA_APC,
480 AV_CODEC_ID_ADPCM_VIMA,
481 #if FF_API_VIMA_DECODER
482 AV_CODEC_ID_VIMA = AV_CODEC_ID_ADPCM_VIMA,
485 AV_CODEC_ID_ADPCM_AFC = 0x11800,
486 AV_CODEC_ID_ADPCM_IMA_OKI,
487 AV_CODEC_ID_ADPCM_DTK,
488 AV_CODEC_ID_ADPCM_IMA_RAD,
489 AV_CODEC_ID_ADPCM_G726LE,
490 AV_CODEC_ID_ADPCM_THP_LE,
491 AV_CODEC_ID_ADPCM_PSX,
492 AV_CODEC_ID_ADPCM_AICA,
493 AV_CODEC_ID_ADPCM_IMA_DAT4,
494 AV_CODEC_ID_ADPCM_MTAF,
497 AV_CODEC_ID_AMR_NB = 0x12000,
500 /* RealAudio codecs*/
501 AV_CODEC_ID_RA_144 = 0x13000,
504 /* various DPCM codecs */
505 AV_CODEC_ID_ROQ_DPCM = 0x14000,
506 AV_CODEC_ID_INTERPLAY_DPCM,
507 AV_CODEC_ID_XAN_DPCM,
508 AV_CODEC_ID_SOL_DPCM,
510 AV_CODEC_ID_SDX2_DPCM = 0x14800,
513 AV_CODEC_ID_MP2 = 0x15000,
514 AV_CODEC_ID_MP3, ///< preferred ID for decoding MPEG audio layer 1, 2 or 3
524 AV_CODEC_ID_VMDAUDIO,
530 AV_CODEC_ID_WESTWOOD_SND1,
531 AV_CODEC_ID_GSM, ///< as in Berlin toast format
534 AV_CODEC_ID_TRUESPEECH,
536 AV_CODEC_ID_SMACKAUDIO,
539 AV_CODEC_ID_DSICINAUDIO,
541 AV_CODEC_ID_MUSEPACK7,
543 AV_CODEC_ID_GSM_MS, /* as found in WAV */
549 AV_CODEC_ID_NELLYMOSER,
550 AV_CODEC_ID_MUSEPACK8,
552 AV_CODEC_ID_WMAVOICE,
554 AV_CODEC_ID_WMALOSSLESS,
563 AV_CODEC_ID_BINKAUDIO_RDFT,
564 AV_CODEC_ID_BINKAUDIO_DCT,
565 AV_CODEC_ID_AAC_LATM,
570 AV_CODEC_ID_8SVX_EXP,
571 AV_CODEC_ID_8SVX_FIB,
572 AV_CODEC_ID_BMV_AUDIO,
577 AV_CODEC_ID_COMFORT_NOISE,
579 AV_CODEC_ID_METASOUND,
580 AV_CODEC_ID_PAF_AUDIO,
584 AV_CODEC_ID_FFWAVESYNTH = 0x15800,
586 AV_CODEC_ID_SONIC_LS,
589 AV_CODEC_ID_DSD_LSBF,
590 AV_CODEC_ID_DSD_MSBF,
591 AV_CODEC_ID_DSD_LSBF_PLANAR,
592 AV_CODEC_ID_DSD_MSBF_PLANAR,
594 AV_CODEC_ID_INTERPLAY_ACM,
599 /* subtitle codecs */
600 AV_CODEC_ID_FIRST_SUBTITLE = 0x17000, ///< A dummy ID pointing at the start of subtitle codecs.
601 AV_CODEC_ID_DVD_SUBTITLE = 0x17000,
602 AV_CODEC_ID_DVB_SUBTITLE,
603 AV_CODEC_ID_TEXT, ///< raw UTF-8 text
606 AV_CODEC_ID_MOV_TEXT,
607 AV_CODEC_ID_HDMV_PGS_SUBTITLE,
608 AV_CODEC_ID_DVB_TELETEXT,
611 AV_CODEC_ID_MICRODVD = 0x17800,
615 AV_CODEC_ID_REALTEXT,
617 AV_CODEC_ID_SUBVIEWER1,
618 AV_CODEC_ID_SUBVIEWER,
625 AV_CODEC_ID_HDMV_TEXT_SUBTITLE,
627 /* other specific kind of codecs (generally used for attachments) */
628 AV_CODEC_ID_FIRST_UNKNOWN = 0x18000, ///< A dummy ID pointing at the start of various fake codecs.
629 AV_CODEC_ID_TTF = 0x18000,
631 AV_CODEC_ID_BINTEXT = 0x18800,
635 AV_CODEC_ID_SMPTE_KLV,
637 AV_CODEC_ID_TIMED_ID3,
638 AV_CODEC_ID_BIN_DATA,
641 AV_CODEC_ID_PROBE = 0x19000, ///< codec_id is not known (like AV_CODEC_ID_NONE) but lavf should attempt to identify it
643 AV_CODEC_ID_MPEG2TS = 0x20000, /**< _FAKE_ codec to indicate a raw MPEG-2 TS
644 * stream (only used by libavformat) */
645 AV_CODEC_ID_MPEG4SYSTEMS = 0x20001, /**< _FAKE_ codec to indicate a MPEG-4 Systems
646 * stream (only used by libavformat) */
647 AV_CODEC_ID_FFMETADATA = 0x21000, ///< Dummy codec for streams containing only metadata information.
648 AV_CODEC_ID_WRAPPED_AVFRAME = 0x21001, ///< Passthrough codec, AVFrames wrapped in AVPacket
652 * This struct describes the properties of a single codec described by an
654 * @see avcodec_descriptor_get()
656 typedef struct AVCodecDescriptor {
658 enum AVMediaType type;
660 * Name of the codec described by this descriptor. It is non-empty and
661 * unique for each codec descriptor. It should contain alphanumeric
662 * characters and '_' only.
666 * A more descriptive name for this codec. May be NULL.
668 const char *long_name;
670 * Codec properties, a combination of AV_CODEC_PROP_* flags.
674 * MIME type(s) associated with the codec.
675 * May be NULL; if not, a NULL-terminated array of MIME types.
676 * The first item is always non-NULL and is the preferred MIME type.
678 const char *const *mime_types;
680 * If non-NULL, an array of profiles recognized for this codec.
681 * Terminated with FF_PROFILE_UNKNOWN.
683 const struct AVProfile *profiles;
687 * Codec uses only intra compression.
690 #define AV_CODEC_PROP_INTRA_ONLY (1 << 0)
692 * Codec supports lossy compression. Audio and video codecs only.
693 * @note a codec may support both lossy and lossless
696 #define AV_CODEC_PROP_LOSSY (1 << 1)
698 * Codec supports lossless compression. Audio and video codecs only.
700 #define AV_CODEC_PROP_LOSSLESS (1 << 2)
702 * Codec supports frame reordering. That is, the coded order (the order in which
703 * the encoded packets are output by the encoders / stored / input to the
704 * decoders) may be different from the presentation order of the corresponding
707 * For codecs that do not have this property set, PTS and DTS should always be
710 #define AV_CODEC_PROP_REORDER (1 << 3)
712 * Subtitle codec is bitmap based
713 * Decoded AVSubtitle data can be read from the AVSubtitleRect->pict field.
715 #define AV_CODEC_PROP_BITMAP_SUB (1 << 16)
717 * Subtitle codec is text based.
718 * Decoded AVSubtitle data can be read from the AVSubtitleRect->ass field.
720 #define AV_CODEC_PROP_TEXT_SUB (1 << 17)
723 * @ingroup lavc_decoding
724 * Required number of additionally allocated bytes at the end of the input bitstream for decoding.
725 * This is mainly needed because some optimized bitstream readers read
726 * 32 or 64 bit at once and could read over the end.<br>
727 * Note: If the first 23 bits of the additional bytes are not 0, then damaged
728 * MPEG bitstreams could cause overread and segfault.
730 #define AV_INPUT_BUFFER_PADDING_SIZE 32
733 * @ingroup lavc_encoding
734 * minimum encoding buffer size
735 * Used to avoid some checks during header writing.
737 #define AV_INPUT_BUFFER_MIN_SIZE 16384
739 #if FF_API_WITHOUT_PREFIX
741 * @deprecated use AV_INPUT_BUFFER_PADDING_SIZE instead
743 #define FF_INPUT_BUFFER_PADDING_SIZE 32
746 * @deprecated use AV_INPUT_BUFFER_MIN_SIZE instead
748 #define FF_MIN_BUFFER_SIZE 16384
749 #endif /* FF_API_WITHOUT_PREFIX */
752 * @ingroup lavc_encoding
753 * motion estimation type.
754 * @deprecated use codec private option instead
756 #if FF_API_MOTION_EST
758 ME_ZERO = 1, ///< no search, that is use 0,0 vector whenever one is needed
762 ME_EPZS, ///< enhanced predictive zonal search
763 ME_X1, ///< reserved for experiments
764 ME_HEX, ///< hexagon based search
765 ME_UMH, ///< uneven multi-hexagon search
766 ME_TESA, ///< transformed exhaustive search algorithm
767 ME_ITER=50, ///< iterative search
772 * @ingroup lavc_decoding
775 /* We leave some space between them for extensions (drop some
776 * keyframes for intra-only or drop just some bidir frames). */
777 AVDISCARD_NONE =-16, ///< discard nothing
778 AVDISCARD_DEFAULT = 0, ///< discard useless packets like 0 size packets in avi
779 AVDISCARD_NONREF = 8, ///< discard all non reference
780 AVDISCARD_BIDIR = 16, ///< discard all bidirectional frames
781 AVDISCARD_NONINTRA= 24, ///< discard all non intra frames
782 AVDISCARD_NONKEY = 32, ///< discard all frames except keyframes
783 AVDISCARD_ALL = 48, ///< discard all
786 enum AVAudioServiceType {
787 AV_AUDIO_SERVICE_TYPE_MAIN = 0,
788 AV_AUDIO_SERVICE_TYPE_EFFECTS = 1,
789 AV_AUDIO_SERVICE_TYPE_VISUALLY_IMPAIRED = 2,
790 AV_AUDIO_SERVICE_TYPE_HEARING_IMPAIRED = 3,
791 AV_AUDIO_SERVICE_TYPE_DIALOGUE = 4,
792 AV_AUDIO_SERVICE_TYPE_COMMENTARY = 5,
793 AV_AUDIO_SERVICE_TYPE_EMERGENCY = 6,
794 AV_AUDIO_SERVICE_TYPE_VOICE_OVER = 7,
795 AV_AUDIO_SERVICE_TYPE_KARAOKE = 8,
796 AV_AUDIO_SERVICE_TYPE_NB , ///< Not part of ABI
800 * @ingroup lavc_encoding
802 typedef struct RcOverride{
805 int qscale; // If this is 0 then quality_factor will be used instead.
806 float quality_factor;
809 #if FF_API_MAX_BFRAMES
811 * @deprecated there is no libavcodec-wide limit on the number of B-frames
813 #define FF_MAX_B_FRAMES 16
817 These flags can be passed in AVCodecContext.flags before initialization.
818 Note: Not everything is supported yet.
822 * Allow decoders to produce frames with data planes that are not aligned
823 * to CPU requirements (e.g. due to cropping).
825 #define AV_CODEC_FLAG_UNALIGNED (1 << 0)
829 #define AV_CODEC_FLAG_QSCALE (1 << 1)
831 * 4 MV per MB allowed / advanced prediction for H.263.
833 #define AV_CODEC_FLAG_4MV (1 << 2)
835 * Output even those frames that might be corrupted.
837 #define AV_CODEC_FLAG_OUTPUT_CORRUPT (1 << 3)
841 #define AV_CODEC_FLAG_QPEL (1 << 4)
843 * Use internal 2pass ratecontrol in first pass mode.
845 #define AV_CODEC_FLAG_PASS1 (1 << 9)
847 * Use internal 2pass ratecontrol in second pass mode.
849 #define AV_CODEC_FLAG_PASS2 (1 << 10)
853 #define AV_CODEC_FLAG_LOOP_FILTER (1 << 11)
855 * Only decode/encode grayscale.
857 #define AV_CODEC_FLAG_GRAY (1 << 13)
859 * error[?] variables will be set during encoding.
861 #define AV_CODEC_FLAG_PSNR (1 << 15)
863 * Input bitstream might be truncated at a random location
864 * instead of only at frame boundaries.
866 #define AV_CODEC_FLAG_TRUNCATED (1 << 16)
868 * Use interlaced DCT.
870 #define AV_CODEC_FLAG_INTERLACED_DCT (1 << 18)
874 #define AV_CODEC_FLAG_LOW_DELAY (1 << 19)
876 * Place global headers in extradata instead of every keyframe.
878 #define AV_CODEC_FLAG_GLOBAL_HEADER (1 << 22)
880 * Use only bitexact stuff (except (I)DCT).
882 #define AV_CODEC_FLAG_BITEXACT (1 << 23)
883 /* Fx : Flag for H.263+ extra options */
885 * H.263 advanced intra coding / MPEG-4 AC prediction
887 #define AV_CODEC_FLAG_AC_PRED (1 << 24)
889 * interlaced motion estimation
891 #define AV_CODEC_FLAG_INTERLACED_ME (1 << 29)
892 #define AV_CODEC_FLAG_CLOSED_GOP (1U << 31)
895 * Allow non spec compliant speedup tricks.
897 #define AV_CODEC_FLAG2_FAST (1 << 0)
899 * Skip bitstream encoding.
901 #define AV_CODEC_FLAG2_NO_OUTPUT (1 << 2)
903 * Place global headers at every keyframe instead of in extradata.
905 #define AV_CODEC_FLAG2_LOCAL_HEADER (1 << 3)
908 * timecode is in drop frame format. DEPRECATED!!!!
910 #define AV_CODEC_FLAG2_DROP_FRAME_TIMECODE (1 << 13)
913 * Input bitstream might be truncated at a packet boundaries
914 * instead of only at frame boundaries.
916 #define AV_CODEC_FLAG2_CHUNKS (1 << 15)
918 * Discard cropping information from SPS.
920 #define AV_CODEC_FLAG2_IGNORE_CROP (1 << 16)
923 * Show all frames before the first keyframe
925 #define AV_CODEC_FLAG2_SHOW_ALL (1 << 22)
927 * Export motion vectors through frame side data
929 #define AV_CODEC_FLAG2_EXPORT_MVS (1 << 28)
931 * Do not skip samples and export skip information as frame side data
933 #define AV_CODEC_FLAG2_SKIP_MANUAL (1 << 29)
935 * Do not reset ASS ReadOrder field on flush (subtitles decoding)
937 #define AV_CODEC_FLAG2_RO_FLUSH_NOOP (1 << 30)
939 /* Unsupported options :
940 * Syntax Arithmetic coding (SAC)
941 * Reference Picture Selection
942 * Independent Segment Decoding */
944 /* codec capabilities */
947 * Decoder can use draw_horiz_band callback.
949 #define AV_CODEC_CAP_DRAW_HORIZ_BAND (1 << 0)
951 * Codec uses get_buffer() for allocating buffers and supports custom allocators.
952 * If not set, it might not use get_buffer() at all or use operations that
953 * assume the buffer was allocated by avcodec_default_get_buffer.
955 #define AV_CODEC_CAP_DR1 (1 << 1)
956 #define AV_CODEC_CAP_TRUNCATED (1 << 3)
958 * Encoder or decoder requires flushing with NULL input at the end in order to
959 * give the complete and correct output.
961 * NOTE: If this flag is not set, the codec is guaranteed to never be fed with
962 * with NULL data. The user can still send NULL data to the public encode
963 * or decode function, but libavcodec will not pass it along to the codec
964 * unless this flag is set.
967 * The decoder has a non-zero delay and needs to be fed with avpkt->data=NULL,
968 * avpkt->size=0 at the end to get the delayed data until the decoder no longer
972 * The encoder needs to be fed with NULL data at the end of encoding until the
973 * encoder no longer returns data.
975 * NOTE: For encoders implementing the AVCodec.encode2() function, setting this
976 * flag also means that the encoder must set the pts and duration for
977 * each output packet. If this flag is not set, the pts and duration will
978 * be determined by libavcodec from the input frame.
980 #define AV_CODEC_CAP_DELAY (1 << 5)
982 * Codec can be fed a final frame with a smaller size.
983 * This can be used to prevent truncation of the last audio samples.
985 #define AV_CODEC_CAP_SMALL_LAST_FRAME (1 << 6)
989 * Codec can export data for HW decoding (VDPAU).
991 #define AV_CODEC_CAP_HWACCEL_VDPAU (1 << 7)
995 * Codec can output multiple frames per AVPacket
996 * Normally demuxers return one frame at a time, demuxers which do not do
997 * are connected to a parser to split what they return into proper frames.
998 * This flag is reserved to the very rare category of codecs which have a
999 * bitstream that cannot be split into frames without timeconsuming
1000 * operations like full decoding. Demuxers carrying such bitstreams thus
1001 * may return multiple frames in a packet. This has many disadvantages like
1002 * prohibiting stream copy in many cases thus it should only be considered
1005 #define AV_CODEC_CAP_SUBFRAMES (1 << 8)
1007 * Codec is experimental and is thus avoided in favor of non experimental
1010 #define AV_CODEC_CAP_EXPERIMENTAL (1 << 9)
1012 * Codec should fill in channel configuration and samplerate instead of container
1014 #define AV_CODEC_CAP_CHANNEL_CONF (1 << 10)
1016 * Codec supports frame-level multithreading.
1018 #define AV_CODEC_CAP_FRAME_THREADS (1 << 12)
1020 * Codec supports slice-based (or partition-based) multithreading.
1022 #define AV_CODEC_CAP_SLICE_THREADS (1 << 13)
1024 * Codec supports changed parameters at any point.
1026 #define AV_CODEC_CAP_PARAM_CHANGE (1 << 14)
1028 * Codec supports avctx->thread_count == 0 (auto).
1030 #define AV_CODEC_CAP_AUTO_THREADS (1 << 15)
1032 * Audio encoder supports receiving a different number of samples in each call.
1034 #define AV_CODEC_CAP_VARIABLE_FRAME_SIZE (1 << 16)
1036 * Codec is intra only.
1038 #define AV_CODEC_CAP_INTRA_ONLY 0x40000000
1040 * Codec is lossless.
1042 #define AV_CODEC_CAP_LOSSLESS 0x80000000
1045 #if FF_API_WITHOUT_PREFIX
1047 * Allow decoders to produce frames with data planes that are not aligned
1048 * to CPU requirements (e.g. due to cropping).
1050 #define CODEC_FLAG_UNALIGNED AV_CODEC_FLAG_UNALIGNED
1051 #define CODEC_FLAG_QSCALE AV_CODEC_FLAG_QSCALE
1052 #define CODEC_FLAG_4MV AV_CODEC_FLAG_4MV
1053 #define CODEC_FLAG_OUTPUT_CORRUPT AV_CODEC_FLAG_OUTPUT_CORRUPT
1054 #define CODEC_FLAG_QPEL AV_CODEC_FLAG_QPEL
1057 * @deprecated use the "gmc" private option of the libxvid encoder
1059 #define CODEC_FLAG_GMC 0x0020 ///< Use GMC.
1063 * @deprecated use the flag "mv0" in the "mpv_flags" private option of the
1064 * mpegvideo encoders
1066 #define CODEC_FLAG_MV0 0x0040
1068 #if FF_API_INPUT_PRESERVED
1070 * @deprecated passing reference-counted frames to the encoders replaces this
1073 #define CODEC_FLAG_INPUT_PRESERVED 0x0100
1075 #define CODEC_FLAG_PASS1 AV_CODEC_FLAG_PASS1
1076 #define CODEC_FLAG_PASS2 AV_CODEC_FLAG_PASS2
1077 #define CODEC_FLAG_GRAY AV_CODEC_FLAG_GRAY
1080 * @deprecated edges are not used/required anymore. I.e. this flag is now always
1083 #define CODEC_FLAG_EMU_EDGE 0x4000
1085 #define CODEC_FLAG_PSNR AV_CODEC_FLAG_PSNR
1086 #define CODEC_FLAG_TRUNCATED AV_CODEC_FLAG_TRUNCATED
1088 #if FF_API_NORMALIZE_AQP
1090 * @deprecated use the flag "naq" in the "mpv_flags" private option of the
1091 * mpegvideo encoders
1093 #define CODEC_FLAG_NORMALIZE_AQP 0x00020000
1095 #define CODEC_FLAG_INTERLACED_DCT AV_CODEC_FLAG_INTERLACED_DCT
1096 #define CODEC_FLAG_LOW_DELAY AV_CODEC_FLAG_LOW_DELAY
1097 #define CODEC_FLAG_GLOBAL_HEADER AV_CODEC_FLAG_GLOBAL_HEADER
1098 #define CODEC_FLAG_BITEXACT AV_CODEC_FLAG_BITEXACT
1099 #define CODEC_FLAG_AC_PRED AV_CODEC_FLAG_AC_PRED
1100 #define CODEC_FLAG_LOOP_FILTER AV_CODEC_FLAG_LOOP_FILTER
1101 #define CODEC_FLAG_INTERLACED_ME AV_CODEC_FLAG_INTERLACED_ME
1102 #define CODEC_FLAG_CLOSED_GOP AV_CODEC_FLAG_CLOSED_GOP
1103 #define CODEC_FLAG2_FAST AV_CODEC_FLAG2_FAST
1104 #define CODEC_FLAG2_NO_OUTPUT AV_CODEC_FLAG2_NO_OUTPUT
1105 #define CODEC_FLAG2_LOCAL_HEADER AV_CODEC_FLAG2_LOCAL_HEADER
1106 #define CODEC_FLAG2_DROP_FRAME_TIMECODE AV_CODEC_FLAG2_DROP_FRAME_TIMECODE
1107 #define CODEC_FLAG2_IGNORE_CROP AV_CODEC_FLAG2_IGNORE_CROP
1109 #define CODEC_FLAG2_CHUNKS AV_CODEC_FLAG2_CHUNKS
1110 #define CODEC_FLAG2_SHOW_ALL AV_CODEC_FLAG2_SHOW_ALL
1111 #define CODEC_FLAG2_EXPORT_MVS AV_CODEC_FLAG2_EXPORT_MVS
1112 #define CODEC_FLAG2_SKIP_MANUAL AV_CODEC_FLAG2_SKIP_MANUAL
1114 /* Unsupported options :
1115 * Syntax Arithmetic coding (SAC)
1116 * Reference Picture Selection
1117 * Independent Segment Decoding */
1119 /* codec capabilities */
1121 #define CODEC_CAP_DRAW_HORIZ_BAND AV_CODEC_CAP_DRAW_HORIZ_BAND ///< Decoder can use draw_horiz_band callback.
1123 * Codec uses get_buffer() for allocating buffers and supports custom allocators.
1124 * If not set, it might not use get_buffer() at all or use operations that
1125 * assume the buffer was allocated by avcodec_default_get_buffer.
1127 #define CODEC_CAP_DR1 AV_CODEC_CAP_DR1
1128 #define CODEC_CAP_TRUNCATED AV_CODEC_CAP_TRUNCATED
1130 /* Codec can export data for HW decoding. This flag indicates that
1131 * the codec would call get_format() with list that might contain HW accelerated
1132 * pixel formats (XvMC, VDPAU, VAAPI, etc). The application can pick any of them
1133 * including raw image format.
1134 * The application can use the passed context to determine bitstream version,
1135 * chroma format, resolution etc.
1137 #define CODEC_CAP_HWACCEL 0x0010
1138 #endif /* FF_API_XVMC */
1140 * Encoder or decoder requires flushing with NULL input at the end in order to
1141 * give the complete and correct output.
1143 * NOTE: If this flag is not set, the codec is guaranteed to never be fed with
1144 * with NULL data. The user can still send NULL data to the public encode
1145 * or decode function, but libavcodec will not pass it along to the codec
1146 * unless this flag is set.
1149 * The decoder has a non-zero delay and needs to be fed with avpkt->data=NULL,
1150 * avpkt->size=0 at the end to get the delayed data until the decoder no longer
1154 * The encoder needs to be fed with NULL data at the end of encoding until the
1155 * encoder no longer returns data.
1157 * NOTE: For encoders implementing the AVCodec.encode2() function, setting this
1158 * flag also means that the encoder must set the pts and duration for
1159 * each output packet. If this flag is not set, the pts and duration will
1160 * be determined by libavcodec from the input frame.
1162 #define CODEC_CAP_DELAY AV_CODEC_CAP_DELAY
1164 * Codec can be fed a final frame with a smaller size.
1165 * This can be used to prevent truncation of the last audio samples.
1167 #define CODEC_CAP_SMALL_LAST_FRAME AV_CODEC_CAP_SMALL_LAST_FRAME
1168 #if FF_API_CAP_VDPAU
1170 * Codec can export data for HW decoding (VDPAU).
1172 #define CODEC_CAP_HWACCEL_VDPAU AV_CODEC_CAP_HWACCEL_VDPAU
1175 * Codec can output multiple frames per AVPacket
1176 * Normally demuxers return one frame at a time, demuxers which do not do
1177 * are connected to a parser to split what they return into proper frames.
1178 * This flag is reserved to the very rare category of codecs which have a
1179 * bitstream that cannot be split into frames without timeconsuming
1180 * operations like full decoding. Demuxers carrying such bitstreams thus
1181 * may return multiple frames in a packet. This has many disadvantages like
1182 * prohibiting stream copy in many cases thus it should only be considered
1185 #define CODEC_CAP_SUBFRAMES AV_CODEC_CAP_SUBFRAMES
1187 * Codec is experimental and is thus avoided in favor of non experimental
1190 #define CODEC_CAP_EXPERIMENTAL AV_CODEC_CAP_EXPERIMENTAL
1192 * Codec should fill in channel configuration and samplerate instead of container
1194 #define CODEC_CAP_CHANNEL_CONF AV_CODEC_CAP_CHANNEL_CONF
1195 #if FF_API_NEG_LINESIZES
1197 * @deprecated no codecs use this capability
1199 #define CODEC_CAP_NEG_LINESIZES 0x0800
1202 * Codec supports frame-level multithreading.
1204 #define CODEC_CAP_FRAME_THREADS AV_CODEC_CAP_FRAME_THREADS
1206 * Codec supports slice-based (or partition-based) multithreading.
1208 #define CODEC_CAP_SLICE_THREADS AV_CODEC_CAP_SLICE_THREADS
1210 * Codec supports changed parameters at any point.
1212 #define CODEC_CAP_PARAM_CHANGE AV_CODEC_CAP_PARAM_CHANGE
1214 * Codec supports avctx->thread_count == 0 (auto).
1216 #define CODEC_CAP_AUTO_THREADS AV_CODEC_CAP_AUTO_THREADS
1218 * Audio encoder supports receiving a different number of samples in each call.
1220 #define CODEC_CAP_VARIABLE_FRAME_SIZE AV_CODEC_CAP_VARIABLE_FRAME_SIZE
1222 * Codec is intra only.
1224 #define CODEC_CAP_INTRA_ONLY AV_CODEC_CAP_INTRA_ONLY
1226 * Codec is lossless.
1228 #define CODEC_CAP_LOSSLESS AV_CODEC_CAP_LOSSLESS
1231 * HWAccel is experimental and is thus avoided in favor of non experimental
1234 #define HWACCEL_CODEC_CAP_EXPERIMENTAL 0x0200
1235 #endif /* FF_API_WITHOUT_PREFIX */
1238 //The following defines may change, don't expect compatibility if you use them.
1239 #define MB_TYPE_INTRA4x4 0x0001
1240 #define MB_TYPE_INTRA16x16 0x0002 //FIXME H.264-specific
1241 #define MB_TYPE_INTRA_PCM 0x0004 //FIXME H.264-specific
1242 #define MB_TYPE_16x16 0x0008
1243 #define MB_TYPE_16x8 0x0010
1244 #define MB_TYPE_8x16 0x0020
1245 #define MB_TYPE_8x8 0x0040
1246 #define MB_TYPE_INTERLACED 0x0080
1247 #define MB_TYPE_DIRECT2 0x0100 //FIXME
1248 #define MB_TYPE_ACPRED 0x0200
1249 #define MB_TYPE_GMC 0x0400
1250 #define MB_TYPE_SKIP 0x0800
1251 #define MB_TYPE_P0L0 0x1000
1252 #define MB_TYPE_P1L0 0x2000
1253 #define MB_TYPE_P0L1 0x4000
1254 #define MB_TYPE_P1L1 0x8000
1255 #define MB_TYPE_L0 (MB_TYPE_P0L0 | MB_TYPE_P1L0)
1256 #define MB_TYPE_L1 (MB_TYPE_P0L1 | MB_TYPE_P1L1)
1257 #define MB_TYPE_L0L1 (MB_TYPE_L0 | MB_TYPE_L1)
1258 #define MB_TYPE_QUANT 0x00010000
1259 #define MB_TYPE_CBP 0x00020000
1260 // Note bits 24-31 are reserved for codec specific use (H.264 ref0, MPEG-1 0mv, ...)
1265 * This specifies the area which should be displayed.
1266 * Note there may be multiple such areas for one frame.
1268 typedef struct AVPanScan{
1271 * - encoding: Set by user.
1272 * - decoding: Set by libavcodec.
1277 * width and height in 1/16 pel
1278 * - encoding: Set by user.
1279 * - decoding: Set by libavcodec.
1285 * position of the top left corner in 1/16 pel for up to 3 fields/frames
1286 * - encoding: Set by user.
1287 * - decoding: Set by libavcodec.
1289 int16_t position[3][2];
1293 * This structure describes the bitrate properties of an encoded bitstream. It
1294 * roughly corresponds to a subset the VBV parameters for MPEG-2 or HRD
1295 * parameters for H.264/HEVC.
1297 typedef struct AVCPBProperties {
1299 * Maximum bitrate of the stream, in bits per second.
1300 * Zero if unknown or unspecified.
1304 * Minimum bitrate of the stream, in bits per second.
1305 * Zero if unknown or unspecified.
1309 * Average bitrate of the stream, in bits per second.
1310 * Zero if unknown or unspecified.
1315 * The size of the buffer to which the ratecontrol is applied, in bits.
1316 * Zero if unknown or unspecified.
1321 * The delay between the time the packet this structure is associated with
1322 * is received and the time when it should be decoded, in periods of a 27MHz
1325 * UINT64_MAX when unknown or unspecified.
1330 #if FF_API_QSCALE_TYPE
1331 #define FF_QSCALE_TYPE_MPEG1 0
1332 #define FF_QSCALE_TYPE_MPEG2 1
1333 #define FF_QSCALE_TYPE_H264 2
1334 #define FF_QSCALE_TYPE_VP56 3
1338 * The decoder will keep a reference to the frame and may reuse it later.
1340 #define AV_GET_BUFFER_FLAG_REF (1 << 0)
1343 * @defgroup lavc_packet AVPacket
1345 * Types and functions for working with AVPacket.
1348 enum AVPacketSideDataType {
1349 AV_PKT_DATA_PALETTE,
1350 AV_PKT_DATA_NEW_EXTRADATA,
1353 * An AV_PKT_DATA_PARAM_CHANGE side data packet is laid out as follows:
1356 * if (param_flags & AV_SIDE_DATA_PARAM_CHANGE_CHANNEL_COUNT)
1357 * s32le channel_count
1358 * if (param_flags & AV_SIDE_DATA_PARAM_CHANGE_CHANNEL_LAYOUT)
1359 * u64le channel_layout
1360 * if (param_flags & AV_SIDE_DATA_PARAM_CHANGE_SAMPLE_RATE)
1362 * if (param_flags & AV_SIDE_DATA_PARAM_CHANGE_DIMENSIONS)
1367 AV_PKT_DATA_PARAM_CHANGE,
1370 * An AV_PKT_DATA_H263_MB_INFO side data packet contains a number of
1371 * structures with info about macroblocks relevant to splitting the
1372 * packet into smaller packets on macroblock edges (e.g. as for RFC 2190).
1373 * That is, it does not necessarily contain info about all macroblocks,
1374 * as long as the distance between macroblocks in the info is smaller
1375 * than the target payload size.
1376 * Each MB info structure is 12 bytes, and is laid out as follows:
1378 * u32le bit offset from the start of the packet
1379 * u8 current quantizer at the start of the macroblock
1381 * u16le macroblock address within the GOB
1382 * u8 horizontal MV predictor
1383 * u8 vertical MV predictor
1384 * u8 horizontal MV predictor for block number 3
1385 * u8 vertical MV predictor for block number 3
1388 AV_PKT_DATA_H263_MB_INFO,
1391 * This side data should be associated with an audio stream and contains
1392 * ReplayGain information in form of the AVReplayGain struct.
1394 AV_PKT_DATA_REPLAYGAIN,
1397 * This side data contains a 3x3 transformation matrix describing an affine
1398 * transformation that needs to be applied to the decoded video frames for
1399 * correct presentation.
1401 * See libavutil/display.h for a detailed description of the data.
1403 AV_PKT_DATA_DISPLAYMATRIX,
1406 * This side data should be associated with a video stream and contains
1407 * Stereoscopic 3D information in form of the AVStereo3D struct.
1409 AV_PKT_DATA_STEREO3D,
1412 * This side data should be associated with an audio stream and corresponds
1413 * to enum AVAudioServiceType.
1415 AV_PKT_DATA_AUDIO_SERVICE_TYPE,
1418 * This side data contains quality related information from the encoder.
1420 * u32le quality factor of the compressed frame. Allowed range is between 1 (good) and FF_LAMBDA_MAX (bad).
1424 * u64le[error count] sum of squared differences between encoder in and output
1427 AV_PKT_DATA_QUALITY_STATS,
1430 * This side data contains an integer value representing the stream index
1431 * of a "fallback" track. A fallback track indicates an alternate
1432 * track to use when the current track can not be decoded for some reason.
1433 * e.g. no decoder available for codec.
1435 AV_PKT_DATA_FALLBACK_TRACK,
1438 * This side data corresponds to the AVCPBProperties struct.
1440 AV_PKT_DATA_CPB_PROPERTIES,
1443 * Recommmends skipping the specified number of samples
1445 * u32le number of samples to skip from start of this packet
1446 * u32le number of samples to skip from end of this packet
1447 * u8 reason for start skip
1448 * u8 reason for end skip (0=padding silence, 1=convergence)
1451 AV_PKT_DATA_SKIP_SAMPLES=70,
1454 * An AV_PKT_DATA_JP_DUALMONO side data packet indicates that
1455 * the packet may contain "dual mono" audio specific to Japanese DTV
1456 * and if it is true, recommends only the selected channel to be used.
1458 * u8 selected channels (0=mail/left, 1=sub/right, 2=both)
1461 AV_PKT_DATA_JP_DUALMONO,
1464 * A list of zero terminated key/value strings. There is no end marker for
1465 * the list, so it is required to rely on the side data size to stop.
1467 AV_PKT_DATA_STRINGS_METADATA,
1470 * Subtitle event position
1478 AV_PKT_DATA_SUBTITLE_POSITION,
1481 * Data found in BlockAdditional element of matroska container. There is
1482 * no end marker for the data, so it is required to rely on the side data
1483 * size to recognize the end. 8 byte id (as found in BlockAddId) followed
1486 AV_PKT_DATA_MATROSKA_BLOCKADDITIONAL,
1489 * The optional first identifier line of a WebVTT cue.
1491 AV_PKT_DATA_WEBVTT_IDENTIFIER,
1494 * The optional settings (rendering instructions) that immediately
1495 * follow the timestamp specifier of a WebVTT cue.
1497 AV_PKT_DATA_WEBVTT_SETTINGS,
1500 * A list of zero terminated key/value strings. There is no end marker for
1501 * the list, so it is required to rely on the side data size to stop. This
1502 * side data includes updated metadata which appeared in the stream.
1504 AV_PKT_DATA_METADATA_UPDATE,
1507 * MPEGTS stream ID, this is required to pass the stream ID
1508 * information from the demuxer to the corresponding muxer.
1510 AV_PKT_DATA_MPEGTS_STREAM_ID,
1513 * Mastering display metadata (based on SMPTE-2086:2014). This metadata
1514 * should be associated with a video stream and containts data in the form
1515 * of the AVMasteringDisplayMetadata struct.
1517 AV_PKT_DATA_MASTERING_DISPLAY_METADATA
1520 #define AV_PKT_DATA_QUALITY_FACTOR AV_PKT_DATA_QUALITY_STATS //DEPRECATED
1522 typedef struct AVPacketSideData {
1525 enum AVPacketSideDataType type;
1529 * This structure stores compressed data. It is typically exported by demuxers
1530 * and then passed as input to decoders, or received as output from encoders and
1531 * then passed to muxers.
1533 * For video, it should typically contain one compressed frame. For audio it may
1534 * contain several compressed frames. Encoders are allowed to output empty
1535 * packets, with no compressed data, containing only side data
1536 * (e.g. to update some stream parameters at the end of encoding).
1538 * AVPacket is one of the few structs in FFmpeg, whose size is a part of public
1539 * ABI. Thus it may be allocated on stack and no new fields can be added to it
1540 * without libavcodec and libavformat major bump.
1542 * The semantics of data ownership depends on the buf field.
1543 * If it is set, the packet data is dynamically allocated and is
1544 * valid indefinitely until a call to av_packet_unref() reduces the
1545 * reference count to 0.
1547 * If the buf field is not set av_packet_ref() would make a copy instead
1548 * of increasing the reference count.
1550 * The side data is always allocated with av_malloc(), copied by
1551 * av_packet_ref() and freed by av_packet_unref().
1553 * @see av_packet_ref
1554 * @see av_packet_unref
1556 typedef struct AVPacket {
1558 * A reference to the reference-counted buffer where the packet data is
1560 * May be NULL, then the packet data is not reference-counted.
1564 * Presentation timestamp in AVStream->time_base units; the time at which
1565 * the decompressed packet will be presented to the user.
1566 * Can be AV_NOPTS_VALUE if it is not stored in the file.
1567 * pts MUST be larger or equal to dts as presentation cannot happen before
1568 * decompression, unless one wants to view hex dumps. Some formats misuse
1569 * the terms dts and pts/cts to mean something different. Such timestamps
1570 * must be converted to true pts/dts before they are stored in AVPacket.
1574 * Decompression timestamp in AVStream->time_base units; the time at which
1575 * the packet is decompressed.
1576 * Can be AV_NOPTS_VALUE if it is not stored in the file.
1583 * A combination of AV_PKT_FLAG values
1587 * Additional packet data that can be provided by the container.
1588 * Packet can contain several types of side information.
1590 AVPacketSideData *side_data;
1591 int side_data_elems;
1594 * Duration of this packet in AVStream->time_base units, 0 if unknown.
1595 * Equals next_pts - this_pts in presentation order.
1599 int64_t pos; ///< byte position in stream, -1 if unknown
1601 #if FF_API_CONVERGENCE_DURATION
1603 * @deprecated Same as the duration field, but as int64_t. This was required
1604 * for Matroska subtitles, whose duration values could overflow when the
1605 * duration field was still an int.
1607 attribute_deprecated
1608 int64_t convergence_duration;
1611 #define AV_PKT_FLAG_KEY 0x0001 ///< The packet contains a keyframe
1612 #define AV_PKT_FLAG_CORRUPT 0x0002 ///< The packet content is corrupted
1614 enum AVSideDataParamChangeFlags {
1615 AV_SIDE_DATA_PARAM_CHANGE_CHANNEL_COUNT = 0x0001,
1616 AV_SIDE_DATA_PARAM_CHANGE_CHANNEL_LAYOUT = 0x0002,
1617 AV_SIDE_DATA_PARAM_CHANGE_SAMPLE_RATE = 0x0004,
1618 AV_SIDE_DATA_PARAM_CHANGE_DIMENSIONS = 0x0008,
1624 struct AVCodecInternal;
1628 AV_FIELD_PROGRESSIVE,
1629 AV_FIELD_TT, //< Top coded_first, top displayed first
1630 AV_FIELD_BB, //< Bottom coded first, bottom displayed first
1631 AV_FIELD_TB, //< Top coded first, bottom displayed first
1632 AV_FIELD_BT, //< Bottom coded first, top displayed first
1636 * main external API structure.
1637 * New fields can be added to the end with minor version bumps.
1638 * Removal, reordering and changes to existing fields require a major
1640 * Please use AVOptions (av_opt* / av_set/get*()) to access these fields from user
1642 * The name string for AVOptions options matches the associated command line
1643 * parameter name and can be found in libavcodec/options_table.h
1644 * The AVOption/command line parameter names differ in some cases from the C
1645 * structure field names for historic reasons or brevity.
1646 * sizeof(AVCodecContext) must not be used outside libav*.
1648 typedef struct AVCodecContext {
1650 * information on struct for av_log
1651 * - set by avcodec_alloc_context3
1653 const AVClass *av_class;
1654 int log_level_offset;
1656 enum AVMediaType codec_type; /* see AVMEDIA_TYPE_xxx */
1657 const struct AVCodec *codec;
1658 #if FF_API_CODEC_NAME
1660 * @deprecated this field is not used for anything in libavcodec
1662 attribute_deprecated
1663 char codec_name[32];
1665 enum AVCodecID codec_id; /* see AV_CODEC_ID_xxx */
1668 * fourcc (LSB first, so "ABCD" -> ('D'<<24) + ('C'<<16) + ('B'<<8) + 'A').
1669 * This is used to work around some encoder bugs.
1670 * A demuxer should set this to what is stored in the field used to identify the codec.
1671 * If there are multiple such fields in a container then the demuxer should choose the one
1672 * which maximizes the information about the used codec.
1673 * If the codec tag field in a container is larger than 32 bits then the demuxer should
1674 * remap the longer ID to 32 bits with a table or other structure. Alternatively a new
1675 * extra_codec_tag + size could be added but for this a clear advantage must be demonstrated
1677 * - encoding: Set by user, if not then the default based on codec_id will be used.
1678 * - decoding: Set by user, will be converted to uppercase by libavcodec during init.
1680 unsigned int codec_tag;
1682 #if FF_API_STREAM_CODEC_TAG
1684 * @deprecated this field is unused
1686 attribute_deprecated
1687 unsigned int stream_codec_tag;
1693 * Private context used for internal data.
1695 * Unlike priv_data, this is not codec-specific. It is used in general
1696 * libavcodec functions.
1698 struct AVCodecInternal *internal;
1701 * Private data of the user, can be used to carry app specific stuff.
1702 * - encoding: Set by user.
1703 * - decoding: Set by user.
1708 * the average bitrate
1709 * - encoding: Set by user; unused for constant quantizer encoding.
1710 * - decoding: Set by user, may be overwritten by libavcodec
1711 * if this info is available in the stream
1716 * number of bits the bitstream is allowed to diverge from the reference.
1717 * the reference can be CBR (for CBR pass1) or VBR (for pass2)
1718 * - encoding: Set by user; unused for constant quantizer encoding.
1719 * - decoding: unused
1721 int bit_rate_tolerance;
1724 * Global quality for codecs which cannot change it per frame.
1725 * This should be proportional to MPEG-1/2/4 qscale.
1726 * - encoding: Set by user.
1727 * - decoding: unused
1732 * - encoding: Set by user.
1733 * - decoding: unused
1735 int compression_level;
1736 #define FF_COMPRESSION_DEFAULT -1
1740 * - encoding: Set by user.
1741 * - decoding: Set by user.
1747 * - encoding: Set by user.
1748 * - decoding: Set by user.
1753 * some codecs need / can use extradata like Huffman tables.
1754 * MJPEG: Huffman tables
1755 * rv10: additional flags
1756 * MPEG-4: global headers (they can be in the bitstream or here)
1757 * The allocated memory should be AV_INPUT_BUFFER_PADDING_SIZE bytes larger
1758 * than extradata_size to avoid problems if it is read with the bitstream reader.
1759 * The bytewise contents of extradata must not depend on the architecture or CPU endianness.
1760 * - encoding: Set/allocated/freed by libavcodec.
1761 * - decoding: Set/allocated/freed by user.
1767 * This is the fundamental unit of time (in seconds) in terms
1768 * of which frame timestamps are represented. For fixed-fps content,
1769 * timebase should be 1/framerate and timestamp increments should be
1771 * This often, but not always is the inverse of the frame rate or field rate
1772 * for video. 1/time_base is not the average frame rate if the frame rate is not
1775 * Like containers, elementary streams also can store timestamps, 1/time_base
1776 * is the unit in which these timestamps are specified.
1777 * As example of such codec time base see ISO/IEC 14496-2:2001(E)
1778 * vop_time_increment_resolution and fixed_vop_rate
1779 * (fixed_vop_rate == 0 implies that it is different from the framerate)
1781 * - encoding: MUST be set by user.
1782 * - decoding: the use of this field for decoding is deprecated.
1783 * Use framerate instead.
1785 AVRational time_base;
1788 * For some codecs, the time base is closer to the field rate than the frame rate.
1789 * Most notably, H.264 and MPEG-2 specify time_base as half of frame duration
1790 * if no telecine is used ...
1792 * Set to time_base ticks per frame. Default 1, e.g., H.264/MPEG-2 set it to 2.
1794 int ticks_per_frame;
1799 * Encoding: Number of frames delay there will be from the encoder input to
1800 * the decoder output. (we assume the decoder matches the spec)
1801 * Decoding: Number of frames delay in addition to what a standard decoder
1802 * as specified in the spec would produce.
1805 * Number of frames the decoded output will be delayed relative to the
1809 * For encoding, this field is unused (see initial_padding).
1811 * For decoding, this is the number of samples the decoder needs to
1812 * output before the decoder's output is valid. When seeking, you should
1813 * start decoding this many samples prior to your desired seek point.
1815 * - encoding: Set by libavcodec.
1816 * - decoding: Set by libavcodec.
1823 * picture width / height.
1825 * @note Those fields may not match the values of the last
1826 * AVFrame output by avcodec_decode_video2 due frame
1829 * - encoding: MUST be set by user.
1830 * - decoding: May be set by the user before opening the decoder if known e.g.
1831 * from the container. Some decoders will require the dimensions
1832 * to be set by the caller. During decoding, the decoder may
1833 * overwrite those values as required while parsing the data.
1838 * Bitstream width / height, may be different from width/height e.g. when
1839 * the decoded frame is cropped before being output or lowres is enabled.
1841 * @note Those field may not match the value of the last
1842 * AVFrame output by avcodec_receive_frame() due frame
1845 * - encoding: unused
1846 * - decoding: May be set by the user before opening the decoder if known
1847 * e.g. from the container. During decoding, the decoder may
1848 * overwrite those values as required while parsing the data.
1850 int coded_width, coded_height;
1852 #if FF_API_ASPECT_EXTENDED
1853 #define FF_ASPECT_EXTENDED 15
1857 * the number of pictures in a group of pictures, or 0 for intra_only
1858 * - encoding: Set by user.
1859 * - decoding: unused
1864 * Pixel format, see AV_PIX_FMT_xxx.
1865 * May be set by the demuxer if known from headers.
1866 * May be overridden by the decoder if it knows better.
1868 * @note This field may not match the value of the last
1869 * AVFrame output by avcodec_receive_frame() due frame
1872 * - encoding: Set by user.
1873 * - decoding: Set by user if known, overridden by libavcodec while
1876 enum AVPixelFormat pix_fmt;
1878 #if FF_API_MOTION_EST
1880 * This option does nothing
1881 * @deprecated use codec private options instead
1883 attribute_deprecated int me_method;
1887 * If non NULL, 'draw_horiz_band' is called by the libavcodec
1888 * decoder to draw a horizontal band. It improves cache usage. Not
1889 * all codecs can do that. You must check the codec capabilities
1891 * When multithreading is used, it may be called from multiple threads
1892 * at the same time; threads might draw different parts of the same AVFrame,
1893 * or multiple AVFrames, and there is no guarantee that slices will be drawn
1895 * The function is also used by hardware acceleration APIs.
1896 * It is called at least once during frame decoding to pass
1897 * the data needed for hardware render.
1898 * In that mode instead of pixel data, AVFrame points to
1899 * a structure specific to the acceleration API. The application
1900 * reads the structure and can change some fields to indicate progress
1902 * - encoding: unused
1903 * - decoding: Set by user.
1904 * @param height the height of the slice
1905 * @param y the y position of the slice
1906 * @param type 1->top field, 2->bottom field, 3->frame
1907 * @param offset offset into the AVFrame.data from which the slice should be read
1909 void (*draw_horiz_band)(struct AVCodecContext *s,
1910 const AVFrame *src, int offset[AV_NUM_DATA_POINTERS],
1911 int y, int type, int height);
1914 * callback to negotiate the pixelFormat
1915 * @param fmt is the list of formats which are supported by the codec,
1916 * it is terminated by -1 as 0 is a valid format, the formats are ordered by quality.
1917 * The first is always the native one.
1918 * @note The callback may be called again immediately if initialization for
1919 * the selected (hardware-accelerated) pixel format failed.
1920 * @warning Behavior is undefined if the callback returns a value not
1921 * in the fmt list of formats.
1922 * @return the chosen format
1923 * - encoding: unused
1924 * - decoding: Set by user, if not set the native format will be chosen.
1926 enum AVPixelFormat (*get_format)(struct AVCodecContext *s, const enum AVPixelFormat * fmt);
1929 * maximum number of B-frames between non-B-frames
1930 * Note: The output will be delayed by max_b_frames+1 relative to the input.
1931 * - encoding: Set by user.
1932 * - decoding: unused
1937 * qscale factor between IP and B-frames
1938 * If > 0 then the last P-frame quantizer will be used (q= lastp_q*factor+offset).
1939 * If < 0 then normal ratecontrol will be done (q= -normal_q*factor+offset).
1940 * - encoding: Set by user.
1941 * - decoding: unused
1943 float b_quant_factor;
1945 #if FF_API_RC_STRATEGY
1946 /** @deprecated use codec private option instead */
1947 attribute_deprecated int rc_strategy;
1948 #define FF_RC_STRATEGY_XVID 1
1951 #if FF_API_PRIVATE_OPT
1952 /** @deprecated use encoder private options instead */
1953 attribute_deprecated
1954 int b_frame_strategy;
1958 * qscale offset between IP and B-frames
1959 * - encoding: Set by user.
1960 * - decoding: unused
1962 float b_quant_offset;
1965 * Size of the frame reordering buffer in the decoder.
1966 * For MPEG-2 it is 1 IPB or 0 low delay IP.
1967 * - encoding: Set by libavcodec.
1968 * - decoding: Set by libavcodec.
1972 #if FF_API_PRIVATE_OPT
1973 /** @deprecated use encoder private options instead */
1974 attribute_deprecated
1979 * qscale factor between P- and I-frames
1980 * If > 0 then the last P-frame quantizer will be used (q = lastp_q * factor + offset).
1981 * If < 0 then normal ratecontrol will be done (q= -normal_q*factor+offset).
1982 * - encoding: Set by user.
1983 * - decoding: unused
1985 float i_quant_factor;
1988 * qscale offset between P and I-frames
1989 * - encoding: Set by user.
1990 * - decoding: unused
1992 float i_quant_offset;
1995 * luminance masking (0-> disabled)
1996 * - encoding: Set by user.
1997 * - decoding: unused
2002 * temporary complexity masking (0-> disabled)
2003 * - encoding: Set by user.
2004 * - decoding: unused
2006 float temporal_cplx_masking;
2009 * spatial complexity masking (0-> disabled)
2010 * - encoding: Set by user.
2011 * - decoding: unused
2013 float spatial_cplx_masking;
2016 * p block masking (0-> disabled)
2017 * - encoding: Set by user.
2018 * - decoding: unused
2023 * darkness masking (0-> disabled)
2024 * - encoding: Set by user.
2025 * - decoding: unused
2031 * - encoding: Set by libavcodec.
2032 * - decoding: Set by user (or 0).
2036 #if FF_API_PRIVATE_OPT
2037 /** @deprecated use encoder private options instead */
2038 attribute_deprecated
2039 int prediction_method;
2040 #define FF_PRED_LEFT 0
2041 #define FF_PRED_PLANE 1
2042 #define FF_PRED_MEDIAN 2
2046 * slice offsets in the frame in bytes
2047 * - encoding: Set/allocated by libavcodec.
2048 * - decoding: Set/allocated by user (or NULL).
2053 * sample aspect ratio (0 if unknown)
2054 * That is the width of a pixel divided by the height of the pixel.
2055 * Numerator and denominator must be relatively prime and smaller than 256 for some video standards.
2056 * - encoding: Set by user.
2057 * - decoding: Set by libavcodec.
2059 AVRational sample_aspect_ratio;
2062 * motion estimation comparison function
2063 * - encoding: Set by user.
2064 * - decoding: unused
2068 * subpixel motion estimation comparison function
2069 * - encoding: Set by user.
2070 * - decoding: unused
2074 * macroblock comparison function (not supported yet)
2075 * - encoding: Set by user.
2076 * - decoding: unused
2080 * interlaced DCT comparison function
2081 * - encoding: Set by user.
2082 * - decoding: unused
2085 #define FF_CMP_SAD 0
2086 #define FF_CMP_SSE 1
2087 #define FF_CMP_SATD 2
2088 #define FF_CMP_DCT 3
2089 #define FF_CMP_PSNR 4
2090 #define FF_CMP_BIT 5
2092 #define FF_CMP_ZERO 7
2093 #define FF_CMP_VSAD 8
2094 #define FF_CMP_VSSE 9
2095 #define FF_CMP_NSSE 10
2096 #define FF_CMP_W53 11
2097 #define FF_CMP_W97 12
2098 #define FF_CMP_DCTMAX 13
2099 #define FF_CMP_DCT264 14
2100 #define FF_CMP_CHROMA 256
2103 * ME diamond size & shape
2104 * - encoding: Set by user.
2105 * - decoding: unused
2110 * amount of previous MV predictors (2a+1 x 2a+1 square)
2111 * - encoding: Set by user.
2112 * - decoding: unused
2114 int last_predictor_count;
2116 #if FF_API_PRIVATE_OPT
2117 /** @deprecated use encoder private options instead */
2118 attribute_deprecated
2123 * motion estimation prepass comparison function
2124 * - encoding: Set by user.
2125 * - decoding: unused
2130 * ME prepass diamond size & shape
2131 * - encoding: Set by user.
2132 * - decoding: unused
2138 * - encoding: Set by user.
2139 * - decoding: unused
2141 int me_subpel_quality;
2145 * DTG active format information (additional aspect ratio
2146 * information only used in DVB MPEG-2 transport streams)
2149 * - encoding: unused
2150 * - decoding: Set by decoder.
2151 * @deprecated Deprecated in favor of AVSideData
2153 attribute_deprecated int dtg_active_format;
2154 #define FF_DTG_AFD_SAME 8
2155 #define FF_DTG_AFD_4_3 9
2156 #define FF_DTG_AFD_16_9 10
2157 #define FF_DTG_AFD_14_9 11
2158 #define FF_DTG_AFD_4_3_SP_14_9 13
2159 #define FF_DTG_AFD_16_9_SP_14_9 14
2160 #define FF_DTG_AFD_SP_4_3 15
2161 #endif /* FF_API_AFD */
2164 * maximum motion estimation search range in subpel units
2165 * If 0 then no limit.
2167 * - encoding: Set by user.
2168 * - decoding: unused
2172 #if FF_API_QUANT_BIAS
2174 * @deprecated use encoder private option instead
2176 attribute_deprecated int intra_quant_bias;
2177 #define FF_DEFAULT_QUANT_BIAS 999999
2180 * @deprecated use encoder private option instead
2182 attribute_deprecated int inter_quant_bias;
2187 * - encoding: unused
2188 * - decoding: Set by user.
2191 #define SLICE_FLAG_CODED_ORDER 0x0001 ///< draw_horiz_band() is called in coded order instead of display
2192 #define SLICE_FLAG_ALLOW_FIELD 0x0002 ///< allow draw_horiz_band() with field slices (MPEG-2 field pics)
2193 #define SLICE_FLAG_ALLOW_PLANE 0x0004 ///< allow draw_horiz_band() with 1 component at a time (SVQ1)
2197 * XVideo Motion Acceleration
2198 * - encoding: forbidden
2199 * - decoding: set by decoder
2200 * @deprecated XvMC doesn't need it anymore.
2202 attribute_deprecated int xvmc_acceleration;
2203 #endif /* FF_API_XVMC */
2206 * macroblock decision mode
2207 * - encoding: Set by user.
2208 * - decoding: unused
2211 #define FF_MB_DECISION_SIMPLE 0 ///< uses mb_cmp
2212 #define FF_MB_DECISION_BITS 1 ///< chooses the one which needs the fewest bits
2213 #define FF_MB_DECISION_RD 2 ///< rate distortion
2216 * custom intra quantization matrix
2217 * - encoding: Set by user, can be NULL.
2218 * - decoding: Set by libavcodec.
2220 uint16_t *intra_matrix;
2223 * custom inter quantization matrix
2224 * - encoding: Set by user, can be NULL.
2225 * - decoding: Set by libavcodec.
2227 uint16_t *inter_matrix;
2229 #if FF_API_PRIVATE_OPT
2230 /** @deprecated use encoder private options instead */
2231 attribute_deprecated
2232 int scenechange_threshold;
2234 /** @deprecated use encoder private options instead */
2235 attribute_deprecated
2236 int noise_reduction;
2241 * @deprecated this field is unused
2243 attribute_deprecated
2247 * @deprecated this field is unused
2249 attribute_deprecated
2254 * precision of the intra DC coefficient - 8
2255 * - encoding: Set by user.
2256 * - decoding: Set by libavcodec
2258 int intra_dc_precision;
2261 * Number of macroblock rows at the top which are skipped.
2262 * - encoding: unused
2263 * - decoding: Set by user.
2268 * Number of macroblock rows at the bottom which are skipped.
2269 * - encoding: unused
2270 * - decoding: Set by user.
2276 * @deprecated use encoder private options instead
2278 attribute_deprecated
2279 float border_masking;
2283 * minimum MB Lagrange multiplier
2284 * - encoding: Set by user.
2285 * - decoding: unused
2290 * maximum MB Lagrange multiplier
2291 * - encoding: Set by user.
2292 * - decoding: unused
2296 #if FF_API_PRIVATE_OPT
2298 * @deprecated use encoder private options instead
2300 attribute_deprecated
2301 int me_penalty_compensation;
2305 * - encoding: Set by user.
2306 * - decoding: unused
2310 #if FF_API_PRIVATE_OPT
2311 /** @deprecated use encoder private options instead */
2312 attribute_deprecated
2318 * - encoding: Set by user.
2319 * - decoding: unused
2324 * number of reference frames
2325 * - encoding: Set by user.
2326 * - decoding: Set by lavc.
2330 #if FF_API_PRIVATE_OPT
2331 /** @deprecated use encoder private options instead */
2332 attribute_deprecated
2336 #if FF_API_UNUSED_MEMBERS
2338 * Multiplied by qscale for each frame and added to scene_change_score.
2339 * - encoding: Set by user.
2340 * - decoding: unused
2342 attribute_deprecated int scenechange_factor;
2346 * Note: Value depends upon the compare function used for fullpel ME.
2347 * - encoding: Set by user.
2348 * - decoding: unused
2352 #if FF_API_PRIVATE_OPT
2353 /** @deprecated use encoder private options instead */
2354 attribute_deprecated
2359 * Chromaticity coordinates of the source primaries.
2360 * - encoding: Set by user
2361 * - decoding: Set by libavcodec
2363 enum AVColorPrimaries color_primaries;
2366 * Color Transfer Characteristic.
2367 * - encoding: Set by user
2368 * - decoding: Set by libavcodec
2370 enum AVColorTransferCharacteristic color_trc;
2373 * YUV colorspace type.
2374 * - encoding: Set by user
2375 * - decoding: Set by libavcodec
2377 enum AVColorSpace colorspace;
2380 * MPEG vs JPEG YUV range.
2381 * - encoding: Set by user
2382 * - decoding: Set by libavcodec
2384 enum AVColorRange color_range;
2387 * This defines the location of chroma samples.
2388 * - encoding: Set by user
2389 * - decoding: Set by libavcodec
2391 enum AVChromaLocation chroma_sample_location;
2395 * Indicates number of picture subdivisions. Used for parallelized
2397 * - encoding: Set by user
2398 * - decoding: unused
2403 * - encoding: set by libavcodec
2404 * - decoding: Set by user.
2406 enum AVFieldOrder field_order;
2409 int sample_rate; ///< samples per second
2410 int channels; ///< number of audio channels
2413 * audio sample format
2414 * - encoding: Set by user.
2415 * - decoding: Set by libavcodec.
2417 enum AVSampleFormat sample_fmt; ///< sample format
2419 /* The following data should not be initialized. */
2421 * Number of samples per channel in an audio frame.
2423 * - encoding: set by libavcodec in avcodec_open2(). Each submitted frame
2424 * except the last must contain exactly frame_size samples per channel.
2425 * May be 0 when the codec has AV_CODEC_CAP_VARIABLE_FRAME_SIZE set, then the
2426 * frame size is not restricted.
2427 * - decoding: may be set by some decoders to indicate constant frame size
2432 * Frame counter, set by libavcodec.
2434 * - decoding: total number of frames returned from the decoder so far.
2435 * - encoding: total number of frames passed to the encoder so far.
2437 * @note the counter is not incremented if encoding/decoding resulted in
2443 * number of bytes per packet if constant and known or 0
2444 * Used by some WAV based audio codecs.
2449 * Audio cutoff bandwidth (0 means "automatic")
2450 * - encoding: Set by user.
2451 * - decoding: unused
2456 * Audio channel layout.
2457 * - encoding: set by user.
2458 * - decoding: set by user, may be overwritten by libavcodec.
2460 uint64_t channel_layout;
2463 * Request decoder to use this channel layout if it can (0 for default)
2464 * - encoding: unused
2465 * - decoding: Set by user.
2467 uint64_t request_channel_layout;
2470 * Type of service that the audio stream conveys.
2471 * - encoding: Set by user.
2472 * - decoding: Set by libavcodec.
2474 enum AVAudioServiceType audio_service_type;
2477 * desired sample format
2478 * - encoding: Not used.
2479 * - decoding: Set by user.
2480 * Decoder will decode to this format if it can.
2482 enum AVSampleFormat request_sample_fmt;
2485 * This callback is called at the beginning of each frame to get data
2486 * buffer(s) for it. There may be one contiguous buffer for all the data or
2487 * there may be a buffer per each data plane or anything in between. What
2488 * this means is, you may set however many entries in buf[] you feel necessary.
2489 * Each buffer must be reference-counted using the AVBuffer API (see description
2492 * The following fields will be set in the frame before this callback is
2495 * - width, height (video only)
2496 * - sample_rate, channel_layout, nb_samples (audio only)
2497 * Their values may differ from the corresponding values in
2498 * AVCodecContext. This callback must use the frame values, not the codec
2499 * context values, to calculate the required buffer size.
2501 * This callback must fill the following fields in the frame:
2505 * * if the data is planar audio with more than 8 channels, then this
2506 * callback must allocate and fill extended_data to contain all pointers
2507 * to all data planes. data[] must hold as many pointers as it can.
2508 * extended_data must be allocated with av_malloc() and will be freed in
2510 * * otherwise extended_data must point to data
2511 * - buf[] must contain one or more pointers to AVBufferRef structures. Each of
2512 * the frame's data and extended_data pointers must be contained in these. That
2513 * is, one AVBufferRef for each allocated chunk of memory, not necessarily one
2514 * AVBufferRef per data[] entry. See: av_buffer_create(), av_buffer_alloc(),
2515 * and av_buffer_ref().
2516 * - extended_buf and nb_extended_buf must be allocated with av_malloc() by
2517 * this callback and filled with the extra buffers if there are more
2518 * buffers than buf[] can hold. extended_buf will be freed in
2521 * If AV_CODEC_CAP_DR1 is not set then get_buffer2() must call
2522 * avcodec_default_get_buffer2() instead of providing buffers allocated by
2525 * Each data plane must be aligned to the maximum required by the target
2528 * @see avcodec_default_get_buffer2()
2532 * If AV_GET_BUFFER_FLAG_REF is set in flags then the frame may be reused
2533 * (read and/or written to if it is writable) later by libavcodec.
2535 * avcodec_align_dimensions2() should be used to find the required width and
2536 * height, as they normally need to be rounded up to the next multiple of 16.
2538 * Some decoders do not support linesizes changing between frames.
2540 * If frame multithreading is used and thread_safe_callbacks is set,
2541 * this callback may be called from a different thread, but not from more
2542 * than one at once. Does not need to be reentrant.
2544 * @see avcodec_align_dimensions2()
2548 * Decoders request a buffer of a particular size by setting
2549 * AVFrame.nb_samples prior to calling get_buffer2(). The decoder may,
2550 * however, utilize only part of the buffer by setting AVFrame.nb_samples
2551 * to a smaller value in the output frame.
2553 * As a convenience, av_samples_get_buffer_size() and
2554 * av_samples_fill_arrays() in libavutil may be used by custom get_buffer2()
2555 * functions to find the required data size and to fill data pointers and
2556 * linesize. In AVFrame.linesize, only linesize[0] may be set for audio
2557 * since all planes must be the same size.
2559 * @see av_samples_get_buffer_size(), av_samples_fill_arrays()
2561 * - encoding: unused
2562 * - decoding: Set by libavcodec, user can override.
2564 int (*get_buffer2)(struct AVCodecContext *s, AVFrame *frame, int flags);
2567 * If non-zero, the decoded audio and video frames returned from
2568 * avcodec_decode_video2() and avcodec_decode_audio4() are reference-counted
2569 * and are valid indefinitely. The caller must free them with
2570 * av_frame_unref() when they are not needed anymore.
2571 * Otherwise, the decoded frames must not be freed by the caller and are
2572 * only valid until the next decode call.
2574 * This is always automatically enabled if avcodec_receive_frame() is used.
2576 * - encoding: unused
2577 * - decoding: set by the caller before avcodec_open2().
2579 int refcounted_frames;
2581 /* - encoding parameters */
2582 float qcompress; ///< amount of qscale change between easy & hard scenes (0.0-1.0)
2583 float qblur; ///< amount of qscale smoothing over time (0.0-1.0)
2587 * - encoding: Set by user.
2588 * - decoding: unused
2594 * - encoding: Set by user.
2595 * - decoding: unused
2600 * maximum quantizer difference between frames
2601 * - encoding: Set by user.
2602 * - decoding: unused
2608 * @deprecated use encoder private options instead
2610 attribute_deprecated
2613 attribute_deprecated
2615 attribute_deprecated
2620 * decoder bitstream buffer size
2621 * - encoding: Set by user.
2622 * - decoding: unused
2627 * ratecontrol override, see RcOverride
2628 * - encoding: Allocated/set/freed by user.
2629 * - decoding: unused
2631 int rc_override_count;
2632 RcOverride *rc_override;
2636 * @deprecated use encoder private options instead
2638 attribute_deprecated
2644 * - encoding: Set by user.
2645 * - decoding: Set by user, may be overwritten by libavcodec.
2647 int64_t rc_max_rate;
2651 * - encoding: Set by user.
2652 * - decoding: unused
2654 int64_t rc_min_rate;
2658 * @deprecated use encoder private options instead
2660 attribute_deprecated
2661 float rc_buffer_aggressivity;
2663 attribute_deprecated
2664 float rc_initial_cplx;
2668 * Ratecontrol attempt to use, at maximum, <value> of what can be used without an underflow.
2669 * - encoding: Set by user.
2670 * - decoding: unused.
2672 float rc_max_available_vbv_use;
2675 * Ratecontrol attempt to use, at least, <value> times the amount needed to prevent a vbv overflow.
2676 * - encoding: Set by user.
2677 * - decoding: unused.
2679 float rc_min_vbv_overflow_use;
2682 * Number of bits which should be loaded into the rc buffer before decoding starts.
2683 * - encoding: Set by user.
2684 * - decoding: unused
2686 int rc_initial_buffer_occupancy;
2688 #if FF_API_CODER_TYPE
2689 #define FF_CODER_TYPE_VLC 0
2690 #define FF_CODER_TYPE_AC 1
2691 #define FF_CODER_TYPE_RAW 2
2692 #define FF_CODER_TYPE_RLE 3
2693 #if FF_API_UNUSED_MEMBERS
2694 #define FF_CODER_TYPE_DEFLATE 4
2695 #endif /* FF_API_UNUSED_MEMBERS */
2697 * @deprecated use encoder private options instead
2699 attribute_deprecated
2701 #endif /* FF_API_CODER_TYPE */
2703 #if FF_API_PRIVATE_OPT
2704 /** @deprecated use encoder private options instead */
2705 attribute_deprecated
2711 * @deprecated use encoder private options instead
2713 attribute_deprecated
2717 * @deprecated use encoder private options instead
2719 attribute_deprecated
2723 #if FF_API_PRIVATE_OPT
2724 /** @deprecated use encoder private options instead */
2725 attribute_deprecated
2726 int frame_skip_threshold;
2728 /** @deprecated use encoder private options instead */
2729 attribute_deprecated
2730 int frame_skip_factor;
2732 /** @deprecated use encoder private options instead */
2733 attribute_deprecated
2736 /** @deprecated use encoder private options instead */
2737 attribute_deprecated
2739 #endif /* FF_API_PRIVATE_OPT */
2742 * trellis RD quantization
2743 * - encoding: Set by user.
2744 * - decoding: unused
2748 #if FF_API_PRIVATE_OPT
2749 /** @deprecated use encoder private options instead */
2750 attribute_deprecated
2751 int min_prediction_order;
2753 /** @deprecated use encoder private options instead */
2754 attribute_deprecated
2755 int max_prediction_order;
2757 /** @deprecated use encoder private options instead */
2758 attribute_deprecated
2759 int64_t timecode_frame_start;
2762 #if FF_API_RTP_CALLBACK
2764 * @deprecated unused
2766 /* The RTP callback: This function is called */
2767 /* every time the encoder has a packet to send. */
2768 /* It depends on the encoder if the data starts */
2769 /* with a Start Code (it should). H.263 does. */
2770 /* mb_nb contains the number of macroblocks */
2771 /* encoded in the RTP payload. */
2772 attribute_deprecated
2773 void (*rtp_callback)(struct AVCodecContext *avctx, void *data, int size, int mb_nb);
2776 #if FF_API_PRIVATE_OPT
2777 /** @deprecated use encoder private options instead */
2778 attribute_deprecated
2779 int rtp_payload_size; /* The size of the RTP payload: the coder will */
2780 /* do its best to deliver a chunk with size */
2781 /* below rtp_payload_size, the chunk will start */
2782 /* with a start code on some codecs like H.263. */
2783 /* This doesn't take account of any particular */
2784 /* headers inside the transmitted RTP payload. */
2787 #if FF_API_STAT_BITS
2788 /* statistics, used for 2-pass encoding */
2789 attribute_deprecated
2791 attribute_deprecated
2793 attribute_deprecated
2795 attribute_deprecated
2797 attribute_deprecated
2799 attribute_deprecated
2801 attribute_deprecated
2803 attribute_deprecated
2806 /** @deprecated this field is unused */
2807 attribute_deprecated
2812 * pass1 encoding statistics output buffer
2813 * - encoding: Set by libavcodec.
2814 * - decoding: unused
2819 * pass2 encoding statistics input buffer
2820 * Concatenated stuff from stats_out of pass1 should be placed here.
2821 * - encoding: Allocated/set/freed by user.
2822 * - decoding: unused
2827 * Work around bugs in encoders which sometimes cannot be detected automatically.
2828 * - encoding: Set by user
2829 * - decoding: Set by user
2831 int workaround_bugs;
2832 #define FF_BUG_AUTODETECT 1 ///< autodetection
2833 #if FF_API_OLD_MSMPEG4
2834 #define FF_BUG_OLD_MSMPEG4 2
2836 #define FF_BUG_XVID_ILACE 4
2837 #define FF_BUG_UMP4 8
2838 #define FF_BUG_NO_PADDING 16
2839 #define FF_BUG_AMV 32
2841 #define FF_BUG_AC_VLC 0 ///< Will be removed, libavcodec can now handle these non-compliant files by default.
2843 #define FF_BUG_QPEL_CHROMA 64
2844 #define FF_BUG_STD_QPEL 128
2845 #define FF_BUG_QPEL_CHROMA2 256
2846 #define FF_BUG_DIRECT_BLOCKSIZE 512
2847 #define FF_BUG_EDGE 1024
2848 #define FF_BUG_HPEL_CHROMA 2048
2849 #define FF_BUG_DC_CLIP 4096
2850 #define FF_BUG_MS 8192 ///< Work around various bugs in Microsoft's broken decoders.
2851 #define FF_BUG_TRUNCATED 16384
2854 * strictly follow the standard (MPEG-4, ...).
2855 * - encoding: Set by user.
2856 * - decoding: Set by user.
2857 * Setting this to STRICT or higher means the encoder and decoder will
2858 * generally do stupid things, whereas setting it to unofficial or lower
2859 * will mean the encoder might produce output that is not supported by all
2860 * spec-compliant decoders. Decoders don't differentiate between normal,
2861 * unofficial and experimental (that is, they always try to decode things
2862 * when they can) unless they are explicitly asked to behave stupidly
2863 * (=strictly conform to the specs)
2865 int strict_std_compliance;
2866 #define FF_COMPLIANCE_VERY_STRICT 2 ///< Strictly conform to an older more strict version of the spec or reference software.
2867 #define FF_COMPLIANCE_STRICT 1 ///< Strictly conform to all the things in the spec no matter what consequences.
2868 #define FF_COMPLIANCE_NORMAL 0
2869 #define FF_COMPLIANCE_UNOFFICIAL -1 ///< Allow unofficial extensions
2870 #define FF_COMPLIANCE_EXPERIMENTAL -2 ///< Allow nonstandardized experimental things.
2873 * error concealment flags
2874 * - encoding: unused
2875 * - decoding: Set by user.
2877 int error_concealment;
2878 #define FF_EC_GUESS_MVS 1
2879 #define FF_EC_DEBLOCK 2
2880 #define FF_EC_FAVOR_INTER 256
2884 * - encoding: Set by user.
2885 * - decoding: Set by user.
2888 #define FF_DEBUG_PICT_INFO 1
2889 #define FF_DEBUG_RC 2
2890 #define FF_DEBUG_BITSTREAM 4
2891 #define FF_DEBUG_MB_TYPE 8
2892 #define FF_DEBUG_QP 16
2895 * @deprecated this option does nothing
2897 #define FF_DEBUG_MV 32
2899 #define FF_DEBUG_DCT_COEFF 0x00000040
2900 #define FF_DEBUG_SKIP 0x00000080
2901 #define FF_DEBUG_STARTCODE 0x00000100
2902 #if FF_API_UNUSED_MEMBERS
2903 #define FF_DEBUG_PTS 0x00000200
2904 #endif /* FF_API_UNUSED_MEMBERS */
2905 #define FF_DEBUG_ER 0x00000400
2906 #define FF_DEBUG_MMCO 0x00000800
2907 #define FF_DEBUG_BUGS 0x00001000
2909 #define FF_DEBUG_VIS_QP 0x00002000 ///< only access through AVOptions from outside libavcodec
2910 #define FF_DEBUG_VIS_MB_TYPE 0x00004000 ///< only access through AVOptions from outside libavcodec
2912 #define FF_DEBUG_BUFFERS 0x00008000
2913 #define FF_DEBUG_THREADS 0x00010000
2914 #define FF_DEBUG_GREEN_MD 0x00800000
2915 #define FF_DEBUG_NOMC 0x01000000
2920 * Code outside libavcodec should access this field using AVOptions
2921 * - encoding: Set by user.
2922 * - decoding: Set by user.
2925 #define FF_DEBUG_VIS_MV_P_FOR 0x00000001 // visualize forward predicted MVs of P-frames
2926 #define FF_DEBUG_VIS_MV_B_FOR 0x00000002 // visualize forward predicted MVs of B-frames
2927 #define FF_DEBUG_VIS_MV_B_BACK 0x00000004 // visualize backward predicted MVs of B-frames
2931 * Error recognition; may misdetect some more or less valid parts as errors.
2932 * - encoding: unused
2933 * - decoding: Set by user.
2935 int err_recognition;
2938 * Verify checksums embedded in the bitstream (could be of either encoded or
2939 * decoded data, depending on the codec) and print an error message on mismatch.
2940 * If AV_EF_EXPLODE is also set, a mismatching checksum will result in the
2941 * decoder returning an error.
2943 #define AV_EF_CRCCHECK (1<<0)
2944 #define AV_EF_BITSTREAM (1<<1) ///< detect bitstream specification deviations
2945 #define AV_EF_BUFFER (1<<2) ///< detect improper bitstream length
2946 #define AV_EF_EXPLODE (1<<3) ///< abort decoding on minor error detection
2948 #define AV_EF_IGNORE_ERR (1<<15) ///< ignore errors and continue
2949 #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
2950 #define AV_EF_COMPLIANT (1<<17) ///< consider all spec non compliances as errors
2951 #define AV_EF_AGGRESSIVE (1<<18) ///< consider things that a sane encoder should not do as an error
2955 * opaque 64-bit number (generally a PTS) that will be reordered and
2956 * output in AVFrame.reordered_opaque
2957 * - encoding: unused
2958 * - decoding: Set by user.
2960 int64_t reordered_opaque;
2963 * Hardware accelerator in use
2964 * - encoding: unused.
2965 * - decoding: Set by libavcodec
2967 struct AVHWAccel *hwaccel;
2970 * Hardware accelerator context.
2971 * For some hardware accelerators, a global context needs to be
2972 * provided by the user. In that case, this holds display-dependent
2973 * data FFmpeg cannot instantiate itself. Please refer to the
2974 * FFmpeg HW accelerator documentation to know how to fill this
2975 * is. e.g. for VA API, this is a struct vaapi_context.
2976 * - encoding: unused
2977 * - decoding: Set by user
2979 void *hwaccel_context;
2983 * - encoding: Set by libavcodec if flags & AV_CODEC_FLAG_PSNR.
2984 * - decoding: unused
2986 uint64_t error[AV_NUM_DATA_POINTERS];
2989 * DCT algorithm, see FF_DCT_* below
2990 * - encoding: Set by user.
2991 * - decoding: unused
2994 #define FF_DCT_AUTO 0
2995 #define FF_DCT_FASTINT 1
2996 #define FF_DCT_INT 2
2997 #define FF_DCT_MMX 3
2998 #define FF_DCT_ALTIVEC 5
2999 #define FF_DCT_FAAN 6
3002 * IDCT algorithm, see FF_IDCT_* below.
3003 * - encoding: Set by user.
3004 * - decoding: Set by user.
3007 #define FF_IDCT_AUTO 0
3008 #define FF_IDCT_INT 1
3009 #define FF_IDCT_SIMPLE 2
3010 #define FF_IDCT_SIMPLEMMX 3
3011 #define FF_IDCT_ARM 7
3012 #define FF_IDCT_ALTIVEC 8
3014 #define FF_IDCT_SH4 9
3016 #define FF_IDCT_SIMPLEARM 10
3017 #if FF_API_UNUSED_MEMBERS
3018 #define FF_IDCT_IPP 13
3019 #endif /* FF_API_UNUSED_MEMBERS */
3020 #define FF_IDCT_XVID 14
3021 #if FF_API_IDCT_XVIDMMX
3022 #define FF_IDCT_XVIDMMX 14
3023 #endif /* FF_API_IDCT_XVIDMMX */
3024 #define FF_IDCT_SIMPLEARMV5TE 16
3025 #define FF_IDCT_SIMPLEARMV6 17
3026 #if FF_API_ARCH_SPARC
3027 #define FF_IDCT_SIMPLEVIS 18
3029 #define FF_IDCT_FAAN 20
3030 #define FF_IDCT_SIMPLENEON 22
3031 #if FF_API_ARCH_ALPHA
3032 #define FF_IDCT_SIMPLEALPHA 23
3034 #define FF_IDCT_SIMPLEAUTO 128
3037 * bits per sample/pixel from the demuxer (needed for huffyuv).
3038 * - encoding: Set by libavcodec.
3039 * - decoding: Set by user.
3041 int bits_per_coded_sample;
3044 * Bits per sample/pixel of internal libavcodec pixel/sample format.
3045 * - encoding: set by user.
3046 * - decoding: set by libavcodec.
3048 int bits_per_raw_sample;
3052 * low resolution decoding, 1-> 1/2 size, 2->1/4 size
3053 * - encoding: unused
3054 * - decoding: Set by user.
3055 * Code outside libavcodec should access this field using:
3056 * av_codec_{get,set}_lowres(avctx)
3061 #if FF_API_CODED_FRAME
3063 * the picture in the bitstream
3064 * - encoding: Set by libavcodec.
3065 * - decoding: unused
3067 * @deprecated use the quality factor packet side data instead
3069 attribute_deprecated AVFrame *coded_frame;
3074 * is used to decide how many independent tasks should be passed to execute()
3075 * - encoding: Set by user.
3076 * - decoding: Set by user.
3081 * Which multithreading methods to use.
3082 * Use of FF_THREAD_FRAME will increase decoding delay by one frame per thread,
3083 * so clients which cannot provide future frames should not use it.
3085 * - encoding: Set by user, otherwise the default is used.
3086 * - decoding: Set by user, otherwise the default is used.
3089 #define FF_THREAD_FRAME 1 ///< Decode more than one frame at once
3090 #define FF_THREAD_SLICE 2 ///< Decode more than one part of a single frame at once
3093 * Which multithreading methods are in use by the codec.
3094 * - encoding: Set by libavcodec.
3095 * - decoding: Set by libavcodec.
3097 int active_thread_type;
3100 * Set by the client if its custom get_buffer() callback can be called
3101 * synchronously from another thread, which allows faster multithreaded decoding.
3102 * draw_horiz_band() will be called from other threads regardless of this setting.
3103 * Ignored if the default get_buffer() is used.
3104 * - encoding: Set by user.
3105 * - decoding: Set by user.
3107 int thread_safe_callbacks;
3110 * The codec may call this to execute several independent things.
3111 * It will return only after finishing all tasks.
3112 * The user may replace this with some multithreaded implementation,
3113 * the default implementation will execute the parts serially.
3114 * @param count the number of things to execute
3115 * - encoding: Set by libavcodec, user can override.
3116 * - decoding: Set by libavcodec, user can override.
3118 int (*execute)(struct AVCodecContext *c, int (*func)(struct AVCodecContext *c2, void *arg), void *arg2, int *ret, int count, int size);
3121 * The codec may call this to execute several independent things.
3122 * It will return only after finishing all tasks.
3123 * The user may replace this with some multithreaded implementation,
3124 * the default implementation will execute the parts serially.
3125 * Also see avcodec_thread_init and e.g. the --enable-pthread configure option.
3126 * @param c context passed also to func
3127 * @param count the number of things to execute
3128 * @param arg2 argument passed unchanged to func
3129 * @param ret return values of executed functions, must have space for "count" values. May be NULL.
3130 * @param func function that will be called count times, with jobnr from 0 to count-1.
3131 * threadnr will be in the range 0 to c->thread_count-1 < MAX_THREADS and so that no
3132 * two instances of func executing at the same time will have the same threadnr.
3133 * @return always 0 currently, but code should handle a future improvement where when any call to func
3134 * returns < 0 no further calls to func may be done and < 0 is returned.
3135 * - encoding: Set by libavcodec, user can override.
3136 * - decoding: Set by libavcodec, user can override.
3138 int (*execute2)(struct AVCodecContext *c, int (*func)(struct AVCodecContext *c2, void *arg, int jobnr, int threadnr), void *arg2, int *ret, int count);
3141 * noise vs. sse weight for the nsse comparison function
3142 * - encoding: Set by user.
3143 * - decoding: unused
3149 * - encoding: Set by user.
3150 * - decoding: Set by libavcodec.
3153 #define FF_PROFILE_UNKNOWN -99
3154 #define FF_PROFILE_RESERVED -100
3156 #define FF_PROFILE_AAC_MAIN 0
3157 #define FF_PROFILE_AAC_LOW 1
3158 #define FF_PROFILE_AAC_SSR 2
3159 #define FF_PROFILE_AAC_LTP 3
3160 #define FF_PROFILE_AAC_HE 4
3161 #define FF_PROFILE_AAC_HE_V2 28
3162 #define FF_PROFILE_AAC_LD 22
3163 #define FF_PROFILE_AAC_ELD 38
3164 #define FF_PROFILE_MPEG2_AAC_LOW 128
3165 #define FF_PROFILE_MPEG2_AAC_HE 131
3167 #define FF_PROFILE_DTS 20
3168 #define FF_PROFILE_DTS_ES 30
3169 #define FF_PROFILE_DTS_96_24 40
3170 #define FF_PROFILE_DTS_HD_HRA 50
3171 #define FF_PROFILE_DTS_HD_MA 60
3172 #define FF_PROFILE_DTS_EXPRESS 70
3174 #define FF_PROFILE_MPEG2_422 0
3175 #define FF_PROFILE_MPEG2_HIGH 1
3176 #define FF_PROFILE_MPEG2_SS 2
3177 #define FF_PROFILE_MPEG2_SNR_SCALABLE 3
3178 #define FF_PROFILE_MPEG2_MAIN 4
3179 #define FF_PROFILE_MPEG2_SIMPLE 5
3181 #define FF_PROFILE_H264_CONSTRAINED (1<<9) // 8+1; constraint_set1_flag
3182 #define FF_PROFILE_H264_INTRA (1<<11) // 8+3; constraint_set3_flag
3184 #define FF_PROFILE_H264_BASELINE 66
3185 #define FF_PROFILE_H264_CONSTRAINED_BASELINE (66|FF_PROFILE_H264_CONSTRAINED)
3186 #define FF_PROFILE_H264_MAIN 77
3187 #define FF_PROFILE_H264_EXTENDED 88
3188 #define FF_PROFILE_H264_HIGH 100
3189 #define FF_PROFILE_H264_HIGH_10 110
3190 #define FF_PROFILE_H264_HIGH_10_INTRA (110|FF_PROFILE_H264_INTRA)
3191 #define FF_PROFILE_H264_HIGH_422 122
3192 #define FF_PROFILE_H264_HIGH_422_INTRA (122|FF_PROFILE_H264_INTRA)
3193 #define FF_PROFILE_H264_HIGH_444 144
3194 #define FF_PROFILE_H264_HIGH_444_PREDICTIVE 244
3195 #define FF_PROFILE_H264_HIGH_444_INTRA (244|FF_PROFILE_H264_INTRA)
3196 #define FF_PROFILE_H264_CAVLC_444 44
3198 #define FF_PROFILE_VC1_SIMPLE 0
3199 #define FF_PROFILE_VC1_MAIN 1
3200 #define FF_PROFILE_VC1_COMPLEX 2
3201 #define FF_PROFILE_VC1_ADVANCED 3
3203 #define FF_PROFILE_MPEG4_SIMPLE 0
3204 #define FF_PROFILE_MPEG4_SIMPLE_SCALABLE 1
3205 #define FF_PROFILE_MPEG4_CORE 2
3206 #define FF_PROFILE_MPEG4_MAIN 3
3207 #define FF_PROFILE_MPEG4_N_BIT 4
3208 #define FF_PROFILE_MPEG4_SCALABLE_TEXTURE 5
3209 #define FF_PROFILE_MPEG4_SIMPLE_FACE_ANIMATION 6
3210 #define FF_PROFILE_MPEG4_BASIC_ANIMATED_TEXTURE 7
3211 #define FF_PROFILE_MPEG4_HYBRID 8
3212 #define FF_PROFILE_MPEG4_ADVANCED_REAL_TIME 9
3213 #define FF_PROFILE_MPEG4_CORE_SCALABLE 10
3214 #define FF_PROFILE_MPEG4_ADVANCED_CODING 11
3215 #define FF_PROFILE_MPEG4_ADVANCED_CORE 12
3216 #define FF_PROFILE_MPEG4_ADVANCED_SCALABLE_TEXTURE 13
3217 #define FF_PROFILE_MPEG4_SIMPLE_STUDIO 14
3218 #define FF_PROFILE_MPEG4_ADVANCED_SIMPLE 15
3220 #define FF_PROFILE_JPEG2000_CSTREAM_RESTRICTION_0 0
3221 #define FF_PROFILE_JPEG2000_CSTREAM_RESTRICTION_1 1
3222 #define FF_PROFILE_JPEG2000_CSTREAM_NO_RESTRICTION 2
3223 #define FF_PROFILE_JPEG2000_DCINEMA_2K 3
3224 #define FF_PROFILE_JPEG2000_DCINEMA_4K 4
3226 #define FF_PROFILE_VP9_0 0
3227 #define FF_PROFILE_VP9_1 1
3228 #define FF_PROFILE_VP9_2 2
3229 #define FF_PROFILE_VP9_3 3
3231 #define FF_PROFILE_HEVC_MAIN 1
3232 #define FF_PROFILE_HEVC_MAIN_10 2
3233 #define FF_PROFILE_HEVC_MAIN_STILL_PICTURE 3
3234 #define FF_PROFILE_HEVC_REXT 4
3238 * - encoding: Set by user.
3239 * - decoding: Set by libavcodec.
3242 #define FF_LEVEL_UNKNOWN -99
3245 * Skip loop filtering for selected frames.
3246 * - encoding: unused
3247 * - decoding: Set by user.
3249 enum AVDiscard skip_loop_filter;
3252 * Skip IDCT/dequantization for selected frames.
3253 * - encoding: unused
3254 * - decoding: Set by user.
3256 enum AVDiscard skip_idct;
3259 * Skip decoding for selected frames.
3260 * - encoding: unused
3261 * - decoding: Set by user.
3263 enum AVDiscard skip_frame;
3266 * Header containing style information for text subtitles.
3267 * For SUBTITLE_ASS subtitle type, it should contain the whole ASS
3268 * [Script Info] and [V4+ Styles] section, plus the [Events] line and
3269 * the Format line following. It shouldn't include any Dialogue line.
3270 * - encoding: Set/allocated/freed by user (before avcodec_open2())
3271 * - decoding: Set/allocated/freed by libavcodec (by avcodec_open2())
3273 uint8_t *subtitle_header;
3274 int subtitle_header_size;
3276 #if FF_API_ERROR_RATE
3278 * @deprecated use the 'error_rate' private AVOption of the mpegvideo
3281 attribute_deprecated
3285 #if FF_API_VBV_DELAY
3287 * VBV delay coded in the last frame (in periods of a 27 MHz clock).
3288 * Used for compliant TS muxing.
3289 * - encoding: Set by libavcodec.
3290 * - decoding: unused.
3291 * @deprecated this value is now exported as a part of
3292 * AV_PKT_DATA_CPB_PROPERTIES packet side data
3294 attribute_deprecated
3298 #if FF_API_SIDEDATA_ONLY_PKT
3300 * Encoding only and set by default. Allow encoders to output packets
3301 * that do not contain any encoded data, only side data.
3303 * Some encoders need to output such packets, e.g. to update some stream
3304 * parameters at the end of encoding.
3306 * @deprecated this field disables the default behaviour and
3307 * it is kept only for compatibility.
3309 attribute_deprecated
3310 int side_data_only_packets;
3314 * Audio only. The number of "priming" samples (padding) inserted by the
3315 * encoder at the beginning of the audio. I.e. this number of leading
3316 * decoded samples must be discarded by the caller to get the original audio
3317 * without leading padding.
3319 * - decoding: unused
3320 * - encoding: Set by libavcodec. The timestamps on the output packets are
3321 * adjusted by the encoder so that they always refer to the
3322 * first sample of the data actually contained in the packet,
3323 * including any added padding. E.g. if the timebase is
3324 * 1/samplerate and the timestamp of the first input sample is
3325 * 0, the timestamp of the first output packet will be
3328 int initial_padding;
3331 * - decoding: For codecs that store a framerate value in the compressed
3332 * bitstream, the decoder may export it here. { 0, 1} when
3334 * - encoding: May be used to signal the framerate of CFR content to an
3337 AVRational framerate;
3340 * Nominal unaccelerated pixel format, see AV_PIX_FMT_xxx.
3341 * - encoding: unused.
3342 * - decoding: Set by libavcodec before calling get_format()
3344 enum AVPixelFormat sw_pix_fmt;
3347 * Timebase in which pkt_dts/pts and AVPacket.dts/pts are.
3348 * Code outside libavcodec should access this field using:
3349 * av_codec_{get,set}_pkt_timebase(avctx)
3350 * - encoding unused.
3351 * - decoding set by user.
3353 AVRational pkt_timebase;
3357 * Code outside libavcodec should access this field using:
3358 * av_codec_{get,set}_codec_descriptor(avctx)
3359 * - encoding: unused.
3360 * - decoding: set by libavcodec.
3362 const AVCodecDescriptor *codec_descriptor;
3366 * low resolution decoding, 1-> 1/2 size, 2->1/4 size
3367 * - encoding: unused
3368 * - decoding: Set by user.
3369 * Code outside libavcodec should access this field using:
3370 * av_codec_{get,set}_lowres(avctx)
3376 * Current statistics for PTS correction.
3377 * - decoding: maintained and used by libavcodec, not intended to be used by user apps
3378 * - encoding: unused
3380 int64_t pts_correction_num_faulty_pts; /// Number of incorrect PTS values so far
3381 int64_t pts_correction_num_faulty_dts; /// Number of incorrect DTS values so far
3382 int64_t pts_correction_last_pts; /// PTS of the last frame
3383 int64_t pts_correction_last_dts; /// DTS of the last frame
3386 * Character encoding of the input subtitles file.
3387 * - decoding: set by user
3388 * - encoding: unused
3393 * Subtitles character encoding mode. Formats or codecs might be adjusting
3394 * this setting (if they are doing the conversion themselves for instance).
3395 * - decoding: set by libavcodec
3396 * - encoding: unused
3398 int sub_charenc_mode;
3399 #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)
3400 #define FF_SUB_CHARENC_MODE_AUTOMATIC 0 ///< libavcodec will select the mode itself
3401 #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
3404 * Skip processing alpha if supported by codec.
3405 * Note that if the format uses pre-multiplied alpha (common with VP6,
3406 * and recommended due to better video quality/compression)
3407 * the image will look as if alpha-blended onto a black background.
3408 * However for formats that do not use pre-multiplied alpha
3409 * there might be serious artefacts (though e.g. libswscale currently
3410 * assumes pre-multiplied alpha anyway).
3411 * Code outside libavcodec should access this field using AVOptions
3413 * - decoding: set by user
3414 * - encoding: unused
3419 * Number of samples to skip after a discontinuity
3420 * - decoding: unused
3421 * - encoding: set by libavcodec
3425 #if !FF_API_DEBUG_MV
3427 * debug motion vectors
3428 * Code outside libavcodec should access this field using AVOptions
3429 * - encoding: Set by user.
3430 * - decoding: Set by user.
3433 #define FF_DEBUG_VIS_MV_P_FOR 0x00000001 //visualize forward predicted MVs of P frames
3434 #define FF_DEBUG_VIS_MV_B_FOR 0x00000002 //visualize forward predicted MVs of B frames
3435 #define FF_DEBUG_VIS_MV_B_BACK 0x00000004 //visualize backward predicted MVs of B frames
3439 * custom intra quantization matrix
3440 * Code outside libavcodec should access this field using av_codec_g/set_chroma_intra_matrix()
3441 * - encoding: Set by user, can be NULL.
3442 * - decoding: unused.
3444 uint16_t *chroma_intra_matrix;
3447 * dump format separator.
3448 * can be ", " or "\n " or anything else
3449 * Code outside libavcodec should access this field using AVOptions
3450 * (NO direct access).
3451 * - encoding: Set by user.
3452 * - decoding: Set by user.
3454 uint8_t *dump_separator;
3457 * ',' separated list of allowed decoders.
3458 * If NULL then all are allowed
3459 * - encoding: unused
3460 * - decoding: set by user through AVOPtions (NO direct access)
3462 char *codec_whitelist;
3465 * Properties of the stream that gets decoded
3466 * To be accessed through av_codec_get_properties() (NO direct access)
3467 * - encoding: unused
3468 * - decoding: set by libavcodec
3470 unsigned properties;
3471 #define FF_CODEC_PROPERTY_LOSSLESS 0x00000001
3472 #define FF_CODEC_PROPERTY_CLOSED_CAPTIONS 0x00000002
3475 * Additional data associated with the entire coded stream.
3477 * - decoding: unused
3478 * - encoding: may be set by libavcodec after avcodec_open2().
3480 AVPacketSideData *coded_side_data;
3481 int nb_coded_side_data;
3486 * For hardware encoders configured to use a hwaccel pixel format, this
3487 * field should be set by the caller to a reference to the AVHWFramesContext
3488 * describing input frames. AVHWFramesContext.format must be equal to
3489 * AVCodecContext.pix_fmt.
3491 * This field should be set before avcodec_open2() is called and is
3492 * afterwards owned and managed by libavcodec.
3494 AVBufferRef *hw_frames_ctx;
3497 * Control the form of AVSubtitle.rects[N]->ass
3498 * - decoding: set by user
3499 * - encoding: unused
3501 int sub_text_format;
3502 #define FF_SUB_TEXT_FMT_ASS 0
3503 #if FF_API_ASS_TIMING
3504 #define FF_SUB_TEXT_FMT_ASS_WITH_TIMINGS 1
3509 AVRational av_codec_get_pkt_timebase (const AVCodecContext *avctx);
3510 void av_codec_set_pkt_timebase (AVCodecContext *avctx, AVRational val);
3512 const AVCodecDescriptor *av_codec_get_codec_descriptor(const AVCodecContext *avctx);
3513 void av_codec_set_codec_descriptor(AVCodecContext *avctx, const AVCodecDescriptor *desc);
3515 unsigned av_codec_get_codec_properties(const AVCodecContext *avctx);
3517 int av_codec_get_lowres(const AVCodecContext *avctx);
3518 void av_codec_set_lowres(AVCodecContext *avctx, int val);
3520 int av_codec_get_seek_preroll(const AVCodecContext *avctx);
3521 void av_codec_set_seek_preroll(AVCodecContext *avctx, int val);
3523 uint16_t *av_codec_get_chroma_intra_matrix(const AVCodecContext *avctx);
3524 void av_codec_set_chroma_intra_matrix(AVCodecContext *avctx, uint16_t *val);
3529 typedef struct AVProfile {
3531 const char *name; ///< short name for the profile
3534 typedef struct AVCodecDefault AVCodecDefault;
3541 typedef struct AVCodec {
3543 * Name of the codec implementation.
3544 * The name is globally unique among encoders and among decoders (but an
3545 * encoder and a decoder can share the same name).
3546 * This is the primary way to find a codec from the user perspective.
3550 * Descriptive name for the codec, meant to be more human readable than name.
3551 * You should use the NULL_IF_CONFIG_SMALL() macro to define it.
3553 const char *long_name;
3554 enum AVMediaType type;
3557 * Codec capabilities.
3558 * see AV_CODEC_CAP_*
3561 const AVRational *supported_framerates; ///< array of supported framerates, or NULL if any, array is terminated by {0,0}
3562 const enum AVPixelFormat *pix_fmts; ///< array of supported pixel formats, or NULL if unknown, array is terminated by -1
3563 const int *supported_samplerates; ///< array of supported audio samplerates, or NULL if unknown, array is terminated by 0
3564 const enum AVSampleFormat *sample_fmts; ///< array of supported sample formats, or NULL if unknown, array is terminated by -1
3565 const uint64_t *channel_layouts; ///< array of support channel layouts, or NULL if unknown. array is terminated by 0
3566 uint8_t max_lowres; ///< maximum value for lowres supported by the decoder, no direct access, use av_codec_get_max_lowres()
3567 const AVClass *priv_class; ///< AVClass for the private context
3568 const AVProfile *profiles; ///< array of recognized profiles, or NULL if unknown, array is terminated by {FF_PROFILE_UNKNOWN}
3570 /*****************************************************************
3571 * No fields below this line are part of the public API. They
3572 * may not be used outside of libavcodec and can be changed and
3574 * New public fields should be added right above.
3575 *****************************************************************
3578 struct AVCodec *next;
3580 * @name Frame-level threading support functions
3584 * If defined, called on thread contexts when they are created.
3585 * If the codec allocates writable tables in init(), re-allocate them here.
3586 * priv_data will be set to a copy of the original.
3588 int (*init_thread_copy)(AVCodecContext *);
3590 * Copy necessary context variables from a previous thread context to the current one.
3591 * If not defined, the next thread will start automatically; otherwise, the codec
3592 * must call ff_thread_finish_setup().
3594 * dst and src will (rarely) point to the same context, in which case memcpy should be skipped.
3596 int (*update_thread_context)(AVCodecContext *dst, const AVCodecContext *src);
3600 * Private codec-specific defaults.
3602 const AVCodecDefault *defaults;
3605 * Initialize codec static data, called from avcodec_register().
3607 void (*init_static_data)(struct AVCodec *codec);
3609 int (*init)(AVCodecContext *);
3610 int (*encode_sub)(AVCodecContext *, uint8_t *buf, int buf_size,
3611 const struct AVSubtitle *sub);
3613 * Encode data to an AVPacket.
3615 * @param avctx codec context
3616 * @param avpkt output AVPacket (may contain a user-provided buffer)
3617 * @param[in] frame AVFrame containing the raw data to be encoded
3618 * @param[out] got_packet_ptr encoder sets to 0 or 1 to indicate that a
3619 * non-empty packet was returned in avpkt.
3620 * @return 0 on success, negative error code on failure
3622 int (*encode2)(AVCodecContext *avctx, AVPacket *avpkt, const AVFrame *frame,
3623 int *got_packet_ptr);
3624 int (*decode)(AVCodecContext *, void *outdata, int *outdata_size, AVPacket *avpkt);
3625 int (*close)(AVCodecContext *);
3627 * Decode/encode API with decoupled packet/frame dataflow. The API is the
3628 * same as the avcodec_ prefixed APIs (avcodec_send_frame() etc.), except
3630 * - never called if the codec is closed or the wrong type,
3631 * - AVPacket parameter change side data is applied right before calling
3632 * AVCodec->send_packet,
3633 * - if AV_CODEC_CAP_DELAY is not set, drain packets or frames are never sent,
3634 * - only one drain packet is ever passed down (until the next flush()),
3635 * - a drain AVPacket is always NULL (no need to check for avpkt->size).
3637 int (*send_frame)(AVCodecContext *avctx, const AVFrame *frame);
3638 int (*send_packet)(AVCodecContext *avctx, const AVPacket *avpkt);
3639 int (*receive_frame)(AVCodecContext *avctx, AVFrame *frame);
3640 int (*receive_packet)(AVCodecContext *avctx, AVPacket *avpkt);
3643 * Will be called when seeking
3645 void (*flush)(AVCodecContext *);
3647 * Internal codec capabilities.
3648 * See FF_CODEC_CAP_* in internal.h
3653 int av_codec_get_max_lowres(const AVCodec *codec);
3655 struct MpegEncContext;
3658 * @defgroup lavc_hwaccel AVHWAccel
3661 typedef struct AVHWAccel {
3663 * Name of the hardware accelerated codec.
3664 * The name is globally unique among encoders and among decoders (but an
3665 * encoder and a decoder can share the same name).
3670 * Type of codec implemented by the hardware accelerator.
3672 * See AVMEDIA_TYPE_xxx
3674 enum AVMediaType type;
3677 * Codec implemented by the hardware accelerator.
3679 * See AV_CODEC_ID_xxx
3684 * Supported pixel format.
3686 * Only hardware accelerated formats are supported here.
3688 enum AVPixelFormat pix_fmt;
3691 * Hardware accelerated codec capabilities.
3692 * see HWACCEL_CODEC_CAP_*
3696 /*****************************************************************
3697 * No fields below this line are part of the public API. They
3698 * may not be used outside of libavcodec and can be changed and
3700 * New public fields should be added right above.
3701 *****************************************************************
3703 struct AVHWAccel *next;
3706 * Allocate a custom buffer
3708 int (*alloc_frame)(AVCodecContext *avctx, AVFrame *frame);
3711 * Called at the beginning of each frame or field picture.
3713 * Meaningful frame information (codec specific) is guaranteed to
3714 * be parsed at this point. This function is mandatory.
3716 * Note that buf can be NULL along with buf_size set to 0.
3717 * Otherwise, this means the whole frame is available at this point.
3719 * @param avctx the codec context
3720 * @param buf the frame data buffer base
3721 * @param buf_size the size of the frame in bytes
3722 * @return zero if successful, a negative value otherwise
3724 int (*start_frame)(AVCodecContext *avctx, const uint8_t *buf, uint32_t buf_size);
3727 * Callback for each slice.
3729 * Meaningful slice information (codec specific) is guaranteed to
3730 * be parsed at this point. This function is mandatory.
3731 * The only exception is XvMC, that works on MB level.
3733 * @param avctx the codec context
3734 * @param buf the slice data buffer base
3735 * @param buf_size the size of the slice in bytes
3736 * @return zero if successful, a negative value otherwise
3738 int (*decode_slice)(AVCodecContext *avctx, const uint8_t *buf, uint32_t buf_size);
3741 * Called at the end of each frame or field picture.
3743 * The whole picture is parsed at this point and can now be sent
3744 * to the hardware accelerator. This function is mandatory.
3746 * @param avctx the codec context
3747 * @return zero if successful, a negative value otherwise
3749 int (*end_frame)(AVCodecContext *avctx);
3752 * Size of per-frame hardware accelerator private data.
3754 * Private data is allocated with av_mallocz() before
3755 * AVCodecContext.get_buffer() and deallocated after
3756 * AVCodecContext.release_buffer().
3758 int frame_priv_data_size;
3761 * Called for every Macroblock in a slice.
3763 * XvMC uses it to replace the ff_mpv_decode_mb().
3764 * Instead of decoding to raw picture, MB parameters are
3765 * stored in an array provided by the video driver.
3767 * @param s the mpeg context
3769 void (*decode_mb)(struct MpegEncContext *s);
3772 * Initialize the hwaccel private data.
3774 * This will be called from ff_get_format(), after hwaccel and
3775 * hwaccel_context are set and the hwaccel private data in AVCodecInternal
3778 int (*init)(AVCodecContext *avctx);
3781 * Uninitialize the hwaccel private data.
3783 * This will be called from get_format() or avcodec_close(), after hwaccel
3784 * and hwaccel_context are already uninitialized.
3786 int (*uninit)(AVCodecContext *avctx);
3789 * Size of the private data to allocate in
3790 * AVCodecInternal.hwaccel_priv_data.
3796 * Hardware acceleration should be used for decoding even if the codec level
3797 * used is unknown or higher than the maximum supported level reported by the
3800 * It's generally a good idea to pass this flag unless you have a specific
3801 * reason not to, as hardware tends to under-report supported levels.
3803 #define AV_HWACCEL_FLAG_IGNORE_LEVEL (1 << 0)
3806 * Hardware acceleration can output YUV pixel formats with a different chroma
3807 * sampling than 4:2:0 and/or other than 8 bits per component.
3809 #define AV_HWACCEL_FLAG_ALLOW_HIGH_DEPTH (1 << 1)
3815 #if FF_API_AVPICTURE
3817 * @defgroup lavc_picture AVPicture
3819 * Functions for working with AVPicture
3824 * Picture data structure.
3826 * Up to four components can be stored into it, the last component is
3828 * @deprecated use AVFrame or imgutils functions instead
3830 typedef struct AVPicture {
3831 attribute_deprecated
3832 uint8_t *data[AV_NUM_DATA_POINTERS]; ///< pointers to the image data planes
3833 attribute_deprecated
3834 int linesize[AV_NUM_DATA_POINTERS]; ///< number of bytes per line
3842 enum AVSubtitleType {
3845 SUBTITLE_BITMAP, ///< A bitmap, pict will be set
3848 * Plain text, the text field must be set by the decoder and is
3849 * authoritative. ass and pict fields may contain approximations.
3854 * Formatted text, the ass field must be set by the decoder and is
3855 * authoritative. pict and text fields may contain approximations.
3860 #define AV_SUBTITLE_FLAG_FORCED 0x00000001
3862 typedef struct AVSubtitleRect {
3863 int x; ///< top left corner of pict, undefined when pict is not set
3864 int y; ///< top left corner of pict, undefined when pict is not set
3865 int w; ///< width of pict, undefined when pict is not set
3866 int h; ///< height of pict, undefined when pict is not set
3867 int nb_colors; ///< number of colors in pict, undefined when pict is not set
3869 #if FF_API_AVPICTURE
3871 * @deprecated unused
3873 attribute_deprecated
3877 * data+linesize for the bitmap of this subtitle.
3878 * Can be set for text/ass as well once they are rendered.
3883 enum AVSubtitleType type;
3885 char *text; ///< 0 terminated plain UTF-8 text
3888 * 0 terminated ASS/SSA compatible event line.
3889 * The presentation of this is unaffected by the other values in this
3897 typedef struct AVSubtitle {
3898 uint16_t format; /* 0 = graphics */
3899 uint32_t start_display_time; /* relative to packet pts, in ms */
3900 uint32_t end_display_time; /* relative to packet pts, in ms */
3902 AVSubtitleRect **rects;
3903 int64_t pts; ///< Same as packet pts, in AV_TIME_BASE
3907 * This struct describes the properties of an encoded stream.
3909 * sizeof(AVCodecParameters) is not a part of the public ABI, this struct must
3910 * be allocated with avcodec_parameters_alloc() and freed with
3911 * avcodec_parameters_free().
3913 typedef struct AVCodecParameters {
3915 * General type of the encoded data.
3917 enum AVMediaType codec_type;
3919 * Specific type of the encoded data (the codec used).
3921 enum AVCodecID codec_id;
3923 * Additional information about the codec (corresponds to the AVI FOURCC).
3928 * Extra binary data needed for initializing the decoder, codec-dependent.
3930 * Must be allocated with av_malloc() and will be freed by
3931 * avcodec_parameters_free(). The allocated size of extradata must be at
3932 * least extradata_size + AV_INPUT_BUFFER_PADDING_SIZE, with the padding
3937 * Size of the extradata content in bytes.
3942 * - video: the pixel format, the value corresponds to enum AVPixelFormat.
3943 * - audio: the sample format, the value corresponds to enum AVSampleFormat.
3948 * The average bitrate of the encoded data (in bits per second).
3953 * The number of bits per sample in the codedwords.
3955 * This is basically the bitrate per sample. It is mandatory for a bunch of
3956 * formats to actually decode them. It's the number of bits for one sample in
3957 * the actual coded bitstream.
3959 * This could be for example 4 for ADPCM
3960 * For PCM formats this matches bits_per_raw_sample
3963 int bits_per_coded_sample;
3966 * This is the number of valid bits in each output sample. If the
3967 * sample format has more bits, the least significant bits are additional
3968 * padding bits, which are always 0. Use right shifts to reduce the sample
3969 * to its actual size. For example, audio formats with 24 bit samples will
3970 * have bits_per_raw_sample set to 24, and format set to AV_SAMPLE_FMT_S32.
3971 * To get the original sample use "(int32_t)sample >> 8"."
3973 * For ADPCM this might be 12 or 16 or similar
3976 int bits_per_raw_sample;
3979 * Codec-specific bitstream restrictions that the stream conforms to.
3985 * Video only. The dimensions of the video frame in pixels.
3991 * Video only. The aspect ratio (width / height) which a single pixel
3992 * should have when displayed.
3994 * When the aspect ratio is unknown / undefined, the numerator should be
3995 * set to 0 (the denominator may have any value).
3997 AVRational sample_aspect_ratio;
4000 * Video only. The order of the fields in interlaced video.
4002 enum AVFieldOrder field_order;
4005 * Video only. Additional colorspace characteristics.
4007 enum AVColorRange color_range;
4008 enum AVColorPrimaries color_primaries;
4009 enum AVColorTransferCharacteristic color_trc;
4010 enum AVColorSpace color_space;
4011 enum AVChromaLocation chroma_location;
4014 * Video only. Number of delayed frames.
4019 * Audio only. The channel layout bitmask. May be 0 if the channel layout is
4020 * unknown or unspecified, otherwise the number of bits set must be equal to
4021 * the channels field.
4023 uint64_t channel_layout;
4025 * Audio only. The number of audio channels.
4029 * Audio only. The number of audio samples per second.
4033 * Audio only. The number of bytes per coded audio frame, required by some
4036 * Corresponds to nBlockAlign in WAVEFORMATEX.
4040 * Audio only. Audio frame size, if known. Required by some formats to be static.
4045 * Audio only. The amount of padding (in samples) inserted by the encoder at
4046 * the beginning of the audio. I.e. this number of leading decoded samples
4047 * must be discarded by the caller to get the original audio without leading
4050 int initial_padding;
4052 * Audio only. The amount of padding (in samples) appended by the encoder to
4053 * the end of the audio. I.e. this number of decoded samples must be
4054 * discarded by the caller from the end of the stream to get the original
4055 * audio without any trailing padding.
4057 int trailing_padding;
4059 * Audio only. Number of samples to skip after a discontinuity.
4062 } AVCodecParameters;
4065 * If c is NULL, returns the first registered codec,
4066 * if c is non-NULL, returns the next registered codec after c,
4067 * or NULL if c is the last one.
4069 AVCodec *av_codec_next(const AVCodec *c);
4072 * Return the LIBAVCODEC_VERSION_INT constant.
4074 unsigned avcodec_version(void);
4077 * Return the libavcodec build-time configuration.
4079 const char *avcodec_configuration(void);
4082 * Return the libavcodec license.
4084 const char *avcodec_license(void);
4087 * Register the codec codec and initialize libavcodec.
4089 * @warning either this function or avcodec_register_all() must be called
4090 * before any other libavcodec functions.
4092 * @see avcodec_register_all()
4094 void avcodec_register(AVCodec *codec);
4097 * Register all the codecs, parsers and bitstream filters which were enabled at
4098 * configuration time. If you do not call this function you can select exactly
4099 * which formats you want to support, by using the individual registration
4102 * @see avcodec_register
4103 * @see av_register_codec_parser
4104 * @see av_register_bitstream_filter
4106 void avcodec_register_all(void);
4109 * Allocate an AVCodecContext and set its fields to default values. The
4110 * resulting struct should be freed with avcodec_free_context().
4112 * @param codec if non-NULL, allocate private data and initialize defaults
4113 * for the given codec. It is illegal to then call avcodec_open2()
4114 * with a different codec.
4115 * If NULL, then the codec-specific defaults won't be initialized,
4116 * which may result in suboptimal default settings (this is
4117 * important mainly for encoders, e.g. libx264).
4119 * @return An AVCodecContext filled with default values or NULL on failure.
4120 * @see avcodec_get_context_defaults
4122 AVCodecContext *avcodec_alloc_context3(const AVCodec *codec);
4125 * Free the codec context and everything associated with it and write NULL to
4126 * the provided pointer.
4128 void avcodec_free_context(AVCodecContext **avctx);
4131 * Set the fields of the given AVCodecContext to default values corresponding
4132 * to the given codec (defaults may be codec-dependent).
4134 * Do not call this function if a non-NULL codec has been passed
4135 * to avcodec_alloc_context3() that allocated this AVCodecContext.
4136 * If codec is non-NULL, it is illegal to call avcodec_open2() with a
4137 * different codec on this AVCodecContext.
4139 int avcodec_get_context_defaults3(AVCodecContext *s, const AVCodec *codec);
4142 * Get the AVClass for AVCodecContext. It can be used in combination with
4143 * AV_OPT_SEARCH_FAKE_OBJ for examining options.
4145 * @see av_opt_find().
4147 const AVClass *avcodec_get_class(void);
4150 * Get the AVClass for AVFrame. It can be used in combination with
4151 * AV_OPT_SEARCH_FAKE_OBJ for examining options.
4153 * @see av_opt_find().
4155 const AVClass *avcodec_get_frame_class(void);
4158 * Get the AVClass for AVSubtitleRect. It can be used in combination with
4159 * AV_OPT_SEARCH_FAKE_OBJ for examining options.
4161 * @see av_opt_find().
4163 const AVClass *avcodec_get_subtitle_rect_class(void);
4166 * Copy the settings of the source AVCodecContext into the destination
4167 * AVCodecContext. The resulting destination codec context will be
4168 * unopened, i.e. you are required to call avcodec_open2() before you
4169 * can use this AVCodecContext to decode/encode video/audio data.
4171 * @param dest target codec context, should be initialized with
4172 * avcodec_alloc_context3(NULL), but otherwise uninitialized
4173 * @param src source codec context
4174 * @return AVERROR() on error (e.g. memory allocation error), 0 on success
4176 int avcodec_copy_context(AVCodecContext *dest, const AVCodecContext *src);
4179 * Allocate a new AVCodecParameters and set its fields to default values
4180 * (unknown/invalid/0). The returned struct must be freed with
4181 * avcodec_parameters_free().
4183 AVCodecParameters *avcodec_parameters_alloc(void);
4186 * Free an AVCodecParameters instance and everything associated with it and
4187 * write NULL to the supplied pointer.
4189 void avcodec_parameters_free(AVCodecParameters **par);
4192 * Copy the contents of src to dst. Any allocated fields in dst are freed and
4193 * replaced with newly allocated duplicates of the corresponding fields in src.
4195 * @return >= 0 on success, a negative AVERROR code on failure.
4197 int avcodec_parameters_copy(AVCodecParameters *dst, const AVCodecParameters *src);
4200 * Fill the parameters struct based on the values from the supplied codec
4201 * context. Any allocated fields in par are freed and replaced with duplicates
4202 * of the corresponding fields in codec.
4204 * @return >= 0 on success, a negative AVERROR code on failure
4206 int avcodec_parameters_from_context(AVCodecParameters *par,
4207 const AVCodecContext *codec);
4210 * Fill the codec context based on the values from the supplied codec
4211 * parameters. Any allocated fields in codec that have a corresponding field in
4212 * par are freed and replaced with duplicates of the corresponding field in par.
4213 * Fields in codec that do not have a counterpart in par are not touched.
4215 * @return >= 0 on success, a negative AVERROR code on failure.
4217 int avcodec_parameters_to_context(AVCodecContext *codec,
4218 const AVCodecParameters *par);
4221 * Initialize the AVCodecContext to use the given AVCodec. Prior to using this
4222 * function the context has to be allocated with avcodec_alloc_context3().
4224 * The functions avcodec_find_decoder_by_name(), avcodec_find_encoder_by_name(),
4225 * avcodec_find_decoder() and avcodec_find_encoder() provide an easy way for
4226 * retrieving a codec.
4228 * @warning This function is not thread safe!
4230 * @note Always call this function before using decoding routines (such as
4231 * @ref avcodec_receive_frame()).
4234 * avcodec_register_all();
4235 * av_dict_set(&opts, "b", "2.5M", 0);
4236 * codec = avcodec_find_decoder(AV_CODEC_ID_H264);
4240 * context = avcodec_alloc_context3(codec);
4242 * if (avcodec_open2(context, codec, opts) < 0)
4246 * @param avctx The context to initialize.
4247 * @param codec The codec to open this context for. If a non-NULL codec has been
4248 * previously passed to avcodec_alloc_context3() or
4249 * avcodec_get_context_defaults3() for this context, then this
4250 * parameter MUST be either NULL or equal to the previously passed
4252 * @param options A dictionary filled with AVCodecContext and codec-private options.
4253 * On return this object will be filled with options that were not found.
4255 * @return zero on success, a negative value on error
4256 * @see avcodec_alloc_context3(), avcodec_find_decoder(), avcodec_find_encoder(),
4257 * av_dict_set(), av_opt_find().
4259 int avcodec_open2(AVCodecContext *avctx, const AVCodec *codec, AVDictionary **options);
4262 * Close a given AVCodecContext and free all the data associated with it
4263 * (but not the AVCodecContext itself).
4265 * Calling this function on an AVCodecContext that hasn't been opened will free
4266 * the codec-specific data allocated in avcodec_alloc_context3() /
4267 * avcodec_get_context_defaults3() with a non-NULL codec. Subsequent calls will
4270 int avcodec_close(AVCodecContext *avctx);
4273 * Free all allocated data in the given subtitle struct.
4275 * @param sub AVSubtitle to free.
4277 void avsubtitle_free(AVSubtitle *sub);
4284 * @addtogroup lavc_packet
4289 * Allocate an AVPacket and set its fields to default values. The resulting
4290 * struct must be freed using av_packet_free().
4292 * @return An AVPacket filled with default values or NULL on failure.
4294 * @note this only allocates the AVPacket itself, not the data buffers. Those
4295 * must be allocated through other means such as av_new_packet.
4297 * @see av_new_packet
4299 AVPacket *av_packet_alloc(void);
4302 * Create a new packet that references the same data as src.
4304 * This is a shortcut for av_packet_alloc()+av_packet_ref().
4306 * @return newly created AVPacket on success, NULL on error.
4308 * @see av_packet_alloc
4309 * @see av_packet_ref
4311 AVPacket *av_packet_clone(AVPacket *src);
4314 * Free the packet, if the packet is reference counted, it will be
4315 * unreferenced first.
4317 * @param packet packet to be freed. The pointer will be set to NULL.
4318 * @note passing NULL is a no-op.
4320 void av_packet_free(AVPacket **pkt);
4323 * Initialize optional fields of a packet with default values.
4325 * Note, this does not touch the data and size members, which have to be
4326 * initialized separately.
4330 void av_init_packet(AVPacket *pkt);
4333 * Allocate the payload of a packet and initialize its fields with
4337 * @param size wanted payload size
4338 * @return 0 if OK, AVERROR_xxx otherwise
4340 int av_new_packet(AVPacket *pkt, int size);
4343 * Reduce packet size, correctly zeroing padding
4346 * @param size new size
4348 void av_shrink_packet(AVPacket *pkt, int size);
4351 * Increase packet size, correctly zeroing padding
4354 * @param grow_by number of bytes by which to increase the size of the packet
4356 int av_grow_packet(AVPacket *pkt, int grow_by);
4359 * Initialize a reference-counted packet from av_malloc()ed data.
4361 * @param pkt packet to be initialized. This function will set the data, size,
4362 * buf and destruct fields, all others are left untouched.
4363 * @param data Data allocated by av_malloc() to be used as packet data. If this
4364 * function returns successfully, the data is owned by the underlying AVBuffer.
4365 * The caller may not access the data through other means.
4366 * @param size size of data in bytes, without the padding. I.e. the full buffer
4367 * size is assumed to be size + AV_INPUT_BUFFER_PADDING_SIZE.
4369 * @return 0 on success, a negative AVERROR on error
4371 int av_packet_from_data(AVPacket *pkt, uint8_t *data, int size);
4373 #if FF_API_AVPACKET_OLD_API
4375 * @warning This is a hack - the packet memory allocation stuff is broken. The
4376 * packet is allocated if it was not really allocated.
4378 * @deprecated Use av_packet_ref
4380 attribute_deprecated
4381 int av_dup_packet(AVPacket *pkt);
4383 * Copy packet, including contents
4385 * @return 0 on success, negative AVERROR on fail
4387 int av_copy_packet(AVPacket *dst, const AVPacket *src);
4390 * Copy packet side data
4392 * @return 0 on success, negative AVERROR on fail
4394 int av_copy_packet_side_data(AVPacket *dst, const AVPacket *src);
4399 * @deprecated Use av_packet_unref
4401 * @param pkt packet to free
4403 attribute_deprecated
4404 void av_free_packet(AVPacket *pkt);
4407 * Allocate new information of a packet.
4410 * @param type side information type
4411 * @param size side information size
4412 * @return pointer to fresh allocated data or NULL otherwise
4414 uint8_t* av_packet_new_side_data(AVPacket *pkt, enum AVPacketSideDataType type,
4418 * Wrap an existing array as a packet side data.
4421 * @param type side information type
4422 * @param data the side data array. It must be allocated with the av_malloc()
4423 * family of functions. The ownership of the data is transferred to
4425 * @param size side information size
4426 * @return a non-negative number on success, a negative AVERROR code on
4427 * failure. On failure, the packet is unchanged and the data remains
4428 * owned by the caller.
4430 int av_packet_add_side_data(AVPacket *pkt, enum AVPacketSideDataType type,
4431 uint8_t *data, size_t size);
4434 * Shrink the already allocated side data buffer
4437 * @param type side information type
4438 * @param size new side information size
4439 * @return 0 on success, < 0 on failure
4441 int av_packet_shrink_side_data(AVPacket *pkt, enum AVPacketSideDataType type,
4445 * Get side information from packet.
4448 * @param type desired side information type
4449 * @param size pointer for side information size to store (optional)
4450 * @return pointer to data if present or NULL otherwise
4452 uint8_t* av_packet_get_side_data(AVPacket *pkt, enum AVPacketSideDataType type,
4455 int av_packet_merge_side_data(AVPacket *pkt);
4457 int av_packet_split_side_data(AVPacket *pkt);
4459 const char *av_packet_side_data_name(enum AVPacketSideDataType type);
4462 * Pack a dictionary for use in side_data.
4464 * @param dict The dictionary to pack.
4465 * @param size pointer to store the size of the returned data
4466 * @return pointer to data if successful, NULL otherwise
4468 uint8_t *av_packet_pack_dictionary(AVDictionary *dict, int *size);
4470 * Unpack a dictionary from side_data.
4472 * @param data data from side_data
4473 * @param size size of the data
4474 * @param dict the metadata storage dictionary
4475 * @return 0 on success, < 0 on failure
4477 int av_packet_unpack_dictionary(const uint8_t *data, int size, AVDictionary **dict);
4481 * Convenience function to free all the side data stored.
4482 * All the other fields stay untouched.
4486 void av_packet_free_side_data(AVPacket *pkt);
4489 * Setup a new reference to the data described by a given packet
4491 * If src is reference-counted, setup dst as a new reference to the
4492 * buffer in src. Otherwise allocate a new buffer in dst and copy the
4493 * data from src into it.
4495 * All the other fields are copied from src.
4497 * @see av_packet_unref
4499 * @param dst Destination packet
4500 * @param src Source packet
4502 * @return 0 on success, a negative AVERROR on error.
4504 int av_packet_ref(AVPacket *dst, const AVPacket *src);
4509 * Unreference the buffer referenced by the packet and reset the
4510 * remaining packet fields to their default values.
4512 * @param pkt The packet to be unreferenced.
4514 void av_packet_unref(AVPacket *pkt);
4517 * Move every field in src to dst and reset src.
4519 * @see av_packet_unref
4521 * @param src Source packet, will be reset
4522 * @param dst Destination packet
4524 void av_packet_move_ref(AVPacket *dst, AVPacket *src);
4527 * Copy only "properties" fields from src to dst.
4529 * Properties for the purpose of this function are all the fields
4530 * beside those related to the packet data (buf, data, size)
4532 * @param dst Destination packet
4533 * @param src Source packet
4535 * @return 0 on success AVERROR on failure.
4537 int av_packet_copy_props(AVPacket *dst, const AVPacket *src);
4540 * Convert valid timing fields (timestamps / durations) in a packet from one
4541 * timebase to another. Timestamps with unknown values (AV_NOPTS_VALUE) will be
4544 * @param pkt packet on which the conversion will be performed
4545 * @param tb_src source timebase, in which the timing fields in pkt are
4547 * @param tb_dst destination timebase, to which the timing fields will be
4550 void av_packet_rescale_ts(AVPacket *pkt, AVRational tb_src, AVRational tb_dst);
4557 * @addtogroup lavc_decoding
4562 * Find a registered decoder with a matching codec ID.
4564 * @param id AVCodecID of the requested decoder
4565 * @return A decoder if one was found, NULL otherwise.
4567 AVCodec *avcodec_find_decoder(enum AVCodecID id);
4570 * Find a registered decoder with the specified name.
4572 * @param name name of the requested decoder
4573 * @return A decoder if one was found, NULL otherwise.
4575 AVCodec *avcodec_find_decoder_by_name(const char *name);
4578 * The default callback for AVCodecContext.get_buffer2(). It is made public so
4579 * it can be called by custom get_buffer2() implementations for decoders without
4580 * AV_CODEC_CAP_DR1 set.
4582 int avcodec_default_get_buffer2(AVCodecContext *s, AVFrame *frame, int flags);
4586 * Return the amount of padding in pixels which the get_buffer callback must
4587 * provide around the edge of the image for codecs which do not have the
4588 * CODEC_FLAG_EMU_EDGE flag.
4590 * @return Required padding in pixels.
4592 * @deprecated CODEC_FLAG_EMU_EDGE is deprecated, so this function is no longer
4595 attribute_deprecated
4596 unsigned avcodec_get_edge_width(void);
4600 * Modify width and height values so that they will result in a memory
4601 * buffer that is acceptable for the codec if you do not use any horizontal
4604 * May only be used if a codec with AV_CODEC_CAP_DR1 has been opened.
4606 void avcodec_align_dimensions(AVCodecContext *s, int *width, int *height);
4609 * Modify width and height values so that they will result in a memory
4610 * buffer that is acceptable for the codec if you also ensure that all
4611 * line sizes are a multiple of the respective linesize_align[i].
4613 * May only be used if a codec with AV_CODEC_CAP_DR1 has been opened.
4615 void avcodec_align_dimensions2(AVCodecContext *s, int *width, int *height,
4616 int linesize_align[AV_NUM_DATA_POINTERS]);
4619 * Converts AVChromaLocation to swscale x/y chroma position.
4621 * The positions represent the chroma (0,0) position in a coordinates system
4622 * with luma (0,0) representing the origin and luma(1,1) representing 256,256
4624 * @param xpos horizontal chroma sample position
4625 * @param ypos vertical chroma sample position
4627 int avcodec_enum_to_chroma_pos(int *xpos, int *ypos, enum AVChromaLocation pos);
4630 * Converts swscale x/y chroma position to AVChromaLocation.
4632 * The positions represent the chroma (0,0) position in a coordinates system
4633 * with luma (0,0) representing the origin and luma(1,1) representing 256,256
4635 * @param xpos horizontal chroma sample position
4636 * @param ypos vertical chroma sample position
4638 enum AVChromaLocation avcodec_chroma_pos_to_enum(int xpos, int ypos);
4641 * Decode the audio frame of size avpkt->size from avpkt->data into frame.
4643 * Some decoders may support multiple frames in a single AVPacket. Such
4644 * decoders would then just decode the first frame and the return value would be
4645 * less than the packet size. In this case, avcodec_decode_audio4 has to be
4646 * called again with an AVPacket containing the remaining data in order to
4647 * decode the second frame, etc... Even if no frames are returned, the packet
4648 * needs to be fed to the decoder with remaining data until it is completely
4649 * consumed or an error occurs.
4651 * Some decoders (those marked with AV_CODEC_CAP_DELAY) have a delay between input
4652 * and output. This means that for some packets they will not immediately
4653 * produce decoded output and need to be flushed at the end of decoding to get
4654 * all the decoded data. Flushing is done by calling this function with packets
4655 * with avpkt->data set to NULL and avpkt->size set to 0 until it stops
4656 * returning samples. It is safe to flush even those decoders that are not
4657 * marked with AV_CODEC_CAP_DELAY, then no samples will be returned.
4659 * @warning The input buffer, avpkt->data must be AV_INPUT_BUFFER_PADDING_SIZE
4660 * larger than the actual read bytes because some optimized bitstream
4661 * readers read 32 or 64 bits at once and could read over the end.
4663 * @note The AVCodecContext MUST have been opened with @ref avcodec_open2()
4664 * before packets may be fed to the decoder.
4666 * @param avctx the codec context
4667 * @param[out] frame The AVFrame in which to store decoded audio samples.
4668 * The decoder will allocate a buffer for the decoded frame by
4669 * calling the AVCodecContext.get_buffer2() callback.
4670 * When AVCodecContext.refcounted_frames is set to 1, the frame is
4671 * reference counted and the returned reference belongs to the
4672 * caller. The caller must release the frame using av_frame_unref()
4673 * when the frame is no longer needed. The caller may safely write
4674 * to the frame if av_frame_is_writable() returns 1.
4675 * When AVCodecContext.refcounted_frames is set to 0, the returned
4676 * reference belongs to the decoder and is valid only until the
4677 * next call to this function or until closing or flushing the
4678 * decoder. The caller may not write to it.
4679 * @param[out] got_frame_ptr Zero if no frame could be decoded, otherwise it is
4680 * non-zero. Note that this field being set to zero
4681 * does not mean that an error has occurred. For
4682 * decoders with AV_CODEC_CAP_DELAY set, no given decode
4683 * call is guaranteed to produce a frame.
4684 * @param[in] avpkt The input AVPacket containing the input buffer.
4685 * At least avpkt->data and avpkt->size should be set. Some
4686 * decoders might also require additional fields to be set.
4687 * @return A negative error code is returned if an error occurred during
4688 * decoding, otherwise the number of bytes consumed from the input
4689 * AVPacket is returned.
4691 * @deprecated Use avcodec_send_packet() and avcodec_receive_frame().
4693 attribute_deprecated
4694 int avcodec_decode_audio4(AVCodecContext *avctx, AVFrame *frame,
4695 int *got_frame_ptr, const AVPacket *avpkt);
4698 * Decode the video frame of size avpkt->size from avpkt->data into picture.
4699 * Some decoders may support multiple frames in a single AVPacket, such
4700 * decoders would then just decode the first frame.
4702 * @warning The input buffer must be AV_INPUT_BUFFER_PADDING_SIZE larger than
4703 * the actual read bytes because some optimized bitstream readers read 32 or 64
4704 * bits at once and could read over the end.
4706 * @warning The end of the input buffer buf should be set to 0 to ensure that
4707 * no overreading happens for damaged MPEG streams.
4709 * @note Codecs which have the AV_CODEC_CAP_DELAY capability set have a delay
4710 * between input and output, these need to be fed with avpkt->data=NULL,
4711 * avpkt->size=0 at the end to return the remaining frames.
4713 * @note The AVCodecContext MUST have been opened with @ref avcodec_open2()
4714 * before packets may be fed to the decoder.
4716 * @param avctx the codec context
4717 * @param[out] picture The AVFrame in which the decoded video frame will be stored.
4718 * Use av_frame_alloc() to get an AVFrame. The codec will
4719 * allocate memory for the actual bitmap by calling the
4720 * AVCodecContext.get_buffer2() callback.
4721 * When AVCodecContext.refcounted_frames is set to 1, the frame is
4722 * reference counted and the returned reference belongs to the
4723 * caller. The caller must release the frame using av_frame_unref()
4724 * when the frame is no longer needed. The caller may safely write
4725 * to the frame if av_frame_is_writable() returns 1.
4726 * When AVCodecContext.refcounted_frames is set to 0, the returned
4727 * reference belongs to the decoder and is valid only until the
4728 * next call to this function or until closing or flushing the
4729 * decoder. The caller may not write to it.
4731 * @param[in] avpkt The input AVPacket containing the input buffer.
4732 * You can create such packet with av_init_packet() and by then setting
4733 * data and size, some decoders might in addition need other fields like
4734 * flags&AV_PKT_FLAG_KEY. All decoders are designed to use the least
4736 * @param[in,out] got_picture_ptr Zero if no frame could be decompressed, otherwise, it is nonzero.
4737 * @return On error a negative value is returned, otherwise the number of bytes
4738 * used or zero if no frame could be decompressed.
4740 * @deprecated Use avcodec_send_packet() and avcodec_receive_frame().
4742 attribute_deprecated
4743 int avcodec_decode_video2(AVCodecContext *avctx, AVFrame *picture,
4744 int *got_picture_ptr,
4745 const AVPacket *avpkt);
4748 * Decode a subtitle message.
4749 * Return a negative value on error, otherwise return the number of bytes used.
4750 * If no subtitle could be decompressed, got_sub_ptr is zero.
4751 * Otherwise, the subtitle is stored in *sub.
4752 * Note that AV_CODEC_CAP_DR1 is not available for subtitle codecs. This is for
4753 * simplicity, because the performance difference is expect to be negligible
4754 * and reusing a get_buffer written for video codecs would probably perform badly
4755 * due to a potentially very different allocation pattern.
4757 * Some decoders (those marked with CODEC_CAP_DELAY) have a delay between input
4758 * and output. This means that for some packets they will not immediately
4759 * produce decoded output and need to be flushed at the end of decoding to get
4760 * all the decoded data. Flushing is done by calling this function with packets
4761 * with avpkt->data set to NULL and avpkt->size set to 0 until it stops
4762 * returning subtitles. It is safe to flush even those decoders that are not
4763 * marked with CODEC_CAP_DELAY, then no subtitles will be returned.
4765 * @note The AVCodecContext MUST have been opened with @ref avcodec_open2()
4766 * before packets may be fed to the decoder.
4768 * @param avctx the codec context
4769 * @param[out] sub The Preallocated AVSubtitle in which the decoded subtitle will be stored,
4770 * must be freed with avsubtitle_free if *got_sub_ptr is set.
4771 * @param[in,out] got_sub_ptr Zero if no subtitle could be decompressed, otherwise, it is nonzero.
4772 * @param[in] avpkt The input AVPacket containing the input buffer.
4774 int avcodec_decode_subtitle2(AVCodecContext *avctx, AVSubtitle *sub,
4779 * Supply raw packet data as input to a decoder.
4781 * Internally, this call will copy relevant AVCodecContext fields, which can
4782 * influence decoding per-packet, and apply them when the packet is actually
4783 * decoded. (For example AVCodecContext.skip_frame, which might direct the
4784 * decoder to drop the frame contained by the packet sent with this function.)
4786 * @warning The input buffer, avpkt->data must be AV_INPUT_BUFFER_PADDING_SIZE
4787 * larger than the actual read bytes because some optimized bitstream
4788 * readers read 32 or 64 bits at once and could read over the end.
4790 * @warning Do not mix this API with the legacy API (like avcodec_decode_video2())
4791 * on the same AVCodecContext. It will return unexpected results now
4792 * or in future libavcodec versions.
4794 * @note The AVCodecContext MUST have been opened with @ref avcodec_open2()
4795 * before packets may be fed to the decoder.
4797 * @param avctx codec context
4798 * @param[in] avpkt The input AVPacket. Usually, this will be a single video
4799 * frame, or several complete audio frames.
4800 * Ownership of the packet remains with the caller, and the
4801 * decoder will not write to the packet. The decoder may create
4802 * a reference to the packet data (or copy it if the packet is
4803 * not reference-counted).
4804 * Unlike with older APIs, the packet is always fully consumed,
4805 * and if it contains multiple frames (e.g. some audio codecs),
4806 * will require you to call avcodec_receive_frame() multiple
4807 * times afterwards before you can send a new packet.
4808 * It can be NULL (or an AVPacket with data set to NULL and
4809 * size set to 0); in this case, it is considered a flush
4810 * packet, which signals the end of the stream. Sending the
4811 * first flush packet will return success. Subsequent ones are
4812 * unnecessary and will return AVERROR_EOF. If the decoder
4813 * still has frames buffered, it will return them after sending
4816 * @return 0 on success, otherwise negative error code:
4817 * AVERROR(EAGAIN): input is not accepted right now - the packet must be
4818 * resent after trying to read output
4819 * AVERROR_EOF: the decoder has been flushed, and no new packets can
4820 * be sent to it (also returned if more than 1 flush
4822 * AVERROR(EINVAL): codec not opened, it is an encoder, or requires flush
4823 * AVERROR(ENOMEM): failed to add packet to internal queue, or similar
4824 * other errors: legitimate decoding errors
4826 int avcodec_send_packet(AVCodecContext *avctx, const AVPacket *avpkt);
4829 * Return decoded output data from a decoder.
4831 * @param avctx codec context
4832 * @param frame This will be set to a reference-counted video or audio
4833 * frame (depending on the decoder type) allocated by the
4834 * decoder. Note that the function will always call
4835 * av_frame_unref(frame) before doing anything else.
4838 * 0: success, a frame was returned
4839 * AVERROR(EAGAIN): output is not available right now - user must try
4841 * AVERROR_EOF: the decoder has been fully flushed, and there will be
4842 * no more output frames
4843 * AVERROR(EINVAL): codec not opened, or it is an encoder
4844 * other negative values: legitimate decoding errors
4846 int avcodec_receive_frame(AVCodecContext *avctx, AVFrame *frame);
4849 * Supply a raw video or audio frame to the encoder. Use avcodec_receive_packet()
4850 * to retrieve buffered output packets.
4852 * @param avctx codec context
4853 * @param[in] frame AVFrame containing the raw audio or video frame to be encoded.
4854 * Ownership of the frame remains with the caller, and the
4855 * encoder will not write to the frame. The encoder may create
4856 * a reference to the frame data (or copy it if the frame is
4857 * not reference-counted).
4858 * It can be NULL, in which case it is considered a flush
4859 * packet. This signals the end of the stream. If the encoder
4860 * still has packets buffered, it will return them after this
4861 * call. Once flushing mode has been entered, additional flush
4862 * packets are ignored, and sending frames will return
4866 * If AV_CODEC_CAP_VARIABLE_FRAME_SIZE is set, then each frame
4867 * can have any number of samples.
4868 * If it is not set, frame->nb_samples must be equal to
4869 * avctx->frame_size for all frames except the last.
4870 * The final frame may be smaller than avctx->frame_size.
4871 * @return 0 on success, otherwise negative error code:
4872 * AVERROR(EAGAIN): input is not accepted right now - the frame must be
4873 * resent after trying to read output packets
4874 * AVERROR_EOF: the encoder has been flushed, and no new frames can
4876 * AVERROR(EINVAL): codec not opened, refcounted_frames not set, it is a
4877 * decoder, or requires flush
4878 * AVERROR(ENOMEM): failed to add packet to internal queue, or similar
4879 * other errors: legitimate decoding errors
4881 int avcodec_send_frame(AVCodecContext *avctx, const AVFrame *frame);
4884 * Read encoded data from the encoder.
4886 * @param avctx codec context
4887 * @param avpkt This will be set to a reference-counted packet allocated by the
4888 * encoder. Note that the function will always call
4889 * av_frame_unref(frame) before doing anything else.
4890 * @return 0 on success, otherwise negative error code:
4891 * AVERROR(EAGAIN): output is not available right now - user must try
4893 * AVERROR_EOF: the encoder has been fully flushed, and there will be
4894 * no more output packets
4895 * AVERROR(EINVAL): codec not opened, or it is an encoder
4896 * other errors: legitimate decoding errors
4898 int avcodec_receive_packet(AVCodecContext *avctx, AVPacket *avpkt);
4902 * @defgroup lavc_parsing Frame parsing
4906 enum AVPictureStructure {
4907 AV_PICTURE_STRUCTURE_UNKNOWN, //< unknown
4908 AV_PICTURE_STRUCTURE_TOP_FIELD, //< coded as top field
4909 AV_PICTURE_STRUCTURE_BOTTOM_FIELD, //< coded as bottom field
4910 AV_PICTURE_STRUCTURE_FRAME, //< coded as frame
4913 typedef struct AVCodecParserContext {
4915 struct AVCodecParser *parser;
4916 int64_t frame_offset; /* offset of the current frame */
4917 int64_t cur_offset; /* current offset
4918 (incremented by each av_parser_parse()) */
4919 int64_t next_frame_offset; /* offset of the next frame */
4921 int pict_type; /* XXX: Put it back in AVCodecContext. */
4923 * This field is used for proper frame duration computation in lavf.
4924 * It signals, how much longer the frame duration of the current frame
4925 * is compared to normal frame duration.
4927 * frame_duration = (1 + repeat_pict) * time_base
4929 * It is used by codecs like H.264 to display telecined material.
4931 int repeat_pict; /* XXX: Put it back in AVCodecContext. */
4932 int64_t pts; /* pts of the current frame */
4933 int64_t dts; /* dts of the current frame */
4938 int fetch_timestamp;
4940 #define AV_PARSER_PTS_NB 4
4941 int cur_frame_start_index;
4942 int64_t cur_frame_offset[AV_PARSER_PTS_NB];
4943 int64_t cur_frame_pts[AV_PARSER_PTS_NB];
4944 int64_t cur_frame_dts[AV_PARSER_PTS_NB];
4947 #define PARSER_FLAG_COMPLETE_FRAMES 0x0001
4948 #define PARSER_FLAG_ONCE 0x0002
4949 /// Set if the parser has a valid file offset
4950 #define PARSER_FLAG_FETCHED_OFFSET 0x0004
4951 #define PARSER_FLAG_USE_CODEC_TS 0x1000
4953 int64_t offset; ///< byte offset from starting packet start
4954 int64_t cur_frame_end[AV_PARSER_PTS_NB];
4957 * Set by parser to 1 for key frames and 0 for non-key frames.
4958 * It is initialized to -1, so if the parser doesn't set this flag,
4959 * old-style fallback using AV_PICTURE_TYPE_I picture type as key frames
4964 #if FF_API_CONVERGENCE_DURATION
4966 * @deprecated unused
4968 attribute_deprecated
4969 int64_t convergence_duration;
4972 // Timestamp generation support:
4974 * Synchronization point for start of timestamp generation.
4976 * Set to >0 for sync point, 0 for no sync point and <0 for undefined
4979 * For example, this corresponds to presence of H.264 buffering period
4985 * Offset of the current timestamp against last timestamp sync point in
4986 * units of AVCodecContext.time_base.
4988 * Set to INT_MIN when dts_sync_point unused. Otherwise, it must
4989 * contain a valid timestamp offset.
4991 * Note that the timestamp of sync point has usually a nonzero
4992 * dts_ref_dts_delta, which refers to the previous sync point. Offset of
4993 * the next frame after timestamp sync point will be usually 1.
4995 * For example, this corresponds to H.264 cpb_removal_delay.
4997 int dts_ref_dts_delta;
5000 * Presentation delay of current frame in units of AVCodecContext.time_base.
5002 * Set to INT_MIN when dts_sync_point unused. Otherwise, it must
5003 * contain valid non-negative timestamp delta (presentation time of a frame
5004 * must not lie in the past).
5006 * This delay represents the difference between decoding and presentation
5007 * time of the frame.
5009 * For example, this corresponds to H.264 dpb_output_delay.
5014 * Position of the packet in file.
5016 * Analogous to cur_frame_pts/dts
5018 int64_t cur_frame_pos[AV_PARSER_PTS_NB];
5021 * Byte position of currently parsed frame in stream.
5026 * Previous frame byte position.
5031 * Duration of the current frame.
5032 * For audio, this is in units of 1 / AVCodecContext.sample_rate.
5033 * For all other types, this is in units of AVCodecContext.time_base.
5037 enum AVFieldOrder field_order;
5040 * Indicate whether a picture is coded as a frame, top field or bottom field.
5042 * For example, H.264 field_pic_flag equal to 0 corresponds to
5043 * AV_PICTURE_STRUCTURE_FRAME. An H.264 picture with field_pic_flag
5044 * equal to 1 and bottom_field_flag equal to 0 corresponds to
5045 * AV_PICTURE_STRUCTURE_TOP_FIELD.
5047 enum AVPictureStructure picture_structure;
5050 * Picture number incremented in presentation or output order.
5051 * This field may be reinitialized at the first picture of a new sequence.
5053 * For example, this corresponds to H.264 PicOrderCnt.
5055 int output_picture_number;
5058 * Dimensions of the decoded video intended for presentation.
5064 * Dimensions of the coded video.
5070 * The format of the coded data, corresponds to enum AVPixelFormat for video
5071 * and for enum AVSampleFormat for audio.
5073 * Note that a decoder can have considerable freedom in how exactly it
5074 * decodes the data, so the format reported here might be different from the
5075 * one returned by a decoder.
5078 } AVCodecParserContext;
5080 typedef struct AVCodecParser {
5081 int codec_ids[5]; /* several codec IDs are permitted */
5083 int (*parser_init)(AVCodecParserContext *s);
5084 /* This callback never returns an error, a negative value means that
5085 * the frame start was in a previous packet. */
5086 int (*parser_parse)(AVCodecParserContext *s,
5087 AVCodecContext *avctx,
5088 const uint8_t **poutbuf, int *poutbuf_size,
5089 const uint8_t *buf, int buf_size);
5090 void (*parser_close)(AVCodecParserContext *s);
5091 int (*split)(AVCodecContext *avctx, const uint8_t *buf, int buf_size);
5092 struct AVCodecParser *next;
5095 AVCodecParser *av_parser_next(const AVCodecParser *c);
5097 void av_register_codec_parser(AVCodecParser *parser);
5098 AVCodecParserContext *av_parser_init(int codec_id);
5103 * @param s parser context.
5104 * @param avctx codec context.
5105 * @param poutbuf set to pointer to parsed buffer or NULL if not yet finished.
5106 * @param poutbuf_size set to size of parsed buffer or zero if not yet finished.
5107 * @param buf input buffer.
5108 * @param buf_size input length, to signal EOF, this should be 0 (so that the last frame can be output).
5109 * @param pts input presentation timestamp.
5110 * @param dts input decoding timestamp.
5111 * @param pos input byte position in stream.
5112 * @return the number of bytes of the input bitstream used.
5117 * len = av_parser_parse2(myparser, AVCodecContext, &data, &size,
5124 * decode_frame(data, size);
5128 int av_parser_parse2(AVCodecParserContext *s,
5129 AVCodecContext *avctx,
5130 uint8_t **poutbuf, int *poutbuf_size,
5131 const uint8_t *buf, int buf_size,
5132 int64_t pts, int64_t dts,
5136 * @return 0 if the output buffer is a subset of the input, 1 if it is allocated and must be freed
5137 * @deprecated use AVBitStreamFilter
5139 int av_parser_change(AVCodecParserContext *s,
5140 AVCodecContext *avctx,
5141 uint8_t **poutbuf, int *poutbuf_size,
5142 const uint8_t *buf, int buf_size, int keyframe);
5143 void av_parser_close(AVCodecParserContext *s);
5151 * @addtogroup lavc_encoding
5156 * Find a registered encoder with a matching codec ID.
5158 * @param id AVCodecID of the requested encoder
5159 * @return An encoder if one was found, NULL otherwise.
5161 AVCodec *avcodec_find_encoder(enum AVCodecID id);
5164 * Find a registered encoder with the specified name.
5166 * @param name name of the requested encoder
5167 * @return An encoder if one was found, NULL otherwise.
5169 AVCodec *avcodec_find_encoder_by_name(const char *name);
5172 * Encode a frame of audio.
5174 * Takes input samples from frame and writes the next output packet, if
5175 * available, to avpkt. The output packet does not necessarily contain data for
5176 * the most recent frame, as encoders can delay, split, and combine input frames
5177 * internally as needed.
5179 * @param avctx codec context
5180 * @param avpkt output AVPacket.
5181 * The user can supply an output buffer by setting
5182 * avpkt->data and avpkt->size prior to calling the
5183 * function, but if the size of the user-provided data is not
5184 * large enough, encoding will fail. If avpkt->data and
5185 * avpkt->size are set, avpkt->destruct must also be set. All
5186 * other AVPacket fields will be reset by the encoder using
5187 * av_init_packet(). If avpkt->data is NULL, the encoder will
5188 * allocate it. The encoder will set avpkt->size to the size
5189 * of the output packet.
5191 * If this function fails or produces no output, avpkt will be
5192 * freed using av_packet_unref().
5193 * @param[in] frame AVFrame containing the raw audio data to be encoded.
5194 * May be NULL when flushing an encoder that has the
5195 * AV_CODEC_CAP_DELAY capability set.
5196 * If AV_CODEC_CAP_VARIABLE_FRAME_SIZE is set, then each frame
5197 * can have any number of samples.
5198 * If it is not set, frame->nb_samples must be equal to
5199 * avctx->frame_size for all frames except the last.
5200 * The final frame may be smaller than avctx->frame_size.
5201 * @param[out] got_packet_ptr This field is set to 1 by libavcodec if the
5202 * output packet is non-empty, and to 0 if it is
5203 * empty. If the function returns an error, the
5204 * packet can be assumed to be invalid, and the
5205 * value of got_packet_ptr is undefined and should
5207 * @return 0 on success, negative error code on failure
5209 * @deprecated use avcodec_send_frame()/avcodec_receive_packet() instead
5211 attribute_deprecated
5212 int avcodec_encode_audio2(AVCodecContext *avctx, AVPacket *avpkt,
5213 const AVFrame *frame, int *got_packet_ptr);
5216 * Encode a frame of video.
5218 * Takes input raw video data from frame and writes the next output packet, if
5219 * available, to avpkt. The output packet does not necessarily contain data for
5220 * the most recent frame, as encoders can delay and reorder input frames
5221 * internally as needed.
5223 * @param avctx codec context
5224 * @param avpkt output AVPacket.
5225 * The user can supply an output buffer by setting
5226 * avpkt->data and avpkt->size prior to calling the
5227 * function, but if the size of the user-provided data is not
5228 * large enough, encoding will fail. All other AVPacket fields
5229 * will be reset by the encoder using av_init_packet(). If
5230 * avpkt->data is NULL, the encoder will allocate it.
5231 * The encoder will set avpkt->size to the size of the
5232 * output packet. The returned data (if any) belongs to the
5233 * caller, he is responsible for freeing it.
5235 * If this function fails or produces no output, avpkt will be
5236 * freed using av_packet_unref().
5237 * @param[in] frame AVFrame containing the raw video data to be encoded.
5238 * May be NULL when flushing an encoder that has the
5239 * AV_CODEC_CAP_DELAY capability set.
5240 * @param[out] got_packet_ptr This field is set to 1 by libavcodec if the
5241 * output packet is non-empty, and to 0 if it is
5242 * empty. If the function returns an error, the
5243 * packet can be assumed to be invalid, and the
5244 * value of got_packet_ptr is undefined and should
5246 * @return 0 on success, negative error code on failure
5248 * @deprecated use avcodec_send_frame()/avcodec_receive_packet() instead
5250 attribute_deprecated
5251 int avcodec_encode_video2(AVCodecContext *avctx, AVPacket *avpkt,
5252 const AVFrame *frame, int *got_packet_ptr);
5254 int avcodec_encode_subtitle(AVCodecContext *avctx, uint8_t *buf, int buf_size,
5255 const AVSubtitle *sub);
5262 #if FF_API_AVCODEC_RESAMPLE
5264 * @defgroup lavc_resample Audio resampling
5266 * @deprecated use libswresample instead
5270 struct ReSampleContext;
5271 struct AVResampleContext;
5273 typedef struct ReSampleContext ReSampleContext;
5276 * Initialize audio resampling context.
5278 * @param output_channels number of output channels
5279 * @param input_channels number of input channels
5280 * @param output_rate output sample rate
5281 * @param input_rate input sample rate
5282 * @param sample_fmt_out requested output sample format
5283 * @param sample_fmt_in input sample format
5284 * @param filter_length length of each FIR filter in the filterbank relative to the cutoff frequency
5285 * @param log2_phase_count log2 of the number of entries in the polyphase filterbank
5286 * @param linear if 1 then the used FIR filter will be linearly interpolated
5287 between the 2 closest, if 0 the closest will be used
5288 * @param cutoff cutoff frequency, 1.0 corresponds to half the output sampling rate
5289 * @return allocated ReSampleContext, NULL if error occurred
5291 attribute_deprecated
5292 ReSampleContext *av_audio_resample_init(int output_channels, int input_channels,
5293 int output_rate, int input_rate,
5294 enum AVSampleFormat sample_fmt_out,
5295 enum AVSampleFormat sample_fmt_in,
5296 int filter_length, int log2_phase_count,
5297 int linear, double cutoff);
5299 attribute_deprecated
5300 int audio_resample(ReSampleContext *s, short *output, short *input, int nb_samples);
5303 * Free resample context.
5305 * @param s a non-NULL pointer to a resample context previously
5306 * created with av_audio_resample_init()
5308 attribute_deprecated
5309 void audio_resample_close(ReSampleContext *s);
5313 * Initialize an audio resampler.
5314 * Note, if either rate is not an integer then simply scale both rates up so they are.
5315 * @param filter_length length of each FIR filter in the filterbank relative to the cutoff freq
5316 * @param log2_phase_count log2 of the number of entries in the polyphase filterbank
5317 * @param linear If 1 then the used FIR filter will be linearly interpolated
5318 between the 2 closest, if 0 the closest will be used
5319 * @param cutoff cutoff frequency, 1.0 corresponds to half the output sampling rate
5321 attribute_deprecated
5322 struct AVResampleContext *av_resample_init(int out_rate, int in_rate, int filter_length, int log2_phase_count, int linear, double cutoff);
5325 * Resample an array of samples using a previously configured context.
5326 * @param src an array of unconsumed samples
5327 * @param consumed the number of samples of src which have been consumed are returned here
5328 * @param src_size the number of unconsumed samples available
5329 * @param dst_size the amount of space in samples available in dst
5330 * @param update_ctx If this is 0 then the context will not be modified, that way several channels can be resampled with the same context.
5331 * @return the number of samples written in dst or -1 if an error occurred
5333 attribute_deprecated
5334 int av_resample(struct AVResampleContext *c, short *dst, short *src, int *consumed, int src_size, int dst_size, int update_ctx);
5338 * Compensate samplerate/timestamp drift. The compensation is done by changing
5339 * the resampler parameters, so no audible clicks or similar distortions occur
5340 * @param compensation_distance distance in output samples over which the compensation should be performed
5341 * @param sample_delta number of output samples which should be output less
5343 * example: av_resample_compensate(c, 10, 500)
5344 * here instead of 510 samples only 500 samples would be output
5346 * note, due to rounding the actual compensation might be slightly different,
5347 * especially if the compensation_distance is large and the in_rate used during init is small
5349 attribute_deprecated
5350 void av_resample_compensate(struct AVResampleContext *c, int sample_delta, int compensation_distance);
5351 attribute_deprecated
5352 void av_resample_close(struct AVResampleContext *c);
5359 #if FF_API_AVPICTURE
5361 * @addtogroup lavc_picture
5366 * @deprecated unused
5368 attribute_deprecated
5369 int avpicture_alloc(AVPicture *picture, enum AVPixelFormat pix_fmt, int width, int height);
5372 * @deprecated unused
5374 attribute_deprecated
5375 void avpicture_free(AVPicture *picture);
5378 * @deprecated use av_image_fill_arrays() instead.
5380 attribute_deprecated
5381 int avpicture_fill(AVPicture *picture, const uint8_t *ptr,
5382 enum AVPixelFormat pix_fmt, int width, int height);
5385 * @deprecated use av_image_copy_to_buffer() instead.
5387 attribute_deprecated
5388 int avpicture_layout(const AVPicture *src, enum AVPixelFormat pix_fmt,
5389 int width, int height,
5390 unsigned char *dest, int dest_size);
5393 * @deprecated use av_image_get_buffer_size() instead.
5395 attribute_deprecated
5396 int avpicture_get_size(enum AVPixelFormat pix_fmt, int width, int height);
5399 * @deprecated av_image_copy() instead.
5401 attribute_deprecated
5402 void av_picture_copy(AVPicture *dst, const AVPicture *src,
5403 enum AVPixelFormat pix_fmt, int width, int height);
5406 * @deprecated unused
5408 attribute_deprecated
5409 int av_picture_crop(AVPicture *dst, const AVPicture *src,
5410 enum AVPixelFormat pix_fmt, int top_band, int left_band);
5413 * @deprecated unused
5415 attribute_deprecated
5416 int av_picture_pad(AVPicture *dst, const AVPicture *src, int height, int width, enum AVPixelFormat pix_fmt,
5417 int padtop, int padbottom, int padleft, int padright, int *color);
5425 * @defgroup lavc_misc Utility functions
5428 * Miscellaneous utility functions related to both encoding and decoding
5434 * @defgroup lavc_misc_pixfmt Pixel formats
5436 * Functions for working with pixel formats.
5441 * Utility function to access log2_chroma_w log2_chroma_h from
5442 * the pixel format AVPixFmtDescriptor.
5444 * This function asserts that pix_fmt is valid. See av_pix_fmt_get_chroma_sub_sample
5445 * for one that returns a failure code and continues in case of invalid
5448 * @param[in] pix_fmt the pixel format
5449 * @param[out] h_shift store log2_chroma_w
5450 * @param[out] v_shift store log2_chroma_h
5452 * @see av_pix_fmt_get_chroma_sub_sample
5455 void avcodec_get_chroma_sub_sample(enum AVPixelFormat pix_fmt, int *h_shift, int *v_shift);
5458 * Return a value representing the fourCC code associated to the
5459 * pixel format pix_fmt, or 0 if no associated fourCC code can be
5462 unsigned int avcodec_pix_fmt_to_codec_tag(enum AVPixelFormat pix_fmt);
5465 * @deprecated see av_get_pix_fmt_loss()
5467 int avcodec_get_pix_fmt_loss(enum AVPixelFormat dst_pix_fmt, enum AVPixelFormat src_pix_fmt,
5471 * Find the best pixel format to convert to given a certain source pixel
5472 * format. When converting from one pixel format to another, information loss
5473 * may occur. For example, when converting from RGB24 to GRAY, the color
5474 * information will be lost. Similarly, other losses occur when converting from
5475 * some formats to other formats. avcodec_find_best_pix_fmt_of_2() searches which of
5476 * the given pixel formats should be used to suffer the least amount of loss.
5477 * The pixel formats from which it chooses one, are determined by the
5478 * pix_fmt_list parameter.
5481 * @param[in] pix_fmt_list AV_PIX_FMT_NONE terminated array of pixel formats to choose from
5482 * @param[in] src_pix_fmt source pixel format
5483 * @param[in] has_alpha Whether the source pixel format alpha channel is used.
5484 * @param[out] loss_ptr Combination of flags informing you what kind of losses will occur.
5485 * @return The best pixel format to convert to or -1 if none was found.
5487 enum AVPixelFormat avcodec_find_best_pix_fmt_of_list(const enum AVPixelFormat *pix_fmt_list,
5488 enum AVPixelFormat src_pix_fmt,
5489 int has_alpha, int *loss_ptr);
5492 * @deprecated see av_find_best_pix_fmt_of_2()
5494 enum AVPixelFormat avcodec_find_best_pix_fmt_of_2(enum AVPixelFormat dst_pix_fmt1, enum AVPixelFormat dst_pix_fmt2,
5495 enum AVPixelFormat src_pix_fmt, int has_alpha, int *loss_ptr);
5497 attribute_deprecated
5498 #if AV_HAVE_INCOMPATIBLE_LIBAV_ABI
5499 enum AVPixelFormat avcodec_find_best_pix_fmt2(const enum AVPixelFormat *pix_fmt_list,
5500 enum AVPixelFormat src_pix_fmt,
5501 int has_alpha, int *loss_ptr);
5503 enum AVPixelFormat avcodec_find_best_pix_fmt2(enum AVPixelFormat dst_pix_fmt1, enum AVPixelFormat dst_pix_fmt2,
5504 enum AVPixelFormat src_pix_fmt, int has_alpha, int *loss_ptr);
5508 enum AVPixelFormat avcodec_default_get_format(struct AVCodecContext *s, const enum AVPixelFormat * fmt);
5514 #if FF_API_SET_DIMENSIONS
5516 * @deprecated this function is not supposed to be used from outside of lavc
5518 attribute_deprecated
5519 void avcodec_set_dimensions(AVCodecContext *s, int width, int height);
5523 * Put a string representing the codec tag codec_tag in buf.
5525 * @param buf buffer to place codec tag in
5526 * @param buf_size size in bytes of buf
5527 * @param codec_tag codec tag to assign
5528 * @return the length of the string that would have been generated if
5529 * enough space had been available, excluding the trailing null
5531 size_t av_get_codec_tag_string(char *buf, size_t buf_size, unsigned int codec_tag);
5533 void avcodec_string(char *buf, int buf_size, AVCodecContext *enc, int encode);
5536 * Return a name for the specified profile, if available.
5538 * @param codec the codec that is searched for the given profile
5539 * @param profile the profile value for which a name is requested
5540 * @return A name for the profile if found, NULL otherwise.
5542 const char *av_get_profile_name(const AVCodec *codec, int profile);
5545 * Return a name for the specified profile, if available.
5547 * @param codec_id the ID of the codec to which the requested profile belongs
5548 * @param profile the profile value for which a name is requested
5549 * @return A name for the profile if found, NULL otherwise.
5551 * @note unlike av_get_profile_name(), which searches a list of profiles
5552 * supported by a specific decoder or encoder implementation, this
5553 * function searches the list of profiles from the AVCodecDescriptor
5555 const char *avcodec_profile_name(enum AVCodecID codec_id, int profile);
5557 int avcodec_default_execute(AVCodecContext *c, int (*func)(AVCodecContext *c2, void *arg2),void *arg, int *ret, int count, int size);
5558 int avcodec_default_execute2(AVCodecContext *c, int (*func)(AVCodecContext *c2, void *arg2, int, int),void *arg, int *ret, int count);
5559 //FIXME func typedef
5562 * Fill AVFrame audio data and linesize pointers.
5564 * The buffer buf must be a preallocated buffer with a size big enough
5565 * to contain the specified samples amount. The filled AVFrame data
5566 * pointers will point to this buffer.
5568 * AVFrame extended_data channel pointers are allocated if necessary for
5571 * @param frame the AVFrame
5572 * frame->nb_samples must be set prior to calling the
5573 * function. This function fills in frame->data,
5574 * frame->extended_data, frame->linesize[0].
5575 * @param nb_channels channel count
5576 * @param sample_fmt sample format
5577 * @param buf buffer to use for frame data
5578 * @param buf_size size of buffer
5579 * @param align plane size sample alignment (0 = default)
5580 * @return >=0 on success, negative error code on failure
5581 * @todo return the size in bytes required to store the samples in
5582 * case of success, at the next libavutil bump
5584 int avcodec_fill_audio_frame(AVFrame *frame, int nb_channels,
5585 enum AVSampleFormat sample_fmt, const uint8_t *buf,
5586 int buf_size, int align);
5589 * Reset the internal decoder state / flush internal buffers. Should be called
5590 * e.g. when seeking or when switching to a different stream.
5592 * @note when refcounted frames are not used (i.e. avctx->refcounted_frames is 0),
5593 * this invalidates the frames previously returned from the decoder. When
5594 * refcounted frames are used, the decoder just releases any references it might
5595 * keep internally, but the caller's reference remains valid.
5597 void avcodec_flush_buffers(AVCodecContext *avctx);
5600 * Return codec bits per sample.
5602 * @param[in] codec_id the codec
5603 * @return Number of bits per sample or zero if unknown for the given codec.
5605 int av_get_bits_per_sample(enum AVCodecID codec_id);
5608 * Return the PCM codec associated with a sample format.
5609 * @param be endianness, 0 for little, 1 for big,
5610 * -1 (or anything else) for native
5611 * @return AV_CODEC_ID_PCM_* or AV_CODEC_ID_NONE
5613 enum AVCodecID av_get_pcm_codec(enum AVSampleFormat fmt, int be);
5616 * Return codec bits per sample.
5617 * Only return non-zero if the bits per sample is exactly correct, not an
5620 * @param[in] codec_id the codec
5621 * @return Number of bits per sample or zero if unknown for the given codec.
5623 int av_get_exact_bits_per_sample(enum AVCodecID codec_id);
5626 * Return audio frame duration.
5628 * @param avctx codec context
5629 * @param frame_bytes size of the frame, or 0 if unknown
5630 * @return frame duration, in samples, if known. 0 if not able to
5633 int av_get_audio_frame_duration(AVCodecContext *avctx, int frame_bytes);
5636 * This function is the same as av_get_audio_frame_duration(), except it works
5637 * with AVCodecParameters instead of an AVCodecContext.
5639 int av_get_audio_frame_duration2(AVCodecParameters *par, int frame_bytes);
5642 typedef struct AVBitStreamFilterContext {
5644 struct AVBitStreamFilter *filter;
5645 AVCodecParserContext *parser;
5646 struct AVBitStreamFilterContext *next;
5648 * Internal default arguments, used if NULL is passed to av_bitstream_filter_filter().
5649 * Not for access by library users.
5652 } AVBitStreamFilterContext;
5655 typedef struct AVBSFInternal AVBSFInternal;
5658 * The bitstream filter state.
5660 * This struct must be allocated with av_bsf_alloc() and freed with
5663 * The fields in the struct will only be changed (by the caller or by the
5664 * filter) as described in their documentation, and are to be considered
5665 * immutable otherwise.
5667 typedef struct AVBSFContext {
5669 * A class for logging and AVOptions
5671 const AVClass *av_class;
5674 * The bitstream filter this context is an instance of.
5676 const struct AVBitStreamFilter *filter;
5679 * Opaque libavcodec internal data. Must not be touched by the caller in any
5682 AVBSFInternal *internal;
5685 * Opaque filter-specific private data. If filter->priv_class is non-NULL,
5686 * this is an AVOptions-enabled struct.
5691 * Parameters of the input stream. Set by the caller before av_bsf_init().
5693 AVCodecParameters *par_in;
5696 * Parameters of the output stream. Set by the filter in av_bsf_init().
5698 AVCodecParameters *par_out;
5701 * The timebase used for the timestamps of the input packets. Set by the
5702 * caller before av_bsf_init().
5704 AVRational time_base_in;
5707 * The timebase used for the timestamps of the output packets. Set by the
5708 * filter in av_bsf_init().
5710 AVRational time_base_out;
5713 typedef struct AVBitStreamFilter {
5717 * A list of codec ids supported by the filter, terminated by
5719 * May be NULL, in that case the bitstream filter works with any codec id.
5721 const enum AVCodecID *codec_ids;
5724 * A class for the private data, used to declare bitstream filter private
5725 * AVOptions. This field is NULL for bitstream filters that do not declare
5728 * If this field is non-NULL, the first member of the filter private data
5729 * must be a pointer to AVClass, which will be set by libavcodec generic
5730 * code to this class.
5732 const AVClass *priv_class;
5734 /*****************************************************************
5735 * No fields below this line are part of the public API. They
5736 * may not be used outside of libavcodec and can be changed and
5738 * New public fields should be added right above.
5739 *****************************************************************
5743 int (*init)(AVBSFContext *ctx);
5744 int (*filter)(AVBSFContext *ctx, AVPacket *pkt);
5745 void (*close)(AVBSFContext *ctx);
5746 } AVBitStreamFilter;
5750 * Register a bitstream filter.
5752 * The filter will be accessible to the application code through
5753 * av_bitstream_filter_next() or can be directly initialized with
5754 * av_bitstream_filter_init().
5756 * @see avcodec_register_all()
5758 attribute_deprecated
5759 void av_register_bitstream_filter(AVBitStreamFilter *bsf);
5762 * Create and initialize a bitstream filter context given a bitstream
5765 * The returned context must be freed with av_bitstream_filter_close().
5767 * @param name the name of the bitstream filter
5768 * @return a bitstream filter context if a matching filter was found
5769 * and successfully initialized, NULL otherwise
5771 attribute_deprecated
5772 AVBitStreamFilterContext *av_bitstream_filter_init(const char *name);
5777 * This function filters the buffer buf with size buf_size, and places the
5778 * filtered buffer in the buffer pointed to by poutbuf.
5780 * The output buffer must be freed by the caller.
5782 * @param bsfc bitstream filter context created by av_bitstream_filter_init()
5783 * @param avctx AVCodecContext accessed by the filter, may be NULL.
5784 * If specified, this must point to the encoder context of the
5785 * output stream the packet is sent to.
5786 * @param args arguments which specify the filter configuration, may be NULL
5787 * @param poutbuf pointer which is updated to point to the filtered buffer
5788 * @param poutbuf_size pointer which is updated to the filtered buffer size in bytes
5789 * @param buf buffer containing the data to filter
5790 * @param buf_size size in bytes of buf
5791 * @param keyframe set to non-zero if the buffer to filter corresponds to a key-frame packet data
5792 * @return >= 0 in case of success, or a negative error code in case of failure
5794 * If the return value is positive, an output buffer is allocated and
5795 * is available in *poutbuf, and is distinct from the input buffer.
5797 * If the return value is 0, the output buffer is not allocated and
5798 * should be considered identical to the input buffer, or in case
5799 * *poutbuf was set it points to the input buffer (not necessarily to
5800 * its starting address). A special case is if *poutbuf was set to NULL and
5801 * *poutbuf_size was set to 0, which indicates the packet should be dropped.
5803 attribute_deprecated
5804 int av_bitstream_filter_filter(AVBitStreamFilterContext *bsfc,
5805 AVCodecContext *avctx, const char *args,
5806 uint8_t **poutbuf, int *poutbuf_size,
5807 const uint8_t *buf, int buf_size, int keyframe);
5810 * Release bitstream filter context.
5812 * @param bsf the bitstream filter context created with
5813 * av_bitstream_filter_init(), can be NULL
5815 attribute_deprecated
5816 void av_bitstream_filter_close(AVBitStreamFilterContext *bsf);
5819 * If f is NULL, return the first registered bitstream filter,
5820 * if f is non-NULL, return the next registered bitstream filter
5821 * after f, or NULL if f is the last one.
5823 * This function can be used to iterate over all registered bitstream
5826 attribute_deprecated
5827 AVBitStreamFilter *av_bitstream_filter_next(const AVBitStreamFilter *f);
5831 * @return a bitstream filter with the specified name or NULL if no such
5832 * bitstream filter exists.
5834 const AVBitStreamFilter *av_bsf_get_by_name(const char *name);
5837 * Iterate over all registered bitstream filters.
5839 * @param opaque a pointer where libavcodec will store the iteration state. Must
5840 * point to NULL to start the iteration.
5842 * @return the next registered bitstream filter or NULL when the iteration is
5845 const AVBitStreamFilter *av_bsf_next(void **opaque);
5848 * Allocate a context for a given bitstream filter. The caller must fill in the
5849 * context parameters as described in the documentation and then call
5850 * av_bsf_init() before sending any data to the filter.
5852 * @param filter the filter for which to allocate an instance.
5853 * @param ctx a pointer into which the pointer to the newly-allocated context
5854 * will be written. It must be freed with av_bsf_free() after the
5855 * filtering is done.
5857 * @return 0 on success, a negative AVERROR code on failure
5859 int av_bsf_alloc(const AVBitStreamFilter *filter, AVBSFContext **ctx);
5862 * Prepare the filter for use, after all the parameters and options have been
5865 int av_bsf_init(AVBSFContext *ctx);
5868 * Submit a packet for filtering.
5870 * After sending each packet, the filter must be completely drained by calling
5871 * av_bsf_receive_packet() repeatedly until it returns AVERROR(EAGAIN) or
5874 * @param pkt the packet to filter. The bitstream filter will take ownership of
5875 * the packet and reset the contents of pkt. pkt is not touched if an error occurs.
5876 * This parameter may be NULL, which signals the end of the stream (i.e. no more
5877 * packets will be sent). That will cause the filter to output any packets it
5878 * may have buffered internally.
5880 * @return 0 on success, a negative AVERROR on error.
5882 int av_bsf_send_packet(AVBSFContext *ctx, AVPacket *pkt);
5885 * Retrieve a filtered packet.
5887 * @param[out] pkt this struct will be filled with the contents of the filtered
5888 * packet. It is owned by the caller and must be freed using
5889 * av_packet_unref() when it is no longer needed.
5890 * This parameter should be "clean" (i.e. freshly allocated
5891 * with av_packet_alloc() or unreffed with av_packet_unref())
5892 * when this function is called. If this function returns
5893 * successfully, the contents of pkt will be completely
5894 * overwritten by the returned data. On failure, pkt is not
5897 * @return 0 on success. AVERROR(EAGAIN) if more packets need to be sent to the
5898 * filter (using av_bsf_send_packet()) to get more output. AVERROR_EOF if there
5899 * will be no further output from the filter. Another negative AVERROR value if
5902 * @note one input packet may result in several output packets, so after sending
5903 * a packet with av_bsf_send_packet(), this function needs to be called
5904 * repeatedly until it stops returning 0. It is also possible for a filter to
5905 * output fewer packets than were sent to it, so this function may return
5906 * AVERROR(EAGAIN) immediately after a successful av_bsf_send_packet() call.
5908 int av_bsf_receive_packet(AVBSFContext *ctx, AVPacket *pkt);
5911 * Free a bitstream filter context and everything associated with it; write NULL
5912 * into the supplied pointer.
5914 void av_bsf_free(AVBSFContext **ctx);
5917 * Get the AVClass for AVBSFContext. It can be used in combination with
5918 * AV_OPT_SEARCH_FAKE_OBJ for examining options.
5920 * @see av_opt_find().
5922 const AVClass *av_bsf_get_class(void);
5927 * Same behaviour av_fast_malloc but the buffer has additional
5928 * AV_INPUT_BUFFER_PADDING_SIZE at the end which will always be 0.
5930 * In addition the whole buffer will initially and after resizes
5931 * be 0-initialized so that no uninitialized data will ever appear.
5933 void av_fast_padded_malloc(void *ptr, unsigned int *size, size_t min_size);
5936 * Same behaviour av_fast_padded_malloc except that buffer will always
5937 * be 0-initialized after call.
5939 void av_fast_padded_mallocz(void *ptr, unsigned int *size, size_t min_size);
5942 * Encode extradata length to a buffer. Used by xiph codecs.
5944 * @param s buffer to write to; must be at least (v/255+1) bytes long
5945 * @param v size of extradata in bytes
5946 * @return number of bytes written to the buffer.
5948 unsigned int av_xiphlacing(unsigned char *s, unsigned int v);
5950 #if FF_API_MISSING_SAMPLE
5952 * Log a generic warning message about a missing feature. This function is
5953 * intended to be used internally by FFmpeg (libavcodec, libavformat, etc.)
5954 * only, and would normally not be used by applications.
5955 * @param[in] avc a pointer to an arbitrary struct of which the first field is
5956 * a pointer to an AVClass struct
5957 * @param[in] feature string containing the name of the missing feature
5958 * @param[in] want_sample indicates if samples are wanted which exhibit this feature.
5959 * If want_sample is non-zero, additional verbiage will be added to the log
5960 * message which tells the user how to report samples to the development
5962 * @deprecated Use avpriv_report_missing_feature() instead.
5964 attribute_deprecated
5965 void av_log_missing_feature(void *avc, const char *feature, int want_sample);
5968 * Log a generic warning message asking for a sample. This function is
5969 * intended to be used internally by FFmpeg (libavcodec, libavformat, etc.)
5970 * only, and would normally not be used by applications.
5971 * @param[in] avc a pointer to an arbitrary struct of which the first field is
5972 * a pointer to an AVClass struct
5973 * @param[in] msg string containing an optional message, or NULL if no message
5974 * @deprecated Use avpriv_request_sample() instead.
5976 attribute_deprecated
5977 void av_log_ask_for_sample(void *avc, const char *msg, ...) av_printf_format(2, 3);
5978 #endif /* FF_API_MISSING_SAMPLE */
5981 * Register the hardware accelerator hwaccel.
5983 void av_register_hwaccel(AVHWAccel *hwaccel);
5986 * If hwaccel is NULL, returns the first registered hardware accelerator,
5987 * if hwaccel is non-NULL, returns the next registered hardware accelerator
5988 * after hwaccel, or NULL if hwaccel is the last one.
5990 AVHWAccel *av_hwaccel_next(const AVHWAccel *hwaccel);
5994 * Lock operation used by lockmgr
5997 AV_LOCK_CREATE, ///< Create a mutex
5998 AV_LOCK_OBTAIN, ///< Lock the mutex
5999 AV_LOCK_RELEASE, ///< Unlock the mutex
6000 AV_LOCK_DESTROY, ///< Free mutex resources
6004 * Register a user provided lock manager supporting the operations
6005 * specified by AVLockOp. The "mutex" argument to the function points
6006 * to a (void *) where the lockmgr should store/get a pointer to a user
6007 * allocated mutex. It is NULL upon AV_LOCK_CREATE and equal to the
6008 * value left by the last call for all other ops. If the lock manager is
6009 * unable to perform the op then it should leave the mutex in the same
6010 * state as when it was called and return a non-zero value. However,
6011 * when called with AV_LOCK_DESTROY the mutex will always be assumed to
6012 * have been successfully destroyed. If av_lockmgr_register succeeds
6013 * it will return a non-negative value, if it fails it will return a
6014 * negative value and destroy all mutex and unregister all callbacks.
6015 * av_lockmgr_register is not thread-safe, it must be called from a
6016 * single thread before any calls which make use of locking are used.
6018 * @param cb User defined callback. av_lockmgr_register invokes calls
6019 * to this callback and the previously registered callback.
6020 * The callback will be used to create more than one mutex
6021 * each of which must be backed by its own underlying locking
6022 * mechanism (i.e. do not use a single static object to
6023 * implement your lock manager). If cb is set to NULL the
6024 * lockmgr will be unregistered.
6026 int av_lockmgr_register(int (*cb)(void **mutex, enum AVLockOp op));
6029 * Get the type of the given codec.
6031 enum AVMediaType avcodec_get_type(enum AVCodecID codec_id);
6034 * Get the name of a codec.
6035 * @return a static string identifying the codec; never NULL
6037 const char *avcodec_get_name(enum AVCodecID id);
6040 * @return a positive value if s is open (i.e. avcodec_open2() was called on it
6041 * with no corresponding avcodec_close()), 0 otherwise.
6043 int avcodec_is_open(AVCodecContext *s);
6046 * @return a non-zero number if codec is an encoder, zero otherwise
6048 int av_codec_is_encoder(const AVCodec *codec);
6051 * @return a non-zero number if codec is a decoder, zero otherwise
6053 int av_codec_is_decoder(const AVCodec *codec);
6056 * @return descriptor for given codec ID or NULL if no descriptor exists.
6058 const AVCodecDescriptor *avcodec_descriptor_get(enum AVCodecID id);
6061 * Iterate over all codec descriptors known to libavcodec.
6063 * @param prev previous descriptor. NULL to get the first descriptor.
6065 * @return next descriptor or NULL after the last descriptor
6067 const AVCodecDescriptor *avcodec_descriptor_next(const AVCodecDescriptor *prev);
6070 * @return codec descriptor with the given name or NULL if no such descriptor
6073 const AVCodecDescriptor *avcodec_descriptor_get_by_name(const char *name);
6076 * Allocate a CPB properties structure and initialize its fields to default
6079 * @param size if non-NULL, the size of the allocated struct will be written
6080 * here. This is useful for embedding it in side data.
6082 * @return the newly allocated struct or NULL on failure
6084 AVCPBProperties *av_cpb_properties_alloc(size_t *size);
6090 #endif /* AVCODEC_AVCODEC_H */