FFmpeg 9.1
Loading...
Searching...
No Matches
avcodec.h
Go to the documentation of this file.
1/*
2 * copyright (c) 2001 Fabrice Bellard
3 *
4 * This file is part of FFmpeg.
5 *
6 * FFmpeg is free software; you can redistribute it and/or
7 * modify it under the terms of the GNU Lesser General Public
8 * License as published by the Free Software Foundation; either
9 * version 2.1 of the License, or (at your option) any later version.
10 *
11 * FFmpeg is distributed in the hope that it will be useful,
12 * but WITHOUT ANY WARRANTY; without even the implied warranty of
13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
14 * Lesser General Public License for more details.
15 *
16 * You should have received a copy of the GNU Lesser General Public
17 * License along with FFmpeg; if not, write to the Free Software
18 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
19 */
20
21#ifndef AVCODEC_AVCODEC_H
22#define AVCODEC_AVCODEC_H
23
24/**
25 * @file
26 * @ingroup libavc
27 * Libavcodec external API header
28 */
29
30#include "libavutil/samplefmt.h"
32#include "libavutil/avutil.h"
33#include "libavutil/buffer.h"
35#include "libavutil/dict.h"
36#include "libavutil/frame.h"
37#include "libavutil/log.h"
38#include "libavutil/pixfmt.h"
39#include "libavutil/rational.h"
40
41#include "codec.h"
42#include "codec_id.h"
43#include "defs.h"
44#include "packet.h"
45#include "version_major.h"
46#ifndef HAVE_AV_CONFIG_H
47/* When included as part of the ffmpeg build, only include the major version
48 * to avoid unnecessary rebuilds. When included externally, keep including
49 * the full version information. */
50#include "version.h"
51
52#include "codec_desc.h"
53#include "codec_par.h"
54#endif
55
57
58/**
59 * @defgroup libavc libavcodec
60 * Encoding/Decoding Library
61 *
62 * @{
63 *
64 * @defgroup lavc_decoding Decoding
65 * @{
66 * @}
67 *
68 * @defgroup lavc_encoding Encoding
69 * @{
70 * @}
71 *
72 * @defgroup lavc_codec Codecs
73 * @{
74 * @defgroup lavc_codec_native Native Codecs
75 * @{
76 * @}
77 * @defgroup lavc_codec_wrappers External library wrappers
78 * @{
79 * @}
80 * @defgroup lavc_codec_hwaccel Hardware Accelerators bridge
81 * @{
82 * @}
83 * @}
84 * @defgroup lavc_internal Internal
85 * @{
86 * @}
87 * @}
88 */
89
90/**
91 * @ingroup libavc
92 * @defgroup lavc_encdec send/receive encoding and decoding API overview
93 * @{
94 *
95 * The avcodec_send_packet()/avcodec_receive_frame()/avcodec_send_frame()/
96 * avcodec_receive_packet() functions provide an encode/decode API, which
97 * decouples input and output.
98 *
99 * The API is very similar for encoding/decoding and audio/video, and works as
100 * follows:
101 * - Set up and open the AVCodecContext as usual.
102 * - Send valid input:
103 * - For decoding, call avcodec_send_packet() to give the decoder raw
104 * compressed data in an AVPacket.
105 * - For encoding, call avcodec_send_frame() to give the encoder an AVFrame
106 * containing uncompressed audio or video.
107 *
108 * In both cases, it is recommended that AVPackets and AVFrames are
109 * refcounted, or libavcodec might have to copy the input data. (libavformat
110 * always returns refcounted AVPackets, and av_frame_get_buffer() allocates
111 * refcounted AVFrames.)
112 * - Receive output in a loop. Periodically call one of the avcodec_receive_*()
113 * functions and process their output:
114 * - For decoding, call avcodec_receive_frame(). On success, it will return
115 * an AVFrame containing uncompressed audio or video data.
116 * - For encoding, call avcodec_receive_packet(). On success, it will return
117 * an AVPacket with a compressed frame.
118 *
119 * Repeat this call until it returns AVERROR(EAGAIN) or an error. The
120 * AVERROR(EAGAIN) return value means that new input data is required to
121 * return new output. In this case, continue with sending input. For each
122 * input frame/packet, the codec will typically return 1 output frame/packet,
123 * but it can also be 0 or more than 1.
124 *
125 * At the beginning of decoding or encoding, the codec might accept multiple
126 * input frames/packets without returning a frame, until its internal buffers
127 * are filled. This situation is handled transparently if you follow the steps
128 * outlined above.
129 *
130 * In theory, sending input can result in EAGAIN - this should happen only if
131 * not all output was received. You can use this to structure alternative decode
132 * or encode loops other than the one suggested above. For example, you could
133 * try sending new input on each iteration, and try to receive output if that
134 * returns EAGAIN.
135 *
136 * End of stream situations. These require "flushing" (aka draining) the codec,
137 * as the codec might buffer multiple frames or packets internally for
138 * performance or out of necessity (consider B-frames).
139 * This is handled as follows:
140 * - Instead of valid input, send NULL to the avcodec_send_packet() (decoding)
141 * or avcodec_send_frame() (encoding) functions. This will enter draining
142 * mode.
143 * - Call avcodec_receive_frame() (decoding) or avcodec_receive_packet()
144 * (encoding) in a loop until AVERROR_EOF is returned. The functions will
145 * not return AVERROR(EAGAIN), unless you forgot to enter draining mode.
146 * - Before decoding can be resumed again, the codec has to be reset with
147 * avcodec_flush_buffers().
148 *
149 * Using the API as outlined above is highly recommended. But it is also
150 * possible to call functions outside of this rigid schema. For example, you can
151 * call avcodec_send_packet() repeatedly without calling
152 * avcodec_receive_frame(). In this case, avcodec_send_packet() will succeed
153 * until the codec's internal buffer has been filled up (which is typically of
154 * size 1 per output frame, after initial input), and then reject input with
155 * AVERROR(EAGAIN). Once it starts rejecting input, you have no choice but to
156 * read at least some output.
157 *
158 * Not all codecs will follow a rigid and predictable dataflow; the only
159 * guarantee is that an AVERROR(EAGAIN) return value on a send/receive call on
160 * one end implies that a receive/send call on the other end will succeed, or
161 * at least will not fail with AVERROR(EAGAIN). In general, no codec will
162 * permit unlimited buffering of input or output.
163 *
164 * A codec is not allowed to return AVERROR(EAGAIN) for both sending and receiving. This
165 * would be an invalid state, which could put the codec user into an endless
166 * loop. The API has no concept of time either: it cannot happen that trying to
167 * do avcodec_send_packet() results in AVERROR(EAGAIN), but a repeated call 1 second
168 * later accepts the packet (with no other receive/flush API calls involved).
169 * The API is a strict state machine, and the passage of time is not supposed
170 * to influence it. Some timing-dependent behavior might still be deemed
171 * acceptable in certain cases. But it must never result in both send/receive
172 * returning EAGAIN at the same time at any point. It must also absolutely be
173 * avoided that the current state is "unstable" and can "flip-flop" between
174 * the send/receive APIs allowing progress. For example, it's not allowed that
175 * the codec randomly decides that it actually wants to consume a packet now
176 * instead of returning a frame, after it just returned AVERROR(EAGAIN) on an
177 * avcodec_send_packet() call.
178 * @}
179 */
180
181/**
182 * @defgroup lavc_core Core functions/structures.
183 * @ingroup libavc
184 *
185 * Basic definitions, functions for querying libavcodec capabilities,
186 * allocating core structures, etc.
187 * @{
188 */
189
190/**
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 */
478 struct AVCodecInternal *internal;
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 */
493 int64_t bit_rate;
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 */
683
684 /**
685 * This defines the location of chroma samples.
686 * - encoding: Set by user
687 * - decoding: Set by libavcodec
688 */
690
691 /** Field order
692 * - encoding: set by libavcodec
693 * - decoding: Set by user.
694 */
696
697 /**
698 * number of reference frames
699 * - encoding: Set by user.
700 * - decoding: Set by lavc.
701 */
702 int refs;
703
704 /**
705 * Size of the frame reordering buffer in the decoder.
706 * For MPEG-2 it is 1 IPB or 0 low delay IP.
707 * - encoding: Set by libavcodec.
708 * - decoding: Set by libavcodec.
709 */
711
712 /**
713 * slice flags
714 * - encoding: unused
715 * - decoding: Set by user.
716 */
718#define SLICE_FLAG_CODED_ORDER 0x0001 ///< draw_horiz_band() is called in coded order instead of display
719#define SLICE_FLAG_ALLOW_FIELD 0x0002 ///< allow draw_horiz_band() with field slices (MPEG-2 field pics)
720#define SLICE_FLAG_ALLOW_PLANE 0x0004 ///< allow draw_horiz_band() with 1 component at a time (SVQ1)
721
722 /**
723 * If non NULL, 'draw_horiz_band' is called by the libavcodec
724 * decoder to draw a horizontal band. It improves cache usage. Not
725 * all codecs can do that. You must check the codec capabilities
726 * beforehand.
727 * When multithreading is used, it may be called from multiple threads
728 * at the same time; threads might draw different parts of the same AVFrame,
729 * or multiple AVFrames, and there is no guarantee that slices will be drawn
730 * in order.
731 * The function is also used by hardware acceleration APIs.
732 * It is called at least once during frame decoding to pass
733 * the data needed for hardware render.
734 * In that mode instead of pixel data, AVFrame points to
735 * a structure specific to the acceleration API. The application
736 * reads the structure and can change some fields to indicate progress
737 * or mark state.
738 * - encoding: unused
739 * - decoding: Set by user.
740 * @param height the height of the slice
741 * @param y the y position of the slice
742 * @param type 1->top field, 2->bottom field, 3->frame
743 * @param offset offset into the AVFrame.data from which the slice should be read
744 */
746 const AVFrame *src, int offset[AV_NUM_DATA_POINTERS],
747 int y, int type, int height);
748
749 /**
750 * Callback to negotiate the pixel format. Decoding only, may be set by the
751 * caller before avcodec_open2().
752 *
753 * Called by some decoders to select the pixel format that will be used for
754 * the output frames. This is mainly used to set up hardware acceleration,
755 * then the provided format list contains the corresponding hwaccel pixel
756 * formats alongside the "software" one. The software pixel format may also
757 * be retrieved from \ref sw_pix_fmt.
758 *
759 * This callback will be called when the coded frame properties (such as
760 * resolution, pixel format, etc.) change and more than one output format is
761 * supported for those new properties. If a hardware pixel format is chosen
762 * and initialization for it fails, the callback may be called again
763 * immediately.
764 *
765 * This callback may be called from different threads if the decoder is
766 * multi-threaded, but not from more than one thread simultaneously.
767 *
768 * @param fmt list of formats which may be used in the current
769 * configuration, terminated by AV_PIX_FMT_NONE.
770 * @warning Behavior is undefined if the callback returns a value other
771 * than one of the formats in fmt or AV_PIX_FMT_NONE.
772 * @return the chosen format or AV_PIX_FMT_NONE
773 */
774 enum AVPixelFormat (*get_format)(struct AVCodecContext *s, const enum AVPixelFormat * fmt);
775
776 /**
777 * maximum number of B-frames between non-B-frames
778 * Note: The output will be delayed by max_b_frames+1 relative to the input.
779 * - encoding: Set by user.
780 * - decoding: unused
781 */
783
784 /**
785 * qscale factor between IP and B-frames
786 * If > 0 then the last P-frame quantizer will be used (q= lastp_q*factor+offset).
787 * If < 0 then normal ratecontrol will be done (q= -normal_q*factor+offset).
788 * - encoding: Set by user.
789 * - decoding: unused
790 */
792
793 /**
794 * qscale offset between IP and B-frames
795 * - encoding: Set by user.
796 * - decoding: unused
797 */
799
800 /**
801 * qscale factor between P- and I-frames
802 * If > 0 then the last P-frame quantizer will be used (q = lastp_q * factor + offset).
803 * If < 0 then normal ratecontrol will be done (q= -normal_q*factor+offset).
804 * - encoding: Set by user.
805 * - decoding: unused
806 */
808
809 /**
810 * qscale offset between P and I-frames
811 * - encoding: Set by user.
812 * - decoding: unused
813 */
815
816 /**
817 * luminance masking (0-> disabled)
818 * - encoding: Set by user.
819 * - decoding: unused
820 */
822
823 /**
824 * temporary complexity masking (0-> disabled)
825 * - encoding: Set by user.
826 * - decoding: unused
827 */
829
830 /**
831 * spatial complexity masking (0-> disabled)
832 * - encoding: Set by user.
833 * - decoding: unused
834 */
836
837 /**
838 * p block masking (0-> disabled)
839 * - encoding: Set by user.
840 * - decoding: unused
841 */
843
844 /**
845 * darkness masking (0-> disabled)
846 * - encoding: Set by user.
847 * - decoding: unused
848 */
850
851 /**
852 * noise vs. sse weight for the nsse comparison function
853 * - encoding: Set by user.
854 * - decoding: unused
855 */
857
858 /**
859 * motion estimation comparison function
860 * - encoding: Set by user.
861 * - decoding: unused
862 */
864 /**
865 * subpixel motion estimation comparison function
866 * - encoding: Set by user.
867 * - decoding: unused
868 */
870 /**
871 * macroblock comparison function (not supported yet)
872 * - encoding: Set by user.
873 * - decoding: unused
874 */
876 /**
877 * interlaced DCT comparison function
878 * - encoding: Set by user.
879 * - decoding: unused
880 */
882#define FF_CMP_SAD 0
883#define FF_CMP_SSE 1
884#define FF_CMP_SATD 2
885#define FF_CMP_DCT 3
886#define FF_CMP_PSNR 4
887#define FF_CMP_BIT 5
888#define FF_CMP_RD 6
889#define FF_CMP_ZERO 7
890#define FF_CMP_VSAD 8
891#define FF_CMP_VSSE 9
892#define FF_CMP_NSSE 10
893#define FF_CMP_W53 11
894#define FF_CMP_W97 12
895#define FF_CMP_DCTMAX 13
896#define FF_CMP_DCT264 14
897#define FF_CMP_MEDIAN_SAD 15
898#define FF_CMP_CHROMA 256
899
900 /**
901 * ME diamond size & shape
902 * - encoding: Set by user.
903 * - decoding: unused
904 */
906
907 /**
908 * amount of previous MV predictors (2a+1 x 2a+1 square)
909 * - encoding: Set by user.
910 * - decoding: unused
911 */
913
914 /**
915 * motion estimation prepass comparison function
916 * - encoding: Set by user.
917 * - decoding: unused
918 */
920
921 /**
922 * ME prepass diamond size & shape
923 * - encoding: Set by user.
924 * - decoding: unused
925 */
927
928 /**
929 * subpel ME quality
930 * - encoding: Set by user.
931 * - decoding: unused
932 */
934
935 /**
936 * maximum motion estimation search range in subpel units
937 * If 0 then no limit.
938 *
939 * - encoding: Set by user.
940 * - decoding: unused
941 */
943
944 /**
945 * macroblock decision mode
946 * - encoding: Set by user.
947 * - decoding: unused
948 */
950#define FF_MB_DECISION_SIMPLE 0 ///< uses mb_cmp
951#define FF_MB_DECISION_BITS 1 ///< chooses the one which needs the fewest bits
952#define FF_MB_DECISION_RD 2 ///< rate distortion
953
954 /**
955 * custom intra quantization matrix
956 * Must be allocated with the av_malloc() family of functions, and will be freed in
957 * avcodec_free_context().
958 * - encoding: Set/allocated by user, freed by libavcodec. Can be NULL.
959 * - decoding: Set/allocated/freed by libavcodec.
960 */
961 uint16_t *intra_matrix;
962
963 /**
964 * custom inter quantization matrix
965 * Must be allocated with the av_malloc() family of functions, and will be freed in
966 * avcodec_free_context().
967 * - encoding: Set/allocated by user, freed by libavcodec. Can be NULL.
968 * - decoding: Set/allocated/freed by libavcodec.
969 */
970 uint16_t *inter_matrix;
971
972 /**
973 * custom intra quantization matrix
974 * - encoding: Set by user, can be NULL.
975 * - decoding: unused.
976 */
978
979#if FF_API_INTRA_DC_PRECISION
980 /**
981 * precision of the intra DC coefficient - 8
982 * - encoding: Set by user.
983 * - decoding: Set by libavcodec
984 * @deprecated Use the MPEG-2 encoder's private option "intra_dc_precision" instead.
985 */
987 int intra_dc_precision;
988#endif
989
990 /**
991 * minimum MB Lagrange multiplier
992 * - encoding: Set by user.
993 * - decoding: unused
994 */
996
997 /**
998 * maximum MB Lagrange multiplier
999 * - encoding: Set by user.
1000 * - decoding: unused
1001 */
1003
1004 /**
1005 * - encoding: Set by user.
1006 * - decoding: unused
1007 */
1009
1010 /**
1011 * minimum GOP size
1012 * - encoding: Set by user.
1013 * - decoding: unused
1014 */
1016
1017 /**
1018 * the number of pictures in a group of pictures, or 0 for intra_only
1019 * - encoding: Set by user.
1020 * - decoding: unused
1021 */
1023
1024 /**
1025 * Note: Value depends upon the compare function used for fullpel ME.
1026 * - encoding: Set by user.
1027 * - decoding: unused
1028 */
1030
1031 /**
1032 * Number of slices.
1033 * Indicates number of picture subdivisions. Used for parallelized
1034 * decoding.
1035 * - encoding: Set by user
1036 * - decoding: unused
1037 */
1039
1040 /* audio only */
1041 int sample_rate; ///< samples per second
1042
1043 /**
1044 * audio sample format
1045 * - encoding: Set by user.
1046 * - decoding: Set by libavcodec.
1047 */
1048 enum AVSampleFormat sample_fmt; ///< sample format
1049
1050 /**
1051 * Audio channel layout.
1052 * - encoding: must be set by the caller, to one of AVCodec.ch_layouts.
1053 * - decoding: may be set by the caller if known e.g. from the container.
1054 * The decoder can then override during decoding as needed.
1055 */
1057
1058 /**
1059 * Number of samples per channel in an audio frame.
1060 *
1061 * - encoding: may be set by the user before calling avcodec_open2(), and
1062 * libavcodec may then overwrite it if needed. Each submitted frame
1063 * except the last must contain exactly frame_size samples per channel.
1064 * May be 0 when the codec has AV_CODEC_CAP_VARIABLE_FRAME_SIZE set, except
1065 * when AV_CODEC_FLAG2_FIXED_FRAME_SIZE is requested, then the
1066 * frame size is not restricted.
1067 * - decoding: may be set by some decoders to indicate constant frame size
1068 */
1070
1071 /* The following data should not be initialized. */
1072 /**
1073 * number of bytes per packet if constant and known or 0
1074 * Used by some WAV based audio codecs.
1075 */
1077
1078 /**
1079 * Audio cutoff bandwidth (0 means "automatic")
1080 * - encoding: Set by user.
1081 * - decoding: unused
1082 */
1084
1085 /**
1086 * Type of service that the audio stream conveys.
1087 * - encoding: Set by user.
1088 * - decoding: Set by libavcodec.
1089 */
1091
1092 /**
1093 * desired sample format
1094 * - encoding: Not used.
1095 * - decoding: Set by user.
1096 * Decoder will decode to this format if it can.
1097 */
1099
1100 /**
1101 * Audio only. The number of "priming" samples (padding) inserted by the
1102 * encoder at the beginning of the audio. I.e. this number of leading
1103 * decoded samples must be discarded by the caller to get the original audio
1104 * without leading padding.
1105 *
1106 * - decoding: unused
1107 * - encoding: Set by libavcodec. The timestamps on the output packets are
1108 * adjusted by the encoder so that they always refer to the
1109 * first sample of the data actually contained in the packet,
1110 * including any added padding. E.g. if the timebase is
1111 * 1/samplerate and the timestamp of the first input sample is
1112 * 0, the timestamp of the first output packet will be
1113 * -initial_padding.
1114 */
1116
1117 /**
1118 * Audio only. The amount of padding (in samples) appended by the encoder to
1119 * the end of the audio. I.e. this number of decoded samples must be
1120 * discarded by the caller from the end of the stream to get the original
1121 * audio without any trailing padding.
1122 *
1123 * - decoding: unused
1124 * - encoding: unused
1125 */
1127
1128 /**
1129 * Number of samples to skip after a discontinuity
1130 * - decoding: may be set by the user, a decoder may raise it to the
1131 * pre-roll it needs
1132 * - encoding: set by libavcodec
1133 */
1135
1136 /**
1137 * This callback is called at the beginning of each frame to get data
1138 * buffer(s) for it. There may be one contiguous buffer for all the data or
1139 * there may be a buffer per each data plane or anything in between. What
1140 * this means is, you may set however many entries in buf[] you feel necessary.
1141 * Each buffer must be reference-counted using the AVBuffer API (see description
1142 * of buf[] below).
1143 *
1144 * The following fields will be set in the frame before this callback is
1145 * called:
1146 * - format
1147 * - width, height (video only)
1148 * - sample_rate, channel_layout, nb_samples (audio only)
1149 * Their values may differ from the corresponding values in
1150 * AVCodecContext. This callback must use the frame values, not the codec
1151 * context values, to calculate the required buffer size.
1152 *
1153 * This callback must fill the following fields in the frame:
1154 * - data[]
1155 * - linesize[]
1156 * - extended_data:
1157 * * if the data is planar audio with more than 8 channels, then this
1158 * callback must allocate and fill extended_data to contain all pointers
1159 * to all data planes. data[] must hold as many pointers as it can.
1160 * extended_data must be allocated with av_malloc() and will be freed in
1161 * av_frame_unref().
1162 * * otherwise extended_data must point to data
1163 * - buf[] must contain one or more pointers to AVBufferRef structures. Each of
1164 * the frame's data and extended_data pointers must be contained in these. That
1165 * is, one AVBufferRef for each allocated chunk of memory, not necessarily one
1166 * AVBufferRef per data[] entry. See: av_buffer_create(), av_buffer_alloc(),
1167 * and av_buffer_ref().
1168 * - extended_buf and nb_extended_buf must be allocated with av_malloc() by
1169 * this callback and filled with the extra buffers if there are more
1170 * buffers than buf[] can hold. extended_buf will be freed in
1171 * av_frame_unref().
1172 * Decoders will generally initialize the whole buffer before it is output
1173 * but it can in rare error conditions happen that uninitialized data is passed
1174 * through. \important The buffers returned by get_buffer* should thus not contain sensitive
1175 * data.
1176 *
1177 * If AV_CODEC_CAP_DR1 is not set then get_buffer2() must call
1178 * avcodec_default_get_buffer2() instead of providing buffers allocated by
1179 * some other means.
1180 *
1181 * Each data plane must be aligned to the maximum required by the target
1182 * CPU.
1183 *
1184 * @see avcodec_default_get_buffer2()
1185 *
1186 * Video:
1187 *
1188 * If AV_GET_BUFFER_FLAG_REF is set in flags then the frame may be reused
1189 * (read and/or written to if it is writable) later by libavcodec.
1190 *
1191 * avcodec_align_dimensions2() should be used to find the required width and
1192 * height, as they normally need to be rounded up to the next multiple of 16.
1193 *
1194 * Some decoders do not support linesizes changing between frames.
1195 *
1196 * If frame multithreading is used, this callback may be called from a
1197 * different thread, but not from more than one at once. Does not need to be
1198 * reentrant.
1199 *
1200 * @see avcodec_align_dimensions2()
1201 *
1202 * Audio:
1203 *
1204 * Decoders request a buffer of a particular size by setting
1205 * AVFrame.nb_samples prior to calling get_buffer2(). The decoder may,
1206 * however, utilize only part of the buffer by setting AVFrame.nb_samples
1207 * to a smaller value in the output frame.
1208 *
1209 * As a convenience, av_samples_get_buffer_size() and
1210 * av_samples_fill_arrays() in libavutil may be used by custom get_buffer2()
1211 * functions to find the required data size and to fill data pointers and
1212 * linesize. In AVFrame.linesize, only linesize[0] may be set for audio
1213 * since all planes must be the same size.
1214 *
1215 * @see av_samples_get_buffer_size(), av_samples_fill_arrays()
1216 *
1217 * - encoding: unused
1218 * - decoding: Set by libavcodec, user can override.
1219 */
1221
1222 /* - encoding parameters */
1223 /**
1224 * number of bits the bitstream is allowed to diverge from the reference.
1225 * the reference can be CBR (for CBR pass1) or VBR (for pass2)
1226 * - encoding: Set by user; unused for constant quantizer encoding.
1227 * - decoding: unused
1228 */
1230
1231 /**
1232 * Global quality for codecs which cannot change it per frame.
1233 * This should be proportional to MPEG-1/2/4 qscale.
1234 * - encoding: Set by user.
1235 * - decoding: unused
1236 */
1238
1239 /**
1240 * - encoding: Set by user.
1241 * - decoding: unused
1242 */
1244#define FF_COMPRESSION_DEFAULT -1
1245
1246 float qcompress; ///< amount of qscale change between easy & hard scenes (0.0-1.0)
1247 float qblur; ///< amount of qscale smoothing over time (0.0-1.0)
1248
1249 /**
1250 * minimum quantizer
1251 * - encoding: Set by user.
1252 * - decoding: unused
1253 */
1254 int qmin;
1255
1256 /**
1257 * maximum quantizer
1258 * - encoding: Set by user.
1259 * - decoding: unused
1260 */
1261 int qmax;
1262
1263 /**
1264 * maximum quantizer difference between frames
1265 * - encoding: Set by user.
1266 * - decoding: unused
1267 */
1269
1270 /**
1271 * decoder bitstream buffer size
1272 * - encoding: Set by user.
1273 * - decoding: May be set by libavcodec.
1274 */
1276
1277 /**
1278 * ratecontrol override, see RcOverride
1279 * - encoding: Allocated/set/freed by user.
1280 * - decoding: unused
1281 */
1284
1285 /**
1286 * maximum bitrate
1287 * - encoding: Set by user.
1288 * - decoding: Set by user, may be overwritten by libavcodec.
1289 */
1291
1292 /**
1293 * minimum bitrate
1294 * - encoding: Set by user.
1295 * - decoding: unused
1296 */
1298
1299 /**
1300 * Ratecontrol attempt to use, at maximum, <value> of what can be used without an underflow.
1301 * - encoding: Set by user.
1302 * - decoding: unused.
1303 */
1305
1306 /**
1307 * Ratecontrol attempt to use, at least, <value> times the amount needed to prevent a vbv overflow.
1308 * - encoding: Set by user.
1309 * - decoding: unused.
1310 */
1312
1313 /**
1314 * Number of bits which should be loaded into the rc buffer before decoding starts.
1315 * - encoding: Set by user.
1316 * - decoding: unused
1317 */
1319
1320 /**
1321 * trellis RD quantization
1322 * - encoding: Set by user.
1323 * - decoding: unused
1324 */
1326
1327 /**
1328 * pass1 encoding statistics output buffer
1329 * - encoding: Set by libavcodec.
1330 * - decoding: unused
1331 */
1333
1334 /**
1335 * pass2 encoding statistics input buffer
1336 * Concatenated stuff from stats_out of pass1 should be placed here.
1337 * - encoding: Allocated/set/freed by user.
1338 * - decoding: unused
1339 */
1341
1342 /**
1343 * Work around bugs in encoders which sometimes cannot be detected automatically.
1344 * - encoding: Set by user
1345 * - decoding: Set by user
1346 */
1348#define FF_BUG_AUTODETECT 1 ///< autodetection
1349#define FF_BUG_XVID_ILACE 4
1350#define FF_BUG_UMP4 8
1351#define FF_BUG_NO_PADDING 16
1352#define FF_BUG_AMV 32
1353#define FF_BUG_QPEL_CHROMA 64
1354#define FF_BUG_STD_QPEL 128
1355#define FF_BUG_QPEL_CHROMA2 256
1356#define FF_BUG_DIRECT_BLOCKSIZE 512
1357#define FF_BUG_EDGE 1024
1358#define FF_BUG_HPEL_CHROMA 2048
1359#define FF_BUG_DC_CLIP 4096
1360#define FF_BUG_MS 8192 ///< Work around various bugs in Microsoft's broken decoders.
1361#define FF_BUG_TRUNCATED 16384
1362#define FF_BUG_IEDGE 32768
1363#define FF_BUG_H264_DP_NNZ 65536 ///< H.264: JM's nC derivation for partitioned slices.
1364
1365 /**
1366 * strictly follow the standard (MPEG-4, ...).
1367 * - encoding: Set by user.
1368 * - decoding: Set by user.
1369 * Setting this to STRICT or higher means the encoder and decoder will
1370 * generally do stupid things, whereas setting it to unofficial or lower
1371 * will mean the encoder might produce output that is not supported by all
1372 * spec-compliant decoders. Decoders don't differentiate between normal,
1373 * unofficial and experimental (that is, they always try to decode things
1374 * when they can) unless they are explicitly asked to behave stupidly
1375 * (=strictly conform to the specs)
1376 * This may only be set to one of the FF_COMPLIANCE_* values in defs.h.
1377 */
1379
1380 /**
1381 * error concealment flags
1382 * - encoding: unused
1383 * - decoding: Set by user.
1384 */
1386#define FF_EC_GUESS_MVS 1
1387#define FF_EC_DEBLOCK 2
1388#define FF_EC_FAVOR_INTER 256
1389
1390 /**
1391 * debug
1392 * - encoding: Set by user.
1393 * - decoding: Set by user.
1394 */
1396#define FF_DEBUG_PICT_INFO 1
1397#define FF_DEBUG_RC 2
1398#define FF_DEBUG_BITSTREAM 4
1399#define FF_DEBUG_MB_TYPE 8
1400#define FF_DEBUG_QP 16
1401#define FF_DEBUG_DCT_COEFF 0x00000040
1402#define FF_DEBUG_SKIP 0x00000080
1403#define FF_DEBUG_STARTCODE 0x00000100
1404#define FF_DEBUG_ER 0x00000400
1405#define FF_DEBUG_MMCO 0x00000800
1406#define FF_DEBUG_BUGS 0x00001000
1407#define FF_DEBUG_BUFFERS 0x00008000
1408#define FF_DEBUG_THREADS 0x00010000
1409#define FF_DEBUG_GREEN_MD 0x00800000
1410#define FF_DEBUG_NOMC 0x01000000
1411
1412 /**
1413 * Error recognition; may misdetect some more or less valid parts as errors.
1414 * This is a bitfield of the AV_EF_* values defined in defs.h.
1415 *
1416 * - encoding: Set by user.
1417 * - decoding: Set by user.
1418 */
1420
1421 /**
1422 * Hardware accelerator in use
1423 * - encoding: unused.
1424 * - decoding: Set by libavcodec
1425 */
1426 const struct AVHWAccel *hwaccel;
1427
1428 /**
1429 * Legacy hardware accelerator context.
1430 *
1431 * For some hardware acceleration methods, the caller may use this field to
1432 * signal hwaccel-specific data to the codec. The struct pointed to by this
1433 * pointer is hwaccel-dependent and defined in the respective header. Please
1434 * refer to the FFmpeg HW accelerator documentation to know how to fill
1435 * this.
1436 *
1437 * In most cases this field is optional - the necessary information may also
1438 * be provided to libavcodec through @ref hw_frames_ctx or @ref
1439 * hw_device_ctx (see avcodec_get_hw_config()). However, in some cases it
1440 * may be the only method of signalling some (optional) information.
1441 *
1442 * The struct and its contents are owned by the caller.
1443 *
1444 * - encoding: May be set by the caller before avcodec_open2(). Must remain
1445 * valid until avcodec_free_context().
1446 * - decoding: May be set by the caller in the get_format() callback.
1447 * Must remain valid until the next get_format() call,
1448 * or avcodec_free_context() (whichever comes first).
1449 */
1451
1452 /**
1453 * A reference to the AVHWFramesContext describing the input (for encoding)
1454 * or output (decoding) frames. The reference is set by the caller and
1455 * afterwards owned (and freed) by libavcodec - it should never be read by
1456 * the caller after being set.
1457 *
1458 * - decoding: This field should be set by the caller from the get_format()
1459 * callback. The previous reference (if any) will always be
1460 * unreffed by libavcodec before the get_format() call.
1461 *
1462 * If the default get_buffer2() is used with a hwaccel pixel
1463 * format, then this AVHWFramesContext will be used for
1464 * allocating the frame buffers.
1465 *
1466 * - encoding: For hardware encoders configured to use a hwaccel pixel
1467 * format, this field should be set by the caller to a reference
1468 * to the AVHWFramesContext describing input frames.
1469 * AVHWFramesContext.format must be equal to
1470 * AVCodecContext.pix_fmt.
1471 *
1472 * This field should be set before avcodec_open2() is called.
1473 */
1475
1476 /**
1477 * A reference to the AVHWDeviceContext describing the device which will
1478 * be used by a hardware encoder/decoder. The reference is set by the
1479 * caller and afterwards owned (and freed) by libavcodec.
1480 *
1481 * This should be used if either the codec device does not require
1482 * hardware frames or any that are used are to be allocated internally by
1483 * libavcodec. If the user wishes to supply any of the frames used as
1484 * encoder input or decoder output then hw_frames_ctx should be used
1485 * instead. When hw_frames_ctx is set in get_format() for a decoder, this
1486 * field will be ignored while decoding the associated stream segment, but
1487 * may again be used on a following one after another get_format() call.
1488 *
1489 * For both encoders and decoders this field should be set before
1490 * avcodec_open2() is called and must not be written to thereafter.
1491 *
1492 * Note that some decoders may require this field to be set initially in
1493 * order to support hw_frames_ctx at all - in that case, all frames
1494 * contexts used must be created on the same device.
1495 */
1497
1498 /**
1499 * Bit set of AV_HWACCEL_FLAG_* flags, which affect hardware accelerated
1500 * decoding (if active).
1501 * - encoding: unused
1502 * - decoding: Set by user (either before avcodec_open2(), or in the
1503 * AVCodecContext.get_format callback)
1504 */
1506
1507 /**
1508 * Video decoding only. Sets the number of extra hardware frames which
1509 * the decoder will allocate for use by the caller. This must be set
1510 * before avcodec_open2() is called.
1511 *
1512 * Some hardware decoders require all frames that they will use for
1513 * output to be defined in advance before decoding starts. For such
1514 * decoders, the hardware frame pool must therefore be of a fixed size.
1515 * The extra frames set here are on top of any number that the decoder
1516 * needs internally in order to operate normally (for example, frames
1517 * used as reference pictures).
1518 */
1520
1521 /**
1522 * error
1523 * - encoding: Set by libavcodec if flags & AV_CODEC_FLAG_PSNR.
1524 * - decoding: unused
1525 */
1527
1528 /**
1529 * DCT algorithm, see FF_DCT_* below
1530 * - encoding: Set by user.
1531 * - decoding: unused
1532 */
1534#define FF_DCT_AUTO 0
1535#define FF_DCT_FASTINT 1
1536#define FF_DCT_INT 2
1537#define FF_DCT_MMX 3
1538#define FF_DCT_ALTIVEC 5
1539#define FF_DCT_FAAN 6
1540#define FF_DCT_NEON 7
1541/**
1542 * Select a RISC-V Vector implementation of the forward DCT when available.
1543 */
1544#define FF_DCT_RVV 8
1545
1546 /**
1547 * IDCT algorithm, see FF_IDCT_* below.
1548 * - encoding: Set by user.
1549 * - decoding: Set by user.
1550 */
1552#define FF_IDCT_AUTO 0
1553#define FF_IDCT_INT 1
1554#define FF_IDCT_SIMPLE 2
1555#define FF_IDCT_SIMPLEMMX 3
1556#define FF_IDCT_ARM 7
1557#define FF_IDCT_ALTIVEC 8
1558#define FF_IDCT_SIMPLEARM 10
1559#define FF_IDCT_XVID 14
1560#define FF_IDCT_SIMPLEARMV5TE 16
1561#define FF_IDCT_SIMPLEARMV6 17
1562#define FF_IDCT_FAAN 20
1563#define FF_IDCT_SIMPLENEON 22
1564#define FF_IDCT_SIMPLEAUTO 128
1565
1566 /**
1567 * bits per sample/pixel from the demuxer (needed for huffyuv).
1568 * - encoding: Set by libavcodec.
1569 * - decoding: Set by user.
1570 */
1572
1573 /**
1574 * Bits per sample/pixel of internal libavcodec pixel/sample format.
1575 * - encoding: set by user.
1576 * - decoding: set by libavcodec.
1577 */
1579
1580 /**
1581 * thread count
1582 * is used to decide how many independent tasks should be passed to execute()
1583 * - encoding: Set by user.
1584 * - decoding: Set by user.
1585 */
1587
1588 /**
1589 * Which multithreading methods to use.
1590 * Use of FF_THREAD_FRAME will increase decoding delay by one frame per thread,
1591 * so clients which cannot provide future frames should not use it.
1592 *
1593 * - encoding: Set by user, otherwise the default is used.
1594 * - decoding: Set by user, otherwise the default is used.
1595 */
1597#define FF_THREAD_FRAME 1 ///< Decode more than one frame at once
1598#define FF_THREAD_SLICE 2 ///< Decode more than one part of a single frame at once
1599
1600 /**
1601 * Which multithreading methods are in use by the codec.
1602 * - encoding: Set by libavcodec.
1603 * - decoding: Set by libavcodec.
1604 */
1606
1607 /**
1608 * The codec may call this to execute several independent things.
1609 * It will return only after finishing all tasks.
1610 * The user may replace this with some multithreaded implementation,
1611 * the default implementation will execute the parts serially.
1612 * @param count the number of things to execute
1613 * - encoding: Set by libavcodec, user can override.
1614 * - decoding: Set by libavcodec, user can override.
1615 */
1616 int (*execute)(struct AVCodecContext *c, int (*func)(struct AVCodecContext *c2, void *arg), void *arg2, int *ret, int count, int size);
1617
1618 /**
1619 * The codec may call this to execute several independent things.
1620 * It will return only after finishing all tasks.
1621 * The user may replace this with some multithreaded implementation,
1622 * the default implementation will execute the parts serially.
1623 * @param c context passed also to func
1624 * @param count the number of things to execute
1625 * @param arg2 argument passed unchanged to func
1626 * @param ret return values of executed functions, must have space for "count" values. May be NULL.
1627 * @param func function that will be called count times, with jobnr from 0 to count-1.
1628 * threadnr will be in the range 0 to c->thread_count-1 < MAX_THREADS and so that no
1629 * two instances of func executing at the same time will have the same threadnr.
1630 * @return always 0 currently, but code should handle a future improvement where when any call to func
1631 * returns < 0 no further calls to func may be done and < 0 is returned.
1632 * - encoding: Set by libavcodec, user can override.
1633 * - decoding: Set by libavcodec, user can override.
1634 */
1635 int (*execute2)(struct AVCodecContext *c, int (*func)(struct AVCodecContext *c2, void *arg, int jobnr, int threadnr), void *arg2, int *ret, int count);
1636
1637 /**
1638 * profile
1639 * - encoding: Set by user.
1640 * - decoding: Set by libavcodec.
1641 * See the AV_PROFILE_* defines in defs.h.
1642 */
1644
1645 /**
1646 * Encoding level descriptor.
1647 * - encoding: Set by user, corresponds to a specific level defined by the
1648 * codec, usually corresponding to the profile level, if not specified it
1649 * is set to AV_LEVEL_UNKNOWN.
1650 * - decoding: Set by libavcodec.
1651 * See AV_LEVEL_* in defs.h.
1652 */
1654
1655 /**
1656 * Skip loop filtering for selected frames.
1657 * - encoding: unused
1658 * - decoding: Set by user.
1659 */
1661
1662 /**
1663 * Skip IDCT/dequantization for selected frames.
1664 * - encoding: unused
1665 * - decoding: Set by user.
1666 */
1668
1669 /**
1670 * Skip decoding for selected frames.
1671 * - encoding: unused
1672 * - decoding: Set by user.
1673 */
1675
1676 /**
1677 * Skip processing alpha if supported by codec.
1678 * Note that if the format uses pre-multiplied alpha (common with VP6,
1679 * and recommended due to better video quality/compression)
1680 * the image will look as if alpha-blended onto a black background.
1681 * However for formats that do not use pre-multiplied alpha
1682 * there might be serious artefacts (though e.g. libswscale currently
1683 * assumes pre-multiplied alpha anyway).
1684 *
1685 * - decoding: set by user
1686 * - encoding: unused
1687 */
1689
1690 /**
1691 * Number of macroblock rows at the top which are skipped.
1692 * - encoding: unused
1693 * - decoding: Set by user.
1694 */
1696
1697 /**
1698 * Number of macroblock rows at the bottom which are skipped.
1699 * - encoding: unused
1700 * - decoding: Set by user.
1701 */
1703
1704 /**
1705 * low resolution decoding, 1-> 1/2 size, 2->1/4 size
1706 * - encoding: unused
1707 * - decoding: Set by user.
1708 */
1710
1711 /**
1712 * AVCodecDescriptor
1713 * - encoding: unused.
1714 * - decoding: set by libavcodec.
1715 */
1717
1718 /**
1719 * Character encoding of the input subtitles file.
1720 * - decoding: set by user
1721 * - encoding: unused
1722 */
1724
1725 /**
1726 * Subtitles character encoding mode. Formats or codecs might be adjusting
1727 * this setting (if they are doing the conversion themselves for instance).
1728 * - decoding: set by libavcodec
1729 * - encoding: unused
1730 */
1732#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)
1733#define FF_SUB_CHARENC_MODE_AUTOMATIC 0 ///< libavcodec will select the mode itself
1734#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
1735#define FF_SUB_CHARENC_MODE_IGNORE 2 ///< neither convert the subtitles, nor check them for valid UTF-8
1736
1737 /**
1738 * Header containing style information for text subtitles.
1739 * For SUBTITLE_ASS subtitle type, it should contain the whole ASS
1740 * [Script Info] and [V4+ Styles] section, plus the [Events] line and
1741 * the Format line following. It shouldn't include any Dialogue line.
1742 *
1743 * - encoding: May be set by the caller before avcodec_open2() to an array
1744 * allocated with the av_malloc() family of functions.
1745 * - decoding: May be set by libavcodec in avcodec_open2().
1746 *
1747 * After being set, the array is owned by the codec and freed in
1748 * avcodec_free_context().
1749 */
1752
1753 /**
1754 * dump format separator.
1755 * can be ", " or "\n " or anything else
1756 * - encoding: Set by user.
1757 * - decoding: Set by user.
1758 */
1760
1761 /**
1762 * ',' separated list of allowed decoders.
1763 * If NULL then all are allowed
1764 * - encoding: unused
1765 * - decoding: set by user
1766 */
1768
1769 /**
1770 * Additional data associated with the entire coded stream.
1771 *
1772 * - decoding: may be set by user before calling avcodec_open2().
1773 * - encoding: may be set by libavcodec after avcodec_open2().
1774 */
1777
1778 /**
1779 * Bit set of AV_CODEC_EXPORT_DATA_* flags, which affects the kind of
1780 * metadata exported in frame, packet, or coded stream side data by
1781 * decoders and encoders.
1782 *
1783 * - decoding: set by user
1784 * - encoding: set by user
1785 */
1787
1788 /**
1789 * The number of pixels per image to maximally accept.
1790 *
1791 * - decoding: set by user
1792 * - encoding: set by user
1793 */
1794 int64_t max_pixels;
1795
1796 /**
1797 * Video decoding only. Certain video codecs support cropping, meaning that
1798 * only a sub-rectangle of the decoded frame is intended for display. This
1799 * option controls how cropping is handled by libavcodec.
1800 *
1801 * When set to 1 (the default), libavcodec will apply cropping internally.
1802 * I.e. it will modify the output frame width/height fields and offset the
1803 * data pointers (only by as much as possible while preserving alignment, or
1804 * by the full amount if the AV_CODEC_FLAG_UNALIGNED flag is set) so that
1805 * the frames output by the decoder refer only to the cropped area. The
1806 * crop_* fields of the output frames will be zero.
1807 *
1808 * When set to 0, the width/height fields of the output frames will be set
1809 * to the coded dimensions and the crop_* fields will describe the cropping
1810 * rectangle. Applying the cropping is left to the caller.
1811 *
1812 * @warning When hardware acceleration with opaque output frames is used,
1813 * libavcodec is unable to apply cropping from the top/left border.
1814 *
1815 * @note when this option is set to zero, the width/height fields of the
1816 * AVCodecContext and output AVFrames have different meanings. The codec
1817 * context fields store display dimensions (with the coded dimensions in
1818 * coded_width/height), while the frame fields store the coded dimensions
1819 * (with the display dimensions being determined by the crop_* fields).
1820 */
1822
1823 /**
1824 * The percentage of damaged samples to discard a frame.
1825 *
1826 * - decoding: set by user
1827 * - encoding: unused
1828 */
1830
1831 /**
1832 * The number of samples per frame to maximally accept.
1833 *
1834 * - decoding: set by user
1835 * - encoding: set by user
1836 */
1838
1839 /**
1840 * This callback is called at the beginning of each packet to get a data
1841 * buffer for it.
1842 *
1843 * The following field will be set in the packet before this callback is
1844 * called:
1845 * - size
1846 * This callback must use the above value to calculate the required buffer size,
1847 * which must padded by at least AV_INPUT_BUFFER_PADDING_SIZE bytes.
1848 *
1849 * In some specific cases, the encoder may not use the entire buffer allocated by this
1850 * callback. This will be reflected in the size value in the packet once returned by
1851 * avcodec_receive_packet().
1852 *
1853 * This callback must fill the following fields in the packet:
1854 * - data: alignment requirements for AVPacket apply, if any. Some architectures and
1855 * encoders may benefit from having aligned data.
1856 * - buf: must contain a pointer to an AVBufferRef structure. The packet's
1857 * data pointer must be contained in it. See: av_buffer_create(), av_buffer_alloc(),
1858 * and av_buffer_ref().
1859 *
1860 * If AV_CODEC_CAP_DR1 is not set then get_encode_buffer() must call
1861 * avcodec_default_get_encode_buffer() instead of providing a buffer allocated by
1862 * some other means.
1863 *
1864 * The flags field may contain a combination of AV_GET_ENCODE_BUFFER_FLAG_ flags.
1865 * They may be used for example to hint what use the buffer may get after being
1866 * created.
1867 * Implementations of this callback may ignore flags they don't understand.
1868 * If AV_GET_ENCODE_BUFFER_FLAG_REF is set in flags then the packet may be reused
1869 * (read and/or written to if it is writable) later by libavcodec.
1870 *
1871 * This callback must be thread-safe, as when frame threading is used, it may
1872 * be called from multiple threads simultaneously.
1873 *
1874 * @see avcodec_default_get_encode_buffer()
1875 *
1876 * - encoding: Set by libavcodec, user can override.
1877 * - decoding: unused
1878 */
1880
1881 /**
1882 * Frame counter, set by libavcodec.
1883 *
1884 * - decoding: total number of frames returned from the decoder so far.
1885 * - encoding: total number of frames passed to the encoder so far.
1886 *
1887 * @note the counter is not incremented if encoding/decoding resulted in
1888 * an error.
1889 */
1890 int64_t frame_num;
1891
1892 /**
1893 * Decoding only. May be set by the caller before avcodec_open2() to an
1894 * av_malloc()'ed array (or via AVOptions). Owned and freed by the decoder
1895 * afterwards.
1896 *
1897 * Side data attached to decoded frames may come from several sources:
1898 * 1. coded_side_data, which the decoder will for certain types translate
1899 * from packet-type to frame-type and attach to frames;
1900 * 2. side data attached to an AVPacket sent for decoding (same
1901 * considerations as above);
1902 * 3. extracted from the coded bytestream.
1903 * The first two cases are supplied by the caller and typically come from a
1904 * container.
1905 *
1906 * This array configures decoder behaviour in cases when side data of the
1907 * same type is present both in the coded bytestream and in the
1908 * user-supplied side data (items 1. and 2. above). In all cases, at most
1909 * one instance of each side data type will be attached to output frames. By
1910 * default it will be the bytestream side data. Adding an
1911 * AVPacketSideDataType value to this array will flip the preference for
1912 * this type, thus making the decoder prefer user-supplied side data over
1913 * bytestream. In case side data of the same type is present both in
1914 * coded_data and attacked to a packet, the packet instance always has
1915 * priority.
1916 *
1917 * The array may also contain a single -1, in which case the preference is
1918 * switched for all side data types.
1919 */
1921 /**
1922 * Number of entries in side_data_prefer_packet.
1923 */
1925
1926 /**
1927 * Array containing static side data, such as HDR10 CLL / MDCV structures.
1928 * Side data entries should be allocated by usage of helpers defined in
1929 * libavutil/frame.h.
1930 *
1931 * - encoding: may be set by user before calling avcodec_open2() for
1932 * encoder configuration. Afterwards owned and freed by the
1933 * encoder.
1934 * - decoding: may be set by libavcodec in avcodec_open2().
1935 */
1938
1939 /**
1940 * Indicates how the alpha channel of the video is represented.
1941 * - encoding: Set by user
1942 * - decoding: Set by libavcodec
1943 */
1945
1946 /**
1947 * Skip prediction (intra prediction and motion compensation) for
1948 * selected frames. When skip_pred and skip_idct both discard a frame,
1949 * the decoder may skip all pixel operations for it and output it with
1950 * valid metadata and undefined pixels.
1951 * - encoding: unused
1952 * - decoding: Set by user.
1953 */
1956
1957/**
1958 * @defgroup lavc_hwaccel AVHWAccel
1959 *
1960 * @note Nothing in this structure should be accessed by the user. At some
1961 * point in future it will not be externally visible at all.
1962 *
1963 * @{
1964 */
1965typedef struct AVHWAccel {
1966 /**
1967 * Name of the hardware accelerated codec.
1968 * The name is globally unique among encoders and among decoders (but an
1969 * encoder and a decoder can share the same name).
1970 */
1971 const char *name;
1972
1973 /**
1974 * Type of codec implemented by the hardware accelerator.
1975 *
1976 * See AVMEDIA_TYPE_xxx
1977 */
1979
1980 /**
1981 * Codec implemented by the hardware accelerator.
1982 *
1983 * See AV_CODEC_ID_xxx
1984 */
1986
1987 /**
1988 * Supported pixel format.
1989 *
1990 * Only hardware accelerated formats are supported here.
1991 */
1993
1994 /**
1995 * Hardware accelerated codec capabilities.
1996 * see AV_HWACCEL_CODEC_CAP_*
1997 */
1999} AVHWAccel;
2000
2001/**
2002 * HWAccel is experimental and is thus avoided in favor of non experimental
2003 * codecs
2004 */
2005#define AV_HWACCEL_CODEC_CAP_EXPERIMENTAL 0x0200
2006
2007/**
2008 * Hardware acceleration should be used for decoding even if the codec level
2009 * used is unknown or higher than the maximum supported level reported by the
2010 * hardware driver.
2011 *
2012 * It's generally a good idea to pass this flag unless you have a specific
2013 * reason not to, as hardware tends to under-report supported levels.
2014 */
2015#define AV_HWACCEL_FLAG_IGNORE_LEVEL (1 << 0)
2016
2017/**
2018 * Hardware acceleration can output YUV pixel formats with a different chroma
2019 * sampling than 4:2:0 and/or other than 8 bits per component.
2020 */
2021#define AV_HWACCEL_FLAG_ALLOW_HIGH_DEPTH (1 << 1)
2022
2023/**
2024 * Hardware acceleration should still be attempted for decoding when the
2025 * codec profile does not match the reported capabilities of the hardware.
2026 *
2027 * For example, this can be used to try to decode baseline profile H.264
2028 * streams in hardware - it will often succeed, because many streams marked
2029 * as baseline profile actually conform to constrained baseline profile.
2030 *
2031 * @warning If the stream is actually not supported then the behaviour is
2032 * undefined, and may include returning entirely incorrect output
2033 * while indicating success.
2034 */
2035#define AV_HWACCEL_FLAG_ALLOW_PROFILE_MISMATCH (1 << 2)
2036
2037/**
2038 * Some hardware decoders (namely nvdec) can either output direct decoder
2039 * surfaces, or make an on-device copy and return said copy.
2040 * There is a hard limit on how many decoder surfaces there can be, and it
2041 * cannot be accurately guessed ahead of time.
2042 * For some processing chains, this can be okay, but others will run into the
2043 * limit and in turn produce very confusing errors that require fine tuning of
2044 * more or less obscure options by the user, or in extreme cases cannot be
2045 * resolved at all without inserting an avfilter that forces a copy.
2046 *
2047 * Thus, the hwaccel will by default make a copy for safety and resilience.
2048 * If a users really wants to minimize the amount of copies, they can set this
2049 * flag and ensure their processing chain does not exhaust the surface pool.
2050 */
2051#define AV_HWACCEL_FLAG_UNSAFE_OUTPUT (1 << 3)
2052
2053/**
2054 * @}
2055 */
2056
2059
2060 SUBTITLE_BITMAP, ///< A bitmap, pict will be set
2061
2062 /**
2063 * Plain text, the text field must be set by the decoder and is
2064 * authoritative. ass and pict fields may contain approximations.
2065 */
2067
2068 /**
2069 * Formatted text, the ass field must be set by the decoder and is
2070 * authoritative. pict and text fields may contain approximations.
2071 */
2073};
2074
2075#define AV_SUBTITLE_FLAG_FORCED 0x00000001
2076
2077typedef struct AVSubtitleRect {
2078 int x; ///< top left corner of pict, undefined when pict is not set
2079 int y; ///< top left corner of pict, undefined when pict is not set
2080 int w; ///< width of pict, undefined when pict is not set
2081 int h; ///< height of pict, undefined when pict is not set
2082 int nb_colors; ///< number of colors in pict, undefined when pict is not set
2083
2084 /**
2085 * data+linesize for the bitmap of this subtitle.
2086 * Can be set for text/ass as well once they are rendered.
2087 */
2088 uint8_t *data[4];
2089 int linesize[4];
2090
2093
2094 char *text; ///< 0 terminated plain UTF-8 text
2095
2096 /**
2097 * 0 terminated ASS/SSA compatible event line.
2098 * The presentation of this is unaffected by the other values in this
2099 * struct.
2100 */
2101 char *ass;
2103
2104typedef struct AVSubtitle {
2105 uint16_t format; /* 0 = graphics */
2106 uint32_t start_display_time; /* relative to packet pts, in ms */
2107 uint32_t end_display_time; /* relative to packet pts, in ms */
2108 unsigned num_rects;
2110 int64_t pts; ///< Same as packet pts, in AV_TIME_BASE
2111} AVSubtitle;
2112
2113/**
2114 * Return the LIBAVCODEC_VERSION_INT constant.
2115 */
2116unsigned avcodec_version(void);
2117
2118/**
2119 * Return the libavcodec build-time configuration.
2120 */
2121const char *avcodec_configuration(void);
2122
2123/**
2124 * Return the libavcodec license.
2125 */
2126const char *avcodec_license(void);
2127
2128/**
2129 * Allocate an AVCodecContext and set its fields to default values. The
2130 * resulting struct should be freed with avcodec_free_context().
2131 *
2132 * @param codec if non-NULL, allocate private data and initialize defaults
2133 * for the given codec. It is illegal to then call avcodec_open2()
2134 * with a different codec.
2135 * If NULL, then the codec-specific defaults won't be initialized,
2136 * which may result in suboptimal default settings (this is
2137 * important mainly for encoders, e.g. libx264).
2138 *
2139 * @return An AVCodecContext filled with default values or NULL on failure.
2140 */
2142
2143/**
2144 * Free the codec context and everything associated with it and write NULL to
2145 * the provided pointer.
2146 */
2148
2149/**
2150 * Get the AVClass for AVCodecContext. It can be used in combination with
2151 * AV_OPT_SEARCH_FAKE_OBJ for examining options.
2152 *
2153 * @see av_opt_find().
2154 */
2156
2157/**
2158 * Get the AVClass for AVSubtitleRect. It can be used in combination with
2159 * AV_OPT_SEARCH_FAKE_OBJ for examining options.
2160 *
2161 * @see av_opt_find().
2162 */
2164
2165/**
2166 * Fill the parameters struct based on the values from the supplied codec
2167 * context. Any allocated fields in par are freed and replaced with duplicates
2168 * of the corresponding fields in codec.
2169 *
2170 * @return >= 0 on success, a negative AVERROR code on failure
2171 *
2172 * @relates AVCodecParameters
2173 */
2175 const AVCodecContext *codec);
2176
2177/**
2178 * Fill the codec context based on the values from the supplied codec
2179 * parameters. Any allocated fields in codec that have a corresponding field in
2180 * par are freed and replaced with duplicates of the corresponding field in par.
2181 * Fields in codec that do not have a counterpart in par are not touched.
2182 *
2183 * @return >= 0 on success, a negative AVERROR code on failure.
2184 *
2185 * @relates AVCodecParameters
2186 */
2188 const struct AVCodecParameters *par);
2189
2190/**
2191 * Initialize the AVCodecContext to use the given AVCodec. Prior to using this
2192 * function the context has to be allocated with avcodec_alloc_context3().
2193 *
2194 * The functions avcodec_find_decoder_by_name(), avcodec_find_encoder_by_name(),
2195 * avcodec_find_decoder() and avcodec_find_encoder() provide an easy way for
2196 * retrieving a codec.
2197 *
2198 * Depending on the codec, you might need to set options in the codec context
2199 * also for decoding (e.g. width, height, or the pixel or audio sample format in
2200 * the case the information is not available in the bitstream, as when decoding
2201 * raw audio or video).
2202 *
2203 * Options in the codec context can be set either by setting them in the options
2204 * AVDictionary, or by setting the values in the context itself, directly or by
2205 * using the av_opt_set() API before calling this function.
2206 *
2207 * Example:
2208 * @code
2209 * av_dict_set(&opts, "b", "2.5M", 0);
2210 * codec = avcodec_find_decoder(AV_CODEC_ID_H264);
2211 * if (!codec)
2212 * exit(1);
2213 *
2214 * context = avcodec_alloc_context3(codec);
2215 *
2216 * if (avcodec_open2(context, codec, opts) < 0)
2217 * exit(1);
2218 * @endcode
2219 *
2220 * In the case AVCodecParameters are available (e.g. when demuxing a stream
2221 * using libavformat, and accessing the AVStream contained in the demuxer), the
2222 * codec parameters can be copied to the codec context using
2223 * avcodec_parameters_to_context(), as in the following example:
2224 *
2225 * @code
2226 * AVStream *stream = ...;
2227 * context = avcodec_alloc_context3(codec);
2228 * if (avcodec_parameters_to_context(context, stream->codecpar) < 0)
2229 * exit(1);
2230 * if (avcodec_open2(context, codec, NULL) < 0)
2231 * exit(1);
2232 * @endcode
2233 *
2234 * @note Always call this function before using decoding routines (such as
2235 * @ref avcodec_receive_frame()).
2236 *
2237 * @param avctx The context to initialize.
2238 * @param codec The codec to open this context for. If a non-NULL codec has been
2239 * previously passed to avcodec_alloc_context3() or
2240 * for this context, then this parameter MUST be either NULL or
2241 * equal to the previously passed codec.
2242 * @param options A dictionary filled with AVCodecContext and codec-private
2243 * options, which are set on top of the options already set in
2244 * avctx, can be NULL. On return this object will be filled with
2245 * options that were not found in the avctx codec context.
2246 *
2247 * @return zero on success, a negative value on error
2248 * @see avcodec_alloc_context3(), avcodec_find_decoder(), avcodec_find_encoder(),
2249 * av_dict_set(), av_opt_set(), av_opt_find(), avcodec_parameters_to_context()
2250 */
2251int avcodec_open2(AVCodecContext *avctx, const AVCodec *codec, AVDictionary **options);
2252
2253/**
2254 * Try to reconfigure the encoder with the provided dictionary. May only be used
2255 * if a codec with AV_CODEC_CAP_ENCODER_RECONF has been opened.
2256 *
2257 * Not all options can be changed, and it depends on the encoder. If any of the
2258 * options can't be applied (Either because the option can't be changed, because
2259 * invalid values for them were passed, or other errors), it is not guaranteed that
2260 * the state of the encoder is the same as prior to calling this function, but in
2261 * most cases it should.
2262 * Unapplied options will remain in *dict, and owned by the caller.
2263 *
2264 * @param avctx The context to reconfigure.
2265 * @param options A dictionary filled with AVCodecContext and codec-private
2266 * options, which are set on top of the options already set in
2267 * avctx. Can't be NULL.
2268 *
2269 * @retval 0 success
2270 * @retval AVERROR_OPTION_NOT_FOUND an entry with an invalid key was passed. The
2271 * context is untouched.
2272 * @retval AVERROR(EINVAL) an entry with an invalid value or an invalid
2273 * argument was passed.
2274 * @retval AVERROR(ENOSYS) unsupported encoder. The context is untouched.
2275 * @retval "another negative error code" other errors.
2276 */
2278
2279/**
2280 * Free all allocated data in the given subtitle struct.
2281 *
2282 * @param sub AVSubtitle to free.
2283 */
2285
2286/**
2287 * @}
2288 */
2289
2290/**
2291 * @addtogroup lavc_decoding
2292 * @{
2293 */
2294
2295/**
2296 * The default callback for AVCodecContext.get_buffer2(). It is made public so
2297 * it can be called by custom get_buffer2() implementations for decoders without
2298 * AV_CODEC_CAP_DR1 set.
2299 */
2301
2302/**
2303 * The default callback for AVCodecContext.get_encode_buffer(). It is made public so
2304 * it can be called by custom get_encode_buffer() implementations for encoders without
2305 * AV_CODEC_CAP_DR1 set.
2306 */
2308
2309/**
2310 * Modify width and height values so that they will result in a memory
2311 * buffer that is acceptable for the codec if you do not use any horizontal
2312 * padding.
2313 *
2314 * May only be used if a codec with AV_CODEC_CAP_DR1 has been opened.
2315 */
2317
2318/**
2319 * Modify width and height values so that they will result in a memory
2320 * buffer that is acceptable for the codec if you also ensure that all
2321 * line sizes are a multiple of the respective linesize_align[i].
2322 *
2323 * May only be used if a codec with AV_CODEC_CAP_DR1 has been opened.
2324 */
2326 int linesize_align[AV_NUM_DATA_POINTERS]);
2327
2328/**
2329 * Decode a subtitle message.
2330 * Return a negative value on error, otherwise return the number of bytes used.
2331 * If no subtitle could be decompressed, got_sub_ptr is zero.
2332 * Otherwise, the subtitle is stored in *sub.
2333 * Note that AV_CODEC_CAP_DR1 is not available for subtitle codecs. This is for
2334 * simplicity, because the performance difference is expected to be negligible
2335 * and reusing a get_buffer written for video codecs would probably perform badly
2336 * due to a potentially very different allocation pattern.
2337 *
2338 * Some decoders (those marked with AV_CODEC_CAP_DELAY) have a delay between input
2339 * and output. This means that for some packets they will not immediately
2340 * produce decoded output and need to be flushed at the end of decoding to get
2341 * all the decoded data. Flushing is done by calling this function with packets
2342 * with avpkt->data set to NULL and avpkt->size set to 0 until it stops
2343 * returning subtitles. It is safe to flush even those decoders that are not
2344 * marked with AV_CODEC_CAP_DELAY, then no subtitles will be returned.
2345 *
2346 * @note The AVCodecContext MUST have been opened with @ref avcodec_open2()
2347 * before packets may be fed to the decoder.
2348 *
2349 * @param avctx the codec context
2350 * @param[out] sub The preallocated AVSubtitle in which the decoded subtitle will be stored,
2351 * must be freed with avsubtitle_free if *got_sub_ptr is set.
2352 * @param[in,out] got_sub_ptr Zero if no subtitle could be decompressed, otherwise, it is nonzero.
2353 * @param[in] avpkt The input AVPacket containing the input buffer.
2354 */
2356 int *got_sub_ptr, const AVPacket *avpkt);
2357
2358/**
2359 * Supply raw packet data as input to a decoder.
2360 *
2361 * Internally, this call will copy relevant AVCodecContext fields, which can
2362 * influence decoding per-packet, and apply them when the packet is actually
2363 * decoded. (For example AVCodecContext.skip_frame, which might direct the
2364 * decoder to drop the frame contained by the packet sent with this function.)
2365 *
2366 * @warning The input buffer, avpkt->data must be AV_INPUT_BUFFER_PADDING_SIZE
2367 * larger than the actual read bytes because some optimized bitstream
2368 * readers read 32 or 64 bits at once and could read over the end.
2369 *
2370 * @note The AVCodecContext MUST have been opened with @ref avcodec_open2()
2371 * before packets may be fed to the decoder.
2372 *
2373 * @param avctx codec context
2374 * @param[in] avpkt The input AVPacket. Usually, this will be a single video
2375 * frame, or several complete audio frames.
2376 * Ownership of the packet remains with the caller, and the
2377 * decoder will not write to the packet. The decoder may create
2378 * a reference to the packet data (or copy it if the packet is
2379 * not reference-counted).
2380 * Unlike with older APIs, the packet is always fully consumed,
2381 * and if it contains multiple frames (e.g. some audio codecs),
2382 * will require you to call avcodec_receive_frame() multiple
2383 * times afterwards before you can send a new packet.
2384 * It can be NULL (or an AVPacket with data set to NULL and
2385 * size set to 0); in this case, it is considered a flush
2386 * packet, which signals the end of the stream. Sending the
2387 * first flush packet will return success. Subsequent ones are
2388 * unnecessary and will return AVERROR_EOF. If the decoder
2389 * still has frames buffered, it will return them after sending
2390 * a flush packet.
2391 *
2392 * @retval 0 success
2393 * @retval AVERROR(EAGAIN) input is not accepted in the current state - user
2394 * must read output with avcodec_receive_frame() (once
2395 * all output is read, the packet should be resent,
2396 * and the call will not fail with EAGAIN).
2397 * @retval AVERROR_EOF the decoder has been flushed, and no new packets can be
2398 * sent to it (also returned if more than 1 flush
2399 * packet is sent)
2400 * @retval AVERROR(EINVAL) codec not opened, it is an encoder, or requires flush
2401 * @retval AVERROR(ENOMEM) failed to add packet to internal queue, or similar
2402 * @retval "another negative error code" legitimate decoding errors
2403 */
2405
2406/**
2407 * Return decoded output data from a decoder or encoder (when the
2408 * @ref AV_CODEC_FLAG_RECON_FRAME flag is used).
2409 *
2410 * @param avctx codec context
2411 * @param frame This will be set to a reference-counted video or audio
2412 * frame (depending on the decoder type) allocated by the
2413 * codec. Note that the function will always call
2414 * av_frame_unref(frame) before doing anything else.
2415 * @param flags Combination of AV_CODEC_RECEIVE_FRAME_FLAG_* flags.
2416 *
2417 * @retval 0 success, a frame was returned
2418 * @retval AVERROR(EAGAIN) output is not available in this state - user must
2419 * try to send new input
2420 * @retval AVERROR_EOF the codec has been fully flushed, and there will be
2421 * no more output frames
2422 * @retval AVERROR(EINVAL) codec not opened, or it is an encoder without the
2423 * @ref AV_CODEC_FLAG_RECON_FRAME flag enabled
2424 * @retval "other negative error code" legitimate decoding errors
2425 */
2427
2428/**
2429 * Alias for `avcodec_receive_frame_flags(avctx, frame, 0)`.
2430 */
2432
2433/**
2434 * Supply a raw video or audio frame to the encoder. Use avcodec_receive_packet()
2435 * to retrieve buffered output packets.
2436 *
2437 * @param avctx codec context
2438 * @param[in] frame AVFrame containing the raw audio or video frame to be encoded.
2439 * Ownership of the frame remains with the caller, and the
2440 * encoder will not write to the frame. The encoder may create
2441 * a reference to the frame data (or copy it if the frame is
2442 * not reference-counted).
2443 * It can be NULL, in which case it is considered a flush
2444 * packet. This signals the end of the stream. If the encoder
2445 * still has packets buffered, it will return them after this
2446 * call. Once flushing mode has been entered, additional flush
2447 * packets are ignored, and sending frames will return
2448 * AVERROR_EOF.
2449 *
2450 * For audio:
2451 * If AV_CODEC_CAP_VARIABLE_FRAME_SIZE is set, then each frame
2452 * can have any number of samples.
2453 * If it is not set, or AV_CODEC_FLAG2_FIXED_FRAME_SIZE was
2454 * requested, then frame->nb_samples must be equal to
2455 * avctx->frame_size for all frames except the last.
2456 * The final frame may be smaller than avctx->frame_size.
2457 * @retval 0 success
2458 * @retval AVERROR(EAGAIN) input is not accepted in the current state - user must
2459 * read output with avcodec_receive_packet() (once all
2460 * output is read, the packet should be resent, and the
2461 * call will not fail with EAGAIN).
2462 * @retval AVERROR_EOF the encoder has been flushed, and no new frames can
2463 * be sent to it
2464 * @retval AVERROR(EINVAL) codec not opened, it is a decoder, or requires flush
2465 * @retval AVERROR(ENOMEM) failed to add packet to internal queue, or similar
2466 * @retval "another negative error code" legitimate encoding errors
2467 */
2469
2470/**
2471 * Read encoded data from the encoder.
2472 *
2473 * @param avctx codec context
2474 * @param avpkt This will be set to a reference-counted packet allocated by the
2475 * encoder. Note that the function will always call
2476 * av_packet_unref(avpkt) before doing anything else.
2477 * @retval 0 success
2478 * @retval AVERROR(EAGAIN) output is not available in the current state - user must
2479 * try to send input
2480 * @retval AVERROR_EOF the encoder has been fully flushed, and there will be no
2481 * more output packets
2482 * @retval AVERROR(EINVAL) codec not opened, or it is a decoder
2483 * @retval "another negative error code" legitimate encoding errors
2484 */
2486
2487/**
2488 * Create and return a AVHWFramesContext with values adequate for hardware
2489 * decoding. This is meant to get called from the get_format callback, and is
2490 * a helper for preparing a AVHWFramesContext for AVCodecContext.hw_frames_ctx.
2491 * This API is for decoding with certain hardware acceleration modes/APIs only.
2492 *
2493 * The returned AVHWFramesContext is not initialized. The caller must do this
2494 * with av_hwframe_ctx_init().
2495 *
2496 * Calling this function is not a requirement, but makes it simpler to avoid
2497 * codec or hardware API specific details when manually allocating frames.
2498 *
2499 * Alternatively to this, an API user can set AVCodecContext.hw_device_ctx,
2500 * which sets up AVCodecContext.hw_frames_ctx fully automatically, and makes
2501 * it unnecessary to call this function or having to care about
2502 * AVHWFramesContext initialization at all.
2503 *
2504 * There are a number of requirements for calling this function:
2505 *
2506 * - It must be called from get_format with the same avctx parameter that was
2507 * passed to get_format. Calling it outside of get_format is not allowed, and
2508 * can trigger undefined behavior.
2509 * - The function is not always supported (see description of return values).
2510 * Even if this function returns successfully, hwaccel initialization could
2511 * fail later. (The degree to which implementations check whether the stream
2512 * is actually supported varies. Some do this check only after the user's
2513 * get_format callback returns.)
2514 * - The hw_pix_fmt must be one of the choices suggested by get_format. If the
2515 * user decides to use a AVHWFramesContext prepared with this API function,
2516 * the user must return the same hw_pix_fmt from get_format.
2517 * - The device_ref passed to this function must support the given hw_pix_fmt.
2518 * - After calling this API function, it is the user's responsibility to
2519 * initialize the AVHWFramesContext (returned by the out_frames_ref parameter),
2520 * and to set AVCodecContext.hw_frames_ctx to it. If done, this must be done
2521 * before returning from get_format (this is implied by the normal
2522 * AVCodecContext.hw_frames_ctx API rules).
2523 * - The AVHWFramesContext parameters may change every time time get_format is
2524 * called. Also, AVCodecContext.hw_frames_ctx is reset before get_format. So
2525 * you are inherently required to go through this process again on every
2526 * get_format call.
2527 * - It is perfectly possible to call this function without actually using
2528 * the resulting AVHWFramesContext. One use-case might be trying to reuse a
2529 * previously initialized AVHWFramesContext, and calling this API function
2530 * only to test whether the required frame parameters have changed.
2531 * - Fields that use dynamically allocated values of any kind must not be set
2532 * by the user unless setting them is explicitly allowed by the documentation.
2533 * If the user sets AVHWFramesContext.free and AVHWFramesContext.user_opaque,
2534 * the new free callback must call the potentially set previous free callback.
2535 * This API call may set any dynamically allocated fields, including the free
2536 * callback.
2537 *
2538 * The function will set at least the following fields on AVHWFramesContext
2539 * (potentially more, depending on hwaccel API):
2540 *
2541 * - All fields set by av_hwframe_ctx_alloc().
2542 * - Set the format field to hw_pix_fmt.
2543 * - Set the sw_format field to the most suited and most versatile format. (An
2544 * implication is that this will prefer generic formats over opaque formats
2545 * with arbitrary restrictions, if possible.)
2546 * - Set the width/height fields to the coded frame size, rounded up to the
2547 * API-specific minimum alignment.
2548 * - Only _if_ the hwaccel requires a pre-allocated pool: set the initial_pool_size
2549 * field to the number of maximum reference surfaces possible with the codec,
2550 * plus 1 surface for the user to work (meaning the user can safely reference
2551 * at most 1 decoded surface at a time), plus additional buffering introduced
2552 * by frame threading. If the hwaccel does not require pre-allocation, the
2553 * field is left to 0, and the decoder will allocate new surfaces on demand
2554 * during decoding.
2555 * - Possibly AVHWFramesContext.hwctx fields, depending on the underlying
2556 * hardware API.
2557 *
2558 * Essentially, out_frames_ref returns the same as av_hwframe_ctx_alloc(), but
2559 * with basic frame parameters set.
2560 *
2561 * The function is stateless, and does not change the AVCodecContext or the
2562 * device_ref AVHWDeviceContext.
2563 *
2564 * @param avctx The context which is currently calling get_format, and which
2565 * implicitly contains all state needed for filling the returned
2566 * AVHWFramesContext properly.
2567 * @param device_ref A reference to the AVHWDeviceContext describing the device
2568 * which will be used by the hardware decoder.
2569 * @param hw_pix_fmt The hwaccel format you are going to return from get_format.
2570 * @param out_frames_ref On success, set to a reference to an _uninitialized_
2571 * AVHWFramesContext, created from the given device_ref.
2572 * Fields will be set to values required for decoding.
2573 * Not changed if an error is returned.
2574 * @return zero on success, a negative value on error. The following error codes
2575 * have special semantics:
2576 * AVERROR(ENOENT): the decoder does not support this functionality. Setup
2577 * is always manual, or it is a decoder which does not
2578 * support setting AVCodecContext.hw_frames_ctx at all,
2579 * or it is a software format.
2580 * AVERROR(EINVAL): it is known that hardware decoding is not supported for
2581 * this configuration, or the device_ref is not supported
2582 * for the hwaccel referenced by hw_pix_fmt.
2583 */
2585 AVBufferRef *device_ref,
2587 AVBufferRef **out_frames_ref);
2588
2590 AV_CODEC_CONFIG_PIX_FORMAT, ///< AVPixelFormat, terminated by AV_PIX_FMT_NONE
2591 AV_CODEC_CONFIG_FRAME_RATE, ///< AVRational, terminated by {0, 0}
2592 AV_CODEC_CONFIG_SAMPLE_RATE, ///< int, terminated by 0
2593 AV_CODEC_CONFIG_SAMPLE_FORMAT, ///< AVSampleFormat, terminated by AV_SAMPLE_FMT_NONE
2594 AV_CODEC_CONFIG_CHANNEL_LAYOUT, ///< AVChannelLayout, terminated by {0}
2595 AV_CODEC_CONFIG_COLOR_RANGE, ///< AVColorRange, terminated by AVCOL_RANGE_UNSPECIFIED
2596 AV_CODEC_CONFIG_COLOR_SPACE, ///< AVColorSpace, terminated by AVCOL_SPC_UNSPECIFIED
2597 AV_CODEC_CONFIG_ALPHA_MODE, ///< AVAlphaMode, terminated by AVALPHA_MODE_UNSPECIFIED
2598 AV_CODEC_CONFIG_CHROMA_LOCATION, ///< AVChromaLocation, terminated by AVCHROMA_LOC_UNSPECIFIED
2599};
2600
2601/**
2602 * Retrieve a list of all supported values for a given configuration type.
2603 *
2604 * @param avctx An optional context to use. Values such as
2605 * `strict_std_compliance` may affect the result. If NULL,
2606 * default values are used.
2607 * @param codec The codec to query, or NULL to use avctx->codec.
2608 * @param config The configuration to query.
2609 * @param flags Currently unused; should be set to zero.
2610 * @param out_configs On success, set to a list of configurations, terminated
2611 * by a config-specific terminator, or NULL if all
2612 * possible values are supported.
2613 * @param out_num_configs On success, set to the number of elements in
2614 *out_configs, excluding the terminator. Optional.
2615 */
2617 const AVCodec *codec, enum AVCodecConfig config,
2618 unsigned flags, const void **out_configs,
2619 int *out_num_configs);
2620
2621
2622
2623/**
2624 * @defgroup lavc_parsing Frame parsing
2625 * @{
2626 */
2627
2630 AV_PICTURE_STRUCTURE_TOP_FIELD, ///< coded as top field
2631 AV_PICTURE_STRUCTURE_BOTTOM_FIELD, ///< coded as bottom field
2632 AV_PICTURE_STRUCTURE_FRAME, ///< coded as frame
2633};
2634
2635typedef struct AVCodecParserContext {
2637 const struct AVCodecParser *parser;
2638 int64_t frame_offset; /* offset of the current frame */
2639 int64_t cur_offset; /* current offset
2640 (incremented by each av_parser_parse()) */
2641 int64_t next_frame_offset; /* offset of the next frame */
2642 /* video info */
2643 int pict_type; /* XXX: Put it back in AVCodecContext. */
2644 /**
2645 * This field is used for proper frame duration computation in lavf.
2646 * It signals, how much longer the frame duration of the current frame
2647 * is compared to normal frame duration.
2648 *
2649 * frame_duration = (1 + repeat_pict) * time_base
2650 *
2651 * It is used by codecs like H.264 to display telecined material.
2652 */
2653 int repeat_pict; /* XXX: Put it back in AVCodecContext. */
2654 int64_t pts; /* pts of the current frame */
2655 int64_t dts; /* dts of the current frame */
2656
2657 /* private data */
2658 int64_t last_pts;
2659 int64_t last_dts;
2661
2662#define AV_PARSER_PTS_NB 4
2667
2669#define PARSER_FLAG_COMPLETE_FRAMES 0x0001
2670#define PARSER_FLAG_ONCE 0x0002
2671/// Set if the parser has a valid file offset
2672#define PARSER_FLAG_FETCHED_OFFSET 0x0004
2673#define PARSER_FLAG_USE_CODEC_TS 0x1000
2674
2675 int64_t offset; ///< byte offset from starting packet start
2677
2678 /**
2679 * Set by parser to 1 for key frames and 0 for non-key frames.
2680 * It is initialized to -1, so if the parser doesn't set this flag,
2681 * old-style fallback using AV_PICTURE_TYPE_I picture type as key frames
2682 * will be used.
2683 */
2685
2686 // Timestamp generation support:
2687 /**
2688 * Synchronization point for start of timestamp generation.
2689 *
2690 * Set to >0 for sync point, 0 for no sync point and <0 for undefined
2691 * (default).
2692 *
2693 * For example, this corresponds to presence of H.264 buffering period
2694 * SEI message.
2695 */
2697
2698 /**
2699 * Offset of the current timestamp against last timestamp sync point in
2700 * units of AVCodecContext.time_base.
2701 *
2702 * Set to INT_MIN when dts_sync_point unused. Otherwise, it must
2703 * contain a valid timestamp offset.
2704 *
2705 * Note that the timestamp of sync point has usually a nonzero
2706 * dts_ref_dts_delta, which refers to the previous sync point. Offset of
2707 * the next frame after timestamp sync point will be usually 1.
2708 *
2709 * For example, this corresponds to H.264 cpb_removal_delay.
2710 */
2712
2713 /**
2714 * Presentation delay of current frame in units of AVCodecContext.time_base.
2715 *
2716 * Set to INT_MIN when dts_sync_point unused. Otherwise, it must
2717 * contain valid non-negative timestamp delta (presentation time of a frame
2718 * must not lie in the past).
2719 *
2720 * This delay represents the difference between decoding and presentation
2721 * time of the frame.
2722 *
2723 * For example, this corresponds to H.264 dpb_output_delay.
2724 */
2726
2727 /**
2728 * Position of the packet in file.
2729 *
2730 * Analogous to cur_frame_pts/dts
2731 */
2733
2734 /**
2735 * Byte position of currently parsed frame in stream.
2736 */
2737 int64_t pos;
2738
2739 /**
2740 * Previous frame byte position.
2741 */
2742 int64_t last_pos;
2743
2744 /**
2745 * Duration of the current frame.
2746 * For audio, this is in units of 1 / AVCodecContext.sample_rate.
2747 * For all other types, this is in units of AVCodecContext.time_base.
2748 */
2750
2752
2753 /**
2754 * Indicate whether a picture is coded as a frame, top field or bottom field.
2755 *
2756 * For example, H.264 field_pic_flag equal to 0 corresponds to
2757 * AV_PICTURE_STRUCTURE_FRAME. An H.264 picture with field_pic_flag
2758 * equal to 1 and bottom_field_flag equal to 0 corresponds to
2759 * AV_PICTURE_STRUCTURE_TOP_FIELD.
2760 */
2762
2763 /**
2764 * Picture number incremented in presentation or output order.
2765 * This field may be reinitialized at the first picture of a new sequence.
2766 *
2767 * For example, this corresponds to H.264 PicOrderCnt.
2768 */
2770
2771 /**
2772 * Dimensions of the decoded video intended for presentation.
2773 */
2776
2777 /**
2778 * Dimensions of the coded video.
2779 */
2782
2783 /**
2784 * The format of the coded data, corresponds to enum AVPixelFormat for video
2785 * and for enum AVSampleFormat for audio.
2786 *
2787 * Note that a decoder can have considerable freedom in how exactly it
2788 * decodes the data, so the format reported here might be different from the
2789 * one returned by a decoder.
2790 */
2793
2794typedef struct AVCodecParser {
2795 enum AVCodecID codec_ids[7]; /* several codec IDs are permitted */
2797
2798/**
2799 * Iterate over all registered codec parsers.
2800 *
2801 * @param opaque a pointer where libavcodec will store the iteration state. Must
2802 * point to NULL to start the iteration.
2803 *
2804 * @return the next registered codec parser or NULL when the iteration is
2805 * finished
2806 */
2807const AVCodecParser *av_parser_iterate(void **opaque);
2808
2810
2811/**
2812 * Parse a packet.
2813 *
2814 * @param s parser context.
2815 * @param avctx codec context.
2816 * @param poutbuf set to pointer to parsed buffer or NULL if not yet finished.
2817 * @param poutbuf_size set to size of parsed buffer or zero if not yet finished.
2818 * @param buf input buffer.
2819 * @param buf_size buffer size in bytes without the padding. I.e. the full buffer
2820 size is assumed to be buf_size + AV_INPUT_BUFFER_PADDING_SIZE.
2821 To signal EOF, this should be 0 (so that the last frame
2822 can be output). After EOF has been signaled, only
2823 further calls with buf_size 0 are allowed; to parse
2824 new data, close the parser and allocate a new one.
2825 * @param pts input presentation timestamp.
2826 * @param dts input decoding timestamp.
2827 * @param pos input byte position in stream.
2828 * @return the number of bytes of the input bitstream used.
2829 *
2830 * Example:
2831 * @code
2832 * while(in_len){
2833 * len = av_parser_parse2(myparser, AVCodecContext, &data, &size,
2834 * in_data, in_len,
2835 * pts, dts, pos);
2836 * in_data += len;
2837 * in_len -= len;
2838 *
2839 * if(size)
2840 * decode_frame(data, size);
2841 * }
2842 * @endcode
2843 */
2845 AVCodecContext *avctx,
2846 uint8_t **poutbuf, int *poutbuf_size,
2847 const uint8_t *buf, int buf_size,
2848 int64_t pts, int64_t dts,
2849 int64_t pos);
2850
2852
2853/**
2854 * @}
2855 * @}
2856 */
2857
2858/**
2859 * @addtogroup lavc_encoding
2860 * @{
2861 */
2862
2863int avcodec_encode_subtitle(AVCodecContext *avctx, uint8_t *buf, int buf_size,
2864 const AVSubtitle *sub);
2865
2866
2867/**
2868 * @}
2869 */
2870
2871/**
2872 * @defgroup lavc_misc Utility functions
2873 * @ingroup libavc
2874 *
2875 * Miscellaneous utility functions related to both encoding and decoding
2876 * (or neither).
2877 * @{
2878 */
2879
2880/**
2881 * @defgroup lavc_misc_pixfmt Pixel formats
2882 *
2883 * Functions for working with pixel formats.
2884 * @{
2885 */
2886
2887/**
2888 * Return a value representing the fourCC code associated to the
2889 * pixel format pix_fmt, or 0 if no associated fourCC code can be
2890 * found.
2891 */
2893
2894/**
2895 * Find the best pixel format to convert to given a certain source pixel
2896 * format. When converting from one pixel format to another, information loss
2897 * may occur. For example, when converting from RGB24 to GRAY, the color
2898 * information will be lost. Similarly, other losses occur when converting from
2899 * some formats to other formats. avcodec_find_best_pix_fmt_of_2() searches which of
2900 * the given pixel formats should be used to suffer the least amount of loss.
2901 * The pixel formats from which it chooses one, are determined by the
2902 * pix_fmt_list parameter.
2903 *
2904 *
2905 * @param[in] pix_fmt_list AV_PIX_FMT_NONE terminated array of pixel formats to choose from
2906 * @param[in] src_pix_fmt source pixel format
2907 * @param[in] has_alpha Whether the source pixel format alpha channel is used.
2908 * @param[out] loss_ptr Combination of flags informing you what kind of losses will occur.
2909 * @return The best pixel format to convert to or -1 if none was found.
2910 */
2912 enum AVPixelFormat src_pix_fmt,
2913 int has_alpha, int *loss_ptr);
2914
2916
2917/**
2918 * @}
2919 */
2920
2921void avcodec_string(char *buf, int buf_size, AVCodecContext *enc, int encode);
2922
2923int avcodec_default_execute(AVCodecContext *c, int (*func)(AVCodecContext *c2, void *arg2),void *arg, int *ret, int count, int size);
2924int avcodec_default_execute2(AVCodecContext *c, int (*func)(AVCodecContext *c2, void *arg2, int, int),void *arg, int *ret, int count);
2925//FIXME func typedef
2926
2927/**
2928 * Fill AVFrame audio data and linesize pointers.
2929 *
2930 * The buffer buf must be a preallocated buffer with a size big enough
2931 * to contain the specified samples amount. The filled AVFrame data
2932 * pointers will point to this buffer.
2933 *
2934 * AVFrame extended_data channel pointers are allocated if necessary for
2935 * planar audio.
2936 *
2937 * @param frame the AVFrame
2938 * frame->nb_samples must be set prior to calling the
2939 * function. This function fills in frame->data,
2940 * frame->extended_data, frame->linesize[0].
2941 * @param nb_channels channel count
2942 * @param sample_fmt sample format
2943 * @param buf buffer to use for frame data
2944 * @param buf_size size of buffer
2945 * @param align plane size sample alignment (0 = default)
2946 * @return >=0 on success, negative error code on failure
2947 * @todo return the size in bytes required to store the samples in
2948 * case of success, at the next libavutil bump
2949 */
2951 enum AVSampleFormat sample_fmt, const uint8_t *buf,
2952 int buf_size, int align);
2953
2954/**
2955 * Reset the internal codec state / flush internal buffers. Should be called
2956 * e.g. when seeking or when switching to a different stream.
2957 *
2958 * @note for decoders, this function just releases any references the decoder
2959 * might keep internally, but the caller's references remain valid.
2960 *
2961 * @note for encoders, this function will only do something if the encoder
2962 * declares support for AV_CODEC_CAP_ENCODER_FLUSH. When called, the encoder
2963 * will drain any remaining packets, and can then be reused for a different
2964 * stream (as opposed to sending a null frame which will leave the encoder
2965 * in a permanent EOF state after draining). This can be desirable if the
2966 * cost of tearing down and replacing the encoder instance is high.
2967 */
2969
2970/**
2971 * Return audio frame duration.
2972 *
2973 * @param avctx codec context
2974 * @param frame_bytes size of the frame, or 0 if unknown
2975 * @return frame duration, in samples, if known. 0 if not able to
2976 * determine.
2977 */
2978int av_get_audio_frame_duration(AVCodecContext *avctx, int frame_bytes);
2979
2980/* memory */
2981
2982/**
2983 * Same behaviour av_fast_malloc but the buffer has additional
2984 * AV_INPUT_BUFFER_PADDING_SIZE at the end which will always be 0.
2985 *
2986 * In addition the whole buffer will initially and after resizes
2987 * be 0-initialized so that no uninitialized data will ever appear.
2988 */
2989void av_fast_padded_malloc(void *ptr, unsigned int *size, size_t min_size);
2990
2991/**
2992 * Same behaviour av_fast_padded_malloc except that buffer will always
2993 * be 0-initialized after call.
2994 */
2995void av_fast_padded_mallocz(void *ptr, unsigned int *size, size_t min_size);
2996
2997/**
2998 * @return a positive value if s is open (i.e. avcodec_open2() was called on it),
2999 * 0 otherwise.
3000 */
3002
3003/**
3004 * @}
3005 */
3006
3007#endif /* AVCODEC_AVCODEC_H */
Macro definitions for various function/variable attributes.
#define attribute_deprecated
Definition attributes.h:131
#define AV_PARSER_PTS_NB
Definition avcodec.h:2662
Convenience header that includes libavutil's core.
refcounted data buffer API
Public libavutil channel layout APIs header.
Misc types and constants that do not belong anywhere else.
AVFieldOrder
Definition defs.h:225
AVAudioServiceType
Definition defs.h:249
static int width
static AVPacket * pkt
static enum AVPixelFormat pix_fmt
static int height
static AVFrame * frame
Public dictionary API.
static void encode(AVCodecContext *ctx, AVFrame *frame, AVPacket *pkt, FILE *output)
reference-counted frame API
#define AV_NUM_DATA_POINTERS
Definition frame.h:480
int avcodec_encode_reconfigure(AVCodecContext *avctx, AVDictionary **options)
Try to reconfigure the encoder with the provided dictionary.
int avcodec_open2(AVCodecContext *avctx, const AVCodec *codec, AVDictionary **options)
Initialize the AVCodecContext to use the given AVCodec.
const AVClass * avcodec_get_class(void)
Get the AVClass for AVCodecContext.
const AVClass * avcodec_get_subtitle_rect_class(void)
Get the AVClass for AVSubtitleRect.
AVCodecContext * avcodec_alloc_context3(const AVCodec *codec)
Allocate an AVCodecContext and set its fields to default values.
int avcodec_parameters_from_context(struct AVCodecParameters *par, const AVCodecContext *codec)
Fill the parameters struct based on the values from the supplied codec context.
AVSubtitleType
Definition avcodec.h:2057
int avcodec_parameters_to_context(AVCodecContext *codec, const struct AVCodecParameters *par)
Fill the codec context based on the values from the supplied codec parameters.
void avsubtitle_free(AVSubtitle *sub)
Free all allocated data in the given subtitle struct.
AVCodecID
Identify the syntax and semantics of the bitstream.
Definition codec_id.h:47
const char * avcodec_license(void)
Return the libavcodec license.
unsigned avcodec_version(void)
Return the LIBAVCODEC_VERSION_INT constant.
const char * avcodec_configuration(void)
Return the libavcodec build-time configuration.
void avcodec_free_context(AVCodecContext **avctx)
Free the codec context and everything associated with it and write NULL to the provided pointer.
@ SUBTITLE_BITMAP
A bitmap, pict will be set.
Definition avcodec.h:2060
@ SUBTITLE_ASS
Formatted text, the ass field must be set by the decoder and is authoritative.
Definition avcodec.h:2072
@ SUBTITLE_TEXT
Plain text, the text field must be set by the decoder and is authoritative.
Definition avcodec.h:2066
@ SUBTITLE_NONE
Definition avcodec.h:2058
int avcodec_default_get_buffer2(AVCodecContext *s, AVFrame *frame, int flags)
The default callback for AVCodecContext.get_buffer2().
int avcodec_receive_frame(AVCodecContext *avctx, AVFrame *frame)
Alias for avcodec_receive_frame_flags(avctx, frame, 0).
void avcodec_align_dimensions2(AVCodecContext *s, int *width, int *height, int linesize_align[AV_NUM_DATA_POINTERS])
Modify width and height values so that they will result in a memory buffer that is acceptable for the...
AVDiscard
Definition defs.h:237
void avcodec_align_dimensions(AVCodecContext *s, int *width, int *height)
Modify width and height values so that they will result in a memory buffer that is acceptable for the...
int avcodec_send_packet(AVCodecContext *avctx, const AVPacket *avpkt)
Supply raw packet data as input to a decoder.
int avcodec_receive_packet(AVCodecContext *avctx, AVPacket *avpkt)
Read encoded data from the encoder.
int avcodec_decode_subtitle2(AVCodecContext *avctx, AVSubtitle *sub, int *got_sub_ptr, const AVPacket *avpkt)
Decode a subtitle message.
int avcodec_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...
int avcodec_get_hw_frames_parameters(AVCodecContext *avctx, AVBufferRef *device_ref, enum AVPixelFormat hw_pix_fmt, AVBufferRef **out_frames_ref)
Create and return a AVHWFramesContext with values adequate for hardware decoding.
int avcodec_send_frame(AVCodecContext *avctx, const AVFrame *frame)
Supply a raw video or audio frame to the encoder.
AVCodecConfig
Definition avcodec.h:2589
int avcodec_default_get_encode_buffer(AVCodecContext *s, AVPacket *pkt, int flags)
The default callback for AVCodecContext.get_encode_buffer().
int avcodec_get_supported_config(const AVCodecContext *avctx, const AVCodec *codec, enum AVCodecConfig config, unsigned flags, const void **out_configs, int *out_num_configs)
Retrieve a list of all supported values for a given configuration type.
@ AV_CODEC_CONFIG_PIX_FORMAT
AVPixelFormat, terminated by AV_PIX_FMT_NONE.
Definition avcodec.h:2590
@ AV_CODEC_CONFIG_SAMPLE_FORMAT
AVSampleFormat, terminated by AV_SAMPLE_FMT_NONE.
Definition avcodec.h:2593
@ AV_CODEC_CONFIG_ALPHA_MODE
AVAlphaMode, terminated by AVALPHA_MODE_UNSPECIFIED.
Definition avcodec.h:2597
@ AV_CODEC_CONFIG_FRAME_RATE
AVRational, terminated by {0, 0}.
Definition avcodec.h:2591
@ AV_CODEC_CONFIG_COLOR_SPACE
AVColorSpace, terminated by AVCOL_SPC_UNSPECIFIED.
Definition avcodec.h:2596
@ AV_CODEC_CONFIG_CHROMA_LOCATION
AVChromaLocation, terminated by AVCHROMA_LOC_UNSPECIFIED.
Definition avcodec.h:2598
@ AV_CODEC_CONFIG_COLOR_RANGE
AVColorRange, terminated by AVCOL_RANGE_UNSPECIFIED.
Definition avcodec.h:2595
@ AV_CODEC_CONFIG_SAMPLE_RATE
int, terminated by 0
Definition avcodec.h:2592
@ AV_CODEC_CONFIG_CHANNEL_LAYOUT
AVChannelLayout, terminated by {0}.
Definition avcodec.h:2594
int avcodec_encode_subtitle(AVCodecContext *avctx, uint8_t *buf, int buf_size, const AVSubtitle *sub)
enum AVPixelFormat avcodec_default_get_format(struct AVCodecContext *s, const enum AVPixelFormat *fmt)
unsigned int avcodec_pix_fmt_to_codec_tag(enum AVPixelFormat pix_fmt)
Return a value representing the fourCC code associated to the pixel format pix_fmt,...
enum AVPixelFormat avcodec_find_best_pix_fmt_of_list(const enum AVPixelFormat *pix_fmt_list, enum AVPixelFormat src_pix_fmt, int has_alpha, int *loss_ptr)
Find the best pixel format to convert to given a certain source pixel format.
void av_fast_padded_malloc(void *ptr, unsigned int *size, size_t min_size)
Same behaviour av_fast_malloc but the buffer has additional AV_INPUT_BUFFER_PADDING_SIZE at the end w...
int av_get_audio_frame_duration(AVCodecContext *avctx, int frame_bytes)
Return audio frame duration.
int avcodec_default_execute2(AVCodecContext *c, int(*func)(AVCodecContext *c2, void *arg2, int, int), void *arg, int *ret, int count)
int avcodec_fill_audio_frame(AVFrame *frame, int nb_channels, enum AVSampleFormat sample_fmt, const uint8_t *buf, int buf_size, int align)
Fill AVFrame audio data and linesize pointers.
void avcodec_string(char *buf, int buf_size, AVCodecContext *enc, int encode)
int avcodec_is_open(AVCodecContext *s)
int avcodec_default_execute(AVCodecContext *c, int(*func)(AVCodecContext *c2, void *arg2), void *arg, int *ret, int count, int size)
void av_fast_padded_mallocz(void *ptr, unsigned int *size, size_t min_size)
Same behaviour av_fast_padded_malloc except that buffer will always be 0-initialized after call.
void avcodec_flush_buffers(AVCodecContext *avctx)
Reset the internal codec state / flush internal buffers.
AVCodecParserContext * av_parser_init(enum AVCodecID codec_id)
void av_parser_close(AVCodecParserContext *s)
int av_parser_parse2(AVCodecParserContext *s, AVCodecContext *avctx, uint8_t **poutbuf, int *poutbuf_size, const uint8_t *buf, int buf_size, int64_t pts, int64_t dts, int64_t pos)
Parse a packet.
const AVCodecParser * av_parser_iterate(void **opaque)
Iterate over all registered codec parsers.
AVPictureStructure
Definition avcodec.h:2628
@ AV_PICTURE_STRUCTURE_FRAME
coded as frame
Definition avcodec.h:2632
@ AV_PICTURE_STRUCTURE_BOTTOM_FIELD
coded as bottom field
Definition avcodec.h:2631
@ AV_PICTURE_STRUCTURE_TOP_FIELD
coded as top field
Definition avcodec.h:2630
@ AV_PICTURE_STRUCTURE_UNKNOWN
unknown
Definition avcodec.h:2629
struct AVDictionary AVDictionary
Definition dict.h:95
AVMediaType
Definition avutil.h:198
AVSampleFormat
Audio sample formats.
Definition samplefmt.h:55
static enum AVPixelFormat hw_pix_fmt
Definition hw_decode.c:46
Libavcodec version macros.
Libavcodec version macros.
pixel format definitions
AVChromaLocation
Location of chroma samples.
Definition pixfmt.h:807
AVColorRange
Visual content value range.
Definition pixfmt.h:753
AVAlphaMode
Correlation between the alpha channel and color values.
Definition pixfmt.h:821
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.
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:856
float rc_max_available_vbv_use
Ratecontrol attempt to use, at maximum, of what can be used without an underflow.
Definition avcodec.h:1304
int skip_top
Number of macroblock rows at the top which are skipped.
Definition avcodec.h:1695
int trellis
trellis RD quantization
Definition avcodec.h:1325
int * side_data_prefer_packet
Decoding only.
Definition avcodec.h:1920
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:1268
uint16_t * chroma_intra_matrix
custom intra quantization matrix
Definition avcodec.h:977
int hwaccel_flags
Bit set of AV_HWACCEL_FLAG_* flags, which affect hardware accelerated decoding (if active).
Definition avcodec.h:1505
int subtitle_header_size
Header containing style information for text subtitles.
Definition avcodec.h:1750
int width
picture width / height.
Definition avcodec.h:605
AVPacketSideData * coded_side_data
Additional data associated with the entire coded stream.
Definition avcodec.h:1775
char * stats_out
pass1 encoding statistics output buffer
Definition avcodec.h:1332
const struct AVCodecDescriptor * codec_descriptor
AVCodecDescriptor.
Definition avcodec.h:1716
int rc_buffer_size
decoder bitstream buffer size
Definition avcodec.h:1275
AVChannelLayout ch_layout
Audio channel layout.
Definition avcodec.h:1056
int me_cmp
motion estimation comparison function
Definition avcodec.h:863
int flags2
AV_CODEC_FLAG2_*.
Definition avcodec.h:507
enum AVSampleFormat sample_fmt
audio sample format
Definition avcodec.h:1048
int debug
debug
Definition avcodec.h:1395
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:1237
int64_t max_pixels
The number of pixels per image to maximally accept.
Definition avcodec.h:1794
enum AVColorRange color_range
MPEG vs JPEG YUV range.
Definition avcodec.h:682
char * sub_charenc
Character encoding of the input subtitles file.
Definition avcodec.h:1723
int error_concealment
error concealment flags
Definition avcodec.h:1385
int dct_algo
DCT algorithm, see FF_DCT_* below.
Definition avcodec.h:1533
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:717
int strict_std_compliance
strictly follow the standard (MPEG-4, ...).
Definition avcodec.h:1378
float b_quant_offset
qscale offset between IP and B-frames
Definition avcodec.h:798
int nb_coded_side_data
Definition avcodec.h:1776
enum AVDiscard skip_pred
Skip prediction (intra prediction and motion compensation) for selected frames.
Definition avcodec.h:1954
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:774
enum AVAudioServiceType audio_service_type
Type of service that the audio stream conveys.
Definition avcodec.h:1090
enum AVColorPrimaries color_primaries
Chromaticity coordinates of the source primaries.
Definition avcodec.h:658
int me_subpel_quality
subpel ME quality
Definition avcodec.h:933
AVBufferRef * hw_frames_ctx
A reference to the AVHWFramesContext describing the input (for encoding) or output (decoding) frames.
Definition avcodec.h:1474
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:782
int mb_lmax
maximum MB Lagrange multiplier
Definition avcodec.h:1002
int qmin
minimum quantizer
Definition avcodec.h:1254
int keyint_min
minimum GOP size
Definition avcodec.h:1015
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:791
int dia_size
ME diamond size & shape.
Definition avcodec.h:905
int64_t frame_num
Frame counter, set by libavcodec.
Definition avcodec.h:1890
int workaround_bugs
Work around bugs in encoders which sometimes cannot be detected automatically.
Definition avcodec.h:1347
int apply_cropping
Video decoding only.
Definition avcodec.h:1821
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:1340
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:1571
int rc_override_count
ratecontrol override, see RcOverride
Definition avcodec.h:1282
uint8_t * dump_separator
dump format separator.
Definition avcodec.h:1759
enum AVFieldOrder field_order
Field order.
Definition avcodec.h:695
uint16_t * inter_matrix
custom inter quantization matrix Must be allocated with the av_malloc() family of functions,...
Definition avcodec.h:970
const struct AVHWAccel * hwaccel
Hardware accelerator in use.
Definition avcodec.h:1426
int active_thread_type
Which multithreading methods are in use by the codec.
Definition avcodec.h:1605
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:1879
int sub_charenc_mode
Subtitles character encoding mode.
Definition avcodec.h:1731
int bit_rate_tolerance
number of bits the bitstream is allowed to diverge from the reference.
Definition avcodec.h:1229
int mb_decision
macroblock decision mode
Definition avcodec.h:949
int has_b_frames
Size of the frame reordering buffer in the decoder.
Definition avcodec.h:710
char * codec_whitelist
',' separated list of allowed decoders.
Definition avcodec.h:1767
int level
Encoding level descriptor.
Definition avcodec.h:1653
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:745
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:1660
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:1318
int thread_type
Which multithreading methods to use.
Definition avcodec.h:1596
int me_sub_cmp
subpixel motion estimation comparison function
Definition avcodec.h:869
int profile
profile
Definition avcodec.h:1643
int last_predictor_count
amount of previous MV predictors (2a+1 x 2a+1 square)
Definition avcodec.h:912
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:1616
int nb_decoded_side_data
Definition avcodec.h:1937
int bits_per_raw_sample
Bits per sample/pixel of internal libavcodec pixel/sample format.
Definition avcodec.h:1578
int idct_algo
IDCT algorithm, see FF_IDCT_* below.
Definition avcodec.h:1551
int export_side_data
Bit set of AV_CODEC_EXPORT_DATA_* flags, which affects the kind of metadata exported in frame,...
Definition avcodec.h:1786
enum AVColorSpace colorspace
YUV colorspace type.
Definition avcodec.h:672
enum AVSampleFormat request_sample_fmt
desired sample format
Definition avcodec.h:1098
int initial_padding
Audio only.
Definition avcodec.h:1115
float temporal_cplx_masking
temporary complexity masking (0-> disabled)
Definition avcodec.h:828
int sample_rate
samples per second
Definition avcodec.h:1041
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:842
int delay
Codec delay.
Definition avcodec.h:588
float dark_masking
darkness masking (0-> disabled)
Definition avcodec.h:849
int mb_cmp
macroblock comparison function (not supported yet)
Definition avcodec.h:875
int gop_size
the number of pictures in a group of pictures, or 0 for intra_only
Definition avcodec.h:1022
int skip_alpha
Skip processing alpha if supported by codec.
Definition avcodec.h:1688
int refs
number of reference frames
Definition avcodec.h:702
int ildct_cmp
interlaced DCT comparison function
Definition avcodec.h:881
int mv0_threshold
Note: Value depends upon the compare function used for fullpel ME.
Definition avcodec.h:1029
int mb_lmin
minimum MB Lagrange multiplier
Definition avcodec.h:995
int64_t rc_max_rate
maximum bitrate
Definition avcodec.h:1290
int compression_level
Definition avcodec.h:1243
int discard_damaged_percentage
The percentage of damaged samples to discard a frame.
Definition avcodec.h:1829
int thread_count
thread count is used to decide how many independent tasks should be passed to execute()
Definition avcodec.h:1586
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:1261
void * hwaccel_context
Legacy hardware accelerator context.
Definition avcodec.h:1450
uint16_t * intra_matrix
custom intra quantization matrix Must be allocated with the av_malloc() family of functions,...
Definition avcodec.h:961
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:1311
uint8_t * subtitle_header
Definition avcodec.h:1751
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:1134
AVFrameSideData ** decoded_side_data
Array containing static side data, such as HDR10 CLL / MDCV structures.
Definition avcodec.h:1936
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:919
int64_t rc_min_rate
minimum bitrate
Definition avcodec.h:1297
int trailing_padding
Audio only.
Definition avcodec.h:1126
enum AVDiscard skip_idct
Skip IDCT/dequantization for selected frames.
Definition avcodec.h:1667
enum AVChromaLocation chroma_sample_location
This defines the location of chroma samples.
Definition avcodec.h:689
enum AVAlphaMode alpha_mode
Indicates how the alpha channel of the video is represented.
Definition avcodec.h:1944
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:1635
uint64_t error[AV_NUM_DATA_POINTERS]
error
Definition avcodec.h:1526
float qcompress
amount of qscale change between easy & hard scenes (0.0-1.0)
Definition avcodec.h:1246
float qblur
amount of qscale smoothing over time (0.0-1.0)
Definition avcodec.h:1247
AVBufferRef * hw_device_ctx
A reference to the AVHWDeviceContext describing the device which will be used by a hardware encoder/d...
Definition avcodec.h:1496
int me_range
maximum motion estimation search range in subpel units If 0 then no limit.
Definition avcodec.h:942
int extra_hw_frames
Video decoding only.
Definition avcodec.h:1519
RcOverride * rc_override
Definition avcodec.h:1283
unsigned nb_side_data_prefer_packet
Number of entries in side_data_prefer_packet.
Definition avcodec.h:1924
int64_t max_samples
The number of samples per frame to maximally accept.
Definition avcodec.h:1837
enum AVCodecID codec_id
Definition avcodec.h:453
int pre_dia_size
ME prepass diamond size & shape.
Definition avcodec.h:926
float lumi_masking
luminance masking (0-> disabled)
Definition avcodec.h:821
int extradata_size
Definition avcodec.h:527
int cutoff
Audio cutoff bandwidth (0 means "automatic").
Definition avcodec.h:1083
int skip_bottom
Number of macroblock rows at the bottom which are skipped.
Definition avcodec.h:1702
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:1076
int frame_size
Number of samples per channel in an audio frame.
Definition avcodec.h:1069
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:807
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:1220
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:1709
void * priv_data
Definition avcodec.h:470
float spatial_cplx_masking
spatial complexity masking (0-> disabled)
Definition avcodec.h:835
enum AVDiscard skip_frame
Skip decoding for selected frames.
Definition avcodec.h:1674
int err_recognition
Error recognition; may misdetect some more or less valid parts as errors.
Definition avcodec.h:1419
float i_quant_offset
qscale offset between P and I-frames
Definition avcodec.h:814
int slices
Number of slices.
Definition avcodec.h:1038
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 duration
Duration of the current frame.
Definition avcodec.h:2749
int dts_ref_dts_delta
Offset of the current timestamp against last timestamp sync point in units of AVCodecContext....
Definition avcodec.h:2711
int64_t cur_frame_end[AV_PARSER_PTS_NB]
Definition avcodec.h:2676
int width
Dimensions of the decoded video intended for presentation.
Definition avcodec.h:2774
enum AVFieldOrder field_order
Definition avcodec.h:2751
const struct AVCodecParser * parser
Definition avcodec.h:2637
int64_t pos
Byte position of currently parsed frame in stream.
Definition avcodec.h:2737
int format
The format of the coded data, corresponds to enum AVPixelFormat for video and for enum AVSampleFormat...
Definition avcodec.h:2791
int repeat_pict
This field is used for proper frame duration computation in lavf.
Definition avcodec.h:2653
enum AVPictureStructure picture_structure
Indicate whether a picture is coded as a frame, top field or bottom field.
Definition avcodec.h:2761
int64_t cur_frame_dts[AV_PARSER_PTS_NB]
Definition avcodec.h:2666
int64_t cur_frame_pos[AV_PARSER_PTS_NB]
Position of the packet in file.
Definition avcodec.h:2732
int output_picture_number
Picture number incremented in presentation or output order.
Definition avcodec.h:2769
int pts_dts_delta
Presentation delay of current frame in units of AVCodecContext.time_base.
Definition avcodec.h:2725
int64_t next_frame_offset
Definition avcodec.h:2641
int64_t cur_frame_pts[AV_PARSER_PTS_NB]
Definition avcodec.h:2665
int64_t cur_frame_offset[AV_PARSER_PTS_NB]
Definition avcodec.h:2664
int key_frame
Set by parser to 1 for key frames and 0 for non-key frames.
Definition avcodec.h:2684
int64_t last_pos
Previous frame byte position.
Definition avcodec.h:2742
int coded_width
Dimensions of the coded video.
Definition avcodec.h:2780
int64_t offset
byte offset from starting packet start
Definition avcodec.h:2675
int dts_sync_point
Synchronization point for start of timestamp generation.
Definition avcodec.h:2696
enum AVCodecID codec_ids[7]
Definition avcodec.h:2795
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:1985
const char * name
Name of the hardware accelerated codec.
Definition avcodec.h:1971
int capabilities
Hardware accelerated codec capabilities.
Definition avcodec.h:1998
enum AVPixelFormat pix_fmt
Supported pixel format.
Definition avcodec.h:1992
enum AVMediaType type
Type of codec implemented by the hardware accelerator.
Definition avcodec.h:1978
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:2078
char * ass
0 terminated ASS/SSA compatible event line.
Definition avcodec.h:2101
int w
width of pict, undefined when pict is not set
Definition avcodec.h:2080
int nb_colors
number of colors in pict, undefined when pict is not set
Definition avcodec.h:2082
char * text
0 terminated plain UTF-8 text
Definition avcodec.h:2094
uint8_t * data[4]
data+linesize for the bitmap of this subtitle.
Definition avcodec.h:2088
int y
top left corner of pict, undefined when pict is not set
Definition avcodec.h:2079
enum AVSubtitleType type
Definition avcodec.h:2092
int linesize[4]
Definition avcodec.h:2089
int h
height of pict, undefined when pict is not set
Definition avcodec.h:2081
uint16_t format
Definition avcodec.h:2105
uint32_t start_display_time
Definition avcodec.h:2106
uint32_t end_display_time
Definition avcodec.h:2107
unsigned num_rects
Definition avcodec.h:2108
AVSubtitleRect ** rects
Definition avcodec.h:2109
int64_t pts
Same as packet pts, in AV_TIME_BASE.
Definition avcodec.h:2110
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
static int64_t pts