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,
452 /* various PCM "codecs" */
453 AV_CODEC_ID_FIRST_AUDIO = 0x10000, ///< A dummy id pointing at the start of audio codecs
454 AV_CODEC_ID_PCM_S16LE = 0x10000,
455 AV_CODEC_ID_PCM_S16BE,
456 AV_CODEC_ID_PCM_U16LE,
457 AV_CODEC_ID_PCM_U16BE,
460 AV_CODEC_ID_PCM_MULAW,
461 AV_CODEC_ID_PCM_ALAW,
462 AV_CODEC_ID_PCM_S32LE,
463 AV_CODEC_ID_PCM_S32BE,
464 AV_CODEC_ID_PCM_U32LE,
465 AV_CODEC_ID_PCM_U32BE,
466 AV_CODEC_ID_PCM_S24LE,
467 AV_CODEC_ID_PCM_S24BE,
468 AV_CODEC_ID_PCM_U24LE,
469 AV_CODEC_ID_PCM_U24BE,
470 AV_CODEC_ID_PCM_S24DAUD,
471 AV_CODEC_ID_PCM_ZORK,
472 AV_CODEC_ID_PCM_S16LE_PLANAR,
474 AV_CODEC_ID_PCM_F32BE,
475 AV_CODEC_ID_PCM_F32LE,
476 AV_CODEC_ID_PCM_F64BE,
477 AV_CODEC_ID_PCM_F64LE,
478 AV_CODEC_ID_PCM_BLURAY,
481 AV_CODEC_ID_PCM_S8_PLANAR,
482 AV_CODEC_ID_PCM_S24LE_PLANAR,
483 AV_CODEC_ID_PCM_S32LE_PLANAR,
484 AV_CODEC_ID_PCM_S16BE_PLANAR,
486 AV_CODEC_ID_PCM_S64LE = 0x10800,
487 AV_CODEC_ID_PCM_S64BE,
488 AV_CODEC_ID_PCM_F16LE,
489 AV_CODEC_ID_PCM_F24LE,
491 /* various ADPCM codecs */
492 AV_CODEC_ID_ADPCM_IMA_QT = 0x11000,
493 AV_CODEC_ID_ADPCM_IMA_WAV,
494 AV_CODEC_ID_ADPCM_IMA_DK3,
495 AV_CODEC_ID_ADPCM_IMA_DK4,
496 AV_CODEC_ID_ADPCM_IMA_WS,
497 AV_CODEC_ID_ADPCM_IMA_SMJPEG,
498 AV_CODEC_ID_ADPCM_MS,
499 AV_CODEC_ID_ADPCM_4XM,
500 AV_CODEC_ID_ADPCM_XA,
501 AV_CODEC_ID_ADPCM_ADX,
502 AV_CODEC_ID_ADPCM_EA,
503 AV_CODEC_ID_ADPCM_G726,
504 AV_CODEC_ID_ADPCM_CT,
505 AV_CODEC_ID_ADPCM_SWF,
506 AV_CODEC_ID_ADPCM_YAMAHA,
507 AV_CODEC_ID_ADPCM_SBPRO_4,
508 AV_CODEC_ID_ADPCM_SBPRO_3,
509 AV_CODEC_ID_ADPCM_SBPRO_2,
510 AV_CODEC_ID_ADPCM_THP,
511 AV_CODEC_ID_ADPCM_IMA_AMV,
512 AV_CODEC_ID_ADPCM_EA_R1,
513 AV_CODEC_ID_ADPCM_EA_R3,
514 AV_CODEC_ID_ADPCM_EA_R2,
515 AV_CODEC_ID_ADPCM_IMA_EA_SEAD,
516 AV_CODEC_ID_ADPCM_IMA_EA_EACS,
517 AV_CODEC_ID_ADPCM_EA_XAS,
518 AV_CODEC_ID_ADPCM_EA_MAXIS_XA,
519 AV_CODEC_ID_ADPCM_IMA_ISS,
520 AV_CODEC_ID_ADPCM_G722,
521 AV_CODEC_ID_ADPCM_IMA_APC,
522 AV_CODEC_ID_ADPCM_VIMA,
523 #if FF_API_VIMA_DECODER
524 AV_CODEC_ID_VIMA = AV_CODEC_ID_ADPCM_VIMA,
527 AV_CODEC_ID_ADPCM_AFC = 0x11800,
528 AV_CODEC_ID_ADPCM_IMA_OKI,
529 AV_CODEC_ID_ADPCM_DTK,
530 AV_CODEC_ID_ADPCM_IMA_RAD,
531 AV_CODEC_ID_ADPCM_G726LE,
532 AV_CODEC_ID_ADPCM_THP_LE,
533 AV_CODEC_ID_ADPCM_PSX,
534 AV_CODEC_ID_ADPCM_AICA,
535 AV_CODEC_ID_ADPCM_IMA_DAT4,
536 AV_CODEC_ID_ADPCM_MTAF,
539 AV_CODEC_ID_AMR_NB = 0x12000,
542 /* RealAudio codecs*/
543 AV_CODEC_ID_RA_144 = 0x13000,
546 /* various DPCM codecs */
547 AV_CODEC_ID_ROQ_DPCM = 0x14000,
548 AV_CODEC_ID_INTERPLAY_DPCM,
549 AV_CODEC_ID_XAN_DPCM,
550 AV_CODEC_ID_SOL_DPCM,
552 AV_CODEC_ID_SDX2_DPCM = 0x14800,
553 AV_CODEC_ID_GREMLIN_DPCM,
556 AV_CODEC_ID_MP2 = 0x15000,
557 AV_CODEC_ID_MP3, ///< preferred ID for decoding MPEG audio layer 1, 2 or 3
567 AV_CODEC_ID_VMDAUDIO,
573 AV_CODEC_ID_WESTWOOD_SND1,
574 AV_CODEC_ID_GSM, ///< as in Berlin toast format
577 AV_CODEC_ID_TRUESPEECH,
579 AV_CODEC_ID_SMACKAUDIO,
582 AV_CODEC_ID_DSICINAUDIO,
584 AV_CODEC_ID_MUSEPACK7,
586 AV_CODEC_ID_GSM_MS, /* as found in WAV */
592 AV_CODEC_ID_NELLYMOSER,
593 AV_CODEC_ID_MUSEPACK8,
595 AV_CODEC_ID_WMAVOICE,
597 AV_CODEC_ID_WMALOSSLESS,
606 AV_CODEC_ID_BINKAUDIO_RDFT,
607 AV_CODEC_ID_BINKAUDIO_DCT,
608 AV_CODEC_ID_AAC_LATM,
613 AV_CODEC_ID_8SVX_EXP,
614 AV_CODEC_ID_8SVX_FIB,
615 AV_CODEC_ID_BMV_AUDIO,
620 AV_CODEC_ID_COMFORT_NOISE,
622 AV_CODEC_ID_METASOUND,
623 AV_CODEC_ID_PAF_AUDIO,
627 AV_CODEC_ID_FFWAVESYNTH = 0x15800,
629 AV_CODEC_ID_SONIC_LS,
632 AV_CODEC_ID_DSD_LSBF,
633 AV_CODEC_ID_DSD_MSBF,
634 AV_CODEC_ID_DSD_LSBF_PLANAR,
635 AV_CODEC_ID_DSD_MSBF_PLANAR,
637 AV_CODEC_ID_INTERPLAY_ACM,
641 AV_CODEC_ID_ATRAC3AL,
642 AV_CODEC_ID_ATRAC3PAL,
645 /* subtitle codecs */
646 AV_CODEC_ID_FIRST_SUBTITLE = 0x17000, ///< A dummy ID pointing at the start of subtitle codecs.
647 AV_CODEC_ID_DVD_SUBTITLE = 0x17000,
648 AV_CODEC_ID_DVB_SUBTITLE,
649 AV_CODEC_ID_TEXT, ///< raw UTF-8 text
652 AV_CODEC_ID_MOV_TEXT,
653 AV_CODEC_ID_HDMV_PGS_SUBTITLE,
654 AV_CODEC_ID_DVB_TELETEXT,
657 AV_CODEC_ID_MICRODVD = 0x17800,
661 AV_CODEC_ID_REALTEXT,
663 AV_CODEC_ID_SUBVIEWER1,
664 AV_CODEC_ID_SUBVIEWER,
671 AV_CODEC_ID_HDMV_TEXT_SUBTITLE,
673 /* other specific kind of codecs (generally used for attachments) */
674 AV_CODEC_ID_FIRST_UNKNOWN = 0x18000, ///< A dummy ID pointing at the start of various fake codecs.
675 AV_CODEC_ID_TTF = 0x18000,
677 AV_CODEC_ID_SCTE_35, ///< Contain timestamp estimated through PCR of program stream.
678 AV_CODEC_ID_BINTEXT = 0x18800,
682 AV_CODEC_ID_SMPTE_KLV,
684 AV_CODEC_ID_TIMED_ID3,
685 AV_CODEC_ID_BIN_DATA,
688 AV_CODEC_ID_PROBE = 0x19000, ///< codec_id is not known (like AV_CODEC_ID_NONE) but lavf should attempt to identify it
690 AV_CODEC_ID_MPEG2TS = 0x20000, /**< _FAKE_ codec to indicate a raw MPEG-2 TS
691 * stream (only used by libavformat) */
692 AV_CODEC_ID_MPEG4SYSTEMS = 0x20001, /**< _FAKE_ codec to indicate a MPEG-4 Systems
693 * stream (only used by libavformat) */
694 AV_CODEC_ID_FFMETADATA = 0x21000, ///< Dummy codec for streams containing only metadata information.
695 AV_CODEC_ID_WRAPPED_AVFRAME = 0x21001, ///< Passthrough codec, AVFrames wrapped in AVPacket
699 * This struct describes the properties of a single codec described by an
701 * @see avcodec_descriptor_get()
703 typedef struct AVCodecDescriptor {
705 enum AVMediaType type;
707 * Name of the codec described by this descriptor. It is non-empty and
708 * unique for each codec descriptor. It should contain alphanumeric
709 * characters and '_' only.
713 * A more descriptive name for this codec. May be NULL.
715 const char *long_name;
717 * Codec properties, a combination of AV_CODEC_PROP_* flags.
721 * MIME type(s) associated with the codec.
722 * May be NULL; if not, a NULL-terminated array of MIME types.
723 * The first item is always non-NULL and is the preferred MIME type.
725 const char *const *mime_types;
727 * If non-NULL, an array of profiles recognized for this codec.
728 * Terminated with FF_PROFILE_UNKNOWN.
730 const struct AVProfile *profiles;
734 * Codec uses only intra compression.
735 * Video and audio codecs only.
737 #define AV_CODEC_PROP_INTRA_ONLY (1 << 0)
739 * Codec supports lossy compression. Audio and video codecs only.
740 * @note a codec may support both lossy and lossless
743 #define AV_CODEC_PROP_LOSSY (1 << 1)
745 * Codec supports lossless compression. Audio and video codecs only.
747 #define AV_CODEC_PROP_LOSSLESS (1 << 2)
749 * Codec supports frame reordering. That is, the coded order (the order in which
750 * the encoded packets are output by the encoders / stored / input to the
751 * decoders) may be different from the presentation order of the corresponding
754 * For codecs that do not have this property set, PTS and DTS should always be
757 #define AV_CODEC_PROP_REORDER (1 << 3)
759 * Subtitle codec is bitmap based
760 * Decoded AVSubtitle data can be read from the AVSubtitleRect->pict field.
762 #define AV_CODEC_PROP_BITMAP_SUB (1 << 16)
764 * Subtitle codec is text based.
765 * Decoded AVSubtitle data can be read from the AVSubtitleRect->ass field.
767 #define AV_CODEC_PROP_TEXT_SUB (1 << 17)
770 * @ingroup lavc_decoding
771 * Required number of additionally allocated bytes at the end of the input bitstream for decoding.
772 * This is mainly needed because some optimized bitstream readers read
773 * 32 or 64 bit at once and could read over the end.<br>
774 * Note: If the first 23 bits of the additional bytes are not 0, then damaged
775 * MPEG bitstreams could cause overread and segfault.
777 #define AV_INPUT_BUFFER_PADDING_SIZE 32
780 * @ingroup lavc_encoding
781 * minimum encoding buffer size
782 * Used to avoid some checks during header writing.
784 #define AV_INPUT_BUFFER_MIN_SIZE 16384
786 #if FF_API_WITHOUT_PREFIX
788 * @deprecated use AV_INPUT_BUFFER_PADDING_SIZE instead
790 #define FF_INPUT_BUFFER_PADDING_SIZE 32
793 * @deprecated use AV_INPUT_BUFFER_MIN_SIZE instead
795 #define FF_MIN_BUFFER_SIZE 16384
796 #endif /* FF_API_WITHOUT_PREFIX */
799 * @ingroup lavc_encoding
800 * motion estimation type.
801 * @deprecated use codec private option instead
803 #if FF_API_MOTION_EST
805 ME_ZERO = 1, ///< no search, that is use 0,0 vector whenever one is needed
809 ME_EPZS, ///< enhanced predictive zonal search
810 ME_X1, ///< reserved for experiments
811 ME_HEX, ///< hexagon based search
812 ME_UMH, ///< uneven multi-hexagon search
813 ME_TESA, ///< transformed exhaustive search algorithm
814 ME_ITER=50, ///< iterative search
819 * @ingroup lavc_decoding
822 /* We leave some space between them for extensions (drop some
823 * keyframes for intra-only or drop just some bidir frames). */
824 AVDISCARD_NONE =-16, ///< discard nothing
825 AVDISCARD_DEFAULT = 0, ///< discard useless packets like 0 size packets in avi
826 AVDISCARD_NONREF = 8, ///< discard all non reference
827 AVDISCARD_BIDIR = 16, ///< discard all bidirectional frames
828 AVDISCARD_NONINTRA= 24, ///< discard all non intra frames
829 AVDISCARD_NONKEY = 32, ///< discard all frames except keyframes
830 AVDISCARD_ALL = 48, ///< discard all
833 enum AVAudioServiceType {
834 AV_AUDIO_SERVICE_TYPE_MAIN = 0,
835 AV_AUDIO_SERVICE_TYPE_EFFECTS = 1,
836 AV_AUDIO_SERVICE_TYPE_VISUALLY_IMPAIRED = 2,
837 AV_AUDIO_SERVICE_TYPE_HEARING_IMPAIRED = 3,
838 AV_AUDIO_SERVICE_TYPE_DIALOGUE = 4,
839 AV_AUDIO_SERVICE_TYPE_COMMENTARY = 5,
840 AV_AUDIO_SERVICE_TYPE_EMERGENCY = 6,
841 AV_AUDIO_SERVICE_TYPE_VOICE_OVER = 7,
842 AV_AUDIO_SERVICE_TYPE_KARAOKE = 8,
843 AV_AUDIO_SERVICE_TYPE_NB , ///< Not part of ABI
847 * @ingroup lavc_encoding
849 typedef struct RcOverride{
852 int qscale; // If this is 0 then quality_factor will be used instead.
853 float quality_factor;
856 #if FF_API_MAX_BFRAMES
858 * @deprecated there is no libavcodec-wide limit on the number of B-frames
860 #define FF_MAX_B_FRAMES 16
864 These flags can be passed in AVCodecContext.flags before initialization.
865 Note: Not everything is supported yet.
869 * Allow decoders to produce frames with data planes that are not aligned
870 * to CPU requirements (e.g. due to cropping).
872 #define AV_CODEC_FLAG_UNALIGNED (1 << 0)
876 #define AV_CODEC_FLAG_QSCALE (1 << 1)
878 * 4 MV per MB allowed / advanced prediction for H.263.
880 #define AV_CODEC_FLAG_4MV (1 << 2)
882 * Output even those frames that might be corrupted.
884 #define AV_CODEC_FLAG_OUTPUT_CORRUPT (1 << 3)
888 #define AV_CODEC_FLAG_QPEL (1 << 4)
890 * Use internal 2pass ratecontrol in first pass mode.
892 #define AV_CODEC_FLAG_PASS1 (1 << 9)
894 * Use internal 2pass ratecontrol in second pass mode.
896 #define AV_CODEC_FLAG_PASS2 (1 << 10)
900 #define AV_CODEC_FLAG_LOOP_FILTER (1 << 11)
902 * Only decode/encode grayscale.
904 #define AV_CODEC_FLAG_GRAY (1 << 13)
906 * error[?] variables will be set during encoding.
908 #define AV_CODEC_FLAG_PSNR (1 << 15)
910 * Input bitstream might be truncated at a random location
911 * instead of only at frame boundaries.
913 #define AV_CODEC_FLAG_TRUNCATED (1 << 16)
915 * Use interlaced DCT.
917 #define AV_CODEC_FLAG_INTERLACED_DCT (1 << 18)
921 #define AV_CODEC_FLAG_LOW_DELAY (1 << 19)
923 * Place global headers in extradata instead of every keyframe.
925 #define AV_CODEC_FLAG_GLOBAL_HEADER (1 << 22)
927 * Use only bitexact stuff (except (I)DCT).
929 #define AV_CODEC_FLAG_BITEXACT (1 << 23)
930 /* Fx : Flag for H.263+ extra options */
932 * H.263 advanced intra coding / MPEG-4 AC prediction
934 #define AV_CODEC_FLAG_AC_PRED (1 << 24)
936 * interlaced motion estimation
938 #define AV_CODEC_FLAG_INTERLACED_ME (1 << 29)
939 #define AV_CODEC_FLAG_CLOSED_GOP (1U << 31)
942 * Allow non spec compliant speedup tricks.
944 #define AV_CODEC_FLAG2_FAST (1 << 0)
946 * Skip bitstream encoding.
948 #define AV_CODEC_FLAG2_NO_OUTPUT (1 << 2)
950 * Place global headers at every keyframe instead of in extradata.
952 #define AV_CODEC_FLAG2_LOCAL_HEADER (1 << 3)
955 * timecode is in drop frame format. DEPRECATED!!!!
957 #define AV_CODEC_FLAG2_DROP_FRAME_TIMECODE (1 << 13)
960 * Input bitstream might be truncated at a packet boundaries
961 * instead of only at frame boundaries.
963 #define AV_CODEC_FLAG2_CHUNKS (1 << 15)
965 * Discard cropping information from SPS.
967 #define AV_CODEC_FLAG2_IGNORE_CROP (1 << 16)
970 * Show all frames before the first keyframe
972 #define AV_CODEC_FLAG2_SHOW_ALL (1 << 22)
974 * Export motion vectors through frame side data
976 #define AV_CODEC_FLAG2_EXPORT_MVS (1 << 28)
978 * Do not skip samples and export skip information as frame side data
980 #define AV_CODEC_FLAG2_SKIP_MANUAL (1 << 29)
982 * Do not reset ASS ReadOrder field on flush (subtitles decoding)
984 #define AV_CODEC_FLAG2_RO_FLUSH_NOOP (1 << 30)
986 /* Unsupported options :
987 * Syntax Arithmetic coding (SAC)
988 * Reference Picture Selection
989 * Independent Segment Decoding */
991 /* codec capabilities */
994 * Decoder can use draw_horiz_band callback.
996 #define AV_CODEC_CAP_DRAW_HORIZ_BAND (1 << 0)
998 * Codec uses get_buffer() for allocating buffers and supports custom allocators.
999 * If not set, it might not use get_buffer() at all or use operations that
1000 * assume the buffer was allocated by avcodec_default_get_buffer.
1002 #define AV_CODEC_CAP_DR1 (1 << 1)
1003 #define AV_CODEC_CAP_TRUNCATED (1 << 3)
1005 * Encoder or decoder requires flushing with NULL input at the end in order to
1006 * give the complete and correct output.
1008 * NOTE: If this flag is not set, the codec is guaranteed to never be fed with
1009 * with NULL data. The user can still send NULL data to the public encode
1010 * or decode function, but libavcodec will not pass it along to the codec
1011 * unless this flag is set.
1014 * The decoder has a non-zero delay and needs to be fed with avpkt->data=NULL,
1015 * avpkt->size=0 at the end to get the delayed data until the decoder no longer
1019 * The encoder needs to be fed with NULL data at the end of encoding until the
1020 * encoder no longer returns data.
1022 * NOTE: For encoders implementing the AVCodec.encode2() function, setting this
1023 * flag also means that the encoder must set the pts and duration for
1024 * each output packet. If this flag is not set, the pts and duration will
1025 * be determined by libavcodec from the input frame.
1027 #define AV_CODEC_CAP_DELAY (1 << 5)
1029 * Codec can be fed a final frame with a smaller size.
1030 * This can be used to prevent truncation of the last audio samples.
1032 #define AV_CODEC_CAP_SMALL_LAST_FRAME (1 << 6)
1034 #if FF_API_CAP_VDPAU
1036 * Codec can export data for HW decoding (VDPAU).
1038 #define AV_CODEC_CAP_HWACCEL_VDPAU (1 << 7)
1042 * Codec can output multiple frames per AVPacket
1043 * Normally demuxers return one frame at a time, demuxers which do not do
1044 * are connected to a parser to split what they return into proper frames.
1045 * This flag is reserved to the very rare category of codecs which have a
1046 * bitstream that cannot be split into frames without timeconsuming
1047 * operations like full decoding. Demuxers carrying such bitstreams thus
1048 * may return multiple frames in a packet. This has many disadvantages like
1049 * prohibiting stream copy in many cases thus it should only be considered
1052 #define AV_CODEC_CAP_SUBFRAMES (1 << 8)
1054 * Codec is experimental and is thus avoided in favor of non experimental
1057 #define AV_CODEC_CAP_EXPERIMENTAL (1 << 9)
1059 * Codec should fill in channel configuration and samplerate instead of container
1061 #define AV_CODEC_CAP_CHANNEL_CONF (1 << 10)
1063 * Codec supports frame-level multithreading.
1065 #define AV_CODEC_CAP_FRAME_THREADS (1 << 12)
1067 * Codec supports slice-based (or partition-based) multithreading.
1069 #define AV_CODEC_CAP_SLICE_THREADS (1 << 13)
1071 * Codec supports changed parameters at any point.
1073 #define AV_CODEC_CAP_PARAM_CHANGE (1 << 14)
1075 * Codec supports avctx->thread_count == 0 (auto).
1077 #define AV_CODEC_CAP_AUTO_THREADS (1 << 15)
1079 * Audio encoder supports receiving a different number of samples in each call.
1081 #define AV_CODEC_CAP_VARIABLE_FRAME_SIZE (1 << 16)
1083 * Decoder is not a preferred choice for probing.
1084 * This indicates that the decoder is not a good choice for probing.
1085 * It could for example be an expensive to spin up hardware decoder,
1086 * or it could simply not provide a lot of useful information about
1088 * A decoder marked with this flag should only be used as last resort
1089 * choice for probing.
1091 #define AV_CODEC_CAP_AVOID_PROBING (1 << 17)
1093 * Codec is intra only.
1095 #define AV_CODEC_CAP_INTRA_ONLY 0x40000000
1097 * Codec is lossless.
1099 #define AV_CODEC_CAP_LOSSLESS 0x80000000
1102 #if FF_API_WITHOUT_PREFIX
1104 * Allow decoders to produce frames with data planes that are not aligned
1105 * to CPU requirements (e.g. due to cropping).
1107 #define CODEC_FLAG_UNALIGNED AV_CODEC_FLAG_UNALIGNED
1108 #define CODEC_FLAG_QSCALE AV_CODEC_FLAG_QSCALE
1109 #define CODEC_FLAG_4MV AV_CODEC_FLAG_4MV
1110 #define CODEC_FLAG_OUTPUT_CORRUPT AV_CODEC_FLAG_OUTPUT_CORRUPT
1111 #define CODEC_FLAG_QPEL AV_CODEC_FLAG_QPEL
1114 * @deprecated use the "gmc" private option of the libxvid encoder
1116 #define CODEC_FLAG_GMC 0x0020 ///< Use GMC.
1120 * @deprecated use the flag "mv0" in the "mpv_flags" private option of the
1121 * mpegvideo encoders
1123 #define CODEC_FLAG_MV0 0x0040
1125 #if FF_API_INPUT_PRESERVED
1127 * @deprecated passing reference-counted frames to the encoders replaces this
1130 #define CODEC_FLAG_INPUT_PRESERVED 0x0100
1132 #define CODEC_FLAG_PASS1 AV_CODEC_FLAG_PASS1
1133 #define CODEC_FLAG_PASS2 AV_CODEC_FLAG_PASS2
1134 #define CODEC_FLAG_GRAY AV_CODEC_FLAG_GRAY
1137 * @deprecated edges are not used/required anymore. I.e. this flag is now always
1140 #define CODEC_FLAG_EMU_EDGE 0x4000
1142 #define CODEC_FLAG_PSNR AV_CODEC_FLAG_PSNR
1143 #define CODEC_FLAG_TRUNCATED AV_CODEC_FLAG_TRUNCATED
1145 #if FF_API_NORMALIZE_AQP
1147 * @deprecated use the flag "naq" in the "mpv_flags" private option of the
1148 * mpegvideo encoders
1150 #define CODEC_FLAG_NORMALIZE_AQP 0x00020000
1152 #define CODEC_FLAG_INTERLACED_DCT AV_CODEC_FLAG_INTERLACED_DCT
1153 #define CODEC_FLAG_LOW_DELAY AV_CODEC_FLAG_LOW_DELAY
1154 #define CODEC_FLAG_GLOBAL_HEADER AV_CODEC_FLAG_GLOBAL_HEADER
1155 #define CODEC_FLAG_BITEXACT AV_CODEC_FLAG_BITEXACT
1156 #define CODEC_FLAG_AC_PRED AV_CODEC_FLAG_AC_PRED
1157 #define CODEC_FLAG_LOOP_FILTER AV_CODEC_FLAG_LOOP_FILTER
1158 #define CODEC_FLAG_INTERLACED_ME AV_CODEC_FLAG_INTERLACED_ME
1159 #define CODEC_FLAG_CLOSED_GOP AV_CODEC_FLAG_CLOSED_GOP
1160 #define CODEC_FLAG2_FAST AV_CODEC_FLAG2_FAST
1161 #define CODEC_FLAG2_NO_OUTPUT AV_CODEC_FLAG2_NO_OUTPUT
1162 #define CODEC_FLAG2_LOCAL_HEADER AV_CODEC_FLAG2_LOCAL_HEADER
1163 #define CODEC_FLAG2_DROP_FRAME_TIMECODE AV_CODEC_FLAG2_DROP_FRAME_TIMECODE
1164 #define CODEC_FLAG2_IGNORE_CROP AV_CODEC_FLAG2_IGNORE_CROP
1166 #define CODEC_FLAG2_CHUNKS AV_CODEC_FLAG2_CHUNKS
1167 #define CODEC_FLAG2_SHOW_ALL AV_CODEC_FLAG2_SHOW_ALL
1168 #define CODEC_FLAG2_EXPORT_MVS AV_CODEC_FLAG2_EXPORT_MVS
1169 #define CODEC_FLAG2_SKIP_MANUAL AV_CODEC_FLAG2_SKIP_MANUAL
1171 /* Unsupported options :
1172 * Syntax Arithmetic coding (SAC)
1173 * Reference Picture Selection
1174 * Independent Segment Decoding */
1176 /* codec capabilities */
1178 #define CODEC_CAP_DRAW_HORIZ_BAND AV_CODEC_CAP_DRAW_HORIZ_BAND ///< Decoder can use draw_horiz_band callback.
1180 * Codec uses get_buffer() for allocating buffers and supports custom allocators.
1181 * If not set, it might not use get_buffer() at all or use operations that
1182 * assume the buffer was allocated by avcodec_default_get_buffer.
1184 #define CODEC_CAP_DR1 AV_CODEC_CAP_DR1
1185 #define CODEC_CAP_TRUNCATED AV_CODEC_CAP_TRUNCATED
1187 /* Codec can export data for HW decoding. This flag indicates that
1188 * the codec would call get_format() with list that might contain HW accelerated
1189 * pixel formats (XvMC, VDPAU, VAAPI, etc). The application can pick any of them
1190 * including raw image format.
1191 * The application can use the passed context to determine bitstream version,
1192 * chroma format, resolution etc.
1194 #define CODEC_CAP_HWACCEL 0x0010
1195 #endif /* FF_API_XVMC */
1197 * Encoder or decoder requires flushing with NULL input at the end in order to
1198 * give the complete and correct output.
1200 * NOTE: If this flag is not set, the codec is guaranteed to never be fed with
1201 * with NULL data. The user can still send NULL data to the public encode
1202 * or decode function, but libavcodec will not pass it along to the codec
1203 * unless this flag is set.
1206 * The decoder has a non-zero delay and needs to be fed with avpkt->data=NULL,
1207 * avpkt->size=0 at the end to get the delayed data until the decoder no longer
1211 * The encoder needs to be fed with NULL data at the end of encoding until the
1212 * encoder no longer returns data.
1214 * NOTE: For encoders implementing the AVCodec.encode2() function, setting this
1215 * flag also means that the encoder must set the pts and duration for
1216 * each output packet. If this flag is not set, the pts and duration will
1217 * be determined by libavcodec from the input frame.
1219 #define CODEC_CAP_DELAY AV_CODEC_CAP_DELAY
1221 * Codec can be fed a final frame with a smaller size.
1222 * This can be used to prevent truncation of the last audio samples.
1224 #define CODEC_CAP_SMALL_LAST_FRAME AV_CODEC_CAP_SMALL_LAST_FRAME
1225 #if FF_API_CAP_VDPAU
1227 * Codec can export data for HW decoding (VDPAU).
1229 #define CODEC_CAP_HWACCEL_VDPAU AV_CODEC_CAP_HWACCEL_VDPAU
1232 * Codec can output multiple frames per AVPacket
1233 * Normally demuxers return one frame at a time, demuxers which do not do
1234 * are connected to a parser to split what they return into proper frames.
1235 * This flag is reserved to the very rare category of codecs which have a
1236 * bitstream that cannot be split into frames without timeconsuming
1237 * operations like full decoding. Demuxers carrying such bitstreams thus
1238 * may return multiple frames in a packet. This has many disadvantages like
1239 * prohibiting stream copy in many cases thus it should only be considered
1242 #define CODEC_CAP_SUBFRAMES AV_CODEC_CAP_SUBFRAMES
1244 * Codec is experimental and is thus avoided in favor of non experimental
1247 #define CODEC_CAP_EXPERIMENTAL AV_CODEC_CAP_EXPERIMENTAL
1249 * Codec should fill in channel configuration and samplerate instead of container
1251 #define CODEC_CAP_CHANNEL_CONF AV_CODEC_CAP_CHANNEL_CONF
1252 #if FF_API_NEG_LINESIZES
1254 * @deprecated no codecs use this capability
1256 #define CODEC_CAP_NEG_LINESIZES 0x0800
1259 * Codec supports frame-level multithreading.
1261 #define CODEC_CAP_FRAME_THREADS AV_CODEC_CAP_FRAME_THREADS
1263 * Codec supports slice-based (or partition-based) multithreading.
1265 #define CODEC_CAP_SLICE_THREADS AV_CODEC_CAP_SLICE_THREADS
1267 * Codec supports changed parameters at any point.
1269 #define CODEC_CAP_PARAM_CHANGE AV_CODEC_CAP_PARAM_CHANGE
1271 * Codec supports avctx->thread_count == 0 (auto).
1273 #define CODEC_CAP_AUTO_THREADS AV_CODEC_CAP_AUTO_THREADS
1275 * Audio encoder supports receiving a different number of samples in each call.
1277 #define CODEC_CAP_VARIABLE_FRAME_SIZE AV_CODEC_CAP_VARIABLE_FRAME_SIZE
1279 * Codec is intra only.
1281 #define CODEC_CAP_INTRA_ONLY AV_CODEC_CAP_INTRA_ONLY
1283 * Codec is lossless.
1285 #define CODEC_CAP_LOSSLESS AV_CODEC_CAP_LOSSLESS
1288 * HWAccel is experimental and is thus avoided in favor of non experimental
1291 #define HWACCEL_CODEC_CAP_EXPERIMENTAL 0x0200
1292 #endif /* FF_API_WITHOUT_PREFIX */
1295 //The following defines may change, don't expect compatibility if you use them.
1296 #define MB_TYPE_INTRA4x4 0x0001
1297 #define MB_TYPE_INTRA16x16 0x0002 //FIXME H.264-specific
1298 #define MB_TYPE_INTRA_PCM 0x0004 //FIXME H.264-specific
1299 #define MB_TYPE_16x16 0x0008
1300 #define MB_TYPE_16x8 0x0010
1301 #define MB_TYPE_8x16 0x0020
1302 #define MB_TYPE_8x8 0x0040
1303 #define MB_TYPE_INTERLACED 0x0080
1304 #define MB_TYPE_DIRECT2 0x0100 //FIXME
1305 #define MB_TYPE_ACPRED 0x0200
1306 #define MB_TYPE_GMC 0x0400
1307 #define MB_TYPE_SKIP 0x0800
1308 #define MB_TYPE_P0L0 0x1000
1309 #define MB_TYPE_P1L0 0x2000
1310 #define MB_TYPE_P0L1 0x4000
1311 #define MB_TYPE_P1L1 0x8000
1312 #define MB_TYPE_L0 (MB_TYPE_P0L0 | MB_TYPE_P1L0)
1313 #define MB_TYPE_L1 (MB_TYPE_P0L1 | MB_TYPE_P1L1)
1314 #define MB_TYPE_L0L1 (MB_TYPE_L0 | MB_TYPE_L1)
1315 #define MB_TYPE_QUANT 0x00010000
1316 #define MB_TYPE_CBP 0x00020000
1317 // Note bits 24-31 are reserved for codec specific use (H.264 ref0, MPEG-1 0mv, ...)
1322 * This specifies the area which should be displayed.
1323 * Note there may be multiple such areas for one frame.
1325 typedef struct AVPanScan{
1328 * - encoding: Set by user.
1329 * - decoding: Set by libavcodec.
1334 * width and height in 1/16 pel
1335 * - encoding: Set by user.
1336 * - decoding: Set by libavcodec.
1342 * position of the top left corner in 1/16 pel for up to 3 fields/frames
1343 * - encoding: Set by user.
1344 * - decoding: Set by libavcodec.
1346 int16_t position[3][2];
1350 * This structure describes the bitrate properties of an encoded bitstream. It
1351 * roughly corresponds to a subset the VBV parameters for MPEG-2 or HRD
1352 * parameters for H.264/HEVC.
1354 typedef struct AVCPBProperties {
1356 * Maximum bitrate of the stream, in bits per second.
1357 * Zero if unknown or unspecified.
1361 * Minimum bitrate of the stream, in bits per second.
1362 * Zero if unknown or unspecified.
1366 * Average bitrate of the stream, in bits per second.
1367 * Zero if unknown or unspecified.
1372 * The size of the buffer to which the ratecontrol is applied, in bits.
1373 * Zero if unknown or unspecified.
1378 * The delay between the time the packet this structure is associated with
1379 * is received and the time when it should be decoded, in periods of a 27MHz
1382 * UINT64_MAX when unknown or unspecified.
1387 #if FF_API_QSCALE_TYPE
1388 #define FF_QSCALE_TYPE_MPEG1 0
1389 #define FF_QSCALE_TYPE_MPEG2 1
1390 #define FF_QSCALE_TYPE_H264 2
1391 #define FF_QSCALE_TYPE_VP56 3
1395 * The decoder will keep a reference to the frame and may reuse it later.
1397 #define AV_GET_BUFFER_FLAG_REF (1 << 0)
1400 * @defgroup lavc_packet AVPacket
1402 * Types and functions for working with AVPacket.
1405 enum AVPacketSideDataType {
1407 * An AV_PKT_DATA_PALETTE side data packet contains exactly AVPALETTE_SIZE
1408 * bytes worth of palette. This side data signals that a new palette is
1411 AV_PKT_DATA_PALETTE,
1414 * The AV_PKT_DATA_NEW_EXTRADATA is used to notify the codec or the format
1415 * that the extradata buffer was changed and the receiving side should
1416 * act upon it appropriately. The new extradata is embedded in the side
1417 * data buffer and should be immediately used for processing the current
1420 AV_PKT_DATA_NEW_EXTRADATA,
1423 * An AV_PKT_DATA_PARAM_CHANGE side data packet is laid out as follows:
1426 * if (param_flags & AV_SIDE_DATA_PARAM_CHANGE_CHANNEL_COUNT)
1427 * s32le channel_count
1428 * if (param_flags & AV_SIDE_DATA_PARAM_CHANGE_CHANNEL_LAYOUT)
1429 * u64le channel_layout
1430 * if (param_flags & AV_SIDE_DATA_PARAM_CHANGE_SAMPLE_RATE)
1432 * if (param_flags & AV_SIDE_DATA_PARAM_CHANGE_DIMENSIONS)
1437 AV_PKT_DATA_PARAM_CHANGE,
1440 * An AV_PKT_DATA_H263_MB_INFO side data packet contains a number of
1441 * structures with info about macroblocks relevant to splitting the
1442 * packet into smaller packets on macroblock edges (e.g. as for RFC 2190).
1443 * That is, it does not necessarily contain info about all macroblocks,
1444 * as long as the distance between macroblocks in the info is smaller
1445 * than the target payload size.
1446 * Each MB info structure is 12 bytes, and is laid out as follows:
1448 * u32le bit offset from the start of the packet
1449 * u8 current quantizer at the start of the macroblock
1451 * u16le macroblock address within the GOB
1452 * u8 horizontal MV predictor
1453 * u8 vertical MV predictor
1454 * u8 horizontal MV predictor for block number 3
1455 * u8 vertical MV predictor for block number 3
1458 AV_PKT_DATA_H263_MB_INFO,
1461 * This side data should be associated with an audio stream and contains
1462 * ReplayGain information in form of the AVReplayGain struct.
1464 AV_PKT_DATA_REPLAYGAIN,
1467 * This side data contains a 3x3 transformation matrix describing an affine
1468 * transformation that needs to be applied to the decoded video frames for
1469 * correct presentation.
1471 * See libavutil/display.h for a detailed description of the data.
1473 AV_PKT_DATA_DISPLAYMATRIX,
1476 * This side data should be associated with a video stream and contains
1477 * Stereoscopic 3D information in form of the AVStereo3D struct.
1479 AV_PKT_DATA_STEREO3D,
1482 * This side data should be associated with an audio stream and corresponds
1483 * to enum AVAudioServiceType.
1485 AV_PKT_DATA_AUDIO_SERVICE_TYPE,
1488 * This side data contains quality related information from the encoder.
1490 * u32le quality factor of the compressed frame. Allowed range is between 1 (good) and FF_LAMBDA_MAX (bad).
1494 * u64le[error count] sum of squared differences between encoder in and output
1497 AV_PKT_DATA_QUALITY_STATS,
1500 * This side data contains an integer value representing the stream index
1501 * of a "fallback" track. A fallback track indicates an alternate
1502 * track to use when the current track can not be decoded for some reason.
1503 * e.g. no decoder available for codec.
1505 AV_PKT_DATA_FALLBACK_TRACK,
1508 * This side data corresponds to the AVCPBProperties struct.
1510 AV_PKT_DATA_CPB_PROPERTIES,
1513 * Recommmends skipping the specified number of samples
1515 * u32le number of samples to skip from start of this packet
1516 * u32le number of samples to skip from end of this packet
1517 * u8 reason for start skip
1518 * u8 reason for end skip (0=padding silence, 1=convergence)
1521 AV_PKT_DATA_SKIP_SAMPLES=70,
1524 * An AV_PKT_DATA_JP_DUALMONO side data packet indicates that
1525 * the packet may contain "dual mono" audio specific to Japanese DTV
1526 * and if it is true, recommends only the selected channel to be used.
1528 * u8 selected channels (0=mail/left, 1=sub/right, 2=both)
1531 AV_PKT_DATA_JP_DUALMONO,
1534 * A list of zero terminated key/value strings. There is no end marker for
1535 * the list, so it is required to rely on the side data size to stop.
1537 AV_PKT_DATA_STRINGS_METADATA,
1540 * Subtitle event position
1548 AV_PKT_DATA_SUBTITLE_POSITION,
1551 * Data found in BlockAdditional element of matroska container. There is
1552 * no end marker for the data, so it is required to rely on the side data
1553 * size to recognize the end. 8 byte id (as found in BlockAddId) followed
1556 AV_PKT_DATA_MATROSKA_BLOCKADDITIONAL,
1559 * The optional first identifier line of a WebVTT cue.
1561 AV_PKT_DATA_WEBVTT_IDENTIFIER,
1564 * The optional settings (rendering instructions) that immediately
1565 * follow the timestamp specifier of a WebVTT cue.
1567 AV_PKT_DATA_WEBVTT_SETTINGS,
1570 * A list of zero terminated key/value strings. There is no end marker for
1571 * the list, so it is required to rely on the side data size to stop. This
1572 * side data includes updated metadata which appeared in the stream.
1574 AV_PKT_DATA_METADATA_UPDATE,
1577 * MPEGTS stream ID, this is required to pass the stream ID
1578 * information from the demuxer to the corresponding muxer.
1580 AV_PKT_DATA_MPEGTS_STREAM_ID,
1583 * Mastering display metadata (based on SMPTE-2086:2014). This metadata
1584 * should be associated with a video stream and contains data in the form
1585 * of the AVMasteringDisplayMetadata struct.
1587 AV_PKT_DATA_MASTERING_DISPLAY_METADATA,
1590 * This side data should be associated with a video stream and corresponds
1591 * to the AVSphericalMapping structure.
1593 AV_PKT_DATA_SPHERICAL,
1596 * Content light level (based on CTA-861.3). This metadata should be
1597 * associated with a video stream and contains data in the form of the
1598 * AVContentLightMetadata struct.
1600 AV_PKT_DATA_CONTENT_LIGHT_LEVEL,
1603 * ATSC A53 Part 4 Closed Captions. This metadata should be associated with
1604 * a video stream. A53 CC bitstream is stored as uint8_t in AVPacketSideData.data.
1605 * The number of bytes of CC data is AVPacketSideData.size.
1610 * The number of side data elements (in fact a bit more than it).
1611 * This is not part of the public API/ABI in the sense that it may
1612 * change when new side data types are added.
1613 * This must stay the last enum value.
1614 * If its value becomes huge, some code using it
1615 * needs to be updated as it assumes it to be smaller than other limits.
1620 #define AV_PKT_DATA_QUALITY_FACTOR AV_PKT_DATA_QUALITY_STATS //DEPRECATED
1622 typedef struct AVPacketSideData {
1625 enum AVPacketSideDataType type;
1629 * This structure stores compressed data. It is typically exported by demuxers
1630 * and then passed as input to decoders, or received as output from encoders and
1631 * then passed to muxers.
1633 * For video, it should typically contain one compressed frame. For audio it may
1634 * contain several compressed frames. Encoders are allowed to output empty
1635 * packets, with no compressed data, containing only side data
1636 * (e.g. to update some stream parameters at the end of encoding).
1638 * AVPacket is one of the few structs in FFmpeg, whose size is a part of public
1639 * ABI. Thus it may be allocated on stack and no new fields can be added to it
1640 * without libavcodec and libavformat major bump.
1642 * The semantics of data ownership depends on the buf field.
1643 * If it is set, the packet data is dynamically allocated and is
1644 * valid indefinitely until a call to av_packet_unref() reduces the
1645 * reference count to 0.
1647 * If the buf field is not set av_packet_ref() would make a copy instead
1648 * of increasing the reference count.
1650 * The side data is always allocated with av_malloc(), copied by
1651 * av_packet_ref() and freed by av_packet_unref().
1653 * @see av_packet_ref
1654 * @see av_packet_unref
1656 typedef struct AVPacket {
1658 * A reference to the reference-counted buffer where the packet data is
1660 * May be NULL, then the packet data is not reference-counted.
1664 * Presentation timestamp in AVStream->time_base units; the time at which
1665 * the decompressed packet will be presented to the user.
1666 * Can be AV_NOPTS_VALUE if it is not stored in the file.
1667 * pts MUST be larger or equal to dts as presentation cannot happen before
1668 * decompression, unless one wants to view hex dumps. Some formats misuse
1669 * the terms dts and pts/cts to mean something different. Such timestamps
1670 * must be converted to true pts/dts before they are stored in AVPacket.
1674 * Decompression timestamp in AVStream->time_base units; the time at which
1675 * the packet is decompressed.
1676 * Can be AV_NOPTS_VALUE if it is not stored in the file.
1683 * A combination of AV_PKT_FLAG values
1687 * Additional packet data that can be provided by the container.
1688 * Packet can contain several types of side information.
1690 AVPacketSideData *side_data;
1691 int side_data_elems;
1694 * Duration of this packet in AVStream->time_base units, 0 if unknown.
1695 * Equals next_pts - this_pts in presentation order.
1699 int64_t pos; ///< byte position in stream, -1 if unknown
1701 #if FF_API_CONVERGENCE_DURATION
1703 * @deprecated Same as the duration field, but as int64_t. This was required
1704 * for Matroska subtitles, whose duration values could overflow when the
1705 * duration field was still an int.
1707 attribute_deprecated
1708 int64_t convergence_duration;
1711 #define AV_PKT_FLAG_KEY 0x0001 ///< The packet contains a keyframe
1712 #define AV_PKT_FLAG_CORRUPT 0x0002 ///< The packet content is corrupted
1714 * Flag is used to discard packets which are required to maintain valid
1715 * decoder state but are not required for output and should be dropped
1718 #define AV_PKT_FLAG_DISCARD 0x0004
1720 * The packet comes from a trusted source.
1722 * Otherwise-unsafe constructs such as arbitrary pointers to data
1723 * outside the packet may be followed.
1725 #define AV_PKT_FLAG_TRUSTED 0x0008
1727 enum AVSideDataParamChangeFlags {
1728 AV_SIDE_DATA_PARAM_CHANGE_CHANNEL_COUNT = 0x0001,
1729 AV_SIDE_DATA_PARAM_CHANGE_CHANNEL_LAYOUT = 0x0002,
1730 AV_SIDE_DATA_PARAM_CHANGE_SAMPLE_RATE = 0x0004,
1731 AV_SIDE_DATA_PARAM_CHANGE_DIMENSIONS = 0x0008,
1737 struct AVCodecInternal;
1741 AV_FIELD_PROGRESSIVE,
1742 AV_FIELD_TT, //< Top coded_first, top displayed first
1743 AV_FIELD_BB, //< Bottom coded first, bottom displayed first
1744 AV_FIELD_TB, //< Top coded first, bottom displayed first
1745 AV_FIELD_BT, //< Bottom coded first, top displayed first
1749 * main external API structure.
1750 * New fields can be added to the end with minor version bumps.
1751 * Removal, reordering and changes to existing fields require a major
1753 * You can use AVOptions (av_opt* / av_set/get*()) to access these fields from user
1755 * The name string for AVOptions options matches the associated command line
1756 * parameter name and can be found in libavcodec/options_table.h
1757 * The AVOption/command line parameter names differ in some cases from the C
1758 * structure field names for historic reasons or brevity.
1759 * sizeof(AVCodecContext) must not be used outside libav*.
1761 typedef struct AVCodecContext {
1763 * information on struct for av_log
1764 * - set by avcodec_alloc_context3
1766 const AVClass *av_class;
1767 int log_level_offset;
1769 enum AVMediaType codec_type; /* see AVMEDIA_TYPE_xxx */
1770 const struct AVCodec *codec;
1771 #if FF_API_CODEC_NAME
1773 * @deprecated this field is not used for anything in libavcodec
1775 attribute_deprecated
1776 char codec_name[32];
1778 enum AVCodecID codec_id; /* see AV_CODEC_ID_xxx */
1781 * fourcc (LSB first, so "ABCD" -> ('D'<<24) + ('C'<<16) + ('B'<<8) + 'A').
1782 * This is used to work around some encoder bugs.
1783 * A demuxer should set this to what is stored in the field used to identify the codec.
1784 * If there are multiple such fields in a container then the demuxer should choose the one
1785 * which maximizes the information about the used codec.
1786 * If the codec tag field in a container is larger than 32 bits then the demuxer should
1787 * remap the longer ID to 32 bits with a table or other structure. Alternatively a new
1788 * extra_codec_tag + size could be added but for this a clear advantage must be demonstrated
1790 * - encoding: Set by user, if not then the default based on codec_id will be used.
1791 * - decoding: Set by user, will be converted to uppercase by libavcodec during init.
1793 unsigned int codec_tag;
1795 #if FF_API_STREAM_CODEC_TAG
1797 * @deprecated this field is unused
1799 attribute_deprecated
1800 unsigned int stream_codec_tag;
1806 * Private context used for internal data.
1808 * Unlike priv_data, this is not codec-specific. It is used in general
1809 * libavcodec functions.
1811 struct AVCodecInternal *internal;
1814 * Private data of the user, can be used to carry app specific stuff.
1815 * - encoding: Set by user.
1816 * - decoding: Set by user.
1821 * the average bitrate
1822 * - encoding: Set by user; unused for constant quantizer encoding.
1823 * - decoding: Set by user, may be overwritten by libavcodec
1824 * if this info is available in the stream
1829 * number of bits the bitstream is allowed to diverge from the reference.
1830 * the reference can be CBR (for CBR pass1) or VBR (for pass2)
1831 * - encoding: Set by user; unused for constant quantizer encoding.
1832 * - decoding: unused
1834 int bit_rate_tolerance;
1837 * Global quality for codecs which cannot change it per frame.
1838 * This should be proportional to MPEG-1/2/4 qscale.
1839 * - encoding: Set by user.
1840 * - decoding: unused
1845 * - encoding: Set by user.
1846 * - decoding: unused
1848 int compression_level;
1849 #define FF_COMPRESSION_DEFAULT -1
1853 * - encoding: Set by user.
1854 * - decoding: Set by user.
1860 * - encoding: Set by user.
1861 * - decoding: Set by user.
1866 * some codecs need / can use extradata like Huffman tables.
1867 * MJPEG: Huffman tables
1868 * rv10: additional flags
1869 * MPEG-4: global headers (they can be in the bitstream or here)
1870 * The allocated memory should be AV_INPUT_BUFFER_PADDING_SIZE bytes larger
1871 * than extradata_size to avoid problems if it is read with the bitstream reader.
1872 * The bytewise contents of extradata must not depend on the architecture or CPU endianness.
1873 * - encoding: Set/allocated/freed by libavcodec.
1874 * - decoding: Set/allocated/freed by user.
1880 * This is the fundamental unit of time (in seconds) in terms
1881 * of which frame timestamps are represented. For fixed-fps content,
1882 * timebase should be 1/framerate and timestamp increments should be
1884 * This often, but not always is the inverse of the frame rate or field rate
1885 * for video. 1/time_base is not the average frame rate if the frame rate is not
1888 * Like containers, elementary streams also can store timestamps, 1/time_base
1889 * is the unit in which these timestamps are specified.
1890 * As example of such codec time base see ISO/IEC 14496-2:2001(E)
1891 * vop_time_increment_resolution and fixed_vop_rate
1892 * (fixed_vop_rate == 0 implies that it is different from the framerate)
1894 * - encoding: MUST be set by user.
1895 * - decoding: the use of this field for decoding is deprecated.
1896 * Use framerate instead.
1898 AVRational time_base;
1901 * For some codecs, the time base is closer to the field rate than the frame rate.
1902 * Most notably, H.264 and MPEG-2 specify time_base as half of frame duration
1903 * if no telecine is used ...
1905 * Set to time_base ticks per frame. Default 1, e.g., H.264/MPEG-2 set it to 2.
1907 int ticks_per_frame;
1912 * Encoding: Number of frames delay there will be from the encoder input to
1913 * the decoder output. (we assume the decoder matches the spec)
1914 * Decoding: Number of frames delay in addition to what a standard decoder
1915 * as specified in the spec would produce.
1918 * Number of frames the decoded output will be delayed relative to the
1922 * For encoding, this field is unused (see initial_padding).
1924 * For decoding, this is the number of samples the decoder needs to
1925 * output before the decoder's output is valid. When seeking, you should
1926 * start decoding this many samples prior to your desired seek point.
1928 * - encoding: Set by libavcodec.
1929 * - decoding: Set by libavcodec.
1936 * picture width / height.
1938 * @note Those fields may not match the values of the last
1939 * AVFrame output by avcodec_decode_video2 due frame
1942 * - encoding: MUST be set by user.
1943 * - decoding: May be set by the user before opening the decoder if known e.g.
1944 * from the container. Some decoders will require the dimensions
1945 * to be set by the caller. During decoding, the decoder may
1946 * overwrite those values as required while parsing the data.
1951 * Bitstream width / height, may be different from width/height e.g. when
1952 * the decoded frame is cropped before being output or lowres is enabled.
1954 * @note Those field may not match the value of the last
1955 * AVFrame output by avcodec_receive_frame() due frame
1958 * - encoding: unused
1959 * - decoding: May be set by the user before opening the decoder if known
1960 * e.g. from the container. During decoding, the decoder may
1961 * overwrite those values as required while parsing the data.
1963 int coded_width, coded_height;
1965 #if FF_API_ASPECT_EXTENDED
1966 #define FF_ASPECT_EXTENDED 15
1970 * the number of pictures in a group of pictures, or 0 for intra_only
1971 * - encoding: Set by user.
1972 * - decoding: unused
1977 * Pixel format, see AV_PIX_FMT_xxx.
1978 * May be set by the demuxer if known from headers.
1979 * May be overridden by the decoder if it knows better.
1981 * @note This field may not match the value of the last
1982 * AVFrame output by avcodec_receive_frame() due frame
1985 * - encoding: Set by user.
1986 * - decoding: Set by user if known, overridden by libavcodec while
1989 enum AVPixelFormat pix_fmt;
1991 #if FF_API_MOTION_EST
1993 * This option does nothing
1994 * @deprecated use codec private options instead
1996 attribute_deprecated int me_method;
2000 * If non NULL, 'draw_horiz_band' is called by the libavcodec
2001 * decoder to draw a horizontal band. It improves cache usage. Not
2002 * all codecs can do that. You must check the codec capabilities
2004 * When multithreading is used, it may be called from multiple threads
2005 * at the same time; threads might draw different parts of the same AVFrame,
2006 * or multiple AVFrames, and there is no guarantee that slices will be drawn
2008 * The function is also used by hardware acceleration APIs.
2009 * It is called at least once during frame decoding to pass
2010 * the data needed for hardware render.
2011 * In that mode instead of pixel data, AVFrame points to
2012 * a structure specific to the acceleration API. The application
2013 * reads the structure and can change some fields to indicate progress
2015 * - encoding: unused
2016 * - decoding: Set by user.
2017 * @param height the height of the slice
2018 * @param y the y position of the slice
2019 * @param type 1->top field, 2->bottom field, 3->frame
2020 * @param offset offset into the AVFrame.data from which the slice should be read
2022 void (*draw_horiz_band)(struct AVCodecContext *s,
2023 const AVFrame *src, int offset[AV_NUM_DATA_POINTERS],
2024 int y, int type, int height);
2027 * callback to negotiate the pixelFormat
2028 * @param fmt is the list of formats which are supported by the codec,
2029 * it is terminated by -1 as 0 is a valid format, the formats are ordered by quality.
2030 * The first is always the native one.
2031 * @note The callback may be called again immediately if initialization for
2032 * the selected (hardware-accelerated) pixel format failed.
2033 * @warning Behavior is undefined if the callback returns a value not
2034 * in the fmt list of formats.
2035 * @return the chosen format
2036 * - encoding: unused
2037 * - decoding: Set by user, if not set the native format will be chosen.
2039 enum AVPixelFormat (*get_format)(struct AVCodecContext *s, const enum AVPixelFormat * fmt);
2042 * maximum number of B-frames between non-B-frames
2043 * Note: The output will be delayed by max_b_frames+1 relative to the input.
2044 * - encoding: Set by user.
2045 * - decoding: unused
2050 * qscale factor between IP and B-frames
2051 * If > 0 then the last P-frame quantizer will be used (q= lastp_q*factor+offset).
2052 * If < 0 then normal ratecontrol will be done (q= -normal_q*factor+offset).
2053 * - encoding: Set by user.
2054 * - decoding: unused
2056 float b_quant_factor;
2058 #if FF_API_RC_STRATEGY
2059 /** @deprecated use codec private option instead */
2060 attribute_deprecated int rc_strategy;
2061 #define FF_RC_STRATEGY_XVID 1
2064 #if FF_API_PRIVATE_OPT
2065 /** @deprecated use encoder private options instead */
2066 attribute_deprecated
2067 int b_frame_strategy;
2071 * qscale offset between IP and B-frames
2072 * - encoding: Set by user.
2073 * - decoding: unused
2075 float b_quant_offset;
2078 * Size of the frame reordering buffer in the decoder.
2079 * For MPEG-2 it is 1 IPB or 0 low delay IP.
2080 * - encoding: Set by libavcodec.
2081 * - decoding: Set by libavcodec.
2085 #if FF_API_PRIVATE_OPT
2086 /** @deprecated use encoder private options instead */
2087 attribute_deprecated
2092 * qscale factor between P- and I-frames
2093 * If > 0 then the last P-frame quantizer will be used (q = lastp_q * factor + offset).
2094 * If < 0 then normal ratecontrol will be done (q= -normal_q*factor+offset).
2095 * - encoding: Set by user.
2096 * - decoding: unused
2098 float i_quant_factor;
2101 * qscale offset between P and I-frames
2102 * - encoding: Set by user.
2103 * - decoding: unused
2105 float i_quant_offset;
2108 * luminance masking (0-> disabled)
2109 * - encoding: Set by user.
2110 * - decoding: unused
2115 * temporary complexity masking (0-> disabled)
2116 * - encoding: Set by user.
2117 * - decoding: unused
2119 float temporal_cplx_masking;
2122 * spatial complexity masking (0-> disabled)
2123 * - encoding: Set by user.
2124 * - decoding: unused
2126 float spatial_cplx_masking;
2129 * p block masking (0-> disabled)
2130 * - encoding: Set by user.
2131 * - decoding: unused
2136 * darkness masking (0-> disabled)
2137 * - encoding: Set by user.
2138 * - decoding: unused
2144 * - encoding: Set by libavcodec.
2145 * - decoding: Set by user (or 0).
2149 #if FF_API_PRIVATE_OPT
2150 /** @deprecated use encoder private options instead */
2151 attribute_deprecated
2152 int prediction_method;
2153 #define FF_PRED_LEFT 0
2154 #define FF_PRED_PLANE 1
2155 #define FF_PRED_MEDIAN 2
2159 * slice offsets in the frame in bytes
2160 * - encoding: Set/allocated by libavcodec.
2161 * - decoding: Set/allocated by user (or NULL).
2166 * sample aspect ratio (0 if unknown)
2167 * That is the width of a pixel divided by the height of the pixel.
2168 * Numerator and denominator must be relatively prime and smaller than 256 for some video standards.
2169 * - encoding: Set by user.
2170 * - decoding: Set by libavcodec.
2172 AVRational sample_aspect_ratio;
2175 * motion estimation comparison function
2176 * - encoding: Set by user.
2177 * - decoding: unused
2181 * subpixel motion estimation comparison function
2182 * - encoding: Set by user.
2183 * - decoding: unused
2187 * macroblock comparison function (not supported yet)
2188 * - encoding: Set by user.
2189 * - decoding: unused
2193 * interlaced DCT comparison function
2194 * - encoding: Set by user.
2195 * - decoding: unused
2198 #define FF_CMP_SAD 0
2199 #define FF_CMP_SSE 1
2200 #define FF_CMP_SATD 2
2201 #define FF_CMP_DCT 3
2202 #define FF_CMP_PSNR 4
2203 #define FF_CMP_BIT 5
2205 #define FF_CMP_ZERO 7
2206 #define FF_CMP_VSAD 8
2207 #define FF_CMP_VSSE 9
2208 #define FF_CMP_NSSE 10
2209 #define FF_CMP_W53 11
2210 #define FF_CMP_W97 12
2211 #define FF_CMP_DCTMAX 13
2212 #define FF_CMP_DCT264 14
2213 #define FF_CMP_MEDIAN_SAD 15
2214 #define FF_CMP_CHROMA 256
2217 * ME diamond size & shape
2218 * - encoding: Set by user.
2219 * - decoding: unused
2224 * amount of previous MV predictors (2a+1 x 2a+1 square)
2225 * - encoding: Set by user.
2226 * - decoding: unused
2228 int last_predictor_count;
2230 #if FF_API_PRIVATE_OPT
2231 /** @deprecated use encoder private options instead */
2232 attribute_deprecated
2237 * motion estimation prepass comparison function
2238 * - encoding: Set by user.
2239 * - decoding: unused
2244 * ME prepass diamond size & shape
2245 * - encoding: Set by user.
2246 * - decoding: unused
2252 * - encoding: Set by user.
2253 * - decoding: unused
2255 int me_subpel_quality;
2259 * DTG active format information (additional aspect ratio
2260 * information only used in DVB MPEG-2 transport streams)
2263 * - encoding: unused
2264 * - decoding: Set by decoder.
2265 * @deprecated Deprecated in favor of AVSideData
2267 attribute_deprecated int dtg_active_format;
2268 #define FF_DTG_AFD_SAME 8
2269 #define FF_DTG_AFD_4_3 9
2270 #define FF_DTG_AFD_16_9 10
2271 #define FF_DTG_AFD_14_9 11
2272 #define FF_DTG_AFD_4_3_SP_14_9 13
2273 #define FF_DTG_AFD_16_9_SP_14_9 14
2274 #define FF_DTG_AFD_SP_4_3 15
2275 #endif /* FF_API_AFD */
2278 * maximum motion estimation search range in subpel units
2279 * If 0 then no limit.
2281 * - encoding: Set by user.
2282 * - decoding: unused
2286 #if FF_API_QUANT_BIAS
2288 * @deprecated use encoder private option instead
2290 attribute_deprecated int intra_quant_bias;
2291 #define FF_DEFAULT_QUANT_BIAS 999999
2294 * @deprecated use encoder private option instead
2296 attribute_deprecated int inter_quant_bias;
2301 * - encoding: unused
2302 * - decoding: Set by user.
2305 #define SLICE_FLAG_CODED_ORDER 0x0001 ///< draw_horiz_band() is called in coded order instead of display
2306 #define SLICE_FLAG_ALLOW_FIELD 0x0002 ///< allow draw_horiz_band() with field slices (MPEG-2 field pics)
2307 #define SLICE_FLAG_ALLOW_PLANE 0x0004 ///< allow draw_horiz_band() with 1 component at a time (SVQ1)
2311 * XVideo Motion Acceleration
2312 * - encoding: forbidden
2313 * - decoding: set by decoder
2314 * @deprecated XvMC doesn't need it anymore.
2316 attribute_deprecated int xvmc_acceleration;
2317 #endif /* FF_API_XVMC */
2320 * macroblock decision mode
2321 * - encoding: Set by user.
2322 * - decoding: unused
2325 #define FF_MB_DECISION_SIMPLE 0 ///< uses mb_cmp
2326 #define FF_MB_DECISION_BITS 1 ///< chooses the one which needs the fewest bits
2327 #define FF_MB_DECISION_RD 2 ///< rate distortion
2330 * custom intra quantization matrix
2331 * - encoding: Set by user, can be NULL.
2332 * - decoding: Set by libavcodec.
2334 uint16_t *intra_matrix;
2337 * custom inter quantization matrix
2338 * - encoding: Set by user, can be NULL.
2339 * - decoding: Set by libavcodec.
2341 uint16_t *inter_matrix;
2343 #if FF_API_PRIVATE_OPT
2344 /** @deprecated use encoder private options instead */
2345 attribute_deprecated
2346 int scenechange_threshold;
2348 /** @deprecated use encoder private options instead */
2349 attribute_deprecated
2350 int noise_reduction;
2355 * @deprecated this field is unused
2357 attribute_deprecated
2361 * @deprecated this field is unused
2363 attribute_deprecated
2368 * precision of the intra DC coefficient - 8
2369 * - encoding: Set by user.
2370 * - decoding: Set by libavcodec
2372 int intra_dc_precision;
2375 * Number of macroblock rows at the top which are skipped.
2376 * - encoding: unused
2377 * - decoding: Set by user.
2382 * Number of macroblock rows at the bottom which are skipped.
2383 * - encoding: unused
2384 * - decoding: Set by user.
2390 * @deprecated use encoder private options instead
2392 attribute_deprecated
2393 float border_masking;
2397 * minimum MB Lagrange multiplier
2398 * - encoding: Set by user.
2399 * - decoding: unused
2404 * maximum MB Lagrange multiplier
2405 * - encoding: Set by user.
2406 * - decoding: unused
2410 #if FF_API_PRIVATE_OPT
2412 * @deprecated use encoder private options instead
2414 attribute_deprecated
2415 int me_penalty_compensation;
2419 * - encoding: Set by user.
2420 * - decoding: unused
2424 #if FF_API_PRIVATE_OPT
2425 /** @deprecated use encoder private options instead */
2426 attribute_deprecated
2432 * - encoding: Set by user.
2433 * - decoding: unused
2438 * number of reference frames
2439 * - encoding: Set by user.
2440 * - decoding: Set by lavc.
2444 #if FF_API_PRIVATE_OPT
2445 /** @deprecated use encoder private options instead */
2446 attribute_deprecated
2450 #if FF_API_UNUSED_MEMBERS
2452 * Multiplied by qscale for each frame and added to scene_change_score.
2453 * - encoding: Set by user.
2454 * - decoding: unused
2456 attribute_deprecated int scenechange_factor;
2460 * Note: Value depends upon the compare function used for fullpel ME.
2461 * - encoding: Set by user.
2462 * - decoding: unused
2466 #if FF_API_PRIVATE_OPT
2467 /** @deprecated use encoder private options instead */
2468 attribute_deprecated
2473 * Chromaticity coordinates of the source primaries.
2474 * - encoding: Set by user
2475 * - decoding: Set by libavcodec
2477 enum AVColorPrimaries color_primaries;
2480 * Color Transfer Characteristic.
2481 * - encoding: Set by user
2482 * - decoding: Set by libavcodec
2484 enum AVColorTransferCharacteristic color_trc;
2487 * YUV colorspace type.
2488 * - encoding: Set by user
2489 * - decoding: Set by libavcodec
2491 enum AVColorSpace colorspace;
2494 * MPEG vs JPEG YUV range.
2495 * - encoding: Set by user
2496 * - decoding: Set by libavcodec
2498 enum AVColorRange color_range;
2501 * This defines the location of chroma samples.
2502 * - encoding: Set by user
2503 * - decoding: Set by libavcodec
2505 enum AVChromaLocation chroma_sample_location;
2509 * Indicates number of picture subdivisions. Used for parallelized
2511 * - encoding: Set by user
2512 * - decoding: unused
2517 * - encoding: set by libavcodec
2518 * - decoding: Set by user.
2520 enum AVFieldOrder field_order;
2523 int sample_rate; ///< samples per second
2524 int channels; ///< number of audio channels
2527 * audio sample format
2528 * - encoding: Set by user.
2529 * - decoding: Set by libavcodec.
2531 enum AVSampleFormat sample_fmt; ///< sample format
2533 /* The following data should not be initialized. */
2535 * Number of samples per channel in an audio frame.
2537 * - encoding: set by libavcodec in avcodec_open2(). Each submitted frame
2538 * except the last must contain exactly frame_size samples per channel.
2539 * May be 0 when the codec has AV_CODEC_CAP_VARIABLE_FRAME_SIZE set, then the
2540 * frame size is not restricted.
2541 * - decoding: may be set by some decoders to indicate constant frame size
2546 * Frame counter, set by libavcodec.
2548 * - decoding: total number of frames returned from the decoder so far.
2549 * - encoding: total number of frames passed to the encoder so far.
2551 * @note the counter is not incremented if encoding/decoding resulted in
2557 * number of bytes per packet if constant and known or 0
2558 * Used by some WAV based audio codecs.
2563 * Audio cutoff bandwidth (0 means "automatic")
2564 * - encoding: Set by user.
2565 * - decoding: unused
2570 * Audio channel layout.
2571 * - encoding: set by user.
2572 * - decoding: set by user, may be overwritten by libavcodec.
2574 uint64_t channel_layout;
2577 * Request decoder to use this channel layout if it can (0 for default)
2578 * - encoding: unused
2579 * - decoding: Set by user.
2581 uint64_t request_channel_layout;
2584 * Type of service that the audio stream conveys.
2585 * - encoding: Set by user.
2586 * - decoding: Set by libavcodec.
2588 enum AVAudioServiceType audio_service_type;
2591 * desired sample format
2592 * - encoding: Not used.
2593 * - decoding: Set by user.
2594 * Decoder will decode to this format if it can.
2596 enum AVSampleFormat request_sample_fmt;
2599 * This callback is called at the beginning of each frame to get data
2600 * buffer(s) for it. There may be one contiguous buffer for all the data or
2601 * there may be a buffer per each data plane or anything in between. What
2602 * this means is, you may set however many entries in buf[] you feel necessary.
2603 * Each buffer must be reference-counted using the AVBuffer API (see description
2606 * The following fields will be set in the frame before this callback is
2609 * - width, height (video only)
2610 * - sample_rate, channel_layout, nb_samples (audio only)
2611 * Their values may differ from the corresponding values in
2612 * AVCodecContext. This callback must use the frame values, not the codec
2613 * context values, to calculate the required buffer size.
2615 * This callback must fill the following fields in the frame:
2619 * * if the data is planar audio with more than 8 channels, then this
2620 * callback must allocate and fill extended_data to contain all pointers
2621 * to all data planes. data[] must hold as many pointers as it can.
2622 * extended_data must be allocated with av_malloc() and will be freed in
2624 * * otherwise extended_data must point to data
2625 * - buf[] must contain one or more pointers to AVBufferRef structures. Each of
2626 * the frame's data and extended_data pointers must be contained in these. That
2627 * is, one AVBufferRef for each allocated chunk of memory, not necessarily one
2628 * AVBufferRef per data[] entry. See: av_buffer_create(), av_buffer_alloc(),
2629 * and av_buffer_ref().
2630 * - extended_buf and nb_extended_buf must be allocated with av_malloc() by
2631 * this callback and filled with the extra buffers if there are more
2632 * buffers than buf[] can hold. extended_buf will be freed in
2635 * If AV_CODEC_CAP_DR1 is not set then get_buffer2() must call
2636 * avcodec_default_get_buffer2() instead of providing buffers allocated by
2639 * Each data plane must be aligned to the maximum required by the target
2642 * @see avcodec_default_get_buffer2()
2646 * If AV_GET_BUFFER_FLAG_REF is set in flags then the frame may be reused
2647 * (read and/or written to if it is writable) later by libavcodec.
2649 * avcodec_align_dimensions2() should be used to find the required width and
2650 * height, as they normally need to be rounded up to the next multiple of 16.
2652 * Some decoders do not support linesizes changing between frames.
2654 * If frame multithreading is used and thread_safe_callbacks is set,
2655 * this callback may be called from a different thread, but not from more
2656 * than one at once. Does not need to be reentrant.
2658 * @see avcodec_align_dimensions2()
2662 * Decoders request a buffer of a particular size by setting
2663 * AVFrame.nb_samples prior to calling get_buffer2(). The decoder may,
2664 * however, utilize only part of the buffer by setting AVFrame.nb_samples
2665 * to a smaller value in the output frame.
2667 * As a convenience, av_samples_get_buffer_size() and
2668 * av_samples_fill_arrays() in libavutil may be used by custom get_buffer2()
2669 * functions to find the required data size and to fill data pointers and
2670 * linesize. In AVFrame.linesize, only linesize[0] may be set for audio
2671 * since all planes must be the same size.
2673 * @see av_samples_get_buffer_size(), av_samples_fill_arrays()
2675 * - encoding: unused
2676 * - decoding: Set by libavcodec, user can override.
2678 int (*get_buffer2)(struct AVCodecContext *s, AVFrame *frame, int flags);
2681 * If non-zero, the decoded audio and video frames returned from
2682 * avcodec_decode_video2() and avcodec_decode_audio4() are reference-counted
2683 * and are valid indefinitely. The caller must free them with
2684 * av_frame_unref() when they are not needed anymore.
2685 * Otherwise, the decoded frames must not be freed by the caller and are
2686 * only valid until the next decode call.
2688 * This is always automatically enabled if avcodec_receive_frame() is used.
2690 * - encoding: unused
2691 * - decoding: set by the caller before avcodec_open2().
2693 attribute_deprecated
2694 int refcounted_frames;
2696 /* - encoding parameters */
2697 float qcompress; ///< amount of qscale change between easy & hard scenes (0.0-1.0)
2698 float qblur; ///< amount of qscale smoothing over time (0.0-1.0)
2702 * - encoding: Set by user.
2703 * - decoding: unused
2709 * - encoding: Set by user.
2710 * - decoding: unused
2715 * maximum quantizer difference between frames
2716 * - encoding: Set by user.
2717 * - decoding: unused
2723 * @deprecated use encoder private options instead
2725 attribute_deprecated
2728 attribute_deprecated
2730 attribute_deprecated
2735 * decoder bitstream buffer size
2736 * - encoding: Set by user.
2737 * - decoding: unused
2742 * ratecontrol override, see RcOverride
2743 * - encoding: Allocated/set/freed by user.
2744 * - decoding: unused
2746 int rc_override_count;
2747 RcOverride *rc_override;
2751 * @deprecated use encoder private options instead
2753 attribute_deprecated
2759 * - encoding: Set by user.
2760 * - decoding: Set by user, may be overwritten by libavcodec.
2762 int64_t rc_max_rate;
2766 * - encoding: Set by user.
2767 * - decoding: unused
2769 int64_t rc_min_rate;
2773 * @deprecated use encoder private options instead
2775 attribute_deprecated
2776 float rc_buffer_aggressivity;
2778 attribute_deprecated
2779 float rc_initial_cplx;
2783 * Ratecontrol attempt to use, at maximum, <value> of what can be used without an underflow.
2784 * - encoding: Set by user.
2785 * - decoding: unused.
2787 float rc_max_available_vbv_use;
2790 * Ratecontrol attempt to use, at least, <value> times the amount needed to prevent a vbv overflow.
2791 * - encoding: Set by user.
2792 * - decoding: unused.
2794 float rc_min_vbv_overflow_use;
2797 * Number of bits which should be loaded into the rc buffer before decoding starts.
2798 * - encoding: Set by user.
2799 * - decoding: unused
2801 int rc_initial_buffer_occupancy;
2803 #if FF_API_CODER_TYPE
2804 #define FF_CODER_TYPE_VLC 0
2805 #define FF_CODER_TYPE_AC 1
2806 #define FF_CODER_TYPE_RAW 2
2807 #define FF_CODER_TYPE_RLE 3
2808 #if FF_API_UNUSED_MEMBERS
2809 #define FF_CODER_TYPE_DEFLATE 4
2810 #endif /* FF_API_UNUSED_MEMBERS */
2812 * @deprecated use encoder private options instead
2814 attribute_deprecated
2816 #endif /* FF_API_CODER_TYPE */
2818 #if FF_API_PRIVATE_OPT
2819 /** @deprecated use encoder private options instead */
2820 attribute_deprecated
2826 * @deprecated use encoder private options instead
2828 attribute_deprecated
2832 * @deprecated use encoder private options instead
2834 attribute_deprecated
2838 #if FF_API_PRIVATE_OPT
2839 /** @deprecated use encoder private options instead */
2840 attribute_deprecated
2841 int frame_skip_threshold;
2843 /** @deprecated use encoder private options instead */
2844 attribute_deprecated
2845 int frame_skip_factor;
2847 /** @deprecated use encoder private options instead */
2848 attribute_deprecated
2851 /** @deprecated use encoder private options instead */
2852 attribute_deprecated
2854 #endif /* FF_API_PRIVATE_OPT */
2857 * trellis RD quantization
2858 * - encoding: Set by user.
2859 * - decoding: unused
2863 #if FF_API_PRIVATE_OPT
2864 /** @deprecated use encoder private options instead */
2865 attribute_deprecated
2866 int min_prediction_order;
2868 /** @deprecated use encoder private options instead */
2869 attribute_deprecated
2870 int max_prediction_order;
2872 /** @deprecated use encoder private options instead */
2873 attribute_deprecated
2874 int64_t timecode_frame_start;
2877 #if FF_API_RTP_CALLBACK
2879 * @deprecated unused
2881 /* The RTP callback: This function is called */
2882 /* every time the encoder has a packet to send. */
2883 /* It depends on the encoder if the data starts */
2884 /* with a Start Code (it should). H.263 does. */
2885 /* mb_nb contains the number of macroblocks */
2886 /* encoded in the RTP payload. */
2887 attribute_deprecated
2888 void (*rtp_callback)(struct AVCodecContext *avctx, void *data, int size, int mb_nb);
2891 #if FF_API_PRIVATE_OPT
2892 /** @deprecated use encoder private options instead */
2893 attribute_deprecated
2894 int rtp_payload_size; /* The size of the RTP payload: the coder will */
2895 /* do its best to deliver a chunk with size */
2896 /* below rtp_payload_size, the chunk will start */
2897 /* with a start code on some codecs like H.263. */
2898 /* This doesn't take account of any particular */
2899 /* headers inside the transmitted RTP payload. */
2902 #if FF_API_STAT_BITS
2903 /* statistics, used for 2-pass encoding */
2904 attribute_deprecated
2906 attribute_deprecated
2908 attribute_deprecated
2910 attribute_deprecated
2912 attribute_deprecated
2914 attribute_deprecated
2916 attribute_deprecated
2918 attribute_deprecated
2921 /** @deprecated this field is unused */
2922 attribute_deprecated
2927 * pass1 encoding statistics output buffer
2928 * - encoding: Set by libavcodec.
2929 * - decoding: unused
2934 * pass2 encoding statistics input buffer
2935 * Concatenated stuff from stats_out of pass1 should be placed here.
2936 * - encoding: Allocated/set/freed by user.
2937 * - decoding: unused
2942 * Work around bugs in encoders which sometimes cannot be detected automatically.
2943 * - encoding: Set by user
2944 * - decoding: Set by user
2946 int workaround_bugs;
2947 #define FF_BUG_AUTODETECT 1 ///< autodetection
2948 #if FF_API_OLD_MSMPEG4
2949 #define FF_BUG_OLD_MSMPEG4 2
2951 #define FF_BUG_XVID_ILACE 4
2952 #define FF_BUG_UMP4 8
2953 #define FF_BUG_NO_PADDING 16
2954 #define FF_BUG_AMV 32
2956 #define FF_BUG_AC_VLC 0 ///< Will be removed, libavcodec can now handle these non-compliant files by default.
2958 #define FF_BUG_QPEL_CHROMA 64
2959 #define FF_BUG_STD_QPEL 128
2960 #define FF_BUG_QPEL_CHROMA2 256
2961 #define FF_BUG_DIRECT_BLOCKSIZE 512
2962 #define FF_BUG_EDGE 1024
2963 #define FF_BUG_HPEL_CHROMA 2048
2964 #define FF_BUG_DC_CLIP 4096
2965 #define FF_BUG_MS 8192 ///< Work around various bugs in Microsoft's broken decoders.
2966 #define FF_BUG_TRUNCATED 16384
2967 #define FF_BUG_IEDGE 32768
2970 * strictly follow the standard (MPEG-4, ...).
2971 * - encoding: Set by user.
2972 * - decoding: Set by user.
2973 * Setting this to STRICT or higher means the encoder and decoder will
2974 * generally do stupid things, whereas setting it to unofficial or lower
2975 * will mean the encoder might produce output that is not supported by all
2976 * spec-compliant decoders. Decoders don't differentiate between normal,
2977 * unofficial and experimental (that is, they always try to decode things
2978 * when they can) unless they are explicitly asked to behave stupidly
2979 * (=strictly conform to the specs)
2981 int strict_std_compliance;
2982 #define FF_COMPLIANCE_VERY_STRICT 2 ///< Strictly conform to an older more strict version of the spec or reference software.
2983 #define FF_COMPLIANCE_STRICT 1 ///< Strictly conform to all the things in the spec no matter what consequences.
2984 #define FF_COMPLIANCE_NORMAL 0
2985 #define FF_COMPLIANCE_UNOFFICIAL -1 ///< Allow unofficial extensions
2986 #define FF_COMPLIANCE_EXPERIMENTAL -2 ///< Allow nonstandardized experimental things.
2989 * error concealment flags
2990 * - encoding: unused
2991 * - decoding: Set by user.
2993 int error_concealment;
2994 #define FF_EC_GUESS_MVS 1
2995 #define FF_EC_DEBLOCK 2
2996 #define FF_EC_FAVOR_INTER 256
3000 * - encoding: Set by user.
3001 * - decoding: Set by user.
3004 #define FF_DEBUG_PICT_INFO 1
3005 #define FF_DEBUG_RC 2
3006 #define FF_DEBUG_BITSTREAM 4
3007 #define FF_DEBUG_MB_TYPE 8
3008 #define FF_DEBUG_QP 16
3011 * @deprecated this option does nothing
3013 #define FF_DEBUG_MV 32
3015 #define FF_DEBUG_DCT_COEFF 0x00000040
3016 #define FF_DEBUG_SKIP 0x00000080
3017 #define FF_DEBUG_STARTCODE 0x00000100
3018 #if FF_API_UNUSED_MEMBERS
3019 #define FF_DEBUG_PTS 0x00000200
3020 #endif /* FF_API_UNUSED_MEMBERS */
3021 #define FF_DEBUG_ER 0x00000400
3022 #define FF_DEBUG_MMCO 0x00000800
3023 #define FF_DEBUG_BUGS 0x00001000
3025 #define FF_DEBUG_VIS_QP 0x00002000
3026 #define FF_DEBUG_VIS_MB_TYPE 0x00004000
3028 #define FF_DEBUG_BUFFERS 0x00008000
3029 #define FF_DEBUG_THREADS 0x00010000
3030 #define FF_DEBUG_GREEN_MD 0x00800000
3031 #define FF_DEBUG_NOMC 0x01000000
3036 * - encoding: Set by user.
3037 * - decoding: Set by user.
3040 #define FF_DEBUG_VIS_MV_P_FOR 0x00000001 // visualize forward predicted MVs of P-frames
3041 #define FF_DEBUG_VIS_MV_B_FOR 0x00000002 // visualize forward predicted MVs of B-frames
3042 #define FF_DEBUG_VIS_MV_B_BACK 0x00000004 // visualize backward predicted MVs of B-frames
3046 * Error recognition; may misdetect some more or less valid parts as errors.
3047 * - encoding: unused
3048 * - decoding: Set by user.
3050 int err_recognition;
3053 * Verify checksums embedded in the bitstream (could be of either encoded or
3054 * decoded data, depending on the codec) and print an error message on mismatch.
3055 * If AV_EF_EXPLODE is also set, a mismatching checksum will result in the
3056 * decoder returning an error.
3058 #define AV_EF_CRCCHECK (1<<0)
3059 #define AV_EF_BITSTREAM (1<<1) ///< detect bitstream specification deviations
3060 #define AV_EF_BUFFER (1<<2) ///< detect improper bitstream length
3061 #define AV_EF_EXPLODE (1<<3) ///< abort decoding on minor error detection
3063 #define AV_EF_IGNORE_ERR (1<<15) ///< ignore errors and continue
3064 #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
3065 #define AV_EF_COMPLIANT (1<<17) ///< consider all spec non compliances as errors
3066 #define AV_EF_AGGRESSIVE (1<<18) ///< consider things that a sane encoder should not do as an error
3070 * opaque 64-bit number (generally a PTS) that will be reordered and
3071 * output in AVFrame.reordered_opaque
3072 * - encoding: unused
3073 * - decoding: Set by user.
3075 int64_t reordered_opaque;
3078 * Hardware accelerator in use
3079 * - encoding: unused.
3080 * - decoding: Set by libavcodec
3082 struct AVHWAccel *hwaccel;
3085 * Hardware accelerator context.
3086 * For some hardware accelerators, a global context needs to be
3087 * provided by the user. In that case, this holds display-dependent
3088 * data FFmpeg cannot instantiate itself. Please refer to the
3089 * FFmpeg HW accelerator documentation to know how to fill this
3090 * is. e.g. for VA API, this is a struct vaapi_context.
3091 * - encoding: unused
3092 * - decoding: Set by user
3094 void *hwaccel_context;
3098 * - encoding: Set by libavcodec if flags & AV_CODEC_FLAG_PSNR.
3099 * - decoding: unused
3101 uint64_t error[AV_NUM_DATA_POINTERS];
3104 * DCT algorithm, see FF_DCT_* below
3105 * - encoding: Set by user.
3106 * - decoding: unused
3109 #define FF_DCT_AUTO 0
3110 #define FF_DCT_FASTINT 1
3111 #define FF_DCT_INT 2
3112 #define FF_DCT_MMX 3
3113 #define FF_DCT_ALTIVEC 5
3114 #define FF_DCT_FAAN 6
3117 * IDCT algorithm, see FF_IDCT_* below.
3118 * - encoding: Set by user.
3119 * - decoding: Set by user.
3122 #define FF_IDCT_AUTO 0
3123 #define FF_IDCT_INT 1
3124 #define FF_IDCT_SIMPLE 2
3125 #define FF_IDCT_SIMPLEMMX 3
3126 #define FF_IDCT_ARM 7
3127 #define FF_IDCT_ALTIVEC 8
3129 #define FF_IDCT_SH4 9
3131 #define FF_IDCT_SIMPLEARM 10
3132 #if FF_API_UNUSED_MEMBERS
3133 #define FF_IDCT_IPP 13
3134 #endif /* FF_API_UNUSED_MEMBERS */
3135 #define FF_IDCT_XVID 14
3136 #if FF_API_IDCT_XVIDMMX
3137 #define FF_IDCT_XVIDMMX 14
3138 #endif /* FF_API_IDCT_XVIDMMX */
3139 #define FF_IDCT_SIMPLEARMV5TE 16
3140 #define FF_IDCT_SIMPLEARMV6 17
3141 #if FF_API_ARCH_SPARC
3142 #define FF_IDCT_SIMPLEVIS 18
3144 #define FF_IDCT_FAAN 20
3145 #define FF_IDCT_SIMPLENEON 22
3146 #if FF_API_ARCH_ALPHA
3147 #define FF_IDCT_SIMPLEALPHA 23
3149 #define FF_IDCT_SIMPLEAUTO 128
3152 * bits per sample/pixel from the demuxer (needed for huffyuv).
3153 * - encoding: Set by libavcodec.
3154 * - decoding: Set by user.
3156 int bits_per_coded_sample;
3159 * Bits per sample/pixel of internal libavcodec pixel/sample format.
3160 * - encoding: set by user.
3161 * - decoding: set by libavcodec.
3163 int bits_per_raw_sample;
3167 * low resolution decoding, 1-> 1/2 size, 2->1/4 size
3168 * - encoding: unused
3169 * - decoding: Set by user.
3174 #if FF_API_CODED_FRAME
3176 * the picture in the bitstream
3177 * - encoding: Set by libavcodec.
3178 * - decoding: unused
3180 * @deprecated use the quality factor packet side data instead
3182 attribute_deprecated AVFrame *coded_frame;
3187 * is used to decide how many independent tasks should be passed to execute()
3188 * - encoding: Set by user.
3189 * - decoding: Set by user.
3194 * Which multithreading methods to use.
3195 * Use of FF_THREAD_FRAME will increase decoding delay by one frame per thread,
3196 * so clients which cannot provide future frames should not use it.
3198 * - encoding: Set by user, otherwise the default is used.
3199 * - decoding: Set by user, otherwise the default is used.
3202 #define FF_THREAD_FRAME 1 ///< Decode more than one frame at once
3203 #define FF_THREAD_SLICE 2 ///< Decode more than one part of a single frame at once
3206 * Which multithreading methods are in use by the codec.
3207 * - encoding: Set by libavcodec.
3208 * - decoding: Set by libavcodec.
3210 int active_thread_type;
3213 * Set by the client if its custom get_buffer() callback can be called
3214 * synchronously from another thread, which allows faster multithreaded decoding.
3215 * draw_horiz_band() will be called from other threads regardless of this setting.
3216 * Ignored if the default get_buffer() is used.
3217 * - encoding: Set by user.
3218 * - decoding: Set by user.
3220 int thread_safe_callbacks;
3223 * The codec may call this to execute several independent things.
3224 * It will return only after finishing all tasks.
3225 * The user may replace this with some multithreaded implementation,
3226 * the default implementation will execute the parts serially.
3227 * @param count the number of things to execute
3228 * - encoding: Set by libavcodec, user can override.
3229 * - decoding: Set by libavcodec, user can override.
3231 int (*execute)(struct AVCodecContext *c, int (*func)(struct AVCodecContext *c2, void *arg), void *arg2, int *ret, int count, int size);
3234 * The codec may call this to execute several independent things.
3235 * It will return only after finishing all tasks.
3236 * The user may replace this with some multithreaded implementation,
3237 * the default implementation will execute the parts serially.
3238 * Also see avcodec_thread_init and e.g. the --enable-pthread configure option.
3239 * @param c context passed also to func
3240 * @param count the number of things to execute
3241 * @param arg2 argument passed unchanged to func
3242 * @param ret return values of executed functions, must have space for "count" values. May be NULL.
3243 * @param func function that will be called count times, with jobnr from 0 to count-1.
3244 * threadnr will be in the range 0 to c->thread_count-1 < MAX_THREADS and so that no
3245 * two instances of func executing at the same time will have the same threadnr.
3246 * @return always 0 currently, but code should handle a future improvement where when any call to func
3247 * returns < 0 no further calls to func may be done and < 0 is returned.
3248 * - encoding: Set by libavcodec, user can override.
3249 * - decoding: Set by libavcodec, user can override.
3251 int (*execute2)(struct AVCodecContext *c, int (*func)(struct AVCodecContext *c2, void *arg, int jobnr, int threadnr), void *arg2, int *ret, int count);
3254 * noise vs. sse weight for the nsse comparison function
3255 * - encoding: Set by user.
3256 * - decoding: unused
3262 * - encoding: Set by user.
3263 * - decoding: Set by libavcodec.
3266 #define FF_PROFILE_UNKNOWN -99
3267 #define FF_PROFILE_RESERVED -100
3269 #define FF_PROFILE_AAC_MAIN 0
3270 #define FF_PROFILE_AAC_LOW 1
3271 #define FF_PROFILE_AAC_SSR 2
3272 #define FF_PROFILE_AAC_LTP 3
3273 #define FF_PROFILE_AAC_HE 4
3274 #define FF_PROFILE_AAC_HE_V2 28
3275 #define FF_PROFILE_AAC_LD 22
3276 #define FF_PROFILE_AAC_ELD 38
3277 #define FF_PROFILE_MPEG2_AAC_LOW 128
3278 #define FF_PROFILE_MPEG2_AAC_HE 131
3280 #define FF_PROFILE_DNXHD 0
3281 #define FF_PROFILE_DNXHR_LB 1
3282 #define FF_PROFILE_DNXHR_SQ 2
3283 #define FF_PROFILE_DNXHR_HQ 3
3284 #define FF_PROFILE_DNXHR_HQX 4
3285 #define FF_PROFILE_DNXHR_444 5
3287 #define FF_PROFILE_DTS 20
3288 #define FF_PROFILE_DTS_ES 30
3289 #define FF_PROFILE_DTS_96_24 40
3290 #define FF_PROFILE_DTS_HD_HRA 50
3291 #define FF_PROFILE_DTS_HD_MA 60
3292 #define FF_PROFILE_DTS_EXPRESS 70
3294 #define FF_PROFILE_MPEG2_422 0
3295 #define FF_PROFILE_MPEG2_HIGH 1
3296 #define FF_PROFILE_MPEG2_SS 2
3297 #define FF_PROFILE_MPEG2_SNR_SCALABLE 3
3298 #define FF_PROFILE_MPEG2_MAIN 4
3299 #define FF_PROFILE_MPEG2_SIMPLE 5
3301 #define FF_PROFILE_H264_CONSTRAINED (1<<9) // 8+1; constraint_set1_flag
3302 #define FF_PROFILE_H264_INTRA (1<<11) // 8+3; constraint_set3_flag
3304 #define FF_PROFILE_H264_BASELINE 66
3305 #define FF_PROFILE_H264_CONSTRAINED_BASELINE (66|FF_PROFILE_H264_CONSTRAINED)
3306 #define FF_PROFILE_H264_MAIN 77
3307 #define FF_PROFILE_H264_EXTENDED 88
3308 #define FF_PROFILE_H264_HIGH 100
3309 #define FF_PROFILE_H264_HIGH_10 110
3310 #define FF_PROFILE_H264_HIGH_10_INTRA (110|FF_PROFILE_H264_INTRA)
3311 #define FF_PROFILE_H264_MULTIVIEW_HIGH 118
3312 #define FF_PROFILE_H264_HIGH_422 122
3313 #define FF_PROFILE_H264_HIGH_422_INTRA (122|FF_PROFILE_H264_INTRA)
3314 #define FF_PROFILE_H264_STEREO_HIGH 128
3315 #define FF_PROFILE_H264_HIGH_444 144
3316 #define FF_PROFILE_H264_HIGH_444_PREDICTIVE 244
3317 #define FF_PROFILE_H264_HIGH_444_INTRA (244|FF_PROFILE_H264_INTRA)
3318 #define FF_PROFILE_H264_CAVLC_444 44
3320 #define FF_PROFILE_VC1_SIMPLE 0
3321 #define FF_PROFILE_VC1_MAIN 1
3322 #define FF_PROFILE_VC1_COMPLEX 2
3323 #define FF_PROFILE_VC1_ADVANCED 3
3325 #define FF_PROFILE_MPEG4_SIMPLE 0
3326 #define FF_PROFILE_MPEG4_SIMPLE_SCALABLE 1
3327 #define FF_PROFILE_MPEG4_CORE 2
3328 #define FF_PROFILE_MPEG4_MAIN 3
3329 #define FF_PROFILE_MPEG4_N_BIT 4
3330 #define FF_PROFILE_MPEG4_SCALABLE_TEXTURE 5
3331 #define FF_PROFILE_MPEG4_SIMPLE_FACE_ANIMATION 6
3332 #define FF_PROFILE_MPEG4_BASIC_ANIMATED_TEXTURE 7
3333 #define FF_PROFILE_MPEG4_HYBRID 8
3334 #define FF_PROFILE_MPEG4_ADVANCED_REAL_TIME 9
3335 #define FF_PROFILE_MPEG4_CORE_SCALABLE 10
3336 #define FF_PROFILE_MPEG4_ADVANCED_CODING 11
3337 #define FF_PROFILE_MPEG4_ADVANCED_CORE 12
3338 #define FF_PROFILE_MPEG4_ADVANCED_SCALABLE_TEXTURE 13
3339 #define FF_PROFILE_MPEG4_SIMPLE_STUDIO 14
3340 #define FF_PROFILE_MPEG4_ADVANCED_SIMPLE 15
3342 #define FF_PROFILE_JPEG2000_CSTREAM_RESTRICTION_0 1
3343 #define FF_PROFILE_JPEG2000_CSTREAM_RESTRICTION_1 2
3344 #define FF_PROFILE_JPEG2000_CSTREAM_NO_RESTRICTION 32768
3345 #define FF_PROFILE_JPEG2000_DCINEMA_2K 3
3346 #define FF_PROFILE_JPEG2000_DCINEMA_4K 4
3348 #define FF_PROFILE_VP9_0 0
3349 #define FF_PROFILE_VP9_1 1
3350 #define FF_PROFILE_VP9_2 2
3351 #define FF_PROFILE_VP9_3 3
3353 #define FF_PROFILE_HEVC_MAIN 1
3354 #define FF_PROFILE_HEVC_MAIN_10 2
3355 #define FF_PROFILE_HEVC_MAIN_STILL_PICTURE 3
3356 #define FF_PROFILE_HEVC_REXT 4
3360 * - encoding: Set by user.
3361 * - decoding: Set by libavcodec.
3364 #define FF_LEVEL_UNKNOWN -99
3367 * Skip loop filtering for selected frames.
3368 * - encoding: unused
3369 * - decoding: Set by user.
3371 enum AVDiscard skip_loop_filter;
3374 * Skip IDCT/dequantization for selected frames.
3375 * - encoding: unused
3376 * - decoding: Set by user.
3378 enum AVDiscard skip_idct;
3381 * Skip decoding for selected frames.
3382 * - encoding: unused
3383 * - decoding: Set by user.
3385 enum AVDiscard skip_frame;
3388 * Header containing style information for text subtitles.
3389 * For SUBTITLE_ASS subtitle type, it should contain the whole ASS
3390 * [Script Info] and [V4+ Styles] section, plus the [Events] line and
3391 * the Format line following. It shouldn't include any Dialogue line.
3392 * - encoding: Set/allocated/freed by user (before avcodec_open2())
3393 * - decoding: Set/allocated/freed by libavcodec (by avcodec_open2())
3395 uint8_t *subtitle_header;
3396 int subtitle_header_size;
3398 #if FF_API_ERROR_RATE
3400 * @deprecated use the 'error_rate' private AVOption of the mpegvideo
3403 attribute_deprecated
3407 #if FF_API_VBV_DELAY
3409 * VBV delay coded in the last frame (in periods of a 27 MHz clock).
3410 * Used for compliant TS muxing.
3411 * - encoding: Set by libavcodec.
3412 * - decoding: unused.
3413 * @deprecated this value is now exported as a part of
3414 * AV_PKT_DATA_CPB_PROPERTIES packet side data
3416 attribute_deprecated
3420 #if FF_API_SIDEDATA_ONLY_PKT
3422 * Encoding only and set by default. Allow encoders to output packets
3423 * that do not contain any encoded data, only side data.
3425 * Some encoders need to output such packets, e.g. to update some stream
3426 * parameters at the end of encoding.
3428 * @deprecated this field disables the default behaviour and
3429 * it is kept only for compatibility.
3431 attribute_deprecated
3432 int side_data_only_packets;
3436 * Audio only. The number of "priming" samples (padding) inserted by the
3437 * encoder at the beginning of the audio. I.e. this number of leading
3438 * decoded samples must be discarded by the caller to get the original audio
3439 * without leading padding.
3441 * - decoding: unused
3442 * - encoding: Set by libavcodec. The timestamps on the output packets are
3443 * adjusted by the encoder so that they always refer to the
3444 * first sample of the data actually contained in the packet,
3445 * including any added padding. E.g. if the timebase is
3446 * 1/samplerate and the timestamp of the first input sample is
3447 * 0, the timestamp of the first output packet will be
3450 int initial_padding;
3453 * - decoding: For codecs that store a framerate value in the compressed
3454 * bitstream, the decoder may export it here. { 0, 1} when
3456 * - encoding: May be used to signal the framerate of CFR content to an
3459 AVRational framerate;
3462 * Nominal unaccelerated pixel format, see AV_PIX_FMT_xxx.
3463 * - encoding: unused.
3464 * - decoding: Set by libavcodec before calling get_format()
3466 enum AVPixelFormat sw_pix_fmt;
3469 * Timebase in which pkt_dts/pts and AVPacket.dts/pts are.
3470 * - encoding unused.
3471 * - decoding set by user.
3473 AVRational pkt_timebase;
3477 * - encoding: unused.
3478 * - decoding: set by libavcodec.
3480 const AVCodecDescriptor *codec_descriptor;
3484 * low resolution decoding, 1-> 1/2 size, 2->1/4 size
3485 * - encoding: unused
3486 * - decoding: Set by user.
3492 * Current statistics for PTS correction.
3493 * - decoding: maintained and used by libavcodec, not intended to be used by user apps
3494 * - encoding: unused
3496 int64_t pts_correction_num_faulty_pts; /// Number of incorrect PTS values so far
3497 int64_t pts_correction_num_faulty_dts; /// Number of incorrect DTS values so far
3498 int64_t pts_correction_last_pts; /// PTS of the last frame
3499 int64_t pts_correction_last_dts; /// DTS of the last frame
3502 * Character encoding of the input subtitles file.
3503 * - decoding: set by user
3504 * - encoding: unused
3509 * Subtitles character encoding mode. Formats or codecs might be adjusting
3510 * this setting (if they are doing the conversion themselves for instance).
3511 * - decoding: set by libavcodec
3512 * - encoding: unused
3514 int sub_charenc_mode;
3515 #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)
3516 #define FF_SUB_CHARENC_MODE_AUTOMATIC 0 ///< libavcodec will select the mode itself
3517 #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
3520 * Skip processing alpha if supported by codec.
3521 * Note that if the format uses pre-multiplied alpha (common with VP6,
3522 * and recommended due to better video quality/compression)
3523 * the image will look as if alpha-blended onto a black background.
3524 * However for formats that do not use pre-multiplied alpha
3525 * there might be serious artefacts (though e.g. libswscale currently
3526 * assumes pre-multiplied alpha anyway).
3528 * - decoding: set by user
3529 * - encoding: unused
3534 * Number of samples to skip after a discontinuity
3535 * - decoding: unused
3536 * - encoding: set by libavcodec
3540 #if !FF_API_DEBUG_MV
3542 * debug motion vectors
3543 * - encoding: Set by user.
3544 * - decoding: Set by user.
3547 #define FF_DEBUG_VIS_MV_P_FOR 0x00000001 //visualize forward predicted MVs of P frames
3548 #define FF_DEBUG_VIS_MV_B_FOR 0x00000002 //visualize forward predicted MVs of B frames
3549 #define FF_DEBUG_VIS_MV_B_BACK 0x00000004 //visualize backward predicted MVs of B frames
3553 * custom intra quantization matrix
3554 * - encoding: Set by user, can be NULL.
3555 * - decoding: unused.
3557 uint16_t *chroma_intra_matrix;
3560 * dump format separator.
3561 * can be ", " or "\n " or anything else
3562 * - encoding: Set by user.
3563 * - decoding: Set by user.
3565 uint8_t *dump_separator;
3568 * ',' separated list of allowed decoders.
3569 * If NULL then all are allowed
3570 * - encoding: unused
3571 * - decoding: set by user
3573 char *codec_whitelist;
3576 * Properties of the stream that gets decoded
3577 * - encoding: unused
3578 * - decoding: set by libavcodec
3580 unsigned properties;
3581 #define FF_CODEC_PROPERTY_LOSSLESS 0x00000001
3582 #define FF_CODEC_PROPERTY_CLOSED_CAPTIONS 0x00000002
3585 * Additional data associated with the entire coded stream.
3587 * - decoding: unused
3588 * - encoding: may be set by libavcodec after avcodec_open2().
3590 AVPacketSideData *coded_side_data;
3591 int nb_coded_side_data;
3594 * A reference to the AVHWFramesContext describing the input (for encoding)
3595 * or output (decoding) frames. The reference is set by the caller and
3596 * afterwards owned (and freed) by libavcodec - it should never be read by
3597 * the caller after being set.
3599 * - decoding: This field should be set by the caller from the get_format()
3600 * callback. The previous reference (if any) will always be
3601 * unreffed by libavcodec before the get_format() call.
3603 * If the default get_buffer2() is used with a hwaccel pixel
3604 * format, then this AVHWFramesContext will be used for
3605 * allocating the frame buffers.
3607 * - encoding: For hardware encoders configured to use a hwaccel pixel
3608 * format, this field should be set by the caller to a reference
3609 * to the AVHWFramesContext describing input frames.
3610 * AVHWFramesContext.format must be equal to
3611 * AVCodecContext.pix_fmt.
3613 * This field should be set before avcodec_open2() is called.
3615 AVBufferRef *hw_frames_ctx;
3618 * Control the form of AVSubtitle.rects[N]->ass
3619 * - decoding: set by user
3620 * - encoding: unused
3622 int sub_text_format;
3623 #define FF_SUB_TEXT_FMT_ASS 0
3624 #if FF_API_ASS_TIMING
3625 #define FF_SUB_TEXT_FMT_ASS_WITH_TIMINGS 1
3629 * Audio only. The amount of padding (in samples) appended by the encoder to
3630 * the end of the audio. I.e. this number of decoded samples must be
3631 * discarded by the caller from the end of the stream to get the original
3632 * audio without any trailing padding.
3634 * - decoding: unused
3635 * - encoding: unused
3637 int trailing_padding;
3640 * The number of pixels per image to maximally accept.
3642 * - decoding: set by user
3643 * - encoding: set by user
3648 * A reference to the AVHWDeviceContext describing the device which will
3649 * be used by a hardware encoder/decoder. The reference is set by the
3650 * caller and afterwards owned (and freed) by libavcodec.
3652 * This should be used if either the codec device does not require
3653 * hardware frames or any that are used are to be allocated internally by
3654 * libavcodec. If the user wishes to supply any of the frames used as
3655 * encoder input or decoder output then hw_frames_ctx should be used
3656 * instead. When hw_frames_ctx is set in get_format() for a decoder, this
3657 * field will be ignored while decoding the associated stream segment, but
3658 * may again be used on a following one after another get_format() call.
3660 * For both encoders and decoders this field should be set before
3661 * avcodec_open2() is called and must not be written to thereafter.
3663 * Note that some decoders may require this field to be set initially in
3664 * order to support hw_frames_ctx at all - in that case, all frames
3665 * contexts used must be created on the same device.
3667 AVBufferRef *hw_device_ctx;
3670 * Bit set of AV_HWACCEL_FLAG_* flags, which affect hardware accelerated
3671 * decoding (if active).
3672 * - encoding: unused
3673 * - decoding: Set by user (either before avcodec_open2(), or in the
3674 * AVCodecContext.get_format callback)
3679 * Video decoding only. Certain video codecs support cropping, meaning that
3680 * only a sub-rectangle of the decoded frame is intended for display. This
3681 * option controls how cropping is handled by libavcodec.
3683 * When set to 1 (the default), libavcodec will apply cropping internally.
3684 * I.e. it will modify the output frame width/height fields and offset the
3685 * data pointers (only by as much as possible while preserving alignment, or
3686 * by the full amount if the AV_CODEC_FLAG_UNALIGNED flag is set) so that
3687 * the frames output by the decoder refer only to the cropped area. The
3688 * crop_* fields of the output frames will be zero.
3690 * When set to 0, the width/height fields of the output frames will be set
3691 * to the coded dimensions and the crop_* fields will describe the cropping
3692 * rectangle. Applying the cropping is left to the caller.
3694 * @warning When hardware acceleration with opaque output frames is used,
3695 * libavcodec is unable to apply cropping from the top/left border.
3697 * @note when this option is set to zero, the width/height fields of the
3698 * AVCodecContext and output AVFrames have different meanings. The codec
3699 * context fields store display dimensions (with the coded dimensions in
3700 * coded_width/height), while the frame fields store the coded dimensions
3701 * (with the display dimensions being determined by the crop_* fields).
3706 AVRational av_codec_get_pkt_timebase (const AVCodecContext *avctx);
3707 void av_codec_set_pkt_timebase (AVCodecContext *avctx, AVRational val);
3709 const AVCodecDescriptor *av_codec_get_codec_descriptor(const AVCodecContext *avctx);
3710 void av_codec_set_codec_descriptor(AVCodecContext *avctx, const AVCodecDescriptor *desc);
3712 unsigned av_codec_get_codec_properties(const AVCodecContext *avctx);
3714 int av_codec_get_lowres(const AVCodecContext *avctx);
3715 void av_codec_set_lowres(AVCodecContext *avctx, int val);
3717 int av_codec_get_seek_preroll(const AVCodecContext *avctx);
3718 void av_codec_set_seek_preroll(AVCodecContext *avctx, int val);
3720 uint16_t *av_codec_get_chroma_intra_matrix(const AVCodecContext *avctx);
3721 void av_codec_set_chroma_intra_matrix(AVCodecContext *avctx, uint16_t *val);
3726 typedef struct AVProfile {
3728 const char *name; ///< short name for the profile
3731 typedef struct AVCodecDefault AVCodecDefault;
3738 typedef struct AVCodec {
3740 * Name of the codec implementation.
3741 * The name is globally unique among encoders and among decoders (but an
3742 * encoder and a decoder can share the same name).
3743 * This is the primary way to find a codec from the user perspective.
3747 * Descriptive name for the codec, meant to be more human readable than name.
3748 * You should use the NULL_IF_CONFIG_SMALL() macro to define it.
3750 const char *long_name;
3751 enum AVMediaType type;
3754 * Codec capabilities.
3755 * see AV_CODEC_CAP_*
3758 const AVRational *supported_framerates; ///< array of supported framerates, or NULL if any, array is terminated by {0,0}
3759 const enum AVPixelFormat *pix_fmts; ///< array of supported pixel formats, or NULL if unknown, array is terminated by -1
3760 const int *supported_samplerates; ///< array of supported audio samplerates, or NULL if unknown, array is terminated by 0
3761 const enum AVSampleFormat *sample_fmts; ///< array of supported sample formats, or NULL if unknown, array is terminated by -1
3762 const uint64_t *channel_layouts; ///< array of support channel layouts, or NULL if unknown. array is terminated by 0
3763 uint8_t max_lowres; ///< maximum value for lowres supported by the decoder
3764 const AVClass *priv_class; ///< AVClass for the private context
3765 const AVProfile *profiles; ///< array of recognized profiles, or NULL if unknown, array is terminated by {FF_PROFILE_UNKNOWN}
3767 /*****************************************************************
3768 * No fields below this line are part of the public API. They
3769 * may not be used outside of libavcodec and can be changed and
3771 * New public fields should be added right above.
3772 *****************************************************************
3775 struct AVCodec *next;
3777 * @name Frame-level threading support functions
3781 * If defined, called on thread contexts when they are created.
3782 * If the codec allocates writable tables in init(), re-allocate them here.
3783 * priv_data will be set to a copy of the original.
3785 int (*init_thread_copy)(AVCodecContext *);
3787 * Copy necessary context variables from a previous thread context to the current one.
3788 * If not defined, the next thread will start automatically; otherwise, the codec
3789 * must call ff_thread_finish_setup().
3791 * dst and src will (rarely) point to the same context, in which case memcpy should be skipped.
3793 int (*update_thread_context)(AVCodecContext *dst, const AVCodecContext *src);
3797 * Private codec-specific defaults.
3799 const AVCodecDefault *defaults;
3802 * Initialize codec static data, called from avcodec_register().
3804 void (*init_static_data)(struct AVCodec *codec);
3806 int (*init)(AVCodecContext *);
3807 int (*encode_sub)(AVCodecContext *, uint8_t *buf, int buf_size,
3808 const struct AVSubtitle *sub);
3810 * Encode data to an AVPacket.
3812 * @param avctx codec context
3813 * @param avpkt output AVPacket (may contain a user-provided buffer)
3814 * @param[in] frame AVFrame containing the raw data to be encoded
3815 * @param[out] got_packet_ptr encoder sets to 0 or 1 to indicate that a
3816 * non-empty packet was returned in avpkt.
3817 * @return 0 on success, negative error code on failure
3819 int (*encode2)(AVCodecContext *avctx, AVPacket *avpkt, const AVFrame *frame,
3820 int *got_packet_ptr);
3821 int (*decode)(AVCodecContext *, void *outdata, int *outdata_size, AVPacket *avpkt);
3822 int (*close)(AVCodecContext *);
3824 * Encode API with decoupled packet/frame dataflow. The API is the
3825 * same as the avcodec_ prefixed APIs (avcodec_send_frame() etc.), except
3827 * - never called if the codec is closed or the wrong type,
3828 * - if AV_CODEC_CAP_DELAY is not set, drain frames are never sent,
3829 * - only one drain frame is ever passed down,
3831 int (*send_frame)(AVCodecContext *avctx, const AVFrame *frame);
3832 int (*receive_packet)(AVCodecContext *avctx, AVPacket *avpkt);
3835 * Decode API with decoupled packet/frame dataflow. This function is called
3836 * to get one output frame. It should call ff_decode_get_packet() to obtain
3839 int (*receive_frame)(AVCodecContext *avctx, AVFrame *frame);
3842 * Will be called when seeking
3844 void (*flush)(AVCodecContext *);
3846 * Internal codec capabilities.
3847 * See FF_CODEC_CAP_* in internal.h
3852 * Decoding only, a comma-separated list of bitstream filters to apply to
3853 * packets before decoding.
3858 int av_codec_get_max_lowres(const AVCodec *codec);
3860 struct MpegEncContext;
3863 * @defgroup lavc_hwaccel AVHWAccel
3866 typedef struct AVHWAccel {
3868 * Name of the hardware accelerated codec.
3869 * The name is globally unique among encoders and among decoders (but an
3870 * encoder and a decoder can share the same name).
3875 * Type of codec implemented by the hardware accelerator.
3877 * See AVMEDIA_TYPE_xxx
3879 enum AVMediaType type;
3882 * Codec implemented by the hardware accelerator.
3884 * See AV_CODEC_ID_xxx
3889 * Supported pixel format.
3891 * Only hardware accelerated formats are supported here.
3893 enum AVPixelFormat pix_fmt;
3896 * Hardware accelerated codec capabilities.
3897 * see AV_HWACCEL_CODEC_CAP_*
3901 /*****************************************************************
3902 * No fields below this line are part of the public API. They
3903 * may not be used outside of libavcodec and can be changed and
3905 * New public fields should be added right above.
3906 *****************************************************************
3908 struct AVHWAccel *next;
3911 * Allocate a custom buffer
3913 int (*alloc_frame)(AVCodecContext *avctx, AVFrame *frame);
3916 * Called at the beginning of each frame or field picture.
3918 * Meaningful frame information (codec specific) is guaranteed to
3919 * be parsed at this point. This function is mandatory.
3921 * Note that buf can be NULL along with buf_size set to 0.
3922 * Otherwise, this means the whole frame is available at this point.
3924 * @param avctx the codec context
3925 * @param buf the frame data buffer base
3926 * @param buf_size the size of the frame in bytes
3927 * @return zero if successful, a negative value otherwise
3929 int (*start_frame)(AVCodecContext *avctx, const uint8_t *buf, uint32_t buf_size);
3932 * Callback for each slice.
3934 * Meaningful slice information (codec specific) is guaranteed to
3935 * be parsed at this point. This function is mandatory.
3936 * The only exception is XvMC, that works on MB level.
3938 * @param avctx the codec context
3939 * @param buf the slice data buffer base
3940 * @param buf_size the size of the slice in bytes
3941 * @return zero if successful, a negative value otherwise
3943 int (*decode_slice)(AVCodecContext *avctx, const uint8_t *buf, uint32_t buf_size);
3946 * Called at the end of each frame or field picture.
3948 * The whole picture is parsed at this point and can now be sent
3949 * to the hardware accelerator. This function is mandatory.
3951 * @param avctx the codec context
3952 * @return zero if successful, a negative value otherwise
3954 int (*end_frame)(AVCodecContext *avctx);
3957 * Size of per-frame hardware accelerator private data.
3959 * Private data is allocated with av_mallocz() before
3960 * AVCodecContext.get_buffer() and deallocated after
3961 * AVCodecContext.release_buffer().
3963 int frame_priv_data_size;
3966 * Called for every Macroblock in a slice.
3968 * XvMC uses it to replace the ff_mpv_reconstruct_mb().
3969 * Instead of decoding to raw picture, MB parameters are
3970 * stored in an array provided by the video driver.
3972 * @param s the mpeg context
3974 void (*decode_mb)(struct MpegEncContext *s);
3977 * Initialize the hwaccel private data.
3979 * This will be called from ff_get_format(), after hwaccel and
3980 * hwaccel_context are set and the hwaccel private data in AVCodecInternal
3983 int (*init)(AVCodecContext *avctx);
3986 * Uninitialize the hwaccel private data.
3988 * This will be called from get_format() or avcodec_close(), after hwaccel
3989 * and hwaccel_context are already uninitialized.
3991 int (*uninit)(AVCodecContext *avctx);
3994 * Size of the private data to allocate in
3995 * AVCodecInternal.hwaccel_priv_data.
4000 * Internal hwaccel capabilities.
4006 * HWAccel is experimental and is thus avoided in favor of non experimental
4009 #define AV_HWACCEL_CODEC_CAP_EXPERIMENTAL 0x0200
4012 * Hardware acceleration should be used for decoding even if the codec level
4013 * used is unknown or higher than the maximum supported level reported by the
4016 * It's generally a good idea to pass this flag unless you have a specific
4017 * reason not to, as hardware tends to under-report supported levels.
4019 #define AV_HWACCEL_FLAG_IGNORE_LEVEL (1 << 0)
4022 * Hardware acceleration can output YUV pixel formats with a different chroma
4023 * sampling than 4:2:0 and/or other than 8 bits per component.
4025 #define AV_HWACCEL_FLAG_ALLOW_HIGH_DEPTH (1 << 1)
4028 * Hardware acceleration should still be attempted for decoding when the
4029 * codec profile does not match the reported capabilities of the hardware.
4031 * For example, this can be used to try to decode baseline profile H.264
4032 * streams in hardware - it will often succeed, because many streams marked
4033 * as baseline profile actually conform to constrained baseline profile.
4035 * @warning If the stream is actually not supported then the behaviour is
4036 * undefined, and may include returning entirely incorrect output
4037 * while indicating success.
4039 #define AV_HWACCEL_FLAG_ALLOW_PROFILE_MISMATCH (1 << 2)
4045 #if FF_API_AVPICTURE
4047 * @defgroup lavc_picture AVPicture
4049 * Functions for working with AVPicture
4054 * Picture data structure.
4056 * Up to four components can be stored into it, the last component is
4058 * @deprecated use AVFrame or imgutils functions instead
4060 typedef struct AVPicture {
4061 attribute_deprecated
4062 uint8_t *data[AV_NUM_DATA_POINTERS]; ///< pointers to the image data planes
4063 attribute_deprecated
4064 int linesize[AV_NUM_DATA_POINTERS]; ///< number of bytes per line
4072 enum AVSubtitleType {
4075 SUBTITLE_BITMAP, ///< A bitmap, pict will be set
4078 * Plain text, the text field must be set by the decoder and is
4079 * authoritative. ass and pict fields may contain approximations.
4084 * Formatted text, the ass field must be set by the decoder and is
4085 * authoritative. pict and text fields may contain approximations.
4090 #define AV_SUBTITLE_FLAG_FORCED 0x00000001
4092 typedef struct AVSubtitleRect {
4093 int x; ///< top left corner of pict, undefined when pict is not set
4094 int y; ///< top left corner of pict, undefined when pict is not set
4095 int w; ///< width of pict, undefined when pict is not set
4096 int h; ///< height of pict, undefined when pict is not set
4097 int nb_colors; ///< number of colors in pict, undefined when pict is not set
4099 #if FF_API_AVPICTURE
4101 * @deprecated unused
4103 attribute_deprecated
4107 * data+linesize for the bitmap of this subtitle.
4108 * Can be set for text/ass as well once they are rendered.
4113 enum AVSubtitleType type;
4115 char *text; ///< 0 terminated plain UTF-8 text
4118 * 0 terminated ASS/SSA compatible event line.
4119 * The presentation of this is unaffected by the other values in this
4127 typedef struct AVSubtitle {
4128 uint16_t format; /* 0 = graphics */
4129 uint32_t start_display_time; /* relative to packet pts, in ms */
4130 uint32_t end_display_time; /* relative to packet pts, in ms */
4132 AVSubtitleRect **rects;
4133 int64_t pts; ///< Same as packet pts, in AV_TIME_BASE
4137 * This struct describes the properties of an encoded stream.
4139 * sizeof(AVCodecParameters) is not a part of the public ABI, this struct must
4140 * be allocated with avcodec_parameters_alloc() and freed with
4141 * avcodec_parameters_free().
4143 typedef struct AVCodecParameters {
4145 * General type of the encoded data.
4147 enum AVMediaType codec_type;
4149 * Specific type of the encoded data (the codec used).
4151 enum AVCodecID codec_id;
4153 * Additional information about the codec (corresponds to the AVI FOURCC).
4158 * Extra binary data needed for initializing the decoder, codec-dependent.
4160 * Must be allocated with av_malloc() and will be freed by
4161 * avcodec_parameters_free(). The allocated size of extradata must be at
4162 * least extradata_size + AV_INPUT_BUFFER_PADDING_SIZE, with the padding
4167 * Size of the extradata content in bytes.
4172 * - video: the pixel format, the value corresponds to enum AVPixelFormat.
4173 * - audio: the sample format, the value corresponds to enum AVSampleFormat.
4178 * The average bitrate of the encoded data (in bits per second).
4183 * The number of bits per sample in the codedwords.
4185 * This is basically the bitrate per sample. It is mandatory for a bunch of
4186 * formats to actually decode them. It's the number of bits for one sample in
4187 * the actual coded bitstream.
4189 * This could be for example 4 for ADPCM
4190 * For PCM formats this matches bits_per_raw_sample
4193 int bits_per_coded_sample;
4196 * This is the number of valid bits in each output sample. If the
4197 * sample format has more bits, the least significant bits are additional
4198 * padding bits, which are always 0. Use right shifts to reduce the sample
4199 * to its actual size. For example, audio formats with 24 bit samples will
4200 * have bits_per_raw_sample set to 24, and format set to AV_SAMPLE_FMT_S32.
4201 * To get the original sample use "(int32_t)sample >> 8"."
4203 * For ADPCM this might be 12 or 16 or similar
4206 int bits_per_raw_sample;
4209 * Codec-specific bitstream restrictions that the stream conforms to.
4215 * Video only. The dimensions of the video frame in pixels.
4221 * Video only. The aspect ratio (width / height) which a single pixel
4222 * should have when displayed.
4224 * When the aspect ratio is unknown / undefined, the numerator should be
4225 * set to 0 (the denominator may have any value).
4227 AVRational sample_aspect_ratio;
4230 * Video only. The order of the fields in interlaced video.
4232 enum AVFieldOrder field_order;
4235 * Video only. Additional colorspace characteristics.
4237 enum AVColorRange color_range;
4238 enum AVColorPrimaries color_primaries;
4239 enum AVColorTransferCharacteristic color_trc;
4240 enum AVColorSpace color_space;
4241 enum AVChromaLocation chroma_location;
4244 * Video only. Number of delayed frames.
4249 * Audio only. The channel layout bitmask. May be 0 if the channel layout is
4250 * unknown or unspecified, otherwise the number of bits set must be equal to
4251 * the channels field.
4253 uint64_t channel_layout;
4255 * Audio only. The number of audio channels.
4259 * Audio only. The number of audio samples per second.
4263 * Audio only. The number of bytes per coded audio frame, required by some
4266 * Corresponds to nBlockAlign in WAVEFORMATEX.
4270 * Audio only. Audio frame size, if known. Required by some formats to be static.
4275 * Audio only. The amount of padding (in samples) inserted by the encoder at
4276 * the beginning of the audio. I.e. this number of leading decoded samples
4277 * must be discarded by the caller to get the original audio without leading
4280 int initial_padding;
4282 * Audio only. The amount of padding (in samples) appended by the encoder to
4283 * the end of the audio. I.e. this number of decoded samples must be
4284 * discarded by the caller from the end of the stream to get the original
4285 * audio without any trailing padding.
4287 int trailing_padding;
4289 * Audio only. Number of samples to skip after a discontinuity.
4292 } AVCodecParameters;
4295 * If c is NULL, returns the first registered codec,
4296 * if c is non-NULL, returns the next registered codec after c,
4297 * or NULL if c is the last one.
4299 AVCodec *av_codec_next(const AVCodec *c);
4302 * Return the LIBAVCODEC_VERSION_INT constant.
4304 unsigned avcodec_version(void);
4307 * Return the libavcodec build-time configuration.
4309 const char *avcodec_configuration(void);
4312 * Return the libavcodec license.
4314 const char *avcodec_license(void);
4317 * Register the codec codec and initialize libavcodec.
4319 * @warning either this function or avcodec_register_all() must be called
4320 * before any other libavcodec functions.
4322 * @see avcodec_register_all()
4324 void avcodec_register(AVCodec *codec);
4327 * Register all the codecs, parsers and bitstream filters which were enabled at
4328 * configuration time. If you do not call this function you can select exactly
4329 * which formats you want to support, by using the individual registration
4332 * @see avcodec_register
4333 * @see av_register_codec_parser
4334 * @see av_register_bitstream_filter
4336 void avcodec_register_all(void);
4339 * Allocate an AVCodecContext and set its fields to default values. The
4340 * resulting struct should be freed with avcodec_free_context().
4342 * @param codec if non-NULL, allocate private data and initialize defaults
4343 * for the given codec. It is illegal to then call avcodec_open2()
4344 * with a different codec.
4345 * If NULL, then the codec-specific defaults won't be initialized,
4346 * which may result in suboptimal default settings (this is
4347 * important mainly for encoders, e.g. libx264).
4349 * @return An AVCodecContext filled with default values or NULL on failure.
4351 AVCodecContext *avcodec_alloc_context3(const AVCodec *codec);
4354 * Free the codec context and everything associated with it and write NULL to
4355 * the provided pointer.
4357 void avcodec_free_context(AVCodecContext **avctx);
4359 #if FF_API_GET_CONTEXT_DEFAULTS
4361 * @deprecated This function should not be used, as closing and opening a codec
4362 * context multiple time is not supported. A new codec context should be
4363 * allocated for each new use.
4365 int avcodec_get_context_defaults3(AVCodecContext *s, const AVCodec *codec);
4369 * Get the AVClass for AVCodecContext. It can be used in combination with
4370 * AV_OPT_SEARCH_FAKE_OBJ for examining options.
4372 * @see av_opt_find().
4374 const AVClass *avcodec_get_class(void);
4376 #if FF_API_COPY_CONTEXT
4378 * Get the AVClass for AVFrame. It can be used in combination with
4379 * AV_OPT_SEARCH_FAKE_OBJ for examining options.
4381 * @see av_opt_find().
4383 const AVClass *avcodec_get_frame_class(void);
4386 * Get the AVClass for AVSubtitleRect. It can be used in combination with
4387 * AV_OPT_SEARCH_FAKE_OBJ for examining options.
4389 * @see av_opt_find().
4391 const AVClass *avcodec_get_subtitle_rect_class(void);
4394 * Copy the settings of the source AVCodecContext into the destination
4395 * AVCodecContext. The resulting destination codec context will be
4396 * unopened, i.e. you are required to call avcodec_open2() before you
4397 * can use this AVCodecContext to decode/encode video/audio data.
4399 * @param dest target codec context, should be initialized with
4400 * avcodec_alloc_context3(NULL), but otherwise uninitialized
4401 * @param src source codec context
4402 * @return AVERROR() on error (e.g. memory allocation error), 0 on success
4404 * @deprecated The semantics of this function are ill-defined and it should not
4405 * be used. If you need to transfer the stream parameters from one codec context
4406 * to another, use an intermediate AVCodecParameters instance and the
4407 * avcodec_parameters_from_context() / avcodec_parameters_to_context()
4410 attribute_deprecated
4411 int avcodec_copy_context(AVCodecContext *dest, const AVCodecContext *src);
4415 * Allocate a new AVCodecParameters and set its fields to default values
4416 * (unknown/invalid/0). The returned struct must be freed with
4417 * avcodec_parameters_free().
4419 AVCodecParameters *avcodec_parameters_alloc(void);
4422 * Free an AVCodecParameters instance and everything associated with it and
4423 * write NULL to the supplied pointer.
4425 void avcodec_parameters_free(AVCodecParameters **par);
4428 * Copy the contents of src to dst. Any allocated fields in dst are freed and
4429 * replaced with newly allocated duplicates of the corresponding fields in src.
4431 * @return >= 0 on success, a negative AVERROR code on failure.
4433 int avcodec_parameters_copy(AVCodecParameters *dst, const AVCodecParameters *src);
4436 * Fill the parameters struct based on the values from the supplied codec
4437 * context. Any allocated fields in par are freed and replaced with duplicates
4438 * of the corresponding fields in codec.
4440 * @return >= 0 on success, a negative AVERROR code on failure
4442 int avcodec_parameters_from_context(AVCodecParameters *par,
4443 const AVCodecContext *codec);
4446 * Fill the codec context based on the values from the supplied codec
4447 * parameters. Any allocated fields in codec that have a corresponding field in
4448 * par are freed and replaced with duplicates of the corresponding field in par.
4449 * Fields in codec that do not have a counterpart in par are not touched.
4451 * @return >= 0 on success, a negative AVERROR code on failure.
4453 int avcodec_parameters_to_context(AVCodecContext *codec,
4454 const AVCodecParameters *par);
4457 * Initialize the AVCodecContext to use the given AVCodec. Prior to using this
4458 * function the context has to be allocated with avcodec_alloc_context3().
4460 * The functions avcodec_find_decoder_by_name(), avcodec_find_encoder_by_name(),
4461 * avcodec_find_decoder() and avcodec_find_encoder() provide an easy way for
4462 * retrieving a codec.
4464 * @warning This function is not thread safe!
4466 * @note Always call this function before using decoding routines (such as
4467 * @ref avcodec_receive_frame()).
4470 * avcodec_register_all();
4471 * av_dict_set(&opts, "b", "2.5M", 0);
4472 * codec = avcodec_find_decoder(AV_CODEC_ID_H264);
4476 * context = avcodec_alloc_context3(codec);
4478 * if (avcodec_open2(context, codec, opts) < 0)
4482 * @param avctx The context to initialize.
4483 * @param codec The codec to open this context for. If a non-NULL codec has been
4484 * previously passed to avcodec_alloc_context3() or
4485 * for this context, then this parameter MUST be either NULL or
4486 * equal to the previously passed codec.
4487 * @param options A dictionary filled with AVCodecContext and codec-private options.
4488 * On return this object will be filled with options that were not found.
4490 * @return zero on success, a negative value on error
4491 * @see avcodec_alloc_context3(), avcodec_find_decoder(), avcodec_find_encoder(),
4492 * av_dict_set(), av_opt_find().
4494 int avcodec_open2(AVCodecContext *avctx, const AVCodec *codec, AVDictionary **options);
4497 * Close a given AVCodecContext and free all the data associated with it
4498 * (but not the AVCodecContext itself).
4500 * Calling this function on an AVCodecContext that hasn't been opened will free
4501 * the codec-specific data allocated in avcodec_alloc_context3() with a non-NULL
4502 * codec. Subsequent calls will do nothing.
4504 * @note Do not use this function. Use avcodec_free_context() to destroy a
4505 * codec context (either open or closed). Opening and closing a codec context
4506 * multiple times is not supported anymore -- use multiple codec contexts
4509 int avcodec_close(AVCodecContext *avctx);
4512 * Free all allocated data in the given subtitle struct.
4514 * @param sub AVSubtitle to free.
4516 void avsubtitle_free(AVSubtitle *sub);
4523 * @addtogroup lavc_packet
4528 * Allocate an AVPacket and set its fields to default values. The resulting
4529 * struct must be freed using av_packet_free().
4531 * @return An AVPacket filled with default values or NULL on failure.
4533 * @note this only allocates the AVPacket itself, not the data buffers. Those
4534 * must be allocated through other means such as av_new_packet.
4536 * @see av_new_packet
4538 AVPacket *av_packet_alloc(void);
4541 * Create a new packet that references the same data as src.
4543 * This is a shortcut for av_packet_alloc()+av_packet_ref().
4545 * @return newly created AVPacket on success, NULL on error.
4547 * @see av_packet_alloc
4548 * @see av_packet_ref
4550 AVPacket *av_packet_clone(const AVPacket *src);
4553 * Free the packet, if the packet is reference counted, it will be
4554 * unreferenced first.
4556 * @param pkt packet to be freed. The pointer will be set to NULL.
4557 * @note passing NULL is a no-op.
4559 void av_packet_free(AVPacket **pkt);
4562 * Initialize optional fields of a packet with default values.
4564 * Note, this does not touch the data and size members, which have to be
4565 * initialized separately.
4569 void av_init_packet(AVPacket *pkt);
4572 * Allocate the payload of a packet and initialize its fields with
4576 * @param size wanted payload size
4577 * @return 0 if OK, AVERROR_xxx otherwise
4579 int av_new_packet(AVPacket *pkt, int size);
4582 * Reduce packet size, correctly zeroing padding
4585 * @param size new size
4587 void av_shrink_packet(AVPacket *pkt, int size);
4590 * Increase packet size, correctly zeroing padding
4593 * @param grow_by number of bytes by which to increase the size of the packet
4595 int av_grow_packet(AVPacket *pkt, int grow_by);
4598 * Initialize a reference-counted packet from av_malloc()ed data.
4600 * @param pkt packet to be initialized. This function will set the data, size,
4601 * buf and destruct fields, all others are left untouched.
4602 * @param data Data allocated by av_malloc() to be used as packet data. If this
4603 * function returns successfully, the data is owned by the underlying AVBuffer.
4604 * The caller may not access the data through other means.
4605 * @param size size of data in bytes, without the padding. I.e. the full buffer
4606 * size is assumed to be size + AV_INPUT_BUFFER_PADDING_SIZE.
4608 * @return 0 on success, a negative AVERROR on error
4610 int av_packet_from_data(AVPacket *pkt, uint8_t *data, int size);
4612 #if FF_API_AVPACKET_OLD_API
4614 * @warning This is a hack - the packet memory allocation stuff is broken. The
4615 * packet is allocated if it was not really allocated.
4617 * @deprecated Use av_packet_ref
4619 attribute_deprecated
4620 int av_dup_packet(AVPacket *pkt);
4622 * Copy packet, including contents
4624 * @return 0 on success, negative AVERROR on fail
4626 * @deprecated Use av_packet_ref
4628 attribute_deprecated
4629 int av_copy_packet(AVPacket *dst, const AVPacket *src);
4632 * Copy packet side data
4634 * @return 0 on success, negative AVERROR on fail
4636 int av_copy_packet_side_data(AVPacket *dst, const AVPacket *src);
4641 * @deprecated Use av_packet_unref
4643 * @param pkt packet to free
4645 attribute_deprecated
4646 void av_free_packet(AVPacket *pkt);
4649 * Allocate new information of a packet.
4652 * @param type side information type
4653 * @param size side information size
4654 * @return pointer to fresh allocated data or NULL otherwise
4656 uint8_t* av_packet_new_side_data(AVPacket *pkt, enum AVPacketSideDataType type,
4660 * Wrap an existing array as a packet side data.
4663 * @param type side information type
4664 * @param data the side data array. It must be allocated with the av_malloc()
4665 * family of functions. The ownership of the data is transferred to
4667 * @param size side information size
4668 * @return a non-negative number on success, a negative AVERROR code on
4669 * failure. On failure, the packet is unchanged and the data remains
4670 * owned by the caller.
4672 int av_packet_add_side_data(AVPacket *pkt, enum AVPacketSideDataType type,
4673 uint8_t *data, size_t size);
4676 * Shrink the already allocated side data buffer
4679 * @param type side information type
4680 * @param size new side information size
4681 * @return 0 on success, < 0 on failure
4683 int av_packet_shrink_side_data(AVPacket *pkt, enum AVPacketSideDataType type,
4687 * Get side information from packet.
4690 * @param type desired side information type
4691 * @param size pointer for side information size to store (optional)
4692 * @return pointer to data if present or NULL otherwise
4694 uint8_t* av_packet_get_side_data(const AVPacket *pkt, enum AVPacketSideDataType type,
4697 #if FF_API_MERGE_SD_API
4698 attribute_deprecated
4699 int av_packet_merge_side_data(AVPacket *pkt);
4701 attribute_deprecated
4702 int av_packet_split_side_data(AVPacket *pkt);
4705 const char *av_packet_side_data_name(enum AVPacketSideDataType type);
4708 * Pack a dictionary for use in side_data.
4710 * @param dict The dictionary to pack.
4711 * @param size pointer to store the size of the returned data
4712 * @return pointer to data if successful, NULL otherwise
4714 uint8_t *av_packet_pack_dictionary(AVDictionary *dict, int *size);
4716 * Unpack a dictionary from side_data.
4718 * @param data data from side_data
4719 * @param size size of the data
4720 * @param dict the metadata storage dictionary
4721 * @return 0 on success, < 0 on failure
4723 int av_packet_unpack_dictionary(const uint8_t *data, int size, AVDictionary **dict);
4727 * Convenience function to free all the side data stored.
4728 * All the other fields stay untouched.
4732 void av_packet_free_side_data(AVPacket *pkt);
4735 * Setup a new reference to the data described by a given packet
4737 * If src is reference-counted, setup dst as a new reference to the
4738 * buffer in src. Otherwise allocate a new buffer in dst and copy the
4739 * data from src into it.
4741 * All the other fields are copied from src.
4743 * @see av_packet_unref
4745 * @param dst Destination packet
4746 * @param src Source packet
4748 * @return 0 on success, a negative AVERROR on error.
4750 int av_packet_ref(AVPacket *dst, const AVPacket *src);
4755 * Unreference the buffer referenced by the packet and reset the
4756 * remaining packet fields to their default values.
4758 * @param pkt The packet to be unreferenced.
4760 void av_packet_unref(AVPacket *pkt);
4763 * Move every field in src to dst and reset src.
4765 * @see av_packet_unref
4767 * @param src Source packet, will be reset
4768 * @param dst Destination packet
4770 void av_packet_move_ref(AVPacket *dst, AVPacket *src);
4773 * Copy only "properties" fields from src to dst.
4775 * Properties for the purpose of this function are all the fields
4776 * beside those related to the packet data (buf, data, size)
4778 * @param dst Destination packet
4779 * @param src Source packet
4781 * @return 0 on success AVERROR on failure.
4783 int av_packet_copy_props(AVPacket *dst, const AVPacket *src);
4786 * Convert valid timing fields (timestamps / durations) in a packet from one
4787 * timebase to another. Timestamps with unknown values (AV_NOPTS_VALUE) will be
4790 * @param pkt packet on which the conversion will be performed
4791 * @param tb_src source timebase, in which the timing fields in pkt are
4793 * @param tb_dst destination timebase, to which the timing fields will be
4796 void av_packet_rescale_ts(AVPacket *pkt, AVRational tb_src, AVRational tb_dst);
4803 * @addtogroup lavc_decoding
4808 * Find a registered decoder with a matching codec ID.
4810 * @param id AVCodecID of the requested decoder
4811 * @return A decoder if one was found, NULL otherwise.
4813 AVCodec *avcodec_find_decoder(enum AVCodecID id);
4816 * Find a registered decoder with the specified name.
4818 * @param name name of the requested decoder
4819 * @return A decoder if one was found, NULL otherwise.
4821 AVCodec *avcodec_find_decoder_by_name(const char *name);
4824 * The default callback for AVCodecContext.get_buffer2(). It is made public so
4825 * it can be called by custom get_buffer2() implementations for decoders without
4826 * AV_CODEC_CAP_DR1 set.
4828 int avcodec_default_get_buffer2(AVCodecContext *s, AVFrame *frame, int flags);
4832 * Return the amount of padding in pixels which the get_buffer callback must
4833 * provide around the edge of the image for codecs which do not have the
4834 * CODEC_FLAG_EMU_EDGE flag.
4836 * @return Required padding in pixels.
4838 * @deprecated CODEC_FLAG_EMU_EDGE is deprecated, so this function is no longer
4841 attribute_deprecated
4842 unsigned avcodec_get_edge_width(void);
4846 * Modify width and height values so that they will result in a memory
4847 * buffer that is acceptable for the codec if you do not use any horizontal
4850 * May only be used if a codec with AV_CODEC_CAP_DR1 has been opened.
4852 void avcodec_align_dimensions(AVCodecContext *s, int *width, int *height);
4855 * Modify width and height values so that they will result in a memory
4856 * buffer that is acceptable for the codec if you also ensure that all
4857 * line sizes are a multiple of the respective linesize_align[i].
4859 * May only be used if a codec with AV_CODEC_CAP_DR1 has been opened.
4861 void avcodec_align_dimensions2(AVCodecContext *s, int *width, int *height,
4862 int linesize_align[AV_NUM_DATA_POINTERS]);
4865 * Converts AVChromaLocation to swscale x/y chroma position.
4867 * The positions represent the chroma (0,0) position in a coordinates system
4868 * with luma (0,0) representing the origin and luma(1,1) representing 256,256
4870 * @param xpos horizontal chroma sample position
4871 * @param ypos vertical chroma sample position
4873 int avcodec_enum_to_chroma_pos(int *xpos, int *ypos, enum AVChromaLocation pos);
4876 * Converts swscale x/y chroma position to AVChromaLocation.
4878 * The positions represent the chroma (0,0) position in a coordinates system
4879 * with luma (0,0) representing the origin and luma(1,1) representing 256,256
4881 * @param xpos horizontal chroma sample position
4882 * @param ypos vertical chroma sample position
4884 enum AVChromaLocation avcodec_chroma_pos_to_enum(int xpos, int ypos);
4887 * Decode the audio frame of size avpkt->size from avpkt->data into frame.
4889 * Some decoders may support multiple frames in a single AVPacket. Such
4890 * decoders would then just decode the first frame and the return value would be
4891 * less than the packet size. In this case, avcodec_decode_audio4 has to be
4892 * called again with an AVPacket containing the remaining data in order to
4893 * decode the second frame, etc... Even if no frames are returned, the packet
4894 * needs to be fed to the decoder with remaining data until it is completely
4895 * consumed or an error occurs.
4897 * Some decoders (those marked with AV_CODEC_CAP_DELAY) have a delay between input
4898 * and output. This means that for some packets they will not immediately
4899 * produce decoded output and need to be flushed at the end of decoding to get
4900 * all the decoded data. Flushing is done by calling this function with packets
4901 * with avpkt->data set to NULL and avpkt->size set to 0 until it stops
4902 * returning samples. It is safe to flush even those decoders that are not
4903 * marked with AV_CODEC_CAP_DELAY, then no samples will be returned.
4905 * @warning The input buffer, avpkt->data must be AV_INPUT_BUFFER_PADDING_SIZE
4906 * larger than the actual read bytes because some optimized bitstream
4907 * readers read 32 or 64 bits at once and could read over the end.
4909 * @note The AVCodecContext MUST have been opened with @ref avcodec_open2()
4910 * before packets may be fed to the decoder.
4912 * @param avctx the codec context
4913 * @param[out] frame The AVFrame in which to store decoded audio samples.
4914 * The decoder will allocate a buffer for the decoded frame by
4915 * calling the AVCodecContext.get_buffer2() callback.
4916 * When AVCodecContext.refcounted_frames is set to 1, the frame is
4917 * reference counted and the returned reference belongs to the
4918 * caller. The caller must release the frame using av_frame_unref()
4919 * when the frame is no longer needed. The caller may safely write
4920 * to the frame if av_frame_is_writable() returns 1.
4921 * When AVCodecContext.refcounted_frames is set to 0, the returned
4922 * reference belongs to the decoder and is valid only until the
4923 * next call to this function or until closing or flushing the
4924 * decoder. The caller may not write to it.
4925 * @param[out] got_frame_ptr Zero if no frame could be decoded, otherwise it is
4926 * non-zero. Note that this field being set to zero
4927 * does not mean that an error has occurred. For
4928 * decoders with AV_CODEC_CAP_DELAY set, no given decode
4929 * call is guaranteed to produce a frame.
4930 * @param[in] avpkt The input AVPacket containing the input buffer.
4931 * At least avpkt->data and avpkt->size should be set. Some
4932 * decoders might also require additional fields to be set.
4933 * @return A negative error code is returned if an error occurred during
4934 * decoding, otherwise the number of bytes consumed from the input
4935 * AVPacket is returned.
4937 * @deprecated Use avcodec_send_packet() and avcodec_receive_frame().
4939 attribute_deprecated
4940 int avcodec_decode_audio4(AVCodecContext *avctx, AVFrame *frame,
4941 int *got_frame_ptr, const AVPacket *avpkt);
4944 * Decode the video frame of size avpkt->size from avpkt->data into picture.
4945 * Some decoders may support multiple frames in a single AVPacket, such
4946 * decoders would then just decode the first frame.
4948 * @warning The input buffer must be AV_INPUT_BUFFER_PADDING_SIZE larger than
4949 * the actual read bytes because some optimized bitstream readers read 32 or 64
4950 * bits at once and could read over the end.
4952 * @warning The end of the input buffer buf should be set to 0 to ensure that
4953 * no overreading happens for damaged MPEG streams.
4955 * @note Codecs which have the AV_CODEC_CAP_DELAY capability set have a delay
4956 * between input and output, these need to be fed with avpkt->data=NULL,
4957 * avpkt->size=0 at the end to return the remaining frames.
4959 * @note The AVCodecContext MUST have been opened with @ref avcodec_open2()
4960 * before packets may be fed to the decoder.
4962 * @param avctx the codec context
4963 * @param[out] picture The AVFrame in which the decoded video frame will be stored.
4964 * Use av_frame_alloc() to get an AVFrame. The codec will
4965 * allocate memory for the actual bitmap by calling the
4966 * AVCodecContext.get_buffer2() callback.
4967 * When AVCodecContext.refcounted_frames is set to 1, the frame is
4968 * reference counted and the returned reference belongs to the
4969 * caller. The caller must release the frame using av_frame_unref()
4970 * when the frame is no longer needed. The caller may safely write
4971 * to the frame if av_frame_is_writable() returns 1.
4972 * When AVCodecContext.refcounted_frames is set to 0, the returned
4973 * reference belongs to the decoder and is valid only until the
4974 * next call to this function or until closing or flushing the
4975 * decoder. The caller may not write to it.
4977 * @param[in] avpkt The input AVPacket containing the input buffer.
4978 * You can create such packet with av_init_packet() and by then setting
4979 * data and size, some decoders might in addition need other fields like
4980 * flags&AV_PKT_FLAG_KEY. All decoders are designed to use the least
4982 * @param[in,out] got_picture_ptr Zero if no frame could be decompressed, otherwise, it is nonzero.
4983 * @return On error a negative value is returned, otherwise the number of bytes
4984 * used or zero if no frame could be decompressed.
4986 * @deprecated Use avcodec_send_packet() and avcodec_receive_frame().
4988 attribute_deprecated
4989 int avcodec_decode_video2(AVCodecContext *avctx, AVFrame *picture,
4990 int *got_picture_ptr,
4991 const AVPacket *avpkt);
4994 * Decode a subtitle message.
4995 * Return a negative value on error, otherwise return the number of bytes used.
4996 * If no subtitle could be decompressed, got_sub_ptr is zero.
4997 * Otherwise, the subtitle is stored in *sub.
4998 * Note that AV_CODEC_CAP_DR1 is not available for subtitle codecs. This is for
4999 * simplicity, because the performance difference is expect to be negligible
5000 * and reusing a get_buffer written for video codecs would probably perform badly
5001 * due to a potentially very different allocation pattern.
5003 * Some decoders (those marked with AV_CODEC_CAP_DELAY) have a delay between input
5004 * and output. This means that for some packets they will not immediately
5005 * produce decoded output and need to be flushed at the end of decoding to get
5006 * all the decoded data. Flushing is done by calling this function with packets
5007 * with avpkt->data set to NULL and avpkt->size set to 0 until it stops
5008 * returning subtitles. It is safe to flush even those decoders that are not
5009 * marked with AV_CODEC_CAP_DELAY, then no subtitles will be returned.
5011 * @note The AVCodecContext MUST have been opened with @ref avcodec_open2()
5012 * before packets may be fed to the decoder.
5014 * @param avctx the codec context
5015 * @param[out] sub The Preallocated AVSubtitle in which the decoded subtitle will be stored,
5016 * must be freed with avsubtitle_free if *got_sub_ptr is set.
5017 * @param[in,out] got_sub_ptr Zero if no subtitle could be decompressed, otherwise, it is nonzero.
5018 * @param[in] avpkt The input AVPacket containing the input buffer.
5020 int avcodec_decode_subtitle2(AVCodecContext *avctx, AVSubtitle *sub,
5025 * Supply raw packet data as input to a decoder.
5027 * Internally, this call will copy relevant AVCodecContext fields, which can
5028 * influence decoding per-packet, and apply them when the packet is actually
5029 * decoded. (For example AVCodecContext.skip_frame, which might direct the
5030 * decoder to drop the frame contained by the packet sent with this function.)
5032 * @warning The input buffer, avpkt->data must be AV_INPUT_BUFFER_PADDING_SIZE
5033 * larger than the actual read bytes because some optimized bitstream
5034 * readers read 32 or 64 bits at once and could read over the end.
5036 * @warning Do not mix this API with the legacy API (like avcodec_decode_video2())
5037 * on the same AVCodecContext. It will return unexpected results now
5038 * or in future libavcodec versions.
5040 * @note The AVCodecContext MUST have been opened with @ref avcodec_open2()
5041 * before packets may be fed to the decoder.
5043 * @param avctx codec context
5044 * @param[in] avpkt The input AVPacket. Usually, this will be a single video
5045 * frame, or several complete audio frames.
5046 * Ownership of the packet remains with the caller, and the
5047 * decoder will not write to the packet. The decoder may create
5048 * a reference to the packet data (or copy it if the packet is
5049 * not reference-counted).
5050 * Unlike with older APIs, the packet is always fully consumed,
5051 * and if it contains multiple frames (e.g. some audio codecs),
5052 * will require you to call avcodec_receive_frame() multiple
5053 * times afterwards before you can send a new packet.
5054 * It can be NULL (or an AVPacket with data set to NULL and
5055 * size set to 0); in this case, it is considered a flush
5056 * packet, which signals the end of the stream. Sending the
5057 * first flush packet will return success. Subsequent ones are
5058 * unnecessary and will return AVERROR_EOF. If the decoder
5059 * still has frames buffered, it will return them after sending
5062 * @return 0 on success, otherwise negative error code:
5063 * AVERROR(EAGAIN): input is not accepted in the current state - user
5064 * must read output with avcodec_receive_frame() (once
5065 * all output is read, the packet should be resent, and
5066 * the call will not fail with EAGAIN).
5067 * AVERROR_EOF: the decoder has been flushed, and no new packets can
5068 * be sent to it (also returned if more than 1 flush
5070 * AVERROR(EINVAL): codec not opened, it is an encoder, or requires flush
5071 * AVERROR(ENOMEM): failed to add packet to internal queue, or similar
5072 * other errors: legitimate decoding errors
5074 int avcodec_send_packet(AVCodecContext *avctx, const AVPacket *avpkt);
5077 * Return decoded output data from a decoder.
5079 * @param avctx codec context
5080 * @param frame This will be set to a reference-counted video or audio
5081 * frame (depending on the decoder type) allocated by the
5082 * decoder. Note that the function will always call
5083 * av_frame_unref(frame) before doing anything else.
5086 * 0: success, a frame was returned
5087 * AVERROR(EAGAIN): output is not available in this state - user must try
5089 * AVERROR_EOF: the decoder has been fully flushed, and there will be
5090 * no more output frames
5091 * AVERROR(EINVAL): codec not opened, or it is an encoder
5092 * other negative values: legitimate decoding errors
5094 int avcodec_receive_frame(AVCodecContext *avctx, AVFrame *frame);
5097 * Supply a raw video or audio frame to the encoder. Use avcodec_receive_packet()
5098 * to retrieve buffered output packets.
5100 * @param avctx codec context
5101 * @param[in] frame AVFrame containing the raw audio or video frame to be encoded.
5102 * Ownership of the frame remains with the caller, and the
5103 * encoder will not write to the frame. The encoder may create
5104 * a reference to the frame data (or copy it if the frame is
5105 * not reference-counted).
5106 * It can be NULL, in which case it is considered a flush
5107 * packet. This signals the end of the stream. If the encoder
5108 * still has packets buffered, it will return them after this
5109 * call. Once flushing mode has been entered, additional flush
5110 * packets are ignored, and sending frames will return
5114 * If AV_CODEC_CAP_VARIABLE_FRAME_SIZE is set, then each frame
5115 * can have any number of samples.
5116 * If it is not set, frame->nb_samples must be equal to
5117 * avctx->frame_size for all frames except the last.
5118 * The final frame may be smaller than avctx->frame_size.
5119 * @return 0 on success, otherwise negative error code:
5120 * AVERROR(EAGAIN): input is not accepted in the current state - user
5121 * must read output with avcodec_receive_packet() (once
5122 * all output is read, the packet should be resent, and
5123 * the call will not fail with EAGAIN).
5124 * AVERROR_EOF: the encoder has been flushed, and no new frames can
5126 * AVERROR(EINVAL): codec not opened, refcounted_frames not set, it is a
5127 * decoder, or requires flush
5128 * AVERROR(ENOMEM): failed to add packet to internal queue, or similar
5129 * other errors: legitimate decoding errors
5131 int avcodec_send_frame(AVCodecContext *avctx, const AVFrame *frame);
5134 * Read encoded data from the encoder.
5136 * @param avctx codec context
5137 * @param avpkt This will be set to a reference-counted packet allocated by the
5138 * encoder. Note that the function will always call
5139 * av_frame_unref(frame) before doing anything else.
5140 * @return 0 on success, otherwise negative error code:
5141 * AVERROR(EAGAIN): output is not available in the current state - user
5142 * must try to send input
5143 * AVERROR_EOF: the encoder has been fully flushed, and there will be
5144 * no more output packets
5145 * AVERROR(EINVAL): codec not opened, or it is an encoder
5146 * other errors: legitimate decoding errors
5148 int avcodec_receive_packet(AVCodecContext *avctx, AVPacket *avpkt);
5152 * @defgroup lavc_parsing Frame parsing
5156 enum AVPictureStructure {
5157 AV_PICTURE_STRUCTURE_UNKNOWN, //< unknown
5158 AV_PICTURE_STRUCTURE_TOP_FIELD, //< coded as top field
5159 AV_PICTURE_STRUCTURE_BOTTOM_FIELD, //< coded as bottom field
5160 AV_PICTURE_STRUCTURE_FRAME, //< coded as frame
5163 typedef struct AVCodecParserContext {
5165 struct AVCodecParser *parser;
5166 int64_t frame_offset; /* offset of the current frame */
5167 int64_t cur_offset; /* current offset
5168 (incremented by each av_parser_parse()) */
5169 int64_t next_frame_offset; /* offset of the next frame */
5171 int pict_type; /* XXX: Put it back in AVCodecContext. */
5173 * This field is used for proper frame duration computation in lavf.
5174 * It signals, how much longer the frame duration of the current frame
5175 * is compared to normal frame duration.
5177 * frame_duration = (1 + repeat_pict) * time_base
5179 * It is used by codecs like H.264 to display telecined material.
5181 int repeat_pict; /* XXX: Put it back in AVCodecContext. */
5182 int64_t pts; /* pts of the current frame */
5183 int64_t dts; /* dts of the current frame */
5188 int fetch_timestamp;
5190 #define AV_PARSER_PTS_NB 4
5191 int cur_frame_start_index;
5192 int64_t cur_frame_offset[AV_PARSER_PTS_NB];
5193 int64_t cur_frame_pts[AV_PARSER_PTS_NB];
5194 int64_t cur_frame_dts[AV_PARSER_PTS_NB];
5197 #define PARSER_FLAG_COMPLETE_FRAMES 0x0001
5198 #define PARSER_FLAG_ONCE 0x0002
5199 /// Set if the parser has a valid file offset
5200 #define PARSER_FLAG_FETCHED_OFFSET 0x0004
5201 #define PARSER_FLAG_USE_CODEC_TS 0x1000
5203 int64_t offset; ///< byte offset from starting packet start
5204 int64_t cur_frame_end[AV_PARSER_PTS_NB];
5207 * Set by parser to 1 for key frames and 0 for non-key frames.
5208 * It is initialized to -1, so if the parser doesn't set this flag,
5209 * old-style fallback using AV_PICTURE_TYPE_I picture type as key frames
5214 #if FF_API_CONVERGENCE_DURATION
5216 * @deprecated unused
5218 attribute_deprecated
5219 int64_t convergence_duration;
5222 // Timestamp generation support:
5224 * Synchronization point for start of timestamp generation.
5226 * Set to >0 for sync point, 0 for no sync point and <0 for undefined
5229 * For example, this corresponds to presence of H.264 buffering period
5235 * Offset of the current timestamp against last timestamp sync point in
5236 * units of AVCodecContext.time_base.
5238 * Set to INT_MIN when dts_sync_point unused. Otherwise, it must
5239 * contain a valid timestamp offset.
5241 * Note that the timestamp of sync point has usually a nonzero
5242 * dts_ref_dts_delta, which refers to the previous sync point. Offset of
5243 * the next frame after timestamp sync point will be usually 1.
5245 * For example, this corresponds to H.264 cpb_removal_delay.
5247 int dts_ref_dts_delta;
5250 * Presentation delay of current frame in units of AVCodecContext.time_base.
5252 * Set to INT_MIN when dts_sync_point unused. Otherwise, it must
5253 * contain valid non-negative timestamp delta (presentation time of a frame
5254 * must not lie in the past).
5256 * This delay represents the difference between decoding and presentation
5257 * time of the frame.
5259 * For example, this corresponds to H.264 dpb_output_delay.
5264 * Position of the packet in file.
5266 * Analogous to cur_frame_pts/dts
5268 int64_t cur_frame_pos[AV_PARSER_PTS_NB];
5271 * Byte position of currently parsed frame in stream.
5276 * Previous frame byte position.
5281 * Duration of the current frame.
5282 * For audio, this is in units of 1 / AVCodecContext.sample_rate.
5283 * For all other types, this is in units of AVCodecContext.time_base.
5287 enum AVFieldOrder field_order;
5290 * Indicate whether a picture is coded as a frame, top field or bottom field.
5292 * For example, H.264 field_pic_flag equal to 0 corresponds to
5293 * AV_PICTURE_STRUCTURE_FRAME. An H.264 picture with field_pic_flag
5294 * equal to 1 and bottom_field_flag equal to 0 corresponds to
5295 * AV_PICTURE_STRUCTURE_TOP_FIELD.
5297 enum AVPictureStructure picture_structure;
5300 * Picture number incremented in presentation or output order.
5301 * This field may be reinitialized at the first picture of a new sequence.
5303 * For example, this corresponds to H.264 PicOrderCnt.
5305 int output_picture_number;
5308 * Dimensions of the decoded video intended for presentation.
5314 * Dimensions of the coded video.
5320 * The format of the coded data, corresponds to enum AVPixelFormat for video
5321 * and for enum AVSampleFormat for audio.
5323 * Note that a decoder can have considerable freedom in how exactly it
5324 * decodes the data, so the format reported here might be different from the
5325 * one returned by a decoder.
5328 } AVCodecParserContext;
5330 typedef struct AVCodecParser {
5331 int codec_ids[5]; /* several codec IDs are permitted */
5333 int (*parser_init)(AVCodecParserContext *s);
5334 /* This callback never returns an error, a negative value means that
5335 * the frame start was in a previous packet. */
5336 int (*parser_parse)(AVCodecParserContext *s,
5337 AVCodecContext *avctx,
5338 const uint8_t **poutbuf, int *poutbuf_size,
5339 const uint8_t *buf, int buf_size);
5340 void (*parser_close)(AVCodecParserContext *s);
5341 int (*split)(AVCodecContext *avctx, const uint8_t *buf, int buf_size);
5342 struct AVCodecParser *next;
5345 AVCodecParser *av_parser_next(const AVCodecParser *c);
5347 void av_register_codec_parser(AVCodecParser *parser);
5348 AVCodecParserContext *av_parser_init(int codec_id);
5353 * @param s parser context.
5354 * @param avctx codec context.
5355 * @param poutbuf set to pointer to parsed buffer or NULL if not yet finished.
5356 * @param poutbuf_size set to size of parsed buffer or zero if not yet finished.
5357 * @param buf input buffer.
5358 * @param buf_size buffer size in bytes without the padding. I.e. the full buffer
5359 size is assumed to be buf_size + AV_INPUT_BUFFER_PADDING_SIZE.
5360 To signal EOF, this should be 0 (so that the last frame
5362 * @param pts input presentation timestamp.
5363 * @param dts input decoding timestamp.
5364 * @param pos input byte position in stream.
5365 * @return the number of bytes of the input bitstream used.
5370 * len = av_parser_parse2(myparser, AVCodecContext, &data, &size,
5377 * decode_frame(data, size);
5381 int av_parser_parse2(AVCodecParserContext *s,
5382 AVCodecContext *avctx,
5383 uint8_t **poutbuf, int *poutbuf_size,
5384 const uint8_t *buf, int buf_size,
5385 int64_t pts, int64_t dts,
5389 * @return 0 if the output buffer is a subset of the input, 1 if it is allocated and must be freed
5390 * @deprecated use AVBitStreamFilter
5392 int av_parser_change(AVCodecParserContext *s,
5393 AVCodecContext *avctx,
5394 uint8_t **poutbuf, int *poutbuf_size,
5395 const uint8_t *buf, int buf_size, int keyframe);
5396 void av_parser_close(AVCodecParserContext *s);
5404 * @addtogroup lavc_encoding
5409 * Find a registered encoder with a matching codec ID.
5411 * @param id AVCodecID of the requested encoder
5412 * @return An encoder if one was found, NULL otherwise.
5414 AVCodec *avcodec_find_encoder(enum AVCodecID id);
5417 * Find a registered encoder with the specified name.
5419 * @param name name of the requested encoder
5420 * @return An encoder if one was found, NULL otherwise.
5422 AVCodec *avcodec_find_encoder_by_name(const char *name);
5425 * Encode a frame of audio.
5427 * Takes input samples from frame and writes the next output packet, if
5428 * available, to avpkt. The output packet does not necessarily contain data for
5429 * the most recent frame, as encoders can delay, split, and combine input frames
5430 * internally as needed.
5432 * @param avctx codec context
5433 * @param avpkt output AVPacket.
5434 * The user can supply an output buffer by setting
5435 * avpkt->data and avpkt->size prior to calling the
5436 * function, but if the size of the user-provided data is not
5437 * large enough, encoding will fail. If avpkt->data and
5438 * avpkt->size are set, avpkt->destruct must also be set. All
5439 * other AVPacket fields will be reset by the encoder using
5440 * av_init_packet(). If avpkt->data is NULL, the encoder will
5441 * allocate it. The encoder will set avpkt->size to the size
5442 * of the output packet.
5444 * If this function fails or produces no output, avpkt will be
5445 * freed using av_packet_unref().
5446 * @param[in] frame AVFrame containing the raw audio data to be encoded.
5447 * May be NULL when flushing an encoder that has the
5448 * AV_CODEC_CAP_DELAY capability set.
5449 * If AV_CODEC_CAP_VARIABLE_FRAME_SIZE is set, then each frame
5450 * can have any number of samples.
5451 * If it is not set, frame->nb_samples must be equal to
5452 * avctx->frame_size for all frames except the last.
5453 * The final frame may be smaller than avctx->frame_size.
5454 * @param[out] got_packet_ptr This field is set to 1 by libavcodec if the
5455 * output packet is non-empty, and to 0 if it is
5456 * empty. If the function returns an error, the
5457 * packet can be assumed to be invalid, and the
5458 * value of got_packet_ptr is undefined and should
5460 * @return 0 on success, negative error code on failure
5462 * @deprecated use avcodec_send_frame()/avcodec_receive_packet() instead
5464 attribute_deprecated
5465 int avcodec_encode_audio2(AVCodecContext *avctx, AVPacket *avpkt,
5466 const AVFrame *frame, int *got_packet_ptr);
5469 * Encode a frame of video.
5471 * Takes input raw video data from frame and writes the next output packet, if
5472 * available, to avpkt. The output packet does not necessarily contain data for
5473 * the most recent frame, as encoders can delay and reorder input frames
5474 * internally as needed.
5476 * @param avctx codec context
5477 * @param avpkt output AVPacket.
5478 * The user can supply an output buffer by setting
5479 * avpkt->data and avpkt->size prior to calling the
5480 * function, but if the size of the user-provided data is not
5481 * large enough, encoding will fail. All other AVPacket fields
5482 * will be reset by the encoder using av_init_packet(). If
5483 * avpkt->data is NULL, the encoder will allocate it.
5484 * The encoder will set avpkt->size to the size of the
5485 * output packet. The returned data (if any) belongs to the
5486 * caller, he is responsible for freeing it.
5488 * If this function fails or produces no output, avpkt will be
5489 * freed using av_packet_unref().
5490 * @param[in] frame AVFrame containing the raw video data to be encoded.
5491 * May be NULL when flushing an encoder that has the
5492 * AV_CODEC_CAP_DELAY capability set.
5493 * @param[out] got_packet_ptr This field is set to 1 by libavcodec if the
5494 * output packet is non-empty, and to 0 if it is
5495 * empty. If the function returns an error, the
5496 * packet can be assumed to be invalid, and the
5497 * value of got_packet_ptr is undefined and should
5499 * @return 0 on success, negative error code on failure
5501 * @deprecated use avcodec_send_frame()/avcodec_receive_packet() instead
5503 attribute_deprecated
5504 int avcodec_encode_video2(AVCodecContext *avctx, AVPacket *avpkt,
5505 const AVFrame *frame, int *got_packet_ptr);
5507 int avcodec_encode_subtitle(AVCodecContext *avctx, uint8_t *buf, int buf_size,
5508 const AVSubtitle *sub);
5515 #if FF_API_AVCODEC_RESAMPLE
5517 * @defgroup lavc_resample Audio resampling
5519 * @deprecated use libswresample instead
5523 struct ReSampleContext;
5524 struct AVResampleContext;
5526 typedef struct ReSampleContext ReSampleContext;
5529 * Initialize audio resampling context.
5531 * @param output_channels number of output channels
5532 * @param input_channels number of input channels
5533 * @param output_rate output sample rate
5534 * @param input_rate input sample rate
5535 * @param sample_fmt_out requested output sample format
5536 * @param sample_fmt_in input sample format
5537 * @param filter_length length of each FIR filter in the filterbank relative to the cutoff frequency
5538 * @param log2_phase_count log2 of the number of entries in the polyphase filterbank
5539 * @param linear if 1 then the used FIR filter will be linearly interpolated
5540 between the 2 closest, if 0 the closest will be used
5541 * @param cutoff cutoff frequency, 1.0 corresponds to half the output sampling rate
5542 * @return allocated ReSampleContext, NULL if error occurred
5544 attribute_deprecated
5545 ReSampleContext *av_audio_resample_init(int output_channels, int input_channels,
5546 int output_rate, int input_rate,
5547 enum AVSampleFormat sample_fmt_out,
5548 enum AVSampleFormat sample_fmt_in,
5549 int filter_length, int log2_phase_count,
5550 int linear, double cutoff);
5552 attribute_deprecated
5553 int audio_resample(ReSampleContext *s, short *output, short *input, int nb_samples);
5556 * Free resample context.
5558 * @param s a non-NULL pointer to a resample context previously
5559 * created with av_audio_resample_init()
5561 attribute_deprecated
5562 void audio_resample_close(ReSampleContext *s);
5566 * Initialize an audio resampler.
5567 * Note, if either rate is not an integer then simply scale both rates up so they are.
5568 * @param filter_length length of each FIR filter in the filterbank relative to the cutoff freq
5569 * @param log2_phase_count log2 of the number of entries in the polyphase filterbank
5570 * @param linear If 1 then the used FIR filter will be linearly interpolated
5571 between the 2 closest, if 0 the closest will be used
5572 * @param cutoff cutoff frequency, 1.0 corresponds to half the output sampling rate
5574 attribute_deprecated
5575 struct AVResampleContext *av_resample_init(int out_rate, int in_rate, int filter_length, int log2_phase_count, int linear, double cutoff);
5578 * Resample an array of samples using a previously configured context.
5579 * @param src an array of unconsumed samples
5580 * @param consumed the number of samples of src which have been consumed are returned here
5581 * @param src_size the number of unconsumed samples available
5582 * @param dst_size the amount of space in samples available in dst
5583 * @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.
5584 * @return the number of samples written in dst or -1 if an error occurred
5586 attribute_deprecated
5587 int av_resample(struct AVResampleContext *c, short *dst, short *src, int *consumed, int src_size, int dst_size, int update_ctx);
5591 * Compensate samplerate/timestamp drift. The compensation is done by changing
5592 * the resampler parameters, so no audible clicks or similar distortions occur
5593 * @param compensation_distance distance in output samples over which the compensation should be performed
5594 * @param sample_delta number of output samples which should be output less
5596 * example: av_resample_compensate(c, 10, 500)
5597 * here instead of 510 samples only 500 samples would be output
5599 * note, due to rounding the actual compensation might be slightly different,
5600 * especially if the compensation_distance is large and the in_rate used during init is small
5602 attribute_deprecated
5603 void av_resample_compensate(struct AVResampleContext *c, int sample_delta, int compensation_distance);
5604 attribute_deprecated
5605 void av_resample_close(struct AVResampleContext *c);
5612 #if FF_API_AVPICTURE
5614 * @addtogroup lavc_picture
5619 * @deprecated unused
5621 attribute_deprecated
5622 int avpicture_alloc(AVPicture *picture, enum AVPixelFormat pix_fmt, int width, int height);
5625 * @deprecated unused
5627 attribute_deprecated
5628 void avpicture_free(AVPicture *picture);
5631 * @deprecated use av_image_fill_arrays() instead.
5633 attribute_deprecated
5634 int avpicture_fill(AVPicture *picture, const uint8_t *ptr,
5635 enum AVPixelFormat pix_fmt, int width, int height);
5638 * @deprecated use av_image_copy_to_buffer() instead.
5640 attribute_deprecated
5641 int avpicture_layout(const AVPicture *src, enum AVPixelFormat pix_fmt,
5642 int width, int height,
5643 unsigned char *dest, int dest_size);
5646 * @deprecated use av_image_get_buffer_size() instead.
5648 attribute_deprecated
5649 int avpicture_get_size(enum AVPixelFormat pix_fmt, int width, int height);
5652 * @deprecated av_image_copy() instead.
5654 attribute_deprecated
5655 void av_picture_copy(AVPicture *dst, const AVPicture *src,
5656 enum AVPixelFormat pix_fmt, int width, int height);
5659 * @deprecated unused
5661 attribute_deprecated
5662 int av_picture_crop(AVPicture *dst, const AVPicture *src,
5663 enum AVPixelFormat pix_fmt, int top_band, int left_band);
5666 * @deprecated unused
5668 attribute_deprecated
5669 int av_picture_pad(AVPicture *dst, const AVPicture *src, int height, int width, enum AVPixelFormat pix_fmt,
5670 int padtop, int padbottom, int padleft, int padright, int *color);
5678 * @defgroup lavc_misc Utility functions
5681 * Miscellaneous utility functions related to both encoding and decoding
5687 * @defgroup lavc_misc_pixfmt Pixel formats
5689 * Functions for working with pixel formats.
5693 #if FF_API_GETCHROMA
5695 * @deprecated Use av_pix_fmt_get_chroma_sub_sample
5698 attribute_deprecated
5699 void avcodec_get_chroma_sub_sample(enum AVPixelFormat pix_fmt, int *h_shift, int *v_shift);
5703 * Return a value representing the fourCC code associated to the
5704 * pixel format pix_fmt, or 0 if no associated fourCC code can be
5707 unsigned int avcodec_pix_fmt_to_codec_tag(enum AVPixelFormat pix_fmt);
5710 * @deprecated see av_get_pix_fmt_loss()
5712 int avcodec_get_pix_fmt_loss(enum AVPixelFormat dst_pix_fmt, enum AVPixelFormat src_pix_fmt,
5716 * Find the best pixel format to convert to given a certain source pixel
5717 * format. When converting from one pixel format to another, information loss
5718 * may occur. For example, when converting from RGB24 to GRAY, the color
5719 * information will be lost. Similarly, other losses occur when converting from
5720 * some formats to other formats. avcodec_find_best_pix_fmt_of_2() searches which of
5721 * the given pixel formats should be used to suffer the least amount of loss.
5722 * The pixel formats from which it chooses one, are determined by the
5723 * pix_fmt_list parameter.
5726 * @param[in] pix_fmt_list AV_PIX_FMT_NONE terminated array of pixel formats to choose from
5727 * @param[in] src_pix_fmt source pixel format
5728 * @param[in] has_alpha Whether the source pixel format alpha channel is used.
5729 * @param[out] loss_ptr Combination of flags informing you what kind of losses will occur.
5730 * @return The best pixel format to convert to or -1 if none was found.
5732 enum AVPixelFormat avcodec_find_best_pix_fmt_of_list(const enum AVPixelFormat *pix_fmt_list,
5733 enum AVPixelFormat src_pix_fmt,
5734 int has_alpha, int *loss_ptr);
5737 * @deprecated see av_find_best_pix_fmt_of_2()
5739 enum AVPixelFormat avcodec_find_best_pix_fmt_of_2(enum AVPixelFormat dst_pix_fmt1, enum AVPixelFormat dst_pix_fmt2,
5740 enum AVPixelFormat src_pix_fmt, int has_alpha, int *loss_ptr);
5742 attribute_deprecated
5743 enum AVPixelFormat avcodec_find_best_pix_fmt2(enum AVPixelFormat dst_pix_fmt1, enum AVPixelFormat dst_pix_fmt2,
5744 enum AVPixelFormat src_pix_fmt, int has_alpha, int *loss_ptr);
5746 enum AVPixelFormat avcodec_default_get_format(struct AVCodecContext *s, const enum AVPixelFormat * fmt);
5752 #if FF_API_SET_DIMENSIONS
5754 * @deprecated this function is not supposed to be used from outside of lavc
5756 attribute_deprecated
5757 void avcodec_set_dimensions(AVCodecContext *s, int width, int height);
5760 #if FF_API_TAG_STRING
5762 * Put a string representing the codec tag codec_tag in buf.
5764 * @param buf buffer to place codec tag in
5765 * @param buf_size size in bytes of buf
5766 * @param codec_tag codec tag to assign
5767 * @return the length of the string that would have been generated if
5768 * enough space had been available, excluding the trailing null
5770 * @deprecated see av_fourcc_make_string() and av_fourcc2str().
5772 attribute_deprecated
5773 size_t av_get_codec_tag_string(char *buf, size_t buf_size, unsigned int codec_tag);
5776 void avcodec_string(char *buf, int buf_size, AVCodecContext *enc, int encode);
5779 * Return a name for the specified profile, if available.
5781 * @param codec the codec that is searched for the given profile
5782 * @param profile the profile value for which a name is requested
5783 * @return A name for the profile if found, NULL otherwise.
5785 const char *av_get_profile_name(const AVCodec *codec, int profile);
5788 * Return a name for the specified profile, if available.
5790 * @param codec_id the ID of the codec to which the requested profile belongs
5791 * @param profile the profile value for which a name is requested
5792 * @return A name for the profile if found, NULL otherwise.
5794 * @note unlike av_get_profile_name(), which searches a list of profiles
5795 * supported by a specific decoder or encoder implementation, this
5796 * function searches the list of profiles from the AVCodecDescriptor
5798 const char *avcodec_profile_name(enum AVCodecID codec_id, int profile);
5800 int avcodec_default_execute(AVCodecContext *c, int (*func)(AVCodecContext *c2, void *arg2),void *arg, int *ret, int count, int size);
5801 int avcodec_default_execute2(AVCodecContext *c, int (*func)(AVCodecContext *c2, void *arg2, int, int),void *arg, int *ret, int count);
5802 //FIXME func typedef
5805 * Fill AVFrame audio data and linesize pointers.
5807 * The buffer buf must be a preallocated buffer with a size big enough
5808 * to contain the specified samples amount. The filled AVFrame data
5809 * pointers will point to this buffer.
5811 * AVFrame extended_data channel pointers are allocated if necessary for
5814 * @param frame the AVFrame
5815 * frame->nb_samples must be set prior to calling the
5816 * function. This function fills in frame->data,
5817 * frame->extended_data, frame->linesize[0].
5818 * @param nb_channels channel count
5819 * @param sample_fmt sample format
5820 * @param buf buffer to use for frame data
5821 * @param buf_size size of buffer
5822 * @param align plane size sample alignment (0 = default)
5823 * @return >=0 on success, negative error code on failure
5824 * @todo return the size in bytes required to store the samples in
5825 * case of success, at the next libavutil bump
5827 int avcodec_fill_audio_frame(AVFrame *frame, int nb_channels,
5828 enum AVSampleFormat sample_fmt, const uint8_t *buf,
5829 int buf_size, int align);
5832 * Reset the internal decoder state / flush internal buffers. Should be called
5833 * e.g. when seeking or when switching to a different stream.
5835 * @note when refcounted frames are not used (i.e. avctx->refcounted_frames is 0),
5836 * this invalidates the frames previously returned from the decoder. When
5837 * refcounted frames are used, the decoder just releases any references it might
5838 * keep internally, but the caller's reference remains valid.
5840 void avcodec_flush_buffers(AVCodecContext *avctx);
5843 * Return codec bits per sample.
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_bits_per_sample(enum AVCodecID codec_id);
5851 * Return the PCM codec associated with a sample format.
5852 * @param be endianness, 0 for little, 1 for big,
5853 * -1 (or anything else) for native
5854 * @return AV_CODEC_ID_PCM_* or AV_CODEC_ID_NONE
5856 enum AVCodecID av_get_pcm_codec(enum AVSampleFormat fmt, int be);
5859 * Return codec bits per sample.
5860 * Only return non-zero if the bits per sample is exactly correct, not an
5863 * @param[in] codec_id the codec
5864 * @return Number of bits per sample or zero if unknown for the given codec.
5866 int av_get_exact_bits_per_sample(enum AVCodecID codec_id);
5869 * Return audio frame duration.
5871 * @param avctx codec context
5872 * @param frame_bytes size of the frame, or 0 if unknown
5873 * @return frame duration, in samples, if known. 0 if not able to
5876 int av_get_audio_frame_duration(AVCodecContext *avctx, int frame_bytes);
5879 * This function is the same as av_get_audio_frame_duration(), except it works
5880 * with AVCodecParameters instead of an AVCodecContext.
5882 int av_get_audio_frame_duration2(AVCodecParameters *par, int frame_bytes);
5885 typedef struct AVBitStreamFilterContext {
5887 const struct AVBitStreamFilter *filter;
5888 AVCodecParserContext *parser;
5889 struct AVBitStreamFilterContext *next;
5891 * Internal default arguments, used if NULL is passed to av_bitstream_filter_filter().
5892 * Not for access by library users.
5895 } AVBitStreamFilterContext;
5898 typedef struct AVBSFInternal AVBSFInternal;
5901 * The bitstream filter state.
5903 * This struct must be allocated with av_bsf_alloc() and freed with
5906 * The fields in the struct will only be changed (by the caller or by the
5907 * filter) as described in their documentation, and are to be considered
5908 * immutable otherwise.
5910 typedef struct AVBSFContext {
5912 * A class for logging and AVOptions
5914 const AVClass *av_class;
5917 * The bitstream filter this context is an instance of.
5919 const struct AVBitStreamFilter *filter;
5922 * Opaque libavcodec internal data. Must not be touched by the caller in any
5925 AVBSFInternal *internal;
5928 * Opaque filter-specific private data. If filter->priv_class is non-NULL,
5929 * this is an AVOptions-enabled struct.
5934 * Parameters of the input stream. This field is allocated in
5935 * av_bsf_alloc(), it needs to be filled by the caller before
5938 AVCodecParameters *par_in;
5941 * Parameters of the output stream. This field is allocated in
5942 * av_bsf_alloc(), it is set by the filter in av_bsf_init().
5944 AVCodecParameters *par_out;
5947 * The timebase used for the timestamps of the input packets. Set by the
5948 * caller before av_bsf_init().
5950 AVRational time_base_in;
5953 * The timebase used for the timestamps of the output packets. Set by the
5954 * filter in av_bsf_init().
5956 AVRational time_base_out;
5959 typedef struct AVBitStreamFilter {
5963 * A list of codec ids supported by the filter, terminated by
5965 * May be NULL, in that case the bitstream filter works with any codec id.
5967 const enum AVCodecID *codec_ids;
5970 * A class for the private data, used to declare bitstream filter private
5971 * AVOptions. This field is NULL for bitstream filters that do not declare
5974 * If this field is non-NULL, the first member of the filter private data
5975 * must be a pointer to AVClass, which will be set by libavcodec generic
5976 * code to this class.
5978 const AVClass *priv_class;
5980 /*****************************************************************
5981 * No fields below this line are part of the public API. They
5982 * may not be used outside of libavcodec and can be changed and
5984 * New public fields should be added right above.
5985 *****************************************************************
5989 int (*init)(AVBSFContext *ctx);
5990 int (*filter)(AVBSFContext *ctx, AVPacket *pkt);
5991 void (*close)(AVBSFContext *ctx);
5992 } AVBitStreamFilter;
5996 * Register a bitstream filter.
5998 * The filter will be accessible to the application code through
5999 * av_bitstream_filter_next() or can be directly initialized with
6000 * av_bitstream_filter_init().
6002 * @see avcodec_register_all()
6004 attribute_deprecated
6005 void av_register_bitstream_filter(AVBitStreamFilter *bsf);
6008 * Create and initialize a bitstream filter context given a bitstream
6011 * The returned context must be freed with av_bitstream_filter_close().
6013 * @param name the name of the bitstream filter
6014 * @return a bitstream filter context if a matching filter was found
6015 * and successfully initialized, NULL otherwise
6017 attribute_deprecated
6018 AVBitStreamFilterContext *av_bitstream_filter_init(const char *name);
6023 * This function filters the buffer buf with size buf_size, and places the
6024 * filtered buffer in the buffer pointed to by poutbuf.
6026 * The output buffer must be freed by the caller.
6028 * @param bsfc bitstream filter context created by av_bitstream_filter_init()
6029 * @param avctx AVCodecContext accessed by the filter, may be NULL.
6030 * If specified, this must point to the encoder context of the
6031 * output stream the packet is sent to.
6032 * @param args arguments which specify the filter configuration, may be NULL
6033 * @param poutbuf pointer which is updated to point to the filtered buffer
6034 * @param poutbuf_size pointer which is updated to the filtered buffer size in bytes
6035 * @param buf buffer containing the data to filter
6036 * @param buf_size size in bytes of buf
6037 * @param keyframe set to non-zero if the buffer to filter corresponds to a key-frame packet data
6038 * @return >= 0 in case of success, or a negative error code in case of failure
6040 * If the return value is positive, an output buffer is allocated and
6041 * is available in *poutbuf, and is distinct from the input buffer.
6043 * If the return value is 0, the output buffer is not allocated and
6044 * should be considered identical to the input buffer, or in case
6045 * *poutbuf was set it points to the input buffer (not necessarily to
6046 * its starting address). A special case is if *poutbuf was set to NULL and
6047 * *poutbuf_size was set to 0, which indicates the packet should be dropped.
6049 attribute_deprecated
6050 int av_bitstream_filter_filter(AVBitStreamFilterContext *bsfc,
6051 AVCodecContext *avctx, const char *args,
6052 uint8_t **poutbuf, int *poutbuf_size,
6053 const uint8_t *buf, int buf_size, int keyframe);
6056 * Release bitstream filter context.
6058 * @param bsf the bitstream filter context created with
6059 * av_bitstream_filter_init(), can be NULL
6061 attribute_deprecated
6062 void av_bitstream_filter_close(AVBitStreamFilterContext *bsf);
6065 * If f is NULL, return the first registered bitstream filter,
6066 * if f is non-NULL, return the next registered bitstream filter
6067 * after f, or NULL if f is the last one.
6069 * This function can be used to iterate over all registered bitstream
6072 attribute_deprecated
6073 AVBitStreamFilter *av_bitstream_filter_next(const AVBitStreamFilter *f);
6077 * @return a bitstream filter with the specified name or NULL if no such
6078 * bitstream filter exists.
6080 const AVBitStreamFilter *av_bsf_get_by_name(const char *name);
6083 * Iterate over all registered bitstream filters.
6085 * @param opaque a pointer where libavcodec will store the iteration state. Must
6086 * point to NULL to start the iteration.
6088 * @return the next registered bitstream filter or NULL when the iteration is
6091 const AVBitStreamFilter *av_bsf_next(void **opaque);
6094 * Allocate a context for a given bitstream filter. The caller must fill in the
6095 * context parameters as described in the documentation and then call
6096 * av_bsf_init() before sending any data to the filter.
6098 * @param filter the filter for which to allocate an instance.
6099 * @param ctx a pointer into which the pointer to the newly-allocated context
6100 * will be written. It must be freed with av_bsf_free() after the
6101 * filtering is done.
6103 * @return 0 on success, a negative AVERROR code on failure
6105 int av_bsf_alloc(const AVBitStreamFilter *filter, AVBSFContext **ctx);
6108 * Prepare the filter for use, after all the parameters and options have been
6111 int av_bsf_init(AVBSFContext *ctx);
6114 * Submit a packet for filtering.
6116 * After sending each packet, the filter must be completely drained by calling
6117 * av_bsf_receive_packet() repeatedly until it returns AVERROR(EAGAIN) or
6120 * @param pkt the packet to filter. The bitstream filter will take ownership of
6121 * the packet and reset the contents of pkt. pkt is not touched if an error occurs.
6122 * This parameter may be NULL, which signals the end of the stream (i.e. no more
6123 * packets will be sent). That will cause the filter to output any packets it
6124 * may have buffered internally.
6126 * @return 0 on success, a negative AVERROR on error.
6128 int av_bsf_send_packet(AVBSFContext *ctx, AVPacket *pkt);
6131 * Retrieve a filtered packet.
6133 * @param[out] pkt this struct will be filled with the contents of the filtered
6134 * packet. It is owned by the caller and must be freed using
6135 * av_packet_unref() when it is no longer needed.
6136 * This parameter should be "clean" (i.e. freshly allocated
6137 * with av_packet_alloc() or unreffed with av_packet_unref())
6138 * when this function is called. If this function returns
6139 * successfully, the contents of pkt will be completely
6140 * overwritten by the returned data. On failure, pkt is not
6143 * @return 0 on success. AVERROR(EAGAIN) if more packets need to be sent to the
6144 * filter (using av_bsf_send_packet()) to get more output. AVERROR_EOF if there
6145 * will be no further output from the filter. Another negative AVERROR value if
6148 * @note one input packet may result in several output packets, so after sending
6149 * a packet with av_bsf_send_packet(), this function needs to be called
6150 * repeatedly until it stops returning 0. It is also possible for a filter to
6151 * output fewer packets than were sent to it, so this function may return
6152 * AVERROR(EAGAIN) immediately after a successful av_bsf_send_packet() call.
6154 int av_bsf_receive_packet(AVBSFContext *ctx, AVPacket *pkt);
6157 * Free a bitstream filter context and everything associated with it; write NULL
6158 * into the supplied pointer.
6160 void av_bsf_free(AVBSFContext **ctx);
6163 * Get the AVClass for AVBSFContext. It can be used in combination with
6164 * AV_OPT_SEARCH_FAKE_OBJ for examining options.
6166 * @see av_opt_find().
6168 const AVClass *av_bsf_get_class(void);
6171 * Structure for chain/list of bitstream filters.
6172 * Empty list can be allocated by av_bsf_list_alloc().
6174 typedef struct AVBSFList AVBSFList;
6177 * Allocate empty list of bitstream filters.
6178 * The list must be later freed by av_bsf_list_free()
6179 * or finalized by av_bsf_list_finalize().
6181 * @return Pointer to @ref AVBSFList on success, NULL in case of failure
6183 AVBSFList *av_bsf_list_alloc(void);
6186 * Free list of bitstream filters.
6188 * @param lst Pointer to pointer returned by av_bsf_list_alloc()
6190 void av_bsf_list_free(AVBSFList **lst);
6193 * Append bitstream filter to the list of bitstream filters.
6195 * @param lst List to append to
6196 * @param bsf Filter context to be appended
6198 * @return >=0 on success, negative AVERROR in case of failure
6200 int av_bsf_list_append(AVBSFList *lst, AVBSFContext *bsf);
6203 * Construct new bitstream filter context given it's name and options
6204 * and append it to the list of bitstream filters.
6206 * @param lst List to append to
6207 * @param bsf_name Name of the bitstream filter
6208 * @param options Options for the bitstream filter, can be set to NULL
6210 * @return >=0 on success, negative AVERROR in case of failure
6212 int av_bsf_list_append2(AVBSFList *lst, const char * bsf_name, AVDictionary **options);
6214 * Finalize list of bitstream filters.
6216 * This function will transform @ref AVBSFList to single @ref AVBSFContext,
6217 * so the whole chain of bitstream filters can be treated as single filter
6218 * freshly allocated by av_bsf_alloc().
6219 * If the call is successful, @ref AVBSFList structure is freed and lst
6220 * will be set to NULL. In case of failure, caller is responsible for
6221 * freeing the structure by av_bsf_list_free()
6223 * @param lst Filter list structure to be transformed
6224 * @param[out] bsf Pointer to be set to newly created @ref AVBSFContext structure
6225 * representing the chain of bitstream filters
6227 * @return >=0 on success, negative AVERROR in case of failure
6229 int av_bsf_list_finalize(AVBSFList **lst, AVBSFContext **bsf);
6232 * Parse string describing list of bitstream filters and create single
6233 * @ref AVBSFContext describing the whole chain of bitstream filters.
6234 * Resulting @ref AVBSFContext can be treated as any other @ref AVBSFContext freshly
6235 * allocated by av_bsf_alloc().
6237 * @param str String describing chain of bitstream filters in format
6238 * `bsf1[=opt1=val1:opt2=val2][,bsf2]`
6239 * @param[out] bsf Pointer to be set to newly created @ref AVBSFContext structure
6240 * representing the chain of bitstream filters
6242 * @return >=0 on success, negative AVERROR in case of failure
6244 int av_bsf_list_parse_str(const char *str, AVBSFContext **bsf);
6247 * Get null/pass-through bitstream filter.
6249 * @param[out] bsf Pointer to be set to new instance of pass-through bitstream filter
6253 int av_bsf_get_null_filter(AVBSFContext **bsf);
6258 * Same behaviour av_fast_malloc but the buffer has additional
6259 * AV_INPUT_BUFFER_PADDING_SIZE at the end which will always be 0.
6261 * In addition the whole buffer will initially and after resizes
6262 * be 0-initialized so that no uninitialized data will ever appear.
6264 void av_fast_padded_malloc(void *ptr, unsigned int *size, size_t min_size);
6267 * Same behaviour av_fast_padded_malloc except that buffer will always
6268 * be 0-initialized after call.
6270 void av_fast_padded_mallocz(void *ptr, unsigned int *size, size_t min_size);
6273 * Encode extradata length to a buffer. Used by xiph codecs.
6275 * @param s buffer to write to; must be at least (v/255+1) bytes long
6276 * @param v size of extradata in bytes
6277 * @return number of bytes written to the buffer.
6279 unsigned int av_xiphlacing(unsigned char *s, unsigned int v);
6281 #if FF_API_MISSING_SAMPLE
6283 * Log a generic warning message about a missing feature. This function is
6284 * intended to be used internally by FFmpeg (libavcodec, libavformat, etc.)
6285 * only, and would normally not be used by applications.
6286 * @param[in] avc a pointer to an arbitrary struct of which the first field is
6287 * a pointer to an AVClass struct
6288 * @param[in] feature string containing the name of the missing feature
6289 * @param[in] want_sample indicates if samples are wanted which exhibit this feature.
6290 * If want_sample is non-zero, additional verbiage will be added to the log
6291 * message which tells the user how to report samples to the development
6293 * @deprecated Use avpriv_report_missing_feature() instead.
6295 attribute_deprecated
6296 void av_log_missing_feature(void *avc, const char *feature, int want_sample);
6299 * Log a generic warning message asking for a sample. This function is
6300 * intended to be used internally by FFmpeg (libavcodec, libavformat, etc.)
6301 * only, and would normally not be used by applications.
6302 * @param[in] avc a pointer to an arbitrary struct of which the first field is
6303 * a pointer to an AVClass struct
6304 * @param[in] msg string containing an optional message, or NULL if no message
6305 * @deprecated Use avpriv_request_sample() instead.
6307 attribute_deprecated
6308 void av_log_ask_for_sample(void *avc, const char *msg, ...) av_printf_format(2, 3);
6309 #endif /* FF_API_MISSING_SAMPLE */
6312 * Register the hardware accelerator hwaccel.
6314 void av_register_hwaccel(AVHWAccel *hwaccel);
6317 * If hwaccel is NULL, returns the first registered hardware accelerator,
6318 * if hwaccel is non-NULL, returns the next registered hardware accelerator
6319 * after hwaccel, or NULL if hwaccel is the last one.
6321 AVHWAccel *av_hwaccel_next(const AVHWAccel *hwaccel);
6325 * Lock operation used by lockmgr
6328 AV_LOCK_CREATE, ///< Create a mutex
6329 AV_LOCK_OBTAIN, ///< Lock the mutex
6330 AV_LOCK_RELEASE, ///< Unlock the mutex
6331 AV_LOCK_DESTROY, ///< Free mutex resources
6335 * Register a user provided lock manager supporting the operations
6336 * specified by AVLockOp. The "mutex" argument to the function points
6337 * to a (void *) where the lockmgr should store/get a pointer to a user
6338 * allocated mutex. It is NULL upon AV_LOCK_CREATE and equal to the
6339 * value left by the last call for all other ops. If the lock manager is
6340 * unable to perform the op then it should leave the mutex in the same
6341 * state as when it was called and return a non-zero value. However,
6342 * when called with AV_LOCK_DESTROY the mutex will always be assumed to
6343 * have been successfully destroyed. If av_lockmgr_register succeeds
6344 * it will return a non-negative value, if it fails it will return a
6345 * negative value and destroy all mutex and unregister all callbacks.
6346 * av_lockmgr_register is not thread-safe, it must be called from a
6347 * single thread before any calls which make use of locking are used.
6349 * @param cb User defined callback. av_lockmgr_register invokes calls
6350 * to this callback and the previously registered callback.
6351 * The callback will be used to create more than one mutex
6352 * each of which must be backed by its own underlying locking
6353 * mechanism (i.e. do not use a single static object to
6354 * implement your lock manager). If cb is set to NULL the
6355 * lockmgr will be unregistered.
6357 int av_lockmgr_register(int (*cb)(void **mutex, enum AVLockOp op));
6360 * Get the type of the given codec.
6362 enum AVMediaType avcodec_get_type(enum AVCodecID codec_id);
6365 * Get the name of a codec.
6366 * @return a static string identifying the codec; never NULL
6368 const char *avcodec_get_name(enum AVCodecID id);
6371 * @return a positive value if s is open (i.e. avcodec_open2() was called on it
6372 * with no corresponding avcodec_close()), 0 otherwise.
6374 int avcodec_is_open(AVCodecContext *s);
6377 * @return a non-zero number if codec is an encoder, zero otherwise
6379 int av_codec_is_encoder(const AVCodec *codec);
6382 * @return a non-zero number if codec is a decoder, zero otherwise
6384 int av_codec_is_decoder(const AVCodec *codec);
6387 * @return descriptor for given codec ID or NULL if no descriptor exists.
6389 const AVCodecDescriptor *avcodec_descriptor_get(enum AVCodecID id);
6392 * Iterate over all codec descriptors known to libavcodec.
6394 * @param prev previous descriptor. NULL to get the first descriptor.
6396 * @return next descriptor or NULL after the last descriptor
6398 const AVCodecDescriptor *avcodec_descriptor_next(const AVCodecDescriptor *prev);
6401 * @return codec descriptor with the given name or NULL if no such descriptor
6404 const AVCodecDescriptor *avcodec_descriptor_get_by_name(const char *name);
6407 * Allocate a CPB properties structure and initialize its fields to default
6410 * @param size if non-NULL, the size of the allocated struct will be written
6411 * here. This is useful for embedding it in side data.
6413 * @return the newly allocated struct or NULL on failure
6415 AVCPBProperties *av_cpb_properties_alloc(size_t *size);
6421 #endif /* AVCODEC_AVCODEC_H */