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.
693 AV_CODEC_ID_BINTEXT = 0x18800,
697 AV_CODEC_ID_SMPTE_KLV,
699 AV_CODEC_ID_TIMED_ID3,
700 AV_CODEC_ID_BIN_DATA,
703 AV_CODEC_ID_PROBE = 0x19000, ///< codec_id is not known (like AV_CODEC_ID_NONE) but lavf should attempt to identify it
705 AV_CODEC_ID_MPEG2TS = 0x20000, /**< _FAKE_ codec to indicate a raw MPEG-2 TS
706 * stream (only used by libavformat) */
707 AV_CODEC_ID_MPEG4SYSTEMS = 0x20001, /**< _FAKE_ codec to indicate a MPEG-4 Systems
708 * stream (only used by libavformat) */
709 AV_CODEC_ID_FFMETADATA = 0x21000, ///< Dummy codec for streams containing only metadata information.
710 AV_CODEC_ID_WRAPPED_AVFRAME = 0x21001, ///< Passthrough codec, AVFrames wrapped in AVPacket
714 * This struct describes the properties of a single codec described by an
716 * @see avcodec_descriptor_get()
718 typedef struct AVCodecDescriptor {
720 enum AVMediaType type;
722 * Name of the codec described by this descriptor. It is non-empty and
723 * unique for each codec descriptor. It should contain alphanumeric
724 * characters and '_' only.
728 * A more descriptive name for this codec. May be NULL.
730 const char *long_name;
732 * Codec properties, a combination of AV_CODEC_PROP_* flags.
736 * MIME type(s) associated with the codec.
737 * May be NULL; if not, a NULL-terminated array of MIME types.
738 * The first item is always non-NULL and is the preferred MIME type.
740 const char *const *mime_types;
742 * If non-NULL, an array of profiles recognized for this codec.
743 * Terminated with FF_PROFILE_UNKNOWN.
745 const struct AVProfile *profiles;
749 * Codec uses only intra compression.
750 * Video and audio codecs only.
752 #define AV_CODEC_PROP_INTRA_ONLY (1 << 0)
754 * Codec supports lossy compression. Audio and video codecs only.
755 * @note a codec may support both lossy and lossless
758 #define AV_CODEC_PROP_LOSSY (1 << 1)
760 * Codec supports lossless compression. Audio and video codecs only.
762 #define AV_CODEC_PROP_LOSSLESS (1 << 2)
764 * Codec supports frame reordering. That is, the coded order (the order in which
765 * the encoded packets are output by the encoders / stored / input to the
766 * decoders) may be different from the presentation order of the corresponding
769 * For codecs that do not have this property set, PTS and DTS should always be
772 #define AV_CODEC_PROP_REORDER (1 << 3)
774 * Subtitle codec is bitmap based
775 * Decoded AVSubtitle data can be read from the AVSubtitleRect->pict field.
777 #define AV_CODEC_PROP_BITMAP_SUB (1 << 16)
779 * Subtitle codec is text based.
780 * Decoded AVSubtitle data can be read from the AVSubtitleRect->ass field.
782 #define AV_CODEC_PROP_TEXT_SUB (1 << 17)
785 * @ingroup lavc_decoding
786 * Required number of additionally allocated bytes at the end of the input bitstream for decoding.
787 * This is mainly needed because some optimized bitstream readers read
788 * 32 or 64 bit at once and could read over the end.<br>
789 * Note: If the first 23 bits of the additional bytes are not 0, then damaged
790 * MPEG bitstreams could cause overread and segfault.
792 #define AV_INPUT_BUFFER_PADDING_SIZE 64
795 * @ingroup lavc_encoding
796 * minimum encoding buffer size
797 * Used to avoid some checks during header writing.
799 #define AV_INPUT_BUFFER_MIN_SIZE 16384
802 * @ingroup lavc_decoding
805 /* We leave some space between them for extensions (drop some
806 * keyframes for intra-only or drop just some bidir frames). */
807 AVDISCARD_NONE =-16, ///< discard nothing
808 AVDISCARD_DEFAULT = 0, ///< discard useless packets like 0 size packets in avi
809 AVDISCARD_NONREF = 8, ///< discard all non reference
810 AVDISCARD_BIDIR = 16, ///< discard all bidirectional frames
811 AVDISCARD_NONINTRA= 24, ///< discard all non intra frames
812 AVDISCARD_NONKEY = 32, ///< discard all frames except keyframes
813 AVDISCARD_ALL = 48, ///< discard all
816 enum AVAudioServiceType {
817 AV_AUDIO_SERVICE_TYPE_MAIN = 0,
818 AV_AUDIO_SERVICE_TYPE_EFFECTS = 1,
819 AV_AUDIO_SERVICE_TYPE_VISUALLY_IMPAIRED = 2,
820 AV_AUDIO_SERVICE_TYPE_HEARING_IMPAIRED = 3,
821 AV_AUDIO_SERVICE_TYPE_DIALOGUE = 4,
822 AV_AUDIO_SERVICE_TYPE_COMMENTARY = 5,
823 AV_AUDIO_SERVICE_TYPE_EMERGENCY = 6,
824 AV_AUDIO_SERVICE_TYPE_VOICE_OVER = 7,
825 AV_AUDIO_SERVICE_TYPE_KARAOKE = 8,
826 AV_AUDIO_SERVICE_TYPE_NB , ///< Not part of ABI
830 * @ingroup lavc_encoding
832 typedef struct RcOverride{
835 int qscale; // If this is 0 then quality_factor will be used instead.
836 float quality_factor;
840 These flags can be passed in AVCodecContext.flags before initialization.
841 Note: Not everything is supported yet.
845 * Allow decoders to produce frames with data planes that are not aligned
846 * to CPU requirements (e.g. due to cropping).
848 #define AV_CODEC_FLAG_UNALIGNED (1 << 0)
852 #define AV_CODEC_FLAG_QSCALE (1 << 1)
854 * 4 MV per MB allowed / advanced prediction for H.263.
856 #define AV_CODEC_FLAG_4MV (1 << 2)
858 * Output even those frames that might be corrupted.
860 #define AV_CODEC_FLAG_OUTPUT_CORRUPT (1 << 3)
864 #define AV_CODEC_FLAG_QPEL (1 << 4)
866 * Don't output frames whose parameters differ from first
867 * decoded frame in stream.
869 #define AV_CODEC_FLAG_DROPCHANGED (1 << 5)
871 * Use internal 2pass ratecontrol in first pass mode.
873 #define AV_CODEC_FLAG_PASS1 (1 << 9)
875 * Use internal 2pass ratecontrol in second pass mode.
877 #define AV_CODEC_FLAG_PASS2 (1 << 10)
881 #define AV_CODEC_FLAG_LOOP_FILTER (1 << 11)
883 * Only decode/encode grayscale.
885 #define AV_CODEC_FLAG_GRAY (1 << 13)
887 * error[?] variables will be set during encoding.
889 #define AV_CODEC_FLAG_PSNR (1 << 15)
891 * Input bitstream might be truncated at a random location
892 * instead of only at frame boundaries.
894 #define AV_CODEC_FLAG_TRUNCATED (1 << 16)
896 * Use interlaced DCT.
898 #define AV_CODEC_FLAG_INTERLACED_DCT (1 << 18)
902 #define AV_CODEC_FLAG_LOW_DELAY (1 << 19)
904 * Place global headers in extradata instead of every keyframe.
906 #define AV_CODEC_FLAG_GLOBAL_HEADER (1 << 22)
908 * Use only bitexact stuff (except (I)DCT).
910 #define AV_CODEC_FLAG_BITEXACT (1 << 23)
911 /* Fx : Flag for H.263+ extra options */
913 * H.263 advanced intra coding / MPEG-4 AC prediction
915 #define AV_CODEC_FLAG_AC_PRED (1 << 24)
917 * interlaced motion estimation
919 #define AV_CODEC_FLAG_INTERLACED_ME (1 << 29)
920 #define AV_CODEC_FLAG_CLOSED_GOP (1U << 31)
923 * Allow non spec compliant speedup tricks.
925 #define AV_CODEC_FLAG2_FAST (1 << 0)
927 * Skip bitstream encoding.
929 #define AV_CODEC_FLAG2_NO_OUTPUT (1 << 2)
931 * Place global headers at every keyframe instead of in extradata.
933 #define AV_CODEC_FLAG2_LOCAL_HEADER (1 << 3)
936 * timecode is in drop frame format. DEPRECATED!!!!
938 #define AV_CODEC_FLAG2_DROP_FRAME_TIMECODE (1 << 13)
941 * Input bitstream might be truncated at a packet boundaries
942 * instead of only at frame boundaries.
944 #define AV_CODEC_FLAG2_CHUNKS (1 << 15)
946 * Discard cropping information from SPS.
948 #define AV_CODEC_FLAG2_IGNORE_CROP (1 << 16)
951 * Show all frames before the first keyframe
953 #define AV_CODEC_FLAG2_SHOW_ALL (1 << 22)
955 * Export motion vectors through frame side data
957 #define AV_CODEC_FLAG2_EXPORT_MVS (1 << 28)
959 * Do not skip samples and export skip information as frame side data
961 #define AV_CODEC_FLAG2_SKIP_MANUAL (1 << 29)
963 * Do not reset ASS ReadOrder field on flush (subtitles decoding)
965 #define AV_CODEC_FLAG2_RO_FLUSH_NOOP (1 << 30)
967 /* Unsupported options :
968 * Syntax Arithmetic coding (SAC)
969 * Reference Picture Selection
970 * Independent Segment Decoding */
972 /* codec capabilities */
975 * Decoder can use draw_horiz_band callback.
977 #define AV_CODEC_CAP_DRAW_HORIZ_BAND (1 << 0)
979 * Codec uses get_buffer() for allocating buffers and supports custom allocators.
980 * If not set, it might not use get_buffer() at all or use operations that
981 * assume the buffer was allocated by avcodec_default_get_buffer.
983 #define AV_CODEC_CAP_DR1 (1 << 1)
984 #define AV_CODEC_CAP_TRUNCATED (1 << 3)
986 * Encoder or decoder requires flushing with NULL input at the end in order to
987 * give the complete and correct output.
989 * NOTE: If this flag is not set, the codec is guaranteed to never be fed with
990 * with NULL data. The user can still send NULL data to the public encode
991 * or decode function, but libavcodec will not pass it along to the codec
992 * unless this flag is set.
995 * The decoder has a non-zero delay and needs to be fed with avpkt->data=NULL,
996 * avpkt->size=0 at the end to get the delayed data until the decoder no longer
1000 * The encoder needs to be fed with NULL data at the end of encoding until the
1001 * encoder no longer returns data.
1003 * NOTE: For encoders implementing the AVCodec.encode2() function, setting this
1004 * flag also means that the encoder must set the pts and duration for
1005 * each output packet. If this flag is not set, the pts and duration will
1006 * be determined by libavcodec from the input frame.
1008 #define AV_CODEC_CAP_DELAY (1 << 5)
1010 * Codec can be fed a final frame with a smaller size.
1011 * This can be used to prevent truncation of the last audio samples.
1013 #define AV_CODEC_CAP_SMALL_LAST_FRAME (1 << 6)
1016 * Codec can output multiple frames per AVPacket
1017 * Normally demuxers return one frame at a time, demuxers which do not do
1018 * are connected to a parser to split what they return into proper frames.
1019 * This flag is reserved to the very rare category of codecs which have a
1020 * bitstream that cannot be split into frames without timeconsuming
1021 * operations like full decoding. Demuxers carrying such bitstreams thus
1022 * may return multiple frames in a packet. This has many disadvantages like
1023 * prohibiting stream copy in many cases thus it should only be considered
1026 #define AV_CODEC_CAP_SUBFRAMES (1 << 8)
1028 * Codec is experimental and is thus avoided in favor of non experimental
1031 #define AV_CODEC_CAP_EXPERIMENTAL (1 << 9)
1033 * Codec should fill in channel configuration and samplerate instead of container
1035 #define AV_CODEC_CAP_CHANNEL_CONF (1 << 10)
1037 * Codec supports frame-level multithreading.
1039 #define AV_CODEC_CAP_FRAME_THREADS (1 << 12)
1041 * Codec supports slice-based (or partition-based) multithreading.
1043 #define AV_CODEC_CAP_SLICE_THREADS (1 << 13)
1045 * Codec supports changed parameters at any point.
1047 #define AV_CODEC_CAP_PARAM_CHANGE (1 << 14)
1049 * Codec supports avctx->thread_count == 0 (auto).
1051 #define AV_CODEC_CAP_AUTO_THREADS (1 << 15)
1053 * Audio encoder supports receiving a different number of samples in each call.
1055 #define AV_CODEC_CAP_VARIABLE_FRAME_SIZE (1 << 16)
1057 * Decoder is not a preferred choice for probing.
1058 * This indicates that the decoder is not a good choice for probing.
1059 * It could for example be an expensive to spin up hardware decoder,
1060 * or it could simply not provide a lot of useful information about
1062 * A decoder marked with this flag should only be used as last resort
1063 * choice for probing.
1065 #define AV_CODEC_CAP_AVOID_PROBING (1 << 17)
1067 * Codec is intra only.
1069 #define AV_CODEC_CAP_INTRA_ONLY 0x40000000
1071 * Codec is lossless.
1073 #define AV_CODEC_CAP_LOSSLESS 0x80000000
1076 * Codec is backed by a hardware implementation. Typically used to
1077 * identify a non-hwaccel hardware decoder. For information about hwaccels, use
1078 * avcodec_get_hw_config() instead.
1080 #define AV_CODEC_CAP_HARDWARE (1 << 18)
1083 * Codec is potentially backed by a hardware implementation, but not
1084 * necessarily. This is used instead of AV_CODEC_CAP_HARDWARE, if the
1085 * implementation provides some sort of internal fallback.
1087 #define AV_CODEC_CAP_HYBRID (1 << 19)
1090 * This codec takes the reordered_opaque field from input AVFrames
1091 * and returns it in the corresponding field in AVCodecContext after
1094 #define AV_CODEC_CAP_ENCODER_REORDERED_OPAQUE (1 << 20)
1098 * This specifies the area which should be displayed.
1099 * Note there may be multiple such areas for one frame.
1101 typedef struct AVPanScan {
1104 * - encoding: Set by user.
1105 * - decoding: Set by libavcodec.
1110 * width and height in 1/16 pel
1111 * - encoding: Set by user.
1112 * - decoding: Set by libavcodec.
1118 * position of the top left corner in 1/16 pel for up to 3 fields/frames
1119 * - encoding: Set by user.
1120 * - decoding: Set by libavcodec.
1122 int16_t position[3][2];
1126 * This structure describes the bitrate properties of an encoded bitstream. It
1127 * roughly corresponds to a subset the VBV parameters for MPEG-2 or HRD
1128 * parameters for H.264/HEVC.
1130 typedef struct AVCPBProperties {
1132 * Maximum bitrate of the stream, in bits per second.
1133 * Zero if unknown or unspecified.
1135 #if FF_API_UNSANITIZED_BITRATES
1138 int64_t max_bitrate;
1141 * Minimum bitrate of the stream, in bits per second.
1142 * Zero if unknown or unspecified.
1144 #if FF_API_UNSANITIZED_BITRATES
1147 int64_t min_bitrate;
1150 * Average bitrate of the stream, in bits per second.
1151 * Zero if unknown or unspecified.
1153 #if FF_API_UNSANITIZED_BITRATES
1156 int64_t avg_bitrate;
1160 * The size of the buffer to which the ratecontrol is applied, in bits.
1161 * Zero if unknown or unspecified.
1166 * The delay between the time the packet this structure is associated with
1167 * is received and the time when it should be decoded, in periods of a 27MHz
1170 * UINT64_MAX when unknown or unspecified.
1176 * The decoder will keep a reference to the frame and may reuse it later.
1178 #define AV_GET_BUFFER_FLAG_REF (1 << 0)
1181 * @defgroup lavc_packet AVPacket
1183 * Types and functions for working with AVPacket.
1186 enum AVPacketSideDataType {
1188 * An AV_PKT_DATA_PALETTE side data packet contains exactly AVPALETTE_SIZE
1189 * bytes worth of palette. This side data signals that a new palette is
1192 AV_PKT_DATA_PALETTE,
1195 * The AV_PKT_DATA_NEW_EXTRADATA is used to notify the codec or the format
1196 * that the extradata buffer was changed and the receiving side should
1197 * act upon it appropriately. The new extradata is embedded in the side
1198 * data buffer and should be immediately used for processing the current
1201 AV_PKT_DATA_NEW_EXTRADATA,
1204 * An AV_PKT_DATA_PARAM_CHANGE side data packet is laid out as follows:
1207 * if (param_flags & AV_SIDE_DATA_PARAM_CHANGE_CHANNEL_COUNT)
1208 * s32le channel_count
1209 * if (param_flags & AV_SIDE_DATA_PARAM_CHANGE_CHANNEL_LAYOUT)
1210 * u64le channel_layout
1211 * if (param_flags & AV_SIDE_DATA_PARAM_CHANGE_SAMPLE_RATE)
1213 * if (param_flags & AV_SIDE_DATA_PARAM_CHANGE_DIMENSIONS)
1218 AV_PKT_DATA_PARAM_CHANGE,
1221 * An AV_PKT_DATA_H263_MB_INFO side data packet contains a number of
1222 * structures with info about macroblocks relevant to splitting the
1223 * packet into smaller packets on macroblock edges (e.g. as for RFC 2190).
1224 * That is, it does not necessarily contain info about all macroblocks,
1225 * as long as the distance between macroblocks in the info is smaller
1226 * than the target payload size.
1227 * Each MB info structure is 12 bytes, and is laid out as follows:
1229 * u32le bit offset from the start of the packet
1230 * u8 current quantizer at the start of the macroblock
1232 * u16le macroblock address within the GOB
1233 * u8 horizontal MV predictor
1234 * u8 vertical MV predictor
1235 * u8 horizontal MV predictor for block number 3
1236 * u8 vertical MV predictor for block number 3
1239 AV_PKT_DATA_H263_MB_INFO,
1242 * This side data should be associated with an audio stream and contains
1243 * ReplayGain information in form of the AVReplayGain struct.
1245 AV_PKT_DATA_REPLAYGAIN,
1248 * This side data contains a 3x3 transformation matrix describing an affine
1249 * transformation that needs to be applied to the decoded video frames for
1250 * correct presentation.
1252 * See libavutil/display.h for a detailed description of the data.
1254 AV_PKT_DATA_DISPLAYMATRIX,
1257 * This side data should be associated with a video stream and contains
1258 * Stereoscopic 3D information in form of the AVStereo3D struct.
1260 AV_PKT_DATA_STEREO3D,
1263 * This side data should be associated with an audio stream and corresponds
1264 * to enum AVAudioServiceType.
1266 AV_PKT_DATA_AUDIO_SERVICE_TYPE,
1269 * This side data contains quality related information from the encoder.
1271 * u32le quality factor of the compressed frame. Allowed range is between 1 (good) and FF_LAMBDA_MAX (bad).
1275 * u64le[error count] sum of squared differences between encoder in and output
1278 AV_PKT_DATA_QUALITY_STATS,
1281 * This side data contains an integer value representing the stream index
1282 * of a "fallback" track. A fallback track indicates an alternate
1283 * track to use when the current track can not be decoded for some reason.
1284 * e.g. no decoder available for codec.
1286 AV_PKT_DATA_FALLBACK_TRACK,
1289 * This side data corresponds to the AVCPBProperties struct.
1291 AV_PKT_DATA_CPB_PROPERTIES,
1294 * Recommmends skipping the specified number of samples
1296 * u32le number of samples to skip from start of this packet
1297 * u32le number of samples to skip from end of this packet
1298 * u8 reason for start skip
1299 * u8 reason for end skip (0=padding silence, 1=convergence)
1302 AV_PKT_DATA_SKIP_SAMPLES,
1305 * An AV_PKT_DATA_JP_DUALMONO side data packet indicates that
1306 * the packet may contain "dual mono" audio specific to Japanese DTV
1307 * and if it is true, recommends only the selected channel to be used.
1309 * u8 selected channels (0=mail/left, 1=sub/right, 2=both)
1312 AV_PKT_DATA_JP_DUALMONO,
1315 * A list of zero terminated key/value strings. There is no end marker for
1316 * the list, so it is required to rely on the side data size to stop.
1318 AV_PKT_DATA_STRINGS_METADATA,
1321 * Subtitle event position
1329 AV_PKT_DATA_SUBTITLE_POSITION,
1332 * Data found in BlockAdditional element of matroska container. There is
1333 * no end marker for the data, so it is required to rely on the side data
1334 * size to recognize the end. 8 byte id (as found in BlockAddId) followed
1337 AV_PKT_DATA_MATROSKA_BLOCKADDITIONAL,
1340 * The optional first identifier line of a WebVTT cue.
1342 AV_PKT_DATA_WEBVTT_IDENTIFIER,
1345 * The optional settings (rendering instructions) that immediately
1346 * follow the timestamp specifier of a WebVTT cue.
1348 AV_PKT_DATA_WEBVTT_SETTINGS,
1351 * A list of zero terminated key/value strings. There is no end marker for
1352 * the list, so it is required to rely on the side data size to stop. This
1353 * side data includes updated metadata which appeared in the stream.
1355 AV_PKT_DATA_METADATA_UPDATE,
1358 * MPEGTS stream ID as uint8_t, this is required to pass the stream ID
1359 * information from the demuxer to the corresponding muxer.
1361 AV_PKT_DATA_MPEGTS_STREAM_ID,
1364 * Mastering display metadata (based on SMPTE-2086:2014). This metadata
1365 * should be associated with a video stream and contains data in the form
1366 * of the AVMasteringDisplayMetadata struct.
1368 AV_PKT_DATA_MASTERING_DISPLAY_METADATA,
1371 * This side data should be associated with a video stream and corresponds
1372 * to the AVSphericalMapping structure.
1374 AV_PKT_DATA_SPHERICAL,
1377 * Content light level (based on CTA-861.3). This metadata should be
1378 * associated with a video stream and contains data in the form of the
1379 * AVContentLightMetadata struct.
1381 AV_PKT_DATA_CONTENT_LIGHT_LEVEL,
1384 * ATSC A53 Part 4 Closed Captions. This metadata should be associated with
1385 * a video stream. A53 CC bitstream is stored as uint8_t in AVPacketSideData.data.
1386 * The number of bytes of CC data is AVPacketSideData.size.
1391 * This side data is encryption initialization data.
1392 * The format is not part of ABI, use av_encryption_init_info_* methods to
1395 AV_PKT_DATA_ENCRYPTION_INIT_INFO,
1398 * This side data contains encryption info for how to decrypt the packet.
1399 * The format is not part of ABI, use av_encryption_info_* methods to access.
1401 AV_PKT_DATA_ENCRYPTION_INFO,
1404 * Active Format Description data consisting of a single byte as specified
1405 * in ETSI TS 101 154 using AVActiveFormatDescription enum.
1410 * The number of side data types.
1411 * This is not part of the public API/ABI in the sense that it may
1412 * change when new side data types are added.
1413 * This must stay the last enum value.
1414 * If its value becomes huge, some code using it
1415 * needs to be updated as it assumes it to be smaller than other limits.
1420 #define AV_PKT_DATA_QUALITY_FACTOR AV_PKT_DATA_QUALITY_STATS //DEPRECATED
1422 typedef struct AVPacketSideData {
1425 enum AVPacketSideDataType type;
1429 * This structure stores compressed data. It is typically exported by demuxers
1430 * and then passed as input to decoders, or received as output from encoders and
1431 * then passed to muxers.
1433 * For video, it should typically contain one compressed frame. For audio it may
1434 * contain several compressed frames. Encoders are allowed to output empty
1435 * packets, with no compressed data, containing only side data
1436 * (e.g. to update some stream parameters at the end of encoding).
1438 * AVPacket is one of the few structs in FFmpeg, whose size is a part of public
1439 * ABI. Thus it may be allocated on stack and no new fields can be added to it
1440 * without libavcodec and libavformat major bump.
1442 * The semantics of data ownership depends on the buf field.
1443 * If it is set, the packet data is dynamically allocated and is
1444 * valid indefinitely until a call to av_packet_unref() reduces the
1445 * reference count to 0.
1447 * If the buf field is not set av_packet_ref() would make a copy instead
1448 * of increasing the reference count.
1450 * The side data is always allocated with av_malloc(), copied by
1451 * av_packet_ref() and freed by av_packet_unref().
1453 * @see av_packet_ref
1454 * @see av_packet_unref
1456 typedef struct AVPacket {
1458 * A reference to the reference-counted buffer where the packet data is
1460 * May be NULL, then the packet data is not reference-counted.
1464 * Presentation timestamp in AVStream->time_base units; the time at which
1465 * the decompressed packet will be presented to the user.
1466 * Can be AV_NOPTS_VALUE if it is not stored in the file.
1467 * pts MUST be larger or equal to dts as presentation cannot happen before
1468 * decompression, unless one wants to view hex dumps. Some formats misuse
1469 * the terms dts and pts/cts to mean something different. Such timestamps
1470 * must be converted to true pts/dts before they are stored in AVPacket.
1474 * Decompression timestamp in AVStream->time_base units; the time at which
1475 * the packet is decompressed.
1476 * Can be AV_NOPTS_VALUE if it is not stored in the file.
1483 * A combination of AV_PKT_FLAG values
1487 * Additional packet data that can be provided by the container.
1488 * Packet can contain several types of side information.
1490 AVPacketSideData *side_data;
1491 int side_data_elems;
1494 * Duration of this packet in AVStream->time_base units, 0 if unknown.
1495 * Equals next_pts - this_pts in presentation order.
1499 int64_t pos; ///< byte position in stream, -1 if unknown
1501 #if FF_API_CONVERGENCE_DURATION
1503 * @deprecated Same as the duration field, but as int64_t. This was required
1504 * for Matroska subtitles, whose duration values could overflow when the
1505 * duration field was still an int.
1507 attribute_deprecated
1508 int64_t convergence_duration;
1511 #define AV_PKT_FLAG_KEY 0x0001 ///< The packet contains a keyframe
1512 #define AV_PKT_FLAG_CORRUPT 0x0002 ///< The packet content is corrupted
1514 * Flag is used to discard packets which are required to maintain valid
1515 * decoder state but are not required for output and should be dropped
1518 #define AV_PKT_FLAG_DISCARD 0x0004
1520 * The packet comes from a trusted source.
1522 * Otherwise-unsafe constructs such as arbitrary pointers to data
1523 * outside the packet may be followed.
1525 #define AV_PKT_FLAG_TRUSTED 0x0008
1527 * Flag is used to indicate packets that contain frames that can
1528 * be discarded by the decoder. I.e. Non-reference frames.
1530 #define AV_PKT_FLAG_DISPOSABLE 0x0010
1533 enum AVSideDataParamChangeFlags {
1534 AV_SIDE_DATA_PARAM_CHANGE_CHANNEL_COUNT = 0x0001,
1535 AV_SIDE_DATA_PARAM_CHANGE_CHANNEL_LAYOUT = 0x0002,
1536 AV_SIDE_DATA_PARAM_CHANGE_SAMPLE_RATE = 0x0004,
1537 AV_SIDE_DATA_PARAM_CHANGE_DIMENSIONS = 0x0008,
1543 struct AVCodecInternal;
1547 AV_FIELD_PROGRESSIVE,
1548 AV_FIELD_TT, //< Top coded_first, top displayed first
1549 AV_FIELD_BB, //< Bottom coded first, bottom displayed first
1550 AV_FIELD_TB, //< Top coded first, bottom displayed first
1551 AV_FIELD_BT, //< Bottom coded first, top displayed first
1555 * main external API structure.
1556 * New fields can be added to the end with minor version bumps.
1557 * Removal, reordering and changes to existing fields require a major
1559 * You can use AVOptions (av_opt* / av_set/get*()) to access these fields from user
1561 * The name string for AVOptions options matches the associated command line
1562 * parameter name and can be found in libavcodec/options_table.h
1563 * The AVOption/command line parameter names differ in some cases from the C
1564 * structure field names for historic reasons or brevity.
1565 * sizeof(AVCodecContext) must not be used outside libav*.
1567 typedef struct AVCodecContext {
1569 * information on struct for av_log
1570 * - set by avcodec_alloc_context3
1572 const AVClass *av_class;
1573 int log_level_offset;
1575 enum AVMediaType codec_type; /* see AVMEDIA_TYPE_xxx */
1576 const struct AVCodec *codec;
1577 enum AVCodecID codec_id; /* see AV_CODEC_ID_xxx */
1580 * fourcc (LSB first, so "ABCD" -> ('D'<<24) + ('C'<<16) + ('B'<<8) + 'A').
1581 * This is used to work around some encoder bugs.
1582 * A demuxer should set this to what is stored in the field used to identify the codec.
1583 * If there are multiple such fields in a container then the demuxer should choose the one
1584 * which maximizes the information about the used codec.
1585 * If the codec tag field in a container is larger than 32 bits then the demuxer should
1586 * remap the longer ID to 32 bits with a table or other structure. Alternatively a new
1587 * extra_codec_tag + size could be added but for this a clear advantage must be demonstrated
1589 * - encoding: Set by user, if not then the default based on codec_id will be used.
1590 * - decoding: Set by user, will be converted to uppercase by libavcodec during init.
1592 unsigned int codec_tag;
1597 * Private context used for internal data.
1599 * Unlike priv_data, this is not codec-specific. It is used in general
1600 * libavcodec functions.
1602 struct AVCodecInternal *internal;
1605 * Private data of the user, can be used to carry app specific stuff.
1606 * - encoding: Set by user.
1607 * - decoding: Set by user.
1612 * the average bitrate
1613 * - encoding: Set by user; unused for constant quantizer encoding.
1614 * - decoding: Set by user, may be overwritten by libavcodec
1615 * if this info is available in the stream
1620 * number of bits the bitstream is allowed to diverge from the reference.
1621 * the reference can be CBR (for CBR pass1) or VBR (for pass2)
1622 * - encoding: Set by user; unused for constant quantizer encoding.
1623 * - decoding: unused
1625 int bit_rate_tolerance;
1628 * Global quality for codecs which cannot change it per frame.
1629 * This should be proportional to MPEG-1/2/4 qscale.
1630 * - encoding: Set by user.
1631 * - decoding: unused
1636 * - encoding: Set by user.
1637 * - decoding: unused
1639 int compression_level;
1640 #define FF_COMPRESSION_DEFAULT -1
1644 * - encoding: Set by user.
1645 * - decoding: Set by user.
1651 * - encoding: Set by user.
1652 * - decoding: Set by user.
1657 * some codecs need / can use extradata like Huffman tables.
1658 * MJPEG: Huffman tables
1659 * rv10: additional flags
1660 * MPEG-4: global headers (they can be in the bitstream or here)
1661 * The allocated memory should be AV_INPUT_BUFFER_PADDING_SIZE bytes larger
1662 * than extradata_size to avoid problems if it is read with the bitstream reader.
1663 * The bytewise contents of extradata must not depend on the architecture or CPU endianness.
1664 * Must be allocated with the av_malloc() family of functions.
1665 * - encoding: Set/allocated/freed by libavcodec.
1666 * - decoding: Set/allocated/freed by user.
1672 * This is the fundamental unit of time (in seconds) in terms
1673 * of which frame timestamps are represented. For fixed-fps content,
1674 * timebase should be 1/framerate and timestamp increments should be
1676 * This often, but not always is the inverse of the frame rate or field rate
1677 * for video. 1/time_base is not the average frame rate if the frame rate is not
1680 * Like containers, elementary streams also can store timestamps, 1/time_base
1681 * is the unit in which these timestamps are specified.
1682 * As example of such codec time base see ISO/IEC 14496-2:2001(E)
1683 * vop_time_increment_resolution and fixed_vop_rate
1684 * (fixed_vop_rate == 0 implies that it is different from the framerate)
1686 * - encoding: MUST be set by user.
1687 * - decoding: the use of this field for decoding is deprecated.
1688 * Use framerate instead.
1690 AVRational time_base;
1693 * For some codecs, the time base is closer to the field rate than the frame rate.
1694 * Most notably, H.264 and MPEG-2 specify time_base as half of frame duration
1695 * if no telecine is used ...
1697 * Set to time_base ticks per frame. Default 1, e.g., H.264/MPEG-2 set it to 2.
1699 int ticks_per_frame;
1704 * Encoding: Number of frames delay there will be from the encoder input to
1705 * the decoder output. (we assume the decoder matches the spec)
1706 * Decoding: Number of frames delay in addition to what a standard decoder
1707 * as specified in the spec would produce.
1710 * Number of frames the decoded output will be delayed relative to the
1714 * For encoding, this field is unused (see initial_padding).
1716 * For decoding, this is the number of samples the decoder needs to
1717 * output before the decoder's output is valid. When seeking, you should
1718 * start decoding this many samples prior to your desired seek point.
1720 * - encoding: Set by libavcodec.
1721 * - decoding: Set by libavcodec.
1728 * picture width / height.
1730 * @note Those fields may not match the values of the last
1731 * AVFrame output by avcodec_decode_video2 due frame
1734 * - encoding: MUST be set by user.
1735 * - decoding: May be set by the user before opening the decoder if known e.g.
1736 * from the container. Some decoders will require the dimensions
1737 * to be set by the caller. During decoding, the decoder may
1738 * overwrite those values as required while parsing the data.
1743 * Bitstream width / height, may be different from width/height e.g. when
1744 * the decoded frame is cropped before being output or lowres is enabled.
1746 * @note Those field may not match the value of the last
1747 * AVFrame output by avcodec_receive_frame() due frame
1750 * - encoding: unused
1751 * - decoding: May be set by the user before opening the decoder if known
1752 * e.g. from the container. During decoding, the decoder may
1753 * overwrite those values as required while parsing the data.
1755 int coded_width, coded_height;
1758 * the number of pictures in a group of pictures, or 0 for intra_only
1759 * - encoding: Set by user.
1760 * - decoding: unused
1765 * Pixel format, see AV_PIX_FMT_xxx.
1766 * May be set by the demuxer if known from headers.
1767 * May be overridden by the decoder if it knows better.
1769 * @note This field may not match the value of the last
1770 * AVFrame output by avcodec_receive_frame() due frame
1773 * - encoding: Set by user.
1774 * - decoding: Set by user if known, overridden by libavcodec while
1777 enum AVPixelFormat pix_fmt;
1780 * If non NULL, 'draw_horiz_band' is called by the libavcodec
1781 * decoder to draw a horizontal band. It improves cache usage. Not
1782 * all codecs can do that. You must check the codec capabilities
1784 * When multithreading is used, it may be called from multiple threads
1785 * at the same time; threads might draw different parts of the same AVFrame,
1786 * or multiple AVFrames, and there is no guarantee that slices will be drawn
1788 * The function is also used by hardware acceleration APIs.
1789 * It is called at least once during frame decoding to pass
1790 * the data needed for hardware render.
1791 * In that mode instead of pixel data, AVFrame points to
1792 * a structure specific to the acceleration API. The application
1793 * reads the structure and can change some fields to indicate progress
1795 * - encoding: unused
1796 * - decoding: Set by user.
1797 * @param height the height of the slice
1798 * @param y the y position of the slice
1799 * @param type 1->top field, 2->bottom field, 3->frame
1800 * @param offset offset into the AVFrame.data from which the slice should be read
1802 void (*draw_horiz_band)(struct AVCodecContext *s,
1803 const AVFrame *src, int offset[AV_NUM_DATA_POINTERS],
1804 int y, int type, int height);
1807 * callback to negotiate the pixelFormat
1808 * @param fmt is the list of formats which are supported by the codec,
1809 * it is terminated by -1 as 0 is a valid format, the formats are ordered by quality.
1810 * The first is always the native one.
1811 * @note The callback may be called again immediately if initialization for
1812 * the selected (hardware-accelerated) pixel format failed.
1813 * @warning Behavior is undefined if the callback returns a value not
1814 * in the fmt list of formats.
1815 * @return the chosen format
1816 * - encoding: unused
1817 * - decoding: Set by user, if not set the native format will be chosen.
1819 enum AVPixelFormat (*get_format)(struct AVCodecContext *s, const enum AVPixelFormat * fmt);
1822 * maximum number of B-frames between non-B-frames
1823 * Note: The output will be delayed by max_b_frames+1 relative to the input.
1824 * - encoding: Set by user.
1825 * - decoding: unused
1830 * qscale factor between IP and B-frames
1831 * If > 0 then the last P-frame quantizer will be used (q= lastp_q*factor+offset).
1832 * If < 0 then normal ratecontrol will be done (q= -normal_q*factor+offset).
1833 * - encoding: Set by user.
1834 * - decoding: unused
1836 float b_quant_factor;
1838 #if FF_API_PRIVATE_OPT
1839 /** @deprecated use encoder private options instead */
1840 attribute_deprecated
1841 int b_frame_strategy;
1845 * qscale offset between IP and B-frames
1846 * - encoding: Set by user.
1847 * - decoding: unused
1849 float b_quant_offset;
1852 * Size of the frame reordering buffer in the decoder.
1853 * For MPEG-2 it is 1 IPB or 0 low delay IP.
1854 * - encoding: Set by libavcodec.
1855 * - decoding: Set by libavcodec.
1859 #if FF_API_PRIVATE_OPT
1860 /** @deprecated use encoder private options instead */
1861 attribute_deprecated
1866 * qscale factor between P- and I-frames
1867 * If > 0 then the last P-frame quantizer will be used (q = lastp_q * factor + offset).
1868 * If < 0 then normal ratecontrol will be done (q= -normal_q*factor+offset).
1869 * - encoding: Set by user.
1870 * - decoding: unused
1872 float i_quant_factor;
1875 * qscale offset between P and I-frames
1876 * - encoding: Set by user.
1877 * - decoding: unused
1879 float i_quant_offset;
1882 * luminance masking (0-> disabled)
1883 * - encoding: Set by user.
1884 * - decoding: unused
1889 * temporary complexity masking (0-> disabled)
1890 * - encoding: Set by user.
1891 * - decoding: unused
1893 float temporal_cplx_masking;
1896 * spatial complexity masking (0-> disabled)
1897 * - encoding: Set by user.
1898 * - decoding: unused
1900 float spatial_cplx_masking;
1903 * p block masking (0-> disabled)
1904 * - encoding: Set by user.
1905 * - decoding: unused
1910 * darkness masking (0-> disabled)
1911 * - encoding: Set by user.
1912 * - decoding: unused
1918 * - encoding: Set by libavcodec.
1919 * - decoding: Set by user (or 0).
1923 #if FF_API_PRIVATE_OPT
1924 /** @deprecated use encoder private options instead */
1925 attribute_deprecated
1926 int prediction_method;
1927 #define FF_PRED_LEFT 0
1928 #define FF_PRED_PLANE 1
1929 #define FF_PRED_MEDIAN 2
1933 * slice offsets in the frame in bytes
1934 * - encoding: Set/allocated by libavcodec.
1935 * - decoding: Set/allocated by user (or NULL).
1940 * sample aspect ratio (0 if unknown)
1941 * That is the width of a pixel divided by the height of the pixel.
1942 * Numerator and denominator must be relatively prime and smaller than 256 for some video standards.
1943 * - encoding: Set by user.
1944 * - decoding: Set by libavcodec.
1946 AVRational sample_aspect_ratio;
1949 * motion estimation comparison function
1950 * - encoding: Set by user.
1951 * - decoding: unused
1955 * subpixel motion estimation comparison function
1956 * - encoding: Set by user.
1957 * - decoding: unused
1961 * macroblock comparison function (not supported yet)
1962 * - encoding: Set by user.
1963 * - decoding: unused
1967 * interlaced DCT comparison function
1968 * - encoding: Set by user.
1969 * - decoding: unused
1972 #define FF_CMP_SAD 0
1973 #define FF_CMP_SSE 1
1974 #define FF_CMP_SATD 2
1975 #define FF_CMP_DCT 3
1976 #define FF_CMP_PSNR 4
1977 #define FF_CMP_BIT 5
1979 #define FF_CMP_ZERO 7
1980 #define FF_CMP_VSAD 8
1981 #define FF_CMP_VSSE 9
1982 #define FF_CMP_NSSE 10
1983 #define FF_CMP_W53 11
1984 #define FF_CMP_W97 12
1985 #define FF_CMP_DCTMAX 13
1986 #define FF_CMP_DCT264 14
1987 #define FF_CMP_MEDIAN_SAD 15
1988 #define FF_CMP_CHROMA 256
1991 * ME diamond size & shape
1992 * - encoding: Set by user.
1993 * - decoding: unused
1998 * amount of previous MV predictors (2a+1 x 2a+1 square)
1999 * - encoding: Set by user.
2000 * - decoding: unused
2002 int last_predictor_count;
2004 #if FF_API_PRIVATE_OPT
2005 /** @deprecated use encoder private options instead */
2006 attribute_deprecated
2011 * motion estimation prepass comparison function
2012 * - encoding: Set by user.
2013 * - decoding: unused
2018 * ME prepass diamond size & shape
2019 * - encoding: Set by user.
2020 * - decoding: unused
2026 * - encoding: Set by user.
2027 * - decoding: unused
2029 int me_subpel_quality;
2032 * maximum motion estimation search range in subpel units
2033 * If 0 then no limit.
2035 * - encoding: Set by user.
2036 * - decoding: unused
2042 * - encoding: unused
2043 * - decoding: Set by user.
2046 #define SLICE_FLAG_CODED_ORDER 0x0001 ///< draw_horiz_band() is called in coded order instead of display
2047 #define SLICE_FLAG_ALLOW_FIELD 0x0002 ///< allow draw_horiz_band() with field slices (MPEG-2 field pics)
2048 #define SLICE_FLAG_ALLOW_PLANE 0x0004 ///< allow draw_horiz_band() with 1 component at a time (SVQ1)
2051 * macroblock decision mode
2052 * - encoding: Set by user.
2053 * - decoding: unused
2056 #define FF_MB_DECISION_SIMPLE 0 ///< uses mb_cmp
2057 #define FF_MB_DECISION_BITS 1 ///< chooses the one which needs the fewest bits
2058 #define FF_MB_DECISION_RD 2 ///< rate distortion
2061 * custom intra quantization matrix
2062 * Must be allocated with the av_malloc() family of functions, and will be freed in
2063 * avcodec_free_context().
2064 * - encoding: Set/allocated by user, freed by libavcodec. Can be NULL.
2065 * - decoding: Set/allocated/freed by libavcodec.
2067 uint16_t *intra_matrix;
2070 * custom inter quantization matrix
2071 * Must be allocated with the av_malloc() family of functions, and will be freed in
2072 * avcodec_free_context().
2073 * - encoding: Set/allocated by user, freed by libavcodec. Can be NULL.
2074 * - decoding: Set/allocated/freed by libavcodec.
2076 uint16_t *inter_matrix;
2078 #if FF_API_PRIVATE_OPT
2079 /** @deprecated use encoder private options instead */
2080 attribute_deprecated
2081 int scenechange_threshold;
2083 /** @deprecated use encoder private options instead */
2084 attribute_deprecated
2085 int noise_reduction;
2089 * precision of the intra DC coefficient - 8
2090 * - encoding: Set by user.
2091 * - decoding: Set by libavcodec
2093 int intra_dc_precision;
2096 * Number of macroblock rows at the top which are skipped.
2097 * - encoding: unused
2098 * - decoding: Set by user.
2103 * Number of macroblock rows at the bottom which are skipped.
2104 * - encoding: unused
2105 * - decoding: Set by user.
2110 * minimum MB Lagrange multiplier
2111 * - encoding: Set by user.
2112 * - decoding: unused
2117 * maximum MB Lagrange multiplier
2118 * - encoding: Set by user.
2119 * - decoding: unused
2123 #if FF_API_PRIVATE_OPT
2125 * @deprecated use encoder private options instead
2127 attribute_deprecated
2128 int me_penalty_compensation;
2132 * - encoding: Set by user.
2133 * - decoding: unused
2137 #if FF_API_PRIVATE_OPT
2138 /** @deprecated use encoder private options instead */
2139 attribute_deprecated
2145 * - encoding: Set by user.
2146 * - decoding: unused
2151 * number of reference frames
2152 * - encoding: Set by user.
2153 * - decoding: Set by lavc.
2157 #if FF_API_PRIVATE_OPT
2158 /** @deprecated use encoder private options instead */
2159 attribute_deprecated
2164 * Note: Value depends upon the compare function used for fullpel ME.
2165 * - encoding: Set by user.
2166 * - decoding: unused
2170 #if FF_API_PRIVATE_OPT
2171 /** @deprecated use encoder private options instead */
2172 attribute_deprecated
2177 * Chromaticity coordinates of the source primaries.
2178 * - encoding: Set by user
2179 * - decoding: Set by libavcodec
2181 enum AVColorPrimaries color_primaries;
2184 * Color Transfer Characteristic.
2185 * - encoding: Set by user
2186 * - decoding: Set by libavcodec
2188 enum AVColorTransferCharacteristic color_trc;
2191 * YUV colorspace type.
2192 * - encoding: Set by user
2193 * - decoding: Set by libavcodec
2195 enum AVColorSpace colorspace;
2198 * MPEG vs JPEG YUV range.
2199 * - encoding: Set by user
2200 * - decoding: Set by libavcodec
2202 enum AVColorRange color_range;
2205 * This defines the location of chroma samples.
2206 * - encoding: Set by user
2207 * - decoding: Set by libavcodec
2209 enum AVChromaLocation chroma_sample_location;
2213 * Indicates number of picture subdivisions. Used for parallelized
2215 * - encoding: Set by user
2216 * - decoding: unused
2221 * - encoding: set by libavcodec
2222 * - decoding: Set by user.
2224 enum AVFieldOrder field_order;
2227 int sample_rate; ///< samples per second
2228 int channels; ///< number of audio channels
2231 * audio sample format
2232 * - encoding: Set by user.
2233 * - decoding: Set by libavcodec.
2235 enum AVSampleFormat sample_fmt; ///< sample format
2237 /* The following data should not be initialized. */
2239 * Number of samples per channel in an audio frame.
2241 * - encoding: set by libavcodec in avcodec_open2(). Each submitted frame
2242 * except the last must contain exactly frame_size samples per channel.
2243 * May be 0 when the codec has AV_CODEC_CAP_VARIABLE_FRAME_SIZE set, then the
2244 * frame size is not restricted.
2245 * - decoding: may be set by some decoders to indicate constant frame size
2250 * Frame counter, set by libavcodec.
2252 * - decoding: total number of frames returned from the decoder so far.
2253 * - encoding: total number of frames passed to the encoder so far.
2255 * @note the counter is not incremented if encoding/decoding resulted in
2261 * number of bytes per packet if constant and known or 0
2262 * Used by some WAV based audio codecs.
2267 * Audio cutoff bandwidth (0 means "automatic")
2268 * - encoding: Set by user.
2269 * - decoding: unused
2274 * Audio channel layout.
2275 * - encoding: set by user.
2276 * - decoding: set by user, may be overwritten by libavcodec.
2278 uint64_t channel_layout;
2281 * Request decoder to use this channel layout if it can (0 for default)
2282 * - encoding: unused
2283 * - decoding: Set by user.
2285 uint64_t request_channel_layout;
2288 * Type of service that the audio stream conveys.
2289 * - encoding: Set by user.
2290 * - decoding: Set by libavcodec.
2292 enum AVAudioServiceType audio_service_type;
2295 * desired sample format
2296 * - encoding: Not used.
2297 * - decoding: Set by user.
2298 * Decoder will decode to this format if it can.
2300 enum AVSampleFormat request_sample_fmt;
2303 * This callback is called at the beginning of each frame to get data
2304 * buffer(s) for it. There may be one contiguous buffer for all the data or
2305 * there may be a buffer per each data plane or anything in between. What
2306 * this means is, you may set however many entries in buf[] you feel necessary.
2307 * Each buffer must be reference-counted using the AVBuffer API (see description
2310 * The following fields will be set in the frame before this callback is
2313 * - width, height (video only)
2314 * - sample_rate, channel_layout, nb_samples (audio only)
2315 * Their values may differ from the corresponding values in
2316 * AVCodecContext. This callback must use the frame values, not the codec
2317 * context values, to calculate the required buffer size.
2319 * This callback must fill the following fields in the frame:
2323 * * if the data is planar audio with more than 8 channels, then this
2324 * callback must allocate and fill extended_data to contain all pointers
2325 * to all data planes. data[] must hold as many pointers as it can.
2326 * extended_data must be allocated with av_malloc() and will be freed in
2328 * * otherwise extended_data must point to data
2329 * - buf[] must contain one or more pointers to AVBufferRef structures. Each of
2330 * the frame's data and extended_data pointers must be contained in these. That
2331 * is, one AVBufferRef for each allocated chunk of memory, not necessarily one
2332 * AVBufferRef per data[] entry. See: av_buffer_create(), av_buffer_alloc(),
2333 * and av_buffer_ref().
2334 * - extended_buf and nb_extended_buf must be allocated with av_malloc() by
2335 * this callback and filled with the extra buffers if there are more
2336 * buffers than buf[] can hold. extended_buf will be freed in
2339 * If AV_CODEC_CAP_DR1 is not set then get_buffer2() must call
2340 * avcodec_default_get_buffer2() instead of providing buffers allocated by
2343 * Each data plane must be aligned to the maximum required by the target
2346 * @see avcodec_default_get_buffer2()
2350 * If AV_GET_BUFFER_FLAG_REF is set in flags then the frame may be reused
2351 * (read and/or written to if it is writable) later by libavcodec.
2353 * avcodec_align_dimensions2() should be used to find the required width and
2354 * height, as they normally need to be rounded up to the next multiple of 16.
2356 * Some decoders do not support linesizes changing between frames.
2358 * If frame multithreading is used and thread_safe_callbacks is set,
2359 * this callback may be called from a different thread, but not from more
2360 * than one at once. Does not need to be reentrant.
2362 * @see avcodec_align_dimensions2()
2366 * Decoders request a buffer of a particular size by setting
2367 * AVFrame.nb_samples prior to calling get_buffer2(). The decoder may,
2368 * however, utilize only part of the buffer by setting AVFrame.nb_samples
2369 * to a smaller value in the output frame.
2371 * As a convenience, av_samples_get_buffer_size() and
2372 * av_samples_fill_arrays() in libavutil may be used by custom get_buffer2()
2373 * functions to find the required data size and to fill data pointers and
2374 * linesize. In AVFrame.linesize, only linesize[0] may be set for audio
2375 * since all planes must be the same size.
2377 * @see av_samples_get_buffer_size(), av_samples_fill_arrays()
2379 * - encoding: unused
2380 * - decoding: Set by libavcodec, user can override.
2382 int (*get_buffer2)(struct AVCodecContext *s, AVFrame *frame, int flags);
2385 * If non-zero, the decoded audio and video frames returned from
2386 * avcodec_decode_video2() and avcodec_decode_audio4() are reference-counted
2387 * and are valid indefinitely. The caller must free them with
2388 * av_frame_unref() when they are not needed anymore.
2389 * Otherwise, the decoded frames must not be freed by the caller and are
2390 * only valid until the next decode call.
2392 * This is always automatically enabled if avcodec_receive_frame() is used.
2394 * - encoding: unused
2395 * - decoding: set by the caller before avcodec_open2().
2397 attribute_deprecated
2398 int refcounted_frames;
2400 /* - encoding parameters */
2401 float qcompress; ///< amount of qscale change between easy & hard scenes (0.0-1.0)
2402 float qblur; ///< amount of qscale smoothing over time (0.0-1.0)
2406 * - encoding: Set by user.
2407 * - decoding: unused
2413 * - encoding: Set by user.
2414 * - decoding: unused
2419 * maximum quantizer difference between frames
2420 * - encoding: Set by user.
2421 * - decoding: unused
2426 * decoder bitstream buffer size
2427 * - encoding: Set by user.
2428 * - decoding: unused
2433 * ratecontrol override, see RcOverride
2434 * - encoding: Allocated/set/freed by user.
2435 * - decoding: unused
2437 int rc_override_count;
2438 RcOverride *rc_override;
2442 * - encoding: Set by user.
2443 * - decoding: Set by user, may be overwritten by libavcodec.
2445 int64_t rc_max_rate;
2449 * - encoding: Set by user.
2450 * - decoding: unused
2452 int64_t rc_min_rate;
2455 * Ratecontrol attempt to use, at maximum, <value> of what can be used without an underflow.
2456 * - encoding: Set by user.
2457 * - decoding: unused.
2459 float rc_max_available_vbv_use;
2462 * Ratecontrol attempt to use, at least, <value> times the amount needed to prevent a vbv overflow.
2463 * - encoding: Set by user.
2464 * - decoding: unused.
2466 float rc_min_vbv_overflow_use;
2469 * Number of bits which should be loaded into the rc buffer before decoding starts.
2470 * - encoding: Set by user.
2471 * - decoding: unused
2473 int rc_initial_buffer_occupancy;
2475 #if FF_API_CODER_TYPE
2476 #define FF_CODER_TYPE_VLC 0
2477 #define FF_CODER_TYPE_AC 1
2478 #define FF_CODER_TYPE_RAW 2
2479 #define FF_CODER_TYPE_RLE 3
2481 * @deprecated use encoder private options instead
2483 attribute_deprecated
2485 #endif /* FF_API_CODER_TYPE */
2487 #if FF_API_PRIVATE_OPT
2488 /** @deprecated use encoder private options instead */
2489 attribute_deprecated
2493 #if FF_API_PRIVATE_OPT
2494 /** @deprecated use encoder private options instead */
2495 attribute_deprecated
2496 int frame_skip_threshold;
2498 /** @deprecated use encoder private options instead */
2499 attribute_deprecated
2500 int frame_skip_factor;
2502 /** @deprecated use encoder private options instead */
2503 attribute_deprecated
2506 /** @deprecated use encoder private options instead */
2507 attribute_deprecated
2509 #endif /* FF_API_PRIVATE_OPT */
2512 * trellis RD quantization
2513 * - encoding: Set by user.
2514 * - decoding: unused
2518 #if FF_API_PRIVATE_OPT
2519 /** @deprecated use encoder private options instead */
2520 attribute_deprecated
2521 int min_prediction_order;
2523 /** @deprecated use encoder private options instead */
2524 attribute_deprecated
2525 int max_prediction_order;
2527 /** @deprecated use encoder private options instead */
2528 attribute_deprecated
2529 int64_t timecode_frame_start;
2532 #if FF_API_RTP_CALLBACK
2534 * @deprecated unused
2536 /* The RTP callback: This function is called */
2537 /* every time the encoder has a packet to send. */
2538 /* It depends on the encoder if the data starts */
2539 /* with a Start Code (it should). H.263 does. */
2540 /* mb_nb contains the number of macroblocks */
2541 /* encoded in the RTP payload. */
2542 attribute_deprecated
2543 void (*rtp_callback)(struct AVCodecContext *avctx, void *data, int size, int mb_nb);
2546 #if FF_API_PRIVATE_OPT
2547 /** @deprecated use encoder private options instead */
2548 attribute_deprecated
2549 int rtp_payload_size; /* The size of the RTP payload: the coder will */
2550 /* do its best to deliver a chunk with size */
2551 /* below rtp_payload_size, the chunk will start */
2552 /* with a start code on some codecs like H.263. */
2553 /* This doesn't take account of any particular */
2554 /* headers inside the transmitted RTP payload. */
2557 #if FF_API_STAT_BITS
2558 /* statistics, used for 2-pass encoding */
2559 attribute_deprecated
2561 attribute_deprecated
2563 attribute_deprecated
2565 attribute_deprecated
2567 attribute_deprecated
2569 attribute_deprecated
2571 attribute_deprecated
2573 attribute_deprecated
2576 /** @deprecated this field is unused */
2577 attribute_deprecated
2582 * pass1 encoding statistics output buffer
2583 * - encoding: Set by libavcodec.
2584 * - decoding: unused
2589 * pass2 encoding statistics input buffer
2590 * Concatenated stuff from stats_out of pass1 should be placed here.
2591 * - encoding: Allocated/set/freed by user.
2592 * - decoding: unused
2597 * Work around bugs in encoders which sometimes cannot be detected automatically.
2598 * - encoding: Set by user
2599 * - decoding: Set by user
2601 int workaround_bugs;
2602 #define FF_BUG_AUTODETECT 1 ///< autodetection
2603 #define FF_BUG_XVID_ILACE 4
2604 #define FF_BUG_UMP4 8
2605 #define FF_BUG_NO_PADDING 16
2606 #define FF_BUG_AMV 32
2607 #define FF_BUG_QPEL_CHROMA 64
2608 #define FF_BUG_STD_QPEL 128
2609 #define FF_BUG_QPEL_CHROMA2 256
2610 #define FF_BUG_DIRECT_BLOCKSIZE 512
2611 #define FF_BUG_EDGE 1024
2612 #define FF_BUG_HPEL_CHROMA 2048
2613 #define FF_BUG_DC_CLIP 4096
2614 #define FF_BUG_MS 8192 ///< Work around various bugs in Microsoft's broken decoders.
2615 #define FF_BUG_TRUNCATED 16384
2616 #define FF_BUG_IEDGE 32768
2619 * strictly follow the standard (MPEG-4, ...).
2620 * - encoding: Set by user.
2621 * - decoding: Set by user.
2622 * Setting this to STRICT or higher means the encoder and decoder will
2623 * generally do stupid things, whereas setting it to unofficial or lower
2624 * will mean the encoder might produce output that is not supported by all
2625 * spec-compliant decoders. Decoders don't differentiate between normal,
2626 * unofficial and experimental (that is, they always try to decode things
2627 * when they can) unless they are explicitly asked to behave stupidly
2628 * (=strictly conform to the specs)
2630 int strict_std_compliance;
2631 #define FF_COMPLIANCE_VERY_STRICT 2 ///< Strictly conform to an older more strict version of the spec or reference software.
2632 #define FF_COMPLIANCE_STRICT 1 ///< Strictly conform to all the things in the spec no matter what consequences.
2633 #define FF_COMPLIANCE_NORMAL 0
2634 #define FF_COMPLIANCE_UNOFFICIAL -1 ///< Allow unofficial extensions
2635 #define FF_COMPLIANCE_EXPERIMENTAL -2 ///< Allow nonstandardized experimental things.
2638 * error concealment flags
2639 * - encoding: unused
2640 * - decoding: Set by user.
2642 int error_concealment;
2643 #define FF_EC_GUESS_MVS 1
2644 #define FF_EC_DEBLOCK 2
2645 #define FF_EC_FAVOR_INTER 256
2649 * - encoding: Set by user.
2650 * - decoding: Set by user.
2653 #define FF_DEBUG_PICT_INFO 1
2654 #define FF_DEBUG_RC 2
2655 #define FF_DEBUG_BITSTREAM 4
2656 #define FF_DEBUG_MB_TYPE 8
2657 #define FF_DEBUG_QP 16
2660 * @deprecated this option does nothing
2662 #define FF_DEBUG_MV 32
2664 #define FF_DEBUG_DCT_COEFF 0x00000040
2665 #define FF_DEBUG_SKIP 0x00000080
2666 #define FF_DEBUG_STARTCODE 0x00000100
2667 #define FF_DEBUG_ER 0x00000400
2668 #define FF_DEBUG_MMCO 0x00000800
2669 #define FF_DEBUG_BUGS 0x00001000
2671 #define FF_DEBUG_VIS_QP 0x00002000
2672 #define FF_DEBUG_VIS_MB_TYPE 0x00004000
2674 #define FF_DEBUG_BUFFERS 0x00008000
2675 #define FF_DEBUG_THREADS 0x00010000
2676 #define FF_DEBUG_GREEN_MD 0x00800000
2677 #define FF_DEBUG_NOMC 0x01000000
2682 * - encoding: Set by user.
2683 * - decoding: Set by user.
2686 #define FF_DEBUG_VIS_MV_P_FOR 0x00000001 // visualize forward predicted MVs of P-frames
2687 #define FF_DEBUG_VIS_MV_B_FOR 0x00000002 // visualize forward predicted MVs of B-frames
2688 #define FF_DEBUG_VIS_MV_B_BACK 0x00000004 // visualize backward predicted MVs of B-frames
2692 * Error recognition; may misdetect some more or less valid parts as errors.
2693 * - encoding: unused
2694 * - decoding: Set by user.
2696 int err_recognition;
2699 * Verify checksums embedded in the bitstream (could be of either encoded or
2700 * decoded data, depending on the codec) and print an error message on mismatch.
2701 * If AV_EF_EXPLODE is also set, a mismatching checksum will result in the
2702 * decoder returning an error.
2704 #define AV_EF_CRCCHECK (1<<0)
2705 #define AV_EF_BITSTREAM (1<<1) ///< detect bitstream specification deviations
2706 #define AV_EF_BUFFER (1<<2) ///< detect improper bitstream length
2707 #define AV_EF_EXPLODE (1<<3) ///< abort decoding on minor error detection
2709 #define AV_EF_IGNORE_ERR (1<<15) ///< ignore errors and continue
2710 #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
2711 #define AV_EF_COMPLIANT (1<<17) ///< consider all spec non compliances as errors
2712 #define AV_EF_AGGRESSIVE (1<<18) ///< consider things that a sane encoder should not do as an error
2716 * opaque 64-bit number (generally a PTS) that will be reordered and
2717 * output in AVFrame.reordered_opaque
2718 * - encoding: Set by libavcodec to the reordered_opaque of the input
2719 * frame corresponding to the last returned packet. Only
2720 * supported by encoders with the
2721 * AV_CODEC_CAP_ENCODER_REORDERED_OPAQUE capability.
2722 * - decoding: Set by user.
2724 int64_t reordered_opaque;
2727 * Hardware accelerator in use
2728 * - encoding: unused.
2729 * - decoding: Set by libavcodec
2731 const struct AVHWAccel *hwaccel;
2734 * Hardware accelerator context.
2735 * For some hardware accelerators, a global context needs to be
2736 * provided by the user. In that case, this holds display-dependent
2737 * data FFmpeg cannot instantiate itself. Please refer to the
2738 * FFmpeg HW accelerator documentation to know how to fill this
2739 * is. e.g. for VA API, this is a struct vaapi_context.
2740 * - encoding: unused
2741 * - decoding: Set by user
2743 void *hwaccel_context;
2747 * - encoding: Set by libavcodec if flags & AV_CODEC_FLAG_PSNR.
2748 * - decoding: unused
2750 uint64_t error[AV_NUM_DATA_POINTERS];
2753 * DCT algorithm, see FF_DCT_* below
2754 * - encoding: Set by user.
2755 * - decoding: unused
2758 #define FF_DCT_AUTO 0
2759 #define FF_DCT_FASTINT 1
2760 #define FF_DCT_INT 2
2761 #define FF_DCT_MMX 3
2762 #define FF_DCT_ALTIVEC 5
2763 #define FF_DCT_FAAN 6
2766 * IDCT algorithm, see FF_IDCT_* below.
2767 * - encoding: Set by user.
2768 * - decoding: Set by user.
2771 #define FF_IDCT_AUTO 0
2772 #define FF_IDCT_INT 1
2773 #define FF_IDCT_SIMPLE 2
2774 #define FF_IDCT_SIMPLEMMX 3
2775 #define FF_IDCT_ARM 7
2776 #define FF_IDCT_ALTIVEC 8
2777 #define FF_IDCT_SIMPLEARM 10
2778 #define FF_IDCT_XVID 14
2779 #define FF_IDCT_SIMPLEARMV5TE 16
2780 #define FF_IDCT_SIMPLEARMV6 17
2781 #define FF_IDCT_FAAN 20
2782 #define FF_IDCT_SIMPLENEON 22
2783 #define FF_IDCT_NONE 24 /* Used by XvMC to extract IDCT coefficients with FF_IDCT_PERM_NONE */
2784 #define FF_IDCT_SIMPLEAUTO 128
2787 * bits per sample/pixel from the demuxer (needed for huffyuv).
2788 * - encoding: Set by libavcodec.
2789 * - decoding: Set by user.
2791 int bits_per_coded_sample;
2794 * Bits per sample/pixel of internal libavcodec pixel/sample format.
2795 * - encoding: set by user.
2796 * - decoding: set by libavcodec.
2798 int bits_per_raw_sample;
2802 * low resolution decoding, 1-> 1/2 size, 2->1/4 size
2803 * - encoding: unused
2804 * - decoding: Set by user.
2809 #if FF_API_CODED_FRAME
2811 * the picture in the bitstream
2812 * - encoding: Set by libavcodec.
2813 * - decoding: unused
2815 * @deprecated use the quality factor packet side data instead
2817 attribute_deprecated AVFrame *coded_frame;
2822 * is used to decide how many independent tasks should be passed to execute()
2823 * - encoding: Set by user.
2824 * - decoding: Set by user.
2829 * Which multithreading methods to use.
2830 * Use of FF_THREAD_FRAME will increase decoding delay by one frame per thread,
2831 * so clients which cannot provide future frames should not use it.
2833 * - encoding: Set by user, otherwise the default is used.
2834 * - decoding: Set by user, otherwise the default is used.
2837 #define FF_THREAD_FRAME 1 ///< Decode more than one frame at once
2838 #define FF_THREAD_SLICE 2 ///< Decode more than one part of a single frame at once
2841 * Which multithreading methods are in use by the codec.
2842 * - encoding: Set by libavcodec.
2843 * - decoding: Set by libavcodec.
2845 int active_thread_type;
2848 * Set by the client if its custom get_buffer() callback can be called
2849 * synchronously from another thread, which allows faster multithreaded decoding.
2850 * draw_horiz_band() will be called from other threads regardless of this setting.
2851 * Ignored if the default get_buffer() is used.
2852 * - encoding: Set by user.
2853 * - decoding: Set by user.
2855 int thread_safe_callbacks;
2858 * The codec may call this to execute several independent things.
2859 * It will return only after finishing all tasks.
2860 * The user may replace this with some multithreaded implementation,
2861 * the default implementation will execute the parts serially.
2862 * @param count the number of things to execute
2863 * - encoding: Set by libavcodec, user can override.
2864 * - decoding: Set by libavcodec, user can override.
2866 int (*execute)(struct AVCodecContext *c, int (*func)(struct AVCodecContext *c2, void *arg), void *arg2, int *ret, int count, int size);
2869 * The codec may call this to execute several independent things.
2870 * It will return only after finishing all tasks.
2871 * The user may replace this with some multithreaded implementation,
2872 * the default implementation will execute the parts serially.
2873 * Also see avcodec_thread_init and e.g. the --enable-pthread configure option.
2874 * @param c context passed also to func
2875 * @param count the number of things to execute
2876 * @param arg2 argument passed unchanged to func
2877 * @param ret return values of executed functions, must have space for "count" values. May be NULL.
2878 * @param func function that will be called count times, with jobnr from 0 to count-1.
2879 * threadnr will be in the range 0 to c->thread_count-1 < MAX_THREADS and so that no
2880 * two instances of func executing at the same time will have the same threadnr.
2881 * @return always 0 currently, but code should handle a future improvement where when any call to func
2882 * returns < 0 no further calls to func may be done and < 0 is returned.
2883 * - encoding: Set by libavcodec, user can override.
2884 * - decoding: Set by libavcodec, user can override.
2886 int (*execute2)(struct AVCodecContext *c, int (*func)(struct AVCodecContext *c2, void *arg, int jobnr, int threadnr), void *arg2, int *ret, int count);
2889 * noise vs. sse weight for the nsse comparison function
2890 * - encoding: Set by user.
2891 * - decoding: unused
2897 * - encoding: Set by user.
2898 * - decoding: Set by libavcodec.
2901 #define FF_PROFILE_UNKNOWN -99
2902 #define FF_PROFILE_RESERVED -100
2904 #define FF_PROFILE_AAC_MAIN 0
2905 #define FF_PROFILE_AAC_LOW 1
2906 #define FF_PROFILE_AAC_SSR 2
2907 #define FF_PROFILE_AAC_LTP 3
2908 #define FF_PROFILE_AAC_HE 4
2909 #define FF_PROFILE_AAC_HE_V2 28
2910 #define FF_PROFILE_AAC_LD 22
2911 #define FF_PROFILE_AAC_ELD 38
2912 #define FF_PROFILE_MPEG2_AAC_LOW 128
2913 #define FF_PROFILE_MPEG2_AAC_HE 131
2915 #define FF_PROFILE_DNXHD 0
2916 #define FF_PROFILE_DNXHR_LB 1
2917 #define FF_PROFILE_DNXHR_SQ 2
2918 #define FF_PROFILE_DNXHR_HQ 3
2919 #define FF_PROFILE_DNXHR_HQX 4
2920 #define FF_PROFILE_DNXHR_444 5
2922 #define FF_PROFILE_DTS 20
2923 #define FF_PROFILE_DTS_ES 30
2924 #define FF_PROFILE_DTS_96_24 40
2925 #define FF_PROFILE_DTS_HD_HRA 50
2926 #define FF_PROFILE_DTS_HD_MA 60
2927 #define FF_PROFILE_DTS_EXPRESS 70
2929 #define FF_PROFILE_MPEG2_422 0
2930 #define FF_PROFILE_MPEG2_HIGH 1
2931 #define FF_PROFILE_MPEG2_SS 2
2932 #define FF_PROFILE_MPEG2_SNR_SCALABLE 3
2933 #define FF_PROFILE_MPEG2_MAIN 4
2934 #define FF_PROFILE_MPEG2_SIMPLE 5
2936 #define FF_PROFILE_H264_CONSTRAINED (1<<9) // 8+1; constraint_set1_flag
2937 #define FF_PROFILE_H264_INTRA (1<<11) // 8+3; constraint_set3_flag
2939 #define FF_PROFILE_H264_BASELINE 66
2940 #define FF_PROFILE_H264_CONSTRAINED_BASELINE (66|FF_PROFILE_H264_CONSTRAINED)
2941 #define FF_PROFILE_H264_MAIN 77
2942 #define FF_PROFILE_H264_EXTENDED 88
2943 #define FF_PROFILE_H264_HIGH 100
2944 #define FF_PROFILE_H264_HIGH_10 110
2945 #define FF_PROFILE_H264_HIGH_10_INTRA (110|FF_PROFILE_H264_INTRA)
2946 #define FF_PROFILE_H264_MULTIVIEW_HIGH 118
2947 #define FF_PROFILE_H264_HIGH_422 122
2948 #define FF_PROFILE_H264_HIGH_422_INTRA (122|FF_PROFILE_H264_INTRA)
2949 #define FF_PROFILE_H264_STEREO_HIGH 128
2950 #define FF_PROFILE_H264_HIGH_444 144
2951 #define FF_PROFILE_H264_HIGH_444_PREDICTIVE 244
2952 #define FF_PROFILE_H264_HIGH_444_INTRA (244|FF_PROFILE_H264_INTRA)
2953 #define FF_PROFILE_H264_CAVLC_444 44
2955 #define FF_PROFILE_VC1_SIMPLE 0
2956 #define FF_PROFILE_VC1_MAIN 1
2957 #define FF_PROFILE_VC1_COMPLEX 2
2958 #define FF_PROFILE_VC1_ADVANCED 3
2960 #define FF_PROFILE_MPEG4_SIMPLE 0
2961 #define FF_PROFILE_MPEG4_SIMPLE_SCALABLE 1
2962 #define FF_PROFILE_MPEG4_CORE 2
2963 #define FF_PROFILE_MPEG4_MAIN 3
2964 #define FF_PROFILE_MPEG4_N_BIT 4
2965 #define FF_PROFILE_MPEG4_SCALABLE_TEXTURE 5
2966 #define FF_PROFILE_MPEG4_SIMPLE_FACE_ANIMATION 6
2967 #define FF_PROFILE_MPEG4_BASIC_ANIMATED_TEXTURE 7
2968 #define FF_PROFILE_MPEG4_HYBRID 8
2969 #define FF_PROFILE_MPEG4_ADVANCED_REAL_TIME 9
2970 #define FF_PROFILE_MPEG4_CORE_SCALABLE 10
2971 #define FF_PROFILE_MPEG4_ADVANCED_CODING 11
2972 #define FF_PROFILE_MPEG4_ADVANCED_CORE 12
2973 #define FF_PROFILE_MPEG4_ADVANCED_SCALABLE_TEXTURE 13
2974 #define FF_PROFILE_MPEG4_SIMPLE_STUDIO 14
2975 #define FF_PROFILE_MPEG4_ADVANCED_SIMPLE 15
2977 #define FF_PROFILE_JPEG2000_CSTREAM_RESTRICTION_0 1
2978 #define FF_PROFILE_JPEG2000_CSTREAM_RESTRICTION_1 2
2979 #define FF_PROFILE_JPEG2000_CSTREAM_NO_RESTRICTION 32768
2980 #define FF_PROFILE_JPEG2000_DCINEMA_2K 3
2981 #define FF_PROFILE_JPEG2000_DCINEMA_4K 4
2983 #define FF_PROFILE_VP9_0 0
2984 #define FF_PROFILE_VP9_1 1
2985 #define FF_PROFILE_VP9_2 2
2986 #define FF_PROFILE_VP9_3 3
2988 #define FF_PROFILE_HEVC_MAIN 1
2989 #define FF_PROFILE_HEVC_MAIN_10 2
2990 #define FF_PROFILE_HEVC_MAIN_STILL_PICTURE 3
2991 #define FF_PROFILE_HEVC_REXT 4
2993 #define FF_PROFILE_AV1_MAIN 0
2994 #define FF_PROFILE_AV1_HIGH 1
2995 #define FF_PROFILE_AV1_PROFESSIONAL 2
2997 #define FF_PROFILE_MJPEG_HUFFMAN_BASELINE_DCT 0xc0
2998 #define FF_PROFILE_MJPEG_HUFFMAN_EXTENDED_SEQUENTIAL_DCT 0xc1
2999 #define FF_PROFILE_MJPEG_HUFFMAN_PROGRESSIVE_DCT 0xc2
3000 #define FF_PROFILE_MJPEG_HUFFMAN_LOSSLESS 0xc3
3001 #define FF_PROFILE_MJPEG_JPEG_LS 0xf7
3003 #define FF_PROFILE_SBC_MSBC 1
3005 #define FF_PROFILE_PRORES_PROXY 0
3006 #define FF_PROFILE_PRORES_LT 1
3007 #define FF_PROFILE_PRORES_STANDARD 2
3008 #define FF_PROFILE_PRORES_HQ 3
3009 #define FF_PROFILE_PRORES_4444 4
3010 #define FF_PROFILE_PRORES_XQ 5
3012 #define FF_PROFILE_ARIB_PROFILE_A 0
3013 #define FF_PROFILE_ARIB_PROFILE_C 1
3017 * - encoding: Set by user.
3018 * - decoding: Set by libavcodec.
3021 #define FF_LEVEL_UNKNOWN -99
3024 * Skip loop filtering for selected frames.
3025 * - encoding: unused
3026 * - decoding: Set by user.
3028 enum AVDiscard skip_loop_filter;
3031 * Skip IDCT/dequantization for selected frames.
3032 * - encoding: unused
3033 * - decoding: Set by user.
3035 enum AVDiscard skip_idct;
3038 * Skip decoding for selected frames.
3039 * - encoding: unused
3040 * - decoding: Set by user.
3042 enum AVDiscard skip_frame;
3045 * Header containing style information for text subtitles.
3046 * For SUBTITLE_ASS subtitle type, it should contain the whole ASS
3047 * [Script Info] and [V4+ Styles] section, plus the [Events] line and
3048 * the Format line following. It shouldn't include any Dialogue line.
3049 * - encoding: Set/allocated/freed by user (before avcodec_open2())
3050 * - decoding: Set/allocated/freed by libavcodec (by avcodec_open2())
3052 uint8_t *subtitle_header;
3053 int subtitle_header_size;
3055 #if FF_API_VBV_DELAY
3057 * VBV delay coded in the last frame (in periods of a 27 MHz clock).
3058 * Used for compliant TS muxing.
3059 * - encoding: Set by libavcodec.
3060 * - decoding: unused.
3061 * @deprecated this value is now exported as a part of
3062 * AV_PKT_DATA_CPB_PROPERTIES packet side data
3064 attribute_deprecated
3068 #if FF_API_SIDEDATA_ONLY_PKT
3070 * Encoding only and set by default. Allow encoders to output packets
3071 * that do not contain any encoded data, only side data.
3073 * Some encoders need to output such packets, e.g. to update some stream
3074 * parameters at the end of encoding.
3076 * @deprecated this field disables the default behaviour and
3077 * it is kept only for compatibility.
3079 attribute_deprecated
3080 int side_data_only_packets;
3084 * Audio only. The number of "priming" samples (padding) inserted by the
3085 * encoder at the beginning of the audio. I.e. this number of leading
3086 * decoded samples must be discarded by the caller to get the original audio
3087 * without leading padding.
3089 * - decoding: unused
3090 * - encoding: Set by libavcodec. The timestamps on the output packets are
3091 * adjusted by the encoder so that they always refer to the
3092 * first sample of the data actually contained in the packet,
3093 * including any added padding. E.g. if the timebase is
3094 * 1/samplerate and the timestamp of the first input sample is
3095 * 0, the timestamp of the first output packet will be
3098 int initial_padding;
3101 * - decoding: For codecs that store a framerate value in the compressed
3102 * bitstream, the decoder may export it here. { 0, 1} when
3104 * - encoding: May be used to signal the framerate of CFR content to an
3107 AVRational framerate;
3110 * Nominal unaccelerated pixel format, see AV_PIX_FMT_xxx.
3111 * - encoding: unused.
3112 * - decoding: Set by libavcodec before calling get_format()
3114 enum AVPixelFormat sw_pix_fmt;
3117 * Timebase in which pkt_dts/pts and AVPacket.dts/pts are.
3118 * - encoding unused.
3119 * - decoding set by user.
3121 AVRational pkt_timebase;
3125 * - encoding: unused.
3126 * - decoding: set by libavcodec.
3128 const AVCodecDescriptor *codec_descriptor;
3132 * low resolution decoding, 1-> 1/2 size, 2->1/4 size
3133 * - encoding: unused
3134 * - decoding: Set by user.
3140 * Current statistics for PTS correction.
3141 * - decoding: maintained and used by libavcodec, not intended to be used by user apps
3142 * - encoding: unused
3144 int64_t pts_correction_num_faulty_pts; /// Number of incorrect PTS values so far
3145 int64_t pts_correction_num_faulty_dts; /// Number of incorrect DTS values so far
3146 int64_t pts_correction_last_pts; /// PTS of the last frame
3147 int64_t pts_correction_last_dts; /// DTS of the last frame
3150 * Character encoding of the input subtitles file.
3151 * - decoding: set by user
3152 * - encoding: unused
3157 * Subtitles character encoding mode. Formats or codecs might be adjusting
3158 * this setting (if they are doing the conversion themselves for instance).
3159 * - decoding: set by libavcodec
3160 * - encoding: unused
3162 int sub_charenc_mode;
3163 #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)
3164 #define FF_SUB_CHARENC_MODE_AUTOMATIC 0 ///< libavcodec will select the mode itself
3165 #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
3166 #define FF_SUB_CHARENC_MODE_IGNORE 2 ///< neither convert the subtitles, nor check them for valid UTF-8
3169 * Skip processing alpha if supported by codec.
3170 * Note that if the format uses pre-multiplied alpha (common with VP6,
3171 * and recommended due to better video quality/compression)
3172 * the image will look as if alpha-blended onto a black background.
3173 * However for formats that do not use pre-multiplied alpha
3174 * there might be serious artefacts (though e.g. libswscale currently
3175 * assumes pre-multiplied alpha anyway).
3177 * - decoding: set by user
3178 * - encoding: unused
3183 * Number of samples to skip after a discontinuity
3184 * - decoding: unused
3185 * - encoding: set by libavcodec
3189 #if !FF_API_DEBUG_MV
3191 * debug motion vectors
3192 * - encoding: Set by user.
3193 * - decoding: Set by user.
3196 #define FF_DEBUG_VIS_MV_P_FOR 0x00000001 //visualize forward predicted MVs of P frames
3197 #define FF_DEBUG_VIS_MV_B_FOR 0x00000002 //visualize forward predicted MVs of B frames
3198 #define FF_DEBUG_VIS_MV_B_BACK 0x00000004 //visualize backward predicted MVs of B frames
3202 * custom intra quantization matrix
3203 * - encoding: Set by user, can be NULL.
3204 * - decoding: unused.
3206 uint16_t *chroma_intra_matrix;
3209 * dump format separator.
3210 * can be ", " or "\n " or anything else
3211 * - encoding: Set by user.
3212 * - decoding: Set by user.
3214 uint8_t *dump_separator;
3217 * ',' separated list of allowed decoders.
3218 * If NULL then all are allowed
3219 * - encoding: unused
3220 * - decoding: set by user
3222 char *codec_whitelist;
3225 * Properties of the stream that gets decoded
3226 * - encoding: unused
3227 * - decoding: set by libavcodec
3229 unsigned properties;
3230 #define FF_CODEC_PROPERTY_LOSSLESS 0x00000001
3231 #define FF_CODEC_PROPERTY_CLOSED_CAPTIONS 0x00000002
3234 * Additional data associated with the entire coded stream.
3236 * - decoding: unused
3237 * - encoding: may be set by libavcodec after avcodec_open2().
3239 AVPacketSideData *coded_side_data;
3240 int nb_coded_side_data;
3243 * A reference to the AVHWFramesContext describing the input (for encoding)
3244 * or output (decoding) frames. The reference is set by the caller and
3245 * afterwards owned (and freed) by libavcodec - it should never be read by
3246 * the caller after being set.
3248 * - decoding: This field should be set by the caller from the get_format()
3249 * callback. The previous reference (if any) will always be
3250 * unreffed by libavcodec before the get_format() call.
3252 * If the default get_buffer2() is used with a hwaccel pixel
3253 * format, then this AVHWFramesContext will be used for
3254 * allocating the frame buffers.
3256 * - encoding: For hardware encoders configured to use a hwaccel pixel
3257 * format, this field should be set by the caller to a reference
3258 * to the AVHWFramesContext describing input frames.
3259 * AVHWFramesContext.format must be equal to
3260 * AVCodecContext.pix_fmt.
3262 * This field should be set before avcodec_open2() is called.
3264 AVBufferRef *hw_frames_ctx;
3267 * Control the form of AVSubtitle.rects[N]->ass
3268 * - decoding: set by user
3269 * - encoding: unused
3271 int sub_text_format;
3272 #define FF_SUB_TEXT_FMT_ASS 0
3273 #if FF_API_ASS_TIMING
3274 #define FF_SUB_TEXT_FMT_ASS_WITH_TIMINGS 1
3278 * Audio only. The amount of padding (in samples) appended by the encoder to
3279 * the end of the audio. I.e. this number of decoded samples must be
3280 * discarded by the caller from the end of the stream to get the original
3281 * audio without any trailing padding.
3283 * - decoding: unused
3284 * - encoding: unused
3286 int trailing_padding;
3289 * The number of pixels per image to maximally accept.
3291 * - decoding: set by user
3292 * - encoding: set by user
3297 * A reference to the AVHWDeviceContext describing the device which will
3298 * be used by a hardware encoder/decoder. The reference is set by the
3299 * caller and afterwards owned (and freed) by libavcodec.
3301 * This should be used if either the codec device does not require
3302 * hardware frames or any that are used are to be allocated internally by
3303 * libavcodec. If the user wishes to supply any of the frames used as
3304 * encoder input or decoder output then hw_frames_ctx should be used
3305 * instead. When hw_frames_ctx is set in get_format() for a decoder, this
3306 * field will be ignored while decoding the associated stream segment, but
3307 * may again be used on a following one after another get_format() call.
3309 * For both encoders and decoders this field should be set before
3310 * avcodec_open2() is called and must not be written to thereafter.
3312 * Note that some decoders may require this field to be set initially in
3313 * order to support hw_frames_ctx at all - in that case, all frames
3314 * contexts used must be created on the same device.
3316 AVBufferRef *hw_device_ctx;
3319 * Bit set of AV_HWACCEL_FLAG_* flags, which affect hardware accelerated
3320 * decoding (if active).
3321 * - encoding: unused
3322 * - decoding: Set by user (either before avcodec_open2(), or in the
3323 * AVCodecContext.get_format callback)
3328 * Video decoding only. Certain video codecs support cropping, meaning that
3329 * only a sub-rectangle of the decoded frame is intended for display. This
3330 * option controls how cropping is handled by libavcodec.
3332 * When set to 1 (the default), libavcodec will apply cropping internally.
3333 * I.e. it will modify the output frame width/height fields and offset the
3334 * data pointers (only by as much as possible while preserving alignment, or
3335 * by the full amount if the AV_CODEC_FLAG_UNALIGNED flag is set) so that
3336 * the frames output by the decoder refer only to the cropped area. The
3337 * crop_* fields of the output frames will be zero.
3339 * When set to 0, the width/height fields of the output frames will be set
3340 * to the coded dimensions and the crop_* fields will describe the cropping
3341 * rectangle. Applying the cropping is left to the caller.
3343 * @warning When hardware acceleration with opaque output frames is used,
3344 * libavcodec is unable to apply cropping from the top/left border.
3346 * @note when this option is set to zero, the width/height fields of the
3347 * AVCodecContext and output AVFrames have different meanings. The codec
3348 * context fields store display dimensions (with the coded dimensions in
3349 * coded_width/height), while the frame fields store the coded dimensions
3350 * (with the display dimensions being determined by the crop_* fields).
3355 * Video decoding only. Sets the number of extra hardware frames which
3356 * the decoder will allocate for use by the caller. This must be set
3357 * before avcodec_open2() is called.
3359 * Some hardware decoders require all frames that they will use for
3360 * output to be defined in advance before decoding starts. For such
3361 * decoders, the hardware frame pool must therefore be of a fixed size.
3362 * The extra frames set here are on top of any number that the decoder
3363 * needs internally in order to operate normally (for example, frames
3364 * used as reference pictures).
3366 int extra_hw_frames;
3369 * The percentage of damaged samples to discard a frame.
3371 * - decoding: set by user
3372 * - encoding: unused
3374 int discard_damaged_percentage;
3377 #if FF_API_CODEC_GET_SET
3379 * Accessors for some AVCodecContext fields. These used to be provided for ABI
3380 * compatibility, and do not need to be used anymore.
3382 attribute_deprecated
3383 AVRational av_codec_get_pkt_timebase (const AVCodecContext *avctx);
3384 attribute_deprecated
3385 void av_codec_set_pkt_timebase (AVCodecContext *avctx, AVRational val);
3387 attribute_deprecated
3388 const AVCodecDescriptor *av_codec_get_codec_descriptor(const AVCodecContext *avctx);
3389 attribute_deprecated
3390 void av_codec_set_codec_descriptor(AVCodecContext *avctx, const AVCodecDescriptor *desc);
3392 attribute_deprecated
3393 unsigned av_codec_get_codec_properties(const AVCodecContext *avctx);
3396 attribute_deprecated
3397 int av_codec_get_lowres(const AVCodecContext *avctx);
3398 attribute_deprecated
3399 void av_codec_set_lowres(AVCodecContext *avctx, int val);
3402 attribute_deprecated
3403 int av_codec_get_seek_preroll(const AVCodecContext *avctx);
3404 attribute_deprecated
3405 void av_codec_set_seek_preroll(AVCodecContext *avctx, int val);
3407 attribute_deprecated
3408 uint16_t *av_codec_get_chroma_intra_matrix(const AVCodecContext *avctx);
3409 attribute_deprecated
3410 void av_codec_set_chroma_intra_matrix(AVCodecContext *avctx, uint16_t *val);
3416 typedef struct AVProfile {
3418 const char *name; ///< short name for the profile
3423 * The codec supports this format via the hw_device_ctx interface.
3425 * When selecting this format, AVCodecContext.hw_device_ctx should
3426 * have been set to a device of the specified type before calling
3429 AV_CODEC_HW_CONFIG_METHOD_HW_DEVICE_CTX = 0x01,
3431 * The codec supports this format via the hw_frames_ctx interface.
3433 * When selecting this format for a decoder,
3434 * AVCodecContext.hw_frames_ctx should be set to a suitable frames
3435 * context inside the get_format() callback. The frames context
3436 * must have been created on a device of the specified type.
3438 AV_CODEC_HW_CONFIG_METHOD_HW_FRAMES_CTX = 0x02,
3440 * The codec supports this format by some internal method.
3442 * This format can be selected without any additional configuration -
3443 * no device or frames context is required.
3445 AV_CODEC_HW_CONFIG_METHOD_INTERNAL = 0x04,
3447 * The codec supports this format by some ad-hoc method.
3449 * Additional settings and/or function calls are required. See the
3450 * codec-specific documentation for details. (Methods requiring
3451 * this sort of configuration are deprecated and others should be
3452 * used in preference.)
3454 AV_CODEC_HW_CONFIG_METHOD_AD_HOC = 0x08,
3457 typedef struct AVCodecHWConfig {
3459 * A hardware pixel format which the codec can use.
3461 enum AVPixelFormat pix_fmt;
3463 * Bit set of AV_CODEC_HW_CONFIG_METHOD_* flags, describing the possible
3464 * setup methods which can be used with this configuration.
3468 * The device type associated with the configuration.
3470 * Must be set for AV_CODEC_HW_CONFIG_METHOD_HW_DEVICE_CTX and
3471 * AV_CODEC_HW_CONFIG_METHOD_HW_FRAMES_CTX, otherwise unused.
3473 enum AVHWDeviceType device_type;
3476 typedef struct AVCodecDefault AVCodecDefault;
3483 typedef struct AVCodec {
3485 * Name of the codec implementation.
3486 * The name is globally unique among encoders and among decoders (but an
3487 * encoder and a decoder can share the same name).
3488 * This is the primary way to find a codec from the user perspective.
3492 * Descriptive name for the codec, meant to be more human readable than name.
3493 * You should use the NULL_IF_CONFIG_SMALL() macro to define it.
3495 const char *long_name;
3496 enum AVMediaType type;
3499 * Codec capabilities.
3500 * see AV_CODEC_CAP_*
3503 const AVRational *supported_framerates; ///< array of supported framerates, or NULL if any, array is terminated by {0,0}
3504 const enum AVPixelFormat *pix_fmts; ///< array of supported pixel formats, or NULL if unknown, array is terminated by -1
3505 const int *supported_samplerates; ///< array of supported audio samplerates, or NULL if unknown, array is terminated by 0
3506 const enum AVSampleFormat *sample_fmts; ///< array of supported sample formats, or NULL if unknown, array is terminated by -1
3507 const uint64_t *channel_layouts; ///< array of support channel layouts, or NULL if unknown. array is terminated by 0
3508 uint8_t max_lowres; ///< maximum value for lowres supported by the decoder
3509 const AVClass *priv_class; ///< AVClass for the private context
3510 const AVProfile *profiles; ///< array of recognized profiles, or NULL if unknown, array is terminated by {FF_PROFILE_UNKNOWN}
3513 * Group name of the codec implementation.
3514 * This is a short symbolic name of the wrapper backing this codec. A
3515 * wrapper uses some kind of external implementation for the codec, such
3516 * as an external library, or a codec implementation provided by the OS or
3518 * If this field is NULL, this is a builtin, libavcodec native codec.
3519 * If non-NULL, this will be the suffix in AVCodec.name in most cases
3520 * (usually AVCodec.name will be of the form "<codec_name>_<wrapper_name>").
3522 const char *wrapper_name;
3524 /*****************************************************************
3525 * No fields below this line are part of the public API. They
3526 * may not be used outside of libavcodec and can be changed and
3528 * New public fields should be added right above.
3529 *****************************************************************
3532 struct AVCodec *next;
3534 * @name Frame-level threading support functions
3538 * If defined, called on thread contexts when they are created.
3539 * If the codec allocates writable tables in init(), re-allocate them here.
3540 * priv_data will be set to a copy of the original.
3542 int (*init_thread_copy)(AVCodecContext *);
3544 * Copy necessary context variables from a previous thread context to the current one.
3545 * If not defined, the next thread will start automatically; otherwise, the codec
3546 * must call ff_thread_finish_setup().
3548 * dst and src will (rarely) point to the same context, in which case memcpy should be skipped.
3550 int (*update_thread_context)(AVCodecContext *dst, const AVCodecContext *src);
3554 * Private codec-specific defaults.
3556 const AVCodecDefault *defaults;
3559 * Initialize codec static data, called from avcodec_register().
3561 * This is not intended for time consuming operations as it is
3562 * run for every codec regardless of that codec being used.
3564 void (*init_static_data)(struct AVCodec *codec);
3566 int (*init)(AVCodecContext *);
3567 int (*encode_sub)(AVCodecContext *, uint8_t *buf, int buf_size,
3568 const struct AVSubtitle *sub);
3570 * Encode data to an AVPacket.
3572 * @param avctx codec context
3573 * @param avpkt output AVPacket (may contain a user-provided buffer)
3574 * @param[in] frame AVFrame containing the raw data to be encoded
3575 * @param[out] got_packet_ptr encoder sets to 0 or 1 to indicate that a
3576 * non-empty packet was returned in avpkt.
3577 * @return 0 on success, negative error code on failure
3579 int (*encode2)(AVCodecContext *avctx, AVPacket *avpkt, const AVFrame *frame,
3580 int *got_packet_ptr);
3581 int (*decode)(AVCodecContext *, void *outdata, int *outdata_size, AVPacket *avpkt);
3582 int (*close)(AVCodecContext *);
3584 * Encode API with decoupled packet/frame dataflow. The API is the
3585 * same as the avcodec_ prefixed APIs (avcodec_send_frame() etc.), except
3587 * - never called if the codec is closed or the wrong type,
3588 * - if AV_CODEC_CAP_DELAY is not set, drain frames are never sent,
3589 * - only one drain frame is ever passed down,
3591 int (*send_frame)(AVCodecContext *avctx, const AVFrame *frame);
3592 int (*receive_packet)(AVCodecContext *avctx, AVPacket *avpkt);
3595 * Decode API with decoupled packet/frame dataflow. This function is called
3596 * to get one output frame. It should call ff_decode_get_packet() to obtain
3599 int (*receive_frame)(AVCodecContext *avctx, AVFrame *frame);
3602 * Will be called when seeking
3604 void (*flush)(AVCodecContext *);
3606 * Internal codec capabilities.
3607 * See FF_CODEC_CAP_* in internal.h
3612 * Decoding only, a comma-separated list of bitstream filters to apply to
3613 * packets before decoding.
3618 * Array of pointers to hardware configurations supported by the codec,
3619 * or NULL if no hardware supported. The array is terminated by a NULL
3622 * The user can only access this field via avcodec_get_hw_config().
3624 const struct AVCodecHWConfigInternal **hw_configs;
3627 #if FF_API_CODEC_GET_SET
3628 attribute_deprecated
3629 int av_codec_get_max_lowres(const AVCodec *codec);
3632 struct MpegEncContext;
3635 * Retrieve supported hardware configurations for a codec.
3637 * Values of index from zero to some maximum return the indexed configuration
3638 * descriptor; all other values return NULL. If the codec does not support
3639 * any hardware configurations then it will always return NULL.
3641 const AVCodecHWConfig *avcodec_get_hw_config(const AVCodec *codec, int index);
3644 * @defgroup lavc_hwaccel AVHWAccel
3646 * @note Nothing in this structure should be accessed by the user. At some
3647 * point in future it will not be externally visible at all.
3651 typedef struct AVHWAccel {
3653 * Name of the hardware accelerated codec.
3654 * The name is globally unique among encoders and among decoders (but an
3655 * encoder and a decoder can share the same name).
3660 * Type of codec implemented by the hardware accelerator.
3662 * See AVMEDIA_TYPE_xxx
3664 enum AVMediaType type;
3667 * Codec implemented by the hardware accelerator.
3669 * See AV_CODEC_ID_xxx
3674 * Supported pixel format.
3676 * Only hardware accelerated formats are supported here.
3678 enum AVPixelFormat pix_fmt;
3681 * Hardware accelerated codec capabilities.
3682 * see AV_HWACCEL_CODEC_CAP_*
3686 /*****************************************************************
3687 * No fields below this line are part of the public API. They
3688 * may not be used outside of libavcodec and can be changed and
3690 * New public fields should be added right above.
3691 *****************************************************************
3695 * Allocate a custom buffer
3697 int (*alloc_frame)(AVCodecContext *avctx, AVFrame *frame);
3700 * Called at the beginning of each frame or field picture.
3702 * Meaningful frame information (codec specific) is guaranteed to
3703 * be parsed at this point. This function is mandatory.
3705 * Note that buf can be NULL along with buf_size set to 0.
3706 * Otherwise, this means the whole frame is available at this point.
3708 * @param avctx the codec context
3709 * @param buf the frame data buffer base
3710 * @param buf_size the size of the frame in bytes
3711 * @return zero if successful, a negative value otherwise
3713 int (*start_frame)(AVCodecContext *avctx, const uint8_t *buf, uint32_t buf_size);
3716 * Callback for parameter data (SPS/PPS/VPS etc).
3718 * Useful for hardware decoders which keep persistent state about the
3719 * video parameters, and need to receive any changes to update that state.
3721 * @param avctx the codec context
3722 * @param type the nal unit type
3723 * @param buf the nal unit data buffer
3724 * @param buf_size the size of the nal unit in bytes
3725 * @return zero if successful, a negative value otherwise
3727 int (*decode_params)(AVCodecContext *avctx, int type, const uint8_t *buf, uint32_t buf_size);
3730 * Callback for each slice.
3732 * Meaningful slice information (codec specific) is guaranteed to
3733 * be parsed at this point. This function is mandatory.
3734 * The only exception is XvMC, that works on MB level.
3736 * @param avctx the codec context
3737 * @param buf the slice data buffer base
3738 * @param buf_size the size of the slice in bytes
3739 * @return zero if successful, a negative value otherwise
3741 int (*decode_slice)(AVCodecContext *avctx, const uint8_t *buf, uint32_t buf_size);
3744 * Called at the end of each frame or field picture.
3746 * The whole picture is parsed at this point and can now be sent
3747 * to the hardware accelerator. This function is mandatory.
3749 * @param avctx the codec context
3750 * @return zero if successful, a negative value otherwise
3752 int (*end_frame)(AVCodecContext *avctx);
3755 * Size of per-frame hardware accelerator private data.
3757 * Private data is allocated with av_mallocz() before
3758 * AVCodecContext.get_buffer() and deallocated after
3759 * AVCodecContext.release_buffer().
3761 int frame_priv_data_size;
3764 * Called for every Macroblock in a slice.
3766 * XvMC uses it to replace the ff_mpv_reconstruct_mb().
3767 * Instead of decoding to raw picture, MB parameters are
3768 * stored in an array provided by the video driver.
3770 * @param s the mpeg context
3772 void (*decode_mb)(struct MpegEncContext *s);
3775 * Initialize the hwaccel private data.
3777 * This will be called from ff_get_format(), after hwaccel and
3778 * hwaccel_context are set and the hwaccel private data in AVCodecInternal
3781 int (*init)(AVCodecContext *avctx);
3784 * Uninitialize the hwaccel private data.
3786 * This will be called from get_format() or avcodec_close(), after hwaccel
3787 * and hwaccel_context are already uninitialized.
3789 int (*uninit)(AVCodecContext *avctx);
3792 * Size of the private data to allocate in
3793 * AVCodecInternal.hwaccel_priv_data.
3798 * Internal hwaccel capabilities.
3803 * Fill the given hw_frames context with current codec parameters. Called
3804 * from get_format. Refer to avcodec_get_hw_frames_parameters() for
3807 * This CAN be called before AVHWAccel.init is called, and you must assume
3808 * that avctx->hwaccel_priv_data is invalid.
3810 int (*frame_params)(AVCodecContext *avctx, AVBufferRef *hw_frames_ctx);
3814 * HWAccel is experimental and is thus avoided in favor of non experimental
3817 #define AV_HWACCEL_CODEC_CAP_EXPERIMENTAL 0x0200
3820 * Hardware acceleration should be used for decoding even if the codec level
3821 * used is unknown or higher than the maximum supported level reported by the
3824 * It's generally a good idea to pass this flag unless you have a specific
3825 * reason not to, as hardware tends to under-report supported levels.
3827 #define AV_HWACCEL_FLAG_IGNORE_LEVEL (1 << 0)
3830 * Hardware acceleration can output YUV pixel formats with a different chroma
3831 * sampling than 4:2:0 and/or other than 8 bits per component.
3833 #define AV_HWACCEL_FLAG_ALLOW_HIGH_DEPTH (1 << 1)
3836 * Hardware acceleration should still be attempted for decoding when the
3837 * codec profile does not match the reported capabilities of the hardware.
3839 * For example, this can be used to try to decode baseline profile H.264
3840 * streams in hardware - it will often succeed, because many streams marked
3841 * as baseline profile actually conform to constrained baseline profile.
3843 * @warning If the stream is actually not supported then the behaviour is
3844 * undefined, and may include returning entirely incorrect output
3845 * while indicating success.
3847 #define AV_HWACCEL_FLAG_ALLOW_PROFILE_MISMATCH (1 << 2)
3853 #if FF_API_AVPICTURE
3855 * @defgroup lavc_picture AVPicture
3857 * Functions for working with AVPicture
3862 * Picture data structure.
3864 * Up to four components can be stored into it, the last component is
3866 * @deprecated use AVFrame or imgutils functions instead
3868 typedef struct AVPicture {
3869 attribute_deprecated
3870 uint8_t *data[AV_NUM_DATA_POINTERS]; ///< pointers to the image data planes
3871 attribute_deprecated
3872 int linesize[AV_NUM_DATA_POINTERS]; ///< number of bytes per line
3880 enum AVSubtitleType {
3883 SUBTITLE_BITMAP, ///< A bitmap, pict will be set
3886 * Plain text, the text field must be set by the decoder and is
3887 * authoritative. ass and pict fields may contain approximations.
3892 * Formatted text, the ass field must be set by the decoder and is
3893 * authoritative. pict and text fields may contain approximations.
3898 #define AV_SUBTITLE_FLAG_FORCED 0x00000001
3900 typedef struct AVSubtitleRect {
3901 int x; ///< top left corner of pict, undefined when pict is not set
3902 int y; ///< top left corner of pict, undefined when pict is not set
3903 int w; ///< width of pict, undefined when pict is not set
3904 int h; ///< height of pict, undefined when pict is not set
3905 int nb_colors; ///< number of colors in pict, undefined when pict is not set
3907 #if FF_API_AVPICTURE
3909 * @deprecated unused
3911 attribute_deprecated
3915 * data+linesize for the bitmap of this subtitle.
3916 * Can be set for text/ass as well once they are rendered.
3921 enum AVSubtitleType type;
3923 char *text; ///< 0 terminated plain UTF-8 text
3926 * 0 terminated ASS/SSA compatible event line.
3927 * The presentation of this is unaffected by the other values in this
3935 typedef struct AVSubtitle {
3936 uint16_t format; /* 0 = graphics */
3937 uint32_t start_display_time; /* relative to packet pts, in ms */
3938 uint32_t end_display_time; /* relative to packet pts, in ms */
3940 AVSubtitleRect **rects;
3941 int64_t pts; ///< Same as packet pts, in AV_TIME_BASE
3945 * This struct describes the properties of an encoded stream.
3947 * sizeof(AVCodecParameters) is not a part of the public ABI, this struct must
3948 * be allocated with avcodec_parameters_alloc() and freed with
3949 * avcodec_parameters_free().
3951 typedef struct AVCodecParameters {
3953 * General type of the encoded data.
3955 enum AVMediaType codec_type;
3957 * Specific type of the encoded data (the codec used).
3959 enum AVCodecID codec_id;
3961 * Additional information about the codec (corresponds to the AVI FOURCC).
3966 * Extra binary data needed for initializing the decoder, codec-dependent.
3968 * Must be allocated with av_malloc() and will be freed by
3969 * avcodec_parameters_free(). The allocated size of extradata must be at
3970 * least extradata_size + AV_INPUT_BUFFER_PADDING_SIZE, with the padding
3975 * Size of the extradata content in bytes.
3980 * - video: the pixel format, the value corresponds to enum AVPixelFormat.
3981 * - audio: the sample format, the value corresponds to enum AVSampleFormat.
3986 * The average bitrate of the encoded data (in bits per second).
3991 * The number of bits per sample in the codedwords.
3993 * This is basically the bitrate per sample. It is mandatory for a bunch of
3994 * formats to actually decode them. It's the number of bits for one sample in
3995 * the actual coded bitstream.
3997 * This could be for example 4 for ADPCM
3998 * For PCM formats this matches bits_per_raw_sample
4001 int bits_per_coded_sample;
4004 * This is the number of valid bits in each output sample. If the
4005 * sample format has more bits, the least significant bits are additional
4006 * padding bits, which are always 0. Use right shifts to reduce the sample
4007 * to its actual size. For example, audio formats with 24 bit samples will
4008 * have bits_per_raw_sample set to 24, and format set to AV_SAMPLE_FMT_S32.
4009 * To get the original sample use "(int32_t)sample >> 8"."
4011 * For ADPCM this might be 12 or 16 or similar
4014 int bits_per_raw_sample;
4017 * Codec-specific bitstream restrictions that the stream conforms to.
4023 * Video only. The dimensions of the video frame in pixels.
4029 * Video only. The aspect ratio (width / height) which a single pixel
4030 * should have when displayed.
4032 * When the aspect ratio is unknown / undefined, the numerator should be
4033 * set to 0 (the denominator may have any value).
4035 AVRational sample_aspect_ratio;
4038 * Video only. The order of the fields in interlaced video.
4040 enum AVFieldOrder field_order;
4043 * Video only. Additional colorspace characteristics.
4045 enum AVColorRange color_range;
4046 enum AVColorPrimaries color_primaries;
4047 enum AVColorTransferCharacteristic color_trc;
4048 enum AVColorSpace color_space;
4049 enum AVChromaLocation chroma_location;
4052 * Video only. Number of delayed frames.
4057 * Audio only. The channel layout bitmask. May be 0 if the channel layout is
4058 * unknown or unspecified, otherwise the number of bits set must be equal to
4059 * the channels field.
4061 uint64_t channel_layout;
4063 * Audio only. The number of audio channels.
4067 * Audio only. The number of audio samples per second.
4071 * Audio only. The number of bytes per coded audio frame, required by some
4074 * Corresponds to nBlockAlign in WAVEFORMATEX.
4078 * Audio only. Audio frame size, if known. Required by some formats to be static.
4083 * Audio only. The amount of padding (in samples) inserted by the encoder at
4084 * the beginning of the audio. I.e. this number of leading decoded samples
4085 * must be discarded by the caller to get the original audio without leading
4088 int initial_padding;
4090 * Audio only. The amount of padding (in samples) appended by the encoder to
4091 * the end of the audio. I.e. this number of decoded samples must be
4092 * discarded by the caller from the end of the stream to get the original
4093 * audio without any trailing padding.
4095 int trailing_padding;
4097 * Audio only. Number of samples to skip after a discontinuity.
4100 } AVCodecParameters;
4103 * Iterate over all registered codecs.
4105 * @param opaque a pointer where libavcodec will store the iteration state. Must
4106 * point to NULL to start the iteration.
4108 * @return the next registered codec or NULL when the iteration is
4111 const AVCodec *av_codec_iterate(void **opaque);
4115 * If c is NULL, returns the first registered codec,
4116 * if c is non-NULL, returns the next registered codec after c,
4117 * or NULL if c is the last one.
4119 attribute_deprecated
4120 AVCodec *av_codec_next(const AVCodec *c);
4124 * Return the LIBAVCODEC_VERSION_INT constant.
4126 unsigned avcodec_version(void);
4129 * Return the libavcodec build-time configuration.
4131 const char *avcodec_configuration(void);
4134 * Return the libavcodec license.
4136 const char *avcodec_license(void);
4140 * Register the codec codec and initialize libavcodec.
4142 * @warning either this function or avcodec_register_all() must be called
4143 * before any other libavcodec functions.
4145 * @see avcodec_register_all()
4147 attribute_deprecated
4148 void avcodec_register(AVCodec *codec);
4151 * Register all the codecs, parsers and bitstream filters which were enabled at
4152 * configuration time. If you do not call this function you can select exactly
4153 * which formats you want to support, by using the individual registration
4156 * @see avcodec_register
4157 * @see av_register_codec_parser
4158 * @see av_register_bitstream_filter
4160 attribute_deprecated
4161 void avcodec_register_all(void);
4165 * Allocate an AVCodecContext and set its fields to default values. The
4166 * resulting struct should be freed with avcodec_free_context().
4168 * @param codec if non-NULL, allocate private data and initialize defaults
4169 * for the given codec. It is illegal to then call avcodec_open2()
4170 * with a different codec.
4171 * If NULL, then the codec-specific defaults won't be initialized,
4172 * which may result in suboptimal default settings (this is
4173 * important mainly for encoders, e.g. libx264).
4175 * @return An AVCodecContext filled with default values or NULL on failure.
4177 AVCodecContext *avcodec_alloc_context3(const AVCodec *codec);
4180 * Free the codec context and everything associated with it and write NULL to
4181 * the provided pointer.
4183 void avcodec_free_context(AVCodecContext **avctx);
4185 #if FF_API_GET_CONTEXT_DEFAULTS
4187 * @deprecated This function should not be used, as closing and opening a codec
4188 * context multiple time is not supported. A new codec context should be
4189 * allocated for each new use.
4191 int avcodec_get_context_defaults3(AVCodecContext *s, const AVCodec *codec);
4195 * Get the AVClass for AVCodecContext. It can be used in combination with
4196 * AV_OPT_SEARCH_FAKE_OBJ for examining options.
4198 * @see av_opt_find().
4200 const AVClass *avcodec_get_class(void);
4202 #if FF_API_COPY_CONTEXT
4204 * Get the AVClass for AVFrame. It can be used in combination with
4205 * AV_OPT_SEARCH_FAKE_OBJ for examining options.
4207 * @see av_opt_find().
4209 const AVClass *avcodec_get_frame_class(void);
4212 * Get the AVClass for AVSubtitleRect. It can be used in combination with
4213 * AV_OPT_SEARCH_FAKE_OBJ for examining options.
4215 * @see av_opt_find().
4217 const AVClass *avcodec_get_subtitle_rect_class(void);
4220 * Copy the settings of the source AVCodecContext into the destination
4221 * AVCodecContext. The resulting destination codec context will be
4222 * unopened, i.e. you are required to call avcodec_open2() before you
4223 * can use this AVCodecContext to decode/encode video/audio data.
4225 * @param dest target codec context, should be initialized with
4226 * avcodec_alloc_context3(NULL), but otherwise uninitialized
4227 * @param src source codec context
4228 * @return AVERROR() on error (e.g. memory allocation error), 0 on success
4230 * @deprecated The semantics of this function are ill-defined and it should not
4231 * be used. If you need to transfer the stream parameters from one codec context
4232 * to another, use an intermediate AVCodecParameters instance and the
4233 * avcodec_parameters_from_context() / avcodec_parameters_to_context()
4236 attribute_deprecated
4237 int avcodec_copy_context(AVCodecContext *dest, const AVCodecContext *src);
4241 * Allocate a new AVCodecParameters and set its fields to default values
4242 * (unknown/invalid/0). The returned struct must be freed with
4243 * avcodec_parameters_free().
4245 AVCodecParameters *avcodec_parameters_alloc(void);
4248 * Free an AVCodecParameters instance and everything associated with it and
4249 * write NULL to the supplied pointer.
4251 void avcodec_parameters_free(AVCodecParameters **par);
4254 * Copy the contents of src to dst. Any allocated fields in dst are freed and
4255 * replaced with newly allocated duplicates of the corresponding fields in src.
4257 * @return >= 0 on success, a negative AVERROR code on failure.
4259 int avcodec_parameters_copy(AVCodecParameters *dst, const AVCodecParameters *src);
4262 * Fill the parameters struct based on the values from the supplied codec
4263 * context. Any allocated fields in par are freed and replaced with duplicates
4264 * of the corresponding fields in codec.
4266 * @return >= 0 on success, a negative AVERROR code on failure
4268 int avcodec_parameters_from_context(AVCodecParameters *par,
4269 const AVCodecContext *codec);
4272 * Fill the codec context based on the values from the supplied codec
4273 * parameters. Any allocated fields in codec that have a corresponding field in
4274 * par are freed and replaced with duplicates of the corresponding field in par.
4275 * Fields in codec that do not have a counterpart in par are not touched.
4277 * @return >= 0 on success, a negative AVERROR code on failure.
4279 int avcodec_parameters_to_context(AVCodecContext *codec,
4280 const AVCodecParameters *par);
4283 * Initialize the AVCodecContext to use the given AVCodec. Prior to using this
4284 * function the context has to be allocated with avcodec_alloc_context3().
4286 * The functions avcodec_find_decoder_by_name(), avcodec_find_encoder_by_name(),
4287 * avcodec_find_decoder() and avcodec_find_encoder() provide an easy way for
4288 * retrieving a codec.
4290 * @warning This function is not thread safe!
4292 * @note Always call this function before using decoding routines (such as
4293 * @ref avcodec_receive_frame()).
4296 * avcodec_register_all();
4297 * av_dict_set(&opts, "b", "2.5M", 0);
4298 * codec = avcodec_find_decoder(AV_CODEC_ID_H264);
4302 * context = avcodec_alloc_context3(codec);
4304 * if (avcodec_open2(context, codec, opts) < 0)
4308 * @param avctx The context to initialize.
4309 * @param codec The codec to open this context for. If a non-NULL codec has been
4310 * previously passed to avcodec_alloc_context3() or
4311 * for this context, then this parameter MUST be either NULL or
4312 * equal to the previously passed codec.
4313 * @param options A dictionary filled with AVCodecContext and codec-private options.
4314 * On return this object will be filled with options that were not found.
4316 * @return zero on success, a negative value on error
4317 * @see avcodec_alloc_context3(), avcodec_find_decoder(), avcodec_find_encoder(),
4318 * av_dict_set(), av_opt_find().
4320 int avcodec_open2(AVCodecContext *avctx, const AVCodec *codec, AVDictionary **options);
4323 * Close a given AVCodecContext and free all the data associated with it
4324 * (but not the AVCodecContext itself).
4326 * Calling this function on an AVCodecContext that hasn't been opened will free
4327 * the codec-specific data allocated in avcodec_alloc_context3() with a non-NULL
4328 * codec. Subsequent calls will do nothing.
4330 * @note Do not use this function. Use avcodec_free_context() to destroy a
4331 * codec context (either open or closed). Opening and closing a codec context
4332 * multiple times is not supported anymore -- use multiple codec contexts
4335 int avcodec_close(AVCodecContext *avctx);
4338 * Free all allocated data in the given subtitle struct.
4340 * @param sub AVSubtitle to free.
4342 void avsubtitle_free(AVSubtitle *sub);
4349 * @addtogroup lavc_packet
4354 * Allocate an AVPacket and set its fields to default values. The resulting
4355 * struct must be freed using av_packet_free().
4357 * @return An AVPacket filled with default values or NULL on failure.
4359 * @note this only allocates the AVPacket itself, not the data buffers. Those
4360 * must be allocated through other means such as av_new_packet.
4362 * @see av_new_packet
4364 AVPacket *av_packet_alloc(void);
4367 * Create a new packet that references the same data as src.
4369 * This is a shortcut for av_packet_alloc()+av_packet_ref().
4371 * @return newly created AVPacket on success, NULL on error.
4373 * @see av_packet_alloc
4374 * @see av_packet_ref
4376 AVPacket *av_packet_clone(const AVPacket *src);
4379 * Free the packet, if the packet is reference counted, it will be
4380 * unreferenced first.
4382 * @param pkt packet to be freed. The pointer will be set to NULL.
4383 * @note passing NULL is a no-op.
4385 void av_packet_free(AVPacket **pkt);
4388 * Initialize optional fields of a packet with default values.
4390 * Note, this does not touch the data and size members, which have to be
4391 * initialized separately.
4395 void av_init_packet(AVPacket *pkt);
4398 * Allocate the payload of a packet and initialize its fields with
4402 * @param size wanted payload size
4403 * @return 0 if OK, AVERROR_xxx otherwise
4405 int av_new_packet(AVPacket *pkt, int size);
4408 * Reduce packet size, correctly zeroing padding
4411 * @param size new size
4413 void av_shrink_packet(AVPacket *pkt, int size);
4416 * Increase packet size, correctly zeroing padding
4419 * @param grow_by number of bytes by which to increase the size of the packet
4421 int av_grow_packet(AVPacket *pkt, int grow_by);
4424 * Initialize a reference-counted packet from av_malloc()ed data.
4426 * @param pkt packet to be initialized. This function will set the data, size,
4427 * and buf fields, all others are left untouched.
4428 * @param data Data allocated by av_malloc() to be used as packet data. If this
4429 * function returns successfully, the data is owned by the underlying AVBuffer.
4430 * The caller may not access the data through other means.
4431 * @param size size of data in bytes, without the padding. I.e. the full buffer
4432 * size is assumed to be size + AV_INPUT_BUFFER_PADDING_SIZE.
4434 * @return 0 on success, a negative AVERROR on error
4436 int av_packet_from_data(AVPacket *pkt, uint8_t *data, int size);
4438 #if FF_API_AVPACKET_OLD_API
4440 * @warning This is a hack - the packet memory allocation stuff is broken. The
4441 * packet is allocated if it was not really allocated.
4443 * @deprecated Use av_packet_ref or av_packet_make_refcounted
4445 attribute_deprecated
4446 int av_dup_packet(AVPacket *pkt);
4448 * Copy packet, including contents
4450 * @return 0 on success, negative AVERROR on fail
4452 * @deprecated Use av_packet_ref
4454 attribute_deprecated
4455 int av_copy_packet(AVPacket *dst, const AVPacket *src);
4458 * Copy packet side data
4460 * @return 0 on success, negative AVERROR on fail
4462 * @deprecated Use av_packet_copy_props
4464 attribute_deprecated
4465 int av_copy_packet_side_data(AVPacket *dst, const AVPacket *src);
4470 * @deprecated Use av_packet_unref
4472 * @param pkt packet to free
4474 attribute_deprecated
4475 void av_free_packet(AVPacket *pkt);
4478 * Allocate new information of a packet.
4481 * @param type side information type
4482 * @param size side information size
4483 * @return pointer to fresh allocated data or NULL otherwise
4485 uint8_t* av_packet_new_side_data(AVPacket *pkt, enum AVPacketSideDataType type,
4489 * Wrap an existing array as a packet side data.
4492 * @param type side information type
4493 * @param data the side data array. It must be allocated with the av_malloc()
4494 * family of functions. The ownership of the data is transferred to
4496 * @param size side information size
4497 * @return a non-negative number on success, a negative AVERROR code on
4498 * failure. On failure, the packet is unchanged and the data remains
4499 * owned by the caller.
4501 int av_packet_add_side_data(AVPacket *pkt, enum AVPacketSideDataType type,
4502 uint8_t *data, size_t size);
4505 * Shrink the already allocated side data buffer
4508 * @param type side information type
4509 * @param size new side information size
4510 * @return 0 on success, < 0 on failure
4512 int av_packet_shrink_side_data(AVPacket *pkt, enum AVPacketSideDataType type,
4516 * Get side information from packet.
4519 * @param type desired side information type
4520 * @param size pointer for side information size to store (optional)
4521 * @return pointer to data if present or NULL otherwise
4523 uint8_t* av_packet_get_side_data(const AVPacket *pkt, enum AVPacketSideDataType type,
4526 #if FF_API_MERGE_SD_API
4527 attribute_deprecated
4528 int av_packet_merge_side_data(AVPacket *pkt);
4530 attribute_deprecated
4531 int av_packet_split_side_data(AVPacket *pkt);
4534 const char *av_packet_side_data_name(enum AVPacketSideDataType type);
4537 * Pack a dictionary for use in side_data.
4539 * @param dict The dictionary to pack.
4540 * @param size pointer to store the size of the returned data
4541 * @return pointer to data if successful, NULL otherwise
4543 uint8_t *av_packet_pack_dictionary(AVDictionary *dict, int *size);
4545 * Unpack a dictionary from side_data.
4547 * @param data data from side_data
4548 * @param size size of the data
4549 * @param dict the metadata storage dictionary
4550 * @return 0 on success, < 0 on failure
4552 int av_packet_unpack_dictionary(const uint8_t *data, int size, AVDictionary **dict);
4556 * Convenience function to free all the side data stored.
4557 * All the other fields stay untouched.
4561 void av_packet_free_side_data(AVPacket *pkt);
4564 * Setup a new reference to the data described by a given packet
4566 * If src is reference-counted, setup dst as a new reference to the
4567 * buffer in src. Otherwise allocate a new buffer in dst and copy the
4568 * data from src into it.
4570 * All the other fields are copied from src.
4572 * @see av_packet_unref
4574 * @param dst Destination packet
4575 * @param src Source packet
4577 * @return 0 on success, a negative AVERROR on error.
4579 int av_packet_ref(AVPacket *dst, const AVPacket *src);
4584 * Unreference the buffer referenced by the packet and reset the
4585 * remaining packet fields to their default values.
4587 * @param pkt The packet to be unreferenced.
4589 void av_packet_unref(AVPacket *pkt);
4592 * Move every field in src to dst and reset src.
4594 * @see av_packet_unref
4596 * @param src Source packet, will be reset
4597 * @param dst Destination packet
4599 void av_packet_move_ref(AVPacket *dst, AVPacket *src);
4602 * Copy only "properties" fields from src to dst.
4604 * Properties for the purpose of this function are all the fields
4605 * beside those related to the packet data (buf, data, size)
4607 * @param dst Destination packet
4608 * @param src Source packet
4610 * @return 0 on success AVERROR on failure.
4612 int av_packet_copy_props(AVPacket *dst, const AVPacket *src);
4615 * Ensure the data described by a given packet is reference counted.
4617 * @note This function does not ensure that the reference will be writable.
4618 * Use av_packet_make_writable instead for that purpose.
4620 * @see av_packet_ref
4621 * @see av_packet_make_writable
4623 * @param pkt packet whose data should be made reference counted.
4625 * @return 0 on success, a negative AVERROR on error. On failure, the
4626 * packet is unchanged.
4628 int av_packet_make_refcounted(AVPacket *pkt);
4631 * Create a writable reference for the data described by a given packet,
4632 * avoiding data copy if possible.
4634 * @param pkt Packet whose data should be made writable.
4636 * @return 0 on success, a negative AVERROR on failure. On failure, the
4637 * packet is unchanged.
4639 int av_packet_make_writable(AVPacket *pkt);
4642 * Convert valid timing fields (timestamps / durations) in a packet from one
4643 * timebase to another. Timestamps with unknown values (AV_NOPTS_VALUE) will be
4646 * @param pkt packet on which the conversion will be performed
4647 * @param tb_src source timebase, in which the timing fields in pkt are
4649 * @param tb_dst destination timebase, to which the timing fields will be
4652 void av_packet_rescale_ts(AVPacket *pkt, AVRational tb_src, AVRational tb_dst);
4659 * @addtogroup lavc_decoding
4664 * Find a registered decoder with a matching codec ID.
4666 * @param id AVCodecID of the requested decoder
4667 * @return A decoder if one was found, NULL otherwise.
4669 AVCodec *avcodec_find_decoder(enum AVCodecID id);
4672 * Find a registered decoder with the specified name.
4674 * @param name name of the requested decoder
4675 * @return A decoder if one was found, NULL otherwise.
4677 AVCodec *avcodec_find_decoder_by_name(const char *name);
4680 * The default callback for AVCodecContext.get_buffer2(). It is made public so
4681 * it can be called by custom get_buffer2() implementations for decoders without
4682 * AV_CODEC_CAP_DR1 set.
4684 int avcodec_default_get_buffer2(AVCodecContext *s, AVFrame *frame, int flags);
4687 * Modify width and height values so that they will result in a memory
4688 * buffer that is acceptable for the codec if you do not use any horizontal
4691 * May only be used if a codec with AV_CODEC_CAP_DR1 has been opened.
4693 void avcodec_align_dimensions(AVCodecContext *s, int *width, int *height);
4696 * Modify width and height values so that they will result in a memory
4697 * buffer that is acceptable for the codec if you also ensure that all
4698 * line sizes are a multiple of the respective linesize_align[i].
4700 * May only be used if a codec with AV_CODEC_CAP_DR1 has been opened.
4702 void avcodec_align_dimensions2(AVCodecContext *s, int *width, int *height,
4703 int linesize_align[AV_NUM_DATA_POINTERS]);
4706 * Converts AVChromaLocation to swscale x/y chroma position.
4708 * The positions represent the chroma (0,0) position in a coordinates system
4709 * with luma (0,0) representing the origin and luma(1,1) representing 256,256
4711 * @param xpos horizontal chroma sample position
4712 * @param ypos vertical chroma sample position
4714 int avcodec_enum_to_chroma_pos(int *xpos, int *ypos, enum AVChromaLocation pos);
4717 * Converts swscale x/y chroma position to AVChromaLocation.
4719 * The positions represent the chroma (0,0) position in a coordinates system
4720 * with luma (0,0) representing the origin and luma(1,1) representing 256,256
4722 * @param xpos horizontal chroma sample position
4723 * @param ypos vertical chroma sample position
4725 enum AVChromaLocation avcodec_chroma_pos_to_enum(int xpos, int ypos);
4728 * Decode the audio frame of size avpkt->size from avpkt->data into frame.
4730 * Some decoders may support multiple frames in a single AVPacket. Such
4731 * decoders would then just decode the first frame and the return value would be
4732 * less than the packet size. In this case, avcodec_decode_audio4 has to be
4733 * called again with an AVPacket containing the remaining data in order to
4734 * decode the second frame, etc... Even if no frames are returned, the packet
4735 * needs to be fed to the decoder with remaining data until it is completely
4736 * consumed or an error occurs.
4738 * Some decoders (those marked with AV_CODEC_CAP_DELAY) have a delay between input
4739 * and output. This means that for some packets they will not immediately
4740 * produce decoded output and need to be flushed at the end of decoding to get
4741 * all the decoded data. Flushing is done by calling this function with packets
4742 * with avpkt->data set to NULL and avpkt->size set to 0 until it stops
4743 * returning samples. It is safe to flush even those decoders that are not
4744 * marked with AV_CODEC_CAP_DELAY, then no samples will be returned.
4746 * @warning The input buffer, avpkt->data must be AV_INPUT_BUFFER_PADDING_SIZE
4747 * larger than the actual read bytes because some optimized bitstream
4748 * readers read 32 or 64 bits at once and could read over the end.
4750 * @note The AVCodecContext MUST have been opened with @ref avcodec_open2()
4751 * before packets may be fed to the decoder.
4753 * @param avctx the codec context
4754 * @param[out] frame The AVFrame in which to store decoded audio samples.
4755 * The decoder will allocate a buffer for the decoded frame by
4756 * calling the AVCodecContext.get_buffer2() callback.
4757 * When AVCodecContext.refcounted_frames is set to 1, the frame is
4758 * reference counted and the returned reference belongs to the
4759 * caller. The caller must release the frame using av_frame_unref()
4760 * when the frame is no longer needed. The caller may safely write
4761 * to the frame if av_frame_is_writable() returns 1.
4762 * When AVCodecContext.refcounted_frames is set to 0, the returned
4763 * reference belongs to the decoder and is valid only until the
4764 * next call to this function or until closing or flushing the
4765 * decoder. The caller may not write to it.
4766 * @param[out] got_frame_ptr Zero if no frame could be decoded, otherwise it is
4767 * non-zero. Note that this field being set to zero
4768 * does not mean that an error has occurred. For
4769 * decoders with AV_CODEC_CAP_DELAY set, no given decode
4770 * call is guaranteed to produce a frame.
4771 * @param[in] avpkt The input AVPacket containing the input buffer.
4772 * At least avpkt->data and avpkt->size should be set. Some
4773 * decoders might also require additional fields to be set.
4774 * @return A negative error code is returned if an error occurred during
4775 * decoding, otherwise the number of bytes consumed from the input
4776 * AVPacket is returned.
4778 * @deprecated Use avcodec_send_packet() and avcodec_receive_frame().
4780 attribute_deprecated
4781 int avcodec_decode_audio4(AVCodecContext *avctx, AVFrame *frame,
4782 int *got_frame_ptr, const AVPacket *avpkt);
4785 * Decode the video frame of size avpkt->size from avpkt->data into picture.
4786 * Some decoders may support multiple frames in a single AVPacket, such
4787 * decoders would then just decode the first frame.
4789 * @warning The input buffer must be AV_INPUT_BUFFER_PADDING_SIZE larger than
4790 * the actual read bytes because some optimized bitstream readers read 32 or 64
4791 * bits at once and could read over the end.
4793 * @warning The end of the input buffer buf should be set to 0 to ensure that
4794 * no overreading happens for damaged MPEG streams.
4796 * @note Codecs which have the AV_CODEC_CAP_DELAY capability set have a delay
4797 * between input and output, these need to be fed with avpkt->data=NULL,
4798 * avpkt->size=0 at the end to return the remaining frames.
4800 * @note The AVCodecContext MUST have been opened with @ref avcodec_open2()
4801 * before packets may be fed to the decoder.
4803 * @param avctx the codec context
4804 * @param[out] picture The AVFrame in which the decoded video frame will be stored.
4805 * Use av_frame_alloc() to get an AVFrame. The codec will
4806 * allocate memory for the actual bitmap by calling the
4807 * AVCodecContext.get_buffer2() callback.
4808 * When AVCodecContext.refcounted_frames is set to 1, the frame is
4809 * reference counted and the returned reference belongs to the
4810 * caller. The caller must release the frame using av_frame_unref()
4811 * when the frame is no longer needed. The caller may safely write
4812 * to the frame if av_frame_is_writable() returns 1.
4813 * When AVCodecContext.refcounted_frames is set to 0, the returned
4814 * reference belongs to the decoder and is valid only until the
4815 * next call to this function or until closing or flushing the
4816 * decoder. The caller may not write to it.
4818 * @param[in] avpkt The input AVPacket containing the input buffer.
4819 * You can create such packet with av_init_packet() and by then setting
4820 * data and size, some decoders might in addition need other fields like
4821 * flags&AV_PKT_FLAG_KEY. All decoders are designed to use the least
4823 * @param[in,out] got_picture_ptr Zero if no frame could be decompressed, otherwise, it is nonzero.
4824 * @return On error a negative value is returned, otherwise the number of bytes
4825 * used or zero if no frame could be decompressed.
4827 * @deprecated Use avcodec_send_packet() and avcodec_receive_frame().
4829 attribute_deprecated
4830 int avcodec_decode_video2(AVCodecContext *avctx, AVFrame *picture,
4831 int *got_picture_ptr,
4832 const AVPacket *avpkt);
4835 * Decode a subtitle message.
4836 * Return a negative value on error, otherwise return the number of bytes used.
4837 * If no subtitle could be decompressed, got_sub_ptr is zero.
4838 * Otherwise, the subtitle is stored in *sub.
4839 * Note that AV_CODEC_CAP_DR1 is not available for subtitle codecs. This is for
4840 * simplicity, because the performance difference is expect to be negligible
4841 * and reusing a get_buffer written for video codecs would probably perform badly
4842 * due to a potentially very different allocation pattern.
4844 * Some decoders (those marked with AV_CODEC_CAP_DELAY) have a delay between input
4845 * and output. This means that for some packets they will not immediately
4846 * produce decoded output and need to be flushed at the end of decoding to get
4847 * all the decoded data. Flushing is done by calling this function with packets
4848 * with avpkt->data set to NULL and avpkt->size set to 0 until it stops
4849 * returning subtitles. It is safe to flush even those decoders that are not
4850 * marked with AV_CODEC_CAP_DELAY, then no subtitles will be returned.
4852 * @note The AVCodecContext MUST have been opened with @ref avcodec_open2()
4853 * before packets may be fed to the decoder.
4855 * @param avctx the codec context
4856 * @param[out] sub The Preallocated AVSubtitle in which the decoded subtitle will be stored,
4857 * must be freed with avsubtitle_free if *got_sub_ptr is set.
4858 * @param[in,out] got_sub_ptr Zero if no subtitle could be decompressed, otherwise, it is nonzero.
4859 * @param[in] avpkt The input AVPacket containing the input buffer.
4861 int avcodec_decode_subtitle2(AVCodecContext *avctx, AVSubtitle *sub,
4866 * Supply raw packet data as input to a decoder.
4868 * Internally, this call will copy relevant AVCodecContext fields, which can
4869 * influence decoding per-packet, and apply them when the packet is actually
4870 * decoded. (For example AVCodecContext.skip_frame, which might direct the
4871 * decoder to drop the frame contained by the packet sent with this function.)
4873 * @warning The input buffer, avpkt->data must be AV_INPUT_BUFFER_PADDING_SIZE
4874 * larger than the actual read bytes because some optimized bitstream
4875 * readers read 32 or 64 bits at once and could read over the end.
4877 * @warning Do not mix this API with the legacy API (like avcodec_decode_video2())
4878 * on the same AVCodecContext. It will return unexpected results now
4879 * or in future libavcodec versions.
4881 * @note The AVCodecContext MUST have been opened with @ref avcodec_open2()
4882 * before packets may be fed to the decoder.
4884 * @param avctx codec context
4885 * @param[in] avpkt The input AVPacket. Usually, this will be a single video
4886 * frame, or several complete audio frames.
4887 * Ownership of the packet remains with the caller, and the
4888 * decoder will not write to the packet. The decoder may create
4889 * a reference to the packet data (or copy it if the packet is
4890 * not reference-counted).
4891 * Unlike with older APIs, the packet is always fully consumed,
4892 * and if it contains multiple frames (e.g. some audio codecs),
4893 * will require you to call avcodec_receive_frame() multiple
4894 * times afterwards before you can send a new packet.
4895 * It can be NULL (or an AVPacket with data set to NULL and
4896 * size set to 0); in this case, it is considered a flush
4897 * packet, which signals the end of the stream. Sending the
4898 * first flush packet will return success. Subsequent ones are
4899 * unnecessary and will return AVERROR_EOF. If the decoder
4900 * still has frames buffered, it will return them after sending
4903 * @return 0 on success, otherwise negative error code:
4904 * AVERROR(EAGAIN): input is not accepted in the current state - user
4905 * must read output with avcodec_receive_frame() (once
4906 * all output is read, the packet should be resent, and
4907 * the call will not fail with EAGAIN).
4908 * AVERROR_EOF: the decoder has been flushed, and no new packets can
4909 * be sent to it (also returned if more than 1 flush
4911 * AVERROR(EINVAL): codec not opened, it is an encoder, or requires flush
4912 * AVERROR(ENOMEM): failed to add packet to internal queue, or similar
4913 * other errors: legitimate decoding errors
4915 int avcodec_send_packet(AVCodecContext *avctx, const AVPacket *avpkt);
4918 * Return decoded output data from a decoder.
4920 * @param avctx codec context
4921 * @param frame This will be set to a reference-counted video or audio
4922 * frame (depending on the decoder type) allocated by the
4923 * decoder. Note that the function will always call
4924 * av_frame_unref(frame) before doing anything else.
4927 * 0: success, a frame was returned
4928 * AVERROR(EAGAIN): output is not available in this state - user must try
4930 * AVERROR_EOF: the decoder has been fully flushed, and there will be
4931 * no more output frames
4932 * AVERROR(EINVAL): codec not opened, or it is an encoder
4933 * AVERROR_INPUT_CHANGED: current decoded frame has changed parameters
4934 * with respect to first decoded frame. Applicable
4935 * when flag AV_CODEC_FLAG_DROPCHANGED is set.
4936 * other negative values: legitimate decoding errors
4938 int avcodec_receive_frame(AVCodecContext *avctx, AVFrame *frame);
4941 * Supply a raw video or audio frame to the encoder. Use avcodec_receive_packet()
4942 * to retrieve buffered output packets.
4944 * @param avctx codec context
4945 * @param[in] frame AVFrame containing the raw audio or video frame to be encoded.
4946 * Ownership of the frame remains with the caller, and the
4947 * encoder will not write to the frame. The encoder may create
4948 * a reference to the frame data (or copy it if the frame is
4949 * not reference-counted).
4950 * It can be NULL, in which case it is considered a flush
4951 * packet. This signals the end of the stream. If the encoder
4952 * still has packets buffered, it will return them after this
4953 * call. Once flushing mode has been entered, additional flush
4954 * packets are ignored, and sending frames will return
4958 * If AV_CODEC_CAP_VARIABLE_FRAME_SIZE is set, then each frame
4959 * can have any number of samples.
4960 * If it is not set, frame->nb_samples must be equal to
4961 * avctx->frame_size for all frames except the last.
4962 * The final frame may be smaller than avctx->frame_size.
4963 * @return 0 on success, otherwise negative error code:
4964 * AVERROR(EAGAIN): input is not accepted in the current state - user
4965 * must read output with avcodec_receive_packet() (once
4966 * all output is read, the packet should be resent, and
4967 * the call will not fail with EAGAIN).
4968 * AVERROR_EOF: the encoder has been flushed, and no new frames can
4970 * AVERROR(EINVAL): codec not opened, refcounted_frames not set, it is a
4971 * decoder, or requires flush
4972 * AVERROR(ENOMEM): failed to add packet to internal queue, or similar
4973 * other errors: legitimate decoding errors
4975 int avcodec_send_frame(AVCodecContext *avctx, const AVFrame *frame);
4978 * Read encoded data from the encoder.
4980 * @param avctx codec context
4981 * @param avpkt This will be set to a reference-counted packet allocated by the
4982 * encoder. Note that the function will always call
4983 * av_frame_unref(frame) before doing anything else.
4984 * @return 0 on success, otherwise negative error code:
4985 * AVERROR(EAGAIN): output is not available in the current state - user
4986 * must try to send input
4987 * AVERROR_EOF: the encoder has been fully flushed, and there will be
4988 * no more output packets
4989 * AVERROR(EINVAL): codec not opened, or it is an encoder
4990 * other errors: legitimate decoding errors
4992 int avcodec_receive_packet(AVCodecContext *avctx, AVPacket *avpkt);
4995 * Create and return a AVHWFramesContext with values adequate for hardware
4996 * decoding. This is meant to get called from the get_format callback, and is
4997 * a helper for preparing a AVHWFramesContext for AVCodecContext.hw_frames_ctx.
4998 * This API is for decoding with certain hardware acceleration modes/APIs only.
5000 * The returned AVHWFramesContext is not initialized. The caller must do this
5001 * with av_hwframe_ctx_init().
5003 * Calling this function is not a requirement, but makes it simpler to avoid
5004 * codec or hardware API specific details when manually allocating frames.
5006 * Alternatively to this, an API user can set AVCodecContext.hw_device_ctx,
5007 * which sets up AVCodecContext.hw_frames_ctx fully automatically, and makes
5008 * it unnecessary to call this function or having to care about
5009 * AVHWFramesContext initialization at all.
5011 * There are a number of requirements for calling this function:
5013 * - It must be called from get_format with the same avctx parameter that was
5014 * passed to get_format. Calling it outside of get_format is not allowed, and
5015 * can trigger undefined behavior.
5016 * - The function is not always supported (see description of return values).
5017 * Even if this function returns successfully, hwaccel initialization could
5018 * fail later. (The degree to which implementations check whether the stream
5019 * is actually supported varies. Some do this check only after the user's
5020 * get_format callback returns.)
5021 * - The hw_pix_fmt must be one of the choices suggested by get_format. If the
5022 * user decides to use a AVHWFramesContext prepared with this API function,
5023 * the user must return the same hw_pix_fmt from get_format.
5024 * - The device_ref passed to this function must support the given hw_pix_fmt.
5025 * - After calling this API function, it is the user's responsibility to
5026 * initialize the AVHWFramesContext (returned by the out_frames_ref parameter),
5027 * and to set AVCodecContext.hw_frames_ctx to it. If done, this must be done
5028 * before returning from get_format (this is implied by the normal
5029 * AVCodecContext.hw_frames_ctx API rules).
5030 * - The AVHWFramesContext parameters may change every time time get_format is
5031 * called. Also, AVCodecContext.hw_frames_ctx is reset before get_format. So
5032 * you are inherently required to go through this process again on every
5034 * - It is perfectly possible to call this function without actually using
5035 * the resulting AVHWFramesContext. One use-case might be trying to reuse a
5036 * previously initialized AVHWFramesContext, and calling this API function
5037 * only to test whether the required frame parameters have changed.
5038 * - Fields that use dynamically allocated values of any kind must not be set
5039 * by the user unless setting them is explicitly allowed by the documentation.
5040 * If the user sets AVHWFramesContext.free and AVHWFramesContext.user_opaque,
5041 * the new free callback must call the potentially set previous free callback.
5042 * This API call may set any dynamically allocated fields, including the free
5045 * The function will set at least the following fields on AVHWFramesContext
5046 * (potentially more, depending on hwaccel API):
5048 * - All fields set by av_hwframe_ctx_alloc().
5049 * - Set the format field to hw_pix_fmt.
5050 * - Set the sw_format field to the most suited and most versatile format. (An
5051 * implication is that this will prefer generic formats over opaque formats
5052 * with arbitrary restrictions, if possible.)
5053 * - Set the width/height fields to the coded frame size, rounded up to the
5054 * API-specific minimum alignment.
5055 * - Only _if_ the hwaccel requires a pre-allocated pool: set the initial_pool_size
5056 * field to the number of maximum reference surfaces possible with the codec,
5057 * plus 1 surface for the user to work (meaning the user can safely reference
5058 * at most 1 decoded surface at a time), plus additional buffering introduced
5059 * by frame threading. If the hwaccel does not require pre-allocation, the
5060 * field is left to 0, and the decoder will allocate new surfaces on demand
5062 * - Possibly AVHWFramesContext.hwctx fields, depending on the underlying
5065 * Essentially, out_frames_ref returns the same as av_hwframe_ctx_alloc(), but
5066 * with basic frame parameters set.
5068 * The function is stateless, and does not change the AVCodecContext or the
5069 * device_ref AVHWDeviceContext.
5071 * @param avctx The context which is currently calling get_format, and which
5072 * implicitly contains all state needed for filling the returned
5073 * AVHWFramesContext properly.
5074 * @param device_ref A reference to the AVHWDeviceContext describing the device
5075 * which will be used by the hardware decoder.
5076 * @param hw_pix_fmt The hwaccel format you are going to return from get_format.
5077 * @param out_frames_ref On success, set to a reference to an _uninitialized_
5078 * AVHWFramesContext, created from the given device_ref.
5079 * Fields will be set to values required for decoding.
5080 * Not changed if an error is returned.
5081 * @return zero on success, a negative value on error. The following error codes
5082 * have special semantics:
5083 * AVERROR(ENOENT): the decoder does not support this functionality. Setup
5084 * is always manual, or it is a decoder which does not
5085 * support setting AVCodecContext.hw_frames_ctx at all,
5086 * or it is a software format.
5087 * AVERROR(EINVAL): it is known that hardware decoding is not supported for
5088 * this configuration, or the device_ref is not supported
5089 * for the hwaccel referenced by hw_pix_fmt.
5091 int avcodec_get_hw_frames_parameters(AVCodecContext *avctx,
5092 AVBufferRef *device_ref,
5093 enum AVPixelFormat hw_pix_fmt,
5094 AVBufferRef **out_frames_ref);
5099 * @defgroup lavc_parsing Frame parsing
5103 enum AVPictureStructure {
5104 AV_PICTURE_STRUCTURE_UNKNOWN, //< unknown
5105 AV_PICTURE_STRUCTURE_TOP_FIELD, //< coded as top field
5106 AV_PICTURE_STRUCTURE_BOTTOM_FIELD, //< coded as bottom field
5107 AV_PICTURE_STRUCTURE_FRAME, //< coded as frame
5110 typedef struct AVCodecParserContext {
5112 struct AVCodecParser *parser;
5113 int64_t frame_offset; /* offset of the current frame */
5114 int64_t cur_offset; /* current offset
5115 (incremented by each av_parser_parse()) */
5116 int64_t next_frame_offset; /* offset of the next frame */
5118 int pict_type; /* XXX: Put it back in AVCodecContext. */
5120 * This field is used for proper frame duration computation in lavf.
5121 * It signals, how much longer the frame duration of the current frame
5122 * is compared to normal frame duration.
5124 * frame_duration = (1 + repeat_pict) * time_base
5126 * It is used by codecs like H.264 to display telecined material.
5128 int repeat_pict; /* XXX: Put it back in AVCodecContext. */
5129 int64_t pts; /* pts of the current frame */
5130 int64_t dts; /* dts of the current frame */
5135 int fetch_timestamp;
5137 #define AV_PARSER_PTS_NB 4
5138 int cur_frame_start_index;
5139 int64_t cur_frame_offset[AV_PARSER_PTS_NB];
5140 int64_t cur_frame_pts[AV_PARSER_PTS_NB];
5141 int64_t cur_frame_dts[AV_PARSER_PTS_NB];
5144 #define PARSER_FLAG_COMPLETE_FRAMES 0x0001
5145 #define PARSER_FLAG_ONCE 0x0002
5146 /// Set if the parser has a valid file offset
5147 #define PARSER_FLAG_FETCHED_OFFSET 0x0004
5148 #define PARSER_FLAG_USE_CODEC_TS 0x1000
5150 int64_t offset; ///< byte offset from starting packet start
5151 int64_t cur_frame_end[AV_PARSER_PTS_NB];
5154 * Set by parser to 1 for key frames and 0 for non-key frames.
5155 * It is initialized to -1, so if the parser doesn't set this flag,
5156 * old-style fallback using AV_PICTURE_TYPE_I picture type as key frames
5161 #if FF_API_CONVERGENCE_DURATION
5163 * @deprecated unused
5165 attribute_deprecated
5166 int64_t convergence_duration;
5169 // Timestamp generation support:
5171 * Synchronization point for start of timestamp generation.
5173 * Set to >0 for sync point, 0 for no sync point and <0 for undefined
5176 * For example, this corresponds to presence of H.264 buffering period
5182 * Offset of the current timestamp against last timestamp sync point in
5183 * units of AVCodecContext.time_base.
5185 * Set to INT_MIN when dts_sync_point unused. Otherwise, it must
5186 * contain a valid timestamp offset.
5188 * Note that the timestamp of sync point has usually a nonzero
5189 * dts_ref_dts_delta, which refers to the previous sync point. Offset of
5190 * the next frame after timestamp sync point will be usually 1.
5192 * For example, this corresponds to H.264 cpb_removal_delay.
5194 int dts_ref_dts_delta;
5197 * Presentation delay of current frame in units of AVCodecContext.time_base.
5199 * Set to INT_MIN when dts_sync_point unused. Otherwise, it must
5200 * contain valid non-negative timestamp delta (presentation time of a frame
5201 * must not lie in the past).
5203 * This delay represents the difference between decoding and presentation
5204 * time of the frame.
5206 * For example, this corresponds to H.264 dpb_output_delay.
5211 * Position of the packet in file.
5213 * Analogous to cur_frame_pts/dts
5215 int64_t cur_frame_pos[AV_PARSER_PTS_NB];
5218 * Byte position of currently parsed frame in stream.
5223 * Previous frame byte position.
5228 * Duration of the current frame.
5229 * For audio, this is in units of 1 / AVCodecContext.sample_rate.
5230 * For all other types, this is in units of AVCodecContext.time_base.
5234 enum AVFieldOrder field_order;
5237 * Indicate whether a picture is coded as a frame, top field or bottom field.
5239 * For example, H.264 field_pic_flag equal to 0 corresponds to
5240 * AV_PICTURE_STRUCTURE_FRAME. An H.264 picture with field_pic_flag
5241 * equal to 1 and bottom_field_flag equal to 0 corresponds to
5242 * AV_PICTURE_STRUCTURE_TOP_FIELD.
5244 enum AVPictureStructure picture_structure;
5247 * Picture number incremented in presentation or output order.
5248 * This field may be reinitialized at the first picture of a new sequence.
5250 * For example, this corresponds to H.264 PicOrderCnt.
5252 int output_picture_number;
5255 * Dimensions of the decoded video intended for presentation.
5261 * Dimensions of the coded video.
5267 * The format of the coded data, corresponds to enum AVPixelFormat for video
5268 * and for enum AVSampleFormat for audio.
5270 * Note that a decoder can have considerable freedom in how exactly it
5271 * decodes the data, so the format reported here might be different from the
5272 * one returned by a decoder.
5275 } AVCodecParserContext;
5277 typedef struct AVCodecParser {
5278 int codec_ids[5]; /* several codec IDs are permitted */
5280 int (*parser_init)(AVCodecParserContext *s);
5281 /* This callback never returns an error, a negative value means that
5282 * the frame start was in a previous packet. */
5283 int (*parser_parse)(AVCodecParserContext *s,
5284 AVCodecContext *avctx,
5285 const uint8_t **poutbuf, int *poutbuf_size,
5286 const uint8_t *buf, int buf_size);
5287 void (*parser_close)(AVCodecParserContext *s);
5288 int (*split)(AVCodecContext *avctx, const uint8_t *buf, int buf_size);
5289 struct AVCodecParser *next;
5293 * Iterate over all registered codec parsers.
5295 * @param opaque a pointer where libavcodec will store the iteration state. Must
5296 * point to NULL to start the iteration.
5298 * @return the next registered codec parser or NULL when the iteration is
5301 const AVCodecParser *av_parser_iterate(void **opaque);
5303 attribute_deprecated
5304 AVCodecParser *av_parser_next(const AVCodecParser *c);
5306 attribute_deprecated
5307 void av_register_codec_parser(AVCodecParser *parser);
5308 AVCodecParserContext *av_parser_init(int codec_id);
5313 * @param s parser context.
5314 * @param avctx codec context.
5315 * @param poutbuf set to pointer to parsed buffer or NULL if not yet finished.
5316 * @param poutbuf_size set to size of parsed buffer or zero if not yet finished.
5317 * @param buf input buffer.
5318 * @param buf_size buffer size in bytes without the padding. I.e. the full buffer
5319 size is assumed to be buf_size + AV_INPUT_BUFFER_PADDING_SIZE.
5320 To signal EOF, this should be 0 (so that the last frame
5322 * @param pts input presentation timestamp.
5323 * @param dts input decoding timestamp.
5324 * @param pos input byte position in stream.
5325 * @return the number of bytes of the input bitstream used.
5330 * len = av_parser_parse2(myparser, AVCodecContext, &data, &size,
5337 * decode_frame(data, size);
5341 int av_parser_parse2(AVCodecParserContext *s,
5342 AVCodecContext *avctx,
5343 uint8_t **poutbuf, int *poutbuf_size,
5344 const uint8_t *buf, int buf_size,
5345 int64_t pts, int64_t dts,
5349 * @return 0 if the output buffer is a subset of the input, 1 if it is allocated and must be freed
5350 * @deprecated use AVBitStreamFilter
5352 int av_parser_change(AVCodecParserContext *s,
5353 AVCodecContext *avctx,
5354 uint8_t **poutbuf, int *poutbuf_size,
5355 const uint8_t *buf, int buf_size, int keyframe);
5356 void av_parser_close(AVCodecParserContext *s);
5364 * @addtogroup lavc_encoding
5369 * Find a registered encoder with a matching codec ID.
5371 * @param id AVCodecID of the requested encoder
5372 * @return An encoder if one was found, NULL otherwise.
5374 AVCodec *avcodec_find_encoder(enum AVCodecID id);
5377 * Find a registered encoder with the specified name.
5379 * @param name name of the requested encoder
5380 * @return An encoder if one was found, NULL otherwise.
5382 AVCodec *avcodec_find_encoder_by_name(const char *name);
5385 * Encode a frame of audio.
5387 * Takes input samples from frame and writes the next output packet, if
5388 * available, to avpkt. The output packet does not necessarily contain data for
5389 * the most recent frame, as encoders can delay, split, and combine input frames
5390 * internally as needed.
5392 * @param avctx codec context
5393 * @param avpkt output AVPacket.
5394 * The user can supply an output buffer by setting
5395 * avpkt->data and avpkt->size prior to calling the
5396 * function, but if the size of the user-provided data is not
5397 * large enough, encoding will fail. If avpkt->data and
5398 * avpkt->size are set, avpkt->destruct must also be set. All
5399 * other AVPacket fields will be reset by the encoder using
5400 * av_init_packet(). If avpkt->data is NULL, the encoder will
5401 * allocate it. The encoder will set avpkt->size to the size
5402 * of the output packet.
5404 * If this function fails or produces no output, avpkt will be
5405 * freed using av_packet_unref().
5406 * @param[in] frame AVFrame containing the raw audio data to be encoded.
5407 * May be NULL when flushing an encoder that has the
5408 * AV_CODEC_CAP_DELAY capability set.
5409 * If AV_CODEC_CAP_VARIABLE_FRAME_SIZE is set, then each frame
5410 * can have any number of samples.
5411 * If it is not set, frame->nb_samples must be equal to
5412 * avctx->frame_size for all frames except the last.
5413 * The final frame may be smaller than avctx->frame_size.
5414 * @param[out] got_packet_ptr This field is set to 1 by libavcodec if the
5415 * output packet is non-empty, and to 0 if it is
5416 * empty. If the function returns an error, the
5417 * packet can be assumed to be invalid, and the
5418 * value of got_packet_ptr is undefined and should
5420 * @return 0 on success, negative error code on failure
5422 * @deprecated use avcodec_send_frame()/avcodec_receive_packet() instead
5424 attribute_deprecated
5425 int avcodec_encode_audio2(AVCodecContext *avctx, AVPacket *avpkt,
5426 const AVFrame *frame, int *got_packet_ptr);
5429 * Encode a frame of video.
5431 * Takes input raw video data from frame and writes the next output packet, if
5432 * available, to avpkt. The output packet does not necessarily contain data for
5433 * the most recent frame, as encoders can delay and reorder input frames
5434 * internally as needed.
5436 * @param avctx codec context
5437 * @param avpkt output AVPacket.
5438 * The user can supply an output buffer by setting
5439 * avpkt->data and avpkt->size prior to calling the
5440 * function, but if the size of the user-provided data is not
5441 * large enough, encoding will fail. All other AVPacket fields
5442 * will be reset by the encoder using av_init_packet(). If
5443 * avpkt->data is NULL, the encoder will allocate it.
5444 * The encoder will set avpkt->size to the size of the
5445 * output packet. The returned data (if any) belongs to the
5446 * caller, he is responsible for freeing it.
5448 * If this function fails or produces no output, avpkt will be
5449 * freed using av_packet_unref().
5450 * @param[in] frame AVFrame containing the raw video data to be encoded.
5451 * May be NULL when flushing an encoder that has the
5452 * AV_CODEC_CAP_DELAY capability set.
5453 * @param[out] got_packet_ptr This field is set to 1 by libavcodec if the
5454 * output packet is non-empty, and to 0 if it is
5455 * empty. If the function returns an error, the
5456 * packet can be assumed to be invalid, and the
5457 * value of got_packet_ptr is undefined and should
5459 * @return 0 on success, negative error code on failure
5461 * @deprecated use avcodec_send_frame()/avcodec_receive_packet() instead
5463 attribute_deprecated
5464 int avcodec_encode_video2(AVCodecContext *avctx, AVPacket *avpkt,
5465 const AVFrame *frame, int *got_packet_ptr);
5467 int avcodec_encode_subtitle(AVCodecContext *avctx, uint8_t *buf, int buf_size,
5468 const AVSubtitle *sub);
5475 #if FF_API_AVPICTURE
5477 * @addtogroup lavc_picture
5482 * @deprecated unused
5484 attribute_deprecated
5485 int avpicture_alloc(AVPicture *picture, enum AVPixelFormat pix_fmt, int width, int height);
5488 * @deprecated unused
5490 attribute_deprecated
5491 void avpicture_free(AVPicture *picture);
5494 * @deprecated use av_image_fill_arrays() instead.
5496 attribute_deprecated
5497 int avpicture_fill(AVPicture *picture, const uint8_t *ptr,
5498 enum AVPixelFormat pix_fmt, int width, int height);
5501 * @deprecated use av_image_copy_to_buffer() instead.
5503 attribute_deprecated
5504 int avpicture_layout(const AVPicture *src, enum AVPixelFormat pix_fmt,
5505 int width, int height,
5506 unsigned char *dest, int dest_size);
5509 * @deprecated use av_image_get_buffer_size() instead.
5511 attribute_deprecated
5512 int avpicture_get_size(enum AVPixelFormat pix_fmt, int width, int height);
5515 * @deprecated av_image_copy() instead.
5517 attribute_deprecated
5518 void av_picture_copy(AVPicture *dst, const AVPicture *src,
5519 enum AVPixelFormat pix_fmt, int width, int height);
5522 * @deprecated unused
5524 attribute_deprecated
5525 int av_picture_crop(AVPicture *dst, const AVPicture *src,
5526 enum AVPixelFormat pix_fmt, int top_band, int left_band);
5529 * @deprecated unused
5531 attribute_deprecated
5532 int av_picture_pad(AVPicture *dst, const AVPicture *src, int height, int width, enum AVPixelFormat pix_fmt,
5533 int padtop, int padbottom, int padleft, int padright, int *color);
5541 * @defgroup lavc_misc Utility functions
5544 * Miscellaneous utility functions related to both encoding and decoding
5550 * @defgroup lavc_misc_pixfmt Pixel formats
5552 * Functions for working with pixel formats.
5556 #if FF_API_GETCHROMA
5558 * @deprecated Use av_pix_fmt_get_chroma_sub_sample
5561 attribute_deprecated
5562 void avcodec_get_chroma_sub_sample(enum AVPixelFormat pix_fmt, int *h_shift, int *v_shift);
5566 * Return a value representing the fourCC code associated to the
5567 * pixel format pix_fmt, or 0 if no associated fourCC code can be
5570 unsigned int avcodec_pix_fmt_to_codec_tag(enum AVPixelFormat pix_fmt);
5573 * @deprecated see av_get_pix_fmt_loss()
5575 int avcodec_get_pix_fmt_loss(enum AVPixelFormat dst_pix_fmt, enum AVPixelFormat src_pix_fmt,
5579 * Find the best pixel format to convert to given a certain source pixel
5580 * format. When converting from one pixel format to another, information loss
5581 * may occur. For example, when converting from RGB24 to GRAY, the color
5582 * information will be lost. Similarly, other losses occur when converting from
5583 * some formats to other formats. avcodec_find_best_pix_fmt_of_2() searches which of
5584 * the given pixel formats should be used to suffer the least amount of loss.
5585 * The pixel formats from which it chooses one, are determined by the
5586 * pix_fmt_list parameter.
5589 * @param[in] pix_fmt_list AV_PIX_FMT_NONE terminated array of pixel formats to choose from
5590 * @param[in] src_pix_fmt source pixel format
5591 * @param[in] has_alpha Whether the source pixel format alpha channel is used.
5592 * @param[out] loss_ptr Combination of flags informing you what kind of losses will occur.
5593 * @return The best pixel format to convert to or -1 if none was found.
5595 enum AVPixelFormat avcodec_find_best_pix_fmt_of_list(const enum AVPixelFormat *pix_fmt_list,
5596 enum AVPixelFormat src_pix_fmt,
5597 int has_alpha, int *loss_ptr);
5600 * @deprecated see av_find_best_pix_fmt_of_2()
5602 enum AVPixelFormat avcodec_find_best_pix_fmt_of_2(enum AVPixelFormat dst_pix_fmt1, enum AVPixelFormat dst_pix_fmt2,
5603 enum AVPixelFormat src_pix_fmt, int has_alpha, int *loss_ptr);
5605 attribute_deprecated
5606 enum AVPixelFormat avcodec_find_best_pix_fmt2(enum AVPixelFormat dst_pix_fmt1, enum AVPixelFormat dst_pix_fmt2,
5607 enum AVPixelFormat src_pix_fmt, int has_alpha, int *loss_ptr);
5609 enum AVPixelFormat avcodec_default_get_format(struct AVCodecContext *s, const enum AVPixelFormat * fmt);
5615 #if FF_API_TAG_STRING
5617 * Put a string representing the codec tag codec_tag in buf.
5619 * @param buf buffer to place codec tag in
5620 * @param buf_size size in bytes of buf
5621 * @param codec_tag codec tag to assign
5622 * @return the length of the string that would have been generated if
5623 * enough space had been available, excluding the trailing null
5625 * @deprecated see av_fourcc_make_string() and av_fourcc2str().
5627 attribute_deprecated
5628 size_t av_get_codec_tag_string(char *buf, size_t buf_size, unsigned int codec_tag);
5631 void avcodec_string(char *buf, int buf_size, AVCodecContext *enc, int encode);
5634 * Return a name for the specified profile, if available.
5636 * @param codec the codec that is searched for the given profile
5637 * @param profile the profile value for which a name is requested
5638 * @return A name for the profile if found, NULL otherwise.
5640 const char *av_get_profile_name(const AVCodec *codec, int profile);
5643 * Return a name for the specified profile, if available.
5645 * @param codec_id the ID of the codec to which the requested profile belongs
5646 * @param profile the profile value for which a name is requested
5647 * @return A name for the profile if found, NULL otherwise.
5649 * @note unlike av_get_profile_name(), which searches a list of profiles
5650 * supported by a specific decoder or encoder implementation, this
5651 * function searches the list of profiles from the AVCodecDescriptor
5653 const char *avcodec_profile_name(enum AVCodecID codec_id, int profile);
5655 int avcodec_default_execute(AVCodecContext *c, int (*func)(AVCodecContext *c2, void *arg2),void *arg, int *ret, int count, int size);
5656 int avcodec_default_execute2(AVCodecContext *c, int (*func)(AVCodecContext *c2, void *arg2, int, int),void *arg, int *ret, int count);
5657 //FIXME func typedef
5660 * Fill AVFrame audio data and linesize pointers.
5662 * The buffer buf must be a preallocated buffer with a size big enough
5663 * to contain the specified samples amount. The filled AVFrame data
5664 * pointers will point to this buffer.
5666 * AVFrame extended_data channel pointers are allocated if necessary for
5669 * @param frame the AVFrame
5670 * frame->nb_samples must be set prior to calling the
5671 * function. This function fills in frame->data,
5672 * frame->extended_data, frame->linesize[0].
5673 * @param nb_channels channel count
5674 * @param sample_fmt sample format
5675 * @param buf buffer to use for frame data
5676 * @param buf_size size of buffer
5677 * @param align plane size sample alignment (0 = default)
5678 * @return >=0 on success, negative error code on failure
5679 * @todo return the size in bytes required to store the samples in
5680 * case of success, at the next libavutil bump
5682 int avcodec_fill_audio_frame(AVFrame *frame, int nb_channels,
5683 enum AVSampleFormat sample_fmt, const uint8_t *buf,
5684 int buf_size, int align);
5687 * Reset the internal decoder state / flush internal buffers. Should be called
5688 * e.g. when seeking or when switching to a different stream.
5690 * @note when refcounted frames are not used (i.e. avctx->refcounted_frames is 0),
5691 * this invalidates the frames previously returned from the decoder. When
5692 * refcounted frames are used, the decoder just releases any references it might
5693 * keep internally, but the caller's reference remains valid.
5695 void avcodec_flush_buffers(AVCodecContext *avctx);
5698 * Return codec bits per sample.
5700 * @param[in] codec_id the codec
5701 * @return Number of bits per sample or zero if unknown for the given codec.
5703 int av_get_bits_per_sample(enum AVCodecID codec_id);
5706 * Return the PCM codec associated with a sample format.
5707 * @param be endianness, 0 for little, 1 for big,
5708 * -1 (or anything else) for native
5709 * @return AV_CODEC_ID_PCM_* or AV_CODEC_ID_NONE
5711 enum AVCodecID av_get_pcm_codec(enum AVSampleFormat fmt, int be);
5714 * Return codec bits per sample.
5715 * Only return non-zero if the bits per sample is exactly correct, not an
5718 * @param[in] codec_id the codec
5719 * @return Number of bits per sample or zero if unknown for the given codec.
5721 int av_get_exact_bits_per_sample(enum AVCodecID codec_id);
5724 * Return audio frame duration.
5726 * @param avctx codec context
5727 * @param frame_bytes size of the frame, or 0 if unknown
5728 * @return frame duration, in samples, if known. 0 if not able to
5731 int av_get_audio_frame_duration(AVCodecContext *avctx, int frame_bytes);
5734 * This function is the same as av_get_audio_frame_duration(), except it works
5735 * with AVCodecParameters instead of an AVCodecContext.
5737 int av_get_audio_frame_duration2(AVCodecParameters *par, int frame_bytes);
5740 typedef struct AVBitStreamFilterContext {
5742 const struct AVBitStreamFilter *filter;
5743 AVCodecParserContext *parser;
5744 struct AVBitStreamFilterContext *next;
5746 * Internal default arguments, used if NULL is passed to av_bitstream_filter_filter().
5747 * Not for access by library users.
5750 } AVBitStreamFilterContext;
5753 typedef struct AVBSFInternal AVBSFInternal;
5756 * The bitstream filter state.
5758 * This struct must be allocated with av_bsf_alloc() and freed with
5761 * The fields in the struct will only be changed (by the caller or by the
5762 * filter) as described in their documentation, and are to be considered
5763 * immutable otherwise.
5765 typedef struct AVBSFContext {
5767 * A class for logging and AVOptions
5769 const AVClass *av_class;
5772 * The bitstream filter this context is an instance of.
5774 const struct AVBitStreamFilter *filter;
5777 * Opaque libavcodec internal data. Must not be touched by the caller in any
5780 AVBSFInternal *internal;
5783 * Opaque filter-specific private data. If filter->priv_class is non-NULL,
5784 * this is an AVOptions-enabled struct.
5789 * Parameters of the input stream. This field is allocated in
5790 * av_bsf_alloc(), it needs to be filled by the caller before
5793 AVCodecParameters *par_in;
5796 * Parameters of the output stream. This field is allocated in
5797 * av_bsf_alloc(), it is set by the filter in av_bsf_init().
5799 AVCodecParameters *par_out;
5802 * The timebase used for the timestamps of the input packets. Set by the
5803 * caller before av_bsf_init().
5805 AVRational time_base_in;
5808 * The timebase used for the timestamps of the output packets. Set by the
5809 * filter in av_bsf_init().
5811 AVRational time_base_out;
5814 typedef struct AVBitStreamFilter {
5818 * A list of codec ids supported by the filter, terminated by
5820 * May be NULL, in that case the bitstream filter works with any codec id.
5822 const enum AVCodecID *codec_ids;
5825 * A class for the private data, used to declare bitstream filter private
5826 * AVOptions. This field is NULL for bitstream filters that do not declare
5829 * If this field is non-NULL, the first member of the filter private data
5830 * must be a pointer to AVClass, which will be set by libavcodec generic
5831 * code to this class.
5833 const AVClass *priv_class;
5835 /*****************************************************************
5836 * No fields below this line are part of the public API. They
5837 * may not be used outside of libavcodec and can be changed and
5839 * New public fields should be added right above.
5840 *****************************************************************
5844 int (*init)(AVBSFContext *ctx);
5845 int (*filter)(AVBSFContext *ctx, AVPacket *pkt);
5846 void (*close)(AVBSFContext *ctx);
5847 void (*flush)(AVBSFContext *ctx);
5848 } AVBitStreamFilter;
5852 * @deprecated the old bitstream filtering API (using AVBitStreamFilterContext)
5853 * is deprecated. Use the new bitstream filtering API (using AVBSFContext).
5855 attribute_deprecated
5856 void av_register_bitstream_filter(AVBitStreamFilter *bsf);
5858 * @deprecated the old bitstream filtering API (using AVBitStreamFilterContext)
5859 * is deprecated. Use av_bsf_get_by_name(), av_bsf_alloc(), and av_bsf_init()
5860 * from the new bitstream filtering API (using AVBSFContext).
5862 attribute_deprecated
5863 AVBitStreamFilterContext *av_bitstream_filter_init(const char *name);
5865 * @deprecated the old bitstream filtering API (using AVBitStreamFilterContext)
5866 * is deprecated. Use av_bsf_send_packet() and av_bsf_receive_packet() from the
5867 * new bitstream filtering API (using AVBSFContext).
5869 attribute_deprecated
5870 int av_bitstream_filter_filter(AVBitStreamFilterContext *bsfc,
5871 AVCodecContext *avctx, const char *args,
5872 uint8_t **poutbuf, int *poutbuf_size,
5873 const uint8_t *buf, int buf_size, int keyframe);
5875 * @deprecated the old bitstream filtering API (using AVBitStreamFilterContext)
5876 * is deprecated. Use av_bsf_free() from the new bitstream filtering API (using
5879 attribute_deprecated
5880 void av_bitstream_filter_close(AVBitStreamFilterContext *bsf);
5882 * @deprecated the old bitstream filtering API (using AVBitStreamFilterContext)
5883 * is deprecated. Use av_bsf_iterate() from the new bitstream filtering API (using
5886 attribute_deprecated
5887 const AVBitStreamFilter *av_bitstream_filter_next(const AVBitStreamFilter *f);
5891 * @return a bitstream filter with the specified name or NULL if no such
5892 * bitstream filter exists.
5894 const AVBitStreamFilter *av_bsf_get_by_name(const char *name);
5897 * Iterate over all registered bitstream filters.
5899 * @param opaque a pointer where libavcodec will store the iteration state. Must
5900 * point to NULL to start the iteration.
5902 * @return the next registered bitstream filter or NULL when the iteration is
5905 const AVBitStreamFilter *av_bsf_iterate(void **opaque);
5907 attribute_deprecated
5908 const AVBitStreamFilter *av_bsf_next(void **opaque);
5912 * Allocate a context for a given bitstream filter. The caller must fill in the
5913 * context parameters as described in the documentation and then call
5914 * av_bsf_init() before sending any data to the filter.
5916 * @param filter the filter for which to allocate an instance.
5917 * @param ctx a pointer into which the pointer to the newly-allocated context
5918 * will be written. It must be freed with av_bsf_free() after the
5919 * filtering is done.
5921 * @return 0 on success, a negative AVERROR code on failure
5923 int av_bsf_alloc(const AVBitStreamFilter *filter, AVBSFContext **ctx);
5926 * Prepare the filter for use, after all the parameters and options have been
5929 int av_bsf_init(AVBSFContext *ctx);
5932 * Submit a packet for filtering.
5934 * After sending each packet, the filter must be completely drained by calling
5935 * av_bsf_receive_packet() repeatedly until it returns AVERROR(EAGAIN) or
5938 * @param pkt the packet to filter. The bitstream filter will take ownership of
5939 * the packet and reset the contents of pkt. pkt is not touched if an error occurs.
5940 * This parameter may be NULL, which signals the end of the stream (i.e. no more
5941 * packets will be sent). That will cause the filter to output any packets it
5942 * may have buffered internally.
5944 * @return 0 on success, a negative AVERROR on error.
5946 int av_bsf_send_packet(AVBSFContext *ctx, AVPacket *pkt);
5949 * Retrieve a filtered packet.
5951 * @param[out] pkt this struct will be filled with the contents of the filtered
5952 * packet. It is owned by the caller and must be freed using
5953 * av_packet_unref() when it is no longer needed.
5954 * This parameter should be "clean" (i.e. freshly allocated
5955 * with av_packet_alloc() or unreffed with av_packet_unref())
5956 * when this function is called. If this function returns
5957 * successfully, the contents of pkt will be completely
5958 * overwritten by the returned data. On failure, pkt is not
5961 * @return 0 on success. AVERROR(EAGAIN) if more packets need to be sent to the
5962 * filter (using av_bsf_send_packet()) to get more output. AVERROR_EOF if there
5963 * will be no further output from the filter. Another negative AVERROR value if
5966 * @note one input packet may result in several output packets, so after sending
5967 * a packet with av_bsf_send_packet(), this function needs to be called
5968 * repeatedly until it stops returning 0. It is also possible for a filter to
5969 * output fewer packets than were sent to it, so this function may return
5970 * AVERROR(EAGAIN) immediately after a successful av_bsf_send_packet() call.
5972 int av_bsf_receive_packet(AVBSFContext *ctx, AVPacket *pkt);
5975 * Reset the internal bitstream filter state / flush internal buffers.
5977 void av_bsf_flush(AVBSFContext *ctx);
5980 * Free a bitstream filter context and everything associated with it; write NULL
5981 * into the supplied pointer.
5983 void av_bsf_free(AVBSFContext **ctx);
5986 * Get the AVClass for AVBSFContext. It can be used in combination with
5987 * AV_OPT_SEARCH_FAKE_OBJ for examining options.
5989 * @see av_opt_find().
5991 const AVClass *av_bsf_get_class(void);
5994 * Structure for chain/list of bitstream filters.
5995 * Empty list can be allocated by av_bsf_list_alloc().
5997 typedef struct AVBSFList AVBSFList;
6000 * Allocate empty list of bitstream filters.
6001 * The list must be later freed by av_bsf_list_free()
6002 * or finalized by av_bsf_list_finalize().
6004 * @return Pointer to @ref AVBSFList on success, NULL in case of failure
6006 AVBSFList *av_bsf_list_alloc(void);
6009 * Free list of bitstream filters.
6011 * @param lst Pointer to pointer returned by av_bsf_list_alloc()
6013 void av_bsf_list_free(AVBSFList **lst);
6016 * Append bitstream filter to the list of bitstream filters.
6018 * @param lst List to append to
6019 * @param bsf Filter context to be appended
6021 * @return >=0 on success, negative AVERROR in case of failure
6023 int av_bsf_list_append(AVBSFList *lst, AVBSFContext *bsf);
6026 * Construct new bitstream filter context given it's name and options
6027 * and append it to the list of bitstream filters.
6029 * @param lst List to append to
6030 * @param bsf_name Name of the bitstream filter
6031 * @param options Options for the bitstream filter, can be set to NULL
6033 * @return >=0 on success, negative AVERROR in case of failure
6035 int av_bsf_list_append2(AVBSFList *lst, const char * bsf_name, AVDictionary **options);
6037 * Finalize list of bitstream filters.
6039 * This function will transform @ref AVBSFList to single @ref AVBSFContext,
6040 * so the whole chain of bitstream filters can be treated as single filter
6041 * freshly allocated by av_bsf_alloc().
6042 * If the call is successful, @ref AVBSFList structure is freed and lst
6043 * will be set to NULL. In case of failure, caller is responsible for
6044 * freeing the structure by av_bsf_list_free()
6046 * @param lst Filter list structure to be transformed
6047 * @param[out] bsf Pointer to be set to newly created @ref AVBSFContext structure
6048 * representing the chain of bitstream filters
6050 * @return >=0 on success, negative AVERROR in case of failure
6052 int av_bsf_list_finalize(AVBSFList **lst, AVBSFContext **bsf);
6055 * Parse string describing list of bitstream filters and create single
6056 * @ref AVBSFContext describing the whole chain of bitstream filters.
6057 * Resulting @ref AVBSFContext can be treated as any other @ref AVBSFContext freshly
6058 * allocated by av_bsf_alloc().
6060 * @param str String describing chain of bitstream filters in format
6061 * `bsf1[=opt1=val1:opt2=val2][,bsf2]`
6062 * @param[out] bsf Pointer to be set to newly created @ref AVBSFContext structure
6063 * representing the chain of bitstream filters
6065 * @return >=0 on success, negative AVERROR in case of failure
6067 int av_bsf_list_parse_str(const char *str, AVBSFContext **bsf);
6070 * Get null/pass-through bitstream filter.
6072 * @param[out] bsf Pointer to be set to new instance of pass-through bitstream filter
6076 int av_bsf_get_null_filter(AVBSFContext **bsf);
6081 * Same behaviour av_fast_malloc but the buffer has additional
6082 * AV_INPUT_BUFFER_PADDING_SIZE at the end which will always be 0.
6084 * In addition the whole buffer will initially and after resizes
6085 * be 0-initialized so that no uninitialized data will ever appear.
6087 void av_fast_padded_malloc(void *ptr, unsigned int *size, size_t min_size);
6090 * Same behaviour av_fast_padded_malloc except that buffer will always
6091 * be 0-initialized after call.
6093 void av_fast_padded_mallocz(void *ptr, unsigned int *size, size_t min_size);
6096 * Encode extradata length to a buffer. Used by xiph codecs.
6098 * @param s buffer to write to; must be at least (v/255+1) bytes long
6099 * @param v size of extradata in bytes
6100 * @return number of bytes written to the buffer.
6102 unsigned int av_xiphlacing(unsigned char *s, unsigned int v);
6104 #if FF_API_USER_VISIBLE_AVHWACCEL
6106 * Register the hardware accelerator hwaccel.
6108 * @deprecated This function doesn't do anything.
6110 attribute_deprecated
6111 void av_register_hwaccel(AVHWAccel *hwaccel);
6114 * If hwaccel is NULL, returns the first registered hardware accelerator,
6115 * if hwaccel is non-NULL, returns the next registered hardware accelerator
6116 * after hwaccel, or NULL if hwaccel is the last one.
6118 * @deprecated AVHWaccel structures contain no user-serviceable parts, so
6119 * this function should not be used.
6121 attribute_deprecated
6122 AVHWAccel *av_hwaccel_next(const AVHWAccel *hwaccel);
6127 * Lock operation used by lockmgr
6129 * @deprecated Deprecated together with av_lockmgr_register().
6132 AV_LOCK_CREATE, ///< Create a mutex
6133 AV_LOCK_OBTAIN, ///< Lock the mutex
6134 AV_LOCK_RELEASE, ///< Unlock the mutex
6135 AV_LOCK_DESTROY, ///< Free mutex resources
6139 * Register a user provided lock manager supporting the operations
6140 * specified by AVLockOp. The "mutex" argument to the function points
6141 * to a (void *) where the lockmgr should store/get a pointer to a user
6142 * allocated mutex. It is NULL upon AV_LOCK_CREATE and equal to the
6143 * value left by the last call for all other ops. If the lock manager is
6144 * unable to perform the op then it should leave the mutex in the same
6145 * state as when it was called and return a non-zero value. However,
6146 * when called with AV_LOCK_DESTROY the mutex will always be assumed to
6147 * have been successfully destroyed. If av_lockmgr_register succeeds
6148 * it will return a non-negative value, if it fails it will return a
6149 * negative value and destroy all mutex and unregister all callbacks.
6150 * av_lockmgr_register is not thread-safe, it must be called from a
6151 * single thread before any calls which make use of locking are used.
6153 * @param cb User defined callback. av_lockmgr_register invokes calls
6154 * to this callback and the previously registered callback.
6155 * The callback will be used to create more than one mutex
6156 * each of which must be backed by its own underlying locking
6157 * mechanism (i.e. do not use a single static object to
6158 * implement your lock manager). If cb is set to NULL the
6159 * lockmgr will be unregistered.
6161 * @deprecated This function does nothing, and always returns 0. Be sure to
6162 * build with thread support to get basic thread safety.
6164 attribute_deprecated
6165 int av_lockmgr_register(int (*cb)(void **mutex, enum AVLockOp op));
6169 * Get the type of the given codec.
6171 enum AVMediaType avcodec_get_type(enum AVCodecID codec_id);
6174 * Get the name of a codec.
6175 * @return a static string identifying the codec; never NULL
6177 const char *avcodec_get_name(enum AVCodecID id);
6180 * @return a positive value if s is open (i.e. avcodec_open2() was called on it
6181 * with no corresponding avcodec_close()), 0 otherwise.
6183 int avcodec_is_open(AVCodecContext *s);
6186 * @return a non-zero number if codec is an encoder, zero otherwise
6188 int av_codec_is_encoder(const AVCodec *codec);
6191 * @return a non-zero number if codec is a decoder, zero otherwise
6193 int av_codec_is_decoder(const AVCodec *codec);
6196 * @return descriptor for given codec ID or NULL if no descriptor exists.
6198 const AVCodecDescriptor *avcodec_descriptor_get(enum AVCodecID id);
6201 * Iterate over all codec descriptors known to libavcodec.
6203 * @param prev previous descriptor. NULL to get the first descriptor.
6205 * @return next descriptor or NULL after the last descriptor
6207 const AVCodecDescriptor *avcodec_descriptor_next(const AVCodecDescriptor *prev);
6210 * @return codec descriptor with the given name or NULL if no such descriptor
6213 const AVCodecDescriptor *avcodec_descriptor_get_by_name(const char *name);
6216 * Allocate a CPB properties structure and initialize its fields to default
6219 * @param size if non-NULL, the size of the allocated struct will be written
6220 * here. This is useful for embedding it in side data.
6222 * @return the newly allocated struct or NULL on failure
6224 AVCPBProperties *av_cpb_properties_alloc(size_t *size);
6230 #endif /* AVCODEC_AVCODEC_H */