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,
558 AV_CODEC_ID_AMR_NB = 0x12000,
561 /* RealAudio codecs*/
562 AV_CODEC_ID_RA_144 = 0x13000,
565 /* various DPCM codecs */
566 AV_CODEC_ID_ROQ_DPCM = 0x14000,
567 AV_CODEC_ID_INTERPLAY_DPCM,
568 AV_CODEC_ID_XAN_DPCM,
569 AV_CODEC_ID_SOL_DPCM,
571 AV_CODEC_ID_SDX2_DPCM = 0x14800,
572 AV_CODEC_ID_GREMLIN_DPCM,
575 AV_CODEC_ID_MP2 = 0x15000,
576 AV_CODEC_ID_MP3, ///< preferred ID for decoding MPEG audio layer 1, 2 or 3
586 AV_CODEC_ID_VMDAUDIO,
592 AV_CODEC_ID_WESTWOOD_SND1,
593 AV_CODEC_ID_GSM, ///< as in Berlin toast format
596 AV_CODEC_ID_TRUESPEECH,
598 AV_CODEC_ID_SMACKAUDIO,
601 AV_CODEC_ID_DSICINAUDIO,
603 AV_CODEC_ID_MUSEPACK7,
605 AV_CODEC_ID_GSM_MS, /* as found in WAV */
608 AV_CODEC_ID_NELLYMOSER,
609 AV_CODEC_ID_MUSEPACK8,
611 AV_CODEC_ID_WMAVOICE,
613 AV_CODEC_ID_WMALOSSLESS,
622 AV_CODEC_ID_BINKAUDIO_RDFT,
623 AV_CODEC_ID_BINKAUDIO_DCT,
624 AV_CODEC_ID_AAC_LATM,
629 AV_CODEC_ID_8SVX_EXP,
630 AV_CODEC_ID_8SVX_FIB,
631 AV_CODEC_ID_BMV_AUDIO,
636 AV_CODEC_ID_COMFORT_NOISE,
638 AV_CODEC_ID_METASOUND,
639 AV_CODEC_ID_PAF_AUDIO,
644 AV_CODEC_ID_FFWAVESYNTH = 0x15800,
646 AV_CODEC_ID_SONIC_LS,
649 AV_CODEC_ID_DSD_LSBF,
650 AV_CODEC_ID_DSD_MSBF,
651 AV_CODEC_ID_DSD_LSBF_PLANAR,
652 AV_CODEC_ID_DSD_MSBF_PLANAR,
654 AV_CODEC_ID_INTERPLAY_ACM,
658 AV_CODEC_ID_ATRAC3AL,
659 AV_CODEC_ID_ATRAC3PAL,
666 AV_CODEC_ID_ACELP_KELVIN,
667 AV_CODEC_ID_MPEGH_3D_AUDIO,
670 /* subtitle codecs */
671 AV_CODEC_ID_FIRST_SUBTITLE = 0x17000, ///< A dummy ID pointing at the start of subtitle codecs.
672 AV_CODEC_ID_DVD_SUBTITLE = 0x17000,
673 AV_CODEC_ID_DVB_SUBTITLE,
674 AV_CODEC_ID_TEXT, ///< raw UTF-8 text
677 AV_CODEC_ID_MOV_TEXT,
678 AV_CODEC_ID_HDMV_PGS_SUBTITLE,
679 AV_CODEC_ID_DVB_TELETEXT,
682 AV_CODEC_ID_MICRODVD = 0x17800,
686 AV_CODEC_ID_REALTEXT,
688 AV_CODEC_ID_SUBVIEWER1,
689 AV_CODEC_ID_SUBVIEWER,
696 AV_CODEC_ID_HDMV_TEXT_SUBTITLE,
698 AV_CODEC_ID_ARIB_CAPTION,
700 /* other specific kind of codecs (generally used for attachments) */
701 AV_CODEC_ID_FIRST_UNKNOWN = 0x18000, ///< A dummy ID pointing at the start of various fake codecs.
702 AV_CODEC_ID_TTF = 0x18000,
704 AV_CODEC_ID_SCTE_35, ///< Contain timestamp estimated through PCR of program stream.
706 AV_CODEC_ID_BINTEXT = 0x18800,
710 AV_CODEC_ID_SMPTE_KLV,
712 AV_CODEC_ID_TIMED_ID3,
713 AV_CODEC_ID_BIN_DATA,
716 AV_CODEC_ID_PROBE = 0x19000, ///< codec_id is not known (like AV_CODEC_ID_NONE) but lavf should attempt to identify it
718 AV_CODEC_ID_MPEG2TS = 0x20000, /**< _FAKE_ codec to indicate a raw MPEG-2 TS
719 * stream (only used by libavformat) */
720 AV_CODEC_ID_MPEG4SYSTEMS = 0x20001, /**< _FAKE_ codec to indicate a MPEG-4 Systems
721 * stream (only used by libavformat) */
722 AV_CODEC_ID_FFMETADATA = 0x21000, ///< Dummy codec for streams containing only metadata information.
723 AV_CODEC_ID_WRAPPED_AVFRAME = 0x21001, ///< Passthrough codec, AVFrames wrapped in AVPacket
727 * This struct describes the properties of a single codec described by an
729 * @see avcodec_descriptor_get()
731 typedef struct AVCodecDescriptor {
733 enum AVMediaType type;
735 * Name of the codec described by this descriptor. It is non-empty and
736 * unique for each codec descriptor. It should contain alphanumeric
737 * characters and '_' only.
741 * A more descriptive name for this codec. May be NULL.
743 const char *long_name;
745 * Codec properties, a combination of AV_CODEC_PROP_* flags.
749 * MIME type(s) associated with the codec.
750 * May be NULL; if not, a NULL-terminated array of MIME types.
751 * The first item is always non-NULL and is the preferred MIME type.
753 const char *const *mime_types;
755 * If non-NULL, an array of profiles recognized for this codec.
756 * Terminated with FF_PROFILE_UNKNOWN.
758 const struct AVProfile *profiles;
762 * Codec uses only intra compression.
763 * Video and audio codecs only.
765 #define AV_CODEC_PROP_INTRA_ONLY (1 << 0)
767 * Codec supports lossy compression. Audio and video codecs only.
768 * @note a codec may support both lossy and lossless
771 #define AV_CODEC_PROP_LOSSY (1 << 1)
773 * Codec supports lossless compression. Audio and video codecs only.
775 #define AV_CODEC_PROP_LOSSLESS (1 << 2)
777 * Codec supports frame reordering. That is, the coded order (the order in which
778 * the encoded packets are output by the encoders / stored / input to the
779 * decoders) may be different from the presentation order of the corresponding
782 * For codecs that do not have this property set, PTS and DTS should always be
785 #define AV_CODEC_PROP_REORDER (1 << 3)
787 * Subtitle codec is bitmap based
788 * Decoded AVSubtitle data can be read from the AVSubtitleRect->pict field.
790 #define AV_CODEC_PROP_BITMAP_SUB (1 << 16)
792 * Subtitle codec is text based.
793 * Decoded AVSubtitle data can be read from the AVSubtitleRect->ass field.
795 #define AV_CODEC_PROP_TEXT_SUB (1 << 17)
798 * @ingroup lavc_decoding
799 * Required number of additionally allocated bytes at the end of the input bitstream for decoding.
800 * This is mainly needed because some optimized bitstream readers read
801 * 32 or 64 bit at once and could read over the end.<br>
802 * Note: If the first 23 bits of the additional bytes are not 0, then damaged
803 * MPEG bitstreams could cause overread and segfault.
805 #define AV_INPUT_BUFFER_PADDING_SIZE 64
808 * @ingroup lavc_encoding
809 * minimum encoding buffer size
810 * Used to avoid some checks during header writing.
812 #define AV_INPUT_BUFFER_MIN_SIZE 16384
815 * @ingroup lavc_decoding
818 /* We leave some space between them for extensions (drop some
819 * keyframes for intra-only or drop just some bidir frames). */
820 AVDISCARD_NONE =-16, ///< discard nothing
821 AVDISCARD_DEFAULT = 0, ///< discard useless packets like 0 size packets in avi
822 AVDISCARD_NONREF = 8, ///< discard all non reference
823 AVDISCARD_BIDIR = 16, ///< discard all bidirectional frames
824 AVDISCARD_NONINTRA= 24, ///< discard all non intra frames
825 AVDISCARD_NONKEY = 32, ///< discard all frames except keyframes
826 AVDISCARD_ALL = 48, ///< discard all
829 enum AVAudioServiceType {
830 AV_AUDIO_SERVICE_TYPE_MAIN = 0,
831 AV_AUDIO_SERVICE_TYPE_EFFECTS = 1,
832 AV_AUDIO_SERVICE_TYPE_VISUALLY_IMPAIRED = 2,
833 AV_AUDIO_SERVICE_TYPE_HEARING_IMPAIRED = 3,
834 AV_AUDIO_SERVICE_TYPE_DIALOGUE = 4,
835 AV_AUDIO_SERVICE_TYPE_COMMENTARY = 5,
836 AV_AUDIO_SERVICE_TYPE_EMERGENCY = 6,
837 AV_AUDIO_SERVICE_TYPE_VOICE_OVER = 7,
838 AV_AUDIO_SERVICE_TYPE_KARAOKE = 8,
839 AV_AUDIO_SERVICE_TYPE_NB , ///< Not part of ABI
843 * @ingroup lavc_encoding
845 typedef struct RcOverride{
848 int qscale; // If this is 0 then quality_factor will be used instead.
849 float quality_factor;
853 These flags can be passed in AVCodecContext.flags before initialization.
854 Note: Not everything is supported yet.
858 * Allow decoders to produce frames with data planes that are not aligned
859 * to CPU requirements (e.g. due to cropping).
861 #define AV_CODEC_FLAG_UNALIGNED (1 << 0)
865 #define AV_CODEC_FLAG_QSCALE (1 << 1)
867 * 4 MV per MB allowed / advanced prediction for H.263.
869 #define AV_CODEC_FLAG_4MV (1 << 2)
871 * Output even those frames that might be corrupted.
873 #define AV_CODEC_FLAG_OUTPUT_CORRUPT (1 << 3)
877 #define AV_CODEC_FLAG_QPEL (1 << 4)
879 * Don't output frames whose parameters differ from first
880 * decoded frame in stream.
882 #define AV_CODEC_FLAG_DROPCHANGED (1 << 5)
884 * Use internal 2pass ratecontrol in first pass mode.
886 #define AV_CODEC_FLAG_PASS1 (1 << 9)
888 * Use internal 2pass ratecontrol in second pass mode.
890 #define AV_CODEC_FLAG_PASS2 (1 << 10)
894 #define AV_CODEC_FLAG_LOOP_FILTER (1 << 11)
896 * Only decode/encode grayscale.
898 #define AV_CODEC_FLAG_GRAY (1 << 13)
900 * error[?] variables will be set during encoding.
902 #define AV_CODEC_FLAG_PSNR (1 << 15)
904 * Input bitstream might be truncated at a random location
905 * instead of only at frame boundaries.
907 #define AV_CODEC_FLAG_TRUNCATED (1 << 16)
909 * Use interlaced DCT.
911 #define AV_CODEC_FLAG_INTERLACED_DCT (1 << 18)
915 #define AV_CODEC_FLAG_LOW_DELAY (1 << 19)
917 * Place global headers in extradata instead of every keyframe.
919 #define AV_CODEC_FLAG_GLOBAL_HEADER (1 << 22)
921 * Use only bitexact stuff (except (I)DCT).
923 #define AV_CODEC_FLAG_BITEXACT (1 << 23)
924 /* Fx : Flag for H.263+ extra options */
926 * H.263 advanced intra coding / MPEG-4 AC prediction
928 #define AV_CODEC_FLAG_AC_PRED (1 << 24)
930 * interlaced motion estimation
932 #define AV_CODEC_FLAG_INTERLACED_ME (1 << 29)
933 #define AV_CODEC_FLAG_CLOSED_GOP (1U << 31)
936 * Allow non spec compliant speedup tricks.
938 #define AV_CODEC_FLAG2_FAST (1 << 0)
940 * Skip bitstream encoding.
942 #define AV_CODEC_FLAG2_NO_OUTPUT (1 << 2)
944 * Place global headers at every keyframe instead of in extradata.
946 #define AV_CODEC_FLAG2_LOCAL_HEADER (1 << 3)
949 * timecode is in drop frame format. DEPRECATED!!!!
951 #define AV_CODEC_FLAG2_DROP_FRAME_TIMECODE (1 << 13)
954 * Input bitstream might be truncated at a packet boundaries
955 * instead of only at frame boundaries.
957 #define AV_CODEC_FLAG2_CHUNKS (1 << 15)
959 * Discard cropping information from SPS.
961 #define AV_CODEC_FLAG2_IGNORE_CROP (1 << 16)
964 * Show all frames before the first keyframe
966 #define AV_CODEC_FLAG2_SHOW_ALL (1 << 22)
968 * Export motion vectors through frame side data
970 #define AV_CODEC_FLAG2_EXPORT_MVS (1 << 28)
972 * Do not skip samples and export skip information as frame side data
974 #define AV_CODEC_FLAG2_SKIP_MANUAL (1 << 29)
976 * Do not reset ASS ReadOrder field on flush (subtitles decoding)
978 #define AV_CODEC_FLAG2_RO_FLUSH_NOOP (1 << 30)
980 /* Unsupported options :
981 * Syntax Arithmetic coding (SAC)
982 * Reference Picture Selection
983 * Independent Segment Decoding */
985 /* codec capabilities */
988 * Decoder can use draw_horiz_band callback.
990 #define AV_CODEC_CAP_DRAW_HORIZ_BAND (1 << 0)
992 * Codec uses get_buffer() for allocating buffers and supports custom allocators.
993 * If not set, it might not use get_buffer() at all or use operations that
994 * assume the buffer was allocated by avcodec_default_get_buffer.
996 #define AV_CODEC_CAP_DR1 (1 << 1)
997 #define AV_CODEC_CAP_TRUNCATED (1 << 3)
999 * Encoder or decoder requires flushing with NULL input at the end in order to
1000 * give the complete and correct output.
1002 * NOTE: If this flag is not set, the codec is guaranteed to never be fed with
1003 * with NULL data. The user can still send NULL data to the public encode
1004 * or decode function, but libavcodec will not pass it along to the codec
1005 * unless this flag is set.
1008 * The decoder has a non-zero delay and needs to be fed with avpkt->data=NULL,
1009 * avpkt->size=0 at the end to get the delayed data until the decoder no longer
1013 * The encoder needs to be fed with NULL data at the end of encoding until the
1014 * encoder no longer returns data.
1016 * NOTE: For encoders implementing the AVCodec.encode2() function, setting this
1017 * flag also means that the encoder must set the pts and duration for
1018 * each output packet. If this flag is not set, the pts and duration will
1019 * be determined by libavcodec from the input frame.
1021 #define AV_CODEC_CAP_DELAY (1 << 5)
1023 * Codec can be fed a final frame with a smaller size.
1024 * This can be used to prevent truncation of the last audio samples.
1026 #define AV_CODEC_CAP_SMALL_LAST_FRAME (1 << 6)
1029 * Codec can output multiple frames per AVPacket
1030 * Normally demuxers return one frame at a time, demuxers which do not do
1031 * are connected to a parser to split what they return into proper frames.
1032 * This flag is reserved to the very rare category of codecs which have a
1033 * bitstream that cannot be split into frames without timeconsuming
1034 * operations like full decoding. Demuxers carrying such bitstreams thus
1035 * may return multiple frames in a packet. This has many disadvantages like
1036 * prohibiting stream copy in many cases thus it should only be considered
1039 #define AV_CODEC_CAP_SUBFRAMES (1 << 8)
1041 * Codec is experimental and is thus avoided in favor of non experimental
1044 #define AV_CODEC_CAP_EXPERIMENTAL (1 << 9)
1046 * Codec should fill in channel configuration and samplerate instead of container
1048 #define AV_CODEC_CAP_CHANNEL_CONF (1 << 10)
1050 * Codec supports frame-level multithreading.
1052 #define AV_CODEC_CAP_FRAME_THREADS (1 << 12)
1054 * Codec supports slice-based (or partition-based) multithreading.
1056 #define AV_CODEC_CAP_SLICE_THREADS (1 << 13)
1058 * Codec supports changed parameters at any point.
1060 #define AV_CODEC_CAP_PARAM_CHANGE (1 << 14)
1062 * Codec supports avctx->thread_count == 0 (auto).
1064 #define AV_CODEC_CAP_AUTO_THREADS (1 << 15)
1066 * Audio encoder supports receiving a different number of samples in each call.
1068 #define AV_CODEC_CAP_VARIABLE_FRAME_SIZE (1 << 16)
1070 * Decoder is not a preferred choice for probing.
1071 * This indicates that the decoder is not a good choice for probing.
1072 * It could for example be an expensive to spin up hardware decoder,
1073 * or it could simply not provide a lot of useful information about
1075 * A decoder marked with this flag should only be used as last resort
1076 * choice for probing.
1078 #define AV_CODEC_CAP_AVOID_PROBING (1 << 17)
1080 * Codec is intra only.
1082 #define AV_CODEC_CAP_INTRA_ONLY 0x40000000
1084 * Codec is lossless.
1086 #define AV_CODEC_CAP_LOSSLESS 0x80000000
1089 * Codec is backed by a hardware implementation. Typically used to
1090 * identify a non-hwaccel hardware decoder. For information about hwaccels, use
1091 * avcodec_get_hw_config() instead.
1093 #define AV_CODEC_CAP_HARDWARE (1 << 18)
1096 * Codec is potentially backed by a hardware implementation, but not
1097 * necessarily. This is used instead of AV_CODEC_CAP_HARDWARE, if the
1098 * implementation provides some sort of internal fallback.
1100 #define AV_CODEC_CAP_HYBRID (1 << 19)
1103 * This codec takes the reordered_opaque field from input AVFrames
1104 * and returns it in the corresponding field in AVCodecContext after
1107 #define AV_CODEC_CAP_ENCODER_REORDERED_OPAQUE (1 << 20)
1109 /* Exported side data.
1110 These flags can be passed in AVCodecContext.export_side_data before initialization.
1113 * Export motion vectors through frame side data
1115 #define AV_CODEC_EXPORT_DATA_MVS (1 << 0)
1117 * Export encoder Producer Reference Time through packet side data
1119 #define AV_CODEC_EXPORT_DATA_PRFT (1 << 1)
1123 * This specifies the area which should be displayed.
1124 * Note there may be multiple such areas for one frame.
1126 typedef struct AVPanScan {
1129 * - encoding: Set by user.
1130 * - decoding: Set by libavcodec.
1135 * width and height in 1/16 pel
1136 * - encoding: Set by user.
1137 * - decoding: Set by libavcodec.
1143 * position of the top left corner in 1/16 pel for up to 3 fields/frames
1144 * - encoding: Set by user.
1145 * - decoding: Set by libavcodec.
1147 int16_t position[3][2];
1151 * This structure describes the bitrate properties of an encoded bitstream. It
1152 * roughly corresponds to a subset the VBV parameters for MPEG-2 or HRD
1153 * parameters for H.264/HEVC.
1155 typedef struct AVCPBProperties {
1157 * Maximum bitrate of the stream, in bits per second.
1158 * Zero if unknown or unspecified.
1160 #if FF_API_UNSANITIZED_BITRATES
1163 int64_t max_bitrate;
1166 * Minimum bitrate of the stream, in bits per second.
1167 * Zero if unknown or unspecified.
1169 #if FF_API_UNSANITIZED_BITRATES
1172 int64_t min_bitrate;
1175 * Average bitrate of the stream, in bits per second.
1176 * Zero if unknown or unspecified.
1178 #if FF_API_UNSANITIZED_BITRATES
1181 int64_t avg_bitrate;
1185 * The size of the buffer to which the ratecontrol is applied, in bits.
1186 * Zero if unknown or unspecified.
1191 * The delay between the time the packet this structure is associated with
1192 * is received and the time when it should be decoded, in periods of a 27MHz
1195 * UINT64_MAX when unknown or unspecified.
1201 * This structure supplies correlation between a packet timestamp and a wall clock
1202 * production time. The definition follows the Producer Reference Time ('prft')
1203 * as defined in ISO/IEC 14496-12
1205 typedef struct AVProducerReferenceTime {
1207 * A UTC timestamp, in microseconds, since Unix epoch (e.g, av_gettime()).
1211 } AVProducerReferenceTime;
1214 * The decoder will keep a reference to the frame and may reuse it later.
1216 #define AV_GET_BUFFER_FLAG_REF (1 << 0)
1219 * @defgroup lavc_packet AVPacket
1221 * Types and functions for working with AVPacket.
1224 enum AVPacketSideDataType {
1226 * An AV_PKT_DATA_PALETTE side data packet contains exactly AVPALETTE_SIZE
1227 * bytes worth of palette. This side data signals that a new palette is
1230 AV_PKT_DATA_PALETTE,
1233 * The AV_PKT_DATA_NEW_EXTRADATA is used to notify the codec or the format
1234 * that the extradata buffer was changed and the receiving side should
1235 * act upon it appropriately. The new extradata is embedded in the side
1236 * data buffer and should be immediately used for processing the current
1239 AV_PKT_DATA_NEW_EXTRADATA,
1242 * An AV_PKT_DATA_PARAM_CHANGE side data packet is laid out as follows:
1245 * if (param_flags & AV_SIDE_DATA_PARAM_CHANGE_CHANNEL_COUNT)
1246 * s32le channel_count
1247 * if (param_flags & AV_SIDE_DATA_PARAM_CHANGE_CHANNEL_LAYOUT)
1248 * u64le channel_layout
1249 * if (param_flags & AV_SIDE_DATA_PARAM_CHANGE_SAMPLE_RATE)
1251 * if (param_flags & AV_SIDE_DATA_PARAM_CHANGE_DIMENSIONS)
1256 AV_PKT_DATA_PARAM_CHANGE,
1259 * An AV_PKT_DATA_H263_MB_INFO side data packet contains a number of
1260 * structures with info about macroblocks relevant to splitting the
1261 * packet into smaller packets on macroblock edges (e.g. as for RFC 2190).
1262 * That is, it does not necessarily contain info about all macroblocks,
1263 * as long as the distance between macroblocks in the info is smaller
1264 * than the target payload size.
1265 * Each MB info structure is 12 bytes, and is laid out as follows:
1267 * u32le bit offset from the start of the packet
1268 * u8 current quantizer at the start of the macroblock
1270 * u16le macroblock address within the GOB
1271 * u8 horizontal MV predictor
1272 * u8 vertical MV predictor
1273 * u8 horizontal MV predictor for block number 3
1274 * u8 vertical MV predictor for block number 3
1277 AV_PKT_DATA_H263_MB_INFO,
1280 * This side data should be associated with an audio stream and contains
1281 * ReplayGain information in form of the AVReplayGain struct.
1283 AV_PKT_DATA_REPLAYGAIN,
1286 * This side data contains a 3x3 transformation matrix describing an affine
1287 * transformation that needs to be applied to the decoded video frames for
1288 * correct presentation.
1290 * See libavutil/display.h for a detailed description of the data.
1292 AV_PKT_DATA_DISPLAYMATRIX,
1295 * This side data should be associated with a video stream and contains
1296 * Stereoscopic 3D information in form of the AVStereo3D struct.
1298 AV_PKT_DATA_STEREO3D,
1301 * This side data should be associated with an audio stream and corresponds
1302 * to enum AVAudioServiceType.
1304 AV_PKT_DATA_AUDIO_SERVICE_TYPE,
1307 * This side data contains quality related information from the encoder.
1309 * u32le quality factor of the compressed frame. Allowed range is between 1 (good) and FF_LAMBDA_MAX (bad).
1313 * u64le[error count] sum of squared differences between encoder in and output
1316 AV_PKT_DATA_QUALITY_STATS,
1319 * This side data contains an integer value representing the stream index
1320 * of a "fallback" track. A fallback track indicates an alternate
1321 * track to use when the current track can not be decoded for some reason.
1322 * e.g. no decoder available for codec.
1324 AV_PKT_DATA_FALLBACK_TRACK,
1327 * This side data corresponds to the AVCPBProperties struct.
1329 AV_PKT_DATA_CPB_PROPERTIES,
1332 * Recommmends skipping the specified number of samples
1334 * u32le number of samples to skip from start of this packet
1335 * u32le number of samples to skip from end of this packet
1336 * u8 reason for start skip
1337 * u8 reason for end skip (0=padding silence, 1=convergence)
1340 AV_PKT_DATA_SKIP_SAMPLES,
1343 * An AV_PKT_DATA_JP_DUALMONO side data packet indicates that
1344 * the packet may contain "dual mono" audio specific to Japanese DTV
1345 * and if it is true, recommends only the selected channel to be used.
1347 * u8 selected channels (0=mail/left, 1=sub/right, 2=both)
1350 AV_PKT_DATA_JP_DUALMONO,
1353 * A list of zero terminated key/value strings. There is no end marker for
1354 * the list, so it is required to rely on the side data size to stop.
1356 AV_PKT_DATA_STRINGS_METADATA,
1359 * Subtitle event position
1367 AV_PKT_DATA_SUBTITLE_POSITION,
1370 * Data found in BlockAdditional element of matroska container. There is
1371 * no end marker for the data, so it is required to rely on the side data
1372 * size to recognize the end. 8 byte id (as found in BlockAddId) followed
1375 AV_PKT_DATA_MATROSKA_BLOCKADDITIONAL,
1378 * The optional first identifier line of a WebVTT cue.
1380 AV_PKT_DATA_WEBVTT_IDENTIFIER,
1383 * The optional settings (rendering instructions) that immediately
1384 * follow the timestamp specifier of a WebVTT cue.
1386 AV_PKT_DATA_WEBVTT_SETTINGS,
1389 * A list of zero terminated key/value strings. There is no end marker for
1390 * the list, so it is required to rely on the side data size to stop. This
1391 * side data includes updated metadata which appeared in the stream.
1393 AV_PKT_DATA_METADATA_UPDATE,
1396 * MPEGTS stream ID as uint8_t, this is required to pass the stream ID
1397 * information from the demuxer to the corresponding muxer.
1399 AV_PKT_DATA_MPEGTS_STREAM_ID,
1402 * Mastering display metadata (based on SMPTE-2086:2014). This metadata
1403 * should be associated with a video stream and contains data in the form
1404 * of the AVMasteringDisplayMetadata struct.
1406 AV_PKT_DATA_MASTERING_DISPLAY_METADATA,
1409 * This side data should be associated with a video stream and corresponds
1410 * to the AVSphericalMapping structure.
1412 AV_PKT_DATA_SPHERICAL,
1415 * Content light level (based on CTA-861.3). This metadata should be
1416 * associated with a video stream and contains data in the form of the
1417 * AVContentLightMetadata struct.
1419 AV_PKT_DATA_CONTENT_LIGHT_LEVEL,
1422 * ATSC A53 Part 4 Closed Captions. This metadata should be associated with
1423 * a video stream. A53 CC bitstream is stored as uint8_t in AVPacketSideData.data.
1424 * The number of bytes of CC data is AVPacketSideData.size.
1429 * This side data is encryption initialization data.
1430 * The format is not part of ABI, use av_encryption_init_info_* methods to
1433 AV_PKT_DATA_ENCRYPTION_INIT_INFO,
1436 * This side data contains encryption info for how to decrypt the packet.
1437 * The format is not part of ABI, use av_encryption_info_* methods to access.
1439 AV_PKT_DATA_ENCRYPTION_INFO,
1442 * Active Format Description data consisting of a single byte as specified
1443 * in ETSI TS 101 154 using AVActiveFormatDescription enum.
1448 * Producer Reference Time data corresponding to the AVProducerReferenceTime struct,
1449 * usually exported by some encoders (on demand through the prft flag set in the
1450 * AVCodecContext export_side_data field).
1455 * The number of side data types.
1456 * This is not part of the public API/ABI in the sense that it may
1457 * change when new side data types are added.
1458 * This must stay the last enum value.
1459 * If its value becomes huge, some code using it
1460 * needs to be updated as it assumes it to be smaller than other limits.
1465 #define AV_PKT_DATA_QUALITY_FACTOR AV_PKT_DATA_QUALITY_STATS //DEPRECATED
1467 typedef struct AVPacketSideData {
1470 enum AVPacketSideDataType type;
1474 * This structure stores compressed data. It is typically exported by demuxers
1475 * and then passed as input to decoders, or received as output from encoders and
1476 * then passed to muxers.
1478 * For video, it should typically contain one compressed frame. For audio it may
1479 * contain several compressed frames. Encoders are allowed to output empty
1480 * packets, with no compressed data, containing only side data
1481 * (e.g. to update some stream parameters at the end of encoding).
1483 * AVPacket is one of the few structs in FFmpeg, whose size is a part of public
1484 * ABI. Thus it may be allocated on stack and no new fields can be added to it
1485 * without libavcodec and libavformat major bump.
1487 * The semantics of data ownership depends on the buf field.
1488 * If it is set, the packet data is dynamically allocated and is
1489 * valid indefinitely until a call to av_packet_unref() reduces the
1490 * reference count to 0.
1492 * If the buf field is not set av_packet_ref() would make a copy instead
1493 * of increasing the reference count.
1495 * The side data is always allocated with av_malloc(), copied by
1496 * av_packet_ref() and freed by av_packet_unref().
1498 * @see av_packet_ref
1499 * @see av_packet_unref
1501 typedef struct AVPacket {
1503 * A reference to the reference-counted buffer where the packet data is
1505 * May be NULL, then the packet data is not reference-counted.
1509 * Presentation timestamp in AVStream->time_base units; the time at which
1510 * the decompressed packet will be presented to the user.
1511 * Can be AV_NOPTS_VALUE if it is not stored in the file.
1512 * pts MUST be larger or equal to dts as presentation cannot happen before
1513 * decompression, unless one wants to view hex dumps. Some formats misuse
1514 * the terms dts and pts/cts to mean something different. Such timestamps
1515 * must be converted to true pts/dts before they are stored in AVPacket.
1519 * Decompression timestamp in AVStream->time_base units; the time at which
1520 * the packet is decompressed.
1521 * Can be AV_NOPTS_VALUE if it is not stored in the file.
1528 * A combination of AV_PKT_FLAG values
1532 * Additional packet data that can be provided by the container.
1533 * Packet can contain several types of side information.
1535 AVPacketSideData *side_data;
1536 int side_data_elems;
1539 * Duration of this packet in AVStream->time_base units, 0 if unknown.
1540 * Equals next_pts - this_pts in presentation order.
1544 int64_t pos; ///< byte position in stream, -1 if unknown
1546 #if FF_API_CONVERGENCE_DURATION
1548 * @deprecated Same as the duration field, but as int64_t. This was required
1549 * for Matroska subtitles, whose duration values could overflow when the
1550 * duration field was still an int.
1552 attribute_deprecated
1553 int64_t convergence_duration;
1556 #define AV_PKT_FLAG_KEY 0x0001 ///< The packet contains a keyframe
1557 #define AV_PKT_FLAG_CORRUPT 0x0002 ///< The packet content is corrupted
1559 * Flag is used to discard packets which are required to maintain valid
1560 * decoder state but are not required for output and should be dropped
1563 #define AV_PKT_FLAG_DISCARD 0x0004
1565 * The packet comes from a trusted source.
1567 * Otherwise-unsafe constructs such as arbitrary pointers to data
1568 * outside the packet may be followed.
1570 #define AV_PKT_FLAG_TRUSTED 0x0008
1572 * Flag is used to indicate packets that contain frames that can
1573 * be discarded by the decoder. I.e. Non-reference frames.
1575 #define AV_PKT_FLAG_DISPOSABLE 0x0010
1578 enum AVSideDataParamChangeFlags {
1579 AV_SIDE_DATA_PARAM_CHANGE_CHANNEL_COUNT = 0x0001,
1580 AV_SIDE_DATA_PARAM_CHANGE_CHANNEL_LAYOUT = 0x0002,
1581 AV_SIDE_DATA_PARAM_CHANGE_SAMPLE_RATE = 0x0004,
1582 AV_SIDE_DATA_PARAM_CHANGE_DIMENSIONS = 0x0008,
1588 struct AVCodecInternal;
1592 AV_FIELD_PROGRESSIVE,
1593 AV_FIELD_TT, //< Top coded_first, top displayed first
1594 AV_FIELD_BB, //< Bottom coded first, bottom displayed first
1595 AV_FIELD_TB, //< Top coded first, bottom displayed first
1596 AV_FIELD_BT, //< Bottom coded first, top displayed first
1600 * main external API structure.
1601 * New fields can be added to the end with minor version bumps.
1602 * Removal, reordering and changes to existing fields require a major
1604 * You can use AVOptions (av_opt* / av_set/get*()) to access these fields from user
1606 * The name string for AVOptions options matches the associated command line
1607 * parameter name and can be found in libavcodec/options_table.h
1608 * The AVOption/command line parameter names differ in some cases from the C
1609 * structure field names for historic reasons or brevity.
1610 * sizeof(AVCodecContext) must not be used outside libav*.
1612 typedef struct AVCodecContext {
1614 * information on struct for av_log
1615 * - set by avcodec_alloc_context3
1617 const AVClass *av_class;
1618 int log_level_offset;
1620 enum AVMediaType codec_type; /* see AVMEDIA_TYPE_xxx */
1621 const struct AVCodec *codec;
1622 enum AVCodecID codec_id; /* see AV_CODEC_ID_xxx */
1625 * fourcc (LSB first, so "ABCD" -> ('D'<<24) + ('C'<<16) + ('B'<<8) + 'A').
1626 * This is used to work around some encoder bugs.
1627 * A demuxer should set this to what is stored in the field used to identify the codec.
1628 * If there are multiple such fields in a container then the demuxer should choose the one
1629 * which maximizes the information about the used codec.
1630 * If the codec tag field in a container is larger than 32 bits then the demuxer should
1631 * remap the longer ID to 32 bits with a table or other structure. Alternatively a new
1632 * extra_codec_tag + size could be added but for this a clear advantage must be demonstrated
1634 * - encoding: Set by user, if not then the default based on codec_id will be used.
1635 * - decoding: Set by user, will be converted to uppercase by libavcodec during init.
1637 unsigned int codec_tag;
1642 * Private context used for internal data.
1644 * Unlike priv_data, this is not codec-specific. It is used in general
1645 * libavcodec functions.
1647 struct AVCodecInternal *internal;
1650 * Private data of the user, can be used to carry app specific stuff.
1651 * - encoding: Set by user.
1652 * - decoding: Set by user.
1657 * the average bitrate
1658 * - encoding: Set by user; unused for constant quantizer encoding.
1659 * - decoding: Set by user, may be overwritten by libavcodec
1660 * if this info is available in the stream
1665 * number of bits the bitstream is allowed to diverge from the reference.
1666 * the reference can be CBR (for CBR pass1) or VBR (for pass2)
1667 * - encoding: Set by user; unused for constant quantizer encoding.
1668 * - decoding: unused
1670 int bit_rate_tolerance;
1673 * Global quality for codecs which cannot change it per frame.
1674 * This should be proportional to MPEG-1/2/4 qscale.
1675 * - encoding: Set by user.
1676 * - decoding: unused
1681 * - encoding: Set by user.
1682 * - decoding: unused
1684 int compression_level;
1685 #define FF_COMPRESSION_DEFAULT -1
1689 * - encoding: Set by user.
1690 * - decoding: Set by user.
1696 * - encoding: Set by user.
1697 * - decoding: Set by user.
1702 * some codecs need / can use extradata like Huffman tables.
1703 * MJPEG: Huffman tables
1704 * rv10: additional flags
1705 * MPEG-4: global headers (they can be in the bitstream or here)
1706 * The allocated memory should be AV_INPUT_BUFFER_PADDING_SIZE bytes larger
1707 * than extradata_size to avoid problems if it is read with the bitstream reader.
1708 * The bytewise contents of extradata must not depend on the architecture or CPU endianness.
1709 * Must be allocated with the av_malloc() family of functions.
1710 * - encoding: Set/allocated/freed by libavcodec.
1711 * - decoding: Set/allocated/freed by user.
1717 * This is the fundamental unit of time (in seconds) in terms
1718 * of which frame timestamps are represented. For fixed-fps content,
1719 * timebase should be 1/framerate and timestamp increments should be
1721 * This often, but not always is the inverse of the frame rate or field rate
1722 * for video. 1/time_base is not the average frame rate if the frame rate is not
1725 * Like containers, elementary streams also can store timestamps, 1/time_base
1726 * is the unit in which these timestamps are specified.
1727 * As example of such codec time base see ISO/IEC 14496-2:2001(E)
1728 * vop_time_increment_resolution and fixed_vop_rate
1729 * (fixed_vop_rate == 0 implies that it is different from the framerate)
1731 * - encoding: MUST be set by user.
1732 * - decoding: the use of this field for decoding is deprecated.
1733 * Use framerate instead.
1735 AVRational time_base;
1738 * For some codecs, the time base is closer to the field rate than the frame rate.
1739 * Most notably, H.264 and MPEG-2 specify time_base as half of frame duration
1740 * if no telecine is used ...
1742 * Set to time_base ticks per frame. Default 1, e.g., H.264/MPEG-2 set it to 2.
1744 int ticks_per_frame;
1749 * Encoding: Number of frames delay there will be from the encoder input to
1750 * the decoder output. (we assume the decoder matches the spec)
1751 * Decoding: Number of frames delay in addition to what a standard decoder
1752 * as specified in the spec would produce.
1755 * Number of frames the decoded output will be delayed relative to the
1759 * For encoding, this field is unused (see initial_padding).
1761 * For decoding, this is the number of samples the decoder needs to
1762 * output before the decoder's output is valid. When seeking, you should
1763 * start decoding this many samples prior to your desired seek point.
1765 * - encoding: Set by libavcodec.
1766 * - decoding: Set by libavcodec.
1773 * picture width / height.
1775 * @note Those fields may not match the values of the last
1776 * AVFrame output by avcodec_decode_video2 due frame
1779 * - encoding: MUST be set by user.
1780 * - decoding: May be set by the user before opening the decoder if known e.g.
1781 * from the container. Some decoders will require the dimensions
1782 * to be set by the caller. During decoding, the decoder may
1783 * overwrite those values as required while parsing the data.
1788 * Bitstream width / height, may be different from width/height e.g. when
1789 * the decoded frame is cropped before being output or lowres is enabled.
1791 * @note Those field may not match the value of the last
1792 * AVFrame output by avcodec_receive_frame() due frame
1795 * - encoding: unused
1796 * - decoding: May be set by the user before opening the decoder if known
1797 * e.g. from the container. During decoding, the decoder may
1798 * overwrite those values as required while parsing the data.
1800 int coded_width, coded_height;
1803 * the number of pictures in a group of pictures, or 0 for intra_only
1804 * - encoding: Set by user.
1805 * - decoding: unused
1810 * Pixel format, see AV_PIX_FMT_xxx.
1811 * May be set by the demuxer if known from headers.
1812 * May be overridden by the decoder if it knows better.
1814 * @note This field may not match the value of the last
1815 * AVFrame output by avcodec_receive_frame() due frame
1818 * - encoding: Set by user.
1819 * - decoding: Set by user if known, overridden by libavcodec while
1822 enum AVPixelFormat pix_fmt;
1825 * If non NULL, 'draw_horiz_band' is called by the libavcodec
1826 * decoder to draw a horizontal band. It improves cache usage. Not
1827 * all codecs can do that. You must check the codec capabilities
1829 * When multithreading is used, it may be called from multiple threads
1830 * at the same time; threads might draw different parts of the same AVFrame,
1831 * or multiple AVFrames, and there is no guarantee that slices will be drawn
1833 * The function is also used by hardware acceleration APIs.
1834 * It is called at least once during frame decoding to pass
1835 * the data needed for hardware render.
1836 * In that mode instead of pixel data, AVFrame points to
1837 * a structure specific to the acceleration API. The application
1838 * reads the structure and can change some fields to indicate progress
1840 * - encoding: unused
1841 * - decoding: Set by user.
1842 * @param height the height of the slice
1843 * @param y the y position of the slice
1844 * @param type 1->top field, 2->bottom field, 3->frame
1845 * @param offset offset into the AVFrame.data from which the slice should be read
1847 void (*draw_horiz_band)(struct AVCodecContext *s,
1848 const AVFrame *src, int offset[AV_NUM_DATA_POINTERS],
1849 int y, int type, int height);
1852 * callback to negotiate the pixelFormat
1853 * @param fmt is the list of formats which are supported by the codec,
1854 * it is terminated by -1 as 0 is a valid format, the formats are ordered by quality.
1855 * The first is always the native one.
1856 * @note The callback may be called again immediately if initialization for
1857 * the selected (hardware-accelerated) pixel format failed.
1858 * @warning Behavior is undefined if the callback returns a value not
1859 * in the fmt list of formats.
1860 * @return the chosen format
1861 * - encoding: unused
1862 * - decoding: Set by user, if not set the native format will be chosen.
1864 enum AVPixelFormat (*get_format)(struct AVCodecContext *s, const enum AVPixelFormat * fmt);
1867 * maximum number of B-frames between non-B-frames
1868 * Note: The output will be delayed by max_b_frames+1 relative to the input.
1869 * - encoding: Set by user.
1870 * - decoding: unused
1875 * qscale factor between IP and B-frames
1876 * If > 0 then the last P-frame quantizer will be used (q= lastp_q*factor+offset).
1877 * If < 0 then normal ratecontrol will be done (q= -normal_q*factor+offset).
1878 * - encoding: Set by user.
1879 * - decoding: unused
1881 float b_quant_factor;
1883 #if FF_API_PRIVATE_OPT
1884 /** @deprecated use encoder private options instead */
1885 attribute_deprecated
1886 int b_frame_strategy;
1890 * qscale offset between IP and B-frames
1891 * - encoding: Set by user.
1892 * - decoding: unused
1894 float b_quant_offset;
1897 * Size of the frame reordering buffer in the decoder.
1898 * For MPEG-2 it is 1 IPB or 0 low delay IP.
1899 * - encoding: Set by libavcodec.
1900 * - decoding: Set by libavcodec.
1904 #if FF_API_PRIVATE_OPT
1905 /** @deprecated use encoder private options instead */
1906 attribute_deprecated
1911 * qscale factor between P- and I-frames
1912 * If > 0 then the last P-frame quantizer will be used (q = lastp_q * factor + offset).
1913 * If < 0 then normal ratecontrol will be done (q= -normal_q*factor+offset).
1914 * - encoding: Set by user.
1915 * - decoding: unused
1917 float i_quant_factor;
1920 * qscale offset between P and I-frames
1921 * - encoding: Set by user.
1922 * - decoding: unused
1924 float i_quant_offset;
1927 * luminance masking (0-> disabled)
1928 * - encoding: Set by user.
1929 * - decoding: unused
1934 * temporary complexity masking (0-> disabled)
1935 * - encoding: Set by user.
1936 * - decoding: unused
1938 float temporal_cplx_masking;
1941 * spatial complexity masking (0-> disabled)
1942 * - encoding: Set by user.
1943 * - decoding: unused
1945 float spatial_cplx_masking;
1948 * p block masking (0-> disabled)
1949 * - encoding: Set by user.
1950 * - decoding: unused
1955 * darkness masking (0-> disabled)
1956 * - encoding: Set by user.
1957 * - decoding: unused
1963 * - encoding: Set by libavcodec.
1964 * - decoding: Set by user (or 0).
1968 #if FF_API_PRIVATE_OPT
1969 /** @deprecated use encoder private options instead */
1970 attribute_deprecated
1971 int prediction_method;
1972 #define FF_PRED_LEFT 0
1973 #define FF_PRED_PLANE 1
1974 #define FF_PRED_MEDIAN 2
1978 * slice offsets in the frame in bytes
1979 * - encoding: Set/allocated by libavcodec.
1980 * - decoding: Set/allocated by user (or NULL).
1985 * sample aspect ratio (0 if unknown)
1986 * That is the width of a pixel divided by the height of the pixel.
1987 * Numerator and denominator must be relatively prime and smaller than 256 for some video standards.
1988 * - encoding: Set by user.
1989 * - decoding: Set by libavcodec.
1991 AVRational sample_aspect_ratio;
1994 * motion estimation comparison function
1995 * - encoding: Set by user.
1996 * - decoding: unused
2000 * subpixel motion estimation comparison function
2001 * - encoding: Set by user.
2002 * - decoding: unused
2006 * macroblock comparison function (not supported yet)
2007 * - encoding: Set by user.
2008 * - decoding: unused
2012 * interlaced DCT comparison function
2013 * - encoding: Set by user.
2014 * - decoding: unused
2017 #define FF_CMP_SAD 0
2018 #define FF_CMP_SSE 1
2019 #define FF_CMP_SATD 2
2020 #define FF_CMP_DCT 3
2021 #define FF_CMP_PSNR 4
2022 #define FF_CMP_BIT 5
2024 #define FF_CMP_ZERO 7
2025 #define FF_CMP_VSAD 8
2026 #define FF_CMP_VSSE 9
2027 #define FF_CMP_NSSE 10
2028 #define FF_CMP_W53 11
2029 #define FF_CMP_W97 12
2030 #define FF_CMP_DCTMAX 13
2031 #define FF_CMP_DCT264 14
2032 #define FF_CMP_MEDIAN_SAD 15
2033 #define FF_CMP_CHROMA 256
2036 * ME diamond size & shape
2037 * - encoding: Set by user.
2038 * - decoding: unused
2043 * amount of previous MV predictors (2a+1 x 2a+1 square)
2044 * - encoding: Set by user.
2045 * - decoding: unused
2047 int last_predictor_count;
2049 #if FF_API_PRIVATE_OPT
2050 /** @deprecated use encoder private options instead */
2051 attribute_deprecated
2056 * motion estimation prepass comparison function
2057 * - encoding: Set by user.
2058 * - decoding: unused
2063 * ME prepass diamond size & shape
2064 * - encoding: Set by user.
2065 * - decoding: unused
2071 * - encoding: Set by user.
2072 * - decoding: unused
2074 int me_subpel_quality;
2077 * maximum motion estimation search range in subpel units
2078 * If 0 then no limit.
2080 * - encoding: Set by user.
2081 * - decoding: unused
2087 * - encoding: unused
2088 * - decoding: Set by user.
2091 #define SLICE_FLAG_CODED_ORDER 0x0001 ///< draw_horiz_band() is called in coded order instead of display
2092 #define SLICE_FLAG_ALLOW_FIELD 0x0002 ///< allow draw_horiz_band() with field slices (MPEG-2 field pics)
2093 #define SLICE_FLAG_ALLOW_PLANE 0x0004 ///< allow draw_horiz_band() with 1 component at a time (SVQ1)
2096 * macroblock decision mode
2097 * - encoding: Set by user.
2098 * - decoding: unused
2101 #define FF_MB_DECISION_SIMPLE 0 ///< uses mb_cmp
2102 #define FF_MB_DECISION_BITS 1 ///< chooses the one which needs the fewest bits
2103 #define FF_MB_DECISION_RD 2 ///< rate distortion
2106 * custom intra quantization matrix
2107 * Must be allocated with the av_malloc() family of functions, and will be freed in
2108 * avcodec_free_context().
2109 * - encoding: Set/allocated by user, freed by libavcodec. Can be NULL.
2110 * - decoding: Set/allocated/freed by libavcodec.
2112 uint16_t *intra_matrix;
2115 * custom inter 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 *inter_matrix;
2123 #if FF_API_PRIVATE_OPT
2124 /** @deprecated use encoder private options instead */
2125 attribute_deprecated
2126 int scenechange_threshold;
2128 /** @deprecated use encoder private options instead */
2129 attribute_deprecated
2130 int noise_reduction;
2134 * precision of the intra DC coefficient - 8
2135 * - encoding: Set by user.
2136 * - decoding: Set by libavcodec
2138 int intra_dc_precision;
2141 * Number of macroblock rows at the top which are skipped.
2142 * - encoding: unused
2143 * - decoding: Set by user.
2148 * Number of macroblock rows at the bottom which are skipped.
2149 * - encoding: unused
2150 * - decoding: Set by user.
2155 * minimum MB Lagrange multiplier
2156 * - encoding: Set by user.
2157 * - decoding: unused
2162 * maximum MB Lagrange multiplier
2163 * - encoding: Set by user.
2164 * - decoding: unused
2168 #if FF_API_PRIVATE_OPT
2170 * @deprecated use encoder private options instead
2172 attribute_deprecated
2173 int me_penalty_compensation;
2177 * - encoding: Set by user.
2178 * - decoding: unused
2182 #if FF_API_PRIVATE_OPT
2183 /** @deprecated use encoder private options instead */
2184 attribute_deprecated
2190 * - encoding: Set by user.
2191 * - decoding: unused
2196 * number of reference frames
2197 * - encoding: Set by user.
2198 * - decoding: Set by lavc.
2202 #if FF_API_PRIVATE_OPT
2203 /** @deprecated use encoder private options instead */
2204 attribute_deprecated
2209 * Note: Value depends upon the compare function used for fullpel ME.
2210 * - encoding: Set by user.
2211 * - decoding: unused
2215 #if FF_API_PRIVATE_OPT
2216 /** @deprecated use encoder private options instead */
2217 attribute_deprecated
2222 * Chromaticity coordinates of the source primaries.
2223 * - encoding: Set by user
2224 * - decoding: Set by libavcodec
2226 enum AVColorPrimaries color_primaries;
2229 * Color Transfer Characteristic.
2230 * - encoding: Set by user
2231 * - decoding: Set by libavcodec
2233 enum AVColorTransferCharacteristic color_trc;
2236 * YUV colorspace type.
2237 * - encoding: Set by user
2238 * - decoding: Set by libavcodec
2240 enum AVColorSpace colorspace;
2243 * MPEG vs JPEG YUV range.
2244 * - encoding: Set by user
2245 * - decoding: Set by libavcodec
2247 enum AVColorRange color_range;
2250 * This defines the location of chroma samples.
2251 * - encoding: Set by user
2252 * - decoding: Set by libavcodec
2254 enum AVChromaLocation chroma_sample_location;
2258 * Indicates number of picture subdivisions. Used for parallelized
2260 * - encoding: Set by user
2261 * - decoding: unused
2266 * - encoding: set by libavcodec
2267 * - decoding: Set by user.
2269 enum AVFieldOrder field_order;
2272 int sample_rate; ///< samples per second
2273 int channels; ///< number of audio channels
2276 * audio sample format
2277 * - encoding: Set by user.
2278 * - decoding: Set by libavcodec.
2280 enum AVSampleFormat sample_fmt; ///< sample format
2282 /* The following data should not be initialized. */
2284 * Number of samples per channel in an audio frame.
2286 * - encoding: set by libavcodec in avcodec_open2(). Each submitted frame
2287 * except the last must contain exactly frame_size samples per channel.
2288 * May be 0 when the codec has AV_CODEC_CAP_VARIABLE_FRAME_SIZE set, then the
2289 * frame size is not restricted.
2290 * - decoding: may be set by some decoders to indicate constant frame size
2295 * Frame counter, set by libavcodec.
2297 * - decoding: total number of frames returned from the decoder so far.
2298 * - encoding: total number of frames passed to the encoder so far.
2300 * @note the counter is not incremented if encoding/decoding resulted in
2306 * number of bytes per packet if constant and known or 0
2307 * Used by some WAV based audio codecs.
2312 * Audio cutoff bandwidth (0 means "automatic")
2313 * - encoding: Set by user.
2314 * - decoding: unused
2319 * Audio channel layout.
2320 * - encoding: set by user.
2321 * - decoding: set by user, may be overwritten by libavcodec.
2323 uint64_t channel_layout;
2326 * Request decoder to use this channel layout if it can (0 for default)
2327 * - encoding: unused
2328 * - decoding: Set by user.
2330 uint64_t request_channel_layout;
2333 * Type of service that the audio stream conveys.
2334 * - encoding: Set by user.
2335 * - decoding: Set by libavcodec.
2337 enum AVAudioServiceType audio_service_type;
2340 * desired sample format
2341 * - encoding: Not used.
2342 * - decoding: Set by user.
2343 * Decoder will decode to this format if it can.
2345 enum AVSampleFormat request_sample_fmt;
2348 * This callback is called at the beginning of each frame to get data
2349 * buffer(s) for it. There may be one contiguous buffer for all the data or
2350 * there may be a buffer per each data plane or anything in between. What
2351 * this means is, you may set however many entries in buf[] you feel necessary.
2352 * Each buffer must be reference-counted using the AVBuffer API (see description
2355 * The following fields will be set in the frame before this callback is
2358 * - width, height (video only)
2359 * - sample_rate, channel_layout, nb_samples (audio only)
2360 * Their values may differ from the corresponding values in
2361 * AVCodecContext. This callback must use the frame values, not the codec
2362 * context values, to calculate the required buffer size.
2364 * This callback must fill the following fields in the frame:
2368 * * if the data is planar audio with more than 8 channels, then this
2369 * callback must allocate and fill extended_data to contain all pointers
2370 * to all data planes. data[] must hold as many pointers as it can.
2371 * extended_data must be allocated with av_malloc() and will be freed in
2373 * * otherwise extended_data must point to data
2374 * - buf[] must contain one or more pointers to AVBufferRef structures. Each of
2375 * the frame's data and extended_data pointers must be contained in these. That
2376 * is, one AVBufferRef for each allocated chunk of memory, not necessarily one
2377 * AVBufferRef per data[] entry. See: av_buffer_create(), av_buffer_alloc(),
2378 * and av_buffer_ref().
2379 * - extended_buf and nb_extended_buf must be allocated with av_malloc() by
2380 * this callback and filled with the extra buffers if there are more
2381 * buffers than buf[] can hold. extended_buf will be freed in
2384 * If AV_CODEC_CAP_DR1 is not set then get_buffer2() must call
2385 * avcodec_default_get_buffer2() instead of providing buffers allocated by
2388 * Each data plane must be aligned to the maximum required by the target
2391 * @see avcodec_default_get_buffer2()
2395 * If AV_GET_BUFFER_FLAG_REF is set in flags then the frame may be reused
2396 * (read and/or written to if it is writable) later by libavcodec.
2398 * avcodec_align_dimensions2() should be used to find the required width and
2399 * height, as they normally need to be rounded up to the next multiple of 16.
2401 * Some decoders do not support linesizes changing between frames.
2403 * If frame multithreading is used and thread_safe_callbacks is set,
2404 * this callback may be called from a different thread, but not from more
2405 * than one at once. Does not need to be reentrant.
2407 * @see avcodec_align_dimensions2()
2411 * Decoders request a buffer of a particular size by setting
2412 * AVFrame.nb_samples prior to calling get_buffer2(). The decoder may,
2413 * however, utilize only part of the buffer by setting AVFrame.nb_samples
2414 * to a smaller value in the output frame.
2416 * As a convenience, av_samples_get_buffer_size() and
2417 * av_samples_fill_arrays() in libavutil may be used by custom get_buffer2()
2418 * functions to find the required data size and to fill data pointers and
2419 * linesize. In AVFrame.linesize, only linesize[0] may be set for audio
2420 * since all planes must be the same size.
2422 * @see av_samples_get_buffer_size(), av_samples_fill_arrays()
2424 * - encoding: unused
2425 * - decoding: Set by libavcodec, user can override.
2427 int (*get_buffer2)(struct AVCodecContext *s, AVFrame *frame, int flags);
2430 * If non-zero, the decoded audio and video frames returned from
2431 * avcodec_decode_video2() and avcodec_decode_audio4() are reference-counted
2432 * and are valid indefinitely. The caller must free them with
2433 * av_frame_unref() when they are not needed anymore.
2434 * Otherwise, the decoded frames must not be freed by the caller and are
2435 * only valid until the next decode call.
2437 * This is always automatically enabled if avcodec_receive_frame() is used.
2439 * - encoding: unused
2440 * - decoding: set by the caller before avcodec_open2().
2442 attribute_deprecated
2443 int refcounted_frames;
2445 /* - encoding parameters */
2446 float qcompress; ///< amount of qscale change between easy & hard scenes (0.0-1.0)
2447 float qblur; ///< amount of qscale smoothing over time (0.0-1.0)
2451 * - encoding: Set by user.
2452 * - decoding: unused
2458 * - encoding: Set by user.
2459 * - decoding: unused
2464 * maximum quantizer difference between frames
2465 * - encoding: Set by user.
2466 * - decoding: unused
2471 * decoder bitstream buffer size
2472 * - encoding: Set by user.
2473 * - decoding: unused
2478 * ratecontrol override, see RcOverride
2479 * - encoding: Allocated/set/freed by user.
2480 * - decoding: unused
2482 int rc_override_count;
2483 RcOverride *rc_override;
2487 * - encoding: Set by user.
2488 * - decoding: Set by user, may be overwritten by libavcodec.
2490 int64_t rc_max_rate;
2494 * - encoding: Set by user.
2495 * - decoding: unused
2497 int64_t rc_min_rate;
2500 * Ratecontrol attempt to use, at maximum, <value> of what can be used without an underflow.
2501 * - encoding: Set by user.
2502 * - decoding: unused.
2504 float rc_max_available_vbv_use;
2507 * Ratecontrol attempt to use, at least, <value> times the amount needed to prevent a vbv overflow.
2508 * - encoding: Set by user.
2509 * - decoding: unused.
2511 float rc_min_vbv_overflow_use;
2514 * Number of bits which should be loaded into the rc buffer before decoding starts.
2515 * - encoding: Set by user.
2516 * - decoding: unused
2518 int rc_initial_buffer_occupancy;
2520 #if FF_API_CODER_TYPE
2521 #define FF_CODER_TYPE_VLC 0
2522 #define FF_CODER_TYPE_AC 1
2523 #define FF_CODER_TYPE_RAW 2
2524 #define FF_CODER_TYPE_RLE 3
2526 * @deprecated use encoder private options instead
2528 attribute_deprecated
2530 #endif /* FF_API_CODER_TYPE */
2532 #if FF_API_PRIVATE_OPT
2533 /** @deprecated use encoder private options instead */
2534 attribute_deprecated
2538 #if FF_API_PRIVATE_OPT
2539 /** @deprecated use encoder private options instead */
2540 attribute_deprecated
2541 int frame_skip_threshold;
2543 /** @deprecated use encoder private options instead */
2544 attribute_deprecated
2545 int frame_skip_factor;
2547 /** @deprecated use encoder private options instead */
2548 attribute_deprecated
2551 /** @deprecated use encoder private options instead */
2552 attribute_deprecated
2554 #endif /* FF_API_PRIVATE_OPT */
2557 * trellis RD quantization
2558 * - encoding: Set by user.
2559 * - decoding: unused
2563 #if FF_API_PRIVATE_OPT
2564 /** @deprecated use encoder private options instead */
2565 attribute_deprecated
2566 int min_prediction_order;
2568 /** @deprecated use encoder private options instead */
2569 attribute_deprecated
2570 int max_prediction_order;
2572 /** @deprecated use encoder private options instead */
2573 attribute_deprecated
2574 int64_t timecode_frame_start;
2577 #if FF_API_RTP_CALLBACK
2579 * @deprecated unused
2581 /* The RTP callback: This function is called */
2582 /* every time the encoder has a packet to send. */
2583 /* It depends on the encoder if the data starts */
2584 /* with a Start Code (it should). H.263 does. */
2585 /* mb_nb contains the number of macroblocks */
2586 /* encoded in the RTP payload. */
2587 attribute_deprecated
2588 void (*rtp_callback)(struct AVCodecContext *avctx, void *data, int size, int mb_nb);
2591 #if FF_API_PRIVATE_OPT
2592 /** @deprecated use encoder private options instead */
2593 attribute_deprecated
2594 int rtp_payload_size; /* The size of the RTP payload: the coder will */
2595 /* do its best to deliver a chunk with size */
2596 /* below rtp_payload_size, the chunk will start */
2597 /* with a start code on some codecs like H.263. */
2598 /* This doesn't take account of any particular */
2599 /* headers inside the transmitted RTP payload. */
2602 #if FF_API_STAT_BITS
2603 /* statistics, used for 2-pass encoding */
2604 attribute_deprecated
2606 attribute_deprecated
2608 attribute_deprecated
2610 attribute_deprecated
2612 attribute_deprecated
2614 attribute_deprecated
2616 attribute_deprecated
2618 attribute_deprecated
2621 /** @deprecated this field is unused */
2622 attribute_deprecated
2627 * pass1 encoding statistics output buffer
2628 * - encoding: Set by libavcodec.
2629 * - decoding: unused
2634 * pass2 encoding statistics input buffer
2635 * Concatenated stuff from stats_out of pass1 should be placed here.
2636 * - encoding: Allocated/set/freed by user.
2637 * - decoding: unused
2642 * Work around bugs in encoders which sometimes cannot be detected automatically.
2643 * - encoding: Set by user
2644 * - decoding: Set by user
2646 int workaround_bugs;
2647 #define FF_BUG_AUTODETECT 1 ///< autodetection
2648 #define FF_BUG_XVID_ILACE 4
2649 #define FF_BUG_UMP4 8
2650 #define FF_BUG_NO_PADDING 16
2651 #define FF_BUG_AMV 32
2652 #define FF_BUG_QPEL_CHROMA 64
2653 #define FF_BUG_STD_QPEL 128
2654 #define FF_BUG_QPEL_CHROMA2 256
2655 #define FF_BUG_DIRECT_BLOCKSIZE 512
2656 #define FF_BUG_EDGE 1024
2657 #define FF_BUG_HPEL_CHROMA 2048
2658 #define FF_BUG_DC_CLIP 4096
2659 #define FF_BUG_MS 8192 ///< Work around various bugs in Microsoft's broken decoders.
2660 #define FF_BUG_TRUNCATED 16384
2661 #define FF_BUG_IEDGE 32768
2664 * strictly follow the standard (MPEG-4, ...).
2665 * - encoding: Set by user.
2666 * - decoding: Set by user.
2667 * Setting this to STRICT or higher means the encoder and decoder will
2668 * generally do stupid things, whereas setting it to unofficial or lower
2669 * will mean the encoder might produce output that is not supported by all
2670 * spec-compliant decoders. Decoders don't differentiate between normal,
2671 * unofficial and experimental (that is, they always try to decode things
2672 * when they can) unless they are explicitly asked to behave stupidly
2673 * (=strictly conform to the specs)
2675 int strict_std_compliance;
2676 #define FF_COMPLIANCE_VERY_STRICT 2 ///< Strictly conform to an older more strict version of the spec or reference software.
2677 #define FF_COMPLIANCE_STRICT 1 ///< Strictly conform to all the things in the spec no matter what consequences.
2678 #define FF_COMPLIANCE_NORMAL 0
2679 #define FF_COMPLIANCE_UNOFFICIAL -1 ///< Allow unofficial extensions
2680 #define FF_COMPLIANCE_EXPERIMENTAL -2 ///< Allow nonstandardized experimental things.
2683 * error concealment flags
2684 * - encoding: unused
2685 * - decoding: Set by user.
2687 int error_concealment;
2688 #define FF_EC_GUESS_MVS 1
2689 #define FF_EC_DEBLOCK 2
2690 #define FF_EC_FAVOR_INTER 256
2694 * - encoding: Set by user.
2695 * - decoding: Set by user.
2698 #define FF_DEBUG_PICT_INFO 1
2699 #define FF_DEBUG_RC 2
2700 #define FF_DEBUG_BITSTREAM 4
2701 #define FF_DEBUG_MB_TYPE 8
2702 #define FF_DEBUG_QP 16
2705 * @deprecated this option does nothing
2707 #define FF_DEBUG_MV 32
2709 #define FF_DEBUG_DCT_COEFF 0x00000040
2710 #define FF_DEBUG_SKIP 0x00000080
2711 #define FF_DEBUG_STARTCODE 0x00000100
2712 #define FF_DEBUG_ER 0x00000400
2713 #define FF_DEBUG_MMCO 0x00000800
2714 #define FF_DEBUG_BUGS 0x00001000
2716 #define FF_DEBUG_VIS_QP 0x00002000
2717 #define FF_DEBUG_VIS_MB_TYPE 0x00004000
2719 #define FF_DEBUG_BUFFERS 0x00008000
2720 #define FF_DEBUG_THREADS 0x00010000
2721 #define FF_DEBUG_GREEN_MD 0x00800000
2722 #define FF_DEBUG_NOMC 0x01000000
2727 * - encoding: Set by user.
2728 * - decoding: Set by user.
2731 #define FF_DEBUG_VIS_MV_P_FOR 0x00000001 // visualize forward predicted MVs of P-frames
2732 #define FF_DEBUG_VIS_MV_B_FOR 0x00000002 // visualize forward predicted MVs of B-frames
2733 #define FF_DEBUG_VIS_MV_B_BACK 0x00000004 // visualize backward predicted MVs of B-frames
2737 * Error recognition; may misdetect some more or less valid parts as errors.
2738 * - encoding: unused
2739 * - decoding: Set by user.
2741 int err_recognition;
2744 * Verify checksums embedded in the bitstream (could be of either encoded or
2745 * decoded data, depending on the codec) and print an error message on mismatch.
2746 * If AV_EF_EXPLODE is also set, a mismatching checksum will result in the
2747 * decoder returning an error.
2749 #define AV_EF_CRCCHECK (1<<0)
2750 #define AV_EF_BITSTREAM (1<<1) ///< detect bitstream specification deviations
2751 #define AV_EF_BUFFER (1<<2) ///< detect improper bitstream length
2752 #define AV_EF_EXPLODE (1<<3) ///< abort decoding on minor error detection
2754 #define AV_EF_IGNORE_ERR (1<<15) ///< ignore errors and continue
2755 #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
2756 #define AV_EF_COMPLIANT (1<<17) ///< consider all spec non compliances as errors
2757 #define AV_EF_AGGRESSIVE (1<<18) ///< consider things that a sane encoder should not do as an error
2761 * opaque 64-bit number (generally a PTS) that will be reordered and
2762 * output in AVFrame.reordered_opaque
2763 * - encoding: Set by libavcodec to the reordered_opaque of the input
2764 * frame corresponding to the last returned packet. Only
2765 * supported by encoders with the
2766 * AV_CODEC_CAP_ENCODER_REORDERED_OPAQUE capability.
2767 * - decoding: Set by user.
2769 int64_t reordered_opaque;
2772 * Hardware accelerator in use
2773 * - encoding: unused.
2774 * - decoding: Set by libavcodec
2776 const struct AVHWAccel *hwaccel;
2779 * Hardware accelerator context.
2780 * For some hardware accelerators, a global context needs to be
2781 * provided by the user. In that case, this holds display-dependent
2782 * data FFmpeg cannot instantiate itself. Please refer to the
2783 * FFmpeg HW accelerator documentation to know how to fill this
2784 * is. e.g. for VA API, this is a struct vaapi_context.
2785 * - encoding: unused
2786 * - decoding: Set by user
2788 void *hwaccel_context;
2792 * - encoding: Set by libavcodec if flags & AV_CODEC_FLAG_PSNR.
2793 * - decoding: unused
2795 uint64_t error[AV_NUM_DATA_POINTERS];
2798 * DCT algorithm, see FF_DCT_* below
2799 * - encoding: Set by user.
2800 * - decoding: unused
2803 #define FF_DCT_AUTO 0
2804 #define FF_DCT_FASTINT 1
2805 #define FF_DCT_INT 2
2806 #define FF_DCT_MMX 3
2807 #define FF_DCT_ALTIVEC 5
2808 #define FF_DCT_FAAN 6
2811 * IDCT algorithm, see FF_IDCT_* below.
2812 * - encoding: Set by user.
2813 * - decoding: Set by user.
2816 #define FF_IDCT_AUTO 0
2817 #define FF_IDCT_INT 1
2818 #define FF_IDCT_SIMPLE 2
2819 #define FF_IDCT_SIMPLEMMX 3
2820 #define FF_IDCT_ARM 7
2821 #define FF_IDCT_ALTIVEC 8
2822 #define FF_IDCT_SIMPLEARM 10
2823 #define FF_IDCT_XVID 14
2824 #define FF_IDCT_SIMPLEARMV5TE 16
2825 #define FF_IDCT_SIMPLEARMV6 17
2826 #define FF_IDCT_FAAN 20
2827 #define FF_IDCT_SIMPLENEON 22
2828 #define FF_IDCT_NONE 24 /* Used by XvMC to extract IDCT coefficients with FF_IDCT_PERM_NONE */
2829 #define FF_IDCT_SIMPLEAUTO 128
2832 * bits per sample/pixel from the demuxer (needed for huffyuv).
2833 * - encoding: Set by libavcodec.
2834 * - decoding: Set by user.
2836 int bits_per_coded_sample;
2839 * Bits per sample/pixel of internal libavcodec pixel/sample format.
2840 * - encoding: set by user.
2841 * - decoding: set by libavcodec.
2843 int bits_per_raw_sample;
2847 * low resolution decoding, 1-> 1/2 size, 2->1/4 size
2848 * - encoding: unused
2849 * - decoding: Set by user.
2854 #if FF_API_CODED_FRAME
2856 * the picture in the bitstream
2857 * - encoding: Set by libavcodec.
2858 * - decoding: unused
2860 * @deprecated use the quality factor packet side data instead
2862 attribute_deprecated AVFrame *coded_frame;
2867 * is used to decide how many independent tasks should be passed to execute()
2868 * - encoding: Set by user.
2869 * - decoding: Set by user.
2874 * Which multithreading methods to use.
2875 * Use of FF_THREAD_FRAME will increase decoding delay by one frame per thread,
2876 * so clients which cannot provide future frames should not use it.
2878 * - encoding: Set by user, otherwise the default is used.
2879 * - decoding: Set by user, otherwise the default is used.
2882 #define FF_THREAD_FRAME 1 ///< Decode more than one frame at once
2883 #define FF_THREAD_SLICE 2 ///< Decode more than one part of a single frame at once
2886 * Which multithreading methods are in use by the codec.
2887 * - encoding: Set by libavcodec.
2888 * - decoding: Set by libavcodec.
2890 int active_thread_type;
2893 * Set by the client if its custom get_buffer() callback can be called
2894 * synchronously from another thread, which allows faster multithreaded decoding.
2895 * draw_horiz_band() will be called from other threads regardless of this setting.
2896 * Ignored if the default get_buffer() is used.
2897 * - encoding: Set by user.
2898 * - decoding: Set by user.
2900 int thread_safe_callbacks;
2903 * The codec may call this to execute several independent things.
2904 * It will return only after finishing all tasks.
2905 * The user may replace this with some multithreaded implementation,
2906 * the default implementation will execute the parts serially.
2907 * @param count the number of things to execute
2908 * - encoding: Set by libavcodec, user can override.
2909 * - decoding: Set by libavcodec, user can override.
2911 int (*execute)(struct AVCodecContext *c, int (*func)(struct AVCodecContext *c2, void *arg), void *arg2, int *ret, int count, int size);
2914 * The codec may call this to execute several independent things.
2915 * It will return only after finishing all tasks.
2916 * The user may replace this with some multithreaded implementation,
2917 * the default implementation will execute the parts serially.
2918 * Also see avcodec_thread_init and e.g. the --enable-pthread configure option.
2919 * @param c context passed also to func
2920 * @param count the number of things to execute
2921 * @param arg2 argument passed unchanged to func
2922 * @param ret return values of executed functions, must have space for "count" values. May be NULL.
2923 * @param func function that will be called count times, with jobnr from 0 to count-1.
2924 * threadnr will be in the range 0 to c->thread_count-1 < MAX_THREADS and so that no
2925 * two instances of func executing at the same time will have the same threadnr.
2926 * @return always 0 currently, but code should handle a future improvement where when any call to func
2927 * returns < 0 no further calls to func may be done and < 0 is returned.
2928 * - encoding: Set by libavcodec, user can override.
2929 * - decoding: Set by libavcodec, user can override.
2931 int (*execute2)(struct AVCodecContext *c, int (*func)(struct AVCodecContext *c2, void *arg, int jobnr, int threadnr), void *arg2, int *ret, int count);
2934 * noise vs. sse weight for the nsse comparison function
2935 * - encoding: Set by user.
2936 * - decoding: unused
2942 * - encoding: Set by user.
2943 * - decoding: Set by libavcodec.
2946 #define FF_PROFILE_UNKNOWN -99
2947 #define FF_PROFILE_RESERVED -100
2949 #define FF_PROFILE_AAC_MAIN 0
2950 #define FF_PROFILE_AAC_LOW 1
2951 #define FF_PROFILE_AAC_SSR 2
2952 #define FF_PROFILE_AAC_LTP 3
2953 #define FF_PROFILE_AAC_HE 4
2954 #define FF_PROFILE_AAC_HE_V2 28
2955 #define FF_PROFILE_AAC_LD 22
2956 #define FF_PROFILE_AAC_ELD 38
2957 #define FF_PROFILE_MPEG2_AAC_LOW 128
2958 #define FF_PROFILE_MPEG2_AAC_HE 131
2960 #define FF_PROFILE_DNXHD 0
2961 #define FF_PROFILE_DNXHR_LB 1
2962 #define FF_PROFILE_DNXHR_SQ 2
2963 #define FF_PROFILE_DNXHR_HQ 3
2964 #define FF_PROFILE_DNXHR_HQX 4
2965 #define FF_PROFILE_DNXHR_444 5
2967 #define FF_PROFILE_DTS 20
2968 #define FF_PROFILE_DTS_ES 30
2969 #define FF_PROFILE_DTS_96_24 40
2970 #define FF_PROFILE_DTS_HD_HRA 50
2971 #define FF_PROFILE_DTS_HD_MA 60
2972 #define FF_PROFILE_DTS_EXPRESS 70
2974 #define FF_PROFILE_MPEG2_422 0
2975 #define FF_PROFILE_MPEG2_HIGH 1
2976 #define FF_PROFILE_MPEG2_SS 2
2977 #define FF_PROFILE_MPEG2_SNR_SCALABLE 3
2978 #define FF_PROFILE_MPEG2_MAIN 4
2979 #define FF_PROFILE_MPEG2_SIMPLE 5
2981 #define FF_PROFILE_H264_CONSTRAINED (1<<9) // 8+1; constraint_set1_flag
2982 #define FF_PROFILE_H264_INTRA (1<<11) // 8+3; constraint_set3_flag
2984 #define FF_PROFILE_H264_BASELINE 66
2985 #define FF_PROFILE_H264_CONSTRAINED_BASELINE (66|FF_PROFILE_H264_CONSTRAINED)
2986 #define FF_PROFILE_H264_MAIN 77
2987 #define FF_PROFILE_H264_EXTENDED 88
2988 #define FF_PROFILE_H264_HIGH 100
2989 #define FF_PROFILE_H264_HIGH_10 110
2990 #define FF_PROFILE_H264_HIGH_10_INTRA (110|FF_PROFILE_H264_INTRA)
2991 #define FF_PROFILE_H264_MULTIVIEW_HIGH 118
2992 #define FF_PROFILE_H264_HIGH_422 122
2993 #define FF_PROFILE_H264_HIGH_422_INTRA (122|FF_PROFILE_H264_INTRA)
2994 #define FF_PROFILE_H264_STEREO_HIGH 128
2995 #define FF_PROFILE_H264_HIGH_444 144
2996 #define FF_PROFILE_H264_HIGH_444_PREDICTIVE 244
2997 #define FF_PROFILE_H264_HIGH_444_INTRA (244|FF_PROFILE_H264_INTRA)
2998 #define FF_PROFILE_H264_CAVLC_444 44
3000 #define FF_PROFILE_VC1_SIMPLE 0
3001 #define FF_PROFILE_VC1_MAIN 1
3002 #define FF_PROFILE_VC1_COMPLEX 2
3003 #define FF_PROFILE_VC1_ADVANCED 3
3005 #define FF_PROFILE_MPEG4_SIMPLE 0
3006 #define FF_PROFILE_MPEG4_SIMPLE_SCALABLE 1
3007 #define FF_PROFILE_MPEG4_CORE 2
3008 #define FF_PROFILE_MPEG4_MAIN 3
3009 #define FF_PROFILE_MPEG4_N_BIT 4
3010 #define FF_PROFILE_MPEG4_SCALABLE_TEXTURE 5
3011 #define FF_PROFILE_MPEG4_SIMPLE_FACE_ANIMATION 6
3012 #define FF_PROFILE_MPEG4_BASIC_ANIMATED_TEXTURE 7
3013 #define FF_PROFILE_MPEG4_HYBRID 8
3014 #define FF_PROFILE_MPEG4_ADVANCED_REAL_TIME 9
3015 #define FF_PROFILE_MPEG4_CORE_SCALABLE 10
3016 #define FF_PROFILE_MPEG4_ADVANCED_CODING 11
3017 #define FF_PROFILE_MPEG4_ADVANCED_CORE 12
3018 #define FF_PROFILE_MPEG4_ADVANCED_SCALABLE_TEXTURE 13
3019 #define FF_PROFILE_MPEG4_SIMPLE_STUDIO 14
3020 #define FF_PROFILE_MPEG4_ADVANCED_SIMPLE 15
3022 #define FF_PROFILE_JPEG2000_CSTREAM_RESTRICTION_0 1
3023 #define FF_PROFILE_JPEG2000_CSTREAM_RESTRICTION_1 2
3024 #define FF_PROFILE_JPEG2000_CSTREAM_NO_RESTRICTION 32768
3025 #define FF_PROFILE_JPEG2000_DCINEMA_2K 3
3026 #define FF_PROFILE_JPEG2000_DCINEMA_4K 4
3028 #define FF_PROFILE_VP9_0 0
3029 #define FF_PROFILE_VP9_1 1
3030 #define FF_PROFILE_VP9_2 2
3031 #define FF_PROFILE_VP9_3 3
3033 #define FF_PROFILE_HEVC_MAIN 1
3034 #define FF_PROFILE_HEVC_MAIN_10 2
3035 #define FF_PROFILE_HEVC_MAIN_STILL_PICTURE 3
3036 #define FF_PROFILE_HEVC_REXT 4
3038 #define FF_PROFILE_AV1_MAIN 0
3039 #define FF_PROFILE_AV1_HIGH 1
3040 #define FF_PROFILE_AV1_PROFESSIONAL 2
3042 #define FF_PROFILE_MJPEG_HUFFMAN_BASELINE_DCT 0xc0
3043 #define FF_PROFILE_MJPEG_HUFFMAN_EXTENDED_SEQUENTIAL_DCT 0xc1
3044 #define FF_PROFILE_MJPEG_HUFFMAN_PROGRESSIVE_DCT 0xc2
3045 #define FF_PROFILE_MJPEG_HUFFMAN_LOSSLESS 0xc3
3046 #define FF_PROFILE_MJPEG_JPEG_LS 0xf7
3048 #define FF_PROFILE_SBC_MSBC 1
3050 #define FF_PROFILE_PRORES_PROXY 0
3051 #define FF_PROFILE_PRORES_LT 1
3052 #define FF_PROFILE_PRORES_STANDARD 2
3053 #define FF_PROFILE_PRORES_HQ 3
3054 #define FF_PROFILE_PRORES_4444 4
3055 #define FF_PROFILE_PRORES_XQ 5
3057 #define FF_PROFILE_ARIB_PROFILE_A 0
3058 #define FF_PROFILE_ARIB_PROFILE_C 1
3062 * - encoding: Set by user.
3063 * - decoding: Set by libavcodec.
3066 #define FF_LEVEL_UNKNOWN -99
3069 * Skip loop filtering for selected frames.
3070 * - encoding: unused
3071 * - decoding: Set by user.
3073 enum AVDiscard skip_loop_filter;
3076 * Skip IDCT/dequantization for selected frames.
3077 * - encoding: unused
3078 * - decoding: Set by user.
3080 enum AVDiscard skip_idct;
3083 * Skip decoding for selected frames.
3084 * - encoding: unused
3085 * - decoding: Set by user.
3087 enum AVDiscard skip_frame;
3090 * Header containing style information for text subtitles.
3091 * For SUBTITLE_ASS subtitle type, it should contain the whole ASS
3092 * [Script Info] and [V4+ Styles] section, plus the [Events] line and
3093 * the Format line following. It shouldn't include any Dialogue line.
3094 * - encoding: Set/allocated/freed by user (before avcodec_open2())
3095 * - decoding: Set/allocated/freed by libavcodec (by avcodec_open2())
3097 uint8_t *subtitle_header;
3098 int subtitle_header_size;
3100 #if FF_API_VBV_DELAY
3102 * VBV delay coded in the last frame (in periods of a 27 MHz clock).
3103 * Used for compliant TS muxing.
3104 * - encoding: Set by libavcodec.
3105 * - decoding: unused.
3106 * @deprecated this value is now exported as a part of
3107 * AV_PKT_DATA_CPB_PROPERTIES packet side data
3109 attribute_deprecated
3113 #if FF_API_SIDEDATA_ONLY_PKT
3115 * Encoding only and set by default. Allow encoders to output packets
3116 * that do not contain any encoded data, only side data.
3118 * Some encoders need to output such packets, e.g. to update some stream
3119 * parameters at the end of encoding.
3121 * @deprecated this field disables the default behaviour and
3122 * it is kept only for compatibility.
3124 attribute_deprecated
3125 int side_data_only_packets;
3129 * Audio only. The number of "priming" samples (padding) inserted by the
3130 * encoder at the beginning of the audio. I.e. this number of leading
3131 * decoded samples must be discarded by the caller to get the original audio
3132 * without leading padding.
3134 * - decoding: unused
3135 * - encoding: Set by libavcodec. The timestamps on the output packets are
3136 * adjusted by the encoder so that they always refer to the
3137 * first sample of the data actually contained in the packet,
3138 * including any added padding. E.g. if the timebase is
3139 * 1/samplerate and the timestamp of the first input sample is
3140 * 0, the timestamp of the first output packet will be
3143 int initial_padding;
3146 * - decoding: For codecs that store a framerate value in the compressed
3147 * bitstream, the decoder may export it here. { 0, 1} when
3149 * - encoding: May be used to signal the framerate of CFR content to an
3152 AVRational framerate;
3155 * Nominal unaccelerated pixel format, see AV_PIX_FMT_xxx.
3156 * - encoding: unused.
3157 * - decoding: Set by libavcodec before calling get_format()
3159 enum AVPixelFormat sw_pix_fmt;
3162 * Timebase in which pkt_dts/pts and AVPacket.dts/pts are.
3163 * - encoding unused.
3164 * - decoding set by user.
3166 AVRational pkt_timebase;
3170 * - encoding: unused.
3171 * - decoding: set by libavcodec.
3173 const AVCodecDescriptor *codec_descriptor;
3177 * low resolution decoding, 1-> 1/2 size, 2->1/4 size
3178 * - encoding: unused
3179 * - decoding: Set by user.
3185 * Current statistics for PTS correction.
3186 * - decoding: maintained and used by libavcodec, not intended to be used by user apps
3187 * - encoding: unused
3189 int64_t pts_correction_num_faulty_pts; /// Number of incorrect PTS values so far
3190 int64_t pts_correction_num_faulty_dts; /// Number of incorrect DTS values so far
3191 int64_t pts_correction_last_pts; /// PTS of the last frame
3192 int64_t pts_correction_last_dts; /// DTS of the last frame
3195 * Character encoding of the input subtitles file.
3196 * - decoding: set by user
3197 * - encoding: unused
3202 * Subtitles character encoding mode. Formats or codecs might be adjusting
3203 * this setting (if they are doing the conversion themselves for instance).
3204 * - decoding: set by libavcodec
3205 * - encoding: unused
3207 int sub_charenc_mode;
3208 #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)
3209 #define FF_SUB_CHARENC_MODE_AUTOMATIC 0 ///< libavcodec will select the mode itself
3210 #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
3211 #define FF_SUB_CHARENC_MODE_IGNORE 2 ///< neither convert the subtitles, nor check them for valid UTF-8
3214 * Skip processing alpha if supported by codec.
3215 * Note that if the format uses pre-multiplied alpha (common with VP6,
3216 * and recommended due to better video quality/compression)
3217 * the image will look as if alpha-blended onto a black background.
3218 * However for formats that do not use pre-multiplied alpha
3219 * there might be serious artefacts (though e.g. libswscale currently
3220 * assumes pre-multiplied alpha anyway).
3222 * - decoding: set by user
3223 * - encoding: unused
3228 * Number of samples to skip after a discontinuity
3229 * - decoding: unused
3230 * - encoding: set by libavcodec
3234 #if !FF_API_DEBUG_MV
3236 * debug motion vectors
3237 * - encoding: Set by user.
3238 * - decoding: Set by user.
3241 #define FF_DEBUG_VIS_MV_P_FOR 0x00000001 //visualize forward predicted MVs of P frames
3242 #define FF_DEBUG_VIS_MV_B_FOR 0x00000002 //visualize forward predicted MVs of B frames
3243 #define FF_DEBUG_VIS_MV_B_BACK 0x00000004 //visualize backward predicted MVs of B frames
3247 * custom intra quantization matrix
3248 * - encoding: Set by user, can be NULL.
3249 * - decoding: unused.
3251 uint16_t *chroma_intra_matrix;
3254 * dump format separator.
3255 * can be ", " or "\n " or anything else
3256 * - encoding: Set by user.
3257 * - decoding: Set by user.
3259 uint8_t *dump_separator;
3262 * ',' separated list of allowed decoders.
3263 * If NULL then all are allowed
3264 * - encoding: unused
3265 * - decoding: set by user
3267 char *codec_whitelist;
3270 * Properties of the stream that gets decoded
3271 * - encoding: unused
3272 * - decoding: set by libavcodec
3274 unsigned properties;
3275 #define FF_CODEC_PROPERTY_LOSSLESS 0x00000001
3276 #define FF_CODEC_PROPERTY_CLOSED_CAPTIONS 0x00000002
3279 * Additional data associated with the entire coded stream.
3281 * - decoding: unused
3282 * - encoding: may be set by libavcodec after avcodec_open2().
3284 AVPacketSideData *coded_side_data;
3285 int nb_coded_side_data;
3288 * A reference to the AVHWFramesContext describing the input (for encoding)
3289 * or output (decoding) frames. The reference is set by the caller and
3290 * afterwards owned (and freed) by libavcodec - it should never be read by
3291 * the caller after being set.
3293 * - decoding: This field should be set by the caller from the get_format()
3294 * callback. The previous reference (if any) will always be
3295 * unreffed by libavcodec before the get_format() call.
3297 * If the default get_buffer2() is used with a hwaccel pixel
3298 * format, then this AVHWFramesContext will be used for
3299 * allocating the frame buffers.
3301 * - encoding: For hardware encoders configured to use a hwaccel pixel
3302 * format, this field should be set by the caller to a reference
3303 * to the AVHWFramesContext describing input frames.
3304 * AVHWFramesContext.format must be equal to
3305 * AVCodecContext.pix_fmt.
3307 * This field should be set before avcodec_open2() is called.
3309 AVBufferRef *hw_frames_ctx;
3312 * Control the form of AVSubtitle.rects[N]->ass
3313 * - decoding: set by user
3314 * - encoding: unused
3316 int sub_text_format;
3317 #define FF_SUB_TEXT_FMT_ASS 0
3318 #if FF_API_ASS_TIMING
3319 #define FF_SUB_TEXT_FMT_ASS_WITH_TIMINGS 1
3323 * Audio only. The amount of padding (in samples) appended by the encoder to
3324 * the end of the audio. I.e. this number of decoded samples must be
3325 * discarded by the caller from the end of the stream to get the original
3326 * audio without any trailing padding.
3328 * - decoding: unused
3329 * - encoding: unused
3331 int trailing_padding;
3334 * The number of pixels per image to maximally accept.
3336 * - decoding: set by user
3337 * - encoding: set by user
3342 * A reference to the AVHWDeviceContext describing the device which will
3343 * be used by a hardware encoder/decoder. The reference is set by the
3344 * caller and afterwards owned (and freed) by libavcodec.
3346 * This should be used if either the codec device does not require
3347 * hardware frames or any that are used are to be allocated internally by
3348 * libavcodec. If the user wishes to supply any of the frames used as
3349 * encoder input or decoder output then hw_frames_ctx should be used
3350 * instead. When hw_frames_ctx is set in get_format() for a decoder, this
3351 * field will be ignored while decoding the associated stream segment, but
3352 * may again be used on a following one after another get_format() call.
3354 * For both encoders and decoders this field should be set before
3355 * avcodec_open2() is called and must not be written to thereafter.
3357 * Note that some decoders may require this field to be set initially in
3358 * order to support hw_frames_ctx at all - in that case, all frames
3359 * contexts used must be created on the same device.
3361 AVBufferRef *hw_device_ctx;
3364 * Bit set of AV_HWACCEL_FLAG_* flags, which affect hardware accelerated
3365 * decoding (if active).
3366 * - encoding: unused
3367 * - decoding: Set by user (either before avcodec_open2(), or in the
3368 * AVCodecContext.get_format callback)
3373 * Video decoding only. Certain video codecs support cropping, meaning that
3374 * only a sub-rectangle of the decoded frame is intended for display. This
3375 * option controls how cropping is handled by libavcodec.
3377 * When set to 1 (the default), libavcodec will apply cropping internally.
3378 * I.e. it will modify the output frame width/height fields and offset the
3379 * data pointers (only by as much as possible while preserving alignment, or
3380 * by the full amount if the AV_CODEC_FLAG_UNALIGNED flag is set) so that
3381 * the frames output by the decoder refer only to the cropped area. The
3382 * crop_* fields of the output frames will be zero.
3384 * When set to 0, the width/height fields of the output frames will be set
3385 * to the coded dimensions and the crop_* fields will describe the cropping
3386 * rectangle. Applying the cropping is left to the caller.
3388 * @warning When hardware acceleration with opaque output frames is used,
3389 * libavcodec is unable to apply cropping from the top/left border.
3391 * @note when this option is set to zero, the width/height fields of the
3392 * AVCodecContext and output AVFrames have different meanings. The codec
3393 * context fields store display dimensions (with the coded dimensions in
3394 * coded_width/height), while the frame fields store the coded dimensions
3395 * (with the display dimensions being determined by the crop_* fields).
3400 * Video decoding only. Sets the number of extra hardware frames which
3401 * the decoder will allocate for use by the caller. This must be set
3402 * before avcodec_open2() is called.
3404 * Some hardware decoders require all frames that they will use for
3405 * output to be defined in advance before decoding starts. For such
3406 * decoders, the hardware frame pool must therefore be of a fixed size.
3407 * The extra frames set here are on top of any number that the decoder
3408 * needs internally in order to operate normally (for example, frames
3409 * used as reference pictures).
3411 int extra_hw_frames;
3414 * The percentage of damaged samples to discard a frame.
3416 * - decoding: set by user
3417 * - encoding: unused
3419 int discard_damaged_percentage;
3422 * The number of samples per frame to maximally accept.
3424 * - decoding: set by user
3425 * - encoding: set by user
3427 int64_t max_samples;
3430 * Bit set of AV_CODEC_EXPORT_DATA_* flags, which affects the kind of
3431 * metadata exported in frame, packet, or coded stream side data by
3432 * decoders and encoders.
3434 * - decoding: set by user
3435 * - encoding: set by user
3437 int export_side_data;
3440 #if FF_API_CODEC_GET_SET
3442 * Accessors for some AVCodecContext fields. These used to be provided for ABI
3443 * compatibility, and do not need to be used anymore.
3445 attribute_deprecated
3446 AVRational av_codec_get_pkt_timebase (const AVCodecContext *avctx);
3447 attribute_deprecated
3448 void av_codec_set_pkt_timebase (AVCodecContext *avctx, AVRational val);
3450 attribute_deprecated
3451 const AVCodecDescriptor *av_codec_get_codec_descriptor(const AVCodecContext *avctx);
3452 attribute_deprecated
3453 void av_codec_set_codec_descriptor(AVCodecContext *avctx, const AVCodecDescriptor *desc);
3455 attribute_deprecated
3456 unsigned av_codec_get_codec_properties(const AVCodecContext *avctx);
3459 attribute_deprecated
3460 int av_codec_get_lowres(const AVCodecContext *avctx);
3461 attribute_deprecated
3462 void av_codec_set_lowres(AVCodecContext *avctx, int val);
3465 attribute_deprecated
3466 int av_codec_get_seek_preroll(const AVCodecContext *avctx);
3467 attribute_deprecated
3468 void av_codec_set_seek_preroll(AVCodecContext *avctx, int val);
3470 attribute_deprecated
3471 uint16_t *av_codec_get_chroma_intra_matrix(const AVCodecContext *avctx);
3472 attribute_deprecated
3473 void av_codec_set_chroma_intra_matrix(AVCodecContext *avctx, uint16_t *val);
3479 typedef struct AVProfile {
3481 const char *name; ///< short name for the profile
3486 * The codec supports this format via the hw_device_ctx interface.
3488 * When selecting this format, AVCodecContext.hw_device_ctx should
3489 * have been set to a device of the specified type before calling
3492 AV_CODEC_HW_CONFIG_METHOD_HW_DEVICE_CTX = 0x01,
3494 * The codec supports this format via the hw_frames_ctx interface.
3496 * When selecting this format for a decoder,
3497 * AVCodecContext.hw_frames_ctx should be set to a suitable frames
3498 * context inside the get_format() callback. The frames context
3499 * must have been created on a device of the specified type.
3501 AV_CODEC_HW_CONFIG_METHOD_HW_FRAMES_CTX = 0x02,
3503 * The codec supports this format by some internal method.
3505 * This format can be selected without any additional configuration -
3506 * no device or frames context is required.
3508 AV_CODEC_HW_CONFIG_METHOD_INTERNAL = 0x04,
3510 * The codec supports this format by some ad-hoc method.
3512 * Additional settings and/or function calls are required. See the
3513 * codec-specific documentation for details. (Methods requiring
3514 * this sort of configuration are deprecated and others should be
3515 * used in preference.)
3517 AV_CODEC_HW_CONFIG_METHOD_AD_HOC = 0x08,
3520 typedef struct AVCodecHWConfig {
3522 * A hardware pixel format which the codec can use.
3524 enum AVPixelFormat pix_fmt;
3526 * Bit set of AV_CODEC_HW_CONFIG_METHOD_* flags, describing the possible
3527 * setup methods which can be used with this configuration.
3531 * The device type associated with the configuration.
3533 * Must be set for AV_CODEC_HW_CONFIG_METHOD_HW_DEVICE_CTX and
3534 * AV_CODEC_HW_CONFIG_METHOD_HW_FRAMES_CTX, otherwise unused.
3536 enum AVHWDeviceType device_type;
3539 typedef struct AVCodecDefault AVCodecDefault;
3546 typedef struct AVCodec {
3548 * Name of the codec implementation.
3549 * The name is globally unique among encoders and among decoders (but an
3550 * encoder and a decoder can share the same name).
3551 * This is the primary way to find a codec from the user perspective.
3555 * Descriptive name for the codec, meant to be more human readable than name.
3556 * You should use the NULL_IF_CONFIG_SMALL() macro to define it.
3558 const char *long_name;
3559 enum AVMediaType type;
3562 * Codec capabilities.
3563 * see AV_CODEC_CAP_*
3566 const AVRational *supported_framerates; ///< array of supported framerates, or NULL if any, array is terminated by {0,0}
3567 const enum AVPixelFormat *pix_fmts; ///< array of supported pixel formats, or NULL if unknown, array is terminated by -1
3568 const int *supported_samplerates; ///< array of supported audio samplerates, or NULL if unknown, array is terminated by 0
3569 const enum AVSampleFormat *sample_fmts; ///< array of supported sample formats, or NULL if unknown, array is terminated by -1
3570 const uint64_t *channel_layouts; ///< array of support channel layouts, or NULL if unknown. array is terminated by 0
3571 uint8_t max_lowres; ///< maximum value for lowres supported by the decoder
3572 const AVClass *priv_class; ///< AVClass for the private context
3573 const AVProfile *profiles; ///< array of recognized profiles, or NULL if unknown, array is terminated by {FF_PROFILE_UNKNOWN}
3576 * Group name of the codec implementation.
3577 * This is a short symbolic name of the wrapper backing this codec. A
3578 * wrapper uses some kind of external implementation for the codec, such
3579 * as an external library, or a codec implementation provided by the OS or
3581 * If this field is NULL, this is a builtin, libavcodec native codec.
3582 * If non-NULL, this will be the suffix in AVCodec.name in most cases
3583 * (usually AVCodec.name will be of the form "<codec_name>_<wrapper_name>").
3585 const char *wrapper_name;
3587 /*****************************************************************
3588 * No fields below this line are part of the public API. They
3589 * may not be used outside of libavcodec and can be changed and
3591 * New public fields should be added right above.
3592 *****************************************************************
3595 struct AVCodec *next;
3597 * @name Frame-level threading support functions
3601 * If defined, called on thread contexts when they are created.
3602 * If the codec allocates writable tables in init(), re-allocate them here.
3603 * priv_data will be set to a copy of the original.
3605 int (*init_thread_copy)(AVCodecContext *);
3607 * Copy necessary context variables from a previous thread context to the current one.
3608 * If not defined, the next thread will start automatically; otherwise, the codec
3609 * must call ff_thread_finish_setup().
3611 * dst and src will (rarely) point to the same context, in which case memcpy should be skipped.
3613 int (*update_thread_context)(AVCodecContext *dst, const AVCodecContext *src);
3617 * Private codec-specific defaults.
3619 const AVCodecDefault *defaults;
3622 * Initialize codec static data, called from avcodec_register().
3624 * This is not intended for time consuming operations as it is
3625 * run for every codec regardless of that codec being used.
3627 void (*init_static_data)(struct AVCodec *codec);
3629 int (*init)(AVCodecContext *);
3630 int (*encode_sub)(AVCodecContext *, uint8_t *buf, int buf_size,
3631 const struct AVSubtitle *sub);
3633 * Encode data to an AVPacket.
3635 * @param avctx codec context
3636 * @param avpkt output AVPacket (may contain a user-provided buffer)
3637 * @param[in] frame AVFrame containing the raw data to be encoded
3638 * @param[out] got_packet_ptr encoder sets to 0 or 1 to indicate that a
3639 * non-empty packet was returned in avpkt.
3640 * @return 0 on success, negative error code on failure
3642 int (*encode2)(AVCodecContext *avctx, AVPacket *avpkt, const AVFrame *frame,
3643 int *got_packet_ptr);
3644 int (*decode)(AVCodecContext *, void *outdata, int *outdata_size, AVPacket *avpkt);
3645 int (*close)(AVCodecContext *);
3647 * Encode API with decoupled packet/frame dataflow. The API is the
3648 * same as the avcodec_ prefixed APIs (avcodec_send_frame() etc.), except
3650 * - never called if the codec is closed or the wrong type,
3651 * - if AV_CODEC_CAP_DELAY is not set, drain frames are never sent,
3652 * - only one drain frame is ever passed down,
3654 int (*send_frame)(AVCodecContext *avctx, const AVFrame *frame);
3655 int (*receive_packet)(AVCodecContext *avctx, AVPacket *avpkt);
3658 * Decode API with decoupled packet/frame dataflow. This function is called
3659 * to get one output frame. It should call ff_decode_get_packet() to obtain
3662 int (*receive_frame)(AVCodecContext *avctx, AVFrame *frame);
3665 * Will be called when seeking
3667 void (*flush)(AVCodecContext *);
3669 * Internal codec capabilities.
3670 * See FF_CODEC_CAP_* in internal.h
3675 * Decoding only, a comma-separated list of bitstream filters to apply to
3676 * packets before decoding.
3681 * Array of pointers to hardware configurations supported by the codec,
3682 * or NULL if no hardware supported. The array is terminated by a NULL
3685 * The user can only access this field via avcodec_get_hw_config().
3687 const struct AVCodecHWConfigInternal **hw_configs;
3690 * List of supported codec_tags, terminated by FF_CODEC_TAGS_END.
3692 const uint32_t *codec_tags;
3695 #if FF_API_CODEC_GET_SET
3696 attribute_deprecated
3697 int av_codec_get_max_lowres(const AVCodec *codec);
3700 struct MpegEncContext;
3703 * Retrieve supported hardware configurations for a codec.
3705 * Values of index from zero to some maximum return the indexed configuration
3706 * descriptor; all other values return NULL. If the codec does not support
3707 * any hardware configurations then it will always return NULL.
3709 const AVCodecHWConfig *avcodec_get_hw_config(const AVCodec *codec, int index);
3712 * @defgroup lavc_hwaccel AVHWAccel
3714 * @note Nothing in this structure should be accessed by the user. At some
3715 * point in future it will not be externally visible at all.
3719 typedef struct AVHWAccel {
3721 * Name of the hardware accelerated codec.
3722 * The name is globally unique among encoders and among decoders (but an
3723 * encoder and a decoder can share the same name).
3728 * Type of codec implemented by the hardware accelerator.
3730 * See AVMEDIA_TYPE_xxx
3732 enum AVMediaType type;
3735 * Codec implemented by the hardware accelerator.
3737 * See AV_CODEC_ID_xxx
3742 * Supported pixel format.
3744 * Only hardware accelerated formats are supported here.
3746 enum AVPixelFormat pix_fmt;
3749 * Hardware accelerated codec capabilities.
3750 * see AV_HWACCEL_CODEC_CAP_*
3754 /*****************************************************************
3755 * No fields below this line are part of the public API. They
3756 * may not be used outside of libavcodec and can be changed and
3758 * New public fields should be added right above.
3759 *****************************************************************
3763 * Allocate a custom buffer
3765 int (*alloc_frame)(AVCodecContext *avctx, AVFrame *frame);
3768 * Called at the beginning of each frame or field picture.
3770 * Meaningful frame information (codec specific) is guaranteed to
3771 * be parsed at this point. This function is mandatory.
3773 * Note that buf can be NULL along with buf_size set to 0.
3774 * Otherwise, this means the whole frame is available at this point.
3776 * @param avctx the codec context
3777 * @param buf the frame data buffer base
3778 * @param buf_size the size of the frame in bytes
3779 * @return zero if successful, a negative value otherwise
3781 int (*start_frame)(AVCodecContext *avctx, const uint8_t *buf, uint32_t buf_size);
3784 * Callback for parameter data (SPS/PPS/VPS etc).
3786 * Useful for hardware decoders which keep persistent state about the
3787 * video parameters, and need to receive any changes to update that state.
3789 * @param avctx the codec context
3790 * @param type the nal unit type
3791 * @param buf the nal unit data buffer
3792 * @param buf_size the size of the nal unit in bytes
3793 * @return zero if successful, a negative value otherwise
3795 int (*decode_params)(AVCodecContext *avctx, int type, const uint8_t *buf, uint32_t buf_size);
3798 * Callback for each slice.
3800 * Meaningful slice information (codec specific) is guaranteed to
3801 * be parsed at this point. This function is mandatory.
3802 * The only exception is XvMC, that works on MB level.
3804 * @param avctx the codec context
3805 * @param buf the slice data buffer base
3806 * @param buf_size the size of the slice in bytes
3807 * @return zero if successful, a negative value otherwise
3809 int (*decode_slice)(AVCodecContext *avctx, const uint8_t *buf, uint32_t buf_size);
3812 * Called at the end of each frame or field picture.
3814 * The whole picture is parsed at this point and can now be sent
3815 * to the hardware accelerator. This function is mandatory.
3817 * @param avctx the codec context
3818 * @return zero if successful, a negative value otherwise
3820 int (*end_frame)(AVCodecContext *avctx);
3823 * Size of per-frame hardware accelerator private data.
3825 * Private data is allocated with av_mallocz() before
3826 * AVCodecContext.get_buffer() and deallocated after
3827 * AVCodecContext.release_buffer().
3829 int frame_priv_data_size;
3832 * Called for every Macroblock in a slice.
3834 * XvMC uses it to replace the ff_mpv_reconstruct_mb().
3835 * Instead of decoding to raw picture, MB parameters are
3836 * stored in an array provided by the video driver.
3838 * @param s the mpeg context
3840 void (*decode_mb)(struct MpegEncContext *s);
3843 * Initialize the hwaccel private data.
3845 * This will be called from ff_get_format(), after hwaccel and
3846 * hwaccel_context are set and the hwaccel private data in AVCodecInternal
3849 int (*init)(AVCodecContext *avctx);
3852 * Uninitialize the hwaccel private data.
3854 * This will be called from get_format() or avcodec_close(), after hwaccel
3855 * and hwaccel_context are already uninitialized.
3857 int (*uninit)(AVCodecContext *avctx);
3860 * Size of the private data to allocate in
3861 * AVCodecInternal.hwaccel_priv_data.
3866 * Internal hwaccel capabilities.
3871 * Fill the given hw_frames context with current codec parameters. Called
3872 * from get_format. Refer to avcodec_get_hw_frames_parameters() for
3875 * This CAN be called before AVHWAccel.init is called, and you must assume
3876 * that avctx->hwaccel_priv_data is invalid.
3878 int (*frame_params)(AVCodecContext *avctx, AVBufferRef *hw_frames_ctx);
3882 * HWAccel is experimental and is thus avoided in favor of non experimental
3885 #define AV_HWACCEL_CODEC_CAP_EXPERIMENTAL 0x0200
3888 * Hardware acceleration should be used for decoding even if the codec level
3889 * used is unknown or higher than the maximum supported level reported by the
3892 * It's generally a good idea to pass this flag unless you have a specific
3893 * reason not to, as hardware tends to under-report supported levels.
3895 #define AV_HWACCEL_FLAG_IGNORE_LEVEL (1 << 0)
3898 * Hardware acceleration can output YUV pixel formats with a different chroma
3899 * sampling than 4:2:0 and/or other than 8 bits per component.
3901 #define AV_HWACCEL_FLAG_ALLOW_HIGH_DEPTH (1 << 1)
3904 * Hardware acceleration should still be attempted for decoding when the
3905 * codec profile does not match the reported capabilities of the hardware.
3907 * For example, this can be used to try to decode baseline profile H.264
3908 * streams in hardware - it will often succeed, because many streams marked
3909 * as baseline profile actually conform to constrained baseline profile.
3911 * @warning If the stream is actually not supported then the behaviour is
3912 * undefined, and may include returning entirely incorrect output
3913 * while indicating success.
3915 #define AV_HWACCEL_FLAG_ALLOW_PROFILE_MISMATCH (1 << 2)
3921 #if FF_API_AVPICTURE
3923 * @defgroup lavc_picture AVPicture
3925 * Functions for working with AVPicture
3930 * Picture data structure.
3932 * Up to four components can be stored into it, the last component is
3934 * @deprecated use AVFrame or imgutils functions instead
3936 typedef struct AVPicture {
3937 attribute_deprecated
3938 uint8_t *data[AV_NUM_DATA_POINTERS]; ///< pointers to the image data planes
3939 attribute_deprecated
3940 int linesize[AV_NUM_DATA_POINTERS]; ///< number of bytes per line
3948 enum AVSubtitleType {
3951 SUBTITLE_BITMAP, ///< A bitmap, pict will be set
3954 * Plain text, the text field must be set by the decoder and is
3955 * authoritative. ass and pict fields may contain approximations.
3960 * Formatted text, the ass field must be set by the decoder and is
3961 * authoritative. pict and text fields may contain approximations.
3966 #define AV_SUBTITLE_FLAG_FORCED 0x00000001
3968 typedef struct AVSubtitleRect {
3969 int x; ///< top left corner of pict, undefined when pict is not set
3970 int y; ///< top left corner of pict, undefined when pict is not set
3971 int w; ///< width of pict, undefined when pict is not set
3972 int h; ///< height of pict, undefined when pict is not set
3973 int nb_colors; ///< number of colors in pict, undefined when pict is not set
3975 #if FF_API_AVPICTURE
3977 * @deprecated unused
3979 attribute_deprecated
3983 * data+linesize for the bitmap of this subtitle.
3984 * Can be set for text/ass as well once they are rendered.
3989 enum AVSubtitleType type;
3991 char *text; ///< 0 terminated plain UTF-8 text
3994 * 0 terminated ASS/SSA compatible event line.
3995 * The presentation of this is unaffected by the other values in this
4003 typedef struct AVSubtitle {
4004 uint16_t format; /* 0 = graphics */
4005 uint32_t start_display_time; /* relative to packet pts, in ms */
4006 uint32_t end_display_time; /* relative to packet pts, in ms */
4008 AVSubtitleRect **rects;
4009 int64_t pts; ///< Same as packet pts, in AV_TIME_BASE
4013 * This struct describes the properties of an encoded stream.
4015 * sizeof(AVCodecParameters) is not a part of the public ABI, this struct must
4016 * be allocated with avcodec_parameters_alloc() and freed with
4017 * avcodec_parameters_free().
4019 typedef struct AVCodecParameters {
4021 * General type of the encoded data.
4023 enum AVMediaType codec_type;
4025 * Specific type of the encoded data (the codec used).
4027 enum AVCodecID codec_id;
4029 * Additional information about the codec (corresponds to the AVI FOURCC).
4034 * Extra binary data needed for initializing the decoder, codec-dependent.
4036 * Must be allocated with av_malloc() and will be freed by
4037 * avcodec_parameters_free(). The allocated size of extradata must be at
4038 * least extradata_size + AV_INPUT_BUFFER_PADDING_SIZE, with the padding
4043 * Size of the extradata content in bytes.
4048 * - video: the pixel format, the value corresponds to enum AVPixelFormat.
4049 * - audio: the sample format, the value corresponds to enum AVSampleFormat.
4054 * The average bitrate of the encoded data (in bits per second).
4059 * The number of bits per sample in the codedwords.
4061 * This is basically the bitrate per sample. It is mandatory for a bunch of
4062 * formats to actually decode them. It's the number of bits for one sample in
4063 * the actual coded bitstream.
4065 * This could be for example 4 for ADPCM
4066 * For PCM formats this matches bits_per_raw_sample
4069 int bits_per_coded_sample;
4072 * This is the number of valid bits in each output sample. If the
4073 * sample format has more bits, the least significant bits are additional
4074 * padding bits, which are always 0. Use right shifts to reduce the sample
4075 * to its actual size. For example, audio formats with 24 bit samples will
4076 * have bits_per_raw_sample set to 24, and format set to AV_SAMPLE_FMT_S32.
4077 * To get the original sample use "(int32_t)sample >> 8"."
4079 * For ADPCM this might be 12 or 16 or similar
4082 int bits_per_raw_sample;
4085 * Codec-specific bitstream restrictions that the stream conforms to.
4091 * Video only. The dimensions of the video frame in pixels.
4097 * Video only. The aspect ratio (width / height) which a single pixel
4098 * should have when displayed.
4100 * When the aspect ratio is unknown / undefined, the numerator should be
4101 * set to 0 (the denominator may have any value).
4103 AVRational sample_aspect_ratio;
4106 * Video only. The order of the fields in interlaced video.
4108 enum AVFieldOrder field_order;
4111 * Video only. Additional colorspace characteristics.
4113 enum AVColorRange color_range;
4114 enum AVColorPrimaries color_primaries;
4115 enum AVColorTransferCharacteristic color_trc;
4116 enum AVColorSpace color_space;
4117 enum AVChromaLocation chroma_location;
4120 * Video only. Number of delayed frames.
4125 * Audio only. The channel layout bitmask. May be 0 if the channel layout is
4126 * unknown or unspecified, otherwise the number of bits set must be equal to
4127 * the channels field.
4129 uint64_t channel_layout;
4131 * Audio only. The number of audio channels.
4135 * Audio only. The number of audio samples per second.
4139 * Audio only. The number of bytes per coded audio frame, required by some
4142 * Corresponds to nBlockAlign in WAVEFORMATEX.
4146 * Audio only. Audio frame size, if known. Required by some formats to be static.
4151 * Audio only. The amount of padding (in samples) inserted by the encoder at
4152 * the beginning of the audio. I.e. this number of leading decoded samples
4153 * must be discarded by the caller to get the original audio without leading
4156 int initial_padding;
4158 * Audio only. The amount of padding (in samples) appended by the encoder to
4159 * the end of the audio. I.e. this number of decoded samples must be
4160 * discarded by the caller from the end of the stream to get the original
4161 * audio without any trailing padding.
4163 int trailing_padding;
4165 * Audio only. Number of samples to skip after a discontinuity.
4168 } AVCodecParameters;
4171 * Iterate over all registered codecs.
4173 * @param opaque a pointer where libavcodec will store the iteration state. Must
4174 * point to NULL to start the iteration.
4176 * @return the next registered codec or NULL when the iteration is
4179 const AVCodec *av_codec_iterate(void **opaque);
4183 * If c is NULL, returns the first registered codec,
4184 * if c is non-NULL, returns the next registered codec after c,
4185 * or NULL if c is the last one.
4187 attribute_deprecated
4188 AVCodec *av_codec_next(const AVCodec *c);
4192 * Return the LIBAVCODEC_VERSION_INT constant.
4194 unsigned avcodec_version(void);
4197 * Return the libavcodec build-time configuration.
4199 const char *avcodec_configuration(void);
4202 * Return the libavcodec license.
4204 const char *avcodec_license(void);
4208 * Register the codec codec and initialize libavcodec.
4210 * @warning either this function or avcodec_register_all() must be called
4211 * before any other libavcodec functions.
4213 * @see avcodec_register_all()
4215 attribute_deprecated
4216 void avcodec_register(AVCodec *codec);
4219 * Register all the codecs, parsers and bitstream filters which were enabled at
4220 * configuration time. If you do not call this function you can select exactly
4221 * which formats you want to support, by using the individual registration
4224 * @see avcodec_register
4225 * @see av_register_codec_parser
4226 * @see av_register_bitstream_filter
4228 attribute_deprecated
4229 void avcodec_register_all(void);
4233 * Allocate an AVCodecContext and set its fields to default values. The
4234 * resulting struct should be freed with avcodec_free_context().
4236 * @param codec if non-NULL, allocate private data and initialize defaults
4237 * for the given codec. It is illegal to then call avcodec_open2()
4238 * with a different codec.
4239 * If NULL, then the codec-specific defaults won't be initialized,
4240 * which may result in suboptimal default settings (this is
4241 * important mainly for encoders, e.g. libx264).
4243 * @return An AVCodecContext filled with default values or NULL on failure.
4245 AVCodecContext *avcodec_alloc_context3(const AVCodec *codec);
4248 * Free the codec context and everything associated with it and write NULL to
4249 * the provided pointer.
4251 void avcodec_free_context(AVCodecContext **avctx);
4253 #if FF_API_GET_CONTEXT_DEFAULTS
4255 * @deprecated This function should not be used, as closing and opening a codec
4256 * context multiple time is not supported. A new codec context should be
4257 * allocated for each new use.
4259 int avcodec_get_context_defaults3(AVCodecContext *s, const AVCodec *codec);
4263 * Get the AVClass for AVCodecContext. It can be used in combination with
4264 * AV_OPT_SEARCH_FAKE_OBJ for examining options.
4266 * @see av_opt_find().
4268 const AVClass *avcodec_get_class(void);
4270 #if FF_API_COPY_CONTEXT
4272 * Get the AVClass for AVFrame. 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_frame_class(void);
4280 * Get the AVClass for AVSubtitleRect. It can be used in combination with
4281 * AV_OPT_SEARCH_FAKE_OBJ for examining options.
4283 * @see av_opt_find().
4285 const AVClass *avcodec_get_subtitle_rect_class(void);
4288 * Copy the settings of the source AVCodecContext into the destination
4289 * AVCodecContext. The resulting destination codec context will be
4290 * unopened, i.e. you are required to call avcodec_open2() before you
4291 * can use this AVCodecContext to decode/encode video/audio data.
4293 * @param dest target codec context, should be initialized with
4294 * avcodec_alloc_context3(NULL), but otherwise uninitialized
4295 * @param src source codec context
4296 * @return AVERROR() on error (e.g. memory allocation error), 0 on success
4298 * @deprecated The semantics of this function are ill-defined and it should not
4299 * be used. If you need to transfer the stream parameters from one codec context
4300 * to another, use an intermediate AVCodecParameters instance and the
4301 * avcodec_parameters_from_context() / avcodec_parameters_to_context()
4304 attribute_deprecated
4305 int avcodec_copy_context(AVCodecContext *dest, const AVCodecContext *src);
4309 * Allocate a new AVCodecParameters and set its fields to default values
4310 * (unknown/invalid/0). The returned struct must be freed with
4311 * avcodec_parameters_free().
4313 AVCodecParameters *avcodec_parameters_alloc(void);
4316 * Free an AVCodecParameters instance and everything associated with it and
4317 * write NULL to the supplied pointer.
4319 void avcodec_parameters_free(AVCodecParameters **par);
4322 * Copy the contents of src to dst. Any allocated fields in dst are freed and
4323 * replaced with newly allocated duplicates of the corresponding fields in src.
4325 * @return >= 0 on success, a negative AVERROR code on failure.
4327 int avcodec_parameters_copy(AVCodecParameters *dst, const AVCodecParameters *src);
4330 * Fill the parameters struct based on the values from the supplied codec
4331 * context. Any allocated fields in par are freed and replaced with duplicates
4332 * of the corresponding fields in codec.
4334 * @return >= 0 on success, a negative AVERROR code on failure
4336 int avcodec_parameters_from_context(AVCodecParameters *par,
4337 const AVCodecContext *codec);
4340 * Fill the codec context based on the values from the supplied codec
4341 * parameters. Any allocated fields in codec that have a corresponding field in
4342 * par are freed and replaced with duplicates of the corresponding field in par.
4343 * Fields in codec that do not have a counterpart in par are not touched.
4345 * @return >= 0 on success, a negative AVERROR code on failure.
4347 int avcodec_parameters_to_context(AVCodecContext *codec,
4348 const AVCodecParameters *par);
4351 * Initialize the AVCodecContext to use the given AVCodec. Prior to using this
4352 * function the context has to be allocated with avcodec_alloc_context3().
4354 * The functions avcodec_find_decoder_by_name(), avcodec_find_encoder_by_name(),
4355 * avcodec_find_decoder() and avcodec_find_encoder() provide an easy way for
4356 * retrieving a codec.
4358 * @warning This function is not thread safe!
4360 * @note Always call this function before using decoding routines (such as
4361 * @ref avcodec_receive_frame()).
4364 * avcodec_register_all();
4365 * av_dict_set(&opts, "b", "2.5M", 0);
4366 * codec = avcodec_find_decoder(AV_CODEC_ID_H264);
4370 * context = avcodec_alloc_context3(codec);
4372 * if (avcodec_open2(context, codec, opts) < 0)
4376 * @param avctx The context to initialize.
4377 * @param codec The codec to open this context for. If a non-NULL codec has been
4378 * previously passed to avcodec_alloc_context3() or
4379 * for this context, then this parameter MUST be either NULL or
4380 * equal to the previously passed codec.
4381 * @param options A dictionary filled with AVCodecContext and codec-private options.
4382 * On return this object will be filled with options that were not found.
4384 * @return zero on success, a negative value on error
4385 * @see avcodec_alloc_context3(), avcodec_find_decoder(), avcodec_find_encoder(),
4386 * av_dict_set(), av_opt_find().
4388 int avcodec_open2(AVCodecContext *avctx, const AVCodec *codec, AVDictionary **options);
4391 * Close a given AVCodecContext and free all the data associated with it
4392 * (but not the AVCodecContext itself).
4394 * Calling this function on an AVCodecContext that hasn't been opened will free
4395 * the codec-specific data allocated in avcodec_alloc_context3() with a non-NULL
4396 * codec. Subsequent calls will do nothing.
4398 * @note Do not use this function. Use avcodec_free_context() to destroy a
4399 * codec context (either open or closed). Opening and closing a codec context
4400 * multiple times is not supported anymore -- use multiple codec contexts
4403 int avcodec_close(AVCodecContext *avctx);
4406 * Free all allocated data in the given subtitle struct.
4408 * @param sub AVSubtitle to free.
4410 void avsubtitle_free(AVSubtitle *sub);
4417 * @addtogroup lavc_packet
4422 * Allocate an AVPacket and set its fields to default values. The resulting
4423 * struct must be freed using av_packet_free().
4425 * @return An AVPacket filled with default values or NULL on failure.
4427 * @note this only allocates the AVPacket itself, not the data buffers. Those
4428 * must be allocated through other means such as av_new_packet.
4430 * @see av_new_packet
4432 AVPacket *av_packet_alloc(void);
4435 * Create a new packet that references the same data as src.
4437 * This is a shortcut for av_packet_alloc()+av_packet_ref().
4439 * @return newly created AVPacket on success, NULL on error.
4441 * @see av_packet_alloc
4442 * @see av_packet_ref
4444 AVPacket *av_packet_clone(const AVPacket *src);
4447 * Free the packet, if the packet is reference counted, it will be
4448 * unreferenced first.
4450 * @param pkt packet to be freed. The pointer will be set to NULL.
4451 * @note passing NULL is a no-op.
4453 void av_packet_free(AVPacket **pkt);
4456 * Initialize optional fields of a packet with default values.
4458 * Note, this does not touch the data and size members, which have to be
4459 * initialized separately.
4463 void av_init_packet(AVPacket *pkt);
4466 * Allocate the payload of a packet and initialize its fields with
4470 * @param size wanted payload size
4471 * @return 0 if OK, AVERROR_xxx otherwise
4473 int av_new_packet(AVPacket *pkt, int size);
4476 * Reduce packet size, correctly zeroing padding
4479 * @param size new size
4481 void av_shrink_packet(AVPacket *pkt, int size);
4484 * Increase packet size, correctly zeroing padding
4487 * @param grow_by number of bytes by which to increase the size of the packet
4489 int av_grow_packet(AVPacket *pkt, int grow_by);
4492 * Initialize a reference-counted packet from av_malloc()ed data.
4494 * @param pkt packet to be initialized. This function will set the data, size,
4495 * and buf fields, all others are left untouched.
4496 * @param data Data allocated by av_malloc() to be used as packet data. If this
4497 * function returns successfully, the data is owned by the underlying AVBuffer.
4498 * The caller may not access the data through other means.
4499 * @param size size of data in bytes, without the padding. I.e. the full buffer
4500 * size is assumed to be size + AV_INPUT_BUFFER_PADDING_SIZE.
4502 * @return 0 on success, a negative AVERROR on error
4504 int av_packet_from_data(AVPacket *pkt, uint8_t *data, int size);
4506 #if FF_API_AVPACKET_OLD_API
4508 * @warning This is a hack - the packet memory allocation stuff is broken. The
4509 * packet is allocated if it was not really allocated.
4511 * @deprecated Use av_packet_ref or av_packet_make_refcounted
4513 attribute_deprecated
4514 int av_dup_packet(AVPacket *pkt);
4516 * Copy packet, including contents
4518 * @return 0 on success, negative AVERROR on fail
4520 * @deprecated Use av_packet_ref
4522 attribute_deprecated
4523 int av_copy_packet(AVPacket *dst, const AVPacket *src);
4526 * Copy packet side data
4528 * @return 0 on success, negative AVERROR on fail
4530 * @deprecated Use av_packet_copy_props
4532 attribute_deprecated
4533 int av_copy_packet_side_data(AVPacket *dst, const AVPacket *src);
4538 * @deprecated Use av_packet_unref
4540 * @param pkt packet to free
4542 attribute_deprecated
4543 void av_free_packet(AVPacket *pkt);
4546 * Allocate new information of a packet.
4549 * @param type side information type
4550 * @param size side information size
4551 * @return pointer to fresh allocated data or NULL otherwise
4553 uint8_t* av_packet_new_side_data(AVPacket *pkt, enum AVPacketSideDataType type,
4557 * Wrap an existing array as a packet side data.
4560 * @param type side information type
4561 * @param data the side data array. It must be allocated with the av_malloc()
4562 * family of functions. The ownership of the data is transferred to
4564 * @param size side information size
4565 * @return a non-negative number on success, a negative AVERROR code on
4566 * failure. On failure, the packet is unchanged and the data remains
4567 * owned by the caller.
4569 int av_packet_add_side_data(AVPacket *pkt, enum AVPacketSideDataType type,
4570 uint8_t *data, size_t size);
4573 * Shrink the already allocated side data buffer
4576 * @param type side information type
4577 * @param size new side information size
4578 * @return 0 on success, < 0 on failure
4580 int av_packet_shrink_side_data(AVPacket *pkt, enum AVPacketSideDataType type,
4584 * Get side information from packet.
4587 * @param type desired side information type
4588 * @param size pointer for side information size to store (optional)
4589 * @return pointer to data if present or NULL otherwise
4591 uint8_t* av_packet_get_side_data(const AVPacket *pkt, enum AVPacketSideDataType type,
4594 #if FF_API_MERGE_SD_API
4595 attribute_deprecated
4596 int av_packet_merge_side_data(AVPacket *pkt);
4598 attribute_deprecated
4599 int av_packet_split_side_data(AVPacket *pkt);
4602 const char *av_packet_side_data_name(enum AVPacketSideDataType type);
4605 * Pack a dictionary for use in side_data.
4607 * @param dict The dictionary to pack.
4608 * @param size pointer to store the size of the returned data
4609 * @return pointer to data if successful, NULL otherwise
4611 uint8_t *av_packet_pack_dictionary(AVDictionary *dict, int *size);
4613 * Unpack a dictionary from side_data.
4615 * @param data data from side_data
4616 * @param size size of the data
4617 * @param dict the metadata storage dictionary
4618 * @return 0 on success, < 0 on failure
4620 int av_packet_unpack_dictionary(const uint8_t *data, int size, AVDictionary **dict);
4624 * Convenience function to free all the side data stored.
4625 * All the other fields stay untouched.
4629 void av_packet_free_side_data(AVPacket *pkt);
4632 * Setup a new reference to the data described by a given packet
4634 * If src is reference-counted, setup dst as a new reference to the
4635 * buffer in src. Otherwise allocate a new buffer in dst and copy the
4636 * data from src into it.
4638 * All the other fields are copied from src.
4640 * @see av_packet_unref
4642 * @param dst Destination packet
4643 * @param src Source packet
4645 * @return 0 on success, a negative AVERROR on error.
4647 int av_packet_ref(AVPacket *dst, const AVPacket *src);
4652 * Unreference the buffer referenced by the packet and reset the
4653 * remaining packet fields to their default values.
4655 * @param pkt The packet to be unreferenced.
4657 void av_packet_unref(AVPacket *pkt);
4660 * Move every field in src to dst and reset src.
4662 * @see av_packet_unref
4664 * @param src Source packet, will be reset
4665 * @param dst Destination packet
4667 void av_packet_move_ref(AVPacket *dst, AVPacket *src);
4670 * Copy only "properties" fields from src to dst.
4672 * Properties for the purpose of this function are all the fields
4673 * beside those related to the packet data (buf, data, size)
4675 * @param dst Destination packet
4676 * @param src Source packet
4678 * @return 0 on success AVERROR on failure.
4680 int av_packet_copy_props(AVPacket *dst, const AVPacket *src);
4683 * Ensure the data described by a given packet is reference counted.
4685 * @note This function does not ensure that the reference will be writable.
4686 * Use av_packet_make_writable instead for that purpose.
4688 * @see av_packet_ref
4689 * @see av_packet_make_writable
4691 * @param pkt packet whose data should be made reference counted.
4693 * @return 0 on success, a negative AVERROR on error. On failure, the
4694 * packet is unchanged.
4696 int av_packet_make_refcounted(AVPacket *pkt);
4699 * Create a writable reference for the data described by a given packet,
4700 * avoiding data copy if possible.
4702 * @param pkt Packet whose data should be made writable.
4704 * @return 0 on success, a negative AVERROR on failure. On failure, the
4705 * packet is unchanged.
4707 int av_packet_make_writable(AVPacket *pkt);
4710 * Convert valid timing fields (timestamps / durations) in a packet from one
4711 * timebase to another. Timestamps with unknown values (AV_NOPTS_VALUE) will be
4714 * @param pkt packet on which the conversion will be performed
4715 * @param tb_src source timebase, in which the timing fields in pkt are
4717 * @param tb_dst destination timebase, to which the timing fields will be
4720 void av_packet_rescale_ts(AVPacket *pkt, AVRational tb_src, AVRational tb_dst);
4727 * @addtogroup lavc_decoding
4732 * Find a registered decoder with a matching codec ID.
4734 * @param id AVCodecID of the requested decoder
4735 * @return A decoder if one was found, NULL otherwise.
4737 AVCodec *avcodec_find_decoder(enum AVCodecID id);
4740 * Find a registered decoder with the specified name.
4742 * @param name name of the requested decoder
4743 * @return A decoder if one was found, NULL otherwise.
4745 AVCodec *avcodec_find_decoder_by_name(const char *name);
4748 * The default callback for AVCodecContext.get_buffer2(). It is made public so
4749 * it can be called by custom get_buffer2() implementations for decoders without
4750 * AV_CODEC_CAP_DR1 set.
4752 int avcodec_default_get_buffer2(AVCodecContext *s, AVFrame *frame, int flags);
4755 * Modify width and height values so that they will result in a memory
4756 * buffer that is acceptable for the codec if you do not use any horizontal
4759 * May only be used if a codec with AV_CODEC_CAP_DR1 has been opened.
4761 void avcodec_align_dimensions(AVCodecContext *s, int *width, int *height);
4764 * Modify width and height values so that they will result in a memory
4765 * buffer that is acceptable for the codec if you also ensure that all
4766 * line sizes are a multiple of the respective linesize_align[i].
4768 * May only be used if a codec with AV_CODEC_CAP_DR1 has been opened.
4770 void avcodec_align_dimensions2(AVCodecContext *s, int *width, int *height,
4771 int linesize_align[AV_NUM_DATA_POINTERS]);
4774 * Converts AVChromaLocation to swscale x/y chroma position.
4776 * The positions represent the chroma (0,0) position in a coordinates system
4777 * with luma (0,0) representing the origin and luma(1,1) representing 256,256
4779 * @param xpos horizontal chroma sample position
4780 * @param ypos vertical chroma sample position
4782 int avcodec_enum_to_chroma_pos(int *xpos, int *ypos, enum AVChromaLocation pos);
4785 * Converts swscale x/y chroma position to AVChromaLocation.
4787 * The positions represent the chroma (0,0) position in a coordinates system
4788 * with luma (0,0) representing the origin and luma(1,1) representing 256,256
4790 * @param xpos horizontal chroma sample position
4791 * @param ypos vertical chroma sample position
4793 enum AVChromaLocation avcodec_chroma_pos_to_enum(int xpos, int ypos);
4796 * Decode the audio frame of size avpkt->size from avpkt->data into frame.
4798 * Some decoders may support multiple frames in a single AVPacket. Such
4799 * decoders would then just decode the first frame and the return value would be
4800 * less than the packet size. In this case, avcodec_decode_audio4 has to be
4801 * called again with an AVPacket containing the remaining data in order to
4802 * decode the second frame, etc... Even if no frames are returned, the packet
4803 * needs to be fed to the decoder with remaining data until it is completely
4804 * consumed or an error occurs.
4806 * Some decoders (those marked with AV_CODEC_CAP_DELAY) have a delay between input
4807 * and output. This means that for some packets they will not immediately
4808 * produce decoded output and need to be flushed at the end of decoding to get
4809 * all the decoded data. Flushing is done by calling this function with packets
4810 * with avpkt->data set to NULL and avpkt->size set to 0 until it stops
4811 * returning samples. It is safe to flush even those decoders that are not
4812 * marked with AV_CODEC_CAP_DELAY, then no samples will be returned.
4814 * @warning The input buffer, avpkt->data must be AV_INPUT_BUFFER_PADDING_SIZE
4815 * larger than the actual read bytes because some optimized bitstream
4816 * readers read 32 or 64 bits at once and could read over the end.
4818 * @note The AVCodecContext MUST have been opened with @ref avcodec_open2()
4819 * before packets may be fed to the decoder.
4821 * @param avctx the codec context
4822 * @param[out] frame The AVFrame in which to store decoded audio samples.
4823 * The decoder will allocate a buffer for the decoded frame by
4824 * calling the AVCodecContext.get_buffer2() callback.
4825 * When AVCodecContext.refcounted_frames is set to 1, the frame is
4826 * reference counted and the returned reference belongs to the
4827 * caller. The caller must release the frame using av_frame_unref()
4828 * when the frame is no longer needed. The caller may safely write
4829 * to the frame if av_frame_is_writable() returns 1.
4830 * When AVCodecContext.refcounted_frames is set to 0, the returned
4831 * reference belongs to the decoder and is valid only until the
4832 * next call to this function or until closing or flushing the
4833 * decoder. The caller may not write to it.
4834 * @param[out] got_frame_ptr Zero if no frame could be decoded, otherwise it is
4835 * non-zero. Note that this field being set to zero
4836 * does not mean that an error has occurred. For
4837 * decoders with AV_CODEC_CAP_DELAY set, no given decode
4838 * call is guaranteed to produce a frame.
4839 * @param[in] avpkt The input AVPacket containing the input buffer.
4840 * At least avpkt->data and avpkt->size should be set. Some
4841 * decoders might also require additional fields to be set.
4842 * @return A negative error code is returned if an error occurred during
4843 * decoding, otherwise the number of bytes consumed from the input
4844 * AVPacket is returned.
4846 * @deprecated Use avcodec_send_packet() and avcodec_receive_frame().
4848 attribute_deprecated
4849 int avcodec_decode_audio4(AVCodecContext *avctx, AVFrame *frame,
4850 int *got_frame_ptr, const AVPacket *avpkt);
4853 * Decode the video frame of size avpkt->size from avpkt->data into picture.
4854 * Some decoders may support multiple frames in a single AVPacket, such
4855 * decoders would then just decode the first frame.
4857 * @warning The input buffer must be AV_INPUT_BUFFER_PADDING_SIZE larger than
4858 * the actual read bytes because some optimized bitstream readers read 32 or 64
4859 * bits at once and could read over the end.
4861 * @warning The end of the input buffer buf should be set to 0 to ensure that
4862 * no overreading happens for damaged MPEG streams.
4864 * @note Codecs which have the AV_CODEC_CAP_DELAY capability set have a delay
4865 * between input and output, these need to be fed with avpkt->data=NULL,
4866 * avpkt->size=0 at the end to return the remaining frames.
4868 * @note The AVCodecContext MUST have been opened with @ref avcodec_open2()
4869 * before packets may be fed to the decoder.
4871 * @param avctx the codec context
4872 * @param[out] picture The AVFrame in which the decoded video frame will be stored.
4873 * Use av_frame_alloc() to get an AVFrame. The codec will
4874 * allocate memory for the actual bitmap by calling the
4875 * AVCodecContext.get_buffer2() callback.
4876 * When AVCodecContext.refcounted_frames is set to 1, the frame is
4877 * reference counted and the returned reference belongs to the
4878 * caller. The caller must release the frame using av_frame_unref()
4879 * when the frame is no longer needed. The caller may safely write
4880 * to the frame if av_frame_is_writable() returns 1.
4881 * When AVCodecContext.refcounted_frames is set to 0, the returned
4882 * reference belongs to the decoder and is valid only until the
4883 * next call to this function or until closing or flushing the
4884 * decoder. The caller may not write to it.
4886 * @param[in] avpkt The input AVPacket containing the input buffer.
4887 * You can create such packet with av_init_packet() and by then setting
4888 * data and size, some decoders might in addition need other fields like
4889 * flags&AV_PKT_FLAG_KEY. All decoders are designed to use the least
4891 * @param[in,out] got_picture_ptr Zero if no frame could be decompressed, otherwise, it is nonzero.
4892 * @return On error a negative value is returned, otherwise the number of bytes
4893 * used or zero if no frame could be decompressed.
4895 * @deprecated Use avcodec_send_packet() and avcodec_receive_frame().
4897 attribute_deprecated
4898 int avcodec_decode_video2(AVCodecContext *avctx, AVFrame *picture,
4899 int *got_picture_ptr,
4900 const AVPacket *avpkt);
4903 * Decode a subtitle message.
4904 * Return a negative value on error, otherwise return the number of bytes used.
4905 * If no subtitle could be decompressed, got_sub_ptr is zero.
4906 * Otherwise, the subtitle is stored in *sub.
4907 * Note that AV_CODEC_CAP_DR1 is not available for subtitle codecs. This is for
4908 * simplicity, because the performance difference is expected to be negligible
4909 * and reusing a get_buffer written for video codecs would probably perform badly
4910 * due to a potentially very different allocation pattern.
4912 * Some decoders (those marked with AV_CODEC_CAP_DELAY) have a delay between input
4913 * and output. This means that for some packets they will not immediately
4914 * produce decoded output and need to be flushed at the end of decoding to get
4915 * all the decoded data. Flushing is done by calling this function with packets
4916 * with avpkt->data set to NULL and avpkt->size set to 0 until it stops
4917 * returning subtitles. It is safe to flush even those decoders that are not
4918 * marked with AV_CODEC_CAP_DELAY, then no subtitles will be returned.
4920 * @note The AVCodecContext MUST have been opened with @ref avcodec_open2()
4921 * before packets may be fed to the decoder.
4923 * @param avctx the codec context
4924 * @param[out] sub The preallocated AVSubtitle in which the decoded subtitle will be stored,
4925 * must be freed with avsubtitle_free if *got_sub_ptr is set.
4926 * @param[in,out] got_sub_ptr Zero if no subtitle could be decompressed, otherwise, it is nonzero.
4927 * @param[in] avpkt The input AVPacket containing the input buffer.
4929 int avcodec_decode_subtitle2(AVCodecContext *avctx, AVSubtitle *sub,
4934 * Supply raw packet data as input to a decoder.
4936 * Internally, this call will copy relevant AVCodecContext fields, which can
4937 * influence decoding per-packet, and apply them when the packet is actually
4938 * decoded. (For example AVCodecContext.skip_frame, which might direct the
4939 * decoder to drop the frame contained by the packet sent with this function.)
4941 * @warning The input buffer, avpkt->data must be AV_INPUT_BUFFER_PADDING_SIZE
4942 * larger than the actual read bytes because some optimized bitstream
4943 * readers read 32 or 64 bits at once and could read over the end.
4945 * @warning Do not mix this API with the legacy API (like avcodec_decode_video2())
4946 * on the same AVCodecContext. It will return unexpected results now
4947 * or in future libavcodec versions.
4949 * @note The AVCodecContext MUST have been opened with @ref avcodec_open2()
4950 * before packets may be fed to the decoder.
4952 * @param avctx codec context
4953 * @param[in] avpkt The input AVPacket. Usually, this will be a single video
4954 * frame, or several complete audio frames.
4955 * Ownership of the packet remains with the caller, and the
4956 * decoder will not write to the packet. The decoder may create
4957 * a reference to the packet data (or copy it if the packet is
4958 * not reference-counted).
4959 * Unlike with older APIs, the packet is always fully consumed,
4960 * and if it contains multiple frames (e.g. some audio codecs),
4961 * will require you to call avcodec_receive_frame() multiple
4962 * times afterwards before you can send a new packet.
4963 * It can be NULL (or an AVPacket with data set to NULL and
4964 * size set to 0); in this case, it is considered a flush
4965 * packet, which signals the end of the stream. Sending the
4966 * first flush packet will return success. Subsequent ones are
4967 * unnecessary and will return AVERROR_EOF. If the decoder
4968 * still has frames buffered, it will return them after sending
4971 * @return 0 on success, otherwise negative error code:
4972 * AVERROR(EAGAIN): input is not accepted in the current state - user
4973 * must read output with avcodec_receive_frame() (once
4974 * all output is read, the packet should be resent, and
4975 * the call will not fail with EAGAIN).
4976 * AVERROR_EOF: the decoder has been flushed, and no new packets can
4977 * be sent to it (also returned if more than 1 flush
4979 * AVERROR(EINVAL): codec not opened, it is an encoder, or requires flush
4980 * AVERROR(ENOMEM): failed to add packet to internal queue, or similar
4981 * other errors: legitimate decoding errors
4983 int avcodec_send_packet(AVCodecContext *avctx, const AVPacket *avpkt);
4986 * Return decoded output data from a decoder.
4988 * @param avctx codec context
4989 * @param frame This will be set to a reference-counted video or audio
4990 * frame (depending on the decoder type) allocated by the
4991 * decoder. Note that the function will always call
4992 * av_frame_unref(frame) before doing anything else.
4995 * 0: success, a frame was returned
4996 * AVERROR(EAGAIN): output is not available in this state - user must try
4998 * AVERROR_EOF: the decoder has been fully flushed, and there will be
4999 * no more output frames
5000 * AVERROR(EINVAL): codec not opened, or it is an encoder
5001 * AVERROR_INPUT_CHANGED: current decoded frame has changed parameters
5002 * with respect to first decoded frame. Applicable
5003 * when flag AV_CODEC_FLAG_DROPCHANGED is set.
5004 * other negative values: legitimate decoding errors
5006 int avcodec_receive_frame(AVCodecContext *avctx, AVFrame *frame);
5009 * Supply a raw video or audio frame to the encoder. Use avcodec_receive_packet()
5010 * to retrieve buffered output packets.
5012 * @param avctx codec context
5013 * @param[in] frame AVFrame containing the raw audio or video frame to be encoded.
5014 * Ownership of the frame remains with the caller, and the
5015 * encoder will not write to the frame. The encoder may create
5016 * a reference to the frame data (or copy it if the frame is
5017 * not reference-counted).
5018 * It can be NULL, in which case it is considered a flush
5019 * packet. This signals the end of the stream. If the encoder
5020 * still has packets buffered, it will return them after this
5021 * call. Once flushing mode has been entered, additional flush
5022 * packets are ignored, and sending frames will return
5026 * If AV_CODEC_CAP_VARIABLE_FRAME_SIZE is set, then each frame
5027 * can have any number of samples.
5028 * If it is not set, frame->nb_samples must be equal to
5029 * avctx->frame_size for all frames except the last.
5030 * The final frame may be smaller than avctx->frame_size.
5031 * @return 0 on success, otherwise negative error code:
5032 * AVERROR(EAGAIN): input is not accepted in the current state - user
5033 * must read output with avcodec_receive_packet() (once
5034 * all output is read, the packet should be resent, and
5035 * the call will not fail with EAGAIN).
5036 * AVERROR_EOF: the encoder has been flushed, and no new frames can
5038 * AVERROR(EINVAL): codec not opened, refcounted_frames not set, it is a
5039 * decoder, or requires flush
5040 * AVERROR(ENOMEM): failed to add packet to internal queue, or similar
5041 * other errors: legitimate decoding errors
5043 int avcodec_send_frame(AVCodecContext *avctx, const AVFrame *frame);
5046 * Read encoded data from the encoder.
5048 * @param avctx codec context
5049 * @param avpkt This will be set to a reference-counted packet allocated by the
5050 * encoder. Note that the function will always call
5051 * av_packet_unref(avpkt) before doing anything else.
5052 * @return 0 on success, otherwise negative error code:
5053 * AVERROR(EAGAIN): output is not available in the current state - user
5054 * must try to send input
5055 * AVERROR_EOF: the encoder has been fully flushed, and there will be
5056 * no more output packets
5057 * AVERROR(EINVAL): codec not opened, or it is an encoder
5058 * other errors: legitimate decoding errors
5060 int avcodec_receive_packet(AVCodecContext *avctx, AVPacket *avpkt);
5063 * Create and return a AVHWFramesContext with values adequate for hardware
5064 * decoding. This is meant to get called from the get_format callback, and is
5065 * a helper for preparing a AVHWFramesContext for AVCodecContext.hw_frames_ctx.
5066 * This API is for decoding with certain hardware acceleration modes/APIs only.
5068 * The returned AVHWFramesContext is not initialized. The caller must do this
5069 * with av_hwframe_ctx_init().
5071 * Calling this function is not a requirement, but makes it simpler to avoid
5072 * codec or hardware API specific details when manually allocating frames.
5074 * Alternatively to this, an API user can set AVCodecContext.hw_device_ctx,
5075 * which sets up AVCodecContext.hw_frames_ctx fully automatically, and makes
5076 * it unnecessary to call this function or having to care about
5077 * AVHWFramesContext initialization at all.
5079 * There are a number of requirements for calling this function:
5081 * - It must be called from get_format with the same avctx parameter that was
5082 * passed to get_format. Calling it outside of get_format is not allowed, and
5083 * can trigger undefined behavior.
5084 * - The function is not always supported (see description of return values).
5085 * Even if this function returns successfully, hwaccel initialization could
5086 * fail later. (The degree to which implementations check whether the stream
5087 * is actually supported varies. Some do this check only after the user's
5088 * get_format callback returns.)
5089 * - The hw_pix_fmt must be one of the choices suggested by get_format. If the
5090 * user decides to use a AVHWFramesContext prepared with this API function,
5091 * the user must return the same hw_pix_fmt from get_format.
5092 * - The device_ref passed to this function must support the given hw_pix_fmt.
5093 * - After calling this API function, it is the user's responsibility to
5094 * initialize the AVHWFramesContext (returned by the out_frames_ref parameter),
5095 * and to set AVCodecContext.hw_frames_ctx to it. If done, this must be done
5096 * before returning from get_format (this is implied by the normal
5097 * AVCodecContext.hw_frames_ctx API rules).
5098 * - The AVHWFramesContext parameters may change every time time get_format is
5099 * called. Also, AVCodecContext.hw_frames_ctx is reset before get_format. So
5100 * you are inherently required to go through this process again on every
5102 * - It is perfectly possible to call this function without actually using
5103 * the resulting AVHWFramesContext. One use-case might be trying to reuse a
5104 * previously initialized AVHWFramesContext, and calling this API function
5105 * only to test whether the required frame parameters have changed.
5106 * - Fields that use dynamically allocated values of any kind must not be set
5107 * by the user unless setting them is explicitly allowed by the documentation.
5108 * If the user sets AVHWFramesContext.free and AVHWFramesContext.user_opaque,
5109 * the new free callback must call the potentially set previous free callback.
5110 * This API call may set any dynamically allocated fields, including the free
5113 * The function will set at least the following fields on AVHWFramesContext
5114 * (potentially more, depending on hwaccel API):
5116 * - All fields set by av_hwframe_ctx_alloc().
5117 * - Set the format field to hw_pix_fmt.
5118 * - Set the sw_format field to the most suited and most versatile format. (An
5119 * implication is that this will prefer generic formats over opaque formats
5120 * with arbitrary restrictions, if possible.)
5121 * - Set the width/height fields to the coded frame size, rounded up to the
5122 * API-specific minimum alignment.
5123 * - Only _if_ the hwaccel requires a pre-allocated pool: set the initial_pool_size
5124 * field to the number of maximum reference surfaces possible with the codec,
5125 * plus 1 surface for the user to work (meaning the user can safely reference
5126 * at most 1 decoded surface at a time), plus additional buffering introduced
5127 * by frame threading. If the hwaccel does not require pre-allocation, the
5128 * field is left to 0, and the decoder will allocate new surfaces on demand
5130 * - Possibly AVHWFramesContext.hwctx fields, depending on the underlying
5133 * Essentially, out_frames_ref returns the same as av_hwframe_ctx_alloc(), but
5134 * with basic frame parameters set.
5136 * The function is stateless, and does not change the AVCodecContext or the
5137 * device_ref AVHWDeviceContext.
5139 * @param avctx The context which is currently calling get_format, and which
5140 * implicitly contains all state needed for filling the returned
5141 * AVHWFramesContext properly.
5142 * @param device_ref A reference to the AVHWDeviceContext describing the device
5143 * which will be used by the hardware decoder.
5144 * @param hw_pix_fmt The hwaccel format you are going to return from get_format.
5145 * @param out_frames_ref On success, set to a reference to an _uninitialized_
5146 * AVHWFramesContext, created from the given device_ref.
5147 * Fields will be set to values required for decoding.
5148 * Not changed if an error is returned.
5149 * @return zero on success, a negative value on error. The following error codes
5150 * have special semantics:
5151 * AVERROR(ENOENT): the decoder does not support this functionality. Setup
5152 * is always manual, or it is a decoder which does not
5153 * support setting AVCodecContext.hw_frames_ctx at all,
5154 * or it is a software format.
5155 * AVERROR(EINVAL): it is known that hardware decoding is not supported for
5156 * this configuration, or the device_ref is not supported
5157 * for the hwaccel referenced by hw_pix_fmt.
5159 int avcodec_get_hw_frames_parameters(AVCodecContext *avctx,
5160 AVBufferRef *device_ref,
5161 enum AVPixelFormat hw_pix_fmt,
5162 AVBufferRef **out_frames_ref);
5167 * @defgroup lavc_parsing Frame parsing
5171 enum AVPictureStructure {
5172 AV_PICTURE_STRUCTURE_UNKNOWN, //< unknown
5173 AV_PICTURE_STRUCTURE_TOP_FIELD, //< coded as top field
5174 AV_PICTURE_STRUCTURE_BOTTOM_FIELD, //< coded as bottom field
5175 AV_PICTURE_STRUCTURE_FRAME, //< coded as frame
5178 typedef struct AVCodecParserContext {
5180 struct AVCodecParser *parser;
5181 int64_t frame_offset; /* offset of the current frame */
5182 int64_t cur_offset; /* current offset
5183 (incremented by each av_parser_parse()) */
5184 int64_t next_frame_offset; /* offset of the next frame */
5186 int pict_type; /* XXX: Put it back in AVCodecContext. */
5188 * This field is used for proper frame duration computation in lavf.
5189 * It signals, how much longer the frame duration of the current frame
5190 * is compared to normal frame duration.
5192 * frame_duration = (1 + repeat_pict) * time_base
5194 * It is used by codecs like H.264 to display telecined material.
5196 int repeat_pict; /* XXX: Put it back in AVCodecContext. */
5197 int64_t pts; /* pts of the current frame */
5198 int64_t dts; /* dts of the current frame */
5203 int fetch_timestamp;
5205 #define AV_PARSER_PTS_NB 4
5206 int cur_frame_start_index;
5207 int64_t cur_frame_offset[AV_PARSER_PTS_NB];
5208 int64_t cur_frame_pts[AV_PARSER_PTS_NB];
5209 int64_t cur_frame_dts[AV_PARSER_PTS_NB];
5212 #define PARSER_FLAG_COMPLETE_FRAMES 0x0001
5213 #define PARSER_FLAG_ONCE 0x0002
5214 /// Set if the parser has a valid file offset
5215 #define PARSER_FLAG_FETCHED_OFFSET 0x0004
5216 #define PARSER_FLAG_USE_CODEC_TS 0x1000
5218 int64_t offset; ///< byte offset from starting packet start
5219 int64_t cur_frame_end[AV_PARSER_PTS_NB];
5222 * Set by parser to 1 for key frames and 0 for non-key frames.
5223 * It is initialized to -1, so if the parser doesn't set this flag,
5224 * old-style fallback using AV_PICTURE_TYPE_I picture type as key frames
5229 #if FF_API_CONVERGENCE_DURATION
5231 * @deprecated unused
5233 attribute_deprecated
5234 int64_t convergence_duration;
5237 // Timestamp generation support:
5239 * Synchronization point for start of timestamp generation.
5241 * Set to >0 for sync point, 0 for no sync point and <0 for undefined
5244 * For example, this corresponds to presence of H.264 buffering period
5250 * Offset of the current timestamp against last timestamp sync point in
5251 * units of AVCodecContext.time_base.
5253 * Set to INT_MIN when dts_sync_point unused. Otherwise, it must
5254 * contain a valid timestamp offset.
5256 * Note that the timestamp of sync point has usually a nonzero
5257 * dts_ref_dts_delta, which refers to the previous sync point. Offset of
5258 * the next frame after timestamp sync point will be usually 1.
5260 * For example, this corresponds to H.264 cpb_removal_delay.
5262 int dts_ref_dts_delta;
5265 * Presentation delay of current frame in units of AVCodecContext.time_base.
5267 * Set to INT_MIN when dts_sync_point unused. Otherwise, it must
5268 * contain valid non-negative timestamp delta (presentation time of a frame
5269 * must not lie in the past).
5271 * This delay represents the difference between decoding and presentation
5272 * time of the frame.
5274 * For example, this corresponds to H.264 dpb_output_delay.
5279 * Position of the packet in file.
5281 * Analogous to cur_frame_pts/dts
5283 int64_t cur_frame_pos[AV_PARSER_PTS_NB];
5286 * Byte position of currently parsed frame in stream.
5291 * Previous frame byte position.
5296 * Duration of the current frame.
5297 * For audio, this is in units of 1 / AVCodecContext.sample_rate.
5298 * For all other types, this is in units of AVCodecContext.time_base.
5302 enum AVFieldOrder field_order;
5305 * Indicate whether a picture is coded as a frame, top field or bottom field.
5307 * For example, H.264 field_pic_flag equal to 0 corresponds to
5308 * AV_PICTURE_STRUCTURE_FRAME. An H.264 picture with field_pic_flag
5309 * equal to 1 and bottom_field_flag equal to 0 corresponds to
5310 * AV_PICTURE_STRUCTURE_TOP_FIELD.
5312 enum AVPictureStructure picture_structure;
5315 * Picture number incremented in presentation or output order.
5316 * This field may be reinitialized at the first picture of a new sequence.
5318 * For example, this corresponds to H.264 PicOrderCnt.
5320 int output_picture_number;
5323 * Dimensions of the decoded video intended for presentation.
5329 * Dimensions of the coded video.
5335 * The format of the coded data, corresponds to enum AVPixelFormat for video
5336 * and for enum AVSampleFormat for audio.
5338 * Note that a decoder can have considerable freedom in how exactly it
5339 * decodes the data, so the format reported here might be different from the
5340 * one returned by a decoder.
5343 } AVCodecParserContext;
5345 typedef struct AVCodecParser {
5346 int codec_ids[5]; /* several codec IDs are permitted */
5348 int (*parser_init)(AVCodecParserContext *s);
5349 /* This callback never returns an error, a negative value means that
5350 * the frame start was in a previous packet. */
5351 int (*parser_parse)(AVCodecParserContext *s,
5352 AVCodecContext *avctx,
5353 const uint8_t **poutbuf, int *poutbuf_size,
5354 const uint8_t *buf, int buf_size);
5355 void (*parser_close)(AVCodecParserContext *s);
5356 int (*split)(AVCodecContext *avctx, const uint8_t *buf, int buf_size);
5357 struct AVCodecParser *next;
5361 * Iterate over all registered codec parsers.
5363 * @param opaque a pointer where libavcodec will store the iteration state. Must
5364 * point to NULL to start the iteration.
5366 * @return the next registered codec parser or NULL when the iteration is
5369 const AVCodecParser *av_parser_iterate(void **opaque);
5371 attribute_deprecated
5372 AVCodecParser *av_parser_next(const AVCodecParser *c);
5374 attribute_deprecated
5375 void av_register_codec_parser(AVCodecParser *parser);
5376 AVCodecParserContext *av_parser_init(int codec_id);
5381 * @param s parser context.
5382 * @param avctx codec context.
5383 * @param poutbuf set to pointer to parsed buffer or NULL if not yet finished.
5384 * @param poutbuf_size set to size of parsed buffer or zero if not yet finished.
5385 * @param buf input buffer.
5386 * @param buf_size buffer size in bytes without the padding. I.e. the full buffer
5387 size is assumed to be buf_size + AV_INPUT_BUFFER_PADDING_SIZE.
5388 To signal EOF, this should be 0 (so that the last frame
5390 * @param pts input presentation timestamp.
5391 * @param dts input decoding timestamp.
5392 * @param pos input byte position in stream.
5393 * @return the number of bytes of the input bitstream used.
5398 * len = av_parser_parse2(myparser, AVCodecContext, &data, &size,
5405 * decode_frame(data, size);
5409 int av_parser_parse2(AVCodecParserContext *s,
5410 AVCodecContext *avctx,
5411 uint8_t **poutbuf, int *poutbuf_size,
5412 const uint8_t *buf, int buf_size,
5413 int64_t pts, int64_t dts,
5417 * @return 0 if the output buffer is a subset of the input, 1 if it is allocated and must be freed
5418 * @deprecated use AVBitStreamFilter
5420 int av_parser_change(AVCodecParserContext *s,
5421 AVCodecContext *avctx,
5422 uint8_t **poutbuf, int *poutbuf_size,
5423 const uint8_t *buf, int buf_size, int keyframe);
5424 void av_parser_close(AVCodecParserContext *s);
5432 * @addtogroup lavc_encoding
5437 * Find a registered encoder with a matching codec ID.
5439 * @param id AVCodecID of the requested encoder
5440 * @return An encoder if one was found, NULL otherwise.
5442 AVCodec *avcodec_find_encoder(enum AVCodecID id);
5445 * Find a registered encoder with the specified name.
5447 * @param name name of the requested encoder
5448 * @return An encoder if one was found, NULL otherwise.
5450 AVCodec *avcodec_find_encoder_by_name(const char *name);
5453 * Encode a frame of audio.
5455 * Takes input samples from frame and writes the next output packet, if
5456 * available, to avpkt. The output packet does not necessarily contain data for
5457 * the most recent frame, as encoders can delay, split, and combine input frames
5458 * internally as needed.
5460 * @param avctx codec context
5461 * @param avpkt output AVPacket.
5462 * The user can supply an output buffer by setting
5463 * avpkt->data and avpkt->size prior to calling the
5464 * function, but if the size of the user-provided data is not
5465 * large enough, encoding will fail. If avpkt->data and
5466 * avpkt->size are set, avpkt->destruct must also be set. All
5467 * other AVPacket fields will be reset by the encoder using
5468 * av_init_packet(). If avpkt->data is NULL, the encoder will
5469 * allocate it. The encoder will set avpkt->size to the size
5470 * of the output packet.
5472 * If this function fails or produces no output, avpkt will be
5473 * freed using av_packet_unref().
5474 * @param[in] frame AVFrame containing the raw audio data to be encoded.
5475 * May be NULL when flushing an encoder that has the
5476 * AV_CODEC_CAP_DELAY capability set.
5477 * If AV_CODEC_CAP_VARIABLE_FRAME_SIZE is set, then each frame
5478 * can have any number of samples.
5479 * If it is not set, frame->nb_samples must be equal to
5480 * avctx->frame_size for all frames except the last.
5481 * The final frame may be smaller than avctx->frame_size.
5482 * @param[out] got_packet_ptr This field is set to 1 by libavcodec if the
5483 * output packet is non-empty, and to 0 if it is
5484 * empty. If the function returns an error, the
5485 * packet can be assumed to be invalid, and the
5486 * value of got_packet_ptr is undefined and should
5488 * @return 0 on success, negative error code on failure
5490 * @deprecated use avcodec_send_frame()/avcodec_receive_packet() instead
5492 attribute_deprecated
5493 int avcodec_encode_audio2(AVCodecContext *avctx, AVPacket *avpkt,
5494 const AVFrame *frame, int *got_packet_ptr);
5497 * Encode a frame of video.
5499 * Takes input raw video data from frame and writes the next output packet, if
5500 * available, to avpkt. The output packet does not necessarily contain data for
5501 * the most recent frame, as encoders can delay and reorder input frames
5502 * internally as needed.
5504 * @param avctx codec context
5505 * @param avpkt output AVPacket.
5506 * The user can supply an output buffer by setting
5507 * avpkt->data and avpkt->size prior to calling the
5508 * function, but if the size of the user-provided data is not
5509 * large enough, encoding will fail. All other AVPacket fields
5510 * will be reset by the encoder using av_init_packet(). If
5511 * avpkt->data is NULL, the encoder will allocate it.
5512 * The encoder will set avpkt->size to the size of the
5513 * output packet. The returned data (if any) belongs to the
5514 * caller, he is responsible for freeing it.
5516 * If this function fails or produces no output, avpkt will be
5517 * freed using av_packet_unref().
5518 * @param[in] frame AVFrame containing the raw video data to be encoded.
5519 * May be NULL when flushing an encoder that has the
5520 * AV_CODEC_CAP_DELAY capability set.
5521 * @param[out] got_packet_ptr This field is set to 1 by libavcodec if the
5522 * output packet is non-empty, and to 0 if it is
5523 * empty. If the function returns an error, the
5524 * packet can be assumed to be invalid, and the
5525 * value of got_packet_ptr is undefined and should
5527 * @return 0 on success, negative error code on failure
5529 * @deprecated use avcodec_send_frame()/avcodec_receive_packet() instead
5531 attribute_deprecated
5532 int avcodec_encode_video2(AVCodecContext *avctx, AVPacket *avpkt,
5533 const AVFrame *frame, int *got_packet_ptr);
5535 int avcodec_encode_subtitle(AVCodecContext *avctx, uint8_t *buf, int buf_size,
5536 const AVSubtitle *sub);
5543 #if FF_API_AVPICTURE
5545 * @addtogroup lavc_picture
5550 * @deprecated unused
5552 attribute_deprecated
5553 int avpicture_alloc(AVPicture *picture, enum AVPixelFormat pix_fmt, int width, int height);
5556 * @deprecated unused
5558 attribute_deprecated
5559 void avpicture_free(AVPicture *picture);
5562 * @deprecated use av_image_fill_arrays() instead.
5564 attribute_deprecated
5565 int avpicture_fill(AVPicture *picture, const uint8_t *ptr,
5566 enum AVPixelFormat pix_fmt, int width, int height);
5569 * @deprecated use av_image_copy_to_buffer() instead.
5571 attribute_deprecated
5572 int avpicture_layout(const AVPicture *src, enum AVPixelFormat pix_fmt,
5573 int width, int height,
5574 unsigned char *dest, int dest_size);
5577 * @deprecated use av_image_get_buffer_size() instead.
5579 attribute_deprecated
5580 int avpicture_get_size(enum AVPixelFormat pix_fmt, int width, int height);
5583 * @deprecated av_image_copy() instead.
5585 attribute_deprecated
5586 void av_picture_copy(AVPicture *dst, const AVPicture *src,
5587 enum AVPixelFormat pix_fmt, int width, int height);
5590 * @deprecated unused
5592 attribute_deprecated
5593 int av_picture_crop(AVPicture *dst, const AVPicture *src,
5594 enum AVPixelFormat pix_fmt, int top_band, int left_band);
5597 * @deprecated unused
5599 attribute_deprecated
5600 int av_picture_pad(AVPicture *dst, const AVPicture *src, int height, int width, enum AVPixelFormat pix_fmt,
5601 int padtop, int padbottom, int padleft, int padright, int *color);
5609 * @defgroup lavc_misc Utility functions
5612 * Miscellaneous utility functions related to both encoding and decoding
5618 * @defgroup lavc_misc_pixfmt Pixel formats
5620 * Functions for working with pixel formats.
5624 #if FF_API_GETCHROMA
5626 * @deprecated Use av_pix_fmt_get_chroma_sub_sample
5629 attribute_deprecated
5630 void avcodec_get_chroma_sub_sample(enum AVPixelFormat pix_fmt, int *h_shift, int *v_shift);
5634 * Return a value representing the fourCC code associated to the
5635 * pixel format pix_fmt, or 0 if no associated fourCC code can be
5638 unsigned int avcodec_pix_fmt_to_codec_tag(enum AVPixelFormat pix_fmt);
5641 * @deprecated see av_get_pix_fmt_loss()
5643 int avcodec_get_pix_fmt_loss(enum AVPixelFormat dst_pix_fmt, enum AVPixelFormat src_pix_fmt,
5647 * Find the best pixel format to convert to given a certain source pixel
5648 * format. When converting from one pixel format to another, information loss
5649 * may occur. For example, when converting from RGB24 to GRAY, the color
5650 * information will be lost. Similarly, other losses occur when converting from
5651 * some formats to other formats. avcodec_find_best_pix_fmt_of_2() searches which of
5652 * the given pixel formats should be used to suffer the least amount of loss.
5653 * The pixel formats from which it chooses one, are determined by the
5654 * pix_fmt_list parameter.
5657 * @param[in] pix_fmt_list AV_PIX_FMT_NONE terminated array of pixel formats to choose from
5658 * @param[in] src_pix_fmt source pixel format
5659 * @param[in] has_alpha Whether the source pixel format alpha channel is used.
5660 * @param[out] loss_ptr Combination of flags informing you what kind of losses will occur.
5661 * @return The best pixel format to convert to or -1 if none was found.
5663 enum AVPixelFormat avcodec_find_best_pix_fmt_of_list(const enum AVPixelFormat *pix_fmt_list,
5664 enum AVPixelFormat src_pix_fmt,
5665 int has_alpha, int *loss_ptr);
5668 * @deprecated see av_find_best_pix_fmt_of_2()
5670 enum AVPixelFormat avcodec_find_best_pix_fmt_of_2(enum AVPixelFormat dst_pix_fmt1, enum AVPixelFormat dst_pix_fmt2,
5671 enum AVPixelFormat src_pix_fmt, int has_alpha, int *loss_ptr);
5673 attribute_deprecated
5674 enum AVPixelFormat avcodec_find_best_pix_fmt2(enum AVPixelFormat dst_pix_fmt1, enum AVPixelFormat dst_pix_fmt2,
5675 enum AVPixelFormat src_pix_fmt, int has_alpha, int *loss_ptr);
5677 enum AVPixelFormat avcodec_default_get_format(struct AVCodecContext *s, const enum AVPixelFormat * fmt);
5683 #if FF_API_TAG_STRING
5685 * Put a string representing the codec tag codec_tag in buf.
5687 * @param buf buffer to place codec tag in
5688 * @param buf_size size in bytes of buf
5689 * @param codec_tag codec tag to assign
5690 * @return the length of the string that would have been generated if
5691 * enough space had been available, excluding the trailing null
5693 * @deprecated see av_fourcc_make_string() and av_fourcc2str().
5695 attribute_deprecated
5696 size_t av_get_codec_tag_string(char *buf, size_t buf_size, unsigned int codec_tag);
5699 void avcodec_string(char *buf, int buf_size, AVCodecContext *enc, int encode);
5702 * Return a name for the specified profile, if available.
5704 * @param codec the codec that is searched for the given profile
5705 * @param profile the profile value for which a name is requested
5706 * @return A name for the profile if found, NULL otherwise.
5708 const char *av_get_profile_name(const AVCodec *codec, int profile);
5711 * Return a name for the specified profile, if available.
5713 * @param codec_id the ID of the codec to which the requested profile belongs
5714 * @param profile the profile value for which a name is requested
5715 * @return A name for the profile if found, NULL otherwise.
5717 * @note unlike av_get_profile_name(), which searches a list of profiles
5718 * supported by a specific decoder or encoder implementation, this
5719 * function searches the list of profiles from the AVCodecDescriptor
5721 const char *avcodec_profile_name(enum AVCodecID codec_id, int profile);
5723 int avcodec_default_execute(AVCodecContext *c, int (*func)(AVCodecContext *c2, void *arg2),void *arg, int *ret, int count, int size);
5724 int avcodec_default_execute2(AVCodecContext *c, int (*func)(AVCodecContext *c2, void *arg2, int, int),void *arg, int *ret, int count);
5725 //FIXME func typedef
5728 * Fill AVFrame audio data and linesize pointers.
5730 * The buffer buf must be a preallocated buffer with a size big enough
5731 * to contain the specified samples amount. The filled AVFrame data
5732 * pointers will point to this buffer.
5734 * AVFrame extended_data channel pointers are allocated if necessary for
5737 * @param frame the AVFrame
5738 * frame->nb_samples must be set prior to calling the
5739 * function. This function fills in frame->data,
5740 * frame->extended_data, frame->linesize[0].
5741 * @param nb_channels channel count
5742 * @param sample_fmt sample format
5743 * @param buf buffer to use for frame data
5744 * @param buf_size size of buffer
5745 * @param align plane size sample alignment (0 = default)
5746 * @return >=0 on success, negative error code on failure
5747 * @todo return the size in bytes required to store the samples in
5748 * case of success, at the next libavutil bump
5750 int avcodec_fill_audio_frame(AVFrame *frame, int nb_channels,
5751 enum AVSampleFormat sample_fmt, const uint8_t *buf,
5752 int buf_size, int align);
5755 * Reset the internal decoder state / flush internal buffers. Should be called
5756 * e.g. when seeking or when switching to a different stream.
5758 * @note when refcounted frames are not used (i.e. avctx->refcounted_frames is 0),
5759 * this invalidates the frames previously returned from the decoder. When
5760 * refcounted frames are used, the decoder just releases any references it might
5761 * keep internally, but the caller's reference remains valid.
5763 void avcodec_flush_buffers(AVCodecContext *avctx);
5766 * Return codec bits per sample.
5768 * @param[in] codec_id the codec
5769 * @return Number of bits per sample or zero if unknown for the given codec.
5771 int av_get_bits_per_sample(enum AVCodecID codec_id);
5774 * Return the PCM codec associated with a sample format.
5775 * @param be endianness, 0 for little, 1 for big,
5776 * -1 (or anything else) for native
5777 * @return AV_CODEC_ID_PCM_* or AV_CODEC_ID_NONE
5779 enum AVCodecID av_get_pcm_codec(enum AVSampleFormat fmt, int be);
5782 * Return codec bits per sample.
5783 * Only return non-zero if the bits per sample is exactly correct, not an
5786 * @param[in] codec_id the codec
5787 * @return Number of bits per sample or zero if unknown for the given codec.
5789 int av_get_exact_bits_per_sample(enum AVCodecID codec_id);
5792 * Return audio frame duration.
5794 * @param avctx codec context
5795 * @param frame_bytes size of the frame, or 0 if unknown
5796 * @return frame duration, in samples, if known. 0 if not able to
5799 int av_get_audio_frame_duration(AVCodecContext *avctx, int frame_bytes);
5802 * This function is the same as av_get_audio_frame_duration(), except it works
5803 * with AVCodecParameters instead of an AVCodecContext.
5805 int av_get_audio_frame_duration2(AVCodecParameters *par, int frame_bytes);
5808 typedef struct AVBitStreamFilterContext {
5810 const struct AVBitStreamFilter *filter;
5811 AVCodecParserContext *parser;
5812 struct AVBitStreamFilterContext *next;
5814 * Internal default arguments, used if NULL is passed to av_bitstream_filter_filter().
5815 * Not for access by library users.
5818 } AVBitStreamFilterContext;
5821 typedef struct AVBSFInternal AVBSFInternal;
5824 * The bitstream filter state.
5826 * This struct must be allocated with av_bsf_alloc() and freed with
5829 * The fields in the struct will only be changed (by the caller or by the
5830 * filter) as described in their documentation, and are to be considered
5831 * immutable otherwise.
5833 typedef struct AVBSFContext {
5835 * A class for logging and AVOptions
5837 const AVClass *av_class;
5840 * The bitstream filter this context is an instance of.
5842 const struct AVBitStreamFilter *filter;
5845 * Opaque libavcodec internal data. Must not be touched by the caller in any
5848 AVBSFInternal *internal;
5851 * Opaque filter-specific private data. If filter->priv_class is non-NULL,
5852 * this is an AVOptions-enabled struct.
5857 * Parameters of the input stream. This field is allocated in
5858 * av_bsf_alloc(), it needs to be filled by the caller before
5861 AVCodecParameters *par_in;
5864 * Parameters of the output stream. This field is allocated in
5865 * av_bsf_alloc(), it is set by the filter in av_bsf_init().
5867 AVCodecParameters *par_out;
5870 * The timebase used for the timestamps of the input packets. Set by the
5871 * caller before av_bsf_init().
5873 AVRational time_base_in;
5876 * The timebase used for the timestamps of the output packets. Set by the
5877 * filter in av_bsf_init().
5879 AVRational time_base_out;
5882 typedef struct AVBitStreamFilter {
5886 * A list of codec ids supported by the filter, terminated by
5888 * May be NULL, in that case the bitstream filter works with any codec id.
5890 const enum AVCodecID *codec_ids;
5893 * A class for the private data, used to declare bitstream filter private
5894 * AVOptions. This field is NULL for bitstream filters that do not declare
5897 * If this field is non-NULL, the first member of the filter private data
5898 * must be a pointer to AVClass, which will be set by libavcodec generic
5899 * code to this class.
5901 const AVClass *priv_class;
5903 /*****************************************************************
5904 * No fields below this line are part of the public API. They
5905 * may not be used outside of libavcodec and can be changed and
5907 * New public fields should be added right above.
5908 *****************************************************************
5912 int (*init)(AVBSFContext *ctx);
5913 int (*filter)(AVBSFContext *ctx, AVPacket *pkt);
5914 void (*close)(AVBSFContext *ctx);
5915 void (*flush)(AVBSFContext *ctx);
5916 } AVBitStreamFilter;
5920 * @deprecated the old bitstream filtering API (using AVBitStreamFilterContext)
5921 * is deprecated. Use the new bitstream filtering API (using AVBSFContext).
5923 attribute_deprecated
5924 void av_register_bitstream_filter(AVBitStreamFilter *bsf);
5926 * @deprecated the old bitstream filtering API (using AVBitStreamFilterContext)
5927 * is deprecated. Use av_bsf_get_by_name(), av_bsf_alloc(), and av_bsf_init()
5928 * from the new bitstream filtering API (using AVBSFContext).
5930 attribute_deprecated
5931 AVBitStreamFilterContext *av_bitstream_filter_init(const char *name);
5933 * @deprecated the old bitstream filtering API (using AVBitStreamFilterContext)
5934 * is deprecated. Use av_bsf_send_packet() and av_bsf_receive_packet() from the
5935 * new bitstream filtering API (using AVBSFContext).
5937 attribute_deprecated
5938 int av_bitstream_filter_filter(AVBitStreamFilterContext *bsfc,
5939 AVCodecContext *avctx, const char *args,
5940 uint8_t **poutbuf, int *poutbuf_size,
5941 const uint8_t *buf, int buf_size, int keyframe);
5943 * @deprecated the old bitstream filtering API (using AVBitStreamFilterContext)
5944 * is deprecated. Use av_bsf_free() from the new bitstream filtering API (using
5947 attribute_deprecated
5948 void av_bitstream_filter_close(AVBitStreamFilterContext *bsf);
5950 * @deprecated the old bitstream filtering API (using AVBitStreamFilterContext)
5951 * is deprecated. Use av_bsf_iterate() from the new bitstream filtering API (using
5954 attribute_deprecated
5955 const AVBitStreamFilter *av_bitstream_filter_next(const AVBitStreamFilter *f);
5959 * @return a bitstream filter with the specified name or NULL if no such
5960 * bitstream filter exists.
5962 const AVBitStreamFilter *av_bsf_get_by_name(const char *name);
5965 * Iterate over all registered bitstream filters.
5967 * @param opaque a pointer where libavcodec will store the iteration state. Must
5968 * point to NULL to start the iteration.
5970 * @return the next registered bitstream filter or NULL when the iteration is
5973 const AVBitStreamFilter *av_bsf_iterate(void **opaque);
5975 attribute_deprecated
5976 const AVBitStreamFilter *av_bsf_next(void **opaque);
5980 * Allocate a context for a given bitstream filter. The caller must fill in the
5981 * context parameters as described in the documentation and then call
5982 * av_bsf_init() before sending any data to the filter.
5984 * @param filter the filter for which to allocate an instance.
5985 * @param ctx a pointer into which the pointer to the newly-allocated context
5986 * will be written. It must be freed with av_bsf_free() after the
5987 * filtering is done.
5989 * @return 0 on success, a negative AVERROR code on failure
5991 int av_bsf_alloc(const AVBitStreamFilter *filter, AVBSFContext **ctx);
5994 * Prepare the filter for use, after all the parameters and options have been
5997 int av_bsf_init(AVBSFContext *ctx);
6000 * Submit a packet for filtering.
6002 * After sending each packet, the filter must be completely drained by calling
6003 * av_bsf_receive_packet() repeatedly until it returns AVERROR(EAGAIN) or
6006 * @param pkt the packet to filter. The bitstream filter will take ownership of
6007 * the packet and reset the contents of pkt. pkt is not touched if an error occurs.
6008 * If pkt is empty (i.e. NULL, or pkt->data is NULL and pkt->side_data_elems zero),
6009 * it signals the end of the stream (i.e. no more non-empty packets will be sent;
6010 * sending more empty packets does nothing) and will cause the filter to output
6011 * any packets it may have buffered internally.
6013 * @return 0 on success, a negative AVERROR on error. This function never fails if
6016 int av_bsf_send_packet(AVBSFContext *ctx, AVPacket *pkt);
6019 * Retrieve a filtered packet.
6021 * @param[out] pkt this struct will be filled with the contents of the filtered
6022 * packet. It is owned by the caller and must be freed using
6023 * av_packet_unref() when it is no longer needed.
6024 * This parameter should be "clean" (i.e. freshly allocated
6025 * with av_packet_alloc() or unreffed with av_packet_unref())
6026 * when this function is called. If this function returns
6027 * successfully, the contents of pkt will be completely
6028 * overwritten by the returned data. On failure, pkt is not
6031 * @return 0 on success. AVERROR(EAGAIN) if more packets need to be sent to the
6032 * filter (using av_bsf_send_packet()) to get more output. AVERROR_EOF if there
6033 * will be no further output from the filter. Another negative AVERROR value if
6036 * @note one input packet may result in several output packets, so after sending
6037 * a packet with av_bsf_send_packet(), this function needs to be called
6038 * repeatedly until it stops returning 0. It is also possible for a filter to
6039 * output fewer packets than were sent to it, so this function may return
6040 * AVERROR(EAGAIN) immediately after a successful av_bsf_send_packet() call.
6042 int av_bsf_receive_packet(AVBSFContext *ctx, AVPacket *pkt);
6045 * Reset the internal bitstream filter state / flush internal buffers.
6047 void av_bsf_flush(AVBSFContext *ctx);
6050 * Free a bitstream filter context and everything associated with it; write NULL
6051 * into the supplied pointer.
6053 void av_bsf_free(AVBSFContext **ctx);
6056 * Get the AVClass for AVBSFContext. It can be used in combination with
6057 * AV_OPT_SEARCH_FAKE_OBJ for examining options.
6059 * @see av_opt_find().
6061 const AVClass *av_bsf_get_class(void);
6064 * Structure for chain/list of bitstream filters.
6065 * Empty list can be allocated by av_bsf_list_alloc().
6067 typedef struct AVBSFList AVBSFList;
6070 * Allocate empty list of bitstream filters.
6071 * The list must be later freed by av_bsf_list_free()
6072 * or finalized by av_bsf_list_finalize().
6074 * @return Pointer to @ref AVBSFList on success, NULL in case of failure
6076 AVBSFList *av_bsf_list_alloc(void);
6079 * Free list of bitstream filters.
6081 * @param lst Pointer to pointer returned by av_bsf_list_alloc()
6083 void av_bsf_list_free(AVBSFList **lst);
6086 * Append bitstream filter to the list of bitstream filters.
6088 * @param lst List to append to
6089 * @param bsf Filter context to be appended
6091 * @return >=0 on success, negative AVERROR in case of failure
6093 int av_bsf_list_append(AVBSFList *lst, AVBSFContext *bsf);
6096 * Construct new bitstream filter context given it's name and options
6097 * and append it to the list of bitstream filters.
6099 * @param lst List to append to
6100 * @param bsf_name Name of the bitstream filter
6101 * @param options Options for the bitstream filter, can be set to NULL
6103 * @return >=0 on success, negative AVERROR in case of failure
6105 int av_bsf_list_append2(AVBSFList *lst, const char * bsf_name, AVDictionary **options);
6107 * Finalize list of bitstream filters.
6109 * This function will transform @ref AVBSFList to single @ref AVBSFContext,
6110 * so the whole chain of bitstream filters can be treated as single filter
6111 * freshly allocated by av_bsf_alloc().
6112 * If the call is successful, @ref AVBSFList structure is freed and lst
6113 * will be set to NULL. In case of failure, caller is responsible for
6114 * freeing the structure by av_bsf_list_free()
6116 * @param lst Filter list structure to be transformed
6117 * @param[out] bsf Pointer to be set to newly created @ref AVBSFContext structure
6118 * representing the chain of bitstream filters
6120 * @return >=0 on success, negative AVERROR in case of failure
6122 int av_bsf_list_finalize(AVBSFList **lst, AVBSFContext **bsf);
6125 * Parse string describing list of bitstream filters and create single
6126 * @ref AVBSFContext describing the whole chain of bitstream filters.
6127 * Resulting @ref AVBSFContext can be treated as any other @ref AVBSFContext freshly
6128 * allocated by av_bsf_alloc().
6130 * @param str String describing chain of bitstream filters in format
6131 * `bsf1[=opt1=val1:opt2=val2][,bsf2]`
6132 * @param[out] bsf Pointer to be set to newly created @ref AVBSFContext structure
6133 * representing the chain of bitstream filters
6135 * @return >=0 on success, negative AVERROR in case of failure
6137 int av_bsf_list_parse_str(const char *str, AVBSFContext **bsf);
6140 * Get null/pass-through bitstream filter.
6142 * @param[out] bsf Pointer to be set to new instance of pass-through bitstream filter
6146 int av_bsf_get_null_filter(AVBSFContext **bsf);
6151 * Same behaviour av_fast_malloc but the buffer has additional
6152 * AV_INPUT_BUFFER_PADDING_SIZE at the end which will always be 0.
6154 * In addition the whole buffer will initially and after resizes
6155 * be 0-initialized so that no uninitialized data will ever appear.
6157 void av_fast_padded_malloc(void *ptr, unsigned int *size, size_t min_size);
6160 * Same behaviour av_fast_padded_malloc except that buffer will always
6161 * be 0-initialized after call.
6163 void av_fast_padded_mallocz(void *ptr, unsigned int *size, size_t min_size);
6166 * Encode extradata length to a buffer. Used by xiph codecs.
6168 * @param s buffer to write to; must be at least (v/255+1) bytes long
6169 * @param v size of extradata in bytes
6170 * @return number of bytes written to the buffer.
6172 unsigned int av_xiphlacing(unsigned char *s, unsigned int v);
6174 #if FF_API_USER_VISIBLE_AVHWACCEL
6176 * Register the hardware accelerator hwaccel.
6178 * @deprecated This function doesn't do anything.
6180 attribute_deprecated
6181 void av_register_hwaccel(AVHWAccel *hwaccel);
6184 * If hwaccel is NULL, returns the first registered hardware accelerator,
6185 * if hwaccel is non-NULL, returns the next registered hardware accelerator
6186 * after hwaccel, or NULL if hwaccel is the last one.
6188 * @deprecated AVHWaccel structures contain no user-serviceable parts, so
6189 * this function should not be used.
6191 attribute_deprecated
6192 AVHWAccel *av_hwaccel_next(const AVHWAccel *hwaccel);
6197 * Lock operation used by lockmgr
6199 * @deprecated Deprecated together with av_lockmgr_register().
6202 AV_LOCK_CREATE, ///< Create a mutex
6203 AV_LOCK_OBTAIN, ///< Lock the mutex
6204 AV_LOCK_RELEASE, ///< Unlock the mutex
6205 AV_LOCK_DESTROY, ///< Free mutex resources
6209 * Register a user provided lock manager supporting the operations
6210 * specified by AVLockOp. The "mutex" argument to the function points
6211 * to a (void *) where the lockmgr should store/get a pointer to a user
6212 * allocated mutex. It is NULL upon AV_LOCK_CREATE and equal to the
6213 * value left by the last call for all other ops. If the lock manager is
6214 * unable to perform the op then it should leave the mutex in the same
6215 * state as when it was called and return a non-zero value. However,
6216 * when called with AV_LOCK_DESTROY the mutex will always be assumed to
6217 * have been successfully destroyed. If av_lockmgr_register succeeds
6218 * it will return a non-negative value, if it fails it will return a
6219 * negative value and destroy all mutex and unregister all callbacks.
6220 * av_lockmgr_register is not thread-safe, it must be called from a
6221 * single thread before any calls which make use of locking are used.
6223 * @param cb User defined callback. av_lockmgr_register invokes calls
6224 * to this callback and the previously registered callback.
6225 * The callback will be used to create more than one mutex
6226 * each of which must be backed by its own underlying locking
6227 * mechanism (i.e. do not use a single static object to
6228 * implement your lock manager). If cb is set to NULL the
6229 * lockmgr will be unregistered.
6231 * @deprecated This function does nothing, and always returns 0. Be sure to
6232 * build with thread support to get basic thread safety.
6234 attribute_deprecated
6235 int av_lockmgr_register(int (*cb)(void **mutex, enum AVLockOp op));
6239 * Get the type of the given codec.
6241 enum AVMediaType avcodec_get_type(enum AVCodecID codec_id);
6244 * Get the name of a codec.
6245 * @return a static string identifying the codec; never NULL
6247 const char *avcodec_get_name(enum AVCodecID id);
6250 * @return a positive value if s is open (i.e. avcodec_open2() was called on it
6251 * with no corresponding avcodec_close()), 0 otherwise.
6253 int avcodec_is_open(AVCodecContext *s);
6256 * @return a non-zero number if codec is an encoder, zero otherwise
6258 int av_codec_is_encoder(const AVCodec *codec);
6261 * @return a non-zero number if codec is a decoder, zero otherwise
6263 int av_codec_is_decoder(const AVCodec *codec);
6266 * @return descriptor for given codec ID or NULL if no descriptor exists.
6268 const AVCodecDescriptor *avcodec_descriptor_get(enum AVCodecID id);
6271 * Iterate over all codec descriptors known to libavcodec.
6273 * @param prev previous descriptor. NULL to get the first descriptor.
6275 * @return next descriptor or NULL after the last descriptor
6277 const AVCodecDescriptor *avcodec_descriptor_next(const AVCodecDescriptor *prev);
6280 * @return codec descriptor with the given name or NULL if no such descriptor
6283 const AVCodecDescriptor *avcodec_descriptor_get_by_name(const char *name);
6286 * Allocate a CPB properties structure and initialize its fields to default
6289 * @param size if non-NULL, the size of the allocated struct will be written
6290 * here. This is useful for embedding it in side data.
6292 * @return the newly allocated struct or NULL on failure
6294 AVCPBProperties *av_cpb_properties_alloc(size_t *size);
6300 #endif /* AVCODEC_AVCODEC_H */