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,
673 /* subtitle codecs */
674 AV_CODEC_ID_FIRST_SUBTITLE = 0x17000, ///< A dummy ID pointing at the start of subtitle codecs.
675 AV_CODEC_ID_DVD_SUBTITLE = 0x17000,
676 AV_CODEC_ID_DVB_SUBTITLE,
677 AV_CODEC_ID_TEXT, ///< raw UTF-8 text
680 AV_CODEC_ID_MOV_TEXT,
681 AV_CODEC_ID_HDMV_PGS_SUBTITLE,
682 AV_CODEC_ID_DVB_TELETEXT,
685 AV_CODEC_ID_MICRODVD = 0x17800,
689 AV_CODEC_ID_REALTEXT,
691 AV_CODEC_ID_SUBVIEWER1,
692 AV_CODEC_ID_SUBVIEWER,
699 AV_CODEC_ID_HDMV_TEXT_SUBTITLE,
701 AV_CODEC_ID_ARIB_CAPTION,
703 /* other specific kind of codecs (generally used for attachments) */
704 AV_CODEC_ID_FIRST_UNKNOWN = 0x18000, ///< A dummy ID pointing at the start of various fake codecs.
705 AV_CODEC_ID_TTF = 0x18000,
707 AV_CODEC_ID_SCTE_35, ///< Contain timestamp estimated through PCR of program stream.
709 AV_CODEC_ID_BINTEXT = 0x18800,
713 AV_CODEC_ID_SMPTE_KLV,
715 AV_CODEC_ID_TIMED_ID3,
716 AV_CODEC_ID_BIN_DATA,
719 AV_CODEC_ID_PROBE = 0x19000, ///< codec_id is not known (like AV_CODEC_ID_NONE) but lavf should attempt to identify it
721 AV_CODEC_ID_MPEG2TS = 0x20000, /**< _FAKE_ codec to indicate a raw MPEG-2 TS
722 * stream (only used by libavformat) */
723 AV_CODEC_ID_MPEG4SYSTEMS = 0x20001, /**< _FAKE_ codec to indicate a MPEG-4 Systems
724 * stream (only used by libavformat) */
725 AV_CODEC_ID_FFMETADATA = 0x21000, ///< Dummy codec for streams containing only metadata information.
726 AV_CODEC_ID_WRAPPED_AVFRAME = 0x21001, ///< Passthrough codec, AVFrames wrapped in AVPacket
730 * This struct describes the properties of a single codec described by an
732 * @see avcodec_descriptor_get()
734 typedef struct AVCodecDescriptor {
736 enum AVMediaType type;
738 * Name of the codec described by this descriptor. It is non-empty and
739 * unique for each codec descriptor. It should contain alphanumeric
740 * characters and '_' only.
744 * A more descriptive name for this codec. May be NULL.
746 const char *long_name;
748 * Codec properties, a combination of AV_CODEC_PROP_* flags.
752 * MIME type(s) associated with the codec.
753 * May be NULL; if not, a NULL-terminated array of MIME types.
754 * The first item is always non-NULL and is the preferred MIME type.
756 const char *const *mime_types;
758 * If non-NULL, an array of profiles recognized for this codec.
759 * Terminated with FF_PROFILE_UNKNOWN.
761 const struct AVProfile *profiles;
765 * Codec uses only intra compression.
766 * Video and audio codecs only.
768 #define AV_CODEC_PROP_INTRA_ONLY (1 << 0)
770 * Codec supports lossy compression. Audio and video codecs only.
771 * @note a codec may support both lossy and lossless
774 #define AV_CODEC_PROP_LOSSY (1 << 1)
776 * Codec supports lossless compression. Audio and video codecs only.
778 #define AV_CODEC_PROP_LOSSLESS (1 << 2)
780 * Codec supports frame reordering. That is, the coded order (the order in which
781 * the encoded packets are output by the encoders / stored / input to the
782 * decoders) may be different from the presentation order of the corresponding
785 * For codecs that do not have this property set, PTS and DTS should always be
788 #define AV_CODEC_PROP_REORDER (1 << 3)
790 * Subtitle codec is bitmap based
791 * Decoded AVSubtitle data can be read from the AVSubtitleRect->pict field.
793 #define AV_CODEC_PROP_BITMAP_SUB (1 << 16)
795 * Subtitle codec is text based.
796 * Decoded AVSubtitle data can be read from the AVSubtitleRect->ass field.
798 #define AV_CODEC_PROP_TEXT_SUB (1 << 17)
801 * @ingroup lavc_decoding
802 * Required number of additionally allocated bytes at the end of the input bitstream for decoding.
803 * This is mainly needed because some optimized bitstream readers read
804 * 32 or 64 bit at once and could read over the end.<br>
805 * Note: If the first 23 bits of the additional bytes are not 0, then damaged
806 * MPEG bitstreams could cause overread and segfault.
808 #define AV_INPUT_BUFFER_PADDING_SIZE 64
811 * @ingroup lavc_encoding
812 * minimum encoding buffer size
813 * Used to avoid some checks during header writing.
815 #define AV_INPUT_BUFFER_MIN_SIZE 16384
818 * @ingroup lavc_decoding
821 /* We leave some space between them for extensions (drop some
822 * keyframes for intra-only or drop just some bidir frames). */
823 AVDISCARD_NONE =-16, ///< discard nothing
824 AVDISCARD_DEFAULT = 0, ///< discard useless packets like 0 size packets in avi
825 AVDISCARD_NONREF = 8, ///< discard all non reference
826 AVDISCARD_BIDIR = 16, ///< discard all bidirectional frames
827 AVDISCARD_NONINTRA= 24, ///< discard all non intra frames
828 AVDISCARD_NONKEY = 32, ///< discard all frames except keyframes
829 AVDISCARD_ALL = 48, ///< discard all
832 enum AVAudioServiceType {
833 AV_AUDIO_SERVICE_TYPE_MAIN = 0,
834 AV_AUDIO_SERVICE_TYPE_EFFECTS = 1,
835 AV_AUDIO_SERVICE_TYPE_VISUALLY_IMPAIRED = 2,
836 AV_AUDIO_SERVICE_TYPE_HEARING_IMPAIRED = 3,
837 AV_AUDIO_SERVICE_TYPE_DIALOGUE = 4,
838 AV_AUDIO_SERVICE_TYPE_COMMENTARY = 5,
839 AV_AUDIO_SERVICE_TYPE_EMERGENCY = 6,
840 AV_AUDIO_SERVICE_TYPE_VOICE_OVER = 7,
841 AV_AUDIO_SERVICE_TYPE_KARAOKE = 8,
842 AV_AUDIO_SERVICE_TYPE_NB , ///< Not part of ABI
846 * @ingroup lavc_encoding
848 typedef struct RcOverride{
851 int qscale; // If this is 0 then quality_factor will be used instead.
852 float quality_factor;
856 These flags can be passed in AVCodecContext.flags before initialization.
857 Note: Not everything is supported yet.
861 * Allow decoders to produce frames with data planes that are not aligned
862 * to CPU requirements (e.g. due to cropping).
864 #define AV_CODEC_FLAG_UNALIGNED (1 << 0)
868 #define AV_CODEC_FLAG_QSCALE (1 << 1)
870 * 4 MV per MB allowed / advanced prediction for H.263.
872 #define AV_CODEC_FLAG_4MV (1 << 2)
874 * Output even those frames that might be corrupted.
876 #define AV_CODEC_FLAG_OUTPUT_CORRUPT (1 << 3)
880 #define AV_CODEC_FLAG_QPEL (1 << 4)
882 * Don't output frames whose parameters differ from first
883 * decoded frame in stream.
885 #define AV_CODEC_FLAG_DROPCHANGED (1 << 5)
887 * Use internal 2pass ratecontrol in first pass mode.
889 #define AV_CODEC_FLAG_PASS1 (1 << 9)
891 * Use internal 2pass ratecontrol in second pass mode.
893 #define AV_CODEC_FLAG_PASS2 (1 << 10)
897 #define AV_CODEC_FLAG_LOOP_FILTER (1 << 11)
899 * Only decode/encode grayscale.
901 #define AV_CODEC_FLAG_GRAY (1 << 13)
903 * error[?] variables will be set during encoding.
905 #define AV_CODEC_FLAG_PSNR (1 << 15)
907 * Input bitstream might be truncated at a random location
908 * instead of only at frame boundaries.
910 #define AV_CODEC_FLAG_TRUNCATED (1 << 16)
912 * Use interlaced DCT.
914 #define AV_CODEC_FLAG_INTERLACED_DCT (1 << 18)
918 #define AV_CODEC_FLAG_LOW_DELAY (1 << 19)
920 * Place global headers in extradata instead of every keyframe.
922 #define AV_CODEC_FLAG_GLOBAL_HEADER (1 << 22)
924 * Use only bitexact stuff (except (I)DCT).
926 #define AV_CODEC_FLAG_BITEXACT (1 << 23)
927 /* Fx : Flag for H.263+ extra options */
929 * H.263 advanced intra coding / MPEG-4 AC prediction
931 #define AV_CODEC_FLAG_AC_PRED (1 << 24)
933 * interlaced motion estimation
935 #define AV_CODEC_FLAG_INTERLACED_ME (1 << 29)
936 #define AV_CODEC_FLAG_CLOSED_GOP (1U << 31)
939 * Allow non spec compliant speedup tricks.
941 #define AV_CODEC_FLAG2_FAST (1 << 0)
943 * Skip bitstream encoding.
945 #define AV_CODEC_FLAG2_NO_OUTPUT (1 << 2)
947 * Place global headers at every keyframe instead of in extradata.
949 #define AV_CODEC_FLAG2_LOCAL_HEADER (1 << 3)
952 * timecode is in drop frame format. DEPRECATED!!!!
954 #define AV_CODEC_FLAG2_DROP_FRAME_TIMECODE (1 << 13)
957 * Input bitstream might be truncated at a packet boundaries
958 * instead of only at frame boundaries.
960 #define AV_CODEC_FLAG2_CHUNKS (1 << 15)
962 * Discard cropping information from SPS.
964 #define AV_CODEC_FLAG2_IGNORE_CROP (1 << 16)
967 * Show all frames before the first keyframe
969 #define AV_CODEC_FLAG2_SHOW_ALL (1 << 22)
971 * Export motion vectors through frame side data
973 #define AV_CODEC_FLAG2_EXPORT_MVS (1 << 28)
975 * Do not skip samples and export skip information as frame side data
977 #define AV_CODEC_FLAG2_SKIP_MANUAL (1 << 29)
979 * Do not reset ASS ReadOrder field on flush (subtitles decoding)
981 #define AV_CODEC_FLAG2_RO_FLUSH_NOOP (1 << 30)
983 /* Unsupported options :
984 * Syntax Arithmetic coding (SAC)
985 * Reference Picture Selection
986 * Independent Segment Decoding */
988 /* codec capabilities */
991 * Decoder can use draw_horiz_band callback.
993 #define AV_CODEC_CAP_DRAW_HORIZ_BAND (1 << 0)
995 * Codec uses get_buffer() for allocating buffers and supports custom allocators.
996 * If not set, it might not use get_buffer() at all or use operations that
997 * assume the buffer was allocated by avcodec_default_get_buffer.
999 #define AV_CODEC_CAP_DR1 (1 << 1)
1000 #define AV_CODEC_CAP_TRUNCATED (1 << 3)
1002 * Encoder or decoder requires flushing with NULL input at the end in order to
1003 * give the complete and correct output.
1005 * NOTE: If this flag is not set, the codec is guaranteed to never be fed with
1006 * with NULL data. The user can still send NULL data to the public encode
1007 * or decode function, but libavcodec will not pass it along to the codec
1008 * unless this flag is set.
1011 * The decoder has a non-zero delay and needs to be fed with avpkt->data=NULL,
1012 * avpkt->size=0 at the end to get the delayed data until the decoder no longer
1016 * The encoder needs to be fed with NULL data at the end of encoding until the
1017 * encoder no longer returns data.
1019 * NOTE: For encoders implementing the AVCodec.encode2() function, setting this
1020 * flag also means that the encoder must set the pts and duration for
1021 * each output packet. If this flag is not set, the pts and duration will
1022 * be determined by libavcodec from the input frame.
1024 #define AV_CODEC_CAP_DELAY (1 << 5)
1026 * Codec can be fed a final frame with a smaller size.
1027 * This can be used to prevent truncation of the last audio samples.
1029 #define AV_CODEC_CAP_SMALL_LAST_FRAME (1 << 6)
1032 * Codec can output multiple frames per AVPacket
1033 * Normally demuxers return one frame at a time, demuxers which do not do
1034 * are connected to a parser to split what they return into proper frames.
1035 * This flag is reserved to the very rare category of codecs which have a
1036 * bitstream that cannot be split into frames without timeconsuming
1037 * operations like full decoding. Demuxers carrying such bitstreams thus
1038 * may return multiple frames in a packet. This has many disadvantages like
1039 * prohibiting stream copy in many cases thus it should only be considered
1042 #define AV_CODEC_CAP_SUBFRAMES (1 << 8)
1044 * Codec is experimental and is thus avoided in favor of non experimental
1047 #define AV_CODEC_CAP_EXPERIMENTAL (1 << 9)
1049 * Codec should fill in channel configuration and samplerate instead of container
1051 #define AV_CODEC_CAP_CHANNEL_CONF (1 << 10)
1053 * Codec supports frame-level multithreading.
1055 #define AV_CODEC_CAP_FRAME_THREADS (1 << 12)
1057 * Codec supports slice-based (or partition-based) multithreading.
1059 #define AV_CODEC_CAP_SLICE_THREADS (1 << 13)
1061 * Codec supports changed parameters at any point.
1063 #define AV_CODEC_CAP_PARAM_CHANGE (1 << 14)
1065 * Codec supports avctx->thread_count == 0 (auto).
1067 #define AV_CODEC_CAP_AUTO_THREADS (1 << 15)
1069 * Audio encoder supports receiving a different number of samples in each call.
1071 #define AV_CODEC_CAP_VARIABLE_FRAME_SIZE (1 << 16)
1073 * Decoder is not a preferred choice for probing.
1074 * This indicates that the decoder is not a good choice for probing.
1075 * It could for example be an expensive to spin up hardware decoder,
1076 * or it could simply not provide a lot of useful information about
1078 * A decoder marked with this flag should only be used as last resort
1079 * choice for probing.
1081 #define AV_CODEC_CAP_AVOID_PROBING (1 << 17)
1083 * Codec is intra only.
1085 #define AV_CODEC_CAP_INTRA_ONLY 0x40000000
1087 * Codec is lossless.
1089 #define AV_CODEC_CAP_LOSSLESS 0x80000000
1092 * Codec is backed by a hardware implementation. Typically used to
1093 * identify a non-hwaccel hardware decoder. For information about hwaccels, use
1094 * avcodec_get_hw_config() instead.
1096 #define AV_CODEC_CAP_HARDWARE (1 << 18)
1099 * Codec is potentially backed by a hardware implementation, but not
1100 * necessarily. This is used instead of AV_CODEC_CAP_HARDWARE, if the
1101 * implementation provides some sort of internal fallback.
1103 #define AV_CODEC_CAP_HYBRID (1 << 19)
1106 * This codec takes the reordered_opaque field from input AVFrames
1107 * and returns it in the corresponding field in AVCodecContext after
1110 #define AV_CODEC_CAP_ENCODER_REORDERED_OPAQUE (1 << 20)
1112 /* Exported side data.
1113 These flags can be passed in AVCodecContext.export_side_data before initialization.
1116 * Export motion vectors through frame side data
1118 #define AV_CODEC_EXPORT_DATA_MVS (1 << 0)
1120 * Export encoder Producer Reference Time through packet side data
1122 #define AV_CODEC_EXPORT_DATA_PRFT (1 << 1)
1126 * This specifies the area which should be displayed.
1127 * Note there may be multiple such areas for one frame.
1129 typedef struct AVPanScan {
1132 * - encoding: Set by user.
1133 * - decoding: Set by libavcodec.
1138 * width and height in 1/16 pel
1139 * - encoding: Set by user.
1140 * - decoding: Set by libavcodec.
1146 * position of the top left corner in 1/16 pel for up to 3 fields/frames
1147 * - encoding: Set by user.
1148 * - decoding: Set by libavcodec.
1150 int16_t position[3][2];
1154 * This structure describes the bitrate properties of an encoded bitstream. It
1155 * roughly corresponds to a subset the VBV parameters for MPEG-2 or HRD
1156 * parameters for H.264/HEVC.
1158 typedef struct AVCPBProperties {
1160 * Maximum bitrate of the stream, in bits per second.
1161 * Zero if unknown or unspecified.
1163 #if FF_API_UNSANITIZED_BITRATES
1166 int64_t max_bitrate;
1169 * Minimum bitrate of the stream, in bits per second.
1170 * Zero if unknown or unspecified.
1172 #if FF_API_UNSANITIZED_BITRATES
1175 int64_t min_bitrate;
1178 * Average bitrate of the stream, in bits per second.
1179 * Zero if unknown or unspecified.
1181 #if FF_API_UNSANITIZED_BITRATES
1184 int64_t avg_bitrate;
1188 * The size of the buffer to which the ratecontrol is applied, in bits.
1189 * Zero if unknown or unspecified.
1194 * The delay between the time the packet this structure is associated with
1195 * is received and the time when it should be decoded, in periods of a 27MHz
1198 * UINT64_MAX when unknown or unspecified.
1204 * This structure supplies correlation between a packet timestamp and a wall clock
1205 * production time. The definition follows the Producer Reference Time ('prft')
1206 * as defined in ISO/IEC 14496-12
1208 typedef struct AVProducerReferenceTime {
1210 * A UTC timestamp, in microseconds, since Unix epoch (e.g, av_gettime()).
1214 } AVProducerReferenceTime;
1217 * The decoder will keep a reference to the frame and may reuse it later.
1219 #define AV_GET_BUFFER_FLAG_REF (1 << 0)
1222 * @defgroup lavc_packet AVPacket
1224 * Types and functions for working with AVPacket.
1227 enum AVPacketSideDataType {
1229 * An AV_PKT_DATA_PALETTE side data packet contains exactly AVPALETTE_SIZE
1230 * bytes worth of palette. This side data signals that a new palette is
1233 AV_PKT_DATA_PALETTE,
1236 * The AV_PKT_DATA_NEW_EXTRADATA is used to notify the codec or the format
1237 * that the extradata buffer was changed and the receiving side should
1238 * act upon it appropriately. The new extradata is embedded in the side
1239 * data buffer and should be immediately used for processing the current
1242 AV_PKT_DATA_NEW_EXTRADATA,
1245 * An AV_PKT_DATA_PARAM_CHANGE side data packet is laid out as follows:
1248 * if (param_flags & AV_SIDE_DATA_PARAM_CHANGE_CHANNEL_COUNT)
1249 * s32le channel_count
1250 * if (param_flags & AV_SIDE_DATA_PARAM_CHANGE_CHANNEL_LAYOUT)
1251 * u64le channel_layout
1252 * if (param_flags & AV_SIDE_DATA_PARAM_CHANGE_SAMPLE_RATE)
1254 * if (param_flags & AV_SIDE_DATA_PARAM_CHANGE_DIMENSIONS)
1259 AV_PKT_DATA_PARAM_CHANGE,
1262 * An AV_PKT_DATA_H263_MB_INFO side data packet contains a number of
1263 * structures with info about macroblocks relevant to splitting the
1264 * packet into smaller packets on macroblock edges (e.g. as for RFC 2190).
1265 * That is, it does not necessarily contain info about all macroblocks,
1266 * as long as the distance between macroblocks in the info is smaller
1267 * than the target payload size.
1268 * Each MB info structure is 12 bytes, and is laid out as follows:
1270 * u32le bit offset from the start of the packet
1271 * u8 current quantizer at the start of the macroblock
1273 * u16le macroblock address within the GOB
1274 * u8 horizontal MV predictor
1275 * u8 vertical MV predictor
1276 * u8 horizontal MV predictor for block number 3
1277 * u8 vertical MV predictor for block number 3
1280 AV_PKT_DATA_H263_MB_INFO,
1283 * This side data should be associated with an audio stream and contains
1284 * ReplayGain information in form of the AVReplayGain struct.
1286 AV_PKT_DATA_REPLAYGAIN,
1289 * This side data contains a 3x3 transformation matrix describing an affine
1290 * transformation that needs to be applied to the decoded video frames for
1291 * correct presentation.
1293 * See libavutil/display.h for a detailed description of the data.
1295 AV_PKT_DATA_DISPLAYMATRIX,
1298 * This side data should be associated with a video stream and contains
1299 * Stereoscopic 3D information in form of the AVStereo3D struct.
1301 AV_PKT_DATA_STEREO3D,
1304 * This side data should be associated with an audio stream and corresponds
1305 * to enum AVAudioServiceType.
1307 AV_PKT_DATA_AUDIO_SERVICE_TYPE,
1310 * This side data contains quality related information from the encoder.
1312 * u32le quality factor of the compressed frame. Allowed range is between 1 (good) and FF_LAMBDA_MAX (bad).
1316 * u64le[error count] sum of squared differences between encoder in and output
1319 AV_PKT_DATA_QUALITY_STATS,
1322 * This side data contains an integer value representing the stream index
1323 * of a "fallback" track. A fallback track indicates an alternate
1324 * track to use when the current track can not be decoded for some reason.
1325 * e.g. no decoder available for codec.
1327 AV_PKT_DATA_FALLBACK_TRACK,
1330 * This side data corresponds to the AVCPBProperties struct.
1332 AV_PKT_DATA_CPB_PROPERTIES,
1335 * Recommmends skipping the specified number of samples
1337 * u32le number of samples to skip from start of this packet
1338 * u32le number of samples to skip from end of this packet
1339 * u8 reason for start skip
1340 * u8 reason for end skip (0=padding silence, 1=convergence)
1343 AV_PKT_DATA_SKIP_SAMPLES,
1346 * An AV_PKT_DATA_JP_DUALMONO side data packet indicates that
1347 * the packet may contain "dual mono" audio specific to Japanese DTV
1348 * and if it is true, recommends only the selected channel to be used.
1350 * u8 selected channels (0=mail/left, 1=sub/right, 2=both)
1353 AV_PKT_DATA_JP_DUALMONO,
1356 * A list of zero terminated key/value strings. There is no end marker for
1357 * the list, so it is required to rely on the side data size to stop.
1359 AV_PKT_DATA_STRINGS_METADATA,
1362 * Subtitle event position
1370 AV_PKT_DATA_SUBTITLE_POSITION,
1373 * Data found in BlockAdditional element of matroska container. There is
1374 * no end marker for the data, so it is required to rely on the side data
1375 * size to recognize the end. 8 byte id (as found in BlockAddId) followed
1378 AV_PKT_DATA_MATROSKA_BLOCKADDITIONAL,
1381 * The optional first identifier line of a WebVTT cue.
1383 AV_PKT_DATA_WEBVTT_IDENTIFIER,
1386 * The optional settings (rendering instructions) that immediately
1387 * follow the timestamp specifier of a WebVTT cue.
1389 AV_PKT_DATA_WEBVTT_SETTINGS,
1392 * A list of zero terminated key/value strings. There is no end marker for
1393 * the list, so it is required to rely on the side data size to stop. This
1394 * side data includes updated metadata which appeared in the stream.
1396 AV_PKT_DATA_METADATA_UPDATE,
1399 * MPEGTS stream ID as uint8_t, this is required to pass the stream ID
1400 * information from the demuxer to the corresponding muxer.
1402 AV_PKT_DATA_MPEGTS_STREAM_ID,
1405 * Mastering display metadata (based on SMPTE-2086:2014). This metadata
1406 * should be associated with a video stream and contains data in the form
1407 * of the AVMasteringDisplayMetadata struct.
1409 AV_PKT_DATA_MASTERING_DISPLAY_METADATA,
1412 * This side data should be associated with a video stream and corresponds
1413 * to the AVSphericalMapping structure.
1415 AV_PKT_DATA_SPHERICAL,
1418 * Content light level (based on CTA-861.3). This metadata should be
1419 * associated with a video stream and contains data in the form of the
1420 * AVContentLightMetadata struct.
1422 AV_PKT_DATA_CONTENT_LIGHT_LEVEL,
1425 * ATSC A53 Part 4 Closed Captions. This metadata should be associated with
1426 * a video stream. A53 CC bitstream is stored as uint8_t in AVPacketSideData.data.
1427 * The number of bytes of CC data is AVPacketSideData.size.
1432 * This side data is encryption initialization data.
1433 * The format is not part of ABI, use av_encryption_init_info_* methods to
1436 AV_PKT_DATA_ENCRYPTION_INIT_INFO,
1439 * This side data contains encryption info for how to decrypt the packet.
1440 * The format is not part of ABI, use av_encryption_info_* methods to access.
1442 AV_PKT_DATA_ENCRYPTION_INFO,
1445 * Active Format Description data consisting of a single byte as specified
1446 * in ETSI TS 101 154 using AVActiveFormatDescription enum.
1451 * Producer Reference Time data corresponding to the AVProducerReferenceTime struct,
1452 * usually exported by some encoders (on demand through the prft flag set in the
1453 * AVCodecContext export_side_data field).
1458 * ICC profile data consisting of an opaque octet buffer following the
1459 * format described by ISO 15076-1.
1461 AV_PKT_DATA_ICC_PROFILE,
1464 * The number of side data types.
1465 * This is not part of the public API/ABI in the sense that it may
1466 * change when new side data types are added.
1467 * This must stay the last enum value.
1468 * If its value becomes huge, some code using it
1469 * needs to be updated as it assumes it to be smaller than other limits.
1474 #define AV_PKT_DATA_QUALITY_FACTOR AV_PKT_DATA_QUALITY_STATS //DEPRECATED
1476 typedef struct AVPacketSideData {
1479 enum AVPacketSideDataType type;
1483 * This structure stores compressed data. It is typically exported by demuxers
1484 * and then passed as input to decoders, or received as output from encoders and
1485 * then passed to muxers.
1487 * For video, it should typically contain one compressed frame. For audio it may
1488 * contain several compressed frames. Encoders are allowed to output empty
1489 * packets, with no compressed data, containing only side data
1490 * (e.g. to update some stream parameters at the end of encoding).
1492 * AVPacket is one of the few structs in FFmpeg, whose size is a part of public
1493 * ABI. Thus it may be allocated on stack and no new fields can be added to it
1494 * without libavcodec and libavformat major bump.
1496 * The semantics of data ownership depends on the buf field.
1497 * If it is set, the packet data is dynamically allocated and is
1498 * valid indefinitely until a call to av_packet_unref() reduces the
1499 * reference count to 0.
1501 * If the buf field is not set av_packet_ref() would make a copy instead
1502 * of increasing the reference count.
1504 * The side data is always allocated with av_malloc(), copied by
1505 * av_packet_ref() and freed by av_packet_unref().
1507 * @see av_packet_ref
1508 * @see av_packet_unref
1510 typedef struct AVPacket {
1512 * A reference to the reference-counted buffer where the packet data is
1514 * May be NULL, then the packet data is not reference-counted.
1518 * Presentation timestamp in AVStream->time_base units; the time at which
1519 * the decompressed packet will be presented to the user.
1520 * Can be AV_NOPTS_VALUE if it is not stored in the file.
1521 * pts MUST be larger or equal to dts as presentation cannot happen before
1522 * decompression, unless one wants to view hex dumps. Some formats misuse
1523 * the terms dts and pts/cts to mean something different. Such timestamps
1524 * must be converted to true pts/dts before they are stored in AVPacket.
1528 * Decompression timestamp in AVStream->time_base units; the time at which
1529 * the packet is decompressed.
1530 * Can be AV_NOPTS_VALUE if it is not stored in the file.
1537 * A combination of AV_PKT_FLAG values
1541 * Additional packet data that can be provided by the container.
1542 * Packet can contain several types of side information.
1544 AVPacketSideData *side_data;
1545 int side_data_elems;
1548 * Duration of this packet in AVStream->time_base units, 0 if unknown.
1549 * Equals next_pts - this_pts in presentation order.
1553 int64_t pos; ///< byte position in stream, -1 if unknown
1555 #if FF_API_CONVERGENCE_DURATION
1557 * @deprecated Same as the duration field, but as int64_t. This was required
1558 * for Matroska subtitles, whose duration values could overflow when the
1559 * duration field was still an int.
1561 attribute_deprecated
1562 int64_t convergence_duration;
1565 #define AV_PKT_FLAG_KEY 0x0001 ///< The packet contains a keyframe
1566 #define AV_PKT_FLAG_CORRUPT 0x0002 ///< The packet content is corrupted
1568 * Flag is used to discard packets which are required to maintain valid
1569 * decoder state but are not required for output and should be dropped
1572 #define AV_PKT_FLAG_DISCARD 0x0004
1574 * The packet comes from a trusted source.
1576 * Otherwise-unsafe constructs such as arbitrary pointers to data
1577 * outside the packet may be followed.
1579 #define AV_PKT_FLAG_TRUSTED 0x0008
1581 * Flag is used to indicate packets that contain frames that can
1582 * be discarded by the decoder. I.e. Non-reference frames.
1584 #define AV_PKT_FLAG_DISPOSABLE 0x0010
1587 enum AVSideDataParamChangeFlags {
1588 AV_SIDE_DATA_PARAM_CHANGE_CHANNEL_COUNT = 0x0001,
1589 AV_SIDE_DATA_PARAM_CHANGE_CHANNEL_LAYOUT = 0x0002,
1590 AV_SIDE_DATA_PARAM_CHANGE_SAMPLE_RATE = 0x0004,
1591 AV_SIDE_DATA_PARAM_CHANGE_DIMENSIONS = 0x0008,
1597 struct AVCodecInternal;
1601 AV_FIELD_PROGRESSIVE,
1602 AV_FIELD_TT, //< Top coded_first, top displayed first
1603 AV_FIELD_BB, //< Bottom coded first, bottom displayed first
1604 AV_FIELD_TB, //< Top coded first, bottom displayed first
1605 AV_FIELD_BT, //< Bottom coded first, top displayed first
1609 * main external API structure.
1610 * New fields can be added to the end with minor version bumps.
1611 * Removal, reordering and changes to existing fields require a major
1613 * You can use AVOptions (av_opt* / av_set/get*()) to access these fields from user
1615 * The name string for AVOptions options matches the associated command line
1616 * parameter name and can be found in libavcodec/options_table.h
1617 * The AVOption/command line parameter names differ in some cases from the C
1618 * structure field names for historic reasons or brevity.
1619 * sizeof(AVCodecContext) must not be used outside libav*.
1621 typedef struct AVCodecContext {
1623 * information on struct for av_log
1624 * - set by avcodec_alloc_context3
1626 const AVClass *av_class;
1627 int log_level_offset;
1629 enum AVMediaType codec_type; /* see AVMEDIA_TYPE_xxx */
1630 const struct AVCodec *codec;
1631 enum AVCodecID codec_id; /* see AV_CODEC_ID_xxx */
1634 * fourcc (LSB first, so "ABCD" -> ('D'<<24) + ('C'<<16) + ('B'<<8) + 'A').
1635 * This is used to work around some encoder bugs.
1636 * A demuxer should set this to what is stored in the field used to identify the codec.
1637 * If there are multiple such fields in a container then the demuxer should choose the one
1638 * which maximizes the information about the used codec.
1639 * If the codec tag field in a container is larger than 32 bits then the demuxer should
1640 * remap the longer ID to 32 bits with a table or other structure. Alternatively a new
1641 * extra_codec_tag + size could be added but for this a clear advantage must be demonstrated
1643 * - encoding: Set by user, if not then the default based on codec_id will be used.
1644 * - decoding: Set by user, will be converted to uppercase by libavcodec during init.
1646 unsigned int codec_tag;
1651 * Private context used for internal data.
1653 * Unlike priv_data, this is not codec-specific. It is used in general
1654 * libavcodec functions.
1656 struct AVCodecInternal *internal;
1659 * Private data of the user, can be used to carry app specific stuff.
1660 * - encoding: Set by user.
1661 * - decoding: Set by user.
1666 * the average bitrate
1667 * - encoding: Set by user; unused for constant quantizer encoding.
1668 * - decoding: Set by user, may be overwritten by libavcodec
1669 * if this info is available in the stream
1674 * number of bits the bitstream is allowed to diverge from the reference.
1675 * the reference can be CBR (for CBR pass1) or VBR (for pass2)
1676 * - encoding: Set by user; unused for constant quantizer encoding.
1677 * - decoding: unused
1679 int bit_rate_tolerance;
1682 * Global quality for codecs which cannot change it per frame.
1683 * This should be proportional to MPEG-1/2/4 qscale.
1684 * - encoding: Set by user.
1685 * - decoding: unused
1690 * - encoding: Set by user.
1691 * - decoding: unused
1693 int compression_level;
1694 #define FF_COMPRESSION_DEFAULT -1
1698 * - encoding: Set by user.
1699 * - decoding: Set by user.
1705 * - encoding: Set by user.
1706 * - decoding: Set by user.
1711 * some codecs need / can use extradata like Huffman tables.
1712 * MJPEG: Huffman tables
1713 * rv10: additional flags
1714 * MPEG-4: global headers (they can be in the bitstream or here)
1715 * The allocated memory should be AV_INPUT_BUFFER_PADDING_SIZE bytes larger
1716 * than extradata_size to avoid problems if it is read with the bitstream reader.
1717 * The bytewise contents of extradata must not depend on the architecture or CPU endianness.
1718 * Must be allocated with the av_malloc() family of functions.
1719 * - encoding: Set/allocated/freed by libavcodec.
1720 * - decoding: Set/allocated/freed by user.
1726 * This is the fundamental unit of time (in seconds) in terms
1727 * of which frame timestamps are represented. For fixed-fps content,
1728 * timebase should be 1/framerate and timestamp increments should be
1730 * This often, but not always is the inverse of the frame rate or field rate
1731 * for video. 1/time_base is not the average frame rate if the frame rate is not
1734 * Like containers, elementary streams also can store timestamps, 1/time_base
1735 * is the unit in which these timestamps are specified.
1736 * As example of such codec time base see ISO/IEC 14496-2:2001(E)
1737 * vop_time_increment_resolution and fixed_vop_rate
1738 * (fixed_vop_rate == 0 implies that it is different from the framerate)
1740 * - encoding: MUST be set by user.
1741 * - decoding: the use of this field for decoding is deprecated.
1742 * Use framerate instead.
1744 AVRational time_base;
1747 * For some codecs, the time base is closer to the field rate than the frame rate.
1748 * Most notably, H.264 and MPEG-2 specify time_base as half of frame duration
1749 * if no telecine is used ...
1751 * Set to time_base ticks per frame. Default 1, e.g., H.264/MPEG-2 set it to 2.
1753 int ticks_per_frame;
1758 * Encoding: Number of frames delay there will be from the encoder input to
1759 * the decoder output. (we assume the decoder matches the spec)
1760 * Decoding: Number of frames delay in addition to what a standard decoder
1761 * as specified in the spec would produce.
1764 * Number of frames the decoded output will be delayed relative to the
1768 * For encoding, this field is unused (see initial_padding).
1770 * For decoding, this is the number of samples the decoder needs to
1771 * output before the decoder's output is valid. When seeking, you should
1772 * start decoding this many samples prior to your desired seek point.
1774 * - encoding: Set by libavcodec.
1775 * - decoding: Set by libavcodec.
1782 * picture width / height.
1784 * @note Those fields may not match the values of the last
1785 * AVFrame output by avcodec_decode_video2 due frame
1788 * - encoding: MUST be set by user.
1789 * - decoding: May be set by the user before opening the decoder if known e.g.
1790 * from the container. Some decoders will require the dimensions
1791 * to be set by the caller. During decoding, the decoder may
1792 * overwrite those values as required while parsing the data.
1797 * Bitstream width / height, may be different from width/height e.g. when
1798 * the decoded frame is cropped before being output or lowres is enabled.
1800 * @note Those field may not match the value of the last
1801 * AVFrame output by avcodec_receive_frame() due frame
1804 * - encoding: unused
1805 * - decoding: May be set by the user before opening the decoder if known
1806 * e.g. from the container. During decoding, the decoder may
1807 * overwrite those values as required while parsing the data.
1809 int coded_width, coded_height;
1812 * the number of pictures in a group of pictures, or 0 for intra_only
1813 * - encoding: Set by user.
1814 * - decoding: unused
1819 * Pixel format, see AV_PIX_FMT_xxx.
1820 * May be set by the demuxer if known from headers.
1821 * May be overridden by the decoder if it knows better.
1823 * @note This field may not match the value of the last
1824 * AVFrame output by avcodec_receive_frame() due frame
1827 * - encoding: Set by user.
1828 * - decoding: Set by user if known, overridden by libavcodec while
1831 enum AVPixelFormat pix_fmt;
1834 * If non NULL, 'draw_horiz_band' is called by the libavcodec
1835 * decoder to draw a horizontal band. It improves cache usage. Not
1836 * all codecs can do that. You must check the codec capabilities
1838 * When multithreading is used, it may be called from multiple threads
1839 * at the same time; threads might draw different parts of the same AVFrame,
1840 * or multiple AVFrames, and there is no guarantee that slices will be drawn
1842 * The function is also used by hardware acceleration APIs.
1843 * It is called at least once during frame decoding to pass
1844 * the data needed for hardware render.
1845 * In that mode instead of pixel data, AVFrame points to
1846 * a structure specific to the acceleration API. The application
1847 * reads the structure and can change some fields to indicate progress
1849 * - encoding: unused
1850 * - decoding: Set by user.
1851 * @param height the height of the slice
1852 * @param y the y position of the slice
1853 * @param type 1->top field, 2->bottom field, 3->frame
1854 * @param offset offset into the AVFrame.data from which the slice should be read
1856 void (*draw_horiz_band)(struct AVCodecContext *s,
1857 const AVFrame *src, int offset[AV_NUM_DATA_POINTERS],
1858 int y, int type, int height);
1861 * callback to negotiate the pixelFormat
1862 * @param fmt is the list of formats which are supported by the codec,
1863 * it is terminated by -1 as 0 is a valid format, the formats are ordered by quality.
1864 * The first is always the native one.
1865 * @note The callback may be called again immediately if initialization for
1866 * the selected (hardware-accelerated) pixel format failed.
1867 * @warning Behavior is undefined if the callback returns a value not
1868 * in the fmt list of formats.
1869 * @return the chosen format
1870 * - encoding: unused
1871 * - decoding: Set by user, if not set the native format will be chosen.
1873 enum AVPixelFormat (*get_format)(struct AVCodecContext *s, const enum AVPixelFormat * fmt);
1876 * maximum number of B-frames between non-B-frames
1877 * Note: The output will be delayed by max_b_frames+1 relative to the input.
1878 * - encoding: Set by user.
1879 * - decoding: unused
1884 * qscale factor between IP and B-frames
1885 * If > 0 then the last P-frame quantizer will be used (q= lastp_q*factor+offset).
1886 * If < 0 then normal ratecontrol will be done (q= -normal_q*factor+offset).
1887 * - encoding: Set by user.
1888 * - decoding: unused
1890 float b_quant_factor;
1892 #if FF_API_PRIVATE_OPT
1893 /** @deprecated use encoder private options instead */
1894 attribute_deprecated
1895 int b_frame_strategy;
1899 * qscale offset between IP and B-frames
1900 * - encoding: Set by user.
1901 * - decoding: unused
1903 float b_quant_offset;
1906 * Size of the frame reordering buffer in the decoder.
1907 * For MPEG-2 it is 1 IPB or 0 low delay IP.
1908 * - encoding: Set by libavcodec.
1909 * - decoding: Set by libavcodec.
1913 #if FF_API_PRIVATE_OPT
1914 /** @deprecated use encoder private options instead */
1915 attribute_deprecated
1920 * qscale factor between P- and I-frames
1921 * If > 0 then the last P-frame quantizer will be used (q = lastp_q * factor + offset).
1922 * If < 0 then normal ratecontrol will be done (q= -normal_q*factor+offset).
1923 * - encoding: Set by user.
1924 * - decoding: unused
1926 float i_quant_factor;
1929 * qscale offset between P and I-frames
1930 * - encoding: Set by user.
1931 * - decoding: unused
1933 float i_quant_offset;
1936 * luminance masking (0-> disabled)
1937 * - encoding: Set by user.
1938 * - decoding: unused
1943 * temporary complexity masking (0-> disabled)
1944 * - encoding: Set by user.
1945 * - decoding: unused
1947 float temporal_cplx_masking;
1950 * spatial complexity masking (0-> disabled)
1951 * - encoding: Set by user.
1952 * - decoding: unused
1954 float spatial_cplx_masking;
1957 * p block masking (0-> disabled)
1958 * - encoding: Set by user.
1959 * - decoding: unused
1964 * darkness masking (0-> disabled)
1965 * - encoding: Set by user.
1966 * - decoding: unused
1972 * - encoding: Set by libavcodec.
1973 * - decoding: Set by user (or 0).
1977 #if FF_API_PRIVATE_OPT
1978 /** @deprecated use encoder private options instead */
1979 attribute_deprecated
1980 int prediction_method;
1981 #define FF_PRED_LEFT 0
1982 #define FF_PRED_PLANE 1
1983 #define FF_PRED_MEDIAN 2
1987 * slice offsets in the frame in bytes
1988 * - encoding: Set/allocated by libavcodec.
1989 * - decoding: Set/allocated by user (or NULL).
1994 * sample aspect ratio (0 if unknown)
1995 * That is the width of a pixel divided by the height of the pixel.
1996 * Numerator and denominator must be relatively prime and smaller than 256 for some video standards.
1997 * - encoding: Set by user.
1998 * - decoding: Set by libavcodec.
2000 AVRational sample_aspect_ratio;
2003 * motion estimation comparison function
2004 * - encoding: Set by user.
2005 * - decoding: unused
2009 * subpixel motion estimation comparison function
2010 * - encoding: Set by user.
2011 * - decoding: unused
2015 * macroblock comparison function (not supported yet)
2016 * - encoding: Set by user.
2017 * - decoding: unused
2021 * interlaced DCT comparison function
2022 * - encoding: Set by user.
2023 * - decoding: unused
2026 #define FF_CMP_SAD 0
2027 #define FF_CMP_SSE 1
2028 #define FF_CMP_SATD 2
2029 #define FF_CMP_DCT 3
2030 #define FF_CMP_PSNR 4
2031 #define FF_CMP_BIT 5
2033 #define FF_CMP_ZERO 7
2034 #define FF_CMP_VSAD 8
2035 #define FF_CMP_VSSE 9
2036 #define FF_CMP_NSSE 10
2037 #define FF_CMP_W53 11
2038 #define FF_CMP_W97 12
2039 #define FF_CMP_DCTMAX 13
2040 #define FF_CMP_DCT264 14
2041 #define FF_CMP_MEDIAN_SAD 15
2042 #define FF_CMP_CHROMA 256
2045 * ME diamond size & shape
2046 * - encoding: Set by user.
2047 * - decoding: unused
2052 * amount of previous MV predictors (2a+1 x 2a+1 square)
2053 * - encoding: Set by user.
2054 * - decoding: unused
2056 int last_predictor_count;
2058 #if FF_API_PRIVATE_OPT
2059 /** @deprecated use encoder private options instead */
2060 attribute_deprecated
2065 * motion estimation prepass comparison function
2066 * - encoding: Set by user.
2067 * - decoding: unused
2072 * ME prepass diamond size & shape
2073 * - encoding: Set by user.
2074 * - decoding: unused
2080 * - encoding: Set by user.
2081 * - decoding: unused
2083 int me_subpel_quality;
2086 * maximum motion estimation search range in subpel units
2087 * If 0 then no limit.
2089 * - encoding: Set by user.
2090 * - decoding: unused
2096 * - encoding: unused
2097 * - decoding: Set by user.
2100 #define SLICE_FLAG_CODED_ORDER 0x0001 ///< draw_horiz_band() is called in coded order instead of display
2101 #define SLICE_FLAG_ALLOW_FIELD 0x0002 ///< allow draw_horiz_band() with field slices (MPEG-2 field pics)
2102 #define SLICE_FLAG_ALLOW_PLANE 0x0004 ///< allow draw_horiz_band() with 1 component at a time (SVQ1)
2105 * macroblock decision mode
2106 * - encoding: Set by user.
2107 * - decoding: unused
2110 #define FF_MB_DECISION_SIMPLE 0 ///< uses mb_cmp
2111 #define FF_MB_DECISION_BITS 1 ///< chooses the one which needs the fewest bits
2112 #define FF_MB_DECISION_RD 2 ///< rate distortion
2115 * custom intra quantization matrix
2116 * Must be allocated with the av_malloc() family of functions, and will be freed in
2117 * avcodec_free_context().
2118 * - encoding: Set/allocated by user, freed by libavcodec. Can be NULL.
2119 * - decoding: Set/allocated/freed by libavcodec.
2121 uint16_t *intra_matrix;
2124 * custom inter quantization matrix
2125 * Must be allocated with the av_malloc() family of functions, and will be freed in
2126 * avcodec_free_context().
2127 * - encoding: Set/allocated by user, freed by libavcodec. Can be NULL.
2128 * - decoding: Set/allocated/freed by libavcodec.
2130 uint16_t *inter_matrix;
2132 #if FF_API_PRIVATE_OPT
2133 /** @deprecated use encoder private options instead */
2134 attribute_deprecated
2135 int scenechange_threshold;
2137 /** @deprecated use encoder private options instead */
2138 attribute_deprecated
2139 int noise_reduction;
2143 * precision of the intra DC coefficient - 8
2144 * - encoding: Set by user.
2145 * - decoding: Set by libavcodec
2147 int intra_dc_precision;
2150 * Number of macroblock rows at the top which are skipped.
2151 * - encoding: unused
2152 * - decoding: Set by user.
2157 * Number of macroblock rows at the bottom which are skipped.
2158 * - encoding: unused
2159 * - decoding: Set by user.
2164 * minimum MB Lagrange multiplier
2165 * - encoding: Set by user.
2166 * - decoding: unused
2171 * maximum MB Lagrange multiplier
2172 * - encoding: Set by user.
2173 * - decoding: unused
2177 #if FF_API_PRIVATE_OPT
2179 * @deprecated use encoder private options instead
2181 attribute_deprecated
2182 int me_penalty_compensation;
2186 * - encoding: Set by user.
2187 * - decoding: unused
2191 #if FF_API_PRIVATE_OPT
2192 /** @deprecated use encoder private options instead */
2193 attribute_deprecated
2199 * - encoding: Set by user.
2200 * - decoding: unused
2205 * number of reference frames
2206 * - encoding: Set by user.
2207 * - decoding: Set by lavc.
2211 #if FF_API_PRIVATE_OPT
2212 /** @deprecated use encoder private options instead */
2213 attribute_deprecated
2218 * Note: Value depends upon the compare function used for fullpel ME.
2219 * - encoding: Set by user.
2220 * - decoding: unused
2224 #if FF_API_PRIVATE_OPT
2225 /** @deprecated use encoder private options instead */
2226 attribute_deprecated
2231 * Chromaticity coordinates of the source primaries.
2232 * - encoding: Set by user
2233 * - decoding: Set by libavcodec
2235 enum AVColorPrimaries color_primaries;
2238 * Color Transfer Characteristic.
2239 * - encoding: Set by user
2240 * - decoding: Set by libavcodec
2242 enum AVColorTransferCharacteristic color_trc;
2245 * YUV colorspace type.
2246 * - encoding: Set by user
2247 * - decoding: Set by libavcodec
2249 enum AVColorSpace colorspace;
2252 * MPEG vs JPEG YUV range.
2253 * - encoding: Set by user
2254 * - decoding: Set by libavcodec
2256 enum AVColorRange color_range;
2259 * This defines the location of chroma samples.
2260 * - encoding: Set by user
2261 * - decoding: Set by libavcodec
2263 enum AVChromaLocation chroma_sample_location;
2267 * Indicates number of picture subdivisions. Used for parallelized
2269 * - encoding: Set by user
2270 * - decoding: unused
2275 * - encoding: set by libavcodec
2276 * - decoding: Set by user.
2278 enum AVFieldOrder field_order;
2281 int sample_rate; ///< samples per second
2282 int channels; ///< number of audio channels
2285 * audio sample format
2286 * - encoding: Set by user.
2287 * - decoding: Set by libavcodec.
2289 enum AVSampleFormat sample_fmt; ///< sample format
2291 /* The following data should not be initialized. */
2293 * Number of samples per channel in an audio frame.
2295 * - encoding: set by libavcodec in avcodec_open2(). Each submitted frame
2296 * except the last must contain exactly frame_size samples per channel.
2297 * May be 0 when the codec has AV_CODEC_CAP_VARIABLE_FRAME_SIZE set, then the
2298 * frame size is not restricted.
2299 * - decoding: may be set by some decoders to indicate constant frame size
2304 * Frame counter, set by libavcodec.
2306 * - decoding: total number of frames returned from the decoder so far.
2307 * - encoding: total number of frames passed to the encoder so far.
2309 * @note the counter is not incremented if encoding/decoding resulted in
2315 * number of bytes per packet if constant and known or 0
2316 * Used by some WAV based audio codecs.
2321 * Audio cutoff bandwidth (0 means "automatic")
2322 * - encoding: Set by user.
2323 * - decoding: unused
2328 * Audio channel layout.
2329 * - encoding: set by user.
2330 * - decoding: set by user, may be overwritten by libavcodec.
2332 uint64_t channel_layout;
2335 * Request decoder to use this channel layout if it can (0 for default)
2336 * - encoding: unused
2337 * - decoding: Set by user.
2339 uint64_t request_channel_layout;
2342 * Type of service that the audio stream conveys.
2343 * - encoding: Set by user.
2344 * - decoding: Set by libavcodec.
2346 enum AVAudioServiceType audio_service_type;
2349 * desired sample format
2350 * - encoding: Not used.
2351 * - decoding: Set by user.
2352 * Decoder will decode to this format if it can.
2354 enum AVSampleFormat request_sample_fmt;
2357 * This callback is called at the beginning of each frame to get data
2358 * buffer(s) for it. There may be one contiguous buffer for all the data or
2359 * there may be a buffer per each data plane or anything in between. What
2360 * this means is, you may set however many entries in buf[] you feel necessary.
2361 * Each buffer must be reference-counted using the AVBuffer API (see description
2364 * The following fields will be set in the frame before this callback is
2367 * - width, height (video only)
2368 * - sample_rate, channel_layout, nb_samples (audio only)
2369 * Their values may differ from the corresponding values in
2370 * AVCodecContext. This callback must use the frame values, not the codec
2371 * context values, to calculate the required buffer size.
2373 * This callback must fill the following fields in the frame:
2377 * * if the data is planar audio with more than 8 channels, then this
2378 * callback must allocate and fill extended_data to contain all pointers
2379 * to all data planes. data[] must hold as many pointers as it can.
2380 * extended_data must be allocated with av_malloc() and will be freed in
2382 * * otherwise extended_data must point to data
2383 * - buf[] must contain one or more pointers to AVBufferRef structures. Each of
2384 * the frame's data and extended_data pointers must be contained in these. That
2385 * is, one AVBufferRef for each allocated chunk of memory, not necessarily one
2386 * AVBufferRef per data[] entry. See: av_buffer_create(), av_buffer_alloc(),
2387 * and av_buffer_ref().
2388 * - extended_buf and nb_extended_buf must be allocated with av_malloc() by
2389 * this callback and filled with the extra buffers if there are more
2390 * buffers than buf[] can hold. extended_buf will be freed in
2393 * If AV_CODEC_CAP_DR1 is not set then get_buffer2() must call
2394 * avcodec_default_get_buffer2() instead of providing buffers allocated by
2397 * Each data plane must be aligned to the maximum required by the target
2400 * @see avcodec_default_get_buffer2()
2404 * If AV_GET_BUFFER_FLAG_REF is set in flags then the frame may be reused
2405 * (read and/or written to if it is writable) later by libavcodec.
2407 * avcodec_align_dimensions2() should be used to find the required width and
2408 * height, as they normally need to be rounded up to the next multiple of 16.
2410 * Some decoders do not support linesizes changing between frames.
2412 * If frame multithreading is used and thread_safe_callbacks is set,
2413 * this callback may be called from a different thread, but not from more
2414 * than one at once. Does not need to be reentrant.
2416 * @see avcodec_align_dimensions2()
2420 * Decoders request a buffer of a particular size by setting
2421 * AVFrame.nb_samples prior to calling get_buffer2(). The decoder may,
2422 * however, utilize only part of the buffer by setting AVFrame.nb_samples
2423 * to a smaller value in the output frame.
2425 * As a convenience, av_samples_get_buffer_size() and
2426 * av_samples_fill_arrays() in libavutil may be used by custom get_buffer2()
2427 * functions to find the required data size and to fill data pointers and
2428 * linesize. In AVFrame.linesize, only linesize[0] may be set for audio
2429 * since all planes must be the same size.
2431 * @see av_samples_get_buffer_size(), av_samples_fill_arrays()
2433 * - encoding: unused
2434 * - decoding: Set by libavcodec, user can override.
2436 int (*get_buffer2)(struct AVCodecContext *s, AVFrame *frame, int flags);
2439 * If non-zero, the decoded audio and video frames returned from
2440 * avcodec_decode_video2() and avcodec_decode_audio4() are reference-counted
2441 * and are valid indefinitely. The caller must free them with
2442 * av_frame_unref() when they are not needed anymore.
2443 * Otherwise, the decoded frames must not be freed by the caller and are
2444 * only valid until the next decode call.
2446 * This is always automatically enabled if avcodec_receive_frame() is used.
2448 * - encoding: unused
2449 * - decoding: set by the caller before avcodec_open2().
2451 attribute_deprecated
2452 int refcounted_frames;
2454 /* - encoding parameters */
2455 float qcompress; ///< amount of qscale change between easy & hard scenes (0.0-1.0)
2456 float qblur; ///< amount of qscale smoothing over time (0.0-1.0)
2460 * - encoding: Set by user.
2461 * - decoding: unused
2467 * - encoding: Set by user.
2468 * - decoding: unused
2473 * maximum quantizer difference between frames
2474 * - encoding: Set by user.
2475 * - decoding: unused
2480 * decoder bitstream buffer size
2481 * - encoding: Set by user.
2482 * - decoding: unused
2487 * ratecontrol override, see RcOverride
2488 * - encoding: Allocated/set/freed by user.
2489 * - decoding: unused
2491 int rc_override_count;
2492 RcOverride *rc_override;
2496 * - encoding: Set by user.
2497 * - decoding: Set by user, may be overwritten by libavcodec.
2499 int64_t rc_max_rate;
2503 * - encoding: Set by user.
2504 * - decoding: unused
2506 int64_t rc_min_rate;
2509 * Ratecontrol attempt to use, at maximum, <value> of what can be used without an underflow.
2510 * - encoding: Set by user.
2511 * - decoding: unused.
2513 float rc_max_available_vbv_use;
2516 * Ratecontrol attempt to use, at least, <value> times the amount needed to prevent a vbv overflow.
2517 * - encoding: Set by user.
2518 * - decoding: unused.
2520 float rc_min_vbv_overflow_use;
2523 * Number of bits which should be loaded into the rc buffer before decoding starts.
2524 * - encoding: Set by user.
2525 * - decoding: unused
2527 int rc_initial_buffer_occupancy;
2529 #if FF_API_CODER_TYPE
2530 #define FF_CODER_TYPE_VLC 0
2531 #define FF_CODER_TYPE_AC 1
2532 #define FF_CODER_TYPE_RAW 2
2533 #define FF_CODER_TYPE_RLE 3
2535 * @deprecated use encoder private options instead
2537 attribute_deprecated
2539 #endif /* FF_API_CODER_TYPE */
2541 #if FF_API_PRIVATE_OPT
2542 /** @deprecated use encoder private options instead */
2543 attribute_deprecated
2547 #if FF_API_PRIVATE_OPT
2548 /** @deprecated use encoder private options instead */
2549 attribute_deprecated
2550 int frame_skip_threshold;
2552 /** @deprecated use encoder private options instead */
2553 attribute_deprecated
2554 int frame_skip_factor;
2556 /** @deprecated use encoder private options instead */
2557 attribute_deprecated
2560 /** @deprecated use encoder private options instead */
2561 attribute_deprecated
2563 #endif /* FF_API_PRIVATE_OPT */
2566 * trellis RD quantization
2567 * - encoding: Set by user.
2568 * - decoding: unused
2572 #if FF_API_PRIVATE_OPT
2573 /** @deprecated use encoder private options instead */
2574 attribute_deprecated
2575 int min_prediction_order;
2577 /** @deprecated use encoder private options instead */
2578 attribute_deprecated
2579 int max_prediction_order;
2581 /** @deprecated use encoder private options instead */
2582 attribute_deprecated
2583 int64_t timecode_frame_start;
2586 #if FF_API_RTP_CALLBACK
2588 * @deprecated unused
2590 /* The RTP callback: This function is called */
2591 /* every time the encoder has a packet to send. */
2592 /* It depends on the encoder if the data starts */
2593 /* with a Start Code (it should). H.263 does. */
2594 /* mb_nb contains the number of macroblocks */
2595 /* encoded in the RTP payload. */
2596 attribute_deprecated
2597 void (*rtp_callback)(struct AVCodecContext *avctx, void *data, int size, int mb_nb);
2600 #if FF_API_PRIVATE_OPT
2601 /** @deprecated use encoder private options instead */
2602 attribute_deprecated
2603 int rtp_payload_size; /* The size of the RTP payload: the coder will */
2604 /* do its best to deliver a chunk with size */
2605 /* below rtp_payload_size, the chunk will start */
2606 /* with a start code on some codecs like H.263. */
2607 /* This doesn't take account of any particular */
2608 /* headers inside the transmitted RTP payload. */
2611 #if FF_API_STAT_BITS
2612 /* statistics, used for 2-pass encoding */
2613 attribute_deprecated
2615 attribute_deprecated
2617 attribute_deprecated
2619 attribute_deprecated
2621 attribute_deprecated
2623 attribute_deprecated
2625 attribute_deprecated
2627 attribute_deprecated
2630 /** @deprecated this field is unused */
2631 attribute_deprecated
2636 * pass1 encoding statistics output buffer
2637 * - encoding: Set by libavcodec.
2638 * - decoding: unused
2643 * pass2 encoding statistics input buffer
2644 * Concatenated stuff from stats_out of pass1 should be placed here.
2645 * - encoding: Allocated/set/freed by user.
2646 * - decoding: unused
2651 * Work around bugs in encoders which sometimes cannot be detected automatically.
2652 * - encoding: Set by user
2653 * - decoding: Set by user
2655 int workaround_bugs;
2656 #define FF_BUG_AUTODETECT 1 ///< autodetection
2657 #define FF_BUG_XVID_ILACE 4
2658 #define FF_BUG_UMP4 8
2659 #define FF_BUG_NO_PADDING 16
2660 #define FF_BUG_AMV 32
2661 #define FF_BUG_QPEL_CHROMA 64
2662 #define FF_BUG_STD_QPEL 128
2663 #define FF_BUG_QPEL_CHROMA2 256
2664 #define FF_BUG_DIRECT_BLOCKSIZE 512
2665 #define FF_BUG_EDGE 1024
2666 #define FF_BUG_HPEL_CHROMA 2048
2667 #define FF_BUG_DC_CLIP 4096
2668 #define FF_BUG_MS 8192 ///< Work around various bugs in Microsoft's broken decoders.
2669 #define FF_BUG_TRUNCATED 16384
2670 #define FF_BUG_IEDGE 32768
2673 * strictly follow the standard (MPEG-4, ...).
2674 * - encoding: Set by user.
2675 * - decoding: Set by user.
2676 * Setting this to STRICT or higher means the encoder and decoder will
2677 * generally do stupid things, whereas setting it to unofficial or lower
2678 * will mean the encoder might produce output that is not supported by all
2679 * spec-compliant decoders. Decoders don't differentiate between normal,
2680 * unofficial and experimental (that is, they always try to decode things
2681 * when they can) unless they are explicitly asked to behave stupidly
2682 * (=strictly conform to the specs)
2684 int strict_std_compliance;
2685 #define FF_COMPLIANCE_VERY_STRICT 2 ///< Strictly conform to an older more strict version of the spec or reference software.
2686 #define FF_COMPLIANCE_STRICT 1 ///< Strictly conform to all the things in the spec no matter what consequences.
2687 #define FF_COMPLIANCE_NORMAL 0
2688 #define FF_COMPLIANCE_UNOFFICIAL -1 ///< Allow unofficial extensions
2689 #define FF_COMPLIANCE_EXPERIMENTAL -2 ///< Allow nonstandardized experimental things.
2692 * error concealment flags
2693 * - encoding: unused
2694 * - decoding: Set by user.
2696 int error_concealment;
2697 #define FF_EC_GUESS_MVS 1
2698 #define FF_EC_DEBLOCK 2
2699 #define FF_EC_FAVOR_INTER 256
2703 * - encoding: Set by user.
2704 * - decoding: Set by user.
2707 #define FF_DEBUG_PICT_INFO 1
2708 #define FF_DEBUG_RC 2
2709 #define FF_DEBUG_BITSTREAM 4
2710 #define FF_DEBUG_MB_TYPE 8
2711 #define FF_DEBUG_QP 16
2714 * @deprecated this option does nothing
2716 #define FF_DEBUG_MV 32
2718 #define FF_DEBUG_DCT_COEFF 0x00000040
2719 #define FF_DEBUG_SKIP 0x00000080
2720 #define FF_DEBUG_STARTCODE 0x00000100
2721 #define FF_DEBUG_ER 0x00000400
2722 #define FF_DEBUG_MMCO 0x00000800
2723 #define FF_DEBUG_BUGS 0x00001000
2725 #define FF_DEBUG_VIS_QP 0x00002000
2726 #define FF_DEBUG_VIS_MB_TYPE 0x00004000
2728 #define FF_DEBUG_BUFFERS 0x00008000
2729 #define FF_DEBUG_THREADS 0x00010000
2730 #define FF_DEBUG_GREEN_MD 0x00800000
2731 #define FF_DEBUG_NOMC 0x01000000
2736 * - encoding: Set by user.
2737 * - decoding: Set by user.
2740 #define FF_DEBUG_VIS_MV_P_FOR 0x00000001 // visualize forward predicted MVs of P-frames
2741 #define FF_DEBUG_VIS_MV_B_FOR 0x00000002 // visualize forward predicted MVs of B-frames
2742 #define FF_DEBUG_VIS_MV_B_BACK 0x00000004 // visualize backward predicted MVs of B-frames
2746 * Error recognition; may misdetect some more or less valid parts as errors.
2747 * - encoding: unused
2748 * - decoding: Set by user.
2750 int err_recognition;
2753 * Verify checksums embedded in the bitstream (could be of either encoded or
2754 * decoded data, depending on the codec) and print an error message on mismatch.
2755 * If AV_EF_EXPLODE is also set, a mismatching checksum will result in the
2756 * decoder returning an error.
2758 #define AV_EF_CRCCHECK (1<<0)
2759 #define AV_EF_BITSTREAM (1<<1) ///< detect bitstream specification deviations
2760 #define AV_EF_BUFFER (1<<2) ///< detect improper bitstream length
2761 #define AV_EF_EXPLODE (1<<3) ///< abort decoding on minor error detection
2763 #define AV_EF_IGNORE_ERR (1<<15) ///< ignore errors and continue
2764 #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
2765 #define AV_EF_COMPLIANT (1<<17) ///< consider all spec non compliances as errors
2766 #define AV_EF_AGGRESSIVE (1<<18) ///< consider things that a sane encoder should not do as an error
2770 * opaque 64-bit number (generally a PTS) that will be reordered and
2771 * output in AVFrame.reordered_opaque
2772 * - encoding: Set by libavcodec to the reordered_opaque of the input
2773 * frame corresponding to the last returned packet. Only
2774 * supported by encoders with the
2775 * AV_CODEC_CAP_ENCODER_REORDERED_OPAQUE capability.
2776 * - decoding: Set by user.
2778 int64_t reordered_opaque;
2781 * Hardware accelerator in use
2782 * - encoding: unused.
2783 * - decoding: Set by libavcodec
2785 const struct AVHWAccel *hwaccel;
2788 * Hardware accelerator context.
2789 * For some hardware accelerators, a global context needs to be
2790 * provided by the user. In that case, this holds display-dependent
2791 * data FFmpeg cannot instantiate itself. Please refer to the
2792 * FFmpeg HW accelerator documentation to know how to fill this
2793 * is. e.g. for VA API, this is a struct vaapi_context.
2794 * - encoding: unused
2795 * - decoding: Set by user
2797 void *hwaccel_context;
2801 * - encoding: Set by libavcodec if flags & AV_CODEC_FLAG_PSNR.
2802 * - decoding: unused
2804 uint64_t error[AV_NUM_DATA_POINTERS];
2807 * DCT algorithm, see FF_DCT_* below
2808 * - encoding: Set by user.
2809 * - decoding: unused
2812 #define FF_DCT_AUTO 0
2813 #define FF_DCT_FASTINT 1
2814 #define FF_DCT_INT 2
2815 #define FF_DCT_MMX 3
2816 #define FF_DCT_ALTIVEC 5
2817 #define FF_DCT_FAAN 6
2820 * IDCT algorithm, see FF_IDCT_* below.
2821 * - encoding: Set by user.
2822 * - decoding: Set by user.
2825 #define FF_IDCT_AUTO 0
2826 #define FF_IDCT_INT 1
2827 #define FF_IDCT_SIMPLE 2
2828 #define FF_IDCT_SIMPLEMMX 3
2829 #define FF_IDCT_ARM 7
2830 #define FF_IDCT_ALTIVEC 8
2831 #define FF_IDCT_SIMPLEARM 10
2832 #define FF_IDCT_XVID 14
2833 #define FF_IDCT_SIMPLEARMV5TE 16
2834 #define FF_IDCT_SIMPLEARMV6 17
2835 #define FF_IDCT_FAAN 20
2836 #define FF_IDCT_SIMPLENEON 22
2837 #define FF_IDCT_NONE 24 /* Used by XvMC to extract IDCT coefficients with FF_IDCT_PERM_NONE */
2838 #define FF_IDCT_SIMPLEAUTO 128
2841 * bits per sample/pixel from the demuxer (needed for huffyuv).
2842 * - encoding: Set by libavcodec.
2843 * - decoding: Set by user.
2845 int bits_per_coded_sample;
2848 * Bits per sample/pixel of internal libavcodec pixel/sample format.
2849 * - encoding: set by user.
2850 * - decoding: set by libavcodec.
2852 int bits_per_raw_sample;
2856 * low resolution decoding, 1-> 1/2 size, 2->1/4 size
2857 * - encoding: unused
2858 * - decoding: Set by user.
2863 #if FF_API_CODED_FRAME
2865 * the picture in the bitstream
2866 * - encoding: Set by libavcodec.
2867 * - decoding: unused
2869 * @deprecated use the quality factor packet side data instead
2871 attribute_deprecated AVFrame *coded_frame;
2876 * is used to decide how many independent tasks should be passed to execute()
2877 * - encoding: Set by user.
2878 * - decoding: Set by user.
2883 * Which multithreading methods to use.
2884 * Use of FF_THREAD_FRAME will increase decoding delay by one frame per thread,
2885 * so clients which cannot provide future frames should not use it.
2887 * - encoding: Set by user, otherwise the default is used.
2888 * - decoding: Set by user, otherwise the default is used.
2891 #define FF_THREAD_FRAME 1 ///< Decode more than one frame at once
2892 #define FF_THREAD_SLICE 2 ///< Decode more than one part of a single frame at once
2895 * Which multithreading methods are in use by the codec.
2896 * - encoding: Set by libavcodec.
2897 * - decoding: Set by libavcodec.
2899 int active_thread_type;
2902 * Set by the client if its custom get_buffer() callback can be called
2903 * synchronously from another thread, which allows faster multithreaded decoding.
2904 * draw_horiz_band() will be called from other threads regardless of this setting.
2905 * Ignored if the default get_buffer() is used.
2906 * - encoding: Set by user.
2907 * - decoding: Set by user.
2909 int thread_safe_callbacks;
2912 * The codec may call this to execute several independent things.
2913 * It will return only after finishing all tasks.
2914 * The user may replace this with some multithreaded implementation,
2915 * the default implementation will execute the parts serially.
2916 * @param count the number of things to execute
2917 * - encoding: Set by libavcodec, user can override.
2918 * - decoding: Set by libavcodec, user can override.
2920 int (*execute)(struct AVCodecContext *c, int (*func)(struct AVCodecContext *c2, void *arg), void *arg2, int *ret, int count, int size);
2923 * The codec may call this to execute several independent things.
2924 * It will return only after finishing all tasks.
2925 * The user may replace this with some multithreaded implementation,
2926 * the default implementation will execute the parts serially.
2927 * Also see avcodec_thread_init and e.g. the --enable-pthread configure option.
2928 * @param c context passed also to func
2929 * @param count the number of things to execute
2930 * @param arg2 argument passed unchanged to func
2931 * @param ret return values of executed functions, must have space for "count" values. May be NULL.
2932 * @param func function that will be called count times, with jobnr from 0 to count-1.
2933 * threadnr will be in the range 0 to c->thread_count-1 < MAX_THREADS and so that no
2934 * two instances of func executing at the same time will have the same threadnr.
2935 * @return always 0 currently, but code should handle a future improvement where when any call to func
2936 * returns < 0 no further calls to func may be done and < 0 is returned.
2937 * - encoding: Set by libavcodec, user can override.
2938 * - decoding: Set by libavcodec, user can override.
2940 int (*execute2)(struct AVCodecContext *c, int (*func)(struct AVCodecContext *c2, void *arg, int jobnr, int threadnr), void *arg2, int *ret, int count);
2943 * noise vs. sse weight for the nsse comparison function
2944 * - encoding: Set by user.
2945 * - decoding: unused
2951 * - encoding: Set by user.
2952 * - decoding: Set by libavcodec.
2955 #define FF_PROFILE_UNKNOWN -99
2956 #define FF_PROFILE_RESERVED -100
2958 #define FF_PROFILE_AAC_MAIN 0
2959 #define FF_PROFILE_AAC_LOW 1
2960 #define FF_PROFILE_AAC_SSR 2
2961 #define FF_PROFILE_AAC_LTP 3
2962 #define FF_PROFILE_AAC_HE 4
2963 #define FF_PROFILE_AAC_HE_V2 28
2964 #define FF_PROFILE_AAC_LD 22
2965 #define FF_PROFILE_AAC_ELD 38
2966 #define FF_PROFILE_MPEG2_AAC_LOW 128
2967 #define FF_PROFILE_MPEG2_AAC_HE 131
2969 #define FF_PROFILE_DNXHD 0
2970 #define FF_PROFILE_DNXHR_LB 1
2971 #define FF_PROFILE_DNXHR_SQ 2
2972 #define FF_PROFILE_DNXHR_HQ 3
2973 #define FF_PROFILE_DNXHR_HQX 4
2974 #define FF_PROFILE_DNXHR_444 5
2976 #define FF_PROFILE_DTS 20
2977 #define FF_PROFILE_DTS_ES 30
2978 #define FF_PROFILE_DTS_96_24 40
2979 #define FF_PROFILE_DTS_HD_HRA 50
2980 #define FF_PROFILE_DTS_HD_MA 60
2981 #define FF_PROFILE_DTS_EXPRESS 70
2983 #define FF_PROFILE_MPEG2_422 0
2984 #define FF_PROFILE_MPEG2_HIGH 1
2985 #define FF_PROFILE_MPEG2_SS 2
2986 #define FF_PROFILE_MPEG2_SNR_SCALABLE 3
2987 #define FF_PROFILE_MPEG2_MAIN 4
2988 #define FF_PROFILE_MPEG2_SIMPLE 5
2990 #define FF_PROFILE_H264_CONSTRAINED (1<<9) // 8+1; constraint_set1_flag
2991 #define FF_PROFILE_H264_INTRA (1<<11) // 8+3; constraint_set3_flag
2993 #define FF_PROFILE_H264_BASELINE 66
2994 #define FF_PROFILE_H264_CONSTRAINED_BASELINE (66|FF_PROFILE_H264_CONSTRAINED)
2995 #define FF_PROFILE_H264_MAIN 77
2996 #define FF_PROFILE_H264_EXTENDED 88
2997 #define FF_PROFILE_H264_HIGH 100
2998 #define FF_PROFILE_H264_HIGH_10 110
2999 #define FF_PROFILE_H264_HIGH_10_INTRA (110|FF_PROFILE_H264_INTRA)
3000 #define FF_PROFILE_H264_MULTIVIEW_HIGH 118
3001 #define FF_PROFILE_H264_HIGH_422 122
3002 #define FF_PROFILE_H264_HIGH_422_INTRA (122|FF_PROFILE_H264_INTRA)
3003 #define FF_PROFILE_H264_STEREO_HIGH 128
3004 #define FF_PROFILE_H264_HIGH_444 144
3005 #define FF_PROFILE_H264_HIGH_444_PREDICTIVE 244
3006 #define FF_PROFILE_H264_HIGH_444_INTRA (244|FF_PROFILE_H264_INTRA)
3007 #define FF_PROFILE_H264_CAVLC_444 44
3009 #define FF_PROFILE_VC1_SIMPLE 0
3010 #define FF_PROFILE_VC1_MAIN 1
3011 #define FF_PROFILE_VC1_COMPLEX 2
3012 #define FF_PROFILE_VC1_ADVANCED 3
3014 #define FF_PROFILE_MPEG4_SIMPLE 0
3015 #define FF_PROFILE_MPEG4_SIMPLE_SCALABLE 1
3016 #define FF_PROFILE_MPEG4_CORE 2
3017 #define FF_PROFILE_MPEG4_MAIN 3
3018 #define FF_PROFILE_MPEG4_N_BIT 4
3019 #define FF_PROFILE_MPEG4_SCALABLE_TEXTURE 5
3020 #define FF_PROFILE_MPEG4_SIMPLE_FACE_ANIMATION 6
3021 #define FF_PROFILE_MPEG4_BASIC_ANIMATED_TEXTURE 7
3022 #define FF_PROFILE_MPEG4_HYBRID 8
3023 #define FF_PROFILE_MPEG4_ADVANCED_REAL_TIME 9
3024 #define FF_PROFILE_MPEG4_CORE_SCALABLE 10
3025 #define FF_PROFILE_MPEG4_ADVANCED_CODING 11
3026 #define FF_PROFILE_MPEG4_ADVANCED_CORE 12
3027 #define FF_PROFILE_MPEG4_ADVANCED_SCALABLE_TEXTURE 13
3028 #define FF_PROFILE_MPEG4_SIMPLE_STUDIO 14
3029 #define FF_PROFILE_MPEG4_ADVANCED_SIMPLE 15
3031 #define FF_PROFILE_JPEG2000_CSTREAM_RESTRICTION_0 1
3032 #define FF_PROFILE_JPEG2000_CSTREAM_RESTRICTION_1 2
3033 #define FF_PROFILE_JPEG2000_CSTREAM_NO_RESTRICTION 32768
3034 #define FF_PROFILE_JPEG2000_DCINEMA_2K 3
3035 #define FF_PROFILE_JPEG2000_DCINEMA_4K 4
3037 #define FF_PROFILE_VP9_0 0
3038 #define FF_PROFILE_VP9_1 1
3039 #define FF_PROFILE_VP9_2 2
3040 #define FF_PROFILE_VP9_3 3
3042 #define FF_PROFILE_HEVC_MAIN 1
3043 #define FF_PROFILE_HEVC_MAIN_10 2
3044 #define FF_PROFILE_HEVC_MAIN_STILL_PICTURE 3
3045 #define FF_PROFILE_HEVC_REXT 4
3047 #define FF_PROFILE_AV1_MAIN 0
3048 #define FF_PROFILE_AV1_HIGH 1
3049 #define FF_PROFILE_AV1_PROFESSIONAL 2
3051 #define FF_PROFILE_MJPEG_HUFFMAN_BASELINE_DCT 0xc0
3052 #define FF_PROFILE_MJPEG_HUFFMAN_EXTENDED_SEQUENTIAL_DCT 0xc1
3053 #define FF_PROFILE_MJPEG_HUFFMAN_PROGRESSIVE_DCT 0xc2
3054 #define FF_PROFILE_MJPEG_HUFFMAN_LOSSLESS 0xc3
3055 #define FF_PROFILE_MJPEG_JPEG_LS 0xf7
3057 #define FF_PROFILE_SBC_MSBC 1
3059 #define FF_PROFILE_PRORES_PROXY 0
3060 #define FF_PROFILE_PRORES_LT 1
3061 #define FF_PROFILE_PRORES_STANDARD 2
3062 #define FF_PROFILE_PRORES_HQ 3
3063 #define FF_PROFILE_PRORES_4444 4
3064 #define FF_PROFILE_PRORES_XQ 5
3066 #define FF_PROFILE_ARIB_PROFILE_A 0
3067 #define FF_PROFILE_ARIB_PROFILE_C 1
3071 * - encoding: Set by user.
3072 * - decoding: Set by libavcodec.
3075 #define FF_LEVEL_UNKNOWN -99
3078 * Skip loop filtering for selected frames.
3079 * - encoding: unused
3080 * - decoding: Set by user.
3082 enum AVDiscard skip_loop_filter;
3085 * Skip IDCT/dequantization for selected frames.
3086 * - encoding: unused
3087 * - decoding: Set by user.
3089 enum AVDiscard skip_idct;
3092 * Skip decoding for selected frames.
3093 * - encoding: unused
3094 * - decoding: Set by user.
3096 enum AVDiscard skip_frame;
3099 * Header containing style information for text subtitles.
3100 * For SUBTITLE_ASS subtitle type, it should contain the whole ASS
3101 * [Script Info] and [V4+ Styles] section, plus the [Events] line and
3102 * the Format line following. It shouldn't include any Dialogue line.
3103 * - encoding: Set/allocated/freed by user (before avcodec_open2())
3104 * - decoding: Set/allocated/freed by libavcodec (by avcodec_open2())
3106 uint8_t *subtitle_header;
3107 int subtitle_header_size;
3109 #if FF_API_VBV_DELAY
3111 * VBV delay coded in the last frame (in periods of a 27 MHz clock).
3112 * Used for compliant TS muxing.
3113 * - encoding: Set by libavcodec.
3114 * - decoding: unused.
3115 * @deprecated this value is now exported as a part of
3116 * AV_PKT_DATA_CPB_PROPERTIES packet side data
3118 attribute_deprecated
3122 #if FF_API_SIDEDATA_ONLY_PKT
3124 * Encoding only and set by default. Allow encoders to output packets
3125 * that do not contain any encoded data, only side data.
3127 * Some encoders need to output such packets, e.g. to update some stream
3128 * parameters at the end of encoding.
3130 * @deprecated this field disables the default behaviour and
3131 * it is kept only for compatibility.
3133 attribute_deprecated
3134 int side_data_only_packets;
3138 * Audio only. The number of "priming" samples (padding) inserted by the
3139 * encoder at the beginning of the audio. I.e. this number of leading
3140 * decoded samples must be discarded by the caller to get the original audio
3141 * without leading padding.
3143 * - decoding: unused
3144 * - encoding: Set by libavcodec. The timestamps on the output packets are
3145 * adjusted by the encoder so that they always refer to the
3146 * first sample of the data actually contained in the packet,
3147 * including any added padding. E.g. if the timebase is
3148 * 1/samplerate and the timestamp of the first input sample is
3149 * 0, the timestamp of the first output packet will be
3152 int initial_padding;
3155 * - decoding: For codecs that store a framerate value in the compressed
3156 * bitstream, the decoder may export it here. { 0, 1} when
3158 * - encoding: May be used to signal the framerate of CFR content to an
3161 AVRational framerate;
3164 * Nominal unaccelerated pixel format, see AV_PIX_FMT_xxx.
3165 * - encoding: unused.
3166 * - decoding: Set by libavcodec before calling get_format()
3168 enum AVPixelFormat sw_pix_fmt;
3171 * Timebase in which pkt_dts/pts and AVPacket.dts/pts are.
3172 * - encoding unused.
3173 * - decoding set by user.
3175 AVRational pkt_timebase;
3179 * - encoding: unused.
3180 * - decoding: set by libavcodec.
3182 const AVCodecDescriptor *codec_descriptor;
3186 * low resolution decoding, 1-> 1/2 size, 2->1/4 size
3187 * - encoding: unused
3188 * - decoding: Set by user.
3194 * Current statistics for PTS correction.
3195 * - decoding: maintained and used by libavcodec, not intended to be used by user apps
3196 * - encoding: unused
3198 int64_t pts_correction_num_faulty_pts; /// Number of incorrect PTS values so far
3199 int64_t pts_correction_num_faulty_dts; /// Number of incorrect DTS values so far
3200 int64_t pts_correction_last_pts; /// PTS of the last frame
3201 int64_t pts_correction_last_dts; /// DTS of the last frame
3204 * Character encoding of the input subtitles file.
3205 * - decoding: set by user
3206 * - encoding: unused
3211 * Subtitles character encoding mode. Formats or codecs might be adjusting
3212 * this setting (if they are doing the conversion themselves for instance).
3213 * - decoding: set by libavcodec
3214 * - encoding: unused
3216 int sub_charenc_mode;
3217 #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)
3218 #define FF_SUB_CHARENC_MODE_AUTOMATIC 0 ///< libavcodec will select the mode itself
3219 #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
3220 #define FF_SUB_CHARENC_MODE_IGNORE 2 ///< neither convert the subtitles, nor check them for valid UTF-8
3223 * Skip processing alpha if supported by codec.
3224 * Note that if the format uses pre-multiplied alpha (common with VP6,
3225 * and recommended due to better video quality/compression)
3226 * the image will look as if alpha-blended onto a black background.
3227 * However for formats that do not use pre-multiplied alpha
3228 * there might be serious artefacts (though e.g. libswscale currently
3229 * assumes pre-multiplied alpha anyway).
3231 * - decoding: set by user
3232 * - encoding: unused
3237 * Number of samples to skip after a discontinuity
3238 * - decoding: unused
3239 * - encoding: set by libavcodec
3243 #if !FF_API_DEBUG_MV
3245 * debug motion vectors
3246 * - encoding: Set by user.
3247 * - decoding: Set by user.
3250 #define FF_DEBUG_VIS_MV_P_FOR 0x00000001 //visualize forward predicted MVs of P frames
3251 #define FF_DEBUG_VIS_MV_B_FOR 0x00000002 //visualize forward predicted MVs of B frames
3252 #define FF_DEBUG_VIS_MV_B_BACK 0x00000004 //visualize backward predicted MVs of B frames
3256 * custom intra quantization matrix
3257 * - encoding: Set by user, can be NULL.
3258 * - decoding: unused.
3260 uint16_t *chroma_intra_matrix;
3263 * dump format separator.
3264 * can be ", " or "\n " or anything else
3265 * - encoding: Set by user.
3266 * - decoding: Set by user.
3268 uint8_t *dump_separator;
3271 * ',' separated list of allowed decoders.
3272 * If NULL then all are allowed
3273 * - encoding: unused
3274 * - decoding: set by user
3276 char *codec_whitelist;
3279 * Properties of the stream that gets decoded
3280 * - encoding: unused
3281 * - decoding: set by libavcodec
3283 unsigned properties;
3284 #define FF_CODEC_PROPERTY_LOSSLESS 0x00000001
3285 #define FF_CODEC_PROPERTY_CLOSED_CAPTIONS 0x00000002
3288 * Additional data associated with the entire coded stream.
3290 * - decoding: unused
3291 * - encoding: may be set by libavcodec after avcodec_open2().
3293 AVPacketSideData *coded_side_data;
3294 int nb_coded_side_data;
3297 * A reference to the AVHWFramesContext describing the input (for encoding)
3298 * or output (decoding) frames. The reference is set by the caller and
3299 * afterwards owned (and freed) by libavcodec - it should never be read by
3300 * the caller after being set.
3302 * - decoding: This field should be set by the caller from the get_format()
3303 * callback. The previous reference (if any) will always be
3304 * unreffed by libavcodec before the get_format() call.
3306 * If the default get_buffer2() is used with a hwaccel pixel
3307 * format, then this AVHWFramesContext will be used for
3308 * allocating the frame buffers.
3310 * - encoding: For hardware encoders configured to use a hwaccel pixel
3311 * format, this field should be set by the caller to a reference
3312 * to the AVHWFramesContext describing input frames.
3313 * AVHWFramesContext.format must be equal to
3314 * AVCodecContext.pix_fmt.
3316 * This field should be set before avcodec_open2() is called.
3318 AVBufferRef *hw_frames_ctx;
3321 * Control the form of AVSubtitle.rects[N]->ass
3322 * - decoding: set by user
3323 * - encoding: unused
3325 int sub_text_format;
3326 #define FF_SUB_TEXT_FMT_ASS 0
3327 #if FF_API_ASS_TIMING
3328 #define FF_SUB_TEXT_FMT_ASS_WITH_TIMINGS 1
3332 * Audio only. The amount of padding (in samples) appended by the encoder to
3333 * the end of the audio. I.e. this number of decoded samples must be
3334 * discarded by the caller from the end of the stream to get the original
3335 * audio without any trailing padding.
3337 * - decoding: unused
3338 * - encoding: unused
3340 int trailing_padding;
3343 * The number of pixels per image to maximally accept.
3345 * - decoding: set by user
3346 * - encoding: set by user
3351 * A reference to the AVHWDeviceContext describing the device which will
3352 * be used by a hardware encoder/decoder. The reference is set by the
3353 * caller and afterwards owned (and freed) by libavcodec.
3355 * This should be used if either the codec device does not require
3356 * hardware frames or any that are used are to be allocated internally by
3357 * libavcodec. If the user wishes to supply any of the frames used as
3358 * encoder input or decoder output then hw_frames_ctx should be used
3359 * instead. When hw_frames_ctx is set in get_format() for a decoder, this
3360 * field will be ignored while decoding the associated stream segment, but
3361 * may again be used on a following one after another get_format() call.
3363 * For both encoders and decoders this field should be set before
3364 * avcodec_open2() is called and must not be written to thereafter.
3366 * Note that some decoders may require this field to be set initially in
3367 * order to support hw_frames_ctx at all - in that case, all frames
3368 * contexts used must be created on the same device.
3370 AVBufferRef *hw_device_ctx;
3373 * Bit set of AV_HWACCEL_FLAG_* flags, which affect hardware accelerated
3374 * decoding (if active).
3375 * - encoding: unused
3376 * - decoding: Set by user (either before avcodec_open2(), or in the
3377 * AVCodecContext.get_format callback)
3382 * Video decoding only. Certain video codecs support cropping, meaning that
3383 * only a sub-rectangle of the decoded frame is intended for display. This
3384 * option controls how cropping is handled by libavcodec.
3386 * When set to 1 (the default), libavcodec will apply cropping internally.
3387 * I.e. it will modify the output frame width/height fields and offset the
3388 * data pointers (only by as much as possible while preserving alignment, or
3389 * by the full amount if the AV_CODEC_FLAG_UNALIGNED flag is set) so that
3390 * the frames output by the decoder refer only to the cropped area. The
3391 * crop_* fields of the output frames will be zero.
3393 * When set to 0, the width/height fields of the output frames will be set
3394 * to the coded dimensions and the crop_* fields will describe the cropping
3395 * rectangle. Applying the cropping is left to the caller.
3397 * @warning When hardware acceleration with opaque output frames is used,
3398 * libavcodec is unable to apply cropping from the top/left border.
3400 * @note when this option is set to zero, the width/height fields of the
3401 * AVCodecContext and output AVFrames have different meanings. The codec
3402 * context fields store display dimensions (with the coded dimensions in
3403 * coded_width/height), while the frame fields store the coded dimensions
3404 * (with the display dimensions being determined by the crop_* fields).
3409 * Video decoding only. Sets the number of extra hardware frames which
3410 * the decoder will allocate for use by the caller. This must be set
3411 * before avcodec_open2() is called.
3413 * Some hardware decoders require all frames that they will use for
3414 * output to be defined in advance before decoding starts. For such
3415 * decoders, the hardware frame pool must therefore be of a fixed size.
3416 * The extra frames set here are on top of any number that the decoder
3417 * needs internally in order to operate normally (for example, frames
3418 * used as reference pictures).
3420 int extra_hw_frames;
3423 * The percentage of damaged samples to discard a frame.
3425 * - decoding: set by user
3426 * - encoding: unused
3428 int discard_damaged_percentage;
3431 * The number of samples per frame to maximally accept.
3433 * - decoding: set by user
3434 * - encoding: set by user
3436 int64_t max_samples;
3439 * Bit set of AV_CODEC_EXPORT_DATA_* flags, which affects the kind of
3440 * metadata exported in frame, packet, or coded stream side data by
3441 * decoders and encoders.
3443 * - decoding: set by user
3444 * - encoding: set by user
3446 int export_side_data;
3449 #if FF_API_CODEC_GET_SET
3451 * Accessors for some AVCodecContext fields. These used to be provided for ABI
3452 * compatibility, and do not need to be used anymore.
3454 attribute_deprecated
3455 AVRational av_codec_get_pkt_timebase (const AVCodecContext *avctx);
3456 attribute_deprecated
3457 void av_codec_set_pkt_timebase (AVCodecContext *avctx, AVRational val);
3459 attribute_deprecated
3460 const AVCodecDescriptor *av_codec_get_codec_descriptor(const AVCodecContext *avctx);
3461 attribute_deprecated
3462 void av_codec_set_codec_descriptor(AVCodecContext *avctx, const AVCodecDescriptor *desc);
3464 attribute_deprecated
3465 unsigned av_codec_get_codec_properties(const AVCodecContext *avctx);
3468 attribute_deprecated
3469 int av_codec_get_lowres(const AVCodecContext *avctx);
3470 attribute_deprecated
3471 void av_codec_set_lowres(AVCodecContext *avctx, int val);
3474 attribute_deprecated
3475 int av_codec_get_seek_preroll(const AVCodecContext *avctx);
3476 attribute_deprecated
3477 void av_codec_set_seek_preroll(AVCodecContext *avctx, int val);
3479 attribute_deprecated
3480 uint16_t *av_codec_get_chroma_intra_matrix(const AVCodecContext *avctx);
3481 attribute_deprecated
3482 void av_codec_set_chroma_intra_matrix(AVCodecContext *avctx, uint16_t *val);
3488 typedef struct AVProfile {
3490 const char *name; ///< short name for the profile
3495 * The codec supports this format via the hw_device_ctx interface.
3497 * When selecting this format, AVCodecContext.hw_device_ctx should
3498 * have been set to a device of the specified type before calling
3501 AV_CODEC_HW_CONFIG_METHOD_HW_DEVICE_CTX = 0x01,
3503 * The codec supports this format via the hw_frames_ctx interface.
3505 * When selecting this format for a decoder,
3506 * AVCodecContext.hw_frames_ctx should be set to a suitable frames
3507 * context inside the get_format() callback. The frames context
3508 * must have been created on a device of the specified type.
3510 AV_CODEC_HW_CONFIG_METHOD_HW_FRAMES_CTX = 0x02,
3512 * The codec supports this format by some internal method.
3514 * This format can be selected without any additional configuration -
3515 * no device or frames context is required.
3517 AV_CODEC_HW_CONFIG_METHOD_INTERNAL = 0x04,
3519 * The codec supports this format by some ad-hoc method.
3521 * Additional settings and/or function calls are required. See the
3522 * codec-specific documentation for details. (Methods requiring
3523 * this sort of configuration are deprecated and others should be
3524 * used in preference.)
3526 AV_CODEC_HW_CONFIG_METHOD_AD_HOC = 0x08,
3529 typedef struct AVCodecHWConfig {
3531 * A hardware pixel format which the codec can use.
3533 enum AVPixelFormat pix_fmt;
3535 * Bit set of AV_CODEC_HW_CONFIG_METHOD_* flags, describing the possible
3536 * setup methods which can be used with this configuration.
3540 * The device type associated with the configuration.
3542 * Must be set for AV_CODEC_HW_CONFIG_METHOD_HW_DEVICE_CTX and
3543 * AV_CODEC_HW_CONFIG_METHOD_HW_FRAMES_CTX, otherwise unused.
3545 enum AVHWDeviceType device_type;
3548 typedef struct AVCodecDefault AVCodecDefault;
3555 typedef struct AVCodec {
3557 * Name of the codec implementation.
3558 * The name is globally unique among encoders and among decoders (but an
3559 * encoder and a decoder can share the same name).
3560 * This is the primary way to find a codec from the user perspective.
3564 * Descriptive name for the codec, meant to be more human readable than name.
3565 * You should use the NULL_IF_CONFIG_SMALL() macro to define it.
3567 const char *long_name;
3568 enum AVMediaType type;
3571 * Codec capabilities.
3572 * see AV_CODEC_CAP_*
3575 const AVRational *supported_framerates; ///< array of supported framerates, or NULL if any, array is terminated by {0,0}
3576 const enum AVPixelFormat *pix_fmts; ///< array of supported pixel formats, or NULL if unknown, array is terminated by -1
3577 const int *supported_samplerates; ///< array of supported audio samplerates, or NULL if unknown, array is terminated by 0
3578 const enum AVSampleFormat *sample_fmts; ///< array of supported sample formats, or NULL if unknown, array is terminated by -1
3579 const uint64_t *channel_layouts; ///< array of support channel layouts, or NULL if unknown. array is terminated by 0
3580 uint8_t max_lowres; ///< maximum value for lowres supported by the decoder
3581 const AVClass *priv_class; ///< AVClass for the private context
3582 const AVProfile *profiles; ///< array of recognized profiles, or NULL if unknown, array is terminated by {FF_PROFILE_UNKNOWN}
3585 * Group name of the codec implementation.
3586 * This is a short symbolic name of the wrapper backing this codec. A
3587 * wrapper uses some kind of external implementation for the codec, such
3588 * as an external library, or a codec implementation provided by the OS or
3590 * If this field is NULL, this is a builtin, libavcodec native codec.
3591 * If non-NULL, this will be the suffix in AVCodec.name in most cases
3592 * (usually AVCodec.name will be of the form "<codec_name>_<wrapper_name>").
3594 const char *wrapper_name;
3596 /*****************************************************************
3597 * No fields below this line are part of the public API. They
3598 * may not be used outside of libavcodec and can be changed and
3600 * New public fields should be added right above.
3601 *****************************************************************
3604 struct AVCodec *next;
3606 * @name Frame-level threading support functions
3610 * If defined, called on thread contexts when they are created.
3611 * If the codec allocates writable tables in init(), re-allocate them here.
3612 * priv_data will be set to a copy of the original.
3614 int (*init_thread_copy)(AVCodecContext *);
3616 * Copy necessary context variables from a previous thread context to the current one.
3617 * If not defined, the next thread will start automatically; otherwise, the codec
3618 * must call ff_thread_finish_setup().
3620 * dst and src will (rarely) point to the same context, in which case memcpy should be skipped.
3622 int (*update_thread_context)(AVCodecContext *dst, const AVCodecContext *src);
3626 * Private codec-specific defaults.
3628 const AVCodecDefault *defaults;
3631 * Initialize codec static data, called from avcodec_register().
3633 * This is not intended for time consuming operations as it is
3634 * run for every codec regardless of that codec being used.
3636 void (*init_static_data)(struct AVCodec *codec);
3638 int (*init)(AVCodecContext *);
3639 int (*encode_sub)(AVCodecContext *, uint8_t *buf, int buf_size,
3640 const struct AVSubtitle *sub);
3642 * Encode data to an AVPacket.
3644 * @param avctx codec context
3645 * @param avpkt output AVPacket (may contain a user-provided buffer)
3646 * @param[in] frame AVFrame containing the raw data to be encoded
3647 * @param[out] got_packet_ptr encoder sets to 0 or 1 to indicate that a
3648 * non-empty packet was returned in avpkt.
3649 * @return 0 on success, negative error code on failure
3651 int (*encode2)(AVCodecContext *avctx, AVPacket *avpkt, const AVFrame *frame,
3652 int *got_packet_ptr);
3653 int (*decode)(AVCodecContext *, void *outdata, int *outdata_size, AVPacket *avpkt);
3654 int (*close)(AVCodecContext *);
3656 * Encode API with decoupled packet/frame dataflow. The API is the
3657 * same as the avcodec_ prefixed APIs (avcodec_send_frame() etc.), except
3659 * - never called if the codec is closed or the wrong type,
3660 * - if AV_CODEC_CAP_DELAY is not set, drain frames are never sent,
3661 * - only one drain frame is ever passed down,
3663 int (*send_frame)(AVCodecContext *avctx, const AVFrame *frame);
3664 int (*receive_packet)(AVCodecContext *avctx, AVPacket *avpkt);
3667 * Decode API with decoupled packet/frame dataflow. This function is called
3668 * to get one output frame. It should call ff_decode_get_packet() to obtain
3671 int (*receive_frame)(AVCodecContext *avctx, AVFrame *frame);
3674 * Will be called when seeking
3676 void (*flush)(AVCodecContext *);
3678 * Internal codec capabilities.
3679 * See FF_CODEC_CAP_* in internal.h
3684 * Decoding only, a comma-separated list of bitstream filters to apply to
3685 * packets before decoding.
3690 * Array of pointers to hardware configurations supported by the codec,
3691 * or NULL if no hardware supported. The array is terminated by a NULL
3694 * The user can only access this field via avcodec_get_hw_config().
3696 const struct AVCodecHWConfigInternal **hw_configs;
3699 * List of supported codec_tags, terminated by FF_CODEC_TAGS_END.
3701 const uint32_t *codec_tags;
3704 #if FF_API_CODEC_GET_SET
3705 attribute_deprecated
3706 int av_codec_get_max_lowres(const AVCodec *codec);
3709 struct MpegEncContext;
3712 * Retrieve supported hardware configurations for a codec.
3714 * Values of index from zero to some maximum return the indexed configuration
3715 * descriptor; all other values return NULL. If the codec does not support
3716 * any hardware configurations then it will always return NULL.
3718 const AVCodecHWConfig *avcodec_get_hw_config(const AVCodec *codec, int index);
3721 * @defgroup lavc_hwaccel AVHWAccel
3723 * @note Nothing in this structure should be accessed by the user. At some
3724 * point in future it will not be externally visible at all.
3728 typedef struct AVHWAccel {
3730 * Name of the hardware accelerated codec.
3731 * The name is globally unique among encoders and among decoders (but an
3732 * encoder and a decoder can share the same name).
3737 * Type of codec implemented by the hardware accelerator.
3739 * See AVMEDIA_TYPE_xxx
3741 enum AVMediaType type;
3744 * Codec implemented by the hardware accelerator.
3746 * See AV_CODEC_ID_xxx
3751 * Supported pixel format.
3753 * Only hardware accelerated formats are supported here.
3755 enum AVPixelFormat pix_fmt;
3758 * Hardware accelerated codec capabilities.
3759 * see AV_HWACCEL_CODEC_CAP_*
3763 /*****************************************************************
3764 * No fields below this line are part of the public API. They
3765 * may not be used outside of libavcodec and can be changed and
3767 * New public fields should be added right above.
3768 *****************************************************************
3772 * Allocate a custom buffer
3774 int (*alloc_frame)(AVCodecContext *avctx, AVFrame *frame);
3777 * Called at the beginning of each frame or field picture.
3779 * Meaningful frame information (codec specific) is guaranteed to
3780 * be parsed at this point. This function is mandatory.
3782 * Note that buf can be NULL along with buf_size set to 0.
3783 * Otherwise, this means the whole frame is available at this point.
3785 * @param avctx the codec context
3786 * @param buf the frame data buffer base
3787 * @param buf_size the size of the frame in bytes
3788 * @return zero if successful, a negative value otherwise
3790 int (*start_frame)(AVCodecContext *avctx, const uint8_t *buf, uint32_t buf_size);
3793 * Callback for parameter data (SPS/PPS/VPS etc).
3795 * Useful for hardware decoders which keep persistent state about the
3796 * video parameters, and need to receive any changes to update that state.
3798 * @param avctx the codec context
3799 * @param type the nal unit type
3800 * @param buf the nal unit data buffer
3801 * @param buf_size the size of the nal unit in bytes
3802 * @return zero if successful, a negative value otherwise
3804 int (*decode_params)(AVCodecContext *avctx, int type, const uint8_t *buf, uint32_t buf_size);
3807 * Callback for each slice.
3809 * Meaningful slice information (codec specific) is guaranteed to
3810 * be parsed at this point. This function is mandatory.
3811 * The only exception is XvMC, that works on MB level.
3813 * @param avctx the codec context
3814 * @param buf the slice data buffer base
3815 * @param buf_size the size of the slice in bytes
3816 * @return zero if successful, a negative value otherwise
3818 int (*decode_slice)(AVCodecContext *avctx, const uint8_t *buf, uint32_t buf_size);
3821 * Called at the end of each frame or field picture.
3823 * The whole picture is parsed at this point and can now be sent
3824 * to the hardware accelerator. This function is mandatory.
3826 * @param avctx the codec context
3827 * @return zero if successful, a negative value otherwise
3829 int (*end_frame)(AVCodecContext *avctx);
3832 * Size of per-frame hardware accelerator private data.
3834 * Private data is allocated with av_mallocz() before
3835 * AVCodecContext.get_buffer() and deallocated after
3836 * AVCodecContext.release_buffer().
3838 int frame_priv_data_size;
3841 * Called for every Macroblock in a slice.
3843 * XvMC uses it to replace the ff_mpv_reconstruct_mb().
3844 * Instead of decoding to raw picture, MB parameters are
3845 * stored in an array provided by the video driver.
3847 * @param s the mpeg context
3849 void (*decode_mb)(struct MpegEncContext *s);
3852 * Initialize the hwaccel private data.
3854 * This will be called from ff_get_format(), after hwaccel and
3855 * hwaccel_context are set and the hwaccel private data in AVCodecInternal
3858 int (*init)(AVCodecContext *avctx);
3861 * Uninitialize the hwaccel private data.
3863 * This will be called from get_format() or avcodec_close(), after hwaccel
3864 * and hwaccel_context are already uninitialized.
3866 int (*uninit)(AVCodecContext *avctx);
3869 * Size of the private data to allocate in
3870 * AVCodecInternal.hwaccel_priv_data.
3875 * Internal hwaccel capabilities.
3880 * Fill the given hw_frames context with current codec parameters. Called
3881 * from get_format. Refer to avcodec_get_hw_frames_parameters() for
3884 * This CAN be called before AVHWAccel.init is called, and you must assume
3885 * that avctx->hwaccel_priv_data is invalid.
3887 int (*frame_params)(AVCodecContext *avctx, AVBufferRef *hw_frames_ctx);
3891 * HWAccel is experimental and is thus avoided in favor of non experimental
3894 #define AV_HWACCEL_CODEC_CAP_EXPERIMENTAL 0x0200
3897 * Hardware acceleration should be used for decoding even if the codec level
3898 * used is unknown or higher than the maximum supported level reported by the
3901 * It's generally a good idea to pass this flag unless you have a specific
3902 * reason not to, as hardware tends to under-report supported levels.
3904 #define AV_HWACCEL_FLAG_IGNORE_LEVEL (1 << 0)
3907 * Hardware acceleration can output YUV pixel formats with a different chroma
3908 * sampling than 4:2:0 and/or other than 8 bits per component.
3910 #define AV_HWACCEL_FLAG_ALLOW_HIGH_DEPTH (1 << 1)
3913 * Hardware acceleration should still be attempted for decoding when the
3914 * codec profile does not match the reported capabilities of the hardware.
3916 * For example, this can be used to try to decode baseline profile H.264
3917 * streams in hardware - it will often succeed, because many streams marked
3918 * as baseline profile actually conform to constrained baseline profile.
3920 * @warning If the stream is actually not supported then the behaviour is
3921 * undefined, and may include returning entirely incorrect output
3922 * while indicating success.
3924 #define AV_HWACCEL_FLAG_ALLOW_PROFILE_MISMATCH (1 << 2)
3930 #if FF_API_AVPICTURE
3932 * @defgroup lavc_picture AVPicture
3934 * Functions for working with AVPicture
3939 * Picture data structure.
3941 * Up to four components can be stored into it, the last component is
3943 * @deprecated use AVFrame or imgutils functions instead
3945 typedef struct AVPicture {
3946 attribute_deprecated
3947 uint8_t *data[AV_NUM_DATA_POINTERS]; ///< pointers to the image data planes
3948 attribute_deprecated
3949 int linesize[AV_NUM_DATA_POINTERS]; ///< number of bytes per line
3957 enum AVSubtitleType {
3960 SUBTITLE_BITMAP, ///< A bitmap, pict will be set
3963 * Plain text, the text field must be set by the decoder and is
3964 * authoritative. ass and pict fields may contain approximations.
3969 * Formatted text, the ass field must be set by the decoder and is
3970 * authoritative. pict and text fields may contain approximations.
3975 #define AV_SUBTITLE_FLAG_FORCED 0x00000001
3977 typedef struct AVSubtitleRect {
3978 int x; ///< top left corner of pict, undefined when pict is not set
3979 int y; ///< top left corner of pict, undefined when pict is not set
3980 int w; ///< width of pict, undefined when pict is not set
3981 int h; ///< height of pict, undefined when pict is not set
3982 int nb_colors; ///< number of colors in pict, undefined when pict is not set
3984 #if FF_API_AVPICTURE
3986 * @deprecated unused
3988 attribute_deprecated
3992 * data+linesize for the bitmap of this subtitle.
3993 * Can be set for text/ass as well once they are rendered.
3998 enum AVSubtitleType type;
4000 char *text; ///< 0 terminated plain UTF-8 text
4003 * 0 terminated ASS/SSA compatible event line.
4004 * The presentation of this is unaffected by the other values in this
4012 typedef struct AVSubtitle {
4013 uint16_t format; /* 0 = graphics */
4014 uint32_t start_display_time; /* relative to packet pts, in ms */
4015 uint32_t end_display_time; /* relative to packet pts, in ms */
4017 AVSubtitleRect **rects;
4018 int64_t pts; ///< Same as packet pts, in AV_TIME_BASE
4022 * This struct describes the properties of an encoded stream.
4024 * sizeof(AVCodecParameters) is not a part of the public ABI, this struct must
4025 * be allocated with avcodec_parameters_alloc() and freed with
4026 * avcodec_parameters_free().
4028 typedef struct AVCodecParameters {
4030 * General type of the encoded data.
4032 enum AVMediaType codec_type;
4034 * Specific type of the encoded data (the codec used).
4036 enum AVCodecID codec_id;
4038 * Additional information about the codec (corresponds to the AVI FOURCC).
4043 * Extra binary data needed for initializing the decoder, codec-dependent.
4045 * Must be allocated with av_malloc() and will be freed by
4046 * avcodec_parameters_free(). The allocated size of extradata must be at
4047 * least extradata_size + AV_INPUT_BUFFER_PADDING_SIZE, with the padding
4052 * Size of the extradata content in bytes.
4057 * - video: the pixel format, the value corresponds to enum AVPixelFormat.
4058 * - audio: the sample format, the value corresponds to enum AVSampleFormat.
4063 * The average bitrate of the encoded data (in bits per second).
4068 * The number of bits per sample in the codedwords.
4070 * This is basically the bitrate per sample. It is mandatory for a bunch of
4071 * formats to actually decode them. It's the number of bits for one sample in
4072 * the actual coded bitstream.
4074 * This could be for example 4 for ADPCM
4075 * For PCM formats this matches bits_per_raw_sample
4078 int bits_per_coded_sample;
4081 * This is the number of valid bits in each output sample. If the
4082 * sample format has more bits, the least significant bits are additional
4083 * padding bits, which are always 0. Use right shifts to reduce the sample
4084 * to its actual size. For example, audio formats with 24 bit samples will
4085 * have bits_per_raw_sample set to 24, and format set to AV_SAMPLE_FMT_S32.
4086 * To get the original sample use "(int32_t)sample >> 8"."
4088 * For ADPCM this might be 12 or 16 or similar
4091 int bits_per_raw_sample;
4094 * Codec-specific bitstream restrictions that the stream conforms to.
4100 * Video only. The dimensions of the video frame in pixels.
4106 * Video only. The aspect ratio (width / height) which a single pixel
4107 * should have when displayed.
4109 * When the aspect ratio is unknown / undefined, the numerator should be
4110 * set to 0 (the denominator may have any value).
4112 AVRational sample_aspect_ratio;
4115 * Video only. The order of the fields in interlaced video.
4117 enum AVFieldOrder field_order;
4120 * Video only. Additional colorspace characteristics.
4122 enum AVColorRange color_range;
4123 enum AVColorPrimaries color_primaries;
4124 enum AVColorTransferCharacteristic color_trc;
4125 enum AVColorSpace color_space;
4126 enum AVChromaLocation chroma_location;
4129 * Video only. Number of delayed frames.
4134 * Audio only. The channel layout bitmask. May be 0 if the channel layout is
4135 * unknown or unspecified, otherwise the number of bits set must be equal to
4136 * the channels field.
4138 uint64_t channel_layout;
4140 * Audio only. The number of audio channels.
4144 * Audio only. The number of audio samples per second.
4148 * Audio only. The number of bytes per coded audio frame, required by some
4151 * Corresponds to nBlockAlign in WAVEFORMATEX.
4155 * Audio only. Audio frame size, if known. Required by some formats to be static.
4160 * Audio only. The amount of padding (in samples) inserted by the encoder at
4161 * the beginning of the audio. I.e. this number of leading decoded samples
4162 * must be discarded by the caller to get the original audio without leading
4165 int initial_padding;
4167 * Audio only. The amount of padding (in samples) appended by the encoder to
4168 * the end of the audio. I.e. this number of decoded samples must be
4169 * discarded by the caller from the end of the stream to get the original
4170 * audio without any trailing padding.
4172 int trailing_padding;
4174 * Audio only. Number of samples to skip after a discontinuity.
4177 } AVCodecParameters;
4180 * Iterate over all registered codecs.
4182 * @param opaque a pointer where libavcodec will store the iteration state. Must
4183 * point to NULL to start the iteration.
4185 * @return the next registered codec or NULL when the iteration is
4188 const AVCodec *av_codec_iterate(void **opaque);
4192 * If c is NULL, returns the first registered codec,
4193 * if c is non-NULL, returns the next registered codec after c,
4194 * or NULL if c is the last one.
4196 attribute_deprecated
4197 AVCodec *av_codec_next(const AVCodec *c);
4201 * Return the LIBAVCODEC_VERSION_INT constant.
4203 unsigned avcodec_version(void);
4206 * Return the libavcodec build-time configuration.
4208 const char *avcodec_configuration(void);
4211 * Return the libavcodec license.
4213 const char *avcodec_license(void);
4217 * Register the codec codec and initialize libavcodec.
4219 * @warning either this function or avcodec_register_all() must be called
4220 * before any other libavcodec functions.
4222 * @see avcodec_register_all()
4224 attribute_deprecated
4225 void avcodec_register(AVCodec *codec);
4228 * Register all the codecs, parsers and bitstream filters which were enabled at
4229 * configuration time. If you do not call this function you can select exactly
4230 * which formats you want to support, by using the individual registration
4233 * @see avcodec_register
4234 * @see av_register_codec_parser
4235 * @see av_register_bitstream_filter
4237 attribute_deprecated
4238 void avcodec_register_all(void);
4242 * Allocate an AVCodecContext and set its fields to default values. The
4243 * resulting struct should be freed with avcodec_free_context().
4245 * @param codec if non-NULL, allocate private data and initialize defaults
4246 * for the given codec. It is illegal to then call avcodec_open2()
4247 * with a different codec.
4248 * If NULL, then the codec-specific defaults won't be initialized,
4249 * which may result in suboptimal default settings (this is
4250 * important mainly for encoders, e.g. libx264).
4252 * @return An AVCodecContext filled with default values or NULL on failure.
4254 AVCodecContext *avcodec_alloc_context3(const AVCodec *codec);
4257 * Free the codec context and everything associated with it and write NULL to
4258 * the provided pointer.
4260 void avcodec_free_context(AVCodecContext **avctx);
4262 #if FF_API_GET_CONTEXT_DEFAULTS
4264 * @deprecated This function should not be used, as closing and opening a codec
4265 * context multiple time is not supported. A new codec context should be
4266 * allocated for each new use.
4268 int avcodec_get_context_defaults3(AVCodecContext *s, const AVCodec *codec);
4272 * Get the AVClass for AVCodecContext. It can be used in combination with
4273 * AV_OPT_SEARCH_FAKE_OBJ for examining options.
4275 * @see av_opt_find().
4277 const AVClass *avcodec_get_class(void);
4279 #if FF_API_COPY_CONTEXT
4281 * Get the AVClass for AVFrame. It can be used in combination with
4282 * AV_OPT_SEARCH_FAKE_OBJ for examining options.
4284 * @see av_opt_find().
4286 const AVClass *avcodec_get_frame_class(void);
4289 * Get the AVClass for AVSubtitleRect. It can be used in combination with
4290 * AV_OPT_SEARCH_FAKE_OBJ for examining options.
4292 * @see av_opt_find().
4294 const AVClass *avcodec_get_subtitle_rect_class(void);
4297 * Copy the settings of the source AVCodecContext into the destination
4298 * AVCodecContext. The resulting destination codec context will be
4299 * unopened, i.e. you are required to call avcodec_open2() before you
4300 * can use this AVCodecContext to decode/encode video/audio data.
4302 * @param dest target codec context, should be initialized with
4303 * avcodec_alloc_context3(NULL), but otherwise uninitialized
4304 * @param src source codec context
4305 * @return AVERROR() on error (e.g. memory allocation error), 0 on success
4307 * @deprecated The semantics of this function are ill-defined and it should not
4308 * be used. If you need to transfer the stream parameters from one codec context
4309 * to another, use an intermediate AVCodecParameters instance and the
4310 * avcodec_parameters_from_context() / avcodec_parameters_to_context()
4313 attribute_deprecated
4314 int avcodec_copy_context(AVCodecContext *dest, const AVCodecContext *src);
4318 * Allocate a new AVCodecParameters and set its fields to default values
4319 * (unknown/invalid/0). The returned struct must be freed with
4320 * avcodec_parameters_free().
4322 AVCodecParameters *avcodec_parameters_alloc(void);
4325 * Free an AVCodecParameters instance and everything associated with it and
4326 * write NULL to the supplied pointer.
4328 void avcodec_parameters_free(AVCodecParameters **par);
4331 * Copy the contents of src to dst. Any allocated fields in dst are freed and
4332 * replaced with newly allocated duplicates of the corresponding fields in src.
4334 * @return >= 0 on success, a negative AVERROR code on failure.
4336 int avcodec_parameters_copy(AVCodecParameters *dst, const AVCodecParameters *src);
4339 * Fill the parameters struct based on the values from the supplied codec
4340 * context. Any allocated fields in par are freed and replaced with duplicates
4341 * of the corresponding fields in codec.
4343 * @return >= 0 on success, a negative AVERROR code on failure
4345 int avcodec_parameters_from_context(AVCodecParameters *par,
4346 const AVCodecContext *codec);
4349 * Fill the codec context based on the values from the supplied codec
4350 * parameters. Any allocated fields in codec that have a corresponding field in
4351 * par are freed and replaced with duplicates of the corresponding field in par.
4352 * Fields in codec that do not have a counterpart in par are not touched.
4354 * @return >= 0 on success, a negative AVERROR code on failure.
4356 int avcodec_parameters_to_context(AVCodecContext *codec,
4357 const AVCodecParameters *par);
4360 * Initialize the AVCodecContext to use the given AVCodec. Prior to using this
4361 * function the context has to be allocated with avcodec_alloc_context3().
4363 * The functions avcodec_find_decoder_by_name(), avcodec_find_encoder_by_name(),
4364 * avcodec_find_decoder() and avcodec_find_encoder() provide an easy way for
4365 * retrieving a codec.
4367 * @warning This function is not thread safe!
4369 * @note Always call this function before using decoding routines (such as
4370 * @ref avcodec_receive_frame()).
4373 * avcodec_register_all();
4374 * av_dict_set(&opts, "b", "2.5M", 0);
4375 * codec = avcodec_find_decoder(AV_CODEC_ID_H264);
4379 * context = avcodec_alloc_context3(codec);
4381 * if (avcodec_open2(context, codec, opts) < 0)
4385 * @param avctx The context to initialize.
4386 * @param codec The codec to open this context for. If a non-NULL codec has been
4387 * previously passed to avcodec_alloc_context3() or
4388 * for this context, then this parameter MUST be either NULL or
4389 * equal to the previously passed codec.
4390 * @param options A dictionary filled with AVCodecContext and codec-private options.
4391 * On return this object will be filled with options that were not found.
4393 * @return zero on success, a negative value on error
4394 * @see avcodec_alloc_context3(), avcodec_find_decoder(), avcodec_find_encoder(),
4395 * av_dict_set(), av_opt_find().
4397 int avcodec_open2(AVCodecContext *avctx, const AVCodec *codec, AVDictionary **options);
4400 * Close a given AVCodecContext and free all the data associated with it
4401 * (but not the AVCodecContext itself).
4403 * Calling this function on an AVCodecContext that hasn't been opened will free
4404 * the codec-specific data allocated in avcodec_alloc_context3() with a non-NULL
4405 * codec. Subsequent calls will do nothing.
4407 * @note Do not use this function. Use avcodec_free_context() to destroy a
4408 * codec context (either open or closed). Opening and closing a codec context
4409 * multiple times is not supported anymore -- use multiple codec contexts
4412 int avcodec_close(AVCodecContext *avctx);
4415 * Free all allocated data in the given subtitle struct.
4417 * @param sub AVSubtitle to free.
4419 void avsubtitle_free(AVSubtitle *sub);
4426 * @addtogroup lavc_packet
4431 * Allocate an AVPacket and set its fields to default values. The resulting
4432 * struct must be freed using av_packet_free().
4434 * @return An AVPacket filled with default values or NULL on failure.
4436 * @note this only allocates the AVPacket itself, not the data buffers. Those
4437 * must be allocated through other means such as av_new_packet.
4439 * @see av_new_packet
4441 AVPacket *av_packet_alloc(void);
4444 * Create a new packet that references the same data as src.
4446 * This is a shortcut for av_packet_alloc()+av_packet_ref().
4448 * @return newly created AVPacket on success, NULL on error.
4450 * @see av_packet_alloc
4451 * @see av_packet_ref
4453 AVPacket *av_packet_clone(const AVPacket *src);
4456 * Free the packet, if the packet is reference counted, it will be
4457 * unreferenced first.
4459 * @param pkt packet to be freed. The pointer will be set to NULL.
4460 * @note passing NULL is a no-op.
4462 void av_packet_free(AVPacket **pkt);
4465 * Initialize optional fields of a packet with default values.
4467 * Note, this does not touch the data and size members, which have to be
4468 * initialized separately.
4472 void av_init_packet(AVPacket *pkt);
4475 * Allocate the payload of a packet and initialize its fields with
4479 * @param size wanted payload size
4480 * @return 0 if OK, AVERROR_xxx otherwise
4482 int av_new_packet(AVPacket *pkt, int size);
4485 * Reduce packet size, correctly zeroing padding
4488 * @param size new size
4490 void av_shrink_packet(AVPacket *pkt, int size);
4493 * Increase packet size, correctly zeroing padding
4496 * @param grow_by number of bytes by which to increase the size of the packet
4498 int av_grow_packet(AVPacket *pkt, int grow_by);
4501 * Initialize a reference-counted packet from av_malloc()ed data.
4503 * @param pkt packet to be initialized. This function will set the data, size,
4504 * and buf fields, all others are left untouched.
4505 * @param data Data allocated by av_malloc() to be used as packet data. If this
4506 * function returns successfully, the data is owned by the underlying AVBuffer.
4507 * The caller may not access the data through other means.
4508 * @param size size of data in bytes, without the padding. I.e. the full buffer
4509 * size is assumed to be size + AV_INPUT_BUFFER_PADDING_SIZE.
4511 * @return 0 on success, a negative AVERROR on error
4513 int av_packet_from_data(AVPacket *pkt, uint8_t *data, int size);
4515 #if FF_API_AVPACKET_OLD_API
4517 * @warning This is a hack - the packet memory allocation stuff is broken. The
4518 * packet is allocated if it was not really allocated.
4520 * @deprecated Use av_packet_ref or av_packet_make_refcounted
4522 attribute_deprecated
4523 int av_dup_packet(AVPacket *pkt);
4525 * Copy packet, including contents
4527 * @return 0 on success, negative AVERROR on fail
4529 * @deprecated Use av_packet_ref
4531 attribute_deprecated
4532 int av_copy_packet(AVPacket *dst, const AVPacket *src);
4535 * Copy packet side data
4537 * @return 0 on success, negative AVERROR on fail
4539 * @deprecated Use av_packet_copy_props
4541 attribute_deprecated
4542 int av_copy_packet_side_data(AVPacket *dst, const AVPacket *src);
4547 * @deprecated Use av_packet_unref
4549 * @param pkt packet to free
4551 attribute_deprecated
4552 void av_free_packet(AVPacket *pkt);
4555 * Allocate new information of a packet.
4558 * @param type side information type
4559 * @param size side information size
4560 * @return pointer to fresh allocated data or NULL otherwise
4562 uint8_t* av_packet_new_side_data(AVPacket *pkt, enum AVPacketSideDataType type,
4566 * Wrap an existing array as a packet side data.
4569 * @param type side information type
4570 * @param data the side data array. It must be allocated with the av_malloc()
4571 * family of functions. The ownership of the data is transferred to
4573 * @param size side information size
4574 * @return a non-negative number on success, a negative AVERROR code on
4575 * failure. On failure, the packet is unchanged and the data remains
4576 * owned by the caller.
4578 int av_packet_add_side_data(AVPacket *pkt, enum AVPacketSideDataType type,
4579 uint8_t *data, size_t size);
4582 * Shrink the already allocated side data buffer
4585 * @param type side information type
4586 * @param size new side information size
4587 * @return 0 on success, < 0 on failure
4589 int av_packet_shrink_side_data(AVPacket *pkt, enum AVPacketSideDataType type,
4593 * Get side information from packet.
4596 * @param type desired side information type
4597 * @param size pointer for side information size to store (optional)
4598 * @return pointer to data if present or NULL otherwise
4600 uint8_t* av_packet_get_side_data(const AVPacket *pkt, enum AVPacketSideDataType type,
4603 #if FF_API_MERGE_SD_API
4604 attribute_deprecated
4605 int av_packet_merge_side_data(AVPacket *pkt);
4607 attribute_deprecated
4608 int av_packet_split_side_data(AVPacket *pkt);
4611 const char *av_packet_side_data_name(enum AVPacketSideDataType type);
4614 * Pack a dictionary for use in side_data.
4616 * @param dict The dictionary to pack.
4617 * @param size pointer to store the size of the returned data
4618 * @return pointer to data if successful, NULL otherwise
4620 uint8_t *av_packet_pack_dictionary(AVDictionary *dict, int *size);
4622 * Unpack a dictionary from side_data.
4624 * @param data data from side_data
4625 * @param size size of the data
4626 * @param dict the metadata storage dictionary
4627 * @return 0 on success, < 0 on failure
4629 int av_packet_unpack_dictionary(const uint8_t *data, int size, AVDictionary **dict);
4633 * Convenience function to free all the side data stored.
4634 * All the other fields stay untouched.
4638 void av_packet_free_side_data(AVPacket *pkt);
4641 * Setup a new reference to the data described by a given packet
4643 * If src is reference-counted, setup dst as a new reference to the
4644 * buffer in src. Otherwise allocate a new buffer in dst and copy the
4645 * data from src into it.
4647 * All the other fields are copied from src.
4649 * @see av_packet_unref
4651 * @param dst Destination packet
4652 * @param src Source packet
4654 * @return 0 on success, a negative AVERROR on error.
4656 int av_packet_ref(AVPacket *dst, const AVPacket *src);
4661 * Unreference the buffer referenced by the packet and reset the
4662 * remaining packet fields to their default values.
4664 * @param pkt The packet to be unreferenced.
4666 void av_packet_unref(AVPacket *pkt);
4669 * Move every field in src to dst and reset src.
4671 * @see av_packet_unref
4673 * @param src Source packet, will be reset
4674 * @param dst Destination packet
4676 void av_packet_move_ref(AVPacket *dst, AVPacket *src);
4679 * Copy only "properties" fields from src to dst.
4681 * Properties for the purpose of this function are all the fields
4682 * beside those related to the packet data (buf, data, size)
4684 * @param dst Destination packet
4685 * @param src Source packet
4687 * @return 0 on success AVERROR on failure.
4689 int av_packet_copy_props(AVPacket *dst, const AVPacket *src);
4692 * Ensure the data described by a given packet is reference counted.
4694 * @note This function does not ensure that the reference will be writable.
4695 * Use av_packet_make_writable instead for that purpose.
4697 * @see av_packet_ref
4698 * @see av_packet_make_writable
4700 * @param pkt packet whose data should be made reference counted.
4702 * @return 0 on success, a negative AVERROR on error. On failure, the
4703 * packet is unchanged.
4705 int av_packet_make_refcounted(AVPacket *pkt);
4708 * Create a writable reference for the data described by a given packet,
4709 * avoiding data copy if possible.
4711 * @param pkt Packet whose data should be made writable.
4713 * @return 0 on success, a negative AVERROR on failure. On failure, the
4714 * packet is unchanged.
4716 int av_packet_make_writable(AVPacket *pkt);
4719 * Convert valid timing fields (timestamps / durations) in a packet from one
4720 * timebase to another. Timestamps with unknown values (AV_NOPTS_VALUE) will be
4723 * @param pkt packet on which the conversion will be performed
4724 * @param tb_src source timebase, in which the timing fields in pkt are
4726 * @param tb_dst destination timebase, to which the timing fields will be
4729 void av_packet_rescale_ts(AVPacket *pkt, AVRational tb_src, AVRational tb_dst);
4736 * @addtogroup lavc_decoding
4741 * Find a registered decoder with a matching codec ID.
4743 * @param id AVCodecID of the requested decoder
4744 * @return A decoder if one was found, NULL otherwise.
4746 AVCodec *avcodec_find_decoder(enum AVCodecID id);
4749 * Find a registered decoder with the specified name.
4751 * @param name name of the requested decoder
4752 * @return A decoder if one was found, NULL otherwise.
4754 AVCodec *avcodec_find_decoder_by_name(const char *name);
4757 * The default callback for AVCodecContext.get_buffer2(). It is made public so
4758 * it can be called by custom get_buffer2() implementations for decoders without
4759 * AV_CODEC_CAP_DR1 set.
4761 int avcodec_default_get_buffer2(AVCodecContext *s, AVFrame *frame, int flags);
4764 * Modify width and height values so that they will result in a memory
4765 * buffer that is acceptable for the codec if you do not use any horizontal
4768 * May only be used if a codec with AV_CODEC_CAP_DR1 has been opened.
4770 void avcodec_align_dimensions(AVCodecContext *s, int *width, int *height);
4773 * Modify width and height values so that they will result in a memory
4774 * buffer that is acceptable for the codec if you also ensure that all
4775 * line sizes are a multiple of the respective linesize_align[i].
4777 * May only be used if a codec with AV_CODEC_CAP_DR1 has been opened.
4779 void avcodec_align_dimensions2(AVCodecContext *s, int *width, int *height,
4780 int linesize_align[AV_NUM_DATA_POINTERS]);
4783 * Converts AVChromaLocation to swscale x/y chroma position.
4785 * The positions represent the chroma (0,0) position in a coordinates system
4786 * with luma (0,0) representing the origin and luma(1,1) representing 256,256
4788 * @param xpos horizontal chroma sample position
4789 * @param ypos vertical chroma sample position
4791 int avcodec_enum_to_chroma_pos(int *xpos, int *ypos, enum AVChromaLocation pos);
4794 * Converts swscale x/y chroma position to AVChromaLocation.
4796 * The positions represent the chroma (0,0) position in a coordinates system
4797 * with luma (0,0) representing the origin and luma(1,1) representing 256,256
4799 * @param xpos horizontal chroma sample position
4800 * @param ypos vertical chroma sample position
4802 enum AVChromaLocation avcodec_chroma_pos_to_enum(int xpos, int ypos);
4805 * Decode the audio frame of size avpkt->size from avpkt->data into frame.
4807 * Some decoders may support multiple frames in a single AVPacket. Such
4808 * decoders would then just decode the first frame and the return value would be
4809 * less than the packet size. In this case, avcodec_decode_audio4 has to be
4810 * called again with an AVPacket containing the remaining data in order to
4811 * decode the second frame, etc... Even if no frames are returned, the packet
4812 * needs to be fed to the decoder with remaining data until it is completely
4813 * consumed or an error occurs.
4815 * Some decoders (those marked with AV_CODEC_CAP_DELAY) have a delay between input
4816 * and output. This means that for some packets they will not immediately
4817 * produce decoded output and need to be flushed at the end of decoding to get
4818 * all the decoded data. Flushing is done by calling this function with packets
4819 * with avpkt->data set to NULL and avpkt->size set to 0 until it stops
4820 * returning samples. It is safe to flush even those decoders that are not
4821 * marked with AV_CODEC_CAP_DELAY, then no samples will be returned.
4823 * @warning The input buffer, avpkt->data must be AV_INPUT_BUFFER_PADDING_SIZE
4824 * larger than the actual read bytes because some optimized bitstream
4825 * readers read 32 or 64 bits at once and could read over the end.
4827 * @note The AVCodecContext MUST have been opened with @ref avcodec_open2()
4828 * before packets may be fed to the decoder.
4830 * @param avctx the codec context
4831 * @param[out] frame The AVFrame in which to store decoded audio samples.
4832 * The decoder will allocate a buffer for the decoded frame by
4833 * calling the AVCodecContext.get_buffer2() callback.
4834 * When AVCodecContext.refcounted_frames is set to 1, the frame is
4835 * reference counted and the returned reference belongs to the
4836 * caller. The caller must release the frame using av_frame_unref()
4837 * when the frame is no longer needed. The caller may safely write
4838 * to the frame if av_frame_is_writable() returns 1.
4839 * When AVCodecContext.refcounted_frames is set to 0, the returned
4840 * reference belongs to the decoder and is valid only until the
4841 * next call to this function or until closing or flushing the
4842 * decoder. The caller may not write to it.
4843 * @param[out] got_frame_ptr Zero if no frame could be decoded, otherwise it is
4844 * non-zero. Note that this field being set to zero
4845 * does not mean that an error has occurred. For
4846 * decoders with AV_CODEC_CAP_DELAY set, no given decode
4847 * call is guaranteed to produce a frame.
4848 * @param[in] avpkt The input AVPacket containing the input buffer.
4849 * At least avpkt->data and avpkt->size should be set. Some
4850 * decoders might also require additional fields to be set.
4851 * @return A negative error code is returned if an error occurred during
4852 * decoding, otherwise the number of bytes consumed from the input
4853 * AVPacket is returned.
4855 * @deprecated Use avcodec_send_packet() and avcodec_receive_frame().
4857 attribute_deprecated
4858 int avcodec_decode_audio4(AVCodecContext *avctx, AVFrame *frame,
4859 int *got_frame_ptr, const AVPacket *avpkt);
4862 * Decode the video frame of size avpkt->size from avpkt->data into picture.
4863 * Some decoders may support multiple frames in a single AVPacket, such
4864 * decoders would then just decode the first frame.
4866 * @warning The input buffer must be AV_INPUT_BUFFER_PADDING_SIZE larger than
4867 * the actual read bytes because some optimized bitstream readers read 32 or 64
4868 * bits at once and could read over the end.
4870 * @warning The end of the input buffer buf should be set to 0 to ensure that
4871 * no overreading happens for damaged MPEG streams.
4873 * @note Codecs which have the AV_CODEC_CAP_DELAY capability set have a delay
4874 * between input and output, these need to be fed with avpkt->data=NULL,
4875 * avpkt->size=0 at the end to return the remaining frames.
4877 * @note The AVCodecContext MUST have been opened with @ref avcodec_open2()
4878 * before packets may be fed to the decoder.
4880 * @param avctx the codec context
4881 * @param[out] picture The AVFrame in which the decoded video frame will be stored.
4882 * Use av_frame_alloc() to get an AVFrame. The codec will
4883 * allocate memory for the actual bitmap by calling the
4884 * AVCodecContext.get_buffer2() callback.
4885 * When AVCodecContext.refcounted_frames is set to 1, the frame is
4886 * reference counted and the returned reference belongs to the
4887 * caller. The caller must release the frame using av_frame_unref()
4888 * when the frame is no longer needed. The caller may safely write
4889 * to the frame if av_frame_is_writable() returns 1.
4890 * When AVCodecContext.refcounted_frames is set to 0, the returned
4891 * reference belongs to the decoder and is valid only until the
4892 * next call to this function or until closing or flushing the
4893 * decoder. The caller may not write to it.
4895 * @param[in] avpkt The input AVPacket containing the input buffer.
4896 * You can create such packet with av_init_packet() and by then setting
4897 * data and size, some decoders might in addition need other fields like
4898 * flags&AV_PKT_FLAG_KEY. All decoders are designed to use the least
4900 * @param[in,out] got_picture_ptr Zero if no frame could be decompressed, otherwise, it is nonzero.
4901 * @return On error a negative value is returned, otherwise the number of bytes
4902 * used or zero if no frame could be decompressed.
4904 * @deprecated Use avcodec_send_packet() and avcodec_receive_frame().
4906 attribute_deprecated
4907 int avcodec_decode_video2(AVCodecContext *avctx, AVFrame *picture,
4908 int *got_picture_ptr,
4909 const AVPacket *avpkt);
4912 * Decode a subtitle message.
4913 * Return a negative value on error, otherwise return the number of bytes used.
4914 * If no subtitle could be decompressed, got_sub_ptr is zero.
4915 * Otherwise, the subtitle is stored in *sub.
4916 * Note that AV_CODEC_CAP_DR1 is not available for subtitle codecs. This is for
4917 * simplicity, because the performance difference is expected to be negligible
4918 * and reusing a get_buffer written for video codecs would probably perform badly
4919 * due to a potentially very different allocation pattern.
4921 * Some decoders (those marked with AV_CODEC_CAP_DELAY) have a delay between input
4922 * and output. This means that for some packets they will not immediately
4923 * produce decoded output and need to be flushed at the end of decoding to get
4924 * all the decoded data. Flushing is done by calling this function with packets
4925 * with avpkt->data set to NULL and avpkt->size set to 0 until it stops
4926 * returning subtitles. It is safe to flush even those decoders that are not
4927 * marked with AV_CODEC_CAP_DELAY, then no subtitles will be returned.
4929 * @note The AVCodecContext MUST have been opened with @ref avcodec_open2()
4930 * before packets may be fed to the decoder.
4932 * @param avctx the codec context
4933 * @param[out] sub The preallocated AVSubtitle in which the decoded subtitle will be stored,
4934 * must be freed with avsubtitle_free if *got_sub_ptr is set.
4935 * @param[in,out] got_sub_ptr Zero if no subtitle could be decompressed, otherwise, it is nonzero.
4936 * @param[in] avpkt The input AVPacket containing the input buffer.
4938 int avcodec_decode_subtitle2(AVCodecContext *avctx, AVSubtitle *sub,
4943 * Supply raw packet data as input to a decoder.
4945 * Internally, this call will copy relevant AVCodecContext fields, which can
4946 * influence decoding per-packet, and apply them when the packet is actually
4947 * decoded. (For example AVCodecContext.skip_frame, which might direct the
4948 * decoder to drop the frame contained by the packet sent with this function.)
4950 * @warning The input buffer, avpkt->data must be AV_INPUT_BUFFER_PADDING_SIZE
4951 * larger than the actual read bytes because some optimized bitstream
4952 * readers read 32 or 64 bits at once and could read over the end.
4954 * @warning Do not mix this API with the legacy API (like avcodec_decode_video2())
4955 * on the same AVCodecContext. It will return unexpected results now
4956 * or in future libavcodec versions.
4958 * @note The AVCodecContext MUST have been opened with @ref avcodec_open2()
4959 * before packets may be fed to the decoder.
4961 * @param avctx codec context
4962 * @param[in] avpkt The input AVPacket. Usually, this will be a single video
4963 * frame, or several complete audio frames.
4964 * Ownership of the packet remains with the caller, and the
4965 * decoder will not write to the packet. The decoder may create
4966 * a reference to the packet data (or copy it if the packet is
4967 * not reference-counted).
4968 * Unlike with older APIs, the packet is always fully consumed,
4969 * and if it contains multiple frames (e.g. some audio codecs),
4970 * will require you to call avcodec_receive_frame() multiple
4971 * times afterwards before you can send a new packet.
4972 * It can be NULL (or an AVPacket with data set to NULL and
4973 * size set to 0); in this case, it is considered a flush
4974 * packet, which signals the end of the stream. Sending the
4975 * first flush packet will return success. Subsequent ones are
4976 * unnecessary and will return AVERROR_EOF. If the decoder
4977 * still has frames buffered, it will return them after sending
4980 * @return 0 on success, otherwise negative error code:
4981 * AVERROR(EAGAIN): input is not accepted in the current state - user
4982 * must read output with avcodec_receive_frame() (once
4983 * all output is read, the packet should be resent, and
4984 * the call will not fail with EAGAIN).
4985 * AVERROR_EOF: the decoder has been flushed, and no new packets can
4986 * be sent to it (also returned if more than 1 flush
4988 * AVERROR(EINVAL): codec not opened, it is an encoder, or requires flush
4989 * AVERROR(ENOMEM): failed to add packet to internal queue, or similar
4990 * other errors: legitimate decoding errors
4992 int avcodec_send_packet(AVCodecContext *avctx, const AVPacket *avpkt);
4995 * Return decoded output data from a decoder.
4997 * @param avctx codec context
4998 * @param frame This will be set to a reference-counted video or audio
4999 * frame (depending on the decoder type) allocated by the
5000 * decoder. Note that the function will always call
5001 * av_frame_unref(frame) before doing anything else.
5004 * 0: success, a frame was returned
5005 * AVERROR(EAGAIN): output is not available in this state - user must try
5007 * AVERROR_EOF: the decoder has been fully flushed, and there will be
5008 * no more output frames
5009 * AVERROR(EINVAL): codec not opened, or it is an encoder
5010 * AVERROR_INPUT_CHANGED: current decoded frame has changed parameters
5011 * with respect to first decoded frame. Applicable
5012 * when flag AV_CODEC_FLAG_DROPCHANGED is set.
5013 * other negative values: legitimate decoding errors
5015 int avcodec_receive_frame(AVCodecContext *avctx, AVFrame *frame);
5018 * Supply a raw video or audio frame to the encoder. Use avcodec_receive_packet()
5019 * to retrieve buffered output packets.
5021 * @param avctx codec context
5022 * @param[in] frame AVFrame containing the raw audio or video frame to be encoded.
5023 * Ownership of the frame remains with the caller, and the
5024 * encoder will not write to the frame. The encoder may create
5025 * a reference to the frame data (or copy it if the frame is
5026 * not reference-counted).
5027 * It can be NULL, in which case it is considered a flush
5028 * packet. This signals the end of the stream. If the encoder
5029 * still has packets buffered, it will return them after this
5030 * call. Once flushing mode has been entered, additional flush
5031 * packets are ignored, and sending frames will return
5035 * If AV_CODEC_CAP_VARIABLE_FRAME_SIZE is set, then each frame
5036 * can have any number of samples.
5037 * If it is not set, frame->nb_samples must be equal to
5038 * avctx->frame_size for all frames except the last.
5039 * The final frame may be smaller than avctx->frame_size.
5040 * @return 0 on success, otherwise negative error code:
5041 * AVERROR(EAGAIN): input is not accepted in the current state - user
5042 * must read output with avcodec_receive_packet() (once
5043 * all output is read, the packet should be resent, and
5044 * the call will not fail with EAGAIN).
5045 * AVERROR_EOF: the encoder has been flushed, and no new frames can
5047 * AVERROR(EINVAL): codec not opened, refcounted_frames not set, it is a
5048 * decoder, or requires flush
5049 * AVERROR(ENOMEM): failed to add packet to internal queue, or similar
5050 * other errors: legitimate encoding errors
5052 int avcodec_send_frame(AVCodecContext *avctx, const AVFrame *frame);
5055 * Read encoded data from the encoder.
5057 * @param avctx codec context
5058 * @param avpkt This will be set to a reference-counted packet allocated by the
5059 * encoder. Note that the function will always call
5060 * av_packet_unref(avpkt) before doing anything else.
5061 * @return 0 on success, otherwise negative error code:
5062 * AVERROR(EAGAIN): output is not available in the current state - user
5063 * must try to send input
5064 * AVERROR_EOF: the encoder has been fully flushed, and there will be
5065 * no more output packets
5066 * AVERROR(EINVAL): codec not opened, or it is a decoder
5067 * other errors: legitimate encoding errors
5069 int avcodec_receive_packet(AVCodecContext *avctx, AVPacket *avpkt);
5072 * Create and return a AVHWFramesContext with values adequate for hardware
5073 * decoding. This is meant to get called from the get_format callback, and is
5074 * a helper for preparing a AVHWFramesContext for AVCodecContext.hw_frames_ctx.
5075 * This API is for decoding with certain hardware acceleration modes/APIs only.
5077 * The returned AVHWFramesContext is not initialized. The caller must do this
5078 * with av_hwframe_ctx_init().
5080 * Calling this function is not a requirement, but makes it simpler to avoid
5081 * codec or hardware API specific details when manually allocating frames.
5083 * Alternatively to this, an API user can set AVCodecContext.hw_device_ctx,
5084 * which sets up AVCodecContext.hw_frames_ctx fully automatically, and makes
5085 * it unnecessary to call this function or having to care about
5086 * AVHWFramesContext initialization at all.
5088 * There are a number of requirements for calling this function:
5090 * - It must be called from get_format with the same avctx parameter that was
5091 * passed to get_format. Calling it outside of get_format is not allowed, and
5092 * can trigger undefined behavior.
5093 * - The function is not always supported (see description of return values).
5094 * Even if this function returns successfully, hwaccel initialization could
5095 * fail later. (The degree to which implementations check whether the stream
5096 * is actually supported varies. Some do this check only after the user's
5097 * get_format callback returns.)
5098 * - The hw_pix_fmt must be one of the choices suggested by get_format. If the
5099 * user decides to use a AVHWFramesContext prepared with this API function,
5100 * the user must return the same hw_pix_fmt from get_format.
5101 * - The device_ref passed to this function must support the given hw_pix_fmt.
5102 * - After calling this API function, it is the user's responsibility to
5103 * initialize the AVHWFramesContext (returned by the out_frames_ref parameter),
5104 * and to set AVCodecContext.hw_frames_ctx to it. If done, this must be done
5105 * before returning from get_format (this is implied by the normal
5106 * AVCodecContext.hw_frames_ctx API rules).
5107 * - The AVHWFramesContext parameters may change every time time get_format is
5108 * called. Also, AVCodecContext.hw_frames_ctx is reset before get_format. So
5109 * you are inherently required to go through this process again on every
5111 * - It is perfectly possible to call this function without actually using
5112 * the resulting AVHWFramesContext. One use-case might be trying to reuse a
5113 * previously initialized AVHWFramesContext, and calling this API function
5114 * only to test whether the required frame parameters have changed.
5115 * - Fields that use dynamically allocated values of any kind must not be set
5116 * by the user unless setting them is explicitly allowed by the documentation.
5117 * If the user sets AVHWFramesContext.free and AVHWFramesContext.user_opaque,
5118 * the new free callback must call the potentially set previous free callback.
5119 * This API call may set any dynamically allocated fields, including the free
5122 * The function will set at least the following fields on AVHWFramesContext
5123 * (potentially more, depending on hwaccel API):
5125 * - All fields set by av_hwframe_ctx_alloc().
5126 * - Set the format field to hw_pix_fmt.
5127 * - Set the sw_format field to the most suited and most versatile format. (An
5128 * implication is that this will prefer generic formats over opaque formats
5129 * with arbitrary restrictions, if possible.)
5130 * - Set the width/height fields to the coded frame size, rounded up to the
5131 * API-specific minimum alignment.
5132 * - Only _if_ the hwaccel requires a pre-allocated pool: set the initial_pool_size
5133 * field to the number of maximum reference surfaces possible with the codec,
5134 * plus 1 surface for the user to work (meaning the user can safely reference
5135 * at most 1 decoded surface at a time), plus additional buffering introduced
5136 * by frame threading. If the hwaccel does not require pre-allocation, the
5137 * field is left to 0, and the decoder will allocate new surfaces on demand
5139 * - Possibly AVHWFramesContext.hwctx fields, depending on the underlying
5142 * Essentially, out_frames_ref returns the same as av_hwframe_ctx_alloc(), but
5143 * with basic frame parameters set.
5145 * The function is stateless, and does not change the AVCodecContext or the
5146 * device_ref AVHWDeviceContext.
5148 * @param avctx The context which is currently calling get_format, and which
5149 * implicitly contains all state needed for filling the returned
5150 * AVHWFramesContext properly.
5151 * @param device_ref A reference to the AVHWDeviceContext describing the device
5152 * which will be used by the hardware decoder.
5153 * @param hw_pix_fmt The hwaccel format you are going to return from get_format.
5154 * @param out_frames_ref On success, set to a reference to an _uninitialized_
5155 * AVHWFramesContext, created from the given device_ref.
5156 * Fields will be set to values required for decoding.
5157 * Not changed if an error is returned.
5158 * @return zero on success, a negative value on error. The following error codes
5159 * have special semantics:
5160 * AVERROR(ENOENT): the decoder does not support this functionality. Setup
5161 * is always manual, or it is a decoder which does not
5162 * support setting AVCodecContext.hw_frames_ctx at all,
5163 * or it is a software format.
5164 * AVERROR(EINVAL): it is known that hardware decoding is not supported for
5165 * this configuration, or the device_ref is not supported
5166 * for the hwaccel referenced by hw_pix_fmt.
5168 int avcodec_get_hw_frames_parameters(AVCodecContext *avctx,
5169 AVBufferRef *device_ref,
5170 enum AVPixelFormat hw_pix_fmt,
5171 AVBufferRef **out_frames_ref);
5176 * @defgroup lavc_parsing Frame parsing
5180 enum AVPictureStructure {
5181 AV_PICTURE_STRUCTURE_UNKNOWN, //< unknown
5182 AV_PICTURE_STRUCTURE_TOP_FIELD, //< coded as top field
5183 AV_PICTURE_STRUCTURE_BOTTOM_FIELD, //< coded as bottom field
5184 AV_PICTURE_STRUCTURE_FRAME, //< coded as frame
5187 typedef struct AVCodecParserContext {
5189 struct AVCodecParser *parser;
5190 int64_t frame_offset; /* offset of the current frame */
5191 int64_t cur_offset; /* current offset
5192 (incremented by each av_parser_parse()) */
5193 int64_t next_frame_offset; /* offset of the next frame */
5195 int pict_type; /* XXX: Put it back in AVCodecContext. */
5197 * This field is used for proper frame duration computation in lavf.
5198 * It signals, how much longer the frame duration of the current frame
5199 * is compared to normal frame duration.
5201 * frame_duration = (1 + repeat_pict) * time_base
5203 * It is used by codecs like H.264 to display telecined material.
5205 int repeat_pict; /* XXX: Put it back in AVCodecContext. */
5206 int64_t pts; /* pts of the current frame */
5207 int64_t dts; /* dts of the current frame */
5212 int fetch_timestamp;
5214 #define AV_PARSER_PTS_NB 4
5215 int cur_frame_start_index;
5216 int64_t cur_frame_offset[AV_PARSER_PTS_NB];
5217 int64_t cur_frame_pts[AV_PARSER_PTS_NB];
5218 int64_t cur_frame_dts[AV_PARSER_PTS_NB];
5221 #define PARSER_FLAG_COMPLETE_FRAMES 0x0001
5222 #define PARSER_FLAG_ONCE 0x0002
5223 /// Set if the parser has a valid file offset
5224 #define PARSER_FLAG_FETCHED_OFFSET 0x0004
5225 #define PARSER_FLAG_USE_CODEC_TS 0x1000
5227 int64_t offset; ///< byte offset from starting packet start
5228 int64_t cur_frame_end[AV_PARSER_PTS_NB];
5231 * Set by parser to 1 for key frames and 0 for non-key frames.
5232 * It is initialized to -1, so if the parser doesn't set this flag,
5233 * old-style fallback using AV_PICTURE_TYPE_I picture type as key frames
5238 #if FF_API_CONVERGENCE_DURATION
5240 * @deprecated unused
5242 attribute_deprecated
5243 int64_t convergence_duration;
5246 // Timestamp generation support:
5248 * Synchronization point for start of timestamp generation.
5250 * Set to >0 for sync point, 0 for no sync point and <0 for undefined
5253 * For example, this corresponds to presence of H.264 buffering period
5259 * Offset of the current timestamp against last timestamp sync point in
5260 * units of AVCodecContext.time_base.
5262 * Set to INT_MIN when dts_sync_point unused. Otherwise, it must
5263 * contain a valid timestamp offset.
5265 * Note that the timestamp of sync point has usually a nonzero
5266 * dts_ref_dts_delta, which refers to the previous sync point. Offset of
5267 * the next frame after timestamp sync point will be usually 1.
5269 * For example, this corresponds to H.264 cpb_removal_delay.
5271 int dts_ref_dts_delta;
5274 * Presentation delay of current frame in units of AVCodecContext.time_base.
5276 * Set to INT_MIN when dts_sync_point unused. Otherwise, it must
5277 * contain valid non-negative timestamp delta (presentation time of a frame
5278 * must not lie in the past).
5280 * This delay represents the difference between decoding and presentation
5281 * time of the frame.
5283 * For example, this corresponds to H.264 dpb_output_delay.
5288 * Position of the packet in file.
5290 * Analogous to cur_frame_pts/dts
5292 int64_t cur_frame_pos[AV_PARSER_PTS_NB];
5295 * Byte position of currently parsed frame in stream.
5300 * Previous frame byte position.
5305 * Duration of the current frame.
5306 * For audio, this is in units of 1 / AVCodecContext.sample_rate.
5307 * For all other types, this is in units of AVCodecContext.time_base.
5311 enum AVFieldOrder field_order;
5314 * Indicate whether a picture is coded as a frame, top field or bottom field.
5316 * For example, H.264 field_pic_flag equal to 0 corresponds to
5317 * AV_PICTURE_STRUCTURE_FRAME. An H.264 picture with field_pic_flag
5318 * equal to 1 and bottom_field_flag equal to 0 corresponds to
5319 * AV_PICTURE_STRUCTURE_TOP_FIELD.
5321 enum AVPictureStructure picture_structure;
5324 * Picture number incremented in presentation or output order.
5325 * This field may be reinitialized at the first picture of a new sequence.
5327 * For example, this corresponds to H.264 PicOrderCnt.
5329 int output_picture_number;
5332 * Dimensions of the decoded video intended for presentation.
5338 * Dimensions of the coded video.
5344 * The format of the coded data, corresponds to enum AVPixelFormat for video
5345 * and for enum AVSampleFormat for audio.
5347 * Note that a decoder can have considerable freedom in how exactly it
5348 * decodes the data, so the format reported here might be different from the
5349 * one returned by a decoder.
5352 } AVCodecParserContext;
5354 typedef struct AVCodecParser {
5355 int codec_ids[5]; /* several codec IDs are permitted */
5357 int (*parser_init)(AVCodecParserContext *s);
5358 /* This callback never returns an error, a negative value means that
5359 * the frame start was in a previous packet. */
5360 int (*parser_parse)(AVCodecParserContext *s,
5361 AVCodecContext *avctx,
5362 const uint8_t **poutbuf, int *poutbuf_size,
5363 const uint8_t *buf, int buf_size);
5364 void (*parser_close)(AVCodecParserContext *s);
5365 int (*split)(AVCodecContext *avctx, const uint8_t *buf, int buf_size);
5366 struct AVCodecParser *next;
5370 * Iterate over all registered codec parsers.
5372 * @param opaque a pointer where libavcodec will store the iteration state. Must
5373 * point to NULL to start the iteration.
5375 * @return the next registered codec parser or NULL when the iteration is
5378 const AVCodecParser *av_parser_iterate(void **opaque);
5380 attribute_deprecated
5381 AVCodecParser *av_parser_next(const AVCodecParser *c);
5383 attribute_deprecated
5384 void av_register_codec_parser(AVCodecParser *parser);
5385 AVCodecParserContext *av_parser_init(int codec_id);
5390 * @param s parser context.
5391 * @param avctx codec context.
5392 * @param poutbuf set to pointer to parsed buffer or NULL if not yet finished.
5393 * @param poutbuf_size set to size of parsed buffer or zero if not yet finished.
5394 * @param buf input buffer.
5395 * @param buf_size buffer size in bytes without the padding. I.e. the full buffer
5396 size is assumed to be buf_size + AV_INPUT_BUFFER_PADDING_SIZE.
5397 To signal EOF, this should be 0 (so that the last frame
5399 * @param pts input presentation timestamp.
5400 * @param dts input decoding timestamp.
5401 * @param pos input byte position in stream.
5402 * @return the number of bytes of the input bitstream used.
5407 * len = av_parser_parse2(myparser, AVCodecContext, &data, &size,
5414 * decode_frame(data, size);
5418 int av_parser_parse2(AVCodecParserContext *s,
5419 AVCodecContext *avctx,
5420 uint8_t **poutbuf, int *poutbuf_size,
5421 const uint8_t *buf, int buf_size,
5422 int64_t pts, int64_t dts,
5426 * @return 0 if the output buffer is a subset of the input, 1 if it is allocated and must be freed
5427 * @deprecated use AVBitStreamFilter
5429 int av_parser_change(AVCodecParserContext *s,
5430 AVCodecContext *avctx,
5431 uint8_t **poutbuf, int *poutbuf_size,
5432 const uint8_t *buf, int buf_size, int keyframe);
5433 void av_parser_close(AVCodecParserContext *s);
5441 * @addtogroup lavc_encoding
5446 * Find a registered encoder with a matching codec ID.
5448 * @param id AVCodecID of the requested encoder
5449 * @return An encoder if one was found, NULL otherwise.
5451 AVCodec *avcodec_find_encoder(enum AVCodecID id);
5454 * Find a registered encoder with the specified name.
5456 * @param name name of the requested encoder
5457 * @return An encoder if one was found, NULL otherwise.
5459 AVCodec *avcodec_find_encoder_by_name(const char *name);
5462 * Encode a frame of audio.
5464 * Takes input samples from frame and writes the next output packet, if
5465 * available, to avpkt. The output packet does not necessarily contain data for
5466 * the most recent frame, as encoders can delay, split, and combine input frames
5467 * internally as needed.
5469 * @param avctx codec context
5470 * @param avpkt output AVPacket.
5471 * The user can supply an output buffer by setting
5472 * avpkt->data and avpkt->size prior to calling the
5473 * function, but if the size of the user-provided data is not
5474 * large enough, encoding will fail. If avpkt->data and
5475 * avpkt->size are set, avpkt->destruct must also be set. All
5476 * other AVPacket fields will be reset by the encoder using
5477 * av_init_packet(). If avpkt->data is NULL, the encoder will
5478 * allocate it. The encoder will set avpkt->size to the size
5479 * of the output packet.
5481 * If this function fails or produces no output, avpkt will be
5482 * freed using av_packet_unref().
5483 * @param[in] frame AVFrame containing the raw audio data to be encoded.
5484 * May be NULL when flushing an encoder that has the
5485 * AV_CODEC_CAP_DELAY capability set.
5486 * If AV_CODEC_CAP_VARIABLE_FRAME_SIZE is set, then each frame
5487 * can have any number of samples.
5488 * If it is not set, frame->nb_samples must be equal to
5489 * avctx->frame_size for all frames except the last.
5490 * The final frame may be smaller than avctx->frame_size.
5491 * @param[out] got_packet_ptr This field is set to 1 by libavcodec if the
5492 * output packet is non-empty, and to 0 if it is
5493 * empty. If the function returns an error, the
5494 * packet can be assumed to be invalid, and the
5495 * value of got_packet_ptr is undefined and should
5497 * @return 0 on success, negative error code on failure
5499 * @deprecated use avcodec_send_frame()/avcodec_receive_packet() instead
5501 attribute_deprecated
5502 int avcodec_encode_audio2(AVCodecContext *avctx, AVPacket *avpkt,
5503 const AVFrame *frame, int *got_packet_ptr);
5506 * Encode a frame of video.
5508 * Takes input raw video data from frame and writes the next output packet, if
5509 * available, to avpkt. The output packet does not necessarily contain data for
5510 * the most recent frame, as encoders can delay and reorder input frames
5511 * internally as needed.
5513 * @param avctx codec context
5514 * @param avpkt output AVPacket.
5515 * The user can supply an output buffer by setting
5516 * avpkt->data and avpkt->size prior to calling the
5517 * function, but if the size of the user-provided data is not
5518 * large enough, encoding will fail. All other AVPacket fields
5519 * will be reset by the encoder using av_init_packet(). If
5520 * avpkt->data is NULL, the encoder will allocate it.
5521 * The encoder will set avpkt->size to the size of the
5522 * output packet. The returned data (if any) belongs to the
5523 * caller, he is responsible for freeing it.
5525 * If this function fails or produces no output, avpkt will be
5526 * freed using av_packet_unref().
5527 * @param[in] frame AVFrame containing the raw video data to be encoded.
5528 * May be NULL when flushing an encoder that has the
5529 * AV_CODEC_CAP_DELAY capability set.
5530 * @param[out] got_packet_ptr This field is set to 1 by libavcodec if the
5531 * output packet is non-empty, and to 0 if it is
5532 * empty. If the function returns an error, the
5533 * packet can be assumed to be invalid, and the
5534 * value of got_packet_ptr is undefined and should
5536 * @return 0 on success, negative error code on failure
5538 * @deprecated use avcodec_send_frame()/avcodec_receive_packet() instead
5540 attribute_deprecated
5541 int avcodec_encode_video2(AVCodecContext *avctx, AVPacket *avpkt,
5542 const AVFrame *frame, int *got_packet_ptr);
5544 int avcodec_encode_subtitle(AVCodecContext *avctx, uint8_t *buf, int buf_size,
5545 const AVSubtitle *sub);
5552 #if FF_API_AVPICTURE
5554 * @addtogroup lavc_picture
5559 * @deprecated unused
5561 attribute_deprecated
5562 int avpicture_alloc(AVPicture *picture, enum AVPixelFormat pix_fmt, int width, int height);
5565 * @deprecated unused
5567 attribute_deprecated
5568 void avpicture_free(AVPicture *picture);
5571 * @deprecated use av_image_fill_arrays() instead.
5573 attribute_deprecated
5574 int avpicture_fill(AVPicture *picture, const uint8_t *ptr,
5575 enum AVPixelFormat pix_fmt, int width, int height);
5578 * @deprecated use av_image_copy_to_buffer() instead.
5580 attribute_deprecated
5581 int avpicture_layout(const AVPicture *src, enum AVPixelFormat pix_fmt,
5582 int width, int height,
5583 unsigned char *dest, int dest_size);
5586 * @deprecated use av_image_get_buffer_size() instead.
5588 attribute_deprecated
5589 int avpicture_get_size(enum AVPixelFormat pix_fmt, int width, int height);
5592 * @deprecated av_image_copy() instead.
5594 attribute_deprecated
5595 void av_picture_copy(AVPicture *dst, const AVPicture *src,
5596 enum AVPixelFormat pix_fmt, int width, int height);
5599 * @deprecated unused
5601 attribute_deprecated
5602 int av_picture_crop(AVPicture *dst, const AVPicture *src,
5603 enum AVPixelFormat pix_fmt, int top_band, int left_band);
5606 * @deprecated unused
5608 attribute_deprecated
5609 int av_picture_pad(AVPicture *dst, const AVPicture *src, int height, int width, enum AVPixelFormat pix_fmt,
5610 int padtop, int padbottom, int padleft, int padright, int *color);
5618 * @defgroup lavc_misc Utility functions
5621 * Miscellaneous utility functions related to both encoding and decoding
5627 * @defgroup lavc_misc_pixfmt Pixel formats
5629 * Functions for working with pixel formats.
5633 #if FF_API_GETCHROMA
5635 * @deprecated Use av_pix_fmt_get_chroma_sub_sample
5638 attribute_deprecated
5639 void avcodec_get_chroma_sub_sample(enum AVPixelFormat pix_fmt, int *h_shift, int *v_shift);
5643 * Return a value representing the fourCC code associated to the
5644 * pixel format pix_fmt, or 0 if no associated fourCC code can be
5647 unsigned int avcodec_pix_fmt_to_codec_tag(enum AVPixelFormat pix_fmt);
5650 * @deprecated see av_get_pix_fmt_loss()
5652 int avcodec_get_pix_fmt_loss(enum AVPixelFormat dst_pix_fmt, enum AVPixelFormat src_pix_fmt,
5656 * Find the best pixel format to convert to given a certain source pixel
5657 * format. When converting from one pixel format to another, information loss
5658 * may occur. For example, when converting from RGB24 to GRAY, the color
5659 * information will be lost. Similarly, other losses occur when converting from
5660 * some formats to other formats. avcodec_find_best_pix_fmt_of_2() searches which of
5661 * the given pixel formats should be used to suffer the least amount of loss.
5662 * The pixel formats from which it chooses one, are determined by the
5663 * pix_fmt_list parameter.
5666 * @param[in] pix_fmt_list AV_PIX_FMT_NONE terminated array of pixel formats to choose from
5667 * @param[in] src_pix_fmt source pixel format
5668 * @param[in] has_alpha Whether the source pixel format alpha channel is used.
5669 * @param[out] loss_ptr Combination of flags informing you what kind of losses will occur.
5670 * @return The best pixel format to convert to or -1 if none was found.
5672 enum AVPixelFormat avcodec_find_best_pix_fmt_of_list(const enum AVPixelFormat *pix_fmt_list,
5673 enum AVPixelFormat src_pix_fmt,
5674 int has_alpha, int *loss_ptr);
5677 * @deprecated see av_find_best_pix_fmt_of_2()
5679 enum AVPixelFormat avcodec_find_best_pix_fmt_of_2(enum AVPixelFormat dst_pix_fmt1, enum AVPixelFormat dst_pix_fmt2,
5680 enum AVPixelFormat src_pix_fmt, int has_alpha, int *loss_ptr);
5682 attribute_deprecated
5683 enum AVPixelFormat avcodec_find_best_pix_fmt2(enum AVPixelFormat dst_pix_fmt1, enum AVPixelFormat dst_pix_fmt2,
5684 enum AVPixelFormat src_pix_fmt, int has_alpha, int *loss_ptr);
5686 enum AVPixelFormat avcodec_default_get_format(struct AVCodecContext *s, const enum AVPixelFormat * fmt);
5692 #if FF_API_TAG_STRING
5694 * Put a string representing the codec tag codec_tag in buf.
5696 * @param buf buffer to place codec tag in
5697 * @param buf_size size in bytes of buf
5698 * @param codec_tag codec tag to assign
5699 * @return the length of the string that would have been generated if
5700 * enough space had been available, excluding the trailing null
5702 * @deprecated see av_fourcc_make_string() and av_fourcc2str().
5704 attribute_deprecated
5705 size_t av_get_codec_tag_string(char *buf, size_t buf_size, unsigned int codec_tag);
5708 void avcodec_string(char *buf, int buf_size, AVCodecContext *enc, int encode);
5711 * Return a name for the specified profile, if available.
5713 * @param codec the codec that is searched for the given profile
5714 * @param profile the profile value for which a name is requested
5715 * @return A name for the profile if found, NULL otherwise.
5717 const char *av_get_profile_name(const AVCodec *codec, int profile);
5720 * Return a name for the specified profile, if available.
5722 * @param codec_id the ID of the codec to which the requested profile belongs
5723 * @param profile the profile value for which a name is requested
5724 * @return A name for the profile if found, NULL otherwise.
5726 * @note unlike av_get_profile_name(), which searches a list of profiles
5727 * supported by a specific decoder or encoder implementation, this
5728 * function searches the list of profiles from the AVCodecDescriptor
5730 const char *avcodec_profile_name(enum AVCodecID codec_id, int profile);
5732 int avcodec_default_execute(AVCodecContext *c, int (*func)(AVCodecContext *c2, void *arg2),void *arg, int *ret, int count, int size);
5733 int avcodec_default_execute2(AVCodecContext *c, int (*func)(AVCodecContext *c2, void *arg2, int, int),void *arg, int *ret, int count);
5734 //FIXME func typedef
5737 * Fill AVFrame audio data and linesize pointers.
5739 * The buffer buf must be a preallocated buffer with a size big enough
5740 * to contain the specified samples amount. The filled AVFrame data
5741 * pointers will point to this buffer.
5743 * AVFrame extended_data channel pointers are allocated if necessary for
5746 * @param frame the AVFrame
5747 * frame->nb_samples must be set prior to calling the
5748 * function. This function fills in frame->data,
5749 * frame->extended_data, frame->linesize[0].
5750 * @param nb_channels channel count
5751 * @param sample_fmt sample format
5752 * @param buf buffer to use for frame data
5753 * @param buf_size size of buffer
5754 * @param align plane size sample alignment (0 = default)
5755 * @return >=0 on success, negative error code on failure
5756 * @todo return the size in bytes required to store the samples in
5757 * case of success, at the next libavutil bump
5759 int avcodec_fill_audio_frame(AVFrame *frame, int nb_channels,
5760 enum AVSampleFormat sample_fmt, const uint8_t *buf,
5761 int buf_size, int align);
5764 * Reset the internal decoder state / flush internal buffers. Should be called
5765 * e.g. when seeking or when switching to a different stream.
5767 * @note when refcounted frames are not used (i.e. avctx->refcounted_frames is 0),
5768 * this invalidates the frames previously returned from the decoder. When
5769 * refcounted frames are used, the decoder just releases any references it might
5770 * keep internally, but the caller's reference remains valid.
5772 void avcodec_flush_buffers(AVCodecContext *avctx);
5775 * Return codec bits per sample.
5777 * @param[in] codec_id the codec
5778 * @return Number of bits per sample or zero if unknown for the given codec.
5780 int av_get_bits_per_sample(enum AVCodecID codec_id);
5783 * Return the PCM codec associated with a sample format.
5784 * @param be endianness, 0 for little, 1 for big,
5785 * -1 (or anything else) for native
5786 * @return AV_CODEC_ID_PCM_* or AV_CODEC_ID_NONE
5788 enum AVCodecID av_get_pcm_codec(enum AVSampleFormat fmt, int be);
5791 * Return codec bits per sample.
5792 * Only return non-zero if the bits per sample is exactly correct, not an
5795 * @param[in] codec_id the codec
5796 * @return Number of bits per sample or zero if unknown for the given codec.
5798 int av_get_exact_bits_per_sample(enum AVCodecID codec_id);
5801 * Return audio frame duration.
5803 * @param avctx codec context
5804 * @param frame_bytes size of the frame, or 0 if unknown
5805 * @return frame duration, in samples, if known. 0 if not able to
5808 int av_get_audio_frame_duration(AVCodecContext *avctx, int frame_bytes);
5811 * This function is the same as av_get_audio_frame_duration(), except it works
5812 * with AVCodecParameters instead of an AVCodecContext.
5814 int av_get_audio_frame_duration2(AVCodecParameters *par, int frame_bytes);
5817 typedef struct AVBitStreamFilterContext {
5819 const struct AVBitStreamFilter *filter;
5820 AVCodecParserContext *parser;
5821 struct AVBitStreamFilterContext *next;
5823 * Internal default arguments, used if NULL is passed to av_bitstream_filter_filter().
5824 * Not for access by library users.
5827 } AVBitStreamFilterContext;
5830 typedef struct AVBSFInternal AVBSFInternal;
5833 * The bitstream filter state.
5835 * This struct must be allocated with av_bsf_alloc() and freed with
5838 * The fields in the struct will only be changed (by the caller or by the
5839 * filter) as described in their documentation, and are to be considered
5840 * immutable otherwise.
5842 typedef struct AVBSFContext {
5844 * A class for logging and AVOptions
5846 const AVClass *av_class;
5849 * The bitstream filter this context is an instance of.
5851 const struct AVBitStreamFilter *filter;
5854 * Opaque libavcodec internal data. Must not be touched by the caller in any
5857 AVBSFInternal *internal;
5860 * Opaque filter-specific private data. If filter->priv_class is non-NULL,
5861 * this is an AVOptions-enabled struct.
5866 * Parameters of the input stream. This field is allocated in
5867 * av_bsf_alloc(), it needs to be filled by the caller before
5870 AVCodecParameters *par_in;
5873 * Parameters of the output stream. This field is allocated in
5874 * av_bsf_alloc(), it is set by the filter in av_bsf_init().
5876 AVCodecParameters *par_out;
5879 * The timebase used for the timestamps of the input packets. Set by the
5880 * caller before av_bsf_init().
5882 AVRational time_base_in;
5885 * The timebase used for the timestamps of the output packets. Set by the
5886 * filter in av_bsf_init().
5888 AVRational time_base_out;
5891 typedef struct AVBitStreamFilter {
5895 * A list of codec ids supported by the filter, terminated by
5897 * May be NULL, in that case the bitstream filter works with any codec id.
5899 const enum AVCodecID *codec_ids;
5902 * A class for the private data, used to declare bitstream filter private
5903 * AVOptions. This field is NULL for bitstream filters that do not declare
5906 * If this field is non-NULL, the first member of the filter private data
5907 * must be a pointer to AVClass, which will be set by libavcodec generic
5908 * code to this class.
5910 const AVClass *priv_class;
5912 /*****************************************************************
5913 * No fields below this line are part of the public API. They
5914 * may not be used outside of libavcodec and can be changed and
5916 * New public fields should be added right above.
5917 *****************************************************************
5921 int (*init)(AVBSFContext *ctx);
5922 int (*filter)(AVBSFContext *ctx, AVPacket *pkt);
5923 void (*close)(AVBSFContext *ctx);
5924 void (*flush)(AVBSFContext *ctx);
5925 } AVBitStreamFilter;
5929 * @deprecated the old bitstream filtering API (using AVBitStreamFilterContext)
5930 * is deprecated. Use the new bitstream filtering API (using AVBSFContext).
5932 attribute_deprecated
5933 void av_register_bitstream_filter(AVBitStreamFilter *bsf);
5935 * @deprecated the old bitstream filtering API (using AVBitStreamFilterContext)
5936 * is deprecated. Use av_bsf_get_by_name(), av_bsf_alloc(), and av_bsf_init()
5937 * from the new bitstream filtering API (using AVBSFContext).
5939 attribute_deprecated
5940 AVBitStreamFilterContext *av_bitstream_filter_init(const char *name);
5942 * @deprecated the old bitstream filtering API (using AVBitStreamFilterContext)
5943 * is deprecated. Use av_bsf_send_packet() and av_bsf_receive_packet() from the
5944 * new bitstream filtering API (using AVBSFContext).
5946 attribute_deprecated
5947 int av_bitstream_filter_filter(AVBitStreamFilterContext *bsfc,
5948 AVCodecContext *avctx, const char *args,
5949 uint8_t **poutbuf, int *poutbuf_size,
5950 const uint8_t *buf, int buf_size, int keyframe);
5952 * @deprecated the old bitstream filtering API (using AVBitStreamFilterContext)
5953 * is deprecated. Use av_bsf_free() from the new bitstream filtering API (using
5956 attribute_deprecated
5957 void av_bitstream_filter_close(AVBitStreamFilterContext *bsf);
5959 * @deprecated the old bitstream filtering API (using AVBitStreamFilterContext)
5960 * is deprecated. Use av_bsf_iterate() from the new bitstream filtering API (using
5963 attribute_deprecated
5964 const AVBitStreamFilter *av_bitstream_filter_next(const AVBitStreamFilter *f);
5968 * @return a bitstream filter with the specified name or NULL if no such
5969 * bitstream filter exists.
5971 const AVBitStreamFilter *av_bsf_get_by_name(const char *name);
5974 * Iterate over all registered bitstream filters.
5976 * @param opaque a pointer where libavcodec will store the iteration state. Must
5977 * point to NULL to start the iteration.
5979 * @return the next registered bitstream filter or NULL when the iteration is
5982 const AVBitStreamFilter *av_bsf_iterate(void **opaque);
5984 attribute_deprecated
5985 const AVBitStreamFilter *av_bsf_next(void **opaque);
5989 * Allocate a context for a given bitstream filter. The caller must fill in the
5990 * context parameters as described in the documentation and then call
5991 * av_bsf_init() before sending any data to the filter.
5993 * @param filter the filter for which to allocate an instance.
5994 * @param ctx a pointer into which the pointer to the newly-allocated context
5995 * will be written. It must be freed with av_bsf_free() after the
5996 * filtering is done.
5998 * @return 0 on success, a negative AVERROR code on failure
6000 int av_bsf_alloc(const AVBitStreamFilter *filter, AVBSFContext **ctx);
6003 * Prepare the filter for use, after all the parameters and options have been
6006 int av_bsf_init(AVBSFContext *ctx);
6009 * Submit a packet for filtering.
6011 * After sending each packet, the filter must be completely drained by calling
6012 * av_bsf_receive_packet() repeatedly until it returns AVERROR(EAGAIN) or
6015 * @param pkt the packet to filter. The bitstream filter will take ownership of
6016 * the packet and reset the contents of pkt. pkt is not touched if an error occurs.
6017 * If pkt is empty (i.e. NULL, or pkt->data is NULL and pkt->side_data_elems zero),
6018 * it signals the end of the stream (i.e. no more non-empty packets will be sent;
6019 * sending more empty packets does nothing) and will cause the filter to output
6020 * any packets it may have buffered internally.
6022 * @return 0 on success, a negative AVERROR on error. This function never fails if
6025 int av_bsf_send_packet(AVBSFContext *ctx, AVPacket *pkt);
6028 * Retrieve a filtered packet.
6030 * @param[out] pkt this struct will be filled with the contents of the filtered
6031 * packet. It is owned by the caller and must be freed using
6032 * av_packet_unref() when it is no longer needed.
6033 * This parameter should be "clean" (i.e. freshly allocated
6034 * with av_packet_alloc() or unreffed with av_packet_unref())
6035 * when this function is called. If this function returns
6036 * successfully, the contents of pkt will be completely
6037 * overwritten by the returned data. On failure, pkt is not
6040 * @return 0 on success. AVERROR(EAGAIN) if more packets need to be sent to the
6041 * filter (using av_bsf_send_packet()) to get more output. AVERROR_EOF if there
6042 * will be no further output from the filter. Another negative AVERROR value if
6045 * @note one input packet may result in several output packets, so after sending
6046 * a packet with av_bsf_send_packet(), this function needs to be called
6047 * repeatedly until it stops returning 0. It is also possible for a filter to
6048 * output fewer packets than were sent to it, so this function may return
6049 * AVERROR(EAGAIN) immediately after a successful av_bsf_send_packet() call.
6051 int av_bsf_receive_packet(AVBSFContext *ctx, AVPacket *pkt);
6054 * Reset the internal bitstream filter state / flush internal buffers.
6056 void av_bsf_flush(AVBSFContext *ctx);
6059 * Free a bitstream filter context and everything associated with it; write NULL
6060 * into the supplied pointer.
6062 void av_bsf_free(AVBSFContext **ctx);
6065 * Get the AVClass for AVBSFContext. It can be used in combination with
6066 * AV_OPT_SEARCH_FAKE_OBJ for examining options.
6068 * @see av_opt_find().
6070 const AVClass *av_bsf_get_class(void);
6073 * Structure for chain/list of bitstream filters.
6074 * Empty list can be allocated by av_bsf_list_alloc().
6076 typedef struct AVBSFList AVBSFList;
6079 * Allocate empty list of bitstream filters.
6080 * The list must be later freed by av_bsf_list_free()
6081 * or finalized by av_bsf_list_finalize().
6083 * @return Pointer to @ref AVBSFList on success, NULL in case of failure
6085 AVBSFList *av_bsf_list_alloc(void);
6088 * Free list of bitstream filters.
6090 * @param lst Pointer to pointer returned by av_bsf_list_alloc()
6092 void av_bsf_list_free(AVBSFList **lst);
6095 * Append bitstream filter to the list of bitstream filters.
6097 * @param lst List to append to
6098 * @param bsf Filter context to be appended
6100 * @return >=0 on success, negative AVERROR in case of failure
6102 int av_bsf_list_append(AVBSFList *lst, AVBSFContext *bsf);
6105 * Construct new bitstream filter context given it's name and options
6106 * and append it to the list of bitstream filters.
6108 * @param lst List to append to
6109 * @param bsf_name Name of the bitstream filter
6110 * @param options Options for the bitstream filter, can be set to NULL
6112 * @return >=0 on success, negative AVERROR in case of failure
6114 int av_bsf_list_append2(AVBSFList *lst, const char * bsf_name, AVDictionary **options);
6116 * Finalize list of bitstream filters.
6118 * This function will transform @ref AVBSFList to single @ref AVBSFContext,
6119 * so the whole chain of bitstream filters can be treated as single filter
6120 * freshly allocated by av_bsf_alloc().
6121 * If the call is successful, @ref AVBSFList structure is freed and lst
6122 * will be set to NULL. In case of failure, caller is responsible for
6123 * freeing the structure by av_bsf_list_free()
6125 * @param lst Filter list structure to be transformed
6126 * @param[out] bsf Pointer to be set to newly created @ref AVBSFContext structure
6127 * representing the chain of bitstream filters
6129 * @return >=0 on success, negative AVERROR in case of failure
6131 int av_bsf_list_finalize(AVBSFList **lst, AVBSFContext **bsf);
6134 * Parse string describing list of bitstream filters and create single
6135 * @ref AVBSFContext describing the whole chain of bitstream filters.
6136 * Resulting @ref AVBSFContext can be treated as any other @ref AVBSFContext freshly
6137 * allocated by av_bsf_alloc().
6139 * @param str String describing chain of bitstream filters in format
6140 * `bsf1[=opt1=val1:opt2=val2][,bsf2]`
6141 * @param[out] bsf Pointer to be set to newly created @ref AVBSFContext structure
6142 * representing the chain of bitstream filters
6144 * @return >=0 on success, negative AVERROR in case of failure
6146 int av_bsf_list_parse_str(const char *str, AVBSFContext **bsf);
6149 * Get null/pass-through bitstream filter.
6151 * @param[out] bsf Pointer to be set to new instance of pass-through bitstream filter
6155 int av_bsf_get_null_filter(AVBSFContext **bsf);
6160 * Same behaviour av_fast_malloc but the buffer has additional
6161 * AV_INPUT_BUFFER_PADDING_SIZE at the end which will always be 0.
6163 * In addition the whole buffer will initially and after resizes
6164 * be 0-initialized so that no uninitialized data will ever appear.
6166 void av_fast_padded_malloc(void *ptr, unsigned int *size, size_t min_size);
6169 * Same behaviour av_fast_padded_malloc except that buffer will always
6170 * be 0-initialized after call.
6172 void av_fast_padded_mallocz(void *ptr, unsigned int *size, size_t min_size);
6175 * Encode extradata length to a buffer. Used by xiph codecs.
6177 * @param s buffer to write to; must be at least (v/255+1) bytes long
6178 * @param v size of extradata in bytes
6179 * @return number of bytes written to the buffer.
6181 unsigned int av_xiphlacing(unsigned char *s, unsigned int v);
6183 #if FF_API_USER_VISIBLE_AVHWACCEL
6185 * Register the hardware accelerator hwaccel.
6187 * @deprecated This function doesn't do anything.
6189 attribute_deprecated
6190 void av_register_hwaccel(AVHWAccel *hwaccel);
6193 * If hwaccel is NULL, returns the first registered hardware accelerator,
6194 * if hwaccel is non-NULL, returns the next registered hardware accelerator
6195 * after hwaccel, or NULL if hwaccel is the last one.
6197 * @deprecated AVHWaccel structures contain no user-serviceable parts, so
6198 * this function should not be used.
6200 attribute_deprecated
6201 AVHWAccel *av_hwaccel_next(const AVHWAccel *hwaccel);
6206 * Lock operation used by lockmgr
6208 * @deprecated Deprecated together with av_lockmgr_register().
6211 AV_LOCK_CREATE, ///< Create a mutex
6212 AV_LOCK_OBTAIN, ///< Lock the mutex
6213 AV_LOCK_RELEASE, ///< Unlock the mutex
6214 AV_LOCK_DESTROY, ///< Free mutex resources
6218 * Register a user provided lock manager supporting the operations
6219 * specified by AVLockOp. The "mutex" argument to the function points
6220 * to a (void *) where the lockmgr should store/get a pointer to a user
6221 * allocated mutex. It is NULL upon AV_LOCK_CREATE and equal to the
6222 * value left by the last call for all other ops. If the lock manager is
6223 * unable to perform the op then it should leave the mutex in the same
6224 * state as when it was called and return a non-zero value. However,
6225 * when called with AV_LOCK_DESTROY the mutex will always be assumed to
6226 * have been successfully destroyed. If av_lockmgr_register succeeds
6227 * it will return a non-negative value, if it fails it will return a
6228 * negative value and destroy all mutex and unregister all callbacks.
6229 * av_lockmgr_register is not thread-safe, it must be called from a
6230 * single thread before any calls which make use of locking are used.
6232 * @param cb User defined callback. av_lockmgr_register invokes calls
6233 * to this callback and the previously registered callback.
6234 * The callback will be used to create more than one mutex
6235 * each of which must be backed by its own underlying locking
6236 * mechanism (i.e. do not use a single static object to
6237 * implement your lock manager). If cb is set to NULL the
6238 * lockmgr will be unregistered.
6240 * @deprecated This function does nothing, and always returns 0. Be sure to
6241 * build with thread support to get basic thread safety.
6243 attribute_deprecated
6244 int av_lockmgr_register(int (*cb)(void **mutex, enum AVLockOp op));
6248 * Get the type of the given codec.
6250 enum AVMediaType avcodec_get_type(enum AVCodecID codec_id);
6253 * Get the name of a codec.
6254 * @return a static string identifying the codec; never NULL
6256 const char *avcodec_get_name(enum AVCodecID id);
6259 * @return a positive value if s is open (i.e. avcodec_open2() was called on it
6260 * with no corresponding avcodec_close()), 0 otherwise.
6262 int avcodec_is_open(AVCodecContext *s);
6265 * @return a non-zero number if codec is an encoder, zero otherwise
6267 int av_codec_is_encoder(const AVCodec *codec);
6270 * @return a non-zero number if codec is a decoder, zero otherwise
6272 int av_codec_is_decoder(const AVCodec *codec);
6275 * @return descriptor for given codec ID or NULL if no descriptor exists.
6277 const AVCodecDescriptor *avcodec_descriptor_get(enum AVCodecID id);
6280 * Iterate over all codec descriptors known to libavcodec.
6282 * @param prev previous descriptor. NULL to get the first descriptor.
6284 * @return next descriptor or NULL after the last descriptor
6286 const AVCodecDescriptor *avcodec_descriptor_next(const AVCodecDescriptor *prev);
6289 * @return codec descriptor with the given name or NULL if no such descriptor
6292 const AVCodecDescriptor *avcodec_descriptor_get_by_name(const char *name);
6295 * Allocate a CPB properties structure and initialize its fields to default
6298 * @param size if non-NULL, the size of the allocated struct will be written
6299 * here. This is useful for embedding it in side data.
6301 * @return the newly allocated struct or NULL on failure
6303 AVCPBProperties *av_cpb_properties_alloc(size_t *size);
6309 #endif /* AVCODEC_AVCODEC_H */