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