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