2 * copyright (c) 2001 Fabrice Bellard
4 * This file is part of Libav.
6 * Libav 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 * Libav 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 Libav; 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/dict.h"
37 #include "libavutil/frame.h"
38 #include "libavutil/log.h"
39 #include "libavutil/pixfmt.h"
40 #include "libavutil/rational.h"
44 #if FF_API_FAST_MALLOC
45 // to provide fast_*alloc
46 #include "libavutil/mem.h"
50 * @defgroup libavc Encoding/Decoding Library
53 * @defgroup lavc_decoding Decoding
57 * @defgroup lavc_encoding Encoding
61 * @defgroup lavc_codec Codecs
63 * @defgroup lavc_codec_native Native Codecs
66 * @defgroup lavc_codec_wrappers External library wrappers
69 * @defgroup lavc_codec_hwaccel Hardware Accelerators bridge
73 * @defgroup lavc_internal Internal
81 * @defgroup lavc_encdec send/receive encoding and decoding API overview
84 * The avcodec_send_packet()/avcodec_receive_frame()/avcodec_send_frame()/
85 * avcodec_receive_packet() functions provide an encode/decode API, which
86 * decouples input and output.
88 * The API is very similar for encoding/decoding and audio/video, and works as
90 * - Set up and open the AVCodecContext as usual.
92 * - For decoding, call avcodec_send_packet() to give the decoder raw
93 * compressed data in an AVPacket.
94 * - For encoding, call avcodec_send_frame() to give the decoder an AVFrame
95 * containing uncompressed audio or video.
96 * In both cases, it is recommended that AVPackets and AVFrames are
97 * refcounted, or libavcodec might have to copy the input data. (libavformat
98 * always returns refcounted AVPackets, and av_frame_get_buffer() allocates
99 * refcounted AVFrames.)
100 * - Receive output in a loop. Periodically call one of the avcodec_receive_*()
101 * functions and process their output:
102 * - For decoding, call avcodec_receive_frame(). On success, it will return
103 * an AVFrame containing uncompressed audio or video data.
104 * - For encoding, call avcodec_receive_packet(). On success, it will return
105 * an AVPacket with a compressed frame.
106 * Repeat this call until it returns AVERROR(EAGAIN) or an error. The
107 * AVERROR(EAGAIN) return value means that new input data is required to
108 * return new output. In this case, continue with sending input. For each
109 * input frame/packet, the codec will typically return 1 output frame/packet,
110 * but it can also be 0 or more than 1.
112 * At the beginning of decoding or encoding, the codec might accept multiple
113 * input frames/packets without returning a frame, until its internal buffers
114 * are filled. This situation is handled transparently if you follow the steps
117 * End of stream situations. These require "flushing" (aka draining) the codec,
118 * as the codec might buffer multiple frames or packets internally for
119 * performance or out of necessity (consider B-frames).
120 * This is handled as follows:
121 * - Instead of valid input, send NULL to the avcodec_send_packet() (decoding)
122 * or avcodec_send_frame() (encoding) functions. This will enter draining
124 * - Call avcodec_receive_frame() (decoding) or avcodec_receive_packet()
125 * (encoding) in a loop until AVERROR_EOF is returned. The functions will
126 * not return AVERROR(EAGAIN), unless you forgot to enter draining mode.
127 * - Before decoding can be resumed again, the codec has to be reset with
128 * avcodec_flush_buffers().
130 * Using the API as outlined above is highly recommended. But it is also
131 * possible to call functions outside of this rigid schema. For example, you can
132 * call avcodec_send_packet() repeatedly without calling
133 * avcodec_receive_frame(). In this case, avcodec_send_packet() will succeed
134 * until the codec's internal buffer has been filled up (which is typically of
135 * size 1 per output frame, after initial input), and then reject input with
136 * AVERROR(EAGAIN). Once it starts rejecting input, you have no choice but to
137 * read at least some output.
139 * Not all codecs will follow a rigid and predictable dataflow; the only
140 * guarantee is that an AVERROR(EAGAIN) return value on a send/receive call on
141 * one end implies that a receive/send call on the other end will succeed. In
142 * general, no codec will permit unlimited buffering of input or output.
144 * This API replaces the following legacy functions:
145 * - avcodec_decode_video2() and avcodec_decode_audio4():
146 * Use avcodec_send_packet() to feed input to the decoder, then use
147 * avcodec_receive_frame() to receive decoded frames after each packet.
148 * Unlike with the old video decoding API, multiple frames might result from
149 * a packet. For audio, splitting the input packet into frames by partially
150 * decoding packets becomes transparent to the API user. You never need to
151 * feed an AVPacket to the API twice.
152 * Additionally, sending a flush/draining packet is required only once.
153 * - avcodec_encode_video2()/avcodec_encode_audio2():
154 * Use avcodec_send_frame() to feed input to the encoder, then use
155 * avcodec_receive_packet() to receive encoded packets.
156 * Providing user-allocated buffers for avcodec_receive_packet() is not
158 * - The new API does not handle subtitles yet.
160 * Mixing new and old function calls on the same AVCodecContext is not allowed,
161 * and will result in arbitrary behavior.
163 * Some codecs might require using the new API; using the old API will return
164 * an error when calling it.
169 * @defgroup lavc_core Core functions/structures.
172 * Basic definitions, functions for querying libavcodec capabilities,
173 * allocating core structures, etc.
179 * Identify the syntax and semantics of the bitstream.
180 * The principle is roughly:
181 * Two decoders with the same ID can decode the same streams.
182 * Two encoders with the same ID can encode compatible streams.
183 * There may be slight deviations from the principle due to implementation
186 * If you add a codec ID to this list, add it so that
187 * 1. no value of a existing codec ID changes (that would break ABI),
188 * 2. it is as close as possible to similar codecs.
190 * After adding new codec IDs, do not forget to add an entry to the codec
191 * descriptor list and bump libavcodec minor version.
197 AV_CODEC_ID_MPEG1VIDEO,
198 AV_CODEC_ID_MPEG2VIDEO, ///< preferred ID for MPEG-1/2 video decoding
200 AV_CODEC_ID_MPEG2VIDEO_XVMC,
201 #endif /* FF_API_XVMC */
212 AV_CODEC_ID_RAWVIDEO,
213 AV_CODEC_ID_MSMPEG4V1,
214 AV_CODEC_ID_MSMPEG4V2,
215 AV_CODEC_ID_MSMPEG4V3,
238 AV_CODEC_ID_INTERPLAY_VIDEO,
245 AV_CODEC_ID_MSVIDEO1,
250 AV_CODEC_ID_TRUEMOTION1,
251 AV_CODEC_ID_VMDVIDEO,
276 AV_CODEC_ID_TRUEMOTION2,
282 AV_CODEC_ID_SMACKVIDEO,
287 AV_CODEC_ID_JPEG2000,
293 AV_CODEC_ID_DSICINVIDEO,
294 AV_CODEC_ID_TIERTEXSEQVIDEO,
302 AV_CODEC_ID_BETHSOFTVID,
314 AV_CODEC_ID_ESCAPE124,
318 AV_CODEC_ID_MOTIONPIXELS,
330 AV_CODEC_ID_FLASHSV2,
331 AV_CODEC_ID_CDGRAPHICS,
334 AV_CODEC_ID_BINKVIDEO,
335 AV_CODEC_ID_IFF_ILBM,
336 AV_CODEC_ID_IFF_BYTERUN1,
342 AV_CODEC_ID_A64_MULTI,
343 AV_CODEC_ID_A64_MULTI5,
346 AV_CODEC_ID_LAGARITH,
350 AV_CODEC_ID_WMV3IMAGE,
351 AV_CODEC_ID_VC1IMAGE,
353 AV_CODEC_ID_BMV_VIDEO,
360 AV_CODEC_ID_ZEROCODEC,
369 AV_CODEC_ID_ESCAPE130,
372 AV_CODEC_ID_HNM4_VIDEO,
375 AV_CODEC_ID_ALIAS_PIX,
376 AV_CODEC_ID_BRENDER_PIX,
377 AV_CODEC_ID_PAF_VIDEO,
390 AV_CODEC_ID_SCREENPRESSO,
393 /* various PCM "codecs" */
394 AV_CODEC_ID_FIRST_AUDIO = 0x10000, ///< A dummy id pointing at the start of audio codecs
395 AV_CODEC_ID_PCM_S16LE = 0x10000,
396 AV_CODEC_ID_PCM_S16BE,
397 AV_CODEC_ID_PCM_U16LE,
398 AV_CODEC_ID_PCM_U16BE,
401 AV_CODEC_ID_PCM_MULAW,
402 AV_CODEC_ID_PCM_ALAW,
403 AV_CODEC_ID_PCM_S32LE,
404 AV_CODEC_ID_PCM_S32BE,
405 AV_CODEC_ID_PCM_U32LE,
406 AV_CODEC_ID_PCM_U32BE,
407 AV_CODEC_ID_PCM_S24LE,
408 AV_CODEC_ID_PCM_S24BE,
409 AV_CODEC_ID_PCM_U24LE,
410 AV_CODEC_ID_PCM_U24BE,
411 AV_CODEC_ID_PCM_S24DAUD,
412 AV_CODEC_ID_PCM_ZORK,
413 AV_CODEC_ID_PCM_S16LE_PLANAR,
415 AV_CODEC_ID_PCM_F32BE,
416 AV_CODEC_ID_PCM_F32LE,
417 AV_CODEC_ID_PCM_F64BE,
418 AV_CODEC_ID_PCM_F64LE,
419 AV_CODEC_ID_PCM_BLURAY,
422 AV_CODEC_ID_PCM_S8_PLANAR,
423 AV_CODEC_ID_PCM_S24LE_PLANAR,
424 AV_CODEC_ID_PCM_S32LE_PLANAR,
425 AV_CODEC_ID_PCM_S16BE_PLANAR,
427 /* various ADPCM codecs */
428 AV_CODEC_ID_ADPCM_IMA_QT = 0x11000,
429 AV_CODEC_ID_ADPCM_IMA_WAV,
430 AV_CODEC_ID_ADPCM_IMA_DK3,
431 AV_CODEC_ID_ADPCM_IMA_DK4,
432 AV_CODEC_ID_ADPCM_IMA_WS,
433 AV_CODEC_ID_ADPCM_IMA_SMJPEG,
434 AV_CODEC_ID_ADPCM_MS,
435 AV_CODEC_ID_ADPCM_4XM,
436 AV_CODEC_ID_ADPCM_XA,
437 AV_CODEC_ID_ADPCM_ADX,
438 AV_CODEC_ID_ADPCM_EA,
439 AV_CODEC_ID_ADPCM_G726,
440 AV_CODEC_ID_ADPCM_CT,
441 AV_CODEC_ID_ADPCM_SWF,
442 AV_CODEC_ID_ADPCM_YAMAHA,
443 AV_CODEC_ID_ADPCM_SBPRO_4,
444 AV_CODEC_ID_ADPCM_SBPRO_3,
445 AV_CODEC_ID_ADPCM_SBPRO_2,
446 AV_CODEC_ID_ADPCM_THP,
447 AV_CODEC_ID_ADPCM_IMA_AMV,
448 AV_CODEC_ID_ADPCM_EA_R1,
449 AV_CODEC_ID_ADPCM_EA_R3,
450 AV_CODEC_ID_ADPCM_EA_R2,
451 AV_CODEC_ID_ADPCM_IMA_EA_SEAD,
452 AV_CODEC_ID_ADPCM_IMA_EA_EACS,
453 AV_CODEC_ID_ADPCM_EA_XAS,
454 AV_CODEC_ID_ADPCM_EA_MAXIS_XA,
455 AV_CODEC_ID_ADPCM_IMA_ISS,
456 AV_CODEC_ID_ADPCM_G722,
457 AV_CODEC_ID_ADPCM_IMA_APC,
458 AV_CODEC_ID_ADPCM_VIMA,
461 AV_CODEC_ID_AMR_NB = 0x12000,
464 /* RealAudio codecs*/
465 AV_CODEC_ID_RA_144 = 0x13000,
468 /* various DPCM codecs */
469 AV_CODEC_ID_ROQ_DPCM = 0x14000,
470 AV_CODEC_ID_INTERPLAY_DPCM,
471 AV_CODEC_ID_XAN_DPCM,
472 AV_CODEC_ID_SOL_DPCM,
475 AV_CODEC_ID_MP2 = 0x15000,
476 AV_CODEC_ID_MP3, ///< preferred ID for decoding MPEG audio layer 1, 2 or 3
486 AV_CODEC_ID_VMDAUDIO,
492 AV_CODEC_ID_WESTWOOD_SND1,
493 AV_CODEC_ID_GSM, ///< as in Berlin toast format
496 AV_CODEC_ID_TRUESPEECH,
498 AV_CODEC_ID_SMACKAUDIO,
501 AV_CODEC_ID_DSICINAUDIO,
503 AV_CODEC_ID_MUSEPACK7,
505 AV_CODEC_ID_GSM_MS, /* as found in WAV */
511 AV_CODEC_ID_NELLYMOSER,
512 AV_CODEC_ID_MUSEPACK8,
514 AV_CODEC_ID_WMAVOICE,
516 AV_CODEC_ID_WMALOSSLESS,
525 AV_CODEC_ID_BINKAUDIO_RDFT,
526 AV_CODEC_ID_BINKAUDIO_DCT,
527 AV_CODEC_ID_AAC_LATM,
532 AV_CODEC_ID_8SVX_EXP,
533 AV_CODEC_ID_8SVX_FIB,
534 AV_CODEC_ID_BMV_AUDIO,
539 AV_CODEC_ID_COMFORT_NOISE,
541 AV_CODEC_ID_METASOUND,
542 AV_CODEC_ID_PAF_AUDIO,
546 /* subtitle codecs */
547 AV_CODEC_ID_FIRST_SUBTITLE = 0x17000, ///< A dummy ID pointing at the start of subtitle codecs.
548 AV_CODEC_ID_DVD_SUBTITLE = 0x17000,
549 AV_CODEC_ID_DVB_SUBTITLE,
550 AV_CODEC_ID_TEXT, ///< raw UTF-8 text
553 AV_CODEC_ID_MOV_TEXT,
554 AV_CODEC_ID_HDMV_PGS_SUBTITLE,
555 AV_CODEC_ID_DVB_TELETEXT,
558 /* other specific kind of codecs (generally used for attachments) */
559 AV_CODEC_ID_FIRST_UNKNOWN = 0x18000, ///< A dummy ID pointing at the start of various fake codecs.
560 AV_CODEC_ID_TTF = 0x18000,
562 AV_CODEC_ID_PROBE = 0x19000, ///< codec_id is not known (like AV_CODEC_ID_NONE) but lavf should attempt to identify it
564 AV_CODEC_ID_MPEG2TS = 0x20000, /**< _FAKE_ codec to indicate a raw MPEG-2 TS
565 * stream (only used by libavformat) */
566 AV_CODEC_ID_MPEG4SYSTEMS = 0x20001, /**< _FAKE_ codec to indicate a MPEG-4 Systems
567 * stream (only used by libavformat) */
568 AV_CODEC_ID_FFMETADATA = 0x21000, ///< Dummy codec for streams containing only metadata information.
569 AV_CODEC_ID_WRAPPED_AVFRAME = 0x21001, ///< Passthrough codec, AVFrames wrapped in AVPacket
573 * This struct describes the properties of a single codec described by an
575 * @see avcodec_descriptor_get()
577 typedef struct AVCodecDescriptor {
579 enum AVMediaType type;
581 * Name of the codec described by this descriptor. It is non-empty and
582 * unique for each codec descriptor. It should contain alphanumeric
583 * characters and '_' only.
587 * A more descriptive name for this codec. May be NULL.
589 const char *long_name;
591 * Codec properties, a combination of AV_CODEC_PROP_* flags.
595 * If non-NULL, an array of profiles recognized for this codec.
596 * Terminated with FF_PROFILE_UNKNOWN.
598 const struct AVProfile *profiles;
602 * Codec uses only intra compression.
605 #define AV_CODEC_PROP_INTRA_ONLY (1 << 0)
607 * Codec supports lossy compression. Audio and video codecs only.
608 * @note a codec may support both lossy and lossless
611 #define AV_CODEC_PROP_LOSSY (1 << 1)
613 * Codec supports lossless compression. Audio and video codecs only.
615 #define AV_CODEC_PROP_LOSSLESS (1 << 2)
617 * Codec supports frame reordering. That is, the coded order (the order in which
618 * the encoded packets are output by the encoders / stored / input to the
619 * decoders) may be different from the presentation order of the corresponding
622 * For codecs that do not have this property set, PTS and DTS should always be
625 #define AV_CODEC_PROP_REORDER (1 << 3)
628 * @ingroup lavc_decoding
629 * Required number of additionally allocated bytes at the end of the input bitstream for decoding.
630 * This is mainly needed because some optimized bitstream readers read
631 * 32 or 64 bit at once and could read over the end.<br>
632 * Note: If the first 23 bits of the additional bytes are not 0, then damaged
633 * MPEG bitstreams could cause overread and segfault.
635 #define AV_INPUT_BUFFER_PADDING_SIZE 8
638 * @ingroup lavc_encoding
639 * minimum encoding buffer size
640 * Used to avoid some checks during header writing.
642 #define AV_INPUT_BUFFER_MIN_SIZE 16384
644 #if FF_API_WITHOUT_PREFIX
646 * @deprecated use AV_INPUT_BUFFER_PADDING_SIZE instead
648 #define FF_INPUT_BUFFER_PADDING_SIZE 8
651 * @deprecated use AV_INPUT_BUFFER_MIN_SIZE instead
653 #define FF_MIN_BUFFER_SIZE 16384
654 #endif /* FF_API_WITHOUT_PREFIX */
657 * @ingroup lavc_encoding
658 * motion estimation type.
659 * @deprecated use codec private option instead
661 #if FF_API_MOTION_EST
663 ME_ZERO = 1, ///< no search, that is use 0,0 vector whenever one is needed
667 ME_EPZS, ///< enhanced predictive zonal search
668 ME_X1, ///< reserved for experiments
669 ME_HEX, ///< hexagon based search
670 ME_UMH, ///< uneven multi-hexagon search
671 ME_TESA, ///< transformed exhaustive search algorithm
676 * @ingroup lavc_decoding
679 /* We leave some space between them for extensions (drop some
680 * keyframes for intra-only or drop just some bidir frames). */
681 AVDISCARD_NONE =-16, ///< discard nothing
682 AVDISCARD_DEFAULT = 0, ///< discard useless packets like 0 size packets in avi
683 AVDISCARD_NONREF = 8, ///< discard all non reference
684 AVDISCARD_BIDIR = 16, ///< discard all bidirectional frames
685 AVDISCARD_NONKEY = 32, ///< discard all frames except keyframes
686 AVDISCARD_ALL = 48, ///< discard all
689 enum AVAudioServiceType {
690 AV_AUDIO_SERVICE_TYPE_MAIN = 0,
691 AV_AUDIO_SERVICE_TYPE_EFFECTS = 1,
692 AV_AUDIO_SERVICE_TYPE_VISUALLY_IMPAIRED = 2,
693 AV_AUDIO_SERVICE_TYPE_HEARING_IMPAIRED = 3,
694 AV_AUDIO_SERVICE_TYPE_DIALOGUE = 4,
695 AV_AUDIO_SERVICE_TYPE_COMMENTARY = 5,
696 AV_AUDIO_SERVICE_TYPE_EMERGENCY = 6,
697 AV_AUDIO_SERVICE_TYPE_VOICE_OVER = 7,
698 AV_AUDIO_SERVICE_TYPE_KARAOKE = 8,
699 AV_AUDIO_SERVICE_TYPE_NB , ///< Not part of ABI
703 * @ingroup lavc_encoding
705 typedef struct RcOverride{
708 int qscale; // If this is 0 then quality_factor will be used instead.
709 float quality_factor;
712 #if FF_API_MAX_BFRAMES
714 * @deprecated there is no libavcodec-wide limit on the number of B-frames
716 #define FF_MAX_B_FRAMES 16
720 These flags can be passed in AVCodecContext.flags before initialization.
721 Note: Not everything is supported yet.
725 * Allow decoders to produce frames with data planes that are not aligned
726 * to CPU requirements (e.g. due to cropping).
728 #define AV_CODEC_FLAG_UNALIGNED (1 << 0)
732 #define AV_CODEC_FLAG_QSCALE (1 << 1)
734 * 4 MV per MB allowed / advanced prediction for H.263.
736 #define AV_CODEC_FLAG_4MV (1 << 2)
738 * Output even those frames that might be corrupted.
740 #define AV_CODEC_FLAG_OUTPUT_CORRUPT (1 << 3)
744 #define AV_CODEC_FLAG_QPEL (1 << 4)
746 * Use internal 2pass ratecontrol in first pass mode.
748 #define AV_CODEC_FLAG_PASS1 (1 << 9)
750 * Use internal 2pass ratecontrol in second pass mode.
752 #define AV_CODEC_FLAG_PASS2 (1 << 10)
756 #define AV_CODEC_FLAG_LOOP_FILTER (1 << 11)
758 * Only decode/encode grayscale.
760 #define AV_CODEC_FLAG_GRAY (1 << 13)
762 * error[?] variables will be set during encoding.
764 #define AV_CODEC_FLAG_PSNR (1 << 15)
766 * Input bitstream might be truncated at a random location
767 * instead of only at frame boundaries.
769 #define AV_CODEC_FLAG_TRUNCATED (1 << 16)
771 * Use interlaced DCT.
773 #define AV_CODEC_FLAG_INTERLACED_DCT (1 << 18)
777 #define AV_CODEC_FLAG_LOW_DELAY (1 << 19)
779 * Place global headers in extradata instead of every keyframe.
781 #define AV_CODEC_FLAG_GLOBAL_HEADER (1 << 22)
783 * Use only bitexact stuff (except (I)DCT).
785 #define AV_CODEC_FLAG_BITEXACT (1 << 23)
786 /* Fx : Flag for h263+ extra options */
788 * H.263 advanced intra coding / MPEG-4 AC prediction
790 #define AV_CODEC_FLAG_AC_PRED (1 << 24)
792 * interlaced motion estimation
794 #define AV_CODEC_FLAG_INTERLACED_ME (1 << 29)
795 #define AV_CODEC_FLAG_CLOSED_GOP (1 << 31)
798 * Allow non spec compliant speedup tricks.
800 #define AV_CODEC_FLAG2_FAST (1 << 0)
802 * Skip bitstream encoding.
804 #define AV_CODEC_FLAG2_NO_OUTPUT (1 << 2)
806 * Place global headers at every keyframe instead of in extradata.
808 #define AV_CODEC_FLAG2_LOCAL_HEADER (1 << 3)
810 * Input bitstream might be truncated at a packet boundaries
811 * instead of only at frame boundaries.
813 #define AV_CODEC_FLAG2_CHUNKS (1 << 15)
815 * Discard cropping information from SPS.
817 #define AV_CODEC_FLAG2_IGNORE_CROP (1 << 16)
819 /* Unsupported options :
820 * Syntax Arithmetic coding (SAC)
821 * Reference Picture Selection
822 * Independent Segment Decoding */
824 /* codec capabilities */
827 * Decoder can use draw_horiz_band callback.
829 #define AV_CODEC_CAP_DRAW_HORIZ_BAND (1 << 0)
831 * Codec uses get_buffer() for allocating buffers and supports custom allocators.
832 * If not set, it might not use get_buffer() at all or use operations that
833 * assume the buffer was allocated by avcodec_default_get_buffer.
835 #define AV_CODEC_CAP_DR1 (1 << 1)
836 #define AV_CODEC_CAP_TRUNCATED (1 << 3)
838 * Encoder or decoder requires flushing with NULL input at the end in order to
839 * give the complete and correct output.
841 * NOTE: If this flag is not set, the codec is guaranteed to never be fed with
842 * with NULL data. The user can still send NULL data to the public encode
843 * or decode function, but libavcodec will not pass it along to the codec
844 * unless this flag is set.
847 * The decoder has a non-zero delay and needs to be fed with avpkt->data=NULL,
848 * avpkt->size=0 at the end to get the delayed data until the decoder no longer
852 * The encoder needs to be fed with NULL data at the end of encoding until the
853 * encoder no longer returns data.
855 * NOTE: For encoders implementing the AVCodec.encode2() function, setting this
856 * flag also means that the encoder must set the pts and duration for
857 * each output packet. If this flag is not set, the pts and duration will
858 * be determined by libavcodec from the input frame.
860 #define AV_CODEC_CAP_DELAY (1 << 5)
862 * Codec can be fed a final frame with a smaller size.
863 * This can be used to prevent truncation of the last audio samples.
865 #define AV_CODEC_CAP_SMALL_LAST_FRAME (1 << 6)
867 * Codec can output multiple frames per AVPacket
868 * Normally demuxers return one frame at a time, demuxers which do not do
869 * are connected to a parser to split what they return into proper frames.
870 * This flag is reserved to the very rare category of codecs which have a
871 * bitstream that cannot be split into frames without timeconsuming
872 * operations like full decoding. Demuxers carring such bitstreams thus
873 * may return multiple frames in a packet. This has many disadvantages like
874 * prohibiting stream copy in many cases thus it should only be considered
877 #define AV_CODEC_CAP_SUBFRAMES (1 << 8)
879 * Codec is experimental and is thus avoided in favor of non experimental
882 #define AV_CODEC_CAP_EXPERIMENTAL (1 << 9)
884 * Codec should fill in channel configuration and samplerate instead of container
886 #define AV_CODEC_CAP_CHANNEL_CONF (1 << 10)
888 * Codec supports frame-level multithreading.
890 #define AV_CODEC_CAP_FRAME_THREADS (1 << 12)
892 * Codec supports slice-based (or partition-based) multithreading.
894 #define AV_CODEC_CAP_SLICE_THREADS (1 << 13)
896 * Codec supports changed parameters at any point.
898 #define AV_CODEC_CAP_PARAM_CHANGE (1 << 14)
900 * Codec supports avctx->thread_count == 0 (auto).
902 #define AV_CODEC_CAP_AUTO_THREADS (1 << 15)
904 * Audio encoder supports receiving a different number of samples in each call.
906 #define AV_CODEC_CAP_VARIABLE_FRAME_SIZE (1 << 16)
908 #if FF_API_WITHOUT_PREFIX
910 * Allow decoders to produce frames with data planes that are not aligned
911 * to CPU requirements (e.g. due to cropping).
913 #define CODEC_FLAG_UNALIGNED 0x0001
914 #define CODEC_FLAG_QSCALE 0x0002 ///< Use fixed qscale.
915 #define CODEC_FLAG_4MV 0x0004 ///< 4 MV per MB allowed / advanced prediction for H.263.
916 #define CODEC_FLAG_OUTPUT_CORRUPT 0x0008 ///< Output even those frames that might be corrupted
917 #define CODEC_FLAG_QPEL 0x0010 ///< Use qpel MC.
920 * @deprecated use the "gmc" private option of the libxvid encoder
922 #define CODEC_FLAG_GMC 0x0020 ///< Use GMC.
926 * @deprecated use the flag "mv0" in the "mpv_flags" private option of the
929 #define CODEC_FLAG_MV0 0x0040
931 #if FF_API_INPUT_PRESERVED
933 * @deprecated passing reference-counted frames to the encoders replaces this
936 #define CODEC_FLAG_INPUT_PRESERVED 0x0100
938 #define CODEC_FLAG_PASS1 0x0200 ///< Use internal 2pass ratecontrol in first pass mode.
939 #define CODEC_FLAG_PASS2 0x0400 ///< Use internal 2pass ratecontrol in second pass mode.
940 #define CODEC_FLAG_GRAY 0x2000 ///< Only decode/encode grayscale.
943 * @deprecated edges are not used/required anymore. I.e. this flag is now always
946 #define CODEC_FLAG_EMU_EDGE 0x4000
948 #define CODEC_FLAG_PSNR 0x8000 ///< error[?] variables will be set during encoding.
949 #define CODEC_FLAG_TRUNCATED 0x00010000 /** Input bitstream might be truncated at a random
950 location instead of only at frame boundaries. */
951 #if FF_API_NORMALIZE_AQP
953 * @deprecated use the flag "naq" in the "mpv_flags" private option of the
956 #define CODEC_FLAG_NORMALIZE_AQP 0x00020000
958 #define CODEC_FLAG_INTERLACED_DCT 0x00040000 ///< Use interlaced DCT.
959 #define CODEC_FLAG_LOW_DELAY 0x00080000 ///< Force low delay.
960 #define CODEC_FLAG_GLOBAL_HEADER 0x00400000 ///< Place global headers in extradata instead of every keyframe.
961 #define CODEC_FLAG_BITEXACT 0x00800000 ///< Use only bitexact stuff (except (I)DCT).
962 /* Fx : Flag for h263+ extra options */
963 #define CODEC_FLAG_AC_PRED 0x01000000 ///< H.263 advanced intra coding / MPEG-4 AC prediction
964 #define CODEC_FLAG_LOOP_FILTER 0x00000800 ///< loop filter
965 #define CODEC_FLAG_INTERLACED_ME 0x20000000 ///< interlaced motion estimation
966 #define CODEC_FLAG_CLOSED_GOP 0x80000000
967 #define CODEC_FLAG2_FAST 0x00000001 ///< Allow non spec compliant speedup tricks.
968 #define CODEC_FLAG2_NO_OUTPUT 0x00000004 ///< Skip bitstream encoding.
969 #define CODEC_FLAG2_LOCAL_HEADER 0x00000008 ///< Place global headers at every keyframe instead of in extradata.
970 #define CODEC_FLAG2_IGNORE_CROP 0x00010000 ///< Discard cropping information from SPS.
972 #define CODEC_FLAG2_CHUNKS 0x00008000 ///< Input bitstream might be truncated at a packet boundaries instead of only at frame boundaries.
974 /* Unsupported options :
975 * Syntax Arithmetic coding (SAC)
976 * Reference Picture Selection
977 * Independent Segment Decoding */
979 /* codec capabilities */
981 #define CODEC_CAP_DRAW_HORIZ_BAND 0x0001 ///< Decoder can use draw_horiz_band callback.
983 * Codec uses get_buffer() for allocating buffers and supports custom allocators.
984 * If not set, it might not use get_buffer() at all or use operations that
985 * assume the buffer was allocated by avcodec_default_get_buffer.
987 #define CODEC_CAP_DR1 0x0002
988 #define CODEC_CAP_TRUNCATED 0x0008
990 /* Codec can export data for HW decoding (XvMC). */
991 #define CODEC_CAP_HWACCEL 0x0010
992 #endif /* FF_API_XVMC */
994 * Encoder or decoder requires flushing with NULL input at the end in order to
995 * give the complete and correct output.
997 * NOTE: If this flag is not set, the codec is guaranteed to never be fed with
998 * with NULL data. The user can still send NULL data to the public encode
999 * or decode function, but libavcodec will not pass it along to the codec
1000 * unless this flag is set.
1003 * The decoder has a non-zero delay and needs to be fed with avpkt->data=NULL,
1004 * avpkt->size=0 at the end to get the delayed data until the decoder no longer
1008 * The encoder needs to be fed with NULL data at the end of encoding until the
1009 * encoder no longer returns data.
1011 * NOTE: For encoders implementing the AVCodec.encode2() function, setting this
1012 * flag also means that the encoder must set the pts and duration for
1013 * each output packet. If this flag is not set, the pts and duration will
1014 * be determined by libavcodec from the input frame.
1016 #define CODEC_CAP_DELAY 0x0020
1018 * Codec can be fed a final frame with a smaller size.
1019 * This can be used to prevent truncation of the last audio samples.
1021 #define CODEC_CAP_SMALL_LAST_FRAME 0x0040
1022 #if FF_API_CAP_VDPAU
1024 * Codec can export data for HW decoding (VDPAU).
1026 #define CODEC_CAP_HWACCEL_VDPAU 0x0080
1029 * Codec can output multiple frames per AVPacket
1030 * Normally demuxers return one frame at a time, demuxers which do not do
1031 * are connected to a parser to split what they return into proper frames.
1032 * This flag is reserved to the very rare category of codecs which have a
1033 * bitstream that cannot be split into frames without timeconsuming
1034 * operations like full decoding. Demuxers carring such bitstreams thus
1035 * may return multiple frames in a packet. This has many disadvantages like
1036 * prohibiting stream copy in many cases thus it should only be considered
1039 #define CODEC_CAP_SUBFRAMES 0x0100
1041 * Codec is experimental and is thus avoided in favor of non experimental
1044 #define CODEC_CAP_EXPERIMENTAL 0x0200
1046 * Codec should fill in channel configuration and samplerate instead of container
1048 #define CODEC_CAP_CHANNEL_CONF 0x0400
1049 #if FF_API_NEG_LINESIZES
1051 * @deprecated no codecs use this capability
1053 #define CODEC_CAP_NEG_LINESIZES 0x0800
1056 * Codec supports frame-level multithreading.
1058 #define CODEC_CAP_FRAME_THREADS 0x1000
1060 * Codec supports slice-based (or partition-based) multithreading.
1062 #define CODEC_CAP_SLICE_THREADS 0x2000
1064 * Codec supports changed parameters at any point.
1066 #define CODEC_CAP_PARAM_CHANGE 0x4000
1068 * Codec supports avctx->thread_count == 0 (auto).
1070 #define CODEC_CAP_AUTO_THREADS 0x8000
1072 * Audio encoder supports receiving a different number of samples in each call.
1074 #define CODEC_CAP_VARIABLE_FRAME_SIZE 0x10000
1075 #endif /* FF_API_WITHOUT_PREFIX */
1078 //The following defines may change, don't expect compatibility if you use them.
1079 #define MB_TYPE_INTRA4x4 0x0001
1080 #define MB_TYPE_INTRA16x16 0x0002 //FIXME H.264-specific
1081 #define MB_TYPE_INTRA_PCM 0x0004 //FIXME H.264-specific
1082 #define MB_TYPE_16x16 0x0008
1083 #define MB_TYPE_16x8 0x0010
1084 #define MB_TYPE_8x16 0x0020
1085 #define MB_TYPE_8x8 0x0040
1086 #define MB_TYPE_INTERLACED 0x0080
1087 #define MB_TYPE_DIRECT2 0x0100 //FIXME
1088 #define MB_TYPE_ACPRED 0x0200
1089 #define MB_TYPE_GMC 0x0400
1090 #define MB_TYPE_SKIP 0x0800
1091 #define MB_TYPE_P0L0 0x1000
1092 #define MB_TYPE_P1L0 0x2000
1093 #define MB_TYPE_P0L1 0x4000
1094 #define MB_TYPE_P1L1 0x8000
1095 #define MB_TYPE_L0 (MB_TYPE_P0L0 | MB_TYPE_P1L0)
1096 #define MB_TYPE_L1 (MB_TYPE_P0L1 | MB_TYPE_P1L1)
1097 #define MB_TYPE_L0L1 (MB_TYPE_L0 | MB_TYPE_L1)
1098 #define MB_TYPE_QUANT 0x00010000
1099 #define MB_TYPE_CBP 0x00020000
1100 //Note bits 24-31 are reserved for codec specific use (h264 ref0, mpeg1 0mv, ...)
1105 * This specifies the area which should be displayed.
1106 * Note there may be multiple such areas for one frame.
1108 typedef struct AVPanScan{
1111 * - encoding: Set by user.
1112 * - decoding: Set by libavcodec.
1117 * width and height in 1/16 pel
1118 * - encoding: Set by user.
1119 * - decoding: Set by libavcodec.
1125 * position of the top left corner in 1/16 pel for up to 3 fields/frames
1126 * - encoding: Set by user.
1127 * - decoding: Set by libavcodec.
1129 int16_t position[3][2];
1133 * This structure describes the bitrate properties of an encoded bitstream. It
1134 * roughly corresponds to a subset the VBV parameters for MPEG-2 or HRD
1135 * parameters for H.264/HEVC.
1137 typedef struct AVCPBProperties {
1139 * Maximum bitrate of the stream, in bits per second.
1140 * Zero if unknown or unspecified.
1144 * Minimum bitrate of the stream, in bits per second.
1145 * Zero if unknown or unspecified.
1149 * Average bitrate of the stream, in bits per second.
1150 * Zero if unknown or unspecified.
1155 * The size of the buffer to which the ratecontrol is applied, in bits.
1156 * Zero if unknown or unspecified.
1161 * The delay between the time the packet this structure is associated with
1162 * is received and the time when it should be decoded, in periods of a 27MHz
1165 * UINT64_MAX when unknown or unspecified.
1170 #if FF_API_QSCALE_TYPE
1171 #define FF_QSCALE_TYPE_MPEG1 0
1172 #define FF_QSCALE_TYPE_MPEG2 1
1173 #define FF_QSCALE_TYPE_H264 2
1174 #define FF_QSCALE_TYPE_VP56 3
1178 * The decoder will keep a reference to the frame and may reuse it later.
1180 #define AV_GET_BUFFER_FLAG_REF (1 << 0)
1183 * @defgroup lavc_packet AVPacket
1185 * Types and functions for working with AVPacket.
1188 enum AVPacketSideDataType {
1189 AV_PKT_DATA_PALETTE,
1190 AV_PKT_DATA_NEW_EXTRADATA,
1193 * An AV_PKT_DATA_PARAM_CHANGE side data packet is laid out as follows:
1196 * if (param_flags & AV_SIDE_DATA_PARAM_CHANGE_CHANNEL_COUNT)
1197 * s32le channel_count
1198 * if (param_flags & AV_SIDE_DATA_PARAM_CHANGE_CHANNEL_LAYOUT)
1199 * u64le channel_layout
1200 * if (param_flags & AV_SIDE_DATA_PARAM_CHANGE_SAMPLE_RATE)
1202 * if (param_flags & AV_SIDE_DATA_PARAM_CHANGE_DIMENSIONS)
1207 AV_PKT_DATA_PARAM_CHANGE,
1210 * An AV_PKT_DATA_H263_MB_INFO side data packet contains a number of
1211 * structures with info about macroblocks relevant to splitting the
1212 * packet into smaller packets on macroblock edges (e.g. as for RFC 2190).
1213 * That is, it does not necessarily contain info about all macroblocks,
1214 * as long as the distance between macroblocks in the info is smaller
1215 * than the target payload size.
1216 * Each MB info structure is 12 bytes, and is laid out as follows:
1218 * u32le bit offset from the start of the packet
1219 * u8 current quantizer at the start of the macroblock
1221 * u16le macroblock address within the GOB
1222 * u8 horizontal MV predictor
1223 * u8 vertical MV predictor
1224 * u8 horizontal MV predictor for block number 3
1225 * u8 vertical MV predictor for block number 3
1228 AV_PKT_DATA_H263_MB_INFO,
1231 * This side data should be associated with an audio stream and contains
1232 * ReplayGain information in form of the AVReplayGain struct.
1234 AV_PKT_DATA_REPLAYGAIN,
1237 * This side data contains a 3x3 transformation matrix describing an affine
1238 * transformation that needs to be applied to the decoded video frames for
1239 * correct presentation.
1241 * See libavutil/display.h for a detailed description of the data.
1243 AV_PKT_DATA_DISPLAYMATRIX,
1246 * This side data should be associated with a video stream and contains
1247 * Stereoscopic 3D information in form of the AVStereo3D struct.
1249 AV_PKT_DATA_STEREO3D,
1252 * This side data should be associated with an audio stream and corresponds
1253 * to enum AVAudioServiceType.
1255 AV_PKT_DATA_AUDIO_SERVICE_TYPE,
1258 * This side data contains an integer value representing the quality
1259 * factor of the compressed frame. Allowed range is between 1 (good)
1260 * and FF_LAMBDA_MAX (bad).
1262 AV_PKT_DATA_QUALITY_FACTOR,
1265 * This side data contains an integer value representing the stream index
1266 * of a "fallback" track. A fallback track indicates an alternate
1267 * track to use when the current track can not be decoded for some reason.
1268 * e.g. no decoder available for codec.
1270 AV_PKT_DATA_FALLBACK_TRACK,
1273 * This side data corresponds to the AVCPBProperties struct.
1275 AV_PKT_DATA_CPB_PROPERTIES,
1278 typedef struct AVPacketSideData {
1281 enum AVPacketSideDataType type;
1285 * This structure stores compressed data. It is typically exported by demuxers
1286 * and then passed as input to decoders, or received as output from encoders and
1287 * then passed to muxers.
1289 * For video, it should typically contain one compressed frame. For audio it may
1290 * contain several compressed frames. Encoders are allowed to output empty
1291 * packets, with no compressed data, containing only side data
1292 * (e.g. to update some stream parameters at the end of encoding).
1294 * AVPacket is one of the few structs in Libav, whose size is a part of public
1295 * ABI. Thus it may be allocated on stack and no new fields can be added to it
1296 * without libavcodec and libavformat major bump.
1298 * The semantics of data ownership depends on the buf field.
1299 * If it is set, the packet data is dynamically allocated and is
1300 * valid indefinitely until a call to av_packet_unref() reduces the
1301 * reference count to 0.
1303 * If the buf field is not set av_packet_ref() would make a copy instead
1304 * of increasing the reference count.
1306 * The side data is always allocated with av_malloc(), copied by
1307 * av_packet_ref() and freed by av_packet_unref().
1309 * @see av_packet_ref
1310 * @see av_packet_unref
1312 typedef struct AVPacket {
1314 * A reference to the reference-counted buffer where the packet data is
1316 * May be NULL, then the packet data is not reference-counted.
1320 * Presentation timestamp in AVStream->time_base units; the time at which
1321 * the decompressed packet will be presented to the user.
1322 * Can be AV_NOPTS_VALUE if it is not stored in the file.
1323 * pts MUST be larger or equal to dts as presentation cannot happen before
1324 * decompression, unless one wants to view hex dumps. Some formats misuse
1325 * the terms dts and pts/cts to mean something different. Such timestamps
1326 * must be converted to true pts/dts before they are stored in AVPacket.
1330 * Decompression timestamp in AVStream->time_base units; the time at which
1331 * the packet is decompressed.
1332 * Can be AV_NOPTS_VALUE if it is not stored in the file.
1339 * A combination of AV_PKT_FLAG values
1343 * Additional packet data that can be provided by the container.
1344 * Packet can contain several types of side information.
1346 AVPacketSideData *side_data;
1347 int side_data_elems;
1350 * Duration of this packet in AVStream->time_base units, 0 if unknown.
1351 * Equals next_pts - this_pts in presentation order.
1355 int64_t pos; ///< byte position in stream, -1 if unknown
1357 #if FF_API_CONVERGENCE_DURATION
1359 * @deprecated Same as the duration field, but as int64_t. This was required
1360 * for Matroska subtitles, whose duration values could overflow when the
1361 * duration field was still an int.
1363 attribute_deprecated
1364 int64_t convergence_duration;
1367 #define AV_PKT_FLAG_KEY 0x0001 ///< The packet contains a keyframe
1368 #define AV_PKT_FLAG_CORRUPT 0x0002 ///< The packet content is corrupted
1370 enum AVSideDataParamChangeFlags {
1371 AV_SIDE_DATA_PARAM_CHANGE_CHANNEL_COUNT = 0x0001,
1372 AV_SIDE_DATA_PARAM_CHANGE_CHANNEL_LAYOUT = 0x0002,
1373 AV_SIDE_DATA_PARAM_CHANGE_SAMPLE_RATE = 0x0004,
1374 AV_SIDE_DATA_PARAM_CHANGE_DIMENSIONS = 0x0008,
1380 struct AVCodecInternal;
1384 AV_FIELD_PROGRESSIVE,
1385 AV_FIELD_TT, //< Top coded_first, top displayed first
1386 AV_FIELD_BB, //< Bottom coded first, bottom displayed first
1387 AV_FIELD_TB, //< Top coded first, bottom displayed first
1388 AV_FIELD_BT, //< Bottom coded first, top displayed first
1392 * main external API structure.
1393 * New fields can be added to the end with minor version bumps.
1394 * Removal, reordering and changes to existing fields require a major
1396 * sizeof(AVCodecContext) must not be used outside libav*.
1398 typedef struct AVCodecContext {
1400 * information on struct for av_log
1401 * - set by avcodec_alloc_context3
1403 const AVClass *av_class;
1404 int log_level_offset;
1406 enum AVMediaType codec_type; /* see AVMEDIA_TYPE_xxx */
1407 const struct AVCodec *codec;
1408 #if FF_API_CODEC_NAME
1410 * @deprecated this field is not used for anything in libavcodec
1412 attribute_deprecated
1413 char codec_name[32];
1415 enum AVCodecID codec_id; /* see AV_CODEC_ID_xxx */
1418 * fourcc (LSB first, so "ABCD" -> ('D'<<24) + ('C'<<16) + ('B'<<8) + 'A').
1419 * This is used to work around some encoder bugs.
1420 * A demuxer should set this to what is stored in the field used to identify the codec.
1421 * If there are multiple such fields in a container then the demuxer should choose the one
1422 * which maximizes the information about the used codec.
1423 * If the codec tag field in a container is larger than 32 bits then the demuxer should
1424 * remap the longer ID to 32 bits with a table or other structure. Alternatively a new
1425 * extra_codec_tag + size could be added but for this a clear advantage must be demonstrated
1427 * - encoding: Set by user, if not then the default based on codec_id will be used.
1428 * - decoding: Set by user, will be converted to uppercase by libavcodec during init.
1430 unsigned int codec_tag;
1432 #if FF_API_STREAM_CODEC_TAG
1434 * @deprecated this field is unused
1436 attribute_deprecated
1437 unsigned int stream_codec_tag;
1443 * Private context used for internal data.
1445 * Unlike priv_data, this is not codec-specific. It is used in general
1446 * libavcodec functions.
1448 struct AVCodecInternal *internal;
1451 * Private data of the user, can be used to carry app specific stuff.
1452 * - encoding: Set by user.
1453 * - decoding: Set by user.
1458 * the average bitrate
1459 * - encoding: Set by user; unused for constant quantizer encoding.
1460 * - decoding: Set by libavcodec. 0 or some bitrate if this info is available in the stream.
1465 * number of bits the bitstream is allowed to diverge from the reference.
1466 * the reference can be CBR (for CBR pass1) or VBR (for pass2)
1467 * - encoding: Set by user; unused for constant quantizer encoding.
1468 * - decoding: unused
1470 int bit_rate_tolerance;
1473 * Global quality for codecs which cannot change it per frame.
1474 * This should be proportional to MPEG-1/2/4 qscale.
1475 * - encoding: Set by user.
1476 * - decoding: unused
1481 * - encoding: Set by user.
1482 * - decoding: unused
1484 int compression_level;
1485 #define FF_COMPRESSION_DEFAULT -1
1489 * - encoding: Set by user.
1490 * - decoding: Set by user.
1496 * - encoding: Set by user.
1497 * - decoding: Set by user.
1502 * some codecs need / can use extradata like Huffman tables.
1503 * mjpeg: Huffman tables
1504 * rv10: additional flags
1505 * mpeg4: global headers (they can be in the bitstream or here)
1506 * The allocated memory should be AV_INPUT_BUFFER_PADDING_SIZE bytes larger
1507 * than extradata_size to avoid prolems if it is read with the bitstream reader.
1508 * The bytewise contents of extradata must not depend on the architecture or CPU endianness.
1509 * - encoding: Set/allocated/freed by libavcodec.
1510 * - decoding: Set/allocated/freed by user.
1516 * This is the fundamental unit of time (in seconds) in terms
1517 * of which frame timestamps are represented. For fixed-fps content,
1518 * timebase should be 1/framerate and timestamp increments should be
1520 * - encoding: MUST be set by user.
1521 * - decoding: the use of this field for decoding is deprecated.
1522 * Use framerate instead.
1524 AVRational time_base;
1527 * For some codecs, the time base is closer to the field rate than the frame rate.
1528 * Most notably, H.264 and MPEG-2 specify time_base as half of frame duration
1529 * if no telecine is used ...
1531 * Set to time_base ticks per frame. Default 1, e.g., H.264/MPEG-2 set it to 2.
1533 int ticks_per_frame;
1539 * Number of frames the decoded output will be delayed relative to the
1543 * For encoding, this field is unused (see initial_padding).
1545 * For decoding, this is the number of samples the decoder needs to
1546 * output before the decoder's output is valid. When seeking, you should
1547 * start decoding this many samples prior to your desired seek point.
1549 * - encoding: Set by libavcodec.
1550 * - decoding: Set by libavcodec.
1557 * picture width / height.
1559 * @note Those fields may not match the values of the last
1560 * AVFrame outputted by avcodec_decode_video2 due frame
1563 * - encoding: MUST be set by user.
1564 * - decoding: May be set by the user before opening the decoder if known e.g.
1565 * from the container. Some decoders will require the dimensions
1566 * to be set by the caller. During decoding, the decoder may
1567 * overwrite those values as required while parsing the data.
1572 * Bitstream width / height, may be different from width/height e.g. when
1573 * the decoded frame is cropped before being output.
1575 * @note Those field may not match the value of the last
1576 * AVFrame outputted by avcodec_receive_frame() due frame
1579 * - encoding: unused
1580 * - decoding: May be set by the user before opening the decoder if known
1581 * e.g. from the container. During decoding, the decoder may
1582 * overwrite those values as required while parsing the data.
1584 int coded_width, coded_height;
1586 #if FF_API_ASPECT_EXTENDED
1587 #define FF_ASPECT_EXTENDED 15
1591 * the number of pictures in a group of pictures, or 0 for intra_only
1592 * - encoding: Set by user.
1593 * - decoding: unused
1598 * Pixel format, see AV_PIX_FMT_xxx.
1599 * May be set by the demuxer if known from headers.
1600 * May be overriden by the decoder if it knows better.
1602 * @note This field may not match the value of the last
1603 * AVFrame outputted by avcodec_receive_frame() due frame
1606 * - encoding: Set by user.
1607 * - decoding: Set by user if known, overridden by libavcodec while
1610 enum AVPixelFormat pix_fmt;
1612 #if FF_API_MOTION_EST
1614 * This option does nothing
1615 * @deprecated use codec private options instead
1617 attribute_deprecated int me_method;
1621 * If non NULL, 'draw_horiz_band' is called by the libavcodec
1622 * decoder to draw a horizontal band. It improves cache usage. Not
1623 * all codecs can do that. You must check the codec capabilities
1625 * When multithreading is used, it may be called from multiple threads
1626 * at the same time; threads might draw different parts of the same AVFrame,
1627 * or multiple AVFrames, and there is no guarantee that slices will be drawn
1629 * The function is also used by hardware acceleration APIs.
1630 * It is called at least once during frame decoding to pass
1631 * the data needed for hardware render.
1632 * In that mode instead of pixel data, AVFrame points to
1633 * a structure specific to the acceleration API. The application
1634 * reads the structure and can change some fields to indicate progress
1636 * - encoding: unused
1637 * - decoding: Set by user.
1638 * @param height the height of the slice
1639 * @param y the y position of the slice
1640 * @param type 1->top field, 2->bottom field, 3->frame
1641 * @param offset offset into the AVFrame.data from which the slice should be read
1643 void (*draw_horiz_band)(struct AVCodecContext *s,
1644 const AVFrame *src, int offset[AV_NUM_DATA_POINTERS],
1645 int y, int type, int height);
1648 * callback to negotiate the pixelFormat
1649 * @param fmt is the list of formats which are supported by the codec,
1650 * it is terminated by -1 as 0 is a valid format, the formats are ordered by quality.
1651 * The first is always the native one.
1652 * @note The callback may be called again immediately if initialization for
1653 * the selected (hardware-accelerated) pixel format failed.
1654 * @warning Behavior is undefined if the callback returns a value not
1655 * in the fmt list of formats.
1656 * @return the chosen format
1657 * - encoding: unused
1658 * - decoding: Set by user, if not set the native format will be chosen.
1660 enum AVPixelFormat (*get_format)(struct AVCodecContext *s, const enum AVPixelFormat * fmt);
1663 * maximum number of B-frames between non-B-frames
1664 * Note: The output will be delayed by max_b_frames+1 relative to the input.
1665 * - encoding: Set by user.
1666 * - decoding: unused
1671 * qscale factor between IP and B-frames
1672 * If > 0 then the last P-frame quantizer will be used (q= lastp_q*factor+offset).
1673 * If < 0 then normal ratecontrol will be done (q= -normal_q*factor+offset).
1674 * - encoding: Set by user.
1675 * - decoding: unused
1677 float b_quant_factor;
1679 #if FF_API_RC_STRATEGY
1680 /** @deprecated use codec private option instead */
1681 attribute_deprecated int rc_strategy;
1682 #define FF_RC_STRATEGY_XVID 1
1685 #if FF_API_PRIVATE_OPT
1686 /** @deprecated use encoder private options instead */
1687 attribute_deprecated
1688 int b_frame_strategy;
1692 * qscale offset between IP and B-frames
1693 * - encoding: Set by user.
1694 * - decoding: unused
1696 float b_quant_offset;
1699 * Size of the frame reordering buffer in the decoder.
1700 * For MPEG-2 it is 1 IPB or 0 low delay IP.
1701 * - encoding: Set by libavcodec.
1702 * - decoding: Set by libavcodec.
1706 #if FF_API_PRIVATE_OPT
1707 /** @deprecated use encoder private options instead */
1708 attribute_deprecated
1713 * qscale factor between P and I-frames
1714 * If > 0 then the last p frame quantizer will be used (q= lastp_q*factor+offset).
1715 * If < 0 then normal ratecontrol will be done (q= -normal_q*factor+offset).
1716 * - encoding: Set by user.
1717 * - decoding: unused
1719 float i_quant_factor;
1722 * qscale offset between P and I-frames
1723 * - encoding: Set by user.
1724 * - decoding: unused
1726 float i_quant_offset;
1729 * luminance masking (0-> disabled)
1730 * - encoding: Set by user.
1731 * - decoding: unused
1736 * temporary complexity masking (0-> disabled)
1737 * - encoding: Set by user.
1738 * - decoding: unused
1740 float temporal_cplx_masking;
1743 * spatial complexity masking (0-> disabled)
1744 * - encoding: Set by user.
1745 * - decoding: unused
1747 float spatial_cplx_masking;
1750 * p block masking (0-> disabled)
1751 * - encoding: Set by user.
1752 * - decoding: unused
1757 * darkness masking (0-> disabled)
1758 * - encoding: Set by user.
1759 * - decoding: unused
1765 * - encoding: Set by libavcodec.
1766 * - decoding: Set by user (or 0).
1770 #if FF_API_PRIVATE_OPT
1771 /** @deprecated use encoder private options instead */
1772 attribute_deprecated
1773 int prediction_method;
1774 #define FF_PRED_LEFT 0
1775 #define FF_PRED_PLANE 1
1776 #define FF_PRED_MEDIAN 2
1780 * slice offsets in the frame in bytes
1781 * - encoding: Set/allocated by libavcodec.
1782 * - decoding: Set/allocated by user (or NULL).
1787 * sample aspect ratio (0 if unknown)
1788 * That is the width of a pixel divided by the height of the pixel.
1789 * Numerator and denominator must be relatively prime and smaller than 256 for some video standards.
1790 * - encoding: Set by user.
1791 * - decoding: Set by libavcodec.
1793 AVRational sample_aspect_ratio;
1796 * motion estimation comparison function
1797 * - encoding: Set by user.
1798 * - decoding: unused
1802 * subpixel motion estimation comparison function
1803 * - encoding: Set by user.
1804 * - decoding: unused
1808 * macroblock comparison function (not supported yet)
1809 * - encoding: Set by user.
1810 * - decoding: unused
1814 * interlaced DCT comparison function
1815 * - encoding: Set by user.
1816 * - decoding: unused
1819 #define FF_CMP_SAD 0
1820 #define FF_CMP_SSE 1
1821 #define FF_CMP_SATD 2
1822 #define FF_CMP_DCT 3
1823 #define FF_CMP_PSNR 4
1824 #define FF_CMP_BIT 5
1826 #define FF_CMP_ZERO 7
1827 #define FF_CMP_VSAD 8
1828 #define FF_CMP_VSSE 9
1829 #define FF_CMP_NSSE 10
1830 #define FF_CMP_DCTMAX 13
1831 #define FF_CMP_DCT264 14
1832 #define FF_CMP_CHROMA 256
1835 * ME diamond size & shape
1836 * - encoding: Set by user.
1837 * - decoding: unused
1842 * amount of previous MV predictors (2a+1 x 2a+1 square)
1843 * - encoding: Set by user.
1844 * - decoding: unused
1846 int last_predictor_count;
1848 #if FF_API_PRIVATE_OPT
1849 /** @deprecated use encoder private options instead */
1850 attribute_deprecated
1855 * motion estimation prepass comparison function
1856 * - encoding: Set by user.
1857 * - decoding: unused
1862 * ME prepass diamond size & shape
1863 * - encoding: Set by user.
1864 * - decoding: unused
1870 * - encoding: Set by user.
1871 * - decoding: unused
1873 int me_subpel_quality;
1877 * DTG active format information (additional aspect ratio
1878 * information only used in DVB MPEG-2 transport streams)
1881 * - encoding: unused
1882 * - decoding: Set by decoder.
1883 * @deprecated Deprecated in favor of AVSideData
1885 attribute_deprecated int dtg_active_format;
1886 #define FF_DTG_AFD_SAME 8
1887 #define FF_DTG_AFD_4_3 9
1888 #define FF_DTG_AFD_16_9 10
1889 #define FF_DTG_AFD_14_9 11
1890 #define FF_DTG_AFD_4_3_SP_14_9 13
1891 #define FF_DTG_AFD_16_9_SP_14_9 14
1892 #define FF_DTG_AFD_SP_4_3 15
1893 #endif /* FF_API_AFD */
1896 * maximum motion estimation search range in subpel units
1897 * If 0 then no limit.
1899 * - encoding: Set by user.
1900 * - decoding: unused
1904 #if FF_API_QUANT_BIAS
1906 * @deprecated use encoder private option instead
1908 attribute_deprecated int intra_quant_bias;
1909 #define FF_DEFAULT_QUANT_BIAS 999999
1912 * @deprecated use encoder private option instead
1914 attribute_deprecated int inter_quant_bias;
1919 * - encoding: unused
1920 * - decoding: Set by user.
1923 #define SLICE_FLAG_CODED_ORDER 0x0001 ///< draw_horiz_band() is called in coded order instead of display
1924 #define SLICE_FLAG_ALLOW_FIELD 0x0002 ///< allow draw_horiz_band() with field slices (MPEG2 field pics)
1925 #define SLICE_FLAG_ALLOW_PLANE 0x0004 ///< allow draw_horiz_band() with 1 component at a time (SVQ1)
1929 * XVideo Motion Acceleration
1930 * - encoding: forbidden
1931 * - decoding: set by decoder
1932 * @deprecated XvMC support is slated for removal.
1934 attribute_deprecated int xvmc_acceleration;
1935 #endif /* FF_API_XVMC */
1938 * macroblock decision mode
1939 * - encoding: Set by user.
1940 * - decoding: unused
1943 #define FF_MB_DECISION_SIMPLE 0 ///< uses mb_cmp
1944 #define FF_MB_DECISION_BITS 1 ///< chooses the one which needs the fewest bits
1945 #define FF_MB_DECISION_RD 2 ///< rate distortion
1948 * custom intra quantization matrix
1949 * - encoding: Set by user, can be NULL.
1950 * - decoding: Set by libavcodec.
1952 uint16_t *intra_matrix;
1955 * custom inter quantization matrix
1956 * - encoding: Set by user, can be NULL.
1957 * - decoding: Set by libavcodec.
1959 uint16_t *inter_matrix;
1961 #if FF_API_PRIVATE_OPT
1962 /** @deprecated use encoder private options instead */
1963 attribute_deprecated
1964 int scenechange_threshold;
1966 /** @deprecated use encoder private options instead */
1967 attribute_deprecated
1968 int noise_reduction;
1973 * @deprecated this field is unused
1975 attribute_deprecated
1979 * @deprecated this field is unused
1981 attribute_deprecated
1986 * precision of the intra DC coefficient - 8
1987 * - encoding: Set by user.
1988 * - decoding: unused
1990 int intra_dc_precision;
1993 * Number of macroblock rows at the top which are skipped.
1994 * - encoding: unused
1995 * - decoding: Set by user.
2000 * Number of macroblock rows at the bottom which are skipped.
2001 * - encoding: unused
2002 * - decoding: Set by user.
2008 * @deprecated use encoder private options instead
2010 attribute_deprecated
2011 float border_masking;
2015 * minimum MB lagrange multipler
2016 * - encoding: Set by user.
2017 * - decoding: unused
2022 * maximum MB lagrange multipler
2023 * - encoding: Set by user.
2024 * - decoding: unused
2028 #if FF_API_PRIVATE_OPT
2030 * @deprecated use encoder private options instead
2032 attribute_deprecated
2033 int me_penalty_compensation;
2037 * - encoding: Set by user.
2038 * - decoding: unused
2042 #if FF_API_PRIVATE_OPT
2043 /** @deprecated use encoder private options instead */
2044 attribute_deprecated
2050 * - encoding: Set by user.
2051 * - decoding: unused
2056 * number of reference frames
2057 * - encoding: Set by user.
2058 * - decoding: Set by lavc.
2062 #if FF_API_PRIVATE_OPT
2063 /** @deprecated use encoder private options instead */
2064 attribute_deprecated
2068 #if FF_API_UNUSED_MEMBERS
2070 * Multiplied by qscale for each frame and added to scene_change_score.
2071 * - encoding: Set by user.
2072 * - decoding: unused
2074 attribute_deprecated int scenechange_factor;
2078 * Note: Value depends upon the compare function used for fullpel ME.
2079 * - encoding: Set by user.
2080 * - decoding: unused
2084 #if FF_API_PRIVATE_OPT
2085 /** @deprecated use encoder private options instead */
2086 attribute_deprecated
2091 * Chromaticity coordinates of the source primaries.
2092 * - encoding: Set by user
2093 * - decoding: Set by libavcodec
2095 enum AVColorPrimaries color_primaries;
2098 * Color Transfer Characteristic.
2099 * - encoding: Set by user
2100 * - decoding: Set by libavcodec
2102 enum AVColorTransferCharacteristic color_trc;
2105 * YUV colorspace type.
2106 * - encoding: Set by user
2107 * - decoding: Set by libavcodec
2109 enum AVColorSpace colorspace;
2112 * MPEG vs JPEG YUV range.
2113 * - encoding: Set by user
2114 * - decoding: Set by libavcodec
2116 enum AVColorRange color_range;
2119 * This defines the location of chroma samples.
2120 * - encoding: Set by user
2121 * - decoding: Set by libavcodec
2123 enum AVChromaLocation chroma_sample_location;
2127 * Indicates number of picture subdivisions. Used for parallelized
2129 * - encoding: Set by user
2130 * - decoding: unused
2135 * - encoding: set by libavcodec
2136 * - decoding: Set by libavcodec
2138 enum AVFieldOrder field_order;
2141 int sample_rate; ///< samples per second
2142 int channels; ///< number of audio channels
2145 * audio sample format
2146 * - encoding: Set by user.
2147 * - decoding: Set by libavcodec.
2149 enum AVSampleFormat sample_fmt; ///< sample format
2151 /* The following data should not be initialized. */
2153 * Number of samples per channel in an audio frame.
2155 * - encoding: set by libavcodec in avcodec_open2(). Each submitted frame
2156 * except the last must contain exactly frame_size samples per channel.
2157 * May be 0 when the codec has AV_CODEC_CAP_VARIABLE_FRAME_SIZE set, then the
2158 * frame size is not restricted.
2159 * - decoding: may be set by some decoders to indicate constant frame size
2164 * Frame counter, set by libavcodec.
2166 * - decoding: total number of frames returned from the decoder so far.
2167 * - encoding: total number of frames passed to the encoder so far.
2169 * @note the counter is not incremented if encoding/decoding resulted in
2175 * number of bytes per packet if constant and known or 0
2176 * Used by some WAV based audio codecs.
2181 * Audio cutoff bandwidth (0 means "automatic")
2182 * - encoding: Set by user.
2183 * - decoding: unused
2188 * Audio channel layout.
2189 * - encoding: set by user.
2190 * - decoding: set by libavcodec.
2192 uint64_t channel_layout;
2195 * Request decoder to use this channel layout if it can (0 for default)
2196 * - encoding: unused
2197 * - decoding: Set by user.
2199 uint64_t request_channel_layout;
2202 * Type of service that the audio stream conveys.
2203 * - encoding: Set by user.
2204 * - decoding: Set by libavcodec.
2206 enum AVAudioServiceType audio_service_type;
2209 * Used to request a sample format from the decoder.
2210 * - encoding: unused.
2211 * - decoding: Set by user.
2213 enum AVSampleFormat request_sample_fmt;
2216 * This callback is called at the beginning of each frame to get data
2217 * buffer(s) for it. There may be one contiguous buffer for all the data or
2218 * there may be a buffer per each data plane or anything in between. What
2219 * this means is, you may set however many entries in buf[] you feel necessary.
2220 * Each buffer must be reference-counted using the AVBuffer API (see description
2223 * The following fields will be set in the frame before this callback is
2226 * - width, height (video only)
2227 * - sample_rate, channel_layout, nb_samples (audio only)
2228 * Their values may differ from the corresponding values in
2229 * AVCodecContext. This callback must use the frame values, not the codec
2230 * context values, to calculate the required buffer size.
2232 * This callback must fill the following fields in the frame:
2236 * * if the data is planar audio with more than 8 channels, then this
2237 * callback must allocate and fill extended_data to contain all pointers
2238 * to all data planes. data[] must hold as many pointers as it can.
2239 * extended_data must be allocated with av_malloc() and will be freed in
2241 * * otherwise exended_data must point to data
2242 * - buf[] must contain one or more pointers to AVBufferRef structures. Each of
2243 * the frame's data and extended_data pointers must be contained in these. That
2244 * is, one AVBufferRef for each allocated chunk of memory, not necessarily one
2245 * AVBufferRef per data[] entry. See: av_buffer_create(), av_buffer_alloc(),
2246 * and av_buffer_ref().
2247 * - extended_buf and nb_extended_buf must be allocated with av_malloc() by
2248 * this callback and filled with the extra buffers if there are more
2249 * buffers than buf[] can hold. extended_buf will be freed in
2252 * If AV_CODEC_CAP_DR1 is not set then get_buffer2() must call
2253 * avcodec_default_get_buffer2() instead of providing buffers allocated by
2256 * Each data plane must be aligned to the maximum required by the target
2259 * @see avcodec_default_get_buffer2()
2263 * If AV_GET_BUFFER_FLAG_REF is set in flags then the frame may be reused
2264 * (read and/or written to if it is writable) later by libavcodec.
2266 * avcodec_align_dimensions2() should be used to find the required width and
2267 * height, as they normally need to be rounded up to the next multiple of 16.
2269 * If frame multithreading is used and thread_safe_callbacks is set,
2270 * this callback may be called from a different thread, but not from more
2271 * than one at once. Does not need to be reentrant.
2273 * @see avcodec_align_dimensions2()
2277 * Decoders request a buffer of a particular size by setting
2278 * AVFrame.nb_samples prior to calling get_buffer2(). The decoder may,
2279 * however, utilize only part of the buffer by setting AVFrame.nb_samples
2280 * to a smaller value in the output frame.
2282 * As a convenience, av_samples_get_buffer_size() and
2283 * av_samples_fill_arrays() in libavutil may be used by custom get_buffer2()
2284 * functions to find the required data size and to fill data pointers and
2285 * linesize. In AVFrame.linesize, only linesize[0] may be set for audio
2286 * since all planes must be the same size.
2288 * @see av_samples_get_buffer_size(), av_samples_fill_arrays()
2290 * - encoding: unused
2291 * - decoding: Set by libavcodec, user can override.
2293 int (*get_buffer2)(struct AVCodecContext *s, AVFrame *frame, int flags);
2296 * If non-zero, the decoded audio and video frames returned from
2297 * avcodec_decode_video2() and avcodec_decode_audio4() are reference-counted
2298 * and are valid indefinitely. The caller must free them with
2299 * av_frame_unref() when they are not needed anymore.
2300 * Otherwise, the decoded frames must not be freed by the caller and are
2301 * only valid until the next decode call.
2303 * This is always automatically enabled if avcodec_receive_frame() is used.
2305 * - encoding: unused
2306 * - decoding: set by the caller before avcodec_open2().
2308 int refcounted_frames;
2310 /* - encoding parameters */
2311 float qcompress; ///< amount of qscale change between easy & hard scenes (0.0-1.0)
2312 float qblur; ///< amount of qscale smoothing over time (0.0-1.0)
2316 * - encoding: Set by user.
2317 * - decoding: unused
2323 * - encoding: Set by user.
2324 * - decoding: unused
2329 * maximum quantizer difference between frames
2330 * - encoding: Set by user.
2331 * - decoding: unused
2337 * @deprecated use encoder private options instead
2339 attribute_deprecated
2342 attribute_deprecated
2344 attribute_deprecated
2349 * decoder bitstream buffer size
2350 * - encoding: Set by user.
2351 * - decoding: unused
2356 * ratecontrol override, see RcOverride
2357 * - encoding: Allocated/set/freed by user.
2358 * - decoding: unused
2360 int rc_override_count;
2361 RcOverride *rc_override;
2365 * @deprecated use encoder private options instead
2367 attribute_deprecated
2373 * - encoding: Set by user.
2374 * - decoding: unused
2380 * - encoding: Set by user.
2381 * - decoding: unused
2387 * @deprecated use encoder private options instead
2389 attribute_deprecated
2390 float rc_buffer_aggressivity;
2392 attribute_deprecated
2393 float rc_initial_cplx;
2397 * Ratecontrol attempt to use, at maximum, <value> of what can be used without an underflow.
2398 * - encoding: Set by user.
2399 * - decoding: unused.
2401 float rc_max_available_vbv_use;
2404 * Ratecontrol attempt to use, at least, <value> times the amount needed to prevent a vbv overflow.
2405 * - encoding: Set by user.
2406 * - decoding: unused.
2408 float rc_min_vbv_overflow_use;
2411 * Number of bits which should be loaded into the rc buffer before decoding starts.
2412 * - encoding: Set by user.
2413 * - decoding: unused
2415 int rc_initial_buffer_occupancy;
2417 #if FF_API_CODER_TYPE
2418 #define FF_CODER_TYPE_VLC 0
2419 #define FF_CODER_TYPE_AC 1
2420 #define FF_CODER_TYPE_RAW 2
2421 #define FF_CODER_TYPE_RLE 3
2422 #if FF_API_UNUSED_MEMBERS
2423 #define FF_CODER_TYPE_DEFLATE 4
2424 #endif /* FF_API_UNUSED_MEMBERS */
2426 * @deprecated use encoder private options instead
2428 attribute_deprecated
2430 #endif /* FF_API_CODER_TYPE */
2432 #if FF_API_PRIVATE_OPT
2433 /** @deprecated use encoder private options instead */
2434 attribute_deprecated
2440 * @deprecated use encoder private options instead
2442 attribute_deprecated
2446 * @deprecated use encoder private options instead
2448 attribute_deprecated
2452 #if FF_API_PRIVATE_OPT
2453 /** @deprecated use encoder private options instead */
2454 attribute_deprecated
2455 int frame_skip_threshold;
2457 /** @deprecated use encoder private options instead */
2458 attribute_deprecated
2459 int frame_skip_factor;
2461 /** @deprecated use encoder private options instead */
2462 attribute_deprecated
2465 /** @deprecated use encoder private options instead */
2466 attribute_deprecated
2468 #endif /* FF_API_PRIVATE_OPT */
2471 * trellis RD quantization
2472 * - encoding: Set by user.
2473 * - decoding: unused
2477 #if FF_API_PRIVATE_OPT
2478 /** @deprecated use encoder private options instead */
2479 attribute_deprecated
2480 int min_prediction_order;
2482 /** @deprecated use encoder private options instead */
2483 attribute_deprecated
2484 int max_prediction_order;
2486 /** @deprecated use encoder private options instead */
2487 attribute_deprecated
2488 int64_t timecode_frame_start;
2491 #if FF_API_RTP_CALLBACK
2493 * @deprecated unused
2495 /* The RTP callback: This function is called */
2496 /* every time the encoder has a packet to send. */
2497 /* It depends on the encoder if the data starts */
2498 /* with a Start Code (it should). H.263 does. */
2499 /* mb_nb contains the number of macroblocks */
2500 /* encoded in the RTP payload. */
2501 attribute_deprecated
2502 void (*rtp_callback)(struct AVCodecContext *avctx, void *data, int size, int mb_nb);
2505 #if FF_API_PRIVATE_OPT
2506 /** @deprecated use encoder private options instead */
2507 attribute_deprecated
2508 int rtp_payload_size; /* The size of the RTP payload: the coder will */
2509 /* do its best to deliver a chunk with size */
2510 /* below rtp_payload_size, the chunk will start */
2511 /* with a start code on some codecs like H.263. */
2512 /* This doesn't take account of any particular */
2513 /* headers inside the transmitted RTP payload. */
2516 #if FF_API_STAT_BITS
2517 /* statistics, used for 2-pass encoding */
2518 attribute_deprecated
2520 attribute_deprecated
2522 attribute_deprecated
2524 attribute_deprecated
2526 attribute_deprecated
2528 attribute_deprecated
2530 attribute_deprecated
2532 attribute_deprecated
2535 /** @deprecated this field is unused */
2536 attribute_deprecated
2541 * pass1 encoding statistics output buffer
2542 * - encoding: Set by libavcodec.
2543 * - decoding: unused
2548 * pass2 encoding statistics input buffer
2549 * Concatenated stuff from stats_out of pass1 should be placed here.
2550 * - encoding: Allocated/set/freed by user.
2551 * - decoding: unused
2556 * Work around bugs in encoders which sometimes cannot be detected automatically.
2557 * - encoding: Set by user
2558 * - decoding: Set by user
2560 int workaround_bugs;
2561 #define FF_BUG_AUTODETECT 1 ///< autodetection
2562 #if FF_API_OLD_MSMPEG4
2563 #define FF_BUG_OLD_MSMPEG4 2
2565 #define FF_BUG_XVID_ILACE 4
2566 #define FF_BUG_UMP4 8
2567 #define FF_BUG_NO_PADDING 16
2568 #define FF_BUG_AMV 32
2570 #define FF_BUG_AC_VLC 0 ///< Will be removed, libavcodec can now handle these non-compliant files by default.
2572 #define FF_BUG_QPEL_CHROMA 64
2573 #define FF_BUG_STD_QPEL 128
2574 #define FF_BUG_QPEL_CHROMA2 256
2575 #define FF_BUG_DIRECT_BLOCKSIZE 512
2576 #define FF_BUG_EDGE 1024
2577 #define FF_BUG_HPEL_CHROMA 2048
2578 #define FF_BUG_DC_CLIP 4096
2579 #define FF_BUG_MS 8192 ///< Work around various bugs in Microsoft's broken decoders.
2580 #define FF_BUG_TRUNCATED 16384
2583 * strictly follow the standard (MPEG4, ...).
2584 * - encoding: Set by user.
2585 * - decoding: Set by user.
2586 * Setting this to STRICT or higher means the encoder and decoder will
2587 * generally do stupid things, whereas setting it to unofficial or lower
2588 * will mean the encoder might produce output that is not supported by all
2589 * spec-compliant decoders. Decoders don't differentiate between normal,
2590 * unofficial and experimental (that is, they always try to decode things
2591 * when they can) unless they are explicitly asked to behave stupidly
2592 * (=strictly conform to the specs)
2594 int strict_std_compliance;
2595 #define FF_COMPLIANCE_VERY_STRICT 2 ///< Strictly conform to an older more strict version of the spec or reference software.
2596 #define FF_COMPLIANCE_STRICT 1 ///< Strictly conform to all the things in the spec no matter what consequences.
2597 #define FF_COMPLIANCE_NORMAL 0
2598 #define FF_COMPLIANCE_UNOFFICIAL -1 ///< Allow unofficial extensions
2599 #define FF_COMPLIANCE_EXPERIMENTAL -2 ///< Allow nonstandardized experimental things.
2602 * error concealment flags
2603 * - encoding: unused
2604 * - decoding: Set by user.
2606 int error_concealment;
2607 #define FF_EC_GUESS_MVS 1
2608 #define FF_EC_DEBLOCK 2
2612 * - encoding: Set by user.
2613 * - decoding: Set by user.
2616 #define FF_DEBUG_PICT_INFO 1
2617 #define FF_DEBUG_RC 2
2618 #define FF_DEBUG_BITSTREAM 4
2619 #define FF_DEBUG_MB_TYPE 8
2620 #define FF_DEBUG_QP 16
2623 * @deprecated this option does nothing
2625 #define FF_DEBUG_MV 32
2627 #define FF_DEBUG_DCT_COEFF 0x00000040
2628 #define FF_DEBUG_SKIP 0x00000080
2629 #define FF_DEBUG_STARTCODE 0x00000100
2630 #if FF_API_UNUSED_MEMBERS
2631 #define FF_DEBUG_PTS 0x00000200
2632 #endif /* FF_API_UNUSED_MEMBERS */
2633 #define FF_DEBUG_ER 0x00000400
2634 #define FF_DEBUG_MMCO 0x00000800
2635 #define FF_DEBUG_BUGS 0x00001000
2637 #define FF_DEBUG_VIS_QP 0x00002000
2638 #define FF_DEBUG_VIS_MB_TYPE 0x00004000
2640 #define FF_DEBUG_BUFFERS 0x00008000
2641 #define FF_DEBUG_THREADS 0x00010000
2645 * @deprecated this option does not have any effect
2647 attribute_deprecated
2649 #define FF_DEBUG_VIS_MV_P_FOR 0x00000001 //visualize forward predicted MVs of P frames
2650 #define FF_DEBUG_VIS_MV_B_FOR 0x00000002 //visualize forward predicted MVs of B frames
2651 #define FF_DEBUG_VIS_MV_B_BACK 0x00000004 //visualize backward predicted MVs of B frames
2655 * Error recognition; may misdetect some more or less valid parts as errors.
2656 * - encoding: unused
2657 * - decoding: Set by user.
2659 int err_recognition;
2662 * Verify checksums embedded in the bitstream (could be of either encoded or
2663 * decoded data, depending on the codec) and print an error message on mismatch.
2664 * If AV_EF_EXPLODE is also set, a mismatching checksum will result in the
2665 * decoder returning an error.
2667 #define AV_EF_CRCCHECK (1<<0)
2668 #define AV_EF_BITSTREAM (1<<1)
2669 #define AV_EF_BUFFER (1<<2)
2670 #define AV_EF_EXPLODE (1<<3)
2673 * opaque 64bit number (generally a PTS) that will be reordered and
2674 * output in AVFrame.reordered_opaque
2675 * - encoding: unused
2676 * - decoding: Set by user.
2678 int64_t reordered_opaque;
2681 * Hardware accelerator in use
2682 * - encoding: unused.
2683 * - decoding: Set by libavcodec
2685 struct AVHWAccel *hwaccel;
2688 * Hardware accelerator context.
2689 * For some hardware accelerators, a global context needs to be
2690 * provided by the user. In that case, this holds display-dependent
2691 * data Libav cannot instantiate itself. Please refer to the
2692 * Libav HW accelerator documentation to know how to fill this
2693 * is. e.g. for VA API, this is a struct vaapi_context.
2694 * - encoding: unused
2695 * - decoding: Set by user
2697 void *hwaccel_context;
2701 * - encoding: Set by libavcodec if flags & AV_CODEC_FLAG_PSNR.
2702 * - decoding: unused
2704 uint64_t error[AV_NUM_DATA_POINTERS];
2707 * DCT algorithm, see FF_DCT_* below
2708 * - encoding: Set by user.
2709 * - decoding: unused
2712 #define FF_DCT_AUTO 0
2713 #define FF_DCT_FASTINT 1
2714 #define FF_DCT_INT 2
2715 #define FF_DCT_MMX 3
2716 #define FF_DCT_ALTIVEC 5
2717 #define FF_DCT_FAAN 6
2720 * IDCT algorithm, see FF_IDCT_* below.
2721 * - encoding: Set by user.
2722 * - decoding: Set by user.
2725 #define FF_IDCT_AUTO 0
2726 #define FF_IDCT_INT 1
2727 #define FF_IDCT_SIMPLE 2
2728 #define FF_IDCT_SIMPLEMMX 3
2729 #define FF_IDCT_ARM 7
2730 #define FF_IDCT_ALTIVEC 8
2732 #define FF_IDCT_SH4 9
2734 #define FF_IDCT_SIMPLEARM 10
2735 #if FF_API_UNUSED_MEMBERS
2736 #define FF_IDCT_IPP 13
2737 #endif /* FF_API_UNUSED_MEMBERS */
2738 #define FF_IDCT_XVID 14
2739 #if FF_API_IDCT_XVIDMMX
2740 #define FF_IDCT_XVIDMMX 14
2741 #endif /* FF_API_IDCT_XVIDMMX */
2742 #define FF_IDCT_SIMPLEARMV5TE 16
2743 #define FF_IDCT_SIMPLEARMV6 17
2744 #if FF_API_ARCH_SPARC
2745 #define FF_IDCT_SIMPLEVIS 18
2747 #define FF_IDCT_FAAN 20
2748 #define FF_IDCT_SIMPLENEON 22
2749 #if FF_API_ARCH_ALPHA
2750 #define FF_IDCT_SIMPLEALPHA 23
2754 * bits per sample/pixel from the demuxer (needed for huffyuv).
2755 * - encoding: Set by libavcodec.
2756 * - decoding: Set by user.
2758 int bits_per_coded_sample;
2761 * Bits per sample/pixel of internal libavcodec pixel/sample format.
2762 * - encoding: set by user.
2763 * - decoding: set by libavcodec.
2765 int bits_per_raw_sample;
2769 * low resolution decoding, 1-> 1/2 size, 2->1/4 size
2770 * - encoding: unused
2771 * - decoding: Set by user.
2773 * @deprecated use decoder private options instead
2775 attribute_deprecated int lowres;
2778 #if FF_API_CODED_FRAME
2780 * the picture in the bitstream
2781 * - encoding: Set by libavcodec.
2782 * - decoding: unused
2784 * @deprecated use the quality factor packet side data instead
2786 attribute_deprecated AVFrame *coded_frame;
2791 * is used to decide how many independent tasks should be passed to execute()
2792 * - encoding: Set by user.
2793 * - decoding: Set by user.
2798 * Which multithreading methods to use.
2799 * Use of FF_THREAD_FRAME will increase decoding delay by one frame per thread,
2800 * so clients which cannot provide future frames should not use it.
2802 * - encoding: Set by user, otherwise the default is used.
2803 * - decoding: Set by user, otherwise the default is used.
2806 #define FF_THREAD_FRAME 1 ///< Decode more than one frame at once
2807 #define FF_THREAD_SLICE 2 ///< Decode more than one part of a single frame at once
2810 * Which multithreading methods are in use by the codec.
2811 * - encoding: Set by libavcodec.
2812 * - decoding: Set by libavcodec.
2814 int active_thread_type;
2817 * Set by the client if its custom get_buffer() callback can be called
2818 * synchronously from another thread, which allows faster multithreaded decoding.
2819 * draw_horiz_band() will be called from other threads regardless of this setting.
2820 * Ignored if the default get_buffer() is used.
2821 * - encoding: Set by user.
2822 * - decoding: Set by user.
2824 int thread_safe_callbacks;
2827 * The codec may call this to execute several independent things.
2828 * It will return only after finishing all tasks.
2829 * The user may replace this with some multithreaded implementation,
2830 * the default implementation will execute the parts serially.
2831 * @param count the number of things to execute
2832 * - encoding: Set by libavcodec, user can override.
2833 * - decoding: Set by libavcodec, user can override.
2835 int (*execute)(struct AVCodecContext *c, int (*func)(struct AVCodecContext *c2, void *arg), void *arg2, int *ret, int count, int size);
2838 * The codec may call this to execute several independent things.
2839 * It will return only after finishing all tasks.
2840 * The user may replace this with some multithreaded implementation,
2841 * the default implementation will execute the parts serially.
2842 * Also see avcodec_thread_init and e.g. the --enable-pthread configure option.
2843 * @param c context passed also to func
2844 * @param count the number of things to execute
2845 * @param arg2 argument passed unchanged to func
2846 * @param ret return values of executed functions, must have space for "count" values. May be NULL.
2847 * @param func function that will be called count times, with jobnr from 0 to count-1.
2848 * threadnr will be in the range 0 to c->thread_count-1 < MAX_THREADS and so that no
2849 * two instances of func executing at the same time will have the same threadnr.
2850 * @return always 0 currently, but code should handle a future improvement where when any call to func
2851 * returns < 0 no further calls to func may be done and < 0 is returned.
2852 * - encoding: Set by libavcodec, user can override.
2853 * - decoding: Set by libavcodec, user can override.
2855 int (*execute2)(struct AVCodecContext *c, int (*func)(struct AVCodecContext *c2, void *arg, int jobnr, int threadnr), void *arg2, int *ret, int count);
2858 * noise vs. sse weight for the nsse comparsion function
2859 * - encoding: Set by user.
2860 * - decoding: unused
2866 * - encoding: Set by user.
2867 * - decoding: Set by libavcodec.
2870 #define FF_PROFILE_UNKNOWN -99
2871 #define FF_PROFILE_RESERVED -100
2873 #define FF_PROFILE_AAC_MAIN 0
2874 #define FF_PROFILE_AAC_LOW 1
2875 #define FF_PROFILE_AAC_SSR 2
2876 #define FF_PROFILE_AAC_LTP 3
2877 #define FF_PROFILE_AAC_HE 4
2878 #define FF_PROFILE_AAC_HE_V2 28
2879 #define FF_PROFILE_AAC_LD 22
2880 #define FF_PROFILE_AAC_ELD 38
2881 #define FF_PROFILE_MPEG2_AAC_LOW 128
2882 #define FF_PROFILE_MPEG2_AAC_HE 131
2884 #define FF_PROFILE_DTS 20
2885 #define FF_PROFILE_DTS_ES 30
2886 #define FF_PROFILE_DTS_96_24 40
2887 #define FF_PROFILE_DTS_HD_HRA 50
2888 #define FF_PROFILE_DTS_HD_MA 60
2889 #define FF_PROFILE_DTS_EXPRESS 70
2891 #define FF_PROFILE_MPEG2_422 0
2892 #define FF_PROFILE_MPEG2_HIGH 1
2893 #define FF_PROFILE_MPEG2_SS 2
2894 #define FF_PROFILE_MPEG2_SNR_SCALABLE 3
2895 #define FF_PROFILE_MPEG2_MAIN 4
2896 #define FF_PROFILE_MPEG2_SIMPLE 5
2898 #define FF_PROFILE_H264_CONSTRAINED (1<<9) // 8+1; constraint_set1_flag
2899 #define FF_PROFILE_H264_INTRA (1<<11) // 8+3; constraint_set3_flag
2901 #define FF_PROFILE_H264_BASELINE 66
2902 #define FF_PROFILE_H264_CONSTRAINED_BASELINE (66|FF_PROFILE_H264_CONSTRAINED)
2903 #define FF_PROFILE_H264_MAIN 77
2904 #define FF_PROFILE_H264_EXTENDED 88
2905 #define FF_PROFILE_H264_HIGH 100
2906 #define FF_PROFILE_H264_HIGH_10 110
2907 #define FF_PROFILE_H264_HIGH_10_INTRA (110|FF_PROFILE_H264_INTRA)
2908 #define FF_PROFILE_H264_HIGH_422 122
2909 #define FF_PROFILE_H264_HIGH_422_INTRA (122|FF_PROFILE_H264_INTRA)
2910 #define FF_PROFILE_H264_HIGH_444 144
2911 #define FF_PROFILE_H264_HIGH_444_PREDICTIVE 244
2912 #define FF_PROFILE_H264_HIGH_444_INTRA (244|FF_PROFILE_H264_INTRA)
2913 #define FF_PROFILE_H264_CAVLC_444 44
2915 #define FF_PROFILE_VC1_SIMPLE 0
2916 #define FF_PROFILE_VC1_MAIN 1
2917 #define FF_PROFILE_VC1_COMPLEX 2
2918 #define FF_PROFILE_VC1_ADVANCED 3
2920 #define FF_PROFILE_MPEG4_SIMPLE 0
2921 #define FF_PROFILE_MPEG4_SIMPLE_SCALABLE 1
2922 #define FF_PROFILE_MPEG4_CORE 2
2923 #define FF_PROFILE_MPEG4_MAIN 3
2924 #define FF_PROFILE_MPEG4_N_BIT 4
2925 #define FF_PROFILE_MPEG4_SCALABLE_TEXTURE 5
2926 #define FF_PROFILE_MPEG4_SIMPLE_FACE_ANIMATION 6
2927 #define FF_PROFILE_MPEG4_BASIC_ANIMATED_TEXTURE 7
2928 #define FF_PROFILE_MPEG4_HYBRID 8
2929 #define FF_PROFILE_MPEG4_ADVANCED_REAL_TIME 9
2930 #define FF_PROFILE_MPEG4_CORE_SCALABLE 10
2931 #define FF_PROFILE_MPEG4_ADVANCED_CODING 11
2932 #define FF_PROFILE_MPEG4_ADVANCED_CORE 12
2933 #define FF_PROFILE_MPEG4_ADVANCED_SCALABLE_TEXTURE 13
2934 #define FF_PROFILE_MPEG4_SIMPLE_STUDIO 14
2935 #define FF_PROFILE_MPEG4_ADVANCED_SIMPLE 15
2937 #define FF_PROFILE_JPEG2000_CSTREAM_RESTRICTION_0 0
2938 #define FF_PROFILE_JPEG2000_CSTREAM_RESTRICTION_1 1
2939 #define FF_PROFILE_JPEG2000_CSTREAM_NO_RESTRICTION 2
2940 #define FF_PROFILE_JPEG2000_DCINEMA_2K 3
2941 #define FF_PROFILE_JPEG2000_DCINEMA_4K 4
2943 #define FF_PROFILE_VP9_0 0
2944 #define FF_PROFILE_VP9_1 1
2945 #define FF_PROFILE_VP9_2 2
2946 #define FF_PROFILE_VP9_3 3
2948 #define FF_PROFILE_HEVC_MAIN 1
2949 #define FF_PROFILE_HEVC_MAIN_10 2
2950 #define FF_PROFILE_HEVC_MAIN_STILL_PICTURE 3
2954 * - encoding: Set by user.
2955 * - decoding: Set by libavcodec.
2958 #define FF_LEVEL_UNKNOWN -99
2961 * - encoding: unused
2962 * - decoding: Set by user.
2964 enum AVDiscard skip_loop_filter;
2967 * - encoding: unused
2968 * - decoding: Set by user.
2970 enum AVDiscard skip_idct;
2973 * - encoding: unused
2974 * - decoding: Set by user.
2976 enum AVDiscard skip_frame;
2979 * Header containing style information for text subtitles.
2980 * For SUBTITLE_ASS subtitle type, it should contain the whole ASS
2981 * [Script Info] and [V4+ Styles] section, plus the [Events] line and
2982 * the Format line following. It shouldn't include any Dialogue line.
2983 * - encoding: Set/allocated/freed by user (before avcodec_open2())
2984 * - decoding: Set/allocated/freed by libavcodec (by avcodec_open2())
2986 uint8_t *subtitle_header;
2987 int subtitle_header_size;
2989 #if FF_API_ERROR_RATE
2991 * @deprecated use the 'error_rate' private AVOption of the mpegvideo
2994 attribute_deprecated
2998 #if FF_API_VBV_DELAY
3000 * VBV delay coded in the last frame (in periods of a 27 MHz clock).
3001 * Used for compliant TS muxing.
3002 * - encoding: Set by libavcodec.
3003 * - decoding: unused.
3004 * @deprecated this value is now exported as a part of
3005 * AV_PKT_DATA_CPB_PROPERTIES packet side data
3007 attribute_deprecated
3011 #if FF_API_SIDEDATA_ONLY_PKT
3013 * Encoding only and set by default. Allow encoders to output packets
3014 * that do not contain any encoded data, only side data.
3016 * Some encoders need to output such packets, e.g. to update some stream
3017 * parameters at the end of encoding.
3019 * @deprecated this field disables the default behaviour and
3020 * it is kept only for compatibility.
3022 attribute_deprecated
3023 int side_data_only_packets;
3027 * Audio only. The number of "priming" samples (padding) inserted by the
3028 * encoder at the beginning of the audio. I.e. this number of leading
3029 * decoded samples must be discarded by the caller to get the original audio
3030 * without leading padding.
3032 * - decoding: unused
3033 * - encoding: Set by libavcodec. The timestamps on the output packets are
3034 * adjusted by the encoder so that they always refer to the
3035 * first sample of the data actually contained in the packet,
3036 * including any added padding. E.g. if the timebase is
3037 * 1/samplerate and the timestamp of the first input sample is
3038 * 0, the timestamp of the first output packet will be
3041 int initial_padding;
3044 * - decoding: For codecs that store a framerate value in the compressed
3045 * bitstream, the decoder may export it here. { 0, 1} when
3047 * - encoding: unused
3049 AVRational framerate;
3052 * Nominal unaccelerated pixel format, see AV_PIX_FMT_xxx.
3053 * - encoding: unused.
3054 * - decoding: Set by libavcodec before calling get_format()
3056 enum AVPixelFormat sw_pix_fmt;
3059 * Additional data associated with the entire coded stream.
3061 * - decoding: unused
3062 * - encoding: may be set by libavcodec after avcodec_open2().
3064 AVPacketSideData *coded_side_data;
3065 int nb_coded_side_data;
3070 * For hardware encoders configured to use a hwaccel pixel format, this
3071 * field should be set by the caller to a reference to the AVHWFramesContext
3072 * describing input frames. AVHWFramesContext.format must be equal to
3073 * AVCodecContext.pix_fmt.
3075 * This field should be set before avcodec_open2() is called and is
3076 * afterwards owned and managed by libavcodec.
3078 AVBufferRef *hw_frames_ctx;
3084 typedef struct AVProfile {
3086 const char *name; ///< short name for the profile
3089 typedef struct AVCodecDefault AVCodecDefault;
3096 typedef struct AVCodec {
3098 * Name of the codec implementation.
3099 * The name is globally unique among encoders and among decoders (but an
3100 * encoder and a decoder can share the same name).
3101 * This is the primary way to find a codec from the user perspective.
3105 * Descriptive name for the codec, meant to be more human readable than name.
3106 * You should use the NULL_IF_CONFIG_SMALL() macro to define it.
3108 const char *long_name;
3109 enum AVMediaType type;
3112 * Codec capabilities.
3113 * see AV_CODEC_CAP_*
3116 const AVRational *supported_framerates; ///< array of supported framerates, or NULL if any, array is terminated by {0,0}
3117 const enum AVPixelFormat *pix_fmts; ///< array of supported pixel formats, or NULL if unknown, array is terminated by -1
3118 const int *supported_samplerates; ///< array of supported audio samplerates, or NULL if unknown, array is terminated by 0
3119 const enum AVSampleFormat *sample_fmts; ///< array of supported sample formats, or NULL if unknown, array is terminated by -1
3120 const uint64_t *channel_layouts; ///< array of support channel layouts, or NULL if unknown. array is terminated by 0
3122 attribute_deprecated uint8_t max_lowres; ///< maximum value for lowres supported by the decoder
3124 const AVClass *priv_class; ///< AVClass for the private context
3125 const AVProfile *profiles; ///< array of recognized profiles, or NULL if unknown, array is terminated by {FF_PROFILE_UNKNOWN}
3127 /*****************************************************************
3128 * No fields below this line are part of the public API. They
3129 * may not be used outside of libavcodec and can be changed and
3131 * New public fields should be added right above.
3132 *****************************************************************
3135 struct AVCodec *next;
3137 * @name Frame-level threading support functions
3141 * If defined, called on thread contexts when they are created.
3142 * If the codec allocates writable tables in init(), re-allocate them here.
3143 * priv_data will be set to a copy of the original.
3145 int (*init_thread_copy)(AVCodecContext *);
3147 * Copy necessary context variables from a previous thread context to the current one.
3148 * If not defined, the next thread will start automatically; otherwise, the codec
3149 * must call ff_thread_finish_setup().
3151 * dst and src will (rarely) point to the same context, in which case memcpy should be skipped.
3153 int (*update_thread_context)(AVCodecContext *dst, const AVCodecContext *src);
3157 * Private codec-specific defaults.
3159 const AVCodecDefault *defaults;
3162 * Initialize codec static data, called from avcodec_register().
3164 void (*init_static_data)(struct AVCodec *codec);
3166 int (*init)(AVCodecContext *);
3167 int (*encode_sub)(AVCodecContext *, uint8_t *buf, int buf_size,
3168 const struct AVSubtitle *sub);
3170 * Encode data to an AVPacket.
3172 * @param avctx codec context
3173 * @param avpkt output AVPacket (may contain a user-provided buffer)
3174 * @param[in] frame AVFrame containing the raw data to be encoded
3175 * @param[out] got_packet_ptr encoder sets to 0 or 1 to indicate that a
3176 * non-empty packet was returned in avpkt.
3177 * @return 0 on success, negative error code on failure
3179 int (*encode2)(AVCodecContext *avctx, AVPacket *avpkt, const AVFrame *frame,
3180 int *got_packet_ptr);
3181 int (*decode)(AVCodecContext *, void *outdata, int *outdata_size, AVPacket *avpkt);
3182 int (*close)(AVCodecContext *);
3184 * Decode/encode API with decoupled packet/frame dataflow. The API is the
3185 * same as the avcodec_ prefixed APIs (avcodec_send_frame() etc.), except
3187 * - never called if the codec is closed or the wrong type,
3188 * - AVPacket parameter change side data is applied right before calling
3189 * AVCodec->send_packet,
3190 * - if AV_CODEC_CAP_DELAY is not set, drain packets or frames are never sent,
3191 * - only one drain packet is ever passed down (until the next flush()),
3192 * - a drain AVPacket is always NULL (no need to check for avpkt->size).
3194 int (*send_frame)(AVCodecContext *avctx, const AVFrame *frame);
3195 int (*send_packet)(AVCodecContext *avctx, const AVPacket *avpkt);
3196 int (*receive_frame)(AVCodecContext *avctx, AVFrame *frame);
3197 int (*receive_packet)(AVCodecContext *avctx, AVPacket *avpkt);
3200 * Will be called when seeking
3202 void (*flush)(AVCodecContext *);
3204 * Internal codec capabilities.
3205 * See FF_CODEC_CAP_* in internal.h
3211 * @defgroup lavc_hwaccel AVHWAccel
3214 typedef struct AVHWAccel {
3216 * Name of the hardware accelerated codec.
3217 * The name is globally unique among encoders and among decoders (but an
3218 * encoder and a decoder can share the same name).
3223 * Type of codec implemented by the hardware accelerator.
3225 * See AVMEDIA_TYPE_xxx
3227 enum AVMediaType type;
3230 * Codec implemented by the hardware accelerator.
3232 * See AV_CODEC_ID_xxx
3237 * Supported pixel format.
3239 * Only hardware accelerated formats are supported here.
3241 enum AVPixelFormat pix_fmt;
3244 * Hardware accelerated codec capabilities.
3245 * see FF_HWACCEL_CODEC_CAP_*
3249 /*****************************************************************
3250 * No fields below this line are part of the public API. They
3251 * may not be used outside of libavcodec and can be changed and
3253 * New public fields should be added right above.
3254 *****************************************************************
3256 struct AVHWAccel *next;
3259 * Allocate a custom buffer
3261 int (*alloc_frame)(AVCodecContext *avctx, AVFrame *frame);
3264 * Called at the beginning of each frame or field picture.
3266 * Meaningful frame information (codec specific) is guaranteed to
3267 * be parsed at this point. This function is mandatory.
3269 * Note that buf can be NULL along with buf_size set to 0.
3270 * Otherwise, this means the whole frame is available at this point.
3272 * @param avctx the codec context
3273 * @param buf the frame data buffer base
3274 * @param buf_size the size of the frame in bytes
3275 * @return zero if successful, a negative value otherwise
3277 int (*start_frame)(AVCodecContext *avctx, const uint8_t *buf, uint32_t buf_size);
3280 * Callback for each slice.
3282 * Meaningful slice information (codec specific) is guaranteed to
3283 * be parsed at this point. This function is mandatory.
3285 * @param avctx the codec context
3286 * @param buf the slice data buffer base
3287 * @param buf_size the size of the slice in bytes
3288 * @return zero if successful, a negative value otherwise
3290 int (*decode_slice)(AVCodecContext *avctx, const uint8_t *buf, uint32_t buf_size);
3293 * Called at the end of each frame or field picture.
3295 * The whole picture is parsed at this point and can now be sent
3296 * to the hardware accelerator. This function is mandatory.
3298 * @param avctx the codec context
3299 * @return zero if successful, a negative value otherwise
3301 int (*end_frame)(AVCodecContext *avctx);
3304 * Size of per-frame hardware accelerator private data.
3306 * Private data is allocated with av_mallocz() before
3307 * AVCodecContext.get_buffer() and deallocated after
3308 * AVCodecContext.release_buffer().
3310 int frame_priv_data_size;
3313 * Initialize the hwaccel private data.
3315 * This will be called from ff_get_format(), after hwaccel and
3316 * hwaccel_context are set and the hwaccel private data in AVCodecInternal
3319 int (*init)(AVCodecContext *avctx);
3322 * Uninitialize the hwaccel private data.
3324 * This will be called from get_format() or avcodec_close(), after hwaccel
3325 * and hwaccel_context are already uninitialized.
3327 int (*uninit)(AVCodecContext *avctx);
3330 * Size of the private data to allocate in
3331 * AVCodecInternal.hwaccel_priv_data.
3337 * Hardware acceleration should be used for decoding even if the codec level
3338 * used is unknown or higher than the maximum supported level reported by the
3341 #define AV_HWACCEL_FLAG_IGNORE_LEVEL (1 << 0)
3344 * Hardware acceleration can output YUV pixel formats with a different chroma
3345 * sampling than 4:2:0 and/or other than 8 bits per component.
3347 #define AV_HWACCEL_FLAG_ALLOW_HIGH_DEPTH (1 << 1)
3353 #if FF_API_AVPICTURE
3355 * @defgroup lavc_picture AVPicture
3357 * Functions for working with AVPicture
3362 * four components are given, that's all.
3363 * the last component is alpha
3364 * @deprecated Use the imgutils functions
3366 typedef struct AVPicture {
3367 attribute_deprecated
3368 uint8_t *data[AV_NUM_DATA_POINTERS];
3369 attribute_deprecated
3370 int linesize[AV_NUM_DATA_POINTERS]; ///< number of bytes per line
3378 #define AVPALETTE_SIZE 1024
3379 #define AVPALETTE_COUNT 256
3381 enum AVSubtitleType {
3384 SUBTITLE_BITMAP, ///< A bitmap, pict will be set
3387 * Plain text, the text field must be set by the decoder and is
3388 * authoritative. ass and pict fields may contain approximations.
3393 * Formatted text, the ass field must be set by the decoder and is
3394 * authoritative. pict and text fields may contain approximations.
3399 #define AV_SUBTITLE_FLAG_FORCED 0x00000001
3401 typedef struct AVSubtitleRect {
3402 int x; ///< top left corner of pict, undefined when pict is not set
3403 int y; ///< top left corner of pict, undefined when pict is not set
3404 int w; ///< width of pict, undefined when pict is not set
3405 int h; ///< height of pict, undefined when pict is not set
3406 int nb_colors; ///< number of colors in pict, undefined when pict is not set
3408 #if FF_API_AVPICTURE
3410 * @deprecated unused
3412 attribute_deprecated
3416 * data+linesize for the bitmap of this subtitle.
3417 * Can be set for text/ass as well once they are rendered.
3422 enum AVSubtitleType type;
3424 char *text; ///< 0 terminated plain UTF-8 text
3427 * 0 terminated ASS/SSA compatible event line.
3428 * The pressentation of this is unaffected by the other values in this
3435 typedef struct AVSubtitle {
3436 uint16_t format; /* 0 = graphics */
3437 uint32_t start_display_time; /* relative to packet pts, in ms */
3438 uint32_t end_display_time; /* relative to packet pts, in ms */
3440 AVSubtitleRect **rects;
3441 int64_t pts; ///< Same as packet pts, in AV_TIME_BASE
3445 * This struct describes the properties of an encoded stream.
3447 * sizeof(AVCodecParameters) is not a part of the public ABI, this struct must
3448 * be allocated with avcodec_parameters_alloc() and freed with
3449 * avcodec_parameters_free().
3451 typedef struct AVCodecParameters {
3453 * General type of the encoded data.
3455 enum AVMediaType codec_type;
3457 * Specific type of the encoded data (the codec used).
3459 enum AVCodecID codec_id;
3461 * Additional information about the codec (corresponds to the AVI FOURCC).
3466 * Extra binary data needed for initializing the decoder, codec-dependent.
3468 * Must be allocated with av_malloc() and will be freed by
3469 * avcodec_parameters_free(). The allocated size of extradata must be at
3470 * least extradata_size + AV_INPUT_BUFFER_PADDING_SIZE, with the padding
3475 * Size of the extradata content in bytes.
3480 * - video: the pixel format, the value corresponds to enum AVPixelFormat.
3481 * - audio: the sample format, the value corresponds to enum AVSampleFormat.
3486 * The average bitrate of the encoded data (in bits per second).
3490 int bits_per_coded_sample;
3493 * Codec-specific bitstream restrictions that the stream conforms to.
3499 * Video only. The dimensions of the video frame in pixels.
3505 * Video only. The aspect ratio (width / height) which a single pixel
3506 * should have when displayed.
3508 * When the aspect ratio is unknown / undefined, the numerator should be
3509 * set to 0 (the denominator may have any value).
3511 AVRational sample_aspect_ratio;
3514 * Video only. The order of the fields in interlaced video.
3516 enum AVFieldOrder field_order;
3519 * Video only. Additional colorspace characteristics.
3521 enum AVColorRange color_range;
3522 enum AVColorPrimaries color_primaries;
3523 enum AVColorTransferCharacteristic color_trc;
3524 enum AVColorSpace color_space;
3525 enum AVChromaLocation chroma_location;
3528 * Audio only. The channel layout bitmask. May be 0 if the channel layout is
3529 * unknown or unspecified, otherwise the number of bits set must be equal to
3530 * the channels field.
3532 uint64_t channel_layout;
3534 * Audio only. The number of audio channels.
3538 * Audio only. The number of audio samples per second.
3542 * Audio only. The number of bytes per coded audio frame, required by some
3545 * Corresponds to nBlockAlign in WAVEFORMATEX.
3550 * Audio only. The amount of padding (in samples) inserted by the encoder at
3551 * the beginning of the audio. I.e. this number of leading decoded samples
3552 * must be discarded by the caller to get the original audio without leading
3555 int initial_padding;
3557 * Audio only. The amount of padding (in samples) appended by the encoder to
3558 * the end of the audio. I.e. this number of decoded samples must be
3559 * discarded by the caller from the end of the stream to get the original
3560 * audio without any trailing padding.
3562 int trailing_padding;
3563 } AVCodecParameters;
3566 * If c is NULL, returns the first registered codec,
3567 * if c is non-NULL, returns the next registered codec after c,
3568 * or NULL if c is the last one.
3570 AVCodec *av_codec_next(const AVCodec *c);
3573 * Return the LIBAVCODEC_VERSION_INT constant.
3575 unsigned avcodec_version(void);
3578 * Return the libavcodec build-time configuration.
3580 const char *avcodec_configuration(void);
3583 * Return the libavcodec license.
3585 const char *avcodec_license(void);
3588 * Register the codec codec and initialize libavcodec.
3590 * @warning either this function or avcodec_register_all() must be called
3591 * before any other libavcodec functions.
3593 * @see avcodec_register_all()
3595 void avcodec_register(AVCodec *codec);
3598 * Register all the codecs, parsers and bitstream filters which were enabled at
3599 * configuration time. If you do not call this function you can select exactly
3600 * which formats you want to support, by using the individual registration
3603 * @see avcodec_register
3604 * @see av_register_codec_parser
3605 * @see av_register_bitstream_filter
3607 void avcodec_register_all(void);
3610 * Allocate an AVCodecContext and set its fields to default values. The
3611 * resulting struct should be freed with avcodec_free_context().
3613 * @param codec if non-NULL, allocate private data and initialize defaults
3614 * for the given codec. It is illegal to then call avcodec_open2()
3615 * with a different codec.
3616 * If NULL, then the codec-specific defaults won't be initialized,
3617 * which may result in suboptimal default settings (this is
3618 * important mainly for encoders, e.g. libx264).
3620 * @return An AVCodecContext filled with default values or NULL on failure.
3621 * @see avcodec_get_context_defaults
3623 AVCodecContext *avcodec_alloc_context3(const AVCodec *codec);
3626 * Free the codec context and everything associated with it and write NULL to
3627 * the provided pointer.
3629 void avcodec_free_context(AVCodecContext **avctx);
3632 * Set the fields of the given AVCodecContext to default values corresponding
3633 * to the given codec (defaults may be codec-dependent).
3635 * Do not call this function if a non-NULL codec has been passed
3636 * to avcodec_alloc_context3() that allocated this AVCodecContext.
3637 * If codec is non-NULL, it is illegal to call avcodec_open2() with a
3638 * different codec on this AVCodecContext.
3640 int avcodec_get_context_defaults3(AVCodecContext *s, const AVCodec *codec);
3643 * Get the AVClass for AVCodecContext. It can be used in combination with
3644 * AV_OPT_SEARCH_FAKE_OBJ for examining options.
3646 * @see av_opt_find().
3648 const AVClass *avcodec_get_class(void);
3651 * Copy the settings of the source AVCodecContext into the destination
3652 * AVCodecContext. The resulting destination codec context will be
3653 * unopened, i.e. you are required to call avcodec_open2() before you
3654 * can use this AVCodecContext to decode/encode video/audio data.
3656 * @param dest target codec context, should be initialized with
3657 * avcodec_alloc_context3(), but otherwise uninitialized
3658 * @param src source codec context
3659 * @return AVERROR() on error (e.g. memory allocation error), 0 on success
3661 int avcodec_copy_context(AVCodecContext *dest, const AVCodecContext *src);
3664 * Allocate a new AVCodecParameters and set its fields to default values
3665 * (unknown/invalid/0). The returned struct must be freed with
3666 * avcodec_parameters_free().
3668 AVCodecParameters *avcodec_parameters_alloc(void);
3671 * Free an AVCodecParameters instance and everything associated with it and
3672 * write NULL to the supplied pointer.
3674 void avcodec_parameters_free(AVCodecParameters **par);
3677 * Copy the contents of src to dst. Any allocated fields in dst are freed and
3678 * replaced with newly allocated duplicates of the corresponding fields in src.
3680 * @return >= 0 on success, a negative AVERROR code on failure.
3682 int avcodec_parameters_copy(AVCodecParameters *dst, const AVCodecParameters *src);
3685 * Fill the parameters struct based on the values from the supplied codec
3686 * context. Any allocated fields in par are freed and replaced with duplicates
3687 * of the corresponding fields in codec.
3689 * @return >= 0 on success, a negative AVERROR code on failure
3691 int avcodec_parameters_from_context(AVCodecParameters *par,
3692 const AVCodecContext *codec);
3695 * Fill the codec context based on the values from the supplied codec
3696 * parameters. Any allocated fields in codec that have a corresponding field in
3697 * par are freed and replaced with duplicates of the corresponding field in par.
3698 * Fields in codec that do not have a counterpart in par are not touched.
3700 * @return >= 0 on success, a negative AVERROR code on failure.
3702 int avcodec_parameters_to_context(AVCodecContext *codec,
3703 const AVCodecParameters *par);
3706 * Initialize the AVCodecContext to use the given AVCodec. Prior to using this
3707 * function the context has to be allocated with avcodec_alloc_context3().
3709 * The functions avcodec_find_decoder_by_name(), avcodec_find_encoder_by_name(),
3710 * avcodec_find_decoder() and avcodec_find_encoder() provide an easy way for
3711 * retrieving a codec.
3713 * @warning This function is not thread safe!
3715 * @note Always call this function before using decoding routines (such as
3716 * @ref avcodec_receive_frame()).
3719 * avcodec_register_all();
3720 * av_dict_set(&opts, "b", "2.5M", 0);
3721 * codec = avcodec_find_decoder(AV_CODEC_ID_H264);
3725 * context = avcodec_alloc_context3(codec);
3727 * if (avcodec_open2(context, codec, opts) < 0)
3731 * @param avctx The context to initialize.
3732 * @param codec The codec to open this context for. If a non-NULL codec has been
3733 * previously passed to avcodec_alloc_context3() or
3734 * avcodec_get_context_defaults3() for this context, then this
3735 * parameter MUST be either NULL or equal to the previously passed
3737 * @param options A dictionary filled with AVCodecContext and codec-private options.
3738 * On return this object will be filled with options that were not found.
3740 * @return zero on success, a negative value on error
3741 * @see avcodec_alloc_context3(), avcodec_find_decoder(), avcodec_find_encoder(),
3742 * av_dict_set(), av_opt_find().
3744 int avcodec_open2(AVCodecContext *avctx, const AVCodec *codec, AVDictionary **options);
3747 * Close a given AVCodecContext and free all the data associated with it
3748 * (but not the AVCodecContext itself).
3750 * Calling this function on an AVCodecContext that hasn't been opened will free
3751 * the codec-specific data allocated in avcodec_alloc_context3() /
3752 * avcodec_get_context_defaults3() with a non-NULL codec. Subsequent calls will
3755 int avcodec_close(AVCodecContext *avctx);
3758 * Free all allocated data in the given subtitle struct.
3760 * @param sub AVSubtitle to free.
3762 void avsubtitle_free(AVSubtitle *sub);
3769 * @addtogroup lavc_packet
3774 * Allocate an AVPacket and set its fields to default values. The resulting
3775 * struct must be freed using av_packet_free().
3777 * @return An AVPacket filled with default values or NULL on failure.
3779 * @note this only allocates the AVPacket itself, not the data buffers. Those
3780 * must be allocated through other means such as av_new_packet.
3782 * @see av_new_packet
3784 AVPacket *av_packet_alloc(void);
3787 * Create a new packet that references the same data as src.
3789 * This is a shortcut for av_packet_alloc()+av_packet_ref().
3791 * @return newly created AVPacket on success, NULL on error.
3793 * @see av_packet_alloc
3794 * @see av_packet_ref
3796 AVPacket *av_packet_clone(AVPacket *src);
3799 * Free the packet, if the packet is reference counted, it will be
3800 * unreferenced first.
3802 * @param packet packet to be freed. The pointer will be set to NULL.
3803 * @note passing NULL is a no-op.
3805 void av_packet_free(AVPacket **pkt);
3808 * Initialize optional fields of a packet with default values.
3810 * Note, this does not touch the data and size members, which have to be
3811 * initialized separately.
3815 void av_init_packet(AVPacket *pkt);
3818 * Allocate the payload of a packet and initialize its fields with
3822 * @param size wanted payload size
3823 * @return 0 if OK, AVERROR_xxx otherwise
3825 int av_new_packet(AVPacket *pkt, int size);
3828 * Reduce packet size, correctly zeroing padding
3831 * @param size new size
3833 void av_shrink_packet(AVPacket *pkt, int size);
3836 * Increase packet size, correctly zeroing padding
3839 * @param grow_by number of bytes by which to increase the size of the packet
3841 int av_grow_packet(AVPacket *pkt, int grow_by);
3844 * Initialize a reference-counted packet from av_malloc()ed data.
3846 * @param pkt packet to be initialized. This function will set the data, size,
3847 * buf and destruct fields, all others are left untouched.
3848 * @param data Data allocated by av_malloc() to be used as packet data. If this
3849 * function returns successfully, the data is owned by the underlying AVBuffer.
3850 * The caller may not access the data through other means.
3851 * @param size size of data in bytes, without the padding. I.e. the full buffer
3852 * size is assumed to be size + AV_INPUT_BUFFER_PADDING_SIZE.
3854 * @return 0 on success, a negative AVERROR on error
3856 int av_packet_from_data(AVPacket *pkt, uint8_t *data, int size);
3858 #if FF_API_AVPACKET_OLD_API
3860 * @warning This is a hack - the packet memory allocation stuff is broken. The
3861 * packet is allocated if it was not really allocated.
3863 * @deprecated Use av_packet_ref
3865 attribute_deprecated
3866 int av_dup_packet(AVPacket *pkt);
3870 * @deprecated Use av_packet_unref
3872 * @param pkt packet to free
3874 attribute_deprecated
3875 void av_free_packet(AVPacket *pkt);
3878 * Allocate new information of a packet.
3881 * @param type side information type
3882 * @param size side information size
3883 * @return pointer to fresh allocated data or NULL otherwise
3885 uint8_t* av_packet_new_side_data(AVPacket *pkt, enum AVPacketSideDataType type,
3889 * Wrap an existing array as a packet side data.
3892 * @param type side information type
3893 * @param data the side data array. It must be allocated with the av_malloc()
3894 * family of functions. The ownership of the data is transferred to
3896 * @param size side information size
3897 * @return a non-negative number on success, a negative AVERROR code on
3898 * failure. On failure, the packet is unchanged and the data remains
3899 * owned by the caller.
3901 int av_packet_add_side_data(AVPacket *pkt, enum AVPacketSideDataType type,
3902 uint8_t *data, size_t size);
3905 * Shrink the already allocated side data buffer
3908 * @param type side information type
3909 * @param size new side information size
3910 * @return 0 on success, < 0 on failure
3912 int av_packet_shrink_side_data(AVPacket *pkt, enum AVPacketSideDataType type,
3916 * Get side information from packet.
3919 * @param type desired side information type
3920 * @param size pointer for side information size to store (optional)
3921 * @return pointer to data if present or NULL otherwise
3923 uint8_t* av_packet_get_side_data(AVPacket *pkt, enum AVPacketSideDataType type,
3927 * Convenience function to free all the side data stored.
3928 * All the other fields stay untouched.
3932 void av_packet_free_side_data(AVPacket *pkt);
3935 * Setup a new reference to the data described by a given packet
3937 * If src is reference-counted, setup dst as a new reference to the
3938 * buffer in src. Otherwise allocate a new buffer in dst and copy the
3939 * data from src into it.
3941 * All the other fields are copied from src.
3943 * @see av_packet_unref
3945 * @param dst Destination packet
3946 * @param src Source packet
3948 * @return 0 on success, a negative AVERROR on error.
3950 int av_packet_ref(AVPacket *dst, AVPacket *src);
3955 * Unreference the buffer referenced by the packet and reset the
3956 * remaining packet fields to their default values.
3958 * @param pkt The packet to be unreferenced.
3960 void av_packet_unref(AVPacket *pkt);
3963 * Move every field in src to dst and reset src.
3965 * @see av_packet_unref
3967 * @param src Source packet, will be reset
3968 * @param dst Destination packet
3970 void av_packet_move_ref(AVPacket *dst, AVPacket *src);
3973 * Copy only "properties" fields from src to dst.
3975 * Properties for the purpose of this function are all the fields
3976 * beside those related to the packet data (buf, data, size)
3978 * @param dst Destination packet
3979 * @param src Source packet
3981 * @return 0 on success AVERROR on failure.
3983 int av_packet_copy_props(AVPacket *dst, const AVPacket *src);
3986 * Convert valid timing fields (timestamps / durations) in a packet from one
3987 * timebase to another. Timestamps with unknown values (AV_NOPTS_VALUE) will be
3990 * @param pkt packet on which the conversion will be performed
3991 * @param tb_src source timebase, in which the timing fields in pkt are
3993 * @param tb_dst destination timebase, to which the timing fields will be
3996 void av_packet_rescale_ts(AVPacket *pkt, AVRational tb_src, AVRational tb_dst);
4003 * @addtogroup lavc_decoding
4008 * Find a registered decoder with a matching codec ID.
4010 * @param id AVCodecID of the requested decoder
4011 * @return A decoder if one was found, NULL otherwise.
4013 AVCodec *avcodec_find_decoder(enum AVCodecID id);
4016 * Find a registered decoder with the specified name.
4018 * @param name name of the requested decoder
4019 * @return A decoder if one was found, NULL otherwise.
4021 AVCodec *avcodec_find_decoder_by_name(const char *name);
4024 * The default callback for AVCodecContext.get_buffer2(). It is made public so
4025 * it can be called by custom get_buffer2() implementations for decoders without
4026 * AV_CODEC_CAP_DR1 set.
4028 int avcodec_default_get_buffer2(AVCodecContext *s, AVFrame *frame, int flags);
4032 * Return the amount of padding in pixels which the get_buffer callback must
4033 * provide around the edge of the image for codecs which do not have the
4034 * CODEC_FLAG_EMU_EDGE flag.
4036 * @return Required padding in pixels.
4038 * @deprecated CODEC_FLAG_EMU_EDGE is deprecated, so this function is no longer
4041 attribute_deprecated
4042 unsigned avcodec_get_edge_width(void);
4046 * Modify width and height values so that they will result in a memory
4047 * buffer that is acceptable for the codec if you do not use any horizontal
4050 * May only be used if a codec with AV_CODEC_CAP_DR1 has been opened.
4052 void avcodec_align_dimensions(AVCodecContext *s, int *width, int *height);
4055 * Modify width and height values so that they will result in a memory
4056 * buffer that is acceptable for the codec if you also ensure that all
4057 * line sizes are a multiple of the respective linesize_align[i].
4059 * May only be used if a codec with AV_CODEC_CAP_DR1 has been opened.
4061 void avcodec_align_dimensions2(AVCodecContext *s, int *width, int *height,
4062 int linesize_align[AV_NUM_DATA_POINTERS]);
4065 * Decode the audio frame of size avpkt->size from avpkt->data into frame.
4067 * Some decoders may support multiple frames in a single AVPacket. Such
4068 * decoders would then just decode the first frame and the return value would be
4069 * less than the packet size. In this case, avcodec_decode_audio4 has to be
4070 * called again with an AVPacket containing the remaining data in order to
4071 * decode the second frame, etc... Even if no frames are returned, the packet
4072 * needs to be fed to the decoder with remaining data until it is completely
4073 * consumed or an error occurs.
4075 * Some decoders (those marked with AV_CODEC_CAP_DELAY) have a delay between input
4076 * and output. This means that for some packets they will not immediately
4077 * produce decoded output and need to be flushed at the end of decoding to get
4078 * all the decoded data. Flushing is done by calling this function with packets
4079 * with avpkt->data set to NULL and avpkt->size set to 0 until it stops
4080 * returning samples. It is safe to flush even those decoders that are not
4081 * marked with AV_CODEC_CAP_DELAY, then no samples will be returned.
4083 * @warning The input buffer, avpkt->data must be AV_INPUT_BUFFER_PADDING_SIZE
4084 * larger than the actual read bytes because some optimized bitstream
4085 * readers read 32 or 64 bits at once and could read over the end.
4087 * @note The AVCodecContext MUST have been opened with @ref avcodec_open2()
4088 * before packets may be fed to the decoder.
4090 * @param avctx the codec context
4091 * @param[out] frame The AVFrame in which to store decoded audio samples.
4092 * The decoder will allocate a buffer for the decoded frame by
4093 * calling the AVCodecContext.get_buffer2() callback.
4094 * When AVCodecContext.refcounted_frames is set to 1, the frame is
4095 * reference counted and the returned reference belongs to the
4096 * caller. The caller must release the frame using av_frame_unref()
4097 * when the frame is no longer needed. The caller may safely write
4098 * to the frame if av_frame_is_writable() returns 1.
4099 * When AVCodecContext.refcounted_frames is set to 0, the returned
4100 * reference belongs to the decoder and is valid only until the
4101 * next call to this function or until closing or flushing the
4102 * decoder. The caller may not write to it.
4103 * @param[out] got_frame_ptr Zero if no frame could be decoded, otherwise it is
4104 * non-zero. Note that this field being set to zero
4105 * does not mean that an error has occurred. For
4106 * decoders with AV_CODEC_CAP_DELAY set, no given decode
4107 * call is guaranteed to produce a frame.
4108 * @param[in] avpkt The input AVPacket containing the input buffer.
4109 * At least avpkt->data and avpkt->size should be set. Some
4110 * decoders might also require additional fields to be set.
4111 * @return A negative error code is returned if an error occurred during
4112 * decoding, otherwise the number of bytes consumed from the input
4113 * AVPacket is returned.
4115 * @deprecated Use avcodec_send_packet() and avcodec_receive_frame().
4117 attribute_deprecated
4118 int avcodec_decode_audio4(AVCodecContext *avctx, AVFrame *frame,
4119 int *got_frame_ptr, AVPacket *avpkt);
4122 * Decode the video frame of size avpkt->size from avpkt->data into picture.
4123 * Some decoders may support multiple frames in a single AVPacket, such
4124 * decoders would then just decode the first frame.
4126 * @warning The input buffer must be AV_INPUT_BUFFER_PADDING_SIZE larger than
4127 * the actual read bytes because some optimized bitstream readers read 32 or 64
4128 * bits at once and could read over the end.
4130 * @warning The end of the input buffer buf should be set to 0 to ensure that
4131 * no overreading happens for damaged MPEG streams.
4133 * @note Codecs which have the AV_CODEC_CAP_DELAY capability set have a delay
4134 * between input and output, these need to be fed with avpkt->data=NULL,
4135 * avpkt->size=0 at the end to return the remaining frames.
4137 * @note The AVCodecContext MUST have been opened with @ref avcodec_open2()
4138 * before packets may be fed to the decoder.
4140 * @param avctx the codec context
4141 * @param[out] picture The AVFrame in which the decoded video frame will be stored.
4142 * Use av_frame_alloc() to get an AVFrame. The codec will
4143 * allocate memory for the actual bitmap by calling the
4144 * AVCodecContext.get_buffer2() callback.
4145 * When AVCodecContext.refcounted_frames is set to 1, the frame is
4146 * reference counted and the returned reference belongs to the
4147 * caller. The caller must release the frame using av_frame_unref()
4148 * when the frame is no longer needed. The caller may safely write
4149 * to the frame if av_frame_is_writable() returns 1.
4150 * When AVCodecContext.refcounted_frames is set to 0, the returned
4151 * reference belongs to the decoder and is valid only until the
4152 * next call to this function or until closing or flushing the
4153 * decoder. The caller may not write to it.
4155 * @param[in] avpkt The input AVpacket containing the input buffer.
4156 * You can create such packet with av_init_packet() and by then setting
4157 * data and size, some decoders might in addition need other fields like
4158 * flags&AV_PKT_FLAG_KEY. All decoders are designed to use the least
4160 * @param[in,out] got_picture_ptr Zero if no frame could be decompressed, otherwise, it is nonzero.
4161 * @return On error a negative value is returned, otherwise the number of bytes
4162 * used or zero if no frame could be decompressed.
4164 * @deprecated Use avcodec_send_packet() and avcodec_receive_frame().
4166 attribute_deprecated
4167 int avcodec_decode_video2(AVCodecContext *avctx, AVFrame *picture,
4168 int *got_picture_ptr,
4172 * Decode a subtitle message.
4173 * Return a negative value on error, otherwise return the number of bytes used.
4174 * If no subtitle could be decompressed, got_sub_ptr is zero.
4175 * Otherwise, the subtitle is stored in *sub.
4176 * Note that AV_CODEC_CAP_DR1 is not available for subtitle codecs. This is for
4177 * simplicity, because the performance difference is expect to be negligible
4178 * and reusing a get_buffer written for video codecs would probably perform badly
4179 * due to a potentially very different allocation pattern.
4181 * @note The AVCodecContext MUST have been opened with @ref avcodec_open2()
4182 * before packets may be fed to the decoder.
4184 * @param avctx the codec context
4185 * @param[out] sub The AVSubtitle in which the decoded subtitle will be stored, must be
4186 freed with avsubtitle_free if *got_sub_ptr is set.
4187 * @param[in,out] got_sub_ptr Zero if no subtitle could be decompressed, otherwise, it is nonzero.
4188 * @param[in] avpkt The input AVPacket containing the input buffer.
4190 int avcodec_decode_subtitle2(AVCodecContext *avctx, AVSubtitle *sub,
4195 * Supply raw packet data as input to a decoder.
4197 * Internally, this call will copy relevant AVCodecContext fields, which can
4198 * influence decoding per-packet, and apply them when the packet is actually
4199 * decoded. (For example AVCodecContext.skip_frame, which might direct the
4200 * decoder to drop the frame contained by the packet sent with this function.)
4202 * @warning The input buffer, avpkt->data must be AV_INPUT_BUFFER_PADDING_SIZE
4203 * larger than the actual read bytes because some optimized bitstream
4204 * readers read 32 or 64 bits at once and could read over the end.
4206 * @warning Do not mix this API with the legacy API (like avcodec_decode_video2())
4207 * on the same AVCodecContext. It will return unexpected results now
4208 * or in future libavcodec versions.
4210 * @note The AVCodecContext MUST have been opened with @ref avcodec_open2()
4211 * before packets may be fed to the decoder.
4213 * @param avctx codec context
4214 * @param[in] avpkt The input AVPacket. Usually, this will be a single video
4215 * frame, or several complete audio frames.
4216 * Ownership of the packet remains with the caller, and the
4217 * decoder will not write to the packet. The decoder may create
4218 * a reference to the packet data (or copy it if the packet is
4219 * not reference-counted).
4220 * Unlike with older APIs, the packet is always fully consumed,
4221 * and if it contains multiple frames (e.g. some audio codecs),
4222 * will require you to call avcodec_receive_frame() multiple
4223 * times afterwards before you can send a new packet.
4224 * It can be NULL (or an AVPacket with data set to NULL and
4225 * size set to 0); in this case, it is considered a flush
4226 * packet, which signals the end of the stream. Sending the
4227 * first flush packet will return success. Subsequent ones are
4228 * unnecessary and will return AVERROR_EOF. If the decoder
4229 * still has frames buffered, it will return them after sending
4232 * @return 0 on success, otherwise negative error code:
4233 * AVERROR(EAGAIN): input is not accepted right now - the packet must be
4234 * resent after trying to read output
4235 * AVERROR_EOF: the decoder has been flushed, and no new packets can
4236 * be sent to it (also returned if more than 1 flush
4238 * AVERROR(EINVAL): codec not opened, it is an encoder, or requires flush
4239 * AVERROR(ENOMEM): failed to add packet to internal queue, or similar
4240 * other errors: legitimate decoding errors
4242 int avcodec_send_packet(AVCodecContext *avctx, const AVPacket *avpkt);
4245 * Return decoded output data from a decoder.
4247 * @param avctx codec context
4248 * @param frame This will be set to a reference-counted video or audio
4249 * frame (depending on the decoder type) allocated by the
4250 * decoder. Note that the function will always call
4251 * av_frame_unref(frame) before doing anything else.
4254 * 0: success, a frame was returned
4255 * AVERROR(EAGAIN): output is not available right now - user must try
4257 * AVERROR_EOF: the decoder has been fully flushed, and there will be
4258 * no more output frames
4259 * AVERROR(EINVAL): codec not opened, or it is an encoder
4260 * other negative values: legitimate decoding errors
4262 int avcodec_receive_frame(AVCodecContext *avctx, AVFrame *frame);
4265 * Supply a raw video or audio frame to the encoder. Use avcodec_receive_packet()
4266 * to retrieve buffered output packets.
4268 * @param avctx codec context
4269 * @param[in] frame AVFrame containing the raw audio or video frame to be encoded.
4270 * Ownership of the frame remains with the caller, and the
4271 * encoder will not write to the frame. The encoder may create
4272 * a reference to the frame data (or copy it if the frame is
4273 * not reference-counted).
4274 * It can be NULL, in which case it is considered a flush
4275 * packet. This signals the end of the stream. If the encoder
4276 * still has packets buffered, it will return them after this
4277 * call. Once flushing mode has been entered, additional flush
4278 * packets are ignored, and sending frames will return
4282 * If AV_CODEC_CAP_VARIABLE_FRAME_SIZE is set, then each frame
4283 * can have any number of samples.
4284 * If it is not set, frame->nb_samples must be equal to
4285 * avctx->frame_size for all frames except the last.
4286 * The final frame may be smaller than avctx->frame_size.
4287 * @return 0 on success, otherwise negative error code:
4288 * AVERROR(EAGAIN): input is not accepted right now - the frame must be
4289 * resent after trying to read output packets
4290 * AVERROR_EOF: the encoder has been flushed, and no new frames can
4292 * AVERROR(EINVAL): codec not opened, refcounted_frames not set, it is a
4293 * decoder, or requires flush
4294 * AVERROR(ENOMEM): failed to add packet to internal queue, or similar
4295 * other errors: legitimate decoding errors
4297 int avcodec_send_frame(AVCodecContext *avctx, const AVFrame *frame);
4300 * Read encoded data from the encoder.
4302 * @param avctx codec context
4303 * @param avpkt This will be set to a reference-counted packet allocated by the
4304 * encoder. Note that the function will always call
4305 * av_frame_unref(frame) before doing anything else.
4306 * @return 0 on success, otherwise negative error code:
4307 * AVERROR(EAGAIN): output is not available right now - user must try
4309 * AVERROR_EOF: the encoder has been fully flushed, and there will be
4310 * no more output packets
4311 * AVERROR(EINVAL): codec not opened, or it is an encoder
4312 * other errors: legitimate decoding errors
4314 int avcodec_receive_packet(AVCodecContext *avctx, AVPacket *avpkt);
4318 * @defgroup lavc_parsing Frame parsing
4322 enum AVPictureStructure {
4323 AV_PICTURE_STRUCTURE_UNKNOWN, //< unknown
4324 AV_PICTURE_STRUCTURE_TOP_FIELD, //< coded as top field
4325 AV_PICTURE_STRUCTURE_BOTTOM_FIELD, //< coded as bottom field
4326 AV_PICTURE_STRUCTURE_FRAME, //< coded as frame
4329 typedef struct AVCodecParserContext {
4331 struct AVCodecParser *parser;
4332 int64_t frame_offset; /* offset of the current frame */
4333 int64_t cur_offset; /* current offset
4334 (incremented by each av_parser_parse()) */
4335 int64_t next_frame_offset; /* offset of the next frame */
4337 int pict_type; /* XXX: Put it back in AVCodecContext. */
4339 * This field is used for proper frame duration computation in lavf.
4340 * It signals, how much longer the frame duration of the current frame
4341 * is compared to normal frame duration.
4343 * frame_duration = (1 + repeat_pict) * time_base
4345 * It is used by codecs like H.264 to display telecined material.
4347 int repeat_pict; /* XXX: Put it back in AVCodecContext. */
4348 int64_t pts; /* pts of the current frame */
4349 int64_t dts; /* dts of the current frame */
4354 int fetch_timestamp;
4356 #define AV_PARSER_PTS_NB 4
4357 int cur_frame_start_index;
4358 int64_t cur_frame_offset[AV_PARSER_PTS_NB];
4359 int64_t cur_frame_pts[AV_PARSER_PTS_NB];
4360 int64_t cur_frame_dts[AV_PARSER_PTS_NB];
4363 #define PARSER_FLAG_COMPLETE_FRAMES 0x0001
4364 #define PARSER_FLAG_ONCE 0x0002
4365 /// Set if the parser has a valid file offset
4366 #define PARSER_FLAG_FETCHED_OFFSET 0x0004
4368 int64_t offset; ///< byte offset from starting packet start
4369 int64_t cur_frame_end[AV_PARSER_PTS_NB];
4372 * Set by parser to 1 for key frames and 0 for non-key frames.
4373 * It is initialized to -1, so if the parser doesn't set this flag,
4374 * old-style fallback using AV_PICTURE_TYPE_I picture type as key frames
4379 #if FF_API_CONVERGENCE_DURATION
4381 * @deprecated unused
4383 attribute_deprecated
4384 int64_t convergence_duration;
4387 // Timestamp generation support:
4389 * Synchronization point for start of timestamp generation.
4391 * Set to >0 for sync point, 0 for no sync point and <0 for undefined
4394 * For example, this corresponds to presence of H.264 buffering period
4400 * Offset of the current timestamp against last timestamp sync point in
4401 * units of AVCodecContext.time_base.
4403 * Set to INT_MIN when dts_sync_point unused. Otherwise, it must
4404 * contain a valid timestamp offset.
4406 * Note that the timestamp of sync point has usually a nonzero
4407 * dts_ref_dts_delta, which refers to the previous sync point. Offset of
4408 * the next frame after timestamp sync point will be usually 1.
4410 * For example, this corresponds to H.264 cpb_removal_delay.
4412 int dts_ref_dts_delta;
4415 * Presentation delay of current frame in units of AVCodecContext.time_base.
4417 * Set to INT_MIN when dts_sync_point unused. Otherwise, it must
4418 * contain valid non-negative timestamp delta (presentation time of a frame
4419 * must not lie in the past).
4421 * This delay represents the difference between decoding and presentation
4422 * time of the frame.
4424 * For example, this corresponds to H.264 dpb_output_delay.
4429 * Position of the packet in file.
4431 * Analogous to cur_frame_pts/dts
4433 int64_t cur_frame_pos[AV_PARSER_PTS_NB];
4436 * Byte position of currently parsed frame in stream.
4441 * Previous frame byte position.
4446 * Duration of the current frame.
4447 * For audio, this is in units of 1 / AVCodecContext.sample_rate.
4448 * For all other types, this is in units of AVCodecContext.time_base.
4452 enum AVFieldOrder field_order;
4455 * Indicate whether a picture is coded as a frame, top field or bottom field.
4457 * For example, H.264 field_pic_flag equal to 0 corresponds to
4458 * AV_PICTURE_STRUCTURE_FRAME. An H.264 picture with field_pic_flag
4459 * equal to 1 and bottom_field_flag equal to 0 corresponds to
4460 * AV_PICTURE_STRUCTURE_TOP_FIELD.
4462 enum AVPictureStructure picture_structure;
4465 * Picture number incremented in presentation or output order.
4466 * This field may be reinitialized at the first picture of a new sequence.
4468 * For example, this corresponds to H.264 PicOrderCnt.
4470 int output_picture_number;
4473 * Dimensions of the decoded video intended for presentation.
4479 * Dimensions of the coded video.
4485 * The format of the coded data, corresponds to enum AVPixelFormat for video
4486 * and for enum AVSampleFormat for audio.
4488 * Note that a decoder can have considerable freedom in how exactly it
4489 * decodes the data, so the format reported here might be different from the
4490 * one returned by a decoder.
4493 } AVCodecParserContext;
4495 typedef struct AVCodecParser {
4496 int codec_ids[5]; /* several codec IDs are permitted */
4498 int (*parser_init)(AVCodecParserContext *s);
4499 /* This callback never returns an error, a negative value means that
4500 * the frame start was in a previous packet. */
4501 int (*parser_parse)(AVCodecParserContext *s,
4502 AVCodecContext *avctx,
4503 const uint8_t **poutbuf, int *poutbuf_size,
4504 const uint8_t *buf, int buf_size);
4505 void (*parser_close)(AVCodecParserContext *s);
4506 int (*split)(AVCodecContext *avctx, const uint8_t *buf, int buf_size);
4507 struct AVCodecParser *next;
4510 AVCodecParser *av_parser_next(const AVCodecParser *c);
4512 void av_register_codec_parser(AVCodecParser *parser);
4513 AVCodecParserContext *av_parser_init(int codec_id);
4518 * @param s parser context.
4519 * @param avctx codec context.
4520 * @param poutbuf set to pointer to parsed buffer or NULL if not yet finished.
4521 * @param poutbuf_size set to size of parsed buffer or zero if not yet finished.
4522 * @param buf input buffer.
4523 * @param buf_size input length, to signal EOF, this should be 0 (so that the last frame can be output).
4524 * @param pts input presentation timestamp.
4525 * @param dts input decoding timestamp.
4526 * @param pos input byte position in stream.
4527 * @return the number of bytes of the input bitstream used.
4532 * len = av_parser_parse2(myparser, AVCodecContext, &data, &size,
4539 * decode_frame(data, size);
4543 int av_parser_parse2(AVCodecParserContext *s,
4544 AVCodecContext *avctx,
4545 uint8_t **poutbuf, int *poutbuf_size,
4546 const uint8_t *buf, int buf_size,
4547 int64_t pts, int64_t dts,
4551 * @return 0 if the output buffer is a subset of the input, 1 if it is allocated and must be freed
4552 * @deprecated use AVBitstreamFilter
4554 int av_parser_change(AVCodecParserContext *s,
4555 AVCodecContext *avctx,
4556 uint8_t **poutbuf, int *poutbuf_size,
4557 const uint8_t *buf, int buf_size, int keyframe);
4558 void av_parser_close(AVCodecParserContext *s);
4566 * @addtogroup lavc_encoding
4571 * Find a registered encoder with a matching codec ID.
4573 * @param id AVCodecID of the requested encoder
4574 * @return An encoder if one was found, NULL otherwise.
4576 AVCodec *avcodec_find_encoder(enum AVCodecID id);
4579 * Find a registered encoder with the specified name.
4581 * @param name name of the requested encoder
4582 * @return An encoder if one was found, NULL otherwise.
4584 AVCodec *avcodec_find_encoder_by_name(const char *name);
4587 * Encode a frame of audio.
4589 * Takes input samples from frame and writes the next output packet, if
4590 * available, to avpkt. The output packet does not necessarily contain data for
4591 * the most recent frame, as encoders can delay, split, and combine input frames
4592 * internally as needed.
4594 * @param avctx codec context
4595 * @param avpkt output AVPacket.
4596 * The user can supply an output buffer by setting
4597 * avpkt->data and avpkt->size prior to calling the
4598 * function, but if the size of the user-provided data is not
4599 * large enough, encoding will fail. All other AVPacket fields
4600 * will be reset by the encoder using av_init_packet(). If
4601 * avpkt->data is NULL, the encoder will allocate it.
4602 * The encoder will set avpkt->size to the size of the
4605 * If this function fails or produces no output, avpkt will be
4606 * freed using av_packet_unref().
4607 * @param[in] frame AVFrame containing the raw audio data to be encoded.
4608 * May be NULL when flushing an encoder that has the
4609 * AV_CODEC_CAP_DELAY capability set.
4610 * If AV_CODEC_CAP_VARIABLE_FRAME_SIZE is set, then each frame
4611 * can have any number of samples.
4612 * If it is not set, frame->nb_samples must be equal to
4613 * avctx->frame_size for all frames except the last.
4614 * The final frame may be smaller than avctx->frame_size.
4615 * @param[out] got_packet_ptr This field is set to 1 by libavcodec if the
4616 * output packet is non-empty, and to 0 if it is
4617 * empty. If the function returns an error, the
4618 * packet can be assumed to be invalid, and the
4619 * value of got_packet_ptr is undefined and should
4621 * @return 0 on success, negative error code on failure
4623 int avcodec_encode_audio2(AVCodecContext *avctx, AVPacket *avpkt,
4624 const AVFrame *frame, int *got_packet_ptr);
4627 * Encode a frame of video.
4629 * Takes input raw video data from frame and writes the next output packet, if
4630 * available, to avpkt. The output packet does not necessarily contain data for
4631 * the most recent frame, as encoders can delay and reorder input frames
4632 * internally as needed.
4634 * @param avctx codec context
4635 * @param avpkt output AVPacket.
4636 * The user can supply an output buffer by setting
4637 * avpkt->data and avpkt->size prior to calling the
4638 * function, but if the size of the user-provided data is not
4639 * large enough, encoding will fail. All other AVPacket fields
4640 * will be reset by the encoder using av_init_packet(). If
4641 * avpkt->data is NULL, the encoder will allocate it.
4642 * The encoder will set avpkt->size to the size of the
4643 * output packet. The returned data (if any) belongs to the
4644 * caller, he is responsible for freeing it.
4646 * If this function fails or produces no output, avpkt will be
4647 * freed using av_packet_unref().
4648 * @param[in] frame AVFrame containing the raw video data to be encoded.
4649 * May be NULL when flushing an encoder that has the
4650 * AV_CODEC_CAP_DELAY capability set.
4651 * @param[out] got_packet_ptr This field is set to 1 by libavcodec if the
4652 * output packet is non-empty, and to 0 if it is
4653 * empty. If the function returns an error, the
4654 * packet can be assumed to be invalid, and the
4655 * value of got_packet_ptr is undefined and should
4657 * @return 0 on success, negative error code on failure
4659 int avcodec_encode_video2(AVCodecContext *avctx, AVPacket *avpkt,
4660 const AVFrame *frame, int *got_packet_ptr);
4662 int avcodec_encode_subtitle(AVCodecContext *avctx, uint8_t *buf, int buf_size,
4663 const AVSubtitle *sub);
4670 #if FF_API_AVPICTURE
4672 * @addtogroup lavc_picture
4677 * @deprecated unused
4679 attribute_deprecated
4680 int avpicture_alloc(AVPicture *picture, enum AVPixelFormat pix_fmt, int width, int height);
4683 * @deprecated unused
4685 attribute_deprecated
4686 void avpicture_free(AVPicture *picture);
4689 * @deprecated use av_image_fill_arrays() instead.
4691 attribute_deprecated
4692 int avpicture_fill(AVPicture *picture, uint8_t *ptr,
4693 enum AVPixelFormat pix_fmt, int width, int height);
4696 * @deprecated use av_image_copy_to_buffer() instead.
4698 attribute_deprecated
4699 int avpicture_layout(const AVPicture* src, enum AVPixelFormat pix_fmt,
4700 int width, int height,
4701 unsigned char *dest, int dest_size);
4704 * @deprecated use av_image_get_buffer_size() instead.
4706 attribute_deprecated
4707 int avpicture_get_size(enum AVPixelFormat pix_fmt, int width, int height);
4710 * @deprecated av_image_copy() instead.
4712 attribute_deprecated
4713 void av_picture_copy(AVPicture *dst, const AVPicture *src,
4714 enum AVPixelFormat pix_fmt, int width, int height);
4717 * @deprecated unused
4719 attribute_deprecated
4720 int av_picture_crop(AVPicture *dst, const AVPicture *src,
4721 enum AVPixelFormat pix_fmt, int top_band, int left_band);
4724 * @deprecated unused
4726 attribute_deprecated
4727 int av_picture_pad(AVPicture *dst, const AVPicture *src, int height, int width, enum AVPixelFormat pix_fmt,
4728 int padtop, int padbottom, int padleft, int padright, int *color);
4736 * @defgroup lavc_misc Utility functions
4739 * Miscellaneous utility functions related to both encoding and decoding
4745 * @defgroup lavc_misc_pixfmt Pixel formats
4747 * Functions for working with pixel formats.
4752 * @deprecated Use av_pix_fmt_get_chroma_sub_sample
4755 void attribute_deprecated avcodec_get_chroma_sub_sample(enum AVPixelFormat pix_fmt, int *h_shift, int *v_shift);
4758 * Return a value representing the fourCC code associated to the
4759 * pixel format pix_fmt, or 0 if no associated fourCC code can be
4762 unsigned int avcodec_pix_fmt_to_codec_tag(enum AVPixelFormat pix_fmt);
4764 #define FF_LOSS_RESOLUTION 0x0001 /**< loss due to resolution change */
4765 #define FF_LOSS_DEPTH 0x0002 /**< loss due to color depth change */
4766 #define FF_LOSS_COLORSPACE 0x0004 /**< loss due to color space conversion */
4767 #define FF_LOSS_ALPHA 0x0008 /**< loss of alpha bits */
4768 #define FF_LOSS_COLORQUANT 0x0010 /**< loss due to color quantization */
4769 #define FF_LOSS_CHROMA 0x0020 /**< loss of chroma (e.g. RGB to gray conversion) */
4772 * Compute what kind of losses will occur when converting from one specific
4773 * pixel format to another.
4774 * When converting from one pixel format to another, information loss may occur.
4775 * For example, when converting from RGB24 to GRAY, the color information will
4776 * be lost. Similarly, other losses occur when converting from some formats to
4777 * other formats. These losses can involve loss of chroma, but also loss of
4778 * resolution, loss of color depth, loss due to the color space conversion, loss
4779 * of the alpha bits or loss due to color quantization.
4780 * avcodec_get_fix_fmt_loss() informs you about the various types of losses
4781 * which will occur when converting from one pixel format to another.
4783 * @param[in] dst_pix_fmt destination pixel format
4784 * @param[in] src_pix_fmt source pixel format
4785 * @param[in] has_alpha Whether the source pixel format alpha channel is used.
4786 * @return Combination of flags informing you what kind of losses will occur.
4788 int avcodec_get_pix_fmt_loss(enum AVPixelFormat dst_pix_fmt, enum AVPixelFormat src_pix_fmt,
4792 * Find the best pixel format to convert to given a certain source pixel
4793 * format. When converting from one pixel format to another, information loss
4794 * may occur. For example, when converting from RGB24 to GRAY, the color
4795 * information will be lost. Similarly, other losses occur when converting from
4796 * some formats to other formats. avcodec_find_best_pix_fmt2() searches which of
4797 * the given pixel formats should be used to suffer the least amount of loss.
4798 * The pixel formats from which it chooses one, are determined by the
4799 * pix_fmt_list parameter.
4802 * @param[in] pix_fmt_list AV_PIX_FMT_NONE terminated array of pixel formats to choose from
4803 * @param[in] src_pix_fmt source pixel format
4804 * @param[in] has_alpha Whether the source pixel format alpha channel is used.
4805 * @param[out] loss_ptr Combination of flags informing you what kind of losses will occur.
4806 * @return The best pixel format to convert to or -1 if none was found.
4808 enum AVPixelFormat avcodec_find_best_pix_fmt2(enum AVPixelFormat *pix_fmt_list,
4809 enum AVPixelFormat src_pix_fmt,
4810 int has_alpha, int *loss_ptr);
4812 enum AVPixelFormat avcodec_default_get_format(struct AVCodecContext *s, const enum AVPixelFormat * fmt);
4818 #if FF_API_SET_DIMENSIONS
4820 * @deprecated this function is not supposed to be used from outside of lavc
4822 attribute_deprecated
4823 void avcodec_set_dimensions(AVCodecContext *s, int width, int height);
4827 * Put a string representing the codec tag codec_tag in buf.
4829 * @param buf buffer to place codec tag in
4830 * @param buf_size size in bytes of buf
4831 * @param codec_tag codec tag to assign
4832 * @return the length of the string that would have been generated if
4833 * enough space had been available, excluding the trailing null
4835 size_t av_get_codec_tag_string(char *buf, size_t buf_size, unsigned int codec_tag);
4837 void avcodec_string(char *buf, int buf_size, AVCodecContext *enc, int encode);
4840 * Return a name for the specified profile, if available.
4842 * @param codec the codec that is searched for the given profile
4843 * @param profile the profile value for which a name is requested
4844 * @return A name for the profile if found, NULL otherwise.
4846 const char *av_get_profile_name(const AVCodec *codec, int profile);
4849 * Return a name for the specified profile, if available.
4851 * @param codec_id the ID of the codec to which the requested profile belongs
4852 * @param profile the profile value for which a name is requested
4853 * @return A name for the profile if found, NULL otherwise.
4855 * @note unlike av_get_profile_name(), which searches a list of profiles
4856 * supported by a specific decoder or encoder implementation, this
4857 * function searches the list of profiles from the AVCodecDescriptor
4859 const char *avcodec_profile_name(enum AVCodecID codec_id, int profile);
4861 int avcodec_default_execute(AVCodecContext *c, int (*func)(AVCodecContext *c2, void *arg2),void *arg, int *ret, int count, int size);
4862 int avcodec_default_execute2(AVCodecContext *c, int (*func)(AVCodecContext *c2, void *arg2, int, int),void *arg, int *ret, int count);
4863 //FIXME func typedef
4866 * Fill audio frame data and linesize.
4867 * AVFrame extended_data channel pointers are allocated if necessary for
4870 * @param frame the AVFrame
4871 * frame->nb_samples must be set prior to calling the
4872 * function. This function fills in frame->data,
4873 * frame->extended_data, frame->linesize[0].
4874 * @param nb_channels channel count
4875 * @param sample_fmt sample format
4876 * @param buf buffer to use for frame data
4877 * @param buf_size size of buffer
4878 * @param align plane size sample alignment (0 = default)
4879 * @return 0 on success, negative error code on failure
4881 int avcodec_fill_audio_frame(AVFrame *frame, int nb_channels,
4882 enum AVSampleFormat sample_fmt, const uint8_t *buf,
4883 int buf_size, int align);
4886 * Reset the internal decoder state / flush internal buffers. Should be called
4887 * e.g. when seeking or when switching to a different stream.
4889 * @note when refcounted frames are not used (i.e. avctx->refcounted_frames is 0),
4890 * this invalidates the frames previously returned from the decoder. When
4891 * refcounted frames are used, the decoder just releases any references it might
4892 * keep internally, but the caller's reference remains valid.
4894 void avcodec_flush_buffers(AVCodecContext *avctx);
4897 * Return codec bits per sample.
4899 * @param[in] codec_id the codec
4900 * @return Number of bits per sample or zero if unknown for the given codec.
4902 int av_get_bits_per_sample(enum AVCodecID codec_id);
4905 * Return codec bits per sample.
4906 * Only return non-zero if the bits per sample is exactly correct, not an
4909 * @param[in] codec_id the codec
4910 * @return Number of bits per sample or zero if unknown for the given codec.
4912 int av_get_exact_bits_per_sample(enum AVCodecID codec_id);
4915 * Return audio frame duration.
4917 * @param avctx codec context
4918 * @param frame_bytes size of the frame, or 0 if unknown
4919 * @return frame duration, in samples, if known. 0 if not able to
4922 int av_get_audio_frame_duration(AVCodecContext *avctx, int frame_bytes);
4925 * This function is the same as av_get_audio_frame_duration(), except it works
4926 * with AVCodecParameters instead of an AVCodecContext.
4928 int av_get_audio_frame_duration2(AVCodecParameters *par, int frame_bytes);
4931 typedef struct AVBitStreamFilterContext {
4933 struct AVBitStreamFilter *filter;
4934 AVCodecParserContext *parser;
4935 struct AVBitStreamFilterContext *next;
4936 } AVBitStreamFilterContext;
4939 typedef struct AVBSFInternal AVBSFInternal;
4942 * The bitstream filter state.
4944 * This struct must be allocated with av_bsf_alloc() and freed with
4947 * The fields in the struct will only be changed (by the caller or by the
4948 * filter) as described in their documentation, and are to be considered
4949 * immutable otherwise.
4951 typedef struct AVBSFContext {
4953 * A class for logging and AVOptions
4955 const AVClass *av_class;
4958 * The bitstream filter this context is an instance of.
4960 const struct AVBitStreamFilter *filter;
4963 * Opaque libavcodec internal data. Must not be touched by the caller in any
4966 AVBSFInternal *internal;
4969 * Opaque filter-specific private data. If filter->priv_class is non-NULL,
4970 * this is an AVOptions-enabled struct.
4975 * Parameters of the input stream. Set by the caller before av_bsf_init().
4977 AVCodecParameters *par_in;
4980 * Parameters of the output stream. Set by the filter in av_bsf_init().
4982 AVCodecParameters *par_out;
4985 * The timebase used for the timestamps of the input packets. Set by the
4986 * caller before av_bsf_init().
4988 AVRational time_base_in;
4991 * The timebase used for the timestamps of the output packets. Set by the
4992 * filter in av_bsf_init().
4994 AVRational time_base_out;
4997 typedef struct AVBitStreamFilter {
5001 * A list of codec ids supported by the filter, terminated by
5003 * May be NULL, in that case the bitstream filter works with any codec id.
5005 const enum AVCodecID *codec_ids;
5008 * A class for the private data, used to declare bitstream filter private
5009 * AVOptions. This field is NULL for bitstream filters that do not declare
5012 * If this field is non-NULL, the first member of the filter private data
5013 * must be a pointer to AVClass, which will be set by libavcodec generic
5014 * code to this class.
5016 const AVClass *priv_class;
5018 /*****************************************************************
5019 * No fields below this line are part of the public API. They
5020 * may not be used outside of libavcodec and can be changed and
5022 * New public fields should be added right above.
5023 *****************************************************************
5027 int (*init)(AVBSFContext *ctx);
5028 int (*filter)(AVBSFContext *ctx, AVPacket *pkt);
5029 void (*close)(AVBSFContext *ctx);
5030 } AVBitStreamFilter;
5034 * @deprecated the old bitstream filtering API (using AVBitStreamFilterContext)
5035 * is deprecated. Use the new bitstream filtering API (using AVBSFContext).
5037 attribute_deprecated
5038 void av_register_bitstream_filter(AVBitStreamFilter *bsf);
5039 attribute_deprecated
5040 AVBitStreamFilterContext *av_bitstream_filter_init(const char *name);
5041 attribute_deprecated
5042 int av_bitstream_filter_filter(AVBitStreamFilterContext *bsfc,
5043 AVCodecContext *avctx, const char *args,
5044 uint8_t **poutbuf, int *poutbuf_size,
5045 const uint8_t *buf, int buf_size, int keyframe);
5046 attribute_deprecated
5047 void av_bitstream_filter_close(AVBitStreamFilterContext *bsf);
5048 attribute_deprecated
5049 AVBitStreamFilter *av_bitstream_filter_next(const AVBitStreamFilter *f);
5053 * @return a bitstream filter with the specified name or NULL if no such
5054 * bitstream filter exists.
5056 const AVBitStreamFilter *av_bsf_get_by_name(const char *name);
5059 * Iterate over all registered bitstream filters.
5061 * @param opaque a pointer where libavcodec will store the iteration state. Must
5062 * point to NULL to start the iteration.
5064 * @return the next registered bitstream filter or NULL when the iteration is
5067 const AVBitStreamFilter *av_bsf_next(void **opaque);
5070 * Allocate a context for a given bitstream filter. The caller must fill in the
5071 * context parameters as described in the documentation and then call
5072 * av_bsf_init() before sending any data to the filter.
5074 * @param filter the filter for which to allocate an instance.
5075 * @param ctx a pointer into which the pointer to the newly-allocated context
5076 * will be written. It must be freed with av_bsf_free() after the
5077 * filtering is done.
5079 * @return 0 on success, a negative AVERROR code on failure
5081 int av_bsf_alloc(const AVBitStreamFilter *filter, AVBSFContext **ctx);
5084 * Prepare the filter for use, after all the parameters and options have been
5087 int av_bsf_init(AVBSFContext *ctx);
5090 * Submit a packet for filtering.
5092 * After sending each packet, the filter must be completely drained by calling
5093 * av_bsf_receive_packet() repeatedly until it returns AVERROR(EAGAIN) or
5096 * @param pkt the packet to filter. The bitstream filter will take ownership of
5097 * the packet and reset the contents of pkt. pkt is not touched if an error occurs.
5098 * This parameter may be NULL, which signals the end of the stream (i.e. no more
5099 * packets will be sent). That will cause the filter to output any packets it
5100 * may have buffered internally.
5102 * @return 0 on success, a negative AVERROR on error.
5104 int av_bsf_send_packet(AVBSFContext *ctx, AVPacket *pkt);
5107 * Retrieve a filtered packet.
5109 * @param[out] pkt this struct will be filled with the contents of the filtered
5110 * packet. It is owned by the caller and must be freed using
5111 * av_packet_unref() when it is no longer needed.
5112 * This parameter should be "clean" (i.e. freshly allocated
5113 * with av_packet_alloc() or unreffed with av_packet_unref())
5114 * when this function is called. If this function returns
5115 * successfully, the contents of pkt will be completely
5116 * overwritten by the returned data. On failure, pkt is not
5119 * @return 0 on success. AVERROR(EAGAIN) if more packets need to be sent to the
5120 * filter (using av_bsf_send_packet()) to get more output. AVERROR_EOF if there
5121 * will be no further output from the filter. Another negative AVERROR value if
5124 * @note one input packet may result in several output packets, so after sending
5125 * a packet with av_bsf_send_packet(), this function needs to be called
5126 * repeatedly until it stops returning 0. It is also possible for a filter to
5127 * output fewer packets than were sent to it, so this function may return
5128 * AVERROR(EAGAIN) immediately after a successful av_bsf_send_packet() call.
5130 int av_bsf_receive_packet(AVBSFContext *ctx, AVPacket *pkt);
5133 * Free a bitstream filter context and everything associated with it; write NULL
5134 * into the supplied pointer.
5136 void av_bsf_free(AVBSFContext **ctx);
5139 * Get the AVClass for AVBSFContext. It can be used in combination with
5140 * AV_OPT_SEARCH_FAKE_OBJ for examining options.
5142 * @see av_opt_find().
5144 const AVClass *av_bsf_get_class(void);
5149 * Allocate a buffer with padding, reusing the given one if large enough.
5151 * Same behaviour av_fast_malloc but the buffer has additional
5152 * AV_INPUT_PADDING_SIZE at the end which will always memset to 0.
5154 void av_fast_padded_malloc(void *ptr, unsigned int *size, size_t min_size);
5157 * Encode extradata length to a buffer. Used by xiph codecs.
5159 * @param s buffer to write to; must be at least (v/255+1) bytes long
5160 * @param v size of extradata in bytes
5161 * @return number of bytes written to the buffer.
5163 unsigned int av_xiphlacing(unsigned char *s, unsigned int v);
5165 #if FF_API_MISSING_SAMPLE
5167 * Log a generic warning message about a missing feature. This function is
5168 * intended to be used internally by Libav (libavcodec, libavformat, etc.)
5169 * only, and would normally not be used by applications.
5170 * @param[in] avc a pointer to an arbitrary struct of which the first field is
5171 * a pointer to an AVClass struct
5172 * @param[in] feature string containing the name of the missing feature
5173 * @param[in] want_sample indicates if samples are wanted which exhibit this feature.
5174 * If want_sample is non-zero, additional verbage will be added to the log
5175 * message which tells the user how to report samples to the development
5177 * @deprecated Use avpriv_report_missing_feature() instead.
5179 attribute_deprecated
5180 void av_log_missing_feature(void *avc, const char *feature, int want_sample);
5183 * Log a generic warning message asking for a sample. This function is
5184 * intended to be used internally by Libav (libavcodec, libavformat, etc.)
5185 * only, and would normally not be used by applications.
5186 * @param[in] avc a pointer to an arbitrary struct of which the first field is
5187 * a pointer to an AVClass struct
5188 * @param[in] msg string containing an optional message, or NULL if no message
5189 * @deprecated Use avpriv_request_sample() instead.
5191 attribute_deprecated
5192 void av_log_ask_for_sample(void *avc, const char *msg, ...) av_printf_format(2, 3);
5193 #endif /* FF_API_MISSING_SAMPLE */
5196 * Register the hardware accelerator hwaccel.
5198 void av_register_hwaccel(AVHWAccel *hwaccel);
5201 * If hwaccel is NULL, returns the first registered hardware accelerator,
5202 * if hwaccel is non-NULL, returns the next registered hardware accelerator
5203 * after hwaccel, or NULL if hwaccel is the last one.
5205 AVHWAccel *av_hwaccel_next(const AVHWAccel *hwaccel);
5209 * Lock operation used by lockmgr
5212 AV_LOCK_CREATE, ///< Create a mutex
5213 AV_LOCK_OBTAIN, ///< Lock the mutex
5214 AV_LOCK_RELEASE, ///< Unlock the mutex
5215 AV_LOCK_DESTROY, ///< Free mutex resources
5219 * Register a user provided lock manager supporting the operations
5220 * specified by AVLockOp. The "mutex" argument to the function points
5221 * to a (void *) where the lockmgr should store/get a pointer to a user
5222 * allocated mutex. It is NULL upon AV_LOCK_CREATE and equal to the
5223 * value left by the last call for all other ops. If the lock manager is
5224 * unable to perform the op then it should leave the mutex in the same
5225 * state as when it was called and return a non-zero value. However,
5226 * when called with AV_LOCK_DESTROY the mutex will always be assumed to
5227 * have been successfully destroyed. If av_lockmgr_register succeeds
5228 * it will return a non-negative value, if it fails it will return a
5229 * negative value and destroy all mutex and unregister all callbacks.
5230 * av_lockmgr_register is not thread-safe, it must be called from a
5231 * single thread before any calls which make use of locking are used.
5233 * @param cb User defined callback. av_lockmgr_register invokes calls
5234 * to this callback and the previously registered callback.
5235 * The callback will be used to create more than one mutex
5236 * each of which must be backed by its own underlying locking
5237 * mechanism (i.e. do not use a single static object to
5238 * implement your lock manager). If cb is set to NULL the
5239 * lockmgr will be unregistered.
5241 int av_lockmgr_register(int (*cb)(void **mutex, enum AVLockOp op));
5244 * Get the type of the given codec.
5246 enum AVMediaType avcodec_get_type(enum AVCodecID codec_id);
5249 * @return a positive value if s is open (i.e. avcodec_open2() was called on it
5250 * with no corresponding avcodec_close()), 0 otherwise.
5252 int avcodec_is_open(AVCodecContext *s);
5255 * @return a non-zero number if codec is an encoder, zero otherwise
5257 int av_codec_is_encoder(const AVCodec *codec);
5260 * @return a non-zero number if codec is a decoder, zero otherwise
5262 int av_codec_is_decoder(const AVCodec *codec);
5265 * @return descriptor for given codec ID or NULL if no descriptor exists.
5267 const AVCodecDescriptor *avcodec_descriptor_get(enum AVCodecID id);
5270 * Iterate over all codec descriptors known to libavcodec.
5272 * @param prev previous descriptor. NULL to get the first descriptor.
5274 * @return next descriptor or NULL after the last descriptor
5276 const AVCodecDescriptor *avcodec_descriptor_next(const AVCodecDescriptor *prev);
5279 * @return codec descriptor with the given name or NULL if no such descriptor
5282 const AVCodecDescriptor *avcodec_descriptor_get_by_name(const char *name);
5285 * Allocate a CPB properties structure and initialize its fields to default
5288 * @param size if non-NULL, the size of the allocated struct will be written
5289 * here. This is useful for embedding it in side data.
5291 * @return the newly allocated struct or NULL on failure
5293 AVCPBProperties *av_cpb_properties_alloc(size_t *size);
5299 #endif /* AVCODEC_AVCODEC_H */