2 * copyright (c) 2001 Fabrice Bellard
4 * This file is part of FFmpeg.
6 * FFmpeg is free software; you can redistribute it and/or
7 * modify it under the terms of the GNU Lesser General Public
8 * License as published by the Free Software Foundation; either
9 * version 2.1 of the License, or (at your option) any later version.
11 * FFmpeg is distributed in the hope that it will be useful,
12 * but WITHOUT ANY WARRANTY; without even the implied warranty of
13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
14 * Lesser General Public License for more details.
16 * You should have received a copy of the GNU Lesser General Public
17 * License along with FFmpeg; if not, write to the Free Software
18 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
21 #ifndef AVCODEC_AVCODEC_H
22 #define AVCODEC_AVCODEC_H
27 * Libavcodec external API header
31 #include "libavutil/samplefmt.h"
32 #include "libavutil/attributes.h"
33 #include "libavutil/avutil.h"
34 #include "libavutil/buffer.h"
35 #include "libavutil/cpu.h"
36 #include "libavutil/channel_layout.h"
37 #include "libavutil/dict.h"
38 #include "libavutil/frame.h"
39 #include "libavutil/hwcontext.h"
40 #include "libavutil/log.h"
41 #include "libavutil/pixfmt.h"
42 #include "libavutil/rational.h"
47 * @defgroup libavc libavcodec
48 * Encoding/Decoding Library
52 * @defgroup lavc_decoding Decoding
56 * @defgroup lavc_encoding Encoding
60 * @defgroup lavc_codec Codecs
62 * @defgroup lavc_codec_native Native Codecs
65 * @defgroup lavc_codec_wrappers External library wrappers
68 * @defgroup lavc_codec_hwaccel Hardware Accelerators bridge
72 * @defgroup lavc_internal Internal
80 * @defgroup lavc_encdec send/receive encoding and decoding API overview
83 * The avcodec_send_packet()/avcodec_receive_frame()/avcodec_send_frame()/
84 * avcodec_receive_packet() functions provide an encode/decode API, which
85 * decouples input and output.
87 * The API is very similar for encoding/decoding and audio/video, and works as
89 * - Set up and open the AVCodecContext as usual.
91 * - For decoding, call avcodec_send_packet() to give the decoder raw
92 * compressed data in an AVPacket.
93 * - For encoding, call avcodec_send_frame() to give the encoder an AVFrame
94 * containing uncompressed audio or video.
96 * In both cases, it is recommended that AVPackets and AVFrames are
97 * refcounted, or libavcodec might have to copy the input data. (libavformat
98 * always returns refcounted AVPackets, and av_frame_get_buffer() allocates
99 * refcounted AVFrames.)
100 * - Receive output in a loop. Periodically call one of the avcodec_receive_*()
101 * functions and process their output:
102 * - For decoding, call avcodec_receive_frame(). On success, it will return
103 * an AVFrame containing uncompressed audio or video data.
104 * - For encoding, call avcodec_receive_packet(). On success, it will return
105 * an AVPacket with a compressed frame.
107 * Repeat this call until it returns AVERROR(EAGAIN) or an error. The
108 * AVERROR(EAGAIN) return value means that new input data is required to
109 * return new output. In this case, continue with sending input. For each
110 * input frame/packet, the codec will typically return 1 output frame/packet,
111 * but it can also be 0 or more than 1.
113 * At the beginning of decoding or encoding, the codec might accept multiple
114 * input frames/packets without returning a frame, until its internal buffers
115 * are filled. This situation is handled transparently if you follow the steps
118 * In theory, sending input can result in EAGAIN - this should happen only if
119 * not all output was received. You can use this to structure alternative decode
120 * or encode loops other than the one suggested above. For example, you could
121 * try sending new input on each iteration, and try to receive output if that
124 * End of stream situations. These require "flushing" (aka draining) the codec,
125 * as the codec might buffer multiple frames or packets internally for
126 * performance or out of necessity (consider B-frames).
127 * This is handled as follows:
128 * - Instead of valid input, send NULL to the avcodec_send_packet() (decoding)
129 * or avcodec_send_frame() (encoding) functions. This will enter draining
131 * - Call avcodec_receive_frame() (decoding) or avcodec_receive_packet()
132 * (encoding) in a loop until AVERROR_EOF is returned. The functions will
133 * not return AVERROR(EAGAIN), unless you forgot to enter draining mode.
134 * - Before decoding can be resumed again, the codec has to be reset with
135 * avcodec_flush_buffers().
137 * Using the API as outlined above is highly recommended. But it is also
138 * possible to call functions outside of this rigid schema. For example, you can
139 * call avcodec_send_packet() repeatedly without calling
140 * avcodec_receive_frame(). In this case, avcodec_send_packet() will succeed
141 * until the codec's internal buffer has been filled up (which is typically of
142 * size 1 per output frame, after initial input), and then reject input with
143 * AVERROR(EAGAIN). Once it starts rejecting input, you have no choice but to
144 * read at least some output.
146 * Not all codecs will follow a rigid and predictable dataflow; the only
147 * guarantee is that an AVERROR(EAGAIN) return value on a send/receive call on
148 * one end implies that a receive/send call on the other end will succeed, or
149 * at least will not fail with AVERROR(EAGAIN). In general, no codec will
150 * permit unlimited buffering of input or output.
152 * This API replaces the following legacy functions:
153 * - avcodec_decode_video2() and avcodec_decode_audio4():
154 * Use avcodec_send_packet() to feed input to the decoder, then use
155 * avcodec_receive_frame() to receive decoded frames after each packet.
156 * Unlike with the old video decoding API, multiple frames might result from
157 * a packet. For audio, splitting the input packet into frames by partially
158 * decoding packets becomes transparent to the API user. You never need to
159 * feed an AVPacket to the API twice (unless it is rejected with AVERROR(EAGAIN) - then
160 * no data was read from the packet).
161 * Additionally, sending a flush/draining packet is required only once.
162 * - avcodec_encode_video2()/avcodec_encode_audio2():
163 * Use avcodec_send_frame() to feed input to the encoder, then use
164 * avcodec_receive_packet() to receive encoded packets.
165 * Providing user-allocated buffers for avcodec_receive_packet() is not
167 * - The new API does not handle subtitles yet.
169 * Mixing new and old function calls on the same AVCodecContext is not allowed,
170 * and will result in undefined behavior.
172 * Some codecs might require using the new API; using the old API will return
173 * an error when calling it. All codecs support the new API.
175 * A codec is not allowed to return AVERROR(EAGAIN) for both sending and receiving. This
176 * would be an invalid state, which could put the codec user into an endless
177 * loop. The API has no concept of time either: it cannot happen that trying to
178 * do avcodec_send_packet() results in AVERROR(EAGAIN), but a repeated call 1 second
179 * later accepts the packet (with no other receive/flush API calls involved).
180 * The API is a strict state machine, and the passage of time is not supposed
181 * to influence it. Some timing-dependent behavior might still be deemed
182 * acceptable in certain cases. But it must never result in both send/receive
183 * returning EAGAIN at the same time at any point. It must also absolutely be
184 * avoided that the current state is "unstable" and can "flip-flop" between
185 * the send/receive APIs allowing progress. For example, it's not allowed that
186 * the codec randomly decides that it actually wants to consume a packet now
187 * instead of returning a frame, after it just returned AVERROR(EAGAIN) on an
188 * avcodec_send_packet() call.
193 * @defgroup lavc_core Core functions/structures.
196 * Basic definitions, functions for querying libavcodec capabilities,
197 * allocating core structures, etc.
203 * Identify the syntax and semantics of the bitstream.
204 * The principle is roughly:
205 * Two decoders with the same ID can decode the same streams.
206 * Two encoders with the same ID can encode compatible streams.
207 * There may be slight deviations from the principle due to implementation
210 * If you add a codec ID to this list, add it so that
211 * 1. no value of an existing codec ID changes (that would break ABI),
212 * 2. it is as close as possible to similar codecs
214 * After adding new codec IDs, do not forget to add an entry to the codec
215 * descriptor list and bump libavcodec minor version.
221 AV_CODEC_ID_MPEG1VIDEO,
222 AV_CODEC_ID_MPEG2VIDEO, ///< preferred ID for MPEG-1/2 video decoding
233 AV_CODEC_ID_RAWVIDEO,
234 AV_CODEC_ID_MSMPEG4V1,
235 AV_CODEC_ID_MSMPEG4V2,
236 AV_CODEC_ID_MSMPEG4V3,
259 AV_CODEC_ID_INTERPLAY_VIDEO,
266 AV_CODEC_ID_MSVIDEO1,
271 AV_CODEC_ID_TRUEMOTION1,
272 AV_CODEC_ID_VMDVIDEO,
297 AV_CODEC_ID_TRUEMOTION2,
303 AV_CODEC_ID_SMACKVIDEO,
308 AV_CODEC_ID_JPEG2000,
314 AV_CODEC_ID_DSICINVIDEO,
315 AV_CODEC_ID_TIERTEXSEQVIDEO,
323 AV_CODEC_ID_BETHSOFTVID,
335 AV_CODEC_ID_ESCAPE124,
339 AV_CODEC_ID_MOTIONPIXELS,
351 AV_CODEC_ID_FLASHSV2,
352 AV_CODEC_ID_CDGRAPHICS,
355 AV_CODEC_ID_BINKVIDEO,
356 AV_CODEC_ID_IFF_ILBM,
357 #define AV_CODEC_ID_IFF_BYTERUN1 AV_CODEC_ID_IFF_ILBM
363 AV_CODEC_ID_A64_MULTI,
364 AV_CODEC_ID_A64_MULTI5,
367 AV_CODEC_ID_LAGARITH,
371 AV_CODEC_ID_WMV3IMAGE,
372 AV_CODEC_ID_VC1IMAGE,
374 AV_CODEC_ID_BMV_VIDEO,
381 AV_CODEC_ID_ZEROCODEC,
390 AV_CODEC_ID_ESCAPE130,
393 AV_CODEC_ID_HNM4_VIDEO,
395 #define AV_CODEC_ID_H265 AV_CODEC_ID_HEVC
397 AV_CODEC_ID_ALIAS_PIX,
398 AV_CODEC_ID_BRENDER_PIX,
399 AV_CODEC_ID_PAF_VIDEO,
412 AV_CODEC_ID_SCREENPRESSO,
416 AV_CODEC_ID_Y41P = 0x8000,
421 AV_CODEC_ID_TARGA_Y216,
433 AV_CODEC_ID_TRUEMOTION2RT,
435 AV_CODEC_ID_MAGICYUV,
436 AV_CODEC_ID_SHEERVIDEO,
443 AV_CODEC_ID_CLEARVIDEO,
446 AV_CODEC_ID_BITPACKED,
453 AV_CODEC_ID_PROSUMER,
467 /* various PCM "codecs" */
468 AV_CODEC_ID_FIRST_AUDIO = 0x10000, ///< A dummy id pointing at the start of audio codecs
469 AV_CODEC_ID_PCM_S16LE = 0x10000,
470 AV_CODEC_ID_PCM_S16BE,
471 AV_CODEC_ID_PCM_U16LE,
472 AV_CODEC_ID_PCM_U16BE,
475 AV_CODEC_ID_PCM_MULAW,
476 AV_CODEC_ID_PCM_ALAW,
477 AV_CODEC_ID_PCM_S32LE,
478 AV_CODEC_ID_PCM_S32BE,
479 AV_CODEC_ID_PCM_U32LE,
480 AV_CODEC_ID_PCM_U32BE,
481 AV_CODEC_ID_PCM_S24LE,
482 AV_CODEC_ID_PCM_S24BE,
483 AV_CODEC_ID_PCM_U24LE,
484 AV_CODEC_ID_PCM_U24BE,
485 AV_CODEC_ID_PCM_S24DAUD,
486 AV_CODEC_ID_PCM_ZORK,
487 AV_CODEC_ID_PCM_S16LE_PLANAR,
489 AV_CODEC_ID_PCM_F32BE,
490 AV_CODEC_ID_PCM_F32LE,
491 AV_CODEC_ID_PCM_F64BE,
492 AV_CODEC_ID_PCM_F64LE,
493 AV_CODEC_ID_PCM_BLURAY,
496 AV_CODEC_ID_PCM_S8_PLANAR,
497 AV_CODEC_ID_PCM_S24LE_PLANAR,
498 AV_CODEC_ID_PCM_S32LE_PLANAR,
499 AV_CODEC_ID_PCM_S16BE_PLANAR,
501 AV_CODEC_ID_PCM_S64LE = 0x10800,
502 AV_CODEC_ID_PCM_S64BE,
503 AV_CODEC_ID_PCM_F16LE,
504 AV_CODEC_ID_PCM_F24LE,
505 AV_CODEC_ID_PCM_VIDC,
507 /* various ADPCM codecs */
508 AV_CODEC_ID_ADPCM_IMA_QT = 0x11000,
509 AV_CODEC_ID_ADPCM_IMA_WAV,
510 AV_CODEC_ID_ADPCM_IMA_DK3,
511 AV_CODEC_ID_ADPCM_IMA_DK4,
512 AV_CODEC_ID_ADPCM_IMA_WS,
513 AV_CODEC_ID_ADPCM_IMA_SMJPEG,
514 AV_CODEC_ID_ADPCM_MS,
515 AV_CODEC_ID_ADPCM_4XM,
516 AV_CODEC_ID_ADPCM_XA,
517 AV_CODEC_ID_ADPCM_ADX,
518 AV_CODEC_ID_ADPCM_EA,
519 AV_CODEC_ID_ADPCM_G726,
520 AV_CODEC_ID_ADPCM_CT,
521 AV_CODEC_ID_ADPCM_SWF,
522 AV_CODEC_ID_ADPCM_YAMAHA,
523 AV_CODEC_ID_ADPCM_SBPRO_4,
524 AV_CODEC_ID_ADPCM_SBPRO_3,
525 AV_CODEC_ID_ADPCM_SBPRO_2,
526 AV_CODEC_ID_ADPCM_THP,
527 AV_CODEC_ID_ADPCM_IMA_AMV,
528 AV_CODEC_ID_ADPCM_EA_R1,
529 AV_CODEC_ID_ADPCM_EA_R3,
530 AV_CODEC_ID_ADPCM_EA_R2,
531 AV_CODEC_ID_ADPCM_IMA_EA_SEAD,
532 AV_CODEC_ID_ADPCM_IMA_EA_EACS,
533 AV_CODEC_ID_ADPCM_EA_XAS,
534 AV_CODEC_ID_ADPCM_EA_MAXIS_XA,
535 AV_CODEC_ID_ADPCM_IMA_ISS,
536 AV_CODEC_ID_ADPCM_G722,
537 AV_CODEC_ID_ADPCM_IMA_APC,
538 AV_CODEC_ID_ADPCM_VIMA,
540 AV_CODEC_ID_ADPCM_AFC = 0x11800,
541 AV_CODEC_ID_ADPCM_IMA_OKI,
542 AV_CODEC_ID_ADPCM_DTK,
543 AV_CODEC_ID_ADPCM_IMA_RAD,
544 AV_CODEC_ID_ADPCM_G726LE,
545 AV_CODEC_ID_ADPCM_THP_LE,
546 AV_CODEC_ID_ADPCM_PSX,
547 AV_CODEC_ID_ADPCM_AICA,
548 AV_CODEC_ID_ADPCM_IMA_DAT4,
549 AV_CODEC_ID_ADPCM_MTAF,
550 AV_CODEC_ID_ADPCM_AGM,
551 AV_CODEC_ID_ADPCM_ARGO,
552 AV_CODEC_ID_ADPCM_IMA_SSI,
553 AV_CODEC_ID_ADPCM_ZORK,
554 AV_CODEC_ID_ADPCM_IMA_APM,
557 AV_CODEC_ID_AMR_NB = 0x12000,
560 /* RealAudio codecs*/
561 AV_CODEC_ID_RA_144 = 0x13000,
564 /* various DPCM codecs */
565 AV_CODEC_ID_ROQ_DPCM = 0x14000,
566 AV_CODEC_ID_INTERPLAY_DPCM,
567 AV_CODEC_ID_XAN_DPCM,
568 AV_CODEC_ID_SOL_DPCM,
570 AV_CODEC_ID_SDX2_DPCM = 0x14800,
571 AV_CODEC_ID_GREMLIN_DPCM,
574 AV_CODEC_ID_MP2 = 0x15000,
575 AV_CODEC_ID_MP3, ///< preferred ID for decoding MPEG audio layer 1, 2 or 3
585 AV_CODEC_ID_VMDAUDIO,
591 AV_CODEC_ID_WESTWOOD_SND1,
592 AV_CODEC_ID_GSM, ///< as in Berlin toast format
595 AV_CODEC_ID_TRUESPEECH,
597 AV_CODEC_ID_SMACKAUDIO,
600 AV_CODEC_ID_DSICINAUDIO,
602 AV_CODEC_ID_MUSEPACK7,
604 AV_CODEC_ID_GSM_MS, /* as found in WAV */
607 AV_CODEC_ID_NELLYMOSER,
608 AV_CODEC_ID_MUSEPACK8,
610 AV_CODEC_ID_WMAVOICE,
612 AV_CODEC_ID_WMALOSSLESS,
621 AV_CODEC_ID_BINKAUDIO_RDFT,
622 AV_CODEC_ID_BINKAUDIO_DCT,
623 AV_CODEC_ID_AAC_LATM,
628 AV_CODEC_ID_8SVX_EXP,
629 AV_CODEC_ID_8SVX_FIB,
630 AV_CODEC_ID_BMV_AUDIO,
635 AV_CODEC_ID_COMFORT_NOISE,
637 AV_CODEC_ID_METASOUND,
638 AV_CODEC_ID_PAF_AUDIO,
643 AV_CODEC_ID_FFWAVESYNTH = 0x15800,
645 AV_CODEC_ID_SONIC_LS,
648 AV_CODEC_ID_DSD_LSBF,
649 AV_CODEC_ID_DSD_MSBF,
650 AV_CODEC_ID_DSD_LSBF_PLANAR,
651 AV_CODEC_ID_DSD_MSBF_PLANAR,
653 AV_CODEC_ID_INTERPLAY_ACM,
657 AV_CODEC_ID_ATRAC3AL,
658 AV_CODEC_ID_ATRAC3PAL,
665 AV_CODEC_ID_ACELP_KELVIN,
666 AV_CODEC_ID_MPEGH_3D_AUDIO,
669 /* subtitle codecs */
670 AV_CODEC_ID_FIRST_SUBTITLE = 0x17000, ///< A dummy ID pointing at the start of subtitle codecs.
671 AV_CODEC_ID_DVD_SUBTITLE = 0x17000,
672 AV_CODEC_ID_DVB_SUBTITLE,
673 AV_CODEC_ID_TEXT, ///< raw UTF-8 text
676 AV_CODEC_ID_MOV_TEXT,
677 AV_CODEC_ID_HDMV_PGS_SUBTITLE,
678 AV_CODEC_ID_DVB_TELETEXT,
681 AV_CODEC_ID_MICRODVD = 0x17800,
685 AV_CODEC_ID_REALTEXT,
687 AV_CODEC_ID_SUBVIEWER1,
688 AV_CODEC_ID_SUBVIEWER,
695 AV_CODEC_ID_HDMV_TEXT_SUBTITLE,
697 AV_CODEC_ID_ARIB_CAPTION,
699 /* other specific kind of codecs (generally used for attachments) */
700 AV_CODEC_ID_FIRST_UNKNOWN = 0x18000, ///< A dummy ID pointing at the start of various fake codecs.
701 AV_CODEC_ID_TTF = 0x18000,
703 AV_CODEC_ID_SCTE_35, ///< Contain timestamp estimated through PCR of program stream.
705 AV_CODEC_ID_BINTEXT = 0x18800,
709 AV_CODEC_ID_SMPTE_KLV,
711 AV_CODEC_ID_TIMED_ID3,
712 AV_CODEC_ID_BIN_DATA,
715 AV_CODEC_ID_PROBE = 0x19000, ///< codec_id is not known (like AV_CODEC_ID_NONE) but lavf should attempt to identify it
717 AV_CODEC_ID_MPEG2TS = 0x20000, /**< _FAKE_ codec to indicate a raw MPEG-2 TS
718 * stream (only used by libavformat) */
719 AV_CODEC_ID_MPEG4SYSTEMS = 0x20001, /**< _FAKE_ codec to indicate a MPEG-4 Systems
720 * stream (only used by libavformat) */
721 AV_CODEC_ID_FFMETADATA = 0x21000, ///< Dummy codec for streams containing only metadata information.
722 AV_CODEC_ID_WRAPPED_AVFRAME = 0x21001, ///< Passthrough codec, AVFrames wrapped in AVPacket
726 * This struct describes the properties of a single codec described by an
728 * @see avcodec_descriptor_get()
730 typedef struct AVCodecDescriptor {
732 enum AVMediaType type;
734 * Name of the codec described by this descriptor. It is non-empty and
735 * unique for each codec descriptor. It should contain alphanumeric
736 * characters and '_' only.
740 * A more descriptive name for this codec. May be NULL.
742 const char *long_name;
744 * Codec properties, a combination of AV_CODEC_PROP_* flags.
748 * MIME type(s) associated with the codec.
749 * May be NULL; if not, a NULL-terminated array of MIME types.
750 * The first item is always non-NULL and is the preferred MIME type.
752 const char *const *mime_types;
754 * If non-NULL, an array of profiles recognized for this codec.
755 * Terminated with FF_PROFILE_UNKNOWN.
757 const struct AVProfile *profiles;
761 * Codec uses only intra compression.
762 * Video and audio codecs only.
764 #define AV_CODEC_PROP_INTRA_ONLY (1 << 0)
766 * Codec supports lossy compression. Audio and video codecs only.
767 * @note a codec may support both lossy and lossless
770 #define AV_CODEC_PROP_LOSSY (1 << 1)
772 * Codec supports lossless compression. Audio and video codecs only.
774 #define AV_CODEC_PROP_LOSSLESS (1 << 2)
776 * Codec supports frame reordering. That is, the coded order (the order in which
777 * the encoded packets are output by the encoders / stored / input to the
778 * decoders) may be different from the presentation order of the corresponding
781 * For codecs that do not have this property set, PTS and DTS should always be
784 #define AV_CODEC_PROP_REORDER (1 << 3)
786 * Subtitle codec is bitmap based
787 * Decoded AVSubtitle data can be read from the AVSubtitleRect->pict field.
789 #define AV_CODEC_PROP_BITMAP_SUB (1 << 16)
791 * Subtitle codec is text based.
792 * Decoded AVSubtitle data can be read from the AVSubtitleRect->ass field.
794 #define AV_CODEC_PROP_TEXT_SUB (1 << 17)
797 * @ingroup lavc_decoding
798 * Required number of additionally allocated bytes at the end of the input bitstream for decoding.
799 * This is mainly needed because some optimized bitstream readers read
800 * 32 or 64 bit at once and could read over the end.<br>
801 * Note: If the first 23 bits of the additional bytes are not 0, then damaged
802 * MPEG bitstreams could cause overread and segfault.
804 #define AV_INPUT_BUFFER_PADDING_SIZE 64
807 * @ingroup lavc_encoding
808 * minimum encoding buffer size
809 * Used to avoid some checks during header writing.
811 #define AV_INPUT_BUFFER_MIN_SIZE 16384
814 * @ingroup lavc_decoding
817 /* We leave some space between them for extensions (drop some
818 * keyframes for intra-only or drop just some bidir frames). */
819 AVDISCARD_NONE =-16, ///< discard nothing
820 AVDISCARD_DEFAULT = 0, ///< discard useless packets like 0 size packets in avi
821 AVDISCARD_NONREF = 8, ///< discard all non reference
822 AVDISCARD_BIDIR = 16, ///< discard all bidirectional frames
823 AVDISCARD_NONINTRA= 24, ///< discard all non intra frames
824 AVDISCARD_NONKEY = 32, ///< discard all frames except keyframes
825 AVDISCARD_ALL = 48, ///< discard all
828 enum AVAudioServiceType {
829 AV_AUDIO_SERVICE_TYPE_MAIN = 0,
830 AV_AUDIO_SERVICE_TYPE_EFFECTS = 1,
831 AV_AUDIO_SERVICE_TYPE_VISUALLY_IMPAIRED = 2,
832 AV_AUDIO_SERVICE_TYPE_HEARING_IMPAIRED = 3,
833 AV_AUDIO_SERVICE_TYPE_DIALOGUE = 4,
834 AV_AUDIO_SERVICE_TYPE_COMMENTARY = 5,
835 AV_AUDIO_SERVICE_TYPE_EMERGENCY = 6,
836 AV_AUDIO_SERVICE_TYPE_VOICE_OVER = 7,
837 AV_AUDIO_SERVICE_TYPE_KARAOKE = 8,
838 AV_AUDIO_SERVICE_TYPE_NB , ///< Not part of ABI
842 * @ingroup lavc_encoding
844 typedef struct RcOverride{
847 int qscale; // If this is 0 then quality_factor will be used instead.
848 float quality_factor;
852 These flags can be passed in AVCodecContext.flags before initialization.
853 Note: Not everything is supported yet.
857 * Allow decoders to produce frames with data planes that are not aligned
858 * to CPU requirements (e.g. due to cropping).
860 #define AV_CODEC_FLAG_UNALIGNED (1 << 0)
864 #define AV_CODEC_FLAG_QSCALE (1 << 1)
866 * 4 MV per MB allowed / advanced prediction for H.263.
868 #define AV_CODEC_FLAG_4MV (1 << 2)
870 * Output even those frames that might be corrupted.
872 #define AV_CODEC_FLAG_OUTPUT_CORRUPT (1 << 3)
876 #define AV_CODEC_FLAG_QPEL (1 << 4)
878 * Don't output frames whose parameters differ from first
879 * decoded frame in stream.
881 #define AV_CODEC_FLAG_DROPCHANGED (1 << 5)
883 * Use internal 2pass ratecontrol in first pass mode.
885 #define AV_CODEC_FLAG_PASS1 (1 << 9)
887 * Use internal 2pass ratecontrol in second pass mode.
889 #define AV_CODEC_FLAG_PASS2 (1 << 10)
893 #define AV_CODEC_FLAG_LOOP_FILTER (1 << 11)
895 * Only decode/encode grayscale.
897 #define AV_CODEC_FLAG_GRAY (1 << 13)
899 * error[?] variables will be set during encoding.
901 #define AV_CODEC_FLAG_PSNR (1 << 15)
903 * Input bitstream might be truncated at a random location
904 * instead of only at frame boundaries.
906 #define AV_CODEC_FLAG_TRUNCATED (1 << 16)
908 * Use interlaced DCT.
910 #define AV_CODEC_FLAG_INTERLACED_DCT (1 << 18)
914 #define AV_CODEC_FLAG_LOW_DELAY (1 << 19)
916 * Place global headers in extradata instead of every keyframe.
918 #define AV_CODEC_FLAG_GLOBAL_HEADER (1 << 22)
920 * Use only bitexact stuff (except (I)DCT).
922 #define AV_CODEC_FLAG_BITEXACT (1 << 23)
923 /* Fx : Flag for H.263+ extra options */
925 * H.263 advanced intra coding / MPEG-4 AC prediction
927 #define AV_CODEC_FLAG_AC_PRED (1 << 24)
929 * interlaced motion estimation
931 #define AV_CODEC_FLAG_INTERLACED_ME (1 << 29)
932 #define AV_CODEC_FLAG_CLOSED_GOP (1U << 31)
935 * Allow non spec compliant speedup tricks.
937 #define AV_CODEC_FLAG2_FAST (1 << 0)
939 * Skip bitstream encoding.
941 #define AV_CODEC_FLAG2_NO_OUTPUT (1 << 2)
943 * Place global headers at every keyframe instead of in extradata.
945 #define AV_CODEC_FLAG2_LOCAL_HEADER (1 << 3)
948 * timecode is in drop frame format. DEPRECATED!!!!
950 #define AV_CODEC_FLAG2_DROP_FRAME_TIMECODE (1 << 13)
953 * Input bitstream might be truncated at a packet boundaries
954 * instead of only at frame boundaries.
956 #define AV_CODEC_FLAG2_CHUNKS (1 << 15)
958 * Discard cropping information from SPS.
960 #define AV_CODEC_FLAG2_IGNORE_CROP (1 << 16)
963 * Show all frames before the first keyframe
965 #define AV_CODEC_FLAG2_SHOW_ALL (1 << 22)
967 * Export motion vectors through frame side data
969 #define AV_CODEC_FLAG2_EXPORT_MVS (1 << 28)
971 * Do not skip samples and export skip information as frame side data
973 #define AV_CODEC_FLAG2_SKIP_MANUAL (1 << 29)
975 * Do not reset ASS ReadOrder field on flush (subtitles decoding)
977 #define AV_CODEC_FLAG2_RO_FLUSH_NOOP (1 << 30)
979 /* Unsupported options :
980 * Syntax Arithmetic coding (SAC)
981 * Reference Picture Selection
982 * Independent Segment Decoding */
984 /* codec capabilities */
987 * Decoder can use draw_horiz_band callback.
989 #define AV_CODEC_CAP_DRAW_HORIZ_BAND (1 << 0)
991 * Codec uses get_buffer() for allocating buffers and supports custom allocators.
992 * If not set, it might not use get_buffer() at all or use operations that
993 * assume the buffer was allocated by avcodec_default_get_buffer.
995 #define AV_CODEC_CAP_DR1 (1 << 1)
996 #define AV_CODEC_CAP_TRUNCATED (1 << 3)
998 * Encoder or decoder requires flushing with NULL input at the end in order to
999 * give the complete and correct output.
1001 * NOTE: If this flag is not set, the codec is guaranteed to never be fed with
1002 * with NULL data. The user can still send NULL data to the public encode
1003 * or decode function, but libavcodec will not pass it along to the codec
1004 * unless this flag is set.
1007 * The decoder has a non-zero delay and needs to be fed with avpkt->data=NULL,
1008 * avpkt->size=0 at the end to get the delayed data until the decoder no longer
1012 * The encoder needs to be fed with NULL data at the end of encoding until the
1013 * encoder no longer returns data.
1015 * NOTE: For encoders implementing the AVCodec.encode2() function, setting this
1016 * flag also means that the encoder must set the pts and duration for
1017 * each output packet. If this flag is not set, the pts and duration will
1018 * be determined by libavcodec from the input frame.
1020 #define AV_CODEC_CAP_DELAY (1 << 5)
1022 * Codec can be fed a final frame with a smaller size.
1023 * This can be used to prevent truncation of the last audio samples.
1025 #define AV_CODEC_CAP_SMALL_LAST_FRAME (1 << 6)
1028 * Codec can output multiple frames per AVPacket
1029 * Normally demuxers return one frame at a time, demuxers which do not do
1030 * are connected to a parser to split what they return into proper frames.
1031 * This flag is reserved to the very rare category of codecs which have a
1032 * bitstream that cannot be split into frames without timeconsuming
1033 * operations like full decoding. Demuxers carrying such bitstreams thus
1034 * may return multiple frames in a packet. This has many disadvantages like
1035 * prohibiting stream copy in many cases thus it should only be considered
1038 #define AV_CODEC_CAP_SUBFRAMES (1 << 8)
1040 * Codec is experimental and is thus avoided in favor of non experimental
1043 #define AV_CODEC_CAP_EXPERIMENTAL (1 << 9)
1045 * Codec should fill in channel configuration and samplerate instead of container
1047 #define AV_CODEC_CAP_CHANNEL_CONF (1 << 10)
1049 * Codec supports frame-level multithreading.
1051 #define AV_CODEC_CAP_FRAME_THREADS (1 << 12)
1053 * Codec supports slice-based (or partition-based) multithreading.
1055 #define AV_CODEC_CAP_SLICE_THREADS (1 << 13)
1057 * Codec supports changed parameters at any point.
1059 #define AV_CODEC_CAP_PARAM_CHANGE (1 << 14)
1061 * Codec supports avctx->thread_count == 0 (auto).
1063 #define AV_CODEC_CAP_AUTO_THREADS (1 << 15)
1065 * Audio encoder supports receiving a different number of samples in each call.
1067 #define AV_CODEC_CAP_VARIABLE_FRAME_SIZE (1 << 16)
1069 * Decoder is not a preferred choice for probing.
1070 * This indicates that the decoder is not a good choice for probing.
1071 * It could for example be an expensive to spin up hardware decoder,
1072 * or it could simply not provide a lot of useful information about
1074 * A decoder marked with this flag should only be used as last resort
1075 * choice for probing.
1077 #define AV_CODEC_CAP_AVOID_PROBING (1 << 17)
1079 * Codec is intra only.
1081 #define AV_CODEC_CAP_INTRA_ONLY 0x40000000
1083 * Codec is lossless.
1085 #define AV_CODEC_CAP_LOSSLESS 0x80000000
1088 * Codec is backed by a hardware implementation. Typically used to
1089 * identify a non-hwaccel hardware decoder. For information about hwaccels, use
1090 * avcodec_get_hw_config() instead.
1092 #define AV_CODEC_CAP_HARDWARE (1 << 18)
1095 * Codec is potentially backed by a hardware implementation, but not
1096 * necessarily. This is used instead of AV_CODEC_CAP_HARDWARE, if the
1097 * implementation provides some sort of internal fallback.
1099 #define AV_CODEC_CAP_HYBRID (1 << 19)
1102 * This codec takes the reordered_opaque field from input AVFrames
1103 * and returns it in the corresponding field in AVCodecContext after
1106 #define AV_CODEC_CAP_ENCODER_REORDERED_OPAQUE (1 << 20)
1108 /* Exported side data.
1109 These flags can be passed in AVCodecContext.export_side_data before initialization.
1112 * Export motion vectors through frame side data
1114 #define AV_CODEC_EXPORT_DATA_MVS (1 << 0)
1116 * Export encoder Producer Reference Time through packet side data
1118 #define AV_CODEC_EXPORT_DATA_PRFT (1 << 1)
1122 * This specifies the area which should be displayed.
1123 * Note there may be multiple such areas for one frame.
1125 typedef struct AVPanScan {
1128 * - encoding: Set by user.
1129 * - decoding: Set by libavcodec.
1134 * width and height in 1/16 pel
1135 * - encoding: Set by user.
1136 * - decoding: Set by libavcodec.
1142 * position of the top left corner in 1/16 pel for up to 3 fields/frames
1143 * - encoding: Set by user.
1144 * - decoding: Set by libavcodec.
1146 int16_t position[3][2];
1150 * This structure describes the bitrate properties of an encoded bitstream. It
1151 * roughly corresponds to a subset the VBV parameters for MPEG-2 or HRD
1152 * parameters for H.264/HEVC.
1154 typedef struct AVCPBProperties {
1156 * Maximum bitrate of the stream, in bits per second.
1157 * Zero if unknown or unspecified.
1159 #if FF_API_UNSANITIZED_BITRATES
1162 int64_t max_bitrate;
1165 * Minimum bitrate of the stream, in bits per second.
1166 * Zero if unknown or unspecified.
1168 #if FF_API_UNSANITIZED_BITRATES
1171 int64_t min_bitrate;
1174 * Average bitrate of the stream, in bits per second.
1175 * Zero if unknown or unspecified.
1177 #if FF_API_UNSANITIZED_BITRATES
1180 int64_t avg_bitrate;
1184 * The size of the buffer to which the ratecontrol is applied, in bits.
1185 * Zero if unknown or unspecified.
1190 * The delay between the time the packet this structure is associated with
1191 * is received and the time when it should be decoded, in periods of a 27MHz
1194 * UINT64_MAX when unknown or unspecified.
1200 * This structure supplies correlation between a packet timestamp and a wall clock
1201 * production time. The definition follows the Producer Reference Time ('prft')
1202 * as defined in ISO/IEC 14496-12
1204 typedef struct AVProducerReferenceTime {
1206 * A UTC timestamp, in microseconds, since Unix epoch (e.g, av_gettime()).
1210 } AVProducerReferenceTime;
1213 * The decoder will keep a reference to the frame and may reuse it later.
1215 #define AV_GET_BUFFER_FLAG_REF (1 << 0)
1218 * @defgroup lavc_packet AVPacket
1220 * Types and functions for working with AVPacket.
1223 enum AVPacketSideDataType {
1225 * An AV_PKT_DATA_PALETTE side data packet contains exactly AVPALETTE_SIZE
1226 * bytes worth of palette. This side data signals that a new palette is
1229 AV_PKT_DATA_PALETTE,
1232 * The AV_PKT_DATA_NEW_EXTRADATA is used to notify the codec or the format
1233 * that the extradata buffer was changed and the receiving side should
1234 * act upon it appropriately. The new extradata is embedded in the side
1235 * data buffer and should be immediately used for processing the current
1238 AV_PKT_DATA_NEW_EXTRADATA,
1241 * An AV_PKT_DATA_PARAM_CHANGE side data packet is laid out as follows:
1244 * if (param_flags & AV_SIDE_DATA_PARAM_CHANGE_CHANNEL_COUNT)
1245 * s32le channel_count
1246 * if (param_flags & AV_SIDE_DATA_PARAM_CHANGE_CHANNEL_LAYOUT)
1247 * u64le channel_layout
1248 * if (param_flags & AV_SIDE_DATA_PARAM_CHANGE_SAMPLE_RATE)
1250 * if (param_flags & AV_SIDE_DATA_PARAM_CHANGE_DIMENSIONS)
1255 AV_PKT_DATA_PARAM_CHANGE,
1258 * An AV_PKT_DATA_H263_MB_INFO side data packet contains a number of
1259 * structures with info about macroblocks relevant to splitting the
1260 * packet into smaller packets on macroblock edges (e.g. as for RFC 2190).
1261 * That is, it does not necessarily contain info about all macroblocks,
1262 * as long as the distance between macroblocks in the info is smaller
1263 * than the target payload size.
1264 * Each MB info structure is 12 bytes, and is laid out as follows:
1266 * u32le bit offset from the start of the packet
1267 * u8 current quantizer at the start of the macroblock
1269 * u16le macroblock address within the GOB
1270 * u8 horizontal MV predictor
1271 * u8 vertical MV predictor
1272 * u8 horizontal MV predictor for block number 3
1273 * u8 vertical MV predictor for block number 3
1276 AV_PKT_DATA_H263_MB_INFO,
1279 * This side data should be associated with an audio stream and contains
1280 * ReplayGain information in form of the AVReplayGain struct.
1282 AV_PKT_DATA_REPLAYGAIN,
1285 * This side data contains a 3x3 transformation matrix describing an affine
1286 * transformation that needs to be applied to the decoded video frames for
1287 * correct presentation.
1289 * See libavutil/display.h for a detailed description of the data.
1291 AV_PKT_DATA_DISPLAYMATRIX,
1294 * This side data should be associated with a video stream and contains
1295 * Stereoscopic 3D information in form of the AVStereo3D struct.
1297 AV_PKT_DATA_STEREO3D,
1300 * This side data should be associated with an audio stream and corresponds
1301 * to enum AVAudioServiceType.
1303 AV_PKT_DATA_AUDIO_SERVICE_TYPE,
1306 * This side data contains quality related information from the encoder.
1308 * u32le quality factor of the compressed frame. Allowed range is between 1 (good) and FF_LAMBDA_MAX (bad).
1312 * u64le[error count] sum of squared differences between encoder in and output
1315 AV_PKT_DATA_QUALITY_STATS,
1318 * This side data contains an integer value representing the stream index
1319 * of a "fallback" track. A fallback track indicates an alternate
1320 * track to use when the current track can not be decoded for some reason.
1321 * e.g. no decoder available for codec.
1323 AV_PKT_DATA_FALLBACK_TRACK,
1326 * This side data corresponds to the AVCPBProperties struct.
1328 AV_PKT_DATA_CPB_PROPERTIES,
1331 * Recommmends skipping the specified number of samples
1333 * u32le number of samples to skip from start of this packet
1334 * u32le number of samples to skip from end of this packet
1335 * u8 reason for start skip
1336 * u8 reason for end skip (0=padding silence, 1=convergence)
1339 AV_PKT_DATA_SKIP_SAMPLES,
1342 * An AV_PKT_DATA_JP_DUALMONO side data packet indicates that
1343 * the packet may contain "dual mono" audio specific to Japanese DTV
1344 * and if it is true, recommends only the selected channel to be used.
1346 * u8 selected channels (0=mail/left, 1=sub/right, 2=both)
1349 AV_PKT_DATA_JP_DUALMONO,
1352 * A list of zero terminated key/value strings. There is no end marker for
1353 * the list, so it is required to rely on the side data size to stop.
1355 AV_PKT_DATA_STRINGS_METADATA,
1358 * Subtitle event position
1366 AV_PKT_DATA_SUBTITLE_POSITION,
1369 * Data found in BlockAdditional element of matroska container. There is
1370 * no end marker for the data, so it is required to rely on the side data
1371 * size to recognize the end. 8 byte id (as found in BlockAddId) followed
1374 AV_PKT_DATA_MATROSKA_BLOCKADDITIONAL,
1377 * The optional first identifier line of a WebVTT cue.
1379 AV_PKT_DATA_WEBVTT_IDENTIFIER,
1382 * The optional settings (rendering instructions) that immediately
1383 * follow the timestamp specifier of a WebVTT cue.
1385 AV_PKT_DATA_WEBVTT_SETTINGS,
1388 * A list of zero terminated key/value strings. There is no end marker for
1389 * the list, so it is required to rely on the side data size to stop. This
1390 * side data includes updated metadata which appeared in the stream.
1392 AV_PKT_DATA_METADATA_UPDATE,
1395 * MPEGTS stream ID as uint8_t, this is required to pass the stream ID
1396 * information from the demuxer to the corresponding muxer.
1398 AV_PKT_DATA_MPEGTS_STREAM_ID,
1401 * Mastering display metadata (based on SMPTE-2086:2014). This metadata
1402 * should be associated with a video stream and contains data in the form
1403 * of the AVMasteringDisplayMetadata struct.
1405 AV_PKT_DATA_MASTERING_DISPLAY_METADATA,
1408 * This side data should be associated with a video stream and corresponds
1409 * to the AVSphericalMapping structure.
1411 AV_PKT_DATA_SPHERICAL,
1414 * Content light level (based on CTA-861.3). This metadata should be
1415 * associated with a video stream and contains data in the form of the
1416 * AVContentLightMetadata struct.
1418 AV_PKT_DATA_CONTENT_LIGHT_LEVEL,
1421 * ATSC A53 Part 4 Closed Captions. This metadata should be associated with
1422 * a video stream. A53 CC bitstream is stored as uint8_t in AVPacketSideData.data.
1423 * The number of bytes of CC data is AVPacketSideData.size.
1428 * This side data is encryption initialization data.
1429 * The format is not part of ABI, use av_encryption_init_info_* methods to
1432 AV_PKT_DATA_ENCRYPTION_INIT_INFO,
1435 * This side data contains encryption info for how to decrypt the packet.
1436 * The format is not part of ABI, use av_encryption_info_* methods to access.
1438 AV_PKT_DATA_ENCRYPTION_INFO,
1441 * Active Format Description data consisting of a single byte as specified
1442 * in ETSI TS 101 154 using AVActiveFormatDescription enum.
1447 * Producer Reference Time data corresponding to the AVProducerReferenceTime struct,
1448 * usually exported by some encoders (on demand through the prft flag set in the
1449 * AVCodecContext export_side_data field).
1454 * The number of side data types.
1455 * This is not part of the public API/ABI in the sense that it may
1456 * change when new side data types are added.
1457 * This must stay the last enum value.
1458 * If its value becomes huge, some code using it
1459 * needs to be updated as it assumes it to be smaller than other limits.
1464 #define AV_PKT_DATA_QUALITY_FACTOR AV_PKT_DATA_QUALITY_STATS //DEPRECATED
1466 typedef struct AVPacketSideData {
1469 enum AVPacketSideDataType type;
1473 * This structure stores compressed data. It is typically exported by demuxers
1474 * and then passed as input to decoders, or received as output from encoders and
1475 * then passed to muxers.
1477 * For video, it should typically contain one compressed frame. For audio it may
1478 * contain several compressed frames. Encoders are allowed to output empty
1479 * packets, with no compressed data, containing only side data
1480 * (e.g. to update some stream parameters at the end of encoding).
1482 * AVPacket is one of the few structs in FFmpeg, whose size is a part of public
1483 * ABI. Thus it may be allocated on stack and no new fields can be added to it
1484 * without libavcodec and libavformat major bump.
1486 * The semantics of data ownership depends on the buf field.
1487 * If it is set, the packet data is dynamically allocated and is
1488 * valid indefinitely until a call to av_packet_unref() reduces the
1489 * reference count to 0.
1491 * If the buf field is not set av_packet_ref() would make a copy instead
1492 * of increasing the reference count.
1494 * The side data is always allocated with av_malloc(), copied by
1495 * av_packet_ref() and freed by av_packet_unref().
1497 * @see av_packet_ref
1498 * @see av_packet_unref
1500 typedef struct AVPacket {
1502 * A reference to the reference-counted buffer where the packet data is
1504 * May be NULL, then the packet data is not reference-counted.
1508 * Presentation timestamp in AVStream->time_base units; the time at which
1509 * the decompressed packet will be presented to the user.
1510 * Can be AV_NOPTS_VALUE if it is not stored in the file.
1511 * pts MUST be larger or equal to dts as presentation cannot happen before
1512 * decompression, unless one wants to view hex dumps. Some formats misuse
1513 * the terms dts and pts/cts to mean something different. Such timestamps
1514 * must be converted to true pts/dts before they are stored in AVPacket.
1518 * Decompression timestamp in AVStream->time_base units; the time at which
1519 * the packet is decompressed.
1520 * Can be AV_NOPTS_VALUE if it is not stored in the file.
1527 * A combination of AV_PKT_FLAG values
1531 * Additional packet data that can be provided by the container.
1532 * Packet can contain several types of side information.
1534 AVPacketSideData *side_data;
1535 int side_data_elems;
1538 * Duration of this packet in AVStream->time_base units, 0 if unknown.
1539 * Equals next_pts - this_pts in presentation order.
1543 int64_t pos; ///< byte position in stream, -1 if unknown
1545 #if FF_API_CONVERGENCE_DURATION
1547 * @deprecated Same as the duration field, but as int64_t. This was required
1548 * for Matroska subtitles, whose duration values could overflow when the
1549 * duration field was still an int.
1551 attribute_deprecated
1552 int64_t convergence_duration;
1555 #define AV_PKT_FLAG_KEY 0x0001 ///< The packet contains a keyframe
1556 #define AV_PKT_FLAG_CORRUPT 0x0002 ///< The packet content is corrupted
1558 * Flag is used to discard packets which are required to maintain valid
1559 * decoder state but are not required for output and should be dropped
1562 #define AV_PKT_FLAG_DISCARD 0x0004
1564 * The packet comes from a trusted source.
1566 * Otherwise-unsafe constructs such as arbitrary pointers to data
1567 * outside the packet may be followed.
1569 #define AV_PKT_FLAG_TRUSTED 0x0008
1571 * Flag is used to indicate packets that contain frames that can
1572 * be discarded by the decoder. I.e. Non-reference frames.
1574 #define AV_PKT_FLAG_DISPOSABLE 0x0010
1577 enum AVSideDataParamChangeFlags {
1578 AV_SIDE_DATA_PARAM_CHANGE_CHANNEL_COUNT = 0x0001,
1579 AV_SIDE_DATA_PARAM_CHANGE_CHANNEL_LAYOUT = 0x0002,
1580 AV_SIDE_DATA_PARAM_CHANGE_SAMPLE_RATE = 0x0004,
1581 AV_SIDE_DATA_PARAM_CHANGE_DIMENSIONS = 0x0008,
1587 struct AVCodecInternal;
1591 AV_FIELD_PROGRESSIVE,
1592 AV_FIELD_TT, //< Top coded_first, top displayed first
1593 AV_FIELD_BB, //< Bottom coded first, bottom displayed first
1594 AV_FIELD_TB, //< Top coded first, bottom displayed first
1595 AV_FIELD_BT, //< Bottom coded first, top displayed first
1599 * main external API structure.
1600 * New fields can be added to the end with minor version bumps.
1601 * Removal, reordering and changes to existing fields require a major
1603 * You can use AVOptions (av_opt* / av_set/get*()) to access these fields from user
1605 * The name string for AVOptions options matches the associated command line
1606 * parameter name and can be found in libavcodec/options_table.h
1607 * The AVOption/command line parameter names differ in some cases from the C
1608 * structure field names for historic reasons or brevity.
1609 * sizeof(AVCodecContext) must not be used outside libav*.
1611 typedef struct AVCodecContext {
1613 * information on struct for av_log
1614 * - set by avcodec_alloc_context3
1616 const AVClass *av_class;
1617 int log_level_offset;
1619 enum AVMediaType codec_type; /* see AVMEDIA_TYPE_xxx */
1620 const struct AVCodec *codec;
1621 enum AVCodecID codec_id; /* see AV_CODEC_ID_xxx */
1624 * fourcc (LSB first, so "ABCD" -> ('D'<<24) + ('C'<<16) + ('B'<<8) + 'A').
1625 * This is used to work around some encoder bugs.
1626 * A demuxer should set this to what is stored in the field used to identify the codec.
1627 * If there are multiple such fields in a container then the demuxer should choose the one
1628 * which maximizes the information about the used codec.
1629 * If the codec tag field in a container is larger than 32 bits then the demuxer should
1630 * remap the longer ID to 32 bits with a table or other structure. Alternatively a new
1631 * extra_codec_tag + size could be added but for this a clear advantage must be demonstrated
1633 * - encoding: Set by user, if not then the default based on codec_id will be used.
1634 * - decoding: Set by user, will be converted to uppercase by libavcodec during init.
1636 unsigned int codec_tag;
1641 * Private context used for internal data.
1643 * Unlike priv_data, this is not codec-specific. It is used in general
1644 * libavcodec functions.
1646 struct AVCodecInternal *internal;
1649 * Private data of the user, can be used to carry app specific stuff.
1650 * - encoding: Set by user.
1651 * - decoding: Set by user.
1656 * the average bitrate
1657 * - encoding: Set by user; unused for constant quantizer encoding.
1658 * - decoding: Set by user, may be overwritten by libavcodec
1659 * if this info is available in the stream
1664 * number of bits the bitstream is allowed to diverge from the reference.
1665 * the reference can be CBR (for CBR pass1) or VBR (for pass2)
1666 * - encoding: Set by user; unused for constant quantizer encoding.
1667 * - decoding: unused
1669 int bit_rate_tolerance;
1672 * Global quality for codecs which cannot change it per frame.
1673 * This should be proportional to MPEG-1/2/4 qscale.
1674 * - encoding: Set by user.
1675 * - decoding: unused
1680 * - encoding: Set by user.
1681 * - decoding: unused
1683 int compression_level;
1684 #define FF_COMPRESSION_DEFAULT -1
1688 * - encoding: Set by user.
1689 * - decoding: Set by user.
1695 * - encoding: Set by user.
1696 * - decoding: Set by user.
1701 * some codecs need / can use extradata like Huffman tables.
1702 * MJPEG: Huffman tables
1703 * rv10: additional flags
1704 * MPEG-4: global headers (they can be in the bitstream or here)
1705 * The allocated memory should be AV_INPUT_BUFFER_PADDING_SIZE bytes larger
1706 * than extradata_size to avoid problems if it is read with the bitstream reader.
1707 * The bytewise contents of extradata must not depend on the architecture or CPU endianness.
1708 * Must be allocated with the av_malloc() family of functions.
1709 * - encoding: Set/allocated/freed by libavcodec.
1710 * - decoding: Set/allocated/freed by user.
1716 * This is the fundamental unit of time (in seconds) in terms
1717 * of which frame timestamps are represented. For fixed-fps content,
1718 * timebase should be 1/framerate and timestamp increments should be
1720 * This often, but not always is the inverse of the frame rate or field rate
1721 * for video. 1/time_base is not the average frame rate if the frame rate is not
1724 * Like containers, elementary streams also can store timestamps, 1/time_base
1725 * is the unit in which these timestamps are specified.
1726 * As example of such codec time base see ISO/IEC 14496-2:2001(E)
1727 * vop_time_increment_resolution and fixed_vop_rate
1728 * (fixed_vop_rate == 0 implies that it is different from the framerate)
1730 * - encoding: MUST be set by user.
1731 * - decoding: the use of this field for decoding is deprecated.
1732 * Use framerate instead.
1734 AVRational time_base;
1737 * For some codecs, the time base is closer to the field rate than the frame rate.
1738 * Most notably, H.264 and MPEG-2 specify time_base as half of frame duration
1739 * if no telecine is used ...
1741 * Set to time_base ticks per frame. Default 1, e.g., H.264/MPEG-2 set it to 2.
1743 int ticks_per_frame;
1748 * Encoding: Number of frames delay there will be from the encoder input to
1749 * the decoder output. (we assume the decoder matches the spec)
1750 * Decoding: Number of frames delay in addition to what a standard decoder
1751 * as specified in the spec would produce.
1754 * Number of frames the decoded output will be delayed relative to the
1758 * For encoding, this field is unused (see initial_padding).
1760 * For decoding, this is the number of samples the decoder needs to
1761 * output before the decoder's output is valid. When seeking, you should
1762 * start decoding this many samples prior to your desired seek point.
1764 * - encoding: Set by libavcodec.
1765 * - decoding: Set by libavcodec.
1772 * picture width / height.
1774 * @note Those fields may not match the values of the last
1775 * AVFrame output by avcodec_decode_video2 due frame
1778 * - encoding: MUST be set by user.
1779 * - decoding: May be set by the user before opening the decoder if known e.g.
1780 * from the container. Some decoders will require the dimensions
1781 * to be set by the caller. During decoding, the decoder may
1782 * overwrite those values as required while parsing the data.
1787 * Bitstream width / height, may be different from width/height e.g. when
1788 * the decoded frame is cropped before being output or lowres is enabled.
1790 * @note Those field may not match the value of the last
1791 * AVFrame output by avcodec_receive_frame() due frame
1794 * - encoding: unused
1795 * - decoding: May be set by the user before opening the decoder if known
1796 * e.g. from the container. During decoding, the decoder may
1797 * overwrite those values as required while parsing the data.
1799 int coded_width, coded_height;
1802 * the number of pictures in a group of pictures, or 0 for intra_only
1803 * - encoding: Set by user.
1804 * - decoding: unused
1809 * Pixel format, see AV_PIX_FMT_xxx.
1810 * May be set by the demuxer if known from headers.
1811 * May be overridden by the decoder if it knows better.
1813 * @note This field may not match the value of the last
1814 * AVFrame output by avcodec_receive_frame() due frame
1817 * - encoding: Set by user.
1818 * - decoding: Set by user if known, overridden by libavcodec while
1821 enum AVPixelFormat pix_fmt;
1824 * If non NULL, 'draw_horiz_band' is called by the libavcodec
1825 * decoder to draw a horizontal band. It improves cache usage. Not
1826 * all codecs can do that. You must check the codec capabilities
1828 * When multithreading is used, it may be called from multiple threads
1829 * at the same time; threads might draw different parts of the same AVFrame,
1830 * or multiple AVFrames, and there is no guarantee that slices will be drawn
1832 * The function is also used by hardware acceleration APIs.
1833 * It is called at least once during frame decoding to pass
1834 * the data needed for hardware render.
1835 * In that mode instead of pixel data, AVFrame points to
1836 * a structure specific to the acceleration API. The application
1837 * reads the structure and can change some fields to indicate progress
1839 * - encoding: unused
1840 * - decoding: Set by user.
1841 * @param height the height of the slice
1842 * @param y the y position of the slice
1843 * @param type 1->top field, 2->bottom field, 3->frame
1844 * @param offset offset into the AVFrame.data from which the slice should be read
1846 void (*draw_horiz_band)(struct AVCodecContext *s,
1847 const AVFrame *src, int offset[AV_NUM_DATA_POINTERS],
1848 int y, int type, int height);
1851 * callback to negotiate the pixelFormat
1852 * @param fmt is the list of formats which are supported by the codec,
1853 * it is terminated by -1 as 0 is a valid format, the formats are ordered by quality.
1854 * The first is always the native one.
1855 * @note The callback may be called again immediately if initialization for
1856 * the selected (hardware-accelerated) pixel format failed.
1857 * @warning Behavior is undefined if the callback returns a value not
1858 * in the fmt list of formats.
1859 * @return the chosen format
1860 * - encoding: unused
1861 * - decoding: Set by user, if not set the native format will be chosen.
1863 enum AVPixelFormat (*get_format)(struct AVCodecContext *s, const enum AVPixelFormat * fmt);
1866 * maximum number of B-frames between non-B-frames
1867 * Note: The output will be delayed by max_b_frames+1 relative to the input.
1868 * - encoding: Set by user.
1869 * - decoding: unused
1874 * qscale factor between IP and B-frames
1875 * If > 0 then the last P-frame quantizer will be used (q= lastp_q*factor+offset).
1876 * If < 0 then normal ratecontrol will be done (q= -normal_q*factor+offset).
1877 * - encoding: Set by user.
1878 * - decoding: unused
1880 float b_quant_factor;
1882 #if FF_API_PRIVATE_OPT
1883 /** @deprecated use encoder private options instead */
1884 attribute_deprecated
1885 int b_frame_strategy;
1889 * qscale offset between IP and B-frames
1890 * - encoding: Set by user.
1891 * - decoding: unused
1893 float b_quant_offset;
1896 * Size of the frame reordering buffer in the decoder.
1897 * For MPEG-2 it is 1 IPB or 0 low delay IP.
1898 * - encoding: Set by libavcodec.
1899 * - decoding: Set by libavcodec.
1903 #if FF_API_PRIVATE_OPT
1904 /** @deprecated use encoder private options instead */
1905 attribute_deprecated
1910 * qscale factor between P- and I-frames
1911 * If > 0 then the last P-frame quantizer will be used (q = lastp_q * factor + offset).
1912 * If < 0 then normal ratecontrol will be done (q= -normal_q*factor+offset).
1913 * - encoding: Set by user.
1914 * - decoding: unused
1916 float i_quant_factor;
1919 * qscale offset between P and I-frames
1920 * - encoding: Set by user.
1921 * - decoding: unused
1923 float i_quant_offset;
1926 * luminance masking (0-> disabled)
1927 * - encoding: Set by user.
1928 * - decoding: unused
1933 * temporary complexity masking (0-> disabled)
1934 * - encoding: Set by user.
1935 * - decoding: unused
1937 float temporal_cplx_masking;
1940 * spatial complexity masking (0-> disabled)
1941 * - encoding: Set by user.
1942 * - decoding: unused
1944 float spatial_cplx_masking;
1947 * p block masking (0-> disabled)
1948 * - encoding: Set by user.
1949 * - decoding: unused
1954 * darkness masking (0-> disabled)
1955 * - encoding: Set by user.
1956 * - decoding: unused
1962 * - encoding: Set by libavcodec.
1963 * - decoding: Set by user (or 0).
1967 #if FF_API_PRIVATE_OPT
1968 /** @deprecated use encoder private options instead */
1969 attribute_deprecated
1970 int prediction_method;
1971 #define FF_PRED_LEFT 0
1972 #define FF_PRED_PLANE 1
1973 #define FF_PRED_MEDIAN 2
1977 * slice offsets in the frame in bytes
1978 * - encoding: Set/allocated by libavcodec.
1979 * - decoding: Set/allocated by user (or NULL).
1984 * sample aspect ratio (0 if unknown)
1985 * That is the width of a pixel divided by the height of the pixel.
1986 * Numerator and denominator must be relatively prime and smaller than 256 for some video standards.
1987 * - encoding: Set by user.
1988 * - decoding: Set by libavcodec.
1990 AVRational sample_aspect_ratio;
1993 * motion estimation comparison function
1994 * - encoding: Set by user.
1995 * - decoding: unused
1999 * subpixel motion estimation comparison function
2000 * - encoding: Set by user.
2001 * - decoding: unused
2005 * macroblock comparison function (not supported yet)
2006 * - encoding: Set by user.
2007 * - decoding: unused
2011 * interlaced DCT comparison function
2012 * - encoding: Set by user.
2013 * - decoding: unused
2016 #define FF_CMP_SAD 0
2017 #define FF_CMP_SSE 1
2018 #define FF_CMP_SATD 2
2019 #define FF_CMP_DCT 3
2020 #define FF_CMP_PSNR 4
2021 #define FF_CMP_BIT 5
2023 #define FF_CMP_ZERO 7
2024 #define FF_CMP_VSAD 8
2025 #define FF_CMP_VSSE 9
2026 #define FF_CMP_NSSE 10
2027 #define FF_CMP_W53 11
2028 #define FF_CMP_W97 12
2029 #define FF_CMP_DCTMAX 13
2030 #define FF_CMP_DCT264 14
2031 #define FF_CMP_MEDIAN_SAD 15
2032 #define FF_CMP_CHROMA 256
2035 * ME diamond size & shape
2036 * - encoding: Set by user.
2037 * - decoding: unused
2042 * amount of previous MV predictors (2a+1 x 2a+1 square)
2043 * - encoding: Set by user.
2044 * - decoding: unused
2046 int last_predictor_count;
2048 #if FF_API_PRIVATE_OPT
2049 /** @deprecated use encoder private options instead */
2050 attribute_deprecated
2055 * motion estimation prepass comparison function
2056 * - encoding: Set by user.
2057 * - decoding: unused
2062 * ME prepass diamond size & shape
2063 * - encoding: Set by user.
2064 * - decoding: unused
2070 * - encoding: Set by user.
2071 * - decoding: unused
2073 int me_subpel_quality;
2076 * maximum motion estimation search range in subpel units
2077 * If 0 then no limit.
2079 * - encoding: Set by user.
2080 * - decoding: unused
2086 * - encoding: unused
2087 * - decoding: Set by user.
2090 #define SLICE_FLAG_CODED_ORDER 0x0001 ///< draw_horiz_band() is called in coded order instead of display
2091 #define SLICE_FLAG_ALLOW_FIELD 0x0002 ///< allow draw_horiz_band() with field slices (MPEG-2 field pics)
2092 #define SLICE_FLAG_ALLOW_PLANE 0x0004 ///< allow draw_horiz_band() with 1 component at a time (SVQ1)
2095 * macroblock decision mode
2096 * - encoding: Set by user.
2097 * - decoding: unused
2100 #define FF_MB_DECISION_SIMPLE 0 ///< uses mb_cmp
2101 #define FF_MB_DECISION_BITS 1 ///< chooses the one which needs the fewest bits
2102 #define FF_MB_DECISION_RD 2 ///< rate distortion
2105 * custom intra quantization matrix
2106 * Must be allocated with the av_malloc() family of functions, and will be freed in
2107 * avcodec_free_context().
2108 * - encoding: Set/allocated by user, freed by libavcodec. Can be NULL.
2109 * - decoding: Set/allocated/freed by libavcodec.
2111 uint16_t *intra_matrix;
2114 * custom inter quantization matrix
2115 * Must be allocated with the av_malloc() family of functions, and will be freed in
2116 * avcodec_free_context().
2117 * - encoding: Set/allocated by user, freed by libavcodec. Can be NULL.
2118 * - decoding: Set/allocated/freed by libavcodec.
2120 uint16_t *inter_matrix;
2122 #if FF_API_PRIVATE_OPT
2123 /** @deprecated use encoder private options instead */
2124 attribute_deprecated
2125 int scenechange_threshold;
2127 /** @deprecated use encoder private options instead */
2128 attribute_deprecated
2129 int noise_reduction;
2133 * precision of the intra DC coefficient - 8
2134 * - encoding: Set by user.
2135 * - decoding: Set by libavcodec
2137 int intra_dc_precision;
2140 * Number of macroblock rows at the top which are skipped.
2141 * - encoding: unused
2142 * - decoding: Set by user.
2147 * Number of macroblock rows at the bottom which are skipped.
2148 * - encoding: unused
2149 * - decoding: Set by user.
2154 * minimum MB Lagrange multiplier
2155 * - encoding: Set by user.
2156 * - decoding: unused
2161 * maximum MB Lagrange multiplier
2162 * - encoding: Set by user.
2163 * - decoding: unused
2167 #if FF_API_PRIVATE_OPT
2169 * @deprecated use encoder private options instead
2171 attribute_deprecated
2172 int me_penalty_compensation;
2176 * - encoding: Set by user.
2177 * - decoding: unused
2181 #if FF_API_PRIVATE_OPT
2182 /** @deprecated use encoder private options instead */
2183 attribute_deprecated
2189 * - encoding: Set by user.
2190 * - decoding: unused
2195 * number of reference frames
2196 * - encoding: Set by user.
2197 * - decoding: Set by lavc.
2201 #if FF_API_PRIVATE_OPT
2202 /** @deprecated use encoder private options instead */
2203 attribute_deprecated
2208 * Note: Value depends upon the compare function used for fullpel ME.
2209 * - encoding: Set by user.
2210 * - decoding: unused
2214 #if FF_API_PRIVATE_OPT
2215 /** @deprecated use encoder private options instead */
2216 attribute_deprecated
2221 * Chromaticity coordinates of the source primaries.
2222 * - encoding: Set by user
2223 * - decoding: Set by libavcodec
2225 enum AVColorPrimaries color_primaries;
2228 * Color Transfer Characteristic.
2229 * - encoding: Set by user
2230 * - decoding: Set by libavcodec
2232 enum AVColorTransferCharacteristic color_trc;
2235 * YUV colorspace type.
2236 * - encoding: Set by user
2237 * - decoding: Set by libavcodec
2239 enum AVColorSpace colorspace;
2242 * MPEG vs JPEG YUV range.
2243 * - encoding: Set by user
2244 * - decoding: Set by libavcodec
2246 enum AVColorRange color_range;
2249 * This defines the location of chroma samples.
2250 * - encoding: Set by user
2251 * - decoding: Set by libavcodec
2253 enum AVChromaLocation chroma_sample_location;
2257 * Indicates number of picture subdivisions. Used for parallelized
2259 * - encoding: Set by user
2260 * - decoding: unused
2265 * - encoding: set by libavcodec
2266 * - decoding: Set by user.
2268 enum AVFieldOrder field_order;
2271 int sample_rate; ///< samples per second
2272 int channels; ///< number of audio channels
2275 * audio sample format
2276 * - encoding: Set by user.
2277 * - decoding: Set by libavcodec.
2279 enum AVSampleFormat sample_fmt; ///< sample format
2281 /* The following data should not be initialized. */
2283 * Number of samples per channel in an audio frame.
2285 * - encoding: set by libavcodec in avcodec_open2(). Each submitted frame
2286 * except the last must contain exactly frame_size samples per channel.
2287 * May be 0 when the codec has AV_CODEC_CAP_VARIABLE_FRAME_SIZE set, then the
2288 * frame size is not restricted.
2289 * - decoding: may be set by some decoders to indicate constant frame size
2294 * Frame counter, set by libavcodec.
2296 * - decoding: total number of frames returned from the decoder so far.
2297 * - encoding: total number of frames passed to the encoder so far.
2299 * @note the counter is not incremented if encoding/decoding resulted in
2305 * number of bytes per packet if constant and known or 0
2306 * Used by some WAV based audio codecs.
2311 * Audio cutoff bandwidth (0 means "automatic")
2312 * - encoding: Set by user.
2313 * - decoding: unused
2318 * Audio channel layout.
2319 * - encoding: set by user.
2320 * - decoding: set by user, may be overwritten by libavcodec.
2322 uint64_t channel_layout;
2325 * Request decoder to use this channel layout if it can (0 for default)
2326 * - encoding: unused
2327 * - decoding: Set by user.
2329 uint64_t request_channel_layout;
2332 * Type of service that the audio stream conveys.
2333 * - encoding: Set by user.
2334 * - decoding: Set by libavcodec.
2336 enum AVAudioServiceType audio_service_type;
2339 * desired sample format
2340 * - encoding: Not used.
2341 * - decoding: Set by user.
2342 * Decoder will decode to this format if it can.
2344 enum AVSampleFormat request_sample_fmt;
2347 * This callback is called at the beginning of each frame to get data
2348 * buffer(s) for it. There may be one contiguous buffer for all the data or
2349 * there may be a buffer per each data plane or anything in between. What
2350 * this means is, you may set however many entries in buf[] you feel necessary.
2351 * Each buffer must be reference-counted using the AVBuffer API (see description
2354 * The following fields will be set in the frame before this callback is
2357 * - width, height (video only)
2358 * - sample_rate, channel_layout, nb_samples (audio only)
2359 * Their values may differ from the corresponding values in
2360 * AVCodecContext. This callback must use the frame values, not the codec
2361 * context values, to calculate the required buffer size.
2363 * This callback must fill the following fields in the frame:
2367 * * if the data is planar audio with more than 8 channels, then this
2368 * callback must allocate and fill extended_data to contain all pointers
2369 * to all data planes. data[] must hold as many pointers as it can.
2370 * extended_data must be allocated with av_malloc() and will be freed in
2372 * * otherwise extended_data must point to data
2373 * - buf[] must contain one or more pointers to AVBufferRef structures. Each of
2374 * the frame's data and extended_data pointers must be contained in these. That
2375 * is, one AVBufferRef for each allocated chunk of memory, not necessarily one
2376 * AVBufferRef per data[] entry. See: av_buffer_create(), av_buffer_alloc(),
2377 * and av_buffer_ref().
2378 * - extended_buf and nb_extended_buf must be allocated with av_malloc() by
2379 * this callback and filled with the extra buffers if there are more
2380 * buffers than buf[] can hold. extended_buf will be freed in
2383 * If AV_CODEC_CAP_DR1 is not set then get_buffer2() must call
2384 * avcodec_default_get_buffer2() instead of providing buffers allocated by
2387 * Each data plane must be aligned to the maximum required by the target
2390 * @see avcodec_default_get_buffer2()
2394 * If AV_GET_BUFFER_FLAG_REF is set in flags then the frame may be reused
2395 * (read and/or written to if it is writable) later by libavcodec.
2397 * avcodec_align_dimensions2() should be used to find the required width and
2398 * height, as they normally need to be rounded up to the next multiple of 16.
2400 * Some decoders do not support linesizes changing between frames.
2402 * If frame multithreading is used and thread_safe_callbacks is set,
2403 * this callback may be called from a different thread, but not from more
2404 * than one at once. Does not need to be reentrant.
2406 * @see avcodec_align_dimensions2()
2410 * Decoders request a buffer of a particular size by setting
2411 * AVFrame.nb_samples prior to calling get_buffer2(). The decoder may,
2412 * however, utilize only part of the buffer by setting AVFrame.nb_samples
2413 * to a smaller value in the output frame.
2415 * As a convenience, av_samples_get_buffer_size() and
2416 * av_samples_fill_arrays() in libavutil may be used by custom get_buffer2()
2417 * functions to find the required data size and to fill data pointers and
2418 * linesize. In AVFrame.linesize, only linesize[0] may be set for audio
2419 * since all planes must be the same size.
2421 * @see av_samples_get_buffer_size(), av_samples_fill_arrays()
2423 * - encoding: unused
2424 * - decoding: Set by libavcodec, user can override.
2426 int (*get_buffer2)(struct AVCodecContext *s, AVFrame *frame, int flags);
2429 * If non-zero, the decoded audio and video frames returned from
2430 * avcodec_decode_video2() and avcodec_decode_audio4() are reference-counted
2431 * and are valid indefinitely. The caller must free them with
2432 * av_frame_unref() when they are not needed anymore.
2433 * Otherwise, the decoded frames must not be freed by the caller and are
2434 * only valid until the next decode call.
2436 * This is always automatically enabled if avcodec_receive_frame() is used.
2438 * - encoding: unused
2439 * - decoding: set by the caller before avcodec_open2().
2441 attribute_deprecated
2442 int refcounted_frames;
2444 /* - encoding parameters */
2445 float qcompress; ///< amount of qscale change between easy & hard scenes (0.0-1.0)
2446 float qblur; ///< amount of qscale smoothing over time (0.0-1.0)
2450 * - encoding: Set by user.
2451 * - decoding: unused
2457 * - encoding: Set by user.
2458 * - decoding: unused
2463 * maximum quantizer difference between frames
2464 * - encoding: Set by user.
2465 * - decoding: unused
2470 * decoder bitstream buffer size
2471 * - encoding: Set by user.
2472 * - decoding: unused
2477 * ratecontrol override, see RcOverride
2478 * - encoding: Allocated/set/freed by user.
2479 * - decoding: unused
2481 int rc_override_count;
2482 RcOverride *rc_override;
2486 * - encoding: Set by user.
2487 * - decoding: Set by user, may be overwritten by libavcodec.
2489 int64_t rc_max_rate;
2493 * - encoding: Set by user.
2494 * - decoding: unused
2496 int64_t rc_min_rate;
2499 * Ratecontrol attempt to use, at maximum, <value> of what can be used without an underflow.
2500 * - encoding: Set by user.
2501 * - decoding: unused.
2503 float rc_max_available_vbv_use;
2506 * Ratecontrol attempt to use, at least, <value> times the amount needed to prevent a vbv overflow.
2507 * - encoding: Set by user.
2508 * - decoding: unused.
2510 float rc_min_vbv_overflow_use;
2513 * Number of bits which should be loaded into the rc buffer before decoding starts.
2514 * - encoding: Set by user.
2515 * - decoding: unused
2517 int rc_initial_buffer_occupancy;
2519 #if FF_API_CODER_TYPE
2520 #define FF_CODER_TYPE_VLC 0
2521 #define FF_CODER_TYPE_AC 1
2522 #define FF_CODER_TYPE_RAW 2
2523 #define FF_CODER_TYPE_RLE 3
2525 * @deprecated use encoder private options instead
2527 attribute_deprecated
2529 #endif /* FF_API_CODER_TYPE */
2531 #if FF_API_PRIVATE_OPT
2532 /** @deprecated use encoder private options instead */
2533 attribute_deprecated
2537 #if FF_API_PRIVATE_OPT
2538 /** @deprecated use encoder private options instead */
2539 attribute_deprecated
2540 int frame_skip_threshold;
2542 /** @deprecated use encoder private options instead */
2543 attribute_deprecated
2544 int frame_skip_factor;
2546 /** @deprecated use encoder private options instead */
2547 attribute_deprecated
2550 /** @deprecated use encoder private options instead */
2551 attribute_deprecated
2553 #endif /* FF_API_PRIVATE_OPT */
2556 * trellis RD quantization
2557 * - encoding: Set by user.
2558 * - decoding: unused
2562 #if FF_API_PRIVATE_OPT
2563 /** @deprecated use encoder private options instead */
2564 attribute_deprecated
2565 int min_prediction_order;
2567 /** @deprecated use encoder private options instead */
2568 attribute_deprecated
2569 int max_prediction_order;
2571 /** @deprecated use encoder private options instead */
2572 attribute_deprecated
2573 int64_t timecode_frame_start;
2576 #if FF_API_RTP_CALLBACK
2578 * @deprecated unused
2580 /* The RTP callback: This function is called */
2581 /* every time the encoder has a packet to send. */
2582 /* It depends on the encoder if the data starts */
2583 /* with a Start Code (it should). H.263 does. */
2584 /* mb_nb contains the number of macroblocks */
2585 /* encoded in the RTP payload. */
2586 attribute_deprecated
2587 void (*rtp_callback)(struct AVCodecContext *avctx, void *data, int size, int mb_nb);
2590 #if FF_API_PRIVATE_OPT
2591 /** @deprecated use encoder private options instead */
2592 attribute_deprecated
2593 int rtp_payload_size; /* The size of the RTP payload: the coder will */
2594 /* do its best to deliver a chunk with size */
2595 /* below rtp_payload_size, the chunk will start */
2596 /* with a start code on some codecs like H.263. */
2597 /* This doesn't take account of any particular */
2598 /* headers inside the transmitted RTP payload. */
2601 #if FF_API_STAT_BITS
2602 /* statistics, used for 2-pass encoding */
2603 attribute_deprecated
2605 attribute_deprecated
2607 attribute_deprecated
2609 attribute_deprecated
2611 attribute_deprecated
2613 attribute_deprecated
2615 attribute_deprecated
2617 attribute_deprecated
2620 /** @deprecated this field is unused */
2621 attribute_deprecated
2626 * pass1 encoding statistics output buffer
2627 * - encoding: Set by libavcodec.
2628 * - decoding: unused
2633 * pass2 encoding statistics input buffer
2634 * Concatenated stuff from stats_out of pass1 should be placed here.
2635 * - encoding: Allocated/set/freed by user.
2636 * - decoding: unused
2641 * Work around bugs in encoders which sometimes cannot be detected automatically.
2642 * - encoding: Set by user
2643 * - decoding: Set by user
2645 int workaround_bugs;
2646 #define FF_BUG_AUTODETECT 1 ///< autodetection
2647 #define FF_BUG_XVID_ILACE 4
2648 #define FF_BUG_UMP4 8
2649 #define FF_BUG_NO_PADDING 16
2650 #define FF_BUG_AMV 32
2651 #define FF_BUG_QPEL_CHROMA 64
2652 #define FF_BUG_STD_QPEL 128
2653 #define FF_BUG_QPEL_CHROMA2 256
2654 #define FF_BUG_DIRECT_BLOCKSIZE 512
2655 #define FF_BUG_EDGE 1024
2656 #define FF_BUG_HPEL_CHROMA 2048
2657 #define FF_BUG_DC_CLIP 4096
2658 #define FF_BUG_MS 8192 ///< Work around various bugs in Microsoft's broken decoders.
2659 #define FF_BUG_TRUNCATED 16384
2660 #define FF_BUG_IEDGE 32768
2663 * strictly follow the standard (MPEG-4, ...).
2664 * - encoding: Set by user.
2665 * - decoding: Set by user.
2666 * Setting this to STRICT or higher means the encoder and decoder will
2667 * generally do stupid things, whereas setting it to unofficial or lower
2668 * will mean the encoder might produce output that is not supported by all
2669 * spec-compliant decoders. Decoders don't differentiate between normal,
2670 * unofficial and experimental (that is, they always try to decode things
2671 * when they can) unless they are explicitly asked to behave stupidly
2672 * (=strictly conform to the specs)
2674 int strict_std_compliance;
2675 #define FF_COMPLIANCE_VERY_STRICT 2 ///< Strictly conform to an older more strict version of the spec or reference software.
2676 #define FF_COMPLIANCE_STRICT 1 ///< Strictly conform to all the things in the spec no matter what consequences.
2677 #define FF_COMPLIANCE_NORMAL 0
2678 #define FF_COMPLIANCE_UNOFFICIAL -1 ///< Allow unofficial extensions
2679 #define FF_COMPLIANCE_EXPERIMENTAL -2 ///< Allow nonstandardized experimental things.
2682 * error concealment flags
2683 * - encoding: unused
2684 * - decoding: Set by user.
2686 int error_concealment;
2687 #define FF_EC_GUESS_MVS 1
2688 #define FF_EC_DEBLOCK 2
2689 #define FF_EC_FAVOR_INTER 256
2693 * - encoding: Set by user.
2694 * - decoding: Set by user.
2697 #define FF_DEBUG_PICT_INFO 1
2698 #define FF_DEBUG_RC 2
2699 #define FF_DEBUG_BITSTREAM 4
2700 #define FF_DEBUG_MB_TYPE 8
2701 #define FF_DEBUG_QP 16
2704 * @deprecated this option does nothing
2706 #define FF_DEBUG_MV 32
2708 #define FF_DEBUG_DCT_COEFF 0x00000040
2709 #define FF_DEBUG_SKIP 0x00000080
2710 #define FF_DEBUG_STARTCODE 0x00000100
2711 #define FF_DEBUG_ER 0x00000400
2712 #define FF_DEBUG_MMCO 0x00000800
2713 #define FF_DEBUG_BUGS 0x00001000
2715 #define FF_DEBUG_VIS_QP 0x00002000
2716 #define FF_DEBUG_VIS_MB_TYPE 0x00004000
2718 #define FF_DEBUG_BUFFERS 0x00008000
2719 #define FF_DEBUG_THREADS 0x00010000
2720 #define FF_DEBUG_GREEN_MD 0x00800000
2721 #define FF_DEBUG_NOMC 0x01000000
2726 * - encoding: Set by user.
2727 * - decoding: Set by user.
2730 #define FF_DEBUG_VIS_MV_P_FOR 0x00000001 // visualize forward predicted MVs of P-frames
2731 #define FF_DEBUG_VIS_MV_B_FOR 0x00000002 // visualize forward predicted MVs of B-frames
2732 #define FF_DEBUG_VIS_MV_B_BACK 0x00000004 // visualize backward predicted MVs of B-frames
2736 * Error recognition; may misdetect some more or less valid parts as errors.
2737 * - encoding: unused
2738 * - decoding: Set by user.
2740 int err_recognition;
2743 * Verify checksums embedded in the bitstream (could be of either encoded or
2744 * decoded data, depending on the codec) and print an error message on mismatch.
2745 * If AV_EF_EXPLODE is also set, a mismatching checksum will result in the
2746 * decoder returning an error.
2748 #define AV_EF_CRCCHECK (1<<0)
2749 #define AV_EF_BITSTREAM (1<<1) ///< detect bitstream specification deviations
2750 #define AV_EF_BUFFER (1<<2) ///< detect improper bitstream length
2751 #define AV_EF_EXPLODE (1<<3) ///< abort decoding on minor error detection
2753 #define AV_EF_IGNORE_ERR (1<<15) ///< ignore errors and continue
2754 #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
2755 #define AV_EF_COMPLIANT (1<<17) ///< consider all spec non compliances as errors
2756 #define AV_EF_AGGRESSIVE (1<<18) ///< consider things that a sane encoder should not do as an error
2760 * opaque 64-bit number (generally a PTS) that will be reordered and
2761 * output in AVFrame.reordered_opaque
2762 * - encoding: Set by libavcodec to the reordered_opaque of the input
2763 * frame corresponding to the last returned packet. Only
2764 * supported by encoders with the
2765 * AV_CODEC_CAP_ENCODER_REORDERED_OPAQUE capability.
2766 * - decoding: Set by user.
2768 int64_t reordered_opaque;
2771 * Hardware accelerator in use
2772 * - encoding: unused.
2773 * - decoding: Set by libavcodec
2775 const struct AVHWAccel *hwaccel;
2778 * Hardware accelerator context.
2779 * For some hardware accelerators, a global context needs to be
2780 * provided by the user. In that case, this holds display-dependent
2781 * data FFmpeg cannot instantiate itself. Please refer to the
2782 * FFmpeg HW accelerator documentation to know how to fill this
2783 * is. e.g. for VA API, this is a struct vaapi_context.
2784 * - encoding: unused
2785 * - decoding: Set by user
2787 void *hwaccel_context;
2791 * - encoding: Set by libavcodec if flags & AV_CODEC_FLAG_PSNR.
2792 * - decoding: unused
2794 uint64_t error[AV_NUM_DATA_POINTERS];
2797 * DCT algorithm, see FF_DCT_* below
2798 * - encoding: Set by user.
2799 * - decoding: unused
2802 #define FF_DCT_AUTO 0
2803 #define FF_DCT_FASTINT 1
2804 #define FF_DCT_INT 2
2805 #define FF_DCT_MMX 3
2806 #define FF_DCT_ALTIVEC 5
2807 #define FF_DCT_FAAN 6
2810 * IDCT algorithm, see FF_IDCT_* below.
2811 * - encoding: Set by user.
2812 * - decoding: Set by user.
2815 #define FF_IDCT_AUTO 0
2816 #define FF_IDCT_INT 1
2817 #define FF_IDCT_SIMPLE 2
2818 #define FF_IDCT_SIMPLEMMX 3
2819 #define FF_IDCT_ARM 7
2820 #define FF_IDCT_ALTIVEC 8
2821 #define FF_IDCT_SIMPLEARM 10
2822 #define FF_IDCT_XVID 14
2823 #define FF_IDCT_SIMPLEARMV5TE 16
2824 #define FF_IDCT_SIMPLEARMV6 17
2825 #define FF_IDCT_FAAN 20
2826 #define FF_IDCT_SIMPLENEON 22
2827 #define FF_IDCT_NONE 24 /* Used by XvMC to extract IDCT coefficients with FF_IDCT_PERM_NONE */
2828 #define FF_IDCT_SIMPLEAUTO 128
2831 * bits per sample/pixel from the demuxer (needed for huffyuv).
2832 * - encoding: Set by libavcodec.
2833 * - decoding: Set by user.
2835 int bits_per_coded_sample;
2838 * Bits per sample/pixel of internal libavcodec pixel/sample format.
2839 * - encoding: set by user.
2840 * - decoding: set by libavcodec.
2842 int bits_per_raw_sample;
2846 * low resolution decoding, 1-> 1/2 size, 2->1/4 size
2847 * - encoding: unused
2848 * - decoding: Set by user.
2853 #if FF_API_CODED_FRAME
2855 * the picture in the bitstream
2856 * - encoding: Set by libavcodec.
2857 * - decoding: unused
2859 * @deprecated use the quality factor packet side data instead
2861 attribute_deprecated AVFrame *coded_frame;
2866 * is used to decide how many independent tasks should be passed to execute()
2867 * - encoding: Set by user.
2868 * - decoding: Set by user.
2873 * Which multithreading methods to use.
2874 * Use of FF_THREAD_FRAME will increase decoding delay by one frame per thread,
2875 * so clients which cannot provide future frames should not use it.
2877 * - encoding: Set by user, otherwise the default is used.
2878 * - decoding: Set by user, otherwise the default is used.
2881 #define FF_THREAD_FRAME 1 ///< Decode more than one frame at once
2882 #define FF_THREAD_SLICE 2 ///< Decode more than one part of a single frame at once
2885 * Which multithreading methods are in use by the codec.
2886 * - encoding: Set by libavcodec.
2887 * - decoding: Set by libavcodec.
2889 int active_thread_type;
2892 * Set by the client if its custom get_buffer() callback can be called
2893 * synchronously from another thread, which allows faster multithreaded decoding.
2894 * draw_horiz_band() will be called from other threads regardless of this setting.
2895 * Ignored if the default get_buffer() is used.
2896 * - encoding: Set by user.
2897 * - decoding: Set by user.
2899 int thread_safe_callbacks;
2902 * The codec may call this to execute several independent things.
2903 * It will return only after finishing all tasks.
2904 * The user may replace this with some multithreaded implementation,
2905 * the default implementation will execute the parts serially.
2906 * @param count the number of things to execute
2907 * - encoding: Set by libavcodec, user can override.
2908 * - decoding: Set by libavcodec, user can override.
2910 int (*execute)(struct AVCodecContext *c, int (*func)(struct AVCodecContext *c2, void *arg), void *arg2, int *ret, int count, int size);
2913 * The codec may call this to execute several independent things.
2914 * It will return only after finishing all tasks.
2915 * The user may replace this with some multithreaded implementation,
2916 * the default implementation will execute the parts serially.
2917 * Also see avcodec_thread_init and e.g. the --enable-pthread configure option.
2918 * @param c context passed also to func
2919 * @param count the number of things to execute
2920 * @param arg2 argument passed unchanged to func
2921 * @param ret return values of executed functions, must have space for "count" values. May be NULL.
2922 * @param func function that will be called count times, with jobnr from 0 to count-1.
2923 * threadnr will be in the range 0 to c->thread_count-1 < MAX_THREADS and so that no
2924 * two instances of func executing at the same time will have the same threadnr.
2925 * @return always 0 currently, but code should handle a future improvement where when any call to func
2926 * returns < 0 no further calls to func may be done and < 0 is returned.
2927 * - encoding: Set by libavcodec, user can override.
2928 * - decoding: Set by libavcodec, user can override.
2930 int (*execute2)(struct AVCodecContext *c, int (*func)(struct AVCodecContext *c2, void *arg, int jobnr, int threadnr), void *arg2, int *ret, int count);
2933 * noise vs. sse weight for the nsse comparison function
2934 * - encoding: Set by user.
2935 * - decoding: unused
2941 * - encoding: Set by user.
2942 * - decoding: Set by libavcodec.
2945 #define FF_PROFILE_UNKNOWN -99
2946 #define FF_PROFILE_RESERVED -100
2948 #define FF_PROFILE_AAC_MAIN 0
2949 #define FF_PROFILE_AAC_LOW 1
2950 #define FF_PROFILE_AAC_SSR 2
2951 #define FF_PROFILE_AAC_LTP 3
2952 #define FF_PROFILE_AAC_HE 4
2953 #define FF_PROFILE_AAC_HE_V2 28
2954 #define FF_PROFILE_AAC_LD 22
2955 #define FF_PROFILE_AAC_ELD 38
2956 #define FF_PROFILE_MPEG2_AAC_LOW 128
2957 #define FF_PROFILE_MPEG2_AAC_HE 131
2959 #define FF_PROFILE_DNXHD 0
2960 #define FF_PROFILE_DNXHR_LB 1
2961 #define FF_PROFILE_DNXHR_SQ 2
2962 #define FF_PROFILE_DNXHR_HQ 3
2963 #define FF_PROFILE_DNXHR_HQX 4
2964 #define FF_PROFILE_DNXHR_444 5
2966 #define FF_PROFILE_DTS 20
2967 #define FF_PROFILE_DTS_ES 30
2968 #define FF_PROFILE_DTS_96_24 40
2969 #define FF_PROFILE_DTS_HD_HRA 50
2970 #define FF_PROFILE_DTS_HD_MA 60
2971 #define FF_PROFILE_DTS_EXPRESS 70
2973 #define FF_PROFILE_MPEG2_422 0
2974 #define FF_PROFILE_MPEG2_HIGH 1
2975 #define FF_PROFILE_MPEG2_SS 2
2976 #define FF_PROFILE_MPEG2_SNR_SCALABLE 3
2977 #define FF_PROFILE_MPEG2_MAIN 4
2978 #define FF_PROFILE_MPEG2_SIMPLE 5
2980 #define FF_PROFILE_H264_CONSTRAINED (1<<9) // 8+1; constraint_set1_flag
2981 #define FF_PROFILE_H264_INTRA (1<<11) // 8+3; constraint_set3_flag
2983 #define FF_PROFILE_H264_BASELINE 66
2984 #define FF_PROFILE_H264_CONSTRAINED_BASELINE (66|FF_PROFILE_H264_CONSTRAINED)
2985 #define FF_PROFILE_H264_MAIN 77
2986 #define FF_PROFILE_H264_EXTENDED 88
2987 #define FF_PROFILE_H264_HIGH 100
2988 #define FF_PROFILE_H264_HIGH_10 110
2989 #define FF_PROFILE_H264_HIGH_10_INTRA (110|FF_PROFILE_H264_INTRA)
2990 #define FF_PROFILE_H264_MULTIVIEW_HIGH 118
2991 #define FF_PROFILE_H264_HIGH_422 122
2992 #define FF_PROFILE_H264_HIGH_422_INTRA (122|FF_PROFILE_H264_INTRA)
2993 #define FF_PROFILE_H264_STEREO_HIGH 128
2994 #define FF_PROFILE_H264_HIGH_444 144
2995 #define FF_PROFILE_H264_HIGH_444_PREDICTIVE 244
2996 #define FF_PROFILE_H264_HIGH_444_INTRA (244|FF_PROFILE_H264_INTRA)
2997 #define FF_PROFILE_H264_CAVLC_444 44
2999 #define FF_PROFILE_VC1_SIMPLE 0
3000 #define FF_PROFILE_VC1_MAIN 1
3001 #define FF_PROFILE_VC1_COMPLEX 2
3002 #define FF_PROFILE_VC1_ADVANCED 3
3004 #define FF_PROFILE_MPEG4_SIMPLE 0
3005 #define FF_PROFILE_MPEG4_SIMPLE_SCALABLE 1
3006 #define FF_PROFILE_MPEG4_CORE 2
3007 #define FF_PROFILE_MPEG4_MAIN 3
3008 #define FF_PROFILE_MPEG4_N_BIT 4
3009 #define FF_PROFILE_MPEG4_SCALABLE_TEXTURE 5
3010 #define FF_PROFILE_MPEG4_SIMPLE_FACE_ANIMATION 6
3011 #define FF_PROFILE_MPEG4_BASIC_ANIMATED_TEXTURE 7
3012 #define FF_PROFILE_MPEG4_HYBRID 8
3013 #define FF_PROFILE_MPEG4_ADVANCED_REAL_TIME 9
3014 #define FF_PROFILE_MPEG4_CORE_SCALABLE 10
3015 #define FF_PROFILE_MPEG4_ADVANCED_CODING 11
3016 #define FF_PROFILE_MPEG4_ADVANCED_CORE 12
3017 #define FF_PROFILE_MPEG4_ADVANCED_SCALABLE_TEXTURE 13
3018 #define FF_PROFILE_MPEG4_SIMPLE_STUDIO 14
3019 #define FF_PROFILE_MPEG4_ADVANCED_SIMPLE 15
3021 #define FF_PROFILE_JPEG2000_CSTREAM_RESTRICTION_0 1
3022 #define FF_PROFILE_JPEG2000_CSTREAM_RESTRICTION_1 2
3023 #define FF_PROFILE_JPEG2000_CSTREAM_NO_RESTRICTION 32768
3024 #define FF_PROFILE_JPEG2000_DCINEMA_2K 3
3025 #define FF_PROFILE_JPEG2000_DCINEMA_4K 4
3027 #define FF_PROFILE_VP9_0 0
3028 #define FF_PROFILE_VP9_1 1
3029 #define FF_PROFILE_VP9_2 2
3030 #define FF_PROFILE_VP9_3 3
3032 #define FF_PROFILE_HEVC_MAIN 1
3033 #define FF_PROFILE_HEVC_MAIN_10 2
3034 #define FF_PROFILE_HEVC_MAIN_STILL_PICTURE 3
3035 #define FF_PROFILE_HEVC_REXT 4
3037 #define FF_PROFILE_AV1_MAIN 0
3038 #define FF_PROFILE_AV1_HIGH 1
3039 #define FF_PROFILE_AV1_PROFESSIONAL 2
3041 #define FF_PROFILE_MJPEG_HUFFMAN_BASELINE_DCT 0xc0
3042 #define FF_PROFILE_MJPEG_HUFFMAN_EXTENDED_SEQUENTIAL_DCT 0xc1
3043 #define FF_PROFILE_MJPEG_HUFFMAN_PROGRESSIVE_DCT 0xc2
3044 #define FF_PROFILE_MJPEG_HUFFMAN_LOSSLESS 0xc3
3045 #define FF_PROFILE_MJPEG_JPEG_LS 0xf7
3047 #define FF_PROFILE_SBC_MSBC 1
3049 #define FF_PROFILE_PRORES_PROXY 0
3050 #define FF_PROFILE_PRORES_LT 1
3051 #define FF_PROFILE_PRORES_STANDARD 2
3052 #define FF_PROFILE_PRORES_HQ 3
3053 #define FF_PROFILE_PRORES_4444 4
3054 #define FF_PROFILE_PRORES_XQ 5
3056 #define FF_PROFILE_ARIB_PROFILE_A 0
3057 #define FF_PROFILE_ARIB_PROFILE_C 1
3061 * - encoding: Set by user.
3062 * - decoding: Set by libavcodec.
3065 #define FF_LEVEL_UNKNOWN -99
3068 * Skip loop filtering for selected frames.
3069 * - encoding: unused
3070 * - decoding: Set by user.
3072 enum AVDiscard skip_loop_filter;
3075 * Skip IDCT/dequantization for selected frames.
3076 * - encoding: unused
3077 * - decoding: Set by user.
3079 enum AVDiscard skip_idct;
3082 * Skip decoding for selected frames.
3083 * - encoding: unused
3084 * - decoding: Set by user.
3086 enum AVDiscard skip_frame;
3089 * Header containing style information for text subtitles.
3090 * For SUBTITLE_ASS subtitle type, it should contain the whole ASS
3091 * [Script Info] and [V4+ Styles] section, plus the [Events] line and
3092 * the Format line following. It shouldn't include any Dialogue line.
3093 * - encoding: Set/allocated/freed by user (before avcodec_open2())
3094 * - decoding: Set/allocated/freed by libavcodec (by avcodec_open2())
3096 uint8_t *subtitle_header;
3097 int subtitle_header_size;
3099 #if FF_API_VBV_DELAY
3101 * VBV delay coded in the last frame (in periods of a 27 MHz clock).
3102 * Used for compliant TS muxing.
3103 * - encoding: Set by libavcodec.
3104 * - decoding: unused.
3105 * @deprecated this value is now exported as a part of
3106 * AV_PKT_DATA_CPB_PROPERTIES packet side data
3108 attribute_deprecated
3112 #if FF_API_SIDEDATA_ONLY_PKT
3114 * Encoding only and set by default. Allow encoders to output packets
3115 * that do not contain any encoded data, only side data.
3117 * Some encoders need to output such packets, e.g. to update some stream
3118 * parameters at the end of encoding.
3120 * @deprecated this field disables the default behaviour and
3121 * it is kept only for compatibility.
3123 attribute_deprecated
3124 int side_data_only_packets;
3128 * Audio only. The number of "priming" samples (padding) inserted by the
3129 * encoder at the beginning of the audio. I.e. this number of leading
3130 * decoded samples must be discarded by the caller to get the original audio
3131 * without leading padding.
3133 * - decoding: unused
3134 * - encoding: Set by libavcodec. The timestamps on the output packets are
3135 * adjusted by the encoder so that they always refer to the
3136 * first sample of the data actually contained in the packet,
3137 * including any added padding. E.g. if the timebase is
3138 * 1/samplerate and the timestamp of the first input sample is
3139 * 0, the timestamp of the first output packet will be
3142 int initial_padding;
3145 * - decoding: For codecs that store a framerate value in the compressed
3146 * bitstream, the decoder may export it here. { 0, 1} when
3148 * - encoding: May be used to signal the framerate of CFR content to an
3151 AVRational framerate;
3154 * Nominal unaccelerated pixel format, see AV_PIX_FMT_xxx.
3155 * - encoding: unused.
3156 * - decoding: Set by libavcodec before calling get_format()
3158 enum AVPixelFormat sw_pix_fmt;
3161 * Timebase in which pkt_dts/pts and AVPacket.dts/pts are.
3162 * - encoding unused.
3163 * - decoding set by user.
3165 AVRational pkt_timebase;
3169 * - encoding: unused.
3170 * - decoding: set by libavcodec.
3172 const AVCodecDescriptor *codec_descriptor;
3176 * low resolution decoding, 1-> 1/2 size, 2->1/4 size
3177 * - encoding: unused
3178 * - decoding: Set by user.
3184 * Current statistics for PTS correction.
3185 * - decoding: maintained and used by libavcodec, not intended to be used by user apps
3186 * - encoding: unused
3188 int64_t pts_correction_num_faulty_pts; /// Number of incorrect PTS values so far
3189 int64_t pts_correction_num_faulty_dts; /// Number of incorrect DTS values so far
3190 int64_t pts_correction_last_pts; /// PTS of the last frame
3191 int64_t pts_correction_last_dts; /// DTS of the last frame
3194 * Character encoding of the input subtitles file.
3195 * - decoding: set by user
3196 * - encoding: unused
3201 * Subtitles character encoding mode. Formats or codecs might be adjusting
3202 * this setting (if they are doing the conversion themselves for instance).
3203 * - decoding: set by libavcodec
3204 * - encoding: unused
3206 int sub_charenc_mode;
3207 #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)
3208 #define FF_SUB_CHARENC_MODE_AUTOMATIC 0 ///< libavcodec will select the mode itself
3209 #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
3210 #define FF_SUB_CHARENC_MODE_IGNORE 2 ///< neither convert the subtitles, nor check them for valid UTF-8
3213 * Skip processing alpha if supported by codec.
3214 * Note that if the format uses pre-multiplied alpha (common with VP6,
3215 * and recommended due to better video quality/compression)
3216 * the image will look as if alpha-blended onto a black background.
3217 * However for formats that do not use pre-multiplied alpha
3218 * there might be serious artefacts (though e.g. libswscale currently
3219 * assumes pre-multiplied alpha anyway).
3221 * - decoding: set by user
3222 * - encoding: unused
3227 * Number of samples to skip after a discontinuity
3228 * - decoding: unused
3229 * - encoding: set by libavcodec
3233 #if !FF_API_DEBUG_MV
3235 * debug motion vectors
3236 * - encoding: Set by user.
3237 * - decoding: Set by user.
3240 #define FF_DEBUG_VIS_MV_P_FOR 0x00000001 //visualize forward predicted MVs of P frames
3241 #define FF_DEBUG_VIS_MV_B_FOR 0x00000002 //visualize forward predicted MVs of B frames
3242 #define FF_DEBUG_VIS_MV_B_BACK 0x00000004 //visualize backward predicted MVs of B frames
3246 * custom intra quantization matrix
3247 * - encoding: Set by user, can be NULL.
3248 * - decoding: unused.
3250 uint16_t *chroma_intra_matrix;
3253 * dump format separator.
3254 * can be ", " or "\n " or anything else
3255 * - encoding: Set by user.
3256 * - decoding: Set by user.
3258 uint8_t *dump_separator;
3261 * ',' separated list of allowed decoders.
3262 * If NULL then all are allowed
3263 * - encoding: unused
3264 * - decoding: set by user
3266 char *codec_whitelist;
3269 * Properties of the stream that gets decoded
3270 * - encoding: unused
3271 * - decoding: set by libavcodec
3273 unsigned properties;
3274 #define FF_CODEC_PROPERTY_LOSSLESS 0x00000001
3275 #define FF_CODEC_PROPERTY_CLOSED_CAPTIONS 0x00000002
3278 * Additional data associated with the entire coded stream.
3280 * - decoding: unused
3281 * - encoding: may be set by libavcodec after avcodec_open2().
3283 AVPacketSideData *coded_side_data;
3284 int nb_coded_side_data;
3287 * A reference to the AVHWFramesContext describing the input (for encoding)
3288 * or output (decoding) frames. The reference is set by the caller and
3289 * afterwards owned (and freed) by libavcodec - it should never be read by
3290 * the caller after being set.
3292 * - decoding: This field should be set by the caller from the get_format()
3293 * callback. The previous reference (if any) will always be
3294 * unreffed by libavcodec before the get_format() call.
3296 * If the default get_buffer2() is used with a hwaccel pixel
3297 * format, then this AVHWFramesContext will be used for
3298 * allocating the frame buffers.
3300 * - encoding: For hardware encoders configured to use a hwaccel pixel
3301 * format, this field should be set by the caller to a reference
3302 * to the AVHWFramesContext describing input frames.
3303 * AVHWFramesContext.format must be equal to
3304 * AVCodecContext.pix_fmt.
3306 * This field should be set before avcodec_open2() is called.
3308 AVBufferRef *hw_frames_ctx;
3311 * Control the form of AVSubtitle.rects[N]->ass
3312 * - decoding: set by user
3313 * - encoding: unused
3315 int sub_text_format;
3316 #define FF_SUB_TEXT_FMT_ASS 0
3317 #if FF_API_ASS_TIMING
3318 #define FF_SUB_TEXT_FMT_ASS_WITH_TIMINGS 1
3322 * Audio only. The amount of padding (in samples) appended by the encoder to
3323 * the end of the audio. I.e. this number of decoded samples must be
3324 * discarded by the caller from the end of the stream to get the original
3325 * audio without any trailing padding.
3327 * - decoding: unused
3328 * - encoding: unused
3330 int trailing_padding;
3333 * The number of pixels per image to maximally accept.
3335 * - decoding: set by user
3336 * - encoding: set by user
3341 * A reference to the AVHWDeviceContext describing the device which will
3342 * be used by a hardware encoder/decoder. The reference is set by the
3343 * caller and afterwards owned (and freed) by libavcodec.
3345 * This should be used if either the codec device does not require
3346 * hardware frames or any that are used are to be allocated internally by
3347 * libavcodec. If the user wishes to supply any of the frames used as
3348 * encoder input or decoder output then hw_frames_ctx should be used
3349 * instead. When hw_frames_ctx is set in get_format() for a decoder, this
3350 * field will be ignored while decoding the associated stream segment, but
3351 * may again be used on a following one after another get_format() call.
3353 * For both encoders and decoders this field should be set before
3354 * avcodec_open2() is called and must not be written to thereafter.
3356 * Note that some decoders may require this field to be set initially in
3357 * order to support hw_frames_ctx at all - in that case, all frames
3358 * contexts used must be created on the same device.
3360 AVBufferRef *hw_device_ctx;
3363 * Bit set of AV_HWACCEL_FLAG_* flags, which affect hardware accelerated
3364 * decoding (if active).
3365 * - encoding: unused
3366 * - decoding: Set by user (either before avcodec_open2(), or in the
3367 * AVCodecContext.get_format callback)
3372 * Video decoding only. Certain video codecs support cropping, meaning that
3373 * only a sub-rectangle of the decoded frame is intended for display. This
3374 * option controls how cropping is handled by libavcodec.
3376 * When set to 1 (the default), libavcodec will apply cropping internally.
3377 * I.e. it will modify the output frame width/height fields and offset the
3378 * data pointers (only by as much as possible while preserving alignment, or
3379 * by the full amount if the AV_CODEC_FLAG_UNALIGNED flag is set) so that
3380 * the frames output by the decoder refer only to the cropped area. The
3381 * crop_* fields of the output frames will be zero.
3383 * When set to 0, the width/height fields of the output frames will be set
3384 * to the coded dimensions and the crop_* fields will describe the cropping
3385 * rectangle. Applying the cropping is left to the caller.
3387 * @warning When hardware acceleration with opaque output frames is used,
3388 * libavcodec is unable to apply cropping from the top/left border.
3390 * @note when this option is set to zero, the width/height fields of the
3391 * AVCodecContext and output AVFrames have different meanings. The codec
3392 * context fields store display dimensions (with the coded dimensions in
3393 * coded_width/height), while the frame fields store the coded dimensions
3394 * (with the display dimensions being determined by the crop_* fields).
3399 * Video decoding only. Sets the number of extra hardware frames which
3400 * the decoder will allocate for use by the caller. This must be set
3401 * before avcodec_open2() is called.
3403 * Some hardware decoders require all frames that they will use for
3404 * output to be defined in advance before decoding starts. For such
3405 * decoders, the hardware frame pool must therefore be of a fixed size.
3406 * The extra frames set here are on top of any number that the decoder
3407 * needs internally in order to operate normally (for example, frames
3408 * used as reference pictures).
3410 int extra_hw_frames;
3413 * The percentage of damaged samples to discard a frame.
3415 * - decoding: set by user
3416 * - encoding: unused
3418 int discard_damaged_percentage;
3421 * The number of samples per frame to maximally accept.
3423 * - decoding: set by user
3424 * - encoding: set by user
3426 int64_t max_samples;
3429 * Bit set of AV_CODEC_EXPORT_DATA_* flags, which affects the kind of
3430 * metadata exported in frame, packet, or coded stream side data by
3431 * decoders and encoders.
3433 * - decoding: set by user
3434 * - encoding: set by user
3436 int export_side_data;
3439 #if FF_API_CODEC_GET_SET
3441 * Accessors for some AVCodecContext fields. These used to be provided for ABI
3442 * compatibility, and do not need to be used anymore.
3444 attribute_deprecated
3445 AVRational av_codec_get_pkt_timebase (const AVCodecContext *avctx);
3446 attribute_deprecated
3447 void av_codec_set_pkt_timebase (AVCodecContext *avctx, AVRational val);
3449 attribute_deprecated
3450 const AVCodecDescriptor *av_codec_get_codec_descriptor(const AVCodecContext *avctx);
3451 attribute_deprecated
3452 void av_codec_set_codec_descriptor(AVCodecContext *avctx, const AVCodecDescriptor *desc);
3454 attribute_deprecated
3455 unsigned av_codec_get_codec_properties(const AVCodecContext *avctx);
3458 attribute_deprecated
3459 int av_codec_get_lowres(const AVCodecContext *avctx);
3460 attribute_deprecated
3461 void av_codec_set_lowres(AVCodecContext *avctx, int val);
3464 attribute_deprecated
3465 int av_codec_get_seek_preroll(const AVCodecContext *avctx);
3466 attribute_deprecated
3467 void av_codec_set_seek_preroll(AVCodecContext *avctx, int val);
3469 attribute_deprecated
3470 uint16_t *av_codec_get_chroma_intra_matrix(const AVCodecContext *avctx);
3471 attribute_deprecated
3472 void av_codec_set_chroma_intra_matrix(AVCodecContext *avctx, uint16_t *val);
3478 typedef struct AVProfile {
3480 const char *name; ///< short name for the profile
3485 * The codec supports this format via the hw_device_ctx interface.
3487 * When selecting this format, AVCodecContext.hw_device_ctx should
3488 * have been set to a device of the specified type before calling
3491 AV_CODEC_HW_CONFIG_METHOD_HW_DEVICE_CTX = 0x01,
3493 * The codec supports this format via the hw_frames_ctx interface.
3495 * When selecting this format for a decoder,
3496 * AVCodecContext.hw_frames_ctx should be set to a suitable frames
3497 * context inside the get_format() callback. The frames context
3498 * must have been created on a device of the specified type.
3500 AV_CODEC_HW_CONFIG_METHOD_HW_FRAMES_CTX = 0x02,
3502 * The codec supports this format by some internal method.
3504 * This format can be selected without any additional configuration -
3505 * no device or frames context is required.
3507 AV_CODEC_HW_CONFIG_METHOD_INTERNAL = 0x04,
3509 * The codec supports this format by some ad-hoc method.
3511 * Additional settings and/or function calls are required. See the
3512 * codec-specific documentation for details. (Methods requiring
3513 * this sort of configuration are deprecated and others should be
3514 * used in preference.)
3516 AV_CODEC_HW_CONFIG_METHOD_AD_HOC = 0x08,
3519 typedef struct AVCodecHWConfig {
3521 * A hardware pixel format which the codec can use.
3523 enum AVPixelFormat pix_fmt;
3525 * Bit set of AV_CODEC_HW_CONFIG_METHOD_* flags, describing the possible
3526 * setup methods which can be used with this configuration.
3530 * The device type associated with the configuration.
3532 * Must be set for AV_CODEC_HW_CONFIG_METHOD_HW_DEVICE_CTX and
3533 * AV_CODEC_HW_CONFIG_METHOD_HW_FRAMES_CTX, otherwise unused.
3535 enum AVHWDeviceType device_type;
3538 typedef struct AVCodecDefault AVCodecDefault;
3545 typedef struct AVCodec {
3547 * Name of the codec implementation.
3548 * The name is globally unique among encoders and among decoders (but an
3549 * encoder and a decoder can share the same name).
3550 * This is the primary way to find a codec from the user perspective.
3554 * Descriptive name for the codec, meant to be more human readable than name.
3555 * You should use the NULL_IF_CONFIG_SMALL() macro to define it.
3557 const char *long_name;
3558 enum AVMediaType type;
3561 * Codec capabilities.
3562 * see AV_CODEC_CAP_*
3565 const AVRational *supported_framerates; ///< array of supported framerates, or NULL if any, array is terminated by {0,0}
3566 const enum AVPixelFormat *pix_fmts; ///< array of supported pixel formats, or NULL if unknown, array is terminated by -1
3567 const int *supported_samplerates; ///< array of supported audio samplerates, or NULL if unknown, array is terminated by 0
3568 const enum AVSampleFormat *sample_fmts; ///< array of supported sample formats, or NULL if unknown, array is terminated by -1
3569 const uint64_t *channel_layouts; ///< array of support channel layouts, or NULL if unknown. array is terminated by 0
3570 uint8_t max_lowres; ///< maximum value for lowres supported by the decoder
3571 const AVClass *priv_class; ///< AVClass for the private context
3572 const AVProfile *profiles; ///< array of recognized profiles, or NULL if unknown, array is terminated by {FF_PROFILE_UNKNOWN}
3575 * Group name of the codec implementation.
3576 * This is a short symbolic name of the wrapper backing this codec. A
3577 * wrapper uses some kind of external implementation for the codec, such
3578 * as an external library, or a codec implementation provided by the OS or
3580 * If this field is NULL, this is a builtin, libavcodec native codec.
3581 * If non-NULL, this will be the suffix in AVCodec.name in most cases
3582 * (usually AVCodec.name will be of the form "<codec_name>_<wrapper_name>").
3584 const char *wrapper_name;
3586 /*****************************************************************
3587 * No fields below this line are part of the public API. They
3588 * may not be used outside of libavcodec and can be changed and
3590 * New public fields should be added right above.
3591 *****************************************************************
3594 struct AVCodec *next;
3596 * @name Frame-level threading support functions
3600 * If defined, called on thread contexts when they are created.
3601 * If the codec allocates writable tables in init(), re-allocate them here.
3602 * priv_data will be set to a copy of the original.
3604 int (*init_thread_copy)(AVCodecContext *);
3606 * Copy necessary context variables from a previous thread context to the current one.
3607 * If not defined, the next thread will start automatically; otherwise, the codec
3608 * must call ff_thread_finish_setup().
3610 * dst and src will (rarely) point to the same context, in which case memcpy should be skipped.
3612 int (*update_thread_context)(AVCodecContext *dst, const AVCodecContext *src);
3616 * Private codec-specific defaults.
3618 const AVCodecDefault *defaults;
3621 * Initialize codec static data, called from avcodec_register().
3623 * This is not intended for time consuming operations as it is
3624 * run for every codec regardless of that codec being used.
3626 void (*init_static_data)(struct AVCodec *codec);
3628 int (*init)(AVCodecContext *);
3629 int (*encode_sub)(AVCodecContext *, uint8_t *buf, int buf_size,
3630 const struct AVSubtitle *sub);
3632 * Encode data to an AVPacket.
3634 * @param avctx codec context
3635 * @param avpkt output AVPacket (may contain a user-provided buffer)
3636 * @param[in] frame AVFrame containing the raw data to be encoded
3637 * @param[out] got_packet_ptr encoder sets to 0 or 1 to indicate that a
3638 * non-empty packet was returned in avpkt.
3639 * @return 0 on success, negative error code on failure
3641 int (*encode2)(AVCodecContext *avctx, AVPacket *avpkt, const AVFrame *frame,
3642 int *got_packet_ptr);
3643 int (*decode)(AVCodecContext *, void *outdata, int *outdata_size, AVPacket *avpkt);
3644 int (*close)(AVCodecContext *);
3646 * Encode API with decoupled packet/frame dataflow. The API is the
3647 * same as the avcodec_ prefixed APIs (avcodec_send_frame() etc.), except
3649 * - never called if the codec is closed or the wrong type,
3650 * - if AV_CODEC_CAP_DELAY is not set, drain frames are never sent,
3651 * - only one drain frame is ever passed down,
3653 int (*send_frame)(AVCodecContext *avctx, const AVFrame *frame);
3654 int (*receive_packet)(AVCodecContext *avctx, AVPacket *avpkt);
3657 * Decode API with decoupled packet/frame dataflow. This function is called
3658 * to get one output frame. It should call ff_decode_get_packet() to obtain
3661 int (*receive_frame)(AVCodecContext *avctx, AVFrame *frame);
3664 * Will be called when seeking
3666 void (*flush)(AVCodecContext *);
3668 * Internal codec capabilities.
3669 * See FF_CODEC_CAP_* in internal.h
3674 * Decoding only, a comma-separated list of bitstream filters to apply to
3675 * packets before decoding.
3680 * Array of pointers to hardware configurations supported by the codec,
3681 * or NULL if no hardware supported. The array is terminated by a NULL
3684 * The user can only access this field via avcodec_get_hw_config().
3686 const struct AVCodecHWConfigInternal **hw_configs;
3689 * List of supported codec_tags, terminated by FF_CODEC_TAGS_END.
3691 const uint32_t *codec_tags;
3694 #if FF_API_CODEC_GET_SET
3695 attribute_deprecated
3696 int av_codec_get_max_lowres(const AVCodec *codec);
3699 struct MpegEncContext;
3702 * Retrieve supported hardware configurations for a codec.
3704 * Values of index from zero to some maximum return the indexed configuration
3705 * descriptor; all other values return NULL. If the codec does not support
3706 * any hardware configurations then it will always return NULL.
3708 const AVCodecHWConfig *avcodec_get_hw_config(const AVCodec *codec, int index);
3711 * @defgroup lavc_hwaccel AVHWAccel
3713 * @note Nothing in this structure should be accessed by the user. At some
3714 * point in future it will not be externally visible at all.
3718 typedef struct AVHWAccel {
3720 * Name of the hardware accelerated codec.
3721 * The name is globally unique among encoders and among decoders (but an
3722 * encoder and a decoder can share the same name).
3727 * Type of codec implemented by the hardware accelerator.
3729 * See AVMEDIA_TYPE_xxx
3731 enum AVMediaType type;
3734 * Codec implemented by the hardware accelerator.
3736 * See AV_CODEC_ID_xxx
3741 * Supported pixel format.
3743 * Only hardware accelerated formats are supported here.
3745 enum AVPixelFormat pix_fmt;
3748 * Hardware accelerated codec capabilities.
3749 * see AV_HWACCEL_CODEC_CAP_*
3753 /*****************************************************************
3754 * No fields below this line are part of the public API. They
3755 * may not be used outside of libavcodec and can be changed and
3757 * New public fields should be added right above.
3758 *****************************************************************
3762 * Allocate a custom buffer
3764 int (*alloc_frame)(AVCodecContext *avctx, AVFrame *frame);
3767 * Called at the beginning of each frame or field picture.
3769 * Meaningful frame information (codec specific) is guaranteed to
3770 * be parsed at this point. This function is mandatory.
3772 * Note that buf can be NULL along with buf_size set to 0.
3773 * Otherwise, this means the whole frame is available at this point.
3775 * @param avctx the codec context
3776 * @param buf the frame data buffer base
3777 * @param buf_size the size of the frame in bytes
3778 * @return zero if successful, a negative value otherwise
3780 int (*start_frame)(AVCodecContext *avctx, const uint8_t *buf, uint32_t buf_size);
3783 * Callback for parameter data (SPS/PPS/VPS etc).
3785 * Useful for hardware decoders which keep persistent state about the
3786 * video parameters, and need to receive any changes to update that state.
3788 * @param avctx the codec context
3789 * @param type the nal unit type
3790 * @param buf the nal unit data buffer
3791 * @param buf_size the size of the nal unit in bytes
3792 * @return zero if successful, a negative value otherwise
3794 int (*decode_params)(AVCodecContext *avctx, int type, const uint8_t *buf, uint32_t buf_size);
3797 * Callback for each slice.
3799 * Meaningful slice information (codec specific) is guaranteed to
3800 * be parsed at this point. This function is mandatory.
3801 * The only exception is XvMC, that works on MB level.
3803 * @param avctx the codec context
3804 * @param buf the slice data buffer base
3805 * @param buf_size the size of the slice in bytes
3806 * @return zero if successful, a negative value otherwise
3808 int (*decode_slice)(AVCodecContext *avctx, const uint8_t *buf, uint32_t buf_size);
3811 * Called at the end of each frame or field picture.
3813 * The whole picture is parsed at this point and can now be sent
3814 * to the hardware accelerator. This function is mandatory.
3816 * @param avctx the codec context
3817 * @return zero if successful, a negative value otherwise
3819 int (*end_frame)(AVCodecContext *avctx);
3822 * Size of per-frame hardware accelerator private data.
3824 * Private data is allocated with av_mallocz() before
3825 * AVCodecContext.get_buffer() and deallocated after
3826 * AVCodecContext.release_buffer().
3828 int frame_priv_data_size;
3831 * Called for every Macroblock in a slice.
3833 * XvMC uses it to replace the ff_mpv_reconstruct_mb().
3834 * Instead of decoding to raw picture, MB parameters are
3835 * stored in an array provided by the video driver.
3837 * @param s the mpeg context
3839 void (*decode_mb)(struct MpegEncContext *s);
3842 * Initialize the hwaccel private data.
3844 * This will be called from ff_get_format(), after hwaccel and
3845 * hwaccel_context are set and the hwaccel private data in AVCodecInternal
3848 int (*init)(AVCodecContext *avctx);
3851 * Uninitialize the hwaccel private data.
3853 * This will be called from get_format() or avcodec_close(), after hwaccel
3854 * and hwaccel_context are already uninitialized.
3856 int (*uninit)(AVCodecContext *avctx);
3859 * Size of the private data to allocate in
3860 * AVCodecInternal.hwaccel_priv_data.
3865 * Internal hwaccel capabilities.
3870 * Fill the given hw_frames context with current codec parameters. Called
3871 * from get_format. Refer to avcodec_get_hw_frames_parameters() for
3874 * This CAN be called before AVHWAccel.init is called, and you must assume
3875 * that avctx->hwaccel_priv_data is invalid.
3877 int (*frame_params)(AVCodecContext *avctx, AVBufferRef *hw_frames_ctx);
3881 * HWAccel is experimental and is thus avoided in favor of non experimental
3884 #define AV_HWACCEL_CODEC_CAP_EXPERIMENTAL 0x0200
3887 * Hardware acceleration should be used for decoding even if the codec level
3888 * used is unknown or higher than the maximum supported level reported by the
3891 * It's generally a good idea to pass this flag unless you have a specific
3892 * reason not to, as hardware tends to under-report supported levels.
3894 #define AV_HWACCEL_FLAG_IGNORE_LEVEL (1 << 0)
3897 * Hardware acceleration can output YUV pixel formats with a different chroma
3898 * sampling than 4:2:0 and/or other than 8 bits per component.
3900 #define AV_HWACCEL_FLAG_ALLOW_HIGH_DEPTH (1 << 1)
3903 * Hardware acceleration should still be attempted for decoding when the
3904 * codec profile does not match the reported capabilities of the hardware.
3906 * For example, this can be used to try to decode baseline profile H.264
3907 * streams in hardware - it will often succeed, because many streams marked
3908 * as baseline profile actually conform to constrained baseline profile.
3910 * @warning If the stream is actually not supported then the behaviour is
3911 * undefined, and may include returning entirely incorrect output
3912 * while indicating success.
3914 #define AV_HWACCEL_FLAG_ALLOW_PROFILE_MISMATCH (1 << 2)
3920 #if FF_API_AVPICTURE
3922 * @defgroup lavc_picture AVPicture
3924 * Functions for working with AVPicture
3929 * Picture data structure.
3931 * Up to four components can be stored into it, the last component is
3933 * @deprecated use AVFrame or imgutils functions instead
3935 typedef struct AVPicture {
3936 attribute_deprecated
3937 uint8_t *data[AV_NUM_DATA_POINTERS]; ///< pointers to the image data planes
3938 attribute_deprecated
3939 int linesize[AV_NUM_DATA_POINTERS]; ///< number of bytes per line
3947 enum AVSubtitleType {
3950 SUBTITLE_BITMAP, ///< A bitmap, pict will be set
3953 * Plain text, the text field must be set by the decoder and is
3954 * authoritative. ass and pict fields may contain approximations.
3959 * Formatted text, the ass field must be set by the decoder and is
3960 * authoritative. pict and text fields may contain approximations.
3965 #define AV_SUBTITLE_FLAG_FORCED 0x00000001
3967 typedef struct AVSubtitleRect {
3968 int x; ///< top left corner of pict, undefined when pict is not set
3969 int y; ///< top left corner of pict, undefined when pict is not set
3970 int w; ///< width of pict, undefined when pict is not set
3971 int h; ///< height of pict, undefined when pict is not set
3972 int nb_colors; ///< number of colors in pict, undefined when pict is not set
3974 #if FF_API_AVPICTURE
3976 * @deprecated unused
3978 attribute_deprecated
3982 * data+linesize for the bitmap of this subtitle.
3983 * Can be set for text/ass as well once they are rendered.
3988 enum AVSubtitleType type;
3990 char *text; ///< 0 terminated plain UTF-8 text
3993 * 0 terminated ASS/SSA compatible event line.
3994 * The presentation of this is unaffected by the other values in this
4002 typedef struct AVSubtitle {
4003 uint16_t format; /* 0 = graphics */
4004 uint32_t start_display_time; /* relative to packet pts, in ms */
4005 uint32_t end_display_time; /* relative to packet pts, in ms */
4007 AVSubtitleRect **rects;
4008 int64_t pts; ///< Same as packet pts, in AV_TIME_BASE
4012 * This struct describes the properties of an encoded stream.
4014 * sizeof(AVCodecParameters) is not a part of the public ABI, this struct must
4015 * be allocated with avcodec_parameters_alloc() and freed with
4016 * avcodec_parameters_free().
4018 typedef struct AVCodecParameters {
4020 * General type of the encoded data.
4022 enum AVMediaType codec_type;
4024 * Specific type of the encoded data (the codec used).
4026 enum AVCodecID codec_id;
4028 * Additional information about the codec (corresponds to the AVI FOURCC).
4033 * Extra binary data needed for initializing the decoder, codec-dependent.
4035 * Must be allocated with av_malloc() and will be freed by
4036 * avcodec_parameters_free(). The allocated size of extradata must be at
4037 * least extradata_size + AV_INPUT_BUFFER_PADDING_SIZE, with the padding
4042 * Size of the extradata content in bytes.
4047 * - video: the pixel format, the value corresponds to enum AVPixelFormat.
4048 * - audio: the sample format, the value corresponds to enum AVSampleFormat.
4053 * The average bitrate of the encoded data (in bits per second).
4058 * The number of bits per sample in the codedwords.
4060 * This is basically the bitrate per sample. It is mandatory for a bunch of
4061 * formats to actually decode them. It's the number of bits for one sample in
4062 * the actual coded bitstream.
4064 * This could be for example 4 for ADPCM
4065 * For PCM formats this matches bits_per_raw_sample
4068 int bits_per_coded_sample;
4071 * This is the number of valid bits in each output sample. If the
4072 * sample format has more bits, the least significant bits are additional
4073 * padding bits, which are always 0. Use right shifts to reduce the sample
4074 * to its actual size. For example, audio formats with 24 bit samples will
4075 * have bits_per_raw_sample set to 24, and format set to AV_SAMPLE_FMT_S32.
4076 * To get the original sample use "(int32_t)sample >> 8"."
4078 * For ADPCM this might be 12 or 16 or similar
4081 int bits_per_raw_sample;
4084 * Codec-specific bitstream restrictions that the stream conforms to.
4090 * Video only. The dimensions of the video frame in pixels.
4096 * Video only. The aspect ratio (width / height) which a single pixel
4097 * should have when displayed.
4099 * When the aspect ratio is unknown / undefined, the numerator should be
4100 * set to 0 (the denominator may have any value).
4102 AVRational sample_aspect_ratio;
4105 * Video only. The order of the fields in interlaced video.
4107 enum AVFieldOrder field_order;
4110 * Video only. Additional colorspace characteristics.
4112 enum AVColorRange color_range;
4113 enum AVColorPrimaries color_primaries;
4114 enum AVColorTransferCharacteristic color_trc;
4115 enum AVColorSpace color_space;
4116 enum AVChromaLocation chroma_location;
4119 * Video only. Number of delayed frames.
4124 * Audio only. The channel layout bitmask. May be 0 if the channel layout is
4125 * unknown or unspecified, otherwise the number of bits set must be equal to
4126 * the channels field.
4128 uint64_t channel_layout;
4130 * Audio only. The number of audio channels.
4134 * Audio only. The number of audio samples per second.
4138 * Audio only. The number of bytes per coded audio frame, required by some
4141 * Corresponds to nBlockAlign in WAVEFORMATEX.
4145 * Audio only. Audio frame size, if known. Required by some formats to be static.
4150 * Audio only. The amount of padding (in samples) inserted by the encoder at
4151 * the beginning of the audio. I.e. this number of leading decoded samples
4152 * must be discarded by the caller to get the original audio without leading
4155 int initial_padding;
4157 * Audio only. The amount of padding (in samples) appended by the encoder to
4158 * the end of the audio. I.e. this number of decoded samples must be
4159 * discarded by the caller from the end of the stream to get the original
4160 * audio without any trailing padding.
4162 int trailing_padding;
4164 * Audio only. Number of samples to skip after a discontinuity.
4167 } AVCodecParameters;
4170 * Iterate over all registered codecs.
4172 * @param opaque a pointer where libavcodec will store the iteration state. Must
4173 * point to NULL to start the iteration.
4175 * @return the next registered codec or NULL when the iteration is
4178 const AVCodec *av_codec_iterate(void **opaque);
4182 * If c is NULL, returns the first registered codec,
4183 * if c is non-NULL, returns the next registered codec after c,
4184 * or NULL if c is the last one.
4186 attribute_deprecated
4187 AVCodec *av_codec_next(const AVCodec *c);
4191 * Return the LIBAVCODEC_VERSION_INT constant.
4193 unsigned avcodec_version(void);
4196 * Return the libavcodec build-time configuration.
4198 const char *avcodec_configuration(void);
4201 * Return the libavcodec license.
4203 const char *avcodec_license(void);
4207 * Register the codec codec and initialize libavcodec.
4209 * @warning either this function or avcodec_register_all() must be called
4210 * before any other libavcodec functions.
4212 * @see avcodec_register_all()
4214 attribute_deprecated
4215 void avcodec_register(AVCodec *codec);
4218 * Register all the codecs, parsers and bitstream filters which were enabled at
4219 * configuration time. If you do not call this function you can select exactly
4220 * which formats you want to support, by using the individual registration
4223 * @see avcodec_register
4224 * @see av_register_codec_parser
4225 * @see av_register_bitstream_filter
4227 attribute_deprecated
4228 void avcodec_register_all(void);
4232 * Allocate an AVCodecContext and set its fields to default values. The
4233 * resulting struct should be freed with avcodec_free_context().
4235 * @param codec if non-NULL, allocate private data and initialize defaults
4236 * for the given codec. It is illegal to then call avcodec_open2()
4237 * with a different codec.
4238 * If NULL, then the codec-specific defaults won't be initialized,
4239 * which may result in suboptimal default settings (this is
4240 * important mainly for encoders, e.g. libx264).
4242 * @return An AVCodecContext filled with default values or NULL on failure.
4244 AVCodecContext *avcodec_alloc_context3(const AVCodec *codec);
4247 * Free the codec context and everything associated with it and write NULL to
4248 * the provided pointer.
4250 void avcodec_free_context(AVCodecContext **avctx);
4252 #if FF_API_GET_CONTEXT_DEFAULTS
4254 * @deprecated This function should not be used, as closing and opening a codec
4255 * context multiple time is not supported. A new codec context should be
4256 * allocated for each new use.
4258 int avcodec_get_context_defaults3(AVCodecContext *s, const AVCodec *codec);
4262 * Get the AVClass for AVCodecContext. It can be used in combination with
4263 * AV_OPT_SEARCH_FAKE_OBJ for examining options.
4265 * @see av_opt_find().
4267 const AVClass *avcodec_get_class(void);
4269 #if FF_API_COPY_CONTEXT
4271 * Get the AVClass for AVFrame. It can be used in combination with
4272 * AV_OPT_SEARCH_FAKE_OBJ for examining options.
4274 * @see av_opt_find().
4276 const AVClass *avcodec_get_frame_class(void);
4279 * Get the AVClass for AVSubtitleRect. It can be used in combination with
4280 * AV_OPT_SEARCH_FAKE_OBJ for examining options.
4282 * @see av_opt_find().
4284 const AVClass *avcodec_get_subtitle_rect_class(void);
4287 * Copy the settings of the source AVCodecContext into the destination
4288 * AVCodecContext. The resulting destination codec context will be
4289 * unopened, i.e. you are required to call avcodec_open2() before you
4290 * can use this AVCodecContext to decode/encode video/audio data.
4292 * @param dest target codec context, should be initialized with
4293 * avcodec_alloc_context3(NULL), but otherwise uninitialized
4294 * @param src source codec context
4295 * @return AVERROR() on error (e.g. memory allocation error), 0 on success
4297 * @deprecated The semantics of this function are ill-defined and it should not
4298 * be used. If you need to transfer the stream parameters from one codec context
4299 * to another, use an intermediate AVCodecParameters instance and the
4300 * avcodec_parameters_from_context() / avcodec_parameters_to_context()
4303 attribute_deprecated
4304 int avcodec_copy_context(AVCodecContext *dest, const AVCodecContext *src);
4308 * Allocate a new AVCodecParameters and set its fields to default values
4309 * (unknown/invalid/0). The returned struct must be freed with
4310 * avcodec_parameters_free().
4312 AVCodecParameters *avcodec_parameters_alloc(void);
4315 * Free an AVCodecParameters instance and everything associated with it and
4316 * write NULL to the supplied pointer.
4318 void avcodec_parameters_free(AVCodecParameters **par);
4321 * Copy the contents of src to dst. Any allocated fields in dst are freed and
4322 * replaced with newly allocated duplicates of the corresponding fields in src.
4324 * @return >= 0 on success, a negative AVERROR code on failure.
4326 int avcodec_parameters_copy(AVCodecParameters *dst, const AVCodecParameters *src);
4329 * Fill the parameters struct based on the values from the supplied codec
4330 * context. Any allocated fields in par are freed and replaced with duplicates
4331 * of the corresponding fields in codec.
4333 * @return >= 0 on success, a negative AVERROR code on failure
4335 int avcodec_parameters_from_context(AVCodecParameters *par,
4336 const AVCodecContext *codec);
4339 * Fill the codec context based on the values from the supplied codec
4340 * parameters. Any allocated fields in codec that have a corresponding field in
4341 * par are freed and replaced with duplicates of the corresponding field in par.
4342 * Fields in codec that do not have a counterpart in par are not touched.
4344 * @return >= 0 on success, a negative AVERROR code on failure.
4346 int avcodec_parameters_to_context(AVCodecContext *codec,
4347 const AVCodecParameters *par);
4350 * Initialize the AVCodecContext to use the given AVCodec. Prior to using this
4351 * function the context has to be allocated with avcodec_alloc_context3().
4353 * The functions avcodec_find_decoder_by_name(), avcodec_find_encoder_by_name(),
4354 * avcodec_find_decoder() and avcodec_find_encoder() provide an easy way for
4355 * retrieving a codec.
4357 * @warning This function is not thread safe!
4359 * @note Always call this function before using decoding routines (such as
4360 * @ref avcodec_receive_frame()).
4363 * avcodec_register_all();
4364 * av_dict_set(&opts, "b", "2.5M", 0);
4365 * codec = avcodec_find_decoder(AV_CODEC_ID_H264);
4369 * context = avcodec_alloc_context3(codec);
4371 * if (avcodec_open2(context, codec, opts) < 0)
4375 * @param avctx The context to initialize.
4376 * @param codec The codec to open this context for. If a non-NULL codec has been
4377 * previously passed to avcodec_alloc_context3() or
4378 * for this context, then this parameter MUST be either NULL or
4379 * equal to the previously passed codec.
4380 * @param options A dictionary filled with AVCodecContext and codec-private options.
4381 * On return this object will be filled with options that were not found.
4383 * @return zero on success, a negative value on error
4384 * @see avcodec_alloc_context3(), avcodec_find_decoder(), avcodec_find_encoder(),
4385 * av_dict_set(), av_opt_find().
4387 int avcodec_open2(AVCodecContext *avctx, const AVCodec *codec, AVDictionary **options);
4390 * Close a given AVCodecContext and free all the data associated with it
4391 * (but not the AVCodecContext itself).
4393 * Calling this function on an AVCodecContext that hasn't been opened will free
4394 * the codec-specific data allocated in avcodec_alloc_context3() with a non-NULL
4395 * codec. Subsequent calls will do nothing.
4397 * @note Do not use this function. Use avcodec_free_context() to destroy a
4398 * codec context (either open or closed). Opening and closing a codec context
4399 * multiple times is not supported anymore -- use multiple codec contexts
4402 int avcodec_close(AVCodecContext *avctx);
4405 * Free all allocated data in the given subtitle struct.
4407 * @param sub AVSubtitle to free.
4409 void avsubtitle_free(AVSubtitle *sub);
4416 * @addtogroup lavc_packet
4421 * Allocate an AVPacket and set its fields to default values. The resulting
4422 * struct must be freed using av_packet_free().
4424 * @return An AVPacket filled with default values or NULL on failure.
4426 * @note this only allocates the AVPacket itself, not the data buffers. Those
4427 * must be allocated through other means such as av_new_packet.
4429 * @see av_new_packet
4431 AVPacket *av_packet_alloc(void);
4434 * Create a new packet that references the same data as src.
4436 * This is a shortcut for av_packet_alloc()+av_packet_ref().
4438 * @return newly created AVPacket on success, NULL on error.
4440 * @see av_packet_alloc
4441 * @see av_packet_ref
4443 AVPacket *av_packet_clone(const AVPacket *src);
4446 * Free the packet, if the packet is reference counted, it will be
4447 * unreferenced first.
4449 * @param pkt packet to be freed. The pointer will be set to NULL.
4450 * @note passing NULL is a no-op.
4452 void av_packet_free(AVPacket **pkt);
4455 * Initialize optional fields of a packet with default values.
4457 * Note, this does not touch the data and size members, which have to be
4458 * initialized separately.
4462 void av_init_packet(AVPacket *pkt);
4465 * Allocate the payload of a packet and initialize its fields with
4469 * @param size wanted payload size
4470 * @return 0 if OK, AVERROR_xxx otherwise
4472 int av_new_packet(AVPacket *pkt, int size);
4475 * Reduce packet size, correctly zeroing padding
4478 * @param size new size
4480 void av_shrink_packet(AVPacket *pkt, int size);
4483 * Increase packet size, correctly zeroing padding
4486 * @param grow_by number of bytes by which to increase the size of the packet
4488 int av_grow_packet(AVPacket *pkt, int grow_by);
4491 * Initialize a reference-counted packet from av_malloc()ed data.
4493 * @param pkt packet to be initialized. This function will set the data, size,
4494 * and buf fields, all others are left untouched.
4495 * @param data Data allocated by av_malloc() to be used as packet data. If this
4496 * function returns successfully, the data is owned by the underlying AVBuffer.
4497 * The caller may not access the data through other means.
4498 * @param size size of data in bytes, without the padding. I.e. the full buffer
4499 * size is assumed to be size + AV_INPUT_BUFFER_PADDING_SIZE.
4501 * @return 0 on success, a negative AVERROR on error
4503 int av_packet_from_data(AVPacket *pkt, uint8_t *data, int size);
4505 #if FF_API_AVPACKET_OLD_API
4507 * @warning This is a hack - the packet memory allocation stuff is broken. The
4508 * packet is allocated if it was not really allocated.
4510 * @deprecated Use av_packet_ref or av_packet_make_refcounted
4512 attribute_deprecated
4513 int av_dup_packet(AVPacket *pkt);
4515 * Copy packet, including contents
4517 * @return 0 on success, negative AVERROR on fail
4519 * @deprecated Use av_packet_ref
4521 attribute_deprecated
4522 int av_copy_packet(AVPacket *dst, const AVPacket *src);
4525 * Copy packet side data
4527 * @return 0 on success, negative AVERROR on fail
4529 * @deprecated Use av_packet_copy_props
4531 attribute_deprecated
4532 int av_copy_packet_side_data(AVPacket *dst, const AVPacket *src);
4537 * @deprecated Use av_packet_unref
4539 * @param pkt packet to free
4541 attribute_deprecated
4542 void av_free_packet(AVPacket *pkt);
4545 * Allocate new information of a packet.
4548 * @param type side information type
4549 * @param size side information size
4550 * @return pointer to fresh allocated data or NULL otherwise
4552 uint8_t* av_packet_new_side_data(AVPacket *pkt, enum AVPacketSideDataType type,
4556 * Wrap an existing array as a packet side data.
4559 * @param type side information type
4560 * @param data the side data array. It must be allocated with the av_malloc()
4561 * family of functions. The ownership of the data is transferred to
4563 * @param size side information size
4564 * @return a non-negative number on success, a negative AVERROR code on
4565 * failure. On failure, the packet is unchanged and the data remains
4566 * owned by the caller.
4568 int av_packet_add_side_data(AVPacket *pkt, enum AVPacketSideDataType type,
4569 uint8_t *data, size_t size);
4572 * Shrink the already allocated side data buffer
4575 * @param type side information type
4576 * @param size new side information size
4577 * @return 0 on success, < 0 on failure
4579 int av_packet_shrink_side_data(AVPacket *pkt, enum AVPacketSideDataType type,
4583 * Get side information from packet.
4586 * @param type desired side information type
4587 * @param size pointer for side information size to store (optional)
4588 * @return pointer to data if present or NULL otherwise
4590 uint8_t* av_packet_get_side_data(const AVPacket *pkt, enum AVPacketSideDataType type,
4593 #if FF_API_MERGE_SD_API
4594 attribute_deprecated
4595 int av_packet_merge_side_data(AVPacket *pkt);
4597 attribute_deprecated
4598 int av_packet_split_side_data(AVPacket *pkt);
4601 const char *av_packet_side_data_name(enum AVPacketSideDataType type);
4604 * Pack a dictionary for use in side_data.
4606 * @param dict The dictionary to pack.
4607 * @param size pointer to store the size of the returned data
4608 * @return pointer to data if successful, NULL otherwise
4610 uint8_t *av_packet_pack_dictionary(AVDictionary *dict, int *size);
4612 * Unpack a dictionary from side_data.
4614 * @param data data from side_data
4615 * @param size size of the data
4616 * @param dict the metadata storage dictionary
4617 * @return 0 on success, < 0 on failure
4619 int av_packet_unpack_dictionary(const uint8_t *data, int size, AVDictionary **dict);
4623 * Convenience function to free all the side data stored.
4624 * All the other fields stay untouched.
4628 void av_packet_free_side_data(AVPacket *pkt);
4631 * Setup a new reference to the data described by a given packet
4633 * If src is reference-counted, setup dst as a new reference to the
4634 * buffer in src. Otherwise allocate a new buffer in dst and copy the
4635 * data from src into it.
4637 * All the other fields are copied from src.
4639 * @see av_packet_unref
4641 * @param dst Destination packet
4642 * @param src Source packet
4644 * @return 0 on success, a negative AVERROR on error.
4646 int av_packet_ref(AVPacket *dst, const AVPacket *src);
4651 * Unreference the buffer referenced by the packet and reset the
4652 * remaining packet fields to their default values.
4654 * @param pkt The packet to be unreferenced.
4656 void av_packet_unref(AVPacket *pkt);
4659 * Move every field in src to dst and reset src.
4661 * @see av_packet_unref
4663 * @param src Source packet, will be reset
4664 * @param dst Destination packet
4666 void av_packet_move_ref(AVPacket *dst, AVPacket *src);
4669 * Copy only "properties" fields from src to dst.
4671 * Properties for the purpose of this function are all the fields
4672 * beside those related to the packet data (buf, data, size)
4674 * @param dst Destination packet
4675 * @param src Source packet
4677 * @return 0 on success AVERROR on failure.
4679 int av_packet_copy_props(AVPacket *dst, const AVPacket *src);
4682 * Ensure the data described by a given packet is reference counted.
4684 * @note This function does not ensure that the reference will be writable.
4685 * Use av_packet_make_writable instead for that purpose.
4687 * @see av_packet_ref
4688 * @see av_packet_make_writable
4690 * @param pkt packet whose data should be made reference counted.
4692 * @return 0 on success, a negative AVERROR on error. On failure, the
4693 * packet is unchanged.
4695 int av_packet_make_refcounted(AVPacket *pkt);
4698 * Create a writable reference for the data described by a given packet,
4699 * avoiding data copy if possible.
4701 * @param pkt Packet whose data should be made writable.
4703 * @return 0 on success, a negative AVERROR on failure. On failure, the
4704 * packet is unchanged.
4706 int av_packet_make_writable(AVPacket *pkt);
4709 * Convert valid timing fields (timestamps / durations) in a packet from one
4710 * timebase to another. Timestamps with unknown values (AV_NOPTS_VALUE) will be
4713 * @param pkt packet on which the conversion will be performed
4714 * @param tb_src source timebase, in which the timing fields in pkt are
4716 * @param tb_dst destination timebase, to which the timing fields will be
4719 void av_packet_rescale_ts(AVPacket *pkt, AVRational tb_src, AVRational tb_dst);
4726 * @addtogroup lavc_decoding
4731 * Find a registered decoder with a matching codec ID.
4733 * @param id AVCodecID of the requested decoder
4734 * @return A decoder if one was found, NULL otherwise.
4736 AVCodec *avcodec_find_decoder(enum AVCodecID id);
4739 * Find a registered decoder with the specified name.
4741 * @param name name of the requested decoder
4742 * @return A decoder if one was found, NULL otherwise.
4744 AVCodec *avcodec_find_decoder_by_name(const char *name);
4747 * The default callback for AVCodecContext.get_buffer2(). It is made public so
4748 * it can be called by custom get_buffer2() implementations for decoders without
4749 * AV_CODEC_CAP_DR1 set.
4751 int avcodec_default_get_buffer2(AVCodecContext *s, AVFrame *frame, int flags);
4754 * Modify width and height values so that they will result in a memory
4755 * buffer that is acceptable for the codec if you do not use any horizontal
4758 * May only be used if a codec with AV_CODEC_CAP_DR1 has been opened.
4760 void avcodec_align_dimensions(AVCodecContext *s, int *width, int *height);
4763 * Modify width and height values so that they will result in a memory
4764 * buffer that is acceptable for the codec if you also ensure that all
4765 * line sizes are a multiple of the respective linesize_align[i].
4767 * May only be used if a codec with AV_CODEC_CAP_DR1 has been opened.
4769 void avcodec_align_dimensions2(AVCodecContext *s, int *width, int *height,
4770 int linesize_align[AV_NUM_DATA_POINTERS]);
4773 * Converts AVChromaLocation to swscale x/y chroma position.
4775 * The positions represent the chroma (0,0) position in a coordinates system
4776 * with luma (0,0) representing the origin and luma(1,1) representing 256,256
4778 * @param xpos horizontal chroma sample position
4779 * @param ypos vertical chroma sample position
4781 int avcodec_enum_to_chroma_pos(int *xpos, int *ypos, enum AVChromaLocation pos);
4784 * Converts swscale x/y chroma position to AVChromaLocation.
4786 * The positions represent the chroma (0,0) position in a coordinates system
4787 * with luma (0,0) representing the origin and luma(1,1) representing 256,256
4789 * @param xpos horizontal chroma sample position
4790 * @param ypos vertical chroma sample position
4792 enum AVChromaLocation avcodec_chroma_pos_to_enum(int xpos, int ypos);
4795 * Decode the audio frame of size avpkt->size from avpkt->data into frame.
4797 * Some decoders may support multiple frames in a single AVPacket. Such
4798 * decoders would then just decode the first frame and the return value would be
4799 * less than the packet size. In this case, avcodec_decode_audio4 has to be
4800 * called again with an AVPacket containing the remaining data in order to
4801 * decode the second frame, etc... Even if no frames are returned, the packet
4802 * needs to be fed to the decoder with remaining data until it is completely
4803 * consumed or an error occurs.
4805 * Some decoders (those marked with AV_CODEC_CAP_DELAY) have a delay between input
4806 * and output. This means that for some packets they will not immediately
4807 * produce decoded output and need to be flushed at the end of decoding to get
4808 * all the decoded data. Flushing is done by calling this function with packets
4809 * with avpkt->data set to NULL and avpkt->size set to 0 until it stops
4810 * returning samples. It is safe to flush even those decoders that are not
4811 * marked with AV_CODEC_CAP_DELAY, then no samples will be returned.
4813 * @warning The input buffer, avpkt->data must be AV_INPUT_BUFFER_PADDING_SIZE
4814 * larger than the actual read bytes because some optimized bitstream
4815 * readers read 32 or 64 bits at once and could read over the end.
4817 * @note The AVCodecContext MUST have been opened with @ref avcodec_open2()
4818 * before packets may be fed to the decoder.
4820 * @param avctx the codec context
4821 * @param[out] frame The AVFrame in which to store decoded audio samples.
4822 * The decoder will allocate a buffer for the decoded frame by
4823 * calling the AVCodecContext.get_buffer2() callback.
4824 * When AVCodecContext.refcounted_frames is set to 1, the frame is
4825 * reference counted and the returned reference belongs to the
4826 * caller. The caller must release the frame using av_frame_unref()
4827 * when the frame is no longer needed. The caller may safely write
4828 * to the frame if av_frame_is_writable() returns 1.
4829 * When AVCodecContext.refcounted_frames is set to 0, the returned
4830 * reference belongs to the decoder and is valid only until the
4831 * next call to this function or until closing or flushing the
4832 * decoder. The caller may not write to it.
4833 * @param[out] got_frame_ptr Zero if no frame could be decoded, otherwise it is
4834 * non-zero. Note that this field being set to zero
4835 * does not mean that an error has occurred. For
4836 * decoders with AV_CODEC_CAP_DELAY set, no given decode
4837 * call is guaranteed to produce a frame.
4838 * @param[in] avpkt The input AVPacket containing the input buffer.
4839 * At least avpkt->data and avpkt->size should be set. Some
4840 * decoders might also require additional fields to be set.
4841 * @return A negative error code is returned if an error occurred during
4842 * decoding, otherwise the number of bytes consumed from the input
4843 * AVPacket is returned.
4845 * @deprecated Use avcodec_send_packet() and avcodec_receive_frame().
4847 attribute_deprecated
4848 int avcodec_decode_audio4(AVCodecContext *avctx, AVFrame *frame,
4849 int *got_frame_ptr, const AVPacket *avpkt);
4852 * Decode the video frame of size avpkt->size from avpkt->data into picture.
4853 * Some decoders may support multiple frames in a single AVPacket, such
4854 * decoders would then just decode the first frame.
4856 * @warning The input buffer must be AV_INPUT_BUFFER_PADDING_SIZE larger than
4857 * the actual read bytes because some optimized bitstream readers read 32 or 64
4858 * bits at once and could read over the end.
4860 * @warning The end of the input buffer buf should be set to 0 to ensure that
4861 * no overreading happens for damaged MPEG streams.
4863 * @note Codecs which have the AV_CODEC_CAP_DELAY capability set have a delay
4864 * between input and output, these need to be fed with avpkt->data=NULL,
4865 * avpkt->size=0 at the end to return the remaining frames.
4867 * @note The AVCodecContext MUST have been opened with @ref avcodec_open2()
4868 * before packets may be fed to the decoder.
4870 * @param avctx the codec context
4871 * @param[out] picture The AVFrame in which the decoded video frame will be stored.
4872 * Use av_frame_alloc() to get an AVFrame. The codec will
4873 * allocate memory for the actual bitmap by calling the
4874 * AVCodecContext.get_buffer2() callback.
4875 * When AVCodecContext.refcounted_frames is set to 1, the frame is
4876 * reference counted and the returned reference belongs to the
4877 * caller. The caller must release the frame using av_frame_unref()
4878 * when the frame is no longer needed. The caller may safely write
4879 * to the frame if av_frame_is_writable() returns 1.
4880 * When AVCodecContext.refcounted_frames is set to 0, the returned
4881 * reference belongs to the decoder and is valid only until the
4882 * next call to this function or until closing or flushing the
4883 * decoder. The caller may not write to it.
4885 * @param[in] avpkt The input AVPacket containing the input buffer.
4886 * You can create such packet with av_init_packet() and by then setting
4887 * data and size, some decoders might in addition need other fields like
4888 * flags&AV_PKT_FLAG_KEY. All decoders are designed to use the least
4890 * @param[in,out] got_picture_ptr Zero if no frame could be decompressed, otherwise, it is nonzero.
4891 * @return On error a negative value is returned, otherwise the number of bytes
4892 * used or zero if no frame could be decompressed.
4894 * @deprecated Use avcodec_send_packet() and avcodec_receive_frame().
4896 attribute_deprecated
4897 int avcodec_decode_video2(AVCodecContext *avctx, AVFrame *picture,
4898 int *got_picture_ptr,
4899 const AVPacket *avpkt);
4902 * Decode a subtitle message.
4903 * Return a negative value on error, otherwise return the number of bytes used.
4904 * If no subtitle could be decompressed, got_sub_ptr is zero.
4905 * Otherwise, the subtitle is stored in *sub.
4906 * Note that AV_CODEC_CAP_DR1 is not available for subtitle codecs. This is for
4907 * simplicity, because the performance difference is expected to be negligible
4908 * and reusing a get_buffer written for video codecs would probably perform badly
4909 * due to a potentially very different allocation pattern.
4911 * Some decoders (those marked with AV_CODEC_CAP_DELAY) have a delay between input
4912 * and output. This means that for some packets they will not immediately
4913 * produce decoded output and need to be flushed at the end of decoding to get
4914 * all the decoded data. Flushing is done by calling this function with packets
4915 * with avpkt->data set to NULL and avpkt->size set to 0 until it stops
4916 * returning subtitles. It is safe to flush even those decoders that are not
4917 * marked with AV_CODEC_CAP_DELAY, then no subtitles will be returned.
4919 * @note The AVCodecContext MUST have been opened with @ref avcodec_open2()
4920 * before packets may be fed to the decoder.
4922 * @param avctx the codec context
4923 * @param[out] sub The preallocated AVSubtitle in which the decoded subtitle will be stored,
4924 * must be freed with avsubtitle_free if *got_sub_ptr is set.
4925 * @param[in,out] got_sub_ptr Zero if no subtitle could be decompressed, otherwise, it is nonzero.
4926 * @param[in] avpkt The input AVPacket containing the input buffer.
4928 int avcodec_decode_subtitle2(AVCodecContext *avctx, AVSubtitle *sub,
4933 * Supply raw packet data as input to a decoder.
4935 * Internally, this call will copy relevant AVCodecContext fields, which can
4936 * influence decoding per-packet, and apply them when the packet is actually
4937 * decoded. (For example AVCodecContext.skip_frame, which might direct the
4938 * decoder to drop the frame contained by the packet sent with this function.)
4940 * @warning The input buffer, avpkt->data must be AV_INPUT_BUFFER_PADDING_SIZE
4941 * larger than the actual read bytes because some optimized bitstream
4942 * readers read 32 or 64 bits at once and could read over the end.
4944 * @warning Do not mix this API with the legacy API (like avcodec_decode_video2())
4945 * on the same AVCodecContext. It will return unexpected results now
4946 * or in future libavcodec versions.
4948 * @note The AVCodecContext MUST have been opened with @ref avcodec_open2()
4949 * before packets may be fed to the decoder.
4951 * @param avctx codec context
4952 * @param[in] avpkt The input AVPacket. Usually, this will be a single video
4953 * frame, or several complete audio frames.
4954 * Ownership of the packet remains with the caller, and the
4955 * decoder will not write to the packet. The decoder may create
4956 * a reference to the packet data (or copy it if the packet is
4957 * not reference-counted).
4958 * Unlike with older APIs, the packet is always fully consumed,
4959 * and if it contains multiple frames (e.g. some audio codecs),
4960 * will require you to call avcodec_receive_frame() multiple
4961 * times afterwards before you can send a new packet.
4962 * It can be NULL (or an AVPacket with data set to NULL and
4963 * size set to 0); in this case, it is considered a flush
4964 * packet, which signals the end of the stream. Sending the
4965 * first flush packet will return success. Subsequent ones are
4966 * unnecessary and will return AVERROR_EOF. If the decoder
4967 * still has frames buffered, it will return them after sending
4970 * @return 0 on success, otherwise negative error code:
4971 * AVERROR(EAGAIN): input is not accepted in the current state - user
4972 * must read output with avcodec_receive_frame() (once
4973 * all output is read, the packet should be resent, and
4974 * the call will not fail with EAGAIN).
4975 * AVERROR_EOF: the decoder has been flushed, and no new packets can
4976 * be sent to it (also returned if more than 1 flush
4978 * AVERROR(EINVAL): codec not opened, it is an encoder, or requires flush
4979 * AVERROR(ENOMEM): failed to add packet to internal queue, or similar
4980 * other errors: legitimate decoding errors
4982 int avcodec_send_packet(AVCodecContext *avctx, const AVPacket *avpkt);
4985 * Return decoded output data from a decoder.
4987 * @param avctx codec context
4988 * @param frame This will be set to a reference-counted video or audio
4989 * frame (depending on the decoder type) allocated by the
4990 * decoder. Note that the function will always call
4991 * av_frame_unref(frame) before doing anything else.
4994 * 0: success, a frame was returned
4995 * AVERROR(EAGAIN): output is not available in this state - user must try
4997 * AVERROR_EOF: the decoder has been fully flushed, and there will be
4998 * no more output frames
4999 * AVERROR(EINVAL): codec not opened, or it is an encoder
5000 * AVERROR_INPUT_CHANGED: current decoded frame has changed parameters
5001 * with respect to first decoded frame. Applicable
5002 * when flag AV_CODEC_FLAG_DROPCHANGED is set.
5003 * other negative values: legitimate decoding errors
5005 int avcodec_receive_frame(AVCodecContext *avctx, AVFrame *frame);
5008 * Supply a raw video or audio frame to the encoder. Use avcodec_receive_packet()
5009 * to retrieve buffered output packets.
5011 * @param avctx codec context
5012 * @param[in] frame AVFrame containing the raw audio or video frame to be encoded.
5013 * Ownership of the frame remains with the caller, and the
5014 * encoder will not write to the frame. The encoder may create
5015 * a reference to the frame data (or copy it if the frame is
5016 * not reference-counted).
5017 * It can be NULL, in which case it is considered a flush
5018 * packet. This signals the end of the stream. If the encoder
5019 * still has packets buffered, it will return them after this
5020 * call. Once flushing mode has been entered, additional flush
5021 * packets are ignored, and sending frames will return
5025 * If AV_CODEC_CAP_VARIABLE_FRAME_SIZE is set, then each frame
5026 * can have any number of samples.
5027 * If it is not set, frame->nb_samples must be equal to
5028 * avctx->frame_size for all frames except the last.
5029 * The final frame may be smaller than avctx->frame_size.
5030 * @return 0 on success, otherwise negative error code:
5031 * AVERROR(EAGAIN): input is not accepted in the current state - user
5032 * must read output with avcodec_receive_packet() (once
5033 * all output is read, the packet should be resent, and
5034 * the call will not fail with EAGAIN).
5035 * AVERROR_EOF: the encoder has been flushed, and no new frames can
5037 * AVERROR(EINVAL): codec not opened, refcounted_frames not set, it is a
5038 * decoder, or requires flush
5039 * AVERROR(ENOMEM): failed to add packet to internal queue, or similar
5040 * other errors: legitimate decoding errors
5042 int avcodec_send_frame(AVCodecContext *avctx, const AVFrame *frame);
5045 * Read encoded data from the encoder.
5047 * @param avctx codec context
5048 * @param avpkt This will be set to a reference-counted packet allocated by the
5049 * encoder. Note that the function will always call
5050 * av_packet_unref(avpkt) before doing anything else.
5051 * @return 0 on success, otherwise negative error code:
5052 * AVERROR(EAGAIN): output is not available in the current state - user
5053 * must try to send input
5054 * AVERROR_EOF: the encoder has been fully flushed, and there will be
5055 * no more output packets
5056 * AVERROR(EINVAL): codec not opened, or it is an encoder
5057 * other errors: legitimate decoding errors
5059 int avcodec_receive_packet(AVCodecContext *avctx, AVPacket *avpkt);
5062 * Create and return a AVHWFramesContext with values adequate for hardware
5063 * decoding. This is meant to get called from the get_format callback, and is
5064 * a helper for preparing a AVHWFramesContext for AVCodecContext.hw_frames_ctx.
5065 * This API is for decoding with certain hardware acceleration modes/APIs only.
5067 * The returned AVHWFramesContext is not initialized. The caller must do this
5068 * with av_hwframe_ctx_init().
5070 * Calling this function is not a requirement, but makes it simpler to avoid
5071 * codec or hardware API specific details when manually allocating frames.
5073 * Alternatively to this, an API user can set AVCodecContext.hw_device_ctx,
5074 * which sets up AVCodecContext.hw_frames_ctx fully automatically, and makes
5075 * it unnecessary to call this function or having to care about
5076 * AVHWFramesContext initialization at all.
5078 * There are a number of requirements for calling this function:
5080 * - It must be called from get_format with the same avctx parameter that was
5081 * passed to get_format. Calling it outside of get_format is not allowed, and
5082 * can trigger undefined behavior.
5083 * - The function is not always supported (see description of return values).
5084 * Even if this function returns successfully, hwaccel initialization could
5085 * fail later. (The degree to which implementations check whether the stream
5086 * is actually supported varies. Some do this check only after the user's
5087 * get_format callback returns.)
5088 * - The hw_pix_fmt must be one of the choices suggested by get_format. If the
5089 * user decides to use a AVHWFramesContext prepared with this API function,
5090 * the user must return the same hw_pix_fmt from get_format.
5091 * - The device_ref passed to this function must support the given hw_pix_fmt.
5092 * - After calling this API function, it is the user's responsibility to
5093 * initialize the AVHWFramesContext (returned by the out_frames_ref parameter),
5094 * and to set AVCodecContext.hw_frames_ctx to it. If done, this must be done
5095 * before returning from get_format (this is implied by the normal
5096 * AVCodecContext.hw_frames_ctx API rules).
5097 * - The AVHWFramesContext parameters may change every time time get_format is
5098 * called. Also, AVCodecContext.hw_frames_ctx is reset before get_format. So
5099 * you are inherently required to go through this process again on every
5101 * - It is perfectly possible to call this function without actually using
5102 * the resulting AVHWFramesContext. One use-case might be trying to reuse a
5103 * previously initialized AVHWFramesContext, and calling this API function
5104 * only to test whether the required frame parameters have changed.
5105 * - Fields that use dynamically allocated values of any kind must not be set
5106 * by the user unless setting them is explicitly allowed by the documentation.
5107 * If the user sets AVHWFramesContext.free and AVHWFramesContext.user_opaque,
5108 * the new free callback must call the potentially set previous free callback.
5109 * This API call may set any dynamically allocated fields, including the free
5112 * The function will set at least the following fields on AVHWFramesContext
5113 * (potentially more, depending on hwaccel API):
5115 * - All fields set by av_hwframe_ctx_alloc().
5116 * - Set the format field to hw_pix_fmt.
5117 * - Set the sw_format field to the most suited and most versatile format. (An
5118 * implication is that this will prefer generic formats over opaque formats
5119 * with arbitrary restrictions, if possible.)
5120 * - Set the width/height fields to the coded frame size, rounded up to the
5121 * API-specific minimum alignment.
5122 * - Only _if_ the hwaccel requires a pre-allocated pool: set the initial_pool_size
5123 * field to the number of maximum reference surfaces possible with the codec,
5124 * plus 1 surface for the user to work (meaning the user can safely reference
5125 * at most 1 decoded surface at a time), plus additional buffering introduced
5126 * by frame threading. If the hwaccel does not require pre-allocation, the
5127 * field is left to 0, and the decoder will allocate new surfaces on demand
5129 * - Possibly AVHWFramesContext.hwctx fields, depending on the underlying
5132 * Essentially, out_frames_ref returns the same as av_hwframe_ctx_alloc(), but
5133 * with basic frame parameters set.
5135 * The function is stateless, and does not change the AVCodecContext or the
5136 * device_ref AVHWDeviceContext.
5138 * @param avctx The context which is currently calling get_format, and which
5139 * implicitly contains all state needed for filling the returned
5140 * AVHWFramesContext properly.
5141 * @param device_ref A reference to the AVHWDeviceContext describing the device
5142 * which will be used by the hardware decoder.
5143 * @param hw_pix_fmt The hwaccel format you are going to return from get_format.
5144 * @param out_frames_ref On success, set to a reference to an _uninitialized_
5145 * AVHWFramesContext, created from the given device_ref.
5146 * Fields will be set to values required for decoding.
5147 * Not changed if an error is returned.
5148 * @return zero on success, a negative value on error. The following error codes
5149 * have special semantics:
5150 * AVERROR(ENOENT): the decoder does not support this functionality. Setup
5151 * is always manual, or it is a decoder which does not
5152 * support setting AVCodecContext.hw_frames_ctx at all,
5153 * or it is a software format.
5154 * AVERROR(EINVAL): it is known that hardware decoding is not supported for
5155 * this configuration, or the device_ref is not supported
5156 * for the hwaccel referenced by hw_pix_fmt.
5158 int avcodec_get_hw_frames_parameters(AVCodecContext *avctx,
5159 AVBufferRef *device_ref,
5160 enum AVPixelFormat hw_pix_fmt,
5161 AVBufferRef **out_frames_ref);
5166 * @defgroup lavc_parsing Frame parsing
5170 enum AVPictureStructure {
5171 AV_PICTURE_STRUCTURE_UNKNOWN, //< unknown
5172 AV_PICTURE_STRUCTURE_TOP_FIELD, //< coded as top field
5173 AV_PICTURE_STRUCTURE_BOTTOM_FIELD, //< coded as bottom field
5174 AV_PICTURE_STRUCTURE_FRAME, //< coded as frame
5177 typedef struct AVCodecParserContext {
5179 struct AVCodecParser *parser;
5180 int64_t frame_offset; /* offset of the current frame */
5181 int64_t cur_offset; /* current offset
5182 (incremented by each av_parser_parse()) */
5183 int64_t next_frame_offset; /* offset of the next frame */
5185 int pict_type; /* XXX: Put it back in AVCodecContext. */
5187 * This field is used for proper frame duration computation in lavf.
5188 * It signals, how much longer the frame duration of the current frame
5189 * is compared to normal frame duration.
5191 * frame_duration = (1 + repeat_pict) * time_base
5193 * It is used by codecs like H.264 to display telecined material.
5195 int repeat_pict; /* XXX: Put it back in AVCodecContext. */
5196 int64_t pts; /* pts of the current frame */
5197 int64_t dts; /* dts of the current frame */
5202 int fetch_timestamp;
5204 #define AV_PARSER_PTS_NB 4
5205 int cur_frame_start_index;
5206 int64_t cur_frame_offset[AV_PARSER_PTS_NB];
5207 int64_t cur_frame_pts[AV_PARSER_PTS_NB];
5208 int64_t cur_frame_dts[AV_PARSER_PTS_NB];
5211 #define PARSER_FLAG_COMPLETE_FRAMES 0x0001
5212 #define PARSER_FLAG_ONCE 0x0002
5213 /// Set if the parser has a valid file offset
5214 #define PARSER_FLAG_FETCHED_OFFSET 0x0004
5215 #define PARSER_FLAG_USE_CODEC_TS 0x1000
5217 int64_t offset; ///< byte offset from starting packet start
5218 int64_t cur_frame_end[AV_PARSER_PTS_NB];
5221 * Set by parser to 1 for key frames and 0 for non-key frames.
5222 * It is initialized to -1, so if the parser doesn't set this flag,
5223 * old-style fallback using AV_PICTURE_TYPE_I picture type as key frames
5228 #if FF_API_CONVERGENCE_DURATION
5230 * @deprecated unused
5232 attribute_deprecated
5233 int64_t convergence_duration;
5236 // Timestamp generation support:
5238 * Synchronization point for start of timestamp generation.
5240 * Set to >0 for sync point, 0 for no sync point and <0 for undefined
5243 * For example, this corresponds to presence of H.264 buffering period
5249 * Offset of the current timestamp against last timestamp sync point in
5250 * units of AVCodecContext.time_base.
5252 * Set to INT_MIN when dts_sync_point unused. Otherwise, it must
5253 * contain a valid timestamp offset.
5255 * Note that the timestamp of sync point has usually a nonzero
5256 * dts_ref_dts_delta, which refers to the previous sync point. Offset of
5257 * the next frame after timestamp sync point will be usually 1.
5259 * For example, this corresponds to H.264 cpb_removal_delay.
5261 int dts_ref_dts_delta;
5264 * Presentation delay of current frame in units of AVCodecContext.time_base.
5266 * Set to INT_MIN when dts_sync_point unused. Otherwise, it must
5267 * contain valid non-negative timestamp delta (presentation time of a frame
5268 * must not lie in the past).
5270 * This delay represents the difference between decoding and presentation
5271 * time of the frame.
5273 * For example, this corresponds to H.264 dpb_output_delay.
5278 * Position of the packet in file.
5280 * Analogous to cur_frame_pts/dts
5282 int64_t cur_frame_pos[AV_PARSER_PTS_NB];
5285 * Byte position of currently parsed frame in stream.
5290 * Previous frame byte position.
5295 * Duration of the current frame.
5296 * For audio, this is in units of 1 / AVCodecContext.sample_rate.
5297 * For all other types, this is in units of AVCodecContext.time_base.
5301 enum AVFieldOrder field_order;
5304 * Indicate whether a picture is coded as a frame, top field or bottom field.
5306 * For example, H.264 field_pic_flag equal to 0 corresponds to
5307 * AV_PICTURE_STRUCTURE_FRAME. An H.264 picture with field_pic_flag
5308 * equal to 1 and bottom_field_flag equal to 0 corresponds to
5309 * AV_PICTURE_STRUCTURE_TOP_FIELD.
5311 enum AVPictureStructure picture_structure;
5314 * Picture number incremented in presentation or output order.
5315 * This field may be reinitialized at the first picture of a new sequence.
5317 * For example, this corresponds to H.264 PicOrderCnt.
5319 int output_picture_number;
5322 * Dimensions of the decoded video intended for presentation.
5328 * Dimensions of the coded video.
5334 * The format of the coded data, corresponds to enum AVPixelFormat for video
5335 * and for enum AVSampleFormat for audio.
5337 * Note that a decoder can have considerable freedom in how exactly it
5338 * decodes the data, so the format reported here might be different from the
5339 * one returned by a decoder.
5342 } AVCodecParserContext;
5344 typedef struct AVCodecParser {
5345 int codec_ids[5]; /* several codec IDs are permitted */
5347 int (*parser_init)(AVCodecParserContext *s);
5348 /* This callback never returns an error, a negative value means that
5349 * the frame start was in a previous packet. */
5350 int (*parser_parse)(AVCodecParserContext *s,
5351 AVCodecContext *avctx,
5352 const uint8_t **poutbuf, int *poutbuf_size,
5353 const uint8_t *buf, int buf_size);
5354 void (*parser_close)(AVCodecParserContext *s);
5355 int (*split)(AVCodecContext *avctx, const uint8_t *buf, int buf_size);
5356 struct AVCodecParser *next;
5360 * Iterate over all registered codec parsers.
5362 * @param opaque a pointer where libavcodec will store the iteration state. Must
5363 * point to NULL to start the iteration.
5365 * @return the next registered codec parser or NULL when the iteration is
5368 const AVCodecParser *av_parser_iterate(void **opaque);
5370 attribute_deprecated
5371 AVCodecParser *av_parser_next(const AVCodecParser *c);
5373 attribute_deprecated
5374 void av_register_codec_parser(AVCodecParser *parser);
5375 AVCodecParserContext *av_parser_init(int codec_id);
5380 * @param s parser context.
5381 * @param avctx codec context.
5382 * @param poutbuf set to pointer to parsed buffer or NULL if not yet finished.
5383 * @param poutbuf_size set to size of parsed buffer or zero if not yet finished.
5384 * @param buf input buffer.
5385 * @param buf_size buffer size in bytes without the padding. I.e. the full buffer
5386 size is assumed to be buf_size + AV_INPUT_BUFFER_PADDING_SIZE.
5387 To signal EOF, this should be 0 (so that the last frame
5389 * @param pts input presentation timestamp.
5390 * @param dts input decoding timestamp.
5391 * @param pos input byte position in stream.
5392 * @return the number of bytes of the input bitstream used.
5397 * len = av_parser_parse2(myparser, AVCodecContext, &data, &size,
5404 * decode_frame(data, size);
5408 int av_parser_parse2(AVCodecParserContext *s,
5409 AVCodecContext *avctx,
5410 uint8_t **poutbuf, int *poutbuf_size,
5411 const uint8_t *buf, int buf_size,
5412 int64_t pts, int64_t dts,
5416 * @return 0 if the output buffer is a subset of the input, 1 if it is allocated and must be freed
5417 * @deprecated use AVBitStreamFilter
5419 int av_parser_change(AVCodecParserContext *s,
5420 AVCodecContext *avctx,
5421 uint8_t **poutbuf, int *poutbuf_size,
5422 const uint8_t *buf, int buf_size, int keyframe);
5423 void av_parser_close(AVCodecParserContext *s);
5431 * @addtogroup lavc_encoding
5436 * Find a registered encoder with a matching codec ID.
5438 * @param id AVCodecID of the requested encoder
5439 * @return An encoder if one was found, NULL otherwise.
5441 AVCodec *avcodec_find_encoder(enum AVCodecID id);
5444 * Find a registered encoder with the specified name.
5446 * @param name name of the requested encoder
5447 * @return An encoder if one was found, NULL otherwise.
5449 AVCodec *avcodec_find_encoder_by_name(const char *name);
5452 * Encode a frame of audio.
5454 * Takes input samples from frame and writes the next output packet, if
5455 * available, to avpkt. The output packet does not necessarily contain data for
5456 * the most recent frame, as encoders can delay, split, and combine input frames
5457 * internally as needed.
5459 * @param avctx codec context
5460 * @param avpkt output AVPacket.
5461 * The user can supply an output buffer by setting
5462 * avpkt->data and avpkt->size prior to calling the
5463 * function, but if the size of the user-provided data is not
5464 * large enough, encoding will fail. If avpkt->data and
5465 * avpkt->size are set, avpkt->destruct must also be set. All
5466 * other AVPacket fields will be reset by the encoder using
5467 * av_init_packet(). If avpkt->data is NULL, the encoder will
5468 * allocate it. The encoder will set avpkt->size to the size
5469 * of the output packet.
5471 * If this function fails or produces no output, avpkt will be
5472 * freed using av_packet_unref().
5473 * @param[in] frame AVFrame containing the raw audio data to be encoded.
5474 * May be NULL when flushing an encoder that has the
5475 * AV_CODEC_CAP_DELAY capability set.
5476 * If AV_CODEC_CAP_VARIABLE_FRAME_SIZE is set, then each frame
5477 * can have any number of samples.
5478 * If it is not set, frame->nb_samples must be equal to
5479 * avctx->frame_size for all frames except the last.
5480 * The final frame may be smaller than avctx->frame_size.
5481 * @param[out] got_packet_ptr This field is set to 1 by libavcodec if the
5482 * output packet is non-empty, and to 0 if it is
5483 * empty. If the function returns an error, the
5484 * packet can be assumed to be invalid, and the
5485 * value of got_packet_ptr is undefined and should
5487 * @return 0 on success, negative error code on failure
5489 * @deprecated use avcodec_send_frame()/avcodec_receive_packet() instead
5491 attribute_deprecated
5492 int avcodec_encode_audio2(AVCodecContext *avctx, AVPacket *avpkt,
5493 const AVFrame *frame, int *got_packet_ptr);
5496 * Encode a frame of video.
5498 * Takes input raw video data from frame and writes the next output packet, if
5499 * available, to avpkt. The output packet does not necessarily contain data for
5500 * the most recent frame, as encoders can delay and reorder input frames
5501 * internally as needed.
5503 * @param avctx codec context
5504 * @param avpkt output AVPacket.
5505 * The user can supply an output buffer by setting
5506 * avpkt->data and avpkt->size prior to calling the
5507 * function, but if the size of the user-provided data is not
5508 * large enough, encoding will fail. All other AVPacket fields
5509 * will be reset by the encoder using av_init_packet(). If
5510 * avpkt->data is NULL, the encoder will allocate it.
5511 * The encoder will set avpkt->size to the size of the
5512 * output packet. The returned data (if any) belongs to the
5513 * caller, he is responsible for freeing it.
5515 * If this function fails or produces no output, avpkt will be
5516 * freed using av_packet_unref().
5517 * @param[in] frame AVFrame containing the raw video data to be encoded.
5518 * May be NULL when flushing an encoder that has the
5519 * AV_CODEC_CAP_DELAY capability set.
5520 * @param[out] got_packet_ptr This field is set to 1 by libavcodec if the
5521 * output packet is non-empty, and to 0 if it is
5522 * empty. If the function returns an error, the
5523 * packet can be assumed to be invalid, and the
5524 * value of got_packet_ptr is undefined and should
5526 * @return 0 on success, negative error code on failure
5528 * @deprecated use avcodec_send_frame()/avcodec_receive_packet() instead
5530 attribute_deprecated
5531 int avcodec_encode_video2(AVCodecContext *avctx, AVPacket *avpkt,
5532 const AVFrame *frame, int *got_packet_ptr);
5534 int avcodec_encode_subtitle(AVCodecContext *avctx, uint8_t *buf, int buf_size,
5535 const AVSubtitle *sub);
5542 #if FF_API_AVPICTURE
5544 * @addtogroup lavc_picture
5549 * @deprecated unused
5551 attribute_deprecated
5552 int avpicture_alloc(AVPicture *picture, enum AVPixelFormat pix_fmt, int width, int height);
5555 * @deprecated unused
5557 attribute_deprecated
5558 void avpicture_free(AVPicture *picture);
5561 * @deprecated use av_image_fill_arrays() instead.
5563 attribute_deprecated
5564 int avpicture_fill(AVPicture *picture, const uint8_t *ptr,
5565 enum AVPixelFormat pix_fmt, int width, int height);
5568 * @deprecated use av_image_copy_to_buffer() instead.
5570 attribute_deprecated
5571 int avpicture_layout(const AVPicture *src, enum AVPixelFormat pix_fmt,
5572 int width, int height,
5573 unsigned char *dest, int dest_size);
5576 * @deprecated use av_image_get_buffer_size() instead.
5578 attribute_deprecated
5579 int avpicture_get_size(enum AVPixelFormat pix_fmt, int width, int height);
5582 * @deprecated av_image_copy() instead.
5584 attribute_deprecated
5585 void av_picture_copy(AVPicture *dst, const AVPicture *src,
5586 enum AVPixelFormat pix_fmt, int width, int height);
5589 * @deprecated unused
5591 attribute_deprecated
5592 int av_picture_crop(AVPicture *dst, const AVPicture *src,
5593 enum AVPixelFormat pix_fmt, int top_band, int left_band);
5596 * @deprecated unused
5598 attribute_deprecated
5599 int av_picture_pad(AVPicture *dst, const AVPicture *src, int height, int width, enum AVPixelFormat pix_fmt,
5600 int padtop, int padbottom, int padleft, int padright, int *color);
5608 * @defgroup lavc_misc Utility functions
5611 * Miscellaneous utility functions related to both encoding and decoding
5617 * @defgroup lavc_misc_pixfmt Pixel formats
5619 * Functions for working with pixel formats.
5623 #if FF_API_GETCHROMA
5625 * @deprecated Use av_pix_fmt_get_chroma_sub_sample
5628 attribute_deprecated
5629 void avcodec_get_chroma_sub_sample(enum AVPixelFormat pix_fmt, int *h_shift, int *v_shift);
5633 * Return a value representing the fourCC code associated to the
5634 * pixel format pix_fmt, or 0 if no associated fourCC code can be
5637 unsigned int avcodec_pix_fmt_to_codec_tag(enum AVPixelFormat pix_fmt);
5640 * @deprecated see av_get_pix_fmt_loss()
5642 int avcodec_get_pix_fmt_loss(enum AVPixelFormat dst_pix_fmt, enum AVPixelFormat src_pix_fmt,
5646 * Find the best pixel format to convert to given a certain source pixel
5647 * format. When converting from one pixel format to another, information loss
5648 * may occur. For example, when converting from RGB24 to GRAY, the color
5649 * information will be lost. Similarly, other losses occur when converting from
5650 * some formats to other formats. avcodec_find_best_pix_fmt_of_2() searches which of
5651 * the given pixel formats should be used to suffer the least amount of loss.
5652 * The pixel formats from which it chooses one, are determined by the
5653 * pix_fmt_list parameter.
5656 * @param[in] pix_fmt_list AV_PIX_FMT_NONE terminated array of pixel formats to choose from
5657 * @param[in] src_pix_fmt source pixel format
5658 * @param[in] has_alpha Whether the source pixel format alpha channel is used.
5659 * @param[out] loss_ptr Combination of flags informing you what kind of losses will occur.
5660 * @return The best pixel format to convert to or -1 if none was found.
5662 enum AVPixelFormat avcodec_find_best_pix_fmt_of_list(const enum AVPixelFormat *pix_fmt_list,
5663 enum AVPixelFormat src_pix_fmt,
5664 int has_alpha, int *loss_ptr);
5667 * @deprecated see av_find_best_pix_fmt_of_2()
5669 enum AVPixelFormat avcodec_find_best_pix_fmt_of_2(enum AVPixelFormat dst_pix_fmt1, enum AVPixelFormat dst_pix_fmt2,
5670 enum AVPixelFormat src_pix_fmt, int has_alpha, int *loss_ptr);
5672 attribute_deprecated
5673 enum AVPixelFormat avcodec_find_best_pix_fmt2(enum AVPixelFormat dst_pix_fmt1, enum AVPixelFormat dst_pix_fmt2,
5674 enum AVPixelFormat src_pix_fmt, int has_alpha, int *loss_ptr);
5676 enum AVPixelFormat avcodec_default_get_format(struct AVCodecContext *s, const enum AVPixelFormat * fmt);
5682 #if FF_API_TAG_STRING
5684 * Put a string representing the codec tag codec_tag in buf.
5686 * @param buf buffer to place codec tag in
5687 * @param buf_size size in bytes of buf
5688 * @param codec_tag codec tag to assign
5689 * @return the length of the string that would have been generated if
5690 * enough space had been available, excluding the trailing null
5692 * @deprecated see av_fourcc_make_string() and av_fourcc2str().
5694 attribute_deprecated
5695 size_t av_get_codec_tag_string(char *buf, size_t buf_size, unsigned int codec_tag);
5698 void avcodec_string(char *buf, int buf_size, AVCodecContext *enc, int encode);
5701 * Return a name for the specified profile, if available.
5703 * @param codec the codec that is searched for the given profile
5704 * @param profile the profile value for which a name is requested
5705 * @return A name for the profile if found, NULL otherwise.
5707 const char *av_get_profile_name(const AVCodec *codec, int profile);
5710 * Return a name for the specified profile, if available.
5712 * @param codec_id the ID of the codec to which the requested profile belongs
5713 * @param profile the profile value for which a name is requested
5714 * @return A name for the profile if found, NULL otherwise.
5716 * @note unlike av_get_profile_name(), which searches a list of profiles
5717 * supported by a specific decoder or encoder implementation, this
5718 * function searches the list of profiles from the AVCodecDescriptor
5720 const char *avcodec_profile_name(enum AVCodecID codec_id, int profile);
5722 int avcodec_default_execute(AVCodecContext *c, int (*func)(AVCodecContext *c2, void *arg2),void *arg, int *ret, int count, int size);
5723 int avcodec_default_execute2(AVCodecContext *c, int (*func)(AVCodecContext *c2, void *arg2, int, int),void *arg, int *ret, int count);
5724 //FIXME func typedef
5727 * Fill AVFrame audio data and linesize pointers.
5729 * The buffer buf must be a preallocated buffer with a size big enough
5730 * to contain the specified samples amount. The filled AVFrame data
5731 * pointers will point to this buffer.
5733 * AVFrame extended_data channel pointers are allocated if necessary for
5736 * @param frame the AVFrame
5737 * frame->nb_samples must be set prior to calling the
5738 * function. This function fills in frame->data,
5739 * frame->extended_data, frame->linesize[0].
5740 * @param nb_channels channel count
5741 * @param sample_fmt sample format
5742 * @param buf buffer to use for frame data
5743 * @param buf_size size of buffer
5744 * @param align plane size sample alignment (0 = default)
5745 * @return >=0 on success, negative error code on failure
5746 * @todo return the size in bytes required to store the samples in
5747 * case of success, at the next libavutil bump
5749 int avcodec_fill_audio_frame(AVFrame *frame, int nb_channels,
5750 enum AVSampleFormat sample_fmt, const uint8_t *buf,
5751 int buf_size, int align);
5754 * Reset the internal decoder state / flush internal buffers. Should be called
5755 * e.g. when seeking or when switching to a different stream.
5757 * @note when refcounted frames are not used (i.e. avctx->refcounted_frames is 0),
5758 * this invalidates the frames previously returned from the decoder. When
5759 * refcounted frames are used, the decoder just releases any references it might
5760 * keep internally, but the caller's reference remains valid.
5762 void avcodec_flush_buffers(AVCodecContext *avctx);
5765 * Return codec bits per sample.
5767 * @param[in] codec_id the codec
5768 * @return Number of bits per sample or zero if unknown for the given codec.
5770 int av_get_bits_per_sample(enum AVCodecID codec_id);
5773 * Return the PCM codec associated with a sample format.
5774 * @param be endianness, 0 for little, 1 for big,
5775 * -1 (or anything else) for native
5776 * @return AV_CODEC_ID_PCM_* or AV_CODEC_ID_NONE
5778 enum AVCodecID av_get_pcm_codec(enum AVSampleFormat fmt, int be);
5781 * Return codec bits per sample.
5782 * Only return non-zero if the bits per sample is exactly correct, not an
5785 * @param[in] codec_id the codec
5786 * @return Number of bits per sample or zero if unknown for the given codec.
5788 int av_get_exact_bits_per_sample(enum AVCodecID codec_id);
5791 * Return audio frame duration.
5793 * @param avctx codec context
5794 * @param frame_bytes size of the frame, or 0 if unknown
5795 * @return frame duration, in samples, if known. 0 if not able to
5798 int av_get_audio_frame_duration(AVCodecContext *avctx, int frame_bytes);
5801 * This function is the same as av_get_audio_frame_duration(), except it works
5802 * with AVCodecParameters instead of an AVCodecContext.
5804 int av_get_audio_frame_duration2(AVCodecParameters *par, int frame_bytes);
5807 typedef struct AVBitStreamFilterContext {
5809 const struct AVBitStreamFilter *filter;
5810 AVCodecParserContext *parser;
5811 struct AVBitStreamFilterContext *next;
5813 * Internal default arguments, used if NULL is passed to av_bitstream_filter_filter().
5814 * Not for access by library users.
5817 } AVBitStreamFilterContext;
5820 typedef struct AVBSFInternal AVBSFInternal;
5823 * The bitstream filter state.
5825 * This struct must be allocated with av_bsf_alloc() and freed with
5828 * The fields in the struct will only be changed (by the caller or by the
5829 * filter) as described in their documentation, and are to be considered
5830 * immutable otherwise.
5832 typedef struct AVBSFContext {
5834 * A class for logging and AVOptions
5836 const AVClass *av_class;
5839 * The bitstream filter this context is an instance of.
5841 const struct AVBitStreamFilter *filter;
5844 * Opaque libavcodec internal data. Must not be touched by the caller in any
5847 AVBSFInternal *internal;
5850 * Opaque filter-specific private data. If filter->priv_class is non-NULL,
5851 * this is an AVOptions-enabled struct.
5856 * Parameters of the input stream. This field is allocated in
5857 * av_bsf_alloc(), it needs to be filled by the caller before
5860 AVCodecParameters *par_in;
5863 * Parameters of the output stream. This field is allocated in
5864 * av_bsf_alloc(), it is set by the filter in av_bsf_init().
5866 AVCodecParameters *par_out;
5869 * The timebase used for the timestamps of the input packets. Set by the
5870 * caller before av_bsf_init().
5872 AVRational time_base_in;
5875 * The timebase used for the timestamps of the output packets. Set by the
5876 * filter in av_bsf_init().
5878 AVRational time_base_out;
5881 typedef struct AVBitStreamFilter {
5885 * A list of codec ids supported by the filter, terminated by
5887 * May be NULL, in that case the bitstream filter works with any codec id.
5889 const enum AVCodecID *codec_ids;
5892 * A class for the private data, used to declare bitstream filter private
5893 * AVOptions. This field is NULL for bitstream filters that do not declare
5896 * If this field is non-NULL, the first member of the filter private data
5897 * must be a pointer to AVClass, which will be set by libavcodec generic
5898 * code to this class.
5900 const AVClass *priv_class;
5902 /*****************************************************************
5903 * No fields below this line are part of the public API. They
5904 * may not be used outside of libavcodec and can be changed and
5906 * New public fields should be added right above.
5907 *****************************************************************
5911 int (*init)(AVBSFContext *ctx);
5912 int (*filter)(AVBSFContext *ctx, AVPacket *pkt);
5913 void (*close)(AVBSFContext *ctx);
5914 void (*flush)(AVBSFContext *ctx);
5915 } AVBitStreamFilter;
5919 * @deprecated the old bitstream filtering API (using AVBitStreamFilterContext)
5920 * is deprecated. Use the new bitstream filtering API (using AVBSFContext).
5922 attribute_deprecated
5923 void av_register_bitstream_filter(AVBitStreamFilter *bsf);
5925 * @deprecated the old bitstream filtering API (using AVBitStreamFilterContext)
5926 * is deprecated. Use av_bsf_get_by_name(), av_bsf_alloc(), and av_bsf_init()
5927 * from the new bitstream filtering API (using AVBSFContext).
5929 attribute_deprecated
5930 AVBitStreamFilterContext *av_bitstream_filter_init(const char *name);
5932 * @deprecated the old bitstream filtering API (using AVBitStreamFilterContext)
5933 * is deprecated. Use av_bsf_send_packet() and av_bsf_receive_packet() from the
5934 * new bitstream filtering API (using AVBSFContext).
5936 attribute_deprecated
5937 int av_bitstream_filter_filter(AVBitStreamFilterContext *bsfc,
5938 AVCodecContext *avctx, const char *args,
5939 uint8_t **poutbuf, int *poutbuf_size,
5940 const uint8_t *buf, int buf_size, int keyframe);
5942 * @deprecated the old bitstream filtering API (using AVBitStreamFilterContext)
5943 * is deprecated. Use av_bsf_free() from the new bitstream filtering API (using
5946 attribute_deprecated
5947 void av_bitstream_filter_close(AVBitStreamFilterContext *bsf);
5949 * @deprecated the old bitstream filtering API (using AVBitStreamFilterContext)
5950 * is deprecated. Use av_bsf_iterate() from the new bitstream filtering API (using
5953 attribute_deprecated
5954 const AVBitStreamFilter *av_bitstream_filter_next(const AVBitStreamFilter *f);
5958 * @return a bitstream filter with the specified name or NULL if no such
5959 * bitstream filter exists.
5961 const AVBitStreamFilter *av_bsf_get_by_name(const char *name);
5964 * Iterate over all registered bitstream filters.
5966 * @param opaque a pointer where libavcodec will store the iteration state. Must
5967 * point to NULL to start the iteration.
5969 * @return the next registered bitstream filter or NULL when the iteration is
5972 const AVBitStreamFilter *av_bsf_iterate(void **opaque);
5974 attribute_deprecated
5975 const AVBitStreamFilter *av_bsf_next(void **opaque);
5979 * Allocate a context for a given bitstream filter. The caller must fill in the
5980 * context parameters as described in the documentation and then call
5981 * av_bsf_init() before sending any data to the filter.
5983 * @param filter the filter for which to allocate an instance.
5984 * @param ctx a pointer into which the pointer to the newly-allocated context
5985 * will be written. It must be freed with av_bsf_free() after the
5986 * filtering is done.
5988 * @return 0 on success, a negative AVERROR code on failure
5990 int av_bsf_alloc(const AVBitStreamFilter *filter, AVBSFContext **ctx);
5993 * Prepare the filter for use, after all the parameters and options have been
5996 int av_bsf_init(AVBSFContext *ctx);
5999 * Submit a packet for filtering.
6001 * After sending each packet, the filter must be completely drained by calling
6002 * av_bsf_receive_packet() repeatedly until it returns AVERROR(EAGAIN) or
6005 * @param pkt the packet to filter. The bitstream filter will take ownership of
6006 * the packet and reset the contents of pkt. pkt is not touched if an error occurs.
6007 * If pkt is empty (i.e. NULL, or pkt->data is NULL and pkt->side_data_elems zero),
6008 * it signals the end of the stream (i.e. no more non-empty packets will be sent;
6009 * sending more empty packets does nothing) and will cause the filter to output
6010 * any packets it may have buffered internally.
6012 * @return 0 on success, a negative AVERROR on error. This function never fails if
6015 int av_bsf_send_packet(AVBSFContext *ctx, AVPacket *pkt);
6018 * Retrieve a filtered packet.
6020 * @param[out] pkt this struct will be filled with the contents of the filtered
6021 * packet. It is owned by the caller and must be freed using
6022 * av_packet_unref() when it is no longer needed.
6023 * This parameter should be "clean" (i.e. freshly allocated
6024 * with av_packet_alloc() or unreffed with av_packet_unref())
6025 * when this function is called. If this function returns
6026 * successfully, the contents of pkt will be completely
6027 * overwritten by the returned data. On failure, pkt is not
6030 * @return 0 on success. AVERROR(EAGAIN) if more packets need to be sent to the
6031 * filter (using av_bsf_send_packet()) to get more output. AVERROR_EOF if there
6032 * will be no further output from the filter. Another negative AVERROR value if
6035 * @note one input packet may result in several output packets, so after sending
6036 * a packet with av_bsf_send_packet(), this function needs to be called
6037 * repeatedly until it stops returning 0. It is also possible for a filter to
6038 * output fewer packets than were sent to it, so this function may return
6039 * AVERROR(EAGAIN) immediately after a successful av_bsf_send_packet() call.
6041 int av_bsf_receive_packet(AVBSFContext *ctx, AVPacket *pkt);
6044 * Reset the internal bitstream filter state / flush internal buffers.
6046 void av_bsf_flush(AVBSFContext *ctx);
6049 * Free a bitstream filter context and everything associated with it; write NULL
6050 * into the supplied pointer.
6052 void av_bsf_free(AVBSFContext **ctx);
6055 * Get the AVClass for AVBSFContext. It can be used in combination with
6056 * AV_OPT_SEARCH_FAKE_OBJ for examining options.
6058 * @see av_opt_find().
6060 const AVClass *av_bsf_get_class(void);
6063 * Structure for chain/list of bitstream filters.
6064 * Empty list can be allocated by av_bsf_list_alloc().
6066 typedef struct AVBSFList AVBSFList;
6069 * Allocate empty list of bitstream filters.
6070 * The list must be later freed by av_bsf_list_free()
6071 * or finalized by av_bsf_list_finalize().
6073 * @return Pointer to @ref AVBSFList on success, NULL in case of failure
6075 AVBSFList *av_bsf_list_alloc(void);
6078 * Free list of bitstream filters.
6080 * @param lst Pointer to pointer returned by av_bsf_list_alloc()
6082 void av_bsf_list_free(AVBSFList **lst);
6085 * Append bitstream filter to the list of bitstream filters.
6087 * @param lst List to append to
6088 * @param bsf Filter context to be appended
6090 * @return >=0 on success, negative AVERROR in case of failure
6092 int av_bsf_list_append(AVBSFList *lst, AVBSFContext *bsf);
6095 * Construct new bitstream filter context given it's name and options
6096 * and append it to the list of bitstream filters.
6098 * @param lst List to append to
6099 * @param bsf_name Name of the bitstream filter
6100 * @param options Options for the bitstream filter, can be set to NULL
6102 * @return >=0 on success, negative AVERROR in case of failure
6104 int av_bsf_list_append2(AVBSFList *lst, const char * bsf_name, AVDictionary **options);
6106 * Finalize list of bitstream filters.
6108 * This function will transform @ref AVBSFList to single @ref AVBSFContext,
6109 * so the whole chain of bitstream filters can be treated as single filter
6110 * freshly allocated by av_bsf_alloc().
6111 * If the call is successful, @ref AVBSFList structure is freed and lst
6112 * will be set to NULL. In case of failure, caller is responsible for
6113 * freeing the structure by av_bsf_list_free()
6115 * @param lst Filter list structure to be transformed
6116 * @param[out] bsf Pointer to be set to newly created @ref AVBSFContext structure
6117 * representing the chain of bitstream filters
6119 * @return >=0 on success, negative AVERROR in case of failure
6121 int av_bsf_list_finalize(AVBSFList **lst, AVBSFContext **bsf);
6124 * Parse string describing list of bitstream filters and create single
6125 * @ref AVBSFContext describing the whole chain of bitstream filters.
6126 * Resulting @ref AVBSFContext can be treated as any other @ref AVBSFContext freshly
6127 * allocated by av_bsf_alloc().
6129 * @param str String describing chain of bitstream filters in format
6130 * `bsf1[=opt1=val1:opt2=val2][,bsf2]`
6131 * @param[out] bsf Pointer to be set to newly created @ref AVBSFContext structure
6132 * representing the chain of bitstream filters
6134 * @return >=0 on success, negative AVERROR in case of failure
6136 int av_bsf_list_parse_str(const char *str, AVBSFContext **bsf);
6139 * Get null/pass-through bitstream filter.
6141 * @param[out] bsf Pointer to be set to new instance of pass-through bitstream filter
6145 int av_bsf_get_null_filter(AVBSFContext **bsf);
6150 * Same behaviour av_fast_malloc but the buffer has additional
6151 * AV_INPUT_BUFFER_PADDING_SIZE at the end which will always be 0.
6153 * In addition the whole buffer will initially and after resizes
6154 * be 0-initialized so that no uninitialized data will ever appear.
6156 void av_fast_padded_malloc(void *ptr, unsigned int *size, size_t min_size);
6159 * Same behaviour av_fast_padded_malloc except that buffer will always
6160 * be 0-initialized after call.
6162 void av_fast_padded_mallocz(void *ptr, unsigned int *size, size_t min_size);
6165 * Encode extradata length to a buffer. Used by xiph codecs.
6167 * @param s buffer to write to; must be at least (v/255+1) bytes long
6168 * @param v size of extradata in bytes
6169 * @return number of bytes written to the buffer.
6171 unsigned int av_xiphlacing(unsigned char *s, unsigned int v);
6173 #if FF_API_USER_VISIBLE_AVHWACCEL
6175 * Register the hardware accelerator hwaccel.
6177 * @deprecated This function doesn't do anything.
6179 attribute_deprecated
6180 void av_register_hwaccel(AVHWAccel *hwaccel);
6183 * If hwaccel is NULL, returns the first registered hardware accelerator,
6184 * if hwaccel is non-NULL, returns the next registered hardware accelerator
6185 * after hwaccel, or NULL if hwaccel is the last one.
6187 * @deprecated AVHWaccel structures contain no user-serviceable parts, so
6188 * this function should not be used.
6190 attribute_deprecated
6191 AVHWAccel *av_hwaccel_next(const AVHWAccel *hwaccel);
6196 * Lock operation used by lockmgr
6198 * @deprecated Deprecated together with av_lockmgr_register().
6201 AV_LOCK_CREATE, ///< Create a mutex
6202 AV_LOCK_OBTAIN, ///< Lock the mutex
6203 AV_LOCK_RELEASE, ///< Unlock the mutex
6204 AV_LOCK_DESTROY, ///< Free mutex resources
6208 * Register a user provided lock manager supporting the operations
6209 * specified by AVLockOp. The "mutex" argument to the function points
6210 * to a (void *) where the lockmgr should store/get a pointer to a user
6211 * allocated mutex. It is NULL upon AV_LOCK_CREATE and equal to the
6212 * value left by the last call for all other ops. If the lock manager is
6213 * unable to perform the op then it should leave the mutex in the same
6214 * state as when it was called and return a non-zero value. However,
6215 * when called with AV_LOCK_DESTROY the mutex will always be assumed to
6216 * have been successfully destroyed. If av_lockmgr_register succeeds
6217 * it will return a non-negative value, if it fails it will return a
6218 * negative value and destroy all mutex and unregister all callbacks.
6219 * av_lockmgr_register is not thread-safe, it must be called from a
6220 * single thread before any calls which make use of locking are used.
6222 * @param cb User defined callback. av_lockmgr_register invokes calls
6223 * to this callback and the previously registered callback.
6224 * The callback will be used to create more than one mutex
6225 * each of which must be backed by its own underlying locking
6226 * mechanism (i.e. do not use a single static object to
6227 * implement your lock manager). If cb is set to NULL the
6228 * lockmgr will be unregistered.
6230 * @deprecated This function does nothing, and always returns 0. Be sure to
6231 * build with thread support to get basic thread safety.
6233 attribute_deprecated
6234 int av_lockmgr_register(int (*cb)(void **mutex, enum AVLockOp op));
6238 * Get the type of the given codec.
6240 enum AVMediaType avcodec_get_type(enum AVCodecID codec_id);
6243 * Get the name of a codec.
6244 * @return a static string identifying the codec; never NULL
6246 const char *avcodec_get_name(enum AVCodecID id);
6249 * @return a positive value if s is open (i.e. avcodec_open2() was called on it
6250 * with no corresponding avcodec_close()), 0 otherwise.
6252 int avcodec_is_open(AVCodecContext *s);
6255 * @return a non-zero number if codec is an encoder, zero otherwise
6257 int av_codec_is_encoder(const AVCodec *codec);
6260 * @return a non-zero number if codec is a decoder, zero otherwise
6262 int av_codec_is_decoder(const AVCodec *codec);
6265 * @return descriptor for given codec ID or NULL if no descriptor exists.
6267 const AVCodecDescriptor *avcodec_descriptor_get(enum AVCodecID id);
6270 * Iterate over all codec descriptors known to libavcodec.
6272 * @param prev previous descriptor. NULL to get the first descriptor.
6274 * @return next descriptor or NULL after the last descriptor
6276 const AVCodecDescriptor *avcodec_descriptor_next(const AVCodecDescriptor *prev);
6279 * @return codec descriptor with the given name or NULL if no such descriptor
6282 const AVCodecDescriptor *avcodec_descriptor_get_by_name(const char *name);
6285 * Allocate a CPB properties structure and initialize its fields to default
6288 * @param size if non-NULL, the size of the allocated struct will be written
6289 * here. This is useful for embedding it in side data.
6291 * @return the newly allocated struct or NULL on failure
6293 AVCPBProperties *av_cpb_properties_alloc(size_t *size);
6299 #endif /* AVCODEC_AVCODEC_H */