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"
45 * @defgroup libavc Encoding/Decoding Library
48 * @defgroup lavc_decoding Decoding
52 * @defgroup lavc_encoding Encoding
56 * @defgroup lavc_codec Codecs
58 * @defgroup lavc_codec_native Native Codecs
61 * @defgroup lavc_codec_wrappers External library wrappers
64 * @defgroup lavc_codec_hwaccel Hardware Accelerators bridge
68 * @defgroup lavc_internal Internal
76 * @defgroup lavc_encdec send/receive encoding and decoding API overview
79 * The avcodec_send_packet()/avcodec_receive_frame()/avcodec_send_frame()/
80 * avcodec_receive_packet() functions provide an encode/decode API, which
81 * decouples input and output.
83 * The API is very similar for encoding/decoding and audio/video, and works as
85 * - Set up and open the AVCodecContext as usual.
87 * - For decoding, call avcodec_send_packet() to give the decoder raw
88 * compressed data in an AVPacket.
89 * - For encoding, call avcodec_send_frame() to give the decoder an AVFrame
90 * containing uncompressed audio or video.
91 * In both cases, it is recommended that AVPackets and AVFrames are
92 * refcounted, or libavcodec might have to copy the input data. (libavformat
93 * always returns refcounted AVPackets, and av_frame_get_buffer() allocates
94 * refcounted AVFrames.)
95 * - Receive output in a loop. Periodically call one of the avcodec_receive_*()
96 * functions and process their output:
97 * - For decoding, call avcodec_receive_frame(). On success, it will return
98 * an AVFrame containing uncompressed audio or video data.
99 * - For encoding, call avcodec_receive_packet(). On success, it will return
100 * an AVPacket with a compressed frame.
101 * Repeat this call until it returns AVERROR(EAGAIN) or an error. The
102 * AVERROR(EAGAIN) return value means that new input data is required to
103 * return new output. In this case, continue with sending input. For each
104 * input frame/packet, the codec will typically return 1 output frame/packet,
105 * but it can also be 0 or more than 1.
107 * At the beginning of decoding or encoding, the codec might accept multiple
108 * input frames/packets without returning a frame, until its internal buffers
109 * are filled. This situation is handled transparently if you follow the steps
112 * In theory, sending input can result in EAGAIN - this should happen only if
113 * not all output was received. You can use this to structure alternative decode
114 * or encode loops other than the one suggested above. For example, you could
115 * try sending new input on each iteration, and try to receive output if that
118 * End of stream situations. These require "flushing" (aka draining) the codec,
119 * as the codec might buffer multiple frames or packets internally for
120 * performance or out of necessity (consider B-frames).
121 * This is handled as follows:
122 * - Instead of valid input, send NULL to the avcodec_send_packet() (decoding)
123 * or avcodec_send_frame() (encoding) functions. This will enter draining
125 * - Call avcodec_receive_frame() (decoding) or avcodec_receive_packet()
126 * (encoding) in a loop until AVERROR_EOF is returned. The functions will
127 * not return AVERROR(EAGAIN), unless you forgot to enter draining mode.
128 * - Before decoding can be resumed again, the codec has to be reset with
129 * avcodec_flush_buffers().
131 * Using the API as outlined above is highly recommended. But it is also
132 * possible to call functions outside of this rigid schema. For example, you can
133 * call avcodec_send_packet() repeatedly without calling
134 * avcodec_receive_frame(). In this case, avcodec_send_packet() will succeed
135 * until the codec's internal buffer has been filled up (which is typically of
136 * size 1 per output frame, after initial input), and then reject input with
137 * AVERROR(EAGAIN). Once it starts rejecting input, you have no choice but to
138 * read at least some output.
140 * Not all codecs will follow a rigid and predictable dataflow; the only
141 * guarantee is that an AVERROR(EAGAIN) return value on a send/receive call on
142 * one end implies that a receive/send call on the other end will succeed. In
143 * general, no codec will permit unlimited buffering of input or output.
145 * This API replaces the following legacy functions:
146 * - avcodec_decode_video2() and avcodec_decode_audio4():
147 * Use avcodec_send_packet() to feed input to the decoder, then use
148 * avcodec_receive_frame() to receive decoded frames after each packet.
149 * Unlike with the old video decoding API, multiple frames might result from
150 * a packet. For audio, splitting the input packet into frames by partially
151 * decoding packets becomes transparent to the API user. You never need to
152 * feed an AVPacket to the API twice (unless it is rejected with EAGAIN - then
153 * no data was read from the packet).
154 * Additionally, sending a flush/draining packet is required only once.
155 * - avcodec_encode_video2()/avcodec_encode_audio2():
156 * Use avcodec_send_frame() to feed input to the encoder, then use
157 * avcodec_receive_packet() to receive encoded packets.
158 * Providing user-allocated buffers for avcodec_receive_packet() is not
160 * - The new API does not handle subtitles yet.
162 * Mixing new and old function calls on the same AVCodecContext is not allowed,
163 * and will result in arbitrary behavior.
165 * Some codecs might require using the new API; using the old API will return
166 * an error when calling it. All codecs support the new API.
168 * A codec is not allowed to return EAGAIN for both sending and receiving. This
169 * would be an invalid state, which could put the codec user into an endless
170 * loop. The API has no concept of time either: it cannot happen that trying to
171 * do avcodec_send_packet() results in EAGAIN, but a repeated call 1 second
172 * later accepts the packet (with no other receive/flush API calls involved).
173 * The API is a strict state machine, and the passage of time is not supposed
174 * to influence it. Some timing-dependent behavior might still be deemed
175 * acceptable in certain cases. But it must never result in both send/receive
176 * returning EAGAIN at the same time at any point. It must also absolutely be
177 * avoided that the current state is "unstable" and can "flip-flop" between
178 * the send/receive APIs allowing progress. For example, it's not allowed that
179 * the codec randomly decides that it actually wants to consume a packet now
180 * instead of returning a frame, after it just returned EAGAIN on an
181 * avcodec_send_packet() call.
186 * @defgroup lavc_core Core functions/structures.
189 * Basic definitions, functions for querying libavcodec capabilities,
190 * allocating core structures, etc.
196 * Identify the syntax and semantics of the bitstream.
197 * The principle is roughly:
198 * Two decoders with the same ID can decode the same streams.
199 * Two encoders with the same ID can encode compatible streams.
200 * There may be slight deviations from the principle due to implementation
203 * If you add a codec ID to this list, add it so that
204 * 1. no value of a existing codec ID changes (that would break ABI),
205 * 2. it is as close as possible to similar codecs.
207 * After adding new codec IDs, do not forget to add an entry to the codec
208 * descriptor list and bump libavcodec minor version.
214 AV_CODEC_ID_MPEG1VIDEO,
215 AV_CODEC_ID_MPEG2VIDEO, ///< preferred ID for MPEG-1/2 video decoding
226 AV_CODEC_ID_RAWVIDEO,
227 AV_CODEC_ID_MSMPEG4V1,
228 AV_CODEC_ID_MSMPEG4V2,
229 AV_CODEC_ID_MSMPEG4V3,
252 AV_CODEC_ID_INTERPLAY_VIDEO,
259 AV_CODEC_ID_MSVIDEO1,
264 AV_CODEC_ID_TRUEMOTION1,
265 AV_CODEC_ID_VMDVIDEO,
290 AV_CODEC_ID_TRUEMOTION2,
296 AV_CODEC_ID_SMACKVIDEO,
301 AV_CODEC_ID_JPEG2000,
307 AV_CODEC_ID_DSICINVIDEO,
308 AV_CODEC_ID_TIERTEXSEQVIDEO,
316 AV_CODEC_ID_BETHSOFTVID,
328 AV_CODEC_ID_ESCAPE124,
332 AV_CODEC_ID_MOTIONPIXELS,
344 AV_CODEC_ID_FLASHSV2,
345 AV_CODEC_ID_CDGRAPHICS,
348 AV_CODEC_ID_BINKVIDEO,
349 AV_CODEC_ID_IFF_ILBM,
350 AV_CODEC_ID_IFF_BYTERUN1,
356 AV_CODEC_ID_A64_MULTI,
357 AV_CODEC_ID_A64_MULTI5,
360 AV_CODEC_ID_LAGARITH,
364 AV_CODEC_ID_WMV3IMAGE,
365 AV_CODEC_ID_VC1IMAGE,
367 AV_CODEC_ID_BMV_VIDEO,
374 AV_CODEC_ID_ZEROCODEC,
383 AV_CODEC_ID_ESCAPE130,
386 AV_CODEC_ID_HNM4_VIDEO,
389 AV_CODEC_ID_ALIAS_PIX,
390 AV_CODEC_ID_BRENDER_PIX,
391 AV_CODEC_ID_PAF_VIDEO,
404 AV_CODEC_ID_SCREENPRESSO,
406 AV_CODEC_ID_MAGICYUV,
407 AV_CODEC_ID_TRUEMOTION2RT,
412 AV_CODEC_ID_CLEARVIDEO,
414 /* various PCM "codecs" */
415 AV_CODEC_ID_FIRST_AUDIO = 0x10000, ///< A dummy id pointing at the start of audio codecs
416 AV_CODEC_ID_PCM_S16LE = 0x10000,
417 AV_CODEC_ID_PCM_S16BE,
418 AV_CODEC_ID_PCM_U16LE,
419 AV_CODEC_ID_PCM_U16BE,
422 AV_CODEC_ID_PCM_MULAW,
423 AV_CODEC_ID_PCM_ALAW,
424 AV_CODEC_ID_PCM_S32LE,
425 AV_CODEC_ID_PCM_S32BE,
426 AV_CODEC_ID_PCM_U32LE,
427 AV_CODEC_ID_PCM_U32BE,
428 AV_CODEC_ID_PCM_S24LE,
429 AV_CODEC_ID_PCM_S24BE,
430 AV_CODEC_ID_PCM_U24LE,
431 AV_CODEC_ID_PCM_U24BE,
432 AV_CODEC_ID_PCM_S24DAUD,
433 AV_CODEC_ID_PCM_ZORK,
434 AV_CODEC_ID_PCM_S16LE_PLANAR,
436 AV_CODEC_ID_PCM_F32BE,
437 AV_CODEC_ID_PCM_F32LE,
438 AV_CODEC_ID_PCM_F64BE,
439 AV_CODEC_ID_PCM_F64LE,
440 AV_CODEC_ID_PCM_BLURAY,
443 AV_CODEC_ID_PCM_S8_PLANAR,
444 AV_CODEC_ID_PCM_S24LE_PLANAR,
445 AV_CODEC_ID_PCM_S32LE_PLANAR,
446 AV_CODEC_ID_PCM_S16BE_PLANAR,
448 /* various ADPCM codecs */
449 AV_CODEC_ID_ADPCM_IMA_QT = 0x11000,
450 AV_CODEC_ID_ADPCM_IMA_WAV,
451 AV_CODEC_ID_ADPCM_IMA_DK3,
452 AV_CODEC_ID_ADPCM_IMA_DK4,
453 AV_CODEC_ID_ADPCM_IMA_WS,
454 AV_CODEC_ID_ADPCM_IMA_SMJPEG,
455 AV_CODEC_ID_ADPCM_MS,
456 AV_CODEC_ID_ADPCM_4XM,
457 AV_CODEC_ID_ADPCM_XA,
458 AV_CODEC_ID_ADPCM_ADX,
459 AV_CODEC_ID_ADPCM_EA,
460 AV_CODEC_ID_ADPCM_G726,
461 AV_CODEC_ID_ADPCM_CT,
462 AV_CODEC_ID_ADPCM_SWF,
463 AV_CODEC_ID_ADPCM_YAMAHA,
464 AV_CODEC_ID_ADPCM_SBPRO_4,
465 AV_CODEC_ID_ADPCM_SBPRO_3,
466 AV_CODEC_ID_ADPCM_SBPRO_2,
467 AV_CODEC_ID_ADPCM_THP,
468 AV_CODEC_ID_ADPCM_IMA_AMV,
469 AV_CODEC_ID_ADPCM_EA_R1,
470 AV_CODEC_ID_ADPCM_EA_R3,
471 AV_CODEC_ID_ADPCM_EA_R2,
472 AV_CODEC_ID_ADPCM_IMA_EA_SEAD,
473 AV_CODEC_ID_ADPCM_IMA_EA_EACS,
474 AV_CODEC_ID_ADPCM_EA_XAS,
475 AV_CODEC_ID_ADPCM_EA_MAXIS_XA,
476 AV_CODEC_ID_ADPCM_IMA_ISS,
477 AV_CODEC_ID_ADPCM_G722,
478 AV_CODEC_ID_ADPCM_IMA_APC,
479 AV_CODEC_ID_ADPCM_VIMA,
482 AV_CODEC_ID_AMR_NB = 0x12000,
485 /* RealAudio codecs*/
486 AV_CODEC_ID_RA_144 = 0x13000,
489 /* various DPCM codecs */
490 AV_CODEC_ID_ROQ_DPCM = 0x14000,
491 AV_CODEC_ID_INTERPLAY_DPCM,
492 AV_CODEC_ID_XAN_DPCM,
493 AV_CODEC_ID_SOL_DPCM,
496 AV_CODEC_ID_MP2 = 0x15000,
497 AV_CODEC_ID_MP3, ///< preferred ID for decoding MPEG audio layer 1, 2 or 3
507 AV_CODEC_ID_VMDAUDIO,
513 AV_CODEC_ID_WESTWOOD_SND1,
514 AV_CODEC_ID_GSM, ///< as in Berlin toast format
517 AV_CODEC_ID_TRUESPEECH,
519 AV_CODEC_ID_SMACKAUDIO,
522 AV_CODEC_ID_DSICINAUDIO,
524 AV_CODEC_ID_MUSEPACK7,
526 AV_CODEC_ID_GSM_MS, /* as found in WAV */
529 AV_CODEC_ID_NELLYMOSER,
530 AV_CODEC_ID_MUSEPACK8,
532 AV_CODEC_ID_WMAVOICE,
534 AV_CODEC_ID_WMALOSSLESS,
543 AV_CODEC_ID_BINKAUDIO_RDFT,
544 AV_CODEC_ID_BINKAUDIO_DCT,
545 AV_CODEC_ID_AAC_LATM,
550 AV_CODEC_ID_8SVX_EXP,
551 AV_CODEC_ID_8SVX_FIB,
552 AV_CODEC_ID_BMV_AUDIO,
557 AV_CODEC_ID_COMFORT_NOISE,
559 AV_CODEC_ID_METASOUND,
560 AV_CODEC_ID_PAF_AUDIO,
564 /* subtitle codecs */
565 AV_CODEC_ID_FIRST_SUBTITLE = 0x17000, ///< A dummy ID pointing at the start of subtitle codecs.
566 AV_CODEC_ID_DVD_SUBTITLE = 0x17000,
567 AV_CODEC_ID_DVB_SUBTITLE,
568 AV_CODEC_ID_TEXT, ///< raw UTF-8 text
571 AV_CODEC_ID_MOV_TEXT,
572 AV_CODEC_ID_HDMV_PGS_SUBTITLE,
573 AV_CODEC_ID_DVB_TELETEXT,
576 /* other specific kind of codecs (generally used for attachments) */
577 AV_CODEC_ID_FIRST_UNKNOWN = 0x18000, ///< A dummy ID pointing at the start of various fake codecs.
578 AV_CODEC_ID_TTF = 0x18000,
580 AV_CODEC_ID_PROBE = 0x19000, ///< codec_id is not known (like AV_CODEC_ID_NONE) but lavf should attempt to identify it
582 AV_CODEC_ID_MPEG2TS = 0x20000, /**< _FAKE_ codec to indicate a raw MPEG-2 TS
583 * stream (only used by libavformat) */
584 AV_CODEC_ID_MPEG4SYSTEMS = 0x20001, /**< _FAKE_ codec to indicate a MPEG-4 Systems
585 * stream (only used by libavformat) */
586 AV_CODEC_ID_FFMETADATA = 0x21000, ///< Dummy codec for streams containing only metadata information.
587 AV_CODEC_ID_WRAPPED_AVFRAME = 0x21001, ///< Passthrough codec, AVFrames wrapped in AVPacket
591 * This struct describes the properties of a single codec described by an
593 * @see avcodec_descriptor_get()
595 typedef struct AVCodecDescriptor {
597 enum AVMediaType type;
599 * Name of the codec described by this descriptor. It is non-empty and
600 * unique for each codec descriptor. It should contain alphanumeric
601 * characters and '_' only.
605 * A more descriptive name for this codec. May be NULL.
607 const char *long_name;
609 * Codec properties, a combination of AV_CODEC_PROP_* flags.
613 * If non-NULL, an array of profiles recognized for this codec.
614 * Terminated with FF_PROFILE_UNKNOWN.
616 const struct AVProfile *profiles;
620 * Codec uses only intra compression.
623 #define AV_CODEC_PROP_INTRA_ONLY (1 << 0)
625 * Codec supports lossy compression. Audio and video codecs only.
626 * @note a codec may support both lossy and lossless
629 #define AV_CODEC_PROP_LOSSY (1 << 1)
631 * Codec supports lossless compression. Audio and video codecs only.
633 #define AV_CODEC_PROP_LOSSLESS (1 << 2)
635 * Codec supports frame reordering. That is, the coded order (the order in which
636 * the encoded packets are output by the encoders / stored / input to the
637 * decoders) may be different from the presentation order of the corresponding
640 * For codecs that do not have this property set, PTS and DTS should always be
643 #define AV_CODEC_PROP_REORDER (1 << 3)
646 * @ingroup lavc_decoding
647 * Required number of additionally allocated bytes at the end of the input bitstream for decoding.
648 * This is mainly needed because some optimized bitstream readers read
649 * 32 or 64 bit at once and could read over the end.<br>
650 * Note: If the first 23 bits of the additional bytes are not 0, then damaged
651 * MPEG bitstreams could cause overread and segfault.
653 #define AV_INPUT_BUFFER_PADDING_SIZE 8
656 * @ingroup lavc_encoding
657 * minimum encoding buffer size
658 * Used to avoid some checks during header writing.
660 #define AV_INPUT_BUFFER_MIN_SIZE 16384
663 * @ingroup lavc_decoding
666 /* We leave some space between them for extensions (drop some
667 * keyframes for intra-only or drop just some bidir frames). */
668 AVDISCARD_NONE =-16, ///< discard nothing
669 AVDISCARD_DEFAULT = 0, ///< discard useless packets like 0 size packets in avi
670 AVDISCARD_NONREF = 8, ///< discard all non reference
671 AVDISCARD_BIDIR = 16, ///< discard all bidirectional frames
672 AVDISCARD_NONKEY = 32, ///< discard all frames except keyframes
673 AVDISCARD_ALL = 48, ///< discard all
676 enum AVAudioServiceType {
677 AV_AUDIO_SERVICE_TYPE_MAIN = 0,
678 AV_AUDIO_SERVICE_TYPE_EFFECTS = 1,
679 AV_AUDIO_SERVICE_TYPE_VISUALLY_IMPAIRED = 2,
680 AV_AUDIO_SERVICE_TYPE_HEARING_IMPAIRED = 3,
681 AV_AUDIO_SERVICE_TYPE_DIALOGUE = 4,
682 AV_AUDIO_SERVICE_TYPE_COMMENTARY = 5,
683 AV_AUDIO_SERVICE_TYPE_EMERGENCY = 6,
684 AV_AUDIO_SERVICE_TYPE_VOICE_OVER = 7,
685 AV_AUDIO_SERVICE_TYPE_KARAOKE = 8,
686 AV_AUDIO_SERVICE_TYPE_NB , ///< Not part of ABI
690 * @ingroup lavc_encoding
692 typedef struct RcOverride{
695 int qscale; // If this is 0 then quality_factor will be used instead.
696 float quality_factor;
700 These flags can be passed in AVCodecContext.flags before initialization.
701 Note: Not everything is supported yet.
705 * Allow decoders to produce frames with data planes that are not aligned
706 * to CPU requirements (e.g. due to cropping).
708 #define AV_CODEC_FLAG_UNALIGNED (1 << 0)
712 #define AV_CODEC_FLAG_QSCALE (1 << 1)
714 * 4 MV per MB allowed / advanced prediction for H.263.
716 #define AV_CODEC_FLAG_4MV (1 << 2)
718 * Output even those frames that might be corrupted.
720 #define AV_CODEC_FLAG_OUTPUT_CORRUPT (1 << 3)
724 #define AV_CODEC_FLAG_QPEL (1 << 4)
726 * Use internal 2pass ratecontrol in first pass mode.
728 #define AV_CODEC_FLAG_PASS1 (1 << 9)
730 * Use internal 2pass ratecontrol in second pass mode.
732 #define AV_CODEC_FLAG_PASS2 (1 << 10)
736 #define AV_CODEC_FLAG_LOOP_FILTER (1 << 11)
738 * Only decode/encode grayscale.
740 #define AV_CODEC_FLAG_GRAY (1 << 13)
742 * error[?] variables will be set during encoding.
744 #define AV_CODEC_FLAG_PSNR (1 << 15)
746 * Input bitstream might be truncated at a random location
747 * instead of only at frame boundaries.
749 #define AV_CODEC_FLAG_TRUNCATED (1 << 16)
751 * Use interlaced DCT.
753 #define AV_CODEC_FLAG_INTERLACED_DCT (1 << 18)
757 #define AV_CODEC_FLAG_LOW_DELAY (1 << 19)
759 * Place global headers in extradata instead of every keyframe.
761 #define AV_CODEC_FLAG_GLOBAL_HEADER (1 << 22)
763 * Use only bitexact stuff (except (I)DCT).
765 #define AV_CODEC_FLAG_BITEXACT (1 << 23)
766 /* Fx : Flag for H.263+ extra options */
768 * H.263 advanced intra coding / MPEG-4 AC prediction
770 #define AV_CODEC_FLAG_AC_PRED (1 << 24)
772 * interlaced motion estimation
774 #define AV_CODEC_FLAG_INTERLACED_ME (1 << 29)
775 #define AV_CODEC_FLAG_CLOSED_GOP (1 << 31)
778 * Allow non spec compliant speedup tricks.
780 #define AV_CODEC_FLAG2_FAST (1 << 0)
782 * Skip bitstream encoding.
784 #define AV_CODEC_FLAG2_NO_OUTPUT (1 << 2)
786 * Place global headers at every keyframe instead of in extradata.
788 #define AV_CODEC_FLAG2_LOCAL_HEADER (1 << 3)
790 * Input bitstream might be truncated at a packet boundaries
791 * instead of only at frame boundaries.
793 #define AV_CODEC_FLAG2_CHUNKS (1 << 15)
795 * Discard cropping information from SPS.
797 #define AV_CODEC_FLAG2_IGNORE_CROP (1 << 16)
799 /* Unsupported options :
800 * Syntax Arithmetic coding (SAC)
801 * Reference Picture Selection
802 * Independent Segment Decoding */
804 /* codec capabilities */
807 * Decoder can use draw_horiz_band callback.
809 #define AV_CODEC_CAP_DRAW_HORIZ_BAND (1 << 0)
811 * Codec uses get_buffer() for allocating buffers and supports custom allocators.
812 * If not set, it might not use get_buffer() at all or use operations that
813 * assume the buffer was allocated by avcodec_default_get_buffer.
815 #define AV_CODEC_CAP_DR1 (1 << 1)
816 #define AV_CODEC_CAP_TRUNCATED (1 << 3)
818 * Encoder or decoder requires flushing with NULL input at the end in order to
819 * give the complete and correct output.
821 * NOTE: If this flag is not set, the codec is guaranteed to never be fed with
822 * with NULL data. The user can still send NULL data to the public encode
823 * or decode function, but libavcodec will not pass it along to the codec
824 * unless this flag is set.
827 * The decoder has a non-zero delay and needs to be fed with avpkt->data=NULL,
828 * avpkt->size=0 at the end to get the delayed data until the decoder no longer
832 * The encoder needs to be fed with NULL data at the end of encoding until the
833 * encoder no longer returns data.
835 * NOTE: For encoders implementing the AVCodec.encode2() function, setting this
836 * flag also means that the encoder must set the pts and duration for
837 * each output packet. If this flag is not set, the pts and duration will
838 * be determined by libavcodec from the input frame.
840 #define AV_CODEC_CAP_DELAY (1 << 5)
842 * Codec can be fed a final frame with a smaller size.
843 * This can be used to prevent truncation of the last audio samples.
845 #define AV_CODEC_CAP_SMALL_LAST_FRAME (1 << 6)
847 * Codec can output multiple frames per AVPacket
848 * Normally demuxers return one frame at a time, demuxers which do not do
849 * are connected to a parser to split what they return into proper frames.
850 * This flag is reserved to the very rare category of codecs which have a
851 * bitstream that cannot be split into frames without timeconsuming
852 * operations like full decoding. Demuxers carrying such bitstreams thus
853 * may return multiple frames in a packet. This has many disadvantages like
854 * prohibiting stream copy in many cases thus it should only be considered
857 #define AV_CODEC_CAP_SUBFRAMES (1 << 8)
859 * Codec is experimental and is thus avoided in favor of non experimental
862 #define AV_CODEC_CAP_EXPERIMENTAL (1 << 9)
864 * Codec should fill in channel configuration and samplerate instead of container
866 #define AV_CODEC_CAP_CHANNEL_CONF (1 << 10)
868 * Codec supports frame-level multithreading.
870 #define AV_CODEC_CAP_FRAME_THREADS (1 << 12)
872 * Codec supports slice-based (or partition-based) multithreading.
874 #define AV_CODEC_CAP_SLICE_THREADS (1 << 13)
876 * Codec supports changed parameters at any point.
878 #define AV_CODEC_CAP_PARAM_CHANGE (1 << 14)
880 * Codec supports avctx->thread_count == 0 (auto).
882 #define AV_CODEC_CAP_AUTO_THREADS (1 << 15)
884 * Audio encoder supports receiving a different number of samples in each call.
886 #define AV_CODEC_CAP_VARIABLE_FRAME_SIZE (1 << 16)
889 * Codec is backed by a hardware implementation. Typically used to
890 * identify a non-hwaccel hardware decoder.
892 #define AV_CODEC_CAP_HARDWARE (1 << 17)
895 * Codec is potentially backed by a hardware implementation, but not
896 * necessarily. This is used instead of AV_CODEC_CAP_HARDWARE, if the
897 * implementation provides some sort of internal fallback.
899 #define AV_CODEC_CAP_HYBRID (1 << 18)
903 * This specifies the area which should be displayed.
904 * Note there may be multiple such areas for one frame.
906 typedef struct AVPanScan{
909 * - encoding: Set by user.
910 * - decoding: Set by libavcodec.
915 * width and height in 1/16 pel
916 * - encoding: Set by user.
917 * - decoding: Set by libavcodec.
923 * position of the top left corner in 1/16 pel for up to 3 fields/frames
924 * - encoding: Set by user.
925 * - decoding: Set by libavcodec.
927 int16_t position[3][2];
931 * This structure describes the bitrate properties of an encoded bitstream. It
932 * roughly corresponds to a subset the VBV parameters for MPEG-2 or HRD
933 * parameters for H.264/HEVC.
935 typedef struct AVCPBProperties {
937 * Maximum bitrate of the stream, in bits per second.
938 * Zero if unknown or unspecified.
942 * Minimum bitrate of the stream, in bits per second.
943 * Zero if unknown or unspecified.
947 * Average bitrate of the stream, in bits per second.
948 * Zero if unknown or unspecified.
953 * The size of the buffer to which the ratecontrol is applied, in bits.
954 * Zero if unknown or unspecified.
959 * The delay between the time the packet this structure is associated with
960 * is received and the time when it should be decoded, in periods of a 27MHz
963 * UINT64_MAX when unknown or unspecified.
969 * The decoder will keep a reference to the frame and may reuse it later.
971 #define AV_GET_BUFFER_FLAG_REF (1 << 0)
974 * @defgroup lavc_packet AVPacket
976 * Types and functions for working with AVPacket.
979 enum AVPacketSideDataType {
981 * An AV_PKT_DATA_PALETTE side data packet contains exactly AVPALETTE_SIZE
982 * bytes worth of palette. This side data signals that a new palette is
988 * The AV_PKT_DATA_NEW_EXTRADATA is used to notify the codec or the format
989 * that the extradata buffer was changed and the receiving side should
990 * act upon it appropriately. The new extradata is embedded in the side
991 * data buffer and should be immediately used for processing the current
994 AV_PKT_DATA_NEW_EXTRADATA,
997 * An AV_PKT_DATA_PARAM_CHANGE side data packet is laid out as follows:
1000 * if (param_flags & AV_SIDE_DATA_PARAM_CHANGE_CHANNEL_COUNT)
1001 * s32le channel_count
1002 * if (param_flags & AV_SIDE_DATA_PARAM_CHANGE_CHANNEL_LAYOUT)
1003 * u64le channel_layout
1004 * if (param_flags & AV_SIDE_DATA_PARAM_CHANGE_SAMPLE_RATE)
1006 * if (param_flags & AV_SIDE_DATA_PARAM_CHANGE_DIMENSIONS)
1011 AV_PKT_DATA_PARAM_CHANGE,
1014 * An AV_PKT_DATA_H263_MB_INFO side data packet contains a number of
1015 * structures with info about macroblocks relevant to splitting the
1016 * packet into smaller packets on macroblock edges (e.g. as for RFC 2190).
1017 * That is, it does not necessarily contain info about all macroblocks,
1018 * as long as the distance between macroblocks in the info is smaller
1019 * than the target payload size.
1020 * Each MB info structure is 12 bytes, and is laid out as follows:
1022 * u32le bit offset from the start of the packet
1023 * u8 current quantizer at the start of the macroblock
1025 * u16le macroblock address within the GOB
1026 * u8 horizontal MV predictor
1027 * u8 vertical MV predictor
1028 * u8 horizontal MV predictor for block number 3
1029 * u8 vertical MV predictor for block number 3
1032 AV_PKT_DATA_H263_MB_INFO,
1035 * This side data should be associated with an audio stream and contains
1036 * ReplayGain information in form of the AVReplayGain struct.
1038 AV_PKT_DATA_REPLAYGAIN,
1041 * This side data contains a 3x3 transformation matrix describing an affine
1042 * transformation that needs to be applied to the decoded video frames for
1043 * correct presentation.
1045 * See libavutil/display.h for a detailed description of the data.
1047 AV_PKT_DATA_DISPLAYMATRIX,
1050 * This side data should be associated with a video stream and contains
1051 * Stereoscopic 3D information in form of the AVStereo3D struct.
1053 AV_PKT_DATA_STEREO3D,
1056 * This side data should be associated with an audio stream and corresponds
1057 * to enum AVAudioServiceType.
1059 AV_PKT_DATA_AUDIO_SERVICE_TYPE,
1062 * This side data contains an integer value representing the quality
1063 * factor of the compressed frame. Allowed range is between 1 (good)
1064 * and FF_LAMBDA_MAX (bad).
1066 AV_PKT_DATA_QUALITY_FACTOR,
1069 * This side data contains an integer value representing the stream index
1070 * of a "fallback" track. A fallback track indicates an alternate
1071 * track to use when the current track can not be decoded for some reason.
1072 * e.g. no decoder available for codec.
1074 AV_PKT_DATA_FALLBACK_TRACK,
1077 * This side data corresponds to the AVCPBProperties struct.
1079 AV_PKT_DATA_CPB_PROPERTIES,
1082 * This side data should be associated with a video stream and corresponds
1083 * to the AVSphericalMapping structure.
1085 AV_PKT_DATA_SPHERICAL,
1088 typedef struct AVPacketSideData {
1091 enum AVPacketSideDataType type;
1095 * This structure stores compressed data. It is typically exported by demuxers
1096 * and then passed as input to decoders, or received as output from encoders and
1097 * then passed to muxers.
1099 * For video, it should typically contain one compressed frame. For audio it may
1100 * contain several compressed frames. Encoders are allowed to output empty
1101 * packets, with no compressed data, containing only side data
1102 * (e.g. to update some stream parameters at the end of encoding).
1104 * AVPacket is one of the few structs in Libav, whose size is a part of public
1105 * ABI. Thus it may be allocated on stack and no new fields can be added to it
1106 * without libavcodec and libavformat major bump.
1108 * The semantics of data ownership depends on the buf field.
1109 * If it is set, the packet data is dynamically allocated and is
1110 * valid indefinitely until a call to av_packet_unref() reduces the
1111 * reference count to 0.
1113 * If the buf field is not set av_packet_ref() would make a copy instead
1114 * of increasing the reference count.
1116 * The side data is always allocated with av_malloc(), copied by
1117 * av_packet_ref() and freed by av_packet_unref().
1119 * @see av_packet_ref
1120 * @see av_packet_unref
1122 typedef struct AVPacket {
1124 * A reference to the reference-counted buffer where the packet data is
1126 * May be NULL, then the packet data is not reference-counted.
1130 * Presentation timestamp in AVStream->time_base units; the time at which
1131 * the decompressed packet will be presented to the user.
1132 * Can be AV_NOPTS_VALUE if it is not stored in the file.
1133 * pts MUST be larger or equal to dts as presentation cannot happen before
1134 * decompression, unless one wants to view hex dumps. Some formats misuse
1135 * the terms dts and pts/cts to mean something different. Such timestamps
1136 * must be converted to true pts/dts before they are stored in AVPacket.
1140 * Decompression timestamp in AVStream->time_base units; the time at which
1141 * the packet is decompressed.
1142 * Can be AV_NOPTS_VALUE if it is not stored in the file.
1149 * A combination of AV_PKT_FLAG values
1153 * Additional packet data that can be provided by the container.
1154 * Packet can contain several types of side information.
1156 AVPacketSideData *side_data;
1157 int side_data_elems;
1160 * Duration of this packet in AVStream->time_base units, 0 if unknown.
1161 * Equals next_pts - this_pts in presentation order.
1165 int64_t pos; ///< byte position in stream, -1 if unknown
1167 #if FF_API_CONVERGENCE_DURATION
1169 * @deprecated Same as the duration field, but as int64_t. This was required
1170 * for Matroska subtitles, whose duration values could overflow when the
1171 * duration field was still an int.
1173 attribute_deprecated
1174 int64_t convergence_duration;
1177 #define AV_PKT_FLAG_KEY 0x0001 ///< The packet contains a keyframe
1178 #define AV_PKT_FLAG_CORRUPT 0x0002 ///< The packet content is corrupted
1180 enum AVSideDataParamChangeFlags {
1181 AV_SIDE_DATA_PARAM_CHANGE_CHANNEL_COUNT = 0x0001,
1182 AV_SIDE_DATA_PARAM_CHANGE_CHANNEL_LAYOUT = 0x0002,
1183 AV_SIDE_DATA_PARAM_CHANGE_SAMPLE_RATE = 0x0004,
1184 AV_SIDE_DATA_PARAM_CHANGE_DIMENSIONS = 0x0008,
1190 struct AVCodecInternal;
1194 AV_FIELD_PROGRESSIVE,
1195 AV_FIELD_TT, //< Top coded_first, top displayed first
1196 AV_FIELD_BB, //< Bottom coded first, bottom displayed first
1197 AV_FIELD_TB, //< Top coded first, bottom displayed first
1198 AV_FIELD_BT, //< Bottom coded first, top displayed first
1202 * main external API structure.
1203 * New fields can be added to the end with minor version bumps.
1204 * Removal, reordering and changes to existing fields require a major
1206 * sizeof(AVCodecContext) must not be used outside libav*.
1208 typedef struct AVCodecContext {
1210 * information on struct for av_log
1211 * - set by avcodec_alloc_context3
1213 const AVClass *av_class;
1214 int log_level_offset;
1216 enum AVMediaType codec_type; /* see AVMEDIA_TYPE_xxx */
1217 const struct AVCodec *codec;
1218 enum AVCodecID codec_id; /* see AV_CODEC_ID_xxx */
1221 * fourcc (LSB first, so "ABCD" -> ('D'<<24) + ('C'<<16) + ('B'<<8) + 'A').
1222 * This is used to work around some encoder bugs.
1223 * A demuxer should set this to what is stored in the field used to identify the codec.
1224 * If there are multiple such fields in a container then the demuxer should choose the one
1225 * which maximizes the information about the used codec.
1226 * If the codec tag field in a container is larger than 32 bits then the demuxer should
1227 * remap the longer ID to 32 bits with a table or other structure. Alternatively a new
1228 * extra_codec_tag + size could be added but for this a clear advantage must be demonstrated
1230 * - encoding: Set by user, if not then the default based on codec_id will be used.
1231 * - decoding: Set by user, will be converted to uppercase by libavcodec during init.
1233 unsigned int codec_tag;
1238 * Private context used for internal data.
1240 * Unlike priv_data, this is not codec-specific. It is used in general
1241 * libavcodec functions.
1243 struct AVCodecInternal *internal;
1246 * Private data of the user, can be used to carry app specific stuff.
1247 * - encoding: Set by user.
1248 * - decoding: Set by user.
1253 * the average bitrate
1254 * - encoding: Set by user; unused for constant quantizer encoding.
1255 * - decoding: Set by libavcodec. 0 or some bitrate if this info is available in the stream.
1260 * number of bits the bitstream is allowed to diverge from the reference.
1261 * the reference can be CBR (for CBR pass1) or VBR (for pass2)
1262 * - encoding: Set by user; unused for constant quantizer encoding.
1263 * - decoding: unused
1265 int bit_rate_tolerance;
1268 * Global quality for codecs which cannot change it per frame.
1269 * This should be proportional to MPEG-1/2/4 qscale.
1270 * - encoding: Set by user.
1271 * - decoding: unused
1276 * - encoding: Set by user.
1277 * - decoding: unused
1279 int compression_level;
1280 #define FF_COMPRESSION_DEFAULT -1
1284 * - encoding: Set by user.
1285 * - decoding: Set by user.
1291 * - encoding: Set by user.
1292 * - decoding: Set by user.
1297 * some codecs need / can use extradata like Huffman tables.
1298 * MJPEG: Huffman tables
1299 * rv10: additional flags
1300 * MPEG-4: global headers (they can be in the bitstream or here)
1301 * The allocated memory should be AV_INPUT_BUFFER_PADDING_SIZE bytes larger
1302 * than extradata_size to avoid problems if it is read with the bitstream reader.
1303 * The bytewise contents of extradata must not depend on the architecture or CPU endianness.
1304 * - encoding: Set/allocated/freed by libavcodec.
1305 * - decoding: Set/allocated/freed by user.
1311 * This is the fundamental unit of time (in seconds) in terms
1312 * of which frame timestamps are represented. For fixed-fps content,
1313 * timebase should be 1/framerate and timestamp increments should be
1315 * - encoding: MUST be set by user.
1316 * - decoding: the use of this field for decoding is deprecated.
1317 * Use framerate instead.
1319 AVRational time_base;
1322 * For some codecs, the time base is closer to the field rate than the frame rate.
1323 * Most notably, H.264 and MPEG-2 specify time_base as half of frame duration
1324 * if no telecine is used ...
1326 * Set to time_base ticks per frame. Default 1, e.g., H.264/MPEG-2 set it to 2.
1328 int ticks_per_frame;
1334 * Number of frames the decoded output will be delayed relative to the
1338 * For encoding, this field is unused (see initial_padding).
1340 * For decoding, this is the number of samples the decoder needs to
1341 * output before the decoder's output is valid. When seeking, you should
1342 * start decoding this many samples prior to your desired seek point.
1344 * - encoding: Set by libavcodec.
1345 * - decoding: Set by libavcodec.
1352 * picture width / height.
1354 * @note Those fields may not match the values of the last
1355 * AVFrame output by avcodec_decode_video2 due frame
1358 * - encoding: MUST be set by user.
1359 * - decoding: May be set by the user before opening the decoder if known e.g.
1360 * from the container. Some decoders will require the dimensions
1361 * to be set by the caller. During decoding, the decoder may
1362 * overwrite those values as required while parsing the data.
1367 * Bitstream width / height, may be different from width/height e.g. when
1368 * the decoded frame is cropped before being output.
1370 * @note Those field may not match the value of the last
1371 * AVFrame output by avcodec_receive_frame() due frame
1374 * - encoding: unused
1375 * - decoding: May be set by the user before opening the decoder if known
1376 * e.g. from the container. During decoding, the decoder may
1377 * overwrite those values as required while parsing the data.
1379 int coded_width, coded_height;
1382 * the number of pictures in a group of pictures, or 0 for intra_only
1383 * - encoding: Set by user.
1384 * - decoding: unused
1389 * Pixel format, see AV_PIX_FMT_xxx.
1390 * May be set by the demuxer if known from headers.
1391 * May be overridden by the decoder if it knows better.
1393 * @note This field may not match the value of the last
1394 * AVFrame output by avcodec_receive_frame() due frame
1397 * - encoding: Set by user.
1398 * - decoding: Set by user if known, overridden by libavcodec while
1401 enum AVPixelFormat pix_fmt;
1404 * If non NULL, 'draw_horiz_band' is called by the libavcodec
1405 * decoder to draw a horizontal band. It improves cache usage. Not
1406 * all codecs can do that. You must check the codec capabilities
1408 * When multithreading is used, it may be called from multiple threads
1409 * at the same time; threads might draw different parts of the same AVFrame,
1410 * or multiple AVFrames, and there is no guarantee that slices will be drawn
1412 * The function is also used by hardware acceleration APIs.
1413 * It is called at least once during frame decoding to pass
1414 * the data needed for hardware render.
1415 * In that mode instead of pixel data, AVFrame points to
1416 * a structure specific to the acceleration API. The application
1417 * reads the structure and can change some fields to indicate progress
1419 * - encoding: unused
1420 * - decoding: Set by user.
1421 * @param height the height of the slice
1422 * @param y the y position of the slice
1423 * @param type 1->top field, 2->bottom field, 3->frame
1424 * @param offset offset into the AVFrame.data from which the slice should be read
1426 void (*draw_horiz_band)(struct AVCodecContext *s,
1427 const AVFrame *src, int offset[AV_NUM_DATA_POINTERS],
1428 int y, int type, int height);
1431 * callback to negotiate the pixelFormat
1432 * @param fmt is the list of formats which are supported by the codec,
1433 * it is terminated by -1 as 0 is a valid format, the formats are ordered by quality.
1434 * The first is always the native one.
1435 * @note The callback may be called again immediately if initialization for
1436 * the selected (hardware-accelerated) pixel format failed.
1437 * @warning Behavior is undefined if the callback returns a value not
1438 * in the fmt list of formats.
1439 * @return the chosen format
1440 * - encoding: unused
1441 * - decoding: Set by user, if not set the native format will be chosen.
1443 enum AVPixelFormat (*get_format)(struct AVCodecContext *s, const enum AVPixelFormat * fmt);
1446 * maximum number of B-frames between non-B-frames
1447 * Note: The output will be delayed by max_b_frames+1 relative to the input.
1448 * - encoding: Set by user.
1449 * - decoding: unused
1454 * qscale factor between IP and B-frames
1455 * If > 0 then the last P-frame quantizer will be used (q= lastp_q*factor+offset).
1456 * If < 0 then normal ratecontrol will be done (q= -normal_q*factor+offset).
1457 * - encoding: Set by user.
1458 * - decoding: unused
1460 float b_quant_factor;
1462 #if FF_API_PRIVATE_OPT
1463 /** @deprecated use encoder private options instead */
1464 attribute_deprecated
1465 int b_frame_strategy;
1469 * qscale offset between IP and B-frames
1470 * - encoding: Set by user.
1471 * - decoding: unused
1473 float b_quant_offset;
1476 * Size of the frame reordering buffer in the decoder.
1477 * For MPEG-2 it is 1 IPB or 0 low delay IP.
1478 * - encoding: Set by libavcodec.
1479 * - decoding: Set by libavcodec.
1483 #if FF_API_PRIVATE_OPT
1484 /** @deprecated use encoder private options instead */
1485 attribute_deprecated
1490 * qscale factor between P- and I-frames
1491 * If > 0 then the last P-frame quantizer will be used (q = lastp_q * factor + offset).
1492 * If < 0 then normal ratecontrol will be done (q= -normal_q*factor+offset).
1493 * - encoding: Set by user.
1494 * - decoding: unused
1496 float i_quant_factor;
1499 * qscale offset between P and I-frames
1500 * - encoding: Set by user.
1501 * - decoding: unused
1503 float i_quant_offset;
1506 * luminance masking (0-> disabled)
1507 * - encoding: Set by user.
1508 * - decoding: unused
1513 * temporary complexity masking (0-> disabled)
1514 * - encoding: Set by user.
1515 * - decoding: unused
1517 float temporal_cplx_masking;
1520 * spatial complexity masking (0-> disabled)
1521 * - encoding: Set by user.
1522 * - decoding: unused
1524 float spatial_cplx_masking;
1527 * p block masking (0-> disabled)
1528 * - encoding: Set by user.
1529 * - decoding: unused
1534 * darkness masking (0-> disabled)
1535 * - encoding: Set by user.
1536 * - decoding: unused
1542 * - encoding: Set by libavcodec.
1543 * - decoding: Set by user (or 0).
1547 #if FF_API_PRIVATE_OPT
1548 /** @deprecated use encoder private options instead */
1549 attribute_deprecated
1550 int prediction_method;
1551 #define FF_PRED_LEFT 0
1552 #define FF_PRED_PLANE 1
1553 #define FF_PRED_MEDIAN 2
1557 * slice offsets in the frame in bytes
1558 * - encoding: Set/allocated by libavcodec.
1559 * - decoding: Set/allocated by user (or NULL).
1564 * sample aspect ratio (0 if unknown)
1565 * That is the width of a pixel divided by the height of the pixel.
1566 * Numerator and denominator must be relatively prime and smaller than 256 for some video standards.
1567 * - encoding: Set by user.
1568 * - decoding: Set by libavcodec.
1570 AVRational sample_aspect_ratio;
1573 * motion estimation comparison function
1574 * - encoding: Set by user.
1575 * - decoding: unused
1579 * subpixel motion estimation comparison function
1580 * - encoding: Set by user.
1581 * - decoding: unused
1585 * macroblock comparison function (not supported yet)
1586 * - encoding: Set by user.
1587 * - decoding: unused
1591 * interlaced DCT comparison function
1592 * - encoding: Set by user.
1593 * - decoding: unused
1596 #define FF_CMP_SAD 0
1597 #define FF_CMP_SSE 1
1598 #define FF_CMP_SATD 2
1599 #define FF_CMP_DCT 3
1600 #define FF_CMP_PSNR 4
1601 #define FF_CMP_BIT 5
1603 #define FF_CMP_ZERO 7
1604 #define FF_CMP_VSAD 8
1605 #define FF_CMP_VSSE 9
1606 #define FF_CMP_NSSE 10
1607 #define FF_CMP_DCTMAX 13
1608 #define FF_CMP_DCT264 14
1609 #define FF_CMP_CHROMA 256
1612 * ME diamond size & shape
1613 * - encoding: Set by user.
1614 * - decoding: unused
1619 * amount of previous MV predictors (2a+1 x 2a+1 square)
1620 * - encoding: Set by user.
1621 * - decoding: unused
1623 int last_predictor_count;
1625 #if FF_API_PRIVATE_OPT
1626 /** @deprecated use encoder private options instead */
1627 attribute_deprecated
1632 * motion estimation prepass comparison function
1633 * - encoding: Set by user.
1634 * - decoding: unused
1639 * ME prepass diamond size & shape
1640 * - encoding: Set by user.
1641 * - decoding: unused
1647 * - encoding: Set by user.
1648 * - decoding: unused
1650 int me_subpel_quality;
1653 * maximum motion estimation search range in subpel units
1654 * If 0 then no limit.
1656 * - encoding: Set by user.
1657 * - decoding: unused
1663 * - encoding: unused
1664 * - decoding: Set by user.
1667 #define SLICE_FLAG_CODED_ORDER 0x0001 ///< draw_horiz_band() is called in coded order instead of display
1668 #define SLICE_FLAG_ALLOW_FIELD 0x0002 ///< allow draw_horiz_band() with field slices (MPEG-2 field pics)
1669 #define SLICE_FLAG_ALLOW_PLANE 0x0004 ///< allow draw_horiz_band() with 1 component at a time (SVQ1)
1672 * macroblock decision mode
1673 * - encoding: Set by user.
1674 * - decoding: unused
1677 #define FF_MB_DECISION_SIMPLE 0 ///< uses mb_cmp
1678 #define FF_MB_DECISION_BITS 1 ///< chooses the one which needs the fewest bits
1679 #define FF_MB_DECISION_RD 2 ///< rate distortion
1682 * custom intra quantization matrix
1683 * - encoding: Set by user, can be NULL.
1684 * - decoding: Set by libavcodec.
1686 uint16_t *intra_matrix;
1689 * custom inter quantization matrix
1690 * - encoding: Set by user, can be NULL.
1691 * - decoding: Set by libavcodec.
1693 uint16_t *inter_matrix;
1695 #if FF_API_PRIVATE_OPT
1696 /** @deprecated use encoder private options instead */
1697 attribute_deprecated
1698 int scenechange_threshold;
1700 /** @deprecated use encoder private options instead */
1701 attribute_deprecated
1702 int noise_reduction;
1706 * precision of the intra DC coefficient - 8
1707 * - encoding: Set by user.
1708 * - decoding: unused
1710 int intra_dc_precision;
1713 * Number of macroblock rows at the top which are skipped.
1714 * - encoding: unused
1715 * - decoding: Set by user.
1720 * Number of macroblock rows at the bottom which are skipped.
1721 * - encoding: unused
1722 * - decoding: Set by user.
1727 * minimum MB Lagrange multiplier
1728 * - encoding: Set by user.
1729 * - decoding: unused
1734 * maximum MB Lagrange multiplier
1735 * - encoding: Set by user.
1736 * - decoding: unused
1740 #if FF_API_PRIVATE_OPT
1742 * @deprecated use encoder private options instead
1744 attribute_deprecated
1745 int me_penalty_compensation;
1749 * - encoding: Set by user.
1750 * - decoding: unused
1754 #if FF_API_PRIVATE_OPT
1755 /** @deprecated use encoder private options instead */
1756 attribute_deprecated
1762 * - encoding: Set by user.
1763 * - decoding: unused
1768 * number of reference frames
1769 * - encoding: Set by user.
1770 * - decoding: Set by lavc.
1774 #if FF_API_PRIVATE_OPT
1775 /** @deprecated use encoder private options instead */
1776 attribute_deprecated
1781 * Note: Value depends upon the compare function used for fullpel ME.
1782 * - encoding: Set by user.
1783 * - decoding: unused
1787 #if FF_API_PRIVATE_OPT
1788 /** @deprecated use encoder private options instead */
1789 attribute_deprecated
1794 * Chromaticity coordinates of the source primaries.
1795 * - encoding: Set by user
1796 * - decoding: Set by libavcodec
1798 enum AVColorPrimaries color_primaries;
1801 * Color Transfer Characteristic.
1802 * - encoding: Set by user
1803 * - decoding: Set by libavcodec
1805 enum AVColorTransferCharacteristic color_trc;
1808 * YUV colorspace type.
1809 * - encoding: Set by user
1810 * - decoding: Set by libavcodec
1812 enum AVColorSpace colorspace;
1815 * MPEG vs JPEG YUV range.
1816 * - encoding: Set by user
1817 * - decoding: Set by libavcodec
1819 enum AVColorRange color_range;
1822 * This defines the location of chroma samples.
1823 * - encoding: Set by user
1824 * - decoding: Set by libavcodec
1826 enum AVChromaLocation chroma_sample_location;
1830 * Indicates number of picture subdivisions. Used for parallelized
1832 * - encoding: Set by user
1833 * - decoding: unused
1838 * - encoding: set by libavcodec
1839 * - decoding: Set by libavcodec
1841 enum AVFieldOrder field_order;
1844 int sample_rate; ///< samples per second
1845 int channels; ///< number of audio channels
1848 * audio sample format
1849 * - encoding: Set by user.
1850 * - decoding: Set by libavcodec.
1852 enum AVSampleFormat sample_fmt; ///< sample format
1854 /* The following data should not be initialized. */
1856 * Number of samples per channel in an audio frame.
1858 * - encoding: set by libavcodec in avcodec_open2(). Each submitted frame
1859 * except the last must contain exactly frame_size samples per channel.
1860 * May be 0 when the codec has AV_CODEC_CAP_VARIABLE_FRAME_SIZE set, then the
1861 * frame size is not restricted.
1862 * - decoding: may be set by some decoders to indicate constant frame size
1867 * Frame counter, set by libavcodec.
1869 * - decoding: total number of frames returned from the decoder so far.
1870 * - encoding: total number of frames passed to the encoder so far.
1872 * @note the counter is not incremented if encoding/decoding resulted in
1878 * number of bytes per packet if constant and known or 0
1879 * Used by some WAV based audio codecs.
1884 * Audio cutoff bandwidth (0 means "automatic")
1885 * - encoding: Set by user.
1886 * - decoding: unused
1891 * Audio channel layout.
1892 * - encoding: set by user.
1893 * - decoding: set by libavcodec.
1895 uint64_t channel_layout;
1898 * Request decoder to use this channel layout if it can (0 for default)
1899 * - encoding: unused
1900 * - decoding: Set by user.
1902 uint64_t request_channel_layout;
1905 * Type of service that the audio stream conveys.
1906 * - encoding: Set by user.
1907 * - decoding: Set by libavcodec.
1909 enum AVAudioServiceType audio_service_type;
1912 * Used to request a sample format from the decoder.
1913 * - encoding: unused.
1914 * - decoding: Set by user.
1916 enum AVSampleFormat request_sample_fmt;
1919 * This callback is called at the beginning of each frame to get data
1920 * buffer(s) for it. There may be one contiguous buffer for all the data or
1921 * there may be a buffer per each data plane or anything in between. What
1922 * this means is, you may set however many entries in buf[] you feel necessary.
1923 * Each buffer must be reference-counted using the AVBuffer API (see description
1926 * The following fields will be set in the frame before this callback is
1929 * - width, height (video only)
1930 * - sample_rate, channel_layout, nb_samples (audio only)
1931 * Their values may differ from the corresponding values in
1932 * AVCodecContext. This callback must use the frame values, not the codec
1933 * context values, to calculate the required buffer size.
1935 * This callback must fill the following fields in the frame:
1939 * * if the data is planar audio with more than 8 channels, then this
1940 * callback must allocate and fill extended_data to contain all pointers
1941 * to all data planes. data[] must hold as many pointers as it can.
1942 * extended_data must be allocated with av_malloc() and will be freed in
1944 * * otherwise extended_data must point to data
1945 * - buf[] must contain one or more pointers to AVBufferRef structures. Each of
1946 * the frame's data and extended_data pointers must be contained in these. That
1947 * is, one AVBufferRef for each allocated chunk of memory, not necessarily one
1948 * AVBufferRef per data[] entry. See: av_buffer_create(), av_buffer_alloc(),
1949 * and av_buffer_ref().
1950 * - extended_buf and nb_extended_buf must be allocated with av_malloc() by
1951 * this callback and filled with the extra buffers if there are more
1952 * buffers than buf[] can hold. extended_buf will be freed in
1955 * If AV_CODEC_CAP_DR1 is not set then get_buffer2() must call
1956 * avcodec_default_get_buffer2() instead of providing buffers allocated by
1959 * Each data plane must be aligned to the maximum required by the target
1962 * @see avcodec_default_get_buffer2()
1966 * If AV_GET_BUFFER_FLAG_REF is set in flags then the frame may be reused
1967 * (read and/or written to if it is writable) later by libavcodec.
1969 * avcodec_align_dimensions2() should be used to find the required width and
1970 * height, as they normally need to be rounded up to the next multiple of 16.
1972 * If frame multithreading is used and thread_safe_callbacks is set,
1973 * this callback may be called from a different thread, but not from more
1974 * than one at once. Does not need to be reentrant.
1976 * @see avcodec_align_dimensions2()
1980 * Decoders request a buffer of a particular size by setting
1981 * AVFrame.nb_samples prior to calling get_buffer2(). The decoder may,
1982 * however, utilize only part of the buffer by setting AVFrame.nb_samples
1983 * to a smaller value in the output frame.
1985 * As a convenience, av_samples_get_buffer_size() and
1986 * av_samples_fill_arrays() in libavutil may be used by custom get_buffer2()
1987 * functions to find the required data size and to fill data pointers and
1988 * linesize. In AVFrame.linesize, only linesize[0] may be set for audio
1989 * since all planes must be the same size.
1991 * @see av_samples_get_buffer_size(), av_samples_fill_arrays()
1993 * - encoding: unused
1994 * - decoding: Set by libavcodec, user can override.
1996 int (*get_buffer2)(struct AVCodecContext *s, AVFrame *frame, int flags);
1999 * If non-zero, the decoded audio and video frames returned from
2000 * avcodec_decode_video2() and avcodec_decode_audio4() are reference-counted
2001 * and are valid indefinitely. The caller must free them with
2002 * av_frame_unref() when they are not needed anymore.
2003 * Otherwise, the decoded frames must not be freed by the caller and are
2004 * only valid until the next decode call.
2006 * This is always automatically enabled if avcodec_receive_frame() is used.
2008 * - encoding: unused
2009 * - decoding: set by the caller before avcodec_open2().
2011 attribute_deprecated int refcounted_frames;
2013 /* - encoding parameters */
2014 float qcompress; ///< amount of qscale change between easy & hard scenes (0.0-1.0)
2015 float qblur; ///< amount of qscale smoothing over time (0.0-1.0)
2019 * - encoding: Set by user.
2020 * - decoding: unused
2026 * - encoding: Set by user.
2027 * - decoding: unused
2032 * maximum quantizer difference between frames
2033 * - encoding: Set by user.
2034 * - decoding: unused
2039 * decoder bitstream buffer size
2040 * - encoding: Set by user.
2041 * - decoding: unused
2046 * ratecontrol override, see RcOverride
2047 * - encoding: Allocated/set/freed by user.
2048 * - decoding: unused
2050 int rc_override_count;
2051 RcOverride *rc_override;
2055 * - encoding: Set by user.
2056 * - decoding: unused
2062 * - encoding: Set by user.
2063 * - decoding: unused
2068 * Ratecontrol attempt to use, at maximum, <value> of what can be used without an underflow.
2069 * - encoding: Set by user.
2070 * - decoding: unused.
2072 float rc_max_available_vbv_use;
2075 * Ratecontrol attempt to use, at least, <value> times the amount needed to prevent a vbv overflow.
2076 * - encoding: Set by user.
2077 * - decoding: unused.
2079 float rc_min_vbv_overflow_use;
2082 * Number of bits which should be loaded into the rc buffer before decoding starts.
2083 * - encoding: Set by user.
2084 * - decoding: unused
2086 int rc_initial_buffer_occupancy;
2088 #if FF_API_CODER_TYPE
2089 #define FF_CODER_TYPE_VLC 0
2090 #define FF_CODER_TYPE_AC 1
2091 #define FF_CODER_TYPE_RAW 2
2092 #define FF_CODER_TYPE_RLE 3
2094 * @deprecated use encoder private options instead
2096 attribute_deprecated
2098 #endif /* FF_API_CODER_TYPE */
2100 #if FF_API_PRIVATE_OPT
2101 /** @deprecated use encoder private options instead */
2102 attribute_deprecated
2106 #if FF_API_PRIVATE_OPT
2107 /** @deprecated use encoder private options instead */
2108 attribute_deprecated
2109 int frame_skip_threshold;
2111 /** @deprecated use encoder private options instead */
2112 attribute_deprecated
2113 int frame_skip_factor;
2115 /** @deprecated use encoder private options instead */
2116 attribute_deprecated
2119 /** @deprecated use encoder private options instead */
2120 attribute_deprecated
2122 #endif /* FF_API_PRIVATE_OPT */
2125 * trellis RD quantization
2126 * - encoding: Set by user.
2127 * - decoding: unused
2131 #if FF_API_PRIVATE_OPT
2132 /** @deprecated use encoder private options instead */
2133 attribute_deprecated
2134 int min_prediction_order;
2136 /** @deprecated use encoder private options instead */
2137 attribute_deprecated
2138 int max_prediction_order;
2140 /** @deprecated use encoder private options instead */
2141 attribute_deprecated
2142 int64_t timecode_frame_start;
2145 #if FF_API_RTP_CALLBACK
2147 * @deprecated unused
2149 /* The RTP callback: This function is called */
2150 /* every time the encoder has a packet to send. */
2151 /* It depends on the encoder if the data starts */
2152 /* with a Start Code (it should). H.263 does. */
2153 /* mb_nb contains the number of macroblocks */
2154 /* encoded in the RTP payload. */
2155 attribute_deprecated
2156 void (*rtp_callback)(struct AVCodecContext *avctx, void *data, int size, int mb_nb);
2159 #if FF_API_PRIVATE_OPT
2160 /** @deprecated use encoder private options instead */
2161 attribute_deprecated
2162 int rtp_payload_size; /* The size of the RTP payload: the coder will */
2163 /* do its best to deliver a chunk with size */
2164 /* below rtp_payload_size, the chunk will start */
2165 /* with a start code on some codecs like H.263. */
2166 /* This doesn't take account of any particular */
2167 /* headers inside the transmitted RTP payload. */
2170 #if FF_API_STAT_BITS
2171 /* statistics, used for 2-pass encoding */
2172 attribute_deprecated
2174 attribute_deprecated
2176 attribute_deprecated
2178 attribute_deprecated
2180 attribute_deprecated
2182 attribute_deprecated
2184 attribute_deprecated
2186 attribute_deprecated
2189 /** @deprecated this field is unused */
2190 attribute_deprecated
2195 * pass1 encoding statistics output buffer
2196 * - encoding: Set by libavcodec.
2197 * - decoding: unused
2202 * pass2 encoding statistics input buffer
2203 * Concatenated stuff from stats_out of pass1 should be placed here.
2204 * - encoding: Allocated/set/freed by user.
2205 * - decoding: unused
2210 * Work around bugs in encoders which sometimes cannot be detected automatically.
2211 * - encoding: Set by user
2212 * - decoding: Set by user
2214 int workaround_bugs;
2215 #define FF_BUG_AUTODETECT 1 ///< autodetection
2216 #define FF_BUG_XVID_ILACE 4
2217 #define FF_BUG_UMP4 8
2218 #define FF_BUG_NO_PADDING 16
2219 #define FF_BUG_AMV 32
2220 #define FF_BUG_QPEL_CHROMA 64
2221 #define FF_BUG_STD_QPEL 128
2222 #define FF_BUG_QPEL_CHROMA2 256
2223 #define FF_BUG_DIRECT_BLOCKSIZE 512
2224 #define FF_BUG_EDGE 1024
2225 #define FF_BUG_HPEL_CHROMA 2048
2226 #define FF_BUG_DC_CLIP 4096
2227 #define FF_BUG_MS 8192 ///< Work around various bugs in Microsoft's broken decoders.
2228 #define FF_BUG_TRUNCATED 16384
2231 * strictly follow the standard (MPEG-4, ...).
2232 * - encoding: Set by user.
2233 * - decoding: Set by user.
2234 * Setting this to STRICT or higher means the encoder and decoder will
2235 * generally do stupid things, whereas setting it to unofficial or lower
2236 * will mean the encoder might produce output that is not supported by all
2237 * spec-compliant decoders. Decoders don't differentiate between normal,
2238 * unofficial and experimental (that is, they always try to decode things
2239 * when they can) unless they are explicitly asked to behave stupidly
2240 * (=strictly conform to the specs)
2242 int strict_std_compliance;
2243 #define FF_COMPLIANCE_VERY_STRICT 2 ///< Strictly conform to an older more strict version of the spec or reference software.
2244 #define FF_COMPLIANCE_STRICT 1 ///< Strictly conform to all the things in the spec no matter what consequences.
2245 #define FF_COMPLIANCE_NORMAL 0
2246 #define FF_COMPLIANCE_UNOFFICIAL -1 ///< Allow unofficial extensions
2247 #define FF_COMPLIANCE_EXPERIMENTAL -2 ///< Allow nonstandardized experimental things.
2250 * error concealment flags
2251 * - encoding: unused
2252 * - decoding: Set by user.
2254 int error_concealment;
2255 #define FF_EC_GUESS_MVS 1
2256 #define FF_EC_DEBLOCK 2
2260 * - encoding: Set by user.
2261 * - decoding: Set by user.
2264 #define FF_DEBUG_PICT_INFO 1
2265 #define FF_DEBUG_RC 2
2266 #define FF_DEBUG_BITSTREAM 4
2267 #define FF_DEBUG_MB_TYPE 8
2268 #define FF_DEBUG_QP 16
2269 #define FF_DEBUG_DCT_COEFF 0x00000040
2270 #define FF_DEBUG_SKIP 0x00000080
2271 #define FF_DEBUG_STARTCODE 0x00000100
2272 #define FF_DEBUG_ER 0x00000400
2273 #define FF_DEBUG_MMCO 0x00000800
2274 #define FF_DEBUG_BUGS 0x00001000
2275 #define FF_DEBUG_BUFFERS 0x00008000
2276 #define FF_DEBUG_THREADS 0x00010000
2279 * Error recognition; may misdetect some more or less valid parts as errors.
2280 * - encoding: unused
2281 * - decoding: Set by user.
2283 int err_recognition;
2286 * Verify checksums embedded in the bitstream (could be of either encoded or
2287 * decoded data, depending on the codec) and print an error message on mismatch.
2288 * If AV_EF_EXPLODE is also set, a mismatching checksum will result in the
2289 * decoder returning an error.
2291 #define AV_EF_CRCCHECK (1<<0)
2292 #define AV_EF_BITSTREAM (1<<1)
2293 #define AV_EF_BUFFER (1<<2)
2294 #define AV_EF_EXPLODE (1<<3)
2297 * opaque 64-bit number (generally a PTS) that will be reordered and
2298 * output in AVFrame.reordered_opaque
2299 * - encoding: unused
2300 * - decoding: Set by user.
2302 int64_t reordered_opaque;
2305 * Hardware accelerator in use
2306 * - encoding: unused.
2307 * - decoding: Set by libavcodec
2309 struct AVHWAccel *hwaccel;
2312 * Hardware accelerator context.
2313 * For some hardware accelerators, a global context needs to be
2314 * provided by the user. In that case, this holds display-dependent
2315 * data Libav cannot instantiate itself. Please refer to the
2316 * Libav HW accelerator documentation to know how to fill this
2317 * is. e.g. for VA API, this is a struct vaapi_context.
2318 * - encoding: unused
2319 * - decoding: Set by user
2321 void *hwaccel_context;
2325 * - encoding: Set by libavcodec if flags & AV_CODEC_FLAG_PSNR.
2326 * - decoding: unused
2328 uint64_t error[AV_NUM_DATA_POINTERS];
2331 * DCT algorithm, see FF_DCT_* below
2332 * - encoding: Set by user.
2333 * - decoding: unused
2336 #define FF_DCT_AUTO 0
2337 #define FF_DCT_FASTINT 1
2338 #define FF_DCT_INT 2
2339 #define FF_DCT_MMX 3
2340 #define FF_DCT_ALTIVEC 5
2341 #define FF_DCT_FAAN 6
2344 * IDCT algorithm, see FF_IDCT_* below.
2345 * - encoding: Set by user.
2346 * - decoding: Set by user.
2349 #define FF_IDCT_AUTO 0
2350 #define FF_IDCT_INT 1
2351 #define FF_IDCT_SIMPLE 2
2352 #define FF_IDCT_SIMPLEMMX 3
2353 #define FF_IDCT_ARM 7
2354 #define FF_IDCT_ALTIVEC 8
2355 #define FF_IDCT_SIMPLEARM 10
2356 #define FF_IDCT_XVID 14
2357 #define FF_IDCT_SIMPLEARMV5TE 16
2358 #define FF_IDCT_SIMPLEARMV6 17
2359 #define FF_IDCT_FAAN 20
2360 #define FF_IDCT_SIMPLENEON 22
2363 * bits per sample/pixel from the demuxer (needed for huffyuv).
2364 * - encoding: Set by libavcodec.
2365 * - decoding: Set by user.
2367 int bits_per_coded_sample;
2370 * Bits per sample/pixel of internal libavcodec pixel/sample format.
2371 * - encoding: set by user.
2372 * - decoding: set by libavcodec.
2374 int bits_per_raw_sample;
2376 #if FF_API_CODED_FRAME
2378 * the picture in the bitstream
2379 * - encoding: Set by libavcodec.
2380 * - decoding: unused
2382 * @deprecated use the quality factor packet side data instead
2384 attribute_deprecated AVFrame *coded_frame;
2389 * is used to decide how many independent tasks should be passed to execute()
2390 * - encoding: Set by user.
2391 * - decoding: Set by user.
2396 * Which multithreading methods to use.
2397 * Use of FF_THREAD_FRAME will increase decoding delay by one frame per thread,
2398 * so clients which cannot provide future frames should not use it.
2400 * - encoding: Set by user, otherwise the default is used.
2401 * - decoding: Set by user, otherwise the default is used.
2404 #define FF_THREAD_FRAME 1 ///< Decode more than one frame at once
2405 #define FF_THREAD_SLICE 2 ///< Decode more than one part of a single frame at once
2408 * Which multithreading methods are in use by the codec.
2409 * - encoding: Set by libavcodec.
2410 * - decoding: Set by libavcodec.
2412 int active_thread_type;
2415 * Set by the client if its custom get_buffer() callback can be called
2416 * synchronously from another thread, which allows faster multithreaded decoding.
2417 * draw_horiz_band() will be called from other threads regardless of this setting.
2418 * Ignored if the default get_buffer() is used.
2419 * - encoding: Set by user.
2420 * - decoding: Set by user.
2422 int thread_safe_callbacks;
2425 * The codec may call this to execute several independent things.
2426 * It will return only after finishing all tasks.
2427 * The user may replace this with some multithreaded implementation,
2428 * the default implementation will execute the parts serially.
2429 * @param count the number of things to execute
2430 * - encoding: Set by libavcodec, user can override.
2431 * - decoding: Set by libavcodec, user can override.
2433 int (*execute)(struct AVCodecContext *c, int (*func)(struct AVCodecContext *c2, void *arg), void *arg2, int *ret, int count, int size);
2436 * The codec may call this to execute several independent things.
2437 * It will return only after finishing all tasks.
2438 * The user may replace this with some multithreaded implementation,
2439 * the default implementation will execute the parts serially.
2440 * Also see avcodec_thread_init and e.g. the --enable-pthread configure option.
2441 * @param c context passed also to func
2442 * @param count the number of things to execute
2443 * @param arg2 argument passed unchanged to func
2444 * @param ret return values of executed functions, must have space for "count" values. May be NULL.
2445 * @param func function that will be called count times, with jobnr from 0 to count-1.
2446 * threadnr will be in the range 0 to c->thread_count-1 < MAX_THREADS and so that no
2447 * two instances of func executing at the same time will have the same threadnr.
2448 * @return always 0 currently, but code should handle a future improvement where when any call to func
2449 * returns < 0 no further calls to func may be done and < 0 is returned.
2450 * - encoding: Set by libavcodec, user can override.
2451 * - decoding: Set by libavcodec, user can override.
2453 int (*execute2)(struct AVCodecContext *c, int (*func)(struct AVCodecContext *c2, void *arg, int jobnr, int threadnr), void *arg2, int *ret, int count);
2456 * noise vs. sse weight for the nsse comparison function
2457 * - encoding: Set by user.
2458 * - decoding: unused
2464 * - encoding: Set by user.
2465 * - decoding: Set by libavcodec.
2468 #define FF_PROFILE_UNKNOWN -99
2469 #define FF_PROFILE_RESERVED -100
2471 #define FF_PROFILE_AAC_MAIN 0
2472 #define FF_PROFILE_AAC_LOW 1
2473 #define FF_PROFILE_AAC_SSR 2
2474 #define FF_PROFILE_AAC_LTP 3
2475 #define FF_PROFILE_AAC_HE 4
2476 #define FF_PROFILE_AAC_HE_V2 28
2477 #define FF_PROFILE_AAC_LD 22
2478 #define FF_PROFILE_AAC_ELD 38
2479 #define FF_PROFILE_MPEG2_AAC_LOW 128
2480 #define FF_PROFILE_MPEG2_AAC_HE 131
2482 #define FF_PROFILE_DTS 20
2483 #define FF_PROFILE_DTS_ES 30
2484 #define FF_PROFILE_DTS_96_24 40
2485 #define FF_PROFILE_DTS_HD_HRA 50
2486 #define FF_PROFILE_DTS_HD_MA 60
2487 #define FF_PROFILE_DTS_EXPRESS 70
2489 #define FF_PROFILE_MPEG2_422 0
2490 #define FF_PROFILE_MPEG2_HIGH 1
2491 #define FF_PROFILE_MPEG2_SS 2
2492 #define FF_PROFILE_MPEG2_SNR_SCALABLE 3
2493 #define FF_PROFILE_MPEG2_MAIN 4
2494 #define FF_PROFILE_MPEG2_SIMPLE 5
2496 #define FF_PROFILE_H264_CONSTRAINED (1<<9) // 8+1; constraint_set1_flag
2497 #define FF_PROFILE_H264_INTRA (1<<11) // 8+3; constraint_set3_flag
2499 #define FF_PROFILE_H264_BASELINE 66
2500 #define FF_PROFILE_H264_CONSTRAINED_BASELINE (66|FF_PROFILE_H264_CONSTRAINED)
2501 #define FF_PROFILE_H264_MAIN 77
2502 #define FF_PROFILE_H264_EXTENDED 88
2503 #define FF_PROFILE_H264_HIGH 100
2504 #define FF_PROFILE_H264_HIGH_10 110
2505 #define FF_PROFILE_H264_HIGH_10_INTRA (110|FF_PROFILE_H264_INTRA)
2506 #define FF_PROFILE_H264_MULTIVIEW_HIGH 118
2507 #define FF_PROFILE_H264_HIGH_422 122
2508 #define FF_PROFILE_H264_HIGH_422_INTRA (122|FF_PROFILE_H264_INTRA)
2509 #define FF_PROFILE_H264_STEREO_HIGH 128
2510 #define FF_PROFILE_H264_HIGH_444 144
2511 #define FF_PROFILE_H264_HIGH_444_PREDICTIVE 244
2512 #define FF_PROFILE_H264_HIGH_444_INTRA (244|FF_PROFILE_H264_INTRA)
2513 #define FF_PROFILE_H264_CAVLC_444 44
2515 #define FF_PROFILE_VC1_SIMPLE 0
2516 #define FF_PROFILE_VC1_MAIN 1
2517 #define FF_PROFILE_VC1_COMPLEX 2
2518 #define FF_PROFILE_VC1_ADVANCED 3
2520 #define FF_PROFILE_MPEG4_SIMPLE 0
2521 #define FF_PROFILE_MPEG4_SIMPLE_SCALABLE 1
2522 #define FF_PROFILE_MPEG4_CORE 2
2523 #define FF_PROFILE_MPEG4_MAIN 3
2524 #define FF_PROFILE_MPEG4_N_BIT 4
2525 #define FF_PROFILE_MPEG4_SCALABLE_TEXTURE 5
2526 #define FF_PROFILE_MPEG4_SIMPLE_FACE_ANIMATION 6
2527 #define FF_PROFILE_MPEG4_BASIC_ANIMATED_TEXTURE 7
2528 #define FF_PROFILE_MPEG4_HYBRID 8
2529 #define FF_PROFILE_MPEG4_ADVANCED_REAL_TIME 9
2530 #define FF_PROFILE_MPEG4_CORE_SCALABLE 10
2531 #define FF_PROFILE_MPEG4_ADVANCED_CODING 11
2532 #define FF_PROFILE_MPEG4_ADVANCED_CORE 12
2533 #define FF_PROFILE_MPEG4_ADVANCED_SCALABLE_TEXTURE 13
2534 #define FF_PROFILE_MPEG4_SIMPLE_STUDIO 14
2535 #define FF_PROFILE_MPEG4_ADVANCED_SIMPLE 15
2537 #define FF_PROFILE_JPEG2000_CSTREAM_RESTRICTION_0 1
2538 #define FF_PROFILE_JPEG2000_CSTREAM_RESTRICTION_1 2
2539 #define FF_PROFILE_JPEG2000_CSTREAM_NO_RESTRICTION 32768
2540 #define FF_PROFILE_JPEG2000_DCINEMA_2K 3
2541 #define FF_PROFILE_JPEG2000_DCINEMA_4K 4
2543 #define FF_PROFILE_VP9_0 0
2544 #define FF_PROFILE_VP9_1 1
2545 #define FF_PROFILE_VP9_2 2
2546 #define FF_PROFILE_VP9_3 3
2548 #define FF_PROFILE_HEVC_MAIN 1
2549 #define FF_PROFILE_HEVC_MAIN_10 2
2550 #define FF_PROFILE_HEVC_MAIN_STILL_PICTURE 3
2551 #define FF_PROFILE_HEVC_REXT 4
2555 * - encoding: Set by user.
2556 * - decoding: Set by libavcodec.
2559 #define FF_LEVEL_UNKNOWN -99
2562 * - encoding: unused
2563 * - decoding: Set by user.
2565 enum AVDiscard skip_loop_filter;
2568 * - encoding: unused
2569 * - decoding: Set by user.
2571 enum AVDiscard skip_idct;
2574 * - encoding: unused
2575 * - decoding: Set by user.
2577 enum AVDiscard skip_frame;
2580 * Header containing style information for text subtitles.
2581 * For SUBTITLE_ASS subtitle type, it should contain the whole ASS
2582 * [Script Info] and [V4+ Styles] section, plus the [Events] line and
2583 * the Format line following. It shouldn't include any Dialogue line.
2584 * - encoding: Set/allocated/freed by user (before avcodec_open2())
2585 * - decoding: Set/allocated/freed by libavcodec (by avcodec_open2())
2587 uint8_t *subtitle_header;
2588 int subtitle_header_size;
2590 #if FF_API_VBV_DELAY
2592 * VBV delay coded in the last frame (in periods of a 27 MHz clock).
2593 * Used for compliant TS muxing.
2594 * - encoding: Set by libavcodec.
2595 * - decoding: unused.
2596 * @deprecated this value is now exported as a part of
2597 * AV_PKT_DATA_CPB_PROPERTIES packet side data
2599 attribute_deprecated
2603 #if FF_API_SIDEDATA_ONLY_PKT
2605 * Encoding only and set by default. Allow encoders to output packets
2606 * that do not contain any encoded data, only side data.
2608 * Some encoders need to output such packets, e.g. to update some stream
2609 * parameters at the end of encoding.
2611 * @deprecated this field disables the default behaviour and
2612 * it is kept only for compatibility.
2614 attribute_deprecated
2615 int side_data_only_packets;
2619 * Audio only. The number of "priming" samples (padding) inserted by the
2620 * encoder at the beginning of the audio. I.e. this number of leading
2621 * decoded samples must be discarded by the caller to get the original audio
2622 * without leading padding.
2624 * - decoding: unused
2625 * - encoding: Set by libavcodec. The timestamps on the output packets are
2626 * adjusted by the encoder so that they always refer to the
2627 * first sample of the data actually contained in the packet,
2628 * including any added padding. E.g. if the timebase is
2629 * 1/samplerate and the timestamp of the first input sample is
2630 * 0, the timestamp of the first output packet will be
2633 int initial_padding;
2636 * - decoding: For codecs that store a framerate value in the compressed
2637 * bitstream, the decoder may export it here. { 0, 1} when
2639 * - encoding: May be used to signal the framerate of CFR content to an
2642 AVRational framerate;
2645 * Nominal unaccelerated pixel format, see AV_PIX_FMT_xxx.
2646 * - encoding: unused.
2647 * - decoding: Set by libavcodec before calling get_format()
2649 enum AVPixelFormat sw_pix_fmt;
2652 * Additional data associated with the entire coded stream.
2654 * - decoding: unused
2655 * - encoding: may be set by libavcodec after avcodec_open2().
2657 AVPacketSideData *coded_side_data;
2658 int nb_coded_side_data;
2661 * A reference to the AVHWFramesContext describing the input (for encoding)
2662 * or output (decoding) frames. The reference is set by the caller and
2663 * afterwards owned (and freed) by libavcodec - it should never be read by
2664 * the caller after being set.
2666 * - decoding: This field should be set by the caller from the get_format()
2667 * callback. The previous reference (if any) will always be
2668 * unreffed by libavcodec before the get_format() call.
2670 * If the default get_buffer2() is used with a hwaccel pixel
2671 * format, then this AVHWFramesContext will be used for
2672 * allocating the frame buffers.
2674 * - encoding: For hardware encoders configured to use a hwaccel pixel
2675 * format, this field should be set by the caller to a reference
2676 * to the AVHWFramesContext describing input frames.
2677 * AVHWFramesContext.format must be equal to
2678 * AVCodecContext.pix_fmt.
2680 * This field should be set before avcodec_open2() is called.
2682 AVBufferRef *hw_frames_ctx;
2685 * Video decoding only. Certain video codecs support cropping, meaning that
2686 * only a sub-rectangle of the decoded frame is intended for display. This
2687 * option controls how cropping is handled by libavcodec.
2689 * When set to 1 (the default), libavcodec will apply cropping internally.
2690 * I.e. it will modify the output frame width/height fields and offset the
2691 * data pointers (only by as much as possible while preserving alignment, or
2692 * by the full amount if the AV_CODEC_FLAG_UNALIGNED flag is set) so that
2693 * the frames output by the decoder refer only to the cropped area. The
2694 * crop_* fields of the output frames will be zero.
2696 * When set to 0, the width/height fields of the output frames will be set
2697 * to the coded dimensions and the crop_* fields will describe the cropping
2698 * rectangle. Applying the cropping is left to the caller.
2700 * @warning When hardware acceleration with opaque output frames is used,
2701 * libavcodec is unable to apply cropping from the top/left border.
2703 * @note when this option is set to zero, the width/height fields of the
2704 * AVCodecContext and output AVFrames have different meanings. The codec
2705 * context fields store display dimensions (with the coded dimensions in
2706 * coded_width/height), while the frame fields store the coded dimensions
2707 * (with the display dimensions being determined by the crop_* fields).
2712 * A reference to the AVHWDeviceContext describing the device which will
2713 * be used by a hardware encoder/decoder. The reference is set by the
2714 * caller and afterwards owned (and freed) by libavcodec.
2716 * This should be used if either the codec device does not require
2717 * hardware frames or any that are used are to be allocated internally by
2718 * libavcodec. If the user wishes to supply any of the frames used as
2719 * encoder input or decoder output then hw_frames_ctx should be used
2720 * instead. When hw_frames_ctx is set in get_format() for a decoder, this
2721 * field will be ignored while decoding the associated stream segment, but
2722 * may again be used on a following one after another get_format() call.
2724 * For both encoders and decoders this field should be set before
2725 * avcodec_open2() is called and must not be written to thereafter.
2727 * Note that some decoders may require this field to be set initially in
2728 * order to support hw_frames_ctx at all - in that case, all frames
2729 * contexts used must be created on the same device.
2731 AVBufferRef *hw_device_ctx;
2734 * Bit set of AV_HWACCEL_FLAG_* flags, which affect hardware accelerated
2735 * decoding (if active).
2736 * - encoding: unused
2737 * - decoding: Set by user (either before avcodec_open2(), or in the
2738 * AVCodecContext.get_format callback)
2746 typedef struct AVProfile {
2748 const char *name; ///< short name for the profile
2751 typedef struct AVCodecDefault AVCodecDefault;
2758 typedef struct AVCodec {
2760 * Name of the codec implementation.
2761 * The name is globally unique among encoders and among decoders (but an
2762 * encoder and a decoder can share the same name).
2763 * This is the primary way to find a codec from the user perspective.
2767 * Descriptive name for the codec, meant to be more human readable than name.
2768 * You should use the NULL_IF_CONFIG_SMALL() macro to define it.
2770 const char *long_name;
2771 enum AVMediaType type;
2774 * Codec capabilities.
2775 * see AV_CODEC_CAP_*
2778 const AVRational *supported_framerates; ///< array of supported framerates, or NULL if any, array is terminated by {0,0}
2779 const enum AVPixelFormat *pix_fmts; ///< array of supported pixel formats, or NULL if unknown, array is terminated by -1
2780 const int *supported_samplerates; ///< array of supported audio samplerates, or NULL if unknown, array is terminated by 0
2781 const enum AVSampleFormat *sample_fmts; ///< array of supported sample formats, or NULL if unknown, array is terminated by -1
2782 const uint64_t *channel_layouts; ///< array of support channel layouts, or NULL if unknown. array is terminated by 0
2783 const AVClass *priv_class; ///< AVClass for the private context
2784 const AVProfile *profiles; ///< array of recognized profiles, or NULL if unknown, array is terminated by {FF_PROFILE_UNKNOWN}
2787 * Group name of the codec implementation.
2788 * This is a short symbolic name of the wrapper backing this codec. A
2789 * wrapper uses some kind of external implementation for the codec, such
2790 * as an external library, or a codec implementation provided by the OS or
2792 * If this field is NULL, this is a builtin, libavcodec native decoder.
2793 * If non-NULL, this will be the suffix in AVCodec.name in most cases
2794 * (usually AVCodec.name will be of the form "<codec_name>_<wrapper_name>").
2796 const char *wrapper_name;
2798 /*****************************************************************
2799 * No fields below this line are part of the public API. They
2800 * may not be used outside of libavcodec and can be changed and
2802 * New public fields should be added right above.
2803 *****************************************************************
2806 struct AVCodec *next;
2808 * @name Frame-level threading support functions
2812 * If defined, called on thread contexts when they are created.
2813 * If the codec allocates writable tables in init(), re-allocate them here.
2814 * priv_data will be set to a copy of the original.
2816 int (*init_thread_copy)(AVCodecContext *);
2818 * Copy necessary context variables from a previous thread context to the current one.
2819 * If not defined, the next thread will start automatically; otherwise, the codec
2820 * must call ff_thread_finish_setup().
2822 * dst and src will (rarely) point to the same context, in which case memcpy should be skipped.
2824 int (*update_thread_context)(AVCodecContext *dst, const AVCodecContext *src);
2828 * Private codec-specific defaults.
2830 const AVCodecDefault *defaults;
2833 * Initialize codec static data, called from avcodec_register().
2835 void (*init_static_data)(struct AVCodec *codec);
2837 int (*init)(AVCodecContext *);
2838 int (*encode_sub)(AVCodecContext *, uint8_t *buf, int buf_size,
2839 const struct AVSubtitle *sub);
2841 * Encode data to an AVPacket.
2843 * @param avctx codec context
2844 * @param avpkt output AVPacket (may contain a user-provided buffer)
2845 * @param[in] frame AVFrame containing the raw data to be encoded
2846 * @param[out] got_packet_ptr encoder sets to 0 or 1 to indicate that a
2847 * non-empty packet was returned in avpkt.
2848 * @return 0 on success, negative error code on failure
2850 int (*encode2)(AVCodecContext *avctx, AVPacket *avpkt, const AVFrame *frame,
2851 int *got_packet_ptr);
2852 int (*decode)(AVCodecContext *, void *outdata, int *outdata_size, AVPacket *avpkt);
2853 int (*close)(AVCodecContext *);
2855 * Encode API with decoupled packet/frame dataflow. The API is the
2856 * same as the avcodec_ prefixed APIs (avcodec_send_frame() etc.), except
2858 * - never called if the codec is closed or the wrong type,
2859 * - if AV_CODEC_CAP_DELAY is not set, drain frames are never sent,
2860 * - only one drain frame is ever passed down,
2862 int (*send_frame)(AVCodecContext *avctx, const AVFrame *frame);
2863 int (*receive_packet)(AVCodecContext *avctx, AVPacket *avpkt);
2866 * Decode API with decoupled packet/frame dataflow. This function is called
2867 * to get one output frame. It should call ff_decode_get_packet() to obtain
2870 int (*receive_frame)(AVCodecContext *avctx, AVFrame *frame);
2873 * Will be called when seeking
2875 void (*flush)(AVCodecContext *);
2877 * Internal codec capabilities.
2878 * See FF_CODEC_CAP_* in internal.h
2883 * Decoding only, a comma-separated list of bitstream filters to apply to
2884 * packets before decoding.
2890 * @defgroup lavc_hwaccel AVHWAccel
2893 typedef struct AVHWAccel {
2895 * Name of the hardware accelerated codec.
2896 * The name is globally unique among encoders and among decoders (but an
2897 * encoder and a decoder can share the same name).
2902 * Type of codec implemented by the hardware accelerator.
2904 * See AVMEDIA_TYPE_xxx
2906 enum AVMediaType type;
2909 * Codec implemented by the hardware accelerator.
2911 * See AV_CODEC_ID_xxx
2916 * Supported pixel format.
2918 * Only hardware accelerated formats are supported here.
2920 enum AVPixelFormat pix_fmt;
2923 * Hardware accelerated codec capabilities.
2924 * see FF_HWACCEL_CODEC_CAP_*
2928 /*****************************************************************
2929 * No fields below this line are part of the public API. They
2930 * may not be used outside of libavcodec and can be changed and
2932 * New public fields should be added right above.
2933 *****************************************************************
2935 struct AVHWAccel *next;
2938 * Allocate a custom buffer
2940 int (*alloc_frame)(AVCodecContext *avctx, AVFrame *frame);
2943 * Called at the beginning of each frame or field picture.
2945 * Meaningful frame information (codec specific) is guaranteed to
2946 * be parsed at this point. This function is mandatory.
2948 * Note that buf can be NULL along with buf_size set to 0.
2949 * Otherwise, this means the whole frame is available at this point.
2951 * @param avctx the codec context
2952 * @param buf the frame data buffer base
2953 * @param buf_size the size of the frame in bytes
2954 * @return zero if successful, a negative value otherwise
2956 int (*start_frame)(AVCodecContext *avctx, const uint8_t *buf, uint32_t buf_size);
2959 * Callback for each slice.
2961 * Meaningful slice information (codec specific) is guaranteed to
2962 * be parsed at this point. This function is mandatory.
2964 * @param avctx the codec context
2965 * @param buf the slice data buffer base
2966 * @param buf_size the size of the slice in bytes
2967 * @return zero if successful, a negative value otherwise
2969 int (*decode_slice)(AVCodecContext *avctx, const uint8_t *buf, uint32_t buf_size);
2972 * Called at the end of each frame or field picture.
2974 * The whole picture is parsed at this point and can now be sent
2975 * to the hardware accelerator. This function is mandatory.
2977 * @param avctx the codec context
2978 * @return zero if successful, a negative value otherwise
2980 int (*end_frame)(AVCodecContext *avctx);
2983 * Size of per-frame hardware accelerator private data.
2985 * Private data is allocated with av_mallocz() before
2986 * AVCodecContext.get_buffer() and deallocated after
2987 * AVCodecContext.release_buffer().
2989 int frame_priv_data_size;
2992 * Initialize the hwaccel private data.
2994 * This will be called from ff_get_format(), after hwaccel and
2995 * hwaccel_context are set and the hwaccel private data in AVCodecInternal
2998 int (*init)(AVCodecContext *avctx);
3001 * Uninitialize the hwaccel private data.
3003 * This will be called from get_format() or avcodec_close(), after hwaccel
3004 * and hwaccel_context are already uninitialized.
3006 int (*uninit)(AVCodecContext *avctx);
3009 * Size of the private data to allocate in
3010 * AVCodecInternal.hwaccel_priv_data.
3015 * Internal hwaccel capabilities.
3020 * Fill the given hw_frames context with current codec parameters. Called
3021 * from get_format. Refer to avcodec_get_hw_frames_parameters() for
3024 * This CAN be called before AVHWAccel.init is called, and you must assume
3025 * that avctx->hwaccel_priv_data is invalid.
3027 int (*frame_params)(AVCodecContext *avctx, AVBufferRef *hw_frames_ctx);
3031 * Hardware acceleration should be used for decoding even if the codec level
3032 * used is unknown or higher than the maximum supported level reported by the
3035 #define AV_HWACCEL_FLAG_IGNORE_LEVEL (1 << 0)
3038 * Hardware acceleration can output YUV pixel formats with a different chroma
3039 * sampling than 4:2:0 and/or other than 8 bits per component.
3041 #define AV_HWACCEL_FLAG_ALLOW_HIGH_DEPTH (1 << 1)
3044 * Hardware acceleration should still be attempted for decoding when the
3045 * codec profile does not match the reported capabilities of the hardware.
3047 * For example, this can be used to try to decode baseline profile H.264
3048 * streams in hardware - it will often succeed, because many streams marked
3049 * as baseline profile actually conform to constrained baseline profile.
3051 * @warning If the stream is actually not supported then the behaviour is
3052 * undefined, and may include returning entirely incorrect output
3053 * while indicating success.
3055 #define AV_HWACCEL_FLAG_ALLOW_PROFILE_MISMATCH (1 << 2)
3061 #if FF_API_AVPICTURE
3063 * @defgroup lavc_picture AVPicture
3065 * Functions for working with AVPicture
3070 * four components are given, that's all.
3071 * the last component is alpha
3072 * @deprecated Use the imgutils functions
3074 typedef struct AVPicture {
3075 attribute_deprecated
3076 uint8_t *data[AV_NUM_DATA_POINTERS];
3077 attribute_deprecated
3078 int linesize[AV_NUM_DATA_POINTERS]; ///< number of bytes per line
3086 #define AVPALETTE_SIZE 1024
3087 #define AVPALETTE_COUNT 256
3089 enum AVSubtitleType {
3092 SUBTITLE_BITMAP, ///< A bitmap, pict will be set
3095 * Plain text, the text field must be set by the decoder and is
3096 * authoritative. ass and pict fields may contain approximations.
3101 * Formatted text, the ass field must be set by the decoder and is
3102 * authoritative. pict and text fields may contain approximations.
3107 #define AV_SUBTITLE_FLAG_FORCED 0x00000001
3109 typedef struct AVSubtitleRect {
3110 int x; ///< top left corner of pict, undefined when pict is not set
3111 int y; ///< top left corner of pict, undefined when pict is not set
3112 int w; ///< width of pict, undefined when pict is not set
3113 int h; ///< height of pict, undefined when pict is not set
3114 int nb_colors; ///< number of colors in pict, undefined when pict is not set
3116 #if FF_API_AVPICTURE
3118 * @deprecated unused
3120 attribute_deprecated
3124 * data+linesize for the bitmap of this subtitle.
3125 * Can be set for text/ass as well once they are rendered.
3130 enum AVSubtitleType type;
3132 char *text; ///< 0 terminated plain UTF-8 text
3135 * 0 terminated ASS/SSA compatible event line.
3136 * The presentation of this is unaffected by the other values in this
3143 typedef struct AVSubtitle {
3144 uint16_t format; /* 0 = graphics */
3145 uint32_t start_display_time; /* relative to packet pts, in ms */
3146 uint32_t end_display_time; /* relative to packet pts, in ms */
3148 AVSubtitleRect **rects;
3149 int64_t pts; ///< Same as packet pts, in AV_TIME_BASE
3153 * This struct describes the properties of an encoded stream.
3155 * sizeof(AVCodecParameters) is not a part of the public ABI, this struct must
3156 * be allocated with avcodec_parameters_alloc() and freed with
3157 * avcodec_parameters_free().
3159 typedef struct AVCodecParameters {
3161 * General type of the encoded data.
3163 enum AVMediaType codec_type;
3165 * Specific type of the encoded data (the codec used).
3167 enum AVCodecID codec_id;
3169 * Additional information about the codec (corresponds to the AVI FOURCC).
3174 * Extra binary data needed for initializing the decoder, codec-dependent.
3176 * Must be allocated with av_malloc() and will be freed by
3177 * avcodec_parameters_free(). The allocated size of extradata must be at
3178 * least extradata_size + AV_INPUT_BUFFER_PADDING_SIZE, with the padding
3183 * Size of the extradata content in bytes.
3188 * - video: the pixel format, the value corresponds to enum AVPixelFormat.
3189 * - audio: the sample format, the value corresponds to enum AVSampleFormat.
3194 * The average bitrate of the encoded data (in bits per second).
3198 int bits_per_coded_sample;
3201 * Codec-specific bitstream restrictions that the stream conforms to.
3207 * Video only. The dimensions of the video frame in pixels.
3213 * Video only. The aspect ratio (width / height) which a single pixel
3214 * should have when displayed.
3216 * When the aspect ratio is unknown / undefined, the numerator should be
3217 * set to 0 (the denominator may have any value).
3219 AVRational sample_aspect_ratio;
3222 * Video only. The order of the fields in interlaced video.
3224 enum AVFieldOrder field_order;
3227 * Video only. Additional colorspace characteristics.
3229 enum AVColorRange color_range;
3230 enum AVColorPrimaries color_primaries;
3231 enum AVColorTransferCharacteristic color_trc;
3232 enum AVColorSpace color_space;
3233 enum AVChromaLocation chroma_location;
3236 * Audio only. The channel layout bitmask. May be 0 if the channel layout is
3237 * unknown or unspecified, otherwise the number of bits set must be equal to
3238 * the channels field.
3240 uint64_t channel_layout;
3242 * Audio only. The number of audio channels.
3246 * Audio only. The number of audio samples per second.
3250 * Audio only. The number of bytes per coded audio frame, required by some
3253 * Corresponds to nBlockAlign in WAVEFORMATEX.
3258 * Audio only. The amount of padding (in samples) inserted by the encoder at
3259 * the beginning of the audio. I.e. this number of leading decoded samples
3260 * must be discarded by the caller to get the original audio without leading
3263 int initial_padding;
3265 * Audio only. The amount of padding (in samples) appended by the encoder to
3266 * the end of the audio. I.e. this number of decoded samples must be
3267 * discarded by the caller from the end of the stream to get the original
3268 * audio without any trailing padding.
3270 int trailing_padding;
3271 } AVCodecParameters;
3274 * If c is NULL, returns the first registered codec,
3275 * if c is non-NULL, returns the next registered codec after c,
3276 * or NULL if c is the last one.
3278 AVCodec *av_codec_next(const AVCodec *c);
3281 * Return the LIBAVCODEC_VERSION_INT constant.
3283 unsigned avcodec_version(void);
3286 * Return the libavcodec build-time configuration.
3288 const char *avcodec_configuration(void);
3291 * Return the libavcodec license.
3293 const char *avcodec_license(void);
3296 * Register the codec codec and initialize libavcodec.
3298 * @warning either this function or avcodec_register_all() must be called
3299 * before any other libavcodec functions.
3301 * @see avcodec_register_all()
3303 void avcodec_register(AVCodec *codec);
3306 * Register all the codecs, parsers and bitstream filters which were enabled at
3307 * configuration time. If you do not call this function you can select exactly
3308 * which formats you want to support, by using the individual registration
3311 * @see avcodec_register
3312 * @see av_register_codec_parser
3313 * @see av_register_bitstream_filter
3315 void avcodec_register_all(void);
3318 * Allocate an AVCodecContext and set its fields to default values. The
3319 * resulting struct should be freed with avcodec_free_context().
3321 * @param codec if non-NULL, allocate private data and initialize defaults
3322 * for the given codec. It is illegal to then call avcodec_open2()
3323 * with a different codec.
3324 * If NULL, then the codec-specific defaults won't be initialized,
3325 * which may result in suboptimal default settings (this is
3326 * important mainly for encoders, e.g. libx264).
3328 * @return An AVCodecContext filled with default values or NULL on failure.
3330 AVCodecContext *avcodec_alloc_context3(const AVCodec *codec);
3333 * Free the codec context and everything associated with it and write NULL to
3334 * the provided pointer.
3336 void avcodec_free_context(AVCodecContext **avctx);
3338 #if FF_API_GET_CONTEXT_DEFAULTS
3340 * @deprecated This function should not be used, as closing and opening a codec
3341 * context multiple time is not supported. A new codec context should be
3342 * allocated for each new use.
3344 int avcodec_get_context_defaults3(AVCodecContext *s, const AVCodec *codec);
3348 * Get the AVClass for AVCodecContext. It can be used in combination with
3349 * AV_OPT_SEARCH_FAKE_OBJ for examining options.
3351 * @see av_opt_find().
3353 const AVClass *avcodec_get_class(void);
3355 #if FF_API_COPY_CONTEXT
3357 * Copy the settings of the source AVCodecContext into the destination
3358 * AVCodecContext. The resulting destination codec context will be
3359 * unopened, i.e. you are required to call avcodec_open2() before you
3360 * can use this AVCodecContext to decode/encode video/audio data.
3362 * @param dest target codec context, should be initialized with
3363 * avcodec_alloc_context3(), but otherwise uninitialized
3364 * @param src source codec context
3365 * @return AVERROR() on error (e.g. memory allocation error), 0 on success
3367 * @deprecated The semantics of this function are ill-defined and it should not
3368 * be used. If you need to transfer the stream parameters from one codec context
3369 * to another, use an intermediate AVCodecParameters instance and the
3370 * avcodec_parameters_from_context() / avcodec_parameters_to_context()
3373 attribute_deprecated
3374 int avcodec_copy_context(AVCodecContext *dest, const AVCodecContext *src);
3378 * Allocate a new AVCodecParameters and set its fields to default values
3379 * (unknown/invalid/0). The returned struct must be freed with
3380 * avcodec_parameters_free().
3382 AVCodecParameters *avcodec_parameters_alloc(void);
3385 * Free an AVCodecParameters instance and everything associated with it and
3386 * write NULL to the supplied pointer.
3388 void avcodec_parameters_free(AVCodecParameters **par);
3391 * Copy the contents of src to dst. Any allocated fields in dst are freed and
3392 * replaced with newly allocated duplicates of the corresponding fields in src.
3394 * @return >= 0 on success, a negative AVERROR code on failure.
3396 int avcodec_parameters_copy(AVCodecParameters *dst, const AVCodecParameters *src);
3399 * Fill the parameters struct based on the values from the supplied codec
3400 * context. Any allocated fields in par are freed and replaced with duplicates
3401 * of the corresponding fields in codec.
3403 * @return >= 0 on success, a negative AVERROR code on failure
3405 int avcodec_parameters_from_context(AVCodecParameters *par,
3406 const AVCodecContext *codec);
3409 * Fill the codec context based on the values from the supplied codec
3410 * parameters. Any allocated fields in codec that have a corresponding field in
3411 * par are freed and replaced with duplicates of the corresponding field in par.
3412 * Fields in codec that do not have a counterpart in par are not touched.
3414 * @return >= 0 on success, a negative AVERROR code on failure.
3416 int avcodec_parameters_to_context(AVCodecContext *codec,
3417 const AVCodecParameters *par);
3420 * Initialize the AVCodecContext to use the given AVCodec. Prior to using this
3421 * function the context has to be allocated with avcodec_alloc_context3().
3423 * The functions avcodec_find_decoder_by_name(), avcodec_find_encoder_by_name(),
3424 * avcodec_find_decoder() and avcodec_find_encoder() provide an easy way for
3425 * retrieving a codec.
3427 * @warning This function is not thread safe!
3429 * @note Always call this function before using decoding routines (such as
3430 * @ref avcodec_receive_frame()).
3433 * avcodec_register_all();
3434 * av_dict_set(&opts, "b", "2.5M", 0);
3435 * codec = avcodec_find_decoder(AV_CODEC_ID_H264);
3439 * context = avcodec_alloc_context3(codec);
3441 * if (avcodec_open2(context, codec, opts) < 0)
3445 * @param avctx The context to initialize.
3446 * @param codec The codec to open this context for. If a non-NULL codec has been
3447 * previously passed to avcodec_alloc_context3() or
3448 * for this context, then this parameter MUST be either NULL or
3449 * equal to the previously passed codec.
3450 * @param options A dictionary filled with AVCodecContext and codec-private options.
3451 * On return this object will be filled with options that were not found.
3453 * @return zero on success, a negative value on error
3454 * @see avcodec_alloc_context3(), avcodec_find_decoder(), avcodec_find_encoder(),
3455 * av_dict_set(), av_opt_find().
3457 int avcodec_open2(AVCodecContext *avctx, const AVCodec *codec, AVDictionary **options);
3460 * Close a given AVCodecContext and free all the data associated with it
3461 * (but not the AVCodecContext itself).
3463 * Calling this function on an AVCodecContext that hasn't been opened will free
3464 * the codec-specific data allocated in avcodec_alloc_context3() with a non-NULL
3465 * codec. Subsequent calls will do nothing.
3467 * @note Do not use this function. Use avcodec_free_context() to destroy a
3468 * codec context (either open or closed). Opening and closing a codec context
3469 * multiple times is not supported anymore -- use multiple codec contexts
3472 int avcodec_close(AVCodecContext *avctx);
3475 * Free all allocated data in the given subtitle struct.
3477 * @param sub AVSubtitle to free.
3479 void avsubtitle_free(AVSubtitle *sub);
3486 * @addtogroup lavc_packet
3491 * Allocate an AVPacket and set its fields to default values. The resulting
3492 * struct must be freed using av_packet_free().
3494 * @return An AVPacket filled with default values or NULL on failure.
3496 * @note this only allocates the AVPacket itself, not the data buffers. Those
3497 * must be allocated through other means such as av_new_packet.
3499 * @see av_new_packet
3501 AVPacket *av_packet_alloc(void);
3504 * Create a new packet that references the same data as src.
3506 * This is a shortcut for av_packet_alloc()+av_packet_ref().
3508 * @return newly created AVPacket on success, NULL on error.
3510 * @see av_packet_alloc
3511 * @see av_packet_ref
3513 AVPacket *av_packet_clone(const AVPacket *src);
3516 * Free the packet, if the packet is reference counted, it will be
3517 * unreferenced first.
3519 * @param pkt packet to be freed. The pointer will be set to NULL.
3520 * @note passing NULL is a no-op.
3522 void av_packet_free(AVPacket **pkt);
3525 * Initialize optional fields of a packet with default values.
3527 * Note, this does not touch the data and size members, which have to be
3528 * initialized separately.
3532 void av_init_packet(AVPacket *pkt);
3535 * Allocate the payload of a packet and initialize its fields with
3539 * @param size wanted payload size
3540 * @return 0 if OK, AVERROR_xxx otherwise
3542 int av_new_packet(AVPacket *pkt, int size);
3545 * Reduce packet size, correctly zeroing padding
3548 * @param size new size
3550 void av_shrink_packet(AVPacket *pkt, int size);
3553 * Increase packet size, correctly zeroing padding
3556 * @param grow_by number of bytes by which to increase the size of the packet
3558 int av_grow_packet(AVPacket *pkt, int grow_by);
3561 * Initialize a reference-counted packet from av_malloc()ed data.
3563 * @param pkt packet to be initialized. This function will set the data, size,
3564 * buf and destruct fields, all others are left untouched.
3565 * @param data Data allocated by av_malloc() to be used as packet data. If this
3566 * function returns successfully, the data is owned by the underlying AVBuffer.
3567 * The caller may not access the data through other means.
3568 * @param size size of data in bytes, without the padding. I.e. the full buffer
3569 * size is assumed to be size + AV_INPUT_BUFFER_PADDING_SIZE.
3571 * @return 0 on success, a negative AVERROR on error
3573 int av_packet_from_data(AVPacket *pkt, uint8_t *data, int size);
3575 #if FF_API_AVPACKET_OLD_API
3577 * @warning This is a hack - the packet memory allocation stuff is broken. The
3578 * packet is allocated if it was not really allocated.
3580 * @deprecated Use av_packet_ref
3582 attribute_deprecated
3583 int av_dup_packet(AVPacket *pkt);
3587 * @deprecated Use av_packet_unref
3589 * @param pkt packet to free
3591 attribute_deprecated
3592 void av_free_packet(AVPacket *pkt);
3595 * Allocate new information of a packet.
3598 * @param type side information type
3599 * @param size side information size
3600 * @return pointer to fresh allocated data or NULL otherwise
3602 uint8_t* av_packet_new_side_data(AVPacket *pkt, enum AVPacketSideDataType type,
3606 * Wrap an existing array as a packet side data.
3609 * @param type side information type
3610 * @param data the side data array. It must be allocated with the av_malloc()
3611 * family of functions. The ownership of the data is transferred to
3613 * @param size side information size
3614 * @return a non-negative number on success, a negative AVERROR code on
3615 * failure. On failure, the packet is unchanged and the data remains
3616 * owned by the caller.
3618 int av_packet_add_side_data(AVPacket *pkt, enum AVPacketSideDataType type,
3619 uint8_t *data, size_t size);
3622 * Shrink the already allocated side data buffer
3625 * @param type side information type
3626 * @param size new side information size
3627 * @return 0 on success, < 0 on failure
3629 int av_packet_shrink_side_data(AVPacket *pkt, enum AVPacketSideDataType type,
3633 * Get side information from packet.
3636 * @param type desired side information type
3637 * @param size pointer for side information size to store (optional)
3638 * @return pointer to data if present or NULL otherwise
3640 uint8_t* av_packet_get_side_data(AVPacket *pkt, enum AVPacketSideDataType type,
3644 * Convenience function to free all the side data stored.
3645 * All the other fields stay untouched.
3649 void av_packet_free_side_data(AVPacket *pkt);
3652 * Setup a new reference to the data described by a given packet
3654 * If src is reference-counted, setup dst as a new reference to the
3655 * buffer in src. Otherwise allocate a new buffer in dst and copy the
3656 * data from src into it.
3658 * All the other fields are copied from src.
3660 * @see av_packet_unref
3662 * @param dst Destination packet
3663 * @param src Source packet
3665 * @return 0 on success, a negative AVERROR on error.
3667 int av_packet_ref(AVPacket *dst, const AVPacket *src);
3672 * Unreference the buffer referenced by the packet and reset the
3673 * remaining packet fields to their default values.
3675 * @param pkt The packet to be unreferenced.
3677 void av_packet_unref(AVPacket *pkt);
3680 * Move every field in src to dst and reset src.
3682 * @see av_packet_unref
3684 * @param src Source packet, will be reset
3685 * @param dst Destination packet
3687 void av_packet_move_ref(AVPacket *dst, AVPacket *src);
3690 * Copy only "properties" fields from src to dst.
3692 * Properties for the purpose of this function are all the fields
3693 * beside those related to the packet data (buf, data, size)
3695 * @param dst Destination packet
3696 * @param src Source packet
3698 * @return 0 on success AVERROR on failure.
3700 int av_packet_copy_props(AVPacket *dst, const AVPacket *src);
3703 * Convert valid timing fields (timestamps / durations) in a packet from one
3704 * timebase to another. Timestamps with unknown values (AV_NOPTS_VALUE) will be
3707 * @param pkt packet on which the conversion will be performed
3708 * @param tb_src source timebase, in which the timing fields in pkt are
3710 * @param tb_dst destination timebase, to which the timing fields will be
3713 void av_packet_rescale_ts(AVPacket *pkt, AVRational tb_src, AVRational tb_dst);
3720 * @addtogroup lavc_decoding
3725 * Find a registered decoder with a matching codec ID.
3727 * @param id AVCodecID of the requested decoder
3728 * @return A decoder if one was found, NULL otherwise.
3730 AVCodec *avcodec_find_decoder(enum AVCodecID id);
3733 * Find a registered decoder with the specified name.
3735 * @param name name of the requested decoder
3736 * @return A decoder if one was found, NULL otherwise.
3738 AVCodec *avcodec_find_decoder_by_name(const char *name);
3741 * The default callback for AVCodecContext.get_buffer2(). It is made public so
3742 * it can be called by custom get_buffer2() implementations for decoders without
3743 * AV_CODEC_CAP_DR1 set.
3745 int avcodec_default_get_buffer2(AVCodecContext *s, AVFrame *frame, int flags);
3748 * Modify width and height values so that they will result in a memory
3749 * buffer that is acceptable for the codec if you do not use any horizontal
3752 * May only be used if a codec with AV_CODEC_CAP_DR1 has been opened.
3754 void avcodec_align_dimensions(AVCodecContext *s, int *width, int *height);
3757 * Modify width and height values so that they will result in a memory
3758 * buffer that is acceptable for the codec if you also ensure that all
3759 * line sizes are a multiple of the respective linesize_align[i].
3761 * May only be used if a codec with AV_CODEC_CAP_DR1 has been opened.
3763 void avcodec_align_dimensions2(AVCodecContext *s, int *width, int *height,
3764 int linesize_align[AV_NUM_DATA_POINTERS]);
3767 * Decode the audio frame of size avpkt->size from avpkt->data into frame.
3769 * Some decoders may support multiple frames in a single AVPacket. Such
3770 * decoders would then just decode the first frame and the return value would be
3771 * less than the packet size. In this case, avcodec_decode_audio4 has to be
3772 * called again with an AVPacket containing the remaining data in order to
3773 * decode the second frame, etc... Even if no frames are returned, the packet
3774 * needs to be fed to the decoder with remaining data until it is completely
3775 * consumed or an error occurs.
3777 * Some decoders (those marked with AV_CODEC_CAP_DELAY) have a delay between input
3778 * and output. This means that for some packets they will not immediately
3779 * produce decoded output and need to be flushed at the end of decoding to get
3780 * all the decoded data. Flushing is done by calling this function with packets
3781 * with avpkt->data set to NULL and avpkt->size set to 0 until it stops
3782 * returning samples. It is safe to flush even those decoders that are not
3783 * marked with AV_CODEC_CAP_DELAY, then no samples will be returned.
3785 * @warning The input buffer, avpkt->data must be AV_INPUT_BUFFER_PADDING_SIZE
3786 * larger than the actual read bytes because some optimized bitstream
3787 * readers read 32 or 64 bits at once and could read over the end.
3789 * @note The AVCodecContext MUST have been opened with @ref avcodec_open2()
3790 * before packets may be fed to the decoder.
3792 * @param avctx the codec context
3793 * @param[out] frame The AVFrame in which to store decoded audio samples.
3794 * The decoder will allocate a buffer for the decoded frame by
3795 * calling the AVCodecContext.get_buffer2() callback.
3796 * When AVCodecContext.refcounted_frames is set to 1, the frame is
3797 * reference counted and the returned reference belongs to the
3798 * caller. The caller must release the frame using av_frame_unref()
3799 * when the frame is no longer needed. The caller may safely write
3800 * to the frame if av_frame_is_writable() returns 1.
3801 * When AVCodecContext.refcounted_frames is set to 0, the returned
3802 * reference belongs to the decoder and is valid only until the
3803 * next call to this function or until closing or flushing the
3804 * decoder. The caller may not write to it.
3805 * @param[out] got_frame_ptr Zero if no frame could be decoded, otherwise it is
3806 * non-zero. Note that this field being set to zero
3807 * does not mean that an error has occurred. For
3808 * decoders with AV_CODEC_CAP_DELAY set, no given decode
3809 * call is guaranteed to produce a frame.
3810 * @param[in] avpkt The input AVPacket containing the input buffer.
3811 * At least avpkt->data and avpkt->size should be set. Some
3812 * decoders might also require additional fields to be set.
3813 * @return A negative error code is returned if an error occurred during
3814 * decoding, otherwise the number of bytes consumed from the input
3815 * AVPacket is returned.
3817 * @deprecated Use avcodec_send_packet() and avcodec_receive_frame().
3819 attribute_deprecated
3820 int avcodec_decode_audio4(AVCodecContext *avctx, AVFrame *frame,
3821 int *got_frame_ptr, AVPacket *avpkt);
3824 * Decode the video frame of size avpkt->size from avpkt->data into picture.
3825 * Some decoders may support multiple frames in a single AVPacket, such
3826 * decoders would then just decode the first frame.
3828 * @warning The input buffer must be AV_INPUT_BUFFER_PADDING_SIZE larger than
3829 * the actual read bytes because some optimized bitstream readers read 32 or 64
3830 * bits at once and could read over the end.
3832 * @warning The end of the input buffer buf should be set to 0 to ensure that
3833 * no overreading happens for damaged MPEG streams.
3835 * @note Codecs which have the AV_CODEC_CAP_DELAY capability set have a delay
3836 * between input and output, these need to be fed with avpkt->data=NULL,
3837 * avpkt->size=0 at the end to return the remaining frames.
3839 * @note The AVCodecContext MUST have been opened with @ref avcodec_open2()
3840 * before packets may be fed to the decoder.
3842 * @param avctx the codec context
3843 * @param[out] picture The AVFrame in which the decoded video frame will be stored.
3844 * Use av_frame_alloc() to get an AVFrame. The codec will
3845 * allocate memory for the actual bitmap by calling the
3846 * AVCodecContext.get_buffer2() callback.
3847 * When AVCodecContext.refcounted_frames is set to 1, the frame is
3848 * reference counted and the returned reference belongs to the
3849 * caller. The caller must release the frame using av_frame_unref()
3850 * when the frame is no longer needed. The caller may safely write
3851 * to the frame if av_frame_is_writable() returns 1.
3852 * When AVCodecContext.refcounted_frames is set to 0, the returned
3853 * reference belongs to the decoder and is valid only until the
3854 * next call to this function or until closing or flushing the
3855 * decoder. The caller may not write to it.
3857 * @param[in] avpkt The input AVPacket containing the input buffer.
3858 * You can create such packet with av_init_packet() and by then setting
3859 * data and size, some decoders might in addition need other fields like
3860 * flags&AV_PKT_FLAG_KEY. All decoders are designed to use the least
3862 * @param[in,out] got_picture_ptr Zero if no frame could be decompressed, otherwise, it is nonzero.
3863 * @return On error a negative value is returned, otherwise the number of bytes
3864 * used or zero if no frame could be decompressed.
3866 * @deprecated Use avcodec_send_packet() and avcodec_receive_frame().
3868 attribute_deprecated
3869 int avcodec_decode_video2(AVCodecContext *avctx, AVFrame *picture,
3870 int *got_picture_ptr,
3874 * Decode a subtitle message.
3875 * Return a negative value on error, otherwise return the number of bytes used.
3876 * If no subtitle could be decompressed, got_sub_ptr is zero.
3877 * Otherwise, the subtitle is stored in *sub.
3878 * Note that AV_CODEC_CAP_DR1 is not available for subtitle codecs. This is for
3879 * simplicity, because the performance difference is expect to be negligible
3880 * and reusing a get_buffer written for video codecs would probably perform badly
3881 * due to a potentially very different allocation pattern.
3883 * @note The AVCodecContext MUST have been opened with @ref avcodec_open2()
3884 * before packets may be fed to the decoder.
3886 * @param avctx the codec context
3887 * @param[out] sub The AVSubtitle in which the decoded subtitle will be stored, must be
3888 freed with avsubtitle_free if *got_sub_ptr is set.
3889 * @param[in,out] got_sub_ptr Zero if no subtitle could be decompressed, otherwise, it is nonzero.
3890 * @param[in] avpkt The input AVPacket containing the input buffer.
3892 int avcodec_decode_subtitle2(AVCodecContext *avctx, AVSubtitle *sub,
3897 * Supply raw packet data as input to a decoder.
3899 * Internally, this call will copy relevant AVCodecContext fields, which can
3900 * influence decoding per-packet, and apply them when the packet is actually
3901 * decoded. (For example AVCodecContext.skip_frame, which might direct the
3902 * decoder to drop the frame contained by the packet sent with this function.)
3904 * @warning The input buffer, avpkt->data must be AV_INPUT_BUFFER_PADDING_SIZE
3905 * larger than the actual read bytes because some optimized bitstream
3906 * readers read 32 or 64 bits at once and could read over the end.
3908 * @warning Do not mix this API with the legacy API (like avcodec_decode_video2())
3909 * on the same AVCodecContext. It will return unexpected results now
3910 * or in future libavcodec versions.
3912 * @note The AVCodecContext MUST have been opened with @ref avcodec_open2()
3913 * before packets may be fed to the decoder.
3915 * @param avctx codec context
3916 * @param[in] avpkt The input AVPacket. Usually, this will be a single video
3917 * frame, or several complete audio frames.
3918 * Ownership of the packet remains with the caller, and the
3919 * decoder will not write to the packet. The decoder may create
3920 * a reference to the packet data (or copy it if the packet is
3921 * not reference-counted).
3922 * Unlike with older APIs, the packet is always fully consumed,
3923 * and if it contains multiple frames (e.g. some audio codecs),
3924 * will require you to call avcodec_receive_frame() multiple
3925 * times afterwards before you can send a new packet.
3926 * It can be NULL (or an AVPacket with data set to NULL and
3927 * size set to 0); in this case, it is considered a flush
3928 * packet, which signals the end of the stream. Sending the
3929 * first flush packet will return success. Subsequent ones are
3930 * unnecessary and will return AVERROR_EOF. If the decoder
3931 * still has frames buffered, it will return them after sending
3934 * @return 0 on success, otherwise negative error code:
3935 * AVERROR(EAGAIN): input is not accepted in the current state - user
3936 * must read output with avcodec_receive_frame() (once
3937 * all output is read, the packet should be resent, and
3938 * the call will not fail with EAGAIN).
3939 * AVERROR_EOF: the decoder has been flushed, and no new packets can
3940 * be sent to it (also returned if more than 1 flush
3942 * AVERROR(EINVAL): codec not opened, it is an encoder, or requires flush
3943 * AVERROR(ENOMEM): failed to add packet to internal queue, or similar
3944 * other errors: legitimate decoding errors
3946 int avcodec_send_packet(AVCodecContext *avctx, const AVPacket *avpkt);
3949 * Return decoded output data from a decoder.
3951 * @param avctx codec context
3952 * @param frame This will be set to a reference-counted video or audio
3953 * frame (depending on the decoder type) allocated by the
3954 * decoder. Note that the function will always call
3955 * av_frame_unref(frame) before doing anything else.
3958 * 0: success, a frame was returned
3959 * AVERROR(EAGAIN): output is not available in this state - user must try
3961 * AVERROR_EOF: the decoder has been fully flushed, and there will be
3962 * no more output frames
3963 * AVERROR(EINVAL): codec not opened, or it is an encoder
3964 * other negative values: legitimate decoding errors
3966 int avcodec_receive_frame(AVCodecContext *avctx, AVFrame *frame);
3969 * Supply a raw video or audio frame to the encoder. Use avcodec_receive_packet()
3970 * to retrieve buffered output packets.
3972 * @param avctx codec context
3973 * @param[in] frame AVFrame containing the raw audio or video frame to be encoded.
3974 * Ownership of the frame remains with the caller, and the
3975 * encoder will not write to the frame. The encoder may create
3976 * a reference to the frame data (or copy it if the frame is
3977 * not reference-counted).
3978 * It can be NULL, in which case it is considered a flush
3979 * packet. This signals the end of the stream. If the encoder
3980 * still has packets buffered, it will return them after this
3981 * call. Once flushing mode has been entered, additional flush
3982 * packets are ignored, and sending frames will return
3986 * If AV_CODEC_CAP_VARIABLE_FRAME_SIZE is set, then each frame
3987 * can have any number of samples.
3988 * If it is not set, frame->nb_samples must be equal to
3989 * avctx->frame_size for all frames except the last.
3990 * The final frame may be smaller than avctx->frame_size.
3991 * @return 0 on success, otherwise negative error code:
3992 * AVERROR(EAGAIN): input is not accepted in the current state - user
3993 * must read output with avcodec_receive_packet() (once
3994 * all output is read, the packet should be resent, and
3995 * the call will not fail with EAGAIN).
3996 * AVERROR_EOF: the encoder has been flushed, and no new frames can
3998 * AVERROR(EINVAL): codec not opened, refcounted_frames not set, it is a
3999 * decoder, or requires flush
4000 * AVERROR(ENOMEM): failed to add packet to internal queue, or similar
4001 * other errors: legitimate decoding errors
4003 int avcodec_send_frame(AVCodecContext *avctx, const AVFrame *frame);
4006 * Read encoded data from the encoder.
4008 * @param avctx codec context
4009 * @param avpkt This will be set to a reference-counted packet allocated by the
4010 * encoder. Note that the function will always call
4011 * av_frame_unref(frame) before doing anything else.
4012 * @return 0 on success, otherwise negative error code:
4013 * AVERROR(EAGAIN): output is not available in the current state - user
4014 * must try to send input
4015 * AVERROR_EOF: the encoder has been fully flushed, and there will be
4016 * no more output packets
4017 * AVERROR(EINVAL): codec not opened, or it is an encoder
4018 * other errors: legitimate decoding errors
4020 int avcodec_receive_packet(AVCodecContext *avctx, AVPacket *avpkt);
4023 * Create and return a AVHWFramesContext with values adequate for hardware
4024 * decoding. This is meant to get called from the get_format callback, and is
4025 * a helper for preparing a AVHWFramesContext for AVCodecContext.hw_frames_ctx.
4026 * This API is for decoding with certain hardware acceleration modes/APIs only.
4028 * The returned AVHWFramesContext is not initialized. The caller must do this
4029 * with av_hwframe_ctx_init().
4031 * Calling this function is not a requirement, but makes it simpler to avoid
4032 * codec or hardware API specific details when manually allocating frames.
4034 * Alternatively to this, an API user can set AVCodecContext.hw_device_ctx,
4035 * which sets up AVCodecContext.hw_frames_ctx fully automatically, and makes
4036 * it unnecessary to call this function or having to care about
4037 * AVHWFramesContext initialization at all.
4039 * There are a number of requirements for calling this function:
4041 * - It must be called from get_format with the same avctx parameter that was
4042 * passed to get_format. Calling it outside of get_format is not allowed, and
4043 * can trigger undefined behavior.
4044 * - The function is not always supported (see description of return values).
4045 * Even if this function returns successfully, hwaccel initialization could
4046 * fail later. (The degree to which implementations check whether the stream
4047 * is actually supported varies. Some do this check only after the user's
4048 * get_format callback returns.)
4049 * - The hw_pix_fmt must be one of the choices suggested by get_format. If the
4050 * user decides to use a AVHWFramesContext prepared with this API function,
4051 * the user must return the same hw_pix_fmt from get_format.
4052 * - The device_ref passed to this function must support the given hw_pix_fmt.
4053 * - After calling this API function, it is the user's responsibility to
4054 * initialize the AVHWFramesContext (returned by the out_frames_ref parameter),
4055 * and to set AVCodecContext.hw_frames_ctx to it. If done, this must be done
4056 * before returning from get_format (this is implied by the normal
4057 * AVCodecContext.hw_frames_ctx API rules).
4058 * - The AVHWFramesContext parameters may change every time time get_format is
4059 * called. Also, AVCodecContext.hw_frames_ctx is reset before get_format. So
4060 * you are inherently required to go through this process again on every
4062 * - It is perfectly possible to call this function without actually using
4063 * the resulting AVHWFramesContext. One use-case might be trying to reuse a
4064 * previously initialized AVHWFramesContext, and calling this API function
4065 * only to test whether the required frame parameters have changed.
4066 * - Fields that use dynamically allocated values of any kind must not be set
4067 * by the user unless setting them is explicitly allowed by the documentation.
4068 * If the user sets AVHWFramesContext.free and AVHWFramesContext.user_opaque,
4069 * the new free callback must call the potentially set previous free callback.
4070 * This API call may set any dynamically allocated fields, including the free
4073 * The function will set at least the following fields on AVHWFramesContext
4074 * (potentially more, depending on hwaccel API):
4076 * - All fields set by av_hwframe_ctx_alloc().
4077 * - Set the format field to hw_pix_fmt.
4078 * - Set the sw_format field to the most suited and most versatile format. (An
4079 * implication is that this will prefer generic formats over opaque formats
4080 * with arbitrary restrictions, if possible.)
4081 * - Set the width/height fields to the coded frame size, rounded up to the
4082 * API-specific minimum alignment.
4083 * - Only _if_ the hwaccel requires a pre-allocated pool: set the initial_pool_size
4084 * field to the number of maximum reference surfaces possible with the codec,
4085 * plus 1 surface for the user to work (meaning the user can safely reference
4086 * at most 1 decoded surface at a time), plus additional buffering introduced
4087 * by frame threading. If the hwaccel does not require pre-allocation, the
4088 * field is left to 0, and the decoder will allocate new surfaces on demand
4090 * - Possibly AVHWFramesContext.hwctx fields, depending on the underlying
4093 * Essentially, out_frames_ref returns the same as av_hwframe_ctx_alloc(), but
4094 * with basic frame parameters set.
4096 * The function is stateless, and does not change the AVCodecContext or the
4097 * device_ref AVHWDeviceContext.
4099 * @param avctx The context which is currently calling get_format, and which
4100 * implicitly contains all state needed for filling the returned
4101 * AVHWFramesContext properly.
4102 * @param device_ref A reference to the AVHWDeviceContext describing the device
4103 * which will be used by the hardware decoder.
4104 * @param hw_pix_fmt The hwaccel format you are going to return from get_format.
4105 * @param out_frames_ref On success, set to a reference to an _uninitialized_
4106 * AVHWFramesContext, created from the given device_ref.
4107 * Fields will be set to values required for decoding.
4108 * Not changed if an error is returned.
4109 * @return zero on success, a negative value on error. The following error codes
4110 * have special semantics:
4111 * AVERROR(ENOENT): the decoder does not support this functionality. Setup
4112 * is always manual, or it is a decoder which does not
4113 * support setting AVCodecContext.hw_frames_ctx at all,
4114 * or it is a software format.
4115 * AVERROR(EINVAL): it is known that hardware decoding is not supported for
4116 * this configuration, or the device_ref is not supported
4117 * for the hwaccel referenced by hw_pix_fmt.
4119 int avcodec_get_hw_frames_parameters(AVCodecContext *avctx,
4120 AVBufferRef *device_ref,
4121 enum AVPixelFormat hw_pix_fmt,
4122 AVBufferRef **out_frames_ref);
4127 * @defgroup lavc_parsing Frame parsing
4131 enum AVPictureStructure {
4132 AV_PICTURE_STRUCTURE_UNKNOWN, //< unknown
4133 AV_PICTURE_STRUCTURE_TOP_FIELD, //< coded as top field
4134 AV_PICTURE_STRUCTURE_BOTTOM_FIELD, //< coded as bottom field
4135 AV_PICTURE_STRUCTURE_FRAME, //< coded as frame
4138 typedef struct AVCodecParserContext {
4140 struct AVCodecParser *parser;
4141 int64_t frame_offset; /* offset of the current frame */
4142 int64_t cur_offset; /* current offset
4143 (incremented by each av_parser_parse()) */
4144 int64_t next_frame_offset; /* offset of the next frame */
4146 int pict_type; /* XXX: Put it back in AVCodecContext. */
4148 * This field is used for proper frame duration computation in lavf.
4149 * It signals, how much longer the frame duration of the current frame
4150 * is compared to normal frame duration.
4152 * frame_duration = (1 + repeat_pict) * time_base
4154 * It is used by codecs like H.264 to display telecined material.
4156 int repeat_pict; /* XXX: Put it back in AVCodecContext. */
4157 int64_t pts; /* pts of the current frame */
4158 int64_t dts; /* dts of the current frame */
4163 int fetch_timestamp;
4165 #define AV_PARSER_PTS_NB 4
4166 int cur_frame_start_index;
4167 int64_t cur_frame_offset[AV_PARSER_PTS_NB];
4168 int64_t cur_frame_pts[AV_PARSER_PTS_NB];
4169 int64_t cur_frame_dts[AV_PARSER_PTS_NB];
4172 #define PARSER_FLAG_COMPLETE_FRAMES 0x0001
4173 #define PARSER_FLAG_ONCE 0x0002
4174 /// Set if the parser has a valid file offset
4175 #define PARSER_FLAG_FETCHED_OFFSET 0x0004
4177 int64_t offset; ///< byte offset from starting packet start
4178 int64_t cur_frame_end[AV_PARSER_PTS_NB];
4181 * Set by parser to 1 for key frames and 0 for non-key frames.
4182 * It is initialized to -1, so if the parser doesn't set this flag,
4183 * old-style fallback using AV_PICTURE_TYPE_I picture type as key frames
4188 #if FF_API_CONVERGENCE_DURATION
4190 * @deprecated unused
4192 attribute_deprecated
4193 int64_t convergence_duration;
4196 // Timestamp generation support:
4198 * Synchronization point for start of timestamp generation.
4200 * Set to >0 for sync point, 0 for no sync point and <0 for undefined
4203 * For example, this corresponds to presence of H.264 buffering period
4209 * Offset of the current timestamp against last timestamp sync point in
4210 * units of AVCodecContext.time_base.
4212 * Set to INT_MIN when dts_sync_point unused. Otherwise, it must
4213 * contain a valid timestamp offset.
4215 * Note that the timestamp of sync point has usually a nonzero
4216 * dts_ref_dts_delta, which refers to the previous sync point. Offset of
4217 * the next frame after timestamp sync point will be usually 1.
4219 * For example, this corresponds to H.264 cpb_removal_delay.
4221 int dts_ref_dts_delta;
4224 * Presentation delay of current frame in units of AVCodecContext.time_base.
4226 * Set to INT_MIN when dts_sync_point unused. Otherwise, it must
4227 * contain valid non-negative timestamp delta (presentation time of a frame
4228 * must not lie in the past).
4230 * This delay represents the difference between decoding and presentation
4231 * time of the frame.
4233 * For example, this corresponds to H.264 dpb_output_delay.
4238 * Position of the packet in file.
4240 * Analogous to cur_frame_pts/dts
4242 int64_t cur_frame_pos[AV_PARSER_PTS_NB];
4245 * Byte position of currently parsed frame in stream.
4250 * Previous frame byte position.
4255 * Duration of the current frame.
4256 * For audio, this is in units of 1 / AVCodecContext.sample_rate.
4257 * For all other types, this is in units of AVCodecContext.time_base.
4261 enum AVFieldOrder field_order;
4264 * Indicate whether a picture is coded as a frame, top field or bottom field.
4266 * For example, H.264 field_pic_flag equal to 0 corresponds to
4267 * AV_PICTURE_STRUCTURE_FRAME. An H.264 picture with field_pic_flag
4268 * equal to 1 and bottom_field_flag equal to 0 corresponds to
4269 * AV_PICTURE_STRUCTURE_TOP_FIELD.
4271 enum AVPictureStructure picture_structure;
4274 * Picture number incremented in presentation or output order.
4275 * This field may be reinitialized at the first picture of a new sequence.
4277 * For example, this corresponds to H.264 PicOrderCnt.
4279 int output_picture_number;
4282 * Dimensions of the decoded video intended for presentation.
4288 * Dimensions of the coded video.
4294 * The format of the coded data, corresponds to enum AVPixelFormat for video
4295 * and for enum AVSampleFormat for audio.
4297 * Note that a decoder can have considerable freedom in how exactly it
4298 * decodes the data, so the format reported here might be different from the
4299 * one returned by a decoder.
4302 } AVCodecParserContext;
4304 typedef struct AVCodecParser {
4305 int codec_ids[5]; /* several codec IDs are permitted */
4307 int (*parser_init)(AVCodecParserContext *s);
4308 /* This callback never returns an error, a negative value means that
4309 * the frame start was in a previous packet. */
4310 int (*parser_parse)(AVCodecParserContext *s,
4311 AVCodecContext *avctx,
4312 const uint8_t **poutbuf, int *poutbuf_size,
4313 const uint8_t *buf, int buf_size);
4314 void (*parser_close)(AVCodecParserContext *s);
4315 int (*split)(AVCodecContext *avctx, const uint8_t *buf, int buf_size);
4316 struct AVCodecParser *next;
4319 AVCodecParser *av_parser_next(const AVCodecParser *c);
4321 void av_register_codec_parser(AVCodecParser *parser);
4322 AVCodecParserContext *av_parser_init(int codec_id);
4327 * @param s parser context.
4328 * @param avctx codec context.
4329 * @param poutbuf set to pointer to parsed buffer or NULL if not yet finished.
4330 * @param poutbuf_size set to size of parsed buffer or zero if not yet finished.
4331 * @param buf input buffer.
4332 * @param buf_size input length, to signal EOF, this should be 0 (so that the last frame can be output).
4333 * @param pts input presentation timestamp.
4334 * @param dts input decoding timestamp.
4335 * @param pos input byte position in stream.
4336 * @return the number of bytes of the input bitstream used.
4341 * len = av_parser_parse2(myparser, AVCodecContext, &data, &size,
4348 * decode_frame(data, size);
4352 int av_parser_parse2(AVCodecParserContext *s,
4353 AVCodecContext *avctx,
4354 uint8_t **poutbuf, int *poutbuf_size,
4355 const uint8_t *buf, int buf_size,
4356 int64_t pts, int64_t dts,
4360 * @return 0 if the output buffer is a subset of the input, 1 if it is allocated and must be freed
4361 * @deprecated use AVBitstreamFilter
4363 int av_parser_change(AVCodecParserContext *s,
4364 AVCodecContext *avctx,
4365 uint8_t **poutbuf, int *poutbuf_size,
4366 const uint8_t *buf, int buf_size, int keyframe);
4367 void av_parser_close(AVCodecParserContext *s);
4375 * @addtogroup lavc_encoding
4380 * Find a registered encoder with a matching codec ID.
4382 * @param id AVCodecID of the requested encoder
4383 * @return An encoder if one was found, NULL otherwise.
4385 AVCodec *avcodec_find_encoder(enum AVCodecID id);
4388 * Find a registered encoder with the specified name.
4390 * @param name name of the requested encoder
4391 * @return An encoder if one was found, NULL otherwise.
4393 AVCodec *avcodec_find_encoder_by_name(const char *name);
4396 * Encode a frame of audio.
4398 * Takes input samples from frame and writes the next output packet, if
4399 * available, to avpkt. The output packet does not necessarily contain data for
4400 * the most recent frame, as encoders can delay, split, and combine input frames
4401 * internally as needed.
4403 * @param avctx codec context
4404 * @param avpkt output AVPacket.
4405 * The user can supply an output buffer by setting
4406 * avpkt->data and avpkt->size prior to calling the
4407 * function, but if the size of the user-provided data is not
4408 * large enough, encoding will fail. All other AVPacket fields
4409 * will be reset by the encoder using av_init_packet(). If
4410 * avpkt->data is NULL, the encoder will allocate it.
4411 * The encoder will set avpkt->size to the size of the
4414 * If this function fails or produces no output, avpkt will be
4415 * freed using av_packet_unref().
4416 * @param[in] frame AVFrame containing the raw audio data to be encoded.
4417 * May be NULL when flushing an encoder that has the
4418 * AV_CODEC_CAP_DELAY capability set.
4419 * If AV_CODEC_CAP_VARIABLE_FRAME_SIZE is set, then each frame
4420 * can have any number of samples.
4421 * If it is not set, frame->nb_samples must be equal to
4422 * avctx->frame_size for all frames except the last.
4423 * The final frame may be smaller than avctx->frame_size.
4424 * @param[out] got_packet_ptr This field is set to 1 by libavcodec if the
4425 * output packet is non-empty, and to 0 if it is
4426 * empty. If the function returns an error, the
4427 * packet can be assumed to be invalid, and the
4428 * value of got_packet_ptr is undefined and should
4430 * @return 0 on success, negative error code on failure
4432 * @deprecated use avcodec_send_frame()/avcodec_receive_packet() instead
4434 attribute_deprecated
4435 int avcodec_encode_audio2(AVCodecContext *avctx, AVPacket *avpkt,
4436 const AVFrame *frame, int *got_packet_ptr);
4439 * Encode a frame of video.
4441 * Takes input raw video data from frame and writes the next output packet, if
4442 * available, to avpkt. The output packet does not necessarily contain data for
4443 * the most recent frame, as encoders can delay and reorder input frames
4444 * internally as needed.
4446 * @param avctx codec context
4447 * @param avpkt output AVPacket.
4448 * The user can supply an output buffer by setting
4449 * avpkt->data and avpkt->size prior to calling the
4450 * function, but if the size of the user-provided data is not
4451 * large enough, encoding will fail. All other AVPacket fields
4452 * will be reset by the encoder using av_init_packet(). If
4453 * avpkt->data is NULL, the encoder will allocate it.
4454 * The encoder will set avpkt->size to the size of the
4455 * output packet. The returned data (if any) belongs to the
4456 * caller, he is responsible for freeing it.
4458 * If this function fails or produces no output, avpkt will be
4459 * freed using av_packet_unref().
4460 * @param[in] frame AVFrame containing the raw video data to be encoded.
4461 * May be NULL when flushing an encoder that has the
4462 * AV_CODEC_CAP_DELAY capability set.
4463 * @param[out] got_packet_ptr This field is set to 1 by libavcodec if the
4464 * output packet is non-empty, and to 0 if it is
4465 * empty. If the function returns an error, the
4466 * packet can be assumed to be invalid, and the
4467 * value of got_packet_ptr is undefined and should
4469 * @return 0 on success, negative error code on failure
4471 * @deprecated use avcodec_send_frame()/avcodec_receive_packet() instead
4473 attribute_deprecated
4474 int avcodec_encode_video2(AVCodecContext *avctx, AVPacket *avpkt,
4475 const AVFrame *frame, int *got_packet_ptr);
4477 int avcodec_encode_subtitle(AVCodecContext *avctx, uint8_t *buf, int buf_size,
4478 const AVSubtitle *sub);
4485 #if FF_API_AVPICTURE
4487 * @addtogroup lavc_picture
4492 * @deprecated unused
4494 attribute_deprecated
4495 int avpicture_alloc(AVPicture *picture, enum AVPixelFormat pix_fmt, int width, int height);
4498 * @deprecated unused
4500 attribute_deprecated
4501 void avpicture_free(AVPicture *picture);
4504 * @deprecated use av_image_fill_arrays() instead.
4506 attribute_deprecated
4507 int avpicture_fill(AVPicture *picture, uint8_t *ptr,
4508 enum AVPixelFormat pix_fmt, int width, int height);
4511 * @deprecated use av_image_copy_to_buffer() instead.
4513 attribute_deprecated
4514 int avpicture_layout(const AVPicture* src, enum AVPixelFormat pix_fmt,
4515 int width, int height,
4516 unsigned char *dest, int dest_size);
4519 * @deprecated use av_image_get_buffer_size() instead.
4521 attribute_deprecated
4522 int avpicture_get_size(enum AVPixelFormat pix_fmt, int width, int height);
4525 * @deprecated av_image_copy() instead.
4527 attribute_deprecated
4528 void av_picture_copy(AVPicture *dst, const AVPicture *src,
4529 enum AVPixelFormat pix_fmt, int width, int height);
4532 * @deprecated unused
4534 attribute_deprecated
4535 int av_picture_crop(AVPicture *dst, const AVPicture *src,
4536 enum AVPixelFormat pix_fmt, int top_band, int left_band);
4539 * @deprecated unused
4541 attribute_deprecated
4542 int av_picture_pad(AVPicture *dst, const AVPicture *src, int height, int width, enum AVPixelFormat pix_fmt,
4543 int padtop, int padbottom, int padleft, int padright, int *color);
4551 * @defgroup lavc_misc Utility functions
4554 * Miscellaneous utility functions related to both encoding and decoding
4560 * @defgroup lavc_misc_pixfmt Pixel formats
4562 * Functions for working with pixel formats.
4567 * Return a value representing the fourCC code associated to the
4568 * pixel format pix_fmt, or 0 if no associated fourCC code can be
4571 unsigned int avcodec_pix_fmt_to_codec_tag(enum AVPixelFormat pix_fmt);
4573 #define FF_LOSS_RESOLUTION 0x0001 /**< loss due to resolution change */
4574 #define FF_LOSS_DEPTH 0x0002 /**< loss due to color depth change */
4575 #define FF_LOSS_COLORSPACE 0x0004 /**< loss due to color space conversion */
4576 #define FF_LOSS_ALPHA 0x0008 /**< loss of alpha bits */
4577 #define FF_LOSS_COLORQUANT 0x0010 /**< loss due to color quantization */
4578 #define FF_LOSS_CHROMA 0x0020 /**< loss of chroma (e.g. RGB to gray conversion) */
4581 * Compute what kind of losses will occur when converting from one specific
4582 * pixel format to another.
4583 * When converting from one pixel format to another, information loss may occur.
4584 * For example, when converting from RGB24 to GRAY, the color information will
4585 * be lost. Similarly, other losses occur when converting from some formats to
4586 * other formats. These losses can involve loss of chroma, but also loss of
4587 * resolution, loss of color depth, loss due to the color space conversion, loss
4588 * of the alpha bits or loss due to color quantization.
4589 * avcodec_get_fix_fmt_loss() informs you about the various types of losses
4590 * which will occur when converting from one pixel format to another.
4592 * @param[in] dst_pix_fmt destination pixel format
4593 * @param[in] src_pix_fmt source pixel format
4594 * @param[in] has_alpha Whether the source pixel format alpha channel is used.
4595 * @return Combination of flags informing you what kind of losses will occur.
4597 int avcodec_get_pix_fmt_loss(enum AVPixelFormat dst_pix_fmt, enum AVPixelFormat src_pix_fmt,
4601 * Find the best pixel format to convert to given a certain source pixel
4602 * format. When converting from one pixel format to another, information loss
4603 * may occur. For example, when converting from RGB24 to GRAY, the color
4604 * information will be lost. Similarly, other losses occur when converting from
4605 * some formats to other formats. avcodec_find_best_pix_fmt2() searches which of
4606 * the given pixel formats should be used to suffer the least amount of loss.
4607 * The pixel formats from which it chooses one, are determined by the
4608 * pix_fmt_list parameter.
4611 * @param[in] pix_fmt_list AV_PIX_FMT_NONE terminated array of pixel formats to choose from
4612 * @param[in] src_pix_fmt source pixel format
4613 * @param[in] has_alpha Whether the source pixel format alpha channel is used.
4614 * @param[out] loss_ptr Combination of flags informing you what kind of losses will occur.
4615 * @return The best pixel format to convert to or -1 if none was found.
4617 enum AVPixelFormat avcodec_find_best_pix_fmt2(enum AVPixelFormat *pix_fmt_list,
4618 enum AVPixelFormat src_pix_fmt,
4619 int has_alpha, int *loss_ptr);
4621 enum AVPixelFormat avcodec_default_get_format(struct AVCodecContext *s, const enum AVPixelFormat * fmt);
4628 * Put a string representing the codec tag codec_tag in buf.
4630 * @param buf buffer to place codec tag in
4631 * @param buf_size size in bytes of buf
4632 * @param codec_tag codec tag to assign
4633 * @return the length of the string that would have been generated if
4634 * enough space had been available, excluding the trailing null
4636 size_t av_get_codec_tag_string(char *buf, size_t buf_size, unsigned int codec_tag);
4638 void avcodec_string(char *buf, int buf_size, AVCodecContext *enc, int encode);
4641 * Return a name for the specified profile, if available.
4643 * @param codec the codec that is searched for the given profile
4644 * @param profile the profile value for which a name is requested
4645 * @return A name for the profile if found, NULL otherwise.
4647 const char *av_get_profile_name(const AVCodec *codec, int profile);
4650 * Return a name for the specified profile, if available.
4652 * @param codec_id the ID of the codec to which the requested profile belongs
4653 * @param profile the profile value for which a name is requested
4654 * @return A name for the profile if found, NULL otherwise.
4656 * @note unlike av_get_profile_name(), which searches a list of profiles
4657 * supported by a specific decoder or encoder implementation, this
4658 * function searches the list of profiles from the AVCodecDescriptor
4660 const char *avcodec_profile_name(enum AVCodecID codec_id, int profile);
4662 int avcodec_default_execute(AVCodecContext *c, int (*func)(AVCodecContext *c2, void *arg2),void *arg, int *ret, int count, int size);
4663 int avcodec_default_execute2(AVCodecContext *c, int (*func)(AVCodecContext *c2, void *arg2, int, int),void *arg, int *ret, int count);
4664 //FIXME func typedef
4667 * Fill audio frame data and linesize.
4668 * AVFrame extended_data channel pointers are allocated if necessary for
4671 * @param frame the AVFrame
4672 * frame->nb_samples must be set prior to calling the
4673 * function. This function fills in frame->data,
4674 * frame->extended_data, frame->linesize[0].
4675 * @param nb_channels channel count
4676 * @param sample_fmt sample format
4677 * @param buf buffer to use for frame data
4678 * @param buf_size size of buffer
4679 * @param align plane size sample alignment (0 = default)
4680 * @return 0 on success, negative error code on failure
4682 int avcodec_fill_audio_frame(AVFrame *frame, int nb_channels,
4683 enum AVSampleFormat sample_fmt, const uint8_t *buf,
4684 int buf_size, int align);
4687 * Reset the internal decoder state / flush internal buffers. Should be called
4688 * e.g. when seeking or when switching to a different stream.
4690 * @note when refcounted frames are not used (i.e. avctx->refcounted_frames is 0),
4691 * this invalidates the frames previously returned from the decoder. When
4692 * refcounted frames are used, the decoder just releases any references it might
4693 * keep internally, but the caller's reference remains valid.
4695 void avcodec_flush_buffers(AVCodecContext *avctx);
4698 * Return codec bits per sample.
4700 * @param[in] codec_id the codec
4701 * @return Number of bits per sample or zero if unknown for the given codec.
4703 int av_get_bits_per_sample(enum AVCodecID codec_id);
4706 * Return codec bits per sample.
4707 * Only return non-zero if the bits per sample is exactly correct, not an
4710 * @param[in] codec_id the codec
4711 * @return Number of bits per sample or zero if unknown for the given codec.
4713 int av_get_exact_bits_per_sample(enum AVCodecID codec_id);
4716 * Return audio frame duration.
4718 * @param avctx codec context
4719 * @param frame_bytes size of the frame, or 0 if unknown
4720 * @return frame duration, in samples, if known. 0 if not able to
4723 int av_get_audio_frame_duration(AVCodecContext *avctx, int frame_bytes);
4726 * This function is the same as av_get_audio_frame_duration(), except it works
4727 * with AVCodecParameters instead of an AVCodecContext.
4729 int av_get_audio_frame_duration2(AVCodecParameters *par, int frame_bytes);
4732 typedef struct AVBitStreamFilterContext {
4734 struct AVBitStreamFilter *filter;
4735 AVCodecParserContext *parser;
4736 struct AVBitStreamFilterContext *next;
4737 } AVBitStreamFilterContext;
4740 typedef struct AVBSFInternal AVBSFInternal;
4743 * The bitstream filter state.
4745 * This struct must be allocated with av_bsf_alloc() and freed with
4748 * The fields in the struct will only be changed (by the caller or by the
4749 * filter) as described in their documentation, and are to be considered
4750 * immutable otherwise.
4752 typedef struct AVBSFContext {
4754 * A class for logging and AVOptions
4756 const AVClass *av_class;
4759 * The bitstream filter this context is an instance of.
4761 const struct AVBitStreamFilter *filter;
4764 * Opaque libavcodec internal data. Must not be touched by the caller in any
4767 AVBSFInternal *internal;
4770 * Opaque filter-specific private data. If filter->priv_class is non-NULL,
4771 * this is an AVOptions-enabled struct.
4776 * Parameters of the input stream. This field is allocated in
4777 * av_bsf_alloc(), it needs to be filled by the caller before
4780 AVCodecParameters *par_in;
4783 * Parameters of the output stream. This field is allocated in
4784 * av_bsf_alloc(), it is set by the filter in av_bsf_init().
4786 AVCodecParameters *par_out;
4789 * The timebase used for the timestamps of the input packets. Set by the
4790 * caller before av_bsf_init().
4792 AVRational time_base_in;
4795 * The timebase used for the timestamps of the output packets. Set by the
4796 * filter in av_bsf_init().
4798 AVRational time_base_out;
4801 typedef struct AVBitStreamFilter {
4805 * A list of codec ids supported by the filter, terminated by
4807 * May be NULL, in that case the bitstream filter works with any codec id.
4809 const enum AVCodecID *codec_ids;
4812 * A class for the private data, used to declare bitstream filter private
4813 * AVOptions. This field is NULL for bitstream filters that do not declare
4816 * If this field is non-NULL, the first member of the filter private data
4817 * must be a pointer to AVClass, which will be set by libavcodec generic
4818 * code to this class.
4820 const AVClass *priv_class;
4822 /*****************************************************************
4823 * No fields below this line are part of the public API. They
4824 * may not be used outside of libavcodec and can be changed and
4826 * New public fields should be added right above.
4827 *****************************************************************
4831 int (*init)(AVBSFContext *ctx);
4832 int (*filter)(AVBSFContext *ctx, AVPacket *pkt);
4833 void (*close)(AVBSFContext *ctx);
4834 } AVBitStreamFilter;
4838 * @deprecated the old bitstream filtering API (using AVBitStreamFilterContext)
4839 * is deprecated. Use the new bitstream filtering API (using AVBSFContext).
4841 attribute_deprecated
4842 void av_register_bitstream_filter(AVBitStreamFilter *bsf);
4843 attribute_deprecated
4844 AVBitStreamFilterContext *av_bitstream_filter_init(const char *name);
4845 attribute_deprecated
4846 int av_bitstream_filter_filter(AVBitStreamFilterContext *bsfc,
4847 AVCodecContext *avctx, const char *args,
4848 uint8_t **poutbuf, int *poutbuf_size,
4849 const uint8_t *buf, int buf_size, int keyframe);
4850 attribute_deprecated
4851 void av_bitstream_filter_close(AVBitStreamFilterContext *bsf);
4852 attribute_deprecated
4853 AVBitStreamFilter *av_bitstream_filter_next(const AVBitStreamFilter *f);
4857 * @return a bitstream filter with the specified name or NULL if no such
4858 * bitstream filter exists.
4860 const AVBitStreamFilter *av_bsf_get_by_name(const char *name);
4863 * Iterate over all registered bitstream filters.
4865 * @param opaque a pointer where libavcodec will store the iteration state. Must
4866 * point to NULL to start the iteration.
4868 * @return the next registered bitstream filter or NULL when the iteration is
4871 const AVBitStreamFilter *av_bsf_next(void **opaque);
4874 * Allocate a context for a given bitstream filter. The caller must fill in the
4875 * context parameters as described in the documentation and then call
4876 * av_bsf_init() before sending any data to the filter.
4878 * @param filter the filter for which to allocate an instance.
4879 * @param ctx a pointer into which the pointer to the newly-allocated context
4880 * will be written. It must be freed with av_bsf_free() after the
4881 * filtering is done.
4883 * @return 0 on success, a negative AVERROR code on failure
4885 int av_bsf_alloc(const AVBitStreamFilter *filter, AVBSFContext **ctx);
4888 * Prepare the filter for use, after all the parameters and options have been
4891 int av_bsf_init(AVBSFContext *ctx);
4894 * Submit a packet for filtering.
4896 * After sending each packet, the filter must be completely drained by calling
4897 * av_bsf_receive_packet() repeatedly until it returns AVERROR(EAGAIN) or
4900 * @param pkt the packet to filter. The bitstream filter will take ownership of
4901 * the packet and reset the contents of pkt. pkt is not touched if an error occurs.
4902 * This parameter may be NULL, which signals the end of the stream (i.e. no more
4903 * packets will be sent). That will cause the filter to output any packets it
4904 * may have buffered internally.
4906 * @return 0 on success, a negative AVERROR on error.
4908 int av_bsf_send_packet(AVBSFContext *ctx, AVPacket *pkt);
4911 * Retrieve a filtered packet.
4913 * @param[out] pkt this struct will be filled with the contents of the filtered
4914 * packet. It is owned by the caller and must be freed using
4915 * av_packet_unref() when it is no longer needed.
4916 * This parameter should be "clean" (i.e. freshly allocated
4917 * with av_packet_alloc() or unreffed with av_packet_unref())
4918 * when this function is called. If this function returns
4919 * successfully, the contents of pkt will be completely
4920 * overwritten by the returned data. On failure, pkt is not
4923 * @return 0 on success. AVERROR(EAGAIN) if more packets need to be sent to the
4924 * filter (using av_bsf_send_packet()) to get more output. AVERROR_EOF if there
4925 * will be no further output from the filter. Another negative AVERROR value if
4928 * @note one input packet may result in several output packets, so after sending
4929 * a packet with av_bsf_send_packet(), this function needs to be called
4930 * repeatedly until it stops returning 0. It is also possible for a filter to
4931 * output fewer packets than were sent to it, so this function may return
4932 * AVERROR(EAGAIN) immediately after a successful av_bsf_send_packet() call.
4934 int av_bsf_receive_packet(AVBSFContext *ctx, AVPacket *pkt);
4937 * Free a bitstream filter context and everything associated with it; write NULL
4938 * into the supplied pointer.
4940 void av_bsf_free(AVBSFContext **ctx);
4943 * Get the AVClass for AVBSFContext. It can be used in combination with
4944 * AV_OPT_SEARCH_FAKE_OBJ for examining options.
4946 * @see av_opt_find().
4948 const AVClass *av_bsf_get_class(void);
4953 * Allocate a buffer with padding, reusing the given one if large enough.
4955 * Same behaviour av_fast_malloc but the buffer has additional
4956 * AV_INPUT_PADDING_SIZE at the end which will always memset to 0.
4958 void av_fast_padded_malloc(void *ptr, unsigned int *size, size_t min_size);
4961 * Encode extradata length to a buffer. Used by xiph codecs.
4963 * @param s buffer to write to; must be at least (v/255+1) bytes long
4964 * @param v size of extradata in bytes
4965 * @return number of bytes written to the buffer.
4967 unsigned int av_xiphlacing(unsigned char *s, unsigned int v);
4970 * Register the hardware accelerator hwaccel.
4972 void av_register_hwaccel(AVHWAccel *hwaccel);
4975 * If hwaccel is NULL, returns the first registered hardware accelerator,
4976 * if hwaccel is non-NULL, returns the next registered hardware accelerator
4977 * after hwaccel, or NULL if hwaccel is the last one.
4979 AVHWAccel *av_hwaccel_next(const AVHWAccel *hwaccel);
4983 * Lock operation used by lockmgr
4986 AV_LOCK_CREATE, ///< Create a mutex
4987 AV_LOCK_OBTAIN, ///< Lock the mutex
4988 AV_LOCK_RELEASE, ///< Unlock the mutex
4989 AV_LOCK_DESTROY, ///< Free mutex resources
4993 * Register a user provided lock manager supporting the operations
4994 * specified by AVLockOp. The "mutex" argument to the function points
4995 * to a (void *) where the lockmgr should store/get a pointer to a user
4996 * allocated mutex. It is NULL upon AV_LOCK_CREATE and equal to the
4997 * value left by the last call for all other ops. If the lock manager is
4998 * unable to perform the op then it should leave the mutex in the same
4999 * state as when it was called and return a non-zero value. However,
5000 * when called with AV_LOCK_DESTROY the mutex will always be assumed to
5001 * have been successfully destroyed. If av_lockmgr_register succeeds
5002 * it will return a non-negative value, if it fails it will return a
5003 * negative value and destroy all mutex and unregister all callbacks.
5004 * av_lockmgr_register is not thread-safe, it must be called from a
5005 * single thread before any calls which make use of locking are used.
5007 * @param cb User defined callback. av_lockmgr_register invokes calls
5008 * to this callback and the previously registered callback.
5009 * The callback will be used to create more than one mutex
5010 * each of which must be backed by its own underlying locking
5011 * mechanism (i.e. do not use a single static object to
5012 * implement your lock manager). If cb is set to NULL the
5013 * lockmgr will be unregistered.
5015 int av_lockmgr_register(int (*cb)(void **mutex, enum AVLockOp op));
5018 * Get the type of the given codec.
5020 enum AVMediaType avcodec_get_type(enum AVCodecID codec_id);
5023 * @return a positive value if s is open (i.e. avcodec_open2() was called on it
5024 * with no corresponding avcodec_close()), 0 otherwise.
5026 int avcodec_is_open(AVCodecContext *s);
5029 * @return a non-zero number if codec is an encoder, zero otherwise
5031 int av_codec_is_encoder(const AVCodec *codec);
5034 * @return a non-zero number if codec is a decoder, zero otherwise
5036 int av_codec_is_decoder(const AVCodec *codec);
5039 * @return descriptor for given codec ID or NULL if no descriptor exists.
5041 const AVCodecDescriptor *avcodec_descriptor_get(enum AVCodecID id);
5044 * Iterate over all codec descriptors known to libavcodec.
5046 * @param prev previous descriptor. NULL to get the first descriptor.
5048 * @return next descriptor or NULL after the last descriptor
5050 const AVCodecDescriptor *avcodec_descriptor_next(const AVCodecDescriptor *prev);
5053 * @return codec descriptor with the given name or NULL if no such descriptor
5056 const AVCodecDescriptor *avcodec_descriptor_get_by_name(const char *name);
5059 * Allocate a CPB properties structure and initialize its fields to default
5062 * @param size if non-NULL, the size of the allocated struct will be written
5063 * here. This is useful for embedding it in side data.
5065 * @return the newly allocated struct or NULL on failure
5067 AVCPBProperties *av_cpb_properties_alloc(size_t *size);
5073 #endif /* AVCODEC_AVCODEC_H */