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/hwcontext.h"
40 #include "libavutil/log.h"
41 #include "libavutil/pixfmt.h"
42 #include "libavutil/rational.h"
47 * @defgroup libavc libavcodec
48 * Encoding/Decoding Library
52 * @defgroup lavc_decoding Decoding
56 * @defgroup lavc_encoding Encoding
60 * @defgroup lavc_codec Codecs
62 * @defgroup lavc_codec_native Native Codecs
65 * @defgroup lavc_codec_wrappers External library wrappers
68 * @defgroup lavc_codec_hwaccel Hardware Accelerators bridge
72 * @defgroup lavc_internal Internal
80 * @defgroup lavc_encdec send/receive encoding and decoding API overview
83 * The avcodec_send_packet()/avcodec_receive_frame()/avcodec_send_frame()/
84 * avcodec_receive_packet() functions provide an encode/decode API, which
85 * decouples input and output.
87 * The API is very similar for encoding/decoding and audio/video, and works as
89 * - Set up and open the AVCodecContext as usual.
91 * - For decoding, call avcodec_send_packet() to give the decoder raw
92 * compressed data in an AVPacket.
93 * - For encoding, call avcodec_send_frame() to give the encoder an AVFrame
94 * containing uncompressed audio or video.
96 * In both cases, it is recommended that AVPackets and AVFrames are
97 * refcounted, or libavcodec might have to copy the input data. (libavformat
98 * always returns refcounted AVPackets, and av_frame_get_buffer() allocates
99 * refcounted AVFrames.)
100 * - Receive output in a loop. Periodically call one of the avcodec_receive_*()
101 * functions and process their output:
102 * - For decoding, call avcodec_receive_frame(). On success, it will return
103 * an AVFrame containing uncompressed audio or video data.
104 * - For encoding, call avcodec_receive_packet(). On success, it will return
105 * an AVPacket with a compressed frame.
107 * Repeat this call until it returns AVERROR(EAGAIN) or an error. The
108 * AVERROR(EAGAIN) return value means that new input data is required to
109 * return new output. In this case, continue with sending input. For each
110 * input frame/packet, the codec will typically return 1 output frame/packet,
111 * but it can also be 0 or more than 1.
113 * At the beginning of decoding or encoding, the codec might accept multiple
114 * input frames/packets without returning a frame, until its internal buffers
115 * are filled. This situation is handled transparently if you follow the steps
118 * In theory, sending input can result in EAGAIN - this should happen only if
119 * not all output was received. You can use this to structure alternative decode
120 * or encode loops other than the one suggested above. For example, you could
121 * try sending new input on each iteration, and try to receive output if that
124 * End of stream situations. These require "flushing" (aka draining) the codec,
125 * as the codec might buffer multiple frames or packets internally for
126 * performance or out of necessity (consider B-frames).
127 * This is handled as follows:
128 * - Instead of valid input, send NULL to the avcodec_send_packet() (decoding)
129 * or avcodec_send_frame() (encoding) functions. This will enter draining
131 * - Call avcodec_receive_frame() (decoding) or avcodec_receive_packet()
132 * (encoding) in a loop until AVERROR_EOF is returned. The functions will
133 * not return AVERROR(EAGAIN), unless you forgot to enter draining mode.
134 * - Before decoding can be resumed again, the codec has to be reset with
135 * avcodec_flush_buffers().
137 * Using the API as outlined above is highly recommended. But it is also
138 * possible to call functions outside of this rigid schema. For example, you can
139 * call avcodec_send_packet() repeatedly without calling
140 * avcodec_receive_frame(). In this case, avcodec_send_packet() will succeed
141 * until the codec's internal buffer has been filled up (which is typically of
142 * size 1 per output frame, after initial input), and then reject input with
143 * AVERROR(EAGAIN). Once it starts rejecting input, you have no choice but to
144 * read at least some output.
146 * Not all codecs will follow a rigid and predictable dataflow; the only
147 * guarantee is that an AVERROR(EAGAIN) return value on a send/receive call on
148 * one end implies that a receive/send call on the other end will succeed, or
149 * at least will not fail with AVERROR(EAGAIN). In general, no codec will
150 * permit unlimited buffering of input or output.
152 * This API replaces the following legacy functions:
153 * - avcodec_decode_video2() and avcodec_decode_audio4():
154 * Use avcodec_send_packet() to feed input to the decoder, then use
155 * avcodec_receive_frame() to receive decoded frames after each packet.
156 * Unlike with the old video decoding API, multiple frames might result from
157 * a packet. For audio, splitting the input packet into frames by partially
158 * decoding packets becomes transparent to the API user. You never need to
159 * feed an AVPacket to the API twice (unless it is rejected with AVERROR(EAGAIN) - then
160 * no data was read from the packet).
161 * Additionally, sending a flush/draining packet is required only once.
162 * - avcodec_encode_video2()/avcodec_encode_audio2():
163 * Use avcodec_send_frame() to feed input to the encoder, then use
164 * avcodec_receive_packet() to receive encoded packets.
165 * Providing user-allocated buffers for avcodec_receive_packet() is not
167 * - The new API does not handle subtitles yet.
169 * Mixing new and old function calls on the same AVCodecContext is not allowed,
170 * and will result in undefined behavior.
172 * Some codecs might require using the new API; using the old API will return
173 * an error when calling it. All codecs support the new API.
175 * A codec is not allowed to return AVERROR(EAGAIN) for both sending and receiving. This
176 * would be an invalid state, which could put the codec user into an endless
177 * loop. The API has no concept of time either: it cannot happen that trying to
178 * do avcodec_send_packet() results in AVERROR(EAGAIN), but a repeated call 1 second
179 * later accepts the packet (with no other receive/flush API calls involved).
180 * The API is a strict state machine, and the passage of time is not supposed
181 * to influence it. Some timing-dependent behavior might still be deemed
182 * acceptable in certain cases. But it must never result in both send/receive
183 * returning EAGAIN at the same time at any point. It must also absolutely be
184 * avoided that the current state is "unstable" and can "flip-flop" between
185 * the send/receive APIs allowing progress. For example, it's not allowed that
186 * the codec randomly decides that it actually wants to consume a packet now
187 * instead of returning a frame, after it just returned AVERROR(EAGAIN) on an
188 * avcodec_send_packet() call.
193 * @defgroup lavc_core Core functions/structures.
196 * Basic definitions, functions for querying libavcodec capabilities,
197 * allocating core structures, etc.
203 * Identify the syntax and semantics of the bitstream.
204 * The principle is roughly:
205 * Two decoders with the same ID can decode the same streams.
206 * Two encoders with the same ID can encode compatible streams.
207 * There may be slight deviations from the principle due to implementation
210 * If you add a codec ID to this list, add it so that
211 * 1. no value of an existing codec ID changes (that would break ABI),
212 * 2. it is as close as possible to similar codecs
214 * After adding new codec IDs, do not forget to add an entry to the codec
215 * descriptor list and bump libavcodec minor version.
221 AV_CODEC_ID_MPEG1VIDEO,
222 AV_CODEC_ID_MPEG2VIDEO, ///< preferred ID for MPEG-1/2 video decoding
233 AV_CODEC_ID_RAWVIDEO,
234 AV_CODEC_ID_MSMPEG4V1,
235 AV_CODEC_ID_MSMPEG4V2,
236 AV_CODEC_ID_MSMPEG4V3,
259 AV_CODEC_ID_INTERPLAY_VIDEO,
266 AV_CODEC_ID_MSVIDEO1,
271 AV_CODEC_ID_TRUEMOTION1,
272 AV_CODEC_ID_VMDVIDEO,
297 AV_CODEC_ID_TRUEMOTION2,
303 AV_CODEC_ID_SMACKVIDEO,
308 AV_CODEC_ID_JPEG2000,
314 AV_CODEC_ID_DSICINVIDEO,
315 AV_CODEC_ID_TIERTEXSEQVIDEO,
323 AV_CODEC_ID_BETHSOFTVID,
335 AV_CODEC_ID_ESCAPE124,
339 AV_CODEC_ID_MOTIONPIXELS,
351 AV_CODEC_ID_FLASHSV2,
352 AV_CODEC_ID_CDGRAPHICS,
355 AV_CODEC_ID_BINKVIDEO,
356 AV_CODEC_ID_IFF_ILBM,
357 #define AV_CODEC_ID_IFF_BYTERUN1 AV_CODEC_ID_IFF_ILBM
363 AV_CODEC_ID_A64_MULTI,
364 AV_CODEC_ID_A64_MULTI5,
367 AV_CODEC_ID_LAGARITH,
371 AV_CODEC_ID_WMV3IMAGE,
372 AV_CODEC_ID_VC1IMAGE,
374 AV_CODEC_ID_BMV_VIDEO,
381 AV_CODEC_ID_ZEROCODEC,
390 AV_CODEC_ID_ESCAPE130,
393 AV_CODEC_ID_HNM4_VIDEO,
395 #define AV_CODEC_ID_H265 AV_CODEC_ID_HEVC
397 AV_CODEC_ID_ALIAS_PIX,
398 AV_CODEC_ID_BRENDER_PIX,
399 AV_CODEC_ID_PAF_VIDEO,
412 AV_CODEC_ID_SCREENPRESSO,
416 AV_CODEC_ID_Y41P = 0x8000,
421 AV_CODEC_ID_TARGA_Y216,
433 AV_CODEC_ID_TRUEMOTION2RT,
435 AV_CODEC_ID_MAGICYUV,
436 AV_CODEC_ID_SHEERVIDEO,
443 AV_CODEC_ID_CLEARVIDEO,
446 AV_CODEC_ID_BITPACKED,
453 AV_CODEC_ID_PROSUMER,
467 /* various PCM "codecs" */
468 AV_CODEC_ID_FIRST_AUDIO = 0x10000, ///< A dummy id pointing at the start of audio codecs
469 AV_CODEC_ID_PCM_S16LE = 0x10000,
470 AV_CODEC_ID_PCM_S16BE,
471 AV_CODEC_ID_PCM_U16LE,
472 AV_CODEC_ID_PCM_U16BE,
475 AV_CODEC_ID_PCM_MULAW,
476 AV_CODEC_ID_PCM_ALAW,
477 AV_CODEC_ID_PCM_S32LE,
478 AV_CODEC_ID_PCM_S32BE,
479 AV_CODEC_ID_PCM_U32LE,
480 AV_CODEC_ID_PCM_U32BE,
481 AV_CODEC_ID_PCM_S24LE,
482 AV_CODEC_ID_PCM_S24BE,
483 AV_CODEC_ID_PCM_U24LE,
484 AV_CODEC_ID_PCM_U24BE,
485 AV_CODEC_ID_PCM_S24DAUD,
486 AV_CODEC_ID_PCM_ZORK,
487 AV_CODEC_ID_PCM_S16LE_PLANAR,
489 AV_CODEC_ID_PCM_F32BE,
490 AV_CODEC_ID_PCM_F32LE,
491 AV_CODEC_ID_PCM_F64BE,
492 AV_CODEC_ID_PCM_F64LE,
493 AV_CODEC_ID_PCM_BLURAY,
496 AV_CODEC_ID_PCM_S8_PLANAR,
497 AV_CODEC_ID_PCM_S24LE_PLANAR,
498 AV_CODEC_ID_PCM_S32LE_PLANAR,
499 AV_CODEC_ID_PCM_S16BE_PLANAR,
501 AV_CODEC_ID_PCM_S64LE = 0x10800,
502 AV_CODEC_ID_PCM_S64BE,
503 AV_CODEC_ID_PCM_F16LE,
504 AV_CODEC_ID_PCM_F24LE,
505 AV_CODEC_ID_PCM_VIDC,
507 /* various ADPCM codecs */
508 AV_CODEC_ID_ADPCM_IMA_QT = 0x11000,
509 AV_CODEC_ID_ADPCM_IMA_WAV,
510 AV_CODEC_ID_ADPCM_IMA_DK3,
511 AV_CODEC_ID_ADPCM_IMA_DK4,
512 AV_CODEC_ID_ADPCM_IMA_WS,
513 AV_CODEC_ID_ADPCM_IMA_SMJPEG,
514 AV_CODEC_ID_ADPCM_MS,
515 AV_CODEC_ID_ADPCM_4XM,
516 AV_CODEC_ID_ADPCM_XA,
517 AV_CODEC_ID_ADPCM_ADX,
518 AV_CODEC_ID_ADPCM_EA,
519 AV_CODEC_ID_ADPCM_G726,
520 AV_CODEC_ID_ADPCM_CT,
521 AV_CODEC_ID_ADPCM_SWF,
522 AV_CODEC_ID_ADPCM_YAMAHA,
523 AV_CODEC_ID_ADPCM_SBPRO_4,
524 AV_CODEC_ID_ADPCM_SBPRO_3,
525 AV_CODEC_ID_ADPCM_SBPRO_2,
526 AV_CODEC_ID_ADPCM_THP,
527 AV_CODEC_ID_ADPCM_IMA_AMV,
528 AV_CODEC_ID_ADPCM_EA_R1,
529 AV_CODEC_ID_ADPCM_EA_R3,
530 AV_CODEC_ID_ADPCM_EA_R2,
531 AV_CODEC_ID_ADPCM_IMA_EA_SEAD,
532 AV_CODEC_ID_ADPCM_IMA_EA_EACS,
533 AV_CODEC_ID_ADPCM_EA_XAS,
534 AV_CODEC_ID_ADPCM_EA_MAXIS_XA,
535 AV_CODEC_ID_ADPCM_IMA_ISS,
536 AV_CODEC_ID_ADPCM_G722,
537 AV_CODEC_ID_ADPCM_IMA_APC,
538 AV_CODEC_ID_ADPCM_VIMA,
540 AV_CODEC_ID_ADPCM_AFC = 0x11800,
541 AV_CODEC_ID_ADPCM_IMA_OKI,
542 AV_CODEC_ID_ADPCM_DTK,
543 AV_CODEC_ID_ADPCM_IMA_RAD,
544 AV_CODEC_ID_ADPCM_G726LE,
545 AV_CODEC_ID_ADPCM_THP_LE,
546 AV_CODEC_ID_ADPCM_PSX,
547 AV_CODEC_ID_ADPCM_AICA,
548 AV_CODEC_ID_ADPCM_IMA_DAT4,
549 AV_CODEC_ID_ADPCM_MTAF,
550 AV_CODEC_ID_ADPCM_AGM,
551 AV_CODEC_ID_ADPCM_ARGO,
552 AV_CODEC_ID_ADPCM_IMA_SSI,
553 AV_CODEC_ID_ADPCM_ZORK,
554 AV_CODEC_ID_ADPCM_IMA_APM,
555 AV_CODEC_ID_ADPCM_IMA_ALP,
556 AV_CODEC_ID_ADPCM_IMA_MTF,
559 AV_CODEC_ID_AMR_NB = 0x12000,
562 /* RealAudio codecs*/
563 AV_CODEC_ID_RA_144 = 0x13000,
566 /* various DPCM codecs */
567 AV_CODEC_ID_ROQ_DPCM = 0x14000,
568 AV_CODEC_ID_INTERPLAY_DPCM,
569 AV_CODEC_ID_XAN_DPCM,
570 AV_CODEC_ID_SOL_DPCM,
572 AV_CODEC_ID_SDX2_DPCM = 0x14800,
573 AV_CODEC_ID_GREMLIN_DPCM,
574 AV_CODEC_ID_DERF_DPCM,
577 AV_CODEC_ID_MP2 = 0x15000,
578 AV_CODEC_ID_MP3, ///< preferred ID for decoding MPEG audio layer 1, 2 or 3
588 AV_CODEC_ID_VMDAUDIO,
594 AV_CODEC_ID_WESTWOOD_SND1,
595 AV_CODEC_ID_GSM, ///< as in Berlin toast format
598 AV_CODEC_ID_TRUESPEECH,
600 AV_CODEC_ID_SMACKAUDIO,
603 AV_CODEC_ID_DSICINAUDIO,
605 AV_CODEC_ID_MUSEPACK7,
607 AV_CODEC_ID_GSM_MS, /* as found in WAV */
610 AV_CODEC_ID_NELLYMOSER,
611 AV_CODEC_ID_MUSEPACK8,
613 AV_CODEC_ID_WMAVOICE,
615 AV_CODEC_ID_WMALOSSLESS,
624 AV_CODEC_ID_BINKAUDIO_RDFT,
625 AV_CODEC_ID_BINKAUDIO_DCT,
626 AV_CODEC_ID_AAC_LATM,
631 AV_CODEC_ID_8SVX_EXP,
632 AV_CODEC_ID_8SVX_FIB,
633 AV_CODEC_ID_BMV_AUDIO,
638 AV_CODEC_ID_COMFORT_NOISE,
640 AV_CODEC_ID_METASOUND,
641 AV_CODEC_ID_PAF_AUDIO,
646 AV_CODEC_ID_FFWAVESYNTH = 0x15800,
648 AV_CODEC_ID_SONIC_LS,
651 AV_CODEC_ID_DSD_LSBF,
652 AV_CODEC_ID_DSD_MSBF,
653 AV_CODEC_ID_DSD_LSBF_PLANAR,
654 AV_CODEC_ID_DSD_MSBF_PLANAR,
656 AV_CODEC_ID_INTERPLAY_ACM,
660 AV_CODEC_ID_ATRAC3AL,
661 AV_CODEC_ID_ATRAC3PAL,
668 AV_CODEC_ID_ACELP_KELVIN,
669 AV_CODEC_ID_MPEGH_3D_AUDIO,
672 /* subtitle codecs */
673 AV_CODEC_ID_FIRST_SUBTITLE = 0x17000, ///< A dummy ID pointing at the start of subtitle codecs.
674 AV_CODEC_ID_DVD_SUBTITLE = 0x17000,
675 AV_CODEC_ID_DVB_SUBTITLE,
676 AV_CODEC_ID_TEXT, ///< raw UTF-8 text
679 AV_CODEC_ID_MOV_TEXT,
680 AV_CODEC_ID_HDMV_PGS_SUBTITLE,
681 AV_CODEC_ID_DVB_TELETEXT,
684 AV_CODEC_ID_MICRODVD = 0x17800,
688 AV_CODEC_ID_REALTEXT,
690 AV_CODEC_ID_SUBVIEWER1,
691 AV_CODEC_ID_SUBVIEWER,
698 AV_CODEC_ID_HDMV_TEXT_SUBTITLE,
700 AV_CODEC_ID_ARIB_CAPTION,
702 /* other specific kind of codecs (generally used for attachments) */
703 AV_CODEC_ID_FIRST_UNKNOWN = 0x18000, ///< A dummy ID pointing at the start of various fake codecs.
704 AV_CODEC_ID_TTF = 0x18000,
706 AV_CODEC_ID_SCTE_35, ///< Contain timestamp estimated through PCR of program stream.
708 AV_CODEC_ID_BINTEXT = 0x18800,
712 AV_CODEC_ID_SMPTE_KLV,
714 AV_CODEC_ID_TIMED_ID3,
715 AV_CODEC_ID_BIN_DATA,
718 AV_CODEC_ID_PROBE = 0x19000, ///< codec_id is not known (like AV_CODEC_ID_NONE) but lavf should attempt to identify it
720 AV_CODEC_ID_MPEG2TS = 0x20000, /**< _FAKE_ codec to indicate a raw MPEG-2 TS
721 * stream (only used by libavformat) */
722 AV_CODEC_ID_MPEG4SYSTEMS = 0x20001, /**< _FAKE_ codec to indicate a MPEG-4 Systems
723 * stream (only used by libavformat) */
724 AV_CODEC_ID_FFMETADATA = 0x21000, ///< Dummy codec for streams containing only metadata information.
725 AV_CODEC_ID_WRAPPED_AVFRAME = 0x21001, ///< Passthrough codec, AVFrames wrapped in AVPacket
729 * This struct describes the properties of a single codec described by an
731 * @see avcodec_descriptor_get()
733 typedef struct AVCodecDescriptor {
735 enum AVMediaType type;
737 * Name of the codec described by this descriptor. It is non-empty and
738 * unique for each codec descriptor. It should contain alphanumeric
739 * characters and '_' only.
743 * A more descriptive name for this codec. May be NULL.
745 const char *long_name;
747 * Codec properties, a combination of AV_CODEC_PROP_* flags.
751 * MIME type(s) associated with the codec.
752 * May be NULL; if not, a NULL-terminated array of MIME types.
753 * The first item is always non-NULL and is the preferred MIME type.
755 const char *const *mime_types;
757 * If non-NULL, an array of profiles recognized for this codec.
758 * Terminated with FF_PROFILE_UNKNOWN.
760 const struct AVProfile *profiles;
764 * Codec uses only intra compression.
765 * Video and audio codecs only.
767 #define AV_CODEC_PROP_INTRA_ONLY (1 << 0)
769 * Codec supports lossy compression. Audio and video codecs only.
770 * @note a codec may support both lossy and lossless
773 #define AV_CODEC_PROP_LOSSY (1 << 1)
775 * Codec supports lossless compression. Audio and video codecs only.
777 #define AV_CODEC_PROP_LOSSLESS (1 << 2)
779 * Codec supports frame reordering. That is, the coded order (the order in which
780 * the encoded packets are output by the encoders / stored / input to the
781 * decoders) may be different from the presentation order of the corresponding
784 * For codecs that do not have this property set, PTS and DTS should always be
787 #define AV_CODEC_PROP_REORDER (1 << 3)
789 * Subtitle codec is bitmap based
790 * Decoded AVSubtitle data can be read from the AVSubtitleRect->pict field.
792 #define AV_CODEC_PROP_BITMAP_SUB (1 << 16)
794 * Subtitle codec is text based.
795 * Decoded AVSubtitle data can be read from the AVSubtitleRect->ass field.
797 #define AV_CODEC_PROP_TEXT_SUB (1 << 17)
800 * @ingroup lavc_decoding
801 * Required number of additionally allocated bytes at the end of the input bitstream for decoding.
802 * This is mainly needed because some optimized bitstream readers read
803 * 32 or 64 bit at once and could read over the end.<br>
804 * Note: If the first 23 bits of the additional bytes are not 0, then damaged
805 * MPEG bitstreams could cause overread and segfault.
807 #define AV_INPUT_BUFFER_PADDING_SIZE 64
810 * @ingroup lavc_encoding
811 * minimum encoding buffer size
812 * Used to avoid some checks during header writing.
814 #define AV_INPUT_BUFFER_MIN_SIZE 16384
817 * @ingroup lavc_decoding
820 /* We leave some space between them for extensions (drop some
821 * keyframes for intra-only or drop just some bidir frames). */
822 AVDISCARD_NONE =-16, ///< discard nothing
823 AVDISCARD_DEFAULT = 0, ///< discard useless packets like 0 size packets in avi
824 AVDISCARD_NONREF = 8, ///< discard all non reference
825 AVDISCARD_BIDIR = 16, ///< discard all bidirectional frames
826 AVDISCARD_NONINTRA= 24, ///< discard all non intra frames
827 AVDISCARD_NONKEY = 32, ///< discard all frames except keyframes
828 AVDISCARD_ALL = 48, ///< discard all
831 enum AVAudioServiceType {
832 AV_AUDIO_SERVICE_TYPE_MAIN = 0,
833 AV_AUDIO_SERVICE_TYPE_EFFECTS = 1,
834 AV_AUDIO_SERVICE_TYPE_VISUALLY_IMPAIRED = 2,
835 AV_AUDIO_SERVICE_TYPE_HEARING_IMPAIRED = 3,
836 AV_AUDIO_SERVICE_TYPE_DIALOGUE = 4,
837 AV_AUDIO_SERVICE_TYPE_COMMENTARY = 5,
838 AV_AUDIO_SERVICE_TYPE_EMERGENCY = 6,
839 AV_AUDIO_SERVICE_TYPE_VOICE_OVER = 7,
840 AV_AUDIO_SERVICE_TYPE_KARAOKE = 8,
841 AV_AUDIO_SERVICE_TYPE_NB , ///< Not part of ABI
845 * @ingroup lavc_encoding
847 typedef struct RcOverride{
850 int qscale; // If this is 0 then quality_factor will be used instead.
851 float quality_factor;
855 These flags can be passed in AVCodecContext.flags before initialization.
856 Note: Not everything is supported yet.
860 * Allow decoders to produce frames with data planes that are not aligned
861 * to CPU requirements (e.g. due to cropping).
863 #define AV_CODEC_FLAG_UNALIGNED (1 << 0)
867 #define AV_CODEC_FLAG_QSCALE (1 << 1)
869 * 4 MV per MB allowed / advanced prediction for H.263.
871 #define AV_CODEC_FLAG_4MV (1 << 2)
873 * Output even those frames that might be corrupted.
875 #define AV_CODEC_FLAG_OUTPUT_CORRUPT (1 << 3)
879 #define AV_CODEC_FLAG_QPEL (1 << 4)
881 * Don't output frames whose parameters differ from first
882 * decoded frame in stream.
884 #define AV_CODEC_FLAG_DROPCHANGED (1 << 5)
886 * Use internal 2pass ratecontrol in first pass mode.
888 #define AV_CODEC_FLAG_PASS1 (1 << 9)
890 * Use internal 2pass ratecontrol in second pass mode.
892 #define AV_CODEC_FLAG_PASS2 (1 << 10)
896 #define AV_CODEC_FLAG_LOOP_FILTER (1 << 11)
898 * Only decode/encode grayscale.
900 #define AV_CODEC_FLAG_GRAY (1 << 13)
902 * error[?] variables will be set during encoding.
904 #define AV_CODEC_FLAG_PSNR (1 << 15)
906 * Input bitstream might be truncated at a random location
907 * instead of only at frame boundaries.
909 #define AV_CODEC_FLAG_TRUNCATED (1 << 16)
911 * Use interlaced DCT.
913 #define AV_CODEC_FLAG_INTERLACED_DCT (1 << 18)
917 #define AV_CODEC_FLAG_LOW_DELAY (1 << 19)
919 * Place global headers in extradata instead of every keyframe.
921 #define AV_CODEC_FLAG_GLOBAL_HEADER (1 << 22)
923 * Use only bitexact stuff (except (I)DCT).
925 #define AV_CODEC_FLAG_BITEXACT (1 << 23)
926 /* Fx : Flag for H.263+ extra options */
928 * H.263 advanced intra coding / MPEG-4 AC prediction
930 #define AV_CODEC_FLAG_AC_PRED (1 << 24)
932 * interlaced motion estimation
934 #define AV_CODEC_FLAG_INTERLACED_ME (1 << 29)
935 #define AV_CODEC_FLAG_CLOSED_GOP (1U << 31)
938 * Allow non spec compliant speedup tricks.
940 #define AV_CODEC_FLAG2_FAST (1 << 0)
942 * Skip bitstream encoding.
944 #define AV_CODEC_FLAG2_NO_OUTPUT (1 << 2)
946 * Place global headers at every keyframe instead of in extradata.
948 #define AV_CODEC_FLAG2_LOCAL_HEADER (1 << 3)
951 * timecode is in drop frame format. DEPRECATED!!!!
953 #define AV_CODEC_FLAG2_DROP_FRAME_TIMECODE (1 << 13)
956 * Input bitstream might be truncated at a packet boundaries
957 * instead of only at frame boundaries.
959 #define AV_CODEC_FLAG2_CHUNKS (1 << 15)
961 * Discard cropping information from SPS.
963 #define AV_CODEC_FLAG2_IGNORE_CROP (1 << 16)
966 * Show all frames before the first keyframe
968 #define AV_CODEC_FLAG2_SHOW_ALL (1 << 22)
970 * Export motion vectors through frame side data
972 #define AV_CODEC_FLAG2_EXPORT_MVS (1 << 28)
974 * Do not skip samples and export skip information as frame side data
976 #define AV_CODEC_FLAG2_SKIP_MANUAL (1 << 29)
978 * Do not reset ASS ReadOrder field on flush (subtitles decoding)
980 #define AV_CODEC_FLAG2_RO_FLUSH_NOOP (1 << 30)
982 /* Unsupported options :
983 * Syntax Arithmetic coding (SAC)
984 * Reference Picture Selection
985 * Independent Segment Decoding */
987 /* codec capabilities */
990 * Decoder can use draw_horiz_band callback.
992 #define AV_CODEC_CAP_DRAW_HORIZ_BAND (1 << 0)
994 * Codec uses get_buffer() for allocating buffers and supports custom allocators.
995 * If not set, it might not use get_buffer() at all or use operations that
996 * assume the buffer was allocated by avcodec_default_get_buffer.
998 #define AV_CODEC_CAP_DR1 (1 << 1)
999 #define AV_CODEC_CAP_TRUNCATED (1 << 3)
1001 * Encoder or decoder requires flushing with NULL input at the end in order to
1002 * give the complete and correct output.
1004 * NOTE: If this flag is not set, the codec is guaranteed to never be fed with
1005 * with NULL data. The user can still send NULL data to the public encode
1006 * or decode function, but libavcodec will not pass it along to the codec
1007 * unless this flag is set.
1010 * The decoder has a non-zero delay and needs to be fed with avpkt->data=NULL,
1011 * avpkt->size=0 at the end to get the delayed data until the decoder no longer
1015 * The encoder needs to be fed with NULL data at the end of encoding until the
1016 * encoder no longer returns data.
1018 * NOTE: For encoders implementing the AVCodec.encode2() function, setting this
1019 * flag also means that the encoder must set the pts and duration for
1020 * each output packet. If this flag is not set, the pts and duration will
1021 * be determined by libavcodec from the input frame.
1023 #define AV_CODEC_CAP_DELAY (1 << 5)
1025 * Codec can be fed a final frame with a smaller size.
1026 * This can be used to prevent truncation of the last audio samples.
1028 #define AV_CODEC_CAP_SMALL_LAST_FRAME (1 << 6)
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 * Codec is backed by a hardware implementation. Typically used to
1092 * identify a non-hwaccel hardware decoder. For information about hwaccels, use
1093 * avcodec_get_hw_config() instead.
1095 #define AV_CODEC_CAP_HARDWARE (1 << 18)
1098 * Codec is potentially backed by a hardware implementation, but not
1099 * necessarily. This is used instead of AV_CODEC_CAP_HARDWARE, if the
1100 * implementation provides some sort of internal fallback.
1102 #define AV_CODEC_CAP_HYBRID (1 << 19)
1105 * This codec takes the reordered_opaque field from input AVFrames
1106 * and returns it in the corresponding field in AVCodecContext after
1109 #define AV_CODEC_CAP_ENCODER_REORDERED_OPAQUE (1 << 20)
1111 /* Exported side data.
1112 These flags can be passed in AVCodecContext.export_side_data before initialization.
1115 * Export motion vectors through frame side data
1117 #define AV_CODEC_EXPORT_DATA_MVS (1 << 0)
1119 * Export encoder Producer Reference Time through packet side data
1121 #define AV_CODEC_EXPORT_DATA_PRFT (1 << 1)
1125 * This specifies the area which should be displayed.
1126 * Note there may be multiple such areas for one frame.
1128 typedef struct AVPanScan {
1131 * - encoding: Set by user.
1132 * - decoding: Set by libavcodec.
1137 * width and height in 1/16 pel
1138 * - encoding: Set by user.
1139 * - decoding: Set by libavcodec.
1145 * position of the top left corner in 1/16 pel for up to 3 fields/frames
1146 * - encoding: Set by user.
1147 * - decoding: Set by libavcodec.
1149 int16_t position[3][2];
1153 * This structure describes the bitrate properties of an encoded bitstream. It
1154 * roughly corresponds to a subset the VBV parameters for MPEG-2 or HRD
1155 * parameters for H.264/HEVC.
1157 typedef struct AVCPBProperties {
1159 * Maximum bitrate of the stream, in bits per second.
1160 * Zero if unknown or unspecified.
1162 #if FF_API_UNSANITIZED_BITRATES
1165 int64_t max_bitrate;
1168 * Minimum bitrate of the stream, in bits per second.
1169 * Zero if unknown or unspecified.
1171 #if FF_API_UNSANITIZED_BITRATES
1174 int64_t min_bitrate;
1177 * Average bitrate of the stream, in bits per second.
1178 * Zero if unknown or unspecified.
1180 #if FF_API_UNSANITIZED_BITRATES
1183 int64_t avg_bitrate;
1187 * The size of the buffer to which the ratecontrol is applied, in bits.
1188 * Zero if unknown or unspecified.
1193 * The delay between the time the packet this structure is associated with
1194 * is received and the time when it should be decoded, in periods of a 27MHz
1197 * UINT64_MAX when unknown or unspecified.
1203 * This structure supplies correlation between a packet timestamp and a wall clock
1204 * production time. The definition follows the Producer Reference Time ('prft')
1205 * as defined in ISO/IEC 14496-12
1207 typedef struct AVProducerReferenceTime {
1209 * A UTC timestamp, in microseconds, since Unix epoch (e.g, av_gettime()).
1213 } AVProducerReferenceTime;
1216 * The decoder will keep a reference to the frame and may reuse it later.
1218 #define AV_GET_BUFFER_FLAG_REF (1 << 0)
1221 * @defgroup lavc_packet AVPacket
1223 * Types and functions for working with AVPacket.
1226 enum AVPacketSideDataType {
1228 * An AV_PKT_DATA_PALETTE side data packet contains exactly AVPALETTE_SIZE
1229 * bytes worth of palette. This side data signals that a new palette is
1232 AV_PKT_DATA_PALETTE,
1235 * The AV_PKT_DATA_NEW_EXTRADATA is used to notify the codec or the format
1236 * that the extradata buffer was changed and the receiving side should
1237 * act upon it appropriately. The new extradata is embedded in the side
1238 * data buffer and should be immediately used for processing the current
1241 AV_PKT_DATA_NEW_EXTRADATA,
1244 * An AV_PKT_DATA_PARAM_CHANGE side data packet is laid out as follows:
1247 * if (param_flags & AV_SIDE_DATA_PARAM_CHANGE_CHANNEL_COUNT)
1248 * s32le channel_count
1249 * if (param_flags & AV_SIDE_DATA_PARAM_CHANGE_CHANNEL_LAYOUT)
1250 * u64le channel_layout
1251 * if (param_flags & AV_SIDE_DATA_PARAM_CHANGE_SAMPLE_RATE)
1253 * if (param_flags & AV_SIDE_DATA_PARAM_CHANGE_DIMENSIONS)
1258 AV_PKT_DATA_PARAM_CHANGE,
1261 * An AV_PKT_DATA_H263_MB_INFO side data packet contains a number of
1262 * structures with info about macroblocks relevant to splitting the
1263 * packet into smaller packets on macroblock edges (e.g. as for RFC 2190).
1264 * That is, it does not necessarily contain info about all macroblocks,
1265 * as long as the distance between macroblocks in the info is smaller
1266 * than the target payload size.
1267 * Each MB info structure is 12 bytes, and is laid out as follows:
1269 * u32le bit offset from the start of the packet
1270 * u8 current quantizer at the start of the macroblock
1272 * u16le macroblock address within the GOB
1273 * u8 horizontal MV predictor
1274 * u8 vertical MV predictor
1275 * u8 horizontal MV predictor for block number 3
1276 * u8 vertical MV predictor for block number 3
1279 AV_PKT_DATA_H263_MB_INFO,
1282 * This side data should be associated with an audio stream and contains
1283 * ReplayGain information in form of the AVReplayGain struct.
1285 AV_PKT_DATA_REPLAYGAIN,
1288 * This side data contains a 3x3 transformation matrix describing an affine
1289 * transformation that needs to be applied to the decoded video frames for
1290 * correct presentation.
1292 * See libavutil/display.h for a detailed description of the data.
1294 AV_PKT_DATA_DISPLAYMATRIX,
1297 * This side data should be associated with a video stream and contains
1298 * Stereoscopic 3D information in form of the AVStereo3D struct.
1300 AV_PKT_DATA_STEREO3D,
1303 * This side data should be associated with an audio stream and corresponds
1304 * to enum AVAudioServiceType.
1306 AV_PKT_DATA_AUDIO_SERVICE_TYPE,
1309 * This side data contains quality related information from the encoder.
1311 * u32le quality factor of the compressed frame. Allowed range is between 1 (good) and FF_LAMBDA_MAX (bad).
1315 * u64le[error count] sum of squared differences between encoder in and output
1318 AV_PKT_DATA_QUALITY_STATS,
1321 * This side data contains an integer value representing the stream index
1322 * of a "fallback" track. A fallback track indicates an alternate
1323 * track to use when the current track can not be decoded for some reason.
1324 * e.g. no decoder available for codec.
1326 AV_PKT_DATA_FALLBACK_TRACK,
1329 * This side data corresponds to the AVCPBProperties struct.
1331 AV_PKT_DATA_CPB_PROPERTIES,
1334 * Recommmends skipping the specified number of samples
1336 * u32le number of samples to skip from start of this packet
1337 * u32le number of samples to skip from end of this packet
1338 * u8 reason for start skip
1339 * u8 reason for end skip (0=padding silence, 1=convergence)
1342 AV_PKT_DATA_SKIP_SAMPLES,
1345 * An AV_PKT_DATA_JP_DUALMONO side data packet indicates that
1346 * the packet may contain "dual mono" audio specific to Japanese DTV
1347 * and if it is true, recommends only the selected channel to be used.
1349 * u8 selected channels (0=mail/left, 1=sub/right, 2=both)
1352 AV_PKT_DATA_JP_DUALMONO,
1355 * A list of zero terminated key/value strings. There is no end marker for
1356 * the list, so it is required to rely on the side data size to stop.
1358 AV_PKT_DATA_STRINGS_METADATA,
1361 * Subtitle event position
1369 AV_PKT_DATA_SUBTITLE_POSITION,
1372 * Data found in BlockAdditional element of matroska container. There is
1373 * no end marker for the data, so it is required to rely on the side data
1374 * size to recognize the end. 8 byte id (as found in BlockAddId) followed
1377 AV_PKT_DATA_MATROSKA_BLOCKADDITIONAL,
1380 * The optional first identifier line of a WebVTT cue.
1382 AV_PKT_DATA_WEBVTT_IDENTIFIER,
1385 * The optional settings (rendering instructions) that immediately
1386 * follow the timestamp specifier of a WebVTT cue.
1388 AV_PKT_DATA_WEBVTT_SETTINGS,
1391 * A list of zero terminated key/value strings. There is no end marker for
1392 * the list, so it is required to rely on the side data size to stop. This
1393 * side data includes updated metadata which appeared in the stream.
1395 AV_PKT_DATA_METADATA_UPDATE,
1398 * MPEGTS stream ID as uint8_t, this is required to pass the stream ID
1399 * information from the demuxer to the corresponding muxer.
1401 AV_PKT_DATA_MPEGTS_STREAM_ID,
1404 * Mastering display metadata (based on SMPTE-2086:2014). This metadata
1405 * should be associated with a video stream and contains data in the form
1406 * of the AVMasteringDisplayMetadata struct.
1408 AV_PKT_DATA_MASTERING_DISPLAY_METADATA,
1411 * This side data should be associated with a video stream and corresponds
1412 * to the AVSphericalMapping structure.
1414 AV_PKT_DATA_SPHERICAL,
1417 * Content light level (based on CTA-861.3). This metadata should be
1418 * associated with a video stream and contains data in the form of the
1419 * AVContentLightMetadata struct.
1421 AV_PKT_DATA_CONTENT_LIGHT_LEVEL,
1424 * ATSC A53 Part 4 Closed Captions. This metadata should be associated with
1425 * a video stream. A53 CC bitstream is stored as uint8_t in AVPacketSideData.data.
1426 * The number of bytes of CC data is AVPacketSideData.size.
1431 * This side data is encryption initialization data.
1432 * The format is not part of ABI, use av_encryption_init_info_* methods to
1435 AV_PKT_DATA_ENCRYPTION_INIT_INFO,
1438 * This side data contains encryption info for how to decrypt the packet.
1439 * The format is not part of ABI, use av_encryption_info_* methods to access.
1441 AV_PKT_DATA_ENCRYPTION_INFO,
1444 * Active Format Description data consisting of a single byte as specified
1445 * in ETSI TS 101 154 using AVActiveFormatDescription enum.
1450 * Producer Reference Time data corresponding to the AVProducerReferenceTime struct,
1451 * usually exported by some encoders (on demand through the prft flag set in the
1452 * AVCodecContext export_side_data field).
1457 * ICC profile data consisting of an opaque octet buffer following the
1458 * format described by ISO 15076-1.
1460 AV_PKT_DATA_ICC_PROFILE,
1463 * The number of side data types.
1464 * This is not part of the public API/ABI in the sense that it may
1465 * change when new side data types are added.
1466 * This must stay the last enum value.
1467 * If its value becomes huge, some code using it
1468 * needs to be updated as it assumes it to be smaller than other limits.
1473 #define AV_PKT_DATA_QUALITY_FACTOR AV_PKT_DATA_QUALITY_STATS //DEPRECATED
1475 typedef struct AVPacketSideData {
1478 enum AVPacketSideDataType type;
1482 * This structure stores compressed data. It is typically exported by demuxers
1483 * and then passed as input to decoders, or received as output from encoders and
1484 * then passed to muxers.
1486 * For video, it should typically contain one compressed frame. For audio it may
1487 * contain several compressed frames. Encoders are allowed to output empty
1488 * packets, with no compressed data, containing only side data
1489 * (e.g. to update some stream parameters at the end of encoding).
1491 * AVPacket is one of the few structs in FFmpeg, whose size is a part of public
1492 * ABI. Thus it may be allocated on stack and no new fields can be added to it
1493 * without libavcodec and libavformat major bump.
1495 * The semantics of data ownership depends on the buf field.
1496 * If it is set, the packet data is dynamically allocated and is
1497 * valid indefinitely until a call to av_packet_unref() reduces the
1498 * reference count to 0.
1500 * If the buf field is not set av_packet_ref() would make a copy instead
1501 * of increasing the reference count.
1503 * The side data is always allocated with av_malloc(), copied by
1504 * av_packet_ref() and freed by av_packet_unref().
1506 * @see av_packet_ref
1507 * @see av_packet_unref
1509 typedef struct AVPacket {
1511 * A reference to the reference-counted buffer where the packet data is
1513 * May be NULL, then the packet data is not reference-counted.
1517 * Presentation timestamp in AVStream->time_base units; the time at which
1518 * the decompressed packet will be presented to the user.
1519 * Can be AV_NOPTS_VALUE if it is not stored in the file.
1520 * pts MUST be larger or equal to dts as presentation cannot happen before
1521 * decompression, unless one wants to view hex dumps. Some formats misuse
1522 * the terms dts and pts/cts to mean something different. Such timestamps
1523 * must be converted to true pts/dts before they are stored in AVPacket.
1527 * Decompression timestamp in AVStream->time_base units; the time at which
1528 * the packet is decompressed.
1529 * Can be AV_NOPTS_VALUE if it is not stored in the file.
1536 * A combination of AV_PKT_FLAG values
1540 * Additional packet data that can be provided by the container.
1541 * Packet can contain several types of side information.
1543 AVPacketSideData *side_data;
1544 int side_data_elems;
1547 * Duration of this packet in AVStream->time_base units, 0 if unknown.
1548 * Equals next_pts - this_pts in presentation order.
1552 int64_t pos; ///< byte position in stream, -1 if unknown
1554 #if FF_API_CONVERGENCE_DURATION
1556 * @deprecated Same as the duration field, but as int64_t. This was required
1557 * for Matroska subtitles, whose duration values could overflow when the
1558 * duration field was still an int.
1560 attribute_deprecated
1561 int64_t convergence_duration;
1564 #define AV_PKT_FLAG_KEY 0x0001 ///< The packet contains a keyframe
1565 #define AV_PKT_FLAG_CORRUPT 0x0002 ///< The packet content is corrupted
1567 * Flag is used to discard packets which are required to maintain valid
1568 * decoder state but are not required for output and should be dropped
1571 #define AV_PKT_FLAG_DISCARD 0x0004
1573 * The packet comes from a trusted source.
1575 * Otherwise-unsafe constructs such as arbitrary pointers to data
1576 * outside the packet may be followed.
1578 #define AV_PKT_FLAG_TRUSTED 0x0008
1580 * Flag is used to indicate packets that contain frames that can
1581 * be discarded by the decoder. I.e. Non-reference frames.
1583 #define AV_PKT_FLAG_DISPOSABLE 0x0010
1586 enum AVSideDataParamChangeFlags {
1587 AV_SIDE_DATA_PARAM_CHANGE_CHANNEL_COUNT = 0x0001,
1588 AV_SIDE_DATA_PARAM_CHANGE_CHANNEL_LAYOUT = 0x0002,
1589 AV_SIDE_DATA_PARAM_CHANGE_SAMPLE_RATE = 0x0004,
1590 AV_SIDE_DATA_PARAM_CHANGE_DIMENSIONS = 0x0008,
1596 struct AVCodecInternal;
1600 AV_FIELD_PROGRESSIVE,
1601 AV_FIELD_TT, //< Top coded_first, top displayed first
1602 AV_FIELD_BB, //< Bottom coded first, bottom displayed first
1603 AV_FIELD_TB, //< Top coded first, bottom displayed first
1604 AV_FIELD_BT, //< Bottom coded first, top displayed first
1608 * main external API structure.
1609 * New fields can be added to the end with minor version bumps.
1610 * Removal, reordering and changes to existing fields require a major
1612 * You can use AVOptions (av_opt* / av_set/get*()) to access these fields from user
1614 * The name string for AVOptions options matches the associated command line
1615 * parameter name and can be found in libavcodec/options_table.h
1616 * The AVOption/command line parameter names differ in some cases from the C
1617 * structure field names for historic reasons or brevity.
1618 * sizeof(AVCodecContext) must not be used outside libav*.
1620 typedef struct AVCodecContext {
1622 * information on struct for av_log
1623 * - set by avcodec_alloc_context3
1625 const AVClass *av_class;
1626 int log_level_offset;
1628 enum AVMediaType codec_type; /* see AVMEDIA_TYPE_xxx */
1629 const struct AVCodec *codec;
1630 enum AVCodecID codec_id; /* see AV_CODEC_ID_xxx */
1633 * fourcc (LSB first, so "ABCD" -> ('D'<<24) + ('C'<<16) + ('B'<<8) + 'A').
1634 * This is used to work around some encoder bugs.
1635 * A demuxer should set this to what is stored in the field used to identify the codec.
1636 * If there are multiple such fields in a container then the demuxer should choose the one
1637 * which maximizes the information about the used codec.
1638 * If the codec tag field in a container is larger than 32 bits then the demuxer should
1639 * remap the longer ID to 32 bits with a table or other structure. Alternatively a new
1640 * extra_codec_tag + size could be added but for this a clear advantage must be demonstrated
1642 * - encoding: Set by user, if not then the default based on codec_id will be used.
1643 * - decoding: Set by user, will be converted to uppercase by libavcodec during init.
1645 unsigned int codec_tag;
1650 * Private context used for internal data.
1652 * Unlike priv_data, this is not codec-specific. It is used in general
1653 * libavcodec functions.
1655 struct AVCodecInternal *internal;
1658 * Private data of the user, can be used to carry app specific stuff.
1659 * - encoding: Set by user.
1660 * - decoding: Set by user.
1665 * the average bitrate
1666 * - encoding: Set by user; unused for constant quantizer encoding.
1667 * - decoding: Set by user, may be overwritten by libavcodec
1668 * if this info is available in the stream
1673 * number of bits the bitstream is allowed to diverge from the reference.
1674 * the reference can be CBR (for CBR pass1) or VBR (for pass2)
1675 * - encoding: Set by user; unused for constant quantizer encoding.
1676 * - decoding: unused
1678 int bit_rate_tolerance;
1681 * Global quality for codecs which cannot change it per frame.
1682 * This should be proportional to MPEG-1/2/4 qscale.
1683 * - encoding: Set by user.
1684 * - decoding: unused
1689 * - encoding: Set by user.
1690 * - decoding: unused
1692 int compression_level;
1693 #define FF_COMPRESSION_DEFAULT -1
1697 * - encoding: Set by user.
1698 * - decoding: Set by user.
1704 * - encoding: Set by user.
1705 * - decoding: Set by user.
1710 * some codecs need / can use extradata like Huffman tables.
1711 * MJPEG: Huffman tables
1712 * rv10: additional flags
1713 * MPEG-4: global headers (they can be in the bitstream or here)
1714 * The allocated memory should be AV_INPUT_BUFFER_PADDING_SIZE bytes larger
1715 * than extradata_size to avoid problems if it is read with the bitstream reader.
1716 * The bytewise contents of extradata must not depend on the architecture or CPU endianness.
1717 * Must be allocated with the av_malloc() family of functions.
1718 * - encoding: Set/allocated/freed by libavcodec.
1719 * - decoding: Set/allocated/freed by user.
1725 * This is the fundamental unit of time (in seconds) in terms
1726 * of which frame timestamps are represented. For fixed-fps content,
1727 * timebase should be 1/framerate and timestamp increments should be
1729 * This often, but not always is the inverse of the frame rate or field rate
1730 * for video. 1/time_base is not the average frame rate if the frame rate is not
1733 * Like containers, elementary streams also can store timestamps, 1/time_base
1734 * is the unit in which these timestamps are specified.
1735 * As example of such codec time base see ISO/IEC 14496-2:2001(E)
1736 * vop_time_increment_resolution and fixed_vop_rate
1737 * (fixed_vop_rate == 0 implies that it is different from the framerate)
1739 * - encoding: MUST be set by user.
1740 * - decoding: the use of this field for decoding is deprecated.
1741 * Use framerate instead.
1743 AVRational time_base;
1746 * For some codecs, the time base is closer to the field rate than the frame rate.
1747 * Most notably, H.264 and MPEG-2 specify time_base as half of frame duration
1748 * if no telecine is used ...
1750 * Set to time_base ticks per frame. Default 1, e.g., H.264/MPEG-2 set it to 2.
1752 int ticks_per_frame;
1757 * Encoding: Number of frames delay there will be from the encoder input to
1758 * the decoder output. (we assume the decoder matches the spec)
1759 * Decoding: Number of frames delay in addition to what a standard decoder
1760 * as specified in the spec would produce.
1763 * Number of frames the decoded output will be delayed relative to the
1767 * For encoding, this field is unused (see initial_padding).
1769 * For decoding, this is the number of samples the decoder needs to
1770 * output before the decoder's output is valid. When seeking, you should
1771 * start decoding this many samples prior to your desired seek point.
1773 * - encoding: Set by libavcodec.
1774 * - decoding: Set by libavcodec.
1781 * picture width / height.
1783 * @note Those fields may not match the values of the last
1784 * AVFrame output by avcodec_decode_video2 due frame
1787 * - encoding: MUST be set by user.
1788 * - decoding: May be set by the user before opening the decoder if known e.g.
1789 * from the container. Some decoders will require the dimensions
1790 * to be set by the caller. During decoding, the decoder may
1791 * overwrite those values as required while parsing the data.
1796 * Bitstream width / height, may be different from width/height e.g. when
1797 * the decoded frame is cropped before being output or lowres is enabled.
1799 * @note Those field may not match the value of the last
1800 * AVFrame output by avcodec_receive_frame() due frame
1803 * - encoding: unused
1804 * - decoding: May be set by the user before opening the decoder if known
1805 * e.g. from the container. During decoding, the decoder may
1806 * overwrite those values as required while parsing the data.
1808 int coded_width, coded_height;
1811 * the number of pictures in a group of pictures, or 0 for intra_only
1812 * - encoding: Set by user.
1813 * - decoding: unused
1818 * Pixel format, see AV_PIX_FMT_xxx.
1819 * May be set by the demuxer if known from headers.
1820 * May be overridden by the decoder if it knows better.
1822 * @note This field may not match the value of the last
1823 * AVFrame output by avcodec_receive_frame() due frame
1826 * - encoding: Set by user.
1827 * - decoding: Set by user if known, overridden by libavcodec while
1830 enum AVPixelFormat pix_fmt;
1833 * If non NULL, 'draw_horiz_band' is called by the libavcodec
1834 * decoder to draw a horizontal band. It improves cache usage. Not
1835 * all codecs can do that. You must check the codec capabilities
1837 * When multithreading is used, it may be called from multiple threads
1838 * at the same time; threads might draw different parts of the same AVFrame,
1839 * or multiple AVFrames, and there is no guarantee that slices will be drawn
1841 * The function is also used by hardware acceleration APIs.
1842 * It is called at least once during frame decoding to pass
1843 * the data needed for hardware render.
1844 * In that mode instead of pixel data, AVFrame points to
1845 * a structure specific to the acceleration API. The application
1846 * reads the structure and can change some fields to indicate progress
1848 * - encoding: unused
1849 * - decoding: Set by user.
1850 * @param height the height of the slice
1851 * @param y the y position of the slice
1852 * @param type 1->top field, 2->bottom field, 3->frame
1853 * @param offset offset into the AVFrame.data from which the slice should be read
1855 void (*draw_horiz_band)(struct AVCodecContext *s,
1856 const AVFrame *src, int offset[AV_NUM_DATA_POINTERS],
1857 int y, int type, int height);
1860 * callback to negotiate the pixelFormat
1861 * @param fmt is the list of formats which are supported by the codec,
1862 * it is terminated by -1 as 0 is a valid format, the formats are ordered by quality.
1863 * The first is always the native one.
1864 * @note The callback may be called again immediately if initialization for
1865 * the selected (hardware-accelerated) pixel format failed.
1866 * @warning Behavior is undefined if the callback returns a value not
1867 * in the fmt list of formats.
1868 * @return the chosen format
1869 * - encoding: unused
1870 * - decoding: Set by user, if not set the native format will be chosen.
1872 enum AVPixelFormat (*get_format)(struct AVCodecContext *s, const enum AVPixelFormat * fmt);
1875 * maximum number of B-frames between non-B-frames
1876 * Note: The output will be delayed by max_b_frames+1 relative to the input.
1877 * - encoding: Set by user.
1878 * - decoding: unused
1883 * qscale factor between IP and B-frames
1884 * If > 0 then the last P-frame quantizer will be used (q= lastp_q*factor+offset).
1885 * If < 0 then normal ratecontrol will be done (q= -normal_q*factor+offset).
1886 * - encoding: Set by user.
1887 * - decoding: unused
1889 float b_quant_factor;
1891 #if FF_API_PRIVATE_OPT
1892 /** @deprecated use encoder private options instead */
1893 attribute_deprecated
1894 int b_frame_strategy;
1898 * qscale offset between IP and B-frames
1899 * - encoding: Set by user.
1900 * - decoding: unused
1902 float b_quant_offset;
1905 * Size of the frame reordering buffer in the decoder.
1906 * For MPEG-2 it is 1 IPB or 0 low delay IP.
1907 * - encoding: Set by libavcodec.
1908 * - decoding: Set by libavcodec.
1912 #if FF_API_PRIVATE_OPT
1913 /** @deprecated use encoder private options instead */
1914 attribute_deprecated
1919 * qscale factor between P- and I-frames
1920 * If > 0 then the last P-frame quantizer will be used (q = lastp_q * factor + offset).
1921 * If < 0 then normal ratecontrol will be done (q= -normal_q*factor+offset).
1922 * - encoding: Set by user.
1923 * - decoding: unused
1925 float i_quant_factor;
1928 * qscale offset between P and I-frames
1929 * - encoding: Set by user.
1930 * - decoding: unused
1932 float i_quant_offset;
1935 * luminance masking (0-> disabled)
1936 * - encoding: Set by user.
1937 * - decoding: unused
1942 * temporary complexity masking (0-> disabled)
1943 * - encoding: Set by user.
1944 * - decoding: unused
1946 float temporal_cplx_masking;
1949 * spatial complexity masking (0-> disabled)
1950 * - encoding: Set by user.
1951 * - decoding: unused
1953 float spatial_cplx_masking;
1956 * p block masking (0-> disabled)
1957 * - encoding: Set by user.
1958 * - decoding: unused
1963 * darkness masking (0-> disabled)
1964 * - encoding: Set by user.
1965 * - decoding: unused
1971 * - encoding: Set by libavcodec.
1972 * - decoding: Set by user (or 0).
1976 #if FF_API_PRIVATE_OPT
1977 /** @deprecated use encoder private options instead */
1978 attribute_deprecated
1979 int prediction_method;
1980 #define FF_PRED_LEFT 0
1981 #define FF_PRED_PLANE 1
1982 #define FF_PRED_MEDIAN 2
1986 * slice offsets in the frame in bytes
1987 * - encoding: Set/allocated by libavcodec.
1988 * - decoding: Set/allocated by user (or NULL).
1993 * sample aspect ratio (0 if unknown)
1994 * That is the width of a pixel divided by the height of the pixel.
1995 * Numerator and denominator must be relatively prime and smaller than 256 for some video standards.
1996 * - encoding: Set by user.
1997 * - decoding: Set by libavcodec.
1999 AVRational sample_aspect_ratio;
2002 * motion estimation comparison function
2003 * - encoding: Set by user.
2004 * - decoding: unused
2008 * subpixel motion estimation comparison function
2009 * - encoding: Set by user.
2010 * - decoding: unused
2014 * macroblock comparison function (not supported yet)
2015 * - encoding: Set by user.
2016 * - decoding: unused
2020 * interlaced DCT comparison function
2021 * - encoding: Set by user.
2022 * - decoding: unused
2025 #define FF_CMP_SAD 0
2026 #define FF_CMP_SSE 1
2027 #define FF_CMP_SATD 2
2028 #define FF_CMP_DCT 3
2029 #define FF_CMP_PSNR 4
2030 #define FF_CMP_BIT 5
2032 #define FF_CMP_ZERO 7
2033 #define FF_CMP_VSAD 8
2034 #define FF_CMP_VSSE 9
2035 #define FF_CMP_NSSE 10
2036 #define FF_CMP_W53 11
2037 #define FF_CMP_W97 12
2038 #define FF_CMP_DCTMAX 13
2039 #define FF_CMP_DCT264 14
2040 #define FF_CMP_MEDIAN_SAD 15
2041 #define FF_CMP_CHROMA 256
2044 * ME diamond size & shape
2045 * - encoding: Set by user.
2046 * - decoding: unused
2051 * amount of previous MV predictors (2a+1 x 2a+1 square)
2052 * - encoding: Set by user.
2053 * - decoding: unused
2055 int last_predictor_count;
2057 #if FF_API_PRIVATE_OPT
2058 /** @deprecated use encoder private options instead */
2059 attribute_deprecated
2064 * motion estimation prepass comparison function
2065 * - encoding: Set by user.
2066 * - decoding: unused
2071 * ME prepass diamond size & shape
2072 * - encoding: Set by user.
2073 * - decoding: unused
2079 * - encoding: Set by user.
2080 * - decoding: unused
2082 int me_subpel_quality;
2085 * maximum motion estimation search range in subpel units
2086 * If 0 then no limit.
2088 * - encoding: Set by user.
2089 * - decoding: unused
2095 * - encoding: unused
2096 * - decoding: Set by user.
2099 #define SLICE_FLAG_CODED_ORDER 0x0001 ///< draw_horiz_band() is called in coded order instead of display
2100 #define SLICE_FLAG_ALLOW_FIELD 0x0002 ///< allow draw_horiz_band() with field slices (MPEG-2 field pics)
2101 #define SLICE_FLAG_ALLOW_PLANE 0x0004 ///< allow draw_horiz_band() with 1 component at a time (SVQ1)
2104 * macroblock decision mode
2105 * - encoding: Set by user.
2106 * - decoding: unused
2109 #define FF_MB_DECISION_SIMPLE 0 ///< uses mb_cmp
2110 #define FF_MB_DECISION_BITS 1 ///< chooses the one which needs the fewest bits
2111 #define FF_MB_DECISION_RD 2 ///< rate distortion
2114 * custom intra quantization matrix
2115 * Must be allocated with the av_malloc() family of functions, and will be freed in
2116 * avcodec_free_context().
2117 * - encoding: Set/allocated by user, freed by libavcodec. Can be NULL.
2118 * - decoding: Set/allocated/freed by libavcodec.
2120 uint16_t *intra_matrix;
2123 * custom inter quantization matrix
2124 * Must be allocated with the av_malloc() family of functions, and will be freed in
2125 * avcodec_free_context().
2126 * - encoding: Set/allocated by user, freed by libavcodec. Can be NULL.
2127 * - decoding: Set/allocated/freed by libavcodec.
2129 uint16_t *inter_matrix;
2131 #if FF_API_PRIVATE_OPT
2132 /** @deprecated use encoder private options instead */
2133 attribute_deprecated
2134 int scenechange_threshold;
2136 /** @deprecated use encoder private options instead */
2137 attribute_deprecated
2138 int noise_reduction;
2142 * precision of the intra DC coefficient - 8
2143 * - encoding: Set by user.
2144 * - decoding: Set by libavcodec
2146 int intra_dc_precision;
2149 * Number of macroblock rows at the top which are skipped.
2150 * - encoding: unused
2151 * - decoding: Set by user.
2156 * Number of macroblock rows at the bottom which are skipped.
2157 * - encoding: unused
2158 * - decoding: Set by user.
2163 * minimum MB Lagrange multiplier
2164 * - encoding: Set by user.
2165 * - decoding: unused
2170 * maximum MB Lagrange multiplier
2171 * - encoding: Set by user.
2172 * - decoding: unused
2176 #if FF_API_PRIVATE_OPT
2178 * @deprecated use encoder private options instead
2180 attribute_deprecated
2181 int me_penalty_compensation;
2185 * - encoding: Set by user.
2186 * - decoding: unused
2190 #if FF_API_PRIVATE_OPT
2191 /** @deprecated use encoder private options instead */
2192 attribute_deprecated
2198 * - encoding: Set by user.
2199 * - decoding: unused
2204 * number of reference frames
2205 * - encoding: Set by user.
2206 * - decoding: Set by lavc.
2210 #if FF_API_PRIVATE_OPT
2211 /** @deprecated use encoder private options instead */
2212 attribute_deprecated
2217 * Note: Value depends upon the compare function used for fullpel ME.
2218 * - encoding: Set by user.
2219 * - decoding: unused
2223 #if FF_API_PRIVATE_OPT
2224 /** @deprecated use encoder private options instead */
2225 attribute_deprecated
2230 * Chromaticity coordinates of the source primaries.
2231 * - encoding: Set by user
2232 * - decoding: Set by libavcodec
2234 enum AVColorPrimaries color_primaries;
2237 * Color Transfer Characteristic.
2238 * - encoding: Set by user
2239 * - decoding: Set by libavcodec
2241 enum AVColorTransferCharacteristic color_trc;
2244 * YUV colorspace type.
2245 * - encoding: Set by user
2246 * - decoding: Set by libavcodec
2248 enum AVColorSpace colorspace;
2251 * MPEG vs JPEG YUV range.
2252 * - encoding: Set by user
2253 * - decoding: Set by libavcodec
2255 enum AVColorRange color_range;
2258 * This defines the location of chroma samples.
2259 * - encoding: Set by user
2260 * - decoding: Set by libavcodec
2262 enum AVChromaLocation chroma_sample_location;
2266 * Indicates number of picture subdivisions. Used for parallelized
2268 * - encoding: Set by user
2269 * - decoding: unused
2274 * - encoding: set by libavcodec
2275 * - decoding: Set by user.
2277 enum AVFieldOrder field_order;
2280 int sample_rate; ///< samples per second
2281 int channels; ///< number of audio channels
2284 * audio sample format
2285 * - encoding: Set by user.
2286 * - decoding: Set by libavcodec.
2288 enum AVSampleFormat sample_fmt; ///< sample format
2290 /* The following data should not be initialized. */
2292 * Number of samples per channel in an audio frame.
2294 * - encoding: set by libavcodec in avcodec_open2(). Each submitted frame
2295 * except the last must contain exactly frame_size samples per channel.
2296 * May be 0 when the codec has AV_CODEC_CAP_VARIABLE_FRAME_SIZE set, then the
2297 * frame size is not restricted.
2298 * - decoding: may be set by some decoders to indicate constant frame size
2303 * Frame counter, set by libavcodec.
2305 * - decoding: total number of frames returned from the decoder so far.
2306 * - encoding: total number of frames passed to the encoder so far.
2308 * @note the counter is not incremented if encoding/decoding resulted in
2314 * number of bytes per packet if constant and known or 0
2315 * Used by some WAV based audio codecs.
2320 * Audio cutoff bandwidth (0 means "automatic")
2321 * - encoding: Set by user.
2322 * - decoding: unused
2327 * Audio channel layout.
2328 * - encoding: set by user.
2329 * - decoding: set by user, may be overwritten by libavcodec.
2331 uint64_t channel_layout;
2334 * Request decoder to use this channel layout if it can (0 for default)
2335 * - encoding: unused
2336 * - decoding: Set by user.
2338 uint64_t request_channel_layout;
2341 * Type of service that the audio stream conveys.
2342 * - encoding: Set by user.
2343 * - decoding: Set by libavcodec.
2345 enum AVAudioServiceType audio_service_type;
2348 * desired sample format
2349 * - encoding: Not used.
2350 * - decoding: Set by user.
2351 * Decoder will decode to this format if it can.
2353 enum AVSampleFormat request_sample_fmt;
2356 * This callback is called at the beginning of each frame to get data
2357 * buffer(s) for it. There may be one contiguous buffer for all the data or
2358 * there may be a buffer per each data plane or anything in between. What
2359 * this means is, you may set however many entries in buf[] you feel necessary.
2360 * Each buffer must be reference-counted using the AVBuffer API (see description
2363 * The following fields will be set in the frame before this callback is
2366 * - width, height (video only)
2367 * - sample_rate, channel_layout, nb_samples (audio only)
2368 * Their values may differ from the corresponding values in
2369 * AVCodecContext. This callback must use the frame values, not the codec
2370 * context values, to calculate the required buffer size.
2372 * This callback must fill the following fields in the frame:
2376 * * if the data is planar audio with more than 8 channels, then this
2377 * callback must allocate and fill extended_data to contain all pointers
2378 * to all data planes. data[] must hold as many pointers as it can.
2379 * extended_data must be allocated with av_malloc() and will be freed in
2381 * * otherwise extended_data must point to data
2382 * - buf[] must contain one or more pointers to AVBufferRef structures. Each of
2383 * the frame's data and extended_data pointers must be contained in these. That
2384 * is, one AVBufferRef for each allocated chunk of memory, not necessarily one
2385 * AVBufferRef per data[] entry. See: av_buffer_create(), av_buffer_alloc(),
2386 * and av_buffer_ref().
2387 * - extended_buf and nb_extended_buf must be allocated with av_malloc() by
2388 * this callback and filled with the extra buffers if there are more
2389 * buffers than buf[] can hold. extended_buf will be freed in
2392 * If AV_CODEC_CAP_DR1 is not set then get_buffer2() must call
2393 * avcodec_default_get_buffer2() instead of providing buffers allocated by
2396 * Each data plane must be aligned to the maximum required by the target
2399 * @see avcodec_default_get_buffer2()
2403 * If AV_GET_BUFFER_FLAG_REF is set in flags then the frame may be reused
2404 * (read and/or written to if it is writable) later by libavcodec.
2406 * avcodec_align_dimensions2() should be used to find the required width and
2407 * height, as they normally need to be rounded up to the next multiple of 16.
2409 * Some decoders do not support linesizes changing between frames.
2411 * If frame multithreading is used and thread_safe_callbacks is set,
2412 * this callback may be called from a different thread, but not from more
2413 * than one at once. Does not need to be reentrant.
2415 * @see avcodec_align_dimensions2()
2419 * Decoders request a buffer of a particular size by setting
2420 * AVFrame.nb_samples prior to calling get_buffer2(). The decoder may,
2421 * however, utilize only part of the buffer by setting AVFrame.nb_samples
2422 * to a smaller value in the output frame.
2424 * As a convenience, av_samples_get_buffer_size() and
2425 * av_samples_fill_arrays() in libavutil may be used by custom get_buffer2()
2426 * functions to find the required data size and to fill data pointers and
2427 * linesize. In AVFrame.linesize, only linesize[0] may be set for audio
2428 * since all planes must be the same size.
2430 * @see av_samples_get_buffer_size(), av_samples_fill_arrays()
2432 * - encoding: unused
2433 * - decoding: Set by libavcodec, user can override.
2435 int (*get_buffer2)(struct AVCodecContext *s, AVFrame *frame, int flags);
2438 * If non-zero, the decoded audio and video frames returned from
2439 * avcodec_decode_video2() and avcodec_decode_audio4() are reference-counted
2440 * and are valid indefinitely. The caller must free them with
2441 * av_frame_unref() when they are not needed anymore.
2442 * Otherwise, the decoded frames must not be freed by the caller and are
2443 * only valid until the next decode call.
2445 * This is always automatically enabled if avcodec_receive_frame() is used.
2447 * - encoding: unused
2448 * - decoding: set by the caller before avcodec_open2().
2450 attribute_deprecated
2451 int refcounted_frames;
2453 /* - encoding parameters */
2454 float qcompress; ///< amount of qscale change between easy & hard scenes (0.0-1.0)
2455 float qblur; ///< amount of qscale smoothing over time (0.0-1.0)
2459 * - encoding: Set by user.
2460 * - decoding: unused
2466 * - encoding: Set by user.
2467 * - decoding: unused
2472 * maximum quantizer difference between frames
2473 * - encoding: Set by user.
2474 * - decoding: unused
2479 * decoder bitstream buffer size
2480 * - encoding: Set by user.
2481 * - decoding: unused
2486 * ratecontrol override, see RcOverride
2487 * - encoding: Allocated/set/freed by user.
2488 * - decoding: unused
2490 int rc_override_count;
2491 RcOverride *rc_override;
2495 * - encoding: Set by user.
2496 * - decoding: Set by user, may be overwritten by libavcodec.
2498 int64_t rc_max_rate;
2502 * - encoding: Set by user.
2503 * - decoding: unused
2505 int64_t rc_min_rate;
2508 * Ratecontrol attempt to use, at maximum, <value> of what can be used without an underflow.
2509 * - encoding: Set by user.
2510 * - decoding: unused.
2512 float rc_max_available_vbv_use;
2515 * Ratecontrol attempt to use, at least, <value> times the amount needed to prevent a vbv overflow.
2516 * - encoding: Set by user.
2517 * - decoding: unused.
2519 float rc_min_vbv_overflow_use;
2522 * Number of bits which should be loaded into the rc buffer before decoding starts.
2523 * - encoding: Set by user.
2524 * - decoding: unused
2526 int rc_initial_buffer_occupancy;
2528 #if FF_API_CODER_TYPE
2529 #define FF_CODER_TYPE_VLC 0
2530 #define FF_CODER_TYPE_AC 1
2531 #define FF_CODER_TYPE_RAW 2
2532 #define FF_CODER_TYPE_RLE 3
2534 * @deprecated use encoder private options instead
2536 attribute_deprecated
2538 #endif /* FF_API_CODER_TYPE */
2540 #if FF_API_PRIVATE_OPT
2541 /** @deprecated use encoder private options instead */
2542 attribute_deprecated
2546 #if FF_API_PRIVATE_OPT
2547 /** @deprecated use encoder private options instead */
2548 attribute_deprecated
2549 int frame_skip_threshold;
2551 /** @deprecated use encoder private options instead */
2552 attribute_deprecated
2553 int frame_skip_factor;
2555 /** @deprecated use encoder private options instead */
2556 attribute_deprecated
2559 /** @deprecated use encoder private options instead */
2560 attribute_deprecated
2562 #endif /* FF_API_PRIVATE_OPT */
2565 * trellis RD quantization
2566 * - encoding: Set by user.
2567 * - decoding: unused
2571 #if FF_API_PRIVATE_OPT
2572 /** @deprecated use encoder private options instead */
2573 attribute_deprecated
2574 int min_prediction_order;
2576 /** @deprecated use encoder private options instead */
2577 attribute_deprecated
2578 int max_prediction_order;
2580 /** @deprecated use encoder private options instead */
2581 attribute_deprecated
2582 int64_t timecode_frame_start;
2585 #if FF_API_RTP_CALLBACK
2587 * @deprecated unused
2589 /* The RTP callback: This function is called */
2590 /* every time the encoder has a packet to send. */
2591 /* It depends on the encoder if the data starts */
2592 /* with a Start Code (it should). H.263 does. */
2593 /* mb_nb contains the number of macroblocks */
2594 /* encoded in the RTP payload. */
2595 attribute_deprecated
2596 void (*rtp_callback)(struct AVCodecContext *avctx, void *data, int size, int mb_nb);
2599 #if FF_API_PRIVATE_OPT
2600 /** @deprecated use encoder private options instead */
2601 attribute_deprecated
2602 int rtp_payload_size; /* The size of the RTP payload: the coder will */
2603 /* do its best to deliver a chunk with size */
2604 /* below rtp_payload_size, the chunk will start */
2605 /* with a start code on some codecs like H.263. */
2606 /* This doesn't take account of any particular */
2607 /* headers inside the transmitted RTP payload. */
2610 #if FF_API_STAT_BITS
2611 /* statistics, used for 2-pass encoding */
2612 attribute_deprecated
2614 attribute_deprecated
2616 attribute_deprecated
2618 attribute_deprecated
2620 attribute_deprecated
2622 attribute_deprecated
2624 attribute_deprecated
2626 attribute_deprecated
2629 /** @deprecated this field is unused */
2630 attribute_deprecated
2635 * pass1 encoding statistics output buffer
2636 * - encoding: Set by libavcodec.
2637 * - decoding: unused
2642 * pass2 encoding statistics input buffer
2643 * Concatenated stuff from stats_out of pass1 should be placed here.
2644 * - encoding: Allocated/set/freed by user.
2645 * - decoding: unused
2650 * Work around bugs in encoders which sometimes cannot be detected automatically.
2651 * - encoding: Set by user
2652 * - decoding: Set by user
2654 int workaround_bugs;
2655 #define FF_BUG_AUTODETECT 1 ///< autodetection
2656 #define FF_BUG_XVID_ILACE 4
2657 #define FF_BUG_UMP4 8
2658 #define FF_BUG_NO_PADDING 16
2659 #define FF_BUG_AMV 32
2660 #define FF_BUG_QPEL_CHROMA 64
2661 #define FF_BUG_STD_QPEL 128
2662 #define FF_BUG_QPEL_CHROMA2 256
2663 #define FF_BUG_DIRECT_BLOCKSIZE 512
2664 #define FF_BUG_EDGE 1024
2665 #define FF_BUG_HPEL_CHROMA 2048
2666 #define FF_BUG_DC_CLIP 4096
2667 #define FF_BUG_MS 8192 ///< Work around various bugs in Microsoft's broken decoders.
2668 #define FF_BUG_TRUNCATED 16384
2669 #define FF_BUG_IEDGE 32768
2672 * strictly follow the standard (MPEG-4, ...).
2673 * - encoding: Set by user.
2674 * - decoding: Set by user.
2675 * Setting this to STRICT or higher means the encoder and decoder will
2676 * generally do stupid things, whereas setting it to unofficial or lower
2677 * will mean the encoder might produce output that is not supported by all
2678 * spec-compliant decoders. Decoders don't differentiate between normal,
2679 * unofficial and experimental (that is, they always try to decode things
2680 * when they can) unless they are explicitly asked to behave stupidly
2681 * (=strictly conform to the specs)
2683 int strict_std_compliance;
2684 #define FF_COMPLIANCE_VERY_STRICT 2 ///< Strictly conform to an older more strict version of the spec or reference software.
2685 #define FF_COMPLIANCE_STRICT 1 ///< Strictly conform to all the things in the spec no matter what consequences.
2686 #define FF_COMPLIANCE_NORMAL 0
2687 #define FF_COMPLIANCE_UNOFFICIAL -1 ///< Allow unofficial extensions
2688 #define FF_COMPLIANCE_EXPERIMENTAL -2 ///< Allow nonstandardized experimental things.
2691 * error concealment flags
2692 * - encoding: unused
2693 * - decoding: Set by user.
2695 int error_concealment;
2696 #define FF_EC_GUESS_MVS 1
2697 #define FF_EC_DEBLOCK 2
2698 #define FF_EC_FAVOR_INTER 256
2702 * - encoding: Set by user.
2703 * - decoding: Set by user.
2706 #define FF_DEBUG_PICT_INFO 1
2707 #define FF_DEBUG_RC 2
2708 #define FF_DEBUG_BITSTREAM 4
2709 #define FF_DEBUG_MB_TYPE 8
2710 #define FF_DEBUG_QP 16
2713 * @deprecated this option does nothing
2715 #define FF_DEBUG_MV 32
2717 #define FF_DEBUG_DCT_COEFF 0x00000040
2718 #define FF_DEBUG_SKIP 0x00000080
2719 #define FF_DEBUG_STARTCODE 0x00000100
2720 #define FF_DEBUG_ER 0x00000400
2721 #define FF_DEBUG_MMCO 0x00000800
2722 #define FF_DEBUG_BUGS 0x00001000
2724 #define FF_DEBUG_VIS_QP 0x00002000
2725 #define FF_DEBUG_VIS_MB_TYPE 0x00004000
2727 #define FF_DEBUG_BUFFERS 0x00008000
2728 #define FF_DEBUG_THREADS 0x00010000
2729 #define FF_DEBUG_GREEN_MD 0x00800000
2730 #define FF_DEBUG_NOMC 0x01000000
2735 * - encoding: Set by user.
2736 * - decoding: Set by user.
2739 #define FF_DEBUG_VIS_MV_P_FOR 0x00000001 // visualize forward predicted MVs of P-frames
2740 #define FF_DEBUG_VIS_MV_B_FOR 0x00000002 // visualize forward predicted MVs of B-frames
2741 #define FF_DEBUG_VIS_MV_B_BACK 0x00000004 // visualize backward predicted MVs of B-frames
2745 * Error recognition; may misdetect some more or less valid parts as errors.
2746 * - encoding: unused
2747 * - decoding: Set by user.
2749 int err_recognition;
2752 * Verify checksums embedded in the bitstream (could be of either encoded or
2753 * decoded data, depending on the codec) and print an error message on mismatch.
2754 * If AV_EF_EXPLODE is also set, a mismatching checksum will result in the
2755 * decoder returning an error.
2757 #define AV_EF_CRCCHECK (1<<0)
2758 #define AV_EF_BITSTREAM (1<<1) ///< detect bitstream specification deviations
2759 #define AV_EF_BUFFER (1<<2) ///< detect improper bitstream length
2760 #define AV_EF_EXPLODE (1<<3) ///< abort decoding on minor error detection
2762 #define AV_EF_IGNORE_ERR (1<<15) ///< ignore errors and continue
2763 #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
2764 #define AV_EF_COMPLIANT (1<<17) ///< consider all spec non compliances as errors
2765 #define AV_EF_AGGRESSIVE (1<<18) ///< consider things that a sane encoder should not do as an error
2769 * opaque 64-bit number (generally a PTS) that will be reordered and
2770 * output in AVFrame.reordered_opaque
2771 * - encoding: Set by libavcodec to the reordered_opaque of the input
2772 * frame corresponding to the last returned packet. Only
2773 * supported by encoders with the
2774 * AV_CODEC_CAP_ENCODER_REORDERED_OPAQUE capability.
2775 * - decoding: Set by user.
2777 int64_t reordered_opaque;
2780 * Hardware accelerator in use
2781 * - encoding: unused.
2782 * - decoding: Set by libavcodec
2784 const struct AVHWAccel *hwaccel;
2787 * Hardware accelerator context.
2788 * For some hardware accelerators, a global context needs to be
2789 * provided by the user. In that case, this holds display-dependent
2790 * data FFmpeg cannot instantiate itself. Please refer to the
2791 * FFmpeg HW accelerator documentation to know how to fill this
2792 * is. e.g. for VA API, this is a struct vaapi_context.
2793 * - encoding: unused
2794 * - decoding: Set by user
2796 void *hwaccel_context;
2800 * - encoding: Set by libavcodec if flags & AV_CODEC_FLAG_PSNR.
2801 * - decoding: unused
2803 uint64_t error[AV_NUM_DATA_POINTERS];
2806 * DCT algorithm, see FF_DCT_* below
2807 * - encoding: Set by user.
2808 * - decoding: unused
2811 #define FF_DCT_AUTO 0
2812 #define FF_DCT_FASTINT 1
2813 #define FF_DCT_INT 2
2814 #define FF_DCT_MMX 3
2815 #define FF_DCT_ALTIVEC 5
2816 #define FF_DCT_FAAN 6
2819 * IDCT algorithm, see FF_IDCT_* below.
2820 * - encoding: Set by user.
2821 * - decoding: Set by user.
2824 #define FF_IDCT_AUTO 0
2825 #define FF_IDCT_INT 1
2826 #define FF_IDCT_SIMPLE 2
2827 #define FF_IDCT_SIMPLEMMX 3
2828 #define FF_IDCT_ARM 7
2829 #define FF_IDCT_ALTIVEC 8
2830 #define FF_IDCT_SIMPLEARM 10
2831 #define FF_IDCT_XVID 14
2832 #define FF_IDCT_SIMPLEARMV5TE 16
2833 #define FF_IDCT_SIMPLEARMV6 17
2834 #define FF_IDCT_FAAN 20
2835 #define FF_IDCT_SIMPLENEON 22
2836 #define FF_IDCT_NONE 24 /* Used by XvMC to extract IDCT coefficients with FF_IDCT_PERM_NONE */
2837 #define FF_IDCT_SIMPLEAUTO 128
2840 * bits per sample/pixel from the demuxer (needed for huffyuv).
2841 * - encoding: Set by libavcodec.
2842 * - decoding: Set by user.
2844 int bits_per_coded_sample;
2847 * Bits per sample/pixel of internal libavcodec pixel/sample format.
2848 * - encoding: set by user.
2849 * - decoding: set by libavcodec.
2851 int bits_per_raw_sample;
2855 * low resolution decoding, 1-> 1/2 size, 2->1/4 size
2856 * - encoding: unused
2857 * - decoding: Set by user.
2862 #if FF_API_CODED_FRAME
2864 * the picture in the bitstream
2865 * - encoding: Set by libavcodec.
2866 * - decoding: unused
2868 * @deprecated use the quality factor packet side data instead
2870 attribute_deprecated AVFrame *coded_frame;
2875 * is used to decide how many independent tasks should be passed to execute()
2876 * - encoding: Set by user.
2877 * - decoding: Set by user.
2882 * Which multithreading methods to use.
2883 * Use of FF_THREAD_FRAME will increase decoding delay by one frame per thread,
2884 * so clients which cannot provide future frames should not use it.
2886 * - encoding: Set by user, otherwise the default is used.
2887 * - decoding: Set by user, otherwise the default is used.
2890 #define FF_THREAD_FRAME 1 ///< Decode more than one frame at once
2891 #define FF_THREAD_SLICE 2 ///< Decode more than one part of a single frame at once
2894 * Which multithreading methods are in use by the codec.
2895 * - encoding: Set by libavcodec.
2896 * - decoding: Set by libavcodec.
2898 int active_thread_type;
2901 * Set by the client if its custom get_buffer() callback can be called
2902 * synchronously from another thread, which allows faster multithreaded decoding.
2903 * draw_horiz_band() will be called from other threads regardless of this setting.
2904 * Ignored if the default get_buffer() is used.
2905 * - encoding: Set by user.
2906 * - decoding: Set by user.
2908 int thread_safe_callbacks;
2911 * The codec may call this to execute several independent things.
2912 * It will return only after finishing all tasks.
2913 * The user may replace this with some multithreaded implementation,
2914 * the default implementation will execute the parts serially.
2915 * @param count the number of things to execute
2916 * - encoding: Set by libavcodec, user can override.
2917 * - decoding: Set by libavcodec, user can override.
2919 int (*execute)(struct AVCodecContext *c, int (*func)(struct AVCodecContext *c2, void *arg), void *arg2, int *ret, int count, int size);
2922 * The codec may call this to execute several independent things.
2923 * It will return only after finishing all tasks.
2924 * The user may replace this with some multithreaded implementation,
2925 * the default implementation will execute the parts serially.
2926 * Also see avcodec_thread_init and e.g. the --enable-pthread configure option.
2927 * @param c context passed also to func
2928 * @param count the number of things to execute
2929 * @param arg2 argument passed unchanged to func
2930 * @param ret return values of executed functions, must have space for "count" values. May be NULL.
2931 * @param func function that will be called count times, with jobnr from 0 to count-1.
2932 * threadnr will be in the range 0 to c->thread_count-1 < MAX_THREADS and so that no
2933 * two instances of func executing at the same time will have the same threadnr.
2934 * @return always 0 currently, but code should handle a future improvement where when any call to func
2935 * returns < 0 no further calls to func may be done and < 0 is returned.
2936 * - encoding: Set by libavcodec, user can override.
2937 * - decoding: Set by libavcodec, user can override.
2939 int (*execute2)(struct AVCodecContext *c, int (*func)(struct AVCodecContext *c2, void *arg, int jobnr, int threadnr), void *arg2, int *ret, int count);
2942 * noise vs. sse weight for the nsse comparison function
2943 * - encoding: Set by user.
2944 * - decoding: unused
2950 * - encoding: Set by user.
2951 * - decoding: Set by libavcodec.
2954 #define FF_PROFILE_UNKNOWN -99
2955 #define FF_PROFILE_RESERVED -100
2957 #define FF_PROFILE_AAC_MAIN 0
2958 #define FF_PROFILE_AAC_LOW 1
2959 #define FF_PROFILE_AAC_SSR 2
2960 #define FF_PROFILE_AAC_LTP 3
2961 #define FF_PROFILE_AAC_HE 4
2962 #define FF_PROFILE_AAC_HE_V2 28
2963 #define FF_PROFILE_AAC_LD 22
2964 #define FF_PROFILE_AAC_ELD 38
2965 #define FF_PROFILE_MPEG2_AAC_LOW 128
2966 #define FF_PROFILE_MPEG2_AAC_HE 131
2968 #define FF_PROFILE_DNXHD 0
2969 #define FF_PROFILE_DNXHR_LB 1
2970 #define FF_PROFILE_DNXHR_SQ 2
2971 #define FF_PROFILE_DNXHR_HQ 3
2972 #define FF_PROFILE_DNXHR_HQX 4
2973 #define FF_PROFILE_DNXHR_444 5
2975 #define FF_PROFILE_DTS 20
2976 #define FF_PROFILE_DTS_ES 30
2977 #define FF_PROFILE_DTS_96_24 40
2978 #define FF_PROFILE_DTS_HD_HRA 50
2979 #define FF_PROFILE_DTS_HD_MA 60
2980 #define FF_PROFILE_DTS_EXPRESS 70
2982 #define FF_PROFILE_MPEG2_422 0
2983 #define FF_PROFILE_MPEG2_HIGH 1
2984 #define FF_PROFILE_MPEG2_SS 2
2985 #define FF_PROFILE_MPEG2_SNR_SCALABLE 3
2986 #define FF_PROFILE_MPEG2_MAIN 4
2987 #define FF_PROFILE_MPEG2_SIMPLE 5
2989 #define FF_PROFILE_H264_CONSTRAINED (1<<9) // 8+1; constraint_set1_flag
2990 #define FF_PROFILE_H264_INTRA (1<<11) // 8+3; constraint_set3_flag
2992 #define FF_PROFILE_H264_BASELINE 66
2993 #define FF_PROFILE_H264_CONSTRAINED_BASELINE (66|FF_PROFILE_H264_CONSTRAINED)
2994 #define FF_PROFILE_H264_MAIN 77
2995 #define FF_PROFILE_H264_EXTENDED 88
2996 #define FF_PROFILE_H264_HIGH 100
2997 #define FF_PROFILE_H264_HIGH_10 110
2998 #define FF_PROFILE_H264_HIGH_10_INTRA (110|FF_PROFILE_H264_INTRA)
2999 #define FF_PROFILE_H264_MULTIVIEW_HIGH 118
3000 #define FF_PROFILE_H264_HIGH_422 122
3001 #define FF_PROFILE_H264_HIGH_422_INTRA (122|FF_PROFILE_H264_INTRA)
3002 #define FF_PROFILE_H264_STEREO_HIGH 128
3003 #define FF_PROFILE_H264_HIGH_444 144
3004 #define FF_PROFILE_H264_HIGH_444_PREDICTIVE 244
3005 #define FF_PROFILE_H264_HIGH_444_INTRA (244|FF_PROFILE_H264_INTRA)
3006 #define FF_PROFILE_H264_CAVLC_444 44
3008 #define FF_PROFILE_VC1_SIMPLE 0
3009 #define FF_PROFILE_VC1_MAIN 1
3010 #define FF_PROFILE_VC1_COMPLEX 2
3011 #define FF_PROFILE_VC1_ADVANCED 3
3013 #define FF_PROFILE_MPEG4_SIMPLE 0
3014 #define FF_PROFILE_MPEG4_SIMPLE_SCALABLE 1
3015 #define FF_PROFILE_MPEG4_CORE 2
3016 #define FF_PROFILE_MPEG4_MAIN 3
3017 #define FF_PROFILE_MPEG4_N_BIT 4
3018 #define FF_PROFILE_MPEG4_SCALABLE_TEXTURE 5
3019 #define FF_PROFILE_MPEG4_SIMPLE_FACE_ANIMATION 6
3020 #define FF_PROFILE_MPEG4_BASIC_ANIMATED_TEXTURE 7
3021 #define FF_PROFILE_MPEG4_HYBRID 8
3022 #define FF_PROFILE_MPEG4_ADVANCED_REAL_TIME 9
3023 #define FF_PROFILE_MPEG4_CORE_SCALABLE 10
3024 #define FF_PROFILE_MPEG4_ADVANCED_CODING 11
3025 #define FF_PROFILE_MPEG4_ADVANCED_CORE 12
3026 #define FF_PROFILE_MPEG4_ADVANCED_SCALABLE_TEXTURE 13
3027 #define FF_PROFILE_MPEG4_SIMPLE_STUDIO 14
3028 #define FF_PROFILE_MPEG4_ADVANCED_SIMPLE 15
3030 #define FF_PROFILE_JPEG2000_CSTREAM_RESTRICTION_0 1
3031 #define FF_PROFILE_JPEG2000_CSTREAM_RESTRICTION_1 2
3032 #define FF_PROFILE_JPEG2000_CSTREAM_NO_RESTRICTION 32768
3033 #define FF_PROFILE_JPEG2000_DCINEMA_2K 3
3034 #define FF_PROFILE_JPEG2000_DCINEMA_4K 4
3036 #define FF_PROFILE_VP9_0 0
3037 #define FF_PROFILE_VP9_1 1
3038 #define FF_PROFILE_VP9_2 2
3039 #define FF_PROFILE_VP9_3 3
3041 #define FF_PROFILE_HEVC_MAIN 1
3042 #define FF_PROFILE_HEVC_MAIN_10 2
3043 #define FF_PROFILE_HEVC_MAIN_STILL_PICTURE 3
3044 #define FF_PROFILE_HEVC_REXT 4
3046 #define FF_PROFILE_AV1_MAIN 0
3047 #define FF_PROFILE_AV1_HIGH 1
3048 #define FF_PROFILE_AV1_PROFESSIONAL 2
3050 #define FF_PROFILE_MJPEG_HUFFMAN_BASELINE_DCT 0xc0
3051 #define FF_PROFILE_MJPEG_HUFFMAN_EXTENDED_SEQUENTIAL_DCT 0xc1
3052 #define FF_PROFILE_MJPEG_HUFFMAN_PROGRESSIVE_DCT 0xc2
3053 #define FF_PROFILE_MJPEG_HUFFMAN_LOSSLESS 0xc3
3054 #define FF_PROFILE_MJPEG_JPEG_LS 0xf7
3056 #define FF_PROFILE_SBC_MSBC 1
3058 #define FF_PROFILE_PRORES_PROXY 0
3059 #define FF_PROFILE_PRORES_LT 1
3060 #define FF_PROFILE_PRORES_STANDARD 2
3061 #define FF_PROFILE_PRORES_HQ 3
3062 #define FF_PROFILE_PRORES_4444 4
3063 #define FF_PROFILE_PRORES_XQ 5
3065 #define FF_PROFILE_ARIB_PROFILE_A 0
3066 #define FF_PROFILE_ARIB_PROFILE_C 1
3070 * - encoding: Set by user.
3071 * - decoding: Set by libavcodec.
3074 #define FF_LEVEL_UNKNOWN -99
3077 * Skip loop filtering for selected frames.
3078 * - encoding: unused
3079 * - decoding: Set by user.
3081 enum AVDiscard skip_loop_filter;
3084 * Skip IDCT/dequantization for selected frames.
3085 * - encoding: unused
3086 * - decoding: Set by user.
3088 enum AVDiscard skip_idct;
3091 * Skip decoding for selected frames.
3092 * - encoding: unused
3093 * - decoding: Set by user.
3095 enum AVDiscard skip_frame;
3098 * Header containing style information for text subtitles.
3099 * For SUBTITLE_ASS subtitle type, it should contain the whole ASS
3100 * [Script Info] and [V4+ Styles] section, plus the [Events] line and
3101 * the Format line following. It shouldn't include any Dialogue line.
3102 * - encoding: Set/allocated/freed by user (before avcodec_open2())
3103 * - decoding: Set/allocated/freed by libavcodec (by avcodec_open2())
3105 uint8_t *subtitle_header;
3106 int subtitle_header_size;
3108 #if FF_API_VBV_DELAY
3110 * VBV delay coded in the last frame (in periods of a 27 MHz clock).
3111 * Used for compliant TS muxing.
3112 * - encoding: Set by libavcodec.
3113 * - decoding: unused.
3114 * @deprecated this value is now exported as a part of
3115 * AV_PKT_DATA_CPB_PROPERTIES packet side data
3117 attribute_deprecated
3121 #if FF_API_SIDEDATA_ONLY_PKT
3123 * Encoding only and set by default. Allow encoders to output packets
3124 * that do not contain any encoded data, only side data.
3126 * Some encoders need to output such packets, e.g. to update some stream
3127 * parameters at the end of encoding.
3129 * @deprecated this field disables the default behaviour and
3130 * it is kept only for compatibility.
3132 attribute_deprecated
3133 int side_data_only_packets;
3137 * Audio only. The number of "priming" samples (padding) inserted by the
3138 * encoder at the beginning of the audio. I.e. this number of leading
3139 * decoded samples must be discarded by the caller to get the original audio
3140 * without leading padding.
3142 * - decoding: unused
3143 * - encoding: Set by libavcodec. The timestamps on the output packets are
3144 * adjusted by the encoder so that they always refer to the
3145 * first sample of the data actually contained in the packet,
3146 * including any added padding. E.g. if the timebase is
3147 * 1/samplerate and the timestamp of the first input sample is
3148 * 0, the timestamp of the first output packet will be
3151 int initial_padding;
3154 * - decoding: For codecs that store a framerate value in the compressed
3155 * bitstream, the decoder may export it here. { 0, 1} when
3157 * - encoding: May be used to signal the framerate of CFR content to an
3160 AVRational framerate;
3163 * Nominal unaccelerated pixel format, see AV_PIX_FMT_xxx.
3164 * - encoding: unused.
3165 * - decoding: Set by libavcodec before calling get_format()
3167 enum AVPixelFormat sw_pix_fmt;
3170 * Timebase in which pkt_dts/pts and AVPacket.dts/pts are.
3171 * - encoding unused.
3172 * - decoding set by user.
3174 AVRational pkt_timebase;
3178 * - encoding: unused.
3179 * - decoding: set by libavcodec.
3181 const AVCodecDescriptor *codec_descriptor;
3185 * low resolution decoding, 1-> 1/2 size, 2->1/4 size
3186 * - encoding: unused
3187 * - decoding: Set by user.
3193 * Current statistics for PTS correction.
3194 * - decoding: maintained and used by libavcodec, not intended to be used by user apps
3195 * - encoding: unused
3197 int64_t pts_correction_num_faulty_pts; /// Number of incorrect PTS values so far
3198 int64_t pts_correction_num_faulty_dts; /// Number of incorrect DTS values so far
3199 int64_t pts_correction_last_pts; /// PTS of the last frame
3200 int64_t pts_correction_last_dts; /// DTS of the last frame
3203 * Character encoding of the input subtitles file.
3204 * - decoding: set by user
3205 * - encoding: unused
3210 * Subtitles character encoding mode. Formats or codecs might be adjusting
3211 * this setting (if they are doing the conversion themselves for instance).
3212 * - decoding: set by libavcodec
3213 * - encoding: unused
3215 int sub_charenc_mode;
3216 #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)
3217 #define FF_SUB_CHARENC_MODE_AUTOMATIC 0 ///< libavcodec will select the mode itself
3218 #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
3219 #define FF_SUB_CHARENC_MODE_IGNORE 2 ///< neither convert the subtitles, nor check them for valid UTF-8
3222 * Skip processing alpha if supported by codec.
3223 * Note that if the format uses pre-multiplied alpha (common with VP6,
3224 * and recommended due to better video quality/compression)
3225 * the image will look as if alpha-blended onto a black background.
3226 * However for formats that do not use pre-multiplied alpha
3227 * there might be serious artefacts (though e.g. libswscale currently
3228 * assumes pre-multiplied alpha anyway).
3230 * - decoding: set by user
3231 * - encoding: unused
3236 * Number of samples to skip after a discontinuity
3237 * - decoding: unused
3238 * - encoding: set by libavcodec
3242 #if !FF_API_DEBUG_MV
3244 * debug motion vectors
3245 * - encoding: Set by user.
3246 * - decoding: Set by user.
3249 #define FF_DEBUG_VIS_MV_P_FOR 0x00000001 //visualize forward predicted MVs of P frames
3250 #define FF_DEBUG_VIS_MV_B_FOR 0x00000002 //visualize forward predicted MVs of B frames
3251 #define FF_DEBUG_VIS_MV_B_BACK 0x00000004 //visualize backward predicted MVs of B frames
3255 * custom intra quantization matrix
3256 * - encoding: Set by user, can be NULL.
3257 * - decoding: unused.
3259 uint16_t *chroma_intra_matrix;
3262 * dump format separator.
3263 * can be ", " or "\n " or anything else
3264 * - encoding: Set by user.
3265 * - decoding: Set by user.
3267 uint8_t *dump_separator;
3270 * ',' separated list of allowed decoders.
3271 * If NULL then all are allowed
3272 * - encoding: unused
3273 * - decoding: set by user
3275 char *codec_whitelist;
3278 * Properties of the stream that gets decoded
3279 * - encoding: unused
3280 * - decoding: set by libavcodec
3282 unsigned properties;
3283 #define FF_CODEC_PROPERTY_LOSSLESS 0x00000001
3284 #define FF_CODEC_PROPERTY_CLOSED_CAPTIONS 0x00000002
3287 * Additional data associated with the entire coded stream.
3289 * - decoding: unused
3290 * - encoding: may be set by libavcodec after avcodec_open2().
3292 AVPacketSideData *coded_side_data;
3293 int nb_coded_side_data;
3296 * A reference to the AVHWFramesContext describing the input (for encoding)
3297 * or output (decoding) frames. The reference is set by the caller and
3298 * afterwards owned (and freed) by libavcodec - it should never be read by
3299 * the caller after being set.
3301 * - decoding: This field should be set by the caller from the get_format()
3302 * callback. The previous reference (if any) will always be
3303 * unreffed by libavcodec before the get_format() call.
3305 * If the default get_buffer2() is used with a hwaccel pixel
3306 * format, then this AVHWFramesContext will be used for
3307 * allocating the frame buffers.
3309 * - encoding: For hardware encoders configured to use a hwaccel pixel
3310 * format, this field should be set by the caller to a reference
3311 * to the AVHWFramesContext describing input frames.
3312 * AVHWFramesContext.format must be equal to
3313 * AVCodecContext.pix_fmt.
3315 * This field should be set before avcodec_open2() is called.
3317 AVBufferRef *hw_frames_ctx;
3320 * Control the form of AVSubtitle.rects[N]->ass
3321 * - decoding: set by user
3322 * - encoding: unused
3324 int sub_text_format;
3325 #define FF_SUB_TEXT_FMT_ASS 0
3326 #if FF_API_ASS_TIMING
3327 #define FF_SUB_TEXT_FMT_ASS_WITH_TIMINGS 1
3331 * Audio only. The amount of padding (in samples) appended by the encoder to
3332 * the end of the audio. I.e. this number of decoded samples must be
3333 * discarded by the caller from the end of the stream to get the original
3334 * audio without any trailing padding.
3336 * - decoding: unused
3337 * - encoding: unused
3339 int trailing_padding;
3342 * The number of pixels per image to maximally accept.
3344 * - decoding: set by user
3345 * - encoding: set by user
3350 * A reference to the AVHWDeviceContext describing the device which will
3351 * be used by a hardware encoder/decoder. The reference is set by the
3352 * caller and afterwards owned (and freed) by libavcodec.
3354 * This should be used if either the codec device does not require
3355 * hardware frames or any that are used are to be allocated internally by
3356 * libavcodec. If the user wishes to supply any of the frames used as
3357 * encoder input or decoder output then hw_frames_ctx should be used
3358 * instead. When hw_frames_ctx is set in get_format() for a decoder, this
3359 * field will be ignored while decoding the associated stream segment, but
3360 * may again be used on a following one after another get_format() call.
3362 * For both encoders and decoders this field should be set before
3363 * avcodec_open2() is called and must not be written to thereafter.
3365 * Note that some decoders may require this field to be set initially in
3366 * order to support hw_frames_ctx at all - in that case, all frames
3367 * contexts used must be created on the same device.
3369 AVBufferRef *hw_device_ctx;
3372 * Bit set of AV_HWACCEL_FLAG_* flags, which affect hardware accelerated
3373 * decoding (if active).
3374 * - encoding: unused
3375 * - decoding: Set by user (either before avcodec_open2(), or in the
3376 * AVCodecContext.get_format callback)
3381 * Video decoding only. Certain video codecs support cropping, meaning that
3382 * only a sub-rectangle of the decoded frame is intended for display. This
3383 * option controls how cropping is handled by libavcodec.
3385 * When set to 1 (the default), libavcodec will apply cropping internally.
3386 * I.e. it will modify the output frame width/height fields and offset the
3387 * data pointers (only by as much as possible while preserving alignment, or
3388 * by the full amount if the AV_CODEC_FLAG_UNALIGNED flag is set) so that
3389 * the frames output by the decoder refer only to the cropped area. The
3390 * crop_* fields of the output frames will be zero.
3392 * When set to 0, the width/height fields of the output frames will be set
3393 * to the coded dimensions and the crop_* fields will describe the cropping
3394 * rectangle. Applying the cropping is left to the caller.
3396 * @warning When hardware acceleration with opaque output frames is used,
3397 * libavcodec is unable to apply cropping from the top/left border.
3399 * @note when this option is set to zero, the width/height fields of the
3400 * AVCodecContext and output AVFrames have different meanings. The codec
3401 * context fields store display dimensions (with the coded dimensions in
3402 * coded_width/height), while the frame fields store the coded dimensions
3403 * (with the display dimensions being determined by the crop_* fields).
3408 * Video decoding only. Sets the number of extra hardware frames which
3409 * the decoder will allocate for use by the caller. This must be set
3410 * before avcodec_open2() is called.
3412 * Some hardware decoders require all frames that they will use for
3413 * output to be defined in advance before decoding starts. For such
3414 * decoders, the hardware frame pool must therefore be of a fixed size.
3415 * The extra frames set here are on top of any number that the decoder
3416 * needs internally in order to operate normally (for example, frames
3417 * used as reference pictures).
3419 int extra_hw_frames;
3422 * The percentage of damaged samples to discard a frame.
3424 * - decoding: set by user
3425 * - encoding: unused
3427 int discard_damaged_percentage;
3430 * The number of samples per frame to maximally accept.
3432 * - decoding: set by user
3433 * - encoding: set by user
3435 int64_t max_samples;
3438 * Bit set of AV_CODEC_EXPORT_DATA_* flags, which affects the kind of
3439 * metadata exported in frame, packet, or coded stream side data by
3440 * decoders and encoders.
3442 * - decoding: set by user
3443 * - encoding: set by user
3445 int export_side_data;
3448 #if FF_API_CODEC_GET_SET
3450 * Accessors for some AVCodecContext fields. These used to be provided for ABI
3451 * compatibility, and do not need to be used anymore.
3453 attribute_deprecated
3454 AVRational av_codec_get_pkt_timebase (const AVCodecContext *avctx);
3455 attribute_deprecated
3456 void av_codec_set_pkt_timebase (AVCodecContext *avctx, AVRational val);
3458 attribute_deprecated
3459 const AVCodecDescriptor *av_codec_get_codec_descriptor(const AVCodecContext *avctx);
3460 attribute_deprecated
3461 void av_codec_set_codec_descriptor(AVCodecContext *avctx, const AVCodecDescriptor *desc);
3463 attribute_deprecated
3464 unsigned av_codec_get_codec_properties(const AVCodecContext *avctx);
3467 attribute_deprecated
3468 int av_codec_get_lowres(const AVCodecContext *avctx);
3469 attribute_deprecated
3470 void av_codec_set_lowres(AVCodecContext *avctx, int val);
3473 attribute_deprecated
3474 int av_codec_get_seek_preroll(const AVCodecContext *avctx);
3475 attribute_deprecated
3476 void av_codec_set_seek_preroll(AVCodecContext *avctx, int val);
3478 attribute_deprecated
3479 uint16_t *av_codec_get_chroma_intra_matrix(const AVCodecContext *avctx);
3480 attribute_deprecated
3481 void av_codec_set_chroma_intra_matrix(AVCodecContext *avctx, uint16_t *val);
3487 typedef struct AVProfile {
3489 const char *name; ///< short name for the profile
3494 * The codec supports this format via the hw_device_ctx interface.
3496 * When selecting this format, AVCodecContext.hw_device_ctx should
3497 * have been set to a device of the specified type before calling
3500 AV_CODEC_HW_CONFIG_METHOD_HW_DEVICE_CTX = 0x01,
3502 * The codec supports this format via the hw_frames_ctx interface.
3504 * When selecting this format for a decoder,
3505 * AVCodecContext.hw_frames_ctx should be set to a suitable frames
3506 * context inside the get_format() callback. The frames context
3507 * must have been created on a device of the specified type.
3509 AV_CODEC_HW_CONFIG_METHOD_HW_FRAMES_CTX = 0x02,
3511 * The codec supports this format by some internal method.
3513 * This format can be selected without any additional configuration -
3514 * no device or frames context is required.
3516 AV_CODEC_HW_CONFIG_METHOD_INTERNAL = 0x04,
3518 * The codec supports this format by some ad-hoc method.
3520 * Additional settings and/or function calls are required. See the
3521 * codec-specific documentation for details. (Methods requiring
3522 * this sort of configuration are deprecated and others should be
3523 * used in preference.)
3525 AV_CODEC_HW_CONFIG_METHOD_AD_HOC = 0x08,
3528 typedef struct AVCodecHWConfig {
3530 * A hardware pixel format which the codec can use.
3532 enum AVPixelFormat pix_fmt;
3534 * Bit set of AV_CODEC_HW_CONFIG_METHOD_* flags, describing the possible
3535 * setup methods which can be used with this configuration.
3539 * The device type associated with the configuration.
3541 * Must be set for AV_CODEC_HW_CONFIG_METHOD_HW_DEVICE_CTX and
3542 * AV_CODEC_HW_CONFIG_METHOD_HW_FRAMES_CTX, otherwise unused.
3544 enum AVHWDeviceType device_type;
3547 typedef struct AVCodecDefault AVCodecDefault;
3554 typedef struct AVCodec {
3556 * Name of the codec implementation.
3557 * The name is globally unique among encoders and among decoders (but an
3558 * encoder and a decoder can share the same name).
3559 * This is the primary way to find a codec from the user perspective.
3563 * Descriptive name for the codec, meant to be more human readable than name.
3564 * You should use the NULL_IF_CONFIG_SMALL() macro to define it.
3566 const char *long_name;
3567 enum AVMediaType type;
3570 * Codec capabilities.
3571 * see AV_CODEC_CAP_*
3574 const AVRational *supported_framerates; ///< array of supported framerates, or NULL if any, array is terminated by {0,0}
3575 const enum AVPixelFormat *pix_fmts; ///< array of supported pixel formats, or NULL if unknown, array is terminated by -1
3576 const int *supported_samplerates; ///< array of supported audio samplerates, or NULL if unknown, array is terminated by 0
3577 const enum AVSampleFormat *sample_fmts; ///< array of supported sample formats, or NULL if unknown, array is terminated by -1
3578 const uint64_t *channel_layouts; ///< array of support channel layouts, or NULL if unknown. array is terminated by 0
3579 uint8_t max_lowres; ///< maximum value for lowres supported by the decoder
3580 const AVClass *priv_class; ///< AVClass for the private context
3581 const AVProfile *profiles; ///< array of recognized profiles, or NULL if unknown, array is terminated by {FF_PROFILE_UNKNOWN}
3584 * Group name of the codec implementation.
3585 * This is a short symbolic name of the wrapper backing this codec. A
3586 * wrapper uses some kind of external implementation for the codec, such
3587 * as an external library, or a codec implementation provided by the OS or
3589 * If this field is NULL, this is a builtin, libavcodec native codec.
3590 * If non-NULL, this will be the suffix in AVCodec.name in most cases
3591 * (usually AVCodec.name will be of the form "<codec_name>_<wrapper_name>").
3593 const char *wrapper_name;
3595 /*****************************************************************
3596 * No fields below this line are part of the public API. They
3597 * may not be used outside of libavcodec and can be changed and
3599 * New public fields should be added right above.
3600 *****************************************************************
3603 struct AVCodec *next;
3605 * @name Frame-level threading support functions
3609 * If defined, called on thread contexts when they are created.
3610 * If the codec allocates writable tables in init(), re-allocate them here.
3611 * priv_data will be set to a copy of the original.
3613 int (*init_thread_copy)(AVCodecContext *);
3615 * Copy necessary context variables from a previous thread context to the current one.
3616 * If not defined, the next thread will start automatically; otherwise, the codec
3617 * must call ff_thread_finish_setup().
3619 * dst and src will (rarely) point to the same context, in which case memcpy should be skipped.
3621 int (*update_thread_context)(AVCodecContext *dst, const AVCodecContext *src);
3625 * Private codec-specific defaults.
3627 const AVCodecDefault *defaults;
3630 * Initialize codec static data, called from avcodec_register().
3632 * This is not intended for time consuming operations as it is
3633 * run for every codec regardless of that codec being used.
3635 void (*init_static_data)(struct AVCodec *codec);
3637 int (*init)(AVCodecContext *);
3638 int (*encode_sub)(AVCodecContext *, uint8_t *buf, int buf_size,
3639 const struct AVSubtitle *sub);
3641 * Encode data to an AVPacket.
3643 * @param avctx codec context
3644 * @param avpkt output AVPacket (may contain a user-provided buffer)
3645 * @param[in] frame AVFrame containing the raw data to be encoded
3646 * @param[out] got_packet_ptr encoder sets to 0 or 1 to indicate that a
3647 * non-empty packet was returned in avpkt.
3648 * @return 0 on success, negative error code on failure
3650 int (*encode2)(AVCodecContext *avctx, AVPacket *avpkt, const AVFrame *frame,
3651 int *got_packet_ptr);
3652 int (*decode)(AVCodecContext *, void *outdata, int *outdata_size, AVPacket *avpkt);
3653 int (*close)(AVCodecContext *);
3655 * Encode API with decoupled packet/frame dataflow. The API is the
3656 * same as the avcodec_ prefixed APIs (avcodec_send_frame() etc.), except
3658 * - never called if the codec is closed or the wrong type,
3659 * - if AV_CODEC_CAP_DELAY is not set, drain frames are never sent,
3660 * - only one drain frame is ever passed down,
3662 int (*send_frame)(AVCodecContext *avctx, const AVFrame *frame);
3663 int (*receive_packet)(AVCodecContext *avctx, AVPacket *avpkt);
3666 * Decode API with decoupled packet/frame dataflow. This function is called
3667 * to get one output frame. It should call ff_decode_get_packet() to obtain
3670 int (*receive_frame)(AVCodecContext *avctx, AVFrame *frame);
3673 * Will be called when seeking
3675 void (*flush)(AVCodecContext *);
3677 * Internal codec capabilities.
3678 * See FF_CODEC_CAP_* in internal.h
3683 * Decoding only, a comma-separated list of bitstream filters to apply to
3684 * packets before decoding.
3689 * Array of pointers to hardware configurations supported by the codec,
3690 * or NULL if no hardware supported. The array is terminated by a NULL
3693 * The user can only access this field via avcodec_get_hw_config().
3695 const struct AVCodecHWConfigInternal **hw_configs;
3698 * List of supported codec_tags, terminated by FF_CODEC_TAGS_END.
3700 const uint32_t *codec_tags;
3703 #if FF_API_CODEC_GET_SET
3704 attribute_deprecated
3705 int av_codec_get_max_lowres(const AVCodec *codec);
3708 struct MpegEncContext;
3711 * Retrieve supported hardware configurations for a codec.
3713 * Values of index from zero to some maximum return the indexed configuration
3714 * descriptor; all other values return NULL. If the codec does not support
3715 * any hardware configurations then it will always return NULL.
3717 const AVCodecHWConfig *avcodec_get_hw_config(const AVCodec *codec, int index);
3720 * @defgroup lavc_hwaccel AVHWAccel
3722 * @note Nothing in this structure should be accessed by the user. At some
3723 * point in future it will not be externally visible at all.
3727 typedef struct AVHWAccel {
3729 * Name of the hardware accelerated codec.
3730 * The name is globally unique among encoders and among decoders (but an
3731 * encoder and a decoder can share the same name).
3736 * Type of codec implemented by the hardware accelerator.
3738 * See AVMEDIA_TYPE_xxx
3740 enum AVMediaType type;
3743 * Codec implemented by the hardware accelerator.
3745 * See AV_CODEC_ID_xxx
3750 * Supported pixel format.
3752 * Only hardware accelerated formats are supported here.
3754 enum AVPixelFormat pix_fmt;
3757 * Hardware accelerated codec capabilities.
3758 * see AV_HWACCEL_CODEC_CAP_*
3762 /*****************************************************************
3763 * No fields below this line are part of the public API. They
3764 * may not be used outside of libavcodec and can be changed and
3766 * New public fields should be added right above.
3767 *****************************************************************
3771 * Allocate a custom buffer
3773 int (*alloc_frame)(AVCodecContext *avctx, AVFrame *frame);
3776 * Called at the beginning of each frame or field picture.
3778 * Meaningful frame information (codec specific) is guaranteed to
3779 * be parsed at this point. This function is mandatory.
3781 * Note that buf can be NULL along with buf_size set to 0.
3782 * Otherwise, this means the whole frame is available at this point.
3784 * @param avctx the codec context
3785 * @param buf the frame data buffer base
3786 * @param buf_size the size of the frame in bytes
3787 * @return zero if successful, a negative value otherwise
3789 int (*start_frame)(AVCodecContext *avctx, const uint8_t *buf, uint32_t buf_size);
3792 * Callback for parameter data (SPS/PPS/VPS etc).
3794 * Useful for hardware decoders which keep persistent state about the
3795 * video parameters, and need to receive any changes to update that state.
3797 * @param avctx the codec context
3798 * @param type the nal unit type
3799 * @param buf the nal unit data buffer
3800 * @param buf_size the size of the nal unit in bytes
3801 * @return zero if successful, a negative value otherwise
3803 int (*decode_params)(AVCodecContext *avctx, int type, const uint8_t *buf, uint32_t buf_size);
3806 * Callback for each slice.
3808 * Meaningful slice information (codec specific) is guaranteed to
3809 * be parsed at this point. This function is mandatory.
3810 * The only exception is XvMC, that works on MB level.
3812 * @param avctx the codec context
3813 * @param buf the slice data buffer base
3814 * @param buf_size the size of the slice in bytes
3815 * @return zero if successful, a negative value otherwise
3817 int (*decode_slice)(AVCodecContext *avctx, const uint8_t *buf, uint32_t buf_size);
3820 * Called at the end of each frame or field picture.
3822 * The whole picture is parsed at this point and can now be sent
3823 * to the hardware accelerator. This function is mandatory.
3825 * @param avctx the codec context
3826 * @return zero if successful, a negative value otherwise
3828 int (*end_frame)(AVCodecContext *avctx);
3831 * Size of per-frame hardware accelerator private data.
3833 * Private data is allocated with av_mallocz() before
3834 * AVCodecContext.get_buffer() and deallocated after
3835 * AVCodecContext.release_buffer().
3837 int frame_priv_data_size;
3840 * Called for every Macroblock in a slice.
3842 * XvMC uses it to replace the ff_mpv_reconstruct_mb().
3843 * Instead of decoding to raw picture, MB parameters are
3844 * stored in an array provided by the video driver.
3846 * @param s the mpeg context
3848 void (*decode_mb)(struct MpegEncContext *s);
3851 * Initialize the hwaccel private data.
3853 * This will be called from ff_get_format(), after hwaccel and
3854 * hwaccel_context are set and the hwaccel private data in AVCodecInternal
3857 int (*init)(AVCodecContext *avctx);
3860 * Uninitialize the hwaccel private data.
3862 * This will be called from get_format() or avcodec_close(), after hwaccel
3863 * and hwaccel_context are already uninitialized.
3865 int (*uninit)(AVCodecContext *avctx);
3868 * Size of the private data to allocate in
3869 * AVCodecInternal.hwaccel_priv_data.
3874 * Internal hwaccel capabilities.
3879 * Fill the given hw_frames context with current codec parameters. Called
3880 * from get_format. Refer to avcodec_get_hw_frames_parameters() for
3883 * This CAN be called before AVHWAccel.init is called, and you must assume
3884 * that avctx->hwaccel_priv_data is invalid.
3886 int (*frame_params)(AVCodecContext *avctx, AVBufferRef *hw_frames_ctx);
3890 * HWAccel is experimental and is thus avoided in favor of non experimental
3893 #define AV_HWACCEL_CODEC_CAP_EXPERIMENTAL 0x0200
3896 * Hardware acceleration should be used for decoding even if the codec level
3897 * used is unknown or higher than the maximum supported level reported by the
3900 * It's generally a good idea to pass this flag unless you have a specific
3901 * reason not to, as hardware tends to under-report supported levels.
3903 #define AV_HWACCEL_FLAG_IGNORE_LEVEL (1 << 0)
3906 * Hardware acceleration can output YUV pixel formats with a different chroma
3907 * sampling than 4:2:0 and/or other than 8 bits per component.
3909 #define AV_HWACCEL_FLAG_ALLOW_HIGH_DEPTH (1 << 1)
3912 * Hardware acceleration should still be attempted for decoding when the
3913 * codec profile does not match the reported capabilities of the hardware.
3915 * For example, this can be used to try to decode baseline profile H.264
3916 * streams in hardware - it will often succeed, because many streams marked
3917 * as baseline profile actually conform to constrained baseline profile.
3919 * @warning If the stream is actually not supported then the behaviour is
3920 * undefined, and may include returning entirely incorrect output
3921 * while indicating success.
3923 #define AV_HWACCEL_FLAG_ALLOW_PROFILE_MISMATCH (1 << 2)
3929 #if FF_API_AVPICTURE
3931 * @defgroup lavc_picture AVPicture
3933 * Functions for working with AVPicture
3938 * Picture data structure.
3940 * Up to four components can be stored into it, the last component is
3942 * @deprecated use AVFrame or imgutils functions instead
3944 typedef struct AVPicture {
3945 attribute_deprecated
3946 uint8_t *data[AV_NUM_DATA_POINTERS]; ///< pointers to the image data planes
3947 attribute_deprecated
3948 int linesize[AV_NUM_DATA_POINTERS]; ///< number of bytes per line
3956 enum AVSubtitleType {
3959 SUBTITLE_BITMAP, ///< A bitmap, pict will be set
3962 * Plain text, the text field must be set by the decoder and is
3963 * authoritative. ass and pict fields may contain approximations.
3968 * Formatted text, the ass field must be set by the decoder and is
3969 * authoritative. pict and text fields may contain approximations.
3974 #define AV_SUBTITLE_FLAG_FORCED 0x00000001
3976 typedef struct AVSubtitleRect {
3977 int x; ///< top left corner of pict, undefined when pict is not set
3978 int y; ///< top left corner of pict, undefined when pict is not set
3979 int w; ///< width of pict, undefined when pict is not set
3980 int h; ///< height of pict, undefined when pict is not set
3981 int nb_colors; ///< number of colors in pict, undefined when pict is not set
3983 #if FF_API_AVPICTURE
3985 * @deprecated unused
3987 attribute_deprecated
3991 * data+linesize for the bitmap of this subtitle.
3992 * Can be set for text/ass as well once they are rendered.
3997 enum AVSubtitleType type;
3999 char *text; ///< 0 terminated plain UTF-8 text
4002 * 0 terminated ASS/SSA compatible event line.
4003 * The presentation of this is unaffected by the other values in this
4011 typedef struct AVSubtitle {
4012 uint16_t format; /* 0 = graphics */
4013 uint32_t start_display_time; /* relative to packet pts, in ms */
4014 uint32_t end_display_time; /* relative to packet pts, in ms */
4016 AVSubtitleRect **rects;
4017 int64_t pts; ///< Same as packet pts, in AV_TIME_BASE
4021 * This struct describes the properties of an encoded stream.
4023 * sizeof(AVCodecParameters) is not a part of the public ABI, this struct must
4024 * be allocated with avcodec_parameters_alloc() and freed with
4025 * avcodec_parameters_free().
4027 typedef struct AVCodecParameters {
4029 * General type of the encoded data.
4031 enum AVMediaType codec_type;
4033 * Specific type of the encoded data (the codec used).
4035 enum AVCodecID codec_id;
4037 * Additional information about the codec (corresponds to the AVI FOURCC).
4042 * Extra binary data needed for initializing the decoder, codec-dependent.
4044 * Must be allocated with av_malloc() and will be freed by
4045 * avcodec_parameters_free(). The allocated size of extradata must be at
4046 * least extradata_size + AV_INPUT_BUFFER_PADDING_SIZE, with the padding
4051 * Size of the extradata content in bytes.
4056 * - video: the pixel format, the value corresponds to enum AVPixelFormat.
4057 * - audio: the sample format, the value corresponds to enum AVSampleFormat.
4062 * The average bitrate of the encoded data (in bits per second).
4067 * The number of bits per sample in the codedwords.
4069 * This is basically the bitrate per sample. It is mandatory for a bunch of
4070 * formats to actually decode them. It's the number of bits for one sample in
4071 * the actual coded bitstream.
4073 * This could be for example 4 for ADPCM
4074 * For PCM formats this matches bits_per_raw_sample
4077 int bits_per_coded_sample;
4080 * This is the number of valid bits in each output sample. If the
4081 * sample format has more bits, the least significant bits are additional
4082 * padding bits, which are always 0. Use right shifts to reduce the sample
4083 * to its actual size. For example, audio formats with 24 bit samples will
4084 * have bits_per_raw_sample set to 24, and format set to AV_SAMPLE_FMT_S32.
4085 * To get the original sample use "(int32_t)sample >> 8"."
4087 * For ADPCM this might be 12 or 16 or similar
4090 int bits_per_raw_sample;
4093 * Codec-specific bitstream restrictions that the stream conforms to.
4099 * Video only. The dimensions of the video frame in pixels.
4105 * Video only. The aspect ratio (width / height) which a single pixel
4106 * should have when displayed.
4108 * When the aspect ratio is unknown / undefined, the numerator should be
4109 * set to 0 (the denominator may have any value).
4111 AVRational sample_aspect_ratio;
4114 * Video only. The order of the fields in interlaced video.
4116 enum AVFieldOrder field_order;
4119 * Video only. Additional colorspace characteristics.
4121 enum AVColorRange color_range;
4122 enum AVColorPrimaries color_primaries;
4123 enum AVColorTransferCharacteristic color_trc;
4124 enum AVColorSpace color_space;
4125 enum AVChromaLocation chroma_location;
4128 * Video only. Number of delayed frames.
4133 * Audio only. The channel layout bitmask. May be 0 if the channel layout is
4134 * unknown or unspecified, otherwise the number of bits set must be equal to
4135 * the channels field.
4137 uint64_t channel_layout;
4139 * Audio only. The number of audio channels.
4143 * Audio only. The number of audio samples per second.
4147 * Audio only. The number of bytes per coded audio frame, required by some
4150 * Corresponds to nBlockAlign in WAVEFORMATEX.
4154 * Audio only. Audio frame size, if known. Required by some formats to be static.
4159 * Audio only. The amount of padding (in samples) inserted by the encoder at
4160 * the beginning of the audio. I.e. this number of leading decoded samples
4161 * must be discarded by the caller to get the original audio without leading
4164 int initial_padding;
4166 * Audio only. The amount of padding (in samples) appended by the encoder to
4167 * the end of the audio. I.e. this number of decoded samples must be
4168 * discarded by the caller from the end of the stream to get the original
4169 * audio without any trailing padding.
4171 int trailing_padding;
4173 * Audio only. Number of samples to skip after a discontinuity.
4176 } AVCodecParameters;
4179 * Iterate over all registered codecs.
4181 * @param opaque a pointer where libavcodec will store the iteration state. Must
4182 * point to NULL to start the iteration.
4184 * @return the next registered codec or NULL when the iteration is
4187 const AVCodec *av_codec_iterate(void **opaque);
4191 * If c is NULL, returns the first registered codec,
4192 * if c is non-NULL, returns the next registered codec after c,
4193 * or NULL if c is the last one.
4195 attribute_deprecated
4196 AVCodec *av_codec_next(const AVCodec *c);
4200 * Return the LIBAVCODEC_VERSION_INT constant.
4202 unsigned avcodec_version(void);
4205 * Return the libavcodec build-time configuration.
4207 const char *avcodec_configuration(void);
4210 * Return the libavcodec license.
4212 const char *avcodec_license(void);
4216 * Register the codec codec and initialize libavcodec.
4218 * @warning either this function or avcodec_register_all() must be called
4219 * before any other libavcodec functions.
4221 * @see avcodec_register_all()
4223 attribute_deprecated
4224 void avcodec_register(AVCodec *codec);
4227 * Register all the codecs, parsers and bitstream filters which were enabled at
4228 * configuration time. If you do not call this function you can select exactly
4229 * which formats you want to support, by using the individual registration
4232 * @see avcodec_register
4233 * @see av_register_codec_parser
4234 * @see av_register_bitstream_filter
4236 attribute_deprecated
4237 void avcodec_register_all(void);
4241 * Allocate an AVCodecContext and set its fields to default values. The
4242 * resulting struct should be freed with avcodec_free_context().
4244 * @param codec if non-NULL, allocate private data and initialize defaults
4245 * for the given codec. It is illegal to then call avcodec_open2()
4246 * with a different codec.
4247 * If NULL, then the codec-specific defaults won't be initialized,
4248 * which may result in suboptimal default settings (this is
4249 * important mainly for encoders, e.g. libx264).
4251 * @return An AVCodecContext filled with default values or NULL on failure.
4253 AVCodecContext *avcodec_alloc_context3(const AVCodec *codec);
4256 * Free the codec context and everything associated with it and write NULL to
4257 * the provided pointer.
4259 void avcodec_free_context(AVCodecContext **avctx);
4261 #if FF_API_GET_CONTEXT_DEFAULTS
4263 * @deprecated This function should not be used, as closing and opening a codec
4264 * context multiple time is not supported. A new codec context should be
4265 * allocated for each new use.
4267 int avcodec_get_context_defaults3(AVCodecContext *s, const AVCodec *codec);
4271 * Get the AVClass for AVCodecContext. It can be used in combination with
4272 * AV_OPT_SEARCH_FAKE_OBJ for examining options.
4274 * @see av_opt_find().
4276 const AVClass *avcodec_get_class(void);
4278 #if FF_API_COPY_CONTEXT
4280 * Get the AVClass for AVFrame. It can be used in combination with
4281 * AV_OPT_SEARCH_FAKE_OBJ for examining options.
4283 * @see av_opt_find().
4285 const AVClass *avcodec_get_frame_class(void);
4288 * Get the AVClass for AVSubtitleRect. It can be used in combination with
4289 * AV_OPT_SEARCH_FAKE_OBJ for examining options.
4291 * @see av_opt_find().
4293 const AVClass *avcodec_get_subtitle_rect_class(void);
4296 * Copy the settings of the source AVCodecContext into the destination
4297 * AVCodecContext. The resulting destination codec context will be
4298 * unopened, i.e. you are required to call avcodec_open2() before you
4299 * can use this AVCodecContext to decode/encode video/audio data.
4301 * @param dest target codec context, should be initialized with
4302 * avcodec_alloc_context3(NULL), but otherwise uninitialized
4303 * @param src source codec context
4304 * @return AVERROR() on error (e.g. memory allocation error), 0 on success
4306 * @deprecated The semantics of this function are ill-defined and it should not
4307 * be used. If you need to transfer the stream parameters from one codec context
4308 * to another, use an intermediate AVCodecParameters instance and the
4309 * avcodec_parameters_from_context() / avcodec_parameters_to_context()
4312 attribute_deprecated
4313 int avcodec_copy_context(AVCodecContext *dest, const AVCodecContext *src);
4317 * Allocate a new AVCodecParameters and set its fields to default values
4318 * (unknown/invalid/0). The returned struct must be freed with
4319 * avcodec_parameters_free().
4321 AVCodecParameters *avcodec_parameters_alloc(void);
4324 * Free an AVCodecParameters instance and everything associated with it and
4325 * write NULL to the supplied pointer.
4327 void avcodec_parameters_free(AVCodecParameters **par);
4330 * Copy the contents of src to dst. Any allocated fields in dst are freed and
4331 * replaced with newly allocated duplicates of the corresponding fields in src.
4333 * @return >= 0 on success, a negative AVERROR code on failure.
4335 int avcodec_parameters_copy(AVCodecParameters *dst, const AVCodecParameters *src);
4338 * Fill the parameters struct based on the values from the supplied codec
4339 * context. Any allocated fields in par are freed and replaced with duplicates
4340 * of the corresponding fields in codec.
4342 * @return >= 0 on success, a negative AVERROR code on failure
4344 int avcodec_parameters_from_context(AVCodecParameters *par,
4345 const AVCodecContext *codec);
4348 * Fill the codec context based on the values from the supplied codec
4349 * parameters. Any allocated fields in codec that have a corresponding field in
4350 * par are freed and replaced with duplicates of the corresponding field in par.
4351 * Fields in codec that do not have a counterpart in par are not touched.
4353 * @return >= 0 on success, a negative AVERROR code on failure.
4355 int avcodec_parameters_to_context(AVCodecContext *codec,
4356 const AVCodecParameters *par);
4359 * Initialize the AVCodecContext to use the given AVCodec. Prior to using this
4360 * function the context has to be allocated with avcodec_alloc_context3().
4362 * The functions avcodec_find_decoder_by_name(), avcodec_find_encoder_by_name(),
4363 * avcodec_find_decoder() and avcodec_find_encoder() provide an easy way for
4364 * retrieving a codec.
4366 * @warning This function is not thread safe!
4368 * @note Always call this function before using decoding routines (such as
4369 * @ref avcodec_receive_frame()).
4372 * avcodec_register_all();
4373 * av_dict_set(&opts, "b", "2.5M", 0);
4374 * codec = avcodec_find_decoder(AV_CODEC_ID_H264);
4378 * context = avcodec_alloc_context3(codec);
4380 * if (avcodec_open2(context, codec, opts) < 0)
4384 * @param avctx The context to initialize.
4385 * @param codec The codec to open this context for. If a non-NULL codec has been
4386 * previously passed to avcodec_alloc_context3() or
4387 * for this context, then this parameter MUST be either NULL or
4388 * equal to the previously passed codec.
4389 * @param options A dictionary filled with AVCodecContext and codec-private options.
4390 * On return this object will be filled with options that were not found.
4392 * @return zero on success, a negative value on error
4393 * @see avcodec_alloc_context3(), avcodec_find_decoder(), avcodec_find_encoder(),
4394 * av_dict_set(), av_opt_find().
4396 int avcodec_open2(AVCodecContext *avctx, const AVCodec *codec, AVDictionary **options);
4399 * Close a given AVCodecContext and free all the data associated with it
4400 * (but not the AVCodecContext itself).
4402 * Calling this function on an AVCodecContext that hasn't been opened will free
4403 * the codec-specific data allocated in avcodec_alloc_context3() with a non-NULL
4404 * codec. Subsequent calls will do nothing.
4406 * @note Do not use this function. Use avcodec_free_context() to destroy a
4407 * codec context (either open or closed). Opening and closing a codec context
4408 * multiple times is not supported anymore -- use multiple codec contexts
4411 int avcodec_close(AVCodecContext *avctx);
4414 * Free all allocated data in the given subtitle struct.
4416 * @param sub AVSubtitle to free.
4418 void avsubtitle_free(AVSubtitle *sub);
4425 * @addtogroup lavc_packet
4430 * Allocate an AVPacket and set its fields to default values. The resulting
4431 * struct must be freed using av_packet_free().
4433 * @return An AVPacket filled with default values or NULL on failure.
4435 * @note this only allocates the AVPacket itself, not the data buffers. Those
4436 * must be allocated through other means such as av_new_packet.
4438 * @see av_new_packet
4440 AVPacket *av_packet_alloc(void);
4443 * Create a new packet that references the same data as src.
4445 * This is a shortcut for av_packet_alloc()+av_packet_ref().
4447 * @return newly created AVPacket on success, NULL on error.
4449 * @see av_packet_alloc
4450 * @see av_packet_ref
4452 AVPacket *av_packet_clone(const AVPacket *src);
4455 * Free the packet, if the packet is reference counted, it will be
4456 * unreferenced first.
4458 * @param pkt packet to be freed. The pointer will be set to NULL.
4459 * @note passing NULL is a no-op.
4461 void av_packet_free(AVPacket **pkt);
4464 * Initialize optional fields of a packet with default values.
4466 * Note, this does not touch the data and size members, which have to be
4467 * initialized separately.
4471 void av_init_packet(AVPacket *pkt);
4474 * Allocate the payload of a packet and initialize its fields with
4478 * @param size wanted payload size
4479 * @return 0 if OK, AVERROR_xxx otherwise
4481 int av_new_packet(AVPacket *pkt, int size);
4484 * Reduce packet size, correctly zeroing padding
4487 * @param size new size
4489 void av_shrink_packet(AVPacket *pkt, int size);
4492 * Increase packet size, correctly zeroing padding
4495 * @param grow_by number of bytes by which to increase the size of the packet
4497 int av_grow_packet(AVPacket *pkt, int grow_by);
4500 * Initialize a reference-counted packet from av_malloc()ed data.
4502 * @param pkt packet to be initialized. This function will set the data, size,
4503 * and buf fields, all others are left untouched.
4504 * @param data Data allocated by av_malloc() to be used as packet data. If this
4505 * function returns successfully, the data is owned by the underlying AVBuffer.
4506 * The caller may not access the data through other means.
4507 * @param size size of data in bytes, without the padding. I.e. the full buffer
4508 * size is assumed to be size + AV_INPUT_BUFFER_PADDING_SIZE.
4510 * @return 0 on success, a negative AVERROR on error
4512 int av_packet_from_data(AVPacket *pkt, uint8_t *data, int size);
4514 #if FF_API_AVPACKET_OLD_API
4516 * @warning This is a hack - the packet memory allocation stuff is broken. The
4517 * packet is allocated if it was not really allocated.
4519 * @deprecated Use av_packet_ref or av_packet_make_refcounted
4521 attribute_deprecated
4522 int av_dup_packet(AVPacket *pkt);
4524 * Copy packet, including contents
4526 * @return 0 on success, negative AVERROR on fail
4528 * @deprecated Use av_packet_ref
4530 attribute_deprecated
4531 int av_copy_packet(AVPacket *dst, const AVPacket *src);
4534 * Copy packet side data
4536 * @return 0 on success, negative AVERROR on fail
4538 * @deprecated Use av_packet_copy_props
4540 attribute_deprecated
4541 int av_copy_packet_side_data(AVPacket *dst, const AVPacket *src);
4546 * @deprecated Use av_packet_unref
4548 * @param pkt packet to free
4550 attribute_deprecated
4551 void av_free_packet(AVPacket *pkt);
4554 * Allocate new information of a packet.
4557 * @param type side information type
4558 * @param size side information size
4559 * @return pointer to fresh allocated data or NULL otherwise
4561 uint8_t* av_packet_new_side_data(AVPacket *pkt, enum AVPacketSideDataType type,
4565 * Wrap an existing array as a packet side data.
4568 * @param type side information type
4569 * @param data the side data array. It must be allocated with the av_malloc()
4570 * family of functions. The ownership of the data is transferred to
4572 * @param size side information size
4573 * @return a non-negative number on success, a negative AVERROR code on
4574 * failure. On failure, the packet is unchanged and the data remains
4575 * owned by the caller.
4577 int av_packet_add_side_data(AVPacket *pkt, enum AVPacketSideDataType type,
4578 uint8_t *data, size_t size);
4581 * Shrink the already allocated side data buffer
4584 * @param type side information type
4585 * @param size new side information size
4586 * @return 0 on success, < 0 on failure
4588 int av_packet_shrink_side_data(AVPacket *pkt, enum AVPacketSideDataType type,
4592 * Get side information from packet.
4595 * @param type desired side information type
4596 * @param size pointer for side information size to store (optional)
4597 * @return pointer to data if present or NULL otherwise
4599 uint8_t* av_packet_get_side_data(const AVPacket *pkt, enum AVPacketSideDataType type,
4602 #if FF_API_MERGE_SD_API
4603 attribute_deprecated
4604 int av_packet_merge_side_data(AVPacket *pkt);
4606 attribute_deprecated
4607 int av_packet_split_side_data(AVPacket *pkt);
4610 const char *av_packet_side_data_name(enum AVPacketSideDataType type);
4613 * Pack a dictionary for use in side_data.
4615 * @param dict The dictionary to pack.
4616 * @param size pointer to store the size of the returned data
4617 * @return pointer to data if successful, NULL otherwise
4619 uint8_t *av_packet_pack_dictionary(AVDictionary *dict, int *size);
4621 * Unpack a dictionary from side_data.
4623 * @param data data from side_data
4624 * @param size size of the data
4625 * @param dict the metadata storage dictionary
4626 * @return 0 on success, < 0 on failure
4628 int av_packet_unpack_dictionary(const uint8_t *data, int size, AVDictionary **dict);
4632 * Convenience function to free all the side data stored.
4633 * All the other fields stay untouched.
4637 void av_packet_free_side_data(AVPacket *pkt);
4640 * Setup a new reference to the data described by a given packet
4642 * If src is reference-counted, setup dst as a new reference to the
4643 * buffer in src. Otherwise allocate a new buffer in dst and copy the
4644 * data from src into it.
4646 * All the other fields are copied from src.
4648 * @see av_packet_unref
4650 * @param dst Destination packet
4651 * @param src Source packet
4653 * @return 0 on success, a negative AVERROR on error.
4655 int av_packet_ref(AVPacket *dst, const AVPacket *src);
4660 * Unreference the buffer referenced by the packet and reset the
4661 * remaining packet fields to their default values.
4663 * @param pkt The packet to be unreferenced.
4665 void av_packet_unref(AVPacket *pkt);
4668 * Move every field in src to dst and reset src.
4670 * @see av_packet_unref
4672 * @param src Source packet, will be reset
4673 * @param dst Destination packet
4675 void av_packet_move_ref(AVPacket *dst, AVPacket *src);
4678 * Copy only "properties" fields from src to dst.
4680 * Properties for the purpose of this function are all the fields
4681 * beside those related to the packet data (buf, data, size)
4683 * @param dst Destination packet
4684 * @param src Source packet
4686 * @return 0 on success AVERROR on failure.
4688 int av_packet_copy_props(AVPacket *dst, const AVPacket *src);
4691 * Ensure the data described by a given packet is reference counted.
4693 * @note This function does not ensure that the reference will be writable.
4694 * Use av_packet_make_writable instead for that purpose.
4696 * @see av_packet_ref
4697 * @see av_packet_make_writable
4699 * @param pkt packet whose data should be made reference counted.
4701 * @return 0 on success, a negative AVERROR on error. On failure, the
4702 * packet is unchanged.
4704 int av_packet_make_refcounted(AVPacket *pkt);
4707 * Create a writable reference for the data described by a given packet,
4708 * avoiding data copy if possible.
4710 * @param pkt Packet whose data should be made writable.
4712 * @return 0 on success, a negative AVERROR on failure. On failure, the
4713 * packet is unchanged.
4715 int av_packet_make_writable(AVPacket *pkt);
4718 * Convert valid timing fields (timestamps / durations) in a packet from one
4719 * timebase to another. Timestamps with unknown values (AV_NOPTS_VALUE) will be
4722 * @param pkt packet on which the conversion will be performed
4723 * @param tb_src source timebase, in which the timing fields in pkt are
4725 * @param tb_dst destination timebase, to which the timing fields will be
4728 void av_packet_rescale_ts(AVPacket *pkt, AVRational tb_src, AVRational tb_dst);
4735 * @addtogroup lavc_decoding
4740 * Find a registered decoder with a matching codec ID.
4742 * @param id AVCodecID of the requested decoder
4743 * @return A decoder if one was found, NULL otherwise.
4745 AVCodec *avcodec_find_decoder(enum AVCodecID id);
4748 * Find a registered decoder with the specified name.
4750 * @param name name of the requested decoder
4751 * @return A decoder if one was found, NULL otherwise.
4753 AVCodec *avcodec_find_decoder_by_name(const char *name);
4756 * The default callback for AVCodecContext.get_buffer2(). It is made public so
4757 * it can be called by custom get_buffer2() implementations for decoders without
4758 * AV_CODEC_CAP_DR1 set.
4760 int avcodec_default_get_buffer2(AVCodecContext *s, AVFrame *frame, int flags);
4763 * Modify width and height values so that they will result in a memory
4764 * buffer that is acceptable for the codec if you do not use any horizontal
4767 * May only be used if a codec with AV_CODEC_CAP_DR1 has been opened.
4769 void avcodec_align_dimensions(AVCodecContext *s, int *width, int *height);
4772 * Modify width and height values so that they will result in a memory
4773 * buffer that is acceptable for the codec if you also ensure that all
4774 * line sizes are a multiple of the respective linesize_align[i].
4776 * May only be used if a codec with AV_CODEC_CAP_DR1 has been opened.
4778 void avcodec_align_dimensions2(AVCodecContext *s, int *width, int *height,
4779 int linesize_align[AV_NUM_DATA_POINTERS]);
4782 * Converts AVChromaLocation to swscale x/y chroma position.
4784 * The positions represent the chroma (0,0) position in a coordinates system
4785 * with luma (0,0) representing the origin and luma(1,1) representing 256,256
4787 * @param xpos horizontal chroma sample position
4788 * @param ypos vertical chroma sample position
4790 int avcodec_enum_to_chroma_pos(int *xpos, int *ypos, enum AVChromaLocation pos);
4793 * Converts swscale x/y chroma position to AVChromaLocation.
4795 * The positions represent the chroma (0,0) position in a coordinates system
4796 * with luma (0,0) representing the origin and luma(1,1) representing 256,256
4798 * @param xpos horizontal chroma sample position
4799 * @param ypos vertical chroma sample position
4801 enum AVChromaLocation avcodec_chroma_pos_to_enum(int xpos, int ypos);
4804 * Decode the audio frame of size avpkt->size from avpkt->data into frame.
4806 * Some decoders may support multiple frames in a single AVPacket. Such
4807 * decoders would then just decode the first frame and the return value would be
4808 * less than the packet size. In this case, avcodec_decode_audio4 has to be
4809 * called again with an AVPacket containing the remaining data in order to
4810 * decode the second frame, etc... Even if no frames are returned, the packet
4811 * needs to be fed to the decoder with remaining data until it is completely
4812 * consumed or an error occurs.
4814 * Some decoders (those marked with AV_CODEC_CAP_DELAY) have a delay between input
4815 * and output. This means that for some packets they will not immediately
4816 * produce decoded output and need to be flushed at the end of decoding to get
4817 * all the decoded data. Flushing is done by calling this function with packets
4818 * with avpkt->data set to NULL and avpkt->size set to 0 until it stops
4819 * returning samples. It is safe to flush even those decoders that are not
4820 * marked with AV_CODEC_CAP_DELAY, then no samples will be returned.
4822 * @warning The input buffer, avpkt->data must be AV_INPUT_BUFFER_PADDING_SIZE
4823 * larger than the actual read bytes because some optimized bitstream
4824 * readers read 32 or 64 bits at once and could read over the end.
4826 * @note The AVCodecContext MUST have been opened with @ref avcodec_open2()
4827 * before packets may be fed to the decoder.
4829 * @param avctx the codec context
4830 * @param[out] frame The AVFrame in which to store decoded audio samples.
4831 * The decoder will allocate a buffer for the decoded frame by
4832 * calling the AVCodecContext.get_buffer2() callback.
4833 * When AVCodecContext.refcounted_frames is set to 1, the frame is
4834 * reference counted and the returned reference belongs to the
4835 * caller. The caller must release the frame using av_frame_unref()
4836 * when the frame is no longer needed. The caller may safely write
4837 * to the frame if av_frame_is_writable() returns 1.
4838 * When AVCodecContext.refcounted_frames is set to 0, the returned
4839 * reference belongs to the decoder and is valid only until the
4840 * next call to this function or until closing or flushing the
4841 * decoder. The caller may not write to it.
4842 * @param[out] got_frame_ptr Zero if no frame could be decoded, otherwise it is
4843 * non-zero. Note that this field being set to zero
4844 * does not mean that an error has occurred. For
4845 * decoders with AV_CODEC_CAP_DELAY set, no given decode
4846 * call is guaranteed to produce a frame.
4847 * @param[in] avpkt The input AVPacket containing the input buffer.
4848 * At least avpkt->data and avpkt->size should be set. Some
4849 * decoders might also require additional fields to be set.
4850 * @return A negative error code is returned if an error occurred during
4851 * decoding, otherwise the number of bytes consumed from the input
4852 * AVPacket is returned.
4854 * @deprecated Use avcodec_send_packet() and avcodec_receive_frame().
4856 attribute_deprecated
4857 int avcodec_decode_audio4(AVCodecContext *avctx, AVFrame *frame,
4858 int *got_frame_ptr, const AVPacket *avpkt);
4861 * Decode the video frame of size avpkt->size from avpkt->data into picture.
4862 * Some decoders may support multiple frames in a single AVPacket, such
4863 * decoders would then just decode the first frame.
4865 * @warning The input buffer must be AV_INPUT_BUFFER_PADDING_SIZE larger than
4866 * the actual read bytes because some optimized bitstream readers read 32 or 64
4867 * bits at once and could read over the end.
4869 * @warning The end of the input buffer buf should be set to 0 to ensure that
4870 * no overreading happens for damaged MPEG streams.
4872 * @note Codecs which have the AV_CODEC_CAP_DELAY capability set have a delay
4873 * between input and output, these need to be fed with avpkt->data=NULL,
4874 * avpkt->size=0 at the end to return the remaining frames.
4876 * @note The AVCodecContext MUST have been opened with @ref avcodec_open2()
4877 * before packets may be fed to the decoder.
4879 * @param avctx the codec context
4880 * @param[out] picture The AVFrame in which the decoded video frame will be stored.
4881 * Use av_frame_alloc() to get an AVFrame. The codec will
4882 * allocate memory for the actual bitmap by calling the
4883 * AVCodecContext.get_buffer2() callback.
4884 * When AVCodecContext.refcounted_frames is set to 1, the frame is
4885 * reference counted and the returned reference belongs to the
4886 * caller. The caller must release the frame using av_frame_unref()
4887 * when the frame is no longer needed. The caller may safely write
4888 * to the frame if av_frame_is_writable() returns 1.
4889 * When AVCodecContext.refcounted_frames is set to 0, the returned
4890 * reference belongs to the decoder and is valid only until the
4891 * next call to this function or until closing or flushing the
4892 * decoder. The caller may not write to it.
4894 * @param[in] avpkt The input AVPacket containing the input buffer.
4895 * You can create such packet with av_init_packet() and by then setting
4896 * data and size, some decoders might in addition need other fields like
4897 * flags&AV_PKT_FLAG_KEY. All decoders are designed to use the least
4899 * @param[in,out] got_picture_ptr Zero if no frame could be decompressed, otherwise, it is nonzero.
4900 * @return On error a negative value is returned, otherwise the number of bytes
4901 * used or zero if no frame could be decompressed.
4903 * @deprecated Use avcodec_send_packet() and avcodec_receive_frame().
4905 attribute_deprecated
4906 int avcodec_decode_video2(AVCodecContext *avctx, AVFrame *picture,
4907 int *got_picture_ptr,
4908 const AVPacket *avpkt);
4911 * Decode a subtitle message.
4912 * Return a negative value on error, otherwise return the number of bytes used.
4913 * If no subtitle could be decompressed, got_sub_ptr is zero.
4914 * Otherwise, the subtitle is stored in *sub.
4915 * Note that AV_CODEC_CAP_DR1 is not available for subtitle codecs. This is for
4916 * simplicity, because the performance difference is expected to be negligible
4917 * and reusing a get_buffer written for video codecs would probably perform badly
4918 * due to a potentially very different allocation pattern.
4920 * Some decoders (those marked with AV_CODEC_CAP_DELAY) have a delay between input
4921 * and output. This means that for some packets they will not immediately
4922 * produce decoded output and need to be flushed at the end of decoding to get
4923 * all the decoded data. Flushing is done by calling this function with packets
4924 * with avpkt->data set to NULL and avpkt->size set to 0 until it stops
4925 * returning subtitles. It is safe to flush even those decoders that are not
4926 * marked with AV_CODEC_CAP_DELAY, then no subtitles will be returned.
4928 * @note The AVCodecContext MUST have been opened with @ref avcodec_open2()
4929 * before packets may be fed to the decoder.
4931 * @param avctx the codec context
4932 * @param[out] sub The preallocated AVSubtitle in which the decoded subtitle will be stored,
4933 * must be freed with avsubtitle_free if *got_sub_ptr is set.
4934 * @param[in,out] got_sub_ptr Zero if no subtitle could be decompressed, otherwise, it is nonzero.
4935 * @param[in] avpkt The input AVPacket containing the input buffer.
4937 int avcodec_decode_subtitle2(AVCodecContext *avctx, AVSubtitle *sub,
4942 * Supply raw packet data as input to a decoder.
4944 * Internally, this call will copy relevant AVCodecContext fields, which can
4945 * influence decoding per-packet, and apply them when the packet is actually
4946 * decoded. (For example AVCodecContext.skip_frame, which might direct the
4947 * decoder to drop the frame contained by the packet sent with this function.)
4949 * @warning The input buffer, avpkt->data must be AV_INPUT_BUFFER_PADDING_SIZE
4950 * larger than the actual read bytes because some optimized bitstream
4951 * readers read 32 or 64 bits at once and could read over the end.
4953 * @warning Do not mix this API with the legacy API (like avcodec_decode_video2())
4954 * on the same AVCodecContext. It will return unexpected results now
4955 * or in future libavcodec versions.
4957 * @note The AVCodecContext MUST have been opened with @ref avcodec_open2()
4958 * before packets may be fed to the decoder.
4960 * @param avctx codec context
4961 * @param[in] avpkt The input AVPacket. Usually, this will be a single video
4962 * frame, or several complete audio frames.
4963 * Ownership of the packet remains with the caller, and the
4964 * decoder will not write to the packet. The decoder may create
4965 * a reference to the packet data (or copy it if the packet is
4966 * not reference-counted).
4967 * Unlike with older APIs, the packet is always fully consumed,
4968 * and if it contains multiple frames (e.g. some audio codecs),
4969 * will require you to call avcodec_receive_frame() multiple
4970 * times afterwards before you can send a new packet.
4971 * It can be NULL (or an AVPacket with data set to NULL and
4972 * size set to 0); in this case, it is considered a flush
4973 * packet, which signals the end of the stream. Sending the
4974 * first flush packet will return success. Subsequent ones are
4975 * unnecessary and will return AVERROR_EOF. If the decoder
4976 * still has frames buffered, it will return them after sending
4979 * @return 0 on success, otherwise negative error code:
4980 * AVERROR(EAGAIN): input is not accepted in the current state - user
4981 * must read output with avcodec_receive_frame() (once
4982 * all output is read, the packet should be resent, and
4983 * the call will not fail with EAGAIN).
4984 * AVERROR_EOF: the decoder has been flushed, and no new packets can
4985 * be sent to it (also returned if more than 1 flush
4987 * AVERROR(EINVAL): codec not opened, it is an encoder, or requires flush
4988 * AVERROR(ENOMEM): failed to add packet to internal queue, or similar
4989 * other errors: legitimate decoding errors
4991 int avcodec_send_packet(AVCodecContext *avctx, const AVPacket *avpkt);
4994 * Return decoded output data from a decoder.
4996 * @param avctx codec context
4997 * @param frame This will be set to a reference-counted video or audio
4998 * frame (depending on the decoder type) allocated by the
4999 * decoder. Note that the function will always call
5000 * av_frame_unref(frame) before doing anything else.
5003 * 0: success, a frame was returned
5004 * AVERROR(EAGAIN): output is not available in this state - user must try
5006 * AVERROR_EOF: the decoder has been fully flushed, and there will be
5007 * no more output frames
5008 * AVERROR(EINVAL): codec not opened, or it is an encoder
5009 * AVERROR_INPUT_CHANGED: current decoded frame has changed parameters
5010 * with respect to first decoded frame. Applicable
5011 * when flag AV_CODEC_FLAG_DROPCHANGED is set.
5012 * other negative values: legitimate decoding errors
5014 int avcodec_receive_frame(AVCodecContext *avctx, AVFrame *frame);
5017 * Supply a raw video or audio frame to the encoder. Use avcodec_receive_packet()
5018 * to retrieve buffered output packets.
5020 * @param avctx codec context
5021 * @param[in] frame AVFrame containing the raw audio or video frame to be encoded.
5022 * Ownership of the frame remains with the caller, and the
5023 * encoder will not write to the frame. The encoder may create
5024 * a reference to the frame data (or copy it if the frame is
5025 * not reference-counted).
5026 * It can be NULL, in which case it is considered a flush
5027 * packet. This signals the end of the stream. If the encoder
5028 * still has packets buffered, it will return them after this
5029 * call. Once flushing mode has been entered, additional flush
5030 * packets are ignored, and sending frames will return
5034 * If AV_CODEC_CAP_VARIABLE_FRAME_SIZE is set, then each frame
5035 * can have any number of samples.
5036 * If it is not set, frame->nb_samples must be equal to
5037 * avctx->frame_size for all frames except the last.
5038 * The final frame may be smaller than avctx->frame_size.
5039 * @return 0 on success, otherwise negative error code:
5040 * AVERROR(EAGAIN): input is not accepted in the current state - user
5041 * must read output with avcodec_receive_packet() (once
5042 * all output is read, the packet should be resent, and
5043 * the call will not fail with EAGAIN).
5044 * AVERROR_EOF: the encoder has been flushed, and no new frames can
5046 * AVERROR(EINVAL): codec not opened, refcounted_frames not set, it is a
5047 * decoder, or requires flush
5048 * AVERROR(ENOMEM): failed to add packet to internal queue, or similar
5049 * other errors: legitimate decoding errors
5051 int avcodec_send_frame(AVCodecContext *avctx, const AVFrame *frame);
5054 * Read encoded data from the encoder.
5056 * @param avctx codec context
5057 * @param avpkt This will be set to a reference-counted packet allocated by the
5058 * encoder. Note that the function will always call
5059 * av_packet_unref(avpkt) before doing anything else.
5060 * @return 0 on success, otherwise negative error code:
5061 * AVERROR(EAGAIN): output is not available in the current state - user
5062 * must try to send input
5063 * AVERROR_EOF: the encoder has been fully flushed, and there will be
5064 * no more output packets
5065 * AVERROR(EINVAL): codec not opened, or it is an encoder
5066 * other errors: legitimate decoding errors
5068 int avcodec_receive_packet(AVCodecContext *avctx, AVPacket *avpkt);
5071 * Create and return a AVHWFramesContext with values adequate for hardware
5072 * decoding. This is meant to get called from the get_format callback, and is
5073 * a helper for preparing a AVHWFramesContext for AVCodecContext.hw_frames_ctx.
5074 * This API is for decoding with certain hardware acceleration modes/APIs only.
5076 * The returned AVHWFramesContext is not initialized. The caller must do this
5077 * with av_hwframe_ctx_init().
5079 * Calling this function is not a requirement, but makes it simpler to avoid
5080 * codec or hardware API specific details when manually allocating frames.
5082 * Alternatively to this, an API user can set AVCodecContext.hw_device_ctx,
5083 * which sets up AVCodecContext.hw_frames_ctx fully automatically, and makes
5084 * it unnecessary to call this function or having to care about
5085 * AVHWFramesContext initialization at all.
5087 * There are a number of requirements for calling this function:
5089 * - It must be called from get_format with the same avctx parameter that was
5090 * passed to get_format. Calling it outside of get_format is not allowed, and
5091 * can trigger undefined behavior.
5092 * - The function is not always supported (see description of return values).
5093 * Even if this function returns successfully, hwaccel initialization could
5094 * fail later. (The degree to which implementations check whether the stream
5095 * is actually supported varies. Some do this check only after the user's
5096 * get_format callback returns.)
5097 * - The hw_pix_fmt must be one of the choices suggested by get_format. If the
5098 * user decides to use a AVHWFramesContext prepared with this API function,
5099 * the user must return the same hw_pix_fmt from get_format.
5100 * - The device_ref passed to this function must support the given hw_pix_fmt.
5101 * - After calling this API function, it is the user's responsibility to
5102 * initialize the AVHWFramesContext (returned by the out_frames_ref parameter),
5103 * and to set AVCodecContext.hw_frames_ctx to it. If done, this must be done
5104 * before returning from get_format (this is implied by the normal
5105 * AVCodecContext.hw_frames_ctx API rules).
5106 * - The AVHWFramesContext parameters may change every time time get_format is
5107 * called. Also, AVCodecContext.hw_frames_ctx is reset before get_format. So
5108 * you are inherently required to go through this process again on every
5110 * - It is perfectly possible to call this function without actually using
5111 * the resulting AVHWFramesContext. One use-case might be trying to reuse a
5112 * previously initialized AVHWFramesContext, and calling this API function
5113 * only to test whether the required frame parameters have changed.
5114 * - Fields that use dynamically allocated values of any kind must not be set
5115 * by the user unless setting them is explicitly allowed by the documentation.
5116 * If the user sets AVHWFramesContext.free and AVHWFramesContext.user_opaque,
5117 * the new free callback must call the potentially set previous free callback.
5118 * This API call may set any dynamically allocated fields, including the free
5121 * The function will set at least the following fields on AVHWFramesContext
5122 * (potentially more, depending on hwaccel API):
5124 * - All fields set by av_hwframe_ctx_alloc().
5125 * - Set the format field to hw_pix_fmt.
5126 * - Set the sw_format field to the most suited and most versatile format. (An
5127 * implication is that this will prefer generic formats over opaque formats
5128 * with arbitrary restrictions, if possible.)
5129 * - Set the width/height fields to the coded frame size, rounded up to the
5130 * API-specific minimum alignment.
5131 * - Only _if_ the hwaccel requires a pre-allocated pool: set the initial_pool_size
5132 * field to the number of maximum reference surfaces possible with the codec,
5133 * plus 1 surface for the user to work (meaning the user can safely reference
5134 * at most 1 decoded surface at a time), plus additional buffering introduced
5135 * by frame threading. If the hwaccel does not require pre-allocation, the
5136 * field is left to 0, and the decoder will allocate new surfaces on demand
5138 * - Possibly AVHWFramesContext.hwctx fields, depending on the underlying
5141 * Essentially, out_frames_ref returns the same as av_hwframe_ctx_alloc(), but
5142 * with basic frame parameters set.
5144 * The function is stateless, and does not change the AVCodecContext or the
5145 * device_ref AVHWDeviceContext.
5147 * @param avctx The context which is currently calling get_format, and which
5148 * implicitly contains all state needed for filling the returned
5149 * AVHWFramesContext properly.
5150 * @param device_ref A reference to the AVHWDeviceContext describing the device
5151 * which will be used by the hardware decoder.
5152 * @param hw_pix_fmt The hwaccel format you are going to return from get_format.
5153 * @param out_frames_ref On success, set to a reference to an _uninitialized_
5154 * AVHWFramesContext, created from the given device_ref.
5155 * Fields will be set to values required for decoding.
5156 * Not changed if an error is returned.
5157 * @return zero on success, a negative value on error. The following error codes
5158 * have special semantics:
5159 * AVERROR(ENOENT): the decoder does not support this functionality. Setup
5160 * is always manual, or it is a decoder which does not
5161 * support setting AVCodecContext.hw_frames_ctx at all,
5162 * or it is a software format.
5163 * AVERROR(EINVAL): it is known that hardware decoding is not supported for
5164 * this configuration, or the device_ref is not supported
5165 * for the hwaccel referenced by hw_pix_fmt.
5167 int avcodec_get_hw_frames_parameters(AVCodecContext *avctx,
5168 AVBufferRef *device_ref,
5169 enum AVPixelFormat hw_pix_fmt,
5170 AVBufferRef **out_frames_ref);
5175 * @defgroup lavc_parsing Frame parsing
5179 enum AVPictureStructure {
5180 AV_PICTURE_STRUCTURE_UNKNOWN, //< unknown
5181 AV_PICTURE_STRUCTURE_TOP_FIELD, //< coded as top field
5182 AV_PICTURE_STRUCTURE_BOTTOM_FIELD, //< coded as bottom field
5183 AV_PICTURE_STRUCTURE_FRAME, //< coded as frame
5186 typedef struct AVCodecParserContext {
5188 struct AVCodecParser *parser;
5189 int64_t frame_offset; /* offset of the current frame */
5190 int64_t cur_offset; /* current offset
5191 (incremented by each av_parser_parse()) */
5192 int64_t next_frame_offset; /* offset of the next frame */
5194 int pict_type; /* XXX: Put it back in AVCodecContext. */
5196 * This field is used for proper frame duration computation in lavf.
5197 * It signals, how much longer the frame duration of the current frame
5198 * is compared to normal frame duration.
5200 * frame_duration = (1 + repeat_pict) * time_base
5202 * It is used by codecs like H.264 to display telecined material.
5204 int repeat_pict; /* XXX: Put it back in AVCodecContext. */
5205 int64_t pts; /* pts of the current frame */
5206 int64_t dts; /* dts of the current frame */
5211 int fetch_timestamp;
5213 #define AV_PARSER_PTS_NB 4
5214 int cur_frame_start_index;
5215 int64_t cur_frame_offset[AV_PARSER_PTS_NB];
5216 int64_t cur_frame_pts[AV_PARSER_PTS_NB];
5217 int64_t cur_frame_dts[AV_PARSER_PTS_NB];
5220 #define PARSER_FLAG_COMPLETE_FRAMES 0x0001
5221 #define PARSER_FLAG_ONCE 0x0002
5222 /// Set if the parser has a valid file offset
5223 #define PARSER_FLAG_FETCHED_OFFSET 0x0004
5224 #define PARSER_FLAG_USE_CODEC_TS 0x1000
5226 int64_t offset; ///< byte offset from starting packet start
5227 int64_t cur_frame_end[AV_PARSER_PTS_NB];
5230 * Set by parser to 1 for key frames and 0 for non-key frames.
5231 * It is initialized to -1, so if the parser doesn't set this flag,
5232 * old-style fallback using AV_PICTURE_TYPE_I picture type as key frames
5237 #if FF_API_CONVERGENCE_DURATION
5239 * @deprecated unused
5241 attribute_deprecated
5242 int64_t convergence_duration;
5245 // Timestamp generation support:
5247 * Synchronization point for start of timestamp generation.
5249 * Set to >0 for sync point, 0 for no sync point and <0 for undefined
5252 * For example, this corresponds to presence of H.264 buffering period
5258 * Offset of the current timestamp against last timestamp sync point in
5259 * units of AVCodecContext.time_base.
5261 * Set to INT_MIN when dts_sync_point unused. Otherwise, it must
5262 * contain a valid timestamp offset.
5264 * Note that the timestamp of sync point has usually a nonzero
5265 * dts_ref_dts_delta, which refers to the previous sync point. Offset of
5266 * the next frame after timestamp sync point will be usually 1.
5268 * For example, this corresponds to H.264 cpb_removal_delay.
5270 int dts_ref_dts_delta;
5273 * Presentation delay of current frame in units of AVCodecContext.time_base.
5275 * Set to INT_MIN when dts_sync_point unused. Otherwise, it must
5276 * contain valid non-negative timestamp delta (presentation time of a frame
5277 * must not lie in the past).
5279 * This delay represents the difference between decoding and presentation
5280 * time of the frame.
5282 * For example, this corresponds to H.264 dpb_output_delay.
5287 * Position of the packet in file.
5289 * Analogous to cur_frame_pts/dts
5291 int64_t cur_frame_pos[AV_PARSER_PTS_NB];
5294 * Byte position of currently parsed frame in stream.
5299 * Previous frame byte position.
5304 * Duration of the current frame.
5305 * For audio, this is in units of 1 / AVCodecContext.sample_rate.
5306 * For all other types, this is in units of AVCodecContext.time_base.
5310 enum AVFieldOrder field_order;
5313 * Indicate whether a picture is coded as a frame, top field or bottom field.
5315 * For example, H.264 field_pic_flag equal to 0 corresponds to
5316 * AV_PICTURE_STRUCTURE_FRAME. An H.264 picture with field_pic_flag
5317 * equal to 1 and bottom_field_flag equal to 0 corresponds to
5318 * AV_PICTURE_STRUCTURE_TOP_FIELD.
5320 enum AVPictureStructure picture_structure;
5323 * Picture number incremented in presentation or output order.
5324 * This field may be reinitialized at the first picture of a new sequence.
5326 * For example, this corresponds to H.264 PicOrderCnt.
5328 int output_picture_number;
5331 * Dimensions of the decoded video intended for presentation.
5337 * Dimensions of the coded video.
5343 * The format of the coded data, corresponds to enum AVPixelFormat for video
5344 * and for enum AVSampleFormat for audio.
5346 * Note that a decoder can have considerable freedom in how exactly it
5347 * decodes the data, so the format reported here might be different from the
5348 * one returned by a decoder.
5351 } AVCodecParserContext;
5353 typedef struct AVCodecParser {
5354 int codec_ids[5]; /* several codec IDs are permitted */
5356 int (*parser_init)(AVCodecParserContext *s);
5357 /* This callback never returns an error, a negative value means that
5358 * the frame start was in a previous packet. */
5359 int (*parser_parse)(AVCodecParserContext *s,
5360 AVCodecContext *avctx,
5361 const uint8_t **poutbuf, int *poutbuf_size,
5362 const uint8_t *buf, int buf_size);
5363 void (*parser_close)(AVCodecParserContext *s);
5364 int (*split)(AVCodecContext *avctx, const uint8_t *buf, int buf_size);
5365 struct AVCodecParser *next;
5369 * Iterate over all registered codec parsers.
5371 * @param opaque a pointer where libavcodec will store the iteration state. Must
5372 * point to NULL to start the iteration.
5374 * @return the next registered codec parser or NULL when the iteration is
5377 const AVCodecParser *av_parser_iterate(void **opaque);
5379 attribute_deprecated
5380 AVCodecParser *av_parser_next(const AVCodecParser *c);
5382 attribute_deprecated
5383 void av_register_codec_parser(AVCodecParser *parser);
5384 AVCodecParserContext *av_parser_init(int codec_id);
5389 * @param s parser context.
5390 * @param avctx codec context.
5391 * @param poutbuf set to pointer to parsed buffer or NULL if not yet finished.
5392 * @param poutbuf_size set to size of parsed buffer or zero if not yet finished.
5393 * @param buf input buffer.
5394 * @param buf_size buffer size in bytes without the padding. I.e. the full buffer
5395 size is assumed to be buf_size + AV_INPUT_BUFFER_PADDING_SIZE.
5396 To signal EOF, this should be 0 (so that the last frame
5398 * @param pts input presentation timestamp.
5399 * @param dts input decoding timestamp.
5400 * @param pos input byte position in stream.
5401 * @return the number of bytes of the input bitstream used.
5406 * len = av_parser_parse2(myparser, AVCodecContext, &data, &size,
5413 * decode_frame(data, size);
5417 int av_parser_parse2(AVCodecParserContext *s,
5418 AVCodecContext *avctx,
5419 uint8_t **poutbuf, int *poutbuf_size,
5420 const uint8_t *buf, int buf_size,
5421 int64_t pts, int64_t dts,
5425 * @return 0 if the output buffer is a subset of the input, 1 if it is allocated and must be freed
5426 * @deprecated use AVBitStreamFilter
5428 int av_parser_change(AVCodecParserContext *s,
5429 AVCodecContext *avctx,
5430 uint8_t **poutbuf, int *poutbuf_size,
5431 const uint8_t *buf, int buf_size, int keyframe);
5432 void av_parser_close(AVCodecParserContext *s);
5440 * @addtogroup lavc_encoding
5445 * Find a registered encoder with a matching codec ID.
5447 * @param id AVCodecID of the requested encoder
5448 * @return An encoder if one was found, NULL otherwise.
5450 AVCodec *avcodec_find_encoder(enum AVCodecID id);
5453 * Find a registered encoder with the specified name.
5455 * @param name name of the requested encoder
5456 * @return An encoder if one was found, NULL otherwise.
5458 AVCodec *avcodec_find_encoder_by_name(const char *name);
5461 * Encode a frame of audio.
5463 * Takes input samples from frame and writes the next output packet, if
5464 * available, to avpkt. The output packet does not necessarily contain data for
5465 * the most recent frame, as encoders can delay, split, and combine input frames
5466 * internally as needed.
5468 * @param avctx codec context
5469 * @param avpkt output AVPacket.
5470 * The user can supply an output buffer by setting
5471 * avpkt->data and avpkt->size prior to calling the
5472 * function, but if the size of the user-provided data is not
5473 * large enough, encoding will fail. If avpkt->data and
5474 * avpkt->size are set, avpkt->destruct must also be set. All
5475 * other AVPacket fields will be reset by the encoder using
5476 * av_init_packet(). If avpkt->data is NULL, the encoder will
5477 * allocate it. The encoder will set avpkt->size to the size
5478 * of the output packet.
5480 * If this function fails or produces no output, avpkt will be
5481 * freed using av_packet_unref().
5482 * @param[in] frame AVFrame containing the raw audio data to be encoded.
5483 * May be NULL when flushing an encoder that has the
5484 * AV_CODEC_CAP_DELAY capability set.
5485 * If AV_CODEC_CAP_VARIABLE_FRAME_SIZE is set, then each frame
5486 * can have any number of samples.
5487 * If it is not set, frame->nb_samples must be equal to
5488 * avctx->frame_size for all frames except the last.
5489 * The final frame may be smaller than avctx->frame_size.
5490 * @param[out] got_packet_ptr This field is set to 1 by libavcodec if the
5491 * output packet is non-empty, and to 0 if it is
5492 * empty. If the function returns an error, the
5493 * packet can be assumed to be invalid, and the
5494 * value of got_packet_ptr is undefined and should
5496 * @return 0 on success, negative error code on failure
5498 * @deprecated use avcodec_send_frame()/avcodec_receive_packet() instead
5500 attribute_deprecated
5501 int avcodec_encode_audio2(AVCodecContext *avctx, AVPacket *avpkt,
5502 const AVFrame *frame, int *got_packet_ptr);
5505 * Encode a frame of video.
5507 * Takes input raw video data from frame and writes the next output packet, if
5508 * available, to avpkt. The output packet does not necessarily contain data for
5509 * the most recent frame, as encoders can delay and reorder input frames
5510 * internally as needed.
5512 * @param avctx codec context
5513 * @param avpkt output AVPacket.
5514 * The user can supply an output buffer by setting
5515 * avpkt->data and avpkt->size prior to calling the
5516 * function, but if the size of the user-provided data is not
5517 * large enough, encoding will fail. All other AVPacket fields
5518 * will be reset by the encoder using av_init_packet(). If
5519 * avpkt->data is NULL, the encoder will allocate it.
5520 * The encoder will set avpkt->size to the size of the
5521 * output packet. The returned data (if any) belongs to the
5522 * caller, he is responsible for freeing it.
5524 * If this function fails or produces no output, avpkt will be
5525 * freed using av_packet_unref().
5526 * @param[in] frame AVFrame containing the raw video data to be encoded.
5527 * May be NULL when flushing an encoder that has the
5528 * AV_CODEC_CAP_DELAY capability set.
5529 * @param[out] got_packet_ptr This field is set to 1 by libavcodec if the
5530 * output packet is non-empty, and to 0 if it is
5531 * empty. If the function returns an error, the
5532 * packet can be assumed to be invalid, and the
5533 * value of got_packet_ptr is undefined and should
5535 * @return 0 on success, negative error code on failure
5537 * @deprecated use avcodec_send_frame()/avcodec_receive_packet() instead
5539 attribute_deprecated
5540 int avcodec_encode_video2(AVCodecContext *avctx, AVPacket *avpkt,
5541 const AVFrame *frame, int *got_packet_ptr);
5543 int avcodec_encode_subtitle(AVCodecContext *avctx, uint8_t *buf, int buf_size,
5544 const AVSubtitle *sub);
5551 #if FF_API_AVPICTURE
5553 * @addtogroup lavc_picture
5558 * @deprecated unused
5560 attribute_deprecated
5561 int avpicture_alloc(AVPicture *picture, enum AVPixelFormat pix_fmt, int width, int height);
5564 * @deprecated unused
5566 attribute_deprecated
5567 void avpicture_free(AVPicture *picture);
5570 * @deprecated use av_image_fill_arrays() instead.
5572 attribute_deprecated
5573 int avpicture_fill(AVPicture *picture, const uint8_t *ptr,
5574 enum AVPixelFormat pix_fmt, int width, int height);
5577 * @deprecated use av_image_copy_to_buffer() instead.
5579 attribute_deprecated
5580 int avpicture_layout(const AVPicture *src, enum AVPixelFormat pix_fmt,
5581 int width, int height,
5582 unsigned char *dest, int dest_size);
5585 * @deprecated use av_image_get_buffer_size() instead.
5587 attribute_deprecated
5588 int avpicture_get_size(enum AVPixelFormat pix_fmt, int width, int height);
5591 * @deprecated av_image_copy() instead.
5593 attribute_deprecated
5594 void av_picture_copy(AVPicture *dst, const AVPicture *src,
5595 enum AVPixelFormat pix_fmt, int width, int height);
5598 * @deprecated unused
5600 attribute_deprecated
5601 int av_picture_crop(AVPicture *dst, const AVPicture *src,
5602 enum AVPixelFormat pix_fmt, int top_band, int left_band);
5605 * @deprecated unused
5607 attribute_deprecated
5608 int av_picture_pad(AVPicture *dst, const AVPicture *src, int height, int width, enum AVPixelFormat pix_fmt,
5609 int padtop, int padbottom, int padleft, int padright, int *color);
5617 * @defgroup lavc_misc Utility functions
5620 * Miscellaneous utility functions related to both encoding and decoding
5626 * @defgroup lavc_misc_pixfmt Pixel formats
5628 * Functions for working with pixel formats.
5632 #if FF_API_GETCHROMA
5634 * @deprecated Use av_pix_fmt_get_chroma_sub_sample
5637 attribute_deprecated
5638 void avcodec_get_chroma_sub_sample(enum AVPixelFormat pix_fmt, int *h_shift, int *v_shift);
5642 * Return a value representing the fourCC code associated to the
5643 * pixel format pix_fmt, or 0 if no associated fourCC code can be
5646 unsigned int avcodec_pix_fmt_to_codec_tag(enum AVPixelFormat pix_fmt);
5649 * @deprecated see av_get_pix_fmt_loss()
5651 int avcodec_get_pix_fmt_loss(enum AVPixelFormat dst_pix_fmt, enum AVPixelFormat src_pix_fmt,
5655 * Find the best pixel format to convert to given a certain source pixel
5656 * format. When converting from one pixel format to another, information loss
5657 * may occur. For example, when converting from RGB24 to GRAY, the color
5658 * information will be lost. Similarly, other losses occur when converting from
5659 * some formats to other formats. avcodec_find_best_pix_fmt_of_2() searches which of
5660 * the given pixel formats should be used to suffer the least amount of loss.
5661 * The pixel formats from which it chooses one, are determined by the
5662 * pix_fmt_list parameter.
5665 * @param[in] pix_fmt_list AV_PIX_FMT_NONE terminated array of pixel formats to choose from
5666 * @param[in] src_pix_fmt source pixel format
5667 * @param[in] has_alpha Whether the source pixel format alpha channel is used.
5668 * @param[out] loss_ptr Combination of flags informing you what kind of losses will occur.
5669 * @return The best pixel format to convert to or -1 if none was found.
5671 enum AVPixelFormat avcodec_find_best_pix_fmt_of_list(const enum AVPixelFormat *pix_fmt_list,
5672 enum AVPixelFormat src_pix_fmt,
5673 int has_alpha, int *loss_ptr);
5676 * @deprecated see av_find_best_pix_fmt_of_2()
5678 enum AVPixelFormat avcodec_find_best_pix_fmt_of_2(enum AVPixelFormat dst_pix_fmt1, enum AVPixelFormat dst_pix_fmt2,
5679 enum AVPixelFormat src_pix_fmt, int has_alpha, int *loss_ptr);
5681 attribute_deprecated
5682 enum AVPixelFormat avcodec_find_best_pix_fmt2(enum AVPixelFormat dst_pix_fmt1, enum AVPixelFormat dst_pix_fmt2,
5683 enum AVPixelFormat src_pix_fmt, int has_alpha, int *loss_ptr);
5685 enum AVPixelFormat avcodec_default_get_format(struct AVCodecContext *s, const enum AVPixelFormat * fmt);
5691 #if FF_API_TAG_STRING
5693 * Put a string representing the codec tag codec_tag in buf.
5695 * @param buf buffer to place codec tag in
5696 * @param buf_size size in bytes of buf
5697 * @param codec_tag codec tag to assign
5698 * @return the length of the string that would have been generated if
5699 * enough space had been available, excluding the trailing null
5701 * @deprecated see av_fourcc_make_string() and av_fourcc2str().
5703 attribute_deprecated
5704 size_t av_get_codec_tag_string(char *buf, size_t buf_size, unsigned int codec_tag);
5707 void avcodec_string(char *buf, int buf_size, AVCodecContext *enc, int encode);
5710 * Return a name for the specified profile, if available.
5712 * @param codec the codec that is searched for the given profile
5713 * @param profile the profile value for which a name is requested
5714 * @return A name for the profile if found, NULL otherwise.
5716 const char *av_get_profile_name(const AVCodec *codec, int profile);
5719 * Return a name for the specified profile, if available.
5721 * @param codec_id the ID of the codec to which the requested profile belongs
5722 * @param profile the profile value for which a name is requested
5723 * @return A name for the profile if found, NULL otherwise.
5725 * @note unlike av_get_profile_name(), which searches a list of profiles
5726 * supported by a specific decoder or encoder implementation, this
5727 * function searches the list of profiles from the AVCodecDescriptor
5729 const char *avcodec_profile_name(enum AVCodecID codec_id, int profile);
5731 int avcodec_default_execute(AVCodecContext *c, int (*func)(AVCodecContext *c2, void *arg2),void *arg, int *ret, int count, int size);
5732 int avcodec_default_execute2(AVCodecContext *c, int (*func)(AVCodecContext *c2, void *arg2, int, int),void *arg, int *ret, int count);
5733 //FIXME func typedef
5736 * Fill AVFrame audio data and linesize pointers.
5738 * The buffer buf must be a preallocated buffer with a size big enough
5739 * to contain the specified samples amount. The filled AVFrame data
5740 * pointers will point to this buffer.
5742 * AVFrame extended_data channel pointers are allocated if necessary for
5745 * @param frame the AVFrame
5746 * frame->nb_samples must be set prior to calling the
5747 * function. This function fills in frame->data,
5748 * frame->extended_data, frame->linesize[0].
5749 * @param nb_channels channel count
5750 * @param sample_fmt sample format
5751 * @param buf buffer to use for frame data
5752 * @param buf_size size of buffer
5753 * @param align plane size sample alignment (0 = default)
5754 * @return >=0 on success, negative error code on failure
5755 * @todo return the size in bytes required to store the samples in
5756 * case of success, at the next libavutil bump
5758 int avcodec_fill_audio_frame(AVFrame *frame, int nb_channels,
5759 enum AVSampleFormat sample_fmt, const uint8_t *buf,
5760 int buf_size, int align);
5763 * Reset the internal decoder state / flush internal buffers. Should be called
5764 * e.g. when seeking or when switching to a different stream.
5766 * @note when refcounted frames are not used (i.e. avctx->refcounted_frames is 0),
5767 * this invalidates the frames previously returned from the decoder. When
5768 * refcounted frames are used, the decoder just releases any references it might
5769 * keep internally, but the caller's reference remains valid.
5771 void avcodec_flush_buffers(AVCodecContext *avctx);
5774 * Return codec bits per sample.
5776 * @param[in] codec_id the codec
5777 * @return Number of bits per sample or zero if unknown for the given codec.
5779 int av_get_bits_per_sample(enum AVCodecID codec_id);
5782 * Return the PCM codec associated with a sample format.
5783 * @param be endianness, 0 for little, 1 for big,
5784 * -1 (or anything else) for native
5785 * @return AV_CODEC_ID_PCM_* or AV_CODEC_ID_NONE
5787 enum AVCodecID av_get_pcm_codec(enum AVSampleFormat fmt, int be);
5790 * Return codec bits per sample.
5791 * Only return non-zero if the bits per sample is exactly correct, not an
5794 * @param[in] codec_id the codec
5795 * @return Number of bits per sample or zero if unknown for the given codec.
5797 int av_get_exact_bits_per_sample(enum AVCodecID codec_id);
5800 * Return audio frame duration.
5802 * @param avctx codec context
5803 * @param frame_bytes size of the frame, or 0 if unknown
5804 * @return frame duration, in samples, if known. 0 if not able to
5807 int av_get_audio_frame_duration(AVCodecContext *avctx, int frame_bytes);
5810 * This function is the same as av_get_audio_frame_duration(), except it works
5811 * with AVCodecParameters instead of an AVCodecContext.
5813 int av_get_audio_frame_duration2(AVCodecParameters *par, int frame_bytes);
5816 typedef struct AVBitStreamFilterContext {
5818 const struct AVBitStreamFilter *filter;
5819 AVCodecParserContext *parser;
5820 struct AVBitStreamFilterContext *next;
5822 * Internal default arguments, used if NULL is passed to av_bitstream_filter_filter().
5823 * Not for access by library users.
5826 } AVBitStreamFilterContext;
5829 typedef struct AVBSFInternal AVBSFInternal;
5832 * The bitstream filter state.
5834 * This struct must be allocated with av_bsf_alloc() and freed with
5837 * The fields in the struct will only be changed (by the caller or by the
5838 * filter) as described in their documentation, and are to be considered
5839 * immutable otherwise.
5841 typedef struct AVBSFContext {
5843 * A class for logging and AVOptions
5845 const AVClass *av_class;
5848 * The bitstream filter this context is an instance of.
5850 const struct AVBitStreamFilter *filter;
5853 * Opaque libavcodec internal data. Must not be touched by the caller in any
5856 AVBSFInternal *internal;
5859 * Opaque filter-specific private data. If filter->priv_class is non-NULL,
5860 * this is an AVOptions-enabled struct.
5865 * Parameters of the input stream. This field is allocated in
5866 * av_bsf_alloc(), it needs to be filled by the caller before
5869 AVCodecParameters *par_in;
5872 * Parameters of the output stream. This field is allocated in
5873 * av_bsf_alloc(), it is set by the filter in av_bsf_init().
5875 AVCodecParameters *par_out;
5878 * The timebase used for the timestamps of the input packets. Set by the
5879 * caller before av_bsf_init().
5881 AVRational time_base_in;
5884 * The timebase used for the timestamps of the output packets. Set by the
5885 * filter in av_bsf_init().
5887 AVRational time_base_out;
5890 typedef struct AVBitStreamFilter {
5894 * A list of codec ids supported by the filter, terminated by
5896 * May be NULL, in that case the bitstream filter works with any codec id.
5898 const enum AVCodecID *codec_ids;
5901 * A class for the private data, used to declare bitstream filter private
5902 * AVOptions. This field is NULL for bitstream filters that do not declare
5905 * If this field is non-NULL, the first member of the filter private data
5906 * must be a pointer to AVClass, which will be set by libavcodec generic
5907 * code to this class.
5909 const AVClass *priv_class;
5911 /*****************************************************************
5912 * No fields below this line are part of the public API. They
5913 * may not be used outside of libavcodec and can be changed and
5915 * New public fields should be added right above.
5916 *****************************************************************
5920 int (*init)(AVBSFContext *ctx);
5921 int (*filter)(AVBSFContext *ctx, AVPacket *pkt);
5922 void (*close)(AVBSFContext *ctx);
5923 void (*flush)(AVBSFContext *ctx);
5924 } AVBitStreamFilter;
5928 * @deprecated the old bitstream filtering API (using AVBitStreamFilterContext)
5929 * is deprecated. Use the new bitstream filtering API (using AVBSFContext).
5931 attribute_deprecated
5932 void av_register_bitstream_filter(AVBitStreamFilter *bsf);
5934 * @deprecated the old bitstream filtering API (using AVBitStreamFilterContext)
5935 * is deprecated. Use av_bsf_get_by_name(), av_bsf_alloc(), and av_bsf_init()
5936 * from the new bitstream filtering API (using AVBSFContext).
5938 attribute_deprecated
5939 AVBitStreamFilterContext *av_bitstream_filter_init(const char *name);
5941 * @deprecated the old bitstream filtering API (using AVBitStreamFilterContext)
5942 * is deprecated. Use av_bsf_send_packet() and av_bsf_receive_packet() from the
5943 * new bitstream filtering API (using AVBSFContext).
5945 attribute_deprecated
5946 int av_bitstream_filter_filter(AVBitStreamFilterContext *bsfc,
5947 AVCodecContext *avctx, const char *args,
5948 uint8_t **poutbuf, int *poutbuf_size,
5949 const uint8_t *buf, int buf_size, int keyframe);
5951 * @deprecated the old bitstream filtering API (using AVBitStreamFilterContext)
5952 * is deprecated. Use av_bsf_free() from the new bitstream filtering API (using
5955 attribute_deprecated
5956 void av_bitstream_filter_close(AVBitStreamFilterContext *bsf);
5958 * @deprecated the old bitstream filtering API (using AVBitStreamFilterContext)
5959 * is deprecated. Use av_bsf_iterate() from the new bitstream filtering API (using
5962 attribute_deprecated
5963 const AVBitStreamFilter *av_bitstream_filter_next(const AVBitStreamFilter *f);
5967 * @return a bitstream filter with the specified name or NULL if no such
5968 * bitstream filter exists.
5970 const AVBitStreamFilter *av_bsf_get_by_name(const char *name);
5973 * Iterate over all registered bitstream filters.
5975 * @param opaque a pointer where libavcodec will store the iteration state. Must
5976 * point to NULL to start the iteration.
5978 * @return the next registered bitstream filter or NULL when the iteration is
5981 const AVBitStreamFilter *av_bsf_iterate(void **opaque);
5983 attribute_deprecated
5984 const AVBitStreamFilter *av_bsf_next(void **opaque);
5988 * Allocate a context for a given bitstream filter. The caller must fill in the
5989 * context parameters as described in the documentation and then call
5990 * av_bsf_init() before sending any data to the filter.
5992 * @param filter the filter for which to allocate an instance.
5993 * @param ctx a pointer into which the pointer to the newly-allocated context
5994 * will be written. It must be freed with av_bsf_free() after the
5995 * filtering is done.
5997 * @return 0 on success, a negative AVERROR code on failure
5999 int av_bsf_alloc(const AVBitStreamFilter *filter, AVBSFContext **ctx);
6002 * Prepare the filter for use, after all the parameters and options have been
6005 int av_bsf_init(AVBSFContext *ctx);
6008 * Submit a packet for filtering.
6010 * After sending each packet, the filter must be completely drained by calling
6011 * av_bsf_receive_packet() repeatedly until it returns AVERROR(EAGAIN) or
6014 * @param pkt the packet to filter. The bitstream filter will take ownership of
6015 * the packet and reset the contents of pkt. pkt is not touched if an error occurs.
6016 * If pkt is empty (i.e. NULL, or pkt->data is NULL and pkt->side_data_elems zero),
6017 * it signals the end of the stream (i.e. no more non-empty packets will be sent;
6018 * sending more empty packets does nothing) and will cause the filter to output
6019 * any packets it may have buffered internally.
6021 * @return 0 on success, a negative AVERROR on error. This function never fails if
6024 int av_bsf_send_packet(AVBSFContext *ctx, AVPacket *pkt);
6027 * Retrieve a filtered packet.
6029 * @param[out] pkt this struct will be filled with the contents of the filtered
6030 * packet. It is owned by the caller and must be freed using
6031 * av_packet_unref() when it is no longer needed.
6032 * This parameter should be "clean" (i.e. freshly allocated
6033 * with av_packet_alloc() or unreffed with av_packet_unref())
6034 * when this function is called. If this function returns
6035 * successfully, the contents of pkt will be completely
6036 * overwritten by the returned data. On failure, pkt is not
6039 * @return 0 on success. AVERROR(EAGAIN) if more packets need to be sent to the
6040 * filter (using av_bsf_send_packet()) to get more output. AVERROR_EOF if there
6041 * will be no further output from the filter. Another negative AVERROR value if
6044 * @note one input packet may result in several output packets, so after sending
6045 * a packet with av_bsf_send_packet(), this function needs to be called
6046 * repeatedly until it stops returning 0. It is also possible for a filter to
6047 * output fewer packets than were sent to it, so this function may return
6048 * AVERROR(EAGAIN) immediately after a successful av_bsf_send_packet() call.
6050 int av_bsf_receive_packet(AVBSFContext *ctx, AVPacket *pkt);
6053 * Reset the internal bitstream filter state / flush internal buffers.
6055 void av_bsf_flush(AVBSFContext *ctx);
6058 * Free a bitstream filter context and everything associated with it; write NULL
6059 * into the supplied pointer.
6061 void av_bsf_free(AVBSFContext **ctx);
6064 * Get the AVClass for AVBSFContext. It can be used in combination with
6065 * AV_OPT_SEARCH_FAKE_OBJ for examining options.
6067 * @see av_opt_find().
6069 const AVClass *av_bsf_get_class(void);
6072 * Structure for chain/list of bitstream filters.
6073 * Empty list can be allocated by av_bsf_list_alloc().
6075 typedef struct AVBSFList AVBSFList;
6078 * Allocate empty list of bitstream filters.
6079 * The list must be later freed by av_bsf_list_free()
6080 * or finalized by av_bsf_list_finalize().
6082 * @return Pointer to @ref AVBSFList on success, NULL in case of failure
6084 AVBSFList *av_bsf_list_alloc(void);
6087 * Free list of bitstream filters.
6089 * @param lst Pointer to pointer returned by av_bsf_list_alloc()
6091 void av_bsf_list_free(AVBSFList **lst);
6094 * Append bitstream filter to the list of bitstream filters.
6096 * @param lst List to append to
6097 * @param bsf Filter context to be appended
6099 * @return >=0 on success, negative AVERROR in case of failure
6101 int av_bsf_list_append(AVBSFList *lst, AVBSFContext *bsf);
6104 * Construct new bitstream filter context given it's name and options
6105 * and append it to the list of bitstream filters.
6107 * @param lst List to append to
6108 * @param bsf_name Name of the bitstream filter
6109 * @param options Options for the bitstream filter, can be set to NULL
6111 * @return >=0 on success, negative AVERROR in case of failure
6113 int av_bsf_list_append2(AVBSFList *lst, const char * bsf_name, AVDictionary **options);
6115 * Finalize list of bitstream filters.
6117 * This function will transform @ref AVBSFList to single @ref AVBSFContext,
6118 * so the whole chain of bitstream filters can be treated as single filter
6119 * freshly allocated by av_bsf_alloc().
6120 * If the call is successful, @ref AVBSFList structure is freed and lst
6121 * will be set to NULL. In case of failure, caller is responsible for
6122 * freeing the structure by av_bsf_list_free()
6124 * @param lst Filter list structure to be transformed
6125 * @param[out] bsf Pointer to be set to newly created @ref AVBSFContext structure
6126 * representing the chain of bitstream filters
6128 * @return >=0 on success, negative AVERROR in case of failure
6130 int av_bsf_list_finalize(AVBSFList **lst, AVBSFContext **bsf);
6133 * Parse string describing list of bitstream filters and create single
6134 * @ref AVBSFContext describing the whole chain of bitstream filters.
6135 * Resulting @ref AVBSFContext can be treated as any other @ref AVBSFContext freshly
6136 * allocated by av_bsf_alloc().
6138 * @param str String describing chain of bitstream filters in format
6139 * `bsf1[=opt1=val1:opt2=val2][,bsf2]`
6140 * @param[out] bsf Pointer to be set to newly created @ref AVBSFContext structure
6141 * representing the chain of bitstream filters
6143 * @return >=0 on success, negative AVERROR in case of failure
6145 int av_bsf_list_parse_str(const char *str, AVBSFContext **bsf);
6148 * Get null/pass-through bitstream filter.
6150 * @param[out] bsf Pointer to be set to new instance of pass-through bitstream filter
6154 int av_bsf_get_null_filter(AVBSFContext **bsf);
6159 * Same behaviour av_fast_malloc but the buffer has additional
6160 * AV_INPUT_BUFFER_PADDING_SIZE at the end which will always be 0.
6162 * In addition the whole buffer will initially and after resizes
6163 * be 0-initialized so that no uninitialized data will ever appear.
6165 void av_fast_padded_malloc(void *ptr, unsigned int *size, size_t min_size);
6168 * Same behaviour av_fast_padded_malloc except that buffer will always
6169 * be 0-initialized after call.
6171 void av_fast_padded_mallocz(void *ptr, unsigned int *size, size_t min_size);
6174 * Encode extradata length to a buffer. Used by xiph codecs.
6176 * @param s buffer to write to; must be at least (v/255+1) bytes long
6177 * @param v size of extradata in bytes
6178 * @return number of bytes written to the buffer.
6180 unsigned int av_xiphlacing(unsigned char *s, unsigned int v);
6182 #if FF_API_USER_VISIBLE_AVHWACCEL
6184 * Register the hardware accelerator hwaccel.
6186 * @deprecated This function doesn't do anything.
6188 attribute_deprecated
6189 void av_register_hwaccel(AVHWAccel *hwaccel);
6192 * If hwaccel is NULL, returns the first registered hardware accelerator,
6193 * if hwaccel is non-NULL, returns the next registered hardware accelerator
6194 * after hwaccel, or NULL if hwaccel is the last one.
6196 * @deprecated AVHWaccel structures contain no user-serviceable parts, so
6197 * this function should not be used.
6199 attribute_deprecated
6200 AVHWAccel *av_hwaccel_next(const AVHWAccel *hwaccel);
6205 * Lock operation used by lockmgr
6207 * @deprecated Deprecated together with av_lockmgr_register().
6210 AV_LOCK_CREATE, ///< Create a mutex
6211 AV_LOCK_OBTAIN, ///< Lock the mutex
6212 AV_LOCK_RELEASE, ///< Unlock the mutex
6213 AV_LOCK_DESTROY, ///< Free mutex resources
6217 * Register a user provided lock manager supporting the operations
6218 * specified by AVLockOp. The "mutex" argument to the function points
6219 * to a (void *) where the lockmgr should store/get a pointer to a user
6220 * allocated mutex. It is NULL upon AV_LOCK_CREATE and equal to the
6221 * value left by the last call for all other ops. If the lock manager is
6222 * unable to perform the op then it should leave the mutex in the same
6223 * state as when it was called and return a non-zero value. However,
6224 * when called with AV_LOCK_DESTROY the mutex will always be assumed to
6225 * have been successfully destroyed. If av_lockmgr_register succeeds
6226 * it will return a non-negative value, if it fails it will return a
6227 * negative value and destroy all mutex and unregister all callbacks.
6228 * av_lockmgr_register is not thread-safe, it must be called from a
6229 * single thread before any calls which make use of locking are used.
6231 * @param cb User defined callback. av_lockmgr_register invokes calls
6232 * to this callback and the previously registered callback.
6233 * The callback will be used to create more than one mutex
6234 * each of which must be backed by its own underlying locking
6235 * mechanism (i.e. do not use a single static object to
6236 * implement your lock manager). If cb is set to NULL the
6237 * lockmgr will be unregistered.
6239 * @deprecated This function does nothing, and always returns 0. Be sure to
6240 * build with thread support to get basic thread safety.
6242 attribute_deprecated
6243 int av_lockmgr_register(int (*cb)(void **mutex, enum AVLockOp op));
6247 * Get the type of the given codec.
6249 enum AVMediaType avcodec_get_type(enum AVCodecID codec_id);
6252 * Get the name of a codec.
6253 * @return a static string identifying the codec; never NULL
6255 const char *avcodec_get_name(enum AVCodecID id);
6258 * @return a positive value if s is open (i.e. avcodec_open2() was called on it
6259 * with no corresponding avcodec_close()), 0 otherwise.
6261 int avcodec_is_open(AVCodecContext *s);
6264 * @return a non-zero number if codec is an encoder, zero otherwise
6266 int av_codec_is_encoder(const AVCodec *codec);
6269 * @return a non-zero number if codec is a decoder, zero otherwise
6271 int av_codec_is_decoder(const AVCodec *codec);
6274 * @return descriptor for given codec ID or NULL if no descriptor exists.
6276 const AVCodecDescriptor *avcodec_descriptor_get(enum AVCodecID id);
6279 * Iterate over all codec descriptors known to libavcodec.
6281 * @param prev previous descriptor. NULL to get the first descriptor.
6283 * @return next descriptor or NULL after the last descriptor
6285 const AVCodecDescriptor *avcodec_descriptor_next(const AVCodecDescriptor *prev);
6288 * @return codec descriptor with the given name or NULL if no such descriptor
6291 const AVCodecDescriptor *avcodec_descriptor_get_by_name(const char *name);
6294 * Allocate a CPB properties structure and initialize its fields to default
6297 * @param size if non-NULL, the size of the allocated struct will be written
6298 * here. This is useful for embedding it in side data.
6300 * @return the newly allocated struct or NULL on failure
6302 AVCPBProperties *av_cpb_properties_alloc(size_t *size);
6308 #endif /* AVCODEC_AVCODEC_H */