2 * copyright (c) 2001 Fabrice Bellard
4 * This file is part of FFmpeg.
6 * FFmpeg is free software; you can redistribute it and/or
7 * modify it under the terms of the GNU Lesser General Public
8 * License as published by the Free Software Foundation; either
9 * version 2.1 of the License, or (at your option) any later version.
11 * FFmpeg is distributed in the hope that it will be useful,
12 * but WITHOUT ANY WARRANTY; without even the implied warranty of
13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
14 * Lesser General Public License for more details.
16 * You should have received a copy of the GNU Lesser General Public
17 * License along with FFmpeg; if not, write to the Free Software
18 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
21 #ifndef AVCODEC_AVCODEC_H
22 #define AVCODEC_AVCODEC_H
27 * Libavcodec external API header
31 #include "libavutil/samplefmt.h"
32 #include "libavutil/attributes.h"
33 #include "libavutil/avutil.h"
34 #include "libavutil/buffer.h"
35 #include "libavutil/cpu.h"
36 #include "libavutil/channel_layout.h"
37 #include "libavutil/dict.h"
38 #include "libavutil/frame.h"
39 #include "libavutil/hwcontext.h"
40 #include "libavutil/log.h"
41 #include "libavutil/pixfmt.h"
42 #include "libavutil/rational.h"
49 * @defgroup libavc libavcodec
50 * Encoding/Decoding Library
54 * @defgroup lavc_decoding Decoding
58 * @defgroup lavc_encoding Encoding
62 * @defgroup lavc_codec Codecs
64 * @defgroup lavc_codec_native Native Codecs
67 * @defgroup lavc_codec_wrappers External library wrappers
70 * @defgroup lavc_codec_hwaccel Hardware Accelerators bridge
74 * @defgroup lavc_internal Internal
82 * @defgroup lavc_encdec send/receive encoding and decoding API overview
85 * The avcodec_send_packet()/avcodec_receive_frame()/avcodec_send_frame()/
86 * avcodec_receive_packet() functions provide an encode/decode API, which
87 * decouples input and output.
89 * The API is very similar for encoding/decoding and audio/video, and works as
91 * - Set up and open the AVCodecContext as usual.
93 * - For decoding, call avcodec_send_packet() to give the decoder raw
94 * compressed data in an AVPacket.
95 * - For encoding, call avcodec_send_frame() to give the encoder an AVFrame
96 * containing uncompressed audio or video.
98 * In both cases, it is recommended that AVPackets and AVFrames are
99 * refcounted, or libavcodec might have to copy the input data. (libavformat
100 * always returns refcounted AVPackets, and av_frame_get_buffer() allocates
101 * refcounted AVFrames.)
102 * - Receive output in a loop. Periodically call one of the avcodec_receive_*()
103 * functions and process their output:
104 * - For decoding, call avcodec_receive_frame(). On success, it will return
105 * an AVFrame containing uncompressed audio or video data.
106 * - For encoding, call avcodec_receive_packet(). On success, it will return
107 * an AVPacket with a compressed frame.
109 * Repeat this call until it returns AVERROR(EAGAIN) or an error. The
110 * AVERROR(EAGAIN) return value means that new input data is required to
111 * return new output. In this case, continue with sending input. For each
112 * input frame/packet, the codec will typically return 1 output frame/packet,
113 * but it can also be 0 or more than 1.
115 * At the beginning of decoding or encoding, the codec might accept multiple
116 * input frames/packets without returning a frame, until its internal buffers
117 * are filled. This situation is handled transparently if you follow the steps
120 * In theory, sending input can result in EAGAIN - this should happen only if
121 * not all output was received. You can use this to structure alternative decode
122 * or encode loops other than the one suggested above. For example, you could
123 * try sending new input on each iteration, and try to receive output if that
126 * End of stream situations. These require "flushing" (aka draining) the codec,
127 * as the codec might buffer multiple frames or packets internally for
128 * performance or out of necessity (consider B-frames).
129 * This is handled as follows:
130 * - Instead of valid input, send NULL to the avcodec_send_packet() (decoding)
131 * or avcodec_send_frame() (encoding) functions. This will enter draining
133 * - Call avcodec_receive_frame() (decoding) or avcodec_receive_packet()
134 * (encoding) in a loop until AVERROR_EOF is returned. The functions will
135 * not return AVERROR(EAGAIN), unless you forgot to enter draining mode.
136 * - Before decoding can be resumed again, the codec has to be reset with
137 * avcodec_flush_buffers().
139 * Using the API as outlined above is highly recommended. But it is also
140 * possible to call functions outside of this rigid schema. For example, you can
141 * call avcodec_send_packet() repeatedly without calling
142 * avcodec_receive_frame(). In this case, avcodec_send_packet() will succeed
143 * until the codec's internal buffer has been filled up (which is typically of
144 * size 1 per output frame, after initial input), and then reject input with
145 * AVERROR(EAGAIN). Once it starts rejecting input, you have no choice but to
146 * read at least some output.
148 * Not all codecs will follow a rigid and predictable dataflow; the only
149 * guarantee is that an AVERROR(EAGAIN) return value on a send/receive call on
150 * one end implies that a receive/send call on the other end will succeed, or
151 * at least will not fail with AVERROR(EAGAIN). In general, no codec will
152 * permit unlimited buffering of input or output.
154 * This API replaces the following legacy functions:
155 * - avcodec_decode_video2() and avcodec_decode_audio4():
156 * Use avcodec_send_packet() to feed input to the decoder, then use
157 * avcodec_receive_frame() to receive decoded frames after each packet.
158 * Unlike with the old video decoding API, multiple frames might result from
159 * a packet. For audio, splitting the input packet into frames by partially
160 * decoding packets becomes transparent to the API user. You never need to
161 * feed an AVPacket to the API twice (unless it is rejected with AVERROR(EAGAIN) - then
162 * no data was read from the packet).
163 * Additionally, sending a flush/draining packet is required only once.
164 * - avcodec_encode_video2()/avcodec_encode_audio2():
165 * Use avcodec_send_frame() to feed input to the encoder, then use
166 * avcodec_receive_packet() to receive encoded packets.
167 * Providing user-allocated buffers for avcodec_receive_packet() is not
169 * - The new API does not handle subtitles yet.
171 * Mixing new and old function calls on the same AVCodecContext is not allowed,
172 * and will result in undefined behavior.
174 * Some codecs might require using the new API; using the old API will return
175 * an error when calling it. All codecs support the new API.
177 * A codec is not allowed to return AVERROR(EAGAIN) for both sending and receiving. This
178 * would be an invalid state, which could put the codec user into an endless
179 * loop. The API has no concept of time either: it cannot happen that trying to
180 * do avcodec_send_packet() results in AVERROR(EAGAIN), but a repeated call 1 second
181 * later accepts the packet (with no other receive/flush API calls involved).
182 * The API is a strict state machine, and the passage of time is not supposed
183 * to influence it. Some timing-dependent behavior might still be deemed
184 * acceptable in certain cases. But it must never result in both send/receive
185 * returning EAGAIN at the same time at any point. It must also absolutely be
186 * avoided that the current state is "unstable" and can "flip-flop" between
187 * the send/receive APIs allowing progress. For example, it's not allowed that
188 * the codec randomly decides that it actually wants to consume a packet now
189 * instead of returning a frame, after it just returned AVERROR(EAGAIN) on an
190 * avcodec_send_packet() call.
195 * @defgroup lavc_core Core functions/structures.
198 * Basic definitions, functions for querying libavcodec capabilities,
199 * allocating core structures, etc.
204 * This struct describes the properties of a single codec described by an
206 * @see avcodec_descriptor_get()
208 typedef struct AVCodecDescriptor {
210 enum AVMediaType type;
212 * Name of the codec described by this descriptor. It is non-empty and
213 * unique for each codec descriptor. It should contain alphanumeric
214 * characters and '_' only.
218 * A more descriptive name for this codec. May be NULL.
220 const char *long_name;
222 * Codec properties, a combination of AV_CODEC_PROP_* flags.
226 * MIME type(s) associated with the codec.
227 * May be NULL; if not, a NULL-terminated array of MIME types.
228 * The first item is always non-NULL and is the preferred MIME type.
230 const char *const *mime_types;
232 * If non-NULL, an array of profiles recognized for this codec.
233 * Terminated with FF_PROFILE_UNKNOWN.
235 const struct AVProfile *profiles;
239 * Codec uses only intra compression.
240 * Video and audio codecs only.
242 #define AV_CODEC_PROP_INTRA_ONLY (1 << 0)
244 * Codec supports lossy compression. Audio and video codecs only.
245 * @note a codec may support both lossy and lossless
248 #define AV_CODEC_PROP_LOSSY (1 << 1)
250 * Codec supports lossless compression. Audio and video codecs only.
252 #define AV_CODEC_PROP_LOSSLESS (1 << 2)
254 * Codec supports frame reordering. That is, the coded order (the order in which
255 * the encoded packets are output by the encoders / stored / input to the
256 * decoders) may be different from the presentation order of the corresponding
259 * For codecs that do not have this property set, PTS and DTS should always be
262 #define AV_CODEC_PROP_REORDER (1 << 3)
264 * Subtitle codec is bitmap based
265 * Decoded AVSubtitle data can be read from the AVSubtitleRect->pict field.
267 #define AV_CODEC_PROP_BITMAP_SUB (1 << 16)
269 * Subtitle codec is text based.
270 * Decoded AVSubtitle data can be read from the AVSubtitleRect->ass field.
272 #define AV_CODEC_PROP_TEXT_SUB (1 << 17)
275 * @ingroup lavc_decoding
276 * Required number of additionally allocated bytes at the end of the input bitstream for decoding.
277 * This is mainly needed because some optimized bitstream readers read
278 * 32 or 64 bit at once and could read over the end.<br>
279 * Note: If the first 23 bits of the additional bytes are not 0, then damaged
280 * MPEG bitstreams could cause overread and segfault.
282 #define AV_INPUT_BUFFER_PADDING_SIZE 64
285 * @ingroup lavc_encoding
286 * minimum encoding buffer size
287 * Used to avoid some checks during header writing.
289 #define AV_INPUT_BUFFER_MIN_SIZE 16384
292 * @ingroup lavc_decoding
295 /* We leave some space between them for extensions (drop some
296 * keyframes for intra-only or drop just some bidir frames). */
297 AVDISCARD_NONE =-16, ///< discard nothing
298 AVDISCARD_DEFAULT = 0, ///< discard useless packets like 0 size packets in avi
299 AVDISCARD_NONREF = 8, ///< discard all non reference
300 AVDISCARD_BIDIR = 16, ///< discard all bidirectional frames
301 AVDISCARD_NONINTRA= 24, ///< discard all non intra frames
302 AVDISCARD_NONKEY = 32, ///< discard all frames except keyframes
303 AVDISCARD_ALL = 48, ///< discard all
306 enum AVAudioServiceType {
307 AV_AUDIO_SERVICE_TYPE_MAIN = 0,
308 AV_AUDIO_SERVICE_TYPE_EFFECTS = 1,
309 AV_AUDIO_SERVICE_TYPE_VISUALLY_IMPAIRED = 2,
310 AV_AUDIO_SERVICE_TYPE_HEARING_IMPAIRED = 3,
311 AV_AUDIO_SERVICE_TYPE_DIALOGUE = 4,
312 AV_AUDIO_SERVICE_TYPE_COMMENTARY = 5,
313 AV_AUDIO_SERVICE_TYPE_EMERGENCY = 6,
314 AV_AUDIO_SERVICE_TYPE_VOICE_OVER = 7,
315 AV_AUDIO_SERVICE_TYPE_KARAOKE = 8,
316 AV_AUDIO_SERVICE_TYPE_NB , ///< Not part of ABI
320 * @ingroup lavc_encoding
322 typedef struct RcOverride{
325 int qscale; // If this is 0 then quality_factor will be used instead.
326 float quality_factor;
330 These flags can be passed in AVCodecContext.flags before initialization.
331 Note: Not everything is supported yet.
335 * Allow decoders to produce frames with data planes that are not aligned
336 * to CPU requirements (e.g. due to cropping).
338 #define AV_CODEC_FLAG_UNALIGNED (1 << 0)
342 #define AV_CODEC_FLAG_QSCALE (1 << 1)
344 * 4 MV per MB allowed / advanced prediction for H.263.
346 #define AV_CODEC_FLAG_4MV (1 << 2)
348 * Output even those frames that might be corrupted.
350 #define AV_CODEC_FLAG_OUTPUT_CORRUPT (1 << 3)
354 #define AV_CODEC_FLAG_QPEL (1 << 4)
356 * Don't output frames whose parameters differ from first
357 * decoded frame in stream.
359 #define AV_CODEC_FLAG_DROPCHANGED (1 << 5)
361 * Use internal 2pass ratecontrol in first pass mode.
363 #define AV_CODEC_FLAG_PASS1 (1 << 9)
365 * Use internal 2pass ratecontrol in second pass mode.
367 #define AV_CODEC_FLAG_PASS2 (1 << 10)
371 #define AV_CODEC_FLAG_LOOP_FILTER (1 << 11)
373 * Only decode/encode grayscale.
375 #define AV_CODEC_FLAG_GRAY (1 << 13)
377 * error[?] variables will be set during encoding.
379 #define AV_CODEC_FLAG_PSNR (1 << 15)
381 * Input bitstream might be truncated at a random location
382 * instead of only at frame boundaries.
384 #define AV_CODEC_FLAG_TRUNCATED (1 << 16)
386 * Use interlaced DCT.
388 #define AV_CODEC_FLAG_INTERLACED_DCT (1 << 18)
392 #define AV_CODEC_FLAG_LOW_DELAY (1 << 19)
394 * Place global headers in extradata instead of every keyframe.
396 #define AV_CODEC_FLAG_GLOBAL_HEADER (1 << 22)
398 * Use only bitexact stuff (except (I)DCT).
400 #define AV_CODEC_FLAG_BITEXACT (1 << 23)
401 /* Fx : Flag for H.263+ extra options */
403 * H.263 advanced intra coding / MPEG-4 AC prediction
405 #define AV_CODEC_FLAG_AC_PRED (1 << 24)
407 * interlaced motion estimation
409 #define AV_CODEC_FLAG_INTERLACED_ME (1 << 29)
410 #define AV_CODEC_FLAG_CLOSED_GOP (1U << 31)
413 * Allow non spec compliant speedup tricks.
415 #define AV_CODEC_FLAG2_FAST (1 << 0)
417 * Skip bitstream encoding.
419 #define AV_CODEC_FLAG2_NO_OUTPUT (1 << 2)
421 * Place global headers at every keyframe instead of in extradata.
423 #define AV_CODEC_FLAG2_LOCAL_HEADER (1 << 3)
426 * timecode is in drop frame format. DEPRECATED!!!!
428 #define AV_CODEC_FLAG2_DROP_FRAME_TIMECODE (1 << 13)
431 * Input bitstream might be truncated at a packet boundaries
432 * instead of only at frame boundaries.
434 #define AV_CODEC_FLAG2_CHUNKS (1 << 15)
436 * Discard cropping information from SPS.
438 #define AV_CODEC_FLAG2_IGNORE_CROP (1 << 16)
441 * Show all frames before the first keyframe
443 #define AV_CODEC_FLAG2_SHOW_ALL (1 << 22)
445 * Export motion vectors through frame side data
447 #define AV_CODEC_FLAG2_EXPORT_MVS (1 << 28)
449 * Do not skip samples and export skip information as frame side data
451 #define AV_CODEC_FLAG2_SKIP_MANUAL (1 << 29)
453 * Do not reset ASS ReadOrder field on flush (subtitles decoding)
455 #define AV_CODEC_FLAG2_RO_FLUSH_NOOP (1 << 30)
457 /* Unsupported options :
458 * Syntax Arithmetic coding (SAC)
459 * Reference Picture Selection
460 * Independent Segment Decoding */
462 /* codec capabilities */
465 * Decoder can use draw_horiz_band callback.
467 #define AV_CODEC_CAP_DRAW_HORIZ_BAND (1 << 0)
469 * Codec uses get_buffer() for allocating buffers and supports custom allocators.
470 * If not set, it might not use get_buffer() at all or use operations that
471 * assume the buffer was allocated by avcodec_default_get_buffer.
473 #define AV_CODEC_CAP_DR1 (1 << 1)
474 #define AV_CODEC_CAP_TRUNCATED (1 << 3)
476 * Encoder or decoder requires flushing with NULL input at the end in order to
477 * give the complete and correct output.
479 * NOTE: If this flag is not set, the codec is guaranteed to never be fed with
480 * with NULL data. The user can still send NULL data to the public encode
481 * or decode function, but libavcodec will not pass it along to the codec
482 * unless this flag is set.
485 * The decoder has a non-zero delay and needs to be fed with avpkt->data=NULL,
486 * avpkt->size=0 at the end to get the delayed data until the decoder no longer
490 * The encoder needs to be fed with NULL data at the end of encoding until the
491 * encoder no longer returns data.
493 * NOTE: For encoders implementing the AVCodec.encode2() function, setting this
494 * flag also means that the encoder must set the pts and duration for
495 * each output packet. If this flag is not set, the pts and duration will
496 * be determined by libavcodec from the input frame.
498 #define AV_CODEC_CAP_DELAY (1 << 5)
500 * Codec can be fed a final frame with a smaller size.
501 * This can be used to prevent truncation of the last audio samples.
503 #define AV_CODEC_CAP_SMALL_LAST_FRAME (1 << 6)
506 * Codec can output multiple frames per AVPacket
507 * Normally demuxers return one frame at a time, demuxers which do not do
508 * are connected to a parser to split what they return into proper frames.
509 * This flag is reserved to the very rare category of codecs which have a
510 * bitstream that cannot be split into frames without timeconsuming
511 * operations like full decoding. Demuxers carrying such bitstreams thus
512 * may return multiple frames in a packet. This has many disadvantages like
513 * prohibiting stream copy in many cases thus it should only be considered
516 #define AV_CODEC_CAP_SUBFRAMES (1 << 8)
518 * Codec is experimental and is thus avoided in favor of non experimental
521 #define AV_CODEC_CAP_EXPERIMENTAL (1 << 9)
523 * Codec should fill in channel configuration and samplerate instead of container
525 #define AV_CODEC_CAP_CHANNEL_CONF (1 << 10)
527 * Codec supports frame-level multithreading.
529 #define AV_CODEC_CAP_FRAME_THREADS (1 << 12)
531 * Codec supports slice-based (or partition-based) multithreading.
533 #define AV_CODEC_CAP_SLICE_THREADS (1 << 13)
535 * Codec supports changed parameters at any point.
537 #define AV_CODEC_CAP_PARAM_CHANGE (1 << 14)
539 * Codec supports avctx->thread_count == 0 (auto).
541 #define AV_CODEC_CAP_AUTO_THREADS (1 << 15)
543 * Audio encoder supports receiving a different number of samples in each call.
545 #define AV_CODEC_CAP_VARIABLE_FRAME_SIZE (1 << 16)
547 * Decoder is not a preferred choice for probing.
548 * This indicates that the decoder is not a good choice for probing.
549 * It could for example be an expensive to spin up hardware decoder,
550 * or it could simply not provide a lot of useful information about
552 * A decoder marked with this flag should only be used as last resort
553 * choice for probing.
555 #define AV_CODEC_CAP_AVOID_PROBING (1 << 17)
557 * Codec is intra only.
559 #define AV_CODEC_CAP_INTRA_ONLY 0x40000000
563 #define AV_CODEC_CAP_LOSSLESS 0x80000000
566 * Codec is backed by a hardware implementation. Typically used to
567 * identify a non-hwaccel hardware decoder. For information about hwaccels, use
568 * avcodec_get_hw_config() instead.
570 #define AV_CODEC_CAP_HARDWARE (1 << 18)
573 * Codec is potentially backed by a hardware implementation, but not
574 * necessarily. This is used instead of AV_CODEC_CAP_HARDWARE, if the
575 * implementation provides some sort of internal fallback.
577 #define AV_CODEC_CAP_HYBRID (1 << 19)
580 * This codec takes the reordered_opaque field from input AVFrames
581 * and returns it in the corresponding field in AVCodecContext after
584 #define AV_CODEC_CAP_ENCODER_REORDERED_OPAQUE (1 << 20)
586 /* Exported side data.
587 These flags can be passed in AVCodecContext.export_side_data before initialization.
590 * Export motion vectors through frame side data
592 #define AV_CODEC_EXPORT_DATA_MVS (1 << 0)
594 * Export encoder Producer Reference Time through packet side data
596 #define AV_CODEC_EXPORT_DATA_PRFT (1 << 1)
600 * This specifies the area which should be displayed.
601 * Note there may be multiple such areas for one frame.
603 typedef struct AVPanScan {
606 * - encoding: Set by user.
607 * - decoding: Set by libavcodec.
612 * width and height in 1/16 pel
613 * - encoding: Set by user.
614 * - decoding: Set by libavcodec.
620 * position of the top left corner in 1/16 pel for up to 3 fields/frames
621 * - encoding: Set by user.
622 * - decoding: Set by libavcodec.
624 int16_t position[3][2];
628 * This structure describes the bitrate properties of an encoded bitstream. It
629 * roughly corresponds to a subset the VBV parameters for MPEG-2 or HRD
630 * parameters for H.264/HEVC.
632 typedef struct AVCPBProperties {
634 * Maximum bitrate of the stream, in bits per second.
635 * Zero if unknown or unspecified.
637 #if FF_API_UNSANITIZED_BITRATES
643 * Minimum bitrate of the stream, in bits per second.
644 * Zero if unknown or unspecified.
646 #if FF_API_UNSANITIZED_BITRATES
652 * Average bitrate of the stream, in bits per second.
653 * Zero if unknown or unspecified.
655 #if FF_API_UNSANITIZED_BITRATES
662 * The size of the buffer to which the ratecontrol is applied, in bits.
663 * Zero if unknown or unspecified.
668 * The delay between the time the packet this structure is associated with
669 * is received and the time when it should be decoded, in periods of a 27MHz
672 * UINT64_MAX when unknown or unspecified.
678 * This structure supplies correlation between a packet timestamp and a wall clock
679 * production time. The definition follows the Producer Reference Time ('prft')
680 * as defined in ISO/IEC 14496-12
682 typedef struct AVProducerReferenceTime {
684 * A UTC timestamp, in microseconds, since Unix epoch (e.g, av_gettime()).
688 } AVProducerReferenceTime;
691 * The decoder will keep a reference to the frame and may reuse it later.
693 #define AV_GET_BUFFER_FLAG_REF (1 << 0)
695 struct AVCodecInternal;
699 AV_FIELD_PROGRESSIVE,
700 AV_FIELD_TT, //< Top coded_first, top displayed first
701 AV_FIELD_BB, //< Bottom coded first, bottom displayed first
702 AV_FIELD_TB, //< Top coded first, bottom displayed first
703 AV_FIELD_BT, //< Bottom coded first, top displayed first
707 * main external API structure.
708 * New fields can be added to the end with minor version bumps.
709 * Removal, reordering and changes to existing fields require a major
711 * You can use AVOptions (av_opt* / av_set/get*()) to access these fields from user
713 * The name string for AVOptions options matches the associated command line
714 * parameter name and can be found in libavcodec/options_table.h
715 * The AVOption/command line parameter names differ in some cases from the C
716 * structure field names for historic reasons or brevity.
717 * sizeof(AVCodecContext) must not be used outside libav*.
719 typedef struct AVCodecContext {
721 * information on struct for av_log
722 * - set by avcodec_alloc_context3
724 const AVClass *av_class;
725 int log_level_offset;
727 enum AVMediaType codec_type; /* see AVMEDIA_TYPE_xxx */
728 const struct AVCodec *codec;
729 enum AVCodecID codec_id; /* see AV_CODEC_ID_xxx */
732 * fourcc (LSB first, so "ABCD" -> ('D'<<24) + ('C'<<16) + ('B'<<8) + 'A').
733 * This is used to work around some encoder bugs.
734 * A demuxer should set this to what is stored in the field used to identify the codec.
735 * If there are multiple such fields in a container then the demuxer should choose the one
736 * which maximizes the information about the used codec.
737 * If the codec tag field in a container is larger than 32 bits then the demuxer should
738 * remap the longer ID to 32 bits with a table or other structure. Alternatively a new
739 * extra_codec_tag + size could be added but for this a clear advantage must be demonstrated
741 * - encoding: Set by user, if not then the default based on codec_id will be used.
742 * - decoding: Set by user, will be converted to uppercase by libavcodec during init.
744 unsigned int codec_tag;
749 * Private context used for internal data.
751 * Unlike priv_data, this is not codec-specific. It is used in general
752 * libavcodec functions.
754 struct AVCodecInternal *internal;
757 * Private data of the user, can be used to carry app specific stuff.
758 * - encoding: Set by user.
759 * - decoding: Set by user.
764 * the average bitrate
765 * - encoding: Set by user; unused for constant quantizer encoding.
766 * - decoding: Set by user, may be overwritten by libavcodec
767 * if this info is available in the stream
772 * number of bits the bitstream is allowed to diverge from the reference.
773 * the reference can be CBR (for CBR pass1) or VBR (for pass2)
774 * - encoding: Set by user; unused for constant quantizer encoding.
777 int bit_rate_tolerance;
780 * Global quality for codecs which cannot change it per frame.
781 * This should be proportional to MPEG-1/2/4 qscale.
782 * - encoding: Set by user.
788 * - encoding: Set by user.
791 int compression_level;
792 #define FF_COMPRESSION_DEFAULT -1
796 * - encoding: Set by user.
797 * - decoding: Set by user.
803 * - encoding: Set by user.
804 * - decoding: Set by user.
809 * some codecs need / can use extradata like Huffman tables.
810 * MJPEG: Huffman tables
811 * rv10: additional flags
812 * MPEG-4: global headers (they can be in the bitstream or here)
813 * The allocated memory should be AV_INPUT_BUFFER_PADDING_SIZE bytes larger
814 * than extradata_size to avoid problems if it is read with the bitstream reader.
815 * The bytewise contents of extradata must not depend on the architecture or CPU endianness.
816 * Must be allocated with the av_malloc() family of functions.
817 * - encoding: Set/allocated/freed by libavcodec.
818 * - decoding: Set/allocated/freed by user.
824 * This is the fundamental unit of time (in seconds) in terms
825 * of which frame timestamps are represented. For fixed-fps content,
826 * timebase should be 1/framerate and timestamp increments should be
828 * This often, but not always is the inverse of the frame rate or field rate
829 * for video. 1/time_base is not the average frame rate if the frame rate is not
832 * Like containers, elementary streams also can store timestamps, 1/time_base
833 * is the unit in which these timestamps are specified.
834 * As example of such codec time base see ISO/IEC 14496-2:2001(E)
835 * vop_time_increment_resolution and fixed_vop_rate
836 * (fixed_vop_rate == 0 implies that it is different from the framerate)
838 * - encoding: MUST be set by user.
839 * - decoding: the use of this field for decoding is deprecated.
840 * Use framerate instead.
842 AVRational time_base;
845 * For some codecs, the time base is closer to the field rate than the frame rate.
846 * Most notably, H.264 and MPEG-2 specify time_base as half of frame duration
847 * if no telecine is used ...
849 * Set to time_base ticks per frame. Default 1, e.g., H.264/MPEG-2 set it to 2.
856 * Encoding: Number of frames delay there will be from the encoder input to
857 * the decoder output. (we assume the decoder matches the spec)
858 * Decoding: Number of frames delay in addition to what a standard decoder
859 * as specified in the spec would produce.
862 * Number of frames the decoded output will be delayed relative to the
866 * For encoding, this field is unused (see initial_padding).
868 * For decoding, this is the number of samples the decoder needs to
869 * output before the decoder's output is valid. When seeking, you should
870 * start decoding this many samples prior to your desired seek point.
872 * - encoding: Set by libavcodec.
873 * - decoding: Set by libavcodec.
880 * picture width / height.
882 * @note Those fields may not match the values of the last
883 * AVFrame output by avcodec_decode_video2 due frame
886 * - encoding: MUST be set by user.
887 * - decoding: May be set by the user before opening the decoder if known e.g.
888 * from the container. Some decoders will require the dimensions
889 * to be set by the caller. During decoding, the decoder may
890 * overwrite those values as required while parsing the data.
895 * Bitstream width / height, may be different from width/height e.g. when
896 * the decoded frame is cropped before being output or lowres is enabled.
898 * @note Those field may not match the value of the last
899 * AVFrame output by avcodec_receive_frame() due frame
903 * - decoding: May be set by the user before opening the decoder if known
904 * e.g. from the container. During decoding, the decoder may
905 * overwrite those values as required while parsing the data.
907 int coded_width, coded_height;
910 * the number of pictures in a group of pictures, or 0 for intra_only
911 * - encoding: Set by user.
917 * Pixel format, see AV_PIX_FMT_xxx.
918 * May be set by the demuxer if known from headers.
919 * May be overridden by the decoder if it knows better.
921 * @note This field may not match the value of the last
922 * AVFrame output by avcodec_receive_frame() due frame
925 * - encoding: Set by user.
926 * - decoding: Set by user if known, overridden by libavcodec while
929 enum AVPixelFormat pix_fmt;
932 * If non NULL, 'draw_horiz_band' is called by the libavcodec
933 * decoder to draw a horizontal band. It improves cache usage. Not
934 * all codecs can do that. You must check the codec capabilities
936 * When multithreading is used, it may be called from multiple threads
937 * at the same time; threads might draw different parts of the same AVFrame,
938 * or multiple AVFrames, and there is no guarantee that slices will be drawn
940 * The function is also used by hardware acceleration APIs.
941 * It is called at least once during frame decoding to pass
942 * the data needed for hardware render.
943 * In that mode instead of pixel data, AVFrame points to
944 * a structure specific to the acceleration API. The application
945 * reads the structure and can change some fields to indicate progress
948 * - decoding: Set by user.
949 * @param height the height of the slice
950 * @param y the y position of the slice
951 * @param type 1->top field, 2->bottom field, 3->frame
952 * @param offset offset into the AVFrame.data from which the slice should be read
954 void (*draw_horiz_band)(struct AVCodecContext *s,
955 const AVFrame *src, int offset[AV_NUM_DATA_POINTERS],
956 int y, int type, int height);
959 * callback to negotiate the pixelFormat
960 * @param fmt is the list of formats which are supported by the codec,
961 * it is terminated by -1 as 0 is a valid format, the formats are ordered by quality.
962 * The first is always the native one.
963 * @note The callback may be called again immediately if initialization for
964 * the selected (hardware-accelerated) pixel format failed.
965 * @warning Behavior is undefined if the callback returns a value not
966 * in the fmt list of formats.
967 * @return the chosen format
969 * - decoding: Set by user, if not set the native format will be chosen.
971 enum AVPixelFormat (*get_format)(struct AVCodecContext *s, const enum AVPixelFormat * fmt);
974 * maximum number of B-frames between non-B-frames
975 * Note: The output will be delayed by max_b_frames+1 relative to the input.
976 * - encoding: Set by user.
982 * qscale factor between IP and B-frames
983 * If > 0 then the last P-frame quantizer will be used (q= lastp_q*factor+offset).
984 * If < 0 then normal ratecontrol will be done (q= -normal_q*factor+offset).
985 * - encoding: Set by user.
988 float b_quant_factor;
990 #if FF_API_PRIVATE_OPT
991 /** @deprecated use encoder private options instead */
993 int b_frame_strategy;
997 * qscale offset between IP and B-frames
998 * - encoding: Set by user.
1001 float b_quant_offset;
1004 * Size of the frame reordering buffer in the decoder.
1005 * For MPEG-2 it is 1 IPB or 0 low delay IP.
1006 * - encoding: Set by libavcodec.
1007 * - decoding: Set by libavcodec.
1011 #if FF_API_PRIVATE_OPT
1012 /** @deprecated use encoder private options instead */
1013 attribute_deprecated
1018 * qscale factor between P- and I-frames
1019 * If > 0 then the last P-frame quantizer will be used (q = lastp_q * factor + offset).
1020 * If < 0 then normal ratecontrol will be done (q= -normal_q*factor+offset).
1021 * - encoding: Set by user.
1022 * - decoding: unused
1024 float i_quant_factor;
1027 * qscale offset between P and I-frames
1028 * - encoding: Set by user.
1029 * - decoding: unused
1031 float i_quant_offset;
1034 * luminance masking (0-> disabled)
1035 * - encoding: Set by user.
1036 * - decoding: unused
1041 * temporary complexity masking (0-> disabled)
1042 * - encoding: Set by user.
1043 * - decoding: unused
1045 float temporal_cplx_masking;
1048 * spatial complexity masking (0-> disabled)
1049 * - encoding: Set by user.
1050 * - decoding: unused
1052 float spatial_cplx_masking;
1055 * p block masking (0-> disabled)
1056 * - encoding: Set by user.
1057 * - decoding: unused
1062 * darkness masking (0-> disabled)
1063 * - encoding: Set by user.
1064 * - decoding: unused
1070 * - encoding: Set by libavcodec.
1071 * - decoding: Set by user (or 0).
1075 #if FF_API_PRIVATE_OPT
1076 /** @deprecated use encoder private options instead */
1077 attribute_deprecated
1078 int prediction_method;
1079 #define FF_PRED_LEFT 0
1080 #define FF_PRED_PLANE 1
1081 #define FF_PRED_MEDIAN 2
1085 * slice offsets in the frame in bytes
1086 * - encoding: Set/allocated by libavcodec.
1087 * - decoding: Set/allocated by user (or NULL).
1092 * sample aspect ratio (0 if unknown)
1093 * That is the width of a pixel divided by the height of the pixel.
1094 * Numerator and denominator must be relatively prime and smaller than 256 for some video standards.
1095 * - encoding: Set by user.
1096 * - decoding: Set by libavcodec.
1098 AVRational sample_aspect_ratio;
1101 * motion estimation comparison function
1102 * - encoding: Set by user.
1103 * - decoding: unused
1107 * subpixel motion estimation comparison function
1108 * - encoding: Set by user.
1109 * - decoding: unused
1113 * macroblock comparison function (not supported yet)
1114 * - encoding: Set by user.
1115 * - decoding: unused
1119 * interlaced DCT comparison function
1120 * - encoding: Set by user.
1121 * - decoding: unused
1124 #define FF_CMP_SAD 0
1125 #define FF_CMP_SSE 1
1126 #define FF_CMP_SATD 2
1127 #define FF_CMP_DCT 3
1128 #define FF_CMP_PSNR 4
1129 #define FF_CMP_BIT 5
1131 #define FF_CMP_ZERO 7
1132 #define FF_CMP_VSAD 8
1133 #define FF_CMP_VSSE 9
1134 #define FF_CMP_NSSE 10
1135 #define FF_CMP_W53 11
1136 #define FF_CMP_W97 12
1137 #define FF_CMP_DCTMAX 13
1138 #define FF_CMP_DCT264 14
1139 #define FF_CMP_MEDIAN_SAD 15
1140 #define FF_CMP_CHROMA 256
1143 * ME diamond size & shape
1144 * - encoding: Set by user.
1145 * - decoding: unused
1150 * amount of previous MV predictors (2a+1 x 2a+1 square)
1151 * - encoding: Set by user.
1152 * - decoding: unused
1154 int last_predictor_count;
1156 #if FF_API_PRIVATE_OPT
1157 /** @deprecated use encoder private options instead */
1158 attribute_deprecated
1163 * motion estimation prepass comparison function
1164 * - encoding: Set by user.
1165 * - decoding: unused
1170 * ME prepass diamond size & shape
1171 * - encoding: Set by user.
1172 * - decoding: unused
1178 * - encoding: Set by user.
1179 * - decoding: unused
1181 int me_subpel_quality;
1184 * maximum motion estimation search range in subpel units
1185 * If 0 then no limit.
1187 * - encoding: Set by user.
1188 * - decoding: unused
1194 * - encoding: unused
1195 * - decoding: Set by user.
1198 #define SLICE_FLAG_CODED_ORDER 0x0001 ///< draw_horiz_band() is called in coded order instead of display
1199 #define SLICE_FLAG_ALLOW_FIELD 0x0002 ///< allow draw_horiz_band() with field slices (MPEG-2 field pics)
1200 #define SLICE_FLAG_ALLOW_PLANE 0x0004 ///< allow draw_horiz_band() with 1 component at a time (SVQ1)
1203 * macroblock decision mode
1204 * - encoding: Set by user.
1205 * - decoding: unused
1208 #define FF_MB_DECISION_SIMPLE 0 ///< uses mb_cmp
1209 #define FF_MB_DECISION_BITS 1 ///< chooses the one which needs the fewest bits
1210 #define FF_MB_DECISION_RD 2 ///< rate distortion
1213 * custom intra quantization matrix
1214 * Must be allocated with the av_malloc() family of functions, and will be freed in
1215 * avcodec_free_context().
1216 * - encoding: Set/allocated by user, freed by libavcodec. Can be NULL.
1217 * - decoding: Set/allocated/freed by libavcodec.
1219 uint16_t *intra_matrix;
1222 * custom inter quantization matrix
1223 * Must be allocated with the av_malloc() family of functions, and will be freed in
1224 * avcodec_free_context().
1225 * - encoding: Set/allocated by user, freed by libavcodec. Can be NULL.
1226 * - decoding: Set/allocated/freed by libavcodec.
1228 uint16_t *inter_matrix;
1230 #if FF_API_PRIVATE_OPT
1231 /** @deprecated use encoder private options instead */
1232 attribute_deprecated
1233 int scenechange_threshold;
1235 /** @deprecated use encoder private options instead */
1236 attribute_deprecated
1237 int noise_reduction;
1241 * precision of the intra DC coefficient - 8
1242 * - encoding: Set by user.
1243 * - decoding: Set by libavcodec
1245 int intra_dc_precision;
1248 * Number of macroblock rows at the top which are skipped.
1249 * - encoding: unused
1250 * - decoding: Set by user.
1255 * Number of macroblock rows at the bottom which are skipped.
1256 * - encoding: unused
1257 * - decoding: Set by user.
1262 * minimum MB Lagrange multiplier
1263 * - encoding: Set by user.
1264 * - decoding: unused
1269 * maximum MB Lagrange multiplier
1270 * - encoding: Set by user.
1271 * - decoding: unused
1275 #if FF_API_PRIVATE_OPT
1277 * @deprecated use encoder private options instead
1279 attribute_deprecated
1280 int me_penalty_compensation;
1284 * - encoding: Set by user.
1285 * - decoding: unused
1289 #if FF_API_PRIVATE_OPT
1290 /** @deprecated use encoder private options instead */
1291 attribute_deprecated
1297 * - encoding: Set by user.
1298 * - decoding: unused
1303 * number of reference frames
1304 * - encoding: Set by user.
1305 * - decoding: Set by lavc.
1309 #if FF_API_PRIVATE_OPT
1310 /** @deprecated use encoder private options instead */
1311 attribute_deprecated
1316 * Note: Value depends upon the compare function used for fullpel ME.
1317 * - encoding: Set by user.
1318 * - decoding: unused
1322 #if FF_API_PRIVATE_OPT
1323 /** @deprecated use encoder private options instead */
1324 attribute_deprecated
1329 * Chromaticity coordinates of the source primaries.
1330 * - encoding: Set by user
1331 * - decoding: Set by libavcodec
1333 enum AVColorPrimaries color_primaries;
1336 * Color Transfer Characteristic.
1337 * - encoding: Set by user
1338 * - decoding: Set by libavcodec
1340 enum AVColorTransferCharacteristic color_trc;
1343 * YUV colorspace type.
1344 * - encoding: Set by user
1345 * - decoding: Set by libavcodec
1347 enum AVColorSpace colorspace;
1350 * MPEG vs JPEG YUV range.
1351 * - encoding: Set by user
1352 * - decoding: Set by libavcodec
1354 enum AVColorRange color_range;
1357 * This defines the location of chroma samples.
1358 * - encoding: Set by user
1359 * - decoding: Set by libavcodec
1361 enum AVChromaLocation chroma_sample_location;
1365 * Indicates number of picture subdivisions. Used for parallelized
1367 * - encoding: Set by user
1368 * - decoding: unused
1373 * - encoding: set by libavcodec
1374 * - decoding: Set by user.
1376 enum AVFieldOrder field_order;
1379 int sample_rate; ///< samples per second
1380 int channels; ///< number of audio channels
1383 * audio sample format
1384 * - encoding: Set by user.
1385 * - decoding: Set by libavcodec.
1387 enum AVSampleFormat sample_fmt; ///< sample format
1389 /* The following data should not be initialized. */
1391 * Number of samples per channel in an audio frame.
1393 * - encoding: set by libavcodec in avcodec_open2(). Each submitted frame
1394 * except the last must contain exactly frame_size samples per channel.
1395 * May be 0 when the codec has AV_CODEC_CAP_VARIABLE_FRAME_SIZE set, then the
1396 * frame size is not restricted.
1397 * - decoding: may be set by some decoders to indicate constant frame size
1402 * Frame counter, set by libavcodec.
1404 * - decoding: total number of frames returned from the decoder so far.
1405 * - encoding: total number of frames passed to the encoder so far.
1407 * @note the counter is not incremented if encoding/decoding resulted in
1413 * number of bytes per packet if constant and known or 0
1414 * Used by some WAV based audio codecs.
1419 * Audio cutoff bandwidth (0 means "automatic")
1420 * - encoding: Set by user.
1421 * - decoding: unused
1426 * Audio channel layout.
1427 * - encoding: set by user.
1428 * - decoding: set by user, may be overwritten by libavcodec.
1430 uint64_t channel_layout;
1433 * Request decoder to use this channel layout if it can (0 for default)
1434 * - encoding: unused
1435 * - decoding: Set by user.
1437 uint64_t request_channel_layout;
1440 * Type of service that the audio stream conveys.
1441 * - encoding: Set by user.
1442 * - decoding: Set by libavcodec.
1444 enum AVAudioServiceType audio_service_type;
1447 * desired sample format
1448 * - encoding: Not used.
1449 * - decoding: Set by user.
1450 * Decoder will decode to this format if it can.
1452 enum AVSampleFormat request_sample_fmt;
1455 * This callback is called at the beginning of each frame to get data
1456 * buffer(s) for it. There may be one contiguous buffer for all the data or
1457 * there may be a buffer per each data plane or anything in between. What
1458 * this means is, you may set however many entries in buf[] you feel necessary.
1459 * Each buffer must be reference-counted using the AVBuffer API (see description
1462 * The following fields will be set in the frame before this callback is
1465 * - width, height (video only)
1466 * - sample_rate, channel_layout, nb_samples (audio only)
1467 * Their values may differ from the corresponding values in
1468 * AVCodecContext. This callback must use the frame values, not the codec
1469 * context values, to calculate the required buffer size.
1471 * This callback must fill the following fields in the frame:
1475 * * if the data is planar audio with more than 8 channels, then this
1476 * callback must allocate and fill extended_data to contain all pointers
1477 * to all data planes. data[] must hold as many pointers as it can.
1478 * extended_data must be allocated with av_malloc() and will be freed in
1480 * * otherwise extended_data must point to data
1481 * - buf[] must contain one or more pointers to AVBufferRef structures. Each of
1482 * the frame's data and extended_data pointers must be contained in these. That
1483 * is, one AVBufferRef for each allocated chunk of memory, not necessarily one
1484 * AVBufferRef per data[] entry. See: av_buffer_create(), av_buffer_alloc(),
1485 * and av_buffer_ref().
1486 * - extended_buf and nb_extended_buf must be allocated with av_malloc() by
1487 * this callback and filled with the extra buffers if there are more
1488 * buffers than buf[] can hold. extended_buf will be freed in
1491 * If AV_CODEC_CAP_DR1 is not set then get_buffer2() must call
1492 * avcodec_default_get_buffer2() instead of providing buffers allocated by
1495 * Each data plane must be aligned to the maximum required by the target
1498 * @see avcodec_default_get_buffer2()
1502 * If AV_GET_BUFFER_FLAG_REF is set in flags then the frame may be reused
1503 * (read and/or written to if it is writable) later by libavcodec.
1505 * avcodec_align_dimensions2() should be used to find the required width and
1506 * height, as they normally need to be rounded up to the next multiple of 16.
1508 * Some decoders do not support linesizes changing between frames.
1510 * If frame multithreading is used and thread_safe_callbacks is set,
1511 * this callback may be called from a different thread, but not from more
1512 * than one at once. Does not need to be reentrant.
1514 * @see avcodec_align_dimensions2()
1518 * Decoders request a buffer of a particular size by setting
1519 * AVFrame.nb_samples prior to calling get_buffer2(). The decoder may,
1520 * however, utilize only part of the buffer by setting AVFrame.nb_samples
1521 * to a smaller value in the output frame.
1523 * As a convenience, av_samples_get_buffer_size() and
1524 * av_samples_fill_arrays() in libavutil may be used by custom get_buffer2()
1525 * functions to find the required data size and to fill data pointers and
1526 * linesize. In AVFrame.linesize, only linesize[0] may be set for audio
1527 * since all planes must be the same size.
1529 * @see av_samples_get_buffer_size(), av_samples_fill_arrays()
1531 * - encoding: unused
1532 * - decoding: Set by libavcodec, user can override.
1534 int (*get_buffer2)(struct AVCodecContext *s, AVFrame *frame, int flags);
1537 * If non-zero, the decoded audio and video frames returned from
1538 * avcodec_decode_video2() and avcodec_decode_audio4() are reference-counted
1539 * and are valid indefinitely. The caller must free them with
1540 * av_frame_unref() when they are not needed anymore.
1541 * Otherwise, the decoded frames must not be freed by the caller and are
1542 * only valid until the next decode call.
1544 * This is always automatically enabled if avcodec_receive_frame() is used.
1546 * - encoding: unused
1547 * - decoding: set by the caller before avcodec_open2().
1549 attribute_deprecated
1550 int refcounted_frames;
1552 /* - encoding parameters */
1553 float qcompress; ///< amount of qscale change between easy & hard scenes (0.0-1.0)
1554 float qblur; ///< amount of qscale smoothing over time (0.0-1.0)
1558 * - encoding: Set by user.
1559 * - decoding: unused
1565 * - encoding: Set by user.
1566 * - decoding: unused
1571 * maximum quantizer difference between frames
1572 * - encoding: Set by user.
1573 * - decoding: unused
1578 * decoder bitstream buffer size
1579 * - encoding: Set by user.
1580 * - decoding: unused
1585 * ratecontrol override, see RcOverride
1586 * - encoding: Allocated/set/freed by user.
1587 * - decoding: unused
1589 int rc_override_count;
1590 RcOverride *rc_override;
1594 * - encoding: Set by user.
1595 * - decoding: Set by user, may be overwritten by libavcodec.
1597 int64_t rc_max_rate;
1601 * - encoding: Set by user.
1602 * - decoding: unused
1604 int64_t rc_min_rate;
1607 * Ratecontrol attempt to use, at maximum, <value> of what can be used without an underflow.
1608 * - encoding: Set by user.
1609 * - decoding: unused.
1611 float rc_max_available_vbv_use;
1614 * Ratecontrol attempt to use, at least, <value> times the amount needed to prevent a vbv overflow.
1615 * - encoding: Set by user.
1616 * - decoding: unused.
1618 float rc_min_vbv_overflow_use;
1621 * Number of bits which should be loaded into the rc buffer before decoding starts.
1622 * - encoding: Set by user.
1623 * - decoding: unused
1625 int rc_initial_buffer_occupancy;
1627 #if FF_API_CODER_TYPE
1628 #define FF_CODER_TYPE_VLC 0
1629 #define FF_CODER_TYPE_AC 1
1630 #define FF_CODER_TYPE_RAW 2
1631 #define FF_CODER_TYPE_RLE 3
1633 * @deprecated use encoder private options instead
1635 attribute_deprecated
1637 #endif /* FF_API_CODER_TYPE */
1639 #if FF_API_PRIVATE_OPT
1640 /** @deprecated use encoder private options instead */
1641 attribute_deprecated
1645 #if FF_API_PRIVATE_OPT
1646 /** @deprecated use encoder private options instead */
1647 attribute_deprecated
1648 int frame_skip_threshold;
1650 /** @deprecated use encoder private options instead */
1651 attribute_deprecated
1652 int frame_skip_factor;
1654 /** @deprecated use encoder private options instead */
1655 attribute_deprecated
1658 /** @deprecated use encoder private options instead */
1659 attribute_deprecated
1661 #endif /* FF_API_PRIVATE_OPT */
1664 * trellis RD quantization
1665 * - encoding: Set by user.
1666 * - decoding: unused
1670 #if FF_API_PRIVATE_OPT
1671 /** @deprecated use encoder private options instead */
1672 attribute_deprecated
1673 int min_prediction_order;
1675 /** @deprecated use encoder private options instead */
1676 attribute_deprecated
1677 int max_prediction_order;
1679 /** @deprecated use encoder private options instead */
1680 attribute_deprecated
1681 int64_t timecode_frame_start;
1684 #if FF_API_RTP_CALLBACK
1686 * @deprecated unused
1688 /* The RTP callback: This function is called */
1689 /* every time the encoder has a packet to send. */
1690 /* It depends on the encoder if the data starts */
1691 /* with a Start Code (it should). H.263 does. */
1692 /* mb_nb contains the number of macroblocks */
1693 /* encoded in the RTP payload. */
1694 attribute_deprecated
1695 void (*rtp_callback)(struct AVCodecContext *avctx, void *data, int size, int mb_nb);
1698 #if FF_API_PRIVATE_OPT
1699 /** @deprecated use encoder private options instead */
1700 attribute_deprecated
1701 int rtp_payload_size; /* The size of the RTP payload: the coder will */
1702 /* do its best to deliver a chunk with size */
1703 /* below rtp_payload_size, the chunk will start */
1704 /* with a start code on some codecs like H.263. */
1705 /* This doesn't take account of any particular */
1706 /* headers inside the transmitted RTP payload. */
1709 #if FF_API_STAT_BITS
1710 /* statistics, used for 2-pass encoding */
1711 attribute_deprecated
1713 attribute_deprecated
1715 attribute_deprecated
1717 attribute_deprecated
1719 attribute_deprecated
1721 attribute_deprecated
1723 attribute_deprecated
1725 attribute_deprecated
1728 /** @deprecated this field is unused */
1729 attribute_deprecated
1734 * pass1 encoding statistics output buffer
1735 * - encoding: Set by libavcodec.
1736 * - decoding: unused
1741 * pass2 encoding statistics input buffer
1742 * Concatenated stuff from stats_out of pass1 should be placed here.
1743 * - encoding: Allocated/set/freed by user.
1744 * - decoding: unused
1749 * Work around bugs in encoders which sometimes cannot be detected automatically.
1750 * - encoding: Set by user
1751 * - decoding: Set by user
1753 int workaround_bugs;
1754 #define FF_BUG_AUTODETECT 1 ///< autodetection
1755 #define FF_BUG_XVID_ILACE 4
1756 #define FF_BUG_UMP4 8
1757 #define FF_BUG_NO_PADDING 16
1758 #define FF_BUG_AMV 32
1759 #define FF_BUG_QPEL_CHROMA 64
1760 #define FF_BUG_STD_QPEL 128
1761 #define FF_BUG_QPEL_CHROMA2 256
1762 #define FF_BUG_DIRECT_BLOCKSIZE 512
1763 #define FF_BUG_EDGE 1024
1764 #define FF_BUG_HPEL_CHROMA 2048
1765 #define FF_BUG_DC_CLIP 4096
1766 #define FF_BUG_MS 8192 ///< Work around various bugs in Microsoft's broken decoders.
1767 #define FF_BUG_TRUNCATED 16384
1768 #define FF_BUG_IEDGE 32768
1771 * strictly follow the standard (MPEG-4, ...).
1772 * - encoding: Set by user.
1773 * - decoding: Set by user.
1774 * Setting this to STRICT or higher means the encoder and decoder will
1775 * generally do stupid things, whereas setting it to unofficial or lower
1776 * will mean the encoder might produce output that is not supported by all
1777 * spec-compliant decoders. Decoders don't differentiate between normal,
1778 * unofficial and experimental (that is, they always try to decode things
1779 * when they can) unless they are explicitly asked to behave stupidly
1780 * (=strictly conform to the specs)
1782 int strict_std_compliance;
1783 #define FF_COMPLIANCE_VERY_STRICT 2 ///< Strictly conform to an older more strict version of the spec or reference software.
1784 #define FF_COMPLIANCE_STRICT 1 ///< Strictly conform to all the things in the spec no matter what consequences.
1785 #define FF_COMPLIANCE_NORMAL 0
1786 #define FF_COMPLIANCE_UNOFFICIAL -1 ///< Allow unofficial extensions
1787 #define FF_COMPLIANCE_EXPERIMENTAL -2 ///< Allow nonstandardized experimental things.
1790 * error concealment flags
1791 * - encoding: unused
1792 * - decoding: Set by user.
1794 int error_concealment;
1795 #define FF_EC_GUESS_MVS 1
1796 #define FF_EC_DEBLOCK 2
1797 #define FF_EC_FAVOR_INTER 256
1801 * - encoding: Set by user.
1802 * - decoding: Set by user.
1805 #define FF_DEBUG_PICT_INFO 1
1806 #define FF_DEBUG_RC 2
1807 #define FF_DEBUG_BITSTREAM 4
1808 #define FF_DEBUG_MB_TYPE 8
1809 #define FF_DEBUG_QP 16
1812 * @deprecated this option does nothing
1814 #define FF_DEBUG_MV 32
1816 #define FF_DEBUG_DCT_COEFF 0x00000040
1817 #define FF_DEBUG_SKIP 0x00000080
1818 #define FF_DEBUG_STARTCODE 0x00000100
1819 #define FF_DEBUG_ER 0x00000400
1820 #define FF_DEBUG_MMCO 0x00000800
1821 #define FF_DEBUG_BUGS 0x00001000
1823 #define FF_DEBUG_VIS_QP 0x00002000
1824 #define FF_DEBUG_VIS_MB_TYPE 0x00004000
1826 #define FF_DEBUG_BUFFERS 0x00008000
1827 #define FF_DEBUG_THREADS 0x00010000
1828 #define FF_DEBUG_GREEN_MD 0x00800000
1829 #define FF_DEBUG_NOMC 0x01000000
1834 * - encoding: Set by user.
1835 * - decoding: Set by user.
1838 #define FF_DEBUG_VIS_MV_P_FOR 0x00000001 // visualize forward predicted MVs of P-frames
1839 #define FF_DEBUG_VIS_MV_B_FOR 0x00000002 // visualize forward predicted MVs of B-frames
1840 #define FF_DEBUG_VIS_MV_B_BACK 0x00000004 // visualize backward predicted MVs of B-frames
1844 * Error recognition; may misdetect some more or less valid parts as errors.
1845 * - encoding: unused
1846 * - decoding: Set by user.
1848 int err_recognition;
1851 * Verify checksums embedded in the bitstream (could be of either encoded or
1852 * decoded data, depending on the codec) and print an error message on mismatch.
1853 * If AV_EF_EXPLODE is also set, a mismatching checksum will result in the
1854 * decoder returning an error.
1856 #define AV_EF_CRCCHECK (1<<0)
1857 #define AV_EF_BITSTREAM (1<<1) ///< detect bitstream specification deviations
1858 #define AV_EF_BUFFER (1<<2) ///< detect improper bitstream length
1859 #define AV_EF_EXPLODE (1<<3) ///< abort decoding on minor error detection
1861 #define AV_EF_IGNORE_ERR (1<<15) ///< ignore errors and continue
1862 #define AV_EF_CAREFUL (1<<16) ///< consider things that violate the spec, are fast to calculate and have not been seen in the wild as errors
1863 #define AV_EF_COMPLIANT (1<<17) ///< consider all spec non compliances as errors
1864 #define AV_EF_AGGRESSIVE (1<<18) ///< consider things that a sane encoder should not do as an error
1868 * opaque 64-bit number (generally a PTS) that will be reordered and
1869 * output in AVFrame.reordered_opaque
1870 * - encoding: Set by libavcodec to the reordered_opaque of the input
1871 * frame corresponding to the last returned packet. Only
1872 * supported by encoders with the
1873 * AV_CODEC_CAP_ENCODER_REORDERED_OPAQUE capability.
1874 * - decoding: Set by user.
1876 int64_t reordered_opaque;
1879 * Hardware accelerator in use
1880 * - encoding: unused.
1881 * - decoding: Set by libavcodec
1883 const struct AVHWAccel *hwaccel;
1886 * Hardware accelerator context.
1887 * For some hardware accelerators, a global context needs to be
1888 * provided by the user. In that case, this holds display-dependent
1889 * data FFmpeg cannot instantiate itself. Please refer to the
1890 * FFmpeg HW accelerator documentation to know how to fill this
1891 * is. e.g. for VA API, this is a struct vaapi_context.
1892 * - encoding: unused
1893 * - decoding: Set by user
1895 void *hwaccel_context;
1899 * - encoding: Set by libavcodec if flags & AV_CODEC_FLAG_PSNR.
1900 * - decoding: unused
1902 uint64_t error[AV_NUM_DATA_POINTERS];
1905 * DCT algorithm, see FF_DCT_* below
1906 * - encoding: Set by user.
1907 * - decoding: unused
1910 #define FF_DCT_AUTO 0
1911 #define FF_DCT_FASTINT 1
1912 #define FF_DCT_INT 2
1913 #define FF_DCT_MMX 3
1914 #define FF_DCT_ALTIVEC 5
1915 #define FF_DCT_FAAN 6
1918 * IDCT algorithm, see FF_IDCT_* below.
1919 * - encoding: Set by user.
1920 * - decoding: Set by user.
1923 #define FF_IDCT_AUTO 0
1924 #define FF_IDCT_INT 1
1925 #define FF_IDCT_SIMPLE 2
1926 #define FF_IDCT_SIMPLEMMX 3
1927 #define FF_IDCT_ARM 7
1928 #define FF_IDCT_ALTIVEC 8
1929 #define FF_IDCT_SIMPLEARM 10
1930 #define FF_IDCT_XVID 14
1931 #define FF_IDCT_SIMPLEARMV5TE 16
1932 #define FF_IDCT_SIMPLEARMV6 17
1933 #define FF_IDCT_FAAN 20
1934 #define FF_IDCT_SIMPLENEON 22
1935 #define FF_IDCT_NONE 24 /* Used by XvMC to extract IDCT coefficients with FF_IDCT_PERM_NONE */
1936 #define FF_IDCT_SIMPLEAUTO 128
1939 * bits per sample/pixel from the demuxer (needed for huffyuv).
1940 * - encoding: Set by libavcodec.
1941 * - decoding: Set by user.
1943 int bits_per_coded_sample;
1946 * Bits per sample/pixel of internal libavcodec pixel/sample format.
1947 * - encoding: set by user.
1948 * - decoding: set by libavcodec.
1950 int bits_per_raw_sample;
1954 * low resolution decoding, 1-> 1/2 size, 2->1/4 size
1955 * - encoding: unused
1956 * - decoding: Set by user.
1961 #if FF_API_CODED_FRAME
1963 * the picture in the bitstream
1964 * - encoding: Set by libavcodec.
1965 * - decoding: unused
1967 * @deprecated use the quality factor packet side data instead
1969 attribute_deprecated AVFrame *coded_frame;
1974 * is used to decide how many independent tasks should be passed to execute()
1975 * - encoding: Set by user.
1976 * - decoding: Set by user.
1981 * Which multithreading methods to use.
1982 * Use of FF_THREAD_FRAME will increase decoding delay by one frame per thread,
1983 * so clients which cannot provide future frames should not use it.
1985 * - encoding: Set by user, otherwise the default is used.
1986 * - decoding: Set by user, otherwise the default is used.
1989 #define FF_THREAD_FRAME 1 ///< Decode more than one frame at once
1990 #define FF_THREAD_SLICE 2 ///< Decode more than one part of a single frame at once
1993 * Which multithreading methods are in use by the codec.
1994 * - encoding: Set by libavcodec.
1995 * - decoding: Set by libavcodec.
1997 int active_thread_type;
2000 * Set by the client if its custom get_buffer() callback can be called
2001 * synchronously from another thread, which allows faster multithreaded decoding.
2002 * draw_horiz_band() will be called from other threads regardless of this setting.
2003 * Ignored if the default get_buffer() is used.
2004 * - encoding: Set by user.
2005 * - decoding: Set by user.
2007 int thread_safe_callbacks;
2010 * The codec may call this to execute several independent things.
2011 * It will return only after finishing all tasks.
2012 * The user may replace this with some multithreaded implementation,
2013 * the default implementation will execute the parts serially.
2014 * @param count the number of things to execute
2015 * - encoding: Set by libavcodec, user can override.
2016 * - decoding: Set by libavcodec, user can override.
2018 int (*execute)(struct AVCodecContext *c, int (*func)(struct AVCodecContext *c2, void *arg), void *arg2, int *ret, int count, int size);
2021 * The codec may call this to execute several independent things.
2022 * It will return only after finishing all tasks.
2023 * The user may replace this with some multithreaded implementation,
2024 * the default implementation will execute the parts serially.
2025 * Also see avcodec_thread_init and e.g. the --enable-pthread configure option.
2026 * @param c context passed also to func
2027 * @param count the number of things to execute
2028 * @param arg2 argument passed unchanged to func
2029 * @param ret return values of executed functions, must have space for "count" values. May be NULL.
2030 * @param func function that will be called count times, with jobnr from 0 to count-1.
2031 * threadnr will be in the range 0 to c->thread_count-1 < MAX_THREADS and so that no
2032 * two instances of func executing at the same time will have the same threadnr.
2033 * @return always 0 currently, but code should handle a future improvement where when any call to func
2034 * returns < 0 no further calls to func may be done and < 0 is returned.
2035 * - encoding: Set by libavcodec, user can override.
2036 * - decoding: Set by libavcodec, user can override.
2038 int (*execute2)(struct AVCodecContext *c, int (*func)(struct AVCodecContext *c2, void *arg, int jobnr, int threadnr), void *arg2, int *ret, int count);
2041 * noise vs. sse weight for the nsse comparison function
2042 * - encoding: Set by user.
2043 * - decoding: unused
2049 * - encoding: Set by user.
2050 * - decoding: Set by libavcodec.
2053 #define FF_PROFILE_UNKNOWN -99
2054 #define FF_PROFILE_RESERVED -100
2056 #define FF_PROFILE_AAC_MAIN 0
2057 #define FF_PROFILE_AAC_LOW 1
2058 #define FF_PROFILE_AAC_SSR 2
2059 #define FF_PROFILE_AAC_LTP 3
2060 #define FF_PROFILE_AAC_HE 4
2061 #define FF_PROFILE_AAC_HE_V2 28
2062 #define FF_PROFILE_AAC_LD 22
2063 #define FF_PROFILE_AAC_ELD 38
2064 #define FF_PROFILE_MPEG2_AAC_LOW 128
2065 #define FF_PROFILE_MPEG2_AAC_HE 131
2067 #define FF_PROFILE_DNXHD 0
2068 #define FF_PROFILE_DNXHR_LB 1
2069 #define FF_PROFILE_DNXHR_SQ 2
2070 #define FF_PROFILE_DNXHR_HQ 3
2071 #define FF_PROFILE_DNXHR_HQX 4
2072 #define FF_PROFILE_DNXHR_444 5
2074 #define FF_PROFILE_DTS 20
2075 #define FF_PROFILE_DTS_ES 30
2076 #define FF_PROFILE_DTS_96_24 40
2077 #define FF_PROFILE_DTS_HD_HRA 50
2078 #define FF_PROFILE_DTS_HD_MA 60
2079 #define FF_PROFILE_DTS_EXPRESS 70
2081 #define FF_PROFILE_MPEG2_422 0
2082 #define FF_PROFILE_MPEG2_HIGH 1
2083 #define FF_PROFILE_MPEG2_SS 2
2084 #define FF_PROFILE_MPEG2_SNR_SCALABLE 3
2085 #define FF_PROFILE_MPEG2_MAIN 4
2086 #define FF_PROFILE_MPEG2_SIMPLE 5
2088 #define FF_PROFILE_H264_CONSTRAINED (1<<9) // 8+1; constraint_set1_flag
2089 #define FF_PROFILE_H264_INTRA (1<<11) // 8+3; constraint_set3_flag
2091 #define FF_PROFILE_H264_BASELINE 66
2092 #define FF_PROFILE_H264_CONSTRAINED_BASELINE (66|FF_PROFILE_H264_CONSTRAINED)
2093 #define FF_PROFILE_H264_MAIN 77
2094 #define FF_PROFILE_H264_EXTENDED 88
2095 #define FF_PROFILE_H264_HIGH 100
2096 #define FF_PROFILE_H264_HIGH_10 110
2097 #define FF_PROFILE_H264_HIGH_10_INTRA (110|FF_PROFILE_H264_INTRA)
2098 #define FF_PROFILE_H264_MULTIVIEW_HIGH 118
2099 #define FF_PROFILE_H264_HIGH_422 122
2100 #define FF_PROFILE_H264_HIGH_422_INTRA (122|FF_PROFILE_H264_INTRA)
2101 #define FF_PROFILE_H264_STEREO_HIGH 128
2102 #define FF_PROFILE_H264_HIGH_444 144
2103 #define FF_PROFILE_H264_HIGH_444_PREDICTIVE 244
2104 #define FF_PROFILE_H264_HIGH_444_INTRA (244|FF_PROFILE_H264_INTRA)
2105 #define FF_PROFILE_H264_CAVLC_444 44
2107 #define FF_PROFILE_VC1_SIMPLE 0
2108 #define FF_PROFILE_VC1_MAIN 1
2109 #define FF_PROFILE_VC1_COMPLEX 2
2110 #define FF_PROFILE_VC1_ADVANCED 3
2112 #define FF_PROFILE_MPEG4_SIMPLE 0
2113 #define FF_PROFILE_MPEG4_SIMPLE_SCALABLE 1
2114 #define FF_PROFILE_MPEG4_CORE 2
2115 #define FF_PROFILE_MPEG4_MAIN 3
2116 #define FF_PROFILE_MPEG4_N_BIT 4
2117 #define FF_PROFILE_MPEG4_SCALABLE_TEXTURE 5
2118 #define FF_PROFILE_MPEG4_SIMPLE_FACE_ANIMATION 6
2119 #define FF_PROFILE_MPEG4_BASIC_ANIMATED_TEXTURE 7
2120 #define FF_PROFILE_MPEG4_HYBRID 8
2121 #define FF_PROFILE_MPEG4_ADVANCED_REAL_TIME 9
2122 #define FF_PROFILE_MPEG4_CORE_SCALABLE 10
2123 #define FF_PROFILE_MPEG4_ADVANCED_CODING 11
2124 #define FF_PROFILE_MPEG4_ADVANCED_CORE 12
2125 #define FF_PROFILE_MPEG4_ADVANCED_SCALABLE_TEXTURE 13
2126 #define FF_PROFILE_MPEG4_SIMPLE_STUDIO 14
2127 #define FF_PROFILE_MPEG4_ADVANCED_SIMPLE 15
2129 #define FF_PROFILE_JPEG2000_CSTREAM_RESTRICTION_0 1
2130 #define FF_PROFILE_JPEG2000_CSTREAM_RESTRICTION_1 2
2131 #define FF_PROFILE_JPEG2000_CSTREAM_NO_RESTRICTION 32768
2132 #define FF_PROFILE_JPEG2000_DCINEMA_2K 3
2133 #define FF_PROFILE_JPEG2000_DCINEMA_4K 4
2135 #define FF_PROFILE_VP9_0 0
2136 #define FF_PROFILE_VP9_1 1
2137 #define FF_PROFILE_VP9_2 2
2138 #define FF_PROFILE_VP9_3 3
2140 #define FF_PROFILE_HEVC_MAIN 1
2141 #define FF_PROFILE_HEVC_MAIN_10 2
2142 #define FF_PROFILE_HEVC_MAIN_STILL_PICTURE 3
2143 #define FF_PROFILE_HEVC_REXT 4
2145 #define FF_PROFILE_AV1_MAIN 0
2146 #define FF_PROFILE_AV1_HIGH 1
2147 #define FF_PROFILE_AV1_PROFESSIONAL 2
2149 #define FF_PROFILE_MJPEG_HUFFMAN_BASELINE_DCT 0xc0
2150 #define FF_PROFILE_MJPEG_HUFFMAN_EXTENDED_SEQUENTIAL_DCT 0xc1
2151 #define FF_PROFILE_MJPEG_HUFFMAN_PROGRESSIVE_DCT 0xc2
2152 #define FF_PROFILE_MJPEG_HUFFMAN_LOSSLESS 0xc3
2153 #define FF_PROFILE_MJPEG_JPEG_LS 0xf7
2155 #define FF_PROFILE_SBC_MSBC 1
2157 #define FF_PROFILE_PRORES_PROXY 0
2158 #define FF_PROFILE_PRORES_LT 1
2159 #define FF_PROFILE_PRORES_STANDARD 2
2160 #define FF_PROFILE_PRORES_HQ 3
2161 #define FF_PROFILE_PRORES_4444 4
2162 #define FF_PROFILE_PRORES_XQ 5
2164 #define FF_PROFILE_ARIB_PROFILE_A 0
2165 #define FF_PROFILE_ARIB_PROFILE_C 1
2169 * - encoding: Set by user.
2170 * - decoding: Set by libavcodec.
2173 #define FF_LEVEL_UNKNOWN -99
2176 * Skip loop filtering for selected frames.
2177 * - encoding: unused
2178 * - decoding: Set by user.
2180 enum AVDiscard skip_loop_filter;
2183 * Skip IDCT/dequantization for selected frames.
2184 * - encoding: unused
2185 * - decoding: Set by user.
2187 enum AVDiscard skip_idct;
2190 * Skip decoding for selected frames.
2191 * - encoding: unused
2192 * - decoding: Set by user.
2194 enum AVDiscard skip_frame;
2197 * Header containing style information for text subtitles.
2198 * For SUBTITLE_ASS subtitle type, it should contain the whole ASS
2199 * [Script Info] and [V4+ Styles] section, plus the [Events] line and
2200 * the Format line following. It shouldn't include any Dialogue line.
2201 * - encoding: Set/allocated/freed by user (before avcodec_open2())
2202 * - decoding: Set/allocated/freed by libavcodec (by avcodec_open2())
2204 uint8_t *subtitle_header;
2205 int subtitle_header_size;
2207 #if FF_API_VBV_DELAY
2209 * VBV delay coded in the last frame (in periods of a 27 MHz clock).
2210 * Used for compliant TS muxing.
2211 * - encoding: Set by libavcodec.
2212 * - decoding: unused.
2213 * @deprecated this value is now exported as a part of
2214 * AV_PKT_DATA_CPB_PROPERTIES packet side data
2216 attribute_deprecated
2220 #if FF_API_SIDEDATA_ONLY_PKT
2222 * Encoding only and set by default. Allow encoders to output packets
2223 * that do not contain any encoded data, only side data.
2225 * Some encoders need to output such packets, e.g. to update some stream
2226 * parameters at the end of encoding.
2228 * @deprecated this field disables the default behaviour and
2229 * it is kept only for compatibility.
2231 attribute_deprecated
2232 int side_data_only_packets;
2236 * Audio only. The number of "priming" samples (padding) inserted by the
2237 * encoder at the beginning of the audio. I.e. this number of leading
2238 * decoded samples must be discarded by the caller to get the original audio
2239 * without leading padding.
2241 * - decoding: unused
2242 * - encoding: Set by libavcodec. The timestamps on the output packets are
2243 * adjusted by the encoder so that they always refer to the
2244 * first sample of the data actually contained in the packet,
2245 * including any added padding. E.g. if the timebase is
2246 * 1/samplerate and the timestamp of the first input sample is
2247 * 0, the timestamp of the first output packet will be
2250 int initial_padding;
2253 * - decoding: For codecs that store a framerate value in the compressed
2254 * bitstream, the decoder may export it here. { 0, 1} when
2256 * - encoding: May be used to signal the framerate of CFR content to an
2259 AVRational framerate;
2262 * Nominal unaccelerated pixel format, see AV_PIX_FMT_xxx.
2263 * - encoding: unused.
2264 * - decoding: Set by libavcodec before calling get_format()
2266 enum AVPixelFormat sw_pix_fmt;
2269 * Timebase in which pkt_dts/pts and AVPacket.dts/pts are.
2270 * - encoding unused.
2271 * - decoding set by user.
2273 AVRational pkt_timebase;
2277 * - encoding: unused.
2278 * - decoding: set by libavcodec.
2280 const AVCodecDescriptor *codec_descriptor;
2284 * low resolution decoding, 1-> 1/2 size, 2->1/4 size
2285 * - encoding: unused
2286 * - decoding: Set by user.
2292 * Current statistics for PTS correction.
2293 * - decoding: maintained and used by libavcodec, not intended to be used by user apps
2294 * - encoding: unused
2296 int64_t pts_correction_num_faulty_pts; /// Number of incorrect PTS values so far
2297 int64_t pts_correction_num_faulty_dts; /// Number of incorrect DTS values so far
2298 int64_t pts_correction_last_pts; /// PTS of the last frame
2299 int64_t pts_correction_last_dts; /// DTS of the last frame
2302 * Character encoding of the input subtitles file.
2303 * - decoding: set by user
2304 * - encoding: unused
2309 * Subtitles character encoding mode. Formats or codecs might be adjusting
2310 * this setting (if they are doing the conversion themselves for instance).
2311 * - decoding: set by libavcodec
2312 * - encoding: unused
2314 int sub_charenc_mode;
2315 #define FF_SUB_CHARENC_MODE_DO_NOTHING -1 ///< do nothing (demuxer outputs a stream supposed to be already in UTF-8, or the codec is bitmap for instance)
2316 #define FF_SUB_CHARENC_MODE_AUTOMATIC 0 ///< libavcodec will select the mode itself
2317 #define FF_SUB_CHARENC_MODE_PRE_DECODER 1 ///< the AVPacket data needs to be recoded to UTF-8 before being fed to the decoder, requires iconv
2318 #define FF_SUB_CHARENC_MODE_IGNORE 2 ///< neither convert the subtitles, nor check them for valid UTF-8
2321 * Skip processing alpha if supported by codec.
2322 * Note that if the format uses pre-multiplied alpha (common with VP6,
2323 * and recommended due to better video quality/compression)
2324 * the image will look as if alpha-blended onto a black background.
2325 * However for formats that do not use pre-multiplied alpha
2326 * there might be serious artefacts (though e.g. libswscale currently
2327 * assumes pre-multiplied alpha anyway).
2329 * - decoding: set by user
2330 * - encoding: unused
2335 * Number of samples to skip after a discontinuity
2336 * - decoding: unused
2337 * - encoding: set by libavcodec
2341 #if !FF_API_DEBUG_MV
2343 * debug motion vectors
2344 * - encoding: Set by user.
2345 * - decoding: Set by user.
2348 #define FF_DEBUG_VIS_MV_P_FOR 0x00000001 //visualize forward predicted MVs of P frames
2349 #define FF_DEBUG_VIS_MV_B_FOR 0x00000002 //visualize forward predicted MVs of B frames
2350 #define FF_DEBUG_VIS_MV_B_BACK 0x00000004 //visualize backward predicted MVs of B frames
2354 * custom intra quantization matrix
2355 * - encoding: Set by user, can be NULL.
2356 * - decoding: unused.
2358 uint16_t *chroma_intra_matrix;
2361 * dump format separator.
2362 * can be ", " or "\n " or anything else
2363 * - encoding: Set by user.
2364 * - decoding: Set by user.
2366 uint8_t *dump_separator;
2369 * ',' separated list of allowed decoders.
2370 * If NULL then all are allowed
2371 * - encoding: unused
2372 * - decoding: set by user
2374 char *codec_whitelist;
2377 * Properties of the stream that gets decoded
2378 * - encoding: unused
2379 * - decoding: set by libavcodec
2381 unsigned properties;
2382 #define FF_CODEC_PROPERTY_LOSSLESS 0x00000001
2383 #define FF_CODEC_PROPERTY_CLOSED_CAPTIONS 0x00000002
2386 * Additional data associated with the entire coded stream.
2388 * - decoding: unused
2389 * - encoding: may be set by libavcodec after avcodec_open2().
2391 AVPacketSideData *coded_side_data;
2392 int nb_coded_side_data;
2395 * A reference to the AVHWFramesContext describing the input (for encoding)
2396 * or output (decoding) frames. The reference is set by the caller and
2397 * afterwards owned (and freed) by libavcodec - it should never be read by
2398 * the caller after being set.
2400 * - decoding: This field should be set by the caller from the get_format()
2401 * callback. The previous reference (if any) will always be
2402 * unreffed by libavcodec before the get_format() call.
2404 * If the default get_buffer2() is used with a hwaccel pixel
2405 * format, then this AVHWFramesContext will be used for
2406 * allocating the frame buffers.
2408 * - encoding: For hardware encoders configured to use a hwaccel pixel
2409 * format, this field should be set by the caller to a reference
2410 * to the AVHWFramesContext describing input frames.
2411 * AVHWFramesContext.format must be equal to
2412 * AVCodecContext.pix_fmt.
2414 * This field should be set before avcodec_open2() is called.
2416 AVBufferRef *hw_frames_ctx;
2419 * Control the form of AVSubtitle.rects[N]->ass
2420 * - decoding: set by user
2421 * - encoding: unused
2423 int sub_text_format;
2424 #define FF_SUB_TEXT_FMT_ASS 0
2425 #if FF_API_ASS_TIMING
2426 #define FF_SUB_TEXT_FMT_ASS_WITH_TIMINGS 1
2430 * Audio only. The amount of padding (in samples) appended by the encoder to
2431 * the end of the audio. I.e. this number of decoded samples must be
2432 * discarded by the caller from the end of the stream to get the original
2433 * audio without any trailing padding.
2435 * - decoding: unused
2436 * - encoding: unused
2438 int trailing_padding;
2441 * The number of pixels per image to maximally accept.
2443 * - decoding: set by user
2444 * - encoding: set by user
2449 * A reference to the AVHWDeviceContext describing the device which will
2450 * be used by a hardware encoder/decoder. The reference is set by the
2451 * caller and afterwards owned (and freed) by libavcodec.
2453 * This should be used if either the codec device does not require
2454 * hardware frames or any that are used are to be allocated internally by
2455 * libavcodec. If the user wishes to supply any of the frames used as
2456 * encoder input or decoder output then hw_frames_ctx should be used
2457 * instead. When hw_frames_ctx is set in get_format() for a decoder, this
2458 * field will be ignored while decoding the associated stream segment, but
2459 * may again be used on a following one after another get_format() call.
2461 * For both encoders and decoders this field should be set before
2462 * avcodec_open2() is called and must not be written to thereafter.
2464 * Note that some decoders may require this field to be set initially in
2465 * order to support hw_frames_ctx at all - in that case, all frames
2466 * contexts used must be created on the same device.
2468 AVBufferRef *hw_device_ctx;
2471 * Bit set of AV_HWACCEL_FLAG_* flags, which affect hardware accelerated
2472 * decoding (if active).
2473 * - encoding: unused
2474 * - decoding: Set by user (either before avcodec_open2(), or in the
2475 * AVCodecContext.get_format callback)
2480 * Video decoding only. Certain video codecs support cropping, meaning that
2481 * only a sub-rectangle of the decoded frame is intended for display. This
2482 * option controls how cropping is handled by libavcodec.
2484 * When set to 1 (the default), libavcodec will apply cropping internally.
2485 * I.e. it will modify the output frame width/height fields and offset the
2486 * data pointers (only by as much as possible while preserving alignment, or
2487 * by the full amount if the AV_CODEC_FLAG_UNALIGNED flag is set) so that
2488 * the frames output by the decoder refer only to the cropped area. The
2489 * crop_* fields of the output frames will be zero.
2491 * When set to 0, the width/height fields of the output frames will be set
2492 * to the coded dimensions and the crop_* fields will describe the cropping
2493 * rectangle. Applying the cropping is left to the caller.
2495 * @warning When hardware acceleration with opaque output frames is used,
2496 * libavcodec is unable to apply cropping from the top/left border.
2498 * @note when this option is set to zero, the width/height fields of the
2499 * AVCodecContext and output AVFrames have different meanings. The codec
2500 * context fields store display dimensions (with the coded dimensions in
2501 * coded_width/height), while the frame fields store the coded dimensions
2502 * (with the display dimensions being determined by the crop_* fields).
2507 * Video decoding only. Sets the number of extra hardware frames which
2508 * the decoder will allocate for use by the caller. This must be set
2509 * before avcodec_open2() is called.
2511 * Some hardware decoders require all frames that they will use for
2512 * output to be defined in advance before decoding starts. For such
2513 * decoders, the hardware frame pool must therefore be of a fixed size.
2514 * The extra frames set here are on top of any number that the decoder
2515 * needs internally in order to operate normally (for example, frames
2516 * used as reference pictures).
2518 int extra_hw_frames;
2521 * The percentage of damaged samples to discard a frame.
2523 * - decoding: set by user
2524 * - encoding: unused
2526 int discard_damaged_percentage;
2529 * The number of samples per frame to maximally accept.
2531 * - decoding: set by user
2532 * - encoding: set by user
2534 int64_t max_samples;
2537 * Bit set of AV_CODEC_EXPORT_DATA_* flags, which affects the kind of
2538 * metadata exported in frame, packet, or coded stream side data by
2539 * decoders and encoders.
2541 * - decoding: set by user
2542 * - encoding: set by user
2544 int export_side_data;
2547 #if FF_API_CODEC_GET_SET
2549 * Accessors for some AVCodecContext fields. These used to be provided for ABI
2550 * compatibility, and do not need to be used anymore.
2552 attribute_deprecated
2553 AVRational av_codec_get_pkt_timebase (const AVCodecContext *avctx);
2554 attribute_deprecated
2555 void av_codec_set_pkt_timebase (AVCodecContext *avctx, AVRational val);
2557 attribute_deprecated
2558 const AVCodecDescriptor *av_codec_get_codec_descriptor(const AVCodecContext *avctx);
2559 attribute_deprecated
2560 void av_codec_set_codec_descriptor(AVCodecContext *avctx, const AVCodecDescriptor *desc);
2562 attribute_deprecated
2563 unsigned av_codec_get_codec_properties(const AVCodecContext *avctx);
2566 attribute_deprecated
2567 int av_codec_get_lowres(const AVCodecContext *avctx);
2568 attribute_deprecated
2569 void av_codec_set_lowres(AVCodecContext *avctx, int val);
2572 attribute_deprecated
2573 int av_codec_get_seek_preroll(const AVCodecContext *avctx);
2574 attribute_deprecated
2575 void av_codec_set_seek_preroll(AVCodecContext *avctx, int val);
2577 attribute_deprecated
2578 uint16_t *av_codec_get_chroma_intra_matrix(const AVCodecContext *avctx);
2579 attribute_deprecated
2580 void av_codec_set_chroma_intra_matrix(AVCodecContext *avctx, uint16_t *val);
2586 typedef struct AVProfile {
2588 const char *name; ///< short name for the profile
2593 * The codec supports this format via the hw_device_ctx interface.
2595 * When selecting this format, AVCodecContext.hw_device_ctx should
2596 * have been set to a device of the specified type before calling
2599 AV_CODEC_HW_CONFIG_METHOD_HW_DEVICE_CTX = 0x01,
2601 * The codec supports this format via the hw_frames_ctx interface.
2603 * When selecting this format for a decoder,
2604 * AVCodecContext.hw_frames_ctx should be set to a suitable frames
2605 * context inside the get_format() callback. The frames context
2606 * must have been created on a device of the specified type.
2608 AV_CODEC_HW_CONFIG_METHOD_HW_FRAMES_CTX = 0x02,
2610 * The codec supports this format by some internal method.
2612 * This format can be selected without any additional configuration -
2613 * no device or frames context is required.
2615 AV_CODEC_HW_CONFIG_METHOD_INTERNAL = 0x04,
2617 * The codec supports this format by some ad-hoc method.
2619 * Additional settings and/or function calls are required. See the
2620 * codec-specific documentation for details. (Methods requiring
2621 * this sort of configuration are deprecated and others should be
2622 * used in preference.)
2624 AV_CODEC_HW_CONFIG_METHOD_AD_HOC = 0x08,
2627 typedef struct AVCodecHWConfig {
2629 * A hardware pixel format which the codec can use.
2631 enum AVPixelFormat pix_fmt;
2633 * Bit set of AV_CODEC_HW_CONFIG_METHOD_* flags, describing the possible
2634 * setup methods which can be used with this configuration.
2638 * The device type associated with the configuration.
2640 * Must be set for AV_CODEC_HW_CONFIG_METHOD_HW_DEVICE_CTX and
2641 * AV_CODEC_HW_CONFIG_METHOD_HW_FRAMES_CTX, otherwise unused.
2643 enum AVHWDeviceType device_type;
2646 typedef struct AVCodecDefault AVCodecDefault;
2653 typedef struct AVCodec {
2655 * Name of the codec implementation.
2656 * The name is globally unique among encoders and among decoders (but an
2657 * encoder and a decoder can share the same name).
2658 * This is the primary way to find a codec from the user perspective.
2662 * Descriptive name for the codec, meant to be more human readable than name.
2663 * You should use the NULL_IF_CONFIG_SMALL() macro to define it.
2665 const char *long_name;
2666 enum AVMediaType type;
2669 * Codec capabilities.
2670 * see AV_CODEC_CAP_*
2673 const AVRational *supported_framerates; ///< array of supported framerates, or NULL if any, array is terminated by {0,0}
2674 const enum AVPixelFormat *pix_fmts; ///< array of supported pixel formats, or NULL if unknown, array is terminated by -1
2675 const int *supported_samplerates; ///< array of supported audio samplerates, or NULL if unknown, array is terminated by 0
2676 const enum AVSampleFormat *sample_fmts; ///< array of supported sample formats, or NULL if unknown, array is terminated by -1
2677 const uint64_t *channel_layouts; ///< array of support channel layouts, or NULL if unknown. array is terminated by 0
2678 uint8_t max_lowres; ///< maximum value for lowres supported by the decoder
2679 const AVClass *priv_class; ///< AVClass for the private context
2680 const AVProfile *profiles; ///< array of recognized profiles, or NULL if unknown, array is terminated by {FF_PROFILE_UNKNOWN}
2683 * Group name of the codec implementation.
2684 * This is a short symbolic name of the wrapper backing this codec. A
2685 * wrapper uses some kind of external implementation for the codec, such
2686 * as an external library, or a codec implementation provided by the OS or
2688 * If this field is NULL, this is a builtin, libavcodec native codec.
2689 * If non-NULL, this will be the suffix in AVCodec.name in most cases
2690 * (usually AVCodec.name will be of the form "<codec_name>_<wrapper_name>").
2692 const char *wrapper_name;
2694 /*****************************************************************
2695 * No fields below this line are part of the public API. They
2696 * may not be used outside of libavcodec and can be changed and
2698 * New public fields should be added right above.
2699 *****************************************************************
2702 struct AVCodec *next;
2704 * @name Frame-level threading support functions
2708 * If defined, called on thread contexts when they are created.
2709 * If the codec allocates writable tables in init(), re-allocate them here.
2710 * priv_data will be set to a copy of the original.
2712 int (*init_thread_copy)(AVCodecContext *);
2714 * Copy necessary context variables from a previous thread context to the current one.
2715 * If not defined, the next thread will start automatically; otherwise, the codec
2716 * must call ff_thread_finish_setup().
2718 * dst and src will (rarely) point to the same context, in which case memcpy should be skipped.
2720 int (*update_thread_context)(AVCodecContext *dst, const AVCodecContext *src);
2724 * Private codec-specific defaults.
2726 const AVCodecDefault *defaults;
2729 * Initialize codec static data, called from avcodec_register().
2731 * This is not intended for time consuming operations as it is
2732 * run for every codec regardless of that codec being used.
2734 void (*init_static_data)(struct AVCodec *codec);
2736 int (*init)(AVCodecContext *);
2737 int (*encode_sub)(AVCodecContext *, uint8_t *buf, int buf_size,
2738 const struct AVSubtitle *sub);
2740 * Encode data to an AVPacket.
2742 * @param avctx codec context
2743 * @param avpkt output AVPacket (may contain a user-provided buffer)
2744 * @param[in] frame AVFrame containing the raw data to be encoded
2745 * @param[out] got_packet_ptr encoder sets to 0 or 1 to indicate that a
2746 * non-empty packet was returned in avpkt.
2747 * @return 0 on success, negative error code on failure
2749 int (*encode2)(AVCodecContext *avctx, AVPacket *avpkt, const AVFrame *frame,
2750 int *got_packet_ptr);
2751 int (*decode)(AVCodecContext *, void *outdata, int *outdata_size, AVPacket *avpkt);
2752 int (*close)(AVCodecContext *);
2754 * Encode API with decoupled packet/frame dataflow. The API is the
2755 * same as the avcodec_ prefixed APIs (avcodec_send_frame() etc.), except
2757 * - never called if the codec is closed or the wrong type,
2758 * - if AV_CODEC_CAP_DELAY is not set, drain frames are never sent,
2759 * - only one drain frame is ever passed down,
2761 int (*send_frame)(AVCodecContext *avctx, const AVFrame *frame);
2762 int (*receive_packet)(AVCodecContext *avctx, AVPacket *avpkt);
2765 * Decode API with decoupled packet/frame dataflow. This function is called
2766 * to get one output frame. It should call ff_decode_get_packet() to obtain
2769 int (*receive_frame)(AVCodecContext *avctx, AVFrame *frame);
2772 * Will be called when seeking
2774 void (*flush)(AVCodecContext *);
2776 * Internal codec capabilities.
2777 * See FF_CODEC_CAP_* in internal.h
2782 * Decoding only, a comma-separated list of bitstream filters to apply to
2783 * packets before decoding.
2788 * Array of pointers to hardware configurations supported by the codec,
2789 * or NULL if no hardware supported. The array is terminated by a NULL
2792 * The user can only access this field via avcodec_get_hw_config().
2794 const struct AVCodecHWConfigInternal **hw_configs;
2797 * List of supported codec_tags, terminated by FF_CODEC_TAGS_END.
2799 const uint32_t *codec_tags;
2802 #if FF_API_CODEC_GET_SET
2803 attribute_deprecated
2804 int av_codec_get_max_lowres(const AVCodec *codec);
2807 struct MpegEncContext;
2810 * Retrieve supported hardware configurations for a codec.
2812 * Values of index from zero to some maximum return the indexed configuration
2813 * descriptor; all other values return NULL. If the codec does not support
2814 * any hardware configurations then it will always return NULL.
2816 const AVCodecHWConfig *avcodec_get_hw_config(const AVCodec *codec, int index);
2819 * @defgroup lavc_hwaccel AVHWAccel
2821 * @note Nothing in this structure should be accessed by the user. At some
2822 * point in future it will not be externally visible at all.
2826 typedef struct AVHWAccel {
2828 * Name of the hardware accelerated codec.
2829 * The name is globally unique among encoders and among decoders (but an
2830 * encoder and a decoder can share the same name).
2835 * Type of codec implemented by the hardware accelerator.
2837 * See AVMEDIA_TYPE_xxx
2839 enum AVMediaType type;
2842 * Codec implemented by the hardware accelerator.
2844 * See AV_CODEC_ID_xxx
2849 * Supported pixel format.
2851 * Only hardware accelerated formats are supported here.
2853 enum AVPixelFormat pix_fmt;
2856 * Hardware accelerated codec capabilities.
2857 * see AV_HWACCEL_CODEC_CAP_*
2861 /*****************************************************************
2862 * No fields below this line are part of the public API. They
2863 * may not be used outside of libavcodec and can be changed and
2865 * New public fields should be added right above.
2866 *****************************************************************
2870 * Allocate a custom buffer
2872 int (*alloc_frame)(AVCodecContext *avctx, AVFrame *frame);
2875 * Called at the beginning of each frame or field picture.
2877 * Meaningful frame information (codec specific) is guaranteed to
2878 * be parsed at this point. This function is mandatory.
2880 * Note that buf can be NULL along with buf_size set to 0.
2881 * Otherwise, this means the whole frame is available at this point.
2883 * @param avctx the codec context
2884 * @param buf the frame data buffer base
2885 * @param buf_size the size of the frame in bytes
2886 * @return zero if successful, a negative value otherwise
2888 int (*start_frame)(AVCodecContext *avctx, const uint8_t *buf, uint32_t buf_size);
2891 * Callback for parameter data (SPS/PPS/VPS etc).
2893 * Useful for hardware decoders which keep persistent state about the
2894 * video parameters, and need to receive any changes to update that state.
2896 * @param avctx the codec context
2897 * @param type the nal unit type
2898 * @param buf the nal unit data buffer
2899 * @param buf_size the size of the nal unit in bytes
2900 * @return zero if successful, a negative value otherwise
2902 int (*decode_params)(AVCodecContext *avctx, int type, const uint8_t *buf, uint32_t buf_size);
2905 * Callback for each slice.
2907 * Meaningful slice information (codec specific) is guaranteed to
2908 * be parsed at this point. This function is mandatory.
2909 * The only exception is XvMC, that works on MB level.
2911 * @param avctx the codec context
2912 * @param buf the slice data buffer base
2913 * @param buf_size the size of the slice in bytes
2914 * @return zero if successful, a negative value otherwise
2916 int (*decode_slice)(AVCodecContext *avctx, const uint8_t *buf, uint32_t buf_size);
2919 * Called at the end of each frame or field picture.
2921 * The whole picture is parsed at this point and can now be sent
2922 * to the hardware accelerator. This function is mandatory.
2924 * @param avctx the codec context
2925 * @return zero if successful, a negative value otherwise
2927 int (*end_frame)(AVCodecContext *avctx);
2930 * Size of per-frame hardware accelerator private data.
2932 * Private data is allocated with av_mallocz() before
2933 * AVCodecContext.get_buffer() and deallocated after
2934 * AVCodecContext.release_buffer().
2936 int frame_priv_data_size;
2939 * Called for every Macroblock in a slice.
2941 * XvMC uses it to replace the ff_mpv_reconstruct_mb().
2942 * Instead of decoding to raw picture, MB parameters are
2943 * stored in an array provided by the video driver.
2945 * @param s the mpeg context
2947 void (*decode_mb)(struct MpegEncContext *s);
2950 * Initialize the hwaccel private data.
2952 * This will be called from ff_get_format(), after hwaccel and
2953 * hwaccel_context are set and the hwaccel private data in AVCodecInternal
2956 int (*init)(AVCodecContext *avctx);
2959 * Uninitialize the hwaccel private data.
2961 * This will be called from get_format() or avcodec_close(), after hwaccel
2962 * and hwaccel_context are already uninitialized.
2964 int (*uninit)(AVCodecContext *avctx);
2967 * Size of the private data to allocate in
2968 * AVCodecInternal.hwaccel_priv_data.
2973 * Internal hwaccel capabilities.
2978 * Fill the given hw_frames context with current codec parameters. Called
2979 * from get_format. Refer to avcodec_get_hw_frames_parameters() for
2982 * This CAN be called before AVHWAccel.init is called, and you must assume
2983 * that avctx->hwaccel_priv_data is invalid.
2985 int (*frame_params)(AVCodecContext *avctx, AVBufferRef *hw_frames_ctx);
2989 * HWAccel is experimental and is thus avoided in favor of non experimental
2992 #define AV_HWACCEL_CODEC_CAP_EXPERIMENTAL 0x0200
2995 * Hardware acceleration should be used for decoding even if the codec level
2996 * used is unknown or higher than the maximum supported level reported by the
2999 * It's generally a good idea to pass this flag unless you have a specific
3000 * reason not to, as hardware tends to under-report supported levels.
3002 #define AV_HWACCEL_FLAG_IGNORE_LEVEL (1 << 0)
3005 * Hardware acceleration can output YUV pixel formats with a different chroma
3006 * sampling than 4:2:0 and/or other than 8 bits per component.
3008 #define AV_HWACCEL_FLAG_ALLOW_HIGH_DEPTH (1 << 1)
3011 * Hardware acceleration should still be attempted for decoding when the
3012 * codec profile does not match the reported capabilities of the hardware.
3014 * For example, this can be used to try to decode baseline profile H.264
3015 * streams in hardware - it will often succeed, because many streams marked
3016 * as baseline profile actually conform to constrained baseline profile.
3018 * @warning If the stream is actually not supported then the behaviour is
3019 * undefined, and may include returning entirely incorrect output
3020 * while indicating success.
3022 #define AV_HWACCEL_FLAG_ALLOW_PROFILE_MISMATCH (1 << 2)
3028 #if FF_API_AVPICTURE
3030 * @defgroup lavc_picture AVPicture
3032 * Functions for working with AVPicture
3037 * Picture data structure.
3039 * Up to four components can be stored into it, the last component is
3041 * @deprecated use AVFrame or imgutils functions instead
3043 typedef struct AVPicture {
3044 attribute_deprecated
3045 uint8_t *data[AV_NUM_DATA_POINTERS]; ///< pointers to the image data planes
3046 attribute_deprecated
3047 int linesize[AV_NUM_DATA_POINTERS]; ///< number of bytes per line
3055 enum AVSubtitleType {
3058 SUBTITLE_BITMAP, ///< A bitmap, pict will be set
3061 * Plain text, the text field must be set by the decoder and is
3062 * authoritative. ass and pict fields may contain approximations.
3067 * Formatted text, the ass field must be set by the decoder and is
3068 * authoritative. pict and text fields may contain approximations.
3073 #define AV_SUBTITLE_FLAG_FORCED 0x00000001
3075 typedef struct AVSubtitleRect {
3076 int x; ///< top left corner of pict, undefined when pict is not set
3077 int y; ///< top left corner of pict, undefined when pict is not set
3078 int w; ///< width of pict, undefined when pict is not set
3079 int h; ///< height of pict, undefined when pict is not set
3080 int nb_colors; ///< number of colors in pict, undefined when pict is not set
3082 #if FF_API_AVPICTURE
3084 * @deprecated unused
3086 attribute_deprecated
3090 * data+linesize for the bitmap of this subtitle.
3091 * Can be set for text/ass as well once they are rendered.
3096 enum AVSubtitleType type;
3098 char *text; ///< 0 terminated plain UTF-8 text
3101 * 0 terminated ASS/SSA compatible event line.
3102 * The presentation of this is unaffected by the other values in this
3110 typedef struct AVSubtitle {
3111 uint16_t format; /* 0 = graphics */
3112 uint32_t start_display_time; /* relative to packet pts, in ms */
3113 uint32_t end_display_time; /* relative to packet pts, in ms */
3115 AVSubtitleRect **rects;
3116 int64_t pts; ///< Same as packet pts, in AV_TIME_BASE
3120 * This struct describes the properties of an encoded stream.
3122 * sizeof(AVCodecParameters) is not a part of the public ABI, this struct must
3123 * be allocated with avcodec_parameters_alloc() and freed with
3124 * avcodec_parameters_free().
3126 typedef struct AVCodecParameters {
3128 * General type of the encoded data.
3130 enum AVMediaType codec_type;
3132 * Specific type of the encoded data (the codec used).
3134 enum AVCodecID codec_id;
3136 * Additional information about the codec (corresponds to the AVI FOURCC).
3141 * Extra binary data needed for initializing the decoder, codec-dependent.
3143 * Must be allocated with av_malloc() and will be freed by
3144 * avcodec_parameters_free(). The allocated size of extradata must be at
3145 * least extradata_size + AV_INPUT_BUFFER_PADDING_SIZE, with the padding
3150 * Size of the extradata content in bytes.
3155 * - video: the pixel format, the value corresponds to enum AVPixelFormat.
3156 * - audio: the sample format, the value corresponds to enum AVSampleFormat.
3161 * The average bitrate of the encoded data (in bits per second).
3166 * The number of bits per sample in the codedwords.
3168 * This is basically the bitrate per sample. It is mandatory for a bunch of
3169 * formats to actually decode them. It's the number of bits for one sample in
3170 * the actual coded bitstream.
3172 * This could be for example 4 for ADPCM
3173 * For PCM formats this matches bits_per_raw_sample
3176 int bits_per_coded_sample;
3179 * This is the number of valid bits in each output sample. If the
3180 * sample format has more bits, the least significant bits are additional
3181 * padding bits, which are always 0. Use right shifts to reduce the sample
3182 * to its actual size. For example, audio formats with 24 bit samples will
3183 * have bits_per_raw_sample set to 24, and format set to AV_SAMPLE_FMT_S32.
3184 * To get the original sample use "(int32_t)sample >> 8"."
3186 * For ADPCM this might be 12 or 16 or similar
3189 int bits_per_raw_sample;
3192 * Codec-specific bitstream restrictions that the stream conforms to.
3198 * Video only. The dimensions of the video frame in pixels.
3204 * Video only. The aspect ratio (width / height) which a single pixel
3205 * should have when displayed.
3207 * When the aspect ratio is unknown / undefined, the numerator should be
3208 * set to 0 (the denominator may have any value).
3210 AVRational sample_aspect_ratio;
3213 * Video only. The order of the fields in interlaced video.
3215 enum AVFieldOrder field_order;
3218 * Video only. Additional colorspace characteristics.
3220 enum AVColorRange color_range;
3221 enum AVColorPrimaries color_primaries;
3222 enum AVColorTransferCharacteristic color_trc;
3223 enum AVColorSpace color_space;
3224 enum AVChromaLocation chroma_location;
3227 * Video only. Number of delayed frames.
3232 * Audio only. The channel layout bitmask. May be 0 if the channel layout is
3233 * unknown or unspecified, otherwise the number of bits set must be equal to
3234 * the channels field.
3236 uint64_t channel_layout;
3238 * Audio only. The number of audio channels.
3242 * Audio only. The number of audio samples per second.
3246 * Audio only. The number of bytes per coded audio frame, required by some
3249 * Corresponds to nBlockAlign in WAVEFORMATEX.
3253 * Audio only. Audio frame size, if known. Required by some formats to be static.
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;
3272 * Audio only. Number of samples to skip after a discontinuity.
3275 } AVCodecParameters;
3278 * Iterate over all registered codecs.
3280 * @param opaque a pointer where libavcodec will store the iteration state. Must
3281 * point to NULL to start the iteration.
3283 * @return the next registered codec or NULL when the iteration is
3286 const AVCodec *av_codec_iterate(void **opaque);
3290 * If c is NULL, returns the first registered codec,
3291 * if c is non-NULL, returns the next registered codec after c,
3292 * or NULL if c is the last one.
3294 attribute_deprecated
3295 AVCodec *av_codec_next(const AVCodec *c);
3299 * Return the LIBAVCODEC_VERSION_INT constant.
3301 unsigned avcodec_version(void);
3304 * Return the libavcodec build-time configuration.
3306 const char *avcodec_configuration(void);
3309 * Return the libavcodec license.
3311 const char *avcodec_license(void);
3315 * Register the codec codec and initialize libavcodec.
3317 * @warning either this function or avcodec_register_all() must be called
3318 * before any other libavcodec functions.
3320 * @see avcodec_register_all()
3322 attribute_deprecated
3323 void avcodec_register(AVCodec *codec);
3326 * Register all the codecs, parsers and bitstream filters which were enabled at
3327 * configuration time. If you do not call this function you can select exactly
3328 * which formats you want to support, by using the individual registration
3331 * @see avcodec_register
3332 * @see av_register_codec_parser
3333 * @see av_register_bitstream_filter
3335 attribute_deprecated
3336 void avcodec_register_all(void);
3340 * Allocate an AVCodecContext and set its fields to default values. The
3341 * resulting struct should be freed with avcodec_free_context().
3343 * @param codec if non-NULL, allocate private data and initialize defaults
3344 * for the given codec. It is illegal to then call avcodec_open2()
3345 * with a different codec.
3346 * If NULL, then the codec-specific defaults won't be initialized,
3347 * which may result in suboptimal default settings (this is
3348 * important mainly for encoders, e.g. libx264).
3350 * @return An AVCodecContext filled with default values or NULL on failure.
3352 AVCodecContext *avcodec_alloc_context3(const AVCodec *codec);
3355 * Free the codec context and everything associated with it and write NULL to
3356 * the provided pointer.
3358 void avcodec_free_context(AVCodecContext **avctx);
3360 #if FF_API_GET_CONTEXT_DEFAULTS
3362 * @deprecated This function should not be used, as closing and opening a codec
3363 * context multiple time is not supported. A new codec context should be
3364 * allocated for each new use.
3366 int avcodec_get_context_defaults3(AVCodecContext *s, const AVCodec *codec);
3370 * Get the AVClass for AVCodecContext. It can be used in combination with
3371 * AV_OPT_SEARCH_FAKE_OBJ for examining options.
3373 * @see av_opt_find().
3375 const AVClass *avcodec_get_class(void);
3377 #if FF_API_COPY_CONTEXT
3379 * Get the AVClass for AVFrame. It can be used in combination with
3380 * AV_OPT_SEARCH_FAKE_OBJ for examining options.
3382 * @see av_opt_find().
3384 const AVClass *avcodec_get_frame_class(void);
3387 * Get the AVClass for AVSubtitleRect. It can be used in combination with
3388 * AV_OPT_SEARCH_FAKE_OBJ for examining options.
3390 * @see av_opt_find().
3392 const AVClass *avcodec_get_subtitle_rect_class(void);
3395 * Copy the settings of the source AVCodecContext into the destination
3396 * AVCodecContext. The resulting destination codec context will be
3397 * unopened, i.e. you are required to call avcodec_open2() before you
3398 * can use this AVCodecContext to decode/encode video/audio data.
3400 * @param dest target codec context, should be initialized with
3401 * avcodec_alloc_context3(NULL), but otherwise uninitialized
3402 * @param src source codec context
3403 * @return AVERROR() on error (e.g. memory allocation error), 0 on success
3405 * @deprecated The semantics of this function are ill-defined and it should not
3406 * be used. If you need to transfer the stream parameters from one codec context
3407 * to another, use an intermediate AVCodecParameters instance and the
3408 * avcodec_parameters_from_context() / avcodec_parameters_to_context()
3411 attribute_deprecated
3412 int avcodec_copy_context(AVCodecContext *dest, const AVCodecContext *src);
3416 * Allocate a new AVCodecParameters and set its fields to default values
3417 * (unknown/invalid/0). The returned struct must be freed with
3418 * avcodec_parameters_free().
3420 AVCodecParameters *avcodec_parameters_alloc(void);
3423 * Free an AVCodecParameters instance and everything associated with it and
3424 * write NULL to the supplied pointer.
3426 void avcodec_parameters_free(AVCodecParameters **par);
3429 * Copy the contents of src to dst. Any allocated fields in dst are freed and
3430 * replaced with newly allocated duplicates of the corresponding fields in src.
3432 * @return >= 0 on success, a negative AVERROR code on failure.
3434 int avcodec_parameters_copy(AVCodecParameters *dst, const AVCodecParameters *src);
3437 * Fill the parameters struct based on the values from the supplied codec
3438 * context. Any allocated fields in par are freed and replaced with duplicates
3439 * of the corresponding fields in codec.
3441 * @return >= 0 on success, a negative AVERROR code on failure
3443 int avcodec_parameters_from_context(AVCodecParameters *par,
3444 const AVCodecContext *codec);
3447 * Fill the codec context based on the values from the supplied codec
3448 * parameters. Any allocated fields in codec that have a corresponding field in
3449 * par are freed and replaced with duplicates of the corresponding field in par.
3450 * Fields in codec that do not have a counterpart in par are not touched.
3452 * @return >= 0 on success, a negative AVERROR code on failure.
3454 int avcodec_parameters_to_context(AVCodecContext *codec,
3455 const AVCodecParameters *par);
3458 * Initialize the AVCodecContext to use the given AVCodec. Prior to using this
3459 * function the context has to be allocated with avcodec_alloc_context3().
3461 * The functions avcodec_find_decoder_by_name(), avcodec_find_encoder_by_name(),
3462 * avcodec_find_decoder() and avcodec_find_encoder() provide an easy way for
3463 * retrieving a codec.
3465 * @warning This function is not thread safe!
3467 * @note Always call this function before using decoding routines (such as
3468 * @ref avcodec_receive_frame()).
3471 * avcodec_register_all();
3472 * av_dict_set(&opts, "b", "2.5M", 0);
3473 * codec = avcodec_find_decoder(AV_CODEC_ID_H264);
3477 * context = avcodec_alloc_context3(codec);
3479 * if (avcodec_open2(context, codec, opts) < 0)
3483 * @param avctx The context to initialize.
3484 * @param codec The codec to open this context for. If a non-NULL codec has been
3485 * previously passed to avcodec_alloc_context3() or
3486 * for this context, then this parameter MUST be either NULL or
3487 * equal to the previously passed codec.
3488 * @param options A dictionary filled with AVCodecContext and codec-private options.
3489 * On return this object will be filled with options that were not found.
3491 * @return zero on success, a negative value on error
3492 * @see avcodec_alloc_context3(), avcodec_find_decoder(), avcodec_find_encoder(),
3493 * av_dict_set(), av_opt_find().
3495 int avcodec_open2(AVCodecContext *avctx, const AVCodec *codec, AVDictionary **options);
3498 * Close a given AVCodecContext and free all the data associated with it
3499 * (but not the AVCodecContext itself).
3501 * Calling this function on an AVCodecContext that hasn't been opened will free
3502 * the codec-specific data allocated in avcodec_alloc_context3() with a non-NULL
3503 * codec. Subsequent calls will do nothing.
3505 * @note Do not use this function. Use avcodec_free_context() to destroy a
3506 * codec context (either open or closed). Opening and closing a codec context
3507 * multiple times is not supported anymore -- use multiple codec contexts
3510 int avcodec_close(AVCodecContext *avctx);
3513 * Free all allocated data in the given subtitle struct.
3515 * @param sub AVSubtitle to free.
3517 void avsubtitle_free(AVSubtitle *sub);
3524 * @addtogroup lavc_decoding
3529 * Find a registered decoder with a matching codec ID.
3531 * @param id AVCodecID of the requested decoder
3532 * @return A decoder if one was found, NULL otherwise.
3534 AVCodec *avcodec_find_decoder(enum AVCodecID id);
3537 * Find a registered decoder with the specified name.
3539 * @param name name of the requested decoder
3540 * @return A decoder if one was found, NULL otherwise.
3542 AVCodec *avcodec_find_decoder_by_name(const char *name);
3545 * The default callback for AVCodecContext.get_buffer2(). It is made public so
3546 * it can be called by custom get_buffer2() implementations for decoders without
3547 * AV_CODEC_CAP_DR1 set.
3549 int avcodec_default_get_buffer2(AVCodecContext *s, AVFrame *frame, int flags);
3552 * Modify width and height values so that they will result in a memory
3553 * buffer that is acceptable for the codec if you do not use any horizontal
3556 * May only be used if a codec with AV_CODEC_CAP_DR1 has been opened.
3558 void avcodec_align_dimensions(AVCodecContext *s, int *width, int *height);
3561 * Modify width and height values so that they will result in a memory
3562 * buffer that is acceptable for the codec if you also ensure that all
3563 * line sizes are a multiple of the respective linesize_align[i].
3565 * May only be used if a codec with AV_CODEC_CAP_DR1 has been opened.
3567 void avcodec_align_dimensions2(AVCodecContext *s, int *width, int *height,
3568 int linesize_align[AV_NUM_DATA_POINTERS]);
3571 * Converts AVChromaLocation to swscale x/y chroma position.
3573 * The positions represent the chroma (0,0) position in a coordinates system
3574 * with luma (0,0) representing the origin and luma(1,1) representing 256,256
3576 * @param xpos horizontal chroma sample position
3577 * @param ypos vertical chroma sample position
3579 int avcodec_enum_to_chroma_pos(int *xpos, int *ypos, enum AVChromaLocation pos);
3582 * Converts swscale x/y chroma position to AVChromaLocation.
3584 * The positions represent the chroma (0,0) position in a coordinates system
3585 * with luma (0,0) representing the origin and luma(1,1) representing 256,256
3587 * @param xpos horizontal chroma sample position
3588 * @param ypos vertical chroma sample position
3590 enum AVChromaLocation avcodec_chroma_pos_to_enum(int xpos, int ypos);
3593 * Decode the audio frame of size avpkt->size from avpkt->data into frame.
3595 * Some decoders may support multiple frames in a single AVPacket. Such
3596 * decoders would then just decode the first frame and the return value would be
3597 * less than the packet size. In this case, avcodec_decode_audio4 has to be
3598 * called again with an AVPacket containing the remaining data in order to
3599 * decode the second frame, etc... Even if no frames are returned, the packet
3600 * needs to be fed to the decoder with remaining data until it is completely
3601 * consumed or an error occurs.
3603 * Some decoders (those marked with AV_CODEC_CAP_DELAY) have a delay between input
3604 * and output. This means that for some packets they will not immediately
3605 * produce decoded output and need to be flushed at the end of decoding to get
3606 * all the decoded data. Flushing is done by calling this function with packets
3607 * with avpkt->data set to NULL and avpkt->size set to 0 until it stops
3608 * returning samples. It is safe to flush even those decoders that are not
3609 * marked with AV_CODEC_CAP_DELAY, then no samples will be returned.
3611 * @warning The input buffer, avpkt->data must be AV_INPUT_BUFFER_PADDING_SIZE
3612 * larger than the actual read bytes because some optimized bitstream
3613 * readers read 32 or 64 bits at once and could read over the end.
3615 * @note The AVCodecContext MUST have been opened with @ref avcodec_open2()
3616 * before packets may be fed to the decoder.
3618 * @param avctx the codec context
3619 * @param[out] frame The AVFrame in which to store decoded audio samples.
3620 * The decoder will allocate a buffer for the decoded frame by
3621 * calling the AVCodecContext.get_buffer2() callback.
3622 * When AVCodecContext.refcounted_frames is set to 1, the frame is
3623 * reference counted and the returned reference belongs to the
3624 * caller. The caller must release the frame using av_frame_unref()
3625 * when the frame is no longer needed. The caller may safely write
3626 * to the frame if av_frame_is_writable() returns 1.
3627 * When AVCodecContext.refcounted_frames is set to 0, the returned
3628 * reference belongs to the decoder and is valid only until the
3629 * next call to this function or until closing or flushing the
3630 * decoder. The caller may not write to it.
3631 * @param[out] got_frame_ptr Zero if no frame could be decoded, otherwise it is
3632 * non-zero. Note that this field being set to zero
3633 * does not mean that an error has occurred. For
3634 * decoders with AV_CODEC_CAP_DELAY set, no given decode
3635 * call is guaranteed to produce a frame.
3636 * @param[in] avpkt The input AVPacket containing the input buffer.
3637 * At least avpkt->data and avpkt->size should be set. Some
3638 * decoders might also require additional fields to be set.
3639 * @return A negative error code is returned if an error occurred during
3640 * decoding, otherwise the number of bytes consumed from the input
3641 * AVPacket is returned.
3643 * @deprecated Use avcodec_send_packet() and avcodec_receive_frame().
3645 attribute_deprecated
3646 int avcodec_decode_audio4(AVCodecContext *avctx, AVFrame *frame,
3647 int *got_frame_ptr, const AVPacket *avpkt);
3650 * Decode the video frame of size avpkt->size from avpkt->data into picture.
3651 * Some decoders may support multiple frames in a single AVPacket, such
3652 * decoders would then just decode the first frame.
3654 * @warning The input buffer must be AV_INPUT_BUFFER_PADDING_SIZE larger than
3655 * the actual read bytes because some optimized bitstream readers read 32 or 64
3656 * bits at once and could read over the end.
3658 * @warning The end of the input buffer buf should be set to 0 to ensure that
3659 * no overreading happens for damaged MPEG streams.
3661 * @note Codecs which have the AV_CODEC_CAP_DELAY capability set have a delay
3662 * between input and output, these need to be fed with avpkt->data=NULL,
3663 * avpkt->size=0 at the end to return the remaining frames.
3665 * @note The AVCodecContext MUST have been opened with @ref avcodec_open2()
3666 * before packets may be fed to the decoder.
3668 * @param avctx the codec context
3669 * @param[out] picture The AVFrame in which the decoded video frame will be stored.
3670 * Use av_frame_alloc() to get an AVFrame. The codec will
3671 * allocate memory for the actual bitmap by calling the
3672 * AVCodecContext.get_buffer2() callback.
3673 * When AVCodecContext.refcounted_frames is set to 1, the frame is
3674 * reference counted and the returned reference belongs to the
3675 * caller. The caller must release the frame using av_frame_unref()
3676 * when the frame is no longer needed. The caller may safely write
3677 * to the frame if av_frame_is_writable() returns 1.
3678 * When AVCodecContext.refcounted_frames is set to 0, the returned
3679 * reference belongs to the decoder and is valid only until the
3680 * next call to this function or until closing or flushing the
3681 * decoder. The caller may not write to it.
3683 * @param[in] avpkt The input AVPacket containing the input buffer.
3684 * You can create such packet with av_init_packet() and by then setting
3685 * data and size, some decoders might in addition need other fields like
3686 * flags&AV_PKT_FLAG_KEY. All decoders are designed to use the least
3688 * @param[in,out] got_picture_ptr Zero if no frame could be decompressed, otherwise, it is nonzero.
3689 * @return On error a negative value is returned, otherwise the number of bytes
3690 * used or zero if no frame could be decompressed.
3692 * @deprecated Use avcodec_send_packet() and avcodec_receive_frame().
3694 attribute_deprecated
3695 int avcodec_decode_video2(AVCodecContext *avctx, AVFrame *picture,
3696 int *got_picture_ptr,
3697 const AVPacket *avpkt);
3700 * Decode a subtitle message.
3701 * Return a negative value on error, otherwise return the number of bytes used.
3702 * If no subtitle could be decompressed, got_sub_ptr is zero.
3703 * Otherwise, the subtitle is stored in *sub.
3704 * Note that AV_CODEC_CAP_DR1 is not available for subtitle codecs. This is for
3705 * simplicity, because the performance difference is expected to be negligible
3706 * and reusing a get_buffer written for video codecs would probably perform badly
3707 * due to a potentially very different allocation pattern.
3709 * Some decoders (those marked with AV_CODEC_CAP_DELAY) have a delay between input
3710 * and output. This means that for some packets they will not immediately
3711 * produce decoded output and need to be flushed at the end of decoding to get
3712 * all the decoded data. Flushing is done by calling this function with packets
3713 * with avpkt->data set to NULL and avpkt->size set to 0 until it stops
3714 * returning subtitles. It is safe to flush even those decoders that are not
3715 * marked with AV_CODEC_CAP_DELAY, then no subtitles will be returned.
3717 * @note The AVCodecContext MUST have been opened with @ref avcodec_open2()
3718 * before packets may be fed to the decoder.
3720 * @param avctx the codec context
3721 * @param[out] sub The preallocated AVSubtitle in which the decoded subtitle will be stored,
3722 * must be freed with avsubtitle_free if *got_sub_ptr is set.
3723 * @param[in,out] got_sub_ptr Zero if no subtitle could be decompressed, otherwise, it is nonzero.
3724 * @param[in] avpkt The input AVPacket containing the input buffer.
3726 int avcodec_decode_subtitle2(AVCodecContext *avctx, AVSubtitle *sub,
3731 * Supply raw packet data as input to a decoder.
3733 * Internally, this call will copy relevant AVCodecContext fields, which can
3734 * influence decoding per-packet, and apply them when the packet is actually
3735 * decoded. (For example AVCodecContext.skip_frame, which might direct the
3736 * decoder to drop the frame contained by the packet sent with this function.)
3738 * @warning The input buffer, avpkt->data must be AV_INPUT_BUFFER_PADDING_SIZE
3739 * larger than the actual read bytes because some optimized bitstream
3740 * readers read 32 or 64 bits at once and could read over the end.
3742 * @warning Do not mix this API with the legacy API (like avcodec_decode_video2())
3743 * on the same AVCodecContext. It will return unexpected results now
3744 * or in future libavcodec versions.
3746 * @note The AVCodecContext MUST have been opened with @ref avcodec_open2()
3747 * before packets may be fed to the decoder.
3749 * @param avctx codec context
3750 * @param[in] avpkt The input AVPacket. Usually, this will be a single video
3751 * frame, or several complete audio frames.
3752 * Ownership of the packet remains with the caller, and the
3753 * decoder will not write to the packet. The decoder may create
3754 * a reference to the packet data (or copy it if the packet is
3755 * not reference-counted).
3756 * Unlike with older APIs, the packet is always fully consumed,
3757 * and if it contains multiple frames (e.g. some audio codecs),
3758 * will require you to call avcodec_receive_frame() multiple
3759 * times afterwards before you can send a new packet.
3760 * It can be NULL (or an AVPacket with data set to NULL and
3761 * size set to 0); in this case, it is considered a flush
3762 * packet, which signals the end of the stream. Sending the
3763 * first flush packet will return success. Subsequent ones are
3764 * unnecessary and will return AVERROR_EOF. If the decoder
3765 * still has frames buffered, it will return them after sending
3768 * @return 0 on success, otherwise negative error code:
3769 * AVERROR(EAGAIN): input is not accepted in the current state - user
3770 * must read output with avcodec_receive_frame() (once
3771 * all output is read, the packet should be resent, and
3772 * the call will not fail with EAGAIN).
3773 * AVERROR_EOF: the decoder has been flushed, and no new packets can
3774 * be sent to it (also returned if more than 1 flush
3776 * AVERROR(EINVAL): codec not opened, it is an encoder, or requires flush
3777 * AVERROR(ENOMEM): failed to add packet to internal queue, or similar
3778 * other errors: legitimate decoding errors
3780 int avcodec_send_packet(AVCodecContext *avctx, const AVPacket *avpkt);
3783 * Return decoded output data from a decoder.
3785 * @param avctx codec context
3786 * @param frame This will be set to a reference-counted video or audio
3787 * frame (depending on the decoder type) allocated by the
3788 * decoder. Note that the function will always call
3789 * av_frame_unref(frame) before doing anything else.
3792 * 0: success, a frame was returned
3793 * AVERROR(EAGAIN): output is not available in this state - user must try
3795 * AVERROR_EOF: the decoder has been fully flushed, and there will be
3796 * no more output frames
3797 * AVERROR(EINVAL): codec not opened, or it is an encoder
3798 * AVERROR_INPUT_CHANGED: current decoded frame has changed parameters
3799 * with respect to first decoded frame. Applicable
3800 * when flag AV_CODEC_FLAG_DROPCHANGED is set.
3801 * other negative values: legitimate decoding errors
3803 int avcodec_receive_frame(AVCodecContext *avctx, AVFrame *frame);
3806 * Supply a raw video or audio frame to the encoder. Use avcodec_receive_packet()
3807 * to retrieve buffered output packets.
3809 * @param avctx codec context
3810 * @param[in] frame AVFrame containing the raw audio or video frame to be encoded.
3811 * Ownership of the frame remains with the caller, and the
3812 * encoder will not write to the frame. The encoder may create
3813 * a reference to the frame data (or copy it if the frame is
3814 * not reference-counted).
3815 * It can be NULL, in which case it is considered a flush
3816 * packet. This signals the end of the stream. If the encoder
3817 * still has packets buffered, it will return them after this
3818 * call. Once flushing mode has been entered, additional flush
3819 * packets are ignored, and sending frames will return
3823 * If AV_CODEC_CAP_VARIABLE_FRAME_SIZE is set, then each frame
3824 * can have any number of samples.
3825 * If it is not set, frame->nb_samples must be equal to
3826 * avctx->frame_size for all frames except the last.
3827 * The final frame may be smaller than avctx->frame_size.
3828 * @return 0 on success, otherwise negative error code:
3829 * AVERROR(EAGAIN): input is not accepted in the current state - user
3830 * must read output with avcodec_receive_packet() (once
3831 * all output is read, the packet should be resent, and
3832 * the call will not fail with EAGAIN).
3833 * AVERROR_EOF: the encoder has been flushed, and no new frames can
3835 * AVERROR(EINVAL): codec not opened, refcounted_frames not set, it is a
3836 * decoder, or requires flush
3837 * AVERROR(ENOMEM): failed to add packet to internal queue, or similar
3838 * other errors: legitimate encoding errors
3840 int avcodec_send_frame(AVCodecContext *avctx, const AVFrame *frame);
3843 * Read encoded data from the encoder.
3845 * @param avctx codec context
3846 * @param avpkt This will be set to a reference-counted packet allocated by the
3847 * encoder. Note that the function will always call
3848 * av_packet_unref(avpkt) before doing anything else.
3849 * @return 0 on success, otherwise negative error code:
3850 * AVERROR(EAGAIN): output is not available in the current state - user
3851 * must try to send input
3852 * AVERROR_EOF: the encoder has been fully flushed, and there will be
3853 * no more output packets
3854 * AVERROR(EINVAL): codec not opened, or it is a decoder
3855 * other errors: legitimate encoding errors
3857 int avcodec_receive_packet(AVCodecContext *avctx, AVPacket *avpkt);
3860 * Create and return a AVHWFramesContext with values adequate for hardware
3861 * decoding. This is meant to get called from the get_format callback, and is
3862 * a helper for preparing a AVHWFramesContext for AVCodecContext.hw_frames_ctx.
3863 * This API is for decoding with certain hardware acceleration modes/APIs only.
3865 * The returned AVHWFramesContext is not initialized. The caller must do this
3866 * with av_hwframe_ctx_init().
3868 * Calling this function is not a requirement, but makes it simpler to avoid
3869 * codec or hardware API specific details when manually allocating frames.
3871 * Alternatively to this, an API user can set AVCodecContext.hw_device_ctx,
3872 * which sets up AVCodecContext.hw_frames_ctx fully automatically, and makes
3873 * it unnecessary to call this function or having to care about
3874 * AVHWFramesContext initialization at all.
3876 * There are a number of requirements for calling this function:
3878 * - It must be called from get_format with the same avctx parameter that was
3879 * passed to get_format. Calling it outside of get_format is not allowed, and
3880 * can trigger undefined behavior.
3881 * - The function is not always supported (see description of return values).
3882 * Even if this function returns successfully, hwaccel initialization could
3883 * fail later. (The degree to which implementations check whether the stream
3884 * is actually supported varies. Some do this check only after the user's
3885 * get_format callback returns.)
3886 * - The hw_pix_fmt must be one of the choices suggested by get_format. If the
3887 * user decides to use a AVHWFramesContext prepared with this API function,
3888 * the user must return the same hw_pix_fmt from get_format.
3889 * - The device_ref passed to this function must support the given hw_pix_fmt.
3890 * - After calling this API function, it is the user's responsibility to
3891 * initialize the AVHWFramesContext (returned by the out_frames_ref parameter),
3892 * and to set AVCodecContext.hw_frames_ctx to it. If done, this must be done
3893 * before returning from get_format (this is implied by the normal
3894 * AVCodecContext.hw_frames_ctx API rules).
3895 * - The AVHWFramesContext parameters may change every time time get_format is
3896 * called. Also, AVCodecContext.hw_frames_ctx is reset before get_format. So
3897 * you are inherently required to go through this process again on every
3899 * - It is perfectly possible to call this function without actually using
3900 * the resulting AVHWFramesContext. One use-case might be trying to reuse a
3901 * previously initialized AVHWFramesContext, and calling this API function
3902 * only to test whether the required frame parameters have changed.
3903 * - Fields that use dynamically allocated values of any kind must not be set
3904 * by the user unless setting them is explicitly allowed by the documentation.
3905 * If the user sets AVHWFramesContext.free and AVHWFramesContext.user_opaque,
3906 * the new free callback must call the potentially set previous free callback.
3907 * This API call may set any dynamically allocated fields, including the free
3910 * The function will set at least the following fields on AVHWFramesContext
3911 * (potentially more, depending on hwaccel API):
3913 * - All fields set by av_hwframe_ctx_alloc().
3914 * - Set the format field to hw_pix_fmt.
3915 * - Set the sw_format field to the most suited and most versatile format. (An
3916 * implication is that this will prefer generic formats over opaque formats
3917 * with arbitrary restrictions, if possible.)
3918 * - Set the width/height fields to the coded frame size, rounded up to the
3919 * API-specific minimum alignment.
3920 * - Only _if_ the hwaccel requires a pre-allocated pool: set the initial_pool_size
3921 * field to the number of maximum reference surfaces possible with the codec,
3922 * plus 1 surface for the user to work (meaning the user can safely reference
3923 * at most 1 decoded surface at a time), plus additional buffering introduced
3924 * by frame threading. If the hwaccel does not require pre-allocation, the
3925 * field is left to 0, and the decoder will allocate new surfaces on demand
3927 * - Possibly AVHWFramesContext.hwctx fields, depending on the underlying
3930 * Essentially, out_frames_ref returns the same as av_hwframe_ctx_alloc(), but
3931 * with basic frame parameters set.
3933 * The function is stateless, and does not change the AVCodecContext or the
3934 * device_ref AVHWDeviceContext.
3936 * @param avctx The context which is currently calling get_format, and which
3937 * implicitly contains all state needed for filling the returned
3938 * AVHWFramesContext properly.
3939 * @param device_ref A reference to the AVHWDeviceContext describing the device
3940 * which will be used by the hardware decoder.
3941 * @param hw_pix_fmt The hwaccel format you are going to return from get_format.
3942 * @param out_frames_ref On success, set to a reference to an _uninitialized_
3943 * AVHWFramesContext, created from the given device_ref.
3944 * Fields will be set to values required for decoding.
3945 * Not changed if an error is returned.
3946 * @return zero on success, a negative value on error. The following error codes
3947 * have special semantics:
3948 * AVERROR(ENOENT): the decoder does not support this functionality. Setup
3949 * is always manual, or it is a decoder which does not
3950 * support setting AVCodecContext.hw_frames_ctx at all,
3951 * or it is a software format.
3952 * AVERROR(EINVAL): it is known that hardware decoding is not supported for
3953 * this configuration, or the device_ref is not supported
3954 * for the hwaccel referenced by hw_pix_fmt.
3956 int avcodec_get_hw_frames_parameters(AVCodecContext *avctx,
3957 AVBufferRef *device_ref,
3958 enum AVPixelFormat hw_pix_fmt,
3959 AVBufferRef **out_frames_ref);
3964 * @defgroup lavc_parsing Frame parsing
3968 enum AVPictureStructure {
3969 AV_PICTURE_STRUCTURE_UNKNOWN, //< unknown
3970 AV_PICTURE_STRUCTURE_TOP_FIELD, //< coded as top field
3971 AV_PICTURE_STRUCTURE_BOTTOM_FIELD, //< coded as bottom field
3972 AV_PICTURE_STRUCTURE_FRAME, //< coded as frame
3975 typedef struct AVCodecParserContext {
3977 struct AVCodecParser *parser;
3978 int64_t frame_offset; /* offset of the current frame */
3979 int64_t cur_offset; /* current offset
3980 (incremented by each av_parser_parse()) */
3981 int64_t next_frame_offset; /* offset of the next frame */
3983 int pict_type; /* XXX: Put it back in AVCodecContext. */
3985 * This field is used for proper frame duration computation in lavf.
3986 * It signals, how much longer the frame duration of the current frame
3987 * is compared to normal frame duration.
3989 * frame_duration = (1 + repeat_pict) * time_base
3991 * It is used by codecs like H.264 to display telecined material.
3993 int repeat_pict; /* XXX: Put it back in AVCodecContext. */
3994 int64_t pts; /* pts of the current frame */
3995 int64_t dts; /* dts of the current frame */
4000 int fetch_timestamp;
4002 #define AV_PARSER_PTS_NB 4
4003 int cur_frame_start_index;
4004 int64_t cur_frame_offset[AV_PARSER_PTS_NB];
4005 int64_t cur_frame_pts[AV_PARSER_PTS_NB];
4006 int64_t cur_frame_dts[AV_PARSER_PTS_NB];
4009 #define PARSER_FLAG_COMPLETE_FRAMES 0x0001
4010 #define PARSER_FLAG_ONCE 0x0002
4011 /// Set if the parser has a valid file offset
4012 #define PARSER_FLAG_FETCHED_OFFSET 0x0004
4013 #define PARSER_FLAG_USE_CODEC_TS 0x1000
4015 int64_t offset; ///< byte offset from starting packet start
4016 int64_t cur_frame_end[AV_PARSER_PTS_NB];
4019 * Set by parser to 1 for key frames and 0 for non-key frames.
4020 * It is initialized to -1, so if the parser doesn't set this flag,
4021 * old-style fallback using AV_PICTURE_TYPE_I picture type as key frames
4026 #if FF_API_CONVERGENCE_DURATION
4028 * @deprecated unused
4030 attribute_deprecated
4031 int64_t convergence_duration;
4034 // Timestamp generation support:
4036 * Synchronization point for start of timestamp generation.
4038 * Set to >0 for sync point, 0 for no sync point and <0 for undefined
4041 * For example, this corresponds to presence of H.264 buffering period
4047 * Offset of the current timestamp against last timestamp sync point in
4048 * units of AVCodecContext.time_base.
4050 * Set to INT_MIN when dts_sync_point unused. Otherwise, it must
4051 * contain a valid timestamp offset.
4053 * Note that the timestamp of sync point has usually a nonzero
4054 * dts_ref_dts_delta, which refers to the previous sync point. Offset of
4055 * the next frame after timestamp sync point will be usually 1.
4057 * For example, this corresponds to H.264 cpb_removal_delay.
4059 int dts_ref_dts_delta;
4062 * Presentation delay of current frame in units of AVCodecContext.time_base.
4064 * Set to INT_MIN when dts_sync_point unused. Otherwise, it must
4065 * contain valid non-negative timestamp delta (presentation time of a frame
4066 * must not lie in the past).
4068 * This delay represents the difference between decoding and presentation
4069 * time of the frame.
4071 * For example, this corresponds to H.264 dpb_output_delay.
4076 * Position of the packet in file.
4078 * Analogous to cur_frame_pts/dts
4080 int64_t cur_frame_pos[AV_PARSER_PTS_NB];
4083 * Byte position of currently parsed frame in stream.
4088 * Previous frame byte position.
4093 * Duration of the current frame.
4094 * For audio, this is in units of 1 / AVCodecContext.sample_rate.
4095 * For all other types, this is in units of AVCodecContext.time_base.
4099 enum AVFieldOrder field_order;
4102 * Indicate whether a picture is coded as a frame, top field or bottom field.
4104 * For example, H.264 field_pic_flag equal to 0 corresponds to
4105 * AV_PICTURE_STRUCTURE_FRAME. An H.264 picture with field_pic_flag
4106 * equal to 1 and bottom_field_flag equal to 0 corresponds to
4107 * AV_PICTURE_STRUCTURE_TOP_FIELD.
4109 enum AVPictureStructure picture_structure;
4112 * Picture number incremented in presentation or output order.
4113 * This field may be reinitialized at the first picture of a new sequence.
4115 * For example, this corresponds to H.264 PicOrderCnt.
4117 int output_picture_number;
4120 * Dimensions of the decoded video intended for presentation.
4126 * Dimensions of the coded video.
4132 * The format of the coded data, corresponds to enum AVPixelFormat for video
4133 * and for enum AVSampleFormat for audio.
4135 * Note that a decoder can have considerable freedom in how exactly it
4136 * decodes the data, so the format reported here might be different from the
4137 * one returned by a decoder.
4140 } AVCodecParserContext;
4142 typedef struct AVCodecParser {
4143 int codec_ids[5]; /* several codec IDs are permitted */
4145 int (*parser_init)(AVCodecParserContext *s);
4146 /* This callback never returns an error, a negative value means that
4147 * the frame start was in a previous packet. */
4148 int (*parser_parse)(AVCodecParserContext *s,
4149 AVCodecContext *avctx,
4150 const uint8_t **poutbuf, int *poutbuf_size,
4151 const uint8_t *buf, int buf_size);
4152 void (*parser_close)(AVCodecParserContext *s);
4153 int (*split)(AVCodecContext *avctx, const uint8_t *buf, int buf_size);
4154 struct AVCodecParser *next;
4158 * Iterate over all registered codec parsers.
4160 * @param opaque a pointer where libavcodec will store the iteration state. Must
4161 * point to NULL to start the iteration.
4163 * @return the next registered codec parser or NULL when the iteration is
4166 const AVCodecParser *av_parser_iterate(void **opaque);
4168 attribute_deprecated
4169 AVCodecParser *av_parser_next(const AVCodecParser *c);
4171 attribute_deprecated
4172 void av_register_codec_parser(AVCodecParser *parser);
4173 AVCodecParserContext *av_parser_init(int codec_id);
4178 * @param s parser context.
4179 * @param avctx codec context.
4180 * @param poutbuf set to pointer to parsed buffer or NULL if not yet finished.
4181 * @param poutbuf_size set to size of parsed buffer or zero if not yet finished.
4182 * @param buf input buffer.
4183 * @param buf_size buffer size in bytes without the padding. I.e. the full buffer
4184 size is assumed to be buf_size + AV_INPUT_BUFFER_PADDING_SIZE.
4185 To signal EOF, this should be 0 (so that the last frame
4187 * @param pts input presentation timestamp.
4188 * @param dts input decoding timestamp.
4189 * @param pos input byte position in stream.
4190 * @return the number of bytes of the input bitstream used.
4195 * len = av_parser_parse2(myparser, AVCodecContext, &data, &size,
4202 * decode_frame(data, size);
4206 int av_parser_parse2(AVCodecParserContext *s,
4207 AVCodecContext *avctx,
4208 uint8_t **poutbuf, int *poutbuf_size,
4209 const uint8_t *buf, int buf_size,
4210 int64_t pts, int64_t dts,
4214 * @return 0 if the output buffer is a subset of the input, 1 if it is allocated and must be freed
4215 * @deprecated use AVBitStreamFilter
4217 int av_parser_change(AVCodecParserContext *s,
4218 AVCodecContext *avctx,
4219 uint8_t **poutbuf, int *poutbuf_size,
4220 const uint8_t *buf, int buf_size, int keyframe);
4221 void av_parser_close(AVCodecParserContext *s);
4229 * @addtogroup lavc_encoding
4234 * Find a registered encoder with a matching codec ID.
4236 * @param id AVCodecID of the requested encoder
4237 * @return An encoder if one was found, NULL otherwise.
4239 AVCodec *avcodec_find_encoder(enum AVCodecID id);
4242 * Find a registered encoder with the specified name.
4244 * @param name name of the requested encoder
4245 * @return An encoder if one was found, NULL otherwise.
4247 AVCodec *avcodec_find_encoder_by_name(const char *name);
4250 * Encode a frame of audio.
4252 * Takes input samples from frame and writes the next output packet, if
4253 * available, to avpkt. The output packet does not necessarily contain data for
4254 * the most recent frame, as encoders can delay, split, and combine input frames
4255 * internally as needed.
4257 * @param avctx codec context
4258 * @param avpkt output AVPacket.
4259 * The user can supply an output buffer by setting
4260 * avpkt->data and avpkt->size prior to calling the
4261 * function, but if the size of the user-provided data is not
4262 * large enough, encoding will fail. If avpkt->data and
4263 * avpkt->size are set, avpkt->destruct must also be set. All
4264 * other AVPacket fields will be reset by the encoder using
4265 * av_init_packet(). If avpkt->data is NULL, the encoder will
4266 * allocate it. The encoder will set avpkt->size to the size
4267 * of the output packet.
4269 * If this function fails or produces no output, avpkt will be
4270 * freed using av_packet_unref().
4271 * @param[in] frame AVFrame containing the raw audio data to be encoded.
4272 * May be NULL when flushing an encoder that has the
4273 * AV_CODEC_CAP_DELAY capability set.
4274 * If AV_CODEC_CAP_VARIABLE_FRAME_SIZE is set, then each frame
4275 * can have any number of samples.
4276 * If it is not set, frame->nb_samples must be equal to
4277 * avctx->frame_size for all frames except the last.
4278 * The final frame may be smaller than avctx->frame_size.
4279 * @param[out] got_packet_ptr This field is set to 1 by libavcodec if the
4280 * output packet is non-empty, and to 0 if it is
4281 * empty. If the function returns an error, the
4282 * packet can be assumed to be invalid, and the
4283 * value of got_packet_ptr is undefined and should
4285 * @return 0 on success, negative error code on failure
4287 * @deprecated use avcodec_send_frame()/avcodec_receive_packet() instead
4289 attribute_deprecated
4290 int avcodec_encode_audio2(AVCodecContext *avctx, AVPacket *avpkt,
4291 const AVFrame *frame, int *got_packet_ptr);
4294 * Encode a frame of video.
4296 * Takes input raw video data from frame and writes the next output packet, if
4297 * available, to avpkt. The output packet does not necessarily contain data for
4298 * the most recent frame, as encoders can delay and reorder input frames
4299 * internally as needed.
4301 * @param avctx codec context
4302 * @param avpkt output AVPacket.
4303 * The user can supply an output buffer by setting
4304 * avpkt->data and avpkt->size prior to calling the
4305 * function, but if the size of the user-provided data is not
4306 * large enough, encoding will fail. All other AVPacket fields
4307 * will be reset by the encoder using av_init_packet(). If
4308 * avpkt->data is NULL, the encoder will allocate it.
4309 * The encoder will set avpkt->size to the size of the
4310 * output packet. The returned data (if any) belongs to the
4311 * caller, he is responsible for freeing it.
4313 * If this function fails or produces no output, avpkt will be
4314 * freed using av_packet_unref().
4315 * @param[in] frame AVFrame containing the raw video data to be encoded.
4316 * May be NULL when flushing an encoder that has the
4317 * AV_CODEC_CAP_DELAY capability set.
4318 * @param[out] got_packet_ptr This field is set to 1 by libavcodec if the
4319 * output packet is non-empty, and to 0 if it is
4320 * empty. If the function returns an error, the
4321 * packet can be assumed to be invalid, and the
4322 * value of got_packet_ptr is undefined and should
4324 * @return 0 on success, negative error code on failure
4326 * @deprecated use avcodec_send_frame()/avcodec_receive_packet() instead
4328 attribute_deprecated
4329 int avcodec_encode_video2(AVCodecContext *avctx, AVPacket *avpkt,
4330 const AVFrame *frame, int *got_packet_ptr);
4332 int avcodec_encode_subtitle(AVCodecContext *avctx, uint8_t *buf, int buf_size,
4333 const AVSubtitle *sub);
4340 #if FF_API_AVPICTURE
4342 * @addtogroup lavc_picture
4347 * @deprecated unused
4349 attribute_deprecated
4350 int avpicture_alloc(AVPicture *picture, enum AVPixelFormat pix_fmt, int width, int height);
4353 * @deprecated unused
4355 attribute_deprecated
4356 void avpicture_free(AVPicture *picture);
4359 * @deprecated use av_image_fill_arrays() instead.
4361 attribute_deprecated
4362 int avpicture_fill(AVPicture *picture, const uint8_t *ptr,
4363 enum AVPixelFormat pix_fmt, int width, int height);
4366 * @deprecated use av_image_copy_to_buffer() instead.
4368 attribute_deprecated
4369 int avpicture_layout(const AVPicture *src, enum AVPixelFormat pix_fmt,
4370 int width, int height,
4371 unsigned char *dest, int dest_size);
4374 * @deprecated use av_image_get_buffer_size() instead.
4376 attribute_deprecated
4377 int avpicture_get_size(enum AVPixelFormat pix_fmt, int width, int height);
4380 * @deprecated av_image_copy() instead.
4382 attribute_deprecated
4383 void av_picture_copy(AVPicture *dst, const AVPicture *src,
4384 enum AVPixelFormat pix_fmt, int width, int height);
4387 * @deprecated unused
4389 attribute_deprecated
4390 int av_picture_crop(AVPicture *dst, const AVPicture *src,
4391 enum AVPixelFormat pix_fmt, int top_band, int left_band);
4394 * @deprecated unused
4396 attribute_deprecated
4397 int av_picture_pad(AVPicture *dst, const AVPicture *src, int height, int width, enum AVPixelFormat pix_fmt,
4398 int padtop, int padbottom, int padleft, int padright, int *color);
4406 * @defgroup lavc_misc Utility functions
4409 * Miscellaneous utility functions related to both encoding and decoding
4415 * @defgroup lavc_misc_pixfmt Pixel formats
4417 * Functions for working with pixel formats.
4421 #if FF_API_GETCHROMA
4423 * @deprecated Use av_pix_fmt_get_chroma_sub_sample
4426 attribute_deprecated
4427 void avcodec_get_chroma_sub_sample(enum AVPixelFormat pix_fmt, int *h_shift, int *v_shift);
4431 * Return a value representing the fourCC code associated to the
4432 * pixel format pix_fmt, or 0 if no associated fourCC code can be
4435 unsigned int avcodec_pix_fmt_to_codec_tag(enum AVPixelFormat pix_fmt);
4438 * @deprecated see av_get_pix_fmt_loss()
4440 int avcodec_get_pix_fmt_loss(enum AVPixelFormat dst_pix_fmt, enum AVPixelFormat src_pix_fmt,
4444 * Find the best pixel format to convert to given a certain source pixel
4445 * format. When converting from one pixel format to another, information loss
4446 * may occur. For example, when converting from RGB24 to GRAY, the color
4447 * information will be lost. Similarly, other losses occur when converting from
4448 * some formats to other formats. avcodec_find_best_pix_fmt_of_2() searches which of
4449 * the given pixel formats should be used to suffer the least amount of loss.
4450 * The pixel formats from which it chooses one, are determined by the
4451 * pix_fmt_list parameter.
4454 * @param[in] pix_fmt_list AV_PIX_FMT_NONE terminated array of pixel formats to choose from
4455 * @param[in] src_pix_fmt source pixel format
4456 * @param[in] has_alpha Whether the source pixel format alpha channel is used.
4457 * @param[out] loss_ptr Combination of flags informing you what kind of losses will occur.
4458 * @return The best pixel format to convert to or -1 if none was found.
4460 enum AVPixelFormat avcodec_find_best_pix_fmt_of_list(const enum AVPixelFormat *pix_fmt_list,
4461 enum AVPixelFormat src_pix_fmt,
4462 int has_alpha, int *loss_ptr);
4465 * @deprecated see av_find_best_pix_fmt_of_2()
4467 enum AVPixelFormat avcodec_find_best_pix_fmt_of_2(enum AVPixelFormat dst_pix_fmt1, enum AVPixelFormat dst_pix_fmt2,
4468 enum AVPixelFormat src_pix_fmt, int has_alpha, int *loss_ptr);
4470 attribute_deprecated
4471 enum AVPixelFormat avcodec_find_best_pix_fmt2(enum AVPixelFormat dst_pix_fmt1, enum AVPixelFormat dst_pix_fmt2,
4472 enum AVPixelFormat src_pix_fmt, int has_alpha, int *loss_ptr);
4474 enum AVPixelFormat avcodec_default_get_format(struct AVCodecContext *s, const enum AVPixelFormat * fmt);
4480 #if FF_API_TAG_STRING
4482 * Put a string representing the codec tag codec_tag in buf.
4484 * @param buf buffer to place codec tag in
4485 * @param buf_size size in bytes of buf
4486 * @param codec_tag codec tag to assign
4487 * @return the length of the string that would have been generated if
4488 * enough space had been available, excluding the trailing null
4490 * @deprecated see av_fourcc_make_string() and av_fourcc2str().
4492 attribute_deprecated
4493 size_t av_get_codec_tag_string(char *buf, size_t buf_size, unsigned int codec_tag);
4496 void avcodec_string(char *buf, int buf_size, AVCodecContext *enc, int encode);
4499 * Return a name for the specified profile, if available.
4501 * @param codec the codec that is searched for the given profile
4502 * @param profile the profile value for which a name is requested
4503 * @return A name for the profile if found, NULL otherwise.
4505 const char *av_get_profile_name(const AVCodec *codec, int profile);
4508 * Return a name for the specified profile, if available.
4510 * @param codec_id the ID of the codec to which the requested profile belongs
4511 * @param profile the profile value for which a name is requested
4512 * @return A name for the profile if found, NULL otherwise.
4514 * @note unlike av_get_profile_name(), which searches a list of profiles
4515 * supported by a specific decoder or encoder implementation, this
4516 * function searches the list of profiles from the AVCodecDescriptor
4518 const char *avcodec_profile_name(enum AVCodecID codec_id, int profile);
4520 int avcodec_default_execute(AVCodecContext *c, int (*func)(AVCodecContext *c2, void *arg2),void *arg, int *ret, int count, int size);
4521 int avcodec_default_execute2(AVCodecContext *c, int (*func)(AVCodecContext *c2, void *arg2, int, int),void *arg, int *ret, int count);
4522 //FIXME func typedef
4525 * Fill AVFrame audio data and linesize pointers.
4527 * The buffer buf must be a preallocated buffer with a size big enough
4528 * to contain the specified samples amount. The filled AVFrame data
4529 * pointers will point to this buffer.
4531 * AVFrame extended_data channel pointers are allocated if necessary for
4534 * @param frame the AVFrame
4535 * frame->nb_samples must be set prior to calling the
4536 * function. This function fills in frame->data,
4537 * frame->extended_data, frame->linesize[0].
4538 * @param nb_channels channel count
4539 * @param sample_fmt sample format
4540 * @param buf buffer to use for frame data
4541 * @param buf_size size of buffer
4542 * @param align plane size sample alignment (0 = default)
4543 * @return >=0 on success, negative error code on failure
4544 * @todo return the size in bytes required to store the samples in
4545 * case of success, at the next libavutil bump
4547 int avcodec_fill_audio_frame(AVFrame *frame, int nb_channels,
4548 enum AVSampleFormat sample_fmt, const uint8_t *buf,
4549 int buf_size, int align);
4552 * Reset the internal decoder state / flush internal buffers. Should be called
4553 * e.g. when seeking or when switching to a different stream.
4555 * @note when refcounted frames are not used (i.e. avctx->refcounted_frames is 0),
4556 * this invalidates the frames previously returned from the decoder. When
4557 * refcounted frames are used, the decoder just releases any references it might
4558 * keep internally, but the caller's reference remains valid.
4560 void avcodec_flush_buffers(AVCodecContext *avctx);
4563 * Return codec bits per sample.
4565 * @param[in] codec_id the codec
4566 * @return Number of bits per sample or zero if unknown for the given codec.
4568 int av_get_bits_per_sample(enum AVCodecID codec_id);
4571 * Return the PCM codec associated with a sample format.
4572 * @param be endianness, 0 for little, 1 for big,
4573 * -1 (or anything else) for native
4574 * @return AV_CODEC_ID_PCM_* or AV_CODEC_ID_NONE
4576 enum AVCodecID av_get_pcm_codec(enum AVSampleFormat fmt, int be);
4579 * Return codec bits per sample.
4580 * Only return non-zero if the bits per sample is exactly correct, not an
4583 * @param[in] codec_id the codec
4584 * @return Number of bits per sample or zero if unknown for the given codec.
4586 int av_get_exact_bits_per_sample(enum AVCodecID codec_id);
4589 * Return audio frame duration.
4591 * @param avctx codec context
4592 * @param frame_bytes size of the frame, or 0 if unknown
4593 * @return frame duration, in samples, if known. 0 if not able to
4596 int av_get_audio_frame_duration(AVCodecContext *avctx, int frame_bytes);
4599 * This function is the same as av_get_audio_frame_duration(), except it works
4600 * with AVCodecParameters instead of an AVCodecContext.
4602 int av_get_audio_frame_duration2(AVCodecParameters *par, int frame_bytes);
4605 typedef struct AVBitStreamFilterContext {
4607 const struct AVBitStreamFilter *filter;
4608 AVCodecParserContext *parser;
4609 struct AVBitStreamFilterContext *next;
4611 * Internal default arguments, used if NULL is passed to av_bitstream_filter_filter().
4612 * Not for access by library users.
4615 } AVBitStreamFilterContext;
4618 typedef struct AVBSFInternal AVBSFInternal;
4621 * The bitstream filter state.
4623 * This struct must be allocated with av_bsf_alloc() and freed with
4626 * The fields in the struct will only be changed (by the caller or by the
4627 * filter) as described in their documentation, and are to be considered
4628 * immutable otherwise.
4630 typedef struct AVBSFContext {
4632 * A class for logging and AVOptions
4634 const AVClass *av_class;
4637 * The bitstream filter this context is an instance of.
4639 const struct AVBitStreamFilter *filter;
4642 * Opaque libavcodec internal data. Must not be touched by the caller in any
4645 AVBSFInternal *internal;
4648 * Opaque filter-specific private data. If filter->priv_class is non-NULL,
4649 * this is an AVOptions-enabled struct.
4654 * Parameters of the input stream. This field is allocated in
4655 * av_bsf_alloc(), it needs to be filled by the caller before
4658 AVCodecParameters *par_in;
4661 * Parameters of the output stream. This field is allocated in
4662 * av_bsf_alloc(), it is set by the filter in av_bsf_init().
4664 AVCodecParameters *par_out;
4667 * The timebase used for the timestamps of the input packets. Set by the
4668 * caller before av_bsf_init().
4670 AVRational time_base_in;
4673 * The timebase used for the timestamps of the output packets. Set by the
4674 * filter in av_bsf_init().
4676 AVRational time_base_out;
4679 typedef struct AVBitStreamFilter {
4683 * A list of codec ids supported by the filter, terminated by
4685 * May be NULL, in that case the bitstream filter works with any codec id.
4687 const enum AVCodecID *codec_ids;
4690 * A class for the private data, used to declare bitstream filter private
4691 * AVOptions. This field is NULL for bitstream filters that do not declare
4694 * If this field is non-NULL, the first member of the filter private data
4695 * must be a pointer to AVClass, which will be set by libavcodec generic
4696 * code to this class.
4698 const AVClass *priv_class;
4700 /*****************************************************************
4701 * No fields below this line are part of the public API. They
4702 * may not be used outside of libavcodec and can be changed and
4704 * New public fields should be added right above.
4705 *****************************************************************
4709 int (*init)(AVBSFContext *ctx);
4710 int (*filter)(AVBSFContext *ctx, AVPacket *pkt);
4711 void (*close)(AVBSFContext *ctx);
4712 void (*flush)(AVBSFContext *ctx);
4713 } AVBitStreamFilter;
4717 * @deprecated the old bitstream filtering API (using AVBitStreamFilterContext)
4718 * is deprecated. Use the new bitstream filtering API (using AVBSFContext).
4720 attribute_deprecated
4721 void av_register_bitstream_filter(AVBitStreamFilter *bsf);
4723 * @deprecated the old bitstream filtering API (using AVBitStreamFilterContext)
4724 * is deprecated. Use av_bsf_get_by_name(), av_bsf_alloc(), and av_bsf_init()
4725 * from the new bitstream filtering API (using AVBSFContext).
4727 attribute_deprecated
4728 AVBitStreamFilterContext *av_bitstream_filter_init(const char *name);
4730 * @deprecated the old bitstream filtering API (using AVBitStreamFilterContext)
4731 * is deprecated. Use av_bsf_send_packet() and av_bsf_receive_packet() from the
4732 * new bitstream filtering API (using AVBSFContext).
4734 attribute_deprecated
4735 int av_bitstream_filter_filter(AVBitStreamFilterContext *bsfc,
4736 AVCodecContext *avctx, const char *args,
4737 uint8_t **poutbuf, int *poutbuf_size,
4738 const uint8_t *buf, int buf_size, int keyframe);
4740 * @deprecated the old bitstream filtering API (using AVBitStreamFilterContext)
4741 * is deprecated. Use av_bsf_free() from the new bitstream filtering API (using
4744 attribute_deprecated
4745 void av_bitstream_filter_close(AVBitStreamFilterContext *bsf);
4747 * @deprecated the old bitstream filtering API (using AVBitStreamFilterContext)
4748 * is deprecated. Use av_bsf_iterate() from the new bitstream filtering API (using
4751 attribute_deprecated
4752 const AVBitStreamFilter *av_bitstream_filter_next(const AVBitStreamFilter *f);
4756 * @return a bitstream filter with the specified name or NULL if no such
4757 * bitstream filter exists.
4759 const AVBitStreamFilter *av_bsf_get_by_name(const char *name);
4762 * Iterate over all registered bitstream filters.
4764 * @param opaque a pointer where libavcodec will store the iteration state. Must
4765 * point to NULL to start the iteration.
4767 * @return the next registered bitstream filter or NULL when the iteration is
4770 const AVBitStreamFilter *av_bsf_iterate(void **opaque);
4772 attribute_deprecated
4773 const AVBitStreamFilter *av_bsf_next(void **opaque);
4777 * Allocate a context for a given bitstream filter. The caller must fill in the
4778 * context parameters as described in the documentation and then call
4779 * av_bsf_init() before sending any data to the filter.
4781 * @param filter the filter for which to allocate an instance.
4782 * @param ctx a pointer into which the pointer to the newly-allocated context
4783 * will be written. It must be freed with av_bsf_free() after the
4784 * filtering is done.
4786 * @return 0 on success, a negative AVERROR code on failure
4788 int av_bsf_alloc(const AVBitStreamFilter *filter, AVBSFContext **ctx);
4791 * Prepare the filter for use, after all the parameters and options have been
4794 int av_bsf_init(AVBSFContext *ctx);
4797 * Submit a packet for filtering.
4799 * After sending each packet, the filter must be completely drained by calling
4800 * av_bsf_receive_packet() repeatedly until it returns AVERROR(EAGAIN) or
4803 * @param pkt the packet to filter. The bitstream filter will take ownership of
4804 * the packet and reset the contents of pkt. pkt is not touched if an error occurs.
4805 * If pkt is empty (i.e. NULL, or pkt->data is NULL and pkt->side_data_elems zero),
4806 * it signals the end of the stream (i.e. no more non-empty packets will be sent;
4807 * sending more empty packets does nothing) and will cause the filter to output
4808 * any packets it may have buffered internally.
4810 * @return 0 on success, a negative AVERROR on error. This function never fails if
4813 int av_bsf_send_packet(AVBSFContext *ctx, AVPacket *pkt);
4816 * Retrieve a filtered packet.
4818 * @param[out] pkt this struct will be filled with the contents of the filtered
4819 * packet. It is owned by the caller and must be freed using
4820 * av_packet_unref() when it is no longer needed.
4821 * This parameter should be "clean" (i.e. freshly allocated
4822 * with av_packet_alloc() or unreffed with av_packet_unref())
4823 * when this function is called. If this function returns
4824 * successfully, the contents of pkt will be completely
4825 * overwritten by the returned data. On failure, pkt is not
4828 * @return 0 on success. AVERROR(EAGAIN) if more packets need to be sent to the
4829 * filter (using av_bsf_send_packet()) to get more output. AVERROR_EOF if there
4830 * will be no further output from the filter. Another negative AVERROR value if
4833 * @note one input packet may result in several output packets, so after sending
4834 * a packet with av_bsf_send_packet(), this function needs to be called
4835 * repeatedly until it stops returning 0. It is also possible for a filter to
4836 * output fewer packets than were sent to it, so this function may return
4837 * AVERROR(EAGAIN) immediately after a successful av_bsf_send_packet() call.
4839 int av_bsf_receive_packet(AVBSFContext *ctx, AVPacket *pkt);
4842 * Reset the internal bitstream filter state / flush internal buffers.
4844 void av_bsf_flush(AVBSFContext *ctx);
4847 * Free a bitstream filter context and everything associated with it; write NULL
4848 * into the supplied pointer.
4850 void av_bsf_free(AVBSFContext **ctx);
4853 * Get the AVClass for AVBSFContext. It can be used in combination with
4854 * AV_OPT_SEARCH_FAKE_OBJ for examining options.
4856 * @see av_opt_find().
4858 const AVClass *av_bsf_get_class(void);
4861 * Structure for chain/list of bitstream filters.
4862 * Empty list can be allocated by av_bsf_list_alloc().
4864 typedef struct AVBSFList AVBSFList;
4867 * Allocate empty list of bitstream filters.
4868 * The list must be later freed by av_bsf_list_free()
4869 * or finalized by av_bsf_list_finalize().
4871 * @return Pointer to @ref AVBSFList on success, NULL in case of failure
4873 AVBSFList *av_bsf_list_alloc(void);
4876 * Free list of bitstream filters.
4878 * @param lst Pointer to pointer returned by av_bsf_list_alloc()
4880 void av_bsf_list_free(AVBSFList **lst);
4883 * Append bitstream filter to the list of bitstream filters.
4885 * @param lst List to append to
4886 * @param bsf Filter context to be appended
4888 * @return >=0 on success, negative AVERROR in case of failure
4890 int av_bsf_list_append(AVBSFList *lst, AVBSFContext *bsf);
4893 * Construct new bitstream filter context given it's name and options
4894 * and append it to the list of bitstream filters.
4896 * @param lst List to append to
4897 * @param bsf_name Name of the bitstream filter
4898 * @param options Options for the bitstream filter, can be set to NULL
4900 * @return >=0 on success, negative AVERROR in case of failure
4902 int av_bsf_list_append2(AVBSFList *lst, const char * bsf_name, AVDictionary **options);
4904 * Finalize list of bitstream filters.
4906 * This function will transform @ref AVBSFList to single @ref AVBSFContext,
4907 * so the whole chain of bitstream filters can be treated as single filter
4908 * freshly allocated by av_bsf_alloc().
4909 * If the call is successful, @ref AVBSFList structure is freed and lst
4910 * will be set to NULL. In case of failure, caller is responsible for
4911 * freeing the structure by av_bsf_list_free()
4913 * @param lst Filter list structure to be transformed
4914 * @param[out] bsf Pointer to be set to newly created @ref AVBSFContext structure
4915 * representing the chain of bitstream filters
4917 * @return >=0 on success, negative AVERROR in case of failure
4919 int av_bsf_list_finalize(AVBSFList **lst, AVBSFContext **bsf);
4922 * Parse string describing list of bitstream filters and create single
4923 * @ref AVBSFContext describing the whole chain of bitstream filters.
4924 * Resulting @ref AVBSFContext can be treated as any other @ref AVBSFContext freshly
4925 * allocated by av_bsf_alloc().
4927 * @param str String describing chain of bitstream filters in format
4928 * `bsf1[=opt1=val1:opt2=val2][,bsf2]`
4929 * @param[out] bsf Pointer to be set to newly created @ref AVBSFContext structure
4930 * representing the chain of bitstream filters
4932 * @return >=0 on success, negative AVERROR in case of failure
4934 int av_bsf_list_parse_str(const char *str, AVBSFContext **bsf);
4937 * Get null/pass-through bitstream filter.
4939 * @param[out] bsf Pointer to be set to new instance of pass-through bitstream filter
4943 int av_bsf_get_null_filter(AVBSFContext **bsf);
4948 * Same behaviour av_fast_malloc but the buffer has additional
4949 * AV_INPUT_BUFFER_PADDING_SIZE at the end which will always be 0.
4951 * In addition the whole buffer will initially and after resizes
4952 * be 0-initialized so that no uninitialized data will ever appear.
4954 void av_fast_padded_malloc(void *ptr, unsigned int *size, size_t min_size);
4957 * Same behaviour av_fast_padded_malloc except that buffer will always
4958 * be 0-initialized after call.
4960 void av_fast_padded_mallocz(void *ptr, unsigned int *size, size_t min_size);
4963 * Encode extradata length to a buffer. Used by xiph codecs.
4965 * @param s buffer to write to; must be at least (v/255+1) bytes long
4966 * @param v size of extradata in bytes
4967 * @return number of bytes written to the buffer.
4969 unsigned int av_xiphlacing(unsigned char *s, unsigned int v);
4971 #if FF_API_USER_VISIBLE_AVHWACCEL
4973 * Register the hardware accelerator hwaccel.
4975 * @deprecated This function doesn't do anything.
4977 attribute_deprecated
4978 void av_register_hwaccel(AVHWAccel *hwaccel);
4981 * If hwaccel is NULL, returns the first registered hardware accelerator,
4982 * if hwaccel is non-NULL, returns the next registered hardware accelerator
4983 * after hwaccel, or NULL if hwaccel is the last one.
4985 * @deprecated AVHWaccel structures contain no user-serviceable parts, so
4986 * this function should not be used.
4988 attribute_deprecated
4989 AVHWAccel *av_hwaccel_next(const AVHWAccel *hwaccel);
4994 * Lock operation used by lockmgr
4996 * @deprecated Deprecated together with av_lockmgr_register().
4999 AV_LOCK_CREATE, ///< Create a mutex
5000 AV_LOCK_OBTAIN, ///< Lock the mutex
5001 AV_LOCK_RELEASE, ///< Unlock the mutex
5002 AV_LOCK_DESTROY, ///< Free mutex resources
5006 * Register a user provided lock manager supporting the operations
5007 * specified by AVLockOp. The "mutex" argument to the function points
5008 * to a (void *) where the lockmgr should store/get a pointer to a user
5009 * allocated mutex. It is NULL upon AV_LOCK_CREATE and equal to the
5010 * value left by the last call for all other ops. If the lock manager is
5011 * unable to perform the op then it should leave the mutex in the same
5012 * state as when it was called and return a non-zero value. However,
5013 * when called with AV_LOCK_DESTROY the mutex will always be assumed to
5014 * have been successfully destroyed. If av_lockmgr_register succeeds
5015 * it will return a non-negative value, if it fails it will return a
5016 * negative value and destroy all mutex and unregister all callbacks.
5017 * av_lockmgr_register is not thread-safe, it must be called from a
5018 * single thread before any calls which make use of locking are used.
5020 * @param cb User defined callback. av_lockmgr_register invokes calls
5021 * to this callback and the previously registered callback.
5022 * The callback will be used to create more than one mutex
5023 * each of which must be backed by its own underlying locking
5024 * mechanism (i.e. do not use a single static object to
5025 * implement your lock manager). If cb is set to NULL the
5026 * lockmgr will be unregistered.
5028 * @deprecated This function does nothing, and always returns 0. Be sure to
5029 * build with thread support to get basic thread safety.
5031 attribute_deprecated
5032 int av_lockmgr_register(int (*cb)(void **mutex, enum AVLockOp op));
5036 * Get the type of the given codec.
5038 enum AVMediaType avcodec_get_type(enum AVCodecID codec_id);
5041 * Get the name of a codec.
5042 * @return a static string identifying the codec; never NULL
5044 const char *avcodec_get_name(enum AVCodecID id);
5047 * @return a positive value if s is open (i.e. avcodec_open2() was called on it
5048 * with no corresponding avcodec_close()), 0 otherwise.
5050 int avcodec_is_open(AVCodecContext *s);
5053 * @return a non-zero number if codec is an encoder, zero otherwise
5055 int av_codec_is_encoder(const AVCodec *codec);
5058 * @return a non-zero number if codec is a decoder, zero otherwise
5060 int av_codec_is_decoder(const AVCodec *codec);
5063 * @return descriptor for given codec ID or NULL if no descriptor exists.
5065 const AVCodecDescriptor *avcodec_descriptor_get(enum AVCodecID id);
5068 * Iterate over all codec descriptors known to libavcodec.
5070 * @param prev previous descriptor. NULL to get the first descriptor.
5072 * @return next descriptor or NULL after the last descriptor
5074 const AVCodecDescriptor *avcodec_descriptor_next(const AVCodecDescriptor *prev);
5077 * @return codec descriptor with the given name or NULL if no such descriptor
5080 const AVCodecDescriptor *avcodec_descriptor_get_by_name(const char *name);
5083 * Allocate a CPB properties structure and initialize its fields to default
5086 * @param size if non-NULL, the size of the allocated struct will be written
5087 * here. This is useful for embedding it in side data.
5089 * @return the newly allocated struct or NULL on failure
5091 AVCPBProperties *av_cpb_properties_alloc(size_t *size);
5097 #endif /* AVCODEC_AVCODEC_H */