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 libavcodec
47 * Encoding/Decoding Library
51 * @defgroup lavc_decoding Decoding
55 * @defgroup lavc_encoding Encoding
59 * @defgroup lavc_codec Codecs
61 * @defgroup lavc_codec_native Native Codecs
64 * @defgroup lavc_codec_wrappers External library wrappers
67 * @defgroup lavc_codec_hwaccel Hardware Accelerators bridge
71 * @defgroup lavc_internal Internal
79 * @defgroup lavc_encdec send/receive encoding and decoding API overview
82 * The avcodec_send_packet()/avcodec_receive_frame()/avcodec_send_frame()/
83 * avcodec_receive_packet() functions provide an encode/decode API, which
84 * decouples input and output.
86 * The API is very similar for encoding/decoding and audio/video, and works as
88 * - Set up and open the AVCodecContext as usual.
90 * - For decoding, call avcodec_send_packet() to give the decoder raw
91 * compressed data in an AVPacket.
92 * - For encoding, call avcodec_send_frame() to give the encoder an AVFrame
93 * containing uncompressed audio or video.
94 * In both cases, it is recommended that AVPackets and AVFrames are
95 * refcounted, or libavcodec might have to copy the input data. (libavformat
96 * always returns refcounted AVPackets, and av_frame_get_buffer() allocates
97 * refcounted AVFrames.)
98 * - Receive output in a loop. Periodically call one of the avcodec_receive_*()
99 * functions and process their output:
100 * - For decoding, call avcodec_receive_frame(). On success, it will return
101 * an AVFrame containing uncompressed audio or video data.
102 * - For encoding, call avcodec_receive_packet(). On success, it will return
103 * an AVPacket with a compressed frame.
104 * Repeat this call until it returns AVERROR(EAGAIN) or an error. The
105 * AVERROR(EAGAIN) return value means that new input data is required to
106 * return new output. In this case, continue with sending input. For each
107 * input frame/packet, the codec will typically return 1 output frame/packet,
108 * but it can also be 0 or more than 1.
110 * At the beginning of decoding or encoding, the codec might accept multiple
111 * input frames/packets without returning a frame, until its internal buffers
112 * are filled. This situation is handled transparently if you follow the steps
115 * In theory, sending input can result in EAGAIN - this should happen only if
116 * not all output was received. You can use this to structure alternative decode
117 * or encode loops other than the one suggested above. For example, you could
118 * try sending new input on each iteration, and try to receive output if that
121 * End of stream situations. These require "flushing" (aka draining) the codec,
122 * as the codec might buffer multiple frames or packets internally for
123 * performance or out of necessity (consider B-frames).
124 * This is handled as follows:
125 * - Instead of valid input, send NULL to the avcodec_send_packet() (decoding)
126 * or avcodec_send_frame() (encoding) functions. This will enter draining
128 * - Call avcodec_receive_frame() (decoding) or avcodec_receive_packet()
129 * (encoding) in a loop until AVERROR_EOF is returned. The functions will
130 * not return AVERROR(EAGAIN), unless you forgot to enter draining mode.
131 * - Before decoding can be resumed again, the codec has to be reset with
132 * avcodec_flush_buffers().
134 * Using the API as outlined above is highly recommended. But it is also
135 * possible to call functions outside of this rigid schema. For example, you can
136 * call avcodec_send_packet() repeatedly without calling
137 * avcodec_receive_frame(). In this case, avcodec_send_packet() will succeed
138 * until the codec's internal buffer has been filled up (which is typically of
139 * size 1 per output frame, after initial input), and then reject input with
140 * AVERROR(EAGAIN). Once it starts rejecting input, you have no choice but to
141 * read at least some output.
143 * Not all codecs will follow a rigid and predictable dataflow; the only
144 * guarantee is that an AVERROR(EAGAIN) return value on a send/receive call on
145 * one end implies that a receive/send call on the other end will succeed, or
146 * at least will not fail with AVERROR(EAGAIN). In general, no codec will
147 * permit unlimited buffering of input or output.
149 * This API replaces the following legacy functions:
150 * - avcodec_decode_video2() and avcodec_decode_audio4():
151 * Use avcodec_send_packet() to feed input to the decoder, then use
152 * avcodec_receive_frame() to receive decoded frames after each packet.
153 * Unlike with the old video decoding API, multiple frames might result from
154 * a packet. For audio, splitting the input packet into frames by partially
155 * decoding packets becomes transparent to the API user. You never need to
156 * feed an AVPacket to the API twice (unless it is rejected with AVERROR(EAGAIN) - then
157 * no data was read from the packet).
158 * Additionally, sending a flush/draining packet is required only once.
159 * - avcodec_encode_video2()/avcodec_encode_audio2():
160 * Use avcodec_send_frame() to feed input to the encoder, then use
161 * avcodec_receive_packet() to receive encoded packets.
162 * Providing user-allocated buffers for avcodec_receive_packet() is not
164 * - The new API does not handle subtitles yet.
166 * Mixing new and old function calls on the same AVCodecContext is not allowed,
167 * and will result in undefined behavior.
169 * Some codecs might require using the new API; using the old API will return
170 * an error when calling it. All codecs support the new API.
172 * A codec is not allowed to return AVERROR(EAGAIN) for both sending and receiving. This
173 * would be an invalid state, which could put the codec user into an endless
174 * loop. The API has no concept of time either: it cannot happen that trying to
175 * do avcodec_send_packet() results in AVERROR(EAGAIN), but a repeated call 1 second
176 * later accepts the packet (with no other receive/flush API calls involved).
177 * The API is a strict state machine, and the passage of time is not supposed
178 * to influence it. Some timing-dependent behavior might still be deemed
179 * acceptable in certain cases. But it must never result in both send/receive
180 * returning EAGAIN at the same time at any point. It must also absolutely be
181 * avoided that the current state is "unstable" and can "flip-flop" between
182 * the send/receive APIs allowing progress. For example, it's not allowed that
183 * the codec randomly decides that it actually wants to consume a packet now
184 * instead of returning a frame, after it just returned AVERROR(EAGAIN) on an
185 * avcodec_send_packet() call.
190 * @defgroup lavc_core Core functions/structures.
193 * Basic definitions, functions for querying libavcodec capabilities,
194 * allocating core structures, etc.
200 * Identify the syntax and semantics of the bitstream.
201 * The principle is roughly:
202 * Two decoders with the same ID can decode the same streams.
203 * Two encoders with the same ID can encode compatible streams.
204 * There may be slight deviations from the principle due to implementation
207 * If you add a codec ID to this list, add it so that
208 * 1. no value of an existing codec ID changes (that would break ABI),
209 * 2. it is as close as possible to similar codecs
211 * After adding new codec IDs, do not forget to add an entry to the codec
212 * descriptor list and bump libavcodec minor version.
218 AV_CODEC_ID_MPEG1VIDEO,
219 AV_CODEC_ID_MPEG2VIDEO, ///< preferred ID for MPEG-1/2 video decoding
221 AV_CODEC_ID_MPEG2VIDEO_XVMC,
222 #endif /* FF_API_XVMC */
233 AV_CODEC_ID_RAWVIDEO,
234 AV_CODEC_ID_MSMPEG4V1,
235 AV_CODEC_ID_MSMPEG4V2,
236 AV_CODEC_ID_MSMPEG4V3,
259 AV_CODEC_ID_INTERPLAY_VIDEO,
266 AV_CODEC_ID_MSVIDEO1,
271 AV_CODEC_ID_TRUEMOTION1,
272 AV_CODEC_ID_VMDVIDEO,
297 AV_CODEC_ID_TRUEMOTION2,
303 AV_CODEC_ID_SMACKVIDEO,
308 AV_CODEC_ID_JPEG2000,
314 AV_CODEC_ID_DSICINVIDEO,
315 AV_CODEC_ID_TIERTEXSEQVIDEO,
323 AV_CODEC_ID_BETHSOFTVID,
335 AV_CODEC_ID_ESCAPE124,
339 AV_CODEC_ID_MOTIONPIXELS,
351 AV_CODEC_ID_FLASHSV2,
352 AV_CODEC_ID_CDGRAPHICS,
355 AV_CODEC_ID_BINKVIDEO,
356 AV_CODEC_ID_IFF_ILBM,
357 #define AV_CODEC_ID_IFF_BYTERUN1 AV_CODEC_ID_IFF_ILBM
363 AV_CODEC_ID_A64_MULTI,
364 AV_CODEC_ID_A64_MULTI5,
367 AV_CODEC_ID_LAGARITH,
371 AV_CODEC_ID_WMV3IMAGE,
372 AV_CODEC_ID_VC1IMAGE,
374 AV_CODEC_ID_BMV_VIDEO,
381 AV_CODEC_ID_ZEROCODEC,
390 AV_CODEC_ID_ESCAPE130,
393 AV_CODEC_ID_HNM4_VIDEO,
395 #define AV_CODEC_ID_H265 AV_CODEC_ID_HEVC
397 AV_CODEC_ID_ALIAS_PIX,
398 AV_CODEC_ID_BRENDER_PIX,
399 AV_CODEC_ID_PAF_VIDEO,
412 AV_CODEC_ID_SCREENPRESSO,
415 AV_CODEC_ID_Y41P = 0x8000,
420 AV_CODEC_ID_TARGA_Y216,
432 AV_CODEC_ID_TRUEMOTION2RT,
434 AV_CODEC_ID_MAGICYUV,
435 AV_CODEC_ID_SHEERVIDEO,
442 AV_CODEC_ID_CLEARVIDEO,
445 AV_CODEC_ID_BITPACKED,
451 /* various PCM "codecs" */
452 AV_CODEC_ID_FIRST_AUDIO = 0x10000, ///< A dummy id pointing at the start of audio codecs
453 AV_CODEC_ID_PCM_S16LE = 0x10000,
454 AV_CODEC_ID_PCM_S16BE,
455 AV_CODEC_ID_PCM_U16LE,
456 AV_CODEC_ID_PCM_U16BE,
459 AV_CODEC_ID_PCM_MULAW,
460 AV_CODEC_ID_PCM_ALAW,
461 AV_CODEC_ID_PCM_S32LE,
462 AV_CODEC_ID_PCM_S32BE,
463 AV_CODEC_ID_PCM_U32LE,
464 AV_CODEC_ID_PCM_U32BE,
465 AV_CODEC_ID_PCM_S24LE,
466 AV_CODEC_ID_PCM_S24BE,
467 AV_CODEC_ID_PCM_U24LE,
468 AV_CODEC_ID_PCM_U24BE,
469 AV_CODEC_ID_PCM_S24DAUD,
470 AV_CODEC_ID_PCM_ZORK,
471 AV_CODEC_ID_PCM_S16LE_PLANAR,
473 AV_CODEC_ID_PCM_F32BE,
474 AV_CODEC_ID_PCM_F32LE,
475 AV_CODEC_ID_PCM_F64BE,
476 AV_CODEC_ID_PCM_F64LE,
477 AV_CODEC_ID_PCM_BLURAY,
480 AV_CODEC_ID_PCM_S8_PLANAR,
481 AV_CODEC_ID_PCM_S24LE_PLANAR,
482 AV_CODEC_ID_PCM_S32LE_PLANAR,
483 AV_CODEC_ID_PCM_S16BE_PLANAR,
485 AV_CODEC_ID_PCM_S64LE = 0x10800,
486 AV_CODEC_ID_PCM_S64BE,
487 AV_CODEC_ID_PCM_F16LE,
488 AV_CODEC_ID_PCM_F24LE,
490 /* various ADPCM codecs */
491 AV_CODEC_ID_ADPCM_IMA_QT = 0x11000,
492 AV_CODEC_ID_ADPCM_IMA_WAV,
493 AV_CODEC_ID_ADPCM_IMA_DK3,
494 AV_CODEC_ID_ADPCM_IMA_DK4,
495 AV_CODEC_ID_ADPCM_IMA_WS,
496 AV_CODEC_ID_ADPCM_IMA_SMJPEG,
497 AV_CODEC_ID_ADPCM_MS,
498 AV_CODEC_ID_ADPCM_4XM,
499 AV_CODEC_ID_ADPCM_XA,
500 AV_CODEC_ID_ADPCM_ADX,
501 AV_CODEC_ID_ADPCM_EA,
502 AV_CODEC_ID_ADPCM_G726,
503 AV_CODEC_ID_ADPCM_CT,
504 AV_CODEC_ID_ADPCM_SWF,
505 AV_CODEC_ID_ADPCM_YAMAHA,
506 AV_CODEC_ID_ADPCM_SBPRO_4,
507 AV_CODEC_ID_ADPCM_SBPRO_3,
508 AV_CODEC_ID_ADPCM_SBPRO_2,
509 AV_CODEC_ID_ADPCM_THP,
510 AV_CODEC_ID_ADPCM_IMA_AMV,
511 AV_CODEC_ID_ADPCM_EA_R1,
512 AV_CODEC_ID_ADPCM_EA_R3,
513 AV_CODEC_ID_ADPCM_EA_R2,
514 AV_CODEC_ID_ADPCM_IMA_EA_SEAD,
515 AV_CODEC_ID_ADPCM_IMA_EA_EACS,
516 AV_CODEC_ID_ADPCM_EA_XAS,
517 AV_CODEC_ID_ADPCM_EA_MAXIS_XA,
518 AV_CODEC_ID_ADPCM_IMA_ISS,
519 AV_CODEC_ID_ADPCM_G722,
520 AV_CODEC_ID_ADPCM_IMA_APC,
521 AV_CODEC_ID_ADPCM_VIMA,
522 #if FF_API_VIMA_DECODER
523 AV_CODEC_ID_VIMA = AV_CODEC_ID_ADPCM_VIMA,
526 AV_CODEC_ID_ADPCM_AFC = 0x11800,
527 AV_CODEC_ID_ADPCM_IMA_OKI,
528 AV_CODEC_ID_ADPCM_DTK,
529 AV_CODEC_ID_ADPCM_IMA_RAD,
530 AV_CODEC_ID_ADPCM_G726LE,
531 AV_CODEC_ID_ADPCM_THP_LE,
532 AV_CODEC_ID_ADPCM_PSX,
533 AV_CODEC_ID_ADPCM_AICA,
534 AV_CODEC_ID_ADPCM_IMA_DAT4,
535 AV_CODEC_ID_ADPCM_MTAF,
538 AV_CODEC_ID_AMR_NB = 0x12000,
541 /* RealAudio codecs*/
542 AV_CODEC_ID_RA_144 = 0x13000,
545 /* various DPCM codecs */
546 AV_CODEC_ID_ROQ_DPCM = 0x14000,
547 AV_CODEC_ID_INTERPLAY_DPCM,
548 AV_CODEC_ID_XAN_DPCM,
549 AV_CODEC_ID_SOL_DPCM,
551 AV_CODEC_ID_SDX2_DPCM = 0x14800,
552 AV_CODEC_ID_GREMLIN_DPCM,
555 AV_CODEC_ID_MP2 = 0x15000,
556 AV_CODEC_ID_MP3, ///< preferred ID for decoding MPEG audio layer 1, 2 or 3
566 AV_CODEC_ID_VMDAUDIO,
572 AV_CODEC_ID_WESTWOOD_SND1,
573 AV_CODEC_ID_GSM, ///< as in Berlin toast format
576 AV_CODEC_ID_TRUESPEECH,
578 AV_CODEC_ID_SMACKAUDIO,
581 AV_CODEC_ID_DSICINAUDIO,
583 AV_CODEC_ID_MUSEPACK7,
585 AV_CODEC_ID_GSM_MS, /* as found in WAV */
591 AV_CODEC_ID_NELLYMOSER,
592 AV_CODEC_ID_MUSEPACK8,
594 AV_CODEC_ID_WMAVOICE,
596 AV_CODEC_ID_WMALOSSLESS,
605 AV_CODEC_ID_BINKAUDIO_RDFT,
606 AV_CODEC_ID_BINKAUDIO_DCT,
607 AV_CODEC_ID_AAC_LATM,
612 AV_CODEC_ID_8SVX_EXP,
613 AV_CODEC_ID_8SVX_FIB,
614 AV_CODEC_ID_BMV_AUDIO,
619 AV_CODEC_ID_COMFORT_NOISE,
621 AV_CODEC_ID_METASOUND,
622 AV_CODEC_ID_PAF_AUDIO,
626 AV_CODEC_ID_FFWAVESYNTH = 0x15800,
628 AV_CODEC_ID_SONIC_LS,
631 AV_CODEC_ID_DSD_LSBF,
632 AV_CODEC_ID_DSD_MSBF,
633 AV_CODEC_ID_DSD_LSBF_PLANAR,
634 AV_CODEC_ID_DSD_MSBF_PLANAR,
636 AV_CODEC_ID_INTERPLAY_ACM,
640 AV_CODEC_ID_ATRAC3AL,
641 AV_CODEC_ID_ATRAC3PAL,
643 /* subtitle codecs */
644 AV_CODEC_ID_FIRST_SUBTITLE = 0x17000, ///< A dummy ID pointing at the start of subtitle codecs.
645 AV_CODEC_ID_DVD_SUBTITLE = 0x17000,
646 AV_CODEC_ID_DVB_SUBTITLE,
647 AV_CODEC_ID_TEXT, ///< raw UTF-8 text
650 AV_CODEC_ID_MOV_TEXT,
651 AV_CODEC_ID_HDMV_PGS_SUBTITLE,
652 AV_CODEC_ID_DVB_TELETEXT,
655 AV_CODEC_ID_MICRODVD = 0x17800,
659 AV_CODEC_ID_REALTEXT,
661 AV_CODEC_ID_SUBVIEWER1,
662 AV_CODEC_ID_SUBVIEWER,
669 AV_CODEC_ID_HDMV_TEXT_SUBTITLE,
671 /* other specific kind of codecs (generally used for attachments) */
672 AV_CODEC_ID_FIRST_UNKNOWN = 0x18000, ///< A dummy ID pointing at the start of various fake codecs.
673 AV_CODEC_ID_TTF = 0x18000,
675 AV_CODEC_ID_SCTE_35, ///< Contain timestamp estimated through PCR of program stream.
676 AV_CODEC_ID_BINTEXT = 0x18800,
680 AV_CODEC_ID_SMPTE_KLV,
682 AV_CODEC_ID_TIMED_ID3,
683 AV_CODEC_ID_BIN_DATA,
686 AV_CODEC_ID_PROBE = 0x19000, ///< codec_id is not known (like AV_CODEC_ID_NONE) but lavf should attempt to identify it
688 AV_CODEC_ID_MPEG2TS = 0x20000, /**< _FAKE_ codec to indicate a raw MPEG-2 TS
689 * stream (only used by libavformat) */
690 AV_CODEC_ID_MPEG4SYSTEMS = 0x20001, /**< _FAKE_ codec to indicate a MPEG-4 Systems
691 * stream (only used by libavformat) */
692 AV_CODEC_ID_FFMETADATA = 0x21000, ///< Dummy codec for streams containing only metadata information.
693 AV_CODEC_ID_WRAPPED_AVFRAME = 0x21001, ///< Passthrough codec, AVFrames wrapped in AVPacket
697 * This struct describes the properties of a single codec described by an
699 * @see avcodec_descriptor_get()
701 typedef struct AVCodecDescriptor {
703 enum AVMediaType type;
705 * Name of the codec described by this descriptor. It is non-empty and
706 * unique for each codec descriptor. It should contain alphanumeric
707 * characters and '_' only.
711 * A more descriptive name for this codec. May be NULL.
713 const char *long_name;
715 * Codec properties, a combination of AV_CODEC_PROP_* flags.
719 * MIME type(s) associated with the codec.
720 * May be NULL; if not, a NULL-terminated array of MIME types.
721 * The first item is always non-NULL and is the preferred MIME type.
723 const char *const *mime_types;
725 * If non-NULL, an array of profiles recognized for this codec.
726 * Terminated with FF_PROFILE_UNKNOWN.
728 const struct AVProfile *profiles;
732 * Codec uses only intra compression.
733 * Video and audio codecs only.
735 #define AV_CODEC_PROP_INTRA_ONLY (1 << 0)
737 * Codec supports lossy compression. Audio and video codecs only.
738 * @note a codec may support both lossy and lossless
741 #define AV_CODEC_PROP_LOSSY (1 << 1)
743 * Codec supports lossless compression. Audio and video codecs only.
745 #define AV_CODEC_PROP_LOSSLESS (1 << 2)
747 * Codec supports frame reordering. That is, the coded order (the order in which
748 * the encoded packets are output by the encoders / stored / input to the
749 * decoders) may be different from the presentation order of the corresponding
752 * For codecs that do not have this property set, PTS and DTS should always be
755 #define AV_CODEC_PROP_REORDER (1 << 3)
757 * Subtitle codec is bitmap based
758 * Decoded AVSubtitle data can be read from the AVSubtitleRect->pict field.
760 #define AV_CODEC_PROP_BITMAP_SUB (1 << 16)
762 * Subtitle codec is text based.
763 * Decoded AVSubtitle data can be read from the AVSubtitleRect->ass field.
765 #define AV_CODEC_PROP_TEXT_SUB (1 << 17)
768 * @ingroup lavc_decoding
769 * Required number of additionally allocated bytes at the end of the input bitstream for decoding.
770 * This is mainly needed because some optimized bitstream readers read
771 * 32 or 64 bit at once and could read over the end.<br>
772 * Note: If the first 23 bits of the additional bytes are not 0, then damaged
773 * MPEG bitstreams could cause overread and segfault.
775 #define AV_INPUT_BUFFER_PADDING_SIZE 32
778 * @ingroup lavc_encoding
779 * minimum encoding buffer size
780 * Used to avoid some checks during header writing.
782 #define AV_INPUT_BUFFER_MIN_SIZE 16384
784 #if FF_API_WITHOUT_PREFIX
786 * @deprecated use AV_INPUT_BUFFER_PADDING_SIZE instead
788 #define FF_INPUT_BUFFER_PADDING_SIZE 32
791 * @deprecated use AV_INPUT_BUFFER_MIN_SIZE instead
793 #define FF_MIN_BUFFER_SIZE 16384
794 #endif /* FF_API_WITHOUT_PREFIX */
797 * @ingroup lavc_encoding
798 * motion estimation type.
799 * @deprecated use codec private option instead
801 #if FF_API_MOTION_EST
803 ME_ZERO = 1, ///< no search, that is use 0,0 vector whenever one is needed
807 ME_EPZS, ///< enhanced predictive zonal search
808 ME_X1, ///< reserved for experiments
809 ME_HEX, ///< hexagon based search
810 ME_UMH, ///< uneven multi-hexagon search
811 ME_TESA, ///< transformed exhaustive search algorithm
812 ME_ITER=50, ///< iterative search
817 * @ingroup lavc_decoding
820 /* We leave some space between them for extensions (drop some
821 * keyframes for intra-only or drop just some bidir frames). */
822 AVDISCARD_NONE =-16, ///< discard nothing
823 AVDISCARD_DEFAULT = 0, ///< discard useless packets like 0 size packets in avi
824 AVDISCARD_NONREF = 8, ///< discard all non reference
825 AVDISCARD_BIDIR = 16, ///< discard all bidirectional frames
826 AVDISCARD_NONINTRA= 24, ///< discard all non intra frames
827 AVDISCARD_NONKEY = 32, ///< discard all frames except keyframes
828 AVDISCARD_ALL = 48, ///< discard all
831 enum AVAudioServiceType {
832 AV_AUDIO_SERVICE_TYPE_MAIN = 0,
833 AV_AUDIO_SERVICE_TYPE_EFFECTS = 1,
834 AV_AUDIO_SERVICE_TYPE_VISUALLY_IMPAIRED = 2,
835 AV_AUDIO_SERVICE_TYPE_HEARING_IMPAIRED = 3,
836 AV_AUDIO_SERVICE_TYPE_DIALOGUE = 4,
837 AV_AUDIO_SERVICE_TYPE_COMMENTARY = 5,
838 AV_AUDIO_SERVICE_TYPE_EMERGENCY = 6,
839 AV_AUDIO_SERVICE_TYPE_VOICE_OVER = 7,
840 AV_AUDIO_SERVICE_TYPE_KARAOKE = 8,
841 AV_AUDIO_SERVICE_TYPE_NB , ///< Not part of ABI
845 * @ingroup lavc_encoding
847 typedef struct RcOverride{
850 int qscale; // If this is 0 then quality_factor will be used instead.
851 float quality_factor;
854 #if FF_API_MAX_BFRAMES
856 * @deprecated there is no libavcodec-wide limit on the number of B-frames
858 #define FF_MAX_B_FRAMES 16
862 These flags can be passed in AVCodecContext.flags before initialization.
863 Note: Not everything is supported yet.
867 * Allow decoders to produce frames with data planes that are not aligned
868 * to CPU requirements (e.g. due to cropping).
870 #define AV_CODEC_FLAG_UNALIGNED (1 << 0)
874 #define AV_CODEC_FLAG_QSCALE (1 << 1)
876 * 4 MV per MB allowed / advanced prediction for H.263.
878 #define AV_CODEC_FLAG_4MV (1 << 2)
880 * Output even those frames that might be corrupted.
882 #define AV_CODEC_FLAG_OUTPUT_CORRUPT (1 << 3)
886 #define AV_CODEC_FLAG_QPEL (1 << 4)
888 * Use internal 2pass ratecontrol in first pass mode.
890 #define AV_CODEC_FLAG_PASS1 (1 << 9)
892 * Use internal 2pass ratecontrol in second pass mode.
894 #define AV_CODEC_FLAG_PASS2 (1 << 10)
898 #define AV_CODEC_FLAG_LOOP_FILTER (1 << 11)
900 * Only decode/encode grayscale.
902 #define AV_CODEC_FLAG_GRAY (1 << 13)
904 * error[?] variables will be set during encoding.
906 #define AV_CODEC_FLAG_PSNR (1 << 15)
908 * Input bitstream might be truncated at a random location
909 * instead of only at frame boundaries.
911 #define AV_CODEC_FLAG_TRUNCATED (1 << 16)
913 * Use interlaced DCT.
915 #define AV_CODEC_FLAG_INTERLACED_DCT (1 << 18)
919 #define AV_CODEC_FLAG_LOW_DELAY (1 << 19)
921 * Place global headers in extradata instead of every keyframe.
923 #define AV_CODEC_FLAG_GLOBAL_HEADER (1 << 22)
925 * Use only bitexact stuff (except (I)DCT).
927 #define AV_CODEC_FLAG_BITEXACT (1 << 23)
928 /* Fx : Flag for H.263+ extra options */
930 * H.263 advanced intra coding / MPEG-4 AC prediction
932 #define AV_CODEC_FLAG_AC_PRED (1 << 24)
934 * interlaced motion estimation
936 #define AV_CODEC_FLAG_INTERLACED_ME (1 << 29)
937 #define AV_CODEC_FLAG_CLOSED_GOP (1U << 31)
940 * Allow non spec compliant speedup tricks.
942 #define AV_CODEC_FLAG2_FAST (1 << 0)
944 * Skip bitstream encoding.
946 #define AV_CODEC_FLAG2_NO_OUTPUT (1 << 2)
948 * Place global headers at every keyframe instead of in extradata.
950 #define AV_CODEC_FLAG2_LOCAL_HEADER (1 << 3)
953 * timecode is in drop frame format. DEPRECATED!!!!
955 #define AV_CODEC_FLAG2_DROP_FRAME_TIMECODE (1 << 13)
958 * Input bitstream might be truncated at a packet boundaries
959 * instead of only at frame boundaries.
961 #define AV_CODEC_FLAG2_CHUNKS (1 << 15)
963 * Discard cropping information from SPS.
965 #define AV_CODEC_FLAG2_IGNORE_CROP (1 << 16)
968 * Show all frames before the first keyframe
970 #define AV_CODEC_FLAG2_SHOW_ALL (1 << 22)
972 * Export motion vectors through frame side data
974 #define AV_CODEC_FLAG2_EXPORT_MVS (1 << 28)
976 * Do not skip samples and export skip information as frame side data
978 #define AV_CODEC_FLAG2_SKIP_MANUAL (1 << 29)
980 * Do not reset ASS ReadOrder field on flush (subtitles decoding)
982 #define AV_CODEC_FLAG2_RO_FLUSH_NOOP (1 << 30)
984 /* Unsupported options :
985 * Syntax Arithmetic coding (SAC)
986 * Reference Picture Selection
987 * Independent Segment Decoding */
989 /* codec capabilities */
992 * Decoder can use draw_horiz_band callback.
994 #define AV_CODEC_CAP_DRAW_HORIZ_BAND (1 << 0)
996 * Codec uses get_buffer() for allocating buffers and supports custom allocators.
997 * If not set, it might not use get_buffer() at all or use operations that
998 * assume the buffer was allocated by avcodec_default_get_buffer.
1000 #define AV_CODEC_CAP_DR1 (1 << 1)
1001 #define AV_CODEC_CAP_TRUNCATED (1 << 3)
1003 * Encoder or decoder requires flushing with NULL input at the end in order to
1004 * give the complete and correct output.
1006 * NOTE: If this flag is not set, the codec is guaranteed to never be fed with
1007 * with NULL data. The user can still send NULL data to the public encode
1008 * or decode function, but libavcodec will not pass it along to the codec
1009 * unless this flag is set.
1012 * The decoder has a non-zero delay and needs to be fed with avpkt->data=NULL,
1013 * avpkt->size=0 at the end to get the delayed data until the decoder no longer
1017 * The encoder needs to be fed with NULL data at the end of encoding until the
1018 * encoder no longer returns data.
1020 * NOTE: For encoders implementing the AVCodec.encode2() function, setting this
1021 * flag also means that the encoder must set the pts and duration for
1022 * each output packet. If this flag is not set, the pts and duration will
1023 * be determined by libavcodec from the input frame.
1025 #define AV_CODEC_CAP_DELAY (1 << 5)
1027 * Codec can be fed a final frame with a smaller size.
1028 * This can be used to prevent truncation of the last audio samples.
1030 #define AV_CODEC_CAP_SMALL_LAST_FRAME (1 << 6)
1032 #if FF_API_CAP_VDPAU
1034 * Codec can export data for HW decoding (VDPAU).
1036 #define AV_CODEC_CAP_HWACCEL_VDPAU (1 << 7)
1040 * Codec can output multiple frames per AVPacket
1041 * Normally demuxers return one frame at a time, demuxers which do not do
1042 * are connected to a parser to split what they return into proper frames.
1043 * This flag is reserved to the very rare category of codecs which have a
1044 * bitstream that cannot be split into frames without timeconsuming
1045 * operations like full decoding. Demuxers carrying such bitstreams thus
1046 * may return multiple frames in a packet. This has many disadvantages like
1047 * prohibiting stream copy in many cases thus it should only be considered
1050 #define AV_CODEC_CAP_SUBFRAMES (1 << 8)
1052 * Codec is experimental and is thus avoided in favor of non experimental
1055 #define AV_CODEC_CAP_EXPERIMENTAL (1 << 9)
1057 * Codec should fill in channel configuration and samplerate instead of container
1059 #define AV_CODEC_CAP_CHANNEL_CONF (1 << 10)
1061 * Codec supports frame-level multithreading.
1063 #define AV_CODEC_CAP_FRAME_THREADS (1 << 12)
1065 * Codec supports slice-based (or partition-based) multithreading.
1067 #define AV_CODEC_CAP_SLICE_THREADS (1 << 13)
1069 * Codec supports changed parameters at any point.
1071 #define AV_CODEC_CAP_PARAM_CHANGE (1 << 14)
1073 * Codec supports avctx->thread_count == 0 (auto).
1075 #define AV_CODEC_CAP_AUTO_THREADS (1 << 15)
1077 * Audio encoder supports receiving a different number of samples in each call.
1079 #define AV_CODEC_CAP_VARIABLE_FRAME_SIZE (1 << 16)
1081 * Decoder is not a preferred choice for probing.
1082 * This indicates that the decoder is not a good choice for probing.
1083 * It could for example be an expensive to spin up hardware decoder,
1084 * or it could simply not provide a lot of useful information about
1086 * A decoder marked with this flag should only be used as last resort
1087 * choice for probing.
1089 #define AV_CODEC_CAP_AVOID_PROBING (1 << 17)
1091 * Codec is intra only.
1093 #define AV_CODEC_CAP_INTRA_ONLY 0x40000000
1095 * Codec is lossless.
1097 #define AV_CODEC_CAP_LOSSLESS 0x80000000
1100 #if FF_API_WITHOUT_PREFIX
1102 * Allow decoders to produce frames with data planes that are not aligned
1103 * to CPU requirements (e.g. due to cropping).
1105 #define CODEC_FLAG_UNALIGNED AV_CODEC_FLAG_UNALIGNED
1106 #define CODEC_FLAG_QSCALE AV_CODEC_FLAG_QSCALE
1107 #define CODEC_FLAG_4MV AV_CODEC_FLAG_4MV
1108 #define CODEC_FLAG_OUTPUT_CORRUPT AV_CODEC_FLAG_OUTPUT_CORRUPT
1109 #define CODEC_FLAG_QPEL AV_CODEC_FLAG_QPEL
1112 * @deprecated use the "gmc" private option of the libxvid encoder
1114 #define CODEC_FLAG_GMC 0x0020 ///< Use GMC.
1118 * @deprecated use the flag "mv0" in the "mpv_flags" private option of the
1119 * mpegvideo encoders
1121 #define CODEC_FLAG_MV0 0x0040
1123 #if FF_API_INPUT_PRESERVED
1125 * @deprecated passing reference-counted frames to the encoders replaces this
1128 #define CODEC_FLAG_INPUT_PRESERVED 0x0100
1130 #define CODEC_FLAG_PASS1 AV_CODEC_FLAG_PASS1
1131 #define CODEC_FLAG_PASS2 AV_CODEC_FLAG_PASS2
1132 #define CODEC_FLAG_GRAY AV_CODEC_FLAG_GRAY
1135 * @deprecated edges are not used/required anymore. I.e. this flag is now always
1138 #define CODEC_FLAG_EMU_EDGE 0x4000
1140 #define CODEC_FLAG_PSNR AV_CODEC_FLAG_PSNR
1141 #define CODEC_FLAG_TRUNCATED AV_CODEC_FLAG_TRUNCATED
1143 #if FF_API_NORMALIZE_AQP
1145 * @deprecated use the flag "naq" in the "mpv_flags" private option of the
1146 * mpegvideo encoders
1148 #define CODEC_FLAG_NORMALIZE_AQP 0x00020000
1150 #define CODEC_FLAG_INTERLACED_DCT AV_CODEC_FLAG_INTERLACED_DCT
1151 #define CODEC_FLAG_LOW_DELAY AV_CODEC_FLAG_LOW_DELAY
1152 #define CODEC_FLAG_GLOBAL_HEADER AV_CODEC_FLAG_GLOBAL_HEADER
1153 #define CODEC_FLAG_BITEXACT AV_CODEC_FLAG_BITEXACT
1154 #define CODEC_FLAG_AC_PRED AV_CODEC_FLAG_AC_PRED
1155 #define CODEC_FLAG_LOOP_FILTER AV_CODEC_FLAG_LOOP_FILTER
1156 #define CODEC_FLAG_INTERLACED_ME AV_CODEC_FLAG_INTERLACED_ME
1157 #define CODEC_FLAG_CLOSED_GOP AV_CODEC_FLAG_CLOSED_GOP
1158 #define CODEC_FLAG2_FAST AV_CODEC_FLAG2_FAST
1159 #define CODEC_FLAG2_NO_OUTPUT AV_CODEC_FLAG2_NO_OUTPUT
1160 #define CODEC_FLAG2_LOCAL_HEADER AV_CODEC_FLAG2_LOCAL_HEADER
1161 #define CODEC_FLAG2_DROP_FRAME_TIMECODE AV_CODEC_FLAG2_DROP_FRAME_TIMECODE
1162 #define CODEC_FLAG2_IGNORE_CROP AV_CODEC_FLAG2_IGNORE_CROP
1164 #define CODEC_FLAG2_CHUNKS AV_CODEC_FLAG2_CHUNKS
1165 #define CODEC_FLAG2_SHOW_ALL AV_CODEC_FLAG2_SHOW_ALL
1166 #define CODEC_FLAG2_EXPORT_MVS AV_CODEC_FLAG2_EXPORT_MVS
1167 #define CODEC_FLAG2_SKIP_MANUAL AV_CODEC_FLAG2_SKIP_MANUAL
1169 /* Unsupported options :
1170 * Syntax Arithmetic coding (SAC)
1171 * Reference Picture Selection
1172 * Independent Segment Decoding */
1174 /* codec capabilities */
1176 #define CODEC_CAP_DRAW_HORIZ_BAND AV_CODEC_CAP_DRAW_HORIZ_BAND ///< Decoder can use draw_horiz_band callback.
1178 * Codec uses get_buffer() for allocating buffers and supports custom allocators.
1179 * If not set, it might not use get_buffer() at all or use operations that
1180 * assume the buffer was allocated by avcodec_default_get_buffer.
1182 #define CODEC_CAP_DR1 AV_CODEC_CAP_DR1
1183 #define CODEC_CAP_TRUNCATED AV_CODEC_CAP_TRUNCATED
1185 /* Codec can export data for HW decoding. This flag indicates that
1186 * the codec would call get_format() with list that might contain HW accelerated
1187 * pixel formats (XvMC, VDPAU, VAAPI, etc). The application can pick any of them
1188 * including raw image format.
1189 * The application can use the passed context to determine bitstream version,
1190 * chroma format, resolution etc.
1192 #define CODEC_CAP_HWACCEL 0x0010
1193 #endif /* FF_API_XVMC */
1195 * Encoder or decoder requires flushing with NULL input at the end in order to
1196 * give the complete and correct output.
1198 * NOTE: If this flag is not set, the codec is guaranteed to never be fed with
1199 * with NULL data. The user can still send NULL data to the public encode
1200 * or decode function, but libavcodec will not pass it along to the codec
1201 * unless this flag is set.
1204 * The decoder has a non-zero delay and needs to be fed with avpkt->data=NULL,
1205 * avpkt->size=0 at the end to get the delayed data until the decoder no longer
1209 * The encoder needs to be fed with NULL data at the end of encoding until the
1210 * encoder no longer returns data.
1212 * NOTE: For encoders implementing the AVCodec.encode2() function, setting this
1213 * flag also means that the encoder must set the pts and duration for
1214 * each output packet. If this flag is not set, the pts and duration will
1215 * be determined by libavcodec from the input frame.
1217 #define CODEC_CAP_DELAY AV_CODEC_CAP_DELAY
1219 * Codec can be fed a final frame with a smaller size.
1220 * This can be used to prevent truncation of the last audio samples.
1222 #define CODEC_CAP_SMALL_LAST_FRAME AV_CODEC_CAP_SMALL_LAST_FRAME
1223 #if FF_API_CAP_VDPAU
1225 * Codec can export data for HW decoding (VDPAU).
1227 #define CODEC_CAP_HWACCEL_VDPAU AV_CODEC_CAP_HWACCEL_VDPAU
1230 * Codec can output multiple frames per AVPacket
1231 * Normally demuxers return one frame at a time, demuxers which do not do
1232 * are connected to a parser to split what they return into proper frames.
1233 * This flag is reserved to the very rare category of codecs which have a
1234 * bitstream that cannot be split into frames without timeconsuming
1235 * operations like full decoding. Demuxers carrying such bitstreams thus
1236 * may return multiple frames in a packet. This has many disadvantages like
1237 * prohibiting stream copy in many cases thus it should only be considered
1240 #define CODEC_CAP_SUBFRAMES AV_CODEC_CAP_SUBFRAMES
1242 * Codec is experimental and is thus avoided in favor of non experimental
1245 #define CODEC_CAP_EXPERIMENTAL AV_CODEC_CAP_EXPERIMENTAL
1247 * Codec should fill in channel configuration and samplerate instead of container
1249 #define CODEC_CAP_CHANNEL_CONF AV_CODEC_CAP_CHANNEL_CONF
1250 #if FF_API_NEG_LINESIZES
1252 * @deprecated no codecs use this capability
1254 #define CODEC_CAP_NEG_LINESIZES 0x0800
1257 * Codec supports frame-level multithreading.
1259 #define CODEC_CAP_FRAME_THREADS AV_CODEC_CAP_FRAME_THREADS
1261 * Codec supports slice-based (or partition-based) multithreading.
1263 #define CODEC_CAP_SLICE_THREADS AV_CODEC_CAP_SLICE_THREADS
1265 * Codec supports changed parameters at any point.
1267 #define CODEC_CAP_PARAM_CHANGE AV_CODEC_CAP_PARAM_CHANGE
1269 * Codec supports avctx->thread_count == 0 (auto).
1271 #define CODEC_CAP_AUTO_THREADS AV_CODEC_CAP_AUTO_THREADS
1273 * Audio encoder supports receiving a different number of samples in each call.
1275 #define CODEC_CAP_VARIABLE_FRAME_SIZE AV_CODEC_CAP_VARIABLE_FRAME_SIZE
1277 * Codec is intra only.
1279 #define CODEC_CAP_INTRA_ONLY AV_CODEC_CAP_INTRA_ONLY
1281 * Codec is lossless.
1283 #define CODEC_CAP_LOSSLESS AV_CODEC_CAP_LOSSLESS
1286 * HWAccel is experimental and is thus avoided in favor of non experimental
1289 #define HWACCEL_CODEC_CAP_EXPERIMENTAL 0x0200
1290 #endif /* FF_API_WITHOUT_PREFIX */
1293 //The following defines may change, don't expect compatibility if you use them.
1294 #define MB_TYPE_INTRA4x4 0x0001
1295 #define MB_TYPE_INTRA16x16 0x0002 //FIXME H.264-specific
1296 #define MB_TYPE_INTRA_PCM 0x0004 //FIXME H.264-specific
1297 #define MB_TYPE_16x16 0x0008
1298 #define MB_TYPE_16x8 0x0010
1299 #define MB_TYPE_8x16 0x0020
1300 #define MB_TYPE_8x8 0x0040
1301 #define MB_TYPE_INTERLACED 0x0080
1302 #define MB_TYPE_DIRECT2 0x0100 //FIXME
1303 #define MB_TYPE_ACPRED 0x0200
1304 #define MB_TYPE_GMC 0x0400
1305 #define MB_TYPE_SKIP 0x0800
1306 #define MB_TYPE_P0L0 0x1000
1307 #define MB_TYPE_P1L0 0x2000
1308 #define MB_TYPE_P0L1 0x4000
1309 #define MB_TYPE_P1L1 0x8000
1310 #define MB_TYPE_L0 (MB_TYPE_P0L0 | MB_TYPE_P1L0)
1311 #define MB_TYPE_L1 (MB_TYPE_P0L1 | MB_TYPE_P1L1)
1312 #define MB_TYPE_L0L1 (MB_TYPE_L0 | MB_TYPE_L1)
1313 #define MB_TYPE_QUANT 0x00010000
1314 #define MB_TYPE_CBP 0x00020000
1315 // Note bits 24-31 are reserved for codec specific use (H.264 ref0, MPEG-1 0mv, ...)
1320 * This specifies the area which should be displayed.
1321 * Note there may be multiple such areas for one frame.
1323 typedef struct AVPanScan{
1326 * - encoding: Set by user.
1327 * - decoding: Set by libavcodec.
1332 * width and height in 1/16 pel
1333 * - encoding: Set by user.
1334 * - decoding: Set by libavcodec.
1340 * position of the top left corner in 1/16 pel for up to 3 fields/frames
1341 * - encoding: Set by user.
1342 * - decoding: Set by libavcodec.
1344 int16_t position[3][2];
1348 * This structure describes the bitrate properties of an encoded bitstream. It
1349 * roughly corresponds to a subset the VBV parameters for MPEG-2 or HRD
1350 * parameters for H.264/HEVC.
1352 typedef struct AVCPBProperties {
1354 * Maximum bitrate of the stream, in bits per second.
1355 * Zero if unknown or unspecified.
1359 * Minimum bitrate of the stream, in bits per second.
1360 * Zero if unknown or unspecified.
1364 * Average bitrate of the stream, in bits per second.
1365 * Zero if unknown or unspecified.
1370 * The size of the buffer to which the ratecontrol is applied, in bits.
1371 * Zero if unknown or unspecified.
1376 * The delay between the time the packet this structure is associated with
1377 * is received and the time when it should be decoded, in periods of a 27MHz
1380 * UINT64_MAX when unknown or unspecified.
1385 #if FF_API_QSCALE_TYPE
1386 #define FF_QSCALE_TYPE_MPEG1 0
1387 #define FF_QSCALE_TYPE_MPEG2 1
1388 #define FF_QSCALE_TYPE_H264 2
1389 #define FF_QSCALE_TYPE_VP56 3
1393 * The decoder will keep a reference to the frame and may reuse it later.
1395 #define AV_GET_BUFFER_FLAG_REF (1 << 0)
1398 * @defgroup lavc_packet AVPacket
1400 * Types and functions for working with AVPacket.
1403 enum AVPacketSideDataType {
1405 * An AV_PKT_DATA_PALETTE side data packet contains exactly AVPALETTE_SIZE
1406 * bytes worth of palette. This side data signals that a new palette is
1409 AV_PKT_DATA_PALETTE,
1412 * The AV_PKT_DATA_NEW_EXTRADATA is used to notify the codec or the format
1413 * that the extradata buffer was changed and the receiving side should
1414 * act upon it appropriately. The new extradata is embedded in the side
1415 * data buffer and should be immediately used for processing the current
1418 AV_PKT_DATA_NEW_EXTRADATA,
1421 * An AV_PKT_DATA_PARAM_CHANGE side data packet is laid out as follows:
1424 * if (param_flags & AV_SIDE_DATA_PARAM_CHANGE_CHANNEL_COUNT)
1425 * s32le channel_count
1426 * if (param_flags & AV_SIDE_DATA_PARAM_CHANGE_CHANNEL_LAYOUT)
1427 * u64le channel_layout
1428 * if (param_flags & AV_SIDE_DATA_PARAM_CHANGE_SAMPLE_RATE)
1430 * if (param_flags & AV_SIDE_DATA_PARAM_CHANGE_DIMENSIONS)
1435 AV_PKT_DATA_PARAM_CHANGE,
1438 * An AV_PKT_DATA_H263_MB_INFO side data packet contains a number of
1439 * structures with info about macroblocks relevant to splitting the
1440 * packet into smaller packets on macroblock edges (e.g. as for RFC 2190).
1441 * That is, it does not necessarily contain info about all macroblocks,
1442 * as long as the distance between macroblocks in the info is smaller
1443 * than the target payload size.
1444 * Each MB info structure is 12 bytes, and is laid out as follows:
1446 * u32le bit offset from the start of the packet
1447 * u8 current quantizer at the start of the macroblock
1449 * u16le macroblock address within the GOB
1450 * u8 horizontal MV predictor
1451 * u8 vertical MV predictor
1452 * u8 horizontal MV predictor for block number 3
1453 * u8 vertical MV predictor for block number 3
1456 AV_PKT_DATA_H263_MB_INFO,
1459 * This side data should be associated with an audio stream and contains
1460 * ReplayGain information in form of the AVReplayGain struct.
1462 AV_PKT_DATA_REPLAYGAIN,
1465 * This side data contains a 3x3 transformation matrix describing an affine
1466 * transformation that needs to be applied to the decoded video frames for
1467 * correct presentation.
1469 * See libavutil/display.h for a detailed description of the data.
1471 AV_PKT_DATA_DISPLAYMATRIX,
1474 * This side data should be associated with a video stream and contains
1475 * Stereoscopic 3D information in form of the AVStereo3D struct.
1477 AV_PKT_DATA_STEREO3D,
1480 * This side data should be associated with an audio stream and corresponds
1481 * to enum AVAudioServiceType.
1483 AV_PKT_DATA_AUDIO_SERVICE_TYPE,
1486 * This side data contains quality related information from the encoder.
1488 * u32le quality factor of the compressed frame. Allowed range is between 1 (good) and FF_LAMBDA_MAX (bad).
1492 * u64le[error count] sum of squared differences between encoder in and output
1495 AV_PKT_DATA_QUALITY_STATS,
1498 * This side data contains an integer value representing the stream index
1499 * of a "fallback" track. A fallback track indicates an alternate
1500 * track to use when the current track can not be decoded for some reason.
1501 * e.g. no decoder available for codec.
1503 AV_PKT_DATA_FALLBACK_TRACK,
1506 * This side data corresponds to the AVCPBProperties struct.
1508 AV_PKT_DATA_CPB_PROPERTIES,
1511 * Recommmends skipping the specified number of samples
1513 * u32le number of samples to skip from start of this packet
1514 * u32le number of samples to skip from end of this packet
1515 * u8 reason for start skip
1516 * u8 reason for end skip (0=padding silence, 1=convergence)
1519 AV_PKT_DATA_SKIP_SAMPLES=70,
1522 * An AV_PKT_DATA_JP_DUALMONO side data packet indicates that
1523 * the packet may contain "dual mono" audio specific to Japanese DTV
1524 * and if it is true, recommends only the selected channel to be used.
1526 * u8 selected channels (0=mail/left, 1=sub/right, 2=both)
1529 AV_PKT_DATA_JP_DUALMONO,
1532 * A list of zero terminated key/value strings. There is no end marker for
1533 * the list, so it is required to rely on the side data size to stop.
1535 AV_PKT_DATA_STRINGS_METADATA,
1538 * Subtitle event position
1546 AV_PKT_DATA_SUBTITLE_POSITION,
1549 * Data found in BlockAdditional element of matroska container. There is
1550 * no end marker for the data, so it is required to rely on the side data
1551 * size to recognize the end. 8 byte id (as found in BlockAddId) followed
1554 AV_PKT_DATA_MATROSKA_BLOCKADDITIONAL,
1557 * The optional first identifier line of a WebVTT cue.
1559 AV_PKT_DATA_WEBVTT_IDENTIFIER,
1562 * The optional settings (rendering instructions) that immediately
1563 * follow the timestamp specifier of a WebVTT cue.
1565 AV_PKT_DATA_WEBVTT_SETTINGS,
1568 * A list of zero terminated key/value strings. There is no end marker for
1569 * the list, so it is required to rely on the side data size to stop. This
1570 * side data includes updated metadata which appeared in the stream.
1572 AV_PKT_DATA_METADATA_UPDATE,
1575 * MPEGTS stream ID, this is required to pass the stream ID
1576 * information from the demuxer to the corresponding muxer.
1578 AV_PKT_DATA_MPEGTS_STREAM_ID,
1581 * Mastering display metadata (based on SMPTE-2086:2014). This metadata
1582 * should be associated with a video stream and contains data in the form
1583 * of the AVMasteringDisplayMetadata struct.
1585 AV_PKT_DATA_MASTERING_DISPLAY_METADATA,
1588 * This side data should be associated with a video stream and corresponds
1589 * to the AVSphericalMapping structure.
1591 AV_PKT_DATA_SPHERICAL,
1594 * Content light level (based on CTA-861.3). This metadata should be
1595 * associated with a video stream and contains data in the form of the
1596 * AVContentLightMetadata struct.
1598 AV_PKT_DATA_CONTENT_LIGHT_LEVEL,
1601 * The number of side data elements (in fact a bit more than it).
1602 * This is not part of the public API/ABI in the sense that it may
1603 * change when new side data types are added.
1604 * This must stay the last enum value.
1605 * If its value becomes huge, some code using it
1606 * needs to be updated as it assumes it to be smaller than other limits.
1611 #define AV_PKT_DATA_QUALITY_FACTOR AV_PKT_DATA_QUALITY_STATS //DEPRECATED
1613 typedef struct AVPacketSideData {
1616 enum AVPacketSideDataType type;
1620 * This structure stores compressed data. It is typically exported by demuxers
1621 * and then passed as input to decoders, or received as output from encoders and
1622 * then passed to muxers.
1624 * For video, it should typically contain one compressed frame. For audio it may
1625 * contain several compressed frames. Encoders are allowed to output empty
1626 * packets, with no compressed data, containing only side data
1627 * (e.g. to update some stream parameters at the end of encoding).
1629 * AVPacket is one of the few structs in FFmpeg, whose size is a part of public
1630 * ABI. Thus it may be allocated on stack and no new fields can be added to it
1631 * without libavcodec and libavformat major bump.
1633 * The semantics of data ownership depends on the buf field.
1634 * If it is set, the packet data is dynamically allocated and is
1635 * valid indefinitely until a call to av_packet_unref() reduces the
1636 * reference count to 0.
1638 * If the buf field is not set av_packet_ref() would make a copy instead
1639 * of increasing the reference count.
1641 * The side data is always allocated with av_malloc(), copied by
1642 * av_packet_ref() and freed by av_packet_unref().
1644 * @see av_packet_ref
1645 * @see av_packet_unref
1647 typedef struct AVPacket {
1649 * A reference to the reference-counted buffer where the packet data is
1651 * May be NULL, then the packet data is not reference-counted.
1655 * Presentation timestamp in AVStream->time_base units; the time at which
1656 * the decompressed packet will be presented to the user.
1657 * Can be AV_NOPTS_VALUE if it is not stored in the file.
1658 * pts MUST be larger or equal to dts as presentation cannot happen before
1659 * decompression, unless one wants to view hex dumps. Some formats misuse
1660 * the terms dts and pts/cts to mean something different. Such timestamps
1661 * must be converted to true pts/dts before they are stored in AVPacket.
1665 * Decompression timestamp in AVStream->time_base units; the time at which
1666 * the packet is decompressed.
1667 * Can be AV_NOPTS_VALUE if it is not stored in the file.
1674 * A combination of AV_PKT_FLAG values
1678 * Additional packet data that can be provided by the container.
1679 * Packet can contain several types of side information.
1681 AVPacketSideData *side_data;
1682 int side_data_elems;
1685 * Duration of this packet in AVStream->time_base units, 0 if unknown.
1686 * Equals next_pts - this_pts in presentation order.
1690 int64_t pos; ///< byte position in stream, -1 if unknown
1692 #if FF_API_CONVERGENCE_DURATION
1694 * @deprecated Same as the duration field, but as int64_t. This was required
1695 * for Matroska subtitles, whose duration values could overflow when the
1696 * duration field was still an int.
1698 attribute_deprecated
1699 int64_t convergence_duration;
1702 #define AV_PKT_FLAG_KEY 0x0001 ///< The packet contains a keyframe
1703 #define AV_PKT_FLAG_CORRUPT 0x0002 ///< The packet content is corrupted
1705 * Flag is used to discard packets which are required to maintain valid
1706 * decoder state but are not required for output and should be dropped
1709 #define AV_PKT_FLAG_DISCARD 0x0004
1711 enum AVSideDataParamChangeFlags {
1712 AV_SIDE_DATA_PARAM_CHANGE_CHANNEL_COUNT = 0x0001,
1713 AV_SIDE_DATA_PARAM_CHANGE_CHANNEL_LAYOUT = 0x0002,
1714 AV_SIDE_DATA_PARAM_CHANGE_SAMPLE_RATE = 0x0004,
1715 AV_SIDE_DATA_PARAM_CHANGE_DIMENSIONS = 0x0008,
1721 struct AVCodecInternal;
1725 AV_FIELD_PROGRESSIVE,
1726 AV_FIELD_TT, //< Top coded_first, top displayed first
1727 AV_FIELD_BB, //< Bottom coded first, bottom displayed first
1728 AV_FIELD_TB, //< Top coded first, bottom displayed first
1729 AV_FIELD_BT, //< Bottom coded first, top displayed first
1733 * main external API structure.
1734 * New fields can be added to the end with minor version bumps.
1735 * Removal, reordering and changes to existing fields require a major
1737 * You can use AVOptions (av_opt* / av_set/get*()) to access these fields from user
1739 * The name string for AVOptions options matches the associated command line
1740 * parameter name and can be found in libavcodec/options_table.h
1741 * The AVOption/command line parameter names differ in some cases from the C
1742 * structure field names for historic reasons or brevity.
1743 * sizeof(AVCodecContext) must not be used outside libav*.
1745 typedef struct AVCodecContext {
1747 * information on struct for av_log
1748 * - set by avcodec_alloc_context3
1750 const AVClass *av_class;
1751 int log_level_offset;
1753 enum AVMediaType codec_type; /* see AVMEDIA_TYPE_xxx */
1754 const struct AVCodec *codec;
1755 #if FF_API_CODEC_NAME
1757 * @deprecated this field is not used for anything in libavcodec
1759 attribute_deprecated
1760 char codec_name[32];
1762 enum AVCodecID codec_id; /* see AV_CODEC_ID_xxx */
1765 * fourcc (LSB first, so "ABCD" -> ('D'<<24) + ('C'<<16) + ('B'<<8) + 'A').
1766 * This is used to work around some encoder bugs.
1767 * A demuxer should set this to what is stored in the field used to identify the codec.
1768 * If there are multiple such fields in a container then the demuxer should choose the one
1769 * which maximizes the information about the used codec.
1770 * If the codec tag field in a container is larger than 32 bits then the demuxer should
1771 * remap the longer ID to 32 bits with a table or other structure. Alternatively a new
1772 * extra_codec_tag + size could be added but for this a clear advantage must be demonstrated
1774 * - encoding: Set by user, if not then the default based on codec_id will be used.
1775 * - decoding: Set by user, will be converted to uppercase by libavcodec during init.
1777 unsigned int codec_tag;
1779 #if FF_API_STREAM_CODEC_TAG
1781 * @deprecated this field is unused
1783 attribute_deprecated
1784 unsigned int stream_codec_tag;
1790 * Private context used for internal data.
1792 * Unlike priv_data, this is not codec-specific. It is used in general
1793 * libavcodec functions.
1795 struct AVCodecInternal *internal;
1798 * Private data of the user, can be used to carry app specific stuff.
1799 * - encoding: Set by user.
1800 * - decoding: Set by user.
1805 * the average bitrate
1806 * - encoding: Set by user; unused for constant quantizer encoding.
1807 * - decoding: Set by user, may be overwritten by libavcodec
1808 * if this info is available in the stream
1813 * number of bits the bitstream is allowed to diverge from the reference.
1814 * the reference can be CBR (for CBR pass1) or VBR (for pass2)
1815 * - encoding: Set by user; unused for constant quantizer encoding.
1816 * - decoding: unused
1818 int bit_rate_tolerance;
1821 * Global quality for codecs which cannot change it per frame.
1822 * This should be proportional to MPEG-1/2/4 qscale.
1823 * - encoding: Set by user.
1824 * - decoding: unused
1829 * - encoding: Set by user.
1830 * - decoding: unused
1832 int compression_level;
1833 #define FF_COMPRESSION_DEFAULT -1
1837 * - encoding: Set by user.
1838 * - decoding: Set by user.
1844 * - encoding: Set by user.
1845 * - decoding: Set by user.
1850 * some codecs need / can use extradata like Huffman tables.
1851 * MJPEG: Huffman tables
1852 * rv10: additional flags
1853 * MPEG-4: global headers (they can be in the bitstream or here)
1854 * The allocated memory should be AV_INPUT_BUFFER_PADDING_SIZE bytes larger
1855 * than extradata_size to avoid problems if it is read with the bitstream reader.
1856 * The bytewise contents of extradata must not depend on the architecture or CPU endianness.
1857 * - encoding: Set/allocated/freed by libavcodec.
1858 * - decoding: Set/allocated/freed by user.
1864 * This is the fundamental unit of time (in seconds) in terms
1865 * of which frame timestamps are represented. For fixed-fps content,
1866 * timebase should be 1/framerate and timestamp increments should be
1868 * This often, but not always is the inverse of the frame rate or field rate
1869 * for video. 1/time_base is not the average frame rate if the frame rate is not
1872 * Like containers, elementary streams also can store timestamps, 1/time_base
1873 * is the unit in which these timestamps are specified.
1874 * As example of such codec time base see ISO/IEC 14496-2:2001(E)
1875 * vop_time_increment_resolution and fixed_vop_rate
1876 * (fixed_vop_rate == 0 implies that it is different from the framerate)
1878 * - encoding: MUST be set by user.
1879 * - decoding: the use of this field for decoding is deprecated.
1880 * Use framerate instead.
1882 AVRational time_base;
1885 * For some codecs, the time base is closer to the field rate than the frame rate.
1886 * Most notably, H.264 and MPEG-2 specify time_base as half of frame duration
1887 * if no telecine is used ...
1889 * Set to time_base ticks per frame. Default 1, e.g., H.264/MPEG-2 set it to 2.
1891 int ticks_per_frame;
1896 * Encoding: Number of frames delay there will be from the encoder input to
1897 * the decoder output. (we assume the decoder matches the spec)
1898 * Decoding: Number of frames delay in addition to what a standard decoder
1899 * as specified in the spec would produce.
1902 * Number of frames the decoded output will be delayed relative to the
1906 * For encoding, this field is unused (see initial_padding).
1908 * For decoding, this is the number of samples the decoder needs to
1909 * output before the decoder's output is valid. When seeking, you should
1910 * start decoding this many samples prior to your desired seek point.
1912 * - encoding: Set by libavcodec.
1913 * - decoding: Set by libavcodec.
1920 * picture width / height.
1922 * @note Those fields may not match the values of the last
1923 * AVFrame output by avcodec_decode_video2 due frame
1926 * - encoding: MUST be set by user.
1927 * - decoding: May be set by the user before opening the decoder if known e.g.
1928 * from the container. Some decoders will require the dimensions
1929 * to be set by the caller. During decoding, the decoder may
1930 * overwrite those values as required while parsing the data.
1935 * Bitstream width / height, may be different from width/height e.g. when
1936 * the decoded frame is cropped before being output or lowres is enabled.
1938 * @note Those field may not match the value of the last
1939 * AVFrame output by avcodec_receive_frame() due frame
1942 * - encoding: unused
1943 * - decoding: May be set by the user before opening the decoder if known
1944 * e.g. from the container. During decoding, the decoder may
1945 * overwrite those values as required while parsing the data.
1947 int coded_width, coded_height;
1949 #if FF_API_ASPECT_EXTENDED
1950 #define FF_ASPECT_EXTENDED 15
1954 * the number of pictures in a group of pictures, or 0 for intra_only
1955 * - encoding: Set by user.
1956 * - decoding: unused
1961 * Pixel format, see AV_PIX_FMT_xxx.
1962 * May be set by the demuxer if known from headers.
1963 * May be overridden by the decoder if it knows better.
1965 * @note This field may not match the value of the last
1966 * AVFrame output by avcodec_receive_frame() due frame
1969 * - encoding: Set by user.
1970 * - decoding: Set by user if known, overridden by libavcodec while
1973 enum AVPixelFormat pix_fmt;
1975 #if FF_API_MOTION_EST
1977 * This option does nothing
1978 * @deprecated use codec private options instead
1980 attribute_deprecated int me_method;
1984 * If non NULL, 'draw_horiz_band' is called by the libavcodec
1985 * decoder to draw a horizontal band. It improves cache usage. Not
1986 * all codecs can do that. You must check the codec capabilities
1988 * When multithreading is used, it may be called from multiple threads
1989 * at the same time; threads might draw different parts of the same AVFrame,
1990 * or multiple AVFrames, and there is no guarantee that slices will be drawn
1992 * The function is also used by hardware acceleration APIs.
1993 * It is called at least once during frame decoding to pass
1994 * the data needed for hardware render.
1995 * In that mode instead of pixel data, AVFrame points to
1996 * a structure specific to the acceleration API. The application
1997 * reads the structure and can change some fields to indicate progress
1999 * - encoding: unused
2000 * - decoding: Set by user.
2001 * @param height the height of the slice
2002 * @param y the y position of the slice
2003 * @param type 1->top field, 2->bottom field, 3->frame
2004 * @param offset offset into the AVFrame.data from which the slice should be read
2006 void (*draw_horiz_band)(struct AVCodecContext *s,
2007 const AVFrame *src, int offset[AV_NUM_DATA_POINTERS],
2008 int y, int type, int height);
2011 * callback to negotiate the pixelFormat
2012 * @param fmt is the list of formats which are supported by the codec,
2013 * it is terminated by -1 as 0 is a valid format, the formats are ordered by quality.
2014 * The first is always the native one.
2015 * @note The callback may be called again immediately if initialization for
2016 * the selected (hardware-accelerated) pixel format failed.
2017 * @warning Behavior is undefined if the callback returns a value not
2018 * in the fmt list of formats.
2019 * @return the chosen format
2020 * - encoding: unused
2021 * - decoding: Set by user, if not set the native format will be chosen.
2023 enum AVPixelFormat (*get_format)(struct AVCodecContext *s, const enum AVPixelFormat * fmt);
2026 * maximum number of B-frames between non-B-frames
2027 * Note: The output will be delayed by max_b_frames+1 relative to the input.
2028 * - encoding: Set by user.
2029 * - decoding: unused
2034 * qscale factor between IP and B-frames
2035 * If > 0 then the last P-frame quantizer will be used (q= lastp_q*factor+offset).
2036 * If < 0 then normal ratecontrol will be done (q= -normal_q*factor+offset).
2037 * - encoding: Set by user.
2038 * - decoding: unused
2040 float b_quant_factor;
2042 #if FF_API_RC_STRATEGY
2043 /** @deprecated use codec private option instead */
2044 attribute_deprecated int rc_strategy;
2045 #define FF_RC_STRATEGY_XVID 1
2048 #if FF_API_PRIVATE_OPT
2049 /** @deprecated use encoder private options instead */
2050 attribute_deprecated
2051 int b_frame_strategy;
2055 * qscale offset between IP and B-frames
2056 * - encoding: Set by user.
2057 * - decoding: unused
2059 float b_quant_offset;
2062 * Size of the frame reordering buffer in the decoder.
2063 * For MPEG-2 it is 1 IPB or 0 low delay IP.
2064 * - encoding: Set by libavcodec.
2065 * - decoding: Set by libavcodec.
2069 #if FF_API_PRIVATE_OPT
2070 /** @deprecated use encoder private options instead */
2071 attribute_deprecated
2076 * qscale factor between P- and I-frames
2077 * If > 0 then the last P-frame quantizer will be used (q = lastp_q * factor + offset).
2078 * If < 0 then normal ratecontrol will be done (q= -normal_q*factor+offset).
2079 * - encoding: Set by user.
2080 * - decoding: unused
2082 float i_quant_factor;
2085 * qscale offset between P and I-frames
2086 * - encoding: Set by user.
2087 * - decoding: unused
2089 float i_quant_offset;
2092 * luminance masking (0-> disabled)
2093 * - encoding: Set by user.
2094 * - decoding: unused
2099 * temporary complexity masking (0-> disabled)
2100 * - encoding: Set by user.
2101 * - decoding: unused
2103 float temporal_cplx_masking;
2106 * spatial complexity masking (0-> disabled)
2107 * - encoding: Set by user.
2108 * - decoding: unused
2110 float spatial_cplx_masking;
2113 * p block masking (0-> disabled)
2114 * - encoding: Set by user.
2115 * - decoding: unused
2120 * darkness masking (0-> disabled)
2121 * - encoding: Set by user.
2122 * - decoding: unused
2128 * - encoding: Set by libavcodec.
2129 * - decoding: Set by user (or 0).
2133 #if FF_API_PRIVATE_OPT
2134 /** @deprecated use encoder private options instead */
2135 attribute_deprecated
2136 int prediction_method;
2137 #define FF_PRED_LEFT 0
2138 #define FF_PRED_PLANE 1
2139 #define FF_PRED_MEDIAN 2
2143 * slice offsets in the frame in bytes
2144 * - encoding: Set/allocated by libavcodec.
2145 * - decoding: Set/allocated by user (or NULL).
2150 * sample aspect ratio (0 if unknown)
2151 * That is the width of a pixel divided by the height of the pixel.
2152 * Numerator and denominator must be relatively prime and smaller than 256 for some video standards.
2153 * - encoding: Set by user.
2154 * - decoding: Set by libavcodec.
2156 AVRational sample_aspect_ratio;
2159 * motion estimation comparison function
2160 * - encoding: Set by user.
2161 * - decoding: unused
2165 * subpixel motion estimation comparison function
2166 * - encoding: Set by user.
2167 * - decoding: unused
2171 * macroblock comparison function (not supported yet)
2172 * - encoding: Set by user.
2173 * - decoding: unused
2177 * interlaced DCT comparison function
2178 * - encoding: Set by user.
2179 * - decoding: unused
2182 #define FF_CMP_SAD 0
2183 #define FF_CMP_SSE 1
2184 #define FF_CMP_SATD 2
2185 #define FF_CMP_DCT 3
2186 #define FF_CMP_PSNR 4
2187 #define FF_CMP_BIT 5
2189 #define FF_CMP_ZERO 7
2190 #define FF_CMP_VSAD 8
2191 #define FF_CMP_VSSE 9
2192 #define FF_CMP_NSSE 10
2193 #define FF_CMP_W53 11
2194 #define FF_CMP_W97 12
2195 #define FF_CMP_DCTMAX 13
2196 #define FF_CMP_DCT264 14
2197 #define FF_CMP_MEDIAN_SAD 15
2198 #define FF_CMP_CHROMA 256
2201 * ME diamond size & shape
2202 * - encoding: Set by user.
2203 * - decoding: unused
2208 * amount of previous MV predictors (2a+1 x 2a+1 square)
2209 * - encoding: Set by user.
2210 * - decoding: unused
2212 int last_predictor_count;
2214 #if FF_API_PRIVATE_OPT
2215 /** @deprecated use encoder private options instead */
2216 attribute_deprecated
2221 * motion estimation prepass comparison function
2222 * - encoding: Set by user.
2223 * - decoding: unused
2228 * ME prepass diamond size & shape
2229 * - encoding: Set by user.
2230 * - decoding: unused
2236 * - encoding: Set by user.
2237 * - decoding: unused
2239 int me_subpel_quality;
2243 * DTG active format information (additional aspect ratio
2244 * information only used in DVB MPEG-2 transport streams)
2247 * - encoding: unused
2248 * - decoding: Set by decoder.
2249 * @deprecated Deprecated in favor of AVSideData
2251 attribute_deprecated int dtg_active_format;
2252 #define FF_DTG_AFD_SAME 8
2253 #define FF_DTG_AFD_4_3 9
2254 #define FF_DTG_AFD_16_9 10
2255 #define FF_DTG_AFD_14_9 11
2256 #define FF_DTG_AFD_4_3_SP_14_9 13
2257 #define FF_DTG_AFD_16_9_SP_14_9 14
2258 #define FF_DTG_AFD_SP_4_3 15
2259 #endif /* FF_API_AFD */
2262 * maximum motion estimation search range in subpel units
2263 * If 0 then no limit.
2265 * - encoding: Set by user.
2266 * - decoding: unused
2270 #if FF_API_QUANT_BIAS
2272 * @deprecated use encoder private option instead
2274 attribute_deprecated int intra_quant_bias;
2275 #define FF_DEFAULT_QUANT_BIAS 999999
2278 * @deprecated use encoder private option instead
2280 attribute_deprecated int inter_quant_bias;
2285 * - encoding: unused
2286 * - decoding: Set by user.
2289 #define SLICE_FLAG_CODED_ORDER 0x0001 ///< draw_horiz_band() is called in coded order instead of display
2290 #define SLICE_FLAG_ALLOW_FIELD 0x0002 ///< allow draw_horiz_band() with field slices (MPEG-2 field pics)
2291 #define SLICE_FLAG_ALLOW_PLANE 0x0004 ///< allow draw_horiz_band() with 1 component at a time (SVQ1)
2295 * XVideo Motion Acceleration
2296 * - encoding: forbidden
2297 * - decoding: set by decoder
2298 * @deprecated XvMC doesn't need it anymore.
2300 attribute_deprecated int xvmc_acceleration;
2301 #endif /* FF_API_XVMC */
2304 * macroblock decision mode
2305 * - encoding: Set by user.
2306 * - decoding: unused
2309 #define FF_MB_DECISION_SIMPLE 0 ///< uses mb_cmp
2310 #define FF_MB_DECISION_BITS 1 ///< chooses the one which needs the fewest bits
2311 #define FF_MB_DECISION_RD 2 ///< rate distortion
2314 * custom intra quantization matrix
2315 * - encoding: Set by user, can be NULL.
2316 * - decoding: Set by libavcodec.
2318 uint16_t *intra_matrix;
2321 * custom inter quantization matrix
2322 * - encoding: Set by user, can be NULL.
2323 * - decoding: Set by libavcodec.
2325 uint16_t *inter_matrix;
2327 #if FF_API_PRIVATE_OPT
2328 /** @deprecated use encoder private options instead */
2329 attribute_deprecated
2330 int scenechange_threshold;
2332 /** @deprecated use encoder private options instead */
2333 attribute_deprecated
2334 int noise_reduction;
2339 * @deprecated this field is unused
2341 attribute_deprecated
2345 * @deprecated this field is unused
2347 attribute_deprecated
2352 * precision of the intra DC coefficient - 8
2353 * - encoding: Set by user.
2354 * - decoding: Set by libavcodec
2356 int intra_dc_precision;
2359 * Number of macroblock rows at the top which are skipped.
2360 * - encoding: unused
2361 * - decoding: Set by user.
2366 * Number of macroblock rows at the bottom which are skipped.
2367 * - encoding: unused
2368 * - decoding: Set by user.
2374 * @deprecated use encoder private options instead
2376 attribute_deprecated
2377 float border_masking;
2381 * minimum MB Lagrange multiplier
2382 * - encoding: Set by user.
2383 * - decoding: unused
2388 * maximum MB Lagrange multiplier
2389 * - encoding: Set by user.
2390 * - decoding: unused
2394 #if FF_API_PRIVATE_OPT
2396 * @deprecated use encoder private options instead
2398 attribute_deprecated
2399 int me_penalty_compensation;
2403 * - encoding: Set by user.
2404 * - decoding: unused
2408 #if FF_API_PRIVATE_OPT
2409 /** @deprecated use encoder private options instead */
2410 attribute_deprecated
2416 * - encoding: Set by user.
2417 * - decoding: unused
2422 * number of reference frames
2423 * - encoding: Set by user.
2424 * - decoding: Set by lavc.
2428 #if FF_API_PRIVATE_OPT
2429 /** @deprecated use encoder private options instead */
2430 attribute_deprecated
2434 #if FF_API_UNUSED_MEMBERS
2436 * Multiplied by qscale for each frame and added to scene_change_score.
2437 * - encoding: Set by user.
2438 * - decoding: unused
2440 attribute_deprecated int scenechange_factor;
2444 * Note: Value depends upon the compare function used for fullpel ME.
2445 * - encoding: Set by user.
2446 * - decoding: unused
2450 #if FF_API_PRIVATE_OPT
2451 /** @deprecated use encoder private options instead */
2452 attribute_deprecated
2457 * Chromaticity coordinates of the source primaries.
2458 * - encoding: Set by user
2459 * - decoding: Set by libavcodec
2461 enum AVColorPrimaries color_primaries;
2464 * Color Transfer Characteristic.
2465 * - encoding: Set by user
2466 * - decoding: Set by libavcodec
2468 enum AVColorTransferCharacteristic color_trc;
2471 * YUV colorspace type.
2472 * - encoding: Set by user
2473 * - decoding: Set by libavcodec
2475 enum AVColorSpace colorspace;
2478 * MPEG vs JPEG YUV range.
2479 * - encoding: Set by user
2480 * - decoding: Set by libavcodec
2482 enum AVColorRange color_range;
2485 * This defines the location of chroma samples.
2486 * - encoding: Set by user
2487 * - decoding: Set by libavcodec
2489 enum AVChromaLocation chroma_sample_location;
2493 * Indicates number of picture subdivisions. Used for parallelized
2495 * - encoding: Set by user
2496 * - decoding: unused
2501 * - encoding: set by libavcodec
2502 * - decoding: Set by user.
2504 enum AVFieldOrder field_order;
2507 int sample_rate; ///< samples per second
2508 int channels; ///< number of audio channels
2511 * audio sample format
2512 * - encoding: Set by user.
2513 * - decoding: Set by libavcodec.
2515 enum AVSampleFormat sample_fmt; ///< sample format
2517 /* The following data should not be initialized. */
2519 * Number of samples per channel in an audio frame.
2521 * - encoding: set by libavcodec in avcodec_open2(). Each submitted frame
2522 * except the last must contain exactly frame_size samples per channel.
2523 * May be 0 when the codec has AV_CODEC_CAP_VARIABLE_FRAME_SIZE set, then the
2524 * frame size is not restricted.
2525 * - decoding: may be set by some decoders to indicate constant frame size
2530 * Frame counter, set by libavcodec.
2532 * - decoding: total number of frames returned from the decoder so far.
2533 * - encoding: total number of frames passed to the encoder so far.
2535 * @note the counter is not incremented if encoding/decoding resulted in
2541 * number of bytes per packet if constant and known or 0
2542 * Used by some WAV based audio codecs.
2547 * Audio cutoff bandwidth (0 means "automatic")
2548 * - encoding: Set by user.
2549 * - decoding: unused
2554 * Audio channel layout.
2555 * - encoding: set by user.
2556 * - decoding: set by user, may be overwritten by libavcodec.
2558 uint64_t channel_layout;
2561 * Request decoder to use this channel layout if it can (0 for default)
2562 * - encoding: unused
2563 * - decoding: Set by user.
2565 uint64_t request_channel_layout;
2568 * Type of service that the audio stream conveys.
2569 * - encoding: Set by user.
2570 * - decoding: Set by libavcodec.
2572 enum AVAudioServiceType audio_service_type;
2575 * desired sample format
2576 * - encoding: Not used.
2577 * - decoding: Set by user.
2578 * Decoder will decode to this format if it can.
2580 enum AVSampleFormat request_sample_fmt;
2583 * This callback is called at the beginning of each frame to get data
2584 * buffer(s) for it. There may be one contiguous buffer for all the data or
2585 * there may be a buffer per each data plane or anything in between. What
2586 * this means is, you may set however many entries in buf[] you feel necessary.
2587 * Each buffer must be reference-counted using the AVBuffer API (see description
2590 * The following fields will be set in the frame before this callback is
2593 * - width, height (video only)
2594 * - sample_rate, channel_layout, nb_samples (audio only)
2595 * Their values may differ from the corresponding values in
2596 * AVCodecContext. This callback must use the frame values, not the codec
2597 * context values, to calculate the required buffer size.
2599 * This callback must fill the following fields in the frame:
2603 * * if the data is planar audio with more than 8 channels, then this
2604 * callback must allocate and fill extended_data to contain all pointers
2605 * to all data planes. data[] must hold as many pointers as it can.
2606 * extended_data must be allocated with av_malloc() and will be freed in
2608 * * otherwise extended_data must point to data
2609 * - buf[] must contain one or more pointers to AVBufferRef structures. Each of
2610 * the frame's data and extended_data pointers must be contained in these. That
2611 * is, one AVBufferRef for each allocated chunk of memory, not necessarily one
2612 * AVBufferRef per data[] entry. See: av_buffer_create(), av_buffer_alloc(),
2613 * and av_buffer_ref().
2614 * - extended_buf and nb_extended_buf must be allocated with av_malloc() by
2615 * this callback and filled with the extra buffers if there are more
2616 * buffers than buf[] can hold. extended_buf will be freed in
2619 * If AV_CODEC_CAP_DR1 is not set then get_buffer2() must call
2620 * avcodec_default_get_buffer2() instead of providing buffers allocated by
2623 * Each data plane must be aligned to the maximum required by the target
2626 * @see avcodec_default_get_buffer2()
2630 * If AV_GET_BUFFER_FLAG_REF is set in flags then the frame may be reused
2631 * (read and/or written to if it is writable) later by libavcodec.
2633 * avcodec_align_dimensions2() should be used to find the required width and
2634 * height, as they normally need to be rounded up to the next multiple of 16.
2636 * Some decoders do not support linesizes changing between frames.
2638 * If frame multithreading is used and thread_safe_callbacks is set,
2639 * this callback may be called from a different thread, but not from more
2640 * than one at once. Does not need to be reentrant.
2642 * @see avcodec_align_dimensions2()
2646 * Decoders request a buffer of a particular size by setting
2647 * AVFrame.nb_samples prior to calling get_buffer2(). The decoder may,
2648 * however, utilize only part of the buffer by setting AVFrame.nb_samples
2649 * to a smaller value in the output frame.
2651 * As a convenience, av_samples_get_buffer_size() and
2652 * av_samples_fill_arrays() in libavutil may be used by custom get_buffer2()
2653 * functions to find the required data size and to fill data pointers and
2654 * linesize. In AVFrame.linesize, only linesize[0] may be set for audio
2655 * since all planes must be the same size.
2657 * @see av_samples_get_buffer_size(), av_samples_fill_arrays()
2659 * - encoding: unused
2660 * - decoding: Set by libavcodec, user can override.
2662 int (*get_buffer2)(struct AVCodecContext *s, AVFrame *frame, int flags);
2665 * If non-zero, the decoded audio and video frames returned from
2666 * avcodec_decode_video2() and avcodec_decode_audio4() are reference-counted
2667 * and are valid indefinitely. The caller must free them with
2668 * av_frame_unref() when they are not needed anymore.
2669 * Otherwise, the decoded frames must not be freed by the caller and are
2670 * only valid until the next decode call.
2672 * This is always automatically enabled if avcodec_receive_frame() is used.
2674 * - encoding: unused
2675 * - decoding: set by the caller before avcodec_open2().
2677 int refcounted_frames;
2679 /* - encoding parameters */
2680 float qcompress; ///< amount of qscale change between easy & hard scenes (0.0-1.0)
2681 float qblur; ///< amount of qscale smoothing over time (0.0-1.0)
2685 * - encoding: Set by user.
2686 * - decoding: unused
2692 * - encoding: Set by user.
2693 * - decoding: unused
2698 * maximum quantizer difference between frames
2699 * - encoding: Set by user.
2700 * - decoding: unused
2706 * @deprecated use encoder private options instead
2708 attribute_deprecated
2711 attribute_deprecated
2713 attribute_deprecated
2718 * decoder bitstream buffer size
2719 * - encoding: Set by user.
2720 * - decoding: unused
2725 * ratecontrol override, see RcOverride
2726 * - encoding: Allocated/set/freed by user.
2727 * - decoding: unused
2729 int rc_override_count;
2730 RcOverride *rc_override;
2734 * @deprecated use encoder private options instead
2736 attribute_deprecated
2742 * - encoding: Set by user.
2743 * - decoding: Set by user, may be overwritten by libavcodec.
2745 int64_t rc_max_rate;
2749 * - encoding: Set by user.
2750 * - decoding: unused
2752 int64_t rc_min_rate;
2756 * @deprecated use encoder private options instead
2758 attribute_deprecated
2759 float rc_buffer_aggressivity;
2761 attribute_deprecated
2762 float rc_initial_cplx;
2766 * Ratecontrol attempt to use, at maximum, <value> of what can be used without an underflow.
2767 * - encoding: Set by user.
2768 * - decoding: unused.
2770 float rc_max_available_vbv_use;
2773 * Ratecontrol attempt to use, at least, <value> times the amount needed to prevent a vbv overflow.
2774 * - encoding: Set by user.
2775 * - decoding: unused.
2777 float rc_min_vbv_overflow_use;
2780 * Number of bits which should be loaded into the rc buffer before decoding starts.
2781 * - encoding: Set by user.
2782 * - decoding: unused
2784 int rc_initial_buffer_occupancy;
2786 #if FF_API_CODER_TYPE
2787 #define FF_CODER_TYPE_VLC 0
2788 #define FF_CODER_TYPE_AC 1
2789 #define FF_CODER_TYPE_RAW 2
2790 #define FF_CODER_TYPE_RLE 3
2791 #if FF_API_UNUSED_MEMBERS
2792 #define FF_CODER_TYPE_DEFLATE 4
2793 #endif /* FF_API_UNUSED_MEMBERS */
2795 * @deprecated use encoder private options instead
2797 attribute_deprecated
2799 #endif /* FF_API_CODER_TYPE */
2801 #if FF_API_PRIVATE_OPT
2802 /** @deprecated use encoder private options instead */
2803 attribute_deprecated
2809 * @deprecated use encoder private options instead
2811 attribute_deprecated
2815 * @deprecated use encoder private options instead
2817 attribute_deprecated
2821 #if FF_API_PRIVATE_OPT
2822 /** @deprecated use encoder private options instead */
2823 attribute_deprecated
2824 int frame_skip_threshold;
2826 /** @deprecated use encoder private options instead */
2827 attribute_deprecated
2828 int frame_skip_factor;
2830 /** @deprecated use encoder private options instead */
2831 attribute_deprecated
2834 /** @deprecated use encoder private options instead */
2835 attribute_deprecated
2837 #endif /* FF_API_PRIVATE_OPT */
2840 * trellis RD quantization
2841 * - encoding: Set by user.
2842 * - decoding: unused
2846 #if FF_API_PRIVATE_OPT
2847 /** @deprecated use encoder private options instead */
2848 attribute_deprecated
2849 int min_prediction_order;
2851 /** @deprecated use encoder private options instead */
2852 attribute_deprecated
2853 int max_prediction_order;
2855 /** @deprecated use encoder private options instead */
2856 attribute_deprecated
2857 int64_t timecode_frame_start;
2860 #if FF_API_RTP_CALLBACK
2862 * @deprecated unused
2864 /* The RTP callback: This function is called */
2865 /* every time the encoder has a packet to send. */
2866 /* It depends on the encoder if the data starts */
2867 /* with a Start Code (it should). H.263 does. */
2868 /* mb_nb contains the number of macroblocks */
2869 /* encoded in the RTP payload. */
2870 attribute_deprecated
2871 void (*rtp_callback)(struct AVCodecContext *avctx, void *data, int size, int mb_nb);
2874 #if FF_API_PRIVATE_OPT
2875 /** @deprecated use encoder private options instead */
2876 attribute_deprecated
2877 int rtp_payload_size; /* The size of the RTP payload: the coder will */
2878 /* do its best to deliver a chunk with size */
2879 /* below rtp_payload_size, the chunk will start */
2880 /* with a start code on some codecs like H.263. */
2881 /* This doesn't take account of any particular */
2882 /* headers inside the transmitted RTP payload. */
2885 #if FF_API_STAT_BITS
2886 /* statistics, used for 2-pass encoding */
2887 attribute_deprecated
2889 attribute_deprecated
2891 attribute_deprecated
2893 attribute_deprecated
2895 attribute_deprecated
2897 attribute_deprecated
2899 attribute_deprecated
2901 attribute_deprecated
2904 /** @deprecated this field is unused */
2905 attribute_deprecated
2910 * pass1 encoding statistics output buffer
2911 * - encoding: Set by libavcodec.
2912 * - decoding: unused
2917 * pass2 encoding statistics input buffer
2918 * Concatenated stuff from stats_out of pass1 should be placed here.
2919 * - encoding: Allocated/set/freed by user.
2920 * - decoding: unused
2925 * Work around bugs in encoders which sometimes cannot be detected automatically.
2926 * - encoding: Set by user
2927 * - decoding: Set by user
2929 int workaround_bugs;
2930 #define FF_BUG_AUTODETECT 1 ///< autodetection
2931 #if FF_API_OLD_MSMPEG4
2932 #define FF_BUG_OLD_MSMPEG4 2
2934 #define FF_BUG_XVID_ILACE 4
2935 #define FF_BUG_UMP4 8
2936 #define FF_BUG_NO_PADDING 16
2937 #define FF_BUG_AMV 32
2939 #define FF_BUG_AC_VLC 0 ///< Will be removed, libavcodec can now handle these non-compliant files by default.
2941 #define FF_BUG_QPEL_CHROMA 64
2942 #define FF_BUG_STD_QPEL 128
2943 #define FF_BUG_QPEL_CHROMA2 256
2944 #define FF_BUG_DIRECT_BLOCKSIZE 512
2945 #define FF_BUG_EDGE 1024
2946 #define FF_BUG_HPEL_CHROMA 2048
2947 #define FF_BUG_DC_CLIP 4096
2948 #define FF_BUG_MS 8192 ///< Work around various bugs in Microsoft's broken decoders.
2949 #define FF_BUG_TRUNCATED 16384
2950 #define FF_BUG_IEDGE 32768
2953 * strictly follow the standard (MPEG-4, ...).
2954 * - encoding: Set by user.
2955 * - decoding: Set by user.
2956 * Setting this to STRICT or higher means the encoder and decoder will
2957 * generally do stupid things, whereas setting it to unofficial or lower
2958 * will mean the encoder might produce output that is not supported by all
2959 * spec-compliant decoders. Decoders don't differentiate between normal,
2960 * unofficial and experimental (that is, they always try to decode things
2961 * when they can) unless they are explicitly asked to behave stupidly
2962 * (=strictly conform to the specs)
2964 int strict_std_compliance;
2965 #define FF_COMPLIANCE_VERY_STRICT 2 ///< Strictly conform to an older more strict version of the spec or reference software.
2966 #define FF_COMPLIANCE_STRICT 1 ///< Strictly conform to all the things in the spec no matter what consequences.
2967 #define FF_COMPLIANCE_NORMAL 0
2968 #define FF_COMPLIANCE_UNOFFICIAL -1 ///< Allow unofficial extensions
2969 #define FF_COMPLIANCE_EXPERIMENTAL -2 ///< Allow nonstandardized experimental things.
2972 * error concealment flags
2973 * - encoding: unused
2974 * - decoding: Set by user.
2976 int error_concealment;
2977 #define FF_EC_GUESS_MVS 1
2978 #define FF_EC_DEBLOCK 2
2979 #define FF_EC_FAVOR_INTER 256
2983 * - encoding: Set by user.
2984 * - decoding: Set by user.
2987 #define FF_DEBUG_PICT_INFO 1
2988 #define FF_DEBUG_RC 2
2989 #define FF_DEBUG_BITSTREAM 4
2990 #define FF_DEBUG_MB_TYPE 8
2991 #define FF_DEBUG_QP 16
2994 * @deprecated this option does nothing
2996 #define FF_DEBUG_MV 32
2998 #define FF_DEBUG_DCT_COEFF 0x00000040
2999 #define FF_DEBUG_SKIP 0x00000080
3000 #define FF_DEBUG_STARTCODE 0x00000100
3001 #if FF_API_UNUSED_MEMBERS
3002 #define FF_DEBUG_PTS 0x00000200
3003 #endif /* FF_API_UNUSED_MEMBERS */
3004 #define FF_DEBUG_ER 0x00000400
3005 #define FF_DEBUG_MMCO 0x00000800
3006 #define FF_DEBUG_BUGS 0x00001000
3008 #define FF_DEBUG_VIS_QP 0x00002000
3009 #define FF_DEBUG_VIS_MB_TYPE 0x00004000
3011 #define FF_DEBUG_BUFFERS 0x00008000
3012 #define FF_DEBUG_THREADS 0x00010000
3013 #define FF_DEBUG_GREEN_MD 0x00800000
3014 #define FF_DEBUG_NOMC 0x01000000
3019 * - encoding: Set by user.
3020 * - decoding: Set by user.
3023 #define FF_DEBUG_VIS_MV_P_FOR 0x00000001 // visualize forward predicted MVs of P-frames
3024 #define FF_DEBUG_VIS_MV_B_FOR 0x00000002 // visualize forward predicted MVs of B-frames
3025 #define FF_DEBUG_VIS_MV_B_BACK 0x00000004 // visualize backward predicted MVs of B-frames
3029 * Error recognition; may misdetect some more or less valid parts as errors.
3030 * - encoding: unused
3031 * - decoding: Set by user.
3033 int err_recognition;
3036 * Verify checksums embedded in the bitstream (could be of either encoded or
3037 * decoded data, depending on the codec) and print an error message on mismatch.
3038 * If AV_EF_EXPLODE is also set, a mismatching checksum will result in the
3039 * decoder returning an error.
3041 #define AV_EF_CRCCHECK (1<<0)
3042 #define AV_EF_BITSTREAM (1<<1) ///< detect bitstream specification deviations
3043 #define AV_EF_BUFFER (1<<2) ///< detect improper bitstream length
3044 #define AV_EF_EXPLODE (1<<3) ///< abort decoding on minor error detection
3046 #define AV_EF_IGNORE_ERR (1<<15) ///< ignore errors and continue
3047 #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
3048 #define AV_EF_COMPLIANT (1<<17) ///< consider all spec non compliances as errors
3049 #define AV_EF_AGGRESSIVE (1<<18) ///< consider things that a sane encoder should not do as an error
3053 * opaque 64-bit number (generally a PTS) that will be reordered and
3054 * output in AVFrame.reordered_opaque
3055 * - encoding: unused
3056 * - decoding: Set by user.
3058 int64_t reordered_opaque;
3061 * Hardware accelerator in use
3062 * - encoding: unused.
3063 * - decoding: Set by libavcodec
3065 struct AVHWAccel *hwaccel;
3068 * Hardware accelerator context.
3069 * For some hardware accelerators, a global context needs to be
3070 * provided by the user. In that case, this holds display-dependent
3071 * data FFmpeg cannot instantiate itself. Please refer to the
3072 * FFmpeg HW accelerator documentation to know how to fill this
3073 * is. e.g. for VA API, this is a struct vaapi_context.
3074 * - encoding: unused
3075 * - decoding: Set by user
3077 void *hwaccel_context;
3081 * - encoding: Set by libavcodec if flags & AV_CODEC_FLAG_PSNR.
3082 * - decoding: unused
3084 uint64_t error[AV_NUM_DATA_POINTERS];
3087 * DCT algorithm, see FF_DCT_* below
3088 * - encoding: Set by user.
3089 * - decoding: unused
3092 #define FF_DCT_AUTO 0
3093 #define FF_DCT_FASTINT 1
3094 #define FF_DCT_INT 2
3095 #define FF_DCT_MMX 3
3096 #define FF_DCT_ALTIVEC 5
3097 #define FF_DCT_FAAN 6
3100 * IDCT algorithm, see FF_IDCT_* below.
3101 * - encoding: Set by user.
3102 * - decoding: Set by user.
3105 #define FF_IDCT_AUTO 0
3106 #define FF_IDCT_INT 1
3107 #define FF_IDCT_SIMPLE 2
3108 #define FF_IDCT_SIMPLEMMX 3
3109 #define FF_IDCT_ARM 7
3110 #define FF_IDCT_ALTIVEC 8
3112 #define FF_IDCT_SH4 9
3114 #define FF_IDCT_SIMPLEARM 10
3115 #if FF_API_UNUSED_MEMBERS
3116 #define FF_IDCT_IPP 13
3117 #endif /* FF_API_UNUSED_MEMBERS */
3118 #define FF_IDCT_XVID 14
3119 #if FF_API_IDCT_XVIDMMX
3120 #define FF_IDCT_XVIDMMX 14
3121 #endif /* FF_API_IDCT_XVIDMMX */
3122 #define FF_IDCT_SIMPLEARMV5TE 16
3123 #define FF_IDCT_SIMPLEARMV6 17
3124 #if FF_API_ARCH_SPARC
3125 #define FF_IDCT_SIMPLEVIS 18
3127 #define FF_IDCT_FAAN 20
3128 #define FF_IDCT_SIMPLENEON 22
3129 #if FF_API_ARCH_ALPHA
3130 #define FF_IDCT_SIMPLEALPHA 23
3132 #define FF_IDCT_SIMPLEAUTO 128
3135 * bits per sample/pixel from the demuxer (needed for huffyuv).
3136 * - encoding: Set by libavcodec.
3137 * - decoding: Set by user.
3139 int bits_per_coded_sample;
3142 * Bits per sample/pixel of internal libavcodec pixel/sample format.
3143 * - encoding: set by user.
3144 * - decoding: set by libavcodec.
3146 int bits_per_raw_sample;
3150 * low resolution decoding, 1-> 1/2 size, 2->1/4 size
3151 * - encoding: unused
3152 * - decoding: Set by user.
3157 #if FF_API_CODED_FRAME
3159 * the picture in the bitstream
3160 * - encoding: Set by libavcodec.
3161 * - decoding: unused
3163 * @deprecated use the quality factor packet side data instead
3165 attribute_deprecated AVFrame *coded_frame;
3170 * is used to decide how many independent tasks should be passed to execute()
3171 * - encoding: Set by user.
3172 * - decoding: Set by user.
3177 * Which multithreading methods to use.
3178 * Use of FF_THREAD_FRAME will increase decoding delay by one frame per thread,
3179 * so clients which cannot provide future frames should not use it.
3181 * - encoding: Set by user, otherwise the default is used.
3182 * - decoding: Set by user, otherwise the default is used.
3185 #define FF_THREAD_FRAME 1 ///< Decode more than one frame at once
3186 #define FF_THREAD_SLICE 2 ///< Decode more than one part of a single frame at once
3189 * Which multithreading methods are in use by the codec.
3190 * - encoding: Set by libavcodec.
3191 * - decoding: Set by libavcodec.
3193 int active_thread_type;
3196 * Set by the client if its custom get_buffer() callback can be called
3197 * synchronously from another thread, which allows faster multithreaded decoding.
3198 * draw_horiz_band() will be called from other threads regardless of this setting.
3199 * Ignored if the default get_buffer() is used.
3200 * - encoding: Set by user.
3201 * - decoding: Set by user.
3203 int thread_safe_callbacks;
3206 * The codec may call this to execute several independent things.
3207 * It will return only after finishing all tasks.
3208 * The user may replace this with some multithreaded implementation,
3209 * the default implementation will execute the parts serially.
3210 * @param count the number of things to execute
3211 * - encoding: Set by libavcodec, user can override.
3212 * - decoding: Set by libavcodec, user can override.
3214 int (*execute)(struct AVCodecContext *c, int (*func)(struct AVCodecContext *c2, void *arg), void *arg2, int *ret, int count, int size);
3217 * The codec may call this to execute several independent things.
3218 * It will return only after finishing all tasks.
3219 * The user may replace this with some multithreaded implementation,
3220 * the default implementation will execute the parts serially.
3221 * Also see avcodec_thread_init and e.g. the --enable-pthread configure option.
3222 * @param c context passed also to func
3223 * @param count the number of things to execute
3224 * @param arg2 argument passed unchanged to func
3225 * @param ret return values of executed functions, must have space for "count" values. May be NULL.
3226 * @param func function that will be called count times, with jobnr from 0 to count-1.
3227 * threadnr will be in the range 0 to c->thread_count-1 < MAX_THREADS and so that no
3228 * two instances of func executing at the same time will have the same threadnr.
3229 * @return always 0 currently, but code should handle a future improvement where when any call to func
3230 * returns < 0 no further calls to func may be done and < 0 is returned.
3231 * - encoding: Set by libavcodec, user can override.
3232 * - decoding: Set by libavcodec, user can override.
3234 int (*execute2)(struct AVCodecContext *c, int (*func)(struct AVCodecContext *c2, void *arg, int jobnr, int threadnr), void *arg2, int *ret, int count);
3237 * noise vs. sse weight for the nsse comparison function
3238 * - encoding: Set by user.
3239 * - decoding: unused
3245 * - encoding: Set by user.
3246 * - decoding: Set by libavcodec.
3249 #define FF_PROFILE_UNKNOWN -99
3250 #define FF_PROFILE_RESERVED -100
3252 #define FF_PROFILE_AAC_MAIN 0
3253 #define FF_PROFILE_AAC_LOW 1
3254 #define FF_PROFILE_AAC_SSR 2
3255 #define FF_PROFILE_AAC_LTP 3
3256 #define FF_PROFILE_AAC_HE 4
3257 #define FF_PROFILE_AAC_HE_V2 28
3258 #define FF_PROFILE_AAC_LD 22
3259 #define FF_PROFILE_AAC_ELD 38
3260 #define FF_PROFILE_MPEG2_AAC_LOW 128
3261 #define FF_PROFILE_MPEG2_AAC_HE 131
3263 #define FF_PROFILE_DNXHD 0
3264 #define FF_PROFILE_DNXHR_LB 1
3265 #define FF_PROFILE_DNXHR_SQ 2
3266 #define FF_PROFILE_DNXHR_HQ 3
3267 #define FF_PROFILE_DNXHR_HQX 4
3268 #define FF_PROFILE_DNXHR_444 5
3270 #define FF_PROFILE_DTS 20
3271 #define FF_PROFILE_DTS_ES 30
3272 #define FF_PROFILE_DTS_96_24 40
3273 #define FF_PROFILE_DTS_HD_HRA 50
3274 #define FF_PROFILE_DTS_HD_MA 60
3275 #define FF_PROFILE_DTS_EXPRESS 70
3277 #define FF_PROFILE_MPEG2_422 0
3278 #define FF_PROFILE_MPEG2_HIGH 1
3279 #define FF_PROFILE_MPEG2_SS 2
3280 #define FF_PROFILE_MPEG2_SNR_SCALABLE 3
3281 #define FF_PROFILE_MPEG2_MAIN 4
3282 #define FF_PROFILE_MPEG2_SIMPLE 5
3284 #define FF_PROFILE_H264_CONSTRAINED (1<<9) // 8+1; constraint_set1_flag
3285 #define FF_PROFILE_H264_INTRA (1<<11) // 8+3; constraint_set3_flag
3287 #define FF_PROFILE_H264_BASELINE 66
3288 #define FF_PROFILE_H264_CONSTRAINED_BASELINE (66|FF_PROFILE_H264_CONSTRAINED)
3289 #define FF_PROFILE_H264_MAIN 77
3290 #define FF_PROFILE_H264_EXTENDED 88
3291 #define FF_PROFILE_H264_HIGH 100
3292 #define FF_PROFILE_H264_HIGH_10 110
3293 #define FF_PROFILE_H264_HIGH_10_INTRA (110|FF_PROFILE_H264_INTRA)
3294 #define FF_PROFILE_H264_MULTIVIEW_HIGH 118
3295 #define FF_PROFILE_H264_HIGH_422 122
3296 #define FF_PROFILE_H264_HIGH_422_INTRA (122|FF_PROFILE_H264_INTRA)
3297 #define FF_PROFILE_H264_STEREO_HIGH 128
3298 #define FF_PROFILE_H264_HIGH_444 144
3299 #define FF_PROFILE_H264_HIGH_444_PREDICTIVE 244
3300 #define FF_PROFILE_H264_HIGH_444_INTRA (244|FF_PROFILE_H264_INTRA)
3301 #define FF_PROFILE_H264_CAVLC_444 44
3303 #define FF_PROFILE_VC1_SIMPLE 0
3304 #define FF_PROFILE_VC1_MAIN 1
3305 #define FF_PROFILE_VC1_COMPLEX 2
3306 #define FF_PROFILE_VC1_ADVANCED 3
3308 #define FF_PROFILE_MPEG4_SIMPLE 0
3309 #define FF_PROFILE_MPEG4_SIMPLE_SCALABLE 1
3310 #define FF_PROFILE_MPEG4_CORE 2
3311 #define FF_PROFILE_MPEG4_MAIN 3
3312 #define FF_PROFILE_MPEG4_N_BIT 4
3313 #define FF_PROFILE_MPEG4_SCALABLE_TEXTURE 5
3314 #define FF_PROFILE_MPEG4_SIMPLE_FACE_ANIMATION 6
3315 #define FF_PROFILE_MPEG4_BASIC_ANIMATED_TEXTURE 7
3316 #define FF_PROFILE_MPEG4_HYBRID 8
3317 #define FF_PROFILE_MPEG4_ADVANCED_REAL_TIME 9
3318 #define FF_PROFILE_MPEG4_CORE_SCALABLE 10
3319 #define FF_PROFILE_MPEG4_ADVANCED_CODING 11
3320 #define FF_PROFILE_MPEG4_ADVANCED_CORE 12
3321 #define FF_PROFILE_MPEG4_ADVANCED_SCALABLE_TEXTURE 13
3322 #define FF_PROFILE_MPEG4_SIMPLE_STUDIO 14
3323 #define FF_PROFILE_MPEG4_ADVANCED_SIMPLE 15
3325 #define FF_PROFILE_JPEG2000_CSTREAM_RESTRICTION_0 1
3326 #define FF_PROFILE_JPEG2000_CSTREAM_RESTRICTION_1 2
3327 #define FF_PROFILE_JPEG2000_CSTREAM_NO_RESTRICTION 32768
3328 #define FF_PROFILE_JPEG2000_DCINEMA_2K 3
3329 #define FF_PROFILE_JPEG2000_DCINEMA_4K 4
3331 #define FF_PROFILE_VP9_0 0
3332 #define FF_PROFILE_VP9_1 1
3333 #define FF_PROFILE_VP9_2 2
3334 #define FF_PROFILE_VP9_3 3
3336 #define FF_PROFILE_HEVC_MAIN 1
3337 #define FF_PROFILE_HEVC_MAIN_10 2
3338 #define FF_PROFILE_HEVC_MAIN_STILL_PICTURE 3
3339 #define FF_PROFILE_HEVC_REXT 4
3343 * - encoding: Set by user.
3344 * - decoding: Set by libavcodec.
3347 #define FF_LEVEL_UNKNOWN -99
3350 * Skip loop filtering for selected frames.
3351 * - encoding: unused
3352 * - decoding: Set by user.
3354 enum AVDiscard skip_loop_filter;
3357 * Skip IDCT/dequantization for selected frames.
3358 * - encoding: unused
3359 * - decoding: Set by user.
3361 enum AVDiscard skip_idct;
3364 * Skip decoding for selected frames.
3365 * - encoding: unused
3366 * - decoding: Set by user.
3368 enum AVDiscard skip_frame;
3371 * Header containing style information for text subtitles.
3372 * For SUBTITLE_ASS subtitle type, it should contain the whole ASS
3373 * [Script Info] and [V4+ Styles] section, plus the [Events] line and
3374 * the Format line following. It shouldn't include any Dialogue line.
3375 * - encoding: Set/allocated/freed by user (before avcodec_open2())
3376 * - decoding: Set/allocated/freed by libavcodec (by avcodec_open2())
3378 uint8_t *subtitle_header;
3379 int subtitle_header_size;
3381 #if FF_API_ERROR_RATE
3383 * @deprecated use the 'error_rate' private AVOption of the mpegvideo
3386 attribute_deprecated
3390 #if FF_API_VBV_DELAY
3392 * VBV delay coded in the last frame (in periods of a 27 MHz clock).
3393 * Used for compliant TS muxing.
3394 * - encoding: Set by libavcodec.
3395 * - decoding: unused.
3396 * @deprecated this value is now exported as a part of
3397 * AV_PKT_DATA_CPB_PROPERTIES packet side data
3399 attribute_deprecated
3403 #if FF_API_SIDEDATA_ONLY_PKT
3405 * Encoding only and set by default. Allow encoders to output packets
3406 * that do not contain any encoded data, only side data.
3408 * Some encoders need to output such packets, e.g. to update some stream
3409 * parameters at the end of encoding.
3411 * @deprecated this field disables the default behaviour and
3412 * it is kept only for compatibility.
3414 attribute_deprecated
3415 int side_data_only_packets;
3419 * Audio only. The number of "priming" samples (padding) inserted by the
3420 * encoder at the beginning of the audio. I.e. this number of leading
3421 * decoded samples must be discarded by the caller to get the original audio
3422 * without leading padding.
3424 * - decoding: unused
3425 * - encoding: Set by libavcodec. The timestamps on the output packets are
3426 * adjusted by the encoder so that they always refer to the
3427 * first sample of the data actually contained in the packet,
3428 * including any added padding. E.g. if the timebase is
3429 * 1/samplerate and the timestamp of the first input sample is
3430 * 0, the timestamp of the first output packet will be
3433 int initial_padding;
3436 * - decoding: For codecs that store a framerate value in the compressed
3437 * bitstream, the decoder may export it here. { 0, 1} when
3439 * - encoding: May be used to signal the framerate of CFR content to an
3442 AVRational framerate;
3445 * Nominal unaccelerated pixel format, see AV_PIX_FMT_xxx.
3446 * - encoding: unused.
3447 * - decoding: Set by libavcodec before calling get_format()
3449 enum AVPixelFormat sw_pix_fmt;
3452 * Timebase in which pkt_dts/pts and AVPacket.dts/pts are.
3453 * - encoding unused.
3454 * - decoding set by user.
3456 AVRational pkt_timebase;
3460 * - encoding: unused.
3461 * - decoding: set by libavcodec.
3463 const AVCodecDescriptor *codec_descriptor;
3467 * low resolution decoding, 1-> 1/2 size, 2->1/4 size
3468 * - encoding: unused
3469 * - decoding: Set by user.
3475 * Current statistics for PTS correction.
3476 * - decoding: maintained and used by libavcodec, not intended to be used by user apps
3477 * - encoding: unused
3479 int64_t pts_correction_num_faulty_pts; /// Number of incorrect PTS values so far
3480 int64_t pts_correction_num_faulty_dts; /// Number of incorrect DTS values so far
3481 int64_t pts_correction_last_pts; /// PTS of the last frame
3482 int64_t pts_correction_last_dts; /// DTS of the last frame
3485 * Character encoding of the input subtitles file.
3486 * - decoding: set by user
3487 * - encoding: unused
3492 * Subtitles character encoding mode. Formats or codecs might be adjusting
3493 * this setting (if they are doing the conversion themselves for instance).
3494 * - decoding: set by libavcodec
3495 * - encoding: unused
3497 int sub_charenc_mode;
3498 #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)
3499 #define FF_SUB_CHARENC_MODE_AUTOMATIC 0 ///< libavcodec will select the mode itself
3500 #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
3503 * Skip processing alpha if supported by codec.
3504 * Note that if the format uses pre-multiplied alpha (common with VP6,
3505 * and recommended due to better video quality/compression)
3506 * the image will look as if alpha-blended onto a black background.
3507 * However for formats that do not use pre-multiplied alpha
3508 * there might be serious artefacts (though e.g. libswscale currently
3509 * assumes pre-multiplied alpha anyway).
3511 * - decoding: set by user
3512 * - encoding: unused
3517 * Number of samples to skip after a discontinuity
3518 * - decoding: unused
3519 * - encoding: set by libavcodec
3523 #if !FF_API_DEBUG_MV
3525 * debug motion vectors
3526 * - encoding: Set by user.
3527 * - decoding: Set by user.
3530 #define FF_DEBUG_VIS_MV_P_FOR 0x00000001 //visualize forward predicted MVs of P frames
3531 #define FF_DEBUG_VIS_MV_B_FOR 0x00000002 //visualize forward predicted MVs of B frames
3532 #define FF_DEBUG_VIS_MV_B_BACK 0x00000004 //visualize backward predicted MVs of B frames
3536 * custom intra quantization matrix
3537 * - encoding: Set by user, can be NULL.
3538 * - decoding: unused.
3540 uint16_t *chroma_intra_matrix;
3543 * dump format separator.
3544 * can be ", " or "\n " or anything else
3545 * - encoding: Set by user.
3546 * - decoding: Set by user.
3548 uint8_t *dump_separator;
3551 * ',' separated list of allowed decoders.
3552 * If NULL then all are allowed
3553 * - encoding: unused
3554 * - decoding: set by user
3556 char *codec_whitelist;
3559 * Properties of the stream that gets decoded
3560 * - encoding: unused
3561 * - decoding: set by libavcodec
3563 unsigned properties;
3564 #define FF_CODEC_PROPERTY_LOSSLESS 0x00000001
3565 #define FF_CODEC_PROPERTY_CLOSED_CAPTIONS 0x00000002
3568 * Additional data associated with the entire coded stream.
3570 * - decoding: unused
3571 * - encoding: may be set by libavcodec after avcodec_open2().
3573 AVPacketSideData *coded_side_data;
3574 int nb_coded_side_data;
3577 * A reference to the AVHWFramesContext describing the input (for encoding)
3578 * or output (decoding) frames. The reference is set by the caller and
3579 * afterwards owned (and freed) by libavcodec - it should never be read by
3580 * the caller after being set.
3582 * - decoding: This field should be set by the caller from the get_format()
3583 * callback. The previous reference (if any) will always be
3584 * unreffed by libavcodec before the get_format() call.
3586 * If the default get_buffer2() is used with a hwaccel pixel
3587 * format, then this AVHWFramesContext will be used for
3588 * allocating the frame buffers.
3590 * - encoding: For hardware encoders configured to use a hwaccel pixel
3591 * format, this field should be set by the caller to a reference
3592 * to the AVHWFramesContext describing input frames.
3593 * AVHWFramesContext.format must be equal to
3594 * AVCodecContext.pix_fmt.
3596 * This field should be set before avcodec_open2() is called.
3598 AVBufferRef *hw_frames_ctx;
3601 * Control the form of AVSubtitle.rects[N]->ass
3602 * - decoding: set by user
3603 * - encoding: unused
3605 int sub_text_format;
3606 #define FF_SUB_TEXT_FMT_ASS 0
3607 #if FF_API_ASS_TIMING
3608 #define FF_SUB_TEXT_FMT_ASS_WITH_TIMINGS 1
3612 * Audio only. The amount of padding (in samples) appended by the encoder to
3613 * the end of the audio. I.e. this number of decoded samples must be
3614 * discarded by the caller from the end of the stream to get the original
3615 * audio without any trailing padding.
3617 * - decoding: unused
3618 * - encoding: unused
3620 int trailing_padding;
3623 * The number of pixels per image to maximally accept.
3625 * - decoding: set by user
3626 * - encoding: set by user
3631 * A reference to the AVHWDeviceContext describing the device which will
3632 * be used by a hardware encoder/decoder. The reference is set by the
3633 * caller and afterwards owned (and freed) by libavcodec.
3635 * This should be used if either the codec device does not require
3636 * hardware frames or any that are used are to be allocated internally by
3637 * libavcodec. If the user wishes to supply any of the frames used as
3638 * encoder input or decoder output then hw_frames_ctx should be used
3639 * instead. When hw_frames_ctx is set in get_format() for a decoder, this
3640 * field will be ignored while decoding the associated stream segment, but
3641 * may again be used on a following one after another get_format() call.
3643 * For both encoders and decoders this field should be set before
3644 * avcodec_open2() is called and must not be written to thereafter.
3646 * Note that some decoders may require this field to be set initially in
3647 * order to support hw_frames_ctx at all - in that case, all frames
3648 * contexts used must be created on the same device.
3650 AVBufferRef *hw_device_ctx;
3653 * Bit set of AV_HWACCEL_FLAG_* flags, which affect hardware accelerated
3654 * decoding (if active).
3655 * - encoding: unused
3656 * - decoding: Set by user (either before avcodec_open2(), or in the
3657 * AVCodecContext.get_format callback)
3662 * Video decoding only. Certain video codecs support cropping, meaning that
3663 * only a sub-rectangle of the decoded frame is intended for display. This
3664 * option controls how cropping is handled by libavcodec.
3666 * When set to 1 (the default), libavcodec will apply cropping internally.
3667 * I.e. it will modify the output frame width/height fields and offset the
3668 * data pointers (only by as much as possible while preserving alignment, or
3669 * by the full amount if the AV_CODEC_FLAG_UNALIGNED flag is set) so that
3670 * the frames output by the decoder refer only to the cropped area. The
3671 * crop_* fields of the output frames will be zero.
3673 * When set to 0, the width/height fields of the output frames will be set
3674 * to the coded dimensions and the crop_* fields will describe the cropping
3675 * rectangle. Applying the cropping is left to the caller.
3677 * @warning When hardware acceleration with opaque output frames is used,
3678 * libavcodec is unable to apply cropping from the top/left border.
3680 * @note when this option is set to zero, the width/height fields of the
3681 * AVCodecContext and output AVFrames have different meanings. The codec
3682 * context fields store display dimensions (with the coded dimensions in
3683 * coded_width/height), while the frame fields store the coded dimensions
3684 * (with the display dimensions being determined by the crop_* fields).
3689 AVRational av_codec_get_pkt_timebase (const AVCodecContext *avctx);
3690 void av_codec_set_pkt_timebase (AVCodecContext *avctx, AVRational val);
3692 const AVCodecDescriptor *av_codec_get_codec_descriptor(const AVCodecContext *avctx);
3693 void av_codec_set_codec_descriptor(AVCodecContext *avctx, const AVCodecDescriptor *desc);
3695 unsigned av_codec_get_codec_properties(const AVCodecContext *avctx);
3697 int av_codec_get_lowres(const AVCodecContext *avctx);
3698 void av_codec_set_lowres(AVCodecContext *avctx, int val);
3700 int av_codec_get_seek_preroll(const AVCodecContext *avctx);
3701 void av_codec_set_seek_preroll(AVCodecContext *avctx, int val);
3703 uint16_t *av_codec_get_chroma_intra_matrix(const AVCodecContext *avctx);
3704 void av_codec_set_chroma_intra_matrix(AVCodecContext *avctx, uint16_t *val);
3709 typedef struct AVProfile {
3711 const char *name; ///< short name for the profile
3714 typedef struct AVCodecDefault AVCodecDefault;
3721 typedef struct AVCodec {
3723 * Name of the codec implementation.
3724 * The name is globally unique among encoders and among decoders (but an
3725 * encoder and a decoder can share the same name).
3726 * This is the primary way to find a codec from the user perspective.
3730 * Descriptive name for the codec, meant to be more human readable than name.
3731 * You should use the NULL_IF_CONFIG_SMALL() macro to define it.
3733 const char *long_name;
3734 enum AVMediaType type;
3737 * Codec capabilities.
3738 * see AV_CODEC_CAP_*
3741 const AVRational *supported_framerates; ///< array of supported framerates, or NULL if any, array is terminated by {0,0}
3742 const enum AVPixelFormat *pix_fmts; ///< array of supported pixel formats, or NULL if unknown, array is terminated by -1
3743 const int *supported_samplerates; ///< array of supported audio samplerates, or NULL if unknown, array is terminated by 0
3744 const enum AVSampleFormat *sample_fmts; ///< array of supported sample formats, or NULL if unknown, array is terminated by -1
3745 const uint64_t *channel_layouts; ///< array of support channel layouts, or NULL if unknown. array is terminated by 0
3746 uint8_t max_lowres; ///< maximum value for lowres supported by the decoder
3747 const AVClass *priv_class; ///< AVClass for the private context
3748 const AVProfile *profiles; ///< array of recognized profiles, or NULL if unknown, array is terminated by {FF_PROFILE_UNKNOWN}
3750 /*****************************************************************
3751 * No fields below this line are part of the public API. They
3752 * may not be used outside of libavcodec and can be changed and
3754 * New public fields should be added right above.
3755 *****************************************************************
3758 struct AVCodec *next;
3760 * @name Frame-level threading support functions
3764 * If defined, called on thread contexts when they are created.
3765 * If the codec allocates writable tables in init(), re-allocate them here.
3766 * priv_data will be set to a copy of the original.
3768 int (*init_thread_copy)(AVCodecContext *);
3770 * Copy necessary context variables from a previous thread context to the current one.
3771 * If not defined, the next thread will start automatically; otherwise, the codec
3772 * must call ff_thread_finish_setup().
3774 * dst and src will (rarely) point to the same context, in which case memcpy should be skipped.
3776 int (*update_thread_context)(AVCodecContext *dst, const AVCodecContext *src);
3780 * Private codec-specific defaults.
3782 const AVCodecDefault *defaults;
3785 * Initialize codec static data, called from avcodec_register().
3787 void (*init_static_data)(struct AVCodec *codec);
3789 int (*init)(AVCodecContext *);
3790 int (*encode_sub)(AVCodecContext *, uint8_t *buf, int buf_size,
3791 const struct AVSubtitle *sub);
3793 * Encode data to an AVPacket.
3795 * @param avctx codec context
3796 * @param avpkt output AVPacket (may contain a user-provided buffer)
3797 * @param[in] frame AVFrame containing the raw data to be encoded
3798 * @param[out] got_packet_ptr encoder sets to 0 or 1 to indicate that a
3799 * non-empty packet was returned in avpkt.
3800 * @return 0 on success, negative error code on failure
3802 int (*encode2)(AVCodecContext *avctx, AVPacket *avpkt, const AVFrame *frame,
3803 int *got_packet_ptr);
3804 int (*decode)(AVCodecContext *, void *outdata, int *outdata_size, AVPacket *avpkt);
3805 int (*close)(AVCodecContext *);
3807 * Encode API with decoupled packet/frame dataflow. The API is the
3808 * same as the avcodec_ prefixed APIs (avcodec_send_frame() etc.), except
3810 * - never called if the codec is closed or the wrong type,
3811 * - if AV_CODEC_CAP_DELAY is not set, drain frames are never sent,
3812 * - only one drain frame is ever passed down,
3814 int (*send_frame)(AVCodecContext *avctx, const AVFrame *frame);
3815 int (*receive_packet)(AVCodecContext *avctx, AVPacket *avpkt);
3818 * Decode API with decoupled packet/frame dataflow. This function is called
3819 * to get one output frame. It should call ff_decode_get_packet() to obtain
3822 int (*receive_frame)(AVCodecContext *avctx, AVFrame *frame);
3825 * Will be called when seeking
3827 void (*flush)(AVCodecContext *);
3829 * Internal codec capabilities.
3830 * See FF_CODEC_CAP_* in internal.h
3835 * Decoding only, a comma-separated list of bitstream filters to apply to
3836 * packets before decoding.
3841 int av_codec_get_max_lowres(const AVCodec *codec);
3843 struct MpegEncContext;
3846 * @defgroup lavc_hwaccel AVHWAccel
3849 typedef struct AVHWAccel {
3851 * Name of the hardware accelerated codec.
3852 * The name is globally unique among encoders and among decoders (but an
3853 * encoder and a decoder can share the same name).
3858 * Type of codec implemented by the hardware accelerator.
3860 * See AVMEDIA_TYPE_xxx
3862 enum AVMediaType type;
3865 * Codec implemented by the hardware accelerator.
3867 * See AV_CODEC_ID_xxx
3872 * Supported pixel format.
3874 * Only hardware accelerated formats are supported here.
3876 enum AVPixelFormat pix_fmt;
3879 * Hardware accelerated codec capabilities.
3880 * see HWACCEL_CODEC_CAP_*
3884 /*****************************************************************
3885 * No fields below this line are part of the public API. They
3886 * may not be used outside of libavcodec and can be changed and
3888 * New public fields should be added right above.
3889 *****************************************************************
3891 struct AVHWAccel *next;
3894 * Allocate a custom buffer
3896 int (*alloc_frame)(AVCodecContext *avctx, AVFrame *frame);
3899 * Called at the beginning of each frame or field picture.
3901 * Meaningful frame information (codec specific) is guaranteed to
3902 * be parsed at this point. This function is mandatory.
3904 * Note that buf can be NULL along with buf_size set to 0.
3905 * Otherwise, this means the whole frame is available at this point.
3907 * @param avctx the codec context
3908 * @param buf the frame data buffer base
3909 * @param buf_size the size of the frame in bytes
3910 * @return zero if successful, a negative value otherwise
3912 int (*start_frame)(AVCodecContext *avctx, const uint8_t *buf, uint32_t buf_size);
3915 * Callback for each slice.
3917 * Meaningful slice information (codec specific) is guaranteed to
3918 * be parsed at this point. This function is mandatory.
3919 * The only exception is XvMC, that works on MB level.
3921 * @param avctx the codec context
3922 * @param buf the slice data buffer base
3923 * @param buf_size the size of the slice in bytes
3924 * @return zero if successful, a negative value otherwise
3926 int (*decode_slice)(AVCodecContext *avctx, const uint8_t *buf, uint32_t buf_size);
3929 * Called at the end of each frame or field picture.
3931 * The whole picture is parsed at this point and can now be sent
3932 * to the hardware accelerator. This function is mandatory.
3934 * @param avctx the codec context
3935 * @return zero if successful, a negative value otherwise
3937 int (*end_frame)(AVCodecContext *avctx);
3940 * Size of per-frame hardware accelerator private data.
3942 * Private data is allocated with av_mallocz() before
3943 * AVCodecContext.get_buffer() and deallocated after
3944 * AVCodecContext.release_buffer().
3946 int frame_priv_data_size;
3949 * Called for every Macroblock in a slice.
3951 * XvMC uses it to replace the ff_mpv_reconstruct_mb().
3952 * Instead of decoding to raw picture, MB parameters are
3953 * stored in an array provided by the video driver.
3955 * @param s the mpeg context
3957 void (*decode_mb)(struct MpegEncContext *s);
3960 * Initialize the hwaccel private data.
3962 * This will be called from ff_get_format(), after hwaccel and
3963 * hwaccel_context are set and the hwaccel private data in AVCodecInternal
3966 int (*init)(AVCodecContext *avctx);
3969 * Uninitialize the hwaccel private data.
3971 * This will be called from get_format() or avcodec_close(), after hwaccel
3972 * and hwaccel_context are already uninitialized.
3974 int (*uninit)(AVCodecContext *avctx);
3977 * Size of the private data to allocate in
3978 * AVCodecInternal.hwaccel_priv_data.
3983 * Internal hwaccel capabilities.
3989 * Hardware acceleration should be used for decoding even if the codec level
3990 * used is unknown or higher than the maximum supported level reported by the
3993 * It's generally a good idea to pass this flag unless you have a specific
3994 * reason not to, as hardware tends to under-report supported levels.
3996 #define AV_HWACCEL_FLAG_IGNORE_LEVEL (1 << 0)
3999 * Hardware acceleration can output YUV pixel formats with a different chroma
4000 * sampling than 4:2:0 and/or other than 8 bits per component.
4002 #define AV_HWACCEL_FLAG_ALLOW_HIGH_DEPTH (1 << 1)
4005 * Hardware acceleration should still be attempted for decoding when the
4006 * codec profile does not match the reported capabilities of the hardware.
4008 * For example, this can be used to try to decode baseline profile H.264
4009 * streams in hardware - it will often succeed, because many streams marked
4010 * as baseline profile actually conform to constrained baseline profile.
4012 * @warning If the stream is actually not supported then the behaviour is
4013 * undefined, and may include returning entirely incorrect output
4014 * while indicating success.
4016 #define AV_HWACCEL_FLAG_ALLOW_PROFILE_MISMATCH (1 << 2)
4022 #if FF_API_AVPICTURE
4024 * @defgroup lavc_picture AVPicture
4026 * Functions for working with AVPicture
4031 * Picture data structure.
4033 * Up to four components can be stored into it, the last component is
4035 * @deprecated use AVFrame or imgutils functions instead
4037 typedef struct AVPicture {
4038 attribute_deprecated
4039 uint8_t *data[AV_NUM_DATA_POINTERS]; ///< pointers to the image data planes
4040 attribute_deprecated
4041 int linesize[AV_NUM_DATA_POINTERS]; ///< number of bytes per line
4049 enum AVSubtitleType {
4052 SUBTITLE_BITMAP, ///< A bitmap, pict will be set
4055 * Plain text, the text field must be set by the decoder and is
4056 * authoritative. ass and pict fields may contain approximations.
4061 * Formatted text, the ass field must be set by the decoder and is
4062 * authoritative. pict and text fields may contain approximations.
4067 #define AV_SUBTITLE_FLAG_FORCED 0x00000001
4069 typedef struct AVSubtitleRect {
4070 int x; ///< top left corner of pict, undefined when pict is not set
4071 int y; ///< top left corner of pict, undefined when pict is not set
4072 int w; ///< width of pict, undefined when pict is not set
4073 int h; ///< height of pict, undefined when pict is not set
4074 int nb_colors; ///< number of colors in pict, undefined when pict is not set
4076 #if FF_API_AVPICTURE
4078 * @deprecated unused
4080 attribute_deprecated
4084 * data+linesize for the bitmap of this subtitle.
4085 * Can be set for text/ass as well once they are rendered.
4090 enum AVSubtitleType type;
4092 char *text; ///< 0 terminated plain UTF-8 text
4095 * 0 terminated ASS/SSA compatible event line.
4096 * The presentation of this is unaffected by the other values in this
4104 typedef struct AVSubtitle {
4105 uint16_t format; /* 0 = graphics */
4106 uint32_t start_display_time; /* relative to packet pts, in ms */
4107 uint32_t end_display_time; /* relative to packet pts, in ms */
4109 AVSubtitleRect **rects;
4110 int64_t pts; ///< Same as packet pts, in AV_TIME_BASE
4114 * This struct describes the properties of an encoded stream.
4116 * sizeof(AVCodecParameters) is not a part of the public ABI, this struct must
4117 * be allocated with avcodec_parameters_alloc() and freed with
4118 * avcodec_parameters_free().
4120 typedef struct AVCodecParameters {
4122 * General type of the encoded data.
4124 enum AVMediaType codec_type;
4126 * Specific type of the encoded data (the codec used).
4128 enum AVCodecID codec_id;
4130 * Additional information about the codec (corresponds to the AVI FOURCC).
4135 * Extra binary data needed for initializing the decoder, codec-dependent.
4137 * Must be allocated with av_malloc() and will be freed by
4138 * avcodec_parameters_free(). The allocated size of extradata must be at
4139 * least extradata_size + AV_INPUT_BUFFER_PADDING_SIZE, with the padding
4144 * Size of the extradata content in bytes.
4149 * - video: the pixel format, the value corresponds to enum AVPixelFormat.
4150 * - audio: the sample format, the value corresponds to enum AVSampleFormat.
4155 * The average bitrate of the encoded data (in bits per second).
4160 * The number of bits per sample in the codedwords.
4162 * This is basically the bitrate per sample. It is mandatory for a bunch of
4163 * formats to actually decode them. It's the number of bits for one sample in
4164 * the actual coded bitstream.
4166 * This could be for example 4 for ADPCM
4167 * For PCM formats this matches bits_per_raw_sample
4170 int bits_per_coded_sample;
4173 * This is the number of valid bits in each output sample. If the
4174 * sample format has more bits, the least significant bits are additional
4175 * padding bits, which are always 0. Use right shifts to reduce the sample
4176 * to its actual size. For example, audio formats with 24 bit samples will
4177 * have bits_per_raw_sample set to 24, and format set to AV_SAMPLE_FMT_S32.
4178 * To get the original sample use "(int32_t)sample >> 8"."
4180 * For ADPCM this might be 12 or 16 or similar
4183 int bits_per_raw_sample;
4186 * Codec-specific bitstream restrictions that the stream conforms to.
4192 * Video only. The dimensions of the video frame in pixels.
4198 * Video only. The aspect ratio (width / height) which a single pixel
4199 * should have when displayed.
4201 * When the aspect ratio is unknown / undefined, the numerator should be
4202 * set to 0 (the denominator may have any value).
4204 AVRational sample_aspect_ratio;
4207 * Video only. The order of the fields in interlaced video.
4209 enum AVFieldOrder field_order;
4212 * Video only. Additional colorspace characteristics.
4214 enum AVColorRange color_range;
4215 enum AVColorPrimaries color_primaries;
4216 enum AVColorTransferCharacteristic color_trc;
4217 enum AVColorSpace color_space;
4218 enum AVChromaLocation chroma_location;
4221 * Video only. Number of delayed frames.
4226 * Audio only. The channel layout bitmask. May be 0 if the channel layout is
4227 * unknown or unspecified, otherwise the number of bits set must be equal to
4228 * the channels field.
4230 uint64_t channel_layout;
4232 * Audio only. The number of audio channels.
4236 * Audio only. The number of audio samples per second.
4240 * Audio only. The number of bytes per coded audio frame, required by some
4243 * Corresponds to nBlockAlign in WAVEFORMATEX.
4247 * Audio only. Audio frame size, if known. Required by some formats to be static.
4252 * Audio only. The amount of padding (in samples) inserted by the encoder at
4253 * the beginning of the audio. I.e. this number of leading decoded samples
4254 * must be discarded by the caller to get the original audio without leading
4257 int initial_padding;
4259 * Audio only. The amount of padding (in samples) appended by the encoder to
4260 * the end of the audio. I.e. this number of decoded samples must be
4261 * discarded by the caller from the end of the stream to get the original
4262 * audio without any trailing padding.
4264 int trailing_padding;
4266 * Audio only. Number of samples to skip after a discontinuity.
4269 } AVCodecParameters;
4272 * If c is NULL, returns the first registered codec,
4273 * if c is non-NULL, returns the next registered codec after c,
4274 * or NULL if c is the last one.
4276 AVCodec *av_codec_next(const AVCodec *c);
4279 * Return the LIBAVCODEC_VERSION_INT constant.
4281 unsigned avcodec_version(void);
4284 * Return the libavcodec build-time configuration.
4286 const char *avcodec_configuration(void);
4289 * Return the libavcodec license.
4291 const char *avcodec_license(void);
4294 * Register the codec codec and initialize libavcodec.
4296 * @warning either this function or avcodec_register_all() must be called
4297 * before any other libavcodec functions.
4299 * @see avcodec_register_all()
4301 void avcodec_register(AVCodec *codec);
4304 * Register all the codecs, parsers and bitstream filters which were enabled at
4305 * configuration time. If you do not call this function you can select exactly
4306 * which formats you want to support, by using the individual registration
4309 * @see avcodec_register
4310 * @see av_register_codec_parser
4311 * @see av_register_bitstream_filter
4313 void avcodec_register_all(void);
4316 * Allocate an AVCodecContext and set its fields to default values. The
4317 * resulting struct should be freed with avcodec_free_context().
4319 * @param codec if non-NULL, allocate private data and initialize defaults
4320 * for the given codec. It is illegal to then call avcodec_open2()
4321 * with a different codec.
4322 * If NULL, then the codec-specific defaults won't be initialized,
4323 * which may result in suboptimal default settings (this is
4324 * important mainly for encoders, e.g. libx264).
4326 * @return An AVCodecContext filled with default values or NULL on failure.
4328 AVCodecContext *avcodec_alloc_context3(const AVCodec *codec);
4331 * Free the codec context and everything associated with it and write NULL to
4332 * the provided pointer.
4334 void avcodec_free_context(AVCodecContext **avctx);
4336 #if FF_API_GET_CONTEXT_DEFAULTS
4338 * @deprecated This function should not be used, as closing and opening a codec
4339 * context multiple time is not supported. A new codec context should be
4340 * allocated for each new use.
4342 int avcodec_get_context_defaults3(AVCodecContext *s, const AVCodec *codec);
4346 * Get the AVClass for AVCodecContext. It can be used in combination with
4347 * AV_OPT_SEARCH_FAKE_OBJ for examining options.
4349 * @see av_opt_find().
4351 const AVClass *avcodec_get_class(void);
4353 #if FF_API_COPY_CONTEXT
4355 * Get the AVClass for AVFrame. It can be used in combination with
4356 * AV_OPT_SEARCH_FAKE_OBJ for examining options.
4358 * @see av_opt_find().
4360 const AVClass *avcodec_get_frame_class(void);
4363 * Get the AVClass for AVSubtitleRect. It can be used in combination with
4364 * AV_OPT_SEARCH_FAKE_OBJ for examining options.
4366 * @see av_opt_find().
4368 const AVClass *avcodec_get_subtitle_rect_class(void);
4371 * Copy the settings of the source AVCodecContext into the destination
4372 * AVCodecContext. The resulting destination codec context will be
4373 * unopened, i.e. you are required to call avcodec_open2() before you
4374 * can use this AVCodecContext to decode/encode video/audio data.
4376 * @param dest target codec context, should be initialized with
4377 * avcodec_alloc_context3(NULL), but otherwise uninitialized
4378 * @param src source codec context
4379 * @return AVERROR() on error (e.g. memory allocation error), 0 on success
4381 * @deprecated The semantics of this function are ill-defined and it should not
4382 * be used. If you need to transfer the stream parameters from one codec context
4383 * to another, use an intermediate AVCodecParameters instance and the
4384 * avcodec_parameters_from_context() / avcodec_parameters_to_context()
4387 attribute_deprecated
4388 int avcodec_copy_context(AVCodecContext *dest, const AVCodecContext *src);
4392 * Allocate a new AVCodecParameters and set its fields to default values
4393 * (unknown/invalid/0). The returned struct must be freed with
4394 * avcodec_parameters_free().
4396 AVCodecParameters *avcodec_parameters_alloc(void);
4399 * Free an AVCodecParameters instance and everything associated with it and
4400 * write NULL to the supplied pointer.
4402 void avcodec_parameters_free(AVCodecParameters **par);
4405 * Copy the contents of src to dst. Any allocated fields in dst are freed and
4406 * replaced with newly allocated duplicates of the corresponding fields in src.
4408 * @return >= 0 on success, a negative AVERROR code on failure.
4410 int avcodec_parameters_copy(AVCodecParameters *dst, const AVCodecParameters *src);
4413 * Fill the parameters struct based on the values from the supplied codec
4414 * context. Any allocated fields in par are freed and replaced with duplicates
4415 * of the corresponding fields in codec.
4417 * @return >= 0 on success, a negative AVERROR code on failure
4419 int avcodec_parameters_from_context(AVCodecParameters *par,
4420 const AVCodecContext *codec);
4423 * Fill the codec context based on the values from the supplied codec
4424 * parameters. Any allocated fields in codec that have a corresponding field in
4425 * par are freed and replaced with duplicates of the corresponding field in par.
4426 * Fields in codec that do not have a counterpart in par are not touched.
4428 * @return >= 0 on success, a negative AVERROR code on failure.
4430 int avcodec_parameters_to_context(AVCodecContext *codec,
4431 const AVCodecParameters *par);
4434 * Initialize the AVCodecContext to use the given AVCodec. Prior to using this
4435 * function the context has to be allocated with avcodec_alloc_context3().
4437 * The functions avcodec_find_decoder_by_name(), avcodec_find_encoder_by_name(),
4438 * avcodec_find_decoder() and avcodec_find_encoder() provide an easy way for
4439 * retrieving a codec.
4441 * @warning This function is not thread safe!
4443 * @note Always call this function before using decoding routines (such as
4444 * @ref avcodec_receive_frame()).
4447 * avcodec_register_all();
4448 * av_dict_set(&opts, "b", "2.5M", 0);
4449 * codec = avcodec_find_decoder(AV_CODEC_ID_H264);
4453 * context = avcodec_alloc_context3(codec);
4455 * if (avcodec_open2(context, codec, opts) < 0)
4459 * @param avctx The context to initialize.
4460 * @param codec The codec to open this context for. If a non-NULL codec has been
4461 * previously passed to avcodec_alloc_context3() or
4462 * for this context, then this parameter MUST be either NULL or
4463 * equal to the previously passed codec.
4464 * @param options A dictionary filled with AVCodecContext and codec-private options.
4465 * On return this object will be filled with options that were not found.
4467 * @return zero on success, a negative value on error
4468 * @see avcodec_alloc_context3(), avcodec_find_decoder(), avcodec_find_encoder(),
4469 * av_dict_set(), av_opt_find().
4471 int avcodec_open2(AVCodecContext *avctx, const AVCodec *codec, AVDictionary **options);
4474 * Close a given AVCodecContext and free all the data associated with it
4475 * (but not the AVCodecContext itself).
4477 * Calling this function on an AVCodecContext that hasn't been opened will free
4478 * the codec-specific data allocated in avcodec_alloc_context3() with a non-NULL
4479 * codec. Subsequent calls will do nothing.
4481 * @note Do not use this function. Use avcodec_free_context() to destroy a
4482 * codec context (either open or closed). Opening and closing a codec context
4483 * multiple times is not supported anymore -- use multiple codec contexts
4486 int avcodec_close(AVCodecContext *avctx);
4489 * Free all allocated data in the given subtitle struct.
4491 * @param sub AVSubtitle to free.
4493 void avsubtitle_free(AVSubtitle *sub);
4500 * @addtogroup lavc_packet
4505 * Allocate an AVPacket and set its fields to default values. The resulting
4506 * struct must be freed using av_packet_free().
4508 * @return An AVPacket filled with default values or NULL on failure.
4510 * @note this only allocates the AVPacket itself, not the data buffers. Those
4511 * must be allocated through other means such as av_new_packet.
4513 * @see av_new_packet
4515 AVPacket *av_packet_alloc(void);
4518 * Create a new packet that references the same data as src.
4520 * This is a shortcut for av_packet_alloc()+av_packet_ref().
4522 * @return newly created AVPacket on success, NULL on error.
4524 * @see av_packet_alloc
4525 * @see av_packet_ref
4527 AVPacket *av_packet_clone(const AVPacket *src);
4530 * Free the packet, if the packet is reference counted, it will be
4531 * unreferenced first.
4533 * @param pkt packet to be freed. The pointer will be set to NULL.
4534 * @note passing NULL is a no-op.
4536 void av_packet_free(AVPacket **pkt);
4539 * Initialize optional fields of a packet with default values.
4541 * Note, this does not touch the data and size members, which have to be
4542 * initialized separately.
4546 void av_init_packet(AVPacket *pkt);
4549 * Allocate the payload of a packet and initialize its fields with
4553 * @param size wanted payload size
4554 * @return 0 if OK, AVERROR_xxx otherwise
4556 int av_new_packet(AVPacket *pkt, int size);
4559 * Reduce packet size, correctly zeroing padding
4562 * @param size new size
4564 void av_shrink_packet(AVPacket *pkt, int size);
4567 * Increase packet size, correctly zeroing padding
4570 * @param grow_by number of bytes by which to increase the size of the packet
4572 int av_grow_packet(AVPacket *pkt, int grow_by);
4575 * Initialize a reference-counted packet from av_malloc()ed data.
4577 * @param pkt packet to be initialized. This function will set the data, size,
4578 * buf and destruct fields, all others are left untouched.
4579 * @param data Data allocated by av_malloc() to be used as packet data. If this
4580 * function returns successfully, the data is owned by the underlying AVBuffer.
4581 * The caller may not access the data through other means.
4582 * @param size size of data in bytes, without the padding. I.e. the full buffer
4583 * size is assumed to be size + AV_INPUT_BUFFER_PADDING_SIZE.
4585 * @return 0 on success, a negative AVERROR on error
4587 int av_packet_from_data(AVPacket *pkt, uint8_t *data, int size);
4589 #if FF_API_AVPACKET_OLD_API
4591 * @warning This is a hack - the packet memory allocation stuff is broken. The
4592 * packet is allocated if it was not really allocated.
4594 * @deprecated Use av_packet_ref
4596 attribute_deprecated
4597 int av_dup_packet(AVPacket *pkt);
4599 * Copy packet, including contents
4601 * @return 0 on success, negative AVERROR on fail
4603 int av_copy_packet(AVPacket *dst, const AVPacket *src);
4606 * Copy packet side data
4608 * @return 0 on success, negative AVERROR on fail
4610 int av_copy_packet_side_data(AVPacket *dst, const AVPacket *src);
4615 * @deprecated Use av_packet_unref
4617 * @param pkt packet to free
4619 attribute_deprecated
4620 void av_free_packet(AVPacket *pkt);
4623 * Allocate new information of a packet.
4626 * @param type side information type
4627 * @param size side information size
4628 * @return pointer to fresh allocated data or NULL otherwise
4630 uint8_t* av_packet_new_side_data(AVPacket *pkt, enum AVPacketSideDataType type,
4634 * Wrap an existing array as a packet side data.
4637 * @param type side information type
4638 * @param data the side data array. It must be allocated with the av_malloc()
4639 * family of functions. The ownership of the data is transferred to
4641 * @param size side information size
4642 * @return a non-negative number on success, a negative AVERROR code on
4643 * failure. On failure, the packet is unchanged and the data remains
4644 * owned by the caller.
4646 int av_packet_add_side_data(AVPacket *pkt, enum AVPacketSideDataType type,
4647 uint8_t *data, size_t size);
4650 * Shrink the already allocated side data buffer
4653 * @param type side information type
4654 * @param size new side information size
4655 * @return 0 on success, < 0 on failure
4657 int av_packet_shrink_side_data(AVPacket *pkt, enum AVPacketSideDataType type,
4661 * Get side information from packet.
4664 * @param type desired side information type
4665 * @param size pointer for side information size to store (optional)
4666 * @return pointer to data if present or NULL otherwise
4668 uint8_t* av_packet_get_side_data(const AVPacket *pkt, enum AVPacketSideDataType type,
4671 #if FF_API_MERGE_SD_API
4672 attribute_deprecated
4673 int av_packet_merge_side_data(AVPacket *pkt);
4675 attribute_deprecated
4676 int av_packet_split_side_data(AVPacket *pkt);
4679 const char *av_packet_side_data_name(enum AVPacketSideDataType type);
4682 * Pack a dictionary for use in side_data.
4684 * @param dict The dictionary to pack.
4685 * @param size pointer to store the size of the returned data
4686 * @return pointer to data if successful, NULL otherwise
4688 uint8_t *av_packet_pack_dictionary(AVDictionary *dict, int *size);
4690 * Unpack a dictionary from side_data.
4692 * @param data data from side_data
4693 * @param size size of the data
4694 * @param dict the metadata storage dictionary
4695 * @return 0 on success, < 0 on failure
4697 int av_packet_unpack_dictionary(const uint8_t *data, int size, AVDictionary **dict);
4701 * Convenience function to free all the side data stored.
4702 * All the other fields stay untouched.
4706 void av_packet_free_side_data(AVPacket *pkt);
4709 * Setup a new reference to the data described by a given packet
4711 * If src is reference-counted, setup dst as a new reference to the
4712 * buffer in src. Otherwise allocate a new buffer in dst and copy the
4713 * data from src into it.
4715 * All the other fields are copied from src.
4717 * @see av_packet_unref
4719 * @param dst Destination packet
4720 * @param src Source packet
4722 * @return 0 on success, a negative AVERROR on error.
4724 int av_packet_ref(AVPacket *dst, const AVPacket *src);
4729 * Unreference the buffer referenced by the packet and reset the
4730 * remaining packet fields to their default values.
4732 * @param pkt The packet to be unreferenced.
4734 void av_packet_unref(AVPacket *pkt);
4737 * Move every field in src to dst and reset src.
4739 * @see av_packet_unref
4741 * @param src Source packet, will be reset
4742 * @param dst Destination packet
4744 void av_packet_move_ref(AVPacket *dst, AVPacket *src);
4747 * Copy only "properties" fields from src to dst.
4749 * Properties for the purpose of this function are all the fields
4750 * beside those related to the packet data (buf, data, size)
4752 * @param dst Destination packet
4753 * @param src Source packet
4755 * @return 0 on success AVERROR on failure.
4757 int av_packet_copy_props(AVPacket *dst, const AVPacket *src);
4760 * Convert valid timing fields (timestamps / durations) in a packet from one
4761 * timebase to another. Timestamps with unknown values (AV_NOPTS_VALUE) will be
4764 * @param pkt packet on which the conversion will be performed
4765 * @param tb_src source timebase, in which the timing fields in pkt are
4767 * @param tb_dst destination timebase, to which the timing fields will be
4770 void av_packet_rescale_ts(AVPacket *pkt, AVRational tb_src, AVRational tb_dst);
4777 * @addtogroup lavc_decoding
4782 * Find a registered decoder with a matching codec ID.
4784 * @param id AVCodecID of the requested decoder
4785 * @return A decoder if one was found, NULL otherwise.
4787 AVCodec *avcodec_find_decoder(enum AVCodecID id);
4790 * Find a registered decoder with the specified name.
4792 * @param name name of the requested decoder
4793 * @return A decoder if one was found, NULL otherwise.
4795 AVCodec *avcodec_find_decoder_by_name(const char *name);
4798 * The default callback for AVCodecContext.get_buffer2(). It is made public so
4799 * it can be called by custom get_buffer2() implementations for decoders without
4800 * AV_CODEC_CAP_DR1 set.
4802 int avcodec_default_get_buffer2(AVCodecContext *s, AVFrame *frame, int flags);
4806 * Return the amount of padding in pixels which the get_buffer callback must
4807 * provide around the edge of the image for codecs which do not have the
4808 * CODEC_FLAG_EMU_EDGE flag.
4810 * @return Required padding in pixels.
4812 * @deprecated CODEC_FLAG_EMU_EDGE is deprecated, so this function is no longer
4815 attribute_deprecated
4816 unsigned avcodec_get_edge_width(void);
4820 * Modify width and height values so that they will result in a memory
4821 * buffer that is acceptable for the codec if you do not use any horizontal
4824 * May only be used if a codec with AV_CODEC_CAP_DR1 has been opened.
4826 void avcodec_align_dimensions(AVCodecContext *s, int *width, int *height);
4829 * Modify width and height values so that they will result in a memory
4830 * buffer that is acceptable for the codec if you also ensure that all
4831 * line sizes are a multiple of the respective linesize_align[i].
4833 * May only be used if a codec with AV_CODEC_CAP_DR1 has been opened.
4835 void avcodec_align_dimensions2(AVCodecContext *s, int *width, int *height,
4836 int linesize_align[AV_NUM_DATA_POINTERS]);
4839 * Converts AVChromaLocation to swscale x/y chroma position.
4841 * The positions represent the chroma (0,0) position in a coordinates system
4842 * with luma (0,0) representing the origin and luma(1,1) representing 256,256
4844 * @param xpos horizontal chroma sample position
4845 * @param ypos vertical chroma sample position
4847 int avcodec_enum_to_chroma_pos(int *xpos, int *ypos, enum AVChromaLocation pos);
4850 * Converts swscale x/y chroma position to AVChromaLocation.
4852 * The positions represent the chroma (0,0) position in a coordinates system
4853 * with luma (0,0) representing the origin and luma(1,1) representing 256,256
4855 * @param xpos horizontal chroma sample position
4856 * @param ypos vertical chroma sample position
4858 enum AVChromaLocation avcodec_chroma_pos_to_enum(int xpos, int ypos);
4861 * Decode the audio frame of size avpkt->size from avpkt->data into frame.
4863 * Some decoders may support multiple frames in a single AVPacket. Such
4864 * decoders would then just decode the first frame and the return value would be
4865 * less than the packet size. In this case, avcodec_decode_audio4 has to be
4866 * called again with an AVPacket containing the remaining data in order to
4867 * decode the second frame, etc... Even if no frames are returned, the packet
4868 * needs to be fed to the decoder with remaining data until it is completely
4869 * consumed or an error occurs.
4871 * Some decoders (those marked with AV_CODEC_CAP_DELAY) have a delay between input
4872 * and output. This means that for some packets they will not immediately
4873 * produce decoded output and need to be flushed at the end of decoding to get
4874 * all the decoded data. Flushing is done by calling this function with packets
4875 * with avpkt->data set to NULL and avpkt->size set to 0 until it stops
4876 * returning samples. It is safe to flush even those decoders that are not
4877 * marked with AV_CODEC_CAP_DELAY, then no samples will be returned.
4879 * @warning The input buffer, avpkt->data must be AV_INPUT_BUFFER_PADDING_SIZE
4880 * larger than the actual read bytes because some optimized bitstream
4881 * readers read 32 or 64 bits at once and could read over the end.
4883 * @note The AVCodecContext MUST have been opened with @ref avcodec_open2()
4884 * before packets may be fed to the decoder.
4886 * @param avctx the codec context
4887 * @param[out] frame The AVFrame in which to store decoded audio samples.
4888 * The decoder will allocate a buffer for the decoded frame by
4889 * calling the AVCodecContext.get_buffer2() callback.
4890 * When AVCodecContext.refcounted_frames is set to 1, the frame is
4891 * reference counted and the returned reference belongs to the
4892 * caller. The caller must release the frame using av_frame_unref()
4893 * when the frame is no longer needed. The caller may safely write
4894 * to the frame if av_frame_is_writable() returns 1.
4895 * When AVCodecContext.refcounted_frames is set to 0, the returned
4896 * reference belongs to the decoder and is valid only until the
4897 * next call to this function or until closing or flushing the
4898 * decoder. The caller may not write to it.
4899 * @param[out] got_frame_ptr Zero if no frame could be decoded, otherwise it is
4900 * non-zero. Note that this field being set to zero
4901 * does not mean that an error has occurred. For
4902 * decoders with AV_CODEC_CAP_DELAY set, no given decode
4903 * call is guaranteed to produce a frame.
4904 * @param[in] avpkt The input AVPacket containing the input buffer.
4905 * At least avpkt->data and avpkt->size should be set. Some
4906 * decoders might also require additional fields to be set.
4907 * @return A negative error code is returned if an error occurred during
4908 * decoding, otherwise the number of bytes consumed from the input
4909 * AVPacket is returned.
4911 * @deprecated Use avcodec_send_packet() and avcodec_receive_frame().
4913 attribute_deprecated
4914 int avcodec_decode_audio4(AVCodecContext *avctx, AVFrame *frame,
4915 int *got_frame_ptr, const AVPacket *avpkt);
4918 * Decode the video frame of size avpkt->size from avpkt->data into picture.
4919 * Some decoders may support multiple frames in a single AVPacket, such
4920 * decoders would then just decode the first frame.
4922 * @warning The input buffer must be AV_INPUT_BUFFER_PADDING_SIZE larger than
4923 * the actual read bytes because some optimized bitstream readers read 32 or 64
4924 * bits at once and could read over the end.
4926 * @warning The end of the input buffer buf should be set to 0 to ensure that
4927 * no overreading happens for damaged MPEG streams.
4929 * @note Codecs which have the AV_CODEC_CAP_DELAY capability set have a delay
4930 * between input and output, these need to be fed with avpkt->data=NULL,
4931 * avpkt->size=0 at the end to return the remaining frames.
4933 * @note The AVCodecContext MUST have been opened with @ref avcodec_open2()
4934 * before packets may be fed to the decoder.
4936 * @param avctx the codec context
4937 * @param[out] picture The AVFrame in which the decoded video frame will be stored.
4938 * Use av_frame_alloc() to get an AVFrame. The codec will
4939 * allocate memory for the actual bitmap by calling the
4940 * AVCodecContext.get_buffer2() callback.
4941 * When AVCodecContext.refcounted_frames is set to 1, the frame is
4942 * reference counted and the returned reference belongs to the
4943 * caller. The caller must release the frame using av_frame_unref()
4944 * when the frame is no longer needed. The caller may safely write
4945 * to the frame if av_frame_is_writable() returns 1.
4946 * When AVCodecContext.refcounted_frames is set to 0, the returned
4947 * reference belongs to the decoder and is valid only until the
4948 * next call to this function or until closing or flushing the
4949 * decoder. The caller may not write to it.
4951 * @param[in] avpkt The input AVPacket containing the input buffer.
4952 * You can create such packet with av_init_packet() and by then setting
4953 * data and size, some decoders might in addition need other fields like
4954 * flags&AV_PKT_FLAG_KEY. All decoders are designed to use the least
4956 * @param[in,out] got_picture_ptr Zero if no frame could be decompressed, otherwise, it is nonzero.
4957 * @return On error a negative value is returned, otherwise the number of bytes
4958 * used or zero if no frame could be decompressed.
4960 * @deprecated Use avcodec_send_packet() and avcodec_receive_frame().
4962 attribute_deprecated
4963 int avcodec_decode_video2(AVCodecContext *avctx, AVFrame *picture,
4964 int *got_picture_ptr,
4965 const AVPacket *avpkt);
4968 * Decode a subtitle message.
4969 * Return a negative value on error, otherwise return the number of bytes used.
4970 * If no subtitle could be decompressed, got_sub_ptr is zero.
4971 * Otherwise, the subtitle is stored in *sub.
4972 * Note that AV_CODEC_CAP_DR1 is not available for subtitle codecs. This is for
4973 * simplicity, because the performance difference is expect to be negligible
4974 * and reusing a get_buffer written for video codecs would probably perform badly
4975 * due to a potentially very different allocation pattern.
4977 * Some decoders (those marked with AV_CODEC_CAP_DELAY) have a delay between input
4978 * and output. This means that for some packets they will not immediately
4979 * produce decoded output and need to be flushed at the end of decoding to get
4980 * all the decoded data. Flushing is done by calling this function with packets
4981 * with avpkt->data set to NULL and avpkt->size set to 0 until it stops
4982 * returning subtitles. It is safe to flush even those decoders that are not
4983 * marked with AV_CODEC_CAP_DELAY, then no subtitles will be returned.
4985 * @note The AVCodecContext MUST have been opened with @ref avcodec_open2()
4986 * before packets may be fed to the decoder.
4988 * @param avctx the codec context
4989 * @param[out] sub The Preallocated AVSubtitle in which the decoded subtitle will be stored,
4990 * must be freed with avsubtitle_free if *got_sub_ptr is set.
4991 * @param[in,out] got_sub_ptr Zero if no subtitle could be decompressed, otherwise, it is nonzero.
4992 * @param[in] avpkt The input AVPacket containing the input buffer.
4994 int avcodec_decode_subtitle2(AVCodecContext *avctx, AVSubtitle *sub,
4999 * Supply raw packet data as input to a decoder.
5001 * Internally, this call will copy relevant AVCodecContext fields, which can
5002 * influence decoding per-packet, and apply them when the packet is actually
5003 * decoded. (For example AVCodecContext.skip_frame, which might direct the
5004 * decoder to drop the frame contained by the packet sent with this function.)
5006 * @warning The input buffer, avpkt->data must be AV_INPUT_BUFFER_PADDING_SIZE
5007 * larger than the actual read bytes because some optimized bitstream
5008 * readers read 32 or 64 bits at once and could read over the end.
5010 * @warning Do not mix this API with the legacy API (like avcodec_decode_video2())
5011 * on the same AVCodecContext. It will return unexpected results now
5012 * or in future libavcodec versions.
5014 * @note The AVCodecContext MUST have been opened with @ref avcodec_open2()
5015 * before packets may be fed to the decoder.
5017 * @param avctx codec context
5018 * @param[in] avpkt The input AVPacket. Usually, this will be a single video
5019 * frame, or several complete audio frames.
5020 * Ownership of the packet remains with the caller, and the
5021 * decoder will not write to the packet. The decoder may create
5022 * a reference to the packet data (or copy it if the packet is
5023 * not reference-counted).
5024 * Unlike with older APIs, the packet is always fully consumed,
5025 * and if it contains multiple frames (e.g. some audio codecs),
5026 * will require you to call avcodec_receive_frame() multiple
5027 * times afterwards before you can send a new packet.
5028 * It can be NULL (or an AVPacket with data set to NULL and
5029 * size set to 0); in this case, it is considered a flush
5030 * packet, which signals the end of the stream. Sending the
5031 * first flush packet will return success. Subsequent ones are
5032 * unnecessary and will return AVERROR_EOF. If the decoder
5033 * still has frames buffered, it will return them after sending
5036 * @return 0 on success, otherwise negative error code:
5037 * AVERROR(EAGAIN): input is not accepted in the current state - user
5038 * must read output with avcodec_receive_frame() (once
5039 * all output is read, the packet should be resent, and
5040 * the call will not fail with EAGAIN).
5041 * AVERROR_EOF: the decoder has been flushed, and no new packets can
5042 * be sent to it (also returned if more than 1 flush
5044 * AVERROR(EINVAL): codec not opened, it is an encoder, or requires flush
5045 * AVERROR(ENOMEM): failed to add packet to internal queue, or similar
5046 * other errors: legitimate decoding errors
5048 int avcodec_send_packet(AVCodecContext *avctx, const AVPacket *avpkt);
5051 * Return decoded output data from a decoder.
5053 * @param avctx codec context
5054 * @param frame This will be set to a reference-counted video or audio
5055 * frame (depending on the decoder type) allocated by the
5056 * decoder. Note that the function will always call
5057 * av_frame_unref(frame) before doing anything else.
5060 * 0: success, a frame was returned
5061 * AVERROR(EAGAIN): output is not available in this state - user must try
5063 * AVERROR_EOF: the decoder has been fully flushed, and there will be
5064 * no more output frames
5065 * AVERROR(EINVAL): codec not opened, or it is an encoder
5066 * other negative values: legitimate decoding errors
5068 int avcodec_receive_frame(AVCodecContext *avctx, AVFrame *frame);
5071 * Supply a raw video or audio frame to the encoder. Use avcodec_receive_packet()
5072 * to retrieve buffered output packets.
5074 * @param avctx codec context
5075 * @param[in] frame AVFrame containing the raw audio or video frame to be encoded.
5076 * Ownership of the frame remains with the caller, and the
5077 * encoder will not write to the frame. The encoder may create
5078 * a reference to the frame data (or copy it if the frame is
5079 * not reference-counted).
5080 * It can be NULL, in which case it is considered a flush
5081 * packet. This signals the end of the stream. If the encoder
5082 * still has packets buffered, it will return them after this
5083 * call. Once flushing mode has been entered, additional flush
5084 * packets are ignored, and sending frames will return
5088 * If AV_CODEC_CAP_VARIABLE_FRAME_SIZE is set, then each frame
5089 * can have any number of samples.
5090 * If it is not set, frame->nb_samples must be equal to
5091 * avctx->frame_size for all frames except the last.
5092 * The final frame may be smaller than avctx->frame_size.
5093 * @return 0 on success, otherwise negative error code:
5094 * AVERROR(EAGAIN): input is not accepted in the current state - user
5095 * must read output with avcodec_receive_packet() (once
5096 * all output is read, the packet should be resent, and
5097 * the call will not fail with EAGAIN).
5098 * AVERROR_EOF: the encoder has been flushed, and no new frames can
5100 * AVERROR(EINVAL): codec not opened, refcounted_frames not set, it is a
5101 * decoder, or requires flush
5102 * AVERROR(ENOMEM): failed to add packet to internal queue, or similar
5103 * other errors: legitimate decoding errors
5105 int avcodec_send_frame(AVCodecContext *avctx, const AVFrame *frame);
5108 * Read encoded data from the encoder.
5110 * @param avctx codec context
5111 * @param avpkt This will be set to a reference-counted packet allocated by the
5112 * encoder. Note that the function will always call
5113 * av_frame_unref(frame) before doing anything else.
5114 * @return 0 on success, otherwise negative error code:
5115 * AVERROR(EAGAIN): output is not available in the current state - user
5116 * must try to send input
5117 * AVERROR_EOF: the encoder has been fully flushed, and there will be
5118 * no more output packets
5119 * AVERROR(EINVAL): codec not opened, or it is an encoder
5120 * other errors: legitimate decoding errors
5122 int avcodec_receive_packet(AVCodecContext *avctx, AVPacket *avpkt);
5126 * @defgroup lavc_parsing Frame parsing
5130 enum AVPictureStructure {
5131 AV_PICTURE_STRUCTURE_UNKNOWN, //< unknown
5132 AV_PICTURE_STRUCTURE_TOP_FIELD, //< coded as top field
5133 AV_PICTURE_STRUCTURE_BOTTOM_FIELD, //< coded as bottom field
5134 AV_PICTURE_STRUCTURE_FRAME, //< coded as frame
5137 typedef struct AVCodecParserContext {
5139 struct AVCodecParser *parser;
5140 int64_t frame_offset; /* offset of the current frame */
5141 int64_t cur_offset; /* current offset
5142 (incremented by each av_parser_parse()) */
5143 int64_t next_frame_offset; /* offset of the next frame */
5145 int pict_type; /* XXX: Put it back in AVCodecContext. */
5147 * This field is used for proper frame duration computation in lavf.
5148 * It signals, how much longer the frame duration of the current frame
5149 * is compared to normal frame duration.
5151 * frame_duration = (1 + repeat_pict) * time_base
5153 * It is used by codecs like H.264 to display telecined material.
5155 int repeat_pict; /* XXX: Put it back in AVCodecContext. */
5156 int64_t pts; /* pts of the current frame */
5157 int64_t dts; /* dts of the current frame */
5162 int fetch_timestamp;
5164 #define AV_PARSER_PTS_NB 4
5165 int cur_frame_start_index;
5166 int64_t cur_frame_offset[AV_PARSER_PTS_NB];
5167 int64_t cur_frame_pts[AV_PARSER_PTS_NB];
5168 int64_t cur_frame_dts[AV_PARSER_PTS_NB];
5171 #define PARSER_FLAG_COMPLETE_FRAMES 0x0001
5172 #define PARSER_FLAG_ONCE 0x0002
5173 /// Set if the parser has a valid file offset
5174 #define PARSER_FLAG_FETCHED_OFFSET 0x0004
5175 #define PARSER_FLAG_USE_CODEC_TS 0x1000
5177 int64_t offset; ///< byte offset from starting packet start
5178 int64_t cur_frame_end[AV_PARSER_PTS_NB];
5181 * Set by parser to 1 for key frames and 0 for non-key frames.
5182 * It is initialized to -1, so if the parser doesn't set this flag,
5183 * old-style fallback using AV_PICTURE_TYPE_I picture type as key frames
5188 #if FF_API_CONVERGENCE_DURATION
5190 * @deprecated unused
5192 attribute_deprecated
5193 int64_t convergence_duration;
5196 // Timestamp generation support:
5198 * Synchronization point for start of timestamp generation.
5200 * Set to >0 for sync point, 0 for no sync point and <0 for undefined
5203 * For example, this corresponds to presence of H.264 buffering period
5209 * Offset of the current timestamp against last timestamp sync point in
5210 * units of AVCodecContext.time_base.
5212 * Set to INT_MIN when dts_sync_point unused. Otherwise, it must
5213 * contain a valid timestamp offset.
5215 * Note that the timestamp of sync point has usually a nonzero
5216 * dts_ref_dts_delta, which refers to the previous sync point. Offset of
5217 * the next frame after timestamp sync point will be usually 1.
5219 * For example, this corresponds to H.264 cpb_removal_delay.
5221 int dts_ref_dts_delta;
5224 * Presentation delay of current frame in units of AVCodecContext.time_base.
5226 * Set to INT_MIN when dts_sync_point unused. Otherwise, it must
5227 * contain valid non-negative timestamp delta (presentation time of a frame
5228 * must not lie in the past).
5230 * This delay represents the difference between decoding and presentation
5231 * time of the frame.
5233 * For example, this corresponds to H.264 dpb_output_delay.
5238 * Position of the packet in file.
5240 * Analogous to cur_frame_pts/dts
5242 int64_t cur_frame_pos[AV_PARSER_PTS_NB];
5245 * Byte position of currently parsed frame in stream.
5250 * Previous frame byte position.
5255 * Duration of the current frame.
5256 * For audio, this is in units of 1 / AVCodecContext.sample_rate.
5257 * For all other types, this is in units of AVCodecContext.time_base.
5261 enum AVFieldOrder field_order;
5264 * Indicate whether a picture is coded as a frame, top field or bottom field.
5266 * For example, H.264 field_pic_flag equal to 0 corresponds to
5267 * AV_PICTURE_STRUCTURE_FRAME. An H.264 picture with field_pic_flag
5268 * equal to 1 and bottom_field_flag equal to 0 corresponds to
5269 * AV_PICTURE_STRUCTURE_TOP_FIELD.
5271 enum AVPictureStructure picture_structure;
5274 * Picture number incremented in presentation or output order.
5275 * This field may be reinitialized at the first picture of a new sequence.
5277 * For example, this corresponds to H.264 PicOrderCnt.
5279 int output_picture_number;
5282 * Dimensions of the decoded video intended for presentation.
5288 * Dimensions of the coded video.
5294 * The format of the coded data, corresponds to enum AVPixelFormat for video
5295 * and for enum AVSampleFormat for audio.
5297 * Note that a decoder can have considerable freedom in how exactly it
5298 * decodes the data, so the format reported here might be different from the
5299 * one returned by a decoder.
5302 } AVCodecParserContext;
5304 typedef struct AVCodecParser {
5305 int codec_ids[5]; /* several codec IDs are permitted */
5307 int (*parser_init)(AVCodecParserContext *s);
5308 /* This callback never returns an error, a negative value means that
5309 * the frame start was in a previous packet. */
5310 int (*parser_parse)(AVCodecParserContext *s,
5311 AVCodecContext *avctx,
5312 const uint8_t **poutbuf, int *poutbuf_size,
5313 const uint8_t *buf, int buf_size);
5314 void (*parser_close)(AVCodecParserContext *s);
5315 int (*split)(AVCodecContext *avctx, const uint8_t *buf, int buf_size);
5316 struct AVCodecParser *next;
5319 AVCodecParser *av_parser_next(const AVCodecParser *c);
5321 void av_register_codec_parser(AVCodecParser *parser);
5322 AVCodecParserContext *av_parser_init(int codec_id);
5327 * @param s parser context.
5328 * @param avctx codec context.
5329 * @param poutbuf set to pointer to parsed buffer or NULL if not yet finished.
5330 * @param poutbuf_size set to size of parsed buffer or zero if not yet finished.
5331 * @param buf input buffer.
5332 * @param buf_size buffer size in bytes without the padding. I.e. the full buffer
5333 size is assumed to be buf_size + AV_INPUT_BUFFER_PADDING_SIZE.
5334 To signal EOF, this should be 0 (so that the last frame
5336 * @param pts input presentation timestamp.
5337 * @param dts input decoding timestamp.
5338 * @param pos input byte position in stream.
5339 * @return the number of bytes of the input bitstream used.
5344 * len = av_parser_parse2(myparser, AVCodecContext, &data, &size,
5351 * decode_frame(data, size);
5355 int av_parser_parse2(AVCodecParserContext *s,
5356 AVCodecContext *avctx,
5357 uint8_t **poutbuf, int *poutbuf_size,
5358 const uint8_t *buf, int buf_size,
5359 int64_t pts, int64_t dts,
5363 * @return 0 if the output buffer is a subset of the input, 1 if it is allocated and must be freed
5364 * @deprecated use AVBitStreamFilter
5366 int av_parser_change(AVCodecParserContext *s,
5367 AVCodecContext *avctx,
5368 uint8_t **poutbuf, int *poutbuf_size,
5369 const uint8_t *buf, int buf_size, int keyframe);
5370 void av_parser_close(AVCodecParserContext *s);
5378 * @addtogroup lavc_encoding
5383 * Find a registered encoder with a matching codec ID.
5385 * @param id AVCodecID of the requested encoder
5386 * @return An encoder if one was found, NULL otherwise.
5388 AVCodec *avcodec_find_encoder(enum AVCodecID id);
5391 * Find a registered encoder with the specified name.
5393 * @param name name of the requested encoder
5394 * @return An encoder if one was found, NULL otherwise.
5396 AVCodec *avcodec_find_encoder_by_name(const char *name);
5399 * Encode a frame of audio.
5401 * Takes input samples from frame and writes the next output packet, if
5402 * available, to avpkt. The output packet does not necessarily contain data for
5403 * the most recent frame, as encoders can delay, split, and combine input frames
5404 * internally as needed.
5406 * @param avctx codec context
5407 * @param avpkt output AVPacket.
5408 * The user can supply an output buffer by setting
5409 * avpkt->data and avpkt->size prior to calling the
5410 * function, but if the size of the user-provided data is not
5411 * large enough, encoding will fail. If avpkt->data and
5412 * avpkt->size are set, avpkt->destruct must also be set. All
5413 * other AVPacket fields will be reset by the encoder using
5414 * av_init_packet(). If avpkt->data is NULL, the encoder will
5415 * allocate it. The encoder will set avpkt->size to the size
5416 * of the output packet.
5418 * If this function fails or produces no output, avpkt will be
5419 * freed using av_packet_unref().
5420 * @param[in] frame AVFrame containing the raw audio data to be encoded.
5421 * May be NULL when flushing an encoder that has the
5422 * AV_CODEC_CAP_DELAY capability set.
5423 * If AV_CODEC_CAP_VARIABLE_FRAME_SIZE is set, then each frame
5424 * can have any number of samples.
5425 * If it is not set, frame->nb_samples must be equal to
5426 * avctx->frame_size for all frames except the last.
5427 * The final frame may be smaller than avctx->frame_size.
5428 * @param[out] got_packet_ptr This field is set to 1 by libavcodec if the
5429 * output packet is non-empty, and to 0 if it is
5430 * empty. If the function returns an error, the
5431 * packet can be assumed to be invalid, and the
5432 * value of got_packet_ptr is undefined and should
5434 * @return 0 on success, negative error code on failure
5436 * @deprecated use avcodec_send_frame()/avcodec_receive_packet() instead
5438 attribute_deprecated
5439 int avcodec_encode_audio2(AVCodecContext *avctx, AVPacket *avpkt,
5440 const AVFrame *frame, int *got_packet_ptr);
5443 * Encode a frame of video.
5445 * Takes input raw video data from frame and writes the next output packet, if
5446 * available, to avpkt. The output packet does not necessarily contain data for
5447 * the most recent frame, as encoders can delay and reorder input frames
5448 * internally as needed.
5450 * @param avctx codec context
5451 * @param avpkt output AVPacket.
5452 * The user can supply an output buffer by setting
5453 * avpkt->data and avpkt->size prior to calling the
5454 * function, but if the size of the user-provided data is not
5455 * large enough, encoding will fail. All other AVPacket fields
5456 * will be reset by the encoder using av_init_packet(). If
5457 * avpkt->data is NULL, the encoder will allocate it.
5458 * The encoder will set avpkt->size to the size of the
5459 * output packet. The returned data (if any) belongs to the
5460 * caller, he is responsible for freeing it.
5462 * If this function fails or produces no output, avpkt will be
5463 * freed using av_packet_unref().
5464 * @param[in] frame AVFrame containing the raw video data to be encoded.
5465 * May be NULL when flushing an encoder that has the
5466 * AV_CODEC_CAP_DELAY capability set.
5467 * @param[out] got_packet_ptr This field is set to 1 by libavcodec if the
5468 * output packet is non-empty, and to 0 if it is
5469 * empty. If the function returns an error, the
5470 * packet can be assumed to be invalid, and the
5471 * value of got_packet_ptr is undefined and should
5473 * @return 0 on success, negative error code on failure
5475 * @deprecated use avcodec_send_frame()/avcodec_receive_packet() instead
5477 attribute_deprecated
5478 int avcodec_encode_video2(AVCodecContext *avctx, AVPacket *avpkt,
5479 const AVFrame *frame, int *got_packet_ptr);
5481 int avcodec_encode_subtitle(AVCodecContext *avctx, uint8_t *buf, int buf_size,
5482 const AVSubtitle *sub);
5489 #if FF_API_AVCODEC_RESAMPLE
5491 * @defgroup lavc_resample Audio resampling
5493 * @deprecated use libswresample instead
5497 struct ReSampleContext;
5498 struct AVResampleContext;
5500 typedef struct ReSampleContext ReSampleContext;
5503 * Initialize audio resampling context.
5505 * @param output_channels number of output channels
5506 * @param input_channels number of input channels
5507 * @param output_rate output sample rate
5508 * @param input_rate input sample rate
5509 * @param sample_fmt_out requested output sample format
5510 * @param sample_fmt_in input sample format
5511 * @param filter_length length of each FIR filter in the filterbank relative to the cutoff frequency
5512 * @param log2_phase_count log2 of the number of entries in the polyphase filterbank
5513 * @param linear if 1 then the used FIR filter will be linearly interpolated
5514 between the 2 closest, if 0 the closest will be used
5515 * @param cutoff cutoff frequency, 1.0 corresponds to half the output sampling rate
5516 * @return allocated ReSampleContext, NULL if error occurred
5518 attribute_deprecated
5519 ReSampleContext *av_audio_resample_init(int output_channels, int input_channels,
5520 int output_rate, int input_rate,
5521 enum AVSampleFormat sample_fmt_out,
5522 enum AVSampleFormat sample_fmt_in,
5523 int filter_length, int log2_phase_count,
5524 int linear, double cutoff);
5526 attribute_deprecated
5527 int audio_resample(ReSampleContext *s, short *output, short *input, int nb_samples);
5530 * Free resample context.
5532 * @param s a non-NULL pointer to a resample context previously
5533 * created with av_audio_resample_init()
5535 attribute_deprecated
5536 void audio_resample_close(ReSampleContext *s);
5540 * Initialize an audio resampler.
5541 * Note, if either rate is not an integer then simply scale both rates up so they are.
5542 * @param filter_length length of each FIR filter in the filterbank relative to the cutoff freq
5543 * @param log2_phase_count log2 of the number of entries in the polyphase filterbank
5544 * @param linear If 1 then the used FIR filter will be linearly interpolated
5545 between the 2 closest, if 0 the closest will be used
5546 * @param cutoff cutoff frequency, 1.0 corresponds to half the output sampling rate
5548 attribute_deprecated
5549 struct AVResampleContext *av_resample_init(int out_rate, int in_rate, int filter_length, int log2_phase_count, int linear, double cutoff);
5552 * Resample an array of samples using a previously configured context.
5553 * @param src an array of unconsumed samples
5554 * @param consumed the number of samples of src which have been consumed are returned here
5555 * @param src_size the number of unconsumed samples available
5556 * @param dst_size the amount of space in samples available in dst
5557 * @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.
5558 * @return the number of samples written in dst or -1 if an error occurred
5560 attribute_deprecated
5561 int av_resample(struct AVResampleContext *c, short *dst, short *src, int *consumed, int src_size, int dst_size, int update_ctx);
5565 * Compensate samplerate/timestamp drift. The compensation is done by changing
5566 * the resampler parameters, so no audible clicks or similar distortions occur
5567 * @param compensation_distance distance in output samples over which the compensation should be performed
5568 * @param sample_delta number of output samples which should be output less
5570 * example: av_resample_compensate(c, 10, 500)
5571 * here instead of 510 samples only 500 samples would be output
5573 * note, due to rounding the actual compensation might be slightly different,
5574 * especially if the compensation_distance is large and the in_rate used during init is small
5576 attribute_deprecated
5577 void av_resample_compensate(struct AVResampleContext *c, int sample_delta, int compensation_distance);
5578 attribute_deprecated
5579 void av_resample_close(struct AVResampleContext *c);
5586 #if FF_API_AVPICTURE
5588 * @addtogroup lavc_picture
5593 * @deprecated unused
5595 attribute_deprecated
5596 int avpicture_alloc(AVPicture *picture, enum AVPixelFormat pix_fmt, int width, int height);
5599 * @deprecated unused
5601 attribute_deprecated
5602 void avpicture_free(AVPicture *picture);
5605 * @deprecated use av_image_fill_arrays() instead.
5607 attribute_deprecated
5608 int avpicture_fill(AVPicture *picture, const uint8_t *ptr,
5609 enum AVPixelFormat pix_fmt, int width, int height);
5612 * @deprecated use av_image_copy_to_buffer() instead.
5614 attribute_deprecated
5615 int avpicture_layout(const AVPicture *src, enum AVPixelFormat pix_fmt,
5616 int width, int height,
5617 unsigned char *dest, int dest_size);
5620 * @deprecated use av_image_get_buffer_size() instead.
5622 attribute_deprecated
5623 int avpicture_get_size(enum AVPixelFormat pix_fmt, int width, int height);
5626 * @deprecated av_image_copy() instead.
5628 attribute_deprecated
5629 void av_picture_copy(AVPicture *dst, const AVPicture *src,
5630 enum AVPixelFormat pix_fmt, int width, int height);
5633 * @deprecated unused
5635 attribute_deprecated
5636 int av_picture_crop(AVPicture *dst, const AVPicture *src,
5637 enum AVPixelFormat pix_fmt, int top_band, int left_band);
5640 * @deprecated unused
5642 attribute_deprecated
5643 int av_picture_pad(AVPicture *dst, const AVPicture *src, int height, int width, enum AVPixelFormat pix_fmt,
5644 int padtop, int padbottom, int padleft, int padright, int *color);
5652 * @defgroup lavc_misc Utility functions
5655 * Miscellaneous utility functions related to both encoding and decoding
5661 * @defgroup lavc_misc_pixfmt Pixel formats
5663 * Functions for working with pixel formats.
5668 * Utility function to access log2_chroma_w log2_chroma_h from
5669 * the pixel format AVPixFmtDescriptor.
5671 * This function asserts that pix_fmt is valid. See av_pix_fmt_get_chroma_sub_sample
5672 * for one that returns a failure code and continues in case of invalid
5675 * @param[in] pix_fmt the pixel format
5676 * @param[out] h_shift store log2_chroma_w
5677 * @param[out] v_shift store log2_chroma_h
5679 * @see av_pix_fmt_get_chroma_sub_sample
5682 void avcodec_get_chroma_sub_sample(enum AVPixelFormat pix_fmt, int *h_shift, int *v_shift);
5685 * Return a value representing the fourCC code associated to the
5686 * pixel format pix_fmt, or 0 if no associated fourCC code can be
5689 unsigned int avcodec_pix_fmt_to_codec_tag(enum AVPixelFormat pix_fmt);
5692 * @deprecated see av_get_pix_fmt_loss()
5694 int avcodec_get_pix_fmt_loss(enum AVPixelFormat dst_pix_fmt, enum AVPixelFormat src_pix_fmt,
5698 * Find the best pixel format to convert to given a certain source pixel
5699 * format. When converting from one pixel format to another, information loss
5700 * may occur. For example, when converting from RGB24 to GRAY, the color
5701 * information will be lost. Similarly, other losses occur when converting from
5702 * some formats to other formats. avcodec_find_best_pix_fmt_of_2() searches which of
5703 * the given pixel formats should be used to suffer the least amount of loss.
5704 * The pixel formats from which it chooses one, are determined by the
5705 * pix_fmt_list parameter.
5708 * @param[in] pix_fmt_list AV_PIX_FMT_NONE terminated array of pixel formats to choose from
5709 * @param[in] src_pix_fmt source pixel format
5710 * @param[in] has_alpha Whether the source pixel format alpha channel is used.
5711 * @param[out] loss_ptr Combination of flags informing you what kind of losses will occur.
5712 * @return The best pixel format to convert to or -1 if none was found.
5714 enum AVPixelFormat avcodec_find_best_pix_fmt_of_list(const enum AVPixelFormat *pix_fmt_list,
5715 enum AVPixelFormat src_pix_fmt,
5716 int has_alpha, int *loss_ptr);
5719 * @deprecated see av_find_best_pix_fmt_of_2()
5721 enum AVPixelFormat avcodec_find_best_pix_fmt_of_2(enum AVPixelFormat dst_pix_fmt1, enum AVPixelFormat dst_pix_fmt2,
5722 enum AVPixelFormat src_pix_fmt, int has_alpha, int *loss_ptr);
5724 attribute_deprecated
5725 enum AVPixelFormat avcodec_find_best_pix_fmt2(enum AVPixelFormat dst_pix_fmt1, enum AVPixelFormat dst_pix_fmt2,
5726 enum AVPixelFormat src_pix_fmt, int has_alpha, int *loss_ptr);
5728 enum AVPixelFormat avcodec_default_get_format(struct AVCodecContext *s, const enum AVPixelFormat * fmt);
5734 #if FF_API_SET_DIMENSIONS
5736 * @deprecated this function is not supposed to be used from outside of lavc
5738 attribute_deprecated
5739 void avcodec_set_dimensions(AVCodecContext *s, int width, int height);
5742 #if FF_API_TAG_STRING
5744 * Put a string representing the codec tag codec_tag in buf.
5746 * @param buf buffer to place codec tag in
5747 * @param buf_size size in bytes of buf
5748 * @param codec_tag codec tag to assign
5749 * @return the length of the string that would have been generated if
5750 * enough space had been available, excluding the trailing null
5752 * @deprecated see av_fourcc_make_string() and av_fourcc2str().
5754 attribute_deprecated
5755 size_t av_get_codec_tag_string(char *buf, size_t buf_size, unsigned int codec_tag);
5758 void avcodec_string(char *buf, int buf_size, AVCodecContext *enc, int encode);
5761 * Return a name for the specified profile, if available.
5763 * @param codec the codec that is searched for the given profile
5764 * @param profile the profile value for which a name is requested
5765 * @return A name for the profile if found, NULL otherwise.
5767 const char *av_get_profile_name(const AVCodec *codec, int profile);
5770 * Return a name for the specified profile, if available.
5772 * @param codec_id the ID of the codec to which the requested profile belongs
5773 * @param profile the profile value for which a name is requested
5774 * @return A name for the profile if found, NULL otherwise.
5776 * @note unlike av_get_profile_name(), which searches a list of profiles
5777 * supported by a specific decoder or encoder implementation, this
5778 * function searches the list of profiles from the AVCodecDescriptor
5780 const char *avcodec_profile_name(enum AVCodecID codec_id, int profile);
5782 int avcodec_default_execute(AVCodecContext *c, int (*func)(AVCodecContext *c2, void *arg2),void *arg, int *ret, int count, int size);
5783 int avcodec_default_execute2(AVCodecContext *c, int (*func)(AVCodecContext *c2, void *arg2, int, int),void *arg, int *ret, int count);
5784 //FIXME func typedef
5787 * Fill AVFrame audio data and linesize pointers.
5789 * The buffer buf must be a preallocated buffer with a size big enough
5790 * to contain the specified samples amount. The filled AVFrame data
5791 * pointers will point to this buffer.
5793 * AVFrame extended_data channel pointers are allocated if necessary for
5796 * @param frame the AVFrame
5797 * frame->nb_samples must be set prior to calling the
5798 * function. This function fills in frame->data,
5799 * frame->extended_data, frame->linesize[0].
5800 * @param nb_channels channel count
5801 * @param sample_fmt sample format
5802 * @param buf buffer to use for frame data
5803 * @param buf_size size of buffer
5804 * @param align plane size sample alignment (0 = default)
5805 * @return >=0 on success, negative error code on failure
5806 * @todo return the size in bytes required to store the samples in
5807 * case of success, at the next libavutil bump
5809 int avcodec_fill_audio_frame(AVFrame *frame, int nb_channels,
5810 enum AVSampleFormat sample_fmt, const uint8_t *buf,
5811 int buf_size, int align);
5814 * Reset the internal decoder state / flush internal buffers. Should be called
5815 * e.g. when seeking or when switching to a different stream.
5817 * @note when refcounted frames are not used (i.e. avctx->refcounted_frames is 0),
5818 * this invalidates the frames previously returned from the decoder. When
5819 * refcounted frames are used, the decoder just releases any references it might
5820 * keep internally, but the caller's reference remains valid.
5822 void avcodec_flush_buffers(AVCodecContext *avctx);
5825 * Return codec bits per sample.
5827 * @param[in] codec_id the codec
5828 * @return Number of bits per sample or zero if unknown for the given codec.
5830 int av_get_bits_per_sample(enum AVCodecID codec_id);
5833 * Return the PCM codec associated with a sample format.
5834 * @param be endianness, 0 for little, 1 for big,
5835 * -1 (or anything else) for native
5836 * @return AV_CODEC_ID_PCM_* or AV_CODEC_ID_NONE
5838 enum AVCodecID av_get_pcm_codec(enum AVSampleFormat fmt, int be);
5841 * Return codec bits per sample.
5842 * Only return non-zero if the bits per sample is exactly correct, not an
5845 * @param[in] codec_id the codec
5846 * @return Number of bits per sample or zero if unknown for the given codec.
5848 int av_get_exact_bits_per_sample(enum AVCodecID codec_id);
5851 * Return audio frame duration.
5853 * @param avctx codec context
5854 * @param frame_bytes size of the frame, or 0 if unknown
5855 * @return frame duration, in samples, if known. 0 if not able to
5858 int av_get_audio_frame_duration(AVCodecContext *avctx, int frame_bytes);
5861 * This function is the same as av_get_audio_frame_duration(), except it works
5862 * with AVCodecParameters instead of an AVCodecContext.
5864 int av_get_audio_frame_duration2(AVCodecParameters *par, int frame_bytes);
5867 typedef struct AVBitStreamFilterContext {
5869 const struct AVBitStreamFilter *filter;
5870 AVCodecParserContext *parser;
5871 struct AVBitStreamFilterContext *next;
5873 * Internal default arguments, used if NULL is passed to av_bitstream_filter_filter().
5874 * Not for access by library users.
5877 } AVBitStreamFilterContext;
5880 typedef struct AVBSFInternal AVBSFInternal;
5883 * The bitstream filter state.
5885 * This struct must be allocated with av_bsf_alloc() and freed with
5888 * The fields in the struct will only be changed (by the caller or by the
5889 * filter) as described in their documentation, and are to be considered
5890 * immutable otherwise.
5892 typedef struct AVBSFContext {
5894 * A class for logging and AVOptions
5896 const AVClass *av_class;
5899 * The bitstream filter this context is an instance of.
5901 const struct AVBitStreamFilter *filter;
5904 * Opaque libavcodec internal data. Must not be touched by the caller in any
5907 AVBSFInternal *internal;
5910 * Opaque filter-specific private data. If filter->priv_class is non-NULL,
5911 * this is an AVOptions-enabled struct.
5916 * Parameters of the input stream. This field is allocated in
5917 * av_bsf_alloc(), it needs to be filled by the caller before
5920 AVCodecParameters *par_in;
5923 * Parameters of the output stream. This field is allocated in
5924 * av_bsf_alloc(), it is set by the filter in av_bsf_init().
5926 AVCodecParameters *par_out;
5929 * The timebase used for the timestamps of the input packets. Set by the
5930 * caller before av_bsf_init().
5932 AVRational time_base_in;
5935 * The timebase used for the timestamps of the output packets. Set by the
5936 * filter in av_bsf_init().
5938 AVRational time_base_out;
5941 typedef struct AVBitStreamFilter {
5945 * A list of codec ids supported by the filter, terminated by
5947 * May be NULL, in that case the bitstream filter works with any codec id.
5949 const enum AVCodecID *codec_ids;
5952 * A class for the private data, used to declare bitstream filter private
5953 * AVOptions. This field is NULL for bitstream filters that do not declare
5956 * If this field is non-NULL, the first member of the filter private data
5957 * must be a pointer to AVClass, which will be set by libavcodec generic
5958 * code to this class.
5960 const AVClass *priv_class;
5962 /*****************************************************************
5963 * No fields below this line are part of the public API. They
5964 * may not be used outside of libavcodec and can be changed and
5966 * New public fields should be added right above.
5967 *****************************************************************
5971 int (*init)(AVBSFContext *ctx);
5972 int (*filter)(AVBSFContext *ctx, AVPacket *pkt);
5973 void (*close)(AVBSFContext *ctx);
5974 } AVBitStreamFilter;
5978 * Register a bitstream filter.
5980 * The filter will be accessible to the application code through
5981 * av_bitstream_filter_next() or can be directly initialized with
5982 * av_bitstream_filter_init().
5984 * @see avcodec_register_all()
5986 attribute_deprecated
5987 void av_register_bitstream_filter(AVBitStreamFilter *bsf);
5990 * Create and initialize a bitstream filter context given a bitstream
5993 * The returned context must be freed with av_bitstream_filter_close().
5995 * @param name the name of the bitstream filter
5996 * @return a bitstream filter context if a matching filter was found
5997 * and successfully initialized, NULL otherwise
5999 attribute_deprecated
6000 AVBitStreamFilterContext *av_bitstream_filter_init(const char *name);
6005 * This function filters the buffer buf with size buf_size, and places the
6006 * filtered buffer in the buffer pointed to by poutbuf.
6008 * The output buffer must be freed by the caller.
6010 * @param bsfc bitstream filter context created by av_bitstream_filter_init()
6011 * @param avctx AVCodecContext accessed by the filter, may be NULL.
6012 * If specified, this must point to the encoder context of the
6013 * output stream the packet is sent to.
6014 * @param args arguments which specify the filter configuration, may be NULL
6015 * @param poutbuf pointer which is updated to point to the filtered buffer
6016 * @param poutbuf_size pointer which is updated to the filtered buffer size in bytes
6017 * @param buf buffer containing the data to filter
6018 * @param buf_size size in bytes of buf
6019 * @param keyframe set to non-zero if the buffer to filter corresponds to a key-frame packet data
6020 * @return >= 0 in case of success, or a negative error code in case of failure
6022 * If the return value is positive, an output buffer is allocated and
6023 * is available in *poutbuf, and is distinct from the input buffer.
6025 * If the return value is 0, the output buffer is not allocated and
6026 * should be considered identical to the input buffer, or in case
6027 * *poutbuf was set it points to the input buffer (not necessarily to
6028 * its starting address). A special case is if *poutbuf was set to NULL and
6029 * *poutbuf_size was set to 0, which indicates the packet should be dropped.
6031 attribute_deprecated
6032 int av_bitstream_filter_filter(AVBitStreamFilterContext *bsfc,
6033 AVCodecContext *avctx, const char *args,
6034 uint8_t **poutbuf, int *poutbuf_size,
6035 const uint8_t *buf, int buf_size, int keyframe);
6038 * Release bitstream filter context.
6040 * @param bsf the bitstream filter context created with
6041 * av_bitstream_filter_init(), can be NULL
6043 attribute_deprecated
6044 void av_bitstream_filter_close(AVBitStreamFilterContext *bsf);
6047 * If f is NULL, return the first registered bitstream filter,
6048 * if f is non-NULL, return the next registered bitstream filter
6049 * after f, or NULL if f is the last one.
6051 * This function can be used to iterate over all registered bitstream
6054 attribute_deprecated
6055 AVBitStreamFilter *av_bitstream_filter_next(const AVBitStreamFilter *f);
6059 * @return a bitstream filter with the specified name or NULL if no such
6060 * bitstream filter exists.
6062 const AVBitStreamFilter *av_bsf_get_by_name(const char *name);
6065 * Iterate over all registered bitstream filters.
6067 * @param opaque a pointer where libavcodec will store the iteration state. Must
6068 * point to NULL to start the iteration.
6070 * @return the next registered bitstream filter or NULL when the iteration is
6073 const AVBitStreamFilter *av_bsf_next(void **opaque);
6076 * Allocate a context for a given bitstream filter. The caller must fill in the
6077 * context parameters as described in the documentation and then call
6078 * av_bsf_init() before sending any data to the filter.
6080 * @param filter the filter for which to allocate an instance.
6081 * @param ctx a pointer into which the pointer to the newly-allocated context
6082 * will be written. It must be freed with av_bsf_free() after the
6083 * filtering is done.
6085 * @return 0 on success, a negative AVERROR code on failure
6087 int av_bsf_alloc(const AVBitStreamFilter *filter, AVBSFContext **ctx);
6090 * Prepare the filter for use, after all the parameters and options have been
6093 int av_bsf_init(AVBSFContext *ctx);
6096 * Submit a packet for filtering.
6098 * After sending each packet, the filter must be completely drained by calling
6099 * av_bsf_receive_packet() repeatedly until it returns AVERROR(EAGAIN) or
6102 * @param pkt the packet to filter. The bitstream filter will take ownership of
6103 * the packet and reset the contents of pkt. pkt is not touched if an error occurs.
6104 * This parameter may be NULL, which signals the end of the stream (i.e. no more
6105 * packets will be sent). That will cause the filter to output any packets it
6106 * may have buffered internally.
6108 * @return 0 on success, a negative AVERROR on error.
6110 int av_bsf_send_packet(AVBSFContext *ctx, AVPacket *pkt);
6113 * Retrieve a filtered packet.
6115 * @param[out] pkt this struct will be filled with the contents of the filtered
6116 * packet. It is owned by the caller and must be freed using
6117 * av_packet_unref() when it is no longer needed.
6118 * This parameter should be "clean" (i.e. freshly allocated
6119 * with av_packet_alloc() or unreffed with av_packet_unref())
6120 * when this function is called. If this function returns
6121 * successfully, the contents of pkt will be completely
6122 * overwritten by the returned data. On failure, pkt is not
6125 * @return 0 on success. AVERROR(EAGAIN) if more packets need to be sent to the
6126 * filter (using av_bsf_send_packet()) to get more output. AVERROR_EOF if there
6127 * will be no further output from the filter. Another negative AVERROR value if
6130 * @note one input packet may result in several output packets, so after sending
6131 * a packet with av_bsf_send_packet(), this function needs to be called
6132 * repeatedly until it stops returning 0. It is also possible for a filter to
6133 * output fewer packets than were sent to it, so this function may return
6134 * AVERROR(EAGAIN) immediately after a successful av_bsf_send_packet() call.
6136 int av_bsf_receive_packet(AVBSFContext *ctx, AVPacket *pkt);
6139 * Free a bitstream filter context and everything associated with it; write NULL
6140 * into the supplied pointer.
6142 void av_bsf_free(AVBSFContext **ctx);
6145 * Get the AVClass for AVBSFContext. It can be used in combination with
6146 * AV_OPT_SEARCH_FAKE_OBJ for examining options.
6148 * @see av_opt_find().
6150 const AVClass *av_bsf_get_class(void);
6153 * Structure for chain/list of bitstream filters.
6154 * Empty list can be allocated by av_bsf_list_alloc().
6156 typedef struct AVBSFList AVBSFList;
6159 * Allocate empty list of bitstream filters.
6160 * The list must be later freed by av_bsf_list_free()
6161 * or finalized by av_bsf_list_finalize().
6163 * @return Pointer to @ref AVBSFList on success, NULL in case of failure
6165 AVBSFList *av_bsf_list_alloc(void);
6168 * Free list of bitstream filters.
6170 * @param lst Pointer to pointer returned by av_bsf_list_alloc()
6172 void av_bsf_list_free(AVBSFList **lst);
6175 * Append bitstream filter to the list of bitstream filters.
6177 * @param lst List to append to
6178 * @param bsf Filter context to be appended
6180 * @return >=0 on success, negative AVERROR in case of failure
6182 int av_bsf_list_append(AVBSFList *lst, AVBSFContext *bsf);
6185 * Construct new bitstream filter context given it's name and options
6186 * and append it to the list of bitstream filters.
6188 * @param lst List to append to
6189 * @param bsf_name Name of the bitstream filter
6190 * @param options Options for the bitstream filter, can be set to NULL
6192 * @return >=0 on success, negative AVERROR in case of failure
6194 int av_bsf_list_append2(AVBSFList *lst, const char * bsf_name, AVDictionary **options);
6196 * Finalize list of bitstream filters.
6198 * This function will transform @ref AVBSFList to single @ref AVBSFContext,
6199 * so the whole chain of bitstream filters can be treated as single filter
6200 * freshly allocated by av_bsf_alloc().
6201 * If the call is successful, @ref AVBSFList structure is freed and lst
6202 * will be set to NULL. In case of failure, caller is responsible for
6203 * freeing the structure by av_bsf_list_free()
6205 * @param lst Filter list structure to be transformed
6206 * @param[out] bsf Pointer to be set to newly created @ref AVBSFContext structure
6207 * representing the chain of bitstream filters
6209 * @return >=0 on success, negative AVERROR in case of failure
6211 int av_bsf_list_finalize(AVBSFList **lst, AVBSFContext **bsf);
6214 * Parse string describing list of bitstream filters and create single
6215 * @ref AVBSFContext describing the whole chain of bitstream filters.
6216 * Resulting @ref AVBSFContext can be treated as any other @ref AVBSFContext freshly
6217 * allocated by av_bsf_alloc().
6219 * @param str String describing chain of bitstream filters in format
6220 * `bsf1[=opt1=val1:opt2=val2][,bsf2]`
6221 * @param[out] bsf Pointer to be set to newly created @ref AVBSFContext structure
6222 * representing the chain of bitstream filters
6224 * @return >=0 on success, negative AVERROR in case of failure
6226 int av_bsf_list_parse_str(const char *str, AVBSFContext **bsf);
6229 * Get null/pass-through bitstream filter.
6231 * @param[out] bsf Pointer to be set to new instance of pass-through bitstream filter
6235 int av_bsf_get_null_filter(AVBSFContext **bsf);
6240 * Same behaviour av_fast_malloc but the buffer has additional
6241 * AV_INPUT_BUFFER_PADDING_SIZE at the end which will always be 0.
6243 * In addition the whole buffer will initially and after resizes
6244 * be 0-initialized so that no uninitialized data will ever appear.
6246 void av_fast_padded_malloc(void *ptr, unsigned int *size, size_t min_size);
6249 * Same behaviour av_fast_padded_malloc except that buffer will always
6250 * be 0-initialized after call.
6252 void av_fast_padded_mallocz(void *ptr, unsigned int *size, size_t min_size);
6255 * Encode extradata length to a buffer. Used by xiph codecs.
6257 * @param s buffer to write to; must be at least (v/255+1) bytes long
6258 * @param v size of extradata in bytes
6259 * @return number of bytes written to the buffer.
6261 unsigned int av_xiphlacing(unsigned char *s, unsigned int v);
6263 #if FF_API_MISSING_SAMPLE
6265 * Log a generic warning message about a missing feature. This function is
6266 * intended to be used internally by FFmpeg (libavcodec, libavformat, etc.)
6267 * only, and would normally not be used by applications.
6268 * @param[in] avc a pointer to an arbitrary struct of which the first field is
6269 * a pointer to an AVClass struct
6270 * @param[in] feature string containing the name of the missing feature
6271 * @param[in] want_sample indicates if samples are wanted which exhibit this feature.
6272 * If want_sample is non-zero, additional verbiage will be added to the log
6273 * message which tells the user how to report samples to the development
6275 * @deprecated Use avpriv_report_missing_feature() instead.
6277 attribute_deprecated
6278 void av_log_missing_feature(void *avc, const char *feature, int want_sample);
6281 * Log a generic warning message asking for a sample. This function is
6282 * intended to be used internally by FFmpeg (libavcodec, libavformat, etc.)
6283 * only, and would normally not be used by applications.
6284 * @param[in] avc a pointer to an arbitrary struct of which the first field is
6285 * a pointer to an AVClass struct
6286 * @param[in] msg string containing an optional message, or NULL if no message
6287 * @deprecated Use avpriv_request_sample() instead.
6289 attribute_deprecated
6290 void av_log_ask_for_sample(void *avc, const char *msg, ...) av_printf_format(2, 3);
6291 #endif /* FF_API_MISSING_SAMPLE */
6294 * Register the hardware accelerator hwaccel.
6296 void av_register_hwaccel(AVHWAccel *hwaccel);
6299 * If hwaccel is NULL, returns the first registered hardware accelerator,
6300 * if hwaccel is non-NULL, returns the next registered hardware accelerator
6301 * after hwaccel, or NULL if hwaccel is the last one.
6303 AVHWAccel *av_hwaccel_next(const AVHWAccel *hwaccel);
6307 * Lock operation used by lockmgr
6310 AV_LOCK_CREATE, ///< Create a mutex
6311 AV_LOCK_OBTAIN, ///< Lock the mutex
6312 AV_LOCK_RELEASE, ///< Unlock the mutex
6313 AV_LOCK_DESTROY, ///< Free mutex resources
6317 * Register a user provided lock manager supporting the operations
6318 * specified by AVLockOp. The "mutex" argument to the function points
6319 * to a (void *) where the lockmgr should store/get a pointer to a user
6320 * allocated mutex. It is NULL upon AV_LOCK_CREATE and equal to the
6321 * value left by the last call for all other ops. If the lock manager is
6322 * unable to perform the op then it should leave the mutex in the same
6323 * state as when it was called and return a non-zero value. However,
6324 * when called with AV_LOCK_DESTROY the mutex will always be assumed to
6325 * have been successfully destroyed. If av_lockmgr_register succeeds
6326 * it will return a non-negative value, if it fails it will return a
6327 * negative value and destroy all mutex and unregister all callbacks.
6328 * av_lockmgr_register is not thread-safe, it must be called from a
6329 * single thread before any calls which make use of locking are used.
6331 * @param cb User defined callback. av_lockmgr_register invokes calls
6332 * to this callback and the previously registered callback.
6333 * The callback will be used to create more than one mutex
6334 * each of which must be backed by its own underlying locking
6335 * mechanism (i.e. do not use a single static object to
6336 * implement your lock manager). If cb is set to NULL the
6337 * lockmgr will be unregistered.
6339 int av_lockmgr_register(int (*cb)(void **mutex, enum AVLockOp op));
6342 * Get the type of the given codec.
6344 enum AVMediaType avcodec_get_type(enum AVCodecID codec_id);
6347 * Get the name of a codec.
6348 * @return a static string identifying the codec; never NULL
6350 const char *avcodec_get_name(enum AVCodecID id);
6353 * @return a positive value if s is open (i.e. avcodec_open2() was called on it
6354 * with no corresponding avcodec_close()), 0 otherwise.
6356 int avcodec_is_open(AVCodecContext *s);
6359 * @return a non-zero number if codec is an encoder, zero otherwise
6361 int av_codec_is_encoder(const AVCodec *codec);
6364 * @return a non-zero number if codec is a decoder, zero otherwise
6366 int av_codec_is_decoder(const AVCodec *codec);
6369 * @return descriptor for given codec ID or NULL if no descriptor exists.
6371 const AVCodecDescriptor *avcodec_descriptor_get(enum AVCodecID id);
6374 * Iterate over all codec descriptors known to libavcodec.
6376 * @param prev previous descriptor. NULL to get the first descriptor.
6378 * @return next descriptor or NULL after the last descriptor
6380 const AVCodecDescriptor *avcodec_descriptor_next(const AVCodecDescriptor *prev);
6383 * @return codec descriptor with the given name or NULL if no such descriptor
6386 const AVCodecDescriptor *avcodec_descriptor_get_by_name(const char *name);
6389 * Allocate a CPB properties structure and initialize its fields to default
6392 * @param size if non-NULL, the size of the allocated struct will be written
6393 * here. This is useful for embedding it in side data.
6395 * @return the newly allocated struct or NULL on failure
6397 AVCPBProperties *av_cpb_properties_alloc(size_t *size);
6403 #endif /* AVCODEC_AVCODEC_H */