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. In
146 * general, no codec will permit unlimited buffering of input or output.
148 * This API replaces the following legacy functions:
149 * - avcodec_decode_video2() and avcodec_decode_audio4():
150 * Use avcodec_send_packet() to feed input to the decoder, then use
151 * avcodec_receive_frame() to receive decoded frames after each packet.
152 * Unlike with the old video decoding API, multiple frames might result from
153 * a packet. For audio, splitting the input packet into frames by partially
154 * decoding packets becomes transparent to the API user. You never need to
155 * feed an AVPacket to the API twice (unless it is rejected with EAGAIN - then
156 * no data was read from the packet).
157 * Additionally, sending a flush/draining packet is required only once.
158 * - avcodec_encode_video2()/avcodec_encode_audio2():
159 * Use avcodec_send_frame() to feed input to the encoder, then use
160 * avcodec_receive_packet() to receive encoded packets.
161 * Providing user-allocated buffers for avcodec_receive_packet() is not
163 * - The new API does not handle subtitles yet.
165 * Mixing new and old function calls on the same AVCodecContext is not allowed,
166 * and will result in undefined behavior.
168 * Some codecs might require using the new API; using the old API will return
169 * an error when calling it. All codecs support the new API.
171 * A codec is not allowed to return EAGAIN for both sending and receiving. This
172 * would be an invalid state, which could put the codec user into an endless
173 * loop. The API has no concept of time either: it cannot happen that trying to
174 * do avcodec_send_packet() results in EAGAIN, but a repeated call 1 second
175 * later accepts the packet (with no other receive/flush API calls involved).
176 * The API is a strict state machine, and the passage of time is not supposed
177 * to influence it. Some timing-dependent behavior might still be deemed
178 * acceptable in certain cases. But it must never result in both send/receive
179 * returning EAGAIN at the same time at any point. It must also absolutely be
180 * avoided that the current state is "unstable" and can "flip-flop" between
181 * the send/receive APIs allowing progress. For example, it's not allowed that
182 * the codec randomly decides that it actually wants to consume a packet now
183 * instead of returning a frame, after it just returned EAGAIN on an
184 * avcodec_send_packet() call.
189 * @defgroup lavc_core Core functions/structures.
192 * Basic definitions, functions for querying libavcodec capabilities,
193 * allocating core structures, etc.
199 * Identify the syntax and semantics of the bitstream.
200 * The principle is roughly:
201 * Two decoders with the same ID can decode the same streams.
202 * Two encoders with the same ID can encode compatible streams.
203 * There may be slight deviations from the principle due to implementation
206 * If you add a codec ID to this list, add it so that
207 * 1. no value of an existing codec ID changes (that would break ABI),
208 * 2. it is as close as possible to similar codecs
210 * After adding new codec IDs, do not forget to add an entry to the codec
211 * descriptor list and bump libavcodec minor version.
217 AV_CODEC_ID_MPEG1VIDEO,
218 AV_CODEC_ID_MPEG2VIDEO, ///< preferred ID for MPEG-1/2 video decoding
220 AV_CODEC_ID_MPEG2VIDEO_XVMC,
221 #endif /* FF_API_XVMC */
232 AV_CODEC_ID_RAWVIDEO,
233 AV_CODEC_ID_MSMPEG4V1,
234 AV_CODEC_ID_MSMPEG4V2,
235 AV_CODEC_ID_MSMPEG4V3,
258 AV_CODEC_ID_INTERPLAY_VIDEO,
265 AV_CODEC_ID_MSVIDEO1,
270 AV_CODEC_ID_TRUEMOTION1,
271 AV_CODEC_ID_VMDVIDEO,
296 AV_CODEC_ID_TRUEMOTION2,
302 AV_CODEC_ID_SMACKVIDEO,
307 AV_CODEC_ID_JPEG2000,
313 AV_CODEC_ID_DSICINVIDEO,
314 AV_CODEC_ID_TIERTEXSEQVIDEO,
322 AV_CODEC_ID_BETHSOFTVID,
334 AV_CODEC_ID_ESCAPE124,
338 AV_CODEC_ID_MOTIONPIXELS,
350 AV_CODEC_ID_FLASHSV2,
351 AV_CODEC_ID_CDGRAPHICS,
354 AV_CODEC_ID_BINKVIDEO,
355 AV_CODEC_ID_IFF_ILBM,
356 #define AV_CODEC_ID_IFF_BYTERUN1 AV_CODEC_ID_IFF_ILBM
362 AV_CODEC_ID_A64_MULTI,
363 AV_CODEC_ID_A64_MULTI5,
366 AV_CODEC_ID_LAGARITH,
370 AV_CODEC_ID_WMV3IMAGE,
371 AV_CODEC_ID_VC1IMAGE,
373 AV_CODEC_ID_BMV_VIDEO,
380 AV_CODEC_ID_ZEROCODEC,
389 AV_CODEC_ID_ESCAPE130,
392 AV_CODEC_ID_HNM4_VIDEO,
394 #define AV_CODEC_ID_H265 AV_CODEC_ID_HEVC
396 AV_CODEC_ID_ALIAS_PIX,
397 AV_CODEC_ID_BRENDER_PIX,
398 AV_CODEC_ID_PAF_VIDEO,
411 AV_CODEC_ID_SCREENPRESSO,
414 AV_CODEC_ID_Y41P = 0x8000,
419 AV_CODEC_ID_TARGA_Y216,
431 AV_CODEC_ID_TRUEMOTION2RT,
433 AV_CODEC_ID_MAGICYUV,
434 AV_CODEC_ID_SHEERVIDEO,
441 AV_CODEC_ID_CLEARVIDEO,
443 /* various PCM "codecs" */
444 AV_CODEC_ID_FIRST_AUDIO = 0x10000, ///< A dummy id pointing at the start of audio codecs
445 AV_CODEC_ID_PCM_S16LE = 0x10000,
446 AV_CODEC_ID_PCM_S16BE,
447 AV_CODEC_ID_PCM_U16LE,
448 AV_CODEC_ID_PCM_U16BE,
451 AV_CODEC_ID_PCM_MULAW,
452 AV_CODEC_ID_PCM_ALAW,
453 AV_CODEC_ID_PCM_S32LE,
454 AV_CODEC_ID_PCM_S32BE,
455 AV_CODEC_ID_PCM_U32LE,
456 AV_CODEC_ID_PCM_U32BE,
457 AV_CODEC_ID_PCM_S24LE,
458 AV_CODEC_ID_PCM_S24BE,
459 AV_CODEC_ID_PCM_U24LE,
460 AV_CODEC_ID_PCM_U24BE,
461 AV_CODEC_ID_PCM_S24DAUD,
462 AV_CODEC_ID_PCM_ZORK,
463 AV_CODEC_ID_PCM_S16LE_PLANAR,
465 AV_CODEC_ID_PCM_F32BE,
466 AV_CODEC_ID_PCM_F32LE,
467 AV_CODEC_ID_PCM_F64BE,
468 AV_CODEC_ID_PCM_F64LE,
469 AV_CODEC_ID_PCM_BLURAY,
472 AV_CODEC_ID_PCM_S8_PLANAR,
473 AV_CODEC_ID_PCM_S24LE_PLANAR,
474 AV_CODEC_ID_PCM_S32LE_PLANAR,
475 AV_CODEC_ID_PCM_S16BE_PLANAR,
477 AV_CODEC_ID_PCM_S64LE = 0x10800,
478 AV_CODEC_ID_PCM_S64BE,
479 AV_CODEC_ID_PCM_F16LE,
480 AV_CODEC_ID_PCM_F24LE,
482 /* various ADPCM codecs */
483 AV_CODEC_ID_ADPCM_IMA_QT = 0x11000,
484 AV_CODEC_ID_ADPCM_IMA_WAV,
485 AV_CODEC_ID_ADPCM_IMA_DK3,
486 AV_CODEC_ID_ADPCM_IMA_DK4,
487 AV_CODEC_ID_ADPCM_IMA_WS,
488 AV_CODEC_ID_ADPCM_IMA_SMJPEG,
489 AV_CODEC_ID_ADPCM_MS,
490 AV_CODEC_ID_ADPCM_4XM,
491 AV_CODEC_ID_ADPCM_XA,
492 AV_CODEC_ID_ADPCM_ADX,
493 AV_CODEC_ID_ADPCM_EA,
494 AV_CODEC_ID_ADPCM_G726,
495 AV_CODEC_ID_ADPCM_CT,
496 AV_CODEC_ID_ADPCM_SWF,
497 AV_CODEC_ID_ADPCM_YAMAHA,
498 AV_CODEC_ID_ADPCM_SBPRO_4,
499 AV_CODEC_ID_ADPCM_SBPRO_3,
500 AV_CODEC_ID_ADPCM_SBPRO_2,
501 AV_CODEC_ID_ADPCM_THP,
502 AV_CODEC_ID_ADPCM_IMA_AMV,
503 AV_CODEC_ID_ADPCM_EA_R1,
504 AV_CODEC_ID_ADPCM_EA_R3,
505 AV_CODEC_ID_ADPCM_EA_R2,
506 AV_CODEC_ID_ADPCM_IMA_EA_SEAD,
507 AV_CODEC_ID_ADPCM_IMA_EA_EACS,
508 AV_CODEC_ID_ADPCM_EA_XAS,
509 AV_CODEC_ID_ADPCM_EA_MAXIS_XA,
510 AV_CODEC_ID_ADPCM_IMA_ISS,
511 AV_CODEC_ID_ADPCM_G722,
512 AV_CODEC_ID_ADPCM_IMA_APC,
513 AV_CODEC_ID_ADPCM_VIMA,
514 #if FF_API_VIMA_DECODER
515 AV_CODEC_ID_VIMA = AV_CODEC_ID_ADPCM_VIMA,
518 AV_CODEC_ID_ADPCM_AFC = 0x11800,
519 AV_CODEC_ID_ADPCM_IMA_OKI,
520 AV_CODEC_ID_ADPCM_DTK,
521 AV_CODEC_ID_ADPCM_IMA_RAD,
522 AV_CODEC_ID_ADPCM_G726LE,
523 AV_CODEC_ID_ADPCM_THP_LE,
524 AV_CODEC_ID_ADPCM_PSX,
525 AV_CODEC_ID_ADPCM_AICA,
526 AV_CODEC_ID_ADPCM_IMA_DAT4,
527 AV_CODEC_ID_ADPCM_MTAF,
530 AV_CODEC_ID_AMR_NB = 0x12000,
533 /* RealAudio codecs*/
534 AV_CODEC_ID_RA_144 = 0x13000,
537 /* various DPCM codecs */
538 AV_CODEC_ID_ROQ_DPCM = 0x14000,
539 AV_CODEC_ID_INTERPLAY_DPCM,
540 AV_CODEC_ID_XAN_DPCM,
541 AV_CODEC_ID_SOL_DPCM,
543 AV_CODEC_ID_SDX2_DPCM = 0x14800,
546 AV_CODEC_ID_MP2 = 0x15000,
547 AV_CODEC_ID_MP3, ///< preferred ID for decoding MPEG audio layer 1, 2 or 3
557 AV_CODEC_ID_VMDAUDIO,
563 AV_CODEC_ID_WESTWOOD_SND1,
564 AV_CODEC_ID_GSM, ///< as in Berlin toast format
567 AV_CODEC_ID_TRUESPEECH,
569 AV_CODEC_ID_SMACKAUDIO,
572 AV_CODEC_ID_DSICINAUDIO,
574 AV_CODEC_ID_MUSEPACK7,
576 AV_CODEC_ID_GSM_MS, /* as found in WAV */
582 AV_CODEC_ID_NELLYMOSER,
583 AV_CODEC_ID_MUSEPACK8,
585 AV_CODEC_ID_WMAVOICE,
587 AV_CODEC_ID_WMALOSSLESS,
596 AV_CODEC_ID_BINKAUDIO_RDFT,
597 AV_CODEC_ID_BINKAUDIO_DCT,
598 AV_CODEC_ID_AAC_LATM,
603 AV_CODEC_ID_8SVX_EXP,
604 AV_CODEC_ID_8SVX_FIB,
605 AV_CODEC_ID_BMV_AUDIO,
610 AV_CODEC_ID_COMFORT_NOISE,
612 AV_CODEC_ID_METASOUND,
613 AV_CODEC_ID_PAF_AUDIO,
617 AV_CODEC_ID_FFWAVESYNTH = 0x15800,
619 AV_CODEC_ID_SONIC_LS,
622 AV_CODEC_ID_DSD_LSBF,
623 AV_CODEC_ID_DSD_MSBF,
624 AV_CODEC_ID_DSD_LSBF_PLANAR,
625 AV_CODEC_ID_DSD_MSBF_PLANAR,
627 AV_CODEC_ID_INTERPLAY_ACM,
631 AV_CODEC_ID_ATRAC3AL,
632 AV_CODEC_ID_ATRAC3PAL,
634 /* subtitle codecs */
635 AV_CODEC_ID_FIRST_SUBTITLE = 0x17000, ///< A dummy ID pointing at the start of subtitle codecs.
636 AV_CODEC_ID_DVD_SUBTITLE = 0x17000,
637 AV_CODEC_ID_DVB_SUBTITLE,
638 AV_CODEC_ID_TEXT, ///< raw UTF-8 text
641 AV_CODEC_ID_MOV_TEXT,
642 AV_CODEC_ID_HDMV_PGS_SUBTITLE,
643 AV_CODEC_ID_DVB_TELETEXT,
646 AV_CODEC_ID_MICRODVD = 0x17800,
650 AV_CODEC_ID_REALTEXT,
652 AV_CODEC_ID_SUBVIEWER1,
653 AV_CODEC_ID_SUBVIEWER,
660 AV_CODEC_ID_HDMV_TEXT_SUBTITLE,
662 /* other specific kind of codecs (generally used for attachments) */
663 AV_CODEC_ID_FIRST_UNKNOWN = 0x18000, ///< A dummy ID pointing at the start of various fake codecs.
664 AV_CODEC_ID_TTF = 0x18000,
666 AV_CODEC_ID_SCTE_35, ///< Contain timestamp estimated through PCR of program stream.
667 AV_CODEC_ID_BINTEXT = 0x18800,
671 AV_CODEC_ID_SMPTE_KLV,
673 AV_CODEC_ID_TIMED_ID3,
674 AV_CODEC_ID_BIN_DATA,
677 AV_CODEC_ID_PROBE = 0x19000, ///< codec_id is not known (like AV_CODEC_ID_NONE) but lavf should attempt to identify it
679 AV_CODEC_ID_MPEG2TS = 0x20000, /**< _FAKE_ codec to indicate a raw MPEG-2 TS
680 * stream (only used by libavformat) */
681 AV_CODEC_ID_MPEG4SYSTEMS = 0x20001, /**< _FAKE_ codec to indicate a MPEG-4 Systems
682 * stream (only used by libavformat) */
683 AV_CODEC_ID_FFMETADATA = 0x21000, ///< Dummy codec for streams containing only metadata information.
684 AV_CODEC_ID_WRAPPED_AVFRAME = 0x21001, ///< Passthrough codec, AVFrames wrapped in AVPacket
688 * This struct describes the properties of a single codec described by an
690 * @see avcodec_descriptor_get()
692 typedef struct AVCodecDescriptor {
694 enum AVMediaType type;
696 * Name of the codec described by this descriptor. It is non-empty and
697 * unique for each codec descriptor. It should contain alphanumeric
698 * characters and '_' only.
702 * A more descriptive name for this codec. May be NULL.
704 const char *long_name;
706 * Codec properties, a combination of AV_CODEC_PROP_* flags.
710 * MIME type(s) associated with the codec.
711 * May be NULL; if not, a NULL-terminated array of MIME types.
712 * The first item is always non-NULL and is the preferred MIME type.
714 const char *const *mime_types;
716 * If non-NULL, an array of profiles recognized for this codec.
717 * Terminated with FF_PROFILE_UNKNOWN.
719 const struct AVProfile *profiles;
723 * Codec uses only intra compression.
726 #define AV_CODEC_PROP_INTRA_ONLY (1 << 0)
728 * Codec supports lossy compression. Audio and video codecs only.
729 * @note a codec may support both lossy and lossless
732 #define AV_CODEC_PROP_LOSSY (1 << 1)
734 * Codec supports lossless compression. Audio and video codecs only.
736 #define AV_CODEC_PROP_LOSSLESS (1 << 2)
738 * Codec supports frame reordering. That is, the coded order (the order in which
739 * the encoded packets are output by the encoders / stored / input to the
740 * decoders) may be different from the presentation order of the corresponding
743 * For codecs that do not have this property set, PTS and DTS should always be
746 #define AV_CODEC_PROP_REORDER (1 << 3)
748 * Subtitle codec is bitmap based
749 * Decoded AVSubtitle data can be read from the AVSubtitleRect->pict field.
751 #define AV_CODEC_PROP_BITMAP_SUB (1 << 16)
753 * Subtitle codec is text based.
754 * Decoded AVSubtitle data can be read from the AVSubtitleRect->ass field.
756 #define AV_CODEC_PROP_TEXT_SUB (1 << 17)
759 * @ingroup lavc_decoding
760 * Required number of additionally allocated bytes at the end of the input bitstream for decoding.
761 * This is mainly needed because some optimized bitstream readers read
762 * 32 or 64 bit at once and could read over the end.<br>
763 * Note: If the first 23 bits of the additional bytes are not 0, then damaged
764 * MPEG bitstreams could cause overread and segfault.
766 #define AV_INPUT_BUFFER_PADDING_SIZE 32
769 * @ingroup lavc_encoding
770 * minimum encoding buffer size
771 * Used to avoid some checks during header writing.
773 #define AV_INPUT_BUFFER_MIN_SIZE 16384
775 #if FF_API_WITHOUT_PREFIX
777 * @deprecated use AV_INPUT_BUFFER_PADDING_SIZE instead
779 #define FF_INPUT_BUFFER_PADDING_SIZE 32
782 * @deprecated use AV_INPUT_BUFFER_MIN_SIZE instead
784 #define FF_MIN_BUFFER_SIZE 16384
785 #endif /* FF_API_WITHOUT_PREFIX */
788 * @ingroup lavc_encoding
789 * motion estimation type.
790 * @deprecated use codec private option instead
792 #if FF_API_MOTION_EST
794 ME_ZERO = 1, ///< no search, that is use 0,0 vector whenever one is needed
798 ME_EPZS, ///< enhanced predictive zonal search
799 ME_X1, ///< reserved for experiments
800 ME_HEX, ///< hexagon based search
801 ME_UMH, ///< uneven multi-hexagon search
802 ME_TESA, ///< transformed exhaustive search algorithm
803 ME_ITER=50, ///< iterative search
808 * @ingroup lavc_decoding
811 /* We leave some space between them for extensions (drop some
812 * keyframes for intra-only or drop just some bidir frames). */
813 AVDISCARD_NONE =-16, ///< discard nothing
814 AVDISCARD_DEFAULT = 0, ///< discard useless packets like 0 size packets in avi
815 AVDISCARD_NONREF = 8, ///< discard all non reference
816 AVDISCARD_BIDIR = 16, ///< discard all bidirectional frames
817 AVDISCARD_NONINTRA= 24, ///< discard all non intra frames
818 AVDISCARD_NONKEY = 32, ///< discard all frames except keyframes
819 AVDISCARD_ALL = 48, ///< discard all
822 enum AVAudioServiceType {
823 AV_AUDIO_SERVICE_TYPE_MAIN = 0,
824 AV_AUDIO_SERVICE_TYPE_EFFECTS = 1,
825 AV_AUDIO_SERVICE_TYPE_VISUALLY_IMPAIRED = 2,
826 AV_AUDIO_SERVICE_TYPE_HEARING_IMPAIRED = 3,
827 AV_AUDIO_SERVICE_TYPE_DIALOGUE = 4,
828 AV_AUDIO_SERVICE_TYPE_COMMENTARY = 5,
829 AV_AUDIO_SERVICE_TYPE_EMERGENCY = 6,
830 AV_AUDIO_SERVICE_TYPE_VOICE_OVER = 7,
831 AV_AUDIO_SERVICE_TYPE_KARAOKE = 8,
832 AV_AUDIO_SERVICE_TYPE_NB , ///< Not part of ABI
836 * @ingroup lavc_encoding
838 typedef struct RcOverride{
841 int qscale; // If this is 0 then quality_factor will be used instead.
842 float quality_factor;
845 #if FF_API_MAX_BFRAMES
847 * @deprecated there is no libavcodec-wide limit on the number of B-frames
849 #define FF_MAX_B_FRAMES 16
853 These flags can be passed in AVCodecContext.flags before initialization.
854 Note: Not everything is supported yet.
858 * Allow decoders to produce frames with data planes that are not aligned
859 * to CPU requirements (e.g. due to cropping).
861 #define AV_CODEC_FLAG_UNALIGNED (1 << 0)
865 #define AV_CODEC_FLAG_QSCALE (1 << 1)
867 * 4 MV per MB allowed / advanced prediction for H.263.
869 #define AV_CODEC_FLAG_4MV (1 << 2)
871 * Output even those frames that might be corrupted.
873 #define AV_CODEC_FLAG_OUTPUT_CORRUPT (1 << 3)
877 #define AV_CODEC_FLAG_QPEL (1 << 4)
879 * Use internal 2pass ratecontrol in first pass mode.
881 #define AV_CODEC_FLAG_PASS1 (1 << 9)
883 * Use internal 2pass ratecontrol in second pass mode.
885 #define AV_CODEC_FLAG_PASS2 (1 << 10)
889 #define AV_CODEC_FLAG_LOOP_FILTER (1 << 11)
891 * Only decode/encode grayscale.
893 #define AV_CODEC_FLAG_GRAY (1 << 13)
895 * error[?] variables will be set during encoding.
897 #define AV_CODEC_FLAG_PSNR (1 << 15)
899 * Input bitstream might be truncated at a random location
900 * instead of only at frame boundaries.
902 #define AV_CODEC_FLAG_TRUNCATED (1 << 16)
904 * Use interlaced DCT.
906 #define AV_CODEC_FLAG_INTERLACED_DCT (1 << 18)
910 #define AV_CODEC_FLAG_LOW_DELAY (1 << 19)
912 * Place global headers in extradata instead of every keyframe.
914 #define AV_CODEC_FLAG_GLOBAL_HEADER (1 << 22)
916 * Use only bitexact stuff (except (I)DCT).
918 #define AV_CODEC_FLAG_BITEXACT (1 << 23)
919 /* Fx : Flag for H.263+ extra options */
921 * H.263 advanced intra coding / MPEG-4 AC prediction
923 #define AV_CODEC_FLAG_AC_PRED (1 << 24)
925 * interlaced motion estimation
927 #define AV_CODEC_FLAG_INTERLACED_ME (1 << 29)
928 #define AV_CODEC_FLAG_CLOSED_GOP (1U << 31)
931 * Allow non spec compliant speedup tricks.
933 #define AV_CODEC_FLAG2_FAST (1 << 0)
935 * Skip bitstream encoding.
937 #define AV_CODEC_FLAG2_NO_OUTPUT (1 << 2)
939 * Place global headers at every keyframe instead of in extradata.
941 #define AV_CODEC_FLAG2_LOCAL_HEADER (1 << 3)
944 * timecode is in drop frame format. DEPRECATED!!!!
946 #define AV_CODEC_FLAG2_DROP_FRAME_TIMECODE (1 << 13)
949 * Input bitstream might be truncated at a packet boundaries
950 * instead of only at frame boundaries.
952 #define AV_CODEC_FLAG2_CHUNKS (1 << 15)
954 * Discard cropping information from SPS.
956 #define AV_CODEC_FLAG2_IGNORE_CROP (1 << 16)
959 * Show all frames before the first keyframe
961 #define AV_CODEC_FLAG2_SHOW_ALL (1 << 22)
963 * Export motion vectors through frame side data
965 #define AV_CODEC_FLAG2_EXPORT_MVS (1 << 28)
967 * Do not skip samples and export skip information as frame side data
969 #define AV_CODEC_FLAG2_SKIP_MANUAL (1 << 29)
971 * Do not reset ASS ReadOrder field on flush (subtitles decoding)
973 #define AV_CODEC_FLAG2_RO_FLUSH_NOOP (1 << 30)
975 /* Unsupported options :
976 * Syntax Arithmetic coding (SAC)
977 * Reference Picture Selection
978 * Independent Segment Decoding */
980 /* codec capabilities */
983 * Decoder can use draw_horiz_band callback.
985 #define AV_CODEC_CAP_DRAW_HORIZ_BAND (1 << 0)
987 * Codec uses get_buffer() for allocating buffers and supports custom allocators.
988 * If not set, it might not use get_buffer() at all or use operations that
989 * assume the buffer was allocated by avcodec_default_get_buffer.
991 #define AV_CODEC_CAP_DR1 (1 << 1)
992 #define AV_CODEC_CAP_TRUNCATED (1 << 3)
994 * Encoder or decoder requires flushing with NULL input at the end in order to
995 * give the complete and correct output.
997 * NOTE: If this flag is not set, the codec is guaranteed to never be fed with
998 * with NULL data. The user can still send NULL data to the public encode
999 * or decode function, but libavcodec will not pass it along to the codec
1000 * unless this flag is set.
1003 * The decoder has a non-zero delay and needs to be fed with avpkt->data=NULL,
1004 * avpkt->size=0 at the end to get the delayed data until the decoder no longer
1008 * The encoder needs to be fed with NULL data at the end of encoding until the
1009 * encoder no longer returns data.
1011 * NOTE: For encoders implementing the AVCodec.encode2() function, setting this
1012 * flag also means that the encoder must set the pts and duration for
1013 * each output packet. If this flag is not set, the pts and duration will
1014 * be determined by libavcodec from the input frame.
1016 #define AV_CODEC_CAP_DELAY (1 << 5)
1018 * Codec can be fed a final frame with a smaller size.
1019 * This can be used to prevent truncation of the last audio samples.
1021 #define AV_CODEC_CAP_SMALL_LAST_FRAME (1 << 6)
1023 #if FF_API_CAP_VDPAU
1025 * Codec can export data for HW decoding (VDPAU).
1027 #define AV_CODEC_CAP_HWACCEL_VDPAU (1 << 7)
1031 * Codec can output multiple frames per AVPacket
1032 * Normally demuxers return one frame at a time, demuxers which do not do
1033 * are connected to a parser to split what they return into proper frames.
1034 * This flag is reserved to the very rare category of codecs which have a
1035 * bitstream that cannot be split into frames without timeconsuming
1036 * operations like full decoding. Demuxers carrying such bitstreams thus
1037 * may return multiple frames in a packet. This has many disadvantages like
1038 * prohibiting stream copy in many cases thus it should only be considered
1041 #define AV_CODEC_CAP_SUBFRAMES (1 << 8)
1043 * Codec is experimental and is thus avoided in favor of non experimental
1046 #define AV_CODEC_CAP_EXPERIMENTAL (1 << 9)
1048 * Codec should fill in channel configuration and samplerate instead of container
1050 #define AV_CODEC_CAP_CHANNEL_CONF (1 << 10)
1052 * Codec supports frame-level multithreading.
1054 #define AV_CODEC_CAP_FRAME_THREADS (1 << 12)
1056 * Codec supports slice-based (or partition-based) multithreading.
1058 #define AV_CODEC_CAP_SLICE_THREADS (1 << 13)
1060 * Codec supports changed parameters at any point.
1062 #define AV_CODEC_CAP_PARAM_CHANGE (1 << 14)
1064 * Codec supports avctx->thread_count == 0 (auto).
1066 #define AV_CODEC_CAP_AUTO_THREADS (1 << 15)
1068 * Audio encoder supports receiving a different number of samples in each call.
1070 #define AV_CODEC_CAP_VARIABLE_FRAME_SIZE (1 << 16)
1072 * Decoder is not a preferred choice for probing.
1073 * This indicates that the decoder is not a good choice for probing.
1074 * It could for example be an expensive to spin up hardware decoder,
1075 * or it could simply not provide a lot of useful information about
1077 * A decoder marked with this flag should only be used as last resort
1078 * choice for probing.
1080 #define AV_CODEC_CAP_AVOID_PROBING (1 << 17)
1082 * Codec is intra only.
1084 #define AV_CODEC_CAP_INTRA_ONLY 0x40000000
1086 * Codec is lossless.
1088 #define AV_CODEC_CAP_LOSSLESS 0x80000000
1091 #if FF_API_WITHOUT_PREFIX
1093 * Allow decoders to produce frames with data planes that are not aligned
1094 * to CPU requirements (e.g. due to cropping).
1096 #define CODEC_FLAG_UNALIGNED AV_CODEC_FLAG_UNALIGNED
1097 #define CODEC_FLAG_QSCALE AV_CODEC_FLAG_QSCALE
1098 #define CODEC_FLAG_4MV AV_CODEC_FLAG_4MV
1099 #define CODEC_FLAG_OUTPUT_CORRUPT AV_CODEC_FLAG_OUTPUT_CORRUPT
1100 #define CODEC_FLAG_QPEL AV_CODEC_FLAG_QPEL
1103 * @deprecated use the "gmc" private option of the libxvid encoder
1105 #define CODEC_FLAG_GMC 0x0020 ///< Use GMC.
1109 * @deprecated use the flag "mv0" in the "mpv_flags" private option of the
1110 * mpegvideo encoders
1112 #define CODEC_FLAG_MV0 0x0040
1114 #if FF_API_INPUT_PRESERVED
1116 * @deprecated passing reference-counted frames to the encoders replaces this
1119 #define CODEC_FLAG_INPUT_PRESERVED 0x0100
1121 #define CODEC_FLAG_PASS1 AV_CODEC_FLAG_PASS1
1122 #define CODEC_FLAG_PASS2 AV_CODEC_FLAG_PASS2
1123 #define CODEC_FLAG_GRAY AV_CODEC_FLAG_GRAY
1126 * @deprecated edges are not used/required anymore. I.e. this flag is now always
1129 #define CODEC_FLAG_EMU_EDGE 0x4000
1131 #define CODEC_FLAG_PSNR AV_CODEC_FLAG_PSNR
1132 #define CODEC_FLAG_TRUNCATED AV_CODEC_FLAG_TRUNCATED
1134 #if FF_API_NORMALIZE_AQP
1136 * @deprecated use the flag "naq" in the "mpv_flags" private option of the
1137 * mpegvideo encoders
1139 #define CODEC_FLAG_NORMALIZE_AQP 0x00020000
1141 #define CODEC_FLAG_INTERLACED_DCT AV_CODEC_FLAG_INTERLACED_DCT
1142 #define CODEC_FLAG_LOW_DELAY AV_CODEC_FLAG_LOW_DELAY
1143 #define CODEC_FLAG_GLOBAL_HEADER AV_CODEC_FLAG_GLOBAL_HEADER
1144 #define CODEC_FLAG_BITEXACT AV_CODEC_FLAG_BITEXACT
1145 #define CODEC_FLAG_AC_PRED AV_CODEC_FLAG_AC_PRED
1146 #define CODEC_FLAG_LOOP_FILTER AV_CODEC_FLAG_LOOP_FILTER
1147 #define CODEC_FLAG_INTERLACED_ME AV_CODEC_FLAG_INTERLACED_ME
1148 #define CODEC_FLAG_CLOSED_GOP AV_CODEC_FLAG_CLOSED_GOP
1149 #define CODEC_FLAG2_FAST AV_CODEC_FLAG2_FAST
1150 #define CODEC_FLAG2_NO_OUTPUT AV_CODEC_FLAG2_NO_OUTPUT
1151 #define CODEC_FLAG2_LOCAL_HEADER AV_CODEC_FLAG2_LOCAL_HEADER
1152 #define CODEC_FLAG2_DROP_FRAME_TIMECODE AV_CODEC_FLAG2_DROP_FRAME_TIMECODE
1153 #define CODEC_FLAG2_IGNORE_CROP AV_CODEC_FLAG2_IGNORE_CROP
1155 #define CODEC_FLAG2_CHUNKS AV_CODEC_FLAG2_CHUNKS
1156 #define CODEC_FLAG2_SHOW_ALL AV_CODEC_FLAG2_SHOW_ALL
1157 #define CODEC_FLAG2_EXPORT_MVS AV_CODEC_FLAG2_EXPORT_MVS
1158 #define CODEC_FLAG2_SKIP_MANUAL AV_CODEC_FLAG2_SKIP_MANUAL
1160 /* Unsupported options :
1161 * Syntax Arithmetic coding (SAC)
1162 * Reference Picture Selection
1163 * Independent Segment Decoding */
1165 /* codec capabilities */
1167 #define CODEC_CAP_DRAW_HORIZ_BAND AV_CODEC_CAP_DRAW_HORIZ_BAND ///< Decoder can use draw_horiz_band callback.
1169 * Codec uses get_buffer() for allocating buffers and supports custom allocators.
1170 * If not set, it might not use get_buffer() at all or use operations that
1171 * assume the buffer was allocated by avcodec_default_get_buffer.
1173 #define CODEC_CAP_DR1 AV_CODEC_CAP_DR1
1174 #define CODEC_CAP_TRUNCATED AV_CODEC_CAP_TRUNCATED
1176 /* Codec can export data for HW decoding. This flag indicates that
1177 * the codec would call get_format() with list that might contain HW accelerated
1178 * pixel formats (XvMC, VDPAU, VAAPI, etc). The application can pick any of them
1179 * including raw image format.
1180 * The application can use the passed context to determine bitstream version,
1181 * chroma format, resolution etc.
1183 #define CODEC_CAP_HWACCEL 0x0010
1184 #endif /* FF_API_XVMC */
1186 * Encoder or decoder requires flushing with NULL input at the end in order to
1187 * give the complete and correct output.
1189 * NOTE: If this flag is not set, the codec is guaranteed to never be fed with
1190 * with NULL data. The user can still send NULL data to the public encode
1191 * or decode function, but libavcodec will not pass it along to the codec
1192 * unless this flag is set.
1195 * The decoder has a non-zero delay and needs to be fed with avpkt->data=NULL,
1196 * avpkt->size=0 at the end to get the delayed data until the decoder no longer
1200 * The encoder needs to be fed with NULL data at the end of encoding until the
1201 * encoder no longer returns data.
1203 * NOTE: For encoders implementing the AVCodec.encode2() function, setting this
1204 * flag also means that the encoder must set the pts and duration for
1205 * each output packet. If this flag is not set, the pts and duration will
1206 * be determined by libavcodec from the input frame.
1208 #define CODEC_CAP_DELAY AV_CODEC_CAP_DELAY
1210 * Codec can be fed a final frame with a smaller size.
1211 * This can be used to prevent truncation of the last audio samples.
1213 #define CODEC_CAP_SMALL_LAST_FRAME AV_CODEC_CAP_SMALL_LAST_FRAME
1214 #if FF_API_CAP_VDPAU
1216 * Codec can export data for HW decoding (VDPAU).
1218 #define CODEC_CAP_HWACCEL_VDPAU AV_CODEC_CAP_HWACCEL_VDPAU
1221 * Codec can output multiple frames per AVPacket
1222 * Normally demuxers return one frame at a time, demuxers which do not do
1223 * are connected to a parser to split what they return into proper frames.
1224 * This flag is reserved to the very rare category of codecs which have a
1225 * bitstream that cannot be split into frames without timeconsuming
1226 * operations like full decoding. Demuxers carrying such bitstreams thus
1227 * may return multiple frames in a packet. This has many disadvantages like
1228 * prohibiting stream copy in many cases thus it should only be considered
1231 #define CODEC_CAP_SUBFRAMES AV_CODEC_CAP_SUBFRAMES
1233 * Codec is experimental and is thus avoided in favor of non experimental
1236 #define CODEC_CAP_EXPERIMENTAL AV_CODEC_CAP_EXPERIMENTAL
1238 * Codec should fill in channel configuration and samplerate instead of container
1240 #define CODEC_CAP_CHANNEL_CONF AV_CODEC_CAP_CHANNEL_CONF
1241 #if FF_API_NEG_LINESIZES
1243 * @deprecated no codecs use this capability
1245 #define CODEC_CAP_NEG_LINESIZES 0x0800
1248 * Codec supports frame-level multithreading.
1250 #define CODEC_CAP_FRAME_THREADS AV_CODEC_CAP_FRAME_THREADS
1252 * Codec supports slice-based (or partition-based) multithreading.
1254 #define CODEC_CAP_SLICE_THREADS AV_CODEC_CAP_SLICE_THREADS
1256 * Codec supports changed parameters at any point.
1258 #define CODEC_CAP_PARAM_CHANGE AV_CODEC_CAP_PARAM_CHANGE
1260 * Codec supports avctx->thread_count == 0 (auto).
1262 #define CODEC_CAP_AUTO_THREADS AV_CODEC_CAP_AUTO_THREADS
1264 * Audio encoder supports receiving a different number of samples in each call.
1266 #define CODEC_CAP_VARIABLE_FRAME_SIZE AV_CODEC_CAP_VARIABLE_FRAME_SIZE
1268 * Codec is intra only.
1270 #define CODEC_CAP_INTRA_ONLY AV_CODEC_CAP_INTRA_ONLY
1272 * Codec is lossless.
1274 #define CODEC_CAP_LOSSLESS AV_CODEC_CAP_LOSSLESS
1277 * HWAccel is experimental and is thus avoided in favor of non experimental
1280 #define HWACCEL_CODEC_CAP_EXPERIMENTAL 0x0200
1281 #endif /* FF_API_WITHOUT_PREFIX */
1284 //The following defines may change, don't expect compatibility if you use them.
1285 #define MB_TYPE_INTRA4x4 0x0001
1286 #define MB_TYPE_INTRA16x16 0x0002 //FIXME H.264-specific
1287 #define MB_TYPE_INTRA_PCM 0x0004 //FIXME H.264-specific
1288 #define MB_TYPE_16x16 0x0008
1289 #define MB_TYPE_16x8 0x0010
1290 #define MB_TYPE_8x16 0x0020
1291 #define MB_TYPE_8x8 0x0040
1292 #define MB_TYPE_INTERLACED 0x0080
1293 #define MB_TYPE_DIRECT2 0x0100 //FIXME
1294 #define MB_TYPE_ACPRED 0x0200
1295 #define MB_TYPE_GMC 0x0400
1296 #define MB_TYPE_SKIP 0x0800
1297 #define MB_TYPE_P0L0 0x1000
1298 #define MB_TYPE_P1L0 0x2000
1299 #define MB_TYPE_P0L1 0x4000
1300 #define MB_TYPE_P1L1 0x8000
1301 #define MB_TYPE_L0 (MB_TYPE_P0L0 | MB_TYPE_P1L0)
1302 #define MB_TYPE_L1 (MB_TYPE_P0L1 | MB_TYPE_P1L1)
1303 #define MB_TYPE_L0L1 (MB_TYPE_L0 | MB_TYPE_L1)
1304 #define MB_TYPE_QUANT 0x00010000
1305 #define MB_TYPE_CBP 0x00020000
1306 // Note bits 24-31 are reserved for codec specific use (H.264 ref0, MPEG-1 0mv, ...)
1311 * This specifies the area which should be displayed.
1312 * Note there may be multiple such areas for one frame.
1314 typedef struct AVPanScan{
1317 * - encoding: Set by user.
1318 * - decoding: Set by libavcodec.
1323 * width and height in 1/16 pel
1324 * - encoding: Set by user.
1325 * - decoding: Set by libavcodec.
1331 * position of the top left corner in 1/16 pel for up to 3 fields/frames
1332 * - encoding: Set by user.
1333 * - decoding: Set by libavcodec.
1335 int16_t position[3][2];
1339 * This structure describes the bitrate properties of an encoded bitstream. It
1340 * roughly corresponds to a subset the VBV parameters for MPEG-2 or HRD
1341 * parameters for H.264/HEVC.
1343 typedef struct AVCPBProperties {
1345 * Maximum bitrate of the stream, in bits per second.
1346 * Zero if unknown or unspecified.
1350 * Minimum bitrate of the stream, in bits per second.
1351 * Zero if unknown or unspecified.
1355 * Average bitrate of the stream, in bits per second.
1356 * Zero if unknown or unspecified.
1361 * The size of the buffer to which the ratecontrol is applied, in bits.
1362 * Zero if unknown or unspecified.
1367 * The delay between the time the packet this structure is associated with
1368 * is received and the time when it should be decoded, in periods of a 27MHz
1371 * UINT64_MAX when unknown or unspecified.
1376 #if FF_API_QSCALE_TYPE
1377 #define FF_QSCALE_TYPE_MPEG1 0
1378 #define FF_QSCALE_TYPE_MPEG2 1
1379 #define FF_QSCALE_TYPE_H264 2
1380 #define FF_QSCALE_TYPE_VP56 3
1384 * The decoder will keep a reference to the frame and may reuse it later.
1386 #define AV_GET_BUFFER_FLAG_REF (1 << 0)
1389 * @defgroup lavc_packet AVPacket
1391 * Types and functions for working with AVPacket.
1394 enum AVPacketSideDataType {
1395 AV_PKT_DATA_PALETTE,
1398 * The AV_PKT_DATA_NEW_EXTRADATA is used to notify the codec or the format
1399 * that the extradata buffer was changed and the receiving side should
1400 * act upon it appropriately. The new extradata is embedded in the side
1401 * data buffer and should be immediately used for processing the current
1404 AV_PKT_DATA_NEW_EXTRADATA,
1407 * An AV_PKT_DATA_PARAM_CHANGE side data packet is laid out as follows:
1410 * if (param_flags & AV_SIDE_DATA_PARAM_CHANGE_CHANNEL_COUNT)
1411 * s32le channel_count
1412 * if (param_flags & AV_SIDE_DATA_PARAM_CHANGE_CHANNEL_LAYOUT)
1413 * u64le channel_layout
1414 * if (param_flags & AV_SIDE_DATA_PARAM_CHANGE_SAMPLE_RATE)
1416 * if (param_flags & AV_SIDE_DATA_PARAM_CHANGE_DIMENSIONS)
1421 AV_PKT_DATA_PARAM_CHANGE,
1424 * An AV_PKT_DATA_H263_MB_INFO side data packet contains a number of
1425 * structures with info about macroblocks relevant to splitting the
1426 * packet into smaller packets on macroblock edges (e.g. as for RFC 2190).
1427 * That is, it does not necessarily contain info about all macroblocks,
1428 * as long as the distance between macroblocks in the info is smaller
1429 * than the target payload size.
1430 * Each MB info structure is 12 bytes, and is laid out as follows:
1432 * u32le bit offset from the start of the packet
1433 * u8 current quantizer at the start of the macroblock
1435 * u16le macroblock address within the GOB
1436 * u8 horizontal MV predictor
1437 * u8 vertical MV predictor
1438 * u8 horizontal MV predictor for block number 3
1439 * u8 vertical MV predictor for block number 3
1442 AV_PKT_DATA_H263_MB_INFO,
1445 * This side data should be associated with an audio stream and contains
1446 * ReplayGain information in form of the AVReplayGain struct.
1448 AV_PKT_DATA_REPLAYGAIN,
1451 * This side data contains a 3x3 transformation matrix describing an affine
1452 * transformation that needs to be applied to the decoded video frames for
1453 * correct presentation.
1455 * See libavutil/display.h for a detailed description of the data.
1457 AV_PKT_DATA_DISPLAYMATRIX,
1460 * This side data should be associated with a video stream and contains
1461 * Stereoscopic 3D information in form of the AVStereo3D struct.
1463 AV_PKT_DATA_STEREO3D,
1466 * This side data should be associated with an audio stream and corresponds
1467 * to enum AVAudioServiceType.
1469 AV_PKT_DATA_AUDIO_SERVICE_TYPE,
1472 * This side data contains quality related information from the encoder.
1474 * u32le quality factor of the compressed frame. Allowed range is between 1 (good) and FF_LAMBDA_MAX (bad).
1478 * u64le[error count] sum of squared differences between encoder in and output
1481 AV_PKT_DATA_QUALITY_STATS,
1484 * This side data contains an integer value representing the stream index
1485 * of a "fallback" track. A fallback track indicates an alternate
1486 * track to use when the current track can not be decoded for some reason.
1487 * e.g. no decoder available for codec.
1489 AV_PKT_DATA_FALLBACK_TRACK,
1492 * This side data corresponds to the AVCPBProperties struct.
1494 AV_PKT_DATA_CPB_PROPERTIES,
1497 * Recommmends skipping the specified number of samples
1499 * u32le number of samples to skip from start of this packet
1500 * u32le number of samples to skip from end of this packet
1501 * u8 reason for start skip
1502 * u8 reason for end skip (0=padding silence, 1=convergence)
1505 AV_PKT_DATA_SKIP_SAMPLES=70,
1508 * An AV_PKT_DATA_JP_DUALMONO side data packet indicates that
1509 * the packet may contain "dual mono" audio specific to Japanese DTV
1510 * and if it is true, recommends only the selected channel to be used.
1512 * u8 selected channels (0=mail/left, 1=sub/right, 2=both)
1515 AV_PKT_DATA_JP_DUALMONO,
1518 * A list of zero terminated key/value strings. There is no end marker for
1519 * the list, so it is required to rely on the side data size to stop.
1521 AV_PKT_DATA_STRINGS_METADATA,
1524 * Subtitle event position
1532 AV_PKT_DATA_SUBTITLE_POSITION,
1535 * Data found in BlockAdditional element of matroska container. There is
1536 * no end marker for the data, so it is required to rely on the side data
1537 * size to recognize the end. 8 byte id (as found in BlockAddId) followed
1540 AV_PKT_DATA_MATROSKA_BLOCKADDITIONAL,
1543 * The optional first identifier line of a WebVTT cue.
1545 AV_PKT_DATA_WEBVTT_IDENTIFIER,
1548 * The optional settings (rendering instructions) that immediately
1549 * follow the timestamp specifier of a WebVTT cue.
1551 AV_PKT_DATA_WEBVTT_SETTINGS,
1554 * A list of zero terminated key/value strings. There is no end marker for
1555 * the list, so it is required to rely on the side data size to stop. This
1556 * side data includes updated metadata which appeared in the stream.
1558 AV_PKT_DATA_METADATA_UPDATE,
1561 * MPEGTS stream ID, this is required to pass the stream ID
1562 * information from the demuxer to the corresponding muxer.
1564 AV_PKT_DATA_MPEGTS_STREAM_ID,
1567 * Mastering display metadata (based on SMPTE-2086:2014). This metadata
1568 * should be associated with a video stream and containts data in the form
1569 * of the AVMasteringDisplayMetadata struct.
1571 AV_PKT_DATA_MASTERING_DISPLAY_METADATA,
1574 * This side data should be associated with a video stream and corresponds
1575 * to the AVSphericalMapping structure.
1577 AV_PKT_DATA_SPHERICAL,
1580 #define AV_PKT_DATA_QUALITY_FACTOR AV_PKT_DATA_QUALITY_STATS //DEPRECATED
1582 typedef struct AVPacketSideData {
1585 enum AVPacketSideDataType type;
1589 * This structure stores compressed data. It is typically exported by demuxers
1590 * and then passed as input to decoders, or received as output from encoders and
1591 * then passed to muxers.
1593 * For video, it should typically contain one compressed frame. For audio it may
1594 * contain several compressed frames. Encoders are allowed to output empty
1595 * packets, with no compressed data, containing only side data
1596 * (e.g. to update some stream parameters at the end of encoding).
1598 * AVPacket is one of the few structs in FFmpeg, whose size is a part of public
1599 * ABI. Thus it may be allocated on stack and no new fields can be added to it
1600 * without libavcodec and libavformat major bump.
1602 * The semantics of data ownership depends on the buf field.
1603 * If it is set, the packet data is dynamically allocated and is
1604 * valid indefinitely until a call to av_packet_unref() reduces the
1605 * reference count to 0.
1607 * If the buf field is not set av_packet_ref() would make a copy instead
1608 * of increasing the reference count.
1610 * The side data is always allocated with av_malloc(), copied by
1611 * av_packet_ref() and freed by av_packet_unref().
1613 * @see av_packet_ref
1614 * @see av_packet_unref
1616 typedef struct AVPacket {
1618 * A reference to the reference-counted buffer where the packet data is
1620 * May be NULL, then the packet data is not reference-counted.
1624 * Presentation timestamp in AVStream->time_base units; the time at which
1625 * the decompressed packet will be presented to the user.
1626 * Can be AV_NOPTS_VALUE if it is not stored in the file.
1627 * pts MUST be larger or equal to dts as presentation cannot happen before
1628 * decompression, unless one wants to view hex dumps. Some formats misuse
1629 * the terms dts and pts/cts to mean something different. Such timestamps
1630 * must be converted to true pts/dts before they are stored in AVPacket.
1634 * Decompression timestamp in AVStream->time_base units; the time at which
1635 * the packet is decompressed.
1636 * Can be AV_NOPTS_VALUE if it is not stored in the file.
1643 * A combination of AV_PKT_FLAG values
1647 * Additional packet data that can be provided by the container.
1648 * Packet can contain several types of side information.
1650 AVPacketSideData *side_data;
1651 int side_data_elems;
1654 * Duration of this packet in AVStream->time_base units, 0 if unknown.
1655 * Equals next_pts - this_pts in presentation order.
1659 int64_t pos; ///< byte position in stream, -1 if unknown
1661 #if FF_API_CONVERGENCE_DURATION
1663 * @deprecated Same as the duration field, but as int64_t. This was required
1664 * for Matroska subtitles, whose duration values could overflow when the
1665 * duration field was still an int.
1667 attribute_deprecated
1668 int64_t convergence_duration;
1671 #define AV_PKT_FLAG_KEY 0x0001 ///< The packet contains a keyframe
1672 #define AV_PKT_FLAG_CORRUPT 0x0002 ///< The packet content is corrupted
1674 * Flag is used to discard packets which are required to maintain valid
1675 * decoder state but are not required for output and should be dropped
1678 #define AV_PKT_FLAG_DISCARD 0x0004
1680 enum AVSideDataParamChangeFlags {
1681 AV_SIDE_DATA_PARAM_CHANGE_CHANNEL_COUNT = 0x0001,
1682 AV_SIDE_DATA_PARAM_CHANGE_CHANNEL_LAYOUT = 0x0002,
1683 AV_SIDE_DATA_PARAM_CHANGE_SAMPLE_RATE = 0x0004,
1684 AV_SIDE_DATA_PARAM_CHANGE_DIMENSIONS = 0x0008,
1690 struct AVCodecInternal;
1694 AV_FIELD_PROGRESSIVE,
1695 AV_FIELD_TT, //< Top coded_first, top displayed first
1696 AV_FIELD_BB, //< Bottom coded first, bottom displayed first
1697 AV_FIELD_TB, //< Top coded first, bottom displayed first
1698 AV_FIELD_BT, //< Bottom coded first, top displayed first
1702 * main external API structure.
1703 * New fields can be added to the end with minor version bumps.
1704 * Removal, reordering and changes to existing fields require a major
1706 * You can use AVOptions (av_opt* / av_set/get*()) to access these fields from user
1708 * The name string for AVOptions options matches the associated command line
1709 * parameter name and can be found in libavcodec/options_table.h
1710 * The AVOption/command line parameter names differ in some cases from the C
1711 * structure field names for historic reasons or brevity.
1712 * sizeof(AVCodecContext) must not be used outside libav*.
1714 typedef struct AVCodecContext {
1716 * information on struct for av_log
1717 * - set by avcodec_alloc_context3
1719 const AVClass *av_class;
1720 int log_level_offset;
1722 enum AVMediaType codec_type; /* see AVMEDIA_TYPE_xxx */
1723 const struct AVCodec *codec;
1724 #if FF_API_CODEC_NAME
1726 * @deprecated this field is not used for anything in libavcodec
1728 attribute_deprecated
1729 char codec_name[32];
1731 enum AVCodecID codec_id; /* see AV_CODEC_ID_xxx */
1734 * fourcc (LSB first, so "ABCD" -> ('D'<<24) + ('C'<<16) + ('B'<<8) + 'A').
1735 * This is used to work around some encoder bugs.
1736 * A demuxer should set this to what is stored in the field used to identify the codec.
1737 * If there are multiple such fields in a container then the demuxer should choose the one
1738 * which maximizes the information about the used codec.
1739 * If the codec tag field in a container is larger than 32 bits then the demuxer should
1740 * remap the longer ID to 32 bits with a table or other structure. Alternatively a new
1741 * extra_codec_tag + size could be added but for this a clear advantage must be demonstrated
1743 * - encoding: Set by user, if not then the default based on codec_id will be used.
1744 * - decoding: Set by user, will be converted to uppercase by libavcodec during init.
1746 unsigned int codec_tag;
1748 #if FF_API_STREAM_CODEC_TAG
1750 * @deprecated this field is unused
1752 attribute_deprecated
1753 unsigned int stream_codec_tag;
1759 * Private context used for internal data.
1761 * Unlike priv_data, this is not codec-specific. It is used in general
1762 * libavcodec functions.
1764 struct AVCodecInternal *internal;
1767 * Private data of the user, can be used to carry app specific stuff.
1768 * - encoding: Set by user.
1769 * - decoding: Set by user.
1774 * the average bitrate
1775 * - encoding: Set by user; unused for constant quantizer encoding.
1776 * - decoding: Set by user, may be overwritten by libavcodec
1777 * if this info is available in the stream
1782 * number of bits the bitstream is allowed to diverge from the reference.
1783 * the reference can be CBR (for CBR pass1) or VBR (for pass2)
1784 * - encoding: Set by user; unused for constant quantizer encoding.
1785 * - decoding: unused
1787 int bit_rate_tolerance;
1790 * Global quality for codecs which cannot change it per frame.
1791 * This should be proportional to MPEG-1/2/4 qscale.
1792 * - encoding: Set by user.
1793 * - decoding: unused
1798 * - encoding: Set by user.
1799 * - decoding: unused
1801 int compression_level;
1802 #define FF_COMPRESSION_DEFAULT -1
1806 * - encoding: Set by user.
1807 * - decoding: Set by user.
1813 * - encoding: Set by user.
1814 * - decoding: Set by user.
1819 * some codecs need / can use extradata like Huffman tables.
1820 * MJPEG: Huffman tables
1821 * rv10: additional flags
1822 * MPEG-4: global headers (they can be in the bitstream or here)
1823 * The allocated memory should be AV_INPUT_BUFFER_PADDING_SIZE bytes larger
1824 * than extradata_size to avoid problems if it is read with the bitstream reader.
1825 * The bytewise contents of extradata must not depend on the architecture or CPU endianness.
1826 * - encoding: Set/allocated/freed by libavcodec.
1827 * - decoding: Set/allocated/freed by user.
1833 * This is the fundamental unit of time (in seconds) in terms
1834 * of which frame timestamps are represented. For fixed-fps content,
1835 * timebase should be 1/framerate and timestamp increments should be
1837 * This often, but not always is the inverse of the frame rate or field rate
1838 * for video. 1/time_base is not the average frame rate if the frame rate is not
1841 * Like containers, elementary streams also can store timestamps, 1/time_base
1842 * is the unit in which these timestamps are specified.
1843 * As example of such codec time base see ISO/IEC 14496-2:2001(E)
1844 * vop_time_increment_resolution and fixed_vop_rate
1845 * (fixed_vop_rate == 0 implies that it is different from the framerate)
1847 * - encoding: MUST be set by user.
1848 * - decoding: the use of this field for decoding is deprecated.
1849 * Use framerate instead.
1851 AVRational time_base;
1854 * For some codecs, the time base is closer to the field rate than the frame rate.
1855 * Most notably, H.264 and MPEG-2 specify time_base as half of frame duration
1856 * if no telecine is used ...
1858 * Set to time_base ticks per frame. Default 1, e.g., H.264/MPEG-2 set it to 2.
1860 int ticks_per_frame;
1865 * Encoding: Number of frames delay there will be from the encoder input to
1866 * the decoder output. (we assume the decoder matches the spec)
1867 * Decoding: Number of frames delay in addition to what a standard decoder
1868 * as specified in the spec would produce.
1871 * Number of frames the decoded output will be delayed relative to the
1875 * For encoding, this field is unused (see initial_padding).
1877 * For decoding, this is the number of samples the decoder needs to
1878 * output before the decoder's output is valid. When seeking, you should
1879 * start decoding this many samples prior to your desired seek point.
1881 * - encoding: Set by libavcodec.
1882 * - decoding: Set by libavcodec.
1889 * picture width / height.
1891 * @note Those fields may not match the values of the last
1892 * AVFrame output by avcodec_decode_video2 due frame
1895 * - encoding: MUST be set by user.
1896 * - decoding: May be set by the user before opening the decoder if known e.g.
1897 * from the container. Some decoders will require the dimensions
1898 * to be set by the caller. During decoding, the decoder may
1899 * overwrite those values as required while parsing the data.
1904 * Bitstream width / height, may be different from width/height e.g. when
1905 * the decoded frame is cropped before being output or lowres is enabled.
1907 * @note Those field may not match the value of the last
1908 * AVFrame output by avcodec_receive_frame() due frame
1911 * - encoding: unused
1912 * - decoding: May be set by the user before opening the decoder if known
1913 * e.g. from the container. During decoding, the decoder may
1914 * overwrite those values as required while parsing the data.
1916 int coded_width, coded_height;
1918 #if FF_API_ASPECT_EXTENDED
1919 #define FF_ASPECT_EXTENDED 15
1923 * the number of pictures in a group of pictures, or 0 for intra_only
1924 * - encoding: Set by user.
1925 * - decoding: unused
1930 * Pixel format, see AV_PIX_FMT_xxx.
1931 * May be set by the demuxer if known from headers.
1932 * May be overridden by the decoder if it knows better.
1934 * @note This field may not match the value of the last
1935 * AVFrame output by avcodec_receive_frame() due frame
1938 * - encoding: Set by user.
1939 * - decoding: Set by user if known, overridden by libavcodec while
1942 enum AVPixelFormat pix_fmt;
1944 #if FF_API_MOTION_EST
1946 * This option does nothing
1947 * @deprecated use codec private options instead
1949 attribute_deprecated int me_method;
1953 * If non NULL, 'draw_horiz_band' is called by the libavcodec
1954 * decoder to draw a horizontal band. It improves cache usage. Not
1955 * all codecs can do that. You must check the codec capabilities
1957 * When multithreading is used, it may be called from multiple threads
1958 * at the same time; threads might draw different parts of the same AVFrame,
1959 * or multiple AVFrames, and there is no guarantee that slices will be drawn
1961 * The function is also used by hardware acceleration APIs.
1962 * It is called at least once during frame decoding to pass
1963 * the data needed for hardware render.
1964 * In that mode instead of pixel data, AVFrame points to
1965 * a structure specific to the acceleration API. The application
1966 * reads the structure and can change some fields to indicate progress
1968 * - encoding: unused
1969 * - decoding: Set by user.
1970 * @param height the height of the slice
1971 * @param y the y position of the slice
1972 * @param type 1->top field, 2->bottom field, 3->frame
1973 * @param offset offset into the AVFrame.data from which the slice should be read
1975 void (*draw_horiz_band)(struct AVCodecContext *s,
1976 const AVFrame *src, int offset[AV_NUM_DATA_POINTERS],
1977 int y, int type, int height);
1980 * callback to negotiate the pixelFormat
1981 * @param fmt is the list of formats which are supported by the codec,
1982 * it is terminated by -1 as 0 is a valid format, the formats are ordered by quality.
1983 * The first is always the native one.
1984 * @note The callback may be called again immediately if initialization for
1985 * the selected (hardware-accelerated) pixel format failed.
1986 * @warning Behavior is undefined if the callback returns a value not
1987 * in the fmt list of formats.
1988 * @return the chosen format
1989 * - encoding: unused
1990 * - decoding: Set by user, if not set the native format will be chosen.
1992 enum AVPixelFormat (*get_format)(struct AVCodecContext *s, const enum AVPixelFormat * fmt);
1995 * maximum number of B-frames between non-B-frames
1996 * Note: The output will be delayed by max_b_frames+1 relative to the input.
1997 * - encoding: Set by user.
1998 * - decoding: unused
2003 * qscale factor between IP and B-frames
2004 * If > 0 then the last P-frame quantizer will be used (q= lastp_q*factor+offset).
2005 * If < 0 then normal ratecontrol will be done (q= -normal_q*factor+offset).
2006 * - encoding: Set by user.
2007 * - decoding: unused
2009 float b_quant_factor;
2011 #if FF_API_RC_STRATEGY
2012 /** @deprecated use codec private option instead */
2013 attribute_deprecated int rc_strategy;
2014 #define FF_RC_STRATEGY_XVID 1
2017 #if FF_API_PRIVATE_OPT
2018 /** @deprecated use encoder private options instead */
2019 attribute_deprecated
2020 int b_frame_strategy;
2024 * qscale offset between IP and B-frames
2025 * - encoding: Set by user.
2026 * - decoding: unused
2028 float b_quant_offset;
2031 * Size of the frame reordering buffer in the decoder.
2032 * For MPEG-2 it is 1 IPB or 0 low delay IP.
2033 * - encoding: Set by libavcodec.
2034 * - decoding: Set by libavcodec.
2038 #if FF_API_PRIVATE_OPT
2039 /** @deprecated use encoder private options instead */
2040 attribute_deprecated
2045 * qscale factor between P- and I-frames
2046 * If > 0 then the last P-frame quantizer will be used (q = lastp_q * factor + offset).
2047 * If < 0 then normal ratecontrol will be done (q= -normal_q*factor+offset).
2048 * - encoding: Set by user.
2049 * - decoding: unused
2051 float i_quant_factor;
2054 * qscale offset between P and I-frames
2055 * - encoding: Set by user.
2056 * - decoding: unused
2058 float i_quant_offset;
2061 * luminance masking (0-> disabled)
2062 * - encoding: Set by user.
2063 * - decoding: unused
2068 * temporary complexity masking (0-> disabled)
2069 * - encoding: Set by user.
2070 * - decoding: unused
2072 float temporal_cplx_masking;
2075 * spatial complexity masking (0-> disabled)
2076 * - encoding: Set by user.
2077 * - decoding: unused
2079 float spatial_cplx_masking;
2082 * p block masking (0-> disabled)
2083 * - encoding: Set by user.
2084 * - decoding: unused
2089 * darkness masking (0-> disabled)
2090 * - encoding: Set by user.
2091 * - decoding: unused
2097 * - encoding: Set by libavcodec.
2098 * - decoding: Set by user (or 0).
2102 #if FF_API_PRIVATE_OPT
2103 /** @deprecated use encoder private options instead */
2104 attribute_deprecated
2105 int prediction_method;
2106 #define FF_PRED_LEFT 0
2107 #define FF_PRED_PLANE 1
2108 #define FF_PRED_MEDIAN 2
2112 * slice offsets in the frame in bytes
2113 * - encoding: Set/allocated by libavcodec.
2114 * - decoding: Set/allocated by user (or NULL).
2119 * sample aspect ratio (0 if unknown)
2120 * That is the width of a pixel divided by the height of the pixel.
2121 * Numerator and denominator must be relatively prime and smaller than 256 for some video standards.
2122 * - encoding: Set by user.
2123 * - decoding: Set by libavcodec.
2125 AVRational sample_aspect_ratio;
2128 * motion estimation comparison function
2129 * - encoding: Set by user.
2130 * - decoding: unused
2134 * subpixel motion estimation comparison function
2135 * - encoding: Set by user.
2136 * - decoding: unused
2140 * macroblock comparison function (not supported yet)
2141 * - encoding: Set by user.
2142 * - decoding: unused
2146 * interlaced DCT comparison function
2147 * - encoding: Set by user.
2148 * - decoding: unused
2151 #define FF_CMP_SAD 0
2152 #define FF_CMP_SSE 1
2153 #define FF_CMP_SATD 2
2154 #define FF_CMP_DCT 3
2155 #define FF_CMP_PSNR 4
2156 #define FF_CMP_BIT 5
2158 #define FF_CMP_ZERO 7
2159 #define FF_CMP_VSAD 8
2160 #define FF_CMP_VSSE 9
2161 #define FF_CMP_NSSE 10
2162 #define FF_CMP_W53 11
2163 #define FF_CMP_W97 12
2164 #define FF_CMP_DCTMAX 13
2165 #define FF_CMP_DCT264 14
2166 #define FF_CMP_MEDIAN_SAD 15
2167 #define FF_CMP_CHROMA 256
2170 * ME diamond size & shape
2171 * - encoding: Set by user.
2172 * - decoding: unused
2177 * amount of previous MV predictors (2a+1 x 2a+1 square)
2178 * - encoding: Set by user.
2179 * - decoding: unused
2181 int last_predictor_count;
2183 #if FF_API_PRIVATE_OPT
2184 /** @deprecated use encoder private options instead */
2185 attribute_deprecated
2190 * motion estimation prepass comparison function
2191 * - encoding: Set by user.
2192 * - decoding: unused
2197 * ME prepass diamond size & shape
2198 * - encoding: Set by user.
2199 * - decoding: unused
2205 * - encoding: Set by user.
2206 * - decoding: unused
2208 int me_subpel_quality;
2212 * DTG active format information (additional aspect ratio
2213 * information only used in DVB MPEG-2 transport streams)
2216 * - encoding: unused
2217 * - decoding: Set by decoder.
2218 * @deprecated Deprecated in favor of AVSideData
2220 attribute_deprecated int dtg_active_format;
2221 #define FF_DTG_AFD_SAME 8
2222 #define FF_DTG_AFD_4_3 9
2223 #define FF_DTG_AFD_16_9 10
2224 #define FF_DTG_AFD_14_9 11
2225 #define FF_DTG_AFD_4_3_SP_14_9 13
2226 #define FF_DTG_AFD_16_9_SP_14_9 14
2227 #define FF_DTG_AFD_SP_4_3 15
2228 #endif /* FF_API_AFD */
2231 * maximum motion estimation search range in subpel units
2232 * If 0 then no limit.
2234 * - encoding: Set by user.
2235 * - decoding: unused
2239 #if FF_API_QUANT_BIAS
2241 * @deprecated use encoder private option instead
2243 attribute_deprecated int intra_quant_bias;
2244 #define FF_DEFAULT_QUANT_BIAS 999999
2247 * @deprecated use encoder private option instead
2249 attribute_deprecated int inter_quant_bias;
2254 * - encoding: unused
2255 * - decoding: Set by user.
2258 #define SLICE_FLAG_CODED_ORDER 0x0001 ///< draw_horiz_band() is called in coded order instead of display
2259 #define SLICE_FLAG_ALLOW_FIELD 0x0002 ///< allow draw_horiz_band() with field slices (MPEG-2 field pics)
2260 #define SLICE_FLAG_ALLOW_PLANE 0x0004 ///< allow draw_horiz_band() with 1 component at a time (SVQ1)
2264 * XVideo Motion Acceleration
2265 * - encoding: forbidden
2266 * - decoding: set by decoder
2267 * @deprecated XvMC doesn't need it anymore.
2269 attribute_deprecated int xvmc_acceleration;
2270 #endif /* FF_API_XVMC */
2273 * macroblock decision mode
2274 * - encoding: Set by user.
2275 * - decoding: unused
2278 #define FF_MB_DECISION_SIMPLE 0 ///< uses mb_cmp
2279 #define FF_MB_DECISION_BITS 1 ///< chooses the one which needs the fewest bits
2280 #define FF_MB_DECISION_RD 2 ///< rate distortion
2283 * custom intra quantization matrix
2284 * - encoding: Set by user, can be NULL.
2285 * - decoding: Set by libavcodec.
2287 uint16_t *intra_matrix;
2290 * custom inter quantization matrix
2291 * - encoding: Set by user, can be NULL.
2292 * - decoding: Set by libavcodec.
2294 uint16_t *inter_matrix;
2296 #if FF_API_PRIVATE_OPT
2297 /** @deprecated use encoder private options instead */
2298 attribute_deprecated
2299 int scenechange_threshold;
2301 /** @deprecated use encoder private options instead */
2302 attribute_deprecated
2303 int noise_reduction;
2308 * @deprecated this field is unused
2310 attribute_deprecated
2314 * @deprecated this field is unused
2316 attribute_deprecated
2321 * precision of the intra DC coefficient - 8
2322 * - encoding: Set by user.
2323 * - decoding: Set by libavcodec
2325 int intra_dc_precision;
2328 * Number of macroblock rows at the top which are skipped.
2329 * - encoding: unused
2330 * - decoding: Set by user.
2335 * Number of macroblock rows at the bottom which are skipped.
2336 * - encoding: unused
2337 * - decoding: Set by user.
2343 * @deprecated use encoder private options instead
2345 attribute_deprecated
2346 float border_masking;
2350 * minimum MB Lagrange multiplier
2351 * - encoding: Set by user.
2352 * - decoding: unused
2357 * maximum MB Lagrange multiplier
2358 * - encoding: Set by user.
2359 * - decoding: unused
2363 #if FF_API_PRIVATE_OPT
2365 * @deprecated use encoder private options instead
2367 attribute_deprecated
2368 int me_penalty_compensation;
2372 * - encoding: Set by user.
2373 * - decoding: unused
2377 #if FF_API_PRIVATE_OPT
2378 /** @deprecated use encoder private options instead */
2379 attribute_deprecated
2385 * - encoding: Set by user.
2386 * - decoding: unused
2391 * number of reference frames
2392 * - encoding: Set by user.
2393 * - decoding: Set by lavc.
2397 #if FF_API_PRIVATE_OPT
2398 /** @deprecated use encoder private options instead */
2399 attribute_deprecated
2403 #if FF_API_UNUSED_MEMBERS
2405 * Multiplied by qscale for each frame and added to scene_change_score.
2406 * - encoding: Set by user.
2407 * - decoding: unused
2409 attribute_deprecated int scenechange_factor;
2413 * Note: Value depends upon the compare function used for fullpel ME.
2414 * - encoding: Set by user.
2415 * - decoding: unused
2419 #if FF_API_PRIVATE_OPT
2420 /** @deprecated use encoder private options instead */
2421 attribute_deprecated
2426 * Chromaticity coordinates of the source primaries.
2427 * - encoding: Set by user
2428 * - decoding: Set by libavcodec
2430 enum AVColorPrimaries color_primaries;
2433 * Color Transfer Characteristic.
2434 * - encoding: Set by user
2435 * - decoding: Set by libavcodec
2437 enum AVColorTransferCharacteristic color_trc;
2440 * YUV colorspace type.
2441 * - encoding: Set by user
2442 * - decoding: Set by libavcodec
2444 enum AVColorSpace colorspace;
2447 * MPEG vs JPEG YUV range.
2448 * - encoding: Set by user
2449 * - decoding: Set by libavcodec
2451 enum AVColorRange color_range;
2454 * This defines the location of chroma samples.
2455 * - encoding: Set by user
2456 * - decoding: Set by libavcodec
2458 enum AVChromaLocation chroma_sample_location;
2462 * Indicates number of picture subdivisions. Used for parallelized
2464 * - encoding: Set by user
2465 * - decoding: unused
2470 * - encoding: set by libavcodec
2471 * - decoding: Set by user.
2473 enum AVFieldOrder field_order;
2476 int sample_rate; ///< samples per second
2477 int channels; ///< number of audio channels
2480 * audio sample format
2481 * - encoding: Set by user.
2482 * - decoding: Set by libavcodec.
2484 enum AVSampleFormat sample_fmt; ///< sample format
2486 /* The following data should not be initialized. */
2488 * Number of samples per channel in an audio frame.
2490 * - encoding: set by libavcodec in avcodec_open2(). Each submitted frame
2491 * except the last must contain exactly frame_size samples per channel.
2492 * May be 0 when the codec has AV_CODEC_CAP_VARIABLE_FRAME_SIZE set, then the
2493 * frame size is not restricted.
2494 * - decoding: may be set by some decoders to indicate constant frame size
2499 * Frame counter, set by libavcodec.
2501 * - decoding: total number of frames returned from the decoder so far.
2502 * - encoding: total number of frames passed to the encoder so far.
2504 * @note the counter is not incremented if encoding/decoding resulted in
2510 * number of bytes per packet if constant and known or 0
2511 * Used by some WAV based audio codecs.
2516 * Audio cutoff bandwidth (0 means "automatic")
2517 * - encoding: Set by user.
2518 * - decoding: unused
2523 * Audio channel layout.
2524 * - encoding: set by user.
2525 * - decoding: set by user, may be overwritten by libavcodec.
2527 uint64_t channel_layout;
2530 * Request decoder to use this channel layout if it can (0 for default)
2531 * - encoding: unused
2532 * - decoding: Set by user.
2534 uint64_t request_channel_layout;
2537 * Type of service that the audio stream conveys.
2538 * - encoding: Set by user.
2539 * - decoding: Set by libavcodec.
2541 enum AVAudioServiceType audio_service_type;
2544 * desired sample format
2545 * - encoding: Not used.
2546 * - decoding: Set by user.
2547 * Decoder will decode to this format if it can.
2549 enum AVSampleFormat request_sample_fmt;
2552 * This callback is called at the beginning of each frame to get data
2553 * buffer(s) for it. There may be one contiguous buffer for all the data or
2554 * there may be a buffer per each data plane or anything in between. What
2555 * this means is, you may set however many entries in buf[] you feel necessary.
2556 * Each buffer must be reference-counted using the AVBuffer API (see description
2559 * The following fields will be set in the frame before this callback is
2562 * - width, height (video only)
2563 * - sample_rate, channel_layout, nb_samples (audio only)
2564 * Their values may differ from the corresponding values in
2565 * AVCodecContext. This callback must use the frame values, not the codec
2566 * context values, to calculate the required buffer size.
2568 * This callback must fill the following fields in the frame:
2572 * * if the data is planar audio with more than 8 channels, then this
2573 * callback must allocate and fill extended_data to contain all pointers
2574 * to all data planes. data[] must hold as many pointers as it can.
2575 * extended_data must be allocated with av_malloc() and will be freed in
2577 * * otherwise extended_data must point to data
2578 * - buf[] must contain one or more pointers to AVBufferRef structures. Each of
2579 * the frame's data and extended_data pointers must be contained in these. That
2580 * is, one AVBufferRef for each allocated chunk of memory, not necessarily one
2581 * AVBufferRef per data[] entry. See: av_buffer_create(), av_buffer_alloc(),
2582 * and av_buffer_ref().
2583 * - extended_buf and nb_extended_buf must be allocated with av_malloc() by
2584 * this callback and filled with the extra buffers if there are more
2585 * buffers than buf[] can hold. extended_buf will be freed in
2588 * If AV_CODEC_CAP_DR1 is not set then get_buffer2() must call
2589 * avcodec_default_get_buffer2() instead of providing buffers allocated by
2592 * Each data plane must be aligned to the maximum required by the target
2595 * @see avcodec_default_get_buffer2()
2599 * If AV_GET_BUFFER_FLAG_REF is set in flags then the frame may be reused
2600 * (read and/or written to if it is writable) later by libavcodec.
2602 * avcodec_align_dimensions2() should be used to find the required width and
2603 * height, as they normally need to be rounded up to the next multiple of 16.
2605 * Some decoders do not support linesizes changing between frames.
2607 * If frame multithreading is used and thread_safe_callbacks is set,
2608 * this callback may be called from a different thread, but not from more
2609 * than one at once. Does not need to be reentrant.
2611 * @see avcodec_align_dimensions2()
2615 * Decoders request a buffer of a particular size by setting
2616 * AVFrame.nb_samples prior to calling get_buffer2(). The decoder may,
2617 * however, utilize only part of the buffer by setting AVFrame.nb_samples
2618 * to a smaller value in the output frame.
2620 * As a convenience, av_samples_get_buffer_size() and
2621 * av_samples_fill_arrays() in libavutil may be used by custom get_buffer2()
2622 * functions to find the required data size and to fill data pointers and
2623 * linesize. In AVFrame.linesize, only linesize[0] may be set for audio
2624 * since all planes must be the same size.
2626 * @see av_samples_get_buffer_size(), av_samples_fill_arrays()
2628 * - encoding: unused
2629 * - decoding: Set by libavcodec, user can override.
2631 int (*get_buffer2)(struct AVCodecContext *s, AVFrame *frame, int flags);
2634 * If non-zero, the decoded audio and video frames returned from
2635 * avcodec_decode_video2() and avcodec_decode_audio4() are reference-counted
2636 * and are valid indefinitely. The caller must free them with
2637 * av_frame_unref() when they are not needed anymore.
2638 * Otherwise, the decoded frames must not be freed by the caller and are
2639 * only valid until the next decode call.
2641 * This is always automatically enabled if avcodec_receive_frame() is used.
2643 * - encoding: unused
2644 * - decoding: set by the caller before avcodec_open2().
2646 int refcounted_frames;
2648 /* - encoding parameters */
2649 float qcompress; ///< amount of qscale change between easy & hard scenes (0.0-1.0)
2650 float qblur; ///< amount of qscale smoothing over time (0.0-1.0)
2654 * - encoding: Set by user.
2655 * - decoding: unused
2661 * - encoding: Set by user.
2662 * - decoding: unused
2667 * maximum quantizer difference between frames
2668 * - encoding: Set by user.
2669 * - decoding: unused
2675 * @deprecated use encoder private options instead
2677 attribute_deprecated
2680 attribute_deprecated
2682 attribute_deprecated
2687 * decoder bitstream buffer size
2688 * - encoding: Set by user.
2689 * - decoding: unused
2694 * ratecontrol override, see RcOverride
2695 * - encoding: Allocated/set/freed by user.
2696 * - decoding: unused
2698 int rc_override_count;
2699 RcOverride *rc_override;
2703 * @deprecated use encoder private options instead
2705 attribute_deprecated
2711 * - encoding: Set by user.
2712 * - decoding: Set by user, may be overwritten by libavcodec.
2714 int64_t rc_max_rate;
2718 * - encoding: Set by user.
2719 * - decoding: unused
2721 int64_t rc_min_rate;
2725 * @deprecated use encoder private options instead
2727 attribute_deprecated
2728 float rc_buffer_aggressivity;
2730 attribute_deprecated
2731 float rc_initial_cplx;
2735 * Ratecontrol attempt to use, at maximum, <value> of what can be used without an underflow.
2736 * - encoding: Set by user.
2737 * - decoding: unused.
2739 float rc_max_available_vbv_use;
2742 * Ratecontrol attempt to use, at least, <value> times the amount needed to prevent a vbv overflow.
2743 * - encoding: Set by user.
2744 * - decoding: unused.
2746 float rc_min_vbv_overflow_use;
2749 * Number of bits which should be loaded into the rc buffer before decoding starts.
2750 * - encoding: Set by user.
2751 * - decoding: unused
2753 int rc_initial_buffer_occupancy;
2755 #if FF_API_CODER_TYPE
2756 #define FF_CODER_TYPE_VLC 0
2757 #define FF_CODER_TYPE_AC 1
2758 #define FF_CODER_TYPE_RAW 2
2759 #define FF_CODER_TYPE_RLE 3
2760 #if FF_API_UNUSED_MEMBERS
2761 #define FF_CODER_TYPE_DEFLATE 4
2762 #endif /* FF_API_UNUSED_MEMBERS */
2764 * @deprecated use encoder private options instead
2766 attribute_deprecated
2768 #endif /* FF_API_CODER_TYPE */
2770 #if FF_API_PRIVATE_OPT
2771 /** @deprecated use encoder private options instead */
2772 attribute_deprecated
2778 * @deprecated use encoder private options instead
2780 attribute_deprecated
2784 * @deprecated use encoder private options instead
2786 attribute_deprecated
2790 #if FF_API_PRIVATE_OPT
2791 /** @deprecated use encoder private options instead */
2792 attribute_deprecated
2793 int frame_skip_threshold;
2795 /** @deprecated use encoder private options instead */
2796 attribute_deprecated
2797 int frame_skip_factor;
2799 /** @deprecated use encoder private options instead */
2800 attribute_deprecated
2803 /** @deprecated use encoder private options instead */
2804 attribute_deprecated
2806 #endif /* FF_API_PRIVATE_OPT */
2809 * trellis RD quantization
2810 * - encoding: Set by user.
2811 * - decoding: unused
2815 #if FF_API_PRIVATE_OPT
2816 /** @deprecated use encoder private options instead */
2817 attribute_deprecated
2818 int min_prediction_order;
2820 /** @deprecated use encoder private options instead */
2821 attribute_deprecated
2822 int max_prediction_order;
2824 /** @deprecated use encoder private options instead */
2825 attribute_deprecated
2826 int64_t timecode_frame_start;
2829 #if FF_API_RTP_CALLBACK
2831 * @deprecated unused
2833 /* The RTP callback: This function is called */
2834 /* every time the encoder has a packet to send. */
2835 /* It depends on the encoder if the data starts */
2836 /* with a Start Code (it should). H.263 does. */
2837 /* mb_nb contains the number of macroblocks */
2838 /* encoded in the RTP payload. */
2839 attribute_deprecated
2840 void (*rtp_callback)(struct AVCodecContext *avctx, void *data, int size, int mb_nb);
2843 #if FF_API_PRIVATE_OPT
2844 /** @deprecated use encoder private options instead */
2845 attribute_deprecated
2846 int rtp_payload_size; /* The size of the RTP payload: the coder will */
2847 /* do its best to deliver a chunk with size */
2848 /* below rtp_payload_size, the chunk will start */
2849 /* with a start code on some codecs like H.263. */
2850 /* This doesn't take account of any particular */
2851 /* headers inside the transmitted RTP payload. */
2854 #if FF_API_STAT_BITS
2855 /* statistics, used for 2-pass encoding */
2856 attribute_deprecated
2858 attribute_deprecated
2860 attribute_deprecated
2862 attribute_deprecated
2864 attribute_deprecated
2866 attribute_deprecated
2868 attribute_deprecated
2870 attribute_deprecated
2873 /** @deprecated this field is unused */
2874 attribute_deprecated
2879 * pass1 encoding statistics output buffer
2880 * - encoding: Set by libavcodec.
2881 * - decoding: unused
2886 * pass2 encoding statistics input buffer
2887 * Concatenated stuff from stats_out of pass1 should be placed here.
2888 * - encoding: Allocated/set/freed by user.
2889 * - decoding: unused
2894 * Work around bugs in encoders which sometimes cannot be detected automatically.
2895 * - encoding: Set by user
2896 * - decoding: Set by user
2898 int workaround_bugs;
2899 #define FF_BUG_AUTODETECT 1 ///< autodetection
2900 #if FF_API_OLD_MSMPEG4
2901 #define FF_BUG_OLD_MSMPEG4 2
2903 #define FF_BUG_XVID_ILACE 4
2904 #define FF_BUG_UMP4 8
2905 #define FF_BUG_NO_PADDING 16
2906 #define FF_BUG_AMV 32
2908 #define FF_BUG_AC_VLC 0 ///< Will be removed, libavcodec can now handle these non-compliant files by default.
2910 #define FF_BUG_QPEL_CHROMA 64
2911 #define FF_BUG_STD_QPEL 128
2912 #define FF_BUG_QPEL_CHROMA2 256
2913 #define FF_BUG_DIRECT_BLOCKSIZE 512
2914 #define FF_BUG_EDGE 1024
2915 #define FF_BUG_HPEL_CHROMA 2048
2916 #define FF_BUG_DC_CLIP 4096
2917 #define FF_BUG_MS 8192 ///< Work around various bugs in Microsoft's broken decoders.
2918 #define FF_BUG_TRUNCATED 16384
2919 #define FF_BUG_IEDGE 32768
2922 * strictly follow the standard (MPEG-4, ...).
2923 * - encoding: Set by user.
2924 * - decoding: Set by user.
2925 * Setting this to STRICT or higher means the encoder and decoder will
2926 * generally do stupid things, whereas setting it to unofficial or lower
2927 * will mean the encoder might produce output that is not supported by all
2928 * spec-compliant decoders. Decoders don't differentiate between normal,
2929 * unofficial and experimental (that is, they always try to decode things
2930 * when they can) unless they are explicitly asked to behave stupidly
2931 * (=strictly conform to the specs)
2933 int strict_std_compliance;
2934 #define FF_COMPLIANCE_VERY_STRICT 2 ///< Strictly conform to an older more strict version of the spec or reference software.
2935 #define FF_COMPLIANCE_STRICT 1 ///< Strictly conform to all the things in the spec no matter what consequences.
2936 #define FF_COMPLIANCE_NORMAL 0
2937 #define FF_COMPLIANCE_UNOFFICIAL -1 ///< Allow unofficial extensions
2938 #define FF_COMPLIANCE_EXPERIMENTAL -2 ///< Allow nonstandardized experimental things.
2941 * error concealment flags
2942 * - encoding: unused
2943 * - decoding: Set by user.
2945 int error_concealment;
2946 #define FF_EC_GUESS_MVS 1
2947 #define FF_EC_DEBLOCK 2
2948 #define FF_EC_FAVOR_INTER 256
2952 * - encoding: Set by user.
2953 * - decoding: Set by user.
2956 #define FF_DEBUG_PICT_INFO 1
2957 #define FF_DEBUG_RC 2
2958 #define FF_DEBUG_BITSTREAM 4
2959 #define FF_DEBUG_MB_TYPE 8
2960 #define FF_DEBUG_QP 16
2963 * @deprecated this option does nothing
2965 #define FF_DEBUG_MV 32
2967 #define FF_DEBUG_DCT_COEFF 0x00000040
2968 #define FF_DEBUG_SKIP 0x00000080
2969 #define FF_DEBUG_STARTCODE 0x00000100
2970 #if FF_API_UNUSED_MEMBERS
2971 #define FF_DEBUG_PTS 0x00000200
2972 #endif /* FF_API_UNUSED_MEMBERS */
2973 #define FF_DEBUG_ER 0x00000400
2974 #define FF_DEBUG_MMCO 0x00000800
2975 #define FF_DEBUG_BUGS 0x00001000
2977 #define FF_DEBUG_VIS_QP 0x00002000
2978 #define FF_DEBUG_VIS_MB_TYPE 0x00004000
2980 #define FF_DEBUG_BUFFERS 0x00008000
2981 #define FF_DEBUG_THREADS 0x00010000
2982 #define FF_DEBUG_GREEN_MD 0x00800000
2983 #define FF_DEBUG_NOMC 0x01000000
2988 * - encoding: Set by user.
2989 * - decoding: Set by user.
2992 #define FF_DEBUG_VIS_MV_P_FOR 0x00000001 // visualize forward predicted MVs of P-frames
2993 #define FF_DEBUG_VIS_MV_B_FOR 0x00000002 // visualize forward predicted MVs of B-frames
2994 #define FF_DEBUG_VIS_MV_B_BACK 0x00000004 // visualize backward predicted MVs of B-frames
2998 * Error recognition; may misdetect some more or less valid parts as errors.
2999 * - encoding: unused
3000 * - decoding: Set by user.
3002 int err_recognition;
3005 * Verify checksums embedded in the bitstream (could be of either encoded or
3006 * decoded data, depending on the codec) and print an error message on mismatch.
3007 * If AV_EF_EXPLODE is also set, a mismatching checksum will result in the
3008 * decoder returning an error.
3010 #define AV_EF_CRCCHECK (1<<0)
3011 #define AV_EF_BITSTREAM (1<<1) ///< detect bitstream specification deviations
3012 #define AV_EF_BUFFER (1<<2) ///< detect improper bitstream length
3013 #define AV_EF_EXPLODE (1<<3) ///< abort decoding on minor error detection
3015 #define AV_EF_IGNORE_ERR (1<<15) ///< ignore errors and continue
3016 #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
3017 #define AV_EF_COMPLIANT (1<<17) ///< consider all spec non compliances as errors
3018 #define AV_EF_AGGRESSIVE (1<<18) ///< consider things that a sane encoder should not do as an error
3022 * opaque 64-bit number (generally a PTS) that will be reordered and
3023 * output in AVFrame.reordered_opaque
3024 * - encoding: unused
3025 * - decoding: Set by user.
3027 int64_t reordered_opaque;
3030 * Hardware accelerator in use
3031 * - encoding: unused.
3032 * - decoding: Set by libavcodec
3034 struct AVHWAccel *hwaccel;
3037 * Hardware accelerator context.
3038 * For some hardware accelerators, a global context needs to be
3039 * provided by the user. In that case, this holds display-dependent
3040 * data FFmpeg cannot instantiate itself. Please refer to the
3041 * FFmpeg HW accelerator documentation to know how to fill this
3042 * is. e.g. for VA API, this is a struct vaapi_context.
3043 * - encoding: unused
3044 * - decoding: Set by user
3046 void *hwaccel_context;
3050 * - encoding: Set by libavcodec if flags & AV_CODEC_FLAG_PSNR.
3051 * - decoding: unused
3053 uint64_t error[AV_NUM_DATA_POINTERS];
3056 * DCT algorithm, see FF_DCT_* below
3057 * - encoding: Set by user.
3058 * - decoding: unused
3061 #define FF_DCT_AUTO 0
3062 #define FF_DCT_FASTINT 1
3063 #define FF_DCT_INT 2
3064 #define FF_DCT_MMX 3
3065 #define FF_DCT_ALTIVEC 5
3066 #define FF_DCT_FAAN 6
3069 * IDCT algorithm, see FF_IDCT_* below.
3070 * - encoding: Set by user.
3071 * - decoding: Set by user.
3074 #define FF_IDCT_AUTO 0
3075 #define FF_IDCT_INT 1
3076 #define FF_IDCT_SIMPLE 2
3077 #define FF_IDCT_SIMPLEMMX 3
3078 #define FF_IDCT_ARM 7
3079 #define FF_IDCT_ALTIVEC 8
3081 #define FF_IDCT_SH4 9
3083 #define FF_IDCT_SIMPLEARM 10
3084 #if FF_API_UNUSED_MEMBERS
3085 #define FF_IDCT_IPP 13
3086 #endif /* FF_API_UNUSED_MEMBERS */
3087 #define FF_IDCT_XVID 14
3088 #if FF_API_IDCT_XVIDMMX
3089 #define FF_IDCT_XVIDMMX 14
3090 #endif /* FF_API_IDCT_XVIDMMX */
3091 #define FF_IDCT_SIMPLEARMV5TE 16
3092 #define FF_IDCT_SIMPLEARMV6 17
3093 #if FF_API_ARCH_SPARC
3094 #define FF_IDCT_SIMPLEVIS 18
3096 #define FF_IDCT_FAAN 20
3097 #define FF_IDCT_SIMPLENEON 22
3098 #if FF_API_ARCH_ALPHA
3099 #define FF_IDCT_SIMPLEALPHA 23
3101 #define FF_IDCT_SIMPLEAUTO 128
3104 * bits per sample/pixel from the demuxer (needed for huffyuv).
3105 * - encoding: Set by libavcodec.
3106 * - decoding: Set by user.
3108 int bits_per_coded_sample;
3111 * Bits per sample/pixel of internal libavcodec pixel/sample format.
3112 * - encoding: set by user.
3113 * - decoding: set by libavcodec.
3115 int bits_per_raw_sample;
3119 * low resolution decoding, 1-> 1/2 size, 2->1/4 size
3120 * - encoding: unused
3121 * - decoding: Set by user.
3126 #if FF_API_CODED_FRAME
3128 * the picture in the bitstream
3129 * - encoding: Set by libavcodec.
3130 * - decoding: unused
3132 * @deprecated use the quality factor packet side data instead
3134 attribute_deprecated AVFrame *coded_frame;
3139 * is used to decide how many independent tasks should be passed to execute()
3140 * - encoding: Set by user.
3141 * - decoding: Set by user.
3146 * Which multithreading methods to use.
3147 * Use of FF_THREAD_FRAME will increase decoding delay by one frame per thread,
3148 * so clients which cannot provide future frames should not use it.
3150 * - encoding: Set by user, otherwise the default is used.
3151 * - decoding: Set by user, otherwise the default is used.
3154 #define FF_THREAD_FRAME 1 ///< Decode more than one frame at once
3155 #define FF_THREAD_SLICE 2 ///< Decode more than one part of a single frame at once
3158 * Which multithreading methods are in use by the codec.
3159 * - encoding: Set by libavcodec.
3160 * - decoding: Set by libavcodec.
3162 int active_thread_type;
3165 * Set by the client if its custom get_buffer() callback can be called
3166 * synchronously from another thread, which allows faster multithreaded decoding.
3167 * draw_horiz_band() will be called from other threads regardless of this setting.
3168 * Ignored if the default get_buffer() is used.
3169 * - encoding: Set by user.
3170 * - decoding: Set by user.
3172 int thread_safe_callbacks;
3175 * The codec may call this to execute several independent things.
3176 * It will return only after finishing all tasks.
3177 * The user may replace this with some multithreaded implementation,
3178 * the default implementation will execute the parts serially.
3179 * @param count the number of things to execute
3180 * - encoding: Set by libavcodec, user can override.
3181 * - decoding: Set by libavcodec, user can override.
3183 int (*execute)(struct AVCodecContext *c, int (*func)(struct AVCodecContext *c2, void *arg), void *arg2, int *ret, int count, int size);
3186 * The codec may call this to execute several independent things.
3187 * It will return only after finishing all tasks.
3188 * The user may replace this with some multithreaded implementation,
3189 * the default implementation will execute the parts serially.
3190 * Also see avcodec_thread_init and e.g. the --enable-pthread configure option.
3191 * @param c context passed also to func
3192 * @param count the number of things to execute
3193 * @param arg2 argument passed unchanged to func
3194 * @param ret return values of executed functions, must have space for "count" values. May be NULL.
3195 * @param func function that will be called count times, with jobnr from 0 to count-1.
3196 * threadnr will be in the range 0 to c->thread_count-1 < MAX_THREADS and so that no
3197 * two instances of func executing at the same time will have the same threadnr.
3198 * @return always 0 currently, but code should handle a future improvement where when any call to func
3199 * returns < 0 no further calls to func may be done and < 0 is returned.
3200 * - encoding: Set by libavcodec, user can override.
3201 * - decoding: Set by libavcodec, user can override.
3203 int (*execute2)(struct AVCodecContext *c, int (*func)(struct AVCodecContext *c2, void *arg, int jobnr, int threadnr), void *arg2, int *ret, int count);
3206 * noise vs. sse weight for the nsse comparison function
3207 * - encoding: Set by user.
3208 * - decoding: unused
3214 * - encoding: Set by user.
3215 * - decoding: Set by libavcodec.
3218 #define FF_PROFILE_UNKNOWN -99
3219 #define FF_PROFILE_RESERVED -100
3221 #define FF_PROFILE_AAC_MAIN 0
3222 #define FF_PROFILE_AAC_LOW 1
3223 #define FF_PROFILE_AAC_SSR 2
3224 #define FF_PROFILE_AAC_LTP 3
3225 #define FF_PROFILE_AAC_HE 4
3226 #define FF_PROFILE_AAC_HE_V2 28
3227 #define FF_PROFILE_AAC_LD 22
3228 #define FF_PROFILE_AAC_ELD 38
3229 #define FF_PROFILE_MPEG2_AAC_LOW 128
3230 #define FF_PROFILE_MPEG2_AAC_HE 131
3232 #define FF_PROFILE_DNXHD 0
3233 #define FF_PROFILE_DNXHR_LB 1
3234 #define FF_PROFILE_DNXHR_SQ 2
3235 #define FF_PROFILE_DNXHR_HQ 3
3236 #define FF_PROFILE_DNXHR_HQX 4
3237 #define FF_PROFILE_DNXHR_444 5
3239 #define FF_PROFILE_DTS 20
3240 #define FF_PROFILE_DTS_ES 30
3241 #define FF_PROFILE_DTS_96_24 40
3242 #define FF_PROFILE_DTS_HD_HRA 50
3243 #define FF_PROFILE_DTS_HD_MA 60
3244 #define FF_PROFILE_DTS_EXPRESS 70
3246 #define FF_PROFILE_MPEG2_422 0
3247 #define FF_PROFILE_MPEG2_HIGH 1
3248 #define FF_PROFILE_MPEG2_SS 2
3249 #define FF_PROFILE_MPEG2_SNR_SCALABLE 3
3250 #define FF_PROFILE_MPEG2_MAIN 4
3251 #define FF_PROFILE_MPEG2_SIMPLE 5
3253 #define FF_PROFILE_H264_CONSTRAINED (1<<9) // 8+1; constraint_set1_flag
3254 #define FF_PROFILE_H264_INTRA (1<<11) // 8+3; constraint_set3_flag
3256 #define FF_PROFILE_H264_BASELINE 66
3257 #define FF_PROFILE_H264_CONSTRAINED_BASELINE (66|FF_PROFILE_H264_CONSTRAINED)
3258 #define FF_PROFILE_H264_MAIN 77
3259 #define FF_PROFILE_H264_EXTENDED 88
3260 #define FF_PROFILE_H264_HIGH 100
3261 #define FF_PROFILE_H264_HIGH_10 110
3262 #define FF_PROFILE_H264_HIGH_10_INTRA (110|FF_PROFILE_H264_INTRA)
3263 #define FF_PROFILE_H264_MULTIVIEW_HIGH 118
3264 #define FF_PROFILE_H264_HIGH_422 122
3265 #define FF_PROFILE_H264_HIGH_422_INTRA (122|FF_PROFILE_H264_INTRA)
3266 #define FF_PROFILE_H264_STEREO_HIGH 128
3267 #define FF_PROFILE_H264_HIGH_444 144
3268 #define FF_PROFILE_H264_HIGH_444_PREDICTIVE 244
3269 #define FF_PROFILE_H264_HIGH_444_INTRA (244|FF_PROFILE_H264_INTRA)
3270 #define FF_PROFILE_H264_CAVLC_444 44
3272 #define FF_PROFILE_VC1_SIMPLE 0
3273 #define FF_PROFILE_VC1_MAIN 1
3274 #define FF_PROFILE_VC1_COMPLEX 2
3275 #define FF_PROFILE_VC1_ADVANCED 3
3277 #define FF_PROFILE_MPEG4_SIMPLE 0
3278 #define FF_PROFILE_MPEG4_SIMPLE_SCALABLE 1
3279 #define FF_PROFILE_MPEG4_CORE 2
3280 #define FF_PROFILE_MPEG4_MAIN 3
3281 #define FF_PROFILE_MPEG4_N_BIT 4
3282 #define FF_PROFILE_MPEG4_SCALABLE_TEXTURE 5
3283 #define FF_PROFILE_MPEG4_SIMPLE_FACE_ANIMATION 6
3284 #define FF_PROFILE_MPEG4_BASIC_ANIMATED_TEXTURE 7
3285 #define FF_PROFILE_MPEG4_HYBRID 8
3286 #define FF_PROFILE_MPEG4_ADVANCED_REAL_TIME 9
3287 #define FF_PROFILE_MPEG4_CORE_SCALABLE 10
3288 #define FF_PROFILE_MPEG4_ADVANCED_CODING 11
3289 #define FF_PROFILE_MPEG4_ADVANCED_CORE 12
3290 #define FF_PROFILE_MPEG4_ADVANCED_SCALABLE_TEXTURE 13
3291 #define FF_PROFILE_MPEG4_SIMPLE_STUDIO 14
3292 #define FF_PROFILE_MPEG4_ADVANCED_SIMPLE 15
3294 #define FF_PROFILE_JPEG2000_CSTREAM_RESTRICTION_0 1
3295 #define FF_PROFILE_JPEG2000_CSTREAM_RESTRICTION_1 2
3296 #define FF_PROFILE_JPEG2000_CSTREAM_NO_RESTRICTION 32768
3297 #define FF_PROFILE_JPEG2000_DCINEMA_2K 3
3298 #define FF_PROFILE_JPEG2000_DCINEMA_4K 4
3300 #define FF_PROFILE_VP9_0 0
3301 #define FF_PROFILE_VP9_1 1
3302 #define FF_PROFILE_VP9_2 2
3303 #define FF_PROFILE_VP9_3 3
3305 #define FF_PROFILE_HEVC_MAIN 1
3306 #define FF_PROFILE_HEVC_MAIN_10 2
3307 #define FF_PROFILE_HEVC_MAIN_STILL_PICTURE 3
3308 #define FF_PROFILE_HEVC_REXT 4
3312 * - encoding: Set by user.
3313 * - decoding: Set by libavcodec.
3316 #define FF_LEVEL_UNKNOWN -99
3319 * Skip loop filtering for selected frames.
3320 * - encoding: unused
3321 * - decoding: Set by user.
3323 enum AVDiscard skip_loop_filter;
3326 * Skip IDCT/dequantization for selected frames.
3327 * - encoding: unused
3328 * - decoding: Set by user.
3330 enum AVDiscard skip_idct;
3333 * Skip decoding for selected frames.
3334 * - encoding: unused
3335 * - decoding: Set by user.
3337 enum AVDiscard skip_frame;
3340 * Header containing style information for text subtitles.
3341 * For SUBTITLE_ASS subtitle type, it should contain the whole ASS
3342 * [Script Info] and [V4+ Styles] section, plus the [Events] line and
3343 * the Format line following. It shouldn't include any Dialogue line.
3344 * - encoding: Set/allocated/freed by user (before avcodec_open2())
3345 * - decoding: Set/allocated/freed by libavcodec (by avcodec_open2())
3347 uint8_t *subtitle_header;
3348 int subtitle_header_size;
3350 #if FF_API_ERROR_RATE
3352 * @deprecated use the 'error_rate' private AVOption of the mpegvideo
3355 attribute_deprecated
3359 #if FF_API_VBV_DELAY
3361 * VBV delay coded in the last frame (in periods of a 27 MHz clock).
3362 * Used for compliant TS muxing.
3363 * - encoding: Set by libavcodec.
3364 * - decoding: unused.
3365 * @deprecated this value is now exported as a part of
3366 * AV_PKT_DATA_CPB_PROPERTIES packet side data
3368 attribute_deprecated
3372 #if FF_API_SIDEDATA_ONLY_PKT
3374 * Encoding only and set by default. Allow encoders to output packets
3375 * that do not contain any encoded data, only side data.
3377 * Some encoders need to output such packets, e.g. to update some stream
3378 * parameters at the end of encoding.
3380 * @deprecated this field disables the default behaviour and
3381 * it is kept only for compatibility.
3383 attribute_deprecated
3384 int side_data_only_packets;
3388 * Audio only. The number of "priming" samples (padding) inserted by the
3389 * encoder at the beginning of the audio. I.e. this number of leading
3390 * decoded samples must be discarded by the caller to get the original audio
3391 * without leading padding.
3393 * - decoding: unused
3394 * - encoding: Set by libavcodec. The timestamps on the output packets are
3395 * adjusted by the encoder so that they always refer to the
3396 * first sample of the data actually contained in the packet,
3397 * including any added padding. E.g. if the timebase is
3398 * 1/samplerate and the timestamp of the first input sample is
3399 * 0, the timestamp of the first output packet will be
3402 int initial_padding;
3405 * - decoding: For codecs that store a framerate value in the compressed
3406 * bitstream, the decoder may export it here. { 0, 1} when
3408 * - encoding: May be used to signal the framerate of CFR content to an
3411 AVRational framerate;
3414 * Nominal unaccelerated pixel format, see AV_PIX_FMT_xxx.
3415 * - encoding: unused.
3416 * - decoding: Set by libavcodec before calling get_format()
3418 enum AVPixelFormat sw_pix_fmt;
3421 * Timebase in which pkt_dts/pts and AVPacket.dts/pts are.
3422 * - encoding unused.
3423 * - decoding set by user.
3425 AVRational pkt_timebase;
3429 * - encoding: unused.
3430 * - decoding: set by libavcodec.
3432 const AVCodecDescriptor *codec_descriptor;
3436 * low resolution decoding, 1-> 1/2 size, 2->1/4 size
3437 * - encoding: unused
3438 * - decoding: Set by user.
3444 * Current statistics for PTS correction.
3445 * - decoding: maintained and used by libavcodec, not intended to be used by user apps
3446 * - encoding: unused
3448 int64_t pts_correction_num_faulty_pts; /// Number of incorrect PTS values so far
3449 int64_t pts_correction_num_faulty_dts; /// Number of incorrect DTS values so far
3450 int64_t pts_correction_last_pts; /// PTS of the last frame
3451 int64_t pts_correction_last_dts; /// DTS of the last frame
3454 * Character encoding of the input subtitles file.
3455 * - decoding: set by user
3456 * - encoding: unused
3461 * Subtitles character encoding mode. Formats or codecs might be adjusting
3462 * this setting (if they are doing the conversion themselves for instance).
3463 * - decoding: set by libavcodec
3464 * - encoding: unused
3466 int sub_charenc_mode;
3467 #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)
3468 #define FF_SUB_CHARENC_MODE_AUTOMATIC 0 ///< libavcodec will select the mode itself
3469 #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
3472 * Skip processing alpha if supported by codec.
3473 * Note that if the format uses pre-multiplied alpha (common with VP6,
3474 * and recommended due to better video quality/compression)
3475 * the image will look as if alpha-blended onto a black background.
3476 * However for formats that do not use pre-multiplied alpha
3477 * there might be serious artefacts (though e.g. libswscale currently
3478 * assumes pre-multiplied alpha anyway).
3480 * - decoding: set by user
3481 * - encoding: unused
3486 * Number of samples to skip after a discontinuity
3487 * - decoding: unused
3488 * - encoding: set by libavcodec
3492 #if !FF_API_DEBUG_MV
3494 * debug motion vectors
3495 * - encoding: Set by user.
3496 * - decoding: Set by user.
3499 #define FF_DEBUG_VIS_MV_P_FOR 0x00000001 //visualize forward predicted MVs of P frames
3500 #define FF_DEBUG_VIS_MV_B_FOR 0x00000002 //visualize forward predicted MVs of B frames
3501 #define FF_DEBUG_VIS_MV_B_BACK 0x00000004 //visualize backward predicted MVs of B frames
3505 * custom intra quantization matrix
3506 * - encoding: Set by user, can be NULL.
3507 * - decoding: unused.
3509 uint16_t *chroma_intra_matrix;
3512 * dump format separator.
3513 * can be ", " or "\n " or anything else
3514 * - encoding: Set by user.
3515 * - decoding: Set by user.
3517 uint8_t *dump_separator;
3520 * ',' separated list of allowed decoders.
3521 * If NULL then all are allowed
3522 * - encoding: unused
3523 * - decoding: set by user
3525 char *codec_whitelist;
3528 * Properties of the stream that gets decoded
3529 * - encoding: unused
3530 * - decoding: set by libavcodec
3532 unsigned properties;
3533 #define FF_CODEC_PROPERTY_LOSSLESS 0x00000001
3534 #define FF_CODEC_PROPERTY_CLOSED_CAPTIONS 0x00000002
3537 * Additional data associated with the entire coded stream.
3539 * - decoding: unused
3540 * - encoding: may be set by libavcodec after avcodec_open2().
3542 AVPacketSideData *coded_side_data;
3543 int nb_coded_side_data;
3546 * A reference to the AVHWFramesContext describing the input (for encoding)
3547 * or output (decoding) frames. The reference is set by the caller and
3548 * afterwards owned (and freed) by libavcodec - it should never be read by
3549 * the caller after being set.
3551 * - decoding: This field should be set by the caller from the get_format()
3552 * callback. The previous reference (if any) will always be
3553 * unreffed by libavcodec before the get_format() call.
3555 * If the default get_buffer2() is used with a hwaccel pixel
3556 * format, then this AVHWFramesContext will be used for
3557 * allocating the frame buffers.
3559 * - encoding: For hardware encoders configured to use a hwaccel pixel
3560 * format, this field should be set by the caller to a reference
3561 * to the AVHWFramesContext describing input frames.
3562 * AVHWFramesContext.format must be equal to
3563 * AVCodecContext.pix_fmt.
3565 * This field should be set before avcodec_open2() is called.
3567 AVBufferRef *hw_frames_ctx;
3570 * Control the form of AVSubtitle.rects[N]->ass
3571 * - decoding: set by user
3572 * - encoding: unused
3574 int sub_text_format;
3575 #define FF_SUB_TEXT_FMT_ASS 0
3576 #if FF_API_ASS_TIMING
3577 #define FF_SUB_TEXT_FMT_ASS_WITH_TIMINGS 1
3581 * Audio only. The amount of padding (in samples) appended by the encoder to
3582 * the end of the audio. I.e. this number of decoded samples must be
3583 * discarded by the caller from the end of the stream to get the original
3584 * audio without any trailing padding.
3586 * - decoding: unused
3587 * - encoding: unused
3589 int trailing_padding;
3592 * The number of pixels per image to maximally accept.
3594 * - decoding: set by user
3595 * - encoding: set by user
3600 * A reference to the AVHWDeviceContext describing the device which will
3601 * be used by a hardware encoder/decoder. The reference is set by the
3602 * caller and afterwards owned (and freed) by libavcodec.
3604 * This should be used if either the codec device does not require
3605 * hardware frames or any that are used are to be allocated internally by
3606 * libavcodec. If the user wishes to supply any of the frames used as
3607 * encoder input or decoder output then hw_frames_ctx should be used
3608 * instead. When hw_frames_ctx is set in get_format() for a decoder, this
3609 * field will be ignored while decoding the associated stream segment, but
3610 * may again be used on a following one after another get_format() call.
3612 * For both encoders and decoders this field should be set before
3613 * avcodec_open2() is called and must not be written to thereafter.
3615 * Note that some decoders may require this field to be set initially in
3616 * order to support hw_frames_ctx at all - in that case, all frames
3617 * contexts used must be created on the same device.
3619 AVBufferRef *hw_device_ctx;
3622 AVRational av_codec_get_pkt_timebase (const AVCodecContext *avctx);
3623 void av_codec_set_pkt_timebase (AVCodecContext *avctx, AVRational val);
3625 const AVCodecDescriptor *av_codec_get_codec_descriptor(const AVCodecContext *avctx);
3626 void av_codec_set_codec_descriptor(AVCodecContext *avctx, const AVCodecDescriptor *desc);
3628 unsigned av_codec_get_codec_properties(const AVCodecContext *avctx);
3630 int av_codec_get_lowres(const AVCodecContext *avctx);
3631 void av_codec_set_lowres(AVCodecContext *avctx, int val);
3633 int av_codec_get_seek_preroll(const AVCodecContext *avctx);
3634 void av_codec_set_seek_preroll(AVCodecContext *avctx, int val);
3636 uint16_t *av_codec_get_chroma_intra_matrix(const AVCodecContext *avctx);
3637 void av_codec_set_chroma_intra_matrix(AVCodecContext *avctx, uint16_t *val);
3642 typedef struct AVProfile {
3644 const char *name; ///< short name for the profile
3647 typedef struct AVCodecDefault AVCodecDefault;
3654 typedef struct AVCodec {
3656 * Name of the codec implementation.
3657 * The name is globally unique among encoders and among decoders (but an
3658 * encoder and a decoder can share the same name).
3659 * This is the primary way to find a codec from the user perspective.
3663 * Descriptive name for the codec, meant to be more human readable than name.
3664 * You should use the NULL_IF_CONFIG_SMALL() macro to define it.
3666 const char *long_name;
3667 enum AVMediaType type;
3670 * Codec capabilities.
3671 * see AV_CODEC_CAP_*
3674 const AVRational *supported_framerates; ///< array of supported framerates, or NULL if any, array is terminated by {0,0}
3675 const enum AVPixelFormat *pix_fmts; ///< array of supported pixel formats, or NULL if unknown, array is terminated by -1
3676 const int *supported_samplerates; ///< array of supported audio samplerates, or NULL if unknown, array is terminated by 0
3677 const enum AVSampleFormat *sample_fmts; ///< array of supported sample formats, or NULL if unknown, array is terminated by -1
3678 const uint64_t *channel_layouts; ///< array of support channel layouts, or NULL if unknown. array is terminated by 0
3679 uint8_t max_lowres; ///< maximum value for lowres supported by the decoder
3680 const AVClass *priv_class; ///< AVClass for the private context
3681 const AVProfile *profiles; ///< array of recognized profiles, or NULL if unknown, array is terminated by {FF_PROFILE_UNKNOWN}
3683 /*****************************************************************
3684 * No fields below this line are part of the public API. They
3685 * may not be used outside of libavcodec and can be changed and
3687 * New public fields should be added right above.
3688 *****************************************************************
3691 struct AVCodec *next;
3693 * @name Frame-level threading support functions
3697 * If defined, called on thread contexts when they are created.
3698 * If the codec allocates writable tables in init(), re-allocate them here.
3699 * priv_data will be set to a copy of the original.
3701 int (*init_thread_copy)(AVCodecContext *);
3703 * Copy necessary context variables from a previous thread context to the current one.
3704 * If not defined, the next thread will start automatically; otherwise, the codec
3705 * must call ff_thread_finish_setup().
3707 * dst and src will (rarely) point to the same context, in which case memcpy should be skipped.
3709 int (*update_thread_context)(AVCodecContext *dst, const AVCodecContext *src);
3713 * Private codec-specific defaults.
3715 const AVCodecDefault *defaults;
3718 * Initialize codec static data, called from avcodec_register().
3720 void (*init_static_data)(struct AVCodec *codec);
3722 int (*init)(AVCodecContext *);
3723 int (*encode_sub)(AVCodecContext *, uint8_t *buf, int buf_size,
3724 const struct AVSubtitle *sub);
3726 * Encode data to an AVPacket.
3728 * @param avctx codec context
3729 * @param avpkt output AVPacket (may contain a user-provided buffer)
3730 * @param[in] frame AVFrame containing the raw data to be encoded
3731 * @param[out] got_packet_ptr encoder sets to 0 or 1 to indicate that a
3732 * non-empty packet was returned in avpkt.
3733 * @return 0 on success, negative error code on failure
3735 int (*encode2)(AVCodecContext *avctx, AVPacket *avpkt, const AVFrame *frame,
3736 int *got_packet_ptr);
3737 int (*decode)(AVCodecContext *, void *outdata, int *outdata_size, AVPacket *avpkt);
3738 int (*close)(AVCodecContext *);
3740 * Decode/encode API with decoupled packet/frame dataflow. The API is the
3741 * same as the avcodec_ prefixed APIs (avcodec_send_frame() etc.), except
3743 * - never called if the codec is closed or the wrong type,
3744 * - AVPacket parameter change side data is applied right before calling
3745 * AVCodec->send_packet,
3746 * - if AV_CODEC_CAP_DELAY is not set, drain packets or frames are never sent,
3747 * - only one drain packet is ever passed down (until the next flush()),
3748 * - a drain AVPacket is always NULL (no need to check for avpkt->size).
3750 int (*send_frame)(AVCodecContext *avctx, const AVFrame *frame);
3751 int (*send_packet)(AVCodecContext *avctx, const AVPacket *avpkt);
3752 int (*receive_frame)(AVCodecContext *avctx, AVFrame *frame);
3753 int (*receive_packet)(AVCodecContext *avctx, AVPacket *avpkt);
3756 * Will be called when seeking
3758 void (*flush)(AVCodecContext *);
3760 * Internal codec capabilities.
3761 * See FF_CODEC_CAP_* in internal.h
3766 int av_codec_get_max_lowres(const AVCodec *codec);
3768 struct MpegEncContext;
3771 * @defgroup lavc_hwaccel AVHWAccel
3774 typedef struct AVHWAccel {
3776 * Name of the hardware accelerated codec.
3777 * The name is globally unique among encoders and among decoders (but an
3778 * encoder and a decoder can share the same name).
3783 * Type of codec implemented by the hardware accelerator.
3785 * See AVMEDIA_TYPE_xxx
3787 enum AVMediaType type;
3790 * Codec implemented by the hardware accelerator.
3792 * See AV_CODEC_ID_xxx
3797 * Supported pixel format.
3799 * Only hardware accelerated formats are supported here.
3801 enum AVPixelFormat pix_fmt;
3804 * Hardware accelerated codec capabilities.
3805 * see HWACCEL_CODEC_CAP_*
3809 /*****************************************************************
3810 * No fields below this line are part of the public API. They
3811 * may not be used outside of libavcodec and can be changed and
3813 * New public fields should be added right above.
3814 *****************************************************************
3816 struct AVHWAccel *next;
3819 * Allocate a custom buffer
3821 int (*alloc_frame)(AVCodecContext *avctx, AVFrame *frame);
3824 * Called at the beginning of each frame or field picture.
3826 * Meaningful frame information (codec specific) is guaranteed to
3827 * be parsed at this point. This function is mandatory.
3829 * Note that buf can be NULL along with buf_size set to 0.
3830 * Otherwise, this means the whole frame is available at this point.
3832 * @param avctx the codec context
3833 * @param buf the frame data buffer base
3834 * @param buf_size the size of the frame in bytes
3835 * @return zero if successful, a negative value otherwise
3837 int (*start_frame)(AVCodecContext *avctx, const uint8_t *buf, uint32_t buf_size);
3840 * Callback for each slice.
3842 * Meaningful slice information (codec specific) is guaranteed to
3843 * be parsed at this point. This function is mandatory.
3844 * The only exception is XvMC, that works on MB level.
3846 * @param avctx the codec context
3847 * @param buf the slice data buffer base
3848 * @param buf_size the size of the slice in bytes
3849 * @return zero if successful, a negative value otherwise
3851 int (*decode_slice)(AVCodecContext *avctx, const uint8_t *buf, uint32_t buf_size);
3854 * Called at the end of each frame or field picture.
3856 * The whole picture is parsed at this point and can now be sent
3857 * to the hardware accelerator. This function is mandatory.
3859 * @param avctx the codec context
3860 * @return zero if successful, a negative value otherwise
3862 int (*end_frame)(AVCodecContext *avctx);
3865 * Size of per-frame hardware accelerator private data.
3867 * Private data is allocated with av_mallocz() before
3868 * AVCodecContext.get_buffer() and deallocated after
3869 * AVCodecContext.release_buffer().
3871 int frame_priv_data_size;
3874 * Called for every Macroblock in a slice.
3876 * XvMC uses it to replace the ff_mpv_decode_mb().
3877 * Instead of decoding to raw picture, MB parameters are
3878 * stored in an array provided by the video driver.
3880 * @param s the mpeg context
3882 void (*decode_mb)(struct MpegEncContext *s);
3885 * Initialize the hwaccel private data.
3887 * This will be called from ff_get_format(), after hwaccel and
3888 * hwaccel_context are set and the hwaccel private data in AVCodecInternal
3891 int (*init)(AVCodecContext *avctx);
3894 * Uninitialize the hwaccel private data.
3896 * This will be called from get_format() or avcodec_close(), after hwaccel
3897 * and hwaccel_context are already uninitialized.
3899 int (*uninit)(AVCodecContext *avctx);
3902 * Size of the private data to allocate in
3903 * AVCodecInternal.hwaccel_priv_data.
3909 * Hardware acceleration should be used for decoding even if the codec level
3910 * used is unknown or higher than the maximum supported level reported by the
3913 * It's generally a good idea to pass this flag unless you have a specific
3914 * reason not to, as hardware tends to under-report supported levels.
3916 #define AV_HWACCEL_FLAG_IGNORE_LEVEL (1 << 0)
3919 * Hardware acceleration can output YUV pixel formats with a different chroma
3920 * sampling than 4:2:0 and/or other than 8 bits per component.
3922 #define AV_HWACCEL_FLAG_ALLOW_HIGH_DEPTH (1 << 1)
3928 #if FF_API_AVPICTURE
3930 * @defgroup lavc_picture AVPicture
3932 * Functions for working with AVPicture
3937 * Picture data structure.
3939 * Up to four components can be stored into it, the last component is
3941 * @deprecated use AVFrame or imgutils functions instead
3943 typedef struct AVPicture {
3944 attribute_deprecated
3945 uint8_t *data[AV_NUM_DATA_POINTERS]; ///< pointers to the image data planes
3946 attribute_deprecated
3947 int linesize[AV_NUM_DATA_POINTERS]; ///< number of bytes per line
3955 enum AVSubtitleType {
3958 SUBTITLE_BITMAP, ///< A bitmap, pict will be set
3961 * Plain text, the text field must be set by the decoder and is
3962 * authoritative. ass and pict fields may contain approximations.
3967 * Formatted text, the ass field must be set by the decoder and is
3968 * authoritative. pict and text fields may contain approximations.
3973 #define AV_SUBTITLE_FLAG_FORCED 0x00000001
3975 typedef struct AVSubtitleRect {
3976 int x; ///< top left corner of pict, undefined when pict is not set
3977 int y; ///< top left corner of pict, undefined when pict is not set
3978 int w; ///< width of pict, undefined when pict is not set
3979 int h; ///< height of pict, undefined when pict is not set
3980 int nb_colors; ///< number of colors in pict, undefined when pict is not set
3982 #if FF_API_AVPICTURE
3984 * @deprecated unused
3986 attribute_deprecated
3990 * data+linesize for the bitmap of this subtitle.
3991 * Can be set for text/ass as well once they are rendered.
3996 enum AVSubtitleType type;
3998 char *text; ///< 0 terminated plain UTF-8 text
4001 * 0 terminated ASS/SSA compatible event line.
4002 * The presentation of this is unaffected by the other values in this
4010 typedef struct AVSubtitle {
4011 uint16_t format; /* 0 = graphics */
4012 uint32_t start_display_time; /* relative to packet pts, in ms */
4013 uint32_t end_display_time; /* relative to packet pts, in ms */
4015 AVSubtitleRect **rects;
4016 int64_t pts; ///< Same as packet pts, in AV_TIME_BASE
4020 * This struct describes the properties of an encoded stream.
4022 * sizeof(AVCodecParameters) is not a part of the public ABI, this struct must
4023 * be allocated with avcodec_parameters_alloc() and freed with
4024 * avcodec_parameters_free().
4026 typedef struct AVCodecParameters {
4028 * General type of the encoded data.
4030 enum AVMediaType codec_type;
4032 * Specific type of the encoded data (the codec used).
4034 enum AVCodecID codec_id;
4036 * Additional information about the codec (corresponds to the AVI FOURCC).
4041 * Extra binary data needed for initializing the decoder, codec-dependent.
4043 * Must be allocated with av_malloc() and will be freed by
4044 * avcodec_parameters_free(). The allocated size of extradata must be at
4045 * least extradata_size + AV_INPUT_BUFFER_PADDING_SIZE, with the padding
4050 * Size of the extradata content in bytes.
4055 * - video: the pixel format, the value corresponds to enum AVPixelFormat.
4056 * - audio: the sample format, the value corresponds to enum AVSampleFormat.
4061 * The average bitrate of the encoded data (in bits per second).
4066 * The number of bits per sample in the codedwords.
4068 * This is basically the bitrate per sample. It is mandatory for a bunch of
4069 * formats to actually decode them. It's the number of bits for one sample in
4070 * the actual coded bitstream.
4072 * This could be for example 4 for ADPCM
4073 * For PCM formats this matches bits_per_raw_sample
4076 int bits_per_coded_sample;
4079 * This is the number of valid bits in each output sample. If the
4080 * sample format has more bits, the least significant bits are additional
4081 * padding bits, which are always 0. Use right shifts to reduce the sample
4082 * to its actual size. For example, audio formats with 24 bit samples will
4083 * have bits_per_raw_sample set to 24, and format set to AV_SAMPLE_FMT_S32.
4084 * To get the original sample use "(int32_t)sample >> 8"."
4086 * For ADPCM this might be 12 or 16 or similar
4089 int bits_per_raw_sample;
4092 * Codec-specific bitstream restrictions that the stream conforms to.
4098 * Video only. The dimensions of the video frame in pixels.
4104 * Video only. The aspect ratio (width / height) which a single pixel
4105 * should have when displayed.
4107 * When the aspect ratio is unknown / undefined, the numerator should be
4108 * set to 0 (the denominator may have any value).
4110 AVRational sample_aspect_ratio;
4113 * Video only. The order of the fields in interlaced video.
4115 enum AVFieldOrder field_order;
4118 * Video only. Additional colorspace characteristics.
4120 enum AVColorRange color_range;
4121 enum AVColorPrimaries color_primaries;
4122 enum AVColorTransferCharacteristic color_trc;
4123 enum AVColorSpace color_space;
4124 enum AVChromaLocation chroma_location;
4127 * Video only. Number of delayed frames.
4132 * Audio only. The channel layout bitmask. May be 0 if the channel layout is
4133 * unknown or unspecified, otherwise the number of bits set must be equal to
4134 * the channels field.
4136 uint64_t channel_layout;
4138 * Audio only. The number of audio channels.
4142 * Audio only. The number of audio samples per second.
4146 * Audio only. The number of bytes per coded audio frame, required by some
4149 * Corresponds to nBlockAlign in WAVEFORMATEX.
4153 * Audio only. Audio frame size, if known. Required by some formats to be static.
4158 * Audio only. The amount of padding (in samples) inserted by the encoder at
4159 * the beginning of the audio. I.e. this number of leading decoded samples
4160 * must be discarded by the caller to get the original audio without leading
4163 int initial_padding;
4165 * Audio only. The amount of padding (in samples) appended by the encoder to
4166 * the end of the audio. I.e. this number of decoded samples must be
4167 * discarded by the caller from the end of the stream to get the original
4168 * audio without any trailing padding.
4170 int trailing_padding;
4172 * Audio only. Number of samples to skip after a discontinuity.
4175 } AVCodecParameters;
4178 * If c is NULL, returns the first registered codec,
4179 * if c is non-NULL, returns the next registered codec after c,
4180 * or NULL if c is the last one.
4182 AVCodec *av_codec_next(const AVCodec *c);
4185 * Return the LIBAVCODEC_VERSION_INT constant.
4187 unsigned avcodec_version(void);
4190 * Return the libavcodec build-time configuration.
4192 const char *avcodec_configuration(void);
4195 * Return the libavcodec license.
4197 const char *avcodec_license(void);
4200 * Register the codec codec and initialize libavcodec.
4202 * @warning either this function or avcodec_register_all() must be called
4203 * before any other libavcodec functions.
4205 * @see avcodec_register_all()
4207 void avcodec_register(AVCodec *codec);
4210 * Register all the codecs, parsers and bitstream filters which were enabled at
4211 * configuration time. If you do not call this function you can select exactly
4212 * which formats you want to support, by using the individual registration
4215 * @see avcodec_register
4216 * @see av_register_codec_parser
4217 * @see av_register_bitstream_filter
4219 void avcodec_register_all(void);
4222 * Allocate an AVCodecContext and set its fields to default values. The
4223 * resulting struct should be freed with avcodec_free_context().
4225 * @param codec if non-NULL, allocate private data and initialize defaults
4226 * for the given codec. It is illegal to then call avcodec_open2()
4227 * with a different codec.
4228 * If NULL, then the codec-specific defaults won't be initialized,
4229 * which may result in suboptimal default settings (this is
4230 * important mainly for encoders, e.g. libx264).
4232 * @return An AVCodecContext filled with default values or NULL on failure.
4234 AVCodecContext *avcodec_alloc_context3(const AVCodec *codec);
4237 * Free the codec context and everything associated with it and write NULL to
4238 * the provided pointer.
4240 void avcodec_free_context(AVCodecContext **avctx);
4242 #if FF_API_GET_CONTEXT_DEFAULTS
4244 * @deprecated This function should not be used, as closing and opening a codec
4245 * context multiple time is not supported. A new codec context should be
4246 * allocated for each new use.
4248 int avcodec_get_context_defaults3(AVCodecContext *s, const AVCodec *codec);
4252 * Get the AVClass for AVCodecContext. It can be used in combination with
4253 * AV_OPT_SEARCH_FAKE_OBJ for examining options.
4255 * @see av_opt_find().
4257 const AVClass *avcodec_get_class(void);
4259 #if FF_API_COPY_CONTEXT
4261 * Get the AVClass for AVFrame. It can be used in combination with
4262 * AV_OPT_SEARCH_FAKE_OBJ for examining options.
4264 * @see av_opt_find().
4266 const AVClass *avcodec_get_frame_class(void);
4269 * Get the AVClass for AVSubtitleRect. It can be used in combination with
4270 * AV_OPT_SEARCH_FAKE_OBJ for examining options.
4272 * @see av_opt_find().
4274 const AVClass *avcodec_get_subtitle_rect_class(void);
4277 * Copy the settings of the source AVCodecContext into the destination
4278 * AVCodecContext. The resulting destination codec context will be
4279 * unopened, i.e. you are required to call avcodec_open2() before you
4280 * can use this AVCodecContext to decode/encode video/audio data.
4282 * @param dest target codec context, should be initialized with
4283 * avcodec_alloc_context3(NULL), but otherwise uninitialized
4284 * @param src source codec context
4285 * @return AVERROR() on error (e.g. memory allocation error), 0 on success
4287 * @deprecated The semantics of this function are ill-defined and it should not
4288 * be used. If you need to transfer the stream parameters from one codec context
4289 * to another, use an intermediate AVCodecParameters instance and the
4290 * avcodec_parameters_from_context() / avcodec_parameters_to_context()
4293 attribute_deprecated
4294 int avcodec_copy_context(AVCodecContext *dest, const AVCodecContext *src);
4298 * Allocate a new AVCodecParameters and set its fields to default values
4299 * (unknown/invalid/0). The returned struct must be freed with
4300 * avcodec_parameters_free().
4302 AVCodecParameters *avcodec_parameters_alloc(void);
4305 * Free an AVCodecParameters instance and everything associated with it and
4306 * write NULL to the supplied pointer.
4308 void avcodec_parameters_free(AVCodecParameters **par);
4311 * Copy the contents of src to dst. Any allocated fields in dst are freed and
4312 * replaced with newly allocated duplicates of the corresponding fields in src.
4314 * @return >= 0 on success, a negative AVERROR code on failure.
4316 int avcodec_parameters_copy(AVCodecParameters *dst, const AVCodecParameters *src);
4319 * Fill the parameters struct based on the values from the supplied codec
4320 * context. Any allocated fields in par are freed and replaced with duplicates
4321 * of the corresponding fields in codec.
4323 * @return >= 0 on success, a negative AVERROR code on failure
4325 int avcodec_parameters_from_context(AVCodecParameters *par,
4326 const AVCodecContext *codec);
4329 * Fill the codec context based on the values from the supplied codec
4330 * parameters. Any allocated fields in codec that have a corresponding field in
4331 * par are freed and replaced with duplicates of the corresponding field in par.
4332 * Fields in codec that do not have a counterpart in par are not touched.
4334 * @return >= 0 on success, a negative AVERROR code on failure.
4336 int avcodec_parameters_to_context(AVCodecContext *codec,
4337 const AVCodecParameters *par);
4340 * Initialize the AVCodecContext to use the given AVCodec. Prior to using this
4341 * function the context has to be allocated with avcodec_alloc_context3().
4343 * The functions avcodec_find_decoder_by_name(), avcodec_find_encoder_by_name(),
4344 * avcodec_find_decoder() and avcodec_find_encoder() provide an easy way for
4345 * retrieving a codec.
4347 * @warning This function is not thread safe!
4349 * @note Always call this function before using decoding routines (such as
4350 * @ref avcodec_receive_frame()).
4353 * avcodec_register_all();
4354 * av_dict_set(&opts, "b", "2.5M", 0);
4355 * codec = avcodec_find_decoder(AV_CODEC_ID_H264);
4359 * context = avcodec_alloc_context3(codec);
4361 * if (avcodec_open2(context, codec, opts) < 0)
4365 * @param avctx The context to initialize.
4366 * @param codec The codec to open this context for. If a non-NULL codec has been
4367 * previously passed to avcodec_alloc_context3() or
4368 * for this context, then this parameter MUST be either NULL or
4369 * equal to the previously passed codec.
4370 * @param options A dictionary filled with AVCodecContext and codec-private options.
4371 * On return this object will be filled with options that were not found.
4373 * @return zero on success, a negative value on error
4374 * @see avcodec_alloc_context3(), avcodec_find_decoder(), avcodec_find_encoder(),
4375 * av_dict_set(), av_opt_find().
4377 int avcodec_open2(AVCodecContext *avctx, const AVCodec *codec, AVDictionary **options);
4380 * Close a given AVCodecContext and free all the data associated with it
4381 * (but not the AVCodecContext itself).
4383 * Calling this function on an AVCodecContext that hasn't been opened will free
4384 * the codec-specific data allocated in avcodec_alloc_context3() with a non-NULL
4385 * codec. Subsequent calls will do nothing.
4387 * @note Do not use this function. Use avcodec_free_context() to destroy a
4388 * codec context (either open or closed). Opening and closing a codec context
4389 * multiple times is not supported anymore -- use multiple codec contexts
4392 int avcodec_close(AVCodecContext *avctx);
4395 * Free all allocated data in the given subtitle struct.
4397 * @param sub AVSubtitle to free.
4399 void avsubtitle_free(AVSubtitle *sub);
4406 * @addtogroup lavc_packet
4411 * Allocate an AVPacket and set its fields to default values. The resulting
4412 * struct must be freed using av_packet_free().
4414 * @return An AVPacket filled with default values or NULL on failure.
4416 * @note this only allocates the AVPacket itself, not the data buffers. Those
4417 * must be allocated through other means such as av_new_packet.
4419 * @see av_new_packet
4421 AVPacket *av_packet_alloc(void);
4424 * Create a new packet that references the same data as src.
4426 * This is a shortcut for av_packet_alloc()+av_packet_ref().
4428 * @return newly created AVPacket on success, NULL on error.
4430 * @see av_packet_alloc
4431 * @see av_packet_ref
4433 AVPacket *av_packet_clone(AVPacket *src);
4436 * Free the packet, if the packet is reference counted, it will be
4437 * unreferenced first.
4439 * @param packet packet to be freed. The pointer will be set to NULL.
4440 * @note passing NULL is a no-op.
4442 void av_packet_free(AVPacket **pkt);
4445 * Initialize optional fields of a packet with default values.
4447 * Note, this does not touch the data and size members, which have to be
4448 * initialized separately.
4452 void av_init_packet(AVPacket *pkt);
4455 * Allocate the payload of a packet and initialize its fields with
4459 * @param size wanted payload size
4460 * @return 0 if OK, AVERROR_xxx otherwise
4462 int av_new_packet(AVPacket *pkt, int size);
4465 * Reduce packet size, correctly zeroing padding
4468 * @param size new size
4470 void av_shrink_packet(AVPacket *pkt, int size);
4473 * Increase packet size, correctly zeroing padding
4476 * @param grow_by number of bytes by which to increase the size of the packet
4478 int av_grow_packet(AVPacket *pkt, int grow_by);
4481 * Initialize a reference-counted packet from av_malloc()ed data.
4483 * @param pkt packet to be initialized. This function will set the data, size,
4484 * buf and destruct fields, all others are left untouched.
4485 * @param data Data allocated by av_malloc() to be used as packet data. If this
4486 * function returns successfully, the data is owned by the underlying AVBuffer.
4487 * The caller may not access the data through other means.
4488 * @param size size of data in bytes, without the padding. I.e. the full buffer
4489 * size is assumed to be size + AV_INPUT_BUFFER_PADDING_SIZE.
4491 * @return 0 on success, a negative AVERROR on error
4493 int av_packet_from_data(AVPacket *pkt, uint8_t *data, int size);
4495 #if FF_API_AVPACKET_OLD_API
4497 * @warning This is a hack - the packet memory allocation stuff is broken. The
4498 * packet is allocated if it was not really allocated.
4500 * @deprecated Use av_packet_ref
4502 attribute_deprecated
4503 int av_dup_packet(AVPacket *pkt);
4505 * Copy packet, including contents
4507 * @return 0 on success, negative AVERROR on fail
4509 int av_copy_packet(AVPacket *dst, const AVPacket *src);
4512 * Copy packet side data
4514 * @return 0 on success, negative AVERROR on fail
4516 int av_copy_packet_side_data(AVPacket *dst, const AVPacket *src);
4521 * @deprecated Use av_packet_unref
4523 * @param pkt packet to free
4525 attribute_deprecated
4526 void av_free_packet(AVPacket *pkt);
4529 * Allocate new information of a packet.
4532 * @param type side information type
4533 * @param size side information size
4534 * @return pointer to fresh allocated data or NULL otherwise
4536 uint8_t* av_packet_new_side_data(AVPacket *pkt, enum AVPacketSideDataType type,
4540 * Wrap an existing array as a packet side data.
4543 * @param type side information type
4544 * @param data the side data array. It must be allocated with the av_malloc()
4545 * family of functions. The ownership of the data is transferred to
4547 * @param size side information size
4548 * @return a non-negative number on success, a negative AVERROR code on
4549 * failure. On failure, the packet is unchanged and the data remains
4550 * owned by the caller.
4552 int av_packet_add_side_data(AVPacket *pkt, enum AVPacketSideDataType type,
4553 uint8_t *data, size_t size);
4556 * Shrink the already allocated side data buffer
4559 * @param type side information type
4560 * @param size new side information size
4561 * @return 0 on success, < 0 on failure
4563 int av_packet_shrink_side_data(AVPacket *pkt, enum AVPacketSideDataType type,
4567 * Get side information from packet.
4570 * @param type desired side information type
4571 * @param size pointer for side information size to store (optional)
4572 * @return pointer to data if present or NULL otherwise
4574 uint8_t* av_packet_get_side_data(AVPacket *pkt, enum AVPacketSideDataType type,
4577 int av_packet_merge_side_data(AVPacket *pkt);
4579 int av_packet_split_side_data(AVPacket *pkt);
4581 const char *av_packet_side_data_name(enum AVPacketSideDataType type);
4584 * Pack a dictionary for use in side_data.
4586 * @param dict The dictionary to pack.
4587 * @param size pointer to store the size of the returned data
4588 * @return pointer to data if successful, NULL otherwise
4590 uint8_t *av_packet_pack_dictionary(AVDictionary *dict, int *size);
4592 * Unpack a dictionary from side_data.
4594 * @param data data from side_data
4595 * @param size size of the data
4596 * @param dict the metadata storage dictionary
4597 * @return 0 on success, < 0 on failure
4599 int av_packet_unpack_dictionary(const uint8_t *data, int size, AVDictionary **dict);
4603 * Convenience function to free all the side data stored.
4604 * All the other fields stay untouched.
4608 void av_packet_free_side_data(AVPacket *pkt);
4611 * Setup a new reference to the data described by a given packet
4613 * If src is reference-counted, setup dst as a new reference to the
4614 * buffer in src. Otherwise allocate a new buffer in dst and copy the
4615 * data from src into it.
4617 * All the other fields are copied from src.
4619 * @see av_packet_unref
4621 * @param dst Destination packet
4622 * @param src Source packet
4624 * @return 0 on success, a negative AVERROR on error.
4626 int av_packet_ref(AVPacket *dst, const AVPacket *src);
4631 * Unreference the buffer referenced by the packet and reset the
4632 * remaining packet fields to their default values.
4634 * @param pkt The packet to be unreferenced.
4636 void av_packet_unref(AVPacket *pkt);
4639 * Move every field in src to dst and reset src.
4641 * @see av_packet_unref
4643 * @param src Source packet, will be reset
4644 * @param dst Destination packet
4646 void av_packet_move_ref(AVPacket *dst, AVPacket *src);
4649 * Copy only "properties" fields from src to dst.
4651 * Properties for the purpose of this function are all the fields
4652 * beside those related to the packet data (buf, data, size)
4654 * @param dst Destination packet
4655 * @param src Source packet
4657 * @return 0 on success AVERROR on failure.
4659 int av_packet_copy_props(AVPacket *dst, const AVPacket *src);
4662 * Convert valid timing fields (timestamps / durations) in a packet from one
4663 * timebase to another. Timestamps with unknown values (AV_NOPTS_VALUE) will be
4666 * @param pkt packet on which the conversion will be performed
4667 * @param tb_src source timebase, in which the timing fields in pkt are
4669 * @param tb_dst destination timebase, to which the timing fields will be
4672 void av_packet_rescale_ts(AVPacket *pkt, AVRational tb_src, AVRational tb_dst);
4679 * @addtogroup lavc_decoding
4684 * Find a registered decoder with a matching codec ID.
4686 * @param id AVCodecID of the requested decoder
4687 * @return A decoder if one was found, NULL otherwise.
4689 AVCodec *avcodec_find_decoder(enum AVCodecID id);
4692 * Find a registered decoder with the specified name.
4694 * @param name name of the requested decoder
4695 * @return A decoder if one was found, NULL otherwise.
4697 AVCodec *avcodec_find_decoder_by_name(const char *name);
4700 * The default callback for AVCodecContext.get_buffer2(). It is made public so
4701 * it can be called by custom get_buffer2() implementations for decoders without
4702 * AV_CODEC_CAP_DR1 set.
4704 int avcodec_default_get_buffer2(AVCodecContext *s, AVFrame *frame, int flags);
4708 * Return the amount of padding in pixels which the get_buffer callback must
4709 * provide around the edge of the image for codecs which do not have the
4710 * CODEC_FLAG_EMU_EDGE flag.
4712 * @return Required padding in pixels.
4714 * @deprecated CODEC_FLAG_EMU_EDGE is deprecated, so this function is no longer
4717 attribute_deprecated
4718 unsigned avcodec_get_edge_width(void);
4722 * Modify width and height values so that they will result in a memory
4723 * buffer that is acceptable for the codec if you do not use any horizontal
4726 * May only be used if a codec with AV_CODEC_CAP_DR1 has been opened.
4728 void avcodec_align_dimensions(AVCodecContext *s, int *width, int *height);
4731 * Modify width and height values so that they will result in a memory
4732 * buffer that is acceptable for the codec if you also ensure that all
4733 * line sizes are a multiple of the respective linesize_align[i].
4735 * May only be used if a codec with AV_CODEC_CAP_DR1 has been opened.
4737 void avcodec_align_dimensions2(AVCodecContext *s, int *width, int *height,
4738 int linesize_align[AV_NUM_DATA_POINTERS]);
4741 * Converts AVChromaLocation to swscale x/y chroma position.
4743 * The positions represent the chroma (0,0) position in a coordinates system
4744 * with luma (0,0) representing the origin and luma(1,1) representing 256,256
4746 * @param xpos horizontal chroma sample position
4747 * @param ypos vertical chroma sample position
4749 int avcodec_enum_to_chroma_pos(int *xpos, int *ypos, enum AVChromaLocation pos);
4752 * Converts swscale x/y chroma position to AVChromaLocation.
4754 * The positions represent the chroma (0,0) position in a coordinates system
4755 * with luma (0,0) representing the origin and luma(1,1) representing 256,256
4757 * @param xpos horizontal chroma sample position
4758 * @param ypos vertical chroma sample position
4760 enum AVChromaLocation avcodec_chroma_pos_to_enum(int xpos, int ypos);
4763 * Decode the audio frame of size avpkt->size from avpkt->data into frame.
4765 * Some decoders may support multiple frames in a single AVPacket. Such
4766 * decoders would then just decode the first frame and the return value would be
4767 * less than the packet size. In this case, avcodec_decode_audio4 has to be
4768 * called again with an AVPacket containing the remaining data in order to
4769 * decode the second frame, etc... Even if no frames are returned, the packet
4770 * needs to be fed to the decoder with remaining data until it is completely
4771 * consumed or an error occurs.
4773 * Some decoders (those marked with AV_CODEC_CAP_DELAY) have a delay between input
4774 * and output. This means that for some packets they will not immediately
4775 * produce decoded output and need to be flushed at the end of decoding to get
4776 * all the decoded data. Flushing is done by calling this function with packets
4777 * with avpkt->data set to NULL and avpkt->size set to 0 until it stops
4778 * returning samples. It is safe to flush even those decoders that are not
4779 * marked with AV_CODEC_CAP_DELAY, then no samples will be returned.
4781 * @warning The input buffer, avpkt->data must be AV_INPUT_BUFFER_PADDING_SIZE
4782 * larger than the actual read bytes because some optimized bitstream
4783 * readers read 32 or 64 bits at once and could read over the end.
4785 * @note The AVCodecContext MUST have been opened with @ref avcodec_open2()
4786 * before packets may be fed to the decoder.
4788 * @param avctx the codec context
4789 * @param[out] frame The AVFrame in which to store decoded audio samples.
4790 * The decoder will allocate a buffer for the decoded frame by
4791 * calling the AVCodecContext.get_buffer2() callback.
4792 * When AVCodecContext.refcounted_frames is set to 1, the frame is
4793 * reference counted and the returned reference belongs to the
4794 * caller. The caller must release the frame using av_frame_unref()
4795 * when the frame is no longer needed. The caller may safely write
4796 * to the frame if av_frame_is_writable() returns 1.
4797 * When AVCodecContext.refcounted_frames is set to 0, the returned
4798 * reference belongs to the decoder and is valid only until the
4799 * next call to this function or until closing or flushing the
4800 * decoder. The caller may not write to it.
4801 * @param[out] got_frame_ptr Zero if no frame could be decoded, otherwise it is
4802 * non-zero. Note that this field being set to zero
4803 * does not mean that an error has occurred. For
4804 * decoders with AV_CODEC_CAP_DELAY set, no given decode
4805 * call is guaranteed to produce a frame.
4806 * @param[in] avpkt The input AVPacket containing the input buffer.
4807 * At least avpkt->data and avpkt->size should be set. Some
4808 * decoders might also require additional fields to be set.
4809 * @return A negative error code is returned if an error occurred during
4810 * decoding, otherwise the number of bytes consumed from the input
4811 * AVPacket is returned.
4813 * @deprecated Use avcodec_send_packet() and avcodec_receive_frame().
4815 attribute_deprecated
4816 int avcodec_decode_audio4(AVCodecContext *avctx, AVFrame *frame,
4817 int *got_frame_ptr, const AVPacket *avpkt);
4820 * Decode the video frame of size avpkt->size from avpkt->data into picture.
4821 * Some decoders may support multiple frames in a single AVPacket, such
4822 * decoders would then just decode the first frame.
4824 * @warning The input buffer must be AV_INPUT_BUFFER_PADDING_SIZE larger than
4825 * the actual read bytes because some optimized bitstream readers read 32 or 64
4826 * bits at once and could read over the end.
4828 * @warning The end of the input buffer buf should be set to 0 to ensure that
4829 * no overreading happens for damaged MPEG streams.
4831 * @note Codecs which have the AV_CODEC_CAP_DELAY capability set have a delay
4832 * between input and output, these need to be fed with avpkt->data=NULL,
4833 * avpkt->size=0 at the end to return the remaining frames.
4835 * @note The AVCodecContext MUST have been opened with @ref avcodec_open2()
4836 * before packets may be fed to the decoder.
4838 * @param avctx the codec context
4839 * @param[out] picture The AVFrame in which the decoded video frame will be stored.
4840 * Use av_frame_alloc() to get an AVFrame. The codec will
4841 * allocate memory for the actual bitmap by calling the
4842 * AVCodecContext.get_buffer2() callback.
4843 * When AVCodecContext.refcounted_frames is set to 1, the frame is
4844 * reference counted and the returned reference belongs to the
4845 * caller. The caller must release the frame using av_frame_unref()
4846 * when the frame is no longer needed. The caller may safely write
4847 * to the frame if av_frame_is_writable() returns 1.
4848 * When AVCodecContext.refcounted_frames is set to 0, the returned
4849 * reference belongs to the decoder and is valid only until the
4850 * next call to this function or until closing or flushing the
4851 * decoder. The caller may not write to it.
4853 * @param[in] avpkt The input AVPacket containing the input buffer.
4854 * You can create such packet with av_init_packet() and by then setting
4855 * data and size, some decoders might in addition need other fields like
4856 * flags&AV_PKT_FLAG_KEY. All decoders are designed to use the least
4858 * @param[in,out] got_picture_ptr Zero if no frame could be decompressed, otherwise, it is nonzero.
4859 * @return On error a negative value is returned, otherwise the number of bytes
4860 * used or zero if no frame could be decompressed.
4862 * @deprecated Use avcodec_send_packet() and avcodec_receive_frame().
4864 attribute_deprecated
4865 int avcodec_decode_video2(AVCodecContext *avctx, AVFrame *picture,
4866 int *got_picture_ptr,
4867 const AVPacket *avpkt);
4870 * Decode a subtitle message.
4871 * Return a negative value on error, otherwise return the number of bytes used.
4872 * If no subtitle could be decompressed, got_sub_ptr is zero.
4873 * Otherwise, the subtitle is stored in *sub.
4874 * Note that AV_CODEC_CAP_DR1 is not available for subtitle codecs. This is for
4875 * simplicity, because the performance difference is expect to be negligible
4876 * and reusing a get_buffer written for video codecs would probably perform badly
4877 * due to a potentially very different allocation pattern.
4879 * Some decoders (those marked with CODEC_CAP_DELAY) have a delay between input
4880 * and output. This means that for some packets they will not immediately
4881 * produce decoded output and need to be flushed at the end of decoding to get
4882 * all the decoded data. Flushing is done by calling this function with packets
4883 * with avpkt->data set to NULL and avpkt->size set to 0 until it stops
4884 * returning subtitles. It is safe to flush even those decoders that are not
4885 * marked with CODEC_CAP_DELAY, then no subtitles will be returned.
4887 * @note The AVCodecContext MUST have been opened with @ref avcodec_open2()
4888 * before packets may be fed to the decoder.
4890 * @param avctx the codec context
4891 * @param[out] sub The Preallocated AVSubtitle in which the decoded subtitle will be stored,
4892 * must be freed with avsubtitle_free if *got_sub_ptr is set.
4893 * @param[in,out] got_sub_ptr Zero if no subtitle could be decompressed, otherwise, it is nonzero.
4894 * @param[in] avpkt The input AVPacket containing the input buffer.
4896 int avcodec_decode_subtitle2(AVCodecContext *avctx, AVSubtitle *sub,
4901 * Supply raw packet data as input to a decoder.
4903 * Internally, this call will copy relevant AVCodecContext fields, which can
4904 * influence decoding per-packet, and apply them when the packet is actually
4905 * decoded. (For example AVCodecContext.skip_frame, which might direct the
4906 * decoder to drop the frame contained by the packet sent with this function.)
4908 * @warning The input buffer, avpkt->data must be AV_INPUT_BUFFER_PADDING_SIZE
4909 * larger than the actual read bytes because some optimized bitstream
4910 * readers read 32 or 64 bits at once and could read over the end.
4912 * @warning Do not mix this API with the legacy API (like avcodec_decode_video2())
4913 * on the same AVCodecContext. It will return unexpected results now
4914 * or in future libavcodec versions.
4916 * @note The AVCodecContext MUST have been opened with @ref avcodec_open2()
4917 * before packets may be fed to the decoder.
4919 * @param avctx codec context
4920 * @param[in] avpkt The input AVPacket. Usually, this will be a single video
4921 * frame, or several complete audio frames.
4922 * Ownership of the packet remains with the caller, and the
4923 * decoder will not write to the packet. The decoder may create
4924 * a reference to the packet data (or copy it if the packet is
4925 * not reference-counted).
4926 * Unlike with older APIs, the packet is always fully consumed,
4927 * and if it contains multiple frames (e.g. some audio codecs),
4928 * will require you to call avcodec_receive_frame() multiple
4929 * times afterwards before you can send a new packet.
4930 * It can be NULL (or an AVPacket with data set to NULL and
4931 * size set to 0); in this case, it is considered a flush
4932 * packet, which signals the end of the stream. Sending the
4933 * first flush packet will return success. Subsequent ones are
4934 * unnecessary and will return AVERROR_EOF. If the decoder
4935 * still has frames buffered, it will return them after sending
4938 * @return 0 on success, otherwise negative error code:
4939 * AVERROR(EAGAIN): input is not accepted in the current state - user
4940 * must read output with avcodec_receive_frame() (once
4941 * all output is read, the packet should be resent, and
4942 * the call will not fail with EAGAIN).
4943 * AVERROR_EOF: the decoder has been flushed, and no new packets can
4944 * be sent to it (also returned if more than 1 flush
4946 * AVERROR(EINVAL): codec not opened, it is an encoder, or requires flush
4947 * AVERROR(ENOMEM): failed to add packet to internal queue, or similar
4948 * other errors: legitimate decoding errors
4950 int avcodec_send_packet(AVCodecContext *avctx, const AVPacket *avpkt);
4953 * Return decoded output data from a decoder.
4955 * @param avctx codec context
4956 * @param frame This will be set to a reference-counted video or audio
4957 * frame (depending on the decoder type) allocated by the
4958 * decoder. Note that the function will always call
4959 * av_frame_unref(frame) before doing anything else.
4962 * 0: success, a frame was returned
4963 * AVERROR(EAGAIN): output is not available in this state - user must try
4965 * AVERROR_EOF: the decoder has been fully flushed, and there will be
4966 * no more output frames
4967 * AVERROR(EINVAL): codec not opened, or it is an encoder
4968 * other negative values: legitimate decoding errors
4970 int avcodec_receive_frame(AVCodecContext *avctx, AVFrame *frame);
4973 * Supply a raw video or audio frame to the encoder. Use avcodec_receive_packet()
4974 * to retrieve buffered output packets.
4976 * @param avctx codec context
4977 * @param[in] frame AVFrame containing the raw audio or video frame to be encoded.
4978 * Ownership of the frame remains with the caller, and the
4979 * encoder will not write to the frame. The encoder may create
4980 * a reference to the frame data (or copy it if the frame is
4981 * not reference-counted).
4982 * It can be NULL, in which case it is considered a flush
4983 * packet. This signals the end of the stream. If the encoder
4984 * still has packets buffered, it will return them after this
4985 * call. Once flushing mode has been entered, additional flush
4986 * packets are ignored, and sending frames will return
4990 * If AV_CODEC_CAP_VARIABLE_FRAME_SIZE is set, then each frame
4991 * can have any number of samples.
4992 * If it is not set, frame->nb_samples must be equal to
4993 * avctx->frame_size for all frames except the last.
4994 * The final frame may be smaller than avctx->frame_size.
4995 * @return 0 on success, otherwise negative error code:
4996 * AVERROR(EAGAIN): input is not accepted in the current state - user
4997 * must read output with avcodec_receive_packet() (once
4998 * all output is read, the packet should be resent, and
4999 * the call will not fail with EAGAIN).
5000 * AVERROR_EOF: the encoder has been flushed, and no new frames can
5002 * AVERROR(EINVAL): codec not opened, refcounted_frames not set, it is a
5003 * decoder, or requires flush
5004 * AVERROR(ENOMEM): failed to add packet to internal queue, or similar
5005 * other errors: legitimate decoding errors
5007 int avcodec_send_frame(AVCodecContext *avctx, const AVFrame *frame);
5010 * Read encoded data from the encoder.
5012 * @param avctx codec context
5013 * @param avpkt This will be set to a reference-counted packet allocated by the
5014 * encoder. Note that the function will always call
5015 * av_frame_unref(frame) before doing anything else.
5016 * @return 0 on success, otherwise negative error code:
5017 * AVERROR(EAGAIN): output is not available in the current state - user
5018 * must try to send input
5019 * AVERROR_EOF: the encoder has been fully flushed, and there will be
5020 * no more output packets
5021 * AVERROR(EINVAL): codec not opened, or it is an encoder
5022 * other errors: legitimate decoding errors
5024 int avcodec_receive_packet(AVCodecContext *avctx, AVPacket *avpkt);
5028 * @defgroup lavc_parsing Frame parsing
5032 enum AVPictureStructure {
5033 AV_PICTURE_STRUCTURE_UNKNOWN, //< unknown
5034 AV_PICTURE_STRUCTURE_TOP_FIELD, //< coded as top field
5035 AV_PICTURE_STRUCTURE_BOTTOM_FIELD, //< coded as bottom field
5036 AV_PICTURE_STRUCTURE_FRAME, //< coded as frame
5039 typedef struct AVCodecParserContext {
5041 struct AVCodecParser *parser;
5042 int64_t frame_offset; /* offset of the current frame */
5043 int64_t cur_offset; /* current offset
5044 (incremented by each av_parser_parse()) */
5045 int64_t next_frame_offset; /* offset of the next frame */
5047 int pict_type; /* XXX: Put it back in AVCodecContext. */
5049 * This field is used for proper frame duration computation in lavf.
5050 * It signals, how much longer the frame duration of the current frame
5051 * is compared to normal frame duration.
5053 * frame_duration = (1 + repeat_pict) * time_base
5055 * It is used by codecs like H.264 to display telecined material.
5057 int repeat_pict; /* XXX: Put it back in AVCodecContext. */
5058 int64_t pts; /* pts of the current frame */
5059 int64_t dts; /* dts of the current frame */
5064 int fetch_timestamp;
5066 #define AV_PARSER_PTS_NB 4
5067 int cur_frame_start_index;
5068 int64_t cur_frame_offset[AV_PARSER_PTS_NB];
5069 int64_t cur_frame_pts[AV_PARSER_PTS_NB];
5070 int64_t cur_frame_dts[AV_PARSER_PTS_NB];
5073 #define PARSER_FLAG_COMPLETE_FRAMES 0x0001
5074 #define PARSER_FLAG_ONCE 0x0002
5075 /// Set if the parser has a valid file offset
5076 #define PARSER_FLAG_FETCHED_OFFSET 0x0004
5077 #define PARSER_FLAG_USE_CODEC_TS 0x1000
5079 int64_t offset; ///< byte offset from starting packet start
5080 int64_t cur_frame_end[AV_PARSER_PTS_NB];
5083 * Set by parser to 1 for key frames and 0 for non-key frames.
5084 * It is initialized to -1, so if the parser doesn't set this flag,
5085 * old-style fallback using AV_PICTURE_TYPE_I picture type as key frames
5090 #if FF_API_CONVERGENCE_DURATION
5092 * @deprecated unused
5094 attribute_deprecated
5095 int64_t convergence_duration;
5098 // Timestamp generation support:
5100 * Synchronization point for start of timestamp generation.
5102 * Set to >0 for sync point, 0 for no sync point and <0 for undefined
5105 * For example, this corresponds to presence of H.264 buffering period
5111 * Offset of the current timestamp against last timestamp sync point in
5112 * units of AVCodecContext.time_base.
5114 * Set to INT_MIN when dts_sync_point unused. Otherwise, it must
5115 * contain a valid timestamp offset.
5117 * Note that the timestamp of sync point has usually a nonzero
5118 * dts_ref_dts_delta, which refers to the previous sync point. Offset of
5119 * the next frame after timestamp sync point will be usually 1.
5121 * For example, this corresponds to H.264 cpb_removal_delay.
5123 int dts_ref_dts_delta;
5126 * Presentation delay of current frame in units of AVCodecContext.time_base.
5128 * Set to INT_MIN when dts_sync_point unused. Otherwise, it must
5129 * contain valid non-negative timestamp delta (presentation time of a frame
5130 * must not lie in the past).
5132 * This delay represents the difference between decoding and presentation
5133 * time of the frame.
5135 * For example, this corresponds to H.264 dpb_output_delay.
5140 * Position of the packet in file.
5142 * Analogous to cur_frame_pts/dts
5144 int64_t cur_frame_pos[AV_PARSER_PTS_NB];
5147 * Byte position of currently parsed frame in stream.
5152 * Previous frame byte position.
5157 * Duration of the current frame.
5158 * For audio, this is in units of 1 / AVCodecContext.sample_rate.
5159 * For all other types, this is in units of AVCodecContext.time_base.
5163 enum AVFieldOrder field_order;
5166 * Indicate whether a picture is coded as a frame, top field or bottom field.
5168 * For example, H.264 field_pic_flag equal to 0 corresponds to
5169 * AV_PICTURE_STRUCTURE_FRAME. An H.264 picture with field_pic_flag
5170 * equal to 1 and bottom_field_flag equal to 0 corresponds to
5171 * AV_PICTURE_STRUCTURE_TOP_FIELD.
5173 enum AVPictureStructure picture_structure;
5176 * Picture number incremented in presentation or output order.
5177 * This field may be reinitialized at the first picture of a new sequence.
5179 * For example, this corresponds to H.264 PicOrderCnt.
5181 int output_picture_number;
5184 * Dimensions of the decoded video intended for presentation.
5190 * Dimensions of the coded video.
5196 * The format of the coded data, corresponds to enum AVPixelFormat for video
5197 * and for enum AVSampleFormat for audio.
5199 * Note that a decoder can have considerable freedom in how exactly it
5200 * decodes the data, so the format reported here might be different from the
5201 * one returned by a decoder.
5204 } AVCodecParserContext;
5206 typedef struct AVCodecParser {
5207 int codec_ids[5]; /* several codec IDs are permitted */
5209 int (*parser_init)(AVCodecParserContext *s);
5210 /* This callback never returns an error, a negative value means that
5211 * the frame start was in a previous packet. */
5212 int (*parser_parse)(AVCodecParserContext *s,
5213 AVCodecContext *avctx,
5214 const uint8_t **poutbuf, int *poutbuf_size,
5215 const uint8_t *buf, int buf_size);
5216 void (*parser_close)(AVCodecParserContext *s);
5217 int (*split)(AVCodecContext *avctx, const uint8_t *buf, int buf_size);
5218 struct AVCodecParser *next;
5221 AVCodecParser *av_parser_next(const AVCodecParser *c);
5223 void av_register_codec_parser(AVCodecParser *parser);
5224 AVCodecParserContext *av_parser_init(int codec_id);
5229 * @param s parser context.
5230 * @param avctx codec context.
5231 * @param poutbuf set to pointer to parsed buffer or NULL if not yet finished.
5232 * @param poutbuf_size set to size of parsed buffer or zero if not yet finished.
5233 * @param buf input buffer.
5234 * @param buf_size buffer size in bytes without the padding. I.e. the full buffer
5235 size is assumed to be buf_size + AV_INPUT_BUFFER_PADDING_SIZE.
5236 To signal EOF, this should be 0 (so that the last frame
5238 * @param pts input presentation timestamp.
5239 * @param dts input decoding timestamp.
5240 * @param pos input byte position in stream.
5241 * @return the number of bytes of the input bitstream used.
5246 * len = av_parser_parse2(myparser, AVCodecContext, &data, &size,
5253 * decode_frame(data, size);
5257 int av_parser_parse2(AVCodecParserContext *s,
5258 AVCodecContext *avctx,
5259 uint8_t **poutbuf, int *poutbuf_size,
5260 const uint8_t *buf, int buf_size,
5261 int64_t pts, int64_t dts,
5265 * @return 0 if the output buffer is a subset of the input, 1 if it is allocated and must be freed
5266 * @deprecated use AVBitStreamFilter
5268 int av_parser_change(AVCodecParserContext *s,
5269 AVCodecContext *avctx,
5270 uint8_t **poutbuf, int *poutbuf_size,
5271 const uint8_t *buf, int buf_size, int keyframe);
5272 void av_parser_close(AVCodecParserContext *s);
5280 * @addtogroup lavc_encoding
5285 * Find a registered encoder with a matching codec ID.
5287 * @param id AVCodecID of the requested encoder
5288 * @return An encoder if one was found, NULL otherwise.
5290 AVCodec *avcodec_find_encoder(enum AVCodecID id);
5293 * Find a registered encoder with the specified name.
5295 * @param name name of the requested encoder
5296 * @return An encoder if one was found, NULL otherwise.
5298 AVCodec *avcodec_find_encoder_by_name(const char *name);
5301 * Encode a frame of audio.
5303 * Takes input samples from frame and writes the next output packet, if
5304 * available, to avpkt. The output packet does not necessarily contain data for
5305 * the most recent frame, as encoders can delay, split, and combine input frames
5306 * internally as needed.
5308 * @param avctx codec context
5309 * @param avpkt output AVPacket.
5310 * The user can supply an output buffer by setting
5311 * avpkt->data and avpkt->size prior to calling the
5312 * function, but if the size of the user-provided data is not
5313 * large enough, encoding will fail. If avpkt->data and
5314 * avpkt->size are set, avpkt->destruct must also be set. All
5315 * other AVPacket fields will be reset by the encoder using
5316 * av_init_packet(). If avpkt->data is NULL, the encoder will
5317 * allocate it. The encoder will set avpkt->size to the size
5318 * of the output packet.
5320 * If this function fails or produces no output, avpkt will be
5321 * freed using av_packet_unref().
5322 * @param[in] frame AVFrame containing the raw audio data to be encoded.
5323 * May be NULL when flushing an encoder that has the
5324 * AV_CODEC_CAP_DELAY capability set.
5325 * If AV_CODEC_CAP_VARIABLE_FRAME_SIZE is set, then each frame
5326 * can have any number of samples.
5327 * If it is not set, frame->nb_samples must be equal to
5328 * avctx->frame_size for all frames except the last.
5329 * The final frame may be smaller than avctx->frame_size.
5330 * @param[out] got_packet_ptr This field is set to 1 by libavcodec if the
5331 * output packet is non-empty, and to 0 if it is
5332 * empty. If the function returns an error, the
5333 * packet can be assumed to be invalid, and the
5334 * value of got_packet_ptr is undefined and should
5336 * @return 0 on success, negative error code on failure
5338 * @deprecated use avcodec_send_frame()/avcodec_receive_packet() instead
5340 attribute_deprecated
5341 int avcodec_encode_audio2(AVCodecContext *avctx, AVPacket *avpkt,
5342 const AVFrame *frame, int *got_packet_ptr);
5345 * Encode a frame of video.
5347 * Takes input raw video data from frame and writes the next output packet, if
5348 * available, to avpkt. The output packet does not necessarily contain data for
5349 * the most recent frame, as encoders can delay and reorder input frames
5350 * internally as needed.
5352 * @param avctx codec context
5353 * @param avpkt output AVPacket.
5354 * The user can supply an output buffer by setting
5355 * avpkt->data and avpkt->size prior to calling the
5356 * function, but if the size of the user-provided data is not
5357 * large enough, encoding will fail. All other AVPacket fields
5358 * will be reset by the encoder using av_init_packet(). If
5359 * avpkt->data is NULL, the encoder will allocate it.
5360 * The encoder will set avpkt->size to the size of the
5361 * output packet. The returned data (if any) belongs to the
5362 * caller, he is responsible for freeing it.
5364 * If this function fails or produces no output, avpkt will be
5365 * freed using av_packet_unref().
5366 * @param[in] frame AVFrame containing the raw video data to be encoded.
5367 * May be NULL when flushing an encoder that has the
5368 * AV_CODEC_CAP_DELAY capability set.
5369 * @param[out] got_packet_ptr This field is set to 1 by libavcodec if the
5370 * output packet is non-empty, and to 0 if it is
5371 * empty. If the function returns an error, the
5372 * packet can be assumed to be invalid, and the
5373 * value of got_packet_ptr is undefined and should
5375 * @return 0 on success, negative error code on failure
5377 * @deprecated use avcodec_send_frame()/avcodec_receive_packet() instead
5379 attribute_deprecated
5380 int avcodec_encode_video2(AVCodecContext *avctx, AVPacket *avpkt,
5381 const AVFrame *frame, int *got_packet_ptr);
5383 int avcodec_encode_subtitle(AVCodecContext *avctx, uint8_t *buf, int buf_size,
5384 const AVSubtitle *sub);
5391 #if FF_API_AVCODEC_RESAMPLE
5393 * @defgroup lavc_resample Audio resampling
5395 * @deprecated use libswresample instead
5399 struct ReSampleContext;
5400 struct AVResampleContext;
5402 typedef struct ReSampleContext ReSampleContext;
5405 * Initialize audio resampling context.
5407 * @param output_channels number of output channels
5408 * @param input_channels number of input channels
5409 * @param output_rate output sample rate
5410 * @param input_rate input sample rate
5411 * @param sample_fmt_out requested output sample format
5412 * @param sample_fmt_in input sample format
5413 * @param filter_length length of each FIR filter in the filterbank relative to the cutoff frequency
5414 * @param log2_phase_count log2 of the number of entries in the polyphase filterbank
5415 * @param linear if 1 then the used FIR filter will be linearly interpolated
5416 between the 2 closest, if 0 the closest will be used
5417 * @param cutoff cutoff frequency, 1.0 corresponds to half the output sampling rate
5418 * @return allocated ReSampleContext, NULL if error occurred
5420 attribute_deprecated
5421 ReSampleContext *av_audio_resample_init(int output_channels, int input_channels,
5422 int output_rate, int input_rate,
5423 enum AVSampleFormat sample_fmt_out,
5424 enum AVSampleFormat sample_fmt_in,
5425 int filter_length, int log2_phase_count,
5426 int linear, double cutoff);
5428 attribute_deprecated
5429 int audio_resample(ReSampleContext *s, short *output, short *input, int nb_samples);
5432 * Free resample context.
5434 * @param s a non-NULL pointer to a resample context previously
5435 * created with av_audio_resample_init()
5437 attribute_deprecated
5438 void audio_resample_close(ReSampleContext *s);
5442 * Initialize an audio resampler.
5443 * Note, if either rate is not an integer then simply scale both rates up so they are.
5444 * @param filter_length length of each FIR filter in the filterbank relative to the cutoff freq
5445 * @param log2_phase_count log2 of the number of entries in the polyphase filterbank
5446 * @param linear If 1 then the used FIR filter will be linearly interpolated
5447 between the 2 closest, if 0 the closest will be used
5448 * @param cutoff cutoff frequency, 1.0 corresponds to half the output sampling rate
5450 attribute_deprecated
5451 struct AVResampleContext *av_resample_init(int out_rate, int in_rate, int filter_length, int log2_phase_count, int linear, double cutoff);
5454 * Resample an array of samples using a previously configured context.
5455 * @param src an array of unconsumed samples
5456 * @param consumed the number of samples of src which have been consumed are returned here
5457 * @param src_size the number of unconsumed samples available
5458 * @param dst_size the amount of space in samples available in dst
5459 * @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.
5460 * @return the number of samples written in dst or -1 if an error occurred
5462 attribute_deprecated
5463 int av_resample(struct AVResampleContext *c, short *dst, short *src, int *consumed, int src_size, int dst_size, int update_ctx);
5467 * Compensate samplerate/timestamp drift. The compensation is done by changing
5468 * the resampler parameters, so no audible clicks or similar distortions occur
5469 * @param compensation_distance distance in output samples over which the compensation should be performed
5470 * @param sample_delta number of output samples which should be output less
5472 * example: av_resample_compensate(c, 10, 500)
5473 * here instead of 510 samples only 500 samples would be output
5475 * note, due to rounding the actual compensation might be slightly different,
5476 * especially if the compensation_distance is large and the in_rate used during init is small
5478 attribute_deprecated
5479 void av_resample_compensate(struct AVResampleContext *c, int sample_delta, int compensation_distance);
5480 attribute_deprecated
5481 void av_resample_close(struct AVResampleContext *c);
5488 #if FF_API_AVPICTURE
5490 * @addtogroup lavc_picture
5495 * @deprecated unused
5497 attribute_deprecated
5498 int avpicture_alloc(AVPicture *picture, enum AVPixelFormat pix_fmt, int width, int height);
5501 * @deprecated unused
5503 attribute_deprecated
5504 void avpicture_free(AVPicture *picture);
5507 * @deprecated use av_image_fill_arrays() instead.
5509 attribute_deprecated
5510 int avpicture_fill(AVPicture *picture, const uint8_t *ptr,
5511 enum AVPixelFormat pix_fmt, int width, int height);
5514 * @deprecated use av_image_copy_to_buffer() instead.
5516 attribute_deprecated
5517 int avpicture_layout(const AVPicture *src, enum AVPixelFormat pix_fmt,
5518 int width, int height,
5519 unsigned char *dest, int dest_size);
5522 * @deprecated use av_image_get_buffer_size() instead.
5524 attribute_deprecated
5525 int avpicture_get_size(enum AVPixelFormat pix_fmt, int width, int height);
5528 * @deprecated av_image_copy() instead.
5530 attribute_deprecated
5531 void av_picture_copy(AVPicture *dst, const AVPicture *src,
5532 enum AVPixelFormat pix_fmt, int width, int height);
5535 * @deprecated unused
5537 attribute_deprecated
5538 int av_picture_crop(AVPicture *dst, const AVPicture *src,
5539 enum AVPixelFormat pix_fmt, int top_band, int left_band);
5542 * @deprecated unused
5544 attribute_deprecated
5545 int av_picture_pad(AVPicture *dst, const AVPicture *src, int height, int width, enum AVPixelFormat pix_fmt,
5546 int padtop, int padbottom, int padleft, int padright, int *color);
5554 * @defgroup lavc_misc Utility functions
5557 * Miscellaneous utility functions related to both encoding and decoding
5563 * @defgroup lavc_misc_pixfmt Pixel formats
5565 * Functions for working with pixel formats.
5570 * Utility function to access log2_chroma_w log2_chroma_h from
5571 * the pixel format AVPixFmtDescriptor.
5573 * This function asserts that pix_fmt is valid. See av_pix_fmt_get_chroma_sub_sample
5574 * for one that returns a failure code and continues in case of invalid
5577 * @param[in] pix_fmt the pixel format
5578 * @param[out] h_shift store log2_chroma_w
5579 * @param[out] v_shift store log2_chroma_h
5581 * @see av_pix_fmt_get_chroma_sub_sample
5584 void avcodec_get_chroma_sub_sample(enum AVPixelFormat pix_fmt, int *h_shift, int *v_shift);
5587 * Return a value representing the fourCC code associated to the
5588 * pixel format pix_fmt, or 0 if no associated fourCC code can be
5591 unsigned int avcodec_pix_fmt_to_codec_tag(enum AVPixelFormat pix_fmt);
5594 * @deprecated see av_get_pix_fmt_loss()
5596 int avcodec_get_pix_fmt_loss(enum AVPixelFormat dst_pix_fmt, enum AVPixelFormat src_pix_fmt,
5600 * Find the best pixel format to convert to given a certain source pixel
5601 * format. When converting from one pixel format to another, information loss
5602 * may occur. For example, when converting from RGB24 to GRAY, the color
5603 * information will be lost. Similarly, other losses occur when converting from
5604 * some formats to other formats. avcodec_find_best_pix_fmt_of_2() searches which of
5605 * the given pixel formats should be used to suffer the least amount of loss.
5606 * The pixel formats from which it chooses one, are determined by the
5607 * pix_fmt_list parameter.
5610 * @param[in] pix_fmt_list AV_PIX_FMT_NONE terminated array of pixel formats to choose from
5611 * @param[in] src_pix_fmt source pixel format
5612 * @param[in] has_alpha Whether the source pixel format alpha channel is used.
5613 * @param[out] loss_ptr Combination of flags informing you what kind of losses will occur.
5614 * @return The best pixel format to convert to or -1 if none was found.
5616 enum AVPixelFormat avcodec_find_best_pix_fmt_of_list(const enum AVPixelFormat *pix_fmt_list,
5617 enum AVPixelFormat src_pix_fmt,
5618 int has_alpha, int *loss_ptr);
5621 * @deprecated see av_find_best_pix_fmt_of_2()
5623 enum AVPixelFormat avcodec_find_best_pix_fmt_of_2(enum AVPixelFormat dst_pix_fmt1, enum AVPixelFormat dst_pix_fmt2,
5624 enum AVPixelFormat src_pix_fmt, int has_alpha, int *loss_ptr);
5626 attribute_deprecated
5627 enum AVPixelFormat avcodec_find_best_pix_fmt2(enum AVPixelFormat dst_pix_fmt1, enum AVPixelFormat dst_pix_fmt2,
5628 enum AVPixelFormat src_pix_fmt, int has_alpha, int *loss_ptr);
5630 enum AVPixelFormat avcodec_default_get_format(struct AVCodecContext *s, const enum AVPixelFormat * fmt);
5636 #if FF_API_SET_DIMENSIONS
5638 * @deprecated this function is not supposed to be used from outside of lavc
5640 attribute_deprecated
5641 void avcodec_set_dimensions(AVCodecContext *s, int width, int height);
5645 * Put a string representing the codec tag codec_tag in buf.
5647 * @param buf buffer to place codec tag in
5648 * @param buf_size size in bytes of buf
5649 * @param codec_tag codec tag to assign
5650 * @return the length of the string that would have been generated if
5651 * enough space had been available, excluding the trailing null
5653 size_t av_get_codec_tag_string(char *buf, size_t buf_size, unsigned int codec_tag);
5655 void avcodec_string(char *buf, int buf_size, AVCodecContext *enc, int encode);
5658 * Return a name for the specified profile, if available.
5660 * @param codec the codec that is searched for the given profile
5661 * @param profile the profile value for which a name is requested
5662 * @return A name for the profile if found, NULL otherwise.
5664 const char *av_get_profile_name(const AVCodec *codec, int profile);
5667 * Return a name for the specified profile, if available.
5669 * @param codec_id the ID of the codec to which the requested profile belongs
5670 * @param profile the profile value for which a name is requested
5671 * @return A name for the profile if found, NULL otherwise.
5673 * @note unlike av_get_profile_name(), which searches a list of profiles
5674 * supported by a specific decoder or encoder implementation, this
5675 * function searches the list of profiles from the AVCodecDescriptor
5677 const char *avcodec_profile_name(enum AVCodecID codec_id, int profile);
5679 int avcodec_default_execute(AVCodecContext *c, int (*func)(AVCodecContext *c2, void *arg2),void *arg, int *ret, int count, int size);
5680 int avcodec_default_execute2(AVCodecContext *c, int (*func)(AVCodecContext *c2, void *arg2, int, int),void *arg, int *ret, int count);
5681 //FIXME func typedef
5684 * Fill AVFrame audio data and linesize pointers.
5686 * The buffer buf must be a preallocated buffer with a size big enough
5687 * to contain the specified samples amount. The filled AVFrame data
5688 * pointers will point to this buffer.
5690 * AVFrame extended_data channel pointers are allocated if necessary for
5693 * @param frame the AVFrame
5694 * frame->nb_samples must be set prior to calling the
5695 * function. This function fills in frame->data,
5696 * frame->extended_data, frame->linesize[0].
5697 * @param nb_channels channel count
5698 * @param sample_fmt sample format
5699 * @param buf buffer to use for frame data
5700 * @param buf_size size of buffer
5701 * @param align plane size sample alignment (0 = default)
5702 * @return >=0 on success, negative error code on failure
5703 * @todo return the size in bytes required to store the samples in
5704 * case of success, at the next libavutil bump
5706 int avcodec_fill_audio_frame(AVFrame *frame, int nb_channels,
5707 enum AVSampleFormat sample_fmt, const uint8_t *buf,
5708 int buf_size, int align);
5711 * Reset the internal decoder state / flush internal buffers. Should be called
5712 * e.g. when seeking or when switching to a different stream.
5714 * @note when refcounted frames are not used (i.e. avctx->refcounted_frames is 0),
5715 * this invalidates the frames previously returned from the decoder. When
5716 * refcounted frames are used, the decoder just releases any references it might
5717 * keep internally, but the caller's reference remains valid.
5719 void avcodec_flush_buffers(AVCodecContext *avctx);
5722 * Return codec bits per sample.
5724 * @param[in] codec_id the codec
5725 * @return Number of bits per sample or zero if unknown for the given codec.
5727 int av_get_bits_per_sample(enum AVCodecID codec_id);
5730 * Return the PCM codec associated with a sample format.
5731 * @param be endianness, 0 for little, 1 for big,
5732 * -1 (or anything else) for native
5733 * @return AV_CODEC_ID_PCM_* or AV_CODEC_ID_NONE
5735 enum AVCodecID av_get_pcm_codec(enum AVSampleFormat fmt, int be);
5738 * Return codec bits per sample.
5739 * Only return non-zero if the bits per sample is exactly correct, not an
5742 * @param[in] codec_id the codec
5743 * @return Number of bits per sample or zero if unknown for the given codec.
5745 int av_get_exact_bits_per_sample(enum AVCodecID codec_id);
5748 * Return audio frame duration.
5750 * @param avctx codec context
5751 * @param frame_bytes size of the frame, or 0 if unknown
5752 * @return frame duration, in samples, if known. 0 if not able to
5755 int av_get_audio_frame_duration(AVCodecContext *avctx, int frame_bytes);
5758 * This function is the same as av_get_audio_frame_duration(), except it works
5759 * with AVCodecParameters instead of an AVCodecContext.
5761 int av_get_audio_frame_duration2(AVCodecParameters *par, int frame_bytes);
5764 typedef struct AVBitStreamFilterContext {
5766 struct AVBitStreamFilter *filter;
5767 AVCodecParserContext *parser;
5768 struct AVBitStreamFilterContext *next;
5770 * Internal default arguments, used if NULL is passed to av_bitstream_filter_filter().
5771 * Not for access by library users.
5774 } AVBitStreamFilterContext;
5777 typedef struct AVBSFInternal AVBSFInternal;
5780 * The bitstream filter state.
5782 * This struct must be allocated with av_bsf_alloc() and freed with
5785 * The fields in the struct will only be changed (by the caller or by the
5786 * filter) as described in their documentation, and are to be considered
5787 * immutable otherwise.
5789 typedef struct AVBSFContext {
5791 * A class for logging and AVOptions
5793 const AVClass *av_class;
5796 * The bitstream filter this context is an instance of.
5798 const struct AVBitStreamFilter *filter;
5801 * Opaque libavcodec internal data. Must not be touched by the caller in any
5804 AVBSFInternal *internal;
5807 * Opaque filter-specific private data. If filter->priv_class is non-NULL,
5808 * this is an AVOptions-enabled struct.
5813 * Parameters of the input stream. Set by the caller before av_bsf_init().
5815 AVCodecParameters *par_in;
5818 * Parameters of the output stream. Set by the filter in av_bsf_init().
5820 AVCodecParameters *par_out;
5823 * The timebase used for the timestamps of the input packets. Set by the
5824 * caller before av_bsf_init().
5826 AVRational time_base_in;
5829 * The timebase used for the timestamps of the output packets. Set by the
5830 * filter in av_bsf_init().
5832 AVRational time_base_out;
5835 typedef struct AVBitStreamFilter {
5839 * A list of codec ids supported by the filter, terminated by
5841 * May be NULL, in that case the bitstream filter works with any codec id.
5843 const enum AVCodecID *codec_ids;
5846 * A class for the private data, used to declare bitstream filter private
5847 * AVOptions. This field is NULL for bitstream filters that do not declare
5850 * If this field is non-NULL, the first member of the filter private data
5851 * must be a pointer to AVClass, which will be set by libavcodec generic
5852 * code to this class.
5854 const AVClass *priv_class;
5856 /*****************************************************************
5857 * No fields below this line are part of the public API. They
5858 * may not be used outside of libavcodec and can be changed and
5860 * New public fields should be added right above.
5861 *****************************************************************
5865 int (*init)(AVBSFContext *ctx);
5866 int (*filter)(AVBSFContext *ctx, AVPacket *pkt);
5867 void (*close)(AVBSFContext *ctx);
5868 } AVBitStreamFilter;
5872 * Register a bitstream filter.
5874 * The filter will be accessible to the application code through
5875 * av_bitstream_filter_next() or can be directly initialized with
5876 * av_bitstream_filter_init().
5878 * @see avcodec_register_all()
5880 attribute_deprecated
5881 void av_register_bitstream_filter(AVBitStreamFilter *bsf);
5884 * Create and initialize a bitstream filter context given a bitstream
5887 * The returned context must be freed with av_bitstream_filter_close().
5889 * @param name the name of the bitstream filter
5890 * @return a bitstream filter context if a matching filter was found
5891 * and successfully initialized, NULL otherwise
5893 attribute_deprecated
5894 AVBitStreamFilterContext *av_bitstream_filter_init(const char *name);
5899 * This function filters the buffer buf with size buf_size, and places the
5900 * filtered buffer in the buffer pointed to by poutbuf.
5902 * The output buffer must be freed by the caller.
5904 * @param bsfc bitstream filter context created by av_bitstream_filter_init()
5905 * @param avctx AVCodecContext accessed by the filter, may be NULL.
5906 * If specified, this must point to the encoder context of the
5907 * output stream the packet is sent to.
5908 * @param args arguments which specify the filter configuration, may be NULL
5909 * @param poutbuf pointer which is updated to point to the filtered buffer
5910 * @param poutbuf_size pointer which is updated to the filtered buffer size in bytes
5911 * @param buf buffer containing the data to filter
5912 * @param buf_size size in bytes of buf
5913 * @param keyframe set to non-zero if the buffer to filter corresponds to a key-frame packet data
5914 * @return >= 0 in case of success, or a negative error code in case of failure
5916 * If the return value is positive, an output buffer is allocated and
5917 * is available in *poutbuf, and is distinct from the input buffer.
5919 * If the return value is 0, the output buffer is not allocated and
5920 * should be considered identical to the input buffer, or in case
5921 * *poutbuf was set it points to the input buffer (not necessarily to
5922 * its starting address). A special case is if *poutbuf was set to NULL and
5923 * *poutbuf_size was set to 0, which indicates the packet should be dropped.
5925 attribute_deprecated
5926 int av_bitstream_filter_filter(AVBitStreamFilterContext *bsfc,
5927 AVCodecContext *avctx, const char *args,
5928 uint8_t **poutbuf, int *poutbuf_size,
5929 const uint8_t *buf, int buf_size, int keyframe);
5932 * Release bitstream filter context.
5934 * @param bsf the bitstream filter context created with
5935 * av_bitstream_filter_init(), can be NULL
5937 attribute_deprecated
5938 void av_bitstream_filter_close(AVBitStreamFilterContext *bsf);
5941 * If f is NULL, return the first registered bitstream filter,
5942 * if f is non-NULL, return the next registered bitstream filter
5943 * after f, or NULL if f is the last one.
5945 * This function can be used to iterate over all registered bitstream
5948 attribute_deprecated
5949 AVBitStreamFilter *av_bitstream_filter_next(const AVBitStreamFilter *f);
5953 * @return a bitstream filter with the specified name or NULL if no such
5954 * bitstream filter exists.
5956 const AVBitStreamFilter *av_bsf_get_by_name(const char *name);
5959 * Iterate over all registered bitstream filters.
5961 * @param opaque a pointer where libavcodec will store the iteration state. Must
5962 * point to NULL to start the iteration.
5964 * @return the next registered bitstream filter or NULL when the iteration is
5967 const AVBitStreamFilter *av_bsf_next(void **opaque);
5970 * Allocate a context for a given bitstream filter. The caller must fill in the
5971 * context parameters as described in the documentation and then call
5972 * av_bsf_init() before sending any data to the filter.
5974 * @param filter the filter for which to allocate an instance.
5975 * @param ctx a pointer into which the pointer to the newly-allocated context
5976 * will be written. It must be freed with av_bsf_free() after the
5977 * filtering is done.
5979 * @return 0 on success, a negative AVERROR code on failure
5981 int av_bsf_alloc(const AVBitStreamFilter *filter, AVBSFContext **ctx);
5984 * Prepare the filter for use, after all the parameters and options have been
5987 int av_bsf_init(AVBSFContext *ctx);
5990 * Submit a packet for filtering.
5992 * After sending each packet, the filter must be completely drained by calling
5993 * av_bsf_receive_packet() repeatedly until it returns AVERROR(EAGAIN) or
5996 * @param pkt the packet to filter. pkt must contain some payload (i.e data or
5997 * side data must be present in pkt). The bitstream filter will take ownership of
5998 * the packet and reset the contents of pkt. pkt is not touched if an error occurs.
5999 * This parameter may be NULL, which signals the end of the stream (i.e. no more
6000 * packets will be sent). That will cause the filter to output any packets it
6001 * may have buffered internally.
6003 * @return 0 on success, a negative AVERROR on error.
6005 int av_bsf_send_packet(AVBSFContext *ctx, AVPacket *pkt);
6008 * Retrieve a filtered packet.
6010 * @param[out] pkt this struct will be filled with the contents of the filtered
6011 * packet. It is owned by the caller and must be freed using
6012 * av_packet_unref() when it is no longer needed.
6013 * This parameter should be "clean" (i.e. freshly allocated
6014 * with av_packet_alloc() or unreffed with av_packet_unref())
6015 * when this function is called. If this function returns
6016 * successfully, the contents of pkt will be completely
6017 * overwritten by the returned data. On failure, pkt is not
6020 * @return 0 on success. AVERROR(EAGAIN) if more packets need to be sent to the
6021 * filter (using av_bsf_send_packet()) to get more output. AVERROR_EOF if there
6022 * will be no further output from the filter. Another negative AVERROR value if
6025 * @note one input packet may result in several output packets, so after sending
6026 * a packet with av_bsf_send_packet(), this function needs to be called
6027 * repeatedly until it stops returning 0. It is also possible for a filter to
6028 * output fewer packets than were sent to it, so this function may return
6029 * AVERROR(EAGAIN) immediately after a successful av_bsf_send_packet() call.
6031 int av_bsf_receive_packet(AVBSFContext *ctx, AVPacket *pkt);
6034 * Free a bitstream filter context and everything associated with it; write NULL
6035 * into the supplied pointer.
6037 void av_bsf_free(AVBSFContext **ctx);
6040 * Get the AVClass for AVBSFContext. It can be used in combination with
6041 * AV_OPT_SEARCH_FAKE_OBJ for examining options.
6043 * @see av_opt_find().
6045 const AVClass *av_bsf_get_class(void);
6048 * Structure for chain/list of bitstream filters.
6049 * Empty list can be allocated by av_bsf_list_alloc().
6051 typedef struct AVBSFList AVBSFList;
6054 * Allocate empty list of bitstream filters.
6055 * The list must be later freed by av_bsf_list_free()
6056 * or finalized by av_bsf_list_finalize().
6058 * @return Pointer to @ref AVBSFList on success, NULL in case of failure
6060 AVBSFList *av_bsf_list_alloc(void);
6063 * Free list of bitstream filters.
6065 * @param lst Pointer to pointer returned by av_bsf_list_alloc()
6067 void av_bsf_list_free(AVBSFList **lst);
6070 * Append bitstream filter to the list of bitstream filters.
6072 * @param lst List to append to
6073 * @param bsf Filter context to be appended
6075 * @return >=0 on success, negative AVERROR in case of failure
6077 int av_bsf_list_append(AVBSFList *lst, AVBSFContext *bsf);
6080 * Construct new bitstream filter context given it's name and options
6081 * and append it to the list of bitstream filters.
6083 * @param lst List to append to
6084 * @param bsf_name Name of the bitstream filter
6085 * @param options Options for the bitstream filter, can be set to NULL
6087 * @return >=0 on success, negative AVERROR in case of failure
6089 int av_bsf_list_append2(AVBSFList *lst, const char * bsf_name, AVDictionary **options);
6091 * Finalize list of bitstream filters.
6093 * This function will transform @ref AVBSFList to single @ref AVBSFContext,
6094 * so the whole chain of bitstream filters can be treated as single filter
6095 * freshly allocated by av_bsf_alloc().
6096 * If the call is successful, @ref AVBSFList structure is freed and lst
6097 * will be set to NULL. In case of failure, caller is responsible for
6098 * freeing the structure by av_bsf_list_free()
6100 * @param lst Filter list structure to be transformed
6101 * @param[out] bsf Pointer to be set to newly created @ref AVBSFContext structure
6102 * representing the chain of bitstream filters
6104 * @return >=0 on success, negative AVERROR in case of failure
6106 int av_bsf_list_finalize(AVBSFList **lst, AVBSFContext **bsf);
6109 * Parse string describing list of bitstream filters and create single
6110 * @ref AVBSFContext describing the whole chain of bitstream filters.
6111 * Resulting @ref AVBSFContext can be treated as any other @ref AVBSFContext freshly
6112 * allocated by av_bsf_alloc().
6114 * @param str String describing chain of bitstream filters in format
6115 * `bsf1[=opt1=val1:opt2=val2][,bsf2]`
6116 * @param[out] bsf Pointer to be set to newly created @ref AVBSFContext structure
6117 * representing the chain of bitstream filters
6119 * @return >=0 on success, negative AVERROR in case of failure
6121 int av_bsf_list_parse_str(const char *str, AVBSFContext **bsf);
6124 * Get null/pass-through bitstream filter.
6126 * @param[out] bsf Pointer to be set to new instance of pass-through bitstream filter
6130 int av_bsf_get_null_filter(AVBSFContext **bsf);
6135 * Same behaviour av_fast_malloc but the buffer has additional
6136 * AV_INPUT_BUFFER_PADDING_SIZE at the end which will always be 0.
6138 * In addition the whole buffer will initially and after resizes
6139 * be 0-initialized so that no uninitialized data will ever appear.
6141 void av_fast_padded_malloc(void *ptr, unsigned int *size, size_t min_size);
6144 * Same behaviour av_fast_padded_malloc except that buffer will always
6145 * be 0-initialized after call.
6147 void av_fast_padded_mallocz(void *ptr, unsigned int *size, size_t min_size);
6150 * Encode extradata length to a buffer. Used by xiph codecs.
6152 * @param s buffer to write to; must be at least (v/255+1) bytes long
6153 * @param v size of extradata in bytes
6154 * @return number of bytes written to the buffer.
6156 unsigned int av_xiphlacing(unsigned char *s, unsigned int v);
6158 #if FF_API_MISSING_SAMPLE
6160 * Log a generic warning message about a missing feature. This function is
6161 * intended to be used internally by FFmpeg (libavcodec, libavformat, etc.)
6162 * only, and would normally not be used by applications.
6163 * @param[in] avc a pointer to an arbitrary struct of which the first field is
6164 * a pointer to an AVClass struct
6165 * @param[in] feature string containing the name of the missing feature
6166 * @param[in] want_sample indicates if samples are wanted which exhibit this feature.
6167 * If want_sample is non-zero, additional verbiage will be added to the log
6168 * message which tells the user how to report samples to the development
6170 * @deprecated Use avpriv_report_missing_feature() instead.
6172 attribute_deprecated
6173 void av_log_missing_feature(void *avc, const char *feature, int want_sample);
6176 * Log a generic warning message asking for a sample. This function is
6177 * intended to be used internally by FFmpeg (libavcodec, libavformat, etc.)
6178 * only, and would normally not be used by applications.
6179 * @param[in] avc a pointer to an arbitrary struct of which the first field is
6180 * a pointer to an AVClass struct
6181 * @param[in] msg string containing an optional message, or NULL if no message
6182 * @deprecated Use avpriv_request_sample() instead.
6184 attribute_deprecated
6185 void av_log_ask_for_sample(void *avc, const char *msg, ...) av_printf_format(2, 3);
6186 #endif /* FF_API_MISSING_SAMPLE */
6189 * Register the hardware accelerator hwaccel.
6191 void av_register_hwaccel(AVHWAccel *hwaccel);
6194 * If hwaccel is NULL, returns the first registered hardware accelerator,
6195 * if hwaccel is non-NULL, returns the next registered hardware accelerator
6196 * after hwaccel, or NULL if hwaccel is the last one.
6198 AVHWAccel *av_hwaccel_next(const AVHWAccel *hwaccel);
6202 * Lock operation used by lockmgr
6205 AV_LOCK_CREATE, ///< Create a mutex
6206 AV_LOCK_OBTAIN, ///< Lock the mutex
6207 AV_LOCK_RELEASE, ///< Unlock the mutex
6208 AV_LOCK_DESTROY, ///< Free mutex resources
6212 * Register a user provided lock manager supporting the operations
6213 * specified by AVLockOp. The "mutex" argument to the function points
6214 * to a (void *) where the lockmgr should store/get a pointer to a user
6215 * allocated mutex. It is NULL upon AV_LOCK_CREATE and equal to the
6216 * value left by the last call for all other ops. If the lock manager is
6217 * unable to perform the op then it should leave the mutex in the same
6218 * state as when it was called and return a non-zero value. However,
6219 * when called with AV_LOCK_DESTROY the mutex will always be assumed to
6220 * have been successfully destroyed. If av_lockmgr_register succeeds
6221 * it will return a non-negative value, if it fails it will return a
6222 * negative value and destroy all mutex and unregister all callbacks.
6223 * av_lockmgr_register is not thread-safe, it must be called from a
6224 * single thread before any calls which make use of locking are used.
6226 * @param cb User defined callback. av_lockmgr_register invokes calls
6227 * to this callback and the previously registered callback.
6228 * The callback will be used to create more than one mutex
6229 * each of which must be backed by its own underlying locking
6230 * mechanism (i.e. do not use a single static object to
6231 * implement your lock manager). If cb is set to NULL the
6232 * lockmgr will be unregistered.
6234 int av_lockmgr_register(int (*cb)(void **mutex, enum AVLockOp op));
6237 * Get the type of the given codec.
6239 enum AVMediaType avcodec_get_type(enum AVCodecID codec_id);
6242 * Get the name of a codec.
6243 * @return a static string identifying the codec; never NULL
6245 const char *avcodec_get_name(enum AVCodecID id);
6248 * @return a positive value if s is open (i.e. avcodec_open2() was called on it
6249 * with no corresponding avcodec_close()), 0 otherwise.
6251 int avcodec_is_open(AVCodecContext *s);
6254 * @return a non-zero number if codec is an encoder, zero otherwise
6256 int av_codec_is_encoder(const AVCodec *codec);
6259 * @return a non-zero number if codec is a decoder, zero otherwise
6261 int av_codec_is_decoder(const AVCodec *codec);
6264 * @return descriptor for given codec ID or NULL if no descriptor exists.
6266 const AVCodecDescriptor *avcodec_descriptor_get(enum AVCodecID id);
6269 * Iterate over all codec descriptors known to libavcodec.
6271 * @param prev previous descriptor. NULL to get the first descriptor.
6273 * @return next descriptor or NULL after the last descriptor
6275 const AVCodecDescriptor *avcodec_descriptor_next(const AVCodecDescriptor *prev);
6278 * @return codec descriptor with the given name or NULL if no such descriptor
6281 const AVCodecDescriptor *avcodec_descriptor_get_by_name(const char *name);
6284 * Allocate a CPB properties structure and initialize its fields to default
6287 * @param size if non-NULL, the size of the allocated struct will be written
6288 * here. This is useful for embedding it in side data.
6290 * @return the newly allocated struct or NULL on failure
6292 AVCPBProperties *av_cpb_properties_alloc(size_t *size);
6298 #endif /* AVCODEC_AVCODEC_H */