FFmpeg 7.1.1
Loading...
Searching...
No Matches
avcodec.h
Go to the documentation of this file.
1/*
2 * copyright (c) 2001 Fabrice Bellard
3 *
4 * This file is part of FFmpeg.
5 *
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.
10 *
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.
15 *
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
19 */
20
21#ifndef AVCODEC_AVCODEC_H
22#define AVCODEC_AVCODEC_H
23
24/**
25 * @file
26 * @ingroup libavc
27 * Libavcodec external API header
28 */
29
30#include "libavutil/samplefmt.h"
32#include "libavutil/avutil.h"
33#include "libavutil/buffer.h"
35#include "libavutil/dict.h"
36#include "libavutil/frame.h"
37#include "libavutil/log.h"
38#include "libavutil/pixfmt.h"
39#include "libavutil/rational.h"
40
41#include "codec.h"
42#include "codec_id.h"
43#include "defs.h"
44#include "packet.h"
45#include "version_major.h"
46#ifndef HAVE_AV_CONFIG_H
47/* When included as part of the ffmpeg build, only include the major version
48 * to avoid unnecessary rebuilds. When included externally, keep including
49 * the full version information. */
50#include "version.h"
51
52#include "codec_desc.h"
53#include "codec_par.h"
54#endif
55
57
58/**
59 * @defgroup libavc libavcodec
60 * Encoding/Decoding Library
61 *
62 * @{
63 *
64 * @defgroup lavc_decoding Decoding
65 * @{
66 * @}
67 *
68 * @defgroup lavc_encoding Encoding
69 * @{
70 * @}
71 *
72 * @defgroup lavc_codec Codecs
73 * @{
74 * @defgroup lavc_codec_native Native Codecs
75 * @{
76 * @}
77 * @defgroup lavc_codec_wrappers External library wrappers
78 * @{
79 * @}
80 * @defgroup lavc_codec_hwaccel Hardware Accelerators bridge
81 * @{
82 * @}
83 * @}
84 * @defgroup lavc_internal Internal
85 * @{
86 * @}
87 * @}
88 */
89
90/**
91 * @ingroup libavc
92 * @defgroup lavc_encdec send/receive encoding and decoding API overview
93 * @{
94 *
95 * The avcodec_send_packet()/avcodec_receive_frame()/avcodec_send_frame()/
96 * avcodec_receive_packet() functions provide an encode/decode API, which
97 * decouples input and output.
98 *
99 * The API is very similar for encoding/decoding and audio/video, and works as
100 * follows:
101 * - Set up and open the AVCodecContext as usual.
102 * - Send valid input:
103 * - For decoding, call avcodec_send_packet() to give the decoder raw
104 * compressed data in an AVPacket.
105 * - For encoding, call avcodec_send_frame() to give the encoder an AVFrame
106 * containing uncompressed audio or video.
107 *
108 * In both cases, it is recommended that AVPackets and AVFrames are
109 * refcounted, or libavcodec might have to copy the input data. (libavformat
110 * always returns refcounted AVPackets, and av_frame_get_buffer() allocates
111 * refcounted AVFrames.)
112 * - Receive output in a loop. Periodically call one of the avcodec_receive_*()
113 * functions and process their output:
114 * - For decoding, call avcodec_receive_frame(). On success, it will return
115 * an AVFrame containing uncompressed audio or video data.
116 * - For encoding, call avcodec_receive_packet(). On success, it will return
117 * an AVPacket with a compressed frame.
118 *
119 * Repeat this call until it returns AVERROR(EAGAIN) or an error. The
120 * AVERROR(EAGAIN) return value means that new input data is required to
121 * return new output. In this case, continue with sending input. For each
122 * input frame/packet, the codec will typically return 1 output frame/packet,
123 * but it can also be 0 or more than 1.
124 *
125 * At the beginning of decoding or encoding, the codec might accept multiple
126 * input frames/packets without returning a frame, until its internal buffers
127 * are filled. This situation is handled transparently if you follow the steps
128 * outlined above.
129 *
130 * In theory, sending input can result in EAGAIN - this should happen only if
131 * not all output was received. You can use this to structure alternative decode
132 * or encode loops other than the one suggested above. For example, you could
133 * try sending new input on each iteration, and try to receive output if that
134 * returns EAGAIN.
135 *
136 * End of stream situations. These require "flushing" (aka draining) the codec,
137 * as the codec might buffer multiple frames or packets internally for
138 * performance or out of necessity (consider B-frames).
139 * This is handled as follows:
140 * - Instead of valid input, send NULL to the avcodec_send_packet() (decoding)
141 * or avcodec_send_frame() (encoding) functions. This will enter draining
142 * mode.
143 * - Call avcodec_receive_frame() (decoding) or avcodec_receive_packet()
144 * (encoding) in a loop until AVERROR_EOF is returned. The functions will
145 * not return AVERROR(EAGAIN), unless you forgot to enter draining mode.
146 * - Before decoding can be resumed again, the codec has to be reset with
147 * avcodec_flush_buffers().
148 *
149 * Using the API as outlined above is highly recommended. But it is also
150 * possible to call functions outside of this rigid schema. For example, you can
151 * call avcodec_send_packet() repeatedly without calling
152 * avcodec_receive_frame(). In this case, avcodec_send_packet() will succeed
153 * until the codec's internal buffer has been filled up (which is typically of
154 * size 1 per output frame, after initial input), and then reject input with
155 * AVERROR(EAGAIN). Once it starts rejecting input, you have no choice but to
156 * read at least some output.
157 *
158 * Not all codecs will follow a rigid and predictable dataflow; the only
159 * guarantee is that an AVERROR(EAGAIN) return value on a send/receive call on
160 * one end implies that a receive/send call on the other end will succeed, or
161 * at least will not fail with AVERROR(EAGAIN). In general, no codec will
162 * permit unlimited buffering of input or output.
163 *
164 * A codec is not allowed to return AVERROR(EAGAIN) for both sending and receiving. This
165 * would be an invalid state, which could put the codec user into an endless
166 * loop. The API has no concept of time either: it cannot happen that trying to
167 * do avcodec_send_packet() results in AVERROR(EAGAIN), but a repeated call 1 second
168 * later accepts the packet (with no other receive/flush API calls involved).
169 * The API is a strict state machine, and the passage of time is not supposed
170 * to influence it. Some timing-dependent behavior might still be deemed
171 * acceptable in certain cases. But it must never result in both send/receive
172 * returning EAGAIN at the same time at any point. It must also absolutely be
173 * avoided that the current state is "unstable" and can "flip-flop" between
174 * the send/receive APIs allowing progress. For example, it's not allowed that
175 * the codec randomly decides that it actually wants to consume a packet now
176 * instead of returning a frame, after it just returned AVERROR(EAGAIN) on an
177 * avcodec_send_packet() call.
178 * @}
179 */
180
181/**
182 * @defgroup lavc_core Core functions/structures.
183 * @ingroup libavc
184 *
185 * Basic definitions, functions for querying libavcodec capabilities,
186 * allocating core structures, etc.
187 * @{
188 */
189
190#if FF_API_BUFFER_MIN_SIZE
191/**
192 * @ingroup lavc_encoding
193 * minimum encoding buffer size
194 * Used to avoid some checks during header writing.
195 * @deprecated Unused: avcodec_receive_packet() does not work
196 * with preallocated packet buffers.
197 */
198#define AV_INPUT_BUFFER_MIN_SIZE 16384
199#endif
200
201/**
202 * @ingroup lavc_encoding
203 */
204typedef struct RcOverride{
207 int qscale; // If this is 0 then quality_factor will be used instead.
209} RcOverride;
210
211/* encoding support
212 These flags can be passed in AVCodecContext.flags before initialization.
213 Note: Not everything is supported yet.
214*/
215
216/**
217 * Allow decoders to produce frames with data planes that are not aligned
218 * to CPU requirements (e.g. due to cropping).
219 */
220#define AV_CODEC_FLAG_UNALIGNED (1 << 0)
221/**
222 * Use fixed qscale.
223 */
224#define AV_CODEC_FLAG_QSCALE (1 << 1)
225/**
226 * 4 MV per MB allowed / advanced prediction for H.263.
227 */
228#define AV_CODEC_FLAG_4MV (1 << 2)
229/**
230 * Output even those frames that might be corrupted.
231 */
232#define AV_CODEC_FLAG_OUTPUT_CORRUPT (1 << 3)
233/**
234 * Use qpel MC.
235 */
236#define AV_CODEC_FLAG_QPEL (1 << 4)
237#if FF_API_DROPCHANGED
238/**
239 * Don't output frames whose parameters differ from first
240 * decoded frame in stream.
241 *
242 * @deprecated callers should implement this functionality in their own code
243 */
244#define AV_CODEC_FLAG_DROPCHANGED (1 << 5)
245#endif
246/**
247 * Request the encoder to output reconstructed frames, i.e.\ frames that would
248 * be produced by decoding the encoded bistream. These frames may be retrieved
249 * by calling avcodec_receive_frame() immediately after a successful call to
250 * avcodec_receive_packet().
251 *
252 * Should only be used with encoders flagged with the
253 * @ref AV_CODEC_CAP_ENCODER_RECON_FRAME capability.
254 *
255 * @note
256 * Each reconstructed frame returned by the encoder corresponds to the last
257 * encoded packet, i.e. the frames are returned in coded order rather than
258 * presentation order.
259 *
260 * @note
261 * Frame parameters (like pixel format or dimensions) do not have to match the
262 * AVCodecContext values. Make sure to use the values from the returned frame.
263 */
264#define AV_CODEC_FLAG_RECON_FRAME (1 << 6)
265/**
266 * @par decoding
267 * Request the decoder to propagate each packet's AVPacket.opaque and
268 * AVPacket.opaque_ref to its corresponding output AVFrame.
269 *
270 * @par encoding:
271 * Request the encoder to propagate each frame's AVFrame.opaque and
272 * AVFrame.opaque_ref values to its corresponding output AVPacket.
273 *
274 * @par
275 * May only be set on encoders that have the
276 * @ref AV_CODEC_CAP_ENCODER_REORDERED_OPAQUE capability flag.
277 *
278 * @note
279 * While in typical cases one input frame produces exactly one output packet
280 * (perhaps after a delay), in general the mapping of frames to packets is
281 * M-to-N, so
282 * - Any number of input frames may be associated with any given output packet.
283 * This includes zero - e.g. some encoders may output packets that carry only
284 * metadata about the whole stream.
285 * - A given input frame may be associated with any number of output packets.
286 * Again this includes zero - e.g. some encoders may drop frames under certain
287 * conditions.
288 * .
289 * This implies that when using this flag, the caller must NOT assume that
290 * - a given input frame's opaques will necessarily appear on some output packet;
291 * - every output packet will have some non-NULL opaque value.
292 * .
293 * When an output packet contains multiple frames, the opaque values will be
294 * taken from the first of those.
295 *
296 * @note
297 * The converse holds for decoders, with frames and packets switched.
298 */
299#define AV_CODEC_FLAG_COPY_OPAQUE (1 << 7)
300/**
301 * Signal to the encoder that the values of AVFrame.duration are valid and
302 * should be used (typically for transferring them to output packets).
303 *
304 * If this flag is not set, frame durations are ignored.
305 */
306#define AV_CODEC_FLAG_FRAME_DURATION (1 << 8)
307/**
308 * Use internal 2pass ratecontrol in first pass mode.
309 */
310#define AV_CODEC_FLAG_PASS1 (1 << 9)
311/**
312 * Use internal 2pass ratecontrol in second pass mode.
313 */
314#define AV_CODEC_FLAG_PASS2 (1 << 10)
315/**
316 * loop filter.
317 */
318#define AV_CODEC_FLAG_LOOP_FILTER (1 << 11)
319/**
320 * Only decode/encode grayscale.
321 */
322#define AV_CODEC_FLAG_GRAY (1 << 13)
323/**
324 * error[?] variables will be set during encoding.
325 */
326#define AV_CODEC_FLAG_PSNR (1 << 15)
327/**
328 * Use interlaced DCT.
329 */
330#define AV_CODEC_FLAG_INTERLACED_DCT (1 << 18)
331/**
332 * Force low delay.
333 */
334#define AV_CODEC_FLAG_LOW_DELAY (1 << 19)
335/**
336 * Place global headers in extradata instead of every keyframe.
337 */
338#define AV_CODEC_FLAG_GLOBAL_HEADER (1 << 22)
339/**
340 * Use only bitexact stuff (except (I)DCT).
341 */
342#define AV_CODEC_FLAG_BITEXACT (1 << 23)
343/* Fx : Flag for H.263+ extra options */
344/**
345 * H.263 advanced intra coding / MPEG-4 AC prediction
346 */
347#define AV_CODEC_FLAG_AC_PRED (1 << 24)
348/**
349 * interlaced motion estimation
350 */
351#define AV_CODEC_FLAG_INTERLACED_ME (1 << 29)
352#define AV_CODEC_FLAG_CLOSED_GOP (1U << 31)
353
354/**
355 * Allow non spec compliant speedup tricks.
356 */
357#define AV_CODEC_FLAG2_FAST (1 << 0)
358/**
359 * Skip bitstream encoding.
360 */
361#define AV_CODEC_FLAG2_NO_OUTPUT (1 << 2)
362/**
363 * Place global headers at every keyframe instead of in extradata.
364 */
365#define AV_CODEC_FLAG2_LOCAL_HEADER (1 << 3)
366
367/**
368 * Input bitstream might be truncated at a packet boundaries
369 * instead of only at frame boundaries.
370 */
371#define AV_CODEC_FLAG2_CHUNKS (1 << 15)
372/**
373 * Discard cropping information from SPS.
374 */
375#define AV_CODEC_FLAG2_IGNORE_CROP (1 << 16)
376
377/**
378 * Show all frames before the first keyframe
379 */
380#define AV_CODEC_FLAG2_SHOW_ALL (1 << 22)
381/**
382 * Export motion vectors through frame side data
383 */
384#define AV_CODEC_FLAG2_EXPORT_MVS (1 << 28)
385/**
386 * Do not skip samples and export skip information as frame side data
387 */
388#define AV_CODEC_FLAG2_SKIP_MANUAL (1 << 29)
389/**
390 * Do not reset ASS ReadOrder field on flush (subtitles decoding)
391 */
392#define AV_CODEC_FLAG2_RO_FLUSH_NOOP (1 << 30)
393/**
394 * Generate/parse ICC profiles on encode/decode, as appropriate for the type of
395 * file. No effect on codecs which cannot contain embedded ICC profiles, or
396 * when compiled without support for lcms2.
397 */
398#define AV_CODEC_FLAG2_ICC_PROFILES (1U << 31)
399
400/* Exported side data.
401 These flags can be passed in AVCodecContext.export_side_data before initialization.
402*/
403/**
404 * Export motion vectors through frame side data
405 */
406#define AV_CODEC_EXPORT_DATA_MVS (1 << 0)
407/**
408 * Export encoder Producer Reference Time through packet side data
409 */
410#define AV_CODEC_EXPORT_DATA_PRFT (1 << 1)
411/**
412 * Decoding only.
413 * Export the AVVideoEncParams structure through frame side data.
414 */
415#define AV_CODEC_EXPORT_DATA_VIDEO_ENC_PARAMS (1 << 2)
416/**
417 * Decoding only.
418 * Do not apply film grain, export it instead.
419 */
420#define AV_CODEC_EXPORT_DATA_FILM_GRAIN (1 << 3)
421
422/**
423 * Decoding only.
424 * Do not apply picture enhancement layers, export them instead.
425 */
426#define AV_CODEC_EXPORT_DATA_ENHANCEMENTS (1 << 4)
427
428/**
429 * The decoder will keep a reference to the frame and may reuse it later.
430 */
431#define AV_GET_BUFFER_FLAG_REF (1 << 0)
432
433/**
434 * The encoder will keep a reference to the packet and may reuse it later.
435 */
436#define AV_GET_ENCODE_BUFFER_FLAG_REF (1 << 0)
437
438/**
439 * main external API structure.
440 * New fields can be added to the end with minor version bumps.
441 * Removal, reordering and changes to existing fields require a major
442 * version bump.
443 * You can use AVOptions (av_opt* / av_set/get*()) to access these fields from user
444 * applications.
445 * The name string for AVOptions options matches the associated command line
446 * parameter name and can be found in libavcodec/options_table.h
447 * The AVOption/command line parameter names differ in some cases from the C
448 * structure field names for historic reasons or brevity.
449 * sizeof(AVCodecContext) must not be used outside libav*.
450 */
451typedef struct AVCodecContext {
452 /**
453 * information on struct for av_log
454 * - set by avcodec_alloc_context3
455 */
458
459 enum AVMediaType codec_type; /* see AVMEDIA_TYPE_xxx */
460 const struct AVCodec *codec;
461 enum AVCodecID codec_id; /* see AV_CODEC_ID_xxx */
462
463 /**
464 * fourcc (LSB first, so "ABCD" -> ('D'<<24) + ('C'<<16) + ('B'<<8) + 'A').
465 * This is used to work around some encoder bugs.
466 * A demuxer should set this to what is stored in the field used to identify the codec.
467 * If there are multiple such fields in a container then the demuxer should choose the one
468 * which maximizes the information about the used codec.
469 * If the codec tag field in a container is larger than 32 bits then the demuxer should
470 * remap the longer ID to 32 bits with a table or other structure. Alternatively a new
471 * extra_codec_tag + size could be added but for this a clear advantage must be demonstrated
472 * first.
473 * - encoding: Set by user, if not then the default based on codec_id will be used.
474 * - decoding: Set by user, will be converted to uppercase by libavcodec during init.
475 */
476 unsigned int codec_tag;
477
479
480 /**
481 * Private context used for internal data.
482 *
483 * Unlike priv_data, this is not codec-specific. It is used in general
484 * libavcodec functions.
485 */
486 struct AVCodecInternal *internal;
487
488 /**
489 * Private data of the user, can be used to carry app specific stuff.
490 * - encoding: Set by user.
491 * - decoding: Set by user.
492 */
493 void *opaque;
494
495 /**
496 * the average bitrate
497 * - encoding: Set by user; unused for constant quantizer encoding.
498 * - decoding: Set by user, may be overwritten by libavcodec
499 * if this info is available in the stream
500 */
501 int64_t bit_rate;
502
503 /**
504 * AV_CODEC_FLAG_*.
505 * - encoding: Set by user.
506 * - decoding: Set by user.
507 */
508 int flags;
509
510 /**
511 * AV_CODEC_FLAG2_*
512 * - encoding: Set by user.
513 * - decoding: Set by user.
514 */
516
517 /**
518 * some codecs need / can use extradata like Huffman tables.
519 * MJPEG: Huffman tables
520 * rv10: additional flags
521 * MPEG-4: global headers (they can be in the bitstream or here)
522 * The allocated memory should be AV_INPUT_BUFFER_PADDING_SIZE bytes larger
523 * than extradata_size to avoid problems if it is read with the bitstream reader.
524 * The bytewise contents of extradata must not depend on the architecture or CPU endianness.
525 * Must be allocated with the av_malloc() family of functions.
526 * - encoding: Set/allocated/freed by libavcodec.
527 * - decoding: Set/allocated/freed by user.
528 */
529 uint8_t *extradata;
531
532 /**
533 * This is the fundamental unit of time (in seconds) in terms
534 * of which frame timestamps are represented. For fixed-fps content,
535 * timebase should be 1/framerate and timestamp increments should be
536 * identically 1.
537 * This often, but not always is the inverse of the frame rate or field rate
538 * for video. 1/time_base is not the average frame rate if the frame rate is not
539 * constant.
540 *
541 * Like containers, elementary streams also can store timestamps, 1/time_base
542 * is the unit in which these timestamps are specified.
543 * As example of such codec time base see ISO/IEC 14496-2:2001(E)
544 * vop_time_increment_resolution and fixed_vop_rate
545 * (fixed_vop_rate == 0 implies that it is different from the framerate)
546 *
547 * - encoding: MUST be set by user.
548 * - decoding: unused.
549 */
551
552 /**
553 * Timebase in which pkt_dts/pts and AVPacket.dts/pts are expressed.
554 * - encoding: unused.
555 * - decoding: set by user.
556 */
558
559 /**
560 * - decoding: For codecs that store a framerate value in the compressed
561 * bitstream, the decoder may export it here. { 0, 1} when
562 * unknown.
563 * - encoding: May be used to signal the framerate of CFR content to an
564 * encoder.
565 */
567
568#if FF_API_TICKS_PER_FRAME
569 /**
570 * For some codecs, the time base is closer to the field rate than the frame rate.
571 * Most notably, H.264 and MPEG-2 specify time_base as half of frame duration
572 * if no telecine is used ...
573 *
574 * Set to time_base ticks per frame. Default 1, e.g., H.264/MPEG-2 set it to 2.
575 *
576 * @deprecated
577 * - decoding: Use AVCodecDescriptor.props & AV_CODEC_PROP_FIELDS
578 * - encoding: Set AVCodecContext.framerate instead
579 *
580 */
582 int ticks_per_frame;
583#endif
584
585 /**
586 * Codec delay.
587 *
588 * Encoding: Number of frames delay there will be from the encoder input to
589 * the decoder output. (we assume the decoder matches the spec)
590 * Decoding: Number of frames delay in addition to what a standard decoder
591 * as specified in the spec would produce.
592 *
593 * Video:
594 * Number of frames the decoded output will be delayed relative to the
595 * encoded input.
596 *
597 * Audio:
598 * For encoding, this field is unused (see initial_padding).
599 *
600 * For decoding, this is the number of samples the decoder needs to
601 * output before the decoder's output is valid. When seeking, you should
602 * start decoding this many samples prior to your desired seek point.
603 *
604 * - encoding: Set by libavcodec.
605 * - decoding: Set by libavcodec.
606 */
607 int delay;
608
609
610 /* video only */
611 /**
612 * picture width / height.
613 *
614 * @note Those fields may not match the values of the last
615 * AVFrame output by avcodec_receive_frame() due frame
616 * reordering.
617 *
618 * - encoding: MUST be set by user.
619 * - decoding: May be set by the user before opening the decoder if known e.g.
620 * from the container. Some decoders will require the dimensions
621 * to be set by the caller. During decoding, the decoder may
622 * overwrite those values as required while parsing the data.
623 */
625
626 /**
627 * Bitstream width / height, may be different from width/height e.g. when
628 * the decoded frame is cropped before being output or lowres is enabled.
629 *
630 * @note Those field may not match the value of the last
631 * AVFrame output by avcodec_receive_frame() due frame
632 * reordering.
633 *
634 * - encoding: unused
635 * - decoding: May be set by the user before opening the decoder if known
636 * e.g. from the container. During decoding, the decoder may
637 * overwrite those values as required while parsing the data.
638 */
640
641 /**
642 * sample aspect ratio (0 if unknown)
643 * That is the width of a pixel divided by the height of the pixel.
644 * Numerator and denominator must be relatively prime and smaller than 256 for some video standards.
645 * - encoding: Set by user.
646 * - decoding: Set by libavcodec.
647 */
649
650 /**
651 * Pixel format, see AV_PIX_FMT_xxx.
652 * May be set by the demuxer if known from headers.
653 * May be overridden by the decoder if it knows better.
654 *
655 * @note This field may not match the value of the last
656 * AVFrame output by avcodec_receive_frame() due frame
657 * reordering.
658 *
659 * - encoding: Set by user.
660 * - decoding: Set by user if known, overridden by libavcodec while
661 * parsing the data.
662 */
664
665 /**
666 * Nominal unaccelerated pixel format, see AV_PIX_FMT_xxx.
667 * - encoding: unused.
668 * - decoding: Set by libavcodec before calling get_format()
669 */
671
672 /**
673 * Chromaticity coordinates of the source primaries.
674 * - encoding: Set by user
675 * - decoding: Set by libavcodec
676 */
678
679 /**
680 * Color Transfer Characteristic.
681 * - encoding: Set by user
682 * - decoding: Set by libavcodec
683 */
685
686 /**
687 * YUV colorspace type.
688 * - encoding: Set by user
689 * - decoding: Set by libavcodec
690 */
692
693 /**
694 * MPEG vs JPEG YUV range.
695 * - encoding: Set by user to override the default output color range value,
696 * If not specified, libavcodec sets the color range depending on the
697 * output format.
698 * - decoding: Set by libavcodec, can be set by the user to propagate the
699 * color range to components reading from the decoder context.
700 */
702
703 /**
704 * This defines the location of chroma samples.
705 * - encoding: Set by user
706 * - decoding: Set by libavcodec
707 */
709
710 /** Field order
711 * - encoding: set by libavcodec
712 * - decoding: Set by user.
713 */
715
716 /**
717 * number of reference frames
718 * - encoding: Set by user.
719 * - decoding: Set by lavc.
720 */
721 int refs;
722
723 /**
724 * Size of the frame reordering buffer in the decoder.
725 * For MPEG-2 it is 1 IPB or 0 low delay IP.
726 * - encoding: Set by libavcodec.
727 * - decoding: Set by libavcodec.
728 */
730
731 /**
732 * slice flags
733 * - encoding: unused
734 * - decoding: Set by user.
735 */
737#define SLICE_FLAG_CODED_ORDER 0x0001 ///< draw_horiz_band() is called in coded order instead of display
738#define SLICE_FLAG_ALLOW_FIELD 0x0002 ///< allow draw_horiz_band() with field slices (MPEG-2 field pics)
739#define SLICE_FLAG_ALLOW_PLANE 0x0004 ///< allow draw_horiz_band() with 1 component at a time (SVQ1)
740
741 /**
742 * If non NULL, 'draw_horiz_band' is called by the libavcodec
743 * decoder to draw a horizontal band. It improves cache usage. Not
744 * all codecs can do that. You must check the codec capabilities
745 * beforehand.
746 * When multithreading is used, it may be called from multiple threads
747 * at the same time; threads might draw different parts of the same AVFrame,
748 * or multiple AVFrames, and there is no guarantee that slices will be drawn
749 * in order.
750 * The function is also used by hardware acceleration APIs.
751 * It is called at least once during frame decoding to pass
752 * the data needed for hardware render.
753 * In that mode instead of pixel data, AVFrame points to
754 * a structure specific to the acceleration API. The application
755 * reads the structure and can change some fields to indicate progress
756 * or mark state.
757 * - encoding: unused
758 * - decoding: Set by user.
759 * @param height the height of the slice
760 * @param y the y position of the slice
761 * @param type 1->top field, 2->bottom field, 3->frame
762 * @param offset offset into the AVFrame.data from which the slice should be read
763 */
765 const AVFrame *src, int offset[AV_NUM_DATA_POINTERS],
766 int y, int type, int height);
767
768 /**
769 * Callback to negotiate the pixel format. Decoding only, may be set by the
770 * caller before avcodec_open2().
771 *
772 * Called by some decoders to select the pixel format that will be used for
773 * the output frames. This is mainly used to set up hardware acceleration,
774 * then the provided format list contains the corresponding hwaccel pixel
775 * formats alongside the "software" one. The software pixel format may also
776 * be retrieved from \ref sw_pix_fmt.
777 *
778 * This callback will be called when the coded frame properties (such as
779 * resolution, pixel format, etc.) change and more than one output format is
780 * supported for those new properties. If a hardware pixel format is chosen
781 * and initialization for it fails, the callback may be called again
782 * immediately.
783 *
784 * This callback may be called from different threads if the decoder is
785 * multi-threaded, but not from more than one thread simultaneously.
786 *
787 * @param fmt list of formats which may be used in the current
788 * configuration, terminated by AV_PIX_FMT_NONE.
789 * @warning Behavior is undefined if the callback returns a value other
790 * than one of the formats in fmt or AV_PIX_FMT_NONE.
791 * @return the chosen format or AV_PIX_FMT_NONE
792 */
793 enum AVPixelFormat (*get_format)(struct AVCodecContext *s, const enum AVPixelFormat * fmt);
794
795 /**
796 * maximum number of B-frames between non-B-frames
797 * Note: The output will be delayed by max_b_frames+1 relative to the input.
798 * - encoding: Set by user.
799 * - decoding: unused
800 */
802
803 /**
804 * qscale factor between IP and B-frames
805 * If > 0 then the last P-frame quantizer will be used (q= lastp_q*factor+offset).
806 * If < 0 then normal ratecontrol will be done (q= -normal_q*factor+offset).
807 * - encoding: Set by user.
808 * - decoding: unused
809 */
811
812 /**
813 * qscale offset between IP and B-frames
814 * - encoding: Set by user.
815 * - decoding: unused
816 */
818
819 /**
820 * qscale factor between P- and I-frames
821 * If > 0 then the last P-frame quantizer will be used (q = lastp_q * factor + offset).
822 * If < 0 then normal ratecontrol will be done (q= -normal_q*factor+offset).
823 * - encoding: Set by user.
824 * - decoding: unused
825 */
827
828 /**
829 * qscale offset between P and I-frames
830 * - encoding: Set by user.
831 * - decoding: unused
832 */
834
835 /**
836 * luminance masking (0-> disabled)
837 * - encoding: Set by user.
838 * - decoding: unused
839 */
841
842 /**
843 * temporary complexity masking (0-> disabled)
844 * - encoding: Set by user.
845 * - decoding: unused
846 */
848
849 /**
850 * spatial complexity masking (0-> disabled)
851 * - encoding: Set by user.
852 * - decoding: unused
853 */
855
856 /**
857 * p block masking (0-> disabled)
858 * - encoding: Set by user.
859 * - decoding: unused
860 */
862
863 /**
864 * darkness masking (0-> disabled)
865 * - encoding: Set by user.
866 * - decoding: unused
867 */
869
870 /**
871 * noise vs. sse weight for the nsse comparison function
872 * - encoding: Set by user.
873 * - decoding: unused
874 */
876
877 /**
878 * motion estimation comparison function
879 * - encoding: Set by user.
880 * - decoding: unused
881 */
883 /**
884 * subpixel motion estimation comparison function
885 * - encoding: Set by user.
886 * - decoding: unused
887 */
889 /**
890 * macroblock comparison function (not supported yet)
891 * - encoding: Set by user.
892 * - decoding: unused
893 */
895 /**
896 * interlaced DCT comparison function
897 * - encoding: Set by user.
898 * - decoding: unused
899 */
901#define FF_CMP_SAD 0
902#define FF_CMP_SSE 1
903#define FF_CMP_SATD 2
904#define FF_CMP_DCT 3
905#define FF_CMP_PSNR 4
906#define FF_CMP_BIT 5
907#define FF_CMP_RD 6
908#define FF_CMP_ZERO 7
909#define FF_CMP_VSAD 8
910#define FF_CMP_VSSE 9
911#define FF_CMP_NSSE 10
912#define FF_CMP_W53 11
913#define FF_CMP_W97 12
914#define FF_CMP_DCTMAX 13
915#define FF_CMP_DCT264 14
916#define FF_CMP_MEDIAN_SAD 15
917#define FF_CMP_CHROMA 256
918
919 /**
920 * ME diamond size & shape
921 * - encoding: Set by user.
922 * - decoding: unused
923 */
925
926 /**
927 * amount of previous MV predictors (2a+1 x 2a+1 square)
928 * - encoding: Set by user.
929 * - decoding: unused
930 */
932
933 /**
934 * motion estimation prepass comparison function
935 * - encoding: Set by user.
936 * - decoding: unused
937 */
939
940 /**
941 * ME prepass diamond size & shape
942 * - encoding: Set by user.
943 * - decoding: unused
944 */
946
947 /**
948 * subpel ME quality
949 * - encoding: Set by user.
950 * - decoding: unused
951 */
953
954 /**
955 * maximum motion estimation search range in subpel units
956 * If 0 then no limit.
957 *
958 * - encoding: Set by user.
959 * - decoding: unused
960 */
962
963 /**
964 * macroblock decision mode
965 * - encoding: Set by user.
966 * - decoding: unused
967 */
969#define FF_MB_DECISION_SIMPLE 0 ///< uses mb_cmp
970#define FF_MB_DECISION_BITS 1 ///< chooses the one which needs the fewest bits
971#define FF_MB_DECISION_RD 2 ///< rate distortion
972
973 /**
974 * custom intra quantization matrix
975 * Must be allocated with the av_malloc() family of functions, and will be freed in
976 * avcodec_free_context().
977 * - encoding: Set/allocated by user, freed by libavcodec. Can be NULL.
978 * - decoding: Set/allocated/freed by libavcodec.
979 */
980 uint16_t *intra_matrix;
981
982 /**
983 * custom inter quantization matrix
984 * Must be allocated with the av_malloc() family of functions, and will be freed in
985 * avcodec_free_context().
986 * - encoding: Set/allocated by user, freed by libavcodec. Can be NULL.
987 * - decoding: Set/allocated/freed by libavcodec.
988 */
989 uint16_t *inter_matrix;
990
991 /**
992 * custom intra quantization matrix
993 * - encoding: Set by user, can be NULL.
994 * - decoding: unused.
995 */
997
998 /**
999 * precision of the intra DC coefficient - 8
1000 * - encoding: Set by user.
1001 * - decoding: Set by libavcodec
1002 */
1004
1005 /**
1006 * minimum MB Lagrange multiplier
1007 * - encoding: Set by user.
1008 * - decoding: unused
1009 */
1011
1012 /**
1013 * maximum MB Lagrange multiplier
1014 * - encoding: Set by user.
1015 * - decoding: unused
1016 */
1018
1019 /**
1020 * - encoding: Set by user.
1021 * - decoding: unused
1022 */
1024
1025 /**
1026 * minimum GOP size
1027 * - encoding: Set by user.
1028 * - decoding: unused
1029 */
1031
1032 /**
1033 * the number of pictures in a group of pictures, or 0 for intra_only
1034 * - encoding: Set by user.
1035 * - decoding: unused
1036 */
1038
1039 /**
1040 * Note: Value depends upon the compare function used for fullpel ME.
1041 * - encoding: Set by user.
1042 * - decoding: unused
1043 */
1045
1046 /**
1047 * Number of slices.
1048 * Indicates number of picture subdivisions. Used for parallelized
1049 * decoding.
1050 * - encoding: Set by user
1051 * - decoding: unused
1052 */
1054
1055 /* audio only */
1056 int sample_rate; ///< samples per second
1057
1058 /**
1059 * audio sample format
1060 * - encoding: Set by user.
1061 * - decoding: Set by libavcodec.
1062 */
1063 enum AVSampleFormat sample_fmt; ///< sample format
1064
1065 /**
1066 * Audio channel layout.
1067 * - encoding: must be set by the caller, to one of AVCodec.ch_layouts.
1068 * - decoding: may be set by the caller if known e.g. from the container.
1069 * The decoder can then override during decoding as needed.
1070 */
1072
1073 /* The following data should not be initialized. */
1074 /**
1075 * Number of samples per channel in an audio frame.
1076 *
1077 * - encoding: set by libavcodec in avcodec_open2(). Each submitted frame
1078 * except the last must contain exactly frame_size samples per channel.
1079 * May be 0 when the codec has AV_CODEC_CAP_VARIABLE_FRAME_SIZE set, then the
1080 * frame size is not restricted.
1081 * - decoding: may be set by some decoders to indicate constant frame size
1082 */
1084
1085 /**
1086 * number of bytes per packet if constant and known or 0
1087 * Used by some WAV based audio codecs.
1088 */
1090
1091 /**
1092 * Audio cutoff bandwidth (0 means "automatic")
1093 * - encoding: Set by user.
1094 * - decoding: unused
1095 */
1097
1098 /**
1099 * Type of service that the audio stream conveys.
1100 * - encoding: Set by user.
1101 * - decoding: Set by libavcodec.
1102 */
1104
1105 /**
1106 * desired sample format
1107 * - encoding: Not used.
1108 * - decoding: Set by user.
1109 * Decoder will decode to this format if it can.
1110 */
1112
1113 /**
1114 * Audio only. The number of "priming" samples (padding) inserted by the
1115 * encoder at the beginning of the audio. I.e. this number of leading
1116 * decoded samples must be discarded by the caller to get the original audio
1117 * without leading padding.
1118 *
1119 * - decoding: unused
1120 * - encoding: Set by libavcodec. The timestamps on the output packets are
1121 * adjusted by the encoder so that they always refer to the
1122 * first sample of the data actually contained in the packet,
1123 * including any added padding. E.g. if the timebase is
1124 * 1/samplerate and the timestamp of the first input sample is
1125 * 0, the timestamp of the first output packet will be
1126 * -initial_padding.
1127 */
1129
1130 /**
1131 * Audio only. The amount of padding (in samples) appended by the encoder to
1132 * the end of the audio. I.e. this number of decoded samples must be
1133 * discarded by the caller from the end of the stream to get the original
1134 * audio without any trailing padding.
1135 *
1136 * - decoding: unused
1137 * - encoding: unused
1138 */
1140
1141 /**
1142 * Number of samples to skip after a discontinuity
1143 * - decoding: unused
1144 * - encoding: set by libavcodec
1145 */
1147
1148 /**
1149 * This callback is called at the beginning of each frame to get data
1150 * buffer(s) for it. There may be one contiguous buffer for all the data or
1151 * there may be a buffer per each data plane or anything in between. What
1152 * this means is, you may set however many entries in buf[] you feel necessary.
1153 * Each buffer must be reference-counted using the AVBuffer API (see description
1154 * of buf[] below).
1155 *
1156 * The following fields will be set in the frame before this callback is
1157 * called:
1158 * - format
1159 * - width, height (video only)
1160 * - sample_rate, channel_layout, nb_samples (audio only)
1161 * Their values may differ from the corresponding values in
1162 * AVCodecContext. This callback must use the frame values, not the codec
1163 * context values, to calculate the required buffer size.
1164 *
1165 * This callback must fill the following fields in the frame:
1166 * - data[]
1167 * - linesize[]
1168 * - extended_data:
1169 * * if the data is planar audio with more than 8 channels, then this
1170 * callback must allocate and fill extended_data to contain all pointers
1171 * to all data planes. data[] must hold as many pointers as it can.
1172 * extended_data must be allocated with av_malloc() and will be freed in
1173 * av_frame_unref().
1174 * * otherwise extended_data must point to data
1175 * - buf[] must contain one or more pointers to AVBufferRef structures. Each of
1176 * the frame's data and extended_data pointers must be contained in these. That
1177 * is, one AVBufferRef for each allocated chunk of memory, not necessarily one
1178 * AVBufferRef per data[] entry. See: av_buffer_create(), av_buffer_alloc(),
1179 * and av_buffer_ref().
1180 * - extended_buf and nb_extended_buf must be allocated with av_malloc() by
1181 * this callback and filled with the extra buffers if there are more
1182 * buffers than buf[] can hold. extended_buf will be freed in
1183 * av_frame_unref().
1184 * Decoders will generally initialize the whole buffer before it is output
1185 * but it can in rare error conditions happen that uninitialized data is passed
1186 * through. \important The buffers returned by get_buffer* should thus not contain sensitive
1187 * data.
1188 *
1189 * If AV_CODEC_CAP_DR1 is not set then get_buffer2() must call
1190 * avcodec_default_get_buffer2() instead of providing buffers allocated by
1191 * some other means.
1192 *
1193 * Each data plane must be aligned to the maximum required by the target
1194 * CPU.
1195 *
1196 * @see avcodec_default_get_buffer2()
1197 *
1198 * Video:
1199 *
1200 * If AV_GET_BUFFER_FLAG_REF is set in flags then the frame may be reused
1201 * (read and/or written to if it is writable) later by libavcodec.
1202 *
1203 * avcodec_align_dimensions2() should be used to find the required width and
1204 * height, as they normally need to be rounded up to the next multiple of 16.
1205 *
1206 * Some decoders do not support linesizes changing between frames.
1207 *
1208 * If frame multithreading is used, this callback may be called from a
1209 * different thread, but not from more than one at once. Does not need to be
1210 * reentrant.
1211 *
1212 * @see avcodec_align_dimensions2()
1213 *
1214 * Audio:
1215 *
1216 * Decoders request a buffer of a particular size by setting
1217 * AVFrame.nb_samples prior to calling get_buffer2(). The decoder may,
1218 * however, utilize only part of the buffer by setting AVFrame.nb_samples
1219 * to a smaller value in the output frame.
1220 *
1221 * As a convenience, av_samples_get_buffer_size() and
1222 * av_samples_fill_arrays() in libavutil may be used by custom get_buffer2()
1223 * functions to find the required data size and to fill data pointers and
1224 * linesize. In AVFrame.linesize, only linesize[0] may be set for audio
1225 * since all planes must be the same size.
1226 *
1227 * @see av_samples_get_buffer_size(), av_samples_fill_arrays()
1228 *
1229 * - encoding: unused
1230 * - decoding: Set by libavcodec, user can override.
1231 */
1233
1234 /* - encoding parameters */
1235 /**
1236 * number of bits the bitstream is allowed to diverge from the reference.
1237 * the reference can be CBR (for CBR pass1) or VBR (for pass2)
1238 * - encoding: Set by user; unused for constant quantizer encoding.
1239 * - decoding: unused
1240 */
1242
1243 /**
1244 * Global quality for codecs which cannot change it per frame.
1245 * This should be proportional to MPEG-1/2/4 qscale.
1246 * - encoding: Set by user.
1247 * - decoding: unused
1248 */
1250
1251 /**
1252 * - encoding: Set by user.
1253 * - decoding: unused
1254 */
1256#define FF_COMPRESSION_DEFAULT -1
1257
1258 float qcompress; ///< amount of qscale change between easy & hard scenes (0.0-1.0)
1259 float qblur; ///< amount of qscale smoothing over time (0.0-1.0)
1260
1261 /**
1262 * minimum quantizer
1263 * - encoding: Set by user.
1264 * - decoding: unused
1265 */
1266 int qmin;
1267
1268 /**
1269 * maximum quantizer
1270 * - encoding: Set by user.
1271 * - decoding: unused
1272 */
1273 int qmax;
1274
1275 /**
1276 * maximum quantizer difference between frames
1277 * - encoding: Set by user.
1278 * - decoding: unused
1279 */
1281
1282 /**
1283 * decoder bitstream buffer size
1284 * - encoding: Set by user.
1285 * - decoding: May be set by libavcodec.
1286 */
1288
1289 /**
1290 * ratecontrol override, see RcOverride
1291 * - encoding: Allocated/set/freed by user.
1292 * - decoding: unused
1293 */
1296
1297 /**
1298 * maximum bitrate
1299 * - encoding: Set by user.
1300 * - decoding: Set by user, may be overwritten by libavcodec.
1301 */
1303
1304 /**
1305 * minimum bitrate
1306 * - encoding: Set by user.
1307 * - decoding: unused
1308 */
1310
1311 /**
1312 * Ratecontrol attempt to use, at maximum, <value> of what can be used without an underflow.
1313 * - encoding: Set by user.
1314 * - decoding: unused.
1315 */
1317
1318 /**
1319 * Ratecontrol attempt to use, at least, <value> times the amount needed to prevent a vbv overflow.
1320 * - encoding: Set by user.
1321 * - decoding: unused.
1322 */
1324
1325 /**
1326 * Number of bits which should be loaded into the rc buffer before decoding starts.
1327 * - encoding: Set by user.
1328 * - decoding: unused
1329 */
1331
1332 /**
1333 * trellis RD quantization
1334 * - encoding: Set by user.
1335 * - decoding: unused
1336 */
1338
1339 /**
1340 * pass1 encoding statistics output buffer
1341 * - encoding: Set by libavcodec.
1342 * - decoding: unused
1343 */
1345
1346 /**
1347 * pass2 encoding statistics input buffer
1348 * Concatenated stuff from stats_out of pass1 should be placed here.
1349 * - encoding: Allocated/set/freed by user.
1350 * - decoding: unused
1351 */
1353
1354 /**
1355 * Work around bugs in encoders which sometimes cannot be detected automatically.
1356 * - encoding: Set by user
1357 * - decoding: Set by user
1358 */
1360#define FF_BUG_AUTODETECT 1 ///< autodetection
1361#define FF_BUG_XVID_ILACE 4
1362#define FF_BUG_UMP4 8
1363#define FF_BUG_NO_PADDING 16
1364#define FF_BUG_AMV 32
1365#define FF_BUG_QPEL_CHROMA 64
1366#define FF_BUG_STD_QPEL 128
1367#define FF_BUG_QPEL_CHROMA2 256
1368#define FF_BUG_DIRECT_BLOCKSIZE 512
1369#define FF_BUG_EDGE 1024
1370#define FF_BUG_HPEL_CHROMA 2048
1371#define FF_BUG_DC_CLIP 4096
1372#define FF_BUG_MS 8192 ///< Work around various bugs in Microsoft's broken decoders.
1373#define FF_BUG_TRUNCATED 16384
1374#define FF_BUG_IEDGE 32768
1375
1376 /**
1377 * strictly follow the standard (MPEG-4, ...).
1378 * - encoding: Set by user.
1379 * - decoding: Set by user.
1380 * Setting this to STRICT or higher means the encoder and decoder will
1381 * generally do stupid things, whereas setting it to unofficial or lower
1382 * will mean the encoder might produce output that is not supported by all
1383 * spec-compliant decoders. Decoders don't differentiate between normal,
1384 * unofficial and experimental (that is, they always try to decode things
1385 * when they can) unless they are explicitly asked to behave stupidly
1386 * (=strictly conform to the specs)
1387 * This may only be set to one of the FF_COMPLIANCE_* values in defs.h.
1388 */
1390
1391 /**
1392 * error concealment flags
1393 * - encoding: unused
1394 * - decoding: Set by user.
1395 */
1397#define FF_EC_GUESS_MVS 1
1398#define FF_EC_DEBLOCK 2
1399#define FF_EC_FAVOR_INTER 256
1400
1401 /**
1402 * debug
1403 * - encoding: Set by user.
1404 * - decoding: Set by user.
1405 */
1407#define FF_DEBUG_PICT_INFO 1
1408#define FF_DEBUG_RC 2
1409#define FF_DEBUG_BITSTREAM 4
1410#define FF_DEBUG_MB_TYPE 8
1411#define FF_DEBUG_QP 16
1412#define FF_DEBUG_DCT_COEFF 0x00000040
1413#define FF_DEBUG_SKIP 0x00000080
1414#define FF_DEBUG_STARTCODE 0x00000100
1415#define FF_DEBUG_ER 0x00000400
1416#define FF_DEBUG_MMCO 0x00000800
1417#define FF_DEBUG_BUGS 0x00001000
1418#define FF_DEBUG_BUFFERS 0x00008000
1419#define FF_DEBUG_THREADS 0x00010000
1420#define FF_DEBUG_GREEN_MD 0x00800000
1421#define FF_DEBUG_NOMC 0x01000000
1422
1423 /**
1424 * Error recognition; may misdetect some more or less valid parts as errors.
1425 * This is a bitfield of the AV_EF_* values defined in defs.h.
1426 *
1427 * - encoding: Set by user.
1428 * - decoding: Set by user.
1429 */
1431
1432 /**
1433 * Hardware accelerator in use
1434 * - encoding: unused.
1435 * - decoding: Set by libavcodec
1436 */
1437 const struct AVHWAccel *hwaccel;
1438
1439 /**
1440 * Legacy hardware accelerator context.
1441 *
1442 * For some hardware acceleration methods, the caller may use this field to
1443 * signal hwaccel-specific data to the codec. The struct pointed to by this
1444 * pointer is hwaccel-dependent and defined in the respective header. Please
1445 * refer to the FFmpeg HW accelerator documentation to know how to fill
1446 * this.
1447 *
1448 * In most cases this field is optional - the necessary information may also
1449 * be provided to libavcodec through @ref hw_frames_ctx or @ref
1450 * hw_device_ctx (see avcodec_get_hw_config()). However, in some cases it
1451 * may be the only method of signalling some (optional) information.
1452 *
1453 * The struct and its contents are owned by the caller.
1454 *
1455 * - encoding: May be set by the caller before avcodec_open2(). Must remain
1456 * valid until avcodec_free_context().
1457 * - decoding: May be set by the caller in the get_format() callback.
1458 * Must remain valid until the next get_format() call,
1459 * or avcodec_free_context() (whichever comes first).
1460 */
1462
1463 /**
1464 * A reference to the AVHWFramesContext describing the input (for encoding)
1465 * or output (decoding) frames. The reference is set by the caller and
1466 * afterwards owned (and freed) by libavcodec - it should never be read by
1467 * the caller after being set.
1468 *
1469 * - decoding: This field should be set by the caller from the get_format()
1470 * callback. The previous reference (if any) will always be
1471 * unreffed by libavcodec before the get_format() call.
1472 *
1473 * If the default get_buffer2() is used with a hwaccel pixel
1474 * format, then this AVHWFramesContext will be used for
1475 * allocating the frame buffers.
1476 *
1477 * - encoding: For hardware encoders configured to use a hwaccel pixel
1478 * format, this field should be set by the caller to a reference
1479 * to the AVHWFramesContext describing input frames.
1480 * AVHWFramesContext.format must be equal to
1481 * AVCodecContext.pix_fmt.
1482 *
1483 * This field should be set before avcodec_open2() is called.
1484 */
1486
1487 /**
1488 * A reference to the AVHWDeviceContext describing the device which will
1489 * be used by a hardware encoder/decoder. The reference is set by the
1490 * caller and afterwards owned (and freed) by libavcodec.
1491 *
1492 * This should be used if either the codec device does not require
1493 * hardware frames or any that are used are to be allocated internally by
1494 * libavcodec. If the user wishes to supply any of the frames used as
1495 * encoder input or decoder output then hw_frames_ctx should be used
1496 * instead. When hw_frames_ctx is set in get_format() for a decoder, this
1497 * field will be ignored while decoding the associated stream segment, but
1498 * may again be used on a following one after another get_format() call.
1499 *
1500 * For both encoders and decoders this field should be set before
1501 * avcodec_open2() is called and must not be written to thereafter.
1502 *
1503 * Note that some decoders may require this field to be set initially in
1504 * order to support hw_frames_ctx at all - in that case, all frames
1505 * contexts used must be created on the same device.
1506 */
1508
1509 /**
1510 * Bit set of AV_HWACCEL_FLAG_* flags, which affect hardware accelerated
1511 * decoding (if active).
1512 * - encoding: unused
1513 * - decoding: Set by user (either before avcodec_open2(), or in the
1514 * AVCodecContext.get_format callback)
1515 */
1517
1518 /**
1519 * Video decoding only. Sets the number of extra hardware frames which
1520 * the decoder will allocate for use by the caller. This must be set
1521 * before avcodec_open2() is called.
1522 *
1523 * Some hardware decoders require all frames that they will use for
1524 * output to be defined in advance before decoding starts. For such
1525 * decoders, the hardware frame pool must therefore be of a fixed size.
1526 * The extra frames set here are on top of any number that the decoder
1527 * needs internally in order to operate normally (for example, frames
1528 * used as reference pictures).
1529 */
1531
1532 /**
1533 * error
1534 * - encoding: Set by libavcodec if flags & AV_CODEC_FLAG_PSNR.
1535 * - decoding: unused
1536 */
1538
1539 /**
1540 * DCT algorithm, see FF_DCT_* below
1541 * - encoding: Set by user.
1542 * - decoding: unused
1543 */
1545#define FF_DCT_AUTO 0
1546#define FF_DCT_FASTINT 1
1547#define FF_DCT_INT 2
1548#define FF_DCT_MMX 3
1549#define FF_DCT_ALTIVEC 5
1550#define FF_DCT_FAAN 6
1551#define FF_DCT_NEON 7
1552
1553 /**
1554 * IDCT algorithm, see FF_IDCT_* below.
1555 * - encoding: Set by user.
1556 * - decoding: Set by user.
1557 */
1559#define FF_IDCT_AUTO 0
1560#define FF_IDCT_INT 1
1561#define FF_IDCT_SIMPLE 2
1562#define FF_IDCT_SIMPLEMMX 3
1563#define FF_IDCT_ARM 7
1564#define FF_IDCT_ALTIVEC 8
1565#define FF_IDCT_SIMPLEARM 10
1566#define FF_IDCT_XVID 14
1567#define FF_IDCT_SIMPLEARMV5TE 16
1568#define FF_IDCT_SIMPLEARMV6 17
1569#define FF_IDCT_FAAN 20
1570#define FF_IDCT_SIMPLENEON 22
1571#define FF_IDCT_SIMPLEAUTO 128
1572
1573 /**
1574 * bits per sample/pixel from the demuxer (needed for huffyuv).
1575 * - encoding: Set by libavcodec.
1576 * - decoding: Set by user.
1577 */
1579
1580 /**
1581 * Bits per sample/pixel of internal libavcodec pixel/sample format.
1582 * - encoding: set by user.
1583 * - decoding: set by libavcodec.
1584 */
1586
1587 /**
1588 * thread count
1589 * is used to decide how many independent tasks should be passed to execute()
1590 * - encoding: Set by user.
1591 * - decoding: Set by user.
1592 */
1594
1595 /**
1596 * Which multithreading methods to use.
1597 * Use of FF_THREAD_FRAME will increase decoding delay by one frame per thread,
1598 * so clients which cannot provide future frames should not use it.
1599 *
1600 * - encoding: Set by user, otherwise the default is used.
1601 * - decoding: Set by user, otherwise the default is used.
1602 */
1604#define FF_THREAD_FRAME 1 ///< Decode more than one frame at once
1605#define FF_THREAD_SLICE 2 ///< Decode more than one part of a single frame at once
1606
1607 /**
1608 * Which multithreading methods are in use by the codec.
1609 * - encoding: Set by libavcodec.
1610 * - decoding: Set by libavcodec.
1611 */
1613
1614 /**
1615 * The codec may call this to execute several independent things.
1616 * It will return only after finishing all tasks.
1617 * The user may replace this with some multithreaded implementation,
1618 * the default implementation will execute the parts serially.
1619 * @param count the number of things to execute
1620 * - encoding: Set by libavcodec, user can override.
1621 * - decoding: Set by libavcodec, user can override.
1622 */
1623 int (*execute)(struct AVCodecContext *c, int (*func)(struct AVCodecContext *c2, void *arg), void *arg2, int *ret, int count, int size);
1624
1625 /**
1626 * The codec may call this to execute several independent things.
1627 * It will return only after finishing all tasks.
1628 * The user may replace this with some multithreaded implementation,
1629 * the default implementation will execute the parts serially.
1630 * @param c context passed also to func
1631 * @param count the number of things to execute
1632 * @param arg2 argument passed unchanged to func
1633 * @param ret return values of executed functions, must have space for "count" values. May be NULL.
1634 * @param func function that will be called count times, with jobnr from 0 to count-1.
1635 * threadnr will be in the range 0 to c->thread_count-1 < MAX_THREADS and so that no
1636 * two instances of func executing at the same time will have the same threadnr.
1637 * @return always 0 currently, but code should handle a future improvement where when any call to func
1638 * returns < 0 no further calls to func may be done and < 0 is returned.
1639 * - encoding: Set by libavcodec, user can override.
1640 * - decoding: Set by libavcodec, user can override.
1641 */
1642 int (*execute2)(struct AVCodecContext *c, int (*func)(struct AVCodecContext *c2, void *arg, int jobnr, int threadnr), void *arg2, int *ret, int count);
1643
1644 /**
1645 * profile
1646 * - encoding: Set by user.
1647 * - decoding: Set by libavcodec.
1648 * See the AV_PROFILE_* defines in defs.h.
1649 */
1651#if FF_API_FF_PROFILE_LEVEL
1652 /** @deprecated The following defines are deprecated; use AV_PROFILE_*
1653 * in defs.h instead. */
1654#define FF_PROFILE_UNKNOWN -99
1655#define FF_PROFILE_RESERVED -100
1656
1657#define FF_PROFILE_AAC_MAIN 0
1658#define FF_PROFILE_AAC_LOW 1
1659#define FF_PROFILE_AAC_SSR 2
1660#define FF_PROFILE_AAC_LTP 3
1661#define FF_PROFILE_AAC_HE 4
1662#define FF_PROFILE_AAC_HE_V2 28
1663#define FF_PROFILE_AAC_LD 22
1664#define FF_PROFILE_AAC_ELD 38
1665#define FF_PROFILE_MPEG2_AAC_LOW 128
1666#define FF_PROFILE_MPEG2_AAC_HE 131
1667
1668#define FF_PROFILE_DNXHD 0
1669#define FF_PROFILE_DNXHR_LB 1
1670#define FF_PROFILE_DNXHR_SQ 2
1671#define FF_PROFILE_DNXHR_HQ 3
1672#define FF_PROFILE_DNXHR_HQX 4
1673#define FF_PROFILE_DNXHR_444 5
1674
1675#define FF_PROFILE_DTS 20
1676#define FF_PROFILE_DTS_ES 30
1677#define FF_PROFILE_DTS_96_24 40
1678#define FF_PROFILE_DTS_HD_HRA 50
1679#define FF_PROFILE_DTS_HD_MA 60
1680#define FF_PROFILE_DTS_EXPRESS 70
1681#define FF_PROFILE_DTS_HD_MA_X 61
1682#define FF_PROFILE_DTS_HD_MA_X_IMAX 62
1683
1684
1685#define FF_PROFILE_EAC3_DDP_ATMOS 30
1686
1687#define FF_PROFILE_TRUEHD_ATMOS 30
1688
1689#define FF_PROFILE_MPEG2_422 0
1690#define FF_PROFILE_MPEG2_HIGH 1
1691#define FF_PROFILE_MPEG2_SS 2
1692#define FF_PROFILE_MPEG2_SNR_SCALABLE 3
1693#define FF_PROFILE_MPEG2_MAIN 4
1694#define FF_PROFILE_MPEG2_SIMPLE 5
1695
1696#define FF_PROFILE_H264_CONSTRAINED (1<<9) // 8+1; constraint_set1_flag
1697#define FF_PROFILE_H264_INTRA (1<<11) // 8+3; constraint_set3_flag
1698
1699#define FF_PROFILE_H264_BASELINE 66
1700#define FF_PROFILE_H264_CONSTRAINED_BASELINE (66|FF_PROFILE_H264_CONSTRAINED)
1701#define FF_PROFILE_H264_MAIN 77
1702#define FF_PROFILE_H264_EXTENDED 88
1703#define FF_PROFILE_H264_HIGH 100
1704#define FF_PROFILE_H264_HIGH_10 110
1705#define FF_PROFILE_H264_HIGH_10_INTRA (110|FF_PROFILE_H264_INTRA)
1706#define FF_PROFILE_H264_MULTIVIEW_HIGH 118
1707#define FF_PROFILE_H264_HIGH_422 122
1708#define FF_PROFILE_H264_HIGH_422_INTRA (122|FF_PROFILE_H264_INTRA)
1709#define FF_PROFILE_H264_STEREO_HIGH 128
1710#define FF_PROFILE_H264_HIGH_444 144
1711#define FF_PROFILE_H264_HIGH_444_PREDICTIVE 244
1712#define FF_PROFILE_H264_HIGH_444_INTRA (244|FF_PROFILE_H264_INTRA)
1713#define FF_PROFILE_H264_CAVLC_444 44
1714
1715#define FF_PROFILE_VC1_SIMPLE 0
1716#define FF_PROFILE_VC1_MAIN 1
1717#define FF_PROFILE_VC1_COMPLEX 2
1718#define FF_PROFILE_VC1_ADVANCED 3
1719
1720#define FF_PROFILE_MPEG4_SIMPLE 0
1721#define FF_PROFILE_MPEG4_SIMPLE_SCALABLE 1
1722#define FF_PROFILE_MPEG4_CORE 2
1723#define FF_PROFILE_MPEG4_MAIN 3
1724#define FF_PROFILE_MPEG4_N_BIT 4
1725#define FF_PROFILE_MPEG4_SCALABLE_TEXTURE 5
1726#define FF_PROFILE_MPEG4_SIMPLE_FACE_ANIMATION 6
1727#define FF_PROFILE_MPEG4_BASIC_ANIMATED_TEXTURE 7
1728#define FF_PROFILE_MPEG4_HYBRID 8
1729#define FF_PROFILE_MPEG4_ADVANCED_REAL_TIME 9
1730#define FF_PROFILE_MPEG4_CORE_SCALABLE 10
1731#define FF_PROFILE_MPEG4_ADVANCED_CODING 11
1732#define FF_PROFILE_MPEG4_ADVANCED_CORE 12
1733#define FF_PROFILE_MPEG4_ADVANCED_SCALABLE_TEXTURE 13
1734#define FF_PROFILE_MPEG4_SIMPLE_STUDIO 14
1735#define FF_PROFILE_MPEG4_ADVANCED_SIMPLE 15
1736
1737#define FF_PROFILE_JPEG2000_CSTREAM_RESTRICTION_0 1
1738#define FF_PROFILE_JPEG2000_CSTREAM_RESTRICTION_1 2
1739#define FF_PROFILE_JPEG2000_CSTREAM_NO_RESTRICTION 32768
1740#define FF_PROFILE_JPEG2000_DCINEMA_2K 3
1741#define FF_PROFILE_JPEG2000_DCINEMA_4K 4
1742
1743#define FF_PROFILE_VP9_0 0
1744#define FF_PROFILE_VP9_1 1
1745#define FF_PROFILE_VP9_2 2
1746#define FF_PROFILE_VP9_3 3
1747
1748#define FF_PROFILE_HEVC_MAIN 1
1749#define FF_PROFILE_HEVC_MAIN_10 2
1750#define FF_PROFILE_HEVC_MAIN_STILL_PICTURE 3
1751#define FF_PROFILE_HEVC_REXT 4
1752#define FF_PROFILE_HEVC_SCC 9
1753
1754#define FF_PROFILE_VVC_MAIN_10 1
1755#define FF_PROFILE_VVC_MAIN_10_444 33
1756
1757#define FF_PROFILE_AV1_MAIN 0
1758#define FF_PROFILE_AV1_HIGH 1
1759#define FF_PROFILE_AV1_PROFESSIONAL 2
1760
1761#define FF_PROFILE_MJPEG_HUFFMAN_BASELINE_DCT 0xc0
1762#define FF_PROFILE_MJPEG_HUFFMAN_EXTENDED_SEQUENTIAL_DCT 0xc1
1763#define FF_PROFILE_MJPEG_HUFFMAN_PROGRESSIVE_DCT 0xc2
1764#define FF_PROFILE_MJPEG_HUFFMAN_LOSSLESS 0xc3
1765#define FF_PROFILE_MJPEG_JPEG_LS 0xf7
1766
1767#define FF_PROFILE_SBC_MSBC 1
1768
1769#define FF_PROFILE_PRORES_PROXY 0
1770#define FF_PROFILE_PRORES_LT 1
1771#define FF_PROFILE_PRORES_STANDARD 2
1772#define FF_PROFILE_PRORES_HQ 3
1773#define FF_PROFILE_PRORES_4444 4
1774#define FF_PROFILE_PRORES_XQ 5
1775
1776#define FF_PROFILE_ARIB_PROFILE_A 0
1777#define FF_PROFILE_ARIB_PROFILE_C 1
1778
1779#define FF_PROFILE_KLVA_SYNC 0
1780#define FF_PROFILE_KLVA_ASYNC 1
1781
1782#define FF_PROFILE_EVC_BASELINE 0
1783#define FF_PROFILE_EVC_MAIN 1
1784#endif
1785
1786 /**
1787 * Encoding level descriptor.
1788 * - encoding: Set by user, corresponds to a specific level defined by the
1789 * codec, usually corresponding to the profile level, if not specified it
1790 * is set to FF_LEVEL_UNKNOWN.
1791 * - decoding: Set by libavcodec.
1792 * See AV_LEVEL_* in defs.h.
1793 */
1795#if FF_API_FF_PROFILE_LEVEL
1796 /** @deprecated The following define is deprecated; use AV_LEVEL_UNKOWN
1797 * in defs.h instead. */
1798#define FF_LEVEL_UNKNOWN -99
1799#endif
1800
1801 /**
1802 * Properties of the stream that gets decoded
1803 * - encoding: unused
1804 * - decoding: set by libavcodec
1805 */
1806 unsigned properties;
1807#define FF_CODEC_PROPERTY_LOSSLESS 0x00000001
1808#define FF_CODEC_PROPERTY_CLOSED_CAPTIONS 0x00000002
1809#define FF_CODEC_PROPERTY_FILM_GRAIN 0x00000004
1810
1811 /**
1812 * Skip loop filtering for selected frames.
1813 * - encoding: unused
1814 * - decoding: Set by user.
1815 */
1817
1818 /**
1819 * Skip IDCT/dequantization for selected frames.
1820 * - encoding: unused
1821 * - decoding: Set by user.
1822 */
1824
1825 /**
1826 * Skip decoding for selected frames.
1827 * - encoding: unused
1828 * - decoding: Set by user.
1829 */
1831
1832 /**
1833 * Skip processing alpha if supported by codec.
1834 * Note that if the format uses pre-multiplied alpha (common with VP6,
1835 * and recommended due to better video quality/compression)
1836 * the image will look as if alpha-blended onto a black background.
1837 * However for formats that do not use pre-multiplied alpha
1838 * there might be serious artefacts (though e.g. libswscale currently
1839 * assumes pre-multiplied alpha anyway).
1840 *
1841 * - decoding: set by user
1842 * - encoding: unused
1843 */
1845
1846 /**
1847 * Number of macroblock rows at the top which are skipped.
1848 * - encoding: unused
1849 * - decoding: Set by user.
1850 */
1852
1853 /**
1854 * Number of macroblock rows at the bottom which are skipped.
1855 * - encoding: unused
1856 * - decoding: Set by user.
1857 */
1859
1860 /**
1861 * low resolution decoding, 1-> 1/2 size, 2->1/4 size
1862 * - encoding: unused
1863 * - decoding: Set by user.
1864 */
1866
1867 /**
1868 * AVCodecDescriptor
1869 * - encoding: unused.
1870 * - decoding: set by libavcodec.
1871 */
1873
1874 /**
1875 * Character encoding of the input subtitles file.
1876 * - decoding: set by user
1877 * - encoding: unused
1878 */
1880
1881 /**
1882 * Subtitles character encoding mode. Formats or codecs might be adjusting
1883 * this setting (if they are doing the conversion themselves for instance).
1884 * - decoding: set by libavcodec
1885 * - encoding: unused
1886 */
1888#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)
1889#define FF_SUB_CHARENC_MODE_AUTOMATIC 0 ///< libavcodec will select the mode itself
1890#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
1891#define FF_SUB_CHARENC_MODE_IGNORE 2 ///< neither convert the subtitles, nor check them for valid UTF-8
1892
1893 /**
1894 * Header containing style information for text subtitles.
1895 * For SUBTITLE_ASS subtitle type, it should contain the whole ASS
1896 * [Script Info] and [V4+ Styles] section, plus the [Events] line and
1897 * the Format line following. It shouldn't include any Dialogue line.
1898 * - encoding: Set/allocated/freed by user (before avcodec_open2())
1899 * - decoding: Set/allocated/freed by libavcodec (by avcodec_open2())
1900 */
1903
1904 /**
1905 * dump format separator.
1906 * can be ", " or "\n " or anything else
1907 * - encoding: Set by user.
1908 * - decoding: Set by user.
1909 */
1911
1912 /**
1913 * ',' separated list of allowed decoders.
1914 * If NULL then all are allowed
1915 * - encoding: unused
1916 * - decoding: set by user
1917 */
1919
1920 /**
1921 * Additional data associated with the entire coded stream.
1922 *
1923 * - decoding: may be set by user before calling avcodec_open2().
1924 * - encoding: may be set by libavcodec after avcodec_open2().
1925 */
1928
1929 /**
1930 * Bit set of AV_CODEC_EXPORT_DATA_* flags, which affects the kind of
1931 * metadata exported in frame, packet, or coded stream side data by
1932 * decoders and encoders.
1933 *
1934 * - decoding: set by user
1935 * - encoding: set by user
1936 */
1938
1939 /**
1940 * The number of pixels per image to maximally accept.
1941 *
1942 * - decoding: set by user
1943 * - encoding: set by user
1944 */
1945 int64_t max_pixels;
1946
1947 /**
1948 * Video decoding only. Certain video codecs support cropping, meaning that
1949 * only a sub-rectangle of the decoded frame is intended for display. This
1950 * option controls how cropping is handled by libavcodec.
1951 *
1952 * When set to 1 (the default), libavcodec will apply cropping internally.
1953 * I.e. it will modify the output frame width/height fields and offset the
1954 * data pointers (only by as much as possible while preserving alignment, or
1955 * by the full amount if the AV_CODEC_FLAG_UNALIGNED flag is set) so that
1956 * the frames output by the decoder refer only to the cropped area. The
1957 * crop_* fields of the output frames will be zero.
1958 *
1959 * When set to 0, the width/height fields of the output frames will be set
1960 * to the coded dimensions and the crop_* fields will describe the cropping
1961 * rectangle. Applying the cropping is left to the caller.
1962 *
1963 * @warning When hardware acceleration with opaque output frames is used,
1964 * libavcodec is unable to apply cropping from the top/left border.
1965 *
1966 * @note when this option is set to zero, the width/height fields of the
1967 * AVCodecContext and output AVFrames have different meanings. The codec
1968 * context fields store display dimensions (with the coded dimensions in
1969 * coded_width/height), while the frame fields store the coded dimensions
1970 * (with the display dimensions being determined by the crop_* fields).
1971 */
1973
1974 /**
1975 * The percentage of damaged samples to discard a frame.
1976 *
1977 * - decoding: set by user
1978 * - encoding: unused
1979 */
1981
1982 /**
1983 * The number of samples per frame to maximally accept.
1984 *
1985 * - decoding: set by user
1986 * - encoding: set by user
1987 */
1989
1990 /**
1991 * This callback is called at the beginning of each packet to get a data
1992 * buffer for it.
1993 *
1994 * The following field will be set in the packet before this callback is
1995 * called:
1996 * - size
1997 * This callback must use the above value to calculate the required buffer size,
1998 * which must padded by at least AV_INPUT_BUFFER_PADDING_SIZE bytes.
1999 *
2000 * In some specific cases, the encoder may not use the entire buffer allocated by this
2001 * callback. This will be reflected in the size value in the packet once returned by
2002 * avcodec_receive_packet().
2003 *
2004 * This callback must fill the following fields in the packet:
2005 * - data: alignment requirements for AVPacket apply, if any. Some architectures and
2006 * encoders may benefit from having aligned data.
2007 * - buf: must contain a pointer to an AVBufferRef structure. The packet's
2008 * data pointer must be contained in it. See: av_buffer_create(), av_buffer_alloc(),
2009 * and av_buffer_ref().
2010 *
2011 * If AV_CODEC_CAP_DR1 is not set then get_encode_buffer() must call
2012 * avcodec_default_get_encode_buffer() instead of providing a buffer allocated by
2013 * some other means.
2014 *
2015 * The flags field may contain a combination of AV_GET_ENCODE_BUFFER_FLAG_ flags.
2016 * They may be used for example to hint what use the buffer may get after being
2017 * created.
2018 * Implementations of this callback may ignore flags they don't understand.
2019 * If AV_GET_ENCODE_BUFFER_FLAG_REF is set in flags then the packet may be reused
2020 * (read and/or written to if it is writable) later by libavcodec.
2021 *
2022 * This callback must be thread-safe, as when frame threading is used, it may
2023 * be called from multiple threads simultaneously.
2024 *
2025 * @see avcodec_default_get_encode_buffer()
2026 *
2027 * - encoding: Set by libavcodec, user can override.
2028 * - decoding: unused
2029 */
2031
2032 /**
2033 * Frame counter, set by libavcodec.
2034 *
2035 * - decoding: total number of frames returned from the decoder so far.
2036 * - encoding: total number of frames passed to the encoder so far.
2037 *
2038 * @note the counter is not incremented if encoding/decoding resulted in
2039 * an error.
2040 */
2041 int64_t frame_num;
2042
2043 /**
2044 * Decoding only. May be set by the caller before avcodec_open2() to an
2045 * av_malloc()'ed array (or via AVOptions). Owned and freed by the decoder
2046 * afterwards.
2047 *
2048 * Side data attached to decoded frames may come from several sources:
2049 * 1. coded_side_data, which the decoder will for certain types translate
2050 * from packet-type to frame-type and attach to frames;
2051 * 2. side data attached to an AVPacket sent for decoding (same
2052 * considerations as above);
2053 * 3. extracted from the coded bytestream.
2054 * The first two cases are supplied by the caller and typically come from a
2055 * container.
2056 *
2057 * This array configures decoder behaviour in cases when side data of the
2058 * same type is present both in the coded bytestream and in the
2059 * user-supplied side data (items 1. and 2. above). In all cases, at most
2060 * one instance of each side data type will be attached to output frames. By
2061 * default it will be the bytestream side data. Adding an
2062 * AVPacketSideDataType value to this array will flip the preference for
2063 * this type, thus making the decoder prefer user-supplied side data over
2064 * bytestream. In case side data of the same type is present both in
2065 * coded_data and attacked to a packet, the packet instance always has
2066 * priority.
2067 *
2068 * The array may also contain a single -1, in which case the preference is
2069 * switched for all side data types.
2070 */
2072 /**
2073 * Number of entries in side_data_prefer_packet.
2074 */
2076
2077 /**
2078 * Array containing static side data, such as HDR10 CLL / MDCV structures.
2079 * Side data entries should be allocated by usage of helpers defined in
2080 * libavutil/frame.h.
2081 *
2082 * - encoding: may be set by user before calling avcodec_open2() for
2083 * encoder configuration. Afterwards owned and freed by the
2084 * encoder.
2085 * - decoding: may be set by libavcodec in avcodec_open2().
2086 */
2090
2091/**
2092 * @defgroup lavc_hwaccel AVHWAccel
2093 *
2094 * @note Nothing in this structure should be accessed by the user. At some
2095 * point in future it will not be externally visible at all.
2096 *
2097 * @{
2098 */
2099typedef struct AVHWAccel {
2100 /**
2101 * Name of the hardware accelerated codec.
2102 * The name is globally unique among encoders and among decoders (but an
2103 * encoder and a decoder can share the same name).
2104 */
2105 const char *name;
2106
2107 /**
2108 * Type of codec implemented by the hardware accelerator.
2109 *
2110 * See AVMEDIA_TYPE_xxx
2111 */
2113
2114 /**
2115 * Codec implemented by the hardware accelerator.
2116 *
2117 * See AV_CODEC_ID_xxx
2118 */
2120
2121 /**
2122 * Supported pixel format.
2123 *
2124 * Only hardware accelerated formats are supported here.
2125 */
2127
2128 /**
2129 * Hardware accelerated codec capabilities.
2130 * see AV_HWACCEL_CODEC_CAP_*
2131 */
2133} AVHWAccel;
2134
2135/**
2136 * HWAccel is experimental and is thus avoided in favor of non experimental
2137 * codecs
2138 */
2139#define AV_HWACCEL_CODEC_CAP_EXPERIMENTAL 0x0200
2140
2141/**
2142 * Hardware acceleration should be used for decoding even if the codec level
2143 * used is unknown or higher than the maximum supported level reported by the
2144 * hardware driver.
2145 *
2146 * It's generally a good idea to pass this flag unless you have a specific
2147 * reason not to, as hardware tends to under-report supported levels.
2148 */
2149#define AV_HWACCEL_FLAG_IGNORE_LEVEL (1 << 0)
2150
2151/**
2152 * Hardware acceleration can output YUV pixel formats with a different chroma
2153 * sampling than 4:2:0 and/or other than 8 bits per component.
2154 */
2155#define AV_HWACCEL_FLAG_ALLOW_HIGH_DEPTH (1 << 1)
2156
2157/**
2158 * Hardware acceleration should still be attempted for decoding when the
2159 * codec profile does not match the reported capabilities of the hardware.
2160 *
2161 * For example, this can be used to try to decode baseline profile H.264
2162 * streams in hardware - it will often succeed, because many streams marked
2163 * as baseline profile actually conform to constrained baseline profile.
2164 *
2165 * @warning If the stream is actually not supported then the behaviour is
2166 * undefined, and may include returning entirely incorrect output
2167 * while indicating success.
2168 */
2169#define AV_HWACCEL_FLAG_ALLOW_PROFILE_MISMATCH (1 << 2)
2170
2171/**
2172 * Some hardware decoders (namely nvdec) can either output direct decoder
2173 * surfaces, or make an on-device copy and return said copy.
2174 * There is a hard limit on how many decoder surfaces there can be, and it
2175 * cannot be accurately guessed ahead of time.
2176 * For some processing chains, this can be okay, but others will run into the
2177 * limit and in turn produce very confusing errors that require fine tuning of
2178 * more or less obscure options by the user, or in extreme cases cannot be
2179 * resolved at all without inserting an avfilter that forces a copy.
2180 *
2181 * Thus, the hwaccel will by default make a copy for safety and resilience.
2182 * If a users really wants to minimize the amount of copies, they can set this
2183 * flag and ensure their processing chain does not exhaust the surface pool.
2184 */
2185#define AV_HWACCEL_FLAG_UNSAFE_OUTPUT (1 << 3)
2186
2187/**
2188 * @}
2189 */
2190
2193
2194 SUBTITLE_BITMAP, ///< A bitmap, pict will be set
2195
2196 /**
2197 * Plain text, the text field must be set by the decoder and is
2198 * authoritative. ass and pict fields may contain approximations.
2199 */
2201
2202 /**
2203 * Formatted text, the ass field must be set by the decoder and is
2204 * authoritative. pict and text fields may contain approximations.
2205 */
2207};
2208
2209#define AV_SUBTITLE_FLAG_FORCED 0x00000001
2210
2211typedef struct AVSubtitleRect {
2212 int x; ///< top left corner of pict, undefined when pict is not set
2213 int y; ///< top left corner of pict, undefined when pict is not set
2214 int w; ///< width of pict, undefined when pict is not set
2215 int h; ///< height of pict, undefined when pict is not set
2216 int nb_colors; ///< number of colors in pict, undefined when pict is not set
2217
2218 /**
2219 * data+linesize for the bitmap of this subtitle.
2220 * Can be set for text/ass as well once they are rendered.
2221 */
2222 uint8_t *data[4];
2223 int linesize[4];
2224
2227
2228 char *text; ///< 0 terminated plain UTF-8 text
2229
2230 /**
2231 * 0 terminated ASS/SSA compatible event line.
2232 * The presentation of this is unaffected by the other values in this
2233 * struct.
2234 */
2235 char *ass;
2237
2238typedef struct AVSubtitle {
2239 uint16_t format; /* 0 = graphics */
2240 uint32_t start_display_time; /* relative to packet pts, in ms */
2241 uint32_t end_display_time; /* relative to packet pts, in ms */
2242 unsigned num_rects;
2244 int64_t pts; ///< Same as packet pts, in AV_TIME_BASE
2245} AVSubtitle;
2246
2247/**
2248 * Return the LIBAVCODEC_VERSION_INT constant.
2249 */
2250unsigned avcodec_version(void);
2251
2252/**
2253 * Return the libavcodec build-time configuration.
2254 */
2255const char *avcodec_configuration(void);
2256
2257/**
2258 * Return the libavcodec license.
2259 */
2260const char *avcodec_license(void);
2261
2262/**
2263 * Allocate an AVCodecContext and set its fields to default values. The
2264 * resulting struct should be freed with avcodec_free_context().
2265 *
2266 * @param codec if non-NULL, allocate private data and initialize defaults
2267 * for the given codec. It is illegal to then call avcodec_open2()
2268 * with a different codec.
2269 * If NULL, then the codec-specific defaults won't be initialized,
2270 * which may result in suboptimal default settings (this is
2271 * important mainly for encoders, e.g. libx264).
2272 *
2273 * @return An AVCodecContext filled with default values or NULL on failure.
2274 */
2276
2277/**
2278 * Free the codec context and everything associated with it and write NULL to
2279 * the provided pointer.
2280 */
2282
2283/**
2284 * Get the AVClass for AVCodecContext. It can be used in combination with
2285 * AV_OPT_SEARCH_FAKE_OBJ for examining options.
2286 *
2287 * @see av_opt_find().
2288 */
2290
2291/**
2292 * Get the AVClass for AVSubtitleRect. It can be used in combination with
2293 * AV_OPT_SEARCH_FAKE_OBJ for examining options.
2294 *
2295 * @see av_opt_find().
2296 */
2298
2299/**
2300 * Fill the parameters struct based on the values from the supplied codec
2301 * context. Any allocated fields in par are freed and replaced with duplicates
2302 * of the corresponding fields in codec.
2303 *
2304 * @return >= 0 on success, a negative AVERROR code on failure
2305 */
2307 const AVCodecContext *codec);
2308
2309/**
2310 * Fill the codec context based on the values from the supplied codec
2311 * parameters. Any allocated fields in codec that have a corresponding field in
2312 * par are freed and replaced with duplicates of the corresponding field in par.
2313 * Fields in codec that do not have a counterpart in par are not touched.
2314 *
2315 * @return >= 0 on success, a negative AVERROR code on failure.
2316 */
2318 const struct AVCodecParameters *par);
2319
2320/**
2321 * Initialize the AVCodecContext to use the given AVCodec. Prior to using this
2322 * function the context has to be allocated with avcodec_alloc_context3().
2323 *
2324 * The functions avcodec_find_decoder_by_name(), avcodec_find_encoder_by_name(),
2325 * avcodec_find_decoder() and avcodec_find_encoder() provide an easy way for
2326 * retrieving a codec.
2327 *
2328 * Depending on the codec, you might need to set options in the codec context
2329 * also for decoding (e.g. width, height, or the pixel or audio sample format in
2330 * the case the information is not available in the bitstream, as when decoding
2331 * raw audio or video).
2332 *
2333 * Options in the codec context can be set either by setting them in the options
2334 * AVDictionary, or by setting the values in the context itself, directly or by
2335 * using the av_opt_set() API before calling this function.
2336 *
2337 * Example:
2338 * @code
2339 * av_dict_set(&opts, "b", "2.5M", 0);
2340 * codec = avcodec_find_decoder(AV_CODEC_ID_H264);
2341 * if (!codec)
2342 * exit(1);
2343 *
2344 * context = avcodec_alloc_context3(codec);
2345 *
2346 * if (avcodec_open2(context, codec, opts) < 0)
2347 * exit(1);
2348 * @endcode
2349 *
2350 * In the case AVCodecParameters are available (e.g. when demuxing a stream
2351 * using libavformat, and accessing the AVStream contained in the demuxer), the
2352 * codec parameters can be copied to the codec context using
2353 * avcodec_parameters_to_context(), as in the following example:
2354 *
2355 * @code
2356 * AVStream *stream = ...;
2357 * context = avcodec_alloc_context3(codec);
2358 * if (avcodec_parameters_to_context(context, stream->codecpar) < 0)
2359 * exit(1);
2360 * if (avcodec_open2(context, codec, NULL) < 0)
2361 * exit(1);
2362 * @endcode
2363 *
2364 * @note Always call this function before using decoding routines (such as
2365 * @ref avcodec_receive_frame()).
2366 *
2367 * @param avctx The context to initialize.
2368 * @param codec The codec to open this context for. If a non-NULL codec has been
2369 * previously passed to avcodec_alloc_context3() or
2370 * for this context, then this parameter MUST be either NULL or
2371 * equal to the previously passed codec.
2372 * @param options A dictionary filled with AVCodecContext and codec-private
2373 * options, which are set on top of the options already set in
2374 * avctx, can be NULL. On return this object will be filled with
2375 * options that were not found in the avctx codec context.
2376 *
2377 * @return zero on success, a negative value on error
2378 * @see avcodec_alloc_context3(), avcodec_find_decoder(), avcodec_find_encoder(),
2379 * av_dict_set(), av_opt_set(), av_opt_find(), avcodec_parameters_to_context()
2380 */
2381int avcodec_open2(AVCodecContext *avctx, const AVCodec *codec, AVDictionary **options);
2382
2383#if FF_API_AVCODEC_CLOSE
2384/**
2385 * Close a given AVCodecContext and free all the data associated with it
2386 * (but not the AVCodecContext itself).
2387 *
2388 * Calling this function on an AVCodecContext that hasn't been opened will free
2389 * the codec-specific data allocated in avcodec_alloc_context3() with a non-NULL
2390 * codec. Subsequent calls will do nothing.
2391 *
2392 * @deprecated Do not use this function. Use avcodec_free_context() to destroy a
2393 * codec context (either open or closed). Opening and closing a codec context
2394 * multiple times is not supported anymore -- use multiple codec contexts
2395 * instead.
2396 */
2398int avcodec_close(AVCodecContext *avctx);
2399#endif
2400
2401/**
2402 * Free all allocated data in the given subtitle struct.
2403 *
2404 * @param sub AVSubtitle to free.
2405 */
2407
2408/**
2409 * @}
2410 */
2411
2412/**
2413 * @addtogroup lavc_decoding
2414 * @{
2415 */
2416
2417/**
2418 * The default callback for AVCodecContext.get_buffer2(). It is made public so
2419 * it can be called by custom get_buffer2() implementations for decoders without
2420 * AV_CODEC_CAP_DR1 set.
2421 */
2423
2424/**
2425 * The default callback for AVCodecContext.get_encode_buffer(). It is made public so
2426 * it can be called by custom get_encode_buffer() implementations for encoders without
2427 * AV_CODEC_CAP_DR1 set.
2428 */
2430
2431/**
2432 * Modify width and height values so that they will result in a memory
2433 * buffer that is acceptable for the codec if you do not use any horizontal
2434 * padding.
2435 *
2436 * May only be used if a codec with AV_CODEC_CAP_DR1 has been opened.
2437 */
2439
2440/**
2441 * Modify width and height values so that they will result in a memory
2442 * buffer that is acceptable for the codec if you also ensure that all
2443 * line sizes are a multiple of the respective linesize_align[i].
2444 *
2445 * May only be used if a codec with AV_CODEC_CAP_DR1 has been opened.
2446 */
2448 int linesize_align[AV_NUM_DATA_POINTERS]);
2449
2450/**
2451 * Decode a subtitle message.
2452 * Return a negative value on error, otherwise return the number of bytes used.
2453 * If no subtitle could be decompressed, got_sub_ptr is zero.
2454 * Otherwise, the subtitle is stored in *sub.
2455 * Note that AV_CODEC_CAP_DR1 is not available for subtitle codecs. This is for
2456 * simplicity, because the performance difference is expected to be negligible
2457 * and reusing a get_buffer written for video codecs would probably perform badly
2458 * due to a potentially very different allocation pattern.
2459 *
2460 * Some decoders (those marked with AV_CODEC_CAP_DELAY) have a delay between input
2461 * and output. This means that for some packets they will not immediately
2462 * produce decoded output and need to be flushed at the end of decoding to get
2463 * all the decoded data. Flushing is done by calling this function with packets
2464 * with avpkt->data set to NULL and avpkt->size set to 0 until it stops
2465 * returning subtitles. It is safe to flush even those decoders that are not
2466 * marked with AV_CODEC_CAP_DELAY, then no subtitles will be returned.
2467 *
2468 * @note The AVCodecContext MUST have been opened with @ref avcodec_open2()
2469 * before packets may be fed to the decoder.
2470 *
2471 * @param avctx the codec context
2472 * @param[out] sub The preallocated AVSubtitle in which the decoded subtitle will be stored,
2473 * must be freed with avsubtitle_free if *got_sub_ptr is set.
2474 * @param[in,out] got_sub_ptr Zero if no subtitle could be decompressed, otherwise, it is nonzero.
2475 * @param[in] avpkt The input AVPacket containing the input buffer.
2476 */
2478 int *got_sub_ptr, const AVPacket *avpkt);
2479
2480/**
2481 * Supply raw packet data as input to a decoder.
2482 *
2483 * Internally, this call will copy relevant AVCodecContext fields, which can
2484 * influence decoding per-packet, and apply them when the packet is actually
2485 * decoded. (For example AVCodecContext.skip_frame, which might direct the
2486 * decoder to drop the frame contained by the packet sent with this function.)
2487 *
2488 * @warning The input buffer, avpkt->data must be AV_INPUT_BUFFER_PADDING_SIZE
2489 * larger than the actual read bytes because some optimized bitstream
2490 * readers read 32 or 64 bits at once and could read over the end.
2491 *
2492 * @note The AVCodecContext MUST have been opened with @ref avcodec_open2()
2493 * before packets may be fed to the decoder.
2494 *
2495 * @param avctx codec context
2496 * @param[in] avpkt The input AVPacket. Usually, this will be a single video
2497 * frame, or several complete audio frames.
2498 * Ownership of the packet remains with the caller, and the
2499 * decoder will not write to the packet. The decoder may create
2500 * a reference to the packet data (or copy it if the packet is
2501 * not reference-counted).
2502 * Unlike with older APIs, the packet is always fully consumed,
2503 * and if it contains multiple frames (e.g. some audio codecs),
2504 * will require you to call avcodec_receive_frame() multiple
2505 * times afterwards before you can send a new packet.
2506 * It can be NULL (or an AVPacket with data set to NULL and
2507 * size set to 0); in this case, it is considered a flush
2508 * packet, which signals the end of the stream. Sending the
2509 * first flush packet will return success. Subsequent ones are
2510 * unnecessary and will return AVERROR_EOF. If the decoder
2511 * still has frames buffered, it will return them after sending
2512 * a flush packet.
2513 *
2514 * @retval 0 success
2515 * @retval AVERROR(EAGAIN) input is not accepted in the current state - user
2516 * must read output with avcodec_receive_frame() (once
2517 * all output is read, the packet should be resent,
2518 * and the call will not fail with EAGAIN).
2519 * @retval AVERROR_EOF the decoder has been flushed, and no new packets can be
2520 * sent to it (also returned if more than 1 flush
2521 * packet is sent)
2522 * @retval AVERROR(EINVAL) codec not opened, it is an encoder, or requires flush
2523 * @retval AVERROR(ENOMEM) failed to add packet to internal queue, or similar
2524 * @retval "another negative error code" legitimate decoding errors
2525 */
2527
2528/**
2529 * Return decoded output data from a decoder or encoder (when the
2530 * @ref AV_CODEC_FLAG_RECON_FRAME flag is used).
2531 *
2532 * @param avctx codec context
2533 * @param frame This will be set to a reference-counted video or audio
2534 * frame (depending on the decoder type) allocated by the
2535 * codec. Note that the function will always call
2536 * av_frame_unref(frame) before doing anything else.
2537 *
2538 * @retval 0 success, a frame was returned
2539 * @retval AVERROR(EAGAIN) output is not available in this state - user must
2540 * try to send new input
2541 * @retval AVERROR_EOF the codec has been fully flushed, and there will be
2542 * no more output frames
2543 * @retval AVERROR(EINVAL) codec not opened, or it is an encoder without the
2544 * @ref AV_CODEC_FLAG_RECON_FRAME flag enabled
2545 * @retval "other negative error code" legitimate decoding errors
2546 */
2548
2549/**
2550 * Supply a raw video or audio frame to the encoder. Use avcodec_receive_packet()
2551 * to retrieve buffered output packets.
2552 *
2553 * @param avctx codec context
2554 * @param[in] frame AVFrame containing the raw audio or video frame to be encoded.
2555 * Ownership of the frame remains with the caller, and the
2556 * encoder will not write to the frame. The encoder may create
2557 * a reference to the frame data (or copy it if the frame is
2558 * not reference-counted).
2559 * It can be NULL, in which case it is considered a flush
2560 * packet. This signals the end of the stream. If the encoder
2561 * still has packets buffered, it will return them after this
2562 * call. Once flushing mode has been entered, additional flush
2563 * packets are ignored, and sending frames will return
2564 * AVERROR_EOF.
2565 *
2566 * For audio:
2567 * If AV_CODEC_CAP_VARIABLE_FRAME_SIZE is set, then each frame
2568 * can have any number of samples.
2569 * If it is not set, frame->nb_samples must be equal to
2570 * avctx->frame_size for all frames except the last.
2571 * The final frame may be smaller than avctx->frame_size.
2572 * @retval 0 success
2573 * @retval AVERROR(EAGAIN) input is not accepted in the current state - user must
2574 * read output with avcodec_receive_packet() (once all
2575 * output is read, the packet should be resent, and the
2576 * call will not fail with EAGAIN).
2577 * @retval AVERROR_EOF the encoder has been flushed, and no new frames can
2578 * be sent to it
2579 * @retval AVERROR(EINVAL) codec not opened, it is a decoder, or requires flush
2580 * @retval AVERROR(ENOMEM) failed to add packet to internal queue, or similar
2581 * @retval "another negative error code" legitimate encoding errors
2582 */
2584
2585/**
2586 * Read encoded data from the encoder.
2587 *
2588 * @param avctx codec context
2589 * @param avpkt This will be set to a reference-counted packet allocated by the
2590 * encoder. Note that the function will always call
2591 * av_packet_unref(avpkt) before doing anything else.
2592 * @retval 0 success
2593 * @retval AVERROR(EAGAIN) output is not available in the current state - user must
2594 * try to send input
2595 * @retval AVERROR_EOF the encoder has been fully flushed, and there will be no
2596 * more output packets
2597 * @retval AVERROR(EINVAL) codec not opened, or it is a decoder
2598 * @retval "another negative error code" legitimate encoding errors
2599 */
2601
2602/**
2603 * Create and return a AVHWFramesContext with values adequate for hardware
2604 * decoding. This is meant to get called from the get_format callback, and is
2605 * a helper for preparing a AVHWFramesContext for AVCodecContext.hw_frames_ctx.
2606 * This API is for decoding with certain hardware acceleration modes/APIs only.
2607 *
2608 * The returned AVHWFramesContext is not initialized. The caller must do this
2609 * with av_hwframe_ctx_init().
2610 *
2611 * Calling this function is not a requirement, but makes it simpler to avoid
2612 * codec or hardware API specific details when manually allocating frames.
2613 *
2614 * Alternatively to this, an API user can set AVCodecContext.hw_device_ctx,
2615 * which sets up AVCodecContext.hw_frames_ctx fully automatically, and makes
2616 * it unnecessary to call this function or having to care about
2617 * AVHWFramesContext initialization at all.
2618 *
2619 * There are a number of requirements for calling this function:
2620 *
2621 * - It must be called from get_format with the same avctx parameter that was
2622 * passed to get_format. Calling it outside of get_format is not allowed, and
2623 * can trigger undefined behavior.
2624 * - The function is not always supported (see description of return values).
2625 * Even if this function returns successfully, hwaccel initialization could
2626 * fail later. (The degree to which implementations check whether the stream
2627 * is actually supported varies. Some do this check only after the user's
2628 * get_format callback returns.)
2629 * - The hw_pix_fmt must be one of the choices suggested by get_format. If the
2630 * user decides to use a AVHWFramesContext prepared with this API function,
2631 * the user must return the same hw_pix_fmt from get_format.
2632 * - The device_ref passed to this function must support the given hw_pix_fmt.
2633 * - After calling this API function, it is the user's responsibility to
2634 * initialize the AVHWFramesContext (returned by the out_frames_ref parameter),
2635 * and to set AVCodecContext.hw_frames_ctx to it. If done, this must be done
2636 * before returning from get_format (this is implied by the normal
2637 * AVCodecContext.hw_frames_ctx API rules).
2638 * - The AVHWFramesContext parameters may change every time time get_format is
2639 * called. Also, AVCodecContext.hw_frames_ctx is reset before get_format. So
2640 * you are inherently required to go through this process again on every
2641 * get_format call.
2642 * - It is perfectly possible to call this function without actually using
2643 * the resulting AVHWFramesContext. One use-case might be trying to reuse a
2644 * previously initialized AVHWFramesContext, and calling this API function
2645 * only to test whether the required frame parameters have changed.
2646 * - Fields that use dynamically allocated values of any kind must not be set
2647 * by the user unless setting them is explicitly allowed by the documentation.
2648 * If the user sets AVHWFramesContext.free and AVHWFramesContext.user_opaque,
2649 * the new free callback must call the potentially set previous free callback.
2650 * This API call may set any dynamically allocated fields, including the free
2651 * callback.
2652 *
2653 * The function will set at least the following fields on AVHWFramesContext
2654 * (potentially more, depending on hwaccel API):
2655 *
2656 * - All fields set by av_hwframe_ctx_alloc().
2657 * - Set the format field to hw_pix_fmt.
2658 * - Set the sw_format field to the most suited and most versatile format. (An
2659 * implication is that this will prefer generic formats over opaque formats
2660 * with arbitrary restrictions, if possible.)
2661 * - Set the width/height fields to the coded frame size, rounded up to the
2662 * API-specific minimum alignment.
2663 * - Only _if_ the hwaccel requires a pre-allocated pool: set the initial_pool_size
2664 * field to the number of maximum reference surfaces possible with the codec,
2665 * plus 1 surface for the user to work (meaning the user can safely reference
2666 * at most 1 decoded surface at a time), plus additional buffering introduced
2667 * by frame threading. If the hwaccel does not require pre-allocation, the
2668 * field is left to 0, and the decoder will allocate new surfaces on demand
2669 * during decoding.
2670 * - Possibly AVHWFramesContext.hwctx fields, depending on the underlying
2671 * hardware API.
2672 *
2673 * Essentially, out_frames_ref returns the same as av_hwframe_ctx_alloc(), but
2674 * with basic frame parameters set.
2675 *
2676 * The function is stateless, and does not change the AVCodecContext or the
2677 * device_ref AVHWDeviceContext.
2678 *
2679 * @param avctx The context which is currently calling get_format, and which
2680 * implicitly contains all state needed for filling the returned
2681 * AVHWFramesContext properly.
2682 * @param device_ref A reference to the AVHWDeviceContext describing the device
2683 * which will be used by the hardware decoder.
2684 * @param hw_pix_fmt The hwaccel format you are going to return from get_format.
2685 * @param out_frames_ref On success, set to a reference to an _uninitialized_
2686 * AVHWFramesContext, created from the given device_ref.
2687 * Fields will be set to values required for decoding.
2688 * Not changed if an error is returned.
2689 * @return zero on success, a negative value on error. The following error codes
2690 * have special semantics:
2691 * AVERROR(ENOENT): the decoder does not support this functionality. Setup
2692 * is always manual, or it is a decoder which does not
2693 * support setting AVCodecContext.hw_frames_ctx at all,
2694 * or it is a software format.
2695 * AVERROR(EINVAL): it is known that hardware decoding is not supported for
2696 * this configuration, or the device_ref is not supported
2697 * for the hwaccel referenced by hw_pix_fmt.
2698 */
2700 AVBufferRef *device_ref,
2702 AVBufferRef **out_frames_ref);
2703
2705 AV_CODEC_CONFIG_PIX_FORMAT, ///< AVPixelFormat, terminated by AV_PIX_FMT_NONE
2706 AV_CODEC_CONFIG_FRAME_RATE, ///< AVRational, terminated by {0, 0}
2707 AV_CODEC_CONFIG_SAMPLE_RATE, ///< int, terminated by 0
2708 AV_CODEC_CONFIG_SAMPLE_FORMAT, ///< AVSampleFormat, terminated by AV_SAMPLE_FMT_NONE
2709 AV_CODEC_CONFIG_CHANNEL_LAYOUT, ///< AVChannelLayout, terminated by {0}
2710 AV_CODEC_CONFIG_COLOR_RANGE, ///< AVColorRange, terminated by AVCOL_RANGE_UNSPECIFIED
2711 AV_CODEC_CONFIG_COLOR_SPACE, ///< AVColorSpace, terminated by AVCOL_SPC_UNSPECIFIED
2712};
2713
2714/**
2715 * Retrieve a list of all supported values for a given configuration type.
2716 *
2717 * @param avctx An optional context to use. Values such as
2718 * `strict_std_compliance` may affect the result. If NULL,
2719 * default values are used.
2720 * @param codec The codec to query, or NULL to use avctx->codec.
2721 * @param config The configuration to query.
2722 * @param flags Currently unused; should be set to zero.
2723 * @param out_configs On success, set to a list of configurations, terminated
2724 * by a config-specific terminator, or NULL if all
2725 * possible values are supported.
2726 * @param out_num_configs On success, set to the number of elements in
2727 *out_configs, excluding the terminator. Optional.
2728 */
2730 const AVCodec *codec, enum AVCodecConfig config,
2731 unsigned flags, const void **out_configs,
2732 int *out_num_configs);
2733
2734
2735
2736/**
2737 * @defgroup lavc_parsing Frame parsing
2738 * @{
2739 */
2740
2743 AV_PICTURE_STRUCTURE_TOP_FIELD, ///< coded as top field
2744 AV_PICTURE_STRUCTURE_BOTTOM_FIELD, ///< coded as bottom field
2745 AV_PICTURE_STRUCTURE_FRAME, ///< coded as frame
2746};
2747
2748typedef struct AVCodecParserContext {
2750 const struct AVCodecParser *parser;
2751 int64_t frame_offset; /* offset of the current frame */
2752 int64_t cur_offset; /* current offset
2753 (incremented by each av_parser_parse()) */
2754 int64_t next_frame_offset; /* offset of the next frame */
2755 /* video info */
2756 int pict_type; /* XXX: Put it back in AVCodecContext. */
2757 /**
2758 * This field is used for proper frame duration computation in lavf.
2759 * It signals, how much longer the frame duration of the current frame
2760 * is compared to normal frame duration.
2761 *
2762 * frame_duration = (1 + repeat_pict) * time_base
2763 *
2764 * It is used by codecs like H.264 to display telecined material.
2765 */
2766 int repeat_pict; /* XXX: Put it back in AVCodecContext. */
2767 int64_t pts; /* pts of the current frame */
2768 int64_t dts; /* dts of the current frame */
2769
2770 /* private data */
2771 int64_t last_pts;
2772 int64_t last_dts;
2774
2775#define AV_PARSER_PTS_NB 4
2780
2782#define PARSER_FLAG_COMPLETE_FRAMES 0x0001
2783#define PARSER_FLAG_ONCE 0x0002
2784/// Set if the parser has a valid file offset
2785#define PARSER_FLAG_FETCHED_OFFSET 0x0004
2786#define PARSER_FLAG_USE_CODEC_TS 0x1000
2787
2788 int64_t offset; ///< byte offset from starting packet start
2790
2791 /**
2792 * Set by parser to 1 for key frames and 0 for non-key frames.
2793 * It is initialized to -1, so if the parser doesn't set this flag,
2794 * old-style fallback using AV_PICTURE_TYPE_I picture type as key frames
2795 * will be used.
2796 */
2798
2799 // Timestamp generation support:
2800 /**
2801 * Synchronization point for start of timestamp generation.
2802 *
2803 * Set to >0 for sync point, 0 for no sync point and <0 for undefined
2804 * (default).
2805 *
2806 * For example, this corresponds to presence of H.264 buffering period
2807 * SEI message.
2808 */
2810
2811 /**
2812 * Offset of the current timestamp against last timestamp sync point in
2813 * units of AVCodecContext.time_base.
2814 *
2815 * Set to INT_MIN when dts_sync_point unused. Otherwise, it must
2816 * contain a valid timestamp offset.
2817 *
2818 * Note that the timestamp of sync point has usually a nonzero
2819 * dts_ref_dts_delta, which refers to the previous sync point. Offset of
2820 * the next frame after timestamp sync point will be usually 1.
2821 *
2822 * For example, this corresponds to H.264 cpb_removal_delay.
2823 */
2825
2826 /**
2827 * Presentation delay of current frame in units of AVCodecContext.time_base.
2828 *
2829 * Set to INT_MIN when dts_sync_point unused. Otherwise, it must
2830 * contain valid non-negative timestamp delta (presentation time of a frame
2831 * must not lie in the past).
2832 *
2833 * This delay represents the difference between decoding and presentation
2834 * time of the frame.
2835 *
2836 * For example, this corresponds to H.264 dpb_output_delay.
2837 */
2839
2840 /**
2841 * Position of the packet in file.
2842 *
2843 * Analogous to cur_frame_pts/dts
2844 */
2846
2847 /**
2848 * Byte position of currently parsed frame in stream.
2849 */
2850 int64_t pos;
2851
2852 /**
2853 * Previous frame byte position.
2854 */
2855 int64_t last_pos;
2856
2857 /**
2858 * Duration of the current frame.
2859 * For audio, this is in units of 1 / AVCodecContext.sample_rate.
2860 * For all other types, this is in units of AVCodecContext.time_base.
2861 */
2863
2865
2866 /**
2867 * Indicate whether a picture is coded as a frame, top field or bottom field.
2868 *
2869 * For example, H.264 field_pic_flag equal to 0 corresponds to
2870 * AV_PICTURE_STRUCTURE_FRAME. An H.264 picture with field_pic_flag
2871 * equal to 1 and bottom_field_flag equal to 0 corresponds to
2872 * AV_PICTURE_STRUCTURE_TOP_FIELD.
2873 */
2875
2876 /**
2877 * Picture number incremented in presentation or output order.
2878 * This field may be reinitialized at the first picture of a new sequence.
2879 *
2880 * For example, this corresponds to H.264 PicOrderCnt.
2881 */
2883
2884 /**
2885 * Dimensions of the decoded video intended for presentation.
2886 */
2889
2890 /**
2891 * Dimensions of the coded video.
2892 */
2895
2896 /**
2897 * The format of the coded data, corresponds to enum AVPixelFormat for video
2898 * and for enum AVSampleFormat for audio.
2899 *
2900 * Note that a decoder can have considerable freedom in how exactly it
2901 * decodes the data, so the format reported here might be different from the
2902 * one returned by a decoder.
2903 */
2906
2907typedef struct AVCodecParser {
2908 int codec_ids[7]; /* several codec IDs are permitted */
2911 /* This callback never returns an error, a negative value means that
2912 * the frame start was in a previous packet. */
2914 AVCodecContext *avctx,
2915 const uint8_t **poutbuf, int *poutbuf_size,
2916 const uint8_t *buf, int buf_size);
2918 int (*split)(AVCodecContext *avctx, const uint8_t *buf, int buf_size);
2920
2921/**
2922 * Iterate over all registered codec parsers.
2923 *
2924 * @param opaque a pointer where libavcodec will store the iteration state. Must
2925 * point to NULL to start the iteration.
2926 *
2927 * @return the next registered codec parser or NULL when the iteration is
2928 * finished
2929 */
2930const AVCodecParser *av_parser_iterate(void **opaque);
2931
2933
2934/**
2935 * Parse a packet.
2936 *
2937 * @param s parser context.
2938 * @param avctx codec context.
2939 * @param poutbuf set to pointer to parsed buffer or NULL if not yet finished.
2940 * @param poutbuf_size set to size of parsed buffer or zero if not yet finished.
2941 * @param buf input buffer.
2942 * @param buf_size buffer size in bytes without the padding. I.e. the full buffer
2943 size is assumed to be buf_size + AV_INPUT_BUFFER_PADDING_SIZE.
2944 To signal EOF, this should be 0 (so that the last frame
2945 can be output).
2946 * @param pts input presentation timestamp.
2947 * @param dts input decoding timestamp.
2948 * @param pos input byte position in stream.
2949 * @return the number of bytes of the input bitstream used.
2950 *
2951 * Example:
2952 * @code
2953 * while(in_len){
2954 * len = av_parser_parse2(myparser, AVCodecContext, &data, &size,
2955 * in_data, in_len,
2956 * pts, dts, pos);
2957 * in_data += len;
2958 * in_len -= len;
2959 *
2960 * if(size)
2961 * decode_frame(data, size);
2962 * }
2963 * @endcode
2964 */
2966 AVCodecContext *avctx,
2967 uint8_t **poutbuf, int *poutbuf_size,
2968 const uint8_t *buf, int buf_size,
2969 int64_t pts, int64_t dts,
2970 int64_t pos);
2971
2973
2974/**
2975 * @}
2976 * @}
2977 */
2978
2979/**
2980 * @addtogroup lavc_encoding
2981 * @{
2982 */
2983
2984int avcodec_encode_subtitle(AVCodecContext *avctx, uint8_t *buf, int buf_size,
2985 const AVSubtitle *sub);
2986
2987
2988/**
2989 * @}
2990 */
2991
2992/**
2993 * @defgroup lavc_misc Utility functions
2994 * @ingroup libavc
2995 *
2996 * Miscellaneous utility functions related to both encoding and decoding
2997 * (or neither).
2998 * @{
2999 */
3000
3001/**
3002 * @defgroup lavc_misc_pixfmt Pixel formats
3003 *
3004 * Functions for working with pixel formats.
3005 * @{
3006 */
3007
3008/**
3009 * Return a value representing the fourCC code associated to the
3010 * pixel format pix_fmt, or 0 if no associated fourCC code can be
3011 * found.
3012 */
3014
3015/**
3016 * Find the best pixel format to convert to given a certain source pixel
3017 * format. When converting from one pixel format to another, information loss
3018 * may occur. For example, when converting from RGB24 to GRAY, the color
3019 * information will be lost. Similarly, other losses occur when converting from
3020 * some formats to other formats. avcodec_find_best_pix_fmt_of_2() searches which of
3021 * the given pixel formats should be used to suffer the least amount of loss.
3022 * The pixel formats from which it chooses one, are determined by the
3023 * pix_fmt_list parameter.
3024 *
3025 *
3026 * @param[in] pix_fmt_list AV_PIX_FMT_NONE terminated array of pixel formats to choose from
3027 * @param[in] src_pix_fmt source pixel format
3028 * @param[in] has_alpha Whether the source pixel format alpha channel is used.
3029 * @param[out] loss_ptr Combination of flags informing you what kind of losses will occur.
3030 * @return The best pixel format to convert to or -1 if none was found.
3031 */
3033 enum AVPixelFormat src_pix_fmt,
3034 int has_alpha, int *loss_ptr);
3035
3037
3038/**
3039 * @}
3040 */
3041
3042void avcodec_string(char *buf, int buf_size, AVCodecContext *enc, int encode);
3043
3044int avcodec_default_execute(AVCodecContext *c, int (*func)(AVCodecContext *c2, void *arg2),void *arg, int *ret, int count, int size);
3045int avcodec_default_execute2(AVCodecContext *c, int (*func)(AVCodecContext *c2, void *arg2, int, int),void *arg, int *ret, int count);
3046//FIXME func typedef
3047
3048/**
3049 * Fill AVFrame audio data and linesize pointers.
3050 *
3051 * The buffer buf must be a preallocated buffer with a size big enough
3052 * to contain the specified samples amount. The filled AVFrame data
3053 * pointers will point to this buffer.
3054 *
3055 * AVFrame extended_data channel pointers are allocated if necessary for
3056 * planar audio.
3057 *
3058 * @param frame the AVFrame
3059 * frame->nb_samples must be set prior to calling the
3060 * function. This function fills in frame->data,
3061 * frame->extended_data, frame->linesize[0].
3062 * @param nb_channels channel count
3063 * @param sample_fmt sample format
3064 * @param buf buffer to use for frame data
3065 * @param buf_size size of buffer
3066 * @param align plane size sample alignment (0 = default)
3067 * @return >=0 on success, negative error code on failure
3068 * @todo return the size in bytes required to store the samples in
3069 * case of success, at the next libavutil bump
3070 */
3072 enum AVSampleFormat sample_fmt, const uint8_t *buf,
3073 int buf_size, int align);
3074
3075/**
3076 * Reset the internal codec state / flush internal buffers. Should be called
3077 * e.g. when seeking or when switching to a different stream.
3078 *
3079 * @note for decoders, this function just releases any references the decoder
3080 * might keep internally, but the caller's references remain valid.
3081 *
3082 * @note for encoders, this function will only do something if the encoder
3083 * declares support for AV_CODEC_CAP_ENCODER_FLUSH. When called, the encoder
3084 * will drain any remaining packets, and can then be re-used for a different
3085 * stream (as opposed to sending a null frame which will leave the encoder
3086 * in a permanent EOF state after draining). This can be desirable if the
3087 * cost of tearing down and replacing the encoder instance is high.
3088 */
3090
3091/**
3092 * Return audio frame duration.
3093 *
3094 * @param avctx codec context
3095 * @param frame_bytes size of the frame, or 0 if unknown
3096 * @return frame duration, in samples, if known. 0 if not able to
3097 * determine.
3098 */
3099int av_get_audio_frame_duration(AVCodecContext *avctx, int frame_bytes);
3100
3101/* memory */
3102
3103/**
3104 * Same behaviour av_fast_malloc but the buffer has additional
3105 * AV_INPUT_BUFFER_PADDING_SIZE at the end which will always be 0.
3106 *
3107 * In addition the whole buffer will initially and after resizes
3108 * be 0-initialized so that no uninitialized data will ever appear.
3109 */
3110void av_fast_padded_malloc(void *ptr, unsigned int *size, size_t min_size);
3111
3112/**
3113 * Same behaviour av_fast_padded_malloc except that buffer will always
3114 * be 0-initialized after call.
3115 */
3116void av_fast_padded_mallocz(void *ptr, unsigned int *size, size_t min_size);
3117
3118/**
3119 * @return a positive value if s is open (i.e. avcodec_open2() was called on it
3120 * with no corresponding avcodec_close()), 0 otherwise.
3121 */
3123
3124/**
3125 * @}
3126 */
3127
3128#endif /* AVCODEC_AVCODEC_H */
Macro definitions for various function/variable attributes.
#define attribute_deprecated
Definition attributes.h:100
#define AV_PARSER_PTS_NB
Definition avcodec.h:2775
Convenience header that includes libavutil's core.
refcounted data buffer API
Public libavutil channel layout APIs header.
Misc types and constants that do not belong anywhere else.
AVFieldOrder
Definition defs.h:200
AVAudioServiceType
Definition defs.h:224
static int width
static AVPacket * pkt
static enum AVPixelFormat pix_fmt
static int height
static AVFrame * frame
Public dictionary API.
static void encode(AVCodecContext *ctx, AVFrame *frame, AVPacket *pkt, FILE *output)
reference-counted frame API
#define AV_NUM_DATA_POINTERS
Definition frame.h:390
int avcodec_open2(AVCodecContext *avctx, const AVCodec *codec, AVDictionary **options)
Initialize the AVCodecContext to use the given AVCodec.
const AVClass * avcodec_get_class(void)
Get the AVClass for AVCodecContext.
const AVClass * avcodec_get_subtitle_rect_class(void)
Get the AVClass for AVSubtitleRect.
AVCodecContext * avcodec_alloc_context3(const AVCodec *codec)
Allocate an AVCodecContext and set its fields to default values.
int avcodec_parameters_from_context(struct AVCodecParameters *par, const AVCodecContext *codec)
Fill the parameters struct based on the values from the supplied codec context.
AVSubtitleType
Definition avcodec.h:2191
int avcodec_parameters_to_context(AVCodecContext *codec, const struct AVCodecParameters *par)
Fill the codec context based on the values from the supplied codec parameters.
void avsubtitle_free(AVSubtitle *sub)
Free all allocated data in the given subtitle struct.
AVCodecID
Identify the syntax and semantics of the bitstream.
Definition codec_id.h:49
const char * avcodec_license(void)
Return the libavcodec license.
unsigned avcodec_version(void)
Return the LIBAVCODEC_VERSION_INT constant.
const char * avcodec_configuration(void)
Return the libavcodec build-time configuration.
void avcodec_free_context(AVCodecContext **avctx)
Free the codec context and everything associated with it and write NULL to the provided pointer.
@ SUBTITLE_BITMAP
A bitmap, pict will be set.
Definition avcodec.h:2194
@ SUBTITLE_ASS
Formatted text, the ass field must be set by the decoder and is authoritative.
Definition avcodec.h:2206
@ SUBTITLE_TEXT
Plain text, the text field must be set by the decoder and is authoritative.
Definition avcodec.h:2200
@ SUBTITLE_NONE
Definition avcodec.h:2192
int avcodec_default_get_buffer2(AVCodecContext *s, AVFrame *frame, int flags)
The default callback for AVCodecContext.get_buffer2().
int avcodec_receive_frame(AVCodecContext *avctx, AVFrame *frame)
Return decoded output data from a decoder or encoder (when the AV_CODEC_FLAG_RECON_FRAME flag is used...
void avcodec_align_dimensions2(AVCodecContext *s, int *width, int *height, int linesize_align[AV_NUM_DATA_POINTERS])
Modify width and height values so that they will result in a memory buffer that is acceptable for the...
AVDiscard
Definition defs.h:212
void avcodec_align_dimensions(AVCodecContext *s, int *width, int *height)
Modify width and height values so that they will result in a memory buffer that is acceptable for the...
int avcodec_send_packet(AVCodecContext *avctx, const AVPacket *avpkt)
Supply raw packet data as input to a decoder.
int avcodec_receive_packet(AVCodecContext *avctx, AVPacket *avpkt)
Read encoded data from the encoder.
int avcodec_decode_subtitle2(AVCodecContext *avctx, AVSubtitle *sub, int *got_sub_ptr, const AVPacket *avpkt)
Decode a subtitle message.
int avcodec_get_hw_frames_parameters(AVCodecContext *avctx, AVBufferRef *device_ref, enum AVPixelFormat hw_pix_fmt, AVBufferRef **out_frames_ref)
Create and return a AVHWFramesContext with values adequate for hardware decoding.
int avcodec_send_frame(AVCodecContext *avctx, const AVFrame *frame)
Supply a raw video or audio frame to the encoder.
AVCodecConfig
Definition avcodec.h:2704
int avcodec_default_get_encode_buffer(AVCodecContext *s, AVPacket *pkt, int flags)
The default callback for AVCodecContext.get_encode_buffer().
int avcodec_get_supported_config(const AVCodecContext *avctx, const AVCodec *codec, enum AVCodecConfig config, unsigned flags, const void **out_configs, int *out_num_configs)
Retrieve a list of all supported values for a given configuration type.
@ AV_CODEC_CONFIG_PIX_FORMAT
AVPixelFormat, terminated by AV_PIX_FMT_NONE.
Definition avcodec.h:2705
@ AV_CODEC_CONFIG_SAMPLE_FORMAT
AVSampleFormat, terminated by AV_SAMPLE_FMT_NONE.
Definition avcodec.h:2708
@ AV_CODEC_CONFIG_FRAME_RATE
AVRational, terminated by {0, 0}.
Definition avcodec.h:2706
@ AV_CODEC_CONFIG_COLOR_SPACE
AVColorSpace, terminated by AVCOL_SPC_UNSPECIFIED.
Definition avcodec.h:2711
@ AV_CODEC_CONFIG_COLOR_RANGE
AVColorRange, terminated by AVCOL_RANGE_UNSPECIFIED.
Definition avcodec.h:2710
@ AV_CODEC_CONFIG_SAMPLE_RATE
int, terminated by 0
Definition avcodec.h:2707
@ AV_CODEC_CONFIG_CHANNEL_LAYOUT
AVChannelLayout, terminated by {0}.
Definition avcodec.h:2709
int avcodec_encode_subtitle(AVCodecContext *avctx, uint8_t *buf, int buf_size, const AVSubtitle *sub)
enum AVPixelFormat avcodec_default_get_format(struct AVCodecContext *s, const enum AVPixelFormat *fmt)
unsigned int avcodec_pix_fmt_to_codec_tag(enum AVPixelFormat pix_fmt)
Return a value representing the fourCC code associated to the pixel format pix_fmt,...
enum AVPixelFormat avcodec_find_best_pix_fmt_of_list(const enum AVPixelFormat *pix_fmt_list, enum AVPixelFormat src_pix_fmt, int has_alpha, int *loss_ptr)
Find the best pixel format to convert to given a certain source pixel format.
void av_fast_padded_malloc(void *ptr, unsigned int *size, size_t min_size)
Same behaviour av_fast_malloc but the buffer has additional AV_INPUT_BUFFER_PADDING_SIZE at the end w...
int av_get_audio_frame_duration(AVCodecContext *avctx, int frame_bytes)
Return audio frame duration.
int avcodec_default_execute2(AVCodecContext *c, int(*func)(AVCodecContext *c2, void *arg2, int, int), void *arg, int *ret, int count)
int avcodec_fill_audio_frame(AVFrame *frame, int nb_channels, enum AVSampleFormat sample_fmt, const uint8_t *buf, int buf_size, int align)
Fill AVFrame audio data and linesize pointers.
void avcodec_string(char *buf, int buf_size, AVCodecContext *enc, int encode)
int avcodec_is_open(AVCodecContext *s)
int avcodec_default_execute(AVCodecContext *c, int(*func)(AVCodecContext *c2, void *arg2), void *arg, int *ret, int count, int size)
void av_fast_padded_mallocz(void *ptr, unsigned int *size, size_t min_size)
Same behaviour av_fast_padded_malloc except that buffer will always be 0-initialized after call.
void avcodec_flush_buffers(AVCodecContext *avctx)
Reset the internal codec state / flush internal buffers.
void av_parser_close(AVCodecParserContext *s)
int av_parser_parse2(AVCodecParserContext *s, AVCodecContext *avctx, uint8_t **poutbuf, int *poutbuf_size, const uint8_t *buf, int buf_size, int64_t pts, int64_t dts, int64_t pos)
Parse a packet.
AVCodecParserContext * av_parser_init(int codec_id)
const AVCodecParser * av_parser_iterate(void **opaque)
Iterate over all registered codec parsers.
AVPictureStructure
Definition avcodec.h:2741
@ AV_PICTURE_STRUCTURE_FRAME
coded as frame
Definition avcodec.h:2745
@ AV_PICTURE_STRUCTURE_BOTTOM_FIELD
coded as bottom field
Definition avcodec.h:2744
@ AV_PICTURE_STRUCTURE_TOP_FIELD
coded as top field
Definition avcodec.h:2743
@ AV_PICTURE_STRUCTURE_UNKNOWN
unknown
Definition avcodec.h:2742
struct AVDictionary AVDictionary
Definition dict.h:94
AVMediaType
Definition avutil.h:199
AVSampleFormat
Audio sample formats.
Definition samplefmt.h:55
static enum AVPixelFormat hw_pix_fmt
Definition hw_decode.c:46
swscale version macros
swscale version macros
pixel format definitions
AVChromaLocation
Location of chroma samples.
Definition pixfmt.h:705
AVColorRange
Visual content value range.
Definition pixfmt.h:651
AVPixelFormat
Pixel format.
Definition pixfmt.h:71
AVColorPrimaries
Chromaticity coordinates of the source primaries.
Definition pixfmt.h:555
AVColorTransferCharacteristic
Color Transfer Characteristic.
Definition pixfmt.h:580
AVColorSpace
YUV colorspace type.
Definition pixfmt.h:609
Utilties for rational number calculation.
A reference to a data buffer.
Definition buffer.h:82
An AVChannelLayout holds information about the channel layout of audio data.
Describe the class of an AVClass context structure.
Definition log.h:66
main external API structure.
Definition avcodec.h:451
int nsse_weight
noise vs.
Definition avcodec.h:875
float rc_max_available_vbv_use
Ratecontrol attempt to use, at maximum, of what can be used without an underflow.
Definition avcodec.h:1316
int skip_top
Number of macroblock rows at the top which are skipped.
Definition avcodec.h:1851
int trellis
trellis RD quantization
Definition avcodec.h:1337
int * side_data_prefer_packet
Decoding only.
Definition avcodec.h:2071
enum AVPixelFormat pix_fmt
Pixel format, see AV_PIX_FMT_xxx.
Definition avcodec.h:663
int max_qdiff
maximum quantizer difference between frames
Definition avcodec.h:1280
uint16_t * chroma_intra_matrix
custom intra quantization matrix
Definition avcodec.h:996
int hwaccel_flags
Bit set of AV_HWACCEL_FLAG_* flags, which affect hardware accelerated decoding (if active).
Definition avcodec.h:1516
int subtitle_header_size
Header containing style information for text subtitles.
Definition avcodec.h:1901
int width
picture width / height.
Definition avcodec.h:624
AVPacketSideData * coded_side_data
Additional data associated with the entire coded stream.
Definition avcodec.h:1926
char * stats_out
pass1 encoding statistics output buffer
Definition avcodec.h:1344
const struct AVCodecDescriptor * codec_descriptor
AVCodecDescriptor.
Definition avcodec.h:1872
int rc_buffer_size
decoder bitstream buffer size
Definition avcodec.h:1287
AVChannelLayout ch_layout
Audio channel layout.
Definition avcodec.h:1071
int me_cmp
motion estimation comparison function
Definition avcodec.h:882
int flags2
AV_CODEC_FLAG2_*.
Definition avcodec.h:515
enum AVSampleFormat sample_fmt
audio sample format
Definition avcodec.h:1063
int debug
debug
Definition avcodec.h:1406
enum AVPixelFormat sw_pix_fmt
Nominal unaccelerated pixel format, see AV_PIX_FMT_xxx.
Definition avcodec.h:670
int global_quality
Global quality for codecs which cannot change it per frame.
Definition avcodec.h:1249
int64_t max_pixels
The number of pixels per image to maximally accept.
Definition avcodec.h:1945
enum AVColorRange color_range
MPEG vs JPEG YUV range.
Definition avcodec.h:701
char * sub_charenc
Character encoding of the input subtitles file.
Definition avcodec.h:1879
int error_concealment
error concealment flags
Definition avcodec.h:1396
int dct_algo
DCT algorithm, see FF_DCT_* below.
Definition avcodec.h:1544
unsigned int codec_tag
fourcc (LSB first, so "ABCD" -> ('D'<<24) + ('C'<<16) + ('B'<<8) + 'A').
Definition avcodec.h:476
int slice_flags
slice flags
Definition avcodec.h:736
int strict_std_compliance
strictly follow the standard (MPEG-4, ...).
Definition avcodec.h:1389
float b_quant_offset
qscale offset between IP and B-frames
Definition avcodec.h:817
int nb_coded_side_data
Definition avcodec.h:1927
AVRational pkt_timebase
Timebase in which pkt_dts/pts and AVPacket.dts/pts are expressed.
Definition avcodec.h:557
enum AVPixelFormat(* get_format)(struct AVCodecContext *s, const enum AVPixelFormat *fmt)
Callback to negotiate the pixel format.
Definition avcodec.h:793
enum AVAudioServiceType audio_service_type
Type of service that the audio stream conveys.
Definition avcodec.h:1103
enum AVColorPrimaries color_primaries
Chromaticity coordinates of the source primaries.
Definition avcodec.h:677
int me_subpel_quality
subpel ME quality
Definition avcodec.h:952
AVBufferRef * hw_frames_ctx
A reference to the AVHWFramesContext describing the input (for encoding) or output (decoding) frames.
Definition avcodec.h:1485
int max_b_frames
maximum number of B-frames between non-B-frames Note: The output will be delayed by max_b_frames+1 re...
Definition avcodec.h:801
int mb_lmax
maximum MB Lagrange multiplier
Definition avcodec.h:1017
int qmin
minimum quantizer
Definition avcodec.h:1266
int keyint_min
minimum GOP size
Definition avcodec.h:1030
enum AVMediaType codec_type
Definition avcodec.h:459
float b_quant_factor
qscale factor between IP and B-frames If > 0 then the last P-frame quantizer will be used (q= lastp_q...
Definition avcodec.h:810
int dia_size
ME diamond size & shape.
Definition avcodec.h:924
int64_t frame_num
Frame counter, set by libavcodec.
Definition avcodec.h:2041
int workaround_bugs
Work around bugs in encoders which sometimes cannot be detected automatically.
Definition avcodec.h:1359
int apply_cropping
Video decoding only.
Definition avcodec.h:1972
AVRational framerate
Definition avcodec.h:566
char * stats_in
pass2 encoding statistics input buffer Concatenated stuff from stats_out of pass1 should be placed he...
Definition avcodec.h:1352
AVRational sample_aspect_ratio
sample aspect ratio (0 if unknown) That is the width of a pixel divided by the height of the pixel.
Definition avcodec.h:648
int bits_per_coded_sample
bits per sample/pixel from the demuxer (needed for huffyuv).
Definition avcodec.h:1578
int rc_override_count
ratecontrol override, see RcOverride
Definition avcodec.h:1294
uint8_t * dump_separator
dump format separator.
Definition avcodec.h:1910
enum AVFieldOrder field_order
Field order.
Definition avcodec.h:714
uint16_t * inter_matrix
custom inter quantization matrix Must be allocated with the av_malloc() family of functions,...
Definition avcodec.h:989
const struct AVHWAccel * hwaccel
Hardware accelerator in use.
Definition avcodec.h:1437
int active_thread_type
Which multithreading methods are in use by the codec.
Definition avcodec.h:1612
int(* get_encode_buffer)(struct AVCodecContext *s, AVPacket *pkt, int flags)
This callback is called at the beginning of each packet to get a data buffer for it.
Definition avcodec.h:2030
int sub_charenc_mode
Subtitles character encoding mode.
Definition avcodec.h:1887
int bit_rate_tolerance
number of bits the bitstream is allowed to diverge from the reference.
Definition avcodec.h:1241
int mb_decision
macroblock decision mode
Definition avcodec.h:968
int has_b_frames
Size of the frame reordering buffer in the decoder.
Definition avcodec.h:729
char * codec_whitelist
',' separated list of allowed decoders.
Definition avcodec.h:1918
int level
Encoding level descriptor.
Definition avcodec.h:1794
void(* draw_horiz_band)(struct AVCodecContext *s, const AVFrame *src, int offset[AV_NUM_DATA_POINTERS], int y, int type, int height)
If non NULL, 'draw_horiz_band' is called by the libavcodec decoder to draw a horizontal band.
Definition avcodec.h:764
int64_t bit_rate
the average bitrate
Definition avcodec.h:501
enum AVDiscard skip_loop_filter
Skip loop filtering for selected frames.
Definition avcodec.h:1816
const struct AVCodec * codec
Definition avcodec.h:460
int rc_initial_buffer_occupancy
Number of bits which should be loaded into the rc buffer before decoding starts.
Definition avcodec.h:1330
int thread_type
Which multithreading methods to use.
Definition avcodec.h:1603
int me_sub_cmp
subpixel motion estimation comparison function
Definition avcodec.h:888
int profile
profile
Definition avcodec.h:1650
unsigned properties
Properties of the stream that gets decoded.
Definition avcodec.h:1806
int last_predictor_count
amount of previous MV predictors (2a+1 x 2a+1 square)
Definition avcodec.h:931
int log_level_offset
Definition avcodec.h:457
int(* execute)(struct AVCodecContext *c, int(*func)(struct AVCodecContext *c2, void *arg), void *arg2, int *ret, int count, int size)
The codec may call this to execute several independent things.
Definition avcodec.h:1623
int nb_decoded_side_data
Definition avcodec.h:2088
int bits_per_raw_sample
Bits per sample/pixel of internal libavcodec pixel/sample format.
Definition avcodec.h:1585
int idct_algo
IDCT algorithm, see FF_IDCT_* below.
Definition avcodec.h:1558
int export_side_data
Bit set of AV_CODEC_EXPORT_DATA_* flags, which affects the kind of metadata exported in frame,...
Definition avcodec.h:1937
enum AVColorSpace colorspace
YUV colorspace type.
Definition avcodec.h:691
enum AVSampleFormat request_sample_fmt
desired sample format
Definition avcodec.h:1111
int initial_padding
Audio only.
Definition avcodec.h:1128
float temporal_cplx_masking
temporary complexity masking (0-> disabled)
Definition avcodec.h:847
int sample_rate
samples per second
Definition avcodec.h:1056
const AVClass * av_class
information on struct for av_log
Definition avcodec.h:456
float p_masking
p block masking (0-> disabled)
Definition avcodec.h:861
int delay
Codec delay.
Definition avcodec.h:607
float dark_masking
darkness masking (0-> disabled)
Definition avcodec.h:868
int mb_cmp
macroblock comparison function (not supported yet)
Definition avcodec.h:894
int gop_size
the number of pictures in a group of pictures, or 0 for intra_only
Definition avcodec.h:1037
int skip_alpha
Skip processing alpha if supported by codec.
Definition avcodec.h:1844
int refs
number of reference frames
Definition avcodec.h:721
int ildct_cmp
interlaced DCT comparison function
Definition avcodec.h:900
int mv0_threshold
Note: Value depends upon the compare function used for fullpel ME.
Definition avcodec.h:1044
int mb_lmin
minimum MB Lagrange multiplier
Definition avcodec.h:1010
int64_t rc_max_rate
maximum bitrate
Definition avcodec.h:1302
int compression_level
Definition avcodec.h:1255
int discard_damaged_percentage
The percentage of damaged samples to discard a frame.
Definition avcodec.h:1980
int thread_count
thread count is used to decide how many independent tasks should be passed to execute()
Definition avcodec.h:1593
void * opaque
Private data of the user, can be used to carry app specific stuff.
Definition avcodec.h:493
int qmax
maximum quantizer
Definition avcodec.h:1273
void * hwaccel_context
Legacy hardware accelerator context.
Definition avcodec.h:1461
uint16_t * intra_matrix
custom intra quantization matrix Must be allocated with the av_malloc() family of functions,...
Definition avcodec.h:980
enum AVColorTransferCharacteristic color_trc
Color Transfer Characteristic.
Definition avcodec.h:684
float rc_min_vbv_overflow_use
Ratecontrol attempt to use, at least, times the amount needed to prevent a vbv overflow.
Definition avcodec.h:1323
uint8_t * subtitle_header
Definition avcodec.h:1902
AVRational time_base
This is the fundamental unit of time (in seconds) in terms of which frame timestamps are represented.
Definition avcodec.h:550
int flags
AV_CODEC_FLAG_*.
Definition avcodec.h:508
int seek_preroll
Number of samples to skip after a discontinuity.
Definition avcodec.h:1146
AVFrameSideData ** decoded_side_data
Array containing static side data, such as HDR10 CLL / MDCV structures.
Definition avcodec.h:2087
uint8_t * extradata
some codecs need / can use extradata like Huffman tables.
Definition avcodec.h:529
int me_pre_cmp
motion estimation prepass comparison function
Definition avcodec.h:938
int64_t rc_min_rate
minimum bitrate
Definition avcodec.h:1309
int trailing_padding
Audio only.
Definition avcodec.h:1139
enum AVDiscard skip_idct
Skip IDCT/dequantization for selected frames.
Definition avcodec.h:1823
int intra_dc_precision
precision of the intra DC coefficient - 8
Definition avcodec.h:1003
enum AVChromaLocation chroma_sample_location
This defines the location of chroma samples.
Definition avcodec.h:708
int(* execute2)(struct AVCodecContext *c, int(*func)(struct AVCodecContext *c2, void *arg, int jobnr, int threadnr), void *arg2, int *ret, int count)
The codec may call this to execute several independent things.
Definition avcodec.h:1642
uint64_t error[AV_NUM_DATA_POINTERS]
error
Definition avcodec.h:1537
float qcompress
amount of qscale change between easy & hard scenes (0.0-1.0)
Definition avcodec.h:1258
float qblur
amount of qscale smoothing over time (0.0-1.0)
Definition avcodec.h:1259
AVBufferRef * hw_device_ctx
A reference to the AVHWDeviceContext describing the device which will be used by a hardware encoder/d...
Definition avcodec.h:1507
int me_range
maximum motion estimation search range in subpel units If 0 then no limit.
Definition avcodec.h:961
int extra_hw_frames
Video decoding only.
Definition avcodec.h:1530
RcOverride * rc_override
Definition avcodec.h:1295
unsigned nb_side_data_prefer_packet
Number of entries in side_data_prefer_packet.
Definition avcodec.h:2075
int64_t max_samples
The number of samples per frame to maximally accept.
Definition avcodec.h:1988
enum AVCodecID codec_id
Definition avcodec.h:461
int pre_dia_size
ME prepass diamond size & shape.
Definition avcodec.h:945
float lumi_masking
luminance masking (0-> disabled)
Definition avcodec.h:840
int extradata_size
Definition avcodec.h:530
int cutoff
Audio cutoff bandwidth (0 means "automatic")
Definition avcodec.h:1096
int skip_bottom
Number of macroblock rows at the bottom which are skipped.
Definition avcodec.h:1858
int coded_width
Bitstream width / height, may be different from width/height e.g.
Definition avcodec.h:639
int block_align
number of bytes per packet if constant and known or 0 Used by some WAV based audio codecs.
Definition avcodec.h:1089
int frame_size
Number of samples per channel in an audio frame.
Definition avcodec.h:1083
float i_quant_factor
qscale factor between P- and I-frames If > 0 then the last P-frame quantizer will be used (q = lastp_...
Definition avcodec.h:826
int(* get_buffer2)(struct AVCodecContext *s, AVFrame *frame, int flags)
This callback is called at the beginning of each frame to get data buffer(s) for it.
Definition avcodec.h:1232
struct AVCodecInternal * internal
Private context used for internal data.
Definition avcodec.h:486
int lowres
low resolution decoding, 1-> 1/2 size, 2->1/4 size
Definition avcodec.h:1865
void * priv_data
Definition avcodec.h:478
float spatial_cplx_masking
spatial complexity masking (0-> disabled)
Definition avcodec.h:854
enum AVDiscard skip_frame
Skip decoding for selected frames.
Definition avcodec.h:1830
int err_recognition
Error recognition; may misdetect some more or less valid parts as errors.
Definition avcodec.h:1430
float i_quant_offset
qscale offset between P and I-frames
Definition avcodec.h:833
int slices
Number of slices.
Definition avcodec.h:1053
This struct describes the properties of a single codec described by an AVCodecID.
Definition codec_desc.h:38
This struct describes the properties of an encoded stream.
Definition codec_par.h:47
int duration
Duration of the current frame.
Definition avcodec.h:2862
int dts_ref_dts_delta
Offset of the current timestamp against last timestamp sync point in units of AVCodecContext....
Definition avcodec.h:2824
int64_t cur_frame_end[AV_PARSER_PTS_NB]
Definition avcodec.h:2789
int width
Dimensions of the decoded video intended for presentation.
Definition avcodec.h:2887
enum AVFieldOrder field_order
Definition avcodec.h:2864
const struct AVCodecParser * parser
Definition avcodec.h:2750
int64_t pos
Byte position of currently parsed frame in stream.
Definition avcodec.h:2850
int format
The format of the coded data, corresponds to enum AVPixelFormat for video and for enum AVSampleFormat...
Definition avcodec.h:2904
int repeat_pict
This field is used for proper frame duration computation in lavf.
Definition avcodec.h:2766
enum AVPictureStructure picture_structure
Indicate whether a picture is coded as a frame, top field or bottom field.
Definition avcodec.h:2874
int64_t cur_frame_dts[AV_PARSER_PTS_NB]
Definition avcodec.h:2779
int64_t cur_frame_pos[AV_PARSER_PTS_NB]
Position of the packet in file.
Definition avcodec.h:2845
int output_picture_number
Picture number incremented in presentation or output order.
Definition avcodec.h:2882
int pts_dts_delta
Presentation delay of current frame in units of AVCodecContext.time_base.
Definition avcodec.h:2838
int64_t next_frame_offset
Definition avcodec.h:2754
int64_t cur_frame_pts[AV_PARSER_PTS_NB]
Definition avcodec.h:2778
int64_t cur_frame_offset[AV_PARSER_PTS_NB]
Definition avcodec.h:2777
int key_frame
Set by parser to 1 for key frames and 0 for non-key frames.
Definition avcodec.h:2797
int64_t last_pos
Previous frame byte position.
Definition avcodec.h:2855
int coded_width
Dimensions of the coded video.
Definition avcodec.h:2893
int64_t offset
byte offset from starting packet start
Definition avcodec.h:2788
int dts_sync_point
Synchronization point for start of timestamp generation.
Definition avcodec.h:2809
int priv_data_size
Definition avcodec.h:2909
int codec_ids[7]
Definition avcodec.h:2908
int(* split)(AVCodecContext *avctx, const uint8_t *buf, int buf_size)
Definition avcodec.h:2918
void(* parser_close)(AVCodecParserContext *s)
Definition avcodec.h:2917
int(* parser_parse)(AVCodecParserContext *s, AVCodecContext *avctx, const uint8_t **poutbuf, int *poutbuf_size, const uint8_t *buf, int buf_size)
Definition avcodec.h:2913
int(* parser_init)(AVCodecParserContext *s)
Definition avcodec.h:2910
AVCodec.
Definition codec.h:187
Structure to hold side data for an AVFrame.
Definition frame.h:265
This structure describes decoded (raw) audio or video data.
Definition frame.h:389
enum AVCodecID id
Codec implemented by the hardware accelerator.
Definition avcodec.h:2119
const char * name
Name of the hardware accelerated codec.
Definition avcodec.h:2105
int capabilities
Hardware accelerated codec capabilities.
Definition avcodec.h:2132
enum AVPixelFormat pix_fmt
Supported pixel format.
Definition avcodec.h:2126
enum AVMediaType type
Type of codec implemented by the hardware accelerator.
Definition avcodec.h:2112
This structure stores auxiliary information for decoding, presenting, or otherwise processing the cod...
Definition packet.h:390
This structure stores compressed data.
Definition packet.h:516
Rational number (pair of numerator and denominator).
Definition rational.h:58
int x
top left corner of pict, undefined when pict is not set
Definition avcodec.h:2212
char * ass
0 terminated ASS/SSA compatible event line.
Definition avcodec.h:2235
int w
width of pict, undefined when pict is not set
Definition avcodec.h:2214
int nb_colors
number of colors in pict, undefined when pict is not set
Definition avcodec.h:2216
char * text
0 terminated plain UTF-8 text
Definition avcodec.h:2228
uint8_t * data[4]
data+linesize for the bitmap of this subtitle.
Definition avcodec.h:2222
int y
top left corner of pict, undefined when pict is not set
Definition avcodec.h:2213
enum AVSubtitleType type
Definition avcodec.h:2226
int linesize[4]
Definition avcodec.h:2223
int h
height of pict, undefined when pict is not set
Definition avcodec.h:2215
uint16_t format
Definition avcodec.h:2239
uint32_t start_display_time
Definition avcodec.h:2240
uint32_t end_display_time
Definition avcodec.h:2241
unsigned num_rects
Definition avcodec.h:2242
AVSubtitleRect ** rects
Definition avcodec.h:2243
int64_t pts
Same as packet pts, in AV_TIME_BASE.
Definition avcodec.h:2244
int qscale
Definition avcodec.h:207
int start_frame
Definition avcodec.h:205
int end_frame
Definition avcodec.h:206
float quality_factor
Definition avcodec.h:208
static int64_t pts