2 * copyright (c) 2001 Fabrice Bellard
4 * This file is part of FFmpeg.
6 * FFmpeg is free software; you can redistribute it and/or
7 * modify it under the terms of the GNU Lesser General Public
8 * License as published by the Free Software Foundation; either
9 * version 2.1 of the License, or (at your option) any later version.
11 * FFmpeg is distributed in the hope that it will be useful,
12 * but WITHOUT ANY WARRANTY; without even the implied warranty of
13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
14 * Lesser General Public License for more details.
16 * You should have received a copy of the GNU Lesser General Public
17 * License along with FFmpeg; if not, write to the Free Software
18 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
21 #ifndef AVCODEC_AVCODEC_H
22 #define AVCODEC_AVCODEC_H
27 * Libavcodec external API header
31 #include "libavutil/samplefmt.h"
32 #include "libavutil/attributes.h"
33 #include "libavutil/avutil.h"
34 #include "libavutil/buffer.h"
35 #include "libavutil/cpu.h"
36 #include "libavutil/channel_layout.h"
37 #include "libavutil/dict.h"
38 #include "libavutil/frame.h"
39 #include "libavutil/hwcontext.h"
40 #include "libavutil/log.h"
41 #include "libavutil/pixfmt.h"
42 #include "libavutil/rational.h"
47 * @defgroup libavc libavcodec
48 * Encoding/Decoding Library
52 * @defgroup lavc_decoding Decoding
56 * @defgroup lavc_encoding Encoding
60 * @defgroup lavc_codec Codecs
62 * @defgroup lavc_codec_native Native Codecs
65 * @defgroup lavc_codec_wrappers External library wrappers
68 * @defgroup lavc_codec_hwaccel Hardware Accelerators bridge
72 * @defgroup lavc_internal Internal
80 * @defgroup lavc_encdec send/receive encoding and decoding API overview
83 * The avcodec_send_packet()/avcodec_receive_frame()/avcodec_send_frame()/
84 * avcodec_receive_packet() functions provide an encode/decode API, which
85 * decouples input and output.
87 * The API is very similar for encoding/decoding and audio/video, and works as
89 * - Set up and open the AVCodecContext as usual.
91 * - For decoding, call avcodec_send_packet() to give the decoder raw
92 * compressed data in an AVPacket.
93 * - For encoding, call avcodec_send_frame() to give the encoder an AVFrame
94 * containing uncompressed audio or video.
95 * In both cases, it is recommended that AVPackets and AVFrames are
96 * refcounted, or libavcodec might have to copy the input data. (libavformat
97 * always returns refcounted AVPackets, and av_frame_get_buffer() allocates
98 * refcounted AVFrames.)
99 * - Receive output in a loop. Periodically call one of the avcodec_receive_*()
100 * functions and process their output:
101 * - For decoding, call avcodec_receive_frame(). On success, it will return
102 * an AVFrame containing uncompressed audio or video data.
103 * - For encoding, call avcodec_receive_packet(). On success, it will return
104 * an AVPacket with a compressed frame.
105 * Repeat this call until it returns AVERROR(EAGAIN) or an error. The
106 * AVERROR(EAGAIN) return value means that new input data is required to
107 * return new output. In this case, continue with sending input. For each
108 * input frame/packet, the codec will typically return 1 output frame/packet,
109 * but it can also be 0 or more than 1.
111 * At the beginning of decoding or encoding, the codec might accept multiple
112 * input frames/packets without returning a frame, until its internal buffers
113 * are filled. This situation is handled transparently if you follow the steps
116 * In theory, sending input can result in EAGAIN - this should happen only if
117 * not all output was received. You can use this to structure alternative decode
118 * or encode loops other than the one suggested above. For example, you could
119 * try sending new input on each iteration, and try to receive output if that
122 * End of stream situations. These require "flushing" (aka draining) the codec,
123 * as the codec might buffer multiple frames or packets internally for
124 * performance or out of necessity (consider B-frames).
125 * This is handled as follows:
126 * - Instead of valid input, send NULL to the avcodec_send_packet() (decoding)
127 * or avcodec_send_frame() (encoding) functions. This will enter draining
129 * - Call avcodec_receive_frame() (decoding) or avcodec_receive_packet()
130 * (encoding) in a loop until AVERROR_EOF is returned. The functions will
131 * not return AVERROR(EAGAIN), unless you forgot to enter draining mode.
132 * - Before decoding can be resumed again, the codec has to be reset with
133 * avcodec_flush_buffers().
135 * Using the API as outlined above is highly recommended. But it is also
136 * possible to call functions outside of this rigid schema. For example, you can
137 * call avcodec_send_packet() repeatedly without calling
138 * avcodec_receive_frame(). In this case, avcodec_send_packet() will succeed
139 * until the codec's internal buffer has been filled up (which is typically of
140 * size 1 per output frame, after initial input), and then reject input with
141 * AVERROR(EAGAIN). Once it starts rejecting input, you have no choice but to
142 * read at least some output.
144 * Not all codecs will follow a rigid and predictable dataflow; the only
145 * guarantee is that an AVERROR(EAGAIN) return value on a send/receive call on
146 * one end implies that a receive/send call on the other end will succeed, or
147 * at least will not fail with AVERROR(EAGAIN). In general, no codec will
148 * permit unlimited buffering of input or output.
150 * This API replaces the following legacy functions:
151 * - avcodec_decode_video2() and avcodec_decode_audio4():
152 * Use avcodec_send_packet() to feed input to the decoder, then use
153 * avcodec_receive_frame() to receive decoded frames after each packet.
154 * Unlike with the old video decoding API, multiple frames might result from
155 * a packet. For audio, splitting the input packet into frames by partially
156 * decoding packets becomes transparent to the API user. You never need to
157 * feed an AVPacket to the API twice (unless it is rejected with AVERROR(EAGAIN) - then
158 * no data was read from the packet).
159 * Additionally, sending a flush/draining packet is required only once.
160 * - avcodec_encode_video2()/avcodec_encode_audio2():
161 * Use avcodec_send_frame() to feed input to the encoder, then use
162 * avcodec_receive_packet() to receive encoded packets.
163 * Providing user-allocated buffers for avcodec_receive_packet() is not
165 * - The new API does not handle subtitles yet.
167 * Mixing new and old function calls on the same AVCodecContext is not allowed,
168 * and will result in undefined behavior.
170 * Some codecs might require using the new API; using the old API will return
171 * an error when calling it. All codecs support the new API.
173 * A codec is not allowed to return AVERROR(EAGAIN) for both sending and receiving. This
174 * would be an invalid state, which could put the codec user into an endless
175 * loop. The API has no concept of time either: it cannot happen that trying to
176 * do avcodec_send_packet() results in AVERROR(EAGAIN), but a repeated call 1 second
177 * later accepts the packet (with no other receive/flush API calls involved).
178 * The API is a strict state machine, and the passage of time is not supposed
179 * to influence it. Some timing-dependent behavior might still be deemed
180 * acceptable in certain cases. But it must never result in both send/receive
181 * returning EAGAIN at the same time at any point. It must also absolutely be
182 * avoided that the current state is "unstable" and can "flip-flop" between
183 * the send/receive APIs allowing progress. For example, it's not allowed that
184 * the codec randomly decides that it actually wants to consume a packet now
185 * instead of returning a frame, after it just returned AVERROR(EAGAIN) on an
186 * avcodec_send_packet() call.
191 * @defgroup lavc_core Core functions/structures.
194 * Basic definitions, functions for querying libavcodec capabilities,
195 * allocating core structures, etc.
201 * Identify the syntax and semantics of the bitstream.
202 * The principle is roughly:
203 * Two decoders with the same ID can decode the same streams.
204 * Two encoders with the same ID can encode compatible streams.
205 * There may be slight deviations from the principle due to implementation
208 * If you add a codec ID to this list, add it so that
209 * 1. no value of an existing codec ID changes (that would break ABI),
210 * 2. it is as close as possible to similar codecs
212 * After adding new codec IDs, do not forget to add an entry to the codec
213 * descriptor list and bump libavcodec minor version.
219 AV_CODEC_ID_MPEG1VIDEO,
220 AV_CODEC_ID_MPEG2VIDEO, ///< preferred ID for MPEG-1/2 video decoding
231 AV_CODEC_ID_RAWVIDEO,
232 AV_CODEC_ID_MSMPEG4V1,
233 AV_CODEC_ID_MSMPEG4V2,
234 AV_CODEC_ID_MSMPEG4V3,
257 AV_CODEC_ID_INTERPLAY_VIDEO,
264 AV_CODEC_ID_MSVIDEO1,
269 AV_CODEC_ID_TRUEMOTION1,
270 AV_CODEC_ID_VMDVIDEO,
295 AV_CODEC_ID_TRUEMOTION2,
301 AV_CODEC_ID_SMACKVIDEO,
306 AV_CODEC_ID_JPEG2000,
312 AV_CODEC_ID_DSICINVIDEO,
313 AV_CODEC_ID_TIERTEXSEQVIDEO,
321 AV_CODEC_ID_BETHSOFTVID,
333 AV_CODEC_ID_ESCAPE124,
337 AV_CODEC_ID_MOTIONPIXELS,
349 AV_CODEC_ID_FLASHSV2,
350 AV_CODEC_ID_CDGRAPHICS,
353 AV_CODEC_ID_BINKVIDEO,
354 AV_CODEC_ID_IFF_ILBM,
355 #define AV_CODEC_ID_IFF_BYTERUN1 AV_CODEC_ID_IFF_ILBM
361 AV_CODEC_ID_A64_MULTI,
362 AV_CODEC_ID_A64_MULTI5,
365 AV_CODEC_ID_LAGARITH,
369 AV_CODEC_ID_WMV3IMAGE,
370 AV_CODEC_ID_VC1IMAGE,
372 AV_CODEC_ID_BMV_VIDEO,
379 AV_CODEC_ID_ZEROCODEC,
388 AV_CODEC_ID_ESCAPE130,
391 AV_CODEC_ID_HNM4_VIDEO,
393 #define AV_CODEC_ID_H265 AV_CODEC_ID_HEVC
395 AV_CODEC_ID_ALIAS_PIX,
396 AV_CODEC_ID_BRENDER_PIX,
397 AV_CODEC_ID_PAF_VIDEO,
410 AV_CODEC_ID_SCREENPRESSO,
413 AV_CODEC_ID_Y41P = 0x8000,
418 AV_CODEC_ID_TARGA_Y216,
430 AV_CODEC_ID_TRUEMOTION2RT,
432 AV_CODEC_ID_MAGICYUV,
433 AV_CODEC_ID_SHEERVIDEO,
440 AV_CODEC_ID_CLEARVIDEO,
443 AV_CODEC_ID_BITPACKED,
450 /* various PCM "codecs" */
451 AV_CODEC_ID_FIRST_AUDIO = 0x10000, ///< A dummy id pointing at the start of audio codecs
452 AV_CODEC_ID_PCM_S16LE = 0x10000,
453 AV_CODEC_ID_PCM_S16BE,
454 AV_CODEC_ID_PCM_U16LE,
455 AV_CODEC_ID_PCM_U16BE,
458 AV_CODEC_ID_PCM_MULAW,
459 AV_CODEC_ID_PCM_ALAW,
460 AV_CODEC_ID_PCM_S32LE,
461 AV_CODEC_ID_PCM_S32BE,
462 AV_CODEC_ID_PCM_U32LE,
463 AV_CODEC_ID_PCM_U32BE,
464 AV_CODEC_ID_PCM_S24LE,
465 AV_CODEC_ID_PCM_S24BE,
466 AV_CODEC_ID_PCM_U24LE,
467 AV_CODEC_ID_PCM_U24BE,
468 AV_CODEC_ID_PCM_S24DAUD,
469 AV_CODEC_ID_PCM_ZORK,
470 AV_CODEC_ID_PCM_S16LE_PLANAR,
472 AV_CODEC_ID_PCM_F32BE,
473 AV_CODEC_ID_PCM_F32LE,
474 AV_CODEC_ID_PCM_F64BE,
475 AV_CODEC_ID_PCM_F64LE,
476 AV_CODEC_ID_PCM_BLURAY,
479 AV_CODEC_ID_PCM_S8_PLANAR,
480 AV_CODEC_ID_PCM_S24LE_PLANAR,
481 AV_CODEC_ID_PCM_S32LE_PLANAR,
482 AV_CODEC_ID_PCM_S16BE_PLANAR,
484 AV_CODEC_ID_PCM_S64LE = 0x10800,
485 AV_CODEC_ID_PCM_S64BE,
486 AV_CODEC_ID_PCM_F16LE,
487 AV_CODEC_ID_PCM_F24LE,
489 /* various ADPCM codecs */
490 AV_CODEC_ID_ADPCM_IMA_QT = 0x11000,
491 AV_CODEC_ID_ADPCM_IMA_WAV,
492 AV_CODEC_ID_ADPCM_IMA_DK3,
493 AV_CODEC_ID_ADPCM_IMA_DK4,
494 AV_CODEC_ID_ADPCM_IMA_WS,
495 AV_CODEC_ID_ADPCM_IMA_SMJPEG,
496 AV_CODEC_ID_ADPCM_MS,
497 AV_CODEC_ID_ADPCM_4XM,
498 AV_CODEC_ID_ADPCM_XA,
499 AV_CODEC_ID_ADPCM_ADX,
500 AV_CODEC_ID_ADPCM_EA,
501 AV_CODEC_ID_ADPCM_G726,
502 AV_CODEC_ID_ADPCM_CT,
503 AV_CODEC_ID_ADPCM_SWF,
504 AV_CODEC_ID_ADPCM_YAMAHA,
505 AV_CODEC_ID_ADPCM_SBPRO_4,
506 AV_CODEC_ID_ADPCM_SBPRO_3,
507 AV_CODEC_ID_ADPCM_SBPRO_2,
508 AV_CODEC_ID_ADPCM_THP,
509 AV_CODEC_ID_ADPCM_IMA_AMV,
510 AV_CODEC_ID_ADPCM_EA_R1,
511 AV_CODEC_ID_ADPCM_EA_R3,
512 AV_CODEC_ID_ADPCM_EA_R2,
513 AV_CODEC_ID_ADPCM_IMA_EA_SEAD,
514 AV_CODEC_ID_ADPCM_IMA_EA_EACS,
515 AV_CODEC_ID_ADPCM_EA_XAS,
516 AV_CODEC_ID_ADPCM_EA_MAXIS_XA,
517 AV_CODEC_ID_ADPCM_IMA_ISS,
518 AV_CODEC_ID_ADPCM_G722,
519 AV_CODEC_ID_ADPCM_IMA_APC,
520 AV_CODEC_ID_ADPCM_VIMA,
522 AV_CODEC_ID_ADPCM_AFC = 0x11800,
523 AV_CODEC_ID_ADPCM_IMA_OKI,
524 AV_CODEC_ID_ADPCM_DTK,
525 AV_CODEC_ID_ADPCM_IMA_RAD,
526 AV_CODEC_ID_ADPCM_G726LE,
527 AV_CODEC_ID_ADPCM_THP_LE,
528 AV_CODEC_ID_ADPCM_PSX,
529 AV_CODEC_ID_ADPCM_AICA,
530 AV_CODEC_ID_ADPCM_IMA_DAT4,
531 AV_CODEC_ID_ADPCM_MTAF,
534 AV_CODEC_ID_AMR_NB = 0x12000,
537 /* RealAudio codecs*/
538 AV_CODEC_ID_RA_144 = 0x13000,
541 /* various DPCM codecs */
542 AV_CODEC_ID_ROQ_DPCM = 0x14000,
543 AV_CODEC_ID_INTERPLAY_DPCM,
544 AV_CODEC_ID_XAN_DPCM,
545 AV_CODEC_ID_SOL_DPCM,
547 AV_CODEC_ID_SDX2_DPCM = 0x14800,
548 AV_CODEC_ID_GREMLIN_DPCM,
551 AV_CODEC_ID_MP2 = 0x15000,
552 AV_CODEC_ID_MP3, ///< preferred ID for decoding MPEG audio layer 1, 2 or 3
562 AV_CODEC_ID_VMDAUDIO,
568 AV_CODEC_ID_WESTWOOD_SND1,
569 AV_CODEC_ID_GSM, ///< as in Berlin toast format
572 AV_CODEC_ID_TRUESPEECH,
574 AV_CODEC_ID_SMACKAUDIO,
577 AV_CODEC_ID_DSICINAUDIO,
579 AV_CODEC_ID_MUSEPACK7,
581 AV_CODEC_ID_GSM_MS, /* as found in WAV */
584 AV_CODEC_ID_NELLYMOSER,
585 AV_CODEC_ID_MUSEPACK8,
587 AV_CODEC_ID_WMAVOICE,
589 AV_CODEC_ID_WMALOSSLESS,
598 AV_CODEC_ID_BINKAUDIO_RDFT,
599 AV_CODEC_ID_BINKAUDIO_DCT,
600 AV_CODEC_ID_AAC_LATM,
605 AV_CODEC_ID_8SVX_EXP,
606 AV_CODEC_ID_8SVX_FIB,
607 AV_CODEC_ID_BMV_AUDIO,
612 AV_CODEC_ID_COMFORT_NOISE,
614 AV_CODEC_ID_METASOUND,
615 AV_CODEC_ID_PAF_AUDIO,
620 AV_CODEC_ID_FFWAVESYNTH = 0x15800,
622 AV_CODEC_ID_SONIC_LS,
625 AV_CODEC_ID_DSD_LSBF,
626 AV_CODEC_ID_DSD_MSBF,
627 AV_CODEC_ID_DSD_LSBF_PLANAR,
628 AV_CODEC_ID_DSD_MSBF_PLANAR,
630 AV_CODEC_ID_INTERPLAY_ACM,
634 AV_CODEC_ID_ATRAC3AL,
635 AV_CODEC_ID_ATRAC3PAL,
641 /* subtitle codecs */
642 AV_CODEC_ID_FIRST_SUBTITLE = 0x17000, ///< A dummy ID pointing at the start of subtitle codecs.
643 AV_CODEC_ID_DVD_SUBTITLE = 0x17000,
644 AV_CODEC_ID_DVB_SUBTITLE,
645 AV_CODEC_ID_TEXT, ///< raw UTF-8 text
648 AV_CODEC_ID_MOV_TEXT,
649 AV_CODEC_ID_HDMV_PGS_SUBTITLE,
650 AV_CODEC_ID_DVB_TELETEXT,
653 AV_CODEC_ID_MICRODVD = 0x17800,
657 AV_CODEC_ID_REALTEXT,
659 AV_CODEC_ID_SUBVIEWER1,
660 AV_CODEC_ID_SUBVIEWER,
667 AV_CODEC_ID_HDMV_TEXT_SUBTITLE,
669 /* other specific kind of codecs (generally used for attachments) */
670 AV_CODEC_ID_FIRST_UNKNOWN = 0x18000, ///< A dummy ID pointing at the start of various fake codecs.
671 AV_CODEC_ID_TTF = 0x18000,
673 AV_CODEC_ID_SCTE_35, ///< Contain timestamp estimated through PCR of program stream.
674 AV_CODEC_ID_BINTEXT = 0x18800,
678 AV_CODEC_ID_SMPTE_KLV,
680 AV_CODEC_ID_TIMED_ID3,
681 AV_CODEC_ID_BIN_DATA,
684 AV_CODEC_ID_PROBE = 0x19000, ///< codec_id is not known (like AV_CODEC_ID_NONE) but lavf should attempt to identify it
686 AV_CODEC_ID_MPEG2TS = 0x20000, /**< _FAKE_ codec to indicate a raw MPEG-2 TS
687 * stream (only used by libavformat) */
688 AV_CODEC_ID_MPEG4SYSTEMS = 0x20001, /**< _FAKE_ codec to indicate a MPEG-4 Systems
689 * stream (only used by libavformat) */
690 AV_CODEC_ID_FFMETADATA = 0x21000, ///< Dummy codec for streams containing only metadata information.
691 AV_CODEC_ID_WRAPPED_AVFRAME = 0x21001, ///< Passthrough codec, AVFrames wrapped in AVPacket
695 * This struct describes the properties of a single codec described by an
697 * @see avcodec_descriptor_get()
699 typedef struct AVCodecDescriptor {
701 enum AVMediaType type;
703 * Name of the codec described by this descriptor. It is non-empty and
704 * unique for each codec descriptor. It should contain alphanumeric
705 * characters and '_' only.
709 * A more descriptive name for this codec. May be NULL.
711 const char *long_name;
713 * Codec properties, a combination of AV_CODEC_PROP_* flags.
717 * MIME type(s) associated with the codec.
718 * May be NULL; if not, a NULL-terminated array of MIME types.
719 * The first item is always non-NULL and is the preferred MIME type.
721 const char *const *mime_types;
723 * If non-NULL, an array of profiles recognized for this codec.
724 * Terminated with FF_PROFILE_UNKNOWN.
726 const struct AVProfile *profiles;
730 * Codec uses only intra compression.
731 * Video and audio codecs only.
733 #define AV_CODEC_PROP_INTRA_ONLY (1 << 0)
735 * Codec supports lossy compression. Audio and video codecs only.
736 * @note a codec may support both lossy and lossless
739 #define AV_CODEC_PROP_LOSSY (1 << 1)
741 * Codec supports lossless compression. Audio and video codecs only.
743 #define AV_CODEC_PROP_LOSSLESS (1 << 2)
745 * Codec supports frame reordering. That is, the coded order (the order in which
746 * the encoded packets are output by the encoders / stored / input to the
747 * decoders) may be different from the presentation order of the corresponding
750 * For codecs that do not have this property set, PTS and DTS should always be
753 #define AV_CODEC_PROP_REORDER (1 << 3)
755 * Subtitle codec is bitmap based
756 * Decoded AVSubtitle data can be read from the AVSubtitleRect->pict field.
758 #define AV_CODEC_PROP_BITMAP_SUB (1 << 16)
760 * Subtitle codec is text based.
761 * Decoded AVSubtitle data can be read from the AVSubtitleRect->ass field.
763 #define AV_CODEC_PROP_TEXT_SUB (1 << 17)
766 * @ingroup lavc_decoding
767 * Required number of additionally allocated bytes at the end of the input bitstream for decoding.
768 * This is mainly needed because some optimized bitstream readers read
769 * 32 or 64 bit at once and could read over the end.<br>
770 * Note: If the first 23 bits of the additional bytes are not 0, then damaged
771 * MPEG bitstreams could cause overread and segfault.
773 #define AV_INPUT_BUFFER_PADDING_SIZE 64
776 * @ingroup lavc_encoding
777 * minimum encoding buffer size
778 * Used to avoid some checks during header writing.
780 #define AV_INPUT_BUFFER_MIN_SIZE 16384
783 * @ingroup lavc_decoding
786 /* We leave some space between them for extensions (drop some
787 * keyframes for intra-only or drop just some bidir frames). */
788 AVDISCARD_NONE =-16, ///< discard nothing
789 AVDISCARD_DEFAULT = 0, ///< discard useless packets like 0 size packets in avi
790 AVDISCARD_NONREF = 8, ///< discard all non reference
791 AVDISCARD_BIDIR = 16, ///< discard all bidirectional frames
792 AVDISCARD_NONINTRA= 24, ///< discard all non intra frames
793 AVDISCARD_NONKEY = 32, ///< discard all frames except keyframes
794 AVDISCARD_ALL = 48, ///< discard all
797 enum AVAudioServiceType {
798 AV_AUDIO_SERVICE_TYPE_MAIN = 0,
799 AV_AUDIO_SERVICE_TYPE_EFFECTS = 1,
800 AV_AUDIO_SERVICE_TYPE_VISUALLY_IMPAIRED = 2,
801 AV_AUDIO_SERVICE_TYPE_HEARING_IMPAIRED = 3,
802 AV_AUDIO_SERVICE_TYPE_DIALOGUE = 4,
803 AV_AUDIO_SERVICE_TYPE_COMMENTARY = 5,
804 AV_AUDIO_SERVICE_TYPE_EMERGENCY = 6,
805 AV_AUDIO_SERVICE_TYPE_VOICE_OVER = 7,
806 AV_AUDIO_SERVICE_TYPE_KARAOKE = 8,
807 AV_AUDIO_SERVICE_TYPE_NB , ///< Not part of ABI
811 * @ingroup lavc_encoding
813 typedef struct RcOverride{
816 int qscale; // If this is 0 then quality_factor will be used instead.
817 float quality_factor;
821 These flags can be passed in AVCodecContext.flags before initialization.
822 Note: Not everything is supported yet.
826 * Allow decoders to produce frames with data planes that are not aligned
827 * to CPU requirements (e.g. due to cropping).
829 #define AV_CODEC_FLAG_UNALIGNED (1 << 0)
833 #define AV_CODEC_FLAG_QSCALE (1 << 1)
835 * 4 MV per MB allowed / advanced prediction for H.263.
837 #define AV_CODEC_FLAG_4MV (1 << 2)
839 * Output even those frames that might be corrupted.
841 #define AV_CODEC_FLAG_OUTPUT_CORRUPT (1 << 3)
845 #define AV_CODEC_FLAG_QPEL (1 << 4)
847 * Use internal 2pass ratecontrol in first pass mode.
849 #define AV_CODEC_FLAG_PASS1 (1 << 9)
851 * Use internal 2pass ratecontrol in second pass mode.
853 #define AV_CODEC_FLAG_PASS2 (1 << 10)
857 #define AV_CODEC_FLAG_LOOP_FILTER (1 << 11)
859 * Only decode/encode grayscale.
861 #define AV_CODEC_FLAG_GRAY (1 << 13)
863 * error[?] variables will be set during encoding.
865 #define AV_CODEC_FLAG_PSNR (1 << 15)
867 * Input bitstream might be truncated at a random location
868 * instead of only at frame boundaries.
870 #define AV_CODEC_FLAG_TRUNCATED (1 << 16)
872 * Use interlaced DCT.
874 #define AV_CODEC_FLAG_INTERLACED_DCT (1 << 18)
878 #define AV_CODEC_FLAG_LOW_DELAY (1 << 19)
880 * Place global headers in extradata instead of every keyframe.
882 #define AV_CODEC_FLAG_GLOBAL_HEADER (1 << 22)
884 * Use only bitexact stuff (except (I)DCT).
886 #define AV_CODEC_FLAG_BITEXACT (1 << 23)
887 /* Fx : Flag for H.263+ extra options */
889 * H.263 advanced intra coding / MPEG-4 AC prediction
891 #define AV_CODEC_FLAG_AC_PRED (1 << 24)
893 * interlaced motion estimation
895 #define AV_CODEC_FLAG_INTERLACED_ME (1 << 29)
896 #define AV_CODEC_FLAG_CLOSED_GOP (1U << 31)
899 * Allow non spec compliant speedup tricks.
901 #define AV_CODEC_FLAG2_FAST (1 << 0)
903 * Skip bitstream encoding.
905 #define AV_CODEC_FLAG2_NO_OUTPUT (1 << 2)
907 * Place global headers at every keyframe instead of in extradata.
909 #define AV_CODEC_FLAG2_LOCAL_HEADER (1 << 3)
912 * timecode is in drop frame format. DEPRECATED!!!!
914 #define AV_CODEC_FLAG2_DROP_FRAME_TIMECODE (1 << 13)
917 * Input bitstream might be truncated at a packet boundaries
918 * instead of only at frame boundaries.
920 #define AV_CODEC_FLAG2_CHUNKS (1 << 15)
922 * Discard cropping information from SPS.
924 #define AV_CODEC_FLAG2_IGNORE_CROP (1 << 16)
927 * Show all frames before the first keyframe
929 #define AV_CODEC_FLAG2_SHOW_ALL (1 << 22)
931 * Export motion vectors through frame side data
933 #define AV_CODEC_FLAG2_EXPORT_MVS (1 << 28)
935 * Do not skip samples and export skip information as frame side data
937 #define AV_CODEC_FLAG2_SKIP_MANUAL (1 << 29)
939 * Do not reset ASS ReadOrder field on flush (subtitles decoding)
941 #define AV_CODEC_FLAG2_RO_FLUSH_NOOP (1 << 30)
943 /* Unsupported options :
944 * Syntax Arithmetic coding (SAC)
945 * Reference Picture Selection
946 * Independent Segment Decoding */
948 /* codec capabilities */
951 * Decoder can use draw_horiz_band callback.
953 #define AV_CODEC_CAP_DRAW_HORIZ_BAND (1 << 0)
955 * Codec uses get_buffer() for allocating buffers and supports custom allocators.
956 * If not set, it might not use get_buffer() at all or use operations that
957 * assume the buffer was allocated by avcodec_default_get_buffer.
959 #define AV_CODEC_CAP_DR1 (1 << 1)
960 #define AV_CODEC_CAP_TRUNCATED (1 << 3)
962 * Encoder or decoder requires flushing with NULL input at the end in order to
963 * give the complete and correct output.
965 * NOTE: If this flag is not set, the codec is guaranteed to never be fed with
966 * with NULL data. The user can still send NULL data to the public encode
967 * or decode function, but libavcodec will not pass it along to the codec
968 * unless this flag is set.
971 * The decoder has a non-zero delay and needs to be fed with avpkt->data=NULL,
972 * avpkt->size=0 at the end to get the delayed data until the decoder no longer
976 * The encoder needs to be fed with NULL data at the end of encoding until the
977 * encoder no longer returns data.
979 * NOTE: For encoders implementing the AVCodec.encode2() function, setting this
980 * flag also means that the encoder must set the pts and duration for
981 * each output packet. If this flag is not set, the pts and duration will
982 * be determined by libavcodec from the input frame.
984 #define AV_CODEC_CAP_DELAY (1 << 5)
986 * Codec can be fed a final frame with a smaller size.
987 * This can be used to prevent truncation of the last audio samples.
989 #define AV_CODEC_CAP_SMALL_LAST_FRAME (1 << 6)
992 * Codec can output multiple frames per AVPacket
993 * Normally demuxers return one frame at a time, demuxers which do not do
994 * are connected to a parser to split what they return into proper frames.
995 * This flag is reserved to the very rare category of codecs which have a
996 * bitstream that cannot be split into frames without timeconsuming
997 * operations like full decoding. Demuxers carrying such bitstreams thus
998 * may return multiple frames in a packet. This has many disadvantages like
999 * prohibiting stream copy in many cases thus it should only be considered
1002 #define AV_CODEC_CAP_SUBFRAMES (1 << 8)
1004 * Codec is experimental and is thus avoided in favor of non experimental
1007 #define AV_CODEC_CAP_EXPERIMENTAL (1 << 9)
1009 * Codec should fill in channel configuration and samplerate instead of container
1011 #define AV_CODEC_CAP_CHANNEL_CONF (1 << 10)
1013 * Codec supports frame-level multithreading.
1015 #define AV_CODEC_CAP_FRAME_THREADS (1 << 12)
1017 * Codec supports slice-based (or partition-based) multithreading.
1019 #define AV_CODEC_CAP_SLICE_THREADS (1 << 13)
1021 * Codec supports changed parameters at any point.
1023 #define AV_CODEC_CAP_PARAM_CHANGE (1 << 14)
1025 * Codec supports avctx->thread_count == 0 (auto).
1027 #define AV_CODEC_CAP_AUTO_THREADS (1 << 15)
1029 * Audio encoder supports receiving a different number of samples in each call.
1031 #define AV_CODEC_CAP_VARIABLE_FRAME_SIZE (1 << 16)
1033 * Decoder is not a preferred choice for probing.
1034 * This indicates that the decoder is not a good choice for probing.
1035 * It could for example be an expensive to spin up hardware decoder,
1036 * or it could simply not provide a lot of useful information about
1038 * A decoder marked with this flag should only be used as last resort
1039 * choice for probing.
1041 #define AV_CODEC_CAP_AVOID_PROBING (1 << 17)
1043 * Codec is intra only.
1045 #define AV_CODEC_CAP_INTRA_ONLY 0x40000000
1047 * Codec is lossless.
1049 #define AV_CODEC_CAP_LOSSLESS 0x80000000
1052 * Codec is backed by a hardware implementation. Typically used to
1053 * identify a non-hwaccel hardware decoder. For information about hwaccels, use
1054 * avcodec_get_hw_config() instead.
1056 #define AV_CODEC_CAP_HARDWARE (1 << 18)
1059 * Codec is potentially backed by a hardware implementation, but not
1060 * necessarily. This is used instead of AV_CODEC_CAP_HARDWARE, if the
1061 * implementation provides some sort of internal fallback.
1063 #define AV_CODEC_CAP_HYBRID (1 << 19)
1067 * This specifies the area which should be displayed.
1068 * Note there may be multiple such areas for one frame.
1070 typedef struct AVPanScan {
1073 * - encoding: Set by user.
1074 * - decoding: Set by libavcodec.
1079 * width and height in 1/16 pel
1080 * - encoding: Set by user.
1081 * - decoding: Set by libavcodec.
1087 * position of the top left corner in 1/16 pel for up to 3 fields/frames
1088 * - encoding: Set by user.
1089 * - decoding: Set by libavcodec.
1091 int16_t position[3][2];
1095 * This structure describes the bitrate properties of an encoded bitstream. It
1096 * roughly corresponds to a subset the VBV parameters for MPEG-2 or HRD
1097 * parameters for H.264/HEVC.
1099 typedef struct AVCPBProperties {
1101 * Maximum bitrate of the stream, in bits per second.
1102 * Zero if unknown or unspecified.
1106 * Minimum bitrate of the stream, in bits per second.
1107 * Zero if unknown or unspecified.
1111 * Average bitrate of the stream, in bits per second.
1112 * Zero if unknown or unspecified.
1117 * The size of the buffer to which the ratecontrol is applied, in bits.
1118 * Zero if unknown or unspecified.
1123 * The delay between the time the packet this structure is associated with
1124 * is received and the time when it should be decoded, in periods of a 27MHz
1127 * UINT64_MAX when unknown or unspecified.
1133 * The decoder will keep a reference to the frame and may reuse it later.
1135 #define AV_GET_BUFFER_FLAG_REF (1 << 0)
1138 * @defgroup lavc_packet AVPacket
1140 * Types and functions for working with AVPacket.
1143 enum AVPacketSideDataType {
1145 * An AV_PKT_DATA_PALETTE side data packet contains exactly AVPALETTE_SIZE
1146 * bytes worth of palette. This side data signals that a new palette is
1149 AV_PKT_DATA_PALETTE,
1152 * The AV_PKT_DATA_NEW_EXTRADATA is used to notify the codec or the format
1153 * that the extradata buffer was changed and the receiving side should
1154 * act upon it appropriately. The new extradata is embedded in the side
1155 * data buffer and should be immediately used for processing the current
1158 AV_PKT_DATA_NEW_EXTRADATA,
1161 * An AV_PKT_DATA_PARAM_CHANGE side data packet is laid out as follows:
1164 * if (param_flags & AV_SIDE_DATA_PARAM_CHANGE_CHANNEL_COUNT)
1165 * s32le channel_count
1166 * if (param_flags & AV_SIDE_DATA_PARAM_CHANGE_CHANNEL_LAYOUT)
1167 * u64le channel_layout
1168 * if (param_flags & AV_SIDE_DATA_PARAM_CHANGE_SAMPLE_RATE)
1170 * if (param_flags & AV_SIDE_DATA_PARAM_CHANGE_DIMENSIONS)
1175 AV_PKT_DATA_PARAM_CHANGE,
1178 * An AV_PKT_DATA_H263_MB_INFO side data packet contains a number of
1179 * structures with info about macroblocks relevant to splitting the
1180 * packet into smaller packets on macroblock edges (e.g. as for RFC 2190).
1181 * That is, it does not necessarily contain info about all macroblocks,
1182 * as long as the distance between macroblocks in the info is smaller
1183 * than the target payload size.
1184 * Each MB info structure is 12 bytes, and is laid out as follows:
1186 * u32le bit offset from the start of the packet
1187 * u8 current quantizer at the start of the macroblock
1189 * u16le macroblock address within the GOB
1190 * u8 horizontal MV predictor
1191 * u8 vertical MV predictor
1192 * u8 horizontal MV predictor for block number 3
1193 * u8 vertical MV predictor for block number 3
1196 AV_PKT_DATA_H263_MB_INFO,
1199 * This side data should be associated with an audio stream and contains
1200 * ReplayGain information in form of the AVReplayGain struct.
1202 AV_PKT_DATA_REPLAYGAIN,
1205 * This side data contains a 3x3 transformation matrix describing an affine
1206 * transformation that needs to be applied to the decoded video frames for
1207 * correct presentation.
1209 * See libavutil/display.h for a detailed description of the data.
1211 AV_PKT_DATA_DISPLAYMATRIX,
1214 * This side data should be associated with a video stream and contains
1215 * Stereoscopic 3D information in form of the AVStereo3D struct.
1217 AV_PKT_DATA_STEREO3D,
1220 * This side data should be associated with an audio stream and corresponds
1221 * to enum AVAudioServiceType.
1223 AV_PKT_DATA_AUDIO_SERVICE_TYPE,
1226 * This side data contains quality related information from the encoder.
1228 * u32le quality factor of the compressed frame. Allowed range is between 1 (good) and FF_LAMBDA_MAX (bad).
1232 * u64le[error count] sum of squared differences between encoder in and output
1235 AV_PKT_DATA_QUALITY_STATS,
1238 * This side data contains an integer value representing the stream index
1239 * of a "fallback" track. A fallback track indicates an alternate
1240 * track to use when the current track can not be decoded for some reason.
1241 * e.g. no decoder available for codec.
1243 AV_PKT_DATA_FALLBACK_TRACK,
1246 * This side data corresponds to the AVCPBProperties struct.
1248 AV_PKT_DATA_CPB_PROPERTIES,
1251 * Recommmends skipping the specified number of samples
1253 * u32le number of samples to skip from start of this packet
1254 * u32le number of samples to skip from end of this packet
1255 * u8 reason for start skip
1256 * u8 reason for end skip (0=padding silence, 1=convergence)
1259 AV_PKT_DATA_SKIP_SAMPLES,
1262 * An AV_PKT_DATA_JP_DUALMONO side data packet indicates that
1263 * the packet may contain "dual mono" audio specific to Japanese DTV
1264 * and if it is true, recommends only the selected channel to be used.
1266 * u8 selected channels (0=mail/left, 1=sub/right, 2=both)
1269 AV_PKT_DATA_JP_DUALMONO,
1272 * A list of zero terminated key/value strings. There is no end marker for
1273 * the list, so it is required to rely on the side data size to stop.
1275 AV_PKT_DATA_STRINGS_METADATA,
1278 * Subtitle event position
1286 AV_PKT_DATA_SUBTITLE_POSITION,
1289 * Data found in BlockAdditional element of matroska container. There is
1290 * no end marker for the data, so it is required to rely on the side data
1291 * size to recognize the end. 8 byte id (as found in BlockAddId) followed
1294 AV_PKT_DATA_MATROSKA_BLOCKADDITIONAL,
1297 * The optional first identifier line of a WebVTT cue.
1299 AV_PKT_DATA_WEBVTT_IDENTIFIER,
1302 * The optional settings (rendering instructions) that immediately
1303 * follow the timestamp specifier of a WebVTT cue.
1305 AV_PKT_DATA_WEBVTT_SETTINGS,
1308 * A list of zero terminated key/value strings. There is no end marker for
1309 * the list, so it is required to rely on the side data size to stop. This
1310 * side data includes updated metadata which appeared in the stream.
1312 AV_PKT_DATA_METADATA_UPDATE,
1315 * MPEGTS stream ID, this is required to pass the stream ID
1316 * information from the demuxer to the corresponding muxer.
1318 AV_PKT_DATA_MPEGTS_STREAM_ID,
1321 * Mastering display metadata (based on SMPTE-2086:2014). This metadata
1322 * should be associated with a video stream and contains data in the form
1323 * of the AVMasteringDisplayMetadata struct.
1325 AV_PKT_DATA_MASTERING_DISPLAY_METADATA,
1328 * This side data should be associated with a video stream and corresponds
1329 * to the AVSphericalMapping structure.
1331 AV_PKT_DATA_SPHERICAL,
1334 * Content light level (based on CTA-861.3). This metadata should be
1335 * associated with a video stream and contains data in the form of the
1336 * AVContentLightMetadata struct.
1338 AV_PKT_DATA_CONTENT_LIGHT_LEVEL,
1341 * ATSC A53 Part 4 Closed Captions. This metadata should be associated with
1342 * a video stream. A53 CC bitstream is stored as uint8_t in AVPacketSideData.data.
1343 * The number of bytes of CC data is AVPacketSideData.size.
1348 * This side data is encryption initialization data.
1349 * The format is not part of ABI, use av_encryption_init_info_* methods to
1352 AV_PKT_DATA_ENCRYPTION_INIT_INFO,
1355 * This side data contains encryption info for how to decrypt the packet.
1356 * The format is not part of ABI, use av_encryption_info_* methods to access.
1358 AV_PKT_DATA_ENCRYPTION_INFO,
1361 * The number of side data types.
1362 * This is not part of the public API/ABI in the sense that it may
1363 * change when new side data types are added.
1364 * This must stay the last enum value.
1365 * If its value becomes huge, some code using it
1366 * needs to be updated as it assumes it to be smaller than other limits.
1371 #define AV_PKT_DATA_QUALITY_FACTOR AV_PKT_DATA_QUALITY_STATS //DEPRECATED
1373 typedef struct AVPacketSideData {
1376 enum AVPacketSideDataType type;
1380 * This structure stores compressed data. It is typically exported by demuxers
1381 * and then passed as input to decoders, or received as output from encoders and
1382 * then passed to muxers.
1384 * For video, it should typically contain one compressed frame. For audio it may
1385 * contain several compressed frames. Encoders are allowed to output empty
1386 * packets, with no compressed data, containing only side data
1387 * (e.g. to update some stream parameters at the end of encoding).
1389 * AVPacket is one of the few structs in FFmpeg, whose size is a part of public
1390 * ABI. Thus it may be allocated on stack and no new fields can be added to it
1391 * without libavcodec and libavformat major bump.
1393 * The semantics of data ownership depends on the buf field.
1394 * If it is set, the packet data is dynamically allocated and is
1395 * valid indefinitely until a call to av_packet_unref() reduces the
1396 * reference count to 0.
1398 * If the buf field is not set av_packet_ref() would make a copy instead
1399 * of increasing the reference count.
1401 * The side data is always allocated with av_malloc(), copied by
1402 * av_packet_ref() and freed by av_packet_unref().
1404 * @see av_packet_ref
1405 * @see av_packet_unref
1407 typedef struct AVPacket {
1409 * A reference to the reference-counted buffer where the packet data is
1411 * May be NULL, then the packet data is not reference-counted.
1415 * Presentation timestamp in AVStream->time_base units; the time at which
1416 * the decompressed packet will be presented to the user.
1417 * Can be AV_NOPTS_VALUE if it is not stored in the file.
1418 * pts MUST be larger or equal to dts as presentation cannot happen before
1419 * decompression, unless one wants to view hex dumps. Some formats misuse
1420 * the terms dts and pts/cts to mean something different. Such timestamps
1421 * must be converted to true pts/dts before they are stored in AVPacket.
1425 * Decompression timestamp in AVStream->time_base units; the time at which
1426 * the packet is decompressed.
1427 * Can be AV_NOPTS_VALUE if it is not stored in the file.
1434 * A combination of AV_PKT_FLAG values
1438 * Additional packet data that can be provided by the container.
1439 * Packet can contain several types of side information.
1441 AVPacketSideData *side_data;
1442 int side_data_elems;
1445 * Duration of this packet in AVStream->time_base units, 0 if unknown.
1446 * Equals next_pts - this_pts in presentation order.
1450 int64_t pos; ///< byte position in stream, -1 if unknown
1452 #if FF_API_CONVERGENCE_DURATION
1454 * @deprecated Same as the duration field, but as int64_t. This was required
1455 * for Matroska subtitles, whose duration values could overflow when the
1456 * duration field was still an int.
1458 attribute_deprecated
1459 int64_t convergence_duration;
1462 #define AV_PKT_FLAG_KEY 0x0001 ///< The packet contains a keyframe
1463 #define AV_PKT_FLAG_CORRUPT 0x0002 ///< The packet content is corrupted
1465 * Flag is used to discard packets which are required to maintain valid
1466 * decoder state but are not required for output and should be dropped
1469 #define AV_PKT_FLAG_DISCARD 0x0004
1471 * The packet comes from a trusted source.
1473 * Otherwise-unsafe constructs such as arbitrary pointers to data
1474 * outside the packet may be followed.
1476 #define AV_PKT_FLAG_TRUSTED 0x0008
1478 * Flag is used to indicate packets that contain frames that can
1479 * be discarded by the decoder. I.e. Non-reference frames.
1481 #define AV_PKT_FLAG_DISPOSABLE 0x0010
1484 enum AVSideDataParamChangeFlags {
1485 AV_SIDE_DATA_PARAM_CHANGE_CHANNEL_COUNT = 0x0001,
1486 AV_SIDE_DATA_PARAM_CHANGE_CHANNEL_LAYOUT = 0x0002,
1487 AV_SIDE_DATA_PARAM_CHANGE_SAMPLE_RATE = 0x0004,
1488 AV_SIDE_DATA_PARAM_CHANGE_DIMENSIONS = 0x0008,
1494 struct AVCodecInternal;
1498 AV_FIELD_PROGRESSIVE,
1499 AV_FIELD_TT, //< Top coded_first, top displayed first
1500 AV_FIELD_BB, //< Bottom coded first, bottom displayed first
1501 AV_FIELD_TB, //< Top coded first, bottom displayed first
1502 AV_FIELD_BT, //< Bottom coded first, top displayed first
1506 * main external API structure.
1507 * New fields can be added to the end with minor version bumps.
1508 * Removal, reordering and changes to existing fields require a major
1510 * You can use AVOptions (av_opt* / av_set/get*()) to access these fields from user
1512 * The name string for AVOptions options matches the associated command line
1513 * parameter name and can be found in libavcodec/options_table.h
1514 * The AVOption/command line parameter names differ in some cases from the C
1515 * structure field names for historic reasons or brevity.
1516 * sizeof(AVCodecContext) must not be used outside libav*.
1518 typedef struct AVCodecContext {
1520 * information on struct for av_log
1521 * - set by avcodec_alloc_context3
1523 const AVClass *av_class;
1524 int log_level_offset;
1526 enum AVMediaType codec_type; /* see AVMEDIA_TYPE_xxx */
1527 const struct AVCodec *codec;
1528 enum AVCodecID codec_id; /* see AV_CODEC_ID_xxx */
1531 * fourcc (LSB first, so "ABCD" -> ('D'<<24) + ('C'<<16) + ('B'<<8) + 'A').
1532 * This is used to work around some encoder bugs.
1533 * A demuxer should set this to what is stored in the field used to identify the codec.
1534 * If there are multiple such fields in a container then the demuxer should choose the one
1535 * which maximizes the information about the used codec.
1536 * If the codec tag field in a container is larger than 32 bits then the demuxer should
1537 * remap the longer ID to 32 bits with a table or other structure. Alternatively a new
1538 * extra_codec_tag + size could be added but for this a clear advantage must be demonstrated
1540 * - encoding: Set by user, if not then the default based on codec_id will be used.
1541 * - decoding: Set by user, will be converted to uppercase by libavcodec during init.
1543 unsigned int codec_tag;
1548 * Private context used for internal data.
1550 * Unlike priv_data, this is not codec-specific. It is used in general
1551 * libavcodec functions.
1553 struct AVCodecInternal *internal;
1556 * Private data of the user, can be used to carry app specific stuff.
1557 * - encoding: Set by user.
1558 * - decoding: Set by user.
1563 * the average bitrate
1564 * - encoding: Set by user; unused for constant quantizer encoding.
1565 * - decoding: Set by user, may be overwritten by libavcodec
1566 * if this info is available in the stream
1571 * number of bits the bitstream is allowed to diverge from the reference.
1572 * the reference can be CBR (for CBR pass1) or VBR (for pass2)
1573 * - encoding: Set by user; unused for constant quantizer encoding.
1574 * - decoding: unused
1576 int bit_rate_tolerance;
1579 * Global quality for codecs which cannot change it per frame.
1580 * This should be proportional to MPEG-1/2/4 qscale.
1581 * - encoding: Set by user.
1582 * - decoding: unused
1587 * - encoding: Set by user.
1588 * - decoding: unused
1590 int compression_level;
1591 #define FF_COMPRESSION_DEFAULT -1
1595 * - encoding: Set by user.
1596 * - decoding: Set by user.
1602 * - encoding: Set by user.
1603 * - decoding: Set by user.
1608 * some codecs need / can use extradata like Huffman tables.
1609 * MJPEG: Huffman tables
1610 * rv10: additional flags
1611 * MPEG-4: global headers (they can be in the bitstream or here)
1612 * The allocated memory should be AV_INPUT_BUFFER_PADDING_SIZE bytes larger
1613 * than extradata_size to avoid problems if it is read with the bitstream reader.
1614 * The bytewise contents of extradata must not depend on the architecture or CPU endianness.
1615 * - encoding: Set/allocated/freed by libavcodec.
1616 * - decoding: Set/allocated/freed by user.
1622 * This is the fundamental unit of time (in seconds) in terms
1623 * of which frame timestamps are represented. For fixed-fps content,
1624 * timebase should be 1/framerate and timestamp increments should be
1626 * This often, but not always is the inverse of the frame rate or field rate
1627 * for video. 1/time_base is not the average frame rate if the frame rate is not
1630 * Like containers, elementary streams also can store timestamps, 1/time_base
1631 * is the unit in which these timestamps are specified.
1632 * As example of such codec time base see ISO/IEC 14496-2:2001(E)
1633 * vop_time_increment_resolution and fixed_vop_rate
1634 * (fixed_vop_rate == 0 implies that it is different from the framerate)
1636 * - encoding: MUST be set by user.
1637 * - decoding: the use of this field for decoding is deprecated.
1638 * Use framerate instead.
1640 AVRational time_base;
1643 * For some codecs, the time base is closer to the field rate than the frame rate.
1644 * Most notably, H.264 and MPEG-2 specify time_base as half of frame duration
1645 * if no telecine is used ...
1647 * Set to time_base ticks per frame. Default 1, e.g., H.264/MPEG-2 set it to 2.
1649 int ticks_per_frame;
1654 * Encoding: Number of frames delay there will be from the encoder input to
1655 * the decoder output. (we assume the decoder matches the spec)
1656 * Decoding: Number of frames delay in addition to what a standard decoder
1657 * as specified in the spec would produce.
1660 * Number of frames the decoded output will be delayed relative to the
1664 * For encoding, this field is unused (see initial_padding).
1666 * For decoding, this is the number of samples the decoder needs to
1667 * output before the decoder's output is valid. When seeking, you should
1668 * start decoding this many samples prior to your desired seek point.
1670 * - encoding: Set by libavcodec.
1671 * - decoding: Set by libavcodec.
1678 * picture width / height.
1680 * @note Those fields may not match the values of the last
1681 * AVFrame output by avcodec_decode_video2 due frame
1684 * - encoding: MUST be set by user.
1685 * - decoding: May be set by the user before opening the decoder if known e.g.
1686 * from the container. Some decoders will require the dimensions
1687 * to be set by the caller. During decoding, the decoder may
1688 * overwrite those values as required while parsing the data.
1693 * Bitstream width / height, may be different from width/height e.g. when
1694 * the decoded frame is cropped before being output or lowres is enabled.
1696 * @note Those field may not match the value of the last
1697 * AVFrame output by avcodec_receive_frame() due frame
1700 * - encoding: unused
1701 * - decoding: May be set by the user before opening the decoder if known
1702 * e.g. from the container. During decoding, the decoder may
1703 * overwrite those values as required while parsing the data.
1705 int coded_width, coded_height;
1708 * the number of pictures in a group of pictures, or 0 for intra_only
1709 * - encoding: Set by user.
1710 * - decoding: unused
1715 * Pixel format, see AV_PIX_FMT_xxx.
1716 * May be set by the demuxer if known from headers.
1717 * May be overridden by the decoder if it knows better.
1719 * @note This field may not match the value of the last
1720 * AVFrame output by avcodec_receive_frame() due frame
1723 * - encoding: Set by user.
1724 * - decoding: Set by user if known, overridden by libavcodec while
1727 enum AVPixelFormat pix_fmt;
1730 * If non NULL, 'draw_horiz_band' is called by the libavcodec
1731 * decoder to draw a horizontal band. It improves cache usage. Not
1732 * all codecs can do that. You must check the codec capabilities
1734 * When multithreading is used, it may be called from multiple threads
1735 * at the same time; threads might draw different parts of the same AVFrame,
1736 * or multiple AVFrames, and there is no guarantee that slices will be drawn
1738 * The function is also used by hardware acceleration APIs.
1739 * It is called at least once during frame decoding to pass
1740 * the data needed for hardware render.
1741 * In that mode instead of pixel data, AVFrame points to
1742 * a structure specific to the acceleration API. The application
1743 * reads the structure and can change some fields to indicate progress
1745 * - encoding: unused
1746 * - decoding: Set by user.
1747 * @param height the height of the slice
1748 * @param y the y position of the slice
1749 * @param type 1->top field, 2->bottom field, 3->frame
1750 * @param offset offset into the AVFrame.data from which the slice should be read
1752 void (*draw_horiz_band)(struct AVCodecContext *s,
1753 const AVFrame *src, int offset[AV_NUM_DATA_POINTERS],
1754 int y, int type, int height);
1757 * callback to negotiate the pixelFormat
1758 * @param fmt is the list of formats which are supported by the codec,
1759 * it is terminated by -1 as 0 is a valid format, the formats are ordered by quality.
1760 * The first is always the native one.
1761 * @note The callback may be called again immediately if initialization for
1762 * the selected (hardware-accelerated) pixel format failed.
1763 * @warning Behavior is undefined if the callback returns a value not
1764 * in the fmt list of formats.
1765 * @return the chosen format
1766 * - encoding: unused
1767 * - decoding: Set by user, if not set the native format will be chosen.
1769 enum AVPixelFormat (*get_format)(struct AVCodecContext *s, const enum AVPixelFormat * fmt);
1772 * maximum number of B-frames between non-B-frames
1773 * Note: The output will be delayed by max_b_frames+1 relative to the input.
1774 * - encoding: Set by user.
1775 * - decoding: unused
1780 * qscale factor between IP and B-frames
1781 * If > 0 then the last P-frame quantizer will be used (q= lastp_q*factor+offset).
1782 * If < 0 then normal ratecontrol will be done (q= -normal_q*factor+offset).
1783 * - encoding: Set by user.
1784 * - decoding: unused
1786 float b_quant_factor;
1788 #if FF_API_PRIVATE_OPT
1789 /** @deprecated use encoder private options instead */
1790 attribute_deprecated
1791 int b_frame_strategy;
1795 * qscale offset between IP and B-frames
1796 * - encoding: Set by user.
1797 * - decoding: unused
1799 float b_quant_offset;
1802 * Size of the frame reordering buffer in the decoder.
1803 * For MPEG-2 it is 1 IPB or 0 low delay IP.
1804 * - encoding: Set by libavcodec.
1805 * - decoding: Set by libavcodec.
1809 #if FF_API_PRIVATE_OPT
1810 /** @deprecated use encoder private options instead */
1811 attribute_deprecated
1816 * qscale factor between P- and I-frames
1817 * If > 0 then the last P-frame quantizer will be used (q = lastp_q * factor + offset).
1818 * If < 0 then normal ratecontrol will be done (q= -normal_q*factor+offset).
1819 * - encoding: Set by user.
1820 * - decoding: unused
1822 float i_quant_factor;
1825 * qscale offset between P and I-frames
1826 * - encoding: Set by user.
1827 * - decoding: unused
1829 float i_quant_offset;
1832 * luminance masking (0-> disabled)
1833 * - encoding: Set by user.
1834 * - decoding: unused
1839 * temporary complexity masking (0-> disabled)
1840 * - encoding: Set by user.
1841 * - decoding: unused
1843 float temporal_cplx_masking;
1846 * spatial complexity masking (0-> disabled)
1847 * - encoding: Set by user.
1848 * - decoding: unused
1850 float spatial_cplx_masking;
1853 * p block masking (0-> disabled)
1854 * - encoding: Set by user.
1855 * - decoding: unused
1860 * darkness masking (0-> disabled)
1861 * - encoding: Set by user.
1862 * - decoding: unused
1868 * - encoding: Set by libavcodec.
1869 * - decoding: Set by user (or 0).
1873 #if FF_API_PRIVATE_OPT
1874 /** @deprecated use encoder private options instead */
1875 attribute_deprecated
1876 int prediction_method;
1877 #define FF_PRED_LEFT 0
1878 #define FF_PRED_PLANE 1
1879 #define FF_PRED_MEDIAN 2
1883 * slice offsets in the frame in bytes
1884 * - encoding: Set/allocated by libavcodec.
1885 * - decoding: Set/allocated by user (or NULL).
1890 * sample aspect ratio (0 if unknown)
1891 * That is the width of a pixel divided by the height of the pixel.
1892 * Numerator and denominator must be relatively prime and smaller than 256 for some video standards.
1893 * - encoding: Set by user.
1894 * - decoding: Set by libavcodec.
1896 AVRational sample_aspect_ratio;
1899 * motion estimation comparison function
1900 * - encoding: Set by user.
1901 * - decoding: unused
1905 * subpixel motion estimation comparison function
1906 * - encoding: Set by user.
1907 * - decoding: unused
1911 * macroblock comparison function (not supported yet)
1912 * - encoding: Set by user.
1913 * - decoding: unused
1917 * interlaced DCT comparison function
1918 * - encoding: Set by user.
1919 * - decoding: unused
1922 #define FF_CMP_SAD 0
1923 #define FF_CMP_SSE 1
1924 #define FF_CMP_SATD 2
1925 #define FF_CMP_DCT 3
1926 #define FF_CMP_PSNR 4
1927 #define FF_CMP_BIT 5
1929 #define FF_CMP_ZERO 7
1930 #define FF_CMP_VSAD 8
1931 #define FF_CMP_VSSE 9
1932 #define FF_CMP_NSSE 10
1933 #define FF_CMP_W53 11
1934 #define FF_CMP_W97 12
1935 #define FF_CMP_DCTMAX 13
1936 #define FF_CMP_DCT264 14
1937 #define FF_CMP_MEDIAN_SAD 15
1938 #define FF_CMP_CHROMA 256
1941 * ME diamond size & shape
1942 * - encoding: Set by user.
1943 * - decoding: unused
1948 * amount of previous MV predictors (2a+1 x 2a+1 square)
1949 * - encoding: Set by user.
1950 * - decoding: unused
1952 int last_predictor_count;
1954 #if FF_API_PRIVATE_OPT
1955 /** @deprecated use encoder private options instead */
1956 attribute_deprecated
1961 * motion estimation prepass comparison function
1962 * - encoding: Set by user.
1963 * - decoding: unused
1968 * ME prepass diamond size & shape
1969 * - encoding: Set by user.
1970 * - decoding: unused
1976 * - encoding: Set by user.
1977 * - decoding: unused
1979 int me_subpel_quality;
1982 * maximum motion estimation search range in subpel units
1983 * If 0 then no limit.
1985 * - encoding: Set by user.
1986 * - decoding: unused
1992 * - encoding: unused
1993 * - decoding: Set by user.
1996 #define SLICE_FLAG_CODED_ORDER 0x0001 ///< draw_horiz_band() is called in coded order instead of display
1997 #define SLICE_FLAG_ALLOW_FIELD 0x0002 ///< allow draw_horiz_band() with field slices (MPEG-2 field pics)
1998 #define SLICE_FLAG_ALLOW_PLANE 0x0004 ///< allow draw_horiz_band() with 1 component at a time (SVQ1)
2001 * macroblock decision mode
2002 * - encoding: Set by user.
2003 * - decoding: unused
2006 #define FF_MB_DECISION_SIMPLE 0 ///< uses mb_cmp
2007 #define FF_MB_DECISION_BITS 1 ///< chooses the one which needs the fewest bits
2008 #define FF_MB_DECISION_RD 2 ///< rate distortion
2011 * custom intra quantization matrix
2012 * - encoding: Set by user, can be NULL.
2013 * - decoding: Set by libavcodec.
2015 uint16_t *intra_matrix;
2018 * custom inter quantization matrix
2019 * - encoding: Set by user, can be NULL.
2020 * - decoding: Set by libavcodec.
2022 uint16_t *inter_matrix;
2024 #if FF_API_PRIVATE_OPT
2025 /** @deprecated use encoder private options instead */
2026 attribute_deprecated
2027 int scenechange_threshold;
2029 /** @deprecated use encoder private options instead */
2030 attribute_deprecated
2031 int noise_reduction;
2035 * precision of the intra DC coefficient - 8
2036 * - encoding: Set by user.
2037 * - decoding: Set by libavcodec
2039 int intra_dc_precision;
2042 * Number of macroblock rows at the top which are skipped.
2043 * - encoding: unused
2044 * - decoding: Set by user.
2049 * Number of macroblock rows at the bottom which are skipped.
2050 * - encoding: unused
2051 * - decoding: Set by user.
2056 * minimum MB Lagrange multiplier
2057 * - encoding: Set by user.
2058 * - decoding: unused
2063 * maximum MB Lagrange multiplier
2064 * - encoding: Set by user.
2065 * - decoding: unused
2069 #if FF_API_PRIVATE_OPT
2071 * @deprecated use encoder private options instead
2073 attribute_deprecated
2074 int me_penalty_compensation;
2078 * - encoding: Set by user.
2079 * - decoding: unused
2083 #if FF_API_PRIVATE_OPT
2084 /** @deprecated use encoder private options instead */
2085 attribute_deprecated
2091 * - encoding: Set by user.
2092 * - decoding: unused
2097 * number of reference frames
2098 * - encoding: Set by user.
2099 * - decoding: Set by lavc.
2103 #if FF_API_PRIVATE_OPT
2104 /** @deprecated use encoder private options instead */
2105 attribute_deprecated
2110 * Note: Value depends upon the compare function used for fullpel ME.
2111 * - encoding: Set by user.
2112 * - decoding: unused
2116 #if FF_API_PRIVATE_OPT
2117 /** @deprecated use encoder private options instead */
2118 attribute_deprecated
2123 * Chromaticity coordinates of the source primaries.
2124 * - encoding: Set by user
2125 * - decoding: Set by libavcodec
2127 enum AVColorPrimaries color_primaries;
2130 * Color Transfer Characteristic.
2131 * - encoding: Set by user
2132 * - decoding: Set by libavcodec
2134 enum AVColorTransferCharacteristic color_trc;
2137 * YUV colorspace type.
2138 * - encoding: Set by user
2139 * - decoding: Set by libavcodec
2141 enum AVColorSpace colorspace;
2144 * MPEG vs JPEG YUV range.
2145 * - encoding: Set by user
2146 * - decoding: Set by libavcodec
2148 enum AVColorRange color_range;
2151 * This defines the location of chroma samples.
2152 * - encoding: Set by user
2153 * - decoding: Set by libavcodec
2155 enum AVChromaLocation chroma_sample_location;
2159 * Indicates number of picture subdivisions. Used for parallelized
2161 * - encoding: Set by user
2162 * - decoding: unused
2167 * - encoding: set by libavcodec
2168 * - decoding: Set by user.
2170 enum AVFieldOrder field_order;
2173 int sample_rate; ///< samples per second
2174 int channels; ///< number of audio channels
2177 * audio sample format
2178 * - encoding: Set by user.
2179 * - decoding: Set by libavcodec.
2181 enum AVSampleFormat sample_fmt; ///< sample format
2183 /* The following data should not be initialized. */
2185 * Number of samples per channel in an audio frame.
2187 * - encoding: set by libavcodec in avcodec_open2(). Each submitted frame
2188 * except the last must contain exactly frame_size samples per channel.
2189 * May be 0 when the codec has AV_CODEC_CAP_VARIABLE_FRAME_SIZE set, then the
2190 * frame size is not restricted.
2191 * - decoding: may be set by some decoders to indicate constant frame size
2196 * Frame counter, set by libavcodec.
2198 * - decoding: total number of frames returned from the decoder so far.
2199 * - encoding: total number of frames passed to the encoder so far.
2201 * @note the counter is not incremented if encoding/decoding resulted in
2207 * number of bytes per packet if constant and known or 0
2208 * Used by some WAV based audio codecs.
2213 * Audio cutoff bandwidth (0 means "automatic")
2214 * - encoding: Set by user.
2215 * - decoding: unused
2220 * Audio channel layout.
2221 * - encoding: set by user.
2222 * - decoding: set by user, may be overwritten by libavcodec.
2224 uint64_t channel_layout;
2227 * Request decoder to use this channel layout if it can (0 for default)
2228 * - encoding: unused
2229 * - decoding: Set by user.
2231 uint64_t request_channel_layout;
2234 * Type of service that the audio stream conveys.
2235 * - encoding: Set by user.
2236 * - decoding: Set by libavcodec.
2238 enum AVAudioServiceType audio_service_type;
2241 * desired sample format
2242 * - encoding: Not used.
2243 * - decoding: Set by user.
2244 * Decoder will decode to this format if it can.
2246 enum AVSampleFormat request_sample_fmt;
2249 * This callback is called at the beginning of each frame to get data
2250 * buffer(s) for it. There may be one contiguous buffer for all the data or
2251 * there may be a buffer per each data plane or anything in between. What
2252 * this means is, you may set however many entries in buf[] you feel necessary.
2253 * Each buffer must be reference-counted using the AVBuffer API (see description
2256 * The following fields will be set in the frame before this callback is
2259 * - width, height (video only)
2260 * - sample_rate, channel_layout, nb_samples (audio only)
2261 * Their values may differ from the corresponding values in
2262 * AVCodecContext. This callback must use the frame values, not the codec
2263 * context values, to calculate the required buffer size.
2265 * This callback must fill the following fields in the frame:
2269 * * if the data is planar audio with more than 8 channels, then this
2270 * callback must allocate and fill extended_data to contain all pointers
2271 * to all data planes. data[] must hold as many pointers as it can.
2272 * extended_data must be allocated with av_malloc() and will be freed in
2274 * * otherwise extended_data must point to data
2275 * - buf[] must contain one or more pointers to AVBufferRef structures. Each of
2276 * the frame's data and extended_data pointers must be contained in these. That
2277 * is, one AVBufferRef for each allocated chunk of memory, not necessarily one
2278 * AVBufferRef per data[] entry. See: av_buffer_create(), av_buffer_alloc(),
2279 * and av_buffer_ref().
2280 * - extended_buf and nb_extended_buf must be allocated with av_malloc() by
2281 * this callback and filled with the extra buffers if there are more
2282 * buffers than buf[] can hold. extended_buf will be freed in
2285 * If AV_CODEC_CAP_DR1 is not set then get_buffer2() must call
2286 * avcodec_default_get_buffer2() instead of providing buffers allocated by
2289 * Each data plane must be aligned to the maximum required by the target
2292 * @see avcodec_default_get_buffer2()
2296 * If AV_GET_BUFFER_FLAG_REF is set in flags then the frame may be reused
2297 * (read and/or written to if it is writable) later by libavcodec.
2299 * avcodec_align_dimensions2() should be used to find the required width and
2300 * height, as they normally need to be rounded up to the next multiple of 16.
2302 * Some decoders do not support linesizes changing between frames.
2304 * If frame multithreading is used and thread_safe_callbacks is set,
2305 * this callback may be called from a different thread, but not from more
2306 * than one at once. Does not need to be reentrant.
2308 * @see avcodec_align_dimensions2()
2312 * Decoders request a buffer of a particular size by setting
2313 * AVFrame.nb_samples prior to calling get_buffer2(). The decoder may,
2314 * however, utilize only part of the buffer by setting AVFrame.nb_samples
2315 * to a smaller value in the output frame.
2317 * As a convenience, av_samples_get_buffer_size() and
2318 * av_samples_fill_arrays() in libavutil may be used by custom get_buffer2()
2319 * functions to find the required data size and to fill data pointers and
2320 * linesize. In AVFrame.linesize, only linesize[0] may be set for audio
2321 * since all planes must be the same size.
2323 * @see av_samples_get_buffer_size(), av_samples_fill_arrays()
2325 * - encoding: unused
2326 * - decoding: Set by libavcodec, user can override.
2328 int (*get_buffer2)(struct AVCodecContext *s, AVFrame *frame, int flags);
2331 * If non-zero, the decoded audio and video frames returned from
2332 * avcodec_decode_video2() and avcodec_decode_audio4() are reference-counted
2333 * and are valid indefinitely. The caller must free them with
2334 * av_frame_unref() when they are not needed anymore.
2335 * Otherwise, the decoded frames must not be freed by the caller and are
2336 * only valid until the next decode call.
2338 * This is always automatically enabled if avcodec_receive_frame() is used.
2340 * - encoding: unused
2341 * - decoding: set by the caller before avcodec_open2().
2343 attribute_deprecated
2344 int refcounted_frames;
2346 /* - encoding parameters */
2347 float qcompress; ///< amount of qscale change between easy & hard scenes (0.0-1.0)
2348 float qblur; ///< amount of qscale smoothing over time (0.0-1.0)
2352 * - encoding: Set by user.
2353 * - decoding: unused
2359 * - encoding: Set by user.
2360 * - decoding: unused
2365 * maximum quantizer difference between frames
2366 * - encoding: Set by user.
2367 * - decoding: unused
2372 * decoder bitstream buffer size
2373 * - encoding: Set by user.
2374 * - decoding: unused
2379 * ratecontrol override, see RcOverride
2380 * - encoding: Allocated/set/freed by user.
2381 * - decoding: unused
2383 int rc_override_count;
2384 RcOverride *rc_override;
2388 * - encoding: Set by user.
2389 * - decoding: Set by user, may be overwritten by libavcodec.
2391 int64_t rc_max_rate;
2395 * - encoding: Set by user.
2396 * - decoding: unused
2398 int64_t rc_min_rate;
2401 * Ratecontrol attempt to use, at maximum, <value> of what can be used without an underflow.
2402 * - encoding: Set by user.
2403 * - decoding: unused.
2405 float rc_max_available_vbv_use;
2408 * Ratecontrol attempt to use, at least, <value> times the amount needed to prevent a vbv overflow.
2409 * - encoding: Set by user.
2410 * - decoding: unused.
2412 float rc_min_vbv_overflow_use;
2415 * Number of bits which should be loaded into the rc buffer before decoding starts.
2416 * - encoding: Set by user.
2417 * - decoding: unused
2419 int rc_initial_buffer_occupancy;
2421 #if FF_API_CODER_TYPE
2422 #define FF_CODER_TYPE_VLC 0
2423 #define FF_CODER_TYPE_AC 1
2424 #define FF_CODER_TYPE_RAW 2
2425 #define FF_CODER_TYPE_RLE 3
2427 * @deprecated use encoder private options instead
2429 attribute_deprecated
2431 #endif /* FF_API_CODER_TYPE */
2433 #if FF_API_PRIVATE_OPT
2434 /** @deprecated use encoder private options instead */
2435 attribute_deprecated
2439 #if FF_API_PRIVATE_OPT
2440 /** @deprecated use encoder private options instead */
2441 attribute_deprecated
2442 int frame_skip_threshold;
2444 /** @deprecated use encoder private options instead */
2445 attribute_deprecated
2446 int frame_skip_factor;
2448 /** @deprecated use encoder private options instead */
2449 attribute_deprecated
2452 /** @deprecated use encoder private options instead */
2453 attribute_deprecated
2455 #endif /* FF_API_PRIVATE_OPT */
2458 * trellis RD quantization
2459 * - encoding: Set by user.
2460 * - decoding: unused
2464 #if FF_API_PRIVATE_OPT
2465 /** @deprecated use encoder private options instead */
2466 attribute_deprecated
2467 int min_prediction_order;
2469 /** @deprecated use encoder private options instead */
2470 attribute_deprecated
2471 int max_prediction_order;
2473 /** @deprecated use encoder private options instead */
2474 attribute_deprecated
2475 int64_t timecode_frame_start;
2478 #if FF_API_RTP_CALLBACK
2480 * @deprecated unused
2482 /* The RTP callback: This function is called */
2483 /* every time the encoder has a packet to send. */
2484 /* It depends on the encoder if the data starts */
2485 /* with a Start Code (it should). H.263 does. */
2486 /* mb_nb contains the number of macroblocks */
2487 /* encoded in the RTP payload. */
2488 attribute_deprecated
2489 void (*rtp_callback)(struct AVCodecContext *avctx, void *data, int size, int mb_nb);
2492 #if FF_API_PRIVATE_OPT
2493 /** @deprecated use encoder private options instead */
2494 attribute_deprecated
2495 int rtp_payload_size; /* The size of the RTP payload: the coder will */
2496 /* do its best to deliver a chunk with size */
2497 /* below rtp_payload_size, the chunk will start */
2498 /* with a start code on some codecs like H.263. */
2499 /* This doesn't take account of any particular */
2500 /* headers inside the transmitted RTP payload. */
2503 #if FF_API_STAT_BITS
2504 /* statistics, used for 2-pass encoding */
2505 attribute_deprecated
2507 attribute_deprecated
2509 attribute_deprecated
2511 attribute_deprecated
2513 attribute_deprecated
2515 attribute_deprecated
2517 attribute_deprecated
2519 attribute_deprecated
2522 /** @deprecated this field is unused */
2523 attribute_deprecated
2528 * pass1 encoding statistics output buffer
2529 * - encoding: Set by libavcodec.
2530 * - decoding: unused
2535 * pass2 encoding statistics input buffer
2536 * Concatenated stuff from stats_out of pass1 should be placed here.
2537 * - encoding: Allocated/set/freed by user.
2538 * - decoding: unused
2543 * Work around bugs in encoders which sometimes cannot be detected automatically.
2544 * - encoding: Set by user
2545 * - decoding: Set by user
2547 int workaround_bugs;
2548 #define FF_BUG_AUTODETECT 1 ///< autodetection
2549 #define FF_BUG_XVID_ILACE 4
2550 #define FF_BUG_UMP4 8
2551 #define FF_BUG_NO_PADDING 16
2552 #define FF_BUG_AMV 32
2553 #define FF_BUG_QPEL_CHROMA 64
2554 #define FF_BUG_STD_QPEL 128
2555 #define FF_BUG_QPEL_CHROMA2 256
2556 #define FF_BUG_DIRECT_BLOCKSIZE 512
2557 #define FF_BUG_EDGE 1024
2558 #define FF_BUG_HPEL_CHROMA 2048
2559 #define FF_BUG_DC_CLIP 4096
2560 #define FF_BUG_MS 8192 ///< Work around various bugs in Microsoft's broken decoders.
2561 #define FF_BUG_TRUNCATED 16384
2562 #define FF_BUG_IEDGE 32768
2565 * strictly follow the standard (MPEG-4, ...).
2566 * - encoding: Set by user.
2567 * - decoding: Set by user.
2568 * Setting this to STRICT or higher means the encoder and decoder will
2569 * generally do stupid things, whereas setting it to unofficial or lower
2570 * will mean the encoder might produce output that is not supported by all
2571 * spec-compliant decoders. Decoders don't differentiate between normal,
2572 * unofficial and experimental (that is, they always try to decode things
2573 * when they can) unless they are explicitly asked to behave stupidly
2574 * (=strictly conform to the specs)
2576 int strict_std_compliance;
2577 #define FF_COMPLIANCE_VERY_STRICT 2 ///< Strictly conform to an older more strict version of the spec or reference software.
2578 #define FF_COMPLIANCE_STRICT 1 ///< Strictly conform to all the things in the spec no matter what consequences.
2579 #define FF_COMPLIANCE_NORMAL 0
2580 #define FF_COMPLIANCE_UNOFFICIAL -1 ///< Allow unofficial extensions
2581 #define FF_COMPLIANCE_EXPERIMENTAL -2 ///< Allow nonstandardized experimental things.
2584 * error concealment flags
2585 * - encoding: unused
2586 * - decoding: Set by user.
2588 int error_concealment;
2589 #define FF_EC_GUESS_MVS 1
2590 #define FF_EC_DEBLOCK 2
2591 #define FF_EC_FAVOR_INTER 256
2595 * - encoding: Set by user.
2596 * - decoding: Set by user.
2599 #define FF_DEBUG_PICT_INFO 1
2600 #define FF_DEBUG_RC 2
2601 #define FF_DEBUG_BITSTREAM 4
2602 #define FF_DEBUG_MB_TYPE 8
2603 #define FF_DEBUG_QP 16
2606 * @deprecated this option does nothing
2608 #define FF_DEBUG_MV 32
2610 #define FF_DEBUG_DCT_COEFF 0x00000040
2611 #define FF_DEBUG_SKIP 0x00000080
2612 #define FF_DEBUG_STARTCODE 0x00000100
2613 #define FF_DEBUG_ER 0x00000400
2614 #define FF_DEBUG_MMCO 0x00000800
2615 #define FF_DEBUG_BUGS 0x00001000
2617 #define FF_DEBUG_VIS_QP 0x00002000
2618 #define FF_DEBUG_VIS_MB_TYPE 0x00004000
2620 #define FF_DEBUG_BUFFERS 0x00008000
2621 #define FF_DEBUG_THREADS 0x00010000
2622 #define FF_DEBUG_GREEN_MD 0x00800000
2623 #define FF_DEBUG_NOMC 0x01000000
2628 * - encoding: Set by user.
2629 * - decoding: Set by user.
2632 #define FF_DEBUG_VIS_MV_P_FOR 0x00000001 // visualize forward predicted MVs of P-frames
2633 #define FF_DEBUG_VIS_MV_B_FOR 0x00000002 // visualize forward predicted MVs of B-frames
2634 #define FF_DEBUG_VIS_MV_B_BACK 0x00000004 // visualize backward predicted MVs of B-frames
2638 * Error recognition; may misdetect some more or less valid parts as errors.
2639 * - encoding: unused
2640 * - decoding: Set by user.
2642 int err_recognition;
2645 * Verify checksums embedded in the bitstream (could be of either encoded or
2646 * decoded data, depending on the codec) and print an error message on mismatch.
2647 * If AV_EF_EXPLODE is also set, a mismatching checksum will result in the
2648 * decoder returning an error.
2650 #define AV_EF_CRCCHECK (1<<0)
2651 #define AV_EF_BITSTREAM (1<<1) ///< detect bitstream specification deviations
2652 #define AV_EF_BUFFER (1<<2) ///< detect improper bitstream length
2653 #define AV_EF_EXPLODE (1<<3) ///< abort decoding on minor error detection
2655 #define AV_EF_IGNORE_ERR (1<<15) ///< ignore errors and continue
2656 #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
2657 #define AV_EF_COMPLIANT (1<<17) ///< consider all spec non compliances as errors
2658 #define AV_EF_AGGRESSIVE (1<<18) ///< consider things that a sane encoder should not do as an error
2662 * opaque 64-bit number (generally a PTS) that will be reordered and
2663 * output in AVFrame.reordered_opaque
2664 * - encoding: unused
2665 * - decoding: Set by user.
2667 int64_t reordered_opaque;
2670 * Hardware accelerator in use
2671 * - encoding: unused.
2672 * - decoding: Set by libavcodec
2674 const struct AVHWAccel *hwaccel;
2677 * Hardware accelerator context.
2678 * For some hardware accelerators, a global context needs to be
2679 * provided by the user. In that case, this holds display-dependent
2680 * data FFmpeg cannot instantiate itself. Please refer to the
2681 * FFmpeg HW accelerator documentation to know how to fill this
2682 * is. e.g. for VA API, this is a struct vaapi_context.
2683 * - encoding: unused
2684 * - decoding: Set by user
2686 void *hwaccel_context;
2690 * - encoding: Set by libavcodec if flags & AV_CODEC_FLAG_PSNR.
2691 * - decoding: unused
2693 uint64_t error[AV_NUM_DATA_POINTERS];
2696 * DCT algorithm, see FF_DCT_* below
2697 * - encoding: Set by user.
2698 * - decoding: unused
2701 #define FF_DCT_AUTO 0
2702 #define FF_DCT_FASTINT 1
2703 #define FF_DCT_INT 2
2704 #define FF_DCT_MMX 3
2705 #define FF_DCT_ALTIVEC 5
2706 #define FF_DCT_FAAN 6
2709 * IDCT algorithm, see FF_IDCT_* below.
2710 * - encoding: Set by user.
2711 * - decoding: Set by user.
2714 #define FF_IDCT_AUTO 0
2715 #define FF_IDCT_INT 1
2716 #define FF_IDCT_SIMPLE 2
2717 #define FF_IDCT_SIMPLEMMX 3
2718 #define FF_IDCT_ARM 7
2719 #define FF_IDCT_ALTIVEC 8
2720 #define FF_IDCT_SIMPLEARM 10
2721 #define FF_IDCT_XVID 14
2722 #define FF_IDCT_SIMPLEARMV5TE 16
2723 #define FF_IDCT_SIMPLEARMV6 17
2724 #define FF_IDCT_FAAN 20
2725 #define FF_IDCT_SIMPLENEON 22
2726 #define FF_IDCT_NONE 24 /* Used by XvMC to extract IDCT coefficients with FF_IDCT_PERM_NONE */
2727 #define FF_IDCT_SIMPLEAUTO 128
2730 * bits per sample/pixel from the demuxer (needed for huffyuv).
2731 * - encoding: Set by libavcodec.
2732 * - decoding: Set by user.
2734 int bits_per_coded_sample;
2737 * Bits per sample/pixel of internal libavcodec pixel/sample format.
2738 * - encoding: set by user.
2739 * - decoding: set by libavcodec.
2741 int bits_per_raw_sample;
2745 * low resolution decoding, 1-> 1/2 size, 2->1/4 size
2746 * - encoding: unused
2747 * - decoding: Set by user.
2752 #if FF_API_CODED_FRAME
2754 * the picture in the bitstream
2755 * - encoding: Set by libavcodec.
2756 * - decoding: unused
2758 * @deprecated use the quality factor packet side data instead
2760 attribute_deprecated AVFrame *coded_frame;
2765 * is used to decide how many independent tasks should be passed to execute()
2766 * - encoding: Set by user.
2767 * - decoding: Set by user.
2772 * Which multithreading methods to use.
2773 * Use of FF_THREAD_FRAME will increase decoding delay by one frame per thread,
2774 * so clients which cannot provide future frames should not use it.
2776 * - encoding: Set by user, otherwise the default is used.
2777 * - decoding: Set by user, otherwise the default is used.
2780 #define FF_THREAD_FRAME 1 ///< Decode more than one frame at once
2781 #define FF_THREAD_SLICE 2 ///< Decode more than one part of a single frame at once
2784 * Which multithreading methods are in use by the codec.
2785 * - encoding: Set by libavcodec.
2786 * - decoding: Set by libavcodec.
2788 int active_thread_type;
2791 * Set by the client if its custom get_buffer() callback can be called
2792 * synchronously from another thread, which allows faster multithreaded decoding.
2793 * draw_horiz_band() will be called from other threads regardless of this setting.
2794 * Ignored if the default get_buffer() is used.
2795 * - encoding: Set by user.
2796 * - decoding: Set by user.
2798 int thread_safe_callbacks;
2801 * The codec may call this to execute several independent things.
2802 * It will return only after finishing all tasks.
2803 * The user may replace this with some multithreaded implementation,
2804 * the default implementation will execute the parts serially.
2805 * @param count the number of things to execute
2806 * - encoding: Set by libavcodec, user can override.
2807 * - decoding: Set by libavcodec, user can override.
2809 int (*execute)(struct AVCodecContext *c, int (*func)(struct AVCodecContext *c2, void *arg), void *arg2, int *ret, int count, int size);
2812 * The codec may call this to execute several independent things.
2813 * It will return only after finishing all tasks.
2814 * The user may replace this with some multithreaded implementation,
2815 * the default implementation will execute the parts serially.
2816 * Also see avcodec_thread_init and e.g. the --enable-pthread configure option.
2817 * @param c context passed also to func
2818 * @param count the number of things to execute
2819 * @param arg2 argument passed unchanged to func
2820 * @param ret return values of executed functions, must have space for "count" values. May be NULL.
2821 * @param func function that will be called count times, with jobnr from 0 to count-1.
2822 * threadnr will be in the range 0 to c->thread_count-1 < MAX_THREADS and so that no
2823 * two instances of func executing at the same time will have the same threadnr.
2824 * @return always 0 currently, but code should handle a future improvement where when any call to func
2825 * returns < 0 no further calls to func may be done and < 0 is returned.
2826 * - encoding: Set by libavcodec, user can override.
2827 * - decoding: Set by libavcodec, user can override.
2829 int (*execute2)(struct AVCodecContext *c, int (*func)(struct AVCodecContext *c2, void *arg, int jobnr, int threadnr), void *arg2, int *ret, int count);
2832 * noise vs. sse weight for the nsse comparison function
2833 * - encoding: Set by user.
2834 * - decoding: unused
2840 * - encoding: Set by user.
2841 * - decoding: Set by libavcodec.
2844 #define FF_PROFILE_UNKNOWN -99
2845 #define FF_PROFILE_RESERVED -100
2847 #define FF_PROFILE_AAC_MAIN 0
2848 #define FF_PROFILE_AAC_LOW 1
2849 #define FF_PROFILE_AAC_SSR 2
2850 #define FF_PROFILE_AAC_LTP 3
2851 #define FF_PROFILE_AAC_HE 4
2852 #define FF_PROFILE_AAC_HE_V2 28
2853 #define FF_PROFILE_AAC_LD 22
2854 #define FF_PROFILE_AAC_ELD 38
2855 #define FF_PROFILE_MPEG2_AAC_LOW 128
2856 #define FF_PROFILE_MPEG2_AAC_HE 131
2858 #define FF_PROFILE_DNXHD 0
2859 #define FF_PROFILE_DNXHR_LB 1
2860 #define FF_PROFILE_DNXHR_SQ 2
2861 #define FF_PROFILE_DNXHR_HQ 3
2862 #define FF_PROFILE_DNXHR_HQX 4
2863 #define FF_PROFILE_DNXHR_444 5
2865 #define FF_PROFILE_DTS 20
2866 #define FF_PROFILE_DTS_ES 30
2867 #define FF_PROFILE_DTS_96_24 40
2868 #define FF_PROFILE_DTS_HD_HRA 50
2869 #define FF_PROFILE_DTS_HD_MA 60
2870 #define FF_PROFILE_DTS_EXPRESS 70
2872 #define FF_PROFILE_MPEG2_422 0
2873 #define FF_PROFILE_MPEG2_HIGH 1
2874 #define FF_PROFILE_MPEG2_SS 2
2875 #define FF_PROFILE_MPEG2_SNR_SCALABLE 3
2876 #define FF_PROFILE_MPEG2_MAIN 4
2877 #define FF_PROFILE_MPEG2_SIMPLE 5
2879 #define FF_PROFILE_H264_CONSTRAINED (1<<9) // 8+1; constraint_set1_flag
2880 #define FF_PROFILE_H264_INTRA (1<<11) // 8+3; constraint_set3_flag
2882 #define FF_PROFILE_H264_BASELINE 66
2883 #define FF_PROFILE_H264_CONSTRAINED_BASELINE (66|FF_PROFILE_H264_CONSTRAINED)
2884 #define FF_PROFILE_H264_MAIN 77
2885 #define FF_PROFILE_H264_EXTENDED 88
2886 #define FF_PROFILE_H264_HIGH 100
2887 #define FF_PROFILE_H264_HIGH_10 110
2888 #define FF_PROFILE_H264_HIGH_10_INTRA (110|FF_PROFILE_H264_INTRA)
2889 #define FF_PROFILE_H264_MULTIVIEW_HIGH 118
2890 #define FF_PROFILE_H264_HIGH_422 122
2891 #define FF_PROFILE_H264_HIGH_422_INTRA (122|FF_PROFILE_H264_INTRA)
2892 #define FF_PROFILE_H264_STEREO_HIGH 128
2893 #define FF_PROFILE_H264_HIGH_444 144
2894 #define FF_PROFILE_H264_HIGH_444_PREDICTIVE 244
2895 #define FF_PROFILE_H264_HIGH_444_INTRA (244|FF_PROFILE_H264_INTRA)
2896 #define FF_PROFILE_H264_CAVLC_444 44
2898 #define FF_PROFILE_VC1_SIMPLE 0
2899 #define FF_PROFILE_VC1_MAIN 1
2900 #define FF_PROFILE_VC1_COMPLEX 2
2901 #define FF_PROFILE_VC1_ADVANCED 3
2903 #define FF_PROFILE_MPEG4_SIMPLE 0
2904 #define FF_PROFILE_MPEG4_SIMPLE_SCALABLE 1
2905 #define FF_PROFILE_MPEG4_CORE 2
2906 #define FF_PROFILE_MPEG4_MAIN 3
2907 #define FF_PROFILE_MPEG4_N_BIT 4
2908 #define FF_PROFILE_MPEG4_SCALABLE_TEXTURE 5
2909 #define FF_PROFILE_MPEG4_SIMPLE_FACE_ANIMATION 6
2910 #define FF_PROFILE_MPEG4_BASIC_ANIMATED_TEXTURE 7
2911 #define FF_PROFILE_MPEG4_HYBRID 8
2912 #define FF_PROFILE_MPEG4_ADVANCED_REAL_TIME 9
2913 #define FF_PROFILE_MPEG4_CORE_SCALABLE 10
2914 #define FF_PROFILE_MPEG4_ADVANCED_CODING 11
2915 #define FF_PROFILE_MPEG4_ADVANCED_CORE 12
2916 #define FF_PROFILE_MPEG4_ADVANCED_SCALABLE_TEXTURE 13
2917 #define FF_PROFILE_MPEG4_SIMPLE_STUDIO 14
2918 #define FF_PROFILE_MPEG4_ADVANCED_SIMPLE 15
2920 #define FF_PROFILE_JPEG2000_CSTREAM_RESTRICTION_0 1
2921 #define FF_PROFILE_JPEG2000_CSTREAM_RESTRICTION_1 2
2922 #define FF_PROFILE_JPEG2000_CSTREAM_NO_RESTRICTION 32768
2923 #define FF_PROFILE_JPEG2000_DCINEMA_2K 3
2924 #define FF_PROFILE_JPEG2000_DCINEMA_4K 4
2926 #define FF_PROFILE_VP9_0 0
2927 #define FF_PROFILE_VP9_1 1
2928 #define FF_PROFILE_VP9_2 2
2929 #define FF_PROFILE_VP9_3 3
2931 #define FF_PROFILE_HEVC_MAIN 1
2932 #define FF_PROFILE_HEVC_MAIN_10 2
2933 #define FF_PROFILE_HEVC_MAIN_STILL_PICTURE 3
2934 #define FF_PROFILE_HEVC_REXT 4
2936 #define FF_PROFILE_MJPEG_HUFFMAN_BASELINE_DCT 0xc0
2937 #define FF_PROFILE_MJPEG_HUFFMAN_EXTENDED_SEQUENTIAL_DCT 0xc1
2938 #define FF_PROFILE_MJPEG_HUFFMAN_PROGRESSIVE_DCT 0xc2
2939 #define FF_PROFILE_MJPEG_HUFFMAN_LOSSLESS 0xc3
2940 #define FF_PROFILE_MJPEG_JPEG_LS 0xf7
2942 #define FF_PROFILE_SBC_MSBC 1
2946 * - encoding: Set by user.
2947 * - decoding: Set by libavcodec.
2950 #define FF_LEVEL_UNKNOWN -99
2953 * Skip loop filtering for selected frames.
2954 * - encoding: unused
2955 * - decoding: Set by user.
2957 enum AVDiscard skip_loop_filter;
2960 * Skip IDCT/dequantization for selected frames.
2961 * - encoding: unused
2962 * - decoding: Set by user.
2964 enum AVDiscard skip_idct;
2967 * Skip decoding for selected frames.
2968 * - encoding: unused
2969 * - decoding: Set by user.
2971 enum AVDiscard skip_frame;
2974 * Header containing style information for text subtitles.
2975 * For SUBTITLE_ASS subtitle type, it should contain the whole ASS
2976 * [Script Info] and [V4+ Styles] section, plus the [Events] line and
2977 * the Format line following. It shouldn't include any Dialogue line.
2978 * - encoding: Set/allocated/freed by user (before avcodec_open2())
2979 * - decoding: Set/allocated/freed by libavcodec (by avcodec_open2())
2981 uint8_t *subtitle_header;
2982 int subtitle_header_size;
2984 #if FF_API_VBV_DELAY
2986 * VBV delay coded in the last frame (in periods of a 27 MHz clock).
2987 * Used for compliant TS muxing.
2988 * - encoding: Set by libavcodec.
2989 * - decoding: unused.
2990 * @deprecated this value is now exported as a part of
2991 * AV_PKT_DATA_CPB_PROPERTIES packet side data
2993 attribute_deprecated
2997 #if FF_API_SIDEDATA_ONLY_PKT
2999 * Encoding only and set by default. Allow encoders to output packets
3000 * that do not contain any encoded data, only side data.
3002 * Some encoders need to output such packets, e.g. to update some stream
3003 * parameters at the end of encoding.
3005 * @deprecated this field disables the default behaviour and
3006 * it is kept only for compatibility.
3008 attribute_deprecated
3009 int side_data_only_packets;
3013 * Audio only. The number of "priming" samples (padding) inserted by the
3014 * encoder at the beginning of the audio. I.e. this number of leading
3015 * decoded samples must be discarded by the caller to get the original audio
3016 * without leading padding.
3018 * - decoding: unused
3019 * - encoding: Set by libavcodec. The timestamps on the output packets are
3020 * adjusted by the encoder so that they always refer to the
3021 * first sample of the data actually contained in the packet,
3022 * including any added padding. E.g. if the timebase is
3023 * 1/samplerate and the timestamp of the first input sample is
3024 * 0, the timestamp of the first output packet will be
3027 int initial_padding;
3030 * - decoding: For codecs that store a framerate value in the compressed
3031 * bitstream, the decoder may export it here. { 0, 1} when
3033 * - encoding: May be used to signal the framerate of CFR content to an
3036 AVRational framerate;
3039 * Nominal unaccelerated pixel format, see AV_PIX_FMT_xxx.
3040 * - encoding: unused.
3041 * - decoding: Set by libavcodec before calling get_format()
3043 enum AVPixelFormat sw_pix_fmt;
3046 * Timebase in which pkt_dts/pts and AVPacket.dts/pts are.
3047 * - encoding unused.
3048 * - decoding set by user.
3050 AVRational pkt_timebase;
3054 * - encoding: unused.
3055 * - decoding: set by libavcodec.
3057 const AVCodecDescriptor *codec_descriptor;
3061 * low resolution decoding, 1-> 1/2 size, 2->1/4 size
3062 * - encoding: unused
3063 * - decoding: Set by user.
3069 * Current statistics for PTS correction.
3070 * - decoding: maintained and used by libavcodec, not intended to be used by user apps
3071 * - encoding: unused
3073 int64_t pts_correction_num_faulty_pts; /// Number of incorrect PTS values so far
3074 int64_t pts_correction_num_faulty_dts; /// Number of incorrect DTS values so far
3075 int64_t pts_correction_last_pts; /// PTS of the last frame
3076 int64_t pts_correction_last_dts; /// DTS of the last frame
3079 * Character encoding of the input subtitles file.
3080 * - decoding: set by user
3081 * - encoding: unused
3086 * Subtitles character encoding mode. Formats or codecs might be adjusting
3087 * this setting (if they are doing the conversion themselves for instance).
3088 * - decoding: set by libavcodec
3089 * - encoding: unused
3091 int sub_charenc_mode;
3092 #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)
3093 #define FF_SUB_CHARENC_MODE_AUTOMATIC 0 ///< libavcodec will select the mode itself
3094 #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
3097 * Skip processing alpha if supported by codec.
3098 * Note that if the format uses pre-multiplied alpha (common with VP6,
3099 * and recommended due to better video quality/compression)
3100 * the image will look as if alpha-blended onto a black background.
3101 * However for formats that do not use pre-multiplied alpha
3102 * there might be serious artefacts (though e.g. libswscale currently
3103 * assumes pre-multiplied alpha anyway).
3105 * - decoding: set by user
3106 * - encoding: unused
3111 * Number of samples to skip after a discontinuity
3112 * - decoding: unused
3113 * - encoding: set by libavcodec
3117 #if !FF_API_DEBUG_MV
3119 * debug motion vectors
3120 * - encoding: Set by user.
3121 * - decoding: Set by user.
3124 #define FF_DEBUG_VIS_MV_P_FOR 0x00000001 //visualize forward predicted MVs of P frames
3125 #define FF_DEBUG_VIS_MV_B_FOR 0x00000002 //visualize forward predicted MVs of B frames
3126 #define FF_DEBUG_VIS_MV_B_BACK 0x00000004 //visualize backward predicted MVs of B frames
3130 * custom intra quantization matrix
3131 * - encoding: Set by user, can be NULL.
3132 * - decoding: unused.
3134 uint16_t *chroma_intra_matrix;
3137 * dump format separator.
3138 * can be ", " or "\n " or anything else
3139 * - encoding: Set by user.
3140 * - decoding: Set by user.
3142 uint8_t *dump_separator;
3145 * ',' separated list of allowed decoders.
3146 * If NULL then all are allowed
3147 * - encoding: unused
3148 * - decoding: set by user
3150 char *codec_whitelist;
3153 * Properties of the stream that gets decoded
3154 * - encoding: unused
3155 * - decoding: set by libavcodec
3157 unsigned properties;
3158 #define FF_CODEC_PROPERTY_LOSSLESS 0x00000001
3159 #define FF_CODEC_PROPERTY_CLOSED_CAPTIONS 0x00000002
3162 * Additional data associated with the entire coded stream.
3164 * - decoding: unused
3165 * - encoding: may be set by libavcodec after avcodec_open2().
3167 AVPacketSideData *coded_side_data;
3168 int nb_coded_side_data;
3171 * A reference to the AVHWFramesContext describing the input (for encoding)
3172 * or output (decoding) frames. The reference is set by the caller and
3173 * afterwards owned (and freed) by libavcodec - it should never be read by
3174 * the caller after being set.
3176 * - decoding: This field should be set by the caller from the get_format()
3177 * callback. The previous reference (if any) will always be
3178 * unreffed by libavcodec before the get_format() call.
3180 * If the default get_buffer2() is used with a hwaccel pixel
3181 * format, then this AVHWFramesContext will be used for
3182 * allocating the frame buffers.
3184 * - encoding: For hardware encoders configured to use a hwaccel pixel
3185 * format, this field should be set by the caller to a reference
3186 * to the AVHWFramesContext describing input frames.
3187 * AVHWFramesContext.format must be equal to
3188 * AVCodecContext.pix_fmt.
3190 * This field should be set before avcodec_open2() is called.
3192 AVBufferRef *hw_frames_ctx;
3195 * Control the form of AVSubtitle.rects[N]->ass
3196 * - decoding: set by user
3197 * - encoding: unused
3199 int sub_text_format;
3200 #define FF_SUB_TEXT_FMT_ASS 0
3201 #if FF_API_ASS_TIMING
3202 #define FF_SUB_TEXT_FMT_ASS_WITH_TIMINGS 1
3206 * Audio only. The amount of padding (in samples) appended by the encoder to
3207 * the end of the audio. I.e. this number of decoded samples must be
3208 * discarded by the caller from the end of the stream to get the original
3209 * audio without any trailing padding.
3211 * - decoding: unused
3212 * - encoding: unused
3214 int trailing_padding;
3217 * The number of pixels per image to maximally accept.
3219 * - decoding: set by user
3220 * - encoding: set by user
3225 * A reference to the AVHWDeviceContext describing the device which will
3226 * be used by a hardware encoder/decoder. The reference is set by the
3227 * caller and afterwards owned (and freed) by libavcodec.
3229 * This should be used if either the codec device does not require
3230 * hardware frames or any that are used are to be allocated internally by
3231 * libavcodec. If the user wishes to supply any of the frames used as
3232 * encoder input or decoder output then hw_frames_ctx should be used
3233 * instead. When hw_frames_ctx is set in get_format() for a decoder, this
3234 * field will be ignored while decoding the associated stream segment, but
3235 * may again be used on a following one after another get_format() call.
3237 * For both encoders and decoders this field should be set before
3238 * avcodec_open2() is called and must not be written to thereafter.
3240 * Note that some decoders may require this field to be set initially in
3241 * order to support hw_frames_ctx at all - in that case, all frames
3242 * contexts used must be created on the same device.
3244 AVBufferRef *hw_device_ctx;
3247 * Bit set of AV_HWACCEL_FLAG_* flags, which affect hardware accelerated
3248 * decoding (if active).
3249 * - encoding: unused
3250 * - decoding: Set by user (either before avcodec_open2(), or in the
3251 * AVCodecContext.get_format callback)
3256 * Video decoding only. Certain video codecs support cropping, meaning that
3257 * only a sub-rectangle of the decoded frame is intended for display. This
3258 * option controls how cropping is handled by libavcodec.
3260 * When set to 1 (the default), libavcodec will apply cropping internally.
3261 * I.e. it will modify the output frame width/height fields and offset the
3262 * data pointers (only by as much as possible while preserving alignment, or
3263 * by the full amount if the AV_CODEC_FLAG_UNALIGNED flag is set) so that
3264 * the frames output by the decoder refer only to the cropped area. The
3265 * crop_* fields of the output frames will be zero.
3267 * When set to 0, the width/height fields of the output frames will be set
3268 * to the coded dimensions and the crop_* fields will describe the cropping
3269 * rectangle. Applying the cropping is left to the caller.
3271 * @warning When hardware acceleration with opaque output frames is used,
3272 * libavcodec is unable to apply cropping from the top/left border.
3274 * @note when this option is set to zero, the width/height fields of the
3275 * AVCodecContext and output AVFrames have different meanings. The codec
3276 * context fields store display dimensions (with the coded dimensions in
3277 * coded_width/height), while the frame fields store the coded dimensions
3278 * (with the display dimensions being determined by the crop_* fields).
3283 * Video decoding only. Sets the number of extra hardware frames which
3284 * the decoder will allocate for use by the caller. This must be set
3285 * before avcodec_open2() is called.
3287 * Some hardware decoders require all frames that they will use for
3288 * output to be defined in advance before decoding starts. For such
3289 * decoders, the hardware frame pool must therefore be of a fixed size.
3290 * The extra frames set here are on top of any number that the decoder
3291 * needs internally in order to operate normally (for example, frames
3292 * used as reference pictures).
3294 int extra_hw_frames;
3297 #if FF_API_CODEC_GET_SET
3299 * Accessors for some AVCodecContext fields. These used to be provided for ABI
3300 * compatibility, and do not need to be used anymore.
3302 attribute_deprecated
3303 AVRational av_codec_get_pkt_timebase (const AVCodecContext *avctx);
3304 attribute_deprecated
3305 void av_codec_set_pkt_timebase (AVCodecContext *avctx, AVRational val);
3307 attribute_deprecated
3308 const AVCodecDescriptor *av_codec_get_codec_descriptor(const AVCodecContext *avctx);
3309 attribute_deprecated
3310 void av_codec_set_codec_descriptor(AVCodecContext *avctx, const AVCodecDescriptor *desc);
3312 attribute_deprecated
3313 unsigned av_codec_get_codec_properties(const AVCodecContext *avctx);
3316 attribute_deprecated
3317 int av_codec_get_lowres(const AVCodecContext *avctx);
3318 attribute_deprecated
3319 void av_codec_set_lowres(AVCodecContext *avctx, int val);
3322 attribute_deprecated
3323 int av_codec_get_seek_preroll(const AVCodecContext *avctx);
3324 attribute_deprecated
3325 void av_codec_set_seek_preroll(AVCodecContext *avctx, int val);
3327 attribute_deprecated
3328 uint16_t *av_codec_get_chroma_intra_matrix(const AVCodecContext *avctx);
3329 attribute_deprecated
3330 void av_codec_set_chroma_intra_matrix(AVCodecContext *avctx, uint16_t *val);
3336 typedef struct AVProfile {
3338 const char *name; ///< short name for the profile
3343 * The codec supports this format via the hw_device_ctx interface.
3345 * When selecting this format, AVCodecContext.hw_device_ctx should
3346 * have been set to a device of the specified type before calling
3349 AV_CODEC_HW_CONFIG_METHOD_HW_DEVICE_CTX = 0x01,
3351 * The codec supports this format via the hw_frames_ctx interface.
3353 * When selecting this format for a decoder,
3354 * AVCodecContext.hw_frames_ctx should be set to a suitable frames
3355 * context inside the get_format() callback. The frames context
3356 * must have been created on a device of the specified type.
3358 AV_CODEC_HW_CONFIG_METHOD_HW_FRAMES_CTX = 0x02,
3360 * The codec supports this format by some internal method.
3362 * This format can be selected without any additional configuration -
3363 * no device or frames context is required.
3365 AV_CODEC_HW_CONFIG_METHOD_INTERNAL = 0x04,
3367 * The codec supports this format by some ad-hoc method.
3369 * Additional settings and/or function calls are required. See the
3370 * codec-specific documentation for details. (Methods requiring
3371 * this sort of configuration are deprecated and others should be
3372 * used in preference.)
3374 AV_CODEC_HW_CONFIG_METHOD_AD_HOC = 0x08,
3377 typedef struct AVCodecHWConfig {
3379 * A hardware pixel format which the codec can use.
3381 enum AVPixelFormat pix_fmt;
3383 * Bit set of AV_CODEC_HW_CONFIG_METHOD_* flags, describing the possible
3384 * setup methods which can be used with this configuration.
3388 * The device type associated with the configuration.
3390 * Must be set for AV_CODEC_HW_CONFIG_METHOD_HW_DEVICE_CTX and
3391 * AV_CODEC_HW_CONFIG_METHOD_HW_FRAMES_CTX, otherwise unused.
3393 enum AVHWDeviceType device_type;
3396 typedef struct AVCodecDefault AVCodecDefault;
3403 typedef struct AVCodec {
3405 * Name of the codec implementation.
3406 * The name is globally unique among encoders and among decoders (but an
3407 * encoder and a decoder can share the same name).
3408 * This is the primary way to find a codec from the user perspective.
3412 * Descriptive name for the codec, meant to be more human readable than name.
3413 * You should use the NULL_IF_CONFIG_SMALL() macro to define it.
3415 const char *long_name;
3416 enum AVMediaType type;
3419 * Codec capabilities.
3420 * see AV_CODEC_CAP_*
3423 const AVRational *supported_framerates; ///< array of supported framerates, or NULL if any, array is terminated by {0,0}
3424 const enum AVPixelFormat *pix_fmts; ///< array of supported pixel formats, or NULL if unknown, array is terminated by -1
3425 const int *supported_samplerates; ///< array of supported audio samplerates, or NULL if unknown, array is terminated by 0
3426 const enum AVSampleFormat *sample_fmts; ///< array of supported sample formats, or NULL if unknown, array is terminated by -1
3427 const uint64_t *channel_layouts; ///< array of support channel layouts, or NULL if unknown. array is terminated by 0
3428 uint8_t max_lowres; ///< maximum value for lowres supported by the decoder
3429 const AVClass *priv_class; ///< AVClass for the private context
3430 const AVProfile *profiles; ///< array of recognized profiles, or NULL if unknown, array is terminated by {FF_PROFILE_UNKNOWN}
3433 * Group name of the codec implementation.
3434 * This is a short symbolic name of the wrapper backing this codec. A
3435 * wrapper uses some kind of external implementation for the codec, such
3436 * as an external library, or a codec implementation provided by the OS or
3438 * If this field is NULL, this is a builtin, libavcodec native codec.
3439 * If non-NULL, this will be the suffix in AVCodec.name in most cases
3440 * (usually AVCodec.name will be of the form "<codec_name>_<wrapper_name>").
3442 const char *wrapper_name;
3444 /*****************************************************************
3445 * No fields below this line are part of the public API. They
3446 * may not be used outside of libavcodec and can be changed and
3448 * New public fields should be added right above.
3449 *****************************************************************
3452 struct AVCodec *next;
3454 * @name Frame-level threading support functions
3458 * If defined, called on thread contexts when they are created.
3459 * If the codec allocates writable tables in init(), re-allocate them here.
3460 * priv_data will be set to a copy of the original.
3462 int (*init_thread_copy)(AVCodecContext *);
3464 * Copy necessary context variables from a previous thread context to the current one.
3465 * If not defined, the next thread will start automatically; otherwise, the codec
3466 * must call ff_thread_finish_setup().
3468 * dst and src will (rarely) point to the same context, in which case memcpy should be skipped.
3470 int (*update_thread_context)(AVCodecContext *dst, const AVCodecContext *src);
3474 * Private codec-specific defaults.
3476 const AVCodecDefault *defaults;
3479 * Initialize codec static data, called from avcodec_register().
3481 * This is not intended for time consuming operations as it is
3482 * run for every codec regardless of that codec being used.
3484 void (*init_static_data)(struct AVCodec *codec);
3486 int (*init)(AVCodecContext *);
3487 int (*encode_sub)(AVCodecContext *, uint8_t *buf, int buf_size,
3488 const struct AVSubtitle *sub);
3490 * Encode data to an AVPacket.
3492 * @param avctx codec context
3493 * @param avpkt output AVPacket (may contain a user-provided buffer)
3494 * @param[in] frame AVFrame containing the raw data to be encoded
3495 * @param[out] got_packet_ptr encoder sets to 0 or 1 to indicate that a
3496 * non-empty packet was returned in avpkt.
3497 * @return 0 on success, negative error code on failure
3499 int (*encode2)(AVCodecContext *avctx, AVPacket *avpkt, const AVFrame *frame,
3500 int *got_packet_ptr);
3501 int (*decode)(AVCodecContext *, void *outdata, int *outdata_size, AVPacket *avpkt);
3502 int (*close)(AVCodecContext *);
3504 * Encode API with decoupled packet/frame dataflow. The API is the
3505 * same as the avcodec_ prefixed APIs (avcodec_send_frame() etc.), except
3507 * - never called if the codec is closed or the wrong type,
3508 * - if AV_CODEC_CAP_DELAY is not set, drain frames are never sent,
3509 * - only one drain frame is ever passed down,
3511 int (*send_frame)(AVCodecContext *avctx, const AVFrame *frame);
3512 int (*receive_packet)(AVCodecContext *avctx, AVPacket *avpkt);
3515 * Decode API with decoupled packet/frame dataflow. This function is called
3516 * to get one output frame. It should call ff_decode_get_packet() to obtain
3519 int (*receive_frame)(AVCodecContext *avctx, AVFrame *frame);
3522 * Will be called when seeking
3524 void (*flush)(AVCodecContext *);
3526 * Internal codec capabilities.
3527 * See FF_CODEC_CAP_* in internal.h
3532 * Decoding only, a comma-separated list of bitstream filters to apply to
3533 * packets before decoding.
3538 * Array of pointers to hardware configurations supported by the codec,
3539 * or NULL if no hardware supported. The array is terminated by a NULL
3542 * The user can only access this field via avcodec_get_hw_config().
3544 const struct AVCodecHWConfigInternal **hw_configs;
3547 #if FF_API_CODEC_GET_SET
3548 attribute_deprecated
3549 int av_codec_get_max_lowres(const AVCodec *codec);
3552 struct MpegEncContext;
3555 * Retrieve supported hardware configurations for a codec.
3557 * Values of index from zero to some maximum return the indexed configuration
3558 * descriptor; all other values return NULL. If the codec does not support
3559 * any hardware configurations then it will always return NULL.
3561 const AVCodecHWConfig *avcodec_get_hw_config(const AVCodec *codec, int index);
3564 * @defgroup lavc_hwaccel AVHWAccel
3566 * @note Nothing in this structure should be accessed by the user. At some
3567 * point in future it will not be externally visible at all.
3571 typedef struct AVHWAccel {
3573 * Name of the hardware accelerated codec.
3574 * The name is globally unique among encoders and among decoders (but an
3575 * encoder and a decoder can share the same name).
3580 * Type of codec implemented by the hardware accelerator.
3582 * See AVMEDIA_TYPE_xxx
3584 enum AVMediaType type;
3587 * Codec implemented by the hardware accelerator.
3589 * See AV_CODEC_ID_xxx
3594 * Supported pixel format.
3596 * Only hardware accelerated formats are supported here.
3598 enum AVPixelFormat pix_fmt;
3601 * Hardware accelerated codec capabilities.
3602 * see AV_HWACCEL_CODEC_CAP_*
3606 /*****************************************************************
3607 * No fields below this line are part of the public API. They
3608 * may not be used outside of libavcodec and can be changed and
3610 * New public fields should be added right above.
3611 *****************************************************************
3615 * Allocate a custom buffer
3617 int (*alloc_frame)(AVCodecContext *avctx, AVFrame *frame);
3620 * Called at the beginning of each frame or field picture.
3622 * Meaningful frame information (codec specific) is guaranteed to
3623 * be parsed at this point. This function is mandatory.
3625 * Note that buf can be NULL along with buf_size set to 0.
3626 * Otherwise, this means the whole frame is available at this point.
3628 * @param avctx the codec context
3629 * @param buf the frame data buffer base
3630 * @param buf_size the size of the frame in bytes
3631 * @return zero if successful, a negative value otherwise
3633 int (*start_frame)(AVCodecContext *avctx, const uint8_t *buf, uint32_t buf_size);
3636 * Callback for parameter data (SPS/PPS/VPS etc).
3638 * Useful for hardware decoders which keep persistent state about the
3639 * video parameters, and need to receive any changes to update that state.
3641 * @param avctx the codec context
3642 * @param type the nal unit type
3643 * @param buf the nal unit data buffer
3644 * @param buf_size the size of the nal unit in bytes
3645 * @return zero if successful, a negative value otherwise
3647 int (*decode_params)(AVCodecContext *avctx, int type, const uint8_t *buf, uint32_t buf_size);
3650 * Callback for each slice.
3652 * Meaningful slice information (codec specific) is guaranteed to
3653 * be parsed at this point. This function is mandatory.
3654 * The only exception is XvMC, that works on MB level.
3656 * @param avctx the codec context
3657 * @param buf the slice data buffer base
3658 * @param buf_size the size of the slice in bytes
3659 * @return zero if successful, a negative value otherwise
3661 int (*decode_slice)(AVCodecContext *avctx, const uint8_t *buf, uint32_t buf_size);
3664 * Called at the end of each frame or field picture.
3666 * The whole picture is parsed at this point and can now be sent
3667 * to the hardware accelerator. This function is mandatory.
3669 * @param avctx the codec context
3670 * @return zero if successful, a negative value otherwise
3672 int (*end_frame)(AVCodecContext *avctx);
3675 * Size of per-frame hardware accelerator private data.
3677 * Private data is allocated with av_mallocz() before
3678 * AVCodecContext.get_buffer() and deallocated after
3679 * AVCodecContext.release_buffer().
3681 int frame_priv_data_size;
3684 * Called for every Macroblock in a slice.
3686 * XvMC uses it to replace the ff_mpv_reconstruct_mb().
3687 * Instead of decoding to raw picture, MB parameters are
3688 * stored in an array provided by the video driver.
3690 * @param s the mpeg context
3692 void (*decode_mb)(struct MpegEncContext *s);
3695 * Initialize the hwaccel private data.
3697 * This will be called from ff_get_format(), after hwaccel and
3698 * hwaccel_context are set and the hwaccel private data in AVCodecInternal
3701 int (*init)(AVCodecContext *avctx);
3704 * Uninitialize the hwaccel private data.
3706 * This will be called from get_format() or avcodec_close(), after hwaccel
3707 * and hwaccel_context are already uninitialized.
3709 int (*uninit)(AVCodecContext *avctx);
3712 * Size of the private data to allocate in
3713 * AVCodecInternal.hwaccel_priv_data.
3718 * Internal hwaccel capabilities.
3723 * Fill the given hw_frames context with current codec parameters. Called
3724 * from get_format. Refer to avcodec_get_hw_frames_parameters() for
3727 * This CAN be called before AVHWAccel.init is called, and you must assume
3728 * that avctx->hwaccel_priv_data is invalid.
3730 int (*frame_params)(AVCodecContext *avctx, AVBufferRef *hw_frames_ctx);
3734 * HWAccel is experimental and is thus avoided in favor of non experimental
3737 #define AV_HWACCEL_CODEC_CAP_EXPERIMENTAL 0x0200
3740 * Hardware acceleration should be used for decoding even if the codec level
3741 * used is unknown or higher than the maximum supported level reported by the
3744 * It's generally a good idea to pass this flag unless you have a specific
3745 * reason not to, as hardware tends to under-report supported levels.
3747 #define AV_HWACCEL_FLAG_IGNORE_LEVEL (1 << 0)
3750 * Hardware acceleration can output YUV pixel formats with a different chroma
3751 * sampling than 4:2:0 and/or other than 8 bits per component.
3753 #define AV_HWACCEL_FLAG_ALLOW_HIGH_DEPTH (1 << 1)
3756 * Hardware acceleration should still be attempted for decoding when the
3757 * codec profile does not match the reported capabilities of the hardware.
3759 * For example, this can be used to try to decode baseline profile H.264
3760 * streams in hardware - it will often succeed, because many streams marked
3761 * as baseline profile actually conform to constrained baseline profile.
3763 * @warning If the stream is actually not supported then the behaviour is
3764 * undefined, and may include returning entirely incorrect output
3765 * while indicating success.
3767 #define AV_HWACCEL_FLAG_ALLOW_PROFILE_MISMATCH (1 << 2)
3773 #if FF_API_AVPICTURE
3775 * @defgroup lavc_picture AVPicture
3777 * Functions for working with AVPicture
3782 * Picture data structure.
3784 * Up to four components can be stored into it, the last component is
3786 * @deprecated use AVFrame or imgutils functions instead
3788 typedef struct AVPicture {
3789 attribute_deprecated
3790 uint8_t *data[AV_NUM_DATA_POINTERS]; ///< pointers to the image data planes
3791 attribute_deprecated
3792 int linesize[AV_NUM_DATA_POINTERS]; ///< number of bytes per line
3800 enum AVSubtitleType {
3803 SUBTITLE_BITMAP, ///< A bitmap, pict will be set
3806 * Plain text, the text field must be set by the decoder and is
3807 * authoritative. ass and pict fields may contain approximations.
3812 * Formatted text, the ass field must be set by the decoder and is
3813 * authoritative. pict and text fields may contain approximations.
3818 #define AV_SUBTITLE_FLAG_FORCED 0x00000001
3820 typedef struct AVSubtitleRect {
3821 int x; ///< top left corner of pict, undefined when pict is not set
3822 int y; ///< top left corner of pict, undefined when pict is not set
3823 int w; ///< width of pict, undefined when pict is not set
3824 int h; ///< height of pict, undefined when pict is not set
3825 int nb_colors; ///< number of colors in pict, undefined when pict is not set
3827 #if FF_API_AVPICTURE
3829 * @deprecated unused
3831 attribute_deprecated
3835 * data+linesize for the bitmap of this subtitle.
3836 * Can be set for text/ass as well once they are rendered.
3841 enum AVSubtitleType type;
3843 char *text; ///< 0 terminated plain UTF-8 text
3846 * 0 terminated ASS/SSA compatible event line.
3847 * The presentation of this is unaffected by the other values in this
3855 typedef struct AVSubtitle {
3856 uint16_t format; /* 0 = graphics */
3857 uint32_t start_display_time; /* relative to packet pts, in ms */
3858 uint32_t end_display_time; /* relative to packet pts, in ms */
3860 AVSubtitleRect **rects;
3861 int64_t pts; ///< Same as packet pts, in AV_TIME_BASE
3865 * This struct describes the properties of an encoded stream.
3867 * sizeof(AVCodecParameters) is not a part of the public ABI, this struct must
3868 * be allocated with avcodec_parameters_alloc() and freed with
3869 * avcodec_parameters_free().
3871 typedef struct AVCodecParameters {
3873 * General type of the encoded data.
3875 enum AVMediaType codec_type;
3877 * Specific type of the encoded data (the codec used).
3879 enum AVCodecID codec_id;
3881 * Additional information about the codec (corresponds to the AVI FOURCC).
3886 * Extra binary data needed for initializing the decoder, codec-dependent.
3888 * Must be allocated with av_malloc() and will be freed by
3889 * avcodec_parameters_free(). The allocated size of extradata must be at
3890 * least extradata_size + AV_INPUT_BUFFER_PADDING_SIZE, with the padding
3895 * Size of the extradata content in bytes.
3900 * - video: the pixel format, the value corresponds to enum AVPixelFormat.
3901 * - audio: the sample format, the value corresponds to enum AVSampleFormat.
3906 * The average bitrate of the encoded data (in bits per second).
3911 * The number of bits per sample in the codedwords.
3913 * This is basically the bitrate per sample. It is mandatory for a bunch of
3914 * formats to actually decode them. It's the number of bits for one sample in
3915 * the actual coded bitstream.
3917 * This could be for example 4 for ADPCM
3918 * For PCM formats this matches bits_per_raw_sample
3921 int bits_per_coded_sample;
3924 * This is the number of valid bits in each output sample. If the
3925 * sample format has more bits, the least significant bits are additional
3926 * padding bits, which are always 0. Use right shifts to reduce the sample
3927 * to its actual size. For example, audio formats with 24 bit samples will
3928 * have bits_per_raw_sample set to 24, and format set to AV_SAMPLE_FMT_S32.
3929 * To get the original sample use "(int32_t)sample >> 8"."
3931 * For ADPCM this might be 12 or 16 or similar
3934 int bits_per_raw_sample;
3937 * Codec-specific bitstream restrictions that the stream conforms to.
3943 * Video only. The dimensions of the video frame in pixels.
3949 * Video only. The aspect ratio (width / height) which a single pixel
3950 * should have when displayed.
3952 * When the aspect ratio is unknown / undefined, the numerator should be
3953 * set to 0 (the denominator may have any value).
3955 AVRational sample_aspect_ratio;
3958 * Video only. The order of the fields in interlaced video.
3960 enum AVFieldOrder field_order;
3963 * Video only. Additional colorspace characteristics.
3965 enum AVColorRange color_range;
3966 enum AVColorPrimaries color_primaries;
3967 enum AVColorTransferCharacteristic color_trc;
3968 enum AVColorSpace color_space;
3969 enum AVChromaLocation chroma_location;
3972 * Video only. Number of delayed frames.
3977 * Audio only. The channel layout bitmask. May be 0 if the channel layout is
3978 * unknown or unspecified, otherwise the number of bits set must be equal to
3979 * the channels field.
3981 uint64_t channel_layout;
3983 * Audio only. The number of audio channels.
3987 * Audio only. The number of audio samples per second.
3991 * Audio only. The number of bytes per coded audio frame, required by some
3994 * Corresponds to nBlockAlign in WAVEFORMATEX.
3998 * Audio only. Audio frame size, if known. Required by some formats to be static.
4003 * Audio only. The amount of padding (in samples) inserted by the encoder at
4004 * the beginning of the audio. I.e. this number of leading decoded samples
4005 * must be discarded by the caller to get the original audio without leading
4008 int initial_padding;
4010 * Audio only. The amount of padding (in samples) appended by the encoder to
4011 * the end of the audio. I.e. this number of decoded samples must be
4012 * discarded by the caller from the end of the stream to get the original
4013 * audio without any trailing padding.
4015 int trailing_padding;
4017 * Audio only. Number of samples to skip after a discontinuity.
4020 } AVCodecParameters;
4023 * Iterate over all registered codecs.
4025 * @param opaque a pointer where libavcodec will store the iteration state. Must
4026 * point to NULL to start the iteration.
4028 * @return the next registered codec or NULL when the iteration is
4031 const AVCodec *av_codec_iterate(void **opaque);
4035 * If c is NULL, returns the first registered codec,
4036 * if c is non-NULL, returns the next registered codec after c,
4037 * or NULL if c is the last one.
4039 attribute_deprecated
4040 AVCodec *av_codec_next(const AVCodec *c);
4044 * Return the LIBAVCODEC_VERSION_INT constant.
4046 unsigned avcodec_version(void);
4049 * Return the libavcodec build-time configuration.
4051 const char *avcodec_configuration(void);
4054 * Return the libavcodec license.
4056 const char *avcodec_license(void);
4060 * Register the codec codec and initialize libavcodec.
4062 * @warning either this function or avcodec_register_all() must be called
4063 * before any other libavcodec functions.
4065 * @see avcodec_register_all()
4067 attribute_deprecated
4068 void avcodec_register(AVCodec *codec);
4071 * Register all the codecs, parsers and bitstream filters which were enabled at
4072 * configuration time. If you do not call this function you can select exactly
4073 * which formats you want to support, by using the individual registration
4076 * @see avcodec_register
4077 * @see av_register_codec_parser
4078 * @see av_register_bitstream_filter
4080 attribute_deprecated
4081 void avcodec_register_all(void);
4085 * Allocate an AVCodecContext and set its fields to default values. The
4086 * resulting struct should be freed with avcodec_free_context().
4088 * @param codec if non-NULL, allocate private data and initialize defaults
4089 * for the given codec. It is illegal to then call avcodec_open2()
4090 * with a different codec.
4091 * If NULL, then the codec-specific defaults won't be initialized,
4092 * which may result in suboptimal default settings (this is
4093 * important mainly for encoders, e.g. libx264).
4095 * @return An AVCodecContext filled with default values or NULL on failure.
4097 AVCodecContext *avcodec_alloc_context3(const AVCodec *codec);
4100 * Free the codec context and everything associated with it and write NULL to
4101 * the provided pointer.
4103 void avcodec_free_context(AVCodecContext **avctx);
4105 #if FF_API_GET_CONTEXT_DEFAULTS
4107 * @deprecated This function should not be used, as closing and opening a codec
4108 * context multiple time is not supported. A new codec context should be
4109 * allocated for each new use.
4111 int avcodec_get_context_defaults3(AVCodecContext *s, const AVCodec *codec);
4115 * Get the AVClass for AVCodecContext. It can be used in combination with
4116 * AV_OPT_SEARCH_FAKE_OBJ for examining options.
4118 * @see av_opt_find().
4120 const AVClass *avcodec_get_class(void);
4122 #if FF_API_COPY_CONTEXT
4124 * Get the AVClass for AVFrame. It can be used in combination with
4125 * AV_OPT_SEARCH_FAKE_OBJ for examining options.
4127 * @see av_opt_find().
4129 const AVClass *avcodec_get_frame_class(void);
4132 * Get the AVClass for AVSubtitleRect. It can be used in combination with
4133 * AV_OPT_SEARCH_FAKE_OBJ for examining options.
4135 * @see av_opt_find().
4137 const AVClass *avcodec_get_subtitle_rect_class(void);
4140 * Copy the settings of the source AVCodecContext into the destination
4141 * AVCodecContext. The resulting destination codec context will be
4142 * unopened, i.e. you are required to call avcodec_open2() before you
4143 * can use this AVCodecContext to decode/encode video/audio data.
4145 * @param dest target codec context, should be initialized with
4146 * avcodec_alloc_context3(NULL), but otherwise uninitialized
4147 * @param src source codec context
4148 * @return AVERROR() on error (e.g. memory allocation error), 0 on success
4150 * @deprecated The semantics of this function are ill-defined and it should not
4151 * be used. If you need to transfer the stream parameters from one codec context
4152 * to another, use an intermediate AVCodecParameters instance and the
4153 * avcodec_parameters_from_context() / avcodec_parameters_to_context()
4156 attribute_deprecated
4157 int avcodec_copy_context(AVCodecContext *dest, const AVCodecContext *src);
4161 * Allocate a new AVCodecParameters and set its fields to default values
4162 * (unknown/invalid/0). The returned struct must be freed with
4163 * avcodec_parameters_free().
4165 AVCodecParameters *avcodec_parameters_alloc(void);
4168 * Free an AVCodecParameters instance and everything associated with it and
4169 * write NULL to the supplied pointer.
4171 void avcodec_parameters_free(AVCodecParameters **par);
4174 * Copy the contents of src to dst. Any allocated fields in dst are freed and
4175 * replaced with newly allocated duplicates of the corresponding fields in src.
4177 * @return >= 0 on success, a negative AVERROR code on failure.
4179 int avcodec_parameters_copy(AVCodecParameters *dst, const AVCodecParameters *src);
4182 * Fill the parameters struct based on the values from the supplied codec
4183 * context. Any allocated fields in par are freed and replaced with duplicates
4184 * of the corresponding fields in codec.
4186 * @return >= 0 on success, a negative AVERROR code on failure
4188 int avcodec_parameters_from_context(AVCodecParameters *par,
4189 const AVCodecContext *codec);
4192 * Fill the codec context based on the values from the supplied codec
4193 * parameters. Any allocated fields in codec that have a corresponding field in
4194 * par are freed and replaced with duplicates of the corresponding field in par.
4195 * Fields in codec that do not have a counterpart in par are not touched.
4197 * @return >= 0 on success, a negative AVERROR code on failure.
4199 int avcodec_parameters_to_context(AVCodecContext *codec,
4200 const AVCodecParameters *par);
4203 * Initialize the AVCodecContext to use the given AVCodec. Prior to using this
4204 * function the context has to be allocated with avcodec_alloc_context3().
4206 * The functions avcodec_find_decoder_by_name(), avcodec_find_encoder_by_name(),
4207 * avcodec_find_decoder() and avcodec_find_encoder() provide an easy way for
4208 * retrieving a codec.
4210 * @warning This function is not thread safe!
4212 * @note Always call this function before using decoding routines (such as
4213 * @ref avcodec_receive_frame()).
4216 * avcodec_register_all();
4217 * av_dict_set(&opts, "b", "2.5M", 0);
4218 * codec = avcodec_find_decoder(AV_CODEC_ID_H264);
4222 * context = avcodec_alloc_context3(codec);
4224 * if (avcodec_open2(context, codec, opts) < 0)
4228 * @param avctx The context to initialize.
4229 * @param codec The codec to open this context for. If a non-NULL codec has been
4230 * previously passed to avcodec_alloc_context3() or
4231 * for this context, then this parameter MUST be either NULL or
4232 * equal to the previously passed codec.
4233 * @param options A dictionary filled with AVCodecContext and codec-private options.
4234 * On return this object will be filled with options that were not found.
4236 * @return zero on success, a negative value on error
4237 * @see avcodec_alloc_context3(), avcodec_find_decoder(), avcodec_find_encoder(),
4238 * av_dict_set(), av_opt_find().
4240 int avcodec_open2(AVCodecContext *avctx, const AVCodec *codec, AVDictionary **options);
4243 * Close a given AVCodecContext and free all the data associated with it
4244 * (but not the AVCodecContext itself).
4246 * Calling this function on an AVCodecContext that hasn't been opened will free
4247 * the codec-specific data allocated in avcodec_alloc_context3() with a non-NULL
4248 * codec. Subsequent calls will do nothing.
4250 * @note Do not use this function. Use avcodec_free_context() to destroy a
4251 * codec context (either open or closed). Opening and closing a codec context
4252 * multiple times is not supported anymore -- use multiple codec contexts
4255 int avcodec_close(AVCodecContext *avctx);
4258 * Free all allocated data in the given subtitle struct.
4260 * @param sub AVSubtitle to free.
4262 void avsubtitle_free(AVSubtitle *sub);
4269 * @addtogroup lavc_packet
4274 * Allocate an AVPacket and set its fields to default values. The resulting
4275 * struct must be freed using av_packet_free().
4277 * @return An AVPacket filled with default values or NULL on failure.
4279 * @note this only allocates the AVPacket itself, not the data buffers. Those
4280 * must be allocated through other means such as av_new_packet.
4282 * @see av_new_packet
4284 AVPacket *av_packet_alloc(void);
4287 * Create a new packet that references the same data as src.
4289 * This is a shortcut for av_packet_alloc()+av_packet_ref().
4291 * @return newly created AVPacket on success, NULL on error.
4293 * @see av_packet_alloc
4294 * @see av_packet_ref
4296 AVPacket *av_packet_clone(const AVPacket *src);
4299 * Free the packet, if the packet is reference counted, it will be
4300 * unreferenced first.
4302 * @param pkt packet to be freed. The pointer will be set to NULL.
4303 * @note passing NULL is a no-op.
4305 void av_packet_free(AVPacket **pkt);
4308 * Initialize optional fields of a packet with default values.
4310 * Note, this does not touch the data and size members, which have to be
4311 * initialized separately.
4315 void av_init_packet(AVPacket *pkt);
4318 * Allocate the payload of a packet and initialize its fields with
4322 * @param size wanted payload size
4323 * @return 0 if OK, AVERROR_xxx otherwise
4325 int av_new_packet(AVPacket *pkt, int size);
4328 * Reduce packet size, correctly zeroing padding
4331 * @param size new size
4333 void av_shrink_packet(AVPacket *pkt, int size);
4336 * Increase packet size, correctly zeroing padding
4339 * @param grow_by number of bytes by which to increase the size of the packet
4341 int av_grow_packet(AVPacket *pkt, int grow_by);
4344 * Initialize a reference-counted packet from av_malloc()ed data.
4346 * @param pkt packet to be initialized. This function will set the data, size,
4347 * buf and destruct fields, all others are left untouched.
4348 * @param data Data allocated by av_malloc() to be used as packet data. If this
4349 * function returns successfully, the data is owned by the underlying AVBuffer.
4350 * The caller may not access the data through other means.
4351 * @param size size of data in bytes, without the padding. I.e. the full buffer
4352 * size is assumed to be size + AV_INPUT_BUFFER_PADDING_SIZE.
4354 * @return 0 on success, a negative AVERROR on error
4356 int av_packet_from_data(AVPacket *pkt, uint8_t *data, int size);
4358 #if FF_API_AVPACKET_OLD_API
4360 * @warning This is a hack - the packet memory allocation stuff is broken. The
4361 * packet is allocated if it was not really allocated.
4363 * @deprecated Use av_packet_ref
4365 attribute_deprecated
4366 int av_dup_packet(AVPacket *pkt);
4368 * Copy packet, including contents
4370 * @return 0 on success, negative AVERROR on fail
4372 * @deprecated Use av_packet_ref
4374 attribute_deprecated
4375 int av_copy_packet(AVPacket *dst, const AVPacket *src);
4378 * Copy packet side data
4380 * @return 0 on success, negative AVERROR on fail
4382 * @deprecated Use av_packet_copy_props
4384 attribute_deprecated
4385 int av_copy_packet_side_data(AVPacket *dst, const AVPacket *src);
4390 * @deprecated Use av_packet_unref
4392 * @param pkt packet to free
4394 attribute_deprecated
4395 void av_free_packet(AVPacket *pkt);
4398 * Allocate new information of a packet.
4401 * @param type side information type
4402 * @param size side information size
4403 * @return pointer to fresh allocated data or NULL otherwise
4405 uint8_t* av_packet_new_side_data(AVPacket *pkt, enum AVPacketSideDataType type,
4409 * Wrap an existing array as a packet side data.
4412 * @param type side information type
4413 * @param data the side data array. It must be allocated with the av_malloc()
4414 * family of functions. The ownership of the data is transferred to
4416 * @param size side information size
4417 * @return a non-negative number on success, a negative AVERROR code on
4418 * failure. On failure, the packet is unchanged and the data remains
4419 * owned by the caller.
4421 int av_packet_add_side_data(AVPacket *pkt, enum AVPacketSideDataType type,
4422 uint8_t *data, size_t size);
4425 * Shrink the already allocated side data buffer
4428 * @param type side information type
4429 * @param size new side information size
4430 * @return 0 on success, < 0 on failure
4432 int av_packet_shrink_side_data(AVPacket *pkt, enum AVPacketSideDataType type,
4436 * Get side information from packet.
4439 * @param type desired side information type
4440 * @param size pointer for side information size to store (optional)
4441 * @return pointer to data if present or NULL otherwise
4443 uint8_t* av_packet_get_side_data(const AVPacket *pkt, enum AVPacketSideDataType type,
4446 #if FF_API_MERGE_SD_API
4447 attribute_deprecated
4448 int av_packet_merge_side_data(AVPacket *pkt);
4450 attribute_deprecated
4451 int av_packet_split_side_data(AVPacket *pkt);
4454 const char *av_packet_side_data_name(enum AVPacketSideDataType type);
4457 * Pack a dictionary for use in side_data.
4459 * @param dict The dictionary to pack.
4460 * @param size pointer to store the size of the returned data
4461 * @return pointer to data if successful, NULL otherwise
4463 uint8_t *av_packet_pack_dictionary(AVDictionary *dict, int *size);
4465 * Unpack a dictionary from side_data.
4467 * @param data data from side_data
4468 * @param size size of the data
4469 * @param dict the metadata storage dictionary
4470 * @return 0 on success, < 0 on failure
4472 int av_packet_unpack_dictionary(const uint8_t *data, int size, AVDictionary **dict);
4476 * Convenience function to free all the side data stored.
4477 * All the other fields stay untouched.
4481 void av_packet_free_side_data(AVPacket *pkt);
4484 * Setup a new reference to the data described by a given packet
4486 * If src is reference-counted, setup dst as a new reference to the
4487 * buffer in src. Otherwise allocate a new buffer in dst and copy the
4488 * data from src into it.
4490 * All the other fields are copied from src.
4492 * @see av_packet_unref
4494 * @param dst Destination packet
4495 * @param src Source packet
4497 * @return 0 on success, a negative AVERROR on error.
4499 int av_packet_ref(AVPacket *dst, const AVPacket *src);
4504 * Unreference the buffer referenced by the packet and reset the
4505 * remaining packet fields to their default values.
4507 * @param pkt The packet to be unreferenced.
4509 void av_packet_unref(AVPacket *pkt);
4512 * Move every field in src to dst and reset src.
4514 * @see av_packet_unref
4516 * @param src Source packet, will be reset
4517 * @param dst Destination packet
4519 void av_packet_move_ref(AVPacket *dst, AVPacket *src);
4522 * Copy only "properties" fields from src to dst.
4524 * Properties for the purpose of this function are all the fields
4525 * beside those related to the packet data (buf, data, size)
4527 * @param dst Destination packet
4528 * @param src Source packet
4530 * @return 0 on success AVERROR on failure.
4532 int av_packet_copy_props(AVPacket *dst, const AVPacket *src);
4535 * Create a writable reference for the data described by a given packet,
4536 * avoiding data copy if possible.
4538 * @param pkt Packet whose data should be made writable.
4540 * @return 0 on success, a negative AVERROR on failure. On failure, the
4541 * packet is unchanged.
4543 int av_packet_make_writable(AVPacket *pkt);
4546 * Convert valid timing fields (timestamps / durations) in a packet from one
4547 * timebase to another. Timestamps with unknown values (AV_NOPTS_VALUE) will be
4550 * @param pkt packet on which the conversion will be performed
4551 * @param tb_src source timebase, in which the timing fields in pkt are
4553 * @param tb_dst destination timebase, to which the timing fields will be
4556 void av_packet_rescale_ts(AVPacket *pkt, AVRational tb_src, AVRational tb_dst);
4563 * @addtogroup lavc_decoding
4568 * Find a registered decoder with a matching codec ID.
4570 * @param id AVCodecID of the requested decoder
4571 * @return A decoder if one was found, NULL otherwise.
4573 AVCodec *avcodec_find_decoder(enum AVCodecID id);
4576 * Find a registered decoder with the specified name.
4578 * @param name name of the requested decoder
4579 * @return A decoder if one was found, NULL otherwise.
4581 AVCodec *avcodec_find_decoder_by_name(const char *name);
4584 * The default callback for AVCodecContext.get_buffer2(). It is made public so
4585 * it can be called by custom get_buffer2() implementations for decoders without
4586 * AV_CODEC_CAP_DR1 set.
4588 int avcodec_default_get_buffer2(AVCodecContext *s, AVFrame *frame, int flags);
4591 * Modify width and height values so that they will result in a memory
4592 * buffer that is acceptable for the codec if you do not use any horizontal
4595 * May only be used if a codec with AV_CODEC_CAP_DR1 has been opened.
4597 void avcodec_align_dimensions(AVCodecContext *s, int *width, int *height);
4600 * Modify width and height values so that they will result in a memory
4601 * buffer that is acceptable for the codec if you also ensure that all
4602 * line sizes are a multiple of the respective linesize_align[i].
4604 * May only be used if a codec with AV_CODEC_CAP_DR1 has been opened.
4606 void avcodec_align_dimensions2(AVCodecContext *s, int *width, int *height,
4607 int linesize_align[AV_NUM_DATA_POINTERS]);
4610 * Converts AVChromaLocation to swscale x/y chroma position.
4612 * The positions represent the chroma (0,0) position in a coordinates system
4613 * with luma (0,0) representing the origin and luma(1,1) representing 256,256
4615 * @param xpos horizontal chroma sample position
4616 * @param ypos vertical chroma sample position
4618 int avcodec_enum_to_chroma_pos(int *xpos, int *ypos, enum AVChromaLocation pos);
4621 * Converts swscale x/y chroma position to AVChromaLocation.
4623 * The positions represent the chroma (0,0) position in a coordinates system
4624 * with luma (0,0) representing the origin and luma(1,1) representing 256,256
4626 * @param xpos horizontal chroma sample position
4627 * @param ypos vertical chroma sample position
4629 enum AVChromaLocation avcodec_chroma_pos_to_enum(int xpos, int ypos);
4632 * Decode the audio frame of size avpkt->size from avpkt->data into frame.
4634 * Some decoders may support multiple frames in a single AVPacket. Such
4635 * decoders would then just decode the first frame and the return value would be
4636 * less than the packet size. In this case, avcodec_decode_audio4 has to be
4637 * called again with an AVPacket containing the remaining data in order to
4638 * decode the second frame, etc... Even if no frames are returned, the packet
4639 * needs to be fed to the decoder with remaining data until it is completely
4640 * consumed or an error occurs.
4642 * Some decoders (those marked with AV_CODEC_CAP_DELAY) have a delay between input
4643 * and output. This means that for some packets they will not immediately
4644 * produce decoded output and need to be flushed at the end of decoding to get
4645 * all the decoded data. Flushing is done by calling this function with packets
4646 * with avpkt->data set to NULL and avpkt->size set to 0 until it stops
4647 * returning samples. It is safe to flush even those decoders that are not
4648 * marked with AV_CODEC_CAP_DELAY, then no samples will be returned.
4650 * @warning The input buffer, avpkt->data must be AV_INPUT_BUFFER_PADDING_SIZE
4651 * larger than the actual read bytes because some optimized bitstream
4652 * readers read 32 or 64 bits at once and could read over the end.
4654 * @note The AVCodecContext MUST have been opened with @ref avcodec_open2()
4655 * before packets may be fed to the decoder.
4657 * @param avctx the codec context
4658 * @param[out] frame The AVFrame in which to store decoded audio samples.
4659 * The decoder will allocate a buffer for the decoded frame by
4660 * calling the AVCodecContext.get_buffer2() callback.
4661 * When AVCodecContext.refcounted_frames is set to 1, the frame is
4662 * reference counted and the returned reference belongs to the
4663 * caller. The caller must release the frame using av_frame_unref()
4664 * when the frame is no longer needed. The caller may safely write
4665 * to the frame if av_frame_is_writable() returns 1.
4666 * When AVCodecContext.refcounted_frames is set to 0, the returned
4667 * reference belongs to the decoder and is valid only until the
4668 * next call to this function or until closing or flushing the
4669 * decoder. The caller may not write to it.
4670 * @param[out] got_frame_ptr Zero if no frame could be decoded, otherwise it is
4671 * non-zero. Note that this field being set to zero
4672 * does not mean that an error has occurred. For
4673 * decoders with AV_CODEC_CAP_DELAY set, no given decode
4674 * call is guaranteed to produce a frame.
4675 * @param[in] avpkt The input AVPacket containing the input buffer.
4676 * At least avpkt->data and avpkt->size should be set. Some
4677 * decoders might also require additional fields to be set.
4678 * @return A negative error code is returned if an error occurred during
4679 * decoding, otherwise the number of bytes consumed from the input
4680 * AVPacket is returned.
4682 * @deprecated Use avcodec_send_packet() and avcodec_receive_frame().
4684 attribute_deprecated
4685 int avcodec_decode_audio4(AVCodecContext *avctx, AVFrame *frame,
4686 int *got_frame_ptr, const AVPacket *avpkt);
4689 * Decode the video frame of size avpkt->size from avpkt->data into picture.
4690 * Some decoders may support multiple frames in a single AVPacket, such
4691 * decoders would then just decode the first frame.
4693 * @warning The input buffer must be AV_INPUT_BUFFER_PADDING_SIZE larger than
4694 * the actual read bytes because some optimized bitstream readers read 32 or 64
4695 * bits at once and could read over the end.
4697 * @warning The end of the input buffer buf should be set to 0 to ensure that
4698 * no overreading happens for damaged MPEG streams.
4700 * @note Codecs which have the AV_CODEC_CAP_DELAY capability set have a delay
4701 * between input and output, these need to be fed with avpkt->data=NULL,
4702 * avpkt->size=0 at the end to return the remaining frames.
4704 * @note The AVCodecContext MUST have been opened with @ref avcodec_open2()
4705 * before packets may be fed to the decoder.
4707 * @param avctx the codec context
4708 * @param[out] picture The AVFrame in which the decoded video frame will be stored.
4709 * Use av_frame_alloc() to get an AVFrame. The codec will
4710 * allocate memory for the actual bitmap by calling the
4711 * AVCodecContext.get_buffer2() callback.
4712 * When AVCodecContext.refcounted_frames is set to 1, the frame is
4713 * reference counted and the returned reference belongs to the
4714 * caller. The caller must release the frame using av_frame_unref()
4715 * when the frame is no longer needed. The caller may safely write
4716 * to the frame if av_frame_is_writable() returns 1.
4717 * When AVCodecContext.refcounted_frames is set to 0, the returned
4718 * reference belongs to the decoder and is valid only until the
4719 * next call to this function or until closing or flushing the
4720 * decoder. The caller may not write to it.
4722 * @param[in] avpkt The input AVPacket containing the input buffer.
4723 * You can create such packet with av_init_packet() and by then setting
4724 * data and size, some decoders might in addition need other fields like
4725 * flags&AV_PKT_FLAG_KEY. All decoders are designed to use the least
4727 * @param[in,out] got_picture_ptr Zero if no frame could be decompressed, otherwise, it is nonzero.
4728 * @return On error a negative value is returned, otherwise the number of bytes
4729 * used or zero if no frame could be decompressed.
4731 * @deprecated Use avcodec_send_packet() and avcodec_receive_frame().
4733 attribute_deprecated
4734 int avcodec_decode_video2(AVCodecContext *avctx, AVFrame *picture,
4735 int *got_picture_ptr,
4736 const AVPacket *avpkt);
4739 * Decode a subtitle message.
4740 * Return a negative value on error, otherwise return the number of bytes used.
4741 * If no subtitle could be decompressed, got_sub_ptr is zero.
4742 * Otherwise, the subtitle is stored in *sub.
4743 * Note that AV_CODEC_CAP_DR1 is not available for subtitle codecs. This is for
4744 * simplicity, because the performance difference is expect to be negligible
4745 * and reusing a get_buffer written for video codecs would probably perform badly
4746 * due to a potentially very different allocation pattern.
4748 * Some decoders (those marked with AV_CODEC_CAP_DELAY) have a delay between input
4749 * and output. This means that for some packets they will not immediately
4750 * produce decoded output and need to be flushed at the end of decoding to get
4751 * all the decoded data. Flushing is done by calling this function with packets
4752 * with avpkt->data set to NULL and avpkt->size set to 0 until it stops
4753 * returning subtitles. It is safe to flush even those decoders that are not
4754 * marked with AV_CODEC_CAP_DELAY, then no subtitles will be returned.
4756 * @note The AVCodecContext MUST have been opened with @ref avcodec_open2()
4757 * before packets may be fed to the decoder.
4759 * @param avctx the codec context
4760 * @param[out] sub The Preallocated AVSubtitle in which the decoded subtitle will be stored,
4761 * must be freed with avsubtitle_free if *got_sub_ptr is set.
4762 * @param[in,out] got_sub_ptr Zero if no subtitle could be decompressed, otherwise, it is nonzero.
4763 * @param[in] avpkt The input AVPacket containing the input buffer.
4765 int avcodec_decode_subtitle2(AVCodecContext *avctx, AVSubtitle *sub,
4770 * Supply raw packet data as input to a decoder.
4772 * Internally, this call will copy relevant AVCodecContext fields, which can
4773 * influence decoding per-packet, and apply them when the packet is actually
4774 * decoded. (For example AVCodecContext.skip_frame, which might direct the
4775 * decoder to drop the frame contained by the packet sent with this function.)
4777 * @warning The input buffer, avpkt->data must be AV_INPUT_BUFFER_PADDING_SIZE
4778 * larger than the actual read bytes because some optimized bitstream
4779 * readers read 32 or 64 bits at once and could read over the end.
4781 * @warning Do not mix this API with the legacy API (like avcodec_decode_video2())
4782 * on the same AVCodecContext. It will return unexpected results now
4783 * or in future libavcodec versions.
4785 * @note The AVCodecContext MUST have been opened with @ref avcodec_open2()
4786 * before packets may be fed to the decoder.
4788 * @param avctx codec context
4789 * @param[in] avpkt The input AVPacket. Usually, this will be a single video
4790 * frame, or several complete audio frames.
4791 * Ownership of the packet remains with the caller, and the
4792 * decoder will not write to the packet. The decoder may create
4793 * a reference to the packet data (or copy it if the packet is
4794 * not reference-counted).
4795 * Unlike with older APIs, the packet is always fully consumed,
4796 * and if it contains multiple frames (e.g. some audio codecs),
4797 * will require you to call avcodec_receive_frame() multiple
4798 * times afterwards before you can send a new packet.
4799 * It can be NULL (or an AVPacket with data set to NULL and
4800 * size set to 0); in this case, it is considered a flush
4801 * packet, which signals the end of the stream. Sending the
4802 * first flush packet will return success. Subsequent ones are
4803 * unnecessary and will return AVERROR_EOF. If the decoder
4804 * still has frames buffered, it will return them after sending
4807 * @return 0 on success, otherwise negative error code:
4808 * AVERROR(EAGAIN): input is not accepted in the current state - user
4809 * must read output with avcodec_receive_frame() (once
4810 * all output is read, the packet should be resent, and
4811 * the call will not fail with EAGAIN).
4812 * AVERROR_EOF: the decoder has been flushed, and no new packets can
4813 * be sent to it (also returned if more than 1 flush
4815 * AVERROR(EINVAL): codec not opened, it is an encoder, or requires flush
4816 * AVERROR(ENOMEM): failed to add packet to internal queue, or similar
4817 * other errors: legitimate decoding errors
4819 int avcodec_send_packet(AVCodecContext *avctx, const AVPacket *avpkt);
4822 * Return decoded output data from a decoder.
4824 * @param avctx codec context
4825 * @param frame This will be set to a reference-counted video or audio
4826 * frame (depending on the decoder type) allocated by the
4827 * decoder. Note that the function will always call
4828 * av_frame_unref(frame) before doing anything else.
4831 * 0: success, a frame was returned
4832 * AVERROR(EAGAIN): output is not available in this state - user must try
4834 * AVERROR_EOF: the decoder has been fully flushed, and there will be
4835 * no more output frames
4836 * AVERROR(EINVAL): codec not opened, or it is an encoder
4837 * other negative values: legitimate decoding errors
4839 int avcodec_receive_frame(AVCodecContext *avctx, AVFrame *frame);
4842 * Supply a raw video or audio frame to the encoder. Use avcodec_receive_packet()
4843 * to retrieve buffered output packets.
4845 * @param avctx codec context
4846 * @param[in] frame AVFrame containing the raw audio or video frame to be encoded.
4847 * Ownership of the frame remains with the caller, and the
4848 * encoder will not write to the frame. The encoder may create
4849 * a reference to the frame data (or copy it if the frame is
4850 * not reference-counted).
4851 * It can be NULL, in which case it is considered a flush
4852 * packet. This signals the end of the stream. If the encoder
4853 * still has packets buffered, it will return them after this
4854 * call. Once flushing mode has been entered, additional flush
4855 * packets are ignored, and sending frames will return
4859 * If AV_CODEC_CAP_VARIABLE_FRAME_SIZE is set, then each frame
4860 * can have any number of samples.
4861 * If it is not set, frame->nb_samples must be equal to
4862 * avctx->frame_size for all frames except the last.
4863 * The final frame may be smaller than avctx->frame_size.
4864 * @return 0 on success, otherwise negative error code:
4865 * AVERROR(EAGAIN): input is not accepted in the current state - user
4866 * must read output with avcodec_receive_packet() (once
4867 * all output is read, the packet should be resent, and
4868 * the call will not fail with EAGAIN).
4869 * AVERROR_EOF: the encoder has been flushed, and no new frames can
4871 * AVERROR(EINVAL): codec not opened, refcounted_frames not set, it is a
4872 * decoder, or requires flush
4873 * AVERROR(ENOMEM): failed to add packet to internal queue, or similar
4874 * other errors: legitimate decoding errors
4876 int avcodec_send_frame(AVCodecContext *avctx, const AVFrame *frame);
4879 * Read encoded data from the encoder.
4881 * @param avctx codec context
4882 * @param avpkt This will be set to a reference-counted packet allocated by the
4883 * encoder. Note that the function will always call
4884 * av_frame_unref(frame) before doing anything else.
4885 * @return 0 on success, otherwise negative error code:
4886 * AVERROR(EAGAIN): output is not available in the current state - user
4887 * must try to send input
4888 * AVERROR_EOF: the encoder has been fully flushed, and there will be
4889 * no more output packets
4890 * AVERROR(EINVAL): codec not opened, or it is an encoder
4891 * other errors: legitimate decoding errors
4893 int avcodec_receive_packet(AVCodecContext *avctx, AVPacket *avpkt);
4896 * Create and return a AVHWFramesContext with values adequate for hardware
4897 * decoding. This is meant to get called from the get_format callback, and is
4898 * a helper for preparing a AVHWFramesContext for AVCodecContext.hw_frames_ctx.
4899 * This API is for decoding with certain hardware acceleration modes/APIs only.
4901 * The returned AVHWFramesContext is not initialized. The caller must do this
4902 * with av_hwframe_ctx_init().
4904 * Calling this function is not a requirement, but makes it simpler to avoid
4905 * codec or hardware API specific details when manually allocating frames.
4907 * Alternatively to this, an API user can set AVCodecContext.hw_device_ctx,
4908 * which sets up AVCodecContext.hw_frames_ctx fully automatically, and makes
4909 * it unnecessary to call this function or having to care about
4910 * AVHWFramesContext initialization at all.
4912 * There are a number of requirements for calling this function:
4914 * - It must be called from get_format with the same avctx parameter that was
4915 * passed to get_format. Calling it outside of get_format is not allowed, and
4916 * can trigger undefined behavior.
4917 * - The function is not always supported (see description of return values).
4918 * Even if this function returns successfully, hwaccel initialization could
4919 * fail later. (The degree to which implementations check whether the stream
4920 * is actually supported varies. Some do this check only after the user's
4921 * get_format callback returns.)
4922 * - The hw_pix_fmt must be one of the choices suggested by get_format. If the
4923 * user decides to use a AVHWFramesContext prepared with this API function,
4924 * the user must return the same hw_pix_fmt from get_format.
4925 * - The device_ref passed to this function must support the given hw_pix_fmt.
4926 * - After calling this API function, it is the user's responsibility to
4927 * initialize the AVHWFramesContext (returned by the out_frames_ref parameter),
4928 * and to set AVCodecContext.hw_frames_ctx to it. If done, this must be done
4929 * before returning from get_format (this is implied by the normal
4930 * AVCodecContext.hw_frames_ctx API rules).
4931 * - The AVHWFramesContext parameters may change every time time get_format is
4932 * called. Also, AVCodecContext.hw_frames_ctx is reset before get_format. So
4933 * you are inherently required to go through this process again on every
4935 * - It is perfectly possible to call this function without actually using
4936 * the resulting AVHWFramesContext. One use-case might be trying to reuse a
4937 * previously initialized AVHWFramesContext, and calling this API function
4938 * only to test whether the required frame parameters have changed.
4939 * - Fields that use dynamically allocated values of any kind must not be set
4940 * by the user unless setting them is explicitly allowed by the documentation.
4941 * If the user sets AVHWFramesContext.free and AVHWFramesContext.user_opaque,
4942 * the new free callback must call the potentially set previous free callback.
4943 * This API call may set any dynamically allocated fields, including the free
4946 * The function will set at least the following fields on AVHWFramesContext
4947 * (potentially more, depending on hwaccel API):
4949 * - All fields set by av_hwframe_ctx_alloc().
4950 * - Set the format field to hw_pix_fmt.
4951 * - Set the sw_format field to the most suited and most versatile format. (An
4952 * implication is that this will prefer generic formats over opaque formats
4953 * with arbitrary restrictions, if possible.)
4954 * - Set the width/height fields to the coded frame size, rounded up to the
4955 * API-specific minimum alignment.
4956 * - Only _if_ the hwaccel requires a pre-allocated pool: set the initial_pool_size
4957 * field to the number of maximum reference surfaces possible with the codec,
4958 * plus 1 surface for the user to work (meaning the user can safely reference
4959 * at most 1 decoded surface at a time), plus additional buffering introduced
4960 * by frame threading. If the hwaccel does not require pre-allocation, the
4961 * field is left to 0, and the decoder will allocate new surfaces on demand
4963 * - Possibly AVHWFramesContext.hwctx fields, depending on the underlying
4966 * Essentially, out_frames_ref returns the same as av_hwframe_ctx_alloc(), but
4967 * with basic frame parameters set.
4969 * The function is stateless, and does not change the AVCodecContext or the
4970 * device_ref AVHWDeviceContext.
4972 * @param avctx The context which is currently calling get_format, and which
4973 * implicitly contains all state needed for filling the returned
4974 * AVHWFramesContext properly.
4975 * @param device_ref A reference to the AVHWDeviceContext describing the device
4976 * which will be used by the hardware decoder.
4977 * @param hw_pix_fmt The hwaccel format you are going to return from get_format.
4978 * @param out_frames_ref On success, set to a reference to an _uninitialized_
4979 * AVHWFramesContext, created from the given device_ref.
4980 * Fields will be set to values required for decoding.
4981 * Not changed if an error is returned.
4982 * @return zero on success, a negative value on error. The following error codes
4983 * have special semantics:
4984 * AVERROR(ENOENT): the decoder does not support this functionality. Setup
4985 * is always manual, or it is a decoder which does not
4986 * support setting AVCodecContext.hw_frames_ctx at all,
4987 * or it is a software format.
4988 * AVERROR(EINVAL): it is known that hardware decoding is not supported for
4989 * this configuration, or the device_ref is not supported
4990 * for the hwaccel referenced by hw_pix_fmt.
4992 int avcodec_get_hw_frames_parameters(AVCodecContext *avctx,
4993 AVBufferRef *device_ref,
4994 enum AVPixelFormat hw_pix_fmt,
4995 AVBufferRef **out_frames_ref);
5000 * @defgroup lavc_parsing Frame parsing
5004 enum AVPictureStructure {
5005 AV_PICTURE_STRUCTURE_UNKNOWN, //< unknown
5006 AV_PICTURE_STRUCTURE_TOP_FIELD, //< coded as top field
5007 AV_PICTURE_STRUCTURE_BOTTOM_FIELD, //< coded as bottom field
5008 AV_PICTURE_STRUCTURE_FRAME, //< coded as frame
5011 typedef struct AVCodecParserContext {
5013 struct AVCodecParser *parser;
5014 int64_t frame_offset; /* offset of the current frame */
5015 int64_t cur_offset; /* current offset
5016 (incremented by each av_parser_parse()) */
5017 int64_t next_frame_offset; /* offset of the next frame */
5019 int pict_type; /* XXX: Put it back in AVCodecContext. */
5021 * This field is used for proper frame duration computation in lavf.
5022 * It signals, how much longer the frame duration of the current frame
5023 * is compared to normal frame duration.
5025 * frame_duration = (1 + repeat_pict) * time_base
5027 * It is used by codecs like H.264 to display telecined material.
5029 int repeat_pict; /* XXX: Put it back in AVCodecContext. */
5030 int64_t pts; /* pts of the current frame */
5031 int64_t dts; /* dts of the current frame */
5036 int fetch_timestamp;
5038 #define AV_PARSER_PTS_NB 4
5039 int cur_frame_start_index;
5040 int64_t cur_frame_offset[AV_PARSER_PTS_NB];
5041 int64_t cur_frame_pts[AV_PARSER_PTS_NB];
5042 int64_t cur_frame_dts[AV_PARSER_PTS_NB];
5045 #define PARSER_FLAG_COMPLETE_FRAMES 0x0001
5046 #define PARSER_FLAG_ONCE 0x0002
5047 /// Set if the parser has a valid file offset
5048 #define PARSER_FLAG_FETCHED_OFFSET 0x0004
5049 #define PARSER_FLAG_USE_CODEC_TS 0x1000
5051 int64_t offset; ///< byte offset from starting packet start
5052 int64_t cur_frame_end[AV_PARSER_PTS_NB];
5055 * Set by parser to 1 for key frames and 0 for non-key frames.
5056 * It is initialized to -1, so if the parser doesn't set this flag,
5057 * old-style fallback using AV_PICTURE_TYPE_I picture type as key frames
5062 #if FF_API_CONVERGENCE_DURATION
5064 * @deprecated unused
5066 attribute_deprecated
5067 int64_t convergence_duration;
5070 // Timestamp generation support:
5072 * Synchronization point for start of timestamp generation.
5074 * Set to >0 for sync point, 0 for no sync point and <0 for undefined
5077 * For example, this corresponds to presence of H.264 buffering period
5083 * Offset of the current timestamp against last timestamp sync point in
5084 * units of AVCodecContext.time_base.
5086 * Set to INT_MIN when dts_sync_point unused. Otherwise, it must
5087 * contain a valid timestamp offset.
5089 * Note that the timestamp of sync point has usually a nonzero
5090 * dts_ref_dts_delta, which refers to the previous sync point. Offset of
5091 * the next frame after timestamp sync point will be usually 1.
5093 * For example, this corresponds to H.264 cpb_removal_delay.
5095 int dts_ref_dts_delta;
5098 * Presentation delay of current frame in units of AVCodecContext.time_base.
5100 * Set to INT_MIN when dts_sync_point unused. Otherwise, it must
5101 * contain valid non-negative timestamp delta (presentation time of a frame
5102 * must not lie in the past).
5104 * This delay represents the difference between decoding and presentation
5105 * time of the frame.
5107 * For example, this corresponds to H.264 dpb_output_delay.
5112 * Position of the packet in file.
5114 * Analogous to cur_frame_pts/dts
5116 int64_t cur_frame_pos[AV_PARSER_PTS_NB];
5119 * Byte position of currently parsed frame in stream.
5124 * Previous frame byte position.
5129 * Duration of the current frame.
5130 * For audio, this is in units of 1 / AVCodecContext.sample_rate.
5131 * For all other types, this is in units of AVCodecContext.time_base.
5135 enum AVFieldOrder field_order;
5138 * Indicate whether a picture is coded as a frame, top field or bottom field.
5140 * For example, H.264 field_pic_flag equal to 0 corresponds to
5141 * AV_PICTURE_STRUCTURE_FRAME. An H.264 picture with field_pic_flag
5142 * equal to 1 and bottom_field_flag equal to 0 corresponds to
5143 * AV_PICTURE_STRUCTURE_TOP_FIELD.
5145 enum AVPictureStructure picture_structure;
5148 * Picture number incremented in presentation or output order.
5149 * This field may be reinitialized at the first picture of a new sequence.
5151 * For example, this corresponds to H.264 PicOrderCnt.
5153 int output_picture_number;
5156 * Dimensions of the decoded video intended for presentation.
5162 * Dimensions of the coded video.
5168 * The format of the coded data, corresponds to enum AVPixelFormat for video
5169 * and for enum AVSampleFormat for audio.
5171 * Note that a decoder can have considerable freedom in how exactly it
5172 * decodes the data, so the format reported here might be different from the
5173 * one returned by a decoder.
5176 } AVCodecParserContext;
5178 typedef struct AVCodecParser {
5179 int codec_ids[5]; /* several codec IDs are permitted */
5181 int (*parser_init)(AVCodecParserContext *s);
5182 /* This callback never returns an error, a negative value means that
5183 * the frame start was in a previous packet. */
5184 int (*parser_parse)(AVCodecParserContext *s,
5185 AVCodecContext *avctx,
5186 const uint8_t **poutbuf, int *poutbuf_size,
5187 const uint8_t *buf, int buf_size);
5188 void (*parser_close)(AVCodecParserContext *s);
5189 int (*split)(AVCodecContext *avctx, const uint8_t *buf, int buf_size);
5190 struct AVCodecParser *next;
5194 * Iterate over all registered codec parsers.
5196 * @param opaque a pointer where libavcodec will store the iteration state. Must
5197 * point to NULL to start the iteration.
5199 * @return the next registered codec parser or NULL when the iteration is
5202 const AVCodecParser *av_parser_iterate(void **opaque);
5204 attribute_deprecated
5205 AVCodecParser *av_parser_next(const AVCodecParser *c);
5207 attribute_deprecated
5208 void av_register_codec_parser(AVCodecParser *parser);
5209 AVCodecParserContext *av_parser_init(int codec_id);
5214 * @param s parser context.
5215 * @param avctx codec context.
5216 * @param poutbuf set to pointer to parsed buffer or NULL if not yet finished.
5217 * @param poutbuf_size set to size of parsed buffer or zero if not yet finished.
5218 * @param buf input buffer.
5219 * @param buf_size buffer size in bytes without the padding. I.e. the full buffer
5220 size is assumed to be buf_size + AV_INPUT_BUFFER_PADDING_SIZE.
5221 To signal EOF, this should be 0 (so that the last frame
5223 * @param pts input presentation timestamp.
5224 * @param dts input decoding timestamp.
5225 * @param pos input byte position in stream.
5226 * @return the number of bytes of the input bitstream used.
5231 * len = av_parser_parse2(myparser, AVCodecContext, &data, &size,
5238 * decode_frame(data, size);
5242 int av_parser_parse2(AVCodecParserContext *s,
5243 AVCodecContext *avctx,
5244 uint8_t **poutbuf, int *poutbuf_size,
5245 const uint8_t *buf, int buf_size,
5246 int64_t pts, int64_t dts,
5250 * @return 0 if the output buffer is a subset of the input, 1 if it is allocated and must be freed
5251 * @deprecated use AVBitStreamFilter
5253 int av_parser_change(AVCodecParserContext *s,
5254 AVCodecContext *avctx,
5255 uint8_t **poutbuf, int *poutbuf_size,
5256 const uint8_t *buf, int buf_size, int keyframe);
5257 void av_parser_close(AVCodecParserContext *s);
5265 * @addtogroup lavc_encoding
5270 * Find a registered encoder with a matching codec ID.
5272 * @param id AVCodecID of the requested encoder
5273 * @return An encoder if one was found, NULL otherwise.
5275 AVCodec *avcodec_find_encoder(enum AVCodecID id);
5278 * Find a registered encoder with the specified name.
5280 * @param name name of the requested encoder
5281 * @return An encoder if one was found, NULL otherwise.
5283 AVCodec *avcodec_find_encoder_by_name(const char *name);
5286 * Encode a frame of audio.
5288 * Takes input samples from frame and writes the next output packet, if
5289 * available, to avpkt. The output packet does not necessarily contain data for
5290 * the most recent frame, as encoders can delay, split, and combine input frames
5291 * internally as needed.
5293 * @param avctx codec context
5294 * @param avpkt output AVPacket.
5295 * The user can supply an output buffer by setting
5296 * avpkt->data and avpkt->size prior to calling the
5297 * function, but if the size of the user-provided data is not
5298 * large enough, encoding will fail. If avpkt->data and
5299 * avpkt->size are set, avpkt->destruct must also be set. All
5300 * other AVPacket fields will be reset by the encoder using
5301 * av_init_packet(). If avpkt->data is NULL, the encoder will
5302 * allocate it. The encoder will set avpkt->size to the size
5303 * of the output packet.
5305 * If this function fails or produces no output, avpkt will be
5306 * freed using av_packet_unref().
5307 * @param[in] frame AVFrame containing the raw audio data to be encoded.
5308 * May be NULL when flushing an encoder that has the
5309 * AV_CODEC_CAP_DELAY capability set.
5310 * If AV_CODEC_CAP_VARIABLE_FRAME_SIZE is set, then each frame
5311 * can have any number of samples.
5312 * If it is not set, frame->nb_samples must be equal to
5313 * avctx->frame_size for all frames except the last.
5314 * The final frame may be smaller than avctx->frame_size.
5315 * @param[out] got_packet_ptr This field is set to 1 by libavcodec if the
5316 * output packet is non-empty, and to 0 if it is
5317 * empty. If the function returns an error, the
5318 * packet can be assumed to be invalid, and the
5319 * value of got_packet_ptr is undefined and should
5321 * @return 0 on success, negative error code on failure
5323 * @deprecated use avcodec_send_frame()/avcodec_receive_packet() instead
5325 attribute_deprecated
5326 int avcodec_encode_audio2(AVCodecContext *avctx, AVPacket *avpkt,
5327 const AVFrame *frame, int *got_packet_ptr);
5330 * Encode a frame of video.
5332 * Takes input raw video data from frame and writes the next output packet, if
5333 * available, to avpkt. The output packet does not necessarily contain data for
5334 * the most recent frame, as encoders can delay and reorder input frames
5335 * internally as needed.
5337 * @param avctx codec context
5338 * @param avpkt output AVPacket.
5339 * The user can supply an output buffer by setting
5340 * avpkt->data and avpkt->size prior to calling the
5341 * function, but if the size of the user-provided data is not
5342 * large enough, encoding will fail. All other AVPacket fields
5343 * will be reset by the encoder using av_init_packet(). If
5344 * avpkt->data is NULL, the encoder will allocate it.
5345 * The encoder will set avpkt->size to the size of the
5346 * output packet. The returned data (if any) belongs to the
5347 * caller, he is responsible for freeing it.
5349 * If this function fails or produces no output, avpkt will be
5350 * freed using av_packet_unref().
5351 * @param[in] frame AVFrame containing the raw video data to be encoded.
5352 * May be NULL when flushing an encoder that has the
5353 * AV_CODEC_CAP_DELAY capability set.
5354 * @param[out] got_packet_ptr This field is set to 1 by libavcodec if the
5355 * output packet is non-empty, and to 0 if it is
5356 * empty. If the function returns an error, the
5357 * packet can be assumed to be invalid, and the
5358 * value of got_packet_ptr is undefined and should
5360 * @return 0 on success, negative error code on failure
5362 * @deprecated use avcodec_send_frame()/avcodec_receive_packet() instead
5364 attribute_deprecated
5365 int avcodec_encode_video2(AVCodecContext *avctx, AVPacket *avpkt,
5366 const AVFrame *frame, int *got_packet_ptr);
5368 int avcodec_encode_subtitle(AVCodecContext *avctx, uint8_t *buf, int buf_size,
5369 const AVSubtitle *sub);
5376 #if FF_API_AVPICTURE
5378 * @addtogroup lavc_picture
5383 * @deprecated unused
5385 attribute_deprecated
5386 int avpicture_alloc(AVPicture *picture, enum AVPixelFormat pix_fmt, int width, int height);
5389 * @deprecated unused
5391 attribute_deprecated
5392 void avpicture_free(AVPicture *picture);
5395 * @deprecated use av_image_fill_arrays() instead.
5397 attribute_deprecated
5398 int avpicture_fill(AVPicture *picture, const uint8_t *ptr,
5399 enum AVPixelFormat pix_fmt, int width, int height);
5402 * @deprecated use av_image_copy_to_buffer() instead.
5404 attribute_deprecated
5405 int avpicture_layout(const AVPicture *src, enum AVPixelFormat pix_fmt,
5406 int width, int height,
5407 unsigned char *dest, int dest_size);
5410 * @deprecated use av_image_get_buffer_size() instead.
5412 attribute_deprecated
5413 int avpicture_get_size(enum AVPixelFormat pix_fmt, int width, int height);
5416 * @deprecated av_image_copy() instead.
5418 attribute_deprecated
5419 void av_picture_copy(AVPicture *dst, const AVPicture *src,
5420 enum AVPixelFormat pix_fmt, int width, int height);
5423 * @deprecated unused
5425 attribute_deprecated
5426 int av_picture_crop(AVPicture *dst, const AVPicture *src,
5427 enum AVPixelFormat pix_fmt, int top_band, int left_band);
5430 * @deprecated unused
5432 attribute_deprecated
5433 int av_picture_pad(AVPicture *dst, const AVPicture *src, int height, int width, enum AVPixelFormat pix_fmt,
5434 int padtop, int padbottom, int padleft, int padright, int *color);
5442 * @defgroup lavc_misc Utility functions
5445 * Miscellaneous utility functions related to both encoding and decoding
5451 * @defgroup lavc_misc_pixfmt Pixel formats
5453 * Functions for working with pixel formats.
5457 #if FF_API_GETCHROMA
5459 * @deprecated Use av_pix_fmt_get_chroma_sub_sample
5462 attribute_deprecated
5463 void avcodec_get_chroma_sub_sample(enum AVPixelFormat pix_fmt, int *h_shift, int *v_shift);
5467 * Return a value representing the fourCC code associated to the
5468 * pixel format pix_fmt, or 0 if no associated fourCC code can be
5471 unsigned int avcodec_pix_fmt_to_codec_tag(enum AVPixelFormat pix_fmt);
5474 * @deprecated see av_get_pix_fmt_loss()
5476 int avcodec_get_pix_fmt_loss(enum AVPixelFormat dst_pix_fmt, enum AVPixelFormat src_pix_fmt,
5480 * Find the best pixel format to convert to given a certain source pixel
5481 * format. When converting from one pixel format to another, information loss
5482 * may occur. For example, when converting from RGB24 to GRAY, the color
5483 * information will be lost. Similarly, other losses occur when converting from
5484 * some formats to other formats. avcodec_find_best_pix_fmt_of_2() searches which of
5485 * the given pixel formats should be used to suffer the least amount of loss.
5486 * The pixel formats from which it chooses one, are determined by the
5487 * pix_fmt_list parameter.
5490 * @param[in] pix_fmt_list AV_PIX_FMT_NONE terminated array of pixel formats to choose from
5491 * @param[in] src_pix_fmt source pixel format
5492 * @param[in] has_alpha Whether the source pixel format alpha channel is used.
5493 * @param[out] loss_ptr Combination of flags informing you what kind of losses will occur.
5494 * @return The best pixel format to convert to or -1 if none was found.
5496 enum AVPixelFormat avcodec_find_best_pix_fmt_of_list(const enum AVPixelFormat *pix_fmt_list,
5497 enum AVPixelFormat src_pix_fmt,
5498 int has_alpha, int *loss_ptr);
5501 * @deprecated see av_find_best_pix_fmt_of_2()
5503 enum AVPixelFormat avcodec_find_best_pix_fmt_of_2(enum AVPixelFormat dst_pix_fmt1, enum AVPixelFormat dst_pix_fmt2,
5504 enum AVPixelFormat src_pix_fmt, int has_alpha, int *loss_ptr);
5506 attribute_deprecated
5507 enum AVPixelFormat avcodec_find_best_pix_fmt2(enum AVPixelFormat dst_pix_fmt1, enum AVPixelFormat dst_pix_fmt2,
5508 enum AVPixelFormat src_pix_fmt, int has_alpha, int *loss_ptr);
5510 enum AVPixelFormat avcodec_default_get_format(struct AVCodecContext *s, const enum AVPixelFormat * fmt);
5516 #if FF_API_TAG_STRING
5518 * Put a string representing the codec tag codec_tag in buf.
5520 * @param buf buffer to place codec tag in
5521 * @param buf_size size in bytes of buf
5522 * @param codec_tag codec tag to assign
5523 * @return the length of the string that would have been generated if
5524 * enough space had been available, excluding the trailing null
5526 * @deprecated see av_fourcc_make_string() and av_fourcc2str().
5528 attribute_deprecated
5529 size_t av_get_codec_tag_string(char *buf, size_t buf_size, unsigned int codec_tag);
5532 void avcodec_string(char *buf, int buf_size, AVCodecContext *enc, int encode);
5535 * Return a name for the specified profile, if available.
5537 * @param codec the codec that is searched for the given profile
5538 * @param profile the profile value for which a name is requested
5539 * @return A name for the profile if found, NULL otherwise.
5541 const char *av_get_profile_name(const AVCodec *codec, int profile);
5544 * Return a name for the specified profile, if available.
5546 * @param codec_id the ID of the codec to which the requested profile belongs
5547 * @param profile the profile value for which a name is requested
5548 * @return A name for the profile if found, NULL otherwise.
5550 * @note unlike av_get_profile_name(), which searches a list of profiles
5551 * supported by a specific decoder or encoder implementation, this
5552 * function searches the list of profiles from the AVCodecDescriptor
5554 const char *avcodec_profile_name(enum AVCodecID codec_id, int profile);
5556 int avcodec_default_execute(AVCodecContext *c, int (*func)(AVCodecContext *c2, void *arg2),void *arg, int *ret, int count, int size);
5557 int avcodec_default_execute2(AVCodecContext *c, int (*func)(AVCodecContext *c2, void *arg2, int, int),void *arg, int *ret, int count);
5558 //FIXME func typedef
5561 * Fill AVFrame audio data and linesize pointers.
5563 * The buffer buf must be a preallocated buffer with a size big enough
5564 * to contain the specified samples amount. The filled AVFrame data
5565 * pointers will point to this buffer.
5567 * AVFrame extended_data channel pointers are allocated if necessary for
5570 * @param frame the AVFrame
5571 * frame->nb_samples must be set prior to calling the
5572 * function. This function fills in frame->data,
5573 * frame->extended_data, frame->linesize[0].
5574 * @param nb_channels channel count
5575 * @param sample_fmt sample format
5576 * @param buf buffer to use for frame data
5577 * @param buf_size size of buffer
5578 * @param align plane size sample alignment (0 = default)
5579 * @return >=0 on success, negative error code on failure
5580 * @todo return the size in bytes required to store the samples in
5581 * case of success, at the next libavutil bump
5583 int avcodec_fill_audio_frame(AVFrame *frame, int nb_channels,
5584 enum AVSampleFormat sample_fmt, const uint8_t *buf,
5585 int buf_size, int align);
5588 * Reset the internal decoder state / flush internal buffers. Should be called
5589 * e.g. when seeking or when switching to a different stream.
5591 * @note when refcounted frames are not used (i.e. avctx->refcounted_frames is 0),
5592 * this invalidates the frames previously returned from the decoder. When
5593 * refcounted frames are used, the decoder just releases any references it might
5594 * keep internally, but the caller's reference remains valid.
5596 void avcodec_flush_buffers(AVCodecContext *avctx);
5599 * Return codec bits per sample.
5601 * @param[in] codec_id the codec
5602 * @return Number of bits per sample or zero if unknown for the given codec.
5604 int av_get_bits_per_sample(enum AVCodecID codec_id);
5607 * Return the PCM codec associated with a sample format.
5608 * @param be endianness, 0 for little, 1 for big,
5609 * -1 (or anything else) for native
5610 * @return AV_CODEC_ID_PCM_* or AV_CODEC_ID_NONE
5612 enum AVCodecID av_get_pcm_codec(enum AVSampleFormat fmt, int be);
5615 * Return codec bits per sample.
5616 * Only return non-zero if the bits per sample is exactly correct, not an
5619 * @param[in] codec_id the codec
5620 * @return Number of bits per sample or zero if unknown for the given codec.
5622 int av_get_exact_bits_per_sample(enum AVCodecID codec_id);
5625 * Return audio frame duration.
5627 * @param avctx codec context
5628 * @param frame_bytes size of the frame, or 0 if unknown
5629 * @return frame duration, in samples, if known. 0 if not able to
5632 int av_get_audio_frame_duration(AVCodecContext *avctx, int frame_bytes);
5635 * This function is the same as av_get_audio_frame_duration(), except it works
5636 * with AVCodecParameters instead of an AVCodecContext.
5638 int av_get_audio_frame_duration2(AVCodecParameters *par, int frame_bytes);
5641 typedef struct AVBitStreamFilterContext {
5643 const struct AVBitStreamFilter *filter;
5644 AVCodecParserContext *parser;
5645 struct AVBitStreamFilterContext *next;
5647 * Internal default arguments, used if NULL is passed to av_bitstream_filter_filter().
5648 * Not for access by library users.
5651 } AVBitStreamFilterContext;
5654 typedef struct AVBSFInternal AVBSFInternal;
5657 * The bitstream filter state.
5659 * This struct must be allocated with av_bsf_alloc() and freed with
5662 * The fields in the struct will only be changed (by the caller or by the
5663 * filter) as described in their documentation, and are to be considered
5664 * immutable otherwise.
5666 typedef struct AVBSFContext {
5668 * A class for logging and AVOptions
5670 const AVClass *av_class;
5673 * The bitstream filter this context is an instance of.
5675 const struct AVBitStreamFilter *filter;
5678 * Opaque libavcodec internal data. Must not be touched by the caller in any
5681 AVBSFInternal *internal;
5684 * Opaque filter-specific private data. If filter->priv_class is non-NULL,
5685 * this is an AVOptions-enabled struct.
5690 * Parameters of the input stream. This field is allocated in
5691 * av_bsf_alloc(), it needs to be filled by the caller before
5694 AVCodecParameters *par_in;
5697 * Parameters of the output stream. This field is allocated in
5698 * av_bsf_alloc(), it is set by the filter in av_bsf_init().
5700 AVCodecParameters *par_out;
5703 * The timebase used for the timestamps of the input packets. Set by the
5704 * caller before av_bsf_init().
5706 AVRational time_base_in;
5709 * The timebase used for the timestamps of the output packets. Set by the
5710 * filter in av_bsf_init().
5712 AVRational time_base_out;
5715 typedef struct AVBitStreamFilter {
5719 * A list of codec ids supported by the filter, terminated by
5721 * May be NULL, in that case the bitstream filter works with any codec id.
5723 const enum AVCodecID *codec_ids;
5726 * A class for the private data, used to declare bitstream filter private
5727 * AVOptions. This field is NULL for bitstream filters that do not declare
5730 * If this field is non-NULL, the first member of the filter private data
5731 * must be a pointer to AVClass, which will be set by libavcodec generic
5732 * code to this class.
5734 const AVClass *priv_class;
5736 /*****************************************************************
5737 * No fields below this line are part of the public API. They
5738 * may not be used outside of libavcodec and can be changed and
5740 * New public fields should be added right above.
5741 *****************************************************************
5745 int (*init)(AVBSFContext *ctx);
5746 int (*filter)(AVBSFContext *ctx, AVPacket *pkt);
5747 void (*close)(AVBSFContext *ctx);
5748 } AVBitStreamFilter;
5752 * @deprecated the old bitstream filtering API (using AVBitStreamFilterContext)
5753 * is deprecated. Use the new bitstream filtering API (using AVBSFContext).
5755 attribute_deprecated
5756 void av_register_bitstream_filter(AVBitStreamFilter *bsf);
5758 * @deprecated the old bitstream filtering API (using AVBitStreamFilterContext)
5759 * is deprecated. Use av_bsf_get_by_name(), av_bsf_alloc(), and av_bsf_init()
5760 * from the new bitstream filtering API (using AVBSFContext).
5762 attribute_deprecated
5763 AVBitStreamFilterContext *av_bitstream_filter_init(const char *name);
5765 * @deprecated the old bitstream filtering API (using AVBitStreamFilterContext)
5766 * is deprecated. Use av_bsf_send_packet() and av_bsf_receive_packet() from the
5767 * new bitstream filtering API (using AVBSFContext).
5769 attribute_deprecated
5770 int av_bitstream_filter_filter(AVBitStreamFilterContext *bsfc,
5771 AVCodecContext *avctx, const char *args,
5772 uint8_t **poutbuf, int *poutbuf_size,
5773 const uint8_t *buf, int buf_size, int keyframe);
5775 * @deprecated the old bitstream filtering API (using AVBitStreamFilterContext)
5776 * is deprecated. Use av_bsf_free() from the new bitstream filtering API (using
5779 attribute_deprecated
5780 void av_bitstream_filter_close(AVBitStreamFilterContext *bsf);
5782 * @deprecated the old bitstream filtering API (using AVBitStreamFilterContext)
5783 * is deprecated. Use av_bsf_iterate() from the new bitstream filtering API (using
5786 attribute_deprecated
5787 const AVBitStreamFilter *av_bitstream_filter_next(const AVBitStreamFilter *f);
5791 * @return a bitstream filter with the specified name or NULL if no such
5792 * bitstream filter exists.
5794 const AVBitStreamFilter *av_bsf_get_by_name(const char *name);
5797 * Iterate over all registered bitstream filters.
5799 * @param opaque a pointer where libavcodec will store the iteration state. Must
5800 * point to NULL to start the iteration.
5802 * @return the next registered bitstream filter or NULL when the iteration is
5805 const AVBitStreamFilter *av_bsf_iterate(void **opaque);
5807 attribute_deprecated
5808 const AVBitStreamFilter *av_bsf_next(void **opaque);
5812 * Allocate a context for a given bitstream filter. The caller must fill in the
5813 * context parameters as described in the documentation and then call
5814 * av_bsf_init() before sending any data to the filter.
5816 * @param filter the filter for which to allocate an instance.
5817 * @param ctx a pointer into which the pointer to the newly-allocated context
5818 * will be written. It must be freed with av_bsf_free() after the
5819 * filtering is done.
5821 * @return 0 on success, a negative AVERROR code on failure
5823 int av_bsf_alloc(const AVBitStreamFilter *filter, AVBSFContext **ctx);
5826 * Prepare the filter for use, after all the parameters and options have been
5829 int av_bsf_init(AVBSFContext *ctx);
5832 * Submit a packet for filtering.
5834 * After sending each packet, the filter must be completely drained by calling
5835 * av_bsf_receive_packet() repeatedly until it returns AVERROR(EAGAIN) or
5838 * @param pkt the packet to filter. The bitstream filter will take ownership of
5839 * the packet and reset the contents of pkt. pkt is not touched if an error occurs.
5840 * This parameter may be NULL, which signals the end of the stream (i.e. no more
5841 * packets will be sent). That will cause the filter to output any packets it
5842 * may have buffered internally.
5844 * @return 0 on success, a negative AVERROR on error.
5846 int av_bsf_send_packet(AVBSFContext *ctx, AVPacket *pkt);
5849 * Retrieve a filtered packet.
5851 * @param[out] pkt this struct will be filled with the contents of the filtered
5852 * packet. It is owned by the caller and must be freed using
5853 * av_packet_unref() when it is no longer needed.
5854 * This parameter should be "clean" (i.e. freshly allocated
5855 * with av_packet_alloc() or unreffed with av_packet_unref())
5856 * when this function is called. If this function returns
5857 * successfully, the contents of pkt will be completely
5858 * overwritten by the returned data. On failure, pkt is not
5861 * @return 0 on success. AVERROR(EAGAIN) if more packets need to be sent to the
5862 * filter (using av_bsf_send_packet()) to get more output. AVERROR_EOF if there
5863 * will be no further output from the filter. Another negative AVERROR value if
5866 * @note one input packet may result in several output packets, so after sending
5867 * a packet with av_bsf_send_packet(), this function needs to be called
5868 * repeatedly until it stops returning 0. It is also possible for a filter to
5869 * output fewer packets than were sent to it, so this function may return
5870 * AVERROR(EAGAIN) immediately after a successful av_bsf_send_packet() call.
5872 int av_bsf_receive_packet(AVBSFContext *ctx, AVPacket *pkt);
5875 * Free a bitstream filter context and everything associated with it; write NULL
5876 * into the supplied pointer.
5878 void av_bsf_free(AVBSFContext **ctx);
5881 * Get the AVClass for AVBSFContext. It can be used in combination with
5882 * AV_OPT_SEARCH_FAKE_OBJ for examining options.
5884 * @see av_opt_find().
5886 const AVClass *av_bsf_get_class(void);
5889 * Structure for chain/list of bitstream filters.
5890 * Empty list can be allocated by av_bsf_list_alloc().
5892 typedef struct AVBSFList AVBSFList;
5895 * Allocate empty list of bitstream filters.
5896 * The list must be later freed by av_bsf_list_free()
5897 * or finalized by av_bsf_list_finalize().
5899 * @return Pointer to @ref AVBSFList on success, NULL in case of failure
5901 AVBSFList *av_bsf_list_alloc(void);
5904 * Free list of bitstream filters.
5906 * @param lst Pointer to pointer returned by av_bsf_list_alloc()
5908 void av_bsf_list_free(AVBSFList **lst);
5911 * Append bitstream filter to the list of bitstream filters.
5913 * @param lst List to append to
5914 * @param bsf Filter context to be appended
5916 * @return >=0 on success, negative AVERROR in case of failure
5918 int av_bsf_list_append(AVBSFList *lst, AVBSFContext *bsf);
5921 * Construct new bitstream filter context given it's name and options
5922 * and append it to the list of bitstream filters.
5924 * @param lst List to append to
5925 * @param bsf_name Name of the bitstream filter
5926 * @param options Options for the bitstream filter, can be set to NULL
5928 * @return >=0 on success, negative AVERROR in case of failure
5930 int av_bsf_list_append2(AVBSFList *lst, const char * bsf_name, AVDictionary **options);
5932 * Finalize list of bitstream filters.
5934 * This function will transform @ref AVBSFList to single @ref AVBSFContext,
5935 * so the whole chain of bitstream filters can be treated as single filter
5936 * freshly allocated by av_bsf_alloc().
5937 * If the call is successful, @ref AVBSFList structure is freed and lst
5938 * will be set to NULL. In case of failure, caller is responsible for
5939 * freeing the structure by av_bsf_list_free()
5941 * @param lst Filter list structure to be transformed
5942 * @param[out] bsf Pointer to be set to newly created @ref AVBSFContext structure
5943 * representing the chain of bitstream filters
5945 * @return >=0 on success, negative AVERROR in case of failure
5947 int av_bsf_list_finalize(AVBSFList **lst, AVBSFContext **bsf);
5950 * Parse string describing list of bitstream filters and create single
5951 * @ref AVBSFContext describing the whole chain of bitstream filters.
5952 * Resulting @ref AVBSFContext can be treated as any other @ref AVBSFContext freshly
5953 * allocated by av_bsf_alloc().
5955 * @param str String describing chain of bitstream filters in format
5956 * `bsf1[=opt1=val1:opt2=val2][,bsf2]`
5957 * @param[out] bsf Pointer to be set to newly created @ref AVBSFContext structure
5958 * representing the chain of bitstream filters
5960 * @return >=0 on success, negative AVERROR in case of failure
5962 int av_bsf_list_parse_str(const char *str, AVBSFContext **bsf);
5965 * Get null/pass-through bitstream filter.
5967 * @param[out] bsf Pointer to be set to new instance of pass-through bitstream filter
5971 int av_bsf_get_null_filter(AVBSFContext **bsf);
5976 * Same behaviour av_fast_malloc but the buffer has additional
5977 * AV_INPUT_BUFFER_PADDING_SIZE at the end which will always be 0.
5979 * In addition the whole buffer will initially and after resizes
5980 * be 0-initialized so that no uninitialized data will ever appear.
5982 void av_fast_padded_malloc(void *ptr, unsigned int *size, size_t min_size);
5985 * Same behaviour av_fast_padded_malloc except that buffer will always
5986 * be 0-initialized after call.
5988 void av_fast_padded_mallocz(void *ptr, unsigned int *size, size_t min_size);
5991 * Encode extradata length to a buffer. Used by xiph codecs.
5993 * @param s buffer to write to; must be at least (v/255+1) bytes long
5994 * @param v size of extradata in bytes
5995 * @return number of bytes written to the buffer.
5997 unsigned int av_xiphlacing(unsigned char *s, unsigned int v);
5999 #if FF_API_USER_VISIBLE_AVHWACCEL
6001 * Register the hardware accelerator hwaccel.
6003 * @deprecated This function doesn't do anything.
6005 attribute_deprecated
6006 void av_register_hwaccel(AVHWAccel *hwaccel);
6009 * If hwaccel is NULL, returns the first registered hardware accelerator,
6010 * if hwaccel is non-NULL, returns the next registered hardware accelerator
6011 * after hwaccel, or NULL if hwaccel is the last one.
6013 * @deprecated AVHWaccel structures contain no user-serviceable parts, so
6014 * this function should not be used.
6016 attribute_deprecated
6017 AVHWAccel *av_hwaccel_next(const AVHWAccel *hwaccel);
6022 * Lock operation used by lockmgr
6024 * @deprecated Deprecated together with av_lockmgr_register().
6027 AV_LOCK_CREATE, ///< Create a mutex
6028 AV_LOCK_OBTAIN, ///< Lock the mutex
6029 AV_LOCK_RELEASE, ///< Unlock the mutex
6030 AV_LOCK_DESTROY, ///< Free mutex resources
6034 * Register a user provided lock manager supporting the operations
6035 * specified by AVLockOp. The "mutex" argument to the function points
6036 * to a (void *) where the lockmgr should store/get a pointer to a user
6037 * allocated mutex. It is NULL upon AV_LOCK_CREATE and equal to the
6038 * value left by the last call for all other ops. If the lock manager is
6039 * unable to perform the op then it should leave the mutex in the same
6040 * state as when it was called and return a non-zero value. However,
6041 * when called with AV_LOCK_DESTROY the mutex will always be assumed to
6042 * have been successfully destroyed. If av_lockmgr_register succeeds
6043 * it will return a non-negative value, if it fails it will return a
6044 * negative value and destroy all mutex and unregister all callbacks.
6045 * av_lockmgr_register is not thread-safe, it must be called from a
6046 * single thread before any calls which make use of locking are used.
6048 * @param cb User defined callback. av_lockmgr_register invokes calls
6049 * to this callback and the previously registered callback.
6050 * The callback will be used to create more than one mutex
6051 * each of which must be backed by its own underlying locking
6052 * mechanism (i.e. do not use a single static object to
6053 * implement your lock manager). If cb is set to NULL the
6054 * lockmgr will be unregistered.
6056 * @deprecated This function does nothing, and always returns 0. Be sure to
6057 * build with thread support to get basic thread safety.
6059 attribute_deprecated
6060 int av_lockmgr_register(int (*cb)(void **mutex, enum AVLockOp op));
6064 * Get the type of the given codec.
6066 enum AVMediaType avcodec_get_type(enum AVCodecID codec_id);
6069 * Get the name of a codec.
6070 * @return a static string identifying the codec; never NULL
6072 const char *avcodec_get_name(enum AVCodecID id);
6075 * @return a positive value if s is open (i.e. avcodec_open2() was called on it
6076 * with no corresponding avcodec_close()), 0 otherwise.
6078 int avcodec_is_open(AVCodecContext *s);
6081 * @return a non-zero number if codec is an encoder, zero otherwise
6083 int av_codec_is_encoder(const AVCodec *codec);
6086 * @return a non-zero number if codec is a decoder, zero otherwise
6088 int av_codec_is_decoder(const AVCodec *codec);
6091 * @return descriptor for given codec ID or NULL if no descriptor exists.
6093 const AVCodecDescriptor *avcodec_descriptor_get(enum AVCodecID id);
6096 * Iterate over all codec descriptors known to libavcodec.
6098 * @param prev previous descriptor. NULL to get the first descriptor.
6100 * @return next descriptor or NULL after the last descriptor
6102 const AVCodecDescriptor *avcodec_descriptor_next(const AVCodecDescriptor *prev);
6105 * @return codec descriptor with the given name or NULL if no such descriptor
6108 const AVCodecDescriptor *avcodec_descriptor_get_by_name(const char *name);
6111 * Allocate a CPB properties structure and initialize its fields to default
6114 * @param size if non-NULL, the size of the allocated struct will be written
6115 * here. This is useful for embedding it in side data.
6117 * @return the newly allocated struct or NULL on failure
6119 AVCPBProperties *av_cpb_properties_alloc(size_t *size);
6125 #endif /* AVCODEC_AVCODEC_H */