2 * copyright (c) 2001 Fabrice Bellard
4 * This file is part of FFmpeg.
6 * FFmpeg is free software; you can redistribute it and/or
7 * modify it under the terms of the GNU Lesser General Public
8 * License as published by the Free Software Foundation; either
9 * version 2.1 of the License, or (at your option) any later version.
11 * FFmpeg is distributed in the hope that it will be useful,
12 * but WITHOUT ANY WARRANTY; without even the implied warranty of
13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
14 * Lesser General Public License for more details.
16 * You should have received a copy of the GNU Lesser General Public
17 * License along with FFmpeg; if not, write to the Free Software
18 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
21 #ifndef AVCODEC_AVCODEC_H
22 #define AVCODEC_AVCODEC_H
27 * Libavcodec external API header
31 #include "libavutil/samplefmt.h"
32 #include "libavutil/attributes.h"
33 #include "libavutil/avutil.h"
34 #include "libavutil/buffer.h"
35 #include "libavutil/cpu.h"
36 #include "libavutil/channel_layout.h"
37 #include "libavutil/dict.h"
38 #include "libavutil/frame.h"
39 #include "libavutil/hwcontext.h"
40 #include "libavutil/log.h"
41 #include "libavutil/pixfmt.h"
42 #include "libavutil/rational.h"
47 * @defgroup libavc libavcodec
48 * Encoding/Decoding Library
52 * @defgroup lavc_decoding Decoding
56 * @defgroup lavc_encoding Encoding
60 * @defgroup lavc_codec Codecs
62 * @defgroup lavc_codec_native Native Codecs
65 * @defgroup lavc_codec_wrappers External library wrappers
68 * @defgroup lavc_codec_hwaccel Hardware Accelerators bridge
72 * @defgroup lavc_internal Internal
80 * @defgroup lavc_encdec send/receive encoding and decoding API overview
83 * The avcodec_send_packet()/avcodec_receive_frame()/avcodec_send_frame()/
84 * avcodec_receive_packet() functions provide an encode/decode API, which
85 * decouples input and output.
87 * The API is very similar for encoding/decoding and audio/video, and works as
89 * - Set up and open the AVCodecContext as usual.
91 * - For decoding, call avcodec_send_packet() to give the decoder raw
92 * compressed data in an AVPacket.
93 * - For encoding, call avcodec_send_frame() to give the encoder an AVFrame
94 * containing uncompressed audio or video.
95 * In both cases, it is recommended that AVPackets and AVFrames are
96 * refcounted, or libavcodec might have to copy the input data. (libavformat
97 * always returns refcounted AVPackets, and av_frame_get_buffer() allocates
98 * refcounted AVFrames.)
99 * - Receive output in a loop. Periodically call one of the avcodec_receive_*()
100 * functions and process their output:
101 * - For decoding, call avcodec_receive_frame(). On success, it will return
102 * an AVFrame containing uncompressed audio or video data.
103 * - For encoding, call avcodec_receive_packet(). On success, it will return
104 * an AVPacket with a compressed frame.
105 * Repeat this call until it returns AVERROR(EAGAIN) or an error. The
106 * AVERROR(EAGAIN) return value means that new input data is required to
107 * return new output. In this case, continue with sending input. For each
108 * input frame/packet, the codec will typically return 1 output frame/packet,
109 * but it can also be 0 or more than 1.
111 * At the beginning of decoding or encoding, the codec might accept multiple
112 * input frames/packets without returning a frame, until its internal buffers
113 * are filled. This situation is handled transparently if you follow the steps
116 * In theory, sending input can result in EAGAIN - this should happen only if
117 * not all output was received. You can use this to structure alternative decode
118 * or encode loops other than the one suggested above. For example, you could
119 * try sending new input on each iteration, and try to receive output if that
122 * End of stream situations. These require "flushing" (aka draining) the codec,
123 * as the codec might buffer multiple frames or packets internally for
124 * performance or out of necessity (consider B-frames).
125 * This is handled as follows:
126 * - Instead of valid input, send NULL to the avcodec_send_packet() (decoding)
127 * or avcodec_send_frame() (encoding) functions. This will enter draining
129 * - Call avcodec_receive_frame() (decoding) or avcodec_receive_packet()
130 * (encoding) in a loop until AVERROR_EOF is returned. The functions will
131 * not return AVERROR(EAGAIN), unless you forgot to enter draining mode.
132 * - Before decoding can be resumed again, the codec has to be reset with
133 * avcodec_flush_buffers().
135 * Using the API as outlined above is highly recommended. But it is also
136 * possible to call functions outside of this rigid schema. For example, you can
137 * call avcodec_send_packet() repeatedly without calling
138 * avcodec_receive_frame(). In this case, avcodec_send_packet() will succeed
139 * until the codec's internal buffer has been filled up (which is typically of
140 * size 1 per output frame, after initial input), and then reject input with
141 * AVERROR(EAGAIN). Once it starts rejecting input, you have no choice but to
142 * read at least some output.
144 * Not all codecs will follow a rigid and predictable dataflow; the only
145 * guarantee is that an AVERROR(EAGAIN) return value on a send/receive call on
146 * one end implies that a receive/send call on the other end will succeed, or
147 * at least will not fail with AVERROR(EAGAIN). In general, no codec will
148 * permit unlimited buffering of input or output.
150 * This API replaces the following legacy functions:
151 * - avcodec_decode_video2() and avcodec_decode_audio4():
152 * Use avcodec_send_packet() to feed input to the decoder, then use
153 * avcodec_receive_frame() to receive decoded frames after each packet.
154 * Unlike with the old video decoding API, multiple frames might result from
155 * a packet. For audio, splitting the input packet into frames by partially
156 * decoding packets becomes transparent to the API user. You never need to
157 * feed an AVPacket to the API twice (unless it is rejected with AVERROR(EAGAIN) - then
158 * no data was read from the packet).
159 * Additionally, sending a flush/draining packet is required only once.
160 * - avcodec_encode_video2()/avcodec_encode_audio2():
161 * Use avcodec_send_frame() to feed input to the encoder, then use
162 * avcodec_receive_packet() to receive encoded packets.
163 * Providing user-allocated buffers for avcodec_receive_packet() is not
165 * - The new API does not handle subtitles yet.
167 * Mixing new and old function calls on the same AVCodecContext is not allowed,
168 * and will result in undefined behavior.
170 * Some codecs might require using the new API; using the old API will return
171 * an error when calling it. All codecs support the new API.
173 * A codec is not allowed to return AVERROR(EAGAIN) for both sending and receiving. This
174 * would be an invalid state, which could put the codec user into an endless
175 * loop. The API has no concept of time either: it cannot happen that trying to
176 * do avcodec_send_packet() results in AVERROR(EAGAIN), but a repeated call 1 second
177 * later accepts the packet (with no other receive/flush API calls involved).
178 * The API is a strict state machine, and the passage of time is not supposed
179 * to influence it. Some timing-dependent behavior might still be deemed
180 * acceptable in certain cases. But it must never result in both send/receive
181 * returning EAGAIN at the same time at any point. It must also absolutely be
182 * avoided that the current state is "unstable" and can "flip-flop" between
183 * the send/receive APIs allowing progress. For example, it's not allowed that
184 * the codec randomly decides that it actually wants to consume a packet now
185 * instead of returning a frame, after it just returned AVERROR(EAGAIN) on an
186 * avcodec_send_packet() call.
191 * @defgroup lavc_core Core functions/structures.
194 * Basic definitions, functions for querying libavcodec capabilities,
195 * allocating core structures, etc.
201 * Identify the syntax and semantics of the bitstream.
202 * The principle is roughly:
203 * Two decoders with the same ID can decode the same streams.
204 * Two encoders with the same ID can encode compatible streams.
205 * There may be slight deviations from the principle due to implementation
208 * If you add a codec ID to this list, add it so that
209 * 1. no value of an existing codec ID changes (that would break ABI),
210 * 2. it is as close as possible to similar codecs
212 * After adding new codec IDs, do not forget to add an entry to the codec
213 * descriptor list and bump libavcodec minor version.
219 AV_CODEC_ID_MPEG1VIDEO,
220 AV_CODEC_ID_MPEG2VIDEO, ///< preferred ID for MPEG-1/2 video decoding
231 AV_CODEC_ID_RAWVIDEO,
232 AV_CODEC_ID_MSMPEG4V1,
233 AV_CODEC_ID_MSMPEG4V2,
234 AV_CODEC_ID_MSMPEG4V3,
257 AV_CODEC_ID_INTERPLAY_VIDEO,
264 AV_CODEC_ID_MSVIDEO1,
269 AV_CODEC_ID_TRUEMOTION1,
270 AV_CODEC_ID_VMDVIDEO,
295 AV_CODEC_ID_TRUEMOTION2,
301 AV_CODEC_ID_SMACKVIDEO,
306 AV_CODEC_ID_JPEG2000,
312 AV_CODEC_ID_DSICINVIDEO,
313 AV_CODEC_ID_TIERTEXSEQVIDEO,
321 AV_CODEC_ID_BETHSOFTVID,
333 AV_CODEC_ID_ESCAPE124,
337 AV_CODEC_ID_MOTIONPIXELS,
349 AV_CODEC_ID_FLASHSV2,
350 AV_CODEC_ID_CDGRAPHICS,
353 AV_CODEC_ID_BINKVIDEO,
354 AV_CODEC_ID_IFF_ILBM,
355 #define AV_CODEC_ID_IFF_BYTERUN1 AV_CODEC_ID_IFF_ILBM
361 AV_CODEC_ID_A64_MULTI,
362 AV_CODEC_ID_A64_MULTI5,
365 AV_CODEC_ID_LAGARITH,
369 AV_CODEC_ID_WMV3IMAGE,
370 AV_CODEC_ID_VC1IMAGE,
372 AV_CODEC_ID_BMV_VIDEO,
379 AV_CODEC_ID_ZEROCODEC,
388 AV_CODEC_ID_ESCAPE130,
391 AV_CODEC_ID_HNM4_VIDEO,
393 #define AV_CODEC_ID_H265 AV_CODEC_ID_HEVC
395 AV_CODEC_ID_ALIAS_PIX,
396 AV_CODEC_ID_BRENDER_PIX,
397 AV_CODEC_ID_PAF_VIDEO,
410 AV_CODEC_ID_SCREENPRESSO,
413 AV_CODEC_ID_Y41P = 0x8000,
418 AV_CODEC_ID_TARGA_Y216,
430 AV_CODEC_ID_TRUEMOTION2RT,
432 AV_CODEC_ID_MAGICYUV,
433 AV_CODEC_ID_SHEERVIDEO,
440 AV_CODEC_ID_CLEARVIDEO,
443 AV_CODEC_ID_BITPACKED,
450 /* various PCM "codecs" */
451 AV_CODEC_ID_FIRST_AUDIO = 0x10000, ///< A dummy id pointing at the start of audio codecs
452 AV_CODEC_ID_PCM_S16LE = 0x10000,
453 AV_CODEC_ID_PCM_S16BE,
454 AV_CODEC_ID_PCM_U16LE,
455 AV_CODEC_ID_PCM_U16BE,
458 AV_CODEC_ID_PCM_MULAW,
459 AV_CODEC_ID_PCM_ALAW,
460 AV_CODEC_ID_PCM_S32LE,
461 AV_CODEC_ID_PCM_S32BE,
462 AV_CODEC_ID_PCM_U32LE,
463 AV_CODEC_ID_PCM_U32BE,
464 AV_CODEC_ID_PCM_S24LE,
465 AV_CODEC_ID_PCM_S24BE,
466 AV_CODEC_ID_PCM_U24LE,
467 AV_CODEC_ID_PCM_U24BE,
468 AV_CODEC_ID_PCM_S24DAUD,
469 AV_CODEC_ID_PCM_ZORK,
470 AV_CODEC_ID_PCM_S16LE_PLANAR,
472 AV_CODEC_ID_PCM_F32BE,
473 AV_CODEC_ID_PCM_F32LE,
474 AV_CODEC_ID_PCM_F64BE,
475 AV_CODEC_ID_PCM_F64LE,
476 AV_CODEC_ID_PCM_BLURAY,
479 AV_CODEC_ID_PCM_S8_PLANAR,
480 AV_CODEC_ID_PCM_S24LE_PLANAR,
481 AV_CODEC_ID_PCM_S32LE_PLANAR,
482 AV_CODEC_ID_PCM_S16BE_PLANAR,
484 AV_CODEC_ID_PCM_S64LE = 0x10800,
485 AV_CODEC_ID_PCM_S64BE,
486 AV_CODEC_ID_PCM_F16LE,
487 AV_CODEC_ID_PCM_F24LE,
489 /* various ADPCM codecs */
490 AV_CODEC_ID_ADPCM_IMA_QT = 0x11000,
491 AV_CODEC_ID_ADPCM_IMA_WAV,
492 AV_CODEC_ID_ADPCM_IMA_DK3,
493 AV_CODEC_ID_ADPCM_IMA_DK4,
494 AV_CODEC_ID_ADPCM_IMA_WS,
495 AV_CODEC_ID_ADPCM_IMA_SMJPEG,
496 AV_CODEC_ID_ADPCM_MS,
497 AV_CODEC_ID_ADPCM_4XM,
498 AV_CODEC_ID_ADPCM_XA,
499 AV_CODEC_ID_ADPCM_ADX,
500 AV_CODEC_ID_ADPCM_EA,
501 AV_CODEC_ID_ADPCM_G726,
502 AV_CODEC_ID_ADPCM_CT,
503 AV_CODEC_ID_ADPCM_SWF,
504 AV_CODEC_ID_ADPCM_YAMAHA,
505 AV_CODEC_ID_ADPCM_SBPRO_4,
506 AV_CODEC_ID_ADPCM_SBPRO_3,
507 AV_CODEC_ID_ADPCM_SBPRO_2,
508 AV_CODEC_ID_ADPCM_THP,
509 AV_CODEC_ID_ADPCM_IMA_AMV,
510 AV_CODEC_ID_ADPCM_EA_R1,
511 AV_CODEC_ID_ADPCM_EA_R3,
512 AV_CODEC_ID_ADPCM_EA_R2,
513 AV_CODEC_ID_ADPCM_IMA_EA_SEAD,
514 AV_CODEC_ID_ADPCM_IMA_EA_EACS,
515 AV_CODEC_ID_ADPCM_EA_XAS,
516 AV_CODEC_ID_ADPCM_EA_MAXIS_XA,
517 AV_CODEC_ID_ADPCM_IMA_ISS,
518 AV_CODEC_ID_ADPCM_G722,
519 AV_CODEC_ID_ADPCM_IMA_APC,
520 AV_CODEC_ID_ADPCM_VIMA,
522 AV_CODEC_ID_ADPCM_AFC = 0x11800,
523 AV_CODEC_ID_ADPCM_IMA_OKI,
524 AV_CODEC_ID_ADPCM_DTK,
525 AV_CODEC_ID_ADPCM_IMA_RAD,
526 AV_CODEC_ID_ADPCM_G726LE,
527 AV_CODEC_ID_ADPCM_THP_LE,
528 AV_CODEC_ID_ADPCM_PSX,
529 AV_CODEC_ID_ADPCM_AICA,
530 AV_CODEC_ID_ADPCM_IMA_DAT4,
531 AV_CODEC_ID_ADPCM_MTAF,
534 AV_CODEC_ID_AMR_NB = 0x12000,
537 /* RealAudio codecs*/
538 AV_CODEC_ID_RA_144 = 0x13000,
541 /* various DPCM codecs */
542 AV_CODEC_ID_ROQ_DPCM = 0x14000,
543 AV_CODEC_ID_INTERPLAY_DPCM,
544 AV_CODEC_ID_XAN_DPCM,
545 AV_CODEC_ID_SOL_DPCM,
547 AV_CODEC_ID_SDX2_DPCM = 0x14800,
548 AV_CODEC_ID_GREMLIN_DPCM,
551 AV_CODEC_ID_MP2 = 0x15000,
552 AV_CODEC_ID_MP3, ///< preferred ID for decoding MPEG audio layer 1, 2 or 3
562 AV_CODEC_ID_VMDAUDIO,
568 AV_CODEC_ID_WESTWOOD_SND1,
569 AV_CODEC_ID_GSM, ///< as in Berlin toast format
572 AV_CODEC_ID_TRUESPEECH,
574 AV_CODEC_ID_SMACKAUDIO,
577 AV_CODEC_ID_DSICINAUDIO,
579 AV_CODEC_ID_MUSEPACK7,
581 AV_CODEC_ID_GSM_MS, /* as found in WAV */
584 AV_CODEC_ID_NELLYMOSER,
585 AV_CODEC_ID_MUSEPACK8,
587 AV_CODEC_ID_WMAVOICE,
589 AV_CODEC_ID_WMALOSSLESS,
598 AV_CODEC_ID_BINKAUDIO_RDFT,
599 AV_CODEC_ID_BINKAUDIO_DCT,
600 AV_CODEC_ID_AAC_LATM,
605 AV_CODEC_ID_8SVX_EXP,
606 AV_CODEC_ID_8SVX_FIB,
607 AV_CODEC_ID_BMV_AUDIO,
612 AV_CODEC_ID_COMFORT_NOISE,
614 AV_CODEC_ID_METASOUND,
615 AV_CODEC_ID_PAF_AUDIO,
620 AV_CODEC_ID_FFWAVESYNTH = 0x15800,
622 AV_CODEC_ID_SONIC_LS,
625 AV_CODEC_ID_DSD_LSBF,
626 AV_CODEC_ID_DSD_MSBF,
627 AV_CODEC_ID_DSD_LSBF_PLANAR,
628 AV_CODEC_ID_DSD_MSBF_PLANAR,
630 AV_CODEC_ID_INTERPLAY_ACM,
634 AV_CODEC_ID_ATRAC3AL,
635 AV_CODEC_ID_ATRAC3PAL,
641 /* subtitle codecs */
642 AV_CODEC_ID_FIRST_SUBTITLE = 0x17000, ///< A dummy ID pointing at the start of subtitle codecs.
643 AV_CODEC_ID_DVD_SUBTITLE = 0x17000,
644 AV_CODEC_ID_DVB_SUBTITLE,
645 AV_CODEC_ID_TEXT, ///< raw UTF-8 text
648 AV_CODEC_ID_MOV_TEXT,
649 AV_CODEC_ID_HDMV_PGS_SUBTITLE,
650 AV_CODEC_ID_DVB_TELETEXT,
653 AV_CODEC_ID_MICRODVD = 0x17800,
657 AV_CODEC_ID_REALTEXT,
659 AV_CODEC_ID_SUBVIEWER1,
660 AV_CODEC_ID_SUBVIEWER,
667 AV_CODEC_ID_HDMV_TEXT_SUBTITLE,
669 /* other specific kind of codecs (generally used for attachments) */
670 AV_CODEC_ID_FIRST_UNKNOWN = 0x18000, ///< A dummy ID pointing at the start of various fake codecs.
671 AV_CODEC_ID_TTF = 0x18000,
673 AV_CODEC_ID_SCTE_35, ///< Contain timestamp estimated through PCR of program stream.
674 AV_CODEC_ID_BINTEXT = 0x18800,
678 AV_CODEC_ID_SMPTE_KLV,
680 AV_CODEC_ID_TIMED_ID3,
681 AV_CODEC_ID_BIN_DATA,
684 AV_CODEC_ID_PROBE = 0x19000, ///< codec_id is not known (like AV_CODEC_ID_NONE) but lavf should attempt to identify it
686 AV_CODEC_ID_MPEG2TS = 0x20000, /**< _FAKE_ codec to indicate a raw MPEG-2 TS
687 * stream (only used by libavformat) */
688 AV_CODEC_ID_MPEG4SYSTEMS = 0x20001, /**< _FAKE_ codec to indicate a MPEG-4 Systems
689 * stream (only used by libavformat) */
690 AV_CODEC_ID_FFMETADATA = 0x21000, ///< Dummy codec for streams containing only metadata information.
691 AV_CODEC_ID_WRAPPED_AVFRAME = 0x21001, ///< Passthrough codec, AVFrames wrapped in AVPacket
695 * This struct describes the properties of a single codec described by an
697 * @see avcodec_descriptor_get()
699 typedef struct AVCodecDescriptor {
701 enum AVMediaType type;
703 * Name of the codec described by this descriptor. It is non-empty and
704 * unique for each codec descriptor. It should contain alphanumeric
705 * characters and '_' only.
709 * A more descriptive name for this codec. May be NULL.
711 const char *long_name;
713 * Codec properties, a combination of AV_CODEC_PROP_* flags.
717 * MIME type(s) associated with the codec.
718 * May be NULL; if not, a NULL-terminated array of MIME types.
719 * The first item is always non-NULL and is the preferred MIME type.
721 const char *const *mime_types;
723 * If non-NULL, an array of profiles recognized for this codec.
724 * Terminated with FF_PROFILE_UNKNOWN.
726 const struct AVProfile *profiles;
730 * Codec uses only intra compression.
731 * Video and audio codecs only.
733 #define AV_CODEC_PROP_INTRA_ONLY (1 << 0)
735 * Codec supports lossy compression. Audio and video codecs only.
736 * @note a codec may support both lossy and lossless
739 #define AV_CODEC_PROP_LOSSY (1 << 1)
741 * Codec supports lossless compression. Audio and video codecs only.
743 #define AV_CODEC_PROP_LOSSLESS (1 << 2)
745 * Codec supports frame reordering. That is, the coded order (the order in which
746 * the encoded packets are output by the encoders / stored / input to the
747 * decoders) may be different from the presentation order of the corresponding
750 * For codecs that do not have this property set, PTS and DTS should always be
753 #define AV_CODEC_PROP_REORDER (1 << 3)
755 * Subtitle codec is bitmap based
756 * Decoded AVSubtitle data can be read from the AVSubtitleRect->pict field.
758 #define AV_CODEC_PROP_BITMAP_SUB (1 << 16)
760 * Subtitle codec is text based.
761 * Decoded AVSubtitle data can be read from the AVSubtitleRect->ass field.
763 #define AV_CODEC_PROP_TEXT_SUB (1 << 17)
766 * @ingroup lavc_decoding
767 * Required number of additionally allocated bytes at the end of the input bitstream for decoding.
768 * This is mainly needed because some optimized bitstream readers read
769 * 32 or 64 bit at once and could read over the end.<br>
770 * Note: If the first 23 bits of the additional bytes are not 0, then damaged
771 * MPEG bitstreams could cause overread and segfault.
773 #define AV_INPUT_BUFFER_PADDING_SIZE 64
776 * @ingroup lavc_encoding
777 * minimum encoding buffer size
778 * Used to avoid some checks during header writing.
780 #define AV_INPUT_BUFFER_MIN_SIZE 16384
783 * @ingroup lavc_decoding
786 /* We leave some space between them for extensions (drop some
787 * keyframes for intra-only or drop just some bidir frames). */
788 AVDISCARD_NONE =-16, ///< discard nothing
789 AVDISCARD_DEFAULT = 0, ///< discard useless packets like 0 size packets in avi
790 AVDISCARD_NONREF = 8, ///< discard all non reference
791 AVDISCARD_BIDIR = 16, ///< discard all bidirectional frames
792 AVDISCARD_NONINTRA= 24, ///< discard all non intra frames
793 AVDISCARD_NONKEY = 32, ///< discard all frames except keyframes
794 AVDISCARD_ALL = 48, ///< discard all
797 enum AVAudioServiceType {
798 AV_AUDIO_SERVICE_TYPE_MAIN = 0,
799 AV_AUDIO_SERVICE_TYPE_EFFECTS = 1,
800 AV_AUDIO_SERVICE_TYPE_VISUALLY_IMPAIRED = 2,
801 AV_AUDIO_SERVICE_TYPE_HEARING_IMPAIRED = 3,
802 AV_AUDIO_SERVICE_TYPE_DIALOGUE = 4,
803 AV_AUDIO_SERVICE_TYPE_COMMENTARY = 5,
804 AV_AUDIO_SERVICE_TYPE_EMERGENCY = 6,
805 AV_AUDIO_SERVICE_TYPE_VOICE_OVER = 7,
806 AV_AUDIO_SERVICE_TYPE_KARAOKE = 8,
807 AV_AUDIO_SERVICE_TYPE_NB , ///< Not part of ABI
811 * @ingroup lavc_encoding
813 typedef struct RcOverride{
816 int qscale; // If this is 0 then quality_factor will be used instead.
817 float quality_factor;
821 These flags can be passed in AVCodecContext.flags before initialization.
822 Note: Not everything is supported yet.
826 * Allow decoders to produce frames with data planes that are not aligned
827 * to CPU requirements (e.g. due to cropping).
829 #define AV_CODEC_FLAG_UNALIGNED (1 << 0)
833 #define AV_CODEC_FLAG_QSCALE (1 << 1)
835 * 4 MV per MB allowed / advanced prediction for H.263.
837 #define AV_CODEC_FLAG_4MV (1 << 2)
839 * Output even those frames that might be corrupted.
841 #define AV_CODEC_FLAG_OUTPUT_CORRUPT (1 << 3)
845 #define AV_CODEC_FLAG_QPEL (1 << 4)
847 * Use internal 2pass ratecontrol in first pass mode.
849 #define AV_CODEC_FLAG_PASS1 (1 << 9)
851 * Use internal 2pass ratecontrol in second pass mode.
853 #define AV_CODEC_FLAG_PASS2 (1 << 10)
857 #define AV_CODEC_FLAG_LOOP_FILTER (1 << 11)
859 * Only decode/encode grayscale.
861 #define AV_CODEC_FLAG_GRAY (1 << 13)
863 * error[?] variables will be set during encoding.
865 #define AV_CODEC_FLAG_PSNR (1 << 15)
867 * Input bitstream might be truncated at a random location
868 * instead of only at frame boundaries.
870 #define AV_CODEC_FLAG_TRUNCATED (1 << 16)
872 * Use interlaced DCT.
874 #define AV_CODEC_FLAG_INTERLACED_DCT (1 << 18)
878 #define AV_CODEC_FLAG_LOW_DELAY (1 << 19)
880 * Place global headers in extradata instead of every keyframe.
882 #define AV_CODEC_FLAG_GLOBAL_HEADER (1 << 22)
884 * Use only bitexact stuff (except (I)DCT).
886 #define AV_CODEC_FLAG_BITEXACT (1 << 23)
887 /* Fx : Flag for H.263+ extra options */
889 * H.263 advanced intra coding / MPEG-4 AC prediction
891 #define AV_CODEC_FLAG_AC_PRED (1 << 24)
893 * interlaced motion estimation
895 #define AV_CODEC_FLAG_INTERLACED_ME (1 << 29)
896 #define AV_CODEC_FLAG_CLOSED_GOP (1U << 31)
899 * Allow non spec compliant speedup tricks.
901 #define AV_CODEC_FLAG2_FAST (1 << 0)
903 * Skip bitstream encoding.
905 #define AV_CODEC_FLAG2_NO_OUTPUT (1 << 2)
907 * Place global headers at every keyframe instead of in extradata.
909 #define AV_CODEC_FLAG2_LOCAL_HEADER (1 << 3)
912 * timecode is in drop frame format. DEPRECATED!!!!
914 #define AV_CODEC_FLAG2_DROP_FRAME_TIMECODE (1 << 13)
917 * Input bitstream might be truncated at a packet boundaries
918 * instead of only at frame boundaries.
920 #define AV_CODEC_FLAG2_CHUNKS (1 << 15)
922 * Discard cropping information from SPS.
924 #define AV_CODEC_FLAG2_IGNORE_CROP (1 << 16)
927 * Show all frames before the first keyframe
929 #define AV_CODEC_FLAG2_SHOW_ALL (1 << 22)
931 * Export motion vectors through frame side data
933 #define AV_CODEC_FLAG2_EXPORT_MVS (1 << 28)
935 * Do not skip samples and export skip information as frame side data
937 #define AV_CODEC_FLAG2_SKIP_MANUAL (1 << 29)
939 * Do not reset ASS ReadOrder field on flush (subtitles decoding)
941 #define AV_CODEC_FLAG2_RO_FLUSH_NOOP (1 << 30)
943 /* Unsupported options :
944 * Syntax Arithmetic coding (SAC)
945 * Reference Picture Selection
946 * Independent Segment Decoding */
948 /* codec capabilities */
951 * Decoder can use draw_horiz_band callback.
953 #define AV_CODEC_CAP_DRAW_HORIZ_BAND (1 << 0)
955 * Codec uses get_buffer() for allocating buffers and supports custom allocators.
956 * If not set, it might not use get_buffer() at all or use operations that
957 * assume the buffer was allocated by avcodec_default_get_buffer.
959 #define AV_CODEC_CAP_DR1 (1 << 1)
960 #define AV_CODEC_CAP_TRUNCATED (1 << 3)
962 * Encoder or decoder requires flushing with NULL input at the end in order to
963 * give the complete and correct output.
965 * NOTE: If this flag is not set, the codec is guaranteed to never be fed with
966 * with NULL data. The user can still send NULL data to the public encode
967 * or decode function, but libavcodec will not pass it along to the codec
968 * unless this flag is set.
971 * The decoder has a non-zero delay and needs to be fed with avpkt->data=NULL,
972 * avpkt->size=0 at the end to get the delayed data until the decoder no longer
976 * The encoder needs to be fed with NULL data at the end of encoding until the
977 * encoder no longer returns data.
979 * NOTE: For encoders implementing the AVCodec.encode2() function, setting this
980 * flag also means that the encoder must set the pts and duration for
981 * each output packet. If this flag is not set, the pts and duration will
982 * be determined by libavcodec from the input frame.
984 #define AV_CODEC_CAP_DELAY (1 << 5)
986 * Codec can be fed a final frame with a smaller size.
987 * This can be used to prevent truncation of the last audio samples.
989 #define AV_CODEC_CAP_SMALL_LAST_FRAME (1 << 6)
992 * Codec can output multiple frames per AVPacket
993 * Normally demuxers return one frame at a time, demuxers which do not do
994 * are connected to a parser to split what they return into proper frames.
995 * This flag is reserved to the very rare category of codecs which have a
996 * bitstream that cannot be split into frames without timeconsuming
997 * operations like full decoding. Demuxers carrying such bitstreams thus
998 * may return multiple frames in a packet. This has many disadvantages like
999 * prohibiting stream copy in many cases thus it should only be considered
1002 #define AV_CODEC_CAP_SUBFRAMES (1 << 8)
1004 * Codec is experimental and is thus avoided in favor of non experimental
1007 #define AV_CODEC_CAP_EXPERIMENTAL (1 << 9)
1009 * Codec should fill in channel configuration and samplerate instead of container
1011 #define AV_CODEC_CAP_CHANNEL_CONF (1 << 10)
1013 * Codec supports frame-level multithreading.
1015 #define AV_CODEC_CAP_FRAME_THREADS (1 << 12)
1017 * Codec supports slice-based (or partition-based) multithreading.
1019 #define AV_CODEC_CAP_SLICE_THREADS (1 << 13)
1021 * Codec supports changed parameters at any point.
1023 #define AV_CODEC_CAP_PARAM_CHANGE (1 << 14)
1025 * Codec supports avctx->thread_count == 0 (auto).
1027 #define AV_CODEC_CAP_AUTO_THREADS (1 << 15)
1029 * Audio encoder supports receiving a different number of samples in each call.
1031 #define AV_CODEC_CAP_VARIABLE_FRAME_SIZE (1 << 16)
1033 * Decoder is not a preferred choice for probing.
1034 * This indicates that the decoder is not a good choice for probing.
1035 * It could for example be an expensive to spin up hardware decoder,
1036 * or it could simply not provide a lot of useful information about
1038 * A decoder marked with this flag should only be used as last resort
1039 * choice for probing.
1041 #define AV_CODEC_CAP_AVOID_PROBING (1 << 17)
1043 * Codec is intra only.
1045 #define AV_CODEC_CAP_INTRA_ONLY 0x40000000
1047 * Codec is lossless.
1049 #define AV_CODEC_CAP_LOSSLESS 0x80000000
1052 * Codec is backed by a hardware implementation. Typically used to
1053 * identify a non-hwaccel hardware decoder. For information about hwaccels, use
1054 * avcodec_get_hw_config() instead.
1056 #define AV_CODEC_CAP_HARDWARE (1 << 18)
1059 * Codec is potentially backed by a hardware implementation, but not
1060 * necessarily. This is used instead of AV_CODEC_CAP_HARDWARE, if the
1061 * implementation provides some sort of internal fallback.
1063 #define AV_CODEC_CAP_HYBRID (1 << 19)
1067 * This specifies the area which should be displayed.
1068 * Note there may be multiple such areas for one frame.
1070 typedef struct AVPanScan {
1073 * - encoding: Set by user.
1074 * - decoding: Set by libavcodec.
1079 * width and height in 1/16 pel
1080 * - encoding: Set by user.
1081 * - decoding: Set by libavcodec.
1087 * position of the top left corner in 1/16 pel for up to 3 fields/frames
1088 * - encoding: Set by user.
1089 * - decoding: Set by libavcodec.
1091 int16_t position[3][2];
1095 * This structure describes the bitrate properties of an encoded bitstream. It
1096 * roughly corresponds to a subset the VBV parameters for MPEG-2 or HRD
1097 * parameters for H.264/HEVC.
1099 typedef struct AVCPBProperties {
1101 * Maximum bitrate of the stream, in bits per second.
1102 * Zero if unknown or unspecified.
1106 * Minimum bitrate of the stream, in bits per second.
1107 * Zero if unknown or unspecified.
1111 * Average bitrate of the stream, in bits per second.
1112 * Zero if unknown or unspecified.
1117 * The size of the buffer to which the ratecontrol is applied, in bits.
1118 * Zero if unknown or unspecified.
1123 * The delay between the time the packet this structure is associated with
1124 * is received and the time when it should be decoded, in periods of a 27MHz
1127 * UINT64_MAX when unknown or unspecified.
1133 * The decoder will keep a reference to the frame and may reuse it later.
1135 #define AV_GET_BUFFER_FLAG_REF (1 << 0)
1138 * @defgroup lavc_packet AVPacket
1140 * Types and functions for working with AVPacket.
1143 enum AVPacketSideDataType {
1145 * An AV_PKT_DATA_PALETTE side data packet contains exactly AVPALETTE_SIZE
1146 * bytes worth of palette. This side data signals that a new palette is
1149 AV_PKT_DATA_PALETTE,
1152 * The AV_PKT_DATA_NEW_EXTRADATA is used to notify the codec or the format
1153 * that the extradata buffer was changed and the receiving side should
1154 * act upon it appropriately. The new extradata is embedded in the side
1155 * data buffer and should be immediately used for processing the current
1158 AV_PKT_DATA_NEW_EXTRADATA,
1161 * An AV_PKT_DATA_PARAM_CHANGE side data packet is laid out as follows:
1164 * if (param_flags & AV_SIDE_DATA_PARAM_CHANGE_CHANNEL_COUNT)
1165 * s32le channel_count
1166 * if (param_flags & AV_SIDE_DATA_PARAM_CHANGE_CHANNEL_LAYOUT)
1167 * u64le channel_layout
1168 * if (param_flags & AV_SIDE_DATA_PARAM_CHANGE_SAMPLE_RATE)
1170 * if (param_flags & AV_SIDE_DATA_PARAM_CHANGE_DIMENSIONS)
1175 AV_PKT_DATA_PARAM_CHANGE,
1178 * An AV_PKT_DATA_H263_MB_INFO side data packet contains a number of
1179 * structures with info about macroblocks relevant to splitting the
1180 * packet into smaller packets on macroblock edges (e.g. as for RFC 2190).
1181 * That is, it does not necessarily contain info about all macroblocks,
1182 * as long as the distance between macroblocks in the info is smaller
1183 * than the target payload size.
1184 * Each MB info structure is 12 bytes, and is laid out as follows:
1186 * u32le bit offset from the start of the packet
1187 * u8 current quantizer at the start of the macroblock
1189 * u16le macroblock address within the GOB
1190 * u8 horizontal MV predictor
1191 * u8 vertical MV predictor
1192 * u8 horizontal MV predictor for block number 3
1193 * u8 vertical MV predictor for block number 3
1196 AV_PKT_DATA_H263_MB_INFO,
1199 * This side data should be associated with an audio stream and contains
1200 * ReplayGain information in form of the AVReplayGain struct.
1202 AV_PKT_DATA_REPLAYGAIN,
1205 * This side data contains a 3x3 transformation matrix describing an affine
1206 * transformation that needs to be applied to the decoded video frames for
1207 * correct presentation.
1209 * See libavutil/display.h for a detailed description of the data.
1211 AV_PKT_DATA_DISPLAYMATRIX,
1214 * This side data should be associated with a video stream and contains
1215 * Stereoscopic 3D information in form of the AVStereo3D struct.
1217 AV_PKT_DATA_STEREO3D,
1220 * This side data should be associated with an audio stream and corresponds
1221 * to enum AVAudioServiceType.
1223 AV_PKT_DATA_AUDIO_SERVICE_TYPE,
1226 * This side data contains quality related information from the encoder.
1228 * u32le quality factor of the compressed frame. Allowed range is between 1 (good) and FF_LAMBDA_MAX (bad).
1232 * u64le[error count] sum of squared differences between encoder in and output
1235 AV_PKT_DATA_QUALITY_STATS,
1238 * This side data contains an integer value representing the stream index
1239 * of a "fallback" track. A fallback track indicates an alternate
1240 * track to use when the current track can not be decoded for some reason.
1241 * e.g. no decoder available for codec.
1243 AV_PKT_DATA_FALLBACK_TRACK,
1246 * This side data corresponds to the AVCPBProperties struct.
1248 AV_PKT_DATA_CPB_PROPERTIES,
1251 * Recommmends skipping the specified number of samples
1253 * u32le number of samples to skip from start of this packet
1254 * u32le number of samples to skip from end of this packet
1255 * u8 reason for start skip
1256 * u8 reason for end skip (0=padding silence, 1=convergence)
1259 AV_PKT_DATA_SKIP_SAMPLES,
1262 * An AV_PKT_DATA_JP_DUALMONO side data packet indicates that
1263 * the packet may contain "dual mono" audio specific to Japanese DTV
1264 * and if it is true, recommends only the selected channel to be used.
1266 * u8 selected channels (0=mail/left, 1=sub/right, 2=both)
1269 AV_PKT_DATA_JP_DUALMONO,
1272 * A list of zero terminated key/value strings. There is no end marker for
1273 * the list, so it is required to rely on the side data size to stop.
1275 AV_PKT_DATA_STRINGS_METADATA,
1278 * Subtitle event position
1286 AV_PKT_DATA_SUBTITLE_POSITION,
1289 * Data found in BlockAdditional element of matroska container. There is
1290 * no end marker for the data, so it is required to rely on the side data
1291 * size to recognize the end. 8 byte id (as found in BlockAddId) followed
1294 AV_PKT_DATA_MATROSKA_BLOCKADDITIONAL,
1297 * The optional first identifier line of a WebVTT cue.
1299 AV_PKT_DATA_WEBVTT_IDENTIFIER,
1302 * The optional settings (rendering instructions) that immediately
1303 * follow the timestamp specifier of a WebVTT cue.
1305 AV_PKT_DATA_WEBVTT_SETTINGS,
1308 * A list of zero terminated key/value strings. There is no end marker for
1309 * the list, so it is required to rely on the side data size to stop. This
1310 * side data includes updated metadata which appeared in the stream.
1312 AV_PKT_DATA_METADATA_UPDATE,
1315 * MPEGTS stream ID, this is required to pass the stream ID
1316 * information from the demuxer to the corresponding muxer.
1318 AV_PKT_DATA_MPEGTS_STREAM_ID,
1321 * Mastering display metadata (based on SMPTE-2086:2014). This metadata
1322 * should be associated with a video stream and contains data in the form
1323 * of the AVMasteringDisplayMetadata struct.
1325 AV_PKT_DATA_MASTERING_DISPLAY_METADATA,
1328 * This side data should be associated with a video stream and corresponds
1329 * to the AVSphericalMapping structure.
1331 AV_PKT_DATA_SPHERICAL,
1334 * Content light level (based on CTA-861.3). This metadata should be
1335 * associated with a video stream and contains data in the form of the
1336 * AVContentLightMetadata struct.
1338 AV_PKT_DATA_CONTENT_LIGHT_LEVEL,
1341 * ATSC A53 Part 4 Closed Captions. This metadata should be associated with
1342 * a video stream. A53 CC bitstream is stored as uint8_t in AVPacketSideData.data.
1343 * The number of bytes of CC data is AVPacketSideData.size.
1348 * The number of side data types.
1349 * This is not part of the public API/ABI in the sense that it may
1350 * change when new side data types are added.
1351 * This must stay the last enum value.
1352 * If its value becomes huge, some code using it
1353 * needs to be updated as it assumes it to be smaller than other limits.
1358 #define AV_PKT_DATA_QUALITY_FACTOR AV_PKT_DATA_QUALITY_STATS //DEPRECATED
1360 typedef struct AVPacketSideData {
1363 enum AVPacketSideDataType type;
1367 * This structure stores compressed data. It is typically exported by demuxers
1368 * and then passed as input to decoders, or received as output from encoders and
1369 * then passed to muxers.
1371 * For video, it should typically contain one compressed frame. For audio it may
1372 * contain several compressed frames. Encoders are allowed to output empty
1373 * packets, with no compressed data, containing only side data
1374 * (e.g. to update some stream parameters at the end of encoding).
1376 * AVPacket is one of the few structs in FFmpeg, whose size is a part of public
1377 * ABI. Thus it may be allocated on stack and no new fields can be added to it
1378 * without libavcodec and libavformat major bump.
1380 * The semantics of data ownership depends on the buf field.
1381 * If it is set, the packet data is dynamically allocated and is
1382 * valid indefinitely until a call to av_packet_unref() reduces the
1383 * reference count to 0.
1385 * If the buf field is not set av_packet_ref() would make a copy instead
1386 * of increasing the reference count.
1388 * The side data is always allocated with av_malloc(), copied by
1389 * av_packet_ref() and freed by av_packet_unref().
1391 * @see av_packet_ref
1392 * @see av_packet_unref
1394 typedef struct AVPacket {
1396 * A reference to the reference-counted buffer where the packet data is
1398 * May be NULL, then the packet data is not reference-counted.
1402 * Presentation timestamp in AVStream->time_base units; the time at which
1403 * the decompressed packet will be presented to the user.
1404 * Can be AV_NOPTS_VALUE if it is not stored in the file.
1405 * pts MUST be larger or equal to dts as presentation cannot happen before
1406 * decompression, unless one wants to view hex dumps. Some formats misuse
1407 * the terms dts and pts/cts to mean something different. Such timestamps
1408 * must be converted to true pts/dts before they are stored in AVPacket.
1412 * Decompression timestamp in AVStream->time_base units; the time at which
1413 * the packet is decompressed.
1414 * Can be AV_NOPTS_VALUE if it is not stored in the file.
1421 * A combination of AV_PKT_FLAG values
1425 * Additional packet data that can be provided by the container.
1426 * Packet can contain several types of side information.
1428 AVPacketSideData *side_data;
1429 int side_data_elems;
1432 * Duration of this packet in AVStream->time_base units, 0 if unknown.
1433 * Equals next_pts - this_pts in presentation order.
1437 int64_t pos; ///< byte position in stream, -1 if unknown
1439 #if FF_API_CONVERGENCE_DURATION
1441 * @deprecated Same as the duration field, but as int64_t. This was required
1442 * for Matroska subtitles, whose duration values could overflow when the
1443 * duration field was still an int.
1445 attribute_deprecated
1446 int64_t convergence_duration;
1449 #define AV_PKT_FLAG_KEY 0x0001 ///< The packet contains a keyframe
1450 #define AV_PKT_FLAG_CORRUPT 0x0002 ///< The packet content is corrupted
1452 * Flag is used to discard packets which are required to maintain valid
1453 * decoder state but are not required for output and should be dropped
1456 #define AV_PKT_FLAG_DISCARD 0x0004
1458 * The packet comes from a trusted source.
1460 * Otherwise-unsafe constructs such as arbitrary pointers to data
1461 * outside the packet may be followed.
1463 #define AV_PKT_FLAG_TRUSTED 0x0008
1465 * Flag is used to indicate packets that contain frames that can
1466 * be discarded by the decoder. I.e. Non-reference frames.
1468 #define AV_PKT_FLAG_DISPOSABLE 0x0010
1471 enum AVSideDataParamChangeFlags {
1472 AV_SIDE_DATA_PARAM_CHANGE_CHANNEL_COUNT = 0x0001,
1473 AV_SIDE_DATA_PARAM_CHANGE_CHANNEL_LAYOUT = 0x0002,
1474 AV_SIDE_DATA_PARAM_CHANGE_SAMPLE_RATE = 0x0004,
1475 AV_SIDE_DATA_PARAM_CHANGE_DIMENSIONS = 0x0008,
1481 struct AVCodecInternal;
1485 AV_FIELD_PROGRESSIVE,
1486 AV_FIELD_TT, //< Top coded_first, top displayed first
1487 AV_FIELD_BB, //< Bottom coded first, bottom displayed first
1488 AV_FIELD_TB, //< Top coded first, bottom displayed first
1489 AV_FIELD_BT, //< Bottom coded first, top displayed first
1493 * main external API structure.
1494 * New fields can be added to the end with minor version bumps.
1495 * Removal, reordering and changes to existing fields require a major
1497 * You can use AVOptions (av_opt* / av_set/get*()) to access these fields from user
1499 * The name string for AVOptions options matches the associated command line
1500 * parameter name and can be found in libavcodec/options_table.h
1501 * The AVOption/command line parameter names differ in some cases from the C
1502 * structure field names for historic reasons or brevity.
1503 * sizeof(AVCodecContext) must not be used outside libav*.
1505 typedef struct AVCodecContext {
1507 * information on struct for av_log
1508 * - set by avcodec_alloc_context3
1510 const AVClass *av_class;
1511 int log_level_offset;
1513 enum AVMediaType codec_type; /* see AVMEDIA_TYPE_xxx */
1514 const struct AVCodec *codec;
1515 enum AVCodecID codec_id; /* see AV_CODEC_ID_xxx */
1518 * fourcc (LSB first, so "ABCD" -> ('D'<<24) + ('C'<<16) + ('B'<<8) + 'A').
1519 * This is used to work around some encoder bugs.
1520 * A demuxer should set this to what is stored in the field used to identify the codec.
1521 * If there are multiple such fields in a container then the demuxer should choose the one
1522 * which maximizes the information about the used codec.
1523 * If the codec tag field in a container is larger than 32 bits then the demuxer should
1524 * remap the longer ID to 32 bits with a table or other structure. Alternatively a new
1525 * extra_codec_tag + size could be added but for this a clear advantage must be demonstrated
1527 * - encoding: Set by user, if not then the default based on codec_id will be used.
1528 * - decoding: Set by user, will be converted to uppercase by libavcodec during init.
1530 unsigned int codec_tag;
1535 * Private context used for internal data.
1537 * Unlike priv_data, this is not codec-specific. It is used in general
1538 * libavcodec functions.
1540 struct AVCodecInternal *internal;
1543 * Private data of the user, can be used to carry app specific stuff.
1544 * - encoding: Set by user.
1545 * - decoding: Set by user.
1550 * the average bitrate
1551 * - encoding: Set by user; unused for constant quantizer encoding.
1552 * - decoding: Set by user, may be overwritten by libavcodec
1553 * if this info is available in the stream
1558 * number of bits the bitstream is allowed to diverge from the reference.
1559 * the reference can be CBR (for CBR pass1) or VBR (for pass2)
1560 * - encoding: Set by user; unused for constant quantizer encoding.
1561 * - decoding: unused
1563 int bit_rate_tolerance;
1566 * Global quality for codecs which cannot change it per frame.
1567 * This should be proportional to MPEG-1/2/4 qscale.
1568 * - encoding: Set by user.
1569 * - decoding: unused
1574 * - encoding: Set by user.
1575 * - decoding: unused
1577 int compression_level;
1578 #define FF_COMPRESSION_DEFAULT -1
1582 * - encoding: Set by user.
1583 * - decoding: Set by user.
1589 * - encoding: Set by user.
1590 * - decoding: Set by user.
1595 * some codecs need / can use extradata like Huffman tables.
1596 * MJPEG: Huffman tables
1597 * rv10: additional flags
1598 * MPEG-4: global headers (they can be in the bitstream or here)
1599 * The allocated memory should be AV_INPUT_BUFFER_PADDING_SIZE bytes larger
1600 * than extradata_size to avoid problems if it is read with the bitstream reader.
1601 * The bytewise contents of extradata must not depend on the architecture or CPU endianness.
1602 * - encoding: Set/allocated/freed by libavcodec.
1603 * - decoding: Set/allocated/freed by user.
1609 * This is the fundamental unit of time (in seconds) in terms
1610 * of which frame timestamps are represented. For fixed-fps content,
1611 * timebase should be 1/framerate and timestamp increments should be
1613 * This often, but not always is the inverse of the frame rate or field rate
1614 * for video. 1/time_base is not the average frame rate if the frame rate is not
1617 * Like containers, elementary streams also can store timestamps, 1/time_base
1618 * is the unit in which these timestamps are specified.
1619 * As example of such codec time base see ISO/IEC 14496-2:2001(E)
1620 * vop_time_increment_resolution and fixed_vop_rate
1621 * (fixed_vop_rate == 0 implies that it is different from the framerate)
1623 * - encoding: MUST be set by user.
1624 * - decoding: the use of this field for decoding is deprecated.
1625 * Use framerate instead.
1627 AVRational time_base;
1630 * For some codecs, the time base is closer to the field rate than the frame rate.
1631 * Most notably, H.264 and MPEG-2 specify time_base as half of frame duration
1632 * if no telecine is used ...
1634 * Set to time_base ticks per frame. Default 1, e.g., H.264/MPEG-2 set it to 2.
1636 int ticks_per_frame;
1641 * Encoding: Number of frames delay there will be from the encoder input to
1642 * the decoder output. (we assume the decoder matches the spec)
1643 * Decoding: Number of frames delay in addition to what a standard decoder
1644 * as specified in the spec would produce.
1647 * Number of frames the decoded output will be delayed relative to the
1651 * For encoding, this field is unused (see initial_padding).
1653 * For decoding, this is the number of samples the decoder needs to
1654 * output before the decoder's output is valid. When seeking, you should
1655 * start decoding this many samples prior to your desired seek point.
1657 * - encoding: Set by libavcodec.
1658 * - decoding: Set by libavcodec.
1665 * picture width / height.
1667 * @note Those fields may not match the values of the last
1668 * AVFrame output by avcodec_decode_video2 due frame
1671 * - encoding: MUST be set by user.
1672 * - decoding: May be set by the user before opening the decoder if known e.g.
1673 * from the container. Some decoders will require the dimensions
1674 * to be set by the caller. During decoding, the decoder may
1675 * overwrite those values as required while parsing the data.
1680 * Bitstream width / height, may be different from width/height e.g. when
1681 * the decoded frame is cropped before being output or lowres is enabled.
1683 * @note Those field may not match the value of the last
1684 * AVFrame output by avcodec_receive_frame() due frame
1687 * - encoding: unused
1688 * - decoding: May be set by the user before opening the decoder if known
1689 * e.g. from the container. During decoding, the decoder may
1690 * overwrite those values as required while parsing the data.
1692 int coded_width, coded_height;
1695 * the number of pictures in a group of pictures, or 0 for intra_only
1696 * - encoding: Set by user.
1697 * - decoding: unused
1702 * Pixel format, see AV_PIX_FMT_xxx.
1703 * May be set by the demuxer if known from headers.
1704 * May be overridden by the decoder if it knows better.
1706 * @note This field may not match the value of the last
1707 * AVFrame output by avcodec_receive_frame() due frame
1710 * - encoding: Set by user.
1711 * - decoding: Set by user if known, overridden by libavcodec while
1714 enum AVPixelFormat pix_fmt;
1717 * If non NULL, 'draw_horiz_band' is called by the libavcodec
1718 * decoder to draw a horizontal band. It improves cache usage. Not
1719 * all codecs can do that. You must check the codec capabilities
1721 * When multithreading is used, it may be called from multiple threads
1722 * at the same time; threads might draw different parts of the same AVFrame,
1723 * or multiple AVFrames, and there is no guarantee that slices will be drawn
1725 * The function is also used by hardware acceleration APIs.
1726 * It is called at least once during frame decoding to pass
1727 * the data needed for hardware render.
1728 * In that mode instead of pixel data, AVFrame points to
1729 * a structure specific to the acceleration API. The application
1730 * reads the structure and can change some fields to indicate progress
1732 * - encoding: unused
1733 * - decoding: Set by user.
1734 * @param height the height of the slice
1735 * @param y the y position of the slice
1736 * @param type 1->top field, 2->bottom field, 3->frame
1737 * @param offset offset into the AVFrame.data from which the slice should be read
1739 void (*draw_horiz_band)(struct AVCodecContext *s,
1740 const AVFrame *src, int offset[AV_NUM_DATA_POINTERS],
1741 int y, int type, int height);
1744 * callback to negotiate the pixelFormat
1745 * @param fmt is the list of formats which are supported by the codec,
1746 * it is terminated by -1 as 0 is a valid format, the formats are ordered by quality.
1747 * The first is always the native one.
1748 * @note The callback may be called again immediately if initialization for
1749 * the selected (hardware-accelerated) pixel format failed.
1750 * @warning Behavior is undefined if the callback returns a value not
1751 * in the fmt list of formats.
1752 * @return the chosen format
1753 * - encoding: unused
1754 * - decoding: Set by user, if not set the native format will be chosen.
1756 enum AVPixelFormat (*get_format)(struct AVCodecContext *s, const enum AVPixelFormat * fmt);
1759 * maximum number of B-frames between non-B-frames
1760 * Note: The output will be delayed by max_b_frames+1 relative to the input.
1761 * - encoding: Set by user.
1762 * - decoding: unused
1767 * qscale factor between IP and B-frames
1768 * If > 0 then the last P-frame quantizer will be used (q= lastp_q*factor+offset).
1769 * If < 0 then normal ratecontrol will be done (q= -normal_q*factor+offset).
1770 * - encoding: Set by user.
1771 * - decoding: unused
1773 float b_quant_factor;
1775 #if FF_API_PRIVATE_OPT
1776 /** @deprecated use encoder private options instead */
1777 attribute_deprecated
1778 int b_frame_strategy;
1782 * qscale offset between IP and B-frames
1783 * - encoding: Set by user.
1784 * - decoding: unused
1786 float b_quant_offset;
1789 * Size of the frame reordering buffer in the decoder.
1790 * For MPEG-2 it is 1 IPB or 0 low delay IP.
1791 * - encoding: Set by libavcodec.
1792 * - decoding: Set by libavcodec.
1796 #if FF_API_PRIVATE_OPT
1797 /** @deprecated use encoder private options instead */
1798 attribute_deprecated
1803 * qscale factor between P- and I-frames
1804 * If > 0 then the last P-frame quantizer will be used (q = lastp_q * factor + offset).
1805 * If < 0 then normal ratecontrol will be done (q= -normal_q*factor+offset).
1806 * - encoding: Set by user.
1807 * - decoding: unused
1809 float i_quant_factor;
1812 * qscale offset between P and I-frames
1813 * - encoding: Set by user.
1814 * - decoding: unused
1816 float i_quant_offset;
1819 * luminance masking (0-> disabled)
1820 * - encoding: Set by user.
1821 * - decoding: unused
1826 * temporary complexity masking (0-> disabled)
1827 * - encoding: Set by user.
1828 * - decoding: unused
1830 float temporal_cplx_masking;
1833 * spatial complexity masking (0-> disabled)
1834 * - encoding: Set by user.
1835 * - decoding: unused
1837 float spatial_cplx_masking;
1840 * p block masking (0-> disabled)
1841 * - encoding: Set by user.
1842 * - decoding: unused
1847 * darkness masking (0-> disabled)
1848 * - encoding: Set by user.
1849 * - decoding: unused
1855 * - encoding: Set by libavcodec.
1856 * - decoding: Set by user (or 0).
1860 #if FF_API_PRIVATE_OPT
1861 /** @deprecated use encoder private options instead */
1862 attribute_deprecated
1863 int prediction_method;
1864 #define FF_PRED_LEFT 0
1865 #define FF_PRED_PLANE 1
1866 #define FF_PRED_MEDIAN 2
1870 * slice offsets in the frame in bytes
1871 * - encoding: Set/allocated by libavcodec.
1872 * - decoding: Set/allocated by user (or NULL).
1877 * sample aspect ratio (0 if unknown)
1878 * That is the width of a pixel divided by the height of the pixel.
1879 * Numerator and denominator must be relatively prime and smaller than 256 for some video standards.
1880 * - encoding: Set by user.
1881 * - decoding: Set by libavcodec.
1883 AVRational sample_aspect_ratio;
1886 * motion estimation comparison function
1887 * - encoding: Set by user.
1888 * - decoding: unused
1892 * subpixel motion estimation comparison function
1893 * - encoding: Set by user.
1894 * - decoding: unused
1898 * macroblock comparison function (not supported yet)
1899 * - encoding: Set by user.
1900 * - decoding: unused
1904 * interlaced DCT comparison function
1905 * - encoding: Set by user.
1906 * - decoding: unused
1909 #define FF_CMP_SAD 0
1910 #define FF_CMP_SSE 1
1911 #define FF_CMP_SATD 2
1912 #define FF_CMP_DCT 3
1913 #define FF_CMP_PSNR 4
1914 #define FF_CMP_BIT 5
1916 #define FF_CMP_ZERO 7
1917 #define FF_CMP_VSAD 8
1918 #define FF_CMP_VSSE 9
1919 #define FF_CMP_NSSE 10
1920 #define FF_CMP_W53 11
1921 #define FF_CMP_W97 12
1922 #define FF_CMP_DCTMAX 13
1923 #define FF_CMP_DCT264 14
1924 #define FF_CMP_MEDIAN_SAD 15
1925 #define FF_CMP_CHROMA 256
1928 * ME diamond size & shape
1929 * - encoding: Set by user.
1930 * - decoding: unused
1935 * amount of previous MV predictors (2a+1 x 2a+1 square)
1936 * - encoding: Set by user.
1937 * - decoding: unused
1939 int last_predictor_count;
1941 #if FF_API_PRIVATE_OPT
1942 /** @deprecated use encoder private options instead */
1943 attribute_deprecated
1948 * motion estimation prepass comparison function
1949 * - encoding: Set by user.
1950 * - decoding: unused
1955 * ME prepass diamond size & shape
1956 * - encoding: Set by user.
1957 * - decoding: unused
1963 * - encoding: Set by user.
1964 * - decoding: unused
1966 int me_subpel_quality;
1969 * maximum motion estimation search range in subpel units
1970 * If 0 then no limit.
1972 * - encoding: Set by user.
1973 * - decoding: unused
1979 * - encoding: unused
1980 * - decoding: Set by user.
1983 #define SLICE_FLAG_CODED_ORDER 0x0001 ///< draw_horiz_band() is called in coded order instead of display
1984 #define SLICE_FLAG_ALLOW_FIELD 0x0002 ///< allow draw_horiz_band() with field slices (MPEG-2 field pics)
1985 #define SLICE_FLAG_ALLOW_PLANE 0x0004 ///< allow draw_horiz_band() with 1 component at a time (SVQ1)
1988 * macroblock decision mode
1989 * - encoding: Set by user.
1990 * - decoding: unused
1993 #define FF_MB_DECISION_SIMPLE 0 ///< uses mb_cmp
1994 #define FF_MB_DECISION_BITS 1 ///< chooses the one which needs the fewest bits
1995 #define FF_MB_DECISION_RD 2 ///< rate distortion
1998 * custom intra quantization matrix
1999 * - encoding: Set by user, can be NULL.
2000 * - decoding: Set by libavcodec.
2002 uint16_t *intra_matrix;
2005 * custom inter quantization matrix
2006 * - encoding: Set by user, can be NULL.
2007 * - decoding: Set by libavcodec.
2009 uint16_t *inter_matrix;
2011 #if FF_API_PRIVATE_OPT
2012 /** @deprecated use encoder private options instead */
2013 attribute_deprecated
2014 int scenechange_threshold;
2016 /** @deprecated use encoder private options instead */
2017 attribute_deprecated
2018 int noise_reduction;
2022 * precision of the intra DC coefficient - 8
2023 * - encoding: Set by user.
2024 * - decoding: Set by libavcodec
2026 int intra_dc_precision;
2029 * Number of macroblock rows at the top which are skipped.
2030 * - encoding: unused
2031 * - decoding: Set by user.
2036 * Number of macroblock rows at the bottom which are skipped.
2037 * - encoding: unused
2038 * - decoding: Set by user.
2043 * minimum MB Lagrange multiplier
2044 * - encoding: Set by user.
2045 * - decoding: unused
2050 * maximum MB Lagrange multiplier
2051 * - encoding: Set by user.
2052 * - decoding: unused
2056 #if FF_API_PRIVATE_OPT
2058 * @deprecated use encoder private options instead
2060 attribute_deprecated
2061 int me_penalty_compensation;
2065 * - encoding: Set by user.
2066 * - decoding: unused
2070 #if FF_API_PRIVATE_OPT
2071 /** @deprecated use encoder private options instead */
2072 attribute_deprecated
2078 * - encoding: Set by user.
2079 * - decoding: unused
2084 * number of reference frames
2085 * - encoding: Set by user.
2086 * - decoding: Set by lavc.
2090 #if FF_API_PRIVATE_OPT
2091 /** @deprecated use encoder private options instead */
2092 attribute_deprecated
2097 * Note: Value depends upon the compare function used for fullpel ME.
2098 * - encoding: Set by user.
2099 * - decoding: unused
2103 #if FF_API_PRIVATE_OPT
2104 /** @deprecated use encoder private options instead */
2105 attribute_deprecated
2110 * Chromaticity coordinates of the source primaries.
2111 * - encoding: Set by user
2112 * - decoding: Set by libavcodec
2114 enum AVColorPrimaries color_primaries;
2117 * Color Transfer Characteristic.
2118 * - encoding: Set by user
2119 * - decoding: Set by libavcodec
2121 enum AVColorTransferCharacteristic color_trc;
2124 * YUV colorspace type.
2125 * - encoding: Set by user
2126 * - decoding: Set by libavcodec
2128 enum AVColorSpace colorspace;
2131 * MPEG vs JPEG YUV range.
2132 * - encoding: Set by user
2133 * - decoding: Set by libavcodec
2135 enum AVColorRange color_range;
2138 * This defines the location of chroma samples.
2139 * - encoding: Set by user
2140 * - decoding: Set by libavcodec
2142 enum AVChromaLocation chroma_sample_location;
2146 * Indicates number of picture subdivisions. Used for parallelized
2148 * - encoding: Set by user
2149 * - decoding: unused
2154 * - encoding: set by libavcodec
2155 * - decoding: Set by user.
2157 enum AVFieldOrder field_order;
2160 int sample_rate; ///< samples per second
2161 int channels; ///< number of audio channels
2164 * audio sample format
2165 * - encoding: Set by user.
2166 * - decoding: Set by libavcodec.
2168 enum AVSampleFormat sample_fmt; ///< sample format
2170 /* The following data should not be initialized. */
2172 * Number of samples per channel in an audio frame.
2174 * - encoding: set by libavcodec in avcodec_open2(). Each submitted frame
2175 * except the last must contain exactly frame_size samples per channel.
2176 * May be 0 when the codec has AV_CODEC_CAP_VARIABLE_FRAME_SIZE set, then the
2177 * frame size is not restricted.
2178 * - decoding: may be set by some decoders to indicate constant frame size
2183 * Frame counter, set by libavcodec.
2185 * - decoding: total number of frames returned from the decoder so far.
2186 * - encoding: total number of frames passed to the encoder so far.
2188 * @note the counter is not incremented if encoding/decoding resulted in
2194 * number of bytes per packet if constant and known or 0
2195 * Used by some WAV based audio codecs.
2200 * Audio cutoff bandwidth (0 means "automatic")
2201 * - encoding: Set by user.
2202 * - decoding: unused
2207 * Audio channel layout.
2208 * - encoding: set by user.
2209 * - decoding: set by user, may be overwritten by libavcodec.
2211 uint64_t channel_layout;
2214 * Request decoder to use this channel layout if it can (0 for default)
2215 * - encoding: unused
2216 * - decoding: Set by user.
2218 uint64_t request_channel_layout;
2221 * Type of service that the audio stream conveys.
2222 * - encoding: Set by user.
2223 * - decoding: Set by libavcodec.
2225 enum AVAudioServiceType audio_service_type;
2228 * desired sample format
2229 * - encoding: Not used.
2230 * - decoding: Set by user.
2231 * Decoder will decode to this format if it can.
2233 enum AVSampleFormat request_sample_fmt;
2236 * This callback is called at the beginning of each frame to get data
2237 * buffer(s) for it. There may be one contiguous buffer for all the data or
2238 * there may be a buffer per each data plane or anything in between. What
2239 * this means is, you may set however many entries in buf[] you feel necessary.
2240 * Each buffer must be reference-counted using the AVBuffer API (see description
2243 * The following fields will be set in the frame before this callback is
2246 * - width, height (video only)
2247 * - sample_rate, channel_layout, nb_samples (audio only)
2248 * Their values may differ from the corresponding values in
2249 * AVCodecContext. This callback must use the frame values, not the codec
2250 * context values, to calculate the required buffer size.
2252 * This callback must fill the following fields in the frame:
2256 * * if the data is planar audio with more than 8 channels, then this
2257 * callback must allocate and fill extended_data to contain all pointers
2258 * to all data planes. data[] must hold as many pointers as it can.
2259 * extended_data must be allocated with av_malloc() and will be freed in
2261 * * otherwise extended_data must point to data
2262 * - buf[] must contain one or more pointers to AVBufferRef structures. Each of
2263 * the frame's data and extended_data pointers must be contained in these. That
2264 * is, one AVBufferRef for each allocated chunk of memory, not necessarily one
2265 * AVBufferRef per data[] entry. See: av_buffer_create(), av_buffer_alloc(),
2266 * and av_buffer_ref().
2267 * - extended_buf and nb_extended_buf must be allocated with av_malloc() by
2268 * this callback and filled with the extra buffers if there are more
2269 * buffers than buf[] can hold. extended_buf will be freed in
2272 * If AV_CODEC_CAP_DR1 is not set then get_buffer2() must call
2273 * avcodec_default_get_buffer2() instead of providing buffers allocated by
2276 * Each data plane must be aligned to the maximum required by the target
2279 * @see avcodec_default_get_buffer2()
2283 * If AV_GET_BUFFER_FLAG_REF is set in flags then the frame may be reused
2284 * (read and/or written to if it is writable) later by libavcodec.
2286 * avcodec_align_dimensions2() should be used to find the required width and
2287 * height, as they normally need to be rounded up to the next multiple of 16.
2289 * Some decoders do not support linesizes changing between frames.
2291 * If frame multithreading is used and thread_safe_callbacks is set,
2292 * this callback may be called from a different thread, but not from more
2293 * than one at once. Does not need to be reentrant.
2295 * @see avcodec_align_dimensions2()
2299 * Decoders request a buffer of a particular size by setting
2300 * AVFrame.nb_samples prior to calling get_buffer2(). The decoder may,
2301 * however, utilize only part of the buffer by setting AVFrame.nb_samples
2302 * to a smaller value in the output frame.
2304 * As a convenience, av_samples_get_buffer_size() and
2305 * av_samples_fill_arrays() in libavutil may be used by custom get_buffer2()
2306 * functions to find the required data size and to fill data pointers and
2307 * linesize. In AVFrame.linesize, only linesize[0] may be set for audio
2308 * since all planes must be the same size.
2310 * @see av_samples_get_buffer_size(), av_samples_fill_arrays()
2312 * - encoding: unused
2313 * - decoding: Set by libavcodec, user can override.
2315 int (*get_buffer2)(struct AVCodecContext *s, AVFrame *frame, int flags);
2318 * If non-zero, the decoded audio and video frames returned from
2319 * avcodec_decode_video2() and avcodec_decode_audio4() are reference-counted
2320 * and are valid indefinitely. The caller must free them with
2321 * av_frame_unref() when they are not needed anymore.
2322 * Otherwise, the decoded frames must not be freed by the caller and are
2323 * only valid until the next decode call.
2325 * This is always automatically enabled if avcodec_receive_frame() is used.
2327 * - encoding: unused
2328 * - decoding: set by the caller before avcodec_open2().
2330 attribute_deprecated
2331 int refcounted_frames;
2333 /* - encoding parameters */
2334 float qcompress; ///< amount of qscale change between easy & hard scenes (0.0-1.0)
2335 float qblur; ///< amount of qscale smoothing over time (0.0-1.0)
2339 * - encoding: Set by user.
2340 * - decoding: unused
2346 * - encoding: Set by user.
2347 * - decoding: unused
2352 * maximum quantizer difference between frames
2353 * - encoding: Set by user.
2354 * - decoding: unused
2359 * decoder bitstream buffer size
2360 * - encoding: Set by user.
2361 * - decoding: unused
2366 * ratecontrol override, see RcOverride
2367 * - encoding: Allocated/set/freed by user.
2368 * - decoding: unused
2370 int rc_override_count;
2371 RcOverride *rc_override;
2375 * - encoding: Set by user.
2376 * - decoding: Set by user, may be overwritten by libavcodec.
2378 int64_t rc_max_rate;
2382 * - encoding: Set by user.
2383 * - decoding: unused
2385 int64_t rc_min_rate;
2388 * Ratecontrol attempt to use, at maximum, <value> of what can be used without an underflow.
2389 * - encoding: Set by user.
2390 * - decoding: unused.
2392 float rc_max_available_vbv_use;
2395 * Ratecontrol attempt to use, at least, <value> times the amount needed to prevent a vbv overflow.
2396 * - encoding: Set by user.
2397 * - decoding: unused.
2399 float rc_min_vbv_overflow_use;
2402 * Number of bits which should be loaded into the rc buffer before decoding starts.
2403 * - encoding: Set by user.
2404 * - decoding: unused
2406 int rc_initial_buffer_occupancy;
2408 #if FF_API_CODER_TYPE
2409 #define FF_CODER_TYPE_VLC 0
2410 #define FF_CODER_TYPE_AC 1
2411 #define FF_CODER_TYPE_RAW 2
2412 #define FF_CODER_TYPE_RLE 3
2414 * @deprecated use encoder private options instead
2416 attribute_deprecated
2418 #endif /* FF_API_CODER_TYPE */
2420 #if FF_API_PRIVATE_OPT
2421 /** @deprecated use encoder private options instead */
2422 attribute_deprecated
2426 #if FF_API_PRIVATE_OPT
2427 /** @deprecated use encoder private options instead */
2428 attribute_deprecated
2429 int frame_skip_threshold;
2431 /** @deprecated use encoder private options instead */
2432 attribute_deprecated
2433 int frame_skip_factor;
2435 /** @deprecated use encoder private options instead */
2436 attribute_deprecated
2439 /** @deprecated use encoder private options instead */
2440 attribute_deprecated
2442 #endif /* FF_API_PRIVATE_OPT */
2445 * trellis RD quantization
2446 * - encoding: Set by user.
2447 * - decoding: unused
2451 #if FF_API_PRIVATE_OPT
2452 /** @deprecated use encoder private options instead */
2453 attribute_deprecated
2454 int min_prediction_order;
2456 /** @deprecated use encoder private options instead */
2457 attribute_deprecated
2458 int max_prediction_order;
2460 /** @deprecated use encoder private options instead */
2461 attribute_deprecated
2462 int64_t timecode_frame_start;
2465 #if FF_API_RTP_CALLBACK
2467 * @deprecated unused
2469 /* The RTP callback: This function is called */
2470 /* every time the encoder has a packet to send. */
2471 /* It depends on the encoder if the data starts */
2472 /* with a Start Code (it should). H.263 does. */
2473 /* mb_nb contains the number of macroblocks */
2474 /* encoded in the RTP payload. */
2475 attribute_deprecated
2476 void (*rtp_callback)(struct AVCodecContext *avctx, void *data, int size, int mb_nb);
2479 #if FF_API_PRIVATE_OPT
2480 /** @deprecated use encoder private options instead */
2481 attribute_deprecated
2482 int rtp_payload_size; /* The size of the RTP payload: the coder will */
2483 /* do its best to deliver a chunk with size */
2484 /* below rtp_payload_size, the chunk will start */
2485 /* with a start code on some codecs like H.263. */
2486 /* This doesn't take account of any particular */
2487 /* headers inside the transmitted RTP payload. */
2490 #if FF_API_STAT_BITS
2491 /* statistics, used for 2-pass encoding */
2492 attribute_deprecated
2494 attribute_deprecated
2496 attribute_deprecated
2498 attribute_deprecated
2500 attribute_deprecated
2502 attribute_deprecated
2504 attribute_deprecated
2506 attribute_deprecated
2509 /** @deprecated this field is unused */
2510 attribute_deprecated
2515 * pass1 encoding statistics output buffer
2516 * - encoding: Set by libavcodec.
2517 * - decoding: unused
2522 * pass2 encoding statistics input buffer
2523 * Concatenated stuff from stats_out of pass1 should be placed here.
2524 * - encoding: Allocated/set/freed by user.
2525 * - decoding: unused
2530 * Work around bugs in encoders which sometimes cannot be detected automatically.
2531 * - encoding: Set by user
2532 * - decoding: Set by user
2534 int workaround_bugs;
2535 #define FF_BUG_AUTODETECT 1 ///< autodetection
2536 #define FF_BUG_XVID_ILACE 4
2537 #define FF_BUG_UMP4 8
2538 #define FF_BUG_NO_PADDING 16
2539 #define FF_BUG_AMV 32
2540 #define FF_BUG_QPEL_CHROMA 64
2541 #define FF_BUG_STD_QPEL 128
2542 #define FF_BUG_QPEL_CHROMA2 256
2543 #define FF_BUG_DIRECT_BLOCKSIZE 512
2544 #define FF_BUG_EDGE 1024
2545 #define FF_BUG_HPEL_CHROMA 2048
2546 #define FF_BUG_DC_CLIP 4096
2547 #define FF_BUG_MS 8192 ///< Work around various bugs in Microsoft's broken decoders.
2548 #define FF_BUG_TRUNCATED 16384
2549 #define FF_BUG_IEDGE 32768
2552 * strictly follow the standard (MPEG-4, ...).
2553 * - encoding: Set by user.
2554 * - decoding: Set by user.
2555 * Setting this to STRICT or higher means the encoder and decoder will
2556 * generally do stupid things, whereas setting it to unofficial or lower
2557 * will mean the encoder might produce output that is not supported by all
2558 * spec-compliant decoders. Decoders don't differentiate between normal,
2559 * unofficial and experimental (that is, they always try to decode things
2560 * when they can) unless they are explicitly asked to behave stupidly
2561 * (=strictly conform to the specs)
2563 int strict_std_compliance;
2564 #define FF_COMPLIANCE_VERY_STRICT 2 ///< Strictly conform to an older more strict version of the spec or reference software.
2565 #define FF_COMPLIANCE_STRICT 1 ///< Strictly conform to all the things in the spec no matter what consequences.
2566 #define FF_COMPLIANCE_NORMAL 0
2567 #define FF_COMPLIANCE_UNOFFICIAL -1 ///< Allow unofficial extensions
2568 #define FF_COMPLIANCE_EXPERIMENTAL -2 ///< Allow nonstandardized experimental things.
2571 * error concealment flags
2572 * - encoding: unused
2573 * - decoding: Set by user.
2575 int error_concealment;
2576 #define FF_EC_GUESS_MVS 1
2577 #define FF_EC_DEBLOCK 2
2578 #define FF_EC_FAVOR_INTER 256
2582 * - encoding: Set by user.
2583 * - decoding: Set by user.
2586 #define FF_DEBUG_PICT_INFO 1
2587 #define FF_DEBUG_RC 2
2588 #define FF_DEBUG_BITSTREAM 4
2589 #define FF_DEBUG_MB_TYPE 8
2590 #define FF_DEBUG_QP 16
2593 * @deprecated this option does nothing
2595 #define FF_DEBUG_MV 32
2597 #define FF_DEBUG_DCT_COEFF 0x00000040
2598 #define FF_DEBUG_SKIP 0x00000080
2599 #define FF_DEBUG_STARTCODE 0x00000100
2600 #define FF_DEBUG_ER 0x00000400
2601 #define FF_DEBUG_MMCO 0x00000800
2602 #define FF_DEBUG_BUGS 0x00001000
2604 #define FF_DEBUG_VIS_QP 0x00002000
2605 #define FF_DEBUG_VIS_MB_TYPE 0x00004000
2607 #define FF_DEBUG_BUFFERS 0x00008000
2608 #define FF_DEBUG_THREADS 0x00010000
2609 #define FF_DEBUG_GREEN_MD 0x00800000
2610 #define FF_DEBUG_NOMC 0x01000000
2615 * - encoding: Set by user.
2616 * - decoding: Set by user.
2619 #define FF_DEBUG_VIS_MV_P_FOR 0x00000001 // visualize forward predicted MVs of P-frames
2620 #define FF_DEBUG_VIS_MV_B_FOR 0x00000002 // visualize forward predicted MVs of B-frames
2621 #define FF_DEBUG_VIS_MV_B_BACK 0x00000004 // visualize backward predicted MVs of B-frames
2625 * Error recognition; may misdetect some more or less valid parts as errors.
2626 * - encoding: unused
2627 * - decoding: Set by user.
2629 int err_recognition;
2632 * Verify checksums embedded in the bitstream (could be of either encoded or
2633 * decoded data, depending on the codec) and print an error message on mismatch.
2634 * If AV_EF_EXPLODE is also set, a mismatching checksum will result in the
2635 * decoder returning an error.
2637 #define AV_EF_CRCCHECK (1<<0)
2638 #define AV_EF_BITSTREAM (1<<1) ///< detect bitstream specification deviations
2639 #define AV_EF_BUFFER (1<<2) ///< detect improper bitstream length
2640 #define AV_EF_EXPLODE (1<<3) ///< abort decoding on minor error detection
2642 #define AV_EF_IGNORE_ERR (1<<15) ///< ignore errors and continue
2643 #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
2644 #define AV_EF_COMPLIANT (1<<17) ///< consider all spec non compliances as errors
2645 #define AV_EF_AGGRESSIVE (1<<18) ///< consider things that a sane encoder should not do as an error
2649 * opaque 64-bit number (generally a PTS) that will be reordered and
2650 * output in AVFrame.reordered_opaque
2651 * - encoding: unused
2652 * - decoding: Set by user.
2654 int64_t reordered_opaque;
2657 * Hardware accelerator in use
2658 * - encoding: unused.
2659 * - decoding: Set by libavcodec
2661 const struct AVHWAccel *hwaccel;
2664 * Hardware accelerator context.
2665 * For some hardware accelerators, a global context needs to be
2666 * provided by the user. In that case, this holds display-dependent
2667 * data FFmpeg cannot instantiate itself. Please refer to the
2668 * FFmpeg HW accelerator documentation to know how to fill this
2669 * is. e.g. for VA API, this is a struct vaapi_context.
2670 * - encoding: unused
2671 * - decoding: Set by user
2673 void *hwaccel_context;
2677 * - encoding: Set by libavcodec if flags & AV_CODEC_FLAG_PSNR.
2678 * - decoding: unused
2680 uint64_t error[AV_NUM_DATA_POINTERS];
2683 * DCT algorithm, see FF_DCT_* below
2684 * - encoding: Set by user.
2685 * - decoding: unused
2688 #define FF_DCT_AUTO 0
2689 #define FF_DCT_FASTINT 1
2690 #define FF_DCT_INT 2
2691 #define FF_DCT_MMX 3
2692 #define FF_DCT_ALTIVEC 5
2693 #define FF_DCT_FAAN 6
2696 * IDCT algorithm, see FF_IDCT_* below.
2697 * - encoding: Set by user.
2698 * - decoding: Set by user.
2701 #define FF_IDCT_AUTO 0
2702 #define FF_IDCT_INT 1
2703 #define FF_IDCT_SIMPLE 2
2704 #define FF_IDCT_SIMPLEMMX 3
2705 #define FF_IDCT_ARM 7
2706 #define FF_IDCT_ALTIVEC 8
2707 #define FF_IDCT_SIMPLEARM 10
2708 #define FF_IDCT_XVID 14
2709 #define FF_IDCT_SIMPLEARMV5TE 16
2710 #define FF_IDCT_SIMPLEARMV6 17
2711 #define FF_IDCT_FAAN 20
2712 #define FF_IDCT_SIMPLENEON 22
2713 #define FF_IDCT_NONE 24 /* Used by XvMC to extract IDCT coefficients with FF_IDCT_PERM_NONE */
2714 #define FF_IDCT_SIMPLEAUTO 128
2717 * bits per sample/pixel from the demuxer (needed for huffyuv).
2718 * - encoding: Set by libavcodec.
2719 * - decoding: Set by user.
2721 int bits_per_coded_sample;
2724 * Bits per sample/pixel of internal libavcodec pixel/sample format.
2725 * - encoding: set by user.
2726 * - decoding: set by libavcodec.
2728 int bits_per_raw_sample;
2732 * low resolution decoding, 1-> 1/2 size, 2->1/4 size
2733 * - encoding: unused
2734 * - decoding: Set by user.
2739 #if FF_API_CODED_FRAME
2741 * the picture in the bitstream
2742 * - encoding: Set by libavcodec.
2743 * - decoding: unused
2745 * @deprecated use the quality factor packet side data instead
2747 attribute_deprecated AVFrame *coded_frame;
2752 * is used to decide how many independent tasks should be passed to execute()
2753 * - encoding: Set by user.
2754 * - decoding: Set by user.
2759 * Which multithreading methods to use.
2760 * Use of FF_THREAD_FRAME will increase decoding delay by one frame per thread,
2761 * so clients which cannot provide future frames should not use it.
2763 * - encoding: Set by user, otherwise the default is used.
2764 * - decoding: Set by user, otherwise the default is used.
2767 #define FF_THREAD_FRAME 1 ///< Decode more than one frame at once
2768 #define FF_THREAD_SLICE 2 ///< Decode more than one part of a single frame at once
2771 * Which multithreading methods are in use by the codec.
2772 * - encoding: Set by libavcodec.
2773 * - decoding: Set by libavcodec.
2775 int active_thread_type;
2778 * Set by the client if its custom get_buffer() callback can be called
2779 * synchronously from another thread, which allows faster multithreaded decoding.
2780 * draw_horiz_band() will be called from other threads regardless of this setting.
2781 * Ignored if the default get_buffer() is used.
2782 * - encoding: Set by user.
2783 * - decoding: Set by user.
2785 int thread_safe_callbacks;
2788 * The codec may call this to execute several independent things.
2789 * It will return only after finishing all tasks.
2790 * The user may replace this with some multithreaded implementation,
2791 * the default implementation will execute the parts serially.
2792 * @param count the number of things to execute
2793 * - encoding: Set by libavcodec, user can override.
2794 * - decoding: Set by libavcodec, user can override.
2796 int (*execute)(struct AVCodecContext *c, int (*func)(struct AVCodecContext *c2, void *arg), void *arg2, int *ret, int count, int size);
2799 * The codec may call this to execute several independent things.
2800 * It will return only after finishing all tasks.
2801 * The user may replace this with some multithreaded implementation,
2802 * the default implementation will execute the parts serially.
2803 * Also see avcodec_thread_init and e.g. the --enable-pthread configure option.
2804 * @param c context passed also to func
2805 * @param count the number of things to execute
2806 * @param arg2 argument passed unchanged to func
2807 * @param ret return values of executed functions, must have space for "count" values. May be NULL.
2808 * @param func function that will be called count times, with jobnr from 0 to count-1.
2809 * threadnr will be in the range 0 to c->thread_count-1 < MAX_THREADS and so that no
2810 * two instances of func executing at the same time will have the same threadnr.
2811 * @return always 0 currently, but code should handle a future improvement where when any call to func
2812 * returns < 0 no further calls to func may be done and < 0 is returned.
2813 * - encoding: Set by libavcodec, user can override.
2814 * - decoding: Set by libavcodec, user can override.
2816 int (*execute2)(struct AVCodecContext *c, int (*func)(struct AVCodecContext *c2, void *arg, int jobnr, int threadnr), void *arg2, int *ret, int count);
2819 * noise vs. sse weight for the nsse comparison function
2820 * - encoding: Set by user.
2821 * - decoding: unused
2827 * - encoding: Set by user.
2828 * - decoding: Set by libavcodec.
2831 #define FF_PROFILE_UNKNOWN -99
2832 #define FF_PROFILE_RESERVED -100
2834 #define FF_PROFILE_AAC_MAIN 0
2835 #define FF_PROFILE_AAC_LOW 1
2836 #define FF_PROFILE_AAC_SSR 2
2837 #define FF_PROFILE_AAC_LTP 3
2838 #define FF_PROFILE_AAC_HE 4
2839 #define FF_PROFILE_AAC_HE_V2 28
2840 #define FF_PROFILE_AAC_LD 22
2841 #define FF_PROFILE_AAC_ELD 38
2842 #define FF_PROFILE_MPEG2_AAC_LOW 128
2843 #define FF_PROFILE_MPEG2_AAC_HE 131
2845 #define FF_PROFILE_DNXHD 0
2846 #define FF_PROFILE_DNXHR_LB 1
2847 #define FF_PROFILE_DNXHR_SQ 2
2848 #define FF_PROFILE_DNXHR_HQ 3
2849 #define FF_PROFILE_DNXHR_HQX 4
2850 #define FF_PROFILE_DNXHR_444 5
2852 #define FF_PROFILE_DTS 20
2853 #define FF_PROFILE_DTS_ES 30
2854 #define FF_PROFILE_DTS_96_24 40
2855 #define FF_PROFILE_DTS_HD_HRA 50
2856 #define FF_PROFILE_DTS_HD_MA 60
2857 #define FF_PROFILE_DTS_EXPRESS 70
2859 #define FF_PROFILE_MPEG2_422 0
2860 #define FF_PROFILE_MPEG2_HIGH 1
2861 #define FF_PROFILE_MPEG2_SS 2
2862 #define FF_PROFILE_MPEG2_SNR_SCALABLE 3
2863 #define FF_PROFILE_MPEG2_MAIN 4
2864 #define FF_PROFILE_MPEG2_SIMPLE 5
2866 #define FF_PROFILE_H264_CONSTRAINED (1<<9) // 8+1; constraint_set1_flag
2867 #define FF_PROFILE_H264_INTRA (1<<11) // 8+3; constraint_set3_flag
2869 #define FF_PROFILE_H264_BASELINE 66
2870 #define FF_PROFILE_H264_CONSTRAINED_BASELINE (66|FF_PROFILE_H264_CONSTRAINED)
2871 #define FF_PROFILE_H264_MAIN 77
2872 #define FF_PROFILE_H264_EXTENDED 88
2873 #define FF_PROFILE_H264_HIGH 100
2874 #define FF_PROFILE_H264_HIGH_10 110
2875 #define FF_PROFILE_H264_HIGH_10_INTRA (110|FF_PROFILE_H264_INTRA)
2876 #define FF_PROFILE_H264_MULTIVIEW_HIGH 118
2877 #define FF_PROFILE_H264_HIGH_422 122
2878 #define FF_PROFILE_H264_HIGH_422_INTRA (122|FF_PROFILE_H264_INTRA)
2879 #define FF_PROFILE_H264_STEREO_HIGH 128
2880 #define FF_PROFILE_H264_HIGH_444 144
2881 #define FF_PROFILE_H264_HIGH_444_PREDICTIVE 244
2882 #define FF_PROFILE_H264_HIGH_444_INTRA (244|FF_PROFILE_H264_INTRA)
2883 #define FF_PROFILE_H264_CAVLC_444 44
2885 #define FF_PROFILE_VC1_SIMPLE 0
2886 #define FF_PROFILE_VC1_MAIN 1
2887 #define FF_PROFILE_VC1_COMPLEX 2
2888 #define FF_PROFILE_VC1_ADVANCED 3
2890 #define FF_PROFILE_MPEG4_SIMPLE 0
2891 #define FF_PROFILE_MPEG4_SIMPLE_SCALABLE 1
2892 #define FF_PROFILE_MPEG4_CORE 2
2893 #define FF_PROFILE_MPEG4_MAIN 3
2894 #define FF_PROFILE_MPEG4_N_BIT 4
2895 #define FF_PROFILE_MPEG4_SCALABLE_TEXTURE 5
2896 #define FF_PROFILE_MPEG4_SIMPLE_FACE_ANIMATION 6
2897 #define FF_PROFILE_MPEG4_BASIC_ANIMATED_TEXTURE 7
2898 #define FF_PROFILE_MPEG4_HYBRID 8
2899 #define FF_PROFILE_MPEG4_ADVANCED_REAL_TIME 9
2900 #define FF_PROFILE_MPEG4_CORE_SCALABLE 10
2901 #define FF_PROFILE_MPEG4_ADVANCED_CODING 11
2902 #define FF_PROFILE_MPEG4_ADVANCED_CORE 12
2903 #define FF_PROFILE_MPEG4_ADVANCED_SCALABLE_TEXTURE 13
2904 #define FF_PROFILE_MPEG4_SIMPLE_STUDIO 14
2905 #define FF_PROFILE_MPEG4_ADVANCED_SIMPLE 15
2907 #define FF_PROFILE_JPEG2000_CSTREAM_RESTRICTION_0 1
2908 #define FF_PROFILE_JPEG2000_CSTREAM_RESTRICTION_1 2
2909 #define FF_PROFILE_JPEG2000_CSTREAM_NO_RESTRICTION 32768
2910 #define FF_PROFILE_JPEG2000_DCINEMA_2K 3
2911 #define FF_PROFILE_JPEG2000_DCINEMA_4K 4
2913 #define FF_PROFILE_VP9_0 0
2914 #define FF_PROFILE_VP9_1 1
2915 #define FF_PROFILE_VP9_2 2
2916 #define FF_PROFILE_VP9_3 3
2918 #define FF_PROFILE_HEVC_MAIN 1
2919 #define FF_PROFILE_HEVC_MAIN_10 2
2920 #define FF_PROFILE_HEVC_MAIN_STILL_PICTURE 3
2921 #define FF_PROFILE_HEVC_REXT 4
2923 #define FF_PROFILE_MJPEG_HUFFMAN_BASELINE_DCT 0xc0
2924 #define FF_PROFILE_MJPEG_HUFFMAN_EXTENDED_SEQUENTIAL_DCT 0xc1
2925 #define FF_PROFILE_MJPEG_HUFFMAN_PROGRESSIVE_DCT 0xc2
2926 #define FF_PROFILE_MJPEG_HUFFMAN_LOSSLESS 0xc3
2927 #define FF_PROFILE_MJPEG_JPEG_LS 0xf7
2929 #define FF_PROFILE_SBC_MSBC 1
2933 * - encoding: Set by user.
2934 * - decoding: Set by libavcodec.
2937 #define FF_LEVEL_UNKNOWN -99
2940 * Skip loop filtering for selected frames.
2941 * - encoding: unused
2942 * - decoding: Set by user.
2944 enum AVDiscard skip_loop_filter;
2947 * Skip IDCT/dequantization for selected frames.
2948 * - encoding: unused
2949 * - decoding: Set by user.
2951 enum AVDiscard skip_idct;
2954 * Skip decoding for selected frames.
2955 * - encoding: unused
2956 * - decoding: Set by user.
2958 enum AVDiscard skip_frame;
2961 * Header containing style information for text subtitles.
2962 * For SUBTITLE_ASS subtitle type, it should contain the whole ASS
2963 * [Script Info] and [V4+ Styles] section, plus the [Events] line and
2964 * the Format line following. It shouldn't include any Dialogue line.
2965 * - encoding: Set/allocated/freed by user (before avcodec_open2())
2966 * - decoding: Set/allocated/freed by libavcodec (by avcodec_open2())
2968 uint8_t *subtitle_header;
2969 int subtitle_header_size;
2971 #if FF_API_VBV_DELAY
2973 * VBV delay coded in the last frame (in periods of a 27 MHz clock).
2974 * Used for compliant TS muxing.
2975 * - encoding: Set by libavcodec.
2976 * - decoding: unused.
2977 * @deprecated this value is now exported as a part of
2978 * AV_PKT_DATA_CPB_PROPERTIES packet side data
2980 attribute_deprecated
2984 #if FF_API_SIDEDATA_ONLY_PKT
2986 * Encoding only and set by default. Allow encoders to output packets
2987 * that do not contain any encoded data, only side data.
2989 * Some encoders need to output such packets, e.g. to update some stream
2990 * parameters at the end of encoding.
2992 * @deprecated this field disables the default behaviour and
2993 * it is kept only for compatibility.
2995 attribute_deprecated
2996 int side_data_only_packets;
3000 * Audio only. The number of "priming" samples (padding) inserted by the
3001 * encoder at the beginning of the audio. I.e. this number of leading
3002 * decoded samples must be discarded by the caller to get the original audio
3003 * without leading padding.
3005 * - decoding: unused
3006 * - encoding: Set by libavcodec. The timestamps on the output packets are
3007 * adjusted by the encoder so that they always refer to the
3008 * first sample of the data actually contained in the packet,
3009 * including any added padding. E.g. if the timebase is
3010 * 1/samplerate and the timestamp of the first input sample is
3011 * 0, the timestamp of the first output packet will be
3014 int initial_padding;
3017 * - decoding: For codecs that store a framerate value in the compressed
3018 * bitstream, the decoder may export it here. { 0, 1} when
3020 * - encoding: May be used to signal the framerate of CFR content to an
3023 AVRational framerate;
3026 * Nominal unaccelerated pixel format, see AV_PIX_FMT_xxx.
3027 * - encoding: unused.
3028 * - decoding: Set by libavcodec before calling get_format()
3030 enum AVPixelFormat sw_pix_fmt;
3033 * Timebase in which pkt_dts/pts and AVPacket.dts/pts are.
3034 * - encoding unused.
3035 * - decoding set by user.
3037 AVRational pkt_timebase;
3041 * - encoding: unused.
3042 * - decoding: set by libavcodec.
3044 const AVCodecDescriptor *codec_descriptor;
3048 * low resolution decoding, 1-> 1/2 size, 2->1/4 size
3049 * - encoding: unused
3050 * - decoding: Set by user.
3056 * Current statistics for PTS correction.
3057 * - decoding: maintained and used by libavcodec, not intended to be used by user apps
3058 * - encoding: unused
3060 int64_t pts_correction_num_faulty_pts; /// Number of incorrect PTS values so far
3061 int64_t pts_correction_num_faulty_dts; /// Number of incorrect DTS values so far
3062 int64_t pts_correction_last_pts; /// PTS of the last frame
3063 int64_t pts_correction_last_dts; /// DTS of the last frame
3066 * Character encoding of the input subtitles file.
3067 * - decoding: set by user
3068 * - encoding: unused
3073 * Subtitles character encoding mode. Formats or codecs might be adjusting
3074 * this setting (if they are doing the conversion themselves for instance).
3075 * - decoding: set by libavcodec
3076 * - encoding: unused
3078 int sub_charenc_mode;
3079 #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)
3080 #define FF_SUB_CHARENC_MODE_AUTOMATIC 0 ///< libavcodec will select the mode itself
3081 #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
3084 * Skip processing alpha if supported by codec.
3085 * Note that if the format uses pre-multiplied alpha (common with VP6,
3086 * and recommended due to better video quality/compression)
3087 * the image will look as if alpha-blended onto a black background.
3088 * However for formats that do not use pre-multiplied alpha
3089 * there might be serious artefacts (though e.g. libswscale currently
3090 * assumes pre-multiplied alpha anyway).
3092 * - decoding: set by user
3093 * - encoding: unused
3098 * Number of samples to skip after a discontinuity
3099 * - decoding: unused
3100 * - encoding: set by libavcodec
3104 #if !FF_API_DEBUG_MV
3106 * debug motion vectors
3107 * - encoding: Set by user.
3108 * - decoding: Set by user.
3111 #define FF_DEBUG_VIS_MV_P_FOR 0x00000001 //visualize forward predicted MVs of P frames
3112 #define FF_DEBUG_VIS_MV_B_FOR 0x00000002 //visualize forward predicted MVs of B frames
3113 #define FF_DEBUG_VIS_MV_B_BACK 0x00000004 //visualize backward predicted MVs of B frames
3117 * custom intra quantization matrix
3118 * - encoding: Set by user, can be NULL.
3119 * - decoding: unused.
3121 uint16_t *chroma_intra_matrix;
3124 * dump format separator.
3125 * can be ", " or "\n " or anything else
3126 * - encoding: Set by user.
3127 * - decoding: Set by user.
3129 uint8_t *dump_separator;
3132 * ',' separated list of allowed decoders.
3133 * If NULL then all are allowed
3134 * - encoding: unused
3135 * - decoding: set by user
3137 char *codec_whitelist;
3140 * Properties of the stream that gets decoded
3141 * - encoding: unused
3142 * - decoding: set by libavcodec
3144 unsigned properties;
3145 #define FF_CODEC_PROPERTY_LOSSLESS 0x00000001
3146 #define FF_CODEC_PROPERTY_CLOSED_CAPTIONS 0x00000002
3149 * Additional data associated with the entire coded stream.
3151 * - decoding: unused
3152 * - encoding: may be set by libavcodec after avcodec_open2().
3154 AVPacketSideData *coded_side_data;
3155 int nb_coded_side_data;
3158 * A reference to the AVHWFramesContext describing the input (for encoding)
3159 * or output (decoding) frames. The reference is set by the caller and
3160 * afterwards owned (and freed) by libavcodec - it should never be read by
3161 * the caller after being set.
3163 * - decoding: This field should be set by the caller from the get_format()
3164 * callback. The previous reference (if any) will always be
3165 * unreffed by libavcodec before the get_format() call.
3167 * If the default get_buffer2() is used with a hwaccel pixel
3168 * format, then this AVHWFramesContext will be used for
3169 * allocating the frame buffers.
3171 * - encoding: For hardware encoders configured to use a hwaccel pixel
3172 * format, this field should be set by the caller to a reference
3173 * to the AVHWFramesContext describing input frames.
3174 * AVHWFramesContext.format must be equal to
3175 * AVCodecContext.pix_fmt.
3177 * This field should be set before avcodec_open2() is called.
3179 AVBufferRef *hw_frames_ctx;
3182 * Control the form of AVSubtitle.rects[N]->ass
3183 * - decoding: set by user
3184 * - encoding: unused
3186 int sub_text_format;
3187 #define FF_SUB_TEXT_FMT_ASS 0
3188 #if FF_API_ASS_TIMING
3189 #define FF_SUB_TEXT_FMT_ASS_WITH_TIMINGS 1
3193 * Audio only. The amount of padding (in samples) appended by the encoder to
3194 * the end of the audio. I.e. this number of decoded samples must be
3195 * discarded by the caller from the end of the stream to get the original
3196 * audio without any trailing padding.
3198 * - decoding: unused
3199 * - encoding: unused
3201 int trailing_padding;
3204 * The number of pixels per image to maximally accept.
3206 * - decoding: set by user
3207 * - encoding: set by user
3212 * A reference to the AVHWDeviceContext describing the device which will
3213 * be used by a hardware encoder/decoder. The reference is set by the
3214 * caller and afterwards owned (and freed) by libavcodec.
3216 * This should be used if either the codec device does not require
3217 * hardware frames or any that are used are to be allocated internally by
3218 * libavcodec. If the user wishes to supply any of the frames used as
3219 * encoder input or decoder output then hw_frames_ctx should be used
3220 * instead. When hw_frames_ctx is set in get_format() for a decoder, this
3221 * field will be ignored while decoding the associated stream segment, but
3222 * may again be used on a following one after another get_format() call.
3224 * For both encoders and decoders this field should be set before
3225 * avcodec_open2() is called and must not be written to thereafter.
3227 * Note that some decoders may require this field to be set initially in
3228 * order to support hw_frames_ctx at all - in that case, all frames
3229 * contexts used must be created on the same device.
3231 AVBufferRef *hw_device_ctx;
3234 * Bit set of AV_HWACCEL_FLAG_* flags, which affect hardware accelerated
3235 * decoding (if active).
3236 * - encoding: unused
3237 * - decoding: Set by user (either before avcodec_open2(), or in the
3238 * AVCodecContext.get_format callback)
3243 * Video decoding only. Certain video codecs support cropping, meaning that
3244 * only a sub-rectangle of the decoded frame is intended for display. This
3245 * option controls how cropping is handled by libavcodec.
3247 * When set to 1 (the default), libavcodec will apply cropping internally.
3248 * I.e. it will modify the output frame width/height fields and offset the
3249 * data pointers (only by as much as possible while preserving alignment, or
3250 * by the full amount if the AV_CODEC_FLAG_UNALIGNED flag is set) so that
3251 * the frames output by the decoder refer only to the cropped area. The
3252 * crop_* fields of the output frames will be zero.
3254 * When set to 0, the width/height fields of the output frames will be set
3255 * to the coded dimensions and the crop_* fields will describe the cropping
3256 * rectangle. Applying the cropping is left to the caller.
3258 * @warning When hardware acceleration with opaque output frames is used,
3259 * libavcodec is unable to apply cropping from the top/left border.
3261 * @note when this option is set to zero, the width/height fields of the
3262 * AVCodecContext and output AVFrames have different meanings. The codec
3263 * context fields store display dimensions (with the coded dimensions in
3264 * coded_width/height), while the frame fields store the coded dimensions
3265 * (with the display dimensions being determined by the crop_* fields).
3270 * Video decoding only. Sets the number of extra hardware frames which
3271 * the decoder will allocate for use by the caller. This must be set
3272 * before avcodec_open2() is called.
3274 * Some hardware decoders require all frames that they will use for
3275 * output to be defined in advance before decoding starts. For such
3276 * decoders, the hardware frame pool must therefore be of a fixed size.
3277 * The extra frames set here are on top of any number that the decoder
3278 * needs internally in order to operate normally (for example, frames
3279 * used as reference pictures).
3281 int extra_hw_frames;
3284 #if FF_API_CODEC_GET_SET
3286 * Accessors for some AVCodecContext fields. These used to be provided for ABI
3287 * compatibility, and do not need to be used anymore.
3289 attribute_deprecated
3290 AVRational av_codec_get_pkt_timebase (const AVCodecContext *avctx);
3291 attribute_deprecated
3292 void av_codec_set_pkt_timebase (AVCodecContext *avctx, AVRational val);
3294 attribute_deprecated
3295 const AVCodecDescriptor *av_codec_get_codec_descriptor(const AVCodecContext *avctx);
3296 attribute_deprecated
3297 void av_codec_set_codec_descriptor(AVCodecContext *avctx, const AVCodecDescriptor *desc);
3299 attribute_deprecated
3300 unsigned av_codec_get_codec_properties(const AVCodecContext *avctx);
3303 attribute_deprecated
3304 int av_codec_get_lowres(const AVCodecContext *avctx);
3305 attribute_deprecated
3306 void av_codec_set_lowres(AVCodecContext *avctx, int val);
3309 attribute_deprecated
3310 int av_codec_get_seek_preroll(const AVCodecContext *avctx);
3311 attribute_deprecated
3312 void av_codec_set_seek_preroll(AVCodecContext *avctx, int val);
3314 attribute_deprecated
3315 uint16_t *av_codec_get_chroma_intra_matrix(const AVCodecContext *avctx);
3316 attribute_deprecated
3317 void av_codec_set_chroma_intra_matrix(AVCodecContext *avctx, uint16_t *val);
3323 typedef struct AVProfile {
3325 const char *name; ///< short name for the profile
3330 * The codec supports this format via the hw_device_ctx interface.
3332 * When selecting this format, AVCodecContext.hw_device_ctx should
3333 * have been set to a device of the specified type before calling
3336 AV_CODEC_HW_CONFIG_METHOD_HW_DEVICE_CTX = 0x01,
3338 * The codec supports this format via the hw_frames_ctx interface.
3340 * When selecting this format for a decoder,
3341 * AVCodecContext.hw_frames_ctx should be set to a suitable frames
3342 * context inside the get_format() callback. The frames context
3343 * must have been created on a device of the specified type.
3345 AV_CODEC_HW_CONFIG_METHOD_HW_FRAMES_CTX = 0x02,
3347 * The codec supports this format by some internal method.
3349 * This format can be selected without any additional configuration -
3350 * no device or frames context is required.
3352 AV_CODEC_HW_CONFIG_METHOD_INTERNAL = 0x04,
3354 * The codec supports this format by some ad-hoc method.
3356 * Additional settings and/or function calls are required. See the
3357 * codec-specific documentation for details. (Methods requiring
3358 * this sort of configuration are deprecated and others should be
3359 * used in preference.)
3361 AV_CODEC_HW_CONFIG_METHOD_AD_HOC = 0x08,
3364 typedef struct AVCodecHWConfig {
3366 * A hardware pixel format which the codec can use.
3368 enum AVPixelFormat pix_fmt;
3370 * Bit set of AV_CODEC_HW_CONFIG_METHOD_* flags, describing the possible
3371 * setup methods which can be used with this configuration.
3375 * The device type associated with the configuration.
3377 * Must be set for AV_CODEC_HW_CONFIG_METHOD_HW_DEVICE_CTX and
3378 * AV_CODEC_HW_CONFIG_METHOD_HW_FRAMES_CTX, otherwise unused.
3380 enum AVHWDeviceType device_type;
3383 typedef struct AVCodecDefault AVCodecDefault;
3390 typedef struct AVCodec {
3392 * Name of the codec implementation.
3393 * The name is globally unique among encoders and among decoders (but an
3394 * encoder and a decoder can share the same name).
3395 * This is the primary way to find a codec from the user perspective.
3399 * Descriptive name for the codec, meant to be more human readable than name.
3400 * You should use the NULL_IF_CONFIG_SMALL() macro to define it.
3402 const char *long_name;
3403 enum AVMediaType type;
3406 * Codec capabilities.
3407 * see AV_CODEC_CAP_*
3410 const AVRational *supported_framerates; ///< array of supported framerates, or NULL if any, array is terminated by {0,0}
3411 const enum AVPixelFormat *pix_fmts; ///< array of supported pixel formats, or NULL if unknown, array is terminated by -1
3412 const int *supported_samplerates; ///< array of supported audio samplerates, or NULL if unknown, array is terminated by 0
3413 const enum AVSampleFormat *sample_fmts; ///< array of supported sample formats, or NULL if unknown, array is terminated by -1
3414 const uint64_t *channel_layouts; ///< array of support channel layouts, or NULL if unknown. array is terminated by 0
3415 uint8_t max_lowres; ///< maximum value for lowres supported by the decoder
3416 const AVClass *priv_class; ///< AVClass for the private context
3417 const AVProfile *profiles; ///< array of recognized profiles, or NULL if unknown, array is terminated by {FF_PROFILE_UNKNOWN}
3420 * Group name of the codec implementation.
3421 * This is a short symbolic name of the wrapper backing this codec. A
3422 * wrapper uses some kind of external implementation for the codec, such
3423 * as an external library, or a codec implementation provided by the OS or
3425 * If this field is NULL, this is a builtin, libavcodec native codec.
3426 * If non-NULL, this will be the suffix in AVCodec.name in most cases
3427 * (usually AVCodec.name will be of the form "<codec_name>_<wrapper_name>").
3429 const char *wrapper_name;
3431 /*****************************************************************
3432 * No fields below this line are part of the public API. They
3433 * may not be used outside of libavcodec and can be changed and
3435 * New public fields should be added right above.
3436 *****************************************************************
3439 struct AVCodec *next;
3441 * @name Frame-level threading support functions
3445 * If defined, called on thread contexts when they are created.
3446 * If the codec allocates writable tables in init(), re-allocate them here.
3447 * priv_data will be set to a copy of the original.
3449 int (*init_thread_copy)(AVCodecContext *);
3451 * Copy necessary context variables from a previous thread context to the current one.
3452 * If not defined, the next thread will start automatically; otherwise, the codec
3453 * must call ff_thread_finish_setup().
3455 * dst and src will (rarely) point to the same context, in which case memcpy should be skipped.
3457 int (*update_thread_context)(AVCodecContext *dst, const AVCodecContext *src);
3461 * Private codec-specific defaults.
3463 const AVCodecDefault *defaults;
3466 * Initialize codec static data, called from avcodec_register().
3468 * This is not intended for time consuming operations as it is
3469 * run for every codec regardless of that codec being used.
3471 void (*init_static_data)(struct AVCodec *codec);
3473 int (*init)(AVCodecContext *);
3474 int (*encode_sub)(AVCodecContext *, uint8_t *buf, int buf_size,
3475 const struct AVSubtitle *sub);
3477 * Encode data to an AVPacket.
3479 * @param avctx codec context
3480 * @param avpkt output AVPacket (may contain a user-provided buffer)
3481 * @param[in] frame AVFrame containing the raw data to be encoded
3482 * @param[out] got_packet_ptr encoder sets to 0 or 1 to indicate that a
3483 * non-empty packet was returned in avpkt.
3484 * @return 0 on success, negative error code on failure
3486 int (*encode2)(AVCodecContext *avctx, AVPacket *avpkt, const AVFrame *frame,
3487 int *got_packet_ptr);
3488 int (*decode)(AVCodecContext *, void *outdata, int *outdata_size, AVPacket *avpkt);
3489 int (*close)(AVCodecContext *);
3491 * Encode API with decoupled packet/frame dataflow. The API is the
3492 * same as the avcodec_ prefixed APIs (avcodec_send_frame() etc.), except
3494 * - never called if the codec is closed or the wrong type,
3495 * - if AV_CODEC_CAP_DELAY is not set, drain frames are never sent,
3496 * - only one drain frame is ever passed down,
3498 int (*send_frame)(AVCodecContext *avctx, const AVFrame *frame);
3499 int (*receive_packet)(AVCodecContext *avctx, AVPacket *avpkt);
3502 * Decode API with decoupled packet/frame dataflow. This function is called
3503 * to get one output frame. It should call ff_decode_get_packet() to obtain
3506 int (*receive_frame)(AVCodecContext *avctx, AVFrame *frame);
3509 * Will be called when seeking
3511 void (*flush)(AVCodecContext *);
3513 * Internal codec capabilities.
3514 * See FF_CODEC_CAP_* in internal.h
3519 * Decoding only, a comma-separated list of bitstream filters to apply to
3520 * packets before decoding.
3525 * Array of pointers to hardware configurations supported by the codec,
3526 * or NULL if no hardware supported. The array is terminated by a NULL
3529 * The user can only access this field via avcodec_get_hw_config().
3531 const struct AVCodecHWConfigInternal **hw_configs;
3534 #if FF_API_CODEC_GET_SET
3535 attribute_deprecated
3536 int av_codec_get_max_lowres(const AVCodec *codec);
3539 struct MpegEncContext;
3542 * Retrieve supported hardware configurations for a codec.
3544 * Values of index from zero to some maximum return the indexed configuration
3545 * descriptor; all other values return NULL. If the codec does not support
3546 * any hardware configurations then it will always return NULL.
3548 const AVCodecHWConfig *avcodec_get_hw_config(const AVCodec *codec, int index);
3551 * @defgroup lavc_hwaccel AVHWAccel
3553 * @note Nothing in this structure should be accessed by the user. At some
3554 * point in future it will not be externally visible at all.
3558 typedef struct AVHWAccel {
3560 * Name of the hardware accelerated codec.
3561 * The name is globally unique among encoders and among decoders (but an
3562 * encoder and a decoder can share the same name).
3567 * Type of codec implemented by the hardware accelerator.
3569 * See AVMEDIA_TYPE_xxx
3571 enum AVMediaType type;
3574 * Codec implemented by the hardware accelerator.
3576 * See AV_CODEC_ID_xxx
3581 * Supported pixel format.
3583 * Only hardware accelerated formats are supported here.
3585 enum AVPixelFormat pix_fmt;
3588 * Hardware accelerated codec capabilities.
3589 * see AV_HWACCEL_CODEC_CAP_*
3593 /*****************************************************************
3594 * No fields below this line are part of the public API. They
3595 * may not be used outside of libavcodec and can be changed and
3597 * New public fields should be added right above.
3598 *****************************************************************
3602 * Allocate a custom buffer
3604 int (*alloc_frame)(AVCodecContext *avctx, AVFrame *frame);
3607 * Called at the beginning of each frame or field picture.
3609 * Meaningful frame information (codec specific) is guaranteed to
3610 * be parsed at this point. This function is mandatory.
3612 * Note that buf can be NULL along with buf_size set to 0.
3613 * Otherwise, this means the whole frame is available at this point.
3615 * @param avctx the codec context
3616 * @param buf the frame data buffer base
3617 * @param buf_size the size of the frame in bytes
3618 * @return zero if successful, a negative value otherwise
3620 int (*start_frame)(AVCodecContext *avctx, const uint8_t *buf, uint32_t buf_size);
3623 * Callback for parameter data (SPS/PPS/VPS etc).
3625 * Useful for hardware decoders which keep persistent state about the
3626 * video parameters, and need to receive any changes to update that state.
3628 * @param avctx the codec context
3629 * @param type the nal unit type
3630 * @param buf the nal unit data buffer
3631 * @param buf_size the size of the nal unit in bytes
3632 * @return zero if successful, a negative value otherwise
3634 int (*decode_params)(AVCodecContext *avctx, int type, const uint8_t *buf, uint32_t buf_size);
3637 * Callback for each slice.
3639 * Meaningful slice information (codec specific) is guaranteed to
3640 * be parsed at this point. This function is mandatory.
3641 * The only exception is XvMC, that works on MB level.
3643 * @param avctx the codec context
3644 * @param buf the slice data buffer base
3645 * @param buf_size the size of the slice in bytes
3646 * @return zero if successful, a negative value otherwise
3648 int (*decode_slice)(AVCodecContext *avctx, const uint8_t *buf, uint32_t buf_size);
3651 * Called at the end of each frame or field picture.
3653 * The whole picture is parsed at this point and can now be sent
3654 * to the hardware accelerator. This function is mandatory.
3656 * @param avctx the codec context
3657 * @return zero if successful, a negative value otherwise
3659 int (*end_frame)(AVCodecContext *avctx);
3662 * Size of per-frame hardware accelerator private data.
3664 * Private data is allocated with av_mallocz() before
3665 * AVCodecContext.get_buffer() and deallocated after
3666 * AVCodecContext.release_buffer().
3668 int frame_priv_data_size;
3671 * Called for every Macroblock in a slice.
3673 * XvMC uses it to replace the ff_mpv_reconstruct_mb().
3674 * Instead of decoding to raw picture, MB parameters are
3675 * stored in an array provided by the video driver.
3677 * @param s the mpeg context
3679 void (*decode_mb)(struct MpegEncContext *s);
3682 * Initialize the hwaccel private data.
3684 * This will be called from ff_get_format(), after hwaccel and
3685 * hwaccel_context are set and the hwaccel private data in AVCodecInternal
3688 int (*init)(AVCodecContext *avctx);
3691 * Uninitialize the hwaccel private data.
3693 * This will be called from get_format() or avcodec_close(), after hwaccel
3694 * and hwaccel_context are already uninitialized.
3696 int (*uninit)(AVCodecContext *avctx);
3699 * Size of the private data to allocate in
3700 * AVCodecInternal.hwaccel_priv_data.
3705 * Internal hwaccel capabilities.
3710 * Fill the given hw_frames context with current codec parameters. Called
3711 * from get_format. Refer to avcodec_get_hw_frames_parameters() for
3714 * This CAN be called before AVHWAccel.init is called, and you must assume
3715 * that avctx->hwaccel_priv_data is invalid.
3717 int (*frame_params)(AVCodecContext *avctx, AVBufferRef *hw_frames_ctx);
3721 * HWAccel is experimental and is thus avoided in favor of non experimental
3724 #define AV_HWACCEL_CODEC_CAP_EXPERIMENTAL 0x0200
3727 * Hardware acceleration should be used for decoding even if the codec level
3728 * used is unknown or higher than the maximum supported level reported by the
3731 * It's generally a good idea to pass this flag unless you have a specific
3732 * reason not to, as hardware tends to under-report supported levels.
3734 #define AV_HWACCEL_FLAG_IGNORE_LEVEL (1 << 0)
3737 * Hardware acceleration can output YUV pixel formats with a different chroma
3738 * sampling than 4:2:0 and/or other than 8 bits per component.
3740 #define AV_HWACCEL_FLAG_ALLOW_HIGH_DEPTH (1 << 1)
3743 * Hardware acceleration should still be attempted for decoding when the
3744 * codec profile does not match the reported capabilities of the hardware.
3746 * For example, this can be used to try to decode baseline profile H.264
3747 * streams in hardware - it will often succeed, because many streams marked
3748 * as baseline profile actually conform to constrained baseline profile.
3750 * @warning If the stream is actually not supported then the behaviour is
3751 * undefined, and may include returning entirely incorrect output
3752 * while indicating success.
3754 #define AV_HWACCEL_FLAG_ALLOW_PROFILE_MISMATCH (1 << 2)
3760 #if FF_API_AVPICTURE
3762 * @defgroup lavc_picture AVPicture
3764 * Functions for working with AVPicture
3769 * Picture data structure.
3771 * Up to four components can be stored into it, the last component is
3773 * @deprecated use AVFrame or imgutils functions instead
3775 typedef struct AVPicture {
3776 attribute_deprecated
3777 uint8_t *data[AV_NUM_DATA_POINTERS]; ///< pointers to the image data planes
3778 attribute_deprecated
3779 int linesize[AV_NUM_DATA_POINTERS]; ///< number of bytes per line
3787 enum AVSubtitleType {
3790 SUBTITLE_BITMAP, ///< A bitmap, pict will be set
3793 * Plain text, the text field must be set by the decoder and is
3794 * authoritative. ass and pict fields may contain approximations.
3799 * Formatted text, the ass field must be set by the decoder and is
3800 * authoritative. pict and text fields may contain approximations.
3805 #define AV_SUBTITLE_FLAG_FORCED 0x00000001
3807 typedef struct AVSubtitleRect {
3808 int x; ///< top left corner of pict, undefined when pict is not set
3809 int y; ///< top left corner of pict, undefined when pict is not set
3810 int w; ///< width of pict, undefined when pict is not set
3811 int h; ///< height of pict, undefined when pict is not set
3812 int nb_colors; ///< number of colors in pict, undefined when pict is not set
3814 #if FF_API_AVPICTURE
3816 * @deprecated unused
3818 attribute_deprecated
3822 * data+linesize for the bitmap of this subtitle.
3823 * Can be set for text/ass as well once they are rendered.
3828 enum AVSubtitleType type;
3830 char *text; ///< 0 terminated plain UTF-8 text
3833 * 0 terminated ASS/SSA compatible event line.
3834 * The presentation of this is unaffected by the other values in this
3842 typedef struct AVSubtitle {
3843 uint16_t format; /* 0 = graphics */
3844 uint32_t start_display_time; /* relative to packet pts, in ms */
3845 uint32_t end_display_time; /* relative to packet pts, in ms */
3847 AVSubtitleRect **rects;
3848 int64_t pts; ///< Same as packet pts, in AV_TIME_BASE
3852 * This struct describes the properties of an encoded stream.
3854 * sizeof(AVCodecParameters) is not a part of the public ABI, this struct must
3855 * be allocated with avcodec_parameters_alloc() and freed with
3856 * avcodec_parameters_free().
3858 typedef struct AVCodecParameters {
3860 * General type of the encoded data.
3862 enum AVMediaType codec_type;
3864 * Specific type of the encoded data (the codec used).
3866 enum AVCodecID codec_id;
3868 * Additional information about the codec (corresponds to the AVI FOURCC).
3873 * Extra binary data needed for initializing the decoder, codec-dependent.
3875 * Must be allocated with av_malloc() and will be freed by
3876 * avcodec_parameters_free(). The allocated size of extradata must be at
3877 * least extradata_size + AV_INPUT_BUFFER_PADDING_SIZE, with the padding
3882 * Size of the extradata content in bytes.
3887 * - video: the pixel format, the value corresponds to enum AVPixelFormat.
3888 * - audio: the sample format, the value corresponds to enum AVSampleFormat.
3893 * The average bitrate of the encoded data (in bits per second).
3898 * The number of bits per sample in the codedwords.
3900 * This is basically the bitrate per sample. It is mandatory for a bunch of
3901 * formats to actually decode them. It's the number of bits for one sample in
3902 * the actual coded bitstream.
3904 * This could be for example 4 for ADPCM
3905 * For PCM formats this matches bits_per_raw_sample
3908 int bits_per_coded_sample;
3911 * This is the number of valid bits in each output sample. If the
3912 * sample format has more bits, the least significant bits are additional
3913 * padding bits, which are always 0. Use right shifts to reduce the sample
3914 * to its actual size. For example, audio formats with 24 bit samples will
3915 * have bits_per_raw_sample set to 24, and format set to AV_SAMPLE_FMT_S32.
3916 * To get the original sample use "(int32_t)sample >> 8"."
3918 * For ADPCM this might be 12 or 16 or similar
3921 int bits_per_raw_sample;
3924 * Codec-specific bitstream restrictions that the stream conforms to.
3930 * Video only. The dimensions of the video frame in pixels.
3936 * Video only. The aspect ratio (width / height) which a single pixel
3937 * should have when displayed.
3939 * When the aspect ratio is unknown / undefined, the numerator should be
3940 * set to 0 (the denominator may have any value).
3942 AVRational sample_aspect_ratio;
3945 * Video only. The order of the fields in interlaced video.
3947 enum AVFieldOrder field_order;
3950 * Video only. Additional colorspace characteristics.
3952 enum AVColorRange color_range;
3953 enum AVColorPrimaries color_primaries;
3954 enum AVColorTransferCharacteristic color_trc;
3955 enum AVColorSpace color_space;
3956 enum AVChromaLocation chroma_location;
3959 * Video only. Number of delayed frames.
3964 * Audio only. The channel layout bitmask. May be 0 if the channel layout is
3965 * unknown or unspecified, otherwise the number of bits set must be equal to
3966 * the channels field.
3968 uint64_t channel_layout;
3970 * Audio only. The number of audio channels.
3974 * Audio only. The number of audio samples per second.
3978 * Audio only. The number of bytes per coded audio frame, required by some
3981 * Corresponds to nBlockAlign in WAVEFORMATEX.
3985 * Audio only. Audio frame size, if known. Required by some formats to be static.
3990 * Audio only. The amount of padding (in samples) inserted by the encoder at
3991 * the beginning of the audio. I.e. this number of leading decoded samples
3992 * must be discarded by the caller to get the original audio without leading
3995 int initial_padding;
3997 * Audio only. The amount of padding (in samples) appended by the encoder to
3998 * the end of the audio. I.e. this number of decoded samples must be
3999 * discarded by the caller from the end of the stream to get the original
4000 * audio without any trailing padding.
4002 int trailing_padding;
4004 * Audio only. Number of samples to skip after a discontinuity.
4007 } AVCodecParameters;
4010 * Iterate over all registered codecs.
4012 * @param opaque a pointer where libavcodec will store the iteration state. Must
4013 * point to NULL to start the iteration.
4015 * @return the next registered codec or NULL when the iteration is
4018 const AVCodec *av_codec_iterate(void **opaque);
4022 * If c is NULL, returns the first registered codec,
4023 * if c is non-NULL, returns the next registered codec after c,
4024 * or NULL if c is the last one.
4026 attribute_deprecated
4027 AVCodec *av_codec_next(const AVCodec *c);
4031 * Return the LIBAVCODEC_VERSION_INT constant.
4033 unsigned avcodec_version(void);
4036 * Return the libavcodec build-time configuration.
4038 const char *avcodec_configuration(void);
4041 * Return the libavcodec license.
4043 const char *avcodec_license(void);
4047 * Register the codec codec and initialize libavcodec.
4049 * @warning either this function or avcodec_register_all() must be called
4050 * before any other libavcodec functions.
4052 * @see avcodec_register_all()
4054 attribute_deprecated
4055 void avcodec_register(AVCodec *codec);
4058 * Register all the codecs, parsers and bitstream filters which were enabled at
4059 * configuration time. If you do not call this function you can select exactly
4060 * which formats you want to support, by using the individual registration
4063 * @see avcodec_register
4064 * @see av_register_codec_parser
4065 * @see av_register_bitstream_filter
4067 attribute_deprecated
4068 void avcodec_register_all(void);
4072 * Allocate an AVCodecContext and set its fields to default values. The
4073 * resulting struct should be freed with avcodec_free_context().
4075 * @param codec if non-NULL, allocate private data and initialize defaults
4076 * for the given codec. It is illegal to then call avcodec_open2()
4077 * with a different codec.
4078 * If NULL, then the codec-specific defaults won't be initialized,
4079 * which may result in suboptimal default settings (this is
4080 * important mainly for encoders, e.g. libx264).
4082 * @return An AVCodecContext filled with default values or NULL on failure.
4084 AVCodecContext *avcodec_alloc_context3(const AVCodec *codec);
4087 * Free the codec context and everything associated with it and write NULL to
4088 * the provided pointer.
4090 void avcodec_free_context(AVCodecContext **avctx);
4092 #if FF_API_GET_CONTEXT_DEFAULTS
4094 * @deprecated This function should not be used, as closing and opening a codec
4095 * context multiple time is not supported. A new codec context should be
4096 * allocated for each new use.
4098 int avcodec_get_context_defaults3(AVCodecContext *s, const AVCodec *codec);
4102 * Get the AVClass for AVCodecContext. It can be used in combination with
4103 * AV_OPT_SEARCH_FAKE_OBJ for examining options.
4105 * @see av_opt_find().
4107 const AVClass *avcodec_get_class(void);
4109 #if FF_API_COPY_CONTEXT
4111 * Get the AVClass for AVFrame. It can be used in combination with
4112 * AV_OPT_SEARCH_FAKE_OBJ for examining options.
4114 * @see av_opt_find().
4116 const AVClass *avcodec_get_frame_class(void);
4119 * Get the AVClass for AVSubtitleRect. It can be used in combination with
4120 * AV_OPT_SEARCH_FAKE_OBJ for examining options.
4122 * @see av_opt_find().
4124 const AVClass *avcodec_get_subtitle_rect_class(void);
4127 * Copy the settings of the source AVCodecContext into the destination
4128 * AVCodecContext. The resulting destination codec context will be
4129 * unopened, i.e. you are required to call avcodec_open2() before you
4130 * can use this AVCodecContext to decode/encode video/audio data.
4132 * @param dest target codec context, should be initialized with
4133 * avcodec_alloc_context3(NULL), but otherwise uninitialized
4134 * @param src source codec context
4135 * @return AVERROR() on error (e.g. memory allocation error), 0 on success
4137 * @deprecated The semantics of this function are ill-defined and it should not
4138 * be used. If you need to transfer the stream parameters from one codec context
4139 * to another, use an intermediate AVCodecParameters instance and the
4140 * avcodec_parameters_from_context() / avcodec_parameters_to_context()
4143 attribute_deprecated
4144 int avcodec_copy_context(AVCodecContext *dest, const AVCodecContext *src);
4148 * Allocate a new AVCodecParameters and set its fields to default values
4149 * (unknown/invalid/0). The returned struct must be freed with
4150 * avcodec_parameters_free().
4152 AVCodecParameters *avcodec_parameters_alloc(void);
4155 * Free an AVCodecParameters instance and everything associated with it and
4156 * write NULL to the supplied pointer.
4158 void avcodec_parameters_free(AVCodecParameters **par);
4161 * Copy the contents of src to dst. Any allocated fields in dst are freed and
4162 * replaced with newly allocated duplicates of the corresponding fields in src.
4164 * @return >= 0 on success, a negative AVERROR code on failure.
4166 int avcodec_parameters_copy(AVCodecParameters *dst, const AVCodecParameters *src);
4169 * Fill the parameters struct based on the values from the supplied codec
4170 * context. Any allocated fields in par are freed and replaced with duplicates
4171 * of the corresponding fields in codec.
4173 * @return >= 0 on success, a negative AVERROR code on failure
4175 int avcodec_parameters_from_context(AVCodecParameters *par,
4176 const AVCodecContext *codec);
4179 * Fill the codec context based on the values from the supplied codec
4180 * parameters. Any allocated fields in codec that have a corresponding field in
4181 * par are freed and replaced with duplicates of the corresponding field in par.
4182 * Fields in codec that do not have a counterpart in par are not touched.
4184 * @return >= 0 on success, a negative AVERROR code on failure.
4186 int avcodec_parameters_to_context(AVCodecContext *codec,
4187 const AVCodecParameters *par);
4190 * Initialize the AVCodecContext to use the given AVCodec. Prior to using this
4191 * function the context has to be allocated with avcodec_alloc_context3().
4193 * The functions avcodec_find_decoder_by_name(), avcodec_find_encoder_by_name(),
4194 * avcodec_find_decoder() and avcodec_find_encoder() provide an easy way for
4195 * retrieving a codec.
4197 * @warning This function is not thread safe!
4199 * @note Always call this function before using decoding routines (such as
4200 * @ref avcodec_receive_frame()).
4203 * avcodec_register_all();
4204 * av_dict_set(&opts, "b", "2.5M", 0);
4205 * codec = avcodec_find_decoder(AV_CODEC_ID_H264);
4209 * context = avcodec_alloc_context3(codec);
4211 * if (avcodec_open2(context, codec, opts) < 0)
4215 * @param avctx The context to initialize.
4216 * @param codec The codec to open this context for. If a non-NULL codec has been
4217 * previously passed to avcodec_alloc_context3() or
4218 * for this context, then this parameter MUST be either NULL or
4219 * equal to the previously passed codec.
4220 * @param options A dictionary filled with AVCodecContext and codec-private options.
4221 * On return this object will be filled with options that were not found.
4223 * @return zero on success, a negative value on error
4224 * @see avcodec_alloc_context3(), avcodec_find_decoder(), avcodec_find_encoder(),
4225 * av_dict_set(), av_opt_find().
4227 int avcodec_open2(AVCodecContext *avctx, const AVCodec *codec, AVDictionary **options);
4230 * Close a given AVCodecContext and free all the data associated with it
4231 * (but not the AVCodecContext itself).
4233 * Calling this function on an AVCodecContext that hasn't been opened will free
4234 * the codec-specific data allocated in avcodec_alloc_context3() with a non-NULL
4235 * codec. Subsequent calls will do nothing.
4237 * @note Do not use this function. Use avcodec_free_context() to destroy a
4238 * codec context (either open or closed). Opening and closing a codec context
4239 * multiple times is not supported anymore -- use multiple codec contexts
4242 int avcodec_close(AVCodecContext *avctx);
4245 * Free all allocated data in the given subtitle struct.
4247 * @param sub AVSubtitle to free.
4249 void avsubtitle_free(AVSubtitle *sub);
4256 * @addtogroup lavc_packet
4261 * Allocate an AVPacket and set its fields to default values. The resulting
4262 * struct must be freed using av_packet_free().
4264 * @return An AVPacket filled with default values or NULL on failure.
4266 * @note this only allocates the AVPacket itself, not the data buffers. Those
4267 * must be allocated through other means such as av_new_packet.
4269 * @see av_new_packet
4271 AVPacket *av_packet_alloc(void);
4274 * Create a new packet that references the same data as src.
4276 * This is a shortcut for av_packet_alloc()+av_packet_ref().
4278 * @return newly created AVPacket on success, NULL on error.
4280 * @see av_packet_alloc
4281 * @see av_packet_ref
4283 AVPacket *av_packet_clone(const AVPacket *src);
4286 * Free the packet, if the packet is reference counted, it will be
4287 * unreferenced first.
4289 * @param pkt packet to be freed. The pointer will be set to NULL.
4290 * @note passing NULL is a no-op.
4292 void av_packet_free(AVPacket **pkt);
4295 * Initialize optional fields of a packet with default values.
4297 * Note, this does not touch the data and size members, which have to be
4298 * initialized separately.
4302 void av_init_packet(AVPacket *pkt);
4305 * Allocate the payload of a packet and initialize its fields with
4309 * @param size wanted payload size
4310 * @return 0 if OK, AVERROR_xxx otherwise
4312 int av_new_packet(AVPacket *pkt, int size);
4315 * Reduce packet size, correctly zeroing padding
4318 * @param size new size
4320 void av_shrink_packet(AVPacket *pkt, int size);
4323 * Increase packet size, correctly zeroing padding
4326 * @param grow_by number of bytes by which to increase the size of the packet
4328 int av_grow_packet(AVPacket *pkt, int grow_by);
4331 * Initialize a reference-counted packet from av_malloc()ed data.
4333 * @param pkt packet to be initialized. This function will set the data, size,
4334 * buf and destruct fields, all others are left untouched.
4335 * @param data Data allocated by av_malloc() to be used as packet data. If this
4336 * function returns successfully, the data is owned by the underlying AVBuffer.
4337 * The caller may not access the data through other means.
4338 * @param size size of data in bytes, without the padding. I.e. the full buffer
4339 * size is assumed to be size + AV_INPUT_BUFFER_PADDING_SIZE.
4341 * @return 0 on success, a negative AVERROR on error
4343 int av_packet_from_data(AVPacket *pkt, uint8_t *data, int size);
4345 #if FF_API_AVPACKET_OLD_API
4347 * @warning This is a hack - the packet memory allocation stuff is broken. The
4348 * packet is allocated if it was not really allocated.
4350 * @deprecated Use av_packet_ref
4352 attribute_deprecated
4353 int av_dup_packet(AVPacket *pkt);
4355 * Copy packet, including contents
4357 * @return 0 on success, negative AVERROR on fail
4359 * @deprecated Use av_packet_ref
4361 attribute_deprecated
4362 int av_copy_packet(AVPacket *dst, const AVPacket *src);
4365 * Copy packet side data
4367 * @return 0 on success, negative AVERROR on fail
4369 * @deprecated Use av_packet_copy_props
4371 attribute_deprecated
4372 int av_copy_packet_side_data(AVPacket *dst, const AVPacket *src);
4377 * @deprecated Use av_packet_unref
4379 * @param pkt packet to free
4381 attribute_deprecated
4382 void av_free_packet(AVPacket *pkt);
4385 * Allocate new information of a packet.
4388 * @param type side information type
4389 * @param size side information size
4390 * @return pointer to fresh allocated data or NULL otherwise
4392 uint8_t* av_packet_new_side_data(AVPacket *pkt, enum AVPacketSideDataType type,
4396 * Wrap an existing array as a packet side data.
4399 * @param type side information type
4400 * @param data the side data array. It must be allocated with the av_malloc()
4401 * family of functions. The ownership of the data is transferred to
4403 * @param size side information size
4404 * @return a non-negative number on success, a negative AVERROR code on
4405 * failure. On failure, the packet is unchanged and the data remains
4406 * owned by the caller.
4408 int av_packet_add_side_data(AVPacket *pkt, enum AVPacketSideDataType type,
4409 uint8_t *data, size_t size);
4412 * Shrink the already allocated side data buffer
4415 * @param type side information type
4416 * @param size new side information size
4417 * @return 0 on success, < 0 on failure
4419 int av_packet_shrink_side_data(AVPacket *pkt, enum AVPacketSideDataType type,
4423 * Get side information from packet.
4426 * @param type desired side information type
4427 * @param size pointer for side information size to store (optional)
4428 * @return pointer to data if present or NULL otherwise
4430 uint8_t* av_packet_get_side_data(const AVPacket *pkt, enum AVPacketSideDataType type,
4433 #if FF_API_MERGE_SD_API
4434 attribute_deprecated
4435 int av_packet_merge_side_data(AVPacket *pkt);
4437 attribute_deprecated
4438 int av_packet_split_side_data(AVPacket *pkt);
4441 const char *av_packet_side_data_name(enum AVPacketSideDataType type);
4444 * Pack a dictionary for use in side_data.
4446 * @param dict The dictionary to pack.
4447 * @param size pointer to store the size of the returned data
4448 * @return pointer to data if successful, NULL otherwise
4450 uint8_t *av_packet_pack_dictionary(AVDictionary *dict, int *size);
4452 * Unpack a dictionary from side_data.
4454 * @param data data from side_data
4455 * @param size size of the data
4456 * @param dict the metadata storage dictionary
4457 * @return 0 on success, < 0 on failure
4459 int av_packet_unpack_dictionary(const uint8_t *data, int size, AVDictionary **dict);
4463 * Convenience function to free all the side data stored.
4464 * All the other fields stay untouched.
4468 void av_packet_free_side_data(AVPacket *pkt);
4471 * Setup a new reference to the data described by a given packet
4473 * If src is reference-counted, setup dst as a new reference to the
4474 * buffer in src. Otherwise allocate a new buffer in dst and copy the
4475 * data from src into it.
4477 * All the other fields are copied from src.
4479 * @see av_packet_unref
4481 * @param dst Destination packet
4482 * @param src Source packet
4484 * @return 0 on success, a negative AVERROR on error.
4486 int av_packet_ref(AVPacket *dst, const AVPacket *src);
4491 * Unreference the buffer referenced by the packet and reset the
4492 * remaining packet fields to their default values.
4494 * @param pkt The packet to be unreferenced.
4496 void av_packet_unref(AVPacket *pkt);
4499 * Move every field in src to dst and reset src.
4501 * @see av_packet_unref
4503 * @param src Source packet, will be reset
4504 * @param dst Destination packet
4506 void av_packet_move_ref(AVPacket *dst, AVPacket *src);
4509 * Copy only "properties" fields from src to dst.
4511 * Properties for the purpose of this function are all the fields
4512 * beside those related to the packet data (buf, data, size)
4514 * @param dst Destination packet
4515 * @param src Source packet
4517 * @return 0 on success AVERROR on failure.
4519 int av_packet_copy_props(AVPacket *dst, const AVPacket *src);
4522 * Convert valid timing fields (timestamps / durations) in a packet from one
4523 * timebase to another. Timestamps with unknown values (AV_NOPTS_VALUE) will be
4526 * @param pkt packet on which the conversion will be performed
4527 * @param tb_src source timebase, in which the timing fields in pkt are
4529 * @param tb_dst destination timebase, to which the timing fields will be
4532 void av_packet_rescale_ts(AVPacket *pkt, AVRational tb_src, AVRational tb_dst);
4539 * @addtogroup lavc_decoding
4544 * Find a registered decoder with a matching codec ID.
4546 * @param id AVCodecID of the requested decoder
4547 * @return A decoder if one was found, NULL otherwise.
4549 AVCodec *avcodec_find_decoder(enum AVCodecID id);
4552 * Find a registered decoder with the specified name.
4554 * @param name name of the requested decoder
4555 * @return A decoder if one was found, NULL otherwise.
4557 AVCodec *avcodec_find_decoder_by_name(const char *name);
4560 * The default callback for AVCodecContext.get_buffer2(). It is made public so
4561 * it can be called by custom get_buffer2() implementations for decoders without
4562 * AV_CODEC_CAP_DR1 set.
4564 int avcodec_default_get_buffer2(AVCodecContext *s, AVFrame *frame, int flags);
4567 * Modify width and height values so that they will result in a memory
4568 * buffer that is acceptable for the codec if you do not use any horizontal
4571 * May only be used if a codec with AV_CODEC_CAP_DR1 has been opened.
4573 void avcodec_align_dimensions(AVCodecContext *s, int *width, int *height);
4576 * Modify width and height values so that they will result in a memory
4577 * buffer that is acceptable for the codec if you also ensure that all
4578 * line sizes are a multiple of the respective linesize_align[i].
4580 * May only be used if a codec with AV_CODEC_CAP_DR1 has been opened.
4582 void avcodec_align_dimensions2(AVCodecContext *s, int *width, int *height,
4583 int linesize_align[AV_NUM_DATA_POINTERS]);
4586 * Converts AVChromaLocation to swscale x/y chroma position.
4588 * The positions represent the chroma (0,0) position in a coordinates system
4589 * with luma (0,0) representing the origin and luma(1,1) representing 256,256
4591 * @param xpos horizontal chroma sample position
4592 * @param ypos vertical chroma sample position
4594 int avcodec_enum_to_chroma_pos(int *xpos, int *ypos, enum AVChromaLocation pos);
4597 * Converts swscale x/y chroma position to AVChromaLocation.
4599 * The positions represent the chroma (0,0) position in a coordinates system
4600 * with luma (0,0) representing the origin and luma(1,1) representing 256,256
4602 * @param xpos horizontal chroma sample position
4603 * @param ypos vertical chroma sample position
4605 enum AVChromaLocation avcodec_chroma_pos_to_enum(int xpos, int ypos);
4608 * Decode the audio frame of size avpkt->size from avpkt->data into frame.
4610 * Some decoders may support multiple frames in a single AVPacket. Such
4611 * decoders would then just decode the first frame and the return value would be
4612 * less than the packet size. In this case, avcodec_decode_audio4 has to be
4613 * called again with an AVPacket containing the remaining data in order to
4614 * decode the second frame, etc... Even if no frames are returned, the packet
4615 * needs to be fed to the decoder with remaining data until it is completely
4616 * consumed or an error occurs.
4618 * Some decoders (those marked with AV_CODEC_CAP_DELAY) have a delay between input
4619 * and output. This means that for some packets they will not immediately
4620 * produce decoded output and need to be flushed at the end of decoding to get
4621 * all the decoded data. Flushing is done by calling this function with packets
4622 * with avpkt->data set to NULL and avpkt->size set to 0 until it stops
4623 * returning samples. It is safe to flush even those decoders that are not
4624 * marked with AV_CODEC_CAP_DELAY, then no samples will be returned.
4626 * @warning The input buffer, avpkt->data must be AV_INPUT_BUFFER_PADDING_SIZE
4627 * larger than the actual read bytes because some optimized bitstream
4628 * readers read 32 or 64 bits at once and could read over the end.
4630 * @note The AVCodecContext MUST have been opened with @ref avcodec_open2()
4631 * before packets may be fed to the decoder.
4633 * @param avctx the codec context
4634 * @param[out] frame The AVFrame in which to store decoded audio samples.
4635 * The decoder will allocate a buffer for the decoded frame by
4636 * calling the AVCodecContext.get_buffer2() callback.
4637 * When AVCodecContext.refcounted_frames is set to 1, the frame is
4638 * reference counted and the returned reference belongs to the
4639 * caller. The caller must release the frame using av_frame_unref()
4640 * when the frame is no longer needed. The caller may safely write
4641 * to the frame if av_frame_is_writable() returns 1.
4642 * When AVCodecContext.refcounted_frames is set to 0, the returned
4643 * reference belongs to the decoder and is valid only until the
4644 * next call to this function or until closing or flushing the
4645 * decoder. The caller may not write to it.
4646 * @param[out] got_frame_ptr Zero if no frame could be decoded, otherwise it is
4647 * non-zero. Note that this field being set to zero
4648 * does not mean that an error has occurred. For
4649 * decoders with AV_CODEC_CAP_DELAY set, no given decode
4650 * call is guaranteed to produce a frame.
4651 * @param[in] avpkt The input AVPacket containing the input buffer.
4652 * At least avpkt->data and avpkt->size should be set. Some
4653 * decoders might also require additional fields to be set.
4654 * @return A negative error code is returned if an error occurred during
4655 * decoding, otherwise the number of bytes consumed from the input
4656 * AVPacket is returned.
4658 * @deprecated Use avcodec_send_packet() and avcodec_receive_frame().
4660 attribute_deprecated
4661 int avcodec_decode_audio4(AVCodecContext *avctx, AVFrame *frame,
4662 int *got_frame_ptr, const AVPacket *avpkt);
4665 * Decode the video frame of size avpkt->size from avpkt->data into picture.
4666 * Some decoders may support multiple frames in a single AVPacket, such
4667 * decoders would then just decode the first frame.
4669 * @warning The input buffer must be AV_INPUT_BUFFER_PADDING_SIZE larger than
4670 * the actual read bytes because some optimized bitstream readers read 32 or 64
4671 * bits at once and could read over the end.
4673 * @warning The end of the input buffer buf should be set to 0 to ensure that
4674 * no overreading happens for damaged MPEG streams.
4676 * @note Codecs which have the AV_CODEC_CAP_DELAY capability set have a delay
4677 * between input and output, these need to be fed with avpkt->data=NULL,
4678 * avpkt->size=0 at the end to return the remaining frames.
4680 * @note The AVCodecContext MUST have been opened with @ref avcodec_open2()
4681 * before packets may be fed to the decoder.
4683 * @param avctx the codec context
4684 * @param[out] picture The AVFrame in which the decoded video frame will be stored.
4685 * Use av_frame_alloc() to get an AVFrame. The codec will
4686 * allocate memory for the actual bitmap by calling the
4687 * AVCodecContext.get_buffer2() callback.
4688 * When AVCodecContext.refcounted_frames is set to 1, the frame is
4689 * reference counted and the returned reference belongs to the
4690 * caller. The caller must release the frame using av_frame_unref()
4691 * when the frame is no longer needed. The caller may safely write
4692 * to the frame if av_frame_is_writable() returns 1.
4693 * When AVCodecContext.refcounted_frames is set to 0, the returned
4694 * reference belongs to the decoder and is valid only until the
4695 * next call to this function or until closing or flushing the
4696 * decoder. The caller may not write to it.
4698 * @param[in] avpkt The input AVPacket containing the input buffer.
4699 * You can create such packet with av_init_packet() and by then setting
4700 * data and size, some decoders might in addition need other fields like
4701 * flags&AV_PKT_FLAG_KEY. All decoders are designed to use the least
4703 * @param[in,out] got_picture_ptr Zero if no frame could be decompressed, otherwise, it is nonzero.
4704 * @return On error a negative value is returned, otherwise the number of bytes
4705 * used or zero if no frame could be decompressed.
4707 * @deprecated Use avcodec_send_packet() and avcodec_receive_frame().
4709 attribute_deprecated
4710 int avcodec_decode_video2(AVCodecContext *avctx, AVFrame *picture,
4711 int *got_picture_ptr,
4712 const AVPacket *avpkt);
4715 * Decode a subtitle message.
4716 * Return a negative value on error, otherwise return the number of bytes used.
4717 * If no subtitle could be decompressed, got_sub_ptr is zero.
4718 * Otherwise, the subtitle is stored in *sub.
4719 * Note that AV_CODEC_CAP_DR1 is not available for subtitle codecs. This is for
4720 * simplicity, because the performance difference is expect to be negligible
4721 * and reusing a get_buffer written for video codecs would probably perform badly
4722 * due to a potentially very different allocation pattern.
4724 * Some decoders (those marked with AV_CODEC_CAP_DELAY) have a delay between input
4725 * and output. This means that for some packets they will not immediately
4726 * produce decoded output and need to be flushed at the end of decoding to get
4727 * all the decoded data. Flushing is done by calling this function with packets
4728 * with avpkt->data set to NULL and avpkt->size set to 0 until it stops
4729 * returning subtitles. It is safe to flush even those decoders that are not
4730 * marked with AV_CODEC_CAP_DELAY, then no subtitles will be returned.
4732 * @note The AVCodecContext MUST have been opened with @ref avcodec_open2()
4733 * before packets may be fed to the decoder.
4735 * @param avctx the codec context
4736 * @param[out] sub The Preallocated AVSubtitle in which the decoded subtitle will be stored,
4737 * must be freed with avsubtitle_free if *got_sub_ptr is set.
4738 * @param[in,out] got_sub_ptr Zero if no subtitle could be decompressed, otherwise, it is nonzero.
4739 * @param[in] avpkt The input AVPacket containing the input buffer.
4741 int avcodec_decode_subtitle2(AVCodecContext *avctx, AVSubtitle *sub,
4746 * Supply raw packet data as input to a decoder.
4748 * Internally, this call will copy relevant AVCodecContext fields, which can
4749 * influence decoding per-packet, and apply them when the packet is actually
4750 * decoded. (For example AVCodecContext.skip_frame, which might direct the
4751 * decoder to drop the frame contained by the packet sent with this function.)
4753 * @warning The input buffer, avpkt->data must be AV_INPUT_BUFFER_PADDING_SIZE
4754 * larger than the actual read bytes because some optimized bitstream
4755 * readers read 32 or 64 bits at once and could read over the end.
4757 * @warning Do not mix this API with the legacy API (like avcodec_decode_video2())
4758 * on the same AVCodecContext. It will return unexpected results now
4759 * or in future libavcodec versions.
4761 * @note The AVCodecContext MUST have been opened with @ref avcodec_open2()
4762 * before packets may be fed to the decoder.
4764 * @param avctx codec context
4765 * @param[in] avpkt The input AVPacket. Usually, this will be a single video
4766 * frame, or several complete audio frames.
4767 * Ownership of the packet remains with the caller, and the
4768 * decoder will not write to the packet. The decoder may create
4769 * a reference to the packet data (or copy it if the packet is
4770 * not reference-counted).
4771 * Unlike with older APIs, the packet is always fully consumed,
4772 * and if it contains multiple frames (e.g. some audio codecs),
4773 * will require you to call avcodec_receive_frame() multiple
4774 * times afterwards before you can send a new packet.
4775 * It can be NULL (or an AVPacket with data set to NULL and
4776 * size set to 0); in this case, it is considered a flush
4777 * packet, which signals the end of the stream. Sending the
4778 * first flush packet will return success. Subsequent ones are
4779 * unnecessary and will return AVERROR_EOF. If the decoder
4780 * still has frames buffered, it will return them after sending
4783 * @return 0 on success, otherwise negative error code:
4784 * AVERROR(EAGAIN): input is not accepted in the current state - user
4785 * must read output with avcodec_receive_frame() (once
4786 * all output is read, the packet should be resent, and
4787 * the call will not fail with EAGAIN).
4788 * AVERROR_EOF: the decoder has been flushed, and no new packets can
4789 * be sent to it (also returned if more than 1 flush
4791 * AVERROR(EINVAL): codec not opened, it is an encoder, or requires flush
4792 * AVERROR(ENOMEM): failed to add packet to internal queue, or similar
4793 * other errors: legitimate decoding errors
4795 int avcodec_send_packet(AVCodecContext *avctx, const AVPacket *avpkt);
4798 * Return decoded output data from a decoder.
4800 * @param avctx codec context
4801 * @param frame This will be set to a reference-counted video or audio
4802 * frame (depending on the decoder type) allocated by the
4803 * decoder. Note that the function will always call
4804 * av_frame_unref(frame) before doing anything else.
4807 * 0: success, a frame was returned
4808 * AVERROR(EAGAIN): output is not available in this state - user must try
4810 * AVERROR_EOF: the decoder has been fully flushed, and there will be
4811 * no more output frames
4812 * AVERROR(EINVAL): codec not opened, or it is an encoder
4813 * other negative values: legitimate decoding errors
4815 int avcodec_receive_frame(AVCodecContext *avctx, AVFrame *frame);
4818 * Supply a raw video or audio frame to the encoder. Use avcodec_receive_packet()
4819 * to retrieve buffered output packets.
4821 * @param avctx codec context
4822 * @param[in] frame AVFrame containing the raw audio or video frame to be encoded.
4823 * Ownership of the frame remains with the caller, and the
4824 * encoder will not write to the frame. The encoder may create
4825 * a reference to the frame data (or copy it if the frame is
4826 * not reference-counted).
4827 * It can be NULL, in which case it is considered a flush
4828 * packet. This signals the end of the stream. If the encoder
4829 * still has packets buffered, it will return them after this
4830 * call. Once flushing mode has been entered, additional flush
4831 * packets are ignored, and sending frames will return
4835 * If AV_CODEC_CAP_VARIABLE_FRAME_SIZE is set, then each frame
4836 * can have any number of samples.
4837 * If it is not set, frame->nb_samples must be equal to
4838 * avctx->frame_size for all frames except the last.
4839 * The final frame may be smaller than avctx->frame_size.
4840 * @return 0 on success, otherwise negative error code:
4841 * AVERROR(EAGAIN): input is not accepted in the current state - user
4842 * must read output with avcodec_receive_packet() (once
4843 * all output is read, the packet should be resent, and
4844 * the call will not fail with EAGAIN).
4845 * AVERROR_EOF: the encoder has been flushed, and no new frames can
4847 * AVERROR(EINVAL): codec not opened, refcounted_frames not set, it is a
4848 * decoder, or requires flush
4849 * AVERROR(ENOMEM): failed to add packet to internal queue, or similar
4850 * other errors: legitimate decoding errors
4852 int avcodec_send_frame(AVCodecContext *avctx, const AVFrame *frame);
4855 * Read encoded data from the encoder.
4857 * @param avctx codec context
4858 * @param avpkt This will be set to a reference-counted packet allocated by the
4859 * encoder. Note that the function will always call
4860 * av_frame_unref(frame) before doing anything else.
4861 * @return 0 on success, otherwise negative error code:
4862 * AVERROR(EAGAIN): output is not available in the current state - user
4863 * must try to send input
4864 * AVERROR_EOF: the encoder has been fully flushed, and there will be
4865 * no more output packets
4866 * AVERROR(EINVAL): codec not opened, or it is an encoder
4867 * other errors: legitimate decoding errors
4869 int avcodec_receive_packet(AVCodecContext *avctx, AVPacket *avpkt);
4872 * Create and return a AVHWFramesContext with values adequate for hardware
4873 * decoding. This is meant to get called from the get_format callback, and is
4874 * a helper for preparing a AVHWFramesContext for AVCodecContext.hw_frames_ctx.
4875 * This API is for decoding with certain hardware acceleration modes/APIs only.
4877 * The returned AVHWFramesContext is not initialized. The caller must do this
4878 * with av_hwframe_ctx_init().
4880 * Calling this function is not a requirement, but makes it simpler to avoid
4881 * codec or hardware API specific details when manually allocating frames.
4883 * Alternatively to this, an API user can set AVCodecContext.hw_device_ctx,
4884 * which sets up AVCodecContext.hw_frames_ctx fully automatically, and makes
4885 * it unnecessary to call this function or having to care about
4886 * AVHWFramesContext initialization at all.
4888 * There are a number of requirements for calling this function:
4890 * - It must be called from get_format with the same avctx parameter that was
4891 * passed to get_format. Calling it outside of get_format is not allowed, and
4892 * can trigger undefined behavior.
4893 * - The function is not always supported (see description of return values).
4894 * Even if this function returns successfully, hwaccel initialization could
4895 * fail later. (The degree to which implementations check whether the stream
4896 * is actually supported varies. Some do this check only after the user's
4897 * get_format callback returns.)
4898 * - The hw_pix_fmt must be one of the choices suggested by get_format. If the
4899 * user decides to use a AVHWFramesContext prepared with this API function,
4900 * the user must return the same hw_pix_fmt from get_format.
4901 * - The device_ref passed to this function must support the given hw_pix_fmt.
4902 * - After calling this API function, it is the user's responsibility to
4903 * initialize the AVHWFramesContext (returned by the out_frames_ref parameter),
4904 * and to set AVCodecContext.hw_frames_ctx to it. If done, this must be done
4905 * before returning from get_format (this is implied by the normal
4906 * AVCodecContext.hw_frames_ctx API rules).
4907 * - The AVHWFramesContext parameters may change every time time get_format is
4908 * called. Also, AVCodecContext.hw_frames_ctx is reset before get_format. So
4909 * you are inherently required to go through this process again on every
4911 * - It is perfectly possible to call this function without actually using
4912 * the resulting AVHWFramesContext. One use-case might be trying to reuse a
4913 * previously initialized AVHWFramesContext, and calling this API function
4914 * only to test whether the required frame parameters have changed.
4915 * - Fields that use dynamically allocated values of any kind must not be set
4916 * by the user unless setting them is explicitly allowed by the documentation.
4917 * If the user sets AVHWFramesContext.free and AVHWFramesContext.user_opaque,
4918 * the new free callback must call the potentially set previous free callback.
4919 * This API call may set any dynamically allocated fields, including the free
4922 * The function will set at least the following fields on AVHWFramesContext
4923 * (potentially more, depending on hwaccel API):
4925 * - All fields set by av_hwframe_ctx_alloc().
4926 * - Set the format field to hw_pix_fmt.
4927 * - Set the sw_format field to the most suited and most versatile format. (An
4928 * implication is that this will prefer generic formats over opaque formats
4929 * with arbitrary restrictions, if possible.)
4930 * - Set the width/height fields to the coded frame size, rounded up to the
4931 * API-specific minimum alignment.
4932 * - Only _if_ the hwaccel requires a pre-allocated pool: set the initial_pool_size
4933 * field to the number of maximum reference surfaces possible with the codec,
4934 * plus 1 surface for the user to work (meaning the user can safely reference
4935 * at most 1 decoded surface at a time), plus additional buffering introduced
4936 * by frame threading. If the hwaccel does not require pre-allocation, the
4937 * field is left to 0, and the decoder will allocate new surfaces on demand
4939 * - Possibly AVHWFramesContext.hwctx fields, depending on the underlying
4942 * Essentially, out_frames_ref returns the same as av_hwframe_ctx_alloc(), but
4943 * with basic frame parameters set.
4945 * The function is stateless, and does not change the AVCodecContext or the
4946 * device_ref AVHWDeviceContext.
4948 * @param avctx The context which is currently calling get_format, and which
4949 * implicitly contains all state needed for filling the returned
4950 * AVHWFramesContext properly.
4951 * @param device_ref A reference to the AVHWDeviceContext describing the device
4952 * which will be used by the hardware decoder.
4953 * @param hw_pix_fmt The hwaccel format you are going to return from get_format.
4954 * @param out_frames_ref On success, set to a reference to an _uninitialized_
4955 * AVHWFramesContext, created from the given device_ref.
4956 * Fields will be set to values required for decoding.
4957 * Not changed if an error is returned.
4958 * @return zero on success, a negative value on error. The following error codes
4959 * have special semantics:
4960 * AVERROR(ENOENT): the decoder does not support this functionality. Setup
4961 * is always manual, or it is a decoder which does not
4962 * support setting AVCodecContext.hw_frames_ctx at all,
4963 * or it is a software format.
4964 * AVERROR(EINVAL): it is known that hardware decoding is not supported for
4965 * this configuration, or the device_ref is not supported
4966 * for the hwaccel referenced by hw_pix_fmt.
4968 int avcodec_get_hw_frames_parameters(AVCodecContext *avctx,
4969 AVBufferRef *device_ref,
4970 enum AVPixelFormat hw_pix_fmt,
4971 AVBufferRef **out_frames_ref);
4976 * @defgroup lavc_parsing Frame parsing
4980 enum AVPictureStructure {
4981 AV_PICTURE_STRUCTURE_UNKNOWN, //< unknown
4982 AV_PICTURE_STRUCTURE_TOP_FIELD, //< coded as top field
4983 AV_PICTURE_STRUCTURE_BOTTOM_FIELD, //< coded as bottom field
4984 AV_PICTURE_STRUCTURE_FRAME, //< coded as frame
4987 typedef struct AVCodecParserContext {
4989 struct AVCodecParser *parser;
4990 int64_t frame_offset; /* offset of the current frame */
4991 int64_t cur_offset; /* current offset
4992 (incremented by each av_parser_parse()) */
4993 int64_t next_frame_offset; /* offset of the next frame */
4995 int pict_type; /* XXX: Put it back in AVCodecContext. */
4997 * This field is used for proper frame duration computation in lavf.
4998 * It signals, how much longer the frame duration of the current frame
4999 * is compared to normal frame duration.
5001 * frame_duration = (1 + repeat_pict) * time_base
5003 * It is used by codecs like H.264 to display telecined material.
5005 int repeat_pict; /* XXX: Put it back in AVCodecContext. */
5006 int64_t pts; /* pts of the current frame */
5007 int64_t dts; /* dts of the current frame */
5012 int fetch_timestamp;
5014 #define AV_PARSER_PTS_NB 4
5015 int cur_frame_start_index;
5016 int64_t cur_frame_offset[AV_PARSER_PTS_NB];
5017 int64_t cur_frame_pts[AV_PARSER_PTS_NB];
5018 int64_t cur_frame_dts[AV_PARSER_PTS_NB];
5021 #define PARSER_FLAG_COMPLETE_FRAMES 0x0001
5022 #define PARSER_FLAG_ONCE 0x0002
5023 /// Set if the parser has a valid file offset
5024 #define PARSER_FLAG_FETCHED_OFFSET 0x0004
5025 #define PARSER_FLAG_USE_CODEC_TS 0x1000
5027 int64_t offset; ///< byte offset from starting packet start
5028 int64_t cur_frame_end[AV_PARSER_PTS_NB];
5031 * Set by parser to 1 for key frames and 0 for non-key frames.
5032 * It is initialized to -1, so if the parser doesn't set this flag,
5033 * old-style fallback using AV_PICTURE_TYPE_I picture type as key frames
5038 #if FF_API_CONVERGENCE_DURATION
5040 * @deprecated unused
5042 attribute_deprecated
5043 int64_t convergence_duration;
5046 // Timestamp generation support:
5048 * Synchronization point for start of timestamp generation.
5050 * Set to >0 for sync point, 0 for no sync point and <0 for undefined
5053 * For example, this corresponds to presence of H.264 buffering period
5059 * Offset of the current timestamp against last timestamp sync point in
5060 * units of AVCodecContext.time_base.
5062 * Set to INT_MIN when dts_sync_point unused. Otherwise, it must
5063 * contain a valid timestamp offset.
5065 * Note that the timestamp of sync point has usually a nonzero
5066 * dts_ref_dts_delta, which refers to the previous sync point. Offset of
5067 * the next frame after timestamp sync point will be usually 1.
5069 * For example, this corresponds to H.264 cpb_removal_delay.
5071 int dts_ref_dts_delta;
5074 * Presentation delay of current frame in units of AVCodecContext.time_base.
5076 * Set to INT_MIN when dts_sync_point unused. Otherwise, it must
5077 * contain valid non-negative timestamp delta (presentation time of a frame
5078 * must not lie in the past).
5080 * This delay represents the difference between decoding and presentation
5081 * time of the frame.
5083 * For example, this corresponds to H.264 dpb_output_delay.
5088 * Position of the packet in file.
5090 * Analogous to cur_frame_pts/dts
5092 int64_t cur_frame_pos[AV_PARSER_PTS_NB];
5095 * Byte position of currently parsed frame in stream.
5100 * Previous frame byte position.
5105 * Duration of the current frame.
5106 * For audio, this is in units of 1 / AVCodecContext.sample_rate.
5107 * For all other types, this is in units of AVCodecContext.time_base.
5111 enum AVFieldOrder field_order;
5114 * Indicate whether a picture is coded as a frame, top field or bottom field.
5116 * For example, H.264 field_pic_flag equal to 0 corresponds to
5117 * AV_PICTURE_STRUCTURE_FRAME. An H.264 picture with field_pic_flag
5118 * equal to 1 and bottom_field_flag equal to 0 corresponds to
5119 * AV_PICTURE_STRUCTURE_TOP_FIELD.
5121 enum AVPictureStructure picture_structure;
5124 * Picture number incremented in presentation or output order.
5125 * This field may be reinitialized at the first picture of a new sequence.
5127 * For example, this corresponds to H.264 PicOrderCnt.
5129 int output_picture_number;
5132 * Dimensions of the decoded video intended for presentation.
5138 * Dimensions of the coded video.
5144 * The format of the coded data, corresponds to enum AVPixelFormat for video
5145 * and for enum AVSampleFormat for audio.
5147 * Note that a decoder can have considerable freedom in how exactly it
5148 * decodes the data, so the format reported here might be different from the
5149 * one returned by a decoder.
5152 } AVCodecParserContext;
5154 typedef struct AVCodecParser {
5155 int codec_ids[5]; /* several codec IDs are permitted */
5157 int (*parser_init)(AVCodecParserContext *s);
5158 /* This callback never returns an error, a negative value means that
5159 * the frame start was in a previous packet. */
5160 int (*parser_parse)(AVCodecParserContext *s,
5161 AVCodecContext *avctx,
5162 const uint8_t **poutbuf, int *poutbuf_size,
5163 const uint8_t *buf, int buf_size);
5164 void (*parser_close)(AVCodecParserContext *s);
5165 int (*split)(AVCodecContext *avctx, const uint8_t *buf, int buf_size);
5166 struct AVCodecParser *next;
5170 * Iterate over all registered codec parsers.
5172 * @param opaque a pointer where libavcodec will store the iteration state. Must
5173 * point to NULL to start the iteration.
5175 * @return the next registered codec parser or NULL when the iteration is
5178 const AVCodecParser *av_parser_iterate(void **opaque);
5180 attribute_deprecated
5181 AVCodecParser *av_parser_next(const AVCodecParser *c);
5183 attribute_deprecated
5184 void av_register_codec_parser(AVCodecParser *parser);
5185 AVCodecParserContext *av_parser_init(int codec_id);
5190 * @param s parser context.
5191 * @param avctx codec context.
5192 * @param poutbuf set to pointer to parsed buffer or NULL if not yet finished.
5193 * @param poutbuf_size set to size of parsed buffer or zero if not yet finished.
5194 * @param buf input buffer.
5195 * @param buf_size buffer size in bytes without the padding. I.e. the full buffer
5196 size is assumed to be buf_size + AV_INPUT_BUFFER_PADDING_SIZE.
5197 To signal EOF, this should be 0 (so that the last frame
5199 * @param pts input presentation timestamp.
5200 * @param dts input decoding timestamp.
5201 * @param pos input byte position in stream.
5202 * @return the number of bytes of the input bitstream used.
5207 * len = av_parser_parse2(myparser, AVCodecContext, &data, &size,
5214 * decode_frame(data, size);
5218 int av_parser_parse2(AVCodecParserContext *s,
5219 AVCodecContext *avctx,
5220 uint8_t **poutbuf, int *poutbuf_size,
5221 const uint8_t *buf, int buf_size,
5222 int64_t pts, int64_t dts,
5226 * @return 0 if the output buffer is a subset of the input, 1 if it is allocated and must be freed
5227 * @deprecated use AVBitStreamFilter
5229 int av_parser_change(AVCodecParserContext *s,
5230 AVCodecContext *avctx,
5231 uint8_t **poutbuf, int *poutbuf_size,
5232 const uint8_t *buf, int buf_size, int keyframe);
5233 void av_parser_close(AVCodecParserContext *s);
5241 * @addtogroup lavc_encoding
5246 * Find a registered encoder with a matching codec ID.
5248 * @param id AVCodecID of the requested encoder
5249 * @return An encoder if one was found, NULL otherwise.
5251 AVCodec *avcodec_find_encoder(enum AVCodecID id);
5254 * Find a registered encoder with the specified name.
5256 * @param name name of the requested encoder
5257 * @return An encoder if one was found, NULL otherwise.
5259 AVCodec *avcodec_find_encoder_by_name(const char *name);
5262 * Encode a frame of audio.
5264 * Takes input samples from frame and writes the next output packet, if
5265 * available, to avpkt. The output packet does not necessarily contain data for
5266 * the most recent frame, as encoders can delay, split, and combine input frames
5267 * internally as needed.
5269 * @param avctx codec context
5270 * @param avpkt output AVPacket.
5271 * The user can supply an output buffer by setting
5272 * avpkt->data and avpkt->size prior to calling the
5273 * function, but if the size of the user-provided data is not
5274 * large enough, encoding will fail. If avpkt->data and
5275 * avpkt->size are set, avpkt->destruct must also be set. All
5276 * other AVPacket fields will be reset by the encoder using
5277 * av_init_packet(). If avpkt->data is NULL, the encoder will
5278 * allocate it. The encoder will set avpkt->size to the size
5279 * of the output packet.
5281 * If this function fails or produces no output, avpkt will be
5282 * freed using av_packet_unref().
5283 * @param[in] frame AVFrame containing the raw audio data to be encoded.
5284 * May be NULL when flushing an encoder that has the
5285 * AV_CODEC_CAP_DELAY capability set.
5286 * If AV_CODEC_CAP_VARIABLE_FRAME_SIZE is set, then each frame
5287 * can have any number of samples.
5288 * If it is not set, frame->nb_samples must be equal to
5289 * avctx->frame_size for all frames except the last.
5290 * The final frame may be smaller than avctx->frame_size.
5291 * @param[out] got_packet_ptr This field is set to 1 by libavcodec if the
5292 * output packet is non-empty, and to 0 if it is
5293 * empty. If the function returns an error, the
5294 * packet can be assumed to be invalid, and the
5295 * value of got_packet_ptr is undefined and should
5297 * @return 0 on success, negative error code on failure
5299 * @deprecated use avcodec_send_frame()/avcodec_receive_packet() instead
5301 attribute_deprecated
5302 int avcodec_encode_audio2(AVCodecContext *avctx, AVPacket *avpkt,
5303 const AVFrame *frame, int *got_packet_ptr);
5306 * Encode a frame of video.
5308 * Takes input raw video data from frame and writes the next output packet, if
5309 * available, to avpkt. The output packet does not necessarily contain data for
5310 * the most recent frame, as encoders can delay and reorder input frames
5311 * internally as needed.
5313 * @param avctx codec context
5314 * @param avpkt output AVPacket.
5315 * The user can supply an output buffer by setting
5316 * avpkt->data and avpkt->size prior to calling the
5317 * function, but if the size of the user-provided data is not
5318 * large enough, encoding will fail. All other AVPacket fields
5319 * will be reset by the encoder using av_init_packet(). If
5320 * avpkt->data is NULL, the encoder will allocate it.
5321 * The encoder will set avpkt->size to the size of the
5322 * output packet. The returned data (if any) belongs to the
5323 * caller, he is responsible for freeing it.
5325 * If this function fails or produces no output, avpkt will be
5326 * freed using av_packet_unref().
5327 * @param[in] frame AVFrame containing the raw video data to be encoded.
5328 * May be NULL when flushing an encoder that has the
5329 * AV_CODEC_CAP_DELAY capability set.
5330 * @param[out] got_packet_ptr This field is set to 1 by libavcodec if the
5331 * output packet is non-empty, and to 0 if it is
5332 * empty. If the function returns an error, the
5333 * packet can be assumed to be invalid, and the
5334 * value of got_packet_ptr is undefined and should
5336 * @return 0 on success, negative error code on failure
5338 * @deprecated use avcodec_send_frame()/avcodec_receive_packet() instead
5340 attribute_deprecated
5341 int avcodec_encode_video2(AVCodecContext *avctx, AVPacket *avpkt,
5342 const AVFrame *frame, int *got_packet_ptr);
5344 int avcodec_encode_subtitle(AVCodecContext *avctx, uint8_t *buf, int buf_size,
5345 const AVSubtitle *sub);
5352 #if FF_API_AVPICTURE
5354 * @addtogroup lavc_picture
5359 * @deprecated unused
5361 attribute_deprecated
5362 int avpicture_alloc(AVPicture *picture, enum AVPixelFormat pix_fmt, int width, int height);
5365 * @deprecated unused
5367 attribute_deprecated
5368 void avpicture_free(AVPicture *picture);
5371 * @deprecated use av_image_fill_arrays() instead.
5373 attribute_deprecated
5374 int avpicture_fill(AVPicture *picture, const uint8_t *ptr,
5375 enum AVPixelFormat pix_fmt, int width, int height);
5378 * @deprecated use av_image_copy_to_buffer() instead.
5380 attribute_deprecated
5381 int avpicture_layout(const AVPicture *src, enum AVPixelFormat pix_fmt,
5382 int width, int height,
5383 unsigned char *dest, int dest_size);
5386 * @deprecated use av_image_get_buffer_size() instead.
5388 attribute_deprecated
5389 int avpicture_get_size(enum AVPixelFormat pix_fmt, int width, int height);
5392 * @deprecated av_image_copy() instead.
5394 attribute_deprecated
5395 void av_picture_copy(AVPicture *dst, const AVPicture *src,
5396 enum AVPixelFormat pix_fmt, int width, int height);
5399 * @deprecated unused
5401 attribute_deprecated
5402 int av_picture_crop(AVPicture *dst, const AVPicture *src,
5403 enum AVPixelFormat pix_fmt, int top_band, int left_band);
5406 * @deprecated unused
5408 attribute_deprecated
5409 int av_picture_pad(AVPicture *dst, const AVPicture *src, int height, int width, enum AVPixelFormat pix_fmt,
5410 int padtop, int padbottom, int padleft, int padright, int *color);
5418 * @defgroup lavc_misc Utility functions
5421 * Miscellaneous utility functions related to both encoding and decoding
5427 * @defgroup lavc_misc_pixfmt Pixel formats
5429 * Functions for working with pixel formats.
5433 #if FF_API_GETCHROMA
5435 * @deprecated Use av_pix_fmt_get_chroma_sub_sample
5438 attribute_deprecated
5439 void avcodec_get_chroma_sub_sample(enum AVPixelFormat pix_fmt, int *h_shift, int *v_shift);
5443 * Return a value representing the fourCC code associated to the
5444 * pixel format pix_fmt, or 0 if no associated fourCC code can be
5447 unsigned int avcodec_pix_fmt_to_codec_tag(enum AVPixelFormat pix_fmt);
5450 * @deprecated see av_get_pix_fmt_loss()
5452 int avcodec_get_pix_fmt_loss(enum AVPixelFormat dst_pix_fmt, enum AVPixelFormat src_pix_fmt,
5456 * Find the best pixel format to convert to given a certain source pixel
5457 * format. When converting from one pixel format to another, information loss
5458 * may occur. For example, when converting from RGB24 to GRAY, the color
5459 * information will be lost. Similarly, other losses occur when converting from
5460 * some formats to other formats. avcodec_find_best_pix_fmt_of_2() searches which of
5461 * the given pixel formats should be used to suffer the least amount of loss.
5462 * The pixel formats from which it chooses one, are determined by the
5463 * pix_fmt_list parameter.
5466 * @param[in] pix_fmt_list AV_PIX_FMT_NONE terminated array of pixel formats to choose from
5467 * @param[in] src_pix_fmt source pixel format
5468 * @param[in] has_alpha Whether the source pixel format alpha channel is used.
5469 * @param[out] loss_ptr Combination of flags informing you what kind of losses will occur.
5470 * @return The best pixel format to convert to or -1 if none was found.
5472 enum AVPixelFormat avcodec_find_best_pix_fmt_of_list(const enum AVPixelFormat *pix_fmt_list,
5473 enum AVPixelFormat src_pix_fmt,
5474 int has_alpha, int *loss_ptr);
5477 * @deprecated see av_find_best_pix_fmt_of_2()
5479 enum AVPixelFormat avcodec_find_best_pix_fmt_of_2(enum AVPixelFormat dst_pix_fmt1, enum AVPixelFormat dst_pix_fmt2,
5480 enum AVPixelFormat src_pix_fmt, int has_alpha, int *loss_ptr);
5482 attribute_deprecated
5483 enum AVPixelFormat avcodec_find_best_pix_fmt2(enum AVPixelFormat dst_pix_fmt1, enum AVPixelFormat dst_pix_fmt2,
5484 enum AVPixelFormat src_pix_fmt, int has_alpha, int *loss_ptr);
5486 enum AVPixelFormat avcodec_default_get_format(struct AVCodecContext *s, const enum AVPixelFormat * fmt);
5492 #if FF_API_TAG_STRING
5494 * Put a string representing the codec tag codec_tag in buf.
5496 * @param buf buffer to place codec tag in
5497 * @param buf_size size in bytes of buf
5498 * @param codec_tag codec tag to assign
5499 * @return the length of the string that would have been generated if
5500 * enough space had been available, excluding the trailing null
5502 * @deprecated see av_fourcc_make_string() and av_fourcc2str().
5504 attribute_deprecated
5505 size_t av_get_codec_tag_string(char *buf, size_t buf_size, unsigned int codec_tag);
5508 void avcodec_string(char *buf, int buf_size, AVCodecContext *enc, int encode);
5511 * Return a name for the specified profile, if available.
5513 * @param codec the codec that is searched for the given profile
5514 * @param profile the profile value for which a name is requested
5515 * @return A name for the profile if found, NULL otherwise.
5517 const char *av_get_profile_name(const AVCodec *codec, int profile);
5520 * Return a name for the specified profile, if available.
5522 * @param codec_id the ID of the codec to which the requested profile belongs
5523 * @param profile the profile value for which a name is requested
5524 * @return A name for the profile if found, NULL otherwise.
5526 * @note unlike av_get_profile_name(), which searches a list of profiles
5527 * supported by a specific decoder or encoder implementation, this
5528 * function searches the list of profiles from the AVCodecDescriptor
5530 const char *avcodec_profile_name(enum AVCodecID codec_id, int profile);
5532 int avcodec_default_execute(AVCodecContext *c, int (*func)(AVCodecContext *c2, void *arg2),void *arg, int *ret, int count, int size);
5533 int avcodec_default_execute2(AVCodecContext *c, int (*func)(AVCodecContext *c2, void *arg2, int, int),void *arg, int *ret, int count);
5534 //FIXME func typedef
5537 * Fill AVFrame audio data and linesize pointers.
5539 * The buffer buf must be a preallocated buffer with a size big enough
5540 * to contain the specified samples amount. The filled AVFrame data
5541 * pointers will point to this buffer.
5543 * AVFrame extended_data channel pointers are allocated if necessary for
5546 * @param frame the AVFrame
5547 * frame->nb_samples must be set prior to calling the
5548 * function. This function fills in frame->data,
5549 * frame->extended_data, frame->linesize[0].
5550 * @param nb_channels channel count
5551 * @param sample_fmt sample format
5552 * @param buf buffer to use for frame data
5553 * @param buf_size size of buffer
5554 * @param align plane size sample alignment (0 = default)
5555 * @return >=0 on success, negative error code on failure
5556 * @todo return the size in bytes required to store the samples in
5557 * case of success, at the next libavutil bump
5559 int avcodec_fill_audio_frame(AVFrame *frame, int nb_channels,
5560 enum AVSampleFormat sample_fmt, const uint8_t *buf,
5561 int buf_size, int align);
5564 * Reset the internal decoder state / flush internal buffers. Should be called
5565 * e.g. when seeking or when switching to a different stream.
5567 * @note when refcounted frames are not used (i.e. avctx->refcounted_frames is 0),
5568 * this invalidates the frames previously returned from the decoder. When
5569 * refcounted frames are used, the decoder just releases any references it might
5570 * keep internally, but the caller's reference remains valid.
5572 void avcodec_flush_buffers(AVCodecContext *avctx);
5575 * Return codec bits per sample.
5577 * @param[in] codec_id the codec
5578 * @return Number of bits per sample or zero if unknown for the given codec.
5580 int av_get_bits_per_sample(enum AVCodecID codec_id);
5583 * Return the PCM codec associated with a sample format.
5584 * @param be endianness, 0 for little, 1 for big,
5585 * -1 (or anything else) for native
5586 * @return AV_CODEC_ID_PCM_* or AV_CODEC_ID_NONE
5588 enum AVCodecID av_get_pcm_codec(enum AVSampleFormat fmt, int be);
5591 * Return codec bits per sample.
5592 * Only return non-zero if the bits per sample is exactly correct, not an
5595 * @param[in] codec_id the codec
5596 * @return Number of bits per sample or zero if unknown for the given codec.
5598 int av_get_exact_bits_per_sample(enum AVCodecID codec_id);
5601 * Return audio frame duration.
5603 * @param avctx codec context
5604 * @param frame_bytes size of the frame, or 0 if unknown
5605 * @return frame duration, in samples, if known. 0 if not able to
5608 int av_get_audio_frame_duration(AVCodecContext *avctx, int frame_bytes);
5611 * This function is the same as av_get_audio_frame_duration(), except it works
5612 * with AVCodecParameters instead of an AVCodecContext.
5614 int av_get_audio_frame_duration2(AVCodecParameters *par, int frame_bytes);
5617 typedef struct AVBitStreamFilterContext {
5619 const struct AVBitStreamFilter *filter;
5620 AVCodecParserContext *parser;
5621 struct AVBitStreamFilterContext *next;
5623 * Internal default arguments, used if NULL is passed to av_bitstream_filter_filter().
5624 * Not for access by library users.
5627 } AVBitStreamFilterContext;
5630 typedef struct AVBSFInternal AVBSFInternal;
5633 * The bitstream filter state.
5635 * This struct must be allocated with av_bsf_alloc() and freed with
5638 * The fields in the struct will only be changed (by the caller or by the
5639 * filter) as described in their documentation, and are to be considered
5640 * immutable otherwise.
5642 typedef struct AVBSFContext {
5644 * A class for logging and AVOptions
5646 const AVClass *av_class;
5649 * The bitstream filter this context is an instance of.
5651 const struct AVBitStreamFilter *filter;
5654 * Opaque libavcodec internal data. Must not be touched by the caller in any
5657 AVBSFInternal *internal;
5660 * Opaque filter-specific private data. If filter->priv_class is non-NULL,
5661 * this is an AVOptions-enabled struct.
5666 * Parameters of the input stream. This field is allocated in
5667 * av_bsf_alloc(), it needs to be filled by the caller before
5670 AVCodecParameters *par_in;
5673 * Parameters of the output stream. This field is allocated in
5674 * av_bsf_alloc(), it is set by the filter in av_bsf_init().
5676 AVCodecParameters *par_out;
5679 * The timebase used for the timestamps of the input packets. Set by the
5680 * caller before av_bsf_init().
5682 AVRational time_base_in;
5685 * The timebase used for the timestamps of the output packets. Set by the
5686 * filter in av_bsf_init().
5688 AVRational time_base_out;
5691 typedef struct AVBitStreamFilter {
5695 * A list of codec ids supported by the filter, terminated by
5697 * May be NULL, in that case the bitstream filter works with any codec id.
5699 const enum AVCodecID *codec_ids;
5702 * A class for the private data, used to declare bitstream filter private
5703 * AVOptions. This field is NULL for bitstream filters that do not declare
5706 * If this field is non-NULL, the first member of the filter private data
5707 * must be a pointer to AVClass, which will be set by libavcodec generic
5708 * code to this class.
5710 const AVClass *priv_class;
5712 /*****************************************************************
5713 * No fields below this line are part of the public API. They
5714 * may not be used outside of libavcodec and can be changed and
5716 * New public fields should be added right above.
5717 *****************************************************************
5721 int (*init)(AVBSFContext *ctx);
5722 int (*filter)(AVBSFContext *ctx, AVPacket *pkt);
5723 void (*close)(AVBSFContext *ctx);
5724 } AVBitStreamFilter;
5728 * @deprecated the old bitstream filtering API (using AVBitStreamFilterContext)
5729 * is deprecated. Use the new bitstream filtering API (using AVBSFContext).
5731 attribute_deprecated
5732 void av_register_bitstream_filter(AVBitStreamFilter *bsf);
5734 * @deprecated the old bitstream filtering API (using AVBitStreamFilterContext)
5735 * is deprecated. Use av_bsf_get_by_name(), av_bsf_alloc(), and av_bsf_init()
5736 * from the new bitstream filtering API (using AVBSFContext).
5738 attribute_deprecated
5739 AVBitStreamFilterContext *av_bitstream_filter_init(const char *name);
5741 * @deprecated the old bitstream filtering API (using AVBitStreamFilterContext)
5742 * is deprecated. Use av_bsf_send_packet() and av_bsf_receive_packet() from the
5743 * new bitstream filtering API (using AVBSFContext).
5745 attribute_deprecated
5746 int av_bitstream_filter_filter(AVBitStreamFilterContext *bsfc,
5747 AVCodecContext *avctx, const char *args,
5748 uint8_t **poutbuf, int *poutbuf_size,
5749 const uint8_t *buf, int buf_size, int keyframe);
5751 * @deprecated the old bitstream filtering API (using AVBitStreamFilterContext)
5752 * is deprecated. Use av_bsf_free() from the new bitstream filtering API (using
5755 attribute_deprecated
5756 void av_bitstream_filter_close(AVBitStreamFilterContext *bsf);
5758 * @deprecated the old bitstream filtering API (using AVBitStreamFilterContext)
5759 * is deprecated. Use av_bsf_iterate() from the new bitstream filtering API (using
5762 attribute_deprecated
5763 const AVBitStreamFilter *av_bitstream_filter_next(const AVBitStreamFilter *f);
5767 * @return a bitstream filter with the specified name or NULL if no such
5768 * bitstream filter exists.
5770 const AVBitStreamFilter *av_bsf_get_by_name(const char *name);
5773 * Iterate over all registered bitstream filters.
5775 * @param opaque a pointer where libavcodec will store the iteration state. Must
5776 * point to NULL to start the iteration.
5778 * @return the next registered bitstream filter or NULL when the iteration is
5781 const AVBitStreamFilter *av_bsf_iterate(void **opaque);
5783 attribute_deprecated
5784 const AVBitStreamFilter *av_bsf_next(void **opaque);
5788 * Allocate a context for a given bitstream filter. The caller must fill in the
5789 * context parameters as described in the documentation and then call
5790 * av_bsf_init() before sending any data to the filter.
5792 * @param filter the filter for which to allocate an instance.
5793 * @param ctx a pointer into which the pointer to the newly-allocated context
5794 * will be written. It must be freed with av_bsf_free() after the
5795 * filtering is done.
5797 * @return 0 on success, a negative AVERROR code on failure
5799 int av_bsf_alloc(const AVBitStreamFilter *filter, AVBSFContext **ctx);
5802 * Prepare the filter for use, after all the parameters and options have been
5805 int av_bsf_init(AVBSFContext *ctx);
5808 * Submit a packet for filtering.
5810 * After sending each packet, the filter must be completely drained by calling
5811 * av_bsf_receive_packet() repeatedly until it returns AVERROR(EAGAIN) or
5814 * @param pkt the packet to filter. The bitstream filter will take ownership of
5815 * the packet and reset the contents of pkt. pkt is not touched if an error occurs.
5816 * This parameter may be NULL, which signals the end of the stream (i.e. no more
5817 * packets will be sent). That will cause the filter to output any packets it
5818 * may have buffered internally.
5820 * @return 0 on success, a negative AVERROR on error.
5822 int av_bsf_send_packet(AVBSFContext *ctx, AVPacket *pkt);
5825 * Retrieve a filtered packet.
5827 * @param[out] pkt this struct will be filled with the contents of the filtered
5828 * packet. It is owned by the caller and must be freed using
5829 * av_packet_unref() when it is no longer needed.
5830 * This parameter should be "clean" (i.e. freshly allocated
5831 * with av_packet_alloc() or unreffed with av_packet_unref())
5832 * when this function is called. If this function returns
5833 * successfully, the contents of pkt will be completely
5834 * overwritten by the returned data. On failure, pkt is not
5837 * @return 0 on success. AVERROR(EAGAIN) if more packets need to be sent to the
5838 * filter (using av_bsf_send_packet()) to get more output. AVERROR_EOF if there
5839 * will be no further output from the filter. Another negative AVERROR value if
5842 * @note one input packet may result in several output packets, so after sending
5843 * a packet with av_bsf_send_packet(), this function needs to be called
5844 * repeatedly until it stops returning 0. It is also possible for a filter to
5845 * output fewer packets than were sent to it, so this function may return
5846 * AVERROR(EAGAIN) immediately after a successful av_bsf_send_packet() call.
5848 int av_bsf_receive_packet(AVBSFContext *ctx, AVPacket *pkt);
5851 * Free a bitstream filter context and everything associated with it; write NULL
5852 * into the supplied pointer.
5854 void av_bsf_free(AVBSFContext **ctx);
5857 * Get the AVClass for AVBSFContext. It can be used in combination with
5858 * AV_OPT_SEARCH_FAKE_OBJ for examining options.
5860 * @see av_opt_find().
5862 const AVClass *av_bsf_get_class(void);
5865 * Structure for chain/list of bitstream filters.
5866 * Empty list can be allocated by av_bsf_list_alloc().
5868 typedef struct AVBSFList AVBSFList;
5871 * Allocate empty list of bitstream filters.
5872 * The list must be later freed by av_bsf_list_free()
5873 * or finalized by av_bsf_list_finalize().
5875 * @return Pointer to @ref AVBSFList on success, NULL in case of failure
5877 AVBSFList *av_bsf_list_alloc(void);
5880 * Free list of bitstream filters.
5882 * @param lst Pointer to pointer returned by av_bsf_list_alloc()
5884 void av_bsf_list_free(AVBSFList **lst);
5887 * Append bitstream filter to the list of bitstream filters.
5889 * @param lst List to append to
5890 * @param bsf Filter context to be appended
5892 * @return >=0 on success, negative AVERROR in case of failure
5894 int av_bsf_list_append(AVBSFList *lst, AVBSFContext *bsf);
5897 * Construct new bitstream filter context given it's name and options
5898 * and append it to the list of bitstream filters.
5900 * @param lst List to append to
5901 * @param bsf_name Name of the bitstream filter
5902 * @param options Options for the bitstream filter, can be set to NULL
5904 * @return >=0 on success, negative AVERROR in case of failure
5906 int av_bsf_list_append2(AVBSFList *lst, const char * bsf_name, AVDictionary **options);
5908 * Finalize list of bitstream filters.
5910 * This function will transform @ref AVBSFList to single @ref AVBSFContext,
5911 * so the whole chain of bitstream filters can be treated as single filter
5912 * freshly allocated by av_bsf_alloc().
5913 * If the call is successful, @ref AVBSFList structure is freed and lst
5914 * will be set to NULL. In case of failure, caller is responsible for
5915 * freeing the structure by av_bsf_list_free()
5917 * @param lst Filter list structure to be transformed
5918 * @param[out] bsf Pointer to be set to newly created @ref AVBSFContext structure
5919 * representing the chain of bitstream filters
5921 * @return >=0 on success, negative AVERROR in case of failure
5923 int av_bsf_list_finalize(AVBSFList **lst, AVBSFContext **bsf);
5926 * Parse string describing list of bitstream filters and create single
5927 * @ref AVBSFContext describing the whole chain of bitstream filters.
5928 * Resulting @ref AVBSFContext can be treated as any other @ref AVBSFContext freshly
5929 * allocated by av_bsf_alloc().
5931 * @param str String describing chain of bitstream filters in format
5932 * `bsf1[=opt1=val1:opt2=val2][,bsf2]`
5933 * @param[out] bsf Pointer to be set to newly created @ref AVBSFContext structure
5934 * representing the chain of bitstream filters
5936 * @return >=0 on success, negative AVERROR in case of failure
5938 int av_bsf_list_parse_str(const char *str, AVBSFContext **bsf);
5941 * Get null/pass-through bitstream filter.
5943 * @param[out] bsf Pointer to be set to new instance of pass-through bitstream filter
5947 int av_bsf_get_null_filter(AVBSFContext **bsf);
5952 * Same behaviour av_fast_malloc but the buffer has additional
5953 * AV_INPUT_BUFFER_PADDING_SIZE at the end which will always be 0.
5955 * In addition the whole buffer will initially and after resizes
5956 * be 0-initialized so that no uninitialized data will ever appear.
5958 void av_fast_padded_malloc(void *ptr, unsigned int *size, size_t min_size);
5961 * Same behaviour av_fast_padded_malloc except that buffer will always
5962 * be 0-initialized after call.
5964 void av_fast_padded_mallocz(void *ptr, unsigned int *size, size_t min_size);
5967 * Encode extradata length to a buffer. Used by xiph codecs.
5969 * @param s buffer to write to; must be at least (v/255+1) bytes long
5970 * @param v size of extradata in bytes
5971 * @return number of bytes written to the buffer.
5973 unsigned int av_xiphlacing(unsigned char *s, unsigned int v);
5975 #if FF_API_USER_VISIBLE_AVHWACCEL
5977 * Register the hardware accelerator hwaccel.
5979 * @deprecated This function doesn't do anything.
5981 attribute_deprecated
5982 void av_register_hwaccel(AVHWAccel *hwaccel);
5985 * If hwaccel is NULL, returns the first registered hardware accelerator,
5986 * if hwaccel is non-NULL, returns the next registered hardware accelerator
5987 * after hwaccel, or NULL if hwaccel is the last one.
5989 * @deprecated AVHWaccel structures contain no user-serviceable parts, so
5990 * this function should not be used.
5992 attribute_deprecated
5993 AVHWAccel *av_hwaccel_next(const AVHWAccel *hwaccel);
5998 * Lock operation used by lockmgr
6000 * @deprecated Deprecated together with av_lockmgr_register().
6003 AV_LOCK_CREATE, ///< Create a mutex
6004 AV_LOCK_OBTAIN, ///< Lock the mutex
6005 AV_LOCK_RELEASE, ///< Unlock the mutex
6006 AV_LOCK_DESTROY, ///< Free mutex resources
6010 * Register a user provided lock manager supporting the operations
6011 * specified by AVLockOp. The "mutex" argument to the function points
6012 * to a (void *) where the lockmgr should store/get a pointer to a user
6013 * allocated mutex. It is NULL upon AV_LOCK_CREATE and equal to the
6014 * value left by the last call for all other ops. If the lock manager is
6015 * unable to perform the op then it should leave the mutex in the same
6016 * state as when it was called and return a non-zero value. However,
6017 * when called with AV_LOCK_DESTROY the mutex will always be assumed to
6018 * have been successfully destroyed. If av_lockmgr_register succeeds
6019 * it will return a non-negative value, if it fails it will return a
6020 * negative value and destroy all mutex and unregister all callbacks.
6021 * av_lockmgr_register is not thread-safe, it must be called from a
6022 * single thread before any calls which make use of locking are used.
6024 * @param cb User defined callback. av_lockmgr_register invokes calls
6025 * to this callback and the previously registered callback.
6026 * The callback will be used to create more than one mutex
6027 * each of which must be backed by its own underlying locking
6028 * mechanism (i.e. do not use a single static object to
6029 * implement your lock manager). If cb is set to NULL the
6030 * lockmgr will be unregistered.
6032 * @deprecated This function does nothing, and always returns 0. Be sure to
6033 * build with thread support to get basic thread safety.
6035 attribute_deprecated
6036 int av_lockmgr_register(int (*cb)(void **mutex, enum AVLockOp op));
6040 * Get the type of the given codec.
6042 enum AVMediaType avcodec_get_type(enum AVCodecID codec_id);
6045 * Get the name of a codec.
6046 * @return a static string identifying the codec; never NULL
6048 const char *avcodec_get_name(enum AVCodecID id);
6051 * @return a positive value if s is open (i.e. avcodec_open2() was called on it
6052 * with no corresponding avcodec_close()), 0 otherwise.
6054 int avcodec_is_open(AVCodecContext *s);
6057 * @return a non-zero number if codec is an encoder, zero otherwise
6059 int av_codec_is_encoder(const AVCodec *codec);
6062 * @return a non-zero number if codec is a decoder, zero otherwise
6064 int av_codec_is_decoder(const AVCodec *codec);
6067 * @return descriptor for given codec ID or NULL if no descriptor exists.
6069 const AVCodecDescriptor *avcodec_descriptor_get(enum AVCodecID id);
6072 * Iterate over all codec descriptors known to libavcodec.
6074 * @param prev previous descriptor. NULL to get the first descriptor.
6076 * @return next descriptor or NULL after the last descriptor
6078 const AVCodecDescriptor *avcodec_descriptor_next(const AVCodecDescriptor *prev);
6081 * @return codec descriptor with the given name or NULL if no such descriptor
6084 const AVCodecDescriptor *avcodec_descriptor_get_by_name(const char *name);
6087 * Allocate a CPB properties structure and initialize its fields to default
6090 * @param size if non-NULL, the size of the allocated struct will be written
6091 * here. This is useful for embedding it in side data.
6093 * @return the newly allocated struct or NULL on failure
6095 AVCPBProperties *av_cpb_properties_alloc(size_t *size);
6101 #endif /* AVCODEC_AVCODEC_H */