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,
642 /* subtitle codecs */
643 AV_CODEC_ID_FIRST_SUBTITLE = 0x17000, ///< A dummy ID pointing at the start of subtitle codecs.
644 AV_CODEC_ID_DVD_SUBTITLE = 0x17000,
645 AV_CODEC_ID_DVB_SUBTITLE,
646 AV_CODEC_ID_TEXT, ///< raw UTF-8 text
649 AV_CODEC_ID_MOV_TEXT,
650 AV_CODEC_ID_HDMV_PGS_SUBTITLE,
651 AV_CODEC_ID_DVB_TELETEXT,
654 AV_CODEC_ID_MICRODVD = 0x17800,
658 AV_CODEC_ID_REALTEXT,
660 AV_CODEC_ID_SUBVIEWER1,
661 AV_CODEC_ID_SUBVIEWER,
668 AV_CODEC_ID_HDMV_TEXT_SUBTITLE,
671 /* other specific kind of codecs (generally used for attachments) */
672 AV_CODEC_ID_FIRST_UNKNOWN = 0x18000, ///< A dummy ID pointing at the start of various fake codecs.
673 AV_CODEC_ID_TTF = 0x18000,
675 AV_CODEC_ID_SCTE_35, ///< Contain timestamp estimated through PCR of program stream.
676 AV_CODEC_ID_BINTEXT = 0x18800,
680 AV_CODEC_ID_SMPTE_KLV,
682 AV_CODEC_ID_TIMED_ID3,
683 AV_CODEC_ID_BIN_DATA,
686 AV_CODEC_ID_PROBE = 0x19000, ///< codec_id is not known (like AV_CODEC_ID_NONE) but lavf should attempt to identify it
688 AV_CODEC_ID_MPEG2TS = 0x20000, /**< _FAKE_ codec to indicate a raw MPEG-2 TS
689 * stream (only used by libavformat) */
690 AV_CODEC_ID_MPEG4SYSTEMS = 0x20001, /**< _FAKE_ codec to indicate a MPEG-4 Systems
691 * stream (only used by libavformat) */
692 AV_CODEC_ID_FFMETADATA = 0x21000, ///< Dummy codec for streams containing only metadata information.
693 AV_CODEC_ID_WRAPPED_AVFRAME = 0x21001, ///< Passthrough codec, AVFrames wrapped in AVPacket
697 * This struct describes the properties of a single codec described by an
699 * @see avcodec_descriptor_get()
701 typedef struct AVCodecDescriptor {
703 enum AVMediaType type;
705 * Name of the codec described by this descriptor. It is non-empty and
706 * unique for each codec descriptor. It should contain alphanumeric
707 * characters and '_' only.
711 * A more descriptive name for this codec. May be NULL.
713 const char *long_name;
715 * Codec properties, a combination of AV_CODEC_PROP_* flags.
719 * MIME type(s) associated with the codec.
720 * May be NULL; if not, a NULL-terminated array of MIME types.
721 * The first item is always non-NULL and is the preferred MIME type.
723 const char *const *mime_types;
725 * If non-NULL, an array of profiles recognized for this codec.
726 * Terminated with FF_PROFILE_UNKNOWN.
728 const struct AVProfile *profiles;
732 * Codec uses only intra compression.
733 * Video and audio codecs only.
735 #define AV_CODEC_PROP_INTRA_ONLY (1 << 0)
737 * Codec supports lossy compression. Audio and video codecs only.
738 * @note a codec may support both lossy and lossless
741 #define AV_CODEC_PROP_LOSSY (1 << 1)
743 * Codec supports lossless compression. Audio and video codecs only.
745 #define AV_CODEC_PROP_LOSSLESS (1 << 2)
747 * Codec supports frame reordering. That is, the coded order (the order in which
748 * the encoded packets are output by the encoders / stored / input to the
749 * decoders) may be different from the presentation order of the corresponding
752 * For codecs that do not have this property set, PTS and DTS should always be
755 #define AV_CODEC_PROP_REORDER (1 << 3)
757 * Subtitle codec is bitmap based
758 * Decoded AVSubtitle data can be read from the AVSubtitleRect->pict field.
760 #define AV_CODEC_PROP_BITMAP_SUB (1 << 16)
762 * Subtitle codec is text based.
763 * Decoded AVSubtitle data can be read from the AVSubtitleRect->ass field.
765 #define AV_CODEC_PROP_TEXT_SUB (1 << 17)
768 * @ingroup lavc_decoding
769 * Required number of additionally allocated bytes at the end of the input bitstream for decoding.
770 * This is mainly needed because some optimized bitstream readers read
771 * 32 or 64 bit at once and could read over the end.<br>
772 * Note: If the first 23 bits of the additional bytes are not 0, then damaged
773 * MPEG bitstreams could cause overread and segfault.
775 #define AV_INPUT_BUFFER_PADDING_SIZE 64
778 * @ingroup lavc_encoding
779 * minimum encoding buffer size
780 * Used to avoid some checks during header writing.
782 #define AV_INPUT_BUFFER_MIN_SIZE 16384
785 * @ingroup lavc_decoding
788 /* We leave some space between them for extensions (drop some
789 * keyframes for intra-only or drop just some bidir frames). */
790 AVDISCARD_NONE =-16, ///< discard nothing
791 AVDISCARD_DEFAULT = 0, ///< discard useless packets like 0 size packets in avi
792 AVDISCARD_NONREF = 8, ///< discard all non reference
793 AVDISCARD_BIDIR = 16, ///< discard all bidirectional frames
794 AVDISCARD_NONINTRA= 24, ///< discard all non intra frames
795 AVDISCARD_NONKEY = 32, ///< discard all frames except keyframes
796 AVDISCARD_ALL = 48, ///< discard all
799 enum AVAudioServiceType {
800 AV_AUDIO_SERVICE_TYPE_MAIN = 0,
801 AV_AUDIO_SERVICE_TYPE_EFFECTS = 1,
802 AV_AUDIO_SERVICE_TYPE_VISUALLY_IMPAIRED = 2,
803 AV_AUDIO_SERVICE_TYPE_HEARING_IMPAIRED = 3,
804 AV_AUDIO_SERVICE_TYPE_DIALOGUE = 4,
805 AV_AUDIO_SERVICE_TYPE_COMMENTARY = 5,
806 AV_AUDIO_SERVICE_TYPE_EMERGENCY = 6,
807 AV_AUDIO_SERVICE_TYPE_VOICE_OVER = 7,
808 AV_AUDIO_SERVICE_TYPE_KARAOKE = 8,
809 AV_AUDIO_SERVICE_TYPE_NB , ///< Not part of ABI
813 * @ingroup lavc_encoding
815 typedef struct RcOverride{
818 int qscale; // If this is 0 then quality_factor will be used instead.
819 float quality_factor;
823 These flags can be passed in AVCodecContext.flags before initialization.
824 Note: Not everything is supported yet.
828 * Allow decoders to produce frames with data planes that are not aligned
829 * to CPU requirements (e.g. due to cropping).
831 #define AV_CODEC_FLAG_UNALIGNED (1 << 0)
835 #define AV_CODEC_FLAG_QSCALE (1 << 1)
837 * 4 MV per MB allowed / advanced prediction for H.263.
839 #define AV_CODEC_FLAG_4MV (1 << 2)
841 * Output even those frames that might be corrupted.
843 #define AV_CODEC_FLAG_OUTPUT_CORRUPT (1 << 3)
847 #define AV_CODEC_FLAG_QPEL (1 << 4)
849 * Use internal 2pass ratecontrol in first pass mode.
851 #define AV_CODEC_FLAG_PASS1 (1 << 9)
853 * Use internal 2pass ratecontrol in second pass mode.
855 #define AV_CODEC_FLAG_PASS2 (1 << 10)
859 #define AV_CODEC_FLAG_LOOP_FILTER (1 << 11)
861 * Only decode/encode grayscale.
863 #define AV_CODEC_FLAG_GRAY (1 << 13)
865 * error[?] variables will be set during encoding.
867 #define AV_CODEC_FLAG_PSNR (1 << 15)
869 * Input bitstream might be truncated at a random location
870 * instead of only at frame boundaries.
872 #define AV_CODEC_FLAG_TRUNCATED (1 << 16)
874 * Use interlaced DCT.
876 #define AV_CODEC_FLAG_INTERLACED_DCT (1 << 18)
880 #define AV_CODEC_FLAG_LOW_DELAY (1 << 19)
882 * Place global headers in extradata instead of every keyframe.
884 #define AV_CODEC_FLAG_GLOBAL_HEADER (1 << 22)
886 * Use only bitexact stuff (except (I)DCT).
888 #define AV_CODEC_FLAG_BITEXACT (1 << 23)
889 /* Fx : Flag for H.263+ extra options */
891 * H.263 advanced intra coding / MPEG-4 AC prediction
893 #define AV_CODEC_FLAG_AC_PRED (1 << 24)
895 * interlaced motion estimation
897 #define AV_CODEC_FLAG_INTERLACED_ME (1 << 29)
898 #define AV_CODEC_FLAG_CLOSED_GOP (1U << 31)
901 * Allow non spec compliant speedup tricks.
903 #define AV_CODEC_FLAG2_FAST (1 << 0)
905 * Skip bitstream encoding.
907 #define AV_CODEC_FLAG2_NO_OUTPUT (1 << 2)
909 * Place global headers at every keyframe instead of in extradata.
911 #define AV_CODEC_FLAG2_LOCAL_HEADER (1 << 3)
914 * timecode is in drop frame format. DEPRECATED!!!!
916 #define AV_CODEC_FLAG2_DROP_FRAME_TIMECODE (1 << 13)
919 * Input bitstream might be truncated at a packet boundaries
920 * instead of only at frame boundaries.
922 #define AV_CODEC_FLAG2_CHUNKS (1 << 15)
924 * Discard cropping information from SPS.
926 #define AV_CODEC_FLAG2_IGNORE_CROP (1 << 16)
929 * Show all frames before the first keyframe
931 #define AV_CODEC_FLAG2_SHOW_ALL (1 << 22)
933 * Export motion vectors through frame side data
935 #define AV_CODEC_FLAG2_EXPORT_MVS (1 << 28)
937 * Do not skip samples and export skip information as frame side data
939 #define AV_CODEC_FLAG2_SKIP_MANUAL (1 << 29)
941 * Do not reset ASS ReadOrder field on flush (subtitles decoding)
943 #define AV_CODEC_FLAG2_RO_FLUSH_NOOP (1 << 30)
945 /* Unsupported options :
946 * Syntax Arithmetic coding (SAC)
947 * Reference Picture Selection
948 * Independent Segment Decoding */
950 /* codec capabilities */
953 * Decoder can use draw_horiz_band callback.
955 #define AV_CODEC_CAP_DRAW_HORIZ_BAND (1 << 0)
957 * Codec uses get_buffer() for allocating buffers and supports custom allocators.
958 * If not set, it might not use get_buffer() at all or use operations that
959 * assume the buffer was allocated by avcodec_default_get_buffer.
961 #define AV_CODEC_CAP_DR1 (1 << 1)
962 #define AV_CODEC_CAP_TRUNCATED (1 << 3)
964 * Encoder or decoder requires flushing with NULL input at the end in order to
965 * give the complete and correct output.
967 * NOTE: If this flag is not set, the codec is guaranteed to never be fed with
968 * with NULL data. The user can still send NULL data to the public encode
969 * or decode function, but libavcodec will not pass it along to the codec
970 * unless this flag is set.
973 * The decoder has a non-zero delay and needs to be fed with avpkt->data=NULL,
974 * avpkt->size=0 at the end to get the delayed data until the decoder no longer
978 * The encoder needs to be fed with NULL data at the end of encoding until the
979 * encoder no longer returns data.
981 * NOTE: For encoders implementing the AVCodec.encode2() function, setting this
982 * flag also means that the encoder must set the pts and duration for
983 * each output packet. If this flag is not set, the pts and duration will
984 * be determined by libavcodec from the input frame.
986 #define AV_CODEC_CAP_DELAY (1 << 5)
988 * Codec can be fed a final frame with a smaller size.
989 * This can be used to prevent truncation of the last audio samples.
991 #define AV_CODEC_CAP_SMALL_LAST_FRAME (1 << 6)
994 * Codec can output multiple frames per AVPacket
995 * Normally demuxers return one frame at a time, demuxers which do not do
996 * are connected to a parser to split what they return into proper frames.
997 * This flag is reserved to the very rare category of codecs which have a
998 * bitstream that cannot be split into frames without timeconsuming
999 * operations like full decoding. Demuxers carrying such bitstreams thus
1000 * may return multiple frames in a packet. This has many disadvantages like
1001 * prohibiting stream copy in many cases thus it should only be considered
1004 #define AV_CODEC_CAP_SUBFRAMES (1 << 8)
1006 * Codec is experimental and is thus avoided in favor of non experimental
1009 #define AV_CODEC_CAP_EXPERIMENTAL (1 << 9)
1011 * Codec should fill in channel configuration and samplerate instead of container
1013 #define AV_CODEC_CAP_CHANNEL_CONF (1 << 10)
1015 * Codec supports frame-level multithreading.
1017 #define AV_CODEC_CAP_FRAME_THREADS (1 << 12)
1019 * Codec supports slice-based (or partition-based) multithreading.
1021 #define AV_CODEC_CAP_SLICE_THREADS (1 << 13)
1023 * Codec supports changed parameters at any point.
1025 #define AV_CODEC_CAP_PARAM_CHANGE (1 << 14)
1027 * Codec supports avctx->thread_count == 0 (auto).
1029 #define AV_CODEC_CAP_AUTO_THREADS (1 << 15)
1031 * Audio encoder supports receiving a different number of samples in each call.
1033 #define AV_CODEC_CAP_VARIABLE_FRAME_SIZE (1 << 16)
1035 * Decoder is not a preferred choice for probing.
1036 * This indicates that the decoder is not a good choice for probing.
1037 * It could for example be an expensive to spin up hardware decoder,
1038 * or it could simply not provide a lot of useful information about
1040 * A decoder marked with this flag should only be used as last resort
1041 * choice for probing.
1043 #define AV_CODEC_CAP_AVOID_PROBING (1 << 17)
1045 * Codec is intra only.
1047 #define AV_CODEC_CAP_INTRA_ONLY 0x40000000
1049 * Codec is lossless.
1051 #define AV_CODEC_CAP_LOSSLESS 0x80000000
1054 * Codec is backed by a hardware implementation. Typically used to
1055 * identify a non-hwaccel hardware decoder. For information about hwaccels, use
1056 * avcodec_get_hw_config() instead.
1058 #define AV_CODEC_CAP_HARDWARE (1 << 18)
1061 * Codec is potentially backed by a hardware implementation, but not
1062 * necessarily. This is used instead of AV_CODEC_CAP_HARDWARE, if the
1063 * implementation provides some sort of internal fallback.
1065 #define AV_CODEC_CAP_HYBRID (1 << 19)
1069 * This specifies the area which should be displayed.
1070 * Note there may be multiple such areas for one frame.
1072 typedef struct AVPanScan {
1075 * - encoding: Set by user.
1076 * - decoding: Set by libavcodec.
1081 * width and height in 1/16 pel
1082 * - encoding: Set by user.
1083 * - decoding: Set by libavcodec.
1089 * position of the top left corner in 1/16 pel for up to 3 fields/frames
1090 * - encoding: Set by user.
1091 * - decoding: Set by libavcodec.
1093 int16_t position[3][2];
1097 * This structure describes the bitrate properties of an encoded bitstream. It
1098 * roughly corresponds to a subset the VBV parameters for MPEG-2 or HRD
1099 * parameters for H.264/HEVC.
1101 typedef struct AVCPBProperties {
1103 * Maximum bitrate of the stream, in bits per second.
1104 * Zero if unknown or unspecified.
1108 * Minimum bitrate of the stream, in bits per second.
1109 * Zero if unknown or unspecified.
1113 * Average bitrate of the stream, in bits per second.
1114 * Zero if unknown or unspecified.
1119 * The size of the buffer to which the ratecontrol is applied, in bits.
1120 * Zero if unknown or unspecified.
1125 * The delay between the time the packet this structure is associated with
1126 * is received and the time when it should be decoded, in periods of a 27MHz
1129 * UINT64_MAX when unknown or unspecified.
1135 * The decoder will keep a reference to the frame and may reuse it later.
1137 #define AV_GET_BUFFER_FLAG_REF (1 << 0)
1140 * @defgroup lavc_packet AVPacket
1142 * Types and functions for working with AVPacket.
1145 enum AVPacketSideDataType {
1147 * An AV_PKT_DATA_PALETTE side data packet contains exactly AVPALETTE_SIZE
1148 * bytes worth of palette. This side data signals that a new palette is
1151 AV_PKT_DATA_PALETTE,
1154 * The AV_PKT_DATA_NEW_EXTRADATA is used to notify the codec or the format
1155 * that the extradata buffer was changed and the receiving side should
1156 * act upon it appropriately. The new extradata is embedded in the side
1157 * data buffer and should be immediately used for processing the current
1160 AV_PKT_DATA_NEW_EXTRADATA,
1163 * An AV_PKT_DATA_PARAM_CHANGE side data packet is laid out as follows:
1166 * if (param_flags & AV_SIDE_DATA_PARAM_CHANGE_CHANNEL_COUNT)
1167 * s32le channel_count
1168 * if (param_flags & AV_SIDE_DATA_PARAM_CHANGE_CHANNEL_LAYOUT)
1169 * u64le channel_layout
1170 * if (param_flags & AV_SIDE_DATA_PARAM_CHANGE_SAMPLE_RATE)
1172 * if (param_flags & AV_SIDE_DATA_PARAM_CHANGE_DIMENSIONS)
1177 AV_PKT_DATA_PARAM_CHANGE,
1180 * An AV_PKT_DATA_H263_MB_INFO side data packet contains a number of
1181 * structures with info about macroblocks relevant to splitting the
1182 * packet into smaller packets on macroblock edges (e.g. as for RFC 2190).
1183 * That is, it does not necessarily contain info about all macroblocks,
1184 * as long as the distance between macroblocks in the info is smaller
1185 * than the target payload size.
1186 * Each MB info structure is 12 bytes, and is laid out as follows:
1188 * u32le bit offset from the start of the packet
1189 * u8 current quantizer at the start of the macroblock
1191 * u16le macroblock address within the GOB
1192 * u8 horizontal MV predictor
1193 * u8 vertical MV predictor
1194 * u8 horizontal MV predictor for block number 3
1195 * u8 vertical MV predictor for block number 3
1198 AV_PKT_DATA_H263_MB_INFO,
1201 * This side data should be associated with an audio stream and contains
1202 * ReplayGain information in form of the AVReplayGain struct.
1204 AV_PKT_DATA_REPLAYGAIN,
1207 * This side data contains a 3x3 transformation matrix describing an affine
1208 * transformation that needs to be applied to the decoded video frames for
1209 * correct presentation.
1211 * See libavutil/display.h for a detailed description of the data.
1213 AV_PKT_DATA_DISPLAYMATRIX,
1216 * This side data should be associated with a video stream and contains
1217 * Stereoscopic 3D information in form of the AVStereo3D struct.
1219 AV_PKT_DATA_STEREO3D,
1222 * This side data should be associated with an audio stream and corresponds
1223 * to enum AVAudioServiceType.
1225 AV_PKT_DATA_AUDIO_SERVICE_TYPE,
1228 * This side data contains quality related information from the encoder.
1230 * u32le quality factor of the compressed frame. Allowed range is between 1 (good) and FF_LAMBDA_MAX (bad).
1234 * u64le[error count] sum of squared differences between encoder in and output
1237 AV_PKT_DATA_QUALITY_STATS,
1240 * This side data contains an integer value representing the stream index
1241 * of a "fallback" track. A fallback track indicates an alternate
1242 * track to use when the current track can not be decoded for some reason.
1243 * e.g. no decoder available for codec.
1245 AV_PKT_DATA_FALLBACK_TRACK,
1248 * This side data corresponds to the AVCPBProperties struct.
1250 AV_PKT_DATA_CPB_PROPERTIES,
1253 * Recommmends skipping the specified number of samples
1255 * u32le number of samples to skip from start of this packet
1256 * u32le number of samples to skip from end of this packet
1257 * u8 reason for start skip
1258 * u8 reason for end skip (0=padding silence, 1=convergence)
1261 AV_PKT_DATA_SKIP_SAMPLES,
1264 * An AV_PKT_DATA_JP_DUALMONO side data packet indicates that
1265 * the packet may contain "dual mono" audio specific to Japanese DTV
1266 * and if it is true, recommends only the selected channel to be used.
1268 * u8 selected channels (0=mail/left, 1=sub/right, 2=both)
1271 AV_PKT_DATA_JP_DUALMONO,
1274 * A list of zero terminated key/value strings. There is no end marker for
1275 * the list, so it is required to rely on the side data size to stop.
1277 AV_PKT_DATA_STRINGS_METADATA,
1280 * Subtitle event position
1288 AV_PKT_DATA_SUBTITLE_POSITION,
1291 * Data found in BlockAdditional element of matroska container. There is
1292 * no end marker for the data, so it is required to rely on the side data
1293 * size to recognize the end. 8 byte id (as found in BlockAddId) followed
1296 AV_PKT_DATA_MATROSKA_BLOCKADDITIONAL,
1299 * The optional first identifier line of a WebVTT cue.
1301 AV_PKT_DATA_WEBVTT_IDENTIFIER,
1304 * The optional settings (rendering instructions) that immediately
1305 * follow the timestamp specifier of a WebVTT cue.
1307 AV_PKT_DATA_WEBVTT_SETTINGS,
1310 * A list of zero terminated key/value strings. There is no end marker for
1311 * the list, so it is required to rely on the side data size to stop. This
1312 * side data includes updated metadata which appeared in the stream.
1314 AV_PKT_DATA_METADATA_UPDATE,
1317 * MPEGTS stream ID, this is required to pass the stream ID
1318 * information from the demuxer to the corresponding muxer.
1320 AV_PKT_DATA_MPEGTS_STREAM_ID,
1323 * Mastering display metadata (based on SMPTE-2086:2014). This metadata
1324 * should be associated with a video stream and contains data in the form
1325 * of the AVMasteringDisplayMetadata struct.
1327 AV_PKT_DATA_MASTERING_DISPLAY_METADATA,
1330 * This side data should be associated with a video stream and corresponds
1331 * to the AVSphericalMapping structure.
1333 AV_PKT_DATA_SPHERICAL,
1336 * Content light level (based on CTA-861.3). This metadata should be
1337 * associated with a video stream and contains data in the form of the
1338 * AVContentLightMetadata struct.
1340 AV_PKT_DATA_CONTENT_LIGHT_LEVEL,
1343 * ATSC A53 Part 4 Closed Captions. This metadata should be associated with
1344 * a video stream. A53 CC bitstream is stored as uint8_t in AVPacketSideData.data.
1345 * The number of bytes of CC data is AVPacketSideData.size.
1350 * This side data is encryption initialization data.
1351 * The format is not part of ABI, use av_encryption_init_info_* methods to
1354 AV_PKT_DATA_ENCRYPTION_INIT_INFO,
1357 * This side data contains encryption info for how to decrypt the packet.
1358 * The format is not part of ABI, use av_encryption_info_* methods to access.
1360 AV_PKT_DATA_ENCRYPTION_INFO,
1363 * The number of side data types.
1364 * This is not part of the public API/ABI in the sense that it may
1365 * change when new side data types are added.
1366 * This must stay the last enum value.
1367 * If its value becomes huge, some code using it
1368 * needs to be updated as it assumes it to be smaller than other limits.
1373 #define AV_PKT_DATA_QUALITY_FACTOR AV_PKT_DATA_QUALITY_STATS //DEPRECATED
1375 typedef struct AVPacketSideData {
1378 enum AVPacketSideDataType type;
1382 * This structure stores compressed data. It is typically exported by demuxers
1383 * and then passed as input to decoders, or received as output from encoders and
1384 * then passed to muxers.
1386 * For video, it should typically contain one compressed frame. For audio it may
1387 * contain several compressed frames. Encoders are allowed to output empty
1388 * packets, with no compressed data, containing only side data
1389 * (e.g. to update some stream parameters at the end of encoding).
1391 * AVPacket is one of the few structs in FFmpeg, whose size is a part of public
1392 * ABI. Thus it may be allocated on stack and no new fields can be added to it
1393 * without libavcodec and libavformat major bump.
1395 * The semantics of data ownership depends on the buf field.
1396 * If it is set, the packet data is dynamically allocated and is
1397 * valid indefinitely until a call to av_packet_unref() reduces the
1398 * reference count to 0.
1400 * If the buf field is not set av_packet_ref() would make a copy instead
1401 * of increasing the reference count.
1403 * The side data is always allocated with av_malloc(), copied by
1404 * av_packet_ref() and freed by av_packet_unref().
1406 * @see av_packet_ref
1407 * @see av_packet_unref
1409 typedef struct AVPacket {
1411 * A reference to the reference-counted buffer where the packet data is
1413 * May be NULL, then the packet data is not reference-counted.
1417 * Presentation timestamp in AVStream->time_base units; the time at which
1418 * the decompressed packet will be presented to the user.
1419 * Can be AV_NOPTS_VALUE if it is not stored in the file.
1420 * pts MUST be larger or equal to dts as presentation cannot happen before
1421 * decompression, unless one wants to view hex dumps. Some formats misuse
1422 * the terms dts and pts/cts to mean something different. Such timestamps
1423 * must be converted to true pts/dts before they are stored in AVPacket.
1427 * Decompression timestamp in AVStream->time_base units; the time at which
1428 * the packet is decompressed.
1429 * Can be AV_NOPTS_VALUE if it is not stored in the file.
1436 * A combination of AV_PKT_FLAG values
1440 * Additional packet data that can be provided by the container.
1441 * Packet can contain several types of side information.
1443 AVPacketSideData *side_data;
1444 int side_data_elems;
1447 * Duration of this packet in AVStream->time_base units, 0 if unknown.
1448 * Equals next_pts - this_pts in presentation order.
1452 int64_t pos; ///< byte position in stream, -1 if unknown
1454 #if FF_API_CONVERGENCE_DURATION
1456 * @deprecated Same as the duration field, but as int64_t. This was required
1457 * for Matroska subtitles, whose duration values could overflow when the
1458 * duration field was still an int.
1460 attribute_deprecated
1461 int64_t convergence_duration;
1464 #define AV_PKT_FLAG_KEY 0x0001 ///< The packet contains a keyframe
1465 #define AV_PKT_FLAG_CORRUPT 0x0002 ///< The packet content is corrupted
1467 * Flag is used to discard packets which are required to maintain valid
1468 * decoder state but are not required for output and should be dropped
1471 #define AV_PKT_FLAG_DISCARD 0x0004
1473 * The packet comes from a trusted source.
1475 * Otherwise-unsafe constructs such as arbitrary pointers to data
1476 * outside the packet may be followed.
1478 #define AV_PKT_FLAG_TRUSTED 0x0008
1480 * Flag is used to indicate packets that contain frames that can
1481 * be discarded by the decoder. I.e. Non-reference frames.
1483 #define AV_PKT_FLAG_DISPOSABLE 0x0010
1486 enum AVSideDataParamChangeFlags {
1487 AV_SIDE_DATA_PARAM_CHANGE_CHANNEL_COUNT = 0x0001,
1488 AV_SIDE_DATA_PARAM_CHANGE_CHANNEL_LAYOUT = 0x0002,
1489 AV_SIDE_DATA_PARAM_CHANGE_SAMPLE_RATE = 0x0004,
1490 AV_SIDE_DATA_PARAM_CHANGE_DIMENSIONS = 0x0008,
1496 struct AVCodecInternal;
1500 AV_FIELD_PROGRESSIVE,
1501 AV_FIELD_TT, //< Top coded_first, top displayed first
1502 AV_FIELD_BB, //< Bottom coded first, bottom displayed first
1503 AV_FIELD_TB, //< Top coded first, bottom displayed first
1504 AV_FIELD_BT, //< Bottom coded first, top displayed first
1508 * main external API structure.
1509 * New fields can be added to the end with minor version bumps.
1510 * Removal, reordering and changes to existing fields require a major
1512 * You can use AVOptions (av_opt* / av_set/get*()) to access these fields from user
1514 * The name string for AVOptions options matches the associated command line
1515 * parameter name and can be found in libavcodec/options_table.h
1516 * The AVOption/command line parameter names differ in some cases from the C
1517 * structure field names for historic reasons or brevity.
1518 * sizeof(AVCodecContext) must not be used outside libav*.
1520 typedef struct AVCodecContext {
1522 * information on struct for av_log
1523 * - set by avcodec_alloc_context3
1525 const AVClass *av_class;
1526 int log_level_offset;
1528 enum AVMediaType codec_type; /* see AVMEDIA_TYPE_xxx */
1529 const struct AVCodec *codec;
1530 enum AVCodecID codec_id; /* see AV_CODEC_ID_xxx */
1533 * fourcc (LSB first, so "ABCD" -> ('D'<<24) + ('C'<<16) + ('B'<<8) + 'A').
1534 * This is used to work around some encoder bugs.
1535 * A demuxer should set this to what is stored in the field used to identify the codec.
1536 * If there are multiple such fields in a container then the demuxer should choose the one
1537 * which maximizes the information about the used codec.
1538 * If the codec tag field in a container is larger than 32 bits then the demuxer should
1539 * remap the longer ID to 32 bits with a table or other structure. Alternatively a new
1540 * extra_codec_tag + size could be added but for this a clear advantage must be demonstrated
1542 * - encoding: Set by user, if not then the default based on codec_id will be used.
1543 * - decoding: Set by user, will be converted to uppercase by libavcodec during init.
1545 unsigned int codec_tag;
1550 * Private context used for internal data.
1552 * Unlike priv_data, this is not codec-specific. It is used in general
1553 * libavcodec functions.
1555 struct AVCodecInternal *internal;
1558 * Private data of the user, can be used to carry app specific stuff.
1559 * - encoding: Set by user.
1560 * - decoding: Set by user.
1565 * the average bitrate
1566 * - encoding: Set by user; unused for constant quantizer encoding.
1567 * - decoding: Set by user, may be overwritten by libavcodec
1568 * if this info is available in the stream
1573 * number of bits the bitstream is allowed to diverge from the reference.
1574 * the reference can be CBR (for CBR pass1) or VBR (for pass2)
1575 * - encoding: Set by user; unused for constant quantizer encoding.
1576 * - decoding: unused
1578 int bit_rate_tolerance;
1581 * Global quality for codecs which cannot change it per frame.
1582 * This should be proportional to MPEG-1/2/4 qscale.
1583 * - encoding: Set by user.
1584 * - decoding: unused
1589 * - encoding: Set by user.
1590 * - decoding: unused
1592 int compression_level;
1593 #define FF_COMPRESSION_DEFAULT -1
1597 * - encoding: Set by user.
1598 * - decoding: Set by user.
1604 * - encoding: Set by user.
1605 * - decoding: Set by user.
1610 * some codecs need / can use extradata like Huffman tables.
1611 * MJPEG: Huffman tables
1612 * rv10: additional flags
1613 * MPEG-4: global headers (they can be in the bitstream or here)
1614 * The allocated memory should be AV_INPUT_BUFFER_PADDING_SIZE bytes larger
1615 * than extradata_size to avoid problems if it is read with the bitstream reader.
1616 * The bytewise contents of extradata must not depend on the architecture or CPU endianness.
1617 * - encoding: Set/allocated/freed by libavcodec.
1618 * - decoding: Set/allocated/freed by user.
1624 * This is the fundamental unit of time (in seconds) in terms
1625 * of which frame timestamps are represented. For fixed-fps content,
1626 * timebase should be 1/framerate and timestamp increments should be
1628 * This often, but not always is the inverse of the frame rate or field rate
1629 * for video. 1/time_base is not the average frame rate if the frame rate is not
1632 * Like containers, elementary streams also can store timestamps, 1/time_base
1633 * is the unit in which these timestamps are specified.
1634 * As example of such codec time base see ISO/IEC 14496-2:2001(E)
1635 * vop_time_increment_resolution and fixed_vop_rate
1636 * (fixed_vop_rate == 0 implies that it is different from the framerate)
1638 * - encoding: MUST be set by user.
1639 * - decoding: the use of this field for decoding is deprecated.
1640 * Use framerate instead.
1642 AVRational time_base;
1645 * For some codecs, the time base is closer to the field rate than the frame rate.
1646 * Most notably, H.264 and MPEG-2 specify time_base as half of frame duration
1647 * if no telecine is used ...
1649 * Set to time_base ticks per frame. Default 1, e.g., H.264/MPEG-2 set it to 2.
1651 int ticks_per_frame;
1656 * Encoding: Number of frames delay there will be from the encoder input to
1657 * the decoder output. (we assume the decoder matches the spec)
1658 * Decoding: Number of frames delay in addition to what a standard decoder
1659 * as specified in the spec would produce.
1662 * Number of frames the decoded output will be delayed relative to the
1666 * For encoding, this field is unused (see initial_padding).
1668 * For decoding, this is the number of samples the decoder needs to
1669 * output before the decoder's output is valid. When seeking, you should
1670 * start decoding this many samples prior to your desired seek point.
1672 * - encoding: Set by libavcodec.
1673 * - decoding: Set by libavcodec.
1680 * picture width / height.
1682 * @note Those fields may not match the values of the last
1683 * AVFrame output by avcodec_decode_video2 due frame
1686 * - encoding: MUST be set by user.
1687 * - decoding: May be set by the user before opening the decoder if known e.g.
1688 * from the container. Some decoders will require the dimensions
1689 * to be set by the caller. During decoding, the decoder may
1690 * overwrite those values as required while parsing the data.
1695 * Bitstream width / height, may be different from width/height e.g. when
1696 * the decoded frame is cropped before being output or lowres is enabled.
1698 * @note Those field may not match the value of the last
1699 * AVFrame output by avcodec_receive_frame() due frame
1702 * - encoding: unused
1703 * - decoding: May be set by the user before opening the decoder if known
1704 * e.g. from the container. During decoding, the decoder may
1705 * overwrite those values as required while parsing the data.
1707 int coded_width, coded_height;
1710 * the number of pictures in a group of pictures, or 0 for intra_only
1711 * - encoding: Set by user.
1712 * - decoding: unused
1717 * Pixel format, see AV_PIX_FMT_xxx.
1718 * May be set by the demuxer if known from headers.
1719 * May be overridden by the decoder if it knows better.
1721 * @note This field may not match the value of the last
1722 * AVFrame output by avcodec_receive_frame() due frame
1725 * - encoding: Set by user.
1726 * - decoding: Set by user if known, overridden by libavcodec while
1729 enum AVPixelFormat pix_fmt;
1732 * If non NULL, 'draw_horiz_band' is called by the libavcodec
1733 * decoder to draw a horizontal band. It improves cache usage. Not
1734 * all codecs can do that. You must check the codec capabilities
1736 * When multithreading is used, it may be called from multiple threads
1737 * at the same time; threads might draw different parts of the same AVFrame,
1738 * or multiple AVFrames, and there is no guarantee that slices will be drawn
1740 * The function is also used by hardware acceleration APIs.
1741 * It is called at least once during frame decoding to pass
1742 * the data needed for hardware render.
1743 * In that mode instead of pixel data, AVFrame points to
1744 * a structure specific to the acceleration API. The application
1745 * reads the structure and can change some fields to indicate progress
1747 * - encoding: unused
1748 * - decoding: Set by user.
1749 * @param height the height of the slice
1750 * @param y the y position of the slice
1751 * @param type 1->top field, 2->bottom field, 3->frame
1752 * @param offset offset into the AVFrame.data from which the slice should be read
1754 void (*draw_horiz_band)(struct AVCodecContext *s,
1755 const AVFrame *src, int offset[AV_NUM_DATA_POINTERS],
1756 int y, int type, int height);
1759 * callback to negotiate the pixelFormat
1760 * @param fmt is the list of formats which are supported by the codec,
1761 * it is terminated by -1 as 0 is a valid format, the formats are ordered by quality.
1762 * The first is always the native one.
1763 * @note The callback may be called again immediately if initialization for
1764 * the selected (hardware-accelerated) pixel format failed.
1765 * @warning Behavior is undefined if the callback returns a value not
1766 * in the fmt list of formats.
1767 * @return the chosen format
1768 * - encoding: unused
1769 * - decoding: Set by user, if not set the native format will be chosen.
1771 enum AVPixelFormat (*get_format)(struct AVCodecContext *s, const enum AVPixelFormat * fmt);
1774 * maximum number of B-frames between non-B-frames
1775 * Note: The output will be delayed by max_b_frames+1 relative to the input.
1776 * - encoding: Set by user.
1777 * - decoding: unused
1782 * qscale factor between IP and B-frames
1783 * If > 0 then the last P-frame quantizer will be used (q= lastp_q*factor+offset).
1784 * If < 0 then normal ratecontrol will be done (q= -normal_q*factor+offset).
1785 * - encoding: Set by user.
1786 * - decoding: unused
1788 float b_quant_factor;
1790 #if FF_API_PRIVATE_OPT
1791 /** @deprecated use encoder private options instead */
1792 attribute_deprecated
1793 int b_frame_strategy;
1797 * qscale offset between IP and B-frames
1798 * - encoding: Set by user.
1799 * - decoding: unused
1801 float b_quant_offset;
1804 * Size of the frame reordering buffer in the decoder.
1805 * For MPEG-2 it is 1 IPB or 0 low delay IP.
1806 * - encoding: Set by libavcodec.
1807 * - decoding: Set by libavcodec.
1811 #if FF_API_PRIVATE_OPT
1812 /** @deprecated use encoder private options instead */
1813 attribute_deprecated
1818 * qscale factor between P- and I-frames
1819 * If > 0 then the last P-frame quantizer will be used (q = lastp_q * factor + offset).
1820 * If < 0 then normal ratecontrol will be done (q= -normal_q*factor+offset).
1821 * - encoding: Set by user.
1822 * - decoding: unused
1824 float i_quant_factor;
1827 * qscale offset between P and I-frames
1828 * - encoding: Set by user.
1829 * - decoding: unused
1831 float i_quant_offset;
1834 * luminance masking (0-> disabled)
1835 * - encoding: Set by user.
1836 * - decoding: unused
1841 * temporary complexity masking (0-> disabled)
1842 * - encoding: Set by user.
1843 * - decoding: unused
1845 float temporal_cplx_masking;
1848 * spatial complexity masking (0-> disabled)
1849 * - encoding: Set by user.
1850 * - decoding: unused
1852 float spatial_cplx_masking;
1855 * p block masking (0-> disabled)
1856 * - encoding: Set by user.
1857 * - decoding: unused
1862 * darkness masking (0-> disabled)
1863 * - encoding: Set by user.
1864 * - decoding: unused
1870 * - encoding: Set by libavcodec.
1871 * - decoding: Set by user (or 0).
1875 #if FF_API_PRIVATE_OPT
1876 /** @deprecated use encoder private options instead */
1877 attribute_deprecated
1878 int prediction_method;
1879 #define FF_PRED_LEFT 0
1880 #define FF_PRED_PLANE 1
1881 #define FF_PRED_MEDIAN 2
1885 * slice offsets in the frame in bytes
1886 * - encoding: Set/allocated by libavcodec.
1887 * - decoding: Set/allocated by user (or NULL).
1892 * sample aspect ratio (0 if unknown)
1893 * That is the width of a pixel divided by the height of the pixel.
1894 * Numerator and denominator must be relatively prime and smaller than 256 for some video standards.
1895 * - encoding: Set by user.
1896 * - decoding: Set by libavcodec.
1898 AVRational sample_aspect_ratio;
1901 * motion estimation comparison function
1902 * - encoding: Set by user.
1903 * - decoding: unused
1907 * subpixel motion estimation comparison function
1908 * - encoding: Set by user.
1909 * - decoding: unused
1913 * macroblock comparison function (not supported yet)
1914 * - encoding: Set by user.
1915 * - decoding: unused
1919 * interlaced DCT comparison function
1920 * - encoding: Set by user.
1921 * - decoding: unused
1924 #define FF_CMP_SAD 0
1925 #define FF_CMP_SSE 1
1926 #define FF_CMP_SATD 2
1927 #define FF_CMP_DCT 3
1928 #define FF_CMP_PSNR 4
1929 #define FF_CMP_BIT 5
1931 #define FF_CMP_ZERO 7
1932 #define FF_CMP_VSAD 8
1933 #define FF_CMP_VSSE 9
1934 #define FF_CMP_NSSE 10
1935 #define FF_CMP_W53 11
1936 #define FF_CMP_W97 12
1937 #define FF_CMP_DCTMAX 13
1938 #define FF_CMP_DCT264 14
1939 #define FF_CMP_MEDIAN_SAD 15
1940 #define FF_CMP_CHROMA 256
1943 * ME diamond size & shape
1944 * - encoding: Set by user.
1945 * - decoding: unused
1950 * amount of previous MV predictors (2a+1 x 2a+1 square)
1951 * - encoding: Set by user.
1952 * - decoding: unused
1954 int last_predictor_count;
1956 #if FF_API_PRIVATE_OPT
1957 /** @deprecated use encoder private options instead */
1958 attribute_deprecated
1963 * motion estimation prepass comparison function
1964 * - encoding: Set by user.
1965 * - decoding: unused
1970 * ME prepass diamond size & shape
1971 * - encoding: Set by user.
1972 * - decoding: unused
1978 * - encoding: Set by user.
1979 * - decoding: unused
1981 int me_subpel_quality;
1984 * maximum motion estimation search range in subpel units
1985 * If 0 then no limit.
1987 * - encoding: Set by user.
1988 * - decoding: unused
1994 * - encoding: unused
1995 * - decoding: Set by user.
1998 #define SLICE_FLAG_CODED_ORDER 0x0001 ///< draw_horiz_band() is called in coded order instead of display
1999 #define SLICE_FLAG_ALLOW_FIELD 0x0002 ///< allow draw_horiz_band() with field slices (MPEG-2 field pics)
2000 #define SLICE_FLAG_ALLOW_PLANE 0x0004 ///< allow draw_horiz_band() with 1 component at a time (SVQ1)
2003 * macroblock decision mode
2004 * - encoding: Set by user.
2005 * - decoding: unused
2008 #define FF_MB_DECISION_SIMPLE 0 ///< uses mb_cmp
2009 #define FF_MB_DECISION_BITS 1 ///< chooses the one which needs the fewest bits
2010 #define FF_MB_DECISION_RD 2 ///< rate distortion
2013 * custom intra quantization matrix
2014 * - encoding: Set by user, can be NULL.
2015 * - decoding: Set by libavcodec.
2017 uint16_t *intra_matrix;
2020 * custom inter quantization matrix
2021 * - encoding: Set by user, can be NULL.
2022 * - decoding: Set by libavcodec.
2024 uint16_t *inter_matrix;
2026 #if FF_API_PRIVATE_OPT
2027 /** @deprecated use encoder private options instead */
2028 attribute_deprecated
2029 int scenechange_threshold;
2031 /** @deprecated use encoder private options instead */
2032 attribute_deprecated
2033 int noise_reduction;
2037 * precision of the intra DC coefficient - 8
2038 * - encoding: Set by user.
2039 * - decoding: Set by libavcodec
2041 int intra_dc_precision;
2044 * Number of macroblock rows at the top which are skipped.
2045 * - encoding: unused
2046 * - decoding: Set by user.
2051 * Number of macroblock rows at the bottom which are skipped.
2052 * - encoding: unused
2053 * - decoding: Set by user.
2058 * minimum MB Lagrange multiplier
2059 * - encoding: Set by user.
2060 * - decoding: unused
2065 * maximum MB Lagrange multiplier
2066 * - encoding: Set by user.
2067 * - decoding: unused
2071 #if FF_API_PRIVATE_OPT
2073 * @deprecated use encoder private options instead
2075 attribute_deprecated
2076 int me_penalty_compensation;
2080 * - encoding: Set by user.
2081 * - decoding: unused
2085 #if FF_API_PRIVATE_OPT
2086 /** @deprecated use encoder private options instead */
2087 attribute_deprecated
2093 * - encoding: Set by user.
2094 * - decoding: unused
2099 * number of reference frames
2100 * - encoding: Set by user.
2101 * - decoding: Set by lavc.
2105 #if FF_API_PRIVATE_OPT
2106 /** @deprecated use encoder private options instead */
2107 attribute_deprecated
2112 * Note: Value depends upon the compare function used for fullpel ME.
2113 * - encoding: Set by user.
2114 * - decoding: unused
2118 #if FF_API_PRIVATE_OPT
2119 /** @deprecated use encoder private options instead */
2120 attribute_deprecated
2125 * Chromaticity coordinates of the source primaries.
2126 * - encoding: Set by user
2127 * - decoding: Set by libavcodec
2129 enum AVColorPrimaries color_primaries;
2132 * Color Transfer Characteristic.
2133 * - encoding: Set by user
2134 * - decoding: Set by libavcodec
2136 enum AVColorTransferCharacteristic color_trc;
2139 * YUV colorspace type.
2140 * - encoding: Set by user
2141 * - decoding: Set by libavcodec
2143 enum AVColorSpace colorspace;
2146 * MPEG vs JPEG YUV range.
2147 * - encoding: Set by user
2148 * - decoding: Set by libavcodec
2150 enum AVColorRange color_range;
2153 * This defines the location of chroma samples.
2154 * - encoding: Set by user
2155 * - decoding: Set by libavcodec
2157 enum AVChromaLocation chroma_sample_location;
2161 * Indicates number of picture subdivisions. Used for parallelized
2163 * - encoding: Set by user
2164 * - decoding: unused
2169 * - encoding: set by libavcodec
2170 * - decoding: Set by user.
2172 enum AVFieldOrder field_order;
2175 int sample_rate; ///< samples per second
2176 int channels; ///< number of audio channels
2179 * audio sample format
2180 * - encoding: Set by user.
2181 * - decoding: Set by libavcodec.
2183 enum AVSampleFormat sample_fmt; ///< sample format
2185 /* The following data should not be initialized. */
2187 * Number of samples per channel in an audio frame.
2189 * - encoding: set by libavcodec in avcodec_open2(). Each submitted frame
2190 * except the last must contain exactly frame_size samples per channel.
2191 * May be 0 when the codec has AV_CODEC_CAP_VARIABLE_FRAME_SIZE set, then the
2192 * frame size is not restricted.
2193 * - decoding: may be set by some decoders to indicate constant frame size
2198 * Frame counter, set by libavcodec.
2200 * - decoding: total number of frames returned from the decoder so far.
2201 * - encoding: total number of frames passed to the encoder so far.
2203 * @note the counter is not incremented if encoding/decoding resulted in
2209 * number of bytes per packet if constant and known or 0
2210 * Used by some WAV based audio codecs.
2215 * Audio cutoff bandwidth (0 means "automatic")
2216 * - encoding: Set by user.
2217 * - decoding: unused
2222 * Audio channel layout.
2223 * - encoding: set by user.
2224 * - decoding: set by user, may be overwritten by libavcodec.
2226 uint64_t channel_layout;
2229 * Request decoder to use this channel layout if it can (0 for default)
2230 * - encoding: unused
2231 * - decoding: Set by user.
2233 uint64_t request_channel_layout;
2236 * Type of service that the audio stream conveys.
2237 * - encoding: Set by user.
2238 * - decoding: Set by libavcodec.
2240 enum AVAudioServiceType audio_service_type;
2243 * desired sample format
2244 * - encoding: Not used.
2245 * - decoding: Set by user.
2246 * Decoder will decode to this format if it can.
2248 enum AVSampleFormat request_sample_fmt;
2251 * This callback is called at the beginning of each frame to get data
2252 * buffer(s) for it. There may be one contiguous buffer for all the data or
2253 * there may be a buffer per each data plane or anything in between. What
2254 * this means is, you may set however many entries in buf[] you feel necessary.
2255 * Each buffer must be reference-counted using the AVBuffer API (see description
2258 * The following fields will be set in the frame before this callback is
2261 * - width, height (video only)
2262 * - sample_rate, channel_layout, nb_samples (audio only)
2263 * Their values may differ from the corresponding values in
2264 * AVCodecContext. This callback must use the frame values, not the codec
2265 * context values, to calculate the required buffer size.
2267 * This callback must fill the following fields in the frame:
2271 * * if the data is planar audio with more than 8 channels, then this
2272 * callback must allocate and fill extended_data to contain all pointers
2273 * to all data planes. data[] must hold as many pointers as it can.
2274 * extended_data must be allocated with av_malloc() and will be freed in
2276 * * otherwise extended_data must point to data
2277 * - buf[] must contain one or more pointers to AVBufferRef structures. Each of
2278 * the frame's data and extended_data pointers must be contained in these. That
2279 * is, one AVBufferRef for each allocated chunk of memory, not necessarily one
2280 * AVBufferRef per data[] entry. See: av_buffer_create(), av_buffer_alloc(),
2281 * and av_buffer_ref().
2282 * - extended_buf and nb_extended_buf must be allocated with av_malloc() by
2283 * this callback and filled with the extra buffers if there are more
2284 * buffers than buf[] can hold. extended_buf will be freed in
2287 * If AV_CODEC_CAP_DR1 is not set then get_buffer2() must call
2288 * avcodec_default_get_buffer2() instead of providing buffers allocated by
2291 * Each data plane must be aligned to the maximum required by the target
2294 * @see avcodec_default_get_buffer2()
2298 * If AV_GET_BUFFER_FLAG_REF is set in flags then the frame may be reused
2299 * (read and/or written to if it is writable) later by libavcodec.
2301 * avcodec_align_dimensions2() should be used to find the required width and
2302 * height, as they normally need to be rounded up to the next multiple of 16.
2304 * Some decoders do not support linesizes changing between frames.
2306 * If frame multithreading is used and thread_safe_callbacks is set,
2307 * this callback may be called from a different thread, but not from more
2308 * than one at once. Does not need to be reentrant.
2310 * @see avcodec_align_dimensions2()
2314 * Decoders request a buffer of a particular size by setting
2315 * AVFrame.nb_samples prior to calling get_buffer2(). The decoder may,
2316 * however, utilize only part of the buffer by setting AVFrame.nb_samples
2317 * to a smaller value in the output frame.
2319 * As a convenience, av_samples_get_buffer_size() and
2320 * av_samples_fill_arrays() in libavutil may be used by custom get_buffer2()
2321 * functions to find the required data size and to fill data pointers and
2322 * linesize. In AVFrame.linesize, only linesize[0] may be set for audio
2323 * since all planes must be the same size.
2325 * @see av_samples_get_buffer_size(), av_samples_fill_arrays()
2327 * - encoding: unused
2328 * - decoding: Set by libavcodec, user can override.
2330 int (*get_buffer2)(struct AVCodecContext *s, AVFrame *frame, int flags);
2333 * If non-zero, the decoded audio and video frames returned from
2334 * avcodec_decode_video2() and avcodec_decode_audio4() are reference-counted
2335 * and are valid indefinitely. The caller must free them with
2336 * av_frame_unref() when they are not needed anymore.
2337 * Otherwise, the decoded frames must not be freed by the caller and are
2338 * only valid until the next decode call.
2340 * This is always automatically enabled if avcodec_receive_frame() is used.
2342 * - encoding: unused
2343 * - decoding: set by the caller before avcodec_open2().
2345 attribute_deprecated
2346 int refcounted_frames;
2348 /* - encoding parameters */
2349 float qcompress; ///< amount of qscale change between easy & hard scenes (0.0-1.0)
2350 float qblur; ///< amount of qscale smoothing over time (0.0-1.0)
2354 * - encoding: Set by user.
2355 * - decoding: unused
2361 * - encoding: Set by user.
2362 * - decoding: unused
2367 * maximum quantizer difference between frames
2368 * - encoding: Set by user.
2369 * - decoding: unused
2374 * decoder bitstream buffer size
2375 * - encoding: Set by user.
2376 * - decoding: unused
2381 * ratecontrol override, see RcOverride
2382 * - encoding: Allocated/set/freed by user.
2383 * - decoding: unused
2385 int rc_override_count;
2386 RcOverride *rc_override;
2390 * - encoding: Set by user.
2391 * - decoding: Set by user, may be overwritten by libavcodec.
2393 int64_t rc_max_rate;
2397 * - encoding: Set by user.
2398 * - decoding: unused
2400 int64_t rc_min_rate;
2403 * Ratecontrol attempt to use, at maximum, <value> of what can be used without an underflow.
2404 * - encoding: Set by user.
2405 * - decoding: unused.
2407 float rc_max_available_vbv_use;
2410 * Ratecontrol attempt to use, at least, <value> times the amount needed to prevent a vbv overflow.
2411 * - encoding: Set by user.
2412 * - decoding: unused.
2414 float rc_min_vbv_overflow_use;
2417 * Number of bits which should be loaded into the rc buffer before decoding starts.
2418 * - encoding: Set by user.
2419 * - decoding: unused
2421 int rc_initial_buffer_occupancy;
2423 #if FF_API_CODER_TYPE
2424 #define FF_CODER_TYPE_VLC 0
2425 #define FF_CODER_TYPE_AC 1
2426 #define FF_CODER_TYPE_RAW 2
2427 #define FF_CODER_TYPE_RLE 3
2429 * @deprecated use encoder private options instead
2431 attribute_deprecated
2433 #endif /* FF_API_CODER_TYPE */
2435 #if FF_API_PRIVATE_OPT
2436 /** @deprecated use encoder private options instead */
2437 attribute_deprecated
2441 #if FF_API_PRIVATE_OPT
2442 /** @deprecated use encoder private options instead */
2443 attribute_deprecated
2444 int frame_skip_threshold;
2446 /** @deprecated use encoder private options instead */
2447 attribute_deprecated
2448 int frame_skip_factor;
2450 /** @deprecated use encoder private options instead */
2451 attribute_deprecated
2454 /** @deprecated use encoder private options instead */
2455 attribute_deprecated
2457 #endif /* FF_API_PRIVATE_OPT */
2460 * trellis RD quantization
2461 * - encoding: Set by user.
2462 * - decoding: unused
2466 #if FF_API_PRIVATE_OPT
2467 /** @deprecated use encoder private options instead */
2468 attribute_deprecated
2469 int min_prediction_order;
2471 /** @deprecated use encoder private options instead */
2472 attribute_deprecated
2473 int max_prediction_order;
2475 /** @deprecated use encoder private options instead */
2476 attribute_deprecated
2477 int64_t timecode_frame_start;
2480 #if FF_API_RTP_CALLBACK
2482 * @deprecated unused
2484 /* The RTP callback: This function is called */
2485 /* every time the encoder has a packet to send. */
2486 /* It depends on the encoder if the data starts */
2487 /* with a Start Code (it should). H.263 does. */
2488 /* mb_nb contains the number of macroblocks */
2489 /* encoded in the RTP payload. */
2490 attribute_deprecated
2491 void (*rtp_callback)(struct AVCodecContext *avctx, void *data, int size, int mb_nb);
2494 #if FF_API_PRIVATE_OPT
2495 /** @deprecated use encoder private options instead */
2496 attribute_deprecated
2497 int rtp_payload_size; /* The size of the RTP payload: the coder will */
2498 /* do its best to deliver a chunk with size */
2499 /* below rtp_payload_size, the chunk will start */
2500 /* with a start code on some codecs like H.263. */
2501 /* This doesn't take account of any particular */
2502 /* headers inside the transmitted RTP payload. */
2505 #if FF_API_STAT_BITS
2506 /* statistics, used for 2-pass encoding */
2507 attribute_deprecated
2509 attribute_deprecated
2511 attribute_deprecated
2513 attribute_deprecated
2515 attribute_deprecated
2517 attribute_deprecated
2519 attribute_deprecated
2521 attribute_deprecated
2524 /** @deprecated this field is unused */
2525 attribute_deprecated
2530 * pass1 encoding statistics output buffer
2531 * - encoding: Set by libavcodec.
2532 * - decoding: unused
2537 * pass2 encoding statistics input buffer
2538 * Concatenated stuff from stats_out of pass1 should be placed here.
2539 * - encoding: Allocated/set/freed by user.
2540 * - decoding: unused
2545 * Work around bugs in encoders which sometimes cannot be detected automatically.
2546 * - encoding: Set by user
2547 * - decoding: Set by user
2549 int workaround_bugs;
2550 #define FF_BUG_AUTODETECT 1 ///< autodetection
2551 #define FF_BUG_XVID_ILACE 4
2552 #define FF_BUG_UMP4 8
2553 #define FF_BUG_NO_PADDING 16
2554 #define FF_BUG_AMV 32
2555 #define FF_BUG_QPEL_CHROMA 64
2556 #define FF_BUG_STD_QPEL 128
2557 #define FF_BUG_QPEL_CHROMA2 256
2558 #define FF_BUG_DIRECT_BLOCKSIZE 512
2559 #define FF_BUG_EDGE 1024
2560 #define FF_BUG_HPEL_CHROMA 2048
2561 #define FF_BUG_DC_CLIP 4096
2562 #define FF_BUG_MS 8192 ///< Work around various bugs in Microsoft's broken decoders.
2563 #define FF_BUG_TRUNCATED 16384
2564 #define FF_BUG_IEDGE 32768
2567 * strictly follow the standard (MPEG-4, ...).
2568 * - encoding: Set by user.
2569 * - decoding: Set by user.
2570 * Setting this to STRICT or higher means the encoder and decoder will
2571 * generally do stupid things, whereas setting it to unofficial or lower
2572 * will mean the encoder might produce output that is not supported by all
2573 * spec-compliant decoders. Decoders don't differentiate between normal,
2574 * unofficial and experimental (that is, they always try to decode things
2575 * when they can) unless they are explicitly asked to behave stupidly
2576 * (=strictly conform to the specs)
2578 int strict_std_compliance;
2579 #define FF_COMPLIANCE_VERY_STRICT 2 ///< Strictly conform to an older more strict version of the spec or reference software.
2580 #define FF_COMPLIANCE_STRICT 1 ///< Strictly conform to all the things in the spec no matter what consequences.
2581 #define FF_COMPLIANCE_NORMAL 0
2582 #define FF_COMPLIANCE_UNOFFICIAL -1 ///< Allow unofficial extensions
2583 #define FF_COMPLIANCE_EXPERIMENTAL -2 ///< Allow nonstandardized experimental things.
2586 * error concealment flags
2587 * - encoding: unused
2588 * - decoding: Set by user.
2590 int error_concealment;
2591 #define FF_EC_GUESS_MVS 1
2592 #define FF_EC_DEBLOCK 2
2593 #define FF_EC_FAVOR_INTER 256
2597 * - encoding: Set by user.
2598 * - decoding: Set by user.
2601 #define FF_DEBUG_PICT_INFO 1
2602 #define FF_DEBUG_RC 2
2603 #define FF_DEBUG_BITSTREAM 4
2604 #define FF_DEBUG_MB_TYPE 8
2605 #define FF_DEBUG_QP 16
2608 * @deprecated this option does nothing
2610 #define FF_DEBUG_MV 32
2612 #define FF_DEBUG_DCT_COEFF 0x00000040
2613 #define FF_DEBUG_SKIP 0x00000080
2614 #define FF_DEBUG_STARTCODE 0x00000100
2615 #define FF_DEBUG_ER 0x00000400
2616 #define FF_DEBUG_MMCO 0x00000800
2617 #define FF_DEBUG_BUGS 0x00001000
2619 #define FF_DEBUG_VIS_QP 0x00002000
2620 #define FF_DEBUG_VIS_MB_TYPE 0x00004000
2622 #define FF_DEBUG_BUFFERS 0x00008000
2623 #define FF_DEBUG_THREADS 0x00010000
2624 #define FF_DEBUG_GREEN_MD 0x00800000
2625 #define FF_DEBUG_NOMC 0x01000000
2630 * - encoding: Set by user.
2631 * - decoding: Set by user.
2634 #define FF_DEBUG_VIS_MV_P_FOR 0x00000001 // visualize forward predicted MVs of P-frames
2635 #define FF_DEBUG_VIS_MV_B_FOR 0x00000002 // visualize forward predicted MVs of B-frames
2636 #define FF_DEBUG_VIS_MV_B_BACK 0x00000004 // visualize backward predicted MVs of B-frames
2640 * Error recognition; may misdetect some more or less valid parts as errors.
2641 * - encoding: unused
2642 * - decoding: Set by user.
2644 int err_recognition;
2647 * Verify checksums embedded in the bitstream (could be of either encoded or
2648 * decoded data, depending on the codec) and print an error message on mismatch.
2649 * If AV_EF_EXPLODE is also set, a mismatching checksum will result in the
2650 * decoder returning an error.
2652 #define AV_EF_CRCCHECK (1<<0)
2653 #define AV_EF_BITSTREAM (1<<1) ///< detect bitstream specification deviations
2654 #define AV_EF_BUFFER (1<<2) ///< detect improper bitstream length
2655 #define AV_EF_EXPLODE (1<<3) ///< abort decoding on minor error detection
2657 #define AV_EF_IGNORE_ERR (1<<15) ///< ignore errors and continue
2658 #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
2659 #define AV_EF_COMPLIANT (1<<17) ///< consider all spec non compliances as errors
2660 #define AV_EF_AGGRESSIVE (1<<18) ///< consider things that a sane encoder should not do as an error
2664 * opaque 64-bit number (generally a PTS) that will be reordered and
2665 * output in AVFrame.reordered_opaque
2666 * - encoding: unused
2667 * - decoding: Set by user.
2669 int64_t reordered_opaque;
2672 * Hardware accelerator in use
2673 * - encoding: unused.
2674 * - decoding: Set by libavcodec
2676 const struct AVHWAccel *hwaccel;
2679 * Hardware accelerator context.
2680 * For some hardware accelerators, a global context needs to be
2681 * provided by the user. In that case, this holds display-dependent
2682 * data FFmpeg cannot instantiate itself. Please refer to the
2683 * FFmpeg HW accelerator documentation to know how to fill this
2684 * is. e.g. for VA API, this is a struct vaapi_context.
2685 * - encoding: unused
2686 * - decoding: Set by user
2688 void *hwaccel_context;
2692 * - encoding: Set by libavcodec if flags & AV_CODEC_FLAG_PSNR.
2693 * - decoding: unused
2695 uint64_t error[AV_NUM_DATA_POINTERS];
2698 * DCT algorithm, see FF_DCT_* below
2699 * - encoding: Set by user.
2700 * - decoding: unused
2703 #define FF_DCT_AUTO 0
2704 #define FF_DCT_FASTINT 1
2705 #define FF_DCT_INT 2
2706 #define FF_DCT_MMX 3
2707 #define FF_DCT_ALTIVEC 5
2708 #define FF_DCT_FAAN 6
2711 * IDCT algorithm, see FF_IDCT_* below.
2712 * - encoding: Set by user.
2713 * - decoding: Set by user.
2716 #define FF_IDCT_AUTO 0
2717 #define FF_IDCT_INT 1
2718 #define FF_IDCT_SIMPLE 2
2719 #define FF_IDCT_SIMPLEMMX 3
2720 #define FF_IDCT_ARM 7
2721 #define FF_IDCT_ALTIVEC 8
2722 #define FF_IDCT_SIMPLEARM 10
2723 #define FF_IDCT_XVID 14
2724 #define FF_IDCT_SIMPLEARMV5TE 16
2725 #define FF_IDCT_SIMPLEARMV6 17
2726 #define FF_IDCT_FAAN 20
2727 #define FF_IDCT_SIMPLENEON 22
2728 #define FF_IDCT_NONE 24 /* Used by XvMC to extract IDCT coefficients with FF_IDCT_PERM_NONE */
2729 #define FF_IDCT_SIMPLEAUTO 128
2732 * bits per sample/pixel from the demuxer (needed for huffyuv).
2733 * - encoding: Set by libavcodec.
2734 * - decoding: Set by user.
2736 int bits_per_coded_sample;
2739 * Bits per sample/pixel of internal libavcodec pixel/sample format.
2740 * - encoding: set by user.
2741 * - decoding: set by libavcodec.
2743 int bits_per_raw_sample;
2747 * low resolution decoding, 1-> 1/2 size, 2->1/4 size
2748 * - encoding: unused
2749 * - decoding: Set by user.
2754 #if FF_API_CODED_FRAME
2756 * the picture in the bitstream
2757 * - encoding: Set by libavcodec.
2758 * - decoding: unused
2760 * @deprecated use the quality factor packet side data instead
2762 attribute_deprecated AVFrame *coded_frame;
2767 * is used to decide how many independent tasks should be passed to execute()
2768 * - encoding: Set by user.
2769 * - decoding: Set by user.
2774 * Which multithreading methods to use.
2775 * Use of FF_THREAD_FRAME will increase decoding delay by one frame per thread,
2776 * so clients which cannot provide future frames should not use it.
2778 * - encoding: Set by user, otherwise the default is used.
2779 * - decoding: Set by user, otherwise the default is used.
2782 #define FF_THREAD_FRAME 1 ///< Decode more than one frame at once
2783 #define FF_THREAD_SLICE 2 ///< Decode more than one part of a single frame at once
2786 * Which multithreading methods are in use by the codec.
2787 * - encoding: Set by libavcodec.
2788 * - decoding: Set by libavcodec.
2790 int active_thread_type;
2793 * Set by the client if its custom get_buffer() callback can be called
2794 * synchronously from another thread, which allows faster multithreaded decoding.
2795 * draw_horiz_band() will be called from other threads regardless of this setting.
2796 * Ignored if the default get_buffer() is used.
2797 * - encoding: Set by user.
2798 * - decoding: Set by user.
2800 int thread_safe_callbacks;
2803 * The codec may call this to execute several independent things.
2804 * It will return only after finishing all tasks.
2805 * The user may replace this with some multithreaded implementation,
2806 * the default implementation will execute the parts serially.
2807 * @param count the number of things to execute
2808 * - encoding: Set by libavcodec, user can override.
2809 * - decoding: Set by libavcodec, user can override.
2811 int (*execute)(struct AVCodecContext *c, int (*func)(struct AVCodecContext *c2, void *arg), void *arg2, int *ret, int count, int size);
2814 * The codec may call this to execute several independent things.
2815 * It will return only after finishing all tasks.
2816 * The user may replace this with some multithreaded implementation,
2817 * the default implementation will execute the parts serially.
2818 * Also see avcodec_thread_init and e.g. the --enable-pthread configure option.
2819 * @param c context passed also to func
2820 * @param count the number of things to execute
2821 * @param arg2 argument passed unchanged to func
2822 * @param ret return values of executed functions, must have space for "count" values. May be NULL.
2823 * @param func function that will be called count times, with jobnr from 0 to count-1.
2824 * threadnr will be in the range 0 to c->thread_count-1 < MAX_THREADS and so that no
2825 * two instances of func executing at the same time will have the same threadnr.
2826 * @return always 0 currently, but code should handle a future improvement where when any call to func
2827 * returns < 0 no further calls to func may be done and < 0 is returned.
2828 * - encoding: Set by libavcodec, user can override.
2829 * - decoding: Set by libavcodec, user can override.
2831 int (*execute2)(struct AVCodecContext *c, int (*func)(struct AVCodecContext *c2, void *arg, int jobnr, int threadnr), void *arg2, int *ret, int count);
2834 * noise vs. sse weight for the nsse comparison function
2835 * - encoding: Set by user.
2836 * - decoding: unused
2842 * - encoding: Set by user.
2843 * - decoding: Set by libavcodec.
2846 #define FF_PROFILE_UNKNOWN -99
2847 #define FF_PROFILE_RESERVED -100
2849 #define FF_PROFILE_AAC_MAIN 0
2850 #define FF_PROFILE_AAC_LOW 1
2851 #define FF_PROFILE_AAC_SSR 2
2852 #define FF_PROFILE_AAC_LTP 3
2853 #define FF_PROFILE_AAC_HE 4
2854 #define FF_PROFILE_AAC_HE_V2 28
2855 #define FF_PROFILE_AAC_LD 22
2856 #define FF_PROFILE_AAC_ELD 38
2857 #define FF_PROFILE_MPEG2_AAC_LOW 128
2858 #define FF_PROFILE_MPEG2_AAC_HE 131
2860 #define FF_PROFILE_DNXHD 0
2861 #define FF_PROFILE_DNXHR_LB 1
2862 #define FF_PROFILE_DNXHR_SQ 2
2863 #define FF_PROFILE_DNXHR_HQ 3
2864 #define FF_PROFILE_DNXHR_HQX 4
2865 #define FF_PROFILE_DNXHR_444 5
2867 #define FF_PROFILE_DTS 20
2868 #define FF_PROFILE_DTS_ES 30
2869 #define FF_PROFILE_DTS_96_24 40
2870 #define FF_PROFILE_DTS_HD_HRA 50
2871 #define FF_PROFILE_DTS_HD_MA 60
2872 #define FF_PROFILE_DTS_EXPRESS 70
2874 #define FF_PROFILE_MPEG2_422 0
2875 #define FF_PROFILE_MPEG2_HIGH 1
2876 #define FF_PROFILE_MPEG2_SS 2
2877 #define FF_PROFILE_MPEG2_SNR_SCALABLE 3
2878 #define FF_PROFILE_MPEG2_MAIN 4
2879 #define FF_PROFILE_MPEG2_SIMPLE 5
2881 #define FF_PROFILE_H264_CONSTRAINED (1<<9) // 8+1; constraint_set1_flag
2882 #define FF_PROFILE_H264_INTRA (1<<11) // 8+3; constraint_set3_flag
2884 #define FF_PROFILE_H264_BASELINE 66
2885 #define FF_PROFILE_H264_CONSTRAINED_BASELINE (66|FF_PROFILE_H264_CONSTRAINED)
2886 #define FF_PROFILE_H264_MAIN 77
2887 #define FF_PROFILE_H264_EXTENDED 88
2888 #define FF_PROFILE_H264_HIGH 100
2889 #define FF_PROFILE_H264_HIGH_10 110
2890 #define FF_PROFILE_H264_HIGH_10_INTRA (110|FF_PROFILE_H264_INTRA)
2891 #define FF_PROFILE_H264_MULTIVIEW_HIGH 118
2892 #define FF_PROFILE_H264_HIGH_422 122
2893 #define FF_PROFILE_H264_HIGH_422_INTRA (122|FF_PROFILE_H264_INTRA)
2894 #define FF_PROFILE_H264_STEREO_HIGH 128
2895 #define FF_PROFILE_H264_HIGH_444 144
2896 #define FF_PROFILE_H264_HIGH_444_PREDICTIVE 244
2897 #define FF_PROFILE_H264_HIGH_444_INTRA (244|FF_PROFILE_H264_INTRA)
2898 #define FF_PROFILE_H264_CAVLC_444 44
2900 #define FF_PROFILE_VC1_SIMPLE 0
2901 #define FF_PROFILE_VC1_MAIN 1
2902 #define FF_PROFILE_VC1_COMPLEX 2
2903 #define FF_PROFILE_VC1_ADVANCED 3
2905 #define FF_PROFILE_MPEG4_SIMPLE 0
2906 #define FF_PROFILE_MPEG4_SIMPLE_SCALABLE 1
2907 #define FF_PROFILE_MPEG4_CORE 2
2908 #define FF_PROFILE_MPEG4_MAIN 3
2909 #define FF_PROFILE_MPEG4_N_BIT 4
2910 #define FF_PROFILE_MPEG4_SCALABLE_TEXTURE 5
2911 #define FF_PROFILE_MPEG4_SIMPLE_FACE_ANIMATION 6
2912 #define FF_PROFILE_MPEG4_BASIC_ANIMATED_TEXTURE 7
2913 #define FF_PROFILE_MPEG4_HYBRID 8
2914 #define FF_PROFILE_MPEG4_ADVANCED_REAL_TIME 9
2915 #define FF_PROFILE_MPEG4_CORE_SCALABLE 10
2916 #define FF_PROFILE_MPEG4_ADVANCED_CODING 11
2917 #define FF_PROFILE_MPEG4_ADVANCED_CORE 12
2918 #define FF_PROFILE_MPEG4_ADVANCED_SCALABLE_TEXTURE 13
2919 #define FF_PROFILE_MPEG4_SIMPLE_STUDIO 14
2920 #define FF_PROFILE_MPEG4_ADVANCED_SIMPLE 15
2922 #define FF_PROFILE_JPEG2000_CSTREAM_RESTRICTION_0 1
2923 #define FF_PROFILE_JPEG2000_CSTREAM_RESTRICTION_1 2
2924 #define FF_PROFILE_JPEG2000_CSTREAM_NO_RESTRICTION 32768
2925 #define FF_PROFILE_JPEG2000_DCINEMA_2K 3
2926 #define FF_PROFILE_JPEG2000_DCINEMA_4K 4
2928 #define FF_PROFILE_VP9_0 0
2929 #define FF_PROFILE_VP9_1 1
2930 #define FF_PROFILE_VP9_2 2
2931 #define FF_PROFILE_VP9_3 3
2933 #define FF_PROFILE_HEVC_MAIN 1
2934 #define FF_PROFILE_HEVC_MAIN_10 2
2935 #define FF_PROFILE_HEVC_MAIN_STILL_PICTURE 3
2936 #define FF_PROFILE_HEVC_REXT 4
2938 #define FF_PROFILE_AV1_MAIN 0
2939 #define FF_PROFILE_AV1_HIGH 1
2940 #define FF_PROFILE_AV1_PROFESSIONAL 2
2942 #define FF_PROFILE_MJPEG_HUFFMAN_BASELINE_DCT 0xc0
2943 #define FF_PROFILE_MJPEG_HUFFMAN_EXTENDED_SEQUENTIAL_DCT 0xc1
2944 #define FF_PROFILE_MJPEG_HUFFMAN_PROGRESSIVE_DCT 0xc2
2945 #define FF_PROFILE_MJPEG_HUFFMAN_LOSSLESS 0xc3
2946 #define FF_PROFILE_MJPEG_JPEG_LS 0xf7
2948 #define FF_PROFILE_SBC_MSBC 1
2952 * - encoding: Set by user.
2953 * - decoding: Set by libavcodec.
2956 #define FF_LEVEL_UNKNOWN -99
2959 * Skip loop filtering for selected frames.
2960 * - encoding: unused
2961 * - decoding: Set by user.
2963 enum AVDiscard skip_loop_filter;
2966 * Skip IDCT/dequantization for selected frames.
2967 * - encoding: unused
2968 * - decoding: Set by user.
2970 enum AVDiscard skip_idct;
2973 * Skip decoding for selected frames.
2974 * - encoding: unused
2975 * - decoding: Set by user.
2977 enum AVDiscard skip_frame;
2980 * Header containing style information for text subtitles.
2981 * For SUBTITLE_ASS subtitle type, it should contain the whole ASS
2982 * [Script Info] and [V4+ Styles] section, plus the [Events] line and
2983 * the Format line following. It shouldn't include any Dialogue line.
2984 * - encoding: Set/allocated/freed by user (before avcodec_open2())
2985 * - decoding: Set/allocated/freed by libavcodec (by avcodec_open2())
2987 uint8_t *subtitle_header;
2988 int subtitle_header_size;
2990 #if FF_API_VBV_DELAY
2992 * VBV delay coded in the last frame (in periods of a 27 MHz clock).
2993 * Used for compliant TS muxing.
2994 * - encoding: Set by libavcodec.
2995 * - decoding: unused.
2996 * @deprecated this value is now exported as a part of
2997 * AV_PKT_DATA_CPB_PROPERTIES packet side data
2999 attribute_deprecated
3003 #if FF_API_SIDEDATA_ONLY_PKT
3005 * Encoding only and set by default. Allow encoders to output packets
3006 * that do not contain any encoded data, only side data.
3008 * Some encoders need to output such packets, e.g. to update some stream
3009 * parameters at the end of encoding.
3011 * @deprecated this field disables the default behaviour and
3012 * it is kept only for compatibility.
3014 attribute_deprecated
3015 int side_data_only_packets;
3019 * Audio only. The number of "priming" samples (padding) inserted by the
3020 * encoder at the beginning of the audio. I.e. this number of leading
3021 * decoded samples must be discarded by the caller to get the original audio
3022 * without leading padding.
3024 * - decoding: unused
3025 * - encoding: Set by libavcodec. The timestamps on the output packets are
3026 * adjusted by the encoder so that they always refer to the
3027 * first sample of the data actually contained in the packet,
3028 * including any added padding. E.g. if the timebase is
3029 * 1/samplerate and the timestamp of the first input sample is
3030 * 0, the timestamp of the first output packet will be
3033 int initial_padding;
3036 * - decoding: For codecs that store a framerate value in the compressed
3037 * bitstream, the decoder may export it here. { 0, 1} when
3039 * - encoding: May be used to signal the framerate of CFR content to an
3042 AVRational framerate;
3045 * Nominal unaccelerated pixel format, see AV_PIX_FMT_xxx.
3046 * - encoding: unused.
3047 * - decoding: Set by libavcodec before calling get_format()
3049 enum AVPixelFormat sw_pix_fmt;
3052 * Timebase in which pkt_dts/pts and AVPacket.dts/pts are.
3053 * - encoding unused.
3054 * - decoding set by user.
3056 AVRational pkt_timebase;
3060 * - encoding: unused.
3061 * - decoding: set by libavcodec.
3063 const AVCodecDescriptor *codec_descriptor;
3067 * low resolution decoding, 1-> 1/2 size, 2->1/4 size
3068 * - encoding: unused
3069 * - decoding: Set by user.
3075 * Current statistics for PTS correction.
3076 * - decoding: maintained and used by libavcodec, not intended to be used by user apps
3077 * - encoding: unused
3079 int64_t pts_correction_num_faulty_pts; /// Number of incorrect PTS values so far
3080 int64_t pts_correction_num_faulty_dts; /// Number of incorrect DTS values so far
3081 int64_t pts_correction_last_pts; /// PTS of the last frame
3082 int64_t pts_correction_last_dts; /// DTS of the last frame
3085 * Character encoding of the input subtitles file.
3086 * - decoding: set by user
3087 * - encoding: unused
3092 * Subtitles character encoding mode. Formats or codecs might be adjusting
3093 * this setting (if they are doing the conversion themselves for instance).
3094 * - decoding: set by libavcodec
3095 * - encoding: unused
3097 int sub_charenc_mode;
3098 #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)
3099 #define FF_SUB_CHARENC_MODE_AUTOMATIC 0 ///< libavcodec will select the mode itself
3100 #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
3101 #define FF_SUB_CHARENC_MODE_IGNORE 2 ///< neither convert the subtitles, nor check them for valid UTF-8
3104 * Skip processing alpha if supported by codec.
3105 * Note that if the format uses pre-multiplied alpha (common with VP6,
3106 * and recommended due to better video quality/compression)
3107 * the image will look as if alpha-blended onto a black background.
3108 * However for formats that do not use pre-multiplied alpha
3109 * there might be serious artefacts (though e.g. libswscale currently
3110 * assumes pre-multiplied alpha anyway).
3112 * - decoding: set by user
3113 * - encoding: unused
3118 * Number of samples to skip after a discontinuity
3119 * - decoding: unused
3120 * - encoding: set by libavcodec
3124 #if !FF_API_DEBUG_MV
3126 * debug motion vectors
3127 * - encoding: Set by user.
3128 * - decoding: Set by user.
3131 #define FF_DEBUG_VIS_MV_P_FOR 0x00000001 //visualize forward predicted MVs of P frames
3132 #define FF_DEBUG_VIS_MV_B_FOR 0x00000002 //visualize forward predicted MVs of B frames
3133 #define FF_DEBUG_VIS_MV_B_BACK 0x00000004 //visualize backward predicted MVs of B frames
3137 * custom intra quantization matrix
3138 * - encoding: Set by user, can be NULL.
3139 * - decoding: unused.
3141 uint16_t *chroma_intra_matrix;
3144 * dump format separator.
3145 * can be ", " or "\n " or anything else
3146 * - encoding: Set by user.
3147 * - decoding: Set by user.
3149 uint8_t *dump_separator;
3152 * ',' separated list of allowed decoders.
3153 * If NULL then all are allowed
3154 * - encoding: unused
3155 * - decoding: set by user
3157 char *codec_whitelist;
3160 * Properties of the stream that gets decoded
3161 * - encoding: unused
3162 * - decoding: set by libavcodec
3164 unsigned properties;
3165 #define FF_CODEC_PROPERTY_LOSSLESS 0x00000001
3166 #define FF_CODEC_PROPERTY_CLOSED_CAPTIONS 0x00000002
3169 * Additional data associated with the entire coded stream.
3171 * - decoding: unused
3172 * - encoding: may be set by libavcodec after avcodec_open2().
3174 AVPacketSideData *coded_side_data;
3175 int nb_coded_side_data;
3178 * A reference to the AVHWFramesContext describing the input (for encoding)
3179 * or output (decoding) frames. The reference is set by the caller and
3180 * afterwards owned (and freed) by libavcodec - it should never be read by
3181 * the caller after being set.
3183 * - decoding: This field should be set by the caller from the get_format()
3184 * callback. The previous reference (if any) will always be
3185 * unreffed by libavcodec before the get_format() call.
3187 * If the default get_buffer2() is used with a hwaccel pixel
3188 * format, then this AVHWFramesContext will be used for
3189 * allocating the frame buffers.
3191 * - encoding: For hardware encoders configured to use a hwaccel pixel
3192 * format, this field should be set by the caller to a reference
3193 * to the AVHWFramesContext describing input frames.
3194 * AVHWFramesContext.format must be equal to
3195 * AVCodecContext.pix_fmt.
3197 * This field should be set before avcodec_open2() is called.
3199 AVBufferRef *hw_frames_ctx;
3202 * Control the form of AVSubtitle.rects[N]->ass
3203 * - decoding: set by user
3204 * - encoding: unused
3206 int sub_text_format;
3207 #define FF_SUB_TEXT_FMT_ASS 0
3208 #if FF_API_ASS_TIMING
3209 #define FF_SUB_TEXT_FMT_ASS_WITH_TIMINGS 1
3213 * Audio only. The amount of padding (in samples) appended by the encoder to
3214 * the end of the audio. I.e. this number of decoded samples must be
3215 * discarded by the caller from the end of the stream to get the original
3216 * audio without any trailing padding.
3218 * - decoding: unused
3219 * - encoding: unused
3221 int trailing_padding;
3224 * The number of pixels per image to maximally accept.
3226 * - decoding: set by user
3227 * - encoding: set by user
3232 * A reference to the AVHWDeviceContext describing the device which will
3233 * be used by a hardware encoder/decoder. The reference is set by the
3234 * caller and afterwards owned (and freed) by libavcodec.
3236 * This should be used if either the codec device does not require
3237 * hardware frames or any that are used are to be allocated internally by
3238 * libavcodec. If the user wishes to supply any of the frames used as
3239 * encoder input or decoder output then hw_frames_ctx should be used
3240 * instead. When hw_frames_ctx is set in get_format() for a decoder, this
3241 * field will be ignored while decoding the associated stream segment, but
3242 * may again be used on a following one after another get_format() call.
3244 * For both encoders and decoders this field should be set before
3245 * avcodec_open2() is called and must not be written to thereafter.
3247 * Note that some decoders may require this field to be set initially in
3248 * order to support hw_frames_ctx at all - in that case, all frames
3249 * contexts used must be created on the same device.
3251 AVBufferRef *hw_device_ctx;
3254 * Bit set of AV_HWACCEL_FLAG_* flags, which affect hardware accelerated
3255 * decoding (if active).
3256 * - encoding: unused
3257 * - decoding: Set by user (either before avcodec_open2(), or in the
3258 * AVCodecContext.get_format callback)
3263 * Video decoding only. Certain video codecs support cropping, meaning that
3264 * only a sub-rectangle of the decoded frame is intended for display. This
3265 * option controls how cropping is handled by libavcodec.
3267 * When set to 1 (the default), libavcodec will apply cropping internally.
3268 * I.e. it will modify the output frame width/height fields and offset the
3269 * data pointers (only by as much as possible while preserving alignment, or
3270 * by the full amount if the AV_CODEC_FLAG_UNALIGNED flag is set) so that
3271 * the frames output by the decoder refer only to the cropped area. The
3272 * crop_* fields of the output frames will be zero.
3274 * When set to 0, the width/height fields of the output frames will be set
3275 * to the coded dimensions and the crop_* fields will describe the cropping
3276 * rectangle. Applying the cropping is left to the caller.
3278 * @warning When hardware acceleration with opaque output frames is used,
3279 * libavcodec is unable to apply cropping from the top/left border.
3281 * @note when this option is set to zero, the width/height fields of the
3282 * AVCodecContext and output AVFrames have different meanings. The codec
3283 * context fields store display dimensions (with the coded dimensions in
3284 * coded_width/height), while the frame fields store the coded dimensions
3285 * (with the display dimensions being determined by the crop_* fields).
3290 * Video decoding only. Sets the number of extra hardware frames which
3291 * the decoder will allocate for use by the caller. This must be set
3292 * before avcodec_open2() is called.
3294 * Some hardware decoders require all frames that they will use for
3295 * output to be defined in advance before decoding starts. For such
3296 * decoders, the hardware frame pool must therefore be of a fixed size.
3297 * The extra frames set here are on top of any number that the decoder
3298 * needs internally in order to operate normally (for example, frames
3299 * used as reference pictures).
3301 int extra_hw_frames;
3304 #if FF_API_CODEC_GET_SET
3306 * Accessors for some AVCodecContext fields. These used to be provided for ABI
3307 * compatibility, and do not need to be used anymore.
3309 attribute_deprecated
3310 AVRational av_codec_get_pkt_timebase (const AVCodecContext *avctx);
3311 attribute_deprecated
3312 void av_codec_set_pkt_timebase (AVCodecContext *avctx, AVRational val);
3314 attribute_deprecated
3315 const AVCodecDescriptor *av_codec_get_codec_descriptor(const AVCodecContext *avctx);
3316 attribute_deprecated
3317 void av_codec_set_codec_descriptor(AVCodecContext *avctx, const AVCodecDescriptor *desc);
3319 attribute_deprecated
3320 unsigned av_codec_get_codec_properties(const AVCodecContext *avctx);
3323 attribute_deprecated
3324 int av_codec_get_lowres(const AVCodecContext *avctx);
3325 attribute_deprecated
3326 void av_codec_set_lowres(AVCodecContext *avctx, int val);
3329 attribute_deprecated
3330 int av_codec_get_seek_preroll(const AVCodecContext *avctx);
3331 attribute_deprecated
3332 void av_codec_set_seek_preroll(AVCodecContext *avctx, int val);
3334 attribute_deprecated
3335 uint16_t *av_codec_get_chroma_intra_matrix(const AVCodecContext *avctx);
3336 attribute_deprecated
3337 void av_codec_set_chroma_intra_matrix(AVCodecContext *avctx, uint16_t *val);
3343 typedef struct AVProfile {
3345 const char *name; ///< short name for the profile
3350 * The codec supports this format via the hw_device_ctx interface.
3352 * When selecting this format, AVCodecContext.hw_device_ctx should
3353 * have been set to a device of the specified type before calling
3356 AV_CODEC_HW_CONFIG_METHOD_HW_DEVICE_CTX = 0x01,
3358 * The codec supports this format via the hw_frames_ctx interface.
3360 * When selecting this format for a decoder,
3361 * AVCodecContext.hw_frames_ctx should be set to a suitable frames
3362 * context inside the get_format() callback. The frames context
3363 * must have been created on a device of the specified type.
3365 AV_CODEC_HW_CONFIG_METHOD_HW_FRAMES_CTX = 0x02,
3367 * The codec supports this format by some internal method.
3369 * This format can be selected without any additional configuration -
3370 * no device or frames context is required.
3372 AV_CODEC_HW_CONFIG_METHOD_INTERNAL = 0x04,
3374 * The codec supports this format by some ad-hoc method.
3376 * Additional settings and/or function calls are required. See the
3377 * codec-specific documentation for details. (Methods requiring
3378 * this sort of configuration are deprecated and others should be
3379 * used in preference.)
3381 AV_CODEC_HW_CONFIG_METHOD_AD_HOC = 0x08,
3384 typedef struct AVCodecHWConfig {
3386 * A hardware pixel format which the codec can use.
3388 enum AVPixelFormat pix_fmt;
3390 * Bit set of AV_CODEC_HW_CONFIG_METHOD_* flags, describing the possible
3391 * setup methods which can be used with this configuration.
3395 * The device type associated with the configuration.
3397 * Must be set for AV_CODEC_HW_CONFIG_METHOD_HW_DEVICE_CTX and
3398 * AV_CODEC_HW_CONFIG_METHOD_HW_FRAMES_CTX, otherwise unused.
3400 enum AVHWDeviceType device_type;
3403 typedef struct AVCodecDefault AVCodecDefault;
3410 typedef struct AVCodec {
3412 * Name of the codec implementation.
3413 * The name is globally unique among encoders and among decoders (but an
3414 * encoder and a decoder can share the same name).
3415 * This is the primary way to find a codec from the user perspective.
3419 * Descriptive name for the codec, meant to be more human readable than name.
3420 * You should use the NULL_IF_CONFIG_SMALL() macro to define it.
3422 const char *long_name;
3423 enum AVMediaType type;
3426 * Codec capabilities.
3427 * see AV_CODEC_CAP_*
3430 const AVRational *supported_framerates; ///< array of supported framerates, or NULL if any, array is terminated by {0,0}
3431 const enum AVPixelFormat *pix_fmts; ///< array of supported pixel formats, or NULL if unknown, array is terminated by -1
3432 const int *supported_samplerates; ///< array of supported audio samplerates, or NULL if unknown, array is terminated by 0
3433 const enum AVSampleFormat *sample_fmts; ///< array of supported sample formats, or NULL if unknown, array is terminated by -1
3434 const uint64_t *channel_layouts; ///< array of support channel layouts, or NULL if unknown. array is terminated by 0
3435 uint8_t max_lowres; ///< maximum value for lowres supported by the decoder
3436 const AVClass *priv_class; ///< AVClass for the private context
3437 const AVProfile *profiles; ///< array of recognized profiles, or NULL if unknown, array is terminated by {FF_PROFILE_UNKNOWN}
3440 * Group name of the codec implementation.
3441 * This is a short symbolic name of the wrapper backing this codec. A
3442 * wrapper uses some kind of external implementation for the codec, such
3443 * as an external library, or a codec implementation provided by the OS or
3445 * If this field is NULL, this is a builtin, libavcodec native codec.
3446 * If non-NULL, this will be the suffix in AVCodec.name in most cases
3447 * (usually AVCodec.name will be of the form "<codec_name>_<wrapper_name>").
3449 const char *wrapper_name;
3451 /*****************************************************************
3452 * No fields below this line are part of the public API. They
3453 * may not be used outside of libavcodec and can be changed and
3455 * New public fields should be added right above.
3456 *****************************************************************
3459 struct AVCodec *next;
3461 * @name Frame-level threading support functions
3465 * If defined, called on thread contexts when they are created.
3466 * If the codec allocates writable tables in init(), re-allocate them here.
3467 * priv_data will be set to a copy of the original.
3469 int (*init_thread_copy)(AVCodecContext *);
3471 * Copy necessary context variables from a previous thread context to the current one.
3472 * If not defined, the next thread will start automatically; otherwise, the codec
3473 * must call ff_thread_finish_setup().
3475 * dst and src will (rarely) point to the same context, in which case memcpy should be skipped.
3477 int (*update_thread_context)(AVCodecContext *dst, const AVCodecContext *src);
3481 * Private codec-specific defaults.
3483 const AVCodecDefault *defaults;
3486 * Initialize codec static data, called from avcodec_register().
3488 * This is not intended for time consuming operations as it is
3489 * run for every codec regardless of that codec being used.
3491 void (*init_static_data)(struct AVCodec *codec);
3493 int (*init)(AVCodecContext *);
3494 int (*encode_sub)(AVCodecContext *, uint8_t *buf, int buf_size,
3495 const struct AVSubtitle *sub);
3497 * Encode data to an AVPacket.
3499 * @param avctx codec context
3500 * @param avpkt output AVPacket (may contain a user-provided buffer)
3501 * @param[in] frame AVFrame containing the raw data to be encoded
3502 * @param[out] got_packet_ptr encoder sets to 0 or 1 to indicate that a
3503 * non-empty packet was returned in avpkt.
3504 * @return 0 on success, negative error code on failure
3506 int (*encode2)(AVCodecContext *avctx, AVPacket *avpkt, const AVFrame *frame,
3507 int *got_packet_ptr);
3508 int (*decode)(AVCodecContext *, void *outdata, int *outdata_size, AVPacket *avpkt);
3509 int (*close)(AVCodecContext *);
3511 * Encode API with decoupled packet/frame dataflow. The API is the
3512 * same as the avcodec_ prefixed APIs (avcodec_send_frame() etc.), except
3514 * - never called if the codec is closed or the wrong type,
3515 * - if AV_CODEC_CAP_DELAY is not set, drain frames are never sent,
3516 * - only one drain frame is ever passed down,
3518 int (*send_frame)(AVCodecContext *avctx, const AVFrame *frame);
3519 int (*receive_packet)(AVCodecContext *avctx, AVPacket *avpkt);
3522 * Decode API with decoupled packet/frame dataflow. This function is called
3523 * to get one output frame. It should call ff_decode_get_packet() to obtain
3526 int (*receive_frame)(AVCodecContext *avctx, AVFrame *frame);
3529 * Will be called when seeking
3531 void (*flush)(AVCodecContext *);
3533 * Internal codec capabilities.
3534 * See FF_CODEC_CAP_* in internal.h
3539 * Decoding only, a comma-separated list of bitstream filters to apply to
3540 * packets before decoding.
3545 * Array of pointers to hardware configurations supported by the codec,
3546 * or NULL if no hardware supported. The array is terminated by a NULL
3549 * The user can only access this field via avcodec_get_hw_config().
3551 const struct AVCodecHWConfigInternal **hw_configs;
3554 #if FF_API_CODEC_GET_SET
3555 attribute_deprecated
3556 int av_codec_get_max_lowres(const AVCodec *codec);
3559 struct MpegEncContext;
3562 * Retrieve supported hardware configurations for a codec.
3564 * Values of index from zero to some maximum return the indexed configuration
3565 * descriptor; all other values return NULL. If the codec does not support
3566 * any hardware configurations then it will always return NULL.
3568 const AVCodecHWConfig *avcodec_get_hw_config(const AVCodec *codec, int index);
3571 * @defgroup lavc_hwaccel AVHWAccel
3573 * @note Nothing in this structure should be accessed by the user. At some
3574 * point in future it will not be externally visible at all.
3578 typedef struct AVHWAccel {
3580 * Name of the hardware accelerated codec.
3581 * The name is globally unique among encoders and among decoders (but an
3582 * encoder and a decoder can share the same name).
3587 * Type of codec implemented by the hardware accelerator.
3589 * See AVMEDIA_TYPE_xxx
3591 enum AVMediaType type;
3594 * Codec implemented by the hardware accelerator.
3596 * See AV_CODEC_ID_xxx
3601 * Supported pixel format.
3603 * Only hardware accelerated formats are supported here.
3605 enum AVPixelFormat pix_fmt;
3608 * Hardware accelerated codec capabilities.
3609 * see AV_HWACCEL_CODEC_CAP_*
3613 /*****************************************************************
3614 * No fields below this line are part of the public API. They
3615 * may not be used outside of libavcodec and can be changed and
3617 * New public fields should be added right above.
3618 *****************************************************************
3622 * Allocate a custom buffer
3624 int (*alloc_frame)(AVCodecContext *avctx, AVFrame *frame);
3627 * Called at the beginning of each frame or field picture.
3629 * Meaningful frame information (codec specific) is guaranteed to
3630 * be parsed at this point. This function is mandatory.
3632 * Note that buf can be NULL along with buf_size set to 0.
3633 * Otherwise, this means the whole frame is available at this point.
3635 * @param avctx the codec context
3636 * @param buf the frame data buffer base
3637 * @param buf_size the size of the frame in bytes
3638 * @return zero if successful, a negative value otherwise
3640 int (*start_frame)(AVCodecContext *avctx, const uint8_t *buf, uint32_t buf_size);
3643 * Callback for parameter data (SPS/PPS/VPS etc).
3645 * Useful for hardware decoders which keep persistent state about the
3646 * video parameters, and need to receive any changes to update that state.
3648 * @param avctx the codec context
3649 * @param type the nal unit type
3650 * @param buf the nal unit data buffer
3651 * @param buf_size the size of the nal unit in bytes
3652 * @return zero if successful, a negative value otherwise
3654 int (*decode_params)(AVCodecContext *avctx, int type, const uint8_t *buf, uint32_t buf_size);
3657 * Callback for each slice.
3659 * Meaningful slice information (codec specific) is guaranteed to
3660 * be parsed at this point. This function is mandatory.
3661 * The only exception is XvMC, that works on MB level.
3663 * @param avctx the codec context
3664 * @param buf the slice data buffer base
3665 * @param buf_size the size of the slice in bytes
3666 * @return zero if successful, a negative value otherwise
3668 int (*decode_slice)(AVCodecContext *avctx, const uint8_t *buf, uint32_t buf_size);
3671 * Called at the end of each frame or field picture.
3673 * The whole picture is parsed at this point and can now be sent
3674 * to the hardware accelerator. This function is mandatory.
3676 * @param avctx the codec context
3677 * @return zero if successful, a negative value otherwise
3679 int (*end_frame)(AVCodecContext *avctx);
3682 * Size of per-frame hardware accelerator private data.
3684 * Private data is allocated with av_mallocz() before
3685 * AVCodecContext.get_buffer() and deallocated after
3686 * AVCodecContext.release_buffer().
3688 int frame_priv_data_size;
3691 * Called for every Macroblock in a slice.
3693 * XvMC uses it to replace the ff_mpv_reconstruct_mb().
3694 * Instead of decoding to raw picture, MB parameters are
3695 * stored in an array provided by the video driver.
3697 * @param s the mpeg context
3699 void (*decode_mb)(struct MpegEncContext *s);
3702 * Initialize the hwaccel private data.
3704 * This will be called from ff_get_format(), after hwaccel and
3705 * hwaccel_context are set and the hwaccel private data in AVCodecInternal
3708 int (*init)(AVCodecContext *avctx);
3711 * Uninitialize the hwaccel private data.
3713 * This will be called from get_format() or avcodec_close(), after hwaccel
3714 * and hwaccel_context are already uninitialized.
3716 int (*uninit)(AVCodecContext *avctx);
3719 * Size of the private data to allocate in
3720 * AVCodecInternal.hwaccel_priv_data.
3725 * Internal hwaccel capabilities.
3730 * Fill the given hw_frames context with current codec parameters. Called
3731 * from get_format. Refer to avcodec_get_hw_frames_parameters() for
3734 * This CAN be called before AVHWAccel.init is called, and you must assume
3735 * that avctx->hwaccel_priv_data is invalid.
3737 int (*frame_params)(AVCodecContext *avctx, AVBufferRef *hw_frames_ctx);
3741 * HWAccel is experimental and is thus avoided in favor of non experimental
3744 #define AV_HWACCEL_CODEC_CAP_EXPERIMENTAL 0x0200
3747 * Hardware acceleration should be used for decoding even if the codec level
3748 * used is unknown or higher than the maximum supported level reported by the
3751 * It's generally a good idea to pass this flag unless you have a specific
3752 * reason not to, as hardware tends to under-report supported levels.
3754 #define AV_HWACCEL_FLAG_IGNORE_LEVEL (1 << 0)
3757 * Hardware acceleration can output YUV pixel formats with a different chroma
3758 * sampling than 4:2:0 and/or other than 8 bits per component.
3760 #define AV_HWACCEL_FLAG_ALLOW_HIGH_DEPTH (1 << 1)
3763 * Hardware acceleration should still be attempted for decoding when the
3764 * codec profile does not match the reported capabilities of the hardware.
3766 * For example, this can be used to try to decode baseline profile H.264
3767 * streams in hardware - it will often succeed, because many streams marked
3768 * as baseline profile actually conform to constrained baseline profile.
3770 * @warning If the stream is actually not supported then the behaviour is
3771 * undefined, and may include returning entirely incorrect output
3772 * while indicating success.
3774 #define AV_HWACCEL_FLAG_ALLOW_PROFILE_MISMATCH (1 << 2)
3780 #if FF_API_AVPICTURE
3782 * @defgroup lavc_picture AVPicture
3784 * Functions for working with AVPicture
3789 * Picture data structure.
3791 * Up to four components can be stored into it, the last component is
3793 * @deprecated use AVFrame or imgutils functions instead
3795 typedef struct AVPicture {
3796 attribute_deprecated
3797 uint8_t *data[AV_NUM_DATA_POINTERS]; ///< pointers to the image data planes
3798 attribute_deprecated
3799 int linesize[AV_NUM_DATA_POINTERS]; ///< number of bytes per line
3807 enum AVSubtitleType {
3810 SUBTITLE_BITMAP, ///< A bitmap, pict will be set
3813 * Plain text, the text field must be set by the decoder and is
3814 * authoritative. ass and pict fields may contain approximations.
3819 * Formatted text, the ass field must be set by the decoder and is
3820 * authoritative. pict and text fields may contain approximations.
3825 #define AV_SUBTITLE_FLAG_FORCED 0x00000001
3827 typedef struct AVSubtitleRect {
3828 int x; ///< top left corner of pict, undefined when pict is not set
3829 int y; ///< top left corner of pict, undefined when pict is not set
3830 int w; ///< width of pict, undefined when pict is not set
3831 int h; ///< height of pict, undefined when pict is not set
3832 int nb_colors; ///< number of colors in pict, undefined when pict is not set
3834 #if FF_API_AVPICTURE
3836 * @deprecated unused
3838 attribute_deprecated
3842 * data+linesize for the bitmap of this subtitle.
3843 * Can be set for text/ass as well once they are rendered.
3848 enum AVSubtitleType type;
3850 char *text; ///< 0 terminated plain UTF-8 text
3853 * 0 terminated ASS/SSA compatible event line.
3854 * The presentation of this is unaffected by the other values in this
3862 typedef struct AVSubtitle {
3863 uint16_t format; /* 0 = graphics */
3864 uint32_t start_display_time; /* relative to packet pts, in ms */
3865 uint32_t end_display_time; /* relative to packet pts, in ms */
3867 AVSubtitleRect **rects;
3868 int64_t pts; ///< Same as packet pts, in AV_TIME_BASE
3872 * This struct describes the properties of an encoded stream.
3874 * sizeof(AVCodecParameters) is not a part of the public ABI, this struct must
3875 * be allocated with avcodec_parameters_alloc() and freed with
3876 * avcodec_parameters_free().
3878 typedef struct AVCodecParameters {
3880 * General type of the encoded data.
3882 enum AVMediaType codec_type;
3884 * Specific type of the encoded data (the codec used).
3886 enum AVCodecID codec_id;
3888 * Additional information about the codec (corresponds to the AVI FOURCC).
3893 * Extra binary data needed for initializing the decoder, codec-dependent.
3895 * Must be allocated with av_malloc() and will be freed by
3896 * avcodec_parameters_free(). The allocated size of extradata must be at
3897 * least extradata_size + AV_INPUT_BUFFER_PADDING_SIZE, with the padding
3902 * Size of the extradata content in bytes.
3907 * - video: the pixel format, the value corresponds to enum AVPixelFormat.
3908 * - audio: the sample format, the value corresponds to enum AVSampleFormat.
3913 * The average bitrate of the encoded data (in bits per second).
3918 * The number of bits per sample in the codedwords.
3920 * This is basically the bitrate per sample. It is mandatory for a bunch of
3921 * formats to actually decode them. It's the number of bits for one sample in
3922 * the actual coded bitstream.
3924 * This could be for example 4 for ADPCM
3925 * For PCM formats this matches bits_per_raw_sample
3928 int bits_per_coded_sample;
3931 * This is the number of valid bits in each output sample. If the
3932 * sample format has more bits, the least significant bits are additional
3933 * padding bits, which are always 0. Use right shifts to reduce the sample
3934 * to its actual size. For example, audio formats with 24 bit samples will
3935 * have bits_per_raw_sample set to 24, and format set to AV_SAMPLE_FMT_S32.
3936 * To get the original sample use "(int32_t)sample >> 8"."
3938 * For ADPCM this might be 12 or 16 or similar
3941 int bits_per_raw_sample;
3944 * Codec-specific bitstream restrictions that the stream conforms to.
3950 * Video only. The dimensions of the video frame in pixels.
3956 * Video only. The aspect ratio (width / height) which a single pixel
3957 * should have when displayed.
3959 * When the aspect ratio is unknown / undefined, the numerator should be
3960 * set to 0 (the denominator may have any value).
3962 AVRational sample_aspect_ratio;
3965 * Video only. The order of the fields in interlaced video.
3967 enum AVFieldOrder field_order;
3970 * Video only. Additional colorspace characteristics.
3972 enum AVColorRange color_range;
3973 enum AVColorPrimaries color_primaries;
3974 enum AVColorTransferCharacteristic color_trc;
3975 enum AVColorSpace color_space;
3976 enum AVChromaLocation chroma_location;
3979 * Video only. Number of delayed frames.
3984 * Audio only. The channel layout bitmask. May be 0 if the channel layout is
3985 * unknown or unspecified, otherwise the number of bits set must be equal to
3986 * the channels field.
3988 uint64_t channel_layout;
3990 * Audio only. The number of audio channels.
3994 * Audio only. The number of audio samples per second.
3998 * Audio only. The number of bytes per coded audio frame, required by some
4001 * Corresponds to nBlockAlign in WAVEFORMATEX.
4005 * Audio only. Audio frame size, if known. Required by some formats to be static.
4010 * Audio only. The amount of padding (in samples) inserted by the encoder at
4011 * the beginning of the audio. I.e. this number of leading decoded samples
4012 * must be discarded by the caller to get the original audio without leading
4015 int initial_padding;
4017 * Audio only. The amount of padding (in samples) appended by the encoder to
4018 * the end of the audio. I.e. this number of decoded samples must be
4019 * discarded by the caller from the end of the stream to get the original
4020 * audio without any trailing padding.
4022 int trailing_padding;
4024 * Audio only. Number of samples to skip after a discontinuity.
4027 } AVCodecParameters;
4030 * Iterate over all registered codecs.
4032 * @param opaque a pointer where libavcodec will store the iteration state. Must
4033 * point to NULL to start the iteration.
4035 * @return the next registered codec or NULL when the iteration is
4038 const AVCodec *av_codec_iterate(void **opaque);
4042 * If c is NULL, returns the first registered codec,
4043 * if c is non-NULL, returns the next registered codec after c,
4044 * or NULL if c is the last one.
4046 attribute_deprecated
4047 AVCodec *av_codec_next(const AVCodec *c);
4051 * Return the LIBAVCODEC_VERSION_INT constant.
4053 unsigned avcodec_version(void);
4056 * Return the libavcodec build-time configuration.
4058 const char *avcodec_configuration(void);
4061 * Return the libavcodec license.
4063 const char *avcodec_license(void);
4067 * Register the codec codec and initialize libavcodec.
4069 * @warning either this function or avcodec_register_all() must be called
4070 * before any other libavcodec functions.
4072 * @see avcodec_register_all()
4074 attribute_deprecated
4075 void avcodec_register(AVCodec *codec);
4078 * Register all the codecs, parsers and bitstream filters which were enabled at
4079 * configuration time. If you do not call this function you can select exactly
4080 * which formats you want to support, by using the individual registration
4083 * @see avcodec_register
4084 * @see av_register_codec_parser
4085 * @see av_register_bitstream_filter
4087 attribute_deprecated
4088 void avcodec_register_all(void);
4092 * Allocate an AVCodecContext and set its fields to default values. The
4093 * resulting struct should be freed with avcodec_free_context().
4095 * @param codec if non-NULL, allocate private data and initialize defaults
4096 * for the given codec. It is illegal to then call avcodec_open2()
4097 * with a different codec.
4098 * If NULL, then the codec-specific defaults won't be initialized,
4099 * which may result in suboptimal default settings (this is
4100 * important mainly for encoders, e.g. libx264).
4102 * @return An AVCodecContext filled with default values or NULL on failure.
4104 AVCodecContext *avcodec_alloc_context3(const AVCodec *codec);
4107 * Free the codec context and everything associated with it and write NULL to
4108 * the provided pointer.
4110 void avcodec_free_context(AVCodecContext **avctx);
4112 #if FF_API_GET_CONTEXT_DEFAULTS
4114 * @deprecated This function should not be used, as closing and opening a codec
4115 * context multiple time is not supported. A new codec context should be
4116 * allocated for each new use.
4118 int avcodec_get_context_defaults3(AVCodecContext *s, const AVCodec *codec);
4122 * Get the AVClass for AVCodecContext. It can be used in combination with
4123 * AV_OPT_SEARCH_FAKE_OBJ for examining options.
4125 * @see av_opt_find().
4127 const AVClass *avcodec_get_class(void);
4129 #if FF_API_COPY_CONTEXT
4131 * Get the AVClass for AVFrame. It can be used in combination with
4132 * AV_OPT_SEARCH_FAKE_OBJ for examining options.
4134 * @see av_opt_find().
4136 const AVClass *avcodec_get_frame_class(void);
4139 * Get the AVClass for AVSubtitleRect. It can be used in combination with
4140 * AV_OPT_SEARCH_FAKE_OBJ for examining options.
4142 * @see av_opt_find().
4144 const AVClass *avcodec_get_subtitle_rect_class(void);
4147 * Copy the settings of the source AVCodecContext into the destination
4148 * AVCodecContext. The resulting destination codec context will be
4149 * unopened, i.e. you are required to call avcodec_open2() before you
4150 * can use this AVCodecContext to decode/encode video/audio data.
4152 * @param dest target codec context, should be initialized with
4153 * avcodec_alloc_context3(NULL), but otherwise uninitialized
4154 * @param src source codec context
4155 * @return AVERROR() on error (e.g. memory allocation error), 0 on success
4157 * @deprecated The semantics of this function are ill-defined and it should not
4158 * be used. If you need to transfer the stream parameters from one codec context
4159 * to another, use an intermediate AVCodecParameters instance and the
4160 * avcodec_parameters_from_context() / avcodec_parameters_to_context()
4163 attribute_deprecated
4164 int avcodec_copy_context(AVCodecContext *dest, const AVCodecContext *src);
4168 * Allocate a new AVCodecParameters and set its fields to default values
4169 * (unknown/invalid/0). The returned struct must be freed with
4170 * avcodec_parameters_free().
4172 AVCodecParameters *avcodec_parameters_alloc(void);
4175 * Free an AVCodecParameters instance and everything associated with it and
4176 * write NULL to the supplied pointer.
4178 void avcodec_parameters_free(AVCodecParameters **par);
4181 * Copy the contents of src to dst. Any allocated fields in dst are freed and
4182 * replaced with newly allocated duplicates of the corresponding fields in src.
4184 * @return >= 0 on success, a negative AVERROR code on failure.
4186 int avcodec_parameters_copy(AVCodecParameters *dst, const AVCodecParameters *src);
4189 * Fill the parameters struct based on the values from the supplied codec
4190 * context. Any allocated fields in par are freed and replaced with duplicates
4191 * of the corresponding fields in codec.
4193 * @return >= 0 on success, a negative AVERROR code on failure
4195 int avcodec_parameters_from_context(AVCodecParameters *par,
4196 const AVCodecContext *codec);
4199 * Fill the codec context based on the values from the supplied codec
4200 * parameters. Any allocated fields in codec that have a corresponding field in
4201 * par are freed and replaced with duplicates of the corresponding field in par.
4202 * Fields in codec that do not have a counterpart in par are not touched.
4204 * @return >= 0 on success, a negative AVERROR code on failure.
4206 int avcodec_parameters_to_context(AVCodecContext *codec,
4207 const AVCodecParameters *par);
4210 * Initialize the AVCodecContext to use the given AVCodec. Prior to using this
4211 * function the context has to be allocated with avcodec_alloc_context3().
4213 * The functions avcodec_find_decoder_by_name(), avcodec_find_encoder_by_name(),
4214 * avcodec_find_decoder() and avcodec_find_encoder() provide an easy way for
4215 * retrieving a codec.
4217 * @warning This function is not thread safe!
4219 * @note Always call this function before using decoding routines (such as
4220 * @ref avcodec_receive_frame()).
4223 * avcodec_register_all();
4224 * av_dict_set(&opts, "b", "2.5M", 0);
4225 * codec = avcodec_find_decoder(AV_CODEC_ID_H264);
4229 * context = avcodec_alloc_context3(codec);
4231 * if (avcodec_open2(context, codec, opts) < 0)
4235 * @param avctx The context to initialize.
4236 * @param codec The codec to open this context for. If a non-NULL codec has been
4237 * previously passed to avcodec_alloc_context3() or
4238 * for this context, then this parameter MUST be either NULL or
4239 * equal to the previously passed codec.
4240 * @param options A dictionary filled with AVCodecContext and codec-private options.
4241 * On return this object will be filled with options that were not found.
4243 * @return zero on success, a negative value on error
4244 * @see avcodec_alloc_context3(), avcodec_find_decoder(), avcodec_find_encoder(),
4245 * av_dict_set(), av_opt_find().
4247 int avcodec_open2(AVCodecContext *avctx, const AVCodec *codec, AVDictionary **options);
4250 * Close a given AVCodecContext and free all the data associated with it
4251 * (but not the AVCodecContext itself).
4253 * Calling this function on an AVCodecContext that hasn't been opened will free
4254 * the codec-specific data allocated in avcodec_alloc_context3() with a non-NULL
4255 * codec. Subsequent calls will do nothing.
4257 * @note Do not use this function. Use avcodec_free_context() to destroy a
4258 * codec context (either open or closed). Opening and closing a codec context
4259 * multiple times is not supported anymore -- use multiple codec contexts
4262 int avcodec_close(AVCodecContext *avctx);
4265 * Free all allocated data in the given subtitle struct.
4267 * @param sub AVSubtitle to free.
4269 void avsubtitle_free(AVSubtitle *sub);
4276 * @addtogroup lavc_packet
4281 * Allocate an AVPacket and set its fields to default values. The resulting
4282 * struct must be freed using av_packet_free().
4284 * @return An AVPacket filled with default values or NULL on failure.
4286 * @note this only allocates the AVPacket itself, not the data buffers. Those
4287 * must be allocated through other means such as av_new_packet.
4289 * @see av_new_packet
4291 AVPacket *av_packet_alloc(void);
4294 * Create a new packet that references the same data as src.
4296 * This is a shortcut for av_packet_alloc()+av_packet_ref().
4298 * @return newly created AVPacket on success, NULL on error.
4300 * @see av_packet_alloc
4301 * @see av_packet_ref
4303 AVPacket *av_packet_clone(const AVPacket *src);
4306 * Free the packet, if the packet is reference counted, it will be
4307 * unreferenced first.
4309 * @param pkt packet to be freed. The pointer will be set to NULL.
4310 * @note passing NULL is a no-op.
4312 void av_packet_free(AVPacket **pkt);
4315 * Initialize optional fields of a packet with default values.
4317 * Note, this does not touch the data and size members, which have to be
4318 * initialized separately.
4322 void av_init_packet(AVPacket *pkt);
4325 * Allocate the payload of a packet and initialize its fields with
4329 * @param size wanted payload size
4330 * @return 0 if OK, AVERROR_xxx otherwise
4332 int av_new_packet(AVPacket *pkt, int size);
4335 * Reduce packet size, correctly zeroing padding
4338 * @param size new size
4340 void av_shrink_packet(AVPacket *pkt, int size);
4343 * Increase packet size, correctly zeroing padding
4346 * @param grow_by number of bytes by which to increase the size of the packet
4348 int av_grow_packet(AVPacket *pkt, int grow_by);
4351 * Initialize a reference-counted packet from av_malloc()ed data.
4353 * @param pkt packet to be initialized. This function will set the data, size,
4354 * buf and destruct fields, all others are left untouched.
4355 * @param data Data allocated by av_malloc() to be used as packet data. If this
4356 * function returns successfully, the data is owned by the underlying AVBuffer.
4357 * The caller may not access the data through other means.
4358 * @param size size of data in bytes, without the padding. I.e. the full buffer
4359 * size is assumed to be size + AV_INPUT_BUFFER_PADDING_SIZE.
4361 * @return 0 on success, a negative AVERROR on error
4363 int av_packet_from_data(AVPacket *pkt, uint8_t *data, int size);
4365 #if FF_API_AVPACKET_OLD_API
4367 * @warning This is a hack - the packet memory allocation stuff is broken. The
4368 * packet is allocated if it was not really allocated.
4370 * @deprecated Use av_packet_ref or av_packet_make_refcounted
4372 attribute_deprecated
4373 int av_dup_packet(AVPacket *pkt);
4375 * Copy packet, including contents
4377 * @return 0 on success, negative AVERROR on fail
4379 * @deprecated Use av_packet_ref
4381 attribute_deprecated
4382 int av_copy_packet(AVPacket *dst, const AVPacket *src);
4385 * Copy packet side data
4387 * @return 0 on success, negative AVERROR on fail
4389 * @deprecated Use av_packet_copy_props
4391 attribute_deprecated
4392 int av_copy_packet_side_data(AVPacket *dst, const AVPacket *src);
4397 * @deprecated Use av_packet_unref
4399 * @param pkt packet to free
4401 attribute_deprecated
4402 void av_free_packet(AVPacket *pkt);
4405 * Allocate new information of a packet.
4408 * @param type side information type
4409 * @param size side information size
4410 * @return pointer to fresh allocated data or NULL otherwise
4412 uint8_t* av_packet_new_side_data(AVPacket *pkt, enum AVPacketSideDataType type,
4416 * Wrap an existing array as a packet side data.
4419 * @param type side information type
4420 * @param data the side data array. It must be allocated with the av_malloc()
4421 * family of functions. The ownership of the data is transferred to
4423 * @param size side information size
4424 * @return a non-negative number on success, a negative AVERROR code on
4425 * failure. On failure, the packet is unchanged and the data remains
4426 * owned by the caller.
4428 int av_packet_add_side_data(AVPacket *pkt, enum AVPacketSideDataType type,
4429 uint8_t *data, size_t size);
4432 * Shrink the already allocated side data buffer
4435 * @param type side information type
4436 * @param size new side information size
4437 * @return 0 on success, < 0 on failure
4439 int av_packet_shrink_side_data(AVPacket *pkt, enum AVPacketSideDataType type,
4443 * Get side information from packet.
4446 * @param type desired side information type
4447 * @param size pointer for side information size to store (optional)
4448 * @return pointer to data if present or NULL otherwise
4450 uint8_t* av_packet_get_side_data(const AVPacket *pkt, enum AVPacketSideDataType type,
4453 #if FF_API_MERGE_SD_API
4454 attribute_deprecated
4455 int av_packet_merge_side_data(AVPacket *pkt);
4457 attribute_deprecated
4458 int av_packet_split_side_data(AVPacket *pkt);
4461 const char *av_packet_side_data_name(enum AVPacketSideDataType type);
4464 * Pack a dictionary for use in side_data.
4466 * @param dict The dictionary to pack.
4467 * @param size pointer to store the size of the returned data
4468 * @return pointer to data if successful, NULL otherwise
4470 uint8_t *av_packet_pack_dictionary(AVDictionary *dict, int *size);
4472 * Unpack a dictionary from side_data.
4474 * @param data data from side_data
4475 * @param size size of the data
4476 * @param dict the metadata storage dictionary
4477 * @return 0 on success, < 0 on failure
4479 int av_packet_unpack_dictionary(const uint8_t *data, int size, AVDictionary **dict);
4483 * Convenience function to free all the side data stored.
4484 * All the other fields stay untouched.
4488 void av_packet_free_side_data(AVPacket *pkt);
4491 * Setup a new reference to the data described by a given packet
4493 * If src is reference-counted, setup dst as a new reference to the
4494 * buffer in src. Otherwise allocate a new buffer in dst and copy the
4495 * data from src into it.
4497 * All the other fields are copied from src.
4499 * @see av_packet_unref
4501 * @param dst Destination packet
4502 * @param src Source packet
4504 * @return 0 on success, a negative AVERROR on error.
4506 int av_packet_ref(AVPacket *dst, const AVPacket *src);
4511 * Unreference the buffer referenced by the packet and reset the
4512 * remaining packet fields to their default values.
4514 * @param pkt The packet to be unreferenced.
4516 void av_packet_unref(AVPacket *pkt);
4519 * Move every field in src to dst and reset src.
4521 * @see av_packet_unref
4523 * @param src Source packet, will be reset
4524 * @param dst Destination packet
4526 void av_packet_move_ref(AVPacket *dst, AVPacket *src);
4529 * Copy only "properties" fields from src to dst.
4531 * Properties for the purpose of this function are all the fields
4532 * beside those related to the packet data (buf, data, size)
4534 * @param dst Destination packet
4535 * @param src Source packet
4537 * @return 0 on success AVERROR on failure.
4539 int av_packet_copy_props(AVPacket *dst, const AVPacket *src);
4542 * Ensure the data described by a given packet is reference counted.
4544 * @note This function does not ensure that the reference will be writable.
4545 * Use av_packet_make_writable instead for that purpose.
4547 * @see av_packet_ref
4548 * @see av_packet_make_writable
4550 * @param pkt packet whose data should be made reference counted.
4552 * @return 0 on success, a negative AVERROR on error. On failure, the
4553 * packet is unchanged.
4555 int av_packet_make_refcounted(AVPacket *pkt);
4558 * Create a writable reference for the data described by a given packet,
4559 * avoiding data copy if possible.
4561 * @param pkt Packet whose data should be made writable.
4563 * @return 0 on success, a negative AVERROR on failure. On failure, the
4564 * packet is unchanged.
4566 int av_packet_make_writable(AVPacket *pkt);
4569 * Convert valid timing fields (timestamps / durations) in a packet from one
4570 * timebase to another. Timestamps with unknown values (AV_NOPTS_VALUE) will be
4573 * @param pkt packet on which the conversion will be performed
4574 * @param tb_src source timebase, in which the timing fields in pkt are
4576 * @param tb_dst destination timebase, to which the timing fields will be
4579 void av_packet_rescale_ts(AVPacket *pkt, AVRational tb_src, AVRational tb_dst);
4586 * @addtogroup lavc_decoding
4591 * Find a registered decoder with a matching codec ID.
4593 * @param id AVCodecID of the requested decoder
4594 * @return A decoder if one was found, NULL otherwise.
4596 AVCodec *avcodec_find_decoder(enum AVCodecID id);
4599 * Find a registered decoder with the specified name.
4601 * @param name name of the requested decoder
4602 * @return A decoder if one was found, NULL otherwise.
4604 AVCodec *avcodec_find_decoder_by_name(const char *name);
4607 * The default callback for AVCodecContext.get_buffer2(). It is made public so
4608 * it can be called by custom get_buffer2() implementations for decoders without
4609 * AV_CODEC_CAP_DR1 set.
4611 int avcodec_default_get_buffer2(AVCodecContext *s, AVFrame *frame, int flags);
4614 * Modify width and height values so that they will result in a memory
4615 * buffer that is acceptable for the codec if you do not use any horizontal
4618 * May only be used if a codec with AV_CODEC_CAP_DR1 has been opened.
4620 void avcodec_align_dimensions(AVCodecContext *s, int *width, int *height);
4623 * Modify width and height values so that they will result in a memory
4624 * buffer that is acceptable for the codec if you also ensure that all
4625 * line sizes are a multiple of the respective linesize_align[i].
4627 * May only be used if a codec with AV_CODEC_CAP_DR1 has been opened.
4629 void avcodec_align_dimensions2(AVCodecContext *s, int *width, int *height,
4630 int linesize_align[AV_NUM_DATA_POINTERS]);
4633 * Converts AVChromaLocation to swscale x/y chroma position.
4635 * The positions represent the chroma (0,0) position in a coordinates system
4636 * with luma (0,0) representing the origin and luma(1,1) representing 256,256
4638 * @param xpos horizontal chroma sample position
4639 * @param ypos vertical chroma sample position
4641 int avcodec_enum_to_chroma_pos(int *xpos, int *ypos, enum AVChromaLocation pos);
4644 * Converts swscale x/y chroma position to AVChromaLocation.
4646 * The positions represent the chroma (0,0) position in a coordinates system
4647 * with luma (0,0) representing the origin and luma(1,1) representing 256,256
4649 * @param xpos horizontal chroma sample position
4650 * @param ypos vertical chroma sample position
4652 enum AVChromaLocation avcodec_chroma_pos_to_enum(int xpos, int ypos);
4655 * Decode the audio frame of size avpkt->size from avpkt->data into frame.
4657 * Some decoders may support multiple frames in a single AVPacket. Such
4658 * decoders would then just decode the first frame and the return value would be
4659 * less than the packet size. In this case, avcodec_decode_audio4 has to be
4660 * called again with an AVPacket containing the remaining data in order to
4661 * decode the second frame, etc... Even if no frames are returned, the packet
4662 * needs to be fed to the decoder with remaining data until it is completely
4663 * consumed or an error occurs.
4665 * Some decoders (those marked with AV_CODEC_CAP_DELAY) have a delay between input
4666 * and output. This means that for some packets they will not immediately
4667 * produce decoded output and need to be flushed at the end of decoding to get
4668 * all the decoded data. Flushing is done by calling this function with packets
4669 * with avpkt->data set to NULL and avpkt->size set to 0 until it stops
4670 * returning samples. It is safe to flush even those decoders that are not
4671 * marked with AV_CODEC_CAP_DELAY, then no samples will be returned.
4673 * @warning The input buffer, avpkt->data must be AV_INPUT_BUFFER_PADDING_SIZE
4674 * larger than the actual read bytes because some optimized bitstream
4675 * readers read 32 or 64 bits at once and could read over the end.
4677 * @note The AVCodecContext MUST have been opened with @ref avcodec_open2()
4678 * before packets may be fed to the decoder.
4680 * @param avctx the codec context
4681 * @param[out] frame The AVFrame in which to store decoded audio samples.
4682 * The decoder will allocate a buffer for the decoded frame by
4683 * calling the AVCodecContext.get_buffer2() callback.
4684 * When AVCodecContext.refcounted_frames is set to 1, the frame is
4685 * reference counted and the returned reference belongs to the
4686 * caller. The caller must release the frame using av_frame_unref()
4687 * when the frame is no longer needed. The caller may safely write
4688 * to the frame if av_frame_is_writable() returns 1.
4689 * When AVCodecContext.refcounted_frames is set to 0, the returned
4690 * reference belongs to the decoder and is valid only until the
4691 * next call to this function or until closing or flushing the
4692 * decoder. The caller may not write to it.
4693 * @param[out] got_frame_ptr Zero if no frame could be decoded, otherwise it is
4694 * non-zero. Note that this field being set to zero
4695 * does not mean that an error has occurred. For
4696 * decoders with AV_CODEC_CAP_DELAY set, no given decode
4697 * call is guaranteed to produce a frame.
4698 * @param[in] avpkt The input AVPacket containing the input buffer.
4699 * At least avpkt->data and avpkt->size should be set. Some
4700 * decoders might also require additional fields to be set.
4701 * @return A negative error code is returned if an error occurred during
4702 * decoding, otherwise the number of bytes consumed from the input
4703 * AVPacket is returned.
4705 * @deprecated Use avcodec_send_packet() and avcodec_receive_frame().
4707 attribute_deprecated
4708 int avcodec_decode_audio4(AVCodecContext *avctx, AVFrame *frame,
4709 int *got_frame_ptr, const AVPacket *avpkt);
4712 * Decode the video frame of size avpkt->size from avpkt->data into picture.
4713 * Some decoders may support multiple frames in a single AVPacket, such
4714 * decoders would then just decode the first frame.
4716 * @warning The input buffer must be AV_INPUT_BUFFER_PADDING_SIZE larger than
4717 * the actual read bytes because some optimized bitstream readers read 32 or 64
4718 * bits at once and could read over the end.
4720 * @warning The end of the input buffer buf should be set to 0 to ensure that
4721 * no overreading happens for damaged MPEG streams.
4723 * @note Codecs which have the AV_CODEC_CAP_DELAY capability set have a delay
4724 * between input and output, these need to be fed with avpkt->data=NULL,
4725 * avpkt->size=0 at the end to return the remaining frames.
4727 * @note The AVCodecContext MUST have been opened with @ref avcodec_open2()
4728 * before packets may be fed to the decoder.
4730 * @param avctx the codec context
4731 * @param[out] picture The AVFrame in which the decoded video frame will be stored.
4732 * Use av_frame_alloc() to get an AVFrame. The codec will
4733 * allocate memory for the actual bitmap by calling the
4734 * AVCodecContext.get_buffer2() callback.
4735 * When AVCodecContext.refcounted_frames is set to 1, the frame is
4736 * reference counted and the returned reference belongs to the
4737 * caller. The caller must release the frame using av_frame_unref()
4738 * when the frame is no longer needed. The caller may safely write
4739 * to the frame if av_frame_is_writable() returns 1.
4740 * When AVCodecContext.refcounted_frames is set to 0, the returned
4741 * reference belongs to the decoder and is valid only until the
4742 * next call to this function or until closing or flushing the
4743 * decoder. The caller may not write to it.
4745 * @param[in] avpkt The input AVPacket containing the input buffer.
4746 * You can create such packet with av_init_packet() and by then setting
4747 * data and size, some decoders might in addition need other fields like
4748 * flags&AV_PKT_FLAG_KEY. All decoders are designed to use the least
4750 * @param[in,out] got_picture_ptr Zero if no frame could be decompressed, otherwise, it is nonzero.
4751 * @return On error a negative value is returned, otherwise the number of bytes
4752 * used or zero if no frame could be decompressed.
4754 * @deprecated Use avcodec_send_packet() and avcodec_receive_frame().
4756 attribute_deprecated
4757 int avcodec_decode_video2(AVCodecContext *avctx, AVFrame *picture,
4758 int *got_picture_ptr,
4759 const AVPacket *avpkt);
4762 * Decode a subtitle message.
4763 * Return a negative value on error, otherwise return the number of bytes used.
4764 * If no subtitle could be decompressed, got_sub_ptr is zero.
4765 * Otherwise, the subtitle is stored in *sub.
4766 * Note that AV_CODEC_CAP_DR1 is not available for subtitle codecs. This is for
4767 * simplicity, because the performance difference is expect to be negligible
4768 * and reusing a get_buffer written for video codecs would probably perform badly
4769 * due to a potentially very different allocation pattern.
4771 * Some decoders (those marked with AV_CODEC_CAP_DELAY) have a delay between input
4772 * and output. This means that for some packets they will not immediately
4773 * produce decoded output and need to be flushed at the end of decoding to get
4774 * all the decoded data. Flushing is done by calling this function with packets
4775 * with avpkt->data set to NULL and avpkt->size set to 0 until it stops
4776 * returning subtitles. It is safe to flush even those decoders that are not
4777 * marked with AV_CODEC_CAP_DELAY, then no subtitles will be returned.
4779 * @note The AVCodecContext MUST have been opened with @ref avcodec_open2()
4780 * before packets may be fed to the decoder.
4782 * @param avctx the codec context
4783 * @param[out] sub The Preallocated AVSubtitle in which the decoded subtitle will be stored,
4784 * must be freed with avsubtitle_free if *got_sub_ptr is set.
4785 * @param[in,out] got_sub_ptr Zero if no subtitle could be decompressed, otherwise, it is nonzero.
4786 * @param[in] avpkt The input AVPacket containing the input buffer.
4788 int avcodec_decode_subtitle2(AVCodecContext *avctx, AVSubtitle *sub,
4793 * Supply raw packet data as input to a decoder.
4795 * Internally, this call will copy relevant AVCodecContext fields, which can
4796 * influence decoding per-packet, and apply them when the packet is actually
4797 * decoded. (For example AVCodecContext.skip_frame, which might direct the
4798 * decoder to drop the frame contained by the packet sent with this function.)
4800 * @warning The input buffer, avpkt->data must be AV_INPUT_BUFFER_PADDING_SIZE
4801 * larger than the actual read bytes because some optimized bitstream
4802 * readers read 32 or 64 bits at once and could read over the end.
4804 * @warning Do not mix this API with the legacy API (like avcodec_decode_video2())
4805 * on the same AVCodecContext. It will return unexpected results now
4806 * or in future libavcodec versions.
4808 * @note The AVCodecContext MUST have been opened with @ref avcodec_open2()
4809 * before packets may be fed to the decoder.
4811 * @param avctx codec context
4812 * @param[in] avpkt The input AVPacket. Usually, this will be a single video
4813 * frame, or several complete audio frames.
4814 * Ownership of the packet remains with the caller, and the
4815 * decoder will not write to the packet. The decoder may create
4816 * a reference to the packet data (or copy it if the packet is
4817 * not reference-counted).
4818 * Unlike with older APIs, the packet is always fully consumed,
4819 * and if it contains multiple frames (e.g. some audio codecs),
4820 * will require you to call avcodec_receive_frame() multiple
4821 * times afterwards before you can send a new packet.
4822 * It can be NULL (or an AVPacket with data set to NULL and
4823 * size set to 0); in this case, it is considered a flush
4824 * packet, which signals the end of the stream. Sending the
4825 * first flush packet will return success. Subsequent ones are
4826 * unnecessary and will return AVERROR_EOF. If the decoder
4827 * still has frames buffered, it will return them after sending
4830 * @return 0 on success, otherwise negative error code:
4831 * AVERROR(EAGAIN): input is not accepted in the current state - user
4832 * must read output with avcodec_receive_frame() (once
4833 * all output is read, the packet should be resent, and
4834 * the call will not fail with EAGAIN).
4835 * AVERROR_EOF: the decoder has been flushed, and no new packets can
4836 * be sent to it (also returned if more than 1 flush
4838 * AVERROR(EINVAL): codec not opened, it is an encoder, or requires flush
4839 * AVERROR(ENOMEM): failed to add packet to internal queue, or similar
4840 * other errors: legitimate decoding errors
4842 int avcodec_send_packet(AVCodecContext *avctx, const AVPacket *avpkt);
4845 * Return decoded output data from a decoder.
4847 * @param avctx codec context
4848 * @param frame This will be set to a reference-counted video or audio
4849 * frame (depending on the decoder type) allocated by the
4850 * decoder. Note that the function will always call
4851 * av_frame_unref(frame) before doing anything else.
4854 * 0: success, a frame was returned
4855 * AVERROR(EAGAIN): output is not available in this state - user must try
4857 * AVERROR_EOF: the decoder has been fully flushed, and there will be
4858 * no more output frames
4859 * AVERROR(EINVAL): codec not opened, or it is an encoder
4860 * other negative values: legitimate decoding errors
4862 int avcodec_receive_frame(AVCodecContext *avctx, AVFrame *frame);
4865 * Supply a raw video or audio frame to the encoder. Use avcodec_receive_packet()
4866 * to retrieve buffered output packets.
4868 * @param avctx codec context
4869 * @param[in] frame AVFrame containing the raw audio or video frame to be encoded.
4870 * Ownership of the frame remains with the caller, and the
4871 * encoder will not write to the frame. The encoder may create
4872 * a reference to the frame data (or copy it if the frame is
4873 * not reference-counted).
4874 * It can be NULL, in which case it is considered a flush
4875 * packet. This signals the end of the stream. If the encoder
4876 * still has packets buffered, it will return them after this
4877 * call. Once flushing mode has been entered, additional flush
4878 * packets are ignored, and sending frames will return
4882 * If AV_CODEC_CAP_VARIABLE_FRAME_SIZE is set, then each frame
4883 * can have any number of samples.
4884 * If it is not set, frame->nb_samples must be equal to
4885 * avctx->frame_size for all frames except the last.
4886 * The final frame may be smaller than avctx->frame_size.
4887 * @return 0 on success, otherwise negative error code:
4888 * AVERROR(EAGAIN): input is not accepted in the current state - user
4889 * must read output with avcodec_receive_packet() (once
4890 * all output is read, the packet should be resent, and
4891 * the call will not fail with EAGAIN).
4892 * AVERROR_EOF: the encoder has been flushed, and no new frames can
4894 * AVERROR(EINVAL): codec not opened, refcounted_frames not set, it is a
4895 * decoder, or requires flush
4896 * AVERROR(ENOMEM): failed to add packet to internal queue, or similar
4897 * other errors: legitimate decoding errors
4899 int avcodec_send_frame(AVCodecContext *avctx, const AVFrame *frame);
4902 * Read encoded data from the encoder.
4904 * @param avctx codec context
4905 * @param avpkt This will be set to a reference-counted packet allocated by the
4906 * encoder. Note that the function will always call
4907 * av_frame_unref(frame) before doing anything else.
4908 * @return 0 on success, otherwise negative error code:
4909 * AVERROR(EAGAIN): output is not available in the current state - user
4910 * must try to send input
4911 * AVERROR_EOF: the encoder has been fully flushed, and there will be
4912 * no more output packets
4913 * AVERROR(EINVAL): codec not opened, or it is an encoder
4914 * other errors: legitimate decoding errors
4916 int avcodec_receive_packet(AVCodecContext *avctx, AVPacket *avpkt);
4919 * Create and return a AVHWFramesContext with values adequate for hardware
4920 * decoding. This is meant to get called from the get_format callback, and is
4921 * a helper for preparing a AVHWFramesContext for AVCodecContext.hw_frames_ctx.
4922 * This API is for decoding with certain hardware acceleration modes/APIs only.
4924 * The returned AVHWFramesContext is not initialized. The caller must do this
4925 * with av_hwframe_ctx_init().
4927 * Calling this function is not a requirement, but makes it simpler to avoid
4928 * codec or hardware API specific details when manually allocating frames.
4930 * Alternatively to this, an API user can set AVCodecContext.hw_device_ctx,
4931 * which sets up AVCodecContext.hw_frames_ctx fully automatically, and makes
4932 * it unnecessary to call this function or having to care about
4933 * AVHWFramesContext initialization at all.
4935 * There are a number of requirements for calling this function:
4937 * - It must be called from get_format with the same avctx parameter that was
4938 * passed to get_format. Calling it outside of get_format is not allowed, and
4939 * can trigger undefined behavior.
4940 * - The function is not always supported (see description of return values).
4941 * Even if this function returns successfully, hwaccel initialization could
4942 * fail later. (The degree to which implementations check whether the stream
4943 * is actually supported varies. Some do this check only after the user's
4944 * get_format callback returns.)
4945 * - The hw_pix_fmt must be one of the choices suggested by get_format. If the
4946 * user decides to use a AVHWFramesContext prepared with this API function,
4947 * the user must return the same hw_pix_fmt from get_format.
4948 * - The device_ref passed to this function must support the given hw_pix_fmt.
4949 * - After calling this API function, it is the user's responsibility to
4950 * initialize the AVHWFramesContext (returned by the out_frames_ref parameter),
4951 * and to set AVCodecContext.hw_frames_ctx to it. If done, this must be done
4952 * before returning from get_format (this is implied by the normal
4953 * AVCodecContext.hw_frames_ctx API rules).
4954 * - The AVHWFramesContext parameters may change every time time get_format is
4955 * called. Also, AVCodecContext.hw_frames_ctx is reset before get_format. So
4956 * you are inherently required to go through this process again on every
4958 * - It is perfectly possible to call this function without actually using
4959 * the resulting AVHWFramesContext. One use-case might be trying to reuse a
4960 * previously initialized AVHWFramesContext, and calling this API function
4961 * only to test whether the required frame parameters have changed.
4962 * - Fields that use dynamically allocated values of any kind must not be set
4963 * by the user unless setting them is explicitly allowed by the documentation.
4964 * If the user sets AVHWFramesContext.free and AVHWFramesContext.user_opaque,
4965 * the new free callback must call the potentially set previous free callback.
4966 * This API call may set any dynamically allocated fields, including the free
4969 * The function will set at least the following fields on AVHWFramesContext
4970 * (potentially more, depending on hwaccel API):
4972 * - All fields set by av_hwframe_ctx_alloc().
4973 * - Set the format field to hw_pix_fmt.
4974 * - Set the sw_format field to the most suited and most versatile format. (An
4975 * implication is that this will prefer generic formats over opaque formats
4976 * with arbitrary restrictions, if possible.)
4977 * - Set the width/height fields to the coded frame size, rounded up to the
4978 * API-specific minimum alignment.
4979 * - Only _if_ the hwaccel requires a pre-allocated pool: set the initial_pool_size
4980 * field to the number of maximum reference surfaces possible with the codec,
4981 * plus 1 surface for the user to work (meaning the user can safely reference
4982 * at most 1 decoded surface at a time), plus additional buffering introduced
4983 * by frame threading. If the hwaccel does not require pre-allocation, the
4984 * field is left to 0, and the decoder will allocate new surfaces on demand
4986 * - Possibly AVHWFramesContext.hwctx fields, depending on the underlying
4989 * Essentially, out_frames_ref returns the same as av_hwframe_ctx_alloc(), but
4990 * with basic frame parameters set.
4992 * The function is stateless, and does not change the AVCodecContext or the
4993 * device_ref AVHWDeviceContext.
4995 * @param avctx The context which is currently calling get_format, and which
4996 * implicitly contains all state needed for filling the returned
4997 * AVHWFramesContext properly.
4998 * @param device_ref A reference to the AVHWDeviceContext describing the device
4999 * which will be used by the hardware decoder.
5000 * @param hw_pix_fmt The hwaccel format you are going to return from get_format.
5001 * @param out_frames_ref On success, set to a reference to an _uninitialized_
5002 * AVHWFramesContext, created from the given device_ref.
5003 * Fields will be set to values required for decoding.
5004 * Not changed if an error is returned.
5005 * @return zero on success, a negative value on error. The following error codes
5006 * have special semantics:
5007 * AVERROR(ENOENT): the decoder does not support this functionality. Setup
5008 * is always manual, or it is a decoder which does not
5009 * support setting AVCodecContext.hw_frames_ctx at all,
5010 * or it is a software format.
5011 * AVERROR(EINVAL): it is known that hardware decoding is not supported for
5012 * this configuration, or the device_ref is not supported
5013 * for the hwaccel referenced by hw_pix_fmt.
5015 int avcodec_get_hw_frames_parameters(AVCodecContext *avctx,
5016 AVBufferRef *device_ref,
5017 enum AVPixelFormat hw_pix_fmt,
5018 AVBufferRef **out_frames_ref);
5023 * @defgroup lavc_parsing Frame parsing
5027 enum AVPictureStructure {
5028 AV_PICTURE_STRUCTURE_UNKNOWN, //< unknown
5029 AV_PICTURE_STRUCTURE_TOP_FIELD, //< coded as top field
5030 AV_PICTURE_STRUCTURE_BOTTOM_FIELD, //< coded as bottom field
5031 AV_PICTURE_STRUCTURE_FRAME, //< coded as frame
5034 typedef struct AVCodecParserContext {
5036 struct AVCodecParser *parser;
5037 int64_t frame_offset; /* offset of the current frame */
5038 int64_t cur_offset; /* current offset
5039 (incremented by each av_parser_parse()) */
5040 int64_t next_frame_offset; /* offset of the next frame */
5042 int pict_type; /* XXX: Put it back in AVCodecContext. */
5044 * This field is used for proper frame duration computation in lavf.
5045 * It signals, how much longer the frame duration of the current frame
5046 * is compared to normal frame duration.
5048 * frame_duration = (1 + repeat_pict) * time_base
5050 * It is used by codecs like H.264 to display telecined material.
5052 int repeat_pict; /* XXX: Put it back in AVCodecContext. */
5053 int64_t pts; /* pts of the current frame */
5054 int64_t dts; /* dts of the current frame */
5059 int fetch_timestamp;
5061 #define AV_PARSER_PTS_NB 4
5062 int cur_frame_start_index;
5063 int64_t cur_frame_offset[AV_PARSER_PTS_NB];
5064 int64_t cur_frame_pts[AV_PARSER_PTS_NB];
5065 int64_t cur_frame_dts[AV_PARSER_PTS_NB];
5068 #define PARSER_FLAG_COMPLETE_FRAMES 0x0001
5069 #define PARSER_FLAG_ONCE 0x0002
5070 /// Set if the parser has a valid file offset
5071 #define PARSER_FLAG_FETCHED_OFFSET 0x0004
5072 #define PARSER_FLAG_USE_CODEC_TS 0x1000
5074 int64_t offset; ///< byte offset from starting packet start
5075 int64_t cur_frame_end[AV_PARSER_PTS_NB];
5078 * Set by parser to 1 for key frames and 0 for non-key frames.
5079 * It is initialized to -1, so if the parser doesn't set this flag,
5080 * old-style fallback using AV_PICTURE_TYPE_I picture type as key frames
5085 #if FF_API_CONVERGENCE_DURATION
5087 * @deprecated unused
5089 attribute_deprecated
5090 int64_t convergence_duration;
5093 // Timestamp generation support:
5095 * Synchronization point for start of timestamp generation.
5097 * Set to >0 for sync point, 0 for no sync point and <0 for undefined
5100 * For example, this corresponds to presence of H.264 buffering period
5106 * Offset of the current timestamp against last timestamp sync point in
5107 * units of AVCodecContext.time_base.
5109 * Set to INT_MIN when dts_sync_point unused. Otherwise, it must
5110 * contain a valid timestamp offset.
5112 * Note that the timestamp of sync point has usually a nonzero
5113 * dts_ref_dts_delta, which refers to the previous sync point. Offset of
5114 * the next frame after timestamp sync point will be usually 1.
5116 * For example, this corresponds to H.264 cpb_removal_delay.
5118 int dts_ref_dts_delta;
5121 * Presentation delay of current frame in units of AVCodecContext.time_base.
5123 * Set to INT_MIN when dts_sync_point unused. Otherwise, it must
5124 * contain valid non-negative timestamp delta (presentation time of a frame
5125 * must not lie in the past).
5127 * This delay represents the difference between decoding and presentation
5128 * time of the frame.
5130 * For example, this corresponds to H.264 dpb_output_delay.
5135 * Position of the packet in file.
5137 * Analogous to cur_frame_pts/dts
5139 int64_t cur_frame_pos[AV_PARSER_PTS_NB];
5142 * Byte position of currently parsed frame in stream.
5147 * Previous frame byte position.
5152 * Duration of the current frame.
5153 * For audio, this is in units of 1 / AVCodecContext.sample_rate.
5154 * For all other types, this is in units of AVCodecContext.time_base.
5158 enum AVFieldOrder field_order;
5161 * Indicate whether a picture is coded as a frame, top field or bottom field.
5163 * For example, H.264 field_pic_flag equal to 0 corresponds to
5164 * AV_PICTURE_STRUCTURE_FRAME. An H.264 picture with field_pic_flag
5165 * equal to 1 and bottom_field_flag equal to 0 corresponds to
5166 * AV_PICTURE_STRUCTURE_TOP_FIELD.
5168 enum AVPictureStructure picture_structure;
5171 * Picture number incremented in presentation or output order.
5172 * This field may be reinitialized at the first picture of a new sequence.
5174 * For example, this corresponds to H.264 PicOrderCnt.
5176 int output_picture_number;
5179 * Dimensions of the decoded video intended for presentation.
5185 * Dimensions of the coded video.
5191 * The format of the coded data, corresponds to enum AVPixelFormat for video
5192 * and for enum AVSampleFormat for audio.
5194 * Note that a decoder can have considerable freedom in how exactly it
5195 * decodes the data, so the format reported here might be different from the
5196 * one returned by a decoder.
5199 } AVCodecParserContext;
5201 typedef struct AVCodecParser {
5202 int codec_ids[5]; /* several codec IDs are permitted */
5204 int (*parser_init)(AVCodecParserContext *s);
5205 /* This callback never returns an error, a negative value means that
5206 * the frame start was in a previous packet. */
5207 int (*parser_parse)(AVCodecParserContext *s,
5208 AVCodecContext *avctx,
5209 const uint8_t **poutbuf, int *poutbuf_size,
5210 const uint8_t *buf, int buf_size);
5211 void (*parser_close)(AVCodecParserContext *s);
5212 int (*split)(AVCodecContext *avctx, const uint8_t *buf, int buf_size);
5213 struct AVCodecParser *next;
5217 * Iterate over all registered codec parsers.
5219 * @param opaque a pointer where libavcodec will store the iteration state. Must
5220 * point to NULL to start the iteration.
5222 * @return the next registered codec parser or NULL when the iteration is
5225 const AVCodecParser *av_parser_iterate(void **opaque);
5227 attribute_deprecated
5228 AVCodecParser *av_parser_next(const AVCodecParser *c);
5230 attribute_deprecated
5231 void av_register_codec_parser(AVCodecParser *parser);
5232 AVCodecParserContext *av_parser_init(int codec_id);
5237 * @param s parser context.
5238 * @param avctx codec context.
5239 * @param poutbuf set to pointer to parsed buffer or NULL if not yet finished.
5240 * @param poutbuf_size set to size of parsed buffer or zero if not yet finished.
5241 * @param buf input buffer.
5242 * @param buf_size buffer size in bytes without the padding. I.e. the full buffer
5243 size is assumed to be buf_size + AV_INPUT_BUFFER_PADDING_SIZE.
5244 To signal EOF, this should be 0 (so that the last frame
5246 * @param pts input presentation timestamp.
5247 * @param dts input decoding timestamp.
5248 * @param pos input byte position in stream.
5249 * @return the number of bytes of the input bitstream used.
5254 * len = av_parser_parse2(myparser, AVCodecContext, &data, &size,
5261 * decode_frame(data, size);
5265 int av_parser_parse2(AVCodecParserContext *s,
5266 AVCodecContext *avctx,
5267 uint8_t **poutbuf, int *poutbuf_size,
5268 const uint8_t *buf, int buf_size,
5269 int64_t pts, int64_t dts,
5273 * @return 0 if the output buffer is a subset of the input, 1 if it is allocated and must be freed
5274 * @deprecated use AVBitStreamFilter
5276 int av_parser_change(AVCodecParserContext *s,
5277 AVCodecContext *avctx,
5278 uint8_t **poutbuf, int *poutbuf_size,
5279 const uint8_t *buf, int buf_size, int keyframe);
5280 void av_parser_close(AVCodecParserContext *s);
5288 * @addtogroup lavc_encoding
5293 * Find a registered encoder with a matching codec ID.
5295 * @param id AVCodecID of the requested encoder
5296 * @return An encoder if one was found, NULL otherwise.
5298 AVCodec *avcodec_find_encoder(enum AVCodecID id);
5301 * Find a registered encoder with the specified name.
5303 * @param name name of the requested encoder
5304 * @return An encoder if one was found, NULL otherwise.
5306 AVCodec *avcodec_find_encoder_by_name(const char *name);
5309 * Encode a frame of audio.
5311 * Takes input samples from frame and writes the next output packet, if
5312 * available, to avpkt. The output packet does not necessarily contain data for
5313 * the most recent frame, as encoders can delay, split, and combine input frames
5314 * internally as needed.
5316 * @param avctx codec context
5317 * @param avpkt output AVPacket.
5318 * The user can supply an output buffer by setting
5319 * avpkt->data and avpkt->size prior to calling the
5320 * function, but if the size of the user-provided data is not
5321 * large enough, encoding will fail. If avpkt->data and
5322 * avpkt->size are set, avpkt->destruct must also be set. All
5323 * other AVPacket fields will be reset by the encoder using
5324 * av_init_packet(). If avpkt->data is NULL, the encoder will
5325 * allocate it. The encoder will set avpkt->size to the size
5326 * of the output packet.
5328 * If this function fails or produces no output, avpkt will be
5329 * freed using av_packet_unref().
5330 * @param[in] frame AVFrame containing the raw audio data to be encoded.
5331 * May be NULL when flushing an encoder that has the
5332 * AV_CODEC_CAP_DELAY capability set.
5333 * If AV_CODEC_CAP_VARIABLE_FRAME_SIZE is set, then each frame
5334 * can have any number of samples.
5335 * If it is not set, frame->nb_samples must be equal to
5336 * avctx->frame_size for all frames except the last.
5337 * The final frame may be smaller than avctx->frame_size.
5338 * @param[out] got_packet_ptr This field is set to 1 by libavcodec if the
5339 * output packet is non-empty, and to 0 if it is
5340 * empty. If the function returns an error, the
5341 * packet can be assumed to be invalid, and the
5342 * value of got_packet_ptr is undefined and should
5344 * @return 0 on success, negative error code on failure
5346 * @deprecated use avcodec_send_frame()/avcodec_receive_packet() instead
5348 attribute_deprecated
5349 int avcodec_encode_audio2(AVCodecContext *avctx, AVPacket *avpkt,
5350 const AVFrame *frame, int *got_packet_ptr);
5353 * Encode a frame of video.
5355 * Takes input raw video data from frame and writes the next output packet, if
5356 * available, to avpkt. The output packet does not necessarily contain data for
5357 * the most recent frame, as encoders can delay and reorder input frames
5358 * internally as needed.
5360 * @param avctx codec context
5361 * @param avpkt output AVPacket.
5362 * The user can supply an output buffer by setting
5363 * avpkt->data and avpkt->size prior to calling the
5364 * function, but if the size of the user-provided data is not
5365 * large enough, encoding will fail. All other AVPacket fields
5366 * will be reset by the encoder using av_init_packet(). If
5367 * avpkt->data is NULL, the encoder will allocate it.
5368 * The encoder will set avpkt->size to the size of the
5369 * output packet. The returned data (if any) belongs to the
5370 * caller, he is responsible for freeing it.
5372 * If this function fails or produces no output, avpkt will be
5373 * freed using av_packet_unref().
5374 * @param[in] frame AVFrame containing the raw video data to be encoded.
5375 * May be NULL when flushing an encoder that has the
5376 * AV_CODEC_CAP_DELAY capability set.
5377 * @param[out] got_packet_ptr This field is set to 1 by libavcodec if the
5378 * output packet is non-empty, and to 0 if it is
5379 * empty. If the function returns an error, the
5380 * packet can be assumed to be invalid, and the
5381 * value of got_packet_ptr is undefined and should
5383 * @return 0 on success, negative error code on failure
5385 * @deprecated use avcodec_send_frame()/avcodec_receive_packet() instead
5387 attribute_deprecated
5388 int avcodec_encode_video2(AVCodecContext *avctx, AVPacket *avpkt,
5389 const AVFrame *frame, int *got_packet_ptr);
5391 int avcodec_encode_subtitle(AVCodecContext *avctx, uint8_t *buf, int buf_size,
5392 const AVSubtitle *sub);
5399 #if FF_API_AVPICTURE
5401 * @addtogroup lavc_picture
5406 * @deprecated unused
5408 attribute_deprecated
5409 int avpicture_alloc(AVPicture *picture, enum AVPixelFormat pix_fmt, int width, int height);
5412 * @deprecated unused
5414 attribute_deprecated
5415 void avpicture_free(AVPicture *picture);
5418 * @deprecated use av_image_fill_arrays() instead.
5420 attribute_deprecated
5421 int avpicture_fill(AVPicture *picture, const uint8_t *ptr,
5422 enum AVPixelFormat pix_fmt, int width, int height);
5425 * @deprecated use av_image_copy_to_buffer() instead.
5427 attribute_deprecated
5428 int avpicture_layout(const AVPicture *src, enum AVPixelFormat pix_fmt,
5429 int width, int height,
5430 unsigned char *dest, int dest_size);
5433 * @deprecated use av_image_get_buffer_size() instead.
5435 attribute_deprecated
5436 int avpicture_get_size(enum AVPixelFormat pix_fmt, int width, int height);
5439 * @deprecated av_image_copy() instead.
5441 attribute_deprecated
5442 void av_picture_copy(AVPicture *dst, const AVPicture *src,
5443 enum AVPixelFormat pix_fmt, int width, int height);
5446 * @deprecated unused
5448 attribute_deprecated
5449 int av_picture_crop(AVPicture *dst, const AVPicture *src,
5450 enum AVPixelFormat pix_fmt, int top_band, int left_band);
5453 * @deprecated unused
5455 attribute_deprecated
5456 int av_picture_pad(AVPicture *dst, const AVPicture *src, int height, int width, enum AVPixelFormat pix_fmt,
5457 int padtop, int padbottom, int padleft, int padright, int *color);
5465 * @defgroup lavc_misc Utility functions
5468 * Miscellaneous utility functions related to both encoding and decoding
5474 * @defgroup lavc_misc_pixfmt Pixel formats
5476 * Functions for working with pixel formats.
5480 #if FF_API_GETCHROMA
5482 * @deprecated Use av_pix_fmt_get_chroma_sub_sample
5485 attribute_deprecated
5486 void avcodec_get_chroma_sub_sample(enum AVPixelFormat pix_fmt, int *h_shift, int *v_shift);
5490 * Return a value representing the fourCC code associated to the
5491 * pixel format pix_fmt, or 0 if no associated fourCC code can be
5494 unsigned int avcodec_pix_fmt_to_codec_tag(enum AVPixelFormat pix_fmt);
5497 * @deprecated see av_get_pix_fmt_loss()
5499 int avcodec_get_pix_fmt_loss(enum AVPixelFormat dst_pix_fmt, enum AVPixelFormat src_pix_fmt,
5503 * Find the best pixel format to convert to given a certain source pixel
5504 * format. When converting from one pixel format to another, information loss
5505 * may occur. For example, when converting from RGB24 to GRAY, the color
5506 * information will be lost. Similarly, other losses occur when converting from
5507 * some formats to other formats. avcodec_find_best_pix_fmt_of_2() searches which of
5508 * the given pixel formats should be used to suffer the least amount of loss.
5509 * The pixel formats from which it chooses one, are determined by the
5510 * pix_fmt_list parameter.
5513 * @param[in] pix_fmt_list AV_PIX_FMT_NONE terminated array of pixel formats to choose from
5514 * @param[in] src_pix_fmt source pixel format
5515 * @param[in] has_alpha Whether the source pixel format alpha channel is used.
5516 * @param[out] loss_ptr Combination of flags informing you what kind of losses will occur.
5517 * @return The best pixel format to convert to or -1 if none was found.
5519 enum AVPixelFormat avcodec_find_best_pix_fmt_of_list(const enum AVPixelFormat *pix_fmt_list,
5520 enum AVPixelFormat src_pix_fmt,
5521 int has_alpha, int *loss_ptr);
5524 * @deprecated see av_find_best_pix_fmt_of_2()
5526 enum AVPixelFormat avcodec_find_best_pix_fmt_of_2(enum AVPixelFormat dst_pix_fmt1, enum AVPixelFormat dst_pix_fmt2,
5527 enum AVPixelFormat src_pix_fmt, int has_alpha, int *loss_ptr);
5529 attribute_deprecated
5530 enum AVPixelFormat avcodec_find_best_pix_fmt2(enum AVPixelFormat dst_pix_fmt1, enum AVPixelFormat dst_pix_fmt2,
5531 enum AVPixelFormat src_pix_fmt, int has_alpha, int *loss_ptr);
5533 enum AVPixelFormat avcodec_default_get_format(struct AVCodecContext *s, const enum AVPixelFormat * fmt);
5539 #if FF_API_TAG_STRING
5541 * Put a string representing the codec tag codec_tag in buf.
5543 * @param buf buffer to place codec tag in
5544 * @param buf_size size in bytes of buf
5545 * @param codec_tag codec tag to assign
5546 * @return the length of the string that would have been generated if
5547 * enough space had been available, excluding the trailing null
5549 * @deprecated see av_fourcc_make_string() and av_fourcc2str().
5551 attribute_deprecated
5552 size_t av_get_codec_tag_string(char *buf, size_t buf_size, unsigned int codec_tag);
5555 void avcodec_string(char *buf, int buf_size, AVCodecContext *enc, int encode);
5558 * Return a name for the specified profile, if available.
5560 * @param codec the codec that is searched for the given profile
5561 * @param profile the profile value for which a name is requested
5562 * @return A name for the profile if found, NULL otherwise.
5564 const char *av_get_profile_name(const AVCodec *codec, int profile);
5567 * Return a name for the specified profile, if available.
5569 * @param codec_id the ID of the codec to which the requested profile belongs
5570 * @param profile the profile value for which a name is requested
5571 * @return A name for the profile if found, NULL otherwise.
5573 * @note unlike av_get_profile_name(), which searches a list of profiles
5574 * supported by a specific decoder or encoder implementation, this
5575 * function searches the list of profiles from the AVCodecDescriptor
5577 const char *avcodec_profile_name(enum AVCodecID codec_id, int profile);
5579 int avcodec_default_execute(AVCodecContext *c, int (*func)(AVCodecContext *c2, void *arg2),void *arg, int *ret, int count, int size);
5580 int avcodec_default_execute2(AVCodecContext *c, int (*func)(AVCodecContext *c2, void *arg2, int, int),void *arg, int *ret, int count);
5581 //FIXME func typedef
5584 * Fill AVFrame audio data and linesize pointers.
5586 * The buffer buf must be a preallocated buffer with a size big enough
5587 * to contain the specified samples amount. The filled AVFrame data
5588 * pointers will point to this buffer.
5590 * AVFrame extended_data channel pointers are allocated if necessary for
5593 * @param frame the AVFrame
5594 * frame->nb_samples must be set prior to calling the
5595 * function. This function fills in frame->data,
5596 * frame->extended_data, frame->linesize[0].
5597 * @param nb_channels channel count
5598 * @param sample_fmt sample format
5599 * @param buf buffer to use for frame data
5600 * @param buf_size size of buffer
5601 * @param align plane size sample alignment (0 = default)
5602 * @return >=0 on success, negative error code on failure
5603 * @todo return the size in bytes required to store the samples in
5604 * case of success, at the next libavutil bump
5606 int avcodec_fill_audio_frame(AVFrame *frame, int nb_channels,
5607 enum AVSampleFormat sample_fmt, const uint8_t *buf,
5608 int buf_size, int align);
5611 * Reset the internal decoder state / flush internal buffers. Should be called
5612 * e.g. when seeking or when switching to a different stream.
5614 * @note when refcounted frames are not used (i.e. avctx->refcounted_frames is 0),
5615 * this invalidates the frames previously returned from the decoder. When
5616 * refcounted frames are used, the decoder just releases any references it might
5617 * keep internally, but the caller's reference remains valid.
5619 void avcodec_flush_buffers(AVCodecContext *avctx);
5622 * Return codec bits per sample.
5624 * @param[in] codec_id the codec
5625 * @return Number of bits per sample or zero if unknown for the given codec.
5627 int av_get_bits_per_sample(enum AVCodecID codec_id);
5630 * Return the PCM codec associated with a sample format.
5631 * @param be endianness, 0 for little, 1 for big,
5632 * -1 (or anything else) for native
5633 * @return AV_CODEC_ID_PCM_* or AV_CODEC_ID_NONE
5635 enum AVCodecID av_get_pcm_codec(enum AVSampleFormat fmt, int be);
5638 * Return codec bits per sample.
5639 * Only return non-zero if the bits per sample is exactly correct, not an
5642 * @param[in] codec_id the codec
5643 * @return Number of bits per sample or zero if unknown for the given codec.
5645 int av_get_exact_bits_per_sample(enum AVCodecID codec_id);
5648 * Return audio frame duration.
5650 * @param avctx codec context
5651 * @param frame_bytes size of the frame, or 0 if unknown
5652 * @return frame duration, in samples, if known. 0 if not able to
5655 int av_get_audio_frame_duration(AVCodecContext *avctx, int frame_bytes);
5658 * This function is the same as av_get_audio_frame_duration(), except it works
5659 * with AVCodecParameters instead of an AVCodecContext.
5661 int av_get_audio_frame_duration2(AVCodecParameters *par, int frame_bytes);
5664 typedef struct AVBitStreamFilterContext {
5666 const struct AVBitStreamFilter *filter;
5667 AVCodecParserContext *parser;
5668 struct AVBitStreamFilterContext *next;
5670 * Internal default arguments, used if NULL is passed to av_bitstream_filter_filter().
5671 * Not for access by library users.
5674 } AVBitStreamFilterContext;
5677 typedef struct AVBSFInternal AVBSFInternal;
5680 * The bitstream filter state.
5682 * This struct must be allocated with av_bsf_alloc() and freed with
5685 * The fields in the struct will only be changed (by the caller or by the
5686 * filter) as described in their documentation, and are to be considered
5687 * immutable otherwise.
5689 typedef struct AVBSFContext {
5691 * A class for logging and AVOptions
5693 const AVClass *av_class;
5696 * The bitstream filter this context is an instance of.
5698 const struct AVBitStreamFilter *filter;
5701 * Opaque libavcodec internal data. Must not be touched by the caller in any
5704 AVBSFInternal *internal;
5707 * Opaque filter-specific private data. If filter->priv_class is non-NULL,
5708 * this is an AVOptions-enabled struct.
5713 * Parameters of the input stream. This field is allocated in
5714 * av_bsf_alloc(), it needs to be filled by the caller before
5717 AVCodecParameters *par_in;
5720 * Parameters of the output stream. This field is allocated in
5721 * av_bsf_alloc(), it is set by the filter in av_bsf_init().
5723 AVCodecParameters *par_out;
5726 * The timebase used for the timestamps of the input packets. Set by the
5727 * caller before av_bsf_init().
5729 AVRational time_base_in;
5732 * The timebase used for the timestamps of the output packets. Set by the
5733 * filter in av_bsf_init().
5735 AVRational time_base_out;
5738 typedef struct AVBitStreamFilter {
5742 * A list of codec ids supported by the filter, terminated by
5744 * May be NULL, in that case the bitstream filter works with any codec id.
5746 const enum AVCodecID *codec_ids;
5749 * A class for the private data, used to declare bitstream filter private
5750 * AVOptions. This field is NULL for bitstream filters that do not declare
5753 * If this field is non-NULL, the first member of the filter private data
5754 * must be a pointer to AVClass, which will be set by libavcodec generic
5755 * code to this class.
5757 const AVClass *priv_class;
5759 /*****************************************************************
5760 * No fields below this line are part of the public API. They
5761 * may not be used outside of libavcodec and can be changed and
5763 * New public fields should be added right above.
5764 *****************************************************************
5768 int (*init)(AVBSFContext *ctx);
5769 int (*filter)(AVBSFContext *ctx, AVPacket *pkt);
5770 void (*close)(AVBSFContext *ctx);
5771 } AVBitStreamFilter;
5775 * @deprecated the old bitstream filtering API (using AVBitStreamFilterContext)
5776 * is deprecated. Use the new bitstream filtering API (using AVBSFContext).
5778 attribute_deprecated
5779 void av_register_bitstream_filter(AVBitStreamFilter *bsf);
5781 * @deprecated the old bitstream filtering API (using AVBitStreamFilterContext)
5782 * is deprecated. Use av_bsf_get_by_name(), av_bsf_alloc(), and av_bsf_init()
5783 * from the new bitstream filtering API (using AVBSFContext).
5785 attribute_deprecated
5786 AVBitStreamFilterContext *av_bitstream_filter_init(const char *name);
5788 * @deprecated the old bitstream filtering API (using AVBitStreamFilterContext)
5789 * is deprecated. Use av_bsf_send_packet() and av_bsf_receive_packet() from the
5790 * new bitstream filtering API (using AVBSFContext).
5792 attribute_deprecated
5793 int av_bitstream_filter_filter(AVBitStreamFilterContext *bsfc,
5794 AVCodecContext *avctx, const char *args,
5795 uint8_t **poutbuf, int *poutbuf_size,
5796 const uint8_t *buf, int buf_size, int keyframe);
5798 * @deprecated the old bitstream filtering API (using AVBitStreamFilterContext)
5799 * is deprecated. Use av_bsf_free() from the new bitstream filtering API (using
5802 attribute_deprecated
5803 void av_bitstream_filter_close(AVBitStreamFilterContext *bsf);
5805 * @deprecated the old bitstream filtering API (using AVBitStreamFilterContext)
5806 * is deprecated. Use av_bsf_iterate() from the new bitstream filtering API (using
5809 attribute_deprecated
5810 const AVBitStreamFilter *av_bitstream_filter_next(const AVBitStreamFilter *f);
5814 * @return a bitstream filter with the specified name or NULL if no such
5815 * bitstream filter exists.
5817 const AVBitStreamFilter *av_bsf_get_by_name(const char *name);
5820 * Iterate over all registered bitstream filters.
5822 * @param opaque a pointer where libavcodec will store the iteration state. Must
5823 * point to NULL to start the iteration.
5825 * @return the next registered bitstream filter or NULL when the iteration is
5828 const AVBitStreamFilter *av_bsf_iterate(void **opaque);
5830 attribute_deprecated
5831 const AVBitStreamFilter *av_bsf_next(void **opaque);
5835 * Allocate a context for a given bitstream filter. The caller must fill in the
5836 * context parameters as described in the documentation and then call
5837 * av_bsf_init() before sending any data to the filter.
5839 * @param filter the filter for which to allocate an instance.
5840 * @param ctx a pointer into which the pointer to the newly-allocated context
5841 * will be written. It must be freed with av_bsf_free() after the
5842 * filtering is done.
5844 * @return 0 on success, a negative AVERROR code on failure
5846 int av_bsf_alloc(const AVBitStreamFilter *filter, AVBSFContext **ctx);
5849 * Prepare the filter for use, after all the parameters and options have been
5852 int av_bsf_init(AVBSFContext *ctx);
5855 * Submit a packet for filtering.
5857 * After sending each packet, the filter must be completely drained by calling
5858 * av_bsf_receive_packet() repeatedly until it returns AVERROR(EAGAIN) or
5861 * @param pkt the packet to filter. The bitstream filter will take ownership of
5862 * the packet and reset the contents of pkt. pkt is not touched if an error occurs.
5863 * This parameter may be NULL, which signals the end of the stream (i.e. no more
5864 * packets will be sent). That will cause the filter to output any packets it
5865 * may have buffered internally.
5867 * @return 0 on success, a negative AVERROR on error.
5869 int av_bsf_send_packet(AVBSFContext *ctx, AVPacket *pkt);
5872 * Retrieve a filtered packet.
5874 * @param[out] pkt this struct will be filled with the contents of the filtered
5875 * packet. It is owned by the caller and must be freed using
5876 * av_packet_unref() when it is no longer needed.
5877 * This parameter should be "clean" (i.e. freshly allocated
5878 * with av_packet_alloc() or unreffed with av_packet_unref())
5879 * when this function is called. If this function returns
5880 * successfully, the contents of pkt will be completely
5881 * overwritten by the returned data. On failure, pkt is not
5884 * @return 0 on success. AVERROR(EAGAIN) if more packets need to be sent to the
5885 * filter (using av_bsf_send_packet()) to get more output. AVERROR_EOF if there
5886 * will be no further output from the filter. Another negative AVERROR value if
5889 * @note one input packet may result in several output packets, so after sending
5890 * a packet with av_bsf_send_packet(), this function needs to be called
5891 * repeatedly until it stops returning 0. It is also possible for a filter to
5892 * output fewer packets than were sent to it, so this function may return
5893 * AVERROR(EAGAIN) immediately after a successful av_bsf_send_packet() call.
5895 int av_bsf_receive_packet(AVBSFContext *ctx, AVPacket *pkt);
5898 * Free a bitstream filter context and everything associated with it; write NULL
5899 * into the supplied pointer.
5901 void av_bsf_free(AVBSFContext **ctx);
5904 * Get the AVClass for AVBSFContext. It can be used in combination with
5905 * AV_OPT_SEARCH_FAKE_OBJ for examining options.
5907 * @see av_opt_find().
5909 const AVClass *av_bsf_get_class(void);
5912 * Structure for chain/list of bitstream filters.
5913 * Empty list can be allocated by av_bsf_list_alloc().
5915 typedef struct AVBSFList AVBSFList;
5918 * Allocate empty list of bitstream filters.
5919 * The list must be later freed by av_bsf_list_free()
5920 * or finalized by av_bsf_list_finalize().
5922 * @return Pointer to @ref AVBSFList on success, NULL in case of failure
5924 AVBSFList *av_bsf_list_alloc(void);
5927 * Free list of bitstream filters.
5929 * @param lst Pointer to pointer returned by av_bsf_list_alloc()
5931 void av_bsf_list_free(AVBSFList **lst);
5934 * Append bitstream filter to the list of bitstream filters.
5936 * @param lst List to append to
5937 * @param bsf Filter context to be appended
5939 * @return >=0 on success, negative AVERROR in case of failure
5941 int av_bsf_list_append(AVBSFList *lst, AVBSFContext *bsf);
5944 * Construct new bitstream filter context given it's name and options
5945 * and append it to the list of bitstream filters.
5947 * @param lst List to append to
5948 * @param bsf_name Name of the bitstream filter
5949 * @param options Options for the bitstream filter, can be set to NULL
5951 * @return >=0 on success, negative AVERROR in case of failure
5953 int av_bsf_list_append2(AVBSFList *lst, const char * bsf_name, AVDictionary **options);
5955 * Finalize list of bitstream filters.
5957 * This function will transform @ref AVBSFList to single @ref AVBSFContext,
5958 * so the whole chain of bitstream filters can be treated as single filter
5959 * freshly allocated by av_bsf_alloc().
5960 * If the call is successful, @ref AVBSFList structure is freed and lst
5961 * will be set to NULL. In case of failure, caller is responsible for
5962 * freeing the structure by av_bsf_list_free()
5964 * @param lst Filter list structure to be transformed
5965 * @param[out] bsf Pointer to be set to newly created @ref AVBSFContext structure
5966 * representing the chain of bitstream filters
5968 * @return >=0 on success, negative AVERROR in case of failure
5970 int av_bsf_list_finalize(AVBSFList **lst, AVBSFContext **bsf);
5973 * Parse string describing list of bitstream filters and create single
5974 * @ref AVBSFContext describing the whole chain of bitstream filters.
5975 * Resulting @ref AVBSFContext can be treated as any other @ref AVBSFContext freshly
5976 * allocated by av_bsf_alloc().
5978 * @param str String describing chain of bitstream filters in format
5979 * `bsf1[=opt1=val1:opt2=val2][,bsf2]`
5980 * @param[out] bsf Pointer to be set to newly created @ref AVBSFContext structure
5981 * representing the chain of bitstream filters
5983 * @return >=0 on success, negative AVERROR in case of failure
5985 int av_bsf_list_parse_str(const char *str, AVBSFContext **bsf);
5988 * Get null/pass-through bitstream filter.
5990 * @param[out] bsf Pointer to be set to new instance of pass-through bitstream filter
5994 int av_bsf_get_null_filter(AVBSFContext **bsf);
5999 * Same behaviour av_fast_malloc but the buffer has additional
6000 * AV_INPUT_BUFFER_PADDING_SIZE at the end which will always be 0.
6002 * In addition the whole buffer will initially and after resizes
6003 * be 0-initialized so that no uninitialized data will ever appear.
6005 void av_fast_padded_malloc(void *ptr, unsigned int *size, size_t min_size);
6008 * Same behaviour av_fast_padded_malloc except that buffer will always
6009 * be 0-initialized after call.
6011 void av_fast_padded_mallocz(void *ptr, unsigned int *size, size_t min_size);
6014 * Encode extradata length to a buffer. Used by xiph codecs.
6016 * @param s buffer to write to; must be at least (v/255+1) bytes long
6017 * @param v size of extradata in bytes
6018 * @return number of bytes written to the buffer.
6020 unsigned int av_xiphlacing(unsigned char *s, unsigned int v);
6022 #if FF_API_USER_VISIBLE_AVHWACCEL
6024 * Register the hardware accelerator hwaccel.
6026 * @deprecated This function doesn't do anything.
6028 attribute_deprecated
6029 void av_register_hwaccel(AVHWAccel *hwaccel);
6032 * If hwaccel is NULL, returns the first registered hardware accelerator,
6033 * if hwaccel is non-NULL, returns the next registered hardware accelerator
6034 * after hwaccel, or NULL if hwaccel is the last one.
6036 * @deprecated AVHWaccel structures contain no user-serviceable parts, so
6037 * this function should not be used.
6039 attribute_deprecated
6040 AVHWAccel *av_hwaccel_next(const AVHWAccel *hwaccel);
6045 * Lock operation used by lockmgr
6047 * @deprecated Deprecated together with av_lockmgr_register().
6050 AV_LOCK_CREATE, ///< Create a mutex
6051 AV_LOCK_OBTAIN, ///< Lock the mutex
6052 AV_LOCK_RELEASE, ///< Unlock the mutex
6053 AV_LOCK_DESTROY, ///< Free mutex resources
6057 * Register a user provided lock manager supporting the operations
6058 * specified by AVLockOp. The "mutex" argument to the function points
6059 * to a (void *) where the lockmgr should store/get a pointer to a user
6060 * allocated mutex. It is NULL upon AV_LOCK_CREATE and equal to the
6061 * value left by the last call for all other ops. If the lock manager is
6062 * unable to perform the op then it should leave the mutex in the same
6063 * state as when it was called and return a non-zero value. However,
6064 * when called with AV_LOCK_DESTROY the mutex will always be assumed to
6065 * have been successfully destroyed. If av_lockmgr_register succeeds
6066 * it will return a non-negative value, if it fails it will return a
6067 * negative value and destroy all mutex and unregister all callbacks.
6068 * av_lockmgr_register is not thread-safe, it must be called from a
6069 * single thread before any calls which make use of locking are used.
6071 * @param cb User defined callback. av_lockmgr_register invokes calls
6072 * to this callback and the previously registered callback.
6073 * The callback will be used to create more than one mutex
6074 * each of which must be backed by its own underlying locking
6075 * mechanism (i.e. do not use a single static object to
6076 * implement your lock manager). If cb is set to NULL the
6077 * lockmgr will be unregistered.
6079 * @deprecated This function does nothing, and always returns 0. Be sure to
6080 * build with thread support to get basic thread safety.
6082 attribute_deprecated
6083 int av_lockmgr_register(int (*cb)(void **mutex, enum AVLockOp op));
6087 * Get the type of the given codec.
6089 enum AVMediaType avcodec_get_type(enum AVCodecID codec_id);
6092 * Get the name of a codec.
6093 * @return a static string identifying the codec; never NULL
6095 const char *avcodec_get_name(enum AVCodecID id);
6098 * @return a positive value if s is open (i.e. avcodec_open2() was called on it
6099 * with no corresponding avcodec_close()), 0 otherwise.
6101 int avcodec_is_open(AVCodecContext *s);
6104 * @return a non-zero number if codec is an encoder, zero otherwise
6106 int av_codec_is_encoder(const AVCodec *codec);
6109 * @return a non-zero number if codec is a decoder, zero otherwise
6111 int av_codec_is_decoder(const AVCodec *codec);
6114 * @return descriptor for given codec ID or NULL if no descriptor exists.
6116 const AVCodecDescriptor *avcodec_descriptor_get(enum AVCodecID id);
6119 * Iterate over all codec descriptors known to libavcodec.
6121 * @param prev previous descriptor. NULL to get the first descriptor.
6123 * @return next descriptor or NULL after the last descriptor
6125 const AVCodecDescriptor *avcodec_descriptor_next(const AVCodecDescriptor *prev);
6128 * @return codec descriptor with the given name or NULL if no such descriptor
6131 const AVCodecDescriptor *avcodec_descriptor_get_by_name(const char *name);
6134 * Allocate a CPB properties structure and initialize its fields to default
6137 * @param size if non-NULL, the size of the allocated struct will be written
6138 * here. This is useful for embedding it in side data.
6140 * @return the newly allocated struct or NULL on failure
6142 AVCPBProperties *av_cpb_properties_alloc(size_t *size);
6148 #endif /* AVCODEC_AVCODEC_H */