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/log.h"
40 #include "libavutil/pixfmt.h"
41 #include "libavutil/rational.h"
46 * @defgroup libavc libavcodec
47 * Encoding/Decoding Library
51 * @defgroup lavc_decoding Decoding
55 * @defgroup lavc_encoding Encoding
59 * @defgroup lavc_codec Codecs
61 * @defgroup lavc_codec_native Native Codecs
64 * @defgroup lavc_codec_wrappers External library wrappers
67 * @defgroup lavc_codec_hwaccel Hardware Accelerators bridge
71 * @defgroup lavc_internal Internal
79 * @defgroup lavc_encdec send/receive encoding and decoding API overview
82 * The avcodec_send_packet()/avcodec_receive_frame()/avcodec_send_frame()/
83 * avcodec_receive_packet() functions provide an encode/decode API, which
84 * decouples input and output.
86 * The API is very similar for encoding/decoding and audio/video, and works as
88 * - Set up and open the AVCodecContext as usual.
90 * - For decoding, call avcodec_send_packet() to give the decoder raw
91 * compressed data in an AVPacket.
92 * - For encoding, call avcodec_send_frame() to give the encoder an AVFrame
93 * containing uncompressed audio or video.
94 * In both cases, it is recommended that AVPackets and AVFrames are
95 * refcounted, or libavcodec might have to copy the input data. (libavformat
96 * always returns refcounted AVPackets, and av_frame_get_buffer() allocates
97 * refcounted AVFrames.)
98 * - Receive output in a loop. Periodically call one of the avcodec_receive_*()
99 * functions and process their output:
100 * - For decoding, call avcodec_receive_frame(). On success, it will return
101 * an AVFrame containing uncompressed audio or video data.
102 * - For encoding, call avcodec_receive_packet(). On success, it will return
103 * an AVPacket with a compressed frame.
104 * Repeat this call until it returns AVERROR(EAGAIN) or an error. The
105 * AVERROR(EAGAIN) return value means that new input data is required to
106 * return new output. In this case, continue with sending input. For each
107 * input frame/packet, the codec will typically return 1 output frame/packet,
108 * but it can also be 0 or more than 1.
110 * At the beginning of decoding or encoding, the codec might accept multiple
111 * input frames/packets without returning a frame, until its internal buffers
112 * are filled. This situation is handled transparently if you follow the steps
115 * In theory, sending input can result in EAGAIN - this should happen only if
116 * not all output was received. You can use this to structure alternative decode
117 * or encode loops other than the one suggested above. For example, you could
118 * try sending new input on each iteration, and try to receive output if that
121 * End of stream situations. These require "flushing" (aka draining) the codec,
122 * as the codec might buffer multiple frames or packets internally for
123 * performance or out of necessity (consider B-frames).
124 * This is handled as follows:
125 * - Instead of valid input, send NULL to the avcodec_send_packet() (decoding)
126 * or avcodec_send_frame() (encoding) functions. This will enter draining
128 * - Call avcodec_receive_frame() (decoding) or avcodec_receive_packet()
129 * (encoding) in a loop until AVERROR_EOF is returned. The functions will
130 * not return AVERROR(EAGAIN), unless you forgot to enter draining mode.
131 * - Before decoding can be resumed again, the codec has to be reset with
132 * avcodec_flush_buffers().
134 * Using the API as outlined above is highly recommended. But it is also
135 * possible to call functions outside of this rigid schema. For example, you can
136 * call avcodec_send_packet() repeatedly without calling
137 * avcodec_receive_frame(). In this case, avcodec_send_packet() will succeed
138 * until the codec's internal buffer has been filled up (which is typically of
139 * size 1 per output frame, after initial input), and then reject input with
140 * AVERROR(EAGAIN). Once it starts rejecting input, you have no choice but to
141 * read at least some output.
143 * Not all codecs will follow a rigid and predictable dataflow; the only
144 * guarantee is that an AVERROR(EAGAIN) return value on a send/receive call on
145 * one end implies that a receive/send call on the other end will succeed. In
146 * general, no codec will permit unlimited buffering of input or output.
148 * This API replaces the following legacy functions:
149 * - avcodec_decode_video2() and avcodec_decode_audio4():
150 * Use avcodec_send_packet() to feed input to the decoder, then use
151 * avcodec_receive_frame() to receive decoded frames after each packet.
152 * Unlike with the old video decoding API, multiple frames might result from
153 * a packet. For audio, splitting the input packet into frames by partially
154 * decoding packets becomes transparent to the API user. You never need to
155 * feed an AVPacket to the API twice (unless it is rejected with EAGAIN - then
156 * no data was read from the packet).
157 * Additionally, sending a flush/draining packet is required only once.
158 * - avcodec_encode_video2()/avcodec_encode_audio2():
159 * Use avcodec_send_frame() to feed input to the encoder, then use
160 * avcodec_receive_packet() to receive encoded packets.
161 * Providing user-allocated buffers for avcodec_receive_packet() is not
163 * - The new API does not handle subtitles yet.
165 * Mixing new and old function calls on the same AVCodecContext is not allowed,
166 * and will result in undefined behavior.
168 * Some codecs might require using the new API; using the old API will return
169 * an error when calling it. All codecs support the new API.
171 * A codec is not allowed to return EAGAIN for both sending and receiving. This
172 * would be an invalid state, which could put the codec user into an endless
173 * loop. The API has no concept of time either: it cannot happen that trying to
174 * do avcodec_send_packet() results in EAGAIN, but a repeated call 1 second
175 * later accepts the packet (with no other receive/flush API calls involved).
176 * The API is a strict state machine, and the passage of time is not supposed
177 * to influence it. Some timing-dependent behavior might still be deemed
178 * acceptable in certain cases. But it must never result in both send/receive
179 * returning EAGAIN at the same time at any point. It must also absolutely be
180 * avoided that the current state is "unstable" and can "flip-flop" between
181 * the send/receive APIs allowing progress. For example, it's not allowed that
182 * the codec randomly decides that it actually wants to consume a packet now
183 * instead of returning a frame, after it just returned EAGAIN on an
184 * avcodec_send_packet() call.
189 * @defgroup lavc_core Core functions/structures.
192 * Basic definitions, functions for querying libavcodec capabilities,
193 * allocating core structures, etc.
199 * Identify the syntax and semantics of the bitstream.
200 * The principle is roughly:
201 * Two decoders with the same ID can decode the same streams.
202 * Two encoders with the same ID can encode compatible streams.
203 * There may be slight deviations from the principle due to implementation
206 * If you add a codec ID to this list, add it so that
207 * 1. no value of an existing codec ID changes (that would break ABI),
208 * 2. it is as close as possible to similar codecs
210 * After adding new codec IDs, do not forget to add an entry to the codec
211 * descriptor list and bump libavcodec minor version.
217 AV_CODEC_ID_MPEG1VIDEO,
218 AV_CODEC_ID_MPEG2VIDEO, ///< preferred ID for MPEG-1/2 video decoding
220 AV_CODEC_ID_MPEG2VIDEO_XVMC,
221 #endif /* FF_API_XVMC */
232 AV_CODEC_ID_RAWVIDEO,
233 AV_CODEC_ID_MSMPEG4V1,
234 AV_CODEC_ID_MSMPEG4V2,
235 AV_CODEC_ID_MSMPEG4V3,
258 AV_CODEC_ID_INTERPLAY_VIDEO,
265 AV_CODEC_ID_MSVIDEO1,
270 AV_CODEC_ID_TRUEMOTION1,
271 AV_CODEC_ID_VMDVIDEO,
296 AV_CODEC_ID_TRUEMOTION2,
302 AV_CODEC_ID_SMACKVIDEO,
307 AV_CODEC_ID_JPEG2000,
313 AV_CODEC_ID_DSICINVIDEO,
314 AV_CODEC_ID_TIERTEXSEQVIDEO,
322 AV_CODEC_ID_BETHSOFTVID,
334 AV_CODEC_ID_ESCAPE124,
338 AV_CODEC_ID_MOTIONPIXELS,
350 AV_CODEC_ID_FLASHSV2,
351 AV_CODEC_ID_CDGRAPHICS,
354 AV_CODEC_ID_BINKVIDEO,
355 AV_CODEC_ID_IFF_ILBM,
356 #define AV_CODEC_ID_IFF_BYTERUN1 AV_CODEC_ID_IFF_ILBM
362 AV_CODEC_ID_A64_MULTI,
363 AV_CODEC_ID_A64_MULTI5,
366 AV_CODEC_ID_LAGARITH,
370 AV_CODEC_ID_WMV3IMAGE,
371 AV_CODEC_ID_VC1IMAGE,
373 AV_CODEC_ID_BMV_VIDEO,
380 AV_CODEC_ID_ZEROCODEC,
389 AV_CODEC_ID_ESCAPE130,
392 AV_CODEC_ID_HNM4_VIDEO,
394 #define AV_CODEC_ID_H265 AV_CODEC_ID_HEVC
396 AV_CODEC_ID_ALIAS_PIX,
397 AV_CODEC_ID_BRENDER_PIX,
398 AV_CODEC_ID_PAF_VIDEO,
411 AV_CODEC_ID_SCREENPRESSO,
414 AV_CODEC_ID_Y41P = 0x8000,
419 AV_CODEC_ID_TARGA_Y216,
431 AV_CODEC_ID_TRUEMOTION2RT,
433 AV_CODEC_ID_MAGICYUV,
434 AV_CODEC_ID_SHEERVIDEO,
441 AV_CODEC_ID_CLEARVIDEO,
444 /* various PCM "codecs" */
445 AV_CODEC_ID_FIRST_AUDIO = 0x10000, ///< A dummy id pointing at the start of audio codecs
446 AV_CODEC_ID_PCM_S16LE = 0x10000,
447 AV_CODEC_ID_PCM_S16BE,
448 AV_CODEC_ID_PCM_U16LE,
449 AV_CODEC_ID_PCM_U16BE,
452 AV_CODEC_ID_PCM_MULAW,
453 AV_CODEC_ID_PCM_ALAW,
454 AV_CODEC_ID_PCM_S32LE,
455 AV_CODEC_ID_PCM_S32BE,
456 AV_CODEC_ID_PCM_U32LE,
457 AV_CODEC_ID_PCM_U32BE,
458 AV_CODEC_ID_PCM_S24LE,
459 AV_CODEC_ID_PCM_S24BE,
460 AV_CODEC_ID_PCM_U24LE,
461 AV_CODEC_ID_PCM_U24BE,
462 AV_CODEC_ID_PCM_S24DAUD,
463 AV_CODEC_ID_PCM_ZORK,
464 AV_CODEC_ID_PCM_S16LE_PLANAR,
466 AV_CODEC_ID_PCM_F32BE,
467 AV_CODEC_ID_PCM_F32LE,
468 AV_CODEC_ID_PCM_F64BE,
469 AV_CODEC_ID_PCM_F64LE,
470 AV_CODEC_ID_PCM_BLURAY,
473 AV_CODEC_ID_PCM_S8_PLANAR,
474 AV_CODEC_ID_PCM_S24LE_PLANAR,
475 AV_CODEC_ID_PCM_S32LE_PLANAR,
476 AV_CODEC_ID_PCM_S16BE_PLANAR,
478 AV_CODEC_ID_PCM_S64LE = 0x10800,
479 AV_CODEC_ID_PCM_S64BE,
480 AV_CODEC_ID_PCM_F16LE,
481 AV_CODEC_ID_PCM_F24LE,
483 /* various ADPCM codecs */
484 AV_CODEC_ID_ADPCM_IMA_QT = 0x11000,
485 AV_CODEC_ID_ADPCM_IMA_WAV,
486 AV_CODEC_ID_ADPCM_IMA_DK3,
487 AV_CODEC_ID_ADPCM_IMA_DK4,
488 AV_CODEC_ID_ADPCM_IMA_WS,
489 AV_CODEC_ID_ADPCM_IMA_SMJPEG,
490 AV_CODEC_ID_ADPCM_MS,
491 AV_CODEC_ID_ADPCM_4XM,
492 AV_CODEC_ID_ADPCM_XA,
493 AV_CODEC_ID_ADPCM_ADX,
494 AV_CODEC_ID_ADPCM_EA,
495 AV_CODEC_ID_ADPCM_G726,
496 AV_CODEC_ID_ADPCM_CT,
497 AV_CODEC_ID_ADPCM_SWF,
498 AV_CODEC_ID_ADPCM_YAMAHA,
499 AV_CODEC_ID_ADPCM_SBPRO_4,
500 AV_CODEC_ID_ADPCM_SBPRO_3,
501 AV_CODEC_ID_ADPCM_SBPRO_2,
502 AV_CODEC_ID_ADPCM_THP,
503 AV_CODEC_ID_ADPCM_IMA_AMV,
504 AV_CODEC_ID_ADPCM_EA_R1,
505 AV_CODEC_ID_ADPCM_EA_R3,
506 AV_CODEC_ID_ADPCM_EA_R2,
507 AV_CODEC_ID_ADPCM_IMA_EA_SEAD,
508 AV_CODEC_ID_ADPCM_IMA_EA_EACS,
509 AV_CODEC_ID_ADPCM_EA_XAS,
510 AV_CODEC_ID_ADPCM_EA_MAXIS_XA,
511 AV_CODEC_ID_ADPCM_IMA_ISS,
512 AV_CODEC_ID_ADPCM_G722,
513 AV_CODEC_ID_ADPCM_IMA_APC,
514 AV_CODEC_ID_ADPCM_VIMA,
515 #if FF_API_VIMA_DECODER
516 AV_CODEC_ID_VIMA = AV_CODEC_ID_ADPCM_VIMA,
519 AV_CODEC_ID_ADPCM_AFC = 0x11800,
520 AV_CODEC_ID_ADPCM_IMA_OKI,
521 AV_CODEC_ID_ADPCM_DTK,
522 AV_CODEC_ID_ADPCM_IMA_RAD,
523 AV_CODEC_ID_ADPCM_G726LE,
524 AV_CODEC_ID_ADPCM_THP_LE,
525 AV_CODEC_ID_ADPCM_PSX,
526 AV_CODEC_ID_ADPCM_AICA,
527 AV_CODEC_ID_ADPCM_IMA_DAT4,
528 AV_CODEC_ID_ADPCM_MTAF,
531 AV_CODEC_ID_AMR_NB = 0x12000,
534 /* RealAudio codecs*/
535 AV_CODEC_ID_RA_144 = 0x13000,
538 /* various DPCM codecs */
539 AV_CODEC_ID_ROQ_DPCM = 0x14000,
540 AV_CODEC_ID_INTERPLAY_DPCM,
541 AV_CODEC_ID_XAN_DPCM,
542 AV_CODEC_ID_SOL_DPCM,
544 AV_CODEC_ID_SDX2_DPCM = 0x14800,
547 AV_CODEC_ID_MP2 = 0x15000,
548 AV_CODEC_ID_MP3, ///< preferred ID for decoding MPEG audio layer 1, 2 or 3
558 AV_CODEC_ID_VMDAUDIO,
564 AV_CODEC_ID_WESTWOOD_SND1,
565 AV_CODEC_ID_GSM, ///< as in Berlin toast format
568 AV_CODEC_ID_TRUESPEECH,
570 AV_CODEC_ID_SMACKAUDIO,
573 AV_CODEC_ID_DSICINAUDIO,
575 AV_CODEC_ID_MUSEPACK7,
577 AV_CODEC_ID_GSM_MS, /* as found in WAV */
583 AV_CODEC_ID_NELLYMOSER,
584 AV_CODEC_ID_MUSEPACK8,
586 AV_CODEC_ID_WMAVOICE,
588 AV_CODEC_ID_WMALOSSLESS,
597 AV_CODEC_ID_BINKAUDIO_RDFT,
598 AV_CODEC_ID_BINKAUDIO_DCT,
599 AV_CODEC_ID_AAC_LATM,
604 AV_CODEC_ID_8SVX_EXP,
605 AV_CODEC_ID_8SVX_FIB,
606 AV_CODEC_ID_BMV_AUDIO,
611 AV_CODEC_ID_COMFORT_NOISE,
613 AV_CODEC_ID_METASOUND,
614 AV_CODEC_ID_PAF_AUDIO,
618 AV_CODEC_ID_FFWAVESYNTH = 0x15800,
620 AV_CODEC_ID_SONIC_LS,
623 AV_CODEC_ID_DSD_LSBF,
624 AV_CODEC_ID_DSD_MSBF,
625 AV_CODEC_ID_DSD_LSBF_PLANAR,
626 AV_CODEC_ID_DSD_MSBF_PLANAR,
628 AV_CODEC_ID_INTERPLAY_ACM,
632 AV_CODEC_ID_ATRAC3AL,
633 AV_CODEC_ID_ATRAC3PAL,
635 /* subtitle codecs */
636 AV_CODEC_ID_FIRST_SUBTITLE = 0x17000, ///< A dummy ID pointing at the start of subtitle codecs.
637 AV_CODEC_ID_DVD_SUBTITLE = 0x17000,
638 AV_CODEC_ID_DVB_SUBTITLE,
639 AV_CODEC_ID_TEXT, ///< raw UTF-8 text
642 AV_CODEC_ID_MOV_TEXT,
643 AV_CODEC_ID_HDMV_PGS_SUBTITLE,
644 AV_CODEC_ID_DVB_TELETEXT,
647 AV_CODEC_ID_MICRODVD = 0x17800,
651 AV_CODEC_ID_REALTEXT,
653 AV_CODEC_ID_SUBVIEWER1,
654 AV_CODEC_ID_SUBVIEWER,
661 AV_CODEC_ID_HDMV_TEXT_SUBTITLE,
663 /* other specific kind of codecs (generally used for attachments) */
664 AV_CODEC_ID_FIRST_UNKNOWN = 0x18000, ///< A dummy ID pointing at the start of various fake codecs.
665 AV_CODEC_ID_TTF = 0x18000,
667 AV_CODEC_ID_SCTE_35, ///< Contain timestamp estimated through PCR of program stream.
668 AV_CODEC_ID_BINTEXT = 0x18800,
672 AV_CODEC_ID_SMPTE_KLV,
674 AV_CODEC_ID_TIMED_ID3,
675 AV_CODEC_ID_BIN_DATA,
678 AV_CODEC_ID_PROBE = 0x19000, ///< codec_id is not known (like AV_CODEC_ID_NONE) but lavf should attempt to identify it
680 AV_CODEC_ID_MPEG2TS = 0x20000, /**< _FAKE_ codec to indicate a raw MPEG-2 TS
681 * stream (only used by libavformat) */
682 AV_CODEC_ID_MPEG4SYSTEMS = 0x20001, /**< _FAKE_ codec to indicate a MPEG-4 Systems
683 * stream (only used by libavformat) */
684 AV_CODEC_ID_FFMETADATA = 0x21000, ///< Dummy codec for streams containing only metadata information.
685 AV_CODEC_ID_WRAPPED_AVFRAME = 0x21001, ///< Passthrough codec, AVFrames wrapped in AVPacket
689 * This struct describes the properties of a single codec described by an
691 * @see avcodec_descriptor_get()
693 typedef struct AVCodecDescriptor {
695 enum AVMediaType type;
697 * Name of the codec described by this descriptor. It is non-empty and
698 * unique for each codec descriptor. It should contain alphanumeric
699 * characters and '_' only.
703 * A more descriptive name for this codec. May be NULL.
705 const char *long_name;
707 * Codec properties, a combination of AV_CODEC_PROP_* flags.
711 * MIME type(s) associated with the codec.
712 * May be NULL; if not, a NULL-terminated array of MIME types.
713 * The first item is always non-NULL and is the preferred MIME type.
715 const char *const *mime_types;
717 * If non-NULL, an array of profiles recognized for this codec.
718 * Terminated with FF_PROFILE_UNKNOWN.
720 const struct AVProfile *profiles;
724 * Codec uses only intra compression.
727 #define AV_CODEC_PROP_INTRA_ONLY (1 << 0)
729 * Codec supports lossy compression. Audio and video codecs only.
730 * @note a codec may support both lossy and lossless
733 #define AV_CODEC_PROP_LOSSY (1 << 1)
735 * Codec supports lossless compression. Audio and video codecs only.
737 #define AV_CODEC_PROP_LOSSLESS (1 << 2)
739 * Codec supports frame reordering. That is, the coded order (the order in which
740 * the encoded packets are output by the encoders / stored / input to the
741 * decoders) may be different from the presentation order of the corresponding
744 * For codecs that do not have this property set, PTS and DTS should always be
747 #define AV_CODEC_PROP_REORDER (1 << 3)
749 * Subtitle codec is bitmap based
750 * Decoded AVSubtitle data can be read from the AVSubtitleRect->pict field.
752 #define AV_CODEC_PROP_BITMAP_SUB (1 << 16)
754 * Subtitle codec is text based.
755 * Decoded AVSubtitle data can be read from the AVSubtitleRect->ass field.
757 #define AV_CODEC_PROP_TEXT_SUB (1 << 17)
760 * @ingroup lavc_decoding
761 * Required number of additionally allocated bytes at the end of the input bitstream for decoding.
762 * This is mainly needed because some optimized bitstream readers read
763 * 32 or 64 bit at once and could read over the end.<br>
764 * Note: If the first 23 bits of the additional bytes are not 0, then damaged
765 * MPEG bitstreams could cause overread and segfault.
767 #define AV_INPUT_BUFFER_PADDING_SIZE 32
770 * @ingroup lavc_encoding
771 * minimum encoding buffer size
772 * Used to avoid some checks during header writing.
774 #define AV_INPUT_BUFFER_MIN_SIZE 16384
776 #if FF_API_WITHOUT_PREFIX
778 * @deprecated use AV_INPUT_BUFFER_PADDING_SIZE instead
780 #define FF_INPUT_BUFFER_PADDING_SIZE 32
783 * @deprecated use AV_INPUT_BUFFER_MIN_SIZE instead
785 #define FF_MIN_BUFFER_SIZE 16384
786 #endif /* FF_API_WITHOUT_PREFIX */
789 * @ingroup lavc_encoding
790 * motion estimation type.
791 * @deprecated use codec private option instead
793 #if FF_API_MOTION_EST
795 ME_ZERO = 1, ///< no search, that is use 0,0 vector whenever one is needed
799 ME_EPZS, ///< enhanced predictive zonal search
800 ME_X1, ///< reserved for experiments
801 ME_HEX, ///< hexagon based search
802 ME_UMH, ///< uneven multi-hexagon search
803 ME_TESA, ///< transformed exhaustive search algorithm
804 ME_ITER=50, ///< iterative search
809 * @ingroup lavc_decoding
812 /* We leave some space between them for extensions (drop some
813 * keyframes for intra-only or drop just some bidir frames). */
814 AVDISCARD_NONE =-16, ///< discard nothing
815 AVDISCARD_DEFAULT = 0, ///< discard useless packets like 0 size packets in avi
816 AVDISCARD_NONREF = 8, ///< discard all non reference
817 AVDISCARD_BIDIR = 16, ///< discard all bidirectional frames
818 AVDISCARD_NONINTRA= 24, ///< discard all non intra frames
819 AVDISCARD_NONKEY = 32, ///< discard all frames except keyframes
820 AVDISCARD_ALL = 48, ///< discard all
823 enum AVAudioServiceType {
824 AV_AUDIO_SERVICE_TYPE_MAIN = 0,
825 AV_AUDIO_SERVICE_TYPE_EFFECTS = 1,
826 AV_AUDIO_SERVICE_TYPE_VISUALLY_IMPAIRED = 2,
827 AV_AUDIO_SERVICE_TYPE_HEARING_IMPAIRED = 3,
828 AV_AUDIO_SERVICE_TYPE_DIALOGUE = 4,
829 AV_AUDIO_SERVICE_TYPE_COMMENTARY = 5,
830 AV_AUDIO_SERVICE_TYPE_EMERGENCY = 6,
831 AV_AUDIO_SERVICE_TYPE_VOICE_OVER = 7,
832 AV_AUDIO_SERVICE_TYPE_KARAOKE = 8,
833 AV_AUDIO_SERVICE_TYPE_NB , ///< Not part of ABI
837 * @ingroup lavc_encoding
839 typedef struct RcOverride{
842 int qscale; // If this is 0 then quality_factor will be used instead.
843 float quality_factor;
846 #if FF_API_MAX_BFRAMES
848 * @deprecated there is no libavcodec-wide limit on the number of B-frames
850 #define FF_MAX_B_FRAMES 16
854 These flags can be passed in AVCodecContext.flags before initialization.
855 Note: Not everything is supported yet.
859 * Allow decoders to produce frames with data planes that are not aligned
860 * to CPU requirements (e.g. due to cropping).
862 #define AV_CODEC_FLAG_UNALIGNED (1 << 0)
866 #define AV_CODEC_FLAG_QSCALE (1 << 1)
868 * 4 MV per MB allowed / advanced prediction for H.263.
870 #define AV_CODEC_FLAG_4MV (1 << 2)
872 * Output even those frames that might be corrupted.
874 #define AV_CODEC_FLAG_OUTPUT_CORRUPT (1 << 3)
878 #define AV_CODEC_FLAG_QPEL (1 << 4)
880 * Use internal 2pass ratecontrol in first pass mode.
882 #define AV_CODEC_FLAG_PASS1 (1 << 9)
884 * Use internal 2pass ratecontrol in second pass mode.
886 #define AV_CODEC_FLAG_PASS2 (1 << 10)
890 #define AV_CODEC_FLAG_LOOP_FILTER (1 << 11)
892 * Only decode/encode grayscale.
894 #define AV_CODEC_FLAG_GRAY (1 << 13)
896 * error[?] variables will be set during encoding.
898 #define AV_CODEC_FLAG_PSNR (1 << 15)
900 * Input bitstream might be truncated at a random location
901 * instead of only at frame boundaries.
903 #define AV_CODEC_FLAG_TRUNCATED (1 << 16)
905 * Use interlaced DCT.
907 #define AV_CODEC_FLAG_INTERLACED_DCT (1 << 18)
911 #define AV_CODEC_FLAG_LOW_DELAY (1 << 19)
913 * Place global headers in extradata instead of every keyframe.
915 #define AV_CODEC_FLAG_GLOBAL_HEADER (1 << 22)
917 * Use only bitexact stuff (except (I)DCT).
919 #define AV_CODEC_FLAG_BITEXACT (1 << 23)
920 /* Fx : Flag for H.263+ extra options */
922 * H.263 advanced intra coding / MPEG-4 AC prediction
924 #define AV_CODEC_FLAG_AC_PRED (1 << 24)
926 * interlaced motion estimation
928 #define AV_CODEC_FLAG_INTERLACED_ME (1 << 29)
929 #define AV_CODEC_FLAG_CLOSED_GOP (1U << 31)
932 * Allow non spec compliant speedup tricks.
934 #define AV_CODEC_FLAG2_FAST (1 << 0)
936 * Skip bitstream encoding.
938 #define AV_CODEC_FLAG2_NO_OUTPUT (1 << 2)
940 * Place global headers at every keyframe instead of in extradata.
942 #define AV_CODEC_FLAG2_LOCAL_HEADER (1 << 3)
945 * timecode is in drop frame format. DEPRECATED!!!!
947 #define AV_CODEC_FLAG2_DROP_FRAME_TIMECODE (1 << 13)
950 * Input bitstream might be truncated at a packet boundaries
951 * instead of only at frame boundaries.
953 #define AV_CODEC_FLAG2_CHUNKS (1 << 15)
955 * Discard cropping information from SPS.
957 #define AV_CODEC_FLAG2_IGNORE_CROP (1 << 16)
960 * Show all frames before the first keyframe
962 #define AV_CODEC_FLAG2_SHOW_ALL (1 << 22)
964 * Export motion vectors through frame side data
966 #define AV_CODEC_FLAG2_EXPORT_MVS (1 << 28)
968 * Do not skip samples and export skip information as frame side data
970 #define AV_CODEC_FLAG2_SKIP_MANUAL (1 << 29)
972 * Do not reset ASS ReadOrder field on flush (subtitles decoding)
974 #define AV_CODEC_FLAG2_RO_FLUSH_NOOP (1 << 30)
976 /* Unsupported options :
977 * Syntax Arithmetic coding (SAC)
978 * Reference Picture Selection
979 * Independent Segment Decoding */
981 /* codec capabilities */
984 * Decoder can use draw_horiz_band callback.
986 #define AV_CODEC_CAP_DRAW_HORIZ_BAND (1 << 0)
988 * Codec uses get_buffer() for allocating buffers and supports custom allocators.
989 * If not set, it might not use get_buffer() at all or use operations that
990 * assume the buffer was allocated by avcodec_default_get_buffer.
992 #define AV_CODEC_CAP_DR1 (1 << 1)
993 #define AV_CODEC_CAP_TRUNCATED (1 << 3)
995 * Encoder or decoder requires flushing with NULL input at the end in order to
996 * give the complete and correct output.
998 * NOTE: If this flag is not set, the codec is guaranteed to never be fed with
999 * with NULL data. The user can still send NULL data to the public encode
1000 * or decode function, but libavcodec will not pass it along to the codec
1001 * unless this flag is set.
1004 * The decoder has a non-zero delay and needs to be fed with avpkt->data=NULL,
1005 * avpkt->size=0 at the end to get the delayed data until the decoder no longer
1009 * The encoder needs to be fed with NULL data at the end of encoding until the
1010 * encoder no longer returns data.
1012 * NOTE: For encoders implementing the AVCodec.encode2() function, setting this
1013 * flag also means that the encoder must set the pts and duration for
1014 * each output packet. If this flag is not set, the pts and duration will
1015 * be determined by libavcodec from the input frame.
1017 #define AV_CODEC_CAP_DELAY (1 << 5)
1019 * Codec can be fed a final frame with a smaller size.
1020 * This can be used to prevent truncation of the last audio samples.
1022 #define AV_CODEC_CAP_SMALL_LAST_FRAME (1 << 6)
1024 #if FF_API_CAP_VDPAU
1026 * Codec can export data for HW decoding (VDPAU).
1028 #define AV_CODEC_CAP_HWACCEL_VDPAU (1 << 7)
1032 * Codec can output multiple frames per AVPacket
1033 * Normally demuxers return one frame at a time, demuxers which do not do
1034 * are connected to a parser to split what they return into proper frames.
1035 * This flag is reserved to the very rare category of codecs which have a
1036 * bitstream that cannot be split into frames without timeconsuming
1037 * operations like full decoding. Demuxers carrying such bitstreams thus
1038 * may return multiple frames in a packet. This has many disadvantages like
1039 * prohibiting stream copy in many cases thus it should only be considered
1042 #define AV_CODEC_CAP_SUBFRAMES (1 << 8)
1044 * Codec is experimental and is thus avoided in favor of non experimental
1047 #define AV_CODEC_CAP_EXPERIMENTAL (1 << 9)
1049 * Codec should fill in channel configuration and samplerate instead of container
1051 #define AV_CODEC_CAP_CHANNEL_CONF (1 << 10)
1053 * Codec supports frame-level multithreading.
1055 #define AV_CODEC_CAP_FRAME_THREADS (1 << 12)
1057 * Codec supports slice-based (or partition-based) multithreading.
1059 #define AV_CODEC_CAP_SLICE_THREADS (1 << 13)
1061 * Codec supports changed parameters at any point.
1063 #define AV_CODEC_CAP_PARAM_CHANGE (1 << 14)
1065 * Codec supports avctx->thread_count == 0 (auto).
1067 #define AV_CODEC_CAP_AUTO_THREADS (1 << 15)
1069 * Audio encoder supports receiving a different number of samples in each call.
1071 #define AV_CODEC_CAP_VARIABLE_FRAME_SIZE (1 << 16)
1073 * Decoder is not a preferred choice for probing.
1074 * This indicates that the decoder is not a good choice for probing.
1075 * It could for example be an expensive to spin up hardware decoder,
1076 * or it could simply not provide a lot of useful information about
1078 * A decoder marked with this flag should only be used as last resort
1079 * choice for probing.
1081 #define AV_CODEC_CAP_AVOID_PROBING (1 << 17)
1083 * Codec is intra only.
1085 #define AV_CODEC_CAP_INTRA_ONLY 0x40000000
1087 * Codec is lossless.
1089 #define AV_CODEC_CAP_LOSSLESS 0x80000000
1092 #if FF_API_WITHOUT_PREFIX
1094 * Allow decoders to produce frames with data planes that are not aligned
1095 * to CPU requirements (e.g. due to cropping).
1097 #define CODEC_FLAG_UNALIGNED AV_CODEC_FLAG_UNALIGNED
1098 #define CODEC_FLAG_QSCALE AV_CODEC_FLAG_QSCALE
1099 #define CODEC_FLAG_4MV AV_CODEC_FLAG_4MV
1100 #define CODEC_FLAG_OUTPUT_CORRUPT AV_CODEC_FLAG_OUTPUT_CORRUPT
1101 #define CODEC_FLAG_QPEL AV_CODEC_FLAG_QPEL
1104 * @deprecated use the "gmc" private option of the libxvid encoder
1106 #define CODEC_FLAG_GMC 0x0020 ///< Use GMC.
1110 * @deprecated use the flag "mv0" in the "mpv_flags" private option of the
1111 * mpegvideo encoders
1113 #define CODEC_FLAG_MV0 0x0040
1115 #if FF_API_INPUT_PRESERVED
1117 * @deprecated passing reference-counted frames to the encoders replaces this
1120 #define CODEC_FLAG_INPUT_PRESERVED 0x0100
1122 #define CODEC_FLAG_PASS1 AV_CODEC_FLAG_PASS1
1123 #define CODEC_FLAG_PASS2 AV_CODEC_FLAG_PASS2
1124 #define CODEC_FLAG_GRAY AV_CODEC_FLAG_GRAY
1127 * @deprecated edges are not used/required anymore. I.e. this flag is now always
1130 #define CODEC_FLAG_EMU_EDGE 0x4000
1132 #define CODEC_FLAG_PSNR AV_CODEC_FLAG_PSNR
1133 #define CODEC_FLAG_TRUNCATED AV_CODEC_FLAG_TRUNCATED
1135 #if FF_API_NORMALIZE_AQP
1137 * @deprecated use the flag "naq" in the "mpv_flags" private option of the
1138 * mpegvideo encoders
1140 #define CODEC_FLAG_NORMALIZE_AQP 0x00020000
1142 #define CODEC_FLAG_INTERLACED_DCT AV_CODEC_FLAG_INTERLACED_DCT
1143 #define CODEC_FLAG_LOW_DELAY AV_CODEC_FLAG_LOW_DELAY
1144 #define CODEC_FLAG_GLOBAL_HEADER AV_CODEC_FLAG_GLOBAL_HEADER
1145 #define CODEC_FLAG_BITEXACT AV_CODEC_FLAG_BITEXACT
1146 #define CODEC_FLAG_AC_PRED AV_CODEC_FLAG_AC_PRED
1147 #define CODEC_FLAG_LOOP_FILTER AV_CODEC_FLAG_LOOP_FILTER
1148 #define CODEC_FLAG_INTERLACED_ME AV_CODEC_FLAG_INTERLACED_ME
1149 #define CODEC_FLAG_CLOSED_GOP AV_CODEC_FLAG_CLOSED_GOP
1150 #define CODEC_FLAG2_FAST AV_CODEC_FLAG2_FAST
1151 #define CODEC_FLAG2_NO_OUTPUT AV_CODEC_FLAG2_NO_OUTPUT
1152 #define CODEC_FLAG2_LOCAL_HEADER AV_CODEC_FLAG2_LOCAL_HEADER
1153 #define CODEC_FLAG2_DROP_FRAME_TIMECODE AV_CODEC_FLAG2_DROP_FRAME_TIMECODE
1154 #define CODEC_FLAG2_IGNORE_CROP AV_CODEC_FLAG2_IGNORE_CROP
1156 #define CODEC_FLAG2_CHUNKS AV_CODEC_FLAG2_CHUNKS
1157 #define CODEC_FLAG2_SHOW_ALL AV_CODEC_FLAG2_SHOW_ALL
1158 #define CODEC_FLAG2_EXPORT_MVS AV_CODEC_FLAG2_EXPORT_MVS
1159 #define CODEC_FLAG2_SKIP_MANUAL AV_CODEC_FLAG2_SKIP_MANUAL
1161 /* Unsupported options :
1162 * Syntax Arithmetic coding (SAC)
1163 * Reference Picture Selection
1164 * Independent Segment Decoding */
1166 /* codec capabilities */
1168 #define CODEC_CAP_DRAW_HORIZ_BAND AV_CODEC_CAP_DRAW_HORIZ_BAND ///< Decoder can use draw_horiz_band callback.
1170 * Codec uses get_buffer() for allocating buffers and supports custom allocators.
1171 * If not set, it might not use get_buffer() at all or use operations that
1172 * assume the buffer was allocated by avcodec_default_get_buffer.
1174 #define CODEC_CAP_DR1 AV_CODEC_CAP_DR1
1175 #define CODEC_CAP_TRUNCATED AV_CODEC_CAP_TRUNCATED
1177 /* Codec can export data for HW decoding. This flag indicates that
1178 * the codec would call get_format() with list that might contain HW accelerated
1179 * pixel formats (XvMC, VDPAU, VAAPI, etc). The application can pick any of them
1180 * including raw image format.
1181 * The application can use the passed context to determine bitstream version,
1182 * chroma format, resolution etc.
1184 #define CODEC_CAP_HWACCEL 0x0010
1185 #endif /* FF_API_XVMC */
1187 * Encoder or decoder requires flushing with NULL input at the end in order to
1188 * give the complete and correct output.
1190 * NOTE: If this flag is not set, the codec is guaranteed to never be fed with
1191 * with NULL data. The user can still send NULL data to the public encode
1192 * or decode function, but libavcodec will not pass it along to the codec
1193 * unless this flag is set.
1196 * The decoder has a non-zero delay and needs to be fed with avpkt->data=NULL,
1197 * avpkt->size=0 at the end to get the delayed data until the decoder no longer
1201 * The encoder needs to be fed with NULL data at the end of encoding until the
1202 * encoder no longer returns data.
1204 * NOTE: For encoders implementing the AVCodec.encode2() function, setting this
1205 * flag also means that the encoder must set the pts and duration for
1206 * each output packet. If this flag is not set, the pts and duration will
1207 * be determined by libavcodec from the input frame.
1209 #define CODEC_CAP_DELAY AV_CODEC_CAP_DELAY
1211 * Codec can be fed a final frame with a smaller size.
1212 * This can be used to prevent truncation of the last audio samples.
1214 #define CODEC_CAP_SMALL_LAST_FRAME AV_CODEC_CAP_SMALL_LAST_FRAME
1215 #if FF_API_CAP_VDPAU
1217 * Codec can export data for HW decoding (VDPAU).
1219 #define CODEC_CAP_HWACCEL_VDPAU AV_CODEC_CAP_HWACCEL_VDPAU
1222 * Codec can output multiple frames per AVPacket
1223 * Normally demuxers return one frame at a time, demuxers which do not do
1224 * are connected to a parser to split what they return into proper frames.
1225 * This flag is reserved to the very rare category of codecs which have a
1226 * bitstream that cannot be split into frames without timeconsuming
1227 * operations like full decoding. Demuxers carrying such bitstreams thus
1228 * may return multiple frames in a packet. This has many disadvantages like
1229 * prohibiting stream copy in many cases thus it should only be considered
1232 #define CODEC_CAP_SUBFRAMES AV_CODEC_CAP_SUBFRAMES
1234 * Codec is experimental and is thus avoided in favor of non experimental
1237 #define CODEC_CAP_EXPERIMENTAL AV_CODEC_CAP_EXPERIMENTAL
1239 * Codec should fill in channel configuration and samplerate instead of container
1241 #define CODEC_CAP_CHANNEL_CONF AV_CODEC_CAP_CHANNEL_CONF
1242 #if FF_API_NEG_LINESIZES
1244 * @deprecated no codecs use this capability
1246 #define CODEC_CAP_NEG_LINESIZES 0x0800
1249 * Codec supports frame-level multithreading.
1251 #define CODEC_CAP_FRAME_THREADS AV_CODEC_CAP_FRAME_THREADS
1253 * Codec supports slice-based (or partition-based) multithreading.
1255 #define CODEC_CAP_SLICE_THREADS AV_CODEC_CAP_SLICE_THREADS
1257 * Codec supports changed parameters at any point.
1259 #define CODEC_CAP_PARAM_CHANGE AV_CODEC_CAP_PARAM_CHANGE
1261 * Codec supports avctx->thread_count == 0 (auto).
1263 #define CODEC_CAP_AUTO_THREADS AV_CODEC_CAP_AUTO_THREADS
1265 * Audio encoder supports receiving a different number of samples in each call.
1267 #define CODEC_CAP_VARIABLE_FRAME_SIZE AV_CODEC_CAP_VARIABLE_FRAME_SIZE
1269 * Codec is intra only.
1271 #define CODEC_CAP_INTRA_ONLY AV_CODEC_CAP_INTRA_ONLY
1273 * Codec is lossless.
1275 #define CODEC_CAP_LOSSLESS AV_CODEC_CAP_LOSSLESS
1278 * HWAccel is experimental and is thus avoided in favor of non experimental
1281 #define HWACCEL_CODEC_CAP_EXPERIMENTAL 0x0200
1282 #endif /* FF_API_WITHOUT_PREFIX */
1285 //The following defines may change, don't expect compatibility if you use them.
1286 #define MB_TYPE_INTRA4x4 0x0001
1287 #define MB_TYPE_INTRA16x16 0x0002 //FIXME H.264-specific
1288 #define MB_TYPE_INTRA_PCM 0x0004 //FIXME H.264-specific
1289 #define MB_TYPE_16x16 0x0008
1290 #define MB_TYPE_16x8 0x0010
1291 #define MB_TYPE_8x16 0x0020
1292 #define MB_TYPE_8x8 0x0040
1293 #define MB_TYPE_INTERLACED 0x0080
1294 #define MB_TYPE_DIRECT2 0x0100 //FIXME
1295 #define MB_TYPE_ACPRED 0x0200
1296 #define MB_TYPE_GMC 0x0400
1297 #define MB_TYPE_SKIP 0x0800
1298 #define MB_TYPE_P0L0 0x1000
1299 #define MB_TYPE_P1L0 0x2000
1300 #define MB_TYPE_P0L1 0x4000
1301 #define MB_TYPE_P1L1 0x8000
1302 #define MB_TYPE_L0 (MB_TYPE_P0L0 | MB_TYPE_P1L0)
1303 #define MB_TYPE_L1 (MB_TYPE_P0L1 | MB_TYPE_P1L1)
1304 #define MB_TYPE_L0L1 (MB_TYPE_L0 | MB_TYPE_L1)
1305 #define MB_TYPE_QUANT 0x00010000
1306 #define MB_TYPE_CBP 0x00020000
1307 // Note bits 24-31 are reserved for codec specific use (H.264 ref0, MPEG-1 0mv, ...)
1312 * This specifies the area which should be displayed.
1313 * Note there may be multiple such areas for one frame.
1315 typedef struct AVPanScan{
1318 * - encoding: Set by user.
1319 * - decoding: Set by libavcodec.
1324 * width and height in 1/16 pel
1325 * - encoding: Set by user.
1326 * - decoding: Set by libavcodec.
1332 * position of the top left corner in 1/16 pel for up to 3 fields/frames
1333 * - encoding: Set by user.
1334 * - decoding: Set by libavcodec.
1336 int16_t position[3][2];
1340 * This structure describes the bitrate properties of an encoded bitstream. It
1341 * roughly corresponds to a subset the VBV parameters for MPEG-2 or HRD
1342 * parameters for H.264/HEVC.
1344 typedef struct AVCPBProperties {
1346 * Maximum bitrate of the stream, in bits per second.
1347 * Zero if unknown or unspecified.
1351 * Minimum bitrate of the stream, in bits per second.
1352 * Zero if unknown or unspecified.
1356 * Average bitrate of the stream, in bits per second.
1357 * Zero if unknown or unspecified.
1362 * The size of the buffer to which the ratecontrol is applied, in bits.
1363 * Zero if unknown or unspecified.
1368 * The delay between the time the packet this structure is associated with
1369 * is received and the time when it should be decoded, in periods of a 27MHz
1372 * UINT64_MAX when unknown or unspecified.
1377 #if FF_API_QSCALE_TYPE
1378 #define FF_QSCALE_TYPE_MPEG1 0
1379 #define FF_QSCALE_TYPE_MPEG2 1
1380 #define FF_QSCALE_TYPE_H264 2
1381 #define FF_QSCALE_TYPE_VP56 3
1385 * The decoder will keep a reference to the frame and may reuse it later.
1387 #define AV_GET_BUFFER_FLAG_REF (1 << 0)
1390 * @defgroup lavc_packet AVPacket
1392 * Types and functions for working with AVPacket.
1395 enum AVPacketSideDataType {
1396 AV_PKT_DATA_PALETTE,
1399 * The AV_PKT_DATA_NEW_EXTRADATA is used to notify the codec or the format
1400 * that the extradata buffer was changed and the receiving side should
1401 * act upon it appropriately. The new extradata is embedded in the side
1402 * data buffer and should be immediately used for processing the current
1405 AV_PKT_DATA_NEW_EXTRADATA,
1408 * An AV_PKT_DATA_PARAM_CHANGE side data packet is laid out as follows:
1411 * if (param_flags & AV_SIDE_DATA_PARAM_CHANGE_CHANNEL_COUNT)
1412 * s32le channel_count
1413 * if (param_flags & AV_SIDE_DATA_PARAM_CHANGE_CHANNEL_LAYOUT)
1414 * u64le channel_layout
1415 * if (param_flags & AV_SIDE_DATA_PARAM_CHANGE_SAMPLE_RATE)
1417 * if (param_flags & AV_SIDE_DATA_PARAM_CHANGE_DIMENSIONS)
1422 AV_PKT_DATA_PARAM_CHANGE,
1425 * An AV_PKT_DATA_H263_MB_INFO side data packet contains a number of
1426 * structures with info about macroblocks relevant to splitting the
1427 * packet into smaller packets on macroblock edges (e.g. as for RFC 2190).
1428 * That is, it does not necessarily contain info about all macroblocks,
1429 * as long as the distance between macroblocks in the info is smaller
1430 * than the target payload size.
1431 * Each MB info structure is 12 bytes, and is laid out as follows:
1433 * u32le bit offset from the start of the packet
1434 * u8 current quantizer at the start of the macroblock
1436 * u16le macroblock address within the GOB
1437 * u8 horizontal MV predictor
1438 * u8 vertical MV predictor
1439 * u8 horizontal MV predictor for block number 3
1440 * u8 vertical MV predictor for block number 3
1443 AV_PKT_DATA_H263_MB_INFO,
1446 * This side data should be associated with an audio stream and contains
1447 * ReplayGain information in form of the AVReplayGain struct.
1449 AV_PKT_DATA_REPLAYGAIN,
1452 * This side data contains a 3x3 transformation matrix describing an affine
1453 * transformation that needs to be applied to the decoded video frames for
1454 * correct presentation.
1456 * See libavutil/display.h for a detailed description of the data.
1458 AV_PKT_DATA_DISPLAYMATRIX,
1461 * This side data should be associated with a video stream and contains
1462 * Stereoscopic 3D information in form of the AVStereo3D struct.
1464 AV_PKT_DATA_STEREO3D,
1467 * This side data should be associated with an audio stream and corresponds
1468 * to enum AVAudioServiceType.
1470 AV_PKT_DATA_AUDIO_SERVICE_TYPE,
1473 * This side data contains quality related information from the encoder.
1475 * u32le quality factor of the compressed frame. Allowed range is between 1 (good) and FF_LAMBDA_MAX (bad).
1479 * u64le[error count] sum of squared differences between encoder in and output
1482 AV_PKT_DATA_QUALITY_STATS,
1485 * This side data contains an integer value representing the stream index
1486 * of a "fallback" track. A fallback track indicates an alternate
1487 * track to use when the current track can not be decoded for some reason.
1488 * e.g. no decoder available for codec.
1490 AV_PKT_DATA_FALLBACK_TRACK,
1493 * This side data corresponds to the AVCPBProperties struct.
1495 AV_PKT_DATA_CPB_PROPERTIES,
1498 * Recommmends skipping the specified number of samples
1500 * u32le number of samples to skip from start of this packet
1501 * u32le number of samples to skip from end of this packet
1502 * u8 reason for start skip
1503 * u8 reason for end skip (0=padding silence, 1=convergence)
1506 AV_PKT_DATA_SKIP_SAMPLES=70,
1509 * An AV_PKT_DATA_JP_DUALMONO side data packet indicates that
1510 * the packet may contain "dual mono" audio specific to Japanese DTV
1511 * and if it is true, recommends only the selected channel to be used.
1513 * u8 selected channels (0=mail/left, 1=sub/right, 2=both)
1516 AV_PKT_DATA_JP_DUALMONO,
1519 * A list of zero terminated key/value strings. There is no end marker for
1520 * the list, so it is required to rely on the side data size to stop.
1522 AV_PKT_DATA_STRINGS_METADATA,
1525 * Subtitle event position
1533 AV_PKT_DATA_SUBTITLE_POSITION,
1536 * Data found in BlockAdditional element of matroska container. There is
1537 * no end marker for the data, so it is required to rely on the side data
1538 * size to recognize the end. 8 byte id (as found in BlockAddId) followed
1541 AV_PKT_DATA_MATROSKA_BLOCKADDITIONAL,
1544 * The optional first identifier line of a WebVTT cue.
1546 AV_PKT_DATA_WEBVTT_IDENTIFIER,
1549 * The optional settings (rendering instructions) that immediately
1550 * follow the timestamp specifier of a WebVTT cue.
1552 AV_PKT_DATA_WEBVTT_SETTINGS,
1555 * A list of zero terminated key/value strings. There is no end marker for
1556 * the list, so it is required to rely on the side data size to stop. This
1557 * side data includes updated metadata which appeared in the stream.
1559 AV_PKT_DATA_METADATA_UPDATE,
1562 * MPEGTS stream ID, this is required to pass the stream ID
1563 * information from the demuxer to the corresponding muxer.
1565 AV_PKT_DATA_MPEGTS_STREAM_ID,
1568 * Mastering display metadata (based on SMPTE-2086:2014). This metadata
1569 * should be associated with a video stream and containts data in the form
1570 * of the AVMasteringDisplayMetadata struct.
1572 AV_PKT_DATA_MASTERING_DISPLAY_METADATA,
1575 * This side data should be associated with a video stream and corresponds
1576 * to the AVSphericalMapping structure.
1578 AV_PKT_DATA_SPHERICAL,
1581 #define AV_PKT_DATA_QUALITY_FACTOR AV_PKT_DATA_QUALITY_STATS //DEPRECATED
1583 typedef struct AVPacketSideData {
1586 enum AVPacketSideDataType type;
1590 * This structure stores compressed data. It is typically exported by demuxers
1591 * and then passed as input to decoders, or received as output from encoders and
1592 * then passed to muxers.
1594 * For video, it should typically contain one compressed frame. For audio it may
1595 * contain several compressed frames. Encoders are allowed to output empty
1596 * packets, with no compressed data, containing only side data
1597 * (e.g. to update some stream parameters at the end of encoding).
1599 * AVPacket is one of the few structs in FFmpeg, whose size is a part of public
1600 * ABI. Thus it may be allocated on stack and no new fields can be added to it
1601 * without libavcodec and libavformat major bump.
1603 * The semantics of data ownership depends on the buf field.
1604 * If it is set, the packet data is dynamically allocated and is
1605 * valid indefinitely until a call to av_packet_unref() reduces the
1606 * reference count to 0.
1608 * If the buf field is not set av_packet_ref() would make a copy instead
1609 * of increasing the reference count.
1611 * The side data is always allocated with av_malloc(), copied by
1612 * av_packet_ref() and freed by av_packet_unref().
1614 * @see av_packet_ref
1615 * @see av_packet_unref
1617 typedef struct AVPacket {
1619 * A reference to the reference-counted buffer where the packet data is
1621 * May be NULL, then the packet data is not reference-counted.
1625 * Presentation timestamp in AVStream->time_base units; the time at which
1626 * the decompressed packet will be presented to the user.
1627 * Can be AV_NOPTS_VALUE if it is not stored in the file.
1628 * pts MUST be larger or equal to dts as presentation cannot happen before
1629 * decompression, unless one wants to view hex dumps. Some formats misuse
1630 * the terms dts and pts/cts to mean something different. Such timestamps
1631 * must be converted to true pts/dts before they are stored in AVPacket.
1635 * Decompression timestamp in AVStream->time_base units; the time at which
1636 * the packet is decompressed.
1637 * Can be AV_NOPTS_VALUE if it is not stored in the file.
1644 * A combination of AV_PKT_FLAG values
1648 * Additional packet data that can be provided by the container.
1649 * Packet can contain several types of side information.
1651 AVPacketSideData *side_data;
1652 int side_data_elems;
1655 * Duration of this packet in AVStream->time_base units, 0 if unknown.
1656 * Equals next_pts - this_pts in presentation order.
1660 int64_t pos; ///< byte position in stream, -1 if unknown
1662 #if FF_API_CONVERGENCE_DURATION
1664 * @deprecated Same as the duration field, but as int64_t. This was required
1665 * for Matroska subtitles, whose duration values could overflow when the
1666 * duration field was still an int.
1668 attribute_deprecated
1669 int64_t convergence_duration;
1672 #define AV_PKT_FLAG_KEY 0x0001 ///< The packet contains a keyframe
1673 #define AV_PKT_FLAG_CORRUPT 0x0002 ///< The packet content is corrupted
1675 * Flag is used to discard packets which are required to maintain valid
1676 * decoder state but are not required for output and should be dropped
1679 #define AV_PKT_FLAG_DISCARD 0x0004
1681 enum AVSideDataParamChangeFlags {
1682 AV_SIDE_DATA_PARAM_CHANGE_CHANNEL_COUNT = 0x0001,
1683 AV_SIDE_DATA_PARAM_CHANGE_CHANNEL_LAYOUT = 0x0002,
1684 AV_SIDE_DATA_PARAM_CHANGE_SAMPLE_RATE = 0x0004,
1685 AV_SIDE_DATA_PARAM_CHANGE_DIMENSIONS = 0x0008,
1691 struct AVCodecInternal;
1695 AV_FIELD_PROGRESSIVE,
1696 AV_FIELD_TT, //< Top coded_first, top displayed first
1697 AV_FIELD_BB, //< Bottom coded first, bottom displayed first
1698 AV_FIELD_TB, //< Top coded first, bottom displayed first
1699 AV_FIELD_BT, //< Bottom coded first, top displayed first
1703 * main external API structure.
1704 * New fields can be added to the end with minor version bumps.
1705 * Removal, reordering and changes to existing fields require a major
1707 * You can use AVOptions (av_opt* / av_set/get*()) to access these fields from user
1709 * The name string for AVOptions options matches the associated command line
1710 * parameter name and can be found in libavcodec/options_table.h
1711 * The AVOption/command line parameter names differ in some cases from the C
1712 * structure field names for historic reasons or brevity.
1713 * sizeof(AVCodecContext) must not be used outside libav*.
1715 typedef struct AVCodecContext {
1717 * information on struct for av_log
1718 * - set by avcodec_alloc_context3
1720 const AVClass *av_class;
1721 int log_level_offset;
1723 enum AVMediaType codec_type; /* see AVMEDIA_TYPE_xxx */
1724 const struct AVCodec *codec;
1725 #if FF_API_CODEC_NAME
1727 * @deprecated this field is not used for anything in libavcodec
1729 attribute_deprecated
1730 char codec_name[32];
1732 enum AVCodecID codec_id; /* see AV_CODEC_ID_xxx */
1735 * fourcc (LSB first, so "ABCD" -> ('D'<<24) + ('C'<<16) + ('B'<<8) + 'A').
1736 * This is used to work around some encoder bugs.
1737 * A demuxer should set this to what is stored in the field used to identify the codec.
1738 * If there are multiple such fields in a container then the demuxer should choose the one
1739 * which maximizes the information about the used codec.
1740 * If the codec tag field in a container is larger than 32 bits then the demuxer should
1741 * remap the longer ID to 32 bits with a table or other structure. Alternatively a new
1742 * extra_codec_tag + size could be added but for this a clear advantage must be demonstrated
1744 * - encoding: Set by user, if not then the default based on codec_id will be used.
1745 * - decoding: Set by user, will be converted to uppercase by libavcodec during init.
1747 unsigned int codec_tag;
1749 #if FF_API_STREAM_CODEC_TAG
1751 * @deprecated this field is unused
1753 attribute_deprecated
1754 unsigned int stream_codec_tag;
1760 * Private context used for internal data.
1762 * Unlike priv_data, this is not codec-specific. It is used in general
1763 * libavcodec functions.
1765 struct AVCodecInternal *internal;
1768 * Private data of the user, can be used to carry app specific stuff.
1769 * - encoding: Set by user.
1770 * - decoding: Set by user.
1775 * the average bitrate
1776 * - encoding: Set by user; unused for constant quantizer encoding.
1777 * - decoding: Set by user, may be overwritten by libavcodec
1778 * if this info is available in the stream
1783 * number of bits the bitstream is allowed to diverge from the reference.
1784 * the reference can be CBR (for CBR pass1) or VBR (for pass2)
1785 * - encoding: Set by user; unused for constant quantizer encoding.
1786 * - decoding: unused
1788 int bit_rate_tolerance;
1791 * Global quality for codecs which cannot change it per frame.
1792 * This should be proportional to MPEG-1/2/4 qscale.
1793 * - encoding: Set by user.
1794 * - decoding: unused
1799 * - encoding: Set by user.
1800 * - decoding: unused
1802 int compression_level;
1803 #define FF_COMPRESSION_DEFAULT -1
1807 * - encoding: Set by user.
1808 * - decoding: Set by user.
1814 * - encoding: Set by user.
1815 * - decoding: Set by user.
1820 * some codecs need / can use extradata like Huffman tables.
1821 * MJPEG: Huffman tables
1822 * rv10: additional flags
1823 * MPEG-4: global headers (they can be in the bitstream or here)
1824 * The allocated memory should be AV_INPUT_BUFFER_PADDING_SIZE bytes larger
1825 * than extradata_size to avoid problems if it is read with the bitstream reader.
1826 * The bytewise contents of extradata must not depend on the architecture or CPU endianness.
1827 * - encoding: Set/allocated/freed by libavcodec.
1828 * - decoding: Set/allocated/freed by user.
1834 * This is the fundamental unit of time (in seconds) in terms
1835 * of which frame timestamps are represented. For fixed-fps content,
1836 * timebase should be 1/framerate and timestamp increments should be
1838 * This often, but not always is the inverse of the frame rate or field rate
1839 * for video. 1/time_base is not the average frame rate if the frame rate is not
1842 * Like containers, elementary streams also can store timestamps, 1/time_base
1843 * is the unit in which these timestamps are specified.
1844 * As example of such codec time base see ISO/IEC 14496-2:2001(E)
1845 * vop_time_increment_resolution and fixed_vop_rate
1846 * (fixed_vop_rate == 0 implies that it is different from the framerate)
1848 * - encoding: MUST be set by user.
1849 * - decoding: the use of this field for decoding is deprecated.
1850 * Use framerate instead.
1852 AVRational time_base;
1855 * For some codecs, the time base is closer to the field rate than the frame rate.
1856 * Most notably, H.264 and MPEG-2 specify time_base as half of frame duration
1857 * if no telecine is used ...
1859 * Set to time_base ticks per frame. Default 1, e.g., H.264/MPEG-2 set it to 2.
1861 int ticks_per_frame;
1866 * Encoding: Number of frames delay there will be from the encoder input to
1867 * the decoder output. (we assume the decoder matches the spec)
1868 * Decoding: Number of frames delay in addition to what a standard decoder
1869 * as specified in the spec would produce.
1872 * Number of frames the decoded output will be delayed relative to the
1876 * For encoding, this field is unused (see initial_padding).
1878 * For decoding, this is the number of samples the decoder needs to
1879 * output before the decoder's output is valid. When seeking, you should
1880 * start decoding this many samples prior to your desired seek point.
1882 * - encoding: Set by libavcodec.
1883 * - decoding: Set by libavcodec.
1890 * picture width / height.
1892 * @note Those fields may not match the values of the last
1893 * AVFrame output by avcodec_decode_video2 due frame
1896 * - encoding: MUST be set by user.
1897 * - decoding: May be set by the user before opening the decoder if known e.g.
1898 * from the container. Some decoders will require the dimensions
1899 * to be set by the caller. During decoding, the decoder may
1900 * overwrite those values as required while parsing the data.
1905 * Bitstream width / height, may be different from width/height e.g. when
1906 * the decoded frame is cropped before being output or lowres is enabled.
1908 * @note Those field may not match the value of the last
1909 * AVFrame output by avcodec_receive_frame() due frame
1912 * - encoding: unused
1913 * - decoding: May be set by the user before opening the decoder if known
1914 * e.g. from the container. During decoding, the decoder may
1915 * overwrite those values as required while parsing the data.
1917 int coded_width, coded_height;
1919 #if FF_API_ASPECT_EXTENDED
1920 #define FF_ASPECT_EXTENDED 15
1924 * the number of pictures in a group of pictures, or 0 for intra_only
1925 * - encoding: Set by user.
1926 * - decoding: unused
1931 * Pixel format, see AV_PIX_FMT_xxx.
1932 * May be set by the demuxer if known from headers.
1933 * May be overridden by the decoder if it knows better.
1935 * @note This field may not match the value of the last
1936 * AVFrame output by avcodec_receive_frame() due frame
1939 * - encoding: Set by user.
1940 * - decoding: Set by user if known, overridden by libavcodec while
1943 enum AVPixelFormat pix_fmt;
1945 #if FF_API_MOTION_EST
1947 * This option does nothing
1948 * @deprecated use codec private options instead
1950 attribute_deprecated int me_method;
1954 * If non NULL, 'draw_horiz_band' is called by the libavcodec
1955 * decoder to draw a horizontal band. It improves cache usage. Not
1956 * all codecs can do that. You must check the codec capabilities
1958 * When multithreading is used, it may be called from multiple threads
1959 * at the same time; threads might draw different parts of the same AVFrame,
1960 * or multiple AVFrames, and there is no guarantee that slices will be drawn
1962 * The function is also used by hardware acceleration APIs.
1963 * It is called at least once during frame decoding to pass
1964 * the data needed for hardware render.
1965 * In that mode instead of pixel data, AVFrame points to
1966 * a structure specific to the acceleration API. The application
1967 * reads the structure and can change some fields to indicate progress
1969 * - encoding: unused
1970 * - decoding: Set by user.
1971 * @param height the height of the slice
1972 * @param y the y position of the slice
1973 * @param type 1->top field, 2->bottom field, 3->frame
1974 * @param offset offset into the AVFrame.data from which the slice should be read
1976 void (*draw_horiz_band)(struct AVCodecContext *s,
1977 const AVFrame *src, int offset[AV_NUM_DATA_POINTERS],
1978 int y, int type, int height);
1981 * callback to negotiate the pixelFormat
1982 * @param fmt is the list of formats which are supported by the codec,
1983 * it is terminated by -1 as 0 is a valid format, the formats are ordered by quality.
1984 * The first is always the native one.
1985 * @note The callback may be called again immediately if initialization for
1986 * the selected (hardware-accelerated) pixel format failed.
1987 * @warning Behavior is undefined if the callback returns a value not
1988 * in the fmt list of formats.
1989 * @return the chosen format
1990 * - encoding: unused
1991 * - decoding: Set by user, if not set the native format will be chosen.
1993 enum AVPixelFormat (*get_format)(struct AVCodecContext *s, const enum AVPixelFormat * fmt);
1996 * maximum number of B-frames between non-B-frames
1997 * Note: The output will be delayed by max_b_frames+1 relative to the input.
1998 * - encoding: Set by user.
1999 * - decoding: unused
2004 * qscale factor between IP and B-frames
2005 * If > 0 then the last P-frame quantizer will be used (q= lastp_q*factor+offset).
2006 * If < 0 then normal ratecontrol will be done (q= -normal_q*factor+offset).
2007 * - encoding: Set by user.
2008 * - decoding: unused
2010 float b_quant_factor;
2012 #if FF_API_RC_STRATEGY
2013 /** @deprecated use codec private option instead */
2014 attribute_deprecated int rc_strategy;
2015 #define FF_RC_STRATEGY_XVID 1
2018 #if FF_API_PRIVATE_OPT
2019 /** @deprecated use encoder private options instead */
2020 attribute_deprecated
2021 int b_frame_strategy;
2025 * qscale offset between IP and B-frames
2026 * - encoding: Set by user.
2027 * - decoding: unused
2029 float b_quant_offset;
2032 * Size of the frame reordering buffer in the decoder.
2033 * For MPEG-2 it is 1 IPB or 0 low delay IP.
2034 * - encoding: Set by libavcodec.
2035 * - decoding: Set by libavcodec.
2039 #if FF_API_PRIVATE_OPT
2040 /** @deprecated use encoder private options instead */
2041 attribute_deprecated
2046 * qscale factor between P- and I-frames
2047 * If > 0 then the last P-frame quantizer will be used (q = lastp_q * factor + offset).
2048 * If < 0 then normal ratecontrol will be done (q= -normal_q*factor+offset).
2049 * - encoding: Set by user.
2050 * - decoding: unused
2052 float i_quant_factor;
2055 * qscale offset between P and I-frames
2056 * - encoding: Set by user.
2057 * - decoding: unused
2059 float i_quant_offset;
2062 * luminance masking (0-> disabled)
2063 * - encoding: Set by user.
2064 * - decoding: unused
2069 * temporary complexity masking (0-> disabled)
2070 * - encoding: Set by user.
2071 * - decoding: unused
2073 float temporal_cplx_masking;
2076 * spatial complexity masking (0-> disabled)
2077 * - encoding: Set by user.
2078 * - decoding: unused
2080 float spatial_cplx_masking;
2083 * p block masking (0-> disabled)
2084 * - encoding: Set by user.
2085 * - decoding: unused
2090 * darkness masking (0-> disabled)
2091 * - encoding: Set by user.
2092 * - decoding: unused
2098 * - encoding: Set by libavcodec.
2099 * - decoding: Set by user (or 0).
2103 #if FF_API_PRIVATE_OPT
2104 /** @deprecated use encoder private options instead */
2105 attribute_deprecated
2106 int prediction_method;
2107 #define FF_PRED_LEFT 0
2108 #define FF_PRED_PLANE 1
2109 #define FF_PRED_MEDIAN 2
2113 * slice offsets in the frame in bytes
2114 * - encoding: Set/allocated by libavcodec.
2115 * - decoding: Set/allocated by user (or NULL).
2120 * sample aspect ratio (0 if unknown)
2121 * That is the width of a pixel divided by the height of the pixel.
2122 * Numerator and denominator must be relatively prime and smaller than 256 for some video standards.
2123 * - encoding: Set by user.
2124 * - decoding: Set by libavcodec.
2126 AVRational sample_aspect_ratio;
2129 * motion estimation comparison function
2130 * - encoding: Set by user.
2131 * - decoding: unused
2135 * subpixel motion estimation comparison function
2136 * - encoding: Set by user.
2137 * - decoding: unused
2141 * macroblock comparison function (not supported yet)
2142 * - encoding: Set by user.
2143 * - decoding: unused
2147 * interlaced DCT comparison function
2148 * - encoding: Set by user.
2149 * - decoding: unused
2152 #define FF_CMP_SAD 0
2153 #define FF_CMP_SSE 1
2154 #define FF_CMP_SATD 2
2155 #define FF_CMP_DCT 3
2156 #define FF_CMP_PSNR 4
2157 #define FF_CMP_BIT 5
2159 #define FF_CMP_ZERO 7
2160 #define FF_CMP_VSAD 8
2161 #define FF_CMP_VSSE 9
2162 #define FF_CMP_NSSE 10
2163 #define FF_CMP_W53 11
2164 #define FF_CMP_W97 12
2165 #define FF_CMP_DCTMAX 13
2166 #define FF_CMP_DCT264 14
2167 #define FF_CMP_MEDIAN_SAD 15
2168 #define FF_CMP_CHROMA 256
2171 * ME diamond size & shape
2172 * - encoding: Set by user.
2173 * - decoding: unused
2178 * amount of previous MV predictors (2a+1 x 2a+1 square)
2179 * - encoding: Set by user.
2180 * - decoding: unused
2182 int last_predictor_count;
2184 #if FF_API_PRIVATE_OPT
2185 /** @deprecated use encoder private options instead */
2186 attribute_deprecated
2191 * motion estimation prepass comparison function
2192 * - encoding: Set by user.
2193 * - decoding: unused
2198 * ME prepass diamond size & shape
2199 * - encoding: Set by user.
2200 * - decoding: unused
2206 * - encoding: Set by user.
2207 * - decoding: unused
2209 int me_subpel_quality;
2213 * DTG active format information (additional aspect ratio
2214 * information only used in DVB MPEG-2 transport streams)
2217 * - encoding: unused
2218 * - decoding: Set by decoder.
2219 * @deprecated Deprecated in favor of AVSideData
2221 attribute_deprecated int dtg_active_format;
2222 #define FF_DTG_AFD_SAME 8
2223 #define FF_DTG_AFD_4_3 9
2224 #define FF_DTG_AFD_16_9 10
2225 #define FF_DTG_AFD_14_9 11
2226 #define FF_DTG_AFD_4_3_SP_14_9 13
2227 #define FF_DTG_AFD_16_9_SP_14_9 14
2228 #define FF_DTG_AFD_SP_4_3 15
2229 #endif /* FF_API_AFD */
2232 * maximum motion estimation search range in subpel units
2233 * If 0 then no limit.
2235 * - encoding: Set by user.
2236 * - decoding: unused
2240 #if FF_API_QUANT_BIAS
2242 * @deprecated use encoder private option instead
2244 attribute_deprecated int intra_quant_bias;
2245 #define FF_DEFAULT_QUANT_BIAS 999999
2248 * @deprecated use encoder private option instead
2250 attribute_deprecated int inter_quant_bias;
2255 * - encoding: unused
2256 * - decoding: Set by user.
2259 #define SLICE_FLAG_CODED_ORDER 0x0001 ///< draw_horiz_band() is called in coded order instead of display
2260 #define SLICE_FLAG_ALLOW_FIELD 0x0002 ///< allow draw_horiz_band() with field slices (MPEG-2 field pics)
2261 #define SLICE_FLAG_ALLOW_PLANE 0x0004 ///< allow draw_horiz_band() with 1 component at a time (SVQ1)
2265 * XVideo Motion Acceleration
2266 * - encoding: forbidden
2267 * - decoding: set by decoder
2268 * @deprecated XvMC doesn't need it anymore.
2270 attribute_deprecated int xvmc_acceleration;
2271 #endif /* FF_API_XVMC */
2274 * macroblock decision mode
2275 * - encoding: Set by user.
2276 * - decoding: unused
2279 #define FF_MB_DECISION_SIMPLE 0 ///< uses mb_cmp
2280 #define FF_MB_DECISION_BITS 1 ///< chooses the one which needs the fewest bits
2281 #define FF_MB_DECISION_RD 2 ///< rate distortion
2284 * custom intra quantization matrix
2285 * - encoding: Set by user, can be NULL.
2286 * - decoding: Set by libavcodec.
2288 uint16_t *intra_matrix;
2291 * custom inter quantization matrix
2292 * - encoding: Set by user, can be NULL.
2293 * - decoding: Set by libavcodec.
2295 uint16_t *inter_matrix;
2297 #if FF_API_PRIVATE_OPT
2298 /** @deprecated use encoder private options instead */
2299 attribute_deprecated
2300 int scenechange_threshold;
2302 /** @deprecated use encoder private options instead */
2303 attribute_deprecated
2304 int noise_reduction;
2309 * @deprecated this field is unused
2311 attribute_deprecated
2315 * @deprecated this field is unused
2317 attribute_deprecated
2322 * precision of the intra DC coefficient - 8
2323 * - encoding: Set by user.
2324 * - decoding: Set by libavcodec
2326 int intra_dc_precision;
2329 * Number of macroblock rows at the top which are skipped.
2330 * - encoding: unused
2331 * - decoding: Set by user.
2336 * Number of macroblock rows at the bottom which are skipped.
2337 * - encoding: unused
2338 * - decoding: Set by user.
2344 * @deprecated use encoder private options instead
2346 attribute_deprecated
2347 float border_masking;
2351 * minimum MB Lagrange multiplier
2352 * - encoding: Set by user.
2353 * - decoding: unused
2358 * maximum MB Lagrange multiplier
2359 * - encoding: Set by user.
2360 * - decoding: unused
2364 #if FF_API_PRIVATE_OPT
2366 * @deprecated use encoder private options instead
2368 attribute_deprecated
2369 int me_penalty_compensation;
2373 * - encoding: Set by user.
2374 * - decoding: unused
2378 #if FF_API_PRIVATE_OPT
2379 /** @deprecated use encoder private options instead */
2380 attribute_deprecated
2386 * - encoding: Set by user.
2387 * - decoding: unused
2392 * number of reference frames
2393 * - encoding: Set by user.
2394 * - decoding: Set by lavc.
2398 #if FF_API_PRIVATE_OPT
2399 /** @deprecated use encoder private options instead */
2400 attribute_deprecated
2404 #if FF_API_UNUSED_MEMBERS
2406 * Multiplied by qscale for each frame and added to scene_change_score.
2407 * - encoding: Set by user.
2408 * - decoding: unused
2410 attribute_deprecated int scenechange_factor;
2414 * Note: Value depends upon the compare function used for fullpel ME.
2415 * - encoding: Set by user.
2416 * - decoding: unused
2420 #if FF_API_PRIVATE_OPT
2421 /** @deprecated use encoder private options instead */
2422 attribute_deprecated
2427 * Chromaticity coordinates of the source primaries.
2428 * - encoding: Set by user
2429 * - decoding: Set by libavcodec
2431 enum AVColorPrimaries color_primaries;
2434 * Color Transfer Characteristic.
2435 * - encoding: Set by user
2436 * - decoding: Set by libavcodec
2438 enum AVColorTransferCharacteristic color_trc;
2441 * YUV colorspace type.
2442 * - encoding: Set by user
2443 * - decoding: Set by libavcodec
2445 enum AVColorSpace colorspace;
2448 * MPEG vs JPEG YUV range.
2449 * - encoding: Set by user
2450 * - decoding: Set by libavcodec
2452 enum AVColorRange color_range;
2455 * This defines the location of chroma samples.
2456 * - encoding: Set by user
2457 * - decoding: Set by libavcodec
2459 enum AVChromaLocation chroma_sample_location;
2463 * Indicates number of picture subdivisions. Used for parallelized
2465 * - encoding: Set by user
2466 * - decoding: unused
2471 * - encoding: set by libavcodec
2472 * - decoding: Set by user.
2474 enum AVFieldOrder field_order;
2477 int sample_rate; ///< samples per second
2478 int channels; ///< number of audio channels
2481 * audio sample format
2482 * - encoding: Set by user.
2483 * - decoding: Set by libavcodec.
2485 enum AVSampleFormat sample_fmt; ///< sample format
2487 /* The following data should not be initialized. */
2489 * Number of samples per channel in an audio frame.
2491 * - encoding: set by libavcodec in avcodec_open2(). Each submitted frame
2492 * except the last must contain exactly frame_size samples per channel.
2493 * May be 0 when the codec has AV_CODEC_CAP_VARIABLE_FRAME_SIZE set, then the
2494 * frame size is not restricted.
2495 * - decoding: may be set by some decoders to indicate constant frame size
2500 * Frame counter, set by libavcodec.
2502 * - decoding: total number of frames returned from the decoder so far.
2503 * - encoding: total number of frames passed to the encoder so far.
2505 * @note the counter is not incremented if encoding/decoding resulted in
2511 * number of bytes per packet if constant and known or 0
2512 * Used by some WAV based audio codecs.
2517 * Audio cutoff bandwidth (0 means "automatic")
2518 * - encoding: Set by user.
2519 * - decoding: unused
2524 * Audio channel layout.
2525 * - encoding: set by user.
2526 * - decoding: set by user, may be overwritten by libavcodec.
2528 uint64_t channel_layout;
2531 * Request decoder to use this channel layout if it can (0 for default)
2532 * - encoding: unused
2533 * - decoding: Set by user.
2535 uint64_t request_channel_layout;
2538 * Type of service that the audio stream conveys.
2539 * - encoding: Set by user.
2540 * - decoding: Set by libavcodec.
2542 enum AVAudioServiceType audio_service_type;
2545 * desired sample format
2546 * - encoding: Not used.
2547 * - decoding: Set by user.
2548 * Decoder will decode to this format if it can.
2550 enum AVSampleFormat request_sample_fmt;
2553 * This callback is called at the beginning of each frame to get data
2554 * buffer(s) for it. There may be one contiguous buffer for all the data or
2555 * there may be a buffer per each data plane or anything in between. What
2556 * this means is, you may set however many entries in buf[] you feel necessary.
2557 * Each buffer must be reference-counted using the AVBuffer API (see description
2560 * The following fields will be set in the frame before this callback is
2563 * - width, height (video only)
2564 * - sample_rate, channel_layout, nb_samples (audio only)
2565 * Their values may differ from the corresponding values in
2566 * AVCodecContext. This callback must use the frame values, not the codec
2567 * context values, to calculate the required buffer size.
2569 * This callback must fill the following fields in the frame:
2573 * * if the data is planar audio with more than 8 channels, then this
2574 * callback must allocate and fill extended_data to contain all pointers
2575 * to all data planes. data[] must hold as many pointers as it can.
2576 * extended_data must be allocated with av_malloc() and will be freed in
2578 * * otherwise extended_data must point to data
2579 * - buf[] must contain one or more pointers to AVBufferRef structures. Each of
2580 * the frame's data and extended_data pointers must be contained in these. That
2581 * is, one AVBufferRef for each allocated chunk of memory, not necessarily one
2582 * AVBufferRef per data[] entry. See: av_buffer_create(), av_buffer_alloc(),
2583 * and av_buffer_ref().
2584 * - extended_buf and nb_extended_buf must be allocated with av_malloc() by
2585 * this callback and filled with the extra buffers if there are more
2586 * buffers than buf[] can hold. extended_buf will be freed in
2589 * If AV_CODEC_CAP_DR1 is not set then get_buffer2() must call
2590 * avcodec_default_get_buffer2() instead of providing buffers allocated by
2593 * Each data plane must be aligned to the maximum required by the target
2596 * @see avcodec_default_get_buffer2()
2600 * If AV_GET_BUFFER_FLAG_REF is set in flags then the frame may be reused
2601 * (read and/or written to if it is writable) later by libavcodec.
2603 * avcodec_align_dimensions2() should be used to find the required width and
2604 * height, as they normally need to be rounded up to the next multiple of 16.
2606 * Some decoders do not support linesizes changing between frames.
2608 * If frame multithreading is used and thread_safe_callbacks is set,
2609 * this callback may be called from a different thread, but not from more
2610 * than one at once. Does not need to be reentrant.
2612 * @see avcodec_align_dimensions2()
2616 * Decoders request a buffer of a particular size by setting
2617 * AVFrame.nb_samples prior to calling get_buffer2(). The decoder may,
2618 * however, utilize only part of the buffer by setting AVFrame.nb_samples
2619 * to a smaller value in the output frame.
2621 * As a convenience, av_samples_get_buffer_size() and
2622 * av_samples_fill_arrays() in libavutil may be used by custom get_buffer2()
2623 * functions to find the required data size and to fill data pointers and
2624 * linesize. In AVFrame.linesize, only linesize[0] may be set for audio
2625 * since all planes must be the same size.
2627 * @see av_samples_get_buffer_size(), av_samples_fill_arrays()
2629 * - encoding: unused
2630 * - decoding: Set by libavcodec, user can override.
2632 int (*get_buffer2)(struct AVCodecContext *s, AVFrame *frame, int flags);
2635 * If non-zero, the decoded audio and video frames returned from
2636 * avcodec_decode_video2() and avcodec_decode_audio4() are reference-counted
2637 * and are valid indefinitely. The caller must free them with
2638 * av_frame_unref() when they are not needed anymore.
2639 * Otherwise, the decoded frames must not be freed by the caller and are
2640 * only valid until the next decode call.
2642 * This is always automatically enabled if avcodec_receive_frame() is used.
2644 * - encoding: unused
2645 * - decoding: set by the caller before avcodec_open2().
2647 int refcounted_frames;
2649 /* - encoding parameters */
2650 float qcompress; ///< amount of qscale change between easy & hard scenes (0.0-1.0)
2651 float qblur; ///< amount of qscale smoothing over time (0.0-1.0)
2655 * - encoding: Set by user.
2656 * - decoding: unused
2662 * - encoding: Set by user.
2663 * - decoding: unused
2668 * maximum quantizer difference between frames
2669 * - encoding: Set by user.
2670 * - decoding: unused
2676 * @deprecated use encoder private options instead
2678 attribute_deprecated
2681 attribute_deprecated
2683 attribute_deprecated
2688 * decoder bitstream buffer size
2689 * - encoding: Set by user.
2690 * - decoding: unused
2695 * ratecontrol override, see RcOverride
2696 * - encoding: Allocated/set/freed by user.
2697 * - decoding: unused
2699 int rc_override_count;
2700 RcOverride *rc_override;
2704 * @deprecated use encoder private options instead
2706 attribute_deprecated
2712 * - encoding: Set by user.
2713 * - decoding: Set by user, may be overwritten by libavcodec.
2715 int64_t rc_max_rate;
2719 * - encoding: Set by user.
2720 * - decoding: unused
2722 int64_t rc_min_rate;
2726 * @deprecated use encoder private options instead
2728 attribute_deprecated
2729 float rc_buffer_aggressivity;
2731 attribute_deprecated
2732 float rc_initial_cplx;
2736 * Ratecontrol attempt to use, at maximum, <value> of what can be used without an underflow.
2737 * - encoding: Set by user.
2738 * - decoding: unused.
2740 float rc_max_available_vbv_use;
2743 * Ratecontrol attempt to use, at least, <value> times the amount needed to prevent a vbv overflow.
2744 * - encoding: Set by user.
2745 * - decoding: unused.
2747 float rc_min_vbv_overflow_use;
2750 * Number of bits which should be loaded into the rc buffer before decoding starts.
2751 * - encoding: Set by user.
2752 * - decoding: unused
2754 int rc_initial_buffer_occupancy;
2756 #if FF_API_CODER_TYPE
2757 #define FF_CODER_TYPE_VLC 0
2758 #define FF_CODER_TYPE_AC 1
2759 #define FF_CODER_TYPE_RAW 2
2760 #define FF_CODER_TYPE_RLE 3
2761 #if FF_API_UNUSED_MEMBERS
2762 #define FF_CODER_TYPE_DEFLATE 4
2763 #endif /* FF_API_UNUSED_MEMBERS */
2765 * @deprecated use encoder private options instead
2767 attribute_deprecated
2769 #endif /* FF_API_CODER_TYPE */
2771 #if FF_API_PRIVATE_OPT
2772 /** @deprecated use encoder private options instead */
2773 attribute_deprecated
2779 * @deprecated use encoder private options instead
2781 attribute_deprecated
2785 * @deprecated use encoder private options instead
2787 attribute_deprecated
2791 #if FF_API_PRIVATE_OPT
2792 /** @deprecated use encoder private options instead */
2793 attribute_deprecated
2794 int frame_skip_threshold;
2796 /** @deprecated use encoder private options instead */
2797 attribute_deprecated
2798 int frame_skip_factor;
2800 /** @deprecated use encoder private options instead */
2801 attribute_deprecated
2804 /** @deprecated use encoder private options instead */
2805 attribute_deprecated
2807 #endif /* FF_API_PRIVATE_OPT */
2810 * trellis RD quantization
2811 * - encoding: Set by user.
2812 * - decoding: unused
2816 #if FF_API_PRIVATE_OPT
2817 /** @deprecated use encoder private options instead */
2818 attribute_deprecated
2819 int min_prediction_order;
2821 /** @deprecated use encoder private options instead */
2822 attribute_deprecated
2823 int max_prediction_order;
2825 /** @deprecated use encoder private options instead */
2826 attribute_deprecated
2827 int64_t timecode_frame_start;
2830 #if FF_API_RTP_CALLBACK
2832 * @deprecated unused
2834 /* The RTP callback: This function is called */
2835 /* every time the encoder has a packet to send. */
2836 /* It depends on the encoder if the data starts */
2837 /* with a Start Code (it should). H.263 does. */
2838 /* mb_nb contains the number of macroblocks */
2839 /* encoded in the RTP payload. */
2840 attribute_deprecated
2841 void (*rtp_callback)(struct AVCodecContext *avctx, void *data, int size, int mb_nb);
2844 #if FF_API_PRIVATE_OPT
2845 /** @deprecated use encoder private options instead */
2846 attribute_deprecated
2847 int rtp_payload_size; /* The size of the RTP payload: the coder will */
2848 /* do its best to deliver a chunk with size */
2849 /* below rtp_payload_size, the chunk will start */
2850 /* with a start code on some codecs like H.263. */
2851 /* This doesn't take account of any particular */
2852 /* headers inside the transmitted RTP payload. */
2855 #if FF_API_STAT_BITS
2856 /* statistics, used for 2-pass encoding */
2857 attribute_deprecated
2859 attribute_deprecated
2861 attribute_deprecated
2863 attribute_deprecated
2865 attribute_deprecated
2867 attribute_deprecated
2869 attribute_deprecated
2871 attribute_deprecated
2874 /** @deprecated this field is unused */
2875 attribute_deprecated
2880 * pass1 encoding statistics output buffer
2881 * - encoding: Set by libavcodec.
2882 * - decoding: unused
2887 * pass2 encoding statistics input buffer
2888 * Concatenated stuff from stats_out of pass1 should be placed here.
2889 * - encoding: Allocated/set/freed by user.
2890 * - decoding: unused
2895 * Work around bugs in encoders which sometimes cannot be detected automatically.
2896 * - encoding: Set by user
2897 * - decoding: Set by user
2899 int workaround_bugs;
2900 #define FF_BUG_AUTODETECT 1 ///< autodetection
2901 #if FF_API_OLD_MSMPEG4
2902 #define FF_BUG_OLD_MSMPEG4 2
2904 #define FF_BUG_XVID_ILACE 4
2905 #define FF_BUG_UMP4 8
2906 #define FF_BUG_NO_PADDING 16
2907 #define FF_BUG_AMV 32
2909 #define FF_BUG_AC_VLC 0 ///< Will be removed, libavcodec can now handle these non-compliant files by default.
2911 #define FF_BUG_QPEL_CHROMA 64
2912 #define FF_BUG_STD_QPEL 128
2913 #define FF_BUG_QPEL_CHROMA2 256
2914 #define FF_BUG_DIRECT_BLOCKSIZE 512
2915 #define FF_BUG_EDGE 1024
2916 #define FF_BUG_HPEL_CHROMA 2048
2917 #define FF_BUG_DC_CLIP 4096
2918 #define FF_BUG_MS 8192 ///< Work around various bugs in Microsoft's broken decoders.
2919 #define FF_BUG_TRUNCATED 16384
2920 #define FF_BUG_IEDGE 32768
2923 * strictly follow the standard (MPEG-4, ...).
2924 * - encoding: Set by user.
2925 * - decoding: Set by user.
2926 * Setting this to STRICT or higher means the encoder and decoder will
2927 * generally do stupid things, whereas setting it to unofficial or lower
2928 * will mean the encoder might produce output that is not supported by all
2929 * spec-compliant decoders. Decoders don't differentiate between normal,
2930 * unofficial and experimental (that is, they always try to decode things
2931 * when they can) unless they are explicitly asked to behave stupidly
2932 * (=strictly conform to the specs)
2934 int strict_std_compliance;
2935 #define FF_COMPLIANCE_VERY_STRICT 2 ///< Strictly conform to an older more strict version of the spec or reference software.
2936 #define FF_COMPLIANCE_STRICT 1 ///< Strictly conform to all the things in the spec no matter what consequences.
2937 #define FF_COMPLIANCE_NORMAL 0
2938 #define FF_COMPLIANCE_UNOFFICIAL -1 ///< Allow unofficial extensions
2939 #define FF_COMPLIANCE_EXPERIMENTAL -2 ///< Allow nonstandardized experimental things.
2942 * error concealment flags
2943 * - encoding: unused
2944 * - decoding: Set by user.
2946 int error_concealment;
2947 #define FF_EC_GUESS_MVS 1
2948 #define FF_EC_DEBLOCK 2
2949 #define FF_EC_FAVOR_INTER 256
2953 * - encoding: Set by user.
2954 * - decoding: Set by user.
2957 #define FF_DEBUG_PICT_INFO 1
2958 #define FF_DEBUG_RC 2
2959 #define FF_DEBUG_BITSTREAM 4
2960 #define FF_DEBUG_MB_TYPE 8
2961 #define FF_DEBUG_QP 16
2964 * @deprecated this option does nothing
2966 #define FF_DEBUG_MV 32
2968 #define FF_DEBUG_DCT_COEFF 0x00000040
2969 #define FF_DEBUG_SKIP 0x00000080
2970 #define FF_DEBUG_STARTCODE 0x00000100
2971 #if FF_API_UNUSED_MEMBERS
2972 #define FF_DEBUG_PTS 0x00000200
2973 #endif /* FF_API_UNUSED_MEMBERS */
2974 #define FF_DEBUG_ER 0x00000400
2975 #define FF_DEBUG_MMCO 0x00000800
2976 #define FF_DEBUG_BUGS 0x00001000
2978 #define FF_DEBUG_VIS_QP 0x00002000
2979 #define FF_DEBUG_VIS_MB_TYPE 0x00004000
2981 #define FF_DEBUG_BUFFERS 0x00008000
2982 #define FF_DEBUG_THREADS 0x00010000
2983 #define FF_DEBUG_GREEN_MD 0x00800000
2984 #define FF_DEBUG_NOMC 0x01000000
2989 * - encoding: Set by user.
2990 * - decoding: Set by user.
2993 #define FF_DEBUG_VIS_MV_P_FOR 0x00000001 // visualize forward predicted MVs of P-frames
2994 #define FF_DEBUG_VIS_MV_B_FOR 0x00000002 // visualize forward predicted MVs of B-frames
2995 #define FF_DEBUG_VIS_MV_B_BACK 0x00000004 // visualize backward predicted MVs of B-frames
2999 * Error recognition; may misdetect some more or less valid parts as errors.
3000 * - encoding: unused
3001 * - decoding: Set by user.
3003 int err_recognition;
3006 * Verify checksums embedded in the bitstream (could be of either encoded or
3007 * decoded data, depending on the codec) and print an error message on mismatch.
3008 * If AV_EF_EXPLODE is also set, a mismatching checksum will result in the
3009 * decoder returning an error.
3011 #define AV_EF_CRCCHECK (1<<0)
3012 #define AV_EF_BITSTREAM (1<<1) ///< detect bitstream specification deviations
3013 #define AV_EF_BUFFER (1<<2) ///< detect improper bitstream length
3014 #define AV_EF_EXPLODE (1<<3) ///< abort decoding on minor error detection
3016 #define AV_EF_IGNORE_ERR (1<<15) ///< ignore errors and continue
3017 #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
3018 #define AV_EF_COMPLIANT (1<<17) ///< consider all spec non compliances as errors
3019 #define AV_EF_AGGRESSIVE (1<<18) ///< consider things that a sane encoder should not do as an error
3023 * opaque 64-bit number (generally a PTS) that will be reordered and
3024 * output in AVFrame.reordered_opaque
3025 * - encoding: unused
3026 * - decoding: Set by user.
3028 int64_t reordered_opaque;
3031 * Hardware accelerator in use
3032 * - encoding: unused.
3033 * - decoding: Set by libavcodec
3035 struct AVHWAccel *hwaccel;
3038 * Hardware accelerator context.
3039 * For some hardware accelerators, a global context needs to be
3040 * provided by the user. In that case, this holds display-dependent
3041 * data FFmpeg cannot instantiate itself. Please refer to the
3042 * FFmpeg HW accelerator documentation to know how to fill this
3043 * is. e.g. for VA API, this is a struct vaapi_context.
3044 * - encoding: unused
3045 * - decoding: Set by user
3047 void *hwaccel_context;
3051 * - encoding: Set by libavcodec if flags & AV_CODEC_FLAG_PSNR.
3052 * - decoding: unused
3054 uint64_t error[AV_NUM_DATA_POINTERS];
3057 * DCT algorithm, see FF_DCT_* below
3058 * - encoding: Set by user.
3059 * - decoding: unused
3062 #define FF_DCT_AUTO 0
3063 #define FF_DCT_FASTINT 1
3064 #define FF_DCT_INT 2
3065 #define FF_DCT_MMX 3
3066 #define FF_DCT_ALTIVEC 5
3067 #define FF_DCT_FAAN 6
3070 * IDCT algorithm, see FF_IDCT_* below.
3071 * - encoding: Set by user.
3072 * - decoding: Set by user.
3075 #define FF_IDCT_AUTO 0
3076 #define FF_IDCT_INT 1
3077 #define FF_IDCT_SIMPLE 2
3078 #define FF_IDCT_SIMPLEMMX 3
3079 #define FF_IDCT_ARM 7
3080 #define FF_IDCT_ALTIVEC 8
3082 #define FF_IDCT_SH4 9
3084 #define FF_IDCT_SIMPLEARM 10
3085 #if FF_API_UNUSED_MEMBERS
3086 #define FF_IDCT_IPP 13
3087 #endif /* FF_API_UNUSED_MEMBERS */
3088 #define FF_IDCT_XVID 14
3089 #if FF_API_IDCT_XVIDMMX
3090 #define FF_IDCT_XVIDMMX 14
3091 #endif /* FF_API_IDCT_XVIDMMX */
3092 #define FF_IDCT_SIMPLEARMV5TE 16
3093 #define FF_IDCT_SIMPLEARMV6 17
3094 #if FF_API_ARCH_SPARC
3095 #define FF_IDCT_SIMPLEVIS 18
3097 #define FF_IDCT_FAAN 20
3098 #define FF_IDCT_SIMPLENEON 22
3099 #if FF_API_ARCH_ALPHA
3100 #define FF_IDCT_SIMPLEALPHA 23
3102 #define FF_IDCT_SIMPLEAUTO 128
3105 * bits per sample/pixel from the demuxer (needed for huffyuv).
3106 * - encoding: Set by libavcodec.
3107 * - decoding: Set by user.
3109 int bits_per_coded_sample;
3112 * Bits per sample/pixel of internal libavcodec pixel/sample format.
3113 * - encoding: set by user.
3114 * - decoding: set by libavcodec.
3116 int bits_per_raw_sample;
3120 * low resolution decoding, 1-> 1/2 size, 2->1/4 size
3121 * - encoding: unused
3122 * - decoding: Set by user.
3127 #if FF_API_CODED_FRAME
3129 * the picture in the bitstream
3130 * - encoding: Set by libavcodec.
3131 * - decoding: unused
3133 * @deprecated use the quality factor packet side data instead
3135 attribute_deprecated AVFrame *coded_frame;
3140 * is used to decide how many independent tasks should be passed to execute()
3141 * - encoding: Set by user.
3142 * - decoding: Set by user.
3147 * Which multithreading methods to use.
3148 * Use of FF_THREAD_FRAME will increase decoding delay by one frame per thread,
3149 * so clients which cannot provide future frames should not use it.
3151 * - encoding: Set by user, otherwise the default is used.
3152 * - decoding: Set by user, otherwise the default is used.
3155 #define FF_THREAD_FRAME 1 ///< Decode more than one frame at once
3156 #define FF_THREAD_SLICE 2 ///< Decode more than one part of a single frame at once
3159 * Which multithreading methods are in use by the codec.
3160 * - encoding: Set by libavcodec.
3161 * - decoding: Set by libavcodec.
3163 int active_thread_type;
3166 * Set by the client if its custom get_buffer() callback can be called
3167 * synchronously from another thread, which allows faster multithreaded decoding.
3168 * draw_horiz_band() will be called from other threads regardless of this setting.
3169 * Ignored if the default get_buffer() is used.
3170 * - encoding: Set by user.
3171 * - decoding: Set by user.
3173 int thread_safe_callbacks;
3176 * The codec may call this to execute several independent things.
3177 * It will return only after finishing all tasks.
3178 * The user may replace this with some multithreaded implementation,
3179 * the default implementation will execute the parts serially.
3180 * @param count the number of things to execute
3181 * - encoding: Set by libavcodec, user can override.
3182 * - decoding: Set by libavcodec, user can override.
3184 int (*execute)(struct AVCodecContext *c, int (*func)(struct AVCodecContext *c2, void *arg), void *arg2, int *ret, int count, int size);
3187 * The codec may call this to execute several independent things.
3188 * It will return only after finishing all tasks.
3189 * The user may replace this with some multithreaded implementation,
3190 * the default implementation will execute the parts serially.
3191 * Also see avcodec_thread_init and e.g. the --enable-pthread configure option.
3192 * @param c context passed also to func
3193 * @param count the number of things to execute
3194 * @param arg2 argument passed unchanged to func
3195 * @param ret return values of executed functions, must have space for "count" values. May be NULL.
3196 * @param func function that will be called count times, with jobnr from 0 to count-1.
3197 * threadnr will be in the range 0 to c->thread_count-1 < MAX_THREADS and so that no
3198 * two instances of func executing at the same time will have the same threadnr.
3199 * @return always 0 currently, but code should handle a future improvement where when any call to func
3200 * returns < 0 no further calls to func may be done and < 0 is returned.
3201 * - encoding: Set by libavcodec, user can override.
3202 * - decoding: Set by libavcodec, user can override.
3204 int (*execute2)(struct AVCodecContext *c, int (*func)(struct AVCodecContext *c2, void *arg, int jobnr, int threadnr), void *arg2, int *ret, int count);
3207 * noise vs. sse weight for the nsse comparison function
3208 * - encoding: Set by user.
3209 * - decoding: unused
3215 * - encoding: Set by user.
3216 * - decoding: Set by libavcodec.
3219 #define FF_PROFILE_UNKNOWN -99
3220 #define FF_PROFILE_RESERVED -100
3222 #define FF_PROFILE_AAC_MAIN 0
3223 #define FF_PROFILE_AAC_LOW 1
3224 #define FF_PROFILE_AAC_SSR 2
3225 #define FF_PROFILE_AAC_LTP 3
3226 #define FF_PROFILE_AAC_HE 4
3227 #define FF_PROFILE_AAC_HE_V2 28
3228 #define FF_PROFILE_AAC_LD 22
3229 #define FF_PROFILE_AAC_ELD 38
3230 #define FF_PROFILE_MPEG2_AAC_LOW 128
3231 #define FF_PROFILE_MPEG2_AAC_HE 131
3233 #define FF_PROFILE_DNXHD 0
3234 #define FF_PROFILE_DNXHR_LB 1
3235 #define FF_PROFILE_DNXHR_SQ 2
3236 #define FF_PROFILE_DNXHR_HQ 3
3237 #define FF_PROFILE_DNXHR_HQX 4
3238 #define FF_PROFILE_DNXHR_444 5
3240 #define FF_PROFILE_DTS 20
3241 #define FF_PROFILE_DTS_ES 30
3242 #define FF_PROFILE_DTS_96_24 40
3243 #define FF_PROFILE_DTS_HD_HRA 50
3244 #define FF_PROFILE_DTS_HD_MA 60
3245 #define FF_PROFILE_DTS_EXPRESS 70
3247 #define FF_PROFILE_MPEG2_422 0
3248 #define FF_PROFILE_MPEG2_HIGH 1
3249 #define FF_PROFILE_MPEG2_SS 2
3250 #define FF_PROFILE_MPEG2_SNR_SCALABLE 3
3251 #define FF_PROFILE_MPEG2_MAIN 4
3252 #define FF_PROFILE_MPEG2_SIMPLE 5
3254 #define FF_PROFILE_H264_CONSTRAINED (1<<9) // 8+1; constraint_set1_flag
3255 #define FF_PROFILE_H264_INTRA (1<<11) // 8+3; constraint_set3_flag
3257 #define FF_PROFILE_H264_BASELINE 66
3258 #define FF_PROFILE_H264_CONSTRAINED_BASELINE (66|FF_PROFILE_H264_CONSTRAINED)
3259 #define FF_PROFILE_H264_MAIN 77
3260 #define FF_PROFILE_H264_EXTENDED 88
3261 #define FF_PROFILE_H264_HIGH 100
3262 #define FF_PROFILE_H264_HIGH_10 110
3263 #define FF_PROFILE_H264_HIGH_10_INTRA (110|FF_PROFILE_H264_INTRA)
3264 #define FF_PROFILE_H264_MULTIVIEW_HIGH 118
3265 #define FF_PROFILE_H264_HIGH_422 122
3266 #define FF_PROFILE_H264_HIGH_422_INTRA (122|FF_PROFILE_H264_INTRA)
3267 #define FF_PROFILE_H264_STEREO_HIGH 128
3268 #define FF_PROFILE_H264_HIGH_444 144
3269 #define FF_PROFILE_H264_HIGH_444_PREDICTIVE 244
3270 #define FF_PROFILE_H264_HIGH_444_INTRA (244|FF_PROFILE_H264_INTRA)
3271 #define FF_PROFILE_H264_CAVLC_444 44
3273 #define FF_PROFILE_VC1_SIMPLE 0
3274 #define FF_PROFILE_VC1_MAIN 1
3275 #define FF_PROFILE_VC1_COMPLEX 2
3276 #define FF_PROFILE_VC1_ADVANCED 3
3278 #define FF_PROFILE_MPEG4_SIMPLE 0
3279 #define FF_PROFILE_MPEG4_SIMPLE_SCALABLE 1
3280 #define FF_PROFILE_MPEG4_CORE 2
3281 #define FF_PROFILE_MPEG4_MAIN 3
3282 #define FF_PROFILE_MPEG4_N_BIT 4
3283 #define FF_PROFILE_MPEG4_SCALABLE_TEXTURE 5
3284 #define FF_PROFILE_MPEG4_SIMPLE_FACE_ANIMATION 6
3285 #define FF_PROFILE_MPEG4_BASIC_ANIMATED_TEXTURE 7
3286 #define FF_PROFILE_MPEG4_HYBRID 8
3287 #define FF_PROFILE_MPEG4_ADVANCED_REAL_TIME 9
3288 #define FF_PROFILE_MPEG4_CORE_SCALABLE 10
3289 #define FF_PROFILE_MPEG4_ADVANCED_CODING 11
3290 #define FF_PROFILE_MPEG4_ADVANCED_CORE 12
3291 #define FF_PROFILE_MPEG4_ADVANCED_SCALABLE_TEXTURE 13
3292 #define FF_PROFILE_MPEG4_SIMPLE_STUDIO 14
3293 #define FF_PROFILE_MPEG4_ADVANCED_SIMPLE 15
3295 #define FF_PROFILE_JPEG2000_CSTREAM_RESTRICTION_0 1
3296 #define FF_PROFILE_JPEG2000_CSTREAM_RESTRICTION_1 2
3297 #define FF_PROFILE_JPEG2000_CSTREAM_NO_RESTRICTION 32768
3298 #define FF_PROFILE_JPEG2000_DCINEMA_2K 3
3299 #define FF_PROFILE_JPEG2000_DCINEMA_4K 4
3301 #define FF_PROFILE_VP9_0 0
3302 #define FF_PROFILE_VP9_1 1
3303 #define FF_PROFILE_VP9_2 2
3304 #define FF_PROFILE_VP9_3 3
3306 #define FF_PROFILE_HEVC_MAIN 1
3307 #define FF_PROFILE_HEVC_MAIN_10 2
3308 #define FF_PROFILE_HEVC_MAIN_STILL_PICTURE 3
3309 #define FF_PROFILE_HEVC_REXT 4
3313 * - encoding: Set by user.
3314 * - decoding: Set by libavcodec.
3317 #define FF_LEVEL_UNKNOWN -99
3320 * Skip loop filtering for selected frames.
3321 * - encoding: unused
3322 * - decoding: Set by user.
3324 enum AVDiscard skip_loop_filter;
3327 * Skip IDCT/dequantization for selected frames.
3328 * - encoding: unused
3329 * - decoding: Set by user.
3331 enum AVDiscard skip_idct;
3334 * Skip decoding for selected frames.
3335 * - encoding: unused
3336 * - decoding: Set by user.
3338 enum AVDiscard skip_frame;
3341 * Header containing style information for text subtitles.
3342 * For SUBTITLE_ASS subtitle type, it should contain the whole ASS
3343 * [Script Info] and [V4+ Styles] section, plus the [Events] line and
3344 * the Format line following. It shouldn't include any Dialogue line.
3345 * - encoding: Set/allocated/freed by user (before avcodec_open2())
3346 * - decoding: Set/allocated/freed by libavcodec (by avcodec_open2())
3348 uint8_t *subtitle_header;
3349 int subtitle_header_size;
3351 #if FF_API_ERROR_RATE
3353 * @deprecated use the 'error_rate' private AVOption of the mpegvideo
3356 attribute_deprecated
3360 #if FF_API_VBV_DELAY
3362 * VBV delay coded in the last frame (in periods of a 27 MHz clock).
3363 * Used for compliant TS muxing.
3364 * - encoding: Set by libavcodec.
3365 * - decoding: unused.
3366 * @deprecated this value is now exported as a part of
3367 * AV_PKT_DATA_CPB_PROPERTIES packet side data
3369 attribute_deprecated
3373 #if FF_API_SIDEDATA_ONLY_PKT
3375 * Encoding only and set by default. Allow encoders to output packets
3376 * that do not contain any encoded data, only side data.
3378 * Some encoders need to output such packets, e.g. to update some stream
3379 * parameters at the end of encoding.
3381 * @deprecated this field disables the default behaviour and
3382 * it is kept only for compatibility.
3384 attribute_deprecated
3385 int side_data_only_packets;
3389 * Audio only. The number of "priming" samples (padding) inserted by the
3390 * encoder at the beginning of the audio. I.e. this number of leading
3391 * decoded samples must be discarded by the caller to get the original audio
3392 * without leading padding.
3394 * - decoding: unused
3395 * - encoding: Set by libavcodec. The timestamps on the output packets are
3396 * adjusted by the encoder so that they always refer to the
3397 * first sample of the data actually contained in the packet,
3398 * including any added padding. E.g. if the timebase is
3399 * 1/samplerate and the timestamp of the first input sample is
3400 * 0, the timestamp of the first output packet will be
3403 int initial_padding;
3406 * - decoding: For codecs that store a framerate value in the compressed
3407 * bitstream, the decoder may export it here. { 0, 1} when
3409 * - encoding: May be used to signal the framerate of CFR content to an
3412 AVRational framerate;
3415 * Nominal unaccelerated pixel format, see AV_PIX_FMT_xxx.
3416 * - encoding: unused.
3417 * - decoding: Set by libavcodec before calling get_format()
3419 enum AVPixelFormat sw_pix_fmt;
3422 * Timebase in which pkt_dts/pts and AVPacket.dts/pts are.
3423 * - encoding unused.
3424 * - decoding set by user.
3426 AVRational pkt_timebase;
3430 * - encoding: unused.
3431 * - decoding: set by libavcodec.
3433 const AVCodecDescriptor *codec_descriptor;
3437 * low resolution decoding, 1-> 1/2 size, 2->1/4 size
3438 * - encoding: unused
3439 * - decoding: Set by user.
3445 * Current statistics for PTS correction.
3446 * - decoding: maintained and used by libavcodec, not intended to be used by user apps
3447 * - encoding: unused
3449 int64_t pts_correction_num_faulty_pts; /// Number of incorrect PTS values so far
3450 int64_t pts_correction_num_faulty_dts; /// Number of incorrect DTS values so far
3451 int64_t pts_correction_last_pts; /// PTS of the last frame
3452 int64_t pts_correction_last_dts; /// DTS of the last frame
3455 * Character encoding of the input subtitles file.
3456 * - decoding: set by user
3457 * - encoding: unused
3462 * Subtitles character encoding mode. Formats or codecs might be adjusting
3463 * this setting (if they are doing the conversion themselves for instance).
3464 * - decoding: set by libavcodec
3465 * - encoding: unused
3467 int sub_charenc_mode;
3468 #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)
3469 #define FF_SUB_CHARENC_MODE_AUTOMATIC 0 ///< libavcodec will select the mode itself
3470 #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
3473 * Skip processing alpha if supported by codec.
3474 * Note that if the format uses pre-multiplied alpha (common with VP6,
3475 * and recommended due to better video quality/compression)
3476 * the image will look as if alpha-blended onto a black background.
3477 * However for formats that do not use pre-multiplied alpha
3478 * there might be serious artefacts (though e.g. libswscale currently
3479 * assumes pre-multiplied alpha anyway).
3481 * - decoding: set by user
3482 * - encoding: unused
3487 * Number of samples to skip after a discontinuity
3488 * - decoding: unused
3489 * - encoding: set by libavcodec
3493 #if !FF_API_DEBUG_MV
3495 * debug motion vectors
3496 * - encoding: Set by user.
3497 * - decoding: Set by user.
3500 #define FF_DEBUG_VIS_MV_P_FOR 0x00000001 //visualize forward predicted MVs of P frames
3501 #define FF_DEBUG_VIS_MV_B_FOR 0x00000002 //visualize forward predicted MVs of B frames
3502 #define FF_DEBUG_VIS_MV_B_BACK 0x00000004 //visualize backward predicted MVs of B frames
3506 * custom intra quantization matrix
3507 * - encoding: Set by user, can be NULL.
3508 * - decoding: unused.
3510 uint16_t *chroma_intra_matrix;
3513 * dump format separator.
3514 * can be ", " or "\n " or anything else
3515 * - encoding: Set by user.
3516 * - decoding: Set by user.
3518 uint8_t *dump_separator;
3521 * ',' separated list of allowed decoders.
3522 * If NULL then all are allowed
3523 * - encoding: unused
3524 * - decoding: set by user
3526 char *codec_whitelist;
3529 * Properties of the stream that gets decoded
3530 * - encoding: unused
3531 * - decoding: set by libavcodec
3533 unsigned properties;
3534 #define FF_CODEC_PROPERTY_LOSSLESS 0x00000001
3535 #define FF_CODEC_PROPERTY_CLOSED_CAPTIONS 0x00000002
3538 * Additional data associated with the entire coded stream.
3540 * - decoding: unused
3541 * - encoding: may be set by libavcodec after avcodec_open2().
3543 AVPacketSideData *coded_side_data;
3544 int nb_coded_side_data;
3547 * A reference to the AVHWFramesContext describing the input (for encoding)
3548 * or output (decoding) frames. The reference is set by the caller and
3549 * afterwards owned (and freed) by libavcodec - it should never be read by
3550 * the caller after being set.
3552 * - decoding: This field should be set by the caller from the get_format()
3553 * callback. The previous reference (if any) will always be
3554 * unreffed by libavcodec before the get_format() call.
3556 * If the default get_buffer2() is used with a hwaccel pixel
3557 * format, then this AVHWFramesContext will be used for
3558 * allocating the frame buffers.
3560 * - encoding: For hardware encoders configured to use a hwaccel pixel
3561 * format, this field should be set by the caller to a reference
3562 * to the AVHWFramesContext describing input frames.
3563 * AVHWFramesContext.format must be equal to
3564 * AVCodecContext.pix_fmt.
3566 * This field should be set before avcodec_open2() is called.
3568 AVBufferRef *hw_frames_ctx;
3571 * Control the form of AVSubtitle.rects[N]->ass
3572 * - decoding: set by user
3573 * - encoding: unused
3575 int sub_text_format;
3576 #define FF_SUB_TEXT_FMT_ASS 0
3577 #if FF_API_ASS_TIMING
3578 #define FF_SUB_TEXT_FMT_ASS_WITH_TIMINGS 1
3582 * Audio only. The amount of padding (in samples) appended by the encoder to
3583 * the end of the audio. I.e. this number of decoded samples must be
3584 * discarded by the caller from the end of the stream to get the original
3585 * audio without any trailing padding.
3587 * - decoding: unused
3588 * - encoding: unused
3590 int trailing_padding;
3593 * The number of pixels per image to maximally accept.
3595 * - decoding: set by user
3596 * - encoding: set by user
3601 * A reference to the AVHWDeviceContext describing the device which will
3602 * be used by a hardware encoder/decoder. The reference is set by the
3603 * caller and afterwards owned (and freed) by libavcodec.
3605 * This should be used if either the codec device does not require
3606 * hardware frames or any that are used are to be allocated internally by
3607 * libavcodec. If the user wishes to supply any of the frames used as
3608 * encoder input or decoder output then hw_frames_ctx should be used
3609 * instead. When hw_frames_ctx is set in get_format() for a decoder, this
3610 * field will be ignored while decoding the associated stream segment, but
3611 * may again be used on a following one after another get_format() call.
3613 * For both encoders and decoders this field should be set before
3614 * avcodec_open2() is called and must not be written to thereafter.
3616 * Note that some decoders may require this field to be set initially in
3617 * order to support hw_frames_ctx at all - in that case, all frames
3618 * contexts used must be created on the same device.
3620 AVBufferRef *hw_device_ctx;
3623 AVRational av_codec_get_pkt_timebase (const AVCodecContext *avctx);
3624 void av_codec_set_pkt_timebase (AVCodecContext *avctx, AVRational val);
3626 const AVCodecDescriptor *av_codec_get_codec_descriptor(const AVCodecContext *avctx);
3627 void av_codec_set_codec_descriptor(AVCodecContext *avctx, const AVCodecDescriptor *desc);
3629 unsigned av_codec_get_codec_properties(const AVCodecContext *avctx);
3631 int av_codec_get_lowres(const AVCodecContext *avctx);
3632 void av_codec_set_lowres(AVCodecContext *avctx, int val);
3634 int av_codec_get_seek_preroll(const AVCodecContext *avctx);
3635 void av_codec_set_seek_preroll(AVCodecContext *avctx, int val);
3637 uint16_t *av_codec_get_chroma_intra_matrix(const AVCodecContext *avctx);
3638 void av_codec_set_chroma_intra_matrix(AVCodecContext *avctx, uint16_t *val);
3643 typedef struct AVProfile {
3645 const char *name; ///< short name for the profile
3648 typedef struct AVCodecDefault AVCodecDefault;
3655 typedef struct AVCodec {
3657 * Name of the codec implementation.
3658 * The name is globally unique among encoders and among decoders (but an
3659 * encoder and a decoder can share the same name).
3660 * This is the primary way to find a codec from the user perspective.
3664 * Descriptive name for the codec, meant to be more human readable than name.
3665 * You should use the NULL_IF_CONFIG_SMALL() macro to define it.
3667 const char *long_name;
3668 enum AVMediaType type;
3671 * Codec capabilities.
3672 * see AV_CODEC_CAP_*
3675 const AVRational *supported_framerates; ///< array of supported framerates, or NULL if any, array is terminated by {0,0}
3676 const enum AVPixelFormat *pix_fmts; ///< array of supported pixel formats, or NULL if unknown, array is terminated by -1
3677 const int *supported_samplerates; ///< array of supported audio samplerates, or NULL if unknown, array is terminated by 0
3678 const enum AVSampleFormat *sample_fmts; ///< array of supported sample formats, or NULL if unknown, array is terminated by -1
3679 const uint64_t *channel_layouts; ///< array of support channel layouts, or NULL if unknown. array is terminated by 0
3680 uint8_t max_lowres; ///< maximum value for lowres supported by the decoder
3681 const AVClass *priv_class; ///< AVClass for the private context
3682 const AVProfile *profiles; ///< array of recognized profiles, or NULL if unknown, array is terminated by {FF_PROFILE_UNKNOWN}
3684 /*****************************************************************
3685 * No fields below this line are part of the public API. They
3686 * may not be used outside of libavcodec and can be changed and
3688 * New public fields should be added right above.
3689 *****************************************************************
3692 struct AVCodec *next;
3694 * @name Frame-level threading support functions
3698 * If defined, called on thread contexts when they are created.
3699 * If the codec allocates writable tables in init(), re-allocate them here.
3700 * priv_data will be set to a copy of the original.
3702 int (*init_thread_copy)(AVCodecContext *);
3704 * Copy necessary context variables from a previous thread context to the current one.
3705 * If not defined, the next thread will start automatically; otherwise, the codec
3706 * must call ff_thread_finish_setup().
3708 * dst and src will (rarely) point to the same context, in which case memcpy should be skipped.
3710 int (*update_thread_context)(AVCodecContext *dst, const AVCodecContext *src);
3714 * Private codec-specific defaults.
3716 const AVCodecDefault *defaults;
3719 * Initialize codec static data, called from avcodec_register().
3721 void (*init_static_data)(struct AVCodec *codec);
3723 int (*init)(AVCodecContext *);
3724 int (*encode_sub)(AVCodecContext *, uint8_t *buf, int buf_size,
3725 const struct AVSubtitle *sub);
3727 * Encode data to an AVPacket.
3729 * @param avctx codec context
3730 * @param avpkt output AVPacket (may contain a user-provided buffer)
3731 * @param[in] frame AVFrame containing the raw data to be encoded
3732 * @param[out] got_packet_ptr encoder sets to 0 or 1 to indicate that a
3733 * non-empty packet was returned in avpkt.
3734 * @return 0 on success, negative error code on failure
3736 int (*encode2)(AVCodecContext *avctx, AVPacket *avpkt, const AVFrame *frame,
3737 int *got_packet_ptr);
3738 int (*decode)(AVCodecContext *, void *outdata, int *outdata_size, AVPacket *avpkt);
3739 int (*close)(AVCodecContext *);
3741 * Decode/encode API with decoupled packet/frame dataflow. The API is the
3742 * same as the avcodec_ prefixed APIs (avcodec_send_frame() etc.), except
3744 * - never called if the codec is closed or the wrong type,
3745 * - AVPacket parameter change side data is applied right before calling
3746 * AVCodec->send_packet,
3747 * - if AV_CODEC_CAP_DELAY is not set, drain packets or frames are never sent,
3748 * - only one drain packet is ever passed down (until the next flush()),
3749 * - a drain AVPacket is always NULL (no need to check for avpkt->size).
3751 int (*send_frame)(AVCodecContext *avctx, const AVFrame *frame);
3752 int (*send_packet)(AVCodecContext *avctx, const AVPacket *avpkt);
3753 int (*receive_frame)(AVCodecContext *avctx, AVFrame *frame);
3754 int (*receive_packet)(AVCodecContext *avctx, AVPacket *avpkt);
3757 * Will be called when seeking
3759 void (*flush)(AVCodecContext *);
3761 * Internal codec capabilities.
3762 * See FF_CODEC_CAP_* in internal.h
3767 int av_codec_get_max_lowres(const AVCodec *codec);
3769 struct MpegEncContext;
3772 * @defgroup lavc_hwaccel AVHWAccel
3775 typedef struct AVHWAccel {
3777 * Name of the hardware accelerated codec.
3778 * The name is globally unique among encoders and among decoders (but an
3779 * encoder and a decoder can share the same name).
3784 * Type of codec implemented by the hardware accelerator.
3786 * See AVMEDIA_TYPE_xxx
3788 enum AVMediaType type;
3791 * Codec implemented by the hardware accelerator.
3793 * See AV_CODEC_ID_xxx
3798 * Supported pixel format.
3800 * Only hardware accelerated formats are supported here.
3802 enum AVPixelFormat pix_fmt;
3805 * Hardware accelerated codec capabilities.
3806 * see HWACCEL_CODEC_CAP_*
3810 /*****************************************************************
3811 * No fields below this line are part of the public API. They
3812 * may not be used outside of libavcodec and can be changed and
3814 * New public fields should be added right above.
3815 *****************************************************************
3817 struct AVHWAccel *next;
3820 * Allocate a custom buffer
3822 int (*alloc_frame)(AVCodecContext *avctx, AVFrame *frame);
3825 * Called at the beginning of each frame or field picture.
3827 * Meaningful frame information (codec specific) is guaranteed to
3828 * be parsed at this point. This function is mandatory.
3830 * Note that buf can be NULL along with buf_size set to 0.
3831 * Otherwise, this means the whole frame is available at this point.
3833 * @param avctx the codec context
3834 * @param buf the frame data buffer base
3835 * @param buf_size the size of the frame in bytes
3836 * @return zero if successful, a negative value otherwise
3838 int (*start_frame)(AVCodecContext *avctx, const uint8_t *buf, uint32_t buf_size);
3841 * Callback for each slice.
3843 * Meaningful slice information (codec specific) is guaranteed to
3844 * be parsed at this point. This function is mandatory.
3845 * The only exception is XvMC, that works on MB level.
3847 * @param avctx the codec context
3848 * @param buf the slice data buffer base
3849 * @param buf_size the size of the slice in bytes
3850 * @return zero if successful, a negative value otherwise
3852 int (*decode_slice)(AVCodecContext *avctx, const uint8_t *buf, uint32_t buf_size);
3855 * Called at the end of each frame or field picture.
3857 * The whole picture is parsed at this point and can now be sent
3858 * to the hardware accelerator. This function is mandatory.
3860 * @param avctx the codec context
3861 * @return zero if successful, a negative value otherwise
3863 int (*end_frame)(AVCodecContext *avctx);
3866 * Size of per-frame hardware accelerator private data.
3868 * Private data is allocated with av_mallocz() before
3869 * AVCodecContext.get_buffer() and deallocated after
3870 * AVCodecContext.release_buffer().
3872 int frame_priv_data_size;
3875 * Called for every Macroblock in a slice.
3877 * XvMC uses it to replace the ff_mpv_decode_mb().
3878 * Instead of decoding to raw picture, MB parameters are
3879 * stored in an array provided by the video driver.
3881 * @param s the mpeg context
3883 void (*decode_mb)(struct MpegEncContext *s);
3886 * Initialize the hwaccel private data.
3888 * This will be called from ff_get_format(), after hwaccel and
3889 * hwaccel_context are set and the hwaccel private data in AVCodecInternal
3892 int (*init)(AVCodecContext *avctx);
3895 * Uninitialize the hwaccel private data.
3897 * This will be called from get_format() or avcodec_close(), after hwaccel
3898 * and hwaccel_context are already uninitialized.
3900 int (*uninit)(AVCodecContext *avctx);
3903 * Size of the private data to allocate in
3904 * AVCodecInternal.hwaccel_priv_data.
3910 * Hardware acceleration should be used for decoding even if the codec level
3911 * used is unknown or higher than the maximum supported level reported by the
3914 * It's generally a good idea to pass this flag unless you have a specific
3915 * reason not to, as hardware tends to under-report supported levels.
3917 #define AV_HWACCEL_FLAG_IGNORE_LEVEL (1 << 0)
3920 * Hardware acceleration can output YUV pixel formats with a different chroma
3921 * sampling than 4:2:0 and/or other than 8 bits per component.
3923 #define AV_HWACCEL_FLAG_ALLOW_HIGH_DEPTH (1 << 1)
3929 #if FF_API_AVPICTURE
3931 * @defgroup lavc_picture AVPicture
3933 * Functions for working with AVPicture
3938 * Picture data structure.
3940 * Up to four components can be stored into it, the last component is
3942 * @deprecated use AVFrame or imgutils functions instead
3944 typedef struct AVPicture {
3945 attribute_deprecated
3946 uint8_t *data[AV_NUM_DATA_POINTERS]; ///< pointers to the image data planes
3947 attribute_deprecated
3948 int linesize[AV_NUM_DATA_POINTERS]; ///< number of bytes per line
3956 enum AVSubtitleType {
3959 SUBTITLE_BITMAP, ///< A bitmap, pict will be set
3962 * Plain text, the text field must be set by the decoder and is
3963 * authoritative. ass and pict fields may contain approximations.
3968 * Formatted text, the ass field must be set by the decoder and is
3969 * authoritative. pict and text fields may contain approximations.
3974 #define AV_SUBTITLE_FLAG_FORCED 0x00000001
3976 typedef struct AVSubtitleRect {
3977 int x; ///< top left corner of pict, undefined when pict is not set
3978 int y; ///< top left corner of pict, undefined when pict is not set
3979 int w; ///< width of pict, undefined when pict is not set
3980 int h; ///< height of pict, undefined when pict is not set
3981 int nb_colors; ///< number of colors in pict, undefined when pict is not set
3983 #if FF_API_AVPICTURE
3985 * @deprecated unused
3987 attribute_deprecated
3991 * data+linesize for the bitmap of this subtitle.
3992 * Can be set for text/ass as well once they are rendered.
3997 enum AVSubtitleType type;
3999 char *text; ///< 0 terminated plain UTF-8 text
4002 * 0 terminated ASS/SSA compatible event line.
4003 * The presentation of this is unaffected by the other values in this
4011 typedef struct AVSubtitle {
4012 uint16_t format; /* 0 = graphics */
4013 uint32_t start_display_time; /* relative to packet pts, in ms */
4014 uint32_t end_display_time; /* relative to packet pts, in ms */
4016 AVSubtitleRect **rects;
4017 int64_t pts; ///< Same as packet pts, in AV_TIME_BASE
4021 * This struct describes the properties of an encoded stream.
4023 * sizeof(AVCodecParameters) is not a part of the public ABI, this struct must
4024 * be allocated with avcodec_parameters_alloc() and freed with
4025 * avcodec_parameters_free().
4027 typedef struct AVCodecParameters {
4029 * General type of the encoded data.
4031 enum AVMediaType codec_type;
4033 * Specific type of the encoded data (the codec used).
4035 enum AVCodecID codec_id;
4037 * Additional information about the codec (corresponds to the AVI FOURCC).
4042 * Extra binary data needed for initializing the decoder, codec-dependent.
4044 * Must be allocated with av_malloc() and will be freed by
4045 * avcodec_parameters_free(). The allocated size of extradata must be at
4046 * least extradata_size + AV_INPUT_BUFFER_PADDING_SIZE, with the padding
4051 * Size of the extradata content in bytes.
4056 * - video: the pixel format, the value corresponds to enum AVPixelFormat.
4057 * - audio: the sample format, the value corresponds to enum AVSampleFormat.
4062 * The average bitrate of the encoded data (in bits per second).
4067 * The number of bits per sample in the codedwords.
4069 * This is basically the bitrate per sample. It is mandatory for a bunch of
4070 * formats to actually decode them. It's the number of bits for one sample in
4071 * the actual coded bitstream.
4073 * This could be for example 4 for ADPCM
4074 * For PCM formats this matches bits_per_raw_sample
4077 int bits_per_coded_sample;
4080 * This is the number of valid bits in each output sample. If the
4081 * sample format has more bits, the least significant bits are additional
4082 * padding bits, which are always 0. Use right shifts to reduce the sample
4083 * to its actual size. For example, audio formats with 24 bit samples will
4084 * have bits_per_raw_sample set to 24, and format set to AV_SAMPLE_FMT_S32.
4085 * To get the original sample use "(int32_t)sample >> 8"."
4087 * For ADPCM this might be 12 or 16 or similar
4090 int bits_per_raw_sample;
4093 * Codec-specific bitstream restrictions that the stream conforms to.
4099 * Video only. The dimensions of the video frame in pixels.
4105 * Video only. The aspect ratio (width / height) which a single pixel
4106 * should have when displayed.
4108 * When the aspect ratio is unknown / undefined, the numerator should be
4109 * set to 0 (the denominator may have any value).
4111 AVRational sample_aspect_ratio;
4114 * Video only. The order of the fields in interlaced video.
4116 enum AVFieldOrder field_order;
4119 * Video only. Additional colorspace characteristics.
4121 enum AVColorRange color_range;
4122 enum AVColorPrimaries color_primaries;
4123 enum AVColorTransferCharacteristic color_trc;
4124 enum AVColorSpace color_space;
4125 enum AVChromaLocation chroma_location;
4128 * Video only. Number of delayed frames.
4133 * Audio only. The channel layout bitmask. May be 0 if the channel layout is
4134 * unknown or unspecified, otherwise the number of bits set must be equal to
4135 * the channels field.
4137 uint64_t channel_layout;
4139 * Audio only. The number of audio channels.
4143 * Audio only. The number of audio samples per second.
4147 * Audio only. The number of bytes per coded audio frame, required by some
4150 * Corresponds to nBlockAlign in WAVEFORMATEX.
4154 * Audio only. Audio frame size, if known. Required by some formats to be static.
4159 * Audio only. The amount of padding (in samples) inserted by the encoder at
4160 * the beginning of the audio. I.e. this number of leading decoded samples
4161 * must be discarded by the caller to get the original audio without leading
4164 int initial_padding;
4166 * Audio only. The amount of padding (in samples) appended by the encoder to
4167 * the end of the audio. I.e. this number of decoded samples must be
4168 * discarded by the caller from the end of the stream to get the original
4169 * audio without any trailing padding.
4171 int trailing_padding;
4173 * Audio only. Number of samples to skip after a discontinuity.
4176 } AVCodecParameters;
4179 * If c is NULL, returns the first registered codec,
4180 * if c is non-NULL, returns the next registered codec after c,
4181 * or NULL if c is the last one.
4183 AVCodec *av_codec_next(const AVCodec *c);
4186 * Return the LIBAVCODEC_VERSION_INT constant.
4188 unsigned avcodec_version(void);
4191 * Return the libavcodec build-time configuration.
4193 const char *avcodec_configuration(void);
4196 * Return the libavcodec license.
4198 const char *avcodec_license(void);
4201 * Register the codec codec and initialize libavcodec.
4203 * @warning either this function or avcodec_register_all() must be called
4204 * before any other libavcodec functions.
4206 * @see avcodec_register_all()
4208 void avcodec_register(AVCodec *codec);
4211 * Register all the codecs, parsers and bitstream filters which were enabled at
4212 * configuration time. If you do not call this function you can select exactly
4213 * which formats you want to support, by using the individual registration
4216 * @see avcodec_register
4217 * @see av_register_codec_parser
4218 * @see av_register_bitstream_filter
4220 void avcodec_register_all(void);
4223 * Allocate an AVCodecContext and set its fields to default values. The
4224 * resulting struct should be freed with avcodec_free_context().
4226 * @param codec if non-NULL, allocate private data and initialize defaults
4227 * for the given codec. It is illegal to then call avcodec_open2()
4228 * with a different codec.
4229 * If NULL, then the codec-specific defaults won't be initialized,
4230 * which may result in suboptimal default settings (this is
4231 * important mainly for encoders, e.g. libx264).
4233 * @return An AVCodecContext filled with default values or NULL on failure.
4235 AVCodecContext *avcodec_alloc_context3(const AVCodec *codec);
4238 * Free the codec context and everything associated with it and write NULL to
4239 * the provided pointer.
4241 void avcodec_free_context(AVCodecContext **avctx);
4243 #if FF_API_GET_CONTEXT_DEFAULTS
4245 * @deprecated This function should not be used, as closing and opening a codec
4246 * context multiple time is not supported. A new codec context should be
4247 * allocated for each new use.
4249 int avcodec_get_context_defaults3(AVCodecContext *s, const AVCodec *codec);
4253 * Get the AVClass for AVCodecContext. It can be used in combination with
4254 * AV_OPT_SEARCH_FAKE_OBJ for examining options.
4256 * @see av_opt_find().
4258 const AVClass *avcodec_get_class(void);
4260 #if FF_API_COPY_CONTEXT
4262 * Get the AVClass for AVFrame. 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_frame_class(void);
4270 * Get the AVClass for AVSubtitleRect. It can be used in combination with
4271 * AV_OPT_SEARCH_FAKE_OBJ for examining options.
4273 * @see av_opt_find().
4275 const AVClass *avcodec_get_subtitle_rect_class(void);
4278 * Copy the settings of the source AVCodecContext into the destination
4279 * AVCodecContext. The resulting destination codec context will be
4280 * unopened, i.e. you are required to call avcodec_open2() before you
4281 * can use this AVCodecContext to decode/encode video/audio data.
4283 * @param dest target codec context, should be initialized with
4284 * avcodec_alloc_context3(NULL), but otherwise uninitialized
4285 * @param src source codec context
4286 * @return AVERROR() on error (e.g. memory allocation error), 0 on success
4288 * @deprecated The semantics of this function are ill-defined and it should not
4289 * be used. If you need to transfer the stream parameters from one codec context
4290 * to another, use an intermediate AVCodecParameters instance and the
4291 * avcodec_parameters_from_context() / avcodec_parameters_to_context()
4294 attribute_deprecated
4295 int avcodec_copy_context(AVCodecContext *dest, const AVCodecContext *src);
4299 * Allocate a new AVCodecParameters and set its fields to default values
4300 * (unknown/invalid/0). The returned struct must be freed with
4301 * avcodec_parameters_free().
4303 AVCodecParameters *avcodec_parameters_alloc(void);
4306 * Free an AVCodecParameters instance and everything associated with it and
4307 * write NULL to the supplied pointer.
4309 void avcodec_parameters_free(AVCodecParameters **par);
4312 * Copy the contents of src to dst. Any allocated fields in dst are freed and
4313 * replaced with newly allocated duplicates of the corresponding fields in src.
4315 * @return >= 0 on success, a negative AVERROR code on failure.
4317 int avcodec_parameters_copy(AVCodecParameters *dst, const AVCodecParameters *src);
4320 * Fill the parameters struct based on the values from the supplied codec
4321 * context. Any allocated fields in par are freed and replaced with duplicates
4322 * of the corresponding fields in codec.
4324 * @return >= 0 on success, a negative AVERROR code on failure
4326 int avcodec_parameters_from_context(AVCodecParameters *par,
4327 const AVCodecContext *codec);
4330 * Fill the codec context based on the values from the supplied codec
4331 * parameters. Any allocated fields in codec that have a corresponding field in
4332 * par are freed and replaced with duplicates of the corresponding field in par.
4333 * Fields in codec that do not have a counterpart in par are not touched.
4335 * @return >= 0 on success, a negative AVERROR code on failure.
4337 int avcodec_parameters_to_context(AVCodecContext *codec,
4338 const AVCodecParameters *par);
4341 * Initialize the AVCodecContext to use the given AVCodec. Prior to using this
4342 * function the context has to be allocated with avcodec_alloc_context3().
4344 * The functions avcodec_find_decoder_by_name(), avcodec_find_encoder_by_name(),
4345 * avcodec_find_decoder() and avcodec_find_encoder() provide an easy way for
4346 * retrieving a codec.
4348 * @warning This function is not thread safe!
4350 * @note Always call this function before using decoding routines (such as
4351 * @ref avcodec_receive_frame()).
4354 * avcodec_register_all();
4355 * av_dict_set(&opts, "b", "2.5M", 0);
4356 * codec = avcodec_find_decoder(AV_CODEC_ID_H264);
4360 * context = avcodec_alloc_context3(codec);
4362 * if (avcodec_open2(context, codec, opts) < 0)
4366 * @param avctx The context to initialize.
4367 * @param codec The codec to open this context for. If a non-NULL codec has been
4368 * previously passed to avcodec_alloc_context3() or
4369 * for this context, then this parameter MUST be either NULL or
4370 * equal to the previously passed codec.
4371 * @param options A dictionary filled with AVCodecContext and codec-private options.
4372 * On return this object will be filled with options that were not found.
4374 * @return zero on success, a negative value on error
4375 * @see avcodec_alloc_context3(), avcodec_find_decoder(), avcodec_find_encoder(),
4376 * av_dict_set(), av_opt_find().
4378 int avcodec_open2(AVCodecContext *avctx, const AVCodec *codec, AVDictionary **options);
4381 * Close a given AVCodecContext and free all the data associated with it
4382 * (but not the AVCodecContext itself).
4384 * Calling this function on an AVCodecContext that hasn't been opened will free
4385 * the codec-specific data allocated in avcodec_alloc_context3() with a non-NULL
4386 * codec. Subsequent calls will do nothing.
4388 * @note Do not use this function. Use avcodec_free_context() to destroy a
4389 * codec context (either open or closed). Opening and closing a codec context
4390 * multiple times is not supported anymore -- use multiple codec contexts
4393 int avcodec_close(AVCodecContext *avctx);
4396 * Free all allocated data in the given subtitle struct.
4398 * @param sub AVSubtitle to free.
4400 void avsubtitle_free(AVSubtitle *sub);
4407 * @addtogroup lavc_packet
4412 * Allocate an AVPacket and set its fields to default values. The resulting
4413 * struct must be freed using av_packet_free().
4415 * @return An AVPacket filled with default values or NULL on failure.
4417 * @note this only allocates the AVPacket itself, not the data buffers. Those
4418 * must be allocated through other means such as av_new_packet.
4420 * @see av_new_packet
4422 AVPacket *av_packet_alloc(void);
4425 * Create a new packet that references the same data as src.
4427 * This is a shortcut for av_packet_alloc()+av_packet_ref().
4429 * @return newly created AVPacket on success, NULL on error.
4431 * @see av_packet_alloc
4432 * @see av_packet_ref
4434 AVPacket *av_packet_clone(AVPacket *src);
4437 * Free the packet, if the packet is reference counted, it will be
4438 * unreferenced first.
4440 * @param packet packet to be freed. The pointer will be set to NULL.
4441 * @note passing NULL is a no-op.
4443 void av_packet_free(AVPacket **pkt);
4446 * Initialize optional fields of a packet with default values.
4448 * Note, this does not touch the data and size members, which have to be
4449 * initialized separately.
4453 void av_init_packet(AVPacket *pkt);
4456 * Allocate the payload of a packet and initialize its fields with
4460 * @param size wanted payload size
4461 * @return 0 if OK, AVERROR_xxx otherwise
4463 int av_new_packet(AVPacket *pkt, int size);
4466 * Reduce packet size, correctly zeroing padding
4469 * @param size new size
4471 void av_shrink_packet(AVPacket *pkt, int size);
4474 * Increase packet size, correctly zeroing padding
4477 * @param grow_by number of bytes by which to increase the size of the packet
4479 int av_grow_packet(AVPacket *pkt, int grow_by);
4482 * Initialize a reference-counted packet from av_malloc()ed data.
4484 * @param pkt packet to be initialized. This function will set the data, size,
4485 * buf and destruct fields, all others are left untouched.
4486 * @param data Data allocated by av_malloc() to be used as packet data. If this
4487 * function returns successfully, the data is owned by the underlying AVBuffer.
4488 * The caller may not access the data through other means.
4489 * @param size size of data in bytes, without the padding. I.e. the full buffer
4490 * size is assumed to be size + AV_INPUT_BUFFER_PADDING_SIZE.
4492 * @return 0 on success, a negative AVERROR on error
4494 int av_packet_from_data(AVPacket *pkt, uint8_t *data, int size);
4496 #if FF_API_AVPACKET_OLD_API
4498 * @warning This is a hack - the packet memory allocation stuff is broken. The
4499 * packet is allocated if it was not really allocated.
4501 * @deprecated Use av_packet_ref
4503 attribute_deprecated
4504 int av_dup_packet(AVPacket *pkt);
4506 * Copy packet, including contents
4508 * @return 0 on success, negative AVERROR on fail
4510 int av_copy_packet(AVPacket *dst, const AVPacket *src);
4513 * Copy packet side data
4515 * @return 0 on success, negative AVERROR on fail
4517 int av_copy_packet_side_data(AVPacket *dst, const AVPacket *src);
4522 * @deprecated Use av_packet_unref
4524 * @param pkt packet to free
4526 attribute_deprecated
4527 void av_free_packet(AVPacket *pkt);
4530 * Allocate new information of a packet.
4533 * @param type side information type
4534 * @param size side information size
4535 * @return pointer to fresh allocated data or NULL otherwise
4537 uint8_t* av_packet_new_side_data(AVPacket *pkt, enum AVPacketSideDataType type,
4541 * Wrap an existing array as a packet side data.
4544 * @param type side information type
4545 * @param data the side data array. It must be allocated with the av_malloc()
4546 * family of functions. The ownership of the data is transferred to
4548 * @param size side information size
4549 * @return a non-negative number on success, a negative AVERROR code on
4550 * failure. On failure, the packet is unchanged and the data remains
4551 * owned by the caller.
4553 int av_packet_add_side_data(AVPacket *pkt, enum AVPacketSideDataType type,
4554 uint8_t *data, size_t size);
4557 * Shrink the already allocated side data buffer
4560 * @param type side information type
4561 * @param size new side information size
4562 * @return 0 on success, < 0 on failure
4564 int av_packet_shrink_side_data(AVPacket *pkt, enum AVPacketSideDataType type,
4568 * Get side information from packet.
4571 * @param type desired side information type
4572 * @param size pointer for side information size to store (optional)
4573 * @return pointer to data if present or NULL otherwise
4575 uint8_t* av_packet_get_side_data(const AVPacket *pkt, enum AVPacketSideDataType type,
4578 int av_packet_merge_side_data(AVPacket *pkt);
4580 int av_packet_split_side_data(AVPacket *pkt);
4582 const char *av_packet_side_data_name(enum AVPacketSideDataType type);
4585 * Pack a dictionary for use in side_data.
4587 * @param dict The dictionary to pack.
4588 * @param size pointer to store the size of the returned data
4589 * @return pointer to data if successful, NULL otherwise
4591 uint8_t *av_packet_pack_dictionary(AVDictionary *dict, int *size);
4593 * Unpack a dictionary from side_data.
4595 * @param data data from side_data
4596 * @param size size of the data
4597 * @param dict the metadata storage dictionary
4598 * @return 0 on success, < 0 on failure
4600 int av_packet_unpack_dictionary(const uint8_t *data, int size, AVDictionary **dict);
4604 * Convenience function to free all the side data stored.
4605 * All the other fields stay untouched.
4609 void av_packet_free_side_data(AVPacket *pkt);
4612 * Setup a new reference to the data described by a given packet
4614 * If src is reference-counted, setup dst as a new reference to the
4615 * buffer in src. Otherwise allocate a new buffer in dst and copy the
4616 * data from src into it.
4618 * All the other fields are copied from src.
4620 * @see av_packet_unref
4622 * @param dst Destination packet
4623 * @param src Source packet
4625 * @return 0 on success, a negative AVERROR on error.
4627 int av_packet_ref(AVPacket *dst, const AVPacket *src);
4632 * Unreference the buffer referenced by the packet and reset the
4633 * remaining packet fields to their default values.
4635 * @param pkt The packet to be unreferenced.
4637 void av_packet_unref(AVPacket *pkt);
4640 * Move every field in src to dst and reset src.
4642 * @see av_packet_unref
4644 * @param src Source packet, will be reset
4645 * @param dst Destination packet
4647 void av_packet_move_ref(AVPacket *dst, AVPacket *src);
4650 * Copy only "properties" fields from src to dst.
4652 * Properties for the purpose of this function are all the fields
4653 * beside those related to the packet data (buf, data, size)
4655 * @param dst Destination packet
4656 * @param src Source packet
4658 * @return 0 on success AVERROR on failure.
4660 int av_packet_copy_props(AVPacket *dst, const AVPacket *src);
4663 * Convert valid timing fields (timestamps / durations) in a packet from one
4664 * timebase to another. Timestamps with unknown values (AV_NOPTS_VALUE) will be
4667 * @param pkt packet on which the conversion will be performed
4668 * @param tb_src source timebase, in which the timing fields in pkt are
4670 * @param tb_dst destination timebase, to which the timing fields will be
4673 void av_packet_rescale_ts(AVPacket *pkt, AVRational tb_src, AVRational tb_dst);
4680 * @addtogroup lavc_decoding
4685 * Find a registered decoder with a matching codec ID.
4687 * @param id AVCodecID of the requested decoder
4688 * @return A decoder if one was found, NULL otherwise.
4690 AVCodec *avcodec_find_decoder(enum AVCodecID id);
4693 * Find a registered decoder with the specified name.
4695 * @param name name of the requested decoder
4696 * @return A decoder if one was found, NULL otherwise.
4698 AVCodec *avcodec_find_decoder_by_name(const char *name);
4701 * The default callback for AVCodecContext.get_buffer2(). It is made public so
4702 * it can be called by custom get_buffer2() implementations for decoders without
4703 * AV_CODEC_CAP_DR1 set.
4705 int avcodec_default_get_buffer2(AVCodecContext *s, AVFrame *frame, int flags);
4709 * Return the amount of padding in pixels which the get_buffer callback must
4710 * provide around the edge of the image for codecs which do not have the
4711 * CODEC_FLAG_EMU_EDGE flag.
4713 * @return Required padding in pixels.
4715 * @deprecated CODEC_FLAG_EMU_EDGE is deprecated, so this function is no longer
4718 attribute_deprecated
4719 unsigned avcodec_get_edge_width(void);
4723 * Modify width and height values so that they will result in a memory
4724 * buffer that is acceptable for the codec if you do not use any horizontal
4727 * May only be used if a codec with AV_CODEC_CAP_DR1 has been opened.
4729 void avcodec_align_dimensions(AVCodecContext *s, int *width, int *height);
4732 * Modify width and height values so that they will result in a memory
4733 * buffer that is acceptable for the codec if you also ensure that all
4734 * line sizes are a multiple of the respective linesize_align[i].
4736 * May only be used if a codec with AV_CODEC_CAP_DR1 has been opened.
4738 void avcodec_align_dimensions2(AVCodecContext *s, int *width, int *height,
4739 int linesize_align[AV_NUM_DATA_POINTERS]);
4742 * Converts AVChromaLocation to swscale x/y chroma position.
4744 * The positions represent the chroma (0,0) position in a coordinates system
4745 * with luma (0,0) representing the origin and luma(1,1) representing 256,256
4747 * @param xpos horizontal chroma sample position
4748 * @param ypos vertical chroma sample position
4750 int avcodec_enum_to_chroma_pos(int *xpos, int *ypos, enum AVChromaLocation pos);
4753 * Converts swscale x/y chroma position to AVChromaLocation.
4755 * The positions represent the chroma (0,0) position in a coordinates system
4756 * with luma (0,0) representing the origin and luma(1,1) representing 256,256
4758 * @param xpos horizontal chroma sample position
4759 * @param ypos vertical chroma sample position
4761 enum AVChromaLocation avcodec_chroma_pos_to_enum(int xpos, int ypos);
4764 * Decode the audio frame of size avpkt->size from avpkt->data into frame.
4766 * Some decoders may support multiple frames in a single AVPacket. Such
4767 * decoders would then just decode the first frame and the return value would be
4768 * less than the packet size. In this case, avcodec_decode_audio4 has to be
4769 * called again with an AVPacket containing the remaining data in order to
4770 * decode the second frame, etc... Even if no frames are returned, the packet
4771 * needs to be fed to the decoder with remaining data until it is completely
4772 * consumed or an error occurs.
4774 * Some decoders (those marked with AV_CODEC_CAP_DELAY) have a delay between input
4775 * and output. This means that for some packets they will not immediately
4776 * produce decoded output and need to be flushed at the end of decoding to get
4777 * all the decoded data. Flushing is done by calling this function with packets
4778 * with avpkt->data set to NULL and avpkt->size set to 0 until it stops
4779 * returning samples. It is safe to flush even those decoders that are not
4780 * marked with AV_CODEC_CAP_DELAY, then no samples will be returned.
4782 * @warning The input buffer, avpkt->data must be AV_INPUT_BUFFER_PADDING_SIZE
4783 * larger than the actual read bytes because some optimized bitstream
4784 * readers read 32 or 64 bits at once and could read over the end.
4786 * @note The AVCodecContext MUST have been opened with @ref avcodec_open2()
4787 * before packets may be fed to the decoder.
4789 * @param avctx the codec context
4790 * @param[out] frame The AVFrame in which to store decoded audio samples.
4791 * The decoder will allocate a buffer for the decoded frame by
4792 * calling the AVCodecContext.get_buffer2() callback.
4793 * When AVCodecContext.refcounted_frames is set to 1, the frame is
4794 * reference counted and the returned reference belongs to the
4795 * caller. The caller must release the frame using av_frame_unref()
4796 * when the frame is no longer needed. The caller may safely write
4797 * to the frame if av_frame_is_writable() returns 1.
4798 * When AVCodecContext.refcounted_frames is set to 0, the returned
4799 * reference belongs to the decoder and is valid only until the
4800 * next call to this function or until closing or flushing the
4801 * decoder. The caller may not write to it.
4802 * @param[out] got_frame_ptr Zero if no frame could be decoded, otherwise it is
4803 * non-zero. Note that this field being set to zero
4804 * does not mean that an error has occurred. For
4805 * decoders with AV_CODEC_CAP_DELAY set, no given decode
4806 * call is guaranteed to produce a frame.
4807 * @param[in] avpkt The input AVPacket containing the input buffer.
4808 * At least avpkt->data and avpkt->size should be set. Some
4809 * decoders might also require additional fields to be set.
4810 * @return A negative error code is returned if an error occurred during
4811 * decoding, otherwise the number of bytes consumed from the input
4812 * AVPacket is returned.
4814 * @deprecated Use avcodec_send_packet() and avcodec_receive_frame().
4816 attribute_deprecated
4817 int avcodec_decode_audio4(AVCodecContext *avctx, AVFrame *frame,
4818 int *got_frame_ptr, const AVPacket *avpkt);
4821 * Decode the video frame of size avpkt->size from avpkt->data into picture.
4822 * Some decoders may support multiple frames in a single AVPacket, such
4823 * decoders would then just decode the first frame.
4825 * @warning The input buffer must be AV_INPUT_BUFFER_PADDING_SIZE larger than
4826 * the actual read bytes because some optimized bitstream readers read 32 or 64
4827 * bits at once and could read over the end.
4829 * @warning The end of the input buffer buf should be set to 0 to ensure that
4830 * no overreading happens for damaged MPEG streams.
4832 * @note Codecs which have the AV_CODEC_CAP_DELAY capability set have a delay
4833 * between input and output, these need to be fed with avpkt->data=NULL,
4834 * avpkt->size=0 at the end to return the remaining frames.
4836 * @note The AVCodecContext MUST have been opened with @ref avcodec_open2()
4837 * before packets may be fed to the decoder.
4839 * @param avctx the codec context
4840 * @param[out] picture The AVFrame in which the decoded video frame will be stored.
4841 * Use av_frame_alloc() to get an AVFrame. The codec will
4842 * allocate memory for the actual bitmap by calling the
4843 * AVCodecContext.get_buffer2() callback.
4844 * When AVCodecContext.refcounted_frames is set to 1, the frame is
4845 * reference counted and the returned reference belongs to the
4846 * caller. The caller must release the frame using av_frame_unref()
4847 * when the frame is no longer needed. The caller may safely write
4848 * to the frame if av_frame_is_writable() returns 1.
4849 * When AVCodecContext.refcounted_frames is set to 0, the returned
4850 * reference belongs to the decoder and is valid only until the
4851 * next call to this function or until closing or flushing the
4852 * decoder. The caller may not write to it.
4854 * @param[in] avpkt The input AVPacket containing the input buffer.
4855 * You can create such packet with av_init_packet() and by then setting
4856 * data and size, some decoders might in addition need other fields like
4857 * flags&AV_PKT_FLAG_KEY. All decoders are designed to use the least
4859 * @param[in,out] got_picture_ptr Zero if no frame could be decompressed, otherwise, it is nonzero.
4860 * @return On error a negative value is returned, otherwise the number of bytes
4861 * used or zero if no frame could be decompressed.
4863 * @deprecated Use avcodec_send_packet() and avcodec_receive_frame().
4865 attribute_deprecated
4866 int avcodec_decode_video2(AVCodecContext *avctx, AVFrame *picture,
4867 int *got_picture_ptr,
4868 const AVPacket *avpkt);
4871 * Decode a subtitle message.
4872 * Return a negative value on error, otherwise return the number of bytes used.
4873 * If no subtitle could be decompressed, got_sub_ptr is zero.
4874 * Otherwise, the subtitle is stored in *sub.
4875 * Note that AV_CODEC_CAP_DR1 is not available for subtitle codecs. This is for
4876 * simplicity, because the performance difference is expect to be negligible
4877 * and reusing a get_buffer written for video codecs would probably perform badly
4878 * due to a potentially very different allocation pattern.
4880 * Some decoders (those marked with CODEC_CAP_DELAY) have a delay between input
4881 * and output. This means that for some packets they will not immediately
4882 * produce decoded output and need to be flushed at the end of decoding to get
4883 * all the decoded data. Flushing is done by calling this function with packets
4884 * with avpkt->data set to NULL and avpkt->size set to 0 until it stops
4885 * returning subtitles. It is safe to flush even those decoders that are not
4886 * marked with CODEC_CAP_DELAY, then no subtitles will be returned.
4888 * @note The AVCodecContext MUST have been opened with @ref avcodec_open2()
4889 * before packets may be fed to the decoder.
4891 * @param avctx the codec context
4892 * @param[out] sub The Preallocated AVSubtitle in which the decoded subtitle will be stored,
4893 * must be freed with avsubtitle_free if *got_sub_ptr is set.
4894 * @param[in,out] got_sub_ptr Zero if no subtitle could be decompressed, otherwise, it is nonzero.
4895 * @param[in] avpkt The input AVPacket containing the input buffer.
4897 int avcodec_decode_subtitle2(AVCodecContext *avctx, AVSubtitle *sub,
4902 * Supply raw packet data as input to a decoder.
4904 * Internally, this call will copy relevant AVCodecContext fields, which can
4905 * influence decoding per-packet, and apply them when the packet is actually
4906 * decoded. (For example AVCodecContext.skip_frame, which might direct the
4907 * decoder to drop the frame contained by the packet sent with this function.)
4909 * @warning The input buffer, avpkt->data must be AV_INPUT_BUFFER_PADDING_SIZE
4910 * larger than the actual read bytes because some optimized bitstream
4911 * readers read 32 or 64 bits at once and could read over the end.
4913 * @warning Do not mix this API with the legacy API (like avcodec_decode_video2())
4914 * on the same AVCodecContext. It will return unexpected results now
4915 * or in future libavcodec versions.
4917 * @note The AVCodecContext MUST have been opened with @ref avcodec_open2()
4918 * before packets may be fed to the decoder.
4920 * @param avctx codec context
4921 * @param[in] avpkt The input AVPacket. Usually, this will be a single video
4922 * frame, or several complete audio frames.
4923 * Ownership of the packet remains with the caller, and the
4924 * decoder will not write to the packet. The decoder may create
4925 * a reference to the packet data (or copy it if the packet is
4926 * not reference-counted).
4927 * Unlike with older APIs, the packet is always fully consumed,
4928 * and if it contains multiple frames (e.g. some audio codecs),
4929 * will require you to call avcodec_receive_frame() multiple
4930 * times afterwards before you can send a new packet.
4931 * It can be NULL (or an AVPacket with data set to NULL and
4932 * size set to 0); in this case, it is considered a flush
4933 * packet, which signals the end of the stream. Sending the
4934 * first flush packet will return success. Subsequent ones are
4935 * unnecessary and will return AVERROR_EOF. If the decoder
4936 * still has frames buffered, it will return them after sending
4939 * @return 0 on success, otherwise negative error code:
4940 * AVERROR(EAGAIN): input is not accepted in the current state - user
4941 * must read output with avcodec_receive_frame() (once
4942 * all output is read, the packet should be resent, and
4943 * the call will not fail with EAGAIN).
4944 * AVERROR_EOF: the decoder has been flushed, and no new packets can
4945 * be sent to it (also returned if more than 1 flush
4947 * AVERROR(EINVAL): codec not opened, it is an encoder, or requires flush
4948 * AVERROR(ENOMEM): failed to add packet to internal queue, or similar
4949 * other errors: legitimate decoding errors
4951 int avcodec_send_packet(AVCodecContext *avctx, const AVPacket *avpkt);
4954 * Return decoded output data from a decoder.
4956 * @param avctx codec context
4957 * @param frame This will be set to a reference-counted video or audio
4958 * frame (depending on the decoder type) allocated by the
4959 * decoder. Note that the function will always call
4960 * av_frame_unref(frame) before doing anything else.
4963 * 0: success, a frame was returned
4964 * AVERROR(EAGAIN): output is not available in this state - user must try
4966 * AVERROR_EOF: the decoder has been fully flushed, and there will be
4967 * no more output frames
4968 * AVERROR(EINVAL): codec not opened, or it is an encoder
4969 * other negative values: legitimate decoding errors
4971 int avcodec_receive_frame(AVCodecContext *avctx, AVFrame *frame);
4974 * Supply a raw video or audio frame to the encoder. Use avcodec_receive_packet()
4975 * to retrieve buffered output packets.
4977 * @param avctx codec context
4978 * @param[in] frame AVFrame containing the raw audio or video frame to be encoded.
4979 * Ownership of the frame remains with the caller, and the
4980 * encoder will not write to the frame. The encoder may create
4981 * a reference to the frame data (or copy it if the frame is
4982 * not reference-counted).
4983 * It can be NULL, in which case it is considered a flush
4984 * packet. This signals the end of the stream. If the encoder
4985 * still has packets buffered, it will return them after this
4986 * call. Once flushing mode has been entered, additional flush
4987 * packets are ignored, and sending frames will return
4991 * If AV_CODEC_CAP_VARIABLE_FRAME_SIZE is set, then each frame
4992 * can have any number of samples.
4993 * If it is not set, frame->nb_samples must be equal to
4994 * avctx->frame_size for all frames except the last.
4995 * The final frame may be smaller than avctx->frame_size.
4996 * @return 0 on success, otherwise negative error code:
4997 * AVERROR(EAGAIN): input is not accepted in the current state - user
4998 * must read output with avcodec_receive_packet() (once
4999 * all output is read, the packet should be resent, and
5000 * the call will not fail with EAGAIN).
5001 * AVERROR_EOF: the encoder has been flushed, and no new frames can
5003 * AVERROR(EINVAL): codec not opened, refcounted_frames not set, it is a
5004 * decoder, or requires flush
5005 * AVERROR(ENOMEM): failed to add packet to internal queue, or similar
5006 * other errors: legitimate decoding errors
5008 int avcodec_send_frame(AVCodecContext *avctx, const AVFrame *frame);
5011 * Read encoded data from the encoder.
5013 * @param avctx codec context
5014 * @param avpkt This will be set to a reference-counted packet allocated by the
5015 * encoder. Note that the function will always call
5016 * av_frame_unref(frame) before doing anything else.
5017 * @return 0 on success, otherwise negative error code:
5018 * AVERROR(EAGAIN): output is not available in the current state - user
5019 * must try to send input
5020 * AVERROR_EOF: the encoder has been fully flushed, and there will be
5021 * no more output packets
5022 * AVERROR(EINVAL): codec not opened, or it is an encoder
5023 * other errors: legitimate decoding errors
5025 int avcodec_receive_packet(AVCodecContext *avctx, AVPacket *avpkt);
5029 * @defgroup lavc_parsing Frame parsing
5033 enum AVPictureStructure {
5034 AV_PICTURE_STRUCTURE_UNKNOWN, //< unknown
5035 AV_PICTURE_STRUCTURE_TOP_FIELD, //< coded as top field
5036 AV_PICTURE_STRUCTURE_BOTTOM_FIELD, //< coded as bottom field
5037 AV_PICTURE_STRUCTURE_FRAME, //< coded as frame
5040 typedef struct AVCodecParserContext {
5042 struct AVCodecParser *parser;
5043 int64_t frame_offset; /* offset of the current frame */
5044 int64_t cur_offset; /* current offset
5045 (incremented by each av_parser_parse()) */
5046 int64_t next_frame_offset; /* offset of the next frame */
5048 int pict_type; /* XXX: Put it back in AVCodecContext. */
5050 * This field is used for proper frame duration computation in lavf.
5051 * It signals, how much longer the frame duration of the current frame
5052 * is compared to normal frame duration.
5054 * frame_duration = (1 + repeat_pict) * time_base
5056 * It is used by codecs like H.264 to display telecined material.
5058 int repeat_pict; /* XXX: Put it back in AVCodecContext. */
5059 int64_t pts; /* pts of the current frame */
5060 int64_t dts; /* dts of the current frame */
5065 int fetch_timestamp;
5067 #define AV_PARSER_PTS_NB 4
5068 int cur_frame_start_index;
5069 int64_t cur_frame_offset[AV_PARSER_PTS_NB];
5070 int64_t cur_frame_pts[AV_PARSER_PTS_NB];
5071 int64_t cur_frame_dts[AV_PARSER_PTS_NB];
5074 #define PARSER_FLAG_COMPLETE_FRAMES 0x0001
5075 #define PARSER_FLAG_ONCE 0x0002
5076 /// Set if the parser has a valid file offset
5077 #define PARSER_FLAG_FETCHED_OFFSET 0x0004
5078 #define PARSER_FLAG_USE_CODEC_TS 0x1000
5080 int64_t offset; ///< byte offset from starting packet start
5081 int64_t cur_frame_end[AV_PARSER_PTS_NB];
5084 * Set by parser to 1 for key frames and 0 for non-key frames.
5085 * It is initialized to -1, so if the parser doesn't set this flag,
5086 * old-style fallback using AV_PICTURE_TYPE_I picture type as key frames
5091 #if FF_API_CONVERGENCE_DURATION
5093 * @deprecated unused
5095 attribute_deprecated
5096 int64_t convergence_duration;
5099 // Timestamp generation support:
5101 * Synchronization point for start of timestamp generation.
5103 * Set to >0 for sync point, 0 for no sync point and <0 for undefined
5106 * For example, this corresponds to presence of H.264 buffering period
5112 * Offset of the current timestamp against last timestamp sync point in
5113 * units of AVCodecContext.time_base.
5115 * Set to INT_MIN when dts_sync_point unused. Otherwise, it must
5116 * contain a valid timestamp offset.
5118 * Note that the timestamp of sync point has usually a nonzero
5119 * dts_ref_dts_delta, which refers to the previous sync point. Offset of
5120 * the next frame after timestamp sync point will be usually 1.
5122 * For example, this corresponds to H.264 cpb_removal_delay.
5124 int dts_ref_dts_delta;
5127 * Presentation delay of current frame in units of AVCodecContext.time_base.
5129 * Set to INT_MIN when dts_sync_point unused. Otherwise, it must
5130 * contain valid non-negative timestamp delta (presentation time of a frame
5131 * must not lie in the past).
5133 * This delay represents the difference between decoding and presentation
5134 * time of the frame.
5136 * For example, this corresponds to H.264 dpb_output_delay.
5141 * Position of the packet in file.
5143 * Analogous to cur_frame_pts/dts
5145 int64_t cur_frame_pos[AV_PARSER_PTS_NB];
5148 * Byte position of currently parsed frame in stream.
5153 * Previous frame byte position.
5158 * Duration of the current frame.
5159 * For audio, this is in units of 1 / AVCodecContext.sample_rate.
5160 * For all other types, this is in units of AVCodecContext.time_base.
5164 enum AVFieldOrder field_order;
5167 * Indicate whether a picture is coded as a frame, top field or bottom field.
5169 * For example, H.264 field_pic_flag equal to 0 corresponds to
5170 * AV_PICTURE_STRUCTURE_FRAME. An H.264 picture with field_pic_flag
5171 * equal to 1 and bottom_field_flag equal to 0 corresponds to
5172 * AV_PICTURE_STRUCTURE_TOP_FIELD.
5174 enum AVPictureStructure picture_structure;
5177 * Picture number incremented in presentation or output order.
5178 * This field may be reinitialized at the first picture of a new sequence.
5180 * For example, this corresponds to H.264 PicOrderCnt.
5182 int output_picture_number;
5185 * Dimensions of the decoded video intended for presentation.
5191 * Dimensions of the coded video.
5197 * The format of the coded data, corresponds to enum AVPixelFormat for video
5198 * and for enum AVSampleFormat for audio.
5200 * Note that a decoder can have considerable freedom in how exactly it
5201 * decodes the data, so the format reported here might be different from the
5202 * one returned by a decoder.
5205 } AVCodecParserContext;
5207 typedef struct AVCodecParser {
5208 int codec_ids[5]; /* several codec IDs are permitted */
5210 int (*parser_init)(AVCodecParserContext *s);
5211 /* This callback never returns an error, a negative value means that
5212 * the frame start was in a previous packet. */
5213 int (*parser_parse)(AVCodecParserContext *s,
5214 AVCodecContext *avctx,
5215 const uint8_t **poutbuf, int *poutbuf_size,
5216 const uint8_t *buf, int buf_size);
5217 void (*parser_close)(AVCodecParserContext *s);
5218 int (*split)(AVCodecContext *avctx, const uint8_t *buf, int buf_size);
5219 struct AVCodecParser *next;
5222 AVCodecParser *av_parser_next(const AVCodecParser *c);
5224 void av_register_codec_parser(AVCodecParser *parser);
5225 AVCodecParserContext *av_parser_init(int codec_id);
5230 * @param s parser context.
5231 * @param avctx codec context.
5232 * @param poutbuf set to pointer to parsed buffer or NULL if not yet finished.
5233 * @param poutbuf_size set to size of parsed buffer or zero if not yet finished.
5234 * @param buf input buffer.
5235 * @param buf_size buffer size in bytes without the padding. I.e. the full buffer
5236 size is assumed to be buf_size + AV_INPUT_BUFFER_PADDING_SIZE.
5237 To signal EOF, this should be 0 (so that the last frame
5239 * @param pts input presentation timestamp.
5240 * @param dts input decoding timestamp.
5241 * @param pos input byte position in stream.
5242 * @return the number of bytes of the input bitstream used.
5247 * len = av_parser_parse2(myparser, AVCodecContext, &data, &size,
5254 * decode_frame(data, size);
5258 int av_parser_parse2(AVCodecParserContext *s,
5259 AVCodecContext *avctx,
5260 uint8_t **poutbuf, int *poutbuf_size,
5261 const uint8_t *buf, int buf_size,
5262 int64_t pts, int64_t dts,
5266 * @return 0 if the output buffer is a subset of the input, 1 if it is allocated and must be freed
5267 * @deprecated use AVBitStreamFilter
5269 int av_parser_change(AVCodecParserContext *s,
5270 AVCodecContext *avctx,
5271 uint8_t **poutbuf, int *poutbuf_size,
5272 const uint8_t *buf, int buf_size, int keyframe);
5273 void av_parser_close(AVCodecParserContext *s);
5281 * @addtogroup lavc_encoding
5286 * Find a registered encoder with a matching codec ID.
5288 * @param id AVCodecID of the requested encoder
5289 * @return An encoder if one was found, NULL otherwise.
5291 AVCodec *avcodec_find_encoder(enum AVCodecID id);
5294 * Find a registered encoder with the specified name.
5296 * @param name name of the requested encoder
5297 * @return An encoder if one was found, NULL otherwise.
5299 AVCodec *avcodec_find_encoder_by_name(const char *name);
5302 * Encode a frame of audio.
5304 * Takes input samples from frame and writes the next output packet, if
5305 * available, to avpkt. The output packet does not necessarily contain data for
5306 * the most recent frame, as encoders can delay, split, and combine input frames
5307 * internally as needed.
5309 * @param avctx codec context
5310 * @param avpkt output AVPacket.
5311 * The user can supply an output buffer by setting
5312 * avpkt->data and avpkt->size prior to calling the
5313 * function, but if the size of the user-provided data is not
5314 * large enough, encoding will fail. If avpkt->data and
5315 * avpkt->size are set, avpkt->destruct must also be set. All
5316 * other AVPacket fields will be reset by the encoder using
5317 * av_init_packet(). If avpkt->data is NULL, the encoder will
5318 * allocate it. The encoder will set avpkt->size to the size
5319 * of the output packet.
5321 * If this function fails or produces no output, avpkt will be
5322 * freed using av_packet_unref().
5323 * @param[in] frame AVFrame containing the raw audio data to be encoded.
5324 * May be NULL when flushing an encoder that has the
5325 * AV_CODEC_CAP_DELAY capability set.
5326 * If AV_CODEC_CAP_VARIABLE_FRAME_SIZE is set, then each frame
5327 * can have any number of samples.
5328 * If it is not set, frame->nb_samples must be equal to
5329 * avctx->frame_size for all frames except the last.
5330 * The final frame may be smaller than avctx->frame_size.
5331 * @param[out] got_packet_ptr This field is set to 1 by libavcodec if the
5332 * output packet is non-empty, and to 0 if it is
5333 * empty. If the function returns an error, the
5334 * packet can be assumed to be invalid, and the
5335 * value of got_packet_ptr is undefined and should
5337 * @return 0 on success, negative error code on failure
5339 * @deprecated use avcodec_send_frame()/avcodec_receive_packet() instead
5341 attribute_deprecated
5342 int avcodec_encode_audio2(AVCodecContext *avctx, AVPacket *avpkt,
5343 const AVFrame *frame, int *got_packet_ptr);
5346 * Encode a frame of video.
5348 * Takes input raw video data from frame and writes the next output packet, if
5349 * available, to avpkt. The output packet does not necessarily contain data for
5350 * the most recent frame, as encoders can delay and reorder input frames
5351 * internally as needed.
5353 * @param avctx codec context
5354 * @param avpkt output AVPacket.
5355 * The user can supply an output buffer by setting
5356 * avpkt->data and avpkt->size prior to calling the
5357 * function, but if the size of the user-provided data is not
5358 * large enough, encoding will fail. All other AVPacket fields
5359 * will be reset by the encoder using av_init_packet(). If
5360 * avpkt->data is NULL, the encoder will allocate it.
5361 * The encoder will set avpkt->size to the size of the
5362 * output packet. The returned data (if any) belongs to the
5363 * caller, he is responsible for freeing it.
5365 * If this function fails or produces no output, avpkt will be
5366 * freed using av_packet_unref().
5367 * @param[in] frame AVFrame containing the raw video data to be encoded.
5368 * May be NULL when flushing an encoder that has the
5369 * AV_CODEC_CAP_DELAY capability set.
5370 * @param[out] got_packet_ptr This field is set to 1 by libavcodec if the
5371 * output packet is non-empty, and to 0 if it is
5372 * empty. If the function returns an error, the
5373 * packet can be assumed to be invalid, and the
5374 * value of got_packet_ptr is undefined and should
5376 * @return 0 on success, negative error code on failure
5378 * @deprecated use avcodec_send_frame()/avcodec_receive_packet() instead
5380 attribute_deprecated
5381 int avcodec_encode_video2(AVCodecContext *avctx, AVPacket *avpkt,
5382 const AVFrame *frame, int *got_packet_ptr);
5384 int avcodec_encode_subtitle(AVCodecContext *avctx, uint8_t *buf, int buf_size,
5385 const AVSubtitle *sub);
5392 #if FF_API_AVCODEC_RESAMPLE
5394 * @defgroup lavc_resample Audio resampling
5396 * @deprecated use libswresample instead
5400 struct ReSampleContext;
5401 struct AVResampleContext;
5403 typedef struct ReSampleContext ReSampleContext;
5406 * Initialize audio resampling context.
5408 * @param output_channels number of output channels
5409 * @param input_channels number of input channels
5410 * @param output_rate output sample rate
5411 * @param input_rate input sample rate
5412 * @param sample_fmt_out requested output sample format
5413 * @param sample_fmt_in input sample format
5414 * @param filter_length length of each FIR filter in the filterbank relative to the cutoff frequency
5415 * @param log2_phase_count log2 of the number of entries in the polyphase filterbank
5416 * @param linear if 1 then the used FIR filter will be linearly interpolated
5417 between the 2 closest, if 0 the closest will be used
5418 * @param cutoff cutoff frequency, 1.0 corresponds to half the output sampling rate
5419 * @return allocated ReSampleContext, NULL if error occurred
5421 attribute_deprecated
5422 ReSampleContext *av_audio_resample_init(int output_channels, int input_channels,
5423 int output_rate, int input_rate,
5424 enum AVSampleFormat sample_fmt_out,
5425 enum AVSampleFormat sample_fmt_in,
5426 int filter_length, int log2_phase_count,
5427 int linear, double cutoff);
5429 attribute_deprecated
5430 int audio_resample(ReSampleContext *s, short *output, short *input, int nb_samples);
5433 * Free resample context.
5435 * @param s a non-NULL pointer to a resample context previously
5436 * created with av_audio_resample_init()
5438 attribute_deprecated
5439 void audio_resample_close(ReSampleContext *s);
5443 * Initialize an audio resampler.
5444 * Note, if either rate is not an integer then simply scale both rates up so they are.
5445 * @param filter_length length of each FIR filter in the filterbank relative to the cutoff freq
5446 * @param log2_phase_count log2 of the number of entries in the polyphase filterbank
5447 * @param linear If 1 then the used FIR filter will be linearly interpolated
5448 between the 2 closest, if 0 the closest will be used
5449 * @param cutoff cutoff frequency, 1.0 corresponds to half the output sampling rate
5451 attribute_deprecated
5452 struct AVResampleContext *av_resample_init(int out_rate, int in_rate, int filter_length, int log2_phase_count, int linear, double cutoff);
5455 * Resample an array of samples using a previously configured context.
5456 * @param src an array of unconsumed samples
5457 * @param consumed the number of samples of src which have been consumed are returned here
5458 * @param src_size the number of unconsumed samples available
5459 * @param dst_size the amount of space in samples available in dst
5460 * @param update_ctx If this is 0 then the context will not be modified, that way several channels can be resampled with the same context.
5461 * @return the number of samples written in dst or -1 if an error occurred
5463 attribute_deprecated
5464 int av_resample(struct AVResampleContext *c, short *dst, short *src, int *consumed, int src_size, int dst_size, int update_ctx);
5468 * Compensate samplerate/timestamp drift. The compensation is done by changing
5469 * the resampler parameters, so no audible clicks or similar distortions occur
5470 * @param compensation_distance distance in output samples over which the compensation should be performed
5471 * @param sample_delta number of output samples which should be output less
5473 * example: av_resample_compensate(c, 10, 500)
5474 * here instead of 510 samples only 500 samples would be output
5476 * note, due to rounding the actual compensation might be slightly different,
5477 * especially if the compensation_distance is large and the in_rate used during init is small
5479 attribute_deprecated
5480 void av_resample_compensate(struct AVResampleContext *c, int sample_delta, int compensation_distance);
5481 attribute_deprecated
5482 void av_resample_close(struct AVResampleContext *c);
5489 #if FF_API_AVPICTURE
5491 * @addtogroup lavc_picture
5496 * @deprecated unused
5498 attribute_deprecated
5499 int avpicture_alloc(AVPicture *picture, enum AVPixelFormat pix_fmt, int width, int height);
5502 * @deprecated unused
5504 attribute_deprecated
5505 void avpicture_free(AVPicture *picture);
5508 * @deprecated use av_image_fill_arrays() instead.
5510 attribute_deprecated
5511 int avpicture_fill(AVPicture *picture, const uint8_t *ptr,
5512 enum AVPixelFormat pix_fmt, int width, int height);
5515 * @deprecated use av_image_copy_to_buffer() instead.
5517 attribute_deprecated
5518 int avpicture_layout(const AVPicture *src, enum AVPixelFormat pix_fmt,
5519 int width, int height,
5520 unsigned char *dest, int dest_size);
5523 * @deprecated use av_image_get_buffer_size() instead.
5525 attribute_deprecated
5526 int avpicture_get_size(enum AVPixelFormat pix_fmt, int width, int height);
5529 * @deprecated av_image_copy() instead.
5531 attribute_deprecated
5532 void av_picture_copy(AVPicture *dst, const AVPicture *src,
5533 enum AVPixelFormat pix_fmt, int width, int height);
5536 * @deprecated unused
5538 attribute_deprecated
5539 int av_picture_crop(AVPicture *dst, const AVPicture *src,
5540 enum AVPixelFormat pix_fmt, int top_band, int left_band);
5543 * @deprecated unused
5545 attribute_deprecated
5546 int av_picture_pad(AVPicture *dst, const AVPicture *src, int height, int width, enum AVPixelFormat pix_fmt,
5547 int padtop, int padbottom, int padleft, int padright, int *color);
5555 * @defgroup lavc_misc Utility functions
5558 * Miscellaneous utility functions related to both encoding and decoding
5564 * @defgroup lavc_misc_pixfmt Pixel formats
5566 * Functions for working with pixel formats.
5571 * Utility function to access log2_chroma_w log2_chroma_h from
5572 * the pixel format AVPixFmtDescriptor.
5574 * This function asserts that pix_fmt is valid. See av_pix_fmt_get_chroma_sub_sample
5575 * for one that returns a failure code and continues in case of invalid
5578 * @param[in] pix_fmt the pixel format
5579 * @param[out] h_shift store log2_chroma_w
5580 * @param[out] v_shift store log2_chroma_h
5582 * @see av_pix_fmt_get_chroma_sub_sample
5585 void avcodec_get_chroma_sub_sample(enum AVPixelFormat pix_fmt, int *h_shift, int *v_shift);
5588 * Return a value representing the fourCC code associated to the
5589 * pixel format pix_fmt, or 0 if no associated fourCC code can be
5592 unsigned int avcodec_pix_fmt_to_codec_tag(enum AVPixelFormat pix_fmt);
5595 * @deprecated see av_get_pix_fmt_loss()
5597 int avcodec_get_pix_fmt_loss(enum AVPixelFormat dst_pix_fmt, enum AVPixelFormat src_pix_fmt,
5601 * Find the best pixel format to convert to given a certain source pixel
5602 * format. When converting from one pixel format to another, information loss
5603 * may occur. For example, when converting from RGB24 to GRAY, the color
5604 * information will be lost. Similarly, other losses occur when converting from
5605 * some formats to other formats. avcodec_find_best_pix_fmt_of_2() searches which of
5606 * the given pixel formats should be used to suffer the least amount of loss.
5607 * The pixel formats from which it chooses one, are determined by the
5608 * pix_fmt_list parameter.
5611 * @param[in] pix_fmt_list AV_PIX_FMT_NONE terminated array of pixel formats to choose from
5612 * @param[in] src_pix_fmt source pixel format
5613 * @param[in] has_alpha Whether the source pixel format alpha channel is used.
5614 * @param[out] loss_ptr Combination of flags informing you what kind of losses will occur.
5615 * @return The best pixel format to convert to or -1 if none was found.
5617 enum AVPixelFormat avcodec_find_best_pix_fmt_of_list(const enum AVPixelFormat *pix_fmt_list,
5618 enum AVPixelFormat src_pix_fmt,
5619 int has_alpha, int *loss_ptr);
5622 * @deprecated see av_find_best_pix_fmt_of_2()
5624 enum AVPixelFormat avcodec_find_best_pix_fmt_of_2(enum AVPixelFormat dst_pix_fmt1, enum AVPixelFormat dst_pix_fmt2,
5625 enum AVPixelFormat src_pix_fmt, int has_alpha, int *loss_ptr);
5627 attribute_deprecated
5628 enum AVPixelFormat avcodec_find_best_pix_fmt2(enum AVPixelFormat dst_pix_fmt1, enum AVPixelFormat dst_pix_fmt2,
5629 enum AVPixelFormat src_pix_fmt, int has_alpha, int *loss_ptr);
5631 enum AVPixelFormat avcodec_default_get_format(struct AVCodecContext *s, const enum AVPixelFormat * fmt);
5637 #if FF_API_SET_DIMENSIONS
5639 * @deprecated this function is not supposed to be used from outside of lavc
5641 attribute_deprecated
5642 void avcodec_set_dimensions(AVCodecContext *s, int width, int height);
5646 * Put a string representing the codec tag codec_tag in buf.
5648 * @param buf buffer to place codec tag in
5649 * @param buf_size size in bytes of buf
5650 * @param codec_tag codec tag to assign
5651 * @return the length of the string that would have been generated if
5652 * enough space had been available, excluding the trailing null
5654 size_t av_get_codec_tag_string(char *buf, size_t buf_size, unsigned int codec_tag);
5656 void avcodec_string(char *buf, int buf_size, AVCodecContext *enc, int encode);
5659 * Return a name for the specified profile, if available.
5661 * @param codec the codec that is searched for the given profile
5662 * @param profile the profile value for which a name is requested
5663 * @return A name for the profile if found, NULL otherwise.
5665 const char *av_get_profile_name(const AVCodec *codec, int profile);
5668 * Return a name for the specified profile, if available.
5670 * @param codec_id the ID of the codec to which the requested profile belongs
5671 * @param profile the profile value for which a name is requested
5672 * @return A name for the profile if found, NULL otherwise.
5674 * @note unlike av_get_profile_name(), which searches a list of profiles
5675 * supported by a specific decoder or encoder implementation, this
5676 * function searches the list of profiles from the AVCodecDescriptor
5678 const char *avcodec_profile_name(enum AVCodecID codec_id, int profile);
5680 int avcodec_default_execute(AVCodecContext *c, int (*func)(AVCodecContext *c2, void *arg2),void *arg, int *ret, int count, int size);
5681 int avcodec_default_execute2(AVCodecContext *c, int (*func)(AVCodecContext *c2, void *arg2, int, int),void *arg, int *ret, int count);
5682 //FIXME func typedef
5685 * Fill AVFrame audio data and linesize pointers.
5687 * The buffer buf must be a preallocated buffer with a size big enough
5688 * to contain the specified samples amount. The filled AVFrame data
5689 * pointers will point to this buffer.
5691 * AVFrame extended_data channel pointers are allocated if necessary for
5694 * @param frame the AVFrame
5695 * frame->nb_samples must be set prior to calling the
5696 * function. This function fills in frame->data,
5697 * frame->extended_data, frame->linesize[0].
5698 * @param nb_channels channel count
5699 * @param sample_fmt sample format
5700 * @param buf buffer to use for frame data
5701 * @param buf_size size of buffer
5702 * @param align plane size sample alignment (0 = default)
5703 * @return >=0 on success, negative error code on failure
5704 * @todo return the size in bytes required to store the samples in
5705 * case of success, at the next libavutil bump
5707 int avcodec_fill_audio_frame(AVFrame *frame, int nb_channels,
5708 enum AVSampleFormat sample_fmt, const uint8_t *buf,
5709 int buf_size, int align);
5712 * Reset the internal decoder state / flush internal buffers. Should be called
5713 * e.g. when seeking or when switching to a different stream.
5715 * @note when refcounted frames are not used (i.e. avctx->refcounted_frames is 0),
5716 * this invalidates the frames previously returned from the decoder. When
5717 * refcounted frames are used, the decoder just releases any references it might
5718 * keep internally, but the caller's reference remains valid.
5720 void avcodec_flush_buffers(AVCodecContext *avctx);
5723 * Return codec bits per sample.
5725 * @param[in] codec_id the codec
5726 * @return Number of bits per sample or zero if unknown for the given codec.
5728 int av_get_bits_per_sample(enum AVCodecID codec_id);
5731 * Return the PCM codec associated with a sample format.
5732 * @param be endianness, 0 for little, 1 for big,
5733 * -1 (or anything else) for native
5734 * @return AV_CODEC_ID_PCM_* or AV_CODEC_ID_NONE
5736 enum AVCodecID av_get_pcm_codec(enum AVSampleFormat fmt, int be);
5739 * Return codec bits per sample.
5740 * Only return non-zero if the bits per sample is exactly correct, not an
5743 * @param[in] codec_id the codec
5744 * @return Number of bits per sample or zero if unknown for the given codec.
5746 int av_get_exact_bits_per_sample(enum AVCodecID codec_id);
5749 * Return audio frame duration.
5751 * @param avctx codec context
5752 * @param frame_bytes size of the frame, or 0 if unknown
5753 * @return frame duration, in samples, if known. 0 if not able to
5756 int av_get_audio_frame_duration(AVCodecContext *avctx, int frame_bytes);
5759 * This function is the same as av_get_audio_frame_duration(), except it works
5760 * with AVCodecParameters instead of an AVCodecContext.
5762 int av_get_audio_frame_duration2(AVCodecParameters *par, int frame_bytes);
5765 typedef struct AVBitStreamFilterContext {
5767 const struct AVBitStreamFilter *filter;
5768 AVCodecParserContext *parser;
5769 struct AVBitStreamFilterContext *next;
5771 * Internal default arguments, used if NULL is passed to av_bitstream_filter_filter().
5772 * Not for access by library users.
5775 } AVBitStreamFilterContext;
5778 typedef struct AVBSFInternal AVBSFInternal;
5781 * The bitstream filter state.
5783 * This struct must be allocated with av_bsf_alloc() and freed with
5786 * The fields in the struct will only be changed (by the caller or by the
5787 * filter) as described in their documentation, and are to be considered
5788 * immutable otherwise.
5790 typedef struct AVBSFContext {
5792 * A class for logging and AVOptions
5794 const AVClass *av_class;
5797 * The bitstream filter this context is an instance of.
5799 const struct AVBitStreamFilter *filter;
5802 * Opaque libavcodec internal data. Must not be touched by the caller in any
5805 AVBSFInternal *internal;
5808 * Opaque filter-specific private data. If filter->priv_class is non-NULL,
5809 * this is an AVOptions-enabled struct.
5814 * Parameters of the input stream. Set by the caller before av_bsf_init().
5816 AVCodecParameters *par_in;
5819 * Parameters of the output stream. Set by the filter in av_bsf_init().
5821 AVCodecParameters *par_out;
5824 * The timebase used for the timestamps of the input packets. Set by the
5825 * caller before av_bsf_init().
5827 AVRational time_base_in;
5830 * The timebase used for the timestamps of the output packets. Set by the
5831 * filter in av_bsf_init().
5833 AVRational time_base_out;
5836 typedef struct AVBitStreamFilter {
5840 * A list of codec ids supported by the filter, terminated by
5842 * May be NULL, in that case the bitstream filter works with any codec id.
5844 const enum AVCodecID *codec_ids;
5847 * A class for the private data, used to declare bitstream filter private
5848 * AVOptions. This field is NULL for bitstream filters that do not declare
5851 * If this field is non-NULL, the first member of the filter private data
5852 * must be a pointer to AVClass, which will be set by libavcodec generic
5853 * code to this class.
5855 const AVClass *priv_class;
5857 /*****************************************************************
5858 * No fields below this line are part of the public API. They
5859 * may not be used outside of libavcodec and can be changed and
5861 * New public fields should be added right above.
5862 *****************************************************************
5866 int (*init)(AVBSFContext *ctx);
5867 int (*filter)(AVBSFContext *ctx, AVPacket *pkt);
5868 void (*close)(AVBSFContext *ctx);
5869 } AVBitStreamFilter;
5873 * Register a bitstream filter.
5875 * The filter will be accessible to the application code through
5876 * av_bitstream_filter_next() or can be directly initialized with
5877 * av_bitstream_filter_init().
5879 * @see avcodec_register_all()
5881 attribute_deprecated
5882 void av_register_bitstream_filter(AVBitStreamFilter *bsf);
5885 * Create and initialize a bitstream filter context given a bitstream
5888 * The returned context must be freed with av_bitstream_filter_close().
5890 * @param name the name of the bitstream filter
5891 * @return a bitstream filter context if a matching filter was found
5892 * and successfully initialized, NULL otherwise
5894 attribute_deprecated
5895 AVBitStreamFilterContext *av_bitstream_filter_init(const char *name);
5900 * This function filters the buffer buf with size buf_size, and places the
5901 * filtered buffer in the buffer pointed to by poutbuf.
5903 * The output buffer must be freed by the caller.
5905 * @param bsfc bitstream filter context created by av_bitstream_filter_init()
5906 * @param avctx AVCodecContext accessed by the filter, may be NULL.
5907 * If specified, this must point to the encoder context of the
5908 * output stream the packet is sent to.
5909 * @param args arguments which specify the filter configuration, may be NULL
5910 * @param poutbuf pointer which is updated to point to the filtered buffer
5911 * @param poutbuf_size pointer which is updated to the filtered buffer size in bytes
5912 * @param buf buffer containing the data to filter
5913 * @param buf_size size in bytes of buf
5914 * @param keyframe set to non-zero if the buffer to filter corresponds to a key-frame packet data
5915 * @return >= 0 in case of success, or a negative error code in case of failure
5917 * If the return value is positive, an output buffer is allocated and
5918 * is available in *poutbuf, and is distinct from the input buffer.
5920 * If the return value is 0, the output buffer is not allocated and
5921 * should be considered identical to the input buffer, or in case
5922 * *poutbuf was set it points to the input buffer (not necessarily to
5923 * its starting address). A special case is if *poutbuf was set to NULL and
5924 * *poutbuf_size was set to 0, which indicates the packet should be dropped.
5926 attribute_deprecated
5927 int av_bitstream_filter_filter(AVBitStreamFilterContext *bsfc,
5928 AVCodecContext *avctx, const char *args,
5929 uint8_t **poutbuf, int *poutbuf_size,
5930 const uint8_t *buf, int buf_size, int keyframe);
5933 * Release bitstream filter context.
5935 * @param bsf the bitstream filter context created with
5936 * av_bitstream_filter_init(), can be NULL
5938 attribute_deprecated
5939 void av_bitstream_filter_close(AVBitStreamFilterContext *bsf);
5942 * If f is NULL, return the first registered bitstream filter,
5943 * if f is non-NULL, return the next registered bitstream filter
5944 * after f, or NULL if f is the last one.
5946 * This function can be used to iterate over all registered bitstream
5949 attribute_deprecated
5950 AVBitStreamFilter *av_bitstream_filter_next(const AVBitStreamFilter *f);
5954 * @return a bitstream filter with the specified name or NULL if no such
5955 * bitstream filter exists.
5957 const AVBitStreamFilter *av_bsf_get_by_name(const char *name);
5960 * Iterate over all registered bitstream filters.
5962 * @param opaque a pointer where libavcodec will store the iteration state. Must
5963 * point to NULL to start the iteration.
5965 * @return the next registered bitstream filter or NULL when the iteration is
5968 const AVBitStreamFilter *av_bsf_next(void **opaque);
5971 * Allocate a context for a given bitstream filter. The caller must fill in the
5972 * context parameters as described in the documentation and then call
5973 * av_bsf_init() before sending any data to the filter.
5975 * @param filter the filter for which to allocate an instance.
5976 * @param ctx a pointer into which the pointer to the newly-allocated context
5977 * will be written. It must be freed with av_bsf_free() after the
5978 * filtering is done.
5980 * @return 0 on success, a negative AVERROR code on failure
5982 int av_bsf_alloc(const AVBitStreamFilter *filter, AVBSFContext **ctx);
5985 * Prepare the filter for use, after all the parameters and options have been
5988 int av_bsf_init(AVBSFContext *ctx);
5991 * Submit a packet for filtering.
5993 * After sending each packet, the filter must be completely drained by calling
5994 * av_bsf_receive_packet() repeatedly until it returns AVERROR(EAGAIN) or
5997 * @param pkt the packet to filter. pkt must contain some payload (i.e data or
5998 * side data must be present in pkt). The bitstream filter will take ownership of
5999 * the packet and reset the contents of pkt. pkt is not touched if an error occurs.
6000 * This parameter may be NULL, which signals the end of the stream (i.e. no more
6001 * packets will be sent). That will cause the filter to output any packets it
6002 * may have buffered internally.
6004 * @return 0 on success, a negative AVERROR on error.
6006 int av_bsf_send_packet(AVBSFContext *ctx, AVPacket *pkt);
6009 * Retrieve a filtered packet.
6011 * @param[out] pkt this struct will be filled with the contents of the filtered
6012 * packet. It is owned by the caller and must be freed using
6013 * av_packet_unref() when it is no longer needed.
6014 * This parameter should be "clean" (i.e. freshly allocated
6015 * with av_packet_alloc() or unreffed with av_packet_unref())
6016 * when this function is called. If this function returns
6017 * successfully, the contents of pkt will be completely
6018 * overwritten by the returned data. On failure, pkt is not
6021 * @return 0 on success. AVERROR(EAGAIN) if more packets need to be sent to the
6022 * filter (using av_bsf_send_packet()) to get more output. AVERROR_EOF if there
6023 * will be no further output from the filter. Another negative AVERROR value if
6026 * @note one input packet may result in several output packets, so after sending
6027 * a packet with av_bsf_send_packet(), this function needs to be called
6028 * repeatedly until it stops returning 0. It is also possible for a filter to
6029 * output fewer packets than were sent to it, so this function may return
6030 * AVERROR(EAGAIN) immediately after a successful av_bsf_send_packet() call.
6032 int av_bsf_receive_packet(AVBSFContext *ctx, AVPacket *pkt);
6035 * Free a bitstream filter context and everything associated with it; write NULL
6036 * into the supplied pointer.
6038 void av_bsf_free(AVBSFContext **ctx);
6041 * Get the AVClass for AVBSFContext. It can be used in combination with
6042 * AV_OPT_SEARCH_FAKE_OBJ for examining options.
6044 * @see av_opt_find().
6046 const AVClass *av_bsf_get_class(void);
6049 * Structure for chain/list of bitstream filters.
6050 * Empty list can be allocated by av_bsf_list_alloc().
6052 typedef struct AVBSFList AVBSFList;
6055 * Allocate empty list of bitstream filters.
6056 * The list must be later freed by av_bsf_list_free()
6057 * or finalized by av_bsf_list_finalize().
6059 * @return Pointer to @ref AVBSFList on success, NULL in case of failure
6061 AVBSFList *av_bsf_list_alloc(void);
6064 * Free list of bitstream filters.
6066 * @param lst Pointer to pointer returned by av_bsf_list_alloc()
6068 void av_bsf_list_free(AVBSFList **lst);
6071 * Append bitstream filter to the list of bitstream filters.
6073 * @param lst List to append to
6074 * @param bsf Filter context to be appended
6076 * @return >=0 on success, negative AVERROR in case of failure
6078 int av_bsf_list_append(AVBSFList *lst, AVBSFContext *bsf);
6081 * Construct new bitstream filter context given it's name and options
6082 * and append it to the list of bitstream filters.
6084 * @param lst List to append to
6085 * @param bsf_name Name of the bitstream filter
6086 * @param options Options for the bitstream filter, can be set to NULL
6088 * @return >=0 on success, negative AVERROR in case of failure
6090 int av_bsf_list_append2(AVBSFList *lst, const char * bsf_name, AVDictionary **options);
6092 * Finalize list of bitstream filters.
6094 * This function will transform @ref AVBSFList to single @ref AVBSFContext,
6095 * so the whole chain of bitstream filters can be treated as single filter
6096 * freshly allocated by av_bsf_alloc().
6097 * If the call is successful, @ref AVBSFList structure is freed and lst
6098 * will be set to NULL. In case of failure, caller is responsible for
6099 * freeing the structure by av_bsf_list_free()
6101 * @param lst Filter list structure to be transformed
6102 * @param[out] bsf Pointer to be set to newly created @ref AVBSFContext structure
6103 * representing the chain of bitstream filters
6105 * @return >=0 on success, negative AVERROR in case of failure
6107 int av_bsf_list_finalize(AVBSFList **lst, AVBSFContext **bsf);
6110 * Parse string describing list of bitstream filters and create single
6111 * @ref AVBSFContext describing the whole chain of bitstream filters.
6112 * Resulting @ref AVBSFContext can be treated as any other @ref AVBSFContext freshly
6113 * allocated by av_bsf_alloc().
6115 * @param str String describing chain of bitstream filters in format
6116 * `bsf1[=opt1=val1:opt2=val2][,bsf2]`
6117 * @param[out] bsf Pointer to be set to newly created @ref AVBSFContext structure
6118 * representing the chain of bitstream filters
6120 * @return >=0 on success, negative AVERROR in case of failure
6122 int av_bsf_list_parse_str(const char *str, AVBSFContext **bsf);
6125 * Get null/pass-through bitstream filter.
6127 * @param[out] bsf Pointer to be set to new instance of pass-through bitstream filter
6131 int av_bsf_get_null_filter(AVBSFContext **bsf);
6136 * Same behaviour av_fast_malloc but the buffer has additional
6137 * AV_INPUT_BUFFER_PADDING_SIZE at the end which will always be 0.
6139 * In addition the whole buffer will initially and after resizes
6140 * be 0-initialized so that no uninitialized data will ever appear.
6142 void av_fast_padded_malloc(void *ptr, unsigned int *size, size_t min_size);
6145 * Same behaviour av_fast_padded_malloc except that buffer will always
6146 * be 0-initialized after call.
6148 void av_fast_padded_mallocz(void *ptr, unsigned int *size, size_t min_size);
6151 * Encode extradata length to a buffer. Used by xiph codecs.
6153 * @param s buffer to write to; must be at least (v/255+1) bytes long
6154 * @param v size of extradata in bytes
6155 * @return number of bytes written to the buffer.
6157 unsigned int av_xiphlacing(unsigned char *s, unsigned int v);
6159 #if FF_API_MISSING_SAMPLE
6161 * Log a generic warning message about a missing feature. This function is
6162 * intended to be used internally by FFmpeg (libavcodec, libavformat, etc.)
6163 * only, and would normally not be used by applications.
6164 * @param[in] avc a pointer to an arbitrary struct of which the first field is
6165 * a pointer to an AVClass struct
6166 * @param[in] feature string containing the name of the missing feature
6167 * @param[in] want_sample indicates if samples are wanted which exhibit this feature.
6168 * If want_sample is non-zero, additional verbiage will be added to the log
6169 * message which tells the user how to report samples to the development
6171 * @deprecated Use avpriv_report_missing_feature() instead.
6173 attribute_deprecated
6174 void av_log_missing_feature(void *avc, const char *feature, int want_sample);
6177 * Log a generic warning message asking for a sample. This function is
6178 * intended to be used internally by FFmpeg (libavcodec, libavformat, etc.)
6179 * only, and would normally not be used by applications.
6180 * @param[in] avc a pointer to an arbitrary struct of which the first field is
6181 * a pointer to an AVClass struct
6182 * @param[in] msg string containing an optional message, or NULL if no message
6183 * @deprecated Use avpriv_request_sample() instead.
6185 attribute_deprecated
6186 void av_log_ask_for_sample(void *avc, const char *msg, ...) av_printf_format(2, 3);
6187 #endif /* FF_API_MISSING_SAMPLE */
6190 * Register the hardware accelerator hwaccel.
6192 void av_register_hwaccel(AVHWAccel *hwaccel);
6195 * If hwaccel is NULL, returns the first registered hardware accelerator,
6196 * if hwaccel is non-NULL, returns the next registered hardware accelerator
6197 * after hwaccel, or NULL if hwaccel is the last one.
6199 AVHWAccel *av_hwaccel_next(const AVHWAccel *hwaccel);
6203 * Lock operation used by lockmgr
6206 AV_LOCK_CREATE, ///< Create a mutex
6207 AV_LOCK_OBTAIN, ///< Lock the mutex
6208 AV_LOCK_RELEASE, ///< Unlock the mutex
6209 AV_LOCK_DESTROY, ///< Free mutex resources
6213 * Register a user provided lock manager supporting the operations
6214 * specified by AVLockOp. The "mutex" argument to the function points
6215 * to a (void *) where the lockmgr should store/get a pointer to a user
6216 * allocated mutex. It is NULL upon AV_LOCK_CREATE and equal to the
6217 * value left by the last call for all other ops. If the lock manager is
6218 * unable to perform the op then it should leave the mutex in the same
6219 * state as when it was called and return a non-zero value. However,
6220 * when called with AV_LOCK_DESTROY the mutex will always be assumed to
6221 * have been successfully destroyed. If av_lockmgr_register succeeds
6222 * it will return a non-negative value, if it fails it will return a
6223 * negative value and destroy all mutex and unregister all callbacks.
6224 * av_lockmgr_register is not thread-safe, it must be called from a
6225 * single thread before any calls which make use of locking are used.
6227 * @param cb User defined callback. av_lockmgr_register invokes calls
6228 * to this callback and the previously registered callback.
6229 * The callback will be used to create more than one mutex
6230 * each of which must be backed by its own underlying locking
6231 * mechanism (i.e. do not use a single static object to
6232 * implement your lock manager). If cb is set to NULL the
6233 * lockmgr will be unregistered.
6235 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 */