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.
95 * In both cases, it is recommended that AVPackets and AVFrames are
96 * refcounted, or libavcodec might have to copy the input data. (libavformat
97 * always returns refcounted AVPackets, and av_frame_get_buffer() allocates
98 * refcounted AVFrames.)
99 * - Receive output in a loop. Periodically call one of the avcodec_receive_*()
100 * functions and process their output:
101 * - For decoding, call avcodec_receive_frame(). On success, it will return
102 * an AVFrame containing uncompressed audio or video data.
103 * - For encoding, call avcodec_receive_packet(). On success, it will return
104 * an AVPacket with a compressed frame.
105 * Repeat this call until it returns AVERROR(EAGAIN) or an error. The
106 * AVERROR(EAGAIN) return value means that new input data is required to
107 * return new output. In this case, continue with sending input. For each
108 * input frame/packet, the codec will typically return 1 output frame/packet,
109 * but it can also be 0 or more than 1.
111 * At the beginning of decoding or encoding, the codec might accept multiple
112 * input frames/packets without returning a frame, until its internal buffers
113 * are filled. This situation is handled transparently if you follow the steps
116 * In theory, sending input can result in EAGAIN - this should happen only if
117 * not all output was received. You can use this to structure alternative decode
118 * or encode loops other than the one suggested above. For example, you could
119 * try sending new input on each iteration, and try to receive output if that
122 * End of stream situations. These require "flushing" (aka draining) the codec,
123 * as the codec might buffer multiple frames or packets internally for
124 * performance or out of necessity (consider B-frames).
125 * This is handled as follows:
126 * - Instead of valid input, send NULL to the avcodec_send_packet() (decoding)
127 * or avcodec_send_frame() (encoding) functions. This will enter draining
129 * - Call avcodec_receive_frame() (decoding) or avcodec_receive_packet()
130 * (encoding) in a loop until AVERROR_EOF is returned. The functions will
131 * not return AVERROR(EAGAIN), unless you forgot to enter draining mode.
132 * - Before decoding can be resumed again, the codec has to be reset with
133 * avcodec_flush_buffers().
135 * Using the API as outlined above is highly recommended. But it is also
136 * possible to call functions outside of this rigid schema. For example, you can
137 * call avcodec_send_packet() repeatedly without calling
138 * avcodec_receive_frame(). In this case, avcodec_send_packet() will succeed
139 * until the codec's internal buffer has been filled up (which is typically of
140 * size 1 per output frame, after initial input), and then reject input with
141 * AVERROR(EAGAIN). Once it starts rejecting input, you have no choice but to
142 * read at least some output.
144 * Not all codecs will follow a rigid and predictable dataflow; the only
145 * guarantee is that an AVERROR(EAGAIN) return value on a send/receive call on
146 * one end implies that a receive/send call on the other end will succeed, or
147 * at least will not fail with AVERROR(EAGAIN). In general, no codec will
148 * permit unlimited buffering of input or output.
150 * This API replaces the following legacy functions:
151 * - avcodec_decode_video2() and avcodec_decode_audio4():
152 * Use avcodec_send_packet() to feed input to the decoder, then use
153 * avcodec_receive_frame() to receive decoded frames after each packet.
154 * Unlike with the old video decoding API, multiple frames might result from
155 * a packet. For audio, splitting the input packet into frames by partially
156 * decoding packets becomes transparent to the API user. You never need to
157 * feed an AVPacket to the API twice (unless it is rejected with AVERROR(EAGAIN) - then
158 * no data was read from the packet).
159 * Additionally, sending a flush/draining packet is required only once.
160 * - avcodec_encode_video2()/avcodec_encode_audio2():
161 * Use avcodec_send_frame() to feed input to the encoder, then use
162 * avcodec_receive_packet() to receive encoded packets.
163 * Providing user-allocated buffers for avcodec_receive_packet() is not
165 * - The new API does not handle subtitles yet.
167 * Mixing new and old function calls on the same AVCodecContext is not allowed,
168 * and will result in undefined behavior.
170 * Some codecs might require using the new API; using the old API will return
171 * an error when calling it. All codecs support the new API.
173 * A codec is not allowed to return AVERROR(EAGAIN) for both sending and receiving. This
174 * would be an invalid state, which could put the codec user into an endless
175 * loop. The API has no concept of time either: it cannot happen that trying to
176 * do avcodec_send_packet() results in AVERROR(EAGAIN), but a repeated call 1 second
177 * later accepts the packet (with no other receive/flush API calls involved).
178 * The API is a strict state machine, and the passage of time is not supposed
179 * to influence it. Some timing-dependent behavior might still be deemed
180 * acceptable in certain cases. But it must never result in both send/receive
181 * returning EAGAIN at the same time at any point. It must also absolutely be
182 * avoided that the current state is "unstable" and can "flip-flop" between
183 * the send/receive APIs allowing progress. For example, it's not allowed that
184 * the codec randomly decides that it actually wants to consume a packet now
185 * instead of returning a frame, after it just returned AVERROR(EAGAIN) on an
186 * avcodec_send_packet() call.
191 * @defgroup lavc_core Core functions/structures.
194 * Basic definitions, functions for querying libavcodec capabilities,
195 * allocating core structures, etc.
201 * Identify the syntax and semantics of the bitstream.
202 * The principle is roughly:
203 * Two decoders with the same ID can decode the same streams.
204 * Two encoders with the same ID can encode compatible streams.
205 * There may be slight deviations from the principle due to implementation
208 * If you add a codec ID to this list, add it so that
209 * 1. no value of an existing codec ID changes (that would break ABI),
210 * 2. it is as close as possible to similar codecs
212 * After adding new codec IDs, do not forget to add an entry to the codec
213 * descriptor list and bump libavcodec minor version.
219 AV_CODEC_ID_MPEG1VIDEO,
220 AV_CODEC_ID_MPEG2VIDEO, ///< preferred ID for MPEG-1/2 video decoding
231 AV_CODEC_ID_RAWVIDEO,
232 AV_CODEC_ID_MSMPEG4V1,
233 AV_CODEC_ID_MSMPEG4V2,
234 AV_CODEC_ID_MSMPEG4V3,
257 AV_CODEC_ID_INTERPLAY_VIDEO,
264 AV_CODEC_ID_MSVIDEO1,
269 AV_CODEC_ID_TRUEMOTION1,
270 AV_CODEC_ID_VMDVIDEO,
295 AV_CODEC_ID_TRUEMOTION2,
301 AV_CODEC_ID_SMACKVIDEO,
306 AV_CODEC_ID_JPEG2000,
312 AV_CODEC_ID_DSICINVIDEO,
313 AV_CODEC_ID_TIERTEXSEQVIDEO,
321 AV_CODEC_ID_BETHSOFTVID,
333 AV_CODEC_ID_ESCAPE124,
337 AV_CODEC_ID_MOTIONPIXELS,
349 AV_CODEC_ID_FLASHSV2,
350 AV_CODEC_ID_CDGRAPHICS,
353 AV_CODEC_ID_BINKVIDEO,
354 AV_CODEC_ID_IFF_ILBM,
355 #define AV_CODEC_ID_IFF_BYTERUN1 AV_CODEC_ID_IFF_ILBM
361 AV_CODEC_ID_A64_MULTI,
362 AV_CODEC_ID_A64_MULTI5,
365 AV_CODEC_ID_LAGARITH,
369 AV_CODEC_ID_WMV3IMAGE,
370 AV_CODEC_ID_VC1IMAGE,
372 AV_CODEC_ID_BMV_VIDEO,
379 AV_CODEC_ID_ZEROCODEC,
388 AV_CODEC_ID_ESCAPE130,
391 AV_CODEC_ID_HNM4_VIDEO,
393 #define AV_CODEC_ID_H265 AV_CODEC_ID_HEVC
395 AV_CODEC_ID_ALIAS_PIX,
396 AV_CODEC_ID_BRENDER_PIX,
397 AV_CODEC_ID_PAF_VIDEO,
410 AV_CODEC_ID_SCREENPRESSO,
414 AV_CODEC_ID_Y41P = 0x8000,
419 AV_CODEC_ID_TARGA_Y216,
431 AV_CODEC_ID_TRUEMOTION2RT,
433 AV_CODEC_ID_MAGICYUV,
434 AV_CODEC_ID_SHEERVIDEO,
441 AV_CODEC_ID_CLEARVIDEO,
444 AV_CODEC_ID_BITPACKED,
451 AV_CODEC_ID_PROSUMER,
462 /* various PCM "codecs" */
463 AV_CODEC_ID_FIRST_AUDIO = 0x10000, ///< A dummy id pointing at the start of audio codecs
464 AV_CODEC_ID_PCM_S16LE = 0x10000,
465 AV_CODEC_ID_PCM_S16BE,
466 AV_CODEC_ID_PCM_U16LE,
467 AV_CODEC_ID_PCM_U16BE,
470 AV_CODEC_ID_PCM_MULAW,
471 AV_CODEC_ID_PCM_ALAW,
472 AV_CODEC_ID_PCM_S32LE,
473 AV_CODEC_ID_PCM_S32BE,
474 AV_CODEC_ID_PCM_U32LE,
475 AV_CODEC_ID_PCM_U32BE,
476 AV_CODEC_ID_PCM_S24LE,
477 AV_CODEC_ID_PCM_S24BE,
478 AV_CODEC_ID_PCM_U24LE,
479 AV_CODEC_ID_PCM_U24BE,
480 AV_CODEC_ID_PCM_S24DAUD,
481 AV_CODEC_ID_PCM_ZORK,
482 AV_CODEC_ID_PCM_S16LE_PLANAR,
484 AV_CODEC_ID_PCM_F32BE,
485 AV_CODEC_ID_PCM_F32LE,
486 AV_CODEC_ID_PCM_F64BE,
487 AV_CODEC_ID_PCM_F64LE,
488 AV_CODEC_ID_PCM_BLURAY,
491 AV_CODEC_ID_PCM_S8_PLANAR,
492 AV_CODEC_ID_PCM_S24LE_PLANAR,
493 AV_CODEC_ID_PCM_S32LE_PLANAR,
494 AV_CODEC_ID_PCM_S16BE_PLANAR,
496 AV_CODEC_ID_PCM_S64LE = 0x10800,
497 AV_CODEC_ID_PCM_S64BE,
498 AV_CODEC_ID_PCM_F16LE,
499 AV_CODEC_ID_PCM_F24LE,
500 AV_CODEC_ID_PCM_VIDC,
502 /* various ADPCM codecs */
503 AV_CODEC_ID_ADPCM_IMA_QT = 0x11000,
504 AV_CODEC_ID_ADPCM_IMA_WAV,
505 AV_CODEC_ID_ADPCM_IMA_DK3,
506 AV_CODEC_ID_ADPCM_IMA_DK4,
507 AV_CODEC_ID_ADPCM_IMA_WS,
508 AV_CODEC_ID_ADPCM_IMA_SMJPEG,
509 AV_CODEC_ID_ADPCM_MS,
510 AV_CODEC_ID_ADPCM_4XM,
511 AV_CODEC_ID_ADPCM_XA,
512 AV_CODEC_ID_ADPCM_ADX,
513 AV_CODEC_ID_ADPCM_EA,
514 AV_CODEC_ID_ADPCM_G726,
515 AV_CODEC_ID_ADPCM_CT,
516 AV_CODEC_ID_ADPCM_SWF,
517 AV_CODEC_ID_ADPCM_YAMAHA,
518 AV_CODEC_ID_ADPCM_SBPRO_4,
519 AV_CODEC_ID_ADPCM_SBPRO_3,
520 AV_CODEC_ID_ADPCM_SBPRO_2,
521 AV_CODEC_ID_ADPCM_THP,
522 AV_CODEC_ID_ADPCM_IMA_AMV,
523 AV_CODEC_ID_ADPCM_EA_R1,
524 AV_CODEC_ID_ADPCM_EA_R3,
525 AV_CODEC_ID_ADPCM_EA_R2,
526 AV_CODEC_ID_ADPCM_IMA_EA_SEAD,
527 AV_CODEC_ID_ADPCM_IMA_EA_EACS,
528 AV_CODEC_ID_ADPCM_EA_XAS,
529 AV_CODEC_ID_ADPCM_EA_MAXIS_XA,
530 AV_CODEC_ID_ADPCM_IMA_ISS,
531 AV_CODEC_ID_ADPCM_G722,
532 AV_CODEC_ID_ADPCM_IMA_APC,
533 AV_CODEC_ID_ADPCM_VIMA,
535 AV_CODEC_ID_ADPCM_AFC = 0x11800,
536 AV_CODEC_ID_ADPCM_IMA_OKI,
537 AV_CODEC_ID_ADPCM_DTK,
538 AV_CODEC_ID_ADPCM_IMA_RAD,
539 AV_CODEC_ID_ADPCM_G726LE,
540 AV_CODEC_ID_ADPCM_THP_LE,
541 AV_CODEC_ID_ADPCM_PSX,
542 AV_CODEC_ID_ADPCM_AICA,
543 AV_CODEC_ID_ADPCM_IMA_DAT4,
544 AV_CODEC_ID_ADPCM_MTAF,
545 AV_CODEC_ID_ADPCM_AGM,
548 AV_CODEC_ID_AMR_NB = 0x12000,
551 /* RealAudio codecs*/
552 AV_CODEC_ID_RA_144 = 0x13000,
555 /* various DPCM codecs */
556 AV_CODEC_ID_ROQ_DPCM = 0x14000,
557 AV_CODEC_ID_INTERPLAY_DPCM,
558 AV_CODEC_ID_XAN_DPCM,
559 AV_CODEC_ID_SOL_DPCM,
561 AV_CODEC_ID_SDX2_DPCM = 0x14800,
562 AV_CODEC_ID_GREMLIN_DPCM,
565 AV_CODEC_ID_MP2 = 0x15000,
566 AV_CODEC_ID_MP3, ///< preferred ID for decoding MPEG audio layer 1, 2 or 3
576 AV_CODEC_ID_VMDAUDIO,
582 AV_CODEC_ID_WESTWOOD_SND1,
583 AV_CODEC_ID_GSM, ///< as in Berlin toast format
586 AV_CODEC_ID_TRUESPEECH,
588 AV_CODEC_ID_SMACKAUDIO,
591 AV_CODEC_ID_DSICINAUDIO,
593 AV_CODEC_ID_MUSEPACK7,
595 AV_CODEC_ID_GSM_MS, /* as found in WAV */
598 AV_CODEC_ID_NELLYMOSER,
599 AV_CODEC_ID_MUSEPACK8,
601 AV_CODEC_ID_WMAVOICE,
603 AV_CODEC_ID_WMALOSSLESS,
612 AV_CODEC_ID_BINKAUDIO_RDFT,
613 AV_CODEC_ID_BINKAUDIO_DCT,
614 AV_CODEC_ID_AAC_LATM,
619 AV_CODEC_ID_8SVX_EXP,
620 AV_CODEC_ID_8SVX_FIB,
621 AV_CODEC_ID_BMV_AUDIO,
626 AV_CODEC_ID_COMFORT_NOISE,
628 AV_CODEC_ID_METASOUND,
629 AV_CODEC_ID_PAF_AUDIO,
634 AV_CODEC_ID_FFWAVESYNTH = 0x15800,
636 AV_CODEC_ID_SONIC_LS,
639 AV_CODEC_ID_DSD_LSBF,
640 AV_CODEC_ID_DSD_MSBF,
641 AV_CODEC_ID_DSD_LSBF_PLANAR,
642 AV_CODEC_ID_DSD_MSBF_PLANAR,
644 AV_CODEC_ID_INTERPLAY_ACM,
648 AV_CODEC_ID_ATRAC3AL,
649 AV_CODEC_ID_ATRAC3PAL,
656 AV_CODEC_ID_ACELP_KELVIN,
658 /* subtitle codecs */
659 AV_CODEC_ID_FIRST_SUBTITLE = 0x17000, ///< A dummy ID pointing at the start of subtitle codecs.
660 AV_CODEC_ID_DVD_SUBTITLE = 0x17000,
661 AV_CODEC_ID_DVB_SUBTITLE,
662 AV_CODEC_ID_TEXT, ///< raw UTF-8 text
665 AV_CODEC_ID_MOV_TEXT,
666 AV_CODEC_ID_HDMV_PGS_SUBTITLE,
667 AV_CODEC_ID_DVB_TELETEXT,
670 AV_CODEC_ID_MICRODVD = 0x17800,
674 AV_CODEC_ID_REALTEXT,
676 AV_CODEC_ID_SUBVIEWER1,
677 AV_CODEC_ID_SUBVIEWER,
684 AV_CODEC_ID_HDMV_TEXT_SUBTITLE,
686 AV_CODEC_ID_ARIB_CAPTION,
688 /* other specific kind of codecs (generally used for attachments) */
689 AV_CODEC_ID_FIRST_UNKNOWN = 0x18000, ///< A dummy ID pointing at the start of various fake codecs.
690 AV_CODEC_ID_TTF = 0x18000,
692 AV_CODEC_ID_SCTE_35, ///< Contain timestamp estimated through PCR of program stream.
694 AV_CODEC_ID_BINTEXT = 0x18800,
698 AV_CODEC_ID_SMPTE_KLV,
700 AV_CODEC_ID_TIMED_ID3,
701 AV_CODEC_ID_BIN_DATA,
704 AV_CODEC_ID_PROBE = 0x19000, ///< codec_id is not known (like AV_CODEC_ID_NONE) but lavf should attempt to identify it
706 AV_CODEC_ID_MPEG2TS = 0x20000, /**< _FAKE_ codec to indicate a raw MPEG-2 TS
707 * stream (only used by libavformat) */
708 AV_CODEC_ID_MPEG4SYSTEMS = 0x20001, /**< _FAKE_ codec to indicate a MPEG-4 Systems
709 * stream (only used by libavformat) */
710 AV_CODEC_ID_FFMETADATA = 0x21000, ///< Dummy codec for streams containing only metadata information.
711 AV_CODEC_ID_WRAPPED_AVFRAME = 0x21001, ///< Passthrough codec, AVFrames wrapped in AVPacket
715 * This struct describes the properties of a single codec described by an
717 * @see avcodec_descriptor_get()
719 typedef struct AVCodecDescriptor {
721 enum AVMediaType type;
723 * Name of the codec described by this descriptor. It is non-empty and
724 * unique for each codec descriptor. It should contain alphanumeric
725 * characters and '_' only.
729 * A more descriptive name for this codec. May be NULL.
731 const char *long_name;
733 * Codec properties, a combination of AV_CODEC_PROP_* flags.
737 * MIME type(s) associated with the codec.
738 * May be NULL; if not, a NULL-terminated array of MIME types.
739 * The first item is always non-NULL and is the preferred MIME type.
741 const char *const *mime_types;
743 * If non-NULL, an array of profiles recognized for this codec.
744 * Terminated with FF_PROFILE_UNKNOWN.
746 const struct AVProfile *profiles;
750 * Codec uses only intra compression.
751 * Video and audio codecs only.
753 #define AV_CODEC_PROP_INTRA_ONLY (1 << 0)
755 * Codec supports lossy compression. Audio and video codecs only.
756 * @note a codec may support both lossy and lossless
759 #define AV_CODEC_PROP_LOSSY (1 << 1)
761 * Codec supports lossless compression. Audio and video codecs only.
763 #define AV_CODEC_PROP_LOSSLESS (1 << 2)
765 * Codec supports frame reordering. That is, the coded order (the order in which
766 * the encoded packets are output by the encoders / stored / input to the
767 * decoders) may be different from the presentation order of the corresponding
770 * For codecs that do not have this property set, PTS and DTS should always be
773 #define AV_CODEC_PROP_REORDER (1 << 3)
775 * Subtitle codec is bitmap based
776 * Decoded AVSubtitle data can be read from the AVSubtitleRect->pict field.
778 #define AV_CODEC_PROP_BITMAP_SUB (1 << 16)
780 * Subtitle codec is text based.
781 * Decoded AVSubtitle data can be read from the AVSubtitleRect->ass field.
783 #define AV_CODEC_PROP_TEXT_SUB (1 << 17)
786 * @ingroup lavc_decoding
787 * Required number of additionally allocated bytes at the end of the input bitstream for decoding.
788 * This is mainly needed because some optimized bitstream readers read
789 * 32 or 64 bit at once and could read over the end.<br>
790 * Note: If the first 23 bits of the additional bytes are not 0, then damaged
791 * MPEG bitstreams could cause overread and segfault.
793 #define AV_INPUT_BUFFER_PADDING_SIZE 64
796 * @ingroup lavc_encoding
797 * minimum encoding buffer size
798 * Used to avoid some checks during header writing.
800 #define AV_INPUT_BUFFER_MIN_SIZE 16384
803 * @ingroup lavc_decoding
806 /* We leave some space between them for extensions (drop some
807 * keyframes for intra-only or drop just some bidir frames). */
808 AVDISCARD_NONE =-16, ///< discard nothing
809 AVDISCARD_DEFAULT = 0, ///< discard useless packets like 0 size packets in avi
810 AVDISCARD_NONREF = 8, ///< discard all non reference
811 AVDISCARD_BIDIR = 16, ///< discard all bidirectional frames
812 AVDISCARD_NONINTRA= 24, ///< discard all non intra frames
813 AVDISCARD_NONKEY = 32, ///< discard all frames except keyframes
814 AVDISCARD_ALL = 48, ///< discard all
817 enum AVAudioServiceType {
818 AV_AUDIO_SERVICE_TYPE_MAIN = 0,
819 AV_AUDIO_SERVICE_TYPE_EFFECTS = 1,
820 AV_AUDIO_SERVICE_TYPE_VISUALLY_IMPAIRED = 2,
821 AV_AUDIO_SERVICE_TYPE_HEARING_IMPAIRED = 3,
822 AV_AUDIO_SERVICE_TYPE_DIALOGUE = 4,
823 AV_AUDIO_SERVICE_TYPE_COMMENTARY = 5,
824 AV_AUDIO_SERVICE_TYPE_EMERGENCY = 6,
825 AV_AUDIO_SERVICE_TYPE_VOICE_OVER = 7,
826 AV_AUDIO_SERVICE_TYPE_KARAOKE = 8,
827 AV_AUDIO_SERVICE_TYPE_NB , ///< Not part of ABI
831 * @ingroup lavc_encoding
833 typedef struct RcOverride{
836 int qscale; // If this is 0 then quality_factor will be used instead.
837 float quality_factor;
841 These flags can be passed in AVCodecContext.flags before initialization.
842 Note: Not everything is supported yet.
846 * Allow decoders to produce frames with data planes that are not aligned
847 * to CPU requirements (e.g. due to cropping).
849 #define AV_CODEC_FLAG_UNALIGNED (1 << 0)
853 #define AV_CODEC_FLAG_QSCALE (1 << 1)
855 * 4 MV per MB allowed / advanced prediction for H.263.
857 #define AV_CODEC_FLAG_4MV (1 << 2)
859 * Output even those frames that might be corrupted.
861 #define AV_CODEC_FLAG_OUTPUT_CORRUPT (1 << 3)
865 #define AV_CODEC_FLAG_QPEL (1 << 4)
867 * Don't output frames whose parameters differ from first
868 * decoded frame in stream.
870 #define AV_CODEC_FLAG_DROPCHANGED (1 << 5)
872 * Use internal 2pass ratecontrol in first pass mode.
874 #define AV_CODEC_FLAG_PASS1 (1 << 9)
876 * Use internal 2pass ratecontrol in second pass mode.
878 #define AV_CODEC_FLAG_PASS2 (1 << 10)
882 #define AV_CODEC_FLAG_LOOP_FILTER (1 << 11)
884 * Only decode/encode grayscale.
886 #define AV_CODEC_FLAG_GRAY (1 << 13)
888 * error[?] variables will be set during encoding.
890 #define AV_CODEC_FLAG_PSNR (1 << 15)
892 * Input bitstream might be truncated at a random location
893 * instead of only at frame boundaries.
895 #define AV_CODEC_FLAG_TRUNCATED (1 << 16)
897 * Use interlaced DCT.
899 #define AV_CODEC_FLAG_INTERLACED_DCT (1 << 18)
903 #define AV_CODEC_FLAG_LOW_DELAY (1 << 19)
905 * Place global headers in extradata instead of every keyframe.
907 #define AV_CODEC_FLAG_GLOBAL_HEADER (1 << 22)
909 * Use only bitexact stuff (except (I)DCT).
911 #define AV_CODEC_FLAG_BITEXACT (1 << 23)
912 /* Fx : Flag for H.263+ extra options */
914 * H.263 advanced intra coding / MPEG-4 AC prediction
916 #define AV_CODEC_FLAG_AC_PRED (1 << 24)
918 * interlaced motion estimation
920 #define AV_CODEC_FLAG_INTERLACED_ME (1 << 29)
921 #define AV_CODEC_FLAG_CLOSED_GOP (1U << 31)
924 * Allow non spec compliant speedup tricks.
926 #define AV_CODEC_FLAG2_FAST (1 << 0)
928 * Skip bitstream encoding.
930 #define AV_CODEC_FLAG2_NO_OUTPUT (1 << 2)
932 * Place global headers at every keyframe instead of in extradata.
934 #define AV_CODEC_FLAG2_LOCAL_HEADER (1 << 3)
937 * timecode is in drop frame format. DEPRECATED!!!!
939 #define AV_CODEC_FLAG2_DROP_FRAME_TIMECODE (1 << 13)
942 * Input bitstream might be truncated at a packet boundaries
943 * instead of only at frame boundaries.
945 #define AV_CODEC_FLAG2_CHUNKS (1 << 15)
947 * Discard cropping information from SPS.
949 #define AV_CODEC_FLAG2_IGNORE_CROP (1 << 16)
952 * Show all frames before the first keyframe
954 #define AV_CODEC_FLAG2_SHOW_ALL (1 << 22)
956 * Export motion vectors through frame side data
958 #define AV_CODEC_FLAG2_EXPORT_MVS (1 << 28)
960 * Do not skip samples and export skip information as frame side data
962 #define AV_CODEC_FLAG2_SKIP_MANUAL (1 << 29)
964 * Do not reset ASS ReadOrder field on flush (subtitles decoding)
966 #define AV_CODEC_FLAG2_RO_FLUSH_NOOP (1 << 30)
968 /* Unsupported options :
969 * Syntax Arithmetic coding (SAC)
970 * Reference Picture Selection
971 * Independent Segment Decoding */
973 /* codec capabilities */
976 * Decoder can use draw_horiz_band callback.
978 #define AV_CODEC_CAP_DRAW_HORIZ_BAND (1 << 0)
980 * Codec uses get_buffer() for allocating buffers and supports custom allocators.
981 * If not set, it might not use get_buffer() at all or use operations that
982 * assume the buffer was allocated by avcodec_default_get_buffer.
984 #define AV_CODEC_CAP_DR1 (1 << 1)
985 #define AV_CODEC_CAP_TRUNCATED (1 << 3)
987 * Encoder or decoder requires flushing with NULL input at the end in order to
988 * give the complete and correct output.
990 * NOTE: If this flag is not set, the codec is guaranteed to never be fed with
991 * with NULL data. The user can still send NULL data to the public encode
992 * or decode function, but libavcodec will not pass it along to the codec
993 * unless this flag is set.
996 * The decoder has a non-zero delay and needs to be fed with avpkt->data=NULL,
997 * avpkt->size=0 at the end to get the delayed data until the decoder no longer
1001 * The encoder needs to be fed with NULL data at the end of encoding until the
1002 * encoder no longer returns data.
1004 * NOTE: For encoders implementing the AVCodec.encode2() function, setting this
1005 * flag also means that the encoder must set the pts and duration for
1006 * each output packet. If this flag is not set, the pts and duration will
1007 * be determined by libavcodec from the input frame.
1009 #define AV_CODEC_CAP_DELAY (1 << 5)
1011 * Codec can be fed a final frame with a smaller size.
1012 * This can be used to prevent truncation of the last audio samples.
1014 #define AV_CODEC_CAP_SMALL_LAST_FRAME (1 << 6)
1017 * Codec can output multiple frames per AVPacket
1018 * Normally demuxers return one frame at a time, demuxers which do not do
1019 * are connected to a parser to split what they return into proper frames.
1020 * This flag is reserved to the very rare category of codecs which have a
1021 * bitstream that cannot be split into frames without timeconsuming
1022 * operations like full decoding. Demuxers carrying such bitstreams thus
1023 * may return multiple frames in a packet. This has many disadvantages like
1024 * prohibiting stream copy in many cases thus it should only be considered
1027 #define AV_CODEC_CAP_SUBFRAMES (1 << 8)
1029 * Codec is experimental and is thus avoided in favor of non experimental
1032 #define AV_CODEC_CAP_EXPERIMENTAL (1 << 9)
1034 * Codec should fill in channel configuration and samplerate instead of container
1036 #define AV_CODEC_CAP_CHANNEL_CONF (1 << 10)
1038 * Codec supports frame-level multithreading.
1040 #define AV_CODEC_CAP_FRAME_THREADS (1 << 12)
1042 * Codec supports slice-based (or partition-based) multithreading.
1044 #define AV_CODEC_CAP_SLICE_THREADS (1 << 13)
1046 * Codec supports changed parameters at any point.
1048 #define AV_CODEC_CAP_PARAM_CHANGE (1 << 14)
1050 * Codec supports avctx->thread_count == 0 (auto).
1052 #define AV_CODEC_CAP_AUTO_THREADS (1 << 15)
1054 * Audio encoder supports receiving a different number of samples in each call.
1056 #define AV_CODEC_CAP_VARIABLE_FRAME_SIZE (1 << 16)
1058 * Decoder is not a preferred choice for probing.
1059 * This indicates that the decoder is not a good choice for probing.
1060 * It could for example be an expensive to spin up hardware decoder,
1061 * or it could simply not provide a lot of useful information about
1063 * A decoder marked with this flag should only be used as last resort
1064 * choice for probing.
1066 #define AV_CODEC_CAP_AVOID_PROBING (1 << 17)
1068 * Codec is intra only.
1070 #define AV_CODEC_CAP_INTRA_ONLY 0x40000000
1072 * Codec is lossless.
1074 #define AV_CODEC_CAP_LOSSLESS 0x80000000
1077 * Codec is backed by a hardware implementation. Typically used to
1078 * identify a non-hwaccel hardware decoder. For information about hwaccels, use
1079 * avcodec_get_hw_config() instead.
1081 #define AV_CODEC_CAP_HARDWARE (1 << 18)
1084 * Codec is potentially backed by a hardware implementation, but not
1085 * necessarily. This is used instead of AV_CODEC_CAP_HARDWARE, if the
1086 * implementation provides some sort of internal fallback.
1088 #define AV_CODEC_CAP_HYBRID (1 << 19)
1091 * This codec takes the reordered_opaque field from input AVFrames
1092 * and returns it in the corresponding field in AVCodecContext after
1095 #define AV_CODEC_CAP_ENCODER_REORDERED_OPAQUE (1 << 20)
1099 * This specifies the area which should be displayed.
1100 * Note there may be multiple such areas for one frame.
1102 typedef struct AVPanScan {
1105 * - encoding: Set by user.
1106 * - decoding: Set by libavcodec.
1111 * width and height in 1/16 pel
1112 * - encoding: Set by user.
1113 * - decoding: Set by libavcodec.
1119 * position of the top left corner in 1/16 pel for up to 3 fields/frames
1120 * - encoding: Set by user.
1121 * - decoding: Set by libavcodec.
1123 int16_t position[3][2];
1127 * This structure describes the bitrate properties of an encoded bitstream. It
1128 * roughly corresponds to a subset the VBV parameters for MPEG-2 or HRD
1129 * parameters for H.264/HEVC.
1131 typedef struct AVCPBProperties {
1133 * Maximum bitrate of the stream, in bits per second.
1134 * Zero if unknown or unspecified.
1136 #if FF_API_UNSANITIZED_BITRATES
1139 int64_t max_bitrate;
1142 * Minimum bitrate of the stream, in bits per second.
1143 * Zero if unknown or unspecified.
1145 #if FF_API_UNSANITIZED_BITRATES
1148 int64_t min_bitrate;
1151 * Average bitrate of the stream, in bits per second.
1152 * Zero if unknown or unspecified.
1154 #if FF_API_UNSANITIZED_BITRATES
1157 int64_t avg_bitrate;
1161 * The size of the buffer to which the ratecontrol is applied, in bits.
1162 * Zero if unknown or unspecified.
1167 * The delay between the time the packet this structure is associated with
1168 * is received and the time when it should be decoded, in periods of a 27MHz
1171 * UINT64_MAX when unknown or unspecified.
1177 * The decoder will keep a reference to the frame and may reuse it later.
1179 #define AV_GET_BUFFER_FLAG_REF (1 << 0)
1182 * @defgroup lavc_packet AVPacket
1184 * Types and functions for working with AVPacket.
1187 enum AVPacketSideDataType {
1189 * An AV_PKT_DATA_PALETTE side data packet contains exactly AVPALETTE_SIZE
1190 * bytes worth of palette. This side data signals that a new palette is
1193 AV_PKT_DATA_PALETTE,
1196 * The AV_PKT_DATA_NEW_EXTRADATA is used to notify the codec or the format
1197 * that the extradata buffer was changed and the receiving side should
1198 * act upon it appropriately. The new extradata is embedded in the side
1199 * data buffer and should be immediately used for processing the current
1202 AV_PKT_DATA_NEW_EXTRADATA,
1205 * An AV_PKT_DATA_PARAM_CHANGE side data packet is laid out as follows:
1208 * if (param_flags & AV_SIDE_DATA_PARAM_CHANGE_CHANNEL_COUNT)
1209 * s32le channel_count
1210 * if (param_flags & AV_SIDE_DATA_PARAM_CHANGE_CHANNEL_LAYOUT)
1211 * u64le channel_layout
1212 * if (param_flags & AV_SIDE_DATA_PARAM_CHANGE_SAMPLE_RATE)
1214 * if (param_flags & AV_SIDE_DATA_PARAM_CHANGE_DIMENSIONS)
1219 AV_PKT_DATA_PARAM_CHANGE,
1222 * An AV_PKT_DATA_H263_MB_INFO side data packet contains a number of
1223 * structures with info about macroblocks relevant to splitting the
1224 * packet into smaller packets on macroblock edges (e.g. as for RFC 2190).
1225 * That is, it does not necessarily contain info about all macroblocks,
1226 * as long as the distance between macroblocks in the info is smaller
1227 * than the target payload size.
1228 * Each MB info structure is 12 bytes, and is laid out as follows:
1230 * u32le bit offset from the start of the packet
1231 * u8 current quantizer at the start of the macroblock
1233 * u16le macroblock address within the GOB
1234 * u8 horizontal MV predictor
1235 * u8 vertical MV predictor
1236 * u8 horizontal MV predictor for block number 3
1237 * u8 vertical MV predictor for block number 3
1240 AV_PKT_DATA_H263_MB_INFO,
1243 * This side data should be associated with an audio stream and contains
1244 * ReplayGain information in form of the AVReplayGain struct.
1246 AV_PKT_DATA_REPLAYGAIN,
1249 * This side data contains a 3x3 transformation matrix describing an affine
1250 * transformation that needs to be applied to the decoded video frames for
1251 * correct presentation.
1253 * See libavutil/display.h for a detailed description of the data.
1255 AV_PKT_DATA_DISPLAYMATRIX,
1258 * This side data should be associated with a video stream and contains
1259 * Stereoscopic 3D information in form of the AVStereo3D struct.
1261 AV_PKT_DATA_STEREO3D,
1264 * This side data should be associated with an audio stream and corresponds
1265 * to enum AVAudioServiceType.
1267 AV_PKT_DATA_AUDIO_SERVICE_TYPE,
1270 * This side data contains quality related information from the encoder.
1272 * u32le quality factor of the compressed frame. Allowed range is between 1 (good) and FF_LAMBDA_MAX (bad).
1276 * u64le[error count] sum of squared differences between encoder in and output
1279 AV_PKT_DATA_QUALITY_STATS,
1282 * This side data contains an integer value representing the stream index
1283 * of a "fallback" track. A fallback track indicates an alternate
1284 * track to use when the current track can not be decoded for some reason.
1285 * e.g. no decoder available for codec.
1287 AV_PKT_DATA_FALLBACK_TRACK,
1290 * This side data corresponds to the AVCPBProperties struct.
1292 AV_PKT_DATA_CPB_PROPERTIES,
1295 * Recommmends skipping the specified number of samples
1297 * u32le number of samples to skip from start of this packet
1298 * u32le number of samples to skip from end of this packet
1299 * u8 reason for start skip
1300 * u8 reason for end skip (0=padding silence, 1=convergence)
1303 AV_PKT_DATA_SKIP_SAMPLES,
1306 * An AV_PKT_DATA_JP_DUALMONO side data packet indicates that
1307 * the packet may contain "dual mono" audio specific to Japanese DTV
1308 * and if it is true, recommends only the selected channel to be used.
1310 * u8 selected channels (0=mail/left, 1=sub/right, 2=both)
1313 AV_PKT_DATA_JP_DUALMONO,
1316 * A list of zero terminated key/value strings. There is no end marker for
1317 * the list, so it is required to rely on the side data size to stop.
1319 AV_PKT_DATA_STRINGS_METADATA,
1322 * Subtitle event position
1330 AV_PKT_DATA_SUBTITLE_POSITION,
1333 * Data found in BlockAdditional element of matroska container. There is
1334 * no end marker for the data, so it is required to rely on the side data
1335 * size to recognize the end. 8 byte id (as found in BlockAddId) followed
1338 AV_PKT_DATA_MATROSKA_BLOCKADDITIONAL,
1341 * The optional first identifier line of a WebVTT cue.
1343 AV_PKT_DATA_WEBVTT_IDENTIFIER,
1346 * The optional settings (rendering instructions) that immediately
1347 * follow the timestamp specifier of a WebVTT cue.
1349 AV_PKT_DATA_WEBVTT_SETTINGS,
1352 * A list of zero terminated key/value strings. There is no end marker for
1353 * the list, so it is required to rely on the side data size to stop. This
1354 * side data includes updated metadata which appeared in the stream.
1356 AV_PKT_DATA_METADATA_UPDATE,
1359 * MPEGTS stream ID as uint8_t, this is required to pass the stream ID
1360 * information from the demuxer to the corresponding muxer.
1362 AV_PKT_DATA_MPEGTS_STREAM_ID,
1365 * Mastering display metadata (based on SMPTE-2086:2014). This metadata
1366 * should be associated with a video stream and contains data in the form
1367 * of the AVMasteringDisplayMetadata struct.
1369 AV_PKT_DATA_MASTERING_DISPLAY_METADATA,
1372 * This side data should be associated with a video stream and corresponds
1373 * to the AVSphericalMapping structure.
1375 AV_PKT_DATA_SPHERICAL,
1378 * Content light level (based on CTA-861.3). This metadata should be
1379 * associated with a video stream and contains data in the form of the
1380 * AVContentLightMetadata struct.
1382 AV_PKT_DATA_CONTENT_LIGHT_LEVEL,
1385 * ATSC A53 Part 4 Closed Captions. This metadata should be associated with
1386 * a video stream. A53 CC bitstream is stored as uint8_t in AVPacketSideData.data.
1387 * The number of bytes of CC data is AVPacketSideData.size.
1392 * This side data is encryption initialization data.
1393 * The format is not part of ABI, use av_encryption_init_info_* methods to
1396 AV_PKT_DATA_ENCRYPTION_INIT_INFO,
1399 * This side data contains encryption info for how to decrypt the packet.
1400 * The format is not part of ABI, use av_encryption_info_* methods to access.
1402 AV_PKT_DATA_ENCRYPTION_INFO,
1405 * Active Format Description data consisting of a single byte as specified
1406 * in ETSI TS 101 154 using AVActiveFormatDescription enum.
1411 * The number of side data types.
1412 * This is not part of the public API/ABI in the sense that it may
1413 * change when new side data types are added.
1414 * This must stay the last enum value.
1415 * If its value becomes huge, some code using it
1416 * needs to be updated as it assumes it to be smaller than other limits.
1421 #define AV_PKT_DATA_QUALITY_FACTOR AV_PKT_DATA_QUALITY_STATS //DEPRECATED
1423 typedef struct AVPacketSideData {
1426 enum AVPacketSideDataType type;
1430 * This structure stores compressed data. It is typically exported by demuxers
1431 * and then passed as input to decoders, or received as output from encoders and
1432 * then passed to muxers.
1434 * For video, it should typically contain one compressed frame. For audio it may
1435 * contain several compressed frames. Encoders are allowed to output empty
1436 * packets, with no compressed data, containing only side data
1437 * (e.g. to update some stream parameters at the end of encoding).
1439 * AVPacket is one of the few structs in FFmpeg, whose size is a part of public
1440 * ABI. Thus it may be allocated on stack and no new fields can be added to it
1441 * without libavcodec and libavformat major bump.
1443 * The semantics of data ownership depends on the buf field.
1444 * If it is set, the packet data is dynamically allocated and is
1445 * valid indefinitely until a call to av_packet_unref() reduces the
1446 * reference count to 0.
1448 * If the buf field is not set av_packet_ref() would make a copy instead
1449 * of increasing the reference count.
1451 * The side data is always allocated with av_malloc(), copied by
1452 * av_packet_ref() and freed by av_packet_unref().
1454 * @see av_packet_ref
1455 * @see av_packet_unref
1457 typedef struct AVPacket {
1459 * A reference to the reference-counted buffer where the packet data is
1461 * May be NULL, then the packet data is not reference-counted.
1465 * Presentation timestamp in AVStream->time_base units; the time at which
1466 * the decompressed packet will be presented to the user.
1467 * Can be AV_NOPTS_VALUE if it is not stored in the file.
1468 * pts MUST be larger or equal to dts as presentation cannot happen before
1469 * decompression, unless one wants to view hex dumps. Some formats misuse
1470 * the terms dts and pts/cts to mean something different. Such timestamps
1471 * must be converted to true pts/dts before they are stored in AVPacket.
1475 * Decompression timestamp in AVStream->time_base units; the time at which
1476 * the packet is decompressed.
1477 * Can be AV_NOPTS_VALUE if it is not stored in the file.
1484 * A combination of AV_PKT_FLAG values
1488 * Additional packet data that can be provided by the container.
1489 * Packet can contain several types of side information.
1491 AVPacketSideData *side_data;
1492 int side_data_elems;
1495 * Duration of this packet in AVStream->time_base units, 0 if unknown.
1496 * Equals next_pts - this_pts in presentation order.
1500 int64_t pos; ///< byte position in stream, -1 if unknown
1502 #if FF_API_CONVERGENCE_DURATION
1504 * @deprecated Same as the duration field, but as int64_t. This was required
1505 * for Matroska subtitles, whose duration values could overflow when the
1506 * duration field was still an int.
1508 attribute_deprecated
1509 int64_t convergence_duration;
1512 #define AV_PKT_FLAG_KEY 0x0001 ///< The packet contains a keyframe
1513 #define AV_PKT_FLAG_CORRUPT 0x0002 ///< The packet content is corrupted
1515 * Flag is used to discard packets which are required to maintain valid
1516 * decoder state but are not required for output and should be dropped
1519 #define AV_PKT_FLAG_DISCARD 0x0004
1521 * The packet comes from a trusted source.
1523 * Otherwise-unsafe constructs such as arbitrary pointers to data
1524 * outside the packet may be followed.
1526 #define AV_PKT_FLAG_TRUSTED 0x0008
1528 * Flag is used to indicate packets that contain frames that can
1529 * be discarded by the decoder. I.e. Non-reference frames.
1531 #define AV_PKT_FLAG_DISPOSABLE 0x0010
1534 enum AVSideDataParamChangeFlags {
1535 AV_SIDE_DATA_PARAM_CHANGE_CHANNEL_COUNT = 0x0001,
1536 AV_SIDE_DATA_PARAM_CHANGE_CHANNEL_LAYOUT = 0x0002,
1537 AV_SIDE_DATA_PARAM_CHANGE_SAMPLE_RATE = 0x0004,
1538 AV_SIDE_DATA_PARAM_CHANGE_DIMENSIONS = 0x0008,
1544 struct AVCodecInternal;
1548 AV_FIELD_PROGRESSIVE,
1549 AV_FIELD_TT, //< Top coded_first, top displayed first
1550 AV_FIELD_BB, //< Bottom coded first, bottom displayed first
1551 AV_FIELD_TB, //< Top coded first, bottom displayed first
1552 AV_FIELD_BT, //< Bottom coded first, top displayed first
1556 * main external API structure.
1557 * New fields can be added to the end with minor version bumps.
1558 * Removal, reordering and changes to existing fields require a major
1560 * You can use AVOptions (av_opt* / av_set/get*()) to access these fields from user
1562 * The name string for AVOptions options matches the associated command line
1563 * parameter name and can be found in libavcodec/options_table.h
1564 * The AVOption/command line parameter names differ in some cases from the C
1565 * structure field names for historic reasons or brevity.
1566 * sizeof(AVCodecContext) must not be used outside libav*.
1568 typedef struct AVCodecContext {
1570 * information on struct for av_log
1571 * - set by avcodec_alloc_context3
1573 const AVClass *av_class;
1574 int log_level_offset;
1576 enum AVMediaType codec_type; /* see AVMEDIA_TYPE_xxx */
1577 const struct AVCodec *codec;
1578 enum AVCodecID codec_id; /* see AV_CODEC_ID_xxx */
1581 * fourcc (LSB first, so "ABCD" -> ('D'<<24) + ('C'<<16) + ('B'<<8) + 'A').
1582 * This is used to work around some encoder bugs.
1583 * A demuxer should set this to what is stored in the field used to identify the codec.
1584 * If there are multiple such fields in a container then the demuxer should choose the one
1585 * which maximizes the information about the used codec.
1586 * If the codec tag field in a container is larger than 32 bits then the demuxer should
1587 * remap the longer ID to 32 bits with a table or other structure. Alternatively a new
1588 * extra_codec_tag + size could be added but for this a clear advantage must be demonstrated
1590 * - encoding: Set by user, if not then the default based on codec_id will be used.
1591 * - decoding: Set by user, will be converted to uppercase by libavcodec during init.
1593 unsigned int codec_tag;
1598 * Private context used for internal data.
1600 * Unlike priv_data, this is not codec-specific. It is used in general
1601 * libavcodec functions.
1603 struct AVCodecInternal *internal;
1606 * Private data of the user, can be used to carry app specific stuff.
1607 * - encoding: Set by user.
1608 * - decoding: Set by user.
1613 * the average bitrate
1614 * - encoding: Set by user; unused for constant quantizer encoding.
1615 * - decoding: Set by user, may be overwritten by libavcodec
1616 * if this info is available in the stream
1621 * number of bits the bitstream is allowed to diverge from the reference.
1622 * the reference can be CBR (for CBR pass1) or VBR (for pass2)
1623 * - encoding: Set by user; unused for constant quantizer encoding.
1624 * - decoding: unused
1626 int bit_rate_tolerance;
1629 * Global quality for codecs which cannot change it per frame.
1630 * This should be proportional to MPEG-1/2/4 qscale.
1631 * - encoding: Set by user.
1632 * - decoding: unused
1637 * - encoding: Set by user.
1638 * - decoding: unused
1640 int compression_level;
1641 #define FF_COMPRESSION_DEFAULT -1
1645 * - encoding: Set by user.
1646 * - decoding: Set by user.
1652 * - encoding: Set by user.
1653 * - decoding: Set by user.
1658 * some codecs need / can use extradata like Huffman tables.
1659 * MJPEG: Huffman tables
1660 * rv10: additional flags
1661 * MPEG-4: global headers (they can be in the bitstream or here)
1662 * The allocated memory should be AV_INPUT_BUFFER_PADDING_SIZE bytes larger
1663 * than extradata_size to avoid problems if it is read with the bitstream reader.
1664 * The bytewise contents of extradata must not depend on the architecture or CPU endianness.
1665 * Must be allocated with the av_malloc() family of functions.
1666 * - encoding: Set/allocated/freed by libavcodec.
1667 * - decoding: Set/allocated/freed by user.
1673 * This is the fundamental unit of time (in seconds) in terms
1674 * of which frame timestamps are represented. For fixed-fps content,
1675 * timebase should be 1/framerate and timestamp increments should be
1677 * This often, but not always is the inverse of the frame rate or field rate
1678 * for video. 1/time_base is not the average frame rate if the frame rate is not
1681 * Like containers, elementary streams also can store timestamps, 1/time_base
1682 * is the unit in which these timestamps are specified.
1683 * As example of such codec time base see ISO/IEC 14496-2:2001(E)
1684 * vop_time_increment_resolution and fixed_vop_rate
1685 * (fixed_vop_rate == 0 implies that it is different from the framerate)
1687 * - encoding: MUST be set by user.
1688 * - decoding: the use of this field for decoding is deprecated.
1689 * Use framerate instead.
1691 AVRational time_base;
1694 * For some codecs, the time base is closer to the field rate than the frame rate.
1695 * Most notably, H.264 and MPEG-2 specify time_base as half of frame duration
1696 * if no telecine is used ...
1698 * Set to time_base ticks per frame. Default 1, e.g., H.264/MPEG-2 set it to 2.
1700 int ticks_per_frame;
1705 * Encoding: Number of frames delay there will be from the encoder input to
1706 * the decoder output. (we assume the decoder matches the spec)
1707 * Decoding: Number of frames delay in addition to what a standard decoder
1708 * as specified in the spec would produce.
1711 * Number of frames the decoded output will be delayed relative to the
1715 * For encoding, this field is unused (see initial_padding).
1717 * For decoding, this is the number of samples the decoder needs to
1718 * output before the decoder's output is valid. When seeking, you should
1719 * start decoding this many samples prior to your desired seek point.
1721 * - encoding: Set by libavcodec.
1722 * - decoding: Set by libavcodec.
1729 * picture width / height.
1731 * @note Those fields may not match the values of the last
1732 * AVFrame output by avcodec_decode_video2 due frame
1735 * - encoding: MUST be set by user.
1736 * - decoding: May be set by the user before opening the decoder if known e.g.
1737 * from the container. Some decoders will require the dimensions
1738 * to be set by the caller. During decoding, the decoder may
1739 * overwrite those values as required while parsing the data.
1744 * Bitstream width / height, may be different from width/height e.g. when
1745 * the decoded frame is cropped before being output or lowres is enabled.
1747 * @note Those field may not match the value of the last
1748 * AVFrame output by avcodec_receive_frame() due frame
1751 * - encoding: unused
1752 * - decoding: May be set by the user before opening the decoder if known
1753 * e.g. from the container. During decoding, the decoder may
1754 * overwrite those values as required while parsing the data.
1756 int coded_width, coded_height;
1759 * the number of pictures in a group of pictures, or 0 for intra_only
1760 * - encoding: Set by user.
1761 * - decoding: unused
1766 * Pixel format, see AV_PIX_FMT_xxx.
1767 * May be set by the demuxer if known from headers.
1768 * May be overridden by the decoder if it knows better.
1770 * @note This field may not match the value of the last
1771 * AVFrame output by avcodec_receive_frame() due frame
1774 * - encoding: Set by user.
1775 * - decoding: Set by user if known, overridden by libavcodec while
1778 enum AVPixelFormat pix_fmt;
1781 * If non NULL, 'draw_horiz_band' is called by the libavcodec
1782 * decoder to draw a horizontal band. It improves cache usage. Not
1783 * all codecs can do that. You must check the codec capabilities
1785 * When multithreading is used, it may be called from multiple threads
1786 * at the same time; threads might draw different parts of the same AVFrame,
1787 * or multiple AVFrames, and there is no guarantee that slices will be drawn
1789 * The function is also used by hardware acceleration APIs.
1790 * It is called at least once during frame decoding to pass
1791 * the data needed for hardware render.
1792 * In that mode instead of pixel data, AVFrame points to
1793 * a structure specific to the acceleration API. The application
1794 * reads the structure and can change some fields to indicate progress
1796 * - encoding: unused
1797 * - decoding: Set by user.
1798 * @param height the height of the slice
1799 * @param y the y position of the slice
1800 * @param type 1->top field, 2->bottom field, 3->frame
1801 * @param offset offset into the AVFrame.data from which the slice should be read
1803 void (*draw_horiz_band)(struct AVCodecContext *s,
1804 const AVFrame *src, int offset[AV_NUM_DATA_POINTERS],
1805 int y, int type, int height);
1808 * callback to negotiate the pixelFormat
1809 * @param fmt is the list of formats which are supported by the codec,
1810 * it is terminated by -1 as 0 is a valid format, the formats are ordered by quality.
1811 * The first is always the native one.
1812 * @note The callback may be called again immediately if initialization for
1813 * the selected (hardware-accelerated) pixel format failed.
1814 * @warning Behavior is undefined if the callback returns a value not
1815 * in the fmt list of formats.
1816 * @return the chosen format
1817 * - encoding: unused
1818 * - decoding: Set by user, if not set the native format will be chosen.
1820 enum AVPixelFormat (*get_format)(struct AVCodecContext *s, const enum AVPixelFormat * fmt);
1823 * maximum number of B-frames between non-B-frames
1824 * Note: The output will be delayed by max_b_frames+1 relative to the input.
1825 * - encoding: Set by user.
1826 * - decoding: unused
1831 * qscale factor between IP and B-frames
1832 * If > 0 then the last P-frame quantizer will be used (q= lastp_q*factor+offset).
1833 * If < 0 then normal ratecontrol will be done (q= -normal_q*factor+offset).
1834 * - encoding: Set by user.
1835 * - decoding: unused
1837 float b_quant_factor;
1839 #if FF_API_PRIVATE_OPT
1840 /** @deprecated use encoder private options instead */
1841 attribute_deprecated
1842 int b_frame_strategy;
1846 * qscale offset between IP and B-frames
1847 * - encoding: Set by user.
1848 * - decoding: unused
1850 float b_quant_offset;
1853 * Size of the frame reordering buffer in the decoder.
1854 * For MPEG-2 it is 1 IPB or 0 low delay IP.
1855 * - encoding: Set by libavcodec.
1856 * - decoding: Set by libavcodec.
1860 #if FF_API_PRIVATE_OPT
1861 /** @deprecated use encoder private options instead */
1862 attribute_deprecated
1867 * qscale factor between P- and I-frames
1868 * If > 0 then the last P-frame quantizer will be used (q = lastp_q * factor + offset).
1869 * If < 0 then normal ratecontrol will be done (q= -normal_q*factor+offset).
1870 * - encoding: Set by user.
1871 * - decoding: unused
1873 float i_quant_factor;
1876 * qscale offset between P and I-frames
1877 * - encoding: Set by user.
1878 * - decoding: unused
1880 float i_quant_offset;
1883 * luminance masking (0-> disabled)
1884 * - encoding: Set by user.
1885 * - decoding: unused
1890 * temporary complexity masking (0-> disabled)
1891 * - encoding: Set by user.
1892 * - decoding: unused
1894 float temporal_cplx_masking;
1897 * spatial complexity masking (0-> disabled)
1898 * - encoding: Set by user.
1899 * - decoding: unused
1901 float spatial_cplx_masking;
1904 * p block masking (0-> disabled)
1905 * - encoding: Set by user.
1906 * - decoding: unused
1911 * darkness masking (0-> disabled)
1912 * - encoding: Set by user.
1913 * - decoding: unused
1919 * - encoding: Set by libavcodec.
1920 * - decoding: Set by user (or 0).
1924 #if FF_API_PRIVATE_OPT
1925 /** @deprecated use encoder private options instead */
1926 attribute_deprecated
1927 int prediction_method;
1928 #define FF_PRED_LEFT 0
1929 #define FF_PRED_PLANE 1
1930 #define FF_PRED_MEDIAN 2
1934 * slice offsets in the frame in bytes
1935 * - encoding: Set/allocated by libavcodec.
1936 * - decoding: Set/allocated by user (or NULL).
1941 * sample aspect ratio (0 if unknown)
1942 * That is the width of a pixel divided by the height of the pixel.
1943 * Numerator and denominator must be relatively prime and smaller than 256 for some video standards.
1944 * - encoding: Set by user.
1945 * - decoding: Set by libavcodec.
1947 AVRational sample_aspect_ratio;
1950 * motion estimation comparison function
1951 * - encoding: Set by user.
1952 * - decoding: unused
1956 * subpixel motion estimation comparison function
1957 * - encoding: Set by user.
1958 * - decoding: unused
1962 * macroblock comparison function (not supported yet)
1963 * - encoding: Set by user.
1964 * - decoding: unused
1968 * interlaced DCT comparison function
1969 * - encoding: Set by user.
1970 * - decoding: unused
1973 #define FF_CMP_SAD 0
1974 #define FF_CMP_SSE 1
1975 #define FF_CMP_SATD 2
1976 #define FF_CMP_DCT 3
1977 #define FF_CMP_PSNR 4
1978 #define FF_CMP_BIT 5
1980 #define FF_CMP_ZERO 7
1981 #define FF_CMP_VSAD 8
1982 #define FF_CMP_VSSE 9
1983 #define FF_CMP_NSSE 10
1984 #define FF_CMP_W53 11
1985 #define FF_CMP_W97 12
1986 #define FF_CMP_DCTMAX 13
1987 #define FF_CMP_DCT264 14
1988 #define FF_CMP_MEDIAN_SAD 15
1989 #define FF_CMP_CHROMA 256
1992 * ME diamond size & shape
1993 * - encoding: Set by user.
1994 * - decoding: unused
1999 * amount of previous MV predictors (2a+1 x 2a+1 square)
2000 * - encoding: Set by user.
2001 * - decoding: unused
2003 int last_predictor_count;
2005 #if FF_API_PRIVATE_OPT
2006 /** @deprecated use encoder private options instead */
2007 attribute_deprecated
2012 * motion estimation prepass comparison function
2013 * - encoding: Set by user.
2014 * - decoding: unused
2019 * ME prepass diamond size & shape
2020 * - encoding: Set by user.
2021 * - decoding: unused
2027 * - encoding: Set by user.
2028 * - decoding: unused
2030 int me_subpel_quality;
2033 * maximum motion estimation search range in subpel units
2034 * If 0 then no limit.
2036 * - encoding: Set by user.
2037 * - decoding: unused
2043 * - encoding: unused
2044 * - decoding: Set by user.
2047 #define SLICE_FLAG_CODED_ORDER 0x0001 ///< draw_horiz_band() is called in coded order instead of display
2048 #define SLICE_FLAG_ALLOW_FIELD 0x0002 ///< allow draw_horiz_band() with field slices (MPEG-2 field pics)
2049 #define SLICE_FLAG_ALLOW_PLANE 0x0004 ///< allow draw_horiz_band() with 1 component at a time (SVQ1)
2052 * macroblock decision mode
2053 * - encoding: Set by user.
2054 * - decoding: unused
2057 #define FF_MB_DECISION_SIMPLE 0 ///< uses mb_cmp
2058 #define FF_MB_DECISION_BITS 1 ///< chooses the one which needs the fewest bits
2059 #define FF_MB_DECISION_RD 2 ///< rate distortion
2062 * custom intra quantization matrix
2063 * Must be allocated with the av_malloc() family of functions, and will be freed in
2064 * avcodec_free_context().
2065 * - encoding: Set/allocated by user, freed by libavcodec. Can be NULL.
2066 * - decoding: Set/allocated/freed by libavcodec.
2068 uint16_t *intra_matrix;
2071 * custom inter quantization matrix
2072 * Must be allocated with the av_malloc() family of functions, and will be freed in
2073 * avcodec_free_context().
2074 * - encoding: Set/allocated by user, freed by libavcodec. Can be NULL.
2075 * - decoding: Set/allocated/freed by libavcodec.
2077 uint16_t *inter_matrix;
2079 #if FF_API_PRIVATE_OPT
2080 /** @deprecated use encoder private options instead */
2081 attribute_deprecated
2082 int scenechange_threshold;
2084 /** @deprecated use encoder private options instead */
2085 attribute_deprecated
2086 int noise_reduction;
2090 * precision of the intra DC coefficient - 8
2091 * - encoding: Set by user.
2092 * - decoding: Set by libavcodec
2094 int intra_dc_precision;
2097 * Number of macroblock rows at the top which are skipped.
2098 * - encoding: unused
2099 * - decoding: Set by user.
2104 * Number of macroblock rows at the bottom which are skipped.
2105 * - encoding: unused
2106 * - decoding: Set by user.
2111 * minimum MB Lagrange multiplier
2112 * - encoding: Set by user.
2113 * - decoding: unused
2118 * maximum MB Lagrange multiplier
2119 * - encoding: Set by user.
2120 * - decoding: unused
2124 #if FF_API_PRIVATE_OPT
2126 * @deprecated use encoder private options instead
2128 attribute_deprecated
2129 int me_penalty_compensation;
2133 * - encoding: Set by user.
2134 * - decoding: unused
2138 #if FF_API_PRIVATE_OPT
2139 /** @deprecated use encoder private options instead */
2140 attribute_deprecated
2146 * - encoding: Set by user.
2147 * - decoding: unused
2152 * number of reference frames
2153 * - encoding: Set by user.
2154 * - decoding: Set by lavc.
2158 #if FF_API_PRIVATE_OPT
2159 /** @deprecated use encoder private options instead */
2160 attribute_deprecated
2165 * Note: Value depends upon the compare function used for fullpel ME.
2166 * - encoding: Set by user.
2167 * - decoding: unused
2171 #if FF_API_PRIVATE_OPT
2172 /** @deprecated use encoder private options instead */
2173 attribute_deprecated
2178 * Chromaticity coordinates of the source primaries.
2179 * - encoding: Set by user
2180 * - decoding: Set by libavcodec
2182 enum AVColorPrimaries color_primaries;
2185 * Color Transfer Characteristic.
2186 * - encoding: Set by user
2187 * - decoding: Set by libavcodec
2189 enum AVColorTransferCharacteristic color_trc;
2192 * YUV colorspace type.
2193 * - encoding: Set by user
2194 * - decoding: Set by libavcodec
2196 enum AVColorSpace colorspace;
2199 * MPEG vs JPEG YUV range.
2200 * - encoding: Set by user
2201 * - decoding: Set by libavcodec
2203 enum AVColorRange color_range;
2206 * This defines the location of chroma samples.
2207 * - encoding: Set by user
2208 * - decoding: Set by libavcodec
2210 enum AVChromaLocation chroma_sample_location;
2214 * Indicates number of picture subdivisions. Used for parallelized
2216 * - encoding: Set by user
2217 * - decoding: unused
2222 * - encoding: set by libavcodec
2223 * - decoding: Set by user.
2225 enum AVFieldOrder field_order;
2228 int sample_rate; ///< samples per second
2229 int channels; ///< number of audio channels
2232 * audio sample format
2233 * - encoding: Set by user.
2234 * - decoding: Set by libavcodec.
2236 enum AVSampleFormat sample_fmt; ///< sample format
2238 /* The following data should not be initialized. */
2240 * Number of samples per channel in an audio frame.
2242 * - encoding: set by libavcodec in avcodec_open2(). Each submitted frame
2243 * except the last must contain exactly frame_size samples per channel.
2244 * May be 0 when the codec has AV_CODEC_CAP_VARIABLE_FRAME_SIZE set, then the
2245 * frame size is not restricted.
2246 * - decoding: may be set by some decoders to indicate constant frame size
2251 * Frame counter, set by libavcodec.
2253 * - decoding: total number of frames returned from the decoder so far.
2254 * - encoding: total number of frames passed to the encoder so far.
2256 * @note the counter is not incremented if encoding/decoding resulted in
2262 * number of bytes per packet if constant and known or 0
2263 * Used by some WAV based audio codecs.
2268 * Audio cutoff bandwidth (0 means "automatic")
2269 * - encoding: Set by user.
2270 * - decoding: unused
2275 * Audio channel layout.
2276 * - encoding: set by user.
2277 * - decoding: set by user, may be overwritten by libavcodec.
2279 uint64_t channel_layout;
2282 * Request decoder to use this channel layout if it can (0 for default)
2283 * - encoding: unused
2284 * - decoding: Set by user.
2286 uint64_t request_channel_layout;
2289 * Type of service that the audio stream conveys.
2290 * - encoding: Set by user.
2291 * - decoding: Set by libavcodec.
2293 enum AVAudioServiceType audio_service_type;
2296 * desired sample format
2297 * - encoding: Not used.
2298 * - decoding: Set by user.
2299 * Decoder will decode to this format if it can.
2301 enum AVSampleFormat request_sample_fmt;
2304 * This callback is called at the beginning of each frame to get data
2305 * buffer(s) for it. There may be one contiguous buffer for all the data or
2306 * there may be a buffer per each data plane or anything in between. What
2307 * this means is, you may set however many entries in buf[] you feel necessary.
2308 * Each buffer must be reference-counted using the AVBuffer API (see description
2311 * The following fields will be set in the frame before this callback is
2314 * - width, height (video only)
2315 * - sample_rate, channel_layout, nb_samples (audio only)
2316 * Their values may differ from the corresponding values in
2317 * AVCodecContext. This callback must use the frame values, not the codec
2318 * context values, to calculate the required buffer size.
2320 * This callback must fill the following fields in the frame:
2324 * * if the data is planar audio with more than 8 channels, then this
2325 * callback must allocate and fill extended_data to contain all pointers
2326 * to all data planes. data[] must hold as many pointers as it can.
2327 * extended_data must be allocated with av_malloc() and will be freed in
2329 * * otherwise extended_data must point to data
2330 * - buf[] must contain one or more pointers to AVBufferRef structures. Each of
2331 * the frame's data and extended_data pointers must be contained in these. That
2332 * is, one AVBufferRef for each allocated chunk of memory, not necessarily one
2333 * AVBufferRef per data[] entry. See: av_buffer_create(), av_buffer_alloc(),
2334 * and av_buffer_ref().
2335 * - extended_buf and nb_extended_buf must be allocated with av_malloc() by
2336 * this callback and filled with the extra buffers if there are more
2337 * buffers than buf[] can hold. extended_buf will be freed in
2340 * If AV_CODEC_CAP_DR1 is not set then get_buffer2() must call
2341 * avcodec_default_get_buffer2() instead of providing buffers allocated by
2344 * Each data plane must be aligned to the maximum required by the target
2347 * @see avcodec_default_get_buffer2()
2351 * If AV_GET_BUFFER_FLAG_REF is set in flags then the frame may be reused
2352 * (read and/or written to if it is writable) later by libavcodec.
2354 * avcodec_align_dimensions2() should be used to find the required width and
2355 * height, as they normally need to be rounded up to the next multiple of 16.
2357 * Some decoders do not support linesizes changing between frames.
2359 * If frame multithreading is used and thread_safe_callbacks is set,
2360 * this callback may be called from a different thread, but not from more
2361 * than one at once. Does not need to be reentrant.
2363 * @see avcodec_align_dimensions2()
2367 * Decoders request a buffer of a particular size by setting
2368 * AVFrame.nb_samples prior to calling get_buffer2(). The decoder may,
2369 * however, utilize only part of the buffer by setting AVFrame.nb_samples
2370 * to a smaller value in the output frame.
2372 * As a convenience, av_samples_get_buffer_size() and
2373 * av_samples_fill_arrays() in libavutil may be used by custom get_buffer2()
2374 * functions to find the required data size and to fill data pointers and
2375 * linesize. In AVFrame.linesize, only linesize[0] may be set for audio
2376 * since all planes must be the same size.
2378 * @see av_samples_get_buffer_size(), av_samples_fill_arrays()
2380 * - encoding: unused
2381 * - decoding: Set by libavcodec, user can override.
2383 int (*get_buffer2)(struct AVCodecContext *s, AVFrame *frame, int flags);
2386 * If non-zero, the decoded audio and video frames returned from
2387 * avcodec_decode_video2() and avcodec_decode_audio4() are reference-counted
2388 * and are valid indefinitely. The caller must free them with
2389 * av_frame_unref() when they are not needed anymore.
2390 * Otherwise, the decoded frames must not be freed by the caller and are
2391 * only valid until the next decode call.
2393 * This is always automatically enabled if avcodec_receive_frame() is used.
2395 * - encoding: unused
2396 * - decoding: set by the caller before avcodec_open2().
2398 attribute_deprecated
2399 int refcounted_frames;
2401 /* - encoding parameters */
2402 float qcompress; ///< amount of qscale change between easy & hard scenes (0.0-1.0)
2403 float qblur; ///< amount of qscale smoothing over time (0.0-1.0)
2407 * - encoding: Set by user.
2408 * - decoding: unused
2414 * - encoding: Set by user.
2415 * - decoding: unused
2420 * maximum quantizer difference between frames
2421 * - encoding: Set by user.
2422 * - decoding: unused
2427 * decoder bitstream buffer size
2428 * - encoding: Set by user.
2429 * - decoding: unused
2434 * ratecontrol override, see RcOverride
2435 * - encoding: Allocated/set/freed by user.
2436 * - decoding: unused
2438 int rc_override_count;
2439 RcOverride *rc_override;
2443 * - encoding: Set by user.
2444 * - decoding: Set by user, may be overwritten by libavcodec.
2446 int64_t rc_max_rate;
2450 * - encoding: Set by user.
2451 * - decoding: unused
2453 int64_t rc_min_rate;
2456 * Ratecontrol attempt to use, at maximum, <value> of what can be used without an underflow.
2457 * - encoding: Set by user.
2458 * - decoding: unused.
2460 float rc_max_available_vbv_use;
2463 * Ratecontrol attempt to use, at least, <value> times the amount needed to prevent a vbv overflow.
2464 * - encoding: Set by user.
2465 * - decoding: unused.
2467 float rc_min_vbv_overflow_use;
2470 * Number of bits which should be loaded into the rc buffer before decoding starts.
2471 * - encoding: Set by user.
2472 * - decoding: unused
2474 int rc_initial_buffer_occupancy;
2476 #if FF_API_CODER_TYPE
2477 #define FF_CODER_TYPE_VLC 0
2478 #define FF_CODER_TYPE_AC 1
2479 #define FF_CODER_TYPE_RAW 2
2480 #define FF_CODER_TYPE_RLE 3
2482 * @deprecated use encoder private options instead
2484 attribute_deprecated
2486 #endif /* FF_API_CODER_TYPE */
2488 #if FF_API_PRIVATE_OPT
2489 /** @deprecated use encoder private options instead */
2490 attribute_deprecated
2494 #if FF_API_PRIVATE_OPT
2495 /** @deprecated use encoder private options instead */
2496 attribute_deprecated
2497 int frame_skip_threshold;
2499 /** @deprecated use encoder private options instead */
2500 attribute_deprecated
2501 int frame_skip_factor;
2503 /** @deprecated use encoder private options instead */
2504 attribute_deprecated
2507 /** @deprecated use encoder private options instead */
2508 attribute_deprecated
2510 #endif /* FF_API_PRIVATE_OPT */
2513 * trellis RD quantization
2514 * - encoding: Set by user.
2515 * - decoding: unused
2519 #if FF_API_PRIVATE_OPT
2520 /** @deprecated use encoder private options instead */
2521 attribute_deprecated
2522 int min_prediction_order;
2524 /** @deprecated use encoder private options instead */
2525 attribute_deprecated
2526 int max_prediction_order;
2528 /** @deprecated use encoder private options instead */
2529 attribute_deprecated
2530 int64_t timecode_frame_start;
2533 #if FF_API_RTP_CALLBACK
2535 * @deprecated unused
2537 /* The RTP callback: This function is called */
2538 /* every time the encoder has a packet to send. */
2539 /* It depends on the encoder if the data starts */
2540 /* with a Start Code (it should). H.263 does. */
2541 /* mb_nb contains the number of macroblocks */
2542 /* encoded in the RTP payload. */
2543 attribute_deprecated
2544 void (*rtp_callback)(struct AVCodecContext *avctx, void *data, int size, int mb_nb);
2547 #if FF_API_PRIVATE_OPT
2548 /** @deprecated use encoder private options instead */
2549 attribute_deprecated
2550 int rtp_payload_size; /* The size of the RTP payload: the coder will */
2551 /* do its best to deliver a chunk with size */
2552 /* below rtp_payload_size, the chunk will start */
2553 /* with a start code on some codecs like H.263. */
2554 /* This doesn't take account of any particular */
2555 /* headers inside the transmitted RTP payload. */
2558 #if FF_API_STAT_BITS
2559 /* statistics, used for 2-pass encoding */
2560 attribute_deprecated
2562 attribute_deprecated
2564 attribute_deprecated
2566 attribute_deprecated
2568 attribute_deprecated
2570 attribute_deprecated
2572 attribute_deprecated
2574 attribute_deprecated
2577 /** @deprecated this field is unused */
2578 attribute_deprecated
2583 * pass1 encoding statistics output buffer
2584 * - encoding: Set by libavcodec.
2585 * - decoding: unused
2590 * pass2 encoding statistics input buffer
2591 * Concatenated stuff from stats_out of pass1 should be placed here.
2592 * - encoding: Allocated/set/freed by user.
2593 * - decoding: unused
2598 * Work around bugs in encoders which sometimes cannot be detected automatically.
2599 * - encoding: Set by user
2600 * - decoding: Set by user
2602 int workaround_bugs;
2603 #define FF_BUG_AUTODETECT 1 ///< autodetection
2604 #define FF_BUG_XVID_ILACE 4
2605 #define FF_BUG_UMP4 8
2606 #define FF_BUG_NO_PADDING 16
2607 #define FF_BUG_AMV 32
2608 #define FF_BUG_QPEL_CHROMA 64
2609 #define FF_BUG_STD_QPEL 128
2610 #define FF_BUG_QPEL_CHROMA2 256
2611 #define FF_BUG_DIRECT_BLOCKSIZE 512
2612 #define FF_BUG_EDGE 1024
2613 #define FF_BUG_HPEL_CHROMA 2048
2614 #define FF_BUG_DC_CLIP 4096
2615 #define FF_BUG_MS 8192 ///< Work around various bugs in Microsoft's broken decoders.
2616 #define FF_BUG_TRUNCATED 16384
2617 #define FF_BUG_IEDGE 32768
2620 * strictly follow the standard (MPEG-4, ...).
2621 * - encoding: Set by user.
2622 * - decoding: Set by user.
2623 * Setting this to STRICT or higher means the encoder and decoder will
2624 * generally do stupid things, whereas setting it to unofficial or lower
2625 * will mean the encoder might produce output that is not supported by all
2626 * spec-compliant decoders. Decoders don't differentiate between normal,
2627 * unofficial and experimental (that is, they always try to decode things
2628 * when they can) unless they are explicitly asked to behave stupidly
2629 * (=strictly conform to the specs)
2631 int strict_std_compliance;
2632 #define FF_COMPLIANCE_VERY_STRICT 2 ///< Strictly conform to an older more strict version of the spec or reference software.
2633 #define FF_COMPLIANCE_STRICT 1 ///< Strictly conform to all the things in the spec no matter what consequences.
2634 #define FF_COMPLIANCE_NORMAL 0
2635 #define FF_COMPLIANCE_UNOFFICIAL -1 ///< Allow unofficial extensions
2636 #define FF_COMPLIANCE_EXPERIMENTAL -2 ///< Allow nonstandardized experimental things.
2639 * error concealment flags
2640 * - encoding: unused
2641 * - decoding: Set by user.
2643 int error_concealment;
2644 #define FF_EC_GUESS_MVS 1
2645 #define FF_EC_DEBLOCK 2
2646 #define FF_EC_FAVOR_INTER 256
2650 * - encoding: Set by user.
2651 * - decoding: Set by user.
2654 #define FF_DEBUG_PICT_INFO 1
2655 #define FF_DEBUG_RC 2
2656 #define FF_DEBUG_BITSTREAM 4
2657 #define FF_DEBUG_MB_TYPE 8
2658 #define FF_DEBUG_QP 16
2661 * @deprecated this option does nothing
2663 #define FF_DEBUG_MV 32
2665 #define FF_DEBUG_DCT_COEFF 0x00000040
2666 #define FF_DEBUG_SKIP 0x00000080
2667 #define FF_DEBUG_STARTCODE 0x00000100
2668 #define FF_DEBUG_ER 0x00000400
2669 #define FF_DEBUG_MMCO 0x00000800
2670 #define FF_DEBUG_BUGS 0x00001000
2672 #define FF_DEBUG_VIS_QP 0x00002000
2673 #define FF_DEBUG_VIS_MB_TYPE 0x00004000
2675 #define FF_DEBUG_BUFFERS 0x00008000
2676 #define FF_DEBUG_THREADS 0x00010000
2677 #define FF_DEBUG_GREEN_MD 0x00800000
2678 #define FF_DEBUG_NOMC 0x01000000
2683 * - encoding: Set by user.
2684 * - decoding: Set by user.
2687 #define FF_DEBUG_VIS_MV_P_FOR 0x00000001 // visualize forward predicted MVs of P-frames
2688 #define FF_DEBUG_VIS_MV_B_FOR 0x00000002 // visualize forward predicted MVs of B-frames
2689 #define FF_DEBUG_VIS_MV_B_BACK 0x00000004 // visualize backward predicted MVs of B-frames
2693 * Error recognition; may misdetect some more or less valid parts as errors.
2694 * - encoding: unused
2695 * - decoding: Set by user.
2697 int err_recognition;
2700 * Verify checksums embedded in the bitstream (could be of either encoded or
2701 * decoded data, depending on the codec) and print an error message on mismatch.
2702 * If AV_EF_EXPLODE is also set, a mismatching checksum will result in the
2703 * decoder returning an error.
2705 #define AV_EF_CRCCHECK (1<<0)
2706 #define AV_EF_BITSTREAM (1<<1) ///< detect bitstream specification deviations
2707 #define AV_EF_BUFFER (1<<2) ///< detect improper bitstream length
2708 #define AV_EF_EXPLODE (1<<3) ///< abort decoding on minor error detection
2710 #define AV_EF_IGNORE_ERR (1<<15) ///< ignore errors and continue
2711 #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
2712 #define AV_EF_COMPLIANT (1<<17) ///< consider all spec non compliances as errors
2713 #define AV_EF_AGGRESSIVE (1<<18) ///< consider things that a sane encoder should not do as an error
2717 * opaque 64-bit number (generally a PTS) that will be reordered and
2718 * output in AVFrame.reordered_opaque
2719 * - encoding: Set by libavcodec to the reordered_opaque of the input
2720 * frame corresponding to the last returned packet. Only
2721 * supported by encoders with the
2722 * AV_CODEC_CAP_ENCODER_REORDERED_OPAQUE capability.
2723 * - decoding: Set by user.
2725 int64_t reordered_opaque;
2728 * Hardware accelerator in use
2729 * - encoding: unused.
2730 * - decoding: Set by libavcodec
2732 const struct AVHWAccel *hwaccel;
2735 * Hardware accelerator context.
2736 * For some hardware accelerators, a global context needs to be
2737 * provided by the user. In that case, this holds display-dependent
2738 * data FFmpeg cannot instantiate itself. Please refer to the
2739 * FFmpeg HW accelerator documentation to know how to fill this
2740 * is. e.g. for VA API, this is a struct vaapi_context.
2741 * - encoding: unused
2742 * - decoding: Set by user
2744 void *hwaccel_context;
2748 * - encoding: Set by libavcodec if flags & AV_CODEC_FLAG_PSNR.
2749 * - decoding: unused
2751 uint64_t error[AV_NUM_DATA_POINTERS];
2754 * DCT algorithm, see FF_DCT_* below
2755 * - encoding: Set by user.
2756 * - decoding: unused
2759 #define FF_DCT_AUTO 0
2760 #define FF_DCT_FASTINT 1
2761 #define FF_DCT_INT 2
2762 #define FF_DCT_MMX 3
2763 #define FF_DCT_ALTIVEC 5
2764 #define FF_DCT_FAAN 6
2767 * IDCT algorithm, see FF_IDCT_* below.
2768 * - encoding: Set by user.
2769 * - decoding: Set by user.
2772 #define FF_IDCT_AUTO 0
2773 #define FF_IDCT_INT 1
2774 #define FF_IDCT_SIMPLE 2
2775 #define FF_IDCT_SIMPLEMMX 3
2776 #define FF_IDCT_ARM 7
2777 #define FF_IDCT_ALTIVEC 8
2778 #define FF_IDCT_SIMPLEARM 10
2779 #define FF_IDCT_XVID 14
2780 #define FF_IDCT_SIMPLEARMV5TE 16
2781 #define FF_IDCT_SIMPLEARMV6 17
2782 #define FF_IDCT_FAAN 20
2783 #define FF_IDCT_SIMPLENEON 22
2784 #define FF_IDCT_NONE 24 /* Used by XvMC to extract IDCT coefficients with FF_IDCT_PERM_NONE */
2785 #define FF_IDCT_SIMPLEAUTO 128
2788 * bits per sample/pixel from the demuxer (needed for huffyuv).
2789 * - encoding: Set by libavcodec.
2790 * - decoding: Set by user.
2792 int bits_per_coded_sample;
2795 * Bits per sample/pixel of internal libavcodec pixel/sample format.
2796 * - encoding: set by user.
2797 * - decoding: set by libavcodec.
2799 int bits_per_raw_sample;
2803 * low resolution decoding, 1-> 1/2 size, 2->1/4 size
2804 * - encoding: unused
2805 * - decoding: Set by user.
2810 #if FF_API_CODED_FRAME
2812 * the picture in the bitstream
2813 * - encoding: Set by libavcodec.
2814 * - decoding: unused
2816 * @deprecated use the quality factor packet side data instead
2818 attribute_deprecated AVFrame *coded_frame;
2823 * is used to decide how many independent tasks should be passed to execute()
2824 * - encoding: Set by user.
2825 * - decoding: Set by user.
2830 * Which multithreading methods to use.
2831 * Use of FF_THREAD_FRAME will increase decoding delay by one frame per thread,
2832 * so clients which cannot provide future frames should not use it.
2834 * - encoding: Set by user, otherwise the default is used.
2835 * - decoding: Set by user, otherwise the default is used.
2838 #define FF_THREAD_FRAME 1 ///< Decode more than one frame at once
2839 #define FF_THREAD_SLICE 2 ///< Decode more than one part of a single frame at once
2842 * Which multithreading methods are in use by the codec.
2843 * - encoding: Set by libavcodec.
2844 * - decoding: Set by libavcodec.
2846 int active_thread_type;
2849 * Set by the client if its custom get_buffer() callback can be called
2850 * synchronously from another thread, which allows faster multithreaded decoding.
2851 * draw_horiz_band() will be called from other threads regardless of this setting.
2852 * Ignored if the default get_buffer() is used.
2853 * - encoding: Set by user.
2854 * - decoding: Set by user.
2856 int thread_safe_callbacks;
2859 * The codec may call this to execute several independent things.
2860 * It will return only after finishing all tasks.
2861 * The user may replace this with some multithreaded implementation,
2862 * the default implementation will execute the parts serially.
2863 * @param count the number of things to execute
2864 * - encoding: Set by libavcodec, user can override.
2865 * - decoding: Set by libavcodec, user can override.
2867 int (*execute)(struct AVCodecContext *c, int (*func)(struct AVCodecContext *c2, void *arg), void *arg2, int *ret, int count, int size);
2870 * The codec may call this to execute several independent things.
2871 * It will return only after finishing all tasks.
2872 * The user may replace this with some multithreaded implementation,
2873 * the default implementation will execute the parts serially.
2874 * Also see avcodec_thread_init and e.g. the --enable-pthread configure option.
2875 * @param c context passed also to func
2876 * @param count the number of things to execute
2877 * @param arg2 argument passed unchanged to func
2878 * @param ret return values of executed functions, must have space for "count" values. May be NULL.
2879 * @param func function that will be called count times, with jobnr from 0 to count-1.
2880 * threadnr will be in the range 0 to c->thread_count-1 < MAX_THREADS and so that no
2881 * two instances of func executing at the same time will have the same threadnr.
2882 * @return always 0 currently, but code should handle a future improvement where when any call to func
2883 * returns < 0 no further calls to func may be done and < 0 is returned.
2884 * - encoding: Set by libavcodec, user can override.
2885 * - decoding: Set by libavcodec, user can override.
2887 int (*execute2)(struct AVCodecContext *c, int (*func)(struct AVCodecContext *c2, void *arg, int jobnr, int threadnr), void *arg2, int *ret, int count);
2890 * noise vs. sse weight for the nsse comparison function
2891 * - encoding: Set by user.
2892 * - decoding: unused
2898 * - encoding: Set by user.
2899 * - decoding: Set by libavcodec.
2902 #define FF_PROFILE_UNKNOWN -99
2903 #define FF_PROFILE_RESERVED -100
2905 #define FF_PROFILE_AAC_MAIN 0
2906 #define FF_PROFILE_AAC_LOW 1
2907 #define FF_PROFILE_AAC_SSR 2
2908 #define FF_PROFILE_AAC_LTP 3
2909 #define FF_PROFILE_AAC_HE 4
2910 #define FF_PROFILE_AAC_HE_V2 28
2911 #define FF_PROFILE_AAC_LD 22
2912 #define FF_PROFILE_AAC_ELD 38
2913 #define FF_PROFILE_MPEG2_AAC_LOW 128
2914 #define FF_PROFILE_MPEG2_AAC_HE 131
2916 #define FF_PROFILE_DNXHD 0
2917 #define FF_PROFILE_DNXHR_LB 1
2918 #define FF_PROFILE_DNXHR_SQ 2
2919 #define FF_PROFILE_DNXHR_HQ 3
2920 #define FF_PROFILE_DNXHR_HQX 4
2921 #define FF_PROFILE_DNXHR_444 5
2923 #define FF_PROFILE_DTS 20
2924 #define FF_PROFILE_DTS_ES 30
2925 #define FF_PROFILE_DTS_96_24 40
2926 #define FF_PROFILE_DTS_HD_HRA 50
2927 #define FF_PROFILE_DTS_HD_MA 60
2928 #define FF_PROFILE_DTS_EXPRESS 70
2930 #define FF_PROFILE_MPEG2_422 0
2931 #define FF_PROFILE_MPEG2_HIGH 1
2932 #define FF_PROFILE_MPEG2_SS 2
2933 #define FF_PROFILE_MPEG2_SNR_SCALABLE 3
2934 #define FF_PROFILE_MPEG2_MAIN 4
2935 #define FF_PROFILE_MPEG2_SIMPLE 5
2937 #define FF_PROFILE_H264_CONSTRAINED (1<<9) // 8+1; constraint_set1_flag
2938 #define FF_PROFILE_H264_INTRA (1<<11) // 8+3; constraint_set3_flag
2940 #define FF_PROFILE_H264_BASELINE 66
2941 #define FF_PROFILE_H264_CONSTRAINED_BASELINE (66|FF_PROFILE_H264_CONSTRAINED)
2942 #define FF_PROFILE_H264_MAIN 77
2943 #define FF_PROFILE_H264_EXTENDED 88
2944 #define FF_PROFILE_H264_HIGH 100
2945 #define FF_PROFILE_H264_HIGH_10 110
2946 #define FF_PROFILE_H264_HIGH_10_INTRA (110|FF_PROFILE_H264_INTRA)
2947 #define FF_PROFILE_H264_MULTIVIEW_HIGH 118
2948 #define FF_PROFILE_H264_HIGH_422 122
2949 #define FF_PROFILE_H264_HIGH_422_INTRA (122|FF_PROFILE_H264_INTRA)
2950 #define FF_PROFILE_H264_STEREO_HIGH 128
2951 #define FF_PROFILE_H264_HIGH_444 144
2952 #define FF_PROFILE_H264_HIGH_444_PREDICTIVE 244
2953 #define FF_PROFILE_H264_HIGH_444_INTRA (244|FF_PROFILE_H264_INTRA)
2954 #define FF_PROFILE_H264_CAVLC_444 44
2956 #define FF_PROFILE_VC1_SIMPLE 0
2957 #define FF_PROFILE_VC1_MAIN 1
2958 #define FF_PROFILE_VC1_COMPLEX 2
2959 #define FF_PROFILE_VC1_ADVANCED 3
2961 #define FF_PROFILE_MPEG4_SIMPLE 0
2962 #define FF_PROFILE_MPEG4_SIMPLE_SCALABLE 1
2963 #define FF_PROFILE_MPEG4_CORE 2
2964 #define FF_PROFILE_MPEG4_MAIN 3
2965 #define FF_PROFILE_MPEG4_N_BIT 4
2966 #define FF_PROFILE_MPEG4_SCALABLE_TEXTURE 5
2967 #define FF_PROFILE_MPEG4_SIMPLE_FACE_ANIMATION 6
2968 #define FF_PROFILE_MPEG4_BASIC_ANIMATED_TEXTURE 7
2969 #define FF_PROFILE_MPEG4_HYBRID 8
2970 #define FF_PROFILE_MPEG4_ADVANCED_REAL_TIME 9
2971 #define FF_PROFILE_MPEG4_CORE_SCALABLE 10
2972 #define FF_PROFILE_MPEG4_ADVANCED_CODING 11
2973 #define FF_PROFILE_MPEG4_ADVANCED_CORE 12
2974 #define FF_PROFILE_MPEG4_ADVANCED_SCALABLE_TEXTURE 13
2975 #define FF_PROFILE_MPEG4_SIMPLE_STUDIO 14
2976 #define FF_PROFILE_MPEG4_ADVANCED_SIMPLE 15
2978 #define FF_PROFILE_JPEG2000_CSTREAM_RESTRICTION_0 1
2979 #define FF_PROFILE_JPEG2000_CSTREAM_RESTRICTION_1 2
2980 #define FF_PROFILE_JPEG2000_CSTREAM_NO_RESTRICTION 32768
2981 #define FF_PROFILE_JPEG2000_DCINEMA_2K 3
2982 #define FF_PROFILE_JPEG2000_DCINEMA_4K 4
2984 #define FF_PROFILE_VP9_0 0
2985 #define FF_PROFILE_VP9_1 1
2986 #define FF_PROFILE_VP9_2 2
2987 #define FF_PROFILE_VP9_3 3
2989 #define FF_PROFILE_HEVC_MAIN 1
2990 #define FF_PROFILE_HEVC_MAIN_10 2
2991 #define FF_PROFILE_HEVC_MAIN_STILL_PICTURE 3
2992 #define FF_PROFILE_HEVC_REXT 4
2994 #define FF_PROFILE_AV1_MAIN 0
2995 #define FF_PROFILE_AV1_HIGH 1
2996 #define FF_PROFILE_AV1_PROFESSIONAL 2
2998 #define FF_PROFILE_MJPEG_HUFFMAN_BASELINE_DCT 0xc0
2999 #define FF_PROFILE_MJPEG_HUFFMAN_EXTENDED_SEQUENTIAL_DCT 0xc1
3000 #define FF_PROFILE_MJPEG_HUFFMAN_PROGRESSIVE_DCT 0xc2
3001 #define FF_PROFILE_MJPEG_HUFFMAN_LOSSLESS 0xc3
3002 #define FF_PROFILE_MJPEG_JPEG_LS 0xf7
3004 #define FF_PROFILE_SBC_MSBC 1
3006 #define FF_PROFILE_PRORES_PROXY 0
3007 #define FF_PROFILE_PRORES_LT 1
3008 #define FF_PROFILE_PRORES_STANDARD 2
3009 #define FF_PROFILE_PRORES_HQ 3
3010 #define FF_PROFILE_PRORES_4444 4
3011 #define FF_PROFILE_PRORES_XQ 5
3013 #define FF_PROFILE_ARIB_PROFILE_A 0
3014 #define FF_PROFILE_ARIB_PROFILE_C 1
3018 * - encoding: Set by user.
3019 * - decoding: Set by libavcodec.
3022 #define FF_LEVEL_UNKNOWN -99
3025 * Skip loop filtering for selected frames.
3026 * - encoding: unused
3027 * - decoding: Set by user.
3029 enum AVDiscard skip_loop_filter;
3032 * Skip IDCT/dequantization for selected frames.
3033 * - encoding: unused
3034 * - decoding: Set by user.
3036 enum AVDiscard skip_idct;
3039 * Skip decoding for selected frames.
3040 * - encoding: unused
3041 * - decoding: Set by user.
3043 enum AVDiscard skip_frame;
3046 * Header containing style information for text subtitles.
3047 * For SUBTITLE_ASS subtitle type, it should contain the whole ASS
3048 * [Script Info] and [V4+ Styles] section, plus the [Events] line and
3049 * the Format line following. It shouldn't include any Dialogue line.
3050 * - encoding: Set/allocated/freed by user (before avcodec_open2())
3051 * - decoding: Set/allocated/freed by libavcodec (by avcodec_open2())
3053 uint8_t *subtitle_header;
3054 int subtitle_header_size;
3056 #if FF_API_VBV_DELAY
3058 * VBV delay coded in the last frame (in periods of a 27 MHz clock).
3059 * Used for compliant TS muxing.
3060 * - encoding: Set by libavcodec.
3061 * - decoding: unused.
3062 * @deprecated this value is now exported as a part of
3063 * AV_PKT_DATA_CPB_PROPERTIES packet side data
3065 attribute_deprecated
3069 #if FF_API_SIDEDATA_ONLY_PKT
3071 * Encoding only and set by default. Allow encoders to output packets
3072 * that do not contain any encoded data, only side data.
3074 * Some encoders need to output such packets, e.g. to update some stream
3075 * parameters at the end of encoding.
3077 * @deprecated this field disables the default behaviour and
3078 * it is kept only for compatibility.
3080 attribute_deprecated
3081 int side_data_only_packets;
3085 * Audio only. The number of "priming" samples (padding) inserted by the
3086 * encoder at the beginning of the audio. I.e. this number of leading
3087 * decoded samples must be discarded by the caller to get the original audio
3088 * without leading padding.
3090 * - decoding: unused
3091 * - encoding: Set by libavcodec. The timestamps on the output packets are
3092 * adjusted by the encoder so that they always refer to the
3093 * first sample of the data actually contained in the packet,
3094 * including any added padding. E.g. if the timebase is
3095 * 1/samplerate and the timestamp of the first input sample is
3096 * 0, the timestamp of the first output packet will be
3099 int initial_padding;
3102 * - decoding: For codecs that store a framerate value in the compressed
3103 * bitstream, the decoder may export it here. { 0, 1} when
3105 * - encoding: May be used to signal the framerate of CFR content to an
3108 AVRational framerate;
3111 * Nominal unaccelerated pixel format, see AV_PIX_FMT_xxx.
3112 * - encoding: unused.
3113 * - decoding: Set by libavcodec before calling get_format()
3115 enum AVPixelFormat sw_pix_fmt;
3118 * Timebase in which pkt_dts/pts and AVPacket.dts/pts are.
3119 * - encoding unused.
3120 * - decoding set by user.
3122 AVRational pkt_timebase;
3126 * - encoding: unused.
3127 * - decoding: set by libavcodec.
3129 const AVCodecDescriptor *codec_descriptor;
3133 * low resolution decoding, 1-> 1/2 size, 2->1/4 size
3134 * - encoding: unused
3135 * - decoding: Set by user.
3141 * Current statistics for PTS correction.
3142 * - decoding: maintained and used by libavcodec, not intended to be used by user apps
3143 * - encoding: unused
3145 int64_t pts_correction_num_faulty_pts; /// Number of incorrect PTS values so far
3146 int64_t pts_correction_num_faulty_dts; /// Number of incorrect DTS values so far
3147 int64_t pts_correction_last_pts; /// PTS of the last frame
3148 int64_t pts_correction_last_dts; /// DTS of the last frame
3151 * Character encoding of the input subtitles file.
3152 * - decoding: set by user
3153 * - encoding: unused
3158 * Subtitles character encoding mode. Formats or codecs might be adjusting
3159 * this setting (if they are doing the conversion themselves for instance).
3160 * - decoding: set by libavcodec
3161 * - encoding: unused
3163 int sub_charenc_mode;
3164 #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)
3165 #define FF_SUB_CHARENC_MODE_AUTOMATIC 0 ///< libavcodec will select the mode itself
3166 #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
3167 #define FF_SUB_CHARENC_MODE_IGNORE 2 ///< neither convert the subtitles, nor check them for valid UTF-8
3170 * Skip processing alpha if supported by codec.
3171 * Note that if the format uses pre-multiplied alpha (common with VP6,
3172 * and recommended due to better video quality/compression)
3173 * the image will look as if alpha-blended onto a black background.
3174 * However for formats that do not use pre-multiplied alpha
3175 * there might be serious artefacts (though e.g. libswscale currently
3176 * assumes pre-multiplied alpha anyway).
3178 * - decoding: set by user
3179 * - encoding: unused
3184 * Number of samples to skip after a discontinuity
3185 * - decoding: unused
3186 * - encoding: set by libavcodec
3190 #if !FF_API_DEBUG_MV
3192 * debug motion vectors
3193 * - encoding: Set by user.
3194 * - decoding: Set by user.
3197 #define FF_DEBUG_VIS_MV_P_FOR 0x00000001 //visualize forward predicted MVs of P frames
3198 #define FF_DEBUG_VIS_MV_B_FOR 0x00000002 //visualize forward predicted MVs of B frames
3199 #define FF_DEBUG_VIS_MV_B_BACK 0x00000004 //visualize backward predicted MVs of B frames
3203 * custom intra quantization matrix
3204 * - encoding: Set by user, can be NULL.
3205 * - decoding: unused.
3207 uint16_t *chroma_intra_matrix;
3210 * dump format separator.
3211 * can be ", " or "\n " or anything else
3212 * - encoding: Set by user.
3213 * - decoding: Set by user.
3215 uint8_t *dump_separator;
3218 * ',' separated list of allowed decoders.
3219 * If NULL then all are allowed
3220 * - encoding: unused
3221 * - decoding: set by user
3223 char *codec_whitelist;
3226 * Properties of the stream that gets decoded
3227 * - encoding: unused
3228 * - decoding: set by libavcodec
3230 unsigned properties;
3231 #define FF_CODEC_PROPERTY_LOSSLESS 0x00000001
3232 #define FF_CODEC_PROPERTY_CLOSED_CAPTIONS 0x00000002
3235 * Additional data associated with the entire coded stream.
3237 * - decoding: unused
3238 * - encoding: may be set by libavcodec after avcodec_open2().
3240 AVPacketSideData *coded_side_data;
3241 int nb_coded_side_data;
3244 * A reference to the AVHWFramesContext describing the input (for encoding)
3245 * or output (decoding) frames. The reference is set by the caller and
3246 * afterwards owned (and freed) by libavcodec - it should never be read by
3247 * the caller after being set.
3249 * - decoding: This field should be set by the caller from the get_format()
3250 * callback. The previous reference (if any) will always be
3251 * unreffed by libavcodec before the get_format() call.
3253 * If the default get_buffer2() is used with a hwaccel pixel
3254 * format, then this AVHWFramesContext will be used for
3255 * allocating the frame buffers.
3257 * - encoding: For hardware encoders configured to use a hwaccel pixel
3258 * format, this field should be set by the caller to a reference
3259 * to the AVHWFramesContext describing input frames.
3260 * AVHWFramesContext.format must be equal to
3261 * AVCodecContext.pix_fmt.
3263 * This field should be set before avcodec_open2() is called.
3265 AVBufferRef *hw_frames_ctx;
3268 * Control the form of AVSubtitle.rects[N]->ass
3269 * - decoding: set by user
3270 * - encoding: unused
3272 int sub_text_format;
3273 #define FF_SUB_TEXT_FMT_ASS 0
3274 #if FF_API_ASS_TIMING
3275 #define FF_SUB_TEXT_FMT_ASS_WITH_TIMINGS 1
3279 * Audio only. The amount of padding (in samples) appended by the encoder to
3280 * the end of the audio. I.e. this number of decoded samples must be
3281 * discarded by the caller from the end of the stream to get the original
3282 * audio without any trailing padding.
3284 * - decoding: unused
3285 * - encoding: unused
3287 int trailing_padding;
3290 * The number of pixels per image to maximally accept.
3292 * - decoding: set by user
3293 * - encoding: set by user
3298 * A reference to the AVHWDeviceContext describing the device which will
3299 * be used by a hardware encoder/decoder. The reference is set by the
3300 * caller and afterwards owned (and freed) by libavcodec.
3302 * This should be used if either the codec device does not require
3303 * hardware frames or any that are used are to be allocated internally by
3304 * libavcodec. If the user wishes to supply any of the frames used as
3305 * encoder input or decoder output then hw_frames_ctx should be used
3306 * instead. When hw_frames_ctx is set in get_format() for a decoder, this
3307 * field will be ignored while decoding the associated stream segment, but
3308 * may again be used on a following one after another get_format() call.
3310 * For both encoders and decoders this field should be set before
3311 * avcodec_open2() is called and must not be written to thereafter.
3313 * Note that some decoders may require this field to be set initially in
3314 * order to support hw_frames_ctx at all - in that case, all frames
3315 * contexts used must be created on the same device.
3317 AVBufferRef *hw_device_ctx;
3320 * Bit set of AV_HWACCEL_FLAG_* flags, which affect hardware accelerated
3321 * decoding (if active).
3322 * - encoding: unused
3323 * - decoding: Set by user (either before avcodec_open2(), or in the
3324 * AVCodecContext.get_format callback)
3329 * Video decoding only. Certain video codecs support cropping, meaning that
3330 * only a sub-rectangle of the decoded frame is intended for display. This
3331 * option controls how cropping is handled by libavcodec.
3333 * When set to 1 (the default), libavcodec will apply cropping internally.
3334 * I.e. it will modify the output frame width/height fields and offset the
3335 * data pointers (only by as much as possible while preserving alignment, or
3336 * by the full amount if the AV_CODEC_FLAG_UNALIGNED flag is set) so that
3337 * the frames output by the decoder refer only to the cropped area. The
3338 * crop_* fields of the output frames will be zero.
3340 * When set to 0, the width/height fields of the output frames will be set
3341 * to the coded dimensions and the crop_* fields will describe the cropping
3342 * rectangle. Applying the cropping is left to the caller.
3344 * @warning When hardware acceleration with opaque output frames is used,
3345 * libavcodec is unable to apply cropping from the top/left border.
3347 * @note when this option is set to zero, the width/height fields of the
3348 * AVCodecContext and output AVFrames have different meanings. The codec
3349 * context fields store display dimensions (with the coded dimensions in
3350 * coded_width/height), while the frame fields store the coded dimensions
3351 * (with the display dimensions being determined by the crop_* fields).
3356 * Video decoding only. Sets the number of extra hardware frames which
3357 * the decoder will allocate for use by the caller. This must be set
3358 * before avcodec_open2() is called.
3360 * Some hardware decoders require all frames that they will use for
3361 * output to be defined in advance before decoding starts. For such
3362 * decoders, the hardware frame pool must therefore be of a fixed size.
3363 * The extra frames set here are on top of any number that the decoder
3364 * needs internally in order to operate normally (for example, frames
3365 * used as reference pictures).
3367 int extra_hw_frames;
3370 * The percentage of damaged samples to discard a frame.
3372 * - decoding: set by user
3373 * - encoding: unused
3375 int discard_damaged_percentage;
3378 #if FF_API_CODEC_GET_SET
3380 * Accessors for some AVCodecContext fields. These used to be provided for ABI
3381 * compatibility, and do not need to be used anymore.
3383 attribute_deprecated
3384 AVRational av_codec_get_pkt_timebase (const AVCodecContext *avctx);
3385 attribute_deprecated
3386 void av_codec_set_pkt_timebase (AVCodecContext *avctx, AVRational val);
3388 attribute_deprecated
3389 const AVCodecDescriptor *av_codec_get_codec_descriptor(const AVCodecContext *avctx);
3390 attribute_deprecated
3391 void av_codec_set_codec_descriptor(AVCodecContext *avctx, const AVCodecDescriptor *desc);
3393 attribute_deprecated
3394 unsigned av_codec_get_codec_properties(const AVCodecContext *avctx);
3397 attribute_deprecated
3398 int av_codec_get_lowres(const AVCodecContext *avctx);
3399 attribute_deprecated
3400 void av_codec_set_lowres(AVCodecContext *avctx, int val);
3403 attribute_deprecated
3404 int av_codec_get_seek_preroll(const AVCodecContext *avctx);
3405 attribute_deprecated
3406 void av_codec_set_seek_preroll(AVCodecContext *avctx, int val);
3408 attribute_deprecated
3409 uint16_t *av_codec_get_chroma_intra_matrix(const AVCodecContext *avctx);
3410 attribute_deprecated
3411 void av_codec_set_chroma_intra_matrix(AVCodecContext *avctx, uint16_t *val);
3417 typedef struct AVProfile {
3419 const char *name; ///< short name for the profile
3424 * The codec supports this format via the hw_device_ctx interface.
3426 * When selecting this format, AVCodecContext.hw_device_ctx should
3427 * have been set to a device of the specified type before calling
3430 AV_CODEC_HW_CONFIG_METHOD_HW_DEVICE_CTX = 0x01,
3432 * The codec supports this format via the hw_frames_ctx interface.
3434 * When selecting this format for a decoder,
3435 * AVCodecContext.hw_frames_ctx should be set to a suitable frames
3436 * context inside the get_format() callback. The frames context
3437 * must have been created on a device of the specified type.
3439 AV_CODEC_HW_CONFIG_METHOD_HW_FRAMES_CTX = 0x02,
3441 * The codec supports this format by some internal method.
3443 * This format can be selected without any additional configuration -
3444 * no device or frames context is required.
3446 AV_CODEC_HW_CONFIG_METHOD_INTERNAL = 0x04,
3448 * The codec supports this format by some ad-hoc method.
3450 * Additional settings and/or function calls are required. See the
3451 * codec-specific documentation for details. (Methods requiring
3452 * this sort of configuration are deprecated and others should be
3453 * used in preference.)
3455 AV_CODEC_HW_CONFIG_METHOD_AD_HOC = 0x08,
3458 typedef struct AVCodecHWConfig {
3460 * A hardware pixel format which the codec can use.
3462 enum AVPixelFormat pix_fmt;
3464 * Bit set of AV_CODEC_HW_CONFIG_METHOD_* flags, describing the possible
3465 * setup methods which can be used with this configuration.
3469 * The device type associated with the configuration.
3471 * Must be set for AV_CODEC_HW_CONFIG_METHOD_HW_DEVICE_CTX and
3472 * AV_CODEC_HW_CONFIG_METHOD_HW_FRAMES_CTX, otherwise unused.
3474 enum AVHWDeviceType device_type;
3477 typedef struct AVCodecDefault AVCodecDefault;
3484 typedef struct AVCodec {
3486 * Name of the codec implementation.
3487 * The name is globally unique among encoders and among decoders (but an
3488 * encoder and a decoder can share the same name).
3489 * This is the primary way to find a codec from the user perspective.
3493 * Descriptive name for the codec, meant to be more human readable than name.
3494 * You should use the NULL_IF_CONFIG_SMALL() macro to define it.
3496 const char *long_name;
3497 enum AVMediaType type;
3500 * Codec capabilities.
3501 * see AV_CODEC_CAP_*
3504 const AVRational *supported_framerates; ///< array of supported framerates, or NULL if any, array is terminated by {0,0}
3505 const enum AVPixelFormat *pix_fmts; ///< array of supported pixel formats, or NULL if unknown, array is terminated by -1
3506 const int *supported_samplerates; ///< array of supported audio samplerates, or NULL if unknown, array is terminated by 0
3507 const enum AVSampleFormat *sample_fmts; ///< array of supported sample formats, or NULL if unknown, array is terminated by -1
3508 const uint64_t *channel_layouts; ///< array of support channel layouts, or NULL if unknown. array is terminated by 0
3509 uint8_t max_lowres; ///< maximum value for lowres supported by the decoder
3510 const AVClass *priv_class; ///< AVClass for the private context
3511 const AVProfile *profiles; ///< array of recognized profiles, or NULL if unknown, array is terminated by {FF_PROFILE_UNKNOWN}
3514 * Group name of the codec implementation.
3515 * This is a short symbolic name of the wrapper backing this codec. A
3516 * wrapper uses some kind of external implementation for the codec, such
3517 * as an external library, or a codec implementation provided by the OS or
3519 * If this field is NULL, this is a builtin, libavcodec native codec.
3520 * If non-NULL, this will be the suffix in AVCodec.name in most cases
3521 * (usually AVCodec.name will be of the form "<codec_name>_<wrapper_name>").
3523 const char *wrapper_name;
3525 /*****************************************************************
3526 * No fields below this line are part of the public API. They
3527 * may not be used outside of libavcodec and can be changed and
3529 * New public fields should be added right above.
3530 *****************************************************************
3533 struct AVCodec *next;
3535 * @name Frame-level threading support functions
3539 * If defined, called on thread contexts when they are created.
3540 * If the codec allocates writable tables in init(), re-allocate them here.
3541 * priv_data will be set to a copy of the original.
3543 int (*init_thread_copy)(AVCodecContext *);
3545 * Copy necessary context variables from a previous thread context to the current one.
3546 * If not defined, the next thread will start automatically; otherwise, the codec
3547 * must call ff_thread_finish_setup().
3549 * dst and src will (rarely) point to the same context, in which case memcpy should be skipped.
3551 int (*update_thread_context)(AVCodecContext *dst, const AVCodecContext *src);
3555 * Private codec-specific defaults.
3557 const AVCodecDefault *defaults;
3560 * Initialize codec static data, called from avcodec_register().
3562 * This is not intended for time consuming operations as it is
3563 * run for every codec regardless of that codec being used.
3565 void (*init_static_data)(struct AVCodec *codec);
3567 int (*init)(AVCodecContext *);
3568 int (*encode_sub)(AVCodecContext *, uint8_t *buf, int buf_size,
3569 const struct AVSubtitle *sub);
3571 * Encode data to an AVPacket.
3573 * @param avctx codec context
3574 * @param avpkt output AVPacket (may contain a user-provided buffer)
3575 * @param[in] frame AVFrame containing the raw data to be encoded
3576 * @param[out] got_packet_ptr encoder sets to 0 or 1 to indicate that a
3577 * non-empty packet was returned in avpkt.
3578 * @return 0 on success, negative error code on failure
3580 int (*encode2)(AVCodecContext *avctx, AVPacket *avpkt, const AVFrame *frame,
3581 int *got_packet_ptr);
3582 int (*decode)(AVCodecContext *, void *outdata, int *outdata_size, AVPacket *avpkt);
3583 int (*close)(AVCodecContext *);
3585 * Encode API with decoupled packet/frame dataflow. The API is the
3586 * same as the avcodec_ prefixed APIs (avcodec_send_frame() etc.), except
3588 * - never called if the codec is closed or the wrong type,
3589 * - if AV_CODEC_CAP_DELAY is not set, drain frames are never sent,
3590 * - only one drain frame is ever passed down,
3592 int (*send_frame)(AVCodecContext *avctx, const AVFrame *frame);
3593 int (*receive_packet)(AVCodecContext *avctx, AVPacket *avpkt);
3596 * Decode API with decoupled packet/frame dataflow. This function is called
3597 * to get one output frame. It should call ff_decode_get_packet() to obtain
3600 int (*receive_frame)(AVCodecContext *avctx, AVFrame *frame);
3603 * Will be called when seeking
3605 void (*flush)(AVCodecContext *);
3607 * Internal codec capabilities.
3608 * See FF_CODEC_CAP_* in internal.h
3613 * Decoding only, a comma-separated list of bitstream filters to apply to
3614 * packets before decoding.
3619 * Array of pointers to hardware configurations supported by the codec,
3620 * or NULL if no hardware supported. The array is terminated by a NULL
3623 * The user can only access this field via avcodec_get_hw_config().
3625 const struct AVCodecHWConfigInternal **hw_configs;
3628 #if FF_API_CODEC_GET_SET
3629 attribute_deprecated
3630 int av_codec_get_max_lowres(const AVCodec *codec);
3633 struct MpegEncContext;
3636 * Retrieve supported hardware configurations for a codec.
3638 * Values of index from zero to some maximum return the indexed configuration
3639 * descriptor; all other values return NULL. If the codec does not support
3640 * any hardware configurations then it will always return NULL.
3642 const AVCodecHWConfig *avcodec_get_hw_config(const AVCodec *codec, int index);
3645 * @defgroup lavc_hwaccel AVHWAccel
3647 * @note Nothing in this structure should be accessed by the user. At some
3648 * point in future it will not be externally visible at all.
3652 typedef struct AVHWAccel {
3654 * Name of the hardware accelerated codec.
3655 * The name is globally unique among encoders and among decoders (but an
3656 * encoder and a decoder can share the same name).
3661 * Type of codec implemented by the hardware accelerator.
3663 * See AVMEDIA_TYPE_xxx
3665 enum AVMediaType type;
3668 * Codec implemented by the hardware accelerator.
3670 * See AV_CODEC_ID_xxx
3675 * Supported pixel format.
3677 * Only hardware accelerated formats are supported here.
3679 enum AVPixelFormat pix_fmt;
3682 * Hardware accelerated codec capabilities.
3683 * see AV_HWACCEL_CODEC_CAP_*
3687 /*****************************************************************
3688 * No fields below this line are part of the public API. They
3689 * may not be used outside of libavcodec and can be changed and
3691 * New public fields should be added right above.
3692 *****************************************************************
3696 * Allocate a custom buffer
3698 int (*alloc_frame)(AVCodecContext *avctx, AVFrame *frame);
3701 * Called at the beginning of each frame or field picture.
3703 * Meaningful frame information (codec specific) is guaranteed to
3704 * be parsed at this point. This function is mandatory.
3706 * Note that buf can be NULL along with buf_size set to 0.
3707 * Otherwise, this means the whole frame is available at this point.
3709 * @param avctx the codec context
3710 * @param buf the frame data buffer base
3711 * @param buf_size the size of the frame in bytes
3712 * @return zero if successful, a negative value otherwise
3714 int (*start_frame)(AVCodecContext *avctx, const uint8_t *buf, uint32_t buf_size);
3717 * Callback for parameter data (SPS/PPS/VPS etc).
3719 * Useful for hardware decoders which keep persistent state about the
3720 * video parameters, and need to receive any changes to update that state.
3722 * @param avctx the codec context
3723 * @param type the nal unit type
3724 * @param buf the nal unit data buffer
3725 * @param buf_size the size of the nal unit in bytes
3726 * @return zero if successful, a negative value otherwise
3728 int (*decode_params)(AVCodecContext *avctx, int type, const uint8_t *buf, uint32_t buf_size);
3731 * Callback for each slice.
3733 * Meaningful slice information (codec specific) is guaranteed to
3734 * be parsed at this point. This function is mandatory.
3735 * The only exception is XvMC, that works on MB level.
3737 * @param avctx the codec context
3738 * @param buf the slice data buffer base
3739 * @param buf_size the size of the slice in bytes
3740 * @return zero if successful, a negative value otherwise
3742 int (*decode_slice)(AVCodecContext *avctx, const uint8_t *buf, uint32_t buf_size);
3745 * Called at the end of each frame or field picture.
3747 * The whole picture is parsed at this point and can now be sent
3748 * to the hardware accelerator. This function is mandatory.
3750 * @param avctx the codec context
3751 * @return zero if successful, a negative value otherwise
3753 int (*end_frame)(AVCodecContext *avctx);
3756 * Size of per-frame hardware accelerator private data.
3758 * Private data is allocated with av_mallocz() before
3759 * AVCodecContext.get_buffer() and deallocated after
3760 * AVCodecContext.release_buffer().
3762 int frame_priv_data_size;
3765 * Called for every Macroblock in a slice.
3767 * XvMC uses it to replace the ff_mpv_reconstruct_mb().
3768 * Instead of decoding to raw picture, MB parameters are
3769 * stored in an array provided by the video driver.
3771 * @param s the mpeg context
3773 void (*decode_mb)(struct MpegEncContext *s);
3776 * Initialize the hwaccel private data.
3778 * This will be called from ff_get_format(), after hwaccel and
3779 * hwaccel_context are set and the hwaccel private data in AVCodecInternal
3782 int (*init)(AVCodecContext *avctx);
3785 * Uninitialize the hwaccel private data.
3787 * This will be called from get_format() or avcodec_close(), after hwaccel
3788 * and hwaccel_context are already uninitialized.
3790 int (*uninit)(AVCodecContext *avctx);
3793 * Size of the private data to allocate in
3794 * AVCodecInternal.hwaccel_priv_data.
3799 * Internal hwaccel capabilities.
3804 * Fill the given hw_frames context with current codec parameters. Called
3805 * from get_format. Refer to avcodec_get_hw_frames_parameters() for
3808 * This CAN be called before AVHWAccel.init is called, and you must assume
3809 * that avctx->hwaccel_priv_data is invalid.
3811 int (*frame_params)(AVCodecContext *avctx, AVBufferRef *hw_frames_ctx);
3815 * HWAccel is experimental and is thus avoided in favor of non experimental
3818 #define AV_HWACCEL_CODEC_CAP_EXPERIMENTAL 0x0200
3821 * Hardware acceleration should be used for decoding even if the codec level
3822 * used is unknown or higher than the maximum supported level reported by the
3825 * It's generally a good idea to pass this flag unless you have a specific
3826 * reason not to, as hardware tends to under-report supported levels.
3828 #define AV_HWACCEL_FLAG_IGNORE_LEVEL (1 << 0)
3831 * Hardware acceleration can output YUV pixel formats with a different chroma
3832 * sampling than 4:2:0 and/or other than 8 bits per component.
3834 #define AV_HWACCEL_FLAG_ALLOW_HIGH_DEPTH (1 << 1)
3837 * Hardware acceleration should still be attempted for decoding when the
3838 * codec profile does not match the reported capabilities of the hardware.
3840 * For example, this can be used to try to decode baseline profile H.264
3841 * streams in hardware - it will often succeed, because many streams marked
3842 * as baseline profile actually conform to constrained baseline profile.
3844 * @warning If the stream is actually not supported then the behaviour is
3845 * undefined, and may include returning entirely incorrect output
3846 * while indicating success.
3848 #define AV_HWACCEL_FLAG_ALLOW_PROFILE_MISMATCH (1 << 2)
3854 #if FF_API_AVPICTURE
3856 * @defgroup lavc_picture AVPicture
3858 * Functions for working with AVPicture
3863 * Picture data structure.
3865 * Up to four components can be stored into it, the last component is
3867 * @deprecated use AVFrame or imgutils functions instead
3869 typedef struct AVPicture {
3870 attribute_deprecated
3871 uint8_t *data[AV_NUM_DATA_POINTERS]; ///< pointers to the image data planes
3872 attribute_deprecated
3873 int linesize[AV_NUM_DATA_POINTERS]; ///< number of bytes per line
3881 enum AVSubtitleType {
3884 SUBTITLE_BITMAP, ///< A bitmap, pict will be set
3887 * Plain text, the text field must be set by the decoder and is
3888 * authoritative. ass and pict fields may contain approximations.
3893 * Formatted text, the ass field must be set by the decoder and is
3894 * authoritative. pict and text fields may contain approximations.
3899 #define AV_SUBTITLE_FLAG_FORCED 0x00000001
3901 typedef struct AVSubtitleRect {
3902 int x; ///< top left corner of pict, undefined when pict is not set
3903 int y; ///< top left corner of pict, undefined when pict is not set
3904 int w; ///< width of pict, undefined when pict is not set
3905 int h; ///< height of pict, undefined when pict is not set
3906 int nb_colors; ///< number of colors in pict, undefined when pict is not set
3908 #if FF_API_AVPICTURE
3910 * @deprecated unused
3912 attribute_deprecated
3916 * data+linesize for the bitmap of this subtitle.
3917 * Can be set for text/ass as well once they are rendered.
3922 enum AVSubtitleType type;
3924 char *text; ///< 0 terminated plain UTF-8 text
3927 * 0 terminated ASS/SSA compatible event line.
3928 * The presentation of this is unaffected by the other values in this
3936 typedef struct AVSubtitle {
3937 uint16_t format; /* 0 = graphics */
3938 uint32_t start_display_time; /* relative to packet pts, in ms */
3939 uint32_t end_display_time; /* relative to packet pts, in ms */
3941 AVSubtitleRect **rects;
3942 int64_t pts; ///< Same as packet pts, in AV_TIME_BASE
3946 * This struct describes the properties of an encoded stream.
3948 * sizeof(AVCodecParameters) is not a part of the public ABI, this struct must
3949 * be allocated with avcodec_parameters_alloc() and freed with
3950 * avcodec_parameters_free().
3952 typedef struct AVCodecParameters {
3954 * General type of the encoded data.
3956 enum AVMediaType codec_type;
3958 * Specific type of the encoded data (the codec used).
3960 enum AVCodecID codec_id;
3962 * Additional information about the codec (corresponds to the AVI FOURCC).
3967 * Extra binary data needed for initializing the decoder, codec-dependent.
3969 * Must be allocated with av_malloc() and will be freed by
3970 * avcodec_parameters_free(). The allocated size of extradata must be at
3971 * least extradata_size + AV_INPUT_BUFFER_PADDING_SIZE, with the padding
3976 * Size of the extradata content in bytes.
3981 * - video: the pixel format, the value corresponds to enum AVPixelFormat.
3982 * - audio: the sample format, the value corresponds to enum AVSampleFormat.
3987 * The average bitrate of the encoded data (in bits per second).
3992 * The number of bits per sample in the codedwords.
3994 * This is basically the bitrate per sample. It is mandatory for a bunch of
3995 * formats to actually decode them. It's the number of bits for one sample in
3996 * the actual coded bitstream.
3998 * This could be for example 4 for ADPCM
3999 * For PCM formats this matches bits_per_raw_sample
4002 int bits_per_coded_sample;
4005 * This is the number of valid bits in each output sample. If the
4006 * sample format has more bits, the least significant bits are additional
4007 * padding bits, which are always 0. Use right shifts to reduce the sample
4008 * to its actual size. For example, audio formats with 24 bit samples will
4009 * have bits_per_raw_sample set to 24, and format set to AV_SAMPLE_FMT_S32.
4010 * To get the original sample use "(int32_t)sample >> 8"."
4012 * For ADPCM this might be 12 or 16 or similar
4015 int bits_per_raw_sample;
4018 * Codec-specific bitstream restrictions that the stream conforms to.
4024 * Video only. The dimensions of the video frame in pixels.
4030 * Video only. The aspect ratio (width / height) which a single pixel
4031 * should have when displayed.
4033 * When the aspect ratio is unknown / undefined, the numerator should be
4034 * set to 0 (the denominator may have any value).
4036 AVRational sample_aspect_ratio;
4039 * Video only. The order of the fields in interlaced video.
4041 enum AVFieldOrder field_order;
4044 * Video only. Additional colorspace characteristics.
4046 enum AVColorRange color_range;
4047 enum AVColorPrimaries color_primaries;
4048 enum AVColorTransferCharacteristic color_trc;
4049 enum AVColorSpace color_space;
4050 enum AVChromaLocation chroma_location;
4053 * Video only. Number of delayed frames.
4058 * Audio only. The channel layout bitmask. May be 0 if the channel layout is
4059 * unknown or unspecified, otherwise the number of bits set must be equal to
4060 * the channels field.
4062 uint64_t channel_layout;
4064 * Audio only. The number of audio channels.
4068 * Audio only. The number of audio samples per second.
4072 * Audio only. The number of bytes per coded audio frame, required by some
4075 * Corresponds to nBlockAlign in WAVEFORMATEX.
4079 * Audio only. Audio frame size, if known. Required by some formats to be static.
4084 * Audio only. The amount of padding (in samples) inserted by the encoder at
4085 * the beginning of the audio. I.e. this number of leading decoded samples
4086 * must be discarded by the caller to get the original audio without leading
4089 int initial_padding;
4091 * Audio only. The amount of padding (in samples) appended by the encoder to
4092 * the end of the audio. I.e. this number of decoded samples must be
4093 * discarded by the caller from the end of the stream to get the original
4094 * audio without any trailing padding.
4096 int trailing_padding;
4098 * Audio only. Number of samples to skip after a discontinuity.
4101 } AVCodecParameters;
4104 * Iterate over all registered codecs.
4106 * @param opaque a pointer where libavcodec will store the iteration state. Must
4107 * point to NULL to start the iteration.
4109 * @return the next registered codec or NULL when the iteration is
4112 const AVCodec *av_codec_iterate(void **opaque);
4116 * If c is NULL, returns the first registered codec,
4117 * if c is non-NULL, returns the next registered codec after c,
4118 * or NULL if c is the last one.
4120 attribute_deprecated
4121 AVCodec *av_codec_next(const AVCodec *c);
4125 * Return the LIBAVCODEC_VERSION_INT constant.
4127 unsigned avcodec_version(void);
4130 * Return the libavcodec build-time configuration.
4132 const char *avcodec_configuration(void);
4135 * Return the libavcodec license.
4137 const char *avcodec_license(void);
4141 * Register the codec codec and initialize libavcodec.
4143 * @warning either this function or avcodec_register_all() must be called
4144 * before any other libavcodec functions.
4146 * @see avcodec_register_all()
4148 attribute_deprecated
4149 void avcodec_register(AVCodec *codec);
4152 * Register all the codecs, parsers and bitstream filters which were enabled at
4153 * configuration time. If you do not call this function you can select exactly
4154 * which formats you want to support, by using the individual registration
4157 * @see avcodec_register
4158 * @see av_register_codec_parser
4159 * @see av_register_bitstream_filter
4161 attribute_deprecated
4162 void avcodec_register_all(void);
4166 * Allocate an AVCodecContext and set its fields to default values. The
4167 * resulting struct should be freed with avcodec_free_context().
4169 * @param codec if non-NULL, allocate private data and initialize defaults
4170 * for the given codec. It is illegal to then call avcodec_open2()
4171 * with a different codec.
4172 * If NULL, then the codec-specific defaults won't be initialized,
4173 * which may result in suboptimal default settings (this is
4174 * important mainly for encoders, e.g. libx264).
4176 * @return An AVCodecContext filled with default values or NULL on failure.
4178 AVCodecContext *avcodec_alloc_context3(const AVCodec *codec);
4181 * Free the codec context and everything associated with it and write NULL to
4182 * the provided pointer.
4184 void avcodec_free_context(AVCodecContext **avctx);
4186 #if FF_API_GET_CONTEXT_DEFAULTS
4188 * @deprecated This function should not be used, as closing and opening a codec
4189 * context multiple time is not supported. A new codec context should be
4190 * allocated for each new use.
4192 int avcodec_get_context_defaults3(AVCodecContext *s, const AVCodec *codec);
4196 * Get the AVClass for AVCodecContext. It can be used in combination with
4197 * AV_OPT_SEARCH_FAKE_OBJ for examining options.
4199 * @see av_opt_find().
4201 const AVClass *avcodec_get_class(void);
4203 #if FF_API_COPY_CONTEXT
4205 * Get the AVClass for AVFrame. It can be used in combination with
4206 * AV_OPT_SEARCH_FAKE_OBJ for examining options.
4208 * @see av_opt_find().
4210 const AVClass *avcodec_get_frame_class(void);
4213 * Get the AVClass for AVSubtitleRect. It can be used in combination with
4214 * AV_OPT_SEARCH_FAKE_OBJ for examining options.
4216 * @see av_opt_find().
4218 const AVClass *avcodec_get_subtitle_rect_class(void);
4221 * Copy the settings of the source AVCodecContext into the destination
4222 * AVCodecContext. The resulting destination codec context will be
4223 * unopened, i.e. you are required to call avcodec_open2() before you
4224 * can use this AVCodecContext to decode/encode video/audio data.
4226 * @param dest target codec context, should be initialized with
4227 * avcodec_alloc_context3(NULL), but otherwise uninitialized
4228 * @param src source codec context
4229 * @return AVERROR() on error (e.g. memory allocation error), 0 on success
4231 * @deprecated The semantics of this function are ill-defined and it should not
4232 * be used. If you need to transfer the stream parameters from one codec context
4233 * to another, use an intermediate AVCodecParameters instance and the
4234 * avcodec_parameters_from_context() / avcodec_parameters_to_context()
4237 attribute_deprecated
4238 int avcodec_copy_context(AVCodecContext *dest, const AVCodecContext *src);
4242 * Allocate a new AVCodecParameters and set its fields to default values
4243 * (unknown/invalid/0). The returned struct must be freed with
4244 * avcodec_parameters_free().
4246 AVCodecParameters *avcodec_parameters_alloc(void);
4249 * Free an AVCodecParameters instance and everything associated with it and
4250 * write NULL to the supplied pointer.
4252 void avcodec_parameters_free(AVCodecParameters **par);
4255 * Copy the contents of src to dst. Any allocated fields in dst are freed and
4256 * replaced with newly allocated duplicates of the corresponding fields in src.
4258 * @return >= 0 on success, a negative AVERROR code on failure.
4260 int avcodec_parameters_copy(AVCodecParameters *dst, const AVCodecParameters *src);
4263 * Fill the parameters struct based on the values from the supplied codec
4264 * context. Any allocated fields in par are freed and replaced with duplicates
4265 * of the corresponding fields in codec.
4267 * @return >= 0 on success, a negative AVERROR code on failure
4269 int avcodec_parameters_from_context(AVCodecParameters *par,
4270 const AVCodecContext *codec);
4273 * Fill the codec context based on the values from the supplied codec
4274 * parameters. Any allocated fields in codec that have a corresponding field in
4275 * par are freed and replaced with duplicates of the corresponding field in par.
4276 * Fields in codec that do not have a counterpart in par are not touched.
4278 * @return >= 0 on success, a negative AVERROR code on failure.
4280 int avcodec_parameters_to_context(AVCodecContext *codec,
4281 const AVCodecParameters *par);
4284 * Initialize the AVCodecContext to use the given AVCodec. Prior to using this
4285 * function the context has to be allocated with avcodec_alloc_context3().
4287 * The functions avcodec_find_decoder_by_name(), avcodec_find_encoder_by_name(),
4288 * avcodec_find_decoder() and avcodec_find_encoder() provide an easy way for
4289 * retrieving a codec.
4291 * @warning This function is not thread safe!
4293 * @note Always call this function before using decoding routines (such as
4294 * @ref avcodec_receive_frame()).
4297 * avcodec_register_all();
4298 * av_dict_set(&opts, "b", "2.5M", 0);
4299 * codec = avcodec_find_decoder(AV_CODEC_ID_H264);
4303 * context = avcodec_alloc_context3(codec);
4305 * if (avcodec_open2(context, codec, opts) < 0)
4309 * @param avctx The context to initialize.
4310 * @param codec The codec to open this context for. If a non-NULL codec has been
4311 * previously passed to avcodec_alloc_context3() or
4312 * for this context, then this parameter MUST be either NULL or
4313 * equal to the previously passed codec.
4314 * @param options A dictionary filled with AVCodecContext and codec-private options.
4315 * On return this object will be filled with options that were not found.
4317 * @return zero on success, a negative value on error
4318 * @see avcodec_alloc_context3(), avcodec_find_decoder(), avcodec_find_encoder(),
4319 * av_dict_set(), av_opt_find().
4321 int avcodec_open2(AVCodecContext *avctx, const AVCodec *codec, AVDictionary **options);
4324 * Close a given AVCodecContext and free all the data associated with it
4325 * (but not the AVCodecContext itself).
4327 * Calling this function on an AVCodecContext that hasn't been opened will free
4328 * the codec-specific data allocated in avcodec_alloc_context3() with a non-NULL
4329 * codec. Subsequent calls will do nothing.
4331 * @note Do not use this function. Use avcodec_free_context() to destroy a
4332 * codec context (either open or closed). Opening and closing a codec context
4333 * multiple times is not supported anymore -- use multiple codec contexts
4336 int avcodec_close(AVCodecContext *avctx);
4339 * Free all allocated data in the given subtitle struct.
4341 * @param sub AVSubtitle to free.
4343 void avsubtitle_free(AVSubtitle *sub);
4350 * @addtogroup lavc_packet
4355 * Allocate an AVPacket and set its fields to default values. The resulting
4356 * struct must be freed using av_packet_free().
4358 * @return An AVPacket filled with default values or NULL on failure.
4360 * @note this only allocates the AVPacket itself, not the data buffers. Those
4361 * must be allocated through other means such as av_new_packet.
4363 * @see av_new_packet
4365 AVPacket *av_packet_alloc(void);
4368 * Create a new packet that references the same data as src.
4370 * This is a shortcut for av_packet_alloc()+av_packet_ref().
4372 * @return newly created AVPacket on success, NULL on error.
4374 * @see av_packet_alloc
4375 * @see av_packet_ref
4377 AVPacket *av_packet_clone(const AVPacket *src);
4380 * Free the packet, if the packet is reference counted, it will be
4381 * unreferenced first.
4383 * @param pkt packet to be freed. The pointer will be set to NULL.
4384 * @note passing NULL is a no-op.
4386 void av_packet_free(AVPacket **pkt);
4389 * Initialize optional fields of a packet with default values.
4391 * Note, this does not touch the data and size members, which have to be
4392 * initialized separately.
4396 void av_init_packet(AVPacket *pkt);
4399 * Allocate the payload of a packet and initialize its fields with
4403 * @param size wanted payload size
4404 * @return 0 if OK, AVERROR_xxx otherwise
4406 int av_new_packet(AVPacket *pkt, int size);
4409 * Reduce packet size, correctly zeroing padding
4412 * @param size new size
4414 void av_shrink_packet(AVPacket *pkt, int size);
4417 * Increase packet size, correctly zeroing padding
4420 * @param grow_by number of bytes by which to increase the size of the packet
4422 int av_grow_packet(AVPacket *pkt, int grow_by);
4425 * Initialize a reference-counted packet from av_malloc()ed data.
4427 * @param pkt packet to be initialized. This function will set the data, size,
4428 * and buf fields, all others are left untouched.
4429 * @param data Data allocated by av_malloc() to be used as packet data. If this
4430 * function returns successfully, the data is owned by the underlying AVBuffer.
4431 * The caller may not access the data through other means.
4432 * @param size size of data in bytes, without the padding. I.e. the full buffer
4433 * size is assumed to be size + AV_INPUT_BUFFER_PADDING_SIZE.
4435 * @return 0 on success, a negative AVERROR on error
4437 int av_packet_from_data(AVPacket *pkt, uint8_t *data, int size);
4439 #if FF_API_AVPACKET_OLD_API
4441 * @warning This is a hack - the packet memory allocation stuff is broken. The
4442 * packet is allocated if it was not really allocated.
4444 * @deprecated Use av_packet_ref or av_packet_make_refcounted
4446 attribute_deprecated
4447 int av_dup_packet(AVPacket *pkt);
4449 * Copy packet, including contents
4451 * @return 0 on success, negative AVERROR on fail
4453 * @deprecated Use av_packet_ref
4455 attribute_deprecated
4456 int av_copy_packet(AVPacket *dst, const AVPacket *src);
4459 * Copy packet side data
4461 * @return 0 on success, negative AVERROR on fail
4463 * @deprecated Use av_packet_copy_props
4465 attribute_deprecated
4466 int av_copy_packet_side_data(AVPacket *dst, const AVPacket *src);
4471 * @deprecated Use av_packet_unref
4473 * @param pkt packet to free
4475 attribute_deprecated
4476 void av_free_packet(AVPacket *pkt);
4479 * Allocate new information of a packet.
4482 * @param type side information type
4483 * @param size side information size
4484 * @return pointer to fresh allocated data or NULL otherwise
4486 uint8_t* av_packet_new_side_data(AVPacket *pkt, enum AVPacketSideDataType type,
4490 * Wrap an existing array as a packet side data.
4493 * @param type side information type
4494 * @param data the side data array. It must be allocated with the av_malloc()
4495 * family of functions. The ownership of the data is transferred to
4497 * @param size side information size
4498 * @return a non-negative number on success, a negative AVERROR code on
4499 * failure. On failure, the packet is unchanged and the data remains
4500 * owned by the caller.
4502 int av_packet_add_side_data(AVPacket *pkt, enum AVPacketSideDataType type,
4503 uint8_t *data, size_t size);
4506 * Shrink the already allocated side data buffer
4509 * @param type side information type
4510 * @param size new side information size
4511 * @return 0 on success, < 0 on failure
4513 int av_packet_shrink_side_data(AVPacket *pkt, enum AVPacketSideDataType type,
4517 * Get side information from packet.
4520 * @param type desired side information type
4521 * @param size pointer for side information size to store (optional)
4522 * @return pointer to data if present or NULL otherwise
4524 uint8_t* av_packet_get_side_data(const AVPacket *pkt, enum AVPacketSideDataType type,
4527 #if FF_API_MERGE_SD_API
4528 attribute_deprecated
4529 int av_packet_merge_side_data(AVPacket *pkt);
4531 attribute_deprecated
4532 int av_packet_split_side_data(AVPacket *pkt);
4535 const char *av_packet_side_data_name(enum AVPacketSideDataType type);
4538 * Pack a dictionary for use in side_data.
4540 * @param dict The dictionary to pack.
4541 * @param size pointer to store the size of the returned data
4542 * @return pointer to data if successful, NULL otherwise
4544 uint8_t *av_packet_pack_dictionary(AVDictionary *dict, int *size);
4546 * Unpack a dictionary from side_data.
4548 * @param data data from side_data
4549 * @param size size of the data
4550 * @param dict the metadata storage dictionary
4551 * @return 0 on success, < 0 on failure
4553 int av_packet_unpack_dictionary(const uint8_t *data, int size, AVDictionary **dict);
4557 * Convenience function to free all the side data stored.
4558 * All the other fields stay untouched.
4562 void av_packet_free_side_data(AVPacket *pkt);
4565 * Setup a new reference to the data described by a given packet
4567 * If src is reference-counted, setup dst as a new reference to the
4568 * buffer in src. Otherwise allocate a new buffer in dst and copy the
4569 * data from src into it.
4571 * All the other fields are copied from src.
4573 * @see av_packet_unref
4575 * @param dst Destination packet
4576 * @param src Source packet
4578 * @return 0 on success, a negative AVERROR on error.
4580 int av_packet_ref(AVPacket *dst, const AVPacket *src);
4585 * Unreference the buffer referenced by the packet and reset the
4586 * remaining packet fields to their default values.
4588 * @param pkt The packet to be unreferenced.
4590 void av_packet_unref(AVPacket *pkt);
4593 * Move every field in src to dst and reset src.
4595 * @see av_packet_unref
4597 * @param src Source packet, will be reset
4598 * @param dst Destination packet
4600 void av_packet_move_ref(AVPacket *dst, AVPacket *src);
4603 * Copy only "properties" fields from src to dst.
4605 * Properties for the purpose of this function are all the fields
4606 * beside those related to the packet data (buf, data, size)
4608 * @param dst Destination packet
4609 * @param src Source packet
4611 * @return 0 on success AVERROR on failure.
4613 int av_packet_copy_props(AVPacket *dst, const AVPacket *src);
4616 * Ensure the data described by a given packet is reference counted.
4618 * @note This function does not ensure that the reference will be writable.
4619 * Use av_packet_make_writable instead for that purpose.
4621 * @see av_packet_ref
4622 * @see av_packet_make_writable
4624 * @param pkt packet whose data should be made reference counted.
4626 * @return 0 on success, a negative AVERROR on error. On failure, the
4627 * packet is unchanged.
4629 int av_packet_make_refcounted(AVPacket *pkt);
4632 * Create a writable reference for the data described by a given packet,
4633 * avoiding data copy if possible.
4635 * @param pkt Packet whose data should be made writable.
4637 * @return 0 on success, a negative AVERROR on failure. On failure, the
4638 * packet is unchanged.
4640 int av_packet_make_writable(AVPacket *pkt);
4643 * Convert valid timing fields (timestamps / durations) in a packet from one
4644 * timebase to another. Timestamps with unknown values (AV_NOPTS_VALUE) will be
4647 * @param pkt packet on which the conversion will be performed
4648 * @param tb_src source timebase, in which the timing fields in pkt are
4650 * @param tb_dst destination timebase, to which the timing fields will be
4653 void av_packet_rescale_ts(AVPacket *pkt, AVRational tb_src, AVRational tb_dst);
4660 * @addtogroup lavc_decoding
4665 * Find a registered decoder with a matching codec ID.
4667 * @param id AVCodecID of the requested decoder
4668 * @return A decoder if one was found, NULL otherwise.
4670 AVCodec *avcodec_find_decoder(enum AVCodecID id);
4673 * Find a registered decoder with the specified name.
4675 * @param name name of the requested decoder
4676 * @return A decoder if one was found, NULL otherwise.
4678 AVCodec *avcodec_find_decoder_by_name(const char *name);
4681 * The default callback for AVCodecContext.get_buffer2(). It is made public so
4682 * it can be called by custom get_buffer2() implementations for decoders without
4683 * AV_CODEC_CAP_DR1 set.
4685 int avcodec_default_get_buffer2(AVCodecContext *s, AVFrame *frame, int flags);
4688 * Modify width and height values so that they will result in a memory
4689 * buffer that is acceptable for the codec if you do not use any horizontal
4692 * May only be used if a codec with AV_CODEC_CAP_DR1 has been opened.
4694 void avcodec_align_dimensions(AVCodecContext *s, int *width, int *height);
4697 * Modify width and height values so that they will result in a memory
4698 * buffer that is acceptable for the codec if you also ensure that all
4699 * line sizes are a multiple of the respective linesize_align[i].
4701 * May only be used if a codec with AV_CODEC_CAP_DR1 has been opened.
4703 void avcodec_align_dimensions2(AVCodecContext *s, int *width, int *height,
4704 int linesize_align[AV_NUM_DATA_POINTERS]);
4707 * Converts AVChromaLocation to swscale x/y chroma position.
4709 * The positions represent the chroma (0,0) position in a coordinates system
4710 * with luma (0,0) representing the origin and luma(1,1) representing 256,256
4712 * @param xpos horizontal chroma sample position
4713 * @param ypos vertical chroma sample position
4715 int avcodec_enum_to_chroma_pos(int *xpos, int *ypos, enum AVChromaLocation pos);
4718 * Converts swscale x/y chroma position to AVChromaLocation.
4720 * The positions represent the chroma (0,0) position in a coordinates system
4721 * with luma (0,0) representing the origin and luma(1,1) representing 256,256
4723 * @param xpos horizontal chroma sample position
4724 * @param ypos vertical chroma sample position
4726 enum AVChromaLocation avcodec_chroma_pos_to_enum(int xpos, int ypos);
4729 * Decode the audio frame of size avpkt->size from avpkt->data into frame.
4731 * Some decoders may support multiple frames in a single AVPacket. Such
4732 * decoders would then just decode the first frame and the return value would be
4733 * less than the packet size. In this case, avcodec_decode_audio4 has to be
4734 * called again with an AVPacket containing the remaining data in order to
4735 * decode the second frame, etc... Even if no frames are returned, the packet
4736 * needs to be fed to the decoder with remaining data until it is completely
4737 * consumed or an error occurs.
4739 * Some decoders (those marked with AV_CODEC_CAP_DELAY) have a delay between input
4740 * and output. This means that for some packets they will not immediately
4741 * produce decoded output and need to be flushed at the end of decoding to get
4742 * all the decoded data. Flushing is done by calling this function with packets
4743 * with avpkt->data set to NULL and avpkt->size set to 0 until it stops
4744 * returning samples. It is safe to flush even those decoders that are not
4745 * marked with AV_CODEC_CAP_DELAY, then no samples will be returned.
4747 * @warning The input buffer, avpkt->data must be AV_INPUT_BUFFER_PADDING_SIZE
4748 * larger than the actual read bytes because some optimized bitstream
4749 * readers read 32 or 64 bits at once and could read over the end.
4751 * @note The AVCodecContext MUST have been opened with @ref avcodec_open2()
4752 * before packets may be fed to the decoder.
4754 * @param avctx the codec context
4755 * @param[out] frame The AVFrame in which to store decoded audio samples.
4756 * The decoder will allocate a buffer for the decoded frame by
4757 * calling the AVCodecContext.get_buffer2() callback.
4758 * When AVCodecContext.refcounted_frames is set to 1, the frame is
4759 * reference counted and the returned reference belongs to the
4760 * caller. The caller must release the frame using av_frame_unref()
4761 * when the frame is no longer needed. The caller may safely write
4762 * to the frame if av_frame_is_writable() returns 1.
4763 * When AVCodecContext.refcounted_frames is set to 0, the returned
4764 * reference belongs to the decoder and is valid only until the
4765 * next call to this function or until closing or flushing the
4766 * decoder. The caller may not write to it.
4767 * @param[out] got_frame_ptr Zero if no frame could be decoded, otherwise it is
4768 * non-zero. Note that this field being set to zero
4769 * does not mean that an error has occurred. For
4770 * decoders with AV_CODEC_CAP_DELAY set, no given decode
4771 * call is guaranteed to produce a frame.
4772 * @param[in] avpkt The input AVPacket containing the input buffer.
4773 * At least avpkt->data and avpkt->size should be set. Some
4774 * decoders might also require additional fields to be set.
4775 * @return A negative error code is returned if an error occurred during
4776 * decoding, otherwise the number of bytes consumed from the input
4777 * AVPacket is returned.
4779 * @deprecated Use avcodec_send_packet() and avcodec_receive_frame().
4781 attribute_deprecated
4782 int avcodec_decode_audio4(AVCodecContext *avctx, AVFrame *frame,
4783 int *got_frame_ptr, const AVPacket *avpkt);
4786 * Decode the video frame of size avpkt->size from avpkt->data into picture.
4787 * Some decoders may support multiple frames in a single AVPacket, such
4788 * decoders would then just decode the first frame.
4790 * @warning The input buffer must be AV_INPUT_BUFFER_PADDING_SIZE larger than
4791 * the actual read bytes because some optimized bitstream readers read 32 or 64
4792 * bits at once and could read over the end.
4794 * @warning The end of the input buffer buf should be set to 0 to ensure that
4795 * no overreading happens for damaged MPEG streams.
4797 * @note Codecs which have the AV_CODEC_CAP_DELAY capability set have a delay
4798 * between input and output, these need to be fed with avpkt->data=NULL,
4799 * avpkt->size=0 at the end to return the remaining frames.
4801 * @note The AVCodecContext MUST have been opened with @ref avcodec_open2()
4802 * before packets may be fed to the decoder.
4804 * @param avctx the codec context
4805 * @param[out] picture The AVFrame in which the decoded video frame will be stored.
4806 * Use av_frame_alloc() to get an AVFrame. The codec will
4807 * allocate memory for the actual bitmap by calling the
4808 * AVCodecContext.get_buffer2() callback.
4809 * When AVCodecContext.refcounted_frames is set to 1, the frame is
4810 * reference counted and the returned reference belongs to the
4811 * caller. The caller must release the frame using av_frame_unref()
4812 * when the frame is no longer needed. The caller may safely write
4813 * to the frame if av_frame_is_writable() returns 1.
4814 * When AVCodecContext.refcounted_frames is set to 0, the returned
4815 * reference belongs to the decoder and is valid only until the
4816 * next call to this function or until closing or flushing the
4817 * decoder. The caller may not write to it.
4819 * @param[in] avpkt The input AVPacket containing the input buffer.
4820 * You can create such packet with av_init_packet() and by then setting
4821 * data and size, some decoders might in addition need other fields like
4822 * flags&AV_PKT_FLAG_KEY. All decoders are designed to use the least
4824 * @param[in,out] got_picture_ptr Zero if no frame could be decompressed, otherwise, it is nonzero.
4825 * @return On error a negative value is returned, otherwise the number of bytes
4826 * used or zero if no frame could be decompressed.
4828 * @deprecated Use avcodec_send_packet() and avcodec_receive_frame().
4830 attribute_deprecated
4831 int avcodec_decode_video2(AVCodecContext *avctx, AVFrame *picture,
4832 int *got_picture_ptr,
4833 const AVPacket *avpkt);
4836 * Decode a subtitle message.
4837 * Return a negative value on error, otherwise return the number of bytes used.
4838 * If no subtitle could be decompressed, got_sub_ptr is zero.
4839 * Otherwise, the subtitle is stored in *sub.
4840 * Note that AV_CODEC_CAP_DR1 is not available for subtitle codecs. This is for
4841 * simplicity, because the performance difference is expect to be negligible
4842 * and reusing a get_buffer written for video codecs would probably perform badly
4843 * due to a potentially very different allocation pattern.
4845 * Some decoders (those marked with AV_CODEC_CAP_DELAY) have a delay between input
4846 * and output. This means that for some packets they will not immediately
4847 * produce decoded output and need to be flushed at the end of decoding to get
4848 * all the decoded data. Flushing is done by calling this function with packets
4849 * with avpkt->data set to NULL and avpkt->size set to 0 until it stops
4850 * returning subtitles. It is safe to flush even those decoders that are not
4851 * marked with AV_CODEC_CAP_DELAY, then no subtitles will be returned.
4853 * @note The AVCodecContext MUST have been opened with @ref avcodec_open2()
4854 * before packets may be fed to the decoder.
4856 * @param avctx the codec context
4857 * @param[out] sub The Preallocated AVSubtitle in which the decoded subtitle will be stored,
4858 * must be freed with avsubtitle_free if *got_sub_ptr is set.
4859 * @param[in,out] got_sub_ptr Zero if no subtitle could be decompressed, otherwise, it is nonzero.
4860 * @param[in] avpkt The input AVPacket containing the input buffer.
4862 int avcodec_decode_subtitle2(AVCodecContext *avctx, AVSubtitle *sub,
4867 * Supply raw packet data as input to a decoder.
4869 * Internally, this call will copy relevant AVCodecContext fields, which can
4870 * influence decoding per-packet, and apply them when the packet is actually
4871 * decoded. (For example AVCodecContext.skip_frame, which might direct the
4872 * decoder to drop the frame contained by the packet sent with this function.)
4874 * @warning The input buffer, avpkt->data must be AV_INPUT_BUFFER_PADDING_SIZE
4875 * larger than the actual read bytes because some optimized bitstream
4876 * readers read 32 or 64 bits at once and could read over the end.
4878 * @warning Do not mix this API with the legacy API (like avcodec_decode_video2())
4879 * on the same AVCodecContext. It will return unexpected results now
4880 * or in future libavcodec versions.
4882 * @note The AVCodecContext MUST have been opened with @ref avcodec_open2()
4883 * before packets may be fed to the decoder.
4885 * @param avctx codec context
4886 * @param[in] avpkt The input AVPacket. Usually, this will be a single video
4887 * frame, or several complete audio frames.
4888 * Ownership of the packet remains with the caller, and the
4889 * decoder will not write to the packet. The decoder may create
4890 * a reference to the packet data (or copy it if the packet is
4891 * not reference-counted).
4892 * Unlike with older APIs, the packet is always fully consumed,
4893 * and if it contains multiple frames (e.g. some audio codecs),
4894 * will require you to call avcodec_receive_frame() multiple
4895 * times afterwards before you can send a new packet.
4896 * It can be NULL (or an AVPacket with data set to NULL and
4897 * size set to 0); in this case, it is considered a flush
4898 * packet, which signals the end of the stream. Sending the
4899 * first flush packet will return success. Subsequent ones are
4900 * unnecessary and will return AVERROR_EOF. If the decoder
4901 * still has frames buffered, it will return them after sending
4904 * @return 0 on success, otherwise negative error code:
4905 * AVERROR(EAGAIN): input is not accepted in the current state - user
4906 * must read output with avcodec_receive_frame() (once
4907 * all output is read, the packet should be resent, and
4908 * the call will not fail with EAGAIN).
4909 * AVERROR_EOF: the decoder has been flushed, and no new packets can
4910 * be sent to it (also returned if more than 1 flush
4912 * AVERROR(EINVAL): codec not opened, it is an encoder, or requires flush
4913 * AVERROR(ENOMEM): failed to add packet to internal queue, or similar
4914 * other errors: legitimate decoding errors
4916 int avcodec_send_packet(AVCodecContext *avctx, const AVPacket *avpkt);
4919 * Return decoded output data from a decoder.
4921 * @param avctx codec context
4922 * @param frame This will be set to a reference-counted video or audio
4923 * frame (depending on the decoder type) allocated by the
4924 * decoder. Note that the function will always call
4925 * av_frame_unref(frame) before doing anything else.
4928 * 0: success, a frame was returned
4929 * AVERROR(EAGAIN): output is not available in this state - user must try
4931 * AVERROR_EOF: the decoder has been fully flushed, and there will be
4932 * no more output frames
4933 * AVERROR(EINVAL): codec not opened, or it is an encoder
4934 * AVERROR_INPUT_CHANGED: current decoded frame has changed parameters
4935 * with respect to first decoded frame. Applicable
4936 * when flag AV_CODEC_FLAG_DROPCHANGED is set.
4937 * other negative values: legitimate decoding errors
4939 int avcodec_receive_frame(AVCodecContext *avctx, AVFrame *frame);
4942 * Supply a raw video or audio frame to the encoder. Use avcodec_receive_packet()
4943 * to retrieve buffered output packets.
4945 * @param avctx codec context
4946 * @param[in] frame AVFrame containing the raw audio or video frame to be encoded.
4947 * Ownership of the frame remains with the caller, and the
4948 * encoder will not write to the frame. The encoder may create
4949 * a reference to the frame data (or copy it if the frame is
4950 * not reference-counted).
4951 * It can be NULL, in which case it is considered a flush
4952 * packet. This signals the end of the stream. If the encoder
4953 * still has packets buffered, it will return them after this
4954 * call. Once flushing mode has been entered, additional flush
4955 * packets are ignored, and sending frames will return
4959 * If AV_CODEC_CAP_VARIABLE_FRAME_SIZE is set, then each frame
4960 * can have any number of samples.
4961 * If it is not set, frame->nb_samples must be equal to
4962 * avctx->frame_size for all frames except the last.
4963 * The final frame may be smaller than avctx->frame_size.
4964 * @return 0 on success, otherwise negative error code:
4965 * AVERROR(EAGAIN): input is not accepted in the current state - user
4966 * must read output with avcodec_receive_packet() (once
4967 * all output is read, the packet should be resent, and
4968 * the call will not fail with EAGAIN).
4969 * AVERROR_EOF: the encoder has been flushed, and no new frames can
4971 * AVERROR(EINVAL): codec not opened, refcounted_frames not set, it is a
4972 * decoder, or requires flush
4973 * AVERROR(ENOMEM): failed to add packet to internal queue, or similar
4974 * other errors: legitimate decoding errors
4976 int avcodec_send_frame(AVCodecContext *avctx, const AVFrame *frame);
4979 * Read encoded data from the encoder.
4981 * @param avctx codec context
4982 * @param avpkt This will be set to a reference-counted packet allocated by the
4983 * encoder. Note that the function will always call
4984 * av_frame_unref(frame) before doing anything else.
4985 * @return 0 on success, otherwise negative error code:
4986 * AVERROR(EAGAIN): output is not available in the current state - user
4987 * must try to send input
4988 * AVERROR_EOF: the encoder has been fully flushed, and there will be
4989 * no more output packets
4990 * AVERROR(EINVAL): codec not opened, or it is an encoder
4991 * other errors: legitimate decoding errors
4993 int avcodec_receive_packet(AVCodecContext *avctx, AVPacket *avpkt);
4996 * Create and return a AVHWFramesContext with values adequate for hardware
4997 * decoding. This is meant to get called from the get_format callback, and is
4998 * a helper for preparing a AVHWFramesContext for AVCodecContext.hw_frames_ctx.
4999 * This API is for decoding with certain hardware acceleration modes/APIs only.
5001 * The returned AVHWFramesContext is not initialized. The caller must do this
5002 * with av_hwframe_ctx_init().
5004 * Calling this function is not a requirement, but makes it simpler to avoid
5005 * codec or hardware API specific details when manually allocating frames.
5007 * Alternatively to this, an API user can set AVCodecContext.hw_device_ctx,
5008 * which sets up AVCodecContext.hw_frames_ctx fully automatically, and makes
5009 * it unnecessary to call this function or having to care about
5010 * AVHWFramesContext initialization at all.
5012 * There are a number of requirements for calling this function:
5014 * - It must be called from get_format with the same avctx parameter that was
5015 * passed to get_format. Calling it outside of get_format is not allowed, and
5016 * can trigger undefined behavior.
5017 * - The function is not always supported (see description of return values).
5018 * Even if this function returns successfully, hwaccel initialization could
5019 * fail later. (The degree to which implementations check whether the stream
5020 * is actually supported varies. Some do this check only after the user's
5021 * get_format callback returns.)
5022 * - The hw_pix_fmt must be one of the choices suggested by get_format. If the
5023 * user decides to use a AVHWFramesContext prepared with this API function,
5024 * the user must return the same hw_pix_fmt from get_format.
5025 * - The device_ref passed to this function must support the given hw_pix_fmt.
5026 * - After calling this API function, it is the user's responsibility to
5027 * initialize the AVHWFramesContext (returned by the out_frames_ref parameter),
5028 * and to set AVCodecContext.hw_frames_ctx to it. If done, this must be done
5029 * before returning from get_format (this is implied by the normal
5030 * AVCodecContext.hw_frames_ctx API rules).
5031 * - The AVHWFramesContext parameters may change every time time get_format is
5032 * called. Also, AVCodecContext.hw_frames_ctx is reset before get_format. So
5033 * you are inherently required to go through this process again on every
5035 * - It is perfectly possible to call this function without actually using
5036 * the resulting AVHWFramesContext. One use-case might be trying to reuse a
5037 * previously initialized AVHWFramesContext, and calling this API function
5038 * only to test whether the required frame parameters have changed.
5039 * - Fields that use dynamically allocated values of any kind must not be set
5040 * by the user unless setting them is explicitly allowed by the documentation.
5041 * If the user sets AVHWFramesContext.free and AVHWFramesContext.user_opaque,
5042 * the new free callback must call the potentially set previous free callback.
5043 * This API call may set any dynamically allocated fields, including the free
5046 * The function will set at least the following fields on AVHWFramesContext
5047 * (potentially more, depending on hwaccel API):
5049 * - All fields set by av_hwframe_ctx_alloc().
5050 * - Set the format field to hw_pix_fmt.
5051 * - Set the sw_format field to the most suited and most versatile format. (An
5052 * implication is that this will prefer generic formats over opaque formats
5053 * with arbitrary restrictions, if possible.)
5054 * - Set the width/height fields to the coded frame size, rounded up to the
5055 * API-specific minimum alignment.
5056 * - Only _if_ the hwaccel requires a pre-allocated pool: set the initial_pool_size
5057 * field to the number of maximum reference surfaces possible with the codec,
5058 * plus 1 surface for the user to work (meaning the user can safely reference
5059 * at most 1 decoded surface at a time), plus additional buffering introduced
5060 * by frame threading. If the hwaccel does not require pre-allocation, the
5061 * field is left to 0, and the decoder will allocate new surfaces on demand
5063 * - Possibly AVHWFramesContext.hwctx fields, depending on the underlying
5066 * Essentially, out_frames_ref returns the same as av_hwframe_ctx_alloc(), but
5067 * with basic frame parameters set.
5069 * The function is stateless, and does not change the AVCodecContext or the
5070 * device_ref AVHWDeviceContext.
5072 * @param avctx The context which is currently calling get_format, and which
5073 * implicitly contains all state needed for filling the returned
5074 * AVHWFramesContext properly.
5075 * @param device_ref A reference to the AVHWDeviceContext describing the device
5076 * which will be used by the hardware decoder.
5077 * @param hw_pix_fmt The hwaccel format you are going to return from get_format.
5078 * @param out_frames_ref On success, set to a reference to an _uninitialized_
5079 * AVHWFramesContext, created from the given device_ref.
5080 * Fields will be set to values required for decoding.
5081 * Not changed if an error is returned.
5082 * @return zero on success, a negative value on error. The following error codes
5083 * have special semantics:
5084 * AVERROR(ENOENT): the decoder does not support this functionality. Setup
5085 * is always manual, or it is a decoder which does not
5086 * support setting AVCodecContext.hw_frames_ctx at all,
5087 * or it is a software format.
5088 * AVERROR(EINVAL): it is known that hardware decoding is not supported for
5089 * this configuration, or the device_ref is not supported
5090 * for the hwaccel referenced by hw_pix_fmt.
5092 int avcodec_get_hw_frames_parameters(AVCodecContext *avctx,
5093 AVBufferRef *device_ref,
5094 enum AVPixelFormat hw_pix_fmt,
5095 AVBufferRef **out_frames_ref);
5100 * @defgroup lavc_parsing Frame parsing
5104 enum AVPictureStructure {
5105 AV_PICTURE_STRUCTURE_UNKNOWN, //< unknown
5106 AV_PICTURE_STRUCTURE_TOP_FIELD, //< coded as top field
5107 AV_PICTURE_STRUCTURE_BOTTOM_FIELD, //< coded as bottom field
5108 AV_PICTURE_STRUCTURE_FRAME, //< coded as frame
5111 typedef struct AVCodecParserContext {
5113 struct AVCodecParser *parser;
5114 int64_t frame_offset; /* offset of the current frame */
5115 int64_t cur_offset; /* current offset
5116 (incremented by each av_parser_parse()) */
5117 int64_t next_frame_offset; /* offset of the next frame */
5119 int pict_type; /* XXX: Put it back in AVCodecContext. */
5121 * This field is used for proper frame duration computation in lavf.
5122 * It signals, how much longer the frame duration of the current frame
5123 * is compared to normal frame duration.
5125 * frame_duration = (1 + repeat_pict) * time_base
5127 * It is used by codecs like H.264 to display telecined material.
5129 int repeat_pict; /* XXX: Put it back in AVCodecContext. */
5130 int64_t pts; /* pts of the current frame */
5131 int64_t dts; /* dts of the current frame */
5136 int fetch_timestamp;
5138 #define AV_PARSER_PTS_NB 4
5139 int cur_frame_start_index;
5140 int64_t cur_frame_offset[AV_PARSER_PTS_NB];
5141 int64_t cur_frame_pts[AV_PARSER_PTS_NB];
5142 int64_t cur_frame_dts[AV_PARSER_PTS_NB];
5145 #define PARSER_FLAG_COMPLETE_FRAMES 0x0001
5146 #define PARSER_FLAG_ONCE 0x0002
5147 /// Set if the parser has a valid file offset
5148 #define PARSER_FLAG_FETCHED_OFFSET 0x0004
5149 #define PARSER_FLAG_USE_CODEC_TS 0x1000
5151 int64_t offset; ///< byte offset from starting packet start
5152 int64_t cur_frame_end[AV_PARSER_PTS_NB];
5155 * Set by parser to 1 for key frames and 0 for non-key frames.
5156 * It is initialized to -1, so if the parser doesn't set this flag,
5157 * old-style fallback using AV_PICTURE_TYPE_I picture type as key frames
5162 #if FF_API_CONVERGENCE_DURATION
5164 * @deprecated unused
5166 attribute_deprecated
5167 int64_t convergence_duration;
5170 // Timestamp generation support:
5172 * Synchronization point for start of timestamp generation.
5174 * Set to >0 for sync point, 0 for no sync point and <0 for undefined
5177 * For example, this corresponds to presence of H.264 buffering period
5183 * Offset of the current timestamp against last timestamp sync point in
5184 * units of AVCodecContext.time_base.
5186 * Set to INT_MIN when dts_sync_point unused. Otherwise, it must
5187 * contain a valid timestamp offset.
5189 * Note that the timestamp of sync point has usually a nonzero
5190 * dts_ref_dts_delta, which refers to the previous sync point. Offset of
5191 * the next frame after timestamp sync point will be usually 1.
5193 * For example, this corresponds to H.264 cpb_removal_delay.
5195 int dts_ref_dts_delta;
5198 * Presentation delay of current frame in units of AVCodecContext.time_base.
5200 * Set to INT_MIN when dts_sync_point unused. Otherwise, it must
5201 * contain valid non-negative timestamp delta (presentation time of a frame
5202 * must not lie in the past).
5204 * This delay represents the difference between decoding and presentation
5205 * time of the frame.
5207 * For example, this corresponds to H.264 dpb_output_delay.
5212 * Position of the packet in file.
5214 * Analogous to cur_frame_pts/dts
5216 int64_t cur_frame_pos[AV_PARSER_PTS_NB];
5219 * Byte position of currently parsed frame in stream.
5224 * Previous frame byte position.
5229 * Duration of the current frame.
5230 * For audio, this is in units of 1 / AVCodecContext.sample_rate.
5231 * For all other types, this is in units of AVCodecContext.time_base.
5235 enum AVFieldOrder field_order;
5238 * Indicate whether a picture is coded as a frame, top field or bottom field.
5240 * For example, H.264 field_pic_flag equal to 0 corresponds to
5241 * AV_PICTURE_STRUCTURE_FRAME. An H.264 picture with field_pic_flag
5242 * equal to 1 and bottom_field_flag equal to 0 corresponds to
5243 * AV_PICTURE_STRUCTURE_TOP_FIELD.
5245 enum AVPictureStructure picture_structure;
5248 * Picture number incremented in presentation or output order.
5249 * This field may be reinitialized at the first picture of a new sequence.
5251 * For example, this corresponds to H.264 PicOrderCnt.
5253 int output_picture_number;
5256 * Dimensions of the decoded video intended for presentation.
5262 * Dimensions of the coded video.
5268 * The format of the coded data, corresponds to enum AVPixelFormat for video
5269 * and for enum AVSampleFormat for audio.
5271 * Note that a decoder can have considerable freedom in how exactly it
5272 * decodes the data, so the format reported here might be different from the
5273 * one returned by a decoder.
5276 } AVCodecParserContext;
5278 typedef struct AVCodecParser {
5279 int codec_ids[5]; /* several codec IDs are permitted */
5281 int (*parser_init)(AVCodecParserContext *s);
5282 /* This callback never returns an error, a negative value means that
5283 * the frame start was in a previous packet. */
5284 int (*parser_parse)(AVCodecParserContext *s,
5285 AVCodecContext *avctx,
5286 const uint8_t **poutbuf, int *poutbuf_size,
5287 const uint8_t *buf, int buf_size);
5288 void (*parser_close)(AVCodecParserContext *s);
5289 int (*split)(AVCodecContext *avctx, const uint8_t *buf, int buf_size);
5290 struct AVCodecParser *next;
5294 * Iterate over all registered codec parsers.
5296 * @param opaque a pointer where libavcodec will store the iteration state. Must
5297 * point to NULL to start the iteration.
5299 * @return the next registered codec parser or NULL when the iteration is
5302 const AVCodecParser *av_parser_iterate(void **opaque);
5304 attribute_deprecated
5305 AVCodecParser *av_parser_next(const AVCodecParser *c);
5307 attribute_deprecated
5308 void av_register_codec_parser(AVCodecParser *parser);
5309 AVCodecParserContext *av_parser_init(int codec_id);
5314 * @param s parser context.
5315 * @param avctx codec context.
5316 * @param poutbuf set to pointer to parsed buffer or NULL if not yet finished.
5317 * @param poutbuf_size set to size of parsed buffer or zero if not yet finished.
5318 * @param buf input buffer.
5319 * @param buf_size buffer size in bytes without the padding. I.e. the full buffer
5320 size is assumed to be buf_size + AV_INPUT_BUFFER_PADDING_SIZE.
5321 To signal EOF, this should be 0 (so that the last frame
5323 * @param pts input presentation timestamp.
5324 * @param dts input decoding timestamp.
5325 * @param pos input byte position in stream.
5326 * @return the number of bytes of the input bitstream used.
5331 * len = av_parser_parse2(myparser, AVCodecContext, &data, &size,
5338 * decode_frame(data, size);
5342 int av_parser_parse2(AVCodecParserContext *s,
5343 AVCodecContext *avctx,
5344 uint8_t **poutbuf, int *poutbuf_size,
5345 const uint8_t *buf, int buf_size,
5346 int64_t pts, int64_t dts,
5350 * @return 0 if the output buffer is a subset of the input, 1 if it is allocated and must be freed
5351 * @deprecated use AVBitStreamFilter
5353 int av_parser_change(AVCodecParserContext *s,
5354 AVCodecContext *avctx,
5355 uint8_t **poutbuf, int *poutbuf_size,
5356 const uint8_t *buf, int buf_size, int keyframe);
5357 void av_parser_close(AVCodecParserContext *s);
5365 * @addtogroup lavc_encoding
5370 * Find a registered encoder with a matching codec ID.
5372 * @param id AVCodecID of the requested encoder
5373 * @return An encoder if one was found, NULL otherwise.
5375 AVCodec *avcodec_find_encoder(enum AVCodecID id);
5378 * Find a registered encoder with the specified name.
5380 * @param name name of the requested encoder
5381 * @return An encoder if one was found, NULL otherwise.
5383 AVCodec *avcodec_find_encoder_by_name(const char *name);
5386 * Encode a frame of audio.
5388 * Takes input samples from frame and writes the next output packet, if
5389 * available, to avpkt. The output packet does not necessarily contain data for
5390 * the most recent frame, as encoders can delay, split, and combine input frames
5391 * internally as needed.
5393 * @param avctx codec context
5394 * @param avpkt output AVPacket.
5395 * The user can supply an output buffer by setting
5396 * avpkt->data and avpkt->size prior to calling the
5397 * function, but if the size of the user-provided data is not
5398 * large enough, encoding will fail. If avpkt->data and
5399 * avpkt->size are set, avpkt->destruct must also be set. All
5400 * other AVPacket fields will be reset by the encoder using
5401 * av_init_packet(). If avpkt->data is NULL, the encoder will
5402 * allocate it. The encoder will set avpkt->size to the size
5403 * of the output packet.
5405 * If this function fails or produces no output, avpkt will be
5406 * freed using av_packet_unref().
5407 * @param[in] frame AVFrame containing the raw audio data to be encoded.
5408 * May be NULL when flushing an encoder that has the
5409 * AV_CODEC_CAP_DELAY capability set.
5410 * If AV_CODEC_CAP_VARIABLE_FRAME_SIZE is set, then each frame
5411 * can have any number of samples.
5412 * If it is not set, frame->nb_samples must be equal to
5413 * avctx->frame_size for all frames except the last.
5414 * The final frame may be smaller than avctx->frame_size.
5415 * @param[out] got_packet_ptr This field is set to 1 by libavcodec if the
5416 * output packet is non-empty, and to 0 if it is
5417 * empty. If the function returns an error, the
5418 * packet can be assumed to be invalid, and the
5419 * value of got_packet_ptr is undefined and should
5421 * @return 0 on success, negative error code on failure
5423 * @deprecated use avcodec_send_frame()/avcodec_receive_packet() instead
5425 attribute_deprecated
5426 int avcodec_encode_audio2(AVCodecContext *avctx, AVPacket *avpkt,
5427 const AVFrame *frame, int *got_packet_ptr);
5430 * Encode a frame of video.
5432 * Takes input raw video data from frame and writes the next output packet, if
5433 * available, to avpkt. The output packet does not necessarily contain data for
5434 * the most recent frame, as encoders can delay and reorder input frames
5435 * internally as needed.
5437 * @param avctx codec context
5438 * @param avpkt output AVPacket.
5439 * The user can supply an output buffer by setting
5440 * avpkt->data and avpkt->size prior to calling the
5441 * function, but if the size of the user-provided data is not
5442 * large enough, encoding will fail. All other AVPacket fields
5443 * will be reset by the encoder using av_init_packet(). If
5444 * avpkt->data is NULL, the encoder will allocate it.
5445 * The encoder will set avpkt->size to the size of the
5446 * output packet. The returned data (if any) belongs to the
5447 * caller, he is responsible for freeing it.
5449 * If this function fails or produces no output, avpkt will be
5450 * freed using av_packet_unref().
5451 * @param[in] frame AVFrame containing the raw video data to be encoded.
5452 * May be NULL when flushing an encoder that has the
5453 * AV_CODEC_CAP_DELAY capability set.
5454 * @param[out] got_packet_ptr This field is set to 1 by libavcodec if the
5455 * output packet is non-empty, and to 0 if it is
5456 * empty. If the function returns an error, the
5457 * packet can be assumed to be invalid, and the
5458 * value of got_packet_ptr is undefined and should
5460 * @return 0 on success, negative error code on failure
5462 * @deprecated use avcodec_send_frame()/avcodec_receive_packet() instead
5464 attribute_deprecated
5465 int avcodec_encode_video2(AVCodecContext *avctx, AVPacket *avpkt,
5466 const AVFrame *frame, int *got_packet_ptr);
5468 int avcodec_encode_subtitle(AVCodecContext *avctx, uint8_t *buf, int buf_size,
5469 const AVSubtitle *sub);
5476 #if FF_API_AVPICTURE
5478 * @addtogroup lavc_picture
5483 * @deprecated unused
5485 attribute_deprecated
5486 int avpicture_alloc(AVPicture *picture, enum AVPixelFormat pix_fmt, int width, int height);
5489 * @deprecated unused
5491 attribute_deprecated
5492 void avpicture_free(AVPicture *picture);
5495 * @deprecated use av_image_fill_arrays() instead.
5497 attribute_deprecated
5498 int avpicture_fill(AVPicture *picture, const uint8_t *ptr,
5499 enum AVPixelFormat pix_fmt, int width, int height);
5502 * @deprecated use av_image_copy_to_buffer() instead.
5504 attribute_deprecated
5505 int avpicture_layout(const AVPicture *src, enum AVPixelFormat pix_fmt,
5506 int width, int height,
5507 unsigned char *dest, int dest_size);
5510 * @deprecated use av_image_get_buffer_size() instead.
5512 attribute_deprecated
5513 int avpicture_get_size(enum AVPixelFormat pix_fmt, int width, int height);
5516 * @deprecated av_image_copy() instead.
5518 attribute_deprecated
5519 void av_picture_copy(AVPicture *dst, const AVPicture *src,
5520 enum AVPixelFormat pix_fmt, int width, int height);
5523 * @deprecated unused
5525 attribute_deprecated
5526 int av_picture_crop(AVPicture *dst, const AVPicture *src,
5527 enum AVPixelFormat pix_fmt, int top_band, int left_band);
5530 * @deprecated unused
5532 attribute_deprecated
5533 int av_picture_pad(AVPicture *dst, const AVPicture *src, int height, int width, enum AVPixelFormat pix_fmt,
5534 int padtop, int padbottom, int padleft, int padright, int *color);
5542 * @defgroup lavc_misc Utility functions
5545 * Miscellaneous utility functions related to both encoding and decoding
5551 * @defgroup lavc_misc_pixfmt Pixel formats
5553 * Functions for working with pixel formats.
5557 #if FF_API_GETCHROMA
5559 * @deprecated Use av_pix_fmt_get_chroma_sub_sample
5562 attribute_deprecated
5563 void avcodec_get_chroma_sub_sample(enum AVPixelFormat pix_fmt, int *h_shift, int *v_shift);
5567 * Return a value representing the fourCC code associated to the
5568 * pixel format pix_fmt, or 0 if no associated fourCC code can be
5571 unsigned int avcodec_pix_fmt_to_codec_tag(enum AVPixelFormat pix_fmt);
5574 * @deprecated see av_get_pix_fmt_loss()
5576 int avcodec_get_pix_fmt_loss(enum AVPixelFormat dst_pix_fmt, enum AVPixelFormat src_pix_fmt,
5580 * Find the best pixel format to convert to given a certain source pixel
5581 * format. When converting from one pixel format to another, information loss
5582 * may occur. For example, when converting from RGB24 to GRAY, the color
5583 * information will be lost. Similarly, other losses occur when converting from
5584 * some formats to other formats. avcodec_find_best_pix_fmt_of_2() searches which of
5585 * the given pixel formats should be used to suffer the least amount of loss.
5586 * The pixel formats from which it chooses one, are determined by the
5587 * pix_fmt_list parameter.
5590 * @param[in] pix_fmt_list AV_PIX_FMT_NONE terminated array of pixel formats to choose from
5591 * @param[in] src_pix_fmt source pixel format
5592 * @param[in] has_alpha Whether the source pixel format alpha channel is used.
5593 * @param[out] loss_ptr Combination of flags informing you what kind of losses will occur.
5594 * @return The best pixel format to convert to or -1 if none was found.
5596 enum AVPixelFormat avcodec_find_best_pix_fmt_of_list(const enum AVPixelFormat *pix_fmt_list,
5597 enum AVPixelFormat src_pix_fmt,
5598 int has_alpha, int *loss_ptr);
5601 * @deprecated see av_find_best_pix_fmt_of_2()
5603 enum AVPixelFormat avcodec_find_best_pix_fmt_of_2(enum AVPixelFormat dst_pix_fmt1, enum AVPixelFormat dst_pix_fmt2,
5604 enum AVPixelFormat src_pix_fmt, int has_alpha, int *loss_ptr);
5606 attribute_deprecated
5607 enum AVPixelFormat avcodec_find_best_pix_fmt2(enum AVPixelFormat dst_pix_fmt1, enum AVPixelFormat dst_pix_fmt2,
5608 enum AVPixelFormat src_pix_fmt, int has_alpha, int *loss_ptr);
5610 enum AVPixelFormat avcodec_default_get_format(struct AVCodecContext *s, const enum AVPixelFormat * fmt);
5616 #if FF_API_TAG_STRING
5618 * Put a string representing the codec tag codec_tag in buf.
5620 * @param buf buffer to place codec tag in
5621 * @param buf_size size in bytes of buf
5622 * @param codec_tag codec tag to assign
5623 * @return the length of the string that would have been generated if
5624 * enough space had been available, excluding the trailing null
5626 * @deprecated see av_fourcc_make_string() and av_fourcc2str().
5628 attribute_deprecated
5629 size_t av_get_codec_tag_string(char *buf, size_t buf_size, unsigned int codec_tag);
5632 void avcodec_string(char *buf, int buf_size, AVCodecContext *enc, int encode);
5635 * Return a name for the specified profile, if available.
5637 * @param codec the codec that is searched for the given profile
5638 * @param profile the profile value for which a name is requested
5639 * @return A name for the profile if found, NULL otherwise.
5641 const char *av_get_profile_name(const AVCodec *codec, int profile);
5644 * Return a name for the specified profile, if available.
5646 * @param codec_id the ID of the codec to which the requested profile belongs
5647 * @param profile the profile value for which a name is requested
5648 * @return A name for the profile if found, NULL otherwise.
5650 * @note unlike av_get_profile_name(), which searches a list of profiles
5651 * supported by a specific decoder or encoder implementation, this
5652 * function searches the list of profiles from the AVCodecDescriptor
5654 const char *avcodec_profile_name(enum AVCodecID codec_id, int profile);
5656 int avcodec_default_execute(AVCodecContext *c, int (*func)(AVCodecContext *c2, void *arg2),void *arg, int *ret, int count, int size);
5657 int avcodec_default_execute2(AVCodecContext *c, int (*func)(AVCodecContext *c2, void *arg2, int, int),void *arg, int *ret, int count);
5658 //FIXME func typedef
5661 * Fill AVFrame audio data and linesize pointers.
5663 * The buffer buf must be a preallocated buffer with a size big enough
5664 * to contain the specified samples amount. The filled AVFrame data
5665 * pointers will point to this buffer.
5667 * AVFrame extended_data channel pointers are allocated if necessary for
5670 * @param frame the AVFrame
5671 * frame->nb_samples must be set prior to calling the
5672 * function. This function fills in frame->data,
5673 * frame->extended_data, frame->linesize[0].
5674 * @param nb_channels channel count
5675 * @param sample_fmt sample format
5676 * @param buf buffer to use for frame data
5677 * @param buf_size size of buffer
5678 * @param align plane size sample alignment (0 = default)
5679 * @return >=0 on success, negative error code on failure
5680 * @todo return the size in bytes required to store the samples in
5681 * case of success, at the next libavutil bump
5683 int avcodec_fill_audio_frame(AVFrame *frame, int nb_channels,
5684 enum AVSampleFormat sample_fmt, const uint8_t *buf,
5685 int buf_size, int align);
5688 * Reset the internal decoder state / flush internal buffers. Should be called
5689 * e.g. when seeking or when switching to a different stream.
5691 * @note when refcounted frames are not used (i.e. avctx->refcounted_frames is 0),
5692 * this invalidates the frames previously returned from the decoder. When
5693 * refcounted frames are used, the decoder just releases any references it might
5694 * keep internally, but the caller's reference remains valid.
5696 void avcodec_flush_buffers(AVCodecContext *avctx);
5699 * Return codec bits per sample.
5701 * @param[in] codec_id the codec
5702 * @return Number of bits per sample or zero if unknown for the given codec.
5704 int av_get_bits_per_sample(enum AVCodecID codec_id);
5707 * Return the PCM codec associated with a sample format.
5708 * @param be endianness, 0 for little, 1 for big,
5709 * -1 (or anything else) for native
5710 * @return AV_CODEC_ID_PCM_* or AV_CODEC_ID_NONE
5712 enum AVCodecID av_get_pcm_codec(enum AVSampleFormat fmt, int be);
5715 * Return codec bits per sample.
5716 * Only return non-zero if the bits per sample is exactly correct, not an
5719 * @param[in] codec_id the codec
5720 * @return Number of bits per sample or zero if unknown for the given codec.
5722 int av_get_exact_bits_per_sample(enum AVCodecID codec_id);
5725 * Return audio frame duration.
5727 * @param avctx codec context
5728 * @param frame_bytes size of the frame, or 0 if unknown
5729 * @return frame duration, in samples, if known. 0 if not able to
5732 int av_get_audio_frame_duration(AVCodecContext *avctx, int frame_bytes);
5735 * This function is the same as av_get_audio_frame_duration(), except it works
5736 * with AVCodecParameters instead of an AVCodecContext.
5738 int av_get_audio_frame_duration2(AVCodecParameters *par, int frame_bytes);
5741 typedef struct AVBitStreamFilterContext {
5743 const struct AVBitStreamFilter *filter;
5744 AVCodecParserContext *parser;
5745 struct AVBitStreamFilterContext *next;
5747 * Internal default arguments, used if NULL is passed to av_bitstream_filter_filter().
5748 * Not for access by library users.
5751 } AVBitStreamFilterContext;
5754 typedef struct AVBSFInternal AVBSFInternal;
5757 * The bitstream filter state.
5759 * This struct must be allocated with av_bsf_alloc() and freed with
5762 * The fields in the struct will only be changed (by the caller or by the
5763 * filter) as described in their documentation, and are to be considered
5764 * immutable otherwise.
5766 typedef struct AVBSFContext {
5768 * A class for logging and AVOptions
5770 const AVClass *av_class;
5773 * The bitstream filter this context is an instance of.
5775 const struct AVBitStreamFilter *filter;
5778 * Opaque libavcodec internal data. Must not be touched by the caller in any
5781 AVBSFInternal *internal;
5784 * Opaque filter-specific private data. If filter->priv_class is non-NULL,
5785 * this is an AVOptions-enabled struct.
5790 * Parameters of the input stream. This field is allocated in
5791 * av_bsf_alloc(), it needs to be filled by the caller before
5794 AVCodecParameters *par_in;
5797 * Parameters of the output stream. This field is allocated in
5798 * av_bsf_alloc(), it is set by the filter in av_bsf_init().
5800 AVCodecParameters *par_out;
5803 * The timebase used for the timestamps of the input packets. Set by the
5804 * caller before av_bsf_init().
5806 AVRational time_base_in;
5809 * The timebase used for the timestamps of the output packets. Set by the
5810 * filter in av_bsf_init().
5812 AVRational time_base_out;
5815 typedef struct AVBitStreamFilter {
5819 * A list of codec ids supported by the filter, terminated by
5821 * May be NULL, in that case the bitstream filter works with any codec id.
5823 const enum AVCodecID *codec_ids;
5826 * A class for the private data, used to declare bitstream filter private
5827 * AVOptions. This field is NULL for bitstream filters that do not declare
5830 * If this field is non-NULL, the first member of the filter private data
5831 * must be a pointer to AVClass, which will be set by libavcodec generic
5832 * code to this class.
5834 const AVClass *priv_class;
5836 /*****************************************************************
5837 * No fields below this line are part of the public API. They
5838 * may not be used outside of libavcodec and can be changed and
5840 * New public fields should be added right above.
5841 *****************************************************************
5845 int (*init)(AVBSFContext *ctx);
5846 int (*filter)(AVBSFContext *ctx, AVPacket *pkt);
5847 void (*close)(AVBSFContext *ctx);
5848 void (*flush)(AVBSFContext *ctx);
5849 } AVBitStreamFilter;
5853 * @deprecated the old bitstream filtering API (using AVBitStreamFilterContext)
5854 * is deprecated. Use the new bitstream filtering API (using AVBSFContext).
5856 attribute_deprecated
5857 void av_register_bitstream_filter(AVBitStreamFilter *bsf);
5859 * @deprecated the old bitstream filtering API (using AVBitStreamFilterContext)
5860 * is deprecated. Use av_bsf_get_by_name(), av_bsf_alloc(), and av_bsf_init()
5861 * from the new bitstream filtering API (using AVBSFContext).
5863 attribute_deprecated
5864 AVBitStreamFilterContext *av_bitstream_filter_init(const char *name);
5866 * @deprecated the old bitstream filtering API (using AVBitStreamFilterContext)
5867 * is deprecated. Use av_bsf_send_packet() and av_bsf_receive_packet() from the
5868 * new bitstream filtering API (using AVBSFContext).
5870 attribute_deprecated
5871 int av_bitstream_filter_filter(AVBitStreamFilterContext *bsfc,
5872 AVCodecContext *avctx, const char *args,
5873 uint8_t **poutbuf, int *poutbuf_size,
5874 const uint8_t *buf, int buf_size, int keyframe);
5876 * @deprecated the old bitstream filtering API (using AVBitStreamFilterContext)
5877 * is deprecated. Use av_bsf_free() from the new bitstream filtering API (using
5880 attribute_deprecated
5881 void av_bitstream_filter_close(AVBitStreamFilterContext *bsf);
5883 * @deprecated the old bitstream filtering API (using AVBitStreamFilterContext)
5884 * is deprecated. Use av_bsf_iterate() from the new bitstream filtering API (using
5887 attribute_deprecated
5888 const AVBitStreamFilter *av_bitstream_filter_next(const AVBitStreamFilter *f);
5892 * @return a bitstream filter with the specified name or NULL if no such
5893 * bitstream filter exists.
5895 const AVBitStreamFilter *av_bsf_get_by_name(const char *name);
5898 * Iterate over all registered bitstream filters.
5900 * @param opaque a pointer where libavcodec will store the iteration state. Must
5901 * point to NULL to start the iteration.
5903 * @return the next registered bitstream filter or NULL when the iteration is
5906 const AVBitStreamFilter *av_bsf_iterate(void **opaque);
5908 attribute_deprecated
5909 const AVBitStreamFilter *av_bsf_next(void **opaque);
5913 * Allocate a context for a given bitstream filter. The caller must fill in the
5914 * context parameters as described in the documentation and then call
5915 * av_bsf_init() before sending any data to the filter.
5917 * @param filter the filter for which to allocate an instance.
5918 * @param ctx a pointer into which the pointer to the newly-allocated context
5919 * will be written. It must be freed with av_bsf_free() after the
5920 * filtering is done.
5922 * @return 0 on success, a negative AVERROR code on failure
5924 int av_bsf_alloc(const AVBitStreamFilter *filter, AVBSFContext **ctx);
5927 * Prepare the filter for use, after all the parameters and options have been
5930 int av_bsf_init(AVBSFContext *ctx);
5933 * Submit a packet for filtering.
5935 * After sending each packet, the filter must be completely drained by calling
5936 * av_bsf_receive_packet() repeatedly until it returns AVERROR(EAGAIN) or
5939 * @param pkt the packet to filter. The bitstream filter will take ownership of
5940 * the packet and reset the contents of pkt. pkt is not touched if an error occurs.
5941 * This parameter may be NULL, which signals the end of the stream (i.e. no more
5942 * packets will be sent). That will cause the filter to output any packets it
5943 * may have buffered internally.
5945 * @return 0 on success, a negative AVERROR on error.
5947 int av_bsf_send_packet(AVBSFContext *ctx, AVPacket *pkt);
5950 * Retrieve a filtered packet.
5952 * @param[out] pkt this struct will be filled with the contents of the filtered
5953 * packet. It is owned by the caller and must be freed using
5954 * av_packet_unref() when it is no longer needed.
5955 * This parameter should be "clean" (i.e. freshly allocated
5956 * with av_packet_alloc() or unreffed with av_packet_unref())
5957 * when this function is called. If this function returns
5958 * successfully, the contents of pkt will be completely
5959 * overwritten by the returned data. On failure, pkt is not
5962 * @return 0 on success. AVERROR(EAGAIN) if more packets need to be sent to the
5963 * filter (using av_bsf_send_packet()) to get more output. AVERROR_EOF if there
5964 * will be no further output from the filter. Another negative AVERROR value if
5967 * @note one input packet may result in several output packets, so after sending
5968 * a packet with av_bsf_send_packet(), this function needs to be called
5969 * repeatedly until it stops returning 0. It is also possible for a filter to
5970 * output fewer packets than were sent to it, so this function may return
5971 * AVERROR(EAGAIN) immediately after a successful av_bsf_send_packet() call.
5973 int av_bsf_receive_packet(AVBSFContext *ctx, AVPacket *pkt);
5976 * Reset the internal bitstream filter state / flush internal buffers.
5978 void av_bsf_flush(AVBSFContext *ctx);
5981 * Free a bitstream filter context and everything associated with it; write NULL
5982 * into the supplied pointer.
5984 void av_bsf_free(AVBSFContext **ctx);
5987 * Get the AVClass for AVBSFContext. It can be used in combination with
5988 * AV_OPT_SEARCH_FAKE_OBJ for examining options.
5990 * @see av_opt_find().
5992 const AVClass *av_bsf_get_class(void);
5995 * Structure for chain/list of bitstream filters.
5996 * Empty list can be allocated by av_bsf_list_alloc().
5998 typedef struct AVBSFList AVBSFList;
6001 * Allocate empty list of bitstream filters.
6002 * The list must be later freed by av_bsf_list_free()
6003 * or finalized by av_bsf_list_finalize().
6005 * @return Pointer to @ref AVBSFList on success, NULL in case of failure
6007 AVBSFList *av_bsf_list_alloc(void);
6010 * Free list of bitstream filters.
6012 * @param lst Pointer to pointer returned by av_bsf_list_alloc()
6014 void av_bsf_list_free(AVBSFList **lst);
6017 * Append bitstream filter to the list of bitstream filters.
6019 * @param lst List to append to
6020 * @param bsf Filter context to be appended
6022 * @return >=0 on success, negative AVERROR in case of failure
6024 int av_bsf_list_append(AVBSFList *lst, AVBSFContext *bsf);
6027 * Construct new bitstream filter context given it's name and options
6028 * and append it to the list of bitstream filters.
6030 * @param lst List to append to
6031 * @param bsf_name Name of the bitstream filter
6032 * @param options Options for the bitstream filter, can be set to NULL
6034 * @return >=0 on success, negative AVERROR in case of failure
6036 int av_bsf_list_append2(AVBSFList *lst, const char * bsf_name, AVDictionary **options);
6038 * Finalize list of bitstream filters.
6040 * This function will transform @ref AVBSFList to single @ref AVBSFContext,
6041 * so the whole chain of bitstream filters can be treated as single filter
6042 * freshly allocated by av_bsf_alloc().
6043 * If the call is successful, @ref AVBSFList structure is freed and lst
6044 * will be set to NULL. In case of failure, caller is responsible for
6045 * freeing the structure by av_bsf_list_free()
6047 * @param lst Filter list structure to be transformed
6048 * @param[out] bsf Pointer to be set to newly created @ref AVBSFContext structure
6049 * representing the chain of bitstream filters
6051 * @return >=0 on success, negative AVERROR in case of failure
6053 int av_bsf_list_finalize(AVBSFList **lst, AVBSFContext **bsf);
6056 * Parse string describing list of bitstream filters and create single
6057 * @ref AVBSFContext describing the whole chain of bitstream filters.
6058 * Resulting @ref AVBSFContext can be treated as any other @ref AVBSFContext freshly
6059 * allocated by av_bsf_alloc().
6061 * @param str String describing chain of bitstream filters in format
6062 * `bsf1[=opt1=val1:opt2=val2][,bsf2]`
6063 * @param[out] bsf Pointer to be set to newly created @ref AVBSFContext structure
6064 * representing the chain of bitstream filters
6066 * @return >=0 on success, negative AVERROR in case of failure
6068 int av_bsf_list_parse_str(const char *str, AVBSFContext **bsf);
6071 * Get null/pass-through bitstream filter.
6073 * @param[out] bsf Pointer to be set to new instance of pass-through bitstream filter
6077 int av_bsf_get_null_filter(AVBSFContext **bsf);
6082 * Same behaviour av_fast_malloc but the buffer has additional
6083 * AV_INPUT_BUFFER_PADDING_SIZE at the end which will always be 0.
6085 * In addition the whole buffer will initially and after resizes
6086 * be 0-initialized so that no uninitialized data will ever appear.
6088 void av_fast_padded_malloc(void *ptr, unsigned int *size, size_t min_size);
6091 * Same behaviour av_fast_padded_malloc except that buffer will always
6092 * be 0-initialized after call.
6094 void av_fast_padded_mallocz(void *ptr, unsigned int *size, size_t min_size);
6097 * Encode extradata length to a buffer. Used by xiph codecs.
6099 * @param s buffer to write to; must be at least (v/255+1) bytes long
6100 * @param v size of extradata in bytes
6101 * @return number of bytes written to the buffer.
6103 unsigned int av_xiphlacing(unsigned char *s, unsigned int v);
6105 #if FF_API_USER_VISIBLE_AVHWACCEL
6107 * Register the hardware accelerator hwaccel.
6109 * @deprecated This function doesn't do anything.
6111 attribute_deprecated
6112 void av_register_hwaccel(AVHWAccel *hwaccel);
6115 * If hwaccel is NULL, returns the first registered hardware accelerator,
6116 * if hwaccel is non-NULL, returns the next registered hardware accelerator
6117 * after hwaccel, or NULL if hwaccel is the last one.
6119 * @deprecated AVHWaccel structures contain no user-serviceable parts, so
6120 * this function should not be used.
6122 attribute_deprecated
6123 AVHWAccel *av_hwaccel_next(const AVHWAccel *hwaccel);
6128 * Lock operation used by lockmgr
6130 * @deprecated Deprecated together with av_lockmgr_register().
6133 AV_LOCK_CREATE, ///< Create a mutex
6134 AV_LOCK_OBTAIN, ///< Lock the mutex
6135 AV_LOCK_RELEASE, ///< Unlock the mutex
6136 AV_LOCK_DESTROY, ///< Free mutex resources
6140 * Register a user provided lock manager supporting the operations
6141 * specified by AVLockOp. The "mutex" argument to the function points
6142 * to a (void *) where the lockmgr should store/get a pointer to a user
6143 * allocated mutex. It is NULL upon AV_LOCK_CREATE and equal to the
6144 * value left by the last call for all other ops. If the lock manager is
6145 * unable to perform the op then it should leave the mutex in the same
6146 * state as when it was called and return a non-zero value. However,
6147 * when called with AV_LOCK_DESTROY the mutex will always be assumed to
6148 * have been successfully destroyed. If av_lockmgr_register succeeds
6149 * it will return a non-negative value, if it fails it will return a
6150 * negative value and destroy all mutex and unregister all callbacks.
6151 * av_lockmgr_register is not thread-safe, it must be called from a
6152 * single thread before any calls which make use of locking are used.
6154 * @param cb User defined callback. av_lockmgr_register invokes calls
6155 * to this callback and the previously registered callback.
6156 * The callback will be used to create more than one mutex
6157 * each of which must be backed by its own underlying locking
6158 * mechanism (i.e. do not use a single static object to
6159 * implement your lock manager). If cb is set to NULL the
6160 * lockmgr will be unregistered.
6162 * @deprecated This function does nothing, and always returns 0. Be sure to
6163 * build with thread support to get basic thread safety.
6165 attribute_deprecated
6166 int av_lockmgr_register(int (*cb)(void **mutex, enum AVLockOp op));
6170 * Get the type of the given codec.
6172 enum AVMediaType avcodec_get_type(enum AVCodecID codec_id);
6175 * Get the name of a codec.
6176 * @return a static string identifying the codec; never NULL
6178 const char *avcodec_get_name(enum AVCodecID id);
6181 * @return a positive value if s is open (i.e. avcodec_open2() was called on it
6182 * with no corresponding avcodec_close()), 0 otherwise.
6184 int avcodec_is_open(AVCodecContext *s);
6187 * @return a non-zero number if codec is an encoder, zero otherwise
6189 int av_codec_is_encoder(const AVCodec *codec);
6192 * @return a non-zero number if codec is a decoder, zero otherwise
6194 int av_codec_is_decoder(const AVCodec *codec);
6197 * @return descriptor for given codec ID or NULL if no descriptor exists.
6199 const AVCodecDescriptor *avcodec_descriptor_get(enum AVCodecID id);
6202 * Iterate over all codec descriptors known to libavcodec.
6204 * @param prev previous descriptor. NULL to get the first descriptor.
6206 * @return next descriptor or NULL after the last descriptor
6208 const AVCodecDescriptor *avcodec_descriptor_next(const AVCodecDescriptor *prev);
6211 * @return codec descriptor with the given name or NULL if no such descriptor
6214 const AVCodecDescriptor *avcodec_descriptor_get_by_name(const char *name);
6217 * Allocate a CPB properties structure and initialize its fields to default
6220 * @param size if non-NULL, the size of the allocated struct will be written
6221 * here. This is useful for embedding it in side data.
6223 * @return the newly allocated struct or NULL on failure
6225 AVCPBProperties *av_cpb_properties_alloc(size_t *size);
6231 #endif /* AVCODEC_AVCODEC_H */