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"
45 #include "codec_desc.h"
46 #include "codec_par.h"
52 * @defgroup libavc libavcodec
53 * Encoding/Decoding Library
57 * @defgroup lavc_decoding Decoding
61 * @defgroup lavc_encoding Encoding
65 * @defgroup lavc_codec Codecs
67 * @defgroup lavc_codec_native Native Codecs
70 * @defgroup lavc_codec_wrappers External library wrappers
73 * @defgroup lavc_codec_hwaccel Hardware Accelerators bridge
77 * @defgroup lavc_internal Internal
85 * @defgroup lavc_encdec send/receive encoding and decoding API overview
88 * The avcodec_send_packet()/avcodec_receive_frame()/avcodec_send_frame()/
89 * avcodec_receive_packet() functions provide an encode/decode API, which
90 * decouples input and output.
92 * The API is very similar for encoding/decoding and audio/video, and works as
94 * - Set up and open the AVCodecContext as usual.
96 * - For decoding, call avcodec_send_packet() to give the decoder raw
97 * compressed data in an AVPacket.
98 * - For encoding, call avcodec_send_frame() to give the encoder an AVFrame
99 * containing uncompressed audio or video.
101 * In both cases, it is recommended that AVPackets and AVFrames are
102 * refcounted, or libavcodec might have to copy the input data. (libavformat
103 * always returns refcounted AVPackets, and av_frame_get_buffer() allocates
104 * refcounted AVFrames.)
105 * - Receive output in a loop. Periodically call one of the avcodec_receive_*()
106 * functions and process their output:
107 * - For decoding, call avcodec_receive_frame(). On success, it will return
108 * an AVFrame containing uncompressed audio or video data.
109 * - For encoding, call avcodec_receive_packet(). On success, it will return
110 * an AVPacket with a compressed frame.
112 * Repeat this call until it returns AVERROR(EAGAIN) or an error. The
113 * AVERROR(EAGAIN) return value means that new input data is required to
114 * return new output. In this case, continue with sending input. For each
115 * input frame/packet, the codec will typically return 1 output frame/packet,
116 * but it can also be 0 or more than 1.
118 * At the beginning of decoding or encoding, the codec might accept multiple
119 * input frames/packets without returning a frame, until its internal buffers
120 * are filled. This situation is handled transparently if you follow the steps
123 * In theory, sending input can result in EAGAIN - this should happen only if
124 * not all output was received. You can use this to structure alternative decode
125 * or encode loops other than the one suggested above. For example, you could
126 * try sending new input on each iteration, and try to receive output if that
129 * End of stream situations. These require "flushing" (aka draining) the codec,
130 * as the codec might buffer multiple frames or packets internally for
131 * performance or out of necessity (consider B-frames).
132 * This is handled as follows:
133 * - Instead of valid input, send NULL to the avcodec_send_packet() (decoding)
134 * or avcodec_send_frame() (encoding) functions. This will enter draining
136 * - Call avcodec_receive_frame() (decoding) or avcodec_receive_packet()
137 * (encoding) in a loop until AVERROR_EOF is returned. The functions will
138 * not return AVERROR(EAGAIN), unless you forgot to enter draining mode.
139 * - Before decoding can be resumed again, the codec has to be reset with
140 * avcodec_flush_buffers().
142 * Using the API as outlined above is highly recommended. But it is also
143 * possible to call functions outside of this rigid schema. For example, you can
144 * call avcodec_send_packet() repeatedly without calling
145 * avcodec_receive_frame(). In this case, avcodec_send_packet() will succeed
146 * until the codec's internal buffer has been filled up (which is typically of
147 * size 1 per output frame, after initial input), and then reject input with
148 * AVERROR(EAGAIN). Once it starts rejecting input, you have no choice but to
149 * read at least some output.
151 * Not all codecs will follow a rigid and predictable dataflow; the only
152 * guarantee is that an AVERROR(EAGAIN) return value on a send/receive call on
153 * one end implies that a receive/send call on the other end will succeed, or
154 * at least will not fail with AVERROR(EAGAIN). In general, no codec will
155 * permit unlimited buffering of input or output.
157 * This API replaces the following legacy functions:
158 * - avcodec_decode_video2() and avcodec_decode_audio4():
159 * Use avcodec_send_packet() to feed input to the decoder, then use
160 * avcodec_receive_frame() to receive decoded frames after each packet.
161 * Unlike with the old video decoding API, multiple frames might result from
162 * a packet. For audio, splitting the input packet into frames by partially
163 * decoding packets becomes transparent to the API user. You never need to
164 * feed an AVPacket to the API twice (unless it is rejected with AVERROR(EAGAIN) - then
165 * no data was read from the packet).
166 * Additionally, sending a flush/draining packet is required only once.
167 * - avcodec_encode_video2()/avcodec_encode_audio2():
168 * Use avcodec_send_frame() to feed input to the encoder, then use
169 * avcodec_receive_packet() to receive encoded packets.
170 * Providing user-allocated buffers for avcodec_receive_packet() is not
172 * - The new API does not handle subtitles yet.
174 * Mixing new and old function calls on the same AVCodecContext is not allowed,
175 * and will result in undefined behavior.
177 * Some codecs might require using the new API; using the old API will return
178 * an error when calling it. All codecs support the new API.
180 * A codec is not allowed to return AVERROR(EAGAIN) for both sending and receiving. This
181 * would be an invalid state, which could put the codec user into an endless
182 * loop. The API has no concept of time either: it cannot happen that trying to
183 * do avcodec_send_packet() results in AVERROR(EAGAIN), but a repeated call 1 second
184 * later accepts the packet (with no other receive/flush API calls involved).
185 * The API is a strict state machine, and the passage of time is not supposed
186 * to influence it. Some timing-dependent behavior might still be deemed
187 * acceptable in certain cases. But it must never result in both send/receive
188 * returning EAGAIN at the same time at any point. It must also absolutely be
189 * avoided that the current state is "unstable" and can "flip-flop" between
190 * the send/receive APIs allowing progress. For example, it's not allowed that
191 * the codec randomly decides that it actually wants to consume a packet now
192 * instead of returning a frame, after it just returned AVERROR(EAGAIN) on an
193 * avcodec_send_packet() call.
198 * @defgroup lavc_core Core functions/structures.
201 * Basic definitions, functions for querying libavcodec capabilities,
202 * allocating core structures, etc.
207 * @ingroup lavc_decoding
208 * Required number of additionally allocated bytes at the end of the input bitstream for decoding.
209 * This is mainly needed because some optimized bitstream readers read
210 * 32 or 64 bit at once and could read over the end.<br>
211 * Note: If the first 23 bits of the additional bytes are not 0, then damaged
212 * MPEG bitstreams could cause overread and segfault.
214 #define AV_INPUT_BUFFER_PADDING_SIZE 64
217 * @ingroup lavc_encoding
218 * minimum encoding buffer size
219 * Used to avoid some checks during header writing.
221 #define AV_INPUT_BUFFER_MIN_SIZE 16384
224 * @ingroup lavc_decoding
227 /* We leave some space between them for extensions (drop some
228 * keyframes for intra-only or drop just some bidir frames). */
229 AVDISCARD_NONE =-16, ///< discard nothing
230 AVDISCARD_DEFAULT = 0, ///< discard useless packets like 0 size packets in avi
231 AVDISCARD_NONREF = 8, ///< discard all non reference
232 AVDISCARD_BIDIR = 16, ///< discard all bidirectional frames
233 AVDISCARD_NONINTRA= 24, ///< discard all non intra frames
234 AVDISCARD_NONKEY = 32, ///< discard all frames except keyframes
235 AVDISCARD_ALL = 48, ///< discard all
238 enum AVAudioServiceType {
239 AV_AUDIO_SERVICE_TYPE_MAIN = 0,
240 AV_AUDIO_SERVICE_TYPE_EFFECTS = 1,
241 AV_AUDIO_SERVICE_TYPE_VISUALLY_IMPAIRED = 2,
242 AV_AUDIO_SERVICE_TYPE_HEARING_IMPAIRED = 3,
243 AV_AUDIO_SERVICE_TYPE_DIALOGUE = 4,
244 AV_AUDIO_SERVICE_TYPE_COMMENTARY = 5,
245 AV_AUDIO_SERVICE_TYPE_EMERGENCY = 6,
246 AV_AUDIO_SERVICE_TYPE_VOICE_OVER = 7,
247 AV_AUDIO_SERVICE_TYPE_KARAOKE = 8,
248 AV_AUDIO_SERVICE_TYPE_NB , ///< Not part of ABI
252 * @ingroup lavc_encoding
254 typedef struct RcOverride{
257 int qscale; // If this is 0 then quality_factor will be used instead.
258 float quality_factor;
262 These flags can be passed in AVCodecContext.flags before initialization.
263 Note: Not everything is supported yet.
267 * Allow decoders to produce frames with data planes that are not aligned
268 * to CPU requirements (e.g. due to cropping).
270 #define AV_CODEC_FLAG_UNALIGNED (1 << 0)
274 #define AV_CODEC_FLAG_QSCALE (1 << 1)
276 * 4 MV per MB allowed / advanced prediction for H.263.
278 #define AV_CODEC_FLAG_4MV (1 << 2)
280 * Output even those frames that might be corrupted.
282 #define AV_CODEC_FLAG_OUTPUT_CORRUPT (1 << 3)
286 #define AV_CODEC_FLAG_QPEL (1 << 4)
288 * Don't output frames whose parameters differ from first
289 * decoded frame in stream.
291 #define AV_CODEC_FLAG_DROPCHANGED (1 << 5)
293 * Use internal 2pass ratecontrol in first pass mode.
295 #define AV_CODEC_FLAG_PASS1 (1 << 9)
297 * Use internal 2pass ratecontrol in second pass mode.
299 #define AV_CODEC_FLAG_PASS2 (1 << 10)
303 #define AV_CODEC_FLAG_LOOP_FILTER (1 << 11)
305 * Only decode/encode grayscale.
307 #define AV_CODEC_FLAG_GRAY (1 << 13)
309 * error[?] variables will be set during encoding.
311 #define AV_CODEC_FLAG_PSNR (1 << 15)
313 * Input bitstream might be truncated at a random location
314 * instead of only at frame boundaries.
316 #define AV_CODEC_FLAG_TRUNCATED (1 << 16)
318 * Use interlaced DCT.
320 #define AV_CODEC_FLAG_INTERLACED_DCT (1 << 18)
324 #define AV_CODEC_FLAG_LOW_DELAY (1 << 19)
326 * Place global headers in extradata instead of every keyframe.
328 #define AV_CODEC_FLAG_GLOBAL_HEADER (1 << 22)
330 * Use only bitexact stuff (except (I)DCT).
332 #define AV_CODEC_FLAG_BITEXACT (1 << 23)
333 /* Fx : Flag for H.263+ extra options */
335 * H.263 advanced intra coding / MPEG-4 AC prediction
337 #define AV_CODEC_FLAG_AC_PRED (1 << 24)
339 * interlaced motion estimation
341 #define AV_CODEC_FLAG_INTERLACED_ME (1 << 29)
342 #define AV_CODEC_FLAG_CLOSED_GOP (1U << 31)
345 * Allow non spec compliant speedup tricks.
347 #define AV_CODEC_FLAG2_FAST (1 << 0)
349 * Skip bitstream encoding.
351 #define AV_CODEC_FLAG2_NO_OUTPUT (1 << 2)
353 * Place global headers at every keyframe instead of in extradata.
355 #define AV_CODEC_FLAG2_LOCAL_HEADER (1 << 3)
358 * timecode is in drop frame format. DEPRECATED!!!!
360 #define AV_CODEC_FLAG2_DROP_FRAME_TIMECODE (1 << 13)
363 * Input bitstream might be truncated at a packet boundaries
364 * instead of only at frame boundaries.
366 #define AV_CODEC_FLAG2_CHUNKS (1 << 15)
368 * Discard cropping information from SPS.
370 #define AV_CODEC_FLAG2_IGNORE_CROP (1 << 16)
373 * Show all frames before the first keyframe
375 #define AV_CODEC_FLAG2_SHOW_ALL (1 << 22)
377 * Export motion vectors through frame side data
379 #define AV_CODEC_FLAG2_EXPORT_MVS (1 << 28)
381 * Do not skip samples and export skip information as frame side data
383 #define AV_CODEC_FLAG2_SKIP_MANUAL (1 << 29)
385 * Do not reset ASS ReadOrder field on flush (subtitles decoding)
387 #define AV_CODEC_FLAG2_RO_FLUSH_NOOP (1 << 30)
389 /* Unsupported options :
390 * Syntax Arithmetic coding (SAC)
391 * Reference Picture Selection
392 * Independent Segment Decoding */
394 /* codec capabilities */
397 * Decoder can use draw_horiz_band callback.
399 #define AV_CODEC_CAP_DRAW_HORIZ_BAND (1 << 0)
401 * Codec uses get_buffer() for allocating buffers and supports custom allocators.
402 * If not set, it might not use get_buffer() at all or use operations that
403 * assume the buffer was allocated by avcodec_default_get_buffer.
405 #define AV_CODEC_CAP_DR1 (1 << 1)
406 #define AV_CODEC_CAP_TRUNCATED (1 << 3)
408 * Encoder or decoder requires flushing with NULL input at the end in order to
409 * give the complete and correct output.
411 * NOTE: If this flag is not set, the codec is guaranteed to never be fed with
412 * with NULL data. The user can still send NULL data to the public encode
413 * or decode function, but libavcodec will not pass it along to the codec
414 * unless this flag is set.
417 * The decoder has a non-zero delay and needs to be fed with avpkt->data=NULL,
418 * avpkt->size=0 at the end to get the delayed data until the decoder no longer
422 * The encoder needs to be fed with NULL data at the end of encoding until the
423 * encoder no longer returns data.
425 * NOTE: For encoders implementing the AVCodec.encode2() function, setting this
426 * flag also means that the encoder must set the pts and duration for
427 * each output packet. If this flag is not set, the pts and duration will
428 * be determined by libavcodec from the input frame.
430 #define AV_CODEC_CAP_DELAY (1 << 5)
432 * Codec can be fed a final frame with a smaller size.
433 * This can be used to prevent truncation of the last audio samples.
435 #define AV_CODEC_CAP_SMALL_LAST_FRAME (1 << 6)
438 * Codec can output multiple frames per AVPacket
439 * Normally demuxers return one frame at a time, demuxers which do not do
440 * are connected to a parser to split what they return into proper frames.
441 * This flag is reserved to the very rare category of codecs which have a
442 * bitstream that cannot be split into frames without timeconsuming
443 * operations like full decoding. Demuxers carrying such bitstreams thus
444 * may return multiple frames in a packet. This has many disadvantages like
445 * prohibiting stream copy in many cases thus it should only be considered
448 #define AV_CODEC_CAP_SUBFRAMES (1 << 8)
450 * Codec is experimental and is thus avoided in favor of non experimental
453 #define AV_CODEC_CAP_EXPERIMENTAL (1 << 9)
455 * Codec should fill in channel configuration and samplerate instead of container
457 #define AV_CODEC_CAP_CHANNEL_CONF (1 << 10)
459 * Codec supports frame-level multithreading.
461 #define AV_CODEC_CAP_FRAME_THREADS (1 << 12)
463 * Codec supports slice-based (or partition-based) multithreading.
465 #define AV_CODEC_CAP_SLICE_THREADS (1 << 13)
467 * Codec supports changed parameters at any point.
469 #define AV_CODEC_CAP_PARAM_CHANGE (1 << 14)
471 * Codec supports avctx->thread_count == 0 (auto).
473 #define AV_CODEC_CAP_AUTO_THREADS (1 << 15)
475 * Audio encoder supports receiving a different number of samples in each call.
477 #define AV_CODEC_CAP_VARIABLE_FRAME_SIZE (1 << 16)
479 * Decoder is not a preferred choice for probing.
480 * This indicates that the decoder is not a good choice for probing.
481 * It could for example be an expensive to spin up hardware decoder,
482 * or it could simply not provide a lot of useful information about
484 * A decoder marked with this flag should only be used as last resort
485 * choice for probing.
487 #define AV_CODEC_CAP_AVOID_PROBING (1 << 17)
489 #if FF_API_UNUSED_CODEC_CAPS
491 * Deprecated and unused. Use AVCodecDescriptor.props instead
493 #define AV_CODEC_CAP_INTRA_ONLY 0x40000000
495 * Deprecated and unused. Use AVCodecDescriptor.props instead
497 #define AV_CODEC_CAP_LOSSLESS 0x80000000
501 * Codec is backed by a hardware implementation. Typically used to
502 * identify a non-hwaccel hardware decoder. For information about hwaccels, use
503 * avcodec_get_hw_config() instead.
505 #define AV_CODEC_CAP_HARDWARE (1 << 18)
508 * Codec is potentially backed by a hardware implementation, but not
509 * necessarily. This is used instead of AV_CODEC_CAP_HARDWARE, if the
510 * implementation provides some sort of internal fallback.
512 #define AV_CODEC_CAP_HYBRID (1 << 19)
515 * This codec takes the reordered_opaque field from input AVFrames
516 * and returns it in the corresponding field in AVCodecContext after
519 #define AV_CODEC_CAP_ENCODER_REORDERED_OPAQUE (1 << 20)
522 * This encoder can be flushed using avcodec_flush_buffers(). If this flag is
523 * not set, the encoder must be closed and reopened to ensure that no frames
526 #define AV_CODEC_CAP_ENCODER_FLUSH (1 << 21)
528 /* Exported side data.
529 These flags can be passed in AVCodecContext.export_side_data before initialization.
532 * Export motion vectors through frame side data
534 #define AV_CODEC_EXPORT_DATA_MVS (1 << 0)
536 * Export encoder Producer Reference Time through packet side data
538 #define AV_CODEC_EXPORT_DATA_PRFT (1 << 1)
541 * Export the AVVideoEncParams structure through frame side data.
543 #define AV_CODEC_EXPORT_DATA_VIDEO_ENC_PARAMS (1 << 2)
547 * This specifies the area which should be displayed.
548 * Note there may be multiple such areas for one frame.
550 typedef struct AVPanScan {
553 * - encoding: Set by user.
554 * - decoding: Set by libavcodec.
559 * width and height in 1/16 pel
560 * - encoding: Set by user.
561 * - decoding: Set by libavcodec.
567 * position of the top left corner in 1/16 pel for up to 3 fields/frames
568 * - encoding: Set by user.
569 * - decoding: Set by libavcodec.
571 int16_t position[3][2];
575 * This structure describes the bitrate properties of an encoded bitstream. It
576 * roughly corresponds to a subset the VBV parameters for MPEG-2 or HRD
577 * parameters for H.264/HEVC.
579 typedef struct AVCPBProperties {
581 * Maximum bitrate of the stream, in bits per second.
582 * Zero if unknown or unspecified.
584 #if FF_API_UNSANITIZED_BITRATES
590 * Minimum bitrate of the stream, in bits per second.
591 * Zero if unknown or unspecified.
593 #if FF_API_UNSANITIZED_BITRATES
599 * Average bitrate of the stream, in bits per second.
600 * Zero if unknown or unspecified.
602 #if FF_API_UNSANITIZED_BITRATES
609 * The size of the buffer to which the ratecontrol is applied, in bits.
610 * Zero if unknown or unspecified.
615 * The delay between the time the packet this structure is associated with
616 * is received and the time when it should be decoded, in periods of a 27MHz
619 * UINT64_MAX when unknown or unspecified.
625 * This structure supplies correlation between a packet timestamp and a wall clock
626 * production time. The definition follows the Producer Reference Time ('prft')
627 * as defined in ISO/IEC 14496-12
629 typedef struct AVProducerReferenceTime {
631 * A UTC timestamp, in microseconds, since Unix epoch (e.g, av_gettime()).
635 } AVProducerReferenceTime;
638 * The decoder will keep a reference to the frame and may reuse it later.
640 #define AV_GET_BUFFER_FLAG_REF (1 << 0)
642 struct AVCodecInternal;
645 * main external API structure.
646 * New fields can be added to the end with minor version bumps.
647 * Removal, reordering and changes to existing fields require a major
649 * You can use AVOptions (av_opt* / av_set/get*()) to access these fields from user
651 * The name string for AVOptions options matches the associated command line
652 * parameter name and can be found in libavcodec/options_table.h
653 * The AVOption/command line parameter names differ in some cases from the C
654 * structure field names for historic reasons or brevity.
655 * sizeof(AVCodecContext) must not be used outside libav*.
657 typedef struct AVCodecContext {
659 * information on struct for av_log
660 * - set by avcodec_alloc_context3
662 const AVClass *av_class;
663 int log_level_offset;
665 enum AVMediaType codec_type; /* see AVMEDIA_TYPE_xxx */
666 const struct AVCodec *codec;
667 enum AVCodecID codec_id; /* see AV_CODEC_ID_xxx */
670 * fourcc (LSB first, so "ABCD" -> ('D'<<24) + ('C'<<16) + ('B'<<8) + 'A').
671 * This is used to work around some encoder bugs.
672 * A demuxer should set this to what is stored in the field used to identify the codec.
673 * If there are multiple such fields in a container then the demuxer should choose the one
674 * which maximizes the information about the used codec.
675 * If the codec tag field in a container is larger than 32 bits then the demuxer should
676 * remap the longer ID to 32 bits with a table or other structure. Alternatively a new
677 * extra_codec_tag + size could be added but for this a clear advantage must be demonstrated
679 * - encoding: Set by user, if not then the default based on codec_id will be used.
680 * - decoding: Set by user, will be converted to uppercase by libavcodec during init.
682 unsigned int codec_tag;
687 * Private context used for internal data.
689 * Unlike priv_data, this is not codec-specific. It is used in general
690 * libavcodec functions.
692 struct AVCodecInternal *internal;
695 * Private data of the user, can be used to carry app specific stuff.
696 * - encoding: Set by user.
697 * - decoding: Set by user.
702 * the average bitrate
703 * - encoding: Set by user; unused for constant quantizer encoding.
704 * - decoding: Set by user, may be overwritten by libavcodec
705 * if this info is available in the stream
710 * number of bits the bitstream is allowed to diverge from the reference.
711 * the reference can be CBR (for CBR pass1) or VBR (for pass2)
712 * - encoding: Set by user; unused for constant quantizer encoding.
715 int bit_rate_tolerance;
718 * Global quality for codecs which cannot change it per frame.
719 * This should be proportional to MPEG-1/2/4 qscale.
720 * - encoding: Set by user.
726 * - encoding: Set by user.
729 int compression_level;
730 #define FF_COMPRESSION_DEFAULT -1
734 * - encoding: Set by user.
735 * - decoding: Set by user.
741 * - encoding: Set by user.
742 * - decoding: Set by user.
747 * some codecs need / can use extradata like Huffman tables.
748 * MJPEG: Huffman tables
749 * rv10: additional flags
750 * MPEG-4: global headers (they can be in the bitstream or here)
751 * The allocated memory should be AV_INPUT_BUFFER_PADDING_SIZE bytes larger
752 * than extradata_size to avoid problems if it is read with the bitstream reader.
753 * The bytewise contents of extradata must not depend on the architecture or CPU endianness.
754 * Must be allocated with the av_malloc() family of functions.
755 * - encoding: Set/allocated/freed by libavcodec.
756 * - decoding: Set/allocated/freed by user.
762 * This is the fundamental unit of time (in seconds) in terms
763 * of which frame timestamps are represented. For fixed-fps content,
764 * timebase should be 1/framerate and timestamp increments should be
766 * This often, but not always is the inverse of the frame rate or field rate
767 * for video. 1/time_base is not the average frame rate if the frame rate is not
770 * Like containers, elementary streams also can store timestamps, 1/time_base
771 * is the unit in which these timestamps are specified.
772 * As example of such codec time base see ISO/IEC 14496-2:2001(E)
773 * vop_time_increment_resolution and fixed_vop_rate
774 * (fixed_vop_rate == 0 implies that it is different from the framerate)
776 * - encoding: MUST be set by user.
777 * - decoding: the use of this field for decoding is deprecated.
778 * Use framerate instead.
780 AVRational time_base;
783 * For some codecs, the time base is closer to the field rate than the frame rate.
784 * Most notably, H.264 and MPEG-2 specify time_base as half of frame duration
785 * if no telecine is used ...
787 * Set to time_base ticks per frame. Default 1, e.g., H.264/MPEG-2 set it to 2.
794 * Encoding: Number of frames delay there will be from the encoder input to
795 * the decoder output. (we assume the decoder matches the spec)
796 * Decoding: Number of frames delay in addition to what a standard decoder
797 * as specified in the spec would produce.
800 * Number of frames the decoded output will be delayed relative to the
804 * For encoding, this field is unused (see initial_padding).
806 * For decoding, this is the number of samples the decoder needs to
807 * output before the decoder's output is valid. When seeking, you should
808 * start decoding this many samples prior to your desired seek point.
810 * - encoding: Set by libavcodec.
811 * - decoding: Set by libavcodec.
818 * picture width / height.
820 * @note Those fields may not match the values of the last
821 * AVFrame output by avcodec_decode_video2 due frame
824 * - encoding: MUST be set by user.
825 * - decoding: May be set by the user before opening the decoder if known e.g.
826 * from the container. Some decoders will require the dimensions
827 * to be set by the caller. During decoding, the decoder may
828 * overwrite those values as required while parsing the data.
833 * Bitstream width / height, may be different from width/height e.g. when
834 * the decoded frame is cropped before being output or lowres is enabled.
836 * @note Those field may not match the value of the last
837 * AVFrame output by avcodec_receive_frame() due frame
841 * - decoding: May be set by the user before opening the decoder if known
842 * e.g. from the container. During decoding, the decoder may
843 * overwrite those values as required while parsing the data.
845 int coded_width, coded_height;
848 * the number of pictures in a group of pictures, or 0 for intra_only
849 * - encoding: Set by user.
855 * Pixel format, see AV_PIX_FMT_xxx.
856 * May be set by the demuxer if known from headers.
857 * May be overridden by the decoder if it knows better.
859 * @note This field may not match the value of the last
860 * AVFrame output by avcodec_receive_frame() due frame
863 * - encoding: Set by user.
864 * - decoding: Set by user if known, overridden by libavcodec while
867 enum AVPixelFormat pix_fmt;
870 * If non NULL, 'draw_horiz_band' is called by the libavcodec
871 * decoder to draw a horizontal band. It improves cache usage. Not
872 * all codecs can do that. You must check the codec capabilities
874 * When multithreading is used, it may be called from multiple threads
875 * at the same time; threads might draw different parts of the same AVFrame,
876 * or multiple AVFrames, and there is no guarantee that slices will be drawn
878 * The function is also used by hardware acceleration APIs.
879 * It is called at least once during frame decoding to pass
880 * the data needed for hardware render.
881 * In that mode instead of pixel data, AVFrame points to
882 * a structure specific to the acceleration API. The application
883 * reads the structure and can change some fields to indicate progress
886 * - decoding: Set by user.
887 * @param height the height of the slice
888 * @param y the y position of the slice
889 * @param type 1->top field, 2->bottom field, 3->frame
890 * @param offset offset into the AVFrame.data from which the slice should be read
892 void (*draw_horiz_band)(struct AVCodecContext *s,
893 const AVFrame *src, int offset[AV_NUM_DATA_POINTERS],
894 int y, int type, int height);
897 * callback to negotiate the pixelFormat
898 * @param fmt is the list of formats which are supported by the codec,
899 * it is terminated by -1 as 0 is a valid format, the formats are ordered by quality.
900 * The first is always the native one.
901 * @note The callback may be called again immediately if initialization for
902 * the selected (hardware-accelerated) pixel format failed.
903 * @warning Behavior is undefined if the callback returns a value not
904 * in the fmt list of formats.
905 * @return the chosen format
907 * - decoding: Set by user, if not set the native format will be chosen.
909 enum AVPixelFormat (*get_format)(struct AVCodecContext *s, const enum AVPixelFormat * fmt);
912 * maximum number of B-frames between non-B-frames
913 * Note: The output will be delayed by max_b_frames+1 relative to the input.
914 * - encoding: Set by user.
920 * qscale factor between IP and B-frames
921 * If > 0 then the last P-frame quantizer will be used (q= lastp_q*factor+offset).
922 * If < 0 then normal ratecontrol will be done (q= -normal_q*factor+offset).
923 * - encoding: Set by user.
926 float b_quant_factor;
928 #if FF_API_PRIVATE_OPT
929 /** @deprecated use encoder private options instead */
931 int b_frame_strategy;
935 * qscale offset between IP and B-frames
936 * - encoding: Set by user.
939 float b_quant_offset;
942 * Size of the frame reordering buffer in the decoder.
943 * For MPEG-2 it is 1 IPB or 0 low delay IP.
944 * - encoding: Set by libavcodec.
945 * - decoding: Set by libavcodec.
949 #if FF_API_PRIVATE_OPT
950 /** @deprecated use encoder private options instead */
956 * qscale factor between P- and I-frames
957 * If > 0 then the last P-frame quantizer will be used (q = lastp_q * factor + offset).
958 * If < 0 then normal ratecontrol will be done (q= -normal_q*factor+offset).
959 * - encoding: Set by user.
962 float i_quant_factor;
965 * qscale offset between P and I-frames
966 * - encoding: Set by user.
969 float i_quant_offset;
972 * luminance masking (0-> disabled)
973 * - encoding: Set by user.
979 * temporary complexity masking (0-> disabled)
980 * - encoding: Set by user.
983 float temporal_cplx_masking;
986 * spatial complexity masking (0-> disabled)
987 * - encoding: Set by user.
990 float spatial_cplx_masking;
993 * p block masking (0-> disabled)
994 * - encoding: Set by user.
1000 * darkness masking (0-> disabled)
1001 * - encoding: Set by user.
1002 * - decoding: unused
1008 * - encoding: Set by libavcodec.
1009 * - decoding: Set by user (or 0).
1013 #if FF_API_PRIVATE_OPT
1014 /** @deprecated use encoder private options instead */
1015 attribute_deprecated
1016 int prediction_method;
1017 #define FF_PRED_LEFT 0
1018 #define FF_PRED_PLANE 1
1019 #define FF_PRED_MEDIAN 2
1023 * slice offsets in the frame in bytes
1024 * - encoding: Set/allocated by libavcodec.
1025 * - decoding: Set/allocated by user (or NULL).
1030 * sample aspect ratio (0 if unknown)
1031 * That is the width of a pixel divided by the height of the pixel.
1032 * Numerator and denominator must be relatively prime and smaller than 256 for some video standards.
1033 * - encoding: Set by user.
1034 * - decoding: Set by libavcodec.
1036 AVRational sample_aspect_ratio;
1039 * motion estimation comparison function
1040 * - encoding: Set by user.
1041 * - decoding: unused
1045 * subpixel motion estimation comparison function
1046 * - encoding: Set by user.
1047 * - decoding: unused
1051 * macroblock comparison function (not supported yet)
1052 * - encoding: Set by user.
1053 * - decoding: unused
1057 * interlaced DCT comparison function
1058 * - encoding: Set by user.
1059 * - decoding: unused
1062 #define FF_CMP_SAD 0
1063 #define FF_CMP_SSE 1
1064 #define FF_CMP_SATD 2
1065 #define FF_CMP_DCT 3
1066 #define FF_CMP_PSNR 4
1067 #define FF_CMP_BIT 5
1069 #define FF_CMP_ZERO 7
1070 #define FF_CMP_VSAD 8
1071 #define FF_CMP_VSSE 9
1072 #define FF_CMP_NSSE 10
1073 #define FF_CMP_W53 11
1074 #define FF_CMP_W97 12
1075 #define FF_CMP_DCTMAX 13
1076 #define FF_CMP_DCT264 14
1077 #define FF_CMP_MEDIAN_SAD 15
1078 #define FF_CMP_CHROMA 256
1081 * ME diamond size & shape
1082 * - encoding: Set by user.
1083 * - decoding: unused
1088 * amount of previous MV predictors (2a+1 x 2a+1 square)
1089 * - encoding: Set by user.
1090 * - decoding: unused
1092 int last_predictor_count;
1094 #if FF_API_PRIVATE_OPT
1095 /** @deprecated use encoder private options instead */
1096 attribute_deprecated
1101 * motion estimation prepass comparison function
1102 * - encoding: Set by user.
1103 * - decoding: unused
1108 * ME prepass diamond size & shape
1109 * - encoding: Set by user.
1110 * - decoding: unused
1116 * - encoding: Set by user.
1117 * - decoding: unused
1119 int me_subpel_quality;
1122 * maximum motion estimation search range in subpel units
1123 * If 0 then no limit.
1125 * - encoding: Set by user.
1126 * - decoding: unused
1132 * - encoding: unused
1133 * - decoding: Set by user.
1136 #define SLICE_FLAG_CODED_ORDER 0x0001 ///< draw_horiz_band() is called in coded order instead of display
1137 #define SLICE_FLAG_ALLOW_FIELD 0x0002 ///< allow draw_horiz_band() with field slices (MPEG-2 field pics)
1138 #define SLICE_FLAG_ALLOW_PLANE 0x0004 ///< allow draw_horiz_band() with 1 component at a time (SVQ1)
1141 * macroblock decision mode
1142 * - encoding: Set by user.
1143 * - decoding: unused
1146 #define FF_MB_DECISION_SIMPLE 0 ///< uses mb_cmp
1147 #define FF_MB_DECISION_BITS 1 ///< chooses the one which needs the fewest bits
1148 #define FF_MB_DECISION_RD 2 ///< rate distortion
1151 * custom intra quantization matrix
1152 * Must be allocated with the av_malloc() family of functions, and will be freed in
1153 * avcodec_free_context().
1154 * - encoding: Set/allocated by user, freed by libavcodec. Can be NULL.
1155 * - decoding: Set/allocated/freed by libavcodec.
1157 uint16_t *intra_matrix;
1160 * custom inter quantization matrix
1161 * Must be allocated with the av_malloc() family of functions, and will be freed in
1162 * avcodec_free_context().
1163 * - encoding: Set/allocated by user, freed by libavcodec. Can be NULL.
1164 * - decoding: Set/allocated/freed by libavcodec.
1166 uint16_t *inter_matrix;
1168 #if FF_API_PRIVATE_OPT
1169 /** @deprecated use encoder private options instead */
1170 attribute_deprecated
1171 int scenechange_threshold;
1173 /** @deprecated use encoder private options instead */
1174 attribute_deprecated
1175 int noise_reduction;
1179 * precision of the intra DC coefficient - 8
1180 * - encoding: Set by user.
1181 * - decoding: Set by libavcodec
1183 int intra_dc_precision;
1186 * Number of macroblock rows at the top which are skipped.
1187 * - encoding: unused
1188 * - decoding: Set by user.
1193 * Number of macroblock rows at the bottom which are skipped.
1194 * - encoding: unused
1195 * - decoding: Set by user.
1200 * minimum MB Lagrange multiplier
1201 * - encoding: Set by user.
1202 * - decoding: unused
1207 * maximum MB Lagrange multiplier
1208 * - encoding: Set by user.
1209 * - decoding: unused
1213 #if FF_API_PRIVATE_OPT
1215 * @deprecated use encoder private options instead
1217 attribute_deprecated
1218 int me_penalty_compensation;
1222 * - encoding: Set by user.
1223 * - decoding: unused
1227 #if FF_API_PRIVATE_OPT
1228 /** @deprecated use encoder private options instead */
1229 attribute_deprecated
1235 * - encoding: Set by user.
1236 * - decoding: unused
1241 * number of reference frames
1242 * - encoding: Set by user.
1243 * - decoding: Set by lavc.
1247 #if FF_API_PRIVATE_OPT
1248 /** @deprecated use encoder private options instead */
1249 attribute_deprecated
1254 * Note: Value depends upon the compare function used for fullpel ME.
1255 * - encoding: Set by user.
1256 * - decoding: unused
1260 #if FF_API_PRIVATE_OPT
1261 /** @deprecated use encoder private options instead */
1262 attribute_deprecated
1267 * Chromaticity coordinates of the source primaries.
1268 * - encoding: Set by user
1269 * - decoding: Set by libavcodec
1271 enum AVColorPrimaries color_primaries;
1274 * Color Transfer Characteristic.
1275 * - encoding: Set by user
1276 * - decoding: Set by libavcodec
1278 enum AVColorTransferCharacteristic color_trc;
1281 * YUV colorspace type.
1282 * - encoding: Set by user
1283 * - decoding: Set by libavcodec
1285 enum AVColorSpace colorspace;
1288 * MPEG vs JPEG YUV range.
1289 * - encoding: Set by user
1290 * - decoding: Set by libavcodec
1292 enum AVColorRange color_range;
1295 * This defines the location of chroma samples.
1296 * - encoding: Set by user
1297 * - decoding: Set by libavcodec
1299 enum AVChromaLocation chroma_sample_location;
1303 * Indicates number of picture subdivisions. Used for parallelized
1305 * - encoding: Set by user
1306 * - decoding: unused
1311 * - encoding: set by libavcodec
1312 * - decoding: Set by user.
1314 enum AVFieldOrder field_order;
1317 int sample_rate; ///< samples per second
1318 int channels; ///< number of audio channels
1321 * audio sample format
1322 * - encoding: Set by user.
1323 * - decoding: Set by libavcodec.
1325 enum AVSampleFormat sample_fmt; ///< sample format
1327 /* The following data should not be initialized. */
1329 * Number of samples per channel in an audio frame.
1331 * - encoding: set by libavcodec in avcodec_open2(). Each submitted frame
1332 * except the last must contain exactly frame_size samples per channel.
1333 * May be 0 when the codec has AV_CODEC_CAP_VARIABLE_FRAME_SIZE set, then the
1334 * frame size is not restricted.
1335 * - decoding: may be set by some decoders to indicate constant frame size
1340 * Frame counter, set by libavcodec.
1342 * - decoding: total number of frames returned from the decoder so far.
1343 * - encoding: total number of frames passed to the encoder so far.
1345 * @note the counter is not incremented if encoding/decoding resulted in
1351 * number of bytes per packet if constant and known or 0
1352 * Used by some WAV based audio codecs.
1357 * Audio cutoff bandwidth (0 means "automatic")
1358 * - encoding: Set by user.
1359 * - decoding: unused
1364 * Audio channel layout.
1365 * - encoding: set by user.
1366 * - decoding: set by user, may be overwritten by libavcodec.
1368 uint64_t channel_layout;
1371 * Request decoder to use this channel layout if it can (0 for default)
1372 * - encoding: unused
1373 * - decoding: Set by user.
1375 uint64_t request_channel_layout;
1378 * Type of service that the audio stream conveys.
1379 * - encoding: Set by user.
1380 * - decoding: Set by libavcodec.
1382 enum AVAudioServiceType audio_service_type;
1385 * desired sample format
1386 * - encoding: Not used.
1387 * - decoding: Set by user.
1388 * Decoder will decode to this format if it can.
1390 enum AVSampleFormat request_sample_fmt;
1393 * This callback is called at the beginning of each frame to get data
1394 * buffer(s) for it. There may be one contiguous buffer for all the data or
1395 * there may be a buffer per each data plane or anything in between. What
1396 * this means is, you may set however many entries in buf[] you feel necessary.
1397 * Each buffer must be reference-counted using the AVBuffer API (see description
1400 * The following fields will be set in the frame before this callback is
1403 * - width, height (video only)
1404 * - sample_rate, channel_layout, nb_samples (audio only)
1405 * Their values may differ from the corresponding values in
1406 * AVCodecContext. This callback must use the frame values, not the codec
1407 * context values, to calculate the required buffer size.
1409 * This callback must fill the following fields in the frame:
1413 * * if the data is planar audio with more than 8 channels, then this
1414 * callback must allocate and fill extended_data to contain all pointers
1415 * to all data planes. data[] must hold as many pointers as it can.
1416 * extended_data must be allocated with av_malloc() and will be freed in
1418 * * otherwise extended_data must point to data
1419 * - buf[] must contain one or more pointers to AVBufferRef structures. Each of
1420 * the frame's data and extended_data pointers must be contained in these. That
1421 * is, one AVBufferRef for each allocated chunk of memory, not necessarily one
1422 * AVBufferRef per data[] entry. See: av_buffer_create(), av_buffer_alloc(),
1423 * and av_buffer_ref().
1424 * - extended_buf and nb_extended_buf must be allocated with av_malloc() by
1425 * this callback and filled with the extra buffers if there are more
1426 * buffers than buf[] can hold. extended_buf will be freed in
1429 * If AV_CODEC_CAP_DR1 is not set then get_buffer2() must call
1430 * avcodec_default_get_buffer2() instead of providing buffers allocated by
1433 * Each data plane must be aligned to the maximum required by the target
1436 * @see avcodec_default_get_buffer2()
1440 * If AV_GET_BUFFER_FLAG_REF is set in flags then the frame may be reused
1441 * (read and/or written to if it is writable) later by libavcodec.
1443 * avcodec_align_dimensions2() should be used to find the required width and
1444 * height, as they normally need to be rounded up to the next multiple of 16.
1446 * Some decoders do not support linesizes changing between frames.
1448 * If frame multithreading is used and thread_safe_callbacks is set,
1449 * this callback may be called from a different thread, but not from more
1450 * than one at once. Does not need to be reentrant.
1452 * @see avcodec_align_dimensions2()
1456 * Decoders request a buffer of a particular size by setting
1457 * AVFrame.nb_samples prior to calling get_buffer2(). The decoder may,
1458 * however, utilize only part of the buffer by setting AVFrame.nb_samples
1459 * to a smaller value in the output frame.
1461 * As a convenience, av_samples_get_buffer_size() and
1462 * av_samples_fill_arrays() in libavutil may be used by custom get_buffer2()
1463 * functions to find the required data size and to fill data pointers and
1464 * linesize. In AVFrame.linesize, only linesize[0] may be set for audio
1465 * since all planes must be the same size.
1467 * @see av_samples_get_buffer_size(), av_samples_fill_arrays()
1469 * - encoding: unused
1470 * - decoding: Set by libavcodec, user can override.
1472 int (*get_buffer2)(struct AVCodecContext *s, AVFrame *frame, int flags);
1475 * If non-zero, the decoded audio and video frames returned from
1476 * avcodec_decode_video2() and avcodec_decode_audio4() are reference-counted
1477 * and are valid indefinitely. The caller must free them with
1478 * av_frame_unref() when they are not needed anymore.
1479 * Otherwise, the decoded frames must not be freed by the caller and are
1480 * only valid until the next decode call.
1482 * This is always automatically enabled if avcodec_receive_frame() is used.
1484 * - encoding: unused
1485 * - decoding: set by the caller before avcodec_open2().
1487 attribute_deprecated
1488 int refcounted_frames;
1490 /* - encoding parameters */
1491 float qcompress; ///< amount of qscale change between easy & hard scenes (0.0-1.0)
1492 float qblur; ///< amount of qscale smoothing over time (0.0-1.0)
1496 * - encoding: Set by user.
1497 * - decoding: unused
1503 * - encoding: Set by user.
1504 * - decoding: unused
1509 * maximum quantizer difference between frames
1510 * - encoding: Set by user.
1511 * - decoding: unused
1516 * decoder bitstream buffer size
1517 * - encoding: Set by user.
1518 * - decoding: unused
1523 * ratecontrol override, see RcOverride
1524 * - encoding: Allocated/set/freed by user.
1525 * - decoding: unused
1527 int rc_override_count;
1528 RcOverride *rc_override;
1532 * - encoding: Set by user.
1533 * - decoding: Set by user, may be overwritten by libavcodec.
1535 int64_t rc_max_rate;
1539 * - encoding: Set by user.
1540 * - decoding: unused
1542 int64_t rc_min_rate;
1545 * Ratecontrol attempt to use, at maximum, <value> of what can be used without an underflow.
1546 * - encoding: Set by user.
1547 * - decoding: unused.
1549 float rc_max_available_vbv_use;
1552 * Ratecontrol attempt to use, at least, <value> times the amount needed to prevent a vbv overflow.
1553 * - encoding: Set by user.
1554 * - decoding: unused.
1556 float rc_min_vbv_overflow_use;
1559 * Number of bits which should be loaded into the rc buffer before decoding starts.
1560 * - encoding: Set by user.
1561 * - decoding: unused
1563 int rc_initial_buffer_occupancy;
1565 #if FF_API_CODER_TYPE
1566 #define FF_CODER_TYPE_VLC 0
1567 #define FF_CODER_TYPE_AC 1
1568 #define FF_CODER_TYPE_RAW 2
1569 #define FF_CODER_TYPE_RLE 3
1571 * @deprecated use encoder private options instead
1573 attribute_deprecated
1575 #endif /* FF_API_CODER_TYPE */
1577 #if FF_API_PRIVATE_OPT
1578 /** @deprecated use encoder private options instead */
1579 attribute_deprecated
1583 #if FF_API_PRIVATE_OPT
1584 /** @deprecated use encoder private options instead */
1585 attribute_deprecated
1586 int frame_skip_threshold;
1588 /** @deprecated use encoder private options instead */
1589 attribute_deprecated
1590 int frame_skip_factor;
1592 /** @deprecated use encoder private options instead */
1593 attribute_deprecated
1596 /** @deprecated use encoder private options instead */
1597 attribute_deprecated
1599 #endif /* FF_API_PRIVATE_OPT */
1602 * trellis RD quantization
1603 * - encoding: Set by user.
1604 * - decoding: unused
1608 #if FF_API_PRIVATE_OPT
1609 /** @deprecated use encoder private options instead */
1610 attribute_deprecated
1611 int min_prediction_order;
1613 /** @deprecated use encoder private options instead */
1614 attribute_deprecated
1615 int max_prediction_order;
1617 /** @deprecated use encoder private options instead */
1618 attribute_deprecated
1619 int64_t timecode_frame_start;
1622 #if FF_API_RTP_CALLBACK
1624 * @deprecated unused
1626 /* The RTP callback: This function is called */
1627 /* every time the encoder has a packet to send. */
1628 /* It depends on the encoder if the data starts */
1629 /* with a Start Code (it should). H.263 does. */
1630 /* mb_nb contains the number of macroblocks */
1631 /* encoded in the RTP payload. */
1632 attribute_deprecated
1633 void (*rtp_callback)(struct AVCodecContext *avctx, void *data, int size, int mb_nb);
1636 #if FF_API_PRIVATE_OPT
1637 /** @deprecated use encoder private options instead */
1638 attribute_deprecated
1639 int rtp_payload_size; /* The size of the RTP payload: the coder will */
1640 /* do its best to deliver a chunk with size */
1641 /* below rtp_payload_size, the chunk will start */
1642 /* with a start code on some codecs like H.263. */
1643 /* This doesn't take account of any particular */
1644 /* headers inside the transmitted RTP payload. */
1647 #if FF_API_STAT_BITS
1648 /* statistics, used for 2-pass encoding */
1649 attribute_deprecated
1651 attribute_deprecated
1653 attribute_deprecated
1655 attribute_deprecated
1657 attribute_deprecated
1659 attribute_deprecated
1661 attribute_deprecated
1663 attribute_deprecated
1666 /** @deprecated this field is unused */
1667 attribute_deprecated
1672 * pass1 encoding statistics output buffer
1673 * - encoding: Set by libavcodec.
1674 * - decoding: unused
1679 * pass2 encoding statistics input buffer
1680 * Concatenated stuff from stats_out of pass1 should be placed here.
1681 * - encoding: Allocated/set/freed by user.
1682 * - decoding: unused
1687 * Work around bugs in encoders which sometimes cannot be detected automatically.
1688 * - encoding: Set by user
1689 * - decoding: Set by user
1691 int workaround_bugs;
1692 #define FF_BUG_AUTODETECT 1 ///< autodetection
1693 #define FF_BUG_XVID_ILACE 4
1694 #define FF_BUG_UMP4 8
1695 #define FF_BUG_NO_PADDING 16
1696 #define FF_BUG_AMV 32
1697 #define FF_BUG_QPEL_CHROMA 64
1698 #define FF_BUG_STD_QPEL 128
1699 #define FF_BUG_QPEL_CHROMA2 256
1700 #define FF_BUG_DIRECT_BLOCKSIZE 512
1701 #define FF_BUG_EDGE 1024
1702 #define FF_BUG_HPEL_CHROMA 2048
1703 #define FF_BUG_DC_CLIP 4096
1704 #define FF_BUG_MS 8192 ///< Work around various bugs in Microsoft's broken decoders.
1705 #define FF_BUG_TRUNCATED 16384
1706 #define FF_BUG_IEDGE 32768
1709 * strictly follow the standard (MPEG-4, ...).
1710 * - encoding: Set by user.
1711 * - decoding: Set by user.
1712 * Setting this to STRICT or higher means the encoder and decoder will
1713 * generally do stupid things, whereas setting it to unofficial or lower
1714 * will mean the encoder might produce output that is not supported by all
1715 * spec-compliant decoders. Decoders don't differentiate between normal,
1716 * unofficial and experimental (that is, they always try to decode things
1717 * when they can) unless they are explicitly asked to behave stupidly
1718 * (=strictly conform to the specs)
1720 int strict_std_compliance;
1721 #define FF_COMPLIANCE_VERY_STRICT 2 ///< Strictly conform to an older more strict version of the spec or reference software.
1722 #define FF_COMPLIANCE_STRICT 1 ///< Strictly conform to all the things in the spec no matter what consequences.
1723 #define FF_COMPLIANCE_NORMAL 0
1724 #define FF_COMPLIANCE_UNOFFICIAL -1 ///< Allow unofficial extensions
1725 #define FF_COMPLIANCE_EXPERIMENTAL -2 ///< Allow nonstandardized experimental things.
1728 * error concealment flags
1729 * - encoding: unused
1730 * - decoding: Set by user.
1732 int error_concealment;
1733 #define FF_EC_GUESS_MVS 1
1734 #define FF_EC_DEBLOCK 2
1735 #define FF_EC_FAVOR_INTER 256
1739 * - encoding: Set by user.
1740 * - decoding: Set by user.
1743 #define FF_DEBUG_PICT_INFO 1
1744 #define FF_DEBUG_RC 2
1745 #define FF_DEBUG_BITSTREAM 4
1746 #define FF_DEBUG_MB_TYPE 8
1747 #define FF_DEBUG_QP 16
1750 * @deprecated this option does nothing
1752 #define FF_DEBUG_MV 32
1754 #define FF_DEBUG_DCT_COEFF 0x00000040
1755 #define FF_DEBUG_SKIP 0x00000080
1756 #define FF_DEBUG_STARTCODE 0x00000100
1757 #define FF_DEBUG_ER 0x00000400
1758 #define FF_DEBUG_MMCO 0x00000800
1759 #define FF_DEBUG_BUGS 0x00001000
1761 #define FF_DEBUG_VIS_QP 0x00002000
1762 #define FF_DEBUG_VIS_MB_TYPE 0x00004000
1764 #define FF_DEBUG_BUFFERS 0x00008000
1765 #define FF_DEBUG_THREADS 0x00010000
1766 #define FF_DEBUG_GREEN_MD 0x00800000
1767 #define FF_DEBUG_NOMC 0x01000000
1772 * - encoding: Set by user.
1773 * - decoding: Set by user.
1776 #define FF_DEBUG_VIS_MV_P_FOR 0x00000001 // visualize forward predicted MVs of P-frames
1777 #define FF_DEBUG_VIS_MV_B_FOR 0x00000002 // visualize forward predicted MVs of B-frames
1778 #define FF_DEBUG_VIS_MV_B_BACK 0x00000004 // visualize backward predicted MVs of B-frames
1782 * Error recognition; may misdetect some more or less valid parts as errors.
1783 * - encoding: unused
1784 * - decoding: Set by user.
1786 int err_recognition;
1789 * Verify checksums embedded in the bitstream (could be of either encoded or
1790 * decoded data, depending on the codec) and print an error message on mismatch.
1791 * If AV_EF_EXPLODE is also set, a mismatching checksum will result in the
1792 * decoder returning an error.
1794 #define AV_EF_CRCCHECK (1<<0)
1795 #define AV_EF_BITSTREAM (1<<1) ///< detect bitstream specification deviations
1796 #define AV_EF_BUFFER (1<<2) ///< detect improper bitstream length
1797 #define AV_EF_EXPLODE (1<<3) ///< abort decoding on minor error detection
1799 #define AV_EF_IGNORE_ERR (1<<15) ///< ignore errors and continue
1800 #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
1801 #define AV_EF_COMPLIANT (1<<17) ///< consider all spec non compliances as errors
1802 #define AV_EF_AGGRESSIVE (1<<18) ///< consider things that a sane encoder should not do as an error
1806 * opaque 64-bit number (generally a PTS) that will be reordered and
1807 * output in AVFrame.reordered_opaque
1808 * - encoding: Set by libavcodec to the reordered_opaque of the input
1809 * frame corresponding to the last returned packet. Only
1810 * supported by encoders with the
1811 * AV_CODEC_CAP_ENCODER_REORDERED_OPAQUE capability.
1812 * - decoding: Set by user.
1814 int64_t reordered_opaque;
1817 * Hardware accelerator in use
1818 * - encoding: unused.
1819 * - decoding: Set by libavcodec
1821 const struct AVHWAccel *hwaccel;
1824 * Hardware accelerator context.
1825 * For some hardware accelerators, a global context needs to be
1826 * provided by the user. In that case, this holds display-dependent
1827 * data FFmpeg cannot instantiate itself. Please refer to the
1828 * FFmpeg HW accelerator documentation to know how to fill this
1829 * is. e.g. for VA API, this is a struct vaapi_context.
1830 * - encoding: unused
1831 * - decoding: Set by user
1833 void *hwaccel_context;
1837 * - encoding: Set by libavcodec if flags & AV_CODEC_FLAG_PSNR.
1838 * - decoding: unused
1840 uint64_t error[AV_NUM_DATA_POINTERS];
1843 * DCT algorithm, see FF_DCT_* below
1844 * - encoding: Set by user.
1845 * - decoding: unused
1848 #define FF_DCT_AUTO 0
1849 #define FF_DCT_FASTINT 1
1850 #define FF_DCT_INT 2
1851 #define FF_DCT_MMX 3
1852 #define FF_DCT_ALTIVEC 5
1853 #define FF_DCT_FAAN 6
1856 * IDCT algorithm, see FF_IDCT_* below.
1857 * - encoding: Set by user.
1858 * - decoding: Set by user.
1861 #define FF_IDCT_AUTO 0
1862 #define FF_IDCT_INT 1
1863 #define FF_IDCT_SIMPLE 2
1864 #define FF_IDCT_SIMPLEMMX 3
1865 #define FF_IDCT_ARM 7
1866 #define FF_IDCT_ALTIVEC 8
1867 #define FF_IDCT_SIMPLEARM 10
1868 #define FF_IDCT_XVID 14
1869 #define FF_IDCT_SIMPLEARMV5TE 16
1870 #define FF_IDCT_SIMPLEARMV6 17
1871 #define FF_IDCT_FAAN 20
1872 #define FF_IDCT_SIMPLENEON 22
1873 #define FF_IDCT_NONE 24 /* Used by XvMC to extract IDCT coefficients with FF_IDCT_PERM_NONE */
1874 #define FF_IDCT_SIMPLEAUTO 128
1877 * bits per sample/pixel from the demuxer (needed for huffyuv).
1878 * - encoding: Set by libavcodec.
1879 * - decoding: Set by user.
1881 int bits_per_coded_sample;
1884 * Bits per sample/pixel of internal libavcodec pixel/sample format.
1885 * - encoding: set by user.
1886 * - decoding: set by libavcodec.
1888 int bits_per_raw_sample;
1892 * low resolution decoding, 1-> 1/2 size, 2->1/4 size
1893 * - encoding: unused
1894 * - decoding: Set by user.
1899 #if FF_API_CODED_FRAME
1901 * the picture in the bitstream
1902 * - encoding: Set by libavcodec.
1903 * - decoding: unused
1905 * @deprecated use the quality factor packet side data instead
1907 attribute_deprecated AVFrame *coded_frame;
1912 * is used to decide how many independent tasks should be passed to execute()
1913 * - encoding: Set by user.
1914 * - decoding: Set by user.
1919 * Which multithreading methods to use.
1920 * Use of FF_THREAD_FRAME will increase decoding delay by one frame per thread,
1921 * so clients which cannot provide future frames should not use it.
1923 * - encoding: Set by user, otherwise the default is used.
1924 * - decoding: Set by user, otherwise the default is used.
1927 #define FF_THREAD_FRAME 1 ///< Decode more than one frame at once
1928 #define FF_THREAD_SLICE 2 ///< Decode more than one part of a single frame at once
1931 * Which multithreading methods are in use by the codec.
1932 * - encoding: Set by libavcodec.
1933 * - decoding: Set by libavcodec.
1935 int active_thread_type;
1938 * Set by the client if its custom get_buffer() callback can be called
1939 * synchronously from another thread, which allows faster multithreaded decoding.
1940 * draw_horiz_band() will be called from other threads regardless of this setting.
1941 * Ignored if the default get_buffer() is used.
1942 * - encoding: Set by user.
1943 * - decoding: Set by user.
1945 int thread_safe_callbacks;
1948 * The codec may call this to execute several independent things.
1949 * It will return only after finishing all tasks.
1950 * The user may replace this with some multithreaded implementation,
1951 * the default implementation will execute the parts serially.
1952 * @param count the number of things to execute
1953 * - encoding: Set by libavcodec, user can override.
1954 * - decoding: Set by libavcodec, user can override.
1956 int (*execute)(struct AVCodecContext *c, int (*func)(struct AVCodecContext *c2, void *arg), void *arg2, int *ret, int count, int size);
1959 * The codec may call this to execute several independent things.
1960 * It will return only after finishing all tasks.
1961 * The user may replace this with some multithreaded implementation,
1962 * the default implementation will execute the parts serially.
1963 * Also see avcodec_thread_init and e.g. the --enable-pthread configure option.
1964 * @param c context passed also to func
1965 * @param count the number of things to execute
1966 * @param arg2 argument passed unchanged to func
1967 * @param ret return values of executed functions, must have space for "count" values. May be NULL.
1968 * @param func function that will be called count times, with jobnr from 0 to count-1.
1969 * threadnr will be in the range 0 to c->thread_count-1 < MAX_THREADS and so that no
1970 * two instances of func executing at the same time will have the same threadnr.
1971 * @return always 0 currently, but code should handle a future improvement where when any call to func
1972 * returns < 0 no further calls to func may be done and < 0 is returned.
1973 * - encoding: Set by libavcodec, user can override.
1974 * - decoding: Set by libavcodec, user can override.
1976 int (*execute2)(struct AVCodecContext *c, int (*func)(struct AVCodecContext *c2, void *arg, int jobnr, int threadnr), void *arg2, int *ret, int count);
1979 * noise vs. sse weight for the nsse comparison function
1980 * - encoding: Set by user.
1981 * - decoding: unused
1987 * - encoding: Set by user.
1988 * - decoding: Set by libavcodec.
1991 #define FF_PROFILE_UNKNOWN -99
1992 #define FF_PROFILE_RESERVED -100
1994 #define FF_PROFILE_AAC_MAIN 0
1995 #define FF_PROFILE_AAC_LOW 1
1996 #define FF_PROFILE_AAC_SSR 2
1997 #define FF_PROFILE_AAC_LTP 3
1998 #define FF_PROFILE_AAC_HE 4
1999 #define FF_PROFILE_AAC_HE_V2 28
2000 #define FF_PROFILE_AAC_LD 22
2001 #define FF_PROFILE_AAC_ELD 38
2002 #define FF_PROFILE_MPEG2_AAC_LOW 128
2003 #define FF_PROFILE_MPEG2_AAC_HE 131
2005 #define FF_PROFILE_DNXHD 0
2006 #define FF_PROFILE_DNXHR_LB 1
2007 #define FF_PROFILE_DNXHR_SQ 2
2008 #define FF_PROFILE_DNXHR_HQ 3
2009 #define FF_PROFILE_DNXHR_HQX 4
2010 #define FF_PROFILE_DNXHR_444 5
2012 #define FF_PROFILE_DTS 20
2013 #define FF_PROFILE_DTS_ES 30
2014 #define FF_PROFILE_DTS_96_24 40
2015 #define FF_PROFILE_DTS_HD_HRA 50
2016 #define FF_PROFILE_DTS_HD_MA 60
2017 #define FF_PROFILE_DTS_EXPRESS 70
2019 #define FF_PROFILE_MPEG2_422 0
2020 #define FF_PROFILE_MPEG2_HIGH 1
2021 #define FF_PROFILE_MPEG2_SS 2
2022 #define FF_PROFILE_MPEG2_SNR_SCALABLE 3
2023 #define FF_PROFILE_MPEG2_MAIN 4
2024 #define FF_PROFILE_MPEG2_SIMPLE 5
2026 #define FF_PROFILE_H264_CONSTRAINED (1<<9) // 8+1; constraint_set1_flag
2027 #define FF_PROFILE_H264_INTRA (1<<11) // 8+3; constraint_set3_flag
2029 #define FF_PROFILE_H264_BASELINE 66
2030 #define FF_PROFILE_H264_CONSTRAINED_BASELINE (66|FF_PROFILE_H264_CONSTRAINED)
2031 #define FF_PROFILE_H264_MAIN 77
2032 #define FF_PROFILE_H264_EXTENDED 88
2033 #define FF_PROFILE_H264_HIGH 100
2034 #define FF_PROFILE_H264_HIGH_10 110
2035 #define FF_PROFILE_H264_HIGH_10_INTRA (110|FF_PROFILE_H264_INTRA)
2036 #define FF_PROFILE_H264_MULTIVIEW_HIGH 118
2037 #define FF_PROFILE_H264_HIGH_422 122
2038 #define FF_PROFILE_H264_HIGH_422_INTRA (122|FF_PROFILE_H264_INTRA)
2039 #define FF_PROFILE_H264_STEREO_HIGH 128
2040 #define FF_PROFILE_H264_HIGH_444 144
2041 #define FF_PROFILE_H264_HIGH_444_PREDICTIVE 244
2042 #define FF_PROFILE_H264_HIGH_444_INTRA (244|FF_PROFILE_H264_INTRA)
2043 #define FF_PROFILE_H264_CAVLC_444 44
2045 #define FF_PROFILE_VC1_SIMPLE 0
2046 #define FF_PROFILE_VC1_MAIN 1
2047 #define FF_PROFILE_VC1_COMPLEX 2
2048 #define FF_PROFILE_VC1_ADVANCED 3
2050 #define FF_PROFILE_MPEG4_SIMPLE 0
2051 #define FF_PROFILE_MPEG4_SIMPLE_SCALABLE 1
2052 #define FF_PROFILE_MPEG4_CORE 2
2053 #define FF_PROFILE_MPEG4_MAIN 3
2054 #define FF_PROFILE_MPEG4_N_BIT 4
2055 #define FF_PROFILE_MPEG4_SCALABLE_TEXTURE 5
2056 #define FF_PROFILE_MPEG4_SIMPLE_FACE_ANIMATION 6
2057 #define FF_PROFILE_MPEG4_BASIC_ANIMATED_TEXTURE 7
2058 #define FF_PROFILE_MPEG4_HYBRID 8
2059 #define FF_PROFILE_MPEG4_ADVANCED_REAL_TIME 9
2060 #define FF_PROFILE_MPEG4_CORE_SCALABLE 10
2061 #define FF_PROFILE_MPEG4_ADVANCED_CODING 11
2062 #define FF_PROFILE_MPEG4_ADVANCED_CORE 12
2063 #define FF_PROFILE_MPEG4_ADVANCED_SCALABLE_TEXTURE 13
2064 #define FF_PROFILE_MPEG4_SIMPLE_STUDIO 14
2065 #define FF_PROFILE_MPEG4_ADVANCED_SIMPLE 15
2067 #define FF_PROFILE_JPEG2000_CSTREAM_RESTRICTION_0 1
2068 #define FF_PROFILE_JPEG2000_CSTREAM_RESTRICTION_1 2
2069 #define FF_PROFILE_JPEG2000_CSTREAM_NO_RESTRICTION 32768
2070 #define FF_PROFILE_JPEG2000_DCINEMA_2K 3
2071 #define FF_PROFILE_JPEG2000_DCINEMA_4K 4
2073 #define FF_PROFILE_VP9_0 0
2074 #define FF_PROFILE_VP9_1 1
2075 #define FF_PROFILE_VP9_2 2
2076 #define FF_PROFILE_VP9_3 3
2078 #define FF_PROFILE_HEVC_MAIN 1
2079 #define FF_PROFILE_HEVC_MAIN_10 2
2080 #define FF_PROFILE_HEVC_MAIN_STILL_PICTURE 3
2081 #define FF_PROFILE_HEVC_REXT 4
2083 #define FF_PROFILE_AV1_MAIN 0
2084 #define FF_PROFILE_AV1_HIGH 1
2085 #define FF_PROFILE_AV1_PROFESSIONAL 2
2087 #define FF_PROFILE_MJPEG_HUFFMAN_BASELINE_DCT 0xc0
2088 #define FF_PROFILE_MJPEG_HUFFMAN_EXTENDED_SEQUENTIAL_DCT 0xc1
2089 #define FF_PROFILE_MJPEG_HUFFMAN_PROGRESSIVE_DCT 0xc2
2090 #define FF_PROFILE_MJPEG_HUFFMAN_LOSSLESS 0xc3
2091 #define FF_PROFILE_MJPEG_JPEG_LS 0xf7
2093 #define FF_PROFILE_SBC_MSBC 1
2095 #define FF_PROFILE_PRORES_PROXY 0
2096 #define FF_PROFILE_PRORES_LT 1
2097 #define FF_PROFILE_PRORES_STANDARD 2
2098 #define FF_PROFILE_PRORES_HQ 3
2099 #define FF_PROFILE_PRORES_4444 4
2100 #define FF_PROFILE_PRORES_XQ 5
2102 #define FF_PROFILE_ARIB_PROFILE_A 0
2103 #define FF_PROFILE_ARIB_PROFILE_C 1
2107 * - encoding: Set by user.
2108 * - decoding: Set by libavcodec.
2111 #define FF_LEVEL_UNKNOWN -99
2114 * Skip loop filtering for selected frames.
2115 * - encoding: unused
2116 * - decoding: Set by user.
2118 enum AVDiscard skip_loop_filter;
2121 * Skip IDCT/dequantization for selected frames.
2122 * - encoding: unused
2123 * - decoding: Set by user.
2125 enum AVDiscard skip_idct;
2128 * Skip decoding for selected frames.
2129 * - encoding: unused
2130 * - decoding: Set by user.
2132 enum AVDiscard skip_frame;
2135 * Header containing style information for text subtitles.
2136 * For SUBTITLE_ASS subtitle type, it should contain the whole ASS
2137 * [Script Info] and [V4+ Styles] section, plus the [Events] line and
2138 * the Format line following. It shouldn't include any Dialogue line.
2139 * - encoding: Set/allocated/freed by user (before avcodec_open2())
2140 * - decoding: Set/allocated/freed by libavcodec (by avcodec_open2())
2142 uint8_t *subtitle_header;
2143 int subtitle_header_size;
2145 #if FF_API_VBV_DELAY
2147 * VBV delay coded in the last frame (in periods of a 27 MHz clock).
2148 * Used for compliant TS muxing.
2149 * - encoding: Set by libavcodec.
2150 * - decoding: unused.
2151 * @deprecated this value is now exported as a part of
2152 * AV_PKT_DATA_CPB_PROPERTIES packet side data
2154 attribute_deprecated
2158 #if FF_API_SIDEDATA_ONLY_PKT
2160 * Encoding only and set by default. Allow encoders to output packets
2161 * that do not contain any encoded data, only side data.
2163 * Some encoders need to output such packets, e.g. to update some stream
2164 * parameters at the end of encoding.
2166 * @deprecated this field disables the default behaviour and
2167 * it is kept only for compatibility.
2169 attribute_deprecated
2170 int side_data_only_packets;
2174 * Audio only. The number of "priming" samples (padding) inserted by the
2175 * encoder at the beginning of the audio. I.e. this number of leading
2176 * decoded samples must be discarded by the caller to get the original audio
2177 * without leading padding.
2179 * - decoding: unused
2180 * - encoding: Set by libavcodec. The timestamps on the output packets are
2181 * adjusted by the encoder so that they always refer to the
2182 * first sample of the data actually contained in the packet,
2183 * including any added padding. E.g. if the timebase is
2184 * 1/samplerate and the timestamp of the first input sample is
2185 * 0, the timestamp of the first output packet will be
2188 int initial_padding;
2191 * - decoding: For codecs that store a framerate value in the compressed
2192 * bitstream, the decoder may export it here. { 0, 1} when
2194 * - encoding: May be used to signal the framerate of CFR content to an
2197 AVRational framerate;
2200 * Nominal unaccelerated pixel format, see AV_PIX_FMT_xxx.
2201 * - encoding: unused.
2202 * - decoding: Set by libavcodec before calling get_format()
2204 enum AVPixelFormat sw_pix_fmt;
2207 * Timebase in which pkt_dts/pts and AVPacket.dts/pts are.
2208 * - encoding unused.
2209 * - decoding set by user.
2211 AVRational pkt_timebase;
2215 * - encoding: unused.
2216 * - decoding: set by libavcodec.
2218 const AVCodecDescriptor *codec_descriptor;
2222 * low resolution decoding, 1-> 1/2 size, 2->1/4 size
2223 * - encoding: unused
2224 * - decoding: Set by user.
2230 * Current statistics for PTS correction.
2231 * - decoding: maintained and used by libavcodec, not intended to be used by user apps
2232 * - encoding: unused
2234 int64_t pts_correction_num_faulty_pts; /// Number of incorrect PTS values so far
2235 int64_t pts_correction_num_faulty_dts; /// Number of incorrect DTS values so far
2236 int64_t pts_correction_last_pts; /// PTS of the last frame
2237 int64_t pts_correction_last_dts; /// DTS of the last frame
2240 * Character encoding of the input subtitles file.
2241 * - decoding: set by user
2242 * - encoding: unused
2247 * Subtitles character encoding mode. Formats or codecs might be adjusting
2248 * this setting (if they are doing the conversion themselves for instance).
2249 * - decoding: set by libavcodec
2250 * - encoding: unused
2252 int sub_charenc_mode;
2253 #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)
2254 #define FF_SUB_CHARENC_MODE_AUTOMATIC 0 ///< libavcodec will select the mode itself
2255 #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
2256 #define FF_SUB_CHARENC_MODE_IGNORE 2 ///< neither convert the subtitles, nor check them for valid UTF-8
2259 * Skip processing alpha if supported by codec.
2260 * Note that if the format uses pre-multiplied alpha (common with VP6,
2261 * and recommended due to better video quality/compression)
2262 * the image will look as if alpha-blended onto a black background.
2263 * However for formats that do not use pre-multiplied alpha
2264 * there might be serious artefacts (though e.g. libswscale currently
2265 * assumes pre-multiplied alpha anyway).
2267 * - decoding: set by user
2268 * - encoding: unused
2273 * Number of samples to skip after a discontinuity
2274 * - decoding: unused
2275 * - encoding: set by libavcodec
2279 #if !FF_API_DEBUG_MV
2281 * debug motion vectors
2282 * - encoding: Set by user.
2283 * - decoding: Set by user.
2286 #define FF_DEBUG_VIS_MV_P_FOR 0x00000001 //visualize forward predicted MVs of P frames
2287 #define FF_DEBUG_VIS_MV_B_FOR 0x00000002 //visualize forward predicted MVs of B frames
2288 #define FF_DEBUG_VIS_MV_B_BACK 0x00000004 //visualize backward predicted MVs of B frames
2292 * custom intra quantization matrix
2293 * - encoding: Set by user, can be NULL.
2294 * - decoding: unused.
2296 uint16_t *chroma_intra_matrix;
2299 * dump format separator.
2300 * can be ", " or "\n " or anything else
2301 * - encoding: Set by user.
2302 * - decoding: Set by user.
2304 uint8_t *dump_separator;
2307 * ',' separated list of allowed decoders.
2308 * If NULL then all are allowed
2309 * - encoding: unused
2310 * - decoding: set by user
2312 char *codec_whitelist;
2315 * Properties of the stream that gets decoded
2316 * - encoding: unused
2317 * - decoding: set by libavcodec
2319 unsigned properties;
2320 #define FF_CODEC_PROPERTY_LOSSLESS 0x00000001
2321 #define FF_CODEC_PROPERTY_CLOSED_CAPTIONS 0x00000002
2324 * Additional data associated with the entire coded stream.
2326 * - decoding: unused
2327 * - encoding: may be set by libavcodec after avcodec_open2().
2329 AVPacketSideData *coded_side_data;
2330 int nb_coded_side_data;
2333 * A reference to the AVHWFramesContext describing the input (for encoding)
2334 * or output (decoding) frames. The reference is set by the caller and
2335 * afterwards owned (and freed) by libavcodec - it should never be read by
2336 * the caller after being set.
2338 * - decoding: This field should be set by the caller from the get_format()
2339 * callback. The previous reference (if any) will always be
2340 * unreffed by libavcodec before the get_format() call.
2342 * If the default get_buffer2() is used with a hwaccel pixel
2343 * format, then this AVHWFramesContext will be used for
2344 * allocating the frame buffers.
2346 * - encoding: For hardware encoders configured to use a hwaccel pixel
2347 * format, this field should be set by the caller to a reference
2348 * to the AVHWFramesContext describing input frames.
2349 * AVHWFramesContext.format must be equal to
2350 * AVCodecContext.pix_fmt.
2352 * This field should be set before avcodec_open2() is called.
2354 AVBufferRef *hw_frames_ctx;
2357 * Control the form of AVSubtitle.rects[N]->ass
2358 * - decoding: set by user
2359 * - encoding: unused
2361 int sub_text_format;
2362 #define FF_SUB_TEXT_FMT_ASS 0
2363 #if FF_API_ASS_TIMING
2364 #define FF_SUB_TEXT_FMT_ASS_WITH_TIMINGS 1
2368 * Audio only. The amount of padding (in samples) appended by the encoder to
2369 * the end of the audio. I.e. this number of decoded samples must be
2370 * discarded by the caller from the end of the stream to get the original
2371 * audio without any trailing padding.
2373 * - decoding: unused
2374 * - encoding: unused
2376 int trailing_padding;
2379 * The number of pixels per image to maximally accept.
2381 * - decoding: set by user
2382 * - encoding: set by user
2387 * A reference to the AVHWDeviceContext describing the device which will
2388 * be used by a hardware encoder/decoder. The reference is set by the
2389 * caller and afterwards owned (and freed) by libavcodec.
2391 * This should be used if either the codec device does not require
2392 * hardware frames or any that are used are to be allocated internally by
2393 * libavcodec. If the user wishes to supply any of the frames used as
2394 * encoder input or decoder output then hw_frames_ctx should be used
2395 * instead. When hw_frames_ctx is set in get_format() for a decoder, this
2396 * field will be ignored while decoding the associated stream segment, but
2397 * may again be used on a following one after another get_format() call.
2399 * For both encoders and decoders this field should be set before
2400 * avcodec_open2() is called and must not be written to thereafter.
2402 * Note that some decoders may require this field to be set initially in
2403 * order to support hw_frames_ctx at all - in that case, all frames
2404 * contexts used must be created on the same device.
2406 AVBufferRef *hw_device_ctx;
2409 * Bit set of AV_HWACCEL_FLAG_* flags, which affect hardware accelerated
2410 * decoding (if active).
2411 * - encoding: unused
2412 * - decoding: Set by user (either before avcodec_open2(), or in the
2413 * AVCodecContext.get_format callback)
2418 * Video decoding only. Certain video codecs support cropping, meaning that
2419 * only a sub-rectangle of the decoded frame is intended for display. This
2420 * option controls how cropping is handled by libavcodec.
2422 * When set to 1 (the default), libavcodec will apply cropping internally.
2423 * I.e. it will modify the output frame width/height fields and offset the
2424 * data pointers (only by as much as possible while preserving alignment, or
2425 * by the full amount if the AV_CODEC_FLAG_UNALIGNED flag is set) so that
2426 * the frames output by the decoder refer only to the cropped area. The
2427 * crop_* fields of the output frames will be zero.
2429 * When set to 0, the width/height fields of the output frames will be set
2430 * to the coded dimensions and the crop_* fields will describe the cropping
2431 * rectangle. Applying the cropping is left to the caller.
2433 * @warning When hardware acceleration with opaque output frames is used,
2434 * libavcodec is unable to apply cropping from the top/left border.
2436 * @note when this option is set to zero, the width/height fields of the
2437 * AVCodecContext and output AVFrames have different meanings. The codec
2438 * context fields store display dimensions (with the coded dimensions in
2439 * coded_width/height), while the frame fields store the coded dimensions
2440 * (with the display dimensions being determined by the crop_* fields).
2445 * Video decoding only. Sets the number of extra hardware frames which
2446 * the decoder will allocate for use by the caller. This must be set
2447 * before avcodec_open2() is called.
2449 * Some hardware decoders require all frames that they will use for
2450 * output to be defined in advance before decoding starts. For such
2451 * decoders, the hardware frame pool must therefore be of a fixed size.
2452 * The extra frames set here are on top of any number that the decoder
2453 * needs internally in order to operate normally (for example, frames
2454 * used as reference pictures).
2456 int extra_hw_frames;
2459 * The percentage of damaged samples to discard a frame.
2461 * - decoding: set by user
2462 * - encoding: unused
2464 int discard_damaged_percentage;
2467 * The number of samples per frame to maximally accept.
2469 * - decoding: set by user
2470 * - encoding: set by user
2472 int64_t max_samples;
2475 * Bit set of AV_CODEC_EXPORT_DATA_* flags, which affects the kind of
2476 * metadata exported in frame, packet, or coded stream side data by
2477 * decoders and encoders.
2479 * - decoding: set by user
2480 * - encoding: set by user
2482 int export_side_data;
2485 #if FF_API_CODEC_GET_SET
2487 * Accessors for some AVCodecContext fields. These used to be provided for ABI
2488 * compatibility, and do not need to be used anymore.
2490 attribute_deprecated
2491 AVRational av_codec_get_pkt_timebase (const AVCodecContext *avctx);
2492 attribute_deprecated
2493 void av_codec_set_pkt_timebase (AVCodecContext *avctx, AVRational val);
2495 attribute_deprecated
2496 const AVCodecDescriptor *av_codec_get_codec_descriptor(const AVCodecContext *avctx);
2497 attribute_deprecated
2498 void av_codec_set_codec_descriptor(AVCodecContext *avctx, const AVCodecDescriptor *desc);
2500 attribute_deprecated
2501 unsigned av_codec_get_codec_properties(const AVCodecContext *avctx);
2504 attribute_deprecated
2505 int av_codec_get_lowres(const AVCodecContext *avctx);
2506 attribute_deprecated
2507 void av_codec_set_lowres(AVCodecContext *avctx, int val);
2510 attribute_deprecated
2511 int av_codec_get_seek_preroll(const AVCodecContext *avctx);
2512 attribute_deprecated
2513 void av_codec_set_seek_preroll(AVCodecContext *avctx, int val);
2515 attribute_deprecated
2516 uint16_t *av_codec_get_chroma_intra_matrix(const AVCodecContext *avctx);
2517 attribute_deprecated
2518 void av_codec_set_chroma_intra_matrix(AVCodecContext *avctx, uint16_t *val);
2524 typedef struct AVProfile {
2526 const char *name; ///< short name for the profile
2531 * The codec supports this format via the hw_device_ctx interface.
2533 * When selecting this format, AVCodecContext.hw_device_ctx should
2534 * have been set to a device of the specified type before calling
2537 AV_CODEC_HW_CONFIG_METHOD_HW_DEVICE_CTX = 0x01,
2539 * The codec supports this format via the hw_frames_ctx interface.
2541 * When selecting this format for a decoder,
2542 * AVCodecContext.hw_frames_ctx should be set to a suitable frames
2543 * context inside the get_format() callback. The frames context
2544 * must have been created on a device of the specified type.
2546 * When selecting this format for an encoder,
2547 * AVCodecContext.hw_frames_ctx should be set to the context which
2548 * will be used for the input frames before calling avcodec_open2().
2550 AV_CODEC_HW_CONFIG_METHOD_HW_FRAMES_CTX = 0x02,
2552 * The codec supports this format by some internal method.
2554 * This format can be selected without any additional configuration -
2555 * no device or frames context is required.
2557 AV_CODEC_HW_CONFIG_METHOD_INTERNAL = 0x04,
2559 * The codec supports this format by some ad-hoc method.
2561 * Additional settings and/or function calls are required. See the
2562 * codec-specific documentation for details. (Methods requiring
2563 * this sort of configuration are deprecated and others should be
2564 * used in preference.)
2566 AV_CODEC_HW_CONFIG_METHOD_AD_HOC = 0x08,
2569 typedef struct AVCodecHWConfig {
2571 * For decoders, a hardware pixel format which that decoder may be
2572 * able to decode to if suitable hardware is available.
2574 * For encoders, a pixel format which the encoder may be able to
2575 * accept. If set to AV_PIX_FMT_NONE, this applies to all pixel
2576 * formats supported by the codec.
2578 enum AVPixelFormat pix_fmt;
2580 * Bit set of AV_CODEC_HW_CONFIG_METHOD_* flags, describing the possible
2581 * setup methods which can be used with this configuration.
2585 * The device type associated with the configuration.
2587 * Must be set for AV_CODEC_HW_CONFIG_METHOD_HW_DEVICE_CTX and
2588 * AV_CODEC_HW_CONFIG_METHOD_HW_FRAMES_CTX, otherwise unused.
2590 enum AVHWDeviceType device_type;
2593 typedef struct AVCodecDefault AVCodecDefault;
2600 typedef struct AVCodec {
2602 * Name of the codec implementation.
2603 * The name is globally unique among encoders and among decoders (but an
2604 * encoder and a decoder can share the same name).
2605 * This is the primary way to find a codec from the user perspective.
2609 * Descriptive name for the codec, meant to be more human readable than name.
2610 * You should use the NULL_IF_CONFIG_SMALL() macro to define it.
2612 const char *long_name;
2613 enum AVMediaType type;
2616 * Codec capabilities.
2617 * see AV_CODEC_CAP_*
2620 const AVRational *supported_framerates; ///< array of supported framerates, or NULL if any, array is terminated by {0,0}
2621 const enum AVPixelFormat *pix_fmts; ///< array of supported pixel formats, or NULL if unknown, array is terminated by -1
2622 const int *supported_samplerates; ///< array of supported audio samplerates, or NULL if unknown, array is terminated by 0
2623 const enum AVSampleFormat *sample_fmts; ///< array of supported sample formats, or NULL if unknown, array is terminated by -1
2624 const uint64_t *channel_layouts; ///< array of support channel layouts, or NULL if unknown. array is terminated by 0
2625 uint8_t max_lowres; ///< maximum value for lowres supported by the decoder
2626 const AVClass *priv_class; ///< AVClass for the private context
2627 const AVProfile *profiles; ///< array of recognized profiles, or NULL if unknown, array is terminated by {FF_PROFILE_UNKNOWN}
2630 * Group name of the codec implementation.
2631 * This is a short symbolic name of the wrapper backing this codec. A
2632 * wrapper uses some kind of external implementation for the codec, such
2633 * as an external library, or a codec implementation provided by the OS or
2635 * If this field is NULL, this is a builtin, libavcodec native codec.
2636 * If non-NULL, this will be the suffix in AVCodec.name in most cases
2637 * (usually AVCodec.name will be of the form "<codec_name>_<wrapper_name>").
2639 const char *wrapper_name;
2641 /*****************************************************************
2642 * No fields below this line are part of the public API. They
2643 * may not be used outside of libavcodec and can be changed and
2645 * New public fields should be added right above.
2646 *****************************************************************
2649 struct AVCodec *next;
2651 * @name Frame-level threading support functions
2655 * Copy necessary context variables from a previous thread context to the current one.
2656 * If not defined, the next thread will start automatically; otherwise, the codec
2657 * must call ff_thread_finish_setup().
2659 * dst and src will (rarely) point to the same context, in which case memcpy should be skipped.
2661 int (*update_thread_context)(AVCodecContext *dst, const AVCodecContext *src);
2665 * Private codec-specific defaults.
2667 const AVCodecDefault *defaults;
2670 * Initialize codec static data, called from avcodec_register().
2672 * This is not intended for time consuming operations as it is
2673 * run for every codec regardless of that codec being used.
2675 void (*init_static_data)(struct AVCodec *codec);
2677 int (*init)(AVCodecContext *);
2678 int (*encode_sub)(AVCodecContext *, uint8_t *buf, int buf_size,
2679 const struct AVSubtitle *sub);
2681 * Encode data to an AVPacket.
2683 * @param avctx codec context
2684 * @param avpkt output AVPacket (may contain a user-provided buffer)
2685 * @param[in] frame AVFrame containing the raw data to be encoded
2686 * @param[out] got_packet_ptr encoder sets to 0 or 1 to indicate that a
2687 * non-empty packet was returned in avpkt.
2688 * @return 0 on success, negative error code on failure
2690 int (*encode2)(AVCodecContext *avctx, AVPacket *avpkt, const AVFrame *frame,
2691 int *got_packet_ptr);
2692 int (*decode)(AVCodecContext *, void *outdata, int *outdata_size, AVPacket *avpkt);
2693 int (*close)(AVCodecContext *);
2695 * Encode API with decoupled packet/frame dataflow. The API is the
2696 * same as the avcodec_ prefixed APIs (avcodec_send_frame() etc.), except
2698 * - never called if the codec is closed or the wrong type,
2699 * - if AV_CODEC_CAP_DELAY is not set, drain frames are never sent,
2700 * - only one drain frame is ever passed down,
2702 int (*send_frame)(AVCodecContext *avctx, const AVFrame *frame);
2703 int (*receive_packet)(AVCodecContext *avctx, AVPacket *avpkt);
2706 * Decode API with decoupled packet/frame dataflow. This function is called
2707 * to get one output frame. It should call ff_decode_get_packet() to obtain
2710 int (*receive_frame)(AVCodecContext *avctx, AVFrame *frame);
2713 * Will be called when seeking
2715 void (*flush)(AVCodecContext *);
2717 * Internal codec capabilities.
2718 * See FF_CODEC_CAP_* in internal.h
2723 * Decoding only, a comma-separated list of bitstream filters to apply to
2724 * packets before decoding.
2729 * Array of pointers to hardware configurations supported by the codec,
2730 * or NULL if no hardware supported. The array is terminated by a NULL
2733 * The user can only access this field via avcodec_get_hw_config().
2735 const struct AVCodecHWConfigInternal **hw_configs;
2738 * List of supported codec_tags, terminated by FF_CODEC_TAGS_END.
2740 const uint32_t *codec_tags;
2743 #if FF_API_CODEC_GET_SET
2744 attribute_deprecated
2745 int av_codec_get_max_lowres(const AVCodec *codec);
2748 struct MpegEncContext;
2751 * Retrieve supported hardware configurations for a codec.
2753 * Values of index from zero to some maximum return the indexed configuration
2754 * descriptor; all other values return NULL. If the codec does not support
2755 * any hardware configurations then it will always return NULL.
2757 const AVCodecHWConfig *avcodec_get_hw_config(const AVCodec *codec, int index);
2760 * @defgroup lavc_hwaccel AVHWAccel
2762 * @note Nothing in this structure should be accessed by the user. At some
2763 * point in future it will not be externally visible at all.
2767 typedef struct AVHWAccel {
2769 * Name of the hardware accelerated codec.
2770 * The name is globally unique among encoders and among decoders (but an
2771 * encoder and a decoder can share the same name).
2776 * Type of codec implemented by the hardware accelerator.
2778 * See AVMEDIA_TYPE_xxx
2780 enum AVMediaType type;
2783 * Codec implemented by the hardware accelerator.
2785 * See AV_CODEC_ID_xxx
2790 * Supported pixel format.
2792 * Only hardware accelerated formats are supported here.
2794 enum AVPixelFormat pix_fmt;
2797 * Hardware accelerated codec capabilities.
2798 * see AV_HWACCEL_CODEC_CAP_*
2802 /*****************************************************************
2803 * No fields below this line are part of the public API. They
2804 * may not be used outside of libavcodec and can be changed and
2806 * New public fields should be added right above.
2807 *****************************************************************
2811 * Allocate a custom buffer
2813 int (*alloc_frame)(AVCodecContext *avctx, AVFrame *frame);
2816 * Called at the beginning of each frame or field picture.
2818 * Meaningful frame information (codec specific) is guaranteed to
2819 * be parsed at this point. This function is mandatory.
2821 * Note that buf can be NULL along with buf_size set to 0.
2822 * Otherwise, this means the whole frame is available at this point.
2824 * @param avctx the codec context
2825 * @param buf the frame data buffer base
2826 * @param buf_size the size of the frame in bytes
2827 * @return zero if successful, a negative value otherwise
2829 int (*start_frame)(AVCodecContext *avctx, const uint8_t *buf, uint32_t buf_size);
2832 * Callback for parameter data (SPS/PPS/VPS etc).
2834 * Useful for hardware decoders which keep persistent state about the
2835 * video parameters, and need to receive any changes to update that state.
2837 * @param avctx the codec context
2838 * @param type the nal unit type
2839 * @param buf the nal unit data buffer
2840 * @param buf_size the size of the nal unit in bytes
2841 * @return zero if successful, a negative value otherwise
2843 int (*decode_params)(AVCodecContext *avctx, int type, const uint8_t *buf, uint32_t buf_size);
2846 * Callback for each slice.
2848 * Meaningful slice information (codec specific) is guaranteed to
2849 * be parsed at this point. This function is mandatory.
2850 * The only exception is XvMC, that works on MB level.
2852 * @param avctx the codec context
2853 * @param buf the slice data buffer base
2854 * @param buf_size the size of the slice in bytes
2855 * @return zero if successful, a negative value otherwise
2857 int (*decode_slice)(AVCodecContext *avctx, const uint8_t *buf, uint32_t buf_size);
2860 * Called at the end of each frame or field picture.
2862 * The whole picture is parsed at this point and can now be sent
2863 * to the hardware accelerator. This function is mandatory.
2865 * @param avctx the codec context
2866 * @return zero if successful, a negative value otherwise
2868 int (*end_frame)(AVCodecContext *avctx);
2871 * Size of per-frame hardware accelerator private data.
2873 * Private data is allocated with av_mallocz() before
2874 * AVCodecContext.get_buffer() and deallocated after
2875 * AVCodecContext.release_buffer().
2877 int frame_priv_data_size;
2880 * Called for every Macroblock in a slice.
2882 * XvMC uses it to replace the ff_mpv_reconstruct_mb().
2883 * Instead of decoding to raw picture, MB parameters are
2884 * stored in an array provided by the video driver.
2886 * @param s the mpeg context
2888 void (*decode_mb)(struct MpegEncContext *s);
2891 * Initialize the hwaccel private data.
2893 * This will be called from ff_get_format(), after hwaccel and
2894 * hwaccel_context are set and the hwaccel private data in AVCodecInternal
2897 int (*init)(AVCodecContext *avctx);
2900 * Uninitialize the hwaccel private data.
2902 * This will be called from get_format() or avcodec_close(), after hwaccel
2903 * and hwaccel_context are already uninitialized.
2905 int (*uninit)(AVCodecContext *avctx);
2908 * Size of the private data to allocate in
2909 * AVCodecInternal.hwaccel_priv_data.
2914 * Internal hwaccel capabilities.
2919 * Fill the given hw_frames context with current codec parameters. Called
2920 * from get_format. Refer to avcodec_get_hw_frames_parameters() for
2923 * This CAN be called before AVHWAccel.init is called, and you must assume
2924 * that avctx->hwaccel_priv_data is invalid.
2926 int (*frame_params)(AVCodecContext *avctx, AVBufferRef *hw_frames_ctx);
2930 * HWAccel is experimental and is thus avoided in favor of non experimental
2933 #define AV_HWACCEL_CODEC_CAP_EXPERIMENTAL 0x0200
2936 * Hardware acceleration should be used for decoding even if the codec level
2937 * used is unknown or higher than the maximum supported level reported by the
2940 * It's generally a good idea to pass this flag unless you have a specific
2941 * reason not to, as hardware tends to under-report supported levels.
2943 #define AV_HWACCEL_FLAG_IGNORE_LEVEL (1 << 0)
2946 * Hardware acceleration can output YUV pixel formats with a different chroma
2947 * sampling than 4:2:0 and/or other than 8 bits per component.
2949 #define AV_HWACCEL_FLAG_ALLOW_HIGH_DEPTH (1 << 1)
2952 * Hardware acceleration should still be attempted for decoding when the
2953 * codec profile does not match the reported capabilities of the hardware.
2955 * For example, this can be used to try to decode baseline profile H.264
2956 * streams in hardware - it will often succeed, because many streams marked
2957 * as baseline profile actually conform to constrained baseline profile.
2959 * @warning If the stream is actually not supported then the behaviour is
2960 * undefined, and may include returning entirely incorrect output
2961 * while indicating success.
2963 #define AV_HWACCEL_FLAG_ALLOW_PROFILE_MISMATCH (1 << 2)
2969 #if FF_API_AVPICTURE
2971 * @defgroup lavc_picture AVPicture
2973 * Functions for working with AVPicture
2978 * Picture data structure.
2980 * Up to four components can be stored into it, the last component is
2982 * @deprecated use AVFrame or imgutils functions instead
2984 typedef struct AVPicture {
2985 attribute_deprecated
2986 uint8_t *data[AV_NUM_DATA_POINTERS]; ///< pointers to the image data planes
2987 attribute_deprecated
2988 int linesize[AV_NUM_DATA_POINTERS]; ///< number of bytes per line
2996 enum AVSubtitleType {
2999 SUBTITLE_BITMAP, ///< A bitmap, pict will be set
3002 * Plain text, the text field must be set by the decoder and is
3003 * authoritative. ass and pict fields may contain approximations.
3008 * Formatted text, the ass field must be set by the decoder and is
3009 * authoritative. pict and text fields may contain approximations.
3014 #define AV_SUBTITLE_FLAG_FORCED 0x00000001
3016 typedef struct AVSubtitleRect {
3017 int x; ///< top left corner of pict, undefined when pict is not set
3018 int y; ///< top left corner of pict, undefined when pict is not set
3019 int w; ///< width of pict, undefined when pict is not set
3020 int h; ///< height of pict, undefined when pict is not set
3021 int nb_colors; ///< number of colors in pict, undefined when pict is not set
3023 #if FF_API_AVPICTURE
3025 * @deprecated unused
3027 attribute_deprecated
3031 * data+linesize for the bitmap of this subtitle.
3032 * Can be set for text/ass as well once they are rendered.
3037 enum AVSubtitleType type;
3039 char *text; ///< 0 terminated plain UTF-8 text
3042 * 0 terminated ASS/SSA compatible event line.
3043 * The presentation of this is unaffected by the other values in this
3051 typedef struct AVSubtitle {
3052 uint16_t format; /* 0 = graphics */
3053 uint32_t start_display_time; /* relative to packet pts, in ms */
3054 uint32_t end_display_time; /* relative to packet pts, in ms */
3056 AVSubtitleRect **rects;
3057 int64_t pts; ///< Same as packet pts, in AV_TIME_BASE
3061 * Iterate over all registered codecs.
3063 * @param opaque a pointer where libavcodec will store the iteration state. Must
3064 * point to NULL to start the iteration.
3066 * @return the next registered codec or NULL when the iteration is
3069 const AVCodec *av_codec_iterate(void **opaque);
3073 * If c is NULL, returns the first registered codec,
3074 * if c is non-NULL, returns the next registered codec after c,
3075 * or NULL if c is the last one.
3077 attribute_deprecated
3078 AVCodec *av_codec_next(const AVCodec *c);
3082 * Return the LIBAVCODEC_VERSION_INT constant.
3084 unsigned avcodec_version(void);
3087 * Return the libavcodec build-time configuration.
3089 const char *avcodec_configuration(void);
3092 * Return the libavcodec license.
3094 const char *avcodec_license(void);
3098 * Register the codec codec and initialize libavcodec.
3100 * @warning either this function or avcodec_register_all() must be called
3101 * before any other libavcodec functions.
3103 * @see avcodec_register_all()
3105 attribute_deprecated
3106 void avcodec_register(AVCodec *codec);
3109 * Register all the codecs, parsers and bitstream filters which were enabled at
3110 * configuration time. If you do not call this function you can select exactly
3111 * which formats you want to support, by using the individual registration
3114 * @see avcodec_register
3115 * @see av_register_codec_parser
3116 * @see av_register_bitstream_filter
3118 attribute_deprecated
3119 void avcodec_register_all(void);
3123 * Allocate an AVCodecContext and set its fields to default values. The
3124 * resulting struct should be freed with avcodec_free_context().
3126 * @param codec if non-NULL, allocate private data and initialize defaults
3127 * for the given codec. It is illegal to then call avcodec_open2()
3128 * with a different codec.
3129 * If NULL, then the codec-specific defaults won't be initialized,
3130 * which may result in suboptimal default settings (this is
3131 * important mainly for encoders, e.g. libx264).
3133 * @return An AVCodecContext filled with default values or NULL on failure.
3135 AVCodecContext *avcodec_alloc_context3(const AVCodec *codec);
3138 * Free the codec context and everything associated with it and write NULL to
3139 * the provided pointer.
3141 void avcodec_free_context(AVCodecContext **avctx);
3143 #if FF_API_GET_CONTEXT_DEFAULTS
3145 * @deprecated This function should not be used, as closing and opening a codec
3146 * context multiple time is not supported. A new codec context should be
3147 * allocated for each new use.
3149 int avcodec_get_context_defaults3(AVCodecContext *s, const AVCodec *codec);
3153 * Get the AVClass for AVCodecContext. It can be used in combination with
3154 * AV_OPT_SEARCH_FAKE_OBJ for examining options.
3156 * @see av_opt_find().
3158 const AVClass *avcodec_get_class(void);
3160 #if FF_API_COPY_CONTEXT
3162 * Get the AVClass for AVFrame. It can be used in combination with
3163 * AV_OPT_SEARCH_FAKE_OBJ for examining options.
3165 * @see av_opt_find().
3167 const AVClass *avcodec_get_frame_class(void);
3170 * Get the AVClass for AVSubtitleRect. It can be used in combination with
3171 * AV_OPT_SEARCH_FAKE_OBJ for examining options.
3173 * @see av_opt_find().
3175 const AVClass *avcodec_get_subtitle_rect_class(void);
3178 * Copy the settings of the source AVCodecContext into the destination
3179 * AVCodecContext. The resulting destination codec context will be
3180 * unopened, i.e. you are required to call avcodec_open2() before you
3181 * can use this AVCodecContext to decode/encode video/audio data.
3183 * @param dest target codec context, should be initialized with
3184 * avcodec_alloc_context3(NULL), but otherwise uninitialized
3185 * @param src source codec context
3186 * @return AVERROR() on error (e.g. memory allocation error), 0 on success
3188 * @deprecated The semantics of this function are ill-defined and it should not
3189 * be used. If you need to transfer the stream parameters from one codec context
3190 * to another, use an intermediate AVCodecParameters instance and the
3191 * avcodec_parameters_from_context() / avcodec_parameters_to_context()
3194 attribute_deprecated
3195 int avcodec_copy_context(AVCodecContext *dest, const AVCodecContext *src);
3199 * Fill the parameters struct based on the values from the supplied codec
3200 * context. Any allocated fields in par are freed and replaced with duplicates
3201 * of the corresponding fields in codec.
3203 * @return >= 0 on success, a negative AVERROR code on failure
3205 int avcodec_parameters_from_context(AVCodecParameters *par,
3206 const AVCodecContext *codec);
3209 * Fill the codec context based on the values from the supplied codec
3210 * parameters. Any allocated fields in codec that have a corresponding field in
3211 * par are freed and replaced with duplicates of the corresponding field in par.
3212 * Fields in codec that do not have a counterpart in par are not touched.
3214 * @return >= 0 on success, a negative AVERROR code on failure.
3216 int avcodec_parameters_to_context(AVCodecContext *codec,
3217 const AVCodecParameters *par);
3220 * Initialize the AVCodecContext to use the given AVCodec. Prior to using this
3221 * function the context has to be allocated with avcodec_alloc_context3().
3223 * The functions avcodec_find_decoder_by_name(), avcodec_find_encoder_by_name(),
3224 * avcodec_find_decoder() and avcodec_find_encoder() provide an easy way for
3225 * retrieving a codec.
3227 * @warning This function is not thread safe!
3229 * @note Always call this function before using decoding routines (such as
3230 * @ref avcodec_receive_frame()).
3233 * avcodec_register_all();
3234 * av_dict_set(&opts, "b", "2.5M", 0);
3235 * codec = avcodec_find_decoder(AV_CODEC_ID_H264);
3239 * context = avcodec_alloc_context3(codec);
3241 * if (avcodec_open2(context, codec, opts) < 0)
3245 * @param avctx The context to initialize.
3246 * @param codec The codec to open this context for. If a non-NULL codec has been
3247 * previously passed to avcodec_alloc_context3() or
3248 * for this context, then this parameter MUST be either NULL or
3249 * equal to the previously passed codec.
3250 * @param options A dictionary filled with AVCodecContext and codec-private options.
3251 * On return this object will be filled with options that were not found.
3253 * @return zero on success, a negative value on error
3254 * @see avcodec_alloc_context3(), avcodec_find_decoder(), avcodec_find_encoder(),
3255 * av_dict_set(), av_opt_find().
3257 int avcodec_open2(AVCodecContext *avctx, const AVCodec *codec, AVDictionary **options);
3260 * Close a given AVCodecContext and free all the data associated with it
3261 * (but not the AVCodecContext itself).
3263 * Calling this function on an AVCodecContext that hasn't been opened will free
3264 * the codec-specific data allocated in avcodec_alloc_context3() with a non-NULL
3265 * codec. Subsequent calls will do nothing.
3267 * @note Do not use this function. Use avcodec_free_context() to destroy a
3268 * codec context (either open or closed). Opening and closing a codec context
3269 * multiple times is not supported anymore -- use multiple codec contexts
3272 int avcodec_close(AVCodecContext *avctx);
3275 * Free all allocated data in the given subtitle struct.
3277 * @param sub AVSubtitle to free.
3279 void avsubtitle_free(AVSubtitle *sub);
3286 * @addtogroup lavc_decoding
3291 * Find a registered decoder with a matching codec ID.
3293 * @param id AVCodecID of the requested decoder
3294 * @return A decoder if one was found, NULL otherwise.
3296 AVCodec *avcodec_find_decoder(enum AVCodecID id);
3299 * Find a registered decoder with the specified name.
3301 * @param name name of the requested decoder
3302 * @return A decoder if one was found, NULL otherwise.
3304 AVCodec *avcodec_find_decoder_by_name(const char *name);
3307 * The default callback for AVCodecContext.get_buffer2(). It is made public so
3308 * it can be called by custom get_buffer2() implementations for decoders without
3309 * AV_CODEC_CAP_DR1 set.
3311 int avcodec_default_get_buffer2(AVCodecContext *s, AVFrame *frame, int flags);
3314 * Modify width and height values so that they will result in a memory
3315 * buffer that is acceptable for the codec if you do not use any horizontal
3318 * May only be used if a codec with AV_CODEC_CAP_DR1 has been opened.
3320 void avcodec_align_dimensions(AVCodecContext *s, int *width, int *height);
3323 * Modify width and height values so that they will result in a memory
3324 * buffer that is acceptable for the codec if you also ensure that all
3325 * line sizes are a multiple of the respective linesize_align[i].
3327 * May only be used if a codec with AV_CODEC_CAP_DR1 has been opened.
3329 void avcodec_align_dimensions2(AVCodecContext *s, int *width, int *height,
3330 int linesize_align[AV_NUM_DATA_POINTERS]);
3333 * Converts AVChromaLocation to swscale x/y chroma position.
3335 * The positions represent the chroma (0,0) position in a coordinates system
3336 * with luma (0,0) representing the origin and luma(1,1) representing 256,256
3338 * @param xpos horizontal chroma sample position
3339 * @param ypos vertical chroma sample position
3341 int avcodec_enum_to_chroma_pos(int *xpos, int *ypos, enum AVChromaLocation pos);
3344 * Converts swscale x/y chroma position to AVChromaLocation.
3346 * The positions represent the chroma (0,0) position in a coordinates system
3347 * with luma (0,0) representing the origin and luma(1,1) representing 256,256
3349 * @param xpos horizontal chroma sample position
3350 * @param ypos vertical chroma sample position
3352 enum AVChromaLocation avcodec_chroma_pos_to_enum(int xpos, int ypos);
3355 * Decode the audio frame of size avpkt->size from avpkt->data into frame.
3357 * Some decoders may support multiple frames in a single AVPacket. Such
3358 * decoders would then just decode the first frame and the return value would be
3359 * less than the packet size. In this case, avcodec_decode_audio4 has to be
3360 * called again with an AVPacket containing the remaining data in order to
3361 * decode the second frame, etc... Even if no frames are returned, the packet
3362 * needs to be fed to the decoder with remaining data until it is completely
3363 * consumed or an error occurs.
3365 * Some decoders (those marked with AV_CODEC_CAP_DELAY) have a delay between input
3366 * and output. This means that for some packets they will not immediately
3367 * produce decoded output and need to be flushed at the end of decoding to get
3368 * all the decoded data. Flushing is done by calling this function with packets
3369 * with avpkt->data set to NULL and avpkt->size set to 0 until it stops
3370 * returning samples. It is safe to flush even those decoders that are not
3371 * marked with AV_CODEC_CAP_DELAY, then no samples will be returned.
3373 * @warning The input buffer, avpkt->data must be AV_INPUT_BUFFER_PADDING_SIZE
3374 * larger than the actual read bytes because some optimized bitstream
3375 * readers read 32 or 64 bits at once and could read over the end.
3377 * @note The AVCodecContext MUST have been opened with @ref avcodec_open2()
3378 * before packets may be fed to the decoder.
3380 * @param avctx the codec context
3381 * @param[out] frame The AVFrame in which to store decoded audio samples.
3382 * The decoder will allocate a buffer for the decoded frame by
3383 * calling the AVCodecContext.get_buffer2() callback.
3384 * When AVCodecContext.refcounted_frames is set to 1, the frame is
3385 * reference counted and the returned reference belongs to the
3386 * caller. The caller must release the frame using av_frame_unref()
3387 * when the frame is no longer needed. The caller may safely write
3388 * to the frame if av_frame_is_writable() returns 1.
3389 * When AVCodecContext.refcounted_frames is set to 0, the returned
3390 * reference belongs to the decoder and is valid only until the
3391 * next call to this function or until closing or flushing the
3392 * decoder. The caller may not write to it.
3393 * @param[out] got_frame_ptr Zero if no frame could be decoded, otherwise it is
3394 * non-zero. Note that this field being set to zero
3395 * does not mean that an error has occurred. For
3396 * decoders with AV_CODEC_CAP_DELAY set, no given decode
3397 * call is guaranteed to produce a frame.
3398 * @param[in] avpkt The input AVPacket containing the input buffer.
3399 * At least avpkt->data and avpkt->size should be set. Some
3400 * decoders might also require additional fields to be set.
3401 * @return A negative error code is returned if an error occurred during
3402 * decoding, otherwise the number of bytes consumed from the input
3403 * AVPacket is returned.
3405 * @deprecated Use avcodec_send_packet() and avcodec_receive_frame().
3407 attribute_deprecated
3408 int avcodec_decode_audio4(AVCodecContext *avctx, AVFrame *frame,
3409 int *got_frame_ptr, const AVPacket *avpkt);
3412 * Decode the video frame of size avpkt->size from avpkt->data into picture.
3413 * Some decoders may support multiple frames in a single AVPacket, such
3414 * decoders would then just decode the first frame.
3416 * @warning The input buffer must be AV_INPUT_BUFFER_PADDING_SIZE larger than
3417 * the actual read bytes because some optimized bitstream readers read 32 or 64
3418 * bits at once and could read over the end.
3420 * @warning The end of the input buffer buf should be set to 0 to ensure that
3421 * no overreading happens for damaged MPEG streams.
3423 * @note Codecs which have the AV_CODEC_CAP_DELAY capability set have a delay
3424 * between input and output, these need to be fed with avpkt->data=NULL,
3425 * avpkt->size=0 at the end to return the remaining frames.
3427 * @note The AVCodecContext MUST have been opened with @ref avcodec_open2()
3428 * before packets may be fed to the decoder.
3430 * @param avctx the codec context
3431 * @param[out] picture The AVFrame in which the decoded video frame will be stored.
3432 * Use av_frame_alloc() to get an AVFrame. The codec will
3433 * allocate memory for the actual bitmap by calling the
3434 * AVCodecContext.get_buffer2() callback.
3435 * When AVCodecContext.refcounted_frames is set to 1, the frame is
3436 * reference counted and the returned reference belongs to the
3437 * caller. The caller must release the frame using av_frame_unref()
3438 * when the frame is no longer needed. The caller may safely write
3439 * to the frame if av_frame_is_writable() returns 1.
3440 * When AVCodecContext.refcounted_frames is set to 0, the returned
3441 * reference belongs to the decoder and is valid only until the
3442 * next call to this function or until closing or flushing the
3443 * decoder. The caller may not write to it.
3445 * @param[in] avpkt The input AVPacket containing the input buffer.
3446 * You can create such packet with av_init_packet() and by then setting
3447 * data and size, some decoders might in addition need other fields like
3448 * flags&AV_PKT_FLAG_KEY. All decoders are designed to use the least
3450 * @param[in,out] got_picture_ptr Zero if no frame could be decompressed, otherwise, it is nonzero.
3451 * @return On error a negative value is returned, otherwise the number of bytes
3452 * used or zero if no frame could be decompressed.
3454 * @deprecated Use avcodec_send_packet() and avcodec_receive_frame().
3456 attribute_deprecated
3457 int avcodec_decode_video2(AVCodecContext *avctx, AVFrame *picture,
3458 int *got_picture_ptr,
3459 const AVPacket *avpkt);
3462 * Decode a subtitle message.
3463 * Return a negative value on error, otherwise return the number of bytes used.
3464 * If no subtitle could be decompressed, got_sub_ptr is zero.
3465 * Otherwise, the subtitle is stored in *sub.
3466 * Note that AV_CODEC_CAP_DR1 is not available for subtitle codecs. This is for
3467 * simplicity, because the performance difference is expected to be negligible
3468 * and reusing a get_buffer written for video codecs would probably perform badly
3469 * due to a potentially very different allocation pattern.
3471 * Some decoders (those marked with AV_CODEC_CAP_DELAY) have a delay between input
3472 * and output. This means that for some packets they will not immediately
3473 * produce decoded output and need to be flushed at the end of decoding to get
3474 * all the decoded data. Flushing is done by calling this function with packets
3475 * with avpkt->data set to NULL and avpkt->size set to 0 until it stops
3476 * returning subtitles. It is safe to flush even those decoders that are not
3477 * marked with AV_CODEC_CAP_DELAY, then no subtitles will be returned.
3479 * @note The AVCodecContext MUST have been opened with @ref avcodec_open2()
3480 * before packets may be fed to the decoder.
3482 * @param avctx the codec context
3483 * @param[out] sub The preallocated AVSubtitle in which the decoded subtitle will be stored,
3484 * must be freed with avsubtitle_free if *got_sub_ptr is set.
3485 * @param[in,out] got_sub_ptr Zero if no subtitle could be decompressed, otherwise, it is nonzero.
3486 * @param[in] avpkt The input AVPacket containing the input buffer.
3488 int avcodec_decode_subtitle2(AVCodecContext *avctx, AVSubtitle *sub,
3493 * Supply raw packet data as input to a decoder.
3495 * Internally, this call will copy relevant AVCodecContext fields, which can
3496 * influence decoding per-packet, and apply them when the packet is actually
3497 * decoded. (For example AVCodecContext.skip_frame, which might direct the
3498 * decoder to drop the frame contained by the packet sent with this function.)
3500 * @warning The input buffer, avpkt->data must be AV_INPUT_BUFFER_PADDING_SIZE
3501 * larger than the actual read bytes because some optimized bitstream
3502 * readers read 32 or 64 bits at once and could read over the end.
3504 * @warning Do not mix this API with the legacy API (like avcodec_decode_video2())
3505 * on the same AVCodecContext. It will return unexpected results now
3506 * or in future libavcodec versions.
3508 * @note The AVCodecContext MUST have been opened with @ref avcodec_open2()
3509 * before packets may be fed to the decoder.
3511 * @param avctx codec context
3512 * @param[in] avpkt The input AVPacket. Usually, this will be a single video
3513 * frame, or several complete audio frames.
3514 * Ownership of the packet remains with the caller, and the
3515 * decoder will not write to the packet. The decoder may create
3516 * a reference to the packet data (or copy it if the packet is
3517 * not reference-counted).
3518 * Unlike with older APIs, the packet is always fully consumed,
3519 * and if it contains multiple frames (e.g. some audio codecs),
3520 * will require you to call avcodec_receive_frame() multiple
3521 * times afterwards before you can send a new packet.
3522 * It can be NULL (or an AVPacket with data set to NULL and
3523 * size set to 0); in this case, it is considered a flush
3524 * packet, which signals the end of the stream. Sending the
3525 * first flush packet will return success. Subsequent ones are
3526 * unnecessary and will return AVERROR_EOF. If the decoder
3527 * still has frames buffered, it will return them after sending
3530 * @return 0 on success, otherwise negative error code:
3531 * AVERROR(EAGAIN): input is not accepted in the current state - user
3532 * must read output with avcodec_receive_frame() (once
3533 * all output is read, the packet should be resent, and
3534 * the call will not fail with EAGAIN).
3535 * AVERROR_EOF: the decoder has been flushed, and no new packets can
3536 * be sent to it (also returned if more than 1 flush
3538 * AVERROR(EINVAL): codec not opened, it is an encoder, or requires flush
3539 * AVERROR(ENOMEM): failed to add packet to internal queue, or similar
3540 * other errors: legitimate decoding errors
3542 int avcodec_send_packet(AVCodecContext *avctx, const AVPacket *avpkt);
3545 * Return decoded output data from a decoder.
3547 * @param avctx codec context
3548 * @param frame This will be set to a reference-counted video or audio
3549 * frame (depending on the decoder type) allocated by the
3550 * decoder. Note that the function will always call
3551 * av_frame_unref(frame) before doing anything else.
3554 * 0: success, a frame was returned
3555 * AVERROR(EAGAIN): output is not available in this state - user must try
3557 * AVERROR_EOF: the decoder has been fully flushed, and there will be
3558 * no more output frames
3559 * AVERROR(EINVAL): codec not opened, or it is an encoder
3560 * AVERROR_INPUT_CHANGED: current decoded frame has changed parameters
3561 * with respect to first decoded frame. Applicable
3562 * when flag AV_CODEC_FLAG_DROPCHANGED is set.
3563 * other negative values: legitimate decoding errors
3565 int avcodec_receive_frame(AVCodecContext *avctx, AVFrame *frame);
3568 * Supply a raw video or audio frame to the encoder. Use avcodec_receive_packet()
3569 * to retrieve buffered output packets.
3571 * @param avctx codec context
3572 * @param[in] frame AVFrame containing the raw audio or video frame to be encoded.
3573 * Ownership of the frame remains with the caller, and the
3574 * encoder will not write to the frame. The encoder may create
3575 * a reference to the frame data (or copy it if the frame is
3576 * not reference-counted).
3577 * It can be NULL, in which case it is considered a flush
3578 * packet. This signals the end of the stream. If the encoder
3579 * still has packets buffered, it will return them after this
3580 * call. Once flushing mode has been entered, additional flush
3581 * packets are ignored, and sending frames will return
3585 * If AV_CODEC_CAP_VARIABLE_FRAME_SIZE is set, then each frame
3586 * can have any number of samples.
3587 * If it is not set, frame->nb_samples must be equal to
3588 * avctx->frame_size for all frames except the last.
3589 * The final frame may be smaller than avctx->frame_size.
3590 * @return 0 on success, otherwise negative error code:
3591 * AVERROR(EAGAIN): input is not accepted in the current state - user
3592 * must read output with avcodec_receive_packet() (once
3593 * all output is read, the packet should be resent, and
3594 * the call will not fail with EAGAIN).
3595 * AVERROR_EOF: the encoder has been flushed, and no new frames can
3597 * AVERROR(EINVAL): codec not opened, refcounted_frames not set, it is a
3598 * decoder, or requires flush
3599 * AVERROR(ENOMEM): failed to add packet to internal queue, or similar
3600 * other errors: legitimate encoding errors
3602 int avcodec_send_frame(AVCodecContext *avctx, const AVFrame *frame);
3605 * Read encoded data from the encoder.
3607 * @param avctx codec context
3608 * @param avpkt This will be set to a reference-counted packet allocated by the
3609 * encoder. Note that the function will always call
3610 * av_packet_unref(avpkt) before doing anything else.
3611 * @return 0 on success, otherwise negative error code:
3612 * AVERROR(EAGAIN): output is not available in the current state - user
3613 * must try to send input
3614 * AVERROR_EOF: the encoder has been fully flushed, and there will be
3615 * no more output packets
3616 * AVERROR(EINVAL): codec not opened, or it is a decoder
3617 * other errors: legitimate encoding errors
3619 int avcodec_receive_packet(AVCodecContext *avctx, AVPacket *avpkt);
3622 * Create and return a AVHWFramesContext with values adequate for hardware
3623 * decoding. This is meant to get called from the get_format callback, and is
3624 * a helper for preparing a AVHWFramesContext for AVCodecContext.hw_frames_ctx.
3625 * This API is for decoding with certain hardware acceleration modes/APIs only.
3627 * The returned AVHWFramesContext is not initialized. The caller must do this
3628 * with av_hwframe_ctx_init().
3630 * Calling this function is not a requirement, but makes it simpler to avoid
3631 * codec or hardware API specific details when manually allocating frames.
3633 * Alternatively to this, an API user can set AVCodecContext.hw_device_ctx,
3634 * which sets up AVCodecContext.hw_frames_ctx fully automatically, and makes
3635 * it unnecessary to call this function or having to care about
3636 * AVHWFramesContext initialization at all.
3638 * There are a number of requirements for calling this function:
3640 * - It must be called from get_format with the same avctx parameter that was
3641 * passed to get_format. Calling it outside of get_format is not allowed, and
3642 * can trigger undefined behavior.
3643 * - The function is not always supported (see description of return values).
3644 * Even if this function returns successfully, hwaccel initialization could
3645 * fail later. (The degree to which implementations check whether the stream
3646 * is actually supported varies. Some do this check only after the user's
3647 * get_format callback returns.)
3648 * - The hw_pix_fmt must be one of the choices suggested by get_format. If the
3649 * user decides to use a AVHWFramesContext prepared with this API function,
3650 * the user must return the same hw_pix_fmt from get_format.
3651 * - The device_ref passed to this function must support the given hw_pix_fmt.
3652 * - After calling this API function, it is the user's responsibility to
3653 * initialize the AVHWFramesContext (returned by the out_frames_ref parameter),
3654 * and to set AVCodecContext.hw_frames_ctx to it. If done, this must be done
3655 * before returning from get_format (this is implied by the normal
3656 * AVCodecContext.hw_frames_ctx API rules).
3657 * - The AVHWFramesContext parameters may change every time time get_format is
3658 * called. Also, AVCodecContext.hw_frames_ctx is reset before get_format. So
3659 * you are inherently required to go through this process again on every
3661 * - It is perfectly possible to call this function without actually using
3662 * the resulting AVHWFramesContext. One use-case might be trying to reuse a
3663 * previously initialized AVHWFramesContext, and calling this API function
3664 * only to test whether the required frame parameters have changed.
3665 * - Fields that use dynamically allocated values of any kind must not be set
3666 * by the user unless setting them is explicitly allowed by the documentation.
3667 * If the user sets AVHWFramesContext.free and AVHWFramesContext.user_opaque,
3668 * the new free callback must call the potentially set previous free callback.
3669 * This API call may set any dynamically allocated fields, including the free
3672 * The function will set at least the following fields on AVHWFramesContext
3673 * (potentially more, depending on hwaccel API):
3675 * - All fields set by av_hwframe_ctx_alloc().
3676 * - Set the format field to hw_pix_fmt.
3677 * - Set the sw_format field to the most suited and most versatile format. (An
3678 * implication is that this will prefer generic formats over opaque formats
3679 * with arbitrary restrictions, if possible.)
3680 * - Set the width/height fields to the coded frame size, rounded up to the
3681 * API-specific minimum alignment.
3682 * - Only _if_ the hwaccel requires a pre-allocated pool: set the initial_pool_size
3683 * field to the number of maximum reference surfaces possible with the codec,
3684 * plus 1 surface for the user to work (meaning the user can safely reference
3685 * at most 1 decoded surface at a time), plus additional buffering introduced
3686 * by frame threading. If the hwaccel does not require pre-allocation, the
3687 * field is left to 0, and the decoder will allocate new surfaces on demand
3689 * - Possibly AVHWFramesContext.hwctx fields, depending on the underlying
3692 * Essentially, out_frames_ref returns the same as av_hwframe_ctx_alloc(), but
3693 * with basic frame parameters set.
3695 * The function is stateless, and does not change the AVCodecContext or the
3696 * device_ref AVHWDeviceContext.
3698 * @param avctx The context which is currently calling get_format, and which
3699 * implicitly contains all state needed for filling the returned
3700 * AVHWFramesContext properly.
3701 * @param device_ref A reference to the AVHWDeviceContext describing the device
3702 * which will be used by the hardware decoder.
3703 * @param hw_pix_fmt The hwaccel format you are going to return from get_format.
3704 * @param out_frames_ref On success, set to a reference to an _uninitialized_
3705 * AVHWFramesContext, created from the given device_ref.
3706 * Fields will be set to values required for decoding.
3707 * Not changed if an error is returned.
3708 * @return zero on success, a negative value on error. The following error codes
3709 * have special semantics:
3710 * AVERROR(ENOENT): the decoder does not support this functionality. Setup
3711 * is always manual, or it is a decoder which does not
3712 * support setting AVCodecContext.hw_frames_ctx at all,
3713 * or it is a software format.
3714 * AVERROR(EINVAL): it is known that hardware decoding is not supported for
3715 * this configuration, or the device_ref is not supported
3716 * for the hwaccel referenced by hw_pix_fmt.
3718 int avcodec_get_hw_frames_parameters(AVCodecContext *avctx,
3719 AVBufferRef *device_ref,
3720 enum AVPixelFormat hw_pix_fmt,
3721 AVBufferRef **out_frames_ref);
3726 * @defgroup lavc_parsing Frame parsing
3730 enum AVPictureStructure {
3731 AV_PICTURE_STRUCTURE_UNKNOWN, //< unknown
3732 AV_PICTURE_STRUCTURE_TOP_FIELD, //< coded as top field
3733 AV_PICTURE_STRUCTURE_BOTTOM_FIELD, //< coded as bottom field
3734 AV_PICTURE_STRUCTURE_FRAME, //< coded as frame
3737 typedef struct AVCodecParserContext {
3739 struct AVCodecParser *parser;
3740 int64_t frame_offset; /* offset of the current frame */
3741 int64_t cur_offset; /* current offset
3742 (incremented by each av_parser_parse()) */
3743 int64_t next_frame_offset; /* offset of the next frame */
3745 int pict_type; /* XXX: Put it back in AVCodecContext. */
3747 * This field is used for proper frame duration computation in lavf.
3748 * It signals, how much longer the frame duration of the current frame
3749 * is compared to normal frame duration.
3751 * frame_duration = (1 + repeat_pict) * time_base
3753 * It is used by codecs like H.264 to display telecined material.
3755 int repeat_pict; /* XXX: Put it back in AVCodecContext. */
3756 int64_t pts; /* pts of the current frame */
3757 int64_t dts; /* dts of the current frame */
3762 int fetch_timestamp;
3764 #define AV_PARSER_PTS_NB 4
3765 int cur_frame_start_index;
3766 int64_t cur_frame_offset[AV_PARSER_PTS_NB];
3767 int64_t cur_frame_pts[AV_PARSER_PTS_NB];
3768 int64_t cur_frame_dts[AV_PARSER_PTS_NB];
3771 #define PARSER_FLAG_COMPLETE_FRAMES 0x0001
3772 #define PARSER_FLAG_ONCE 0x0002
3773 /// Set if the parser has a valid file offset
3774 #define PARSER_FLAG_FETCHED_OFFSET 0x0004
3775 #define PARSER_FLAG_USE_CODEC_TS 0x1000
3777 int64_t offset; ///< byte offset from starting packet start
3778 int64_t cur_frame_end[AV_PARSER_PTS_NB];
3781 * Set by parser to 1 for key frames and 0 for non-key frames.
3782 * It is initialized to -1, so if the parser doesn't set this flag,
3783 * old-style fallback using AV_PICTURE_TYPE_I picture type as key frames
3788 #if FF_API_CONVERGENCE_DURATION
3790 * @deprecated unused
3792 attribute_deprecated
3793 int64_t convergence_duration;
3796 // Timestamp generation support:
3798 * Synchronization point for start of timestamp generation.
3800 * Set to >0 for sync point, 0 for no sync point and <0 for undefined
3803 * For example, this corresponds to presence of H.264 buffering period
3809 * Offset of the current timestamp against last timestamp sync point in
3810 * units of AVCodecContext.time_base.
3812 * Set to INT_MIN when dts_sync_point unused. Otherwise, it must
3813 * contain a valid timestamp offset.
3815 * Note that the timestamp of sync point has usually a nonzero
3816 * dts_ref_dts_delta, which refers to the previous sync point. Offset of
3817 * the next frame after timestamp sync point will be usually 1.
3819 * For example, this corresponds to H.264 cpb_removal_delay.
3821 int dts_ref_dts_delta;
3824 * Presentation delay of current frame in units of AVCodecContext.time_base.
3826 * Set to INT_MIN when dts_sync_point unused. Otherwise, it must
3827 * contain valid non-negative timestamp delta (presentation time of a frame
3828 * must not lie in the past).
3830 * This delay represents the difference between decoding and presentation
3831 * time of the frame.
3833 * For example, this corresponds to H.264 dpb_output_delay.
3838 * Position of the packet in file.
3840 * Analogous to cur_frame_pts/dts
3842 int64_t cur_frame_pos[AV_PARSER_PTS_NB];
3845 * Byte position of currently parsed frame in stream.
3850 * Previous frame byte position.
3855 * Duration of the current frame.
3856 * For audio, this is in units of 1 / AVCodecContext.sample_rate.
3857 * For all other types, this is in units of AVCodecContext.time_base.
3861 enum AVFieldOrder field_order;
3864 * Indicate whether a picture is coded as a frame, top field or bottom field.
3866 * For example, H.264 field_pic_flag equal to 0 corresponds to
3867 * AV_PICTURE_STRUCTURE_FRAME. An H.264 picture with field_pic_flag
3868 * equal to 1 and bottom_field_flag equal to 0 corresponds to
3869 * AV_PICTURE_STRUCTURE_TOP_FIELD.
3871 enum AVPictureStructure picture_structure;
3874 * Picture number incremented in presentation or output order.
3875 * This field may be reinitialized at the first picture of a new sequence.
3877 * For example, this corresponds to H.264 PicOrderCnt.
3879 int output_picture_number;
3882 * Dimensions of the decoded video intended for presentation.
3888 * Dimensions of the coded video.
3894 * The format of the coded data, corresponds to enum AVPixelFormat for video
3895 * and for enum AVSampleFormat for audio.
3897 * Note that a decoder can have considerable freedom in how exactly it
3898 * decodes the data, so the format reported here might be different from the
3899 * one returned by a decoder.
3902 } AVCodecParserContext;
3904 typedef struct AVCodecParser {
3905 int codec_ids[5]; /* several codec IDs are permitted */
3907 int (*parser_init)(AVCodecParserContext *s);
3908 /* This callback never returns an error, a negative value means that
3909 * the frame start was in a previous packet. */
3910 int (*parser_parse)(AVCodecParserContext *s,
3911 AVCodecContext *avctx,
3912 const uint8_t **poutbuf, int *poutbuf_size,
3913 const uint8_t *buf, int buf_size);
3914 void (*parser_close)(AVCodecParserContext *s);
3915 int (*split)(AVCodecContext *avctx, const uint8_t *buf, int buf_size);
3916 struct AVCodecParser *next;
3920 * Iterate over all registered codec parsers.
3922 * @param opaque a pointer where libavcodec will store the iteration state. Must
3923 * point to NULL to start the iteration.
3925 * @return the next registered codec parser or NULL when the iteration is
3928 const AVCodecParser *av_parser_iterate(void **opaque);
3930 attribute_deprecated
3931 AVCodecParser *av_parser_next(const AVCodecParser *c);
3933 attribute_deprecated
3934 void av_register_codec_parser(AVCodecParser *parser);
3935 AVCodecParserContext *av_parser_init(int codec_id);
3940 * @param s parser context.
3941 * @param avctx codec context.
3942 * @param poutbuf set to pointer to parsed buffer or NULL if not yet finished.
3943 * @param poutbuf_size set to size of parsed buffer or zero if not yet finished.
3944 * @param buf input buffer.
3945 * @param buf_size buffer size in bytes without the padding. I.e. the full buffer
3946 size is assumed to be buf_size + AV_INPUT_BUFFER_PADDING_SIZE.
3947 To signal EOF, this should be 0 (so that the last frame
3949 * @param pts input presentation timestamp.
3950 * @param dts input decoding timestamp.
3951 * @param pos input byte position in stream.
3952 * @return the number of bytes of the input bitstream used.
3957 * len = av_parser_parse2(myparser, AVCodecContext, &data, &size,
3964 * decode_frame(data, size);
3968 int av_parser_parse2(AVCodecParserContext *s,
3969 AVCodecContext *avctx,
3970 uint8_t **poutbuf, int *poutbuf_size,
3971 const uint8_t *buf, int buf_size,
3972 int64_t pts, int64_t dts,
3976 * @return 0 if the output buffer is a subset of the input, 1 if it is allocated and must be freed
3977 * @deprecated use AVBitStreamFilter
3979 int av_parser_change(AVCodecParserContext *s,
3980 AVCodecContext *avctx,
3981 uint8_t **poutbuf, int *poutbuf_size,
3982 const uint8_t *buf, int buf_size, int keyframe);
3983 void av_parser_close(AVCodecParserContext *s);
3991 * @addtogroup lavc_encoding
3996 * Find a registered encoder with a matching codec ID.
3998 * @param id AVCodecID of the requested encoder
3999 * @return An encoder if one was found, NULL otherwise.
4001 AVCodec *avcodec_find_encoder(enum AVCodecID id);
4004 * Find a registered encoder with the specified name.
4006 * @param name name of the requested encoder
4007 * @return An encoder if one was found, NULL otherwise.
4009 AVCodec *avcodec_find_encoder_by_name(const char *name);
4012 * Encode a frame of audio.
4014 * Takes input samples from frame and writes the next output packet, if
4015 * available, to avpkt. The output packet does not necessarily contain data for
4016 * the most recent frame, as encoders can delay, split, and combine input frames
4017 * internally as needed.
4019 * @param avctx codec context
4020 * @param avpkt output AVPacket.
4021 * The user can supply an output buffer by setting
4022 * avpkt->data and avpkt->size prior to calling the
4023 * function, but if the size of the user-provided data is not
4024 * large enough, encoding will fail. If avpkt->data and
4025 * avpkt->size are set, avpkt->destruct must also be set. All
4026 * other AVPacket fields will be reset by the encoder using
4027 * av_init_packet(). If avpkt->data is NULL, the encoder will
4028 * allocate it. The encoder will set avpkt->size to the size
4029 * of the output packet.
4031 * If this function fails or produces no output, avpkt will be
4032 * freed using av_packet_unref().
4033 * @param[in] frame AVFrame containing the raw audio data to be encoded.
4034 * May be NULL when flushing an encoder that has the
4035 * AV_CODEC_CAP_DELAY capability set.
4036 * If AV_CODEC_CAP_VARIABLE_FRAME_SIZE is set, then each frame
4037 * can have any number of samples.
4038 * If it is not set, frame->nb_samples must be equal to
4039 * avctx->frame_size for all frames except the last.
4040 * The final frame may be smaller than avctx->frame_size.
4041 * @param[out] got_packet_ptr This field is set to 1 by libavcodec if the
4042 * output packet is non-empty, and to 0 if it is
4043 * empty. If the function returns an error, the
4044 * packet can be assumed to be invalid, and the
4045 * value of got_packet_ptr is undefined and should
4047 * @return 0 on success, negative error code on failure
4049 * @deprecated use avcodec_send_frame()/avcodec_receive_packet() instead
4051 attribute_deprecated
4052 int avcodec_encode_audio2(AVCodecContext *avctx, AVPacket *avpkt,
4053 const AVFrame *frame, int *got_packet_ptr);
4056 * Encode a frame of video.
4058 * Takes input raw video data from frame and writes the next output packet, if
4059 * available, to avpkt. The output packet does not necessarily contain data for
4060 * the most recent frame, as encoders can delay and reorder input frames
4061 * internally as needed.
4063 * @param avctx codec context
4064 * @param avpkt output AVPacket.
4065 * The user can supply an output buffer by setting
4066 * avpkt->data and avpkt->size prior to calling the
4067 * function, but if the size of the user-provided data is not
4068 * large enough, encoding will fail. All other AVPacket fields
4069 * will be reset by the encoder using av_init_packet(). If
4070 * avpkt->data is NULL, the encoder will allocate it.
4071 * The encoder will set avpkt->size to the size of the
4072 * output packet. The returned data (if any) belongs to the
4073 * caller, he is responsible for freeing it.
4075 * If this function fails or produces no output, avpkt will be
4076 * freed using av_packet_unref().
4077 * @param[in] frame AVFrame containing the raw video data to be encoded.
4078 * May be NULL when flushing an encoder that has the
4079 * AV_CODEC_CAP_DELAY capability set.
4080 * @param[out] got_packet_ptr This field is set to 1 by libavcodec if the
4081 * output packet is non-empty, and to 0 if it is
4082 * empty. If the function returns an error, the
4083 * packet can be assumed to be invalid, and the
4084 * value of got_packet_ptr is undefined and should
4086 * @return 0 on success, negative error code on failure
4088 * @deprecated use avcodec_send_frame()/avcodec_receive_packet() instead
4090 attribute_deprecated
4091 int avcodec_encode_video2(AVCodecContext *avctx, AVPacket *avpkt,
4092 const AVFrame *frame, int *got_packet_ptr);
4094 int avcodec_encode_subtitle(AVCodecContext *avctx, uint8_t *buf, int buf_size,
4095 const AVSubtitle *sub);
4102 #if FF_API_AVPICTURE
4104 * @addtogroup lavc_picture
4109 * @deprecated unused
4111 attribute_deprecated
4112 int avpicture_alloc(AVPicture *picture, enum AVPixelFormat pix_fmt, int width, int height);
4115 * @deprecated unused
4117 attribute_deprecated
4118 void avpicture_free(AVPicture *picture);
4121 * @deprecated use av_image_fill_arrays() instead.
4123 attribute_deprecated
4124 int avpicture_fill(AVPicture *picture, const uint8_t *ptr,
4125 enum AVPixelFormat pix_fmt, int width, int height);
4128 * @deprecated use av_image_copy_to_buffer() instead.
4130 attribute_deprecated
4131 int avpicture_layout(const AVPicture *src, enum AVPixelFormat pix_fmt,
4132 int width, int height,
4133 unsigned char *dest, int dest_size);
4136 * @deprecated use av_image_get_buffer_size() instead.
4138 attribute_deprecated
4139 int avpicture_get_size(enum AVPixelFormat pix_fmt, int width, int height);
4142 * @deprecated av_image_copy() instead.
4144 attribute_deprecated
4145 void av_picture_copy(AVPicture *dst, const AVPicture *src,
4146 enum AVPixelFormat pix_fmt, int width, int height);
4149 * @deprecated unused
4151 attribute_deprecated
4152 int av_picture_crop(AVPicture *dst, const AVPicture *src,
4153 enum AVPixelFormat pix_fmt, int top_band, int left_band);
4156 * @deprecated unused
4158 attribute_deprecated
4159 int av_picture_pad(AVPicture *dst, const AVPicture *src, int height, int width, enum AVPixelFormat pix_fmt,
4160 int padtop, int padbottom, int padleft, int padright, int *color);
4168 * @defgroup lavc_misc Utility functions
4171 * Miscellaneous utility functions related to both encoding and decoding
4177 * @defgroup lavc_misc_pixfmt Pixel formats
4179 * Functions for working with pixel formats.
4183 #if FF_API_GETCHROMA
4185 * @deprecated Use av_pix_fmt_get_chroma_sub_sample
4188 attribute_deprecated
4189 void avcodec_get_chroma_sub_sample(enum AVPixelFormat pix_fmt, int *h_shift, int *v_shift);
4193 * Return a value representing the fourCC code associated to the
4194 * pixel format pix_fmt, or 0 if no associated fourCC code can be
4197 unsigned int avcodec_pix_fmt_to_codec_tag(enum AVPixelFormat pix_fmt);
4200 * @deprecated see av_get_pix_fmt_loss()
4202 int avcodec_get_pix_fmt_loss(enum AVPixelFormat dst_pix_fmt, enum AVPixelFormat src_pix_fmt,
4206 * Find the best pixel format to convert to given a certain source pixel
4207 * format. When converting from one pixel format to another, information loss
4208 * may occur. For example, when converting from RGB24 to GRAY, the color
4209 * information will be lost. Similarly, other losses occur when converting from
4210 * some formats to other formats. avcodec_find_best_pix_fmt_of_2() searches which of
4211 * the given pixel formats should be used to suffer the least amount of loss.
4212 * The pixel formats from which it chooses one, are determined by the
4213 * pix_fmt_list parameter.
4216 * @param[in] pix_fmt_list AV_PIX_FMT_NONE terminated array of pixel formats to choose from
4217 * @param[in] src_pix_fmt source pixel format
4218 * @param[in] has_alpha Whether the source pixel format alpha channel is used.
4219 * @param[out] loss_ptr Combination of flags informing you what kind of losses will occur.
4220 * @return The best pixel format to convert to or -1 if none was found.
4222 enum AVPixelFormat avcodec_find_best_pix_fmt_of_list(const enum AVPixelFormat *pix_fmt_list,
4223 enum AVPixelFormat src_pix_fmt,
4224 int has_alpha, int *loss_ptr);
4227 * @deprecated see av_find_best_pix_fmt_of_2()
4229 enum AVPixelFormat avcodec_find_best_pix_fmt_of_2(enum AVPixelFormat dst_pix_fmt1, enum AVPixelFormat dst_pix_fmt2,
4230 enum AVPixelFormat src_pix_fmt, int has_alpha, int *loss_ptr);
4232 attribute_deprecated
4233 enum AVPixelFormat avcodec_find_best_pix_fmt2(enum AVPixelFormat dst_pix_fmt1, enum AVPixelFormat dst_pix_fmt2,
4234 enum AVPixelFormat src_pix_fmt, int has_alpha, int *loss_ptr);
4236 enum AVPixelFormat avcodec_default_get_format(struct AVCodecContext *s, const enum AVPixelFormat * fmt);
4242 #if FF_API_TAG_STRING
4244 * Put a string representing the codec tag codec_tag in buf.
4246 * @param buf buffer to place codec tag in
4247 * @param buf_size size in bytes of buf
4248 * @param codec_tag codec tag to assign
4249 * @return the length of the string that would have been generated if
4250 * enough space had been available, excluding the trailing null
4252 * @deprecated see av_fourcc_make_string() and av_fourcc2str().
4254 attribute_deprecated
4255 size_t av_get_codec_tag_string(char *buf, size_t buf_size, unsigned int codec_tag);
4258 void avcodec_string(char *buf, int buf_size, AVCodecContext *enc, int encode);
4261 * Return a name for the specified profile, if available.
4263 * @param codec the codec that is searched for the given profile
4264 * @param profile the profile value for which a name is requested
4265 * @return A name for the profile if found, NULL otherwise.
4267 const char *av_get_profile_name(const AVCodec *codec, int profile);
4270 * Return a name for the specified profile, if available.
4272 * @param codec_id the ID of the codec to which the requested profile belongs
4273 * @param profile the profile value for which a name is requested
4274 * @return A name for the profile if found, NULL otherwise.
4276 * @note unlike av_get_profile_name(), which searches a list of profiles
4277 * supported by a specific decoder or encoder implementation, this
4278 * function searches the list of profiles from the AVCodecDescriptor
4280 const char *avcodec_profile_name(enum AVCodecID codec_id, int profile);
4282 int avcodec_default_execute(AVCodecContext *c, int (*func)(AVCodecContext *c2, void *arg2),void *arg, int *ret, int count, int size);
4283 int avcodec_default_execute2(AVCodecContext *c, int (*func)(AVCodecContext *c2, void *arg2, int, int),void *arg, int *ret, int count);
4284 //FIXME func typedef
4287 * Fill AVFrame audio data and linesize pointers.
4289 * The buffer buf must be a preallocated buffer with a size big enough
4290 * to contain the specified samples amount. The filled AVFrame data
4291 * pointers will point to this buffer.
4293 * AVFrame extended_data channel pointers are allocated if necessary for
4296 * @param frame the AVFrame
4297 * frame->nb_samples must be set prior to calling the
4298 * function. This function fills in frame->data,
4299 * frame->extended_data, frame->linesize[0].
4300 * @param nb_channels channel count
4301 * @param sample_fmt sample format
4302 * @param buf buffer to use for frame data
4303 * @param buf_size size of buffer
4304 * @param align plane size sample alignment (0 = default)
4305 * @return >=0 on success, negative error code on failure
4306 * @todo return the size in bytes required to store the samples in
4307 * case of success, at the next libavutil bump
4309 int avcodec_fill_audio_frame(AVFrame *frame, int nb_channels,
4310 enum AVSampleFormat sample_fmt, const uint8_t *buf,
4311 int buf_size, int align);
4314 * Reset the internal codec state / flush internal buffers. Should be called
4315 * e.g. when seeking or when switching to a different stream.
4317 * @note for decoders, when refcounted frames are not used
4318 * (i.e. avctx->refcounted_frames is 0), this invalidates the frames previously
4319 * returned from the decoder. When refcounted frames are used, the decoder just
4320 * releases any references it might keep internally, but the caller's reference
4323 * @note for encoders, this function will only do something if the encoder
4324 * declares support for AV_CODEC_CAP_ENCODER_FLUSH. When called, the encoder
4325 * will drain any remaining packets, and can then be re-used for a different
4326 * stream (as opposed to sending a null frame which will leave the encoder
4327 * in a permanent EOF state after draining). This can be desirable if the
4328 * cost of tearing down and replacing the encoder instance is high.
4330 void avcodec_flush_buffers(AVCodecContext *avctx);
4333 * Return codec bits per sample.
4335 * @param[in] codec_id the codec
4336 * @return Number of bits per sample or zero if unknown for the given codec.
4338 int av_get_bits_per_sample(enum AVCodecID codec_id);
4341 * Return the PCM codec associated with a sample format.
4342 * @param be endianness, 0 for little, 1 for big,
4343 * -1 (or anything else) for native
4344 * @return AV_CODEC_ID_PCM_* or AV_CODEC_ID_NONE
4346 enum AVCodecID av_get_pcm_codec(enum AVSampleFormat fmt, int be);
4349 * Return codec bits per sample.
4350 * Only return non-zero if the bits per sample is exactly correct, not an
4353 * @param[in] codec_id the codec
4354 * @return Number of bits per sample or zero if unknown for the given codec.
4356 int av_get_exact_bits_per_sample(enum AVCodecID codec_id);
4359 * Return audio frame duration.
4361 * @param avctx codec context
4362 * @param frame_bytes size of the frame, or 0 if unknown
4363 * @return frame duration, in samples, if known. 0 if not able to
4366 int av_get_audio_frame_duration(AVCodecContext *avctx, int frame_bytes);
4369 * This function is the same as av_get_audio_frame_duration(), except it works
4370 * with AVCodecParameters instead of an AVCodecContext.
4372 int av_get_audio_frame_duration2(AVCodecParameters *par, int frame_bytes);
4375 typedef struct AVBitStreamFilterContext {
4377 const struct AVBitStreamFilter *filter;
4378 AVCodecParserContext *parser;
4379 struct AVBitStreamFilterContext *next;
4381 * Internal default arguments, used if NULL is passed to av_bitstream_filter_filter().
4382 * Not for access by library users.
4385 } AVBitStreamFilterContext;
4388 * @deprecated the old bitstream filtering API (using AVBitStreamFilterContext)
4389 * is deprecated. Use the new bitstream filtering API (using AVBSFContext).
4391 attribute_deprecated
4392 void av_register_bitstream_filter(AVBitStreamFilter *bsf);
4394 * @deprecated the old bitstream filtering API (using AVBitStreamFilterContext)
4395 * is deprecated. Use av_bsf_get_by_name(), av_bsf_alloc(), and av_bsf_init()
4396 * from the new bitstream filtering API (using AVBSFContext).
4398 attribute_deprecated
4399 AVBitStreamFilterContext *av_bitstream_filter_init(const char *name);
4401 * @deprecated the old bitstream filtering API (using AVBitStreamFilterContext)
4402 * is deprecated. Use av_bsf_send_packet() and av_bsf_receive_packet() from the
4403 * new bitstream filtering API (using AVBSFContext).
4405 attribute_deprecated
4406 int av_bitstream_filter_filter(AVBitStreamFilterContext *bsfc,
4407 AVCodecContext *avctx, const char *args,
4408 uint8_t **poutbuf, int *poutbuf_size,
4409 const uint8_t *buf, int buf_size, int keyframe);
4411 * @deprecated the old bitstream filtering API (using AVBitStreamFilterContext)
4412 * is deprecated. Use av_bsf_free() from the new bitstream filtering API (using
4415 attribute_deprecated
4416 void av_bitstream_filter_close(AVBitStreamFilterContext *bsf);
4418 * @deprecated the old bitstream filtering API (using AVBitStreamFilterContext)
4419 * is deprecated. Use av_bsf_iterate() from the new bitstream filtering API (using
4422 attribute_deprecated
4423 const AVBitStreamFilter *av_bitstream_filter_next(const AVBitStreamFilter *f);
4427 attribute_deprecated
4428 const AVBitStreamFilter *av_bsf_next(void **opaque);
4434 * Same behaviour av_fast_malloc but the buffer has additional
4435 * AV_INPUT_BUFFER_PADDING_SIZE at the end which will always be 0.
4437 * In addition the whole buffer will initially and after resizes
4438 * be 0-initialized so that no uninitialized data will ever appear.
4440 void av_fast_padded_malloc(void *ptr, unsigned int *size, size_t min_size);
4443 * Same behaviour av_fast_padded_malloc except that buffer will always
4444 * be 0-initialized after call.
4446 void av_fast_padded_mallocz(void *ptr, unsigned int *size, size_t min_size);
4449 * Encode extradata length to a buffer. Used by xiph codecs.
4451 * @param s buffer to write to; must be at least (v/255+1) bytes long
4452 * @param v size of extradata in bytes
4453 * @return number of bytes written to the buffer.
4455 unsigned int av_xiphlacing(unsigned char *s, unsigned int v);
4457 #if FF_API_USER_VISIBLE_AVHWACCEL
4459 * Register the hardware accelerator hwaccel.
4461 * @deprecated This function doesn't do anything.
4463 attribute_deprecated
4464 void av_register_hwaccel(AVHWAccel *hwaccel);
4467 * If hwaccel is NULL, returns the first registered hardware accelerator,
4468 * if hwaccel is non-NULL, returns the next registered hardware accelerator
4469 * after hwaccel, or NULL if hwaccel is the last one.
4471 * @deprecated AVHWaccel structures contain no user-serviceable parts, so
4472 * this function should not be used.
4474 attribute_deprecated
4475 AVHWAccel *av_hwaccel_next(const AVHWAccel *hwaccel);
4480 * Lock operation used by lockmgr
4482 * @deprecated Deprecated together with av_lockmgr_register().
4485 AV_LOCK_CREATE, ///< Create a mutex
4486 AV_LOCK_OBTAIN, ///< Lock the mutex
4487 AV_LOCK_RELEASE, ///< Unlock the mutex
4488 AV_LOCK_DESTROY, ///< Free mutex resources
4492 * Register a user provided lock manager supporting the operations
4493 * specified by AVLockOp. The "mutex" argument to the function points
4494 * to a (void *) where the lockmgr should store/get a pointer to a user
4495 * allocated mutex. It is NULL upon AV_LOCK_CREATE and equal to the
4496 * value left by the last call for all other ops. If the lock manager is
4497 * unable to perform the op then it should leave the mutex in the same
4498 * state as when it was called and return a non-zero value. However,
4499 * when called with AV_LOCK_DESTROY the mutex will always be assumed to
4500 * have been successfully destroyed. If av_lockmgr_register succeeds
4501 * it will return a non-negative value, if it fails it will return a
4502 * negative value and destroy all mutex and unregister all callbacks.
4503 * av_lockmgr_register is not thread-safe, it must be called from a
4504 * single thread before any calls which make use of locking are used.
4506 * @param cb User defined callback. av_lockmgr_register invokes calls
4507 * to this callback and the previously registered callback.
4508 * The callback will be used to create more than one mutex
4509 * each of which must be backed by its own underlying locking
4510 * mechanism (i.e. do not use a single static object to
4511 * implement your lock manager). If cb is set to NULL the
4512 * lockmgr will be unregistered.
4514 * @deprecated This function does nothing, and always returns 0. Be sure to
4515 * build with thread support to get basic thread safety.
4517 attribute_deprecated
4518 int av_lockmgr_register(int (*cb)(void **mutex, enum AVLockOp op));
4522 * Get the type of the given codec.
4524 enum AVMediaType avcodec_get_type(enum AVCodecID codec_id);
4527 * Get the name of a codec.
4528 * @return a static string identifying the codec; never NULL
4530 const char *avcodec_get_name(enum AVCodecID id);
4533 * @return a positive value if s is open (i.e. avcodec_open2() was called on it
4534 * with no corresponding avcodec_close()), 0 otherwise.
4536 int avcodec_is_open(AVCodecContext *s);
4539 * @return a non-zero number if codec is an encoder, zero otherwise
4541 int av_codec_is_encoder(const AVCodec *codec);
4544 * @return a non-zero number if codec is a decoder, zero otherwise
4546 int av_codec_is_decoder(const AVCodec *codec);
4549 * Allocate a CPB properties structure and initialize its fields to default
4552 * @param size if non-NULL, the size of the allocated struct will be written
4553 * here. This is useful for embedding it in side data.
4555 * @return the newly allocated struct or NULL on failure
4557 AVCPBProperties *av_cpb_properties_alloc(size_t *size);
4563 #endif /* AVCODEC_AVCODEC_H */