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,
670 /* other specific kind of codecs (generally used for attachments) */
671 AV_CODEC_ID_FIRST_UNKNOWN = 0x18000, ///< A dummy ID pointing at the start of various fake codecs.
672 AV_CODEC_ID_TTF = 0x18000,
674 AV_CODEC_ID_SCTE_35, ///< Contain timestamp estimated through PCR of program stream.
675 AV_CODEC_ID_BINTEXT = 0x18800,
679 AV_CODEC_ID_SMPTE_KLV,
681 AV_CODEC_ID_TIMED_ID3,
682 AV_CODEC_ID_BIN_DATA,
685 AV_CODEC_ID_PROBE = 0x19000, ///< codec_id is not known (like AV_CODEC_ID_NONE) but lavf should attempt to identify it
687 AV_CODEC_ID_MPEG2TS = 0x20000, /**< _FAKE_ codec to indicate a raw MPEG-2 TS
688 * stream (only used by libavformat) */
689 AV_CODEC_ID_MPEG4SYSTEMS = 0x20001, /**< _FAKE_ codec to indicate a MPEG-4 Systems
690 * stream (only used by libavformat) */
691 AV_CODEC_ID_FFMETADATA = 0x21000, ///< Dummy codec for streams containing only metadata information.
692 AV_CODEC_ID_WRAPPED_AVFRAME = 0x21001, ///< Passthrough codec, AVFrames wrapped in AVPacket
696 * This struct describes the properties of a single codec described by an
698 * @see avcodec_descriptor_get()
700 typedef struct AVCodecDescriptor {
702 enum AVMediaType type;
704 * Name of the codec described by this descriptor. It is non-empty and
705 * unique for each codec descriptor. It should contain alphanumeric
706 * characters and '_' only.
710 * A more descriptive name for this codec. May be NULL.
712 const char *long_name;
714 * Codec properties, a combination of AV_CODEC_PROP_* flags.
718 * MIME type(s) associated with the codec.
719 * May be NULL; if not, a NULL-terminated array of MIME types.
720 * The first item is always non-NULL and is the preferred MIME type.
722 const char *const *mime_types;
724 * If non-NULL, an array of profiles recognized for this codec.
725 * Terminated with FF_PROFILE_UNKNOWN.
727 const struct AVProfile *profiles;
731 * Codec uses only intra compression.
732 * Video and audio codecs only.
734 #define AV_CODEC_PROP_INTRA_ONLY (1 << 0)
736 * Codec supports lossy compression. Audio and video codecs only.
737 * @note a codec may support both lossy and lossless
740 #define AV_CODEC_PROP_LOSSY (1 << 1)
742 * Codec supports lossless compression. Audio and video codecs only.
744 #define AV_CODEC_PROP_LOSSLESS (1 << 2)
746 * Codec supports frame reordering. That is, the coded order (the order in which
747 * the encoded packets are output by the encoders / stored / input to the
748 * decoders) may be different from the presentation order of the corresponding
751 * For codecs that do not have this property set, PTS and DTS should always be
754 #define AV_CODEC_PROP_REORDER (1 << 3)
756 * Subtitle codec is bitmap based
757 * Decoded AVSubtitle data can be read from the AVSubtitleRect->pict field.
759 #define AV_CODEC_PROP_BITMAP_SUB (1 << 16)
761 * Subtitle codec is text based.
762 * Decoded AVSubtitle data can be read from the AVSubtitleRect->ass field.
764 #define AV_CODEC_PROP_TEXT_SUB (1 << 17)
767 * @ingroup lavc_decoding
768 * Required number of additionally allocated bytes at the end of the input bitstream for decoding.
769 * This is mainly needed because some optimized bitstream readers read
770 * 32 or 64 bit at once and could read over the end.<br>
771 * Note: If the first 23 bits of the additional bytes are not 0, then damaged
772 * MPEG bitstreams could cause overread and segfault.
774 #define AV_INPUT_BUFFER_PADDING_SIZE 64
777 * @ingroup lavc_encoding
778 * minimum encoding buffer size
779 * Used to avoid some checks during header writing.
781 #define AV_INPUT_BUFFER_MIN_SIZE 16384
784 * @ingroup lavc_decoding
787 /* We leave some space between them for extensions (drop some
788 * keyframes for intra-only or drop just some bidir frames). */
789 AVDISCARD_NONE =-16, ///< discard nothing
790 AVDISCARD_DEFAULT = 0, ///< discard useless packets like 0 size packets in avi
791 AVDISCARD_NONREF = 8, ///< discard all non reference
792 AVDISCARD_BIDIR = 16, ///< discard all bidirectional frames
793 AVDISCARD_NONINTRA= 24, ///< discard all non intra frames
794 AVDISCARD_NONKEY = 32, ///< discard all frames except keyframes
795 AVDISCARD_ALL = 48, ///< discard all
798 enum AVAudioServiceType {
799 AV_AUDIO_SERVICE_TYPE_MAIN = 0,
800 AV_AUDIO_SERVICE_TYPE_EFFECTS = 1,
801 AV_AUDIO_SERVICE_TYPE_VISUALLY_IMPAIRED = 2,
802 AV_AUDIO_SERVICE_TYPE_HEARING_IMPAIRED = 3,
803 AV_AUDIO_SERVICE_TYPE_DIALOGUE = 4,
804 AV_AUDIO_SERVICE_TYPE_COMMENTARY = 5,
805 AV_AUDIO_SERVICE_TYPE_EMERGENCY = 6,
806 AV_AUDIO_SERVICE_TYPE_VOICE_OVER = 7,
807 AV_AUDIO_SERVICE_TYPE_KARAOKE = 8,
808 AV_AUDIO_SERVICE_TYPE_NB , ///< Not part of ABI
812 * @ingroup lavc_encoding
814 typedef struct RcOverride{
817 int qscale; // If this is 0 then quality_factor will be used instead.
818 float quality_factor;
822 These flags can be passed in AVCodecContext.flags before initialization.
823 Note: Not everything is supported yet.
827 * Allow decoders to produce frames with data planes that are not aligned
828 * to CPU requirements (e.g. due to cropping).
830 #define AV_CODEC_FLAG_UNALIGNED (1 << 0)
834 #define AV_CODEC_FLAG_QSCALE (1 << 1)
836 * 4 MV per MB allowed / advanced prediction for H.263.
838 #define AV_CODEC_FLAG_4MV (1 << 2)
840 * Output even those frames that might be corrupted.
842 #define AV_CODEC_FLAG_OUTPUT_CORRUPT (1 << 3)
846 #define AV_CODEC_FLAG_QPEL (1 << 4)
848 * Use internal 2pass ratecontrol in first pass mode.
850 #define AV_CODEC_FLAG_PASS1 (1 << 9)
852 * Use internal 2pass ratecontrol in second pass mode.
854 #define AV_CODEC_FLAG_PASS2 (1 << 10)
858 #define AV_CODEC_FLAG_LOOP_FILTER (1 << 11)
860 * Only decode/encode grayscale.
862 #define AV_CODEC_FLAG_GRAY (1 << 13)
864 * error[?] variables will be set during encoding.
866 #define AV_CODEC_FLAG_PSNR (1 << 15)
868 * Input bitstream might be truncated at a random location
869 * instead of only at frame boundaries.
871 #define AV_CODEC_FLAG_TRUNCATED (1 << 16)
873 * Use interlaced DCT.
875 #define AV_CODEC_FLAG_INTERLACED_DCT (1 << 18)
879 #define AV_CODEC_FLAG_LOW_DELAY (1 << 19)
881 * Place global headers in extradata instead of every keyframe.
883 #define AV_CODEC_FLAG_GLOBAL_HEADER (1 << 22)
885 * Use only bitexact stuff (except (I)DCT).
887 #define AV_CODEC_FLAG_BITEXACT (1 << 23)
888 /* Fx : Flag for H.263+ extra options */
890 * H.263 advanced intra coding / MPEG-4 AC prediction
892 #define AV_CODEC_FLAG_AC_PRED (1 << 24)
894 * interlaced motion estimation
896 #define AV_CODEC_FLAG_INTERLACED_ME (1 << 29)
897 #define AV_CODEC_FLAG_CLOSED_GOP (1U << 31)
900 * Allow non spec compliant speedup tricks.
902 #define AV_CODEC_FLAG2_FAST (1 << 0)
904 * Skip bitstream encoding.
906 #define AV_CODEC_FLAG2_NO_OUTPUT (1 << 2)
908 * Place global headers at every keyframe instead of in extradata.
910 #define AV_CODEC_FLAG2_LOCAL_HEADER (1 << 3)
913 * timecode is in drop frame format. DEPRECATED!!!!
915 #define AV_CODEC_FLAG2_DROP_FRAME_TIMECODE (1 << 13)
918 * Input bitstream might be truncated at a packet boundaries
919 * instead of only at frame boundaries.
921 #define AV_CODEC_FLAG2_CHUNKS (1 << 15)
923 * Discard cropping information from SPS.
925 #define AV_CODEC_FLAG2_IGNORE_CROP (1 << 16)
928 * Show all frames before the first keyframe
930 #define AV_CODEC_FLAG2_SHOW_ALL (1 << 22)
932 * Export motion vectors through frame side data
934 #define AV_CODEC_FLAG2_EXPORT_MVS (1 << 28)
936 * Do not skip samples and export skip information as frame side data
938 #define AV_CODEC_FLAG2_SKIP_MANUAL (1 << 29)
940 * Do not reset ASS ReadOrder field on flush (subtitles decoding)
942 #define AV_CODEC_FLAG2_RO_FLUSH_NOOP (1 << 30)
944 /* Unsupported options :
945 * Syntax Arithmetic coding (SAC)
946 * Reference Picture Selection
947 * Independent Segment Decoding */
949 /* codec capabilities */
952 * Decoder can use draw_horiz_band callback.
954 #define AV_CODEC_CAP_DRAW_HORIZ_BAND (1 << 0)
956 * Codec uses get_buffer() for allocating buffers and supports custom allocators.
957 * If not set, it might not use get_buffer() at all or use operations that
958 * assume the buffer was allocated by avcodec_default_get_buffer.
960 #define AV_CODEC_CAP_DR1 (1 << 1)
961 #define AV_CODEC_CAP_TRUNCATED (1 << 3)
963 * Encoder or decoder requires flushing with NULL input at the end in order to
964 * give the complete and correct output.
966 * NOTE: If this flag is not set, the codec is guaranteed to never be fed with
967 * with NULL data. The user can still send NULL data to the public encode
968 * or decode function, but libavcodec will not pass it along to the codec
969 * unless this flag is set.
972 * The decoder has a non-zero delay and needs to be fed with avpkt->data=NULL,
973 * avpkt->size=0 at the end to get the delayed data until the decoder no longer
977 * The encoder needs to be fed with NULL data at the end of encoding until the
978 * encoder no longer returns data.
980 * NOTE: For encoders implementing the AVCodec.encode2() function, setting this
981 * flag also means that the encoder must set the pts and duration for
982 * each output packet. If this flag is not set, the pts and duration will
983 * be determined by libavcodec from the input frame.
985 #define AV_CODEC_CAP_DELAY (1 << 5)
987 * Codec can be fed a final frame with a smaller size.
988 * This can be used to prevent truncation of the last audio samples.
990 #define AV_CODEC_CAP_SMALL_LAST_FRAME (1 << 6)
993 * Codec can output multiple frames per AVPacket
994 * Normally demuxers return one frame at a time, demuxers which do not do
995 * are connected to a parser to split what they return into proper frames.
996 * This flag is reserved to the very rare category of codecs which have a
997 * bitstream that cannot be split into frames without timeconsuming
998 * operations like full decoding. Demuxers carrying such bitstreams thus
999 * may return multiple frames in a packet. This has many disadvantages like
1000 * prohibiting stream copy in many cases thus it should only be considered
1003 #define AV_CODEC_CAP_SUBFRAMES (1 << 8)
1005 * Codec is experimental and is thus avoided in favor of non experimental
1008 #define AV_CODEC_CAP_EXPERIMENTAL (1 << 9)
1010 * Codec should fill in channel configuration and samplerate instead of container
1012 #define AV_CODEC_CAP_CHANNEL_CONF (1 << 10)
1014 * Codec supports frame-level multithreading.
1016 #define AV_CODEC_CAP_FRAME_THREADS (1 << 12)
1018 * Codec supports slice-based (or partition-based) multithreading.
1020 #define AV_CODEC_CAP_SLICE_THREADS (1 << 13)
1022 * Codec supports changed parameters at any point.
1024 #define AV_CODEC_CAP_PARAM_CHANGE (1 << 14)
1026 * Codec supports avctx->thread_count == 0 (auto).
1028 #define AV_CODEC_CAP_AUTO_THREADS (1 << 15)
1030 * Audio encoder supports receiving a different number of samples in each call.
1032 #define AV_CODEC_CAP_VARIABLE_FRAME_SIZE (1 << 16)
1034 * Decoder is not a preferred choice for probing.
1035 * This indicates that the decoder is not a good choice for probing.
1036 * It could for example be an expensive to spin up hardware decoder,
1037 * or it could simply not provide a lot of useful information about
1039 * A decoder marked with this flag should only be used as last resort
1040 * choice for probing.
1042 #define AV_CODEC_CAP_AVOID_PROBING (1 << 17)
1044 * Codec is intra only.
1046 #define AV_CODEC_CAP_INTRA_ONLY 0x40000000
1048 * Codec is lossless.
1050 #define AV_CODEC_CAP_LOSSLESS 0x80000000
1053 * Codec is backed by a hardware implementation. Typically used to
1054 * identify a non-hwaccel hardware decoder. For information about hwaccels, use
1055 * avcodec_get_hw_config() instead.
1057 #define AV_CODEC_CAP_HARDWARE (1 << 18)
1060 * Codec is potentially backed by a hardware implementation, but not
1061 * necessarily. This is used instead of AV_CODEC_CAP_HARDWARE, if the
1062 * implementation provides some sort of internal fallback.
1064 #define AV_CODEC_CAP_HYBRID (1 << 19)
1068 * This specifies the area which should be displayed.
1069 * Note there may be multiple such areas for one frame.
1071 typedef struct AVPanScan {
1074 * - encoding: Set by user.
1075 * - decoding: Set by libavcodec.
1080 * width and height in 1/16 pel
1081 * - encoding: Set by user.
1082 * - decoding: Set by libavcodec.
1088 * position of the top left corner in 1/16 pel for up to 3 fields/frames
1089 * - encoding: Set by user.
1090 * - decoding: Set by libavcodec.
1092 int16_t position[3][2];
1096 * This structure describes the bitrate properties of an encoded bitstream. It
1097 * roughly corresponds to a subset the VBV parameters for MPEG-2 or HRD
1098 * parameters for H.264/HEVC.
1100 typedef struct AVCPBProperties {
1102 * Maximum bitrate of the stream, in bits per second.
1103 * Zero if unknown or unspecified.
1107 * Minimum bitrate of the stream, in bits per second.
1108 * Zero if unknown or unspecified.
1112 * Average bitrate of the stream, in bits per second.
1113 * Zero if unknown or unspecified.
1118 * The size of the buffer to which the ratecontrol is applied, in bits.
1119 * Zero if unknown or unspecified.
1124 * The delay between the time the packet this structure is associated with
1125 * is received and the time when it should be decoded, in periods of a 27MHz
1128 * UINT64_MAX when unknown or unspecified.
1134 * The decoder will keep a reference to the frame and may reuse it later.
1136 #define AV_GET_BUFFER_FLAG_REF (1 << 0)
1139 * @defgroup lavc_packet AVPacket
1141 * Types and functions for working with AVPacket.
1144 enum AVPacketSideDataType {
1146 * An AV_PKT_DATA_PALETTE side data packet contains exactly AVPALETTE_SIZE
1147 * bytes worth of palette. This side data signals that a new palette is
1150 AV_PKT_DATA_PALETTE,
1153 * The AV_PKT_DATA_NEW_EXTRADATA is used to notify the codec or the format
1154 * that the extradata buffer was changed and the receiving side should
1155 * act upon it appropriately. The new extradata is embedded in the side
1156 * data buffer and should be immediately used for processing the current
1159 AV_PKT_DATA_NEW_EXTRADATA,
1162 * An AV_PKT_DATA_PARAM_CHANGE side data packet is laid out as follows:
1165 * if (param_flags & AV_SIDE_DATA_PARAM_CHANGE_CHANNEL_COUNT)
1166 * s32le channel_count
1167 * if (param_flags & AV_SIDE_DATA_PARAM_CHANGE_CHANNEL_LAYOUT)
1168 * u64le channel_layout
1169 * if (param_flags & AV_SIDE_DATA_PARAM_CHANGE_SAMPLE_RATE)
1171 * if (param_flags & AV_SIDE_DATA_PARAM_CHANGE_DIMENSIONS)
1176 AV_PKT_DATA_PARAM_CHANGE,
1179 * An AV_PKT_DATA_H263_MB_INFO side data packet contains a number of
1180 * structures with info about macroblocks relevant to splitting the
1181 * packet into smaller packets on macroblock edges (e.g. as for RFC 2190).
1182 * That is, it does not necessarily contain info about all macroblocks,
1183 * as long as the distance between macroblocks in the info is smaller
1184 * than the target payload size.
1185 * Each MB info structure is 12 bytes, and is laid out as follows:
1187 * u32le bit offset from the start of the packet
1188 * u8 current quantizer at the start of the macroblock
1190 * u16le macroblock address within the GOB
1191 * u8 horizontal MV predictor
1192 * u8 vertical MV predictor
1193 * u8 horizontal MV predictor for block number 3
1194 * u8 vertical MV predictor for block number 3
1197 AV_PKT_DATA_H263_MB_INFO,
1200 * This side data should be associated with an audio stream and contains
1201 * ReplayGain information in form of the AVReplayGain struct.
1203 AV_PKT_DATA_REPLAYGAIN,
1206 * This side data contains a 3x3 transformation matrix describing an affine
1207 * transformation that needs to be applied to the decoded video frames for
1208 * correct presentation.
1210 * See libavutil/display.h for a detailed description of the data.
1212 AV_PKT_DATA_DISPLAYMATRIX,
1215 * This side data should be associated with a video stream and contains
1216 * Stereoscopic 3D information in form of the AVStereo3D struct.
1218 AV_PKT_DATA_STEREO3D,
1221 * This side data should be associated with an audio stream and corresponds
1222 * to enum AVAudioServiceType.
1224 AV_PKT_DATA_AUDIO_SERVICE_TYPE,
1227 * This side data contains quality related information from the encoder.
1229 * u32le quality factor of the compressed frame. Allowed range is between 1 (good) and FF_LAMBDA_MAX (bad).
1233 * u64le[error count] sum of squared differences between encoder in and output
1236 AV_PKT_DATA_QUALITY_STATS,
1239 * This side data contains an integer value representing the stream index
1240 * of a "fallback" track. A fallback track indicates an alternate
1241 * track to use when the current track can not be decoded for some reason.
1242 * e.g. no decoder available for codec.
1244 AV_PKT_DATA_FALLBACK_TRACK,
1247 * This side data corresponds to the AVCPBProperties struct.
1249 AV_PKT_DATA_CPB_PROPERTIES,
1252 * Recommmends skipping the specified number of samples
1254 * u32le number of samples to skip from start of this packet
1255 * u32le number of samples to skip from end of this packet
1256 * u8 reason for start skip
1257 * u8 reason for end skip (0=padding silence, 1=convergence)
1260 AV_PKT_DATA_SKIP_SAMPLES,
1263 * An AV_PKT_DATA_JP_DUALMONO side data packet indicates that
1264 * the packet may contain "dual mono" audio specific to Japanese DTV
1265 * and if it is true, recommends only the selected channel to be used.
1267 * u8 selected channels (0=mail/left, 1=sub/right, 2=both)
1270 AV_PKT_DATA_JP_DUALMONO,
1273 * A list of zero terminated key/value strings. There is no end marker for
1274 * the list, so it is required to rely on the side data size to stop.
1276 AV_PKT_DATA_STRINGS_METADATA,
1279 * Subtitle event position
1287 AV_PKT_DATA_SUBTITLE_POSITION,
1290 * Data found in BlockAdditional element of matroska container. There is
1291 * no end marker for the data, so it is required to rely on the side data
1292 * size to recognize the end. 8 byte id (as found in BlockAddId) followed
1295 AV_PKT_DATA_MATROSKA_BLOCKADDITIONAL,
1298 * The optional first identifier line of a WebVTT cue.
1300 AV_PKT_DATA_WEBVTT_IDENTIFIER,
1303 * The optional settings (rendering instructions) that immediately
1304 * follow the timestamp specifier of a WebVTT cue.
1306 AV_PKT_DATA_WEBVTT_SETTINGS,
1309 * A list of zero terminated key/value strings. There is no end marker for
1310 * the list, so it is required to rely on the side data size to stop. This
1311 * side data includes updated metadata which appeared in the stream.
1313 AV_PKT_DATA_METADATA_UPDATE,
1316 * MPEGTS stream ID, this is required to pass the stream ID
1317 * information from the demuxer to the corresponding muxer.
1319 AV_PKT_DATA_MPEGTS_STREAM_ID,
1322 * Mastering display metadata (based on SMPTE-2086:2014). This metadata
1323 * should be associated with a video stream and contains data in the form
1324 * of the AVMasteringDisplayMetadata struct.
1326 AV_PKT_DATA_MASTERING_DISPLAY_METADATA,
1329 * This side data should be associated with a video stream and corresponds
1330 * to the AVSphericalMapping structure.
1332 AV_PKT_DATA_SPHERICAL,
1335 * Content light level (based on CTA-861.3). This metadata should be
1336 * associated with a video stream and contains data in the form of the
1337 * AVContentLightMetadata struct.
1339 AV_PKT_DATA_CONTENT_LIGHT_LEVEL,
1342 * ATSC A53 Part 4 Closed Captions. This metadata should be associated with
1343 * a video stream. A53 CC bitstream is stored as uint8_t in AVPacketSideData.data.
1344 * The number of bytes of CC data is AVPacketSideData.size.
1349 * This side data is encryption initialization data.
1350 * The format is not part of ABI, use av_encryption_init_info_* methods to
1353 AV_PKT_DATA_ENCRYPTION_INIT_INFO,
1356 * This side data contains encryption info for how to decrypt the packet.
1357 * The format is not part of ABI, use av_encryption_info_* methods to access.
1359 AV_PKT_DATA_ENCRYPTION_INFO,
1362 * The number of side data types.
1363 * This is not part of the public API/ABI in the sense that it may
1364 * change when new side data types are added.
1365 * This must stay the last enum value.
1366 * If its value becomes huge, some code using it
1367 * needs to be updated as it assumes it to be smaller than other limits.
1372 #define AV_PKT_DATA_QUALITY_FACTOR AV_PKT_DATA_QUALITY_STATS //DEPRECATED
1374 typedef struct AVPacketSideData {
1377 enum AVPacketSideDataType type;
1381 * This structure stores compressed data. It is typically exported by demuxers
1382 * and then passed as input to decoders, or received as output from encoders and
1383 * then passed to muxers.
1385 * For video, it should typically contain one compressed frame. For audio it may
1386 * contain several compressed frames. Encoders are allowed to output empty
1387 * packets, with no compressed data, containing only side data
1388 * (e.g. to update some stream parameters at the end of encoding).
1390 * AVPacket is one of the few structs in FFmpeg, whose size is a part of public
1391 * ABI. Thus it may be allocated on stack and no new fields can be added to it
1392 * without libavcodec and libavformat major bump.
1394 * The semantics of data ownership depends on the buf field.
1395 * If it is set, the packet data is dynamically allocated and is
1396 * valid indefinitely until a call to av_packet_unref() reduces the
1397 * reference count to 0.
1399 * If the buf field is not set av_packet_ref() would make a copy instead
1400 * of increasing the reference count.
1402 * The side data is always allocated with av_malloc(), copied by
1403 * av_packet_ref() and freed by av_packet_unref().
1405 * @see av_packet_ref
1406 * @see av_packet_unref
1408 typedef struct AVPacket {
1410 * A reference to the reference-counted buffer where the packet data is
1412 * May be NULL, then the packet data is not reference-counted.
1416 * Presentation timestamp in AVStream->time_base units; the time at which
1417 * the decompressed packet will be presented to the user.
1418 * Can be AV_NOPTS_VALUE if it is not stored in the file.
1419 * pts MUST be larger or equal to dts as presentation cannot happen before
1420 * decompression, unless one wants to view hex dumps. Some formats misuse
1421 * the terms dts and pts/cts to mean something different. Such timestamps
1422 * must be converted to true pts/dts before they are stored in AVPacket.
1426 * Decompression timestamp in AVStream->time_base units; the time at which
1427 * the packet is decompressed.
1428 * Can be AV_NOPTS_VALUE if it is not stored in the file.
1435 * A combination of AV_PKT_FLAG values
1439 * Additional packet data that can be provided by the container.
1440 * Packet can contain several types of side information.
1442 AVPacketSideData *side_data;
1443 int side_data_elems;
1446 * Duration of this packet in AVStream->time_base units, 0 if unknown.
1447 * Equals next_pts - this_pts in presentation order.
1451 int64_t pos; ///< byte position in stream, -1 if unknown
1453 #if FF_API_CONVERGENCE_DURATION
1455 * @deprecated Same as the duration field, but as int64_t. This was required
1456 * for Matroska subtitles, whose duration values could overflow when the
1457 * duration field was still an int.
1459 attribute_deprecated
1460 int64_t convergence_duration;
1463 #define AV_PKT_FLAG_KEY 0x0001 ///< The packet contains a keyframe
1464 #define AV_PKT_FLAG_CORRUPT 0x0002 ///< The packet content is corrupted
1466 * Flag is used to discard packets which are required to maintain valid
1467 * decoder state but are not required for output and should be dropped
1470 #define AV_PKT_FLAG_DISCARD 0x0004
1472 * The packet comes from a trusted source.
1474 * Otherwise-unsafe constructs such as arbitrary pointers to data
1475 * outside the packet may be followed.
1477 #define AV_PKT_FLAG_TRUSTED 0x0008
1479 * Flag is used to indicate packets that contain frames that can
1480 * be discarded by the decoder. I.e. Non-reference frames.
1482 #define AV_PKT_FLAG_DISPOSABLE 0x0010
1485 enum AVSideDataParamChangeFlags {
1486 AV_SIDE_DATA_PARAM_CHANGE_CHANNEL_COUNT = 0x0001,
1487 AV_SIDE_DATA_PARAM_CHANGE_CHANNEL_LAYOUT = 0x0002,
1488 AV_SIDE_DATA_PARAM_CHANGE_SAMPLE_RATE = 0x0004,
1489 AV_SIDE_DATA_PARAM_CHANGE_DIMENSIONS = 0x0008,
1495 struct AVCodecInternal;
1499 AV_FIELD_PROGRESSIVE,
1500 AV_FIELD_TT, //< Top coded_first, top displayed first
1501 AV_FIELD_BB, //< Bottom coded first, bottom displayed first
1502 AV_FIELD_TB, //< Top coded first, bottom displayed first
1503 AV_FIELD_BT, //< Bottom coded first, top displayed first
1507 * main external API structure.
1508 * New fields can be added to the end with minor version bumps.
1509 * Removal, reordering and changes to existing fields require a major
1511 * You can use AVOptions (av_opt* / av_set/get*()) to access these fields from user
1513 * The name string for AVOptions options matches the associated command line
1514 * parameter name and can be found in libavcodec/options_table.h
1515 * The AVOption/command line parameter names differ in some cases from the C
1516 * structure field names for historic reasons or brevity.
1517 * sizeof(AVCodecContext) must not be used outside libav*.
1519 typedef struct AVCodecContext {
1521 * information on struct for av_log
1522 * - set by avcodec_alloc_context3
1524 const AVClass *av_class;
1525 int log_level_offset;
1527 enum AVMediaType codec_type; /* see AVMEDIA_TYPE_xxx */
1528 const struct AVCodec *codec;
1529 enum AVCodecID codec_id; /* see AV_CODEC_ID_xxx */
1532 * fourcc (LSB first, so "ABCD" -> ('D'<<24) + ('C'<<16) + ('B'<<8) + 'A').
1533 * This is used to work around some encoder bugs.
1534 * A demuxer should set this to what is stored in the field used to identify the codec.
1535 * If there are multiple such fields in a container then the demuxer should choose the one
1536 * which maximizes the information about the used codec.
1537 * If the codec tag field in a container is larger than 32 bits then the demuxer should
1538 * remap the longer ID to 32 bits with a table or other structure. Alternatively a new
1539 * extra_codec_tag + size could be added but for this a clear advantage must be demonstrated
1541 * - encoding: Set by user, if not then the default based on codec_id will be used.
1542 * - decoding: Set by user, will be converted to uppercase by libavcodec during init.
1544 unsigned int codec_tag;
1549 * Private context used for internal data.
1551 * Unlike priv_data, this is not codec-specific. It is used in general
1552 * libavcodec functions.
1554 struct AVCodecInternal *internal;
1557 * Private data of the user, can be used to carry app specific stuff.
1558 * - encoding: Set by user.
1559 * - decoding: Set by user.
1564 * the average bitrate
1565 * - encoding: Set by user; unused for constant quantizer encoding.
1566 * - decoding: Set by user, may be overwritten by libavcodec
1567 * if this info is available in the stream
1572 * number of bits the bitstream is allowed to diverge from the reference.
1573 * the reference can be CBR (for CBR pass1) or VBR (for pass2)
1574 * - encoding: Set by user; unused for constant quantizer encoding.
1575 * - decoding: unused
1577 int bit_rate_tolerance;
1580 * Global quality for codecs which cannot change it per frame.
1581 * This should be proportional to MPEG-1/2/4 qscale.
1582 * - encoding: Set by user.
1583 * - decoding: unused
1588 * - encoding: Set by user.
1589 * - decoding: unused
1591 int compression_level;
1592 #define FF_COMPRESSION_DEFAULT -1
1596 * - encoding: Set by user.
1597 * - decoding: Set by user.
1603 * - encoding: Set by user.
1604 * - decoding: Set by user.
1609 * some codecs need / can use extradata like Huffman tables.
1610 * MJPEG: Huffman tables
1611 * rv10: additional flags
1612 * MPEG-4: global headers (they can be in the bitstream or here)
1613 * The allocated memory should be AV_INPUT_BUFFER_PADDING_SIZE bytes larger
1614 * than extradata_size to avoid problems if it is read with the bitstream reader.
1615 * The bytewise contents of extradata must not depend on the architecture or CPU endianness.
1616 * - encoding: Set/allocated/freed by libavcodec.
1617 * - decoding: Set/allocated/freed by user.
1623 * This is the fundamental unit of time (in seconds) in terms
1624 * of which frame timestamps are represented. For fixed-fps content,
1625 * timebase should be 1/framerate and timestamp increments should be
1627 * This often, but not always is the inverse of the frame rate or field rate
1628 * for video. 1/time_base is not the average frame rate if the frame rate is not
1631 * Like containers, elementary streams also can store timestamps, 1/time_base
1632 * is the unit in which these timestamps are specified.
1633 * As example of such codec time base see ISO/IEC 14496-2:2001(E)
1634 * vop_time_increment_resolution and fixed_vop_rate
1635 * (fixed_vop_rate == 0 implies that it is different from the framerate)
1637 * - encoding: MUST be set by user.
1638 * - decoding: the use of this field for decoding is deprecated.
1639 * Use framerate instead.
1641 AVRational time_base;
1644 * For some codecs, the time base is closer to the field rate than the frame rate.
1645 * Most notably, H.264 and MPEG-2 specify time_base as half of frame duration
1646 * if no telecine is used ...
1648 * Set to time_base ticks per frame. Default 1, e.g., H.264/MPEG-2 set it to 2.
1650 int ticks_per_frame;
1655 * Encoding: Number of frames delay there will be from the encoder input to
1656 * the decoder output. (we assume the decoder matches the spec)
1657 * Decoding: Number of frames delay in addition to what a standard decoder
1658 * as specified in the spec would produce.
1661 * Number of frames the decoded output will be delayed relative to the
1665 * For encoding, this field is unused (see initial_padding).
1667 * For decoding, this is the number of samples the decoder needs to
1668 * output before the decoder's output is valid. When seeking, you should
1669 * start decoding this many samples prior to your desired seek point.
1671 * - encoding: Set by libavcodec.
1672 * - decoding: Set by libavcodec.
1679 * picture width / height.
1681 * @note Those fields may not match the values of the last
1682 * AVFrame output by avcodec_decode_video2 due frame
1685 * - encoding: MUST be set by user.
1686 * - decoding: May be set by the user before opening the decoder if known e.g.
1687 * from the container. Some decoders will require the dimensions
1688 * to be set by the caller. During decoding, the decoder may
1689 * overwrite those values as required while parsing the data.
1694 * Bitstream width / height, may be different from width/height e.g. when
1695 * the decoded frame is cropped before being output or lowres is enabled.
1697 * @note Those field may not match the value of the last
1698 * AVFrame output by avcodec_receive_frame() due frame
1701 * - encoding: unused
1702 * - decoding: May be set by the user before opening the decoder if known
1703 * e.g. from the container. During decoding, the decoder may
1704 * overwrite those values as required while parsing the data.
1706 int coded_width, coded_height;
1709 * the number of pictures in a group of pictures, or 0 for intra_only
1710 * - encoding: Set by user.
1711 * - decoding: unused
1716 * Pixel format, see AV_PIX_FMT_xxx.
1717 * May be set by the demuxer if known from headers.
1718 * May be overridden by the decoder if it knows better.
1720 * @note This field may not match the value of the last
1721 * AVFrame output by avcodec_receive_frame() due frame
1724 * - encoding: Set by user.
1725 * - decoding: Set by user if known, overridden by libavcodec while
1728 enum AVPixelFormat pix_fmt;
1731 * If non NULL, 'draw_horiz_band' is called by the libavcodec
1732 * decoder to draw a horizontal band. It improves cache usage. Not
1733 * all codecs can do that. You must check the codec capabilities
1735 * When multithreading is used, it may be called from multiple threads
1736 * at the same time; threads might draw different parts of the same AVFrame,
1737 * or multiple AVFrames, and there is no guarantee that slices will be drawn
1739 * The function is also used by hardware acceleration APIs.
1740 * It is called at least once during frame decoding to pass
1741 * the data needed for hardware render.
1742 * In that mode instead of pixel data, AVFrame points to
1743 * a structure specific to the acceleration API. The application
1744 * reads the structure and can change some fields to indicate progress
1746 * - encoding: unused
1747 * - decoding: Set by user.
1748 * @param height the height of the slice
1749 * @param y the y position of the slice
1750 * @param type 1->top field, 2->bottom field, 3->frame
1751 * @param offset offset into the AVFrame.data from which the slice should be read
1753 void (*draw_horiz_band)(struct AVCodecContext *s,
1754 const AVFrame *src, int offset[AV_NUM_DATA_POINTERS],
1755 int y, int type, int height);
1758 * callback to negotiate the pixelFormat
1759 * @param fmt is the list of formats which are supported by the codec,
1760 * it is terminated by -1 as 0 is a valid format, the formats are ordered by quality.
1761 * The first is always the native one.
1762 * @note The callback may be called again immediately if initialization for
1763 * the selected (hardware-accelerated) pixel format failed.
1764 * @warning Behavior is undefined if the callback returns a value not
1765 * in the fmt list of formats.
1766 * @return the chosen format
1767 * - encoding: unused
1768 * - decoding: Set by user, if not set the native format will be chosen.
1770 enum AVPixelFormat (*get_format)(struct AVCodecContext *s, const enum AVPixelFormat * fmt);
1773 * maximum number of B-frames between non-B-frames
1774 * Note: The output will be delayed by max_b_frames+1 relative to the input.
1775 * - encoding: Set by user.
1776 * - decoding: unused
1781 * qscale factor between IP and B-frames
1782 * If > 0 then the last P-frame quantizer will be used (q= lastp_q*factor+offset).
1783 * If < 0 then normal ratecontrol will be done (q= -normal_q*factor+offset).
1784 * - encoding: Set by user.
1785 * - decoding: unused
1787 float b_quant_factor;
1789 #if FF_API_PRIVATE_OPT
1790 /** @deprecated use encoder private options instead */
1791 attribute_deprecated
1792 int b_frame_strategy;
1796 * qscale offset between IP and B-frames
1797 * - encoding: Set by user.
1798 * - decoding: unused
1800 float b_quant_offset;
1803 * Size of the frame reordering buffer in the decoder.
1804 * For MPEG-2 it is 1 IPB or 0 low delay IP.
1805 * - encoding: Set by libavcodec.
1806 * - decoding: Set by libavcodec.
1810 #if FF_API_PRIVATE_OPT
1811 /** @deprecated use encoder private options instead */
1812 attribute_deprecated
1817 * qscale factor between P- and I-frames
1818 * If > 0 then the last P-frame quantizer will be used (q = lastp_q * factor + offset).
1819 * If < 0 then normal ratecontrol will be done (q= -normal_q*factor+offset).
1820 * - encoding: Set by user.
1821 * - decoding: unused
1823 float i_quant_factor;
1826 * qscale offset between P and I-frames
1827 * - encoding: Set by user.
1828 * - decoding: unused
1830 float i_quant_offset;
1833 * luminance masking (0-> disabled)
1834 * - encoding: Set by user.
1835 * - decoding: unused
1840 * temporary complexity masking (0-> disabled)
1841 * - encoding: Set by user.
1842 * - decoding: unused
1844 float temporal_cplx_masking;
1847 * spatial complexity masking (0-> disabled)
1848 * - encoding: Set by user.
1849 * - decoding: unused
1851 float spatial_cplx_masking;
1854 * p block masking (0-> disabled)
1855 * - encoding: Set by user.
1856 * - decoding: unused
1861 * darkness masking (0-> disabled)
1862 * - encoding: Set by user.
1863 * - decoding: unused
1869 * - encoding: Set by libavcodec.
1870 * - decoding: Set by user (or 0).
1874 #if FF_API_PRIVATE_OPT
1875 /** @deprecated use encoder private options instead */
1876 attribute_deprecated
1877 int prediction_method;
1878 #define FF_PRED_LEFT 0
1879 #define FF_PRED_PLANE 1
1880 #define FF_PRED_MEDIAN 2
1884 * slice offsets in the frame in bytes
1885 * - encoding: Set/allocated by libavcodec.
1886 * - decoding: Set/allocated by user (or NULL).
1891 * sample aspect ratio (0 if unknown)
1892 * That is the width of a pixel divided by the height of the pixel.
1893 * Numerator and denominator must be relatively prime and smaller than 256 for some video standards.
1894 * - encoding: Set by user.
1895 * - decoding: Set by libavcodec.
1897 AVRational sample_aspect_ratio;
1900 * motion estimation comparison function
1901 * - encoding: Set by user.
1902 * - decoding: unused
1906 * subpixel motion estimation comparison function
1907 * - encoding: Set by user.
1908 * - decoding: unused
1912 * macroblock comparison function (not supported yet)
1913 * - encoding: Set by user.
1914 * - decoding: unused
1918 * interlaced DCT comparison function
1919 * - encoding: Set by user.
1920 * - decoding: unused
1923 #define FF_CMP_SAD 0
1924 #define FF_CMP_SSE 1
1925 #define FF_CMP_SATD 2
1926 #define FF_CMP_DCT 3
1927 #define FF_CMP_PSNR 4
1928 #define FF_CMP_BIT 5
1930 #define FF_CMP_ZERO 7
1931 #define FF_CMP_VSAD 8
1932 #define FF_CMP_VSSE 9
1933 #define FF_CMP_NSSE 10
1934 #define FF_CMP_W53 11
1935 #define FF_CMP_W97 12
1936 #define FF_CMP_DCTMAX 13
1937 #define FF_CMP_DCT264 14
1938 #define FF_CMP_MEDIAN_SAD 15
1939 #define FF_CMP_CHROMA 256
1942 * ME diamond size & shape
1943 * - encoding: Set by user.
1944 * - decoding: unused
1949 * amount of previous MV predictors (2a+1 x 2a+1 square)
1950 * - encoding: Set by user.
1951 * - decoding: unused
1953 int last_predictor_count;
1955 #if FF_API_PRIVATE_OPT
1956 /** @deprecated use encoder private options instead */
1957 attribute_deprecated
1962 * motion estimation prepass comparison function
1963 * - encoding: Set by user.
1964 * - decoding: unused
1969 * ME prepass diamond size & shape
1970 * - encoding: Set by user.
1971 * - decoding: unused
1977 * - encoding: Set by user.
1978 * - decoding: unused
1980 int me_subpel_quality;
1983 * maximum motion estimation search range in subpel units
1984 * If 0 then no limit.
1986 * - encoding: Set by user.
1987 * - decoding: unused
1993 * - encoding: unused
1994 * - decoding: Set by user.
1997 #define SLICE_FLAG_CODED_ORDER 0x0001 ///< draw_horiz_band() is called in coded order instead of display
1998 #define SLICE_FLAG_ALLOW_FIELD 0x0002 ///< allow draw_horiz_band() with field slices (MPEG-2 field pics)
1999 #define SLICE_FLAG_ALLOW_PLANE 0x0004 ///< allow draw_horiz_band() with 1 component at a time (SVQ1)
2002 * macroblock decision mode
2003 * - encoding: Set by user.
2004 * - decoding: unused
2007 #define FF_MB_DECISION_SIMPLE 0 ///< uses mb_cmp
2008 #define FF_MB_DECISION_BITS 1 ///< chooses the one which needs the fewest bits
2009 #define FF_MB_DECISION_RD 2 ///< rate distortion
2012 * custom intra quantization matrix
2013 * - encoding: Set by user, can be NULL.
2014 * - decoding: Set by libavcodec.
2016 uint16_t *intra_matrix;
2019 * custom inter quantization matrix
2020 * - encoding: Set by user, can be NULL.
2021 * - decoding: Set by libavcodec.
2023 uint16_t *inter_matrix;
2025 #if FF_API_PRIVATE_OPT
2026 /** @deprecated use encoder private options instead */
2027 attribute_deprecated
2028 int scenechange_threshold;
2030 /** @deprecated use encoder private options instead */
2031 attribute_deprecated
2032 int noise_reduction;
2036 * precision of the intra DC coefficient - 8
2037 * - encoding: Set by user.
2038 * - decoding: Set by libavcodec
2040 int intra_dc_precision;
2043 * Number of macroblock rows at the top which are skipped.
2044 * - encoding: unused
2045 * - decoding: Set by user.
2050 * Number of macroblock rows at the bottom which are skipped.
2051 * - encoding: unused
2052 * - decoding: Set by user.
2057 * minimum MB Lagrange multiplier
2058 * - encoding: Set by user.
2059 * - decoding: unused
2064 * maximum MB Lagrange multiplier
2065 * - encoding: Set by user.
2066 * - decoding: unused
2070 #if FF_API_PRIVATE_OPT
2072 * @deprecated use encoder private options instead
2074 attribute_deprecated
2075 int me_penalty_compensation;
2079 * - encoding: Set by user.
2080 * - decoding: unused
2084 #if FF_API_PRIVATE_OPT
2085 /** @deprecated use encoder private options instead */
2086 attribute_deprecated
2092 * - encoding: Set by user.
2093 * - decoding: unused
2098 * number of reference frames
2099 * - encoding: Set by user.
2100 * - decoding: Set by lavc.
2104 #if FF_API_PRIVATE_OPT
2105 /** @deprecated use encoder private options instead */
2106 attribute_deprecated
2111 * Note: Value depends upon the compare function used for fullpel ME.
2112 * - encoding: Set by user.
2113 * - decoding: unused
2117 #if FF_API_PRIVATE_OPT
2118 /** @deprecated use encoder private options instead */
2119 attribute_deprecated
2124 * Chromaticity coordinates of the source primaries.
2125 * - encoding: Set by user
2126 * - decoding: Set by libavcodec
2128 enum AVColorPrimaries color_primaries;
2131 * Color Transfer Characteristic.
2132 * - encoding: Set by user
2133 * - decoding: Set by libavcodec
2135 enum AVColorTransferCharacteristic color_trc;
2138 * YUV colorspace type.
2139 * - encoding: Set by user
2140 * - decoding: Set by libavcodec
2142 enum AVColorSpace colorspace;
2145 * MPEG vs JPEG YUV range.
2146 * - encoding: Set by user
2147 * - decoding: Set by libavcodec
2149 enum AVColorRange color_range;
2152 * This defines the location of chroma samples.
2153 * - encoding: Set by user
2154 * - decoding: Set by libavcodec
2156 enum AVChromaLocation chroma_sample_location;
2160 * Indicates number of picture subdivisions. Used for parallelized
2162 * - encoding: Set by user
2163 * - decoding: unused
2168 * - encoding: set by libavcodec
2169 * - decoding: Set by user.
2171 enum AVFieldOrder field_order;
2174 int sample_rate; ///< samples per second
2175 int channels; ///< number of audio channels
2178 * audio sample format
2179 * - encoding: Set by user.
2180 * - decoding: Set by libavcodec.
2182 enum AVSampleFormat sample_fmt; ///< sample format
2184 /* The following data should not be initialized. */
2186 * Number of samples per channel in an audio frame.
2188 * - encoding: set by libavcodec in avcodec_open2(). Each submitted frame
2189 * except the last must contain exactly frame_size samples per channel.
2190 * May be 0 when the codec has AV_CODEC_CAP_VARIABLE_FRAME_SIZE set, then the
2191 * frame size is not restricted.
2192 * - decoding: may be set by some decoders to indicate constant frame size
2197 * Frame counter, set by libavcodec.
2199 * - decoding: total number of frames returned from the decoder so far.
2200 * - encoding: total number of frames passed to the encoder so far.
2202 * @note the counter is not incremented if encoding/decoding resulted in
2208 * number of bytes per packet if constant and known or 0
2209 * Used by some WAV based audio codecs.
2214 * Audio cutoff bandwidth (0 means "automatic")
2215 * - encoding: Set by user.
2216 * - decoding: unused
2221 * Audio channel layout.
2222 * - encoding: set by user.
2223 * - decoding: set by user, may be overwritten by libavcodec.
2225 uint64_t channel_layout;
2228 * Request decoder to use this channel layout if it can (0 for default)
2229 * - encoding: unused
2230 * - decoding: Set by user.
2232 uint64_t request_channel_layout;
2235 * Type of service that the audio stream conveys.
2236 * - encoding: Set by user.
2237 * - decoding: Set by libavcodec.
2239 enum AVAudioServiceType audio_service_type;
2242 * desired sample format
2243 * - encoding: Not used.
2244 * - decoding: Set by user.
2245 * Decoder will decode to this format if it can.
2247 enum AVSampleFormat request_sample_fmt;
2250 * This callback is called at the beginning of each frame to get data
2251 * buffer(s) for it. There may be one contiguous buffer for all the data or
2252 * there may be a buffer per each data plane or anything in between. What
2253 * this means is, you may set however many entries in buf[] you feel necessary.
2254 * Each buffer must be reference-counted using the AVBuffer API (see description
2257 * The following fields will be set in the frame before this callback is
2260 * - width, height (video only)
2261 * - sample_rate, channel_layout, nb_samples (audio only)
2262 * Their values may differ from the corresponding values in
2263 * AVCodecContext. This callback must use the frame values, not the codec
2264 * context values, to calculate the required buffer size.
2266 * This callback must fill the following fields in the frame:
2270 * * if the data is planar audio with more than 8 channels, then this
2271 * callback must allocate and fill extended_data to contain all pointers
2272 * to all data planes. data[] must hold as many pointers as it can.
2273 * extended_data must be allocated with av_malloc() and will be freed in
2275 * * otherwise extended_data must point to data
2276 * - buf[] must contain one or more pointers to AVBufferRef structures. Each of
2277 * the frame's data and extended_data pointers must be contained in these. That
2278 * is, one AVBufferRef for each allocated chunk of memory, not necessarily one
2279 * AVBufferRef per data[] entry. See: av_buffer_create(), av_buffer_alloc(),
2280 * and av_buffer_ref().
2281 * - extended_buf and nb_extended_buf must be allocated with av_malloc() by
2282 * this callback and filled with the extra buffers if there are more
2283 * buffers than buf[] can hold. extended_buf will be freed in
2286 * If AV_CODEC_CAP_DR1 is not set then get_buffer2() must call
2287 * avcodec_default_get_buffer2() instead of providing buffers allocated by
2290 * Each data plane must be aligned to the maximum required by the target
2293 * @see avcodec_default_get_buffer2()
2297 * If AV_GET_BUFFER_FLAG_REF is set in flags then the frame may be reused
2298 * (read and/or written to if it is writable) later by libavcodec.
2300 * avcodec_align_dimensions2() should be used to find the required width and
2301 * height, as they normally need to be rounded up to the next multiple of 16.
2303 * Some decoders do not support linesizes changing between frames.
2305 * If frame multithreading is used and thread_safe_callbacks is set,
2306 * this callback may be called from a different thread, but not from more
2307 * than one at once. Does not need to be reentrant.
2309 * @see avcodec_align_dimensions2()
2313 * Decoders request a buffer of a particular size by setting
2314 * AVFrame.nb_samples prior to calling get_buffer2(). The decoder may,
2315 * however, utilize only part of the buffer by setting AVFrame.nb_samples
2316 * to a smaller value in the output frame.
2318 * As a convenience, av_samples_get_buffer_size() and
2319 * av_samples_fill_arrays() in libavutil may be used by custom get_buffer2()
2320 * functions to find the required data size and to fill data pointers and
2321 * linesize. In AVFrame.linesize, only linesize[0] may be set for audio
2322 * since all planes must be the same size.
2324 * @see av_samples_get_buffer_size(), av_samples_fill_arrays()
2326 * - encoding: unused
2327 * - decoding: Set by libavcodec, user can override.
2329 int (*get_buffer2)(struct AVCodecContext *s, AVFrame *frame, int flags);
2332 * If non-zero, the decoded audio and video frames returned from
2333 * avcodec_decode_video2() and avcodec_decode_audio4() are reference-counted
2334 * and are valid indefinitely. The caller must free them with
2335 * av_frame_unref() when they are not needed anymore.
2336 * Otherwise, the decoded frames must not be freed by the caller and are
2337 * only valid until the next decode call.
2339 * This is always automatically enabled if avcodec_receive_frame() is used.
2341 * - encoding: unused
2342 * - decoding: set by the caller before avcodec_open2().
2344 attribute_deprecated
2345 int refcounted_frames;
2347 /* - encoding parameters */
2348 float qcompress; ///< amount of qscale change between easy & hard scenes (0.0-1.0)
2349 float qblur; ///< amount of qscale smoothing over time (0.0-1.0)
2353 * - encoding: Set by user.
2354 * - decoding: unused
2360 * - encoding: Set by user.
2361 * - decoding: unused
2366 * maximum quantizer difference between frames
2367 * - encoding: Set by user.
2368 * - decoding: unused
2373 * decoder bitstream buffer size
2374 * - encoding: Set by user.
2375 * - decoding: unused
2380 * ratecontrol override, see RcOverride
2381 * - encoding: Allocated/set/freed by user.
2382 * - decoding: unused
2384 int rc_override_count;
2385 RcOverride *rc_override;
2389 * - encoding: Set by user.
2390 * - decoding: Set by user, may be overwritten by libavcodec.
2392 int64_t rc_max_rate;
2396 * - encoding: Set by user.
2397 * - decoding: unused
2399 int64_t rc_min_rate;
2402 * Ratecontrol attempt to use, at maximum, <value> of what can be used without an underflow.
2403 * - encoding: Set by user.
2404 * - decoding: unused.
2406 float rc_max_available_vbv_use;
2409 * Ratecontrol attempt to use, at least, <value> times the amount needed to prevent a vbv overflow.
2410 * - encoding: Set by user.
2411 * - decoding: unused.
2413 float rc_min_vbv_overflow_use;
2416 * Number of bits which should be loaded into the rc buffer before decoding starts.
2417 * - encoding: Set by user.
2418 * - decoding: unused
2420 int rc_initial_buffer_occupancy;
2422 #if FF_API_CODER_TYPE
2423 #define FF_CODER_TYPE_VLC 0
2424 #define FF_CODER_TYPE_AC 1
2425 #define FF_CODER_TYPE_RAW 2
2426 #define FF_CODER_TYPE_RLE 3
2428 * @deprecated use encoder private options instead
2430 attribute_deprecated
2432 #endif /* FF_API_CODER_TYPE */
2434 #if FF_API_PRIVATE_OPT
2435 /** @deprecated use encoder private options instead */
2436 attribute_deprecated
2440 #if FF_API_PRIVATE_OPT
2441 /** @deprecated use encoder private options instead */
2442 attribute_deprecated
2443 int frame_skip_threshold;
2445 /** @deprecated use encoder private options instead */
2446 attribute_deprecated
2447 int frame_skip_factor;
2449 /** @deprecated use encoder private options instead */
2450 attribute_deprecated
2453 /** @deprecated use encoder private options instead */
2454 attribute_deprecated
2456 #endif /* FF_API_PRIVATE_OPT */
2459 * trellis RD quantization
2460 * - encoding: Set by user.
2461 * - decoding: unused
2465 #if FF_API_PRIVATE_OPT
2466 /** @deprecated use encoder private options instead */
2467 attribute_deprecated
2468 int min_prediction_order;
2470 /** @deprecated use encoder private options instead */
2471 attribute_deprecated
2472 int max_prediction_order;
2474 /** @deprecated use encoder private options instead */
2475 attribute_deprecated
2476 int64_t timecode_frame_start;
2479 #if FF_API_RTP_CALLBACK
2481 * @deprecated unused
2483 /* The RTP callback: This function is called */
2484 /* every time the encoder has a packet to send. */
2485 /* It depends on the encoder if the data starts */
2486 /* with a Start Code (it should). H.263 does. */
2487 /* mb_nb contains the number of macroblocks */
2488 /* encoded in the RTP payload. */
2489 attribute_deprecated
2490 void (*rtp_callback)(struct AVCodecContext *avctx, void *data, int size, int mb_nb);
2493 #if FF_API_PRIVATE_OPT
2494 /** @deprecated use encoder private options instead */
2495 attribute_deprecated
2496 int rtp_payload_size; /* The size of the RTP payload: the coder will */
2497 /* do its best to deliver a chunk with size */
2498 /* below rtp_payload_size, the chunk will start */
2499 /* with a start code on some codecs like H.263. */
2500 /* This doesn't take account of any particular */
2501 /* headers inside the transmitted RTP payload. */
2504 #if FF_API_STAT_BITS
2505 /* statistics, used for 2-pass encoding */
2506 attribute_deprecated
2508 attribute_deprecated
2510 attribute_deprecated
2512 attribute_deprecated
2514 attribute_deprecated
2516 attribute_deprecated
2518 attribute_deprecated
2520 attribute_deprecated
2523 /** @deprecated this field is unused */
2524 attribute_deprecated
2529 * pass1 encoding statistics output buffer
2530 * - encoding: Set by libavcodec.
2531 * - decoding: unused
2536 * pass2 encoding statistics input buffer
2537 * Concatenated stuff from stats_out of pass1 should be placed here.
2538 * - encoding: Allocated/set/freed by user.
2539 * - decoding: unused
2544 * Work around bugs in encoders which sometimes cannot be detected automatically.
2545 * - encoding: Set by user
2546 * - decoding: Set by user
2548 int workaround_bugs;
2549 #define FF_BUG_AUTODETECT 1 ///< autodetection
2550 #define FF_BUG_XVID_ILACE 4
2551 #define FF_BUG_UMP4 8
2552 #define FF_BUG_NO_PADDING 16
2553 #define FF_BUG_AMV 32
2554 #define FF_BUG_QPEL_CHROMA 64
2555 #define FF_BUG_STD_QPEL 128
2556 #define FF_BUG_QPEL_CHROMA2 256
2557 #define FF_BUG_DIRECT_BLOCKSIZE 512
2558 #define FF_BUG_EDGE 1024
2559 #define FF_BUG_HPEL_CHROMA 2048
2560 #define FF_BUG_DC_CLIP 4096
2561 #define FF_BUG_MS 8192 ///< Work around various bugs in Microsoft's broken decoders.
2562 #define FF_BUG_TRUNCATED 16384
2563 #define FF_BUG_IEDGE 32768
2566 * strictly follow the standard (MPEG-4, ...).
2567 * - encoding: Set by user.
2568 * - decoding: Set by user.
2569 * Setting this to STRICT or higher means the encoder and decoder will
2570 * generally do stupid things, whereas setting it to unofficial or lower
2571 * will mean the encoder might produce output that is not supported by all
2572 * spec-compliant decoders. Decoders don't differentiate between normal,
2573 * unofficial and experimental (that is, they always try to decode things
2574 * when they can) unless they are explicitly asked to behave stupidly
2575 * (=strictly conform to the specs)
2577 int strict_std_compliance;
2578 #define FF_COMPLIANCE_VERY_STRICT 2 ///< Strictly conform to an older more strict version of the spec or reference software.
2579 #define FF_COMPLIANCE_STRICT 1 ///< Strictly conform to all the things in the spec no matter what consequences.
2580 #define FF_COMPLIANCE_NORMAL 0
2581 #define FF_COMPLIANCE_UNOFFICIAL -1 ///< Allow unofficial extensions
2582 #define FF_COMPLIANCE_EXPERIMENTAL -2 ///< Allow nonstandardized experimental things.
2585 * error concealment flags
2586 * - encoding: unused
2587 * - decoding: Set by user.
2589 int error_concealment;
2590 #define FF_EC_GUESS_MVS 1
2591 #define FF_EC_DEBLOCK 2
2592 #define FF_EC_FAVOR_INTER 256
2596 * - encoding: Set by user.
2597 * - decoding: Set by user.
2600 #define FF_DEBUG_PICT_INFO 1
2601 #define FF_DEBUG_RC 2
2602 #define FF_DEBUG_BITSTREAM 4
2603 #define FF_DEBUG_MB_TYPE 8
2604 #define FF_DEBUG_QP 16
2607 * @deprecated this option does nothing
2609 #define FF_DEBUG_MV 32
2611 #define FF_DEBUG_DCT_COEFF 0x00000040
2612 #define FF_DEBUG_SKIP 0x00000080
2613 #define FF_DEBUG_STARTCODE 0x00000100
2614 #define FF_DEBUG_ER 0x00000400
2615 #define FF_DEBUG_MMCO 0x00000800
2616 #define FF_DEBUG_BUGS 0x00001000
2618 #define FF_DEBUG_VIS_QP 0x00002000
2619 #define FF_DEBUG_VIS_MB_TYPE 0x00004000
2621 #define FF_DEBUG_BUFFERS 0x00008000
2622 #define FF_DEBUG_THREADS 0x00010000
2623 #define FF_DEBUG_GREEN_MD 0x00800000
2624 #define FF_DEBUG_NOMC 0x01000000
2629 * - encoding: Set by user.
2630 * - decoding: Set by user.
2633 #define FF_DEBUG_VIS_MV_P_FOR 0x00000001 // visualize forward predicted MVs of P-frames
2634 #define FF_DEBUG_VIS_MV_B_FOR 0x00000002 // visualize forward predicted MVs of B-frames
2635 #define FF_DEBUG_VIS_MV_B_BACK 0x00000004 // visualize backward predicted MVs of B-frames
2639 * Error recognition; may misdetect some more or less valid parts as errors.
2640 * - encoding: unused
2641 * - decoding: Set by user.
2643 int err_recognition;
2646 * Verify checksums embedded in the bitstream (could be of either encoded or
2647 * decoded data, depending on the codec) and print an error message on mismatch.
2648 * If AV_EF_EXPLODE is also set, a mismatching checksum will result in the
2649 * decoder returning an error.
2651 #define AV_EF_CRCCHECK (1<<0)
2652 #define AV_EF_BITSTREAM (1<<1) ///< detect bitstream specification deviations
2653 #define AV_EF_BUFFER (1<<2) ///< detect improper bitstream length
2654 #define AV_EF_EXPLODE (1<<3) ///< abort decoding on minor error detection
2656 #define AV_EF_IGNORE_ERR (1<<15) ///< ignore errors and continue
2657 #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
2658 #define AV_EF_COMPLIANT (1<<17) ///< consider all spec non compliances as errors
2659 #define AV_EF_AGGRESSIVE (1<<18) ///< consider things that a sane encoder should not do as an error
2663 * opaque 64-bit number (generally a PTS) that will be reordered and
2664 * output in AVFrame.reordered_opaque
2665 * - encoding: unused
2666 * - decoding: Set by user.
2668 int64_t reordered_opaque;
2671 * Hardware accelerator in use
2672 * - encoding: unused.
2673 * - decoding: Set by libavcodec
2675 const struct AVHWAccel *hwaccel;
2678 * Hardware accelerator context.
2679 * For some hardware accelerators, a global context needs to be
2680 * provided by the user. In that case, this holds display-dependent
2681 * data FFmpeg cannot instantiate itself. Please refer to the
2682 * FFmpeg HW accelerator documentation to know how to fill this
2683 * is. e.g. for VA API, this is a struct vaapi_context.
2684 * - encoding: unused
2685 * - decoding: Set by user
2687 void *hwaccel_context;
2691 * - encoding: Set by libavcodec if flags & AV_CODEC_FLAG_PSNR.
2692 * - decoding: unused
2694 uint64_t error[AV_NUM_DATA_POINTERS];
2697 * DCT algorithm, see FF_DCT_* below
2698 * - encoding: Set by user.
2699 * - decoding: unused
2702 #define FF_DCT_AUTO 0
2703 #define FF_DCT_FASTINT 1
2704 #define FF_DCT_INT 2
2705 #define FF_DCT_MMX 3
2706 #define FF_DCT_ALTIVEC 5
2707 #define FF_DCT_FAAN 6
2710 * IDCT algorithm, see FF_IDCT_* below.
2711 * - encoding: Set by user.
2712 * - decoding: Set by user.
2715 #define FF_IDCT_AUTO 0
2716 #define FF_IDCT_INT 1
2717 #define FF_IDCT_SIMPLE 2
2718 #define FF_IDCT_SIMPLEMMX 3
2719 #define FF_IDCT_ARM 7
2720 #define FF_IDCT_ALTIVEC 8
2721 #define FF_IDCT_SIMPLEARM 10
2722 #define FF_IDCT_XVID 14
2723 #define FF_IDCT_SIMPLEARMV5TE 16
2724 #define FF_IDCT_SIMPLEARMV6 17
2725 #define FF_IDCT_FAAN 20
2726 #define FF_IDCT_SIMPLENEON 22
2727 #define FF_IDCT_NONE 24 /* Used by XvMC to extract IDCT coefficients with FF_IDCT_PERM_NONE */
2728 #define FF_IDCT_SIMPLEAUTO 128
2731 * bits per sample/pixel from the demuxer (needed for huffyuv).
2732 * - encoding: Set by libavcodec.
2733 * - decoding: Set by user.
2735 int bits_per_coded_sample;
2738 * Bits per sample/pixel of internal libavcodec pixel/sample format.
2739 * - encoding: set by user.
2740 * - decoding: set by libavcodec.
2742 int bits_per_raw_sample;
2746 * low resolution decoding, 1-> 1/2 size, 2->1/4 size
2747 * - encoding: unused
2748 * - decoding: Set by user.
2753 #if FF_API_CODED_FRAME
2755 * the picture in the bitstream
2756 * - encoding: Set by libavcodec.
2757 * - decoding: unused
2759 * @deprecated use the quality factor packet side data instead
2761 attribute_deprecated AVFrame *coded_frame;
2766 * is used to decide how many independent tasks should be passed to execute()
2767 * - encoding: Set by user.
2768 * - decoding: Set by user.
2773 * Which multithreading methods to use.
2774 * Use of FF_THREAD_FRAME will increase decoding delay by one frame per thread,
2775 * so clients which cannot provide future frames should not use it.
2777 * - encoding: Set by user, otherwise the default is used.
2778 * - decoding: Set by user, otherwise the default is used.
2781 #define FF_THREAD_FRAME 1 ///< Decode more than one frame at once
2782 #define FF_THREAD_SLICE 2 ///< Decode more than one part of a single frame at once
2785 * Which multithreading methods are in use by the codec.
2786 * - encoding: Set by libavcodec.
2787 * - decoding: Set by libavcodec.
2789 int active_thread_type;
2792 * Set by the client if its custom get_buffer() callback can be called
2793 * synchronously from another thread, which allows faster multithreaded decoding.
2794 * draw_horiz_band() will be called from other threads regardless of this setting.
2795 * Ignored if the default get_buffer() is used.
2796 * - encoding: Set by user.
2797 * - decoding: Set by user.
2799 int thread_safe_callbacks;
2802 * The codec may call this to execute several independent things.
2803 * It will return only after finishing all tasks.
2804 * The user may replace this with some multithreaded implementation,
2805 * the default implementation will execute the parts serially.
2806 * @param count the number of things to execute
2807 * - encoding: Set by libavcodec, user can override.
2808 * - decoding: Set by libavcodec, user can override.
2810 int (*execute)(struct AVCodecContext *c, int (*func)(struct AVCodecContext *c2, void *arg), void *arg2, int *ret, int count, int size);
2813 * The codec may call this to execute several independent things.
2814 * It will return only after finishing all tasks.
2815 * The user may replace this with some multithreaded implementation,
2816 * the default implementation will execute the parts serially.
2817 * Also see avcodec_thread_init and e.g. the --enable-pthread configure option.
2818 * @param c context passed also to func
2819 * @param count the number of things to execute
2820 * @param arg2 argument passed unchanged to func
2821 * @param ret return values of executed functions, must have space for "count" values. May be NULL.
2822 * @param func function that will be called count times, with jobnr from 0 to count-1.
2823 * threadnr will be in the range 0 to c->thread_count-1 < MAX_THREADS and so that no
2824 * two instances of func executing at the same time will have the same threadnr.
2825 * @return always 0 currently, but code should handle a future improvement where when any call to func
2826 * returns < 0 no further calls to func may be done and < 0 is returned.
2827 * - encoding: Set by libavcodec, user can override.
2828 * - decoding: Set by libavcodec, user can override.
2830 int (*execute2)(struct AVCodecContext *c, int (*func)(struct AVCodecContext *c2, void *arg, int jobnr, int threadnr), void *arg2, int *ret, int count);
2833 * noise vs. sse weight for the nsse comparison function
2834 * - encoding: Set by user.
2835 * - decoding: unused
2841 * - encoding: Set by user.
2842 * - decoding: Set by libavcodec.
2845 #define FF_PROFILE_UNKNOWN -99
2846 #define FF_PROFILE_RESERVED -100
2848 #define FF_PROFILE_AAC_MAIN 0
2849 #define FF_PROFILE_AAC_LOW 1
2850 #define FF_PROFILE_AAC_SSR 2
2851 #define FF_PROFILE_AAC_LTP 3
2852 #define FF_PROFILE_AAC_HE 4
2853 #define FF_PROFILE_AAC_HE_V2 28
2854 #define FF_PROFILE_AAC_LD 22
2855 #define FF_PROFILE_AAC_ELD 38
2856 #define FF_PROFILE_MPEG2_AAC_LOW 128
2857 #define FF_PROFILE_MPEG2_AAC_HE 131
2859 #define FF_PROFILE_DNXHD 0
2860 #define FF_PROFILE_DNXHR_LB 1
2861 #define FF_PROFILE_DNXHR_SQ 2
2862 #define FF_PROFILE_DNXHR_HQ 3
2863 #define FF_PROFILE_DNXHR_HQX 4
2864 #define FF_PROFILE_DNXHR_444 5
2866 #define FF_PROFILE_DTS 20
2867 #define FF_PROFILE_DTS_ES 30
2868 #define FF_PROFILE_DTS_96_24 40
2869 #define FF_PROFILE_DTS_HD_HRA 50
2870 #define FF_PROFILE_DTS_HD_MA 60
2871 #define FF_PROFILE_DTS_EXPRESS 70
2873 #define FF_PROFILE_MPEG2_422 0
2874 #define FF_PROFILE_MPEG2_HIGH 1
2875 #define FF_PROFILE_MPEG2_SS 2
2876 #define FF_PROFILE_MPEG2_SNR_SCALABLE 3
2877 #define FF_PROFILE_MPEG2_MAIN 4
2878 #define FF_PROFILE_MPEG2_SIMPLE 5
2880 #define FF_PROFILE_H264_CONSTRAINED (1<<9) // 8+1; constraint_set1_flag
2881 #define FF_PROFILE_H264_INTRA (1<<11) // 8+3; constraint_set3_flag
2883 #define FF_PROFILE_H264_BASELINE 66
2884 #define FF_PROFILE_H264_CONSTRAINED_BASELINE (66|FF_PROFILE_H264_CONSTRAINED)
2885 #define FF_PROFILE_H264_MAIN 77
2886 #define FF_PROFILE_H264_EXTENDED 88
2887 #define FF_PROFILE_H264_HIGH 100
2888 #define FF_PROFILE_H264_HIGH_10 110
2889 #define FF_PROFILE_H264_HIGH_10_INTRA (110|FF_PROFILE_H264_INTRA)
2890 #define FF_PROFILE_H264_MULTIVIEW_HIGH 118
2891 #define FF_PROFILE_H264_HIGH_422 122
2892 #define FF_PROFILE_H264_HIGH_422_INTRA (122|FF_PROFILE_H264_INTRA)
2893 #define FF_PROFILE_H264_STEREO_HIGH 128
2894 #define FF_PROFILE_H264_HIGH_444 144
2895 #define FF_PROFILE_H264_HIGH_444_PREDICTIVE 244
2896 #define FF_PROFILE_H264_HIGH_444_INTRA (244|FF_PROFILE_H264_INTRA)
2897 #define FF_PROFILE_H264_CAVLC_444 44
2899 #define FF_PROFILE_VC1_SIMPLE 0
2900 #define FF_PROFILE_VC1_MAIN 1
2901 #define FF_PROFILE_VC1_COMPLEX 2
2902 #define FF_PROFILE_VC1_ADVANCED 3
2904 #define FF_PROFILE_MPEG4_SIMPLE 0
2905 #define FF_PROFILE_MPEG4_SIMPLE_SCALABLE 1
2906 #define FF_PROFILE_MPEG4_CORE 2
2907 #define FF_PROFILE_MPEG4_MAIN 3
2908 #define FF_PROFILE_MPEG4_N_BIT 4
2909 #define FF_PROFILE_MPEG4_SCALABLE_TEXTURE 5
2910 #define FF_PROFILE_MPEG4_SIMPLE_FACE_ANIMATION 6
2911 #define FF_PROFILE_MPEG4_BASIC_ANIMATED_TEXTURE 7
2912 #define FF_PROFILE_MPEG4_HYBRID 8
2913 #define FF_PROFILE_MPEG4_ADVANCED_REAL_TIME 9
2914 #define FF_PROFILE_MPEG4_CORE_SCALABLE 10
2915 #define FF_PROFILE_MPEG4_ADVANCED_CODING 11
2916 #define FF_PROFILE_MPEG4_ADVANCED_CORE 12
2917 #define FF_PROFILE_MPEG4_ADVANCED_SCALABLE_TEXTURE 13
2918 #define FF_PROFILE_MPEG4_SIMPLE_STUDIO 14
2919 #define FF_PROFILE_MPEG4_ADVANCED_SIMPLE 15
2921 #define FF_PROFILE_JPEG2000_CSTREAM_RESTRICTION_0 1
2922 #define FF_PROFILE_JPEG2000_CSTREAM_RESTRICTION_1 2
2923 #define FF_PROFILE_JPEG2000_CSTREAM_NO_RESTRICTION 32768
2924 #define FF_PROFILE_JPEG2000_DCINEMA_2K 3
2925 #define FF_PROFILE_JPEG2000_DCINEMA_4K 4
2927 #define FF_PROFILE_VP9_0 0
2928 #define FF_PROFILE_VP9_1 1
2929 #define FF_PROFILE_VP9_2 2
2930 #define FF_PROFILE_VP9_3 3
2932 #define FF_PROFILE_HEVC_MAIN 1
2933 #define FF_PROFILE_HEVC_MAIN_10 2
2934 #define FF_PROFILE_HEVC_MAIN_STILL_PICTURE 3
2935 #define FF_PROFILE_HEVC_REXT 4
2937 #define FF_PROFILE_AV1_MAIN 0
2938 #define FF_PROFILE_AV1_HIGH 1
2939 #define FF_PROFILE_AV1_PROFESSIONAL 2
2941 #define FF_PROFILE_MJPEG_HUFFMAN_BASELINE_DCT 0xc0
2942 #define FF_PROFILE_MJPEG_HUFFMAN_EXTENDED_SEQUENTIAL_DCT 0xc1
2943 #define FF_PROFILE_MJPEG_HUFFMAN_PROGRESSIVE_DCT 0xc2
2944 #define FF_PROFILE_MJPEG_HUFFMAN_LOSSLESS 0xc3
2945 #define FF_PROFILE_MJPEG_JPEG_LS 0xf7
2947 #define FF_PROFILE_SBC_MSBC 1
2951 * - encoding: Set by user.
2952 * - decoding: Set by libavcodec.
2955 #define FF_LEVEL_UNKNOWN -99
2958 * Skip loop filtering for selected frames.
2959 * - encoding: unused
2960 * - decoding: Set by user.
2962 enum AVDiscard skip_loop_filter;
2965 * Skip IDCT/dequantization for selected frames.
2966 * - encoding: unused
2967 * - decoding: Set by user.
2969 enum AVDiscard skip_idct;
2972 * Skip decoding for selected frames.
2973 * - encoding: unused
2974 * - decoding: Set by user.
2976 enum AVDiscard skip_frame;
2979 * Header containing style information for text subtitles.
2980 * For SUBTITLE_ASS subtitle type, it should contain the whole ASS
2981 * [Script Info] and [V4+ Styles] section, plus the [Events] line and
2982 * the Format line following. It shouldn't include any Dialogue line.
2983 * - encoding: Set/allocated/freed by user (before avcodec_open2())
2984 * - decoding: Set/allocated/freed by libavcodec (by avcodec_open2())
2986 uint8_t *subtitle_header;
2987 int subtitle_header_size;
2989 #if FF_API_VBV_DELAY
2991 * VBV delay coded in the last frame (in periods of a 27 MHz clock).
2992 * Used for compliant TS muxing.
2993 * - encoding: Set by libavcodec.
2994 * - decoding: unused.
2995 * @deprecated this value is now exported as a part of
2996 * AV_PKT_DATA_CPB_PROPERTIES packet side data
2998 attribute_deprecated
3002 #if FF_API_SIDEDATA_ONLY_PKT
3004 * Encoding only and set by default. Allow encoders to output packets
3005 * that do not contain any encoded data, only side data.
3007 * Some encoders need to output such packets, e.g. to update some stream
3008 * parameters at the end of encoding.
3010 * @deprecated this field disables the default behaviour and
3011 * it is kept only for compatibility.
3013 attribute_deprecated
3014 int side_data_only_packets;
3018 * Audio only. The number of "priming" samples (padding) inserted by the
3019 * encoder at the beginning of the audio. I.e. this number of leading
3020 * decoded samples must be discarded by the caller to get the original audio
3021 * without leading padding.
3023 * - decoding: unused
3024 * - encoding: Set by libavcodec. The timestamps on the output packets are
3025 * adjusted by the encoder so that they always refer to the
3026 * first sample of the data actually contained in the packet,
3027 * including any added padding. E.g. if the timebase is
3028 * 1/samplerate and the timestamp of the first input sample is
3029 * 0, the timestamp of the first output packet will be
3032 int initial_padding;
3035 * - decoding: For codecs that store a framerate value in the compressed
3036 * bitstream, the decoder may export it here. { 0, 1} when
3038 * - encoding: May be used to signal the framerate of CFR content to an
3041 AVRational framerate;
3044 * Nominal unaccelerated pixel format, see AV_PIX_FMT_xxx.
3045 * - encoding: unused.
3046 * - decoding: Set by libavcodec before calling get_format()
3048 enum AVPixelFormat sw_pix_fmt;
3051 * Timebase in which pkt_dts/pts and AVPacket.dts/pts are.
3052 * - encoding unused.
3053 * - decoding set by user.
3055 AVRational pkt_timebase;
3059 * - encoding: unused.
3060 * - decoding: set by libavcodec.
3062 const AVCodecDescriptor *codec_descriptor;
3066 * low resolution decoding, 1-> 1/2 size, 2->1/4 size
3067 * - encoding: unused
3068 * - decoding: Set by user.
3074 * Current statistics for PTS correction.
3075 * - decoding: maintained and used by libavcodec, not intended to be used by user apps
3076 * - encoding: unused
3078 int64_t pts_correction_num_faulty_pts; /// Number of incorrect PTS values so far
3079 int64_t pts_correction_num_faulty_dts; /// Number of incorrect DTS values so far
3080 int64_t pts_correction_last_pts; /// PTS of the last frame
3081 int64_t pts_correction_last_dts; /// DTS of the last frame
3084 * Character encoding of the input subtitles file.
3085 * - decoding: set by user
3086 * - encoding: unused
3091 * Subtitles character encoding mode. Formats or codecs might be adjusting
3092 * this setting (if they are doing the conversion themselves for instance).
3093 * - decoding: set by libavcodec
3094 * - encoding: unused
3096 int sub_charenc_mode;
3097 #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)
3098 #define FF_SUB_CHARENC_MODE_AUTOMATIC 0 ///< libavcodec will select the mode itself
3099 #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
3100 #define FF_SUB_CHARENC_MODE_IGNORE 2 ///< neither convert the subtitles, nor check them for valid UTF-8
3103 * Skip processing alpha if supported by codec.
3104 * Note that if the format uses pre-multiplied alpha (common with VP6,
3105 * and recommended due to better video quality/compression)
3106 * the image will look as if alpha-blended onto a black background.
3107 * However for formats that do not use pre-multiplied alpha
3108 * there might be serious artefacts (though e.g. libswscale currently
3109 * assumes pre-multiplied alpha anyway).
3111 * - decoding: set by user
3112 * - encoding: unused
3117 * Number of samples to skip after a discontinuity
3118 * - decoding: unused
3119 * - encoding: set by libavcodec
3123 #if !FF_API_DEBUG_MV
3125 * debug motion vectors
3126 * - encoding: Set by user.
3127 * - decoding: Set by user.
3130 #define FF_DEBUG_VIS_MV_P_FOR 0x00000001 //visualize forward predicted MVs of P frames
3131 #define FF_DEBUG_VIS_MV_B_FOR 0x00000002 //visualize forward predicted MVs of B frames
3132 #define FF_DEBUG_VIS_MV_B_BACK 0x00000004 //visualize backward predicted MVs of B frames
3136 * custom intra quantization matrix
3137 * - encoding: Set by user, can be NULL.
3138 * - decoding: unused.
3140 uint16_t *chroma_intra_matrix;
3143 * dump format separator.
3144 * can be ", " or "\n " or anything else
3145 * - encoding: Set by user.
3146 * - decoding: Set by user.
3148 uint8_t *dump_separator;
3151 * ',' separated list of allowed decoders.
3152 * If NULL then all are allowed
3153 * - encoding: unused
3154 * - decoding: set by user
3156 char *codec_whitelist;
3159 * Properties of the stream that gets decoded
3160 * - encoding: unused
3161 * - decoding: set by libavcodec
3163 unsigned properties;
3164 #define FF_CODEC_PROPERTY_LOSSLESS 0x00000001
3165 #define FF_CODEC_PROPERTY_CLOSED_CAPTIONS 0x00000002
3168 * Additional data associated with the entire coded stream.
3170 * - decoding: unused
3171 * - encoding: may be set by libavcodec after avcodec_open2().
3173 AVPacketSideData *coded_side_data;
3174 int nb_coded_side_data;
3177 * A reference to the AVHWFramesContext describing the input (for encoding)
3178 * or output (decoding) frames. The reference is set by the caller and
3179 * afterwards owned (and freed) by libavcodec - it should never be read by
3180 * the caller after being set.
3182 * - decoding: This field should be set by the caller from the get_format()
3183 * callback. The previous reference (if any) will always be
3184 * unreffed by libavcodec before the get_format() call.
3186 * If the default get_buffer2() is used with a hwaccel pixel
3187 * format, then this AVHWFramesContext will be used for
3188 * allocating the frame buffers.
3190 * - encoding: For hardware encoders configured to use a hwaccel pixel
3191 * format, this field should be set by the caller to a reference
3192 * to the AVHWFramesContext describing input frames.
3193 * AVHWFramesContext.format must be equal to
3194 * AVCodecContext.pix_fmt.
3196 * This field should be set before avcodec_open2() is called.
3198 AVBufferRef *hw_frames_ctx;
3201 * Control the form of AVSubtitle.rects[N]->ass
3202 * - decoding: set by user
3203 * - encoding: unused
3205 int sub_text_format;
3206 #define FF_SUB_TEXT_FMT_ASS 0
3207 #if FF_API_ASS_TIMING
3208 #define FF_SUB_TEXT_FMT_ASS_WITH_TIMINGS 1
3212 * Audio only. The amount of padding (in samples) appended by the encoder to
3213 * the end of the audio. I.e. this number of decoded samples must be
3214 * discarded by the caller from the end of the stream to get the original
3215 * audio without any trailing padding.
3217 * - decoding: unused
3218 * - encoding: unused
3220 int trailing_padding;
3223 * The number of pixels per image to maximally accept.
3225 * - decoding: set by user
3226 * - encoding: set by user
3231 * A reference to the AVHWDeviceContext describing the device which will
3232 * be used by a hardware encoder/decoder. The reference is set by the
3233 * caller and afterwards owned (and freed) by libavcodec.
3235 * This should be used if either the codec device does not require
3236 * hardware frames or any that are used are to be allocated internally by
3237 * libavcodec. If the user wishes to supply any of the frames used as
3238 * encoder input or decoder output then hw_frames_ctx should be used
3239 * instead. When hw_frames_ctx is set in get_format() for a decoder, this
3240 * field will be ignored while decoding the associated stream segment, but
3241 * may again be used on a following one after another get_format() call.
3243 * For both encoders and decoders this field should be set before
3244 * avcodec_open2() is called and must not be written to thereafter.
3246 * Note that some decoders may require this field to be set initially in
3247 * order to support hw_frames_ctx at all - in that case, all frames
3248 * contexts used must be created on the same device.
3250 AVBufferRef *hw_device_ctx;
3253 * Bit set of AV_HWACCEL_FLAG_* flags, which affect hardware accelerated
3254 * decoding (if active).
3255 * - encoding: unused
3256 * - decoding: Set by user (either before avcodec_open2(), or in the
3257 * AVCodecContext.get_format callback)
3262 * Video decoding only. Certain video codecs support cropping, meaning that
3263 * only a sub-rectangle of the decoded frame is intended for display. This
3264 * option controls how cropping is handled by libavcodec.
3266 * When set to 1 (the default), libavcodec will apply cropping internally.
3267 * I.e. it will modify the output frame width/height fields and offset the
3268 * data pointers (only by as much as possible while preserving alignment, or
3269 * by the full amount if the AV_CODEC_FLAG_UNALIGNED flag is set) so that
3270 * the frames output by the decoder refer only to the cropped area. The
3271 * crop_* fields of the output frames will be zero.
3273 * When set to 0, the width/height fields of the output frames will be set
3274 * to the coded dimensions and the crop_* fields will describe the cropping
3275 * rectangle. Applying the cropping is left to the caller.
3277 * @warning When hardware acceleration with opaque output frames is used,
3278 * libavcodec is unable to apply cropping from the top/left border.
3280 * @note when this option is set to zero, the width/height fields of the
3281 * AVCodecContext and output AVFrames have different meanings. The codec
3282 * context fields store display dimensions (with the coded dimensions in
3283 * coded_width/height), while the frame fields store the coded dimensions
3284 * (with the display dimensions being determined by the crop_* fields).
3289 * Video decoding only. Sets the number of extra hardware frames which
3290 * the decoder will allocate for use by the caller. This must be set
3291 * before avcodec_open2() is called.
3293 * Some hardware decoders require all frames that they will use for
3294 * output to be defined in advance before decoding starts. For such
3295 * decoders, the hardware frame pool must therefore be of a fixed size.
3296 * The extra frames set here are on top of any number that the decoder
3297 * needs internally in order to operate normally (for example, frames
3298 * used as reference pictures).
3300 int extra_hw_frames;
3303 #if FF_API_CODEC_GET_SET
3305 * Accessors for some AVCodecContext fields. These used to be provided for ABI
3306 * compatibility, and do not need to be used anymore.
3308 attribute_deprecated
3309 AVRational av_codec_get_pkt_timebase (const AVCodecContext *avctx);
3310 attribute_deprecated
3311 void av_codec_set_pkt_timebase (AVCodecContext *avctx, AVRational val);
3313 attribute_deprecated
3314 const AVCodecDescriptor *av_codec_get_codec_descriptor(const AVCodecContext *avctx);
3315 attribute_deprecated
3316 void av_codec_set_codec_descriptor(AVCodecContext *avctx, const AVCodecDescriptor *desc);
3318 attribute_deprecated
3319 unsigned av_codec_get_codec_properties(const AVCodecContext *avctx);
3322 attribute_deprecated
3323 int av_codec_get_lowres(const AVCodecContext *avctx);
3324 attribute_deprecated
3325 void av_codec_set_lowres(AVCodecContext *avctx, int val);
3328 attribute_deprecated
3329 int av_codec_get_seek_preroll(const AVCodecContext *avctx);
3330 attribute_deprecated
3331 void av_codec_set_seek_preroll(AVCodecContext *avctx, int val);
3333 attribute_deprecated
3334 uint16_t *av_codec_get_chroma_intra_matrix(const AVCodecContext *avctx);
3335 attribute_deprecated
3336 void av_codec_set_chroma_intra_matrix(AVCodecContext *avctx, uint16_t *val);
3342 typedef struct AVProfile {
3344 const char *name; ///< short name for the profile
3349 * The codec supports this format via the hw_device_ctx interface.
3351 * When selecting this format, AVCodecContext.hw_device_ctx should
3352 * have been set to a device of the specified type before calling
3355 AV_CODEC_HW_CONFIG_METHOD_HW_DEVICE_CTX = 0x01,
3357 * The codec supports this format via the hw_frames_ctx interface.
3359 * When selecting this format for a decoder,
3360 * AVCodecContext.hw_frames_ctx should be set to a suitable frames
3361 * context inside the get_format() callback. The frames context
3362 * must have been created on a device of the specified type.
3364 AV_CODEC_HW_CONFIG_METHOD_HW_FRAMES_CTX = 0x02,
3366 * The codec supports this format by some internal method.
3368 * This format can be selected without any additional configuration -
3369 * no device or frames context is required.
3371 AV_CODEC_HW_CONFIG_METHOD_INTERNAL = 0x04,
3373 * The codec supports this format by some ad-hoc method.
3375 * Additional settings and/or function calls are required. See the
3376 * codec-specific documentation for details. (Methods requiring
3377 * this sort of configuration are deprecated and others should be
3378 * used in preference.)
3380 AV_CODEC_HW_CONFIG_METHOD_AD_HOC = 0x08,
3383 typedef struct AVCodecHWConfig {
3385 * A hardware pixel format which the codec can use.
3387 enum AVPixelFormat pix_fmt;
3389 * Bit set of AV_CODEC_HW_CONFIG_METHOD_* flags, describing the possible
3390 * setup methods which can be used with this configuration.
3394 * The device type associated with the configuration.
3396 * Must be set for AV_CODEC_HW_CONFIG_METHOD_HW_DEVICE_CTX and
3397 * AV_CODEC_HW_CONFIG_METHOD_HW_FRAMES_CTX, otherwise unused.
3399 enum AVHWDeviceType device_type;
3402 typedef struct AVCodecDefault AVCodecDefault;
3409 typedef struct AVCodec {
3411 * Name of the codec implementation.
3412 * The name is globally unique among encoders and among decoders (but an
3413 * encoder and a decoder can share the same name).
3414 * This is the primary way to find a codec from the user perspective.
3418 * Descriptive name for the codec, meant to be more human readable than name.
3419 * You should use the NULL_IF_CONFIG_SMALL() macro to define it.
3421 const char *long_name;
3422 enum AVMediaType type;
3425 * Codec capabilities.
3426 * see AV_CODEC_CAP_*
3429 const AVRational *supported_framerates; ///< array of supported framerates, or NULL if any, array is terminated by {0,0}
3430 const enum AVPixelFormat *pix_fmts; ///< array of supported pixel formats, or NULL if unknown, array is terminated by -1
3431 const int *supported_samplerates; ///< array of supported audio samplerates, or NULL if unknown, array is terminated by 0
3432 const enum AVSampleFormat *sample_fmts; ///< array of supported sample formats, or NULL if unknown, array is terminated by -1
3433 const uint64_t *channel_layouts; ///< array of support channel layouts, or NULL if unknown. array is terminated by 0
3434 uint8_t max_lowres; ///< maximum value for lowres supported by the decoder
3435 const AVClass *priv_class; ///< AVClass for the private context
3436 const AVProfile *profiles; ///< array of recognized profiles, or NULL if unknown, array is terminated by {FF_PROFILE_UNKNOWN}
3439 * Group name of the codec implementation.
3440 * This is a short symbolic name of the wrapper backing this codec. A
3441 * wrapper uses some kind of external implementation for the codec, such
3442 * as an external library, or a codec implementation provided by the OS or
3444 * If this field is NULL, this is a builtin, libavcodec native codec.
3445 * If non-NULL, this will be the suffix in AVCodec.name in most cases
3446 * (usually AVCodec.name will be of the form "<codec_name>_<wrapper_name>").
3448 const char *wrapper_name;
3450 /*****************************************************************
3451 * No fields below this line are part of the public API. They
3452 * may not be used outside of libavcodec and can be changed and
3454 * New public fields should be added right above.
3455 *****************************************************************
3458 struct AVCodec *next;
3460 * @name Frame-level threading support functions
3464 * If defined, called on thread contexts when they are created.
3465 * If the codec allocates writable tables in init(), re-allocate them here.
3466 * priv_data will be set to a copy of the original.
3468 int (*init_thread_copy)(AVCodecContext *);
3470 * Copy necessary context variables from a previous thread context to the current one.
3471 * If not defined, the next thread will start automatically; otherwise, the codec
3472 * must call ff_thread_finish_setup().
3474 * dst and src will (rarely) point to the same context, in which case memcpy should be skipped.
3476 int (*update_thread_context)(AVCodecContext *dst, const AVCodecContext *src);
3480 * Private codec-specific defaults.
3482 const AVCodecDefault *defaults;
3485 * Initialize codec static data, called from avcodec_register().
3487 * This is not intended for time consuming operations as it is
3488 * run for every codec regardless of that codec being used.
3490 void (*init_static_data)(struct AVCodec *codec);
3492 int (*init)(AVCodecContext *);
3493 int (*encode_sub)(AVCodecContext *, uint8_t *buf, int buf_size,
3494 const struct AVSubtitle *sub);
3496 * Encode data to an AVPacket.
3498 * @param avctx codec context
3499 * @param avpkt output AVPacket (may contain a user-provided buffer)
3500 * @param[in] frame AVFrame containing the raw data to be encoded
3501 * @param[out] got_packet_ptr encoder sets to 0 or 1 to indicate that a
3502 * non-empty packet was returned in avpkt.
3503 * @return 0 on success, negative error code on failure
3505 int (*encode2)(AVCodecContext *avctx, AVPacket *avpkt, const AVFrame *frame,
3506 int *got_packet_ptr);
3507 int (*decode)(AVCodecContext *, void *outdata, int *outdata_size, AVPacket *avpkt);
3508 int (*close)(AVCodecContext *);
3510 * Encode API with decoupled packet/frame dataflow. The API is the
3511 * same as the avcodec_ prefixed APIs (avcodec_send_frame() etc.), except
3513 * - never called if the codec is closed or the wrong type,
3514 * - if AV_CODEC_CAP_DELAY is not set, drain frames are never sent,
3515 * - only one drain frame is ever passed down,
3517 int (*send_frame)(AVCodecContext *avctx, const AVFrame *frame);
3518 int (*receive_packet)(AVCodecContext *avctx, AVPacket *avpkt);
3521 * Decode API with decoupled packet/frame dataflow. This function is called
3522 * to get one output frame. It should call ff_decode_get_packet() to obtain
3525 int (*receive_frame)(AVCodecContext *avctx, AVFrame *frame);
3528 * Will be called when seeking
3530 void (*flush)(AVCodecContext *);
3532 * Internal codec capabilities.
3533 * See FF_CODEC_CAP_* in internal.h
3538 * Decoding only, a comma-separated list of bitstream filters to apply to
3539 * packets before decoding.
3544 * Array of pointers to hardware configurations supported by the codec,
3545 * or NULL if no hardware supported. The array is terminated by a NULL
3548 * The user can only access this field via avcodec_get_hw_config().
3550 const struct AVCodecHWConfigInternal **hw_configs;
3553 #if FF_API_CODEC_GET_SET
3554 attribute_deprecated
3555 int av_codec_get_max_lowres(const AVCodec *codec);
3558 struct MpegEncContext;
3561 * Retrieve supported hardware configurations for a codec.
3563 * Values of index from zero to some maximum return the indexed configuration
3564 * descriptor; all other values return NULL. If the codec does not support
3565 * any hardware configurations then it will always return NULL.
3567 const AVCodecHWConfig *avcodec_get_hw_config(const AVCodec *codec, int index);
3570 * @defgroup lavc_hwaccel AVHWAccel
3572 * @note Nothing in this structure should be accessed by the user. At some
3573 * point in future it will not be externally visible at all.
3577 typedef struct AVHWAccel {
3579 * Name of the hardware accelerated codec.
3580 * The name is globally unique among encoders and among decoders (but an
3581 * encoder and a decoder can share the same name).
3586 * Type of codec implemented by the hardware accelerator.
3588 * See AVMEDIA_TYPE_xxx
3590 enum AVMediaType type;
3593 * Codec implemented by the hardware accelerator.
3595 * See AV_CODEC_ID_xxx
3600 * Supported pixel format.
3602 * Only hardware accelerated formats are supported here.
3604 enum AVPixelFormat pix_fmt;
3607 * Hardware accelerated codec capabilities.
3608 * see AV_HWACCEL_CODEC_CAP_*
3612 /*****************************************************************
3613 * No fields below this line are part of the public API. They
3614 * may not be used outside of libavcodec and can be changed and
3616 * New public fields should be added right above.
3617 *****************************************************************
3621 * Allocate a custom buffer
3623 int (*alloc_frame)(AVCodecContext *avctx, AVFrame *frame);
3626 * Called at the beginning of each frame or field picture.
3628 * Meaningful frame information (codec specific) is guaranteed to
3629 * be parsed at this point. This function is mandatory.
3631 * Note that buf can be NULL along with buf_size set to 0.
3632 * Otherwise, this means the whole frame is available at this point.
3634 * @param avctx the codec context
3635 * @param buf the frame data buffer base
3636 * @param buf_size the size of the frame in bytes
3637 * @return zero if successful, a negative value otherwise
3639 int (*start_frame)(AVCodecContext *avctx, const uint8_t *buf, uint32_t buf_size);
3642 * Callback for parameter data (SPS/PPS/VPS etc).
3644 * Useful for hardware decoders which keep persistent state about the
3645 * video parameters, and need to receive any changes to update that state.
3647 * @param avctx the codec context
3648 * @param type the nal unit type
3649 * @param buf the nal unit data buffer
3650 * @param buf_size the size of the nal unit in bytes
3651 * @return zero if successful, a negative value otherwise
3653 int (*decode_params)(AVCodecContext *avctx, int type, const uint8_t *buf, uint32_t buf_size);
3656 * Callback for each slice.
3658 * Meaningful slice information (codec specific) is guaranteed to
3659 * be parsed at this point. This function is mandatory.
3660 * The only exception is XvMC, that works on MB level.
3662 * @param avctx the codec context
3663 * @param buf the slice data buffer base
3664 * @param buf_size the size of the slice in bytes
3665 * @return zero if successful, a negative value otherwise
3667 int (*decode_slice)(AVCodecContext *avctx, const uint8_t *buf, uint32_t buf_size);
3670 * Called at the end of each frame or field picture.
3672 * The whole picture is parsed at this point and can now be sent
3673 * to the hardware accelerator. This function is mandatory.
3675 * @param avctx the codec context
3676 * @return zero if successful, a negative value otherwise
3678 int (*end_frame)(AVCodecContext *avctx);
3681 * Size of per-frame hardware accelerator private data.
3683 * Private data is allocated with av_mallocz() before
3684 * AVCodecContext.get_buffer() and deallocated after
3685 * AVCodecContext.release_buffer().
3687 int frame_priv_data_size;
3690 * Called for every Macroblock in a slice.
3692 * XvMC uses it to replace the ff_mpv_reconstruct_mb().
3693 * Instead of decoding to raw picture, MB parameters are
3694 * stored in an array provided by the video driver.
3696 * @param s the mpeg context
3698 void (*decode_mb)(struct MpegEncContext *s);
3701 * Initialize the hwaccel private data.
3703 * This will be called from ff_get_format(), after hwaccel and
3704 * hwaccel_context are set and the hwaccel private data in AVCodecInternal
3707 int (*init)(AVCodecContext *avctx);
3710 * Uninitialize the hwaccel private data.
3712 * This will be called from get_format() or avcodec_close(), after hwaccel
3713 * and hwaccel_context are already uninitialized.
3715 int (*uninit)(AVCodecContext *avctx);
3718 * Size of the private data to allocate in
3719 * AVCodecInternal.hwaccel_priv_data.
3724 * Internal hwaccel capabilities.
3729 * Fill the given hw_frames context with current codec parameters. Called
3730 * from get_format. Refer to avcodec_get_hw_frames_parameters() for
3733 * This CAN be called before AVHWAccel.init is called, and you must assume
3734 * that avctx->hwaccel_priv_data is invalid.
3736 int (*frame_params)(AVCodecContext *avctx, AVBufferRef *hw_frames_ctx);
3740 * HWAccel is experimental and is thus avoided in favor of non experimental
3743 #define AV_HWACCEL_CODEC_CAP_EXPERIMENTAL 0x0200
3746 * Hardware acceleration should be used for decoding even if the codec level
3747 * used is unknown or higher than the maximum supported level reported by the
3750 * It's generally a good idea to pass this flag unless you have a specific
3751 * reason not to, as hardware tends to under-report supported levels.
3753 #define AV_HWACCEL_FLAG_IGNORE_LEVEL (1 << 0)
3756 * Hardware acceleration can output YUV pixel formats with a different chroma
3757 * sampling than 4:2:0 and/or other than 8 bits per component.
3759 #define AV_HWACCEL_FLAG_ALLOW_HIGH_DEPTH (1 << 1)
3762 * Hardware acceleration should still be attempted for decoding when the
3763 * codec profile does not match the reported capabilities of the hardware.
3765 * For example, this can be used to try to decode baseline profile H.264
3766 * streams in hardware - it will often succeed, because many streams marked
3767 * as baseline profile actually conform to constrained baseline profile.
3769 * @warning If the stream is actually not supported then the behaviour is
3770 * undefined, and may include returning entirely incorrect output
3771 * while indicating success.
3773 #define AV_HWACCEL_FLAG_ALLOW_PROFILE_MISMATCH (1 << 2)
3779 #if FF_API_AVPICTURE
3781 * @defgroup lavc_picture AVPicture
3783 * Functions for working with AVPicture
3788 * Picture data structure.
3790 * Up to four components can be stored into it, the last component is
3792 * @deprecated use AVFrame or imgutils functions instead
3794 typedef struct AVPicture {
3795 attribute_deprecated
3796 uint8_t *data[AV_NUM_DATA_POINTERS]; ///< pointers to the image data planes
3797 attribute_deprecated
3798 int linesize[AV_NUM_DATA_POINTERS]; ///< number of bytes per line
3806 enum AVSubtitleType {
3809 SUBTITLE_BITMAP, ///< A bitmap, pict will be set
3812 * Plain text, the text field must be set by the decoder and is
3813 * authoritative. ass and pict fields may contain approximations.
3818 * Formatted text, the ass field must be set by the decoder and is
3819 * authoritative. pict and text fields may contain approximations.
3824 #define AV_SUBTITLE_FLAG_FORCED 0x00000001
3826 typedef struct AVSubtitleRect {
3827 int x; ///< top left corner of pict, undefined when pict is not set
3828 int y; ///< top left corner of pict, undefined when pict is not set
3829 int w; ///< width of pict, undefined when pict is not set
3830 int h; ///< height of pict, undefined when pict is not set
3831 int nb_colors; ///< number of colors in pict, undefined when pict is not set
3833 #if FF_API_AVPICTURE
3835 * @deprecated unused
3837 attribute_deprecated
3841 * data+linesize for the bitmap of this subtitle.
3842 * Can be set for text/ass as well once they are rendered.
3847 enum AVSubtitleType type;
3849 char *text; ///< 0 terminated plain UTF-8 text
3852 * 0 terminated ASS/SSA compatible event line.
3853 * The presentation of this is unaffected by the other values in this
3861 typedef struct AVSubtitle {
3862 uint16_t format; /* 0 = graphics */
3863 uint32_t start_display_time; /* relative to packet pts, in ms */
3864 uint32_t end_display_time; /* relative to packet pts, in ms */
3866 AVSubtitleRect **rects;
3867 int64_t pts; ///< Same as packet pts, in AV_TIME_BASE
3871 * This struct describes the properties of an encoded stream.
3873 * sizeof(AVCodecParameters) is not a part of the public ABI, this struct must
3874 * be allocated with avcodec_parameters_alloc() and freed with
3875 * avcodec_parameters_free().
3877 typedef struct AVCodecParameters {
3879 * General type of the encoded data.
3881 enum AVMediaType codec_type;
3883 * Specific type of the encoded data (the codec used).
3885 enum AVCodecID codec_id;
3887 * Additional information about the codec (corresponds to the AVI FOURCC).
3892 * Extra binary data needed for initializing the decoder, codec-dependent.
3894 * Must be allocated with av_malloc() and will be freed by
3895 * avcodec_parameters_free(). The allocated size of extradata must be at
3896 * least extradata_size + AV_INPUT_BUFFER_PADDING_SIZE, with the padding
3901 * Size of the extradata content in bytes.
3906 * - video: the pixel format, the value corresponds to enum AVPixelFormat.
3907 * - audio: the sample format, the value corresponds to enum AVSampleFormat.
3912 * The average bitrate of the encoded data (in bits per second).
3917 * The number of bits per sample in the codedwords.
3919 * This is basically the bitrate per sample. It is mandatory for a bunch of
3920 * formats to actually decode them. It's the number of bits for one sample in
3921 * the actual coded bitstream.
3923 * This could be for example 4 for ADPCM
3924 * For PCM formats this matches bits_per_raw_sample
3927 int bits_per_coded_sample;
3930 * This is the number of valid bits in each output sample. If the
3931 * sample format has more bits, the least significant bits are additional
3932 * padding bits, which are always 0. Use right shifts to reduce the sample
3933 * to its actual size. For example, audio formats with 24 bit samples will
3934 * have bits_per_raw_sample set to 24, and format set to AV_SAMPLE_FMT_S32.
3935 * To get the original sample use "(int32_t)sample >> 8"."
3937 * For ADPCM this might be 12 or 16 or similar
3940 int bits_per_raw_sample;
3943 * Codec-specific bitstream restrictions that the stream conforms to.
3949 * Video only. The dimensions of the video frame in pixels.
3955 * Video only. The aspect ratio (width / height) which a single pixel
3956 * should have when displayed.
3958 * When the aspect ratio is unknown / undefined, the numerator should be
3959 * set to 0 (the denominator may have any value).
3961 AVRational sample_aspect_ratio;
3964 * Video only. The order of the fields in interlaced video.
3966 enum AVFieldOrder field_order;
3969 * Video only. Additional colorspace characteristics.
3971 enum AVColorRange color_range;
3972 enum AVColorPrimaries color_primaries;
3973 enum AVColorTransferCharacteristic color_trc;
3974 enum AVColorSpace color_space;
3975 enum AVChromaLocation chroma_location;
3978 * Video only. Number of delayed frames.
3983 * Audio only. The channel layout bitmask. May be 0 if the channel layout is
3984 * unknown or unspecified, otherwise the number of bits set must be equal to
3985 * the channels field.
3987 uint64_t channel_layout;
3989 * Audio only. The number of audio channels.
3993 * Audio only. The number of audio samples per second.
3997 * Audio only. The number of bytes per coded audio frame, required by some
4000 * Corresponds to nBlockAlign in WAVEFORMATEX.
4004 * Audio only. Audio frame size, if known. Required by some formats to be static.
4009 * Audio only. The amount of padding (in samples) inserted by the encoder at
4010 * the beginning of the audio. I.e. this number of leading decoded samples
4011 * must be discarded by the caller to get the original audio without leading
4014 int initial_padding;
4016 * Audio only. The amount of padding (in samples) appended by the encoder to
4017 * the end of the audio. I.e. this number of decoded samples must be
4018 * discarded by the caller from the end of the stream to get the original
4019 * audio without any trailing padding.
4021 int trailing_padding;
4023 * Audio only. Number of samples to skip after a discontinuity.
4026 } AVCodecParameters;
4029 * Iterate over all registered codecs.
4031 * @param opaque a pointer where libavcodec will store the iteration state. Must
4032 * point to NULL to start the iteration.
4034 * @return the next registered codec or NULL when the iteration is
4037 const AVCodec *av_codec_iterate(void **opaque);
4041 * If c is NULL, returns the first registered codec,
4042 * if c is non-NULL, returns the next registered codec after c,
4043 * or NULL if c is the last one.
4045 attribute_deprecated
4046 AVCodec *av_codec_next(const AVCodec *c);
4050 * Return the LIBAVCODEC_VERSION_INT constant.
4052 unsigned avcodec_version(void);
4055 * Return the libavcodec build-time configuration.
4057 const char *avcodec_configuration(void);
4060 * Return the libavcodec license.
4062 const char *avcodec_license(void);
4066 * Register the codec codec and initialize libavcodec.
4068 * @warning either this function or avcodec_register_all() must be called
4069 * before any other libavcodec functions.
4071 * @see avcodec_register_all()
4073 attribute_deprecated
4074 void avcodec_register(AVCodec *codec);
4077 * Register all the codecs, parsers and bitstream filters which were enabled at
4078 * configuration time. If you do not call this function you can select exactly
4079 * which formats you want to support, by using the individual registration
4082 * @see avcodec_register
4083 * @see av_register_codec_parser
4084 * @see av_register_bitstream_filter
4086 attribute_deprecated
4087 void avcodec_register_all(void);
4091 * Allocate an AVCodecContext and set its fields to default values. The
4092 * resulting struct should be freed with avcodec_free_context().
4094 * @param codec if non-NULL, allocate private data and initialize defaults
4095 * for the given codec. It is illegal to then call avcodec_open2()
4096 * with a different codec.
4097 * If NULL, then the codec-specific defaults won't be initialized,
4098 * which may result in suboptimal default settings (this is
4099 * important mainly for encoders, e.g. libx264).
4101 * @return An AVCodecContext filled with default values or NULL on failure.
4103 AVCodecContext *avcodec_alloc_context3(const AVCodec *codec);
4106 * Free the codec context and everything associated with it and write NULL to
4107 * the provided pointer.
4109 void avcodec_free_context(AVCodecContext **avctx);
4111 #if FF_API_GET_CONTEXT_DEFAULTS
4113 * @deprecated This function should not be used, as closing and opening a codec
4114 * context multiple time is not supported. A new codec context should be
4115 * allocated for each new use.
4117 int avcodec_get_context_defaults3(AVCodecContext *s, const AVCodec *codec);
4121 * Get the AVClass for AVCodecContext. It can be used in combination with
4122 * AV_OPT_SEARCH_FAKE_OBJ for examining options.
4124 * @see av_opt_find().
4126 const AVClass *avcodec_get_class(void);
4128 #if FF_API_COPY_CONTEXT
4130 * Get the AVClass for AVFrame. It can be used in combination with
4131 * AV_OPT_SEARCH_FAKE_OBJ for examining options.
4133 * @see av_opt_find().
4135 const AVClass *avcodec_get_frame_class(void);
4138 * Get the AVClass for AVSubtitleRect. It can be used in combination with
4139 * AV_OPT_SEARCH_FAKE_OBJ for examining options.
4141 * @see av_opt_find().
4143 const AVClass *avcodec_get_subtitle_rect_class(void);
4146 * Copy the settings of the source AVCodecContext into the destination
4147 * AVCodecContext. The resulting destination codec context will be
4148 * unopened, i.e. you are required to call avcodec_open2() before you
4149 * can use this AVCodecContext to decode/encode video/audio data.
4151 * @param dest target codec context, should be initialized with
4152 * avcodec_alloc_context3(NULL), but otherwise uninitialized
4153 * @param src source codec context
4154 * @return AVERROR() on error (e.g. memory allocation error), 0 on success
4156 * @deprecated The semantics of this function are ill-defined and it should not
4157 * be used. If you need to transfer the stream parameters from one codec context
4158 * to another, use an intermediate AVCodecParameters instance and the
4159 * avcodec_parameters_from_context() / avcodec_parameters_to_context()
4162 attribute_deprecated
4163 int avcodec_copy_context(AVCodecContext *dest, const AVCodecContext *src);
4167 * Allocate a new AVCodecParameters and set its fields to default values
4168 * (unknown/invalid/0). The returned struct must be freed with
4169 * avcodec_parameters_free().
4171 AVCodecParameters *avcodec_parameters_alloc(void);
4174 * Free an AVCodecParameters instance and everything associated with it and
4175 * write NULL to the supplied pointer.
4177 void avcodec_parameters_free(AVCodecParameters **par);
4180 * Copy the contents of src to dst. Any allocated fields in dst are freed and
4181 * replaced with newly allocated duplicates of the corresponding fields in src.
4183 * @return >= 0 on success, a negative AVERROR code on failure.
4185 int avcodec_parameters_copy(AVCodecParameters *dst, const AVCodecParameters *src);
4188 * Fill the parameters struct based on the values from the supplied codec
4189 * context. Any allocated fields in par are freed and replaced with duplicates
4190 * of the corresponding fields in codec.
4192 * @return >= 0 on success, a negative AVERROR code on failure
4194 int avcodec_parameters_from_context(AVCodecParameters *par,
4195 const AVCodecContext *codec);
4198 * Fill the codec context based on the values from the supplied codec
4199 * parameters. Any allocated fields in codec that have a corresponding field in
4200 * par are freed and replaced with duplicates of the corresponding field in par.
4201 * Fields in codec that do not have a counterpart in par are not touched.
4203 * @return >= 0 on success, a negative AVERROR code on failure.
4205 int avcodec_parameters_to_context(AVCodecContext *codec,
4206 const AVCodecParameters *par);
4209 * Initialize the AVCodecContext to use the given AVCodec. Prior to using this
4210 * function the context has to be allocated with avcodec_alloc_context3().
4212 * The functions avcodec_find_decoder_by_name(), avcodec_find_encoder_by_name(),
4213 * avcodec_find_decoder() and avcodec_find_encoder() provide an easy way for
4214 * retrieving a codec.
4216 * @warning This function is not thread safe!
4218 * @note Always call this function before using decoding routines (such as
4219 * @ref avcodec_receive_frame()).
4222 * avcodec_register_all();
4223 * av_dict_set(&opts, "b", "2.5M", 0);
4224 * codec = avcodec_find_decoder(AV_CODEC_ID_H264);
4228 * context = avcodec_alloc_context3(codec);
4230 * if (avcodec_open2(context, codec, opts) < 0)
4234 * @param avctx The context to initialize.
4235 * @param codec The codec to open this context for. If a non-NULL codec has been
4236 * previously passed to avcodec_alloc_context3() or
4237 * for this context, then this parameter MUST be either NULL or
4238 * equal to the previously passed codec.
4239 * @param options A dictionary filled with AVCodecContext and codec-private options.
4240 * On return this object will be filled with options that were not found.
4242 * @return zero on success, a negative value on error
4243 * @see avcodec_alloc_context3(), avcodec_find_decoder(), avcodec_find_encoder(),
4244 * av_dict_set(), av_opt_find().
4246 int avcodec_open2(AVCodecContext *avctx, const AVCodec *codec, AVDictionary **options);
4249 * Close a given AVCodecContext and free all the data associated with it
4250 * (but not the AVCodecContext itself).
4252 * Calling this function on an AVCodecContext that hasn't been opened will free
4253 * the codec-specific data allocated in avcodec_alloc_context3() with a non-NULL
4254 * codec. Subsequent calls will do nothing.
4256 * @note Do not use this function. Use avcodec_free_context() to destroy a
4257 * codec context (either open or closed). Opening and closing a codec context
4258 * multiple times is not supported anymore -- use multiple codec contexts
4261 int avcodec_close(AVCodecContext *avctx);
4264 * Free all allocated data in the given subtitle struct.
4266 * @param sub AVSubtitle to free.
4268 void avsubtitle_free(AVSubtitle *sub);
4275 * @addtogroup lavc_packet
4280 * Allocate an AVPacket and set its fields to default values. The resulting
4281 * struct must be freed using av_packet_free().
4283 * @return An AVPacket filled with default values or NULL on failure.
4285 * @note this only allocates the AVPacket itself, not the data buffers. Those
4286 * must be allocated through other means such as av_new_packet.
4288 * @see av_new_packet
4290 AVPacket *av_packet_alloc(void);
4293 * Create a new packet that references the same data as src.
4295 * This is a shortcut for av_packet_alloc()+av_packet_ref().
4297 * @return newly created AVPacket on success, NULL on error.
4299 * @see av_packet_alloc
4300 * @see av_packet_ref
4302 AVPacket *av_packet_clone(const AVPacket *src);
4305 * Free the packet, if the packet is reference counted, it will be
4306 * unreferenced first.
4308 * @param pkt packet to be freed. The pointer will be set to NULL.
4309 * @note passing NULL is a no-op.
4311 void av_packet_free(AVPacket **pkt);
4314 * Initialize optional fields of a packet with default values.
4316 * Note, this does not touch the data and size members, which have to be
4317 * initialized separately.
4321 void av_init_packet(AVPacket *pkt);
4324 * Allocate the payload of a packet and initialize its fields with
4328 * @param size wanted payload size
4329 * @return 0 if OK, AVERROR_xxx otherwise
4331 int av_new_packet(AVPacket *pkt, int size);
4334 * Reduce packet size, correctly zeroing padding
4337 * @param size new size
4339 void av_shrink_packet(AVPacket *pkt, int size);
4342 * Increase packet size, correctly zeroing padding
4345 * @param grow_by number of bytes by which to increase the size of the packet
4347 int av_grow_packet(AVPacket *pkt, int grow_by);
4350 * Initialize a reference-counted packet from av_malloc()ed data.
4352 * @param pkt packet to be initialized. This function will set the data, size,
4353 * buf and destruct fields, all others are left untouched.
4354 * @param data Data allocated by av_malloc() to be used as packet data. If this
4355 * function returns successfully, the data is owned by the underlying AVBuffer.
4356 * The caller may not access the data through other means.
4357 * @param size size of data in bytes, without the padding. I.e. the full buffer
4358 * size is assumed to be size + AV_INPUT_BUFFER_PADDING_SIZE.
4360 * @return 0 on success, a negative AVERROR on error
4362 int av_packet_from_data(AVPacket *pkt, uint8_t *data, int size);
4364 #if FF_API_AVPACKET_OLD_API
4366 * @warning This is a hack - the packet memory allocation stuff is broken. The
4367 * packet is allocated if it was not really allocated.
4369 * @deprecated Use av_packet_ref or av_packet_make_refcounted
4371 attribute_deprecated
4372 int av_dup_packet(AVPacket *pkt);
4374 * Copy packet, including contents
4376 * @return 0 on success, negative AVERROR on fail
4378 * @deprecated Use av_packet_ref
4380 attribute_deprecated
4381 int av_copy_packet(AVPacket *dst, const AVPacket *src);
4384 * Copy packet side data
4386 * @return 0 on success, negative AVERROR on fail
4388 * @deprecated Use av_packet_copy_props
4390 attribute_deprecated
4391 int av_copy_packet_side_data(AVPacket *dst, const AVPacket *src);
4396 * @deprecated Use av_packet_unref
4398 * @param pkt packet to free
4400 attribute_deprecated
4401 void av_free_packet(AVPacket *pkt);
4404 * Allocate new information of a packet.
4407 * @param type side information type
4408 * @param size side information size
4409 * @return pointer to fresh allocated data or NULL otherwise
4411 uint8_t* av_packet_new_side_data(AVPacket *pkt, enum AVPacketSideDataType type,
4415 * Wrap an existing array as a packet side data.
4418 * @param type side information type
4419 * @param data the side data array. It must be allocated with the av_malloc()
4420 * family of functions. The ownership of the data is transferred to
4422 * @param size side information size
4423 * @return a non-negative number on success, a negative AVERROR code on
4424 * failure. On failure, the packet is unchanged and the data remains
4425 * owned by the caller.
4427 int av_packet_add_side_data(AVPacket *pkt, enum AVPacketSideDataType type,
4428 uint8_t *data, size_t size);
4431 * Shrink the already allocated side data buffer
4434 * @param type side information type
4435 * @param size new side information size
4436 * @return 0 on success, < 0 on failure
4438 int av_packet_shrink_side_data(AVPacket *pkt, enum AVPacketSideDataType type,
4442 * Get side information from packet.
4445 * @param type desired side information type
4446 * @param size pointer for side information size to store (optional)
4447 * @return pointer to data if present or NULL otherwise
4449 uint8_t* av_packet_get_side_data(const AVPacket *pkt, enum AVPacketSideDataType type,
4452 #if FF_API_MERGE_SD_API
4453 attribute_deprecated
4454 int av_packet_merge_side_data(AVPacket *pkt);
4456 attribute_deprecated
4457 int av_packet_split_side_data(AVPacket *pkt);
4460 const char *av_packet_side_data_name(enum AVPacketSideDataType type);
4463 * Pack a dictionary for use in side_data.
4465 * @param dict The dictionary to pack.
4466 * @param size pointer to store the size of the returned data
4467 * @return pointer to data if successful, NULL otherwise
4469 uint8_t *av_packet_pack_dictionary(AVDictionary *dict, int *size);
4471 * Unpack a dictionary from side_data.
4473 * @param data data from side_data
4474 * @param size size of the data
4475 * @param dict the metadata storage dictionary
4476 * @return 0 on success, < 0 on failure
4478 int av_packet_unpack_dictionary(const uint8_t *data, int size, AVDictionary **dict);
4482 * Convenience function to free all the side data stored.
4483 * All the other fields stay untouched.
4487 void av_packet_free_side_data(AVPacket *pkt);
4490 * Setup a new reference to the data described by a given packet
4492 * If src is reference-counted, setup dst as a new reference to the
4493 * buffer in src. Otherwise allocate a new buffer in dst and copy the
4494 * data from src into it.
4496 * All the other fields are copied from src.
4498 * @see av_packet_unref
4500 * @param dst Destination packet
4501 * @param src Source packet
4503 * @return 0 on success, a negative AVERROR on error.
4505 int av_packet_ref(AVPacket *dst, const AVPacket *src);
4510 * Unreference the buffer referenced by the packet and reset the
4511 * remaining packet fields to their default values.
4513 * @param pkt The packet to be unreferenced.
4515 void av_packet_unref(AVPacket *pkt);
4518 * Move every field in src to dst and reset src.
4520 * @see av_packet_unref
4522 * @param src Source packet, will be reset
4523 * @param dst Destination packet
4525 void av_packet_move_ref(AVPacket *dst, AVPacket *src);
4528 * Copy only "properties" fields from src to dst.
4530 * Properties for the purpose of this function are all the fields
4531 * beside those related to the packet data (buf, data, size)
4533 * @param dst Destination packet
4534 * @param src Source packet
4536 * @return 0 on success AVERROR on failure.
4538 int av_packet_copy_props(AVPacket *dst, const AVPacket *src);
4541 * Ensure the data described by a given packet is reference counted.
4543 * @note This function does not ensure that the reference will be writable.
4544 * Use av_packet_make_writable instead for that purpose.
4546 * @see av_packet_ref
4547 * @see av_packet_make_writable
4549 * @param pkt packet whose data should be made reference counted.
4551 * @return 0 on success, a negative AVERROR on error. On failure, the
4552 * packet is unchanged.
4554 int av_packet_make_refcounted(AVPacket *pkt);
4557 * Create a writable reference for the data described by a given packet,
4558 * avoiding data copy if possible.
4560 * @param pkt Packet whose data should be made writable.
4562 * @return 0 on success, a negative AVERROR on failure. On failure, the
4563 * packet is unchanged.
4565 int av_packet_make_writable(AVPacket *pkt);
4568 * Convert valid timing fields (timestamps / durations) in a packet from one
4569 * timebase to another. Timestamps with unknown values (AV_NOPTS_VALUE) will be
4572 * @param pkt packet on which the conversion will be performed
4573 * @param tb_src source timebase, in which the timing fields in pkt are
4575 * @param tb_dst destination timebase, to which the timing fields will be
4578 void av_packet_rescale_ts(AVPacket *pkt, AVRational tb_src, AVRational tb_dst);
4585 * @addtogroup lavc_decoding
4590 * Find a registered decoder with a matching codec ID.
4592 * @param id AVCodecID of the requested decoder
4593 * @return A decoder if one was found, NULL otherwise.
4595 AVCodec *avcodec_find_decoder(enum AVCodecID id);
4598 * Find a registered decoder with the specified name.
4600 * @param name name of the requested decoder
4601 * @return A decoder if one was found, NULL otherwise.
4603 AVCodec *avcodec_find_decoder_by_name(const char *name);
4606 * The default callback for AVCodecContext.get_buffer2(). It is made public so
4607 * it can be called by custom get_buffer2() implementations for decoders without
4608 * AV_CODEC_CAP_DR1 set.
4610 int avcodec_default_get_buffer2(AVCodecContext *s, AVFrame *frame, int flags);
4613 * Modify width and height values so that they will result in a memory
4614 * buffer that is acceptable for the codec if you do not use any horizontal
4617 * May only be used if a codec with AV_CODEC_CAP_DR1 has been opened.
4619 void avcodec_align_dimensions(AVCodecContext *s, int *width, int *height);
4622 * Modify width and height values so that they will result in a memory
4623 * buffer that is acceptable for the codec if you also ensure that all
4624 * line sizes are a multiple of the respective linesize_align[i].
4626 * May only be used if a codec with AV_CODEC_CAP_DR1 has been opened.
4628 void avcodec_align_dimensions2(AVCodecContext *s, int *width, int *height,
4629 int linesize_align[AV_NUM_DATA_POINTERS]);
4632 * Converts AVChromaLocation to swscale x/y chroma position.
4634 * The positions represent the chroma (0,0) position in a coordinates system
4635 * with luma (0,0) representing the origin and luma(1,1) representing 256,256
4637 * @param xpos horizontal chroma sample position
4638 * @param ypos vertical chroma sample position
4640 int avcodec_enum_to_chroma_pos(int *xpos, int *ypos, enum AVChromaLocation pos);
4643 * Converts swscale x/y chroma position to AVChromaLocation.
4645 * The positions represent the chroma (0,0) position in a coordinates system
4646 * with luma (0,0) representing the origin and luma(1,1) representing 256,256
4648 * @param xpos horizontal chroma sample position
4649 * @param ypos vertical chroma sample position
4651 enum AVChromaLocation avcodec_chroma_pos_to_enum(int xpos, int ypos);
4654 * Decode the audio frame of size avpkt->size from avpkt->data into frame.
4656 * Some decoders may support multiple frames in a single AVPacket. Such
4657 * decoders would then just decode the first frame and the return value would be
4658 * less than the packet size. In this case, avcodec_decode_audio4 has to be
4659 * called again with an AVPacket containing the remaining data in order to
4660 * decode the second frame, etc... Even if no frames are returned, the packet
4661 * needs to be fed to the decoder with remaining data until it is completely
4662 * consumed or an error occurs.
4664 * Some decoders (those marked with AV_CODEC_CAP_DELAY) have a delay between input
4665 * and output. This means that for some packets they will not immediately
4666 * produce decoded output and need to be flushed at the end of decoding to get
4667 * all the decoded data. Flushing is done by calling this function with packets
4668 * with avpkt->data set to NULL and avpkt->size set to 0 until it stops
4669 * returning samples. It is safe to flush even those decoders that are not
4670 * marked with AV_CODEC_CAP_DELAY, then no samples will be returned.
4672 * @warning The input buffer, avpkt->data must be AV_INPUT_BUFFER_PADDING_SIZE
4673 * larger than the actual read bytes because some optimized bitstream
4674 * readers read 32 or 64 bits at once and could read over the end.
4676 * @note The AVCodecContext MUST have been opened with @ref avcodec_open2()
4677 * before packets may be fed to the decoder.
4679 * @param avctx the codec context
4680 * @param[out] frame The AVFrame in which to store decoded audio samples.
4681 * The decoder will allocate a buffer for the decoded frame by
4682 * calling the AVCodecContext.get_buffer2() callback.
4683 * When AVCodecContext.refcounted_frames is set to 1, the frame is
4684 * reference counted and the returned reference belongs to the
4685 * caller. The caller must release the frame using av_frame_unref()
4686 * when the frame is no longer needed. The caller may safely write
4687 * to the frame if av_frame_is_writable() returns 1.
4688 * When AVCodecContext.refcounted_frames is set to 0, the returned
4689 * reference belongs to the decoder and is valid only until the
4690 * next call to this function or until closing or flushing the
4691 * decoder. The caller may not write to it.
4692 * @param[out] got_frame_ptr Zero if no frame could be decoded, otherwise it is
4693 * non-zero. Note that this field being set to zero
4694 * does not mean that an error has occurred. For
4695 * decoders with AV_CODEC_CAP_DELAY set, no given decode
4696 * call is guaranteed to produce a frame.
4697 * @param[in] avpkt The input AVPacket containing the input buffer.
4698 * At least avpkt->data and avpkt->size should be set. Some
4699 * decoders might also require additional fields to be set.
4700 * @return A negative error code is returned if an error occurred during
4701 * decoding, otherwise the number of bytes consumed from the input
4702 * AVPacket is returned.
4704 * @deprecated Use avcodec_send_packet() and avcodec_receive_frame().
4706 attribute_deprecated
4707 int avcodec_decode_audio4(AVCodecContext *avctx, AVFrame *frame,
4708 int *got_frame_ptr, const AVPacket *avpkt);
4711 * Decode the video frame of size avpkt->size from avpkt->data into picture.
4712 * Some decoders may support multiple frames in a single AVPacket, such
4713 * decoders would then just decode the first frame.
4715 * @warning The input buffer must be AV_INPUT_BUFFER_PADDING_SIZE larger than
4716 * the actual read bytes because some optimized bitstream readers read 32 or 64
4717 * bits at once and could read over the end.
4719 * @warning The end of the input buffer buf should be set to 0 to ensure that
4720 * no overreading happens for damaged MPEG streams.
4722 * @note Codecs which have the AV_CODEC_CAP_DELAY capability set have a delay
4723 * between input and output, these need to be fed with avpkt->data=NULL,
4724 * avpkt->size=0 at the end to return the remaining frames.
4726 * @note The AVCodecContext MUST have been opened with @ref avcodec_open2()
4727 * before packets may be fed to the decoder.
4729 * @param avctx the codec context
4730 * @param[out] picture The AVFrame in which the decoded video frame will be stored.
4731 * Use av_frame_alloc() to get an AVFrame. The codec will
4732 * allocate memory for the actual bitmap by calling the
4733 * AVCodecContext.get_buffer2() callback.
4734 * When AVCodecContext.refcounted_frames is set to 1, the frame is
4735 * reference counted and the returned reference belongs to the
4736 * caller. The caller must release the frame using av_frame_unref()
4737 * when the frame is no longer needed. The caller may safely write
4738 * to the frame if av_frame_is_writable() returns 1.
4739 * When AVCodecContext.refcounted_frames is set to 0, the returned
4740 * reference belongs to the decoder and is valid only until the
4741 * next call to this function or until closing or flushing the
4742 * decoder. The caller may not write to it.
4744 * @param[in] avpkt The input AVPacket containing the input buffer.
4745 * You can create such packet with av_init_packet() and by then setting
4746 * data and size, some decoders might in addition need other fields like
4747 * flags&AV_PKT_FLAG_KEY. All decoders are designed to use the least
4749 * @param[in,out] got_picture_ptr Zero if no frame could be decompressed, otherwise, it is nonzero.
4750 * @return On error a negative value is returned, otherwise the number of bytes
4751 * used or zero if no frame could be decompressed.
4753 * @deprecated Use avcodec_send_packet() and avcodec_receive_frame().
4755 attribute_deprecated
4756 int avcodec_decode_video2(AVCodecContext *avctx, AVFrame *picture,
4757 int *got_picture_ptr,
4758 const AVPacket *avpkt);
4761 * Decode a subtitle message.
4762 * Return a negative value on error, otherwise return the number of bytes used.
4763 * If no subtitle could be decompressed, got_sub_ptr is zero.
4764 * Otherwise, the subtitle is stored in *sub.
4765 * Note that AV_CODEC_CAP_DR1 is not available for subtitle codecs. This is for
4766 * simplicity, because the performance difference is expect to be negligible
4767 * and reusing a get_buffer written for video codecs would probably perform badly
4768 * due to a potentially very different allocation pattern.
4770 * Some decoders (those marked with AV_CODEC_CAP_DELAY) have a delay between input
4771 * and output. This means that for some packets they will not immediately
4772 * produce decoded output and need to be flushed at the end of decoding to get
4773 * all the decoded data. Flushing is done by calling this function with packets
4774 * with avpkt->data set to NULL and avpkt->size set to 0 until it stops
4775 * returning subtitles. It is safe to flush even those decoders that are not
4776 * marked with AV_CODEC_CAP_DELAY, then no subtitles will be returned.
4778 * @note The AVCodecContext MUST have been opened with @ref avcodec_open2()
4779 * before packets may be fed to the decoder.
4781 * @param avctx the codec context
4782 * @param[out] sub The Preallocated AVSubtitle in which the decoded subtitle will be stored,
4783 * must be freed with avsubtitle_free if *got_sub_ptr is set.
4784 * @param[in,out] got_sub_ptr Zero if no subtitle could be decompressed, otherwise, it is nonzero.
4785 * @param[in] avpkt The input AVPacket containing the input buffer.
4787 int avcodec_decode_subtitle2(AVCodecContext *avctx, AVSubtitle *sub,
4792 * Supply raw packet data as input to a decoder.
4794 * Internally, this call will copy relevant AVCodecContext fields, which can
4795 * influence decoding per-packet, and apply them when the packet is actually
4796 * decoded. (For example AVCodecContext.skip_frame, which might direct the
4797 * decoder to drop the frame contained by the packet sent with this function.)
4799 * @warning The input buffer, avpkt->data must be AV_INPUT_BUFFER_PADDING_SIZE
4800 * larger than the actual read bytes because some optimized bitstream
4801 * readers read 32 or 64 bits at once and could read over the end.
4803 * @warning Do not mix this API with the legacy API (like avcodec_decode_video2())
4804 * on the same AVCodecContext. It will return unexpected results now
4805 * or in future libavcodec versions.
4807 * @note The AVCodecContext MUST have been opened with @ref avcodec_open2()
4808 * before packets may be fed to the decoder.
4810 * @param avctx codec context
4811 * @param[in] avpkt The input AVPacket. Usually, this will be a single video
4812 * frame, or several complete audio frames.
4813 * Ownership of the packet remains with the caller, and the
4814 * decoder will not write to the packet. The decoder may create
4815 * a reference to the packet data (or copy it if the packet is
4816 * not reference-counted).
4817 * Unlike with older APIs, the packet is always fully consumed,
4818 * and if it contains multiple frames (e.g. some audio codecs),
4819 * will require you to call avcodec_receive_frame() multiple
4820 * times afterwards before you can send a new packet.
4821 * It can be NULL (or an AVPacket with data set to NULL and
4822 * size set to 0); in this case, it is considered a flush
4823 * packet, which signals the end of the stream. Sending the
4824 * first flush packet will return success. Subsequent ones are
4825 * unnecessary and will return AVERROR_EOF. If the decoder
4826 * still has frames buffered, it will return them after sending
4829 * @return 0 on success, otherwise negative error code:
4830 * AVERROR(EAGAIN): input is not accepted in the current state - user
4831 * must read output with avcodec_receive_frame() (once
4832 * all output is read, the packet should be resent, and
4833 * the call will not fail with EAGAIN).
4834 * AVERROR_EOF: the decoder has been flushed, and no new packets can
4835 * be sent to it (also returned if more than 1 flush
4837 * AVERROR(EINVAL): codec not opened, it is an encoder, or requires flush
4838 * AVERROR(ENOMEM): failed to add packet to internal queue, or similar
4839 * other errors: legitimate decoding errors
4841 int avcodec_send_packet(AVCodecContext *avctx, const AVPacket *avpkt);
4844 * Return decoded output data from a decoder.
4846 * @param avctx codec context
4847 * @param frame This will be set to a reference-counted video or audio
4848 * frame (depending on the decoder type) allocated by the
4849 * decoder. Note that the function will always call
4850 * av_frame_unref(frame) before doing anything else.
4853 * 0: success, a frame was returned
4854 * AVERROR(EAGAIN): output is not available in this state - user must try
4856 * AVERROR_EOF: the decoder has been fully flushed, and there will be
4857 * no more output frames
4858 * AVERROR(EINVAL): codec not opened, or it is an encoder
4859 * other negative values: legitimate decoding errors
4861 int avcodec_receive_frame(AVCodecContext *avctx, AVFrame *frame);
4864 * Supply a raw video or audio frame to the encoder. Use avcodec_receive_packet()
4865 * to retrieve buffered output packets.
4867 * @param avctx codec context
4868 * @param[in] frame AVFrame containing the raw audio or video frame to be encoded.
4869 * Ownership of the frame remains with the caller, and the
4870 * encoder will not write to the frame. The encoder may create
4871 * a reference to the frame data (or copy it if the frame is
4872 * not reference-counted).
4873 * It can be NULL, in which case it is considered a flush
4874 * packet. This signals the end of the stream. If the encoder
4875 * still has packets buffered, it will return them after this
4876 * call. Once flushing mode has been entered, additional flush
4877 * packets are ignored, and sending frames will return
4881 * If AV_CODEC_CAP_VARIABLE_FRAME_SIZE is set, then each frame
4882 * can have any number of samples.
4883 * If it is not set, frame->nb_samples must be equal to
4884 * avctx->frame_size for all frames except the last.
4885 * The final frame may be smaller than avctx->frame_size.
4886 * @return 0 on success, otherwise negative error code:
4887 * AVERROR(EAGAIN): input is not accepted in the current state - user
4888 * must read output with avcodec_receive_packet() (once
4889 * all output is read, the packet should be resent, and
4890 * the call will not fail with EAGAIN).
4891 * AVERROR_EOF: the encoder has been flushed, and no new frames can
4893 * AVERROR(EINVAL): codec not opened, refcounted_frames not set, it is a
4894 * decoder, or requires flush
4895 * AVERROR(ENOMEM): failed to add packet to internal queue, or similar
4896 * other errors: legitimate decoding errors
4898 int avcodec_send_frame(AVCodecContext *avctx, const AVFrame *frame);
4901 * Read encoded data from the encoder.
4903 * @param avctx codec context
4904 * @param avpkt This will be set to a reference-counted packet allocated by the
4905 * encoder. Note that the function will always call
4906 * av_frame_unref(frame) before doing anything else.
4907 * @return 0 on success, otherwise negative error code:
4908 * AVERROR(EAGAIN): output is not available in the current state - user
4909 * must try to send input
4910 * AVERROR_EOF: the encoder has been fully flushed, and there will be
4911 * no more output packets
4912 * AVERROR(EINVAL): codec not opened, or it is an encoder
4913 * other errors: legitimate decoding errors
4915 int avcodec_receive_packet(AVCodecContext *avctx, AVPacket *avpkt);
4918 * Create and return a AVHWFramesContext with values adequate for hardware
4919 * decoding. This is meant to get called from the get_format callback, and is
4920 * a helper for preparing a AVHWFramesContext for AVCodecContext.hw_frames_ctx.
4921 * This API is for decoding with certain hardware acceleration modes/APIs only.
4923 * The returned AVHWFramesContext is not initialized. The caller must do this
4924 * with av_hwframe_ctx_init().
4926 * Calling this function is not a requirement, but makes it simpler to avoid
4927 * codec or hardware API specific details when manually allocating frames.
4929 * Alternatively to this, an API user can set AVCodecContext.hw_device_ctx,
4930 * which sets up AVCodecContext.hw_frames_ctx fully automatically, and makes
4931 * it unnecessary to call this function or having to care about
4932 * AVHWFramesContext initialization at all.
4934 * There are a number of requirements for calling this function:
4936 * - It must be called from get_format with the same avctx parameter that was
4937 * passed to get_format. Calling it outside of get_format is not allowed, and
4938 * can trigger undefined behavior.
4939 * - The function is not always supported (see description of return values).
4940 * Even if this function returns successfully, hwaccel initialization could
4941 * fail later. (The degree to which implementations check whether the stream
4942 * is actually supported varies. Some do this check only after the user's
4943 * get_format callback returns.)
4944 * - The hw_pix_fmt must be one of the choices suggested by get_format. If the
4945 * user decides to use a AVHWFramesContext prepared with this API function,
4946 * the user must return the same hw_pix_fmt from get_format.
4947 * - The device_ref passed to this function must support the given hw_pix_fmt.
4948 * - After calling this API function, it is the user's responsibility to
4949 * initialize the AVHWFramesContext (returned by the out_frames_ref parameter),
4950 * and to set AVCodecContext.hw_frames_ctx to it. If done, this must be done
4951 * before returning from get_format (this is implied by the normal
4952 * AVCodecContext.hw_frames_ctx API rules).
4953 * - The AVHWFramesContext parameters may change every time time get_format is
4954 * called. Also, AVCodecContext.hw_frames_ctx is reset before get_format. So
4955 * you are inherently required to go through this process again on every
4957 * - It is perfectly possible to call this function without actually using
4958 * the resulting AVHWFramesContext. One use-case might be trying to reuse a
4959 * previously initialized AVHWFramesContext, and calling this API function
4960 * only to test whether the required frame parameters have changed.
4961 * - Fields that use dynamically allocated values of any kind must not be set
4962 * by the user unless setting them is explicitly allowed by the documentation.
4963 * If the user sets AVHWFramesContext.free and AVHWFramesContext.user_opaque,
4964 * the new free callback must call the potentially set previous free callback.
4965 * This API call may set any dynamically allocated fields, including the free
4968 * The function will set at least the following fields on AVHWFramesContext
4969 * (potentially more, depending on hwaccel API):
4971 * - All fields set by av_hwframe_ctx_alloc().
4972 * - Set the format field to hw_pix_fmt.
4973 * - Set the sw_format field to the most suited and most versatile format. (An
4974 * implication is that this will prefer generic formats over opaque formats
4975 * with arbitrary restrictions, if possible.)
4976 * - Set the width/height fields to the coded frame size, rounded up to the
4977 * API-specific minimum alignment.
4978 * - Only _if_ the hwaccel requires a pre-allocated pool: set the initial_pool_size
4979 * field to the number of maximum reference surfaces possible with the codec,
4980 * plus 1 surface for the user to work (meaning the user can safely reference
4981 * at most 1 decoded surface at a time), plus additional buffering introduced
4982 * by frame threading. If the hwaccel does not require pre-allocation, the
4983 * field is left to 0, and the decoder will allocate new surfaces on demand
4985 * - Possibly AVHWFramesContext.hwctx fields, depending on the underlying
4988 * Essentially, out_frames_ref returns the same as av_hwframe_ctx_alloc(), but
4989 * with basic frame parameters set.
4991 * The function is stateless, and does not change the AVCodecContext or the
4992 * device_ref AVHWDeviceContext.
4994 * @param avctx The context which is currently calling get_format, and which
4995 * implicitly contains all state needed for filling the returned
4996 * AVHWFramesContext properly.
4997 * @param device_ref A reference to the AVHWDeviceContext describing the device
4998 * which will be used by the hardware decoder.
4999 * @param hw_pix_fmt The hwaccel format you are going to return from get_format.
5000 * @param out_frames_ref On success, set to a reference to an _uninitialized_
5001 * AVHWFramesContext, created from the given device_ref.
5002 * Fields will be set to values required for decoding.
5003 * Not changed if an error is returned.
5004 * @return zero on success, a negative value on error. The following error codes
5005 * have special semantics:
5006 * AVERROR(ENOENT): the decoder does not support this functionality. Setup
5007 * is always manual, or it is a decoder which does not
5008 * support setting AVCodecContext.hw_frames_ctx at all,
5009 * or it is a software format.
5010 * AVERROR(EINVAL): it is known that hardware decoding is not supported for
5011 * this configuration, or the device_ref is not supported
5012 * for the hwaccel referenced by hw_pix_fmt.
5014 int avcodec_get_hw_frames_parameters(AVCodecContext *avctx,
5015 AVBufferRef *device_ref,
5016 enum AVPixelFormat hw_pix_fmt,
5017 AVBufferRef **out_frames_ref);
5022 * @defgroup lavc_parsing Frame parsing
5026 enum AVPictureStructure {
5027 AV_PICTURE_STRUCTURE_UNKNOWN, //< unknown
5028 AV_PICTURE_STRUCTURE_TOP_FIELD, //< coded as top field
5029 AV_PICTURE_STRUCTURE_BOTTOM_FIELD, //< coded as bottom field
5030 AV_PICTURE_STRUCTURE_FRAME, //< coded as frame
5033 typedef struct AVCodecParserContext {
5035 struct AVCodecParser *parser;
5036 int64_t frame_offset; /* offset of the current frame */
5037 int64_t cur_offset; /* current offset
5038 (incremented by each av_parser_parse()) */
5039 int64_t next_frame_offset; /* offset of the next frame */
5041 int pict_type; /* XXX: Put it back in AVCodecContext. */
5043 * This field is used for proper frame duration computation in lavf.
5044 * It signals, how much longer the frame duration of the current frame
5045 * is compared to normal frame duration.
5047 * frame_duration = (1 + repeat_pict) * time_base
5049 * It is used by codecs like H.264 to display telecined material.
5051 int repeat_pict; /* XXX: Put it back in AVCodecContext. */
5052 int64_t pts; /* pts of the current frame */
5053 int64_t dts; /* dts of the current frame */
5058 int fetch_timestamp;
5060 #define AV_PARSER_PTS_NB 4
5061 int cur_frame_start_index;
5062 int64_t cur_frame_offset[AV_PARSER_PTS_NB];
5063 int64_t cur_frame_pts[AV_PARSER_PTS_NB];
5064 int64_t cur_frame_dts[AV_PARSER_PTS_NB];
5067 #define PARSER_FLAG_COMPLETE_FRAMES 0x0001
5068 #define PARSER_FLAG_ONCE 0x0002
5069 /// Set if the parser has a valid file offset
5070 #define PARSER_FLAG_FETCHED_OFFSET 0x0004
5071 #define PARSER_FLAG_USE_CODEC_TS 0x1000
5073 int64_t offset; ///< byte offset from starting packet start
5074 int64_t cur_frame_end[AV_PARSER_PTS_NB];
5077 * Set by parser to 1 for key frames and 0 for non-key frames.
5078 * It is initialized to -1, so if the parser doesn't set this flag,
5079 * old-style fallback using AV_PICTURE_TYPE_I picture type as key frames
5084 #if FF_API_CONVERGENCE_DURATION
5086 * @deprecated unused
5088 attribute_deprecated
5089 int64_t convergence_duration;
5092 // Timestamp generation support:
5094 * Synchronization point for start of timestamp generation.
5096 * Set to >0 for sync point, 0 for no sync point and <0 for undefined
5099 * For example, this corresponds to presence of H.264 buffering period
5105 * Offset of the current timestamp against last timestamp sync point in
5106 * units of AVCodecContext.time_base.
5108 * Set to INT_MIN when dts_sync_point unused. Otherwise, it must
5109 * contain a valid timestamp offset.
5111 * Note that the timestamp of sync point has usually a nonzero
5112 * dts_ref_dts_delta, which refers to the previous sync point. Offset of
5113 * the next frame after timestamp sync point will be usually 1.
5115 * For example, this corresponds to H.264 cpb_removal_delay.
5117 int dts_ref_dts_delta;
5120 * Presentation delay of current frame in units of AVCodecContext.time_base.
5122 * Set to INT_MIN when dts_sync_point unused. Otherwise, it must
5123 * contain valid non-negative timestamp delta (presentation time of a frame
5124 * must not lie in the past).
5126 * This delay represents the difference between decoding and presentation
5127 * time of the frame.
5129 * For example, this corresponds to H.264 dpb_output_delay.
5134 * Position of the packet in file.
5136 * Analogous to cur_frame_pts/dts
5138 int64_t cur_frame_pos[AV_PARSER_PTS_NB];
5141 * Byte position of currently parsed frame in stream.
5146 * Previous frame byte position.
5151 * Duration of the current frame.
5152 * For audio, this is in units of 1 / AVCodecContext.sample_rate.
5153 * For all other types, this is in units of AVCodecContext.time_base.
5157 enum AVFieldOrder field_order;
5160 * Indicate whether a picture is coded as a frame, top field or bottom field.
5162 * For example, H.264 field_pic_flag equal to 0 corresponds to
5163 * AV_PICTURE_STRUCTURE_FRAME. An H.264 picture with field_pic_flag
5164 * equal to 1 and bottom_field_flag equal to 0 corresponds to
5165 * AV_PICTURE_STRUCTURE_TOP_FIELD.
5167 enum AVPictureStructure picture_structure;
5170 * Picture number incremented in presentation or output order.
5171 * This field may be reinitialized at the first picture of a new sequence.
5173 * For example, this corresponds to H.264 PicOrderCnt.
5175 int output_picture_number;
5178 * Dimensions of the decoded video intended for presentation.
5184 * Dimensions of the coded video.
5190 * The format of the coded data, corresponds to enum AVPixelFormat for video
5191 * and for enum AVSampleFormat for audio.
5193 * Note that a decoder can have considerable freedom in how exactly it
5194 * decodes the data, so the format reported here might be different from the
5195 * one returned by a decoder.
5198 } AVCodecParserContext;
5200 typedef struct AVCodecParser {
5201 int codec_ids[5]; /* several codec IDs are permitted */
5203 int (*parser_init)(AVCodecParserContext *s);
5204 /* This callback never returns an error, a negative value means that
5205 * the frame start was in a previous packet. */
5206 int (*parser_parse)(AVCodecParserContext *s,
5207 AVCodecContext *avctx,
5208 const uint8_t **poutbuf, int *poutbuf_size,
5209 const uint8_t *buf, int buf_size);
5210 void (*parser_close)(AVCodecParserContext *s);
5211 int (*split)(AVCodecContext *avctx, const uint8_t *buf, int buf_size);
5212 struct AVCodecParser *next;
5216 * Iterate over all registered codec parsers.
5218 * @param opaque a pointer where libavcodec will store the iteration state. Must
5219 * point to NULL to start the iteration.
5221 * @return the next registered codec parser or NULL when the iteration is
5224 const AVCodecParser *av_parser_iterate(void **opaque);
5226 attribute_deprecated
5227 AVCodecParser *av_parser_next(const AVCodecParser *c);
5229 attribute_deprecated
5230 void av_register_codec_parser(AVCodecParser *parser);
5231 AVCodecParserContext *av_parser_init(int codec_id);
5236 * @param s parser context.
5237 * @param avctx codec context.
5238 * @param poutbuf set to pointer to parsed buffer or NULL if not yet finished.
5239 * @param poutbuf_size set to size of parsed buffer or zero if not yet finished.
5240 * @param buf input buffer.
5241 * @param buf_size buffer size in bytes without the padding. I.e. the full buffer
5242 size is assumed to be buf_size + AV_INPUT_BUFFER_PADDING_SIZE.
5243 To signal EOF, this should be 0 (so that the last frame
5245 * @param pts input presentation timestamp.
5246 * @param dts input decoding timestamp.
5247 * @param pos input byte position in stream.
5248 * @return the number of bytes of the input bitstream used.
5253 * len = av_parser_parse2(myparser, AVCodecContext, &data, &size,
5260 * decode_frame(data, size);
5264 int av_parser_parse2(AVCodecParserContext *s,
5265 AVCodecContext *avctx,
5266 uint8_t **poutbuf, int *poutbuf_size,
5267 const uint8_t *buf, int buf_size,
5268 int64_t pts, int64_t dts,
5272 * @return 0 if the output buffer is a subset of the input, 1 if it is allocated and must be freed
5273 * @deprecated use AVBitStreamFilter
5275 int av_parser_change(AVCodecParserContext *s,
5276 AVCodecContext *avctx,
5277 uint8_t **poutbuf, int *poutbuf_size,
5278 const uint8_t *buf, int buf_size, int keyframe);
5279 void av_parser_close(AVCodecParserContext *s);
5287 * @addtogroup lavc_encoding
5292 * Find a registered encoder with a matching codec ID.
5294 * @param id AVCodecID of the requested encoder
5295 * @return An encoder if one was found, NULL otherwise.
5297 AVCodec *avcodec_find_encoder(enum AVCodecID id);
5300 * Find a registered encoder with the specified name.
5302 * @param name name of the requested encoder
5303 * @return An encoder if one was found, NULL otherwise.
5305 AVCodec *avcodec_find_encoder_by_name(const char *name);
5308 * Encode a frame of audio.
5310 * Takes input samples from frame and writes the next output packet, if
5311 * available, to avpkt. The output packet does not necessarily contain data for
5312 * the most recent frame, as encoders can delay, split, and combine input frames
5313 * internally as needed.
5315 * @param avctx codec context
5316 * @param avpkt output AVPacket.
5317 * The user can supply an output buffer by setting
5318 * avpkt->data and avpkt->size prior to calling the
5319 * function, but if the size of the user-provided data is not
5320 * large enough, encoding will fail. If avpkt->data and
5321 * avpkt->size are set, avpkt->destruct must also be set. All
5322 * other AVPacket fields will be reset by the encoder using
5323 * av_init_packet(). If avpkt->data is NULL, the encoder will
5324 * allocate it. The encoder will set avpkt->size to the size
5325 * of the output packet.
5327 * If this function fails or produces no output, avpkt will be
5328 * freed using av_packet_unref().
5329 * @param[in] frame AVFrame containing the raw audio data to be encoded.
5330 * May be NULL when flushing an encoder that has the
5331 * AV_CODEC_CAP_DELAY capability set.
5332 * If AV_CODEC_CAP_VARIABLE_FRAME_SIZE is set, then each frame
5333 * can have any number of samples.
5334 * If it is not set, frame->nb_samples must be equal to
5335 * avctx->frame_size for all frames except the last.
5336 * The final frame may be smaller than avctx->frame_size.
5337 * @param[out] got_packet_ptr This field is set to 1 by libavcodec if the
5338 * output packet is non-empty, and to 0 if it is
5339 * empty. If the function returns an error, the
5340 * packet can be assumed to be invalid, and the
5341 * value of got_packet_ptr is undefined and should
5343 * @return 0 on success, negative error code on failure
5345 * @deprecated use avcodec_send_frame()/avcodec_receive_packet() instead
5347 attribute_deprecated
5348 int avcodec_encode_audio2(AVCodecContext *avctx, AVPacket *avpkt,
5349 const AVFrame *frame, int *got_packet_ptr);
5352 * Encode a frame of video.
5354 * Takes input raw video data from frame and writes the next output packet, if
5355 * available, to avpkt. The output packet does not necessarily contain data for
5356 * the most recent frame, as encoders can delay and reorder input frames
5357 * internally as needed.
5359 * @param avctx codec context
5360 * @param avpkt output AVPacket.
5361 * The user can supply an output buffer by setting
5362 * avpkt->data and avpkt->size prior to calling the
5363 * function, but if the size of the user-provided data is not
5364 * large enough, encoding will fail. All other AVPacket fields
5365 * will be reset by the encoder using av_init_packet(). If
5366 * avpkt->data is NULL, the encoder will allocate it.
5367 * The encoder will set avpkt->size to the size of the
5368 * output packet. The returned data (if any) belongs to the
5369 * caller, he is responsible for freeing it.
5371 * If this function fails or produces no output, avpkt will be
5372 * freed using av_packet_unref().
5373 * @param[in] frame AVFrame containing the raw video data to be encoded.
5374 * May be NULL when flushing an encoder that has the
5375 * AV_CODEC_CAP_DELAY capability set.
5376 * @param[out] got_packet_ptr This field is set to 1 by libavcodec if the
5377 * output packet is non-empty, and to 0 if it is
5378 * empty. If the function returns an error, the
5379 * packet can be assumed to be invalid, and the
5380 * value of got_packet_ptr is undefined and should
5382 * @return 0 on success, negative error code on failure
5384 * @deprecated use avcodec_send_frame()/avcodec_receive_packet() instead
5386 attribute_deprecated
5387 int avcodec_encode_video2(AVCodecContext *avctx, AVPacket *avpkt,
5388 const AVFrame *frame, int *got_packet_ptr);
5390 int avcodec_encode_subtitle(AVCodecContext *avctx, uint8_t *buf, int buf_size,
5391 const AVSubtitle *sub);
5398 #if FF_API_AVPICTURE
5400 * @addtogroup lavc_picture
5405 * @deprecated unused
5407 attribute_deprecated
5408 int avpicture_alloc(AVPicture *picture, enum AVPixelFormat pix_fmt, int width, int height);
5411 * @deprecated unused
5413 attribute_deprecated
5414 void avpicture_free(AVPicture *picture);
5417 * @deprecated use av_image_fill_arrays() instead.
5419 attribute_deprecated
5420 int avpicture_fill(AVPicture *picture, const uint8_t *ptr,
5421 enum AVPixelFormat pix_fmt, int width, int height);
5424 * @deprecated use av_image_copy_to_buffer() instead.
5426 attribute_deprecated
5427 int avpicture_layout(const AVPicture *src, enum AVPixelFormat pix_fmt,
5428 int width, int height,
5429 unsigned char *dest, int dest_size);
5432 * @deprecated use av_image_get_buffer_size() instead.
5434 attribute_deprecated
5435 int avpicture_get_size(enum AVPixelFormat pix_fmt, int width, int height);
5438 * @deprecated av_image_copy() instead.
5440 attribute_deprecated
5441 void av_picture_copy(AVPicture *dst, const AVPicture *src,
5442 enum AVPixelFormat pix_fmt, int width, int height);
5445 * @deprecated unused
5447 attribute_deprecated
5448 int av_picture_crop(AVPicture *dst, const AVPicture *src,
5449 enum AVPixelFormat pix_fmt, int top_band, int left_band);
5452 * @deprecated unused
5454 attribute_deprecated
5455 int av_picture_pad(AVPicture *dst, const AVPicture *src, int height, int width, enum AVPixelFormat pix_fmt,
5456 int padtop, int padbottom, int padleft, int padright, int *color);
5464 * @defgroup lavc_misc Utility functions
5467 * Miscellaneous utility functions related to both encoding and decoding
5473 * @defgroup lavc_misc_pixfmt Pixel formats
5475 * Functions for working with pixel formats.
5479 #if FF_API_GETCHROMA
5481 * @deprecated Use av_pix_fmt_get_chroma_sub_sample
5484 attribute_deprecated
5485 void avcodec_get_chroma_sub_sample(enum AVPixelFormat pix_fmt, int *h_shift, int *v_shift);
5489 * Return a value representing the fourCC code associated to the
5490 * pixel format pix_fmt, or 0 if no associated fourCC code can be
5493 unsigned int avcodec_pix_fmt_to_codec_tag(enum AVPixelFormat pix_fmt);
5496 * @deprecated see av_get_pix_fmt_loss()
5498 int avcodec_get_pix_fmt_loss(enum AVPixelFormat dst_pix_fmt, enum AVPixelFormat src_pix_fmt,
5502 * Find the best pixel format to convert to given a certain source pixel
5503 * format. When converting from one pixel format to another, information loss
5504 * may occur. For example, when converting from RGB24 to GRAY, the color
5505 * information will be lost. Similarly, other losses occur when converting from
5506 * some formats to other formats. avcodec_find_best_pix_fmt_of_2() searches which of
5507 * the given pixel formats should be used to suffer the least amount of loss.
5508 * The pixel formats from which it chooses one, are determined by the
5509 * pix_fmt_list parameter.
5512 * @param[in] pix_fmt_list AV_PIX_FMT_NONE terminated array of pixel formats to choose from
5513 * @param[in] src_pix_fmt source pixel format
5514 * @param[in] has_alpha Whether the source pixel format alpha channel is used.
5515 * @param[out] loss_ptr Combination of flags informing you what kind of losses will occur.
5516 * @return The best pixel format to convert to or -1 if none was found.
5518 enum AVPixelFormat avcodec_find_best_pix_fmt_of_list(const enum AVPixelFormat *pix_fmt_list,
5519 enum AVPixelFormat src_pix_fmt,
5520 int has_alpha, int *loss_ptr);
5523 * @deprecated see av_find_best_pix_fmt_of_2()
5525 enum AVPixelFormat avcodec_find_best_pix_fmt_of_2(enum AVPixelFormat dst_pix_fmt1, enum AVPixelFormat dst_pix_fmt2,
5526 enum AVPixelFormat src_pix_fmt, int has_alpha, int *loss_ptr);
5528 attribute_deprecated
5529 enum AVPixelFormat avcodec_find_best_pix_fmt2(enum AVPixelFormat dst_pix_fmt1, enum AVPixelFormat dst_pix_fmt2,
5530 enum AVPixelFormat src_pix_fmt, int has_alpha, int *loss_ptr);
5532 enum AVPixelFormat avcodec_default_get_format(struct AVCodecContext *s, const enum AVPixelFormat * fmt);
5538 #if FF_API_TAG_STRING
5540 * Put a string representing the codec tag codec_tag in buf.
5542 * @param buf buffer to place codec tag in
5543 * @param buf_size size in bytes of buf
5544 * @param codec_tag codec tag to assign
5545 * @return the length of the string that would have been generated if
5546 * enough space had been available, excluding the trailing null
5548 * @deprecated see av_fourcc_make_string() and av_fourcc2str().
5550 attribute_deprecated
5551 size_t av_get_codec_tag_string(char *buf, size_t buf_size, unsigned int codec_tag);
5554 void avcodec_string(char *buf, int buf_size, AVCodecContext *enc, int encode);
5557 * Return a name for the specified profile, if available.
5559 * @param codec the codec that is searched for the given profile
5560 * @param profile the profile value for which a name is requested
5561 * @return A name for the profile if found, NULL otherwise.
5563 const char *av_get_profile_name(const AVCodec *codec, int profile);
5566 * Return a name for the specified profile, if available.
5568 * @param codec_id the ID of the codec to which the requested profile belongs
5569 * @param profile the profile value for which a name is requested
5570 * @return A name for the profile if found, NULL otherwise.
5572 * @note unlike av_get_profile_name(), which searches a list of profiles
5573 * supported by a specific decoder or encoder implementation, this
5574 * function searches the list of profiles from the AVCodecDescriptor
5576 const char *avcodec_profile_name(enum AVCodecID codec_id, int profile);
5578 int avcodec_default_execute(AVCodecContext *c, int (*func)(AVCodecContext *c2, void *arg2),void *arg, int *ret, int count, int size);
5579 int avcodec_default_execute2(AVCodecContext *c, int (*func)(AVCodecContext *c2, void *arg2, int, int),void *arg, int *ret, int count);
5580 //FIXME func typedef
5583 * Fill AVFrame audio data and linesize pointers.
5585 * The buffer buf must be a preallocated buffer with a size big enough
5586 * to contain the specified samples amount. The filled AVFrame data
5587 * pointers will point to this buffer.
5589 * AVFrame extended_data channel pointers are allocated if necessary for
5592 * @param frame the AVFrame
5593 * frame->nb_samples must be set prior to calling the
5594 * function. This function fills in frame->data,
5595 * frame->extended_data, frame->linesize[0].
5596 * @param nb_channels channel count
5597 * @param sample_fmt sample format
5598 * @param buf buffer to use for frame data
5599 * @param buf_size size of buffer
5600 * @param align plane size sample alignment (0 = default)
5601 * @return >=0 on success, negative error code on failure
5602 * @todo return the size in bytes required to store the samples in
5603 * case of success, at the next libavutil bump
5605 int avcodec_fill_audio_frame(AVFrame *frame, int nb_channels,
5606 enum AVSampleFormat sample_fmt, const uint8_t *buf,
5607 int buf_size, int align);
5610 * Reset the internal decoder state / flush internal buffers. Should be called
5611 * e.g. when seeking or when switching to a different stream.
5613 * @note when refcounted frames are not used (i.e. avctx->refcounted_frames is 0),
5614 * this invalidates the frames previously returned from the decoder. When
5615 * refcounted frames are used, the decoder just releases any references it might
5616 * keep internally, but the caller's reference remains valid.
5618 void avcodec_flush_buffers(AVCodecContext *avctx);
5621 * Return codec bits per sample.
5623 * @param[in] codec_id the codec
5624 * @return Number of bits per sample or zero if unknown for the given codec.
5626 int av_get_bits_per_sample(enum AVCodecID codec_id);
5629 * Return the PCM codec associated with a sample format.
5630 * @param be endianness, 0 for little, 1 for big,
5631 * -1 (or anything else) for native
5632 * @return AV_CODEC_ID_PCM_* or AV_CODEC_ID_NONE
5634 enum AVCodecID av_get_pcm_codec(enum AVSampleFormat fmt, int be);
5637 * Return codec bits per sample.
5638 * Only return non-zero if the bits per sample is exactly correct, not an
5641 * @param[in] codec_id the codec
5642 * @return Number of bits per sample or zero if unknown for the given codec.
5644 int av_get_exact_bits_per_sample(enum AVCodecID codec_id);
5647 * Return audio frame duration.
5649 * @param avctx codec context
5650 * @param frame_bytes size of the frame, or 0 if unknown
5651 * @return frame duration, in samples, if known. 0 if not able to
5654 int av_get_audio_frame_duration(AVCodecContext *avctx, int frame_bytes);
5657 * This function is the same as av_get_audio_frame_duration(), except it works
5658 * with AVCodecParameters instead of an AVCodecContext.
5660 int av_get_audio_frame_duration2(AVCodecParameters *par, int frame_bytes);
5663 typedef struct AVBitStreamFilterContext {
5665 const struct AVBitStreamFilter *filter;
5666 AVCodecParserContext *parser;
5667 struct AVBitStreamFilterContext *next;
5669 * Internal default arguments, used if NULL is passed to av_bitstream_filter_filter().
5670 * Not for access by library users.
5673 } AVBitStreamFilterContext;
5676 typedef struct AVBSFInternal AVBSFInternal;
5679 * The bitstream filter state.
5681 * This struct must be allocated with av_bsf_alloc() and freed with
5684 * The fields in the struct will only be changed (by the caller or by the
5685 * filter) as described in their documentation, and are to be considered
5686 * immutable otherwise.
5688 typedef struct AVBSFContext {
5690 * A class for logging and AVOptions
5692 const AVClass *av_class;
5695 * The bitstream filter this context is an instance of.
5697 const struct AVBitStreamFilter *filter;
5700 * Opaque libavcodec internal data. Must not be touched by the caller in any
5703 AVBSFInternal *internal;
5706 * Opaque filter-specific private data. If filter->priv_class is non-NULL,
5707 * this is an AVOptions-enabled struct.
5712 * Parameters of the input stream. This field is allocated in
5713 * av_bsf_alloc(), it needs to be filled by the caller before
5716 AVCodecParameters *par_in;
5719 * Parameters of the output stream. This field is allocated in
5720 * av_bsf_alloc(), it is set by the filter in av_bsf_init().
5722 AVCodecParameters *par_out;
5725 * The timebase used for the timestamps of the input packets. Set by the
5726 * caller before av_bsf_init().
5728 AVRational time_base_in;
5731 * The timebase used for the timestamps of the output packets. Set by the
5732 * filter in av_bsf_init().
5734 AVRational time_base_out;
5737 typedef struct AVBitStreamFilter {
5741 * A list of codec ids supported by the filter, terminated by
5743 * May be NULL, in that case the bitstream filter works with any codec id.
5745 const enum AVCodecID *codec_ids;
5748 * A class for the private data, used to declare bitstream filter private
5749 * AVOptions. This field is NULL for bitstream filters that do not declare
5752 * If this field is non-NULL, the first member of the filter private data
5753 * must be a pointer to AVClass, which will be set by libavcodec generic
5754 * code to this class.
5756 const AVClass *priv_class;
5758 /*****************************************************************
5759 * No fields below this line are part of the public API. They
5760 * may not be used outside of libavcodec and can be changed and
5762 * New public fields should be added right above.
5763 *****************************************************************
5767 int (*init)(AVBSFContext *ctx);
5768 int (*filter)(AVBSFContext *ctx, AVPacket *pkt);
5769 void (*close)(AVBSFContext *ctx);
5770 } AVBitStreamFilter;
5774 * @deprecated the old bitstream filtering API (using AVBitStreamFilterContext)
5775 * is deprecated. Use the new bitstream filtering API (using AVBSFContext).
5777 attribute_deprecated
5778 void av_register_bitstream_filter(AVBitStreamFilter *bsf);
5780 * @deprecated the old bitstream filtering API (using AVBitStreamFilterContext)
5781 * is deprecated. Use av_bsf_get_by_name(), av_bsf_alloc(), and av_bsf_init()
5782 * from the new bitstream filtering API (using AVBSFContext).
5784 attribute_deprecated
5785 AVBitStreamFilterContext *av_bitstream_filter_init(const char *name);
5787 * @deprecated the old bitstream filtering API (using AVBitStreamFilterContext)
5788 * is deprecated. Use av_bsf_send_packet() and av_bsf_receive_packet() from the
5789 * new bitstream filtering API (using AVBSFContext).
5791 attribute_deprecated
5792 int av_bitstream_filter_filter(AVBitStreamFilterContext *bsfc,
5793 AVCodecContext *avctx, const char *args,
5794 uint8_t **poutbuf, int *poutbuf_size,
5795 const uint8_t *buf, int buf_size, int keyframe);
5797 * @deprecated the old bitstream filtering API (using AVBitStreamFilterContext)
5798 * is deprecated. Use av_bsf_free() from the new bitstream filtering API (using
5801 attribute_deprecated
5802 void av_bitstream_filter_close(AVBitStreamFilterContext *bsf);
5804 * @deprecated the old bitstream filtering API (using AVBitStreamFilterContext)
5805 * is deprecated. Use av_bsf_iterate() from the new bitstream filtering API (using
5808 attribute_deprecated
5809 const AVBitStreamFilter *av_bitstream_filter_next(const AVBitStreamFilter *f);
5813 * @return a bitstream filter with the specified name or NULL if no such
5814 * bitstream filter exists.
5816 const AVBitStreamFilter *av_bsf_get_by_name(const char *name);
5819 * Iterate over all registered bitstream filters.
5821 * @param opaque a pointer where libavcodec will store the iteration state. Must
5822 * point to NULL to start the iteration.
5824 * @return the next registered bitstream filter or NULL when the iteration is
5827 const AVBitStreamFilter *av_bsf_iterate(void **opaque);
5829 attribute_deprecated
5830 const AVBitStreamFilter *av_bsf_next(void **opaque);
5834 * Allocate a context for a given bitstream filter. The caller must fill in the
5835 * context parameters as described in the documentation and then call
5836 * av_bsf_init() before sending any data to the filter.
5838 * @param filter the filter for which to allocate an instance.
5839 * @param ctx a pointer into which the pointer to the newly-allocated context
5840 * will be written. It must be freed with av_bsf_free() after the
5841 * filtering is done.
5843 * @return 0 on success, a negative AVERROR code on failure
5845 int av_bsf_alloc(const AVBitStreamFilter *filter, AVBSFContext **ctx);
5848 * Prepare the filter for use, after all the parameters and options have been
5851 int av_bsf_init(AVBSFContext *ctx);
5854 * Submit a packet for filtering.
5856 * After sending each packet, the filter must be completely drained by calling
5857 * av_bsf_receive_packet() repeatedly until it returns AVERROR(EAGAIN) or
5860 * @param pkt the packet to filter. The bitstream filter will take ownership of
5861 * the packet and reset the contents of pkt. pkt is not touched if an error occurs.
5862 * This parameter may be NULL, which signals the end of the stream (i.e. no more
5863 * packets will be sent). That will cause the filter to output any packets it
5864 * may have buffered internally.
5866 * @return 0 on success, a negative AVERROR on error.
5868 int av_bsf_send_packet(AVBSFContext *ctx, AVPacket *pkt);
5871 * Retrieve a filtered packet.
5873 * @param[out] pkt this struct will be filled with the contents of the filtered
5874 * packet. It is owned by the caller and must be freed using
5875 * av_packet_unref() when it is no longer needed.
5876 * This parameter should be "clean" (i.e. freshly allocated
5877 * with av_packet_alloc() or unreffed with av_packet_unref())
5878 * when this function is called. If this function returns
5879 * successfully, the contents of pkt will be completely
5880 * overwritten by the returned data. On failure, pkt is not
5883 * @return 0 on success. AVERROR(EAGAIN) if more packets need to be sent to the
5884 * filter (using av_bsf_send_packet()) to get more output. AVERROR_EOF if there
5885 * will be no further output from the filter. Another negative AVERROR value if
5888 * @note one input packet may result in several output packets, so after sending
5889 * a packet with av_bsf_send_packet(), this function needs to be called
5890 * repeatedly until it stops returning 0. It is also possible for a filter to
5891 * output fewer packets than were sent to it, so this function may return
5892 * AVERROR(EAGAIN) immediately after a successful av_bsf_send_packet() call.
5894 int av_bsf_receive_packet(AVBSFContext *ctx, AVPacket *pkt);
5897 * Free a bitstream filter context and everything associated with it; write NULL
5898 * into the supplied pointer.
5900 void av_bsf_free(AVBSFContext **ctx);
5903 * Get the AVClass for AVBSFContext. It can be used in combination with
5904 * AV_OPT_SEARCH_FAKE_OBJ for examining options.
5906 * @see av_opt_find().
5908 const AVClass *av_bsf_get_class(void);
5911 * Structure for chain/list of bitstream filters.
5912 * Empty list can be allocated by av_bsf_list_alloc().
5914 typedef struct AVBSFList AVBSFList;
5917 * Allocate empty list of bitstream filters.
5918 * The list must be later freed by av_bsf_list_free()
5919 * or finalized by av_bsf_list_finalize().
5921 * @return Pointer to @ref AVBSFList on success, NULL in case of failure
5923 AVBSFList *av_bsf_list_alloc(void);
5926 * Free list of bitstream filters.
5928 * @param lst Pointer to pointer returned by av_bsf_list_alloc()
5930 void av_bsf_list_free(AVBSFList **lst);
5933 * Append bitstream filter to the list of bitstream filters.
5935 * @param lst List to append to
5936 * @param bsf Filter context to be appended
5938 * @return >=0 on success, negative AVERROR in case of failure
5940 int av_bsf_list_append(AVBSFList *lst, AVBSFContext *bsf);
5943 * Construct new bitstream filter context given it's name and options
5944 * and append it to the list of bitstream filters.
5946 * @param lst List to append to
5947 * @param bsf_name Name of the bitstream filter
5948 * @param options Options for the bitstream filter, can be set to NULL
5950 * @return >=0 on success, negative AVERROR in case of failure
5952 int av_bsf_list_append2(AVBSFList *lst, const char * bsf_name, AVDictionary **options);
5954 * Finalize list of bitstream filters.
5956 * This function will transform @ref AVBSFList to single @ref AVBSFContext,
5957 * so the whole chain of bitstream filters can be treated as single filter
5958 * freshly allocated by av_bsf_alloc().
5959 * If the call is successful, @ref AVBSFList structure is freed and lst
5960 * will be set to NULL. In case of failure, caller is responsible for
5961 * freeing the structure by av_bsf_list_free()
5963 * @param lst Filter list structure to be transformed
5964 * @param[out] bsf Pointer to be set to newly created @ref AVBSFContext structure
5965 * representing the chain of bitstream filters
5967 * @return >=0 on success, negative AVERROR in case of failure
5969 int av_bsf_list_finalize(AVBSFList **lst, AVBSFContext **bsf);
5972 * Parse string describing list of bitstream filters and create single
5973 * @ref AVBSFContext describing the whole chain of bitstream filters.
5974 * Resulting @ref AVBSFContext can be treated as any other @ref AVBSFContext freshly
5975 * allocated by av_bsf_alloc().
5977 * @param str String describing chain of bitstream filters in format
5978 * `bsf1[=opt1=val1:opt2=val2][,bsf2]`
5979 * @param[out] bsf Pointer to be set to newly created @ref AVBSFContext structure
5980 * representing the chain of bitstream filters
5982 * @return >=0 on success, negative AVERROR in case of failure
5984 int av_bsf_list_parse_str(const char *str, AVBSFContext **bsf);
5987 * Get null/pass-through bitstream filter.
5989 * @param[out] bsf Pointer to be set to new instance of pass-through bitstream filter
5993 int av_bsf_get_null_filter(AVBSFContext **bsf);
5998 * Same behaviour av_fast_malloc but the buffer has additional
5999 * AV_INPUT_BUFFER_PADDING_SIZE at the end which will always be 0.
6001 * In addition the whole buffer will initially and after resizes
6002 * be 0-initialized so that no uninitialized data will ever appear.
6004 void av_fast_padded_malloc(void *ptr, unsigned int *size, size_t min_size);
6007 * Same behaviour av_fast_padded_malloc except that buffer will always
6008 * be 0-initialized after call.
6010 void av_fast_padded_mallocz(void *ptr, unsigned int *size, size_t min_size);
6013 * Encode extradata length to a buffer. Used by xiph codecs.
6015 * @param s buffer to write to; must be at least (v/255+1) bytes long
6016 * @param v size of extradata in bytes
6017 * @return number of bytes written to the buffer.
6019 unsigned int av_xiphlacing(unsigned char *s, unsigned int v);
6021 #if FF_API_USER_VISIBLE_AVHWACCEL
6023 * Register the hardware accelerator hwaccel.
6025 * @deprecated This function doesn't do anything.
6027 attribute_deprecated
6028 void av_register_hwaccel(AVHWAccel *hwaccel);
6031 * If hwaccel is NULL, returns the first registered hardware accelerator,
6032 * if hwaccel is non-NULL, returns the next registered hardware accelerator
6033 * after hwaccel, or NULL if hwaccel is the last one.
6035 * @deprecated AVHWaccel structures contain no user-serviceable parts, so
6036 * this function should not be used.
6038 attribute_deprecated
6039 AVHWAccel *av_hwaccel_next(const AVHWAccel *hwaccel);
6044 * Lock operation used by lockmgr
6046 * @deprecated Deprecated together with av_lockmgr_register().
6049 AV_LOCK_CREATE, ///< Create a mutex
6050 AV_LOCK_OBTAIN, ///< Lock the mutex
6051 AV_LOCK_RELEASE, ///< Unlock the mutex
6052 AV_LOCK_DESTROY, ///< Free mutex resources
6056 * Register a user provided lock manager supporting the operations
6057 * specified by AVLockOp. The "mutex" argument to the function points
6058 * to a (void *) where the lockmgr should store/get a pointer to a user
6059 * allocated mutex. It is NULL upon AV_LOCK_CREATE and equal to the
6060 * value left by the last call for all other ops. If the lock manager is
6061 * unable to perform the op then it should leave the mutex in the same
6062 * state as when it was called and return a non-zero value. However,
6063 * when called with AV_LOCK_DESTROY the mutex will always be assumed to
6064 * have been successfully destroyed. If av_lockmgr_register succeeds
6065 * it will return a non-negative value, if it fails it will return a
6066 * negative value and destroy all mutex and unregister all callbacks.
6067 * av_lockmgr_register is not thread-safe, it must be called from a
6068 * single thread before any calls which make use of locking are used.
6070 * @param cb User defined callback. av_lockmgr_register invokes calls
6071 * to this callback and the previously registered callback.
6072 * The callback will be used to create more than one mutex
6073 * each of which must be backed by its own underlying locking
6074 * mechanism (i.e. do not use a single static object to
6075 * implement your lock manager). If cb is set to NULL the
6076 * lockmgr will be unregistered.
6078 * @deprecated This function does nothing, and always returns 0. Be sure to
6079 * build with thread support to get basic thread safety.
6081 attribute_deprecated
6082 int av_lockmgr_register(int (*cb)(void **mutex, enum AVLockOp op));
6086 * Get the type of the given codec.
6088 enum AVMediaType avcodec_get_type(enum AVCodecID codec_id);
6091 * Get the name of a codec.
6092 * @return a static string identifying the codec; never NULL
6094 const char *avcodec_get_name(enum AVCodecID id);
6097 * @return a positive value if s is open (i.e. avcodec_open2() was called on it
6098 * with no corresponding avcodec_close()), 0 otherwise.
6100 int avcodec_is_open(AVCodecContext *s);
6103 * @return a non-zero number if codec is an encoder, zero otherwise
6105 int av_codec_is_encoder(const AVCodec *codec);
6108 * @return a non-zero number if codec is a decoder, zero otherwise
6110 int av_codec_is_decoder(const AVCodec *codec);
6113 * @return descriptor for given codec ID or NULL if no descriptor exists.
6115 const AVCodecDescriptor *avcodec_descriptor_get(enum AVCodecID id);
6118 * Iterate over all codec descriptors known to libavcodec.
6120 * @param prev previous descriptor. NULL to get the first descriptor.
6122 * @return next descriptor or NULL after the last descriptor
6124 const AVCodecDescriptor *avcodec_descriptor_next(const AVCodecDescriptor *prev);
6127 * @return codec descriptor with the given name or NULL if no such descriptor
6130 const AVCodecDescriptor *avcodec_descriptor_get_by_name(const char *name);
6133 * Allocate a CPB properties structure and initialize its fields to default
6136 * @param size if non-NULL, the size of the allocated struct will be written
6137 * here. This is useful for embedding it in side data.
6139 * @return the newly allocated struct or NULL on failure
6141 AVCPBProperties *av_cpb_properties_alloc(size_t *size);
6147 #endif /* AVCODEC_AVCODEC_H */