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, or
146 * at least will not fail with AVERROR(EAGAIN). In general, no codec will
147 * permit unlimited buffering of input or output.
149 * This API replaces the following legacy functions:
150 * - avcodec_decode_video2() and avcodec_decode_audio4():
151 * Use avcodec_send_packet() to feed input to the decoder, then use
152 * avcodec_receive_frame() to receive decoded frames after each packet.
153 * Unlike with the old video decoding API, multiple frames might result from
154 * a packet. For audio, splitting the input packet into frames by partially
155 * decoding packets becomes transparent to the API user. You never need to
156 * feed an AVPacket to the API twice (unless it is rejected with AVERROR(EAGAIN) - then
157 * no data was read from the packet).
158 * Additionally, sending a flush/draining packet is required only once.
159 * - avcodec_encode_video2()/avcodec_encode_audio2():
160 * Use avcodec_send_frame() to feed input to the encoder, then use
161 * avcodec_receive_packet() to receive encoded packets.
162 * Providing user-allocated buffers for avcodec_receive_packet() is not
164 * - The new API does not handle subtitles yet.
166 * Mixing new and old function calls on the same AVCodecContext is not allowed,
167 * and will result in undefined behavior.
169 * Some codecs might require using the new API; using the old API will return
170 * an error when calling it. All codecs support the new API.
172 * A codec is not allowed to return AVERROR(EAGAIN) for both sending and receiving. This
173 * would be an invalid state, which could put the codec user into an endless
174 * loop. The API has no concept of time either: it cannot happen that trying to
175 * do avcodec_send_packet() results in AVERROR(EAGAIN), but a repeated call 1 second
176 * later accepts the packet (with no other receive/flush API calls involved).
177 * The API is a strict state machine, and the passage of time is not supposed
178 * to influence it. Some timing-dependent behavior might still be deemed
179 * acceptable in certain cases. But it must never result in both send/receive
180 * returning EAGAIN at the same time at any point. It must also absolutely be
181 * avoided that the current state is "unstable" and can "flip-flop" between
182 * the send/receive APIs allowing progress. For example, it's not allowed that
183 * the codec randomly decides that it actually wants to consume a packet now
184 * instead of returning a frame, after it just returned AVERROR(EAGAIN) on an
185 * avcodec_send_packet() call.
190 * @defgroup lavc_core Core functions/structures.
193 * Basic definitions, functions for querying libavcodec capabilities,
194 * allocating core structures, etc.
200 * Identify the syntax and semantics of the bitstream.
201 * The principle is roughly:
202 * Two decoders with the same ID can decode the same streams.
203 * Two encoders with the same ID can encode compatible streams.
204 * There may be slight deviations from the principle due to implementation
207 * If you add a codec ID to this list, add it so that
208 * 1. no value of an existing codec ID changes (that would break ABI),
209 * 2. it is as close as possible to similar codecs
211 * After adding new codec IDs, do not forget to add an entry to the codec
212 * descriptor list and bump libavcodec minor version.
218 AV_CODEC_ID_MPEG1VIDEO,
219 AV_CODEC_ID_MPEG2VIDEO, ///< preferred ID for MPEG-1/2 video decoding
221 AV_CODEC_ID_MPEG2VIDEO_XVMC,
222 #endif /* FF_API_XVMC */
233 AV_CODEC_ID_RAWVIDEO,
234 AV_CODEC_ID_MSMPEG4V1,
235 AV_CODEC_ID_MSMPEG4V2,
236 AV_CODEC_ID_MSMPEG4V3,
259 AV_CODEC_ID_INTERPLAY_VIDEO,
266 AV_CODEC_ID_MSVIDEO1,
271 AV_CODEC_ID_TRUEMOTION1,
272 AV_CODEC_ID_VMDVIDEO,
297 AV_CODEC_ID_TRUEMOTION2,
303 AV_CODEC_ID_SMACKVIDEO,
308 AV_CODEC_ID_JPEG2000,
314 AV_CODEC_ID_DSICINVIDEO,
315 AV_CODEC_ID_TIERTEXSEQVIDEO,
323 AV_CODEC_ID_BETHSOFTVID,
335 AV_CODEC_ID_ESCAPE124,
339 AV_CODEC_ID_MOTIONPIXELS,
351 AV_CODEC_ID_FLASHSV2,
352 AV_CODEC_ID_CDGRAPHICS,
355 AV_CODEC_ID_BINKVIDEO,
356 AV_CODEC_ID_IFF_ILBM,
357 #define AV_CODEC_ID_IFF_BYTERUN1 AV_CODEC_ID_IFF_ILBM
363 AV_CODEC_ID_A64_MULTI,
364 AV_CODEC_ID_A64_MULTI5,
367 AV_CODEC_ID_LAGARITH,
371 AV_CODEC_ID_WMV3IMAGE,
372 AV_CODEC_ID_VC1IMAGE,
374 AV_CODEC_ID_BMV_VIDEO,
381 AV_CODEC_ID_ZEROCODEC,
390 AV_CODEC_ID_ESCAPE130,
393 AV_CODEC_ID_HNM4_VIDEO,
395 #define AV_CODEC_ID_H265 AV_CODEC_ID_HEVC
397 AV_CODEC_ID_ALIAS_PIX,
398 AV_CODEC_ID_BRENDER_PIX,
399 AV_CODEC_ID_PAF_VIDEO,
412 AV_CODEC_ID_SCREENPRESSO,
415 AV_CODEC_ID_Y41P = 0x8000,
420 AV_CODEC_ID_TARGA_Y216,
432 AV_CODEC_ID_TRUEMOTION2RT,
434 AV_CODEC_ID_MAGICYUV,
435 AV_CODEC_ID_SHEERVIDEO,
442 AV_CODEC_ID_CLEARVIDEO,
445 AV_CODEC_ID_BITPACKED,
449 /* various PCM "codecs" */
450 AV_CODEC_ID_FIRST_AUDIO = 0x10000, ///< A dummy id pointing at the start of audio codecs
451 AV_CODEC_ID_PCM_S16LE = 0x10000,
452 AV_CODEC_ID_PCM_S16BE,
453 AV_CODEC_ID_PCM_U16LE,
454 AV_CODEC_ID_PCM_U16BE,
457 AV_CODEC_ID_PCM_MULAW,
458 AV_CODEC_ID_PCM_ALAW,
459 AV_CODEC_ID_PCM_S32LE,
460 AV_CODEC_ID_PCM_S32BE,
461 AV_CODEC_ID_PCM_U32LE,
462 AV_CODEC_ID_PCM_U32BE,
463 AV_CODEC_ID_PCM_S24LE,
464 AV_CODEC_ID_PCM_S24BE,
465 AV_CODEC_ID_PCM_U24LE,
466 AV_CODEC_ID_PCM_U24BE,
467 AV_CODEC_ID_PCM_S24DAUD,
468 AV_CODEC_ID_PCM_ZORK,
469 AV_CODEC_ID_PCM_S16LE_PLANAR,
471 AV_CODEC_ID_PCM_F32BE,
472 AV_CODEC_ID_PCM_F32LE,
473 AV_CODEC_ID_PCM_F64BE,
474 AV_CODEC_ID_PCM_F64LE,
475 AV_CODEC_ID_PCM_BLURAY,
478 AV_CODEC_ID_PCM_S8_PLANAR,
479 AV_CODEC_ID_PCM_S24LE_PLANAR,
480 AV_CODEC_ID_PCM_S32LE_PLANAR,
481 AV_CODEC_ID_PCM_S16BE_PLANAR,
483 AV_CODEC_ID_PCM_S64LE = 0x10800,
484 AV_CODEC_ID_PCM_S64BE,
485 AV_CODEC_ID_PCM_F16LE,
486 AV_CODEC_ID_PCM_F24LE,
488 /* various ADPCM codecs */
489 AV_CODEC_ID_ADPCM_IMA_QT = 0x11000,
490 AV_CODEC_ID_ADPCM_IMA_WAV,
491 AV_CODEC_ID_ADPCM_IMA_DK3,
492 AV_CODEC_ID_ADPCM_IMA_DK4,
493 AV_CODEC_ID_ADPCM_IMA_WS,
494 AV_CODEC_ID_ADPCM_IMA_SMJPEG,
495 AV_CODEC_ID_ADPCM_MS,
496 AV_CODEC_ID_ADPCM_4XM,
497 AV_CODEC_ID_ADPCM_XA,
498 AV_CODEC_ID_ADPCM_ADX,
499 AV_CODEC_ID_ADPCM_EA,
500 AV_CODEC_ID_ADPCM_G726,
501 AV_CODEC_ID_ADPCM_CT,
502 AV_CODEC_ID_ADPCM_SWF,
503 AV_CODEC_ID_ADPCM_YAMAHA,
504 AV_CODEC_ID_ADPCM_SBPRO_4,
505 AV_CODEC_ID_ADPCM_SBPRO_3,
506 AV_CODEC_ID_ADPCM_SBPRO_2,
507 AV_CODEC_ID_ADPCM_THP,
508 AV_CODEC_ID_ADPCM_IMA_AMV,
509 AV_CODEC_ID_ADPCM_EA_R1,
510 AV_CODEC_ID_ADPCM_EA_R3,
511 AV_CODEC_ID_ADPCM_EA_R2,
512 AV_CODEC_ID_ADPCM_IMA_EA_SEAD,
513 AV_CODEC_ID_ADPCM_IMA_EA_EACS,
514 AV_CODEC_ID_ADPCM_EA_XAS,
515 AV_CODEC_ID_ADPCM_EA_MAXIS_XA,
516 AV_CODEC_ID_ADPCM_IMA_ISS,
517 AV_CODEC_ID_ADPCM_G722,
518 AV_CODEC_ID_ADPCM_IMA_APC,
519 AV_CODEC_ID_ADPCM_VIMA,
520 #if FF_API_VIMA_DECODER
521 AV_CODEC_ID_VIMA = AV_CODEC_ID_ADPCM_VIMA,
524 AV_CODEC_ID_ADPCM_AFC = 0x11800,
525 AV_CODEC_ID_ADPCM_IMA_OKI,
526 AV_CODEC_ID_ADPCM_DTK,
527 AV_CODEC_ID_ADPCM_IMA_RAD,
528 AV_CODEC_ID_ADPCM_G726LE,
529 AV_CODEC_ID_ADPCM_THP_LE,
530 AV_CODEC_ID_ADPCM_PSX,
531 AV_CODEC_ID_ADPCM_AICA,
532 AV_CODEC_ID_ADPCM_IMA_DAT4,
533 AV_CODEC_ID_ADPCM_MTAF,
536 AV_CODEC_ID_AMR_NB = 0x12000,
539 /* RealAudio codecs*/
540 AV_CODEC_ID_RA_144 = 0x13000,
543 /* various DPCM codecs */
544 AV_CODEC_ID_ROQ_DPCM = 0x14000,
545 AV_CODEC_ID_INTERPLAY_DPCM,
546 AV_CODEC_ID_XAN_DPCM,
547 AV_CODEC_ID_SOL_DPCM,
549 AV_CODEC_ID_SDX2_DPCM = 0x14800,
552 AV_CODEC_ID_MP2 = 0x15000,
553 AV_CODEC_ID_MP3, ///< preferred ID for decoding MPEG audio layer 1, 2 or 3
563 AV_CODEC_ID_VMDAUDIO,
569 AV_CODEC_ID_WESTWOOD_SND1,
570 AV_CODEC_ID_GSM, ///< as in Berlin toast format
573 AV_CODEC_ID_TRUESPEECH,
575 AV_CODEC_ID_SMACKAUDIO,
578 AV_CODEC_ID_DSICINAUDIO,
580 AV_CODEC_ID_MUSEPACK7,
582 AV_CODEC_ID_GSM_MS, /* as found in WAV */
588 AV_CODEC_ID_NELLYMOSER,
589 AV_CODEC_ID_MUSEPACK8,
591 AV_CODEC_ID_WMAVOICE,
593 AV_CODEC_ID_WMALOSSLESS,
602 AV_CODEC_ID_BINKAUDIO_RDFT,
603 AV_CODEC_ID_BINKAUDIO_DCT,
604 AV_CODEC_ID_AAC_LATM,
609 AV_CODEC_ID_8SVX_EXP,
610 AV_CODEC_ID_8SVX_FIB,
611 AV_CODEC_ID_BMV_AUDIO,
616 AV_CODEC_ID_COMFORT_NOISE,
618 AV_CODEC_ID_METASOUND,
619 AV_CODEC_ID_PAF_AUDIO,
623 AV_CODEC_ID_FFWAVESYNTH = 0x15800,
625 AV_CODEC_ID_SONIC_LS,
628 AV_CODEC_ID_DSD_LSBF,
629 AV_CODEC_ID_DSD_MSBF,
630 AV_CODEC_ID_DSD_LSBF_PLANAR,
631 AV_CODEC_ID_DSD_MSBF_PLANAR,
633 AV_CODEC_ID_INTERPLAY_ACM,
637 AV_CODEC_ID_ATRAC3AL,
638 AV_CODEC_ID_ATRAC3PAL,
640 /* subtitle codecs */
641 AV_CODEC_ID_FIRST_SUBTITLE = 0x17000, ///< A dummy ID pointing at the start of subtitle codecs.
642 AV_CODEC_ID_DVD_SUBTITLE = 0x17000,
643 AV_CODEC_ID_DVB_SUBTITLE,
644 AV_CODEC_ID_TEXT, ///< raw UTF-8 text
647 AV_CODEC_ID_MOV_TEXT,
648 AV_CODEC_ID_HDMV_PGS_SUBTITLE,
649 AV_CODEC_ID_DVB_TELETEXT,
652 AV_CODEC_ID_MICRODVD = 0x17800,
656 AV_CODEC_ID_REALTEXT,
658 AV_CODEC_ID_SUBVIEWER1,
659 AV_CODEC_ID_SUBVIEWER,
666 AV_CODEC_ID_HDMV_TEXT_SUBTITLE,
668 /* other specific kind of codecs (generally used for attachments) */
669 AV_CODEC_ID_FIRST_UNKNOWN = 0x18000, ///< A dummy ID pointing at the start of various fake codecs.
670 AV_CODEC_ID_TTF = 0x18000,
672 AV_CODEC_ID_SCTE_35, ///< Contain timestamp estimated through PCR of program stream.
673 AV_CODEC_ID_BINTEXT = 0x18800,
677 AV_CODEC_ID_SMPTE_KLV,
679 AV_CODEC_ID_TIMED_ID3,
680 AV_CODEC_ID_BIN_DATA,
683 AV_CODEC_ID_PROBE = 0x19000, ///< codec_id is not known (like AV_CODEC_ID_NONE) but lavf should attempt to identify it
685 AV_CODEC_ID_MPEG2TS = 0x20000, /**< _FAKE_ codec to indicate a raw MPEG-2 TS
686 * stream (only used by libavformat) */
687 AV_CODEC_ID_MPEG4SYSTEMS = 0x20001, /**< _FAKE_ codec to indicate a MPEG-4 Systems
688 * stream (only used by libavformat) */
689 AV_CODEC_ID_FFMETADATA = 0x21000, ///< Dummy codec for streams containing only metadata information.
690 AV_CODEC_ID_WRAPPED_AVFRAME = 0x21001, ///< Passthrough codec, AVFrames wrapped in AVPacket
694 * This struct describes the properties of a single codec described by an
696 * @see avcodec_descriptor_get()
698 typedef struct AVCodecDescriptor {
700 enum AVMediaType type;
702 * Name of the codec described by this descriptor. It is non-empty and
703 * unique for each codec descriptor. It should contain alphanumeric
704 * characters and '_' only.
708 * A more descriptive name for this codec. May be NULL.
710 const char *long_name;
712 * Codec properties, a combination of AV_CODEC_PROP_* flags.
716 * MIME type(s) associated with the codec.
717 * May be NULL; if not, a NULL-terminated array of MIME types.
718 * The first item is always non-NULL and is the preferred MIME type.
720 const char *const *mime_types;
722 * If non-NULL, an array of profiles recognized for this codec.
723 * Terminated with FF_PROFILE_UNKNOWN.
725 const struct AVProfile *profiles;
729 * Codec uses only intra compression.
730 * Video and audio codecs only.
732 #define AV_CODEC_PROP_INTRA_ONLY (1 << 0)
734 * Codec supports lossy compression. Audio and video codecs only.
735 * @note a codec may support both lossy and lossless
738 #define AV_CODEC_PROP_LOSSY (1 << 1)
740 * Codec supports lossless compression. Audio and video codecs only.
742 #define AV_CODEC_PROP_LOSSLESS (1 << 2)
744 * Codec supports frame reordering. That is, the coded order (the order in which
745 * the encoded packets are output by the encoders / stored / input to the
746 * decoders) may be different from the presentation order of the corresponding
749 * For codecs that do not have this property set, PTS and DTS should always be
752 #define AV_CODEC_PROP_REORDER (1 << 3)
754 * Subtitle codec is bitmap based
755 * Decoded AVSubtitle data can be read from the AVSubtitleRect->pict field.
757 #define AV_CODEC_PROP_BITMAP_SUB (1 << 16)
759 * Subtitle codec is text based.
760 * Decoded AVSubtitle data can be read from the AVSubtitleRect->ass field.
762 #define AV_CODEC_PROP_TEXT_SUB (1 << 17)
765 * @ingroup lavc_decoding
766 * Required number of additionally allocated bytes at the end of the input bitstream for decoding.
767 * This is mainly needed because some optimized bitstream readers read
768 * 32 or 64 bit at once and could read over the end.<br>
769 * Note: If the first 23 bits of the additional bytes are not 0, then damaged
770 * MPEG bitstreams could cause overread and segfault.
772 #define AV_INPUT_BUFFER_PADDING_SIZE 32
775 * @ingroup lavc_encoding
776 * minimum encoding buffer size
777 * Used to avoid some checks during header writing.
779 #define AV_INPUT_BUFFER_MIN_SIZE 16384
781 #if FF_API_WITHOUT_PREFIX
783 * @deprecated use AV_INPUT_BUFFER_PADDING_SIZE instead
785 #define FF_INPUT_BUFFER_PADDING_SIZE 32
788 * @deprecated use AV_INPUT_BUFFER_MIN_SIZE instead
790 #define FF_MIN_BUFFER_SIZE 16384
791 #endif /* FF_API_WITHOUT_PREFIX */
794 * @ingroup lavc_encoding
795 * motion estimation type.
796 * @deprecated use codec private option instead
798 #if FF_API_MOTION_EST
800 ME_ZERO = 1, ///< no search, that is use 0,0 vector whenever one is needed
804 ME_EPZS, ///< enhanced predictive zonal search
805 ME_X1, ///< reserved for experiments
806 ME_HEX, ///< hexagon based search
807 ME_UMH, ///< uneven multi-hexagon search
808 ME_TESA, ///< transformed exhaustive search algorithm
809 ME_ITER=50, ///< iterative search
814 * @ingroup lavc_decoding
817 /* We leave some space between them for extensions (drop some
818 * keyframes for intra-only or drop just some bidir frames). */
819 AVDISCARD_NONE =-16, ///< discard nothing
820 AVDISCARD_DEFAULT = 0, ///< discard useless packets like 0 size packets in avi
821 AVDISCARD_NONREF = 8, ///< discard all non reference
822 AVDISCARD_BIDIR = 16, ///< discard all bidirectional frames
823 AVDISCARD_NONINTRA= 24, ///< discard all non intra frames
824 AVDISCARD_NONKEY = 32, ///< discard all frames except keyframes
825 AVDISCARD_ALL = 48, ///< discard all
828 enum AVAudioServiceType {
829 AV_AUDIO_SERVICE_TYPE_MAIN = 0,
830 AV_AUDIO_SERVICE_TYPE_EFFECTS = 1,
831 AV_AUDIO_SERVICE_TYPE_VISUALLY_IMPAIRED = 2,
832 AV_AUDIO_SERVICE_TYPE_HEARING_IMPAIRED = 3,
833 AV_AUDIO_SERVICE_TYPE_DIALOGUE = 4,
834 AV_AUDIO_SERVICE_TYPE_COMMENTARY = 5,
835 AV_AUDIO_SERVICE_TYPE_EMERGENCY = 6,
836 AV_AUDIO_SERVICE_TYPE_VOICE_OVER = 7,
837 AV_AUDIO_SERVICE_TYPE_KARAOKE = 8,
838 AV_AUDIO_SERVICE_TYPE_NB , ///< Not part of ABI
842 * @ingroup lavc_encoding
844 typedef struct RcOverride{
847 int qscale; // If this is 0 then quality_factor will be used instead.
848 float quality_factor;
851 #if FF_API_MAX_BFRAMES
853 * @deprecated there is no libavcodec-wide limit on the number of B-frames
855 #define FF_MAX_B_FRAMES 16
859 These flags can be passed in AVCodecContext.flags before initialization.
860 Note: Not everything is supported yet.
864 * Allow decoders to produce frames with data planes that are not aligned
865 * to CPU requirements (e.g. due to cropping).
867 #define AV_CODEC_FLAG_UNALIGNED (1 << 0)
871 #define AV_CODEC_FLAG_QSCALE (1 << 1)
873 * 4 MV per MB allowed / advanced prediction for H.263.
875 #define AV_CODEC_FLAG_4MV (1 << 2)
877 * Output even those frames that might be corrupted.
879 #define AV_CODEC_FLAG_OUTPUT_CORRUPT (1 << 3)
883 #define AV_CODEC_FLAG_QPEL (1 << 4)
885 * Use internal 2pass ratecontrol in first pass mode.
887 #define AV_CODEC_FLAG_PASS1 (1 << 9)
889 * Use internal 2pass ratecontrol in second pass mode.
891 #define AV_CODEC_FLAG_PASS2 (1 << 10)
895 #define AV_CODEC_FLAG_LOOP_FILTER (1 << 11)
897 * Only decode/encode grayscale.
899 #define AV_CODEC_FLAG_GRAY (1 << 13)
901 * error[?] variables will be set during encoding.
903 #define AV_CODEC_FLAG_PSNR (1 << 15)
905 * Input bitstream might be truncated at a random location
906 * instead of only at frame boundaries.
908 #define AV_CODEC_FLAG_TRUNCATED (1 << 16)
910 * Use interlaced DCT.
912 #define AV_CODEC_FLAG_INTERLACED_DCT (1 << 18)
916 #define AV_CODEC_FLAG_LOW_DELAY (1 << 19)
918 * Place global headers in extradata instead of every keyframe.
920 #define AV_CODEC_FLAG_GLOBAL_HEADER (1 << 22)
922 * Use only bitexact stuff (except (I)DCT).
924 #define AV_CODEC_FLAG_BITEXACT (1 << 23)
925 /* Fx : Flag for H.263+ extra options */
927 * H.263 advanced intra coding / MPEG-4 AC prediction
929 #define AV_CODEC_FLAG_AC_PRED (1 << 24)
931 * interlaced motion estimation
933 #define AV_CODEC_FLAG_INTERLACED_ME (1 << 29)
934 #define AV_CODEC_FLAG_CLOSED_GOP (1U << 31)
937 * Allow non spec compliant speedup tricks.
939 #define AV_CODEC_FLAG2_FAST (1 << 0)
941 * Skip bitstream encoding.
943 #define AV_CODEC_FLAG2_NO_OUTPUT (1 << 2)
945 * Place global headers at every keyframe instead of in extradata.
947 #define AV_CODEC_FLAG2_LOCAL_HEADER (1 << 3)
950 * timecode is in drop frame format. DEPRECATED!!!!
952 #define AV_CODEC_FLAG2_DROP_FRAME_TIMECODE (1 << 13)
955 * Input bitstream might be truncated at a packet boundaries
956 * instead of only at frame boundaries.
958 #define AV_CODEC_FLAG2_CHUNKS (1 << 15)
960 * Discard cropping information from SPS.
962 #define AV_CODEC_FLAG2_IGNORE_CROP (1 << 16)
965 * Show all frames before the first keyframe
967 #define AV_CODEC_FLAG2_SHOW_ALL (1 << 22)
969 * Export motion vectors through frame side data
971 #define AV_CODEC_FLAG2_EXPORT_MVS (1 << 28)
973 * Do not skip samples and export skip information as frame side data
975 #define AV_CODEC_FLAG2_SKIP_MANUAL (1 << 29)
977 * Do not reset ASS ReadOrder field on flush (subtitles decoding)
979 #define AV_CODEC_FLAG2_RO_FLUSH_NOOP (1 << 30)
981 /* Unsupported options :
982 * Syntax Arithmetic coding (SAC)
983 * Reference Picture Selection
984 * Independent Segment Decoding */
986 /* codec capabilities */
989 * Decoder can use draw_horiz_band callback.
991 #define AV_CODEC_CAP_DRAW_HORIZ_BAND (1 << 0)
993 * Codec uses get_buffer() for allocating buffers and supports custom allocators.
994 * If not set, it might not use get_buffer() at all or use operations that
995 * assume the buffer was allocated by avcodec_default_get_buffer.
997 #define AV_CODEC_CAP_DR1 (1 << 1)
998 #define AV_CODEC_CAP_TRUNCATED (1 << 3)
1000 * Encoder or decoder requires flushing with NULL input at the end in order to
1001 * give the complete and correct output.
1003 * NOTE: If this flag is not set, the codec is guaranteed to never be fed with
1004 * with NULL data. The user can still send NULL data to the public encode
1005 * or decode function, but libavcodec will not pass it along to the codec
1006 * unless this flag is set.
1009 * The decoder has a non-zero delay and needs to be fed with avpkt->data=NULL,
1010 * avpkt->size=0 at the end to get the delayed data until the decoder no longer
1014 * The encoder needs to be fed with NULL data at the end of encoding until the
1015 * encoder no longer returns data.
1017 * NOTE: For encoders implementing the AVCodec.encode2() function, setting this
1018 * flag also means that the encoder must set the pts and duration for
1019 * each output packet. If this flag is not set, the pts and duration will
1020 * be determined by libavcodec from the input frame.
1022 #define AV_CODEC_CAP_DELAY (1 << 5)
1024 * Codec can be fed a final frame with a smaller size.
1025 * This can be used to prevent truncation of the last audio samples.
1027 #define AV_CODEC_CAP_SMALL_LAST_FRAME (1 << 6)
1029 #if FF_API_CAP_VDPAU
1031 * Codec can export data for HW decoding (VDPAU).
1033 #define AV_CODEC_CAP_HWACCEL_VDPAU (1 << 7)
1037 * Codec can output multiple frames per AVPacket
1038 * Normally demuxers return one frame at a time, demuxers which do not do
1039 * are connected to a parser to split what they return into proper frames.
1040 * This flag is reserved to the very rare category of codecs which have a
1041 * bitstream that cannot be split into frames without timeconsuming
1042 * operations like full decoding. Demuxers carrying such bitstreams thus
1043 * may return multiple frames in a packet. This has many disadvantages like
1044 * prohibiting stream copy in many cases thus it should only be considered
1047 #define AV_CODEC_CAP_SUBFRAMES (1 << 8)
1049 * Codec is experimental and is thus avoided in favor of non experimental
1052 #define AV_CODEC_CAP_EXPERIMENTAL (1 << 9)
1054 * Codec should fill in channel configuration and samplerate instead of container
1056 #define AV_CODEC_CAP_CHANNEL_CONF (1 << 10)
1058 * Codec supports frame-level multithreading.
1060 #define AV_CODEC_CAP_FRAME_THREADS (1 << 12)
1062 * Codec supports slice-based (or partition-based) multithreading.
1064 #define AV_CODEC_CAP_SLICE_THREADS (1 << 13)
1066 * Codec supports changed parameters at any point.
1068 #define AV_CODEC_CAP_PARAM_CHANGE (1 << 14)
1070 * Codec supports avctx->thread_count == 0 (auto).
1072 #define AV_CODEC_CAP_AUTO_THREADS (1 << 15)
1074 * Audio encoder supports receiving a different number of samples in each call.
1076 #define AV_CODEC_CAP_VARIABLE_FRAME_SIZE (1 << 16)
1078 * Decoder is not a preferred choice for probing.
1079 * This indicates that the decoder is not a good choice for probing.
1080 * It could for example be an expensive to spin up hardware decoder,
1081 * or it could simply not provide a lot of useful information about
1083 * A decoder marked with this flag should only be used as last resort
1084 * choice for probing.
1086 #define AV_CODEC_CAP_AVOID_PROBING (1 << 17)
1088 * Codec is intra only.
1090 #define AV_CODEC_CAP_INTRA_ONLY 0x40000000
1092 * Codec is lossless.
1094 #define AV_CODEC_CAP_LOSSLESS 0x80000000
1097 #if FF_API_WITHOUT_PREFIX
1099 * Allow decoders to produce frames with data planes that are not aligned
1100 * to CPU requirements (e.g. due to cropping).
1102 #define CODEC_FLAG_UNALIGNED AV_CODEC_FLAG_UNALIGNED
1103 #define CODEC_FLAG_QSCALE AV_CODEC_FLAG_QSCALE
1104 #define CODEC_FLAG_4MV AV_CODEC_FLAG_4MV
1105 #define CODEC_FLAG_OUTPUT_CORRUPT AV_CODEC_FLAG_OUTPUT_CORRUPT
1106 #define CODEC_FLAG_QPEL AV_CODEC_FLAG_QPEL
1109 * @deprecated use the "gmc" private option of the libxvid encoder
1111 #define CODEC_FLAG_GMC 0x0020 ///< Use GMC.
1115 * @deprecated use the flag "mv0" in the "mpv_flags" private option of the
1116 * mpegvideo encoders
1118 #define CODEC_FLAG_MV0 0x0040
1120 #if FF_API_INPUT_PRESERVED
1122 * @deprecated passing reference-counted frames to the encoders replaces this
1125 #define CODEC_FLAG_INPUT_PRESERVED 0x0100
1127 #define CODEC_FLAG_PASS1 AV_CODEC_FLAG_PASS1
1128 #define CODEC_FLAG_PASS2 AV_CODEC_FLAG_PASS2
1129 #define CODEC_FLAG_GRAY AV_CODEC_FLAG_GRAY
1132 * @deprecated edges are not used/required anymore. I.e. this flag is now always
1135 #define CODEC_FLAG_EMU_EDGE 0x4000
1137 #define CODEC_FLAG_PSNR AV_CODEC_FLAG_PSNR
1138 #define CODEC_FLAG_TRUNCATED AV_CODEC_FLAG_TRUNCATED
1140 #if FF_API_NORMALIZE_AQP
1142 * @deprecated use the flag "naq" in the "mpv_flags" private option of the
1143 * mpegvideo encoders
1145 #define CODEC_FLAG_NORMALIZE_AQP 0x00020000
1147 #define CODEC_FLAG_INTERLACED_DCT AV_CODEC_FLAG_INTERLACED_DCT
1148 #define CODEC_FLAG_LOW_DELAY AV_CODEC_FLAG_LOW_DELAY
1149 #define CODEC_FLAG_GLOBAL_HEADER AV_CODEC_FLAG_GLOBAL_HEADER
1150 #define CODEC_FLAG_BITEXACT AV_CODEC_FLAG_BITEXACT
1151 #define CODEC_FLAG_AC_PRED AV_CODEC_FLAG_AC_PRED
1152 #define CODEC_FLAG_LOOP_FILTER AV_CODEC_FLAG_LOOP_FILTER
1153 #define CODEC_FLAG_INTERLACED_ME AV_CODEC_FLAG_INTERLACED_ME
1154 #define CODEC_FLAG_CLOSED_GOP AV_CODEC_FLAG_CLOSED_GOP
1155 #define CODEC_FLAG2_FAST AV_CODEC_FLAG2_FAST
1156 #define CODEC_FLAG2_NO_OUTPUT AV_CODEC_FLAG2_NO_OUTPUT
1157 #define CODEC_FLAG2_LOCAL_HEADER AV_CODEC_FLAG2_LOCAL_HEADER
1158 #define CODEC_FLAG2_DROP_FRAME_TIMECODE AV_CODEC_FLAG2_DROP_FRAME_TIMECODE
1159 #define CODEC_FLAG2_IGNORE_CROP AV_CODEC_FLAG2_IGNORE_CROP
1161 #define CODEC_FLAG2_CHUNKS AV_CODEC_FLAG2_CHUNKS
1162 #define CODEC_FLAG2_SHOW_ALL AV_CODEC_FLAG2_SHOW_ALL
1163 #define CODEC_FLAG2_EXPORT_MVS AV_CODEC_FLAG2_EXPORT_MVS
1164 #define CODEC_FLAG2_SKIP_MANUAL AV_CODEC_FLAG2_SKIP_MANUAL
1166 /* Unsupported options :
1167 * Syntax Arithmetic coding (SAC)
1168 * Reference Picture Selection
1169 * Independent Segment Decoding */
1171 /* codec capabilities */
1173 #define CODEC_CAP_DRAW_HORIZ_BAND AV_CODEC_CAP_DRAW_HORIZ_BAND ///< Decoder can use draw_horiz_band callback.
1175 * Codec uses get_buffer() for allocating buffers and supports custom allocators.
1176 * If not set, it might not use get_buffer() at all or use operations that
1177 * assume the buffer was allocated by avcodec_default_get_buffer.
1179 #define CODEC_CAP_DR1 AV_CODEC_CAP_DR1
1180 #define CODEC_CAP_TRUNCATED AV_CODEC_CAP_TRUNCATED
1182 /* Codec can export data for HW decoding. This flag indicates that
1183 * the codec would call get_format() with list that might contain HW accelerated
1184 * pixel formats (XvMC, VDPAU, VAAPI, etc). The application can pick any of them
1185 * including raw image format.
1186 * The application can use the passed context to determine bitstream version,
1187 * chroma format, resolution etc.
1189 #define CODEC_CAP_HWACCEL 0x0010
1190 #endif /* FF_API_XVMC */
1192 * Encoder or decoder requires flushing with NULL input at the end in order to
1193 * give the complete and correct output.
1195 * NOTE: If this flag is not set, the codec is guaranteed to never be fed with
1196 * with NULL data. The user can still send NULL data to the public encode
1197 * or decode function, but libavcodec will not pass it along to the codec
1198 * unless this flag is set.
1201 * The decoder has a non-zero delay and needs to be fed with avpkt->data=NULL,
1202 * avpkt->size=0 at the end to get the delayed data until the decoder no longer
1206 * The encoder needs to be fed with NULL data at the end of encoding until the
1207 * encoder no longer returns data.
1209 * NOTE: For encoders implementing the AVCodec.encode2() function, setting this
1210 * flag also means that the encoder must set the pts and duration for
1211 * each output packet. If this flag is not set, the pts and duration will
1212 * be determined by libavcodec from the input frame.
1214 #define CODEC_CAP_DELAY AV_CODEC_CAP_DELAY
1216 * Codec can be fed a final frame with a smaller size.
1217 * This can be used to prevent truncation of the last audio samples.
1219 #define CODEC_CAP_SMALL_LAST_FRAME AV_CODEC_CAP_SMALL_LAST_FRAME
1220 #if FF_API_CAP_VDPAU
1222 * Codec can export data for HW decoding (VDPAU).
1224 #define CODEC_CAP_HWACCEL_VDPAU AV_CODEC_CAP_HWACCEL_VDPAU
1227 * Codec can output multiple frames per AVPacket
1228 * Normally demuxers return one frame at a time, demuxers which do not do
1229 * are connected to a parser to split what they return into proper frames.
1230 * This flag is reserved to the very rare category of codecs which have a
1231 * bitstream that cannot be split into frames without timeconsuming
1232 * operations like full decoding. Demuxers carrying such bitstreams thus
1233 * may return multiple frames in a packet. This has many disadvantages like
1234 * prohibiting stream copy in many cases thus it should only be considered
1237 #define CODEC_CAP_SUBFRAMES AV_CODEC_CAP_SUBFRAMES
1239 * Codec is experimental and is thus avoided in favor of non experimental
1242 #define CODEC_CAP_EXPERIMENTAL AV_CODEC_CAP_EXPERIMENTAL
1244 * Codec should fill in channel configuration and samplerate instead of container
1246 #define CODEC_CAP_CHANNEL_CONF AV_CODEC_CAP_CHANNEL_CONF
1247 #if FF_API_NEG_LINESIZES
1249 * @deprecated no codecs use this capability
1251 #define CODEC_CAP_NEG_LINESIZES 0x0800
1254 * Codec supports frame-level multithreading.
1256 #define CODEC_CAP_FRAME_THREADS AV_CODEC_CAP_FRAME_THREADS
1258 * Codec supports slice-based (or partition-based) multithreading.
1260 #define CODEC_CAP_SLICE_THREADS AV_CODEC_CAP_SLICE_THREADS
1262 * Codec supports changed parameters at any point.
1264 #define CODEC_CAP_PARAM_CHANGE AV_CODEC_CAP_PARAM_CHANGE
1266 * Codec supports avctx->thread_count == 0 (auto).
1268 #define CODEC_CAP_AUTO_THREADS AV_CODEC_CAP_AUTO_THREADS
1270 * Audio encoder supports receiving a different number of samples in each call.
1272 #define CODEC_CAP_VARIABLE_FRAME_SIZE AV_CODEC_CAP_VARIABLE_FRAME_SIZE
1274 * Codec is intra only.
1276 #define CODEC_CAP_INTRA_ONLY AV_CODEC_CAP_INTRA_ONLY
1278 * Codec is lossless.
1280 #define CODEC_CAP_LOSSLESS AV_CODEC_CAP_LOSSLESS
1283 * HWAccel is experimental and is thus avoided in favor of non experimental
1286 #define HWACCEL_CODEC_CAP_EXPERIMENTAL 0x0200
1287 #endif /* FF_API_WITHOUT_PREFIX */
1290 //The following defines may change, don't expect compatibility if you use them.
1291 #define MB_TYPE_INTRA4x4 0x0001
1292 #define MB_TYPE_INTRA16x16 0x0002 //FIXME H.264-specific
1293 #define MB_TYPE_INTRA_PCM 0x0004 //FIXME H.264-specific
1294 #define MB_TYPE_16x16 0x0008
1295 #define MB_TYPE_16x8 0x0010
1296 #define MB_TYPE_8x16 0x0020
1297 #define MB_TYPE_8x8 0x0040
1298 #define MB_TYPE_INTERLACED 0x0080
1299 #define MB_TYPE_DIRECT2 0x0100 //FIXME
1300 #define MB_TYPE_ACPRED 0x0200
1301 #define MB_TYPE_GMC 0x0400
1302 #define MB_TYPE_SKIP 0x0800
1303 #define MB_TYPE_P0L0 0x1000
1304 #define MB_TYPE_P1L0 0x2000
1305 #define MB_TYPE_P0L1 0x4000
1306 #define MB_TYPE_P1L1 0x8000
1307 #define MB_TYPE_L0 (MB_TYPE_P0L0 | MB_TYPE_P1L0)
1308 #define MB_TYPE_L1 (MB_TYPE_P0L1 | MB_TYPE_P1L1)
1309 #define MB_TYPE_L0L1 (MB_TYPE_L0 | MB_TYPE_L1)
1310 #define MB_TYPE_QUANT 0x00010000
1311 #define MB_TYPE_CBP 0x00020000
1312 // Note bits 24-31 are reserved for codec specific use (H.264 ref0, MPEG-1 0mv, ...)
1317 * This specifies the area which should be displayed.
1318 * Note there may be multiple such areas for one frame.
1320 typedef struct AVPanScan{
1323 * - encoding: Set by user.
1324 * - decoding: Set by libavcodec.
1329 * width and height in 1/16 pel
1330 * - encoding: Set by user.
1331 * - decoding: Set by libavcodec.
1337 * position of the top left corner in 1/16 pel for up to 3 fields/frames
1338 * - encoding: Set by user.
1339 * - decoding: Set by libavcodec.
1341 int16_t position[3][2];
1345 * This structure describes the bitrate properties of an encoded bitstream. It
1346 * roughly corresponds to a subset the VBV parameters for MPEG-2 or HRD
1347 * parameters for H.264/HEVC.
1349 typedef struct AVCPBProperties {
1351 * Maximum bitrate of the stream, in bits per second.
1352 * Zero if unknown or unspecified.
1356 * Minimum bitrate of the stream, in bits per second.
1357 * Zero if unknown or unspecified.
1361 * Average bitrate of the stream, in bits per second.
1362 * Zero if unknown or unspecified.
1367 * The size of the buffer to which the ratecontrol is applied, in bits.
1368 * Zero if unknown or unspecified.
1373 * The delay between the time the packet this structure is associated with
1374 * is received and the time when it should be decoded, in periods of a 27MHz
1377 * UINT64_MAX when unknown or unspecified.
1382 #if FF_API_QSCALE_TYPE
1383 #define FF_QSCALE_TYPE_MPEG1 0
1384 #define FF_QSCALE_TYPE_MPEG2 1
1385 #define FF_QSCALE_TYPE_H264 2
1386 #define FF_QSCALE_TYPE_VP56 3
1390 * The decoder will keep a reference to the frame and may reuse it later.
1392 #define AV_GET_BUFFER_FLAG_REF (1 << 0)
1395 * @defgroup lavc_packet AVPacket
1397 * Types and functions for working with AVPacket.
1400 enum AVPacketSideDataType {
1402 * An AV_PKT_DATA_PALETTE side data packet contains exactly AVPALETTE_SIZE
1403 * bytes worth of palette. This side data signals that a new palette is
1406 AV_PKT_DATA_PALETTE,
1409 * The AV_PKT_DATA_NEW_EXTRADATA is used to notify the codec or the format
1410 * that the extradata buffer was changed and the receiving side should
1411 * act upon it appropriately. The new extradata is embedded in the side
1412 * data buffer and should be immediately used for processing the current
1415 AV_PKT_DATA_NEW_EXTRADATA,
1418 * An AV_PKT_DATA_PARAM_CHANGE side data packet is laid out as follows:
1421 * if (param_flags & AV_SIDE_DATA_PARAM_CHANGE_CHANNEL_COUNT)
1422 * s32le channel_count
1423 * if (param_flags & AV_SIDE_DATA_PARAM_CHANGE_CHANNEL_LAYOUT)
1424 * u64le channel_layout
1425 * if (param_flags & AV_SIDE_DATA_PARAM_CHANGE_SAMPLE_RATE)
1427 * if (param_flags & AV_SIDE_DATA_PARAM_CHANGE_DIMENSIONS)
1432 AV_PKT_DATA_PARAM_CHANGE,
1435 * An AV_PKT_DATA_H263_MB_INFO side data packet contains a number of
1436 * structures with info about macroblocks relevant to splitting the
1437 * packet into smaller packets on macroblock edges (e.g. as for RFC 2190).
1438 * That is, it does not necessarily contain info about all macroblocks,
1439 * as long as the distance between macroblocks in the info is smaller
1440 * than the target payload size.
1441 * Each MB info structure is 12 bytes, and is laid out as follows:
1443 * u32le bit offset from the start of the packet
1444 * u8 current quantizer at the start of the macroblock
1446 * u16le macroblock address within the GOB
1447 * u8 horizontal MV predictor
1448 * u8 vertical MV predictor
1449 * u8 horizontal MV predictor for block number 3
1450 * u8 vertical MV predictor for block number 3
1453 AV_PKT_DATA_H263_MB_INFO,
1456 * This side data should be associated with an audio stream and contains
1457 * ReplayGain information in form of the AVReplayGain struct.
1459 AV_PKT_DATA_REPLAYGAIN,
1462 * This side data contains a 3x3 transformation matrix describing an affine
1463 * transformation that needs to be applied to the decoded video frames for
1464 * correct presentation.
1466 * See libavutil/display.h for a detailed description of the data.
1468 AV_PKT_DATA_DISPLAYMATRIX,
1471 * This side data should be associated with a video stream and contains
1472 * Stereoscopic 3D information in form of the AVStereo3D struct.
1474 AV_PKT_DATA_STEREO3D,
1477 * This side data should be associated with an audio stream and corresponds
1478 * to enum AVAudioServiceType.
1480 AV_PKT_DATA_AUDIO_SERVICE_TYPE,
1483 * This side data contains quality related information from the encoder.
1485 * u32le quality factor of the compressed frame. Allowed range is between 1 (good) and FF_LAMBDA_MAX (bad).
1489 * u64le[error count] sum of squared differences between encoder in and output
1492 AV_PKT_DATA_QUALITY_STATS,
1495 * This side data contains an integer value representing the stream index
1496 * of a "fallback" track. A fallback track indicates an alternate
1497 * track to use when the current track can not be decoded for some reason.
1498 * e.g. no decoder available for codec.
1500 AV_PKT_DATA_FALLBACK_TRACK,
1503 * This side data corresponds to the AVCPBProperties struct.
1505 AV_PKT_DATA_CPB_PROPERTIES,
1508 * Recommmends skipping the specified number of samples
1510 * u32le number of samples to skip from start of this packet
1511 * u32le number of samples to skip from end of this packet
1512 * u8 reason for start skip
1513 * u8 reason for end skip (0=padding silence, 1=convergence)
1516 AV_PKT_DATA_SKIP_SAMPLES=70,
1519 * An AV_PKT_DATA_JP_DUALMONO side data packet indicates that
1520 * the packet may contain "dual mono" audio specific to Japanese DTV
1521 * and if it is true, recommends only the selected channel to be used.
1523 * u8 selected channels (0=mail/left, 1=sub/right, 2=both)
1526 AV_PKT_DATA_JP_DUALMONO,
1529 * A list of zero terminated key/value strings. There is no end marker for
1530 * the list, so it is required to rely on the side data size to stop.
1532 AV_PKT_DATA_STRINGS_METADATA,
1535 * Subtitle event position
1543 AV_PKT_DATA_SUBTITLE_POSITION,
1546 * Data found in BlockAdditional element of matroska container. There is
1547 * no end marker for the data, so it is required to rely on the side data
1548 * size to recognize the end. 8 byte id (as found in BlockAddId) followed
1551 AV_PKT_DATA_MATROSKA_BLOCKADDITIONAL,
1554 * The optional first identifier line of a WebVTT cue.
1556 AV_PKT_DATA_WEBVTT_IDENTIFIER,
1559 * The optional settings (rendering instructions) that immediately
1560 * follow the timestamp specifier of a WebVTT cue.
1562 AV_PKT_DATA_WEBVTT_SETTINGS,
1565 * A list of zero terminated key/value strings. There is no end marker for
1566 * the list, so it is required to rely on the side data size to stop. This
1567 * side data includes updated metadata which appeared in the stream.
1569 AV_PKT_DATA_METADATA_UPDATE,
1572 * MPEGTS stream ID, this is required to pass the stream ID
1573 * information from the demuxer to the corresponding muxer.
1575 AV_PKT_DATA_MPEGTS_STREAM_ID,
1578 * Mastering display metadata (based on SMPTE-2086:2014). This metadata
1579 * should be associated with a video stream and contains data in the form
1580 * of the AVMasteringDisplayMetadata struct.
1582 AV_PKT_DATA_MASTERING_DISPLAY_METADATA,
1585 * This side data should be associated with a video stream and corresponds
1586 * to the AVSphericalMapping structure.
1588 AV_PKT_DATA_SPHERICAL,
1591 * Content light level (based on CTA-861.3). This metadata should be
1592 * associated with a video stream and contains data in the form of the
1593 * AVContentLightMetadata struct.
1595 AV_PKT_DATA_CONTENT_LIGHT_LEVEL,
1598 * The number of side data elements (in fact a bit more than it).
1599 * This is not part of the public API/ABI in the sense that it may
1600 * change when new side data types are added.
1601 * This must stay the last enum value.
1602 * If its value becomes huge, some code using it
1603 * needs to be updated as it assumes it to be smaller than other limits.
1608 #define AV_PKT_DATA_QUALITY_FACTOR AV_PKT_DATA_QUALITY_STATS //DEPRECATED
1610 typedef struct AVPacketSideData {
1613 enum AVPacketSideDataType type;
1617 * This structure stores compressed data. It is typically exported by demuxers
1618 * and then passed as input to decoders, or received as output from encoders and
1619 * then passed to muxers.
1621 * For video, it should typically contain one compressed frame. For audio it may
1622 * contain several compressed frames. Encoders are allowed to output empty
1623 * packets, with no compressed data, containing only side data
1624 * (e.g. to update some stream parameters at the end of encoding).
1626 * AVPacket is one of the few structs in FFmpeg, whose size is a part of public
1627 * ABI. Thus it may be allocated on stack and no new fields can be added to it
1628 * without libavcodec and libavformat major bump.
1630 * The semantics of data ownership depends on the buf field.
1631 * If it is set, the packet data is dynamically allocated and is
1632 * valid indefinitely until a call to av_packet_unref() reduces the
1633 * reference count to 0.
1635 * If the buf field is not set av_packet_ref() would make a copy instead
1636 * of increasing the reference count.
1638 * The side data is always allocated with av_malloc(), copied by
1639 * av_packet_ref() and freed by av_packet_unref().
1641 * @see av_packet_ref
1642 * @see av_packet_unref
1644 typedef struct AVPacket {
1646 * A reference to the reference-counted buffer where the packet data is
1648 * May be NULL, then the packet data is not reference-counted.
1652 * Presentation timestamp in AVStream->time_base units; the time at which
1653 * the decompressed packet will be presented to the user.
1654 * Can be AV_NOPTS_VALUE if it is not stored in the file.
1655 * pts MUST be larger or equal to dts as presentation cannot happen before
1656 * decompression, unless one wants to view hex dumps. Some formats misuse
1657 * the terms dts and pts/cts to mean something different. Such timestamps
1658 * must be converted to true pts/dts before they are stored in AVPacket.
1662 * Decompression timestamp in AVStream->time_base units; the time at which
1663 * the packet is decompressed.
1664 * Can be AV_NOPTS_VALUE if it is not stored in the file.
1671 * A combination of AV_PKT_FLAG values
1675 * Additional packet data that can be provided by the container.
1676 * Packet can contain several types of side information.
1678 AVPacketSideData *side_data;
1679 int side_data_elems;
1682 * Duration of this packet in AVStream->time_base units, 0 if unknown.
1683 * Equals next_pts - this_pts in presentation order.
1687 int64_t pos; ///< byte position in stream, -1 if unknown
1689 #if FF_API_CONVERGENCE_DURATION
1691 * @deprecated Same as the duration field, but as int64_t. This was required
1692 * for Matroska subtitles, whose duration values could overflow when the
1693 * duration field was still an int.
1695 attribute_deprecated
1696 int64_t convergence_duration;
1699 #define AV_PKT_FLAG_KEY 0x0001 ///< The packet contains a keyframe
1700 #define AV_PKT_FLAG_CORRUPT 0x0002 ///< The packet content is corrupted
1702 * Flag is used to discard packets which are required to maintain valid
1703 * decoder state but are not required for output and should be dropped
1706 #define AV_PKT_FLAG_DISCARD 0x0004
1708 enum AVSideDataParamChangeFlags {
1709 AV_SIDE_DATA_PARAM_CHANGE_CHANNEL_COUNT = 0x0001,
1710 AV_SIDE_DATA_PARAM_CHANGE_CHANNEL_LAYOUT = 0x0002,
1711 AV_SIDE_DATA_PARAM_CHANGE_SAMPLE_RATE = 0x0004,
1712 AV_SIDE_DATA_PARAM_CHANGE_DIMENSIONS = 0x0008,
1718 struct AVCodecInternal;
1722 AV_FIELD_PROGRESSIVE,
1723 AV_FIELD_TT, //< Top coded_first, top displayed first
1724 AV_FIELD_BB, //< Bottom coded first, bottom displayed first
1725 AV_FIELD_TB, //< Top coded first, bottom displayed first
1726 AV_FIELD_BT, //< Bottom coded first, top displayed first
1730 * main external API structure.
1731 * New fields can be added to the end with minor version bumps.
1732 * Removal, reordering and changes to existing fields require a major
1734 * You can use AVOptions (av_opt* / av_set/get*()) to access these fields from user
1736 * The name string for AVOptions options matches the associated command line
1737 * parameter name and can be found in libavcodec/options_table.h
1738 * The AVOption/command line parameter names differ in some cases from the C
1739 * structure field names for historic reasons or brevity.
1740 * sizeof(AVCodecContext) must not be used outside libav*.
1742 typedef struct AVCodecContext {
1744 * information on struct for av_log
1745 * - set by avcodec_alloc_context3
1747 const AVClass *av_class;
1748 int log_level_offset;
1750 enum AVMediaType codec_type; /* see AVMEDIA_TYPE_xxx */
1751 const struct AVCodec *codec;
1752 #if FF_API_CODEC_NAME
1754 * @deprecated this field is not used for anything in libavcodec
1756 attribute_deprecated
1757 char codec_name[32];
1759 enum AVCodecID codec_id; /* see AV_CODEC_ID_xxx */
1762 * fourcc (LSB first, so "ABCD" -> ('D'<<24) + ('C'<<16) + ('B'<<8) + 'A').
1763 * This is used to work around some encoder bugs.
1764 * A demuxer should set this to what is stored in the field used to identify the codec.
1765 * If there are multiple such fields in a container then the demuxer should choose the one
1766 * which maximizes the information about the used codec.
1767 * If the codec tag field in a container is larger than 32 bits then the demuxer should
1768 * remap the longer ID to 32 bits with a table or other structure. Alternatively a new
1769 * extra_codec_tag + size could be added but for this a clear advantage must be demonstrated
1771 * - encoding: Set by user, if not then the default based on codec_id will be used.
1772 * - decoding: Set by user, will be converted to uppercase by libavcodec during init.
1774 unsigned int codec_tag;
1776 #if FF_API_STREAM_CODEC_TAG
1778 * @deprecated this field is unused
1780 attribute_deprecated
1781 unsigned int stream_codec_tag;
1787 * Private context used for internal data.
1789 * Unlike priv_data, this is not codec-specific. It is used in general
1790 * libavcodec functions.
1792 struct AVCodecInternal *internal;
1795 * Private data of the user, can be used to carry app specific stuff.
1796 * - encoding: Set by user.
1797 * - decoding: Set by user.
1802 * the average bitrate
1803 * - encoding: Set by user; unused for constant quantizer encoding.
1804 * - decoding: Set by user, may be overwritten by libavcodec
1805 * if this info is available in the stream
1810 * number of bits the bitstream is allowed to diverge from the reference.
1811 * the reference can be CBR (for CBR pass1) or VBR (for pass2)
1812 * - encoding: Set by user; unused for constant quantizer encoding.
1813 * - decoding: unused
1815 int bit_rate_tolerance;
1818 * Global quality for codecs which cannot change it per frame.
1819 * This should be proportional to MPEG-1/2/4 qscale.
1820 * - encoding: Set by user.
1821 * - decoding: unused
1826 * - encoding: Set by user.
1827 * - decoding: unused
1829 int compression_level;
1830 #define FF_COMPRESSION_DEFAULT -1
1834 * - encoding: Set by user.
1835 * - decoding: Set by user.
1841 * - encoding: Set by user.
1842 * - decoding: Set by user.
1847 * some codecs need / can use extradata like Huffman tables.
1848 * MJPEG: Huffman tables
1849 * rv10: additional flags
1850 * MPEG-4: global headers (they can be in the bitstream or here)
1851 * The allocated memory should be AV_INPUT_BUFFER_PADDING_SIZE bytes larger
1852 * than extradata_size to avoid problems if it is read with the bitstream reader.
1853 * The bytewise contents of extradata must not depend on the architecture or CPU endianness.
1854 * - encoding: Set/allocated/freed by libavcodec.
1855 * - decoding: Set/allocated/freed by user.
1861 * This is the fundamental unit of time (in seconds) in terms
1862 * of which frame timestamps are represented. For fixed-fps content,
1863 * timebase should be 1/framerate and timestamp increments should be
1865 * This often, but not always is the inverse of the frame rate or field rate
1866 * for video. 1/time_base is not the average frame rate if the frame rate is not
1869 * Like containers, elementary streams also can store timestamps, 1/time_base
1870 * is the unit in which these timestamps are specified.
1871 * As example of such codec time base see ISO/IEC 14496-2:2001(E)
1872 * vop_time_increment_resolution and fixed_vop_rate
1873 * (fixed_vop_rate == 0 implies that it is different from the framerate)
1875 * - encoding: MUST be set by user.
1876 * - decoding: the use of this field for decoding is deprecated.
1877 * Use framerate instead.
1879 AVRational time_base;
1882 * For some codecs, the time base is closer to the field rate than the frame rate.
1883 * Most notably, H.264 and MPEG-2 specify time_base as half of frame duration
1884 * if no telecine is used ...
1886 * Set to time_base ticks per frame. Default 1, e.g., H.264/MPEG-2 set it to 2.
1888 int ticks_per_frame;
1893 * Encoding: Number of frames delay there will be from the encoder input to
1894 * the decoder output. (we assume the decoder matches the spec)
1895 * Decoding: Number of frames delay in addition to what a standard decoder
1896 * as specified in the spec would produce.
1899 * Number of frames the decoded output will be delayed relative to the
1903 * For encoding, this field is unused (see initial_padding).
1905 * For decoding, this is the number of samples the decoder needs to
1906 * output before the decoder's output is valid. When seeking, you should
1907 * start decoding this many samples prior to your desired seek point.
1909 * - encoding: Set by libavcodec.
1910 * - decoding: Set by libavcodec.
1917 * picture width / height.
1919 * @note Those fields may not match the values of the last
1920 * AVFrame output by avcodec_decode_video2 due frame
1923 * - encoding: MUST be set by user.
1924 * - decoding: May be set by the user before opening the decoder if known e.g.
1925 * from the container. Some decoders will require the dimensions
1926 * to be set by the caller. During decoding, the decoder may
1927 * overwrite those values as required while parsing the data.
1932 * Bitstream width / height, may be different from width/height e.g. when
1933 * the decoded frame is cropped before being output or lowres is enabled.
1935 * @note Those field may not match the value of the last
1936 * AVFrame output by avcodec_receive_frame() due frame
1939 * - encoding: unused
1940 * - decoding: May be set by the user before opening the decoder if known
1941 * e.g. from the container. During decoding, the decoder may
1942 * overwrite those values as required while parsing the data.
1944 int coded_width, coded_height;
1946 #if FF_API_ASPECT_EXTENDED
1947 #define FF_ASPECT_EXTENDED 15
1951 * the number of pictures in a group of pictures, or 0 for intra_only
1952 * - encoding: Set by user.
1953 * - decoding: unused
1958 * Pixel format, see AV_PIX_FMT_xxx.
1959 * May be set by the demuxer if known from headers.
1960 * May be overridden by the decoder if it knows better.
1962 * @note This field may not match the value of the last
1963 * AVFrame output by avcodec_receive_frame() due frame
1966 * - encoding: Set by user.
1967 * - decoding: Set by user if known, overridden by libavcodec while
1970 enum AVPixelFormat pix_fmt;
1972 #if FF_API_MOTION_EST
1974 * This option does nothing
1975 * @deprecated use codec private options instead
1977 attribute_deprecated int me_method;
1981 * If non NULL, 'draw_horiz_band' is called by the libavcodec
1982 * decoder to draw a horizontal band. It improves cache usage. Not
1983 * all codecs can do that. You must check the codec capabilities
1985 * When multithreading is used, it may be called from multiple threads
1986 * at the same time; threads might draw different parts of the same AVFrame,
1987 * or multiple AVFrames, and there is no guarantee that slices will be drawn
1989 * The function is also used by hardware acceleration APIs.
1990 * It is called at least once during frame decoding to pass
1991 * the data needed for hardware render.
1992 * In that mode instead of pixel data, AVFrame points to
1993 * a structure specific to the acceleration API. The application
1994 * reads the structure and can change some fields to indicate progress
1996 * - encoding: unused
1997 * - decoding: Set by user.
1998 * @param height the height of the slice
1999 * @param y the y position of the slice
2000 * @param type 1->top field, 2->bottom field, 3->frame
2001 * @param offset offset into the AVFrame.data from which the slice should be read
2003 void (*draw_horiz_band)(struct AVCodecContext *s,
2004 const AVFrame *src, int offset[AV_NUM_DATA_POINTERS],
2005 int y, int type, int height);
2008 * callback to negotiate the pixelFormat
2009 * @param fmt is the list of formats which are supported by the codec,
2010 * it is terminated by -1 as 0 is a valid format, the formats are ordered by quality.
2011 * The first is always the native one.
2012 * @note The callback may be called again immediately if initialization for
2013 * the selected (hardware-accelerated) pixel format failed.
2014 * @warning Behavior is undefined if the callback returns a value not
2015 * in the fmt list of formats.
2016 * @return the chosen format
2017 * - encoding: unused
2018 * - decoding: Set by user, if not set the native format will be chosen.
2020 enum AVPixelFormat (*get_format)(struct AVCodecContext *s, const enum AVPixelFormat * fmt);
2023 * maximum number of B-frames between non-B-frames
2024 * Note: The output will be delayed by max_b_frames+1 relative to the input.
2025 * - encoding: Set by user.
2026 * - decoding: unused
2031 * qscale factor between IP and B-frames
2032 * If > 0 then the last P-frame quantizer will be used (q= lastp_q*factor+offset).
2033 * If < 0 then normal ratecontrol will be done (q= -normal_q*factor+offset).
2034 * - encoding: Set by user.
2035 * - decoding: unused
2037 float b_quant_factor;
2039 #if FF_API_RC_STRATEGY
2040 /** @deprecated use codec private option instead */
2041 attribute_deprecated int rc_strategy;
2042 #define FF_RC_STRATEGY_XVID 1
2045 #if FF_API_PRIVATE_OPT
2046 /** @deprecated use encoder private options instead */
2047 attribute_deprecated
2048 int b_frame_strategy;
2052 * qscale offset between IP and B-frames
2053 * - encoding: Set by user.
2054 * - decoding: unused
2056 float b_quant_offset;
2059 * Size of the frame reordering buffer in the decoder.
2060 * For MPEG-2 it is 1 IPB or 0 low delay IP.
2061 * - encoding: Set by libavcodec.
2062 * - decoding: Set by libavcodec.
2066 #if FF_API_PRIVATE_OPT
2067 /** @deprecated use encoder private options instead */
2068 attribute_deprecated
2073 * qscale factor between P- and I-frames
2074 * If > 0 then the last P-frame quantizer will be used (q = lastp_q * factor + offset).
2075 * If < 0 then normal ratecontrol will be done (q= -normal_q*factor+offset).
2076 * - encoding: Set by user.
2077 * - decoding: unused
2079 float i_quant_factor;
2082 * qscale offset between P and I-frames
2083 * - encoding: Set by user.
2084 * - decoding: unused
2086 float i_quant_offset;
2089 * luminance masking (0-> disabled)
2090 * - encoding: Set by user.
2091 * - decoding: unused
2096 * temporary complexity masking (0-> disabled)
2097 * - encoding: Set by user.
2098 * - decoding: unused
2100 float temporal_cplx_masking;
2103 * spatial complexity masking (0-> disabled)
2104 * - encoding: Set by user.
2105 * - decoding: unused
2107 float spatial_cplx_masking;
2110 * p block masking (0-> disabled)
2111 * - encoding: Set by user.
2112 * - decoding: unused
2117 * darkness masking (0-> disabled)
2118 * - encoding: Set by user.
2119 * - decoding: unused
2125 * - encoding: Set by libavcodec.
2126 * - decoding: Set by user (or 0).
2130 #if FF_API_PRIVATE_OPT
2131 /** @deprecated use encoder private options instead */
2132 attribute_deprecated
2133 int prediction_method;
2134 #define FF_PRED_LEFT 0
2135 #define FF_PRED_PLANE 1
2136 #define FF_PRED_MEDIAN 2
2140 * slice offsets in the frame in bytes
2141 * - encoding: Set/allocated by libavcodec.
2142 * - decoding: Set/allocated by user (or NULL).
2147 * sample aspect ratio (0 if unknown)
2148 * That is the width of a pixel divided by the height of the pixel.
2149 * Numerator and denominator must be relatively prime and smaller than 256 for some video standards.
2150 * - encoding: Set by user.
2151 * - decoding: Set by libavcodec.
2153 AVRational sample_aspect_ratio;
2156 * motion estimation comparison function
2157 * - encoding: Set by user.
2158 * - decoding: unused
2162 * subpixel motion estimation comparison function
2163 * - encoding: Set by user.
2164 * - decoding: unused
2168 * macroblock comparison function (not supported yet)
2169 * - encoding: Set by user.
2170 * - decoding: unused
2174 * interlaced DCT comparison function
2175 * - encoding: Set by user.
2176 * - decoding: unused
2179 #define FF_CMP_SAD 0
2180 #define FF_CMP_SSE 1
2181 #define FF_CMP_SATD 2
2182 #define FF_CMP_DCT 3
2183 #define FF_CMP_PSNR 4
2184 #define FF_CMP_BIT 5
2186 #define FF_CMP_ZERO 7
2187 #define FF_CMP_VSAD 8
2188 #define FF_CMP_VSSE 9
2189 #define FF_CMP_NSSE 10
2190 #define FF_CMP_W53 11
2191 #define FF_CMP_W97 12
2192 #define FF_CMP_DCTMAX 13
2193 #define FF_CMP_DCT264 14
2194 #define FF_CMP_MEDIAN_SAD 15
2195 #define FF_CMP_CHROMA 256
2198 * ME diamond size & shape
2199 * - encoding: Set by user.
2200 * - decoding: unused
2205 * amount of previous MV predictors (2a+1 x 2a+1 square)
2206 * - encoding: Set by user.
2207 * - decoding: unused
2209 int last_predictor_count;
2211 #if FF_API_PRIVATE_OPT
2212 /** @deprecated use encoder private options instead */
2213 attribute_deprecated
2218 * motion estimation prepass comparison function
2219 * - encoding: Set by user.
2220 * - decoding: unused
2225 * ME prepass diamond size & shape
2226 * - encoding: Set by user.
2227 * - decoding: unused
2233 * - encoding: Set by user.
2234 * - decoding: unused
2236 int me_subpel_quality;
2240 * DTG active format information (additional aspect ratio
2241 * information only used in DVB MPEG-2 transport streams)
2244 * - encoding: unused
2245 * - decoding: Set by decoder.
2246 * @deprecated Deprecated in favor of AVSideData
2248 attribute_deprecated int dtg_active_format;
2249 #define FF_DTG_AFD_SAME 8
2250 #define FF_DTG_AFD_4_3 9
2251 #define FF_DTG_AFD_16_9 10
2252 #define FF_DTG_AFD_14_9 11
2253 #define FF_DTG_AFD_4_3_SP_14_9 13
2254 #define FF_DTG_AFD_16_9_SP_14_9 14
2255 #define FF_DTG_AFD_SP_4_3 15
2256 #endif /* FF_API_AFD */
2259 * maximum motion estimation search range in subpel units
2260 * If 0 then no limit.
2262 * - encoding: Set by user.
2263 * - decoding: unused
2267 #if FF_API_QUANT_BIAS
2269 * @deprecated use encoder private option instead
2271 attribute_deprecated int intra_quant_bias;
2272 #define FF_DEFAULT_QUANT_BIAS 999999
2275 * @deprecated use encoder private option instead
2277 attribute_deprecated int inter_quant_bias;
2282 * - encoding: unused
2283 * - decoding: Set by user.
2286 #define SLICE_FLAG_CODED_ORDER 0x0001 ///< draw_horiz_band() is called in coded order instead of display
2287 #define SLICE_FLAG_ALLOW_FIELD 0x0002 ///< allow draw_horiz_band() with field slices (MPEG-2 field pics)
2288 #define SLICE_FLAG_ALLOW_PLANE 0x0004 ///< allow draw_horiz_band() with 1 component at a time (SVQ1)
2292 * XVideo Motion Acceleration
2293 * - encoding: forbidden
2294 * - decoding: set by decoder
2295 * @deprecated XvMC doesn't need it anymore.
2297 attribute_deprecated int xvmc_acceleration;
2298 #endif /* FF_API_XVMC */
2301 * macroblock decision mode
2302 * - encoding: Set by user.
2303 * - decoding: unused
2306 #define FF_MB_DECISION_SIMPLE 0 ///< uses mb_cmp
2307 #define FF_MB_DECISION_BITS 1 ///< chooses the one which needs the fewest bits
2308 #define FF_MB_DECISION_RD 2 ///< rate distortion
2311 * custom intra quantization matrix
2312 * - encoding: Set by user, can be NULL.
2313 * - decoding: Set by libavcodec.
2315 uint16_t *intra_matrix;
2318 * custom inter quantization matrix
2319 * - encoding: Set by user, can be NULL.
2320 * - decoding: Set by libavcodec.
2322 uint16_t *inter_matrix;
2324 #if FF_API_PRIVATE_OPT
2325 /** @deprecated use encoder private options instead */
2326 attribute_deprecated
2327 int scenechange_threshold;
2329 /** @deprecated use encoder private options instead */
2330 attribute_deprecated
2331 int noise_reduction;
2336 * @deprecated this field is unused
2338 attribute_deprecated
2342 * @deprecated this field is unused
2344 attribute_deprecated
2349 * precision of the intra DC coefficient - 8
2350 * - encoding: Set by user.
2351 * - decoding: Set by libavcodec
2353 int intra_dc_precision;
2356 * Number of macroblock rows at the top which are skipped.
2357 * - encoding: unused
2358 * - decoding: Set by user.
2363 * Number of macroblock rows at the bottom which are skipped.
2364 * - encoding: unused
2365 * - decoding: Set by user.
2371 * @deprecated use encoder private options instead
2373 attribute_deprecated
2374 float border_masking;
2378 * minimum MB Lagrange multiplier
2379 * - encoding: Set by user.
2380 * - decoding: unused
2385 * maximum MB Lagrange multiplier
2386 * - encoding: Set by user.
2387 * - decoding: unused
2391 #if FF_API_PRIVATE_OPT
2393 * @deprecated use encoder private options instead
2395 attribute_deprecated
2396 int me_penalty_compensation;
2400 * - encoding: Set by user.
2401 * - decoding: unused
2405 #if FF_API_PRIVATE_OPT
2406 /** @deprecated use encoder private options instead */
2407 attribute_deprecated
2413 * - encoding: Set by user.
2414 * - decoding: unused
2419 * number of reference frames
2420 * - encoding: Set by user.
2421 * - decoding: Set by lavc.
2425 #if FF_API_PRIVATE_OPT
2426 /** @deprecated use encoder private options instead */
2427 attribute_deprecated
2431 #if FF_API_UNUSED_MEMBERS
2433 * Multiplied by qscale for each frame and added to scene_change_score.
2434 * - encoding: Set by user.
2435 * - decoding: unused
2437 attribute_deprecated int scenechange_factor;
2441 * Note: Value depends upon the compare function used for fullpel ME.
2442 * - encoding: Set by user.
2443 * - decoding: unused
2447 #if FF_API_PRIVATE_OPT
2448 /** @deprecated use encoder private options instead */
2449 attribute_deprecated
2454 * Chromaticity coordinates of the source primaries.
2455 * - encoding: Set by user
2456 * - decoding: Set by libavcodec
2458 enum AVColorPrimaries color_primaries;
2461 * Color Transfer Characteristic.
2462 * - encoding: Set by user
2463 * - decoding: Set by libavcodec
2465 enum AVColorTransferCharacteristic color_trc;
2468 * YUV colorspace type.
2469 * - encoding: Set by user
2470 * - decoding: Set by libavcodec
2472 enum AVColorSpace colorspace;
2475 * MPEG vs JPEG YUV range.
2476 * - encoding: Set by user
2477 * - decoding: Set by libavcodec
2479 enum AVColorRange color_range;
2482 * This defines the location of chroma samples.
2483 * - encoding: Set by user
2484 * - decoding: Set by libavcodec
2486 enum AVChromaLocation chroma_sample_location;
2490 * Indicates number of picture subdivisions. Used for parallelized
2492 * - encoding: Set by user
2493 * - decoding: unused
2498 * - encoding: set by libavcodec
2499 * - decoding: Set by user.
2501 enum AVFieldOrder field_order;
2504 int sample_rate; ///< samples per second
2505 int channels; ///< number of audio channels
2508 * audio sample format
2509 * - encoding: Set by user.
2510 * - decoding: Set by libavcodec.
2512 enum AVSampleFormat sample_fmt; ///< sample format
2514 /* The following data should not be initialized. */
2516 * Number of samples per channel in an audio frame.
2518 * - encoding: set by libavcodec in avcodec_open2(). Each submitted frame
2519 * except the last must contain exactly frame_size samples per channel.
2520 * May be 0 when the codec has AV_CODEC_CAP_VARIABLE_FRAME_SIZE set, then the
2521 * frame size is not restricted.
2522 * - decoding: may be set by some decoders to indicate constant frame size
2527 * Frame counter, set by libavcodec.
2529 * - decoding: total number of frames returned from the decoder so far.
2530 * - encoding: total number of frames passed to the encoder so far.
2532 * @note the counter is not incremented if encoding/decoding resulted in
2538 * number of bytes per packet if constant and known or 0
2539 * Used by some WAV based audio codecs.
2544 * Audio cutoff bandwidth (0 means "automatic")
2545 * - encoding: Set by user.
2546 * - decoding: unused
2551 * Audio channel layout.
2552 * - encoding: set by user.
2553 * - decoding: set by user, may be overwritten by libavcodec.
2555 uint64_t channel_layout;
2558 * Request decoder to use this channel layout if it can (0 for default)
2559 * - encoding: unused
2560 * - decoding: Set by user.
2562 uint64_t request_channel_layout;
2565 * Type of service that the audio stream conveys.
2566 * - encoding: Set by user.
2567 * - decoding: Set by libavcodec.
2569 enum AVAudioServiceType audio_service_type;
2572 * desired sample format
2573 * - encoding: Not used.
2574 * - decoding: Set by user.
2575 * Decoder will decode to this format if it can.
2577 enum AVSampleFormat request_sample_fmt;
2580 * This callback is called at the beginning of each frame to get data
2581 * buffer(s) for it. There may be one contiguous buffer for all the data or
2582 * there may be a buffer per each data plane or anything in between. What
2583 * this means is, you may set however many entries in buf[] you feel necessary.
2584 * Each buffer must be reference-counted using the AVBuffer API (see description
2587 * The following fields will be set in the frame before this callback is
2590 * - width, height (video only)
2591 * - sample_rate, channel_layout, nb_samples (audio only)
2592 * Their values may differ from the corresponding values in
2593 * AVCodecContext. This callback must use the frame values, not the codec
2594 * context values, to calculate the required buffer size.
2596 * This callback must fill the following fields in the frame:
2600 * * if the data is planar audio with more than 8 channels, then this
2601 * callback must allocate and fill extended_data to contain all pointers
2602 * to all data planes. data[] must hold as many pointers as it can.
2603 * extended_data must be allocated with av_malloc() and will be freed in
2605 * * otherwise extended_data must point to data
2606 * - buf[] must contain one or more pointers to AVBufferRef structures. Each of
2607 * the frame's data and extended_data pointers must be contained in these. That
2608 * is, one AVBufferRef for each allocated chunk of memory, not necessarily one
2609 * AVBufferRef per data[] entry. See: av_buffer_create(), av_buffer_alloc(),
2610 * and av_buffer_ref().
2611 * - extended_buf and nb_extended_buf must be allocated with av_malloc() by
2612 * this callback and filled with the extra buffers if there are more
2613 * buffers than buf[] can hold. extended_buf will be freed in
2616 * If AV_CODEC_CAP_DR1 is not set then get_buffer2() must call
2617 * avcodec_default_get_buffer2() instead of providing buffers allocated by
2620 * Each data plane must be aligned to the maximum required by the target
2623 * @see avcodec_default_get_buffer2()
2627 * If AV_GET_BUFFER_FLAG_REF is set in flags then the frame may be reused
2628 * (read and/or written to if it is writable) later by libavcodec.
2630 * avcodec_align_dimensions2() should be used to find the required width and
2631 * height, as they normally need to be rounded up to the next multiple of 16.
2633 * Some decoders do not support linesizes changing between frames.
2635 * If frame multithreading is used and thread_safe_callbacks is set,
2636 * this callback may be called from a different thread, but not from more
2637 * than one at once. Does not need to be reentrant.
2639 * @see avcodec_align_dimensions2()
2643 * Decoders request a buffer of a particular size by setting
2644 * AVFrame.nb_samples prior to calling get_buffer2(). The decoder may,
2645 * however, utilize only part of the buffer by setting AVFrame.nb_samples
2646 * to a smaller value in the output frame.
2648 * As a convenience, av_samples_get_buffer_size() and
2649 * av_samples_fill_arrays() in libavutil may be used by custom get_buffer2()
2650 * functions to find the required data size and to fill data pointers and
2651 * linesize. In AVFrame.linesize, only linesize[0] may be set for audio
2652 * since all planes must be the same size.
2654 * @see av_samples_get_buffer_size(), av_samples_fill_arrays()
2656 * - encoding: unused
2657 * - decoding: Set by libavcodec, user can override.
2659 int (*get_buffer2)(struct AVCodecContext *s, AVFrame *frame, int flags);
2662 * If non-zero, the decoded audio and video frames returned from
2663 * avcodec_decode_video2() and avcodec_decode_audio4() are reference-counted
2664 * and are valid indefinitely. The caller must free them with
2665 * av_frame_unref() when they are not needed anymore.
2666 * Otherwise, the decoded frames must not be freed by the caller and are
2667 * only valid until the next decode call.
2669 * This is always automatically enabled if avcodec_receive_frame() is used.
2671 * - encoding: unused
2672 * - decoding: set by the caller before avcodec_open2().
2674 int refcounted_frames;
2676 /* - encoding parameters */
2677 float qcompress; ///< amount of qscale change between easy & hard scenes (0.0-1.0)
2678 float qblur; ///< amount of qscale smoothing over time (0.0-1.0)
2682 * - encoding: Set by user.
2683 * - decoding: unused
2689 * - encoding: Set by user.
2690 * - decoding: unused
2695 * maximum quantizer difference between frames
2696 * - encoding: Set by user.
2697 * - decoding: unused
2703 * @deprecated use encoder private options instead
2705 attribute_deprecated
2708 attribute_deprecated
2710 attribute_deprecated
2715 * decoder bitstream buffer size
2716 * - encoding: Set by user.
2717 * - decoding: unused
2722 * ratecontrol override, see RcOverride
2723 * - encoding: Allocated/set/freed by user.
2724 * - decoding: unused
2726 int rc_override_count;
2727 RcOverride *rc_override;
2731 * @deprecated use encoder private options instead
2733 attribute_deprecated
2739 * - encoding: Set by user.
2740 * - decoding: Set by user, may be overwritten by libavcodec.
2742 int64_t rc_max_rate;
2746 * - encoding: Set by user.
2747 * - decoding: unused
2749 int64_t rc_min_rate;
2753 * @deprecated use encoder private options instead
2755 attribute_deprecated
2756 float rc_buffer_aggressivity;
2758 attribute_deprecated
2759 float rc_initial_cplx;
2763 * Ratecontrol attempt to use, at maximum, <value> of what can be used without an underflow.
2764 * - encoding: Set by user.
2765 * - decoding: unused.
2767 float rc_max_available_vbv_use;
2770 * Ratecontrol attempt to use, at least, <value> times the amount needed to prevent a vbv overflow.
2771 * - encoding: Set by user.
2772 * - decoding: unused.
2774 float rc_min_vbv_overflow_use;
2777 * Number of bits which should be loaded into the rc buffer before decoding starts.
2778 * - encoding: Set by user.
2779 * - decoding: unused
2781 int rc_initial_buffer_occupancy;
2783 #if FF_API_CODER_TYPE
2784 #define FF_CODER_TYPE_VLC 0
2785 #define FF_CODER_TYPE_AC 1
2786 #define FF_CODER_TYPE_RAW 2
2787 #define FF_CODER_TYPE_RLE 3
2788 #if FF_API_UNUSED_MEMBERS
2789 #define FF_CODER_TYPE_DEFLATE 4
2790 #endif /* FF_API_UNUSED_MEMBERS */
2792 * @deprecated use encoder private options instead
2794 attribute_deprecated
2796 #endif /* FF_API_CODER_TYPE */
2798 #if FF_API_PRIVATE_OPT
2799 /** @deprecated use encoder private options instead */
2800 attribute_deprecated
2806 * @deprecated use encoder private options instead
2808 attribute_deprecated
2812 * @deprecated use encoder private options instead
2814 attribute_deprecated
2818 #if FF_API_PRIVATE_OPT
2819 /** @deprecated use encoder private options instead */
2820 attribute_deprecated
2821 int frame_skip_threshold;
2823 /** @deprecated use encoder private options instead */
2824 attribute_deprecated
2825 int frame_skip_factor;
2827 /** @deprecated use encoder private options instead */
2828 attribute_deprecated
2831 /** @deprecated use encoder private options instead */
2832 attribute_deprecated
2834 #endif /* FF_API_PRIVATE_OPT */
2837 * trellis RD quantization
2838 * - encoding: Set by user.
2839 * - decoding: unused
2843 #if FF_API_PRIVATE_OPT
2844 /** @deprecated use encoder private options instead */
2845 attribute_deprecated
2846 int min_prediction_order;
2848 /** @deprecated use encoder private options instead */
2849 attribute_deprecated
2850 int max_prediction_order;
2852 /** @deprecated use encoder private options instead */
2853 attribute_deprecated
2854 int64_t timecode_frame_start;
2857 #if FF_API_RTP_CALLBACK
2859 * @deprecated unused
2861 /* The RTP callback: This function is called */
2862 /* every time the encoder has a packet to send. */
2863 /* It depends on the encoder if the data starts */
2864 /* with a Start Code (it should). H.263 does. */
2865 /* mb_nb contains the number of macroblocks */
2866 /* encoded in the RTP payload. */
2867 attribute_deprecated
2868 void (*rtp_callback)(struct AVCodecContext *avctx, void *data, int size, int mb_nb);
2871 #if FF_API_PRIVATE_OPT
2872 /** @deprecated use encoder private options instead */
2873 attribute_deprecated
2874 int rtp_payload_size; /* The size of the RTP payload: the coder will */
2875 /* do its best to deliver a chunk with size */
2876 /* below rtp_payload_size, the chunk will start */
2877 /* with a start code on some codecs like H.263. */
2878 /* This doesn't take account of any particular */
2879 /* headers inside the transmitted RTP payload. */
2882 #if FF_API_STAT_BITS
2883 /* statistics, used for 2-pass encoding */
2884 attribute_deprecated
2886 attribute_deprecated
2888 attribute_deprecated
2890 attribute_deprecated
2892 attribute_deprecated
2894 attribute_deprecated
2896 attribute_deprecated
2898 attribute_deprecated
2901 /** @deprecated this field is unused */
2902 attribute_deprecated
2907 * pass1 encoding statistics output buffer
2908 * - encoding: Set by libavcodec.
2909 * - decoding: unused
2914 * pass2 encoding statistics input buffer
2915 * Concatenated stuff from stats_out of pass1 should be placed here.
2916 * - encoding: Allocated/set/freed by user.
2917 * - decoding: unused
2922 * Work around bugs in encoders which sometimes cannot be detected automatically.
2923 * - encoding: Set by user
2924 * - decoding: Set by user
2926 int workaround_bugs;
2927 #define FF_BUG_AUTODETECT 1 ///< autodetection
2928 #if FF_API_OLD_MSMPEG4
2929 #define FF_BUG_OLD_MSMPEG4 2
2931 #define FF_BUG_XVID_ILACE 4
2932 #define FF_BUG_UMP4 8
2933 #define FF_BUG_NO_PADDING 16
2934 #define FF_BUG_AMV 32
2936 #define FF_BUG_AC_VLC 0 ///< Will be removed, libavcodec can now handle these non-compliant files by default.
2938 #define FF_BUG_QPEL_CHROMA 64
2939 #define FF_BUG_STD_QPEL 128
2940 #define FF_BUG_QPEL_CHROMA2 256
2941 #define FF_BUG_DIRECT_BLOCKSIZE 512
2942 #define FF_BUG_EDGE 1024
2943 #define FF_BUG_HPEL_CHROMA 2048
2944 #define FF_BUG_DC_CLIP 4096
2945 #define FF_BUG_MS 8192 ///< Work around various bugs in Microsoft's broken decoders.
2946 #define FF_BUG_TRUNCATED 16384
2947 #define FF_BUG_IEDGE 32768
2950 * strictly follow the standard (MPEG-4, ...).
2951 * - encoding: Set by user.
2952 * - decoding: Set by user.
2953 * Setting this to STRICT or higher means the encoder and decoder will
2954 * generally do stupid things, whereas setting it to unofficial or lower
2955 * will mean the encoder might produce output that is not supported by all
2956 * spec-compliant decoders. Decoders don't differentiate between normal,
2957 * unofficial and experimental (that is, they always try to decode things
2958 * when they can) unless they are explicitly asked to behave stupidly
2959 * (=strictly conform to the specs)
2961 int strict_std_compliance;
2962 #define FF_COMPLIANCE_VERY_STRICT 2 ///< Strictly conform to an older more strict version of the spec or reference software.
2963 #define FF_COMPLIANCE_STRICT 1 ///< Strictly conform to all the things in the spec no matter what consequences.
2964 #define FF_COMPLIANCE_NORMAL 0
2965 #define FF_COMPLIANCE_UNOFFICIAL -1 ///< Allow unofficial extensions
2966 #define FF_COMPLIANCE_EXPERIMENTAL -2 ///< Allow nonstandardized experimental things.
2969 * error concealment flags
2970 * - encoding: unused
2971 * - decoding: Set by user.
2973 int error_concealment;
2974 #define FF_EC_GUESS_MVS 1
2975 #define FF_EC_DEBLOCK 2
2976 #define FF_EC_FAVOR_INTER 256
2980 * - encoding: Set by user.
2981 * - decoding: Set by user.
2984 #define FF_DEBUG_PICT_INFO 1
2985 #define FF_DEBUG_RC 2
2986 #define FF_DEBUG_BITSTREAM 4
2987 #define FF_DEBUG_MB_TYPE 8
2988 #define FF_DEBUG_QP 16
2991 * @deprecated this option does nothing
2993 #define FF_DEBUG_MV 32
2995 #define FF_DEBUG_DCT_COEFF 0x00000040
2996 #define FF_DEBUG_SKIP 0x00000080
2997 #define FF_DEBUG_STARTCODE 0x00000100
2998 #if FF_API_UNUSED_MEMBERS
2999 #define FF_DEBUG_PTS 0x00000200
3000 #endif /* FF_API_UNUSED_MEMBERS */
3001 #define FF_DEBUG_ER 0x00000400
3002 #define FF_DEBUG_MMCO 0x00000800
3003 #define FF_DEBUG_BUGS 0x00001000
3005 #define FF_DEBUG_VIS_QP 0x00002000
3006 #define FF_DEBUG_VIS_MB_TYPE 0x00004000
3008 #define FF_DEBUG_BUFFERS 0x00008000
3009 #define FF_DEBUG_THREADS 0x00010000
3010 #define FF_DEBUG_GREEN_MD 0x00800000
3011 #define FF_DEBUG_NOMC 0x01000000
3016 * - encoding: Set by user.
3017 * - decoding: Set by user.
3020 #define FF_DEBUG_VIS_MV_P_FOR 0x00000001 // visualize forward predicted MVs of P-frames
3021 #define FF_DEBUG_VIS_MV_B_FOR 0x00000002 // visualize forward predicted MVs of B-frames
3022 #define FF_DEBUG_VIS_MV_B_BACK 0x00000004 // visualize backward predicted MVs of B-frames
3026 * Error recognition; may misdetect some more or less valid parts as errors.
3027 * - encoding: unused
3028 * - decoding: Set by user.
3030 int err_recognition;
3033 * Verify checksums embedded in the bitstream (could be of either encoded or
3034 * decoded data, depending on the codec) and print an error message on mismatch.
3035 * If AV_EF_EXPLODE is also set, a mismatching checksum will result in the
3036 * decoder returning an error.
3038 #define AV_EF_CRCCHECK (1<<0)
3039 #define AV_EF_BITSTREAM (1<<1) ///< detect bitstream specification deviations
3040 #define AV_EF_BUFFER (1<<2) ///< detect improper bitstream length
3041 #define AV_EF_EXPLODE (1<<3) ///< abort decoding on minor error detection
3043 #define AV_EF_IGNORE_ERR (1<<15) ///< ignore errors and continue
3044 #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
3045 #define AV_EF_COMPLIANT (1<<17) ///< consider all spec non compliances as errors
3046 #define AV_EF_AGGRESSIVE (1<<18) ///< consider things that a sane encoder should not do as an error
3050 * opaque 64-bit number (generally a PTS) that will be reordered and
3051 * output in AVFrame.reordered_opaque
3052 * - encoding: unused
3053 * - decoding: Set by user.
3055 int64_t reordered_opaque;
3058 * Hardware accelerator in use
3059 * - encoding: unused.
3060 * - decoding: Set by libavcodec
3062 struct AVHWAccel *hwaccel;
3065 * Hardware accelerator context.
3066 * For some hardware accelerators, a global context needs to be
3067 * provided by the user. In that case, this holds display-dependent
3068 * data FFmpeg cannot instantiate itself. Please refer to the
3069 * FFmpeg HW accelerator documentation to know how to fill this
3070 * is. e.g. for VA API, this is a struct vaapi_context.
3071 * - encoding: unused
3072 * - decoding: Set by user
3074 void *hwaccel_context;
3078 * - encoding: Set by libavcodec if flags & AV_CODEC_FLAG_PSNR.
3079 * - decoding: unused
3081 uint64_t error[AV_NUM_DATA_POINTERS];
3084 * DCT algorithm, see FF_DCT_* below
3085 * - encoding: Set by user.
3086 * - decoding: unused
3089 #define FF_DCT_AUTO 0
3090 #define FF_DCT_FASTINT 1
3091 #define FF_DCT_INT 2
3092 #define FF_DCT_MMX 3
3093 #define FF_DCT_ALTIVEC 5
3094 #define FF_DCT_FAAN 6
3097 * IDCT algorithm, see FF_IDCT_* below.
3098 * - encoding: Set by user.
3099 * - decoding: Set by user.
3102 #define FF_IDCT_AUTO 0
3103 #define FF_IDCT_INT 1
3104 #define FF_IDCT_SIMPLE 2
3105 #define FF_IDCT_SIMPLEMMX 3
3106 #define FF_IDCT_ARM 7
3107 #define FF_IDCT_ALTIVEC 8
3109 #define FF_IDCT_SH4 9
3111 #define FF_IDCT_SIMPLEARM 10
3112 #if FF_API_UNUSED_MEMBERS
3113 #define FF_IDCT_IPP 13
3114 #endif /* FF_API_UNUSED_MEMBERS */
3115 #define FF_IDCT_XVID 14
3116 #if FF_API_IDCT_XVIDMMX
3117 #define FF_IDCT_XVIDMMX 14
3118 #endif /* FF_API_IDCT_XVIDMMX */
3119 #define FF_IDCT_SIMPLEARMV5TE 16
3120 #define FF_IDCT_SIMPLEARMV6 17
3121 #if FF_API_ARCH_SPARC
3122 #define FF_IDCT_SIMPLEVIS 18
3124 #define FF_IDCT_FAAN 20
3125 #define FF_IDCT_SIMPLENEON 22
3126 #if FF_API_ARCH_ALPHA
3127 #define FF_IDCT_SIMPLEALPHA 23
3129 #define FF_IDCT_SIMPLEAUTO 128
3132 * bits per sample/pixel from the demuxer (needed for huffyuv).
3133 * - encoding: Set by libavcodec.
3134 * - decoding: Set by user.
3136 int bits_per_coded_sample;
3139 * Bits per sample/pixel of internal libavcodec pixel/sample format.
3140 * - encoding: set by user.
3141 * - decoding: set by libavcodec.
3143 int bits_per_raw_sample;
3147 * low resolution decoding, 1-> 1/2 size, 2->1/4 size
3148 * - encoding: unused
3149 * - decoding: Set by user.
3154 #if FF_API_CODED_FRAME
3156 * the picture in the bitstream
3157 * - encoding: Set by libavcodec.
3158 * - decoding: unused
3160 * @deprecated use the quality factor packet side data instead
3162 attribute_deprecated AVFrame *coded_frame;
3167 * is used to decide how many independent tasks should be passed to execute()
3168 * - encoding: Set by user.
3169 * - decoding: Set by user.
3174 * Which multithreading methods to use.
3175 * Use of FF_THREAD_FRAME will increase decoding delay by one frame per thread,
3176 * so clients which cannot provide future frames should not use it.
3178 * - encoding: Set by user, otherwise the default is used.
3179 * - decoding: Set by user, otherwise the default is used.
3182 #define FF_THREAD_FRAME 1 ///< Decode more than one frame at once
3183 #define FF_THREAD_SLICE 2 ///< Decode more than one part of a single frame at once
3186 * Which multithreading methods are in use by the codec.
3187 * - encoding: Set by libavcodec.
3188 * - decoding: Set by libavcodec.
3190 int active_thread_type;
3193 * Set by the client if its custom get_buffer() callback can be called
3194 * synchronously from another thread, which allows faster multithreaded decoding.
3195 * draw_horiz_band() will be called from other threads regardless of this setting.
3196 * Ignored if the default get_buffer() is used.
3197 * - encoding: Set by user.
3198 * - decoding: Set by user.
3200 int thread_safe_callbacks;
3203 * The codec may call this to execute several independent things.
3204 * It will return only after finishing all tasks.
3205 * The user may replace this with some multithreaded implementation,
3206 * the default implementation will execute the parts serially.
3207 * @param count the number of things to execute
3208 * - encoding: Set by libavcodec, user can override.
3209 * - decoding: Set by libavcodec, user can override.
3211 int (*execute)(struct AVCodecContext *c, int (*func)(struct AVCodecContext *c2, void *arg), void *arg2, int *ret, int count, int size);
3214 * The codec may call this to execute several independent things.
3215 * It will return only after finishing all tasks.
3216 * The user may replace this with some multithreaded implementation,
3217 * the default implementation will execute the parts serially.
3218 * Also see avcodec_thread_init and e.g. the --enable-pthread configure option.
3219 * @param c context passed also to func
3220 * @param count the number of things to execute
3221 * @param arg2 argument passed unchanged to func
3222 * @param ret return values of executed functions, must have space for "count" values. May be NULL.
3223 * @param func function that will be called count times, with jobnr from 0 to count-1.
3224 * threadnr will be in the range 0 to c->thread_count-1 < MAX_THREADS and so that no
3225 * two instances of func executing at the same time will have the same threadnr.
3226 * @return always 0 currently, but code should handle a future improvement where when any call to func
3227 * returns < 0 no further calls to func may be done and < 0 is returned.
3228 * - encoding: Set by libavcodec, user can override.
3229 * - decoding: Set by libavcodec, user can override.
3231 int (*execute2)(struct AVCodecContext *c, int (*func)(struct AVCodecContext *c2, void *arg, int jobnr, int threadnr), void *arg2, int *ret, int count);
3234 * noise vs. sse weight for the nsse comparison function
3235 * - encoding: Set by user.
3236 * - decoding: unused
3242 * - encoding: Set by user.
3243 * - decoding: Set by libavcodec.
3246 #define FF_PROFILE_UNKNOWN -99
3247 #define FF_PROFILE_RESERVED -100
3249 #define FF_PROFILE_AAC_MAIN 0
3250 #define FF_PROFILE_AAC_LOW 1
3251 #define FF_PROFILE_AAC_SSR 2
3252 #define FF_PROFILE_AAC_LTP 3
3253 #define FF_PROFILE_AAC_HE 4
3254 #define FF_PROFILE_AAC_HE_V2 28
3255 #define FF_PROFILE_AAC_LD 22
3256 #define FF_PROFILE_AAC_ELD 38
3257 #define FF_PROFILE_MPEG2_AAC_LOW 128
3258 #define FF_PROFILE_MPEG2_AAC_HE 131
3260 #define FF_PROFILE_DNXHD 0
3261 #define FF_PROFILE_DNXHR_LB 1
3262 #define FF_PROFILE_DNXHR_SQ 2
3263 #define FF_PROFILE_DNXHR_HQ 3
3264 #define FF_PROFILE_DNXHR_HQX 4
3265 #define FF_PROFILE_DNXHR_444 5
3267 #define FF_PROFILE_DTS 20
3268 #define FF_PROFILE_DTS_ES 30
3269 #define FF_PROFILE_DTS_96_24 40
3270 #define FF_PROFILE_DTS_HD_HRA 50
3271 #define FF_PROFILE_DTS_HD_MA 60
3272 #define FF_PROFILE_DTS_EXPRESS 70
3274 #define FF_PROFILE_MPEG2_422 0
3275 #define FF_PROFILE_MPEG2_HIGH 1
3276 #define FF_PROFILE_MPEG2_SS 2
3277 #define FF_PROFILE_MPEG2_SNR_SCALABLE 3
3278 #define FF_PROFILE_MPEG2_MAIN 4
3279 #define FF_PROFILE_MPEG2_SIMPLE 5
3281 #define FF_PROFILE_H264_CONSTRAINED (1<<9) // 8+1; constraint_set1_flag
3282 #define FF_PROFILE_H264_INTRA (1<<11) // 8+3; constraint_set3_flag
3284 #define FF_PROFILE_H264_BASELINE 66
3285 #define FF_PROFILE_H264_CONSTRAINED_BASELINE (66|FF_PROFILE_H264_CONSTRAINED)
3286 #define FF_PROFILE_H264_MAIN 77
3287 #define FF_PROFILE_H264_EXTENDED 88
3288 #define FF_PROFILE_H264_HIGH 100
3289 #define FF_PROFILE_H264_HIGH_10 110
3290 #define FF_PROFILE_H264_HIGH_10_INTRA (110|FF_PROFILE_H264_INTRA)
3291 #define FF_PROFILE_H264_MULTIVIEW_HIGH 118
3292 #define FF_PROFILE_H264_HIGH_422 122
3293 #define FF_PROFILE_H264_HIGH_422_INTRA (122|FF_PROFILE_H264_INTRA)
3294 #define FF_PROFILE_H264_STEREO_HIGH 128
3295 #define FF_PROFILE_H264_HIGH_444 144
3296 #define FF_PROFILE_H264_HIGH_444_PREDICTIVE 244
3297 #define FF_PROFILE_H264_HIGH_444_INTRA (244|FF_PROFILE_H264_INTRA)
3298 #define FF_PROFILE_H264_CAVLC_444 44
3300 #define FF_PROFILE_VC1_SIMPLE 0
3301 #define FF_PROFILE_VC1_MAIN 1
3302 #define FF_PROFILE_VC1_COMPLEX 2
3303 #define FF_PROFILE_VC1_ADVANCED 3
3305 #define FF_PROFILE_MPEG4_SIMPLE 0
3306 #define FF_PROFILE_MPEG4_SIMPLE_SCALABLE 1
3307 #define FF_PROFILE_MPEG4_CORE 2
3308 #define FF_PROFILE_MPEG4_MAIN 3
3309 #define FF_PROFILE_MPEG4_N_BIT 4
3310 #define FF_PROFILE_MPEG4_SCALABLE_TEXTURE 5
3311 #define FF_PROFILE_MPEG4_SIMPLE_FACE_ANIMATION 6
3312 #define FF_PROFILE_MPEG4_BASIC_ANIMATED_TEXTURE 7
3313 #define FF_PROFILE_MPEG4_HYBRID 8
3314 #define FF_PROFILE_MPEG4_ADVANCED_REAL_TIME 9
3315 #define FF_PROFILE_MPEG4_CORE_SCALABLE 10
3316 #define FF_PROFILE_MPEG4_ADVANCED_CODING 11
3317 #define FF_PROFILE_MPEG4_ADVANCED_CORE 12
3318 #define FF_PROFILE_MPEG4_ADVANCED_SCALABLE_TEXTURE 13
3319 #define FF_PROFILE_MPEG4_SIMPLE_STUDIO 14
3320 #define FF_PROFILE_MPEG4_ADVANCED_SIMPLE 15
3322 #define FF_PROFILE_JPEG2000_CSTREAM_RESTRICTION_0 1
3323 #define FF_PROFILE_JPEG2000_CSTREAM_RESTRICTION_1 2
3324 #define FF_PROFILE_JPEG2000_CSTREAM_NO_RESTRICTION 32768
3325 #define FF_PROFILE_JPEG2000_DCINEMA_2K 3
3326 #define FF_PROFILE_JPEG2000_DCINEMA_4K 4
3328 #define FF_PROFILE_VP9_0 0
3329 #define FF_PROFILE_VP9_1 1
3330 #define FF_PROFILE_VP9_2 2
3331 #define FF_PROFILE_VP9_3 3
3333 #define FF_PROFILE_HEVC_MAIN 1
3334 #define FF_PROFILE_HEVC_MAIN_10 2
3335 #define FF_PROFILE_HEVC_MAIN_STILL_PICTURE 3
3336 #define FF_PROFILE_HEVC_REXT 4
3340 * - encoding: Set by user.
3341 * - decoding: Set by libavcodec.
3344 #define FF_LEVEL_UNKNOWN -99
3347 * Skip loop filtering for selected frames.
3348 * - encoding: unused
3349 * - decoding: Set by user.
3351 enum AVDiscard skip_loop_filter;
3354 * Skip IDCT/dequantization for selected frames.
3355 * - encoding: unused
3356 * - decoding: Set by user.
3358 enum AVDiscard skip_idct;
3361 * Skip decoding for selected frames.
3362 * - encoding: unused
3363 * - decoding: Set by user.
3365 enum AVDiscard skip_frame;
3368 * Header containing style information for text subtitles.
3369 * For SUBTITLE_ASS subtitle type, it should contain the whole ASS
3370 * [Script Info] and [V4+ Styles] section, plus the [Events] line and
3371 * the Format line following. It shouldn't include any Dialogue line.
3372 * - encoding: Set/allocated/freed by user (before avcodec_open2())
3373 * - decoding: Set/allocated/freed by libavcodec (by avcodec_open2())
3375 uint8_t *subtitle_header;
3376 int subtitle_header_size;
3378 #if FF_API_ERROR_RATE
3380 * @deprecated use the 'error_rate' private AVOption of the mpegvideo
3383 attribute_deprecated
3387 #if FF_API_VBV_DELAY
3389 * VBV delay coded in the last frame (in periods of a 27 MHz clock).
3390 * Used for compliant TS muxing.
3391 * - encoding: Set by libavcodec.
3392 * - decoding: unused.
3393 * @deprecated this value is now exported as a part of
3394 * AV_PKT_DATA_CPB_PROPERTIES packet side data
3396 attribute_deprecated
3400 #if FF_API_SIDEDATA_ONLY_PKT
3402 * Encoding only and set by default. Allow encoders to output packets
3403 * that do not contain any encoded data, only side data.
3405 * Some encoders need to output such packets, e.g. to update some stream
3406 * parameters at the end of encoding.
3408 * @deprecated this field disables the default behaviour and
3409 * it is kept only for compatibility.
3411 attribute_deprecated
3412 int side_data_only_packets;
3416 * Audio only. The number of "priming" samples (padding) inserted by the
3417 * encoder at the beginning of the audio. I.e. this number of leading
3418 * decoded samples must be discarded by the caller to get the original audio
3419 * without leading padding.
3421 * - decoding: unused
3422 * - encoding: Set by libavcodec. The timestamps on the output packets are
3423 * adjusted by the encoder so that they always refer to the
3424 * first sample of the data actually contained in the packet,
3425 * including any added padding. E.g. if the timebase is
3426 * 1/samplerate and the timestamp of the first input sample is
3427 * 0, the timestamp of the first output packet will be
3430 int initial_padding;
3433 * - decoding: For codecs that store a framerate value in the compressed
3434 * bitstream, the decoder may export it here. { 0, 1} when
3436 * - encoding: May be used to signal the framerate of CFR content to an
3439 AVRational framerate;
3442 * Nominal unaccelerated pixel format, see AV_PIX_FMT_xxx.
3443 * - encoding: unused.
3444 * - decoding: Set by libavcodec before calling get_format()
3446 enum AVPixelFormat sw_pix_fmt;
3449 * Timebase in which pkt_dts/pts and AVPacket.dts/pts are.
3450 * - encoding unused.
3451 * - decoding set by user.
3453 AVRational pkt_timebase;
3457 * - encoding: unused.
3458 * - decoding: set by libavcodec.
3460 const AVCodecDescriptor *codec_descriptor;
3464 * low resolution decoding, 1-> 1/2 size, 2->1/4 size
3465 * - encoding: unused
3466 * - decoding: Set by user.
3472 * Current statistics for PTS correction.
3473 * - decoding: maintained and used by libavcodec, not intended to be used by user apps
3474 * - encoding: unused
3476 int64_t pts_correction_num_faulty_pts; /// Number of incorrect PTS values so far
3477 int64_t pts_correction_num_faulty_dts; /// Number of incorrect DTS values so far
3478 int64_t pts_correction_last_pts; /// PTS of the last frame
3479 int64_t pts_correction_last_dts; /// DTS of the last frame
3482 * Character encoding of the input subtitles file.
3483 * - decoding: set by user
3484 * - encoding: unused
3489 * Subtitles character encoding mode. Formats or codecs might be adjusting
3490 * this setting (if they are doing the conversion themselves for instance).
3491 * - decoding: set by libavcodec
3492 * - encoding: unused
3494 int sub_charenc_mode;
3495 #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)
3496 #define FF_SUB_CHARENC_MODE_AUTOMATIC 0 ///< libavcodec will select the mode itself
3497 #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
3500 * Skip processing alpha if supported by codec.
3501 * Note that if the format uses pre-multiplied alpha (common with VP6,
3502 * and recommended due to better video quality/compression)
3503 * the image will look as if alpha-blended onto a black background.
3504 * However for formats that do not use pre-multiplied alpha
3505 * there might be serious artefacts (though e.g. libswscale currently
3506 * assumes pre-multiplied alpha anyway).
3508 * - decoding: set by user
3509 * - encoding: unused
3514 * Number of samples to skip after a discontinuity
3515 * - decoding: unused
3516 * - encoding: set by libavcodec
3520 #if !FF_API_DEBUG_MV
3522 * debug motion vectors
3523 * - encoding: Set by user.
3524 * - decoding: Set by user.
3527 #define FF_DEBUG_VIS_MV_P_FOR 0x00000001 //visualize forward predicted MVs of P frames
3528 #define FF_DEBUG_VIS_MV_B_FOR 0x00000002 //visualize forward predicted MVs of B frames
3529 #define FF_DEBUG_VIS_MV_B_BACK 0x00000004 //visualize backward predicted MVs of B frames
3533 * custom intra quantization matrix
3534 * - encoding: Set by user, can be NULL.
3535 * - decoding: unused.
3537 uint16_t *chroma_intra_matrix;
3540 * dump format separator.
3541 * can be ", " or "\n " or anything else
3542 * - encoding: Set by user.
3543 * - decoding: Set by user.
3545 uint8_t *dump_separator;
3548 * ',' separated list of allowed decoders.
3549 * If NULL then all are allowed
3550 * - encoding: unused
3551 * - decoding: set by user
3553 char *codec_whitelist;
3556 * Properties of the stream that gets decoded
3557 * - encoding: unused
3558 * - decoding: set by libavcodec
3560 unsigned properties;
3561 #define FF_CODEC_PROPERTY_LOSSLESS 0x00000001
3562 #define FF_CODEC_PROPERTY_CLOSED_CAPTIONS 0x00000002
3565 * Additional data associated with the entire coded stream.
3567 * - decoding: unused
3568 * - encoding: may be set by libavcodec after avcodec_open2().
3570 AVPacketSideData *coded_side_data;
3571 int nb_coded_side_data;
3574 * A reference to the AVHWFramesContext describing the input (for encoding)
3575 * or output (decoding) frames. The reference is set by the caller and
3576 * afterwards owned (and freed) by libavcodec - it should never be read by
3577 * the caller after being set.
3579 * - decoding: This field should be set by the caller from the get_format()
3580 * callback. The previous reference (if any) will always be
3581 * unreffed by libavcodec before the get_format() call.
3583 * If the default get_buffer2() is used with a hwaccel pixel
3584 * format, then this AVHWFramesContext will be used for
3585 * allocating the frame buffers.
3587 * - encoding: For hardware encoders configured to use a hwaccel pixel
3588 * format, this field should be set by the caller to a reference
3589 * to the AVHWFramesContext describing input frames.
3590 * AVHWFramesContext.format must be equal to
3591 * AVCodecContext.pix_fmt.
3593 * This field should be set before avcodec_open2() is called.
3595 AVBufferRef *hw_frames_ctx;
3598 * Control the form of AVSubtitle.rects[N]->ass
3599 * - decoding: set by user
3600 * - encoding: unused
3602 int sub_text_format;
3603 #define FF_SUB_TEXT_FMT_ASS 0
3604 #if FF_API_ASS_TIMING
3605 #define FF_SUB_TEXT_FMT_ASS_WITH_TIMINGS 1
3609 * Audio only. The amount of padding (in samples) appended by the encoder to
3610 * the end of the audio. I.e. this number of decoded samples must be
3611 * discarded by the caller from the end of the stream to get the original
3612 * audio without any trailing padding.
3614 * - decoding: unused
3615 * - encoding: unused
3617 int trailing_padding;
3620 * The number of pixels per image to maximally accept.
3622 * - decoding: set by user
3623 * - encoding: set by user
3628 * A reference to the AVHWDeviceContext describing the device which will
3629 * be used by a hardware encoder/decoder. The reference is set by the
3630 * caller and afterwards owned (and freed) by libavcodec.
3632 * This should be used if either the codec device does not require
3633 * hardware frames or any that are used are to be allocated internally by
3634 * libavcodec. If the user wishes to supply any of the frames used as
3635 * encoder input or decoder output then hw_frames_ctx should be used
3636 * instead. When hw_frames_ctx is set in get_format() for a decoder, this
3637 * field will be ignored while decoding the associated stream segment, but
3638 * may again be used on a following one after another get_format() call.
3640 * For both encoders and decoders this field should be set before
3641 * avcodec_open2() is called and must not be written to thereafter.
3643 * Note that some decoders may require this field to be set initially in
3644 * order to support hw_frames_ctx at all - in that case, all frames
3645 * contexts used must be created on the same device.
3647 AVBufferRef *hw_device_ctx;
3650 * Bit set of AV_HWACCEL_FLAG_* flags, which affect hardware accelerated
3651 * decoding (if active).
3652 * - encoding: unused
3653 * - decoding: Set by user (either before avcodec_open2(), or in the
3654 * AVCodecContext.get_format callback)
3659 * Video decoding only. Certain video codecs support cropping, meaning that
3660 * only a sub-rectangle of the decoded frame is intended for display. This
3661 * option controls how cropping is handled by libavcodec.
3663 * When set to 1 (the default), libavcodec will apply cropping internally.
3664 * I.e. it will modify the output frame width/height fields and offset the
3665 * data pointers (only by as much as possible while preserving alignment, or
3666 * by the full amount if the AV_CODEC_FLAG_UNALIGNED flag is set) so that
3667 * the frames output by the decoder refer only to the cropped area. The
3668 * crop_* fields of the output frames will be zero.
3670 * When set to 0, the width/height fields of the output frames will be set
3671 * to the coded dimensions and the crop_* fields will describe the cropping
3672 * rectangle. Applying the cropping is left to the caller.
3674 * @warning When hardware acceleration with opaque output frames is used,
3675 * libavcodec is unable to apply cropping from the top/left border.
3677 * @note when this option is set to zero, the width/height fields of the
3678 * AVCodecContext and output AVFrames have different meanings. The codec
3679 * context fields store display dimensions (with the coded dimensions in
3680 * coded_width/height), while the frame fields store the coded dimensions
3681 * (with the display dimensions being determined by the crop_* fields).
3686 AVRational av_codec_get_pkt_timebase (const AVCodecContext *avctx);
3687 void av_codec_set_pkt_timebase (AVCodecContext *avctx, AVRational val);
3689 const AVCodecDescriptor *av_codec_get_codec_descriptor(const AVCodecContext *avctx);
3690 void av_codec_set_codec_descriptor(AVCodecContext *avctx, const AVCodecDescriptor *desc);
3692 unsigned av_codec_get_codec_properties(const AVCodecContext *avctx);
3694 int av_codec_get_lowres(const AVCodecContext *avctx);
3695 void av_codec_set_lowres(AVCodecContext *avctx, int val);
3697 int av_codec_get_seek_preroll(const AVCodecContext *avctx);
3698 void av_codec_set_seek_preroll(AVCodecContext *avctx, int val);
3700 uint16_t *av_codec_get_chroma_intra_matrix(const AVCodecContext *avctx);
3701 void av_codec_set_chroma_intra_matrix(AVCodecContext *avctx, uint16_t *val);
3706 typedef struct AVProfile {
3708 const char *name; ///< short name for the profile
3711 typedef struct AVCodecDefault AVCodecDefault;
3718 typedef struct AVCodec {
3720 * Name of the codec implementation.
3721 * The name is globally unique among encoders and among decoders (but an
3722 * encoder and a decoder can share the same name).
3723 * This is the primary way to find a codec from the user perspective.
3727 * Descriptive name for the codec, meant to be more human readable than name.
3728 * You should use the NULL_IF_CONFIG_SMALL() macro to define it.
3730 const char *long_name;
3731 enum AVMediaType type;
3734 * Codec capabilities.
3735 * see AV_CODEC_CAP_*
3738 const AVRational *supported_framerates; ///< array of supported framerates, or NULL if any, array is terminated by {0,0}
3739 const enum AVPixelFormat *pix_fmts; ///< array of supported pixel formats, or NULL if unknown, array is terminated by -1
3740 const int *supported_samplerates; ///< array of supported audio samplerates, or NULL if unknown, array is terminated by 0
3741 const enum AVSampleFormat *sample_fmts; ///< array of supported sample formats, or NULL if unknown, array is terminated by -1
3742 const uint64_t *channel_layouts; ///< array of support channel layouts, or NULL if unknown. array is terminated by 0
3743 uint8_t max_lowres; ///< maximum value for lowres supported by the decoder
3744 const AVClass *priv_class; ///< AVClass for the private context
3745 const AVProfile *profiles; ///< array of recognized profiles, or NULL if unknown, array is terminated by {FF_PROFILE_UNKNOWN}
3747 /*****************************************************************
3748 * No fields below this line are part of the public API. They
3749 * may not be used outside of libavcodec and can be changed and
3751 * New public fields should be added right above.
3752 *****************************************************************
3755 struct AVCodec *next;
3757 * @name Frame-level threading support functions
3761 * If defined, called on thread contexts when they are created.
3762 * If the codec allocates writable tables in init(), re-allocate them here.
3763 * priv_data will be set to a copy of the original.
3765 int (*init_thread_copy)(AVCodecContext *);
3767 * Copy necessary context variables from a previous thread context to the current one.
3768 * If not defined, the next thread will start automatically; otherwise, the codec
3769 * must call ff_thread_finish_setup().
3771 * dst and src will (rarely) point to the same context, in which case memcpy should be skipped.
3773 int (*update_thread_context)(AVCodecContext *dst, const AVCodecContext *src);
3777 * Private codec-specific defaults.
3779 const AVCodecDefault *defaults;
3782 * Initialize codec static data, called from avcodec_register().
3784 void (*init_static_data)(struct AVCodec *codec);
3786 int (*init)(AVCodecContext *);
3787 int (*encode_sub)(AVCodecContext *, uint8_t *buf, int buf_size,
3788 const struct AVSubtitle *sub);
3790 * Encode data to an AVPacket.
3792 * @param avctx codec context
3793 * @param avpkt output AVPacket (may contain a user-provided buffer)
3794 * @param[in] frame AVFrame containing the raw data to be encoded
3795 * @param[out] got_packet_ptr encoder sets to 0 or 1 to indicate that a
3796 * non-empty packet was returned in avpkt.
3797 * @return 0 on success, negative error code on failure
3799 int (*encode2)(AVCodecContext *avctx, AVPacket *avpkt, const AVFrame *frame,
3800 int *got_packet_ptr);
3801 int (*decode)(AVCodecContext *, void *outdata, int *outdata_size, AVPacket *avpkt);
3802 int (*close)(AVCodecContext *);
3804 * Encode API with decoupled packet/frame dataflow. The API is the
3805 * same as the avcodec_ prefixed APIs (avcodec_send_frame() etc.), except
3807 * - never called if the codec is closed or the wrong type,
3808 * - if AV_CODEC_CAP_DELAY is not set, drain frames are never sent,
3809 * - only one drain frame is ever passed down,
3811 int (*send_frame)(AVCodecContext *avctx, const AVFrame *frame);
3812 int (*receive_packet)(AVCodecContext *avctx, AVPacket *avpkt);
3815 * Decode API with decoupled packet/frame dataflow. This function is called
3816 * to get one output frame. It should call ff_decode_get_packet() to obtain
3819 int (*receive_frame)(AVCodecContext *avctx, AVFrame *frame);
3822 * Will be called when seeking
3824 void (*flush)(AVCodecContext *);
3826 * Internal codec capabilities.
3827 * See FF_CODEC_CAP_* in internal.h
3832 * Decoding only, a comma-separated list of bitstream filters to apply to
3833 * packets before decoding.
3838 int av_codec_get_max_lowres(const AVCodec *codec);
3840 struct MpegEncContext;
3843 * @defgroup lavc_hwaccel AVHWAccel
3846 typedef struct AVHWAccel {
3848 * Name of the hardware accelerated codec.
3849 * The name is globally unique among encoders and among decoders (but an
3850 * encoder and a decoder can share the same name).
3855 * Type of codec implemented by the hardware accelerator.
3857 * See AVMEDIA_TYPE_xxx
3859 enum AVMediaType type;
3862 * Codec implemented by the hardware accelerator.
3864 * See AV_CODEC_ID_xxx
3869 * Supported pixel format.
3871 * Only hardware accelerated formats are supported here.
3873 enum AVPixelFormat pix_fmt;
3876 * Hardware accelerated codec capabilities.
3877 * see HWACCEL_CODEC_CAP_*
3881 /*****************************************************************
3882 * No fields below this line are part of the public API. They
3883 * may not be used outside of libavcodec and can be changed and
3885 * New public fields should be added right above.
3886 *****************************************************************
3888 struct AVHWAccel *next;
3891 * Allocate a custom buffer
3893 int (*alloc_frame)(AVCodecContext *avctx, AVFrame *frame);
3896 * Called at the beginning of each frame or field picture.
3898 * Meaningful frame information (codec specific) is guaranteed to
3899 * be parsed at this point. This function is mandatory.
3901 * Note that buf can be NULL along with buf_size set to 0.
3902 * Otherwise, this means the whole frame is available at this point.
3904 * @param avctx the codec context
3905 * @param buf the frame data buffer base
3906 * @param buf_size the size of the frame in bytes
3907 * @return zero if successful, a negative value otherwise
3909 int (*start_frame)(AVCodecContext *avctx, const uint8_t *buf, uint32_t buf_size);
3912 * Callback for each slice.
3914 * Meaningful slice information (codec specific) is guaranteed to
3915 * be parsed at this point. This function is mandatory.
3916 * The only exception is XvMC, that works on MB level.
3918 * @param avctx the codec context
3919 * @param buf the slice data buffer base
3920 * @param buf_size the size of the slice in bytes
3921 * @return zero if successful, a negative value otherwise
3923 int (*decode_slice)(AVCodecContext *avctx, const uint8_t *buf, uint32_t buf_size);
3926 * Called at the end of each frame or field picture.
3928 * The whole picture is parsed at this point and can now be sent
3929 * to the hardware accelerator. This function is mandatory.
3931 * @param avctx the codec context
3932 * @return zero if successful, a negative value otherwise
3934 int (*end_frame)(AVCodecContext *avctx);
3937 * Size of per-frame hardware accelerator private data.
3939 * Private data is allocated with av_mallocz() before
3940 * AVCodecContext.get_buffer() and deallocated after
3941 * AVCodecContext.release_buffer().
3943 int frame_priv_data_size;
3946 * Called for every Macroblock in a slice.
3948 * XvMC uses it to replace the ff_mpv_decode_mb().
3949 * Instead of decoding to raw picture, MB parameters are
3950 * stored in an array provided by the video driver.
3952 * @param s the mpeg context
3954 void (*decode_mb)(struct MpegEncContext *s);
3957 * Initialize the hwaccel private data.
3959 * This will be called from ff_get_format(), after hwaccel and
3960 * hwaccel_context are set and the hwaccel private data in AVCodecInternal
3963 int (*init)(AVCodecContext *avctx);
3966 * Uninitialize the hwaccel private data.
3968 * This will be called from get_format() or avcodec_close(), after hwaccel
3969 * and hwaccel_context are already uninitialized.
3971 int (*uninit)(AVCodecContext *avctx);
3974 * Size of the private data to allocate in
3975 * AVCodecInternal.hwaccel_priv_data.
3980 * Internal hwaccel capabilities.
3986 * Hardware acceleration should be used for decoding even if the codec level
3987 * used is unknown or higher than the maximum supported level reported by the
3990 * It's generally a good idea to pass this flag unless you have a specific
3991 * reason not to, as hardware tends to under-report supported levels.
3993 #define AV_HWACCEL_FLAG_IGNORE_LEVEL (1 << 0)
3996 * Hardware acceleration can output YUV pixel formats with a different chroma
3997 * sampling than 4:2:0 and/or other than 8 bits per component.
3999 #define AV_HWACCEL_FLAG_ALLOW_HIGH_DEPTH (1 << 1)
4005 #if FF_API_AVPICTURE
4007 * @defgroup lavc_picture AVPicture
4009 * Functions for working with AVPicture
4014 * Picture data structure.
4016 * Up to four components can be stored into it, the last component is
4018 * @deprecated use AVFrame or imgutils functions instead
4020 typedef struct AVPicture {
4021 attribute_deprecated
4022 uint8_t *data[AV_NUM_DATA_POINTERS]; ///< pointers to the image data planes
4023 attribute_deprecated
4024 int linesize[AV_NUM_DATA_POINTERS]; ///< number of bytes per line
4032 enum AVSubtitleType {
4035 SUBTITLE_BITMAP, ///< A bitmap, pict will be set
4038 * Plain text, the text field must be set by the decoder and is
4039 * authoritative. ass and pict fields may contain approximations.
4044 * Formatted text, the ass field must be set by the decoder and is
4045 * authoritative. pict and text fields may contain approximations.
4050 #define AV_SUBTITLE_FLAG_FORCED 0x00000001
4052 typedef struct AVSubtitleRect {
4053 int x; ///< top left corner of pict, undefined when pict is not set
4054 int y; ///< top left corner of pict, undefined when pict is not set
4055 int w; ///< width of pict, undefined when pict is not set
4056 int h; ///< height of pict, undefined when pict is not set
4057 int nb_colors; ///< number of colors in pict, undefined when pict is not set
4059 #if FF_API_AVPICTURE
4061 * @deprecated unused
4063 attribute_deprecated
4067 * data+linesize for the bitmap of this subtitle.
4068 * Can be set for text/ass as well once they are rendered.
4073 enum AVSubtitleType type;
4075 char *text; ///< 0 terminated plain UTF-8 text
4078 * 0 terminated ASS/SSA compatible event line.
4079 * The presentation of this is unaffected by the other values in this
4087 typedef struct AVSubtitle {
4088 uint16_t format; /* 0 = graphics */
4089 uint32_t start_display_time; /* relative to packet pts, in ms */
4090 uint32_t end_display_time; /* relative to packet pts, in ms */
4092 AVSubtitleRect **rects;
4093 int64_t pts; ///< Same as packet pts, in AV_TIME_BASE
4097 * This struct describes the properties of an encoded stream.
4099 * sizeof(AVCodecParameters) is not a part of the public ABI, this struct must
4100 * be allocated with avcodec_parameters_alloc() and freed with
4101 * avcodec_parameters_free().
4103 typedef struct AVCodecParameters {
4105 * General type of the encoded data.
4107 enum AVMediaType codec_type;
4109 * Specific type of the encoded data (the codec used).
4111 enum AVCodecID codec_id;
4113 * Additional information about the codec (corresponds to the AVI FOURCC).
4118 * Extra binary data needed for initializing the decoder, codec-dependent.
4120 * Must be allocated with av_malloc() and will be freed by
4121 * avcodec_parameters_free(). The allocated size of extradata must be at
4122 * least extradata_size + AV_INPUT_BUFFER_PADDING_SIZE, with the padding
4127 * Size of the extradata content in bytes.
4132 * - video: the pixel format, the value corresponds to enum AVPixelFormat.
4133 * - audio: the sample format, the value corresponds to enum AVSampleFormat.
4138 * The average bitrate of the encoded data (in bits per second).
4143 * The number of bits per sample in the codedwords.
4145 * This is basically the bitrate per sample. It is mandatory for a bunch of
4146 * formats to actually decode them. It's the number of bits for one sample in
4147 * the actual coded bitstream.
4149 * This could be for example 4 for ADPCM
4150 * For PCM formats this matches bits_per_raw_sample
4153 int bits_per_coded_sample;
4156 * This is the number of valid bits in each output sample. If the
4157 * sample format has more bits, the least significant bits are additional
4158 * padding bits, which are always 0. Use right shifts to reduce the sample
4159 * to its actual size. For example, audio formats with 24 bit samples will
4160 * have bits_per_raw_sample set to 24, and format set to AV_SAMPLE_FMT_S32.
4161 * To get the original sample use "(int32_t)sample >> 8"."
4163 * For ADPCM this might be 12 or 16 or similar
4166 int bits_per_raw_sample;
4169 * Codec-specific bitstream restrictions that the stream conforms to.
4175 * Video only. The dimensions of the video frame in pixels.
4181 * Video only. The aspect ratio (width / height) which a single pixel
4182 * should have when displayed.
4184 * When the aspect ratio is unknown / undefined, the numerator should be
4185 * set to 0 (the denominator may have any value).
4187 AVRational sample_aspect_ratio;
4190 * Video only. The order of the fields in interlaced video.
4192 enum AVFieldOrder field_order;
4195 * Video only. Additional colorspace characteristics.
4197 enum AVColorRange color_range;
4198 enum AVColorPrimaries color_primaries;
4199 enum AVColorTransferCharacteristic color_trc;
4200 enum AVColorSpace color_space;
4201 enum AVChromaLocation chroma_location;
4204 * Video only. Number of delayed frames.
4209 * Audio only. The channel layout bitmask. May be 0 if the channel layout is
4210 * unknown or unspecified, otherwise the number of bits set must be equal to
4211 * the channels field.
4213 uint64_t channel_layout;
4215 * Audio only. The number of audio channels.
4219 * Audio only. The number of audio samples per second.
4223 * Audio only. The number of bytes per coded audio frame, required by some
4226 * Corresponds to nBlockAlign in WAVEFORMATEX.
4230 * Audio only. Audio frame size, if known. Required by some formats to be static.
4235 * Audio only. The amount of padding (in samples) inserted by the encoder at
4236 * the beginning of the audio. I.e. this number of leading decoded samples
4237 * must be discarded by the caller to get the original audio without leading
4240 int initial_padding;
4242 * Audio only. The amount of padding (in samples) appended by the encoder to
4243 * the end of the audio. I.e. this number of decoded samples must be
4244 * discarded by the caller from the end of the stream to get the original
4245 * audio without any trailing padding.
4247 int trailing_padding;
4249 * Audio only. Number of samples to skip after a discontinuity.
4252 } AVCodecParameters;
4255 * If c is NULL, returns the first registered codec,
4256 * if c is non-NULL, returns the next registered codec after c,
4257 * or NULL if c is the last one.
4259 AVCodec *av_codec_next(const AVCodec *c);
4262 * Return the LIBAVCODEC_VERSION_INT constant.
4264 unsigned avcodec_version(void);
4267 * Return the libavcodec build-time configuration.
4269 const char *avcodec_configuration(void);
4272 * Return the libavcodec license.
4274 const char *avcodec_license(void);
4277 * Register the codec codec and initialize libavcodec.
4279 * @warning either this function or avcodec_register_all() must be called
4280 * before any other libavcodec functions.
4282 * @see avcodec_register_all()
4284 void avcodec_register(AVCodec *codec);
4287 * Register all the codecs, parsers and bitstream filters which were enabled at
4288 * configuration time. If you do not call this function you can select exactly
4289 * which formats you want to support, by using the individual registration
4292 * @see avcodec_register
4293 * @see av_register_codec_parser
4294 * @see av_register_bitstream_filter
4296 void avcodec_register_all(void);
4299 * Allocate an AVCodecContext and set its fields to default values. The
4300 * resulting struct should be freed with avcodec_free_context().
4302 * @param codec if non-NULL, allocate private data and initialize defaults
4303 * for the given codec. It is illegal to then call avcodec_open2()
4304 * with a different codec.
4305 * If NULL, then the codec-specific defaults won't be initialized,
4306 * which may result in suboptimal default settings (this is
4307 * important mainly for encoders, e.g. libx264).
4309 * @return An AVCodecContext filled with default values or NULL on failure.
4311 AVCodecContext *avcodec_alloc_context3(const AVCodec *codec);
4314 * Free the codec context and everything associated with it and write NULL to
4315 * the provided pointer.
4317 void avcodec_free_context(AVCodecContext **avctx);
4319 #if FF_API_GET_CONTEXT_DEFAULTS
4321 * @deprecated This function should not be used, as closing and opening a codec
4322 * context multiple time is not supported. A new codec context should be
4323 * allocated for each new use.
4325 int avcodec_get_context_defaults3(AVCodecContext *s, const AVCodec *codec);
4329 * Get the AVClass for AVCodecContext. It can be used in combination with
4330 * AV_OPT_SEARCH_FAKE_OBJ for examining options.
4332 * @see av_opt_find().
4334 const AVClass *avcodec_get_class(void);
4336 #if FF_API_COPY_CONTEXT
4338 * Get the AVClass for AVFrame. It can be used in combination with
4339 * AV_OPT_SEARCH_FAKE_OBJ for examining options.
4341 * @see av_opt_find().
4343 const AVClass *avcodec_get_frame_class(void);
4346 * Get the AVClass for AVSubtitleRect. It can be used in combination with
4347 * AV_OPT_SEARCH_FAKE_OBJ for examining options.
4349 * @see av_opt_find().
4351 const AVClass *avcodec_get_subtitle_rect_class(void);
4354 * Copy the settings of the source AVCodecContext into the destination
4355 * AVCodecContext. The resulting destination codec context will be
4356 * unopened, i.e. you are required to call avcodec_open2() before you
4357 * can use this AVCodecContext to decode/encode video/audio data.
4359 * @param dest target codec context, should be initialized with
4360 * avcodec_alloc_context3(NULL), but otherwise uninitialized
4361 * @param src source codec context
4362 * @return AVERROR() on error (e.g. memory allocation error), 0 on success
4364 * @deprecated The semantics of this function are ill-defined and it should not
4365 * be used. If you need to transfer the stream parameters from one codec context
4366 * to another, use an intermediate AVCodecParameters instance and the
4367 * avcodec_parameters_from_context() / avcodec_parameters_to_context()
4370 attribute_deprecated
4371 int avcodec_copy_context(AVCodecContext *dest, const AVCodecContext *src);
4375 * Allocate a new AVCodecParameters and set its fields to default values
4376 * (unknown/invalid/0). The returned struct must be freed with
4377 * avcodec_parameters_free().
4379 AVCodecParameters *avcodec_parameters_alloc(void);
4382 * Free an AVCodecParameters instance and everything associated with it and
4383 * write NULL to the supplied pointer.
4385 void avcodec_parameters_free(AVCodecParameters **par);
4388 * Copy the contents of src to dst. Any allocated fields in dst are freed and
4389 * replaced with newly allocated duplicates of the corresponding fields in src.
4391 * @return >= 0 on success, a negative AVERROR code on failure.
4393 int avcodec_parameters_copy(AVCodecParameters *dst, const AVCodecParameters *src);
4396 * Fill the parameters struct based on the values from the supplied codec
4397 * context. Any allocated fields in par are freed and replaced with duplicates
4398 * of the corresponding fields in codec.
4400 * @return >= 0 on success, a negative AVERROR code on failure
4402 int avcodec_parameters_from_context(AVCodecParameters *par,
4403 const AVCodecContext *codec);
4406 * Fill the codec context based on the values from the supplied codec
4407 * parameters. Any allocated fields in codec that have a corresponding field in
4408 * par are freed and replaced with duplicates of the corresponding field in par.
4409 * Fields in codec that do not have a counterpart in par are not touched.
4411 * @return >= 0 on success, a negative AVERROR code on failure.
4413 int avcodec_parameters_to_context(AVCodecContext *codec,
4414 const AVCodecParameters *par);
4417 * Initialize the AVCodecContext to use the given AVCodec. Prior to using this
4418 * function the context has to be allocated with avcodec_alloc_context3().
4420 * The functions avcodec_find_decoder_by_name(), avcodec_find_encoder_by_name(),
4421 * avcodec_find_decoder() and avcodec_find_encoder() provide an easy way for
4422 * retrieving a codec.
4424 * @warning This function is not thread safe!
4426 * @note Always call this function before using decoding routines (such as
4427 * @ref avcodec_receive_frame()).
4430 * avcodec_register_all();
4431 * av_dict_set(&opts, "b", "2.5M", 0);
4432 * codec = avcodec_find_decoder(AV_CODEC_ID_H264);
4436 * context = avcodec_alloc_context3(codec);
4438 * if (avcodec_open2(context, codec, opts) < 0)
4442 * @param avctx The context to initialize.
4443 * @param codec The codec to open this context for. If a non-NULL codec has been
4444 * previously passed to avcodec_alloc_context3() or
4445 * for this context, then this parameter MUST be either NULL or
4446 * equal to the previously passed codec.
4447 * @param options A dictionary filled with AVCodecContext and codec-private options.
4448 * On return this object will be filled with options that were not found.
4450 * @return zero on success, a negative value on error
4451 * @see avcodec_alloc_context3(), avcodec_find_decoder(), avcodec_find_encoder(),
4452 * av_dict_set(), av_opt_find().
4454 int avcodec_open2(AVCodecContext *avctx, const AVCodec *codec, AVDictionary **options);
4457 * Close a given AVCodecContext and free all the data associated with it
4458 * (but not the AVCodecContext itself).
4460 * Calling this function on an AVCodecContext that hasn't been opened will free
4461 * the codec-specific data allocated in avcodec_alloc_context3() with a non-NULL
4462 * codec. Subsequent calls will do nothing.
4464 * @note Do not use this function. Use avcodec_free_context() to destroy a
4465 * codec context (either open or closed). Opening and closing a codec context
4466 * multiple times is not supported anymore -- use multiple codec contexts
4469 int avcodec_close(AVCodecContext *avctx);
4472 * Free all allocated data in the given subtitle struct.
4474 * @param sub AVSubtitle to free.
4476 void avsubtitle_free(AVSubtitle *sub);
4483 * @addtogroup lavc_packet
4488 * Allocate an AVPacket and set its fields to default values. The resulting
4489 * struct must be freed using av_packet_free().
4491 * @return An AVPacket filled with default values or NULL on failure.
4493 * @note this only allocates the AVPacket itself, not the data buffers. Those
4494 * must be allocated through other means such as av_new_packet.
4496 * @see av_new_packet
4498 AVPacket *av_packet_alloc(void);
4501 * Create a new packet that references the same data as src.
4503 * This is a shortcut for av_packet_alloc()+av_packet_ref().
4505 * @return newly created AVPacket on success, NULL on error.
4507 * @see av_packet_alloc
4508 * @see av_packet_ref
4510 AVPacket *av_packet_clone(const AVPacket *src);
4513 * Free the packet, if the packet is reference counted, it will be
4514 * unreferenced first.
4516 * @param pkt packet to be freed. The pointer will be set to NULL.
4517 * @note passing NULL is a no-op.
4519 void av_packet_free(AVPacket **pkt);
4522 * Initialize optional fields of a packet with default values.
4524 * Note, this does not touch the data and size members, which have to be
4525 * initialized separately.
4529 void av_init_packet(AVPacket *pkt);
4532 * Allocate the payload of a packet and initialize its fields with
4536 * @param size wanted payload size
4537 * @return 0 if OK, AVERROR_xxx otherwise
4539 int av_new_packet(AVPacket *pkt, int size);
4542 * Reduce packet size, correctly zeroing padding
4545 * @param size new size
4547 void av_shrink_packet(AVPacket *pkt, int size);
4550 * Increase packet size, correctly zeroing padding
4553 * @param grow_by number of bytes by which to increase the size of the packet
4555 int av_grow_packet(AVPacket *pkt, int grow_by);
4558 * Initialize a reference-counted packet from av_malloc()ed data.
4560 * @param pkt packet to be initialized. This function will set the data, size,
4561 * buf and destruct fields, all others are left untouched.
4562 * @param data Data allocated by av_malloc() to be used as packet data. If this
4563 * function returns successfully, the data is owned by the underlying AVBuffer.
4564 * The caller may not access the data through other means.
4565 * @param size size of data in bytes, without the padding. I.e. the full buffer
4566 * size is assumed to be size + AV_INPUT_BUFFER_PADDING_SIZE.
4568 * @return 0 on success, a negative AVERROR on error
4570 int av_packet_from_data(AVPacket *pkt, uint8_t *data, int size);
4572 #if FF_API_AVPACKET_OLD_API
4574 * @warning This is a hack - the packet memory allocation stuff is broken. The
4575 * packet is allocated if it was not really allocated.
4577 * @deprecated Use av_packet_ref
4579 attribute_deprecated
4580 int av_dup_packet(AVPacket *pkt);
4582 * Copy packet, including contents
4584 * @return 0 on success, negative AVERROR on fail
4586 int av_copy_packet(AVPacket *dst, const AVPacket *src);
4589 * Copy packet side data
4591 * @return 0 on success, negative AVERROR on fail
4593 int av_copy_packet_side_data(AVPacket *dst, const AVPacket *src);
4598 * @deprecated Use av_packet_unref
4600 * @param pkt packet to free
4602 attribute_deprecated
4603 void av_free_packet(AVPacket *pkt);
4606 * Allocate new information of a packet.
4609 * @param type side information type
4610 * @param size side information size
4611 * @return pointer to fresh allocated data or NULL otherwise
4613 uint8_t* av_packet_new_side_data(AVPacket *pkt, enum AVPacketSideDataType type,
4617 * Wrap an existing array as a packet side data.
4620 * @param type side information type
4621 * @param data the side data array. It must be allocated with the av_malloc()
4622 * family of functions. The ownership of the data is transferred to
4624 * @param size side information size
4625 * @return a non-negative number on success, a negative AVERROR code on
4626 * failure. On failure, the packet is unchanged and the data remains
4627 * owned by the caller.
4629 int av_packet_add_side_data(AVPacket *pkt, enum AVPacketSideDataType type,
4630 uint8_t *data, size_t size);
4633 * Shrink the already allocated side data buffer
4636 * @param type side information type
4637 * @param size new side information size
4638 * @return 0 on success, < 0 on failure
4640 int av_packet_shrink_side_data(AVPacket *pkt, enum AVPacketSideDataType type,
4644 * Get side information from packet.
4647 * @param type desired side information type
4648 * @param size pointer for side information size to store (optional)
4649 * @return pointer to data if present or NULL otherwise
4651 uint8_t* av_packet_get_side_data(const AVPacket *pkt, enum AVPacketSideDataType type,
4654 #if FF_API_MERGE_SD_API
4655 attribute_deprecated
4656 int av_packet_merge_side_data(AVPacket *pkt);
4658 attribute_deprecated
4659 int av_packet_split_side_data(AVPacket *pkt);
4662 const char *av_packet_side_data_name(enum AVPacketSideDataType type);
4665 * Pack a dictionary for use in side_data.
4667 * @param dict The dictionary to pack.
4668 * @param size pointer to store the size of the returned data
4669 * @return pointer to data if successful, NULL otherwise
4671 uint8_t *av_packet_pack_dictionary(AVDictionary *dict, int *size);
4673 * Unpack a dictionary from side_data.
4675 * @param data data from side_data
4676 * @param size size of the data
4677 * @param dict the metadata storage dictionary
4678 * @return 0 on success, < 0 on failure
4680 int av_packet_unpack_dictionary(const uint8_t *data, int size, AVDictionary **dict);
4684 * Convenience function to free all the side data stored.
4685 * All the other fields stay untouched.
4689 void av_packet_free_side_data(AVPacket *pkt);
4692 * Setup a new reference to the data described by a given packet
4694 * If src is reference-counted, setup dst as a new reference to the
4695 * buffer in src. Otherwise allocate a new buffer in dst and copy the
4696 * data from src into it.
4698 * All the other fields are copied from src.
4700 * @see av_packet_unref
4702 * @param dst Destination packet
4703 * @param src Source packet
4705 * @return 0 on success, a negative AVERROR on error.
4707 int av_packet_ref(AVPacket *dst, const AVPacket *src);
4712 * Unreference the buffer referenced by the packet and reset the
4713 * remaining packet fields to their default values.
4715 * @param pkt The packet to be unreferenced.
4717 void av_packet_unref(AVPacket *pkt);
4720 * Move every field in src to dst and reset src.
4722 * @see av_packet_unref
4724 * @param src Source packet, will be reset
4725 * @param dst Destination packet
4727 void av_packet_move_ref(AVPacket *dst, AVPacket *src);
4730 * Copy only "properties" fields from src to dst.
4732 * Properties for the purpose of this function are all the fields
4733 * beside those related to the packet data (buf, data, size)
4735 * @param dst Destination packet
4736 * @param src Source packet
4738 * @return 0 on success AVERROR on failure.
4740 int av_packet_copy_props(AVPacket *dst, const AVPacket *src);
4743 * Convert valid timing fields (timestamps / durations) in a packet from one
4744 * timebase to another. Timestamps with unknown values (AV_NOPTS_VALUE) will be
4747 * @param pkt packet on which the conversion will be performed
4748 * @param tb_src source timebase, in which the timing fields in pkt are
4750 * @param tb_dst destination timebase, to which the timing fields will be
4753 void av_packet_rescale_ts(AVPacket *pkt, AVRational tb_src, AVRational tb_dst);
4760 * @addtogroup lavc_decoding
4765 * Find a registered decoder with a matching codec ID.
4767 * @param id AVCodecID of the requested decoder
4768 * @return A decoder if one was found, NULL otherwise.
4770 AVCodec *avcodec_find_decoder(enum AVCodecID id);
4773 * Find a registered decoder with the specified name.
4775 * @param name name of the requested decoder
4776 * @return A decoder if one was found, NULL otherwise.
4778 AVCodec *avcodec_find_decoder_by_name(const char *name);
4781 * The default callback for AVCodecContext.get_buffer2(). It is made public so
4782 * it can be called by custom get_buffer2() implementations for decoders without
4783 * AV_CODEC_CAP_DR1 set.
4785 int avcodec_default_get_buffer2(AVCodecContext *s, AVFrame *frame, int flags);
4789 * Return the amount of padding in pixels which the get_buffer callback must
4790 * provide around the edge of the image for codecs which do not have the
4791 * CODEC_FLAG_EMU_EDGE flag.
4793 * @return Required padding in pixels.
4795 * @deprecated CODEC_FLAG_EMU_EDGE is deprecated, so this function is no longer
4798 attribute_deprecated
4799 unsigned avcodec_get_edge_width(void);
4803 * Modify width and height values so that they will result in a memory
4804 * buffer that is acceptable for the codec if you do not use any horizontal
4807 * May only be used if a codec with AV_CODEC_CAP_DR1 has been opened.
4809 void avcodec_align_dimensions(AVCodecContext *s, int *width, int *height);
4812 * Modify width and height values so that they will result in a memory
4813 * buffer that is acceptable for the codec if you also ensure that all
4814 * line sizes are a multiple of the respective linesize_align[i].
4816 * May only be used if a codec with AV_CODEC_CAP_DR1 has been opened.
4818 void avcodec_align_dimensions2(AVCodecContext *s, int *width, int *height,
4819 int linesize_align[AV_NUM_DATA_POINTERS]);
4822 * Converts AVChromaLocation to swscale x/y chroma position.
4824 * The positions represent the chroma (0,0) position in a coordinates system
4825 * with luma (0,0) representing the origin and luma(1,1) representing 256,256
4827 * @param xpos horizontal chroma sample position
4828 * @param ypos vertical chroma sample position
4830 int avcodec_enum_to_chroma_pos(int *xpos, int *ypos, enum AVChromaLocation pos);
4833 * Converts swscale x/y chroma position to AVChromaLocation.
4835 * The positions represent the chroma (0,0) position in a coordinates system
4836 * with luma (0,0) representing the origin and luma(1,1) representing 256,256
4838 * @param xpos horizontal chroma sample position
4839 * @param ypos vertical chroma sample position
4841 enum AVChromaLocation avcodec_chroma_pos_to_enum(int xpos, int ypos);
4844 * Decode the audio frame of size avpkt->size from avpkt->data into frame.
4846 * Some decoders may support multiple frames in a single AVPacket. Such
4847 * decoders would then just decode the first frame and the return value would be
4848 * less than the packet size. In this case, avcodec_decode_audio4 has to be
4849 * called again with an AVPacket containing the remaining data in order to
4850 * decode the second frame, etc... Even if no frames are returned, the packet
4851 * needs to be fed to the decoder with remaining data until it is completely
4852 * consumed or an error occurs.
4854 * Some decoders (those marked with AV_CODEC_CAP_DELAY) have a delay between input
4855 * and output. This means that for some packets they will not immediately
4856 * produce decoded output and need to be flushed at the end of decoding to get
4857 * all the decoded data. Flushing is done by calling this function with packets
4858 * with avpkt->data set to NULL and avpkt->size set to 0 until it stops
4859 * returning samples. It is safe to flush even those decoders that are not
4860 * marked with AV_CODEC_CAP_DELAY, then no samples will be returned.
4862 * @warning The input buffer, avpkt->data must be AV_INPUT_BUFFER_PADDING_SIZE
4863 * larger than the actual read bytes because some optimized bitstream
4864 * readers read 32 or 64 bits at once and could read over the end.
4866 * @note The AVCodecContext MUST have been opened with @ref avcodec_open2()
4867 * before packets may be fed to the decoder.
4869 * @param avctx the codec context
4870 * @param[out] frame The AVFrame in which to store decoded audio samples.
4871 * The decoder will allocate a buffer for the decoded frame by
4872 * calling the AVCodecContext.get_buffer2() callback.
4873 * When AVCodecContext.refcounted_frames is set to 1, the frame is
4874 * reference counted and the returned reference belongs to the
4875 * caller. The caller must release the frame using av_frame_unref()
4876 * when the frame is no longer needed. The caller may safely write
4877 * to the frame if av_frame_is_writable() returns 1.
4878 * When AVCodecContext.refcounted_frames is set to 0, the returned
4879 * reference belongs to the decoder and is valid only until the
4880 * next call to this function or until closing or flushing the
4881 * decoder. The caller may not write to it.
4882 * @param[out] got_frame_ptr Zero if no frame could be decoded, otherwise it is
4883 * non-zero. Note that this field being set to zero
4884 * does not mean that an error has occurred. For
4885 * decoders with AV_CODEC_CAP_DELAY set, no given decode
4886 * call is guaranteed to produce a frame.
4887 * @param[in] avpkt The input AVPacket containing the input buffer.
4888 * At least avpkt->data and avpkt->size should be set. Some
4889 * decoders might also require additional fields to be set.
4890 * @return A negative error code is returned if an error occurred during
4891 * decoding, otherwise the number of bytes consumed from the input
4892 * AVPacket is returned.
4894 * @deprecated Use avcodec_send_packet() and avcodec_receive_frame().
4896 attribute_deprecated
4897 int avcodec_decode_audio4(AVCodecContext *avctx, AVFrame *frame,
4898 int *got_frame_ptr, const AVPacket *avpkt);
4901 * Decode the video frame of size avpkt->size from avpkt->data into picture.
4902 * Some decoders may support multiple frames in a single AVPacket, such
4903 * decoders would then just decode the first frame.
4905 * @warning The input buffer must be AV_INPUT_BUFFER_PADDING_SIZE larger than
4906 * the actual read bytes because some optimized bitstream readers read 32 or 64
4907 * bits at once and could read over the end.
4909 * @warning The end of the input buffer buf should be set to 0 to ensure that
4910 * no overreading happens for damaged MPEG streams.
4912 * @note Codecs which have the AV_CODEC_CAP_DELAY capability set have a delay
4913 * between input and output, these need to be fed with avpkt->data=NULL,
4914 * avpkt->size=0 at the end to return the remaining frames.
4916 * @note The AVCodecContext MUST have been opened with @ref avcodec_open2()
4917 * before packets may be fed to the decoder.
4919 * @param avctx the codec context
4920 * @param[out] picture The AVFrame in which the decoded video frame will be stored.
4921 * Use av_frame_alloc() to get an AVFrame. The codec will
4922 * allocate memory for the actual bitmap by calling the
4923 * AVCodecContext.get_buffer2() callback.
4924 * When AVCodecContext.refcounted_frames is set to 1, the frame is
4925 * reference counted and the returned reference belongs to the
4926 * caller. The caller must release the frame using av_frame_unref()
4927 * when the frame is no longer needed. The caller may safely write
4928 * to the frame if av_frame_is_writable() returns 1.
4929 * When AVCodecContext.refcounted_frames is set to 0, the returned
4930 * reference belongs to the decoder and is valid only until the
4931 * next call to this function or until closing or flushing the
4932 * decoder. The caller may not write to it.
4934 * @param[in] avpkt The input AVPacket containing the input buffer.
4935 * You can create such packet with av_init_packet() and by then setting
4936 * data and size, some decoders might in addition need other fields like
4937 * flags&AV_PKT_FLAG_KEY. All decoders are designed to use the least
4939 * @param[in,out] got_picture_ptr Zero if no frame could be decompressed, otherwise, it is nonzero.
4940 * @return On error a negative value is returned, otherwise the number of bytes
4941 * used or zero if no frame could be decompressed.
4943 * @deprecated Use avcodec_send_packet() and avcodec_receive_frame().
4945 attribute_deprecated
4946 int avcodec_decode_video2(AVCodecContext *avctx, AVFrame *picture,
4947 int *got_picture_ptr,
4948 const AVPacket *avpkt);
4951 * Decode a subtitle message.
4952 * Return a negative value on error, otherwise return the number of bytes used.
4953 * If no subtitle could be decompressed, got_sub_ptr is zero.
4954 * Otherwise, the subtitle is stored in *sub.
4955 * Note that AV_CODEC_CAP_DR1 is not available for subtitle codecs. This is for
4956 * simplicity, because the performance difference is expect to be negligible
4957 * and reusing a get_buffer written for video codecs would probably perform badly
4958 * due to a potentially very different allocation pattern.
4960 * Some decoders (those marked with AV_CODEC_CAP_DELAY) have a delay between input
4961 * and output. This means that for some packets they will not immediately
4962 * produce decoded output and need to be flushed at the end of decoding to get
4963 * all the decoded data. Flushing is done by calling this function with packets
4964 * with avpkt->data set to NULL and avpkt->size set to 0 until it stops
4965 * returning subtitles. It is safe to flush even those decoders that are not
4966 * marked with AV_CODEC_CAP_DELAY, then no subtitles will be returned.
4968 * @note The AVCodecContext MUST have been opened with @ref avcodec_open2()
4969 * before packets may be fed to the decoder.
4971 * @param avctx the codec context
4972 * @param[out] sub The Preallocated AVSubtitle in which the decoded subtitle will be stored,
4973 * must be freed with avsubtitle_free if *got_sub_ptr is set.
4974 * @param[in,out] got_sub_ptr Zero if no subtitle could be decompressed, otherwise, it is nonzero.
4975 * @param[in] avpkt The input AVPacket containing the input buffer.
4977 int avcodec_decode_subtitle2(AVCodecContext *avctx, AVSubtitle *sub,
4982 * Supply raw packet data as input to a decoder.
4984 * Internally, this call will copy relevant AVCodecContext fields, which can
4985 * influence decoding per-packet, and apply them when the packet is actually
4986 * decoded. (For example AVCodecContext.skip_frame, which might direct the
4987 * decoder to drop the frame contained by the packet sent with this function.)
4989 * @warning The input buffer, avpkt->data must be AV_INPUT_BUFFER_PADDING_SIZE
4990 * larger than the actual read bytes because some optimized bitstream
4991 * readers read 32 or 64 bits at once and could read over the end.
4993 * @warning Do not mix this API with the legacy API (like avcodec_decode_video2())
4994 * on the same AVCodecContext. It will return unexpected results now
4995 * or in future libavcodec versions.
4997 * @note The AVCodecContext MUST have been opened with @ref avcodec_open2()
4998 * before packets may be fed to the decoder.
5000 * @param avctx codec context
5001 * @param[in] avpkt The input AVPacket. Usually, this will be a single video
5002 * frame, or several complete audio frames.
5003 * Ownership of the packet remains with the caller, and the
5004 * decoder will not write to the packet. The decoder may create
5005 * a reference to the packet data (or copy it if the packet is
5006 * not reference-counted).
5007 * Unlike with older APIs, the packet is always fully consumed,
5008 * and if it contains multiple frames (e.g. some audio codecs),
5009 * will require you to call avcodec_receive_frame() multiple
5010 * times afterwards before you can send a new packet.
5011 * It can be NULL (or an AVPacket with data set to NULL and
5012 * size set to 0); in this case, it is considered a flush
5013 * packet, which signals the end of the stream. Sending the
5014 * first flush packet will return success. Subsequent ones are
5015 * unnecessary and will return AVERROR_EOF. If the decoder
5016 * still has frames buffered, it will return them after sending
5019 * @return 0 on success, otherwise negative error code:
5020 * AVERROR(EAGAIN): input is not accepted in the current state - user
5021 * must read output with avcodec_receive_frame() (once
5022 * all output is read, the packet should be resent, and
5023 * the call will not fail with EAGAIN).
5024 * AVERROR_EOF: the decoder has been flushed, and no new packets can
5025 * be sent to it (also returned if more than 1 flush
5027 * AVERROR(EINVAL): codec not opened, it is an encoder, or requires flush
5028 * AVERROR(ENOMEM): failed to add packet to internal queue, or similar
5029 * other errors: legitimate decoding errors
5031 int avcodec_send_packet(AVCodecContext *avctx, const AVPacket *avpkt);
5034 * Return decoded output data from a decoder.
5036 * @param avctx codec context
5037 * @param frame This will be set to a reference-counted video or audio
5038 * frame (depending on the decoder type) allocated by the
5039 * decoder. Note that the function will always call
5040 * av_frame_unref(frame) before doing anything else.
5043 * 0: success, a frame was returned
5044 * AVERROR(EAGAIN): output is not available in this state - user must try
5046 * AVERROR_EOF: the decoder has been fully flushed, and there will be
5047 * no more output frames
5048 * AVERROR(EINVAL): codec not opened, or it is an encoder
5049 * other negative values: legitimate decoding errors
5051 int avcodec_receive_frame(AVCodecContext *avctx, AVFrame *frame);
5054 * Supply a raw video or audio frame to the encoder. Use avcodec_receive_packet()
5055 * to retrieve buffered output packets.
5057 * @param avctx codec context
5058 * @param[in] frame AVFrame containing the raw audio or video frame to be encoded.
5059 * Ownership of the frame remains with the caller, and the
5060 * encoder will not write to the frame. The encoder may create
5061 * a reference to the frame data (or copy it if the frame is
5062 * not reference-counted).
5063 * It can be NULL, in which case it is considered a flush
5064 * packet. This signals the end of the stream. If the encoder
5065 * still has packets buffered, it will return them after this
5066 * call. Once flushing mode has been entered, additional flush
5067 * packets are ignored, and sending frames will return
5071 * If AV_CODEC_CAP_VARIABLE_FRAME_SIZE is set, then each frame
5072 * can have any number of samples.
5073 * If it is not set, frame->nb_samples must be equal to
5074 * avctx->frame_size for all frames except the last.
5075 * The final frame may be smaller than avctx->frame_size.
5076 * @return 0 on success, otherwise negative error code:
5077 * AVERROR(EAGAIN): input is not accepted in the current state - user
5078 * must read output with avcodec_receive_packet() (once
5079 * all output is read, the packet should be resent, and
5080 * the call will not fail with EAGAIN).
5081 * AVERROR_EOF: the encoder has been flushed, and no new frames can
5083 * AVERROR(EINVAL): codec not opened, refcounted_frames not set, it is a
5084 * decoder, or requires flush
5085 * AVERROR(ENOMEM): failed to add packet to internal queue, or similar
5086 * other errors: legitimate decoding errors
5088 int avcodec_send_frame(AVCodecContext *avctx, const AVFrame *frame);
5091 * Read encoded data from the encoder.
5093 * @param avctx codec context
5094 * @param avpkt This will be set to a reference-counted packet allocated by the
5095 * encoder. Note that the function will always call
5096 * av_frame_unref(frame) before doing anything else.
5097 * @return 0 on success, otherwise negative error code:
5098 * AVERROR(EAGAIN): output is not available in the current state - user
5099 * must try to send input
5100 * AVERROR_EOF: the encoder has been fully flushed, and there will be
5101 * no more output packets
5102 * AVERROR(EINVAL): codec not opened, or it is an encoder
5103 * other errors: legitimate decoding errors
5105 int avcodec_receive_packet(AVCodecContext *avctx, AVPacket *avpkt);
5109 * @defgroup lavc_parsing Frame parsing
5113 enum AVPictureStructure {
5114 AV_PICTURE_STRUCTURE_UNKNOWN, //< unknown
5115 AV_PICTURE_STRUCTURE_TOP_FIELD, //< coded as top field
5116 AV_PICTURE_STRUCTURE_BOTTOM_FIELD, //< coded as bottom field
5117 AV_PICTURE_STRUCTURE_FRAME, //< coded as frame
5120 typedef struct AVCodecParserContext {
5122 struct AVCodecParser *parser;
5123 int64_t frame_offset; /* offset of the current frame */
5124 int64_t cur_offset; /* current offset
5125 (incremented by each av_parser_parse()) */
5126 int64_t next_frame_offset; /* offset of the next frame */
5128 int pict_type; /* XXX: Put it back in AVCodecContext. */
5130 * This field is used for proper frame duration computation in lavf.
5131 * It signals, how much longer the frame duration of the current frame
5132 * is compared to normal frame duration.
5134 * frame_duration = (1 + repeat_pict) * time_base
5136 * It is used by codecs like H.264 to display telecined material.
5138 int repeat_pict; /* XXX: Put it back in AVCodecContext. */
5139 int64_t pts; /* pts of the current frame */
5140 int64_t dts; /* dts of the current frame */
5145 int fetch_timestamp;
5147 #define AV_PARSER_PTS_NB 4
5148 int cur_frame_start_index;
5149 int64_t cur_frame_offset[AV_PARSER_PTS_NB];
5150 int64_t cur_frame_pts[AV_PARSER_PTS_NB];
5151 int64_t cur_frame_dts[AV_PARSER_PTS_NB];
5154 #define PARSER_FLAG_COMPLETE_FRAMES 0x0001
5155 #define PARSER_FLAG_ONCE 0x0002
5156 /// Set if the parser has a valid file offset
5157 #define PARSER_FLAG_FETCHED_OFFSET 0x0004
5158 #define PARSER_FLAG_USE_CODEC_TS 0x1000
5160 int64_t offset; ///< byte offset from starting packet start
5161 int64_t cur_frame_end[AV_PARSER_PTS_NB];
5164 * Set by parser to 1 for key frames and 0 for non-key frames.
5165 * It is initialized to -1, so if the parser doesn't set this flag,
5166 * old-style fallback using AV_PICTURE_TYPE_I picture type as key frames
5171 #if FF_API_CONVERGENCE_DURATION
5173 * @deprecated unused
5175 attribute_deprecated
5176 int64_t convergence_duration;
5179 // Timestamp generation support:
5181 * Synchronization point for start of timestamp generation.
5183 * Set to >0 for sync point, 0 for no sync point and <0 for undefined
5186 * For example, this corresponds to presence of H.264 buffering period
5192 * Offset of the current timestamp against last timestamp sync point in
5193 * units of AVCodecContext.time_base.
5195 * Set to INT_MIN when dts_sync_point unused. Otherwise, it must
5196 * contain a valid timestamp offset.
5198 * Note that the timestamp of sync point has usually a nonzero
5199 * dts_ref_dts_delta, which refers to the previous sync point. Offset of
5200 * the next frame after timestamp sync point will be usually 1.
5202 * For example, this corresponds to H.264 cpb_removal_delay.
5204 int dts_ref_dts_delta;
5207 * Presentation delay of current frame in units of AVCodecContext.time_base.
5209 * Set to INT_MIN when dts_sync_point unused. Otherwise, it must
5210 * contain valid non-negative timestamp delta (presentation time of a frame
5211 * must not lie in the past).
5213 * This delay represents the difference between decoding and presentation
5214 * time of the frame.
5216 * For example, this corresponds to H.264 dpb_output_delay.
5221 * Position of the packet in file.
5223 * Analogous to cur_frame_pts/dts
5225 int64_t cur_frame_pos[AV_PARSER_PTS_NB];
5228 * Byte position of currently parsed frame in stream.
5233 * Previous frame byte position.
5238 * Duration of the current frame.
5239 * For audio, this is in units of 1 / AVCodecContext.sample_rate.
5240 * For all other types, this is in units of AVCodecContext.time_base.
5244 enum AVFieldOrder field_order;
5247 * Indicate whether a picture is coded as a frame, top field or bottom field.
5249 * For example, H.264 field_pic_flag equal to 0 corresponds to
5250 * AV_PICTURE_STRUCTURE_FRAME. An H.264 picture with field_pic_flag
5251 * equal to 1 and bottom_field_flag equal to 0 corresponds to
5252 * AV_PICTURE_STRUCTURE_TOP_FIELD.
5254 enum AVPictureStructure picture_structure;
5257 * Picture number incremented in presentation or output order.
5258 * This field may be reinitialized at the first picture of a new sequence.
5260 * For example, this corresponds to H.264 PicOrderCnt.
5262 int output_picture_number;
5265 * Dimensions of the decoded video intended for presentation.
5271 * Dimensions of the coded video.
5277 * The format of the coded data, corresponds to enum AVPixelFormat for video
5278 * and for enum AVSampleFormat for audio.
5280 * Note that a decoder can have considerable freedom in how exactly it
5281 * decodes the data, so the format reported here might be different from the
5282 * one returned by a decoder.
5285 } AVCodecParserContext;
5287 typedef struct AVCodecParser {
5288 int codec_ids[5]; /* several codec IDs are permitted */
5290 int (*parser_init)(AVCodecParserContext *s);
5291 /* This callback never returns an error, a negative value means that
5292 * the frame start was in a previous packet. */
5293 int (*parser_parse)(AVCodecParserContext *s,
5294 AVCodecContext *avctx,
5295 const uint8_t **poutbuf, int *poutbuf_size,
5296 const uint8_t *buf, int buf_size);
5297 void (*parser_close)(AVCodecParserContext *s);
5298 int (*split)(AVCodecContext *avctx, const uint8_t *buf, int buf_size);
5299 struct AVCodecParser *next;
5302 AVCodecParser *av_parser_next(const AVCodecParser *c);
5304 void av_register_codec_parser(AVCodecParser *parser);
5305 AVCodecParserContext *av_parser_init(int codec_id);
5310 * @param s parser context.
5311 * @param avctx codec context.
5312 * @param poutbuf set to pointer to parsed buffer or NULL if not yet finished.
5313 * @param poutbuf_size set to size of parsed buffer or zero if not yet finished.
5314 * @param buf input buffer.
5315 * @param buf_size buffer size in bytes without the padding. I.e. the full buffer
5316 size is assumed to be buf_size + AV_INPUT_BUFFER_PADDING_SIZE.
5317 To signal EOF, this should be 0 (so that the last frame
5319 * @param pts input presentation timestamp.
5320 * @param dts input decoding timestamp.
5321 * @param pos input byte position in stream.
5322 * @return the number of bytes of the input bitstream used.
5327 * len = av_parser_parse2(myparser, AVCodecContext, &data, &size,
5334 * decode_frame(data, size);
5338 int av_parser_parse2(AVCodecParserContext *s,
5339 AVCodecContext *avctx,
5340 uint8_t **poutbuf, int *poutbuf_size,
5341 const uint8_t *buf, int buf_size,
5342 int64_t pts, int64_t dts,
5346 * @return 0 if the output buffer is a subset of the input, 1 if it is allocated and must be freed
5347 * @deprecated use AVBitStreamFilter
5349 int av_parser_change(AVCodecParserContext *s,
5350 AVCodecContext *avctx,
5351 uint8_t **poutbuf, int *poutbuf_size,
5352 const uint8_t *buf, int buf_size, int keyframe);
5353 void av_parser_close(AVCodecParserContext *s);
5361 * @addtogroup lavc_encoding
5366 * Find a registered encoder with a matching codec ID.
5368 * @param id AVCodecID of the requested encoder
5369 * @return An encoder if one was found, NULL otherwise.
5371 AVCodec *avcodec_find_encoder(enum AVCodecID id);
5374 * Find a registered encoder with the specified name.
5376 * @param name name of the requested encoder
5377 * @return An encoder if one was found, NULL otherwise.
5379 AVCodec *avcodec_find_encoder_by_name(const char *name);
5382 * Encode a frame of audio.
5384 * Takes input samples from frame and writes the next output packet, if
5385 * available, to avpkt. The output packet does not necessarily contain data for
5386 * the most recent frame, as encoders can delay, split, and combine input frames
5387 * internally as needed.
5389 * @param avctx codec context
5390 * @param avpkt output AVPacket.
5391 * The user can supply an output buffer by setting
5392 * avpkt->data and avpkt->size prior to calling the
5393 * function, but if the size of the user-provided data is not
5394 * large enough, encoding will fail. If avpkt->data and
5395 * avpkt->size are set, avpkt->destruct must also be set. All
5396 * other AVPacket fields will be reset by the encoder using
5397 * av_init_packet(). If avpkt->data is NULL, the encoder will
5398 * allocate it. The encoder will set avpkt->size to the size
5399 * of the output packet.
5401 * If this function fails or produces no output, avpkt will be
5402 * freed using av_packet_unref().
5403 * @param[in] frame AVFrame containing the raw audio data to be encoded.
5404 * May be NULL when flushing an encoder that has the
5405 * AV_CODEC_CAP_DELAY capability set.
5406 * If AV_CODEC_CAP_VARIABLE_FRAME_SIZE is set, then each frame
5407 * can have any number of samples.
5408 * If it is not set, frame->nb_samples must be equal to
5409 * avctx->frame_size for all frames except the last.
5410 * The final frame may be smaller than avctx->frame_size.
5411 * @param[out] got_packet_ptr This field is set to 1 by libavcodec if the
5412 * output packet is non-empty, and to 0 if it is
5413 * empty. If the function returns an error, the
5414 * packet can be assumed to be invalid, and the
5415 * value of got_packet_ptr is undefined and should
5417 * @return 0 on success, negative error code on failure
5419 * @deprecated use avcodec_send_frame()/avcodec_receive_packet() instead
5421 attribute_deprecated
5422 int avcodec_encode_audio2(AVCodecContext *avctx, AVPacket *avpkt,
5423 const AVFrame *frame, int *got_packet_ptr);
5426 * Encode a frame of video.
5428 * Takes input raw video data from frame and writes the next output packet, if
5429 * available, to avpkt. The output packet does not necessarily contain data for
5430 * the most recent frame, as encoders can delay and reorder input frames
5431 * internally as needed.
5433 * @param avctx codec context
5434 * @param avpkt output AVPacket.
5435 * The user can supply an output buffer by setting
5436 * avpkt->data and avpkt->size prior to calling the
5437 * function, but if the size of the user-provided data is not
5438 * large enough, encoding will fail. All other AVPacket fields
5439 * will be reset by the encoder using av_init_packet(). If
5440 * avpkt->data is NULL, the encoder will allocate it.
5441 * The encoder will set avpkt->size to the size of the
5442 * output packet. The returned data (if any) belongs to the
5443 * caller, he is responsible for freeing it.
5445 * If this function fails or produces no output, avpkt will be
5446 * freed using av_packet_unref().
5447 * @param[in] frame AVFrame containing the raw video data to be encoded.
5448 * May be NULL when flushing an encoder that has the
5449 * AV_CODEC_CAP_DELAY capability set.
5450 * @param[out] got_packet_ptr This field is set to 1 by libavcodec if the
5451 * output packet is non-empty, and to 0 if it is
5452 * empty. If the function returns an error, the
5453 * packet can be assumed to be invalid, and the
5454 * value of got_packet_ptr is undefined and should
5456 * @return 0 on success, negative error code on failure
5458 * @deprecated use avcodec_send_frame()/avcodec_receive_packet() instead
5460 attribute_deprecated
5461 int avcodec_encode_video2(AVCodecContext *avctx, AVPacket *avpkt,
5462 const AVFrame *frame, int *got_packet_ptr);
5464 int avcodec_encode_subtitle(AVCodecContext *avctx, uint8_t *buf, int buf_size,
5465 const AVSubtitle *sub);
5472 #if FF_API_AVCODEC_RESAMPLE
5474 * @defgroup lavc_resample Audio resampling
5476 * @deprecated use libswresample instead
5480 struct ReSampleContext;
5481 struct AVResampleContext;
5483 typedef struct ReSampleContext ReSampleContext;
5486 * Initialize audio resampling context.
5488 * @param output_channels number of output channels
5489 * @param input_channels number of input channels
5490 * @param output_rate output sample rate
5491 * @param input_rate input sample rate
5492 * @param sample_fmt_out requested output sample format
5493 * @param sample_fmt_in input sample format
5494 * @param filter_length length of each FIR filter in the filterbank relative to the cutoff frequency
5495 * @param log2_phase_count log2 of the number of entries in the polyphase filterbank
5496 * @param linear if 1 then the used FIR filter will be linearly interpolated
5497 between the 2 closest, if 0 the closest will be used
5498 * @param cutoff cutoff frequency, 1.0 corresponds to half the output sampling rate
5499 * @return allocated ReSampleContext, NULL if error occurred
5501 attribute_deprecated
5502 ReSampleContext *av_audio_resample_init(int output_channels, int input_channels,
5503 int output_rate, int input_rate,
5504 enum AVSampleFormat sample_fmt_out,
5505 enum AVSampleFormat sample_fmt_in,
5506 int filter_length, int log2_phase_count,
5507 int linear, double cutoff);
5509 attribute_deprecated
5510 int audio_resample(ReSampleContext *s, short *output, short *input, int nb_samples);
5513 * Free resample context.
5515 * @param s a non-NULL pointer to a resample context previously
5516 * created with av_audio_resample_init()
5518 attribute_deprecated
5519 void audio_resample_close(ReSampleContext *s);
5523 * Initialize an audio resampler.
5524 * Note, if either rate is not an integer then simply scale both rates up so they are.
5525 * @param filter_length length of each FIR filter in the filterbank relative to the cutoff freq
5526 * @param log2_phase_count log2 of the number of entries in the polyphase filterbank
5527 * @param linear If 1 then the used FIR filter will be linearly interpolated
5528 between the 2 closest, if 0 the closest will be used
5529 * @param cutoff cutoff frequency, 1.0 corresponds to half the output sampling rate
5531 attribute_deprecated
5532 struct AVResampleContext *av_resample_init(int out_rate, int in_rate, int filter_length, int log2_phase_count, int linear, double cutoff);
5535 * Resample an array of samples using a previously configured context.
5536 * @param src an array of unconsumed samples
5537 * @param consumed the number of samples of src which have been consumed are returned here
5538 * @param src_size the number of unconsumed samples available
5539 * @param dst_size the amount of space in samples available in dst
5540 * @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.
5541 * @return the number of samples written in dst or -1 if an error occurred
5543 attribute_deprecated
5544 int av_resample(struct AVResampleContext *c, short *dst, short *src, int *consumed, int src_size, int dst_size, int update_ctx);
5548 * Compensate samplerate/timestamp drift. The compensation is done by changing
5549 * the resampler parameters, so no audible clicks or similar distortions occur
5550 * @param compensation_distance distance in output samples over which the compensation should be performed
5551 * @param sample_delta number of output samples which should be output less
5553 * example: av_resample_compensate(c, 10, 500)
5554 * here instead of 510 samples only 500 samples would be output
5556 * note, due to rounding the actual compensation might be slightly different,
5557 * especially if the compensation_distance is large and the in_rate used during init is small
5559 attribute_deprecated
5560 void av_resample_compensate(struct AVResampleContext *c, int sample_delta, int compensation_distance);
5561 attribute_deprecated
5562 void av_resample_close(struct AVResampleContext *c);
5569 #if FF_API_AVPICTURE
5571 * @addtogroup lavc_picture
5576 * @deprecated unused
5578 attribute_deprecated
5579 int avpicture_alloc(AVPicture *picture, enum AVPixelFormat pix_fmt, int width, int height);
5582 * @deprecated unused
5584 attribute_deprecated
5585 void avpicture_free(AVPicture *picture);
5588 * @deprecated use av_image_fill_arrays() instead.
5590 attribute_deprecated
5591 int avpicture_fill(AVPicture *picture, const uint8_t *ptr,
5592 enum AVPixelFormat pix_fmt, int width, int height);
5595 * @deprecated use av_image_copy_to_buffer() instead.
5597 attribute_deprecated
5598 int avpicture_layout(const AVPicture *src, enum AVPixelFormat pix_fmt,
5599 int width, int height,
5600 unsigned char *dest, int dest_size);
5603 * @deprecated use av_image_get_buffer_size() instead.
5605 attribute_deprecated
5606 int avpicture_get_size(enum AVPixelFormat pix_fmt, int width, int height);
5609 * @deprecated av_image_copy() instead.
5611 attribute_deprecated
5612 void av_picture_copy(AVPicture *dst, const AVPicture *src,
5613 enum AVPixelFormat pix_fmt, int width, int height);
5616 * @deprecated unused
5618 attribute_deprecated
5619 int av_picture_crop(AVPicture *dst, const AVPicture *src,
5620 enum AVPixelFormat pix_fmt, int top_band, int left_band);
5623 * @deprecated unused
5625 attribute_deprecated
5626 int av_picture_pad(AVPicture *dst, const AVPicture *src, int height, int width, enum AVPixelFormat pix_fmt,
5627 int padtop, int padbottom, int padleft, int padright, int *color);
5635 * @defgroup lavc_misc Utility functions
5638 * Miscellaneous utility functions related to both encoding and decoding
5644 * @defgroup lavc_misc_pixfmt Pixel formats
5646 * Functions for working with pixel formats.
5651 * Utility function to access log2_chroma_w log2_chroma_h from
5652 * the pixel format AVPixFmtDescriptor.
5654 * This function asserts that pix_fmt is valid. See av_pix_fmt_get_chroma_sub_sample
5655 * for one that returns a failure code and continues in case of invalid
5658 * @param[in] pix_fmt the pixel format
5659 * @param[out] h_shift store log2_chroma_w
5660 * @param[out] v_shift store log2_chroma_h
5662 * @see av_pix_fmt_get_chroma_sub_sample
5665 void avcodec_get_chroma_sub_sample(enum AVPixelFormat pix_fmt, int *h_shift, int *v_shift);
5668 * Return a value representing the fourCC code associated to the
5669 * pixel format pix_fmt, or 0 if no associated fourCC code can be
5672 unsigned int avcodec_pix_fmt_to_codec_tag(enum AVPixelFormat pix_fmt);
5675 * @deprecated see av_get_pix_fmt_loss()
5677 int avcodec_get_pix_fmt_loss(enum AVPixelFormat dst_pix_fmt, enum AVPixelFormat src_pix_fmt,
5681 * Find the best pixel format to convert to given a certain source pixel
5682 * format. When converting from one pixel format to another, information loss
5683 * may occur. For example, when converting from RGB24 to GRAY, the color
5684 * information will be lost. Similarly, other losses occur when converting from
5685 * some formats to other formats. avcodec_find_best_pix_fmt_of_2() searches which of
5686 * the given pixel formats should be used to suffer the least amount of loss.
5687 * The pixel formats from which it chooses one, are determined by the
5688 * pix_fmt_list parameter.
5691 * @param[in] pix_fmt_list AV_PIX_FMT_NONE terminated array of pixel formats to choose from
5692 * @param[in] src_pix_fmt source pixel format
5693 * @param[in] has_alpha Whether the source pixel format alpha channel is used.
5694 * @param[out] loss_ptr Combination of flags informing you what kind of losses will occur.
5695 * @return The best pixel format to convert to or -1 if none was found.
5697 enum AVPixelFormat avcodec_find_best_pix_fmt_of_list(const enum AVPixelFormat *pix_fmt_list,
5698 enum AVPixelFormat src_pix_fmt,
5699 int has_alpha, int *loss_ptr);
5702 * @deprecated see av_find_best_pix_fmt_of_2()
5704 enum AVPixelFormat avcodec_find_best_pix_fmt_of_2(enum AVPixelFormat dst_pix_fmt1, enum AVPixelFormat dst_pix_fmt2,
5705 enum AVPixelFormat src_pix_fmt, int has_alpha, int *loss_ptr);
5707 attribute_deprecated
5708 enum AVPixelFormat avcodec_find_best_pix_fmt2(enum AVPixelFormat dst_pix_fmt1, enum AVPixelFormat dst_pix_fmt2,
5709 enum AVPixelFormat src_pix_fmt, int has_alpha, int *loss_ptr);
5711 enum AVPixelFormat avcodec_default_get_format(struct AVCodecContext *s, const enum AVPixelFormat * fmt);
5717 #if FF_API_SET_DIMENSIONS
5719 * @deprecated this function is not supposed to be used from outside of lavc
5721 attribute_deprecated
5722 void avcodec_set_dimensions(AVCodecContext *s, int width, int height);
5725 #if FF_API_TAG_STRING
5727 * Put a string representing the codec tag codec_tag in buf.
5729 * @param buf buffer to place codec tag in
5730 * @param buf_size size in bytes of buf
5731 * @param codec_tag codec tag to assign
5732 * @return the length of the string that would have been generated if
5733 * enough space had been available, excluding the trailing null
5735 * @deprecated see av_fourcc_make_string() and av_fourcc2str().
5737 attribute_deprecated
5738 size_t av_get_codec_tag_string(char *buf, size_t buf_size, unsigned int codec_tag);
5741 void avcodec_string(char *buf, int buf_size, AVCodecContext *enc, int encode);
5744 * Return a name for the specified profile, if available.
5746 * @param codec the codec that is searched for the given profile
5747 * @param profile the profile value for which a name is requested
5748 * @return A name for the profile if found, NULL otherwise.
5750 const char *av_get_profile_name(const AVCodec *codec, int profile);
5753 * Return a name for the specified profile, if available.
5755 * @param codec_id the ID of the codec to which the requested profile belongs
5756 * @param profile the profile value for which a name is requested
5757 * @return A name for the profile if found, NULL otherwise.
5759 * @note unlike av_get_profile_name(), which searches a list of profiles
5760 * supported by a specific decoder or encoder implementation, this
5761 * function searches the list of profiles from the AVCodecDescriptor
5763 const char *avcodec_profile_name(enum AVCodecID codec_id, int profile);
5765 int avcodec_default_execute(AVCodecContext *c, int (*func)(AVCodecContext *c2, void *arg2),void *arg, int *ret, int count, int size);
5766 int avcodec_default_execute2(AVCodecContext *c, int (*func)(AVCodecContext *c2, void *arg2, int, int),void *arg, int *ret, int count);
5767 //FIXME func typedef
5770 * Fill AVFrame audio data and linesize pointers.
5772 * The buffer buf must be a preallocated buffer with a size big enough
5773 * to contain the specified samples amount. The filled AVFrame data
5774 * pointers will point to this buffer.
5776 * AVFrame extended_data channel pointers are allocated if necessary for
5779 * @param frame the AVFrame
5780 * frame->nb_samples must be set prior to calling the
5781 * function. This function fills in frame->data,
5782 * frame->extended_data, frame->linesize[0].
5783 * @param nb_channels channel count
5784 * @param sample_fmt sample format
5785 * @param buf buffer to use for frame data
5786 * @param buf_size size of buffer
5787 * @param align plane size sample alignment (0 = default)
5788 * @return >=0 on success, negative error code on failure
5789 * @todo return the size in bytes required to store the samples in
5790 * case of success, at the next libavutil bump
5792 int avcodec_fill_audio_frame(AVFrame *frame, int nb_channels,
5793 enum AVSampleFormat sample_fmt, const uint8_t *buf,
5794 int buf_size, int align);
5797 * Reset the internal decoder state / flush internal buffers. Should be called
5798 * e.g. when seeking or when switching to a different stream.
5800 * @note when refcounted frames are not used (i.e. avctx->refcounted_frames is 0),
5801 * this invalidates the frames previously returned from the decoder. When
5802 * refcounted frames are used, the decoder just releases any references it might
5803 * keep internally, but the caller's reference remains valid.
5805 void avcodec_flush_buffers(AVCodecContext *avctx);
5808 * Return codec bits per sample.
5810 * @param[in] codec_id the codec
5811 * @return Number of bits per sample or zero if unknown for the given codec.
5813 int av_get_bits_per_sample(enum AVCodecID codec_id);
5816 * Return the PCM codec associated with a sample format.
5817 * @param be endianness, 0 for little, 1 for big,
5818 * -1 (or anything else) for native
5819 * @return AV_CODEC_ID_PCM_* or AV_CODEC_ID_NONE
5821 enum AVCodecID av_get_pcm_codec(enum AVSampleFormat fmt, int be);
5824 * Return codec bits per sample.
5825 * Only return non-zero if the bits per sample is exactly correct, not an
5828 * @param[in] codec_id the codec
5829 * @return Number of bits per sample or zero if unknown for the given codec.
5831 int av_get_exact_bits_per_sample(enum AVCodecID codec_id);
5834 * Return audio frame duration.
5836 * @param avctx codec context
5837 * @param frame_bytes size of the frame, or 0 if unknown
5838 * @return frame duration, in samples, if known. 0 if not able to
5841 int av_get_audio_frame_duration(AVCodecContext *avctx, int frame_bytes);
5844 * This function is the same as av_get_audio_frame_duration(), except it works
5845 * with AVCodecParameters instead of an AVCodecContext.
5847 int av_get_audio_frame_duration2(AVCodecParameters *par, int frame_bytes);
5850 typedef struct AVBitStreamFilterContext {
5852 const struct AVBitStreamFilter *filter;
5853 AVCodecParserContext *parser;
5854 struct AVBitStreamFilterContext *next;
5856 * Internal default arguments, used if NULL is passed to av_bitstream_filter_filter().
5857 * Not for access by library users.
5860 } AVBitStreamFilterContext;
5863 typedef struct AVBSFInternal AVBSFInternal;
5866 * The bitstream filter state.
5868 * This struct must be allocated with av_bsf_alloc() and freed with
5871 * The fields in the struct will only be changed (by the caller or by the
5872 * filter) as described in their documentation, and are to be considered
5873 * immutable otherwise.
5875 typedef struct AVBSFContext {
5877 * A class for logging and AVOptions
5879 const AVClass *av_class;
5882 * The bitstream filter this context is an instance of.
5884 const struct AVBitStreamFilter *filter;
5887 * Opaque libavcodec internal data. Must not be touched by the caller in any
5890 AVBSFInternal *internal;
5893 * Opaque filter-specific private data. If filter->priv_class is non-NULL,
5894 * this is an AVOptions-enabled struct.
5899 * Parameters of the input stream. This field is allocated in
5900 * av_bsf_alloc(), it needs to be filled by the caller before
5903 AVCodecParameters *par_in;
5906 * Parameters of the output stream. This field is allocated in
5907 * av_bsf_alloc(), it is set by the filter in av_bsf_init().
5909 AVCodecParameters *par_out;
5912 * The timebase used for the timestamps of the input packets. Set by the
5913 * caller before av_bsf_init().
5915 AVRational time_base_in;
5918 * The timebase used for the timestamps of the output packets. Set by the
5919 * filter in av_bsf_init().
5921 AVRational time_base_out;
5924 typedef struct AVBitStreamFilter {
5928 * A list of codec ids supported by the filter, terminated by
5930 * May be NULL, in that case the bitstream filter works with any codec id.
5932 const enum AVCodecID *codec_ids;
5935 * A class for the private data, used to declare bitstream filter private
5936 * AVOptions. This field is NULL for bitstream filters that do not declare
5939 * If this field is non-NULL, the first member of the filter private data
5940 * must be a pointer to AVClass, which will be set by libavcodec generic
5941 * code to this class.
5943 const AVClass *priv_class;
5945 /*****************************************************************
5946 * No fields below this line are part of the public API. They
5947 * may not be used outside of libavcodec and can be changed and
5949 * New public fields should be added right above.
5950 *****************************************************************
5954 int (*init)(AVBSFContext *ctx);
5955 int (*filter)(AVBSFContext *ctx, AVPacket *pkt);
5956 void (*close)(AVBSFContext *ctx);
5957 } AVBitStreamFilter;
5961 * Register a bitstream filter.
5963 * The filter will be accessible to the application code through
5964 * av_bitstream_filter_next() or can be directly initialized with
5965 * av_bitstream_filter_init().
5967 * @see avcodec_register_all()
5969 attribute_deprecated
5970 void av_register_bitstream_filter(AVBitStreamFilter *bsf);
5973 * Create and initialize a bitstream filter context given a bitstream
5976 * The returned context must be freed with av_bitstream_filter_close().
5978 * @param name the name of the bitstream filter
5979 * @return a bitstream filter context if a matching filter was found
5980 * and successfully initialized, NULL otherwise
5982 attribute_deprecated
5983 AVBitStreamFilterContext *av_bitstream_filter_init(const char *name);
5988 * This function filters the buffer buf with size buf_size, and places the
5989 * filtered buffer in the buffer pointed to by poutbuf.
5991 * The output buffer must be freed by the caller.
5993 * @param bsfc bitstream filter context created by av_bitstream_filter_init()
5994 * @param avctx AVCodecContext accessed by the filter, may be NULL.
5995 * If specified, this must point to the encoder context of the
5996 * output stream the packet is sent to.
5997 * @param args arguments which specify the filter configuration, may be NULL
5998 * @param poutbuf pointer which is updated to point to the filtered buffer
5999 * @param poutbuf_size pointer which is updated to the filtered buffer size in bytes
6000 * @param buf buffer containing the data to filter
6001 * @param buf_size size in bytes of buf
6002 * @param keyframe set to non-zero if the buffer to filter corresponds to a key-frame packet data
6003 * @return >= 0 in case of success, or a negative error code in case of failure
6005 * If the return value is positive, an output buffer is allocated and
6006 * is available in *poutbuf, and is distinct from the input buffer.
6008 * If the return value is 0, the output buffer is not allocated and
6009 * should be considered identical to the input buffer, or in case
6010 * *poutbuf was set it points to the input buffer (not necessarily to
6011 * its starting address). A special case is if *poutbuf was set to NULL and
6012 * *poutbuf_size was set to 0, which indicates the packet should be dropped.
6014 attribute_deprecated
6015 int av_bitstream_filter_filter(AVBitStreamFilterContext *bsfc,
6016 AVCodecContext *avctx, const char *args,
6017 uint8_t **poutbuf, int *poutbuf_size,
6018 const uint8_t *buf, int buf_size, int keyframe);
6021 * Release bitstream filter context.
6023 * @param bsf the bitstream filter context created with
6024 * av_bitstream_filter_init(), can be NULL
6026 attribute_deprecated
6027 void av_bitstream_filter_close(AVBitStreamFilterContext *bsf);
6030 * If f is NULL, return the first registered bitstream filter,
6031 * if f is non-NULL, return the next registered bitstream filter
6032 * after f, or NULL if f is the last one.
6034 * This function can be used to iterate over all registered bitstream
6037 attribute_deprecated
6038 AVBitStreamFilter *av_bitstream_filter_next(const AVBitStreamFilter *f);
6042 * @return a bitstream filter with the specified name or NULL if no such
6043 * bitstream filter exists.
6045 const AVBitStreamFilter *av_bsf_get_by_name(const char *name);
6048 * Iterate over all registered bitstream filters.
6050 * @param opaque a pointer where libavcodec will store the iteration state. Must
6051 * point to NULL to start the iteration.
6053 * @return the next registered bitstream filter or NULL when the iteration is
6056 const AVBitStreamFilter *av_bsf_next(void **opaque);
6059 * Allocate a context for a given bitstream filter. The caller must fill in the
6060 * context parameters as described in the documentation and then call
6061 * av_bsf_init() before sending any data to the filter.
6063 * @param filter the filter for which to allocate an instance.
6064 * @param ctx a pointer into which the pointer to the newly-allocated context
6065 * will be written. It must be freed with av_bsf_free() after the
6066 * filtering is done.
6068 * @return 0 on success, a negative AVERROR code on failure
6070 int av_bsf_alloc(const AVBitStreamFilter *filter, AVBSFContext **ctx);
6073 * Prepare the filter for use, after all the parameters and options have been
6076 int av_bsf_init(AVBSFContext *ctx);
6079 * Submit a packet for filtering.
6081 * After sending each packet, the filter must be completely drained by calling
6082 * av_bsf_receive_packet() repeatedly until it returns AVERROR(EAGAIN) or
6085 * @param pkt the packet to filter. The bitstream filter will take ownership of
6086 * the packet and reset the contents of pkt. pkt is not touched if an error occurs.
6087 * This parameter may be NULL, which signals the end of the stream (i.e. no more
6088 * packets will be sent). That will cause the filter to output any packets it
6089 * may have buffered internally.
6091 * @return 0 on success, a negative AVERROR on error.
6093 int av_bsf_send_packet(AVBSFContext *ctx, AVPacket *pkt);
6096 * Retrieve a filtered packet.
6098 * @param[out] pkt this struct will be filled with the contents of the filtered
6099 * packet. It is owned by the caller and must be freed using
6100 * av_packet_unref() when it is no longer needed.
6101 * This parameter should be "clean" (i.e. freshly allocated
6102 * with av_packet_alloc() or unreffed with av_packet_unref())
6103 * when this function is called. If this function returns
6104 * successfully, the contents of pkt will be completely
6105 * overwritten by the returned data. On failure, pkt is not
6108 * @return 0 on success. AVERROR(EAGAIN) if more packets need to be sent to the
6109 * filter (using av_bsf_send_packet()) to get more output. AVERROR_EOF if there
6110 * will be no further output from the filter. Another negative AVERROR value if
6113 * @note one input packet may result in several output packets, so after sending
6114 * a packet with av_bsf_send_packet(), this function needs to be called
6115 * repeatedly until it stops returning 0. It is also possible for a filter to
6116 * output fewer packets than were sent to it, so this function may return
6117 * AVERROR(EAGAIN) immediately after a successful av_bsf_send_packet() call.
6119 int av_bsf_receive_packet(AVBSFContext *ctx, AVPacket *pkt);
6122 * Free a bitstream filter context and everything associated with it; write NULL
6123 * into the supplied pointer.
6125 void av_bsf_free(AVBSFContext **ctx);
6128 * Get the AVClass for AVBSFContext. It can be used in combination with
6129 * AV_OPT_SEARCH_FAKE_OBJ for examining options.
6131 * @see av_opt_find().
6133 const AVClass *av_bsf_get_class(void);
6136 * Structure for chain/list of bitstream filters.
6137 * Empty list can be allocated by av_bsf_list_alloc().
6139 typedef struct AVBSFList AVBSFList;
6142 * Allocate empty list of bitstream filters.
6143 * The list must be later freed by av_bsf_list_free()
6144 * or finalized by av_bsf_list_finalize().
6146 * @return Pointer to @ref AVBSFList on success, NULL in case of failure
6148 AVBSFList *av_bsf_list_alloc(void);
6151 * Free list of bitstream filters.
6153 * @param lst Pointer to pointer returned by av_bsf_list_alloc()
6155 void av_bsf_list_free(AVBSFList **lst);
6158 * Append bitstream filter to the list of bitstream filters.
6160 * @param lst List to append to
6161 * @param bsf Filter context to be appended
6163 * @return >=0 on success, negative AVERROR in case of failure
6165 int av_bsf_list_append(AVBSFList *lst, AVBSFContext *bsf);
6168 * Construct new bitstream filter context given it's name and options
6169 * and append it to the list of bitstream filters.
6171 * @param lst List to append to
6172 * @param bsf_name Name of the bitstream filter
6173 * @param options Options for the bitstream filter, can be set to NULL
6175 * @return >=0 on success, negative AVERROR in case of failure
6177 int av_bsf_list_append2(AVBSFList *lst, const char * bsf_name, AVDictionary **options);
6179 * Finalize list of bitstream filters.
6181 * This function will transform @ref AVBSFList to single @ref AVBSFContext,
6182 * so the whole chain of bitstream filters can be treated as single filter
6183 * freshly allocated by av_bsf_alloc().
6184 * If the call is successful, @ref AVBSFList structure is freed and lst
6185 * will be set to NULL. In case of failure, caller is responsible for
6186 * freeing the structure by av_bsf_list_free()
6188 * @param lst Filter list structure to be transformed
6189 * @param[out] bsf Pointer to be set to newly created @ref AVBSFContext structure
6190 * representing the chain of bitstream filters
6192 * @return >=0 on success, negative AVERROR in case of failure
6194 int av_bsf_list_finalize(AVBSFList **lst, AVBSFContext **bsf);
6197 * Parse string describing list of bitstream filters and create single
6198 * @ref AVBSFContext describing the whole chain of bitstream filters.
6199 * Resulting @ref AVBSFContext can be treated as any other @ref AVBSFContext freshly
6200 * allocated by av_bsf_alloc().
6202 * @param str String describing chain of bitstream filters in format
6203 * `bsf1[=opt1=val1:opt2=val2][,bsf2]`
6204 * @param[out] bsf Pointer to be set to newly created @ref AVBSFContext structure
6205 * representing the chain of bitstream filters
6207 * @return >=0 on success, negative AVERROR in case of failure
6209 int av_bsf_list_parse_str(const char *str, AVBSFContext **bsf);
6212 * Get null/pass-through bitstream filter.
6214 * @param[out] bsf Pointer to be set to new instance of pass-through bitstream filter
6218 int av_bsf_get_null_filter(AVBSFContext **bsf);
6223 * Same behaviour av_fast_malloc but the buffer has additional
6224 * AV_INPUT_BUFFER_PADDING_SIZE at the end which will always be 0.
6226 * In addition the whole buffer will initially and after resizes
6227 * be 0-initialized so that no uninitialized data will ever appear.
6229 void av_fast_padded_malloc(void *ptr, unsigned int *size, size_t min_size);
6232 * Same behaviour av_fast_padded_malloc except that buffer will always
6233 * be 0-initialized after call.
6235 void av_fast_padded_mallocz(void *ptr, unsigned int *size, size_t min_size);
6238 * Encode extradata length to a buffer. Used by xiph codecs.
6240 * @param s buffer to write to; must be at least (v/255+1) bytes long
6241 * @param v size of extradata in bytes
6242 * @return number of bytes written to the buffer.
6244 unsigned int av_xiphlacing(unsigned char *s, unsigned int v);
6246 #if FF_API_MISSING_SAMPLE
6248 * Log a generic warning message about a missing feature. This function is
6249 * intended to be used internally by FFmpeg (libavcodec, libavformat, etc.)
6250 * only, and would normally not be used by applications.
6251 * @param[in] avc a pointer to an arbitrary struct of which the first field is
6252 * a pointer to an AVClass struct
6253 * @param[in] feature string containing the name of the missing feature
6254 * @param[in] want_sample indicates if samples are wanted which exhibit this feature.
6255 * If want_sample is non-zero, additional verbiage will be added to the log
6256 * message which tells the user how to report samples to the development
6258 * @deprecated Use avpriv_report_missing_feature() instead.
6260 attribute_deprecated
6261 void av_log_missing_feature(void *avc, const char *feature, int want_sample);
6264 * Log a generic warning message asking for a sample. This function is
6265 * intended to be used internally by FFmpeg (libavcodec, libavformat, etc.)
6266 * only, and would normally not be used by applications.
6267 * @param[in] avc a pointer to an arbitrary struct of which the first field is
6268 * a pointer to an AVClass struct
6269 * @param[in] msg string containing an optional message, or NULL if no message
6270 * @deprecated Use avpriv_request_sample() instead.
6272 attribute_deprecated
6273 void av_log_ask_for_sample(void *avc, const char *msg, ...) av_printf_format(2, 3);
6274 #endif /* FF_API_MISSING_SAMPLE */
6277 * Register the hardware accelerator hwaccel.
6279 void av_register_hwaccel(AVHWAccel *hwaccel);
6282 * If hwaccel is NULL, returns the first registered hardware accelerator,
6283 * if hwaccel is non-NULL, returns the next registered hardware accelerator
6284 * after hwaccel, or NULL if hwaccel is the last one.
6286 AVHWAccel *av_hwaccel_next(const AVHWAccel *hwaccel);
6290 * Lock operation used by lockmgr
6293 AV_LOCK_CREATE, ///< Create a mutex
6294 AV_LOCK_OBTAIN, ///< Lock the mutex
6295 AV_LOCK_RELEASE, ///< Unlock the mutex
6296 AV_LOCK_DESTROY, ///< Free mutex resources
6300 * Register a user provided lock manager supporting the operations
6301 * specified by AVLockOp. The "mutex" argument to the function points
6302 * to a (void *) where the lockmgr should store/get a pointer to a user
6303 * allocated mutex. It is NULL upon AV_LOCK_CREATE and equal to the
6304 * value left by the last call for all other ops. If the lock manager is
6305 * unable to perform the op then it should leave the mutex in the same
6306 * state as when it was called and return a non-zero value. However,
6307 * when called with AV_LOCK_DESTROY the mutex will always be assumed to
6308 * have been successfully destroyed. If av_lockmgr_register succeeds
6309 * it will return a non-negative value, if it fails it will return a
6310 * negative value and destroy all mutex and unregister all callbacks.
6311 * av_lockmgr_register is not thread-safe, it must be called from a
6312 * single thread before any calls which make use of locking are used.
6314 * @param cb User defined callback. av_lockmgr_register invokes calls
6315 * to this callback and the previously registered callback.
6316 * The callback will be used to create more than one mutex
6317 * each of which must be backed by its own underlying locking
6318 * mechanism (i.e. do not use a single static object to
6319 * implement your lock manager). If cb is set to NULL the
6320 * lockmgr will be unregistered.
6322 int av_lockmgr_register(int (*cb)(void **mutex, enum AVLockOp op));
6325 * Get the type of the given codec.
6327 enum AVMediaType avcodec_get_type(enum AVCodecID codec_id);
6330 * Get the name of a codec.
6331 * @return a static string identifying the codec; never NULL
6333 const char *avcodec_get_name(enum AVCodecID id);
6336 * @return a positive value if s is open (i.e. avcodec_open2() was called on it
6337 * with no corresponding avcodec_close()), 0 otherwise.
6339 int avcodec_is_open(AVCodecContext *s);
6342 * @return a non-zero number if codec is an encoder, zero otherwise
6344 int av_codec_is_encoder(const AVCodec *codec);
6347 * @return a non-zero number if codec is a decoder, zero otherwise
6349 int av_codec_is_decoder(const AVCodec *codec);
6352 * @return descriptor for given codec ID or NULL if no descriptor exists.
6354 const AVCodecDescriptor *avcodec_descriptor_get(enum AVCodecID id);
6357 * Iterate over all codec descriptors known to libavcodec.
6359 * @param prev previous descriptor. NULL to get the first descriptor.
6361 * @return next descriptor or NULL after the last descriptor
6363 const AVCodecDescriptor *avcodec_descriptor_next(const AVCodecDescriptor *prev);
6366 * @return codec descriptor with the given name or NULL if no such descriptor
6369 const AVCodecDescriptor *avcodec_descriptor_get_by_name(const char *name);
6372 * Allocate a CPB properties structure and initialize its fields to default
6375 * @param size if non-NULL, the size of the allocated struct will be written
6376 * here. This is useful for embedding it in side data.
6378 * @return the newly allocated struct or NULL on failure
6380 AVCPBProperties *av_cpb_properties_alloc(size_t *size);
6386 #endif /* AVCODEC_AVCODEC_H */