2 * copyright (c) 2001 Fabrice Bellard
4 * This file is part of FFmpeg.
6 * FFmpeg is free software; you can redistribute it and/or
7 * modify it under the terms of the GNU Lesser General Public
8 * License as published by the Free Software Foundation; either
9 * version 2.1 of the License, or (at your option) any later version.
11 * FFmpeg is distributed in the hope that it will be useful,
12 * but WITHOUT ANY WARRANTY; without even the implied warranty of
13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
14 * Lesser General Public License for more details.
16 * You should have received a copy of the GNU Lesser General Public
17 * License along with FFmpeg; if not, write to the Free Software
18 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
21 #ifndef AVCODEC_AVCODEC_H
22 #define AVCODEC_AVCODEC_H
27 * Libavcodec external API header
31 #include "libavutil/samplefmt.h"
32 #include "libavutil/attributes.h"
33 #include "libavutil/avutil.h"
34 #include "libavutil/buffer.h"
35 #include "libavutil/cpu.h"
36 #include "libavutil/channel_layout.h"
37 #include "libavutil/dict.h"
38 #include "libavutil/frame.h"
39 #include "libavutil/hwcontext.h"
40 #include "libavutil/log.h"
41 #include "libavutil/pixfmt.h"
42 #include "libavutil/rational.h"
44 #include "codec_desc.h"
50 * @defgroup libavc libavcodec
51 * Encoding/Decoding Library
55 * @defgroup lavc_decoding Decoding
59 * @defgroup lavc_encoding Encoding
63 * @defgroup lavc_codec Codecs
65 * @defgroup lavc_codec_native Native Codecs
68 * @defgroup lavc_codec_wrappers External library wrappers
71 * @defgroup lavc_codec_hwaccel Hardware Accelerators bridge
75 * @defgroup lavc_internal Internal
83 * @defgroup lavc_encdec send/receive encoding and decoding API overview
86 * The avcodec_send_packet()/avcodec_receive_frame()/avcodec_send_frame()/
87 * avcodec_receive_packet() functions provide an encode/decode API, which
88 * decouples input and output.
90 * The API is very similar for encoding/decoding and audio/video, and works as
92 * - Set up and open the AVCodecContext as usual.
94 * - For decoding, call avcodec_send_packet() to give the decoder raw
95 * compressed data in an AVPacket.
96 * - For encoding, call avcodec_send_frame() to give the encoder an AVFrame
97 * containing uncompressed audio or video.
99 * In both cases, it is recommended that AVPackets and AVFrames are
100 * refcounted, or libavcodec might have to copy the input data. (libavformat
101 * always returns refcounted AVPackets, and av_frame_get_buffer() allocates
102 * refcounted AVFrames.)
103 * - Receive output in a loop. Periodically call one of the avcodec_receive_*()
104 * functions and process their output:
105 * - For decoding, call avcodec_receive_frame(). On success, it will return
106 * an AVFrame containing uncompressed audio or video data.
107 * - For encoding, call avcodec_receive_packet(). On success, it will return
108 * an AVPacket with a compressed frame.
110 * Repeat this call until it returns AVERROR(EAGAIN) or an error. The
111 * AVERROR(EAGAIN) return value means that new input data is required to
112 * return new output. In this case, continue with sending input. For each
113 * input frame/packet, the codec will typically return 1 output frame/packet,
114 * but it can also be 0 or more than 1.
116 * At the beginning of decoding or encoding, the codec might accept multiple
117 * input frames/packets without returning a frame, until its internal buffers
118 * are filled. This situation is handled transparently if you follow the steps
121 * In theory, sending input can result in EAGAIN - this should happen only if
122 * not all output was received. You can use this to structure alternative decode
123 * or encode loops other than the one suggested above. For example, you could
124 * try sending new input on each iteration, and try to receive output if that
127 * End of stream situations. These require "flushing" (aka draining) the codec,
128 * as the codec might buffer multiple frames or packets internally for
129 * performance or out of necessity (consider B-frames).
130 * This is handled as follows:
131 * - Instead of valid input, send NULL to the avcodec_send_packet() (decoding)
132 * or avcodec_send_frame() (encoding) functions. This will enter draining
134 * - Call avcodec_receive_frame() (decoding) or avcodec_receive_packet()
135 * (encoding) in a loop until AVERROR_EOF is returned. The functions will
136 * not return AVERROR(EAGAIN), unless you forgot to enter draining mode.
137 * - Before decoding can be resumed again, the codec has to be reset with
138 * avcodec_flush_buffers().
140 * Using the API as outlined above is highly recommended. But it is also
141 * possible to call functions outside of this rigid schema. For example, you can
142 * call avcodec_send_packet() repeatedly without calling
143 * avcodec_receive_frame(). In this case, avcodec_send_packet() will succeed
144 * until the codec's internal buffer has been filled up (which is typically of
145 * size 1 per output frame, after initial input), and then reject input with
146 * AVERROR(EAGAIN). Once it starts rejecting input, you have no choice but to
147 * read at least some output.
149 * Not all codecs will follow a rigid and predictable dataflow; the only
150 * guarantee is that an AVERROR(EAGAIN) return value on a send/receive call on
151 * one end implies that a receive/send call on the other end will succeed, or
152 * at least will not fail with AVERROR(EAGAIN). In general, no codec will
153 * permit unlimited buffering of input or output.
155 * This API replaces the following legacy functions:
156 * - avcodec_decode_video2() and avcodec_decode_audio4():
157 * Use avcodec_send_packet() to feed input to the decoder, then use
158 * avcodec_receive_frame() to receive decoded frames after each packet.
159 * Unlike with the old video decoding API, multiple frames might result from
160 * a packet. For audio, splitting the input packet into frames by partially
161 * decoding packets becomes transparent to the API user. You never need to
162 * feed an AVPacket to the API twice (unless it is rejected with AVERROR(EAGAIN) - then
163 * no data was read from the packet).
164 * Additionally, sending a flush/draining packet is required only once.
165 * - avcodec_encode_video2()/avcodec_encode_audio2():
166 * Use avcodec_send_frame() to feed input to the encoder, then use
167 * avcodec_receive_packet() to receive encoded packets.
168 * Providing user-allocated buffers for avcodec_receive_packet() is not
170 * - The new API does not handle subtitles yet.
172 * Mixing new and old function calls on the same AVCodecContext is not allowed,
173 * and will result in undefined behavior.
175 * Some codecs might require using the new API; using the old API will return
176 * an error when calling it. All codecs support the new API.
178 * A codec is not allowed to return AVERROR(EAGAIN) for both sending and receiving. This
179 * would be an invalid state, which could put the codec user into an endless
180 * loop. The API has no concept of time either: it cannot happen that trying to
181 * do avcodec_send_packet() results in AVERROR(EAGAIN), but a repeated call 1 second
182 * later accepts the packet (with no other receive/flush API calls involved).
183 * The API is a strict state machine, and the passage of time is not supposed
184 * to influence it. Some timing-dependent behavior might still be deemed
185 * acceptable in certain cases. But it must never result in both send/receive
186 * returning EAGAIN at the same time at any point. It must also absolutely be
187 * avoided that the current state is "unstable" and can "flip-flop" between
188 * the send/receive APIs allowing progress. For example, it's not allowed that
189 * the codec randomly decides that it actually wants to consume a packet now
190 * instead of returning a frame, after it just returned AVERROR(EAGAIN) on an
191 * avcodec_send_packet() call.
196 * @defgroup lavc_core Core functions/structures.
199 * Basic definitions, functions for querying libavcodec capabilities,
200 * allocating core structures, etc.
205 * @ingroup lavc_decoding
206 * Required number of additionally allocated bytes at the end of the input bitstream for decoding.
207 * This is mainly needed because some optimized bitstream readers read
208 * 32 or 64 bit at once and could read over the end.<br>
209 * Note: If the first 23 bits of the additional bytes are not 0, then damaged
210 * MPEG bitstreams could cause overread and segfault.
212 #define AV_INPUT_BUFFER_PADDING_SIZE 64
215 * @ingroup lavc_encoding
216 * minimum encoding buffer size
217 * Used to avoid some checks during header writing.
219 #define AV_INPUT_BUFFER_MIN_SIZE 16384
222 * @ingroup lavc_decoding
225 /* We leave some space between them for extensions (drop some
226 * keyframes for intra-only or drop just some bidir frames). */
227 AVDISCARD_NONE =-16, ///< discard nothing
228 AVDISCARD_DEFAULT = 0, ///< discard useless packets like 0 size packets in avi
229 AVDISCARD_NONREF = 8, ///< discard all non reference
230 AVDISCARD_BIDIR = 16, ///< discard all bidirectional frames
231 AVDISCARD_NONINTRA= 24, ///< discard all non intra frames
232 AVDISCARD_NONKEY = 32, ///< discard all frames except keyframes
233 AVDISCARD_ALL = 48, ///< discard all
236 enum AVAudioServiceType {
237 AV_AUDIO_SERVICE_TYPE_MAIN = 0,
238 AV_AUDIO_SERVICE_TYPE_EFFECTS = 1,
239 AV_AUDIO_SERVICE_TYPE_VISUALLY_IMPAIRED = 2,
240 AV_AUDIO_SERVICE_TYPE_HEARING_IMPAIRED = 3,
241 AV_AUDIO_SERVICE_TYPE_DIALOGUE = 4,
242 AV_AUDIO_SERVICE_TYPE_COMMENTARY = 5,
243 AV_AUDIO_SERVICE_TYPE_EMERGENCY = 6,
244 AV_AUDIO_SERVICE_TYPE_VOICE_OVER = 7,
245 AV_AUDIO_SERVICE_TYPE_KARAOKE = 8,
246 AV_AUDIO_SERVICE_TYPE_NB , ///< Not part of ABI
250 * @ingroup lavc_encoding
252 typedef struct RcOverride{
255 int qscale; // If this is 0 then quality_factor will be used instead.
256 float quality_factor;
260 These flags can be passed in AVCodecContext.flags before initialization.
261 Note: Not everything is supported yet.
265 * Allow decoders to produce frames with data planes that are not aligned
266 * to CPU requirements (e.g. due to cropping).
268 #define AV_CODEC_FLAG_UNALIGNED (1 << 0)
272 #define AV_CODEC_FLAG_QSCALE (1 << 1)
274 * 4 MV per MB allowed / advanced prediction for H.263.
276 #define AV_CODEC_FLAG_4MV (1 << 2)
278 * Output even those frames that might be corrupted.
280 #define AV_CODEC_FLAG_OUTPUT_CORRUPT (1 << 3)
284 #define AV_CODEC_FLAG_QPEL (1 << 4)
286 * Don't output frames whose parameters differ from first
287 * decoded frame in stream.
289 #define AV_CODEC_FLAG_DROPCHANGED (1 << 5)
291 * Use internal 2pass ratecontrol in first pass mode.
293 #define AV_CODEC_FLAG_PASS1 (1 << 9)
295 * Use internal 2pass ratecontrol in second pass mode.
297 #define AV_CODEC_FLAG_PASS2 (1 << 10)
301 #define AV_CODEC_FLAG_LOOP_FILTER (1 << 11)
303 * Only decode/encode grayscale.
305 #define AV_CODEC_FLAG_GRAY (1 << 13)
307 * error[?] variables will be set during encoding.
309 #define AV_CODEC_FLAG_PSNR (1 << 15)
311 * Input bitstream might be truncated at a random location
312 * instead of only at frame boundaries.
314 #define AV_CODEC_FLAG_TRUNCATED (1 << 16)
316 * Use interlaced DCT.
318 #define AV_CODEC_FLAG_INTERLACED_DCT (1 << 18)
322 #define AV_CODEC_FLAG_LOW_DELAY (1 << 19)
324 * Place global headers in extradata instead of every keyframe.
326 #define AV_CODEC_FLAG_GLOBAL_HEADER (1 << 22)
328 * Use only bitexact stuff (except (I)DCT).
330 #define AV_CODEC_FLAG_BITEXACT (1 << 23)
331 /* Fx : Flag for H.263+ extra options */
333 * H.263 advanced intra coding / MPEG-4 AC prediction
335 #define AV_CODEC_FLAG_AC_PRED (1 << 24)
337 * interlaced motion estimation
339 #define AV_CODEC_FLAG_INTERLACED_ME (1 << 29)
340 #define AV_CODEC_FLAG_CLOSED_GOP (1U << 31)
343 * Allow non spec compliant speedup tricks.
345 #define AV_CODEC_FLAG2_FAST (1 << 0)
347 * Skip bitstream encoding.
349 #define AV_CODEC_FLAG2_NO_OUTPUT (1 << 2)
351 * Place global headers at every keyframe instead of in extradata.
353 #define AV_CODEC_FLAG2_LOCAL_HEADER (1 << 3)
356 * timecode is in drop frame format. DEPRECATED!!!!
358 #define AV_CODEC_FLAG2_DROP_FRAME_TIMECODE (1 << 13)
361 * Input bitstream might be truncated at a packet boundaries
362 * instead of only at frame boundaries.
364 #define AV_CODEC_FLAG2_CHUNKS (1 << 15)
366 * Discard cropping information from SPS.
368 #define AV_CODEC_FLAG2_IGNORE_CROP (1 << 16)
371 * Show all frames before the first keyframe
373 #define AV_CODEC_FLAG2_SHOW_ALL (1 << 22)
375 * Export motion vectors through frame side data
377 #define AV_CODEC_FLAG2_EXPORT_MVS (1 << 28)
379 * Do not skip samples and export skip information as frame side data
381 #define AV_CODEC_FLAG2_SKIP_MANUAL (1 << 29)
383 * Do not reset ASS ReadOrder field on flush (subtitles decoding)
385 #define AV_CODEC_FLAG2_RO_FLUSH_NOOP (1 << 30)
387 /* Unsupported options :
388 * Syntax Arithmetic coding (SAC)
389 * Reference Picture Selection
390 * Independent Segment Decoding */
392 /* codec capabilities */
395 * Decoder can use draw_horiz_band callback.
397 #define AV_CODEC_CAP_DRAW_HORIZ_BAND (1 << 0)
399 * Codec uses get_buffer() for allocating buffers and supports custom allocators.
400 * If not set, it might not use get_buffer() at all or use operations that
401 * assume the buffer was allocated by avcodec_default_get_buffer.
403 #define AV_CODEC_CAP_DR1 (1 << 1)
404 #define AV_CODEC_CAP_TRUNCATED (1 << 3)
406 * Encoder or decoder requires flushing with NULL input at the end in order to
407 * give the complete and correct output.
409 * NOTE: If this flag is not set, the codec is guaranteed to never be fed with
410 * with NULL data. The user can still send NULL data to the public encode
411 * or decode function, but libavcodec will not pass it along to the codec
412 * unless this flag is set.
415 * The decoder has a non-zero delay and needs to be fed with avpkt->data=NULL,
416 * avpkt->size=0 at the end to get the delayed data until the decoder no longer
420 * The encoder needs to be fed with NULL data at the end of encoding until the
421 * encoder no longer returns data.
423 * NOTE: For encoders implementing the AVCodec.encode2() function, setting this
424 * flag also means that the encoder must set the pts and duration for
425 * each output packet. If this flag is not set, the pts and duration will
426 * be determined by libavcodec from the input frame.
428 #define AV_CODEC_CAP_DELAY (1 << 5)
430 * Codec can be fed a final frame with a smaller size.
431 * This can be used to prevent truncation of the last audio samples.
433 #define AV_CODEC_CAP_SMALL_LAST_FRAME (1 << 6)
436 * Codec can output multiple frames per AVPacket
437 * Normally demuxers return one frame at a time, demuxers which do not do
438 * are connected to a parser to split what they return into proper frames.
439 * This flag is reserved to the very rare category of codecs which have a
440 * bitstream that cannot be split into frames without timeconsuming
441 * operations like full decoding. Demuxers carrying such bitstreams thus
442 * may return multiple frames in a packet. This has many disadvantages like
443 * prohibiting stream copy in many cases thus it should only be considered
446 #define AV_CODEC_CAP_SUBFRAMES (1 << 8)
448 * Codec is experimental and is thus avoided in favor of non experimental
451 #define AV_CODEC_CAP_EXPERIMENTAL (1 << 9)
453 * Codec should fill in channel configuration and samplerate instead of container
455 #define AV_CODEC_CAP_CHANNEL_CONF (1 << 10)
457 * Codec supports frame-level multithreading.
459 #define AV_CODEC_CAP_FRAME_THREADS (1 << 12)
461 * Codec supports slice-based (or partition-based) multithreading.
463 #define AV_CODEC_CAP_SLICE_THREADS (1 << 13)
465 * Codec supports changed parameters at any point.
467 #define AV_CODEC_CAP_PARAM_CHANGE (1 << 14)
469 * Codec supports avctx->thread_count == 0 (auto).
471 #define AV_CODEC_CAP_AUTO_THREADS (1 << 15)
473 * Audio encoder supports receiving a different number of samples in each call.
475 #define AV_CODEC_CAP_VARIABLE_FRAME_SIZE (1 << 16)
477 * Decoder is not a preferred choice for probing.
478 * This indicates that the decoder is not a good choice for probing.
479 * It could for example be an expensive to spin up hardware decoder,
480 * or it could simply not provide a lot of useful information about
482 * A decoder marked with this flag should only be used as last resort
483 * choice for probing.
485 #define AV_CODEC_CAP_AVOID_PROBING (1 << 17)
487 * Codec is intra only.
489 #define AV_CODEC_CAP_INTRA_ONLY 0x40000000
493 #define AV_CODEC_CAP_LOSSLESS 0x80000000
496 * Codec is backed by a hardware implementation. Typically used to
497 * identify a non-hwaccel hardware decoder. For information about hwaccels, use
498 * avcodec_get_hw_config() instead.
500 #define AV_CODEC_CAP_HARDWARE (1 << 18)
503 * Codec is potentially backed by a hardware implementation, but not
504 * necessarily. This is used instead of AV_CODEC_CAP_HARDWARE, if the
505 * implementation provides some sort of internal fallback.
507 #define AV_CODEC_CAP_HYBRID (1 << 19)
510 * This codec takes the reordered_opaque field from input AVFrames
511 * and returns it in the corresponding field in AVCodecContext after
514 #define AV_CODEC_CAP_ENCODER_REORDERED_OPAQUE (1 << 20)
517 * This encoder can be flushed using avcodec_flush_buffers(). If this flag is
518 * not set, the encoder must be closed and reopened to ensure that no frames
521 #define AV_CODEC_CAP_ENCODER_FLUSH (1 << 21)
523 /* Exported side data.
524 These flags can be passed in AVCodecContext.export_side_data before initialization.
527 * Export motion vectors through frame side data
529 #define AV_CODEC_EXPORT_DATA_MVS (1 << 0)
531 * Export encoder Producer Reference Time through packet side data
533 #define AV_CODEC_EXPORT_DATA_PRFT (1 << 1)
536 * Export the AVVideoEncParams structure through frame side data.
538 #define AV_CODEC_EXPORT_DATA_VIDEO_ENC_PARAMS (1 << 2)
542 * This specifies the area which should be displayed.
543 * Note there may be multiple such areas for one frame.
545 typedef struct AVPanScan {
548 * - encoding: Set by user.
549 * - decoding: Set by libavcodec.
554 * width and height in 1/16 pel
555 * - encoding: Set by user.
556 * - decoding: Set by libavcodec.
562 * position of the top left corner in 1/16 pel for up to 3 fields/frames
563 * - encoding: Set by user.
564 * - decoding: Set by libavcodec.
566 int16_t position[3][2];
570 * This structure describes the bitrate properties of an encoded bitstream. It
571 * roughly corresponds to a subset the VBV parameters for MPEG-2 or HRD
572 * parameters for H.264/HEVC.
574 typedef struct AVCPBProperties {
576 * Maximum bitrate of the stream, in bits per second.
577 * Zero if unknown or unspecified.
579 #if FF_API_UNSANITIZED_BITRATES
585 * Minimum bitrate of the stream, in bits per second.
586 * Zero if unknown or unspecified.
588 #if FF_API_UNSANITIZED_BITRATES
594 * Average bitrate of the stream, in bits per second.
595 * Zero if unknown or unspecified.
597 #if FF_API_UNSANITIZED_BITRATES
604 * The size of the buffer to which the ratecontrol is applied, in bits.
605 * Zero if unknown or unspecified.
610 * The delay between the time the packet this structure is associated with
611 * is received and the time when it should be decoded, in periods of a 27MHz
614 * UINT64_MAX when unknown or unspecified.
620 * This structure supplies correlation between a packet timestamp and a wall clock
621 * production time. The definition follows the Producer Reference Time ('prft')
622 * as defined in ISO/IEC 14496-12
624 typedef struct AVProducerReferenceTime {
626 * A UTC timestamp, in microseconds, since Unix epoch (e.g, av_gettime()).
630 } AVProducerReferenceTime;
633 * The decoder will keep a reference to the frame and may reuse it later.
635 #define AV_GET_BUFFER_FLAG_REF (1 << 0)
637 struct AVCodecInternal;
641 AV_FIELD_PROGRESSIVE,
642 AV_FIELD_TT, //< Top coded_first, top displayed first
643 AV_FIELD_BB, //< Bottom coded first, bottom displayed first
644 AV_FIELD_TB, //< Top coded first, bottom displayed first
645 AV_FIELD_BT, //< Bottom coded first, top displayed first
649 * main external API structure.
650 * New fields can be added to the end with minor version bumps.
651 * Removal, reordering and changes to existing fields require a major
653 * You can use AVOptions (av_opt* / av_set/get*()) to access these fields from user
655 * The name string for AVOptions options matches the associated command line
656 * parameter name and can be found in libavcodec/options_table.h
657 * The AVOption/command line parameter names differ in some cases from the C
658 * structure field names for historic reasons or brevity.
659 * sizeof(AVCodecContext) must not be used outside libav*.
661 typedef struct AVCodecContext {
663 * information on struct for av_log
664 * - set by avcodec_alloc_context3
666 const AVClass *av_class;
667 int log_level_offset;
669 enum AVMediaType codec_type; /* see AVMEDIA_TYPE_xxx */
670 const struct AVCodec *codec;
671 enum AVCodecID codec_id; /* see AV_CODEC_ID_xxx */
674 * fourcc (LSB first, so "ABCD" -> ('D'<<24) + ('C'<<16) + ('B'<<8) + 'A').
675 * This is used to work around some encoder bugs.
676 * A demuxer should set this to what is stored in the field used to identify the codec.
677 * If there are multiple such fields in a container then the demuxer should choose the one
678 * which maximizes the information about the used codec.
679 * If the codec tag field in a container is larger than 32 bits then the demuxer should
680 * remap the longer ID to 32 bits with a table or other structure. Alternatively a new
681 * extra_codec_tag + size could be added but for this a clear advantage must be demonstrated
683 * - encoding: Set by user, if not then the default based on codec_id will be used.
684 * - decoding: Set by user, will be converted to uppercase by libavcodec during init.
686 unsigned int codec_tag;
691 * Private context used for internal data.
693 * Unlike priv_data, this is not codec-specific. It is used in general
694 * libavcodec functions.
696 struct AVCodecInternal *internal;
699 * Private data of the user, can be used to carry app specific stuff.
700 * - encoding: Set by user.
701 * - decoding: Set by user.
706 * the average bitrate
707 * - encoding: Set by user; unused for constant quantizer encoding.
708 * - decoding: Set by user, may be overwritten by libavcodec
709 * if this info is available in the stream
714 * number of bits the bitstream is allowed to diverge from the reference.
715 * the reference can be CBR (for CBR pass1) or VBR (for pass2)
716 * - encoding: Set by user; unused for constant quantizer encoding.
719 int bit_rate_tolerance;
722 * Global quality for codecs which cannot change it per frame.
723 * This should be proportional to MPEG-1/2/4 qscale.
724 * - encoding: Set by user.
730 * - encoding: Set by user.
733 int compression_level;
734 #define FF_COMPRESSION_DEFAULT -1
738 * - encoding: Set by user.
739 * - decoding: Set by user.
745 * - encoding: Set by user.
746 * - decoding: Set by user.
751 * some codecs need / can use extradata like Huffman tables.
752 * MJPEG: Huffman tables
753 * rv10: additional flags
754 * MPEG-4: global headers (they can be in the bitstream or here)
755 * The allocated memory should be AV_INPUT_BUFFER_PADDING_SIZE bytes larger
756 * than extradata_size to avoid problems if it is read with the bitstream reader.
757 * The bytewise contents of extradata must not depend on the architecture or CPU endianness.
758 * Must be allocated with the av_malloc() family of functions.
759 * - encoding: Set/allocated/freed by libavcodec.
760 * - decoding: Set/allocated/freed by user.
766 * This is the fundamental unit of time (in seconds) in terms
767 * of which frame timestamps are represented. For fixed-fps content,
768 * timebase should be 1/framerate and timestamp increments should be
770 * This often, but not always is the inverse of the frame rate or field rate
771 * for video. 1/time_base is not the average frame rate if the frame rate is not
774 * Like containers, elementary streams also can store timestamps, 1/time_base
775 * is the unit in which these timestamps are specified.
776 * As example of such codec time base see ISO/IEC 14496-2:2001(E)
777 * vop_time_increment_resolution and fixed_vop_rate
778 * (fixed_vop_rate == 0 implies that it is different from the framerate)
780 * - encoding: MUST be set by user.
781 * - decoding: the use of this field for decoding is deprecated.
782 * Use framerate instead.
784 AVRational time_base;
787 * For some codecs, the time base is closer to the field rate than the frame rate.
788 * Most notably, H.264 and MPEG-2 specify time_base as half of frame duration
789 * if no telecine is used ...
791 * Set to time_base ticks per frame. Default 1, e.g., H.264/MPEG-2 set it to 2.
798 * Encoding: Number of frames delay there will be from the encoder input to
799 * the decoder output. (we assume the decoder matches the spec)
800 * Decoding: Number of frames delay in addition to what a standard decoder
801 * as specified in the spec would produce.
804 * Number of frames the decoded output will be delayed relative to the
808 * For encoding, this field is unused (see initial_padding).
810 * For decoding, this is the number of samples the decoder needs to
811 * output before the decoder's output is valid. When seeking, you should
812 * start decoding this many samples prior to your desired seek point.
814 * - encoding: Set by libavcodec.
815 * - decoding: Set by libavcodec.
822 * picture width / height.
824 * @note Those fields may not match the values of the last
825 * AVFrame output by avcodec_decode_video2 due frame
828 * - encoding: MUST be set by user.
829 * - decoding: May be set by the user before opening the decoder if known e.g.
830 * from the container. Some decoders will require the dimensions
831 * to be set by the caller. During decoding, the decoder may
832 * overwrite those values as required while parsing the data.
837 * Bitstream width / height, may be different from width/height e.g. when
838 * the decoded frame is cropped before being output or lowres is enabled.
840 * @note Those field may not match the value of the last
841 * AVFrame output by avcodec_receive_frame() due frame
845 * - decoding: May be set by the user before opening the decoder if known
846 * e.g. from the container. During decoding, the decoder may
847 * overwrite those values as required while parsing the data.
849 int coded_width, coded_height;
852 * the number of pictures in a group of pictures, or 0 for intra_only
853 * - encoding: Set by user.
859 * Pixel format, see AV_PIX_FMT_xxx.
860 * May be set by the demuxer if known from headers.
861 * May be overridden by the decoder if it knows better.
863 * @note This field may not match the value of the last
864 * AVFrame output by avcodec_receive_frame() due frame
867 * - encoding: Set by user.
868 * - decoding: Set by user if known, overridden by libavcodec while
871 enum AVPixelFormat pix_fmt;
874 * If non NULL, 'draw_horiz_band' is called by the libavcodec
875 * decoder to draw a horizontal band. It improves cache usage. Not
876 * all codecs can do that. You must check the codec capabilities
878 * When multithreading is used, it may be called from multiple threads
879 * at the same time; threads might draw different parts of the same AVFrame,
880 * or multiple AVFrames, and there is no guarantee that slices will be drawn
882 * The function is also used by hardware acceleration APIs.
883 * It is called at least once during frame decoding to pass
884 * the data needed for hardware render.
885 * In that mode instead of pixel data, AVFrame points to
886 * a structure specific to the acceleration API. The application
887 * reads the structure and can change some fields to indicate progress
890 * - decoding: Set by user.
891 * @param height the height of the slice
892 * @param y the y position of the slice
893 * @param type 1->top field, 2->bottom field, 3->frame
894 * @param offset offset into the AVFrame.data from which the slice should be read
896 void (*draw_horiz_band)(struct AVCodecContext *s,
897 const AVFrame *src, int offset[AV_NUM_DATA_POINTERS],
898 int y, int type, int height);
901 * callback to negotiate the pixelFormat
902 * @param fmt is the list of formats which are supported by the codec,
903 * it is terminated by -1 as 0 is a valid format, the formats are ordered by quality.
904 * The first is always the native one.
905 * @note The callback may be called again immediately if initialization for
906 * the selected (hardware-accelerated) pixel format failed.
907 * @warning Behavior is undefined if the callback returns a value not
908 * in the fmt list of formats.
909 * @return the chosen format
911 * - decoding: Set by user, if not set the native format will be chosen.
913 enum AVPixelFormat (*get_format)(struct AVCodecContext *s, const enum AVPixelFormat * fmt);
916 * maximum number of B-frames between non-B-frames
917 * Note: The output will be delayed by max_b_frames+1 relative to the input.
918 * - encoding: Set by user.
924 * qscale factor between IP and B-frames
925 * If > 0 then the last P-frame quantizer will be used (q= lastp_q*factor+offset).
926 * If < 0 then normal ratecontrol will be done (q= -normal_q*factor+offset).
927 * - encoding: Set by user.
930 float b_quant_factor;
932 #if FF_API_PRIVATE_OPT
933 /** @deprecated use encoder private options instead */
935 int b_frame_strategy;
939 * qscale offset between IP and B-frames
940 * - encoding: Set by user.
943 float b_quant_offset;
946 * Size of the frame reordering buffer in the decoder.
947 * For MPEG-2 it is 1 IPB or 0 low delay IP.
948 * - encoding: Set by libavcodec.
949 * - decoding: Set by libavcodec.
953 #if FF_API_PRIVATE_OPT
954 /** @deprecated use encoder private options instead */
960 * qscale factor between P- and I-frames
961 * If > 0 then the last P-frame quantizer will be used (q = lastp_q * factor + offset).
962 * If < 0 then normal ratecontrol will be done (q= -normal_q*factor+offset).
963 * - encoding: Set by user.
966 float i_quant_factor;
969 * qscale offset between P and I-frames
970 * - encoding: Set by user.
973 float i_quant_offset;
976 * luminance masking (0-> disabled)
977 * - encoding: Set by user.
983 * temporary complexity masking (0-> disabled)
984 * - encoding: Set by user.
987 float temporal_cplx_masking;
990 * spatial complexity masking (0-> disabled)
991 * - encoding: Set by user.
994 float spatial_cplx_masking;
997 * p block masking (0-> disabled)
998 * - encoding: Set by user.
1004 * darkness masking (0-> disabled)
1005 * - encoding: Set by user.
1006 * - decoding: unused
1012 * - encoding: Set by libavcodec.
1013 * - decoding: Set by user (or 0).
1017 #if FF_API_PRIVATE_OPT
1018 /** @deprecated use encoder private options instead */
1019 attribute_deprecated
1020 int prediction_method;
1021 #define FF_PRED_LEFT 0
1022 #define FF_PRED_PLANE 1
1023 #define FF_PRED_MEDIAN 2
1027 * slice offsets in the frame in bytes
1028 * - encoding: Set/allocated by libavcodec.
1029 * - decoding: Set/allocated by user (or NULL).
1034 * sample aspect ratio (0 if unknown)
1035 * That is the width of a pixel divided by the height of the pixel.
1036 * Numerator and denominator must be relatively prime and smaller than 256 for some video standards.
1037 * - encoding: Set by user.
1038 * - decoding: Set by libavcodec.
1040 AVRational sample_aspect_ratio;
1043 * motion estimation comparison function
1044 * - encoding: Set by user.
1045 * - decoding: unused
1049 * subpixel motion estimation comparison function
1050 * - encoding: Set by user.
1051 * - decoding: unused
1055 * macroblock comparison function (not supported yet)
1056 * - encoding: Set by user.
1057 * - decoding: unused
1061 * interlaced DCT comparison function
1062 * - encoding: Set by user.
1063 * - decoding: unused
1066 #define FF_CMP_SAD 0
1067 #define FF_CMP_SSE 1
1068 #define FF_CMP_SATD 2
1069 #define FF_CMP_DCT 3
1070 #define FF_CMP_PSNR 4
1071 #define FF_CMP_BIT 5
1073 #define FF_CMP_ZERO 7
1074 #define FF_CMP_VSAD 8
1075 #define FF_CMP_VSSE 9
1076 #define FF_CMP_NSSE 10
1077 #define FF_CMP_W53 11
1078 #define FF_CMP_W97 12
1079 #define FF_CMP_DCTMAX 13
1080 #define FF_CMP_DCT264 14
1081 #define FF_CMP_MEDIAN_SAD 15
1082 #define FF_CMP_CHROMA 256
1085 * ME diamond size & shape
1086 * - encoding: Set by user.
1087 * - decoding: unused
1092 * amount of previous MV predictors (2a+1 x 2a+1 square)
1093 * - encoding: Set by user.
1094 * - decoding: unused
1096 int last_predictor_count;
1098 #if FF_API_PRIVATE_OPT
1099 /** @deprecated use encoder private options instead */
1100 attribute_deprecated
1105 * motion estimation prepass comparison function
1106 * - encoding: Set by user.
1107 * - decoding: unused
1112 * ME prepass diamond size & shape
1113 * - encoding: Set by user.
1114 * - decoding: unused
1120 * - encoding: Set by user.
1121 * - decoding: unused
1123 int me_subpel_quality;
1126 * maximum motion estimation search range in subpel units
1127 * If 0 then no limit.
1129 * - encoding: Set by user.
1130 * - decoding: unused
1136 * - encoding: unused
1137 * - decoding: Set by user.
1140 #define SLICE_FLAG_CODED_ORDER 0x0001 ///< draw_horiz_band() is called in coded order instead of display
1141 #define SLICE_FLAG_ALLOW_FIELD 0x0002 ///< allow draw_horiz_band() with field slices (MPEG-2 field pics)
1142 #define SLICE_FLAG_ALLOW_PLANE 0x0004 ///< allow draw_horiz_band() with 1 component at a time (SVQ1)
1145 * macroblock decision mode
1146 * - encoding: Set by user.
1147 * - decoding: unused
1150 #define FF_MB_DECISION_SIMPLE 0 ///< uses mb_cmp
1151 #define FF_MB_DECISION_BITS 1 ///< chooses the one which needs the fewest bits
1152 #define FF_MB_DECISION_RD 2 ///< rate distortion
1155 * custom intra quantization matrix
1156 * Must be allocated with the av_malloc() family of functions, and will be freed in
1157 * avcodec_free_context().
1158 * - encoding: Set/allocated by user, freed by libavcodec. Can be NULL.
1159 * - decoding: Set/allocated/freed by libavcodec.
1161 uint16_t *intra_matrix;
1164 * custom inter quantization matrix
1165 * Must be allocated with the av_malloc() family of functions, and will be freed in
1166 * avcodec_free_context().
1167 * - encoding: Set/allocated by user, freed by libavcodec. Can be NULL.
1168 * - decoding: Set/allocated/freed by libavcodec.
1170 uint16_t *inter_matrix;
1172 #if FF_API_PRIVATE_OPT
1173 /** @deprecated use encoder private options instead */
1174 attribute_deprecated
1175 int scenechange_threshold;
1177 /** @deprecated use encoder private options instead */
1178 attribute_deprecated
1179 int noise_reduction;
1183 * precision of the intra DC coefficient - 8
1184 * - encoding: Set by user.
1185 * - decoding: Set by libavcodec
1187 int intra_dc_precision;
1190 * Number of macroblock rows at the top which are skipped.
1191 * - encoding: unused
1192 * - decoding: Set by user.
1197 * Number of macroblock rows at the bottom which are skipped.
1198 * - encoding: unused
1199 * - decoding: Set by user.
1204 * minimum MB Lagrange multiplier
1205 * - encoding: Set by user.
1206 * - decoding: unused
1211 * maximum MB Lagrange multiplier
1212 * - encoding: Set by user.
1213 * - decoding: unused
1217 #if FF_API_PRIVATE_OPT
1219 * @deprecated use encoder private options instead
1221 attribute_deprecated
1222 int me_penalty_compensation;
1226 * - encoding: Set by user.
1227 * - decoding: unused
1231 #if FF_API_PRIVATE_OPT
1232 /** @deprecated use encoder private options instead */
1233 attribute_deprecated
1239 * - encoding: Set by user.
1240 * - decoding: unused
1245 * number of reference frames
1246 * - encoding: Set by user.
1247 * - decoding: Set by lavc.
1251 #if FF_API_PRIVATE_OPT
1252 /** @deprecated use encoder private options instead */
1253 attribute_deprecated
1258 * Note: Value depends upon the compare function used for fullpel ME.
1259 * - encoding: Set by user.
1260 * - decoding: unused
1264 #if FF_API_PRIVATE_OPT
1265 /** @deprecated use encoder private options instead */
1266 attribute_deprecated
1271 * Chromaticity coordinates of the source primaries.
1272 * - encoding: Set by user
1273 * - decoding: Set by libavcodec
1275 enum AVColorPrimaries color_primaries;
1278 * Color Transfer Characteristic.
1279 * - encoding: Set by user
1280 * - decoding: Set by libavcodec
1282 enum AVColorTransferCharacteristic color_trc;
1285 * YUV colorspace type.
1286 * - encoding: Set by user
1287 * - decoding: Set by libavcodec
1289 enum AVColorSpace colorspace;
1292 * MPEG vs JPEG YUV range.
1293 * - encoding: Set by user
1294 * - decoding: Set by libavcodec
1296 enum AVColorRange color_range;
1299 * This defines the location of chroma samples.
1300 * - encoding: Set by user
1301 * - decoding: Set by libavcodec
1303 enum AVChromaLocation chroma_sample_location;
1307 * Indicates number of picture subdivisions. Used for parallelized
1309 * - encoding: Set by user
1310 * - decoding: unused
1315 * - encoding: set by libavcodec
1316 * - decoding: Set by user.
1318 enum AVFieldOrder field_order;
1321 int sample_rate; ///< samples per second
1322 int channels; ///< number of audio channels
1325 * audio sample format
1326 * - encoding: Set by user.
1327 * - decoding: Set by libavcodec.
1329 enum AVSampleFormat sample_fmt; ///< sample format
1331 /* The following data should not be initialized. */
1333 * Number of samples per channel in an audio frame.
1335 * - encoding: set by libavcodec in avcodec_open2(). Each submitted frame
1336 * except the last must contain exactly frame_size samples per channel.
1337 * May be 0 when the codec has AV_CODEC_CAP_VARIABLE_FRAME_SIZE set, then the
1338 * frame size is not restricted.
1339 * - decoding: may be set by some decoders to indicate constant frame size
1344 * Frame counter, set by libavcodec.
1346 * - decoding: total number of frames returned from the decoder so far.
1347 * - encoding: total number of frames passed to the encoder so far.
1349 * @note the counter is not incremented if encoding/decoding resulted in
1355 * number of bytes per packet if constant and known or 0
1356 * Used by some WAV based audio codecs.
1361 * Audio cutoff bandwidth (0 means "automatic")
1362 * - encoding: Set by user.
1363 * - decoding: unused
1368 * Audio channel layout.
1369 * - encoding: set by user.
1370 * - decoding: set by user, may be overwritten by libavcodec.
1372 uint64_t channel_layout;
1375 * Request decoder to use this channel layout if it can (0 for default)
1376 * - encoding: unused
1377 * - decoding: Set by user.
1379 uint64_t request_channel_layout;
1382 * Type of service that the audio stream conveys.
1383 * - encoding: Set by user.
1384 * - decoding: Set by libavcodec.
1386 enum AVAudioServiceType audio_service_type;
1389 * desired sample format
1390 * - encoding: Not used.
1391 * - decoding: Set by user.
1392 * Decoder will decode to this format if it can.
1394 enum AVSampleFormat request_sample_fmt;
1397 * This callback is called at the beginning of each frame to get data
1398 * buffer(s) for it. There may be one contiguous buffer for all the data or
1399 * there may be a buffer per each data plane or anything in between. What
1400 * this means is, you may set however many entries in buf[] you feel necessary.
1401 * Each buffer must be reference-counted using the AVBuffer API (see description
1404 * The following fields will be set in the frame before this callback is
1407 * - width, height (video only)
1408 * - sample_rate, channel_layout, nb_samples (audio only)
1409 * Their values may differ from the corresponding values in
1410 * AVCodecContext. This callback must use the frame values, not the codec
1411 * context values, to calculate the required buffer size.
1413 * This callback must fill the following fields in the frame:
1417 * * if the data is planar audio with more than 8 channels, then this
1418 * callback must allocate and fill extended_data to contain all pointers
1419 * to all data planes. data[] must hold as many pointers as it can.
1420 * extended_data must be allocated with av_malloc() and will be freed in
1422 * * otherwise extended_data must point to data
1423 * - buf[] must contain one or more pointers to AVBufferRef structures. Each of
1424 * the frame's data and extended_data pointers must be contained in these. That
1425 * is, one AVBufferRef for each allocated chunk of memory, not necessarily one
1426 * AVBufferRef per data[] entry. See: av_buffer_create(), av_buffer_alloc(),
1427 * and av_buffer_ref().
1428 * - extended_buf and nb_extended_buf must be allocated with av_malloc() by
1429 * this callback and filled with the extra buffers if there are more
1430 * buffers than buf[] can hold. extended_buf will be freed in
1433 * If AV_CODEC_CAP_DR1 is not set then get_buffer2() must call
1434 * avcodec_default_get_buffer2() instead of providing buffers allocated by
1437 * Each data plane must be aligned to the maximum required by the target
1440 * @see avcodec_default_get_buffer2()
1444 * If AV_GET_BUFFER_FLAG_REF is set in flags then the frame may be reused
1445 * (read and/or written to if it is writable) later by libavcodec.
1447 * avcodec_align_dimensions2() should be used to find the required width and
1448 * height, as they normally need to be rounded up to the next multiple of 16.
1450 * Some decoders do not support linesizes changing between frames.
1452 * If frame multithreading is used and thread_safe_callbacks is set,
1453 * this callback may be called from a different thread, but not from more
1454 * than one at once. Does not need to be reentrant.
1456 * @see avcodec_align_dimensions2()
1460 * Decoders request a buffer of a particular size by setting
1461 * AVFrame.nb_samples prior to calling get_buffer2(). The decoder may,
1462 * however, utilize only part of the buffer by setting AVFrame.nb_samples
1463 * to a smaller value in the output frame.
1465 * As a convenience, av_samples_get_buffer_size() and
1466 * av_samples_fill_arrays() in libavutil may be used by custom get_buffer2()
1467 * functions to find the required data size and to fill data pointers and
1468 * linesize. In AVFrame.linesize, only linesize[0] may be set for audio
1469 * since all planes must be the same size.
1471 * @see av_samples_get_buffer_size(), av_samples_fill_arrays()
1473 * - encoding: unused
1474 * - decoding: Set by libavcodec, user can override.
1476 int (*get_buffer2)(struct AVCodecContext *s, AVFrame *frame, int flags);
1479 * If non-zero, the decoded audio and video frames returned from
1480 * avcodec_decode_video2() and avcodec_decode_audio4() are reference-counted
1481 * and are valid indefinitely. The caller must free them with
1482 * av_frame_unref() when they are not needed anymore.
1483 * Otherwise, the decoded frames must not be freed by the caller and are
1484 * only valid until the next decode call.
1486 * This is always automatically enabled if avcodec_receive_frame() is used.
1488 * - encoding: unused
1489 * - decoding: set by the caller before avcodec_open2().
1491 attribute_deprecated
1492 int refcounted_frames;
1494 /* - encoding parameters */
1495 float qcompress; ///< amount of qscale change between easy & hard scenes (0.0-1.0)
1496 float qblur; ///< amount of qscale smoothing over time (0.0-1.0)
1500 * - encoding: Set by user.
1501 * - decoding: unused
1507 * - encoding: Set by user.
1508 * - decoding: unused
1513 * maximum quantizer difference between frames
1514 * - encoding: Set by user.
1515 * - decoding: unused
1520 * decoder bitstream buffer size
1521 * - encoding: Set by user.
1522 * - decoding: unused
1527 * ratecontrol override, see RcOverride
1528 * - encoding: Allocated/set/freed by user.
1529 * - decoding: unused
1531 int rc_override_count;
1532 RcOverride *rc_override;
1536 * - encoding: Set by user.
1537 * - decoding: Set by user, may be overwritten by libavcodec.
1539 int64_t rc_max_rate;
1543 * - encoding: Set by user.
1544 * - decoding: unused
1546 int64_t rc_min_rate;
1549 * Ratecontrol attempt to use, at maximum, <value> of what can be used without an underflow.
1550 * - encoding: Set by user.
1551 * - decoding: unused.
1553 float rc_max_available_vbv_use;
1556 * Ratecontrol attempt to use, at least, <value> times the amount needed to prevent a vbv overflow.
1557 * - encoding: Set by user.
1558 * - decoding: unused.
1560 float rc_min_vbv_overflow_use;
1563 * Number of bits which should be loaded into the rc buffer before decoding starts.
1564 * - encoding: Set by user.
1565 * - decoding: unused
1567 int rc_initial_buffer_occupancy;
1569 #if FF_API_CODER_TYPE
1570 #define FF_CODER_TYPE_VLC 0
1571 #define FF_CODER_TYPE_AC 1
1572 #define FF_CODER_TYPE_RAW 2
1573 #define FF_CODER_TYPE_RLE 3
1575 * @deprecated use encoder private options instead
1577 attribute_deprecated
1579 #endif /* FF_API_CODER_TYPE */
1581 #if FF_API_PRIVATE_OPT
1582 /** @deprecated use encoder private options instead */
1583 attribute_deprecated
1587 #if FF_API_PRIVATE_OPT
1588 /** @deprecated use encoder private options instead */
1589 attribute_deprecated
1590 int frame_skip_threshold;
1592 /** @deprecated use encoder private options instead */
1593 attribute_deprecated
1594 int frame_skip_factor;
1596 /** @deprecated use encoder private options instead */
1597 attribute_deprecated
1600 /** @deprecated use encoder private options instead */
1601 attribute_deprecated
1603 #endif /* FF_API_PRIVATE_OPT */
1606 * trellis RD quantization
1607 * - encoding: Set by user.
1608 * - decoding: unused
1612 #if FF_API_PRIVATE_OPT
1613 /** @deprecated use encoder private options instead */
1614 attribute_deprecated
1615 int min_prediction_order;
1617 /** @deprecated use encoder private options instead */
1618 attribute_deprecated
1619 int max_prediction_order;
1621 /** @deprecated use encoder private options instead */
1622 attribute_deprecated
1623 int64_t timecode_frame_start;
1626 #if FF_API_RTP_CALLBACK
1628 * @deprecated unused
1630 /* The RTP callback: This function is called */
1631 /* every time the encoder has a packet to send. */
1632 /* It depends on the encoder if the data starts */
1633 /* with a Start Code (it should). H.263 does. */
1634 /* mb_nb contains the number of macroblocks */
1635 /* encoded in the RTP payload. */
1636 attribute_deprecated
1637 void (*rtp_callback)(struct AVCodecContext *avctx, void *data, int size, int mb_nb);
1640 #if FF_API_PRIVATE_OPT
1641 /** @deprecated use encoder private options instead */
1642 attribute_deprecated
1643 int rtp_payload_size; /* The size of the RTP payload: the coder will */
1644 /* do its best to deliver a chunk with size */
1645 /* below rtp_payload_size, the chunk will start */
1646 /* with a start code on some codecs like H.263. */
1647 /* This doesn't take account of any particular */
1648 /* headers inside the transmitted RTP payload. */
1651 #if FF_API_STAT_BITS
1652 /* statistics, used for 2-pass encoding */
1653 attribute_deprecated
1655 attribute_deprecated
1657 attribute_deprecated
1659 attribute_deprecated
1661 attribute_deprecated
1663 attribute_deprecated
1665 attribute_deprecated
1667 attribute_deprecated
1670 /** @deprecated this field is unused */
1671 attribute_deprecated
1676 * pass1 encoding statistics output buffer
1677 * - encoding: Set by libavcodec.
1678 * - decoding: unused
1683 * pass2 encoding statistics input buffer
1684 * Concatenated stuff from stats_out of pass1 should be placed here.
1685 * - encoding: Allocated/set/freed by user.
1686 * - decoding: unused
1691 * Work around bugs in encoders which sometimes cannot be detected automatically.
1692 * - encoding: Set by user
1693 * - decoding: Set by user
1695 int workaround_bugs;
1696 #define FF_BUG_AUTODETECT 1 ///< autodetection
1697 #define FF_BUG_XVID_ILACE 4
1698 #define FF_BUG_UMP4 8
1699 #define FF_BUG_NO_PADDING 16
1700 #define FF_BUG_AMV 32
1701 #define FF_BUG_QPEL_CHROMA 64
1702 #define FF_BUG_STD_QPEL 128
1703 #define FF_BUG_QPEL_CHROMA2 256
1704 #define FF_BUG_DIRECT_BLOCKSIZE 512
1705 #define FF_BUG_EDGE 1024
1706 #define FF_BUG_HPEL_CHROMA 2048
1707 #define FF_BUG_DC_CLIP 4096
1708 #define FF_BUG_MS 8192 ///< Work around various bugs in Microsoft's broken decoders.
1709 #define FF_BUG_TRUNCATED 16384
1710 #define FF_BUG_IEDGE 32768
1713 * strictly follow the standard (MPEG-4, ...).
1714 * - encoding: Set by user.
1715 * - decoding: Set by user.
1716 * Setting this to STRICT or higher means the encoder and decoder will
1717 * generally do stupid things, whereas setting it to unofficial or lower
1718 * will mean the encoder might produce output that is not supported by all
1719 * spec-compliant decoders. Decoders don't differentiate between normal,
1720 * unofficial and experimental (that is, they always try to decode things
1721 * when they can) unless they are explicitly asked to behave stupidly
1722 * (=strictly conform to the specs)
1724 int strict_std_compliance;
1725 #define FF_COMPLIANCE_VERY_STRICT 2 ///< Strictly conform to an older more strict version of the spec or reference software.
1726 #define FF_COMPLIANCE_STRICT 1 ///< Strictly conform to all the things in the spec no matter what consequences.
1727 #define FF_COMPLIANCE_NORMAL 0
1728 #define FF_COMPLIANCE_UNOFFICIAL -1 ///< Allow unofficial extensions
1729 #define FF_COMPLIANCE_EXPERIMENTAL -2 ///< Allow nonstandardized experimental things.
1732 * error concealment flags
1733 * - encoding: unused
1734 * - decoding: Set by user.
1736 int error_concealment;
1737 #define FF_EC_GUESS_MVS 1
1738 #define FF_EC_DEBLOCK 2
1739 #define FF_EC_FAVOR_INTER 256
1743 * - encoding: Set by user.
1744 * - decoding: Set by user.
1747 #define FF_DEBUG_PICT_INFO 1
1748 #define FF_DEBUG_RC 2
1749 #define FF_DEBUG_BITSTREAM 4
1750 #define FF_DEBUG_MB_TYPE 8
1751 #define FF_DEBUG_QP 16
1754 * @deprecated this option does nothing
1756 #define FF_DEBUG_MV 32
1758 #define FF_DEBUG_DCT_COEFF 0x00000040
1759 #define FF_DEBUG_SKIP 0x00000080
1760 #define FF_DEBUG_STARTCODE 0x00000100
1761 #define FF_DEBUG_ER 0x00000400
1762 #define FF_DEBUG_MMCO 0x00000800
1763 #define FF_DEBUG_BUGS 0x00001000
1765 #define FF_DEBUG_VIS_QP 0x00002000
1766 #define FF_DEBUG_VIS_MB_TYPE 0x00004000
1768 #define FF_DEBUG_BUFFERS 0x00008000
1769 #define FF_DEBUG_THREADS 0x00010000
1770 #define FF_DEBUG_GREEN_MD 0x00800000
1771 #define FF_DEBUG_NOMC 0x01000000
1776 * - encoding: Set by user.
1777 * - decoding: Set by user.
1780 #define FF_DEBUG_VIS_MV_P_FOR 0x00000001 // visualize forward predicted MVs of P-frames
1781 #define FF_DEBUG_VIS_MV_B_FOR 0x00000002 // visualize forward predicted MVs of B-frames
1782 #define FF_DEBUG_VIS_MV_B_BACK 0x00000004 // visualize backward predicted MVs of B-frames
1786 * Error recognition; may misdetect some more or less valid parts as errors.
1787 * - encoding: unused
1788 * - decoding: Set by user.
1790 int err_recognition;
1793 * Verify checksums embedded in the bitstream (could be of either encoded or
1794 * decoded data, depending on the codec) and print an error message on mismatch.
1795 * If AV_EF_EXPLODE is also set, a mismatching checksum will result in the
1796 * decoder returning an error.
1798 #define AV_EF_CRCCHECK (1<<0)
1799 #define AV_EF_BITSTREAM (1<<1) ///< detect bitstream specification deviations
1800 #define AV_EF_BUFFER (1<<2) ///< detect improper bitstream length
1801 #define AV_EF_EXPLODE (1<<3) ///< abort decoding on minor error detection
1803 #define AV_EF_IGNORE_ERR (1<<15) ///< ignore errors and continue
1804 #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
1805 #define AV_EF_COMPLIANT (1<<17) ///< consider all spec non compliances as errors
1806 #define AV_EF_AGGRESSIVE (1<<18) ///< consider things that a sane encoder should not do as an error
1810 * opaque 64-bit number (generally a PTS) that will be reordered and
1811 * output in AVFrame.reordered_opaque
1812 * - encoding: Set by libavcodec to the reordered_opaque of the input
1813 * frame corresponding to the last returned packet. Only
1814 * supported by encoders with the
1815 * AV_CODEC_CAP_ENCODER_REORDERED_OPAQUE capability.
1816 * - decoding: Set by user.
1818 int64_t reordered_opaque;
1821 * Hardware accelerator in use
1822 * - encoding: unused.
1823 * - decoding: Set by libavcodec
1825 const struct AVHWAccel *hwaccel;
1828 * Hardware accelerator context.
1829 * For some hardware accelerators, a global context needs to be
1830 * provided by the user. In that case, this holds display-dependent
1831 * data FFmpeg cannot instantiate itself. Please refer to the
1832 * FFmpeg HW accelerator documentation to know how to fill this
1833 * is. e.g. for VA API, this is a struct vaapi_context.
1834 * - encoding: unused
1835 * - decoding: Set by user
1837 void *hwaccel_context;
1841 * - encoding: Set by libavcodec if flags & AV_CODEC_FLAG_PSNR.
1842 * - decoding: unused
1844 uint64_t error[AV_NUM_DATA_POINTERS];
1847 * DCT algorithm, see FF_DCT_* below
1848 * - encoding: Set by user.
1849 * - decoding: unused
1852 #define FF_DCT_AUTO 0
1853 #define FF_DCT_FASTINT 1
1854 #define FF_DCT_INT 2
1855 #define FF_DCT_MMX 3
1856 #define FF_DCT_ALTIVEC 5
1857 #define FF_DCT_FAAN 6
1860 * IDCT algorithm, see FF_IDCT_* below.
1861 * - encoding: Set by user.
1862 * - decoding: Set by user.
1865 #define FF_IDCT_AUTO 0
1866 #define FF_IDCT_INT 1
1867 #define FF_IDCT_SIMPLE 2
1868 #define FF_IDCT_SIMPLEMMX 3
1869 #define FF_IDCT_ARM 7
1870 #define FF_IDCT_ALTIVEC 8
1871 #define FF_IDCT_SIMPLEARM 10
1872 #define FF_IDCT_XVID 14
1873 #define FF_IDCT_SIMPLEARMV5TE 16
1874 #define FF_IDCT_SIMPLEARMV6 17
1875 #define FF_IDCT_FAAN 20
1876 #define FF_IDCT_SIMPLENEON 22
1877 #define FF_IDCT_NONE 24 /* Used by XvMC to extract IDCT coefficients with FF_IDCT_PERM_NONE */
1878 #define FF_IDCT_SIMPLEAUTO 128
1881 * bits per sample/pixel from the demuxer (needed for huffyuv).
1882 * - encoding: Set by libavcodec.
1883 * - decoding: Set by user.
1885 int bits_per_coded_sample;
1888 * Bits per sample/pixel of internal libavcodec pixel/sample format.
1889 * - encoding: set by user.
1890 * - decoding: set by libavcodec.
1892 int bits_per_raw_sample;
1896 * low resolution decoding, 1-> 1/2 size, 2->1/4 size
1897 * - encoding: unused
1898 * - decoding: Set by user.
1903 #if FF_API_CODED_FRAME
1905 * the picture in the bitstream
1906 * - encoding: Set by libavcodec.
1907 * - decoding: unused
1909 * @deprecated use the quality factor packet side data instead
1911 attribute_deprecated AVFrame *coded_frame;
1916 * is used to decide how many independent tasks should be passed to execute()
1917 * - encoding: Set by user.
1918 * - decoding: Set by user.
1923 * Which multithreading methods to use.
1924 * Use of FF_THREAD_FRAME will increase decoding delay by one frame per thread,
1925 * so clients which cannot provide future frames should not use it.
1927 * - encoding: Set by user, otherwise the default is used.
1928 * - decoding: Set by user, otherwise the default is used.
1931 #define FF_THREAD_FRAME 1 ///< Decode more than one frame at once
1932 #define FF_THREAD_SLICE 2 ///< Decode more than one part of a single frame at once
1935 * Which multithreading methods are in use by the codec.
1936 * - encoding: Set by libavcodec.
1937 * - decoding: Set by libavcodec.
1939 int active_thread_type;
1942 * Set by the client if its custom get_buffer() callback can be called
1943 * synchronously from another thread, which allows faster multithreaded decoding.
1944 * draw_horiz_band() will be called from other threads regardless of this setting.
1945 * Ignored if the default get_buffer() is used.
1946 * - encoding: Set by user.
1947 * - decoding: Set by user.
1949 int thread_safe_callbacks;
1952 * The codec may call this to execute several independent things.
1953 * It will return only after finishing all tasks.
1954 * The user may replace this with some multithreaded implementation,
1955 * the default implementation will execute the parts serially.
1956 * @param count the number of things to execute
1957 * - encoding: Set by libavcodec, user can override.
1958 * - decoding: Set by libavcodec, user can override.
1960 int (*execute)(struct AVCodecContext *c, int (*func)(struct AVCodecContext *c2, void *arg), void *arg2, int *ret, int count, int size);
1963 * The codec may call this to execute several independent things.
1964 * It will return only after finishing all tasks.
1965 * The user may replace this with some multithreaded implementation,
1966 * the default implementation will execute the parts serially.
1967 * Also see avcodec_thread_init and e.g. the --enable-pthread configure option.
1968 * @param c context passed also to func
1969 * @param count the number of things to execute
1970 * @param arg2 argument passed unchanged to func
1971 * @param ret return values of executed functions, must have space for "count" values. May be NULL.
1972 * @param func function that will be called count times, with jobnr from 0 to count-1.
1973 * threadnr will be in the range 0 to c->thread_count-1 < MAX_THREADS and so that no
1974 * two instances of func executing at the same time will have the same threadnr.
1975 * @return always 0 currently, but code should handle a future improvement where when any call to func
1976 * returns < 0 no further calls to func may be done and < 0 is returned.
1977 * - encoding: Set by libavcodec, user can override.
1978 * - decoding: Set by libavcodec, user can override.
1980 int (*execute2)(struct AVCodecContext *c, int (*func)(struct AVCodecContext *c2, void *arg, int jobnr, int threadnr), void *arg2, int *ret, int count);
1983 * noise vs. sse weight for the nsse comparison function
1984 * - encoding: Set by user.
1985 * - decoding: unused
1991 * - encoding: Set by user.
1992 * - decoding: Set by libavcodec.
1995 #define FF_PROFILE_UNKNOWN -99
1996 #define FF_PROFILE_RESERVED -100
1998 #define FF_PROFILE_AAC_MAIN 0
1999 #define FF_PROFILE_AAC_LOW 1
2000 #define FF_PROFILE_AAC_SSR 2
2001 #define FF_PROFILE_AAC_LTP 3
2002 #define FF_PROFILE_AAC_HE 4
2003 #define FF_PROFILE_AAC_HE_V2 28
2004 #define FF_PROFILE_AAC_LD 22
2005 #define FF_PROFILE_AAC_ELD 38
2006 #define FF_PROFILE_MPEG2_AAC_LOW 128
2007 #define FF_PROFILE_MPEG2_AAC_HE 131
2009 #define FF_PROFILE_DNXHD 0
2010 #define FF_PROFILE_DNXHR_LB 1
2011 #define FF_PROFILE_DNXHR_SQ 2
2012 #define FF_PROFILE_DNXHR_HQ 3
2013 #define FF_PROFILE_DNXHR_HQX 4
2014 #define FF_PROFILE_DNXHR_444 5
2016 #define FF_PROFILE_DTS 20
2017 #define FF_PROFILE_DTS_ES 30
2018 #define FF_PROFILE_DTS_96_24 40
2019 #define FF_PROFILE_DTS_HD_HRA 50
2020 #define FF_PROFILE_DTS_HD_MA 60
2021 #define FF_PROFILE_DTS_EXPRESS 70
2023 #define FF_PROFILE_MPEG2_422 0
2024 #define FF_PROFILE_MPEG2_HIGH 1
2025 #define FF_PROFILE_MPEG2_SS 2
2026 #define FF_PROFILE_MPEG2_SNR_SCALABLE 3
2027 #define FF_PROFILE_MPEG2_MAIN 4
2028 #define FF_PROFILE_MPEG2_SIMPLE 5
2030 #define FF_PROFILE_H264_CONSTRAINED (1<<9) // 8+1; constraint_set1_flag
2031 #define FF_PROFILE_H264_INTRA (1<<11) // 8+3; constraint_set3_flag
2033 #define FF_PROFILE_H264_BASELINE 66
2034 #define FF_PROFILE_H264_CONSTRAINED_BASELINE (66|FF_PROFILE_H264_CONSTRAINED)
2035 #define FF_PROFILE_H264_MAIN 77
2036 #define FF_PROFILE_H264_EXTENDED 88
2037 #define FF_PROFILE_H264_HIGH 100
2038 #define FF_PROFILE_H264_HIGH_10 110
2039 #define FF_PROFILE_H264_HIGH_10_INTRA (110|FF_PROFILE_H264_INTRA)
2040 #define FF_PROFILE_H264_MULTIVIEW_HIGH 118
2041 #define FF_PROFILE_H264_HIGH_422 122
2042 #define FF_PROFILE_H264_HIGH_422_INTRA (122|FF_PROFILE_H264_INTRA)
2043 #define FF_PROFILE_H264_STEREO_HIGH 128
2044 #define FF_PROFILE_H264_HIGH_444 144
2045 #define FF_PROFILE_H264_HIGH_444_PREDICTIVE 244
2046 #define FF_PROFILE_H264_HIGH_444_INTRA (244|FF_PROFILE_H264_INTRA)
2047 #define FF_PROFILE_H264_CAVLC_444 44
2049 #define FF_PROFILE_VC1_SIMPLE 0
2050 #define FF_PROFILE_VC1_MAIN 1
2051 #define FF_PROFILE_VC1_COMPLEX 2
2052 #define FF_PROFILE_VC1_ADVANCED 3
2054 #define FF_PROFILE_MPEG4_SIMPLE 0
2055 #define FF_PROFILE_MPEG4_SIMPLE_SCALABLE 1
2056 #define FF_PROFILE_MPEG4_CORE 2
2057 #define FF_PROFILE_MPEG4_MAIN 3
2058 #define FF_PROFILE_MPEG4_N_BIT 4
2059 #define FF_PROFILE_MPEG4_SCALABLE_TEXTURE 5
2060 #define FF_PROFILE_MPEG4_SIMPLE_FACE_ANIMATION 6
2061 #define FF_PROFILE_MPEG4_BASIC_ANIMATED_TEXTURE 7
2062 #define FF_PROFILE_MPEG4_HYBRID 8
2063 #define FF_PROFILE_MPEG4_ADVANCED_REAL_TIME 9
2064 #define FF_PROFILE_MPEG4_CORE_SCALABLE 10
2065 #define FF_PROFILE_MPEG4_ADVANCED_CODING 11
2066 #define FF_PROFILE_MPEG4_ADVANCED_CORE 12
2067 #define FF_PROFILE_MPEG4_ADVANCED_SCALABLE_TEXTURE 13
2068 #define FF_PROFILE_MPEG4_SIMPLE_STUDIO 14
2069 #define FF_PROFILE_MPEG4_ADVANCED_SIMPLE 15
2071 #define FF_PROFILE_JPEG2000_CSTREAM_RESTRICTION_0 1
2072 #define FF_PROFILE_JPEG2000_CSTREAM_RESTRICTION_1 2
2073 #define FF_PROFILE_JPEG2000_CSTREAM_NO_RESTRICTION 32768
2074 #define FF_PROFILE_JPEG2000_DCINEMA_2K 3
2075 #define FF_PROFILE_JPEG2000_DCINEMA_4K 4
2077 #define FF_PROFILE_VP9_0 0
2078 #define FF_PROFILE_VP9_1 1
2079 #define FF_PROFILE_VP9_2 2
2080 #define FF_PROFILE_VP9_3 3
2082 #define FF_PROFILE_HEVC_MAIN 1
2083 #define FF_PROFILE_HEVC_MAIN_10 2
2084 #define FF_PROFILE_HEVC_MAIN_STILL_PICTURE 3
2085 #define FF_PROFILE_HEVC_REXT 4
2087 #define FF_PROFILE_AV1_MAIN 0
2088 #define FF_PROFILE_AV1_HIGH 1
2089 #define FF_PROFILE_AV1_PROFESSIONAL 2
2091 #define FF_PROFILE_MJPEG_HUFFMAN_BASELINE_DCT 0xc0
2092 #define FF_PROFILE_MJPEG_HUFFMAN_EXTENDED_SEQUENTIAL_DCT 0xc1
2093 #define FF_PROFILE_MJPEG_HUFFMAN_PROGRESSIVE_DCT 0xc2
2094 #define FF_PROFILE_MJPEG_HUFFMAN_LOSSLESS 0xc3
2095 #define FF_PROFILE_MJPEG_JPEG_LS 0xf7
2097 #define FF_PROFILE_SBC_MSBC 1
2099 #define FF_PROFILE_PRORES_PROXY 0
2100 #define FF_PROFILE_PRORES_LT 1
2101 #define FF_PROFILE_PRORES_STANDARD 2
2102 #define FF_PROFILE_PRORES_HQ 3
2103 #define FF_PROFILE_PRORES_4444 4
2104 #define FF_PROFILE_PRORES_XQ 5
2106 #define FF_PROFILE_ARIB_PROFILE_A 0
2107 #define FF_PROFILE_ARIB_PROFILE_C 1
2111 * - encoding: Set by user.
2112 * - decoding: Set by libavcodec.
2115 #define FF_LEVEL_UNKNOWN -99
2118 * Skip loop filtering for selected frames.
2119 * - encoding: unused
2120 * - decoding: Set by user.
2122 enum AVDiscard skip_loop_filter;
2125 * Skip IDCT/dequantization for selected frames.
2126 * - encoding: unused
2127 * - decoding: Set by user.
2129 enum AVDiscard skip_idct;
2132 * Skip decoding for selected frames.
2133 * - encoding: unused
2134 * - decoding: Set by user.
2136 enum AVDiscard skip_frame;
2139 * Header containing style information for text subtitles.
2140 * For SUBTITLE_ASS subtitle type, it should contain the whole ASS
2141 * [Script Info] and [V4+ Styles] section, plus the [Events] line and
2142 * the Format line following. It shouldn't include any Dialogue line.
2143 * - encoding: Set/allocated/freed by user (before avcodec_open2())
2144 * - decoding: Set/allocated/freed by libavcodec (by avcodec_open2())
2146 uint8_t *subtitle_header;
2147 int subtitle_header_size;
2149 #if FF_API_VBV_DELAY
2151 * VBV delay coded in the last frame (in periods of a 27 MHz clock).
2152 * Used for compliant TS muxing.
2153 * - encoding: Set by libavcodec.
2154 * - decoding: unused.
2155 * @deprecated this value is now exported as a part of
2156 * AV_PKT_DATA_CPB_PROPERTIES packet side data
2158 attribute_deprecated
2162 #if FF_API_SIDEDATA_ONLY_PKT
2164 * Encoding only and set by default. Allow encoders to output packets
2165 * that do not contain any encoded data, only side data.
2167 * Some encoders need to output such packets, e.g. to update some stream
2168 * parameters at the end of encoding.
2170 * @deprecated this field disables the default behaviour and
2171 * it is kept only for compatibility.
2173 attribute_deprecated
2174 int side_data_only_packets;
2178 * Audio only. The number of "priming" samples (padding) inserted by the
2179 * encoder at the beginning of the audio. I.e. this number of leading
2180 * decoded samples must be discarded by the caller to get the original audio
2181 * without leading padding.
2183 * - decoding: unused
2184 * - encoding: Set by libavcodec. The timestamps on the output packets are
2185 * adjusted by the encoder so that they always refer to the
2186 * first sample of the data actually contained in the packet,
2187 * including any added padding. E.g. if the timebase is
2188 * 1/samplerate and the timestamp of the first input sample is
2189 * 0, the timestamp of the first output packet will be
2192 int initial_padding;
2195 * - decoding: For codecs that store a framerate value in the compressed
2196 * bitstream, the decoder may export it here. { 0, 1} when
2198 * - encoding: May be used to signal the framerate of CFR content to an
2201 AVRational framerate;
2204 * Nominal unaccelerated pixel format, see AV_PIX_FMT_xxx.
2205 * - encoding: unused.
2206 * - decoding: Set by libavcodec before calling get_format()
2208 enum AVPixelFormat sw_pix_fmt;
2211 * Timebase in which pkt_dts/pts and AVPacket.dts/pts are.
2212 * - encoding unused.
2213 * - decoding set by user.
2215 AVRational pkt_timebase;
2219 * - encoding: unused.
2220 * - decoding: set by libavcodec.
2222 const AVCodecDescriptor *codec_descriptor;
2226 * low resolution decoding, 1-> 1/2 size, 2->1/4 size
2227 * - encoding: unused
2228 * - decoding: Set by user.
2234 * Current statistics for PTS correction.
2235 * - decoding: maintained and used by libavcodec, not intended to be used by user apps
2236 * - encoding: unused
2238 int64_t pts_correction_num_faulty_pts; /// Number of incorrect PTS values so far
2239 int64_t pts_correction_num_faulty_dts; /// Number of incorrect DTS values so far
2240 int64_t pts_correction_last_pts; /// PTS of the last frame
2241 int64_t pts_correction_last_dts; /// DTS of the last frame
2244 * Character encoding of the input subtitles file.
2245 * - decoding: set by user
2246 * - encoding: unused
2251 * Subtitles character encoding mode. Formats or codecs might be adjusting
2252 * this setting (if they are doing the conversion themselves for instance).
2253 * - decoding: set by libavcodec
2254 * - encoding: unused
2256 int sub_charenc_mode;
2257 #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)
2258 #define FF_SUB_CHARENC_MODE_AUTOMATIC 0 ///< libavcodec will select the mode itself
2259 #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
2260 #define FF_SUB_CHARENC_MODE_IGNORE 2 ///< neither convert the subtitles, nor check them for valid UTF-8
2263 * Skip processing alpha if supported by codec.
2264 * Note that if the format uses pre-multiplied alpha (common with VP6,
2265 * and recommended due to better video quality/compression)
2266 * the image will look as if alpha-blended onto a black background.
2267 * However for formats that do not use pre-multiplied alpha
2268 * there might be serious artefacts (though e.g. libswscale currently
2269 * assumes pre-multiplied alpha anyway).
2271 * - decoding: set by user
2272 * - encoding: unused
2277 * Number of samples to skip after a discontinuity
2278 * - decoding: unused
2279 * - encoding: set by libavcodec
2283 #if !FF_API_DEBUG_MV
2285 * debug motion vectors
2286 * - encoding: Set by user.
2287 * - decoding: Set by user.
2290 #define FF_DEBUG_VIS_MV_P_FOR 0x00000001 //visualize forward predicted MVs of P frames
2291 #define FF_DEBUG_VIS_MV_B_FOR 0x00000002 //visualize forward predicted MVs of B frames
2292 #define FF_DEBUG_VIS_MV_B_BACK 0x00000004 //visualize backward predicted MVs of B frames
2296 * custom intra quantization matrix
2297 * - encoding: Set by user, can be NULL.
2298 * - decoding: unused.
2300 uint16_t *chroma_intra_matrix;
2303 * dump format separator.
2304 * can be ", " or "\n " or anything else
2305 * - encoding: Set by user.
2306 * - decoding: Set by user.
2308 uint8_t *dump_separator;
2311 * ',' separated list of allowed decoders.
2312 * If NULL then all are allowed
2313 * - encoding: unused
2314 * - decoding: set by user
2316 char *codec_whitelist;
2319 * Properties of the stream that gets decoded
2320 * - encoding: unused
2321 * - decoding: set by libavcodec
2323 unsigned properties;
2324 #define FF_CODEC_PROPERTY_LOSSLESS 0x00000001
2325 #define FF_CODEC_PROPERTY_CLOSED_CAPTIONS 0x00000002
2328 * Additional data associated with the entire coded stream.
2330 * - decoding: unused
2331 * - encoding: may be set by libavcodec after avcodec_open2().
2333 AVPacketSideData *coded_side_data;
2334 int nb_coded_side_data;
2337 * A reference to the AVHWFramesContext describing the input (for encoding)
2338 * or output (decoding) frames. The reference is set by the caller and
2339 * afterwards owned (and freed) by libavcodec - it should never be read by
2340 * the caller after being set.
2342 * - decoding: This field should be set by the caller from the get_format()
2343 * callback. The previous reference (if any) will always be
2344 * unreffed by libavcodec before the get_format() call.
2346 * If the default get_buffer2() is used with a hwaccel pixel
2347 * format, then this AVHWFramesContext will be used for
2348 * allocating the frame buffers.
2350 * - encoding: For hardware encoders configured to use a hwaccel pixel
2351 * format, this field should be set by the caller to a reference
2352 * to the AVHWFramesContext describing input frames.
2353 * AVHWFramesContext.format must be equal to
2354 * AVCodecContext.pix_fmt.
2356 * This field should be set before avcodec_open2() is called.
2358 AVBufferRef *hw_frames_ctx;
2361 * Control the form of AVSubtitle.rects[N]->ass
2362 * - decoding: set by user
2363 * - encoding: unused
2365 int sub_text_format;
2366 #define FF_SUB_TEXT_FMT_ASS 0
2367 #if FF_API_ASS_TIMING
2368 #define FF_SUB_TEXT_FMT_ASS_WITH_TIMINGS 1
2372 * Audio only. The amount of padding (in samples) appended by the encoder to
2373 * the end of the audio. I.e. this number of decoded samples must be
2374 * discarded by the caller from the end of the stream to get the original
2375 * audio without any trailing padding.
2377 * - decoding: unused
2378 * - encoding: unused
2380 int trailing_padding;
2383 * The number of pixels per image to maximally accept.
2385 * - decoding: set by user
2386 * - encoding: set by user
2391 * A reference to the AVHWDeviceContext describing the device which will
2392 * be used by a hardware encoder/decoder. The reference is set by the
2393 * caller and afterwards owned (and freed) by libavcodec.
2395 * This should be used if either the codec device does not require
2396 * hardware frames or any that are used are to be allocated internally by
2397 * libavcodec. If the user wishes to supply any of the frames used as
2398 * encoder input or decoder output then hw_frames_ctx should be used
2399 * instead. When hw_frames_ctx is set in get_format() for a decoder, this
2400 * field will be ignored while decoding the associated stream segment, but
2401 * may again be used on a following one after another get_format() call.
2403 * For both encoders and decoders this field should be set before
2404 * avcodec_open2() is called and must not be written to thereafter.
2406 * Note that some decoders may require this field to be set initially in
2407 * order to support hw_frames_ctx at all - in that case, all frames
2408 * contexts used must be created on the same device.
2410 AVBufferRef *hw_device_ctx;
2413 * Bit set of AV_HWACCEL_FLAG_* flags, which affect hardware accelerated
2414 * decoding (if active).
2415 * - encoding: unused
2416 * - decoding: Set by user (either before avcodec_open2(), or in the
2417 * AVCodecContext.get_format callback)
2422 * Video decoding only. Certain video codecs support cropping, meaning that
2423 * only a sub-rectangle of the decoded frame is intended for display. This
2424 * option controls how cropping is handled by libavcodec.
2426 * When set to 1 (the default), libavcodec will apply cropping internally.
2427 * I.e. it will modify the output frame width/height fields and offset the
2428 * data pointers (only by as much as possible while preserving alignment, or
2429 * by the full amount if the AV_CODEC_FLAG_UNALIGNED flag is set) so that
2430 * the frames output by the decoder refer only to the cropped area. The
2431 * crop_* fields of the output frames will be zero.
2433 * When set to 0, the width/height fields of the output frames will be set
2434 * to the coded dimensions and the crop_* fields will describe the cropping
2435 * rectangle. Applying the cropping is left to the caller.
2437 * @warning When hardware acceleration with opaque output frames is used,
2438 * libavcodec is unable to apply cropping from the top/left border.
2440 * @note when this option is set to zero, the width/height fields of the
2441 * AVCodecContext and output AVFrames have different meanings. The codec
2442 * context fields store display dimensions (with the coded dimensions in
2443 * coded_width/height), while the frame fields store the coded dimensions
2444 * (with the display dimensions being determined by the crop_* fields).
2449 * Video decoding only. Sets the number of extra hardware frames which
2450 * the decoder will allocate for use by the caller. This must be set
2451 * before avcodec_open2() is called.
2453 * Some hardware decoders require all frames that they will use for
2454 * output to be defined in advance before decoding starts. For such
2455 * decoders, the hardware frame pool must therefore be of a fixed size.
2456 * The extra frames set here are on top of any number that the decoder
2457 * needs internally in order to operate normally (for example, frames
2458 * used as reference pictures).
2460 int extra_hw_frames;
2463 * The percentage of damaged samples to discard a frame.
2465 * - decoding: set by user
2466 * - encoding: unused
2468 int discard_damaged_percentage;
2471 * The number of samples per frame to maximally accept.
2473 * - decoding: set by user
2474 * - encoding: set by user
2476 int64_t max_samples;
2479 * Bit set of AV_CODEC_EXPORT_DATA_* flags, which affects the kind of
2480 * metadata exported in frame, packet, or coded stream side data by
2481 * decoders and encoders.
2483 * - decoding: set by user
2484 * - encoding: set by user
2486 int export_side_data;
2489 #if FF_API_CODEC_GET_SET
2491 * Accessors for some AVCodecContext fields. These used to be provided for ABI
2492 * compatibility, and do not need to be used anymore.
2494 attribute_deprecated
2495 AVRational av_codec_get_pkt_timebase (const AVCodecContext *avctx);
2496 attribute_deprecated
2497 void av_codec_set_pkt_timebase (AVCodecContext *avctx, AVRational val);
2499 attribute_deprecated
2500 const AVCodecDescriptor *av_codec_get_codec_descriptor(const AVCodecContext *avctx);
2501 attribute_deprecated
2502 void av_codec_set_codec_descriptor(AVCodecContext *avctx, const AVCodecDescriptor *desc);
2504 attribute_deprecated
2505 unsigned av_codec_get_codec_properties(const AVCodecContext *avctx);
2508 attribute_deprecated
2509 int av_codec_get_lowres(const AVCodecContext *avctx);
2510 attribute_deprecated
2511 void av_codec_set_lowres(AVCodecContext *avctx, int val);
2514 attribute_deprecated
2515 int av_codec_get_seek_preroll(const AVCodecContext *avctx);
2516 attribute_deprecated
2517 void av_codec_set_seek_preroll(AVCodecContext *avctx, int val);
2519 attribute_deprecated
2520 uint16_t *av_codec_get_chroma_intra_matrix(const AVCodecContext *avctx);
2521 attribute_deprecated
2522 void av_codec_set_chroma_intra_matrix(AVCodecContext *avctx, uint16_t *val);
2528 typedef struct AVProfile {
2530 const char *name; ///< short name for the profile
2535 * The codec supports this format via the hw_device_ctx interface.
2537 * When selecting this format, AVCodecContext.hw_device_ctx should
2538 * have been set to a device of the specified type before calling
2541 AV_CODEC_HW_CONFIG_METHOD_HW_DEVICE_CTX = 0x01,
2543 * The codec supports this format via the hw_frames_ctx interface.
2545 * When selecting this format for a decoder,
2546 * AVCodecContext.hw_frames_ctx should be set to a suitable frames
2547 * context inside the get_format() callback. The frames context
2548 * must have been created on a device of the specified type.
2550 * When selecting this format for an encoder,
2551 * AVCodecContext.hw_frames_ctx should be set to the context which
2552 * will be used for the input frames before calling avcodec_open2().
2554 AV_CODEC_HW_CONFIG_METHOD_HW_FRAMES_CTX = 0x02,
2556 * The codec supports this format by some internal method.
2558 * This format can be selected without any additional configuration -
2559 * no device or frames context is required.
2561 AV_CODEC_HW_CONFIG_METHOD_INTERNAL = 0x04,
2563 * The codec supports this format by some ad-hoc method.
2565 * Additional settings and/or function calls are required. See the
2566 * codec-specific documentation for details. (Methods requiring
2567 * this sort of configuration are deprecated and others should be
2568 * used in preference.)
2570 AV_CODEC_HW_CONFIG_METHOD_AD_HOC = 0x08,
2573 typedef struct AVCodecHWConfig {
2575 * For decoders, a hardware pixel format which that decoder may be
2576 * able to decode to if suitable hardware is available.
2578 * For encoders, a pixel format which the encoder may be able to
2579 * accept. If set to AV_PIX_FMT_NONE, this applies to all pixel
2580 * formats supported by the codec.
2582 enum AVPixelFormat pix_fmt;
2584 * Bit set of AV_CODEC_HW_CONFIG_METHOD_* flags, describing the possible
2585 * setup methods which can be used with this configuration.
2589 * The device type associated with the configuration.
2591 * Must be set for AV_CODEC_HW_CONFIG_METHOD_HW_DEVICE_CTX and
2592 * AV_CODEC_HW_CONFIG_METHOD_HW_FRAMES_CTX, otherwise unused.
2594 enum AVHWDeviceType device_type;
2597 typedef struct AVCodecDefault AVCodecDefault;
2604 typedef struct AVCodec {
2606 * Name of the codec implementation.
2607 * The name is globally unique among encoders and among decoders (but an
2608 * encoder and a decoder can share the same name).
2609 * This is the primary way to find a codec from the user perspective.
2613 * Descriptive name for the codec, meant to be more human readable than name.
2614 * You should use the NULL_IF_CONFIG_SMALL() macro to define it.
2616 const char *long_name;
2617 enum AVMediaType type;
2620 * Codec capabilities.
2621 * see AV_CODEC_CAP_*
2624 const AVRational *supported_framerates; ///< array of supported framerates, or NULL if any, array is terminated by {0,0}
2625 const enum AVPixelFormat *pix_fmts; ///< array of supported pixel formats, or NULL if unknown, array is terminated by -1
2626 const int *supported_samplerates; ///< array of supported audio samplerates, or NULL if unknown, array is terminated by 0
2627 const enum AVSampleFormat *sample_fmts; ///< array of supported sample formats, or NULL if unknown, array is terminated by -1
2628 const uint64_t *channel_layouts; ///< array of support channel layouts, or NULL if unknown. array is terminated by 0
2629 uint8_t max_lowres; ///< maximum value for lowres supported by the decoder
2630 const AVClass *priv_class; ///< AVClass for the private context
2631 const AVProfile *profiles; ///< array of recognized profiles, or NULL if unknown, array is terminated by {FF_PROFILE_UNKNOWN}
2634 * Group name of the codec implementation.
2635 * This is a short symbolic name of the wrapper backing this codec. A
2636 * wrapper uses some kind of external implementation for the codec, such
2637 * as an external library, or a codec implementation provided by the OS or
2639 * If this field is NULL, this is a builtin, libavcodec native codec.
2640 * If non-NULL, this will be the suffix in AVCodec.name in most cases
2641 * (usually AVCodec.name will be of the form "<codec_name>_<wrapper_name>").
2643 const char *wrapper_name;
2645 /*****************************************************************
2646 * No fields below this line are part of the public API. They
2647 * may not be used outside of libavcodec and can be changed and
2649 * New public fields should be added right above.
2650 *****************************************************************
2653 struct AVCodec *next;
2655 * @name Frame-level threading support functions
2659 * Copy necessary context variables from a previous thread context to the current one.
2660 * If not defined, the next thread will start automatically; otherwise, the codec
2661 * must call ff_thread_finish_setup().
2663 * dst and src will (rarely) point to the same context, in which case memcpy should be skipped.
2665 int (*update_thread_context)(AVCodecContext *dst, const AVCodecContext *src);
2669 * Private codec-specific defaults.
2671 const AVCodecDefault *defaults;
2674 * Initialize codec static data, called from avcodec_register().
2676 * This is not intended for time consuming operations as it is
2677 * run for every codec regardless of that codec being used.
2679 void (*init_static_data)(struct AVCodec *codec);
2681 int (*init)(AVCodecContext *);
2682 int (*encode_sub)(AVCodecContext *, uint8_t *buf, int buf_size,
2683 const struct AVSubtitle *sub);
2685 * Encode data to an AVPacket.
2687 * @param avctx codec context
2688 * @param avpkt output AVPacket (may contain a user-provided buffer)
2689 * @param[in] frame AVFrame containing the raw data to be encoded
2690 * @param[out] got_packet_ptr encoder sets to 0 or 1 to indicate that a
2691 * non-empty packet was returned in avpkt.
2692 * @return 0 on success, negative error code on failure
2694 int (*encode2)(AVCodecContext *avctx, AVPacket *avpkt, const AVFrame *frame,
2695 int *got_packet_ptr);
2696 int (*decode)(AVCodecContext *, void *outdata, int *outdata_size, AVPacket *avpkt);
2697 int (*close)(AVCodecContext *);
2699 * Encode API with decoupled packet/frame dataflow. The API is the
2700 * same as the avcodec_ prefixed APIs (avcodec_send_frame() etc.), except
2702 * - never called if the codec is closed or the wrong type,
2703 * - if AV_CODEC_CAP_DELAY is not set, drain frames are never sent,
2704 * - only one drain frame is ever passed down,
2706 int (*send_frame)(AVCodecContext *avctx, const AVFrame *frame);
2707 int (*receive_packet)(AVCodecContext *avctx, AVPacket *avpkt);
2710 * Decode API with decoupled packet/frame dataflow. This function is called
2711 * to get one output frame. It should call ff_decode_get_packet() to obtain
2714 int (*receive_frame)(AVCodecContext *avctx, AVFrame *frame);
2717 * Will be called when seeking
2719 void (*flush)(AVCodecContext *);
2721 * Internal codec capabilities.
2722 * See FF_CODEC_CAP_* in internal.h
2727 * Decoding only, a comma-separated list of bitstream filters to apply to
2728 * packets before decoding.
2733 * Array of pointers to hardware configurations supported by the codec,
2734 * or NULL if no hardware supported. The array is terminated by a NULL
2737 * The user can only access this field via avcodec_get_hw_config().
2739 const struct AVCodecHWConfigInternal **hw_configs;
2742 * List of supported codec_tags, terminated by FF_CODEC_TAGS_END.
2744 const uint32_t *codec_tags;
2747 #if FF_API_CODEC_GET_SET
2748 attribute_deprecated
2749 int av_codec_get_max_lowres(const AVCodec *codec);
2752 struct MpegEncContext;
2755 * Retrieve supported hardware configurations for a codec.
2757 * Values of index from zero to some maximum return the indexed configuration
2758 * descriptor; all other values return NULL. If the codec does not support
2759 * any hardware configurations then it will always return NULL.
2761 const AVCodecHWConfig *avcodec_get_hw_config(const AVCodec *codec, int index);
2764 * @defgroup lavc_hwaccel AVHWAccel
2766 * @note Nothing in this structure should be accessed by the user. At some
2767 * point in future it will not be externally visible at all.
2771 typedef struct AVHWAccel {
2773 * Name of the hardware accelerated codec.
2774 * The name is globally unique among encoders and among decoders (but an
2775 * encoder and a decoder can share the same name).
2780 * Type of codec implemented by the hardware accelerator.
2782 * See AVMEDIA_TYPE_xxx
2784 enum AVMediaType type;
2787 * Codec implemented by the hardware accelerator.
2789 * See AV_CODEC_ID_xxx
2794 * Supported pixel format.
2796 * Only hardware accelerated formats are supported here.
2798 enum AVPixelFormat pix_fmt;
2801 * Hardware accelerated codec capabilities.
2802 * see AV_HWACCEL_CODEC_CAP_*
2806 /*****************************************************************
2807 * No fields below this line are part of the public API. They
2808 * may not be used outside of libavcodec and can be changed and
2810 * New public fields should be added right above.
2811 *****************************************************************
2815 * Allocate a custom buffer
2817 int (*alloc_frame)(AVCodecContext *avctx, AVFrame *frame);
2820 * Called at the beginning of each frame or field picture.
2822 * Meaningful frame information (codec specific) is guaranteed to
2823 * be parsed at this point. This function is mandatory.
2825 * Note that buf can be NULL along with buf_size set to 0.
2826 * Otherwise, this means the whole frame is available at this point.
2828 * @param avctx the codec context
2829 * @param buf the frame data buffer base
2830 * @param buf_size the size of the frame in bytes
2831 * @return zero if successful, a negative value otherwise
2833 int (*start_frame)(AVCodecContext *avctx, const uint8_t *buf, uint32_t buf_size);
2836 * Callback for parameter data (SPS/PPS/VPS etc).
2838 * Useful for hardware decoders which keep persistent state about the
2839 * video parameters, and need to receive any changes to update that state.
2841 * @param avctx the codec context
2842 * @param type the nal unit type
2843 * @param buf the nal unit data buffer
2844 * @param buf_size the size of the nal unit in bytes
2845 * @return zero if successful, a negative value otherwise
2847 int (*decode_params)(AVCodecContext *avctx, int type, const uint8_t *buf, uint32_t buf_size);
2850 * Callback for each slice.
2852 * Meaningful slice information (codec specific) is guaranteed to
2853 * be parsed at this point. This function is mandatory.
2854 * The only exception is XvMC, that works on MB level.
2856 * @param avctx the codec context
2857 * @param buf the slice data buffer base
2858 * @param buf_size the size of the slice in bytes
2859 * @return zero if successful, a negative value otherwise
2861 int (*decode_slice)(AVCodecContext *avctx, const uint8_t *buf, uint32_t buf_size);
2864 * Called at the end of each frame or field picture.
2866 * The whole picture is parsed at this point and can now be sent
2867 * to the hardware accelerator. This function is mandatory.
2869 * @param avctx the codec context
2870 * @return zero if successful, a negative value otherwise
2872 int (*end_frame)(AVCodecContext *avctx);
2875 * Size of per-frame hardware accelerator private data.
2877 * Private data is allocated with av_mallocz() before
2878 * AVCodecContext.get_buffer() and deallocated after
2879 * AVCodecContext.release_buffer().
2881 int frame_priv_data_size;
2884 * Called for every Macroblock in a slice.
2886 * XvMC uses it to replace the ff_mpv_reconstruct_mb().
2887 * Instead of decoding to raw picture, MB parameters are
2888 * stored in an array provided by the video driver.
2890 * @param s the mpeg context
2892 void (*decode_mb)(struct MpegEncContext *s);
2895 * Initialize the hwaccel private data.
2897 * This will be called from ff_get_format(), after hwaccel and
2898 * hwaccel_context are set and the hwaccel private data in AVCodecInternal
2901 int (*init)(AVCodecContext *avctx);
2904 * Uninitialize the hwaccel private data.
2906 * This will be called from get_format() or avcodec_close(), after hwaccel
2907 * and hwaccel_context are already uninitialized.
2909 int (*uninit)(AVCodecContext *avctx);
2912 * Size of the private data to allocate in
2913 * AVCodecInternal.hwaccel_priv_data.
2918 * Internal hwaccel capabilities.
2923 * Fill the given hw_frames context with current codec parameters. Called
2924 * from get_format. Refer to avcodec_get_hw_frames_parameters() for
2927 * This CAN be called before AVHWAccel.init is called, and you must assume
2928 * that avctx->hwaccel_priv_data is invalid.
2930 int (*frame_params)(AVCodecContext *avctx, AVBufferRef *hw_frames_ctx);
2934 * HWAccel is experimental and is thus avoided in favor of non experimental
2937 #define AV_HWACCEL_CODEC_CAP_EXPERIMENTAL 0x0200
2940 * Hardware acceleration should be used for decoding even if the codec level
2941 * used is unknown or higher than the maximum supported level reported by the
2944 * It's generally a good idea to pass this flag unless you have a specific
2945 * reason not to, as hardware tends to under-report supported levels.
2947 #define AV_HWACCEL_FLAG_IGNORE_LEVEL (1 << 0)
2950 * Hardware acceleration can output YUV pixel formats with a different chroma
2951 * sampling than 4:2:0 and/or other than 8 bits per component.
2953 #define AV_HWACCEL_FLAG_ALLOW_HIGH_DEPTH (1 << 1)
2956 * Hardware acceleration should still be attempted for decoding when the
2957 * codec profile does not match the reported capabilities of the hardware.
2959 * For example, this can be used to try to decode baseline profile H.264
2960 * streams in hardware - it will often succeed, because many streams marked
2961 * as baseline profile actually conform to constrained baseline profile.
2963 * @warning If the stream is actually not supported then the behaviour is
2964 * undefined, and may include returning entirely incorrect output
2965 * while indicating success.
2967 #define AV_HWACCEL_FLAG_ALLOW_PROFILE_MISMATCH (1 << 2)
2973 #if FF_API_AVPICTURE
2975 * @defgroup lavc_picture AVPicture
2977 * Functions for working with AVPicture
2982 * Picture data structure.
2984 * Up to four components can be stored into it, the last component is
2986 * @deprecated use AVFrame or imgutils functions instead
2988 typedef struct AVPicture {
2989 attribute_deprecated
2990 uint8_t *data[AV_NUM_DATA_POINTERS]; ///< pointers to the image data planes
2991 attribute_deprecated
2992 int linesize[AV_NUM_DATA_POINTERS]; ///< number of bytes per line
3000 enum AVSubtitleType {
3003 SUBTITLE_BITMAP, ///< A bitmap, pict will be set
3006 * Plain text, the text field must be set by the decoder and is
3007 * authoritative. ass and pict fields may contain approximations.
3012 * Formatted text, the ass field must be set by the decoder and is
3013 * authoritative. pict and text fields may contain approximations.
3018 #define AV_SUBTITLE_FLAG_FORCED 0x00000001
3020 typedef struct AVSubtitleRect {
3021 int x; ///< top left corner of pict, undefined when pict is not set
3022 int y; ///< top left corner of pict, undefined when pict is not set
3023 int w; ///< width of pict, undefined when pict is not set
3024 int h; ///< height of pict, undefined when pict is not set
3025 int nb_colors; ///< number of colors in pict, undefined when pict is not set
3027 #if FF_API_AVPICTURE
3029 * @deprecated unused
3031 attribute_deprecated
3035 * data+linesize for the bitmap of this subtitle.
3036 * Can be set for text/ass as well once they are rendered.
3041 enum AVSubtitleType type;
3043 char *text; ///< 0 terminated plain UTF-8 text
3046 * 0 terminated ASS/SSA compatible event line.
3047 * The presentation of this is unaffected by the other values in this
3055 typedef struct AVSubtitle {
3056 uint16_t format; /* 0 = graphics */
3057 uint32_t start_display_time; /* relative to packet pts, in ms */
3058 uint32_t end_display_time; /* relative to packet pts, in ms */
3060 AVSubtitleRect **rects;
3061 int64_t pts; ///< Same as packet pts, in AV_TIME_BASE
3065 * This struct describes the properties of an encoded stream.
3067 * sizeof(AVCodecParameters) is not a part of the public ABI, this struct must
3068 * be allocated with avcodec_parameters_alloc() and freed with
3069 * avcodec_parameters_free().
3071 typedef struct AVCodecParameters {
3073 * General type of the encoded data.
3075 enum AVMediaType codec_type;
3077 * Specific type of the encoded data (the codec used).
3079 enum AVCodecID codec_id;
3081 * Additional information about the codec (corresponds to the AVI FOURCC).
3086 * Extra binary data needed for initializing the decoder, codec-dependent.
3088 * Must be allocated with av_malloc() and will be freed by
3089 * avcodec_parameters_free(). The allocated size of extradata must be at
3090 * least extradata_size + AV_INPUT_BUFFER_PADDING_SIZE, with the padding
3095 * Size of the extradata content in bytes.
3100 * - video: the pixel format, the value corresponds to enum AVPixelFormat.
3101 * - audio: the sample format, the value corresponds to enum AVSampleFormat.
3106 * The average bitrate of the encoded data (in bits per second).
3111 * The number of bits per sample in the codedwords.
3113 * This is basically the bitrate per sample. It is mandatory for a bunch of
3114 * formats to actually decode them. It's the number of bits for one sample in
3115 * the actual coded bitstream.
3117 * This could be for example 4 for ADPCM
3118 * For PCM formats this matches bits_per_raw_sample
3121 int bits_per_coded_sample;
3124 * This is the number of valid bits in each output sample. If the
3125 * sample format has more bits, the least significant bits are additional
3126 * padding bits, which are always 0. Use right shifts to reduce the sample
3127 * to its actual size. For example, audio formats with 24 bit samples will
3128 * have bits_per_raw_sample set to 24, and format set to AV_SAMPLE_FMT_S32.
3129 * To get the original sample use "(int32_t)sample >> 8"."
3131 * For ADPCM this might be 12 or 16 or similar
3134 int bits_per_raw_sample;
3137 * Codec-specific bitstream restrictions that the stream conforms to.
3143 * Video only. The dimensions of the video frame in pixels.
3149 * Video only. The aspect ratio (width / height) which a single pixel
3150 * should have when displayed.
3152 * When the aspect ratio is unknown / undefined, the numerator should be
3153 * set to 0 (the denominator may have any value).
3155 AVRational sample_aspect_ratio;
3158 * Video only. The order of the fields in interlaced video.
3160 enum AVFieldOrder field_order;
3163 * Video only. Additional colorspace characteristics.
3165 enum AVColorRange color_range;
3166 enum AVColorPrimaries color_primaries;
3167 enum AVColorTransferCharacteristic color_trc;
3168 enum AVColorSpace color_space;
3169 enum AVChromaLocation chroma_location;
3172 * Video only. Number of delayed frames.
3177 * Audio only. The channel layout bitmask. May be 0 if the channel layout is
3178 * unknown or unspecified, otherwise the number of bits set must be equal to
3179 * the channels field.
3181 uint64_t channel_layout;
3183 * Audio only. The number of audio channels.
3187 * Audio only. The number of audio samples per second.
3191 * Audio only. The number of bytes per coded audio frame, required by some
3194 * Corresponds to nBlockAlign in WAVEFORMATEX.
3198 * Audio only. Audio frame size, if known. Required by some formats to be static.
3203 * Audio only. The amount of padding (in samples) inserted by the encoder at
3204 * the beginning of the audio. I.e. this number of leading decoded samples
3205 * must be discarded by the caller to get the original audio without leading
3208 int initial_padding;
3210 * Audio only. The amount of padding (in samples) appended by the encoder to
3211 * the end of the audio. I.e. this number of decoded samples must be
3212 * discarded by the caller from the end of the stream to get the original
3213 * audio without any trailing padding.
3215 int trailing_padding;
3217 * Audio only. Number of samples to skip after a discontinuity.
3220 } AVCodecParameters;
3223 * Iterate over all registered codecs.
3225 * @param opaque a pointer where libavcodec will store the iteration state. Must
3226 * point to NULL to start the iteration.
3228 * @return the next registered codec or NULL when the iteration is
3231 const AVCodec *av_codec_iterate(void **opaque);
3235 * If c is NULL, returns the first registered codec,
3236 * if c is non-NULL, returns the next registered codec after c,
3237 * or NULL if c is the last one.
3239 attribute_deprecated
3240 AVCodec *av_codec_next(const AVCodec *c);
3244 * Return the LIBAVCODEC_VERSION_INT constant.
3246 unsigned avcodec_version(void);
3249 * Return the libavcodec build-time configuration.
3251 const char *avcodec_configuration(void);
3254 * Return the libavcodec license.
3256 const char *avcodec_license(void);
3260 * Register the codec codec and initialize libavcodec.
3262 * @warning either this function or avcodec_register_all() must be called
3263 * before any other libavcodec functions.
3265 * @see avcodec_register_all()
3267 attribute_deprecated
3268 void avcodec_register(AVCodec *codec);
3271 * Register all the codecs, parsers and bitstream filters which were enabled at
3272 * configuration time. If you do not call this function you can select exactly
3273 * which formats you want to support, by using the individual registration
3276 * @see avcodec_register
3277 * @see av_register_codec_parser
3278 * @see av_register_bitstream_filter
3280 attribute_deprecated
3281 void avcodec_register_all(void);
3285 * Allocate an AVCodecContext and set its fields to default values. The
3286 * resulting struct should be freed with avcodec_free_context().
3288 * @param codec if non-NULL, allocate private data and initialize defaults
3289 * for the given codec. It is illegal to then call avcodec_open2()
3290 * with a different codec.
3291 * If NULL, then the codec-specific defaults won't be initialized,
3292 * which may result in suboptimal default settings (this is
3293 * important mainly for encoders, e.g. libx264).
3295 * @return An AVCodecContext filled with default values or NULL on failure.
3297 AVCodecContext *avcodec_alloc_context3(const AVCodec *codec);
3300 * Free the codec context and everything associated with it and write NULL to
3301 * the provided pointer.
3303 void avcodec_free_context(AVCodecContext **avctx);
3305 #if FF_API_GET_CONTEXT_DEFAULTS
3307 * @deprecated This function should not be used, as closing and opening a codec
3308 * context multiple time is not supported. A new codec context should be
3309 * allocated for each new use.
3311 int avcodec_get_context_defaults3(AVCodecContext *s, const AVCodec *codec);
3315 * Get the AVClass for AVCodecContext. It can be used in combination with
3316 * AV_OPT_SEARCH_FAKE_OBJ for examining options.
3318 * @see av_opt_find().
3320 const AVClass *avcodec_get_class(void);
3322 #if FF_API_COPY_CONTEXT
3324 * Get the AVClass for AVFrame. It can be used in combination with
3325 * AV_OPT_SEARCH_FAKE_OBJ for examining options.
3327 * @see av_opt_find().
3329 const AVClass *avcodec_get_frame_class(void);
3332 * Get the AVClass for AVSubtitleRect. It can be used in combination with
3333 * AV_OPT_SEARCH_FAKE_OBJ for examining options.
3335 * @see av_opt_find().
3337 const AVClass *avcodec_get_subtitle_rect_class(void);
3340 * Copy the settings of the source AVCodecContext into the destination
3341 * AVCodecContext. The resulting destination codec context will be
3342 * unopened, i.e. you are required to call avcodec_open2() before you
3343 * can use this AVCodecContext to decode/encode video/audio data.
3345 * @param dest target codec context, should be initialized with
3346 * avcodec_alloc_context3(NULL), but otherwise uninitialized
3347 * @param src source codec context
3348 * @return AVERROR() on error (e.g. memory allocation error), 0 on success
3350 * @deprecated The semantics of this function are ill-defined and it should not
3351 * be used. If you need to transfer the stream parameters from one codec context
3352 * to another, use an intermediate AVCodecParameters instance and the
3353 * avcodec_parameters_from_context() / avcodec_parameters_to_context()
3356 attribute_deprecated
3357 int avcodec_copy_context(AVCodecContext *dest, const AVCodecContext *src);
3361 * Allocate a new AVCodecParameters and set its fields to default values
3362 * (unknown/invalid/0). The returned struct must be freed with
3363 * avcodec_parameters_free().
3365 AVCodecParameters *avcodec_parameters_alloc(void);
3368 * Free an AVCodecParameters instance and everything associated with it and
3369 * write NULL to the supplied pointer.
3371 void avcodec_parameters_free(AVCodecParameters **par);
3374 * Copy the contents of src to dst. Any allocated fields in dst are freed and
3375 * replaced with newly allocated duplicates of the corresponding fields in src.
3377 * @return >= 0 on success, a negative AVERROR code on failure.
3379 int avcodec_parameters_copy(AVCodecParameters *dst, const AVCodecParameters *src);
3382 * Fill the parameters struct based on the values from the supplied codec
3383 * context. Any allocated fields in par are freed and replaced with duplicates
3384 * of the corresponding fields in codec.
3386 * @return >= 0 on success, a negative AVERROR code on failure
3388 int avcodec_parameters_from_context(AVCodecParameters *par,
3389 const AVCodecContext *codec);
3392 * Fill the codec context based on the values from the supplied codec
3393 * parameters. Any allocated fields in codec that have a corresponding field in
3394 * par are freed and replaced with duplicates of the corresponding field in par.
3395 * Fields in codec that do not have a counterpart in par are not touched.
3397 * @return >= 0 on success, a negative AVERROR code on failure.
3399 int avcodec_parameters_to_context(AVCodecContext *codec,
3400 const AVCodecParameters *par);
3403 * Initialize the AVCodecContext to use the given AVCodec. Prior to using this
3404 * function the context has to be allocated with avcodec_alloc_context3().
3406 * The functions avcodec_find_decoder_by_name(), avcodec_find_encoder_by_name(),
3407 * avcodec_find_decoder() and avcodec_find_encoder() provide an easy way for
3408 * retrieving a codec.
3410 * @warning This function is not thread safe!
3412 * @note Always call this function before using decoding routines (such as
3413 * @ref avcodec_receive_frame()).
3416 * avcodec_register_all();
3417 * av_dict_set(&opts, "b", "2.5M", 0);
3418 * codec = avcodec_find_decoder(AV_CODEC_ID_H264);
3422 * context = avcodec_alloc_context3(codec);
3424 * if (avcodec_open2(context, codec, opts) < 0)
3428 * @param avctx The context to initialize.
3429 * @param codec The codec to open this context for. If a non-NULL codec has been
3430 * previously passed to avcodec_alloc_context3() or
3431 * for this context, then this parameter MUST be either NULL or
3432 * equal to the previously passed codec.
3433 * @param options A dictionary filled with AVCodecContext and codec-private options.
3434 * On return this object will be filled with options that were not found.
3436 * @return zero on success, a negative value on error
3437 * @see avcodec_alloc_context3(), avcodec_find_decoder(), avcodec_find_encoder(),
3438 * av_dict_set(), av_opt_find().
3440 int avcodec_open2(AVCodecContext *avctx, const AVCodec *codec, AVDictionary **options);
3443 * Close a given AVCodecContext and free all the data associated with it
3444 * (but not the AVCodecContext itself).
3446 * Calling this function on an AVCodecContext that hasn't been opened will free
3447 * the codec-specific data allocated in avcodec_alloc_context3() with a non-NULL
3448 * codec. Subsequent calls will do nothing.
3450 * @note Do not use this function. Use avcodec_free_context() to destroy a
3451 * codec context (either open or closed). Opening and closing a codec context
3452 * multiple times is not supported anymore -- use multiple codec contexts
3455 int avcodec_close(AVCodecContext *avctx);
3458 * Free all allocated data in the given subtitle struct.
3460 * @param sub AVSubtitle to free.
3462 void avsubtitle_free(AVSubtitle *sub);
3469 * @addtogroup lavc_decoding
3474 * Find a registered decoder with a matching codec ID.
3476 * @param id AVCodecID of the requested decoder
3477 * @return A decoder if one was found, NULL otherwise.
3479 AVCodec *avcodec_find_decoder(enum AVCodecID id);
3482 * Find a registered decoder with the specified name.
3484 * @param name name of the requested decoder
3485 * @return A decoder if one was found, NULL otherwise.
3487 AVCodec *avcodec_find_decoder_by_name(const char *name);
3490 * The default callback for AVCodecContext.get_buffer2(). It is made public so
3491 * it can be called by custom get_buffer2() implementations for decoders without
3492 * AV_CODEC_CAP_DR1 set.
3494 int avcodec_default_get_buffer2(AVCodecContext *s, AVFrame *frame, int flags);
3497 * Modify width and height values so that they will result in a memory
3498 * buffer that is acceptable for the codec if you do not use any horizontal
3501 * May only be used if a codec with AV_CODEC_CAP_DR1 has been opened.
3503 void avcodec_align_dimensions(AVCodecContext *s, int *width, int *height);
3506 * Modify width and height values so that they will result in a memory
3507 * buffer that is acceptable for the codec if you also ensure that all
3508 * line sizes are a multiple of the respective linesize_align[i].
3510 * May only be used if a codec with AV_CODEC_CAP_DR1 has been opened.
3512 void avcodec_align_dimensions2(AVCodecContext *s, int *width, int *height,
3513 int linesize_align[AV_NUM_DATA_POINTERS]);
3516 * Converts AVChromaLocation to swscale x/y chroma position.
3518 * The positions represent the chroma (0,0) position in a coordinates system
3519 * with luma (0,0) representing the origin and luma(1,1) representing 256,256
3521 * @param xpos horizontal chroma sample position
3522 * @param ypos vertical chroma sample position
3524 int avcodec_enum_to_chroma_pos(int *xpos, int *ypos, enum AVChromaLocation pos);
3527 * Converts swscale x/y chroma position to AVChromaLocation.
3529 * The positions represent the chroma (0,0) position in a coordinates system
3530 * with luma (0,0) representing the origin and luma(1,1) representing 256,256
3532 * @param xpos horizontal chroma sample position
3533 * @param ypos vertical chroma sample position
3535 enum AVChromaLocation avcodec_chroma_pos_to_enum(int xpos, int ypos);
3538 * Decode the audio frame of size avpkt->size from avpkt->data into frame.
3540 * Some decoders may support multiple frames in a single AVPacket. Such
3541 * decoders would then just decode the first frame and the return value would be
3542 * less than the packet size. In this case, avcodec_decode_audio4 has to be
3543 * called again with an AVPacket containing the remaining data in order to
3544 * decode the second frame, etc... Even if no frames are returned, the packet
3545 * needs to be fed to the decoder with remaining data until it is completely
3546 * consumed or an error occurs.
3548 * Some decoders (those marked with AV_CODEC_CAP_DELAY) have a delay between input
3549 * and output. This means that for some packets they will not immediately
3550 * produce decoded output and need to be flushed at the end of decoding to get
3551 * all the decoded data. Flushing is done by calling this function with packets
3552 * with avpkt->data set to NULL and avpkt->size set to 0 until it stops
3553 * returning samples. It is safe to flush even those decoders that are not
3554 * marked with AV_CODEC_CAP_DELAY, then no samples will be returned.
3556 * @warning The input buffer, avpkt->data must be AV_INPUT_BUFFER_PADDING_SIZE
3557 * larger than the actual read bytes because some optimized bitstream
3558 * readers read 32 or 64 bits at once and could read over the end.
3560 * @note The AVCodecContext MUST have been opened with @ref avcodec_open2()
3561 * before packets may be fed to the decoder.
3563 * @param avctx the codec context
3564 * @param[out] frame The AVFrame in which to store decoded audio samples.
3565 * The decoder will allocate a buffer for the decoded frame by
3566 * calling the AVCodecContext.get_buffer2() callback.
3567 * When AVCodecContext.refcounted_frames is set to 1, the frame is
3568 * reference counted and the returned reference belongs to the
3569 * caller. The caller must release the frame using av_frame_unref()
3570 * when the frame is no longer needed. The caller may safely write
3571 * to the frame if av_frame_is_writable() returns 1.
3572 * When AVCodecContext.refcounted_frames is set to 0, the returned
3573 * reference belongs to the decoder and is valid only until the
3574 * next call to this function or until closing or flushing the
3575 * decoder. The caller may not write to it.
3576 * @param[out] got_frame_ptr Zero if no frame could be decoded, otherwise it is
3577 * non-zero. Note that this field being set to zero
3578 * does not mean that an error has occurred. For
3579 * decoders with AV_CODEC_CAP_DELAY set, no given decode
3580 * call is guaranteed to produce a frame.
3581 * @param[in] avpkt The input AVPacket containing the input buffer.
3582 * At least avpkt->data and avpkt->size should be set. Some
3583 * decoders might also require additional fields to be set.
3584 * @return A negative error code is returned if an error occurred during
3585 * decoding, otherwise the number of bytes consumed from the input
3586 * AVPacket is returned.
3588 * @deprecated Use avcodec_send_packet() and avcodec_receive_frame().
3590 attribute_deprecated
3591 int avcodec_decode_audio4(AVCodecContext *avctx, AVFrame *frame,
3592 int *got_frame_ptr, const AVPacket *avpkt);
3595 * Decode the video frame of size avpkt->size from avpkt->data into picture.
3596 * Some decoders may support multiple frames in a single AVPacket, such
3597 * decoders would then just decode the first frame.
3599 * @warning The input buffer must be AV_INPUT_BUFFER_PADDING_SIZE larger than
3600 * the actual read bytes because some optimized bitstream readers read 32 or 64
3601 * bits at once and could read over the end.
3603 * @warning The end of the input buffer buf should be set to 0 to ensure that
3604 * no overreading happens for damaged MPEG streams.
3606 * @note Codecs which have the AV_CODEC_CAP_DELAY capability set have a delay
3607 * between input and output, these need to be fed with avpkt->data=NULL,
3608 * avpkt->size=0 at the end to return the remaining frames.
3610 * @note The AVCodecContext MUST have been opened with @ref avcodec_open2()
3611 * before packets may be fed to the decoder.
3613 * @param avctx the codec context
3614 * @param[out] picture The AVFrame in which the decoded video frame will be stored.
3615 * Use av_frame_alloc() to get an AVFrame. The codec will
3616 * allocate memory for the actual bitmap by calling the
3617 * AVCodecContext.get_buffer2() callback.
3618 * When AVCodecContext.refcounted_frames is set to 1, the frame is
3619 * reference counted and the returned reference belongs to the
3620 * caller. The caller must release the frame using av_frame_unref()
3621 * when the frame is no longer needed. The caller may safely write
3622 * to the frame if av_frame_is_writable() returns 1.
3623 * When AVCodecContext.refcounted_frames is set to 0, the returned
3624 * reference belongs to the decoder and is valid only until the
3625 * next call to this function or until closing or flushing the
3626 * decoder. The caller may not write to it.
3628 * @param[in] avpkt The input AVPacket containing the input buffer.
3629 * You can create such packet with av_init_packet() and by then setting
3630 * data and size, some decoders might in addition need other fields like
3631 * flags&AV_PKT_FLAG_KEY. All decoders are designed to use the least
3633 * @param[in,out] got_picture_ptr Zero if no frame could be decompressed, otherwise, it is nonzero.
3634 * @return On error a negative value is returned, otherwise the number of bytes
3635 * used or zero if no frame could be decompressed.
3637 * @deprecated Use avcodec_send_packet() and avcodec_receive_frame().
3639 attribute_deprecated
3640 int avcodec_decode_video2(AVCodecContext *avctx, AVFrame *picture,
3641 int *got_picture_ptr,
3642 const AVPacket *avpkt);
3645 * Decode a subtitle message.
3646 * Return a negative value on error, otherwise return the number of bytes used.
3647 * If no subtitle could be decompressed, got_sub_ptr is zero.
3648 * Otherwise, the subtitle is stored in *sub.
3649 * Note that AV_CODEC_CAP_DR1 is not available for subtitle codecs. This is for
3650 * simplicity, because the performance difference is expected to be negligible
3651 * and reusing a get_buffer written for video codecs would probably perform badly
3652 * due to a potentially very different allocation pattern.
3654 * Some decoders (those marked with AV_CODEC_CAP_DELAY) have a delay between input
3655 * and output. This means that for some packets they will not immediately
3656 * produce decoded output and need to be flushed at the end of decoding to get
3657 * all the decoded data. Flushing is done by calling this function with packets
3658 * with avpkt->data set to NULL and avpkt->size set to 0 until it stops
3659 * returning subtitles. It is safe to flush even those decoders that are not
3660 * marked with AV_CODEC_CAP_DELAY, then no subtitles will be returned.
3662 * @note The AVCodecContext MUST have been opened with @ref avcodec_open2()
3663 * before packets may be fed to the decoder.
3665 * @param avctx the codec context
3666 * @param[out] sub The preallocated AVSubtitle in which the decoded subtitle will be stored,
3667 * must be freed with avsubtitle_free if *got_sub_ptr is set.
3668 * @param[in,out] got_sub_ptr Zero if no subtitle could be decompressed, otherwise, it is nonzero.
3669 * @param[in] avpkt The input AVPacket containing the input buffer.
3671 int avcodec_decode_subtitle2(AVCodecContext *avctx, AVSubtitle *sub,
3676 * Supply raw packet data as input to a decoder.
3678 * Internally, this call will copy relevant AVCodecContext fields, which can
3679 * influence decoding per-packet, and apply them when the packet is actually
3680 * decoded. (For example AVCodecContext.skip_frame, which might direct the
3681 * decoder to drop the frame contained by the packet sent with this function.)
3683 * @warning The input buffer, avpkt->data must be AV_INPUT_BUFFER_PADDING_SIZE
3684 * larger than the actual read bytes because some optimized bitstream
3685 * readers read 32 or 64 bits at once and could read over the end.
3687 * @warning Do not mix this API with the legacy API (like avcodec_decode_video2())
3688 * on the same AVCodecContext. It will return unexpected results now
3689 * or in future libavcodec versions.
3691 * @note The AVCodecContext MUST have been opened with @ref avcodec_open2()
3692 * before packets may be fed to the decoder.
3694 * @param avctx codec context
3695 * @param[in] avpkt The input AVPacket. Usually, this will be a single video
3696 * frame, or several complete audio frames.
3697 * Ownership of the packet remains with the caller, and the
3698 * decoder will not write to the packet. The decoder may create
3699 * a reference to the packet data (or copy it if the packet is
3700 * not reference-counted).
3701 * Unlike with older APIs, the packet is always fully consumed,
3702 * and if it contains multiple frames (e.g. some audio codecs),
3703 * will require you to call avcodec_receive_frame() multiple
3704 * times afterwards before you can send a new packet.
3705 * It can be NULL (or an AVPacket with data set to NULL and
3706 * size set to 0); in this case, it is considered a flush
3707 * packet, which signals the end of the stream. Sending the
3708 * first flush packet will return success. Subsequent ones are
3709 * unnecessary and will return AVERROR_EOF. If the decoder
3710 * still has frames buffered, it will return them after sending
3713 * @return 0 on success, otherwise negative error code:
3714 * AVERROR(EAGAIN): input is not accepted in the current state - user
3715 * must read output with avcodec_receive_frame() (once
3716 * all output is read, the packet should be resent, and
3717 * the call will not fail with EAGAIN).
3718 * AVERROR_EOF: the decoder has been flushed, and no new packets can
3719 * be sent to it (also returned if more than 1 flush
3721 * AVERROR(EINVAL): codec not opened, it is an encoder, or requires flush
3722 * AVERROR(ENOMEM): failed to add packet to internal queue, or similar
3723 * other errors: legitimate decoding errors
3725 int avcodec_send_packet(AVCodecContext *avctx, const AVPacket *avpkt);
3728 * Return decoded output data from a decoder.
3730 * @param avctx codec context
3731 * @param frame This will be set to a reference-counted video or audio
3732 * frame (depending on the decoder type) allocated by the
3733 * decoder. Note that the function will always call
3734 * av_frame_unref(frame) before doing anything else.
3737 * 0: success, a frame was returned
3738 * AVERROR(EAGAIN): output is not available in this state - user must try
3740 * AVERROR_EOF: the decoder has been fully flushed, and there will be
3741 * no more output frames
3742 * AVERROR(EINVAL): codec not opened, or it is an encoder
3743 * AVERROR_INPUT_CHANGED: current decoded frame has changed parameters
3744 * with respect to first decoded frame. Applicable
3745 * when flag AV_CODEC_FLAG_DROPCHANGED is set.
3746 * other negative values: legitimate decoding errors
3748 int avcodec_receive_frame(AVCodecContext *avctx, AVFrame *frame);
3751 * Supply a raw video or audio frame to the encoder. Use avcodec_receive_packet()
3752 * to retrieve buffered output packets.
3754 * @param avctx codec context
3755 * @param[in] frame AVFrame containing the raw audio or video frame to be encoded.
3756 * Ownership of the frame remains with the caller, and the
3757 * encoder will not write to the frame. The encoder may create
3758 * a reference to the frame data (or copy it if the frame is
3759 * not reference-counted).
3760 * It can be NULL, in which case it is considered a flush
3761 * packet. This signals the end of the stream. If the encoder
3762 * still has packets buffered, it will return them after this
3763 * call. Once flushing mode has been entered, additional flush
3764 * packets are ignored, and sending frames will return
3768 * If AV_CODEC_CAP_VARIABLE_FRAME_SIZE is set, then each frame
3769 * can have any number of samples.
3770 * If it is not set, frame->nb_samples must be equal to
3771 * avctx->frame_size for all frames except the last.
3772 * The final frame may be smaller than avctx->frame_size.
3773 * @return 0 on success, otherwise negative error code:
3774 * AVERROR(EAGAIN): input is not accepted in the current state - user
3775 * must read output with avcodec_receive_packet() (once
3776 * all output is read, the packet should be resent, and
3777 * the call will not fail with EAGAIN).
3778 * AVERROR_EOF: the encoder has been flushed, and no new frames can
3780 * AVERROR(EINVAL): codec not opened, refcounted_frames not set, it is a
3781 * decoder, or requires flush
3782 * AVERROR(ENOMEM): failed to add packet to internal queue, or similar
3783 * other errors: legitimate encoding errors
3785 int avcodec_send_frame(AVCodecContext *avctx, const AVFrame *frame);
3788 * Read encoded data from the encoder.
3790 * @param avctx codec context
3791 * @param avpkt This will be set to a reference-counted packet allocated by the
3792 * encoder. Note that the function will always call
3793 * av_packet_unref(avpkt) before doing anything else.
3794 * @return 0 on success, otherwise negative error code:
3795 * AVERROR(EAGAIN): output is not available in the current state - user
3796 * must try to send input
3797 * AVERROR_EOF: the encoder has been fully flushed, and there will be
3798 * no more output packets
3799 * AVERROR(EINVAL): codec not opened, or it is a decoder
3800 * other errors: legitimate encoding errors
3802 int avcodec_receive_packet(AVCodecContext *avctx, AVPacket *avpkt);
3805 * Create and return a AVHWFramesContext with values adequate for hardware
3806 * decoding. This is meant to get called from the get_format callback, and is
3807 * a helper for preparing a AVHWFramesContext for AVCodecContext.hw_frames_ctx.
3808 * This API is for decoding with certain hardware acceleration modes/APIs only.
3810 * The returned AVHWFramesContext is not initialized. The caller must do this
3811 * with av_hwframe_ctx_init().
3813 * Calling this function is not a requirement, but makes it simpler to avoid
3814 * codec or hardware API specific details when manually allocating frames.
3816 * Alternatively to this, an API user can set AVCodecContext.hw_device_ctx,
3817 * which sets up AVCodecContext.hw_frames_ctx fully automatically, and makes
3818 * it unnecessary to call this function or having to care about
3819 * AVHWFramesContext initialization at all.
3821 * There are a number of requirements for calling this function:
3823 * - It must be called from get_format with the same avctx parameter that was
3824 * passed to get_format. Calling it outside of get_format is not allowed, and
3825 * can trigger undefined behavior.
3826 * - The function is not always supported (see description of return values).
3827 * Even if this function returns successfully, hwaccel initialization could
3828 * fail later. (The degree to which implementations check whether the stream
3829 * is actually supported varies. Some do this check only after the user's
3830 * get_format callback returns.)
3831 * - The hw_pix_fmt must be one of the choices suggested by get_format. If the
3832 * user decides to use a AVHWFramesContext prepared with this API function,
3833 * the user must return the same hw_pix_fmt from get_format.
3834 * - The device_ref passed to this function must support the given hw_pix_fmt.
3835 * - After calling this API function, it is the user's responsibility to
3836 * initialize the AVHWFramesContext (returned by the out_frames_ref parameter),
3837 * and to set AVCodecContext.hw_frames_ctx to it. If done, this must be done
3838 * before returning from get_format (this is implied by the normal
3839 * AVCodecContext.hw_frames_ctx API rules).
3840 * - The AVHWFramesContext parameters may change every time time get_format is
3841 * called. Also, AVCodecContext.hw_frames_ctx is reset before get_format. So
3842 * you are inherently required to go through this process again on every
3844 * - It is perfectly possible to call this function without actually using
3845 * the resulting AVHWFramesContext. One use-case might be trying to reuse a
3846 * previously initialized AVHWFramesContext, and calling this API function
3847 * only to test whether the required frame parameters have changed.
3848 * - Fields that use dynamically allocated values of any kind must not be set
3849 * by the user unless setting them is explicitly allowed by the documentation.
3850 * If the user sets AVHWFramesContext.free and AVHWFramesContext.user_opaque,
3851 * the new free callback must call the potentially set previous free callback.
3852 * This API call may set any dynamically allocated fields, including the free
3855 * The function will set at least the following fields on AVHWFramesContext
3856 * (potentially more, depending on hwaccel API):
3858 * - All fields set by av_hwframe_ctx_alloc().
3859 * - Set the format field to hw_pix_fmt.
3860 * - Set the sw_format field to the most suited and most versatile format. (An
3861 * implication is that this will prefer generic formats over opaque formats
3862 * with arbitrary restrictions, if possible.)
3863 * - Set the width/height fields to the coded frame size, rounded up to the
3864 * API-specific minimum alignment.
3865 * - Only _if_ the hwaccel requires a pre-allocated pool: set the initial_pool_size
3866 * field to the number of maximum reference surfaces possible with the codec,
3867 * plus 1 surface for the user to work (meaning the user can safely reference
3868 * at most 1 decoded surface at a time), plus additional buffering introduced
3869 * by frame threading. If the hwaccel does not require pre-allocation, the
3870 * field is left to 0, and the decoder will allocate new surfaces on demand
3872 * - Possibly AVHWFramesContext.hwctx fields, depending on the underlying
3875 * Essentially, out_frames_ref returns the same as av_hwframe_ctx_alloc(), but
3876 * with basic frame parameters set.
3878 * The function is stateless, and does not change the AVCodecContext or the
3879 * device_ref AVHWDeviceContext.
3881 * @param avctx The context which is currently calling get_format, and which
3882 * implicitly contains all state needed for filling the returned
3883 * AVHWFramesContext properly.
3884 * @param device_ref A reference to the AVHWDeviceContext describing the device
3885 * which will be used by the hardware decoder.
3886 * @param hw_pix_fmt The hwaccel format you are going to return from get_format.
3887 * @param out_frames_ref On success, set to a reference to an _uninitialized_
3888 * AVHWFramesContext, created from the given device_ref.
3889 * Fields will be set to values required for decoding.
3890 * Not changed if an error is returned.
3891 * @return zero on success, a negative value on error. The following error codes
3892 * have special semantics:
3893 * AVERROR(ENOENT): the decoder does not support this functionality. Setup
3894 * is always manual, or it is a decoder which does not
3895 * support setting AVCodecContext.hw_frames_ctx at all,
3896 * or it is a software format.
3897 * AVERROR(EINVAL): it is known that hardware decoding is not supported for
3898 * this configuration, or the device_ref is not supported
3899 * for the hwaccel referenced by hw_pix_fmt.
3901 int avcodec_get_hw_frames_parameters(AVCodecContext *avctx,
3902 AVBufferRef *device_ref,
3903 enum AVPixelFormat hw_pix_fmt,
3904 AVBufferRef **out_frames_ref);
3909 * @defgroup lavc_parsing Frame parsing
3913 enum AVPictureStructure {
3914 AV_PICTURE_STRUCTURE_UNKNOWN, //< unknown
3915 AV_PICTURE_STRUCTURE_TOP_FIELD, //< coded as top field
3916 AV_PICTURE_STRUCTURE_BOTTOM_FIELD, //< coded as bottom field
3917 AV_PICTURE_STRUCTURE_FRAME, //< coded as frame
3920 typedef struct AVCodecParserContext {
3922 struct AVCodecParser *parser;
3923 int64_t frame_offset; /* offset of the current frame */
3924 int64_t cur_offset; /* current offset
3925 (incremented by each av_parser_parse()) */
3926 int64_t next_frame_offset; /* offset of the next frame */
3928 int pict_type; /* XXX: Put it back in AVCodecContext. */
3930 * This field is used for proper frame duration computation in lavf.
3931 * It signals, how much longer the frame duration of the current frame
3932 * is compared to normal frame duration.
3934 * frame_duration = (1 + repeat_pict) * time_base
3936 * It is used by codecs like H.264 to display telecined material.
3938 int repeat_pict; /* XXX: Put it back in AVCodecContext. */
3939 int64_t pts; /* pts of the current frame */
3940 int64_t dts; /* dts of the current frame */
3945 int fetch_timestamp;
3947 #define AV_PARSER_PTS_NB 4
3948 int cur_frame_start_index;
3949 int64_t cur_frame_offset[AV_PARSER_PTS_NB];
3950 int64_t cur_frame_pts[AV_PARSER_PTS_NB];
3951 int64_t cur_frame_dts[AV_PARSER_PTS_NB];
3954 #define PARSER_FLAG_COMPLETE_FRAMES 0x0001
3955 #define PARSER_FLAG_ONCE 0x0002
3956 /// Set if the parser has a valid file offset
3957 #define PARSER_FLAG_FETCHED_OFFSET 0x0004
3958 #define PARSER_FLAG_USE_CODEC_TS 0x1000
3960 int64_t offset; ///< byte offset from starting packet start
3961 int64_t cur_frame_end[AV_PARSER_PTS_NB];
3964 * Set by parser to 1 for key frames and 0 for non-key frames.
3965 * It is initialized to -1, so if the parser doesn't set this flag,
3966 * old-style fallback using AV_PICTURE_TYPE_I picture type as key frames
3971 #if FF_API_CONVERGENCE_DURATION
3973 * @deprecated unused
3975 attribute_deprecated
3976 int64_t convergence_duration;
3979 // Timestamp generation support:
3981 * Synchronization point for start of timestamp generation.
3983 * Set to >0 for sync point, 0 for no sync point and <0 for undefined
3986 * For example, this corresponds to presence of H.264 buffering period
3992 * Offset of the current timestamp against last timestamp sync point in
3993 * units of AVCodecContext.time_base.
3995 * Set to INT_MIN when dts_sync_point unused. Otherwise, it must
3996 * contain a valid timestamp offset.
3998 * Note that the timestamp of sync point has usually a nonzero
3999 * dts_ref_dts_delta, which refers to the previous sync point. Offset of
4000 * the next frame after timestamp sync point will be usually 1.
4002 * For example, this corresponds to H.264 cpb_removal_delay.
4004 int dts_ref_dts_delta;
4007 * Presentation delay of current frame in units of AVCodecContext.time_base.
4009 * Set to INT_MIN when dts_sync_point unused. Otherwise, it must
4010 * contain valid non-negative timestamp delta (presentation time of a frame
4011 * must not lie in the past).
4013 * This delay represents the difference between decoding and presentation
4014 * time of the frame.
4016 * For example, this corresponds to H.264 dpb_output_delay.
4021 * Position of the packet in file.
4023 * Analogous to cur_frame_pts/dts
4025 int64_t cur_frame_pos[AV_PARSER_PTS_NB];
4028 * Byte position of currently parsed frame in stream.
4033 * Previous frame byte position.
4038 * Duration of the current frame.
4039 * For audio, this is in units of 1 / AVCodecContext.sample_rate.
4040 * For all other types, this is in units of AVCodecContext.time_base.
4044 enum AVFieldOrder field_order;
4047 * Indicate whether a picture is coded as a frame, top field or bottom field.
4049 * For example, H.264 field_pic_flag equal to 0 corresponds to
4050 * AV_PICTURE_STRUCTURE_FRAME. An H.264 picture with field_pic_flag
4051 * equal to 1 and bottom_field_flag equal to 0 corresponds to
4052 * AV_PICTURE_STRUCTURE_TOP_FIELD.
4054 enum AVPictureStructure picture_structure;
4057 * Picture number incremented in presentation or output order.
4058 * This field may be reinitialized at the first picture of a new sequence.
4060 * For example, this corresponds to H.264 PicOrderCnt.
4062 int output_picture_number;
4065 * Dimensions of the decoded video intended for presentation.
4071 * Dimensions of the coded video.
4077 * The format of the coded data, corresponds to enum AVPixelFormat for video
4078 * and for enum AVSampleFormat for audio.
4080 * Note that a decoder can have considerable freedom in how exactly it
4081 * decodes the data, so the format reported here might be different from the
4082 * one returned by a decoder.
4085 } AVCodecParserContext;
4087 typedef struct AVCodecParser {
4088 int codec_ids[5]; /* several codec IDs are permitted */
4090 int (*parser_init)(AVCodecParserContext *s);
4091 /* This callback never returns an error, a negative value means that
4092 * the frame start was in a previous packet. */
4093 int (*parser_parse)(AVCodecParserContext *s,
4094 AVCodecContext *avctx,
4095 const uint8_t **poutbuf, int *poutbuf_size,
4096 const uint8_t *buf, int buf_size);
4097 void (*parser_close)(AVCodecParserContext *s);
4098 int (*split)(AVCodecContext *avctx, const uint8_t *buf, int buf_size);
4099 struct AVCodecParser *next;
4103 * Iterate over all registered codec parsers.
4105 * @param opaque a pointer where libavcodec will store the iteration state. Must
4106 * point to NULL to start the iteration.
4108 * @return the next registered codec parser or NULL when the iteration is
4111 const AVCodecParser *av_parser_iterate(void **opaque);
4113 attribute_deprecated
4114 AVCodecParser *av_parser_next(const AVCodecParser *c);
4116 attribute_deprecated
4117 void av_register_codec_parser(AVCodecParser *parser);
4118 AVCodecParserContext *av_parser_init(int codec_id);
4123 * @param s parser context.
4124 * @param avctx codec context.
4125 * @param poutbuf set to pointer to parsed buffer or NULL if not yet finished.
4126 * @param poutbuf_size set to size of parsed buffer or zero if not yet finished.
4127 * @param buf input buffer.
4128 * @param buf_size buffer size in bytes without the padding. I.e. the full buffer
4129 size is assumed to be buf_size + AV_INPUT_BUFFER_PADDING_SIZE.
4130 To signal EOF, this should be 0 (so that the last frame
4132 * @param pts input presentation timestamp.
4133 * @param dts input decoding timestamp.
4134 * @param pos input byte position in stream.
4135 * @return the number of bytes of the input bitstream used.
4140 * len = av_parser_parse2(myparser, AVCodecContext, &data, &size,
4147 * decode_frame(data, size);
4151 int av_parser_parse2(AVCodecParserContext *s,
4152 AVCodecContext *avctx,
4153 uint8_t **poutbuf, int *poutbuf_size,
4154 const uint8_t *buf, int buf_size,
4155 int64_t pts, int64_t dts,
4159 * @return 0 if the output buffer is a subset of the input, 1 if it is allocated and must be freed
4160 * @deprecated use AVBitStreamFilter
4162 int av_parser_change(AVCodecParserContext *s,
4163 AVCodecContext *avctx,
4164 uint8_t **poutbuf, int *poutbuf_size,
4165 const uint8_t *buf, int buf_size, int keyframe);
4166 void av_parser_close(AVCodecParserContext *s);
4174 * @addtogroup lavc_encoding
4179 * Find a registered encoder with a matching codec ID.
4181 * @param id AVCodecID of the requested encoder
4182 * @return An encoder if one was found, NULL otherwise.
4184 AVCodec *avcodec_find_encoder(enum AVCodecID id);
4187 * Find a registered encoder with the specified name.
4189 * @param name name of the requested encoder
4190 * @return An encoder if one was found, NULL otherwise.
4192 AVCodec *avcodec_find_encoder_by_name(const char *name);
4195 * Encode a frame of audio.
4197 * Takes input samples from frame and writes the next output packet, if
4198 * available, to avpkt. The output packet does not necessarily contain data for
4199 * the most recent frame, as encoders can delay, split, and combine input frames
4200 * internally as needed.
4202 * @param avctx codec context
4203 * @param avpkt output AVPacket.
4204 * The user can supply an output buffer by setting
4205 * avpkt->data and avpkt->size prior to calling the
4206 * function, but if the size of the user-provided data is not
4207 * large enough, encoding will fail. If avpkt->data and
4208 * avpkt->size are set, avpkt->destruct must also be set. All
4209 * other AVPacket fields will be reset by the encoder using
4210 * av_init_packet(). If avpkt->data is NULL, the encoder will
4211 * allocate it. The encoder will set avpkt->size to the size
4212 * of the output packet.
4214 * If this function fails or produces no output, avpkt will be
4215 * freed using av_packet_unref().
4216 * @param[in] frame AVFrame containing the raw audio data to be encoded.
4217 * May be NULL when flushing an encoder that has the
4218 * AV_CODEC_CAP_DELAY capability set.
4219 * If AV_CODEC_CAP_VARIABLE_FRAME_SIZE is set, then each frame
4220 * can have any number of samples.
4221 * If it is not set, frame->nb_samples must be equal to
4222 * avctx->frame_size for all frames except the last.
4223 * The final frame may be smaller than avctx->frame_size.
4224 * @param[out] got_packet_ptr This field is set to 1 by libavcodec if the
4225 * output packet is non-empty, and to 0 if it is
4226 * empty. If the function returns an error, the
4227 * packet can be assumed to be invalid, and the
4228 * value of got_packet_ptr is undefined and should
4230 * @return 0 on success, negative error code on failure
4232 * @deprecated use avcodec_send_frame()/avcodec_receive_packet() instead
4234 attribute_deprecated
4235 int avcodec_encode_audio2(AVCodecContext *avctx, AVPacket *avpkt,
4236 const AVFrame *frame, int *got_packet_ptr);
4239 * Encode a frame of video.
4241 * Takes input raw video data from frame and writes the next output packet, if
4242 * available, to avpkt. The output packet does not necessarily contain data for
4243 * the most recent frame, as encoders can delay and reorder input frames
4244 * internally as needed.
4246 * @param avctx codec context
4247 * @param avpkt output AVPacket.
4248 * The user can supply an output buffer by setting
4249 * avpkt->data and avpkt->size prior to calling the
4250 * function, but if the size of the user-provided data is not
4251 * large enough, encoding will fail. All other AVPacket fields
4252 * will be reset by the encoder using av_init_packet(). If
4253 * avpkt->data is NULL, the encoder will allocate it.
4254 * The encoder will set avpkt->size to the size of the
4255 * output packet. The returned data (if any) belongs to the
4256 * caller, he is responsible for freeing it.
4258 * If this function fails or produces no output, avpkt will be
4259 * freed using av_packet_unref().
4260 * @param[in] frame AVFrame containing the raw video data to be encoded.
4261 * May be NULL when flushing an encoder that has the
4262 * AV_CODEC_CAP_DELAY capability set.
4263 * @param[out] got_packet_ptr This field is set to 1 by libavcodec if the
4264 * output packet is non-empty, and to 0 if it is
4265 * empty. If the function returns an error, the
4266 * packet can be assumed to be invalid, and the
4267 * value of got_packet_ptr is undefined and should
4269 * @return 0 on success, negative error code on failure
4271 * @deprecated use avcodec_send_frame()/avcodec_receive_packet() instead
4273 attribute_deprecated
4274 int avcodec_encode_video2(AVCodecContext *avctx, AVPacket *avpkt,
4275 const AVFrame *frame, int *got_packet_ptr);
4277 int avcodec_encode_subtitle(AVCodecContext *avctx, uint8_t *buf, int buf_size,
4278 const AVSubtitle *sub);
4285 #if FF_API_AVPICTURE
4287 * @addtogroup lavc_picture
4292 * @deprecated unused
4294 attribute_deprecated
4295 int avpicture_alloc(AVPicture *picture, enum AVPixelFormat pix_fmt, int width, int height);
4298 * @deprecated unused
4300 attribute_deprecated
4301 void avpicture_free(AVPicture *picture);
4304 * @deprecated use av_image_fill_arrays() instead.
4306 attribute_deprecated
4307 int avpicture_fill(AVPicture *picture, const uint8_t *ptr,
4308 enum AVPixelFormat pix_fmt, int width, int height);
4311 * @deprecated use av_image_copy_to_buffer() instead.
4313 attribute_deprecated
4314 int avpicture_layout(const AVPicture *src, enum AVPixelFormat pix_fmt,
4315 int width, int height,
4316 unsigned char *dest, int dest_size);
4319 * @deprecated use av_image_get_buffer_size() instead.
4321 attribute_deprecated
4322 int avpicture_get_size(enum AVPixelFormat pix_fmt, int width, int height);
4325 * @deprecated av_image_copy() instead.
4327 attribute_deprecated
4328 void av_picture_copy(AVPicture *dst, const AVPicture *src,
4329 enum AVPixelFormat pix_fmt, int width, int height);
4332 * @deprecated unused
4334 attribute_deprecated
4335 int av_picture_crop(AVPicture *dst, const AVPicture *src,
4336 enum AVPixelFormat pix_fmt, int top_band, int left_band);
4339 * @deprecated unused
4341 attribute_deprecated
4342 int av_picture_pad(AVPicture *dst, const AVPicture *src, int height, int width, enum AVPixelFormat pix_fmt,
4343 int padtop, int padbottom, int padleft, int padright, int *color);
4351 * @defgroup lavc_misc Utility functions
4354 * Miscellaneous utility functions related to both encoding and decoding
4360 * @defgroup lavc_misc_pixfmt Pixel formats
4362 * Functions for working with pixel formats.
4366 #if FF_API_GETCHROMA
4368 * @deprecated Use av_pix_fmt_get_chroma_sub_sample
4371 attribute_deprecated
4372 void avcodec_get_chroma_sub_sample(enum AVPixelFormat pix_fmt, int *h_shift, int *v_shift);
4376 * Return a value representing the fourCC code associated to the
4377 * pixel format pix_fmt, or 0 if no associated fourCC code can be
4380 unsigned int avcodec_pix_fmt_to_codec_tag(enum AVPixelFormat pix_fmt);
4383 * @deprecated see av_get_pix_fmt_loss()
4385 int avcodec_get_pix_fmt_loss(enum AVPixelFormat dst_pix_fmt, enum AVPixelFormat src_pix_fmt,
4389 * Find the best pixel format to convert to given a certain source pixel
4390 * format. When converting from one pixel format to another, information loss
4391 * may occur. For example, when converting from RGB24 to GRAY, the color
4392 * information will be lost. Similarly, other losses occur when converting from
4393 * some formats to other formats. avcodec_find_best_pix_fmt_of_2() searches which of
4394 * the given pixel formats should be used to suffer the least amount of loss.
4395 * The pixel formats from which it chooses one, are determined by the
4396 * pix_fmt_list parameter.
4399 * @param[in] pix_fmt_list AV_PIX_FMT_NONE terminated array of pixel formats to choose from
4400 * @param[in] src_pix_fmt source pixel format
4401 * @param[in] has_alpha Whether the source pixel format alpha channel is used.
4402 * @param[out] loss_ptr Combination of flags informing you what kind of losses will occur.
4403 * @return The best pixel format to convert to or -1 if none was found.
4405 enum AVPixelFormat avcodec_find_best_pix_fmt_of_list(const enum AVPixelFormat *pix_fmt_list,
4406 enum AVPixelFormat src_pix_fmt,
4407 int has_alpha, int *loss_ptr);
4410 * @deprecated see av_find_best_pix_fmt_of_2()
4412 enum AVPixelFormat avcodec_find_best_pix_fmt_of_2(enum AVPixelFormat dst_pix_fmt1, enum AVPixelFormat dst_pix_fmt2,
4413 enum AVPixelFormat src_pix_fmt, int has_alpha, int *loss_ptr);
4415 attribute_deprecated
4416 enum AVPixelFormat avcodec_find_best_pix_fmt2(enum AVPixelFormat dst_pix_fmt1, enum AVPixelFormat dst_pix_fmt2,
4417 enum AVPixelFormat src_pix_fmt, int has_alpha, int *loss_ptr);
4419 enum AVPixelFormat avcodec_default_get_format(struct AVCodecContext *s, const enum AVPixelFormat * fmt);
4425 #if FF_API_TAG_STRING
4427 * Put a string representing the codec tag codec_tag in buf.
4429 * @param buf buffer to place codec tag in
4430 * @param buf_size size in bytes of buf
4431 * @param codec_tag codec tag to assign
4432 * @return the length of the string that would have been generated if
4433 * enough space had been available, excluding the trailing null
4435 * @deprecated see av_fourcc_make_string() and av_fourcc2str().
4437 attribute_deprecated
4438 size_t av_get_codec_tag_string(char *buf, size_t buf_size, unsigned int codec_tag);
4441 void avcodec_string(char *buf, int buf_size, AVCodecContext *enc, int encode);
4444 * Return a name for the specified profile, if available.
4446 * @param codec the codec that is searched for the given profile
4447 * @param profile the profile value for which a name is requested
4448 * @return A name for the profile if found, NULL otherwise.
4450 const char *av_get_profile_name(const AVCodec *codec, int profile);
4453 * Return a name for the specified profile, if available.
4455 * @param codec_id the ID of the codec to which the requested profile belongs
4456 * @param profile the profile value for which a name is requested
4457 * @return A name for the profile if found, NULL otherwise.
4459 * @note unlike av_get_profile_name(), which searches a list of profiles
4460 * supported by a specific decoder or encoder implementation, this
4461 * function searches the list of profiles from the AVCodecDescriptor
4463 const char *avcodec_profile_name(enum AVCodecID codec_id, int profile);
4465 int avcodec_default_execute(AVCodecContext *c, int (*func)(AVCodecContext *c2, void *arg2),void *arg, int *ret, int count, int size);
4466 int avcodec_default_execute2(AVCodecContext *c, int (*func)(AVCodecContext *c2, void *arg2, int, int),void *arg, int *ret, int count);
4467 //FIXME func typedef
4470 * Fill AVFrame audio data and linesize pointers.
4472 * The buffer buf must be a preallocated buffer with a size big enough
4473 * to contain the specified samples amount. The filled AVFrame data
4474 * pointers will point to this buffer.
4476 * AVFrame extended_data channel pointers are allocated if necessary for
4479 * @param frame the AVFrame
4480 * frame->nb_samples must be set prior to calling the
4481 * function. This function fills in frame->data,
4482 * frame->extended_data, frame->linesize[0].
4483 * @param nb_channels channel count
4484 * @param sample_fmt sample format
4485 * @param buf buffer to use for frame data
4486 * @param buf_size size of buffer
4487 * @param align plane size sample alignment (0 = default)
4488 * @return >=0 on success, negative error code on failure
4489 * @todo return the size in bytes required to store the samples in
4490 * case of success, at the next libavutil bump
4492 int avcodec_fill_audio_frame(AVFrame *frame, int nb_channels,
4493 enum AVSampleFormat sample_fmt, const uint8_t *buf,
4494 int buf_size, int align);
4497 * Reset the internal codec state / flush internal buffers. Should be called
4498 * e.g. when seeking or when switching to a different stream.
4500 * @note for decoders, when refcounted frames are not used
4501 * (i.e. avctx->refcounted_frames is 0), this invalidates the frames previously
4502 * returned from the decoder. When refcounted frames are used, the decoder just
4503 * releases any references it might keep internally, but the caller's reference
4506 * @note for encoders, this function will only do something if the encoder
4507 * declares support for AV_CODEC_CAP_ENCODER_FLUSH. When called, the encoder
4508 * will drain any remaining packets, and can then be re-used for a different
4509 * stream (as opposed to sending a null frame which will leave the encoder
4510 * in a permanent EOF state after draining). This can be desirable if the
4511 * cost of tearing down and replacing the encoder instance is high.
4513 void avcodec_flush_buffers(AVCodecContext *avctx);
4516 * Return codec bits per sample.
4518 * @param[in] codec_id the codec
4519 * @return Number of bits per sample or zero if unknown for the given codec.
4521 int av_get_bits_per_sample(enum AVCodecID codec_id);
4524 * Return the PCM codec associated with a sample format.
4525 * @param be endianness, 0 for little, 1 for big,
4526 * -1 (or anything else) for native
4527 * @return AV_CODEC_ID_PCM_* or AV_CODEC_ID_NONE
4529 enum AVCodecID av_get_pcm_codec(enum AVSampleFormat fmt, int be);
4532 * Return codec bits per sample.
4533 * Only return non-zero if the bits per sample is exactly correct, not an
4536 * @param[in] codec_id the codec
4537 * @return Number of bits per sample or zero if unknown for the given codec.
4539 int av_get_exact_bits_per_sample(enum AVCodecID codec_id);
4542 * Return audio frame duration.
4544 * @param avctx codec context
4545 * @param frame_bytes size of the frame, or 0 if unknown
4546 * @return frame duration, in samples, if known. 0 if not able to
4549 int av_get_audio_frame_duration(AVCodecContext *avctx, int frame_bytes);
4552 * This function is the same as av_get_audio_frame_duration(), except it works
4553 * with AVCodecParameters instead of an AVCodecContext.
4555 int av_get_audio_frame_duration2(AVCodecParameters *par, int frame_bytes);
4558 typedef struct AVBitStreamFilterContext {
4560 const struct AVBitStreamFilter *filter;
4561 AVCodecParserContext *parser;
4562 struct AVBitStreamFilterContext *next;
4564 * Internal default arguments, used if NULL is passed to av_bitstream_filter_filter().
4565 * Not for access by library users.
4568 } AVBitStreamFilterContext;
4571 typedef struct AVBSFInternal AVBSFInternal;
4574 * The bitstream filter state.
4576 * This struct must be allocated with av_bsf_alloc() and freed with
4579 * The fields in the struct will only be changed (by the caller or by the
4580 * filter) as described in their documentation, and are to be considered
4581 * immutable otherwise.
4583 typedef struct AVBSFContext {
4585 * A class for logging and AVOptions
4587 const AVClass *av_class;
4590 * The bitstream filter this context is an instance of.
4592 const struct AVBitStreamFilter *filter;
4595 * Opaque libavcodec internal data. Must not be touched by the caller in any
4598 AVBSFInternal *internal;
4601 * Opaque filter-specific private data. If filter->priv_class is non-NULL,
4602 * this is an AVOptions-enabled struct.
4607 * Parameters of the input stream. This field is allocated in
4608 * av_bsf_alloc(), it needs to be filled by the caller before
4611 AVCodecParameters *par_in;
4614 * Parameters of the output stream. This field is allocated in
4615 * av_bsf_alloc(), it is set by the filter in av_bsf_init().
4617 AVCodecParameters *par_out;
4620 * The timebase used for the timestamps of the input packets. Set by the
4621 * caller before av_bsf_init().
4623 AVRational time_base_in;
4626 * The timebase used for the timestamps of the output packets. Set by the
4627 * filter in av_bsf_init().
4629 AVRational time_base_out;
4632 typedef struct AVBitStreamFilter {
4636 * A list of codec ids supported by the filter, terminated by
4638 * May be NULL, in that case the bitstream filter works with any codec id.
4640 const enum AVCodecID *codec_ids;
4643 * A class for the private data, used to declare bitstream filter private
4644 * AVOptions. This field is NULL for bitstream filters that do not declare
4647 * If this field is non-NULL, the first member of the filter private data
4648 * must be a pointer to AVClass, which will be set by libavcodec generic
4649 * code to this class.
4651 const AVClass *priv_class;
4653 /*****************************************************************
4654 * No fields below this line are part of the public API. They
4655 * may not be used outside of libavcodec and can be changed and
4657 * New public fields should be added right above.
4658 *****************************************************************
4662 int (*init)(AVBSFContext *ctx);
4663 int (*filter)(AVBSFContext *ctx, AVPacket *pkt);
4664 void (*close)(AVBSFContext *ctx);
4665 void (*flush)(AVBSFContext *ctx);
4666 } AVBitStreamFilter;
4670 * @deprecated the old bitstream filtering API (using AVBitStreamFilterContext)
4671 * is deprecated. Use the new bitstream filtering API (using AVBSFContext).
4673 attribute_deprecated
4674 void av_register_bitstream_filter(AVBitStreamFilter *bsf);
4676 * @deprecated the old bitstream filtering API (using AVBitStreamFilterContext)
4677 * is deprecated. Use av_bsf_get_by_name(), av_bsf_alloc(), and av_bsf_init()
4678 * from the new bitstream filtering API (using AVBSFContext).
4680 attribute_deprecated
4681 AVBitStreamFilterContext *av_bitstream_filter_init(const char *name);
4683 * @deprecated the old bitstream filtering API (using AVBitStreamFilterContext)
4684 * is deprecated. Use av_bsf_send_packet() and av_bsf_receive_packet() from the
4685 * new bitstream filtering API (using AVBSFContext).
4687 attribute_deprecated
4688 int av_bitstream_filter_filter(AVBitStreamFilterContext *bsfc,
4689 AVCodecContext *avctx, const char *args,
4690 uint8_t **poutbuf, int *poutbuf_size,
4691 const uint8_t *buf, int buf_size, int keyframe);
4693 * @deprecated the old bitstream filtering API (using AVBitStreamFilterContext)
4694 * is deprecated. Use av_bsf_free() from the new bitstream filtering API (using
4697 attribute_deprecated
4698 void av_bitstream_filter_close(AVBitStreamFilterContext *bsf);
4700 * @deprecated the old bitstream filtering API (using AVBitStreamFilterContext)
4701 * is deprecated. Use av_bsf_iterate() from the new bitstream filtering API (using
4704 attribute_deprecated
4705 const AVBitStreamFilter *av_bitstream_filter_next(const AVBitStreamFilter *f);
4709 * @return a bitstream filter with the specified name or NULL if no such
4710 * bitstream filter exists.
4712 const AVBitStreamFilter *av_bsf_get_by_name(const char *name);
4715 * Iterate over all registered bitstream filters.
4717 * @param opaque a pointer where libavcodec will store the iteration state. Must
4718 * point to NULL to start the iteration.
4720 * @return the next registered bitstream filter or NULL when the iteration is
4723 const AVBitStreamFilter *av_bsf_iterate(void **opaque);
4725 attribute_deprecated
4726 const AVBitStreamFilter *av_bsf_next(void **opaque);
4730 * Allocate a context for a given bitstream filter. The caller must fill in the
4731 * context parameters as described in the documentation and then call
4732 * av_bsf_init() before sending any data to the filter.
4734 * @param filter the filter for which to allocate an instance.
4735 * @param ctx a pointer into which the pointer to the newly-allocated context
4736 * will be written. It must be freed with av_bsf_free() after the
4737 * filtering is done.
4739 * @return 0 on success, a negative AVERROR code on failure
4741 int av_bsf_alloc(const AVBitStreamFilter *filter, AVBSFContext **ctx);
4744 * Prepare the filter for use, after all the parameters and options have been
4747 int av_bsf_init(AVBSFContext *ctx);
4750 * Submit a packet for filtering.
4752 * After sending each packet, the filter must be completely drained by calling
4753 * av_bsf_receive_packet() repeatedly until it returns AVERROR(EAGAIN) or
4756 * @param pkt the packet to filter. The bitstream filter will take ownership of
4757 * the packet and reset the contents of pkt. pkt is not touched if an error occurs.
4758 * If pkt is empty (i.e. NULL, or pkt->data is NULL and pkt->side_data_elems zero),
4759 * it signals the end of the stream (i.e. no more non-empty packets will be sent;
4760 * sending more empty packets does nothing) and will cause the filter to output
4761 * any packets it may have buffered internally.
4763 * @return 0 on success, a negative AVERROR on error. This function never fails if
4766 int av_bsf_send_packet(AVBSFContext *ctx, AVPacket *pkt);
4769 * Retrieve a filtered packet.
4771 * @param[out] pkt this struct will be filled with the contents of the filtered
4772 * packet. It is owned by the caller and must be freed using
4773 * av_packet_unref() when it is no longer needed.
4774 * This parameter should be "clean" (i.e. freshly allocated
4775 * with av_packet_alloc() or unreffed with av_packet_unref())
4776 * when this function is called. If this function returns
4777 * successfully, the contents of pkt will be completely
4778 * overwritten by the returned data. On failure, pkt is not
4781 * @return 0 on success. AVERROR(EAGAIN) if more packets need to be sent to the
4782 * filter (using av_bsf_send_packet()) to get more output. AVERROR_EOF if there
4783 * will be no further output from the filter. Another negative AVERROR value if
4786 * @note one input packet may result in several output packets, so after sending
4787 * a packet with av_bsf_send_packet(), this function needs to be called
4788 * repeatedly until it stops returning 0. It is also possible for a filter to
4789 * output fewer packets than were sent to it, so this function may return
4790 * AVERROR(EAGAIN) immediately after a successful av_bsf_send_packet() call.
4792 int av_bsf_receive_packet(AVBSFContext *ctx, AVPacket *pkt);
4795 * Reset the internal bitstream filter state / flush internal buffers.
4797 void av_bsf_flush(AVBSFContext *ctx);
4800 * Free a bitstream filter context and everything associated with it; write NULL
4801 * into the supplied pointer.
4803 void av_bsf_free(AVBSFContext **ctx);
4806 * Get the AVClass for AVBSFContext. It can be used in combination with
4807 * AV_OPT_SEARCH_FAKE_OBJ for examining options.
4809 * @see av_opt_find().
4811 const AVClass *av_bsf_get_class(void);
4814 * Structure for chain/list of bitstream filters.
4815 * Empty list can be allocated by av_bsf_list_alloc().
4817 typedef struct AVBSFList AVBSFList;
4820 * Allocate empty list of bitstream filters.
4821 * The list must be later freed by av_bsf_list_free()
4822 * or finalized by av_bsf_list_finalize().
4824 * @return Pointer to @ref AVBSFList on success, NULL in case of failure
4826 AVBSFList *av_bsf_list_alloc(void);
4829 * Free list of bitstream filters.
4831 * @param lst Pointer to pointer returned by av_bsf_list_alloc()
4833 void av_bsf_list_free(AVBSFList **lst);
4836 * Append bitstream filter to the list of bitstream filters.
4838 * @param lst List to append to
4839 * @param bsf Filter context to be appended
4841 * @return >=0 on success, negative AVERROR in case of failure
4843 int av_bsf_list_append(AVBSFList *lst, AVBSFContext *bsf);
4846 * Construct new bitstream filter context given it's name and options
4847 * and append it to the list of bitstream filters.
4849 * @param lst List to append to
4850 * @param bsf_name Name of the bitstream filter
4851 * @param options Options for the bitstream filter, can be set to NULL
4853 * @return >=0 on success, negative AVERROR in case of failure
4855 int av_bsf_list_append2(AVBSFList *lst, const char * bsf_name, AVDictionary **options);
4857 * Finalize list of bitstream filters.
4859 * This function will transform @ref AVBSFList to single @ref AVBSFContext,
4860 * so the whole chain of bitstream filters can be treated as single filter
4861 * freshly allocated by av_bsf_alloc().
4862 * If the call is successful, @ref AVBSFList structure is freed and lst
4863 * will be set to NULL. In case of failure, caller is responsible for
4864 * freeing the structure by av_bsf_list_free()
4866 * @param lst Filter list structure to be transformed
4867 * @param[out] bsf Pointer to be set to newly created @ref AVBSFContext structure
4868 * representing the chain of bitstream filters
4870 * @return >=0 on success, negative AVERROR in case of failure
4872 int av_bsf_list_finalize(AVBSFList **lst, AVBSFContext **bsf);
4875 * Parse string describing list of bitstream filters and create single
4876 * @ref AVBSFContext describing the whole chain of bitstream filters.
4877 * Resulting @ref AVBSFContext can be treated as any other @ref AVBSFContext freshly
4878 * allocated by av_bsf_alloc().
4880 * @param str String describing chain of bitstream filters in format
4881 * `bsf1[=opt1=val1:opt2=val2][,bsf2]`
4882 * @param[out] bsf Pointer to be set to newly created @ref AVBSFContext structure
4883 * representing the chain of bitstream filters
4885 * @return >=0 on success, negative AVERROR in case of failure
4887 int av_bsf_list_parse_str(const char *str, AVBSFContext **bsf);
4890 * Get null/pass-through bitstream filter.
4892 * @param[out] bsf Pointer to be set to new instance of pass-through bitstream filter
4896 int av_bsf_get_null_filter(AVBSFContext **bsf);
4901 * Same behaviour av_fast_malloc but the buffer has additional
4902 * AV_INPUT_BUFFER_PADDING_SIZE at the end which will always be 0.
4904 * In addition the whole buffer will initially and after resizes
4905 * be 0-initialized so that no uninitialized data will ever appear.
4907 void av_fast_padded_malloc(void *ptr, unsigned int *size, size_t min_size);
4910 * Same behaviour av_fast_padded_malloc except that buffer will always
4911 * be 0-initialized after call.
4913 void av_fast_padded_mallocz(void *ptr, unsigned int *size, size_t min_size);
4916 * Encode extradata length to a buffer. Used by xiph codecs.
4918 * @param s buffer to write to; must be at least (v/255+1) bytes long
4919 * @param v size of extradata in bytes
4920 * @return number of bytes written to the buffer.
4922 unsigned int av_xiphlacing(unsigned char *s, unsigned int v);
4924 #if FF_API_USER_VISIBLE_AVHWACCEL
4926 * Register the hardware accelerator hwaccel.
4928 * @deprecated This function doesn't do anything.
4930 attribute_deprecated
4931 void av_register_hwaccel(AVHWAccel *hwaccel);
4934 * If hwaccel is NULL, returns the first registered hardware accelerator,
4935 * if hwaccel is non-NULL, returns the next registered hardware accelerator
4936 * after hwaccel, or NULL if hwaccel is the last one.
4938 * @deprecated AVHWaccel structures contain no user-serviceable parts, so
4939 * this function should not be used.
4941 attribute_deprecated
4942 AVHWAccel *av_hwaccel_next(const AVHWAccel *hwaccel);
4947 * Lock operation used by lockmgr
4949 * @deprecated Deprecated together with av_lockmgr_register().
4952 AV_LOCK_CREATE, ///< Create a mutex
4953 AV_LOCK_OBTAIN, ///< Lock the mutex
4954 AV_LOCK_RELEASE, ///< Unlock the mutex
4955 AV_LOCK_DESTROY, ///< Free mutex resources
4959 * Register a user provided lock manager supporting the operations
4960 * specified by AVLockOp. The "mutex" argument to the function points
4961 * to a (void *) where the lockmgr should store/get a pointer to a user
4962 * allocated mutex. It is NULL upon AV_LOCK_CREATE and equal to the
4963 * value left by the last call for all other ops. If the lock manager is
4964 * unable to perform the op then it should leave the mutex in the same
4965 * state as when it was called and return a non-zero value. However,
4966 * when called with AV_LOCK_DESTROY the mutex will always be assumed to
4967 * have been successfully destroyed. If av_lockmgr_register succeeds
4968 * it will return a non-negative value, if it fails it will return a
4969 * negative value and destroy all mutex and unregister all callbacks.
4970 * av_lockmgr_register is not thread-safe, it must be called from a
4971 * single thread before any calls which make use of locking are used.
4973 * @param cb User defined callback. av_lockmgr_register invokes calls
4974 * to this callback and the previously registered callback.
4975 * The callback will be used to create more than one mutex
4976 * each of which must be backed by its own underlying locking
4977 * mechanism (i.e. do not use a single static object to
4978 * implement your lock manager). If cb is set to NULL the
4979 * lockmgr will be unregistered.
4981 * @deprecated This function does nothing, and always returns 0. Be sure to
4982 * build with thread support to get basic thread safety.
4984 attribute_deprecated
4985 int av_lockmgr_register(int (*cb)(void **mutex, enum AVLockOp op));
4989 * Get the type of the given codec.
4991 enum AVMediaType avcodec_get_type(enum AVCodecID codec_id);
4994 * Get the name of a codec.
4995 * @return a static string identifying the codec; never NULL
4997 const char *avcodec_get_name(enum AVCodecID id);
5000 * @return a positive value if s is open (i.e. avcodec_open2() was called on it
5001 * with no corresponding avcodec_close()), 0 otherwise.
5003 int avcodec_is_open(AVCodecContext *s);
5006 * @return a non-zero number if codec is an encoder, zero otherwise
5008 int av_codec_is_encoder(const AVCodec *codec);
5011 * @return a non-zero number if codec is a decoder, zero otherwise
5013 int av_codec_is_decoder(const AVCodec *codec);
5016 * Allocate a CPB properties structure and initialize its fields to default
5019 * @param size if non-NULL, the size of the allocated struct will be written
5020 * here. This is useful for embedding it in side data.
5022 * @return the newly allocated struct or NULL on failure
5024 AVCPBProperties *av_cpb_properties_alloc(size_t *size);
5030 #endif /* AVCODEC_AVCODEC_H */