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"
44 #include "codec_desc.h"
45 #include "codec_par.h"
51 * @defgroup libavc libavcodec
52 * Encoding/Decoding Library
56 * @defgroup lavc_decoding Decoding
60 * @defgroup lavc_encoding Encoding
64 * @defgroup lavc_codec Codecs
66 * @defgroup lavc_codec_native Native Codecs
69 * @defgroup lavc_codec_wrappers External library wrappers
72 * @defgroup lavc_codec_hwaccel Hardware Accelerators bridge
76 * @defgroup lavc_internal Internal
84 * @defgroup lavc_encdec send/receive encoding and decoding API overview
87 * The avcodec_send_packet()/avcodec_receive_frame()/avcodec_send_frame()/
88 * avcodec_receive_packet() functions provide an encode/decode API, which
89 * decouples input and output.
91 * The API is very similar for encoding/decoding and audio/video, and works as
93 * - Set up and open the AVCodecContext as usual.
95 * - For decoding, call avcodec_send_packet() to give the decoder raw
96 * compressed data in an AVPacket.
97 * - For encoding, call avcodec_send_frame() to give the encoder an AVFrame
98 * containing uncompressed audio or video.
100 * In both cases, it is recommended that AVPackets and AVFrames are
101 * refcounted, or libavcodec might have to copy the input data. (libavformat
102 * always returns refcounted AVPackets, and av_frame_get_buffer() allocates
103 * refcounted AVFrames.)
104 * - Receive output in a loop. Periodically call one of the avcodec_receive_*()
105 * functions and process their output:
106 * - For decoding, call avcodec_receive_frame(). On success, it will return
107 * an AVFrame containing uncompressed audio or video data.
108 * - For encoding, call avcodec_receive_packet(). On success, it will return
109 * an AVPacket with a compressed frame.
111 * Repeat this call until it returns AVERROR(EAGAIN) or an error. The
112 * AVERROR(EAGAIN) return value means that new input data is required to
113 * return new output. In this case, continue with sending input. For each
114 * input frame/packet, the codec will typically return 1 output frame/packet,
115 * but it can also be 0 or more than 1.
117 * At the beginning of decoding or encoding, the codec might accept multiple
118 * input frames/packets without returning a frame, until its internal buffers
119 * are filled. This situation is handled transparently if you follow the steps
122 * In theory, sending input can result in EAGAIN - this should happen only if
123 * not all output was received. You can use this to structure alternative decode
124 * or encode loops other than the one suggested above. For example, you could
125 * try sending new input on each iteration, and try to receive output if that
128 * End of stream situations. These require "flushing" (aka draining) the codec,
129 * as the codec might buffer multiple frames or packets internally for
130 * performance or out of necessity (consider B-frames).
131 * This is handled as follows:
132 * - Instead of valid input, send NULL to the avcodec_send_packet() (decoding)
133 * or avcodec_send_frame() (encoding) functions. This will enter draining
135 * - Call avcodec_receive_frame() (decoding) or avcodec_receive_packet()
136 * (encoding) in a loop until AVERROR_EOF is returned. The functions will
137 * not return AVERROR(EAGAIN), unless you forgot to enter draining mode.
138 * - Before decoding can be resumed again, the codec has to be reset with
139 * avcodec_flush_buffers().
141 * Using the API as outlined above is highly recommended. But it is also
142 * possible to call functions outside of this rigid schema. For example, you can
143 * call avcodec_send_packet() repeatedly without calling
144 * avcodec_receive_frame(). In this case, avcodec_send_packet() will succeed
145 * until the codec's internal buffer has been filled up (which is typically of
146 * size 1 per output frame, after initial input), and then reject input with
147 * AVERROR(EAGAIN). Once it starts rejecting input, you have no choice but to
148 * read at least some output.
150 * Not all codecs will follow a rigid and predictable dataflow; the only
151 * guarantee is that an AVERROR(EAGAIN) return value on a send/receive call on
152 * one end implies that a receive/send call on the other end will succeed, or
153 * at least will not fail with AVERROR(EAGAIN). In general, no codec will
154 * permit unlimited buffering of input or output.
156 * This API replaces the following legacy functions:
157 * - avcodec_decode_video2() and avcodec_decode_audio4():
158 * Use avcodec_send_packet() to feed input to the decoder, then use
159 * avcodec_receive_frame() to receive decoded frames after each packet.
160 * Unlike with the old video decoding API, multiple frames might result from
161 * a packet. For audio, splitting the input packet into frames by partially
162 * decoding packets becomes transparent to the API user. You never need to
163 * feed an AVPacket to the API twice (unless it is rejected with AVERROR(EAGAIN) - then
164 * no data was read from the packet).
165 * Additionally, sending a flush/draining packet is required only once.
166 * - avcodec_encode_video2()/avcodec_encode_audio2():
167 * Use avcodec_send_frame() to feed input to the encoder, then use
168 * avcodec_receive_packet() to receive encoded packets.
169 * Providing user-allocated buffers for avcodec_receive_packet() is not
171 * - The new API does not handle subtitles yet.
173 * Mixing new and old function calls on the same AVCodecContext is not allowed,
174 * and will result in undefined behavior.
176 * Some codecs might require using the new API; using the old API will return
177 * an error when calling it. All codecs support the new API.
179 * A codec is not allowed to return AVERROR(EAGAIN) for both sending and receiving. This
180 * would be an invalid state, which could put the codec user into an endless
181 * loop. The API has no concept of time either: it cannot happen that trying to
182 * do avcodec_send_packet() results in AVERROR(EAGAIN), but a repeated call 1 second
183 * later accepts the packet (with no other receive/flush API calls involved).
184 * The API is a strict state machine, and the passage of time is not supposed
185 * to influence it. Some timing-dependent behavior might still be deemed
186 * acceptable in certain cases. But it must never result in both send/receive
187 * returning EAGAIN at the same time at any point. It must also absolutely be
188 * avoided that the current state is "unstable" and can "flip-flop" between
189 * the send/receive APIs allowing progress. For example, it's not allowed that
190 * the codec randomly decides that it actually wants to consume a packet now
191 * instead of returning a frame, after it just returned AVERROR(EAGAIN) on an
192 * avcodec_send_packet() call.
197 * @defgroup lavc_core Core functions/structures.
200 * Basic definitions, functions for querying libavcodec capabilities,
201 * allocating core structures, etc.
206 * @ingroup lavc_decoding
207 * Required number of additionally allocated bytes at the end of the input bitstream for decoding.
208 * This is mainly needed because some optimized bitstream readers read
209 * 32 or 64 bit at once and could read over the end.<br>
210 * Note: If the first 23 bits of the additional bytes are not 0, then damaged
211 * MPEG bitstreams could cause overread and segfault.
213 #define AV_INPUT_BUFFER_PADDING_SIZE 64
216 * @ingroup lavc_encoding
217 * minimum encoding buffer size
218 * Used to avoid some checks during header writing.
220 #define AV_INPUT_BUFFER_MIN_SIZE 16384
223 * @ingroup lavc_decoding
226 /* We leave some space between them for extensions (drop some
227 * keyframes for intra-only or drop just some bidir frames). */
228 AVDISCARD_NONE =-16, ///< discard nothing
229 AVDISCARD_DEFAULT = 0, ///< discard useless packets like 0 size packets in avi
230 AVDISCARD_NONREF = 8, ///< discard all non reference
231 AVDISCARD_BIDIR = 16, ///< discard all bidirectional frames
232 AVDISCARD_NONINTRA= 24, ///< discard all non intra frames
233 AVDISCARD_NONKEY = 32, ///< discard all frames except keyframes
234 AVDISCARD_ALL = 48, ///< discard all
237 enum AVAudioServiceType {
238 AV_AUDIO_SERVICE_TYPE_MAIN = 0,
239 AV_AUDIO_SERVICE_TYPE_EFFECTS = 1,
240 AV_AUDIO_SERVICE_TYPE_VISUALLY_IMPAIRED = 2,
241 AV_AUDIO_SERVICE_TYPE_HEARING_IMPAIRED = 3,
242 AV_AUDIO_SERVICE_TYPE_DIALOGUE = 4,
243 AV_AUDIO_SERVICE_TYPE_COMMENTARY = 5,
244 AV_AUDIO_SERVICE_TYPE_EMERGENCY = 6,
245 AV_AUDIO_SERVICE_TYPE_VOICE_OVER = 7,
246 AV_AUDIO_SERVICE_TYPE_KARAOKE = 8,
247 AV_AUDIO_SERVICE_TYPE_NB , ///< Not part of ABI
251 * @ingroup lavc_encoding
253 typedef struct RcOverride{
256 int qscale; // If this is 0 then quality_factor will be used instead.
257 float quality_factor;
261 These flags can be passed in AVCodecContext.flags before initialization.
262 Note: Not everything is supported yet.
266 * Allow decoders to produce frames with data planes that are not aligned
267 * to CPU requirements (e.g. due to cropping).
269 #define AV_CODEC_FLAG_UNALIGNED (1 << 0)
273 #define AV_CODEC_FLAG_QSCALE (1 << 1)
275 * 4 MV per MB allowed / advanced prediction for H.263.
277 #define AV_CODEC_FLAG_4MV (1 << 2)
279 * Output even those frames that might be corrupted.
281 #define AV_CODEC_FLAG_OUTPUT_CORRUPT (1 << 3)
285 #define AV_CODEC_FLAG_QPEL (1 << 4)
287 * Don't output frames whose parameters differ from first
288 * decoded frame in stream.
290 #define AV_CODEC_FLAG_DROPCHANGED (1 << 5)
292 * Use internal 2pass ratecontrol in first pass mode.
294 #define AV_CODEC_FLAG_PASS1 (1 << 9)
296 * Use internal 2pass ratecontrol in second pass mode.
298 #define AV_CODEC_FLAG_PASS2 (1 << 10)
302 #define AV_CODEC_FLAG_LOOP_FILTER (1 << 11)
304 * Only decode/encode grayscale.
306 #define AV_CODEC_FLAG_GRAY (1 << 13)
308 * error[?] variables will be set during encoding.
310 #define AV_CODEC_FLAG_PSNR (1 << 15)
312 * Input bitstream might be truncated at a random location
313 * instead of only at frame boundaries.
315 #define AV_CODEC_FLAG_TRUNCATED (1 << 16)
317 * Use interlaced DCT.
319 #define AV_CODEC_FLAG_INTERLACED_DCT (1 << 18)
323 #define AV_CODEC_FLAG_LOW_DELAY (1 << 19)
325 * Place global headers in extradata instead of every keyframe.
327 #define AV_CODEC_FLAG_GLOBAL_HEADER (1 << 22)
329 * Use only bitexact stuff (except (I)DCT).
331 #define AV_CODEC_FLAG_BITEXACT (1 << 23)
332 /* Fx : Flag for H.263+ extra options */
334 * H.263 advanced intra coding / MPEG-4 AC prediction
336 #define AV_CODEC_FLAG_AC_PRED (1 << 24)
338 * interlaced motion estimation
340 #define AV_CODEC_FLAG_INTERLACED_ME (1 << 29)
341 #define AV_CODEC_FLAG_CLOSED_GOP (1U << 31)
344 * Allow non spec compliant speedup tricks.
346 #define AV_CODEC_FLAG2_FAST (1 << 0)
348 * Skip bitstream encoding.
350 #define AV_CODEC_FLAG2_NO_OUTPUT (1 << 2)
352 * Place global headers at every keyframe instead of in extradata.
354 #define AV_CODEC_FLAG2_LOCAL_HEADER (1 << 3)
357 * timecode is in drop frame format. DEPRECATED!!!!
359 #define AV_CODEC_FLAG2_DROP_FRAME_TIMECODE (1 << 13)
362 * Input bitstream might be truncated at a packet boundaries
363 * instead of only at frame boundaries.
365 #define AV_CODEC_FLAG2_CHUNKS (1 << 15)
367 * Discard cropping information from SPS.
369 #define AV_CODEC_FLAG2_IGNORE_CROP (1 << 16)
372 * Show all frames before the first keyframe
374 #define AV_CODEC_FLAG2_SHOW_ALL (1 << 22)
376 * Export motion vectors through frame side data
378 #define AV_CODEC_FLAG2_EXPORT_MVS (1 << 28)
380 * Do not skip samples and export skip information as frame side data
382 #define AV_CODEC_FLAG2_SKIP_MANUAL (1 << 29)
384 * Do not reset ASS ReadOrder field on flush (subtitles decoding)
386 #define AV_CODEC_FLAG2_RO_FLUSH_NOOP (1 << 30)
388 /* Unsupported options :
389 * Syntax Arithmetic coding (SAC)
390 * Reference Picture Selection
391 * Independent Segment Decoding */
393 /* codec capabilities */
396 * Decoder can use draw_horiz_band callback.
398 #define AV_CODEC_CAP_DRAW_HORIZ_BAND (1 << 0)
400 * Codec uses get_buffer() for allocating buffers and supports custom allocators.
401 * If not set, it might not use get_buffer() at all or use operations that
402 * assume the buffer was allocated by avcodec_default_get_buffer.
404 #define AV_CODEC_CAP_DR1 (1 << 1)
405 #define AV_CODEC_CAP_TRUNCATED (1 << 3)
407 * Encoder or decoder requires flushing with NULL input at the end in order to
408 * give the complete and correct output.
410 * NOTE: If this flag is not set, the codec is guaranteed to never be fed with
411 * with NULL data. The user can still send NULL data to the public encode
412 * or decode function, but libavcodec will not pass it along to the codec
413 * unless this flag is set.
416 * The decoder has a non-zero delay and needs to be fed with avpkt->data=NULL,
417 * avpkt->size=0 at the end to get the delayed data until the decoder no longer
421 * The encoder needs to be fed with NULL data at the end of encoding until the
422 * encoder no longer returns data.
424 * NOTE: For encoders implementing the AVCodec.encode2() function, setting this
425 * flag also means that the encoder must set the pts and duration for
426 * each output packet. If this flag is not set, the pts and duration will
427 * be determined by libavcodec from the input frame.
429 #define AV_CODEC_CAP_DELAY (1 << 5)
431 * Codec can be fed a final frame with a smaller size.
432 * This can be used to prevent truncation of the last audio samples.
434 #define AV_CODEC_CAP_SMALL_LAST_FRAME (1 << 6)
437 * Codec can output multiple frames per AVPacket
438 * Normally demuxers return one frame at a time, demuxers which do not do
439 * are connected to a parser to split what they return into proper frames.
440 * This flag is reserved to the very rare category of codecs which have a
441 * bitstream that cannot be split into frames without timeconsuming
442 * operations like full decoding. Demuxers carrying such bitstreams thus
443 * may return multiple frames in a packet. This has many disadvantages like
444 * prohibiting stream copy in many cases thus it should only be considered
447 #define AV_CODEC_CAP_SUBFRAMES (1 << 8)
449 * Codec is experimental and is thus avoided in favor of non experimental
452 #define AV_CODEC_CAP_EXPERIMENTAL (1 << 9)
454 * Codec should fill in channel configuration and samplerate instead of container
456 #define AV_CODEC_CAP_CHANNEL_CONF (1 << 10)
458 * Codec supports frame-level multithreading.
460 #define AV_CODEC_CAP_FRAME_THREADS (1 << 12)
462 * Codec supports slice-based (or partition-based) multithreading.
464 #define AV_CODEC_CAP_SLICE_THREADS (1 << 13)
466 * Codec supports changed parameters at any point.
468 #define AV_CODEC_CAP_PARAM_CHANGE (1 << 14)
470 * Codec supports avctx->thread_count == 0 (auto).
472 #define AV_CODEC_CAP_AUTO_THREADS (1 << 15)
474 * Audio encoder supports receiving a different number of samples in each call.
476 #define AV_CODEC_CAP_VARIABLE_FRAME_SIZE (1 << 16)
478 * Decoder is not a preferred choice for probing.
479 * This indicates that the decoder is not a good choice for probing.
480 * It could for example be an expensive to spin up hardware decoder,
481 * or it could simply not provide a lot of useful information about
483 * A decoder marked with this flag should only be used as last resort
484 * choice for probing.
486 #define AV_CODEC_CAP_AVOID_PROBING (1 << 17)
488 #if FF_API_UNUSED_CODEC_CAPS
490 * Deprecated and unused. Use AVCodecDescriptor.props instead
492 #define AV_CODEC_CAP_INTRA_ONLY 0x40000000
494 * Deprecated and unused. Use AVCodecDescriptor.props instead
496 #define AV_CODEC_CAP_LOSSLESS 0x80000000
500 * Codec is backed by a hardware implementation. Typically used to
501 * identify a non-hwaccel hardware decoder. For information about hwaccels, use
502 * avcodec_get_hw_config() instead.
504 #define AV_CODEC_CAP_HARDWARE (1 << 18)
507 * Codec is potentially backed by a hardware implementation, but not
508 * necessarily. This is used instead of AV_CODEC_CAP_HARDWARE, if the
509 * implementation provides some sort of internal fallback.
511 #define AV_CODEC_CAP_HYBRID (1 << 19)
514 * This codec takes the reordered_opaque field from input AVFrames
515 * and returns it in the corresponding field in AVCodecContext after
518 #define AV_CODEC_CAP_ENCODER_REORDERED_OPAQUE (1 << 20)
521 * This encoder can be flushed using avcodec_flush_buffers(). If this flag is
522 * not set, the encoder must be closed and reopened to ensure that no frames
525 #define AV_CODEC_CAP_ENCODER_FLUSH (1 << 21)
527 /* Exported side data.
528 These flags can be passed in AVCodecContext.export_side_data before initialization.
531 * Export motion vectors through frame side data
533 #define AV_CODEC_EXPORT_DATA_MVS (1 << 0)
535 * Export encoder Producer Reference Time through packet side data
537 #define AV_CODEC_EXPORT_DATA_PRFT (1 << 1)
540 * Export the AVVideoEncParams structure through frame side data.
542 #define AV_CODEC_EXPORT_DATA_VIDEO_ENC_PARAMS (1 << 2)
546 * This specifies the area which should be displayed.
547 * Note there may be multiple such areas for one frame.
549 typedef struct AVPanScan {
552 * - encoding: Set by user.
553 * - decoding: Set by libavcodec.
558 * width and height in 1/16 pel
559 * - encoding: Set by user.
560 * - decoding: Set by libavcodec.
566 * position of the top left corner in 1/16 pel for up to 3 fields/frames
567 * - encoding: Set by user.
568 * - decoding: Set by libavcodec.
570 int16_t position[3][2];
574 * This structure describes the bitrate properties of an encoded bitstream. It
575 * roughly corresponds to a subset the VBV parameters for MPEG-2 or HRD
576 * parameters for H.264/HEVC.
578 typedef struct AVCPBProperties {
580 * Maximum bitrate of the stream, in bits per second.
581 * Zero if unknown or unspecified.
583 #if FF_API_UNSANITIZED_BITRATES
589 * Minimum bitrate of the stream, in bits per second.
590 * Zero if unknown or unspecified.
592 #if FF_API_UNSANITIZED_BITRATES
598 * Average bitrate of the stream, in bits per second.
599 * Zero if unknown or unspecified.
601 #if FF_API_UNSANITIZED_BITRATES
608 * The size of the buffer to which the ratecontrol is applied, in bits.
609 * Zero if unknown or unspecified.
614 * The delay between the time the packet this structure is associated with
615 * is received and the time when it should be decoded, in periods of a 27MHz
618 * UINT64_MAX when unknown or unspecified.
624 * This structure supplies correlation between a packet timestamp and a wall clock
625 * production time. The definition follows the Producer Reference Time ('prft')
626 * as defined in ISO/IEC 14496-12
628 typedef struct AVProducerReferenceTime {
630 * A UTC timestamp, in microseconds, since Unix epoch (e.g, av_gettime()).
634 } AVProducerReferenceTime;
637 * The decoder will keep a reference to the frame and may reuse it later.
639 #define AV_GET_BUFFER_FLAG_REF (1 << 0)
641 struct AVCodecInternal;
644 * main external API structure.
645 * New fields can be added to the end with minor version bumps.
646 * Removal, reordering and changes to existing fields require a major
648 * You can use AVOptions (av_opt* / av_set/get*()) to access these fields from user
650 * The name string for AVOptions options matches the associated command line
651 * parameter name and can be found in libavcodec/options_table.h
652 * The AVOption/command line parameter names differ in some cases from the C
653 * structure field names for historic reasons or brevity.
654 * sizeof(AVCodecContext) must not be used outside libav*.
656 typedef struct AVCodecContext {
658 * information on struct for av_log
659 * - set by avcodec_alloc_context3
661 const AVClass *av_class;
662 int log_level_offset;
664 enum AVMediaType codec_type; /* see AVMEDIA_TYPE_xxx */
665 const struct AVCodec *codec;
666 enum AVCodecID codec_id; /* see AV_CODEC_ID_xxx */
669 * fourcc (LSB first, so "ABCD" -> ('D'<<24) + ('C'<<16) + ('B'<<8) + 'A').
670 * This is used to work around some encoder bugs.
671 * A demuxer should set this to what is stored in the field used to identify the codec.
672 * If there are multiple such fields in a container then the demuxer should choose the one
673 * which maximizes the information about the used codec.
674 * If the codec tag field in a container is larger than 32 bits then the demuxer should
675 * remap the longer ID to 32 bits with a table or other structure. Alternatively a new
676 * extra_codec_tag + size could be added but for this a clear advantage must be demonstrated
678 * - encoding: Set by user, if not then the default based on codec_id will be used.
679 * - decoding: Set by user, will be converted to uppercase by libavcodec during init.
681 unsigned int codec_tag;
686 * Private context used for internal data.
688 * Unlike priv_data, this is not codec-specific. It is used in general
689 * libavcodec functions.
691 struct AVCodecInternal *internal;
694 * Private data of the user, can be used to carry app specific stuff.
695 * - encoding: Set by user.
696 * - decoding: Set by user.
701 * the average bitrate
702 * - encoding: Set by user; unused for constant quantizer encoding.
703 * - decoding: Set by user, may be overwritten by libavcodec
704 * if this info is available in the stream
709 * number of bits the bitstream is allowed to diverge from the reference.
710 * the reference can be CBR (for CBR pass1) or VBR (for pass2)
711 * - encoding: Set by user; unused for constant quantizer encoding.
714 int bit_rate_tolerance;
717 * Global quality for codecs which cannot change it per frame.
718 * This should be proportional to MPEG-1/2/4 qscale.
719 * - encoding: Set by user.
725 * - encoding: Set by user.
728 int compression_level;
729 #define FF_COMPRESSION_DEFAULT -1
733 * - encoding: Set by user.
734 * - decoding: Set by user.
740 * - encoding: Set by user.
741 * - decoding: Set by user.
746 * some codecs need / can use extradata like Huffman tables.
747 * MJPEG: Huffman tables
748 * rv10: additional flags
749 * MPEG-4: global headers (they can be in the bitstream or here)
750 * The allocated memory should be AV_INPUT_BUFFER_PADDING_SIZE bytes larger
751 * than extradata_size to avoid problems if it is read with the bitstream reader.
752 * The bytewise contents of extradata must not depend on the architecture or CPU endianness.
753 * Must be allocated with the av_malloc() family of functions.
754 * - encoding: Set/allocated/freed by libavcodec.
755 * - decoding: Set/allocated/freed by user.
761 * This is the fundamental unit of time (in seconds) in terms
762 * of which frame timestamps are represented. For fixed-fps content,
763 * timebase should be 1/framerate and timestamp increments should be
765 * This often, but not always is the inverse of the frame rate or field rate
766 * for video. 1/time_base is not the average frame rate if the frame rate is not
769 * Like containers, elementary streams also can store timestamps, 1/time_base
770 * is the unit in which these timestamps are specified.
771 * As example of such codec time base see ISO/IEC 14496-2:2001(E)
772 * vop_time_increment_resolution and fixed_vop_rate
773 * (fixed_vop_rate == 0 implies that it is different from the framerate)
775 * - encoding: MUST be set by user.
776 * - decoding: the use of this field for decoding is deprecated.
777 * Use framerate instead.
779 AVRational time_base;
782 * For some codecs, the time base is closer to the field rate than the frame rate.
783 * Most notably, H.264 and MPEG-2 specify time_base as half of frame duration
784 * if no telecine is used ...
786 * Set to time_base ticks per frame. Default 1, e.g., H.264/MPEG-2 set it to 2.
793 * Encoding: Number of frames delay there will be from the encoder input to
794 * the decoder output. (we assume the decoder matches the spec)
795 * Decoding: Number of frames delay in addition to what a standard decoder
796 * as specified in the spec would produce.
799 * Number of frames the decoded output will be delayed relative to the
803 * For encoding, this field is unused (see initial_padding).
805 * For decoding, this is the number of samples the decoder needs to
806 * output before the decoder's output is valid. When seeking, you should
807 * start decoding this many samples prior to your desired seek point.
809 * - encoding: Set by libavcodec.
810 * - decoding: Set by libavcodec.
817 * picture width / height.
819 * @note Those fields may not match the values of the last
820 * AVFrame output by avcodec_decode_video2 due frame
823 * - encoding: MUST be set by user.
824 * - decoding: May be set by the user before opening the decoder if known e.g.
825 * from the container. Some decoders will require the dimensions
826 * to be set by the caller. During decoding, the decoder may
827 * overwrite those values as required while parsing the data.
832 * Bitstream width / height, may be different from width/height e.g. when
833 * the decoded frame is cropped before being output or lowres is enabled.
835 * @note Those field may not match the value of the last
836 * AVFrame output by avcodec_receive_frame() due frame
840 * - decoding: May be set by the user before opening the decoder if known
841 * e.g. from the container. During decoding, the decoder may
842 * overwrite those values as required while parsing the data.
844 int coded_width, coded_height;
847 * the number of pictures in a group of pictures, or 0 for intra_only
848 * - encoding: Set by user.
854 * Pixel format, see AV_PIX_FMT_xxx.
855 * May be set by the demuxer if known from headers.
856 * May be overridden by the decoder if it knows better.
858 * @note This field may not match the value of the last
859 * AVFrame output by avcodec_receive_frame() due frame
862 * - encoding: Set by user.
863 * - decoding: Set by user if known, overridden by libavcodec while
866 enum AVPixelFormat pix_fmt;
869 * If non NULL, 'draw_horiz_band' is called by the libavcodec
870 * decoder to draw a horizontal band. It improves cache usage. Not
871 * all codecs can do that. You must check the codec capabilities
873 * When multithreading is used, it may be called from multiple threads
874 * at the same time; threads might draw different parts of the same AVFrame,
875 * or multiple AVFrames, and there is no guarantee that slices will be drawn
877 * The function is also used by hardware acceleration APIs.
878 * It is called at least once during frame decoding to pass
879 * the data needed for hardware render.
880 * In that mode instead of pixel data, AVFrame points to
881 * a structure specific to the acceleration API. The application
882 * reads the structure and can change some fields to indicate progress
885 * - decoding: Set by user.
886 * @param height the height of the slice
887 * @param y the y position of the slice
888 * @param type 1->top field, 2->bottom field, 3->frame
889 * @param offset offset into the AVFrame.data from which the slice should be read
891 void (*draw_horiz_band)(struct AVCodecContext *s,
892 const AVFrame *src, int offset[AV_NUM_DATA_POINTERS],
893 int y, int type, int height);
896 * callback to negotiate the pixelFormat
897 * @param fmt is the list of formats which are supported by the codec,
898 * it is terminated by -1 as 0 is a valid format, the formats are ordered by quality.
899 * The first is always the native one.
900 * @note The callback may be called again immediately if initialization for
901 * the selected (hardware-accelerated) pixel format failed.
902 * @warning Behavior is undefined if the callback returns a value not
903 * in the fmt list of formats.
904 * @return the chosen format
906 * - decoding: Set by user, if not set the native format will be chosen.
908 enum AVPixelFormat (*get_format)(struct AVCodecContext *s, const enum AVPixelFormat * fmt);
911 * maximum number of B-frames between non-B-frames
912 * Note: The output will be delayed by max_b_frames+1 relative to the input.
913 * - encoding: Set by user.
919 * qscale factor between IP and B-frames
920 * If > 0 then the last P-frame quantizer will be used (q= lastp_q*factor+offset).
921 * If < 0 then normal ratecontrol will be done (q= -normal_q*factor+offset).
922 * - encoding: Set by user.
925 float b_quant_factor;
927 #if FF_API_PRIVATE_OPT
928 /** @deprecated use encoder private options instead */
930 int b_frame_strategy;
934 * qscale offset between IP and B-frames
935 * - encoding: Set by user.
938 float b_quant_offset;
941 * Size of the frame reordering buffer in the decoder.
942 * For MPEG-2 it is 1 IPB or 0 low delay IP.
943 * - encoding: Set by libavcodec.
944 * - decoding: Set by libavcodec.
948 #if FF_API_PRIVATE_OPT
949 /** @deprecated use encoder private options instead */
955 * qscale factor between P- and I-frames
956 * If > 0 then the last P-frame quantizer will be used (q = lastp_q * factor + offset).
957 * If < 0 then normal ratecontrol will be done (q= -normal_q*factor+offset).
958 * - encoding: Set by user.
961 float i_quant_factor;
964 * qscale offset between P and I-frames
965 * - encoding: Set by user.
968 float i_quant_offset;
971 * luminance masking (0-> disabled)
972 * - encoding: Set by user.
978 * temporary complexity masking (0-> disabled)
979 * - encoding: Set by user.
982 float temporal_cplx_masking;
985 * spatial complexity masking (0-> disabled)
986 * - encoding: Set by user.
989 float spatial_cplx_masking;
992 * p block masking (0-> disabled)
993 * - encoding: Set by user.
999 * darkness masking (0-> disabled)
1000 * - encoding: Set by user.
1001 * - decoding: unused
1007 * - encoding: Set by libavcodec.
1008 * - decoding: Set by user (or 0).
1012 #if FF_API_PRIVATE_OPT
1013 /** @deprecated use encoder private options instead */
1014 attribute_deprecated
1015 int prediction_method;
1016 #define FF_PRED_LEFT 0
1017 #define FF_PRED_PLANE 1
1018 #define FF_PRED_MEDIAN 2
1022 * slice offsets in the frame in bytes
1023 * - encoding: Set/allocated by libavcodec.
1024 * - decoding: Set/allocated by user (or NULL).
1029 * sample aspect ratio (0 if unknown)
1030 * That is the width of a pixel divided by the height of the pixel.
1031 * Numerator and denominator must be relatively prime and smaller than 256 for some video standards.
1032 * - encoding: Set by user.
1033 * - decoding: Set by libavcodec.
1035 AVRational sample_aspect_ratio;
1038 * motion estimation comparison function
1039 * - encoding: Set by user.
1040 * - decoding: unused
1044 * subpixel motion estimation comparison function
1045 * - encoding: Set by user.
1046 * - decoding: unused
1050 * macroblock comparison function (not supported yet)
1051 * - encoding: Set by user.
1052 * - decoding: unused
1056 * interlaced DCT comparison function
1057 * - encoding: Set by user.
1058 * - decoding: unused
1061 #define FF_CMP_SAD 0
1062 #define FF_CMP_SSE 1
1063 #define FF_CMP_SATD 2
1064 #define FF_CMP_DCT 3
1065 #define FF_CMP_PSNR 4
1066 #define FF_CMP_BIT 5
1068 #define FF_CMP_ZERO 7
1069 #define FF_CMP_VSAD 8
1070 #define FF_CMP_VSSE 9
1071 #define FF_CMP_NSSE 10
1072 #define FF_CMP_W53 11
1073 #define FF_CMP_W97 12
1074 #define FF_CMP_DCTMAX 13
1075 #define FF_CMP_DCT264 14
1076 #define FF_CMP_MEDIAN_SAD 15
1077 #define FF_CMP_CHROMA 256
1080 * ME diamond size & shape
1081 * - encoding: Set by user.
1082 * - decoding: unused
1087 * amount of previous MV predictors (2a+1 x 2a+1 square)
1088 * - encoding: Set by user.
1089 * - decoding: unused
1091 int last_predictor_count;
1093 #if FF_API_PRIVATE_OPT
1094 /** @deprecated use encoder private options instead */
1095 attribute_deprecated
1100 * motion estimation prepass comparison function
1101 * - encoding: Set by user.
1102 * - decoding: unused
1107 * ME prepass diamond size & shape
1108 * - encoding: Set by user.
1109 * - decoding: unused
1115 * - encoding: Set by user.
1116 * - decoding: unused
1118 int me_subpel_quality;
1121 * maximum motion estimation search range in subpel units
1122 * If 0 then no limit.
1124 * - encoding: Set by user.
1125 * - decoding: unused
1131 * - encoding: unused
1132 * - decoding: Set by user.
1135 #define SLICE_FLAG_CODED_ORDER 0x0001 ///< draw_horiz_band() is called in coded order instead of display
1136 #define SLICE_FLAG_ALLOW_FIELD 0x0002 ///< allow draw_horiz_band() with field slices (MPEG-2 field pics)
1137 #define SLICE_FLAG_ALLOW_PLANE 0x0004 ///< allow draw_horiz_band() with 1 component at a time (SVQ1)
1140 * macroblock decision mode
1141 * - encoding: Set by user.
1142 * - decoding: unused
1145 #define FF_MB_DECISION_SIMPLE 0 ///< uses mb_cmp
1146 #define FF_MB_DECISION_BITS 1 ///< chooses the one which needs the fewest bits
1147 #define FF_MB_DECISION_RD 2 ///< rate distortion
1150 * custom intra quantization matrix
1151 * Must be allocated with the av_malloc() family of functions, and will be freed in
1152 * avcodec_free_context().
1153 * - encoding: Set/allocated by user, freed by libavcodec. Can be NULL.
1154 * - decoding: Set/allocated/freed by libavcodec.
1156 uint16_t *intra_matrix;
1159 * custom inter quantization matrix
1160 * Must be allocated with the av_malloc() family of functions, and will be freed in
1161 * avcodec_free_context().
1162 * - encoding: Set/allocated by user, freed by libavcodec. Can be NULL.
1163 * - decoding: Set/allocated/freed by libavcodec.
1165 uint16_t *inter_matrix;
1167 #if FF_API_PRIVATE_OPT
1168 /** @deprecated use encoder private options instead */
1169 attribute_deprecated
1170 int scenechange_threshold;
1172 /** @deprecated use encoder private options instead */
1173 attribute_deprecated
1174 int noise_reduction;
1178 * precision of the intra DC coefficient - 8
1179 * - encoding: Set by user.
1180 * - decoding: Set by libavcodec
1182 int intra_dc_precision;
1185 * Number of macroblock rows at the top which are skipped.
1186 * - encoding: unused
1187 * - decoding: Set by user.
1192 * Number of macroblock rows at the bottom which are skipped.
1193 * - encoding: unused
1194 * - decoding: Set by user.
1199 * minimum MB Lagrange multiplier
1200 * - encoding: Set by user.
1201 * - decoding: unused
1206 * maximum MB Lagrange multiplier
1207 * - encoding: Set by user.
1208 * - decoding: unused
1212 #if FF_API_PRIVATE_OPT
1214 * @deprecated use encoder private options instead
1216 attribute_deprecated
1217 int me_penalty_compensation;
1221 * - encoding: Set by user.
1222 * - decoding: unused
1226 #if FF_API_PRIVATE_OPT
1227 /** @deprecated use encoder private options instead */
1228 attribute_deprecated
1234 * - encoding: Set by user.
1235 * - decoding: unused
1240 * number of reference frames
1241 * - encoding: Set by user.
1242 * - decoding: Set by lavc.
1246 #if FF_API_PRIVATE_OPT
1247 /** @deprecated use encoder private options instead */
1248 attribute_deprecated
1253 * Note: Value depends upon the compare function used for fullpel ME.
1254 * - encoding: Set by user.
1255 * - decoding: unused
1259 #if FF_API_PRIVATE_OPT
1260 /** @deprecated use encoder private options instead */
1261 attribute_deprecated
1266 * Chromaticity coordinates of the source primaries.
1267 * - encoding: Set by user
1268 * - decoding: Set by libavcodec
1270 enum AVColorPrimaries color_primaries;
1273 * Color Transfer Characteristic.
1274 * - encoding: Set by user
1275 * - decoding: Set by libavcodec
1277 enum AVColorTransferCharacteristic color_trc;
1280 * YUV colorspace type.
1281 * - encoding: Set by user
1282 * - decoding: Set by libavcodec
1284 enum AVColorSpace colorspace;
1287 * MPEG vs JPEG YUV range.
1288 * - encoding: Set by user
1289 * - decoding: Set by libavcodec
1291 enum AVColorRange color_range;
1294 * This defines the location of chroma samples.
1295 * - encoding: Set by user
1296 * - decoding: Set by libavcodec
1298 enum AVChromaLocation chroma_sample_location;
1302 * Indicates number of picture subdivisions. Used for parallelized
1304 * - encoding: Set by user
1305 * - decoding: unused
1310 * - encoding: set by libavcodec
1311 * - decoding: Set by user.
1313 enum AVFieldOrder field_order;
1316 int sample_rate; ///< samples per second
1317 int channels; ///< number of audio channels
1320 * audio sample format
1321 * - encoding: Set by user.
1322 * - decoding: Set by libavcodec.
1324 enum AVSampleFormat sample_fmt; ///< sample format
1326 /* The following data should not be initialized. */
1328 * Number of samples per channel in an audio frame.
1330 * - encoding: set by libavcodec in avcodec_open2(). Each submitted frame
1331 * except the last must contain exactly frame_size samples per channel.
1332 * May be 0 when the codec has AV_CODEC_CAP_VARIABLE_FRAME_SIZE set, then the
1333 * frame size is not restricted.
1334 * - decoding: may be set by some decoders to indicate constant frame size
1339 * Frame counter, set by libavcodec.
1341 * - decoding: total number of frames returned from the decoder so far.
1342 * - encoding: total number of frames passed to the encoder so far.
1344 * @note the counter is not incremented if encoding/decoding resulted in
1350 * number of bytes per packet if constant and known or 0
1351 * Used by some WAV based audio codecs.
1356 * Audio cutoff bandwidth (0 means "automatic")
1357 * - encoding: Set by user.
1358 * - decoding: unused
1363 * Audio channel layout.
1364 * - encoding: set by user.
1365 * - decoding: set by user, may be overwritten by libavcodec.
1367 uint64_t channel_layout;
1370 * Request decoder to use this channel layout if it can (0 for default)
1371 * - encoding: unused
1372 * - decoding: Set by user.
1374 uint64_t request_channel_layout;
1377 * Type of service that the audio stream conveys.
1378 * - encoding: Set by user.
1379 * - decoding: Set by libavcodec.
1381 enum AVAudioServiceType audio_service_type;
1384 * desired sample format
1385 * - encoding: Not used.
1386 * - decoding: Set by user.
1387 * Decoder will decode to this format if it can.
1389 enum AVSampleFormat request_sample_fmt;
1392 * This callback is called at the beginning of each frame to get data
1393 * buffer(s) for it. There may be one contiguous buffer for all the data or
1394 * there may be a buffer per each data plane or anything in between. What
1395 * this means is, you may set however many entries in buf[] you feel necessary.
1396 * Each buffer must be reference-counted using the AVBuffer API (see description
1399 * The following fields will be set in the frame before this callback is
1402 * - width, height (video only)
1403 * - sample_rate, channel_layout, nb_samples (audio only)
1404 * Their values may differ from the corresponding values in
1405 * AVCodecContext. This callback must use the frame values, not the codec
1406 * context values, to calculate the required buffer size.
1408 * This callback must fill the following fields in the frame:
1412 * * if the data is planar audio with more than 8 channels, then this
1413 * callback must allocate and fill extended_data to contain all pointers
1414 * to all data planes. data[] must hold as many pointers as it can.
1415 * extended_data must be allocated with av_malloc() and will be freed in
1417 * * otherwise extended_data must point to data
1418 * - buf[] must contain one or more pointers to AVBufferRef structures. Each of
1419 * the frame's data and extended_data pointers must be contained in these. That
1420 * is, one AVBufferRef for each allocated chunk of memory, not necessarily one
1421 * AVBufferRef per data[] entry. See: av_buffer_create(), av_buffer_alloc(),
1422 * and av_buffer_ref().
1423 * - extended_buf and nb_extended_buf must be allocated with av_malloc() by
1424 * this callback and filled with the extra buffers if there are more
1425 * buffers than buf[] can hold. extended_buf will be freed in
1428 * If AV_CODEC_CAP_DR1 is not set then get_buffer2() must call
1429 * avcodec_default_get_buffer2() instead of providing buffers allocated by
1432 * Each data plane must be aligned to the maximum required by the target
1435 * @see avcodec_default_get_buffer2()
1439 * If AV_GET_BUFFER_FLAG_REF is set in flags then the frame may be reused
1440 * (read and/or written to if it is writable) later by libavcodec.
1442 * avcodec_align_dimensions2() should be used to find the required width and
1443 * height, as they normally need to be rounded up to the next multiple of 16.
1445 * Some decoders do not support linesizes changing between frames.
1447 * If frame multithreading is used and thread_safe_callbacks is set,
1448 * this callback may be called from a different thread, but not from more
1449 * than one at once. Does not need to be reentrant.
1451 * @see avcodec_align_dimensions2()
1455 * Decoders request a buffer of a particular size by setting
1456 * AVFrame.nb_samples prior to calling get_buffer2(). The decoder may,
1457 * however, utilize only part of the buffer by setting AVFrame.nb_samples
1458 * to a smaller value in the output frame.
1460 * As a convenience, av_samples_get_buffer_size() and
1461 * av_samples_fill_arrays() in libavutil may be used by custom get_buffer2()
1462 * functions to find the required data size and to fill data pointers and
1463 * linesize. In AVFrame.linesize, only linesize[0] may be set for audio
1464 * since all planes must be the same size.
1466 * @see av_samples_get_buffer_size(), av_samples_fill_arrays()
1468 * - encoding: unused
1469 * - decoding: Set by libavcodec, user can override.
1471 int (*get_buffer2)(struct AVCodecContext *s, AVFrame *frame, int flags);
1474 * If non-zero, the decoded audio and video frames returned from
1475 * avcodec_decode_video2() and avcodec_decode_audio4() are reference-counted
1476 * and are valid indefinitely. The caller must free them with
1477 * av_frame_unref() when they are not needed anymore.
1478 * Otherwise, the decoded frames must not be freed by the caller and are
1479 * only valid until the next decode call.
1481 * This is always automatically enabled if avcodec_receive_frame() is used.
1483 * - encoding: unused
1484 * - decoding: set by the caller before avcodec_open2().
1486 attribute_deprecated
1487 int refcounted_frames;
1489 /* - encoding parameters */
1490 float qcompress; ///< amount of qscale change between easy & hard scenes (0.0-1.0)
1491 float qblur; ///< amount of qscale smoothing over time (0.0-1.0)
1495 * - encoding: Set by user.
1496 * - decoding: unused
1502 * - encoding: Set by user.
1503 * - decoding: unused
1508 * maximum quantizer difference between frames
1509 * - encoding: Set by user.
1510 * - decoding: unused
1515 * decoder bitstream buffer size
1516 * - encoding: Set by user.
1517 * - decoding: unused
1522 * ratecontrol override, see RcOverride
1523 * - encoding: Allocated/set/freed by user.
1524 * - decoding: unused
1526 int rc_override_count;
1527 RcOverride *rc_override;
1531 * - encoding: Set by user.
1532 * - decoding: Set by user, may be overwritten by libavcodec.
1534 int64_t rc_max_rate;
1538 * - encoding: Set by user.
1539 * - decoding: unused
1541 int64_t rc_min_rate;
1544 * Ratecontrol attempt to use, at maximum, <value> of what can be used without an underflow.
1545 * - encoding: Set by user.
1546 * - decoding: unused.
1548 float rc_max_available_vbv_use;
1551 * Ratecontrol attempt to use, at least, <value> times the amount needed to prevent a vbv overflow.
1552 * - encoding: Set by user.
1553 * - decoding: unused.
1555 float rc_min_vbv_overflow_use;
1558 * Number of bits which should be loaded into the rc buffer before decoding starts.
1559 * - encoding: Set by user.
1560 * - decoding: unused
1562 int rc_initial_buffer_occupancy;
1564 #if FF_API_CODER_TYPE
1565 #define FF_CODER_TYPE_VLC 0
1566 #define FF_CODER_TYPE_AC 1
1567 #define FF_CODER_TYPE_RAW 2
1568 #define FF_CODER_TYPE_RLE 3
1570 * @deprecated use encoder private options instead
1572 attribute_deprecated
1574 #endif /* FF_API_CODER_TYPE */
1576 #if FF_API_PRIVATE_OPT
1577 /** @deprecated use encoder private options instead */
1578 attribute_deprecated
1582 #if FF_API_PRIVATE_OPT
1583 /** @deprecated use encoder private options instead */
1584 attribute_deprecated
1585 int frame_skip_threshold;
1587 /** @deprecated use encoder private options instead */
1588 attribute_deprecated
1589 int frame_skip_factor;
1591 /** @deprecated use encoder private options instead */
1592 attribute_deprecated
1595 /** @deprecated use encoder private options instead */
1596 attribute_deprecated
1598 #endif /* FF_API_PRIVATE_OPT */
1601 * trellis RD quantization
1602 * - encoding: Set by user.
1603 * - decoding: unused
1607 #if FF_API_PRIVATE_OPT
1608 /** @deprecated use encoder private options instead */
1609 attribute_deprecated
1610 int min_prediction_order;
1612 /** @deprecated use encoder private options instead */
1613 attribute_deprecated
1614 int max_prediction_order;
1616 /** @deprecated use encoder private options instead */
1617 attribute_deprecated
1618 int64_t timecode_frame_start;
1621 #if FF_API_RTP_CALLBACK
1623 * @deprecated unused
1625 /* The RTP callback: This function is called */
1626 /* every time the encoder has a packet to send. */
1627 /* It depends on the encoder if the data starts */
1628 /* with a Start Code (it should). H.263 does. */
1629 /* mb_nb contains the number of macroblocks */
1630 /* encoded in the RTP payload. */
1631 attribute_deprecated
1632 void (*rtp_callback)(struct AVCodecContext *avctx, void *data, int size, int mb_nb);
1635 #if FF_API_PRIVATE_OPT
1636 /** @deprecated use encoder private options instead */
1637 attribute_deprecated
1638 int rtp_payload_size; /* The size of the RTP payload: the coder will */
1639 /* do its best to deliver a chunk with size */
1640 /* below rtp_payload_size, the chunk will start */
1641 /* with a start code on some codecs like H.263. */
1642 /* This doesn't take account of any particular */
1643 /* headers inside the transmitted RTP payload. */
1646 #if FF_API_STAT_BITS
1647 /* statistics, used for 2-pass encoding */
1648 attribute_deprecated
1650 attribute_deprecated
1652 attribute_deprecated
1654 attribute_deprecated
1656 attribute_deprecated
1658 attribute_deprecated
1660 attribute_deprecated
1662 attribute_deprecated
1665 /** @deprecated this field is unused */
1666 attribute_deprecated
1671 * pass1 encoding statistics output buffer
1672 * - encoding: Set by libavcodec.
1673 * - decoding: unused
1678 * pass2 encoding statistics input buffer
1679 * Concatenated stuff from stats_out of pass1 should be placed here.
1680 * - encoding: Allocated/set/freed by user.
1681 * - decoding: unused
1686 * Work around bugs in encoders which sometimes cannot be detected automatically.
1687 * - encoding: Set by user
1688 * - decoding: Set by user
1690 int workaround_bugs;
1691 #define FF_BUG_AUTODETECT 1 ///< autodetection
1692 #define FF_BUG_XVID_ILACE 4
1693 #define FF_BUG_UMP4 8
1694 #define FF_BUG_NO_PADDING 16
1695 #define FF_BUG_AMV 32
1696 #define FF_BUG_QPEL_CHROMA 64
1697 #define FF_BUG_STD_QPEL 128
1698 #define FF_BUG_QPEL_CHROMA2 256
1699 #define FF_BUG_DIRECT_BLOCKSIZE 512
1700 #define FF_BUG_EDGE 1024
1701 #define FF_BUG_HPEL_CHROMA 2048
1702 #define FF_BUG_DC_CLIP 4096
1703 #define FF_BUG_MS 8192 ///< Work around various bugs in Microsoft's broken decoders.
1704 #define FF_BUG_TRUNCATED 16384
1705 #define FF_BUG_IEDGE 32768
1708 * strictly follow the standard (MPEG-4, ...).
1709 * - encoding: Set by user.
1710 * - decoding: Set by user.
1711 * Setting this to STRICT or higher means the encoder and decoder will
1712 * generally do stupid things, whereas setting it to unofficial or lower
1713 * will mean the encoder might produce output that is not supported by all
1714 * spec-compliant decoders. Decoders don't differentiate between normal,
1715 * unofficial and experimental (that is, they always try to decode things
1716 * when they can) unless they are explicitly asked to behave stupidly
1717 * (=strictly conform to the specs)
1719 int strict_std_compliance;
1720 #define FF_COMPLIANCE_VERY_STRICT 2 ///< Strictly conform to an older more strict version of the spec or reference software.
1721 #define FF_COMPLIANCE_STRICT 1 ///< Strictly conform to all the things in the spec no matter what consequences.
1722 #define FF_COMPLIANCE_NORMAL 0
1723 #define FF_COMPLIANCE_UNOFFICIAL -1 ///< Allow unofficial extensions
1724 #define FF_COMPLIANCE_EXPERIMENTAL -2 ///< Allow nonstandardized experimental things.
1727 * error concealment flags
1728 * - encoding: unused
1729 * - decoding: Set by user.
1731 int error_concealment;
1732 #define FF_EC_GUESS_MVS 1
1733 #define FF_EC_DEBLOCK 2
1734 #define FF_EC_FAVOR_INTER 256
1738 * - encoding: Set by user.
1739 * - decoding: Set by user.
1742 #define FF_DEBUG_PICT_INFO 1
1743 #define FF_DEBUG_RC 2
1744 #define FF_DEBUG_BITSTREAM 4
1745 #define FF_DEBUG_MB_TYPE 8
1746 #define FF_DEBUG_QP 16
1749 * @deprecated this option does nothing
1751 #define FF_DEBUG_MV 32
1753 #define FF_DEBUG_DCT_COEFF 0x00000040
1754 #define FF_DEBUG_SKIP 0x00000080
1755 #define FF_DEBUG_STARTCODE 0x00000100
1756 #define FF_DEBUG_ER 0x00000400
1757 #define FF_DEBUG_MMCO 0x00000800
1758 #define FF_DEBUG_BUGS 0x00001000
1760 #define FF_DEBUG_VIS_QP 0x00002000
1761 #define FF_DEBUG_VIS_MB_TYPE 0x00004000
1763 #define FF_DEBUG_BUFFERS 0x00008000
1764 #define FF_DEBUG_THREADS 0x00010000
1765 #define FF_DEBUG_GREEN_MD 0x00800000
1766 #define FF_DEBUG_NOMC 0x01000000
1771 * - encoding: Set by user.
1772 * - decoding: Set by user.
1775 #define FF_DEBUG_VIS_MV_P_FOR 0x00000001 // visualize forward predicted MVs of P-frames
1776 #define FF_DEBUG_VIS_MV_B_FOR 0x00000002 // visualize forward predicted MVs of B-frames
1777 #define FF_DEBUG_VIS_MV_B_BACK 0x00000004 // visualize backward predicted MVs of B-frames
1781 * Error recognition; may misdetect some more or less valid parts as errors.
1782 * - encoding: unused
1783 * - decoding: Set by user.
1785 int err_recognition;
1788 * Verify checksums embedded in the bitstream (could be of either encoded or
1789 * decoded data, depending on the codec) and print an error message on mismatch.
1790 * If AV_EF_EXPLODE is also set, a mismatching checksum will result in the
1791 * decoder returning an error.
1793 #define AV_EF_CRCCHECK (1<<0)
1794 #define AV_EF_BITSTREAM (1<<1) ///< detect bitstream specification deviations
1795 #define AV_EF_BUFFER (1<<2) ///< detect improper bitstream length
1796 #define AV_EF_EXPLODE (1<<3) ///< abort decoding on minor error detection
1798 #define AV_EF_IGNORE_ERR (1<<15) ///< ignore errors and continue
1799 #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
1800 #define AV_EF_COMPLIANT (1<<17) ///< consider all spec non compliances as errors
1801 #define AV_EF_AGGRESSIVE (1<<18) ///< consider things that a sane encoder should not do as an error
1805 * opaque 64-bit number (generally a PTS) that will be reordered and
1806 * output in AVFrame.reordered_opaque
1807 * - encoding: Set by libavcodec to the reordered_opaque of the input
1808 * frame corresponding to the last returned packet. Only
1809 * supported by encoders with the
1810 * AV_CODEC_CAP_ENCODER_REORDERED_OPAQUE capability.
1811 * - decoding: Set by user.
1813 int64_t reordered_opaque;
1816 * Hardware accelerator in use
1817 * - encoding: unused.
1818 * - decoding: Set by libavcodec
1820 const struct AVHWAccel *hwaccel;
1823 * Hardware accelerator context.
1824 * For some hardware accelerators, a global context needs to be
1825 * provided by the user. In that case, this holds display-dependent
1826 * data FFmpeg cannot instantiate itself. Please refer to the
1827 * FFmpeg HW accelerator documentation to know how to fill this
1828 * is. e.g. for VA API, this is a struct vaapi_context.
1829 * - encoding: unused
1830 * - decoding: Set by user
1832 void *hwaccel_context;
1836 * - encoding: Set by libavcodec if flags & AV_CODEC_FLAG_PSNR.
1837 * - decoding: unused
1839 uint64_t error[AV_NUM_DATA_POINTERS];
1842 * DCT algorithm, see FF_DCT_* below
1843 * - encoding: Set by user.
1844 * - decoding: unused
1847 #define FF_DCT_AUTO 0
1848 #define FF_DCT_FASTINT 1
1849 #define FF_DCT_INT 2
1850 #define FF_DCT_MMX 3
1851 #define FF_DCT_ALTIVEC 5
1852 #define FF_DCT_FAAN 6
1855 * IDCT algorithm, see FF_IDCT_* below.
1856 * - encoding: Set by user.
1857 * - decoding: Set by user.
1860 #define FF_IDCT_AUTO 0
1861 #define FF_IDCT_INT 1
1862 #define FF_IDCT_SIMPLE 2
1863 #define FF_IDCT_SIMPLEMMX 3
1864 #define FF_IDCT_ARM 7
1865 #define FF_IDCT_ALTIVEC 8
1866 #define FF_IDCT_SIMPLEARM 10
1867 #define FF_IDCT_XVID 14
1868 #define FF_IDCT_SIMPLEARMV5TE 16
1869 #define FF_IDCT_SIMPLEARMV6 17
1870 #define FF_IDCT_FAAN 20
1871 #define FF_IDCT_SIMPLENEON 22
1872 #define FF_IDCT_NONE 24 /* Used by XvMC to extract IDCT coefficients with FF_IDCT_PERM_NONE */
1873 #define FF_IDCT_SIMPLEAUTO 128
1876 * bits per sample/pixel from the demuxer (needed for huffyuv).
1877 * - encoding: Set by libavcodec.
1878 * - decoding: Set by user.
1880 int bits_per_coded_sample;
1883 * Bits per sample/pixel of internal libavcodec pixel/sample format.
1884 * - encoding: set by user.
1885 * - decoding: set by libavcodec.
1887 int bits_per_raw_sample;
1891 * low resolution decoding, 1-> 1/2 size, 2->1/4 size
1892 * - encoding: unused
1893 * - decoding: Set by user.
1898 #if FF_API_CODED_FRAME
1900 * the picture in the bitstream
1901 * - encoding: Set by libavcodec.
1902 * - decoding: unused
1904 * @deprecated use the quality factor packet side data instead
1906 attribute_deprecated AVFrame *coded_frame;
1911 * is used to decide how many independent tasks should be passed to execute()
1912 * - encoding: Set by user.
1913 * - decoding: Set by user.
1918 * Which multithreading methods to use.
1919 * Use of FF_THREAD_FRAME will increase decoding delay by one frame per thread,
1920 * so clients which cannot provide future frames should not use it.
1922 * - encoding: Set by user, otherwise the default is used.
1923 * - decoding: Set by user, otherwise the default is used.
1926 #define FF_THREAD_FRAME 1 ///< Decode more than one frame at once
1927 #define FF_THREAD_SLICE 2 ///< Decode more than one part of a single frame at once
1930 * Which multithreading methods are in use by the codec.
1931 * - encoding: Set by libavcodec.
1932 * - decoding: Set by libavcodec.
1934 int active_thread_type;
1937 * Set by the client if its custom get_buffer() callback can be called
1938 * synchronously from another thread, which allows faster multithreaded decoding.
1939 * draw_horiz_band() will be called from other threads regardless of this setting.
1940 * Ignored if the default get_buffer() is used.
1941 * - encoding: Set by user.
1942 * - decoding: Set by user.
1944 int thread_safe_callbacks;
1947 * The codec may call this to execute several independent things.
1948 * It will return only after finishing all tasks.
1949 * The user may replace this with some multithreaded implementation,
1950 * the default implementation will execute the parts serially.
1951 * @param count the number of things to execute
1952 * - encoding: Set by libavcodec, user can override.
1953 * - decoding: Set by libavcodec, user can override.
1955 int (*execute)(struct AVCodecContext *c, int (*func)(struct AVCodecContext *c2, void *arg), void *arg2, int *ret, int count, int size);
1958 * The codec may call this to execute several independent things.
1959 * It will return only after finishing all tasks.
1960 * The user may replace this with some multithreaded implementation,
1961 * the default implementation will execute the parts serially.
1962 * Also see avcodec_thread_init and e.g. the --enable-pthread configure option.
1963 * @param c context passed also to func
1964 * @param count the number of things to execute
1965 * @param arg2 argument passed unchanged to func
1966 * @param ret return values of executed functions, must have space for "count" values. May be NULL.
1967 * @param func function that will be called count times, with jobnr from 0 to count-1.
1968 * threadnr will be in the range 0 to c->thread_count-1 < MAX_THREADS and so that no
1969 * two instances of func executing at the same time will have the same threadnr.
1970 * @return always 0 currently, but code should handle a future improvement where when any call to func
1971 * returns < 0 no further calls to func may be done and < 0 is returned.
1972 * - encoding: Set by libavcodec, user can override.
1973 * - decoding: Set by libavcodec, user can override.
1975 int (*execute2)(struct AVCodecContext *c, int (*func)(struct AVCodecContext *c2, void *arg, int jobnr, int threadnr), void *arg2, int *ret, int count);
1978 * noise vs. sse weight for the nsse comparison function
1979 * - encoding: Set by user.
1980 * - decoding: unused
1986 * - encoding: Set by user.
1987 * - decoding: Set by libavcodec.
1990 #define FF_PROFILE_UNKNOWN -99
1991 #define FF_PROFILE_RESERVED -100
1993 #define FF_PROFILE_AAC_MAIN 0
1994 #define FF_PROFILE_AAC_LOW 1
1995 #define FF_PROFILE_AAC_SSR 2
1996 #define FF_PROFILE_AAC_LTP 3
1997 #define FF_PROFILE_AAC_HE 4
1998 #define FF_PROFILE_AAC_HE_V2 28
1999 #define FF_PROFILE_AAC_LD 22
2000 #define FF_PROFILE_AAC_ELD 38
2001 #define FF_PROFILE_MPEG2_AAC_LOW 128
2002 #define FF_PROFILE_MPEG2_AAC_HE 131
2004 #define FF_PROFILE_DNXHD 0
2005 #define FF_PROFILE_DNXHR_LB 1
2006 #define FF_PROFILE_DNXHR_SQ 2
2007 #define FF_PROFILE_DNXHR_HQ 3
2008 #define FF_PROFILE_DNXHR_HQX 4
2009 #define FF_PROFILE_DNXHR_444 5
2011 #define FF_PROFILE_DTS 20
2012 #define FF_PROFILE_DTS_ES 30
2013 #define FF_PROFILE_DTS_96_24 40
2014 #define FF_PROFILE_DTS_HD_HRA 50
2015 #define FF_PROFILE_DTS_HD_MA 60
2016 #define FF_PROFILE_DTS_EXPRESS 70
2018 #define FF_PROFILE_MPEG2_422 0
2019 #define FF_PROFILE_MPEG2_HIGH 1
2020 #define FF_PROFILE_MPEG2_SS 2
2021 #define FF_PROFILE_MPEG2_SNR_SCALABLE 3
2022 #define FF_PROFILE_MPEG2_MAIN 4
2023 #define FF_PROFILE_MPEG2_SIMPLE 5
2025 #define FF_PROFILE_H264_CONSTRAINED (1<<9) // 8+1; constraint_set1_flag
2026 #define FF_PROFILE_H264_INTRA (1<<11) // 8+3; constraint_set3_flag
2028 #define FF_PROFILE_H264_BASELINE 66
2029 #define FF_PROFILE_H264_CONSTRAINED_BASELINE (66|FF_PROFILE_H264_CONSTRAINED)
2030 #define FF_PROFILE_H264_MAIN 77
2031 #define FF_PROFILE_H264_EXTENDED 88
2032 #define FF_PROFILE_H264_HIGH 100
2033 #define FF_PROFILE_H264_HIGH_10 110
2034 #define FF_PROFILE_H264_HIGH_10_INTRA (110|FF_PROFILE_H264_INTRA)
2035 #define FF_PROFILE_H264_MULTIVIEW_HIGH 118
2036 #define FF_PROFILE_H264_HIGH_422 122
2037 #define FF_PROFILE_H264_HIGH_422_INTRA (122|FF_PROFILE_H264_INTRA)
2038 #define FF_PROFILE_H264_STEREO_HIGH 128
2039 #define FF_PROFILE_H264_HIGH_444 144
2040 #define FF_PROFILE_H264_HIGH_444_PREDICTIVE 244
2041 #define FF_PROFILE_H264_HIGH_444_INTRA (244|FF_PROFILE_H264_INTRA)
2042 #define FF_PROFILE_H264_CAVLC_444 44
2044 #define FF_PROFILE_VC1_SIMPLE 0
2045 #define FF_PROFILE_VC1_MAIN 1
2046 #define FF_PROFILE_VC1_COMPLEX 2
2047 #define FF_PROFILE_VC1_ADVANCED 3
2049 #define FF_PROFILE_MPEG4_SIMPLE 0
2050 #define FF_PROFILE_MPEG4_SIMPLE_SCALABLE 1
2051 #define FF_PROFILE_MPEG4_CORE 2
2052 #define FF_PROFILE_MPEG4_MAIN 3
2053 #define FF_PROFILE_MPEG4_N_BIT 4
2054 #define FF_PROFILE_MPEG4_SCALABLE_TEXTURE 5
2055 #define FF_PROFILE_MPEG4_SIMPLE_FACE_ANIMATION 6
2056 #define FF_PROFILE_MPEG4_BASIC_ANIMATED_TEXTURE 7
2057 #define FF_PROFILE_MPEG4_HYBRID 8
2058 #define FF_PROFILE_MPEG4_ADVANCED_REAL_TIME 9
2059 #define FF_PROFILE_MPEG4_CORE_SCALABLE 10
2060 #define FF_PROFILE_MPEG4_ADVANCED_CODING 11
2061 #define FF_PROFILE_MPEG4_ADVANCED_CORE 12
2062 #define FF_PROFILE_MPEG4_ADVANCED_SCALABLE_TEXTURE 13
2063 #define FF_PROFILE_MPEG4_SIMPLE_STUDIO 14
2064 #define FF_PROFILE_MPEG4_ADVANCED_SIMPLE 15
2066 #define FF_PROFILE_JPEG2000_CSTREAM_RESTRICTION_0 1
2067 #define FF_PROFILE_JPEG2000_CSTREAM_RESTRICTION_1 2
2068 #define FF_PROFILE_JPEG2000_CSTREAM_NO_RESTRICTION 32768
2069 #define FF_PROFILE_JPEG2000_DCINEMA_2K 3
2070 #define FF_PROFILE_JPEG2000_DCINEMA_4K 4
2072 #define FF_PROFILE_VP9_0 0
2073 #define FF_PROFILE_VP9_1 1
2074 #define FF_PROFILE_VP9_2 2
2075 #define FF_PROFILE_VP9_3 3
2077 #define FF_PROFILE_HEVC_MAIN 1
2078 #define FF_PROFILE_HEVC_MAIN_10 2
2079 #define FF_PROFILE_HEVC_MAIN_STILL_PICTURE 3
2080 #define FF_PROFILE_HEVC_REXT 4
2082 #define FF_PROFILE_AV1_MAIN 0
2083 #define FF_PROFILE_AV1_HIGH 1
2084 #define FF_PROFILE_AV1_PROFESSIONAL 2
2086 #define FF_PROFILE_MJPEG_HUFFMAN_BASELINE_DCT 0xc0
2087 #define FF_PROFILE_MJPEG_HUFFMAN_EXTENDED_SEQUENTIAL_DCT 0xc1
2088 #define FF_PROFILE_MJPEG_HUFFMAN_PROGRESSIVE_DCT 0xc2
2089 #define FF_PROFILE_MJPEG_HUFFMAN_LOSSLESS 0xc3
2090 #define FF_PROFILE_MJPEG_JPEG_LS 0xf7
2092 #define FF_PROFILE_SBC_MSBC 1
2094 #define FF_PROFILE_PRORES_PROXY 0
2095 #define FF_PROFILE_PRORES_LT 1
2096 #define FF_PROFILE_PRORES_STANDARD 2
2097 #define FF_PROFILE_PRORES_HQ 3
2098 #define FF_PROFILE_PRORES_4444 4
2099 #define FF_PROFILE_PRORES_XQ 5
2101 #define FF_PROFILE_ARIB_PROFILE_A 0
2102 #define FF_PROFILE_ARIB_PROFILE_C 1
2106 * - encoding: Set by user.
2107 * - decoding: Set by libavcodec.
2110 #define FF_LEVEL_UNKNOWN -99
2113 * Skip loop filtering for selected frames.
2114 * - encoding: unused
2115 * - decoding: Set by user.
2117 enum AVDiscard skip_loop_filter;
2120 * Skip IDCT/dequantization for selected frames.
2121 * - encoding: unused
2122 * - decoding: Set by user.
2124 enum AVDiscard skip_idct;
2127 * Skip decoding for selected frames.
2128 * - encoding: unused
2129 * - decoding: Set by user.
2131 enum AVDiscard skip_frame;
2134 * Header containing style information for text subtitles.
2135 * For SUBTITLE_ASS subtitle type, it should contain the whole ASS
2136 * [Script Info] and [V4+ Styles] section, plus the [Events] line and
2137 * the Format line following. It shouldn't include any Dialogue line.
2138 * - encoding: Set/allocated/freed by user (before avcodec_open2())
2139 * - decoding: Set/allocated/freed by libavcodec (by avcodec_open2())
2141 uint8_t *subtitle_header;
2142 int subtitle_header_size;
2144 #if FF_API_VBV_DELAY
2146 * VBV delay coded in the last frame (in periods of a 27 MHz clock).
2147 * Used for compliant TS muxing.
2148 * - encoding: Set by libavcodec.
2149 * - decoding: unused.
2150 * @deprecated this value is now exported as a part of
2151 * AV_PKT_DATA_CPB_PROPERTIES packet side data
2153 attribute_deprecated
2157 #if FF_API_SIDEDATA_ONLY_PKT
2159 * Encoding only and set by default. Allow encoders to output packets
2160 * that do not contain any encoded data, only side data.
2162 * Some encoders need to output such packets, e.g. to update some stream
2163 * parameters at the end of encoding.
2165 * @deprecated this field disables the default behaviour and
2166 * it is kept only for compatibility.
2168 attribute_deprecated
2169 int side_data_only_packets;
2173 * Audio only. The number of "priming" samples (padding) inserted by the
2174 * encoder at the beginning of the audio. I.e. this number of leading
2175 * decoded samples must be discarded by the caller to get the original audio
2176 * without leading padding.
2178 * - decoding: unused
2179 * - encoding: Set by libavcodec. The timestamps on the output packets are
2180 * adjusted by the encoder so that they always refer to the
2181 * first sample of the data actually contained in the packet,
2182 * including any added padding. E.g. if the timebase is
2183 * 1/samplerate and the timestamp of the first input sample is
2184 * 0, the timestamp of the first output packet will be
2187 int initial_padding;
2190 * - decoding: For codecs that store a framerate value in the compressed
2191 * bitstream, the decoder may export it here. { 0, 1} when
2193 * - encoding: May be used to signal the framerate of CFR content to an
2196 AVRational framerate;
2199 * Nominal unaccelerated pixel format, see AV_PIX_FMT_xxx.
2200 * - encoding: unused.
2201 * - decoding: Set by libavcodec before calling get_format()
2203 enum AVPixelFormat sw_pix_fmt;
2206 * Timebase in which pkt_dts/pts and AVPacket.dts/pts are.
2207 * - encoding unused.
2208 * - decoding set by user.
2210 AVRational pkt_timebase;
2214 * - encoding: unused.
2215 * - decoding: set by libavcodec.
2217 const AVCodecDescriptor *codec_descriptor;
2221 * low resolution decoding, 1-> 1/2 size, 2->1/4 size
2222 * - encoding: unused
2223 * - decoding: Set by user.
2229 * Current statistics for PTS correction.
2230 * - decoding: maintained and used by libavcodec, not intended to be used by user apps
2231 * - encoding: unused
2233 int64_t pts_correction_num_faulty_pts; /// Number of incorrect PTS values so far
2234 int64_t pts_correction_num_faulty_dts; /// Number of incorrect DTS values so far
2235 int64_t pts_correction_last_pts; /// PTS of the last frame
2236 int64_t pts_correction_last_dts; /// DTS of the last frame
2239 * Character encoding of the input subtitles file.
2240 * - decoding: set by user
2241 * - encoding: unused
2246 * Subtitles character encoding mode. Formats or codecs might be adjusting
2247 * this setting (if they are doing the conversion themselves for instance).
2248 * - decoding: set by libavcodec
2249 * - encoding: unused
2251 int sub_charenc_mode;
2252 #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)
2253 #define FF_SUB_CHARENC_MODE_AUTOMATIC 0 ///< libavcodec will select the mode itself
2254 #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
2255 #define FF_SUB_CHARENC_MODE_IGNORE 2 ///< neither convert the subtitles, nor check them for valid UTF-8
2258 * Skip processing alpha if supported by codec.
2259 * Note that if the format uses pre-multiplied alpha (common with VP6,
2260 * and recommended due to better video quality/compression)
2261 * the image will look as if alpha-blended onto a black background.
2262 * However for formats that do not use pre-multiplied alpha
2263 * there might be serious artefacts (though e.g. libswscale currently
2264 * assumes pre-multiplied alpha anyway).
2266 * - decoding: set by user
2267 * - encoding: unused
2272 * Number of samples to skip after a discontinuity
2273 * - decoding: unused
2274 * - encoding: set by libavcodec
2278 #if !FF_API_DEBUG_MV
2280 * debug motion vectors
2281 * - encoding: Set by user.
2282 * - decoding: Set by user.
2285 #define FF_DEBUG_VIS_MV_P_FOR 0x00000001 //visualize forward predicted MVs of P frames
2286 #define FF_DEBUG_VIS_MV_B_FOR 0x00000002 //visualize forward predicted MVs of B frames
2287 #define FF_DEBUG_VIS_MV_B_BACK 0x00000004 //visualize backward predicted MVs of B frames
2291 * custom intra quantization matrix
2292 * - encoding: Set by user, can be NULL.
2293 * - decoding: unused.
2295 uint16_t *chroma_intra_matrix;
2298 * dump format separator.
2299 * can be ", " or "\n " or anything else
2300 * - encoding: Set by user.
2301 * - decoding: Set by user.
2303 uint8_t *dump_separator;
2306 * ',' separated list of allowed decoders.
2307 * If NULL then all are allowed
2308 * - encoding: unused
2309 * - decoding: set by user
2311 char *codec_whitelist;
2314 * Properties of the stream that gets decoded
2315 * - encoding: unused
2316 * - decoding: set by libavcodec
2318 unsigned properties;
2319 #define FF_CODEC_PROPERTY_LOSSLESS 0x00000001
2320 #define FF_CODEC_PROPERTY_CLOSED_CAPTIONS 0x00000002
2323 * Additional data associated with the entire coded stream.
2325 * - decoding: unused
2326 * - encoding: may be set by libavcodec after avcodec_open2().
2328 AVPacketSideData *coded_side_data;
2329 int nb_coded_side_data;
2332 * A reference to the AVHWFramesContext describing the input (for encoding)
2333 * or output (decoding) frames. The reference is set by the caller and
2334 * afterwards owned (and freed) by libavcodec - it should never be read by
2335 * the caller after being set.
2337 * - decoding: This field should be set by the caller from the get_format()
2338 * callback. The previous reference (if any) will always be
2339 * unreffed by libavcodec before the get_format() call.
2341 * If the default get_buffer2() is used with a hwaccel pixel
2342 * format, then this AVHWFramesContext will be used for
2343 * allocating the frame buffers.
2345 * - encoding: For hardware encoders configured to use a hwaccel pixel
2346 * format, this field should be set by the caller to a reference
2347 * to the AVHWFramesContext describing input frames.
2348 * AVHWFramesContext.format must be equal to
2349 * AVCodecContext.pix_fmt.
2351 * This field should be set before avcodec_open2() is called.
2353 AVBufferRef *hw_frames_ctx;
2356 * Control the form of AVSubtitle.rects[N]->ass
2357 * - decoding: set by user
2358 * - encoding: unused
2360 int sub_text_format;
2361 #define FF_SUB_TEXT_FMT_ASS 0
2362 #if FF_API_ASS_TIMING
2363 #define FF_SUB_TEXT_FMT_ASS_WITH_TIMINGS 1
2367 * Audio only. The amount of padding (in samples) appended by the encoder to
2368 * the end of the audio. I.e. this number of decoded samples must be
2369 * discarded by the caller from the end of the stream to get the original
2370 * audio without any trailing padding.
2372 * - decoding: unused
2373 * - encoding: unused
2375 int trailing_padding;
2378 * The number of pixels per image to maximally accept.
2380 * - decoding: set by user
2381 * - encoding: set by user
2386 * A reference to the AVHWDeviceContext describing the device which will
2387 * be used by a hardware encoder/decoder. The reference is set by the
2388 * caller and afterwards owned (and freed) by libavcodec.
2390 * This should be used if either the codec device does not require
2391 * hardware frames or any that are used are to be allocated internally by
2392 * libavcodec. If the user wishes to supply any of the frames used as
2393 * encoder input or decoder output then hw_frames_ctx should be used
2394 * instead. When hw_frames_ctx is set in get_format() for a decoder, this
2395 * field will be ignored while decoding the associated stream segment, but
2396 * may again be used on a following one after another get_format() call.
2398 * For both encoders and decoders this field should be set before
2399 * avcodec_open2() is called and must not be written to thereafter.
2401 * Note that some decoders may require this field to be set initially in
2402 * order to support hw_frames_ctx at all - in that case, all frames
2403 * contexts used must be created on the same device.
2405 AVBufferRef *hw_device_ctx;
2408 * Bit set of AV_HWACCEL_FLAG_* flags, which affect hardware accelerated
2409 * decoding (if active).
2410 * - encoding: unused
2411 * - decoding: Set by user (either before avcodec_open2(), or in the
2412 * AVCodecContext.get_format callback)
2417 * Video decoding only. Certain video codecs support cropping, meaning that
2418 * only a sub-rectangle of the decoded frame is intended for display. This
2419 * option controls how cropping is handled by libavcodec.
2421 * When set to 1 (the default), libavcodec will apply cropping internally.
2422 * I.e. it will modify the output frame width/height fields and offset the
2423 * data pointers (only by as much as possible while preserving alignment, or
2424 * by the full amount if the AV_CODEC_FLAG_UNALIGNED flag is set) so that
2425 * the frames output by the decoder refer only to the cropped area. The
2426 * crop_* fields of the output frames will be zero.
2428 * When set to 0, the width/height fields of the output frames will be set
2429 * to the coded dimensions and the crop_* fields will describe the cropping
2430 * rectangle. Applying the cropping is left to the caller.
2432 * @warning When hardware acceleration with opaque output frames is used,
2433 * libavcodec is unable to apply cropping from the top/left border.
2435 * @note when this option is set to zero, the width/height fields of the
2436 * AVCodecContext and output AVFrames have different meanings. The codec
2437 * context fields store display dimensions (with the coded dimensions in
2438 * coded_width/height), while the frame fields store the coded dimensions
2439 * (with the display dimensions being determined by the crop_* fields).
2444 * Video decoding only. Sets the number of extra hardware frames which
2445 * the decoder will allocate for use by the caller. This must be set
2446 * before avcodec_open2() is called.
2448 * Some hardware decoders require all frames that they will use for
2449 * output to be defined in advance before decoding starts. For such
2450 * decoders, the hardware frame pool must therefore be of a fixed size.
2451 * The extra frames set here are on top of any number that the decoder
2452 * needs internally in order to operate normally (for example, frames
2453 * used as reference pictures).
2455 int extra_hw_frames;
2458 * The percentage of damaged samples to discard a frame.
2460 * - decoding: set by user
2461 * - encoding: unused
2463 int discard_damaged_percentage;
2466 * The number of samples per frame to maximally accept.
2468 * - decoding: set by user
2469 * - encoding: set by user
2471 int64_t max_samples;
2474 * Bit set of AV_CODEC_EXPORT_DATA_* flags, which affects the kind of
2475 * metadata exported in frame, packet, or coded stream side data by
2476 * decoders and encoders.
2478 * - decoding: set by user
2479 * - encoding: set by user
2481 int export_side_data;
2484 #if FF_API_CODEC_GET_SET
2486 * Accessors for some AVCodecContext fields. These used to be provided for ABI
2487 * compatibility, and do not need to be used anymore.
2489 attribute_deprecated
2490 AVRational av_codec_get_pkt_timebase (const AVCodecContext *avctx);
2491 attribute_deprecated
2492 void av_codec_set_pkt_timebase (AVCodecContext *avctx, AVRational val);
2494 attribute_deprecated
2495 const AVCodecDescriptor *av_codec_get_codec_descriptor(const AVCodecContext *avctx);
2496 attribute_deprecated
2497 void av_codec_set_codec_descriptor(AVCodecContext *avctx, const AVCodecDescriptor *desc);
2499 attribute_deprecated
2500 unsigned av_codec_get_codec_properties(const AVCodecContext *avctx);
2503 attribute_deprecated
2504 int av_codec_get_lowres(const AVCodecContext *avctx);
2505 attribute_deprecated
2506 void av_codec_set_lowres(AVCodecContext *avctx, int val);
2509 attribute_deprecated
2510 int av_codec_get_seek_preroll(const AVCodecContext *avctx);
2511 attribute_deprecated
2512 void av_codec_set_seek_preroll(AVCodecContext *avctx, int val);
2514 attribute_deprecated
2515 uint16_t *av_codec_get_chroma_intra_matrix(const AVCodecContext *avctx);
2516 attribute_deprecated
2517 void av_codec_set_chroma_intra_matrix(AVCodecContext *avctx, uint16_t *val);
2523 typedef struct AVProfile {
2525 const char *name; ///< short name for the profile
2530 * The codec supports this format via the hw_device_ctx interface.
2532 * When selecting this format, AVCodecContext.hw_device_ctx should
2533 * have been set to a device of the specified type before calling
2536 AV_CODEC_HW_CONFIG_METHOD_HW_DEVICE_CTX = 0x01,
2538 * The codec supports this format via the hw_frames_ctx interface.
2540 * When selecting this format for a decoder,
2541 * AVCodecContext.hw_frames_ctx should be set to a suitable frames
2542 * context inside the get_format() callback. The frames context
2543 * must have been created on a device of the specified type.
2545 * When selecting this format for an encoder,
2546 * AVCodecContext.hw_frames_ctx should be set to the context which
2547 * will be used for the input frames before calling avcodec_open2().
2549 AV_CODEC_HW_CONFIG_METHOD_HW_FRAMES_CTX = 0x02,
2551 * The codec supports this format by some internal method.
2553 * This format can be selected without any additional configuration -
2554 * no device or frames context is required.
2556 AV_CODEC_HW_CONFIG_METHOD_INTERNAL = 0x04,
2558 * The codec supports this format by some ad-hoc method.
2560 * Additional settings and/or function calls are required. See the
2561 * codec-specific documentation for details. (Methods requiring
2562 * this sort of configuration are deprecated and others should be
2563 * used in preference.)
2565 AV_CODEC_HW_CONFIG_METHOD_AD_HOC = 0x08,
2568 typedef struct AVCodecHWConfig {
2570 * For decoders, a hardware pixel format which that decoder may be
2571 * able to decode to if suitable hardware is available.
2573 * For encoders, a pixel format which the encoder may be able to
2574 * accept. If set to AV_PIX_FMT_NONE, this applies to all pixel
2575 * formats supported by the codec.
2577 enum AVPixelFormat pix_fmt;
2579 * Bit set of AV_CODEC_HW_CONFIG_METHOD_* flags, describing the possible
2580 * setup methods which can be used with this configuration.
2584 * The device type associated with the configuration.
2586 * Must be set for AV_CODEC_HW_CONFIG_METHOD_HW_DEVICE_CTX and
2587 * AV_CODEC_HW_CONFIG_METHOD_HW_FRAMES_CTX, otherwise unused.
2589 enum AVHWDeviceType device_type;
2592 typedef struct AVCodecDefault AVCodecDefault;
2599 typedef struct AVCodec {
2601 * Name of the codec implementation.
2602 * The name is globally unique among encoders and among decoders (but an
2603 * encoder and a decoder can share the same name).
2604 * This is the primary way to find a codec from the user perspective.
2608 * Descriptive name for the codec, meant to be more human readable than name.
2609 * You should use the NULL_IF_CONFIG_SMALL() macro to define it.
2611 const char *long_name;
2612 enum AVMediaType type;
2615 * Codec capabilities.
2616 * see AV_CODEC_CAP_*
2619 const AVRational *supported_framerates; ///< array of supported framerates, or NULL if any, array is terminated by {0,0}
2620 const enum AVPixelFormat *pix_fmts; ///< array of supported pixel formats, or NULL if unknown, array is terminated by -1
2621 const int *supported_samplerates; ///< array of supported audio samplerates, or NULL if unknown, array is terminated by 0
2622 const enum AVSampleFormat *sample_fmts; ///< array of supported sample formats, or NULL if unknown, array is terminated by -1
2623 const uint64_t *channel_layouts; ///< array of support channel layouts, or NULL if unknown. array is terminated by 0
2624 uint8_t max_lowres; ///< maximum value for lowres supported by the decoder
2625 const AVClass *priv_class; ///< AVClass for the private context
2626 const AVProfile *profiles; ///< array of recognized profiles, or NULL if unknown, array is terminated by {FF_PROFILE_UNKNOWN}
2629 * Group name of the codec implementation.
2630 * This is a short symbolic name of the wrapper backing this codec. A
2631 * wrapper uses some kind of external implementation for the codec, such
2632 * as an external library, or a codec implementation provided by the OS or
2634 * If this field is NULL, this is a builtin, libavcodec native codec.
2635 * If non-NULL, this will be the suffix in AVCodec.name in most cases
2636 * (usually AVCodec.name will be of the form "<codec_name>_<wrapper_name>").
2638 const char *wrapper_name;
2640 /*****************************************************************
2641 * No fields below this line are part of the public API. They
2642 * may not be used outside of libavcodec and can be changed and
2644 * New public fields should be added right above.
2645 *****************************************************************
2648 struct AVCodec *next;
2650 * @name Frame-level threading support functions
2654 * Copy necessary context variables from a previous thread context to the current one.
2655 * If not defined, the next thread will start automatically; otherwise, the codec
2656 * must call ff_thread_finish_setup().
2658 * dst and src will (rarely) point to the same context, in which case memcpy should be skipped.
2660 int (*update_thread_context)(AVCodecContext *dst, const AVCodecContext *src);
2664 * Private codec-specific defaults.
2666 const AVCodecDefault *defaults;
2669 * Initialize codec static data, called from avcodec_register().
2671 * This is not intended for time consuming operations as it is
2672 * run for every codec regardless of that codec being used.
2674 void (*init_static_data)(struct AVCodec *codec);
2676 int (*init)(AVCodecContext *);
2677 int (*encode_sub)(AVCodecContext *, uint8_t *buf, int buf_size,
2678 const struct AVSubtitle *sub);
2680 * Encode data to an AVPacket.
2682 * @param avctx codec context
2683 * @param avpkt output AVPacket (may contain a user-provided buffer)
2684 * @param[in] frame AVFrame containing the raw data to be encoded
2685 * @param[out] got_packet_ptr encoder sets to 0 or 1 to indicate that a
2686 * non-empty packet was returned in avpkt.
2687 * @return 0 on success, negative error code on failure
2689 int (*encode2)(AVCodecContext *avctx, AVPacket *avpkt, const AVFrame *frame,
2690 int *got_packet_ptr);
2691 int (*decode)(AVCodecContext *, void *outdata, int *outdata_size, AVPacket *avpkt);
2692 int (*close)(AVCodecContext *);
2694 * Encode API with decoupled packet/frame dataflow. The API is the
2695 * same as the avcodec_ prefixed APIs (avcodec_send_frame() etc.), except
2697 * - never called if the codec is closed or the wrong type,
2698 * - if AV_CODEC_CAP_DELAY is not set, drain frames are never sent,
2699 * - only one drain frame is ever passed down,
2701 int (*send_frame)(AVCodecContext *avctx, const AVFrame *frame);
2702 int (*receive_packet)(AVCodecContext *avctx, AVPacket *avpkt);
2705 * Decode API with decoupled packet/frame dataflow. This function is called
2706 * to get one output frame. It should call ff_decode_get_packet() to obtain
2709 int (*receive_frame)(AVCodecContext *avctx, AVFrame *frame);
2712 * Will be called when seeking
2714 void (*flush)(AVCodecContext *);
2716 * Internal codec capabilities.
2717 * See FF_CODEC_CAP_* in internal.h
2722 * Decoding only, a comma-separated list of bitstream filters to apply to
2723 * packets before decoding.
2728 * Array of pointers to hardware configurations supported by the codec,
2729 * or NULL if no hardware supported. The array is terminated by a NULL
2732 * The user can only access this field via avcodec_get_hw_config().
2734 const struct AVCodecHWConfigInternal **hw_configs;
2737 * List of supported codec_tags, terminated by FF_CODEC_TAGS_END.
2739 const uint32_t *codec_tags;
2742 #if FF_API_CODEC_GET_SET
2743 attribute_deprecated
2744 int av_codec_get_max_lowres(const AVCodec *codec);
2747 struct MpegEncContext;
2750 * Retrieve supported hardware configurations for a codec.
2752 * Values of index from zero to some maximum return the indexed configuration
2753 * descriptor; all other values return NULL. If the codec does not support
2754 * any hardware configurations then it will always return NULL.
2756 const AVCodecHWConfig *avcodec_get_hw_config(const AVCodec *codec, int index);
2759 * @defgroup lavc_hwaccel AVHWAccel
2761 * @note Nothing in this structure should be accessed by the user. At some
2762 * point in future it will not be externally visible at all.
2766 typedef struct AVHWAccel {
2768 * Name of the hardware accelerated codec.
2769 * The name is globally unique among encoders and among decoders (but an
2770 * encoder and a decoder can share the same name).
2775 * Type of codec implemented by the hardware accelerator.
2777 * See AVMEDIA_TYPE_xxx
2779 enum AVMediaType type;
2782 * Codec implemented by the hardware accelerator.
2784 * See AV_CODEC_ID_xxx
2789 * Supported pixel format.
2791 * Only hardware accelerated formats are supported here.
2793 enum AVPixelFormat pix_fmt;
2796 * Hardware accelerated codec capabilities.
2797 * see AV_HWACCEL_CODEC_CAP_*
2801 /*****************************************************************
2802 * No fields below this line are part of the public API. They
2803 * may not be used outside of libavcodec and can be changed and
2805 * New public fields should be added right above.
2806 *****************************************************************
2810 * Allocate a custom buffer
2812 int (*alloc_frame)(AVCodecContext *avctx, AVFrame *frame);
2815 * Called at the beginning of each frame or field picture.
2817 * Meaningful frame information (codec specific) is guaranteed to
2818 * be parsed at this point. This function is mandatory.
2820 * Note that buf can be NULL along with buf_size set to 0.
2821 * Otherwise, this means the whole frame is available at this point.
2823 * @param avctx the codec context
2824 * @param buf the frame data buffer base
2825 * @param buf_size the size of the frame in bytes
2826 * @return zero if successful, a negative value otherwise
2828 int (*start_frame)(AVCodecContext *avctx, const uint8_t *buf, uint32_t buf_size);
2831 * Callback for parameter data (SPS/PPS/VPS etc).
2833 * Useful for hardware decoders which keep persistent state about the
2834 * video parameters, and need to receive any changes to update that state.
2836 * @param avctx the codec context
2837 * @param type the nal unit type
2838 * @param buf the nal unit data buffer
2839 * @param buf_size the size of the nal unit in bytes
2840 * @return zero if successful, a negative value otherwise
2842 int (*decode_params)(AVCodecContext *avctx, int type, const uint8_t *buf, uint32_t buf_size);
2845 * Callback for each slice.
2847 * Meaningful slice information (codec specific) is guaranteed to
2848 * be parsed at this point. This function is mandatory.
2849 * The only exception is XvMC, that works on MB level.
2851 * @param avctx the codec context
2852 * @param buf the slice data buffer base
2853 * @param buf_size the size of the slice in bytes
2854 * @return zero if successful, a negative value otherwise
2856 int (*decode_slice)(AVCodecContext *avctx, const uint8_t *buf, uint32_t buf_size);
2859 * Called at the end of each frame or field picture.
2861 * The whole picture is parsed at this point and can now be sent
2862 * to the hardware accelerator. This function is mandatory.
2864 * @param avctx the codec context
2865 * @return zero if successful, a negative value otherwise
2867 int (*end_frame)(AVCodecContext *avctx);
2870 * Size of per-frame hardware accelerator private data.
2872 * Private data is allocated with av_mallocz() before
2873 * AVCodecContext.get_buffer() and deallocated after
2874 * AVCodecContext.release_buffer().
2876 int frame_priv_data_size;
2879 * Called for every Macroblock in a slice.
2881 * XvMC uses it to replace the ff_mpv_reconstruct_mb().
2882 * Instead of decoding to raw picture, MB parameters are
2883 * stored in an array provided by the video driver.
2885 * @param s the mpeg context
2887 void (*decode_mb)(struct MpegEncContext *s);
2890 * Initialize the hwaccel private data.
2892 * This will be called from ff_get_format(), after hwaccel and
2893 * hwaccel_context are set and the hwaccel private data in AVCodecInternal
2896 int (*init)(AVCodecContext *avctx);
2899 * Uninitialize the hwaccel private data.
2901 * This will be called from get_format() or avcodec_close(), after hwaccel
2902 * and hwaccel_context are already uninitialized.
2904 int (*uninit)(AVCodecContext *avctx);
2907 * Size of the private data to allocate in
2908 * AVCodecInternal.hwaccel_priv_data.
2913 * Internal hwaccel capabilities.
2918 * Fill the given hw_frames context with current codec parameters. Called
2919 * from get_format. Refer to avcodec_get_hw_frames_parameters() for
2922 * This CAN be called before AVHWAccel.init is called, and you must assume
2923 * that avctx->hwaccel_priv_data is invalid.
2925 int (*frame_params)(AVCodecContext *avctx, AVBufferRef *hw_frames_ctx);
2929 * HWAccel is experimental and is thus avoided in favor of non experimental
2932 #define AV_HWACCEL_CODEC_CAP_EXPERIMENTAL 0x0200
2935 * Hardware acceleration should be used for decoding even if the codec level
2936 * used is unknown or higher than the maximum supported level reported by the
2939 * It's generally a good idea to pass this flag unless you have a specific
2940 * reason not to, as hardware tends to under-report supported levels.
2942 #define AV_HWACCEL_FLAG_IGNORE_LEVEL (1 << 0)
2945 * Hardware acceleration can output YUV pixel formats with a different chroma
2946 * sampling than 4:2:0 and/or other than 8 bits per component.
2948 #define AV_HWACCEL_FLAG_ALLOW_HIGH_DEPTH (1 << 1)
2951 * Hardware acceleration should still be attempted for decoding when the
2952 * codec profile does not match the reported capabilities of the hardware.
2954 * For example, this can be used to try to decode baseline profile H.264
2955 * streams in hardware - it will often succeed, because many streams marked
2956 * as baseline profile actually conform to constrained baseline profile.
2958 * @warning If the stream is actually not supported then the behaviour is
2959 * undefined, and may include returning entirely incorrect output
2960 * while indicating success.
2962 #define AV_HWACCEL_FLAG_ALLOW_PROFILE_MISMATCH (1 << 2)
2968 #if FF_API_AVPICTURE
2970 * @defgroup lavc_picture AVPicture
2972 * Functions for working with AVPicture
2977 * Picture data structure.
2979 * Up to four components can be stored into it, the last component is
2981 * @deprecated use AVFrame or imgutils functions instead
2983 typedef struct AVPicture {
2984 attribute_deprecated
2985 uint8_t *data[AV_NUM_DATA_POINTERS]; ///< pointers to the image data planes
2986 attribute_deprecated
2987 int linesize[AV_NUM_DATA_POINTERS]; ///< number of bytes per line
2995 enum AVSubtitleType {
2998 SUBTITLE_BITMAP, ///< A bitmap, pict will be set
3001 * Plain text, the text field must be set by the decoder and is
3002 * authoritative. ass and pict fields may contain approximations.
3007 * Formatted text, the ass field must be set by the decoder and is
3008 * authoritative. pict and text fields may contain approximations.
3013 #define AV_SUBTITLE_FLAG_FORCED 0x00000001
3015 typedef struct AVSubtitleRect {
3016 int x; ///< top left corner of pict, undefined when pict is not set
3017 int y; ///< top left corner of pict, undefined when pict is not set
3018 int w; ///< width of pict, undefined when pict is not set
3019 int h; ///< height of pict, undefined when pict is not set
3020 int nb_colors; ///< number of colors in pict, undefined when pict is not set
3022 #if FF_API_AVPICTURE
3024 * @deprecated unused
3026 attribute_deprecated
3030 * data+linesize for the bitmap of this subtitle.
3031 * Can be set for text/ass as well once they are rendered.
3036 enum AVSubtitleType type;
3038 char *text; ///< 0 terminated plain UTF-8 text
3041 * 0 terminated ASS/SSA compatible event line.
3042 * The presentation of this is unaffected by the other values in this
3050 typedef struct AVSubtitle {
3051 uint16_t format; /* 0 = graphics */
3052 uint32_t start_display_time; /* relative to packet pts, in ms */
3053 uint32_t end_display_time; /* relative to packet pts, in ms */
3055 AVSubtitleRect **rects;
3056 int64_t pts; ///< Same as packet pts, in AV_TIME_BASE
3060 * Iterate over all registered codecs.
3062 * @param opaque a pointer where libavcodec will store the iteration state. Must
3063 * point to NULL to start the iteration.
3065 * @return the next registered codec or NULL when the iteration is
3068 const AVCodec *av_codec_iterate(void **opaque);
3072 * If c is NULL, returns the first registered codec,
3073 * if c is non-NULL, returns the next registered codec after c,
3074 * or NULL if c is the last one.
3076 attribute_deprecated
3077 AVCodec *av_codec_next(const AVCodec *c);
3081 * Return the LIBAVCODEC_VERSION_INT constant.
3083 unsigned avcodec_version(void);
3086 * Return the libavcodec build-time configuration.
3088 const char *avcodec_configuration(void);
3091 * Return the libavcodec license.
3093 const char *avcodec_license(void);
3097 * Register the codec codec and initialize libavcodec.
3099 * @warning either this function or avcodec_register_all() must be called
3100 * before any other libavcodec functions.
3102 * @see avcodec_register_all()
3104 attribute_deprecated
3105 void avcodec_register(AVCodec *codec);
3108 * Register all the codecs, parsers and bitstream filters which were enabled at
3109 * configuration time. If you do not call this function you can select exactly
3110 * which formats you want to support, by using the individual registration
3113 * @see avcodec_register
3114 * @see av_register_codec_parser
3115 * @see av_register_bitstream_filter
3117 attribute_deprecated
3118 void avcodec_register_all(void);
3122 * Allocate an AVCodecContext and set its fields to default values. The
3123 * resulting struct should be freed with avcodec_free_context().
3125 * @param codec if non-NULL, allocate private data and initialize defaults
3126 * for the given codec. It is illegal to then call avcodec_open2()
3127 * with a different codec.
3128 * If NULL, then the codec-specific defaults won't be initialized,
3129 * which may result in suboptimal default settings (this is
3130 * important mainly for encoders, e.g. libx264).
3132 * @return An AVCodecContext filled with default values or NULL on failure.
3134 AVCodecContext *avcodec_alloc_context3(const AVCodec *codec);
3137 * Free the codec context and everything associated with it and write NULL to
3138 * the provided pointer.
3140 void avcodec_free_context(AVCodecContext **avctx);
3142 #if FF_API_GET_CONTEXT_DEFAULTS
3144 * @deprecated This function should not be used, as closing and opening a codec
3145 * context multiple time is not supported. A new codec context should be
3146 * allocated for each new use.
3148 int avcodec_get_context_defaults3(AVCodecContext *s, const AVCodec *codec);
3152 * Get the AVClass for AVCodecContext. It can be used in combination with
3153 * AV_OPT_SEARCH_FAKE_OBJ for examining options.
3155 * @see av_opt_find().
3157 const AVClass *avcodec_get_class(void);
3159 #if FF_API_COPY_CONTEXT
3161 * Get the AVClass for AVFrame. It can be used in combination with
3162 * AV_OPT_SEARCH_FAKE_OBJ for examining options.
3164 * @see av_opt_find().
3166 const AVClass *avcodec_get_frame_class(void);
3169 * Get the AVClass for AVSubtitleRect. It can be used in combination with
3170 * AV_OPT_SEARCH_FAKE_OBJ for examining options.
3172 * @see av_opt_find().
3174 const AVClass *avcodec_get_subtitle_rect_class(void);
3177 * Copy the settings of the source AVCodecContext into the destination
3178 * AVCodecContext. The resulting destination codec context will be
3179 * unopened, i.e. you are required to call avcodec_open2() before you
3180 * can use this AVCodecContext to decode/encode video/audio data.
3182 * @param dest target codec context, should be initialized with
3183 * avcodec_alloc_context3(NULL), but otherwise uninitialized
3184 * @param src source codec context
3185 * @return AVERROR() on error (e.g. memory allocation error), 0 on success
3187 * @deprecated The semantics of this function are ill-defined and it should not
3188 * be used. If you need to transfer the stream parameters from one codec context
3189 * to another, use an intermediate AVCodecParameters instance and the
3190 * avcodec_parameters_from_context() / avcodec_parameters_to_context()
3193 attribute_deprecated
3194 int avcodec_copy_context(AVCodecContext *dest, const AVCodecContext *src);
3198 * Fill the parameters struct based on the values from the supplied codec
3199 * context. Any allocated fields in par are freed and replaced with duplicates
3200 * of the corresponding fields in codec.
3202 * @return >= 0 on success, a negative AVERROR code on failure
3204 int avcodec_parameters_from_context(AVCodecParameters *par,
3205 const AVCodecContext *codec);
3208 * Fill the codec context based on the values from the supplied codec
3209 * parameters. Any allocated fields in codec that have a corresponding field in
3210 * par are freed and replaced with duplicates of the corresponding field in par.
3211 * Fields in codec that do not have a counterpart in par are not touched.
3213 * @return >= 0 on success, a negative AVERROR code on failure.
3215 int avcodec_parameters_to_context(AVCodecContext *codec,
3216 const AVCodecParameters *par);
3219 * Initialize the AVCodecContext to use the given AVCodec. Prior to using this
3220 * function the context has to be allocated with avcodec_alloc_context3().
3222 * The functions avcodec_find_decoder_by_name(), avcodec_find_encoder_by_name(),
3223 * avcodec_find_decoder() and avcodec_find_encoder() provide an easy way for
3224 * retrieving a codec.
3226 * @warning This function is not thread safe!
3228 * @note Always call this function before using decoding routines (such as
3229 * @ref avcodec_receive_frame()).
3232 * avcodec_register_all();
3233 * av_dict_set(&opts, "b", "2.5M", 0);
3234 * codec = avcodec_find_decoder(AV_CODEC_ID_H264);
3238 * context = avcodec_alloc_context3(codec);
3240 * if (avcodec_open2(context, codec, opts) < 0)
3244 * @param avctx The context to initialize.
3245 * @param codec The codec to open this context for. If a non-NULL codec has been
3246 * previously passed to avcodec_alloc_context3() or
3247 * for this context, then this parameter MUST be either NULL or
3248 * equal to the previously passed codec.
3249 * @param options A dictionary filled with AVCodecContext and codec-private options.
3250 * On return this object will be filled with options that were not found.
3252 * @return zero on success, a negative value on error
3253 * @see avcodec_alloc_context3(), avcodec_find_decoder(), avcodec_find_encoder(),
3254 * av_dict_set(), av_opt_find().
3256 int avcodec_open2(AVCodecContext *avctx, const AVCodec *codec, AVDictionary **options);
3259 * Close a given AVCodecContext and free all the data associated with it
3260 * (but not the AVCodecContext itself).
3262 * Calling this function on an AVCodecContext that hasn't been opened will free
3263 * the codec-specific data allocated in avcodec_alloc_context3() with a non-NULL
3264 * codec. Subsequent calls will do nothing.
3266 * @note Do not use this function. Use avcodec_free_context() to destroy a
3267 * codec context (either open or closed). Opening and closing a codec context
3268 * multiple times is not supported anymore -- use multiple codec contexts
3271 int avcodec_close(AVCodecContext *avctx);
3274 * Free all allocated data in the given subtitle struct.
3276 * @param sub AVSubtitle to free.
3278 void avsubtitle_free(AVSubtitle *sub);
3285 * @addtogroup lavc_decoding
3290 * Find a registered decoder with a matching codec ID.
3292 * @param id AVCodecID of the requested decoder
3293 * @return A decoder if one was found, NULL otherwise.
3295 AVCodec *avcodec_find_decoder(enum AVCodecID id);
3298 * Find a registered decoder with the specified name.
3300 * @param name name of the requested decoder
3301 * @return A decoder if one was found, NULL otherwise.
3303 AVCodec *avcodec_find_decoder_by_name(const char *name);
3306 * The default callback for AVCodecContext.get_buffer2(). It is made public so
3307 * it can be called by custom get_buffer2() implementations for decoders without
3308 * AV_CODEC_CAP_DR1 set.
3310 int avcodec_default_get_buffer2(AVCodecContext *s, AVFrame *frame, int flags);
3313 * Modify width and height values so that they will result in a memory
3314 * buffer that is acceptable for the codec if you do not use any horizontal
3317 * May only be used if a codec with AV_CODEC_CAP_DR1 has been opened.
3319 void avcodec_align_dimensions(AVCodecContext *s, int *width, int *height);
3322 * Modify width and height values so that they will result in a memory
3323 * buffer that is acceptable for the codec if you also ensure that all
3324 * line sizes are a multiple of the respective linesize_align[i].
3326 * May only be used if a codec with AV_CODEC_CAP_DR1 has been opened.
3328 void avcodec_align_dimensions2(AVCodecContext *s, int *width, int *height,
3329 int linesize_align[AV_NUM_DATA_POINTERS]);
3332 * Converts AVChromaLocation to swscale x/y chroma position.
3334 * The positions represent the chroma (0,0) position in a coordinates system
3335 * with luma (0,0) representing the origin and luma(1,1) representing 256,256
3337 * @param xpos horizontal chroma sample position
3338 * @param ypos vertical chroma sample position
3340 int avcodec_enum_to_chroma_pos(int *xpos, int *ypos, enum AVChromaLocation pos);
3343 * Converts swscale x/y chroma position to AVChromaLocation.
3345 * The positions represent the chroma (0,0) position in a coordinates system
3346 * with luma (0,0) representing the origin and luma(1,1) representing 256,256
3348 * @param xpos horizontal chroma sample position
3349 * @param ypos vertical chroma sample position
3351 enum AVChromaLocation avcodec_chroma_pos_to_enum(int xpos, int ypos);
3354 * Decode the audio frame of size avpkt->size from avpkt->data into frame.
3356 * Some decoders may support multiple frames in a single AVPacket. Such
3357 * decoders would then just decode the first frame and the return value would be
3358 * less than the packet size. In this case, avcodec_decode_audio4 has to be
3359 * called again with an AVPacket containing the remaining data in order to
3360 * decode the second frame, etc... Even if no frames are returned, the packet
3361 * needs to be fed to the decoder with remaining data until it is completely
3362 * consumed or an error occurs.
3364 * Some decoders (those marked with AV_CODEC_CAP_DELAY) have a delay between input
3365 * and output. This means that for some packets they will not immediately
3366 * produce decoded output and need to be flushed at the end of decoding to get
3367 * all the decoded data. Flushing is done by calling this function with packets
3368 * with avpkt->data set to NULL and avpkt->size set to 0 until it stops
3369 * returning samples. It is safe to flush even those decoders that are not
3370 * marked with AV_CODEC_CAP_DELAY, then no samples will be returned.
3372 * @warning The input buffer, avpkt->data must be AV_INPUT_BUFFER_PADDING_SIZE
3373 * larger than the actual read bytes because some optimized bitstream
3374 * readers read 32 or 64 bits at once and could read over the end.
3376 * @note The AVCodecContext MUST have been opened with @ref avcodec_open2()
3377 * before packets may be fed to the decoder.
3379 * @param avctx the codec context
3380 * @param[out] frame The AVFrame in which to store decoded audio samples.
3381 * The decoder will allocate a buffer for the decoded frame by
3382 * calling the AVCodecContext.get_buffer2() callback.
3383 * When AVCodecContext.refcounted_frames is set to 1, the frame is
3384 * reference counted and the returned reference belongs to the
3385 * caller. The caller must release the frame using av_frame_unref()
3386 * when the frame is no longer needed. The caller may safely write
3387 * to the frame if av_frame_is_writable() returns 1.
3388 * When AVCodecContext.refcounted_frames is set to 0, the returned
3389 * reference belongs to the decoder and is valid only until the
3390 * next call to this function or until closing or flushing the
3391 * decoder. The caller may not write to it.
3392 * @param[out] got_frame_ptr Zero if no frame could be decoded, otherwise it is
3393 * non-zero. Note that this field being set to zero
3394 * does not mean that an error has occurred. For
3395 * decoders with AV_CODEC_CAP_DELAY set, no given decode
3396 * call is guaranteed to produce a frame.
3397 * @param[in] avpkt The input AVPacket containing the input buffer.
3398 * At least avpkt->data and avpkt->size should be set. Some
3399 * decoders might also require additional fields to be set.
3400 * @return A negative error code is returned if an error occurred during
3401 * decoding, otherwise the number of bytes consumed from the input
3402 * AVPacket is returned.
3404 * @deprecated Use avcodec_send_packet() and avcodec_receive_frame().
3406 attribute_deprecated
3407 int avcodec_decode_audio4(AVCodecContext *avctx, AVFrame *frame,
3408 int *got_frame_ptr, const AVPacket *avpkt);
3411 * Decode the video frame of size avpkt->size from avpkt->data into picture.
3412 * Some decoders may support multiple frames in a single AVPacket, such
3413 * decoders would then just decode the first frame.
3415 * @warning The input buffer must be AV_INPUT_BUFFER_PADDING_SIZE larger than
3416 * the actual read bytes because some optimized bitstream readers read 32 or 64
3417 * bits at once and could read over the end.
3419 * @warning The end of the input buffer buf should be set to 0 to ensure that
3420 * no overreading happens for damaged MPEG streams.
3422 * @note Codecs which have the AV_CODEC_CAP_DELAY capability set have a delay
3423 * between input and output, these need to be fed with avpkt->data=NULL,
3424 * avpkt->size=0 at the end to return the remaining frames.
3426 * @note The AVCodecContext MUST have been opened with @ref avcodec_open2()
3427 * before packets may be fed to the decoder.
3429 * @param avctx the codec context
3430 * @param[out] picture The AVFrame in which the decoded video frame will be stored.
3431 * Use av_frame_alloc() to get an AVFrame. The codec will
3432 * allocate memory for the actual bitmap by calling the
3433 * AVCodecContext.get_buffer2() callback.
3434 * When AVCodecContext.refcounted_frames is set to 1, the frame is
3435 * reference counted and the returned reference belongs to the
3436 * caller. The caller must release the frame using av_frame_unref()
3437 * when the frame is no longer needed. The caller may safely write
3438 * to the frame if av_frame_is_writable() returns 1.
3439 * When AVCodecContext.refcounted_frames is set to 0, the returned
3440 * reference belongs to the decoder and is valid only until the
3441 * next call to this function or until closing or flushing the
3442 * decoder. The caller may not write to it.
3444 * @param[in] avpkt The input AVPacket containing the input buffer.
3445 * You can create such packet with av_init_packet() and by then setting
3446 * data and size, some decoders might in addition need other fields like
3447 * flags&AV_PKT_FLAG_KEY. All decoders are designed to use the least
3449 * @param[in,out] got_picture_ptr Zero if no frame could be decompressed, otherwise, it is nonzero.
3450 * @return On error a negative value is returned, otherwise the number of bytes
3451 * used or zero if no frame could be decompressed.
3453 * @deprecated Use avcodec_send_packet() and avcodec_receive_frame().
3455 attribute_deprecated
3456 int avcodec_decode_video2(AVCodecContext *avctx, AVFrame *picture,
3457 int *got_picture_ptr,
3458 const AVPacket *avpkt);
3461 * Decode a subtitle message.
3462 * Return a negative value on error, otherwise return the number of bytes used.
3463 * If no subtitle could be decompressed, got_sub_ptr is zero.
3464 * Otherwise, the subtitle is stored in *sub.
3465 * Note that AV_CODEC_CAP_DR1 is not available for subtitle codecs. This is for
3466 * simplicity, because the performance difference is expected to be negligible
3467 * and reusing a get_buffer written for video codecs would probably perform badly
3468 * due to a potentially very different allocation pattern.
3470 * Some decoders (those marked with AV_CODEC_CAP_DELAY) have a delay between input
3471 * and output. This means that for some packets they will not immediately
3472 * produce decoded output and need to be flushed at the end of decoding to get
3473 * all the decoded data. Flushing is done by calling this function with packets
3474 * with avpkt->data set to NULL and avpkt->size set to 0 until it stops
3475 * returning subtitles. It is safe to flush even those decoders that are not
3476 * marked with AV_CODEC_CAP_DELAY, then no subtitles will be returned.
3478 * @note The AVCodecContext MUST have been opened with @ref avcodec_open2()
3479 * before packets may be fed to the decoder.
3481 * @param avctx the codec context
3482 * @param[out] sub The preallocated AVSubtitle in which the decoded subtitle will be stored,
3483 * must be freed with avsubtitle_free if *got_sub_ptr is set.
3484 * @param[in,out] got_sub_ptr Zero if no subtitle could be decompressed, otherwise, it is nonzero.
3485 * @param[in] avpkt The input AVPacket containing the input buffer.
3487 int avcodec_decode_subtitle2(AVCodecContext *avctx, AVSubtitle *sub,
3492 * Supply raw packet data as input to a decoder.
3494 * Internally, this call will copy relevant AVCodecContext fields, which can
3495 * influence decoding per-packet, and apply them when the packet is actually
3496 * decoded. (For example AVCodecContext.skip_frame, which might direct the
3497 * decoder to drop the frame contained by the packet sent with this function.)
3499 * @warning The input buffer, avpkt->data must be AV_INPUT_BUFFER_PADDING_SIZE
3500 * larger than the actual read bytes because some optimized bitstream
3501 * readers read 32 or 64 bits at once and could read over the end.
3503 * @warning Do not mix this API with the legacy API (like avcodec_decode_video2())
3504 * on the same AVCodecContext. It will return unexpected results now
3505 * or in future libavcodec versions.
3507 * @note The AVCodecContext MUST have been opened with @ref avcodec_open2()
3508 * before packets may be fed to the decoder.
3510 * @param avctx codec context
3511 * @param[in] avpkt The input AVPacket. Usually, this will be a single video
3512 * frame, or several complete audio frames.
3513 * Ownership of the packet remains with the caller, and the
3514 * decoder will not write to the packet. The decoder may create
3515 * a reference to the packet data (or copy it if the packet is
3516 * not reference-counted).
3517 * Unlike with older APIs, the packet is always fully consumed,
3518 * and if it contains multiple frames (e.g. some audio codecs),
3519 * will require you to call avcodec_receive_frame() multiple
3520 * times afterwards before you can send a new packet.
3521 * It can be NULL (or an AVPacket with data set to NULL and
3522 * size set to 0); in this case, it is considered a flush
3523 * packet, which signals the end of the stream. Sending the
3524 * first flush packet will return success. Subsequent ones are
3525 * unnecessary and will return AVERROR_EOF. If the decoder
3526 * still has frames buffered, it will return them after sending
3529 * @return 0 on success, otherwise negative error code:
3530 * AVERROR(EAGAIN): input is not accepted in the current state - user
3531 * must read output with avcodec_receive_frame() (once
3532 * all output is read, the packet should be resent, and
3533 * the call will not fail with EAGAIN).
3534 * AVERROR_EOF: the decoder has been flushed, and no new packets can
3535 * be sent to it (also returned if more than 1 flush
3537 * AVERROR(EINVAL): codec not opened, it is an encoder, or requires flush
3538 * AVERROR(ENOMEM): failed to add packet to internal queue, or similar
3539 * other errors: legitimate decoding errors
3541 int avcodec_send_packet(AVCodecContext *avctx, const AVPacket *avpkt);
3544 * Return decoded output data from a decoder.
3546 * @param avctx codec context
3547 * @param frame This will be set to a reference-counted video or audio
3548 * frame (depending on the decoder type) allocated by the
3549 * decoder. Note that the function will always call
3550 * av_frame_unref(frame) before doing anything else.
3553 * 0: success, a frame was returned
3554 * AVERROR(EAGAIN): output is not available in this state - user must try
3556 * AVERROR_EOF: the decoder has been fully flushed, and there will be
3557 * no more output frames
3558 * AVERROR(EINVAL): codec not opened, or it is an encoder
3559 * AVERROR_INPUT_CHANGED: current decoded frame has changed parameters
3560 * with respect to first decoded frame. Applicable
3561 * when flag AV_CODEC_FLAG_DROPCHANGED is set.
3562 * other negative values: legitimate decoding errors
3564 int avcodec_receive_frame(AVCodecContext *avctx, AVFrame *frame);
3567 * Supply a raw video or audio frame to the encoder. Use avcodec_receive_packet()
3568 * to retrieve buffered output packets.
3570 * @param avctx codec context
3571 * @param[in] frame AVFrame containing the raw audio or video frame to be encoded.
3572 * Ownership of the frame remains with the caller, and the
3573 * encoder will not write to the frame. The encoder may create
3574 * a reference to the frame data (or copy it if the frame is
3575 * not reference-counted).
3576 * It can be NULL, in which case it is considered a flush
3577 * packet. This signals the end of the stream. If the encoder
3578 * still has packets buffered, it will return them after this
3579 * call. Once flushing mode has been entered, additional flush
3580 * packets are ignored, and sending frames will return
3584 * If AV_CODEC_CAP_VARIABLE_FRAME_SIZE is set, then each frame
3585 * can have any number of samples.
3586 * If it is not set, frame->nb_samples must be equal to
3587 * avctx->frame_size for all frames except the last.
3588 * The final frame may be smaller than avctx->frame_size.
3589 * @return 0 on success, otherwise negative error code:
3590 * AVERROR(EAGAIN): input is not accepted in the current state - user
3591 * must read output with avcodec_receive_packet() (once
3592 * all output is read, the packet should be resent, and
3593 * the call will not fail with EAGAIN).
3594 * AVERROR_EOF: the encoder has been flushed, and no new frames can
3596 * AVERROR(EINVAL): codec not opened, refcounted_frames not set, it is a
3597 * decoder, or requires flush
3598 * AVERROR(ENOMEM): failed to add packet to internal queue, or similar
3599 * other errors: legitimate encoding errors
3601 int avcodec_send_frame(AVCodecContext *avctx, const AVFrame *frame);
3604 * Read encoded data from the encoder.
3606 * @param avctx codec context
3607 * @param avpkt This will be set to a reference-counted packet allocated by the
3608 * encoder. Note that the function will always call
3609 * av_packet_unref(avpkt) before doing anything else.
3610 * @return 0 on success, otherwise negative error code:
3611 * AVERROR(EAGAIN): output is not available in the current state - user
3612 * must try to send input
3613 * AVERROR_EOF: the encoder has been fully flushed, and there will be
3614 * no more output packets
3615 * AVERROR(EINVAL): codec not opened, or it is a decoder
3616 * other errors: legitimate encoding errors
3618 int avcodec_receive_packet(AVCodecContext *avctx, AVPacket *avpkt);
3621 * Create and return a AVHWFramesContext with values adequate for hardware
3622 * decoding. This is meant to get called from the get_format callback, and is
3623 * a helper for preparing a AVHWFramesContext for AVCodecContext.hw_frames_ctx.
3624 * This API is for decoding with certain hardware acceleration modes/APIs only.
3626 * The returned AVHWFramesContext is not initialized. The caller must do this
3627 * with av_hwframe_ctx_init().
3629 * Calling this function is not a requirement, but makes it simpler to avoid
3630 * codec or hardware API specific details when manually allocating frames.
3632 * Alternatively to this, an API user can set AVCodecContext.hw_device_ctx,
3633 * which sets up AVCodecContext.hw_frames_ctx fully automatically, and makes
3634 * it unnecessary to call this function or having to care about
3635 * AVHWFramesContext initialization at all.
3637 * There are a number of requirements for calling this function:
3639 * - It must be called from get_format with the same avctx parameter that was
3640 * passed to get_format. Calling it outside of get_format is not allowed, and
3641 * can trigger undefined behavior.
3642 * - The function is not always supported (see description of return values).
3643 * Even if this function returns successfully, hwaccel initialization could
3644 * fail later. (The degree to which implementations check whether the stream
3645 * is actually supported varies. Some do this check only after the user's
3646 * get_format callback returns.)
3647 * - The hw_pix_fmt must be one of the choices suggested by get_format. If the
3648 * user decides to use a AVHWFramesContext prepared with this API function,
3649 * the user must return the same hw_pix_fmt from get_format.
3650 * - The device_ref passed to this function must support the given hw_pix_fmt.
3651 * - After calling this API function, it is the user's responsibility to
3652 * initialize the AVHWFramesContext (returned by the out_frames_ref parameter),
3653 * and to set AVCodecContext.hw_frames_ctx to it. If done, this must be done
3654 * before returning from get_format (this is implied by the normal
3655 * AVCodecContext.hw_frames_ctx API rules).
3656 * - The AVHWFramesContext parameters may change every time time get_format is
3657 * called. Also, AVCodecContext.hw_frames_ctx is reset before get_format. So
3658 * you are inherently required to go through this process again on every
3660 * - It is perfectly possible to call this function without actually using
3661 * the resulting AVHWFramesContext. One use-case might be trying to reuse a
3662 * previously initialized AVHWFramesContext, and calling this API function
3663 * only to test whether the required frame parameters have changed.
3664 * - Fields that use dynamically allocated values of any kind must not be set
3665 * by the user unless setting them is explicitly allowed by the documentation.
3666 * If the user sets AVHWFramesContext.free and AVHWFramesContext.user_opaque,
3667 * the new free callback must call the potentially set previous free callback.
3668 * This API call may set any dynamically allocated fields, including the free
3671 * The function will set at least the following fields on AVHWFramesContext
3672 * (potentially more, depending on hwaccel API):
3674 * - All fields set by av_hwframe_ctx_alloc().
3675 * - Set the format field to hw_pix_fmt.
3676 * - Set the sw_format field to the most suited and most versatile format. (An
3677 * implication is that this will prefer generic formats over opaque formats
3678 * with arbitrary restrictions, if possible.)
3679 * - Set the width/height fields to the coded frame size, rounded up to the
3680 * API-specific minimum alignment.
3681 * - Only _if_ the hwaccel requires a pre-allocated pool: set the initial_pool_size
3682 * field to the number of maximum reference surfaces possible with the codec,
3683 * plus 1 surface for the user to work (meaning the user can safely reference
3684 * at most 1 decoded surface at a time), plus additional buffering introduced
3685 * by frame threading. If the hwaccel does not require pre-allocation, the
3686 * field is left to 0, and the decoder will allocate new surfaces on demand
3688 * - Possibly AVHWFramesContext.hwctx fields, depending on the underlying
3691 * Essentially, out_frames_ref returns the same as av_hwframe_ctx_alloc(), but
3692 * with basic frame parameters set.
3694 * The function is stateless, and does not change the AVCodecContext or the
3695 * device_ref AVHWDeviceContext.
3697 * @param avctx The context which is currently calling get_format, and which
3698 * implicitly contains all state needed for filling the returned
3699 * AVHWFramesContext properly.
3700 * @param device_ref A reference to the AVHWDeviceContext describing the device
3701 * which will be used by the hardware decoder.
3702 * @param hw_pix_fmt The hwaccel format you are going to return from get_format.
3703 * @param out_frames_ref On success, set to a reference to an _uninitialized_
3704 * AVHWFramesContext, created from the given device_ref.
3705 * Fields will be set to values required for decoding.
3706 * Not changed if an error is returned.
3707 * @return zero on success, a negative value on error. The following error codes
3708 * have special semantics:
3709 * AVERROR(ENOENT): the decoder does not support this functionality. Setup
3710 * is always manual, or it is a decoder which does not
3711 * support setting AVCodecContext.hw_frames_ctx at all,
3712 * or it is a software format.
3713 * AVERROR(EINVAL): it is known that hardware decoding is not supported for
3714 * this configuration, or the device_ref is not supported
3715 * for the hwaccel referenced by hw_pix_fmt.
3717 int avcodec_get_hw_frames_parameters(AVCodecContext *avctx,
3718 AVBufferRef *device_ref,
3719 enum AVPixelFormat hw_pix_fmt,
3720 AVBufferRef **out_frames_ref);
3725 * @defgroup lavc_parsing Frame parsing
3729 enum AVPictureStructure {
3730 AV_PICTURE_STRUCTURE_UNKNOWN, //< unknown
3731 AV_PICTURE_STRUCTURE_TOP_FIELD, //< coded as top field
3732 AV_PICTURE_STRUCTURE_BOTTOM_FIELD, //< coded as bottom field
3733 AV_PICTURE_STRUCTURE_FRAME, //< coded as frame
3736 typedef struct AVCodecParserContext {
3738 struct AVCodecParser *parser;
3739 int64_t frame_offset; /* offset of the current frame */
3740 int64_t cur_offset; /* current offset
3741 (incremented by each av_parser_parse()) */
3742 int64_t next_frame_offset; /* offset of the next frame */
3744 int pict_type; /* XXX: Put it back in AVCodecContext. */
3746 * This field is used for proper frame duration computation in lavf.
3747 * It signals, how much longer the frame duration of the current frame
3748 * is compared to normal frame duration.
3750 * frame_duration = (1 + repeat_pict) * time_base
3752 * It is used by codecs like H.264 to display telecined material.
3754 int repeat_pict; /* XXX: Put it back in AVCodecContext. */
3755 int64_t pts; /* pts of the current frame */
3756 int64_t dts; /* dts of the current frame */
3761 int fetch_timestamp;
3763 #define AV_PARSER_PTS_NB 4
3764 int cur_frame_start_index;
3765 int64_t cur_frame_offset[AV_PARSER_PTS_NB];
3766 int64_t cur_frame_pts[AV_PARSER_PTS_NB];
3767 int64_t cur_frame_dts[AV_PARSER_PTS_NB];
3770 #define PARSER_FLAG_COMPLETE_FRAMES 0x0001
3771 #define PARSER_FLAG_ONCE 0x0002
3772 /// Set if the parser has a valid file offset
3773 #define PARSER_FLAG_FETCHED_OFFSET 0x0004
3774 #define PARSER_FLAG_USE_CODEC_TS 0x1000
3776 int64_t offset; ///< byte offset from starting packet start
3777 int64_t cur_frame_end[AV_PARSER_PTS_NB];
3780 * Set by parser to 1 for key frames and 0 for non-key frames.
3781 * It is initialized to -1, so if the parser doesn't set this flag,
3782 * old-style fallback using AV_PICTURE_TYPE_I picture type as key frames
3787 #if FF_API_CONVERGENCE_DURATION
3789 * @deprecated unused
3791 attribute_deprecated
3792 int64_t convergence_duration;
3795 // Timestamp generation support:
3797 * Synchronization point for start of timestamp generation.
3799 * Set to >0 for sync point, 0 for no sync point and <0 for undefined
3802 * For example, this corresponds to presence of H.264 buffering period
3808 * Offset of the current timestamp against last timestamp sync point in
3809 * units of AVCodecContext.time_base.
3811 * Set to INT_MIN when dts_sync_point unused. Otherwise, it must
3812 * contain a valid timestamp offset.
3814 * Note that the timestamp of sync point has usually a nonzero
3815 * dts_ref_dts_delta, which refers to the previous sync point. Offset of
3816 * the next frame after timestamp sync point will be usually 1.
3818 * For example, this corresponds to H.264 cpb_removal_delay.
3820 int dts_ref_dts_delta;
3823 * Presentation delay of current frame in units of AVCodecContext.time_base.
3825 * Set to INT_MIN when dts_sync_point unused. Otherwise, it must
3826 * contain valid non-negative timestamp delta (presentation time of a frame
3827 * must not lie in the past).
3829 * This delay represents the difference between decoding and presentation
3830 * time of the frame.
3832 * For example, this corresponds to H.264 dpb_output_delay.
3837 * Position of the packet in file.
3839 * Analogous to cur_frame_pts/dts
3841 int64_t cur_frame_pos[AV_PARSER_PTS_NB];
3844 * Byte position of currently parsed frame in stream.
3849 * Previous frame byte position.
3854 * Duration of the current frame.
3855 * For audio, this is in units of 1 / AVCodecContext.sample_rate.
3856 * For all other types, this is in units of AVCodecContext.time_base.
3860 enum AVFieldOrder field_order;
3863 * Indicate whether a picture is coded as a frame, top field or bottom field.
3865 * For example, H.264 field_pic_flag equal to 0 corresponds to
3866 * AV_PICTURE_STRUCTURE_FRAME. An H.264 picture with field_pic_flag
3867 * equal to 1 and bottom_field_flag equal to 0 corresponds to
3868 * AV_PICTURE_STRUCTURE_TOP_FIELD.
3870 enum AVPictureStructure picture_structure;
3873 * Picture number incremented in presentation or output order.
3874 * This field may be reinitialized at the first picture of a new sequence.
3876 * For example, this corresponds to H.264 PicOrderCnt.
3878 int output_picture_number;
3881 * Dimensions of the decoded video intended for presentation.
3887 * Dimensions of the coded video.
3893 * The format of the coded data, corresponds to enum AVPixelFormat for video
3894 * and for enum AVSampleFormat for audio.
3896 * Note that a decoder can have considerable freedom in how exactly it
3897 * decodes the data, so the format reported here might be different from the
3898 * one returned by a decoder.
3901 } AVCodecParserContext;
3903 typedef struct AVCodecParser {
3904 int codec_ids[5]; /* several codec IDs are permitted */
3906 int (*parser_init)(AVCodecParserContext *s);
3907 /* This callback never returns an error, a negative value means that
3908 * the frame start was in a previous packet. */
3909 int (*parser_parse)(AVCodecParserContext *s,
3910 AVCodecContext *avctx,
3911 const uint8_t **poutbuf, int *poutbuf_size,
3912 const uint8_t *buf, int buf_size);
3913 void (*parser_close)(AVCodecParserContext *s);
3914 int (*split)(AVCodecContext *avctx, const uint8_t *buf, int buf_size);
3915 struct AVCodecParser *next;
3919 * Iterate over all registered codec parsers.
3921 * @param opaque a pointer where libavcodec will store the iteration state. Must
3922 * point to NULL to start the iteration.
3924 * @return the next registered codec parser or NULL when the iteration is
3927 const AVCodecParser *av_parser_iterate(void **opaque);
3929 attribute_deprecated
3930 AVCodecParser *av_parser_next(const AVCodecParser *c);
3932 attribute_deprecated
3933 void av_register_codec_parser(AVCodecParser *parser);
3934 AVCodecParserContext *av_parser_init(int codec_id);
3939 * @param s parser context.
3940 * @param avctx codec context.
3941 * @param poutbuf set to pointer to parsed buffer or NULL if not yet finished.
3942 * @param poutbuf_size set to size of parsed buffer or zero if not yet finished.
3943 * @param buf input buffer.
3944 * @param buf_size buffer size in bytes without the padding. I.e. the full buffer
3945 size is assumed to be buf_size + AV_INPUT_BUFFER_PADDING_SIZE.
3946 To signal EOF, this should be 0 (so that the last frame
3948 * @param pts input presentation timestamp.
3949 * @param dts input decoding timestamp.
3950 * @param pos input byte position in stream.
3951 * @return the number of bytes of the input bitstream used.
3956 * len = av_parser_parse2(myparser, AVCodecContext, &data, &size,
3963 * decode_frame(data, size);
3967 int av_parser_parse2(AVCodecParserContext *s,
3968 AVCodecContext *avctx,
3969 uint8_t **poutbuf, int *poutbuf_size,
3970 const uint8_t *buf, int buf_size,
3971 int64_t pts, int64_t dts,
3975 * @return 0 if the output buffer is a subset of the input, 1 if it is allocated and must be freed
3976 * @deprecated use AVBitStreamFilter
3978 int av_parser_change(AVCodecParserContext *s,
3979 AVCodecContext *avctx,
3980 uint8_t **poutbuf, int *poutbuf_size,
3981 const uint8_t *buf, int buf_size, int keyframe);
3982 void av_parser_close(AVCodecParserContext *s);
3990 * @addtogroup lavc_encoding
3995 * Find a registered encoder with a matching codec ID.
3997 * @param id AVCodecID of the requested encoder
3998 * @return An encoder if one was found, NULL otherwise.
4000 AVCodec *avcodec_find_encoder(enum AVCodecID id);
4003 * Find a registered encoder with the specified name.
4005 * @param name name of the requested encoder
4006 * @return An encoder if one was found, NULL otherwise.
4008 AVCodec *avcodec_find_encoder_by_name(const char *name);
4011 * Encode a frame of audio.
4013 * Takes input samples from frame and writes the next output packet, if
4014 * available, to avpkt. The output packet does not necessarily contain data for
4015 * the most recent frame, as encoders can delay, split, and combine input frames
4016 * internally as needed.
4018 * @param avctx codec context
4019 * @param avpkt output AVPacket.
4020 * The user can supply an output buffer by setting
4021 * avpkt->data and avpkt->size prior to calling the
4022 * function, but if the size of the user-provided data is not
4023 * large enough, encoding will fail. If avpkt->data and
4024 * avpkt->size are set, avpkt->destruct must also be set. All
4025 * other AVPacket fields will be reset by the encoder using
4026 * av_init_packet(). If avpkt->data is NULL, the encoder will
4027 * allocate it. The encoder will set avpkt->size to the size
4028 * of the output packet.
4030 * If this function fails or produces no output, avpkt will be
4031 * freed using av_packet_unref().
4032 * @param[in] frame AVFrame containing the raw audio data to be encoded.
4033 * May be NULL when flushing an encoder that has the
4034 * AV_CODEC_CAP_DELAY capability set.
4035 * If AV_CODEC_CAP_VARIABLE_FRAME_SIZE is set, then each frame
4036 * can have any number of samples.
4037 * If it is not set, frame->nb_samples must be equal to
4038 * avctx->frame_size for all frames except the last.
4039 * The final frame may be smaller than avctx->frame_size.
4040 * @param[out] got_packet_ptr This field is set to 1 by libavcodec if the
4041 * output packet is non-empty, and to 0 if it is
4042 * empty. If the function returns an error, the
4043 * packet can be assumed to be invalid, and the
4044 * value of got_packet_ptr is undefined and should
4046 * @return 0 on success, negative error code on failure
4048 * @deprecated use avcodec_send_frame()/avcodec_receive_packet() instead
4050 attribute_deprecated
4051 int avcodec_encode_audio2(AVCodecContext *avctx, AVPacket *avpkt,
4052 const AVFrame *frame, int *got_packet_ptr);
4055 * Encode a frame of video.
4057 * Takes input raw video data from frame and writes the next output packet, if
4058 * available, to avpkt. The output packet does not necessarily contain data for
4059 * the most recent frame, as encoders can delay and reorder input frames
4060 * internally as needed.
4062 * @param avctx codec context
4063 * @param avpkt output AVPacket.
4064 * The user can supply an output buffer by setting
4065 * avpkt->data and avpkt->size prior to calling the
4066 * function, but if the size of the user-provided data is not
4067 * large enough, encoding will fail. All other AVPacket fields
4068 * will be reset by the encoder using av_init_packet(). If
4069 * avpkt->data is NULL, the encoder will allocate it.
4070 * The encoder will set avpkt->size to the size of the
4071 * output packet. The returned data (if any) belongs to the
4072 * caller, he is responsible for freeing it.
4074 * If this function fails or produces no output, avpkt will be
4075 * freed using av_packet_unref().
4076 * @param[in] frame AVFrame containing the raw video data to be encoded.
4077 * May be NULL when flushing an encoder that has the
4078 * AV_CODEC_CAP_DELAY capability set.
4079 * @param[out] got_packet_ptr This field is set to 1 by libavcodec if the
4080 * output packet is non-empty, and to 0 if it is
4081 * empty. If the function returns an error, the
4082 * packet can be assumed to be invalid, and the
4083 * value of got_packet_ptr is undefined and should
4085 * @return 0 on success, negative error code on failure
4087 * @deprecated use avcodec_send_frame()/avcodec_receive_packet() instead
4089 attribute_deprecated
4090 int avcodec_encode_video2(AVCodecContext *avctx, AVPacket *avpkt,
4091 const AVFrame *frame, int *got_packet_ptr);
4093 int avcodec_encode_subtitle(AVCodecContext *avctx, uint8_t *buf, int buf_size,
4094 const AVSubtitle *sub);
4101 #if FF_API_AVPICTURE
4103 * @addtogroup lavc_picture
4108 * @deprecated unused
4110 attribute_deprecated
4111 int avpicture_alloc(AVPicture *picture, enum AVPixelFormat pix_fmt, int width, int height);
4114 * @deprecated unused
4116 attribute_deprecated
4117 void avpicture_free(AVPicture *picture);
4120 * @deprecated use av_image_fill_arrays() instead.
4122 attribute_deprecated
4123 int avpicture_fill(AVPicture *picture, const uint8_t *ptr,
4124 enum AVPixelFormat pix_fmt, int width, int height);
4127 * @deprecated use av_image_copy_to_buffer() instead.
4129 attribute_deprecated
4130 int avpicture_layout(const AVPicture *src, enum AVPixelFormat pix_fmt,
4131 int width, int height,
4132 unsigned char *dest, int dest_size);
4135 * @deprecated use av_image_get_buffer_size() instead.
4137 attribute_deprecated
4138 int avpicture_get_size(enum AVPixelFormat pix_fmt, int width, int height);
4141 * @deprecated av_image_copy() instead.
4143 attribute_deprecated
4144 void av_picture_copy(AVPicture *dst, const AVPicture *src,
4145 enum AVPixelFormat pix_fmt, int width, int height);
4148 * @deprecated unused
4150 attribute_deprecated
4151 int av_picture_crop(AVPicture *dst, const AVPicture *src,
4152 enum AVPixelFormat pix_fmt, int top_band, int left_band);
4155 * @deprecated unused
4157 attribute_deprecated
4158 int av_picture_pad(AVPicture *dst, const AVPicture *src, int height, int width, enum AVPixelFormat pix_fmt,
4159 int padtop, int padbottom, int padleft, int padright, int *color);
4167 * @defgroup lavc_misc Utility functions
4170 * Miscellaneous utility functions related to both encoding and decoding
4176 * @defgroup lavc_misc_pixfmt Pixel formats
4178 * Functions for working with pixel formats.
4182 #if FF_API_GETCHROMA
4184 * @deprecated Use av_pix_fmt_get_chroma_sub_sample
4187 attribute_deprecated
4188 void avcodec_get_chroma_sub_sample(enum AVPixelFormat pix_fmt, int *h_shift, int *v_shift);
4192 * Return a value representing the fourCC code associated to the
4193 * pixel format pix_fmt, or 0 if no associated fourCC code can be
4196 unsigned int avcodec_pix_fmt_to_codec_tag(enum AVPixelFormat pix_fmt);
4199 * @deprecated see av_get_pix_fmt_loss()
4201 int avcodec_get_pix_fmt_loss(enum AVPixelFormat dst_pix_fmt, enum AVPixelFormat src_pix_fmt,
4205 * Find the best pixel format to convert to given a certain source pixel
4206 * format. When converting from one pixel format to another, information loss
4207 * may occur. For example, when converting from RGB24 to GRAY, the color
4208 * information will be lost. Similarly, other losses occur when converting from
4209 * some formats to other formats. avcodec_find_best_pix_fmt_of_2() searches which of
4210 * the given pixel formats should be used to suffer the least amount of loss.
4211 * The pixel formats from which it chooses one, are determined by the
4212 * pix_fmt_list parameter.
4215 * @param[in] pix_fmt_list AV_PIX_FMT_NONE terminated array of pixel formats to choose from
4216 * @param[in] src_pix_fmt source pixel format
4217 * @param[in] has_alpha Whether the source pixel format alpha channel is used.
4218 * @param[out] loss_ptr Combination of flags informing you what kind of losses will occur.
4219 * @return The best pixel format to convert to or -1 if none was found.
4221 enum AVPixelFormat avcodec_find_best_pix_fmt_of_list(const enum AVPixelFormat *pix_fmt_list,
4222 enum AVPixelFormat src_pix_fmt,
4223 int has_alpha, int *loss_ptr);
4226 * @deprecated see av_find_best_pix_fmt_of_2()
4228 enum AVPixelFormat avcodec_find_best_pix_fmt_of_2(enum AVPixelFormat dst_pix_fmt1, enum AVPixelFormat dst_pix_fmt2,
4229 enum AVPixelFormat src_pix_fmt, int has_alpha, int *loss_ptr);
4231 attribute_deprecated
4232 enum AVPixelFormat avcodec_find_best_pix_fmt2(enum AVPixelFormat dst_pix_fmt1, enum AVPixelFormat dst_pix_fmt2,
4233 enum AVPixelFormat src_pix_fmt, int has_alpha, int *loss_ptr);
4235 enum AVPixelFormat avcodec_default_get_format(struct AVCodecContext *s, const enum AVPixelFormat * fmt);
4241 #if FF_API_TAG_STRING
4243 * Put a string representing the codec tag codec_tag in buf.
4245 * @param buf buffer to place codec tag in
4246 * @param buf_size size in bytes of buf
4247 * @param codec_tag codec tag to assign
4248 * @return the length of the string that would have been generated if
4249 * enough space had been available, excluding the trailing null
4251 * @deprecated see av_fourcc_make_string() and av_fourcc2str().
4253 attribute_deprecated
4254 size_t av_get_codec_tag_string(char *buf, size_t buf_size, unsigned int codec_tag);
4257 void avcodec_string(char *buf, int buf_size, AVCodecContext *enc, int encode);
4260 * Return a name for the specified profile, if available.
4262 * @param codec the codec that is searched for the given profile
4263 * @param profile the profile value for which a name is requested
4264 * @return A name for the profile if found, NULL otherwise.
4266 const char *av_get_profile_name(const AVCodec *codec, int profile);
4269 * Return a name for the specified profile, if available.
4271 * @param codec_id the ID of the codec to which the requested profile belongs
4272 * @param profile the profile value for which a name is requested
4273 * @return A name for the profile if found, NULL otherwise.
4275 * @note unlike av_get_profile_name(), which searches a list of profiles
4276 * supported by a specific decoder or encoder implementation, this
4277 * function searches the list of profiles from the AVCodecDescriptor
4279 const char *avcodec_profile_name(enum AVCodecID codec_id, int profile);
4281 int avcodec_default_execute(AVCodecContext *c, int (*func)(AVCodecContext *c2, void *arg2),void *arg, int *ret, int count, int size);
4282 int avcodec_default_execute2(AVCodecContext *c, int (*func)(AVCodecContext *c2, void *arg2, int, int),void *arg, int *ret, int count);
4283 //FIXME func typedef
4286 * Fill AVFrame audio data and linesize pointers.
4288 * The buffer buf must be a preallocated buffer with a size big enough
4289 * to contain the specified samples amount. The filled AVFrame data
4290 * pointers will point to this buffer.
4292 * AVFrame extended_data channel pointers are allocated if necessary for
4295 * @param frame the AVFrame
4296 * frame->nb_samples must be set prior to calling the
4297 * function. This function fills in frame->data,
4298 * frame->extended_data, frame->linesize[0].
4299 * @param nb_channels channel count
4300 * @param sample_fmt sample format
4301 * @param buf buffer to use for frame data
4302 * @param buf_size size of buffer
4303 * @param align plane size sample alignment (0 = default)
4304 * @return >=0 on success, negative error code on failure
4305 * @todo return the size in bytes required to store the samples in
4306 * case of success, at the next libavutil bump
4308 int avcodec_fill_audio_frame(AVFrame *frame, int nb_channels,
4309 enum AVSampleFormat sample_fmt, const uint8_t *buf,
4310 int buf_size, int align);
4313 * Reset the internal codec state / flush internal buffers. Should be called
4314 * e.g. when seeking or when switching to a different stream.
4316 * @note for decoders, when refcounted frames are not used
4317 * (i.e. avctx->refcounted_frames is 0), this invalidates the frames previously
4318 * returned from the decoder. When refcounted frames are used, the decoder just
4319 * releases any references it might keep internally, but the caller's reference
4322 * @note for encoders, this function will only do something if the encoder
4323 * declares support for AV_CODEC_CAP_ENCODER_FLUSH. When called, the encoder
4324 * will drain any remaining packets, and can then be re-used for a different
4325 * stream (as opposed to sending a null frame which will leave the encoder
4326 * in a permanent EOF state after draining). This can be desirable if the
4327 * cost of tearing down and replacing the encoder instance is high.
4329 void avcodec_flush_buffers(AVCodecContext *avctx);
4332 * Return codec bits per sample.
4334 * @param[in] codec_id the codec
4335 * @return Number of bits per sample or zero if unknown for the given codec.
4337 int av_get_bits_per_sample(enum AVCodecID codec_id);
4340 * Return the PCM codec associated with a sample format.
4341 * @param be endianness, 0 for little, 1 for big,
4342 * -1 (or anything else) for native
4343 * @return AV_CODEC_ID_PCM_* or AV_CODEC_ID_NONE
4345 enum AVCodecID av_get_pcm_codec(enum AVSampleFormat fmt, int be);
4348 * Return codec bits per sample.
4349 * Only return non-zero if the bits per sample is exactly correct, not an
4352 * @param[in] codec_id the codec
4353 * @return Number of bits per sample or zero if unknown for the given codec.
4355 int av_get_exact_bits_per_sample(enum AVCodecID codec_id);
4358 * Return audio frame duration.
4360 * @param avctx codec context
4361 * @param frame_bytes size of the frame, or 0 if unknown
4362 * @return frame duration, in samples, if known. 0 if not able to
4365 int av_get_audio_frame_duration(AVCodecContext *avctx, int frame_bytes);
4368 * This function is the same as av_get_audio_frame_duration(), except it works
4369 * with AVCodecParameters instead of an AVCodecContext.
4371 int av_get_audio_frame_duration2(AVCodecParameters *par, int frame_bytes);
4374 typedef struct AVBitStreamFilterContext {
4376 const struct AVBitStreamFilter *filter;
4377 AVCodecParserContext *parser;
4378 struct AVBitStreamFilterContext *next;
4380 * Internal default arguments, used if NULL is passed to av_bitstream_filter_filter().
4381 * Not for access by library users.
4384 } AVBitStreamFilterContext;
4387 typedef struct AVBSFInternal AVBSFInternal;
4390 * The bitstream filter state.
4392 * This struct must be allocated with av_bsf_alloc() and freed with
4395 * The fields in the struct will only be changed (by the caller or by the
4396 * filter) as described in their documentation, and are to be considered
4397 * immutable otherwise.
4399 typedef struct AVBSFContext {
4401 * A class for logging and AVOptions
4403 const AVClass *av_class;
4406 * The bitstream filter this context is an instance of.
4408 const struct AVBitStreamFilter *filter;
4411 * Opaque libavcodec internal data. Must not be touched by the caller in any
4414 AVBSFInternal *internal;
4417 * Opaque filter-specific private data. If filter->priv_class is non-NULL,
4418 * this is an AVOptions-enabled struct.
4423 * Parameters of the input stream. This field is allocated in
4424 * av_bsf_alloc(), it needs to be filled by the caller before
4427 AVCodecParameters *par_in;
4430 * Parameters of the output stream. This field is allocated in
4431 * av_bsf_alloc(), it is set by the filter in av_bsf_init().
4433 AVCodecParameters *par_out;
4436 * The timebase used for the timestamps of the input packets. Set by the
4437 * caller before av_bsf_init().
4439 AVRational time_base_in;
4442 * The timebase used for the timestamps of the output packets. Set by the
4443 * filter in av_bsf_init().
4445 AVRational time_base_out;
4448 typedef struct AVBitStreamFilter {
4452 * A list of codec ids supported by the filter, terminated by
4454 * May be NULL, in that case the bitstream filter works with any codec id.
4456 const enum AVCodecID *codec_ids;
4459 * A class for the private data, used to declare bitstream filter private
4460 * AVOptions. This field is NULL for bitstream filters that do not declare
4463 * If this field is non-NULL, the first member of the filter private data
4464 * must be a pointer to AVClass, which will be set by libavcodec generic
4465 * code to this class.
4467 const AVClass *priv_class;
4469 /*****************************************************************
4470 * No fields below this line are part of the public API. They
4471 * may not be used outside of libavcodec and can be changed and
4473 * New public fields should be added right above.
4474 *****************************************************************
4478 int (*init)(AVBSFContext *ctx);
4479 int (*filter)(AVBSFContext *ctx, AVPacket *pkt);
4480 void (*close)(AVBSFContext *ctx);
4481 void (*flush)(AVBSFContext *ctx);
4482 } AVBitStreamFilter;
4486 * @deprecated the old bitstream filtering API (using AVBitStreamFilterContext)
4487 * is deprecated. Use the new bitstream filtering API (using AVBSFContext).
4489 attribute_deprecated
4490 void av_register_bitstream_filter(AVBitStreamFilter *bsf);
4492 * @deprecated the old bitstream filtering API (using AVBitStreamFilterContext)
4493 * is deprecated. Use av_bsf_get_by_name(), av_bsf_alloc(), and av_bsf_init()
4494 * from the new bitstream filtering API (using AVBSFContext).
4496 attribute_deprecated
4497 AVBitStreamFilterContext *av_bitstream_filter_init(const char *name);
4499 * @deprecated the old bitstream filtering API (using AVBitStreamFilterContext)
4500 * is deprecated. Use av_bsf_send_packet() and av_bsf_receive_packet() from the
4501 * new bitstream filtering API (using AVBSFContext).
4503 attribute_deprecated
4504 int av_bitstream_filter_filter(AVBitStreamFilterContext *bsfc,
4505 AVCodecContext *avctx, const char *args,
4506 uint8_t **poutbuf, int *poutbuf_size,
4507 const uint8_t *buf, int buf_size, int keyframe);
4509 * @deprecated the old bitstream filtering API (using AVBitStreamFilterContext)
4510 * is deprecated. Use av_bsf_free() from the new bitstream filtering API (using
4513 attribute_deprecated
4514 void av_bitstream_filter_close(AVBitStreamFilterContext *bsf);
4516 * @deprecated the old bitstream filtering API (using AVBitStreamFilterContext)
4517 * is deprecated. Use av_bsf_iterate() from the new bitstream filtering API (using
4520 attribute_deprecated
4521 const AVBitStreamFilter *av_bitstream_filter_next(const AVBitStreamFilter *f);
4525 * @return a bitstream filter with the specified name or NULL if no such
4526 * bitstream filter exists.
4528 const AVBitStreamFilter *av_bsf_get_by_name(const char *name);
4531 * Iterate over all registered bitstream filters.
4533 * @param opaque a pointer where libavcodec will store the iteration state. Must
4534 * point to NULL to start the iteration.
4536 * @return the next registered bitstream filter or NULL when the iteration is
4539 const AVBitStreamFilter *av_bsf_iterate(void **opaque);
4541 attribute_deprecated
4542 const AVBitStreamFilter *av_bsf_next(void **opaque);
4546 * Allocate a context for a given bitstream filter. The caller must fill in the
4547 * context parameters as described in the documentation and then call
4548 * av_bsf_init() before sending any data to the filter.
4550 * @param filter the filter for which to allocate an instance.
4551 * @param ctx a pointer into which the pointer to the newly-allocated context
4552 * will be written. It must be freed with av_bsf_free() after the
4553 * filtering is done.
4555 * @return 0 on success, a negative AVERROR code on failure
4557 int av_bsf_alloc(const AVBitStreamFilter *filter, AVBSFContext **ctx);
4560 * Prepare the filter for use, after all the parameters and options have been
4563 int av_bsf_init(AVBSFContext *ctx);
4566 * Submit a packet for filtering.
4568 * After sending each packet, the filter must be completely drained by calling
4569 * av_bsf_receive_packet() repeatedly until it returns AVERROR(EAGAIN) or
4572 * @param pkt the packet to filter. The bitstream filter will take ownership of
4573 * the packet and reset the contents of pkt. pkt is not touched if an error occurs.
4574 * If pkt is empty (i.e. NULL, or pkt->data is NULL and pkt->side_data_elems zero),
4575 * it signals the end of the stream (i.e. no more non-empty packets will be sent;
4576 * sending more empty packets does nothing) and will cause the filter to output
4577 * any packets it may have buffered internally.
4579 * @return 0 on success, a negative AVERROR on error. This function never fails if
4582 int av_bsf_send_packet(AVBSFContext *ctx, AVPacket *pkt);
4585 * Retrieve a filtered packet.
4587 * @param[out] pkt this struct will be filled with the contents of the filtered
4588 * packet. It is owned by the caller and must be freed using
4589 * av_packet_unref() when it is no longer needed.
4590 * This parameter should be "clean" (i.e. freshly allocated
4591 * with av_packet_alloc() or unreffed with av_packet_unref())
4592 * when this function is called. If this function returns
4593 * successfully, the contents of pkt will be completely
4594 * overwritten by the returned data. On failure, pkt is not
4597 * @return 0 on success. AVERROR(EAGAIN) if more packets need to be sent to the
4598 * filter (using av_bsf_send_packet()) to get more output. AVERROR_EOF if there
4599 * will be no further output from the filter. Another negative AVERROR value if
4602 * @note one input packet may result in several output packets, so after sending
4603 * a packet with av_bsf_send_packet(), this function needs to be called
4604 * repeatedly until it stops returning 0. It is also possible for a filter to
4605 * output fewer packets than were sent to it, so this function may return
4606 * AVERROR(EAGAIN) immediately after a successful av_bsf_send_packet() call.
4608 int av_bsf_receive_packet(AVBSFContext *ctx, AVPacket *pkt);
4611 * Reset the internal bitstream filter state / flush internal buffers.
4613 void av_bsf_flush(AVBSFContext *ctx);
4616 * Free a bitstream filter context and everything associated with it; write NULL
4617 * into the supplied pointer.
4619 void av_bsf_free(AVBSFContext **ctx);
4622 * Get the AVClass for AVBSFContext. It can be used in combination with
4623 * AV_OPT_SEARCH_FAKE_OBJ for examining options.
4625 * @see av_opt_find().
4627 const AVClass *av_bsf_get_class(void);
4630 * Structure for chain/list of bitstream filters.
4631 * Empty list can be allocated by av_bsf_list_alloc().
4633 typedef struct AVBSFList AVBSFList;
4636 * Allocate empty list of bitstream filters.
4637 * The list must be later freed by av_bsf_list_free()
4638 * or finalized by av_bsf_list_finalize().
4640 * @return Pointer to @ref AVBSFList on success, NULL in case of failure
4642 AVBSFList *av_bsf_list_alloc(void);
4645 * Free list of bitstream filters.
4647 * @param lst Pointer to pointer returned by av_bsf_list_alloc()
4649 void av_bsf_list_free(AVBSFList **lst);
4652 * Append bitstream filter to the list of bitstream filters.
4654 * @param lst List to append to
4655 * @param bsf Filter context to be appended
4657 * @return >=0 on success, negative AVERROR in case of failure
4659 int av_bsf_list_append(AVBSFList *lst, AVBSFContext *bsf);
4662 * Construct new bitstream filter context given it's name and options
4663 * and append it to the list of bitstream filters.
4665 * @param lst List to append to
4666 * @param bsf_name Name of the bitstream filter
4667 * @param options Options for the bitstream filter, can be set to NULL
4669 * @return >=0 on success, negative AVERROR in case of failure
4671 int av_bsf_list_append2(AVBSFList *lst, const char * bsf_name, AVDictionary **options);
4673 * Finalize list of bitstream filters.
4675 * This function will transform @ref AVBSFList to single @ref AVBSFContext,
4676 * so the whole chain of bitstream filters can be treated as single filter
4677 * freshly allocated by av_bsf_alloc().
4678 * If the call is successful, @ref AVBSFList structure is freed and lst
4679 * will be set to NULL. In case of failure, caller is responsible for
4680 * freeing the structure by av_bsf_list_free()
4682 * @param lst Filter list structure to be transformed
4683 * @param[out] bsf Pointer to be set to newly created @ref AVBSFContext structure
4684 * representing the chain of bitstream filters
4686 * @return >=0 on success, negative AVERROR in case of failure
4688 int av_bsf_list_finalize(AVBSFList **lst, AVBSFContext **bsf);
4691 * Parse string describing list of bitstream filters and create single
4692 * @ref AVBSFContext describing the whole chain of bitstream filters.
4693 * Resulting @ref AVBSFContext can be treated as any other @ref AVBSFContext freshly
4694 * allocated by av_bsf_alloc().
4696 * @param str String describing chain of bitstream filters in format
4697 * `bsf1[=opt1=val1:opt2=val2][,bsf2]`
4698 * @param[out] bsf Pointer to be set to newly created @ref AVBSFContext structure
4699 * representing the chain of bitstream filters
4701 * @return >=0 on success, negative AVERROR in case of failure
4703 int av_bsf_list_parse_str(const char *str, AVBSFContext **bsf);
4706 * Get null/pass-through bitstream filter.
4708 * @param[out] bsf Pointer to be set to new instance of pass-through bitstream filter
4712 int av_bsf_get_null_filter(AVBSFContext **bsf);
4717 * Same behaviour av_fast_malloc but the buffer has additional
4718 * AV_INPUT_BUFFER_PADDING_SIZE at the end which will always be 0.
4720 * In addition the whole buffer will initially and after resizes
4721 * be 0-initialized so that no uninitialized data will ever appear.
4723 void av_fast_padded_malloc(void *ptr, unsigned int *size, size_t min_size);
4726 * Same behaviour av_fast_padded_malloc except that buffer will always
4727 * be 0-initialized after call.
4729 void av_fast_padded_mallocz(void *ptr, unsigned int *size, size_t min_size);
4732 * Encode extradata length to a buffer. Used by xiph codecs.
4734 * @param s buffer to write to; must be at least (v/255+1) bytes long
4735 * @param v size of extradata in bytes
4736 * @return number of bytes written to the buffer.
4738 unsigned int av_xiphlacing(unsigned char *s, unsigned int v);
4740 #if FF_API_USER_VISIBLE_AVHWACCEL
4742 * Register the hardware accelerator hwaccel.
4744 * @deprecated This function doesn't do anything.
4746 attribute_deprecated
4747 void av_register_hwaccel(AVHWAccel *hwaccel);
4750 * If hwaccel is NULL, returns the first registered hardware accelerator,
4751 * if hwaccel is non-NULL, returns the next registered hardware accelerator
4752 * after hwaccel, or NULL if hwaccel is the last one.
4754 * @deprecated AVHWaccel structures contain no user-serviceable parts, so
4755 * this function should not be used.
4757 attribute_deprecated
4758 AVHWAccel *av_hwaccel_next(const AVHWAccel *hwaccel);
4763 * Lock operation used by lockmgr
4765 * @deprecated Deprecated together with av_lockmgr_register().
4768 AV_LOCK_CREATE, ///< Create a mutex
4769 AV_LOCK_OBTAIN, ///< Lock the mutex
4770 AV_LOCK_RELEASE, ///< Unlock the mutex
4771 AV_LOCK_DESTROY, ///< Free mutex resources
4775 * Register a user provided lock manager supporting the operations
4776 * specified by AVLockOp. The "mutex" argument to the function points
4777 * to a (void *) where the lockmgr should store/get a pointer to a user
4778 * allocated mutex. It is NULL upon AV_LOCK_CREATE and equal to the
4779 * value left by the last call for all other ops. If the lock manager is
4780 * unable to perform the op then it should leave the mutex in the same
4781 * state as when it was called and return a non-zero value. However,
4782 * when called with AV_LOCK_DESTROY the mutex will always be assumed to
4783 * have been successfully destroyed. If av_lockmgr_register succeeds
4784 * it will return a non-negative value, if it fails it will return a
4785 * negative value and destroy all mutex and unregister all callbacks.
4786 * av_lockmgr_register is not thread-safe, it must be called from a
4787 * single thread before any calls which make use of locking are used.
4789 * @param cb User defined callback. av_lockmgr_register invokes calls
4790 * to this callback and the previously registered callback.
4791 * The callback will be used to create more than one mutex
4792 * each of which must be backed by its own underlying locking
4793 * mechanism (i.e. do not use a single static object to
4794 * implement your lock manager). If cb is set to NULL the
4795 * lockmgr will be unregistered.
4797 * @deprecated This function does nothing, and always returns 0. Be sure to
4798 * build with thread support to get basic thread safety.
4800 attribute_deprecated
4801 int av_lockmgr_register(int (*cb)(void **mutex, enum AVLockOp op));
4805 * Get the type of the given codec.
4807 enum AVMediaType avcodec_get_type(enum AVCodecID codec_id);
4810 * Get the name of a codec.
4811 * @return a static string identifying the codec; never NULL
4813 const char *avcodec_get_name(enum AVCodecID id);
4816 * @return a positive value if s is open (i.e. avcodec_open2() was called on it
4817 * with no corresponding avcodec_close()), 0 otherwise.
4819 int avcodec_is_open(AVCodecContext *s);
4822 * @return a non-zero number if codec is an encoder, zero otherwise
4824 int av_codec_is_encoder(const AVCodec *codec);
4827 * @return a non-zero number if codec is a decoder, zero otherwise
4829 int av_codec_is_decoder(const AVCodec *codec);
4832 * Allocate a CPB properties structure and initialize its fields to default
4835 * @param size if non-NULL, the size of the allocated struct will be written
4836 * here. This is useful for embedding it in side data.
4838 * @return the newly allocated struct or NULL on failure
4840 AVCPBProperties *av_cpb_properties_alloc(size_t *size);
4846 #endif /* AVCODEC_AVCODEC_H */