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 * A codec is not allowed to return AVERROR(EAGAIN) for both sending and receiving. This
159 * would be an invalid state, which could put the codec user into an endless
160 * loop. The API has no concept of time either: it cannot happen that trying to
161 * do avcodec_send_packet() results in AVERROR(EAGAIN), but a repeated call 1 second
162 * later accepts the packet (with no other receive/flush API calls involved).
163 * The API is a strict state machine, and the passage of time is not supposed
164 * to influence it. Some timing-dependent behavior might still be deemed
165 * acceptable in certain cases. But it must never result in both send/receive
166 * returning EAGAIN at the same time at any point. It must also absolutely be
167 * avoided that the current state is "unstable" and can "flip-flop" between
168 * the send/receive APIs allowing progress. For example, it's not allowed that
169 * the codec randomly decides that it actually wants to consume a packet now
170 * instead of returning a frame, after it just returned AVERROR(EAGAIN) on an
171 * avcodec_send_packet() call.
176 * @defgroup lavc_core Core functions/structures.
179 * Basic definitions, functions for querying libavcodec capabilities,
180 * allocating core structures, etc.
185 * @ingroup lavc_decoding
186 * Required number of additionally allocated bytes at the end of the input bitstream for decoding.
187 * This is mainly needed because some optimized bitstream readers read
188 * 32 or 64 bit at once and could read over the end.<br>
189 * Note: If the first 23 bits of the additional bytes are not 0, then damaged
190 * MPEG bitstreams could cause overread and segfault.
192 #define AV_INPUT_BUFFER_PADDING_SIZE 64
195 * @ingroup lavc_encoding
196 * minimum encoding buffer size
197 * Used to avoid some checks during header writing.
199 #define AV_INPUT_BUFFER_MIN_SIZE 16384
202 * @ingroup lavc_decoding
205 /* We leave some space between them for extensions (drop some
206 * keyframes for intra-only or drop just some bidir frames). */
207 AVDISCARD_NONE =-16, ///< discard nothing
208 AVDISCARD_DEFAULT = 0, ///< discard useless packets like 0 size packets in avi
209 AVDISCARD_NONREF = 8, ///< discard all non reference
210 AVDISCARD_BIDIR = 16, ///< discard all bidirectional frames
211 AVDISCARD_NONINTRA= 24, ///< discard all non intra frames
212 AVDISCARD_NONKEY = 32, ///< discard all frames except keyframes
213 AVDISCARD_ALL = 48, ///< discard all
216 enum AVAudioServiceType {
217 AV_AUDIO_SERVICE_TYPE_MAIN = 0,
218 AV_AUDIO_SERVICE_TYPE_EFFECTS = 1,
219 AV_AUDIO_SERVICE_TYPE_VISUALLY_IMPAIRED = 2,
220 AV_AUDIO_SERVICE_TYPE_HEARING_IMPAIRED = 3,
221 AV_AUDIO_SERVICE_TYPE_DIALOGUE = 4,
222 AV_AUDIO_SERVICE_TYPE_COMMENTARY = 5,
223 AV_AUDIO_SERVICE_TYPE_EMERGENCY = 6,
224 AV_AUDIO_SERVICE_TYPE_VOICE_OVER = 7,
225 AV_AUDIO_SERVICE_TYPE_KARAOKE = 8,
226 AV_AUDIO_SERVICE_TYPE_NB , ///< Not part of ABI
230 * @ingroup lavc_encoding
232 typedef struct RcOverride{
235 int qscale; // If this is 0 then quality_factor will be used instead.
236 float quality_factor;
240 These flags can be passed in AVCodecContext.flags before initialization.
241 Note: Not everything is supported yet.
245 * Allow decoders to produce frames with data planes that are not aligned
246 * to CPU requirements (e.g. due to cropping).
248 #define AV_CODEC_FLAG_UNALIGNED (1 << 0)
252 #define AV_CODEC_FLAG_QSCALE (1 << 1)
254 * 4 MV per MB allowed / advanced prediction for H.263.
256 #define AV_CODEC_FLAG_4MV (1 << 2)
258 * Output even those frames that might be corrupted.
260 #define AV_CODEC_FLAG_OUTPUT_CORRUPT (1 << 3)
264 #define AV_CODEC_FLAG_QPEL (1 << 4)
266 * Don't output frames whose parameters differ from first
267 * decoded frame in stream.
269 #define AV_CODEC_FLAG_DROPCHANGED (1 << 5)
271 * Use internal 2pass ratecontrol in first pass mode.
273 #define AV_CODEC_FLAG_PASS1 (1 << 9)
275 * Use internal 2pass ratecontrol in second pass mode.
277 #define AV_CODEC_FLAG_PASS2 (1 << 10)
281 #define AV_CODEC_FLAG_LOOP_FILTER (1 << 11)
283 * Only decode/encode grayscale.
285 #define AV_CODEC_FLAG_GRAY (1 << 13)
287 * error[?] variables will be set during encoding.
289 #define AV_CODEC_FLAG_PSNR (1 << 15)
291 * Input bitstream might be truncated at a random location
292 * instead of only at frame boundaries.
294 #define AV_CODEC_FLAG_TRUNCATED (1 << 16)
296 * Use interlaced DCT.
298 #define AV_CODEC_FLAG_INTERLACED_DCT (1 << 18)
302 #define AV_CODEC_FLAG_LOW_DELAY (1 << 19)
304 * Place global headers in extradata instead of every keyframe.
306 #define AV_CODEC_FLAG_GLOBAL_HEADER (1 << 22)
308 * Use only bitexact stuff (except (I)DCT).
310 #define AV_CODEC_FLAG_BITEXACT (1 << 23)
311 /* Fx : Flag for H.263+ extra options */
313 * H.263 advanced intra coding / MPEG-4 AC prediction
315 #define AV_CODEC_FLAG_AC_PRED (1 << 24)
317 * interlaced motion estimation
319 #define AV_CODEC_FLAG_INTERLACED_ME (1 << 29)
320 #define AV_CODEC_FLAG_CLOSED_GOP (1U << 31)
323 * Allow non spec compliant speedup tricks.
325 #define AV_CODEC_FLAG2_FAST (1 << 0)
327 * Skip bitstream encoding.
329 #define AV_CODEC_FLAG2_NO_OUTPUT (1 << 2)
331 * Place global headers at every keyframe instead of in extradata.
333 #define AV_CODEC_FLAG2_LOCAL_HEADER (1 << 3)
336 * timecode is in drop frame format. DEPRECATED!!!!
338 #define AV_CODEC_FLAG2_DROP_FRAME_TIMECODE (1 << 13)
341 * Input bitstream might be truncated at a packet boundaries
342 * instead of only at frame boundaries.
344 #define AV_CODEC_FLAG2_CHUNKS (1 << 15)
346 * Discard cropping information from SPS.
348 #define AV_CODEC_FLAG2_IGNORE_CROP (1 << 16)
351 * Show all frames before the first keyframe
353 #define AV_CODEC_FLAG2_SHOW_ALL (1 << 22)
355 * Export motion vectors through frame side data
357 #define AV_CODEC_FLAG2_EXPORT_MVS (1 << 28)
359 * Do not skip samples and export skip information as frame side data
361 #define AV_CODEC_FLAG2_SKIP_MANUAL (1 << 29)
363 * Do not reset ASS ReadOrder field on flush (subtitles decoding)
365 #define AV_CODEC_FLAG2_RO_FLUSH_NOOP (1 << 30)
367 /* Unsupported options :
368 * Syntax Arithmetic coding (SAC)
369 * Reference Picture Selection
370 * Independent Segment Decoding */
372 /* codec capabilities */
374 /* Exported side data.
375 These flags can be passed in AVCodecContext.export_side_data before initialization.
378 * Export motion vectors through frame side data
380 #define AV_CODEC_EXPORT_DATA_MVS (1 << 0)
382 * Export encoder Producer Reference Time through packet side data
384 #define AV_CODEC_EXPORT_DATA_PRFT (1 << 1)
387 * Export the AVVideoEncParams structure through frame side data.
389 #define AV_CODEC_EXPORT_DATA_VIDEO_ENC_PARAMS (1 << 2)
392 * Do not apply film grain, export it instead.
394 #define AV_CODEC_EXPORT_DATA_FILM_GRAIN (1 << 3)
398 * This specifies the area which should be displayed.
399 * Note there may be multiple such areas for one frame.
401 typedef struct AVPanScan {
404 * - encoding: Set by user.
405 * - decoding: Set by libavcodec.
410 * width and height in 1/16 pel
411 * - encoding: Set by user.
412 * - decoding: Set by libavcodec.
418 * position of the top left corner in 1/16 pel for up to 3 fields/frames
419 * - encoding: Set by user.
420 * - decoding: Set by libavcodec.
422 int16_t position[3][2];
426 * This structure describes the bitrate properties of an encoded bitstream. It
427 * roughly corresponds to a subset the VBV parameters for MPEG-2 or HRD
428 * parameters for H.264/HEVC.
430 typedef struct AVCPBProperties {
432 * Maximum bitrate of the stream, in bits per second.
433 * Zero if unknown or unspecified.
437 * Minimum bitrate of the stream, in bits per second.
438 * Zero if unknown or unspecified.
442 * Average bitrate of the stream, in bits per second.
443 * Zero if unknown or unspecified.
448 * The size of the buffer to which the ratecontrol is applied, in bits.
449 * Zero if unknown or unspecified.
454 * The delay between the time the packet this structure is associated with
455 * is received and the time when it should be decoded, in periods of a 27MHz
458 * UINT64_MAX when unknown or unspecified.
464 * This structure supplies correlation between a packet timestamp and a wall clock
465 * production time. The definition follows the Producer Reference Time ('prft')
466 * as defined in ISO/IEC 14496-12
468 typedef struct AVProducerReferenceTime {
470 * A UTC timestamp, in microseconds, since Unix epoch (e.g, av_gettime()).
474 } AVProducerReferenceTime;
477 * The decoder will keep a reference to the frame and may reuse it later.
479 #define AV_GET_BUFFER_FLAG_REF (1 << 0)
482 * The encoder will keep a reference to the packet and may reuse it later.
484 #define AV_GET_ENCODE_BUFFER_FLAG_REF (1 << 0)
486 struct AVCodecInternal;
489 * main external API structure.
490 * New fields can be added to the end with minor version bumps.
491 * Removal, reordering and changes to existing fields require a major
493 * You can use AVOptions (av_opt* / av_set/get*()) to access these fields from user
495 * The name string for AVOptions options matches the associated command line
496 * parameter name and can be found in libavcodec/options_table.h
497 * The AVOption/command line parameter names differ in some cases from the C
498 * structure field names for historic reasons or brevity.
499 * sizeof(AVCodecContext) must not be used outside libav*.
501 typedef struct AVCodecContext {
503 * information on struct for av_log
504 * - set by avcodec_alloc_context3
506 const AVClass *av_class;
507 int log_level_offset;
509 enum AVMediaType codec_type; /* see AVMEDIA_TYPE_xxx */
510 const struct AVCodec *codec;
511 enum AVCodecID codec_id; /* see AV_CODEC_ID_xxx */
514 * fourcc (LSB first, so "ABCD" -> ('D'<<24) + ('C'<<16) + ('B'<<8) + 'A').
515 * This is used to work around some encoder bugs.
516 * A demuxer should set this to what is stored in the field used to identify the codec.
517 * If there are multiple such fields in a container then the demuxer should choose the one
518 * which maximizes the information about the used codec.
519 * If the codec tag field in a container is larger than 32 bits then the demuxer should
520 * remap the longer ID to 32 bits with a table or other structure. Alternatively a new
521 * extra_codec_tag + size could be added but for this a clear advantage must be demonstrated
523 * - encoding: Set by user, if not then the default based on codec_id will be used.
524 * - decoding: Set by user, will be converted to uppercase by libavcodec during init.
526 unsigned int codec_tag;
531 * Private context used for internal data.
533 * Unlike priv_data, this is not codec-specific. It is used in general
534 * libavcodec functions.
536 struct AVCodecInternal *internal;
539 * Private data of the user, can be used to carry app specific stuff.
540 * - encoding: Set by user.
541 * - decoding: Set by user.
546 * the average bitrate
547 * - encoding: Set by user; unused for constant quantizer encoding.
548 * - decoding: Set by user, may be overwritten by libavcodec
549 * if this info is available in the stream
554 * number of bits the bitstream is allowed to diverge from the reference.
555 * the reference can be CBR (for CBR pass1) or VBR (for pass2)
556 * - encoding: Set by user; unused for constant quantizer encoding.
559 int bit_rate_tolerance;
562 * Global quality for codecs which cannot change it per frame.
563 * This should be proportional to MPEG-1/2/4 qscale.
564 * - encoding: Set by user.
570 * - encoding: Set by user.
573 int compression_level;
574 #define FF_COMPRESSION_DEFAULT -1
578 * - encoding: Set by user.
579 * - decoding: Set by user.
585 * - encoding: Set by user.
586 * - decoding: Set by user.
591 * some codecs need / can use extradata like Huffman tables.
592 * MJPEG: Huffman tables
593 * rv10: additional flags
594 * MPEG-4: global headers (they can be in the bitstream or here)
595 * The allocated memory should be AV_INPUT_BUFFER_PADDING_SIZE bytes larger
596 * than extradata_size to avoid problems if it is read with the bitstream reader.
597 * The bytewise contents of extradata must not depend on the architecture or CPU endianness.
598 * Must be allocated with the av_malloc() family of functions.
599 * - encoding: Set/allocated/freed by libavcodec.
600 * - decoding: Set/allocated/freed by user.
606 * This is the fundamental unit of time (in seconds) in terms
607 * of which frame timestamps are represented. For fixed-fps content,
608 * timebase should be 1/framerate and timestamp increments should be
610 * This often, but not always is the inverse of the frame rate or field rate
611 * for video. 1/time_base is not the average frame rate if the frame rate is not
614 * Like containers, elementary streams also can store timestamps, 1/time_base
615 * is the unit in which these timestamps are specified.
616 * As example of such codec time base see ISO/IEC 14496-2:2001(E)
617 * vop_time_increment_resolution and fixed_vop_rate
618 * (fixed_vop_rate == 0 implies that it is different from the framerate)
620 * - encoding: MUST be set by user.
621 * - decoding: the use of this field for decoding is deprecated.
622 * Use framerate instead.
624 AVRational time_base;
627 * For some codecs, the time base is closer to the field rate than the frame rate.
628 * Most notably, H.264 and MPEG-2 specify time_base as half of frame duration
629 * if no telecine is used ...
631 * Set to time_base ticks per frame. Default 1, e.g., H.264/MPEG-2 set it to 2.
638 * Encoding: Number of frames delay there will be from the encoder input to
639 * the decoder output. (we assume the decoder matches the spec)
640 * Decoding: Number of frames delay in addition to what a standard decoder
641 * as specified in the spec would produce.
644 * Number of frames the decoded output will be delayed relative to the
648 * For encoding, this field is unused (see initial_padding).
650 * For decoding, this is the number of samples the decoder needs to
651 * output before the decoder's output is valid. When seeking, you should
652 * start decoding this many samples prior to your desired seek point.
654 * - encoding: Set by libavcodec.
655 * - decoding: Set by libavcodec.
662 * picture width / height.
664 * @note Those fields may not match the values of the last
665 * AVFrame output by avcodec_receive_frame() due frame
668 * - encoding: MUST be set by user.
669 * - decoding: May be set by the user before opening the decoder if known e.g.
670 * from the container. Some decoders will require the dimensions
671 * to be set by the caller. During decoding, the decoder may
672 * overwrite those values as required while parsing the data.
677 * Bitstream width / height, may be different from width/height e.g. when
678 * the decoded frame is cropped before being output or lowres is enabled.
680 * @note Those field may not match the value of the last
681 * AVFrame output by avcodec_receive_frame() due frame
685 * - decoding: May be set by the user before opening the decoder if known
686 * e.g. from the container. During decoding, the decoder may
687 * overwrite those values as required while parsing the data.
689 int coded_width, coded_height;
692 * the number of pictures in a group of pictures, or 0 for intra_only
693 * - encoding: Set by user.
699 * Pixel format, see AV_PIX_FMT_xxx.
700 * May be set by the demuxer if known from headers.
701 * May be overridden by the decoder if it knows better.
703 * @note This field may not match the value of the last
704 * AVFrame output by avcodec_receive_frame() due frame
707 * - encoding: Set by user.
708 * - decoding: Set by user if known, overridden by libavcodec while
711 enum AVPixelFormat pix_fmt;
714 * If non NULL, 'draw_horiz_band' is called by the libavcodec
715 * decoder to draw a horizontal band. It improves cache usage. Not
716 * all codecs can do that. You must check the codec capabilities
718 * When multithreading is used, it may be called from multiple threads
719 * at the same time; threads might draw different parts of the same AVFrame,
720 * or multiple AVFrames, and there is no guarantee that slices will be drawn
722 * The function is also used by hardware acceleration APIs.
723 * It is called at least once during frame decoding to pass
724 * the data needed for hardware render.
725 * In that mode instead of pixel data, AVFrame points to
726 * a structure specific to the acceleration API. The application
727 * reads the structure and can change some fields to indicate progress
730 * - decoding: Set by user.
731 * @param height the height of the slice
732 * @param y the y position of the slice
733 * @param type 1->top field, 2->bottom field, 3->frame
734 * @param offset offset into the AVFrame.data from which the slice should be read
736 void (*draw_horiz_band)(struct AVCodecContext *s,
737 const AVFrame *src, int offset[AV_NUM_DATA_POINTERS],
738 int y, int type, int height);
741 * callback to negotiate the pixelFormat
742 * @param fmt is the list of formats which are supported by the codec,
743 * it is terminated by -1 as 0 is a valid format, the formats are ordered by quality.
744 * The first is always the native one.
745 * @note The callback may be called again immediately if initialization for
746 * the selected (hardware-accelerated) pixel format failed.
747 * @warning Behavior is undefined if the callback returns a value not
748 * in the fmt list of formats.
749 * @return the chosen format
751 * - decoding: Set by user, if not set the native format will be chosen.
753 enum AVPixelFormat (*get_format)(struct AVCodecContext *s, const enum AVPixelFormat * fmt);
756 * maximum number of B-frames between non-B-frames
757 * Note: The output will be delayed by max_b_frames+1 relative to the input.
758 * - encoding: Set by user.
764 * qscale factor between IP and B-frames
765 * If > 0 then the last P-frame quantizer will be used (q= lastp_q*factor+offset).
766 * If < 0 then normal ratecontrol will be done (q= -normal_q*factor+offset).
767 * - encoding: Set by user.
770 float b_quant_factor;
773 * qscale offset between IP and B-frames
774 * - encoding: Set by user.
777 float b_quant_offset;
780 * Size of the frame reordering buffer in the decoder.
781 * For MPEG-2 it is 1 IPB or 0 low delay IP.
782 * - encoding: Set by libavcodec.
783 * - decoding: Set by libavcodec.
788 * qscale factor between P- and I-frames
789 * If > 0 then the last P-frame quantizer will be used (q = lastp_q * factor + offset).
790 * If < 0 then normal ratecontrol will be done (q= -normal_q*factor+offset).
791 * - encoding: Set by user.
794 float i_quant_factor;
797 * qscale offset between P and I-frames
798 * - encoding: Set by user.
801 float i_quant_offset;
804 * luminance masking (0-> disabled)
805 * - encoding: Set by user.
811 * temporary complexity masking (0-> disabled)
812 * - encoding: Set by user.
815 float temporal_cplx_masking;
818 * spatial complexity masking (0-> disabled)
819 * - encoding: Set by user.
822 float spatial_cplx_masking;
825 * p block masking (0-> disabled)
826 * - encoding: Set by user.
832 * darkness masking (0-> disabled)
833 * - encoding: Set by user.
840 * - encoding: Set by libavcodec.
841 * - decoding: Set by user (or 0).
846 * slice offsets in the frame in bytes
847 * - encoding: Set/allocated by libavcodec.
848 * - decoding: Set/allocated by user (or NULL).
853 * sample aspect ratio (0 if unknown)
854 * That is the width of a pixel divided by the height of the pixel.
855 * Numerator and denominator must be relatively prime and smaller than 256 for some video standards.
856 * - encoding: Set by user.
857 * - decoding: Set by libavcodec.
859 AVRational sample_aspect_ratio;
862 * motion estimation comparison function
863 * - encoding: Set by user.
868 * subpixel motion estimation comparison function
869 * - encoding: Set by user.
874 * macroblock comparison function (not supported yet)
875 * - encoding: Set by user.
880 * interlaced DCT comparison function
881 * - encoding: Set by user.
887 #define FF_CMP_SATD 2
889 #define FF_CMP_PSNR 4
892 #define FF_CMP_ZERO 7
893 #define FF_CMP_VSAD 8
894 #define FF_CMP_VSSE 9
895 #define FF_CMP_NSSE 10
896 #define FF_CMP_W53 11
897 #define FF_CMP_W97 12
898 #define FF_CMP_DCTMAX 13
899 #define FF_CMP_DCT264 14
900 #define FF_CMP_MEDIAN_SAD 15
901 #define FF_CMP_CHROMA 256
904 * ME diamond size & shape
905 * - encoding: Set by user.
911 * amount of previous MV predictors (2a+1 x 2a+1 square)
912 * - encoding: Set by user.
915 int last_predictor_count;
918 * motion estimation prepass comparison function
919 * - encoding: Set by user.
925 * ME prepass diamond size & shape
926 * - encoding: Set by user.
933 * - encoding: Set by user.
936 int me_subpel_quality;
939 * maximum motion estimation search range in subpel units
940 * If 0 then no limit.
942 * - encoding: Set by user.
950 * - decoding: Set by user.
953 #define SLICE_FLAG_CODED_ORDER 0x0001 ///< draw_horiz_band() is called in coded order instead of display
954 #define SLICE_FLAG_ALLOW_FIELD 0x0002 ///< allow draw_horiz_band() with field slices (MPEG-2 field pics)
955 #define SLICE_FLAG_ALLOW_PLANE 0x0004 ///< allow draw_horiz_band() with 1 component at a time (SVQ1)
958 * macroblock decision mode
959 * - encoding: Set by user.
963 #define FF_MB_DECISION_SIMPLE 0 ///< uses mb_cmp
964 #define FF_MB_DECISION_BITS 1 ///< chooses the one which needs the fewest bits
965 #define FF_MB_DECISION_RD 2 ///< rate distortion
968 * custom intra quantization matrix
969 * Must be allocated with the av_malloc() family of functions, and will be freed in
970 * avcodec_free_context().
971 * - encoding: Set/allocated by user, freed by libavcodec. Can be NULL.
972 * - decoding: Set/allocated/freed by libavcodec.
974 uint16_t *intra_matrix;
977 * custom inter quantization matrix
978 * Must be allocated with the av_malloc() family of functions, and will be freed in
979 * avcodec_free_context().
980 * - encoding: Set/allocated by user, freed by libavcodec. Can be NULL.
981 * - decoding: Set/allocated/freed by libavcodec.
983 uint16_t *inter_matrix;
986 * precision of the intra DC coefficient - 8
987 * - encoding: Set by user.
988 * - decoding: Set by libavcodec
990 int intra_dc_precision;
993 * Number of macroblock rows at the top which are skipped.
995 * - decoding: Set by user.
1000 * Number of macroblock rows at the bottom which are skipped.
1001 * - encoding: unused
1002 * - decoding: Set by user.
1007 * minimum MB Lagrange multiplier
1008 * - encoding: Set by user.
1009 * - decoding: unused
1014 * maximum MB Lagrange multiplier
1015 * - encoding: Set by user.
1016 * - decoding: unused
1021 * - encoding: Set by user.
1022 * - decoding: unused
1028 * - encoding: Set by user.
1029 * - decoding: unused
1034 * number of reference frames
1035 * - encoding: Set by user.
1036 * - decoding: Set by lavc.
1041 * Note: Value depends upon the compare function used for fullpel ME.
1042 * - encoding: Set by user.
1043 * - decoding: unused
1048 * Chromaticity coordinates of the source primaries.
1049 * - encoding: Set by user
1050 * - decoding: Set by libavcodec
1052 enum AVColorPrimaries color_primaries;
1055 * Color Transfer Characteristic.
1056 * - encoding: Set by user
1057 * - decoding: Set by libavcodec
1059 enum AVColorTransferCharacteristic color_trc;
1062 * YUV colorspace type.
1063 * - encoding: Set by user
1064 * - decoding: Set by libavcodec
1066 enum AVColorSpace colorspace;
1069 * MPEG vs JPEG YUV range.
1070 * - encoding: Set by user
1071 * - decoding: Set by libavcodec
1073 enum AVColorRange color_range;
1076 * This defines the location of chroma samples.
1077 * - encoding: Set by user
1078 * - decoding: Set by libavcodec
1080 enum AVChromaLocation chroma_sample_location;
1084 * Indicates number of picture subdivisions. Used for parallelized
1086 * - encoding: Set by user
1087 * - decoding: unused
1092 * - encoding: set by libavcodec
1093 * - decoding: Set by user.
1095 enum AVFieldOrder field_order;
1098 int sample_rate; ///< samples per second
1099 int channels; ///< number of audio channels
1102 * audio sample format
1103 * - encoding: Set by user.
1104 * - decoding: Set by libavcodec.
1106 enum AVSampleFormat sample_fmt; ///< sample format
1108 /* The following data should not be initialized. */
1110 * Number of samples per channel in an audio frame.
1112 * - encoding: set by libavcodec in avcodec_open2(). Each submitted frame
1113 * except the last must contain exactly frame_size samples per channel.
1114 * May be 0 when the codec has AV_CODEC_CAP_VARIABLE_FRAME_SIZE set, then the
1115 * frame size is not restricted.
1116 * - decoding: may be set by some decoders to indicate constant frame size
1121 * Frame counter, set by libavcodec.
1123 * - decoding: total number of frames returned from the decoder so far.
1124 * - encoding: total number of frames passed to the encoder so far.
1126 * @note the counter is not incremented if encoding/decoding resulted in
1132 * number of bytes per packet if constant and known or 0
1133 * Used by some WAV based audio codecs.
1138 * Audio cutoff bandwidth (0 means "automatic")
1139 * - encoding: Set by user.
1140 * - decoding: unused
1145 * Audio channel layout.
1146 * - encoding: set by user.
1147 * - decoding: set by user, may be overwritten by libavcodec.
1149 uint64_t channel_layout;
1152 * Request decoder to use this channel layout if it can (0 for default)
1153 * - encoding: unused
1154 * - decoding: Set by user.
1156 uint64_t request_channel_layout;
1159 * Type of service that the audio stream conveys.
1160 * - encoding: Set by user.
1161 * - decoding: Set by libavcodec.
1163 enum AVAudioServiceType audio_service_type;
1166 * desired sample format
1167 * - encoding: Not used.
1168 * - decoding: Set by user.
1169 * Decoder will decode to this format if it can.
1171 enum AVSampleFormat request_sample_fmt;
1174 * This callback is called at the beginning of each frame to get data
1175 * buffer(s) for it. There may be one contiguous buffer for all the data or
1176 * there may be a buffer per each data plane or anything in between. What
1177 * this means is, you may set however many entries in buf[] you feel necessary.
1178 * Each buffer must be reference-counted using the AVBuffer API (see description
1181 * The following fields will be set in the frame before this callback is
1184 * - width, height (video only)
1185 * - sample_rate, channel_layout, nb_samples (audio only)
1186 * Their values may differ from the corresponding values in
1187 * AVCodecContext. This callback must use the frame values, not the codec
1188 * context values, to calculate the required buffer size.
1190 * This callback must fill the following fields in the frame:
1194 * * if the data is planar audio with more than 8 channels, then this
1195 * callback must allocate and fill extended_data to contain all pointers
1196 * to all data planes. data[] must hold as many pointers as it can.
1197 * extended_data must be allocated with av_malloc() and will be freed in
1199 * * otherwise extended_data must point to data
1200 * - buf[] must contain one or more pointers to AVBufferRef structures. Each of
1201 * the frame's data and extended_data pointers must be contained in these. That
1202 * is, one AVBufferRef for each allocated chunk of memory, not necessarily one
1203 * AVBufferRef per data[] entry. See: av_buffer_create(), av_buffer_alloc(),
1204 * and av_buffer_ref().
1205 * - extended_buf and nb_extended_buf must be allocated with av_malloc() by
1206 * this callback and filled with the extra buffers if there are more
1207 * buffers than buf[] can hold. extended_buf will be freed in
1210 * If AV_CODEC_CAP_DR1 is not set then get_buffer2() must call
1211 * avcodec_default_get_buffer2() instead of providing buffers allocated by
1214 * Each data plane must be aligned to the maximum required by the target
1217 * @see avcodec_default_get_buffer2()
1221 * If AV_GET_BUFFER_FLAG_REF is set in flags then the frame may be reused
1222 * (read and/or written to if it is writable) later by libavcodec.
1224 * avcodec_align_dimensions2() should be used to find the required width and
1225 * height, as they normally need to be rounded up to the next multiple of 16.
1227 * Some decoders do not support linesizes changing between frames.
1229 * If frame multithreading is used, this callback may be called from a
1230 * different thread, but not from more than one at once. Does not need to be
1233 * @see avcodec_align_dimensions2()
1237 * Decoders request a buffer of a particular size by setting
1238 * AVFrame.nb_samples prior to calling get_buffer2(). The decoder may,
1239 * however, utilize only part of the buffer by setting AVFrame.nb_samples
1240 * to a smaller value in the output frame.
1242 * As a convenience, av_samples_get_buffer_size() and
1243 * av_samples_fill_arrays() in libavutil may be used by custom get_buffer2()
1244 * functions to find the required data size and to fill data pointers and
1245 * linesize. In AVFrame.linesize, only linesize[0] may be set for audio
1246 * since all planes must be the same size.
1248 * @see av_samples_get_buffer_size(), av_samples_fill_arrays()
1250 * - encoding: unused
1251 * - decoding: Set by libavcodec, user can override.
1253 int (*get_buffer2)(struct AVCodecContext *s, AVFrame *frame, int flags);
1255 /* - encoding parameters */
1256 float qcompress; ///< amount of qscale change between easy & hard scenes (0.0-1.0)
1257 float qblur; ///< amount of qscale smoothing over time (0.0-1.0)
1261 * - encoding: Set by user.
1262 * - decoding: unused
1268 * - encoding: Set by user.
1269 * - decoding: unused
1274 * maximum quantizer difference between frames
1275 * - encoding: Set by user.
1276 * - decoding: unused
1281 * decoder bitstream buffer size
1282 * - encoding: Set by user.
1283 * - decoding: unused
1288 * ratecontrol override, see RcOverride
1289 * - encoding: Allocated/set/freed by user.
1290 * - decoding: unused
1292 int rc_override_count;
1293 RcOverride *rc_override;
1297 * - encoding: Set by user.
1298 * - decoding: Set by user, may be overwritten by libavcodec.
1300 int64_t rc_max_rate;
1304 * - encoding: Set by user.
1305 * - decoding: unused
1307 int64_t rc_min_rate;
1310 * Ratecontrol attempt to use, at maximum, <value> of what can be used without an underflow.
1311 * - encoding: Set by user.
1312 * - decoding: unused.
1314 float rc_max_available_vbv_use;
1317 * Ratecontrol attempt to use, at least, <value> times the amount needed to prevent a vbv overflow.
1318 * - encoding: Set by user.
1319 * - decoding: unused.
1321 float rc_min_vbv_overflow_use;
1324 * Number of bits which should be loaded into the rc buffer before decoding starts.
1325 * - encoding: Set by user.
1326 * - decoding: unused
1328 int rc_initial_buffer_occupancy;
1331 * trellis RD quantization
1332 * - encoding: Set by user.
1333 * - decoding: unused
1338 * pass1 encoding statistics output buffer
1339 * - encoding: Set by libavcodec.
1340 * - decoding: unused
1345 * pass2 encoding statistics input buffer
1346 * Concatenated stuff from stats_out of pass1 should be placed here.
1347 * - encoding: Allocated/set/freed by user.
1348 * - decoding: unused
1353 * Work around bugs in encoders which sometimes cannot be detected automatically.
1354 * - encoding: Set by user
1355 * - decoding: Set by user
1357 int workaround_bugs;
1358 #define FF_BUG_AUTODETECT 1 ///< autodetection
1359 #define FF_BUG_XVID_ILACE 4
1360 #define FF_BUG_UMP4 8
1361 #define FF_BUG_NO_PADDING 16
1362 #define FF_BUG_AMV 32
1363 #define FF_BUG_QPEL_CHROMA 64
1364 #define FF_BUG_STD_QPEL 128
1365 #define FF_BUG_QPEL_CHROMA2 256
1366 #define FF_BUG_DIRECT_BLOCKSIZE 512
1367 #define FF_BUG_EDGE 1024
1368 #define FF_BUG_HPEL_CHROMA 2048
1369 #define FF_BUG_DC_CLIP 4096
1370 #define FF_BUG_MS 8192 ///< Work around various bugs in Microsoft's broken decoders.
1371 #define FF_BUG_TRUNCATED 16384
1372 #define FF_BUG_IEDGE 32768
1375 * strictly follow the standard (MPEG-4, ...).
1376 * - encoding: Set by user.
1377 * - decoding: Set by user.
1378 * Setting this to STRICT or higher means the encoder and decoder will
1379 * generally do stupid things, whereas setting it to unofficial or lower
1380 * will mean the encoder might produce output that is not supported by all
1381 * spec-compliant decoders. Decoders don't differentiate between normal,
1382 * unofficial and experimental (that is, they always try to decode things
1383 * when they can) unless they are explicitly asked to behave stupidly
1384 * (=strictly conform to the specs)
1386 int strict_std_compliance;
1387 #define FF_COMPLIANCE_VERY_STRICT 2 ///< Strictly conform to an older more strict version of the spec or reference software.
1388 #define FF_COMPLIANCE_STRICT 1 ///< Strictly conform to all the things in the spec no matter what consequences.
1389 #define FF_COMPLIANCE_NORMAL 0
1390 #define FF_COMPLIANCE_UNOFFICIAL -1 ///< Allow unofficial extensions
1391 #define FF_COMPLIANCE_EXPERIMENTAL -2 ///< Allow nonstandardized experimental things.
1394 * error concealment flags
1395 * - encoding: unused
1396 * - decoding: Set by user.
1398 int error_concealment;
1399 #define FF_EC_GUESS_MVS 1
1400 #define FF_EC_DEBLOCK 2
1401 #define FF_EC_FAVOR_INTER 256
1405 * - encoding: Set by user.
1406 * - decoding: Set by user.
1409 #define FF_DEBUG_PICT_INFO 1
1410 #define FF_DEBUG_RC 2
1411 #define FF_DEBUG_BITSTREAM 4
1412 #define FF_DEBUG_MB_TYPE 8
1413 #define FF_DEBUG_QP 16
1414 #define FF_DEBUG_DCT_COEFF 0x00000040
1415 #define FF_DEBUG_SKIP 0x00000080
1416 #define FF_DEBUG_STARTCODE 0x00000100
1417 #define FF_DEBUG_ER 0x00000400
1418 #define FF_DEBUG_MMCO 0x00000800
1419 #define FF_DEBUG_BUGS 0x00001000
1420 #define FF_DEBUG_BUFFERS 0x00008000
1421 #define FF_DEBUG_THREADS 0x00010000
1422 #define FF_DEBUG_GREEN_MD 0x00800000
1423 #define FF_DEBUG_NOMC 0x01000000
1426 * Error recognition; may misdetect some more or less valid parts as errors.
1427 * - encoding: Set by user.
1428 * - decoding: Set by user.
1430 int err_recognition;
1433 * Verify checksums embedded in the bitstream (could be of either encoded or
1434 * decoded data, depending on the codec) and print an error message on mismatch.
1435 * If AV_EF_EXPLODE is also set, a mismatching checksum will result in the
1436 * decoder returning an error.
1438 #define AV_EF_CRCCHECK (1<<0)
1439 #define AV_EF_BITSTREAM (1<<1) ///< detect bitstream specification deviations
1440 #define AV_EF_BUFFER (1<<2) ///< detect improper bitstream length
1441 #define AV_EF_EXPLODE (1<<3) ///< abort decoding on minor error detection
1443 #define AV_EF_IGNORE_ERR (1<<15) ///< ignore errors and continue
1444 #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
1445 #define AV_EF_COMPLIANT (1<<17) ///< consider all spec non compliances as errors
1446 #define AV_EF_AGGRESSIVE (1<<18) ///< consider things that a sane encoder should not do as an error
1450 * opaque 64-bit number (generally a PTS) that will be reordered and
1451 * output in AVFrame.reordered_opaque
1452 * - encoding: Set by libavcodec to the reordered_opaque of the input
1453 * frame corresponding to the last returned packet. Only
1454 * supported by encoders with the
1455 * AV_CODEC_CAP_ENCODER_REORDERED_OPAQUE capability.
1456 * - decoding: Set by user.
1458 int64_t reordered_opaque;
1461 * Hardware accelerator in use
1462 * - encoding: unused.
1463 * - decoding: Set by libavcodec
1465 const struct AVHWAccel *hwaccel;
1468 * Hardware accelerator context.
1469 * For some hardware accelerators, a global context needs to be
1470 * provided by the user. In that case, this holds display-dependent
1471 * data FFmpeg cannot instantiate itself. Please refer to the
1472 * FFmpeg HW accelerator documentation to know how to fill this.
1473 * - encoding: unused
1474 * - decoding: Set by user
1476 void *hwaccel_context;
1480 * - encoding: Set by libavcodec if flags & AV_CODEC_FLAG_PSNR.
1481 * - decoding: unused
1483 uint64_t error[AV_NUM_DATA_POINTERS];
1486 * DCT algorithm, see FF_DCT_* below
1487 * - encoding: Set by user.
1488 * - decoding: unused
1491 #define FF_DCT_AUTO 0
1492 #define FF_DCT_FASTINT 1
1493 #define FF_DCT_INT 2
1494 #define FF_DCT_MMX 3
1495 #define FF_DCT_ALTIVEC 5
1496 #define FF_DCT_FAAN 6
1499 * IDCT algorithm, see FF_IDCT_* below.
1500 * - encoding: Set by user.
1501 * - decoding: Set by user.
1504 #define FF_IDCT_AUTO 0
1505 #define FF_IDCT_INT 1
1506 #define FF_IDCT_SIMPLE 2
1507 #define FF_IDCT_SIMPLEMMX 3
1508 #define FF_IDCT_ARM 7
1509 #define FF_IDCT_ALTIVEC 8
1510 #define FF_IDCT_SIMPLEARM 10
1511 #define FF_IDCT_XVID 14
1512 #define FF_IDCT_SIMPLEARMV5TE 16
1513 #define FF_IDCT_SIMPLEARMV6 17
1514 #define FF_IDCT_FAAN 20
1515 #define FF_IDCT_SIMPLENEON 22
1516 #define FF_IDCT_NONE 24 /* Used by XvMC to extract IDCT coefficients with FF_IDCT_PERM_NONE */
1517 #define FF_IDCT_SIMPLEAUTO 128
1520 * bits per sample/pixel from the demuxer (needed for huffyuv).
1521 * - encoding: Set by libavcodec.
1522 * - decoding: Set by user.
1524 int bits_per_coded_sample;
1527 * Bits per sample/pixel of internal libavcodec pixel/sample format.
1528 * - encoding: set by user.
1529 * - decoding: set by libavcodec.
1531 int bits_per_raw_sample;
1534 * low resolution decoding, 1-> 1/2 size, 2->1/4 size
1535 * - encoding: unused
1536 * - decoding: Set by user.
1542 * is used to decide how many independent tasks should be passed to execute()
1543 * - encoding: Set by user.
1544 * - decoding: Set by user.
1549 * Which multithreading methods to use.
1550 * Use of FF_THREAD_FRAME will increase decoding delay by one frame per thread,
1551 * so clients which cannot provide future frames should not use it.
1553 * - encoding: Set by user, otherwise the default is used.
1554 * - decoding: Set by user, otherwise the default is used.
1557 #define FF_THREAD_FRAME 1 ///< Decode more than one frame at once
1558 #define FF_THREAD_SLICE 2 ///< Decode more than one part of a single frame at once
1561 * Which multithreading methods are in use by the codec.
1562 * - encoding: Set by libavcodec.
1563 * - decoding: Set by libavcodec.
1565 int active_thread_type;
1567 #if FF_API_THREAD_SAFE_CALLBACKS
1569 * Set by the client if its custom get_buffer() callback can be called
1570 * synchronously from another thread, which allows faster multithreaded decoding.
1571 * draw_horiz_band() will be called from other threads regardless of this setting.
1572 * Ignored if the default get_buffer() is used.
1573 * - encoding: Set by user.
1574 * - decoding: Set by user.
1576 * @deprecated the custom get_buffer2() callback should always be
1577 * thread-safe. Thread-unsafe get_buffer2() implementations will be
1578 * invalid starting with LIBAVCODEC_VERSION_MAJOR=60; in other words,
1579 * libavcodec will behave as if this field was always set to 1.
1580 * Callers that want to be forward compatible with future libavcodec
1581 * versions should wrap access to this field in
1582 * #if LIBAVCODEC_VERSION_MAJOR < 60
1584 attribute_deprecated
1585 int thread_safe_callbacks;
1589 * The codec may call this to execute several independent things.
1590 * It will return only after finishing all tasks.
1591 * The user may replace this with some multithreaded implementation,
1592 * the default implementation will execute the parts serially.
1593 * @param count the number of things to execute
1594 * - encoding: Set by libavcodec, user can override.
1595 * - decoding: Set by libavcodec, user can override.
1597 int (*execute)(struct AVCodecContext *c, int (*func)(struct AVCodecContext *c2, void *arg), void *arg2, int *ret, int count, int size);
1600 * The codec may call this to execute several independent things.
1601 * It will return only after finishing all tasks.
1602 * The user may replace this with some multithreaded implementation,
1603 * the default implementation will execute the parts serially.
1604 * Also see avcodec_thread_init and e.g. the --enable-pthread configure option.
1605 * @param c context passed also to func
1606 * @param count the number of things to execute
1607 * @param arg2 argument passed unchanged to func
1608 * @param ret return values of executed functions, must have space for "count" values. May be NULL.
1609 * @param func function that will be called count times, with jobnr from 0 to count-1.
1610 * threadnr will be in the range 0 to c->thread_count-1 < MAX_THREADS and so that no
1611 * two instances of func executing at the same time will have the same threadnr.
1612 * @return always 0 currently, but code should handle a future improvement where when any call to func
1613 * returns < 0 no further calls to func may be done and < 0 is returned.
1614 * - encoding: Set by libavcodec, user can override.
1615 * - decoding: Set by libavcodec, user can override.
1617 int (*execute2)(struct AVCodecContext *c, int (*func)(struct AVCodecContext *c2, void *arg, int jobnr, int threadnr), void *arg2, int *ret, int count);
1620 * noise vs. sse weight for the nsse comparison function
1621 * - encoding: Set by user.
1622 * - decoding: unused
1628 * - encoding: Set by user.
1629 * - decoding: Set by libavcodec.
1632 #define FF_PROFILE_UNKNOWN -99
1633 #define FF_PROFILE_RESERVED -100
1635 #define FF_PROFILE_AAC_MAIN 0
1636 #define FF_PROFILE_AAC_LOW 1
1637 #define FF_PROFILE_AAC_SSR 2
1638 #define FF_PROFILE_AAC_LTP 3
1639 #define FF_PROFILE_AAC_HE 4
1640 #define FF_PROFILE_AAC_HE_V2 28
1641 #define FF_PROFILE_AAC_LD 22
1642 #define FF_PROFILE_AAC_ELD 38
1643 #define FF_PROFILE_MPEG2_AAC_LOW 128
1644 #define FF_PROFILE_MPEG2_AAC_HE 131
1646 #define FF_PROFILE_DNXHD 0
1647 #define FF_PROFILE_DNXHR_LB 1
1648 #define FF_PROFILE_DNXHR_SQ 2
1649 #define FF_PROFILE_DNXHR_HQ 3
1650 #define FF_PROFILE_DNXHR_HQX 4
1651 #define FF_PROFILE_DNXHR_444 5
1653 #define FF_PROFILE_DTS 20
1654 #define FF_PROFILE_DTS_ES 30
1655 #define FF_PROFILE_DTS_96_24 40
1656 #define FF_PROFILE_DTS_HD_HRA 50
1657 #define FF_PROFILE_DTS_HD_MA 60
1658 #define FF_PROFILE_DTS_EXPRESS 70
1660 #define FF_PROFILE_MPEG2_422 0
1661 #define FF_PROFILE_MPEG2_HIGH 1
1662 #define FF_PROFILE_MPEG2_SS 2
1663 #define FF_PROFILE_MPEG2_SNR_SCALABLE 3
1664 #define FF_PROFILE_MPEG2_MAIN 4
1665 #define FF_PROFILE_MPEG2_SIMPLE 5
1667 #define FF_PROFILE_H264_CONSTRAINED (1<<9) // 8+1; constraint_set1_flag
1668 #define FF_PROFILE_H264_INTRA (1<<11) // 8+3; constraint_set3_flag
1670 #define FF_PROFILE_H264_BASELINE 66
1671 #define FF_PROFILE_H264_CONSTRAINED_BASELINE (66|FF_PROFILE_H264_CONSTRAINED)
1672 #define FF_PROFILE_H264_MAIN 77
1673 #define FF_PROFILE_H264_EXTENDED 88
1674 #define FF_PROFILE_H264_HIGH 100
1675 #define FF_PROFILE_H264_HIGH_10 110
1676 #define FF_PROFILE_H264_HIGH_10_INTRA (110|FF_PROFILE_H264_INTRA)
1677 #define FF_PROFILE_H264_MULTIVIEW_HIGH 118
1678 #define FF_PROFILE_H264_HIGH_422 122
1679 #define FF_PROFILE_H264_HIGH_422_INTRA (122|FF_PROFILE_H264_INTRA)
1680 #define FF_PROFILE_H264_STEREO_HIGH 128
1681 #define FF_PROFILE_H264_HIGH_444 144
1682 #define FF_PROFILE_H264_HIGH_444_PREDICTIVE 244
1683 #define FF_PROFILE_H264_HIGH_444_INTRA (244|FF_PROFILE_H264_INTRA)
1684 #define FF_PROFILE_H264_CAVLC_444 44
1686 #define FF_PROFILE_VC1_SIMPLE 0
1687 #define FF_PROFILE_VC1_MAIN 1
1688 #define FF_PROFILE_VC1_COMPLEX 2
1689 #define FF_PROFILE_VC1_ADVANCED 3
1691 #define FF_PROFILE_MPEG4_SIMPLE 0
1692 #define FF_PROFILE_MPEG4_SIMPLE_SCALABLE 1
1693 #define FF_PROFILE_MPEG4_CORE 2
1694 #define FF_PROFILE_MPEG4_MAIN 3
1695 #define FF_PROFILE_MPEG4_N_BIT 4
1696 #define FF_PROFILE_MPEG4_SCALABLE_TEXTURE 5
1697 #define FF_PROFILE_MPEG4_SIMPLE_FACE_ANIMATION 6
1698 #define FF_PROFILE_MPEG4_BASIC_ANIMATED_TEXTURE 7
1699 #define FF_PROFILE_MPEG4_HYBRID 8
1700 #define FF_PROFILE_MPEG4_ADVANCED_REAL_TIME 9
1701 #define FF_PROFILE_MPEG4_CORE_SCALABLE 10
1702 #define FF_PROFILE_MPEG4_ADVANCED_CODING 11
1703 #define FF_PROFILE_MPEG4_ADVANCED_CORE 12
1704 #define FF_PROFILE_MPEG4_ADVANCED_SCALABLE_TEXTURE 13
1705 #define FF_PROFILE_MPEG4_SIMPLE_STUDIO 14
1706 #define FF_PROFILE_MPEG4_ADVANCED_SIMPLE 15
1708 #define FF_PROFILE_JPEG2000_CSTREAM_RESTRICTION_0 1
1709 #define FF_PROFILE_JPEG2000_CSTREAM_RESTRICTION_1 2
1710 #define FF_PROFILE_JPEG2000_CSTREAM_NO_RESTRICTION 32768
1711 #define FF_PROFILE_JPEG2000_DCINEMA_2K 3
1712 #define FF_PROFILE_JPEG2000_DCINEMA_4K 4
1714 #define FF_PROFILE_VP9_0 0
1715 #define FF_PROFILE_VP9_1 1
1716 #define FF_PROFILE_VP9_2 2
1717 #define FF_PROFILE_VP9_3 3
1719 #define FF_PROFILE_HEVC_MAIN 1
1720 #define FF_PROFILE_HEVC_MAIN_10 2
1721 #define FF_PROFILE_HEVC_MAIN_STILL_PICTURE 3
1722 #define FF_PROFILE_HEVC_REXT 4
1724 #define FF_PROFILE_VVC_MAIN_10 1
1725 #define FF_PROFILE_VVC_MAIN_10_444 33
1727 #define FF_PROFILE_AV1_MAIN 0
1728 #define FF_PROFILE_AV1_HIGH 1
1729 #define FF_PROFILE_AV1_PROFESSIONAL 2
1731 #define FF_PROFILE_MJPEG_HUFFMAN_BASELINE_DCT 0xc0
1732 #define FF_PROFILE_MJPEG_HUFFMAN_EXTENDED_SEQUENTIAL_DCT 0xc1
1733 #define FF_PROFILE_MJPEG_HUFFMAN_PROGRESSIVE_DCT 0xc2
1734 #define FF_PROFILE_MJPEG_HUFFMAN_LOSSLESS 0xc3
1735 #define FF_PROFILE_MJPEG_JPEG_LS 0xf7
1737 #define FF_PROFILE_SBC_MSBC 1
1739 #define FF_PROFILE_PRORES_PROXY 0
1740 #define FF_PROFILE_PRORES_LT 1
1741 #define FF_PROFILE_PRORES_STANDARD 2
1742 #define FF_PROFILE_PRORES_HQ 3
1743 #define FF_PROFILE_PRORES_4444 4
1744 #define FF_PROFILE_PRORES_XQ 5
1746 #define FF_PROFILE_ARIB_PROFILE_A 0
1747 #define FF_PROFILE_ARIB_PROFILE_C 1
1749 #define FF_PROFILE_KLVA_SYNC 0
1750 #define FF_PROFILE_KLVA_ASYNC 1
1754 * - encoding: Set by user.
1755 * - decoding: Set by libavcodec.
1758 #define FF_LEVEL_UNKNOWN -99
1761 * Skip loop filtering for selected frames.
1762 * - encoding: unused
1763 * - decoding: Set by user.
1765 enum AVDiscard skip_loop_filter;
1768 * Skip IDCT/dequantization for selected frames.
1769 * - encoding: unused
1770 * - decoding: Set by user.
1772 enum AVDiscard skip_idct;
1775 * Skip decoding for selected frames.
1776 * - encoding: unused
1777 * - decoding: Set by user.
1779 enum AVDiscard skip_frame;
1782 * Header containing style information for text subtitles.
1783 * For SUBTITLE_ASS subtitle type, it should contain the whole ASS
1784 * [Script Info] and [V4+ Styles] section, plus the [Events] line and
1785 * the Format line following. It shouldn't include any Dialogue line.
1786 * - encoding: Set/allocated/freed by user (before avcodec_open2())
1787 * - decoding: Set/allocated/freed by libavcodec (by avcodec_open2())
1789 uint8_t *subtitle_header;
1790 int subtitle_header_size;
1793 * Audio only. The number of "priming" samples (padding) inserted by the
1794 * encoder at the beginning of the audio. I.e. this number of leading
1795 * decoded samples must be discarded by the caller to get the original audio
1796 * without leading padding.
1798 * - decoding: unused
1799 * - encoding: Set by libavcodec. The timestamps on the output packets are
1800 * adjusted by the encoder so that they always refer to the
1801 * first sample of the data actually contained in the packet,
1802 * including any added padding. E.g. if the timebase is
1803 * 1/samplerate and the timestamp of the first input sample is
1804 * 0, the timestamp of the first output packet will be
1807 int initial_padding;
1810 * - decoding: For codecs that store a framerate value in the compressed
1811 * bitstream, the decoder may export it here. { 0, 1} when
1813 * - encoding: May be used to signal the framerate of CFR content to an
1816 AVRational framerate;
1819 * Nominal unaccelerated pixel format, see AV_PIX_FMT_xxx.
1820 * - encoding: unused.
1821 * - decoding: Set by libavcodec before calling get_format()
1823 enum AVPixelFormat sw_pix_fmt;
1826 * Timebase in which pkt_dts/pts and AVPacket.dts/pts are.
1827 * - encoding unused.
1828 * - decoding set by user.
1830 AVRational pkt_timebase;
1834 * - encoding: unused.
1835 * - decoding: set by libavcodec.
1837 const AVCodecDescriptor *codec_descriptor;
1840 * Current statistics for PTS correction.
1841 * - decoding: maintained and used by libavcodec, not intended to be used by user apps
1842 * - encoding: unused
1844 int64_t pts_correction_num_faulty_pts; /// Number of incorrect PTS values so far
1845 int64_t pts_correction_num_faulty_dts; /// Number of incorrect DTS values so far
1846 int64_t pts_correction_last_pts; /// PTS of the last frame
1847 int64_t pts_correction_last_dts; /// DTS of the last frame
1850 * Character encoding of the input subtitles file.
1851 * - decoding: set by user
1852 * - encoding: unused
1857 * Subtitles character encoding mode. Formats or codecs might be adjusting
1858 * this setting (if they are doing the conversion themselves for instance).
1859 * - decoding: set by libavcodec
1860 * - encoding: unused
1862 int sub_charenc_mode;
1863 #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)
1864 #define FF_SUB_CHARENC_MODE_AUTOMATIC 0 ///< libavcodec will select the mode itself
1865 #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
1866 #define FF_SUB_CHARENC_MODE_IGNORE 2 ///< neither convert the subtitles, nor check them for valid UTF-8
1869 * Skip processing alpha if supported by codec.
1870 * Note that if the format uses pre-multiplied alpha (common with VP6,
1871 * and recommended due to better video quality/compression)
1872 * the image will look as if alpha-blended onto a black background.
1873 * However for formats that do not use pre-multiplied alpha
1874 * there might be serious artefacts (though e.g. libswscale currently
1875 * assumes pre-multiplied alpha anyway).
1877 * - decoding: set by user
1878 * - encoding: unused
1883 * Number of samples to skip after a discontinuity
1884 * - decoding: unused
1885 * - encoding: set by libavcodec
1891 * @deprecated unused
1893 attribute_deprecated
1895 #define FF_DEBUG_VIS_MV_P_FOR 0x00000001 //visualize forward predicted MVs of P frames
1896 #define FF_DEBUG_VIS_MV_B_FOR 0x00000002 //visualize forward predicted MVs of B frames
1897 #define FF_DEBUG_VIS_MV_B_BACK 0x00000004 //visualize backward predicted MVs of B frames
1901 * custom intra quantization matrix
1902 * - encoding: Set by user, can be NULL.
1903 * - decoding: unused.
1905 uint16_t *chroma_intra_matrix;
1908 * dump format separator.
1909 * can be ", " or "\n " or anything else
1910 * - encoding: Set by user.
1911 * - decoding: Set by user.
1913 uint8_t *dump_separator;
1916 * ',' separated list of allowed decoders.
1917 * If NULL then all are allowed
1918 * - encoding: unused
1919 * - decoding: set by user
1921 char *codec_whitelist;
1924 * Properties of the stream that gets decoded
1925 * - encoding: unused
1926 * - decoding: set by libavcodec
1928 unsigned properties;
1929 #define FF_CODEC_PROPERTY_LOSSLESS 0x00000001
1930 #define FF_CODEC_PROPERTY_CLOSED_CAPTIONS 0x00000002
1933 * Additional data associated with the entire coded stream.
1935 * - decoding: unused
1936 * - encoding: may be set by libavcodec after avcodec_open2().
1938 AVPacketSideData *coded_side_data;
1939 int nb_coded_side_data;
1942 * A reference to the AVHWFramesContext describing the input (for encoding)
1943 * or output (decoding) frames. The reference is set by the caller and
1944 * afterwards owned (and freed) by libavcodec - it should never be read by
1945 * the caller after being set.
1947 * - decoding: This field should be set by the caller from the get_format()
1948 * callback. The previous reference (if any) will always be
1949 * unreffed by libavcodec before the get_format() call.
1951 * If the default get_buffer2() is used with a hwaccel pixel
1952 * format, then this AVHWFramesContext will be used for
1953 * allocating the frame buffers.
1955 * - encoding: For hardware encoders configured to use a hwaccel pixel
1956 * format, this field should be set by the caller to a reference
1957 * to the AVHWFramesContext describing input frames.
1958 * AVHWFramesContext.format must be equal to
1959 * AVCodecContext.pix_fmt.
1961 * This field should be set before avcodec_open2() is called.
1963 AVBufferRef *hw_frames_ctx;
1966 * Control the form of AVSubtitle.rects[N]->ass
1967 * - decoding: set by user
1968 * - encoding: unused
1970 int sub_text_format;
1971 #define FF_SUB_TEXT_FMT_ASS 0
1974 * Audio only. The amount of padding (in samples) appended by the encoder to
1975 * the end of the audio. I.e. this number of decoded samples must be
1976 * discarded by the caller from the end of the stream to get the original
1977 * audio without any trailing padding.
1979 * - decoding: unused
1980 * - encoding: unused
1982 int trailing_padding;
1985 * The number of pixels per image to maximally accept.
1987 * - decoding: set by user
1988 * - encoding: set by user
1993 * A reference to the AVHWDeviceContext describing the device which will
1994 * be used by a hardware encoder/decoder. The reference is set by the
1995 * caller and afterwards owned (and freed) by libavcodec.
1997 * This should be used if either the codec device does not require
1998 * hardware frames or any that are used are to be allocated internally by
1999 * libavcodec. If the user wishes to supply any of the frames used as
2000 * encoder input or decoder output then hw_frames_ctx should be used
2001 * instead. When hw_frames_ctx is set in get_format() for a decoder, this
2002 * field will be ignored while decoding the associated stream segment, but
2003 * may again be used on a following one after another get_format() call.
2005 * For both encoders and decoders this field should be set before
2006 * avcodec_open2() is called and must not be written to thereafter.
2008 * Note that some decoders may require this field to be set initially in
2009 * order to support hw_frames_ctx at all - in that case, all frames
2010 * contexts used must be created on the same device.
2012 AVBufferRef *hw_device_ctx;
2015 * Bit set of AV_HWACCEL_FLAG_* flags, which affect hardware accelerated
2016 * decoding (if active).
2017 * - encoding: unused
2018 * - decoding: Set by user (either before avcodec_open2(), or in the
2019 * AVCodecContext.get_format callback)
2024 * Video decoding only. Certain video codecs support cropping, meaning that
2025 * only a sub-rectangle of the decoded frame is intended for display. This
2026 * option controls how cropping is handled by libavcodec.
2028 * When set to 1 (the default), libavcodec will apply cropping internally.
2029 * I.e. it will modify the output frame width/height fields and offset the
2030 * data pointers (only by as much as possible while preserving alignment, or
2031 * by the full amount if the AV_CODEC_FLAG_UNALIGNED flag is set) so that
2032 * the frames output by the decoder refer only to the cropped area. The
2033 * crop_* fields of the output frames will be zero.
2035 * When set to 0, the width/height fields of the output frames will be set
2036 * to the coded dimensions and the crop_* fields will describe the cropping
2037 * rectangle. Applying the cropping is left to the caller.
2039 * @warning When hardware acceleration with opaque output frames is used,
2040 * libavcodec is unable to apply cropping from the top/left border.
2042 * @note when this option is set to zero, the width/height fields of the
2043 * AVCodecContext and output AVFrames have different meanings. The codec
2044 * context fields store display dimensions (with the coded dimensions in
2045 * coded_width/height), while the frame fields store the coded dimensions
2046 * (with the display dimensions being determined by the crop_* fields).
2051 * Video decoding only. Sets the number of extra hardware frames which
2052 * the decoder will allocate for use by the caller. This must be set
2053 * before avcodec_open2() is called.
2055 * Some hardware decoders require all frames that they will use for
2056 * output to be defined in advance before decoding starts. For such
2057 * decoders, the hardware frame pool must therefore be of a fixed size.
2058 * The extra frames set here are on top of any number that the decoder
2059 * needs internally in order to operate normally (for example, frames
2060 * used as reference pictures).
2062 int extra_hw_frames;
2065 * The percentage of damaged samples to discard a frame.
2067 * - decoding: set by user
2068 * - encoding: unused
2070 int discard_damaged_percentage;
2073 * The number of samples per frame to maximally accept.
2075 * - decoding: set by user
2076 * - encoding: set by user
2078 int64_t max_samples;
2081 * Bit set of AV_CODEC_EXPORT_DATA_* flags, which affects the kind of
2082 * metadata exported in frame, packet, or coded stream side data by
2083 * decoders and encoders.
2085 * - decoding: set by user
2086 * - encoding: set by user
2088 int export_side_data;
2091 * This callback is called at the beginning of each packet to get a data
2094 * The following field will be set in the packet before this callback is
2097 * This callback must use the above value to calculate the required buffer size,
2098 * which must padded by at least AV_INPUT_BUFFER_PADDING_SIZE bytes.
2100 * This callback must fill the following fields in the packet:
2101 * - data: alignment requirements for AVPacket apply, if any. Some architectures and
2102 * encoders may benefit from having aligned data.
2103 * - buf: must contain a pointer to an AVBufferRef structure. The packet's
2104 * data pointer must be contained in it. See: av_buffer_create(), av_buffer_alloc(),
2105 * and av_buffer_ref().
2107 * If AV_CODEC_CAP_DR1 is not set then get_encode_buffer() must call
2108 * avcodec_default_get_encode_buffer() instead of providing a buffer allocated by
2111 * The flags field may contain a combination of AV_GET_ENCODE_BUFFER_FLAG_ flags.
2112 * They may be used for example to hint what use the buffer may get after being
2114 * Implementations of this callback may ignore flags they don't understand.
2115 * If AV_GET_ENCODE_BUFFER_FLAG_REF is set in flags then the packet may be reused
2116 * (read and/or written to if it is writable) later by libavcodec.
2118 * This callback must be thread-safe, as when frame threading is used, it may
2119 * be called from multiple threads simultaneously.
2121 * @see avcodec_default_get_encode_buffer()
2123 * - encoding: Set by libavcodec, user can override.
2124 * - decoding: unused
2126 int (*get_encode_buffer)(struct AVCodecContext *s, AVPacket *pkt, int flags);
2131 struct MpegEncContext;
2134 * @defgroup lavc_hwaccel AVHWAccel
2136 * @note Nothing in this structure should be accessed by the user. At some
2137 * point in future it will not be externally visible at all.
2141 typedef struct AVHWAccel {
2143 * Name of the hardware accelerated codec.
2144 * The name is globally unique among encoders and among decoders (but an
2145 * encoder and a decoder can share the same name).
2150 * Type of codec implemented by the hardware accelerator.
2152 * See AVMEDIA_TYPE_xxx
2154 enum AVMediaType type;
2157 * Codec implemented by the hardware accelerator.
2159 * See AV_CODEC_ID_xxx
2164 * Supported pixel format.
2166 * Only hardware accelerated formats are supported here.
2168 enum AVPixelFormat pix_fmt;
2171 * Hardware accelerated codec capabilities.
2172 * see AV_HWACCEL_CODEC_CAP_*
2176 /*****************************************************************
2177 * No fields below this line are part of the public API. They
2178 * may not be used outside of libavcodec and can be changed and
2180 * New public fields should be added right above.
2181 *****************************************************************
2185 * Allocate a custom buffer
2187 int (*alloc_frame)(AVCodecContext *avctx, AVFrame *frame);
2190 * Called at the beginning of each frame or field picture.
2192 * Meaningful frame information (codec specific) is guaranteed to
2193 * be parsed at this point. This function is mandatory.
2195 * Note that buf can be NULL along with buf_size set to 0.
2196 * Otherwise, this means the whole frame is available at this point.
2198 * @param avctx the codec context
2199 * @param buf the frame data buffer base
2200 * @param buf_size the size of the frame in bytes
2201 * @return zero if successful, a negative value otherwise
2203 int (*start_frame)(AVCodecContext *avctx, const uint8_t *buf, uint32_t buf_size);
2206 * Callback for parameter data (SPS/PPS/VPS etc).
2208 * Useful for hardware decoders which keep persistent state about the
2209 * video parameters, and need to receive any changes to update that state.
2211 * @param avctx the codec context
2212 * @param type the nal unit type
2213 * @param buf the nal unit data buffer
2214 * @param buf_size the size of the nal unit in bytes
2215 * @return zero if successful, a negative value otherwise
2217 int (*decode_params)(AVCodecContext *avctx, int type, const uint8_t *buf, uint32_t buf_size);
2220 * Callback for each slice.
2222 * Meaningful slice information (codec specific) is guaranteed to
2223 * be parsed at this point. This function is mandatory.
2224 * The only exception is XvMC, that works on MB level.
2226 * @param avctx the codec context
2227 * @param buf the slice data buffer base
2228 * @param buf_size the size of the slice in bytes
2229 * @return zero if successful, a negative value otherwise
2231 int (*decode_slice)(AVCodecContext *avctx, const uint8_t *buf, uint32_t buf_size);
2234 * Called at the end of each frame or field picture.
2236 * The whole picture is parsed at this point and can now be sent
2237 * to the hardware accelerator. This function is mandatory.
2239 * @param avctx the codec context
2240 * @return zero if successful, a negative value otherwise
2242 int (*end_frame)(AVCodecContext *avctx);
2245 * Size of per-frame hardware accelerator private data.
2247 * Private data is allocated with av_mallocz() before
2248 * AVCodecContext.get_buffer() and deallocated after
2249 * AVCodecContext.release_buffer().
2251 int frame_priv_data_size;
2254 * Called for every Macroblock in a slice.
2256 * XvMC uses it to replace the ff_mpv_reconstruct_mb().
2257 * Instead of decoding to raw picture, MB parameters are
2258 * stored in an array provided by the video driver.
2260 * @param s the mpeg context
2262 void (*decode_mb)(struct MpegEncContext *s);
2265 * Initialize the hwaccel private data.
2267 * This will be called from ff_get_format(), after hwaccel and
2268 * hwaccel_context are set and the hwaccel private data in AVCodecInternal
2271 int (*init)(AVCodecContext *avctx);
2274 * Uninitialize the hwaccel private data.
2276 * This will be called from get_format() or avcodec_close(), after hwaccel
2277 * and hwaccel_context are already uninitialized.
2279 int (*uninit)(AVCodecContext *avctx);
2282 * Size of the private data to allocate in
2283 * AVCodecInternal.hwaccel_priv_data.
2288 * Internal hwaccel capabilities.
2293 * Fill the given hw_frames context with current codec parameters. Called
2294 * from get_format. Refer to avcodec_get_hw_frames_parameters() for
2297 * This CAN be called before AVHWAccel.init is called, and you must assume
2298 * that avctx->hwaccel_priv_data is invalid.
2300 int (*frame_params)(AVCodecContext *avctx, AVBufferRef *hw_frames_ctx);
2304 * HWAccel is experimental and is thus avoided in favor of non experimental
2307 #define AV_HWACCEL_CODEC_CAP_EXPERIMENTAL 0x0200
2310 * Hardware acceleration should be used for decoding even if the codec level
2311 * used is unknown or higher than the maximum supported level reported by the
2314 * It's generally a good idea to pass this flag unless you have a specific
2315 * reason not to, as hardware tends to under-report supported levels.
2317 #define AV_HWACCEL_FLAG_IGNORE_LEVEL (1 << 0)
2320 * Hardware acceleration can output YUV pixel formats with a different chroma
2321 * sampling than 4:2:0 and/or other than 8 bits per component.
2323 #define AV_HWACCEL_FLAG_ALLOW_HIGH_DEPTH (1 << 1)
2326 * Hardware acceleration should still be attempted for decoding when the
2327 * codec profile does not match the reported capabilities of the hardware.
2329 * For example, this can be used to try to decode baseline profile H.264
2330 * streams in hardware - it will often succeed, because many streams marked
2331 * as baseline profile actually conform to constrained baseline profile.
2333 * @warning If the stream is actually not supported then the behaviour is
2334 * undefined, and may include returning entirely incorrect output
2335 * while indicating success.
2337 #define AV_HWACCEL_FLAG_ALLOW_PROFILE_MISMATCH (1 << 2)
2343 enum AVSubtitleType {
2346 SUBTITLE_BITMAP, ///< A bitmap, pict will be set
2349 * Plain text, the text field must be set by the decoder and is
2350 * authoritative. ass and pict fields may contain approximations.
2355 * Formatted text, the ass field must be set by the decoder and is
2356 * authoritative. pict and text fields may contain approximations.
2361 #define AV_SUBTITLE_FLAG_FORCED 0x00000001
2363 typedef struct AVSubtitleRect {
2364 int x; ///< top left corner of pict, undefined when pict is not set
2365 int y; ///< top left corner of pict, undefined when pict is not set
2366 int w; ///< width of pict, undefined when pict is not set
2367 int h; ///< height of pict, undefined when pict is not set
2368 int nb_colors; ///< number of colors in pict, undefined when pict is not set
2371 * data+linesize for the bitmap of this subtitle.
2372 * Can be set for text/ass as well once they are rendered.
2377 enum AVSubtitleType type;
2379 char *text; ///< 0 terminated plain UTF-8 text
2382 * 0 terminated ASS/SSA compatible event line.
2383 * The presentation of this is unaffected by the other values in this
2391 typedef struct AVSubtitle {
2392 uint16_t format; /* 0 = graphics */
2393 uint32_t start_display_time; /* relative to packet pts, in ms */
2394 uint32_t end_display_time; /* relative to packet pts, in ms */
2396 AVSubtitleRect **rects;
2397 int64_t pts; ///< Same as packet pts, in AV_TIME_BASE
2401 * Return the LIBAVCODEC_VERSION_INT constant.
2403 unsigned avcodec_version(void);
2406 * Return the libavcodec build-time configuration.
2408 const char *avcodec_configuration(void);
2411 * Return the libavcodec license.
2413 const char *avcodec_license(void);
2416 * Allocate an AVCodecContext and set its fields to default values. The
2417 * resulting struct should be freed with avcodec_free_context().
2419 * @param codec if non-NULL, allocate private data and initialize defaults
2420 * for the given codec. It is illegal to then call avcodec_open2()
2421 * with a different codec.
2422 * If NULL, then the codec-specific defaults won't be initialized,
2423 * which may result in suboptimal default settings (this is
2424 * important mainly for encoders, e.g. libx264).
2426 * @return An AVCodecContext filled with default values or NULL on failure.
2428 AVCodecContext *avcodec_alloc_context3(const AVCodec *codec);
2431 * Free the codec context and everything associated with it and write NULL to
2432 * the provided pointer.
2434 void avcodec_free_context(AVCodecContext **avctx);
2437 * Get the AVClass for AVCodecContext. It can be used in combination with
2438 * AV_OPT_SEARCH_FAKE_OBJ for examining options.
2440 * @see av_opt_find().
2442 const AVClass *avcodec_get_class(void);
2444 #if FF_API_GET_FRAME_CLASS
2446 * @deprecated This function should not be used.
2448 attribute_deprecated
2449 const AVClass *avcodec_get_frame_class(void);
2453 * Get the AVClass for AVSubtitleRect. It can be used in combination with
2454 * AV_OPT_SEARCH_FAKE_OBJ for examining options.
2456 * @see av_opt_find().
2458 const AVClass *avcodec_get_subtitle_rect_class(void);
2461 * Fill the parameters struct based on the values from the supplied codec
2462 * context. Any allocated fields in par are freed and replaced with duplicates
2463 * of the corresponding fields in codec.
2465 * @return >= 0 on success, a negative AVERROR code on failure
2467 int avcodec_parameters_from_context(AVCodecParameters *par,
2468 const AVCodecContext *codec);
2471 * Fill the codec context based on the values from the supplied codec
2472 * parameters. Any allocated fields in codec that have a corresponding field in
2473 * par are freed and replaced with duplicates of the corresponding field in par.
2474 * Fields in codec that do not have a counterpart in par are not touched.
2476 * @return >= 0 on success, a negative AVERROR code on failure.
2478 int avcodec_parameters_to_context(AVCodecContext *codec,
2479 const AVCodecParameters *par);
2482 * Initialize the AVCodecContext to use the given AVCodec. Prior to using this
2483 * function the context has to be allocated with avcodec_alloc_context3().
2485 * The functions avcodec_find_decoder_by_name(), avcodec_find_encoder_by_name(),
2486 * avcodec_find_decoder() and avcodec_find_encoder() provide an easy way for
2487 * retrieving a codec.
2489 * @warning This function is not thread safe!
2491 * @note Always call this function before using decoding routines (such as
2492 * @ref avcodec_receive_frame()).
2495 * av_dict_set(&opts, "b", "2.5M", 0);
2496 * codec = avcodec_find_decoder(AV_CODEC_ID_H264);
2500 * context = avcodec_alloc_context3(codec);
2502 * if (avcodec_open2(context, codec, opts) < 0)
2506 * @param avctx The context to initialize.
2507 * @param codec The codec to open this context for. If a non-NULL codec has been
2508 * previously passed to avcodec_alloc_context3() or
2509 * for this context, then this parameter MUST be either NULL or
2510 * equal to the previously passed codec.
2511 * @param options A dictionary filled with AVCodecContext and codec-private options.
2512 * On return this object will be filled with options that were not found.
2514 * @return zero on success, a negative value on error
2515 * @see avcodec_alloc_context3(), avcodec_find_decoder(), avcodec_find_encoder(),
2516 * av_dict_set(), av_opt_find().
2518 int avcodec_open2(AVCodecContext *avctx, const AVCodec *codec, AVDictionary **options);
2521 * Close a given AVCodecContext and free all the data associated with it
2522 * (but not the AVCodecContext itself).
2524 * Calling this function on an AVCodecContext that hasn't been opened will free
2525 * the codec-specific data allocated in avcodec_alloc_context3() with a non-NULL
2526 * codec. Subsequent calls will do nothing.
2528 * @note Do not use this function. Use avcodec_free_context() to destroy a
2529 * codec context (either open or closed). Opening and closing a codec context
2530 * multiple times is not supported anymore -- use multiple codec contexts
2533 int avcodec_close(AVCodecContext *avctx);
2536 * Free all allocated data in the given subtitle struct.
2538 * @param sub AVSubtitle to free.
2540 void avsubtitle_free(AVSubtitle *sub);
2547 * @addtogroup lavc_decoding
2552 * The default callback for AVCodecContext.get_buffer2(). It is made public so
2553 * it can be called by custom get_buffer2() implementations for decoders without
2554 * AV_CODEC_CAP_DR1 set.
2556 int avcodec_default_get_buffer2(AVCodecContext *s, AVFrame *frame, int flags);
2559 * The default callback for AVCodecContext.get_encode_buffer(). It is made public so
2560 * it can be called by custom get_encode_buffer() implementations for encoders without
2561 * AV_CODEC_CAP_DR1 set.
2563 int avcodec_default_get_encode_buffer(AVCodecContext *s, AVPacket *pkt, int flags);
2566 * Modify width and height values so that they will result in a memory
2567 * buffer that is acceptable for the codec if you do not use any horizontal
2570 * May only be used if a codec with AV_CODEC_CAP_DR1 has been opened.
2572 void avcodec_align_dimensions(AVCodecContext *s, int *width, int *height);
2575 * Modify width and height values so that they will result in a memory
2576 * buffer that is acceptable for the codec if you also ensure that all
2577 * line sizes are a multiple of the respective linesize_align[i].
2579 * May only be used if a codec with AV_CODEC_CAP_DR1 has been opened.
2581 void avcodec_align_dimensions2(AVCodecContext *s, int *width, int *height,
2582 int linesize_align[AV_NUM_DATA_POINTERS]);
2585 * Converts AVChromaLocation to swscale x/y chroma position.
2587 * The positions represent the chroma (0,0) position in a coordinates system
2588 * with luma (0,0) representing the origin and luma(1,1) representing 256,256
2590 * @param xpos horizontal chroma sample position
2591 * @param ypos vertical chroma sample position
2593 int avcodec_enum_to_chroma_pos(int *xpos, int *ypos, enum AVChromaLocation pos);
2596 * Converts swscale x/y chroma position to AVChromaLocation.
2598 * The positions represent the chroma (0,0) position in a coordinates system
2599 * with luma (0,0) representing the origin and luma(1,1) representing 256,256
2601 * @param xpos horizontal chroma sample position
2602 * @param ypos vertical chroma sample position
2604 enum AVChromaLocation avcodec_chroma_pos_to_enum(int xpos, int ypos);
2607 * Decode a subtitle message.
2608 * Return a negative value on error, otherwise return the number of bytes used.
2609 * If no subtitle could be decompressed, got_sub_ptr is zero.
2610 * Otherwise, the subtitle is stored in *sub.
2611 * Note that AV_CODEC_CAP_DR1 is not available for subtitle codecs. This is for
2612 * simplicity, because the performance difference is expected to be negligible
2613 * and reusing a get_buffer written for video codecs would probably perform badly
2614 * due to a potentially very different allocation pattern.
2616 * Some decoders (those marked with AV_CODEC_CAP_DELAY) have a delay between input
2617 * and output. This means that for some packets they will not immediately
2618 * produce decoded output and need to be flushed at the end of decoding to get
2619 * all the decoded data. Flushing is done by calling this function with packets
2620 * with avpkt->data set to NULL and avpkt->size set to 0 until it stops
2621 * returning subtitles. It is safe to flush even those decoders that are not
2622 * marked with AV_CODEC_CAP_DELAY, then no subtitles will be returned.
2624 * @note The AVCodecContext MUST have been opened with @ref avcodec_open2()
2625 * before packets may be fed to the decoder.
2627 * @param avctx the codec context
2628 * @param[out] sub The preallocated AVSubtitle in which the decoded subtitle will be stored,
2629 * must be freed with avsubtitle_free if *got_sub_ptr is set.
2630 * @param[in,out] got_sub_ptr Zero if no subtitle could be decompressed, otherwise, it is nonzero.
2631 * @param[in] avpkt The input AVPacket containing the input buffer.
2633 int avcodec_decode_subtitle2(AVCodecContext *avctx, AVSubtitle *sub,
2638 * Supply raw packet data as input to a decoder.
2640 * Internally, this call will copy relevant AVCodecContext fields, which can
2641 * influence decoding per-packet, and apply them when the packet is actually
2642 * decoded. (For example AVCodecContext.skip_frame, which might direct the
2643 * decoder to drop the frame contained by the packet sent with this function.)
2645 * @warning The input buffer, avpkt->data must be AV_INPUT_BUFFER_PADDING_SIZE
2646 * larger than the actual read bytes because some optimized bitstream
2647 * readers read 32 or 64 bits at once and could read over the end.
2649 * @note The AVCodecContext MUST have been opened with @ref avcodec_open2()
2650 * before packets may be fed to the decoder.
2652 * @param avctx codec context
2653 * @param[in] avpkt The input AVPacket. Usually, this will be a single video
2654 * frame, or several complete audio frames.
2655 * Ownership of the packet remains with the caller, and the
2656 * decoder will not write to the packet. The decoder may create
2657 * a reference to the packet data (or copy it if the packet is
2658 * not reference-counted).
2659 * Unlike with older APIs, the packet is always fully consumed,
2660 * and if it contains multiple frames (e.g. some audio codecs),
2661 * will require you to call avcodec_receive_frame() multiple
2662 * times afterwards before you can send a new packet.
2663 * It can be NULL (or an AVPacket with data set to NULL and
2664 * size set to 0); in this case, it is considered a flush
2665 * packet, which signals the end of the stream. Sending the
2666 * first flush packet will return success. Subsequent ones are
2667 * unnecessary and will return AVERROR_EOF. If the decoder
2668 * still has frames buffered, it will return them after sending
2671 * @return 0 on success, otherwise negative error code:
2672 * AVERROR(EAGAIN): input is not accepted in the current state - user
2673 * must read output with avcodec_receive_frame() (once
2674 * all output is read, the packet should be resent, and
2675 * the call will not fail with EAGAIN).
2676 * AVERROR_EOF: the decoder has been flushed, and no new packets can
2677 * be sent to it (also returned if more than 1 flush
2679 * AVERROR(EINVAL): codec not opened, it is an encoder, or requires flush
2680 * AVERROR(ENOMEM): failed to add packet to internal queue, or similar
2681 * other errors: legitimate decoding errors
2683 int avcodec_send_packet(AVCodecContext *avctx, const AVPacket *avpkt);
2686 * Return decoded output data from a decoder.
2688 * @param avctx codec context
2689 * @param frame This will be set to a reference-counted video or audio
2690 * frame (depending on the decoder type) allocated by the
2691 * decoder. Note that the function will always call
2692 * av_frame_unref(frame) before doing anything else.
2695 * 0: success, a frame was returned
2696 * AVERROR(EAGAIN): output is not available in this state - user must try
2698 * AVERROR_EOF: the decoder has been fully flushed, and there will be
2699 * no more output frames
2700 * AVERROR(EINVAL): codec not opened, or it is an encoder
2701 * AVERROR_INPUT_CHANGED: current decoded frame has changed parameters
2702 * with respect to first decoded frame. Applicable
2703 * when flag AV_CODEC_FLAG_DROPCHANGED is set.
2704 * other negative values: legitimate decoding errors
2706 int avcodec_receive_frame(AVCodecContext *avctx, AVFrame *frame);
2709 * Supply a raw video or audio frame to the encoder. Use avcodec_receive_packet()
2710 * to retrieve buffered output packets.
2712 * @param avctx codec context
2713 * @param[in] frame AVFrame containing the raw audio or video frame to be encoded.
2714 * Ownership of the frame remains with the caller, and the
2715 * encoder will not write to the frame. The encoder may create
2716 * a reference to the frame data (or copy it if the frame is
2717 * not reference-counted).
2718 * It can be NULL, in which case it is considered a flush
2719 * packet. This signals the end of the stream. If the encoder
2720 * still has packets buffered, it will return them after this
2721 * call. Once flushing mode has been entered, additional flush
2722 * packets are ignored, and sending frames will return
2726 * If AV_CODEC_CAP_VARIABLE_FRAME_SIZE is set, then each frame
2727 * can have any number of samples.
2728 * If it is not set, frame->nb_samples must be equal to
2729 * avctx->frame_size for all frames except the last.
2730 * The final frame may be smaller than avctx->frame_size.
2731 * @return 0 on success, otherwise negative error code:
2732 * AVERROR(EAGAIN): input is not accepted in the current state - user
2733 * must read output with avcodec_receive_packet() (once
2734 * all output is read, the packet should be resent, and
2735 * the call will not fail with EAGAIN).
2736 * AVERROR_EOF: the encoder has been flushed, and no new frames can
2738 * AVERROR(EINVAL): codec not opened, refcounted_frames not set, it is a
2739 * decoder, or requires flush
2740 * AVERROR(ENOMEM): failed to add packet to internal queue, or similar
2741 * other errors: legitimate encoding errors
2743 int avcodec_send_frame(AVCodecContext *avctx, const AVFrame *frame);
2746 * Read encoded data from the encoder.
2748 * @param avctx codec context
2749 * @param avpkt This will be set to a reference-counted packet allocated by the
2750 * encoder. Note that the function will always call
2751 * av_packet_unref(avpkt) before doing anything else.
2752 * @return 0 on success, otherwise negative error code:
2753 * AVERROR(EAGAIN): output is not available in the current state - user
2754 * must try to send input
2755 * AVERROR_EOF: the encoder has been fully flushed, and there will be
2756 * no more output packets
2757 * AVERROR(EINVAL): codec not opened, or it is a decoder
2758 * other errors: legitimate encoding errors
2760 int avcodec_receive_packet(AVCodecContext *avctx, AVPacket *avpkt);
2763 * Create and return a AVHWFramesContext with values adequate for hardware
2764 * decoding. This is meant to get called from the get_format callback, and is
2765 * a helper for preparing a AVHWFramesContext for AVCodecContext.hw_frames_ctx.
2766 * This API is for decoding with certain hardware acceleration modes/APIs only.
2768 * The returned AVHWFramesContext is not initialized. The caller must do this
2769 * with av_hwframe_ctx_init().
2771 * Calling this function is not a requirement, but makes it simpler to avoid
2772 * codec or hardware API specific details when manually allocating frames.
2774 * Alternatively to this, an API user can set AVCodecContext.hw_device_ctx,
2775 * which sets up AVCodecContext.hw_frames_ctx fully automatically, and makes
2776 * it unnecessary to call this function or having to care about
2777 * AVHWFramesContext initialization at all.
2779 * There are a number of requirements for calling this function:
2781 * - It must be called from get_format with the same avctx parameter that was
2782 * passed to get_format. Calling it outside of get_format is not allowed, and
2783 * can trigger undefined behavior.
2784 * - The function is not always supported (see description of return values).
2785 * Even if this function returns successfully, hwaccel initialization could
2786 * fail later. (The degree to which implementations check whether the stream
2787 * is actually supported varies. Some do this check only after the user's
2788 * get_format callback returns.)
2789 * - The hw_pix_fmt must be one of the choices suggested by get_format. If the
2790 * user decides to use a AVHWFramesContext prepared with this API function,
2791 * the user must return the same hw_pix_fmt from get_format.
2792 * - The device_ref passed to this function must support the given hw_pix_fmt.
2793 * - After calling this API function, it is the user's responsibility to
2794 * initialize the AVHWFramesContext (returned by the out_frames_ref parameter),
2795 * and to set AVCodecContext.hw_frames_ctx to it. If done, this must be done
2796 * before returning from get_format (this is implied by the normal
2797 * AVCodecContext.hw_frames_ctx API rules).
2798 * - The AVHWFramesContext parameters may change every time time get_format is
2799 * called. Also, AVCodecContext.hw_frames_ctx is reset before get_format. So
2800 * you are inherently required to go through this process again on every
2802 * - It is perfectly possible to call this function without actually using
2803 * the resulting AVHWFramesContext. One use-case might be trying to reuse a
2804 * previously initialized AVHWFramesContext, and calling this API function
2805 * only to test whether the required frame parameters have changed.
2806 * - Fields that use dynamically allocated values of any kind must not be set
2807 * by the user unless setting them is explicitly allowed by the documentation.
2808 * If the user sets AVHWFramesContext.free and AVHWFramesContext.user_opaque,
2809 * the new free callback must call the potentially set previous free callback.
2810 * This API call may set any dynamically allocated fields, including the free
2813 * The function will set at least the following fields on AVHWFramesContext
2814 * (potentially more, depending on hwaccel API):
2816 * - All fields set by av_hwframe_ctx_alloc().
2817 * - Set the format field to hw_pix_fmt.
2818 * - Set the sw_format field to the most suited and most versatile format. (An
2819 * implication is that this will prefer generic formats over opaque formats
2820 * with arbitrary restrictions, if possible.)
2821 * - Set the width/height fields to the coded frame size, rounded up to the
2822 * API-specific minimum alignment.
2823 * - Only _if_ the hwaccel requires a pre-allocated pool: set the initial_pool_size
2824 * field to the number of maximum reference surfaces possible with the codec,
2825 * plus 1 surface for the user to work (meaning the user can safely reference
2826 * at most 1 decoded surface at a time), plus additional buffering introduced
2827 * by frame threading. If the hwaccel does not require pre-allocation, the
2828 * field is left to 0, and the decoder will allocate new surfaces on demand
2830 * - Possibly AVHWFramesContext.hwctx fields, depending on the underlying
2833 * Essentially, out_frames_ref returns the same as av_hwframe_ctx_alloc(), but
2834 * with basic frame parameters set.
2836 * The function is stateless, and does not change the AVCodecContext or the
2837 * device_ref AVHWDeviceContext.
2839 * @param avctx The context which is currently calling get_format, and which
2840 * implicitly contains all state needed for filling the returned
2841 * AVHWFramesContext properly.
2842 * @param device_ref A reference to the AVHWDeviceContext describing the device
2843 * which will be used by the hardware decoder.
2844 * @param hw_pix_fmt The hwaccel format you are going to return from get_format.
2845 * @param out_frames_ref On success, set to a reference to an _uninitialized_
2846 * AVHWFramesContext, created from the given device_ref.
2847 * Fields will be set to values required for decoding.
2848 * Not changed if an error is returned.
2849 * @return zero on success, a negative value on error. The following error codes
2850 * have special semantics:
2851 * AVERROR(ENOENT): the decoder does not support this functionality. Setup
2852 * is always manual, or it is a decoder which does not
2853 * support setting AVCodecContext.hw_frames_ctx at all,
2854 * or it is a software format.
2855 * AVERROR(EINVAL): it is known that hardware decoding is not supported for
2856 * this configuration, or the device_ref is not supported
2857 * for the hwaccel referenced by hw_pix_fmt.
2859 int avcodec_get_hw_frames_parameters(AVCodecContext *avctx,
2860 AVBufferRef *device_ref,
2861 enum AVPixelFormat hw_pix_fmt,
2862 AVBufferRef **out_frames_ref);
2867 * @defgroup lavc_parsing Frame parsing
2871 enum AVPictureStructure {
2872 AV_PICTURE_STRUCTURE_UNKNOWN, //< unknown
2873 AV_PICTURE_STRUCTURE_TOP_FIELD, //< coded as top field
2874 AV_PICTURE_STRUCTURE_BOTTOM_FIELD, //< coded as bottom field
2875 AV_PICTURE_STRUCTURE_FRAME, //< coded as frame
2878 typedef struct AVCodecParserContext {
2880 struct AVCodecParser *parser;
2881 int64_t frame_offset; /* offset of the current frame */
2882 int64_t cur_offset; /* current offset
2883 (incremented by each av_parser_parse()) */
2884 int64_t next_frame_offset; /* offset of the next frame */
2886 int pict_type; /* XXX: Put it back in AVCodecContext. */
2888 * This field is used for proper frame duration computation in lavf.
2889 * It signals, how much longer the frame duration of the current frame
2890 * is compared to normal frame duration.
2892 * frame_duration = (1 + repeat_pict) * time_base
2894 * It is used by codecs like H.264 to display telecined material.
2896 int repeat_pict; /* XXX: Put it back in AVCodecContext. */
2897 int64_t pts; /* pts of the current frame */
2898 int64_t dts; /* dts of the current frame */
2903 int fetch_timestamp;
2905 #define AV_PARSER_PTS_NB 4
2906 int cur_frame_start_index;
2907 int64_t cur_frame_offset[AV_PARSER_PTS_NB];
2908 int64_t cur_frame_pts[AV_PARSER_PTS_NB];
2909 int64_t cur_frame_dts[AV_PARSER_PTS_NB];
2912 #define PARSER_FLAG_COMPLETE_FRAMES 0x0001
2913 #define PARSER_FLAG_ONCE 0x0002
2914 /// Set if the parser has a valid file offset
2915 #define PARSER_FLAG_FETCHED_OFFSET 0x0004
2916 #define PARSER_FLAG_USE_CODEC_TS 0x1000
2918 int64_t offset; ///< byte offset from starting packet start
2919 int64_t cur_frame_end[AV_PARSER_PTS_NB];
2922 * Set by parser to 1 for key frames and 0 for non-key frames.
2923 * It is initialized to -1, so if the parser doesn't set this flag,
2924 * old-style fallback using AV_PICTURE_TYPE_I picture type as key frames
2929 // Timestamp generation support:
2931 * Synchronization point for start of timestamp generation.
2933 * Set to >0 for sync point, 0 for no sync point and <0 for undefined
2936 * For example, this corresponds to presence of H.264 buffering period
2942 * Offset of the current timestamp against last timestamp sync point in
2943 * units of AVCodecContext.time_base.
2945 * Set to INT_MIN when dts_sync_point unused. Otherwise, it must
2946 * contain a valid timestamp offset.
2948 * Note that the timestamp of sync point has usually a nonzero
2949 * dts_ref_dts_delta, which refers to the previous sync point. Offset of
2950 * the next frame after timestamp sync point will be usually 1.
2952 * For example, this corresponds to H.264 cpb_removal_delay.
2954 int dts_ref_dts_delta;
2957 * Presentation delay of current frame in units of AVCodecContext.time_base.
2959 * Set to INT_MIN when dts_sync_point unused. Otherwise, it must
2960 * contain valid non-negative timestamp delta (presentation time of a frame
2961 * must not lie in the past).
2963 * This delay represents the difference between decoding and presentation
2964 * time of the frame.
2966 * For example, this corresponds to H.264 dpb_output_delay.
2971 * Position of the packet in file.
2973 * Analogous to cur_frame_pts/dts
2975 int64_t cur_frame_pos[AV_PARSER_PTS_NB];
2978 * Byte position of currently parsed frame in stream.
2983 * Previous frame byte position.
2988 * Duration of the current frame.
2989 * For audio, this is in units of 1 / AVCodecContext.sample_rate.
2990 * For all other types, this is in units of AVCodecContext.time_base.
2994 enum AVFieldOrder field_order;
2997 * Indicate whether a picture is coded as a frame, top field or bottom field.
2999 * For example, H.264 field_pic_flag equal to 0 corresponds to
3000 * AV_PICTURE_STRUCTURE_FRAME. An H.264 picture with field_pic_flag
3001 * equal to 1 and bottom_field_flag equal to 0 corresponds to
3002 * AV_PICTURE_STRUCTURE_TOP_FIELD.
3004 enum AVPictureStructure picture_structure;
3007 * Picture number incremented in presentation or output order.
3008 * This field may be reinitialized at the first picture of a new sequence.
3010 * For example, this corresponds to H.264 PicOrderCnt.
3012 int output_picture_number;
3015 * Dimensions of the decoded video intended for presentation.
3021 * Dimensions of the coded video.
3027 * The format of the coded data, corresponds to enum AVPixelFormat for video
3028 * and for enum AVSampleFormat for audio.
3030 * Note that a decoder can have considerable freedom in how exactly it
3031 * decodes the data, so the format reported here might be different from the
3032 * one returned by a decoder.
3035 } AVCodecParserContext;
3037 typedef struct AVCodecParser {
3038 int codec_ids[5]; /* several codec IDs are permitted */
3040 int (*parser_init)(AVCodecParserContext *s);
3041 /* This callback never returns an error, a negative value means that
3042 * the frame start was in a previous packet. */
3043 int (*parser_parse)(AVCodecParserContext *s,
3044 AVCodecContext *avctx,
3045 const uint8_t **poutbuf, int *poutbuf_size,
3046 const uint8_t *buf, int buf_size);
3047 void (*parser_close)(AVCodecParserContext *s);
3048 int (*split)(AVCodecContext *avctx, const uint8_t *buf, int buf_size);
3052 * Iterate over all registered codec parsers.
3054 * @param opaque a pointer where libavcodec will store the iteration state. Must
3055 * point to NULL to start the iteration.
3057 * @return the next registered codec parser or NULL when the iteration is
3060 const AVCodecParser *av_parser_iterate(void **opaque);
3062 AVCodecParserContext *av_parser_init(int codec_id);
3067 * @param s parser context.
3068 * @param avctx codec context.
3069 * @param poutbuf set to pointer to parsed buffer or NULL if not yet finished.
3070 * @param poutbuf_size set to size of parsed buffer or zero if not yet finished.
3071 * @param buf input buffer.
3072 * @param buf_size buffer size in bytes without the padding. I.e. the full buffer
3073 size is assumed to be buf_size + AV_INPUT_BUFFER_PADDING_SIZE.
3074 To signal EOF, this should be 0 (so that the last frame
3076 * @param pts input presentation timestamp.
3077 * @param dts input decoding timestamp.
3078 * @param pos input byte position in stream.
3079 * @return the number of bytes of the input bitstream used.
3084 * len = av_parser_parse2(myparser, AVCodecContext, &data, &size,
3091 * decode_frame(data, size);
3095 int av_parser_parse2(AVCodecParserContext *s,
3096 AVCodecContext *avctx,
3097 uint8_t **poutbuf, int *poutbuf_size,
3098 const uint8_t *buf, int buf_size,
3099 int64_t pts, int64_t dts,
3102 void av_parser_close(AVCodecParserContext *s);
3110 * @addtogroup lavc_encoding
3114 int avcodec_encode_subtitle(AVCodecContext *avctx, uint8_t *buf, int buf_size,
3115 const AVSubtitle *sub);
3123 * @defgroup lavc_misc Utility functions
3126 * Miscellaneous utility functions related to both encoding and decoding
3132 * @defgroup lavc_misc_pixfmt Pixel formats
3134 * Functions for working with pixel formats.
3139 * Return a value representing the fourCC code associated to the
3140 * pixel format pix_fmt, or 0 if no associated fourCC code can be
3143 unsigned int avcodec_pix_fmt_to_codec_tag(enum AVPixelFormat pix_fmt);
3146 * Find the best pixel format to convert to given a certain source pixel
3147 * format. When converting from one pixel format to another, information loss
3148 * may occur. For example, when converting from RGB24 to GRAY, the color
3149 * information will be lost. Similarly, other losses occur when converting from
3150 * some formats to other formats. avcodec_find_best_pix_fmt_of_2() searches which of
3151 * the given pixel formats should be used to suffer the least amount of loss.
3152 * The pixel formats from which it chooses one, are determined by the
3153 * pix_fmt_list parameter.
3156 * @param[in] pix_fmt_list AV_PIX_FMT_NONE terminated array of pixel formats to choose from
3157 * @param[in] src_pix_fmt source pixel format
3158 * @param[in] has_alpha Whether the source pixel format alpha channel is used.
3159 * @param[out] loss_ptr Combination of flags informing you what kind of losses will occur.
3160 * @return The best pixel format to convert to or -1 if none was found.
3162 enum AVPixelFormat avcodec_find_best_pix_fmt_of_list(const enum AVPixelFormat *pix_fmt_list,
3163 enum AVPixelFormat src_pix_fmt,
3164 int has_alpha, int *loss_ptr);
3166 enum AVPixelFormat avcodec_default_get_format(struct AVCodecContext *s, const enum AVPixelFormat * fmt);
3172 void avcodec_string(char *buf, int buf_size, AVCodecContext *enc, int encode);
3175 * Return a name for the specified profile, if available.
3177 * @param codec the codec that is searched for the given profile
3178 * @param profile the profile value for which a name is requested
3179 * @return A name for the profile if found, NULL otherwise.
3181 const char *av_get_profile_name(const AVCodec *codec, int profile);
3184 * Return a name for the specified profile, if available.
3186 * @param codec_id the ID of the codec to which the requested profile belongs
3187 * @param profile the profile value for which a name is requested
3188 * @return A name for the profile if found, NULL otherwise.
3190 * @note unlike av_get_profile_name(), which searches a list of profiles
3191 * supported by a specific decoder or encoder implementation, this
3192 * function searches the list of profiles from the AVCodecDescriptor
3194 const char *avcodec_profile_name(enum AVCodecID codec_id, int profile);
3196 int avcodec_default_execute(AVCodecContext *c, int (*func)(AVCodecContext *c2, void *arg2),void *arg, int *ret, int count, int size);
3197 int avcodec_default_execute2(AVCodecContext *c, int (*func)(AVCodecContext *c2, void *arg2, int, int),void *arg, int *ret, int count);
3198 //FIXME func typedef
3201 * Fill AVFrame audio data and linesize pointers.
3203 * The buffer buf must be a preallocated buffer with a size big enough
3204 * to contain the specified samples amount. The filled AVFrame data
3205 * pointers will point to this buffer.
3207 * AVFrame extended_data channel pointers are allocated if necessary for
3210 * @param frame the AVFrame
3211 * frame->nb_samples must be set prior to calling the
3212 * function. This function fills in frame->data,
3213 * frame->extended_data, frame->linesize[0].
3214 * @param nb_channels channel count
3215 * @param sample_fmt sample format
3216 * @param buf buffer to use for frame data
3217 * @param buf_size size of buffer
3218 * @param align plane size sample alignment (0 = default)
3219 * @return >=0 on success, negative error code on failure
3220 * @todo return the size in bytes required to store the samples in
3221 * case of success, at the next libavutil bump
3223 int avcodec_fill_audio_frame(AVFrame *frame, int nb_channels,
3224 enum AVSampleFormat sample_fmt, const uint8_t *buf,
3225 int buf_size, int align);
3228 * Reset the internal codec state / flush internal buffers. Should be called
3229 * e.g. when seeking or when switching to a different stream.
3231 * @note for decoders, when refcounted frames are not used
3232 * (i.e. avctx->refcounted_frames is 0), this invalidates the frames previously
3233 * returned from the decoder. When refcounted frames are used, the decoder just
3234 * releases any references it might keep internally, but the caller's reference
3237 * @note for encoders, this function will only do something if the encoder
3238 * declares support for AV_CODEC_CAP_ENCODER_FLUSH. When called, the encoder
3239 * will drain any remaining packets, and can then be re-used for a different
3240 * stream (as opposed to sending a null frame which will leave the encoder
3241 * in a permanent EOF state after draining). This can be desirable if the
3242 * cost of tearing down and replacing the encoder instance is high.
3244 void avcodec_flush_buffers(AVCodecContext *avctx);
3247 * Return codec bits per sample.
3249 * @param[in] codec_id the codec
3250 * @return Number of bits per sample or zero if unknown for the given codec.
3252 int av_get_bits_per_sample(enum AVCodecID codec_id);
3255 * Return the PCM codec associated with a sample format.
3256 * @param be endianness, 0 for little, 1 for big,
3257 * -1 (or anything else) for native
3258 * @return AV_CODEC_ID_PCM_* or AV_CODEC_ID_NONE
3260 enum AVCodecID av_get_pcm_codec(enum AVSampleFormat fmt, int be);
3263 * Return codec bits per sample.
3264 * Only return non-zero if the bits per sample is exactly correct, not an
3267 * @param[in] codec_id the codec
3268 * @return Number of bits per sample or zero if unknown for the given codec.
3270 int av_get_exact_bits_per_sample(enum AVCodecID codec_id);
3273 * Return audio frame duration.
3275 * @param avctx codec context
3276 * @param frame_bytes size of the frame, or 0 if unknown
3277 * @return frame duration, in samples, if known. 0 if not able to
3280 int av_get_audio_frame_duration(AVCodecContext *avctx, int frame_bytes);
3283 * This function is the same as av_get_audio_frame_duration(), except it works
3284 * with AVCodecParameters instead of an AVCodecContext.
3286 int av_get_audio_frame_duration2(AVCodecParameters *par, int frame_bytes);
3291 * Same behaviour av_fast_malloc but the buffer has additional
3292 * AV_INPUT_BUFFER_PADDING_SIZE at the end which will always be 0.
3294 * In addition the whole buffer will initially and after resizes
3295 * be 0-initialized so that no uninitialized data will ever appear.
3297 void av_fast_padded_malloc(void *ptr, unsigned int *size, size_t min_size);
3300 * Same behaviour av_fast_padded_malloc except that buffer will always
3301 * be 0-initialized after call.
3303 void av_fast_padded_mallocz(void *ptr, unsigned int *size, size_t min_size);
3306 * Encode extradata length to a buffer. Used by xiph codecs.
3308 * @param s buffer to write to; must be at least (v/255+1) bytes long
3309 * @param v size of extradata in bytes
3310 * @return number of bytes written to the buffer.
3312 unsigned int av_xiphlacing(unsigned char *s, unsigned int v);
3315 * @return a positive value if s is open (i.e. avcodec_open2() was called on it
3316 * with no corresponding avcodec_close()), 0 otherwise.
3318 int avcodec_is_open(AVCodecContext *s);
3321 * Allocate a CPB properties structure and initialize its fields to default
3324 * @param size if non-NULL, the size of the allocated struct will be written
3325 * here. This is useful for embedding it in side data.
3327 * @return the newly allocated struct or NULL on failure
3329 AVCPBProperties *av_cpb_properties_alloc(size_t *size);
3335 #endif /* AVCODEC_AVCODEC_H */