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"
46 #include "codec_desc.h"
47 #include "codec_par.h"
53 * @defgroup libavc libavcodec
54 * Encoding/Decoding Library
58 * @defgroup lavc_decoding Decoding
62 * @defgroup lavc_encoding Encoding
66 * @defgroup lavc_codec Codecs
68 * @defgroup lavc_codec_native Native Codecs
71 * @defgroup lavc_codec_wrappers External library wrappers
74 * @defgroup lavc_codec_hwaccel Hardware Accelerators bridge
78 * @defgroup lavc_internal Internal
86 * @defgroup lavc_encdec send/receive encoding and decoding API overview
89 * The avcodec_send_packet()/avcodec_receive_frame()/avcodec_send_frame()/
90 * avcodec_receive_packet() functions provide an encode/decode API, which
91 * decouples input and output.
93 * The API is very similar for encoding/decoding and audio/video, and works as
95 * - Set up and open the AVCodecContext as usual.
97 * - For decoding, call avcodec_send_packet() to give the decoder raw
98 * compressed data in an AVPacket.
99 * - For encoding, call avcodec_send_frame() to give the encoder an AVFrame
100 * containing uncompressed audio or video.
102 * In both cases, it is recommended that AVPackets and AVFrames are
103 * refcounted, or libavcodec might have to copy the input data. (libavformat
104 * always returns refcounted AVPackets, and av_frame_get_buffer() allocates
105 * refcounted AVFrames.)
106 * - Receive output in a loop. Periodically call one of the avcodec_receive_*()
107 * functions and process their output:
108 * - For decoding, call avcodec_receive_frame(). On success, it will return
109 * an AVFrame containing uncompressed audio or video data.
110 * - For encoding, call avcodec_receive_packet(). On success, it will return
111 * an AVPacket with a compressed frame.
113 * Repeat this call until it returns AVERROR(EAGAIN) or an error. The
114 * AVERROR(EAGAIN) return value means that new input data is required to
115 * return new output. In this case, continue with sending input. For each
116 * input frame/packet, the codec will typically return 1 output frame/packet,
117 * but it can also be 0 or more than 1.
119 * At the beginning of decoding or encoding, the codec might accept multiple
120 * input frames/packets without returning a frame, until its internal buffers
121 * are filled. This situation is handled transparently if you follow the steps
124 * In theory, sending input can result in EAGAIN - this should happen only if
125 * not all output was received. You can use this to structure alternative decode
126 * or encode loops other than the one suggested above. For example, you could
127 * try sending new input on each iteration, and try to receive output if that
130 * End of stream situations. These require "flushing" (aka draining) the codec,
131 * as the codec might buffer multiple frames or packets internally for
132 * performance or out of necessity (consider B-frames).
133 * This is handled as follows:
134 * - Instead of valid input, send NULL to the avcodec_send_packet() (decoding)
135 * or avcodec_send_frame() (encoding) functions. This will enter draining
137 * - Call avcodec_receive_frame() (decoding) or avcodec_receive_packet()
138 * (encoding) in a loop until AVERROR_EOF is returned. The functions will
139 * not return AVERROR(EAGAIN), unless you forgot to enter draining mode.
140 * - Before decoding can be resumed again, the codec has to be reset with
141 * avcodec_flush_buffers().
143 * Using the API as outlined above is highly recommended. But it is also
144 * possible to call functions outside of this rigid schema. For example, you can
145 * call avcodec_send_packet() repeatedly without calling
146 * avcodec_receive_frame(). In this case, avcodec_send_packet() will succeed
147 * until the codec's internal buffer has been filled up (which is typically of
148 * size 1 per output frame, after initial input), and then reject input with
149 * AVERROR(EAGAIN). Once it starts rejecting input, you have no choice but to
150 * read at least some output.
152 * Not all codecs will follow a rigid and predictable dataflow; the only
153 * guarantee is that an AVERROR(EAGAIN) return value on a send/receive call on
154 * one end implies that a receive/send call on the other end will succeed, or
155 * at least will not fail with AVERROR(EAGAIN). In general, no codec will
156 * permit unlimited buffering of input or output.
158 * This API replaces the following legacy functions:
159 * - avcodec_decode_video2() and avcodec_decode_audio4():
160 * Use avcodec_send_packet() to feed input to the decoder, then use
161 * avcodec_receive_frame() to receive decoded frames after each packet.
162 * Unlike with the old video decoding API, multiple frames might result from
163 * a packet. For audio, splitting the input packet into frames by partially
164 * decoding packets becomes transparent to the API user. You never need to
165 * feed an AVPacket to the API twice (unless it is rejected with AVERROR(EAGAIN) - then
166 * no data was read from the packet).
167 * Additionally, sending a flush/draining packet is required only once.
168 * - avcodec_encode_video2()/avcodec_encode_audio2():
169 * Use avcodec_send_frame() to feed input to the encoder, then use
170 * avcodec_receive_packet() to receive encoded packets.
171 * Providing user-allocated buffers for avcodec_receive_packet() is not
173 * - The new API does not handle subtitles yet.
175 * Mixing new and old function calls on the same AVCodecContext is not allowed,
176 * and will result in undefined behavior.
178 * Some codecs might require using the new API; using the old API will return
179 * an error when calling it. All codecs support the new API.
181 * A codec is not allowed to return AVERROR(EAGAIN) for both sending and receiving. This
182 * would be an invalid state, which could put the codec user into an endless
183 * loop. The API has no concept of time either: it cannot happen that trying to
184 * do avcodec_send_packet() results in AVERROR(EAGAIN), but a repeated call 1 second
185 * later accepts the packet (with no other receive/flush API calls involved).
186 * The API is a strict state machine, and the passage of time is not supposed
187 * to influence it. Some timing-dependent behavior might still be deemed
188 * acceptable in certain cases. But it must never result in both send/receive
189 * returning EAGAIN at the same time at any point. It must also absolutely be
190 * avoided that the current state is "unstable" and can "flip-flop" between
191 * the send/receive APIs allowing progress. For example, it's not allowed that
192 * the codec randomly decides that it actually wants to consume a packet now
193 * instead of returning a frame, after it just returned AVERROR(EAGAIN) on an
194 * avcodec_send_packet() call.
199 * @defgroup lavc_core Core functions/structures.
202 * Basic definitions, functions for querying libavcodec capabilities,
203 * allocating core structures, etc.
208 * @ingroup lavc_decoding
209 * Required number of additionally allocated bytes at the end of the input bitstream for decoding.
210 * This is mainly needed because some optimized bitstream readers read
211 * 32 or 64 bit at once and could read over the end.<br>
212 * Note: If the first 23 bits of the additional bytes are not 0, then damaged
213 * MPEG bitstreams could cause overread and segfault.
215 #define AV_INPUT_BUFFER_PADDING_SIZE 64
218 * @ingroup lavc_encoding
219 * minimum encoding buffer size
220 * Used to avoid some checks during header writing.
222 #define AV_INPUT_BUFFER_MIN_SIZE 16384
225 * @ingroup lavc_decoding
228 /* We leave some space between them for extensions (drop some
229 * keyframes for intra-only or drop just some bidir frames). */
230 AVDISCARD_NONE =-16, ///< discard nothing
231 AVDISCARD_DEFAULT = 0, ///< discard useless packets like 0 size packets in avi
232 AVDISCARD_NONREF = 8, ///< discard all non reference
233 AVDISCARD_BIDIR = 16, ///< discard all bidirectional frames
234 AVDISCARD_NONINTRA= 24, ///< discard all non intra frames
235 AVDISCARD_NONKEY = 32, ///< discard all frames except keyframes
236 AVDISCARD_ALL = 48, ///< discard all
239 enum AVAudioServiceType {
240 AV_AUDIO_SERVICE_TYPE_MAIN = 0,
241 AV_AUDIO_SERVICE_TYPE_EFFECTS = 1,
242 AV_AUDIO_SERVICE_TYPE_VISUALLY_IMPAIRED = 2,
243 AV_AUDIO_SERVICE_TYPE_HEARING_IMPAIRED = 3,
244 AV_AUDIO_SERVICE_TYPE_DIALOGUE = 4,
245 AV_AUDIO_SERVICE_TYPE_COMMENTARY = 5,
246 AV_AUDIO_SERVICE_TYPE_EMERGENCY = 6,
247 AV_AUDIO_SERVICE_TYPE_VOICE_OVER = 7,
248 AV_AUDIO_SERVICE_TYPE_KARAOKE = 8,
249 AV_AUDIO_SERVICE_TYPE_NB , ///< Not part of ABI
253 * @ingroup lavc_encoding
255 typedef struct RcOverride{
258 int qscale; // If this is 0 then quality_factor will be used instead.
259 float quality_factor;
263 These flags can be passed in AVCodecContext.flags before initialization.
264 Note: Not everything is supported yet.
268 * Allow decoders to produce frames with data planes that are not aligned
269 * to CPU requirements (e.g. due to cropping).
271 #define AV_CODEC_FLAG_UNALIGNED (1 << 0)
275 #define AV_CODEC_FLAG_QSCALE (1 << 1)
277 * 4 MV per MB allowed / advanced prediction for H.263.
279 #define AV_CODEC_FLAG_4MV (1 << 2)
281 * Output even those frames that might be corrupted.
283 #define AV_CODEC_FLAG_OUTPUT_CORRUPT (1 << 3)
287 #define AV_CODEC_FLAG_QPEL (1 << 4)
289 * Don't output frames whose parameters differ from first
290 * decoded frame in stream.
292 #define AV_CODEC_FLAG_DROPCHANGED (1 << 5)
294 * Use internal 2pass ratecontrol in first pass mode.
296 #define AV_CODEC_FLAG_PASS1 (1 << 9)
298 * Use internal 2pass ratecontrol in second pass mode.
300 #define AV_CODEC_FLAG_PASS2 (1 << 10)
304 #define AV_CODEC_FLAG_LOOP_FILTER (1 << 11)
306 * Only decode/encode grayscale.
308 #define AV_CODEC_FLAG_GRAY (1 << 13)
310 * error[?] variables will be set during encoding.
312 #define AV_CODEC_FLAG_PSNR (1 << 15)
314 * Input bitstream might be truncated at a random location
315 * instead of only at frame boundaries.
317 #define AV_CODEC_FLAG_TRUNCATED (1 << 16)
319 * Use interlaced DCT.
321 #define AV_CODEC_FLAG_INTERLACED_DCT (1 << 18)
325 #define AV_CODEC_FLAG_LOW_DELAY (1 << 19)
327 * Place global headers in extradata instead of every keyframe.
329 #define AV_CODEC_FLAG_GLOBAL_HEADER (1 << 22)
331 * Use only bitexact stuff (except (I)DCT).
333 #define AV_CODEC_FLAG_BITEXACT (1 << 23)
334 /* Fx : Flag for H.263+ extra options */
336 * H.263 advanced intra coding / MPEG-4 AC prediction
338 #define AV_CODEC_FLAG_AC_PRED (1 << 24)
340 * interlaced motion estimation
342 #define AV_CODEC_FLAG_INTERLACED_ME (1 << 29)
343 #define AV_CODEC_FLAG_CLOSED_GOP (1U << 31)
346 * Allow non spec compliant speedup tricks.
348 #define AV_CODEC_FLAG2_FAST (1 << 0)
350 * Skip bitstream encoding.
352 #define AV_CODEC_FLAG2_NO_OUTPUT (1 << 2)
354 * Place global headers at every keyframe instead of in extradata.
356 #define AV_CODEC_FLAG2_LOCAL_HEADER (1 << 3)
359 * timecode is in drop frame format. DEPRECATED!!!!
361 #define AV_CODEC_FLAG2_DROP_FRAME_TIMECODE (1 << 13)
364 * Input bitstream might be truncated at a packet boundaries
365 * instead of only at frame boundaries.
367 #define AV_CODEC_FLAG2_CHUNKS (1 << 15)
369 * Discard cropping information from SPS.
371 #define AV_CODEC_FLAG2_IGNORE_CROP (1 << 16)
374 * Show all frames before the first keyframe
376 #define AV_CODEC_FLAG2_SHOW_ALL (1 << 22)
378 * Export motion vectors through frame side data
380 #define AV_CODEC_FLAG2_EXPORT_MVS (1 << 28)
382 * Do not skip samples and export skip information as frame side data
384 #define AV_CODEC_FLAG2_SKIP_MANUAL (1 << 29)
386 * Do not reset ASS ReadOrder field on flush (subtitles decoding)
388 #define AV_CODEC_FLAG2_RO_FLUSH_NOOP (1 << 30)
390 /* Unsupported options :
391 * Syntax Arithmetic coding (SAC)
392 * Reference Picture Selection
393 * Independent Segment Decoding */
395 /* codec capabilities */
397 /* Exported side data.
398 These flags can be passed in AVCodecContext.export_side_data before initialization.
401 * Export motion vectors through frame side data
403 #define AV_CODEC_EXPORT_DATA_MVS (1 << 0)
405 * Export encoder Producer Reference Time through packet side data
407 #define AV_CODEC_EXPORT_DATA_PRFT (1 << 1)
410 * Export the AVVideoEncParams structure through frame side data.
412 #define AV_CODEC_EXPORT_DATA_VIDEO_ENC_PARAMS (1 << 2)
415 * Do not apply film grain, export it instead.
417 #define AV_CODEC_EXPORT_DATA_FILM_GRAIN (1 << 3)
421 * This specifies the area which should be displayed.
422 * Note there may be multiple such areas for one frame.
424 typedef struct AVPanScan {
427 * - encoding: Set by user.
428 * - decoding: Set by libavcodec.
433 * width and height in 1/16 pel
434 * - encoding: Set by user.
435 * - decoding: Set by libavcodec.
441 * position of the top left corner in 1/16 pel for up to 3 fields/frames
442 * - encoding: Set by user.
443 * - decoding: Set by libavcodec.
445 int16_t position[3][2];
449 * This structure describes the bitrate properties of an encoded bitstream. It
450 * roughly corresponds to a subset the VBV parameters for MPEG-2 or HRD
451 * parameters for H.264/HEVC.
453 typedef struct AVCPBProperties {
455 * Maximum bitrate of the stream, in bits per second.
456 * Zero if unknown or unspecified.
458 #if FF_API_UNSANITIZED_BITRATES
464 * Minimum bitrate of the stream, in bits per second.
465 * Zero if unknown or unspecified.
467 #if FF_API_UNSANITIZED_BITRATES
473 * Average bitrate of the stream, in bits per second.
474 * Zero if unknown or unspecified.
476 #if FF_API_UNSANITIZED_BITRATES
483 * The size of the buffer to which the ratecontrol is applied, in bits.
484 * Zero if unknown or unspecified.
489 * The delay between the time the packet this structure is associated with
490 * is received and the time when it should be decoded, in periods of a 27MHz
493 * UINT64_MAX when unknown or unspecified.
499 * This structure supplies correlation between a packet timestamp and a wall clock
500 * production time. The definition follows the Producer Reference Time ('prft')
501 * as defined in ISO/IEC 14496-12
503 typedef struct AVProducerReferenceTime {
505 * A UTC timestamp, in microseconds, since Unix epoch (e.g, av_gettime()).
509 } AVProducerReferenceTime;
512 * The decoder will keep a reference to the frame and may reuse it later.
514 #define AV_GET_BUFFER_FLAG_REF (1 << 0)
516 struct AVCodecInternal;
519 * main external API structure.
520 * New fields can be added to the end with minor version bumps.
521 * Removal, reordering and changes to existing fields require a major
523 * You can use AVOptions (av_opt* / av_set/get*()) to access these fields from user
525 * The name string for AVOptions options matches the associated command line
526 * parameter name and can be found in libavcodec/options_table.h
527 * The AVOption/command line parameter names differ in some cases from the C
528 * structure field names for historic reasons or brevity.
529 * sizeof(AVCodecContext) must not be used outside libav*.
531 typedef struct AVCodecContext {
533 * information on struct for av_log
534 * - set by avcodec_alloc_context3
536 const AVClass *av_class;
537 int log_level_offset;
539 enum AVMediaType codec_type; /* see AVMEDIA_TYPE_xxx */
540 const struct AVCodec *codec;
541 enum AVCodecID codec_id; /* see AV_CODEC_ID_xxx */
544 * fourcc (LSB first, so "ABCD" -> ('D'<<24) + ('C'<<16) + ('B'<<8) + 'A').
545 * This is used to work around some encoder bugs.
546 * A demuxer should set this to what is stored in the field used to identify the codec.
547 * If there are multiple such fields in a container then the demuxer should choose the one
548 * which maximizes the information about the used codec.
549 * If the codec tag field in a container is larger than 32 bits then the demuxer should
550 * remap the longer ID to 32 bits with a table or other structure. Alternatively a new
551 * extra_codec_tag + size could be added but for this a clear advantage must be demonstrated
553 * - encoding: Set by user, if not then the default based on codec_id will be used.
554 * - decoding: Set by user, will be converted to uppercase by libavcodec during init.
556 unsigned int codec_tag;
561 * Private context used for internal data.
563 * Unlike priv_data, this is not codec-specific. It is used in general
564 * libavcodec functions.
566 struct AVCodecInternal *internal;
569 * Private data of the user, can be used to carry app specific stuff.
570 * - encoding: Set by user.
571 * - decoding: Set by user.
576 * the average bitrate
577 * - encoding: Set by user; unused for constant quantizer encoding.
578 * - decoding: Set by user, may be overwritten by libavcodec
579 * if this info is available in the stream
584 * number of bits the bitstream is allowed to diverge from the reference.
585 * the reference can be CBR (for CBR pass1) or VBR (for pass2)
586 * - encoding: Set by user; unused for constant quantizer encoding.
589 int bit_rate_tolerance;
592 * Global quality for codecs which cannot change it per frame.
593 * This should be proportional to MPEG-1/2/4 qscale.
594 * - encoding: Set by user.
600 * - encoding: Set by user.
603 int compression_level;
604 #define FF_COMPRESSION_DEFAULT -1
608 * - encoding: Set by user.
609 * - decoding: Set by user.
615 * - encoding: Set by user.
616 * - decoding: Set by user.
621 * some codecs need / can use extradata like Huffman tables.
622 * MJPEG: Huffman tables
623 * rv10: additional flags
624 * MPEG-4: global headers (they can be in the bitstream or here)
625 * The allocated memory should be AV_INPUT_BUFFER_PADDING_SIZE bytes larger
626 * than extradata_size to avoid problems if it is read with the bitstream reader.
627 * The bytewise contents of extradata must not depend on the architecture or CPU endianness.
628 * Must be allocated with the av_malloc() family of functions.
629 * - encoding: Set/allocated/freed by libavcodec.
630 * - decoding: Set/allocated/freed by user.
636 * This is the fundamental unit of time (in seconds) in terms
637 * of which frame timestamps are represented. For fixed-fps content,
638 * timebase should be 1/framerate and timestamp increments should be
640 * This often, but not always is the inverse of the frame rate or field rate
641 * for video. 1/time_base is not the average frame rate if the frame rate is not
644 * Like containers, elementary streams also can store timestamps, 1/time_base
645 * is the unit in which these timestamps are specified.
646 * As example of such codec time base see ISO/IEC 14496-2:2001(E)
647 * vop_time_increment_resolution and fixed_vop_rate
648 * (fixed_vop_rate == 0 implies that it is different from the framerate)
650 * - encoding: MUST be set by user.
651 * - decoding: the use of this field for decoding is deprecated.
652 * Use framerate instead.
654 AVRational time_base;
657 * For some codecs, the time base is closer to the field rate than the frame rate.
658 * Most notably, H.264 and MPEG-2 specify time_base as half of frame duration
659 * if no telecine is used ...
661 * Set to time_base ticks per frame. Default 1, e.g., H.264/MPEG-2 set it to 2.
668 * Encoding: Number of frames delay there will be from the encoder input to
669 * the decoder output. (we assume the decoder matches the spec)
670 * Decoding: Number of frames delay in addition to what a standard decoder
671 * as specified in the spec would produce.
674 * Number of frames the decoded output will be delayed relative to the
678 * For encoding, this field is unused (see initial_padding).
680 * For decoding, this is the number of samples the decoder needs to
681 * output before the decoder's output is valid. When seeking, you should
682 * start decoding this many samples prior to your desired seek point.
684 * - encoding: Set by libavcodec.
685 * - decoding: Set by libavcodec.
692 * picture width / height.
694 * @note Those fields may not match the values of the last
695 * AVFrame output by avcodec_decode_video2 due frame
698 * - encoding: MUST be set by user.
699 * - decoding: May be set by the user before opening the decoder if known e.g.
700 * from the container. Some decoders will require the dimensions
701 * to be set by the caller. During decoding, the decoder may
702 * overwrite those values as required while parsing the data.
707 * Bitstream width / height, may be different from width/height e.g. when
708 * the decoded frame is cropped before being output or lowres is enabled.
710 * @note Those field may not match the value of the last
711 * AVFrame output by avcodec_receive_frame() due frame
715 * - decoding: May be set by the user before opening the decoder if known
716 * e.g. from the container. During decoding, the decoder may
717 * overwrite those values as required while parsing the data.
719 int coded_width, coded_height;
722 * the number of pictures in a group of pictures, or 0 for intra_only
723 * - encoding: Set by user.
729 * Pixel format, see AV_PIX_FMT_xxx.
730 * May be set by the demuxer if known from headers.
731 * May be overridden by the decoder if it knows better.
733 * @note This field may not match the value of the last
734 * AVFrame output by avcodec_receive_frame() due frame
737 * - encoding: Set by user.
738 * - decoding: Set by user if known, overridden by libavcodec while
741 enum AVPixelFormat pix_fmt;
744 * If non NULL, 'draw_horiz_band' is called by the libavcodec
745 * decoder to draw a horizontal band. It improves cache usage. Not
746 * all codecs can do that. You must check the codec capabilities
748 * When multithreading is used, it may be called from multiple threads
749 * at the same time; threads might draw different parts of the same AVFrame,
750 * or multiple AVFrames, and there is no guarantee that slices will be drawn
752 * The function is also used by hardware acceleration APIs.
753 * It is called at least once during frame decoding to pass
754 * the data needed for hardware render.
755 * In that mode instead of pixel data, AVFrame points to
756 * a structure specific to the acceleration API. The application
757 * reads the structure and can change some fields to indicate progress
760 * - decoding: Set by user.
761 * @param height the height of the slice
762 * @param y the y position of the slice
763 * @param type 1->top field, 2->bottom field, 3->frame
764 * @param offset offset into the AVFrame.data from which the slice should be read
766 void (*draw_horiz_band)(struct AVCodecContext *s,
767 const AVFrame *src, int offset[AV_NUM_DATA_POINTERS],
768 int y, int type, int height);
771 * callback to negotiate the pixelFormat
772 * @param fmt is the list of formats which are supported by the codec,
773 * it is terminated by -1 as 0 is a valid format, the formats are ordered by quality.
774 * The first is always the native one.
775 * @note The callback may be called again immediately if initialization for
776 * the selected (hardware-accelerated) pixel format failed.
777 * @warning Behavior is undefined if the callback returns a value not
778 * in the fmt list of formats.
779 * @return the chosen format
781 * - decoding: Set by user, if not set the native format will be chosen.
783 enum AVPixelFormat (*get_format)(struct AVCodecContext *s, const enum AVPixelFormat * fmt);
786 * maximum number of B-frames between non-B-frames
787 * Note: The output will be delayed by max_b_frames+1 relative to the input.
788 * - encoding: Set by user.
794 * qscale factor between IP and B-frames
795 * If > 0 then the last P-frame quantizer will be used (q= lastp_q*factor+offset).
796 * If < 0 then normal ratecontrol will be done (q= -normal_q*factor+offset).
797 * - encoding: Set by user.
800 float b_quant_factor;
802 #if FF_API_PRIVATE_OPT
803 /** @deprecated use encoder private options instead */
805 int b_frame_strategy;
809 * qscale offset between IP and B-frames
810 * - encoding: Set by user.
813 float b_quant_offset;
816 * Size of the frame reordering buffer in the decoder.
817 * For MPEG-2 it is 1 IPB or 0 low delay IP.
818 * - encoding: Set by libavcodec.
819 * - decoding: Set by libavcodec.
823 #if FF_API_PRIVATE_OPT
824 /** @deprecated use encoder private options instead */
830 * qscale factor between P- and I-frames
831 * If > 0 then the last P-frame quantizer will be used (q = lastp_q * factor + offset).
832 * If < 0 then normal ratecontrol will be done (q= -normal_q*factor+offset).
833 * - encoding: Set by user.
836 float i_quant_factor;
839 * qscale offset between P and I-frames
840 * - encoding: Set by user.
843 float i_quant_offset;
846 * luminance masking (0-> disabled)
847 * - encoding: Set by user.
853 * temporary complexity masking (0-> disabled)
854 * - encoding: Set by user.
857 float temporal_cplx_masking;
860 * spatial complexity masking (0-> disabled)
861 * - encoding: Set by user.
864 float spatial_cplx_masking;
867 * p block masking (0-> disabled)
868 * - encoding: Set by user.
874 * darkness masking (0-> disabled)
875 * - encoding: Set by user.
882 * - encoding: Set by libavcodec.
883 * - decoding: Set by user (or 0).
887 #if FF_API_PRIVATE_OPT
888 /** @deprecated use encoder private options instead */
890 int prediction_method;
891 #define FF_PRED_LEFT 0
892 #define FF_PRED_PLANE 1
893 #define FF_PRED_MEDIAN 2
897 * slice offsets in the frame in bytes
898 * - encoding: Set/allocated by libavcodec.
899 * - decoding: Set/allocated by user (or NULL).
904 * sample aspect ratio (0 if unknown)
905 * That is the width of a pixel divided by the height of the pixel.
906 * Numerator and denominator must be relatively prime and smaller than 256 for some video standards.
907 * - encoding: Set by user.
908 * - decoding: Set by libavcodec.
910 AVRational sample_aspect_ratio;
913 * motion estimation comparison function
914 * - encoding: Set by user.
919 * subpixel motion estimation comparison function
920 * - encoding: Set by user.
925 * macroblock comparison function (not supported yet)
926 * - encoding: Set by user.
931 * interlaced DCT comparison function
932 * - encoding: Set by user.
938 #define FF_CMP_SATD 2
940 #define FF_CMP_PSNR 4
943 #define FF_CMP_ZERO 7
944 #define FF_CMP_VSAD 8
945 #define FF_CMP_VSSE 9
946 #define FF_CMP_NSSE 10
947 #define FF_CMP_W53 11
948 #define FF_CMP_W97 12
949 #define FF_CMP_DCTMAX 13
950 #define FF_CMP_DCT264 14
951 #define FF_CMP_MEDIAN_SAD 15
952 #define FF_CMP_CHROMA 256
955 * ME diamond size & shape
956 * - encoding: Set by user.
962 * amount of previous MV predictors (2a+1 x 2a+1 square)
963 * - encoding: Set by user.
966 int last_predictor_count;
968 #if FF_API_PRIVATE_OPT
969 /** @deprecated use encoder private options instead */
975 * motion estimation prepass comparison function
976 * - encoding: Set by user.
982 * ME prepass diamond size & shape
983 * - encoding: Set by user.
990 * - encoding: Set by user.
993 int me_subpel_quality;
996 * maximum motion estimation search range in subpel units
997 * If 0 then no limit.
999 * - encoding: Set by user.
1000 * - decoding: unused
1006 * - encoding: unused
1007 * - decoding: Set by user.
1010 #define SLICE_FLAG_CODED_ORDER 0x0001 ///< draw_horiz_band() is called in coded order instead of display
1011 #define SLICE_FLAG_ALLOW_FIELD 0x0002 ///< allow draw_horiz_band() with field slices (MPEG-2 field pics)
1012 #define SLICE_FLAG_ALLOW_PLANE 0x0004 ///< allow draw_horiz_band() with 1 component at a time (SVQ1)
1015 * macroblock decision mode
1016 * - encoding: Set by user.
1017 * - decoding: unused
1020 #define FF_MB_DECISION_SIMPLE 0 ///< uses mb_cmp
1021 #define FF_MB_DECISION_BITS 1 ///< chooses the one which needs the fewest bits
1022 #define FF_MB_DECISION_RD 2 ///< rate distortion
1025 * custom intra quantization matrix
1026 * Must be allocated with the av_malloc() family of functions, and will be freed in
1027 * avcodec_free_context().
1028 * - encoding: Set/allocated by user, freed by libavcodec. Can be NULL.
1029 * - decoding: Set/allocated/freed by libavcodec.
1031 uint16_t *intra_matrix;
1034 * custom inter quantization matrix
1035 * Must be allocated with the av_malloc() family of functions, and will be freed in
1036 * avcodec_free_context().
1037 * - encoding: Set/allocated by user, freed by libavcodec. Can be NULL.
1038 * - decoding: Set/allocated/freed by libavcodec.
1040 uint16_t *inter_matrix;
1042 #if FF_API_PRIVATE_OPT
1043 /** @deprecated use encoder private options instead */
1044 attribute_deprecated
1045 int scenechange_threshold;
1047 /** @deprecated use encoder private options instead */
1048 attribute_deprecated
1049 int noise_reduction;
1053 * precision of the intra DC coefficient - 8
1054 * - encoding: Set by user.
1055 * - decoding: Set by libavcodec
1057 int intra_dc_precision;
1060 * Number of macroblock rows at the top which are skipped.
1061 * - encoding: unused
1062 * - decoding: Set by user.
1067 * Number of macroblock rows at the bottom which are skipped.
1068 * - encoding: unused
1069 * - decoding: Set by user.
1074 * minimum MB Lagrange multiplier
1075 * - encoding: Set by user.
1076 * - decoding: unused
1081 * maximum MB Lagrange multiplier
1082 * - encoding: Set by user.
1083 * - decoding: unused
1087 #if FF_API_PRIVATE_OPT
1089 * @deprecated use encoder private options instead
1091 attribute_deprecated
1092 int me_penalty_compensation;
1096 * - encoding: Set by user.
1097 * - decoding: unused
1101 #if FF_API_PRIVATE_OPT
1102 /** @deprecated use encoder private options instead */
1103 attribute_deprecated
1109 * - encoding: Set by user.
1110 * - decoding: unused
1115 * number of reference frames
1116 * - encoding: Set by user.
1117 * - decoding: Set by lavc.
1121 #if FF_API_PRIVATE_OPT
1122 /** @deprecated use encoder private options instead */
1123 attribute_deprecated
1128 * Note: Value depends upon the compare function used for fullpel ME.
1129 * - encoding: Set by user.
1130 * - decoding: unused
1134 #if FF_API_PRIVATE_OPT
1135 /** @deprecated use encoder private options instead */
1136 attribute_deprecated
1141 * Chromaticity coordinates of the source primaries.
1142 * - encoding: Set by user
1143 * - decoding: Set by libavcodec
1145 enum AVColorPrimaries color_primaries;
1148 * Color Transfer Characteristic.
1149 * - encoding: Set by user
1150 * - decoding: Set by libavcodec
1152 enum AVColorTransferCharacteristic color_trc;
1155 * YUV colorspace type.
1156 * - encoding: Set by user
1157 * - decoding: Set by libavcodec
1159 enum AVColorSpace colorspace;
1162 * MPEG vs JPEG YUV range.
1163 * - encoding: Set by user
1164 * - decoding: Set by libavcodec
1166 enum AVColorRange color_range;
1169 * This defines the location of chroma samples.
1170 * - encoding: Set by user
1171 * - decoding: Set by libavcodec
1173 enum AVChromaLocation chroma_sample_location;
1177 * Indicates number of picture subdivisions. Used for parallelized
1179 * - encoding: Set by user
1180 * - decoding: unused
1185 * - encoding: set by libavcodec
1186 * - decoding: Set by user.
1188 enum AVFieldOrder field_order;
1191 int sample_rate; ///< samples per second
1192 int channels; ///< number of audio channels
1195 * audio sample format
1196 * - encoding: Set by user.
1197 * - decoding: Set by libavcodec.
1199 enum AVSampleFormat sample_fmt; ///< sample format
1201 /* The following data should not be initialized. */
1203 * Number of samples per channel in an audio frame.
1205 * - encoding: set by libavcodec in avcodec_open2(). Each submitted frame
1206 * except the last must contain exactly frame_size samples per channel.
1207 * May be 0 when the codec has AV_CODEC_CAP_VARIABLE_FRAME_SIZE set, then the
1208 * frame size is not restricted.
1209 * - decoding: may be set by some decoders to indicate constant frame size
1214 * Frame counter, set by libavcodec.
1216 * - decoding: total number of frames returned from the decoder so far.
1217 * - encoding: total number of frames passed to the encoder so far.
1219 * @note the counter is not incremented if encoding/decoding resulted in
1225 * number of bytes per packet if constant and known or 0
1226 * Used by some WAV based audio codecs.
1231 * Audio cutoff bandwidth (0 means "automatic")
1232 * - encoding: Set by user.
1233 * - decoding: unused
1238 * Audio channel layout.
1239 * - encoding: set by user.
1240 * - decoding: set by user, may be overwritten by libavcodec.
1242 uint64_t channel_layout;
1245 * Request decoder to use this channel layout if it can (0 for default)
1246 * - encoding: unused
1247 * - decoding: Set by user.
1249 uint64_t request_channel_layout;
1252 * Type of service that the audio stream conveys.
1253 * - encoding: Set by user.
1254 * - decoding: Set by libavcodec.
1256 enum AVAudioServiceType audio_service_type;
1259 * desired sample format
1260 * - encoding: Not used.
1261 * - decoding: Set by user.
1262 * Decoder will decode to this format if it can.
1264 enum AVSampleFormat request_sample_fmt;
1267 * This callback is called at the beginning of each frame to get data
1268 * buffer(s) for it. There may be one contiguous buffer for all the data or
1269 * there may be a buffer per each data plane or anything in between. What
1270 * this means is, you may set however many entries in buf[] you feel necessary.
1271 * Each buffer must be reference-counted using the AVBuffer API (see description
1274 * The following fields will be set in the frame before this callback is
1277 * - width, height (video only)
1278 * - sample_rate, channel_layout, nb_samples (audio only)
1279 * Their values may differ from the corresponding values in
1280 * AVCodecContext. This callback must use the frame values, not the codec
1281 * context values, to calculate the required buffer size.
1283 * This callback must fill the following fields in the frame:
1287 * * if the data is planar audio with more than 8 channels, then this
1288 * callback must allocate and fill extended_data to contain all pointers
1289 * to all data planes. data[] must hold as many pointers as it can.
1290 * extended_data must be allocated with av_malloc() and will be freed in
1292 * * otherwise extended_data must point to data
1293 * - buf[] must contain one or more pointers to AVBufferRef structures. Each of
1294 * the frame's data and extended_data pointers must be contained in these. That
1295 * is, one AVBufferRef for each allocated chunk of memory, not necessarily one
1296 * AVBufferRef per data[] entry. See: av_buffer_create(), av_buffer_alloc(),
1297 * and av_buffer_ref().
1298 * - extended_buf and nb_extended_buf must be allocated with av_malloc() by
1299 * this callback and filled with the extra buffers if there are more
1300 * buffers than buf[] can hold. extended_buf will be freed in
1303 * If AV_CODEC_CAP_DR1 is not set then get_buffer2() must call
1304 * avcodec_default_get_buffer2() instead of providing buffers allocated by
1307 * Each data plane must be aligned to the maximum required by the target
1310 * @see avcodec_default_get_buffer2()
1314 * If AV_GET_BUFFER_FLAG_REF is set in flags then the frame may be reused
1315 * (read and/or written to if it is writable) later by libavcodec.
1317 * avcodec_align_dimensions2() should be used to find the required width and
1318 * height, as they normally need to be rounded up to the next multiple of 16.
1320 * Some decoders do not support linesizes changing between frames.
1322 * If frame multithreading is used, this callback may be called from a
1323 * different thread, but not from more than one at once. Does not need to be
1326 * @see avcodec_align_dimensions2()
1330 * Decoders request a buffer of a particular size by setting
1331 * AVFrame.nb_samples prior to calling get_buffer2(). The decoder may,
1332 * however, utilize only part of the buffer by setting AVFrame.nb_samples
1333 * to a smaller value in the output frame.
1335 * As a convenience, av_samples_get_buffer_size() and
1336 * av_samples_fill_arrays() in libavutil may be used by custom get_buffer2()
1337 * functions to find the required data size and to fill data pointers and
1338 * linesize. In AVFrame.linesize, only linesize[0] may be set for audio
1339 * since all planes must be the same size.
1341 * @see av_samples_get_buffer_size(), av_samples_fill_arrays()
1343 * - encoding: unused
1344 * - decoding: Set by libavcodec, user can override.
1346 int (*get_buffer2)(struct AVCodecContext *s, AVFrame *frame, int flags);
1349 * If non-zero, the decoded audio and video frames returned from
1350 * avcodec_decode_video2() and avcodec_decode_audio4() are reference-counted
1351 * and are valid indefinitely. The caller must free them with
1352 * av_frame_unref() when they are not needed anymore.
1353 * Otherwise, the decoded frames must not be freed by the caller and are
1354 * only valid until the next decode call.
1356 * This is always automatically enabled if avcodec_receive_frame() is used.
1358 * - encoding: unused
1359 * - decoding: set by the caller before avcodec_open2().
1361 attribute_deprecated
1362 int refcounted_frames;
1364 /* - encoding parameters */
1365 float qcompress; ///< amount of qscale change between easy & hard scenes (0.0-1.0)
1366 float qblur; ///< amount of qscale smoothing over time (0.0-1.0)
1370 * - encoding: Set by user.
1371 * - decoding: unused
1377 * - encoding: Set by user.
1378 * - decoding: unused
1383 * maximum quantizer difference between frames
1384 * - encoding: Set by user.
1385 * - decoding: unused
1390 * decoder bitstream buffer size
1391 * - encoding: Set by user.
1392 * - decoding: unused
1397 * ratecontrol override, see RcOverride
1398 * - encoding: Allocated/set/freed by user.
1399 * - decoding: unused
1401 int rc_override_count;
1402 RcOverride *rc_override;
1406 * - encoding: Set by user.
1407 * - decoding: Set by user, may be overwritten by libavcodec.
1409 int64_t rc_max_rate;
1413 * - encoding: Set by user.
1414 * - decoding: unused
1416 int64_t rc_min_rate;
1419 * Ratecontrol attempt to use, at maximum, <value> of what can be used without an underflow.
1420 * - encoding: Set by user.
1421 * - decoding: unused.
1423 float rc_max_available_vbv_use;
1426 * Ratecontrol attempt to use, at least, <value> times the amount needed to prevent a vbv overflow.
1427 * - encoding: Set by user.
1428 * - decoding: unused.
1430 float rc_min_vbv_overflow_use;
1433 * Number of bits which should be loaded into the rc buffer before decoding starts.
1434 * - encoding: Set by user.
1435 * - decoding: unused
1437 int rc_initial_buffer_occupancy;
1439 #if FF_API_CODER_TYPE
1440 #define FF_CODER_TYPE_VLC 0
1441 #define FF_CODER_TYPE_AC 1
1442 #define FF_CODER_TYPE_RAW 2
1443 #define FF_CODER_TYPE_RLE 3
1445 * @deprecated use encoder private options instead
1447 attribute_deprecated
1449 #endif /* FF_API_CODER_TYPE */
1451 #if FF_API_PRIVATE_OPT
1452 /** @deprecated use encoder private options instead */
1453 attribute_deprecated
1457 #if FF_API_PRIVATE_OPT
1458 /** @deprecated use encoder private options instead */
1459 attribute_deprecated
1460 int frame_skip_threshold;
1462 /** @deprecated use encoder private options instead */
1463 attribute_deprecated
1464 int frame_skip_factor;
1466 /** @deprecated use encoder private options instead */
1467 attribute_deprecated
1470 /** @deprecated use encoder private options instead */
1471 attribute_deprecated
1473 #endif /* FF_API_PRIVATE_OPT */
1476 * trellis RD quantization
1477 * - encoding: Set by user.
1478 * - decoding: unused
1482 #if FF_API_PRIVATE_OPT
1483 /** @deprecated use encoder private options instead */
1484 attribute_deprecated
1485 int min_prediction_order;
1487 /** @deprecated use encoder private options instead */
1488 attribute_deprecated
1489 int max_prediction_order;
1491 /** @deprecated use encoder private options instead */
1492 attribute_deprecated
1493 int64_t timecode_frame_start;
1496 #if FF_API_RTP_CALLBACK
1498 * @deprecated unused
1500 /* The RTP callback: This function is called */
1501 /* every time the encoder has a packet to send. */
1502 /* It depends on the encoder if the data starts */
1503 /* with a Start Code (it should). H.263 does. */
1504 /* mb_nb contains the number of macroblocks */
1505 /* encoded in the RTP payload. */
1506 attribute_deprecated
1507 void (*rtp_callback)(struct AVCodecContext *avctx, void *data, int size, int mb_nb);
1510 #if FF_API_PRIVATE_OPT
1511 /** @deprecated use encoder private options instead */
1512 attribute_deprecated
1513 int rtp_payload_size; /* The size of the RTP payload: the coder will */
1514 /* do its best to deliver a chunk with size */
1515 /* below rtp_payload_size, the chunk will start */
1516 /* with a start code on some codecs like H.263. */
1517 /* This doesn't take account of any particular */
1518 /* headers inside the transmitted RTP payload. */
1521 #if FF_API_STAT_BITS
1522 /* statistics, used for 2-pass encoding */
1523 attribute_deprecated
1525 attribute_deprecated
1527 attribute_deprecated
1529 attribute_deprecated
1531 attribute_deprecated
1533 attribute_deprecated
1535 attribute_deprecated
1537 attribute_deprecated
1540 /** @deprecated this field is unused */
1541 attribute_deprecated
1546 * pass1 encoding statistics output buffer
1547 * - encoding: Set by libavcodec.
1548 * - decoding: unused
1553 * pass2 encoding statistics input buffer
1554 * Concatenated stuff from stats_out of pass1 should be placed here.
1555 * - encoding: Allocated/set/freed by user.
1556 * - decoding: unused
1561 * Work around bugs in encoders which sometimes cannot be detected automatically.
1562 * - encoding: Set by user
1563 * - decoding: Set by user
1565 int workaround_bugs;
1566 #define FF_BUG_AUTODETECT 1 ///< autodetection
1567 #define FF_BUG_XVID_ILACE 4
1568 #define FF_BUG_UMP4 8
1569 #define FF_BUG_NO_PADDING 16
1570 #define FF_BUG_AMV 32
1571 #define FF_BUG_QPEL_CHROMA 64
1572 #define FF_BUG_STD_QPEL 128
1573 #define FF_BUG_QPEL_CHROMA2 256
1574 #define FF_BUG_DIRECT_BLOCKSIZE 512
1575 #define FF_BUG_EDGE 1024
1576 #define FF_BUG_HPEL_CHROMA 2048
1577 #define FF_BUG_DC_CLIP 4096
1578 #define FF_BUG_MS 8192 ///< Work around various bugs in Microsoft's broken decoders.
1579 #define FF_BUG_TRUNCATED 16384
1580 #define FF_BUG_IEDGE 32768
1583 * strictly follow the standard (MPEG-4, ...).
1584 * - encoding: Set by user.
1585 * - decoding: Set by user.
1586 * Setting this to STRICT or higher means the encoder and decoder will
1587 * generally do stupid things, whereas setting it to unofficial or lower
1588 * will mean the encoder might produce output that is not supported by all
1589 * spec-compliant decoders. Decoders don't differentiate between normal,
1590 * unofficial and experimental (that is, they always try to decode things
1591 * when they can) unless they are explicitly asked to behave stupidly
1592 * (=strictly conform to the specs)
1594 int strict_std_compliance;
1595 #define FF_COMPLIANCE_VERY_STRICT 2 ///< Strictly conform to an older more strict version of the spec or reference software.
1596 #define FF_COMPLIANCE_STRICT 1 ///< Strictly conform to all the things in the spec no matter what consequences.
1597 #define FF_COMPLIANCE_NORMAL 0
1598 #define FF_COMPLIANCE_UNOFFICIAL -1 ///< Allow unofficial extensions
1599 #define FF_COMPLIANCE_EXPERIMENTAL -2 ///< Allow nonstandardized experimental things.
1602 * error concealment flags
1603 * - encoding: unused
1604 * - decoding: Set by user.
1606 int error_concealment;
1607 #define FF_EC_GUESS_MVS 1
1608 #define FF_EC_DEBLOCK 2
1609 #define FF_EC_FAVOR_INTER 256
1613 * - encoding: Set by user.
1614 * - decoding: Set by user.
1617 #define FF_DEBUG_PICT_INFO 1
1618 #define FF_DEBUG_RC 2
1619 #define FF_DEBUG_BITSTREAM 4
1620 #define FF_DEBUG_MB_TYPE 8
1621 #define FF_DEBUG_QP 16
1624 * @deprecated this option does nothing
1626 #define FF_DEBUG_MV 32
1628 #define FF_DEBUG_DCT_COEFF 0x00000040
1629 #define FF_DEBUG_SKIP 0x00000080
1630 #define FF_DEBUG_STARTCODE 0x00000100
1631 #define FF_DEBUG_ER 0x00000400
1632 #define FF_DEBUG_MMCO 0x00000800
1633 #define FF_DEBUG_BUGS 0x00001000
1635 #define FF_DEBUG_VIS_QP 0x00002000
1636 #define FF_DEBUG_VIS_MB_TYPE 0x00004000
1638 #define FF_DEBUG_BUFFERS 0x00008000
1639 #define FF_DEBUG_THREADS 0x00010000
1640 #define FF_DEBUG_GREEN_MD 0x00800000
1641 #define FF_DEBUG_NOMC 0x01000000
1646 * - encoding: Set by user.
1647 * - decoding: Set by user.
1650 #define FF_DEBUG_VIS_MV_P_FOR 0x00000001 // visualize forward predicted MVs of P-frames
1651 #define FF_DEBUG_VIS_MV_B_FOR 0x00000002 // visualize forward predicted MVs of B-frames
1652 #define FF_DEBUG_VIS_MV_B_BACK 0x00000004 // visualize backward predicted MVs of B-frames
1656 * Error recognition; may misdetect some more or less valid parts as errors.
1657 * - encoding: unused
1658 * - decoding: Set by user.
1660 int err_recognition;
1663 * Verify checksums embedded in the bitstream (could be of either encoded or
1664 * decoded data, depending on the codec) and print an error message on mismatch.
1665 * If AV_EF_EXPLODE is also set, a mismatching checksum will result in the
1666 * decoder returning an error.
1668 #define AV_EF_CRCCHECK (1<<0)
1669 #define AV_EF_BITSTREAM (1<<1) ///< detect bitstream specification deviations
1670 #define AV_EF_BUFFER (1<<2) ///< detect improper bitstream length
1671 #define AV_EF_EXPLODE (1<<3) ///< abort decoding on minor error detection
1673 #define AV_EF_IGNORE_ERR (1<<15) ///< ignore errors and continue
1674 #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
1675 #define AV_EF_COMPLIANT (1<<17) ///< consider all spec non compliances as errors
1676 #define AV_EF_AGGRESSIVE (1<<18) ///< consider things that a sane encoder should not do as an error
1680 * opaque 64-bit number (generally a PTS) that will be reordered and
1681 * output in AVFrame.reordered_opaque
1682 * - encoding: Set by libavcodec to the reordered_opaque of the input
1683 * frame corresponding to the last returned packet. Only
1684 * supported by encoders with the
1685 * AV_CODEC_CAP_ENCODER_REORDERED_OPAQUE capability.
1686 * - decoding: Set by user.
1688 int64_t reordered_opaque;
1691 * Hardware accelerator in use
1692 * - encoding: unused.
1693 * - decoding: Set by libavcodec
1695 const struct AVHWAccel *hwaccel;
1698 * Hardware accelerator context.
1699 * For some hardware accelerators, a global context needs to be
1700 * provided by the user. In that case, this holds display-dependent
1701 * data FFmpeg cannot instantiate itself. Please refer to the
1702 * FFmpeg HW accelerator documentation to know how to fill this
1703 * is. e.g. for VA API, this is a struct vaapi_context.
1704 * - encoding: unused
1705 * - decoding: Set by user
1707 void *hwaccel_context;
1711 * - encoding: Set by libavcodec if flags & AV_CODEC_FLAG_PSNR.
1712 * - decoding: unused
1714 uint64_t error[AV_NUM_DATA_POINTERS];
1717 * DCT algorithm, see FF_DCT_* below
1718 * - encoding: Set by user.
1719 * - decoding: unused
1722 #define FF_DCT_AUTO 0
1723 #define FF_DCT_FASTINT 1
1724 #define FF_DCT_INT 2
1725 #define FF_DCT_MMX 3
1726 #define FF_DCT_ALTIVEC 5
1727 #define FF_DCT_FAAN 6
1730 * IDCT algorithm, see FF_IDCT_* below.
1731 * - encoding: Set by user.
1732 * - decoding: Set by user.
1735 #define FF_IDCT_AUTO 0
1736 #define FF_IDCT_INT 1
1737 #define FF_IDCT_SIMPLE 2
1738 #define FF_IDCT_SIMPLEMMX 3
1739 #define FF_IDCT_ARM 7
1740 #define FF_IDCT_ALTIVEC 8
1741 #define FF_IDCT_SIMPLEARM 10
1742 #define FF_IDCT_XVID 14
1743 #define FF_IDCT_SIMPLEARMV5TE 16
1744 #define FF_IDCT_SIMPLEARMV6 17
1745 #define FF_IDCT_FAAN 20
1746 #define FF_IDCT_SIMPLENEON 22
1747 #define FF_IDCT_NONE 24 /* Used by XvMC to extract IDCT coefficients with FF_IDCT_PERM_NONE */
1748 #define FF_IDCT_SIMPLEAUTO 128
1751 * bits per sample/pixel from the demuxer (needed for huffyuv).
1752 * - encoding: Set by libavcodec.
1753 * - decoding: Set by user.
1755 int bits_per_coded_sample;
1758 * Bits per sample/pixel of internal libavcodec pixel/sample format.
1759 * - encoding: set by user.
1760 * - decoding: set by libavcodec.
1762 int bits_per_raw_sample;
1766 * low resolution decoding, 1-> 1/2 size, 2->1/4 size
1767 * - encoding: unused
1768 * - decoding: Set by user.
1773 #if FF_API_CODED_FRAME
1775 * the picture in the bitstream
1776 * - encoding: Set by libavcodec.
1777 * - decoding: unused
1779 * @deprecated use the quality factor packet side data instead
1781 attribute_deprecated AVFrame *coded_frame;
1786 * is used to decide how many independent tasks should be passed to execute()
1787 * - encoding: Set by user.
1788 * - decoding: Set by user.
1793 * Which multithreading methods to use.
1794 * Use of FF_THREAD_FRAME will increase decoding delay by one frame per thread,
1795 * so clients which cannot provide future frames should not use it.
1797 * - encoding: Set by user, otherwise the default is used.
1798 * - decoding: Set by user, otherwise the default is used.
1801 #define FF_THREAD_FRAME 1 ///< Decode more than one frame at once
1802 #define FF_THREAD_SLICE 2 ///< Decode more than one part of a single frame at once
1805 * Which multithreading methods are in use by the codec.
1806 * - encoding: Set by libavcodec.
1807 * - decoding: Set by libavcodec.
1809 int active_thread_type;
1811 #if FF_API_THREAD_SAFE_CALLBACKS
1813 * Set by the client if its custom get_buffer() callback can be called
1814 * synchronously from another thread, which allows faster multithreaded decoding.
1815 * draw_horiz_band() will be called from other threads regardless of this setting.
1816 * Ignored if the default get_buffer() is used.
1817 * - encoding: Set by user.
1818 * - decoding: Set by user.
1820 * @deprecated the custom get_buffer2() callback should always be
1821 * thread-safe. Thread-unsafe get_buffer2() implementations will be
1822 * invalid once this field is removed.
1824 attribute_deprecated
1825 int thread_safe_callbacks;
1829 * The codec may call this to execute several independent things.
1830 * It will return only after finishing all tasks.
1831 * The user may replace this with some multithreaded implementation,
1832 * the default implementation will execute the parts serially.
1833 * @param count the number of things to execute
1834 * - encoding: Set by libavcodec, user can override.
1835 * - decoding: Set by libavcodec, user can override.
1837 int (*execute)(struct AVCodecContext *c, int (*func)(struct AVCodecContext *c2, void *arg), void *arg2, int *ret, int count, int size);
1840 * The codec may call this to execute several independent things.
1841 * It will return only after finishing all tasks.
1842 * The user may replace this with some multithreaded implementation,
1843 * the default implementation will execute the parts serially.
1844 * Also see avcodec_thread_init and e.g. the --enable-pthread configure option.
1845 * @param c context passed also to func
1846 * @param count the number of things to execute
1847 * @param arg2 argument passed unchanged to func
1848 * @param ret return values of executed functions, must have space for "count" values. May be NULL.
1849 * @param func function that will be called count times, with jobnr from 0 to count-1.
1850 * threadnr will be in the range 0 to c->thread_count-1 < MAX_THREADS and so that no
1851 * two instances of func executing at the same time will have the same threadnr.
1852 * @return always 0 currently, but code should handle a future improvement where when any call to func
1853 * returns < 0 no further calls to func may be done and < 0 is returned.
1854 * - encoding: Set by libavcodec, user can override.
1855 * - decoding: Set by libavcodec, user can override.
1857 int (*execute2)(struct AVCodecContext *c, int (*func)(struct AVCodecContext *c2, void *arg, int jobnr, int threadnr), void *arg2, int *ret, int count);
1860 * noise vs. sse weight for the nsse comparison function
1861 * - encoding: Set by user.
1862 * - decoding: unused
1868 * - encoding: Set by user.
1869 * - decoding: Set by libavcodec.
1872 #define FF_PROFILE_UNKNOWN -99
1873 #define FF_PROFILE_RESERVED -100
1875 #define FF_PROFILE_AAC_MAIN 0
1876 #define FF_PROFILE_AAC_LOW 1
1877 #define FF_PROFILE_AAC_SSR 2
1878 #define FF_PROFILE_AAC_LTP 3
1879 #define FF_PROFILE_AAC_HE 4
1880 #define FF_PROFILE_AAC_HE_V2 28
1881 #define FF_PROFILE_AAC_LD 22
1882 #define FF_PROFILE_AAC_ELD 38
1883 #define FF_PROFILE_MPEG2_AAC_LOW 128
1884 #define FF_PROFILE_MPEG2_AAC_HE 131
1886 #define FF_PROFILE_DNXHD 0
1887 #define FF_PROFILE_DNXHR_LB 1
1888 #define FF_PROFILE_DNXHR_SQ 2
1889 #define FF_PROFILE_DNXHR_HQ 3
1890 #define FF_PROFILE_DNXHR_HQX 4
1891 #define FF_PROFILE_DNXHR_444 5
1893 #define FF_PROFILE_DTS 20
1894 #define FF_PROFILE_DTS_ES 30
1895 #define FF_PROFILE_DTS_96_24 40
1896 #define FF_PROFILE_DTS_HD_HRA 50
1897 #define FF_PROFILE_DTS_HD_MA 60
1898 #define FF_PROFILE_DTS_EXPRESS 70
1900 #define FF_PROFILE_MPEG2_422 0
1901 #define FF_PROFILE_MPEG2_HIGH 1
1902 #define FF_PROFILE_MPEG2_SS 2
1903 #define FF_PROFILE_MPEG2_SNR_SCALABLE 3
1904 #define FF_PROFILE_MPEG2_MAIN 4
1905 #define FF_PROFILE_MPEG2_SIMPLE 5
1907 #define FF_PROFILE_H264_CONSTRAINED (1<<9) // 8+1; constraint_set1_flag
1908 #define FF_PROFILE_H264_INTRA (1<<11) // 8+3; constraint_set3_flag
1910 #define FF_PROFILE_H264_BASELINE 66
1911 #define FF_PROFILE_H264_CONSTRAINED_BASELINE (66|FF_PROFILE_H264_CONSTRAINED)
1912 #define FF_PROFILE_H264_MAIN 77
1913 #define FF_PROFILE_H264_EXTENDED 88
1914 #define FF_PROFILE_H264_HIGH 100
1915 #define FF_PROFILE_H264_HIGH_10 110
1916 #define FF_PROFILE_H264_HIGH_10_INTRA (110|FF_PROFILE_H264_INTRA)
1917 #define FF_PROFILE_H264_MULTIVIEW_HIGH 118
1918 #define FF_PROFILE_H264_HIGH_422 122
1919 #define FF_PROFILE_H264_HIGH_422_INTRA (122|FF_PROFILE_H264_INTRA)
1920 #define FF_PROFILE_H264_STEREO_HIGH 128
1921 #define FF_PROFILE_H264_HIGH_444 144
1922 #define FF_PROFILE_H264_HIGH_444_PREDICTIVE 244
1923 #define FF_PROFILE_H264_HIGH_444_INTRA (244|FF_PROFILE_H264_INTRA)
1924 #define FF_PROFILE_H264_CAVLC_444 44
1926 #define FF_PROFILE_VC1_SIMPLE 0
1927 #define FF_PROFILE_VC1_MAIN 1
1928 #define FF_PROFILE_VC1_COMPLEX 2
1929 #define FF_PROFILE_VC1_ADVANCED 3
1931 #define FF_PROFILE_MPEG4_SIMPLE 0
1932 #define FF_PROFILE_MPEG4_SIMPLE_SCALABLE 1
1933 #define FF_PROFILE_MPEG4_CORE 2
1934 #define FF_PROFILE_MPEG4_MAIN 3
1935 #define FF_PROFILE_MPEG4_N_BIT 4
1936 #define FF_PROFILE_MPEG4_SCALABLE_TEXTURE 5
1937 #define FF_PROFILE_MPEG4_SIMPLE_FACE_ANIMATION 6
1938 #define FF_PROFILE_MPEG4_BASIC_ANIMATED_TEXTURE 7
1939 #define FF_PROFILE_MPEG4_HYBRID 8
1940 #define FF_PROFILE_MPEG4_ADVANCED_REAL_TIME 9
1941 #define FF_PROFILE_MPEG4_CORE_SCALABLE 10
1942 #define FF_PROFILE_MPEG4_ADVANCED_CODING 11
1943 #define FF_PROFILE_MPEG4_ADVANCED_CORE 12
1944 #define FF_PROFILE_MPEG4_ADVANCED_SCALABLE_TEXTURE 13
1945 #define FF_PROFILE_MPEG4_SIMPLE_STUDIO 14
1946 #define FF_PROFILE_MPEG4_ADVANCED_SIMPLE 15
1948 #define FF_PROFILE_JPEG2000_CSTREAM_RESTRICTION_0 1
1949 #define FF_PROFILE_JPEG2000_CSTREAM_RESTRICTION_1 2
1950 #define FF_PROFILE_JPEG2000_CSTREAM_NO_RESTRICTION 32768
1951 #define FF_PROFILE_JPEG2000_DCINEMA_2K 3
1952 #define FF_PROFILE_JPEG2000_DCINEMA_4K 4
1954 #define FF_PROFILE_VP9_0 0
1955 #define FF_PROFILE_VP9_1 1
1956 #define FF_PROFILE_VP9_2 2
1957 #define FF_PROFILE_VP9_3 3
1959 #define FF_PROFILE_HEVC_MAIN 1
1960 #define FF_PROFILE_HEVC_MAIN_10 2
1961 #define FF_PROFILE_HEVC_MAIN_STILL_PICTURE 3
1962 #define FF_PROFILE_HEVC_REXT 4
1964 #define FF_PROFILE_AV1_MAIN 0
1965 #define FF_PROFILE_AV1_HIGH 1
1966 #define FF_PROFILE_AV1_PROFESSIONAL 2
1968 #define FF_PROFILE_MJPEG_HUFFMAN_BASELINE_DCT 0xc0
1969 #define FF_PROFILE_MJPEG_HUFFMAN_EXTENDED_SEQUENTIAL_DCT 0xc1
1970 #define FF_PROFILE_MJPEG_HUFFMAN_PROGRESSIVE_DCT 0xc2
1971 #define FF_PROFILE_MJPEG_HUFFMAN_LOSSLESS 0xc3
1972 #define FF_PROFILE_MJPEG_JPEG_LS 0xf7
1974 #define FF_PROFILE_SBC_MSBC 1
1976 #define FF_PROFILE_PRORES_PROXY 0
1977 #define FF_PROFILE_PRORES_LT 1
1978 #define FF_PROFILE_PRORES_STANDARD 2
1979 #define FF_PROFILE_PRORES_HQ 3
1980 #define FF_PROFILE_PRORES_4444 4
1981 #define FF_PROFILE_PRORES_XQ 5
1983 #define FF_PROFILE_ARIB_PROFILE_A 0
1984 #define FF_PROFILE_ARIB_PROFILE_C 1
1986 #define FF_PROFILE_KLVA_SYNC 0
1987 #define FF_PROFILE_KLVA_ASYNC 1
1991 * - encoding: Set by user.
1992 * - decoding: Set by libavcodec.
1995 #define FF_LEVEL_UNKNOWN -99
1998 * Skip loop filtering for selected frames.
1999 * - encoding: unused
2000 * - decoding: Set by user.
2002 enum AVDiscard skip_loop_filter;
2005 * Skip IDCT/dequantization for selected frames.
2006 * - encoding: unused
2007 * - decoding: Set by user.
2009 enum AVDiscard skip_idct;
2012 * Skip decoding for selected frames.
2013 * - encoding: unused
2014 * - decoding: Set by user.
2016 enum AVDiscard skip_frame;
2019 * Header containing style information for text subtitles.
2020 * For SUBTITLE_ASS subtitle type, it should contain the whole ASS
2021 * [Script Info] and [V4+ Styles] section, plus the [Events] line and
2022 * the Format line following. It shouldn't include any Dialogue line.
2023 * - encoding: Set/allocated/freed by user (before avcodec_open2())
2024 * - decoding: Set/allocated/freed by libavcodec (by avcodec_open2())
2026 uint8_t *subtitle_header;
2027 int subtitle_header_size;
2029 #if FF_API_VBV_DELAY
2031 * VBV delay coded in the last frame (in periods of a 27 MHz clock).
2032 * Used for compliant TS muxing.
2033 * - encoding: Set by libavcodec.
2034 * - decoding: unused.
2035 * @deprecated this value is now exported as a part of
2036 * AV_PKT_DATA_CPB_PROPERTIES packet side data
2038 attribute_deprecated
2042 #if FF_API_SIDEDATA_ONLY_PKT
2044 * Encoding only and set by default. Allow encoders to output packets
2045 * that do not contain any encoded data, only side data.
2047 * Some encoders need to output such packets, e.g. to update some stream
2048 * parameters at the end of encoding.
2050 * @deprecated this field disables the default behaviour and
2051 * it is kept only for compatibility.
2053 attribute_deprecated
2054 int side_data_only_packets;
2058 * Audio only. The number of "priming" samples (padding) inserted by the
2059 * encoder at the beginning of the audio. I.e. this number of leading
2060 * decoded samples must be discarded by the caller to get the original audio
2061 * without leading padding.
2063 * - decoding: unused
2064 * - encoding: Set by libavcodec. The timestamps on the output packets are
2065 * adjusted by the encoder so that they always refer to the
2066 * first sample of the data actually contained in the packet,
2067 * including any added padding. E.g. if the timebase is
2068 * 1/samplerate and the timestamp of the first input sample is
2069 * 0, the timestamp of the first output packet will be
2072 int initial_padding;
2075 * - decoding: For codecs that store a framerate value in the compressed
2076 * bitstream, the decoder may export it here. { 0, 1} when
2078 * - encoding: May be used to signal the framerate of CFR content to an
2081 AVRational framerate;
2084 * Nominal unaccelerated pixel format, see AV_PIX_FMT_xxx.
2085 * - encoding: unused.
2086 * - decoding: Set by libavcodec before calling get_format()
2088 enum AVPixelFormat sw_pix_fmt;
2091 * Timebase in which pkt_dts/pts and AVPacket.dts/pts are.
2092 * - encoding unused.
2093 * - decoding set by user.
2095 AVRational pkt_timebase;
2099 * - encoding: unused.
2100 * - decoding: set by libavcodec.
2102 const AVCodecDescriptor *codec_descriptor;
2106 * low resolution decoding, 1-> 1/2 size, 2->1/4 size
2107 * - encoding: unused
2108 * - decoding: Set by user.
2114 * Current statistics for PTS correction.
2115 * - decoding: maintained and used by libavcodec, not intended to be used by user apps
2116 * - encoding: unused
2118 int64_t pts_correction_num_faulty_pts; /// Number of incorrect PTS values so far
2119 int64_t pts_correction_num_faulty_dts; /// Number of incorrect DTS values so far
2120 int64_t pts_correction_last_pts; /// PTS of the last frame
2121 int64_t pts_correction_last_dts; /// DTS of the last frame
2124 * Character encoding of the input subtitles file.
2125 * - decoding: set by user
2126 * - encoding: unused
2131 * Subtitles character encoding mode. Formats or codecs might be adjusting
2132 * this setting (if they are doing the conversion themselves for instance).
2133 * - decoding: set by libavcodec
2134 * - encoding: unused
2136 int sub_charenc_mode;
2137 #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)
2138 #define FF_SUB_CHARENC_MODE_AUTOMATIC 0 ///< libavcodec will select the mode itself
2139 #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
2140 #define FF_SUB_CHARENC_MODE_IGNORE 2 ///< neither convert the subtitles, nor check them for valid UTF-8
2143 * Skip processing alpha if supported by codec.
2144 * Note that if the format uses pre-multiplied alpha (common with VP6,
2145 * and recommended due to better video quality/compression)
2146 * the image will look as if alpha-blended onto a black background.
2147 * However for formats that do not use pre-multiplied alpha
2148 * there might be serious artefacts (though e.g. libswscale currently
2149 * assumes pre-multiplied alpha anyway).
2151 * - decoding: set by user
2152 * - encoding: unused
2157 * Number of samples to skip after a discontinuity
2158 * - decoding: unused
2159 * - encoding: set by libavcodec
2163 #if !FF_API_DEBUG_MV
2165 * debug motion vectors
2166 * - encoding: Set by user.
2167 * - decoding: Set by user.
2170 #define FF_DEBUG_VIS_MV_P_FOR 0x00000001 //visualize forward predicted MVs of P frames
2171 #define FF_DEBUG_VIS_MV_B_FOR 0x00000002 //visualize forward predicted MVs of B frames
2172 #define FF_DEBUG_VIS_MV_B_BACK 0x00000004 //visualize backward predicted MVs of B frames
2176 * custom intra quantization matrix
2177 * - encoding: Set by user, can be NULL.
2178 * - decoding: unused.
2180 uint16_t *chroma_intra_matrix;
2183 * dump format separator.
2184 * can be ", " or "\n " or anything else
2185 * - encoding: Set by user.
2186 * - decoding: Set by user.
2188 uint8_t *dump_separator;
2191 * ',' separated list of allowed decoders.
2192 * If NULL then all are allowed
2193 * - encoding: unused
2194 * - decoding: set by user
2196 char *codec_whitelist;
2199 * Properties of the stream that gets decoded
2200 * - encoding: unused
2201 * - decoding: set by libavcodec
2203 unsigned properties;
2204 #define FF_CODEC_PROPERTY_LOSSLESS 0x00000001
2205 #define FF_CODEC_PROPERTY_CLOSED_CAPTIONS 0x00000002
2208 * Additional data associated with the entire coded stream.
2210 * - decoding: unused
2211 * - encoding: may be set by libavcodec after avcodec_open2().
2213 AVPacketSideData *coded_side_data;
2214 int nb_coded_side_data;
2217 * A reference to the AVHWFramesContext describing the input (for encoding)
2218 * or output (decoding) frames. The reference is set by the caller and
2219 * afterwards owned (and freed) by libavcodec - it should never be read by
2220 * the caller after being set.
2222 * - decoding: This field should be set by the caller from the get_format()
2223 * callback. The previous reference (if any) will always be
2224 * unreffed by libavcodec before the get_format() call.
2226 * If the default get_buffer2() is used with a hwaccel pixel
2227 * format, then this AVHWFramesContext will be used for
2228 * allocating the frame buffers.
2230 * - encoding: For hardware encoders configured to use a hwaccel pixel
2231 * format, this field should be set by the caller to a reference
2232 * to the AVHWFramesContext describing input frames.
2233 * AVHWFramesContext.format must be equal to
2234 * AVCodecContext.pix_fmt.
2236 * This field should be set before avcodec_open2() is called.
2238 AVBufferRef *hw_frames_ctx;
2241 * Control the form of AVSubtitle.rects[N]->ass
2242 * - decoding: set by user
2243 * - encoding: unused
2245 int sub_text_format;
2246 #define FF_SUB_TEXT_FMT_ASS 0
2247 #if FF_API_ASS_TIMING
2248 #define FF_SUB_TEXT_FMT_ASS_WITH_TIMINGS 1
2252 * Audio only. The amount of padding (in samples) appended by the encoder to
2253 * the end of the audio. I.e. this number of decoded samples must be
2254 * discarded by the caller from the end of the stream to get the original
2255 * audio without any trailing padding.
2257 * - decoding: unused
2258 * - encoding: unused
2260 int trailing_padding;
2263 * The number of pixels per image to maximally accept.
2265 * - decoding: set by user
2266 * - encoding: set by user
2271 * A reference to the AVHWDeviceContext describing the device which will
2272 * be used by a hardware encoder/decoder. The reference is set by the
2273 * caller and afterwards owned (and freed) by libavcodec.
2275 * This should be used if either the codec device does not require
2276 * hardware frames or any that are used are to be allocated internally by
2277 * libavcodec. If the user wishes to supply any of the frames used as
2278 * encoder input or decoder output then hw_frames_ctx should be used
2279 * instead. When hw_frames_ctx is set in get_format() for a decoder, this
2280 * field will be ignored while decoding the associated stream segment, but
2281 * may again be used on a following one after another get_format() call.
2283 * For both encoders and decoders this field should be set before
2284 * avcodec_open2() is called and must not be written to thereafter.
2286 * Note that some decoders may require this field to be set initially in
2287 * order to support hw_frames_ctx at all - in that case, all frames
2288 * contexts used must be created on the same device.
2290 AVBufferRef *hw_device_ctx;
2293 * Bit set of AV_HWACCEL_FLAG_* flags, which affect hardware accelerated
2294 * decoding (if active).
2295 * - encoding: unused
2296 * - decoding: Set by user (either before avcodec_open2(), or in the
2297 * AVCodecContext.get_format callback)
2302 * Video decoding only. Certain video codecs support cropping, meaning that
2303 * only a sub-rectangle of the decoded frame is intended for display. This
2304 * option controls how cropping is handled by libavcodec.
2306 * When set to 1 (the default), libavcodec will apply cropping internally.
2307 * I.e. it will modify the output frame width/height fields and offset the
2308 * data pointers (only by as much as possible while preserving alignment, or
2309 * by the full amount if the AV_CODEC_FLAG_UNALIGNED flag is set) so that
2310 * the frames output by the decoder refer only to the cropped area. The
2311 * crop_* fields of the output frames will be zero.
2313 * When set to 0, the width/height fields of the output frames will be set
2314 * to the coded dimensions and the crop_* fields will describe the cropping
2315 * rectangle. Applying the cropping is left to the caller.
2317 * @warning When hardware acceleration with opaque output frames is used,
2318 * libavcodec is unable to apply cropping from the top/left border.
2320 * @note when this option is set to zero, the width/height fields of the
2321 * AVCodecContext and output AVFrames have different meanings. The codec
2322 * context fields store display dimensions (with the coded dimensions in
2323 * coded_width/height), while the frame fields store the coded dimensions
2324 * (with the display dimensions being determined by the crop_* fields).
2329 * Video decoding only. Sets the number of extra hardware frames which
2330 * the decoder will allocate for use by the caller. This must be set
2331 * before avcodec_open2() is called.
2333 * Some hardware decoders require all frames that they will use for
2334 * output to be defined in advance before decoding starts. For such
2335 * decoders, the hardware frame pool must therefore be of a fixed size.
2336 * The extra frames set here are on top of any number that the decoder
2337 * needs internally in order to operate normally (for example, frames
2338 * used as reference pictures).
2340 int extra_hw_frames;
2343 * The percentage of damaged samples to discard a frame.
2345 * - decoding: set by user
2346 * - encoding: unused
2348 int discard_damaged_percentage;
2351 * The number of samples per frame to maximally accept.
2353 * - decoding: set by user
2354 * - encoding: set by user
2356 int64_t max_samples;
2359 * Bit set of AV_CODEC_EXPORT_DATA_* flags, which affects the kind of
2360 * metadata exported in frame, packet, or coded stream side data by
2361 * decoders and encoders.
2363 * - decoding: set by user
2364 * - encoding: set by user
2366 int export_side_data;
2369 #if FF_API_CODEC_GET_SET
2371 * Accessors for some AVCodecContext fields. These used to be provided for ABI
2372 * compatibility, and do not need to be used anymore.
2374 attribute_deprecated
2375 AVRational av_codec_get_pkt_timebase (const AVCodecContext *avctx);
2376 attribute_deprecated
2377 void av_codec_set_pkt_timebase (AVCodecContext *avctx, AVRational val);
2379 attribute_deprecated
2380 const AVCodecDescriptor *av_codec_get_codec_descriptor(const AVCodecContext *avctx);
2381 attribute_deprecated
2382 void av_codec_set_codec_descriptor(AVCodecContext *avctx, const AVCodecDescriptor *desc);
2384 attribute_deprecated
2385 unsigned av_codec_get_codec_properties(const AVCodecContext *avctx);
2388 attribute_deprecated
2389 int av_codec_get_lowres(const AVCodecContext *avctx);
2390 attribute_deprecated
2391 void av_codec_set_lowres(AVCodecContext *avctx, int val);
2394 attribute_deprecated
2395 int av_codec_get_seek_preroll(const AVCodecContext *avctx);
2396 attribute_deprecated
2397 void av_codec_set_seek_preroll(AVCodecContext *avctx, int val);
2399 attribute_deprecated
2400 uint16_t *av_codec_get_chroma_intra_matrix(const AVCodecContext *avctx);
2401 attribute_deprecated
2402 void av_codec_set_chroma_intra_matrix(AVCodecContext *avctx, uint16_t *val);
2407 #if FF_API_CODEC_GET_SET
2408 attribute_deprecated
2409 int av_codec_get_max_lowres(const AVCodec *codec);
2412 struct MpegEncContext;
2415 * @defgroup lavc_hwaccel AVHWAccel
2417 * @note Nothing in this structure should be accessed by the user. At some
2418 * point in future it will not be externally visible at all.
2422 typedef struct AVHWAccel {
2424 * Name of the hardware accelerated codec.
2425 * The name is globally unique among encoders and among decoders (but an
2426 * encoder and a decoder can share the same name).
2431 * Type of codec implemented by the hardware accelerator.
2433 * See AVMEDIA_TYPE_xxx
2435 enum AVMediaType type;
2438 * Codec implemented by the hardware accelerator.
2440 * See AV_CODEC_ID_xxx
2445 * Supported pixel format.
2447 * Only hardware accelerated formats are supported here.
2449 enum AVPixelFormat pix_fmt;
2452 * Hardware accelerated codec capabilities.
2453 * see AV_HWACCEL_CODEC_CAP_*
2457 /*****************************************************************
2458 * No fields below this line are part of the public API. They
2459 * may not be used outside of libavcodec and can be changed and
2461 * New public fields should be added right above.
2462 *****************************************************************
2466 * Allocate a custom buffer
2468 int (*alloc_frame)(AVCodecContext *avctx, AVFrame *frame);
2471 * Called at the beginning of each frame or field picture.
2473 * Meaningful frame information (codec specific) is guaranteed to
2474 * be parsed at this point. This function is mandatory.
2476 * Note that buf can be NULL along with buf_size set to 0.
2477 * Otherwise, this means the whole frame is available at this point.
2479 * @param avctx the codec context
2480 * @param buf the frame data buffer base
2481 * @param buf_size the size of the frame in bytes
2482 * @return zero if successful, a negative value otherwise
2484 int (*start_frame)(AVCodecContext *avctx, const uint8_t *buf, uint32_t buf_size);
2487 * Callback for parameter data (SPS/PPS/VPS etc).
2489 * Useful for hardware decoders which keep persistent state about the
2490 * video parameters, and need to receive any changes to update that state.
2492 * @param avctx the codec context
2493 * @param type the nal unit type
2494 * @param buf the nal unit data buffer
2495 * @param buf_size the size of the nal unit in bytes
2496 * @return zero if successful, a negative value otherwise
2498 int (*decode_params)(AVCodecContext *avctx, int type, const uint8_t *buf, uint32_t buf_size);
2501 * Callback for each slice.
2503 * Meaningful slice information (codec specific) is guaranteed to
2504 * be parsed at this point. This function is mandatory.
2505 * The only exception is XvMC, that works on MB level.
2507 * @param avctx the codec context
2508 * @param buf the slice data buffer base
2509 * @param buf_size the size of the slice in bytes
2510 * @return zero if successful, a negative value otherwise
2512 int (*decode_slice)(AVCodecContext *avctx, const uint8_t *buf, uint32_t buf_size);
2515 * Called at the end of each frame or field picture.
2517 * The whole picture is parsed at this point and can now be sent
2518 * to the hardware accelerator. This function is mandatory.
2520 * @param avctx the codec context
2521 * @return zero if successful, a negative value otherwise
2523 int (*end_frame)(AVCodecContext *avctx);
2526 * Size of per-frame hardware accelerator private data.
2528 * Private data is allocated with av_mallocz() before
2529 * AVCodecContext.get_buffer() and deallocated after
2530 * AVCodecContext.release_buffer().
2532 int frame_priv_data_size;
2535 * Called for every Macroblock in a slice.
2537 * XvMC uses it to replace the ff_mpv_reconstruct_mb().
2538 * Instead of decoding to raw picture, MB parameters are
2539 * stored in an array provided by the video driver.
2541 * @param s the mpeg context
2543 void (*decode_mb)(struct MpegEncContext *s);
2546 * Initialize the hwaccel private data.
2548 * This will be called from ff_get_format(), after hwaccel and
2549 * hwaccel_context are set and the hwaccel private data in AVCodecInternal
2552 int (*init)(AVCodecContext *avctx);
2555 * Uninitialize the hwaccel private data.
2557 * This will be called from get_format() or avcodec_close(), after hwaccel
2558 * and hwaccel_context are already uninitialized.
2560 int (*uninit)(AVCodecContext *avctx);
2563 * Size of the private data to allocate in
2564 * AVCodecInternal.hwaccel_priv_data.
2569 * Internal hwaccel capabilities.
2574 * Fill the given hw_frames context with current codec parameters. Called
2575 * from get_format. Refer to avcodec_get_hw_frames_parameters() for
2578 * This CAN be called before AVHWAccel.init is called, and you must assume
2579 * that avctx->hwaccel_priv_data is invalid.
2581 int (*frame_params)(AVCodecContext *avctx, AVBufferRef *hw_frames_ctx);
2585 * HWAccel is experimental and is thus avoided in favor of non experimental
2588 #define AV_HWACCEL_CODEC_CAP_EXPERIMENTAL 0x0200
2591 * Hardware acceleration should be used for decoding even if the codec level
2592 * used is unknown or higher than the maximum supported level reported by the
2595 * It's generally a good idea to pass this flag unless you have a specific
2596 * reason not to, as hardware tends to under-report supported levels.
2598 #define AV_HWACCEL_FLAG_IGNORE_LEVEL (1 << 0)
2601 * Hardware acceleration can output YUV pixel formats with a different chroma
2602 * sampling than 4:2:0 and/or other than 8 bits per component.
2604 #define AV_HWACCEL_FLAG_ALLOW_HIGH_DEPTH (1 << 1)
2607 * Hardware acceleration should still be attempted for decoding when the
2608 * codec profile does not match the reported capabilities of the hardware.
2610 * For example, this can be used to try to decode baseline profile H.264
2611 * streams in hardware - it will often succeed, because many streams marked
2612 * as baseline profile actually conform to constrained baseline profile.
2614 * @warning If the stream is actually not supported then the behaviour is
2615 * undefined, and may include returning entirely incorrect output
2616 * while indicating success.
2618 #define AV_HWACCEL_FLAG_ALLOW_PROFILE_MISMATCH (1 << 2)
2624 #if FF_API_AVPICTURE
2626 * @defgroup lavc_picture AVPicture
2628 * Functions for working with AVPicture
2633 * Picture data structure.
2635 * Up to four components can be stored into it, the last component is
2637 * @deprecated use AVFrame or imgutils functions instead
2639 typedef struct AVPicture {
2640 attribute_deprecated
2641 uint8_t *data[AV_NUM_DATA_POINTERS]; ///< pointers to the image data planes
2642 attribute_deprecated
2643 int linesize[AV_NUM_DATA_POINTERS]; ///< number of bytes per line
2651 enum AVSubtitleType {
2654 SUBTITLE_BITMAP, ///< A bitmap, pict will be set
2657 * Plain text, the text field must be set by the decoder and is
2658 * authoritative. ass and pict fields may contain approximations.
2663 * Formatted text, the ass field must be set by the decoder and is
2664 * authoritative. pict and text fields may contain approximations.
2669 #define AV_SUBTITLE_FLAG_FORCED 0x00000001
2671 typedef struct AVSubtitleRect {
2672 int x; ///< top left corner of pict, undefined when pict is not set
2673 int y; ///< top left corner of pict, undefined when pict is not set
2674 int w; ///< width of pict, undefined when pict is not set
2675 int h; ///< height of pict, undefined when pict is not set
2676 int nb_colors; ///< number of colors in pict, undefined when pict is not set
2678 #if FF_API_AVPICTURE
2680 * @deprecated unused
2682 attribute_deprecated
2686 * data+linesize for the bitmap of this subtitle.
2687 * Can be set for text/ass as well once they are rendered.
2692 enum AVSubtitleType type;
2694 char *text; ///< 0 terminated plain UTF-8 text
2697 * 0 terminated ASS/SSA compatible event line.
2698 * The presentation of this is unaffected by the other values in this
2706 typedef struct AVSubtitle {
2707 uint16_t format; /* 0 = graphics */
2708 uint32_t start_display_time; /* relative to packet pts, in ms */
2709 uint32_t end_display_time; /* relative to packet pts, in ms */
2711 AVSubtitleRect **rects;
2712 int64_t pts; ///< Same as packet pts, in AV_TIME_BASE
2717 * If c is NULL, returns the first registered codec,
2718 * if c is non-NULL, returns the next registered codec after c,
2719 * or NULL if c is the last one.
2721 attribute_deprecated
2722 AVCodec *av_codec_next(const AVCodec *c);
2726 * Return the LIBAVCODEC_VERSION_INT constant.
2728 unsigned avcodec_version(void);
2731 * Return the libavcodec build-time configuration.
2733 const char *avcodec_configuration(void);
2736 * Return the libavcodec license.
2738 const char *avcodec_license(void);
2742 * Register the codec codec and initialize libavcodec.
2744 * @warning either this function or avcodec_register_all() must be called
2745 * before any other libavcodec functions.
2747 * @see avcodec_register_all()
2749 attribute_deprecated
2750 void avcodec_register(AVCodec *codec);
2753 * Register all the codecs, parsers and bitstream filters which were enabled at
2754 * configuration time. If you do not call this function you can select exactly
2755 * which formats you want to support, by using the individual registration
2758 * @see avcodec_register
2759 * @see av_register_codec_parser
2760 * @see av_register_bitstream_filter
2762 attribute_deprecated
2763 void avcodec_register_all(void);
2767 * Allocate an AVCodecContext and set its fields to default values. The
2768 * resulting struct should be freed with avcodec_free_context().
2770 * @param codec if non-NULL, allocate private data and initialize defaults
2771 * for the given codec. It is illegal to then call avcodec_open2()
2772 * with a different codec.
2773 * If NULL, then the codec-specific defaults won't be initialized,
2774 * which may result in suboptimal default settings (this is
2775 * important mainly for encoders, e.g. libx264).
2777 * @return An AVCodecContext filled with default values or NULL on failure.
2779 AVCodecContext *avcodec_alloc_context3(const AVCodec *codec);
2782 * Free the codec context and everything associated with it and write NULL to
2783 * the provided pointer.
2785 void avcodec_free_context(AVCodecContext **avctx);
2787 #if FF_API_GET_CONTEXT_DEFAULTS
2789 * @deprecated This function should not be used, as closing and opening a codec
2790 * context multiple time is not supported. A new codec context should be
2791 * allocated for each new use.
2793 int avcodec_get_context_defaults3(AVCodecContext *s, const AVCodec *codec);
2797 * Get the AVClass for AVCodecContext. It can be used in combination with
2798 * AV_OPT_SEARCH_FAKE_OBJ for examining options.
2800 * @see av_opt_find().
2802 const AVClass *avcodec_get_class(void);
2804 #if FF_API_COPY_CONTEXT
2806 * Get the AVClass for AVFrame. It can be used in combination with
2807 * AV_OPT_SEARCH_FAKE_OBJ for examining options.
2809 * @see av_opt_find().
2811 const AVClass *avcodec_get_frame_class(void);
2814 * Get the AVClass for AVSubtitleRect. It can be used in combination with
2815 * AV_OPT_SEARCH_FAKE_OBJ for examining options.
2817 * @see av_opt_find().
2819 const AVClass *avcodec_get_subtitle_rect_class(void);
2822 * Copy the settings of the source AVCodecContext into the destination
2823 * AVCodecContext. The resulting destination codec context will be
2824 * unopened, i.e. you are required to call avcodec_open2() before you
2825 * can use this AVCodecContext to decode/encode video/audio data.
2827 * @param dest target codec context, should be initialized with
2828 * avcodec_alloc_context3(NULL), but otherwise uninitialized
2829 * @param src source codec context
2830 * @return AVERROR() on error (e.g. memory allocation error), 0 on success
2832 * @deprecated The semantics of this function are ill-defined and it should not
2833 * be used. If you need to transfer the stream parameters from one codec context
2834 * to another, use an intermediate AVCodecParameters instance and the
2835 * avcodec_parameters_from_context() / avcodec_parameters_to_context()
2838 attribute_deprecated
2839 int avcodec_copy_context(AVCodecContext *dest, const AVCodecContext *src);
2843 * Fill the parameters struct based on the values from the supplied codec
2844 * context. Any allocated fields in par are freed and replaced with duplicates
2845 * of the corresponding fields in codec.
2847 * @return >= 0 on success, a negative AVERROR code on failure
2849 int avcodec_parameters_from_context(AVCodecParameters *par,
2850 const AVCodecContext *codec);
2853 * Fill the codec context based on the values from the supplied codec
2854 * parameters. Any allocated fields in codec that have a corresponding field in
2855 * par are freed and replaced with duplicates of the corresponding field in par.
2856 * Fields in codec that do not have a counterpart in par are not touched.
2858 * @return >= 0 on success, a negative AVERROR code on failure.
2860 int avcodec_parameters_to_context(AVCodecContext *codec,
2861 const AVCodecParameters *par);
2864 * Initialize the AVCodecContext to use the given AVCodec. Prior to using this
2865 * function the context has to be allocated with avcodec_alloc_context3().
2867 * The functions avcodec_find_decoder_by_name(), avcodec_find_encoder_by_name(),
2868 * avcodec_find_decoder() and avcodec_find_encoder() provide an easy way for
2869 * retrieving a codec.
2871 * @warning This function is not thread safe!
2873 * @note Always call this function before using decoding routines (such as
2874 * @ref avcodec_receive_frame()).
2877 * avcodec_register_all();
2878 * av_dict_set(&opts, "b", "2.5M", 0);
2879 * codec = avcodec_find_decoder(AV_CODEC_ID_H264);
2883 * context = avcodec_alloc_context3(codec);
2885 * if (avcodec_open2(context, codec, opts) < 0)
2889 * @param avctx The context to initialize.
2890 * @param codec The codec to open this context for. If a non-NULL codec has been
2891 * previously passed to avcodec_alloc_context3() or
2892 * for this context, then this parameter MUST be either NULL or
2893 * equal to the previously passed codec.
2894 * @param options A dictionary filled with AVCodecContext and codec-private options.
2895 * On return this object will be filled with options that were not found.
2897 * @return zero on success, a negative value on error
2898 * @see avcodec_alloc_context3(), avcodec_find_decoder(), avcodec_find_encoder(),
2899 * av_dict_set(), av_opt_find().
2901 int avcodec_open2(AVCodecContext *avctx, const AVCodec *codec, AVDictionary **options);
2904 * Close a given AVCodecContext and free all the data associated with it
2905 * (but not the AVCodecContext itself).
2907 * Calling this function on an AVCodecContext that hasn't been opened will free
2908 * the codec-specific data allocated in avcodec_alloc_context3() with a non-NULL
2909 * codec. Subsequent calls will do nothing.
2911 * @note Do not use this function. Use avcodec_free_context() to destroy a
2912 * codec context (either open or closed). Opening and closing a codec context
2913 * multiple times is not supported anymore -- use multiple codec contexts
2916 int avcodec_close(AVCodecContext *avctx);
2919 * Free all allocated data in the given subtitle struct.
2921 * @param sub AVSubtitle to free.
2923 void avsubtitle_free(AVSubtitle *sub);
2930 * @addtogroup lavc_decoding
2935 * The default callback for AVCodecContext.get_buffer2(). It is made public so
2936 * it can be called by custom get_buffer2() implementations for decoders without
2937 * AV_CODEC_CAP_DR1 set.
2939 int avcodec_default_get_buffer2(AVCodecContext *s, AVFrame *frame, int flags);
2942 * Modify width and height values so that they will result in a memory
2943 * buffer that is acceptable for the codec if you do not use any horizontal
2946 * May only be used if a codec with AV_CODEC_CAP_DR1 has been opened.
2948 void avcodec_align_dimensions(AVCodecContext *s, int *width, int *height);
2951 * Modify width and height values so that they will result in a memory
2952 * buffer that is acceptable for the codec if you also ensure that all
2953 * line sizes are a multiple of the respective linesize_align[i].
2955 * May only be used if a codec with AV_CODEC_CAP_DR1 has been opened.
2957 void avcodec_align_dimensions2(AVCodecContext *s, int *width, int *height,
2958 int linesize_align[AV_NUM_DATA_POINTERS]);
2961 * Converts AVChromaLocation to swscale x/y chroma position.
2963 * The positions represent the chroma (0,0) position in a coordinates system
2964 * with luma (0,0) representing the origin and luma(1,1) representing 256,256
2966 * @param xpos horizontal chroma sample position
2967 * @param ypos vertical chroma sample position
2969 int avcodec_enum_to_chroma_pos(int *xpos, int *ypos, enum AVChromaLocation pos);
2972 * Converts swscale x/y chroma position to AVChromaLocation.
2974 * The positions represent the chroma (0,0) position in a coordinates system
2975 * with luma (0,0) representing the origin and luma(1,1) representing 256,256
2977 * @param xpos horizontal chroma sample position
2978 * @param ypos vertical chroma sample position
2980 enum AVChromaLocation avcodec_chroma_pos_to_enum(int xpos, int ypos);
2983 * Decode the audio frame of size avpkt->size from avpkt->data into frame.
2985 * Some decoders may support multiple frames in a single AVPacket. Such
2986 * decoders would then just decode the first frame and the return value would be
2987 * less than the packet size. In this case, avcodec_decode_audio4 has to be
2988 * called again with an AVPacket containing the remaining data in order to
2989 * decode the second frame, etc... Even if no frames are returned, the packet
2990 * needs to be fed to the decoder with remaining data until it is completely
2991 * consumed or an error occurs.
2993 * Some decoders (those marked with AV_CODEC_CAP_DELAY) have a delay between input
2994 * and output. This means that for some packets they will not immediately
2995 * produce decoded output and need to be flushed at the end of decoding to get
2996 * all the decoded data. Flushing is done by calling this function with packets
2997 * with avpkt->data set to NULL and avpkt->size set to 0 until it stops
2998 * returning samples. It is safe to flush even those decoders that are not
2999 * marked with AV_CODEC_CAP_DELAY, then no samples will be returned.
3001 * @warning The input buffer, avpkt->data must be AV_INPUT_BUFFER_PADDING_SIZE
3002 * larger than the actual read bytes because some optimized bitstream
3003 * readers read 32 or 64 bits at once and could read over the end.
3005 * @note The AVCodecContext MUST have been opened with @ref avcodec_open2()
3006 * before packets may be fed to the decoder.
3008 * @param avctx the codec context
3009 * @param[out] frame The AVFrame in which to store decoded audio samples.
3010 * The decoder will allocate a buffer for the decoded frame by
3011 * calling the AVCodecContext.get_buffer2() callback.
3012 * When AVCodecContext.refcounted_frames is set to 1, the frame is
3013 * reference counted and the returned reference belongs to the
3014 * caller. The caller must release the frame using av_frame_unref()
3015 * when the frame is no longer needed. The caller may safely write
3016 * to the frame if av_frame_is_writable() returns 1.
3017 * When AVCodecContext.refcounted_frames is set to 0, the returned
3018 * reference belongs to the decoder and is valid only until the
3019 * next call to this function or until closing or flushing the
3020 * decoder. The caller may not write to it.
3021 * @param[out] got_frame_ptr Zero if no frame could be decoded, otherwise it is
3022 * non-zero. Note that this field being set to zero
3023 * does not mean that an error has occurred. For
3024 * decoders with AV_CODEC_CAP_DELAY set, no given decode
3025 * call is guaranteed to produce a frame.
3026 * @param[in] avpkt The input AVPacket containing the input buffer.
3027 * At least avpkt->data and avpkt->size should be set. Some
3028 * decoders might also require additional fields to be set.
3029 * @return A negative error code is returned if an error occurred during
3030 * decoding, otherwise the number of bytes consumed from the input
3031 * AVPacket is returned.
3033 * @deprecated Use avcodec_send_packet() and avcodec_receive_frame().
3035 attribute_deprecated
3036 int avcodec_decode_audio4(AVCodecContext *avctx, AVFrame *frame,
3037 int *got_frame_ptr, const AVPacket *avpkt);
3040 * Decode the video frame of size avpkt->size from avpkt->data into picture.
3041 * Some decoders may support multiple frames in a single AVPacket, such
3042 * decoders would then just decode the first frame.
3044 * @warning The input buffer must be AV_INPUT_BUFFER_PADDING_SIZE larger than
3045 * the actual read bytes because some optimized bitstream readers read 32 or 64
3046 * bits at once and could read over the end.
3048 * @warning The end of the input buffer buf should be set to 0 to ensure that
3049 * no overreading happens for damaged MPEG streams.
3051 * @note Codecs which have the AV_CODEC_CAP_DELAY capability set have a delay
3052 * between input and output, these need to be fed with avpkt->data=NULL,
3053 * avpkt->size=0 at the end to return the remaining frames.
3055 * @note The AVCodecContext MUST have been opened with @ref avcodec_open2()
3056 * before packets may be fed to the decoder.
3058 * @param avctx the codec context
3059 * @param[out] picture The AVFrame in which the decoded video frame will be stored.
3060 * Use av_frame_alloc() to get an AVFrame. The codec will
3061 * allocate memory for the actual bitmap by calling the
3062 * AVCodecContext.get_buffer2() callback.
3063 * When AVCodecContext.refcounted_frames is set to 1, the frame is
3064 * reference counted and the returned reference belongs to the
3065 * caller. The caller must release the frame using av_frame_unref()
3066 * when the frame is no longer needed. The caller may safely write
3067 * to the frame if av_frame_is_writable() returns 1.
3068 * When AVCodecContext.refcounted_frames is set to 0, the returned
3069 * reference belongs to the decoder and is valid only until the
3070 * next call to this function or until closing or flushing the
3071 * decoder. The caller may not write to it.
3073 * @param[in] avpkt The input AVPacket containing the input buffer.
3074 * You can create such packet with av_init_packet() and by then setting
3075 * data and size, some decoders might in addition need other fields like
3076 * flags&AV_PKT_FLAG_KEY. All decoders are designed to use the least
3078 * @param[in,out] got_picture_ptr Zero if no frame could be decompressed, otherwise, it is nonzero.
3079 * @return On error a negative value is returned, otherwise the number of bytes
3080 * used or zero if no frame could be decompressed.
3082 * @deprecated Use avcodec_send_packet() and avcodec_receive_frame().
3084 attribute_deprecated
3085 int avcodec_decode_video2(AVCodecContext *avctx, AVFrame *picture,
3086 int *got_picture_ptr,
3087 const AVPacket *avpkt);
3090 * Decode a subtitle message.
3091 * Return a negative value on error, otherwise return the number of bytes used.
3092 * If no subtitle could be decompressed, got_sub_ptr is zero.
3093 * Otherwise, the subtitle is stored in *sub.
3094 * Note that AV_CODEC_CAP_DR1 is not available for subtitle codecs. This is for
3095 * simplicity, because the performance difference is expected to be negligible
3096 * and reusing a get_buffer written for video codecs would probably perform badly
3097 * due to a potentially very different allocation pattern.
3099 * Some decoders (those marked with AV_CODEC_CAP_DELAY) have a delay between input
3100 * and output. This means that for some packets they will not immediately
3101 * produce decoded output and need to be flushed at the end of decoding to get
3102 * all the decoded data. Flushing is done by calling this function with packets
3103 * with avpkt->data set to NULL and avpkt->size set to 0 until it stops
3104 * returning subtitles. It is safe to flush even those decoders that are not
3105 * marked with AV_CODEC_CAP_DELAY, then no subtitles will be returned.
3107 * @note The AVCodecContext MUST have been opened with @ref avcodec_open2()
3108 * before packets may be fed to the decoder.
3110 * @param avctx the codec context
3111 * @param[out] sub The preallocated AVSubtitle in which the decoded subtitle will be stored,
3112 * must be freed with avsubtitle_free if *got_sub_ptr is set.
3113 * @param[in,out] got_sub_ptr Zero if no subtitle could be decompressed, otherwise, it is nonzero.
3114 * @param[in] avpkt The input AVPacket containing the input buffer.
3116 int avcodec_decode_subtitle2(AVCodecContext *avctx, AVSubtitle *sub,
3121 * Supply raw packet data as input to a decoder.
3123 * Internally, this call will copy relevant AVCodecContext fields, which can
3124 * influence decoding per-packet, and apply them when the packet is actually
3125 * decoded. (For example AVCodecContext.skip_frame, which might direct the
3126 * decoder to drop the frame contained by the packet sent with this function.)
3128 * @warning The input buffer, avpkt->data must be AV_INPUT_BUFFER_PADDING_SIZE
3129 * larger than the actual read bytes because some optimized bitstream
3130 * readers read 32 or 64 bits at once and could read over the end.
3132 * @warning Do not mix this API with the legacy API (like avcodec_decode_video2())
3133 * on the same AVCodecContext. It will return unexpected results now
3134 * or in future libavcodec versions.
3136 * @note The AVCodecContext MUST have been opened with @ref avcodec_open2()
3137 * before packets may be fed to the decoder.
3139 * @param avctx codec context
3140 * @param[in] avpkt The input AVPacket. Usually, this will be a single video
3141 * frame, or several complete audio frames.
3142 * Ownership of the packet remains with the caller, and the
3143 * decoder will not write to the packet. The decoder may create
3144 * a reference to the packet data (or copy it if the packet is
3145 * not reference-counted).
3146 * Unlike with older APIs, the packet is always fully consumed,
3147 * and if it contains multiple frames (e.g. some audio codecs),
3148 * will require you to call avcodec_receive_frame() multiple
3149 * times afterwards before you can send a new packet.
3150 * It can be NULL (or an AVPacket with data set to NULL and
3151 * size set to 0); in this case, it is considered a flush
3152 * packet, which signals the end of the stream. Sending the
3153 * first flush packet will return success. Subsequent ones are
3154 * unnecessary and will return AVERROR_EOF. If the decoder
3155 * still has frames buffered, it will return them after sending
3158 * @return 0 on success, otherwise negative error code:
3159 * AVERROR(EAGAIN): input is not accepted in the current state - user
3160 * must read output with avcodec_receive_frame() (once
3161 * all output is read, the packet should be resent, and
3162 * the call will not fail with EAGAIN).
3163 * AVERROR_EOF: the decoder has been flushed, and no new packets can
3164 * be sent to it (also returned if more than 1 flush
3166 * AVERROR(EINVAL): codec not opened, it is an encoder, or requires flush
3167 * AVERROR(ENOMEM): failed to add packet to internal queue, or similar
3168 * other errors: legitimate decoding errors
3170 int avcodec_send_packet(AVCodecContext *avctx, const AVPacket *avpkt);
3173 * Return decoded output data from a decoder.
3175 * @param avctx codec context
3176 * @param frame This will be set to a reference-counted video or audio
3177 * frame (depending on the decoder type) allocated by the
3178 * decoder. Note that the function will always call
3179 * av_frame_unref(frame) before doing anything else.
3182 * 0: success, a frame was returned
3183 * AVERROR(EAGAIN): output is not available in this state - user must try
3185 * AVERROR_EOF: the decoder has been fully flushed, and there will be
3186 * no more output frames
3187 * AVERROR(EINVAL): codec not opened, or it is an encoder
3188 * AVERROR_INPUT_CHANGED: current decoded frame has changed parameters
3189 * with respect to first decoded frame. Applicable
3190 * when flag AV_CODEC_FLAG_DROPCHANGED is set.
3191 * other negative values: legitimate decoding errors
3193 int avcodec_receive_frame(AVCodecContext *avctx, AVFrame *frame);
3196 * Supply a raw video or audio frame to the encoder. Use avcodec_receive_packet()
3197 * to retrieve buffered output packets.
3199 * @param avctx codec context
3200 * @param[in] frame AVFrame containing the raw audio or video frame to be encoded.
3201 * Ownership of the frame remains with the caller, and the
3202 * encoder will not write to the frame. The encoder may create
3203 * a reference to the frame data (or copy it if the frame is
3204 * not reference-counted).
3205 * It can be NULL, in which case it is considered a flush
3206 * packet. This signals the end of the stream. If the encoder
3207 * still has packets buffered, it will return them after this
3208 * call. Once flushing mode has been entered, additional flush
3209 * packets are ignored, and sending frames will return
3213 * If AV_CODEC_CAP_VARIABLE_FRAME_SIZE is set, then each frame
3214 * can have any number of samples.
3215 * If it is not set, frame->nb_samples must be equal to
3216 * avctx->frame_size for all frames except the last.
3217 * The final frame may be smaller than avctx->frame_size.
3218 * @return 0 on success, otherwise negative error code:
3219 * AVERROR(EAGAIN): input is not accepted in the current state - user
3220 * must read output with avcodec_receive_packet() (once
3221 * all output is read, the packet should be resent, and
3222 * the call will not fail with EAGAIN).
3223 * AVERROR_EOF: the encoder has been flushed, and no new frames can
3225 * AVERROR(EINVAL): codec not opened, refcounted_frames not set, it is a
3226 * decoder, or requires flush
3227 * AVERROR(ENOMEM): failed to add packet to internal queue, or similar
3228 * other errors: legitimate encoding errors
3230 int avcodec_send_frame(AVCodecContext *avctx, const AVFrame *frame);
3233 * Read encoded data from the encoder.
3235 * @param avctx codec context
3236 * @param avpkt This will be set to a reference-counted packet allocated by the
3237 * encoder. Note that the function will always call
3238 * av_packet_unref(avpkt) before doing anything else.
3239 * @return 0 on success, otherwise negative error code:
3240 * AVERROR(EAGAIN): output is not available in the current state - user
3241 * must try to send input
3242 * AVERROR_EOF: the encoder has been fully flushed, and there will be
3243 * no more output packets
3244 * AVERROR(EINVAL): codec not opened, or it is a decoder
3245 * other errors: legitimate encoding errors
3247 int avcodec_receive_packet(AVCodecContext *avctx, AVPacket *avpkt);
3250 * Create and return a AVHWFramesContext with values adequate for hardware
3251 * decoding. This is meant to get called from the get_format callback, and is
3252 * a helper for preparing a AVHWFramesContext for AVCodecContext.hw_frames_ctx.
3253 * This API is for decoding with certain hardware acceleration modes/APIs only.
3255 * The returned AVHWFramesContext is not initialized. The caller must do this
3256 * with av_hwframe_ctx_init().
3258 * Calling this function is not a requirement, but makes it simpler to avoid
3259 * codec or hardware API specific details when manually allocating frames.
3261 * Alternatively to this, an API user can set AVCodecContext.hw_device_ctx,
3262 * which sets up AVCodecContext.hw_frames_ctx fully automatically, and makes
3263 * it unnecessary to call this function or having to care about
3264 * AVHWFramesContext initialization at all.
3266 * There are a number of requirements for calling this function:
3268 * - It must be called from get_format with the same avctx parameter that was
3269 * passed to get_format. Calling it outside of get_format is not allowed, and
3270 * can trigger undefined behavior.
3271 * - The function is not always supported (see description of return values).
3272 * Even if this function returns successfully, hwaccel initialization could
3273 * fail later. (The degree to which implementations check whether the stream
3274 * is actually supported varies. Some do this check only after the user's
3275 * get_format callback returns.)
3276 * - The hw_pix_fmt must be one of the choices suggested by get_format. If the
3277 * user decides to use a AVHWFramesContext prepared with this API function,
3278 * the user must return the same hw_pix_fmt from get_format.
3279 * - The device_ref passed to this function must support the given hw_pix_fmt.
3280 * - After calling this API function, it is the user's responsibility to
3281 * initialize the AVHWFramesContext (returned by the out_frames_ref parameter),
3282 * and to set AVCodecContext.hw_frames_ctx to it. If done, this must be done
3283 * before returning from get_format (this is implied by the normal
3284 * AVCodecContext.hw_frames_ctx API rules).
3285 * - The AVHWFramesContext parameters may change every time time get_format is
3286 * called. Also, AVCodecContext.hw_frames_ctx is reset before get_format. So
3287 * you are inherently required to go through this process again on every
3289 * - It is perfectly possible to call this function without actually using
3290 * the resulting AVHWFramesContext. One use-case might be trying to reuse a
3291 * previously initialized AVHWFramesContext, and calling this API function
3292 * only to test whether the required frame parameters have changed.
3293 * - Fields that use dynamically allocated values of any kind must not be set
3294 * by the user unless setting them is explicitly allowed by the documentation.
3295 * If the user sets AVHWFramesContext.free and AVHWFramesContext.user_opaque,
3296 * the new free callback must call the potentially set previous free callback.
3297 * This API call may set any dynamically allocated fields, including the free
3300 * The function will set at least the following fields on AVHWFramesContext
3301 * (potentially more, depending on hwaccel API):
3303 * - All fields set by av_hwframe_ctx_alloc().
3304 * - Set the format field to hw_pix_fmt.
3305 * - Set the sw_format field to the most suited and most versatile format. (An
3306 * implication is that this will prefer generic formats over opaque formats
3307 * with arbitrary restrictions, if possible.)
3308 * - Set the width/height fields to the coded frame size, rounded up to the
3309 * API-specific minimum alignment.
3310 * - Only _if_ the hwaccel requires a pre-allocated pool: set the initial_pool_size
3311 * field to the number of maximum reference surfaces possible with the codec,
3312 * plus 1 surface for the user to work (meaning the user can safely reference
3313 * at most 1 decoded surface at a time), plus additional buffering introduced
3314 * by frame threading. If the hwaccel does not require pre-allocation, the
3315 * field is left to 0, and the decoder will allocate new surfaces on demand
3317 * - Possibly AVHWFramesContext.hwctx fields, depending on the underlying
3320 * Essentially, out_frames_ref returns the same as av_hwframe_ctx_alloc(), but
3321 * with basic frame parameters set.
3323 * The function is stateless, and does not change the AVCodecContext or the
3324 * device_ref AVHWDeviceContext.
3326 * @param avctx The context which is currently calling get_format, and which
3327 * implicitly contains all state needed for filling the returned
3328 * AVHWFramesContext properly.
3329 * @param device_ref A reference to the AVHWDeviceContext describing the device
3330 * which will be used by the hardware decoder.
3331 * @param hw_pix_fmt The hwaccel format you are going to return from get_format.
3332 * @param out_frames_ref On success, set to a reference to an _uninitialized_
3333 * AVHWFramesContext, created from the given device_ref.
3334 * Fields will be set to values required for decoding.
3335 * Not changed if an error is returned.
3336 * @return zero on success, a negative value on error. The following error codes
3337 * have special semantics:
3338 * AVERROR(ENOENT): the decoder does not support this functionality. Setup
3339 * is always manual, or it is a decoder which does not
3340 * support setting AVCodecContext.hw_frames_ctx at all,
3341 * or it is a software format.
3342 * AVERROR(EINVAL): it is known that hardware decoding is not supported for
3343 * this configuration, or the device_ref is not supported
3344 * for the hwaccel referenced by hw_pix_fmt.
3346 int avcodec_get_hw_frames_parameters(AVCodecContext *avctx,
3347 AVBufferRef *device_ref,
3348 enum AVPixelFormat hw_pix_fmt,
3349 AVBufferRef **out_frames_ref);
3354 * @defgroup lavc_parsing Frame parsing
3358 enum AVPictureStructure {
3359 AV_PICTURE_STRUCTURE_UNKNOWN, //< unknown
3360 AV_PICTURE_STRUCTURE_TOP_FIELD, //< coded as top field
3361 AV_PICTURE_STRUCTURE_BOTTOM_FIELD, //< coded as bottom field
3362 AV_PICTURE_STRUCTURE_FRAME, //< coded as frame
3365 typedef struct AVCodecParserContext {
3367 struct AVCodecParser *parser;
3368 int64_t frame_offset; /* offset of the current frame */
3369 int64_t cur_offset; /* current offset
3370 (incremented by each av_parser_parse()) */
3371 int64_t next_frame_offset; /* offset of the next frame */
3373 int pict_type; /* XXX: Put it back in AVCodecContext. */
3375 * This field is used for proper frame duration computation in lavf.
3376 * It signals, how much longer the frame duration of the current frame
3377 * is compared to normal frame duration.
3379 * frame_duration = (1 + repeat_pict) * time_base
3381 * It is used by codecs like H.264 to display telecined material.
3383 int repeat_pict; /* XXX: Put it back in AVCodecContext. */
3384 int64_t pts; /* pts of the current frame */
3385 int64_t dts; /* dts of the current frame */
3390 int fetch_timestamp;
3392 #define AV_PARSER_PTS_NB 4
3393 int cur_frame_start_index;
3394 int64_t cur_frame_offset[AV_PARSER_PTS_NB];
3395 int64_t cur_frame_pts[AV_PARSER_PTS_NB];
3396 int64_t cur_frame_dts[AV_PARSER_PTS_NB];
3399 #define PARSER_FLAG_COMPLETE_FRAMES 0x0001
3400 #define PARSER_FLAG_ONCE 0x0002
3401 /// Set if the parser has a valid file offset
3402 #define PARSER_FLAG_FETCHED_OFFSET 0x0004
3403 #define PARSER_FLAG_USE_CODEC_TS 0x1000
3405 int64_t offset; ///< byte offset from starting packet start
3406 int64_t cur_frame_end[AV_PARSER_PTS_NB];
3409 * Set by parser to 1 for key frames and 0 for non-key frames.
3410 * It is initialized to -1, so if the parser doesn't set this flag,
3411 * old-style fallback using AV_PICTURE_TYPE_I picture type as key frames
3416 #if FF_API_CONVERGENCE_DURATION
3418 * @deprecated unused
3420 attribute_deprecated
3421 int64_t convergence_duration;
3424 // Timestamp generation support:
3426 * Synchronization point for start of timestamp generation.
3428 * Set to >0 for sync point, 0 for no sync point and <0 for undefined
3431 * For example, this corresponds to presence of H.264 buffering period
3437 * Offset of the current timestamp against last timestamp sync point in
3438 * units of AVCodecContext.time_base.
3440 * Set to INT_MIN when dts_sync_point unused. Otherwise, it must
3441 * contain a valid timestamp offset.
3443 * Note that the timestamp of sync point has usually a nonzero
3444 * dts_ref_dts_delta, which refers to the previous sync point. Offset of
3445 * the next frame after timestamp sync point will be usually 1.
3447 * For example, this corresponds to H.264 cpb_removal_delay.
3449 int dts_ref_dts_delta;
3452 * Presentation delay of current frame in units of AVCodecContext.time_base.
3454 * Set to INT_MIN when dts_sync_point unused. Otherwise, it must
3455 * contain valid non-negative timestamp delta (presentation time of a frame
3456 * must not lie in the past).
3458 * This delay represents the difference between decoding and presentation
3459 * time of the frame.
3461 * For example, this corresponds to H.264 dpb_output_delay.
3466 * Position of the packet in file.
3468 * Analogous to cur_frame_pts/dts
3470 int64_t cur_frame_pos[AV_PARSER_PTS_NB];
3473 * Byte position of currently parsed frame in stream.
3478 * Previous frame byte position.
3483 * Duration of the current frame.
3484 * For audio, this is in units of 1 / AVCodecContext.sample_rate.
3485 * For all other types, this is in units of AVCodecContext.time_base.
3489 enum AVFieldOrder field_order;
3492 * Indicate whether a picture is coded as a frame, top field or bottom field.
3494 * For example, H.264 field_pic_flag equal to 0 corresponds to
3495 * AV_PICTURE_STRUCTURE_FRAME. An H.264 picture with field_pic_flag
3496 * equal to 1 and bottom_field_flag equal to 0 corresponds to
3497 * AV_PICTURE_STRUCTURE_TOP_FIELD.
3499 enum AVPictureStructure picture_structure;
3502 * Picture number incremented in presentation or output order.
3503 * This field may be reinitialized at the first picture of a new sequence.
3505 * For example, this corresponds to H.264 PicOrderCnt.
3507 int output_picture_number;
3510 * Dimensions of the decoded video intended for presentation.
3516 * Dimensions of the coded video.
3522 * The format of the coded data, corresponds to enum AVPixelFormat for video
3523 * and for enum AVSampleFormat for audio.
3525 * Note that a decoder can have considerable freedom in how exactly it
3526 * decodes the data, so the format reported here might be different from the
3527 * one returned by a decoder.
3530 } AVCodecParserContext;
3532 typedef struct AVCodecParser {
3533 int codec_ids[5]; /* several codec IDs are permitted */
3535 int (*parser_init)(AVCodecParserContext *s);
3536 /* This callback never returns an error, a negative value means that
3537 * the frame start was in a previous packet. */
3538 int (*parser_parse)(AVCodecParserContext *s,
3539 AVCodecContext *avctx,
3540 const uint8_t **poutbuf, int *poutbuf_size,
3541 const uint8_t *buf, int buf_size);
3542 void (*parser_close)(AVCodecParserContext *s);
3543 int (*split)(AVCodecContext *avctx, const uint8_t *buf, int buf_size);
3544 struct AVCodecParser *next;
3548 * Iterate over all registered codec parsers.
3550 * @param opaque a pointer where libavcodec will store the iteration state. Must
3551 * point to NULL to start the iteration.
3553 * @return the next registered codec parser or NULL when the iteration is
3556 const AVCodecParser *av_parser_iterate(void **opaque);
3559 attribute_deprecated
3560 AVCodecParser *av_parser_next(const AVCodecParser *c);
3562 attribute_deprecated
3563 void av_register_codec_parser(AVCodecParser *parser);
3565 AVCodecParserContext *av_parser_init(int codec_id);
3570 * @param s parser context.
3571 * @param avctx codec context.
3572 * @param poutbuf set to pointer to parsed buffer or NULL if not yet finished.
3573 * @param poutbuf_size set to size of parsed buffer or zero if not yet finished.
3574 * @param buf input buffer.
3575 * @param buf_size buffer size in bytes without the padding. I.e. the full buffer
3576 size is assumed to be buf_size + AV_INPUT_BUFFER_PADDING_SIZE.
3577 To signal EOF, this should be 0 (so that the last frame
3579 * @param pts input presentation timestamp.
3580 * @param dts input decoding timestamp.
3581 * @param pos input byte position in stream.
3582 * @return the number of bytes of the input bitstream used.
3587 * len = av_parser_parse2(myparser, AVCodecContext, &data, &size,
3594 * decode_frame(data, size);
3598 int av_parser_parse2(AVCodecParserContext *s,
3599 AVCodecContext *avctx,
3600 uint8_t **poutbuf, int *poutbuf_size,
3601 const uint8_t *buf, int buf_size,
3602 int64_t pts, int64_t dts,
3606 * @return 0 if the output buffer is a subset of the input, 1 if it is allocated and must be freed
3607 * @deprecated use AVBitStreamFilter
3609 int av_parser_change(AVCodecParserContext *s,
3610 AVCodecContext *avctx,
3611 uint8_t **poutbuf, int *poutbuf_size,
3612 const uint8_t *buf, int buf_size, int keyframe);
3613 void av_parser_close(AVCodecParserContext *s);
3621 * @addtogroup lavc_encoding
3626 * Encode a frame of audio.
3628 * Takes input samples from frame and writes the next output packet, if
3629 * available, to avpkt. The output packet does not necessarily contain data for
3630 * the most recent frame, as encoders can delay, split, and combine input frames
3631 * internally as needed.
3633 * @param avctx codec context
3634 * @param avpkt output AVPacket.
3635 * The user can supply an output buffer by setting
3636 * avpkt->data and avpkt->size prior to calling the
3637 * function, but if the size of the user-provided data is not
3638 * large enough, encoding will fail. If avpkt->data and
3639 * avpkt->size are set, avpkt->destruct must also be set. All
3640 * other AVPacket fields will be reset by the encoder using
3641 * av_init_packet(). If avpkt->data is NULL, the encoder will
3642 * allocate it. The encoder will set avpkt->size to the size
3643 * of the output packet.
3645 * If this function fails or produces no output, avpkt will be
3646 * freed using av_packet_unref().
3647 * @param[in] frame AVFrame containing the raw audio data to be encoded.
3648 * May be NULL when flushing an encoder that has the
3649 * AV_CODEC_CAP_DELAY capability set.
3650 * If AV_CODEC_CAP_VARIABLE_FRAME_SIZE is set, then each frame
3651 * can have any number of samples.
3652 * If it is not set, frame->nb_samples must be equal to
3653 * avctx->frame_size for all frames except the last.
3654 * The final frame may be smaller than avctx->frame_size.
3655 * @param[out] got_packet_ptr This field is set to 1 by libavcodec if the
3656 * output packet is non-empty, and to 0 if it is
3657 * empty. If the function returns an error, the
3658 * packet can be assumed to be invalid, and the
3659 * value of got_packet_ptr is undefined and should
3661 * @return 0 on success, negative error code on failure
3663 * @deprecated use avcodec_send_frame()/avcodec_receive_packet() instead
3665 attribute_deprecated
3666 int avcodec_encode_audio2(AVCodecContext *avctx, AVPacket *avpkt,
3667 const AVFrame *frame, int *got_packet_ptr);
3670 * Encode a frame of video.
3672 * Takes input raw video data from frame and writes the next output packet, if
3673 * available, to avpkt. The output packet does not necessarily contain data for
3674 * the most recent frame, as encoders can delay and reorder input frames
3675 * internally as needed.
3677 * @param avctx codec context
3678 * @param avpkt output AVPacket.
3679 * The user can supply an output buffer by setting
3680 * avpkt->data and avpkt->size prior to calling the
3681 * function, but if the size of the user-provided data is not
3682 * large enough, encoding will fail. All other AVPacket fields
3683 * will be reset by the encoder using av_init_packet(). If
3684 * avpkt->data is NULL, the encoder will allocate it.
3685 * The encoder will set avpkt->size to the size of the
3686 * output packet. The returned data (if any) belongs to the
3687 * caller, he is responsible for freeing it.
3689 * If this function fails or produces no output, avpkt will be
3690 * freed using av_packet_unref().
3691 * @param[in] frame AVFrame containing the raw video data to be encoded.
3692 * May be NULL when flushing an encoder that has the
3693 * AV_CODEC_CAP_DELAY capability set.
3694 * @param[out] got_packet_ptr This field is set to 1 by libavcodec if the
3695 * output packet is non-empty, and to 0 if it is
3696 * empty. If the function returns an error, the
3697 * packet can be assumed to be invalid, and the
3698 * value of got_packet_ptr is undefined and should
3700 * @return 0 on success, negative error code on failure
3702 * @deprecated use avcodec_send_frame()/avcodec_receive_packet() instead
3704 attribute_deprecated
3705 int avcodec_encode_video2(AVCodecContext *avctx, AVPacket *avpkt,
3706 const AVFrame *frame, int *got_packet_ptr);
3708 int avcodec_encode_subtitle(AVCodecContext *avctx, uint8_t *buf, int buf_size,
3709 const AVSubtitle *sub);
3716 #if FF_API_AVPICTURE
3718 * @addtogroup lavc_picture
3723 * @deprecated unused
3725 attribute_deprecated
3726 int avpicture_alloc(AVPicture *picture, enum AVPixelFormat pix_fmt, int width, int height);
3729 * @deprecated unused
3731 attribute_deprecated
3732 void avpicture_free(AVPicture *picture);
3735 * @deprecated use av_image_fill_arrays() instead.
3737 attribute_deprecated
3738 int avpicture_fill(AVPicture *picture, const uint8_t *ptr,
3739 enum AVPixelFormat pix_fmt, int width, int height);
3742 * @deprecated use av_image_copy_to_buffer() instead.
3744 attribute_deprecated
3745 int avpicture_layout(const AVPicture *src, enum AVPixelFormat pix_fmt,
3746 int width, int height,
3747 unsigned char *dest, int dest_size);
3750 * @deprecated use av_image_get_buffer_size() instead.
3752 attribute_deprecated
3753 int avpicture_get_size(enum AVPixelFormat pix_fmt, int width, int height);
3756 * @deprecated av_image_copy() instead.
3758 attribute_deprecated
3759 void av_picture_copy(AVPicture *dst, const AVPicture *src,
3760 enum AVPixelFormat pix_fmt, int width, int height);
3763 * @deprecated unused
3765 attribute_deprecated
3766 int av_picture_crop(AVPicture *dst, const AVPicture *src,
3767 enum AVPixelFormat pix_fmt, int top_band, int left_band);
3770 * @deprecated unused
3772 attribute_deprecated
3773 int av_picture_pad(AVPicture *dst, const AVPicture *src, int height, int width, enum AVPixelFormat pix_fmt,
3774 int padtop, int padbottom, int padleft, int padright, int *color);
3782 * @defgroup lavc_misc Utility functions
3785 * Miscellaneous utility functions related to both encoding and decoding
3791 * @defgroup lavc_misc_pixfmt Pixel formats
3793 * Functions for working with pixel formats.
3797 #if FF_API_GETCHROMA
3799 * @deprecated Use av_pix_fmt_get_chroma_sub_sample
3802 attribute_deprecated
3803 void avcodec_get_chroma_sub_sample(enum AVPixelFormat pix_fmt, int *h_shift, int *v_shift);
3807 * Return a value representing the fourCC code associated to the
3808 * pixel format pix_fmt, or 0 if no associated fourCC code can be
3811 unsigned int avcodec_pix_fmt_to_codec_tag(enum AVPixelFormat pix_fmt);
3814 * @deprecated see av_get_pix_fmt_loss()
3816 int avcodec_get_pix_fmt_loss(enum AVPixelFormat dst_pix_fmt, enum AVPixelFormat src_pix_fmt,
3820 * Find the best pixel format to convert to given a certain source pixel
3821 * format. When converting from one pixel format to another, information loss
3822 * may occur. For example, when converting from RGB24 to GRAY, the color
3823 * information will be lost. Similarly, other losses occur when converting from
3824 * some formats to other formats. avcodec_find_best_pix_fmt_of_2() searches which of
3825 * the given pixel formats should be used to suffer the least amount of loss.
3826 * The pixel formats from which it chooses one, are determined by the
3827 * pix_fmt_list parameter.
3830 * @param[in] pix_fmt_list AV_PIX_FMT_NONE terminated array of pixel formats to choose from
3831 * @param[in] src_pix_fmt source pixel format
3832 * @param[in] has_alpha Whether the source pixel format alpha channel is used.
3833 * @param[out] loss_ptr Combination of flags informing you what kind of losses will occur.
3834 * @return The best pixel format to convert to or -1 if none was found.
3836 enum AVPixelFormat avcodec_find_best_pix_fmt_of_list(const enum AVPixelFormat *pix_fmt_list,
3837 enum AVPixelFormat src_pix_fmt,
3838 int has_alpha, int *loss_ptr);
3841 * @deprecated see av_find_best_pix_fmt_of_2()
3843 enum AVPixelFormat avcodec_find_best_pix_fmt_of_2(enum AVPixelFormat dst_pix_fmt1, enum AVPixelFormat dst_pix_fmt2,
3844 enum AVPixelFormat src_pix_fmt, int has_alpha, int *loss_ptr);
3846 attribute_deprecated
3847 enum AVPixelFormat avcodec_find_best_pix_fmt2(enum AVPixelFormat dst_pix_fmt1, enum AVPixelFormat dst_pix_fmt2,
3848 enum AVPixelFormat src_pix_fmt, int has_alpha, int *loss_ptr);
3850 enum AVPixelFormat avcodec_default_get_format(struct AVCodecContext *s, const enum AVPixelFormat * fmt);
3856 #if FF_API_TAG_STRING
3858 * Put a string representing the codec tag codec_tag in buf.
3860 * @param buf buffer to place codec tag in
3861 * @param buf_size size in bytes of buf
3862 * @param codec_tag codec tag to assign
3863 * @return the length of the string that would have been generated if
3864 * enough space had been available, excluding the trailing null
3866 * @deprecated see av_fourcc_make_string() and av_fourcc2str().
3868 attribute_deprecated
3869 size_t av_get_codec_tag_string(char *buf, size_t buf_size, unsigned int codec_tag);
3872 void avcodec_string(char *buf, int buf_size, AVCodecContext *enc, int encode);
3875 * Return a name for the specified profile, if available.
3877 * @param codec the codec that is searched for the given profile
3878 * @param profile the profile value for which a name is requested
3879 * @return A name for the profile if found, NULL otherwise.
3881 const char *av_get_profile_name(const AVCodec *codec, int profile);
3884 * Return a name for the specified profile, if available.
3886 * @param codec_id the ID of the codec to which the requested profile belongs
3887 * @param profile the profile value for which a name is requested
3888 * @return A name for the profile if found, NULL otherwise.
3890 * @note unlike av_get_profile_name(), which searches a list of profiles
3891 * supported by a specific decoder or encoder implementation, this
3892 * function searches the list of profiles from the AVCodecDescriptor
3894 const char *avcodec_profile_name(enum AVCodecID codec_id, int profile);
3896 int avcodec_default_execute(AVCodecContext *c, int (*func)(AVCodecContext *c2, void *arg2),void *arg, int *ret, int count, int size);
3897 int avcodec_default_execute2(AVCodecContext *c, int (*func)(AVCodecContext *c2, void *arg2, int, int),void *arg, int *ret, int count);
3898 //FIXME func typedef
3901 * Fill AVFrame audio data and linesize pointers.
3903 * The buffer buf must be a preallocated buffer with a size big enough
3904 * to contain the specified samples amount. The filled AVFrame data
3905 * pointers will point to this buffer.
3907 * AVFrame extended_data channel pointers are allocated if necessary for
3910 * @param frame the AVFrame
3911 * frame->nb_samples must be set prior to calling the
3912 * function. This function fills in frame->data,
3913 * frame->extended_data, frame->linesize[0].
3914 * @param nb_channels channel count
3915 * @param sample_fmt sample format
3916 * @param buf buffer to use for frame data
3917 * @param buf_size size of buffer
3918 * @param align plane size sample alignment (0 = default)
3919 * @return >=0 on success, negative error code on failure
3920 * @todo return the size in bytes required to store the samples in
3921 * case of success, at the next libavutil bump
3923 int avcodec_fill_audio_frame(AVFrame *frame, int nb_channels,
3924 enum AVSampleFormat sample_fmt, const uint8_t *buf,
3925 int buf_size, int align);
3928 * Reset the internal codec state / flush internal buffers. Should be called
3929 * e.g. when seeking or when switching to a different stream.
3931 * @note for decoders, when refcounted frames are not used
3932 * (i.e. avctx->refcounted_frames is 0), this invalidates the frames previously
3933 * returned from the decoder. When refcounted frames are used, the decoder just
3934 * releases any references it might keep internally, but the caller's reference
3937 * @note for encoders, this function will only do something if the encoder
3938 * declares support for AV_CODEC_CAP_ENCODER_FLUSH. When called, the encoder
3939 * will drain any remaining packets, and can then be re-used for a different
3940 * stream (as opposed to sending a null frame which will leave the encoder
3941 * in a permanent EOF state after draining). This can be desirable if the
3942 * cost of tearing down and replacing the encoder instance is high.
3944 void avcodec_flush_buffers(AVCodecContext *avctx);
3947 * Return codec bits per sample.
3949 * @param[in] codec_id the codec
3950 * @return Number of bits per sample or zero if unknown for the given codec.
3952 int av_get_bits_per_sample(enum AVCodecID codec_id);
3955 * Return the PCM codec associated with a sample format.
3956 * @param be endianness, 0 for little, 1 for big,
3957 * -1 (or anything else) for native
3958 * @return AV_CODEC_ID_PCM_* or AV_CODEC_ID_NONE
3960 enum AVCodecID av_get_pcm_codec(enum AVSampleFormat fmt, int be);
3963 * Return codec bits per sample.
3964 * Only return non-zero if the bits per sample is exactly correct, not an
3967 * @param[in] codec_id the codec
3968 * @return Number of bits per sample or zero if unknown for the given codec.
3970 int av_get_exact_bits_per_sample(enum AVCodecID codec_id);
3973 * Return audio frame duration.
3975 * @param avctx codec context
3976 * @param frame_bytes size of the frame, or 0 if unknown
3977 * @return frame duration, in samples, if known. 0 if not able to
3980 int av_get_audio_frame_duration(AVCodecContext *avctx, int frame_bytes);
3983 * This function is the same as av_get_audio_frame_duration(), except it works
3984 * with AVCodecParameters instead of an AVCodecContext.
3986 int av_get_audio_frame_duration2(AVCodecParameters *par, int frame_bytes);
3989 typedef struct AVBitStreamFilterContext {
3991 const struct AVBitStreamFilter *filter;
3992 AVCodecParserContext *parser;
3993 struct AVBitStreamFilterContext *next;
3995 * Internal default arguments, used if NULL is passed to av_bitstream_filter_filter().
3996 * Not for access by library users.
3999 } AVBitStreamFilterContext;
4002 * @deprecated the old bitstream filtering API (using AVBitStreamFilterContext)
4003 * is deprecated. Use the new bitstream filtering API (using AVBSFContext).
4005 attribute_deprecated
4006 void av_register_bitstream_filter(AVBitStreamFilter *bsf);
4008 * @deprecated the old bitstream filtering API (using AVBitStreamFilterContext)
4009 * is deprecated. Use av_bsf_get_by_name(), av_bsf_alloc(), and av_bsf_init()
4010 * from the new bitstream filtering API (using AVBSFContext).
4012 attribute_deprecated
4013 AVBitStreamFilterContext *av_bitstream_filter_init(const char *name);
4015 * @deprecated the old bitstream filtering API (using AVBitStreamFilterContext)
4016 * is deprecated. Use av_bsf_send_packet() and av_bsf_receive_packet() from the
4017 * new bitstream filtering API (using AVBSFContext).
4019 attribute_deprecated
4020 int av_bitstream_filter_filter(AVBitStreamFilterContext *bsfc,
4021 AVCodecContext *avctx, const char *args,
4022 uint8_t **poutbuf, int *poutbuf_size,
4023 const uint8_t *buf, int buf_size, int keyframe);
4025 * @deprecated the old bitstream filtering API (using AVBitStreamFilterContext)
4026 * is deprecated. Use av_bsf_free() from the new bitstream filtering API (using
4029 attribute_deprecated
4030 void av_bitstream_filter_close(AVBitStreamFilterContext *bsf);
4032 * @deprecated the old bitstream filtering API (using AVBitStreamFilterContext)
4033 * is deprecated. Use av_bsf_iterate() from the new bitstream filtering API (using
4036 attribute_deprecated
4037 const AVBitStreamFilter *av_bitstream_filter_next(const AVBitStreamFilter *f);
4041 attribute_deprecated
4042 const AVBitStreamFilter *av_bsf_next(void **opaque);
4048 * Same behaviour av_fast_malloc but the buffer has additional
4049 * AV_INPUT_BUFFER_PADDING_SIZE at the end which will always be 0.
4051 * In addition the whole buffer will initially and after resizes
4052 * be 0-initialized so that no uninitialized data will ever appear.
4054 void av_fast_padded_malloc(void *ptr, unsigned int *size, size_t min_size);
4057 * Same behaviour av_fast_padded_malloc except that buffer will always
4058 * be 0-initialized after call.
4060 void av_fast_padded_mallocz(void *ptr, unsigned int *size, size_t min_size);
4063 * Encode extradata length to a buffer. Used by xiph codecs.
4065 * @param s buffer to write to; must be at least (v/255+1) bytes long
4066 * @param v size of extradata in bytes
4067 * @return number of bytes written to the buffer.
4069 unsigned int av_xiphlacing(unsigned char *s, unsigned int v);
4071 #if FF_API_USER_VISIBLE_AVHWACCEL
4073 * Register the hardware accelerator hwaccel.
4075 * @deprecated This function doesn't do anything.
4077 attribute_deprecated
4078 void av_register_hwaccel(AVHWAccel *hwaccel);
4081 * If hwaccel is NULL, returns the first registered hardware accelerator,
4082 * if hwaccel is non-NULL, returns the next registered hardware accelerator
4083 * after hwaccel, or NULL if hwaccel is the last one.
4085 * @deprecated AVHWaccel structures contain no user-serviceable parts, so
4086 * this function should not be used.
4088 attribute_deprecated
4089 AVHWAccel *av_hwaccel_next(const AVHWAccel *hwaccel);
4094 * Lock operation used by lockmgr
4096 * @deprecated Deprecated together with av_lockmgr_register().
4099 AV_LOCK_CREATE, ///< Create a mutex
4100 AV_LOCK_OBTAIN, ///< Lock the mutex
4101 AV_LOCK_RELEASE, ///< Unlock the mutex
4102 AV_LOCK_DESTROY, ///< Free mutex resources
4106 * Register a user provided lock manager supporting the operations
4107 * specified by AVLockOp. The "mutex" argument to the function points
4108 * to a (void *) where the lockmgr should store/get a pointer to a user
4109 * allocated mutex. It is NULL upon AV_LOCK_CREATE and equal to the
4110 * value left by the last call for all other ops. If the lock manager is
4111 * unable to perform the op then it should leave the mutex in the same
4112 * state as when it was called and return a non-zero value. However,
4113 * when called with AV_LOCK_DESTROY the mutex will always be assumed to
4114 * have been successfully destroyed. If av_lockmgr_register succeeds
4115 * it will return a non-negative value, if it fails it will return a
4116 * negative value and destroy all mutex and unregister all callbacks.
4117 * av_lockmgr_register is not thread-safe, it must be called from a
4118 * single thread before any calls which make use of locking are used.
4120 * @param cb User defined callback. av_lockmgr_register invokes calls
4121 * to this callback and the previously registered callback.
4122 * The callback will be used to create more than one mutex
4123 * each of which must be backed by its own underlying locking
4124 * mechanism (i.e. do not use a single static object to
4125 * implement your lock manager). If cb is set to NULL the
4126 * lockmgr will be unregistered.
4128 * @deprecated This function does nothing, and always returns 0. Be sure to
4129 * build with thread support to get basic thread safety.
4131 attribute_deprecated
4132 int av_lockmgr_register(int (*cb)(void **mutex, enum AVLockOp op));
4136 * @return a positive value if s is open (i.e. avcodec_open2() was called on it
4137 * with no corresponding avcodec_close()), 0 otherwise.
4139 int avcodec_is_open(AVCodecContext *s);
4142 * Allocate a CPB properties structure and initialize its fields to default
4145 * @param size if non-NULL, the size of the allocated struct will be written
4146 * here. This is useful for embedding it in side data.
4148 * @return the newly allocated struct or NULL on failure
4150 AVCPBProperties *av_cpb_properties_alloc(size_t *size);
4156 #endif /* AVCODEC_AVCODEC_H */