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,
414 AV_CODEC_ID_Y41P = 0x8000,
419 AV_CODEC_ID_TARGA_Y216,
431 AV_CODEC_ID_TRUEMOTION2RT,
433 AV_CODEC_ID_MAGICYUV,
434 AV_CODEC_ID_SHEERVIDEO,
441 AV_CODEC_ID_CLEARVIDEO,
444 AV_CODEC_ID_BITPACKED,
451 AV_CODEC_ID_PROSUMER,
464 /* various PCM "codecs" */
465 AV_CODEC_ID_FIRST_AUDIO = 0x10000, ///< A dummy id pointing at the start of audio codecs
466 AV_CODEC_ID_PCM_S16LE = 0x10000,
467 AV_CODEC_ID_PCM_S16BE,
468 AV_CODEC_ID_PCM_U16LE,
469 AV_CODEC_ID_PCM_U16BE,
472 AV_CODEC_ID_PCM_MULAW,
473 AV_CODEC_ID_PCM_ALAW,
474 AV_CODEC_ID_PCM_S32LE,
475 AV_CODEC_ID_PCM_S32BE,
476 AV_CODEC_ID_PCM_U32LE,
477 AV_CODEC_ID_PCM_U32BE,
478 AV_CODEC_ID_PCM_S24LE,
479 AV_CODEC_ID_PCM_S24BE,
480 AV_CODEC_ID_PCM_U24LE,
481 AV_CODEC_ID_PCM_U24BE,
482 AV_CODEC_ID_PCM_S24DAUD,
483 AV_CODEC_ID_PCM_ZORK,
484 AV_CODEC_ID_PCM_S16LE_PLANAR,
486 AV_CODEC_ID_PCM_F32BE,
487 AV_CODEC_ID_PCM_F32LE,
488 AV_CODEC_ID_PCM_F64BE,
489 AV_CODEC_ID_PCM_F64LE,
490 AV_CODEC_ID_PCM_BLURAY,
493 AV_CODEC_ID_PCM_S8_PLANAR,
494 AV_CODEC_ID_PCM_S24LE_PLANAR,
495 AV_CODEC_ID_PCM_S32LE_PLANAR,
496 AV_CODEC_ID_PCM_S16BE_PLANAR,
498 AV_CODEC_ID_PCM_S64LE = 0x10800,
499 AV_CODEC_ID_PCM_S64BE,
500 AV_CODEC_ID_PCM_F16LE,
501 AV_CODEC_ID_PCM_F24LE,
502 AV_CODEC_ID_PCM_VIDC,
504 /* various ADPCM codecs */
505 AV_CODEC_ID_ADPCM_IMA_QT = 0x11000,
506 AV_CODEC_ID_ADPCM_IMA_WAV,
507 AV_CODEC_ID_ADPCM_IMA_DK3,
508 AV_CODEC_ID_ADPCM_IMA_DK4,
509 AV_CODEC_ID_ADPCM_IMA_WS,
510 AV_CODEC_ID_ADPCM_IMA_SMJPEG,
511 AV_CODEC_ID_ADPCM_MS,
512 AV_CODEC_ID_ADPCM_4XM,
513 AV_CODEC_ID_ADPCM_XA,
514 AV_CODEC_ID_ADPCM_ADX,
515 AV_CODEC_ID_ADPCM_EA,
516 AV_CODEC_ID_ADPCM_G726,
517 AV_CODEC_ID_ADPCM_CT,
518 AV_CODEC_ID_ADPCM_SWF,
519 AV_CODEC_ID_ADPCM_YAMAHA,
520 AV_CODEC_ID_ADPCM_SBPRO_4,
521 AV_CODEC_ID_ADPCM_SBPRO_3,
522 AV_CODEC_ID_ADPCM_SBPRO_2,
523 AV_CODEC_ID_ADPCM_THP,
524 AV_CODEC_ID_ADPCM_IMA_AMV,
525 AV_CODEC_ID_ADPCM_EA_R1,
526 AV_CODEC_ID_ADPCM_EA_R3,
527 AV_CODEC_ID_ADPCM_EA_R2,
528 AV_CODEC_ID_ADPCM_IMA_EA_SEAD,
529 AV_CODEC_ID_ADPCM_IMA_EA_EACS,
530 AV_CODEC_ID_ADPCM_EA_XAS,
531 AV_CODEC_ID_ADPCM_EA_MAXIS_XA,
532 AV_CODEC_ID_ADPCM_IMA_ISS,
533 AV_CODEC_ID_ADPCM_G722,
534 AV_CODEC_ID_ADPCM_IMA_APC,
535 AV_CODEC_ID_ADPCM_VIMA,
537 AV_CODEC_ID_ADPCM_AFC = 0x11800,
538 AV_CODEC_ID_ADPCM_IMA_OKI,
539 AV_CODEC_ID_ADPCM_DTK,
540 AV_CODEC_ID_ADPCM_IMA_RAD,
541 AV_CODEC_ID_ADPCM_G726LE,
542 AV_CODEC_ID_ADPCM_THP_LE,
543 AV_CODEC_ID_ADPCM_PSX,
544 AV_CODEC_ID_ADPCM_AICA,
545 AV_CODEC_ID_ADPCM_IMA_DAT4,
546 AV_CODEC_ID_ADPCM_MTAF,
547 AV_CODEC_ID_ADPCM_AGM,
548 AV_CODEC_ID_ADPCM_ARGO,
551 AV_CODEC_ID_AMR_NB = 0x12000,
554 /* RealAudio codecs*/
555 AV_CODEC_ID_RA_144 = 0x13000,
558 /* various DPCM codecs */
559 AV_CODEC_ID_ROQ_DPCM = 0x14000,
560 AV_CODEC_ID_INTERPLAY_DPCM,
561 AV_CODEC_ID_XAN_DPCM,
562 AV_CODEC_ID_SOL_DPCM,
564 AV_CODEC_ID_SDX2_DPCM = 0x14800,
565 AV_CODEC_ID_GREMLIN_DPCM,
568 AV_CODEC_ID_MP2 = 0x15000,
569 AV_CODEC_ID_MP3, ///< preferred ID for decoding MPEG audio layer 1, 2 or 3
579 AV_CODEC_ID_VMDAUDIO,
585 AV_CODEC_ID_WESTWOOD_SND1,
586 AV_CODEC_ID_GSM, ///< as in Berlin toast format
589 AV_CODEC_ID_TRUESPEECH,
591 AV_CODEC_ID_SMACKAUDIO,
594 AV_CODEC_ID_DSICINAUDIO,
596 AV_CODEC_ID_MUSEPACK7,
598 AV_CODEC_ID_GSM_MS, /* as found in WAV */
601 AV_CODEC_ID_NELLYMOSER,
602 AV_CODEC_ID_MUSEPACK8,
604 AV_CODEC_ID_WMAVOICE,
606 AV_CODEC_ID_WMALOSSLESS,
615 AV_CODEC_ID_BINKAUDIO_RDFT,
616 AV_CODEC_ID_BINKAUDIO_DCT,
617 AV_CODEC_ID_AAC_LATM,
622 AV_CODEC_ID_8SVX_EXP,
623 AV_CODEC_ID_8SVX_FIB,
624 AV_CODEC_ID_BMV_AUDIO,
629 AV_CODEC_ID_COMFORT_NOISE,
631 AV_CODEC_ID_METASOUND,
632 AV_CODEC_ID_PAF_AUDIO,
637 AV_CODEC_ID_FFWAVESYNTH = 0x15800,
639 AV_CODEC_ID_SONIC_LS,
642 AV_CODEC_ID_DSD_LSBF,
643 AV_CODEC_ID_DSD_MSBF,
644 AV_CODEC_ID_DSD_LSBF_PLANAR,
645 AV_CODEC_ID_DSD_MSBF_PLANAR,
647 AV_CODEC_ID_INTERPLAY_ACM,
651 AV_CODEC_ID_ATRAC3AL,
652 AV_CODEC_ID_ATRAC3PAL,
659 AV_CODEC_ID_ACELP_KELVIN,
660 AV_CODEC_ID_MPEGH_3D_AUDIO,
662 /* subtitle codecs */
663 AV_CODEC_ID_FIRST_SUBTITLE = 0x17000, ///< A dummy ID pointing at the start of subtitle codecs.
664 AV_CODEC_ID_DVD_SUBTITLE = 0x17000,
665 AV_CODEC_ID_DVB_SUBTITLE,
666 AV_CODEC_ID_TEXT, ///< raw UTF-8 text
669 AV_CODEC_ID_MOV_TEXT,
670 AV_CODEC_ID_HDMV_PGS_SUBTITLE,
671 AV_CODEC_ID_DVB_TELETEXT,
674 AV_CODEC_ID_MICRODVD = 0x17800,
678 AV_CODEC_ID_REALTEXT,
680 AV_CODEC_ID_SUBVIEWER1,
681 AV_CODEC_ID_SUBVIEWER,
688 AV_CODEC_ID_HDMV_TEXT_SUBTITLE,
690 AV_CODEC_ID_ARIB_CAPTION,
692 /* other specific kind of codecs (generally used for attachments) */
693 AV_CODEC_ID_FIRST_UNKNOWN = 0x18000, ///< A dummy ID pointing at the start of various fake codecs.
694 AV_CODEC_ID_TTF = 0x18000,
696 AV_CODEC_ID_SCTE_35, ///< Contain timestamp estimated through PCR of program stream.
698 AV_CODEC_ID_BINTEXT = 0x18800,
702 AV_CODEC_ID_SMPTE_KLV,
704 AV_CODEC_ID_TIMED_ID3,
705 AV_CODEC_ID_BIN_DATA,
708 AV_CODEC_ID_PROBE = 0x19000, ///< codec_id is not known (like AV_CODEC_ID_NONE) but lavf should attempt to identify it
710 AV_CODEC_ID_MPEG2TS = 0x20000, /**< _FAKE_ codec to indicate a raw MPEG-2 TS
711 * stream (only used by libavformat) */
712 AV_CODEC_ID_MPEG4SYSTEMS = 0x20001, /**< _FAKE_ codec to indicate a MPEG-4 Systems
713 * stream (only used by libavformat) */
714 AV_CODEC_ID_FFMETADATA = 0x21000, ///< Dummy codec for streams containing only metadata information.
715 AV_CODEC_ID_WRAPPED_AVFRAME = 0x21001, ///< Passthrough codec, AVFrames wrapped in AVPacket
719 * This struct describes the properties of a single codec described by an
721 * @see avcodec_descriptor_get()
723 typedef struct AVCodecDescriptor {
725 enum AVMediaType type;
727 * Name of the codec described by this descriptor. It is non-empty and
728 * unique for each codec descriptor. It should contain alphanumeric
729 * characters and '_' only.
733 * A more descriptive name for this codec. May be NULL.
735 const char *long_name;
737 * Codec properties, a combination of AV_CODEC_PROP_* flags.
741 * MIME type(s) associated with the codec.
742 * May be NULL; if not, a NULL-terminated array of MIME types.
743 * The first item is always non-NULL and is the preferred MIME type.
745 const char *const *mime_types;
747 * If non-NULL, an array of profiles recognized for this codec.
748 * Terminated with FF_PROFILE_UNKNOWN.
750 const struct AVProfile *profiles;
754 * Codec uses only intra compression.
755 * Video and audio codecs only.
757 #define AV_CODEC_PROP_INTRA_ONLY (1 << 0)
759 * Codec supports lossy compression. Audio and video codecs only.
760 * @note a codec may support both lossy and lossless
763 #define AV_CODEC_PROP_LOSSY (1 << 1)
765 * Codec supports lossless compression. Audio and video codecs only.
767 #define AV_CODEC_PROP_LOSSLESS (1 << 2)
769 * Codec supports frame reordering. That is, the coded order (the order in which
770 * the encoded packets are output by the encoders / stored / input to the
771 * decoders) may be different from the presentation order of the corresponding
774 * For codecs that do not have this property set, PTS and DTS should always be
777 #define AV_CODEC_PROP_REORDER (1 << 3)
779 * Subtitle codec is bitmap based
780 * Decoded AVSubtitle data can be read from the AVSubtitleRect->pict field.
782 #define AV_CODEC_PROP_BITMAP_SUB (1 << 16)
784 * Subtitle codec is text based.
785 * Decoded AVSubtitle data can be read from the AVSubtitleRect->ass field.
787 #define AV_CODEC_PROP_TEXT_SUB (1 << 17)
790 * @ingroup lavc_decoding
791 * Required number of additionally allocated bytes at the end of the input bitstream for decoding.
792 * This is mainly needed because some optimized bitstream readers read
793 * 32 or 64 bit at once and could read over the end.<br>
794 * Note: If the first 23 bits of the additional bytes are not 0, then damaged
795 * MPEG bitstreams could cause overread and segfault.
797 #define AV_INPUT_BUFFER_PADDING_SIZE 64
800 * @ingroup lavc_encoding
801 * minimum encoding buffer size
802 * Used to avoid some checks during header writing.
804 #define AV_INPUT_BUFFER_MIN_SIZE 16384
807 * @ingroup lavc_decoding
810 /* We leave some space between them for extensions (drop some
811 * keyframes for intra-only or drop just some bidir frames). */
812 AVDISCARD_NONE =-16, ///< discard nothing
813 AVDISCARD_DEFAULT = 0, ///< discard useless packets like 0 size packets in avi
814 AVDISCARD_NONREF = 8, ///< discard all non reference
815 AVDISCARD_BIDIR = 16, ///< discard all bidirectional frames
816 AVDISCARD_NONINTRA= 24, ///< discard all non intra frames
817 AVDISCARD_NONKEY = 32, ///< discard all frames except keyframes
818 AVDISCARD_ALL = 48, ///< discard all
821 enum AVAudioServiceType {
822 AV_AUDIO_SERVICE_TYPE_MAIN = 0,
823 AV_AUDIO_SERVICE_TYPE_EFFECTS = 1,
824 AV_AUDIO_SERVICE_TYPE_VISUALLY_IMPAIRED = 2,
825 AV_AUDIO_SERVICE_TYPE_HEARING_IMPAIRED = 3,
826 AV_AUDIO_SERVICE_TYPE_DIALOGUE = 4,
827 AV_AUDIO_SERVICE_TYPE_COMMENTARY = 5,
828 AV_AUDIO_SERVICE_TYPE_EMERGENCY = 6,
829 AV_AUDIO_SERVICE_TYPE_VOICE_OVER = 7,
830 AV_AUDIO_SERVICE_TYPE_KARAOKE = 8,
831 AV_AUDIO_SERVICE_TYPE_NB , ///< Not part of ABI
835 * @ingroup lavc_encoding
837 typedef struct RcOverride{
840 int qscale; // If this is 0 then quality_factor will be used instead.
841 float quality_factor;
845 These flags can be passed in AVCodecContext.flags before initialization.
846 Note: Not everything is supported yet.
850 * Allow decoders to produce frames with data planes that are not aligned
851 * to CPU requirements (e.g. due to cropping).
853 #define AV_CODEC_FLAG_UNALIGNED (1 << 0)
857 #define AV_CODEC_FLAG_QSCALE (1 << 1)
859 * 4 MV per MB allowed / advanced prediction for H.263.
861 #define AV_CODEC_FLAG_4MV (1 << 2)
863 * Output even those frames that might be corrupted.
865 #define AV_CODEC_FLAG_OUTPUT_CORRUPT (1 << 3)
869 #define AV_CODEC_FLAG_QPEL (1 << 4)
871 * Don't output frames whose parameters differ from first
872 * decoded frame in stream.
874 #define AV_CODEC_FLAG_DROPCHANGED (1 << 5)
876 * Use internal 2pass ratecontrol in first pass mode.
878 #define AV_CODEC_FLAG_PASS1 (1 << 9)
880 * Use internal 2pass ratecontrol in second pass mode.
882 #define AV_CODEC_FLAG_PASS2 (1 << 10)
886 #define AV_CODEC_FLAG_LOOP_FILTER (1 << 11)
888 * Only decode/encode grayscale.
890 #define AV_CODEC_FLAG_GRAY (1 << 13)
892 * error[?] variables will be set during encoding.
894 #define AV_CODEC_FLAG_PSNR (1 << 15)
896 * Input bitstream might be truncated at a random location
897 * instead of only at frame boundaries.
899 #define AV_CODEC_FLAG_TRUNCATED (1 << 16)
901 * Use interlaced DCT.
903 #define AV_CODEC_FLAG_INTERLACED_DCT (1 << 18)
907 #define AV_CODEC_FLAG_LOW_DELAY (1 << 19)
909 * Place global headers in extradata instead of every keyframe.
911 #define AV_CODEC_FLAG_GLOBAL_HEADER (1 << 22)
913 * Use only bitexact stuff (except (I)DCT).
915 #define AV_CODEC_FLAG_BITEXACT (1 << 23)
916 /* Fx : Flag for H.263+ extra options */
918 * H.263 advanced intra coding / MPEG-4 AC prediction
920 #define AV_CODEC_FLAG_AC_PRED (1 << 24)
922 * interlaced motion estimation
924 #define AV_CODEC_FLAG_INTERLACED_ME (1 << 29)
925 #define AV_CODEC_FLAG_CLOSED_GOP (1U << 31)
928 * Allow non spec compliant speedup tricks.
930 #define AV_CODEC_FLAG2_FAST (1 << 0)
932 * Skip bitstream encoding.
934 #define AV_CODEC_FLAG2_NO_OUTPUT (1 << 2)
936 * Place global headers at every keyframe instead of in extradata.
938 #define AV_CODEC_FLAG2_LOCAL_HEADER (1 << 3)
941 * timecode is in drop frame format. DEPRECATED!!!!
943 #define AV_CODEC_FLAG2_DROP_FRAME_TIMECODE (1 << 13)
946 * Input bitstream might be truncated at a packet boundaries
947 * instead of only at frame boundaries.
949 #define AV_CODEC_FLAG2_CHUNKS (1 << 15)
951 * Discard cropping information from SPS.
953 #define AV_CODEC_FLAG2_IGNORE_CROP (1 << 16)
956 * Show all frames before the first keyframe
958 #define AV_CODEC_FLAG2_SHOW_ALL (1 << 22)
960 * Export motion vectors through frame side data
962 #define AV_CODEC_FLAG2_EXPORT_MVS (1 << 28)
964 * Do not skip samples and export skip information as frame side data
966 #define AV_CODEC_FLAG2_SKIP_MANUAL (1 << 29)
968 * Do not reset ASS ReadOrder field on flush (subtitles decoding)
970 #define AV_CODEC_FLAG2_RO_FLUSH_NOOP (1 << 30)
972 /* Unsupported options :
973 * Syntax Arithmetic coding (SAC)
974 * Reference Picture Selection
975 * Independent Segment Decoding */
977 /* codec capabilities */
980 * Decoder can use draw_horiz_band callback.
982 #define AV_CODEC_CAP_DRAW_HORIZ_BAND (1 << 0)
984 * Codec uses get_buffer() for allocating buffers and supports custom allocators.
985 * If not set, it might not use get_buffer() at all or use operations that
986 * assume the buffer was allocated by avcodec_default_get_buffer.
988 #define AV_CODEC_CAP_DR1 (1 << 1)
989 #define AV_CODEC_CAP_TRUNCATED (1 << 3)
991 * Encoder or decoder requires flushing with NULL input at the end in order to
992 * give the complete and correct output.
994 * NOTE: If this flag is not set, the codec is guaranteed to never be fed with
995 * with NULL data. The user can still send NULL data to the public encode
996 * or decode function, but libavcodec will not pass it along to the codec
997 * unless this flag is set.
1000 * The decoder has a non-zero delay and needs to be fed with avpkt->data=NULL,
1001 * avpkt->size=0 at the end to get the delayed data until the decoder no longer
1005 * The encoder needs to be fed with NULL data at the end of encoding until the
1006 * encoder no longer returns data.
1008 * NOTE: For encoders implementing the AVCodec.encode2() function, setting this
1009 * flag also means that the encoder must set the pts and duration for
1010 * each output packet. If this flag is not set, the pts and duration will
1011 * be determined by libavcodec from the input frame.
1013 #define AV_CODEC_CAP_DELAY (1 << 5)
1015 * Codec can be fed a final frame with a smaller size.
1016 * This can be used to prevent truncation of the last audio samples.
1018 #define AV_CODEC_CAP_SMALL_LAST_FRAME (1 << 6)
1021 * Codec can output multiple frames per AVPacket
1022 * Normally demuxers return one frame at a time, demuxers which do not do
1023 * are connected to a parser to split what they return into proper frames.
1024 * This flag is reserved to the very rare category of codecs which have a
1025 * bitstream that cannot be split into frames without timeconsuming
1026 * operations like full decoding. Demuxers carrying such bitstreams thus
1027 * may return multiple frames in a packet. This has many disadvantages like
1028 * prohibiting stream copy in many cases thus it should only be considered
1031 #define AV_CODEC_CAP_SUBFRAMES (1 << 8)
1033 * Codec is experimental and is thus avoided in favor of non experimental
1036 #define AV_CODEC_CAP_EXPERIMENTAL (1 << 9)
1038 * Codec should fill in channel configuration and samplerate instead of container
1040 #define AV_CODEC_CAP_CHANNEL_CONF (1 << 10)
1042 * Codec supports frame-level multithreading.
1044 #define AV_CODEC_CAP_FRAME_THREADS (1 << 12)
1046 * Codec supports slice-based (or partition-based) multithreading.
1048 #define AV_CODEC_CAP_SLICE_THREADS (1 << 13)
1050 * Codec supports changed parameters at any point.
1052 #define AV_CODEC_CAP_PARAM_CHANGE (1 << 14)
1054 * Codec supports avctx->thread_count == 0 (auto).
1056 #define AV_CODEC_CAP_AUTO_THREADS (1 << 15)
1058 * Audio encoder supports receiving a different number of samples in each call.
1060 #define AV_CODEC_CAP_VARIABLE_FRAME_SIZE (1 << 16)
1062 * Decoder is not a preferred choice for probing.
1063 * This indicates that the decoder is not a good choice for probing.
1064 * It could for example be an expensive to spin up hardware decoder,
1065 * or it could simply not provide a lot of useful information about
1067 * A decoder marked with this flag should only be used as last resort
1068 * choice for probing.
1070 #define AV_CODEC_CAP_AVOID_PROBING (1 << 17)
1072 * Codec is intra only.
1074 #define AV_CODEC_CAP_INTRA_ONLY 0x40000000
1076 * Codec is lossless.
1078 #define AV_CODEC_CAP_LOSSLESS 0x80000000
1081 * Codec is backed by a hardware implementation. Typically used to
1082 * identify a non-hwaccel hardware decoder. For information about hwaccels, use
1083 * avcodec_get_hw_config() instead.
1085 #define AV_CODEC_CAP_HARDWARE (1 << 18)
1088 * Codec is potentially backed by a hardware implementation, but not
1089 * necessarily. This is used instead of AV_CODEC_CAP_HARDWARE, if the
1090 * implementation provides some sort of internal fallback.
1092 #define AV_CODEC_CAP_HYBRID (1 << 19)
1095 * This codec takes the reordered_opaque field from input AVFrames
1096 * and returns it in the corresponding field in AVCodecContext after
1099 #define AV_CODEC_CAP_ENCODER_REORDERED_OPAQUE (1 << 20)
1103 * This specifies the area which should be displayed.
1104 * Note there may be multiple such areas for one frame.
1106 typedef struct AVPanScan {
1109 * - encoding: Set by user.
1110 * - decoding: Set by libavcodec.
1115 * width and height in 1/16 pel
1116 * - encoding: Set by user.
1117 * - decoding: Set by libavcodec.
1123 * position of the top left corner in 1/16 pel for up to 3 fields/frames
1124 * - encoding: Set by user.
1125 * - decoding: Set by libavcodec.
1127 int16_t position[3][2];
1131 * This structure describes the bitrate properties of an encoded bitstream. It
1132 * roughly corresponds to a subset the VBV parameters for MPEG-2 or HRD
1133 * parameters for H.264/HEVC.
1135 typedef struct AVCPBProperties {
1137 * Maximum bitrate of the stream, in bits per second.
1138 * Zero if unknown or unspecified.
1140 #if FF_API_UNSANITIZED_BITRATES
1143 int64_t max_bitrate;
1146 * Minimum bitrate of the stream, in bits per second.
1147 * Zero if unknown or unspecified.
1149 #if FF_API_UNSANITIZED_BITRATES
1152 int64_t min_bitrate;
1155 * Average bitrate of the stream, in bits per second.
1156 * Zero if unknown or unspecified.
1158 #if FF_API_UNSANITIZED_BITRATES
1161 int64_t avg_bitrate;
1165 * The size of the buffer to which the ratecontrol is applied, in bits.
1166 * Zero if unknown or unspecified.
1171 * The delay between the time the packet this structure is associated with
1172 * is received and the time when it should be decoded, in periods of a 27MHz
1175 * UINT64_MAX when unknown or unspecified.
1180 typedef struct AVProducerReferenceTime {
1183 } AVProducerReferenceTime;
1186 * The decoder will keep a reference to the frame and may reuse it later.
1188 #define AV_GET_BUFFER_FLAG_REF (1 << 0)
1191 * @defgroup lavc_packet AVPacket
1193 * Types and functions for working with AVPacket.
1196 enum AVPacketSideDataType {
1198 * An AV_PKT_DATA_PALETTE side data packet contains exactly AVPALETTE_SIZE
1199 * bytes worth of palette. This side data signals that a new palette is
1202 AV_PKT_DATA_PALETTE,
1205 * The AV_PKT_DATA_NEW_EXTRADATA is used to notify the codec or the format
1206 * that the extradata buffer was changed and the receiving side should
1207 * act upon it appropriately. The new extradata is embedded in the side
1208 * data buffer and should be immediately used for processing the current
1211 AV_PKT_DATA_NEW_EXTRADATA,
1214 * An AV_PKT_DATA_PARAM_CHANGE side data packet is laid out as follows:
1217 * if (param_flags & AV_SIDE_DATA_PARAM_CHANGE_CHANNEL_COUNT)
1218 * s32le channel_count
1219 * if (param_flags & AV_SIDE_DATA_PARAM_CHANGE_CHANNEL_LAYOUT)
1220 * u64le channel_layout
1221 * if (param_flags & AV_SIDE_DATA_PARAM_CHANGE_SAMPLE_RATE)
1223 * if (param_flags & AV_SIDE_DATA_PARAM_CHANGE_DIMENSIONS)
1228 AV_PKT_DATA_PARAM_CHANGE,
1231 * An AV_PKT_DATA_H263_MB_INFO side data packet contains a number of
1232 * structures with info about macroblocks relevant to splitting the
1233 * packet into smaller packets on macroblock edges (e.g. as for RFC 2190).
1234 * That is, it does not necessarily contain info about all macroblocks,
1235 * as long as the distance between macroblocks in the info is smaller
1236 * than the target payload size.
1237 * Each MB info structure is 12 bytes, and is laid out as follows:
1239 * u32le bit offset from the start of the packet
1240 * u8 current quantizer at the start of the macroblock
1242 * u16le macroblock address within the GOB
1243 * u8 horizontal MV predictor
1244 * u8 vertical MV predictor
1245 * u8 horizontal MV predictor for block number 3
1246 * u8 vertical MV predictor for block number 3
1249 AV_PKT_DATA_H263_MB_INFO,
1252 * This side data should be associated with an audio stream and contains
1253 * ReplayGain information in form of the AVReplayGain struct.
1255 AV_PKT_DATA_REPLAYGAIN,
1258 * This side data contains a 3x3 transformation matrix describing an affine
1259 * transformation that needs to be applied to the decoded video frames for
1260 * correct presentation.
1262 * See libavutil/display.h for a detailed description of the data.
1264 AV_PKT_DATA_DISPLAYMATRIX,
1267 * This side data should be associated with a video stream and contains
1268 * Stereoscopic 3D information in form of the AVStereo3D struct.
1270 AV_PKT_DATA_STEREO3D,
1273 * This side data should be associated with an audio stream and corresponds
1274 * to enum AVAudioServiceType.
1276 AV_PKT_DATA_AUDIO_SERVICE_TYPE,
1279 * This side data contains quality related information from the encoder.
1281 * u32le quality factor of the compressed frame. Allowed range is between 1 (good) and FF_LAMBDA_MAX (bad).
1285 * u64le[error count] sum of squared differences between encoder in and output
1288 AV_PKT_DATA_QUALITY_STATS,
1291 * This side data contains an integer value representing the stream index
1292 * of a "fallback" track. A fallback track indicates an alternate
1293 * track to use when the current track can not be decoded for some reason.
1294 * e.g. no decoder available for codec.
1296 AV_PKT_DATA_FALLBACK_TRACK,
1299 * This side data corresponds to the AVCPBProperties struct.
1301 AV_PKT_DATA_CPB_PROPERTIES,
1304 * Recommmends skipping the specified number of samples
1306 * u32le number of samples to skip from start of this packet
1307 * u32le number of samples to skip from end of this packet
1308 * u8 reason for start skip
1309 * u8 reason for end skip (0=padding silence, 1=convergence)
1312 AV_PKT_DATA_SKIP_SAMPLES,
1315 * An AV_PKT_DATA_JP_DUALMONO side data packet indicates that
1316 * the packet may contain "dual mono" audio specific to Japanese DTV
1317 * and if it is true, recommends only the selected channel to be used.
1319 * u8 selected channels (0=mail/left, 1=sub/right, 2=both)
1322 AV_PKT_DATA_JP_DUALMONO,
1325 * A list of zero terminated key/value strings. There is no end marker for
1326 * the list, so it is required to rely on the side data size to stop.
1328 AV_PKT_DATA_STRINGS_METADATA,
1331 * Subtitle event position
1339 AV_PKT_DATA_SUBTITLE_POSITION,
1342 * Data found in BlockAdditional element of matroska container. There is
1343 * no end marker for the data, so it is required to rely on the side data
1344 * size to recognize the end. 8 byte id (as found in BlockAddId) followed
1347 AV_PKT_DATA_MATROSKA_BLOCKADDITIONAL,
1350 * The optional first identifier line of a WebVTT cue.
1352 AV_PKT_DATA_WEBVTT_IDENTIFIER,
1355 * The optional settings (rendering instructions) that immediately
1356 * follow the timestamp specifier of a WebVTT cue.
1358 AV_PKT_DATA_WEBVTT_SETTINGS,
1361 * A list of zero terminated key/value strings. There is no end marker for
1362 * the list, so it is required to rely on the side data size to stop. This
1363 * side data includes updated metadata which appeared in the stream.
1365 AV_PKT_DATA_METADATA_UPDATE,
1368 * MPEGTS stream ID as uint8_t, this is required to pass the stream ID
1369 * information from the demuxer to the corresponding muxer.
1371 AV_PKT_DATA_MPEGTS_STREAM_ID,
1374 * Mastering display metadata (based on SMPTE-2086:2014). This metadata
1375 * should be associated with a video stream and contains data in the form
1376 * of the AVMasteringDisplayMetadata struct.
1378 AV_PKT_DATA_MASTERING_DISPLAY_METADATA,
1381 * This side data should be associated with a video stream and corresponds
1382 * to the AVSphericalMapping structure.
1384 AV_PKT_DATA_SPHERICAL,
1387 * Content light level (based on CTA-861.3). This metadata should be
1388 * associated with a video stream and contains data in the form of the
1389 * AVContentLightMetadata struct.
1391 AV_PKT_DATA_CONTENT_LIGHT_LEVEL,
1394 * ATSC A53 Part 4 Closed Captions. This metadata should be associated with
1395 * a video stream. A53 CC bitstream is stored as uint8_t in AVPacketSideData.data.
1396 * The number of bytes of CC data is AVPacketSideData.size.
1401 * This side data is encryption initialization data.
1402 * The format is not part of ABI, use av_encryption_init_info_* methods to
1405 AV_PKT_DATA_ENCRYPTION_INIT_INFO,
1408 * This side data contains encryption info for how to decrypt the packet.
1409 * The format is not part of ABI, use av_encryption_info_* methods to access.
1411 AV_PKT_DATA_ENCRYPTION_INFO,
1414 * Active Format Description data consisting of a single byte as specified
1415 * in ETSI TS 101 154 using AVActiveFormatDescription enum.
1420 * Producer Reference Time data corresponding to the AVProducerReferenceTime struct.
1425 * The number of side data types.
1426 * This is not part of the public API/ABI in the sense that it may
1427 * change when new side data types are added.
1428 * This must stay the last enum value.
1429 * If its value becomes huge, some code using it
1430 * needs to be updated as it assumes it to be smaller than other limits.
1435 #define AV_PKT_DATA_QUALITY_FACTOR AV_PKT_DATA_QUALITY_STATS //DEPRECATED
1437 typedef struct AVPacketSideData {
1440 enum AVPacketSideDataType type;
1444 * This structure stores compressed data. It is typically exported by demuxers
1445 * and then passed as input to decoders, or received as output from encoders and
1446 * then passed to muxers.
1448 * For video, it should typically contain one compressed frame. For audio it may
1449 * contain several compressed frames. Encoders are allowed to output empty
1450 * packets, with no compressed data, containing only side data
1451 * (e.g. to update some stream parameters at the end of encoding).
1453 * AVPacket is one of the few structs in FFmpeg, whose size is a part of public
1454 * ABI. Thus it may be allocated on stack and no new fields can be added to it
1455 * without libavcodec and libavformat major bump.
1457 * The semantics of data ownership depends on the buf field.
1458 * If it is set, the packet data is dynamically allocated and is
1459 * valid indefinitely until a call to av_packet_unref() reduces the
1460 * reference count to 0.
1462 * If the buf field is not set av_packet_ref() would make a copy instead
1463 * of increasing the reference count.
1465 * The side data is always allocated with av_malloc(), copied by
1466 * av_packet_ref() and freed by av_packet_unref().
1468 * @see av_packet_ref
1469 * @see av_packet_unref
1471 typedef struct AVPacket {
1473 * A reference to the reference-counted buffer where the packet data is
1475 * May be NULL, then the packet data is not reference-counted.
1479 * Presentation timestamp in AVStream->time_base units; the time at which
1480 * the decompressed packet will be presented to the user.
1481 * Can be AV_NOPTS_VALUE if it is not stored in the file.
1482 * pts MUST be larger or equal to dts as presentation cannot happen before
1483 * decompression, unless one wants to view hex dumps. Some formats misuse
1484 * the terms dts and pts/cts to mean something different. Such timestamps
1485 * must be converted to true pts/dts before they are stored in AVPacket.
1489 * Decompression timestamp in AVStream->time_base units; the time at which
1490 * the packet is decompressed.
1491 * Can be AV_NOPTS_VALUE if it is not stored in the file.
1498 * A combination of AV_PKT_FLAG values
1502 * Additional packet data that can be provided by the container.
1503 * Packet can contain several types of side information.
1505 AVPacketSideData *side_data;
1506 int side_data_elems;
1509 * Duration of this packet in AVStream->time_base units, 0 if unknown.
1510 * Equals next_pts - this_pts in presentation order.
1514 int64_t pos; ///< byte position in stream, -1 if unknown
1516 #if FF_API_CONVERGENCE_DURATION
1518 * @deprecated Same as the duration field, but as int64_t. This was required
1519 * for Matroska subtitles, whose duration values could overflow when the
1520 * duration field was still an int.
1522 attribute_deprecated
1523 int64_t convergence_duration;
1526 #define AV_PKT_FLAG_KEY 0x0001 ///< The packet contains a keyframe
1527 #define AV_PKT_FLAG_CORRUPT 0x0002 ///< The packet content is corrupted
1529 * Flag is used to discard packets which are required to maintain valid
1530 * decoder state but are not required for output and should be dropped
1533 #define AV_PKT_FLAG_DISCARD 0x0004
1535 * The packet comes from a trusted source.
1537 * Otherwise-unsafe constructs such as arbitrary pointers to data
1538 * outside the packet may be followed.
1540 #define AV_PKT_FLAG_TRUSTED 0x0008
1542 * Flag is used to indicate packets that contain frames that can
1543 * be discarded by the decoder. I.e. Non-reference frames.
1545 #define AV_PKT_FLAG_DISPOSABLE 0x0010
1548 enum AVSideDataParamChangeFlags {
1549 AV_SIDE_DATA_PARAM_CHANGE_CHANNEL_COUNT = 0x0001,
1550 AV_SIDE_DATA_PARAM_CHANGE_CHANNEL_LAYOUT = 0x0002,
1551 AV_SIDE_DATA_PARAM_CHANGE_SAMPLE_RATE = 0x0004,
1552 AV_SIDE_DATA_PARAM_CHANGE_DIMENSIONS = 0x0008,
1558 struct AVCodecInternal;
1562 AV_FIELD_PROGRESSIVE,
1563 AV_FIELD_TT, //< Top coded_first, top displayed first
1564 AV_FIELD_BB, //< Bottom coded first, bottom displayed first
1565 AV_FIELD_TB, //< Top coded first, bottom displayed first
1566 AV_FIELD_BT, //< Bottom coded first, top displayed first
1570 * main external API structure.
1571 * New fields can be added to the end with minor version bumps.
1572 * Removal, reordering and changes to existing fields require a major
1574 * You can use AVOptions (av_opt* / av_set/get*()) to access these fields from user
1576 * The name string for AVOptions options matches the associated command line
1577 * parameter name and can be found in libavcodec/options_table.h
1578 * The AVOption/command line parameter names differ in some cases from the C
1579 * structure field names for historic reasons or brevity.
1580 * sizeof(AVCodecContext) must not be used outside libav*.
1582 typedef struct AVCodecContext {
1584 * information on struct for av_log
1585 * - set by avcodec_alloc_context3
1587 const AVClass *av_class;
1588 int log_level_offset;
1590 enum AVMediaType codec_type; /* see AVMEDIA_TYPE_xxx */
1591 const struct AVCodec *codec;
1592 enum AVCodecID codec_id; /* see AV_CODEC_ID_xxx */
1595 * fourcc (LSB first, so "ABCD" -> ('D'<<24) + ('C'<<16) + ('B'<<8) + 'A').
1596 * This is used to work around some encoder bugs.
1597 * A demuxer should set this to what is stored in the field used to identify the codec.
1598 * If there are multiple such fields in a container then the demuxer should choose the one
1599 * which maximizes the information about the used codec.
1600 * If the codec tag field in a container is larger than 32 bits then the demuxer should
1601 * remap the longer ID to 32 bits with a table or other structure. Alternatively a new
1602 * extra_codec_tag + size could be added but for this a clear advantage must be demonstrated
1604 * - encoding: Set by user, if not then the default based on codec_id will be used.
1605 * - decoding: Set by user, will be converted to uppercase by libavcodec during init.
1607 unsigned int codec_tag;
1612 * Private context used for internal data.
1614 * Unlike priv_data, this is not codec-specific. It is used in general
1615 * libavcodec functions.
1617 struct AVCodecInternal *internal;
1620 * Private data of the user, can be used to carry app specific stuff.
1621 * - encoding: Set by user.
1622 * - decoding: Set by user.
1627 * the average bitrate
1628 * - encoding: Set by user; unused for constant quantizer encoding.
1629 * - decoding: Set by user, may be overwritten by libavcodec
1630 * if this info is available in the stream
1635 * number of bits the bitstream is allowed to diverge from the reference.
1636 * the reference can be CBR (for CBR pass1) or VBR (for pass2)
1637 * - encoding: Set by user; unused for constant quantizer encoding.
1638 * - decoding: unused
1640 int bit_rate_tolerance;
1643 * Global quality for codecs which cannot change it per frame.
1644 * This should be proportional to MPEG-1/2/4 qscale.
1645 * - encoding: Set by user.
1646 * - decoding: unused
1651 * - encoding: Set by user.
1652 * - decoding: unused
1654 int compression_level;
1655 #define FF_COMPRESSION_DEFAULT -1
1659 * - encoding: Set by user.
1660 * - decoding: Set by user.
1666 * - encoding: Set by user.
1667 * - decoding: Set by user.
1672 * some codecs need / can use extradata like Huffman tables.
1673 * MJPEG: Huffman tables
1674 * rv10: additional flags
1675 * MPEG-4: global headers (they can be in the bitstream or here)
1676 * The allocated memory should be AV_INPUT_BUFFER_PADDING_SIZE bytes larger
1677 * than extradata_size to avoid problems if it is read with the bitstream reader.
1678 * The bytewise contents of extradata must not depend on the architecture or CPU endianness.
1679 * Must be allocated with the av_malloc() family of functions.
1680 * - encoding: Set/allocated/freed by libavcodec.
1681 * - decoding: Set/allocated/freed by user.
1687 * This is the fundamental unit of time (in seconds) in terms
1688 * of which frame timestamps are represented. For fixed-fps content,
1689 * timebase should be 1/framerate and timestamp increments should be
1691 * This often, but not always is the inverse of the frame rate or field rate
1692 * for video. 1/time_base is not the average frame rate if the frame rate is not
1695 * Like containers, elementary streams also can store timestamps, 1/time_base
1696 * is the unit in which these timestamps are specified.
1697 * As example of such codec time base see ISO/IEC 14496-2:2001(E)
1698 * vop_time_increment_resolution and fixed_vop_rate
1699 * (fixed_vop_rate == 0 implies that it is different from the framerate)
1701 * - encoding: MUST be set by user.
1702 * - decoding: the use of this field for decoding is deprecated.
1703 * Use framerate instead.
1705 AVRational time_base;
1708 * For some codecs, the time base is closer to the field rate than the frame rate.
1709 * Most notably, H.264 and MPEG-2 specify time_base as half of frame duration
1710 * if no telecine is used ...
1712 * Set to time_base ticks per frame. Default 1, e.g., H.264/MPEG-2 set it to 2.
1714 int ticks_per_frame;
1719 * Encoding: Number of frames delay there will be from the encoder input to
1720 * the decoder output. (we assume the decoder matches the spec)
1721 * Decoding: Number of frames delay in addition to what a standard decoder
1722 * as specified in the spec would produce.
1725 * Number of frames the decoded output will be delayed relative to the
1729 * For encoding, this field is unused (see initial_padding).
1731 * For decoding, this is the number of samples the decoder needs to
1732 * output before the decoder's output is valid. When seeking, you should
1733 * start decoding this many samples prior to your desired seek point.
1735 * - encoding: Set by libavcodec.
1736 * - decoding: Set by libavcodec.
1743 * picture width / height.
1745 * @note Those fields may not match the values of the last
1746 * AVFrame output by avcodec_decode_video2 due frame
1749 * - encoding: MUST be set by user.
1750 * - decoding: May be set by the user before opening the decoder if known e.g.
1751 * from the container. Some decoders will require the dimensions
1752 * to be set by the caller. During decoding, the decoder may
1753 * overwrite those values as required while parsing the data.
1758 * Bitstream width / height, may be different from width/height e.g. when
1759 * the decoded frame is cropped before being output or lowres is enabled.
1761 * @note Those field may not match the value of the last
1762 * AVFrame output by avcodec_receive_frame() due frame
1765 * - encoding: unused
1766 * - decoding: May be set by the user before opening the decoder if known
1767 * e.g. from the container. During decoding, the decoder may
1768 * overwrite those values as required while parsing the data.
1770 int coded_width, coded_height;
1773 * the number of pictures in a group of pictures, or 0 for intra_only
1774 * - encoding: Set by user.
1775 * - decoding: unused
1780 * Pixel format, see AV_PIX_FMT_xxx.
1781 * May be set by the demuxer if known from headers.
1782 * May be overridden by the decoder if it knows better.
1784 * @note This field may not match the value of the last
1785 * AVFrame output by avcodec_receive_frame() due frame
1788 * - encoding: Set by user.
1789 * - decoding: Set by user if known, overridden by libavcodec while
1792 enum AVPixelFormat pix_fmt;
1795 * If non NULL, 'draw_horiz_band' is called by the libavcodec
1796 * decoder to draw a horizontal band. It improves cache usage. Not
1797 * all codecs can do that. You must check the codec capabilities
1799 * When multithreading is used, it may be called from multiple threads
1800 * at the same time; threads might draw different parts of the same AVFrame,
1801 * or multiple AVFrames, and there is no guarantee that slices will be drawn
1803 * The function is also used by hardware acceleration APIs.
1804 * It is called at least once during frame decoding to pass
1805 * the data needed for hardware render.
1806 * In that mode instead of pixel data, AVFrame points to
1807 * a structure specific to the acceleration API. The application
1808 * reads the structure and can change some fields to indicate progress
1810 * - encoding: unused
1811 * - decoding: Set by user.
1812 * @param height the height of the slice
1813 * @param y the y position of the slice
1814 * @param type 1->top field, 2->bottom field, 3->frame
1815 * @param offset offset into the AVFrame.data from which the slice should be read
1817 void (*draw_horiz_band)(struct AVCodecContext *s,
1818 const AVFrame *src, int offset[AV_NUM_DATA_POINTERS],
1819 int y, int type, int height);
1822 * callback to negotiate the pixelFormat
1823 * @param fmt is the list of formats which are supported by the codec,
1824 * it is terminated by -1 as 0 is a valid format, the formats are ordered by quality.
1825 * The first is always the native one.
1826 * @note The callback may be called again immediately if initialization for
1827 * the selected (hardware-accelerated) pixel format failed.
1828 * @warning Behavior is undefined if the callback returns a value not
1829 * in the fmt list of formats.
1830 * @return the chosen format
1831 * - encoding: unused
1832 * - decoding: Set by user, if not set the native format will be chosen.
1834 enum AVPixelFormat (*get_format)(struct AVCodecContext *s, const enum AVPixelFormat * fmt);
1837 * maximum number of B-frames between non-B-frames
1838 * Note: The output will be delayed by max_b_frames+1 relative to the input.
1839 * - encoding: Set by user.
1840 * - decoding: unused
1845 * qscale factor between IP and B-frames
1846 * If > 0 then the last P-frame quantizer will be used (q= lastp_q*factor+offset).
1847 * If < 0 then normal ratecontrol will be done (q= -normal_q*factor+offset).
1848 * - encoding: Set by user.
1849 * - decoding: unused
1851 float b_quant_factor;
1853 #if FF_API_PRIVATE_OPT
1854 /** @deprecated use encoder private options instead */
1855 attribute_deprecated
1856 int b_frame_strategy;
1860 * qscale offset between IP and B-frames
1861 * - encoding: Set by user.
1862 * - decoding: unused
1864 float b_quant_offset;
1867 * Size of the frame reordering buffer in the decoder.
1868 * For MPEG-2 it is 1 IPB or 0 low delay IP.
1869 * - encoding: Set by libavcodec.
1870 * - decoding: Set by libavcodec.
1874 #if FF_API_PRIVATE_OPT
1875 /** @deprecated use encoder private options instead */
1876 attribute_deprecated
1881 * qscale factor between P- and I-frames
1882 * If > 0 then the last P-frame quantizer will be used (q = lastp_q * factor + offset).
1883 * If < 0 then normal ratecontrol will be done (q= -normal_q*factor+offset).
1884 * - encoding: Set by user.
1885 * - decoding: unused
1887 float i_quant_factor;
1890 * qscale offset between P and I-frames
1891 * - encoding: Set by user.
1892 * - decoding: unused
1894 float i_quant_offset;
1897 * luminance masking (0-> disabled)
1898 * - encoding: Set by user.
1899 * - decoding: unused
1904 * temporary complexity masking (0-> disabled)
1905 * - encoding: Set by user.
1906 * - decoding: unused
1908 float temporal_cplx_masking;
1911 * spatial complexity masking (0-> disabled)
1912 * - encoding: Set by user.
1913 * - decoding: unused
1915 float spatial_cplx_masking;
1918 * p block masking (0-> disabled)
1919 * - encoding: Set by user.
1920 * - decoding: unused
1925 * darkness masking (0-> disabled)
1926 * - encoding: Set by user.
1927 * - decoding: unused
1933 * - encoding: Set by libavcodec.
1934 * - decoding: Set by user (or 0).
1938 #if FF_API_PRIVATE_OPT
1939 /** @deprecated use encoder private options instead */
1940 attribute_deprecated
1941 int prediction_method;
1942 #define FF_PRED_LEFT 0
1943 #define FF_PRED_PLANE 1
1944 #define FF_PRED_MEDIAN 2
1948 * slice offsets in the frame in bytes
1949 * - encoding: Set/allocated by libavcodec.
1950 * - decoding: Set/allocated by user (or NULL).
1955 * sample aspect ratio (0 if unknown)
1956 * That is the width of a pixel divided by the height of the pixel.
1957 * Numerator and denominator must be relatively prime and smaller than 256 for some video standards.
1958 * - encoding: Set by user.
1959 * - decoding: Set by libavcodec.
1961 AVRational sample_aspect_ratio;
1964 * motion estimation comparison function
1965 * - encoding: Set by user.
1966 * - decoding: unused
1970 * subpixel motion estimation comparison function
1971 * - encoding: Set by user.
1972 * - decoding: unused
1976 * macroblock comparison function (not supported yet)
1977 * - encoding: Set by user.
1978 * - decoding: unused
1982 * interlaced DCT comparison function
1983 * - encoding: Set by user.
1984 * - decoding: unused
1987 #define FF_CMP_SAD 0
1988 #define FF_CMP_SSE 1
1989 #define FF_CMP_SATD 2
1990 #define FF_CMP_DCT 3
1991 #define FF_CMP_PSNR 4
1992 #define FF_CMP_BIT 5
1994 #define FF_CMP_ZERO 7
1995 #define FF_CMP_VSAD 8
1996 #define FF_CMP_VSSE 9
1997 #define FF_CMP_NSSE 10
1998 #define FF_CMP_W53 11
1999 #define FF_CMP_W97 12
2000 #define FF_CMP_DCTMAX 13
2001 #define FF_CMP_DCT264 14
2002 #define FF_CMP_MEDIAN_SAD 15
2003 #define FF_CMP_CHROMA 256
2006 * ME diamond size & shape
2007 * - encoding: Set by user.
2008 * - decoding: unused
2013 * amount of previous MV predictors (2a+1 x 2a+1 square)
2014 * - encoding: Set by user.
2015 * - decoding: unused
2017 int last_predictor_count;
2019 #if FF_API_PRIVATE_OPT
2020 /** @deprecated use encoder private options instead */
2021 attribute_deprecated
2026 * motion estimation prepass comparison function
2027 * - encoding: Set by user.
2028 * - decoding: unused
2033 * ME prepass diamond size & shape
2034 * - encoding: Set by user.
2035 * - decoding: unused
2041 * - encoding: Set by user.
2042 * - decoding: unused
2044 int me_subpel_quality;
2047 * maximum motion estimation search range in subpel units
2048 * If 0 then no limit.
2050 * - encoding: Set by user.
2051 * - decoding: unused
2057 * - encoding: unused
2058 * - decoding: Set by user.
2061 #define SLICE_FLAG_CODED_ORDER 0x0001 ///< draw_horiz_band() is called in coded order instead of display
2062 #define SLICE_FLAG_ALLOW_FIELD 0x0002 ///< allow draw_horiz_band() with field slices (MPEG-2 field pics)
2063 #define SLICE_FLAG_ALLOW_PLANE 0x0004 ///< allow draw_horiz_band() with 1 component at a time (SVQ1)
2066 * macroblock decision mode
2067 * - encoding: Set by user.
2068 * - decoding: unused
2071 #define FF_MB_DECISION_SIMPLE 0 ///< uses mb_cmp
2072 #define FF_MB_DECISION_BITS 1 ///< chooses the one which needs the fewest bits
2073 #define FF_MB_DECISION_RD 2 ///< rate distortion
2076 * custom intra quantization matrix
2077 * Must be allocated with the av_malloc() family of functions, and will be freed in
2078 * avcodec_free_context().
2079 * - encoding: Set/allocated by user, freed by libavcodec. Can be NULL.
2080 * - decoding: Set/allocated/freed by libavcodec.
2082 uint16_t *intra_matrix;
2085 * custom inter quantization matrix
2086 * Must be allocated with the av_malloc() family of functions, and will be freed in
2087 * avcodec_free_context().
2088 * - encoding: Set/allocated by user, freed by libavcodec. Can be NULL.
2089 * - decoding: Set/allocated/freed by libavcodec.
2091 uint16_t *inter_matrix;
2093 #if FF_API_PRIVATE_OPT
2094 /** @deprecated use encoder private options instead */
2095 attribute_deprecated
2096 int scenechange_threshold;
2098 /** @deprecated use encoder private options instead */
2099 attribute_deprecated
2100 int noise_reduction;
2104 * precision of the intra DC coefficient - 8
2105 * - encoding: Set by user.
2106 * - decoding: Set by libavcodec
2108 int intra_dc_precision;
2111 * Number of macroblock rows at the top which are skipped.
2112 * - encoding: unused
2113 * - decoding: Set by user.
2118 * Number of macroblock rows at the bottom which are skipped.
2119 * - encoding: unused
2120 * - decoding: Set by user.
2125 * minimum MB Lagrange multiplier
2126 * - encoding: Set by user.
2127 * - decoding: unused
2132 * maximum MB Lagrange multiplier
2133 * - encoding: Set by user.
2134 * - decoding: unused
2138 #if FF_API_PRIVATE_OPT
2140 * @deprecated use encoder private options instead
2142 attribute_deprecated
2143 int me_penalty_compensation;
2147 * - encoding: Set by user.
2148 * - decoding: unused
2152 #if FF_API_PRIVATE_OPT
2153 /** @deprecated use encoder private options instead */
2154 attribute_deprecated
2160 * - encoding: Set by user.
2161 * - decoding: unused
2166 * number of reference frames
2167 * - encoding: Set by user.
2168 * - decoding: Set by lavc.
2172 #if FF_API_PRIVATE_OPT
2173 /** @deprecated use encoder private options instead */
2174 attribute_deprecated
2179 * Note: Value depends upon the compare function used for fullpel ME.
2180 * - encoding: Set by user.
2181 * - decoding: unused
2185 #if FF_API_PRIVATE_OPT
2186 /** @deprecated use encoder private options instead */
2187 attribute_deprecated
2192 * Chromaticity coordinates of the source primaries.
2193 * - encoding: Set by user
2194 * - decoding: Set by libavcodec
2196 enum AVColorPrimaries color_primaries;
2199 * Color Transfer Characteristic.
2200 * - encoding: Set by user
2201 * - decoding: Set by libavcodec
2203 enum AVColorTransferCharacteristic color_trc;
2206 * YUV colorspace type.
2207 * - encoding: Set by user
2208 * - decoding: Set by libavcodec
2210 enum AVColorSpace colorspace;
2213 * MPEG vs JPEG YUV range.
2214 * - encoding: Set by user
2215 * - decoding: Set by libavcodec
2217 enum AVColorRange color_range;
2220 * This defines the location of chroma samples.
2221 * - encoding: Set by user
2222 * - decoding: Set by libavcodec
2224 enum AVChromaLocation chroma_sample_location;
2228 * Indicates number of picture subdivisions. Used for parallelized
2230 * - encoding: Set by user
2231 * - decoding: unused
2236 * - encoding: set by libavcodec
2237 * - decoding: Set by user.
2239 enum AVFieldOrder field_order;
2242 int sample_rate; ///< samples per second
2243 int channels; ///< number of audio channels
2246 * audio sample format
2247 * - encoding: Set by user.
2248 * - decoding: Set by libavcodec.
2250 enum AVSampleFormat sample_fmt; ///< sample format
2252 /* The following data should not be initialized. */
2254 * Number of samples per channel in an audio frame.
2256 * - encoding: set by libavcodec in avcodec_open2(). Each submitted frame
2257 * except the last must contain exactly frame_size samples per channel.
2258 * May be 0 when the codec has AV_CODEC_CAP_VARIABLE_FRAME_SIZE set, then the
2259 * frame size is not restricted.
2260 * - decoding: may be set by some decoders to indicate constant frame size
2265 * Frame counter, set by libavcodec.
2267 * - decoding: total number of frames returned from the decoder so far.
2268 * - encoding: total number of frames passed to the encoder so far.
2270 * @note the counter is not incremented if encoding/decoding resulted in
2276 * number of bytes per packet if constant and known or 0
2277 * Used by some WAV based audio codecs.
2282 * Audio cutoff bandwidth (0 means "automatic")
2283 * - encoding: Set by user.
2284 * - decoding: unused
2289 * Audio channel layout.
2290 * - encoding: set by user.
2291 * - decoding: set by user, may be overwritten by libavcodec.
2293 uint64_t channel_layout;
2296 * Request decoder to use this channel layout if it can (0 for default)
2297 * - encoding: unused
2298 * - decoding: Set by user.
2300 uint64_t request_channel_layout;
2303 * Type of service that the audio stream conveys.
2304 * - encoding: Set by user.
2305 * - decoding: Set by libavcodec.
2307 enum AVAudioServiceType audio_service_type;
2310 * desired sample format
2311 * - encoding: Not used.
2312 * - decoding: Set by user.
2313 * Decoder will decode to this format if it can.
2315 enum AVSampleFormat request_sample_fmt;
2318 * This callback is called at the beginning of each frame to get data
2319 * buffer(s) for it. There may be one contiguous buffer for all the data or
2320 * there may be a buffer per each data plane or anything in between. What
2321 * this means is, you may set however many entries in buf[] you feel necessary.
2322 * Each buffer must be reference-counted using the AVBuffer API (see description
2325 * The following fields will be set in the frame before this callback is
2328 * - width, height (video only)
2329 * - sample_rate, channel_layout, nb_samples (audio only)
2330 * Their values may differ from the corresponding values in
2331 * AVCodecContext. This callback must use the frame values, not the codec
2332 * context values, to calculate the required buffer size.
2334 * This callback must fill the following fields in the frame:
2338 * * if the data is planar audio with more than 8 channels, then this
2339 * callback must allocate and fill extended_data to contain all pointers
2340 * to all data planes. data[] must hold as many pointers as it can.
2341 * extended_data must be allocated with av_malloc() and will be freed in
2343 * * otherwise extended_data must point to data
2344 * - buf[] must contain one or more pointers to AVBufferRef structures. Each of
2345 * the frame's data and extended_data pointers must be contained in these. That
2346 * is, one AVBufferRef for each allocated chunk of memory, not necessarily one
2347 * AVBufferRef per data[] entry. See: av_buffer_create(), av_buffer_alloc(),
2348 * and av_buffer_ref().
2349 * - extended_buf and nb_extended_buf must be allocated with av_malloc() by
2350 * this callback and filled with the extra buffers if there are more
2351 * buffers than buf[] can hold. extended_buf will be freed in
2354 * If AV_CODEC_CAP_DR1 is not set then get_buffer2() must call
2355 * avcodec_default_get_buffer2() instead of providing buffers allocated by
2358 * Each data plane must be aligned to the maximum required by the target
2361 * @see avcodec_default_get_buffer2()
2365 * If AV_GET_BUFFER_FLAG_REF is set in flags then the frame may be reused
2366 * (read and/or written to if it is writable) later by libavcodec.
2368 * avcodec_align_dimensions2() should be used to find the required width and
2369 * height, as they normally need to be rounded up to the next multiple of 16.
2371 * Some decoders do not support linesizes changing between frames.
2373 * If frame multithreading is used and thread_safe_callbacks is set,
2374 * this callback may be called from a different thread, but not from more
2375 * than one at once. Does not need to be reentrant.
2377 * @see avcodec_align_dimensions2()
2381 * Decoders request a buffer of a particular size by setting
2382 * AVFrame.nb_samples prior to calling get_buffer2(). The decoder may,
2383 * however, utilize only part of the buffer by setting AVFrame.nb_samples
2384 * to a smaller value in the output frame.
2386 * As a convenience, av_samples_get_buffer_size() and
2387 * av_samples_fill_arrays() in libavutil may be used by custom get_buffer2()
2388 * functions to find the required data size and to fill data pointers and
2389 * linesize. In AVFrame.linesize, only linesize[0] may be set for audio
2390 * since all planes must be the same size.
2392 * @see av_samples_get_buffer_size(), av_samples_fill_arrays()
2394 * - encoding: unused
2395 * - decoding: Set by libavcodec, user can override.
2397 int (*get_buffer2)(struct AVCodecContext *s, AVFrame *frame, int flags);
2400 * If non-zero, the decoded audio and video frames returned from
2401 * avcodec_decode_video2() and avcodec_decode_audio4() are reference-counted
2402 * and are valid indefinitely. The caller must free them with
2403 * av_frame_unref() when they are not needed anymore.
2404 * Otherwise, the decoded frames must not be freed by the caller and are
2405 * only valid until the next decode call.
2407 * This is always automatically enabled if avcodec_receive_frame() is used.
2409 * - encoding: unused
2410 * - decoding: set by the caller before avcodec_open2().
2412 attribute_deprecated
2413 int refcounted_frames;
2415 /* - encoding parameters */
2416 float qcompress; ///< amount of qscale change between easy & hard scenes (0.0-1.0)
2417 float qblur; ///< amount of qscale smoothing over time (0.0-1.0)
2421 * - encoding: Set by user.
2422 * - decoding: unused
2428 * - encoding: Set by user.
2429 * - decoding: unused
2434 * maximum quantizer difference between frames
2435 * - encoding: Set by user.
2436 * - decoding: unused
2441 * decoder bitstream buffer size
2442 * - encoding: Set by user.
2443 * - decoding: unused
2448 * ratecontrol override, see RcOverride
2449 * - encoding: Allocated/set/freed by user.
2450 * - decoding: unused
2452 int rc_override_count;
2453 RcOverride *rc_override;
2457 * - encoding: Set by user.
2458 * - decoding: Set by user, may be overwritten by libavcodec.
2460 int64_t rc_max_rate;
2464 * - encoding: Set by user.
2465 * - decoding: unused
2467 int64_t rc_min_rate;
2470 * Ratecontrol attempt to use, at maximum, <value> of what can be used without an underflow.
2471 * - encoding: Set by user.
2472 * - decoding: unused.
2474 float rc_max_available_vbv_use;
2477 * Ratecontrol attempt to use, at least, <value> times the amount needed to prevent a vbv overflow.
2478 * - encoding: Set by user.
2479 * - decoding: unused.
2481 float rc_min_vbv_overflow_use;
2484 * Number of bits which should be loaded into the rc buffer before decoding starts.
2485 * - encoding: Set by user.
2486 * - decoding: unused
2488 int rc_initial_buffer_occupancy;
2490 #if FF_API_CODER_TYPE
2491 #define FF_CODER_TYPE_VLC 0
2492 #define FF_CODER_TYPE_AC 1
2493 #define FF_CODER_TYPE_RAW 2
2494 #define FF_CODER_TYPE_RLE 3
2496 * @deprecated use encoder private options instead
2498 attribute_deprecated
2500 #endif /* FF_API_CODER_TYPE */
2502 #if FF_API_PRIVATE_OPT
2503 /** @deprecated use encoder private options instead */
2504 attribute_deprecated
2508 #if FF_API_PRIVATE_OPT
2509 /** @deprecated use encoder private options instead */
2510 attribute_deprecated
2511 int frame_skip_threshold;
2513 /** @deprecated use encoder private options instead */
2514 attribute_deprecated
2515 int frame_skip_factor;
2517 /** @deprecated use encoder private options instead */
2518 attribute_deprecated
2521 /** @deprecated use encoder private options instead */
2522 attribute_deprecated
2524 #endif /* FF_API_PRIVATE_OPT */
2527 * trellis RD quantization
2528 * - encoding: Set by user.
2529 * - decoding: unused
2533 #if FF_API_PRIVATE_OPT
2534 /** @deprecated use encoder private options instead */
2535 attribute_deprecated
2536 int min_prediction_order;
2538 /** @deprecated use encoder private options instead */
2539 attribute_deprecated
2540 int max_prediction_order;
2542 /** @deprecated use encoder private options instead */
2543 attribute_deprecated
2544 int64_t timecode_frame_start;
2547 #if FF_API_RTP_CALLBACK
2549 * @deprecated unused
2551 /* The RTP callback: This function is called */
2552 /* every time the encoder has a packet to send. */
2553 /* It depends on the encoder if the data starts */
2554 /* with a Start Code (it should). H.263 does. */
2555 /* mb_nb contains the number of macroblocks */
2556 /* encoded in the RTP payload. */
2557 attribute_deprecated
2558 void (*rtp_callback)(struct AVCodecContext *avctx, void *data, int size, int mb_nb);
2561 #if FF_API_PRIVATE_OPT
2562 /** @deprecated use encoder private options instead */
2563 attribute_deprecated
2564 int rtp_payload_size; /* The size of the RTP payload: the coder will */
2565 /* do its best to deliver a chunk with size */
2566 /* below rtp_payload_size, the chunk will start */
2567 /* with a start code on some codecs like H.263. */
2568 /* This doesn't take account of any particular */
2569 /* headers inside the transmitted RTP payload. */
2572 #if FF_API_STAT_BITS
2573 /* statistics, used for 2-pass encoding */
2574 attribute_deprecated
2576 attribute_deprecated
2578 attribute_deprecated
2580 attribute_deprecated
2582 attribute_deprecated
2584 attribute_deprecated
2586 attribute_deprecated
2588 attribute_deprecated
2591 /** @deprecated this field is unused */
2592 attribute_deprecated
2597 * pass1 encoding statistics output buffer
2598 * - encoding: Set by libavcodec.
2599 * - decoding: unused
2604 * pass2 encoding statistics input buffer
2605 * Concatenated stuff from stats_out of pass1 should be placed here.
2606 * - encoding: Allocated/set/freed by user.
2607 * - decoding: unused
2612 * Work around bugs in encoders which sometimes cannot be detected automatically.
2613 * - encoding: Set by user
2614 * - decoding: Set by user
2616 int workaround_bugs;
2617 #define FF_BUG_AUTODETECT 1 ///< autodetection
2618 #define FF_BUG_XVID_ILACE 4
2619 #define FF_BUG_UMP4 8
2620 #define FF_BUG_NO_PADDING 16
2621 #define FF_BUG_AMV 32
2622 #define FF_BUG_QPEL_CHROMA 64
2623 #define FF_BUG_STD_QPEL 128
2624 #define FF_BUG_QPEL_CHROMA2 256
2625 #define FF_BUG_DIRECT_BLOCKSIZE 512
2626 #define FF_BUG_EDGE 1024
2627 #define FF_BUG_HPEL_CHROMA 2048
2628 #define FF_BUG_DC_CLIP 4096
2629 #define FF_BUG_MS 8192 ///< Work around various bugs in Microsoft's broken decoders.
2630 #define FF_BUG_TRUNCATED 16384
2631 #define FF_BUG_IEDGE 32768
2634 * strictly follow the standard (MPEG-4, ...).
2635 * - encoding: Set by user.
2636 * - decoding: Set by user.
2637 * Setting this to STRICT or higher means the encoder and decoder will
2638 * generally do stupid things, whereas setting it to unofficial or lower
2639 * will mean the encoder might produce output that is not supported by all
2640 * spec-compliant decoders. Decoders don't differentiate between normal,
2641 * unofficial and experimental (that is, they always try to decode things
2642 * when they can) unless they are explicitly asked to behave stupidly
2643 * (=strictly conform to the specs)
2645 int strict_std_compliance;
2646 #define FF_COMPLIANCE_VERY_STRICT 2 ///< Strictly conform to an older more strict version of the spec or reference software.
2647 #define FF_COMPLIANCE_STRICT 1 ///< Strictly conform to all the things in the spec no matter what consequences.
2648 #define FF_COMPLIANCE_NORMAL 0
2649 #define FF_COMPLIANCE_UNOFFICIAL -1 ///< Allow unofficial extensions
2650 #define FF_COMPLIANCE_EXPERIMENTAL -2 ///< Allow nonstandardized experimental things.
2653 * error concealment flags
2654 * - encoding: unused
2655 * - decoding: Set by user.
2657 int error_concealment;
2658 #define FF_EC_GUESS_MVS 1
2659 #define FF_EC_DEBLOCK 2
2660 #define FF_EC_FAVOR_INTER 256
2664 * - encoding: Set by user.
2665 * - decoding: Set by user.
2668 #define FF_DEBUG_PICT_INFO 1
2669 #define FF_DEBUG_RC 2
2670 #define FF_DEBUG_BITSTREAM 4
2671 #define FF_DEBUG_MB_TYPE 8
2672 #define FF_DEBUG_QP 16
2675 * @deprecated this option does nothing
2677 #define FF_DEBUG_MV 32
2679 #define FF_DEBUG_DCT_COEFF 0x00000040
2680 #define FF_DEBUG_SKIP 0x00000080
2681 #define FF_DEBUG_STARTCODE 0x00000100
2682 #define FF_DEBUG_ER 0x00000400
2683 #define FF_DEBUG_MMCO 0x00000800
2684 #define FF_DEBUG_BUGS 0x00001000
2686 #define FF_DEBUG_VIS_QP 0x00002000
2687 #define FF_DEBUG_VIS_MB_TYPE 0x00004000
2689 #define FF_DEBUG_BUFFERS 0x00008000
2690 #define FF_DEBUG_THREADS 0x00010000
2691 #define FF_DEBUG_GREEN_MD 0x00800000
2692 #define FF_DEBUG_NOMC 0x01000000
2697 * - encoding: Set by user.
2698 * - decoding: Set by user.
2701 #define FF_DEBUG_VIS_MV_P_FOR 0x00000001 // visualize forward predicted MVs of P-frames
2702 #define FF_DEBUG_VIS_MV_B_FOR 0x00000002 // visualize forward predicted MVs of B-frames
2703 #define FF_DEBUG_VIS_MV_B_BACK 0x00000004 // visualize backward predicted MVs of B-frames
2707 * Error recognition; may misdetect some more or less valid parts as errors.
2708 * - encoding: unused
2709 * - decoding: Set by user.
2711 int err_recognition;
2714 * Verify checksums embedded in the bitstream (could be of either encoded or
2715 * decoded data, depending on the codec) and print an error message on mismatch.
2716 * If AV_EF_EXPLODE is also set, a mismatching checksum will result in the
2717 * decoder returning an error.
2719 #define AV_EF_CRCCHECK (1<<0)
2720 #define AV_EF_BITSTREAM (1<<1) ///< detect bitstream specification deviations
2721 #define AV_EF_BUFFER (1<<2) ///< detect improper bitstream length
2722 #define AV_EF_EXPLODE (1<<3) ///< abort decoding on minor error detection
2724 #define AV_EF_IGNORE_ERR (1<<15) ///< ignore errors and continue
2725 #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
2726 #define AV_EF_COMPLIANT (1<<17) ///< consider all spec non compliances as errors
2727 #define AV_EF_AGGRESSIVE (1<<18) ///< consider things that a sane encoder should not do as an error
2731 * opaque 64-bit number (generally a PTS) that will be reordered and
2732 * output in AVFrame.reordered_opaque
2733 * - encoding: Set by libavcodec to the reordered_opaque of the input
2734 * frame corresponding to the last returned packet. Only
2735 * supported by encoders with the
2736 * AV_CODEC_CAP_ENCODER_REORDERED_OPAQUE capability.
2737 * - decoding: Set by user.
2739 int64_t reordered_opaque;
2742 * Hardware accelerator in use
2743 * - encoding: unused.
2744 * - decoding: Set by libavcodec
2746 const struct AVHWAccel *hwaccel;
2749 * Hardware accelerator context.
2750 * For some hardware accelerators, a global context needs to be
2751 * provided by the user. In that case, this holds display-dependent
2752 * data FFmpeg cannot instantiate itself. Please refer to the
2753 * FFmpeg HW accelerator documentation to know how to fill this
2754 * is. e.g. for VA API, this is a struct vaapi_context.
2755 * - encoding: unused
2756 * - decoding: Set by user
2758 void *hwaccel_context;
2762 * - encoding: Set by libavcodec if flags & AV_CODEC_FLAG_PSNR.
2763 * - decoding: unused
2765 uint64_t error[AV_NUM_DATA_POINTERS];
2768 * DCT algorithm, see FF_DCT_* below
2769 * - encoding: Set by user.
2770 * - decoding: unused
2773 #define FF_DCT_AUTO 0
2774 #define FF_DCT_FASTINT 1
2775 #define FF_DCT_INT 2
2776 #define FF_DCT_MMX 3
2777 #define FF_DCT_ALTIVEC 5
2778 #define FF_DCT_FAAN 6
2781 * IDCT algorithm, see FF_IDCT_* below.
2782 * - encoding: Set by user.
2783 * - decoding: Set by user.
2786 #define FF_IDCT_AUTO 0
2787 #define FF_IDCT_INT 1
2788 #define FF_IDCT_SIMPLE 2
2789 #define FF_IDCT_SIMPLEMMX 3
2790 #define FF_IDCT_ARM 7
2791 #define FF_IDCT_ALTIVEC 8
2792 #define FF_IDCT_SIMPLEARM 10
2793 #define FF_IDCT_XVID 14
2794 #define FF_IDCT_SIMPLEARMV5TE 16
2795 #define FF_IDCT_SIMPLEARMV6 17
2796 #define FF_IDCT_FAAN 20
2797 #define FF_IDCT_SIMPLENEON 22
2798 #define FF_IDCT_NONE 24 /* Used by XvMC to extract IDCT coefficients with FF_IDCT_PERM_NONE */
2799 #define FF_IDCT_SIMPLEAUTO 128
2802 * bits per sample/pixel from the demuxer (needed for huffyuv).
2803 * - encoding: Set by libavcodec.
2804 * - decoding: Set by user.
2806 int bits_per_coded_sample;
2809 * Bits per sample/pixel of internal libavcodec pixel/sample format.
2810 * - encoding: set by user.
2811 * - decoding: set by libavcodec.
2813 int bits_per_raw_sample;
2817 * low resolution decoding, 1-> 1/2 size, 2->1/4 size
2818 * - encoding: unused
2819 * - decoding: Set by user.
2824 #if FF_API_CODED_FRAME
2826 * the picture in the bitstream
2827 * - encoding: Set by libavcodec.
2828 * - decoding: unused
2830 * @deprecated use the quality factor packet side data instead
2832 attribute_deprecated AVFrame *coded_frame;
2837 * is used to decide how many independent tasks should be passed to execute()
2838 * - encoding: Set by user.
2839 * - decoding: Set by user.
2844 * Which multithreading methods to use.
2845 * Use of FF_THREAD_FRAME will increase decoding delay by one frame per thread,
2846 * so clients which cannot provide future frames should not use it.
2848 * - encoding: Set by user, otherwise the default is used.
2849 * - decoding: Set by user, otherwise the default is used.
2852 #define FF_THREAD_FRAME 1 ///< Decode more than one frame at once
2853 #define FF_THREAD_SLICE 2 ///< Decode more than one part of a single frame at once
2856 * Which multithreading methods are in use by the codec.
2857 * - encoding: Set by libavcodec.
2858 * - decoding: Set by libavcodec.
2860 int active_thread_type;
2863 * Set by the client if its custom get_buffer() callback can be called
2864 * synchronously from another thread, which allows faster multithreaded decoding.
2865 * draw_horiz_band() will be called from other threads regardless of this setting.
2866 * Ignored if the default get_buffer() is used.
2867 * - encoding: Set by user.
2868 * - decoding: Set by user.
2870 int thread_safe_callbacks;
2873 * The codec may call this to execute several independent things.
2874 * It will return only after finishing all tasks.
2875 * The user may replace this with some multithreaded implementation,
2876 * the default implementation will execute the parts serially.
2877 * @param count the number of things to execute
2878 * - encoding: Set by libavcodec, user can override.
2879 * - decoding: Set by libavcodec, user can override.
2881 int (*execute)(struct AVCodecContext *c, int (*func)(struct AVCodecContext *c2, void *arg), void *arg2, int *ret, int count, int size);
2884 * The codec may call this to execute several independent things.
2885 * It will return only after finishing all tasks.
2886 * The user may replace this with some multithreaded implementation,
2887 * the default implementation will execute the parts serially.
2888 * Also see avcodec_thread_init and e.g. the --enable-pthread configure option.
2889 * @param c context passed also to func
2890 * @param count the number of things to execute
2891 * @param arg2 argument passed unchanged to func
2892 * @param ret return values of executed functions, must have space for "count" values. May be NULL.
2893 * @param func function that will be called count times, with jobnr from 0 to count-1.
2894 * threadnr will be in the range 0 to c->thread_count-1 < MAX_THREADS and so that no
2895 * two instances of func executing at the same time will have the same threadnr.
2896 * @return always 0 currently, but code should handle a future improvement where when any call to func
2897 * returns < 0 no further calls to func may be done and < 0 is returned.
2898 * - encoding: Set by libavcodec, user can override.
2899 * - decoding: Set by libavcodec, user can override.
2901 int (*execute2)(struct AVCodecContext *c, int (*func)(struct AVCodecContext *c2, void *arg, int jobnr, int threadnr), void *arg2, int *ret, int count);
2904 * noise vs. sse weight for the nsse comparison function
2905 * - encoding: Set by user.
2906 * - decoding: unused
2912 * - encoding: Set by user.
2913 * - decoding: Set by libavcodec.
2916 #define FF_PROFILE_UNKNOWN -99
2917 #define FF_PROFILE_RESERVED -100
2919 #define FF_PROFILE_AAC_MAIN 0
2920 #define FF_PROFILE_AAC_LOW 1
2921 #define FF_PROFILE_AAC_SSR 2
2922 #define FF_PROFILE_AAC_LTP 3
2923 #define FF_PROFILE_AAC_HE 4
2924 #define FF_PROFILE_AAC_HE_V2 28
2925 #define FF_PROFILE_AAC_LD 22
2926 #define FF_PROFILE_AAC_ELD 38
2927 #define FF_PROFILE_MPEG2_AAC_LOW 128
2928 #define FF_PROFILE_MPEG2_AAC_HE 131
2930 #define FF_PROFILE_DNXHD 0
2931 #define FF_PROFILE_DNXHR_LB 1
2932 #define FF_PROFILE_DNXHR_SQ 2
2933 #define FF_PROFILE_DNXHR_HQ 3
2934 #define FF_PROFILE_DNXHR_HQX 4
2935 #define FF_PROFILE_DNXHR_444 5
2937 #define FF_PROFILE_DTS 20
2938 #define FF_PROFILE_DTS_ES 30
2939 #define FF_PROFILE_DTS_96_24 40
2940 #define FF_PROFILE_DTS_HD_HRA 50
2941 #define FF_PROFILE_DTS_HD_MA 60
2942 #define FF_PROFILE_DTS_EXPRESS 70
2944 #define FF_PROFILE_MPEG2_422 0
2945 #define FF_PROFILE_MPEG2_HIGH 1
2946 #define FF_PROFILE_MPEG2_SS 2
2947 #define FF_PROFILE_MPEG2_SNR_SCALABLE 3
2948 #define FF_PROFILE_MPEG2_MAIN 4
2949 #define FF_PROFILE_MPEG2_SIMPLE 5
2951 #define FF_PROFILE_H264_CONSTRAINED (1<<9) // 8+1; constraint_set1_flag
2952 #define FF_PROFILE_H264_INTRA (1<<11) // 8+3; constraint_set3_flag
2954 #define FF_PROFILE_H264_BASELINE 66
2955 #define FF_PROFILE_H264_CONSTRAINED_BASELINE (66|FF_PROFILE_H264_CONSTRAINED)
2956 #define FF_PROFILE_H264_MAIN 77
2957 #define FF_PROFILE_H264_EXTENDED 88
2958 #define FF_PROFILE_H264_HIGH 100
2959 #define FF_PROFILE_H264_HIGH_10 110
2960 #define FF_PROFILE_H264_HIGH_10_INTRA (110|FF_PROFILE_H264_INTRA)
2961 #define FF_PROFILE_H264_MULTIVIEW_HIGH 118
2962 #define FF_PROFILE_H264_HIGH_422 122
2963 #define FF_PROFILE_H264_HIGH_422_INTRA (122|FF_PROFILE_H264_INTRA)
2964 #define FF_PROFILE_H264_STEREO_HIGH 128
2965 #define FF_PROFILE_H264_HIGH_444 144
2966 #define FF_PROFILE_H264_HIGH_444_PREDICTIVE 244
2967 #define FF_PROFILE_H264_HIGH_444_INTRA (244|FF_PROFILE_H264_INTRA)
2968 #define FF_PROFILE_H264_CAVLC_444 44
2970 #define FF_PROFILE_VC1_SIMPLE 0
2971 #define FF_PROFILE_VC1_MAIN 1
2972 #define FF_PROFILE_VC1_COMPLEX 2
2973 #define FF_PROFILE_VC1_ADVANCED 3
2975 #define FF_PROFILE_MPEG4_SIMPLE 0
2976 #define FF_PROFILE_MPEG4_SIMPLE_SCALABLE 1
2977 #define FF_PROFILE_MPEG4_CORE 2
2978 #define FF_PROFILE_MPEG4_MAIN 3
2979 #define FF_PROFILE_MPEG4_N_BIT 4
2980 #define FF_PROFILE_MPEG4_SCALABLE_TEXTURE 5
2981 #define FF_PROFILE_MPEG4_SIMPLE_FACE_ANIMATION 6
2982 #define FF_PROFILE_MPEG4_BASIC_ANIMATED_TEXTURE 7
2983 #define FF_PROFILE_MPEG4_HYBRID 8
2984 #define FF_PROFILE_MPEG4_ADVANCED_REAL_TIME 9
2985 #define FF_PROFILE_MPEG4_CORE_SCALABLE 10
2986 #define FF_PROFILE_MPEG4_ADVANCED_CODING 11
2987 #define FF_PROFILE_MPEG4_ADVANCED_CORE 12
2988 #define FF_PROFILE_MPEG4_ADVANCED_SCALABLE_TEXTURE 13
2989 #define FF_PROFILE_MPEG4_SIMPLE_STUDIO 14
2990 #define FF_PROFILE_MPEG4_ADVANCED_SIMPLE 15
2992 #define FF_PROFILE_JPEG2000_CSTREAM_RESTRICTION_0 1
2993 #define FF_PROFILE_JPEG2000_CSTREAM_RESTRICTION_1 2
2994 #define FF_PROFILE_JPEG2000_CSTREAM_NO_RESTRICTION 32768
2995 #define FF_PROFILE_JPEG2000_DCINEMA_2K 3
2996 #define FF_PROFILE_JPEG2000_DCINEMA_4K 4
2998 #define FF_PROFILE_VP9_0 0
2999 #define FF_PROFILE_VP9_1 1
3000 #define FF_PROFILE_VP9_2 2
3001 #define FF_PROFILE_VP9_3 3
3003 #define FF_PROFILE_HEVC_MAIN 1
3004 #define FF_PROFILE_HEVC_MAIN_10 2
3005 #define FF_PROFILE_HEVC_MAIN_STILL_PICTURE 3
3006 #define FF_PROFILE_HEVC_REXT 4
3008 #define FF_PROFILE_AV1_MAIN 0
3009 #define FF_PROFILE_AV1_HIGH 1
3010 #define FF_PROFILE_AV1_PROFESSIONAL 2
3012 #define FF_PROFILE_MJPEG_HUFFMAN_BASELINE_DCT 0xc0
3013 #define FF_PROFILE_MJPEG_HUFFMAN_EXTENDED_SEQUENTIAL_DCT 0xc1
3014 #define FF_PROFILE_MJPEG_HUFFMAN_PROGRESSIVE_DCT 0xc2
3015 #define FF_PROFILE_MJPEG_HUFFMAN_LOSSLESS 0xc3
3016 #define FF_PROFILE_MJPEG_JPEG_LS 0xf7
3018 #define FF_PROFILE_SBC_MSBC 1
3020 #define FF_PROFILE_PRORES_PROXY 0
3021 #define FF_PROFILE_PRORES_LT 1
3022 #define FF_PROFILE_PRORES_STANDARD 2
3023 #define FF_PROFILE_PRORES_HQ 3
3024 #define FF_PROFILE_PRORES_4444 4
3025 #define FF_PROFILE_PRORES_XQ 5
3027 #define FF_PROFILE_ARIB_PROFILE_A 0
3028 #define FF_PROFILE_ARIB_PROFILE_C 1
3032 * - encoding: Set by user.
3033 * - decoding: Set by libavcodec.
3036 #define FF_LEVEL_UNKNOWN -99
3039 * Skip loop filtering for selected frames.
3040 * - encoding: unused
3041 * - decoding: Set by user.
3043 enum AVDiscard skip_loop_filter;
3046 * Skip IDCT/dequantization for selected frames.
3047 * - encoding: unused
3048 * - decoding: Set by user.
3050 enum AVDiscard skip_idct;
3053 * Skip decoding for selected frames.
3054 * - encoding: unused
3055 * - decoding: Set by user.
3057 enum AVDiscard skip_frame;
3060 * Header containing style information for text subtitles.
3061 * For SUBTITLE_ASS subtitle type, it should contain the whole ASS
3062 * [Script Info] and [V4+ Styles] section, plus the [Events] line and
3063 * the Format line following. It shouldn't include any Dialogue line.
3064 * - encoding: Set/allocated/freed by user (before avcodec_open2())
3065 * - decoding: Set/allocated/freed by libavcodec (by avcodec_open2())
3067 uint8_t *subtitle_header;
3068 int subtitle_header_size;
3070 #if FF_API_VBV_DELAY
3072 * VBV delay coded in the last frame (in periods of a 27 MHz clock).
3073 * Used for compliant TS muxing.
3074 * - encoding: Set by libavcodec.
3075 * - decoding: unused.
3076 * @deprecated this value is now exported as a part of
3077 * AV_PKT_DATA_CPB_PROPERTIES packet side data
3079 attribute_deprecated
3083 #if FF_API_SIDEDATA_ONLY_PKT
3085 * Encoding only and set by default. Allow encoders to output packets
3086 * that do not contain any encoded data, only side data.
3088 * Some encoders need to output such packets, e.g. to update some stream
3089 * parameters at the end of encoding.
3091 * @deprecated this field disables the default behaviour and
3092 * it is kept only for compatibility.
3094 attribute_deprecated
3095 int side_data_only_packets;
3099 * Audio only. The number of "priming" samples (padding) inserted by the
3100 * encoder at the beginning of the audio. I.e. this number of leading
3101 * decoded samples must be discarded by the caller to get the original audio
3102 * without leading padding.
3104 * - decoding: unused
3105 * - encoding: Set by libavcodec. The timestamps on the output packets are
3106 * adjusted by the encoder so that they always refer to the
3107 * first sample of the data actually contained in the packet,
3108 * including any added padding. E.g. if the timebase is
3109 * 1/samplerate and the timestamp of the first input sample is
3110 * 0, the timestamp of the first output packet will be
3113 int initial_padding;
3116 * - decoding: For codecs that store a framerate value in the compressed
3117 * bitstream, the decoder may export it here. { 0, 1} when
3119 * - encoding: May be used to signal the framerate of CFR content to an
3122 AVRational framerate;
3125 * Nominal unaccelerated pixel format, see AV_PIX_FMT_xxx.
3126 * - encoding: unused.
3127 * - decoding: Set by libavcodec before calling get_format()
3129 enum AVPixelFormat sw_pix_fmt;
3132 * Timebase in which pkt_dts/pts and AVPacket.dts/pts are.
3133 * - encoding unused.
3134 * - decoding set by user.
3136 AVRational pkt_timebase;
3140 * - encoding: unused.
3141 * - decoding: set by libavcodec.
3143 const AVCodecDescriptor *codec_descriptor;
3147 * low resolution decoding, 1-> 1/2 size, 2->1/4 size
3148 * - encoding: unused
3149 * - decoding: Set by user.
3155 * Current statistics for PTS correction.
3156 * - decoding: maintained and used by libavcodec, not intended to be used by user apps
3157 * - encoding: unused
3159 int64_t pts_correction_num_faulty_pts; /// Number of incorrect PTS values so far
3160 int64_t pts_correction_num_faulty_dts; /// Number of incorrect DTS values so far
3161 int64_t pts_correction_last_pts; /// PTS of the last frame
3162 int64_t pts_correction_last_dts; /// DTS of the last frame
3165 * Character encoding of the input subtitles file.
3166 * - decoding: set by user
3167 * - encoding: unused
3172 * Subtitles character encoding mode. Formats or codecs might be adjusting
3173 * this setting (if they are doing the conversion themselves for instance).
3174 * - decoding: set by libavcodec
3175 * - encoding: unused
3177 int sub_charenc_mode;
3178 #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)
3179 #define FF_SUB_CHARENC_MODE_AUTOMATIC 0 ///< libavcodec will select the mode itself
3180 #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
3181 #define FF_SUB_CHARENC_MODE_IGNORE 2 ///< neither convert the subtitles, nor check them for valid UTF-8
3184 * Skip processing alpha if supported by codec.
3185 * Note that if the format uses pre-multiplied alpha (common with VP6,
3186 * and recommended due to better video quality/compression)
3187 * the image will look as if alpha-blended onto a black background.
3188 * However for formats that do not use pre-multiplied alpha
3189 * there might be serious artefacts (though e.g. libswscale currently
3190 * assumes pre-multiplied alpha anyway).
3192 * - decoding: set by user
3193 * - encoding: unused
3198 * Number of samples to skip after a discontinuity
3199 * - decoding: unused
3200 * - encoding: set by libavcodec
3204 #if !FF_API_DEBUG_MV
3206 * debug motion vectors
3207 * - encoding: Set by user.
3208 * - decoding: Set by user.
3211 #define FF_DEBUG_VIS_MV_P_FOR 0x00000001 //visualize forward predicted MVs of P frames
3212 #define FF_DEBUG_VIS_MV_B_FOR 0x00000002 //visualize forward predicted MVs of B frames
3213 #define FF_DEBUG_VIS_MV_B_BACK 0x00000004 //visualize backward predicted MVs of B frames
3217 * custom intra quantization matrix
3218 * - encoding: Set by user, can be NULL.
3219 * - decoding: unused.
3221 uint16_t *chroma_intra_matrix;
3224 * dump format separator.
3225 * can be ", " or "\n " or anything else
3226 * - encoding: Set by user.
3227 * - decoding: Set by user.
3229 uint8_t *dump_separator;
3232 * ',' separated list of allowed decoders.
3233 * If NULL then all are allowed
3234 * - encoding: unused
3235 * - decoding: set by user
3237 char *codec_whitelist;
3240 * Properties of the stream that gets decoded
3241 * - encoding: unused
3242 * - decoding: set by libavcodec
3244 unsigned properties;
3245 #define FF_CODEC_PROPERTY_LOSSLESS 0x00000001
3246 #define FF_CODEC_PROPERTY_CLOSED_CAPTIONS 0x00000002
3249 * Additional data associated with the entire coded stream.
3251 * - decoding: unused
3252 * - encoding: may be set by libavcodec after avcodec_open2().
3254 AVPacketSideData *coded_side_data;
3255 int nb_coded_side_data;
3258 * A reference to the AVHWFramesContext describing the input (for encoding)
3259 * or output (decoding) frames. The reference is set by the caller and
3260 * afterwards owned (and freed) by libavcodec - it should never be read by
3261 * the caller after being set.
3263 * - decoding: This field should be set by the caller from the get_format()
3264 * callback. The previous reference (if any) will always be
3265 * unreffed by libavcodec before the get_format() call.
3267 * If the default get_buffer2() is used with a hwaccel pixel
3268 * format, then this AVHWFramesContext will be used for
3269 * allocating the frame buffers.
3271 * - encoding: For hardware encoders configured to use a hwaccel pixel
3272 * format, this field should be set by the caller to a reference
3273 * to the AVHWFramesContext describing input frames.
3274 * AVHWFramesContext.format must be equal to
3275 * AVCodecContext.pix_fmt.
3277 * This field should be set before avcodec_open2() is called.
3279 AVBufferRef *hw_frames_ctx;
3282 * Control the form of AVSubtitle.rects[N]->ass
3283 * - decoding: set by user
3284 * - encoding: unused
3286 int sub_text_format;
3287 #define FF_SUB_TEXT_FMT_ASS 0
3288 #if FF_API_ASS_TIMING
3289 #define FF_SUB_TEXT_FMT_ASS_WITH_TIMINGS 1
3293 * Audio only. The amount of padding (in samples) appended by the encoder to
3294 * the end of the audio. I.e. this number of decoded samples must be
3295 * discarded by the caller from the end of the stream to get the original
3296 * audio without any trailing padding.
3298 * - decoding: unused
3299 * - encoding: unused
3301 int trailing_padding;
3304 * The number of pixels per image to maximally accept.
3306 * - decoding: set by user
3307 * - encoding: set by user
3312 * A reference to the AVHWDeviceContext describing the device which will
3313 * be used by a hardware encoder/decoder. The reference is set by the
3314 * caller and afterwards owned (and freed) by libavcodec.
3316 * This should be used if either the codec device does not require
3317 * hardware frames or any that are used are to be allocated internally by
3318 * libavcodec. If the user wishes to supply any of the frames used as
3319 * encoder input or decoder output then hw_frames_ctx should be used
3320 * instead. When hw_frames_ctx is set in get_format() for a decoder, this
3321 * field will be ignored while decoding the associated stream segment, but
3322 * may again be used on a following one after another get_format() call.
3324 * For both encoders and decoders this field should be set before
3325 * avcodec_open2() is called and must not be written to thereafter.
3327 * Note that some decoders may require this field to be set initially in
3328 * order to support hw_frames_ctx at all - in that case, all frames
3329 * contexts used must be created on the same device.
3331 AVBufferRef *hw_device_ctx;
3334 * Bit set of AV_HWACCEL_FLAG_* flags, which affect hardware accelerated
3335 * decoding (if active).
3336 * - encoding: unused
3337 * - decoding: Set by user (either before avcodec_open2(), or in the
3338 * AVCodecContext.get_format callback)
3343 * Video decoding only. Certain video codecs support cropping, meaning that
3344 * only a sub-rectangle of the decoded frame is intended for display. This
3345 * option controls how cropping is handled by libavcodec.
3347 * When set to 1 (the default), libavcodec will apply cropping internally.
3348 * I.e. it will modify the output frame width/height fields and offset the
3349 * data pointers (only by as much as possible while preserving alignment, or
3350 * by the full amount if the AV_CODEC_FLAG_UNALIGNED flag is set) so that
3351 * the frames output by the decoder refer only to the cropped area. The
3352 * crop_* fields of the output frames will be zero.
3354 * When set to 0, the width/height fields of the output frames will be set
3355 * to the coded dimensions and the crop_* fields will describe the cropping
3356 * rectangle. Applying the cropping is left to the caller.
3358 * @warning When hardware acceleration with opaque output frames is used,
3359 * libavcodec is unable to apply cropping from the top/left border.
3361 * @note when this option is set to zero, the width/height fields of the
3362 * AVCodecContext and output AVFrames have different meanings. The codec
3363 * context fields store display dimensions (with the coded dimensions in
3364 * coded_width/height), while the frame fields store the coded dimensions
3365 * (with the display dimensions being determined by the crop_* fields).
3370 * Video decoding only. Sets the number of extra hardware frames which
3371 * the decoder will allocate for use by the caller. This must be set
3372 * before avcodec_open2() is called.
3374 * Some hardware decoders require all frames that they will use for
3375 * output to be defined in advance before decoding starts. For such
3376 * decoders, the hardware frame pool must therefore be of a fixed size.
3377 * The extra frames set here are on top of any number that the decoder
3378 * needs internally in order to operate normally (for example, frames
3379 * used as reference pictures).
3381 int extra_hw_frames;
3384 * The percentage of damaged samples to discard a frame.
3386 * - decoding: set by user
3387 * - encoding: unused
3389 int discard_damaged_percentage;
3392 * The number of samples per frame to maximally accept.
3394 * - decoding: set by user
3395 * - encoding: set by user
3397 int64_t max_samples;
3400 #if FF_API_CODEC_GET_SET
3402 * Accessors for some AVCodecContext fields. These used to be provided for ABI
3403 * compatibility, and do not need to be used anymore.
3405 attribute_deprecated
3406 AVRational av_codec_get_pkt_timebase (const AVCodecContext *avctx);
3407 attribute_deprecated
3408 void av_codec_set_pkt_timebase (AVCodecContext *avctx, AVRational val);
3410 attribute_deprecated
3411 const AVCodecDescriptor *av_codec_get_codec_descriptor(const AVCodecContext *avctx);
3412 attribute_deprecated
3413 void av_codec_set_codec_descriptor(AVCodecContext *avctx, const AVCodecDescriptor *desc);
3415 attribute_deprecated
3416 unsigned av_codec_get_codec_properties(const AVCodecContext *avctx);
3419 attribute_deprecated
3420 int av_codec_get_lowres(const AVCodecContext *avctx);
3421 attribute_deprecated
3422 void av_codec_set_lowres(AVCodecContext *avctx, int val);
3425 attribute_deprecated
3426 int av_codec_get_seek_preroll(const AVCodecContext *avctx);
3427 attribute_deprecated
3428 void av_codec_set_seek_preroll(AVCodecContext *avctx, int val);
3430 attribute_deprecated
3431 uint16_t *av_codec_get_chroma_intra_matrix(const AVCodecContext *avctx);
3432 attribute_deprecated
3433 void av_codec_set_chroma_intra_matrix(AVCodecContext *avctx, uint16_t *val);
3439 typedef struct AVProfile {
3441 const char *name; ///< short name for the profile
3446 * The codec supports this format via the hw_device_ctx interface.
3448 * When selecting this format, AVCodecContext.hw_device_ctx should
3449 * have been set to a device of the specified type before calling
3452 AV_CODEC_HW_CONFIG_METHOD_HW_DEVICE_CTX = 0x01,
3454 * The codec supports this format via the hw_frames_ctx interface.
3456 * When selecting this format for a decoder,
3457 * AVCodecContext.hw_frames_ctx should be set to a suitable frames
3458 * context inside the get_format() callback. The frames context
3459 * must have been created on a device of the specified type.
3461 AV_CODEC_HW_CONFIG_METHOD_HW_FRAMES_CTX = 0x02,
3463 * The codec supports this format by some internal method.
3465 * This format can be selected without any additional configuration -
3466 * no device or frames context is required.
3468 AV_CODEC_HW_CONFIG_METHOD_INTERNAL = 0x04,
3470 * The codec supports this format by some ad-hoc method.
3472 * Additional settings and/or function calls are required. See the
3473 * codec-specific documentation for details. (Methods requiring
3474 * this sort of configuration are deprecated and others should be
3475 * used in preference.)
3477 AV_CODEC_HW_CONFIG_METHOD_AD_HOC = 0x08,
3480 typedef struct AVCodecHWConfig {
3482 * A hardware pixel format which the codec can use.
3484 enum AVPixelFormat pix_fmt;
3486 * Bit set of AV_CODEC_HW_CONFIG_METHOD_* flags, describing the possible
3487 * setup methods which can be used with this configuration.
3491 * The device type associated with the configuration.
3493 * Must be set for AV_CODEC_HW_CONFIG_METHOD_HW_DEVICE_CTX and
3494 * AV_CODEC_HW_CONFIG_METHOD_HW_FRAMES_CTX, otherwise unused.
3496 enum AVHWDeviceType device_type;
3499 typedef struct AVCodecDefault AVCodecDefault;
3506 typedef struct AVCodec {
3508 * Name of the codec implementation.
3509 * The name is globally unique among encoders and among decoders (but an
3510 * encoder and a decoder can share the same name).
3511 * This is the primary way to find a codec from the user perspective.
3515 * Descriptive name for the codec, meant to be more human readable than name.
3516 * You should use the NULL_IF_CONFIG_SMALL() macro to define it.
3518 const char *long_name;
3519 enum AVMediaType type;
3522 * Codec capabilities.
3523 * see AV_CODEC_CAP_*
3526 const AVRational *supported_framerates; ///< array of supported framerates, or NULL if any, array is terminated by {0,0}
3527 const enum AVPixelFormat *pix_fmts; ///< array of supported pixel formats, or NULL if unknown, array is terminated by -1
3528 const int *supported_samplerates; ///< array of supported audio samplerates, or NULL if unknown, array is terminated by 0
3529 const enum AVSampleFormat *sample_fmts; ///< array of supported sample formats, or NULL if unknown, array is terminated by -1
3530 const uint64_t *channel_layouts; ///< array of support channel layouts, or NULL if unknown. array is terminated by 0
3531 uint8_t max_lowres; ///< maximum value for lowres supported by the decoder
3532 const AVClass *priv_class; ///< AVClass for the private context
3533 const AVProfile *profiles; ///< array of recognized profiles, or NULL if unknown, array is terminated by {FF_PROFILE_UNKNOWN}
3536 * Group name of the codec implementation.
3537 * This is a short symbolic name of the wrapper backing this codec. A
3538 * wrapper uses some kind of external implementation for the codec, such
3539 * as an external library, or a codec implementation provided by the OS or
3541 * If this field is NULL, this is a builtin, libavcodec native codec.
3542 * If non-NULL, this will be the suffix in AVCodec.name in most cases
3543 * (usually AVCodec.name will be of the form "<codec_name>_<wrapper_name>").
3545 const char *wrapper_name;
3547 /*****************************************************************
3548 * No fields below this line are part of the public API. They
3549 * may not be used outside of libavcodec and can be changed and
3551 * New public fields should be added right above.
3552 *****************************************************************
3555 struct AVCodec *next;
3557 * @name Frame-level threading support functions
3561 * If defined, called on thread contexts when they are created.
3562 * If the codec allocates writable tables in init(), re-allocate them here.
3563 * priv_data will be set to a copy of the original.
3565 int (*init_thread_copy)(AVCodecContext *);
3567 * Copy necessary context variables from a previous thread context to the current one.
3568 * If not defined, the next thread will start automatically; otherwise, the codec
3569 * must call ff_thread_finish_setup().
3571 * dst and src will (rarely) point to the same context, in which case memcpy should be skipped.
3573 int (*update_thread_context)(AVCodecContext *dst, const AVCodecContext *src);
3577 * Private codec-specific defaults.
3579 const AVCodecDefault *defaults;
3582 * Initialize codec static data, called from avcodec_register().
3584 * This is not intended for time consuming operations as it is
3585 * run for every codec regardless of that codec being used.
3587 void (*init_static_data)(struct AVCodec *codec);
3589 int (*init)(AVCodecContext *);
3590 int (*encode_sub)(AVCodecContext *, uint8_t *buf, int buf_size,
3591 const struct AVSubtitle *sub);
3593 * Encode data to an AVPacket.
3595 * @param avctx codec context
3596 * @param avpkt output AVPacket (may contain a user-provided buffer)
3597 * @param[in] frame AVFrame containing the raw data to be encoded
3598 * @param[out] got_packet_ptr encoder sets to 0 or 1 to indicate that a
3599 * non-empty packet was returned in avpkt.
3600 * @return 0 on success, negative error code on failure
3602 int (*encode2)(AVCodecContext *avctx, AVPacket *avpkt, const AVFrame *frame,
3603 int *got_packet_ptr);
3604 int (*decode)(AVCodecContext *, void *outdata, int *outdata_size, AVPacket *avpkt);
3605 int (*close)(AVCodecContext *);
3607 * Encode API with decoupled packet/frame dataflow. The API is the
3608 * same as the avcodec_ prefixed APIs (avcodec_send_frame() etc.), except
3610 * - never called if the codec is closed or the wrong type,
3611 * - if AV_CODEC_CAP_DELAY is not set, drain frames are never sent,
3612 * - only one drain frame is ever passed down,
3614 int (*send_frame)(AVCodecContext *avctx, const AVFrame *frame);
3615 int (*receive_packet)(AVCodecContext *avctx, AVPacket *avpkt);
3618 * Decode API with decoupled packet/frame dataflow. This function is called
3619 * to get one output frame. It should call ff_decode_get_packet() to obtain
3622 int (*receive_frame)(AVCodecContext *avctx, AVFrame *frame);
3625 * Will be called when seeking
3627 void (*flush)(AVCodecContext *);
3629 * Internal codec capabilities.
3630 * See FF_CODEC_CAP_* in internal.h
3635 * Decoding only, a comma-separated list of bitstream filters to apply to
3636 * packets before decoding.
3641 * Array of pointers to hardware configurations supported by the codec,
3642 * or NULL if no hardware supported. The array is terminated by a NULL
3645 * The user can only access this field via avcodec_get_hw_config().
3647 const struct AVCodecHWConfigInternal **hw_configs;
3650 * List of supported codec_tags, terminated by FF_CODEC_TAGS_END.
3652 const uint32_t *codec_tags;
3655 #if FF_API_CODEC_GET_SET
3656 attribute_deprecated
3657 int av_codec_get_max_lowres(const AVCodec *codec);
3660 struct MpegEncContext;
3663 * Retrieve supported hardware configurations for a codec.
3665 * Values of index from zero to some maximum return the indexed configuration
3666 * descriptor; all other values return NULL. If the codec does not support
3667 * any hardware configurations then it will always return NULL.
3669 const AVCodecHWConfig *avcodec_get_hw_config(const AVCodec *codec, int index);
3672 * @defgroup lavc_hwaccel AVHWAccel
3674 * @note Nothing in this structure should be accessed by the user. At some
3675 * point in future it will not be externally visible at all.
3679 typedef struct AVHWAccel {
3681 * Name of the hardware accelerated codec.
3682 * The name is globally unique among encoders and among decoders (but an
3683 * encoder and a decoder can share the same name).
3688 * Type of codec implemented by the hardware accelerator.
3690 * See AVMEDIA_TYPE_xxx
3692 enum AVMediaType type;
3695 * Codec implemented by the hardware accelerator.
3697 * See AV_CODEC_ID_xxx
3702 * Supported pixel format.
3704 * Only hardware accelerated formats are supported here.
3706 enum AVPixelFormat pix_fmt;
3709 * Hardware accelerated codec capabilities.
3710 * see AV_HWACCEL_CODEC_CAP_*
3714 /*****************************************************************
3715 * No fields below this line are part of the public API. They
3716 * may not be used outside of libavcodec and can be changed and
3718 * New public fields should be added right above.
3719 *****************************************************************
3723 * Allocate a custom buffer
3725 int (*alloc_frame)(AVCodecContext *avctx, AVFrame *frame);
3728 * Called at the beginning of each frame or field picture.
3730 * Meaningful frame information (codec specific) is guaranteed to
3731 * be parsed at this point. This function is mandatory.
3733 * Note that buf can be NULL along with buf_size set to 0.
3734 * Otherwise, this means the whole frame is available at this point.
3736 * @param avctx the codec context
3737 * @param buf the frame data buffer base
3738 * @param buf_size the size of the frame in bytes
3739 * @return zero if successful, a negative value otherwise
3741 int (*start_frame)(AVCodecContext *avctx, const uint8_t *buf, uint32_t buf_size);
3744 * Callback for parameter data (SPS/PPS/VPS etc).
3746 * Useful for hardware decoders which keep persistent state about the
3747 * video parameters, and need to receive any changes to update that state.
3749 * @param avctx the codec context
3750 * @param type the nal unit type
3751 * @param buf the nal unit data buffer
3752 * @param buf_size the size of the nal unit in bytes
3753 * @return zero if successful, a negative value otherwise
3755 int (*decode_params)(AVCodecContext *avctx, int type, const uint8_t *buf, uint32_t buf_size);
3758 * Callback for each slice.
3760 * Meaningful slice information (codec specific) is guaranteed to
3761 * be parsed at this point. This function is mandatory.
3762 * The only exception is XvMC, that works on MB level.
3764 * @param avctx the codec context
3765 * @param buf the slice data buffer base
3766 * @param buf_size the size of the slice in bytes
3767 * @return zero if successful, a negative value otherwise
3769 int (*decode_slice)(AVCodecContext *avctx, const uint8_t *buf, uint32_t buf_size);
3772 * Called at the end of each frame or field picture.
3774 * The whole picture is parsed at this point and can now be sent
3775 * to the hardware accelerator. This function is mandatory.
3777 * @param avctx the codec context
3778 * @return zero if successful, a negative value otherwise
3780 int (*end_frame)(AVCodecContext *avctx);
3783 * Size of per-frame hardware accelerator private data.
3785 * Private data is allocated with av_mallocz() before
3786 * AVCodecContext.get_buffer() and deallocated after
3787 * AVCodecContext.release_buffer().
3789 int frame_priv_data_size;
3792 * Called for every Macroblock in a slice.
3794 * XvMC uses it to replace the ff_mpv_reconstruct_mb().
3795 * Instead of decoding to raw picture, MB parameters are
3796 * stored in an array provided by the video driver.
3798 * @param s the mpeg context
3800 void (*decode_mb)(struct MpegEncContext *s);
3803 * Initialize the hwaccel private data.
3805 * This will be called from ff_get_format(), after hwaccel and
3806 * hwaccel_context are set and the hwaccel private data in AVCodecInternal
3809 int (*init)(AVCodecContext *avctx);
3812 * Uninitialize the hwaccel private data.
3814 * This will be called from get_format() or avcodec_close(), after hwaccel
3815 * and hwaccel_context are already uninitialized.
3817 int (*uninit)(AVCodecContext *avctx);
3820 * Size of the private data to allocate in
3821 * AVCodecInternal.hwaccel_priv_data.
3826 * Internal hwaccel capabilities.
3831 * Fill the given hw_frames context with current codec parameters. Called
3832 * from get_format. Refer to avcodec_get_hw_frames_parameters() for
3835 * This CAN be called before AVHWAccel.init is called, and you must assume
3836 * that avctx->hwaccel_priv_data is invalid.
3838 int (*frame_params)(AVCodecContext *avctx, AVBufferRef *hw_frames_ctx);
3842 * HWAccel is experimental and is thus avoided in favor of non experimental
3845 #define AV_HWACCEL_CODEC_CAP_EXPERIMENTAL 0x0200
3848 * Hardware acceleration should be used for decoding even if the codec level
3849 * used is unknown or higher than the maximum supported level reported by the
3852 * It's generally a good idea to pass this flag unless you have a specific
3853 * reason not to, as hardware tends to under-report supported levels.
3855 #define AV_HWACCEL_FLAG_IGNORE_LEVEL (1 << 0)
3858 * Hardware acceleration can output YUV pixel formats with a different chroma
3859 * sampling than 4:2:0 and/or other than 8 bits per component.
3861 #define AV_HWACCEL_FLAG_ALLOW_HIGH_DEPTH (1 << 1)
3864 * Hardware acceleration should still be attempted for decoding when the
3865 * codec profile does not match the reported capabilities of the hardware.
3867 * For example, this can be used to try to decode baseline profile H.264
3868 * streams in hardware - it will often succeed, because many streams marked
3869 * as baseline profile actually conform to constrained baseline profile.
3871 * @warning If the stream is actually not supported then the behaviour is
3872 * undefined, and may include returning entirely incorrect output
3873 * while indicating success.
3875 #define AV_HWACCEL_FLAG_ALLOW_PROFILE_MISMATCH (1 << 2)
3881 #if FF_API_AVPICTURE
3883 * @defgroup lavc_picture AVPicture
3885 * Functions for working with AVPicture
3890 * Picture data structure.
3892 * Up to four components can be stored into it, the last component is
3894 * @deprecated use AVFrame or imgutils functions instead
3896 typedef struct AVPicture {
3897 attribute_deprecated
3898 uint8_t *data[AV_NUM_DATA_POINTERS]; ///< pointers to the image data planes
3899 attribute_deprecated
3900 int linesize[AV_NUM_DATA_POINTERS]; ///< number of bytes per line
3908 enum AVSubtitleType {
3911 SUBTITLE_BITMAP, ///< A bitmap, pict will be set
3914 * Plain text, the text field must be set by the decoder and is
3915 * authoritative. ass and pict fields may contain approximations.
3920 * Formatted text, the ass field must be set by the decoder and is
3921 * authoritative. pict and text fields may contain approximations.
3926 #define AV_SUBTITLE_FLAG_FORCED 0x00000001
3928 typedef struct AVSubtitleRect {
3929 int x; ///< top left corner of pict, undefined when pict is not set
3930 int y; ///< top left corner of pict, undefined when pict is not set
3931 int w; ///< width of pict, undefined when pict is not set
3932 int h; ///< height of pict, undefined when pict is not set
3933 int nb_colors; ///< number of colors in pict, undefined when pict is not set
3935 #if FF_API_AVPICTURE
3937 * @deprecated unused
3939 attribute_deprecated
3943 * data+linesize for the bitmap of this subtitle.
3944 * Can be set for text/ass as well once they are rendered.
3949 enum AVSubtitleType type;
3951 char *text; ///< 0 terminated plain UTF-8 text
3954 * 0 terminated ASS/SSA compatible event line.
3955 * The presentation of this is unaffected by the other values in this
3963 typedef struct AVSubtitle {
3964 uint16_t format; /* 0 = graphics */
3965 uint32_t start_display_time; /* relative to packet pts, in ms */
3966 uint32_t end_display_time; /* relative to packet pts, in ms */
3968 AVSubtitleRect **rects;
3969 int64_t pts; ///< Same as packet pts, in AV_TIME_BASE
3973 * This struct describes the properties of an encoded stream.
3975 * sizeof(AVCodecParameters) is not a part of the public ABI, this struct must
3976 * be allocated with avcodec_parameters_alloc() and freed with
3977 * avcodec_parameters_free().
3979 typedef struct AVCodecParameters {
3981 * General type of the encoded data.
3983 enum AVMediaType codec_type;
3985 * Specific type of the encoded data (the codec used).
3987 enum AVCodecID codec_id;
3989 * Additional information about the codec (corresponds to the AVI FOURCC).
3994 * Extra binary data needed for initializing the decoder, codec-dependent.
3996 * Must be allocated with av_malloc() and will be freed by
3997 * avcodec_parameters_free(). The allocated size of extradata must be at
3998 * least extradata_size + AV_INPUT_BUFFER_PADDING_SIZE, with the padding
4003 * Size of the extradata content in bytes.
4008 * - video: the pixel format, the value corresponds to enum AVPixelFormat.
4009 * - audio: the sample format, the value corresponds to enum AVSampleFormat.
4014 * The average bitrate of the encoded data (in bits per second).
4019 * The number of bits per sample in the codedwords.
4021 * This is basically the bitrate per sample. It is mandatory for a bunch of
4022 * formats to actually decode them. It's the number of bits for one sample in
4023 * the actual coded bitstream.
4025 * This could be for example 4 for ADPCM
4026 * For PCM formats this matches bits_per_raw_sample
4029 int bits_per_coded_sample;
4032 * This is the number of valid bits in each output sample. If the
4033 * sample format has more bits, the least significant bits are additional
4034 * padding bits, which are always 0. Use right shifts to reduce the sample
4035 * to its actual size. For example, audio formats with 24 bit samples will
4036 * have bits_per_raw_sample set to 24, and format set to AV_SAMPLE_FMT_S32.
4037 * To get the original sample use "(int32_t)sample >> 8"."
4039 * For ADPCM this might be 12 or 16 or similar
4042 int bits_per_raw_sample;
4045 * Codec-specific bitstream restrictions that the stream conforms to.
4051 * Video only. The dimensions of the video frame in pixels.
4057 * Video only. The aspect ratio (width / height) which a single pixel
4058 * should have when displayed.
4060 * When the aspect ratio is unknown / undefined, the numerator should be
4061 * set to 0 (the denominator may have any value).
4063 AVRational sample_aspect_ratio;
4066 * Video only. The order of the fields in interlaced video.
4068 enum AVFieldOrder field_order;
4071 * Video only. Additional colorspace characteristics.
4073 enum AVColorRange color_range;
4074 enum AVColorPrimaries color_primaries;
4075 enum AVColorTransferCharacteristic color_trc;
4076 enum AVColorSpace color_space;
4077 enum AVChromaLocation chroma_location;
4080 * Video only. Number of delayed frames.
4085 * Audio only. The channel layout bitmask. May be 0 if the channel layout is
4086 * unknown or unspecified, otherwise the number of bits set must be equal to
4087 * the channels field.
4089 uint64_t channel_layout;
4091 * Audio only. The number of audio channels.
4095 * Audio only. The number of audio samples per second.
4099 * Audio only. The number of bytes per coded audio frame, required by some
4102 * Corresponds to nBlockAlign in WAVEFORMATEX.
4106 * Audio only. Audio frame size, if known. Required by some formats to be static.
4111 * Audio only. The amount of padding (in samples) inserted by the encoder at
4112 * the beginning of the audio. I.e. this number of leading decoded samples
4113 * must be discarded by the caller to get the original audio without leading
4116 int initial_padding;
4118 * Audio only. The amount of padding (in samples) appended by the encoder to
4119 * the end of the audio. I.e. this number of decoded samples must be
4120 * discarded by the caller from the end of the stream to get the original
4121 * audio without any trailing padding.
4123 int trailing_padding;
4125 * Audio only. Number of samples to skip after a discontinuity.
4128 } AVCodecParameters;
4131 * Iterate over all registered codecs.
4133 * @param opaque a pointer where libavcodec will store the iteration state. Must
4134 * point to NULL to start the iteration.
4136 * @return the next registered codec or NULL when the iteration is
4139 const AVCodec *av_codec_iterate(void **opaque);
4143 * If c is NULL, returns the first registered codec,
4144 * if c is non-NULL, returns the next registered codec after c,
4145 * or NULL if c is the last one.
4147 attribute_deprecated
4148 AVCodec *av_codec_next(const AVCodec *c);
4152 * Return the LIBAVCODEC_VERSION_INT constant.
4154 unsigned avcodec_version(void);
4157 * Return the libavcodec build-time configuration.
4159 const char *avcodec_configuration(void);
4162 * Return the libavcodec license.
4164 const char *avcodec_license(void);
4168 * Register the codec codec and initialize libavcodec.
4170 * @warning either this function or avcodec_register_all() must be called
4171 * before any other libavcodec functions.
4173 * @see avcodec_register_all()
4175 attribute_deprecated
4176 void avcodec_register(AVCodec *codec);
4179 * Register all the codecs, parsers and bitstream filters which were enabled at
4180 * configuration time. If you do not call this function you can select exactly
4181 * which formats you want to support, by using the individual registration
4184 * @see avcodec_register
4185 * @see av_register_codec_parser
4186 * @see av_register_bitstream_filter
4188 attribute_deprecated
4189 void avcodec_register_all(void);
4193 * Allocate an AVCodecContext and set its fields to default values. The
4194 * resulting struct should be freed with avcodec_free_context().
4196 * @param codec if non-NULL, allocate private data and initialize defaults
4197 * for the given codec. It is illegal to then call avcodec_open2()
4198 * with a different codec.
4199 * If NULL, then the codec-specific defaults won't be initialized,
4200 * which may result in suboptimal default settings (this is
4201 * important mainly for encoders, e.g. libx264).
4203 * @return An AVCodecContext filled with default values or NULL on failure.
4205 AVCodecContext *avcodec_alloc_context3(const AVCodec *codec);
4208 * Free the codec context and everything associated with it and write NULL to
4209 * the provided pointer.
4211 void avcodec_free_context(AVCodecContext **avctx);
4213 #if FF_API_GET_CONTEXT_DEFAULTS
4215 * @deprecated This function should not be used, as closing and opening a codec
4216 * context multiple time is not supported. A new codec context should be
4217 * allocated for each new use.
4219 int avcodec_get_context_defaults3(AVCodecContext *s, const AVCodec *codec);
4223 * Get the AVClass for AVCodecContext. It can be used in combination with
4224 * AV_OPT_SEARCH_FAKE_OBJ for examining options.
4226 * @see av_opt_find().
4228 const AVClass *avcodec_get_class(void);
4230 #if FF_API_COPY_CONTEXT
4232 * Get the AVClass for AVFrame. It can be used in combination with
4233 * AV_OPT_SEARCH_FAKE_OBJ for examining options.
4235 * @see av_opt_find().
4237 const AVClass *avcodec_get_frame_class(void);
4240 * Get the AVClass for AVSubtitleRect. It can be used in combination with
4241 * AV_OPT_SEARCH_FAKE_OBJ for examining options.
4243 * @see av_opt_find().
4245 const AVClass *avcodec_get_subtitle_rect_class(void);
4248 * Copy the settings of the source AVCodecContext into the destination
4249 * AVCodecContext. The resulting destination codec context will be
4250 * unopened, i.e. you are required to call avcodec_open2() before you
4251 * can use this AVCodecContext to decode/encode video/audio data.
4253 * @param dest target codec context, should be initialized with
4254 * avcodec_alloc_context3(NULL), but otherwise uninitialized
4255 * @param src source codec context
4256 * @return AVERROR() on error (e.g. memory allocation error), 0 on success
4258 * @deprecated The semantics of this function are ill-defined and it should not
4259 * be used. If you need to transfer the stream parameters from one codec context
4260 * to another, use an intermediate AVCodecParameters instance and the
4261 * avcodec_parameters_from_context() / avcodec_parameters_to_context()
4264 attribute_deprecated
4265 int avcodec_copy_context(AVCodecContext *dest, const AVCodecContext *src);
4269 * Allocate a new AVCodecParameters and set its fields to default values
4270 * (unknown/invalid/0). The returned struct must be freed with
4271 * avcodec_parameters_free().
4273 AVCodecParameters *avcodec_parameters_alloc(void);
4276 * Free an AVCodecParameters instance and everything associated with it and
4277 * write NULL to the supplied pointer.
4279 void avcodec_parameters_free(AVCodecParameters **par);
4282 * Copy the contents of src to dst. Any allocated fields in dst are freed and
4283 * replaced with newly allocated duplicates of the corresponding fields in src.
4285 * @return >= 0 on success, a negative AVERROR code on failure.
4287 int avcodec_parameters_copy(AVCodecParameters *dst, const AVCodecParameters *src);
4290 * Fill the parameters struct based on the values from the supplied codec
4291 * context. Any allocated fields in par are freed and replaced with duplicates
4292 * of the corresponding fields in codec.
4294 * @return >= 0 on success, a negative AVERROR code on failure
4296 int avcodec_parameters_from_context(AVCodecParameters *par,
4297 const AVCodecContext *codec);
4300 * Fill the codec context based on the values from the supplied codec
4301 * parameters. Any allocated fields in codec that have a corresponding field in
4302 * par are freed and replaced with duplicates of the corresponding field in par.
4303 * Fields in codec that do not have a counterpart in par are not touched.
4305 * @return >= 0 on success, a negative AVERROR code on failure.
4307 int avcodec_parameters_to_context(AVCodecContext *codec,
4308 const AVCodecParameters *par);
4311 * Initialize the AVCodecContext to use the given AVCodec. Prior to using this
4312 * function the context has to be allocated with avcodec_alloc_context3().
4314 * The functions avcodec_find_decoder_by_name(), avcodec_find_encoder_by_name(),
4315 * avcodec_find_decoder() and avcodec_find_encoder() provide an easy way for
4316 * retrieving a codec.
4318 * @warning This function is not thread safe!
4320 * @note Always call this function before using decoding routines (such as
4321 * @ref avcodec_receive_frame()).
4324 * avcodec_register_all();
4325 * av_dict_set(&opts, "b", "2.5M", 0);
4326 * codec = avcodec_find_decoder(AV_CODEC_ID_H264);
4330 * context = avcodec_alloc_context3(codec);
4332 * if (avcodec_open2(context, codec, opts) < 0)
4336 * @param avctx The context to initialize.
4337 * @param codec The codec to open this context for. If a non-NULL codec has been
4338 * previously passed to avcodec_alloc_context3() or
4339 * for this context, then this parameter MUST be either NULL or
4340 * equal to the previously passed codec.
4341 * @param options A dictionary filled with AVCodecContext and codec-private options.
4342 * On return this object will be filled with options that were not found.
4344 * @return zero on success, a negative value on error
4345 * @see avcodec_alloc_context3(), avcodec_find_decoder(), avcodec_find_encoder(),
4346 * av_dict_set(), av_opt_find().
4348 int avcodec_open2(AVCodecContext *avctx, const AVCodec *codec, AVDictionary **options);
4351 * Close a given AVCodecContext and free all the data associated with it
4352 * (but not the AVCodecContext itself).
4354 * Calling this function on an AVCodecContext that hasn't been opened will free
4355 * the codec-specific data allocated in avcodec_alloc_context3() with a non-NULL
4356 * codec. Subsequent calls will do nothing.
4358 * @note Do not use this function. Use avcodec_free_context() to destroy a
4359 * codec context (either open or closed). Opening and closing a codec context
4360 * multiple times is not supported anymore -- use multiple codec contexts
4363 int avcodec_close(AVCodecContext *avctx);
4366 * Free all allocated data in the given subtitle struct.
4368 * @param sub AVSubtitle to free.
4370 void avsubtitle_free(AVSubtitle *sub);
4377 * @addtogroup lavc_packet
4382 * Allocate an AVPacket and set its fields to default values. The resulting
4383 * struct must be freed using av_packet_free().
4385 * @return An AVPacket filled with default values or NULL on failure.
4387 * @note this only allocates the AVPacket itself, not the data buffers. Those
4388 * must be allocated through other means such as av_new_packet.
4390 * @see av_new_packet
4392 AVPacket *av_packet_alloc(void);
4395 * Create a new packet that references the same data as src.
4397 * This is a shortcut for av_packet_alloc()+av_packet_ref().
4399 * @return newly created AVPacket on success, NULL on error.
4401 * @see av_packet_alloc
4402 * @see av_packet_ref
4404 AVPacket *av_packet_clone(const AVPacket *src);
4407 * Free the packet, if the packet is reference counted, it will be
4408 * unreferenced first.
4410 * @param pkt packet to be freed. The pointer will be set to NULL.
4411 * @note passing NULL is a no-op.
4413 void av_packet_free(AVPacket **pkt);
4416 * Initialize optional fields of a packet with default values.
4418 * Note, this does not touch the data and size members, which have to be
4419 * initialized separately.
4423 void av_init_packet(AVPacket *pkt);
4426 * Allocate the payload of a packet and initialize its fields with
4430 * @param size wanted payload size
4431 * @return 0 if OK, AVERROR_xxx otherwise
4433 int av_new_packet(AVPacket *pkt, int size);
4436 * Reduce packet size, correctly zeroing padding
4439 * @param size new size
4441 void av_shrink_packet(AVPacket *pkt, int size);
4444 * Increase packet size, correctly zeroing padding
4447 * @param grow_by number of bytes by which to increase the size of the packet
4449 int av_grow_packet(AVPacket *pkt, int grow_by);
4452 * Initialize a reference-counted packet from av_malloc()ed data.
4454 * @param pkt packet to be initialized. This function will set the data, size,
4455 * and buf fields, all others are left untouched.
4456 * @param data Data allocated by av_malloc() to be used as packet data. If this
4457 * function returns successfully, the data is owned by the underlying AVBuffer.
4458 * The caller may not access the data through other means.
4459 * @param size size of data in bytes, without the padding. I.e. the full buffer
4460 * size is assumed to be size + AV_INPUT_BUFFER_PADDING_SIZE.
4462 * @return 0 on success, a negative AVERROR on error
4464 int av_packet_from_data(AVPacket *pkt, uint8_t *data, int size);
4466 #if FF_API_AVPACKET_OLD_API
4468 * @warning This is a hack - the packet memory allocation stuff is broken. The
4469 * packet is allocated if it was not really allocated.
4471 * @deprecated Use av_packet_ref or av_packet_make_refcounted
4473 attribute_deprecated
4474 int av_dup_packet(AVPacket *pkt);
4476 * Copy packet, including contents
4478 * @return 0 on success, negative AVERROR on fail
4480 * @deprecated Use av_packet_ref
4482 attribute_deprecated
4483 int av_copy_packet(AVPacket *dst, const AVPacket *src);
4486 * Copy packet side data
4488 * @return 0 on success, negative AVERROR on fail
4490 * @deprecated Use av_packet_copy_props
4492 attribute_deprecated
4493 int av_copy_packet_side_data(AVPacket *dst, const AVPacket *src);
4498 * @deprecated Use av_packet_unref
4500 * @param pkt packet to free
4502 attribute_deprecated
4503 void av_free_packet(AVPacket *pkt);
4506 * Allocate new information of a packet.
4509 * @param type side information type
4510 * @param size side information size
4511 * @return pointer to fresh allocated data or NULL otherwise
4513 uint8_t* av_packet_new_side_data(AVPacket *pkt, enum AVPacketSideDataType type,
4517 * Wrap an existing array as a packet side data.
4520 * @param type side information type
4521 * @param data the side data array. It must be allocated with the av_malloc()
4522 * family of functions. The ownership of the data is transferred to
4524 * @param size side information size
4525 * @return a non-negative number on success, a negative AVERROR code on
4526 * failure. On failure, the packet is unchanged and the data remains
4527 * owned by the caller.
4529 int av_packet_add_side_data(AVPacket *pkt, enum AVPacketSideDataType type,
4530 uint8_t *data, size_t size);
4533 * Shrink the already allocated side data buffer
4536 * @param type side information type
4537 * @param size new side information size
4538 * @return 0 on success, < 0 on failure
4540 int av_packet_shrink_side_data(AVPacket *pkt, enum AVPacketSideDataType type,
4544 * Get side information from packet.
4547 * @param type desired side information type
4548 * @param size pointer for side information size to store (optional)
4549 * @return pointer to data if present or NULL otherwise
4551 uint8_t* av_packet_get_side_data(const AVPacket *pkt, enum AVPacketSideDataType type,
4554 #if FF_API_MERGE_SD_API
4555 attribute_deprecated
4556 int av_packet_merge_side_data(AVPacket *pkt);
4558 attribute_deprecated
4559 int av_packet_split_side_data(AVPacket *pkt);
4562 const char *av_packet_side_data_name(enum AVPacketSideDataType type);
4565 * Pack a dictionary for use in side_data.
4567 * @param dict The dictionary to pack.
4568 * @param size pointer to store the size of the returned data
4569 * @return pointer to data if successful, NULL otherwise
4571 uint8_t *av_packet_pack_dictionary(AVDictionary *dict, int *size);
4573 * Unpack a dictionary from side_data.
4575 * @param data data from side_data
4576 * @param size size of the data
4577 * @param dict the metadata storage dictionary
4578 * @return 0 on success, < 0 on failure
4580 int av_packet_unpack_dictionary(const uint8_t *data, int size, AVDictionary **dict);
4584 * Convenience function to free all the side data stored.
4585 * All the other fields stay untouched.
4589 void av_packet_free_side_data(AVPacket *pkt);
4592 * Setup a new reference to the data described by a given packet
4594 * If src is reference-counted, setup dst as a new reference to the
4595 * buffer in src. Otherwise allocate a new buffer in dst and copy the
4596 * data from src into it.
4598 * All the other fields are copied from src.
4600 * @see av_packet_unref
4602 * @param dst Destination packet
4603 * @param src Source packet
4605 * @return 0 on success, a negative AVERROR on error.
4607 int av_packet_ref(AVPacket *dst, const AVPacket *src);
4612 * Unreference the buffer referenced by the packet and reset the
4613 * remaining packet fields to their default values.
4615 * @param pkt The packet to be unreferenced.
4617 void av_packet_unref(AVPacket *pkt);
4620 * Move every field in src to dst and reset src.
4622 * @see av_packet_unref
4624 * @param src Source packet, will be reset
4625 * @param dst Destination packet
4627 void av_packet_move_ref(AVPacket *dst, AVPacket *src);
4630 * Copy only "properties" fields from src to dst.
4632 * Properties for the purpose of this function are all the fields
4633 * beside those related to the packet data (buf, data, size)
4635 * @param dst Destination packet
4636 * @param src Source packet
4638 * @return 0 on success AVERROR on failure.
4640 int av_packet_copy_props(AVPacket *dst, const AVPacket *src);
4643 * Ensure the data described by a given packet is reference counted.
4645 * @note This function does not ensure that the reference will be writable.
4646 * Use av_packet_make_writable instead for that purpose.
4648 * @see av_packet_ref
4649 * @see av_packet_make_writable
4651 * @param pkt packet whose data should be made reference counted.
4653 * @return 0 on success, a negative AVERROR on error. On failure, the
4654 * packet is unchanged.
4656 int av_packet_make_refcounted(AVPacket *pkt);
4659 * Create a writable reference for the data described by a given packet,
4660 * avoiding data copy if possible.
4662 * @param pkt Packet whose data should be made writable.
4664 * @return 0 on success, a negative AVERROR on failure. On failure, the
4665 * packet is unchanged.
4667 int av_packet_make_writable(AVPacket *pkt);
4670 * Convert valid timing fields (timestamps / durations) in a packet from one
4671 * timebase to another. Timestamps with unknown values (AV_NOPTS_VALUE) will be
4674 * @param pkt packet on which the conversion will be performed
4675 * @param tb_src source timebase, in which the timing fields in pkt are
4677 * @param tb_dst destination timebase, to which the timing fields will be
4680 void av_packet_rescale_ts(AVPacket *pkt, AVRational tb_src, AVRational tb_dst);
4687 * @addtogroup lavc_decoding
4692 * Find a registered decoder with a matching codec ID.
4694 * @param id AVCodecID of the requested decoder
4695 * @return A decoder if one was found, NULL otherwise.
4697 AVCodec *avcodec_find_decoder(enum AVCodecID id);
4700 * Find a registered decoder with the specified name.
4702 * @param name name of the requested decoder
4703 * @return A decoder if one was found, NULL otherwise.
4705 AVCodec *avcodec_find_decoder_by_name(const char *name);
4708 * The default callback for AVCodecContext.get_buffer2(). It is made public so
4709 * it can be called by custom get_buffer2() implementations for decoders without
4710 * AV_CODEC_CAP_DR1 set.
4712 int avcodec_default_get_buffer2(AVCodecContext *s, AVFrame *frame, int flags);
4715 * Modify width and height values so that they will result in a memory
4716 * buffer that is acceptable for the codec if you do not use any horizontal
4719 * May only be used if a codec with AV_CODEC_CAP_DR1 has been opened.
4721 void avcodec_align_dimensions(AVCodecContext *s, int *width, int *height);
4724 * Modify width and height values so that they will result in a memory
4725 * buffer that is acceptable for the codec if you also ensure that all
4726 * line sizes are a multiple of the respective linesize_align[i].
4728 * May only be used if a codec with AV_CODEC_CAP_DR1 has been opened.
4730 void avcodec_align_dimensions2(AVCodecContext *s, int *width, int *height,
4731 int linesize_align[AV_NUM_DATA_POINTERS]);
4734 * Converts AVChromaLocation to swscale x/y chroma position.
4736 * The positions represent the chroma (0,0) position in a coordinates system
4737 * with luma (0,0) representing the origin and luma(1,1) representing 256,256
4739 * @param xpos horizontal chroma sample position
4740 * @param ypos vertical chroma sample position
4742 int avcodec_enum_to_chroma_pos(int *xpos, int *ypos, enum AVChromaLocation pos);
4745 * Converts swscale x/y chroma position to AVChromaLocation.
4747 * The positions represent the chroma (0,0) position in a coordinates system
4748 * with luma (0,0) representing the origin and luma(1,1) representing 256,256
4750 * @param xpos horizontal chroma sample position
4751 * @param ypos vertical chroma sample position
4753 enum AVChromaLocation avcodec_chroma_pos_to_enum(int xpos, int ypos);
4756 * Decode the audio frame of size avpkt->size from avpkt->data into frame.
4758 * Some decoders may support multiple frames in a single AVPacket. Such
4759 * decoders would then just decode the first frame and the return value would be
4760 * less than the packet size. In this case, avcodec_decode_audio4 has to be
4761 * called again with an AVPacket containing the remaining data in order to
4762 * decode the second frame, etc... Even if no frames are returned, the packet
4763 * needs to be fed to the decoder with remaining data until it is completely
4764 * consumed or an error occurs.
4766 * Some decoders (those marked with AV_CODEC_CAP_DELAY) have a delay between input
4767 * and output. This means that for some packets they will not immediately
4768 * produce decoded output and need to be flushed at the end of decoding to get
4769 * all the decoded data. Flushing is done by calling this function with packets
4770 * with avpkt->data set to NULL and avpkt->size set to 0 until it stops
4771 * returning samples. It is safe to flush even those decoders that are not
4772 * marked with AV_CODEC_CAP_DELAY, then no samples will be returned.
4774 * @warning The input buffer, avpkt->data must be AV_INPUT_BUFFER_PADDING_SIZE
4775 * larger than the actual read bytes because some optimized bitstream
4776 * readers read 32 or 64 bits at once and could read over the end.
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] frame The AVFrame in which to store decoded audio samples.
4783 * The decoder will allocate a buffer for the decoded frame by
4784 * calling the AVCodecContext.get_buffer2() callback.
4785 * When AVCodecContext.refcounted_frames is set to 1, the frame is
4786 * reference counted and the returned reference belongs to the
4787 * caller. The caller must release the frame using av_frame_unref()
4788 * when the frame is no longer needed. The caller may safely write
4789 * to the frame if av_frame_is_writable() returns 1.
4790 * When AVCodecContext.refcounted_frames is set to 0, the returned
4791 * reference belongs to the decoder and is valid only until the
4792 * next call to this function or until closing or flushing the
4793 * decoder. The caller may not write to it.
4794 * @param[out] got_frame_ptr Zero if no frame could be decoded, otherwise it is
4795 * non-zero. Note that this field being set to zero
4796 * does not mean that an error has occurred. For
4797 * decoders with AV_CODEC_CAP_DELAY set, no given decode
4798 * call is guaranteed to produce a frame.
4799 * @param[in] avpkt The input AVPacket containing the input buffer.
4800 * At least avpkt->data and avpkt->size should be set. Some
4801 * decoders might also require additional fields to be set.
4802 * @return A negative error code is returned if an error occurred during
4803 * decoding, otherwise the number of bytes consumed from the input
4804 * AVPacket is returned.
4806 * @deprecated Use avcodec_send_packet() and avcodec_receive_frame().
4808 attribute_deprecated
4809 int avcodec_decode_audio4(AVCodecContext *avctx, AVFrame *frame,
4810 int *got_frame_ptr, const AVPacket *avpkt);
4813 * Decode the video frame of size avpkt->size from avpkt->data into picture.
4814 * Some decoders may support multiple frames in a single AVPacket, such
4815 * decoders would then just decode the first frame.
4817 * @warning The input buffer must be AV_INPUT_BUFFER_PADDING_SIZE larger than
4818 * the actual read bytes because some optimized bitstream readers read 32 or 64
4819 * bits at once and could read over the end.
4821 * @warning The end of the input buffer buf should be set to 0 to ensure that
4822 * no overreading happens for damaged MPEG streams.
4824 * @note Codecs which have the AV_CODEC_CAP_DELAY capability set have a delay
4825 * between input and output, these need to be fed with avpkt->data=NULL,
4826 * avpkt->size=0 at the end to return the remaining frames.
4828 * @note The AVCodecContext MUST have been opened with @ref avcodec_open2()
4829 * before packets may be fed to the decoder.
4831 * @param avctx the codec context
4832 * @param[out] picture The AVFrame in which the decoded video frame will be stored.
4833 * Use av_frame_alloc() to get an AVFrame. The codec will
4834 * allocate memory for the actual bitmap by calling the
4835 * AVCodecContext.get_buffer2() callback.
4836 * When AVCodecContext.refcounted_frames is set to 1, the frame is
4837 * reference counted and the returned reference belongs to the
4838 * caller. The caller must release the frame using av_frame_unref()
4839 * when the frame is no longer needed. The caller may safely write
4840 * to the frame if av_frame_is_writable() returns 1.
4841 * When AVCodecContext.refcounted_frames is set to 0, the returned
4842 * reference belongs to the decoder and is valid only until the
4843 * next call to this function or until closing or flushing the
4844 * decoder. The caller may not write to it.
4846 * @param[in] avpkt The input AVPacket containing the input buffer.
4847 * You can create such packet with av_init_packet() and by then setting
4848 * data and size, some decoders might in addition need other fields like
4849 * flags&AV_PKT_FLAG_KEY. All decoders are designed to use the least
4851 * @param[in,out] got_picture_ptr Zero if no frame could be decompressed, otherwise, it is nonzero.
4852 * @return On error a negative value is returned, otherwise the number of bytes
4853 * used or zero if no frame could be decompressed.
4855 * @deprecated Use avcodec_send_packet() and avcodec_receive_frame().
4857 attribute_deprecated
4858 int avcodec_decode_video2(AVCodecContext *avctx, AVFrame *picture,
4859 int *got_picture_ptr,
4860 const AVPacket *avpkt);
4863 * Decode a subtitle message.
4864 * Return a negative value on error, otherwise return the number of bytes used.
4865 * If no subtitle could be decompressed, got_sub_ptr is zero.
4866 * Otherwise, the subtitle is stored in *sub.
4867 * Note that AV_CODEC_CAP_DR1 is not available for subtitle codecs. This is for
4868 * simplicity, because the performance difference is expect to be negligible
4869 * and reusing a get_buffer written for video codecs would probably perform badly
4870 * due to a potentially very different allocation pattern.
4872 * Some decoders (those marked with AV_CODEC_CAP_DELAY) have a delay between input
4873 * and output. This means that for some packets they will not immediately
4874 * produce decoded output and need to be flushed at the end of decoding to get
4875 * all the decoded data. Flushing is done by calling this function with packets
4876 * with avpkt->data set to NULL and avpkt->size set to 0 until it stops
4877 * returning subtitles. It is safe to flush even those decoders that are not
4878 * marked with AV_CODEC_CAP_DELAY, then no subtitles will be returned.
4880 * @note The AVCodecContext MUST have been opened with @ref avcodec_open2()
4881 * before packets may be fed to the decoder.
4883 * @param avctx the codec context
4884 * @param[out] sub The Preallocated AVSubtitle in which the decoded subtitle will be stored,
4885 * must be freed with avsubtitle_free if *got_sub_ptr is set.
4886 * @param[in,out] got_sub_ptr Zero if no subtitle could be decompressed, otherwise, it is nonzero.
4887 * @param[in] avpkt The input AVPacket containing the input buffer.
4889 int avcodec_decode_subtitle2(AVCodecContext *avctx, AVSubtitle *sub,
4894 * Supply raw packet data as input to a decoder.
4896 * Internally, this call will copy relevant AVCodecContext fields, which can
4897 * influence decoding per-packet, and apply them when the packet is actually
4898 * decoded. (For example AVCodecContext.skip_frame, which might direct the
4899 * decoder to drop the frame contained by the packet sent with this function.)
4901 * @warning The input buffer, avpkt->data must be AV_INPUT_BUFFER_PADDING_SIZE
4902 * larger than the actual read bytes because some optimized bitstream
4903 * readers read 32 or 64 bits at once and could read over the end.
4905 * @warning Do not mix this API with the legacy API (like avcodec_decode_video2())
4906 * on the same AVCodecContext. It will return unexpected results now
4907 * or in future libavcodec versions.
4909 * @note The AVCodecContext MUST have been opened with @ref avcodec_open2()
4910 * before packets may be fed to the decoder.
4912 * @param avctx codec context
4913 * @param[in] avpkt The input AVPacket. Usually, this will be a single video
4914 * frame, or several complete audio frames.
4915 * Ownership of the packet remains with the caller, and the
4916 * decoder will not write to the packet. The decoder may create
4917 * a reference to the packet data (or copy it if the packet is
4918 * not reference-counted).
4919 * Unlike with older APIs, the packet is always fully consumed,
4920 * and if it contains multiple frames (e.g. some audio codecs),
4921 * will require you to call avcodec_receive_frame() multiple
4922 * times afterwards before you can send a new packet.
4923 * It can be NULL (or an AVPacket with data set to NULL and
4924 * size set to 0); in this case, it is considered a flush
4925 * packet, which signals the end of the stream. Sending the
4926 * first flush packet will return success. Subsequent ones are
4927 * unnecessary and will return AVERROR_EOF. If the decoder
4928 * still has frames buffered, it will return them after sending
4931 * @return 0 on success, otherwise negative error code:
4932 * AVERROR(EAGAIN): input is not accepted in the current state - user
4933 * must read output with avcodec_receive_frame() (once
4934 * all output is read, the packet should be resent, and
4935 * the call will not fail with EAGAIN).
4936 * AVERROR_EOF: the decoder has been flushed, and no new packets can
4937 * be sent to it (also returned if more than 1 flush
4939 * AVERROR(EINVAL): codec not opened, it is an encoder, or requires flush
4940 * AVERROR(ENOMEM): failed to add packet to internal queue, or similar
4941 * other errors: legitimate decoding errors
4943 int avcodec_send_packet(AVCodecContext *avctx, const AVPacket *avpkt);
4946 * Return decoded output data from a decoder.
4948 * @param avctx codec context
4949 * @param frame This will be set to a reference-counted video or audio
4950 * frame (depending on the decoder type) allocated by the
4951 * decoder. Note that the function will always call
4952 * av_frame_unref(frame) before doing anything else.
4955 * 0: success, a frame was returned
4956 * AVERROR(EAGAIN): output is not available in this state - user must try
4958 * AVERROR_EOF: the decoder has been fully flushed, and there will be
4959 * no more output frames
4960 * AVERROR(EINVAL): codec not opened, or it is an encoder
4961 * AVERROR_INPUT_CHANGED: current decoded frame has changed parameters
4962 * with respect to first decoded frame. Applicable
4963 * when flag AV_CODEC_FLAG_DROPCHANGED is set.
4964 * other negative values: legitimate decoding errors
4966 int avcodec_receive_frame(AVCodecContext *avctx, AVFrame *frame);
4969 * Supply a raw video or audio frame to the encoder. Use avcodec_receive_packet()
4970 * to retrieve buffered output packets.
4972 * @param avctx codec context
4973 * @param[in] frame AVFrame containing the raw audio or video frame to be encoded.
4974 * Ownership of the frame remains with the caller, and the
4975 * encoder will not write to the frame. The encoder may create
4976 * a reference to the frame data (or copy it if the frame is
4977 * not reference-counted).
4978 * It can be NULL, in which case it is considered a flush
4979 * packet. This signals the end of the stream. If the encoder
4980 * still has packets buffered, it will return them after this
4981 * call. Once flushing mode has been entered, additional flush
4982 * packets are ignored, and sending frames will return
4986 * If AV_CODEC_CAP_VARIABLE_FRAME_SIZE is set, then each frame
4987 * can have any number of samples.
4988 * If it is not set, frame->nb_samples must be equal to
4989 * avctx->frame_size for all frames except the last.
4990 * The final frame may be smaller than avctx->frame_size.
4991 * @return 0 on success, otherwise negative error code:
4992 * AVERROR(EAGAIN): input is not accepted in the current state - user
4993 * must read output with avcodec_receive_packet() (once
4994 * all output is read, the packet should be resent, and
4995 * the call will not fail with EAGAIN).
4996 * AVERROR_EOF: the encoder has been flushed, and no new frames can
4998 * AVERROR(EINVAL): codec not opened, refcounted_frames not set, it is a
4999 * decoder, or requires flush
5000 * AVERROR(ENOMEM): failed to add packet to internal queue, or similar
5001 * other errors: legitimate decoding errors
5003 int avcodec_send_frame(AVCodecContext *avctx, const AVFrame *frame);
5006 * Read encoded data from the encoder.
5008 * @param avctx codec context
5009 * @param avpkt This will be set to a reference-counted packet allocated by the
5010 * encoder. Note that the function will always call
5011 * av_frame_unref(frame) before doing anything else.
5012 * @return 0 on success, otherwise negative error code:
5013 * AVERROR(EAGAIN): output is not available in the current state - user
5014 * must try to send input
5015 * AVERROR_EOF: the encoder has been fully flushed, and there will be
5016 * no more output packets
5017 * AVERROR(EINVAL): codec not opened, or it is an encoder
5018 * other errors: legitimate decoding errors
5020 int avcodec_receive_packet(AVCodecContext *avctx, AVPacket *avpkt);
5023 * Create and return a AVHWFramesContext with values adequate for hardware
5024 * decoding. This is meant to get called from the get_format callback, and is
5025 * a helper for preparing a AVHWFramesContext for AVCodecContext.hw_frames_ctx.
5026 * This API is for decoding with certain hardware acceleration modes/APIs only.
5028 * The returned AVHWFramesContext is not initialized. The caller must do this
5029 * with av_hwframe_ctx_init().
5031 * Calling this function is not a requirement, but makes it simpler to avoid
5032 * codec or hardware API specific details when manually allocating frames.
5034 * Alternatively to this, an API user can set AVCodecContext.hw_device_ctx,
5035 * which sets up AVCodecContext.hw_frames_ctx fully automatically, and makes
5036 * it unnecessary to call this function or having to care about
5037 * AVHWFramesContext initialization at all.
5039 * There are a number of requirements for calling this function:
5041 * - It must be called from get_format with the same avctx parameter that was
5042 * passed to get_format. Calling it outside of get_format is not allowed, and
5043 * can trigger undefined behavior.
5044 * - The function is not always supported (see description of return values).
5045 * Even if this function returns successfully, hwaccel initialization could
5046 * fail later. (The degree to which implementations check whether the stream
5047 * is actually supported varies. Some do this check only after the user's
5048 * get_format callback returns.)
5049 * - The hw_pix_fmt must be one of the choices suggested by get_format. If the
5050 * user decides to use a AVHWFramesContext prepared with this API function,
5051 * the user must return the same hw_pix_fmt from get_format.
5052 * - The device_ref passed to this function must support the given hw_pix_fmt.
5053 * - After calling this API function, it is the user's responsibility to
5054 * initialize the AVHWFramesContext (returned by the out_frames_ref parameter),
5055 * and to set AVCodecContext.hw_frames_ctx to it. If done, this must be done
5056 * before returning from get_format (this is implied by the normal
5057 * AVCodecContext.hw_frames_ctx API rules).
5058 * - The AVHWFramesContext parameters may change every time time get_format is
5059 * called. Also, AVCodecContext.hw_frames_ctx is reset before get_format. So
5060 * you are inherently required to go through this process again on every
5062 * - It is perfectly possible to call this function without actually using
5063 * the resulting AVHWFramesContext. One use-case might be trying to reuse a
5064 * previously initialized AVHWFramesContext, and calling this API function
5065 * only to test whether the required frame parameters have changed.
5066 * - Fields that use dynamically allocated values of any kind must not be set
5067 * by the user unless setting them is explicitly allowed by the documentation.
5068 * If the user sets AVHWFramesContext.free and AVHWFramesContext.user_opaque,
5069 * the new free callback must call the potentially set previous free callback.
5070 * This API call may set any dynamically allocated fields, including the free
5073 * The function will set at least the following fields on AVHWFramesContext
5074 * (potentially more, depending on hwaccel API):
5076 * - All fields set by av_hwframe_ctx_alloc().
5077 * - Set the format field to hw_pix_fmt.
5078 * - Set the sw_format field to the most suited and most versatile format. (An
5079 * implication is that this will prefer generic formats over opaque formats
5080 * with arbitrary restrictions, if possible.)
5081 * - Set the width/height fields to the coded frame size, rounded up to the
5082 * API-specific minimum alignment.
5083 * - Only _if_ the hwaccel requires a pre-allocated pool: set the initial_pool_size
5084 * field to the number of maximum reference surfaces possible with the codec,
5085 * plus 1 surface for the user to work (meaning the user can safely reference
5086 * at most 1 decoded surface at a time), plus additional buffering introduced
5087 * by frame threading. If the hwaccel does not require pre-allocation, the
5088 * field is left to 0, and the decoder will allocate new surfaces on demand
5090 * - Possibly AVHWFramesContext.hwctx fields, depending on the underlying
5093 * Essentially, out_frames_ref returns the same as av_hwframe_ctx_alloc(), but
5094 * with basic frame parameters set.
5096 * The function is stateless, and does not change the AVCodecContext or the
5097 * device_ref AVHWDeviceContext.
5099 * @param avctx The context which is currently calling get_format, and which
5100 * implicitly contains all state needed for filling the returned
5101 * AVHWFramesContext properly.
5102 * @param device_ref A reference to the AVHWDeviceContext describing the device
5103 * which will be used by the hardware decoder.
5104 * @param hw_pix_fmt The hwaccel format you are going to return from get_format.
5105 * @param out_frames_ref On success, set to a reference to an _uninitialized_
5106 * AVHWFramesContext, created from the given device_ref.
5107 * Fields will be set to values required for decoding.
5108 * Not changed if an error is returned.
5109 * @return zero on success, a negative value on error. The following error codes
5110 * have special semantics:
5111 * AVERROR(ENOENT): the decoder does not support this functionality. Setup
5112 * is always manual, or it is a decoder which does not
5113 * support setting AVCodecContext.hw_frames_ctx at all,
5114 * or it is a software format.
5115 * AVERROR(EINVAL): it is known that hardware decoding is not supported for
5116 * this configuration, or the device_ref is not supported
5117 * for the hwaccel referenced by hw_pix_fmt.
5119 int avcodec_get_hw_frames_parameters(AVCodecContext *avctx,
5120 AVBufferRef *device_ref,
5121 enum AVPixelFormat hw_pix_fmt,
5122 AVBufferRef **out_frames_ref);
5127 * @defgroup lavc_parsing Frame parsing
5131 enum AVPictureStructure {
5132 AV_PICTURE_STRUCTURE_UNKNOWN, //< unknown
5133 AV_PICTURE_STRUCTURE_TOP_FIELD, //< coded as top field
5134 AV_PICTURE_STRUCTURE_BOTTOM_FIELD, //< coded as bottom field
5135 AV_PICTURE_STRUCTURE_FRAME, //< coded as frame
5138 typedef struct AVCodecParserContext {
5140 struct AVCodecParser *parser;
5141 int64_t frame_offset; /* offset of the current frame */
5142 int64_t cur_offset; /* current offset
5143 (incremented by each av_parser_parse()) */
5144 int64_t next_frame_offset; /* offset of the next frame */
5146 int pict_type; /* XXX: Put it back in AVCodecContext. */
5148 * This field is used for proper frame duration computation in lavf.
5149 * It signals, how much longer the frame duration of the current frame
5150 * is compared to normal frame duration.
5152 * frame_duration = (1 + repeat_pict) * time_base
5154 * It is used by codecs like H.264 to display telecined material.
5156 int repeat_pict; /* XXX: Put it back in AVCodecContext. */
5157 int64_t pts; /* pts of the current frame */
5158 int64_t dts; /* dts of the current frame */
5163 int fetch_timestamp;
5165 #define AV_PARSER_PTS_NB 4
5166 int cur_frame_start_index;
5167 int64_t cur_frame_offset[AV_PARSER_PTS_NB];
5168 int64_t cur_frame_pts[AV_PARSER_PTS_NB];
5169 int64_t cur_frame_dts[AV_PARSER_PTS_NB];
5172 #define PARSER_FLAG_COMPLETE_FRAMES 0x0001
5173 #define PARSER_FLAG_ONCE 0x0002
5174 /// Set if the parser has a valid file offset
5175 #define PARSER_FLAG_FETCHED_OFFSET 0x0004
5176 #define PARSER_FLAG_USE_CODEC_TS 0x1000
5178 int64_t offset; ///< byte offset from starting packet start
5179 int64_t cur_frame_end[AV_PARSER_PTS_NB];
5182 * Set by parser to 1 for key frames and 0 for non-key frames.
5183 * It is initialized to -1, so if the parser doesn't set this flag,
5184 * old-style fallback using AV_PICTURE_TYPE_I picture type as key frames
5189 #if FF_API_CONVERGENCE_DURATION
5191 * @deprecated unused
5193 attribute_deprecated
5194 int64_t convergence_duration;
5197 // Timestamp generation support:
5199 * Synchronization point for start of timestamp generation.
5201 * Set to >0 for sync point, 0 for no sync point and <0 for undefined
5204 * For example, this corresponds to presence of H.264 buffering period
5210 * Offset of the current timestamp against last timestamp sync point in
5211 * units of AVCodecContext.time_base.
5213 * Set to INT_MIN when dts_sync_point unused. Otherwise, it must
5214 * contain a valid timestamp offset.
5216 * Note that the timestamp of sync point has usually a nonzero
5217 * dts_ref_dts_delta, which refers to the previous sync point. Offset of
5218 * the next frame after timestamp sync point will be usually 1.
5220 * For example, this corresponds to H.264 cpb_removal_delay.
5222 int dts_ref_dts_delta;
5225 * Presentation delay of current frame in units of AVCodecContext.time_base.
5227 * Set to INT_MIN when dts_sync_point unused. Otherwise, it must
5228 * contain valid non-negative timestamp delta (presentation time of a frame
5229 * must not lie in the past).
5231 * This delay represents the difference between decoding and presentation
5232 * time of the frame.
5234 * For example, this corresponds to H.264 dpb_output_delay.
5239 * Position of the packet in file.
5241 * Analogous to cur_frame_pts/dts
5243 int64_t cur_frame_pos[AV_PARSER_PTS_NB];
5246 * Byte position of currently parsed frame in stream.
5251 * Previous frame byte position.
5256 * Duration of the current frame.
5257 * For audio, this is in units of 1 / AVCodecContext.sample_rate.
5258 * For all other types, this is in units of AVCodecContext.time_base.
5262 enum AVFieldOrder field_order;
5265 * Indicate whether a picture is coded as a frame, top field or bottom field.
5267 * For example, H.264 field_pic_flag equal to 0 corresponds to
5268 * AV_PICTURE_STRUCTURE_FRAME. An H.264 picture with field_pic_flag
5269 * equal to 1 and bottom_field_flag equal to 0 corresponds to
5270 * AV_PICTURE_STRUCTURE_TOP_FIELD.
5272 enum AVPictureStructure picture_structure;
5275 * Picture number incremented in presentation or output order.
5276 * This field may be reinitialized at the first picture of a new sequence.
5278 * For example, this corresponds to H.264 PicOrderCnt.
5280 int output_picture_number;
5283 * Dimensions of the decoded video intended for presentation.
5289 * Dimensions of the coded video.
5295 * The format of the coded data, corresponds to enum AVPixelFormat for video
5296 * and for enum AVSampleFormat for audio.
5298 * Note that a decoder can have considerable freedom in how exactly it
5299 * decodes the data, so the format reported here might be different from the
5300 * one returned by a decoder.
5303 } AVCodecParserContext;
5305 typedef struct AVCodecParser {
5306 int codec_ids[5]; /* several codec IDs are permitted */
5308 int (*parser_init)(AVCodecParserContext *s);
5309 /* This callback never returns an error, a negative value means that
5310 * the frame start was in a previous packet. */
5311 int (*parser_parse)(AVCodecParserContext *s,
5312 AVCodecContext *avctx,
5313 const uint8_t **poutbuf, int *poutbuf_size,
5314 const uint8_t *buf, int buf_size);
5315 void (*parser_close)(AVCodecParserContext *s);
5316 int (*split)(AVCodecContext *avctx, const uint8_t *buf, int buf_size);
5317 struct AVCodecParser *next;
5321 * Iterate over all registered codec parsers.
5323 * @param opaque a pointer where libavcodec will store the iteration state. Must
5324 * point to NULL to start the iteration.
5326 * @return the next registered codec parser or NULL when the iteration is
5329 const AVCodecParser *av_parser_iterate(void **opaque);
5331 attribute_deprecated
5332 AVCodecParser *av_parser_next(const AVCodecParser *c);
5334 attribute_deprecated
5335 void av_register_codec_parser(AVCodecParser *parser);
5336 AVCodecParserContext *av_parser_init(int codec_id);
5341 * @param s parser context.
5342 * @param avctx codec context.
5343 * @param poutbuf set to pointer to parsed buffer or NULL if not yet finished.
5344 * @param poutbuf_size set to size of parsed buffer or zero if not yet finished.
5345 * @param buf input buffer.
5346 * @param buf_size buffer size in bytes without the padding. I.e. the full buffer
5347 size is assumed to be buf_size + AV_INPUT_BUFFER_PADDING_SIZE.
5348 To signal EOF, this should be 0 (so that the last frame
5350 * @param pts input presentation timestamp.
5351 * @param dts input decoding timestamp.
5352 * @param pos input byte position in stream.
5353 * @return the number of bytes of the input bitstream used.
5358 * len = av_parser_parse2(myparser, AVCodecContext, &data, &size,
5365 * decode_frame(data, size);
5369 int av_parser_parse2(AVCodecParserContext *s,
5370 AVCodecContext *avctx,
5371 uint8_t **poutbuf, int *poutbuf_size,
5372 const uint8_t *buf, int buf_size,
5373 int64_t pts, int64_t dts,
5377 * @return 0 if the output buffer is a subset of the input, 1 if it is allocated and must be freed
5378 * @deprecated use AVBitStreamFilter
5380 int av_parser_change(AVCodecParserContext *s,
5381 AVCodecContext *avctx,
5382 uint8_t **poutbuf, int *poutbuf_size,
5383 const uint8_t *buf, int buf_size, int keyframe);
5384 void av_parser_close(AVCodecParserContext *s);
5392 * @addtogroup lavc_encoding
5397 * Find a registered encoder with a matching codec ID.
5399 * @param id AVCodecID of the requested encoder
5400 * @return An encoder if one was found, NULL otherwise.
5402 AVCodec *avcodec_find_encoder(enum AVCodecID id);
5405 * Find a registered encoder with the specified name.
5407 * @param name name of the requested encoder
5408 * @return An encoder if one was found, NULL otherwise.
5410 AVCodec *avcodec_find_encoder_by_name(const char *name);
5413 * Encode a frame of audio.
5415 * Takes input samples from frame and writes the next output packet, if
5416 * available, to avpkt. The output packet does not necessarily contain data for
5417 * the most recent frame, as encoders can delay, split, and combine input frames
5418 * internally as needed.
5420 * @param avctx codec context
5421 * @param avpkt output AVPacket.
5422 * The user can supply an output buffer by setting
5423 * avpkt->data and avpkt->size prior to calling the
5424 * function, but if the size of the user-provided data is not
5425 * large enough, encoding will fail. If avpkt->data and
5426 * avpkt->size are set, avpkt->destruct must also be set. All
5427 * other AVPacket fields will be reset by the encoder using
5428 * av_init_packet(). If avpkt->data is NULL, the encoder will
5429 * allocate it. The encoder will set avpkt->size to the size
5430 * of the output packet.
5432 * If this function fails or produces no output, avpkt will be
5433 * freed using av_packet_unref().
5434 * @param[in] frame AVFrame containing the raw audio data to be encoded.
5435 * May be NULL when flushing an encoder that has the
5436 * AV_CODEC_CAP_DELAY capability set.
5437 * If AV_CODEC_CAP_VARIABLE_FRAME_SIZE is set, then each frame
5438 * can have any number of samples.
5439 * If it is not set, frame->nb_samples must be equal to
5440 * avctx->frame_size for all frames except the last.
5441 * The final frame may be smaller than avctx->frame_size.
5442 * @param[out] got_packet_ptr This field is set to 1 by libavcodec if the
5443 * output packet is non-empty, and to 0 if it is
5444 * empty. If the function returns an error, the
5445 * packet can be assumed to be invalid, and the
5446 * value of got_packet_ptr is undefined and should
5448 * @return 0 on success, negative error code on failure
5450 * @deprecated use avcodec_send_frame()/avcodec_receive_packet() instead
5452 attribute_deprecated
5453 int avcodec_encode_audio2(AVCodecContext *avctx, AVPacket *avpkt,
5454 const AVFrame *frame, int *got_packet_ptr);
5457 * Encode a frame of video.
5459 * Takes input raw video data from frame and writes the next output packet, if
5460 * available, to avpkt. The output packet does not necessarily contain data for
5461 * the most recent frame, as encoders can delay and reorder input frames
5462 * internally as needed.
5464 * @param avctx codec context
5465 * @param avpkt output AVPacket.
5466 * The user can supply an output buffer by setting
5467 * avpkt->data and avpkt->size prior to calling the
5468 * function, but if the size of the user-provided data is not
5469 * large enough, encoding will fail. All other AVPacket fields
5470 * will be reset by the encoder using av_init_packet(). If
5471 * avpkt->data is NULL, the encoder will allocate it.
5472 * The encoder will set avpkt->size to the size of the
5473 * output packet. The returned data (if any) belongs to the
5474 * caller, he is responsible for freeing it.
5476 * If this function fails or produces no output, avpkt will be
5477 * freed using av_packet_unref().
5478 * @param[in] frame AVFrame containing the raw video data to be encoded.
5479 * May be NULL when flushing an encoder that has the
5480 * AV_CODEC_CAP_DELAY capability set.
5481 * @param[out] got_packet_ptr This field is set to 1 by libavcodec if the
5482 * output packet is non-empty, and to 0 if it is
5483 * empty. If the function returns an error, the
5484 * packet can be assumed to be invalid, and the
5485 * value of got_packet_ptr is undefined and should
5487 * @return 0 on success, negative error code on failure
5489 * @deprecated use avcodec_send_frame()/avcodec_receive_packet() instead
5491 attribute_deprecated
5492 int avcodec_encode_video2(AVCodecContext *avctx, AVPacket *avpkt,
5493 const AVFrame *frame, int *got_packet_ptr);
5495 int avcodec_encode_subtitle(AVCodecContext *avctx, uint8_t *buf, int buf_size,
5496 const AVSubtitle *sub);
5503 #if FF_API_AVPICTURE
5505 * @addtogroup lavc_picture
5510 * @deprecated unused
5512 attribute_deprecated
5513 int avpicture_alloc(AVPicture *picture, enum AVPixelFormat pix_fmt, int width, int height);
5516 * @deprecated unused
5518 attribute_deprecated
5519 void avpicture_free(AVPicture *picture);
5522 * @deprecated use av_image_fill_arrays() instead.
5524 attribute_deprecated
5525 int avpicture_fill(AVPicture *picture, const uint8_t *ptr,
5526 enum AVPixelFormat pix_fmt, int width, int height);
5529 * @deprecated use av_image_copy_to_buffer() instead.
5531 attribute_deprecated
5532 int avpicture_layout(const AVPicture *src, enum AVPixelFormat pix_fmt,
5533 int width, int height,
5534 unsigned char *dest, int dest_size);
5537 * @deprecated use av_image_get_buffer_size() instead.
5539 attribute_deprecated
5540 int avpicture_get_size(enum AVPixelFormat pix_fmt, int width, int height);
5543 * @deprecated av_image_copy() instead.
5545 attribute_deprecated
5546 void av_picture_copy(AVPicture *dst, const AVPicture *src,
5547 enum AVPixelFormat pix_fmt, int width, int height);
5550 * @deprecated unused
5552 attribute_deprecated
5553 int av_picture_crop(AVPicture *dst, const AVPicture *src,
5554 enum AVPixelFormat pix_fmt, int top_band, int left_band);
5557 * @deprecated unused
5559 attribute_deprecated
5560 int av_picture_pad(AVPicture *dst, const AVPicture *src, int height, int width, enum AVPixelFormat pix_fmt,
5561 int padtop, int padbottom, int padleft, int padright, int *color);
5569 * @defgroup lavc_misc Utility functions
5572 * Miscellaneous utility functions related to both encoding and decoding
5578 * @defgroup lavc_misc_pixfmt Pixel formats
5580 * Functions for working with pixel formats.
5584 #if FF_API_GETCHROMA
5586 * @deprecated Use av_pix_fmt_get_chroma_sub_sample
5589 attribute_deprecated
5590 void avcodec_get_chroma_sub_sample(enum AVPixelFormat pix_fmt, int *h_shift, int *v_shift);
5594 * Return a value representing the fourCC code associated to the
5595 * pixel format pix_fmt, or 0 if no associated fourCC code can be
5598 unsigned int avcodec_pix_fmt_to_codec_tag(enum AVPixelFormat pix_fmt);
5601 * @deprecated see av_get_pix_fmt_loss()
5603 int avcodec_get_pix_fmt_loss(enum AVPixelFormat dst_pix_fmt, enum AVPixelFormat src_pix_fmt,
5607 * Find the best pixel format to convert to given a certain source pixel
5608 * format. When converting from one pixel format to another, information loss
5609 * may occur. For example, when converting from RGB24 to GRAY, the color
5610 * information will be lost. Similarly, other losses occur when converting from
5611 * some formats to other formats. avcodec_find_best_pix_fmt_of_2() searches which of
5612 * the given pixel formats should be used to suffer the least amount of loss.
5613 * The pixel formats from which it chooses one, are determined by the
5614 * pix_fmt_list parameter.
5617 * @param[in] pix_fmt_list AV_PIX_FMT_NONE terminated array of pixel formats to choose from
5618 * @param[in] src_pix_fmt source pixel format
5619 * @param[in] has_alpha Whether the source pixel format alpha channel is used.
5620 * @param[out] loss_ptr Combination of flags informing you what kind of losses will occur.
5621 * @return The best pixel format to convert to or -1 if none was found.
5623 enum AVPixelFormat avcodec_find_best_pix_fmt_of_list(const enum AVPixelFormat *pix_fmt_list,
5624 enum AVPixelFormat src_pix_fmt,
5625 int has_alpha, int *loss_ptr);
5628 * @deprecated see av_find_best_pix_fmt_of_2()
5630 enum AVPixelFormat avcodec_find_best_pix_fmt_of_2(enum AVPixelFormat dst_pix_fmt1, enum AVPixelFormat dst_pix_fmt2,
5631 enum AVPixelFormat src_pix_fmt, int has_alpha, int *loss_ptr);
5633 attribute_deprecated
5634 enum AVPixelFormat avcodec_find_best_pix_fmt2(enum AVPixelFormat dst_pix_fmt1, enum AVPixelFormat dst_pix_fmt2,
5635 enum AVPixelFormat src_pix_fmt, int has_alpha, int *loss_ptr);
5637 enum AVPixelFormat avcodec_default_get_format(struct AVCodecContext *s, const enum AVPixelFormat * fmt);
5643 #if FF_API_TAG_STRING
5645 * Put a string representing the codec tag codec_tag in buf.
5647 * @param buf buffer to place codec tag in
5648 * @param buf_size size in bytes of buf
5649 * @param codec_tag codec tag to assign
5650 * @return the length of the string that would have been generated if
5651 * enough space had been available, excluding the trailing null
5653 * @deprecated see av_fourcc_make_string() and av_fourcc2str().
5655 attribute_deprecated
5656 size_t av_get_codec_tag_string(char *buf, size_t buf_size, unsigned int codec_tag);
5659 void avcodec_string(char *buf, int buf_size, AVCodecContext *enc, int encode);
5662 * Return a name for the specified profile, if available.
5664 * @param codec the codec that is searched for the given profile
5665 * @param profile the profile value for which a name is requested
5666 * @return A name for the profile if found, NULL otherwise.
5668 const char *av_get_profile_name(const AVCodec *codec, int profile);
5671 * Return a name for the specified profile, if available.
5673 * @param codec_id the ID of the codec to which the requested profile belongs
5674 * @param profile the profile value for which a name is requested
5675 * @return A name for the profile if found, NULL otherwise.
5677 * @note unlike av_get_profile_name(), which searches a list of profiles
5678 * supported by a specific decoder or encoder implementation, this
5679 * function searches the list of profiles from the AVCodecDescriptor
5681 const char *avcodec_profile_name(enum AVCodecID codec_id, int profile);
5683 int avcodec_default_execute(AVCodecContext *c, int (*func)(AVCodecContext *c2, void *arg2),void *arg, int *ret, int count, int size);
5684 int avcodec_default_execute2(AVCodecContext *c, int (*func)(AVCodecContext *c2, void *arg2, int, int),void *arg, int *ret, int count);
5685 //FIXME func typedef
5688 * Fill AVFrame audio data and linesize pointers.
5690 * The buffer buf must be a preallocated buffer with a size big enough
5691 * to contain the specified samples amount. The filled AVFrame data
5692 * pointers will point to this buffer.
5694 * AVFrame extended_data channel pointers are allocated if necessary for
5697 * @param frame the AVFrame
5698 * frame->nb_samples must be set prior to calling the
5699 * function. This function fills in frame->data,
5700 * frame->extended_data, frame->linesize[0].
5701 * @param nb_channels channel count
5702 * @param sample_fmt sample format
5703 * @param buf buffer to use for frame data
5704 * @param buf_size size of buffer
5705 * @param align plane size sample alignment (0 = default)
5706 * @return >=0 on success, negative error code on failure
5707 * @todo return the size in bytes required to store the samples in
5708 * case of success, at the next libavutil bump
5710 int avcodec_fill_audio_frame(AVFrame *frame, int nb_channels,
5711 enum AVSampleFormat sample_fmt, const uint8_t *buf,
5712 int buf_size, int align);
5715 * Reset the internal decoder state / flush internal buffers. Should be called
5716 * e.g. when seeking or when switching to a different stream.
5718 * @note when refcounted frames are not used (i.e. avctx->refcounted_frames is 0),
5719 * this invalidates the frames previously returned from the decoder. When
5720 * refcounted frames are used, the decoder just releases any references it might
5721 * keep internally, but the caller's reference remains valid.
5723 void avcodec_flush_buffers(AVCodecContext *avctx);
5726 * Return codec bits per sample.
5728 * @param[in] codec_id the codec
5729 * @return Number of bits per sample or zero if unknown for the given codec.
5731 int av_get_bits_per_sample(enum AVCodecID codec_id);
5734 * Return the PCM codec associated with a sample format.
5735 * @param be endianness, 0 for little, 1 for big,
5736 * -1 (or anything else) for native
5737 * @return AV_CODEC_ID_PCM_* or AV_CODEC_ID_NONE
5739 enum AVCodecID av_get_pcm_codec(enum AVSampleFormat fmt, int be);
5742 * Return codec bits per sample.
5743 * Only return non-zero if the bits per sample is exactly correct, not an
5746 * @param[in] codec_id the codec
5747 * @return Number of bits per sample or zero if unknown for the given codec.
5749 int av_get_exact_bits_per_sample(enum AVCodecID codec_id);
5752 * Return audio frame duration.
5754 * @param avctx codec context
5755 * @param frame_bytes size of the frame, or 0 if unknown
5756 * @return frame duration, in samples, if known. 0 if not able to
5759 int av_get_audio_frame_duration(AVCodecContext *avctx, int frame_bytes);
5762 * This function is the same as av_get_audio_frame_duration(), except it works
5763 * with AVCodecParameters instead of an AVCodecContext.
5765 int av_get_audio_frame_duration2(AVCodecParameters *par, int frame_bytes);
5768 typedef struct AVBitStreamFilterContext {
5770 const struct AVBitStreamFilter *filter;
5771 AVCodecParserContext *parser;
5772 struct AVBitStreamFilterContext *next;
5774 * Internal default arguments, used if NULL is passed to av_bitstream_filter_filter().
5775 * Not for access by library users.
5778 } AVBitStreamFilterContext;
5781 typedef struct AVBSFInternal AVBSFInternal;
5784 * The bitstream filter state.
5786 * This struct must be allocated with av_bsf_alloc() and freed with
5789 * The fields in the struct will only be changed (by the caller or by the
5790 * filter) as described in their documentation, and are to be considered
5791 * immutable otherwise.
5793 typedef struct AVBSFContext {
5795 * A class for logging and AVOptions
5797 const AVClass *av_class;
5800 * The bitstream filter this context is an instance of.
5802 const struct AVBitStreamFilter *filter;
5805 * Opaque libavcodec internal data. Must not be touched by the caller in any
5808 AVBSFInternal *internal;
5811 * Opaque filter-specific private data. If filter->priv_class is non-NULL,
5812 * this is an AVOptions-enabled struct.
5817 * Parameters of the input stream. This field is allocated in
5818 * av_bsf_alloc(), it needs to be filled by the caller before
5821 AVCodecParameters *par_in;
5824 * Parameters of the output stream. This field is allocated in
5825 * av_bsf_alloc(), it is set by the filter in av_bsf_init().
5827 AVCodecParameters *par_out;
5830 * The timebase used for the timestamps of the input packets. Set by the
5831 * caller before av_bsf_init().
5833 AVRational time_base_in;
5836 * The timebase used for the timestamps of the output packets. Set by the
5837 * filter in av_bsf_init().
5839 AVRational time_base_out;
5842 typedef struct AVBitStreamFilter {
5846 * A list of codec ids supported by the filter, terminated by
5848 * May be NULL, in that case the bitstream filter works with any codec id.
5850 const enum AVCodecID *codec_ids;
5853 * A class for the private data, used to declare bitstream filter private
5854 * AVOptions. This field is NULL for bitstream filters that do not declare
5857 * If this field is non-NULL, the first member of the filter private data
5858 * must be a pointer to AVClass, which will be set by libavcodec generic
5859 * code to this class.
5861 const AVClass *priv_class;
5863 /*****************************************************************
5864 * No fields below this line are part of the public API. They
5865 * may not be used outside of libavcodec and can be changed and
5867 * New public fields should be added right above.
5868 *****************************************************************
5872 int (*init)(AVBSFContext *ctx);
5873 int (*filter)(AVBSFContext *ctx, AVPacket *pkt);
5874 void (*close)(AVBSFContext *ctx);
5875 void (*flush)(AVBSFContext *ctx);
5876 } AVBitStreamFilter;
5880 * @deprecated the old bitstream filtering API (using AVBitStreamFilterContext)
5881 * is deprecated. Use the new bitstream filtering API (using AVBSFContext).
5883 attribute_deprecated
5884 void av_register_bitstream_filter(AVBitStreamFilter *bsf);
5886 * @deprecated the old bitstream filtering API (using AVBitStreamFilterContext)
5887 * is deprecated. Use av_bsf_get_by_name(), av_bsf_alloc(), and av_bsf_init()
5888 * from the new bitstream filtering API (using AVBSFContext).
5890 attribute_deprecated
5891 AVBitStreamFilterContext *av_bitstream_filter_init(const char *name);
5893 * @deprecated the old bitstream filtering API (using AVBitStreamFilterContext)
5894 * is deprecated. Use av_bsf_send_packet() and av_bsf_receive_packet() from the
5895 * new bitstream filtering API (using AVBSFContext).
5897 attribute_deprecated
5898 int av_bitstream_filter_filter(AVBitStreamFilterContext *bsfc,
5899 AVCodecContext *avctx, const char *args,
5900 uint8_t **poutbuf, int *poutbuf_size,
5901 const uint8_t *buf, int buf_size, int keyframe);
5903 * @deprecated the old bitstream filtering API (using AVBitStreamFilterContext)
5904 * is deprecated. Use av_bsf_free() from the new bitstream filtering API (using
5907 attribute_deprecated
5908 void av_bitstream_filter_close(AVBitStreamFilterContext *bsf);
5910 * @deprecated the old bitstream filtering API (using AVBitStreamFilterContext)
5911 * is deprecated. Use av_bsf_iterate() from the new bitstream filtering API (using
5914 attribute_deprecated
5915 const AVBitStreamFilter *av_bitstream_filter_next(const AVBitStreamFilter *f);
5919 * @return a bitstream filter with the specified name or NULL if no such
5920 * bitstream filter exists.
5922 const AVBitStreamFilter *av_bsf_get_by_name(const char *name);
5925 * Iterate over all registered bitstream filters.
5927 * @param opaque a pointer where libavcodec will store the iteration state. Must
5928 * point to NULL to start the iteration.
5930 * @return the next registered bitstream filter or NULL when the iteration is
5933 const AVBitStreamFilter *av_bsf_iterate(void **opaque);
5935 attribute_deprecated
5936 const AVBitStreamFilter *av_bsf_next(void **opaque);
5940 * Allocate a context for a given bitstream filter. The caller must fill in the
5941 * context parameters as described in the documentation and then call
5942 * av_bsf_init() before sending any data to the filter.
5944 * @param filter the filter for which to allocate an instance.
5945 * @param ctx a pointer into which the pointer to the newly-allocated context
5946 * will be written. It must be freed with av_bsf_free() after the
5947 * filtering is done.
5949 * @return 0 on success, a negative AVERROR code on failure
5951 int av_bsf_alloc(const AVBitStreamFilter *filter, AVBSFContext **ctx);
5954 * Prepare the filter for use, after all the parameters and options have been
5957 int av_bsf_init(AVBSFContext *ctx);
5960 * Submit a packet for filtering.
5962 * After sending each packet, the filter must be completely drained by calling
5963 * av_bsf_receive_packet() repeatedly until it returns AVERROR(EAGAIN) or
5966 * @param pkt the packet to filter. The bitstream filter will take ownership of
5967 * the packet and reset the contents of pkt. pkt is not touched if an error occurs.
5968 * If pkt is empty (i.e. NULL, or pkt->data is NULL and pkt->side_data_elems zero),
5969 * it signals the end of the stream (i.e. no more non-empty packets will be sent;
5970 * sending more empty packets does nothing) and will cause the filter to output
5971 * any packets it may have buffered internally.
5973 * @return 0 on success, a negative AVERROR on error. This function never fails if
5976 int av_bsf_send_packet(AVBSFContext *ctx, AVPacket *pkt);
5979 * Retrieve a filtered packet.
5981 * @param[out] pkt this struct will be filled with the contents of the filtered
5982 * packet. It is owned by the caller and must be freed using
5983 * av_packet_unref() when it is no longer needed.
5984 * This parameter should be "clean" (i.e. freshly allocated
5985 * with av_packet_alloc() or unreffed with av_packet_unref())
5986 * when this function is called. If this function returns
5987 * successfully, the contents of pkt will be completely
5988 * overwritten by the returned data. On failure, pkt is not
5991 * @return 0 on success. AVERROR(EAGAIN) if more packets need to be sent to the
5992 * filter (using av_bsf_send_packet()) to get more output. AVERROR_EOF if there
5993 * will be no further output from the filter. Another negative AVERROR value if
5996 * @note one input packet may result in several output packets, so after sending
5997 * a packet with av_bsf_send_packet(), this function needs to be called
5998 * repeatedly until it stops returning 0. It is also possible for a filter to
5999 * output fewer packets than were sent to it, so this function may return
6000 * AVERROR(EAGAIN) immediately after a successful av_bsf_send_packet() call.
6002 int av_bsf_receive_packet(AVBSFContext *ctx, AVPacket *pkt);
6005 * Reset the internal bitstream filter state / flush internal buffers.
6007 void av_bsf_flush(AVBSFContext *ctx);
6010 * Free a bitstream filter context and everything associated with it; write NULL
6011 * into the supplied pointer.
6013 void av_bsf_free(AVBSFContext **ctx);
6016 * Get the AVClass for AVBSFContext. It can be used in combination with
6017 * AV_OPT_SEARCH_FAKE_OBJ for examining options.
6019 * @see av_opt_find().
6021 const AVClass *av_bsf_get_class(void);
6024 * Structure for chain/list of bitstream filters.
6025 * Empty list can be allocated by av_bsf_list_alloc().
6027 typedef struct AVBSFList AVBSFList;
6030 * Allocate empty list of bitstream filters.
6031 * The list must be later freed by av_bsf_list_free()
6032 * or finalized by av_bsf_list_finalize().
6034 * @return Pointer to @ref AVBSFList on success, NULL in case of failure
6036 AVBSFList *av_bsf_list_alloc(void);
6039 * Free list of bitstream filters.
6041 * @param lst Pointer to pointer returned by av_bsf_list_alloc()
6043 void av_bsf_list_free(AVBSFList **lst);
6046 * Append bitstream filter to the list of bitstream filters.
6048 * @param lst List to append to
6049 * @param bsf Filter context to be appended
6051 * @return >=0 on success, negative AVERROR in case of failure
6053 int av_bsf_list_append(AVBSFList *lst, AVBSFContext *bsf);
6056 * Construct new bitstream filter context given it's name and options
6057 * and append it to the list of bitstream filters.
6059 * @param lst List to append to
6060 * @param bsf_name Name of the bitstream filter
6061 * @param options Options for the bitstream filter, can be set to NULL
6063 * @return >=0 on success, negative AVERROR in case of failure
6065 int av_bsf_list_append2(AVBSFList *lst, const char * bsf_name, AVDictionary **options);
6067 * Finalize list of bitstream filters.
6069 * This function will transform @ref AVBSFList to single @ref AVBSFContext,
6070 * so the whole chain of bitstream filters can be treated as single filter
6071 * freshly allocated by av_bsf_alloc().
6072 * If the call is successful, @ref AVBSFList structure is freed and lst
6073 * will be set to NULL. In case of failure, caller is responsible for
6074 * freeing the structure by av_bsf_list_free()
6076 * @param lst Filter list structure to be transformed
6077 * @param[out] bsf Pointer to be set to newly created @ref AVBSFContext structure
6078 * representing the chain of bitstream filters
6080 * @return >=0 on success, negative AVERROR in case of failure
6082 int av_bsf_list_finalize(AVBSFList **lst, AVBSFContext **bsf);
6085 * Parse string describing list of bitstream filters and create single
6086 * @ref AVBSFContext describing the whole chain of bitstream filters.
6087 * Resulting @ref AVBSFContext can be treated as any other @ref AVBSFContext freshly
6088 * allocated by av_bsf_alloc().
6090 * @param str String describing chain of bitstream filters in format
6091 * `bsf1[=opt1=val1:opt2=val2][,bsf2]`
6092 * @param[out] bsf Pointer to be set to newly created @ref AVBSFContext structure
6093 * representing the chain of bitstream filters
6095 * @return >=0 on success, negative AVERROR in case of failure
6097 int av_bsf_list_parse_str(const char *str, AVBSFContext **bsf);
6100 * Get null/pass-through bitstream filter.
6102 * @param[out] bsf Pointer to be set to new instance of pass-through bitstream filter
6106 int av_bsf_get_null_filter(AVBSFContext **bsf);
6111 * Same behaviour av_fast_malloc but the buffer has additional
6112 * AV_INPUT_BUFFER_PADDING_SIZE at the end which will always be 0.
6114 * In addition the whole buffer will initially and after resizes
6115 * be 0-initialized so that no uninitialized data will ever appear.
6117 void av_fast_padded_malloc(void *ptr, unsigned int *size, size_t min_size);
6120 * Same behaviour av_fast_padded_malloc except that buffer will always
6121 * be 0-initialized after call.
6123 void av_fast_padded_mallocz(void *ptr, unsigned int *size, size_t min_size);
6126 * Encode extradata length to a buffer. Used by xiph codecs.
6128 * @param s buffer to write to; must be at least (v/255+1) bytes long
6129 * @param v size of extradata in bytes
6130 * @return number of bytes written to the buffer.
6132 unsigned int av_xiphlacing(unsigned char *s, unsigned int v);
6134 #if FF_API_USER_VISIBLE_AVHWACCEL
6136 * Register the hardware accelerator hwaccel.
6138 * @deprecated This function doesn't do anything.
6140 attribute_deprecated
6141 void av_register_hwaccel(AVHWAccel *hwaccel);
6144 * If hwaccel is NULL, returns the first registered hardware accelerator,
6145 * if hwaccel is non-NULL, returns the next registered hardware accelerator
6146 * after hwaccel, or NULL if hwaccel is the last one.
6148 * @deprecated AVHWaccel structures contain no user-serviceable parts, so
6149 * this function should not be used.
6151 attribute_deprecated
6152 AVHWAccel *av_hwaccel_next(const AVHWAccel *hwaccel);
6157 * Lock operation used by lockmgr
6159 * @deprecated Deprecated together with av_lockmgr_register().
6162 AV_LOCK_CREATE, ///< Create a mutex
6163 AV_LOCK_OBTAIN, ///< Lock the mutex
6164 AV_LOCK_RELEASE, ///< Unlock the mutex
6165 AV_LOCK_DESTROY, ///< Free mutex resources
6169 * Register a user provided lock manager supporting the operations
6170 * specified by AVLockOp. The "mutex" argument to the function points
6171 * to a (void *) where the lockmgr should store/get a pointer to a user
6172 * allocated mutex. It is NULL upon AV_LOCK_CREATE and equal to the
6173 * value left by the last call for all other ops. If the lock manager is
6174 * unable to perform the op then it should leave the mutex in the same
6175 * state as when it was called and return a non-zero value. However,
6176 * when called with AV_LOCK_DESTROY the mutex will always be assumed to
6177 * have been successfully destroyed. If av_lockmgr_register succeeds
6178 * it will return a non-negative value, if it fails it will return a
6179 * negative value and destroy all mutex and unregister all callbacks.
6180 * av_lockmgr_register is not thread-safe, it must be called from a
6181 * single thread before any calls which make use of locking are used.
6183 * @param cb User defined callback. av_lockmgr_register invokes calls
6184 * to this callback and the previously registered callback.
6185 * The callback will be used to create more than one mutex
6186 * each of which must be backed by its own underlying locking
6187 * mechanism (i.e. do not use a single static object to
6188 * implement your lock manager). If cb is set to NULL the
6189 * lockmgr will be unregistered.
6191 * @deprecated This function does nothing, and always returns 0. Be sure to
6192 * build with thread support to get basic thread safety.
6194 attribute_deprecated
6195 int av_lockmgr_register(int (*cb)(void **mutex, enum AVLockOp op));
6199 * Get the type of the given codec.
6201 enum AVMediaType avcodec_get_type(enum AVCodecID codec_id);
6204 * Get the name of a codec.
6205 * @return a static string identifying the codec; never NULL
6207 const char *avcodec_get_name(enum AVCodecID id);
6210 * @return a positive value if s is open (i.e. avcodec_open2() was called on it
6211 * with no corresponding avcodec_close()), 0 otherwise.
6213 int avcodec_is_open(AVCodecContext *s);
6216 * @return a non-zero number if codec is an encoder, zero otherwise
6218 int av_codec_is_encoder(const AVCodec *codec);
6221 * @return a non-zero number if codec is a decoder, zero otherwise
6223 int av_codec_is_decoder(const AVCodec *codec);
6226 * @return descriptor for given codec ID or NULL if no descriptor exists.
6228 const AVCodecDescriptor *avcodec_descriptor_get(enum AVCodecID id);
6231 * Iterate over all codec descriptors known to libavcodec.
6233 * @param prev previous descriptor. NULL to get the first descriptor.
6235 * @return next descriptor or NULL after the last descriptor
6237 const AVCodecDescriptor *avcodec_descriptor_next(const AVCodecDescriptor *prev);
6240 * @return codec descriptor with the given name or NULL if no such descriptor
6243 const AVCodecDescriptor *avcodec_descriptor_get_by_name(const char *name);
6246 * Allocate a CPB properties structure and initialize its fields to default
6249 * @param size if non-NULL, the size of the allocated struct will be written
6250 * here. This is useful for embedding it in side data.
6252 * @return the newly allocated struct or NULL on failure
6254 AVCPBProperties *av_cpb_properties_alloc(size_t *size);
6260 #endif /* AVCODEC_AVCODEC_H */