FFmpeg  4.3.9
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 <errno.h>
31 #include "libavutil/samplefmt.h"
32 #include "libavutil/attributes.h"
33 #include "libavutil/avutil.h"
34 #include "libavutil/buffer.h"
35 #include "libavutil/cpu.h"
37 #include "libavutil/dict.h"
38 #include "libavutil/frame.h"
39 #include "libavutil/hwcontext.h"
40 #include "libavutil/log.h"
41 #include "libavutil/pixfmt.h"
42 #include "libavutil/rational.h"
43 
44 #include "bsf.h"
45 #include "codec.h"
46 #include "codec_desc.h"
47 #include "codec_par.h"
48 #include "codec_id.h"
49 #include "packet.h"
50 #include "version.h"
51 
52 /**
53  * @defgroup libavc libavcodec
54  * Encoding/Decoding Library
55  *
56  * @{
57  *
58  * @defgroup lavc_decoding Decoding
59  * @{
60  * @}
61  *
62  * @defgroup lavc_encoding Encoding
63  * @{
64  * @}
65  *
66  * @defgroup lavc_codec Codecs
67  * @{
68  * @defgroup lavc_codec_native Native Codecs
69  * @{
70  * @}
71  * @defgroup lavc_codec_wrappers External library wrappers
72  * @{
73  * @}
74  * @defgroup lavc_codec_hwaccel Hardware Accelerators bridge
75  * @{
76  * @}
77  * @}
78  * @defgroup lavc_internal Internal
79  * @{
80  * @}
81  * @}
82  */
83 
84 /**
85  * @ingroup libavc
86  * @defgroup lavc_encdec send/receive encoding and decoding API overview
87  * @{
88  *
89  * The avcodec_send_packet()/avcodec_receive_frame()/avcodec_send_frame()/
90  * avcodec_receive_packet() functions provide an encode/decode API, which
91  * decouples input and output.
92  *
93  * The API is very similar for encoding/decoding and audio/video, and works as
94  * follows:
95  * - Set up and open the AVCodecContext as usual.
96  * - Send valid input:
97  * - For decoding, call avcodec_send_packet() to give the decoder raw
98  * compressed data in an AVPacket.
99  * - For encoding, call avcodec_send_frame() to give the encoder an AVFrame
100  * containing uncompressed audio or video.
101  *
102  * In both cases, it is recommended that AVPackets and AVFrames are
103  * refcounted, or libavcodec might have to copy the input data. (libavformat
104  * always returns refcounted AVPackets, and av_frame_get_buffer() allocates
105  * refcounted AVFrames.)
106  * - Receive output in a loop. Periodically call one of the avcodec_receive_*()
107  * functions and process their output:
108  * - For decoding, call avcodec_receive_frame(). On success, it will return
109  * an AVFrame containing uncompressed audio or video data.
110  * - For encoding, call avcodec_receive_packet(). On success, it will return
111  * an AVPacket with a compressed frame.
112  *
113  * Repeat this call until it returns AVERROR(EAGAIN) or an error. The
114  * AVERROR(EAGAIN) return value means that new input data is required to
115  * return new output. In this case, continue with sending input. For each
116  * input frame/packet, the codec will typically return 1 output frame/packet,
117  * but it can also be 0 or more than 1.
118  *
119  * At the beginning of decoding or encoding, the codec might accept multiple
120  * input frames/packets without returning a frame, until its internal buffers
121  * are filled. This situation is handled transparently if you follow the steps
122  * outlined above.
123  *
124  * In theory, sending input can result in EAGAIN - this should happen only if
125  * not all output was received. You can use this to structure alternative decode
126  * or encode loops other than the one suggested above. For example, you could
127  * try sending new input on each iteration, and try to receive output if that
128  * returns EAGAIN.
129  *
130  * End of stream situations. These require "flushing" (aka draining) the codec,
131  * as the codec might buffer multiple frames or packets internally for
132  * performance or out of necessity (consider B-frames).
133  * This is handled as follows:
134  * - Instead of valid input, send NULL to the avcodec_send_packet() (decoding)
135  * or avcodec_send_frame() (encoding) functions. This will enter draining
136  * mode.
137  * - Call avcodec_receive_frame() (decoding) or avcodec_receive_packet()
138  * (encoding) in a loop until AVERROR_EOF is returned. The functions will
139  * not return AVERROR(EAGAIN), unless you forgot to enter draining mode.
140  * - Before decoding can be resumed again, the codec has to be reset with
141  * avcodec_flush_buffers().
142  *
143  * Using the API as outlined above is highly recommended. But it is also
144  * possible to call functions outside of this rigid schema. For example, you can
145  * call avcodec_send_packet() repeatedly without calling
146  * avcodec_receive_frame(). In this case, avcodec_send_packet() will succeed
147  * until the codec's internal buffer has been filled up (which is typically of
148  * size 1 per output frame, after initial input), and then reject input with
149  * AVERROR(EAGAIN). Once it starts rejecting input, you have no choice but to
150  * read at least some output.
151  *
152  * Not all codecs will follow a rigid and predictable dataflow; the only
153  * guarantee is that an AVERROR(EAGAIN) return value on a send/receive call on
154  * one end implies that a receive/send call on the other end will succeed, or
155  * at least will not fail with AVERROR(EAGAIN). In general, no codec will
156  * permit unlimited buffering of input or output.
157  *
158  * This API replaces the following legacy functions:
159  * - avcodec_decode_video2() and avcodec_decode_audio4():
160  * Use avcodec_send_packet() to feed input to the decoder, then use
161  * avcodec_receive_frame() to receive decoded frames after each packet.
162  * Unlike with the old video decoding API, multiple frames might result from
163  * a packet. For audio, splitting the input packet into frames by partially
164  * decoding packets becomes transparent to the API user. You never need to
165  * feed an AVPacket to the API twice (unless it is rejected with AVERROR(EAGAIN) - then
166  * no data was read from the packet).
167  * Additionally, sending a flush/draining packet is required only once.
168  * - avcodec_encode_video2()/avcodec_encode_audio2():
169  * Use avcodec_send_frame() to feed input to the encoder, then use
170  * avcodec_receive_packet() to receive encoded packets.
171  * Providing user-allocated buffers for avcodec_receive_packet() is not
172  * possible.
173  * - The new API does not handle subtitles yet.
174  *
175  * Mixing new and old function calls on the same AVCodecContext is not allowed,
176  * and will result in undefined behavior.
177  *
178  * Some codecs might require using the new API; using the old API will return
179  * an error when calling it. All codecs support the new API.
180  *
181  * A codec is not allowed to return AVERROR(EAGAIN) for both sending and receiving. This
182  * would be an invalid state, which could put the codec user into an endless
183  * loop. The API has no concept of time either: it cannot happen that trying to
184  * do avcodec_send_packet() results in AVERROR(EAGAIN), but a repeated call 1 second
185  * later accepts the packet (with no other receive/flush API calls involved).
186  * The API is a strict state machine, and the passage of time is not supposed
187  * to influence it. Some timing-dependent behavior might still be deemed
188  * acceptable in certain cases. But it must never result in both send/receive
189  * returning EAGAIN at the same time at any point. It must also absolutely be
190  * avoided that the current state is "unstable" and can "flip-flop" between
191  * the send/receive APIs allowing progress. For example, it's not allowed that
192  * the codec randomly decides that it actually wants to consume a packet now
193  * instead of returning a frame, after it just returned AVERROR(EAGAIN) on an
194  * avcodec_send_packet() call.
195  * @}
196  */
197 
198 /**
199  * @defgroup lavc_core Core functions/structures.
200  * @ingroup libavc
201  *
202  * Basic definitions, functions for querying libavcodec capabilities,
203  * allocating core structures, etc.
204  * @{
205  */
206 
207 /**
208  * @ingroup lavc_decoding
209  * Required number of additionally allocated bytes at the end of the input bitstream for decoding.
210  * This is mainly needed because some optimized bitstream readers read
211  * 32 or 64 bit at once and could read over the end.<br>
212  * Note: If the first 23 bits of the additional bytes are not 0, then damaged
213  * MPEG bitstreams could cause overread and segfault.
214  */
215 #define AV_INPUT_BUFFER_PADDING_SIZE 64
216 
217 /**
218  * @ingroup lavc_encoding
219  * minimum encoding buffer size
220  * Used to avoid some checks during header writing.
221  */
222 #define AV_INPUT_BUFFER_MIN_SIZE 16384
223 
224 /**
225  * @ingroup lavc_decoding
226  */
228  /* We leave some space between them for extensions (drop some
229  * keyframes for intra-only or drop just some bidir frames). */
230  AVDISCARD_NONE =-16, ///< discard nothing
231  AVDISCARD_DEFAULT = 0, ///< discard useless packets like 0 size packets in avi
232  AVDISCARD_NONREF = 8, ///< discard all non reference
233  AVDISCARD_BIDIR = 16, ///< discard all bidirectional frames
234  AVDISCARD_NONINTRA= 24, ///< discard all non intra frames
235  AVDISCARD_NONKEY = 32, ///< discard all frames except keyframes
236  AVDISCARD_ALL = 48, ///< discard all
237 };
238 
249  AV_AUDIO_SERVICE_TYPE_NB , ///< Not part of ABI
250 };
251 
252 /**
253  * @ingroup lavc_encoding
254  */
255 typedef struct RcOverride{
258  int qscale; // If this is 0 then quality_factor will be used instead.
260 } RcOverride;
261 
262 /* encoding support
263  These flags can be passed in AVCodecContext.flags before initialization.
264  Note: Not everything is supported yet.
265 */
266 
267 /**
268  * Allow decoders to produce frames with data planes that are not aligned
269  * to CPU requirements (e.g. due to cropping).
270  */
271 #define AV_CODEC_FLAG_UNALIGNED (1 << 0)
272 /**
273  * Use fixed qscale.
274  */
275 #define AV_CODEC_FLAG_QSCALE (1 << 1)
276 /**
277  * 4 MV per MB allowed / advanced prediction for H.263.
278  */
279 #define AV_CODEC_FLAG_4MV (1 << 2)
280 /**
281  * Output even those frames that might be corrupted.
282  */
283 #define AV_CODEC_FLAG_OUTPUT_CORRUPT (1 << 3)
284 /**
285  * Use qpel MC.
286  */
287 #define AV_CODEC_FLAG_QPEL (1 << 4)
288 /**
289  * Don't output frames whose parameters differ from first
290  * decoded frame in stream.
291  */
292 #define AV_CODEC_FLAG_DROPCHANGED (1 << 5)
293 /**
294  * Use internal 2pass ratecontrol in first pass mode.
295  */
296 #define AV_CODEC_FLAG_PASS1 (1 << 9)
297 /**
298  * Use internal 2pass ratecontrol in second pass mode.
299  */
300 #define AV_CODEC_FLAG_PASS2 (1 << 10)
301 /**
302  * loop filter.
303  */
304 #define AV_CODEC_FLAG_LOOP_FILTER (1 << 11)
305 /**
306  * Only decode/encode grayscale.
307  */
308 #define AV_CODEC_FLAG_GRAY (1 << 13)
309 /**
310  * error[?] variables will be set during encoding.
311  */
312 #define AV_CODEC_FLAG_PSNR (1 << 15)
313 /**
314  * Input bitstream might be truncated at a random location
315  * instead of only at frame boundaries.
316  */
317 #define AV_CODEC_FLAG_TRUNCATED (1 << 16)
318 /**
319  * Use interlaced DCT.
320  */
321 #define AV_CODEC_FLAG_INTERLACED_DCT (1 << 18)
322 /**
323  * Force low delay.
324  */
325 #define AV_CODEC_FLAG_LOW_DELAY (1 << 19)
326 /**
327  * Place global headers in extradata instead of every keyframe.
328  */
329 #define AV_CODEC_FLAG_GLOBAL_HEADER (1 << 22)
330 /**
331  * Use only bitexact stuff (except (I)DCT).
332  */
333 #define AV_CODEC_FLAG_BITEXACT (1 << 23)
334 /* Fx : Flag for H.263+ extra options */
335 /**
336  * H.263 advanced intra coding / MPEG-4 AC prediction
337  */
338 #define AV_CODEC_FLAG_AC_PRED (1 << 24)
339 /**
340  * interlaced motion estimation
341  */
342 #define AV_CODEC_FLAG_INTERLACED_ME (1 << 29)
343 #define AV_CODEC_FLAG_CLOSED_GOP (1U << 31)
344 
345 /**
346  * Allow non spec compliant speedup tricks.
347  */
348 #define AV_CODEC_FLAG2_FAST (1 << 0)
349 /**
350  * Skip bitstream encoding.
351  */
352 #define AV_CODEC_FLAG2_NO_OUTPUT (1 << 2)
353 /**
354  * Place global headers at every keyframe instead of in extradata.
355  */
356 #define AV_CODEC_FLAG2_LOCAL_HEADER (1 << 3)
357 
358 /**
359  * timecode is in drop frame format. DEPRECATED!!!!
360  */
361 #define AV_CODEC_FLAG2_DROP_FRAME_TIMECODE (1 << 13)
362 
363 /**
364  * Input bitstream might be truncated at a packet boundaries
365  * instead of only at frame boundaries.
366  */
367 #define AV_CODEC_FLAG2_CHUNKS (1 << 15)
368 /**
369  * Discard cropping information from SPS.
370  */
371 #define AV_CODEC_FLAG2_IGNORE_CROP (1 << 16)
372 
373 /**
374  * Show all frames before the first keyframe
375  */
376 #define AV_CODEC_FLAG2_SHOW_ALL (1 << 22)
377 /**
378  * Export motion vectors through frame side data
379  */
380 #define AV_CODEC_FLAG2_EXPORT_MVS (1 << 28)
381 /**
382  * Do not skip samples and export skip information as frame side data
383  */
384 #define AV_CODEC_FLAG2_SKIP_MANUAL (1 << 29)
385 /**
386  * Do not reset ASS ReadOrder field on flush (subtitles decoding)
387  */
388 #define AV_CODEC_FLAG2_RO_FLUSH_NOOP (1 << 30)
389 
390 /* Unsupported options :
391  * Syntax Arithmetic coding (SAC)
392  * Reference Picture Selection
393  * Independent Segment Decoding */
394 /* /Fx */
395 /* codec capabilities */
396 
397 /* Exported side data.
398  These flags can be passed in AVCodecContext.export_side_data before initialization.
399 */
400 /**
401  * Export motion vectors through frame side data
402  */
403 #define AV_CODEC_EXPORT_DATA_MVS (1 << 0)
404 /**
405  * Export encoder Producer Reference Time through packet side data
406  */
407 #define AV_CODEC_EXPORT_DATA_PRFT (1 << 1)
408 /**
409  * Decoding only.
410  * Export the AVVideoEncParams structure through frame side data.
411  */
412 #define AV_CODEC_EXPORT_DATA_VIDEO_ENC_PARAMS (1 << 2)
413 
414 /**
415  * Pan Scan area.
416  * This specifies the area which should be displayed.
417  * Note there may be multiple such areas for one frame.
418  */
419 typedef struct AVPanScan {
420  /**
421  * id
422  * - encoding: Set by user.
423  * - decoding: Set by libavcodec.
424  */
425  int id;
426 
427  /**
428  * width and height in 1/16 pel
429  * - encoding: Set by user.
430  * - decoding: Set by libavcodec.
431  */
432  int width;
433  int height;
434 
435  /**
436  * position of the top left corner in 1/16 pel for up to 3 fields/frames
437  * - encoding: Set by user.
438  * - decoding: Set by libavcodec.
439  */
440  int16_t position[3][2];
441 } AVPanScan;
442 
443 /**
444  * This structure describes the bitrate properties of an encoded bitstream. It
445  * roughly corresponds to a subset the VBV parameters for MPEG-2 or HRD
446  * parameters for H.264/HEVC.
447  */
448 typedef struct AVCPBProperties {
449  /**
450  * Maximum bitrate of the stream, in bits per second.
451  * Zero if unknown or unspecified.
452  */
453 #if FF_API_UNSANITIZED_BITRATES
455 #else
456  int64_t max_bitrate;
457 #endif
458  /**
459  * Minimum bitrate of the stream, in bits per second.
460  * Zero if unknown or unspecified.
461  */
462 #if FF_API_UNSANITIZED_BITRATES
464 #else
465  int64_t min_bitrate;
466 #endif
467  /**
468  * Average bitrate of the stream, in bits per second.
469  * Zero if unknown or unspecified.
470  */
471 #if FF_API_UNSANITIZED_BITRATES
473 #else
474  int64_t avg_bitrate;
475 #endif
476 
477  /**
478  * The size of the buffer to which the ratecontrol is applied, in bits.
479  * Zero if unknown or unspecified.
480  */
482 
483  /**
484  * The delay between the time the packet this structure is associated with
485  * is received and the time when it should be decoded, in periods of a 27MHz
486  * clock.
487  *
488  * UINT64_MAX when unknown or unspecified.
489  */
490  uint64_t vbv_delay;
492 
493 /**
494  * This structure supplies correlation between a packet timestamp and a wall clock
495  * production time. The definition follows the Producer Reference Time ('prft')
496  * as defined in ISO/IEC 14496-12
497  */
498 typedef struct AVProducerReferenceTime {
499  /**
500  * A UTC timestamp, in microseconds, since Unix epoch (e.g, av_gettime()).
501  */
503  int flags;
505 
506 /**
507  * The decoder will keep a reference to the frame and may reuse it later.
508  */
509 #define AV_GET_BUFFER_FLAG_REF (1 << 0)
510 
511 struct AVCodecInternal;
512 
513 /**
514  * main external API structure.
515  * New fields can be added to the end with minor version bumps.
516  * Removal, reordering and changes to existing fields require a major
517  * version bump.
518  * You can use AVOptions (av_opt* / av_set/get*()) to access these fields from user
519  * applications.
520  * The name string for AVOptions options matches the associated command line
521  * parameter name and can be found in libavcodec/options_table.h
522  * The AVOption/command line parameter names differ in some cases from the C
523  * structure field names for historic reasons or brevity.
524  * sizeof(AVCodecContext) must not be used outside libav*.
525  */
526 typedef struct AVCodecContext {
527  /**
528  * information on struct for av_log
529  * - set by avcodec_alloc_context3
530  */
533 
534  enum AVMediaType codec_type; /* see AVMEDIA_TYPE_xxx */
535  const struct AVCodec *codec;
536  enum AVCodecID codec_id; /* see AV_CODEC_ID_xxx */
537 
538  /**
539  * fourcc (LSB first, so "ABCD" -> ('D'<<24) + ('C'<<16) + ('B'<<8) + 'A').
540  * This is used to work around some encoder bugs.
541  * A demuxer should set this to what is stored in the field used to identify the codec.
542  * If there are multiple such fields in a container then the demuxer should choose the one
543  * which maximizes the information about the used codec.
544  * If the codec tag field in a container is larger than 32 bits then the demuxer should
545  * remap the longer ID to 32 bits with a table or other structure. Alternatively a new
546  * extra_codec_tag + size could be added but for this a clear advantage must be demonstrated
547  * first.
548  * - encoding: Set by user, if not then the default based on codec_id will be used.
549  * - decoding: Set by user, will be converted to uppercase by libavcodec during init.
550  */
551  unsigned int codec_tag;
552 
553  void *priv_data;
554 
555  /**
556  * Private context used for internal data.
557  *
558  * Unlike priv_data, this is not codec-specific. It is used in general
559  * libavcodec functions.
560  */
561  struct AVCodecInternal *internal;
562 
563  /**
564  * Private data of the user, can be used to carry app specific stuff.
565  * - encoding: Set by user.
566  * - decoding: Set by user.
567  */
568  void *opaque;
569 
570  /**
571  * the average bitrate
572  * - encoding: Set by user; unused for constant quantizer encoding.
573  * - decoding: Set by user, may be overwritten by libavcodec
574  * if this info is available in the stream
575  */
577 
578  /**
579  * number of bits the bitstream is allowed to diverge from the reference.
580  * the reference can be CBR (for CBR pass1) or VBR (for pass2)
581  * - encoding: Set by user; unused for constant quantizer encoding.
582  * - decoding: unused
583  */
585 
586  /**
587  * Global quality for codecs which cannot change it per frame.
588  * This should be proportional to MPEG-1/2/4 qscale.
589  * - encoding: Set by user.
590  * - decoding: unused
591  */
593 
594  /**
595  * - encoding: Set by user.
596  * - decoding: unused
597  */
599 #define FF_COMPRESSION_DEFAULT -1
600 
601  /**
602  * AV_CODEC_FLAG_*.
603  * - encoding: Set by user.
604  * - decoding: Set by user.
605  */
606  int flags;
607 
608  /**
609  * AV_CODEC_FLAG2_*
610  * - encoding: Set by user.
611  * - decoding: Set by user.
612  */
613  int flags2;
614 
615  /**
616  * some codecs need / can use extradata like Huffman tables.
617  * MJPEG: Huffman tables
618  * rv10: additional flags
619  * MPEG-4: global headers (they can be in the bitstream or here)
620  * The allocated memory should be AV_INPUT_BUFFER_PADDING_SIZE bytes larger
621  * than extradata_size to avoid problems if it is read with the bitstream reader.
622  * The bytewise contents of extradata must not depend on the architecture or CPU endianness.
623  * Must be allocated with the av_malloc() family of functions.
624  * - encoding: Set/allocated/freed by libavcodec.
625  * - decoding: Set/allocated/freed by user.
626  */
629 
630  /**
631  * This is the fundamental unit of time (in seconds) in terms
632  * of which frame timestamps are represented. For fixed-fps content,
633  * timebase should be 1/framerate and timestamp increments should be
634  * identically 1.
635  * This often, but not always is the inverse of the frame rate or field rate
636  * for video. 1/time_base is not the average frame rate if the frame rate is not
637  * constant.
638  *
639  * Like containers, elementary streams also can store timestamps, 1/time_base
640  * is the unit in which these timestamps are specified.
641  * As example of such codec time base see ISO/IEC 14496-2:2001(E)
642  * vop_time_increment_resolution and fixed_vop_rate
643  * (fixed_vop_rate == 0 implies that it is different from the framerate)
644  *
645  * - encoding: MUST be set by user.
646  * - decoding: the use of this field for decoding is deprecated.
647  * Use framerate instead.
648  */
650 
651  /**
652  * For some codecs, the time base is closer to the field rate than the frame rate.
653  * Most notably, H.264 and MPEG-2 specify time_base as half of frame duration
654  * if no telecine is used ...
655  *
656  * Set to time_base ticks per frame. Default 1, e.g., H.264/MPEG-2 set it to 2.
657  */
659 
660  /**
661  * Codec delay.
662  *
663  * Encoding: Number of frames delay there will be from the encoder input to
664  * the decoder output. (we assume the decoder matches the spec)
665  * Decoding: Number of frames delay in addition to what a standard decoder
666  * as specified in the spec would produce.
667  *
668  * Video:
669  * Number of frames the decoded output will be delayed relative to the
670  * encoded input.
671  *
672  * Audio:
673  * For encoding, this field is unused (see initial_padding).
674  *
675  * For decoding, this is the number of samples the decoder needs to
676  * output before the decoder's output is valid. When seeking, you should
677  * start decoding this many samples prior to your desired seek point.
678  *
679  * - encoding: Set by libavcodec.
680  * - decoding: Set by libavcodec.
681  */
682  int delay;
683 
684 
685  /* video only */
686  /**
687  * picture width / height.
688  *
689  * @note Those fields may not match the values of the last
690  * AVFrame output by avcodec_decode_video2 due frame
691  * reordering.
692  *
693  * - encoding: MUST be set by user.
694  * - decoding: May be set by the user before opening the decoder if known e.g.
695  * from the container. Some decoders will require the dimensions
696  * to be set by the caller. During decoding, the decoder may
697  * overwrite those values as required while parsing the data.
698  */
699  int width, height;
700 
701  /**
702  * Bitstream width / height, may be different from width/height e.g. when
703  * the decoded frame is cropped before being output or lowres is enabled.
704  *
705  * @note Those field may not match the value of the last
706  * AVFrame output by avcodec_receive_frame() due frame
707  * reordering.
708  *
709  * - encoding: unused
710  * - decoding: May be set by the user before opening the decoder if known
711  * e.g. from the container. During decoding, the decoder may
712  * overwrite those values as required while parsing the data.
713  */
714  int coded_width, coded_height;
715 
716  /**
717  * the number of pictures in a group of pictures, or 0 for intra_only
718  * - encoding: Set by user.
719  * - decoding: unused
720  */
721  int gop_size;
722 
723  /**
724  * Pixel format, see AV_PIX_FMT_xxx.
725  * May be set by the demuxer if known from headers.
726  * May be overridden by the decoder if it knows better.
727  *
728  * @note This field may not match the value of the last
729  * AVFrame output by avcodec_receive_frame() due frame
730  * reordering.
731  *
732  * - encoding: Set by user.
733  * - decoding: Set by user if known, overridden by libavcodec while
734  * parsing the data.
735  */
737 
738  /**
739  * If non NULL, 'draw_horiz_band' is called by the libavcodec
740  * decoder to draw a horizontal band. It improves cache usage. Not
741  * all codecs can do that. You must check the codec capabilities
742  * beforehand.
743  * When multithreading is used, it may be called from multiple threads
744  * at the same time; threads might draw different parts of the same AVFrame,
745  * or multiple AVFrames, and there is no guarantee that slices will be drawn
746  * in order.
747  * The function is also used by hardware acceleration APIs.
748  * It is called at least once during frame decoding to pass
749  * the data needed for hardware render.
750  * In that mode instead of pixel data, AVFrame points to
751  * a structure specific to the acceleration API. The application
752  * reads the structure and can change some fields to indicate progress
753  * or mark state.
754  * - encoding: unused
755  * - decoding: Set by user.
756  * @param height the height of the slice
757  * @param y the y position of the slice
758  * @param type 1->top field, 2->bottom field, 3->frame
759  * @param offset offset into the AVFrame.data from which the slice should be read
760  */
762  const AVFrame *src, int offset[AV_NUM_DATA_POINTERS],
763  int y, int type, int height);
764 
765  /**
766  * callback to negotiate the pixelFormat
767  * @param fmt is the list of formats which are supported by the codec,
768  * it is terminated by -1 as 0 is a valid format, the formats are ordered by quality.
769  * The first is always the native one.
770  * @note The callback may be called again immediately if initialization for
771  * the selected (hardware-accelerated) pixel format failed.
772  * @warning Behavior is undefined if the callback returns a value not
773  * in the fmt list of formats.
774  * @return the chosen format
775  * - encoding: unused
776  * - decoding: Set by user, if not set the native format will be chosen.
777  */
778  enum AVPixelFormat (*get_format)(struct AVCodecContext *s, const enum AVPixelFormat * fmt);
779 
780  /**
781  * maximum number of B-frames between non-B-frames
782  * Note: The output will be delayed by max_b_frames+1 relative to the input.
783  * - encoding: Set by user.
784  * - decoding: unused
785  */
787 
788  /**
789  * qscale factor between IP and B-frames
790  * If > 0 then the last P-frame quantizer will be used (q= lastp_q*factor+offset).
791  * If < 0 then normal ratecontrol will be done (q= -normal_q*factor+offset).
792  * - encoding: Set by user.
793  * - decoding: unused
794  */
796 
797 #if FF_API_PRIVATE_OPT
798  /** @deprecated use encoder private options instead */
801 #endif
802 
803  /**
804  * qscale offset between IP and B-frames
805  * - encoding: Set by user.
806  * - decoding: unused
807  */
809 
810  /**
811  * Size of the frame reordering buffer in the decoder.
812  * For MPEG-2 it is 1 IPB or 0 low delay IP.
813  * - encoding: Set by libavcodec.
814  * - decoding: Set by libavcodec.
815  */
817 
818 #if FF_API_PRIVATE_OPT
819  /** @deprecated use encoder private options instead */
822 #endif
823 
824  /**
825  * qscale factor between P- and I-frames
826  * If > 0 then the last P-frame quantizer will be used (q = lastp_q * factor + offset).
827  * If < 0 then normal ratecontrol will be done (q= -normal_q*factor+offset).
828  * - encoding: Set by user.
829  * - decoding: unused
830  */
832 
833  /**
834  * qscale offset between P and I-frames
835  * - encoding: Set by user.
836  * - decoding: unused
837  */
839 
840  /**
841  * luminance masking (0-> disabled)
842  * - encoding: Set by user.
843  * - decoding: unused
844  */
846 
847  /**
848  * temporary complexity masking (0-> disabled)
849  * - encoding: Set by user.
850  * - decoding: unused
851  */
853 
854  /**
855  * spatial complexity masking (0-> disabled)
856  * - encoding: Set by user.
857  * - decoding: unused
858  */
860 
861  /**
862  * p block masking (0-> disabled)
863  * - encoding: Set by user.
864  * - decoding: unused
865  */
866  float p_masking;
867 
868  /**
869  * darkness masking (0-> disabled)
870  * - encoding: Set by user.
871  * - decoding: unused
872  */
874 
875  /**
876  * slice count
877  * - encoding: Set by libavcodec.
878  * - decoding: Set by user (or 0).
879  */
881 
882 #if FF_API_PRIVATE_OPT
883  /** @deprecated use encoder private options instead */
886 #define FF_PRED_LEFT 0
887 #define FF_PRED_PLANE 1
888 #define FF_PRED_MEDIAN 2
889 #endif
890 
891  /**
892  * slice offsets in the frame in bytes
893  * - encoding: Set/allocated by libavcodec.
894  * - decoding: Set/allocated by user (or NULL).
895  */
897 
898  /**
899  * sample aspect ratio (0 if unknown)
900  * That is the width of a pixel divided by the height of the pixel.
901  * Numerator and denominator must be relatively prime and smaller than 256 for some video standards.
902  * - encoding: Set by user.
903  * - decoding: Set by libavcodec.
904  */
906 
907  /**
908  * motion estimation comparison function
909  * - encoding: Set by user.
910  * - decoding: unused
911  */
912  int me_cmp;
913  /**
914  * subpixel motion estimation comparison function
915  * - encoding: Set by user.
916  * - decoding: unused
917  */
919  /**
920  * macroblock comparison function (not supported yet)
921  * - encoding: Set by user.
922  * - decoding: unused
923  */
924  int mb_cmp;
925  /**
926  * interlaced DCT comparison function
927  * - encoding: Set by user.
928  * - decoding: unused
929  */
931 #define FF_CMP_SAD 0
932 #define FF_CMP_SSE 1
933 #define FF_CMP_SATD 2
934 #define FF_CMP_DCT 3
935 #define FF_CMP_PSNR 4
936 #define FF_CMP_BIT 5
937 #define FF_CMP_RD 6
938 #define FF_CMP_ZERO 7
939 #define FF_CMP_VSAD 8
940 #define FF_CMP_VSSE 9
941 #define FF_CMP_NSSE 10
942 #define FF_CMP_W53 11
943 #define FF_CMP_W97 12
944 #define FF_CMP_DCTMAX 13
945 #define FF_CMP_DCT264 14
946 #define FF_CMP_MEDIAN_SAD 15
947 #define FF_CMP_CHROMA 256
948 
949  /**
950  * ME diamond size & shape
951  * - encoding: Set by user.
952  * - decoding: unused
953  */
954  int dia_size;
955 
956  /**
957  * amount of previous MV predictors (2a+1 x 2a+1 square)
958  * - encoding: Set by user.
959  * - decoding: unused
960  */
962 
963 #if FF_API_PRIVATE_OPT
964  /** @deprecated use encoder private options instead */
966  int pre_me;
967 #endif
968 
969  /**
970  * motion estimation prepass comparison function
971  * - encoding: Set by user.
972  * - decoding: unused
973  */
975 
976  /**
977  * ME prepass diamond size & shape
978  * - encoding: Set by user.
979  * - decoding: unused
980  */
982 
983  /**
984  * subpel ME quality
985  * - encoding: Set by user.
986  * - decoding: unused
987  */
989 
990  /**
991  * maximum motion estimation search range in subpel units
992  * If 0 then no limit.
993  *
994  * - encoding: Set by user.
995  * - decoding: unused
996  */
997  int me_range;
998 
999  /**
1000  * slice flags
1001  * - encoding: unused
1002  * - decoding: Set by user.
1003  */
1005 #define SLICE_FLAG_CODED_ORDER 0x0001 ///< draw_horiz_band() is called in coded order instead of display
1006 #define SLICE_FLAG_ALLOW_FIELD 0x0002 ///< allow draw_horiz_band() with field slices (MPEG-2 field pics)
1007 #define SLICE_FLAG_ALLOW_PLANE 0x0004 ///< allow draw_horiz_band() with 1 component at a time (SVQ1)
1008 
1009  /**
1010  * macroblock decision mode
1011  * - encoding: Set by user.
1012  * - decoding: unused
1013  */
1015 #define FF_MB_DECISION_SIMPLE 0 ///< uses mb_cmp
1016 #define FF_MB_DECISION_BITS 1 ///< chooses the one which needs the fewest bits
1017 #define FF_MB_DECISION_RD 2 ///< rate distortion
1018 
1019  /**
1020  * custom intra quantization matrix
1021  * Must be allocated with the av_malloc() family of functions, and will be freed in
1022  * avcodec_free_context().
1023  * - encoding: Set/allocated by user, freed by libavcodec. Can be NULL.
1024  * - decoding: Set/allocated/freed by libavcodec.
1025  */
1026  uint16_t *intra_matrix;
1027 
1028  /**
1029  * custom inter quantization matrix
1030  * Must be allocated with the av_malloc() family of functions, and will be freed in
1031  * avcodec_free_context().
1032  * - encoding: Set/allocated by user, freed by libavcodec. Can be NULL.
1033  * - decoding: Set/allocated/freed by libavcodec.
1034  */
1035  uint16_t *inter_matrix;
1036 
1037 #if FF_API_PRIVATE_OPT
1038  /** @deprecated use encoder private options instead */
1041 
1042  /** @deprecated use encoder private options instead */
1045 #endif
1046 
1047  /**
1048  * precision of the intra DC coefficient - 8
1049  * - encoding: Set by user.
1050  * - decoding: Set by libavcodec
1051  */
1053 
1054  /**
1055  * Number of macroblock rows at the top which are skipped.
1056  * - encoding: unused
1057  * - decoding: Set by user.
1058  */
1060 
1061  /**
1062  * Number of macroblock rows at the bottom which are skipped.
1063  * - encoding: unused
1064  * - decoding: Set by user.
1065  */
1067 
1068  /**
1069  * minimum MB Lagrange multiplier
1070  * - encoding: Set by user.
1071  * - decoding: unused
1072  */
1073  int mb_lmin;
1074 
1075  /**
1076  * maximum MB Lagrange multiplier
1077  * - encoding: Set by user.
1078  * - decoding: unused
1079  */
1080  int mb_lmax;
1081 
1082 #if FF_API_PRIVATE_OPT
1083  /**
1084  * @deprecated use encoder private options instead
1085  */
1088 #endif
1089 
1090  /**
1091  * - encoding: Set by user.
1092  * - decoding: unused
1093  */
1095 
1096 #if FF_API_PRIVATE_OPT
1097  /** @deprecated use encoder private options instead */
1100 #endif
1101 
1102  /**
1103  * minimum GOP size
1104  * - encoding: Set by user.
1105  * - decoding: unused
1106  */
1108 
1109  /**
1110  * number of reference frames
1111  * - encoding: Set by user.
1112  * - decoding: Set by lavc.
1113  */
1114  int refs;
1115 
1116 #if FF_API_PRIVATE_OPT
1117  /** @deprecated use encoder private options instead */
1120 #endif
1121 
1122  /**
1123  * Note: Value depends upon the compare function used for fullpel ME.
1124  * - encoding: Set by user.
1125  * - decoding: unused
1126  */
1128 
1129 #if FF_API_PRIVATE_OPT
1130  /** @deprecated use encoder private options instead */
1133 #endif
1134 
1135  /**
1136  * Chromaticity coordinates of the source primaries.
1137  * - encoding: Set by user
1138  * - decoding: Set by libavcodec
1139  */
1141 
1142  /**
1143  * Color Transfer Characteristic.
1144  * - encoding: Set by user
1145  * - decoding: Set by libavcodec
1146  */
1148 
1149  /**
1150  * YUV colorspace type.
1151  * - encoding: Set by user
1152  * - decoding: Set by libavcodec
1153  */
1155 
1156  /**
1157  * MPEG vs JPEG YUV range.
1158  * - encoding: Set by user
1159  * - decoding: Set by libavcodec
1160  */
1162 
1163  /**
1164  * This defines the location of chroma samples.
1165  * - encoding: Set by user
1166  * - decoding: Set by libavcodec
1167  */
1169 
1170  /**
1171  * Number of slices.
1172  * Indicates number of picture subdivisions. Used for parallelized
1173  * decoding.
1174  * - encoding: Set by user
1175  * - decoding: unused
1176  */
1177  int slices;
1178 
1179  /** Field order
1180  * - encoding: set by libavcodec
1181  * - decoding: Set by user.
1182  */
1184 
1185  /* audio only */
1186  int sample_rate; ///< samples per second
1187  int channels; ///< number of audio channels
1188 
1189  /**
1190  * audio sample format
1191  * - encoding: Set by user.
1192  * - decoding: Set by libavcodec.
1193  */
1194  enum AVSampleFormat sample_fmt; ///< sample format
1195 
1196  /* The following data should not be initialized. */
1197  /**
1198  * Number of samples per channel in an audio frame.
1199  *
1200  * - encoding: set by libavcodec in avcodec_open2(). Each submitted frame
1201  * except the last must contain exactly frame_size samples per channel.
1202  * May be 0 when the codec has AV_CODEC_CAP_VARIABLE_FRAME_SIZE set, then the
1203  * frame size is not restricted.
1204  * - decoding: may be set by some decoders to indicate constant frame size
1205  */
1207 
1208  /**
1209  * Frame counter, set by libavcodec.
1210  *
1211  * - decoding: total number of frames returned from the decoder so far.
1212  * - encoding: total number of frames passed to the encoder so far.
1213  *
1214  * @note the counter is not incremented if encoding/decoding resulted in
1215  * an error.
1216  */
1218 
1219  /**
1220  * number of bytes per packet if constant and known or 0
1221  * Used by some WAV based audio codecs.
1222  */
1224 
1225  /**
1226  * Audio cutoff bandwidth (0 means "automatic")
1227  * - encoding: Set by user.
1228  * - decoding: unused
1229  */
1230  int cutoff;
1231 
1232  /**
1233  * Audio channel layout.
1234  * - encoding: set by user.
1235  * - decoding: set by user, may be overwritten by libavcodec.
1236  */
1237  uint64_t channel_layout;
1238 
1239  /**
1240  * Request decoder to use this channel layout if it can (0 for default)
1241  * - encoding: unused
1242  * - decoding: Set by user.
1243  */
1245 
1246  /**
1247  * Type of service that the audio stream conveys.
1248  * - encoding: Set by user.
1249  * - decoding: Set by libavcodec.
1250  */
1252 
1253  /**
1254  * desired sample format
1255  * - encoding: Not used.
1256  * - decoding: Set by user.
1257  * Decoder will decode to this format if it can.
1258  */
1260 
1261  /**
1262  * This callback is called at the beginning of each frame to get data
1263  * buffer(s) for it. There may be one contiguous buffer for all the data or
1264  * there may be a buffer per each data plane or anything in between. What
1265  * this means is, you may set however many entries in buf[] you feel necessary.
1266  * Each buffer must be reference-counted using the AVBuffer API (see description
1267  * of buf[] below).
1268  *
1269  * The following fields will be set in the frame before this callback is
1270  * called:
1271  * - format
1272  * - width, height (video only)
1273  * - sample_rate, channel_layout, nb_samples (audio only)
1274  * Their values may differ from the corresponding values in
1275  * AVCodecContext. This callback must use the frame values, not the codec
1276  * context values, to calculate the required buffer size.
1277  *
1278  * This callback must fill the following fields in the frame:
1279  * - data[]
1280  * - linesize[]
1281  * - extended_data:
1282  * * if the data is planar audio with more than 8 channels, then this
1283  * callback must allocate and fill extended_data to contain all pointers
1284  * to all data planes. data[] must hold as many pointers as it can.
1285  * extended_data must be allocated with av_malloc() and will be freed in
1286  * av_frame_unref().
1287  * * otherwise extended_data must point to data
1288  * - buf[] must contain one or more pointers to AVBufferRef structures. Each of
1289  * the frame's data and extended_data pointers must be contained in these. That
1290  * is, one AVBufferRef for each allocated chunk of memory, not necessarily one
1291  * AVBufferRef per data[] entry. See: av_buffer_create(), av_buffer_alloc(),
1292  * and av_buffer_ref().
1293  * - extended_buf and nb_extended_buf must be allocated with av_malloc() by
1294  * this callback and filled with the extra buffers if there are more
1295  * buffers than buf[] can hold. extended_buf will be freed in
1296  * av_frame_unref().
1297  * Decoders will generally initialize the whole buffer before it is output
1298  * but it can in rare error conditions happen that uninitialized data is passed
1299  * through. \important The buffers returned by get_buffer* should thus not contain sensitive
1300  * data.
1301  *
1302  * If AV_CODEC_CAP_DR1 is not set then get_buffer2() must call
1303  * avcodec_default_get_buffer2() instead of providing buffers allocated by
1304  * some other means.
1305  *
1306  * Each data plane must be aligned to the maximum required by the target
1307  * CPU.
1308  *
1309  * @see avcodec_default_get_buffer2()
1310  *
1311  * Video:
1312  *
1313  * If AV_GET_BUFFER_FLAG_REF is set in flags then the frame may be reused
1314  * (read and/or written to if it is writable) later by libavcodec.
1315  *
1316  * avcodec_align_dimensions2() should be used to find the required width and
1317  * height, as they normally need to be rounded up to the next multiple of 16.
1318  *
1319  * Some decoders do not support linesizes changing between frames.
1320  *
1321  * If frame multithreading is used and thread_safe_callbacks is set,
1322  * this callback may be called from a different thread, but not from more
1323  * than one at once. Does not need to be reentrant.
1324  *
1325  * @see avcodec_align_dimensions2()
1326  *
1327  * Audio:
1328  *
1329  * Decoders request a buffer of a particular size by setting
1330  * AVFrame.nb_samples prior to calling get_buffer2(). The decoder may,
1331  * however, utilize only part of the buffer by setting AVFrame.nb_samples
1332  * to a smaller value in the output frame.
1333  *
1334  * As a convenience, av_samples_get_buffer_size() and
1335  * av_samples_fill_arrays() in libavutil may be used by custom get_buffer2()
1336  * functions to find the required data size and to fill data pointers and
1337  * linesize. In AVFrame.linesize, only linesize[0] may be set for audio
1338  * since all planes must be the same size.
1339  *
1340  * @see av_samples_get_buffer_size(), av_samples_fill_arrays()
1341  *
1342  * - encoding: unused
1343  * - decoding: Set by libavcodec, user can override.
1344  */
1346 
1347  /**
1348  * If non-zero, the decoded audio and video frames returned from
1349  * avcodec_decode_video2() and avcodec_decode_audio4() are reference-counted
1350  * and are valid indefinitely. The caller must free them with
1351  * av_frame_unref() when they are not needed anymore.
1352  * Otherwise, the decoded frames must not be freed by the caller and are
1353  * only valid until the next decode call.
1354  *
1355  * This is always automatically enabled if avcodec_receive_frame() is used.
1356  *
1357  * - encoding: unused
1358  * - decoding: set by the caller before avcodec_open2().
1359  */
1362 
1363  /* - encoding parameters */
1364  float qcompress; ///< amount of qscale change between easy & hard scenes (0.0-1.0)
1365  float qblur; ///< amount of qscale smoothing over time (0.0-1.0)
1366 
1367  /**
1368  * minimum quantizer
1369  * - encoding: Set by user.
1370  * - decoding: unused
1371  */
1372  int qmin;
1373 
1374  /**
1375  * maximum quantizer
1376  * - encoding: Set by user.
1377  * - decoding: unused
1378  */
1379  int qmax;
1380 
1381  /**
1382  * maximum quantizer difference between frames
1383  * - encoding: Set by user.
1384  * - decoding: unused
1385  */
1387 
1388  /**
1389  * decoder bitstream buffer size
1390  * - encoding: Set by user.
1391  * - decoding: unused
1392  */
1394 
1395  /**
1396  * ratecontrol override, see RcOverride
1397  * - encoding: Allocated/set/freed by user.
1398  * - decoding: unused
1399  */
1402 
1403  /**
1404  * maximum bitrate
1405  * - encoding: Set by user.
1406  * - decoding: Set by user, may be overwritten by libavcodec.
1407  */
1409 
1410  /**
1411  * minimum bitrate
1412  * - encoding: Set by user.
1413  * - decoding: unused
1414  */
1416 
1417  /**
1418  * Ratecontrol attempt to use, at maximum, <value> of what can be used without an underflow.
1419  * - encoding: Set by user.
1420  * - decoding: unused.
1421  */
1423 
1424  /**
1425  * Ratecontrol attempt to use, at least, <value> times the amount needed to prevent a vbv overflow.
1426  * - encoding: Set by user.
1427  * - decoding: unused.
1428  */
1430 
1431  /**
1432  * Number of bits which should be loaded into the rc buffer before decoding starts.
1433  * - encoding: Set by user.
1434  * - decoding: unused
1435  */
1437 
1438 #if FF_API_CODER_TYPE
1439 #define FF_CODER_TYPE_VLC 0
1440 #define FF_CODER_TYPE_AC 1
1441 #define FF_CODER_TYPE_RAW 2
1442 #define FF_CODER_TYPE_RLE 3
1443  /**
1444  * @deprecated use encoder private options instead
1445  */
1448 #endif /* FF_API_CODER_TYPE */
1449 
1450 #if FF_API_PRIVATE_OPT
1451  /** @deprecated use encoder private options instead */
1454 #endif
1455 
1456 #if FF_API_PRIVATE_OPT
1457  /** @deprecated use encoder private options instead */
1460 
1461  /** @deprecated use encoder private options instead */
1464 
1465  /** @deprecated use encoder private options instead */
1468 
1469  /** @deprecated use encoder private options instead */
1472 #endif /* FF_API_PRIVATE_OPT */
1473 
1474  /**
1475  * trellis RD quantization
1476  * - encoding: Set by user.
1477  * - decoding: unused
1478  */
1479  int trellis;
1480 
1481 #if FF_API_PRIVATE_OPT
1482  /** @deprecated use encoder private options instead */
1485 
1486  /** @deprecated use encoder private options instead */
1489 
1490  /** @deprecated use encoder private options instead */
1493 #endif
1494 
1495 #if FF_API_RTP_CALLBACK
1496  /**
1497  * @deprecated unused
1498  */
1499  /* The RTP callback: This function is called */
1500  /* every time the encoder has a packet to send. */
1501  /* It depends on the encoder if the data starts */
1502  /* with a Start Code (it should). H.263 does. */
1503  /* mb_nb contains the number of macroblocks */
1504  /* encoded in the RTP payload. */
1506  void (*rtp_callback)(struct AVCodecContext *avctx, void *data, int size, int mb_nb);
1507 #endif
1508 
1509 #if FF_API_PRIVATE_OPT
1510  /** @deprecated use encoder private options instead */
1512  int rtp_payload_size; /* The size of the RTP payload: the coder will */
1513  /* do its best to deliver a chunk with size */
1514  /* below rtp_payload_size, the chunk will start */
1515  /* with a start code on some codecs like H.263. */
1516  /* This doesn't take account of any particular */
1517  /* headers inside the transmitted RTP payload. */
1518 #endif
1519 
1520 #if FF_API_STAT_BITS
1521  /* statistics, used for 2-pass encoding */
1523  int mv_bits;
1531  int i_count;
1533  int p_count;
1538 
1539  /** @deprecated this field is unused */
1542 #endif
1543 
1544  /**
1545  * pass1 encoding statistics output buffer
1546  * - encoding: Set by libavcodec.
1547  * - decoding: unused
1548  */
1549  char *stats_out;
1550 
1551  /**
1552  * pass2 encoding statistics input buffer
1553  * Concatenated stuff from stats_out of pass1 should be placed here.
1554  * - encoding: Allocated/set/freed by user.
1555  * - decoding: unused
1556  */
1557  char *stats_in;
1558 
1559  /**
1560  * Work around bugs in encoders which sometimes cannot be detected automatically.
1561  * - encoding: Set by user
1562  * - decoding: Set by user
1563  */
1565 #define FF_BUG_AUTODETECT 1 ///< autodetection
1566 #define FF_BUG_XVID_ILACE 4
1567 #define FF_BUG_UMP4 8
1568 #define FF_BUG_NO_PADDING 16
1569 #define FF_BUG_AMV 32
1570 #define FF_BUG_QPEL_CHROMA 64
1571 #define FF_BUG_STD_QPEL 128
1572 #define FF_BUG_QPEL_CHROMA2 256
1573 #define FF_BUG_DIRECT_BLOCKSIZE 512
1574 #define FF_BUG_EDGE 1024
1575 #define FF_BUG_HPEL_CHROMA 2048
1576 #define FF_BUG_DC_CLIP 4096
1577 #define FF_BUG_MS 8192 ///< Work around various bugs in Microsoft's broken decoders.
1578 #define FF_BUG_TRUNCATED 16384
1579 #define FF_BUG_IEDGE 32768
1580 
1581  /**
1582  * strictly follow the standard (MPEG-4, ...).
1583  * - encoding: Set by user.
1584  * - decoding: Set by user.
1585  * Setting this to STRICT or higher means the encoder and decoder will
1586  * generally do stupid things, whereas setting it to unofficial or lower
1587  * will mean the encoder might produce output that is not supported by all
1588  * spec-compliant decoders. Decoders don't differentiate between normal,
1589  * unofficial and experimental (that is, they always try to decode things
1590  * when they can) unless they are explicitly asked to behave stupidly
1591  * (=strictly conform to the specs)
1592  */
1594 #define FF_COMPLIANCE_VERY_STRICT 2 ///< Strictly conform to an older more strict version of the spec or reference software.
1595 #define FF_COMPLIANCE_STRICT 1 ///< Strictly conform to all the things in the spec no matter what consequences.
1596 #define FF_COMPLIANCE_NORMAL 0
1597 #define FF_COMPLIANCE_UNOFFICIAL -1 ///< Allow unofficial extensions
1598 #define FF_COMPLIANCE_EXPERIMENTAL -2 ///< Allow nonstandardized experimental things.
1599 
1600  /**
1601  * error concealment flags
1602  * - encoding: unused
1603  * - decoding: Set by user.
1604  */
1606 #define FF_EC_GUESS_MVS 1
1607 #define FF_EC_DEBLOCK 2
1608 #define FF_EC_FAVOR_INTER 256
1609 
1610  /**
1611  * debug
1612  * - encoding: Set by user.
1613  * - decoding: Set by user.
1614  */
1615  int debug;
1616 #define FF_DEBUG_PICT_INFO 1
1617 #define FF_DEBUG_RC 2
1618 #define FF_DEBUG_BITSTREAM 4
1619 #define FF_DEBUG_MB_TYPE 8
1620 #define FF_DEBUG_QP 16
1621 #if FF_API_DEBUG_MV
1622 /**
1623  * @deprecated this option does nothing
1624  */
1625 #define FF_DEBUG_MV 32
1626 #endif
1627 #define FF_DEBUG_DCT_COEFF 0x00000040
1628 #define FF_DEBUG_SKIP 0x00000080
1629 #define FF_DEBUG_STARTCODE 0x00000100
1630 #define FF_DEBUG_ER 0x00000400
1631 #define FF_DEBUG_MMCO 0x00000800
1632 #define FF_DEBUG_BUGS 0x00001000
1633 #if FF_API_DEBUG_MV
1634 #define FF_DEBUG_VIS_QP 0x00002000
1635 #define FF_DEBUG_VIS_MB_TYPE 0x00004000
1636 #endif
1637 #define FF_DEBUG_BUFFERS 0x00008000
1638 #define FF_DEBUG_THREADS 0x00010000
1639 #define FF_DEBUG_GREEN_MD 0x00800000
1640 #define FF_DEBUG_NOMC 0x01000000
1641 
1642 #if FF_API_DEBUG_MV
1643  /**
1644  * debug
1645  * - encoding: Set by user.
1646  * - decoding: Set by user.
1647  */
1648  int debug_mv;
1649 #define FF_DEBUG_VIS_MV_P_FOR 0x00000001 // visualize forward predicted MVs of P-frames
1650 #define FF_DEBUG_VIS_MV_B_FOR 0x00000002 // visualize forward predicted MVs of B-frames
1651 #define FF_DEBUG_VIS_MV_B_BACK 0x00000004 // visualize backward predicted MVs of B-frames
1652 #endif
1653 
1654  /**
1655  * Error recognition; may misdetect some more or less valid parts as errors.
1656  * - encoding: unused
1657  * - decoding: Set by user.
1658  */
1660 
1661 /**
1662  * Verify checksums embedded in the bitstream (could be of either encoded or
1663  * decoded data, depending on the codec) and print an error message on mismatch.
1664  * If AV_EF_EXPLODE is also set, a mismatching checksum will result in the
1665  * decoder returning an error.
1666  */
1667 #define AV_EF_CRCCHECK (1<<0)
1668 #define AV_EF_BITSTREAM (1<<1) ///< detect bitstream specification deviations
1669 #define AV_EF_BUFFER (1<<2) ///< detect improper bitstream length
1670 #define AV_EF_EXPLODE (1<<3) ///< abort decoding on minor error detection
1671 
1672 #define AV_EF_IGNORE_ERR (1<<15) ///< ignore errors and continue
1673 #define AV_EF_CAREFUL (1<<16) ///< consider things that violate the spec, are fast to calculate and have not been seen in the wild as errors
1674 #define AV_EF_COMPLIANT (1<<17) ///< consider all spec non compliances as errors
1675 #define AV_EF_AGGRESSIVE (1<<18) ///< consider things that a sane encoder should not do as an error
1676 
1677 
1678  /**
1679  * opaque 64-bit number (generally a PTS) that will be reordered and
1680  * output in AVFrame.reordered_opaque
1681  * - encoding: Set by libavcodec to the reordered_opaque of the input
1682  * frame corresponding to the last returned packet. Only
1683  * supported by encoders with the
1684  * AV_CODEC_CAP_ENCODER_REORDERED_OPAQUE capability.
1685  * - decoding: Set by user.
1686  */
1688 
1689  /**
1690  * Hardware accelerator in use
1691  * - encoding: unused.
1692  * - decoding: Set by libavcodec
1693  */
1694  const struct AVHWAccel *hwaccel;
1695 
1696  /**
1697  * Hardware accelerator context.
1698  * For some hardware accelerators, a global context needs to be
1699  * provided by the user. In that case, this holds display-dependent
1700  * data FFmpeg cannot instantiate itself. Please refer to the
1701  * FFmpeg HW accelerator documentation to know how to fill this
1702  * is. e.g. for VA API, this is a struct vaapi_context.
1703  * - encoding: unused
1704  * - decoding: Set by user
1705  */
1707 
1708  /**
1709  * error
1710  * - encoding: Set by libavcodec if flags & AV_CODEC_FLAG_PSNR.
1711  * - decoding: unused
1712  */
1714 
1715  /**
1716  * DCT algorithm, see FF_DCT_* below
1717  * - encoding: Set by user.
1718  * - decoding: unused
1719  */
1721 #define FF_DCT_AUTO 0
1722 #define FF_DCT_FASTINT 1
1723 #define FF_DCT_INT 2
1724 #define FF_DCT_MMX 3
1725 #define FF_DCT_ALTIVEC 5
1726 #define FF_DCT_FAAN 6
1727 
1728  /**
1729  * IDCT algorithm, see FF_IDCT_* below.
1730  * - encoding: Set by user.
1731  * - decoding: Set by user.
1732  */
1734 #define FF_IDCT_AUTO 0
1735 #define FF_IDCT_INT 1
1736 #define FF_IDCT_SIMPLE 2
1737 #define FF_IDCT_SIMPLEMMX 3
1738 #define FF_IDCT_ARM 7
1739 #define FF_IDCT_ALTIVEC 8
1740 #define FF_IDCT_SIMPLEARM 10
1741 #define FF_IDCT_XVID 14
1742 #define FF_IDCT_SIMPLEARMV5TE 16
1743 #define FF_IDCT_SIMPLEARMV6 17
1744 #define FF_IDCT_FAAN 20
1745 #define FF_IDCT_SIMPLENEON 22
1746 #define FF_IDCT_NONE 24 /* Used by XvMC to extract IDCT coefficients with FF_IDCT_PERM_NONE */
1747 #define FF_IDCT_SIMPLEAUTO 128
1748 
1749  /**
1750  * bits per sample/pixel from the demuxer (needed for huffyuv).
1751  * - encoding: Set by libavcodec.
1752  * - decoding: Set by user.
1753  */
1755 
1756  /**
1757  * Bits per sample/pixel of internal libavcodec pixel/sample format.
1758  * - encoding: set by user.
1759  * - decoding: set by libavcodec.
1760  */
1762 
1763 #if FF_API_LOWRES
1764  /**
1765  * low resolution decoding, 1-> 1/2 size, 2->1/4 size
1766  * - encoding: unused
1767  * - decoding: Set by user.
1768  */
1769  int lowres;
1770 #endif
1771 
1772 #if FF_API_CODED_FRAME
1773  /**
1774  * the picture in the bitstream
1775  * - encoding: Set by libavcodec.
1776  * - decoding: unused
1777  *
1778  * @deprecated use the quality factor packet side data instead
1779  */
1781 #endif
1782 
1783  /**
1784  * thread count
1785  * is used to decide how many independent tasks should be passed to execute()
1786  * - encoding: Set by user.
1787  * - decoding: Set by user.
1788  */
1790 
1791  /**
1792  * Which multithreading methods to use.
1793  * Use of FF_THREAD_FRAME will increase decoding delay by one frame per thread,
1794  * so clients which cannot provide future frames should not use it.
1795  *
1796  * - encoding: Set by user, otherwise the default is used.
1797  * - decoding: Set by user, otherwise the default is used.
1798  */
1800 #define FF_THREAD_FRAME 1 ///< Decode more than one frame at once
1801 #define FF_THREAD_SLICE 2 ///< Decode more than one part of a single frame at once
1802 
1803  /**
1804  * Which multithreading methods are in use by the codec.
1805  * - encoding: Set by libavcodec.
1806  * - decoding: Set by libavcodec.
1807  */
1809 
1810  /**
1811  * Set by the client if its custom get_buffer() callback can be called
1812  * synchronously from another thread, which allows faster multithreaded decoding.
1813  * draw_horiz_band() will be called from other threads regardless of this setting.
1814  * Ignored if the default get_buffer() is used.
1815  * - encoding: Set by user.
1816  * - decoding: Set by user.
1817  */
1819 
1820  /**
1821  * The codec may call this to execute several independent things.
1822  * It will return only after finishing all tasks.
1823  * The user may replace this with some multithreaded implementation,
1824  * the default implementation will execute the parts serially.
1825  * @param count the number of things to execute
1826  * - encoding: Set by libavcodec, user can override.
1827  * - decoding: Set by libavcodec, user can override.
1828  */
1829  int (*execute)(struct AVCodecContext *c, int (*func)(struct AVCodecContext *c2, void *arg), void *arg2, int *ret, int count, int size);
1830 
1831  /**
1832  * The codec may call this to execute several independent things.
1833  * It will return only after finishing all tasks.
1834  * The user may replace this with some multithreaded implementation,
1835  * the default implementation will execute the parts serially.
1836  * Also see avcodec_thread_init and e.g. the --enable-pthread configure option.
1837  * @param c context passed also to func
1838  * @param count the number of things to execute
1839  * @param arg2 argument passed unchanged to func
1840  * @param ret return values of executed functions, must have space for "count" values. May be NULL.
1841  * @param func function that will be called count times, with jobnr from 0 to count-1.
1842  * threadnr will be in the range 0 to c->thread_count-1 < MAX_THREADS and so that no
1843  * two instances of func executing at the same time will have the same threadnr.
1844  * @return always 0 currently, but code should handle a future improvement where when any call to func
1845  * returns < 0 no further calls to func may be done and < 0 is returned.
1846  * - encoding: Set by libavcodec, user can override.
1847  * - decoding: Set by libavcodec, user can override.
1848  */
1849  int (*execute2)(struct AVCodecContext *c, int (*func)(struct AVCodecContext *c2, void *arg, int jobnr, int threadnr), void *arg2, int *ret, int count);
1850 
1851  /**
1852  * noise vs. sse weight for the nsse comparison function
1853  * - encoding: Set by user.
1854  * - decoding: unused
1855  */
1857 
1858  /**
1859  * profile
1860  * - encoding: Set by user.
1861  * - decoding: Set by libavcodec.
1862  */
1863  int profile;
1864 #define FF_PROFILE_UNKNOWN -99
1865 #define FF_PROFILE_RESERVED -100
1866 
1867 #define FF_PROFILE_AAC_MAIN 0
1868 #define FF_PROFILE_AAC_LOW 1
1869 #define FF_PROFILE_AAC_SSR 2
1870 #define FF_PROFILE_AAC_LTP 3
1871 #define FF_PROFILE_AAC_HE 4
1872 #define FF_PROFILE_AAC_HE_V2 28
1873 #define FF_PROFILE_AAC_LD 22
1874 #define FF_PROFILE_AAC_ELD 38
1875 #define FF_PROFILE_MPEG2_AAC_LOW 128
1876 #define FF_PROFILE_MPEG2_AAC_HE 131
1877 
1878 #define FF_PROFILE_DNXHD 0
1879 #define FF_PROFILE_DNXHR_LB 1
1880 #define FF_PROFILE_DNXHR_SQ 2
1881 #define FF_PROFILE_DNXHR_HQ 3
1882 #define FF_PROFILE_DNXHR_HQX 4
1883 #define FF_PROFILE_DNXHR_444 5
1884 
1885 #define FF_PROFILE_DTS 20
1886 #define FF_PROFILE_DTS_ES 30
1887 #define FF_PROFILE_DTS_96_24 40
1888 #define FF_PROFILE_DTS_HD_HRA 50
1889 #define FF_PROFILE_DTS_HD_MA 60
1890 #define FF_PROFILE_DTS_EXPRESS 70
1891 
1892 #define FF_PROFILE_MPEG2_422 0
1893 #define FF_PROFILE_MPEG2_HIGH 1
1894 #define FF_PROFILE_MPEG2_SS 2
1895 #define FF_PROFILE_MPEG2_SNR_SCALABLE 3
1896 #define FF_PROFILE_MPEG2_MAIN 4
1897 #define FF_PROFILE_MPEG2_SIMPLE 5
1898 
1899 #define FF_PROFILE_H264_CONSTRAINED (1<<9) // 8+1; constraint_set1_flag
1900 #define FF_PROFILE_H264_INTRA (1<<11) // 8+3; constraint_set3_flag
1901 
1902 #define FF_PROFILE_H264_BASELINE 66
1903 #define FF_PROFILE_H264_CONSTRAINED_BASELINE (66|FF_PROFILE_H264_CONSTRAINED)
1904 #define FF_PROFILE_H264_MAIN 77
1905 #define FF_PROFILE_H264_EXTENDED 88
1906 #define FF_PROFILE_H264_HIGH 100
1907 #define FF_PROFILE_H264_HIGH_10 110
1908 #define FF_PROFILE_H264_HIGH_10_INTRA (110|FF_PROFILE_H264_INTRA)
1909 #define FF_PROFILE_H264_MULTIVIEW_HIGH 118
1910 #define FF_PROFILE_H264_HIGH_422 122
1911 #define FF_PROFILE_H264_HIGH_422_INTRA (122|FF_PROFILE_H264_INTRA)
1912 #define FF_PROFILE_H264_STEREO_HIGH 128
1913 #define FF_PROFILE_H264_HIGH_444 144
1914 #define FF_PROFILE_H264_HIGH_444_PREDICTIVE 244
1915 #define FF_PROFILE_H264_HIGH_444_INTRA (244|FF_PROFILE_H264_INTRA)
1916 #define FF_PROFILE_H264_CAVLC_444 44
1917 
1918 #define FF_PROFILE_VC1_SIMPLE 0
1919 #define FF_PROFILE_VC1_MAIN 1
1920 #define FF_PROFILE_VC1_COMPLEX 2
1921 #define FF_PROFILE_VC1_ADVANCED 3
1922 
1923 #define FF_PROFILE_MPEG4_SIMPLE 0
1924 #define FF_PROFILE_MPEG4_SIMPLE_SCALABLE 1
1925 #define FF_PROFILE_MPEG4_CORE 2
1926 #define FF_PROFILE_MPEG4_MAIN 3
1927 #define FF_PROFILE_MPEG4_N_BIT 4
1928 #define FF_PROFILE_MPEG4_SCALABLE_TEXTURE 5
1929 #define FF_PROFILE_MPEG4_SIMPLE_FACE_ANIMATION 6
1930 #define FF_PROFILE_MPEG4_BASIC_ANIMATED_TEXTURE 7
1931 #define FF_PROFILE_MPEG4_HYBRID 8
1932 #define FF_PROFILE_MPEG4_ADVANCED_REAL_TIME 9
1933 #define FF_PROFILE_MPEG4_CORE_SCALABLE 10
1934 #define FF_PROFILE_MPEG4_ADVANCED_CODING 11
1935 #define FF_PROFILE_MPEG4_ADVANCED_CORE 12
1936 #define FF_PROFILE_MPEG4_ADVANCED_SCALABLE_TEXTURE 13
1937 #define FF_PROFILE_MPEG4_SIMPLE_STUDIO 14
1938 #define FF_PROFILE_MPEG4_ADVANCED_SIMPLE 15
1939 
1940 #define FF_PROFILE_JPEG2000_CSTREAM_RESTRICTION_0 1
1941 #define FF_PROFILE_JPEG2000_CSTREAM_RESTRICTION_1 2
1942 #define FF_PROFILE_JPEG2000_CSTREAM_NO_RESTRICTION 32768
1943 #define FF_PROFILE_JPEG2000_DCINEMA_2K 3
1944 #define FF_PROFILE_JPEG2000_DCINEMA_4K 4
1945 
1946 #define FF_PROFILE_VP9_0 0
1947 #define FF_PROFILE_VP9_1 1
1948 #define FF_PROFILE_VP9_2 2
1949 #define FF_PROFILE_VP9_3 3
1950 
1951 #define FF_PROFILE_HEVC_MAIN 1
1952 #define FF_PROFILE_HEVC_MAIN_10 2
1953 #define FF_PROFILE_HEVC_MAIN_STILL_PICTURE 3
1954 #define FF_PROFILE_HEVC_REXT 4
1955 
1956 #define FF_PROFILE_AV1_MAIN 0
1957 #define FF_PROFILE_AV1_HIGH 1
1958 #define FF_PROFILE_AV1_PROFESSIONAL 2
1959 
1960 #define FF_PROFILE_MJPEG_HUFFMAN_BASELINE_DCT 0xc0
1961 #define FF_PROFILE_MJPEG_HUFFMAN_EXTENDED_SEQUENTIAL_DCT 0xc1
1962 #define FF_PROFILE_MJPEG_HUFFMAN_PROGRESSIVE_DCT 0xc2
1963 #define FF_PROFILE_MJPEG_HUFFMAN_LOSSLESS 0xc3
1964 #define FF_PROFILE_MJPEG_JPEG_LS 0xf7
1965 
1966 #define FF_PROFILE_SBC_MSBC 1
1967 
1968 #define FF_PROFILE_PRORES_PROXY 0
1969 #define FF_PROFILE_PRORES_LT 1
1970 #define FF_PROFILE_PRORES_STANDARD 2
1971 #define FF_PROFILE_PRORES_HQ 3
1972 #define FF_PROFILE_PRORES_4444 4
1973 #define FF_PROFILE_PRORES_XQ 5
1974 
1975 #define FF_PROFILE_ARIB_PROFILE_A 0
1976 #define FF_PROFILE_ARIB_PROFILE_C 1
1977 
1978 #define FF_PROFILE_KLVA_SYNC 0
1979 #define FF_PROFILE_KLVA_ASYNC 1
1980 
1981  /**
1982  * level
1983  * - encoding: Set by user.
1984  * - decoding: Set by libavcodec.
1985  */
1986  int level;
1987 #define FF_LEVEL_UNKNOWN -99
1988 
1989  /**
1990  * Skip loop filtering for selected frames.
1991  * - encoding: unused
1992  * - decoding: Set by user.
1993  */
1995 
1996  /**
1997  * Skip IDCT/dequantization for selected frames.
1998  * - encoding: unused
1999  * - decoding: Set by user.
2000  */
2002 
2003  /**
2004  * Skip decoding for selected frames.
2005  * - encoding: unused
2006  * - decoding: Set by user.
2007  */
2009 
2010  /**
2011  * Header containing style information for text subtitles.
2012  * For SUBTITLE_ASS subtitle type, it should contain the whole ASS
2013  * [Script Info] and [V4+ Styles] section, plus the [Events] line and
2014  * the Format line following. It shouldn't include any Dialogue line.
2015  * - encoding: Set/allocated/freed by user (before avcodec_open2())
2016  * - decoding: Set/allocated/freed by libavcodec (by avcodec_open2())
2017  */
2020 
2021 #if FF_API_VBV_DELAY
2022  /**
2023  * VBV delay coded in the last frame (in periods of a 27 MHz clock).
2024  * Used for compliant TS muxing.
2025  * - encoding: Set by libavcodec.
2026  * - decoding: unused.
2027  * @deprecated this value is now exported as a part of
2028  * AV_PKT_DATA_CPB_PROPERTIES packet side data
2029  */
2031  uint64_t vbv_delay;
2032 #endif
2033 
2034 #if FF_API_SIDEDATA_ONLY_PKT
2035  /**
2036  * Encoding only and set by default. Allow encoders to output packets
2037  * that do not contain any encoded data, only side data.
2038  *
2039  * Some encoders need to output such packets, e.g. to update some stream
2040  * parameters at the end of encoding.
2041  *
2042  * @deprecated this field disables the default behaviour and
2043  * it is kept only for compatibility.
2044  */
2047 #endif
2048 
2049  /**
2050  * Audio only. The number of "priming" samples (padding) inserted by the
2051  * encoder at the beginning of the audio. I.e. this number of leading
2052  * decoded samples must be discarded by the caller to get the original audio
2053  * without leading padding.
2054  *
2055  * - decoding: unused
2056  * - encoding: Set by libavcodec. The timestamps on the output packets are
2057  * adjusted by the encoder so that they always refer to the
2058  * first sample of the data actually contained in the packet,
2059  * including any added padding. E.g. if the timebase is
2060  * 1/samplerate and the timestamp of the first input sample is
2061  * 0, the timestamp of the first output packet will be
2062  * -initial_padding.
2063  */
2065 
2066  /**
2067  * - decoding: For codecs that store a framerate value in the compressed
2068  * bitstream, the decoder may export it here. { 0, 1} when
2069  * unknown.
2070  * - encoding: May be used to signal the framerate of CFR content to an
2071  * encoder.
2072  */
2074 
2075  /**
2076  * Nominal unaccelerated pixel format, see AV_PIX_FMT_xxx.
2077  * - encoding: unused.
2078  * - decoding: Set by libavcodec before calling get_format()
2079  */
2081 
2082  /**
2083  * Timebase in which pkt_dts/pts and AVPacket.dts/pts are.
2084  * - encoding unused.
2085  * - decoding set by user.
2086  */
2088 
2089  /**
2090  * AVCodecDescriptor
2091  * - encoding: unused.
2092  * - decoding: set by libavcodec.
2093  */
2095 
2096 #if !FF_API_LOWRES
2097  /**
2098  * low resolution decoding, 1-> 1/2 size, 2->1/4 size
2099  * - encoding: unused
2100  * - decoding: Set by user.
2101  */
2102  int lowres;
2103 #endif
2104 
2105  /**
2106  * Current statistics for PTS correction.
2107  * - decoding: maintained and used by libavcodec, not intended to be used by user apps
2108  * - encoding: unused
2109  */
2110  int64_t pts_correction_num_faulty_pts; /// Number of incorrect PTS values so far
2111  int64_t pts_correction_num_faulty_dts; /// Number of incorrect DTS values so far
2112  int64_t pts_correction_last_pts; /// PTS of the last frame
2113  int64_t pts_correction_last_dts; /// DTS of the last frame
2114 
2115  /**
2116  * Character encoding of the input subtitles file.
2117  * - decoding: set by user
2118  * - encoding: unused
2119  */
2121 
2122  /**
2123  * Subtitles character encoding mode. Formats or codecs might be adjusting
2124  * this setting (if they are doing the conversion themselves for instance).
2125  * - decoding: set by libavcodec
2126  * - encoding: unused
2127  */
2129 #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)
2130 #define FF_SUB_CHARENC_MODE_AUTOMATIC 0 ///< libavcodec will select the mode itself
2131 #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
2132 #define FF_SUB_CHARENC_MODE_IGNORE 2 ///< neither convert the subtitles, nor check them for valid UTF-8
2133 
2134  /**
2135  * Skip processing alpha if supported by codec.
2136  * Note that if the format uses pre-multiplied alpha (common with VP6,
2137  * and recommended due to better video quality/compression)
2138  * the image will look as if alpha-blended onto a black background.
2139  * However for formats that do not use pre-multiplied alpha
2140  * there might be serious artefacts (though e.g. libswscale currently
2141  * assumes pre-multiplied alpha anyway).
2142  *
2143  * - decoding: set by user
2144  * - encoding: unused
2145  */
2147 
2148  /**
2149  * Number of samples to skip after a discontinuity
2150  * - decoding: unused
2151  * - encoding: set by libavcodec
2152  */
2154 
2155 #if !FF_API_DEBUG_MV
2156  /**
2157  * debug motion vectors
2158  * - encoding: Set by user.
2159  * - decoding: Set by user.
2160  */
2162 #define FF_DEBUG_VIS_MV_P_FOR 0x00000001 //visualize forward predicted MVs of P frames
2163 #define FF_DEBUG_VIS_MV_B_FOR 0x00000002 //visualize forward predicted MVs of B frames
2164 #define FF_DEBUG_VIS_MV_B_BACK 0x00000004 //visualize backward predicted MVs of B frames
2165 #endif
2166 
2167  /**
2168  * custom intra quantization matrix
2169  * - encoding: Set by user, can be NULL.
2170  * - decoding: unused.
2171  */
2173 
2174  /**
2175  * dump format separator.
2176  * can be ", " or "\n " or anything else
2177  * - encoding: Set by user.
2178  * - decoding: Set by user.
2179  */
2181 
2182  /**
2183  * ',' separated list of allowed decoders.
2184  * If NULL then all are allowed
2185  * - encoding: unused
2186  * - decoding: set by user
2187  */
2189 
2190  /**
2191  * Properties of the stream that gets decoded
2192  * - encoding: unused
2193  * - decoding: set by libavcodec
2194  */
2195  unsigned properties;
2196 #define FF_CODEC_PROPERTY_LOSSLESS 0x00000001
2197 #define FF_CODEC_PROPERTY_CLOSED_CAPTIONS 0x00000002
2198 
2199  /**
2200  * Additional data associated with the entire coded stream.
2201  *
2202  * - decoding: unused
2203  * - encoding: may be set by libavcodec after avcodec_open2().
2204  */
2207 
2208  /**
2209  * A reference to the AVHWFramesContext describing the input (for encoding)
2210  * or output (decoding) frames. The reference is set by the caller and
2211  * afterwards owned (and freed) by libavcodec - it should never be read by
2212  * the caller after being set.
2213  *
2214  * - decoding: This field should be set by the caller from the get_format()
2215  * callback. The previous reference (if any) will always be
2216  * unreffed by libavcodec before the get_format() call.
2217  *
2218  * If the default get_buffer2() is used with a hwaccel pixel
2219  * format, then this AVHWFramesContext will be used for
2220  * allocating the frame buffers.
2221  *
2222  * - encoding: For hardware encoders configured to use a hwaccel pixel
2223  * format, this field should be set by the caller to a reference
2224  * to the AVHWFramesContext describing input frames.
2225  * AVHWFramesContext.format must be equal to
2226  * AVCodecContext.pix_fmt.
2227  *
2228  * This field should be set before avcodec_open2() is called.
2229  */
2231 
2232  /**
2233  * Control the form of AVSubtitle.rects[N]->ass
2234  * - decoding: set by user
2235  * - encoding: unused
2236  */
2238 #define FF_SUB_TEXT_FMT_ASS 0
2239 #if FF_API_ASS_TIMING
2240 #define FF_SUB_TEXT_FMT_ASS_WITH_TIMINGS 1
2241 #endif
2242 
2243  /**
2244  * Audio only. The amount of padding (in samples) appended by the encoder to
2245  * the end of the audio. I.e. this number of decoded samples must be
2246  * discarded by the caller from the end of the stream to get the original
2247  * audio without any trailing padding.
2248  *
2249  * - decoding: unused
2250  * - encoding: unused
2251  */
2253 
2254  /**
2255  * The number of pixels per image to maximally accept.
2256  *
2257  * - decoding: set by user
2258  * - encoding: set by user
2259  */
2261 
2262  /**
2263  * A reference to the AVHWDeviceContext describing the device which will
2264  * be used by a hardware encoder/decoder. The reference is set by the
2265  * caller and afterwards owned (and freed) by libavcodec.
2266  *
2267  * This should be used if either the codec device does not require
2268  * hardware frames or any that are used are to be allocated internally by
2269  * libavcodec. If the user wishes to supply any of the frames used as
2270  * encoder input or decoder output then hw_frames_ctx should be used
2271  * instead. When hw_frames_ctx is set in get_format() for a decoder, this
2272  * field will be ignored while decoding the associated stream segment, but
2273  * may again be used on a following one after another get_format() call.
2274  *
2275  * For both encoders and decoders this field should be set before
2276  * avcodec_open2() is called and must not be written to thereafter.
2277  *
2278  * Note that some decoders may require this field to be set initially in
2279  * order to support hw_frames_ctx at all - in that case, all frames
2280  * contexts used must be created on the same device.
2281  */
2283 
2284  /**
2285  * Bit set of AV_HWACCEL_FLAG_* flags, which affect hardware accelerated
2286  * decoding (if active).
2287  * - encoding: unused
2288  * - decoding: Set by user (either before avcodec_open2(), or in the
2289  * AVCodecContext.get_format callback)
2290  */
2292 
2293  /**
2294  * Video decoding only. Certain video codecs support cropping, meaning that
2295  * only a sub-rectangle of the decoded frame is intended for display. This
2296  * option controls how cropping is handled by libavcodec.
2297  *
2298  * When set to 1 (the default), libavcodec will apply cropping internally.
2299  * I.e. it will modify the output frame width/height fields and offset the
2300  * data pointers (only by as much as possible while preserving alignment, or
2301  * by the full amount if the AV_CODEC_FLAG_UNALIGNED flag is set) so that
2302  * the frames output by the decoder refer only to the cropped area. The
2303  * crop_* fields of the output frames will be zero.
2304  *
2305  * When set to 0, the width/height fields of the output frames will be set
2306  * to the coded dimensions and the crop_* fields will describe the cropping
2307  * rectangle. Applying the cropping is left to the caller.
2308  *
2309  * @warning When hardware acceleration with opaque output frames is used,
2310  * libavcodec is unable to apply cropping from the top/left border.
2311  *
2312  * @note when this option is set to zero, the width/height fields of the
2313  * AVCodecContext and output AVFrames have different meanings. The codec
2314  * context fields store display dimensions (with the coded dimensions in
2315  * coded_width/height), while the frame fields store the coded dimensions
2316  * (with the display dimensions being determined by the crop_* fields).
2317  */
2319 
2320  /*
2321  * Video decoding only. Sets the number of extra hardware frames which
2322  * the decoder will allocate for use by the caller. This must be set
2323  * before avcodec_open2() is called.
2324  *
2325  * Some hardware decoders require all frames that they will use for
2326  * output to be defined in advance before decoding starts. For such
2327  * decoders, the hardware frame pool must therefore be of a fixed size.
2328  * The extra frames set here are on top of any number that the decoder
2329  * needs internally in order to operate normally (for example, frames
2330  * used as reference pictures).
2331  */
2333 
2334  /**
2335  * The percentage of damaged samples to discard a frame.
2336  *
2337  * - decoding: set by user
2338  * - encoding: unused
2339  */
2341 
2342  /**
2343  * The number of samples per frame to maximally accept.
2344  *
2345  * - decoding: set by user
2346  * - encoding: set by user
2347  */
2349 
2350  /**
2351  * Bit set of AV_CODEC_EXPORT_DATA_* flags, which affects the kind of
2352  * metadata exported in frame, packet, or coded stream side data by
2353  * decoders and encoders.
2354  *
2355  * - decoding: set by user
2356  * - encoding: set by user
2357  */
2359 } AVCodecContext;
2360 
2361 #if FF_API_CODEC_GET_SET
2362 /**
2363  * Accessors for some AVCodecContext fields. These used to be provided for ABI
2364  * compatibility, and do not need to be used anymore.
2365  */
2370 
2375 
2377 unsigned av_codec_get_codec_properties(const AVCodecContext *avctx);
2378 
2379 #if FF_API_LOWRES
2381 int av_codec_get_lowres(const AVCodecContext *avctx);
2383 void av_codec_set_lowres(AVCodecContext *avctx, int val);
2384 #endif
2385 
2387 int av_codec_get_seek_preroll(const AVCodecContext *avctx);
2389 void av_codec_set_seek_preroll(AVCodecContext *avctx, int val);
2390 
2392 uint16_t *av_codec_get_chroma_intra_matrix(const AVCodecContext *avctx);
2394 void av_codec_set_chroma_intra_matrix(AVCodecContext *avctx, uint16_t *val);
2395 #endif
2396 
2397 struct AVSubtitle;
2398 
2399 #if FF_API_CODEC_GET_SET
2401 int av_codec_get_max_lowres(const AVCodec *codec);
2402 #endif
2403 
2404 struct MpegEncContext;
2405 
2406 /**
2407  * @defgroup lavc_hwaccel AVHWAccel
2408  *
2409  * @note Nothing in this structure should be accessed by the user. At some
2410  * point in future it will not be externally visible at all.
2411  *
2412  * @{
2413  */
2414 typedef struct AVHWAccel {
2415  /**
2416  * Name of the hardware accelerated codec.
2417  * The name is globally unique among encoders and among decoders (but an
2418  * encoder and a decoder can share the same name).
2419  */
2420  const char *name;
2421 
2422  /**
2423  * Type of codec implemented by the hardware accelerator.
2424  *
2425  * See AVMEDIA_TYPE_xxx
2426  */
2428 
2429  /**
2430  * Codec implemented by the hardware accelerator.
2431  *
2432  * See AV_CODEC_ID_xxx
2433  */
2435 
2436  /**
2437  * Supported pixel format.
2438  *
2439  * Only hardware accelerated formats are supported here.
2440  */
2442 
2443  /**
2444  * Hardware accelerated codec capabilities.
2445  * see AV_HWACCEL_CODEC_CAP_*
2446  */
2448 
2449  /*****************************************************************
2450  * No fields below this line are part of the public API. They
2451  * may not be used outside of libavcodec and can be changed and
2452  * removed at will.
2453  * New public fields should be added right above.
2454  *****************************************************************
2455  */
2456 
2457  /**
2458  * Allocate a custom buffer
2459  */
2461 
2462  /**
2463  * Called at the beginning of each frame or field picture.
2464  *
2465  * Meaningful frame information (codec specific) is guaranteed to
2466  * be parsed at this point. This function is mandatory.
2467  *
2468  * Note that buf can be NULL along with buf_size set to 0.
2469  * Otherwise, this means the whole frame is available at this point.
2470  *
2471  * @param avctx the codec context
2472  * @param buf the frame data buffer base
2473  * @param buf_size the size of the frame in bytes
2474  * @return zero if successful, a negative value otherwise
2475  */
2476  int (*start_frame)(AVCodecContext *avctx, const uint8_t *buf, uint32_t buf_size);
2477 
2478  /**
2479  * Callback for parameter data (SPS/PPS/VPS etc).
2480  *
2481  * Useful for hardware decoders which keep persistent state about the
2482  * video parameters, and need to receive any changes to update that state.
2483  *
2484  * @param avctx the codec context
2485  * @param type the nal unit type
2486  * @param buf the nal unit data buffer
2487  * @param buf_size the size of the nal unit in bytes
2488  * @return zero if successful, a negative value otherwise
2489  */
2490  int (*decode_params)(AVCodecContext *avctx, int type, const uint8_t *buf, uint32_t buf_size);
2491 
2492  /**
2493  * Callback for each slice.
2494  *
2495  * Meaningful slice information (codec specific) is guaranteed to
2496  * be parsed at this point. This function is mandatory.
2497  * The only exception is XvMC, that works on MB level.
2498  *
2499  * @param avctx the codec context
2500  * @param buf the slice data buffer base
2501  * @param buf_size the size of the slice in bytes
2502  * @return zero if successful, a negative value otherwise
2503  */
2504  int (*decode_slice)(AVCodecContext *avctx, const uint8_t *buf, uint32_t buf_size);
2505 
2506  /**
2507  * Called at the end of each frame or field picture.
2508  *
2509  * The whole picture is parsed at this point and can now be sent
2510  * to the hardware accelerator. This function is mandatory.
2511  *
2512  * @param avctx the codec context
2513  * @return zero if successful, a negative value otherwise
2514  */
2516 
2517  /**
2518  * Size of per-frame hardware accelerator private data.
2519  *
2520  * Private data is allocated with av_mallocz() before
2521  * AVCodecContext.get_buffer() and deallocated after
2522  * AVCodecContext.release_buffer().
2523  */
2525 
2526  /**
2527  * Called for every Macroblock in a slice.
2528  *
2529  * XvMC uses it to replace the ff_mpv_reconstruct_mb().
2530  * Instead of decoding to raw picture, MB parameters are
2531  * stored in an array provided by the video driver.
2532  *
2533  * @param s the mpeg context
2534  */
2536 
2537  /**
2538  * Initialize the hwaccel private data.
2539  *
2540  * This will be called from ff_get_format(), after hwaccel and
2541  * hwaccel_context are set and the hwaccel private data in AVCodecInternal
2542  * is allocated.
2543  */
2545 
2546  /**
2547  * Uninitialize the hwaccel private data.
2548  *
2549  * This will be called from get_format() or avcodec_close(), after hwaccel
2550  * and hwaccel_context are already uninitialized.
2551  */
2553 
2554  /**
2555  * Size of the private data to allocate in
2556  * AVCodecInternal.hwaccel_priv_data.
2557  */
2559 
2560  /**
2561  * Internal hwaccel capabilities.
2562  */
2564 
2565  /**
2566  * Fill the given hw_frames context with current codec parameters. Called
2567  * from get_format. Refer to avcodec_get_hw_frames_parameters() for
2568  * details.
2569  *
2570  * This CAN be called before AVHWAccel.init is called, and you must assume
2571  * that avctx->hwaccel_priv_data is invalid.
2572  */
2573  int (*frame_params)(AVCodecContext *avctx, AVBufferRef *hw_frames_ctx);
2574 } AVHWAccel;
2575 
2576 /**
2577  * HWAccel is experimental and is thus avoided in favor of non experimental
2578  * codecs
2579  */
2580 #define AV_HWACCEL_CODEC_CAP_EXPERIMENTAL 0x0200
2581 
2582 /**
2583  * Hardware acceleration should be used for decoding even if the codec level
2584  * used is unknown or higher than the maximum supported level reported by the
2585  * hardware driver.
2586  *
2587  * It's generally a good idea to pass this flag unless you have a specific
2588  * reason not to, as hardware tends to under-report supported levels.
2589  */
2590 #define AV_HWACCEL_FLAG_IGNORE_LEVEL (1 << 0)
2591 
2592 /**
2593  * Hardware acceleration can output YUV pixel formats with a different chroma
2594  * sampling than 4:2:0 and/or other than 8 bits per component.
2595  */
2596 #define AV_HWACCEL_FLAG_ALLOW_HIGH_DEPTH (1 << 1)
2597 
2598 /**
2599  * Hardware acceleration should still be attempted for decoding when the
2600  * codec profile does not match the reported capabilities of the hardware.
2601  *
2602  * For example, this can be used to try to decode baseline profile H.264
2603  * streams in hardware - it will often succeed, because many streams marked
2604  * as baseline profile actually conform to constrained baseline profile.
2605  *
2606  * @warning If the stream is actually not supported then the behaviour is
2607  * undefined, and may include returning entirely incorrect output
2608  * while indicating success.
2609  */
2610 #define AV_HWACCEL_FLAG_ALLOW_PROFILE_MISMATCH (1 << 2)
2611 
2612 /**
2613  * @}
2614  */
2615 
2616 #if FF_API_AVPICTURE
2617 /**
2618  * @defgroup lavc_picture AVPicture
2619  *
2620  * Functions for working with AVPicture
2621  * @{
2622  */
2623 
2624 /**
2625  * Picture data structure.
2626  *
2627  * Up to four components can be stored into it, the last component is
2628  * alpha.
2629  * @deprecated use AVFrame or imgutils functions instead
2630  */
2631 typedef struct AVPicture {
2633  uint8_t *data[AV_NUM_DATA_POINTERS]; ///< pointers to the image data planes
2635  int linesize[AV_NUM_DATA_POINTERS]; ///< number of bytes per line
2636 } AVPicture;
2637 
2638 /**
2639  * @}
2640  */
2641 #endif
2642 
2645 
2646  SUBTITLE_BITMAP, ///< A bitmap, pict will be set
2647 
2648  /**
2649  * Plain text, the text field must be set by the decoder and is
2650  * authoritative. ass and pict fields may contain approximations.
2651  */
2653 
2654  /**
2655  * Formatted text, the ass field must be set by the decoder and is
2656  * authoritative. pict and text fields may contain approximations.
2657  */
2659 };
2660 
2661 #define AV_SUBTITLE_FLAG_FORCED 0x00000001
2662 
2663 typedef struct AVSubtitleRect {
2664  int x; ///< top left corner of pict, undefined when pict is not set
2665  int y; ///< top left corner of pict, undefined when pict is not set
2666  int w; ///< width of pict, undefined when pict is not set
2667  int h; ///< height of pict, undefined when pict is not set
2668  int nb_colors; ///< number of colors in pict, undefined when pict is not set
2669 
2670 #if FF_API_AVPICTURE
2671  /**
2672  * @deprecated unused
2673  */
2676 #endif
2677  /**
2678  * data+linesize for the bitmap of this subtitle.
2679  * Can be set for text/ass as well once they are rendered.
2680  */
2682  int linesize[4];
2683 
2685 
2686  char *text; ///< 0 terminated plain UTF-8 text
2687 
2688  /**
2689  * 0 terminated ASS/SSA compatible event line.
2690  * The presentation of this is unaffected by the other values in this
2691  * struct.
2692  */
2693  char *ass;
2694 
2695  int flags;
2696 } AVSubtitleRect;
2697 
2698 typedef struct AVSubtitle {
2699  uint16_t format; /* 0 = graphics */
2700  uint32_t start_display_time; /* relative to packet pts, in ms */
2701  uint32_t end_display_time; /* relative to packet pts, in ms */
2702  unsigned num_rects;
2704  int64_t pts; ///< Same as packet pts, in AV_TIME_BASE
2705 } AVSubtitle;
2706 
2707 #if FF_API_NEXT
2708 /**
2709  * If c is NULL, returns the first registered codec,
2710  * if c is non-NULL, returns the next registered codec after c,
2711  * or NULL if c is the last one.
2712  */
2714 AVCodec *av_codec_next(const AVCodec *c);
2715 #endif
2716 
2717 /**
2718  * Return the LIBAVCODEC_VERSION_INT constant.
2719  */
2720 unsigned avcodec_version(void);
2721 
2722 /**
2723  * Return the libavcodec build-time configuration.
2724  */
2725 const char *avcodec_configuration(void);
2726 
2727 /**
2728  * Return the libavcodec license.
2729  */
2730 const char *avcodec_license(void);
2731 
2732 #if FF_API_NEXT
2733 /**
2734  * Register the codec codec and initialize libavcodec.
2735  *
2736  * @warning either this function or avcodec_register_all() must be called
2737  * before any other libavcodec functions.
2738  *
2739  * @see avcodec_register_all()
2740  */
2742 void avcodec_register(AVCodec *codec);
2743 
2744 /**
2745  * Register all the codecs, parsers and bitstream filters which were enabled at
2746  * configuration time. If you do not call this function you can select exactly
2747  * which formats you want to support, by using the individual registration
2748  * functions.
2749  *
2750  * @see avcodec_register
2751  * @see av_register_codec_parser
2752  * @see av_register_bitstream_filter
2753  */
2755 void avcodec_register_all(void);
2756 #endif
2757 
2758 /**
2759  * Allocate an AVCodecContext and set its fields to default values. The
2760  * resulting struct should be freed with avcodec_free_context().
2761  *
2762  * @param codec if non-NULL, allocate private data and initialize defaults
2763  * for the given codec. It is illegal to then call avcodec_open2()
2764  * with a different codec.
2765  * If NULL, then the codec-specific defaults won't be initialized,
2766  * which may result in suboptimal default settings (this is
2767  * important mainly for encoders, e.g. libx264).
2768  *
2769  * @return An AVCodecContext filled with default values or NULL on failure.
2770  */
2772 
2773 /**
2774  * Free the codec context and everything associated with it and write NULL to
2775  * the provided pointer.
2776  */
2777 void avcodec_free_context(AVCodecContext **avctx);
2778 
2779 #if FF_API_GET_CONTEXT_DEFAULTS
2780 /**
2781  * @deprecated This function should not be used, as closing and opening a codec
2782  * context multiple time is not supported. A new codec context should be
2783  * allocated for each new use.
2784  */
2786 #endif
2787 
2788 /**
2789  * Get the AVClass for AVCodecContext. It can be used in combination with
2790  * AV_OPT_SEARCH_FAKE_OBJ for examining options.
2791  *
2792  * @see av_opt_find().
2793  */
2794 const AVClass *avcodec_get_class(void);
2795 
2796 #if FF_API_COPY_CONTEXT
2797 /**
2798  * Get the AVClass for AVFrame. It can be used in combination with
2799  * AV_OPT_SEARCH_FAKE_OBJ for examining options.
2800  *
2801  * @see av_opt_find().
2802  */
2803 const AVClass *avcodec_get_frame_class(void);
2804 
2805 /**
2806  * Get the AVClass for AVSubtitleRect. It can be used in combination with
2807  * AV_OPT_SEARCH_FAKE_OBJ for examining options.
2808  *
2809  * @see av_opt_find().
2810  */
2812 
2813 /**
2814  * Copy the settings of the source AVCodecContext into the destination
2815  * AVCodecContext. The resulting destination codec context will be
2816  * unopened, i.e. you are required to call avcodec_open2() before you
2817  * can use this AVCodecContext to decode/encode video/audio data.
2818  *
2819  * @param dest target codec context, should be initialized with
2820  * avcodec_alloc_context3(NULL), but otherwise uninitialized
2821  * @param src source codec context
2822  * @return AVERROR() on error (e.g. memory allocation error), 0 on success
2823  *
2824  * @deprecated The semantics of this function are ill-defined and it should not
2825  * be used. If you need to transfer the stream parameters from one codec context
2826  * to another, use an intermediate AVCodecParameters instance and the
2827  * avcodec_parameters_from_context() / avcodec_parameters_to_context()
2828  * functions.
2829  */
2832 #endif
2833 
2834 /**
2835  * Fill the parameters struct based on the values from the supplied codec
2836  * context. Any allocated fields in par are freed and replaced with duplicates
2837  * of the corresponding fields in codec.
2838  *
2839  * @return >= 0 on success, a negative AVERROR code on failure
2840  */
2842  const AVCodecContext *codec);
2843 
2844 /**
2845  * Fill the codec context based on the values from the supplied codec
2846  * parameters. Any allocated fields in codec that have a corresponding field in
2847  * par are freed and replaced with duplicates of the corresponding field in par.
2848  * Fields in codec that do not have a counterpart in par are not touched.
2849  *
2850  * @return >= 0 on success, a negative AVERROR code on failure.
2851  */
2853  const AVCodecParameters *par);
2854 
2855 /**
2856  * Initialize the AVCodecContext to use the given AVCodec. Prior to using this
2857  * function the context has to be allocated with avcodec_alloc_context3().
2858  *
2859  * The functions avcodec_find_decoder_by_name(), avcodec_find_encoder_by_name(),
2860  * avcodec_find_decoder() and avcodec_find_encoder() provide an easy way for
2861  * retrieving a codec.
2862  *
2863  * @warning This function is not thread safe!
2864  *
2865  * @note Always call this function before using decoding routines (such as
2866  * @ref avcodec_receive_frame()).
2867  *
2868  * @code
2869  * avcodec_register_all();
2870  * av_dict_set(&opts, "b", "2.5M", 0);
2871  * codec = avcodec_find_decoder(AV_CODEC_ID_H264);
2872  * if (!codec)
2873  * exit(1);
2874  *
2875  * context = avcodec_alloc_context3(codec);
2876  *
2877  * if (avcodec_open2(context, codec, opts) < 0)
2878  * exit(1);
2879  * @endcode
2880  *
2881  * @param avctx The context to initialize.
2882  * @param codec The codec to open this context for. If a non-NULL codec has been
2883  * previously passed to avcodec_alloc_context3() or
2884  * for this context, then this parameter MUST be either NULL or
2885  * equal to the previously passed codec.
2886  * @param options A dictionary filled with AVCodecContext and codec-private options.
2887  * On return this object will be filled with options that were not found.
2888  *
2889  * @return zero on success, a negative value on error
2890  * @see avcodec_alloc_context3(), avcodec_find_decoder(), avcodec_find_encoder(),
2891  * av_dict_set(), av_opt_find().
2892  */
2893 int avcodec_open2(AVCodecContext *avctx, const AVCodec *codec, AVDictionary **options);
2894 
2895 /**
2896  * Close a given AVCodecContext and free all the data associated with it
2897  * (but not the AVCodecContext itself).
2898  *
2899  * Calling this function on an AVCodecContext that hasn't been opened will free
2900  * the codec-specific data allocated in avcodec_alloc_context3() with a non-NULL
2901  * codec. Subsequent calls will do nothing.
2902  *
2903  * @note Do not use this function. Use avcodec_free_context() to destroy a
2904  * codec context (either open or closed). Opening and closing a codec context
2905  * multiple times is not supported anymore -- use multiple codec contexts
2906  * instead.
2907  */
2908 int avcodec_close(AVCodecContext *avctx);
2909 
2910 /**
2911  * Free all allocated data in the given subtitle struct.
2912  *
2913  * @param sub AVSubtitle to free.
2914  */
2915 void avsubtitle_free(AVSubtitle *sub);
2916 
2917 /**
2918  * @}
2919  */
2920 
2921 /**
2922  * @addtogroup lavc_decoding
2923  * @{
2924  */
2925 
2926 /**
2927  * The default callback for AVCodecContext.get_buffer2(). It is made public so
2928  * it can be called by custom get_buffer2() implementations for decoders without
2929  * AV_CODEC_CAP_DR1 set.
2930  */
2932 
2933 /**
2934  * Modify width and height values so that they will result in a memory
2935  * buffer that is acceptable for the codec if you do not use any horizontal
2936  * padding.
2937  *
2938  * May only be used if a codec with AV_CODEC_CAP_DR1 has been opened.
2939  */
2941 
2942 /**
2943  * Modify width and height values so that they will result in a memory
2944  * buffer that is acceptable for the codec if you also ensure that all
2945  * line sizes are a multiple of the respective linesize_align[i].
2946  *
2947  * May only be used if a codec with AV_CODEC_CAP_DR1 has been opened.
2948  */
2950  int linesize_align[AV_NUM_DATA_POINTERS]);
2951 
2952 /**
2953  * Converts AVChromaLocation to swscale x/y chroma position.
2954  *
2955  * The positions represent the chroma (0,0) position in a coordinates system
2956  * with luma (0,0) representing the origin and luma(1,1) representing 256,256
2957  *
2958  * @param xpos horizontal chroma sample position
2959  * @param ypos vertical chroma sample position
2960  */
2961 int avcodec_enum_to_chroma_pos(int *xpos, int *ypos, enum AVChromaLocation pos);
2962 
2963 /**
2964  * Converts swscale x/y chroma position to AVChromaLocation.
2965  *
2966  * The positions represent the chroma (0,0) position in a coordinates system
2967  * with luma (0,0) representing the origin and luma(1,1) representing 256,256
2968  *
2969  * @param xpos horizontal chroma sample position
2970  * @param ypos vertical chroma sample position
2971  */
2972 enum AVChromaLocation avcodec_chroma_pos_to_enum(int xpos, int ypos);
2973 
2974 /**
2975  * Decode the audio frame of size avpkt->size from avpkt->data into frame.
2976  *
2977  * Some decoders may support multiple frames in a single AVPacket. Such
2978  * decoders would then just decode the first frame and the return value would be
2979  * less than the packet size. In this case, avcodec_decode_audio4 has to be
2980  * called again with an AVPacket containing the remaining data in order to
2981  * decode the second frame, etc... Even if no frames are returned, the packet
2982  * needs to be fed to the decoder with remaining data until it is completely
2983  * consumed or an error occurs.
2984  *
2985  * Some decoders (those marked with AV_CODEC_CAP_DELAY) have a delay between input
2986  * and output. This means that for some packets they will not immediately
2987  * produce decoded output and need to be flushed at the end of decoding to get
2988  * all the decoded data. Flushing is done by calling this function with packets
2989  * with avpkt->data set to NULL and avpkt->size set to 0 until it stops
2990  * returning samples. It is safe to flush even those decoders that are not
2991  * marked with AV_CODEC_CAP_DELAY, then no samples will be returned.
2992  *
2993  * @warning The input buffer, avpkt->data must be AV_INPUT_BUFFER_PADDING_SIZE
2994  * larger than the actual read bytes because some optimized bitstream
2995  * readers read 32 or 64 bits at once and could read over the end.
2996  *
2997  * @note The AVCodecContext MUST have been opened with @ref avcodec_open2()
2998  * before packets may be fed to the decoder.
2999  *
3000  * @param avctx the codec context
3001  * @param[out] frame The AVFrame in which to store decoded audio samples.
3002  * The decoder will allocate a buffer for the decoded frame by
3003  * calling the AVCodecContext.get_buffer2() callback.
3004  * When AVCodecContext.refcounted_frames is set to 1, the frame is
3005  * reference counted and the returned reference belongs to the
3006  * caller. The caller must release the frame using av_frame_unref()
3007  * when the frame is no longer needed. The caller may safely write
3008  * to the frame if av_frame_is_writable() returns 1.
3009  * When AVCodecContext.refcounted_frames is set to 0, the returned
3010  * reference belongs to the decoder and is valid only until the
3011  * next call to this function or until closing or flushing the
3012  * decoder. The caller may not write to it.
3013  * @param[out] got_frame_ptr Zero if no frame could be decoded, otherwise it is
3014  * non-zero. Note that this field being set to zero
3015  * does not mean that an error has occurred. For
3016  * decoders with AV_CODEC_CAP_DELAY set, no given decode
3017  * call is guaranteed to produce a frame.
3018  * @param[in] avpkt The input AVPacket containing the input buffer.
3019  * At least avpkt->data and avpkt->size should be set. Some
3020  * decoders might also require additional fields to be set.
3021  * @return A negative error code is returned if an error occurred during
3022  * decoding, otherwise the number of bytes consumed from the input
3023  * AVPacket is returned.
3024  *
3025 * @deprecated Use avcodec_send_packet() and avcodec_receive_frame().
3026  */
3029  int *got_frame_ptr, const AVPacket *avpkt);
3030 
3031 /**
3032  * Decode the video frame of size avpkt->size from avpkt->data into picture.
3033  * Some decoders may support multiple frames in a single AVPacket, such
3034  * decoders would then just decode the first frame.
3035  *
3036  * @warning The input buffer must be AV_INPUT_BUFFER_PADDING_SIZE larger than
3037  * the actual read bytes because some optimized bitstream readers read 32 or 64
3038  * bits at once and could read over the end.
3039  *
3040  * @warning The end of the input buffer buf should be set to 0 to ensure that
3041  * no overreading happens for damaged MPEG streams.
3042  *
3043  * @note Codecs which have the AV_CODEC_CAP_DELAY capability set have a delay
3044  * between input and output, these need to be fed with avpkt->data=NULL,
3045  * avpkt->size=0 at the end to return the remaining frames.
3046  *
3047  * @note The AVCodecContext MUST have been opened with @ref avcodec_open2()
3048  * before packets may be fed to the decoder.
3049  *
3050  * @param avctx the codec context
3051  * @param[out] picture The AVFrame in which the decoded video frame will be stored.
3052  * Use av_frame_alloc() to get an AVFrame. The codec will
3053  * allocate memory for the actual bitmap by calling the
3054  * AVCodecContext.get_buffer2() callback.
3055  * When AVCodecContext.refcounted_frames is set to 1, the frame is
3056  * reference counted and the returned reference belongs to the
3057  * caller. The caller must release the frame using av_frame_unref()
3058  * when the frame is no longer needed. The caller may safely write
3059  * to the frame if av_frame_is_writable() returns 1.
3060  * When AVCodecContext.refcounted_frames is set to 0, the returned
3061  * reference belongs to the decoder and is valid only until the
3062  * next call to this function or until closing or flushing the
3063  * decoder. The caller may not write to it.
3064  *
3065  * @param[in] avpkt The input AVPacket containing the input buffer.
3066  * You can create such packet with av_init_packet() and by then setting
3067  * data and size, some decoders might in addition need other fields like
3068  * flags&AV_PKT_FLAG_KEY. All decoders are designed to use the least
3069  * fields possible.
3070  * @param[in,out] got_picture_ptr Zero if no frame could be decompressed, otherwise, it is nonzero.
3071  * @return On error a negative value is returned, otherwise the number of bytes
3072  * used or zero if no frame could be decompressed.
3073  *
3074  * @deprecated Use avcodec_send_packet() and avcodec_receive_frame().
3075  */
3077 int avcodec_decode_video2(AVCodecContext *avctx, AVFrame *picture,
3078  int *got_picture_ptr,
3079  const AVPacket *avpkt);
3080 
3081 /**
3082  * Decode a subtitle message.
3083  * Return a negative value on error, otherwise return the number of bytes used.
3084  * If no subtitle could be decompressed, got_sub_ptr is zero.
3085  * Otherwise, the subtitle is stored in *sub.
3086  * Note that AV_CODEC_CAP_DR1 is not available for subtitle codecs. This is for
3087  * simplicity, because the performance difference is expected to be negligible
3088  * and reusing a get_buffer written for video codecs would probably perform badly
3089  * due to a potentially very different allocation pattern.
3090  *
3091  * Some decoders (those marked with AV_CODEC_CAP_DELAY) have a delay between input
3092  * and output. This means that for some packets they will not immediately
3093  * produce decoded output and need to be flushed at the end of decoding to get
3094  * all the decoded data. Flushing is done by calling this function with packets
3095  * with avpkt->data set to NULL and avpkt->size set to 0 until it stops
3096  * returning subtitles. It is safe to flush even those decoders that are not
3097  * marked with AV_CODEC_CAP_DELAY, then no subtitles will be returned.
3098  *
3099  * @note The AVCodecContext MUST have been opened with @ref avcodec_open2()
3100  * before packets may be fed to the decoder.
3101  *
3102  * @param avctx the codec context
3103  * @param[out] sub The preallocated AVSubtitle in which the decoded subtitle will be stored,
3104  * must be freed with avsubtitle_free if *got_sub_ptr is set.
3105  * @param[in,out] got_sub_ptr Zero if no subtitle could be decompressed, otherwise, it is nonzero.
3106  * @param[in] avpkt The input AVPacket containing the input buffer.
3107  */
3109  int *got_sub_ptr,
3110  AVPacket *avpkt);
3111 
3112 /**
3113  * Supply raw packet data as input to a decoder.
3114  *
3115  * Internally, this call will copy relevant AVCodecContext fields, which can
3116  * influence decoding per-packet, and apply them when the packet is actually
3117  * decoded. (For example AVCodecContext.skip_frame, which might direct the
3118  * decoder to drop the frame contained by the packet sent with this function.)
3119  *
3120  * @warning The input buffer, avpkt->data must be AV_INPUT_BUFFER_PADDING_SIZE
3121  * larger than the actual read bytes because some optimized bitstream
3122  * readers read 32 or 64 bits at once and could read over the end.
3123  *
3124  * @warning Do not mix this API with the legacy API (like avcodec_decode_video2())
3125  * on the same AVCodecContext. It will return unexpected results now
3126  * or in future libavcodec versions.
3127  *
3128  * @note The AVCodecContext MUST have been opened with @ref avcodec_open2()
3129  * before packets may be fed to the decoder.
3130  *
3131  * @param avctx codec context
3132  * @param[in] avpkt The input AVPacket. Usually, this will be a single video
3133  * frame, or several complete audio frames.
3134  * Ownership of the packet remains with the caller, and the
3135  * decoder will not write to the packet. The decoder may create
3136  * a reference to the packet data (or copy it if the packet is
3137  * not reference-counted).
3138  * Unlike with older APIs, the packet is always fully consumed,
3139  * and if it contains multiple frames (e.g. some audio codecs),
3140  * will require you to call avcodec_receive_frame() multiple
3141  * times afterwards before you can send a new packet.
3142  * It can be NULL (or an AVPacket with data set to NULL and
3143  * size set to 0); in this case, it is considered a flush
3144  * packet, which signals the end of the stream. Sending the
3145  * first flush packet will return success. Subsequent ones are
3146  * unnecessary and will return AVERROR_EOF. If the decoder
3147  * still has frames buffered, it will return them after sending
3148  * a flush packet.
3149  *
3150  * @return 0 on success, otherwise negative error code:
3151  * AVERROR(EAGAIN): input is not accepted in the current state - user
3152  * must read output with avcodec_receive_frame() (once
3153  * all output is read, the packet should be resent, and
3154  * the call will not fail with EAGAIN).
3155  * AVERROR_EOF: the decoder has been flushed, and no new packets can
3156  * be sent to it (also returned if more than 1 flush
3157  * packet is sent)
3158  * AVERROR(EINVAL): codec not opened, it is an encoder, or requires flush
3159  * AVERROR(ENOMEM): failed to add packet to internal queue, or similar
3160  * other errors: legitimate decoding errors
3161  */
3162 int avcodec_send_packet(AVCodecContext *avctx, const AVPacket *avpkt);
3163 
3164 /**
3165  * Return decoded output data from a decoder.
3166  *
3167  * @param avctx codec context
3168  * @param frame This will be set to a reference-counted video or audio
3169  * frame (depending on the decoder type) allocated by the
3170  * decoder. Note that the function will always call
3171  * av_frame_unref(frame) before doing anything else.
3172  *
3173  * @return
3174  * 0: success, a frame was returned
3175  * AVERROR(EAGAIN): output is not available in this state - user must try
3176  * to send new input
3177  * AVERROR_EOF: the decoder has been fully flushed, and there will be
3178  * no more output frames
3179  * AVERROR(EINVAL): codec not opened, or it is an encoder
3180  * AVERROR_INPUT_CHANGED: current decoded frame has changed parameters
3181  * with respect to first decoded frame. Applicable
3182  * when flag AV_CODEC_FLAG_DROPCHANGED is set.
3183  * other negative values: legitimate decoding errors
3184  */
3186 
3187 /**
3188  * Supply a raw video or audio frame to the encoder. Use avcodec_receive_packet()
3189  * to retrieve buffered output packets.
3190  *
3191  * @param avctx codec context
3192  * @param[in] frame AVFrame containing the raw audio or video frame to be encoded.
3193  * Ownership of the frame remains with the caller, and the
3194  * encoder will not write to the frame. The encoder may create
3195  * a reference to the frame data (or copy it if the frame is
3196  * not reference-counted).
3197  * It can be NULL, in which case it is considered a flush
3198  * packet. This signals the end of the stream. If the encoder
3199  * still has packets buffered, it will return them after this
3200  * call. Once flushing mode has been entered, additional flush
3201  * packets are ignored, and sending frames will return
3202  * AVERROR_EOF.
3203  *
3204  * For audio:
3205  * If AV_CODEC_CAP_VARIABLE_FRAME_SIZE is set, then each frame
3206  * can have any number of samples.
3207  * If it is not set, frame->nb_samples must be equal to
3208  * avctx->frame_size for all frames except the last.
3209  * The final frame may be smaller than avctx->frame_size.
3210  * @return 0 on success, otherwise negative error code:
3211  * AVERROR(EAGAIN): input is not accepted in the current state - user
3212  * must read output with avcodec_receive_packet() (once
3213  * all output is read, the packet should be resent, and
3214  * the call will not fail with EAGAIN).
3215  * AVERROR_EOF: the encoder has been flushed, and no new frames can
3216  * be sent to it
3217  * AVERROR(EINVAL): codec not opened, refcounted_frames not set, it is a
3218  * decoder, or requires flush
3219  * AVERROR(ENOMEM): failed to add packet to internal queue, or similar
3220  * other errors: legitimate encoding errors
3221  */
3222 int avcodec_send_frame(AVCodecContext *avctx, const AVFrame *frame);
3223 
3224 /**
3225  * Read encoded data from the encoder.
3226  *
3227  * @param avctx codec context
3228  * @param avpkt This will be set to a reference-counted packet allocated by the
3229  * encoder. Note that the function will always call
3230  * av_packet_unref(avpkt) before doing anything else.
3231  * @return 0 on success, otherwise negative error code:
3232  * AVERROR(EAGAIN): output is not available in the current state - user
3233  * must try to send input
3234  * AVERROR_EOF: the encoder has been fully flushed, and there will be
3235  * no more output packets
3236  * AVERROR(EINVAL): codec not opened, or it is a decoder
3237  * other errors: legitimate encoding errors
3238  */
3239 int avcodec_receive_packet(AVCodecContext *avctx, AVPacket *avpkt);
3240 
3241 /**
3242  * Create and return a AVHWFramesContext with values adequate for hardware
3243  * decoding. This is meant to get called from the get_format callback, and is
3244  * a helper for preparing a AVHWFramesContext for AVCodecContext.hw_frames_ctx.
3245  * This API is for decoding with certain hardware acceleration modes/APIs only.
3246  *
3247  * The returned AVHWFramesContext is not initialized. The caller must do this
3248  * with av_hwframe_ctx_init().
3249  *
3250  * Calling this function is not a requirement, but makes it simpler to avoid
3251  * codec or hardware API specific details when manually allocating frames.
3252  *
3253  * Alternatively to this, an API user can set AVCodecContext.hw_device_ctx,
3254  * which sets up AVCodecContext.hw_frames_ctx fully automatically, and makes
3255  * it unnecessary to call this function or having to care about
3256  * AVHWFramesContext initialization at all.
3257  *
3258  * There are a number of requirements for calling this function:
3259  *
3260  * - It must be called from get_format with the same avctx parameter that was
3261  * passed to get_format. Calling it outside of get_format is not allowed, and
3262  * can trigger undefined behavior.
3263  * - The function is not always supported (see description of return values).
3264  * Even if this function returns successfully, hwaccel initialization could
3265  * fail later. (The degree to which implementations check whether the stream
3266  * is actually supported varies. Some do this check only after the user's
3267  * get_format callback returns.)
3268  * - The hw_pix_fmt must be one of the choices suggested by get_format. If the
3269  * user decides to use a AVHWFramesContext prepared with this API function,
3270  * the user must return the same hw_pix_fmt from get_format.
3271  * - The device_ref passed to this function must support the given hw_pix_fmt.
3272  * - After calling this API function, it is the user's responsibility to
3273  * initialize the AVHWFramesContext (returned by the out_frames_ref parameter),
3274  * and to set AVCodecContext.hw_frames_ctx to it. If done, this must be done
3275  * before returning from get_format (this is implied by the normal
3276  * AVCodecContext.hw_frames_ctx API rules).
3277  * - The AVHWFramesContext parameters may change every time time get_format is
3278  * called. Also, AVCodecContext.hw_frames_ctx is reset before get_format. So
3279  * you are inherently required to go through this process again on every
3280  * get_format call.
3281  * - It is perfectly possible to call this function without actually using
3282  * the resulting AVHWFramesContext. One use-case might be trying to reuse a
3283  * previously initialized AVHWFramesContext, and calling this API function
3284  * only to test whether the required frame parameters have changed.
3285  * - Fields that use dynamically allocated values of any kind must not be set
3286  * by the user unless setting them is explicitly allowed by the documentation.
3287  * If the user sets AVHWFramesContext.free and AVHWFramesContext.user_opaque,
3288  * the new free callback must call the potentially set previous free callback.
3289  * This API call may set any dynamically allocated fields, including the free
3290  * callback.
3291  *
3292  * The function will set at least the following fields on AVHWFramesContext
3293  * (potentially more, depending on hwaccel API):
3294  *
3295  * - All fields set by av_hwframe_ctx_alloc().
3296  * - Set the format field to hw_pix_fmt.
3297  * - Set the sw_format field to the most suited and most versatile format. (An
3298  * implication is that this will prefer generic formats over opaque formats
3299  * with arbitrary restrictions, if possible.)
3300  * - Set the width/height fields to the coded frame size, rounded up to the
3301  * API-specific minimum alignment.
3302  * - Only _if_ the hwaccel requires a pre-allocated pool: set the initial_pool_size
3303  * field to the number of maximum reference surfaces possible with the codec,
3304  * plus 1 surface for the user to work (meaning the user can safely reference
3305  * at most 1 decoded surface at a time), plus additional buffering introduced
3306  * by frame threading. If the hwaccel does not require pre-allocation, the
3307  * field is left to 0, and the decoder will allocate new surfaces on demand
3308  * during decoding.
3309  * - Possibly AVHWFramesContext.hwctx fields, depending on the underlying
3310  * hardware API.
3311  *
3312  * Essentially, out_frames_ref returns the same as av_hwframe_ctx_alloc(), but
3313  * with basic frame parameters set.
3314  *
3315  * The function is stateless, and does not change the AVCodecContext or the
3316  * device_ref AVHWDeviceContext.
3317  *
3318  * @param avctx The context which is currently calling get_format, and which
3319  * implicitly contains all state needed for filling the returned
3320  * AVHWFramesContext properly.
3321  * @param device_ref A reference to the AVHWDeviceContext describing the device
3322  * which will be used by the hardware decoder.
3323  * @param hw_pix_fmt The hwaccel format you are going to return from get_format.
3324  * @param out_frames_ref On success, set to a reference to an _uninitialized_
3325  * AVHWFramesContext, created from the given device_ref.
3326  * Fields will be set to values required for decoding.
3327  * Not changed if an error is returned.
3328  * @return zero on success, a negative value on error. The following error codes
3329  * have special semantics:
3330  * AVERROR(ENOENT): the decoder does not support this functionality. Setup
3331  * is always manual, or it is a decoder which does not
3332  * support setting AVCodecContext.hw_frames_ctx at all,
3333  * or it is a software format.
3334  * AVERROR(EINVAL): it is known that hardware decoding is not supported for
3335  * this configuration, or the device_ref is not supported
3336  * for the hwaccel referenced by hw_pix_fmt.
3337  */
3339  AVBufferRef *device_ref,
3341  AVBufferRef **out_frames_ref);
3342 
3343 
3344 
3345 /**
3346  * @defgroup lavc_parsing Frame parsing
3347  * @{
3348  */
3349 
3352  AV_PICTURE_STRUCTURE_TOP_FIELD, //< coded as top field
3353  AV_PICTURE_STRUCTURE_BOTTOM_FIELD, //< coded as bottom field
3354  AV_PICTURE_STRUCTURE_FRAME, //< coded as frame
3355 };
3356 
3357 typedef struct AVCodecParserContext {
3358  void *priv_data;
3360  int64_t frame_offset; /* offset of the current frame */
3361  int64_t cur_offset; /* current offset
3362  (incremented by each av_parser_parse()) */
3363  int64_t next_frame_offset; /* offset of the next frame */
3364  /* video info */
3365  int pict_type; /* XXX: Put it back in AVCodecContext. */
3366  /**
3367  * This field is used for proper frame duration computation in lavf.
3368  * It signals, how much longer the frame duration of the current frame
3369  * is compared to normal frame duration.
3370  *
3371  * frame_duration = (1 + repeat_pict) * time_base
3372  *
3373  * It is used by codecs like H.264 to display telecined material.
3374  */
3375  int repeat_pict; /* XXX: Put it back in AVCodecContext. */
3376  int64_t pts; /* pts of the current frame */
3377  int64_t dts; /* dts of the current frame */
3378 
3379  /* private data */
3383 
3384 #define AV_PARSER_PTS_NB 4
3386  int64_t cur_frame_offset[AV_PARSER_PTS_NB];
3387  int64_t cur_frame_pts[AV_PARSER_PTS_NB];
3388  int64_t cur_frame_dts[AV_PARSER_PTS_NB];
3389 
3390  int flags;
3391 #define PARSER_FLAG_COMPLETE_FRAMES 0x0001
3392 #define PARSER_FLAG_ONCE 0x0002
3393 /// Set if the parser has a valid file offset
3394 #define PARSER_FLAG_FETCHED_OFFSET 0x0004
3395 #define PARSER_FLAG_USE_CODEC_TS 0x1000
3396 
3397  int64_t offset; ///< byte offset from starting packet start
3398  int64_t cur_frame_end[AV_PARSER_PTS_NB];
3399 
3400  /**
3401  * Set by parser to 1 for key frames and 0 for non-key frames.
3402  * It is initialized to -1, so if the parser doesn't set this flag,
3403  * old-style fallback using AV_PICTURE_TYPE_I picture type as key frames
3404  * will be used.
3405  */
3407 
3408 #if FF_API_CONVERGENCE_DURATION
3409  /**
3410  * @deprecated unused
3411  */
3414 #endif
3415 
3416  // Timestamp generation support:
3417  /**
3418  * Synchronization point for start of timestamp generation.
3419  *
3420  * Set to >0 for sync point, 0 for no sync point and <0 for undefined
3421  * (default).
3422  *
3423  * For example, this corresponds to presence of H.264 buffering period
3424  * SEI message.
3425  */
3427 
3428  /**
3429  * Offset of the current timestamp against last timestamp sync point in
3430  * units of AVCodecContext.time_base.
3431  *
3432  * Set to INT_MIN when dts_sync_point unused. Otherwise, it must
3433  * contain a valid timestamp offset.
3434  *
3435  * Note that the timestamp of sync point has usually a nonzero
3436  * dts_ref_dts_delta, which refers to the previous sync point. Offset of
3437  * the next frame after timestamp sync point will be usually 1.
3438  *
3439  * For example, this corresponds to H.264 cpb_removal_delay.
3440  */
3442 
3443  /**
3444  * Presentation delay of current frame in units of AVCodecContext.time_base.
3445  *
3446  * Set to INT_MIN when dts_sync_point unused. Otherwise, it must
3447  * contain valid non-negative timestamp delta (presentation time of a frame
3448  * must not lie in the past).
3449  *
3450  * This delay represents the difference between decoding and presentation
3451  * time of the frame.
3452  *
3453  * For example, this corresponds to H.264 dpb_output_delay.
3454  */
3456 
3457  /**
3458  * Position of the packet in file.
3459  *
3460  * Analogous to cur_frame_pts/dts
3461  */
3462  int64_t cur_frame_pos[AV_PARSER_PTS_NB];
3463 
3464  /**
3465  * Byte position of currently parsed frame in stream.
3466  */
3468 
3469  /**
3470  * Previous frame byte position.
3471  */
3473 
3474  /**
3475  * Duration of the current frame.
3476  * For audio, this is in units of 1 / AVCodecContext.sample_rate.
3477  * For all other types, this is in units of AVCodecContext.time_base.
3478  */
3480 
3481  enum AVFieldOrder field_order;
3482 
3483  /**
3484  * Indicate whether a picture is coded as a frame, top field or bottom field.
3485  *
3486  * For example, H.264 field_pic_flag equal to 0 corresponds to
3487  * AV_PICTURE_STRUCTURE_FRAME. An H.264 picture with field_pic_flag
3488  * equal to 1 and bottom_field_flag equal to 0 corresponds to
3489  * AV_PICTURE_STRUCTURE_TOP_FIELD.
3490  */
3491  enum AVPictureStructure picture_structure;
3492 
3493  /**
3494  * Picture number incremented in presentation or output order.
3495  * This field may be reinitialized at the first picture of a new sequence.
3496  *
3497  * For example, this corresponds to H.264 PicOrderCnt.
3498  */
3500 
3501  /**
3502  * Dimensions of the decoded video intended for presentation.
3503  */
3504  int width;
3505  int height;
3506 
3507  /**
3508  * Dimensions of the coded video.
3509  */
3512 
3513  /**
3514  * The format of the coded data, corresponds to enum AVPixelFormat for video
3515  * and for enum AVSampleFormat for audio.
3516  *
3517  * Note that a decoder can have considerable freedom in how exactly it
3518  * decodes the data, so the format reported here might be different from the
3519  * one returned by a decoder.
3520  */
3521  int format;
3523 
3524 typedef struct AVCodecParser {
3525  int codec_ids[5]; /* several codec IDs are permitted */
3527  int (*parser_init)(AVCodecParserContext *s);
3528  /* This callback never returns an error, a negative value means that
3529  * the frame start was in a previous packet. */
3530  int (*parser_parse)(AVCodecParserContext *s,
3531  AVCodecContext *avctx,
3532  const uint8_t **poutbuf, int *poutbuf_size,
3533  const uint8_t *buf, int buf_size);
3534  void (*parser_close)(AVCodecParserContext *s);
3535  int (*split)(AVCodecContext *avctx, const uint8_t *buf, int buf_size);
3537 } AVCodecParser;
3538 
3539 /**
3540  * Iterate over all registered codec parsers.
3541  *
3542  * @param opaque a pointer where libavcodec will store the iteration state. Must
3543  * point to NULL to start the iteration.
3544  *
3545  * @return the next registered codec parser or NULL when the iteration is
3546  * finished
3547  */
3548 const AVCodecParser *av_parser_iterate(void **opaque);
3549 
3552 
3556 
3557 /**
3558  * Parse a packet.
3559  *
3560  * @param s parser context.
3561  * @param avctx codec context.
3562  * @param poutbuf set to pointer to parsed buffer or NULL if not yet finished.
3563  * @param poutbuf_size set to size of parsed buffer or zero if not yet finished.
3564  * @param buf input buffer.
3565  * @param buf_size buffer size in bytes without the padding. I.e. the full buffer
3566  size is assumed to be buf_size + AV_INPUT_BUFFER_PADDING_SIZE.
3567  To signal EOF, this should be 0 (so that the last frame
3568  can be output).
3569  * @param pts input presentation timestamp.
3570  * @param dts input decoding timestamp.
3571  * @param pos input byte position in stream.
3572  * @return the number of bytes of the input bitstream used.
3573  *
3574  * Example:
3575  * @code
3576  * while(in_len){
3577  * len = av_parser_parse2(myparser, AVCodecContext, &data, &size,
3578  * in_data, in_len,
3579  * pts, dts, pos);
3580  * in_data += len;
3581  * in_len -= len;
3582  *
3583  * if(size)
3584  * decode_frame(data, size);
3585  * }
3586  * @endcode
3587  */
3589  AVCodecContext *avctx,
3590  uint8_t **poutbuf, int *poutbuf_size,
3591  const uint8_t *buf, int buf_size,
3592  int64_t pts, int64_t dts,
3593  int64_t pos);
3594 
3595 /**
3596  * @return 0 if the output buffer is a subset of the input, 1 if it is allocated and must be freed
3597  * @deprecated use AVBitStreamFilter
3598  */
3600  AVCodecContext *avctx,
3601  uint8_t **poutbuf, int *poutbuf_size,
3602  const uint8_t *buf, int buf_size, int keyframe);
3604 
3605 /**
3606  * @}
3607  * @}
3608  */
3609 
3610 /**
3611  * @addtogroup lavc_encoding
3612  * @{
3613  */
3614 
3615 /**
3616  * Encode a frame of audio.
3617  *
3618  * Takes input samples from frame and writes the next output packet, if
3619  * available, to avpkt. The output packet does not necessarily contain data for
3620  * the most recent frame, as encoders can delay, split, and combine input frames
3621  * internally as needed.
3622  *
3623  * @param avctx codec context
3624  * @param avpkt output AVPacket.
3625  * The user can supply an output buffer by setting
3626  * avpkt->data and avpkt->size prior to calling the
3627  * function, but if the size of the user-provided data is not
3628  * large enough, encoding will fail. If avpkt->data and
3629  * avpkt->size are set, avpkt->destruct must also be set. All
3630  * other AVPacket fields will be reset by the encoder using
3631  * av_init_packet(). If avpkt->data is NULL, the encoder will
3632  * allocate it. The encoder will set avpkt->size to the size
3633  * of the output packet.
3634  *
3635  * If this function fails or produces no output, avpkt will be
3636  * freed using av_packet_unref().
3637  * @param[in] frame AVFrame containing the raw audio data to be encoded.
3638  * May be NULL when flushing an encoder that has the
3639  * AV_CODEC_CAP_DELAY capability set.
3640  * If AV_CODEC_CAP_VARIABLE_FRAME_SIZE is set, then each frame
3641  * can have any number of samples.
3642  * If it is not set, frame->nb_samples must be equal to
3643  * avctx->frame_size for all frames except the last.
3644  * The final frame may be smaller than avctx->frame_size.
3645  * @param[out] got_packet_ptr This field is set to 1 by libavcodec if the
3646  * output packet is non-empty, and to 0 if it is
3647  * empty. If the function returns an error, the
3648  * packet can be assumed to be invalid, and the
3649  * value of got_packet_ptr is undefined and should
3650  * not be used.
3651  * @return 0 on success, negative error code on failure
3652  *
3653  * @deprecated use avcodec_send_frame()/avcodec_receive_packet() instead
3654  */
3656 int avcodec_encode_audio2(AVCodecContext *avctx, AVPacket *avpkt,
3657  const AVFrame *frame, int *got_packet_ptr);
3658 
3659 /**
3660  * Encode a frame of video.
3661  *
3662  * Takes input raw video data from frame and writes the next output packet, if
3663  * available, to avpkt. The output packet does not necessarily contain data for
3664  * the most recent frame, as encoders can delay and reorder input frames
3665  * internally as needed.
3666  *
3667  * @param avctx codec context
3668  * @param avpkt output AVPacket.
3669  * The user can supply an output buffer by setting
3670  * avpkt->data and avpkt->size prior to calling the
3671  * function, but if the size of the user-provided data is not
3672  * large enough, encoding will fail. All other AVPacket fields
3673  * will be reset by the encoder using av_init_packet(). If
3674  * avpkt->data is NULL, the encoder will allocate it.
3675  * The encoder will set avpkt->size to the size of the
3676  * output packet. The returned data (if any) belongs to the
3677  * caller, he is responsible for freeing it.
3678  *
3679  * If this function fails or produces no output, avpkt will be
3680  * freed using av_packet_unref().
3681  * @param[in] frame AVFrame containing the raw video data to be encoded.
3682  * May be NULL when flushing an encoder that has the
3683  * AV_CODEC_CAP_DELAY capability set.
3684  * @param[out] got_packet_ptr This field is set to 1 by libavcodec if the
3685  * output packet is non-empty, and to 0 if it is
3686  * empty. If the function returns an error, the
3687  * packet can be assumed to be invalid, and the
3688  * value of got_packet_ptr is undefined and should
3689  * not be used.
3690  * @return 0 on success, negative error code on failure
3691  *
3692  * @deprecated use avcodec_send_frame()/avcodec_receive_packet() instead
3693  */
3695 int avcodec_encode_video2(AVCodecContext *avctx, AVPacket *avpkt,
3696  const AVFrame *frame, int *got_packet_ptr);
3697 
3698 int avcodec_encode_subtitle(AVCodecContext *avctx, uint8_t *buf, int buf_size,
3699  const AVSubtitle *sub);
3700 
3701 
3702 /**
3703  * @}
3704  */
3705 
3706 #if FF_API_AVPICTURE
3707 /**
3708  * @addtogroup lavc_picture
3709  * @{
3710  */
3711 
3712 /**
3713  * @deprecated unused
3714  */
3716 int avpicture_alloc(AVPicture *picture, enum AVPixelFormat pix_fmt, int width, int height);
3717 
3718 /**
3719  * @deprecated unused
3720  */
3722 void avpicture_free(AVPicture *picture);
3723 
3724 /**
3725  * @deprecated use av_image_fill_arrays() instead.
3726  */
3728 int avpicture_fill(AVPicture *picture, const uint8_t *ptr,
3729  enum AVPixelFormat pix_fmt, int width, int height);
3730 
3731 /**
3732  * @deprecated use av_image_copy_to_buffer() instead.
3733  */
3736  int width, int height,
3737  unsigned char *dest, int dest_size);
3738 
3739 /**
3740  * @deprecated use av_image_get_buffer_size() instead.
3741  */
3744 
3745 /**
3746  * @deprecated av_image_copy() instead.
3747  */
3749 void av_picture_copy(AVPicture *dst, const AVPicture *src,
3750  enum AVPixelFormat pix_fmt, int width, int height);
3751 
3752 /**
3753  * @deprecated unused
3754  */
3756 int av_picture_crop(AVPicture *dst, const AVPicture *src,
3757  enum AVPixelFormat pix_fmt, int top_band, int left_band);
3758 
3759 /**
3760  * @deprecated unused
3761  */
3763 int av_picture_pad(AVPicture *dst, const AVPicture *src, int height, int width, enum AVPixelFormat pix_fmt,
3764  int padtop, int padbottom, int padleft, int padright, int *color);
3765 
3766 /**
3767  * @}
3768  */
3769 #endif
3770 
3771 /**
3772  * @defgroup lavc_misc Utility functions
3773  * @ingroup libavc
3774  *
3775  * Miscellaneous utility functions related to both encoding and decoding
3776  * (or neither).
3777  * @{
3778  */
3779 
3780 /**
3781  * @defgroup lavc_misc_pixfmt Pixel formats
3782  *
3783  * Functions for working with pixel formats.
3784  * @{
3785  */
3786 
3787 #if FF_API_GETCHROMA
3788 /**
3789  * @deprecated Use av_pix_fmt_get_chroma_sub_sample
3790  */
3791 
3793 void avcodec_get_chroma_sub_sample(enum AVPixelFormat pix_fmt, int *h_shift, int *v_shift);
3794 #endif
3795 
3796 /**
3797  * Return a value representing the fourCC code associated to the
3798  * pixel format pix_fmt, or 0 if no associated fourCC code can be
3799  * found.
3800  */
3802 
3803 /**
3804  * @deprecated see av_get_pix_fmt_loss()
3805  */
3806 int avcodec_get_pix_fmt_loss(enum AVPixelFormat dst_pix_fmt, enum AVPixelFormat src_pix_fmt,
3807  int has_alpha);
3808 
3809 /**
3810  * Find the best pixel format to convert to given a certain source pixel
3811  * format. When converting from one pixel format to another, information loss
3812  * may occur. For example, when converting from RGB24 to GRAY, the color
3813  * information will be lost. Similarly, other losses occur when converting from
3814  * some formats to other formats. avcodec_find_best_pix_fmt_of_2() searches which of
3815  * the given pixel formats should be used to suffer the least amount of loss.
3816  * The pixel formats from which it chooses one, are determined by the
3817  * pix_fmt_list parameter.
3818  *
3819  *
3820  * @param[in] pix_fmt_list AV_PIX_FMT_NONE terminated array of pixel formats to choose from
3821  * @param[in] src_pix_fmt source pixel format
3822  * @param[in] has_alpha Whether the source pixel format alpha channel is used.
3823  * @param[out] loss_ptr Combination of flags informing you what kind of losses will occur.
3824  * @return The best pixel format to convert to or -1 if none was found.
3825  */
3826 enum AVPixelFormat avcodec_find_best_pix_fmt_of_list(const enum AVPixelFormat *pix_fmt_list,
3827  enum AVPixelFormat src_pix_fmt,
3828  int has_alpha, int *loss_ptr);
3829 
3830 /**
3831  * @deprecated see av_find_best_pix_fmt_of_2()
3832  */
3833 enum AVPixelFormat avcodec_find_best_pix_fmt_of_2(enum AVPixelFormat dst_pix_fmt1, enum AVPixelFormat dst_pix_fmt2,
3834  enum AVPixelFormat src_pix_fmt, int has_alpha, int *loss_ptr);
3835 
3837 enum AVPixelFormat avcodec_find_best_pix_fmt2(enum AVPixelFormat dst_pix_fmt1, enum AVPixelFormat dst_pix_fmt2,
3838  enum AVPixelFormat src_pix_fmt, int has_alpha, int *loss_ptr);
3839 
3841 
3842 /**
3843  * @}
3844  */
3845 
3846 #if FF_API_TAG_STRING
3847 /**
3848  * Put a string representing the codec tag codec_tag in buf.
3849  *
3850  * @param buf buffer to place codec tag in
3851  * @param buf_size size in bytes of buf
3852  * @param codec_tag codec tag to assign
3853  * @return the length of the string that would have been generated if
3854  * enough space had been available, excluding the trailing null
3855  *
3856  * @deprecated see av_fourcc_make_string() and av_fourcc2str().
3857  */
3859 size_t av_get_codec_tag_string(char *buf, size_t buf_size, unsigned int codec_tag);
3860 #endif
3861 
3862 void avcodec_string(char *buf, int buf_size, AVCodecContext *enc, int encode);
3863 
3864 /**
3865  * Return a name for the specified profile, if available.
3866  *
3867  * @param codec the codec that is searched for the given profile
3868  * @param profile the profile value for which a name is requested
3869  * @return A name for the profile if found, NULL otherwise.
3870  */
3871 const char *av_get_profile_name(const AVCodec *codec, int profile);
3872 
3873 /**
3874  * Return a name for the specified profile, if available.
3875  *
3876  * @param codec_id the ID of the codec to which the requested profile belongs
3877  * @param profile the profile value for which a name is requested
3878  * @return A name for the profile if found, NULL otherwise.
3879  *
3880  * @note unlike av_get_profile_name(), which searches a list of profiles
3881  * supported by a specific decoder or encoder implementation, this
3882  * function searches the list of profiles from the AVCodecDescriptor
3883  */
3884 const char *avcodec_profile_name(enum AVCodecID codec_id, int profile);
3885 
3886 int avcodec_default_execute(AVCodecContext *c, int (*func)(AVCodecContext *c2, void *arg2),void *arg, int *ret, int count, int size);
3887 int avcodec_default_execute2(AVCodecContext *c, int (*func)(AVCodecContext *c2, void *arg2, int, int),void *arg, int *ret, int count);
3888 //FIXME func typedef
3889 
3890 /**
3891  * Fill AVFrame audio data and linesize pointers.
3892  *
3893  * The buffer buf must be a preallocated buffer with a size big enough
3894  * to contain the specified samples amount. The filled AVFrame data
3895  * pointers will point to this buffer.
3896  *
3897  * AVFrame extended_data channel pointers are allocated if necessary for
3898  * planar audio.
3899  *
3900  * @param frame the AVFrame
3901  * frame->nb_samples must be set prior to calling the
3902  * function. This function fills in frame->data,
3903  * frame->extended_data, frame->linesize[0].
3904  * @param nb_channels channel count
3905  * @param sample_fmt sample format
3906  * @param buf buffer to use for frame data
3907  * @param buf_size size of buffer
3908  * @param align plane size sample alignment (0 = default)
3909  * @return >=0 on success, negative error code on failure
3910  * @todo return the size in bytes required to store the samples in
3911  * case of success, at the next libavutil bump
3912  */
3914  enum AVSampleFormat sample_fmt, const uint8_t *buf,
3915  int buf_size, int align);
3916 
3917 /**
3918  * Reset the internal codec state / flush internal buffers. Should be called
3919  * e.g. when seeking or when switching to a different stream.
3920  *
3921  * @note for decoders, when refcounted frames are not used
3922  * (i.e. avctx->refcounted_frames is 0), this invalidates the frames previously
3923  * returned from the decoder. When refcounted frames are used, the decoder just
3924  * releases any references it might keep internally, but the caller's reference
3925  * remains valid.
3926  *
3927  * @note for encoders, this function will only do something if the encoder
3928  * declares support for AV_CODEC_CAP_ENCODER_FLUSH. When called, the encoder
3929  * will drain any remaining packets, and can then be re-used for a different
3930  * stream (as opposed to sending a null frame which will leave the encoder
3931  * in a permanent EOF state after draining). This can be desirable if the
3932  * cost of tearing down and replacing the encoder instance is high.
3933  */
3935 
3936 /**
3937  * Return codec bits per sample.
3938  *
3939  * @param[in] codec_id the codec
3940  * @return Number of bits per sample or zero if unknown for the given codec.
3941  */
3943 
3944 /**
3945  * Return the PCM codec associated with a sample format.
3946  * @param be endianness, 0 for little, 1 for big,
3947  * -1 (or anything else) for native
3948  * @return AV_CODEC_ID_PCM_* or AV_CODEC_ID_NONE
3949  */
3950 enum AVCodecID av_get_pcm_codec(enum AVSampleFormat fmt, int be);
3951 
3952 /**
3953  * Return codec bits per sample.
3954  * Only return non-zero if the bits per sample is exactly correct, not an
3955  * approximation.
3956  *
3957  * @param[in] codec_id the codec
3958  * @return Number of bits per sample or zero if unknown for the given codec.
3959  */
3961 
3962 /**
3963  * Return audio frame duration.
3964  *
3965  * @param avctx codec context
3966  * @param frame_bytes size of the frame, or 0 if unknown
3967  * @return frame duration, in samples, if known. 0 if not able to
3968  * determine.
3969  */
3970 int av_get_audio_frame_duration(AVCodecContext *avctx, int frame_bytes);
3971 
3972 /**
3973  * This function is the same as av_get_audio_frame_duration(), except it works
3974  * with AVCodecParameters instead of an AVCodecContext.
3975  */
3976 int av_get_audio_frame_duration2(AVCodecParameters *par, int frame_bytes);
3977 
3978 #if FF_API_OLD_BSF
3980  void *priv_data;
3981  const struct AVBitStreamFilter *filter;
3984  /**
3985  * Internal default arguments, used if NULL is passed to av_bitstream_filter_filter().
3986  * Not for access by library users.
3987  */
3988  char *args;
3990 
3991 /**
3992  * @deprecated the old bitstream filtering API (using AVBitStreamFilterContext)
3993  * is deprecated. Use the new bitstream filtering API (using AVBSFContext).
3994  */
3997 /**
3998  * @deprecated the old bitstream filtering API (using AVBitStreamFilterContext)
3999  * is deprecated. Use av_bsf_get_by_name(), av_bsf_alloc(), and av_bsf_init()
4000  * from the new bitstream filtering API (using AVBSFContext).
4001  */
4004 /**
4005  * @deprecated the old bitstream filtering API (using AVBitStreamFilterContext)
4006  * is deprecated. Use av_bsf_send_packet() and av_bsf_receive_packet() from the
4007  * new bitstream filtering API (using AVBSFContext).
4008  */
4011  AVCodecContext *avctx, const char *args,
4012  uint8_t **poutbuf, int *poutbuf_size,
4013  const uint8_t *buf, int buf_size, int keyframe);
4014 /**
4015  * @deprecated the old bitstream filtering API (using AVBitStreamFilterContext)
4016  * is deprecated. Use av_bsf_free() from the new bitstream filtering API (using
4017  * AVBSFContext).
4018  */
4021 /**
4022  * @deprecated the old bitstream filtering API (using AVBitStreamFilterContext)
4023  * is deprecated. Use av_bsf_iterate() from the new bitstream filtering API (using
4024  * AVBSFContext).
4025  */
4028 #endif
4029 
4030 #if FF_API_NEXT
4032 const AVBitStreamFilter *av_bsf_next(void **opaque);
4033 #endif
4034 
4035 /* memory */
4036 
4037 /**
4038  * Same behaviour av_fast_malloc but the buffer has additional
4039  * AV_INPUT_BUFFER_PADDING_SIZE at the end which will always be 0.
4040  *
4041  * In addition the whole buffer will initially and after resizes
4042  * be 0-initialized so that no uninitialized data will ever appear.
4043  */
4044 void av_fast_padded_malloc(void *ptr, unsigned int *size, size_t min_size);
4045 
4046 /**
4047  * Same behaviour av_fast_padded_malloc except that buffer will always
4048  * be 0-initialized after call.
4049  */
4050 void av_fast_padded_mallocz(void *ptr, unsigned int *size, size_t min_size);
4051 
4052 /**
4053  * Encode extradata length to a buffer. Used by xiph codecs.
4054  *
4055  * @param s buffer to write to; must be at least (v/255+1) bytes long
4056  * @param v size of extradata in bytes
4057  * @return number of bytes written to the buffer.
4058  */
4059 unsigned int av_xiphlacing(unsigned char *s, unsigned int v);
4060 
4061 #if FF_API_USER_VISIBLE_AVHWACCEL
4062 /**
4063  * Register the hardware accelerator hwaccel.
4064  *
4065  * @deprecated This function doesn't do anything.
4066  */
4068 void av_register_hwaccel(AVHWAccel *hwaccel);
4069 
4070 /**
4071  * If hwaccel is NULL, returns the first registered hardware accelerator,
4072  * if hwaccel is non-NULL, returns the next registered hardware accelerator
4073  * after hwaccel, or NULL if hwaccel is the last one.
4074  *
4075  * @deprecated AVHWaccel structures contain no user-serviceable parts, so
4076  * this function should not be used.
4077  */
4079 AVHWAccel *av_hwaccel_next(const AVHWAccel *hwaccel);
4080 #endif
4081 
4082 #if FF_API_LOCKMGR
4083 /**
4084  * Lock operation used by lockmgr
4085  *
4086  * @deprecated Deprecated together with av_lockmgr_register().
4087  */
4088 enum AVLockOp {
4089  AV_LOCK_CREATE, ///< Create a mutex
4090  AV_LOCK_OBTAIN, ///< Lock the mutex
4091  AV_LOCK_RELEASE, ///< Unlock the mutex
4092  AV_LOCK_DESTROY, ///< Free mutex resources
4093 };
4094 
4095 /**
4096  * Register a user provided lock manager supporting the operations
4097  * specified by AVLockOp. The "mutex" argument to the function points
4098  * to a (void *) where the lockmgr should store/get a pointer to a user
4099  * allocated mutex. It is NULL upon AV_LOCK_CREATE and equal to the
4100  * value left by the last call for all other ops. If the lock manager is
4101  * unable to perform the op then it should leave the mutex in the same
4102  * state as when it was called and return a non-zero value. However,
4103  * when called with AV_LOCK_DESTROY the mutex will always be assumed to
4104  * have been successfully destroyed. If av_lockmgr_register succeeds
4105  * it will return a non-negative value, if it fails it will return a
4106  * negative value and destroy all mutex and unregister all callbacks.
4107  * av_lockmgr_register is not thread-safe, it must be called from a
4108  * single thread before any calls which make use of locking are used.
4109  *
4110  * @param cb User defined callback. av_lockmgr_register invokes calls
4111  * to this callback and the previously registered callback.
4112  * The callback will be used to create more than one mutex
4113  * each of which must be backed by its own underlying locking
4114  * mechanism (i.e. do not use a single static object to
4115  * implement your lock manager). If cb is set to NULL the
4116  * lockmgr will be unregistered.
4117  *
4118  * @deprecated This function does nothing, and always returns 0. Be sure to
4119  * build with thread support to get basic thread safety.
4120  */
4122 int av_lockmgr_register(int (*cb)(void **mutex, enum AVLockOp op));
4123 #endif
4124 
4125 /**
4126  * @return a positive value if s is open (i.e. avcodec_open2() was called on it
4127  * with no corresponding avcodec_close()), 0 otherwise.
4128  */
4130 
4131 /**
4132  * Allocate a CPB properties structure and initialize its fields to default
4133  * values.
4134  *
4135  * @param size if non-NULL, the size of the allocated struct will be written
4136  * here. This is useful for embedding it in side data.
4137  *
4138  * @return the newly allocated struct or NULL on failure
4139  */
4141 
4142 /**
4143  * @}
4144  */
4145 
4146 #endif /* AVCODEC_AVCODEC_H */
int caps_internal
Internal hwaccel capabilities.
Definition: avcodec.h:2563
const struct AVCodec * codec
Definition: avcodec.h:535
AVRational framerate
Definition: avcodec.h:2073
discard all frames except keyframes
Definition: avcodec.h:235
const AVCodecDescriptor * codec_descriptor
AVCodecDescriptor.
Definition: avcodec.h:2094
static enum AVPixelFormat pix_fmt
#define AV_NUM_DATA_POINTERS
Definition: frame.h:301
static AVMutex mutex
Definition: log.c:44
int64_t pts_correction_num_faulty_dts
Number of incorrect PTS values so far.
Definition: avcodec.h:2111
int size
This structure describes decoded (raw) audio or video data.
Definition: frame.h:300
int avcodec_default_execute2(AVCodecContext *c, int(*func)(AVCodecContext *c2, void *arg2, int, int), void *arg, int *ret, int count)
int x
top left corner of pict, undefined when pict is not set
Definition: avcodec.h:2664
int dct_algo
DCT algorithm, see FF_DCT_* below.
Definition: avcodec.h:1720
int apply_cropping
Video decoding only.
Definition: avcodec.h:2318
int coded_width
Bitstream width / height, may be different from width/height e.g.
Definition: avcodec.h:714
int capabilities
Hardware accelerated codec capabilities.
Definition: avcodec.h:2447
attribute_deprecated void av_register_codec_parser(AVCodecParser *parser)
Definition: parsers.c:109
float qblur
amount of qscale smoothing over time (0.0-1.0)
Definition: avcodec.h:1365
Unlock the mutex.
Definition: avcodec.h:4091
int64_t bit_rate
the average bitrate
Definition: avcodec.h:576
static void draw_horiz_band(AVCodecContext *ctx, const AVFrame *fr, int offset[4], int slice_position, int type, int height)
Definition: api-band-test.c:36
attribute_deprecated AVCodec * av_codec_next(const AVCodec *c)
If c is NULL, returns the first registered codec, if c is non-NULL, returns the next registered codec...
Definition: allcodecs.c:867
int64_t next_frame_offset
Definition: avcodec.h:3363
const char * desc
Definition: nvenc.c:79
int id
id
Definition: avcodec.h:425
static av_cold int init(AVCodecContext *avctx)
Definition: avrndec.c:35
static int decode_slice(AVCodecContext *c, void *arg)
Definition: ffv1dec.c:253
int max_bitrate
Maximum bitrate of the stream, in bits per second.
Definition: avcodec.h:454
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:786
int rc_initial_buffer_occupancy
Number of bits which should be loaded into the rc buffer before decoding starts.
Definition: avcodec.h:1436
int height
Definition: avcodec.h:433
int width
Dimensions of the decoded video intended for presentation.
Definition: avcodec.h:3504
int avcodec_receive_packet(AVCodecContext *avctx, AVPacket *avpkt)
Read encoded data from the encoder.
Definition: encode.c:422
attribute_deprecated int frame_skip_cmp
Definition: avcodec.h:1471
const char * avcodec_configuration(void)
Return the libavcodec build-time configuration.
Definition: utils.c:1488
attribute_deprecated int av_bitstream_filter_filter(AVBitStreamFilterContext *bsfc, AVCodecContext *avctx, const char *args, uint8_t **poutbuf, int *poutbuf_size, const uint8_t *buf, int buf_size, int keyframe)
int qscale
Definition: avcodec.h:258
attribute_deprecated const AVBitStreamFilter * av_bsf_next(void **opaque)
attribute_deprecated int av_picture_crop(AVPicture *dst, const AVPicture *src, enum AVPixelFormat pix_fmt, int top_band, int left_band)
Definition: imgconvert.c:107
int nb_colors
number of colors in pict, undefined when pict is not set
Definition: avcodec.h:2668
int mb_lmin
minimum MB Lagrange multiplier
Definition: avcodec.h:1073
const char * avcodec_license(void)
Return the libavcodec license.
Definition: utils.c:1493
int coded_width
Dimensions of the coded video.
Definition: avcodec.h:3510
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:905
attribute_deprecated int avcodec_encode_audio2(AVCodecContext *avctx, AVPacket *avpkt, const AVFrame *frame, int *got_packet_ptr)
Encode a frame of audio.
Definition: encode.c:113
enum AVMediaType codec_type
Definition: rtp.c:37
Convenience header that includes libavutil&#39;s core.
attribute_deprecated int avcodec_decode_audio4(AVCodecContext *avctx, AVFrame *frame, int *got_frame_ptr, const AVPacket *avpkt)
Decode the audio frame of size avpkt->size from avpkt->data into frame.
Definition: decode.c:813
unsigned num_rects
Definition: avcodec.h:2702
void av_fast_padded_malloc(void *ptr, unsigned int *size, size_t min_size)
Same behaviour av_fast_malloc but the buffer has additional AV_INPUT_BUFFER_PADDING_SIZE at the end w...
Definition: utils.c:70
color_range
char * stats_in
pass2 encoding statistics input buffer Concatenated stuff from stats_out of pass1 should be placed he...
Definition: avcodec.h:1557
int ildct_cmp
interlaced DCT comparison function
Definition: avcodec.h:930
discard all non intra frames
Definition: avcodec.h:234
int duration
Duration of the current frame.
Definition: avcodec.h:3479
discard all
Definition: avcodec.h:236
attribute_deprecated void avcodec_get_chroma_sub_sample(enum AVPixelFormat pix_fmt, int *h_shift, int *v_shift)
Definition: imgconvert.c:38
int bits_per_raw_sample
Bits per sample/pixel of internal libavcodec pixel/sample format.
Definition: avcodec.h:1761
attribute_deprecated int av_lockmgr_register(int(*cb)(void **mutex, enum AVLockOp op))
Register a user provided lock manager supporting the operations specified by AVLockOp.
Definition: utils.c:1880
static void error(const char *err)
int avcodec_enum_to_chroma_pos(int *xpos, int *ypos, enum AVChromaLocation pos)
Converts AVChromaLocation to swscale x/y chroma position.
Definition: utils.c:372
int dts_ref_dts_delta
Offset of the current timestamp against last timestamp sync point in units of AVCodecContext.time_base.
Definition: avcodec.h:3441
int avcodec_decode_subtitle2(AVCodecContext *avctx, AVSubtitle *sub, int *got_sub_ptr, AVPacket *avpkt)
Decode a subtitle message.
Definition: decode.c:978
const struct AVHWAccel * hwaccel
Hardware accelerator in use.
Definition: avcodec.h:1694
Picture data structure.
Definition: avcodec.h:2631
int profile
profile
Definition: avcodec.h:1863
AVCodec.
Definition: codec.h:190
int block_align
number of bytes per packet if constant and known or 0 Used by some WAV based audio codecs...
Definition: avcodec.h:1223
attribute_deprecated int av_picture_pad(AVPicture *dst, const AVPicture *src, int height, int width, enum AVPixelFormat pix_fmt, int padtop, int padbottom, int padleft, int padright, int *color)
Definition: imgconvert.c:138
float i_quant_offset
qscale offset between P and I-frames
Definition: avcodec.h:838
attribute_deprecated int av_codec_get_seek_preroll(const AVCodecContext *avctx)
This struct describes the properties of an encoded stream.
Definition: codec_par.h:52
AVLockOp
Lock operation used by lockmgr.
Definition: avcodec.h:4088
attribute_deprecated AVPicture pict
Definition: avcodec.h:2675
AVColorTransferCharacteristic
Color Transfer Characteristic.
Definition: pixfmt.h:480
int min_bitrate
Minimum bitrate of the stream, in bits per second.
Definition: avcodec.h:463
char * text
0 terminated plain UTF-8 text
Definition: avcodec.h:2686
attribute_deprecated int frame_skip_exp
Definition: avcodec.h:1467
attribute_deprecated int avpicture_alloc(AVPicture *picture, enum AVPixelFormat pix_fmt, int width, int height)
Definition: avpicture.c:57
Macro definitions for various function/variable attributes.
AVRational time_base
This is the fundamental unit of time (in seconds) in terms of which frame timestamps are represented...
Definition: avcodec.h:649
int avcodec_get_pix_fmt_loss(enum AVPixelFormat dst_pix_fmt, enum AVPixelFormat src_pix_fmt, int has_alpha)
Definition: imgconvert.c:47
AVSubtitleRect ** rects
Definition: avcodec.h:2703
enum AVAudioServiceType audio_service_type
Type of service that the audio stream conveys.
Definition: avcodec.h:1251
int avcodec_fill_audio_frame(AVFrame *frame, int nb_channels, enum AVSampleFormat sample_fmt, const uint8_t *buf, int buf_size, int align)
Fill AVFrame audio data and linesize pointers.
Definition: utils.c:395
enum AVDiscard skip_frame
Skip decoding for selected frames.
Definition: avcodec.h:2008
static HEVCFrame * alloc_frame(HEVCContext *s)
Definition: hevc_refs.c:82
const AVClass * avcodec_get_class(void)
Get the AVClass for AVCodecContext.
Definition: options.c:295
uint64_t vbv_delay
The delay between the time the packet this structure is associated with is received and the time when...
Definition: avcodec.h:490
void avcodec_align_dimensions(AVCodecContext *s, int *width, int *height)
Modify width and height values so that they will result in a memory buffer that is acceptable for the...
Definition: utils.c:357
int w
width of pict, undefined when pict is not set
Definition: avcodec.h:2666
attribute_deprecated int mv_bits
Definition: avcodec.h:1523
float p_masking
p block masking (0-> disabled)
Definition: avcodec.h:866
AVCodecParserContext * parser
Definition: avcodec.h:3982
attribute_deprecated const AVBitStreamFilter * av_bitstream_filter_next(const AVBitStreamFilter *f)
Public dictionary API.
static double cb(void *priv, double x, double y)
Definition: vf_geq.c:215
attribute_deprecated int side_data_only_packets
Encoding only and set by default.
Definition: avcodec.h:2046
int bit_rate_tolerance
number of bits the bitstream is allowed to diverge from the reference.
Definition: avcodec.h:584
int mb_lmax
maximum MB Lagrange multiplier
Definition: avcodec.h:1080
int export_side_data
Bit set of AV_CODEC_EXPORT_DATA_* flags, which affects the kind of metadata exported in frame...
Definition: avcodec.h:2358
enum AVPixelFormat avcodec_default_get_format(struct AVCodecContext *s, const enum AVPixelFormat *fmt)
Definition: decode.c:1067
enum AVSampleFormat sample_fmt
audio sample format
Definition: avcodec.h:1194
Lock the mutex.
Definition: avcodec.h:4090
uint8_t
void * hwaccel_context
Hardware accelerator context.
Definition: avcodec.h:1706
int av_parser_change(AVCodecParserContext *s, AVCodecContext *avctx, uint8_t **poutbuf, int *poutbuf_size, const uint8_t *buf, int buf_size, int keyframe)
Definition: parser.c:189
static av_cold int uninit(AVCodecContext *avctx)
Definition: crystalhd.c:279
int subtitle_header_size
Definition: avcodec.h:2019
int me_range
maximum motion estimation search range in subpel units If 0 then no limit.
Definition: avcodec.h:997
attribute_deprecated int i_count
Definition: avcodec.h:1531
AVColorSpace
YUV colorspace type.
Definition: pixfmt.h:509
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, or 0 if no associated fourCC code can be found.
Definition: raw.c:304
#define f(width, name)
Definition: cbs_vp9.c:255
uint16_t * chroma_intra_matrix
custom intra quantization matrix
Definition: avcodec.h:2172
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:795
int trailing_padding
Audio only.
Definition: avcodec.h:2252
int pre_dia_size
ME prepass diamond size & shape.
Definition: avcodec.h:981
uint8_t * extradata
some codecs need / can use extradata like Huffman tables.
Definition: avcodec.h:627
const AVClass * av_class
information on struct for av_log
Definition: avcodec.h:531
int me_cmp
motion estimation comparison function
Definition: avcodec.h:912
int avcodec_parameters_to_context(AVCodecContext *codec, const AVCodecParameters *par)
Fill the codec context based on the values from the supplied codec parameters.
Definition: utils.c:2193
static AVFrame * frame
struct AVCodecParser * next
Definition: avcodec.h:3536
const char data[16]
Definition: mxf.c:91
#define height
int64_t wallclock
A UTC timestamp, in microseconds, since Unix epoch (e.g, av_gettime()).
Definition: avcodec.h:502
attribute_deprecated int context_model
Definition: avcodec.h:1453
attribute_deprecated void avcodec_register(AVCodec *codec)
Register the codec codec and initialize libavcodec.
Definition: allcodecs.c:862
int lowres
low resolution decoding, 1-> 1/2 size, 2->1/4 size
Definition: avcodec.h:1769
attribute_deprecated int av_codec_get_max_lowres(const AVCodec *codec)
Definition: utils.c:509
AVColorRange
MPEG vs JPEG YUV range.
Definition: pixfmt.h:532
const AVClass * avcodec_get_frame_class(void)
Get the AVClass for AVFrame.
Definition: options.c:322
int buffer_size
The size of the buffer to which the ratecontrol is applied, in bits.
Definition: avcodec.h:481
int h
height of pict, undefined when pict is not set
Definition: avcodec.h:2667
int bits_per_coded_sample
bits per sample/pixel from the demuxer (needed for huffyuv).
Definition: avcodec.h:1754
float lumi_masking
luminance masking (0-> disabled)
Definition: avcodec.h:845
char * stats_out
pass1 encoding statistics output buffer
Definition: avcodec.h:1549
AVColorPrimaries
Chromaticity coordinates of the source primaries.
Definition: pixfmt.h:455
AVCPBProperties * av_cpb_properties_alloc(size_t *size)
Allocate a CPB properties structure and initialize its fields to default values.
Definition: utils.c:2032
struct AVBitStreamFilterContext * next
Definition: avcodec.h:3983
enum AVChromaLocation chroma_sample_location
This defines the location of chroma samples.
Definition: avcodec.h:1168
attribute_deprecated int frame_skip_threshold
Definition: avcodec.h:1459
attribute_deprecated void av_codec_set_seek_preroll(AVCodecContext *avctx, int val)
float quality_factor
Definition: avcodec.h:259
attribute_deprecated void avcodec_register_all(void)
Register all the codecs, parsers and bitstream filters which were enabled at configuration time...
Definition: allcodecs.c:877
void avcodec_align_dimensions2(AVCodecContext *s, int *width, int *height, int linesize_align[AV_NUM_DATA_POINTERS])
Modify width and height values so that they will result in a memory buffer that is acceptable for the...
Definition: utils.c:154
attribute_deprecated int avpicture_fill(AVPicture *picture, const uint8_t *ptr, enum AVPixelFormat pix_fmt, int width, int height)
Definition: avpicture.c:37
attribute_deprecated int skip_count
Definition: avcodec.h:1535
attribute_deprecated void av_register_hwaccel(AVHWAccel *hwaccel)
Register the hardware accelerator hwaccel.
Definition: utils.c:1874
int slice_count
slice count
Definition: avcodec.h:880
Libavcodec version macros.
#define src
Definition: vp8dsp.c:254
int avcodec_close(AVCodecContext *avctx)
Close a given AVCodecContext and free all the data associated with it (but not the AVCodecContext its...
Definition: utils.c:1152
AVRational pkt_timebase
Timebase in which pkt_dts/pts and AVPacket.dts/pts are.
Definition: avcodec.h:2087
AVCodecID
Identify the syntax and semantics of the bitstream.
Definition: codec_id.h:46
attribute_deprecated unsigned av_codec_get_codec_properties(const AVCodecContext *avctx)
Definition: utils.c:504
static int get_format(AVCodecContext *avctx, const enum AVPixelFormat *pix_fmts)
Definition: qsvdec.c:51
int av_get_bits_per_sample(enum AVCodecID codec_id)
Return codec bits per sample.
Definition: utils.c:1583
int has_b_frames
Size of the frame reordering buffer in the decoder.
Definition: avcodec.h:816
int64_t pos
Byte position of currently parsed frame in stream.
Definition: avcodec.h:3467
Create a mutex.
Definition: avcodec.h:4089
int priv_data_size
Definition: avcodec.h:3526
struct AVCodecParser * parser
Definition: avcodec.h:3359
AVAudioServiceType
Definition: avcodec.h:239
int y
top left corner of pict, undefined when pict is not set
Definition: avcodec.h:2665
discard all bidirectional frames
Definition: avcodec.h:233
int me_sub_cmp
subpixel motion estimation comparison function
Definition: avcodec.h:918
attribute_deprecated uint64_t vbv_delay
VBV delay coded in the last frame (in periods of a 27 MHz clock).
Definition: avcodec.h:2031
int qmax
maximum quantizer
Definition: avcodec.h:1379
enum AVSampleFormat request_sample_fmt
desired sample format
Definition: avcodec.h:1259
int skip_alpha
Skip processing alpha if supported by codec.
Definition: avcodec.h:2146
int64_t pts_correction_last_pts
Number of incorrect DTS values so far.
Definition: avcodec.h:2112
int active_thread_type
Which multithreading methods are in use by the codec.
Definition: avcodec.h:1808
int avcodec_is_open(AVCodecContext *s)
Definition: utils.c:1971
int error_concealment
error concealment flags
Definition: avcodec.h:1605
int avcodec_receive_frame(AVCodecContext *avctx, AVFrame *frame)
Return decoded output data from a decoder.
Definition: decode.c:649
unsigned int pos
Definition: spdifenc.c:412
int initial_padding
Audio only.
Definition: avcodec.h:2064
attribute_deprecated AVCodecParser * av_parser_next(const AVCodecParser *c)
Definition: parsers.c:88
attribute_deprecated AVBitStreamFilterContext * av_bitstream_filter_init(const char *name)
const char * arg
Definition: jacosubdec.c:66
int flags
AV_CODEC_FLAG_*.
Definition: avcodec.h:606
enum AVPixelFormat avcodec_find_best_pix_fmt_of_list(const enum AVPixelFormat *pix_fmt_list, enum AVPixelFormat src_pix_fmt, int has_alpha, int *loss_ptr)
Find the best pixel format to convert to given a certain source pixel format.
Definition: imgconvert.c:66
int log_level_offset
Definition: avcodec.h:532
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:831
int width
width and height in 1/16 pel
Definition: avcodec.h:432
int64_t max_pixels
The number of pixels per image to maximally accept.
Definition: avcodec.h:2260
static const uint8_t offset[127][2]
Definition: vf_spp.c:93
int av_get_audio_frame_duration2(AVCodecParameters *par, int frame_bytes)
This function is the same as av_get_audio_frame_duration(), except it works with AVCodecParameters in...
Definition: utils.c:1818
attribute_deprecated int64_t timecode_frame_start
Definition: avcodec.h:1492
attribute_deprecated int b_sensitivity
Definition: avcodec.h:1132
int priv_data_size
Size of the private data to allocate in AVCodecInternal.hwaccel_priv_data.
Definition: avcodec.h:2558
reference-counted frame API
uint64_t channel_layout
Audio channel layout.
Definition: avcodec.h:1237
static char * split(char *message, char delim)
Definition: af_channelmap.c:81
uint32_t end_display_time
Definition: avcodec.h:2701
int64_t pts
Same as packet pts, in AV_TIME_BASE.
Definition: avcodec.h:2704
int rc_buffer_size
decoder bitstream buffer size
Definition: avcodec.h:1393
int intra_dc_precision
precision of the intra DC coefficient - 8
Definition: avcodec.h:1052
int64_t rc_min_rate
minimum bitrate
Definition: avcodec.h:1415
Not part of ABI.
Definition: avcodec.h:249
int refs
number of reference frames
Definition: avcodec.h:1114
A bitmap, pict will be set.
Definition: avcodec.h:2646
const char * name
Definition: qsvenc.c:46
int rc_override_count
ratecontrol override, see RcOverride
Definition: avcodec.h:1400
audio channel layout utility functions
int err_recognition
Error recognition; may misdetect some more or less valid parts as errors.
Definition: avcodec.h:1659
const char * name
Name of the hardware accelerated codec.
Definition: avcodec.h:2420
AVPacketSideData * coded_side_data
Additional data associated with the entire coded stream.
Definition: avcodec.h:2205
attribute_deprecated int avpicture_layout(const AVPicture *src, enum AVPixelFormat pix_fmt, int width, int height, unsigned char *dest, int dest_size)
Definition: avpicture.c:44
int av_get_exact_bits_per_sample(enum AVCodecID codec_id)
Return codec bits per sample.
Definition: utils.c:1499
attribute_deprecated int avcodec_copy_context(AVCodecContext *dest, const AVCodecContext *src)
Copy the settings of the source AVCodecContext into the destination AVCodecContext.
Definition: options.c:216
AVCodecContext * avcodec_alloc_context3(const AVCodec *codec)
Allocate an AVCodecContext and set its fields to default values.
Definition: options.c:157
int av_parser_parse2(AVCodecParserContext *s, AVCodecContext *avctx, uint8_t **poutbuf, int *poutbuf_size, const uint8_t *buf, int buf_size, int64_t pts, int64_t dts, int64_t pos)
Parse a packet.
Definition: parser.c:120
#define width
int width
picture width / height.
Definition: avcodec.h:699
int idct_algo
IDCT algorithm, see FF_IDCT_* below.
Definition: avcodec.h:1733
AVBufferRef * hw_frames_ctx
A reference to the AVHWFramesContext describing the input (for encoding) or output (decoding) frames...
Definition: avcodec.h:2230
int64_t offset
byte offset from starting packet start
Definition: avcodec.h:3397
attribute_deprecated void av_bitstream_filter_close(AVBitStreamFilterContext *bsf)
attribute_deprecated int noise_reduction
Definition: avcodec.h:1044
float rc_max_available_vbv_use
Ratecontrol attempt to use, at maximum, of what can be used without an underflow. ...
Definition: avcodec.h:1422
float rc_min_vbv_overflow_use
Ratecontrol attempt to use, at least, times the amount needed to prevent a vbv overflow.
Definition: avcodec.h:1429
static int decode_mb(ASV1Context *a, int16_t block[6][64])
Definition: asvdec.c:164
static const struct ColorPrimaries color_primaries[AVCOL_PRI_NB]
void av_parser_close(AVCodecParserContext *s)
Definition: parser.c:224
attribute_deprecated int avpicture_get_size(enum AVPixelFormat pix_fmt, int width, int height)
Definition: avpicture.c:52
int start_frame
Definition: avcodec.h:256
attribute_deprecated int frame_skip_factor
Definition: avcodec.h:1463
uint16_t format
Definition: avcodec.h:2699
const AVClass * avcodec_get_subtitle_rect_class(void)
Get the AVClass for AVSubtitleRect.
Definition: options.c:347
#define s(width, name)
Definition: cbs_vp9.c:257
int level
level
Definition: avcodec.h:1986
int64_t reordered_opaque
opaque 64-bit number (generally a PTS) that will be reordered and output in AVFrame.reordered_opaque
Definition: avcodec.h:1687
int ticks_per_frame
For some codecs, the time base is closer to the field rate than the frame rate.
Definition: avcodec.h:658
int skip_top
Number of macroblock rows at the top which are skipped.
Definition: avcodec.h:1059
enum AVCodecID codec_id
Definition: vaapi_decode.c:369
int mb_decision
macroblock decision mode
Definition: avcodec.h:1014
int last_predictor_count
amount of previous MV predictors (2a+1 x 2a+1 square)
Definition: avcodec.h:961
int max_qdiff
maximum quantizer difference between frames
Definition: avcodec.h:1386
char * sub_charenc
DTS of the last frame.
Definition: avcodec.h:2120
attribute_deprecated int coder_type
Definition: avcodec.h:1447
RcOverride * rc_override
Definition: avcodec.h:1401
int64_t last_pos
Previous frame byte position.
Definition: avcodec.h:3472
attribute_deprecated const AVCodecDescriptor * av_codec_get_codec_descriptor(const AVCodecContext *avctx)
int thread_count
thread count is used to decide how many independent tasks should be passed to execute() ...
Definition: avcodec.h:1789
int sub_charenc_mode
Subtitles character encoding mode.
Definition: avcodec.h:2128
attribute_deprecated int max_prediction_order
Definition: avcodec.h:1488
void avcodec_flush_buffers(AVCodecContext *avctx)
Reset the internal codec state / flush internal buffers.
Definition: utils.c:1089
attribute_deprecated int i_tex_bits
Definition: avcodec.h:1527
enum AVPixelFormat avcodec_find_best_pix_fmt_of_2(enum AVPixelFormat dst_pix_fmt1, enum AVPixelFormat dst_pix_fmt2, enum AVPixelFormat src_pix_fmt, int has_alpha, int *loss_ptr)
Definition: imgconvert.c:54
attribute_deprecated enum AVPixelFormat avcodec_find_best_pix_fmt2(enum AVPixelFormat dst_pix_fmt1, enum AVPixelFormat dst_pix_fmt2, enum AVPixelFormat src_pix_fmt, int has_alpha, int *loss_ptr)
Definition: imgconvert.c:60
int avcodec_send_packet(AVCodecContext *avctx, const AVPacket *avpkt)
Supply raw packet data as input to a decoder.
Definition: decode.c:586
const char * av_get_profile_name(const AVCodec *codec, int profile)
Return a name for the specified profile, if available.
Definition: utils.c:1450
int frame_size
Number of samples per channel in an audio frame.
Definition: avcodec.h:1206
int pts_dts_delta
Presentation delay of current frame in units of AVCodecContext.time_base.
Definition: avcodec.h:3455
attribute_deprecated int misc_bits
Definition: avcodec.h:1537
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:1849
This structure describes the bitrate properties of an encoded bitstream.
Definition: avcodec.h:448
int bidir_refine
Definition: avcodec.h:1094
attribute_deprecated AVHWAccel * av_hwaccel_next(const AVHWAccel *hwaccel)
If hwaccel is NULL, returns the first registered hardware accelerator, if hwaccel is non-NULL...
Definition: utils.c:1869
AVCodecParserContext * av_parser_init(int codec_id)
Definition: parser.c:34
int avcodec_default_get_buffer2(AVCodecContext *s, AVFrame *frame, int flags)
The default callback for AVCodecContext.get_buffer2().
Definition: decode.c:1649
int discard_damaged_percentage
The percentage of damaged samples to discard a frame.
Definition: avcodec.h:2340
attribute_deprecated int mpeg_quant
Definition: avcodec.h:821
attribute_deprecated int avcodec_decode_video2(AVCodecContext *avctx, AVFrame *picture, int *got_picture_ptr, const AVPacket *avpkt)
Decode the video frame of size avpkt->size from avpkt->data into picture.
Definition: decode.c:806
AVSampleFormat
Audio sample formats.
Definition: samplefmt.h:58
attribute_deprecated int scenechange_threshold
Definition: avcodec.h:1040
void avcodec_free_context(AVCodecContext **avctx)
Free the codec context and everything associated with it and write NULL to the provided pointer...
Definition: options.c:172
typedef void(RENAME(mix_any_func_type))
enum AVCodecID av_get_pcm_codec(enum AVSampleFormat fmt, int be)
Return the PCM codec associated with a sample format.
Definition: utils.c:1561
int compression_level
Definition: avcodec.h:598
int seek_preroll
Number of samples to skip after a discontinuity.
Definition: avcodec.h:2153
attribute_deprecated int prediction_method
Definition: avcodec.h:885
int sample_rate
samples per second
Definition: avcodec.h:1186
enum AVDiscard skip_idct
Skip IDCT/dequantization for selected frames.
Definition: avcodec.h:2001
attribute_deprecated int b_frame_strategy
Definition: avcodec.h:800
const AVCodecParser * av_parser_iterate(void **opaque)
Iterate over all registered codec parsers.
Definition: parsers.c:98
attribute_deprecated uint16_t * av_codec_get_chroma_intra_matrix(const AVCodecContext *avctx)
Plain text, the text field must be set by the decoder and is authoritative.
Definition: avcodec.h:2652
int debug
debug
Definition: avcodec.h:1615
main external API structure.
Definition: avcodec.h:526
attribute_deprecated void av_codec_set_pkt_timebase(AVCodecContext *avctx, AVRational val)
long long int64_t
Definition: coverity.c:34
int qmin
minimum quantizer
Definition: avcodec.h:1372
void avsubtitle_free(AVSubtitle *sub)
Free all allocated data in the given subtitle struct.
Definition: utils.c:1133
unsigned int codec_tag
fourcc (LSB first, so "ABCD" -> (&#39;D&#39;<<24) + (&#39;C&#39;<<16) + (&#39;B&#39;<<8) + &#39;A&#39;).
Definition: avcodec.h:551
static void encode(AVCodecContext *ctx, AVFrame *frame, AVPacket *pkt, FILE *output)
Definition: encode_audio.c:95
int avcodec_send_frame(AVCodecContext *avctx, const AVFrame *frame)
Supply a raw video or audio frame to the encoder.
Definition: encode.c:392
float spatial_cplx_masking
spatial complexity masking (0-> disabled)
Definition: avcodec.h:859
attribute_deprecated int header_bits
Definition: avcodec.h:1525
int64_t max_samples
The number of samples per frame to maximally accept.
Definition: avcodec.h:2348
int extradata_size
Definition: avcodec.h:628
unsigned int av_xiphlacing(unsigned char *s, unsigned int v)
Encode extradata length to a buffer.
Definition: utils.c:1836
uint16_t * intra_matrix
custom intra quantization matrix Must be allocated with the av_malloc() family of functions...
Definition: avcodec.h:1026
int nb_coded_side_data
Definition: avcodec.h:2206
int slice_flags
slice flags
Definition: avcodec.h:1004
int(* func)(AVBPrint *dst, const char *in, const char *arg)
Definition: jacosubdec.c:67
Describe the class of an AVClass context structure.
Definition: log.h:67
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:1345
enum AVColorSpace colorspace
YUV colorspace type.
Definition: avcodec.h:1154
Rational number (pair of numerator and denominator).
Definition: rational.h:58
attribute_deprecated int avcodec_encode_video2(AVCodecContext *avctx, AVPacket *avpkt, const AVFrame *frame, int *got_packet_ptr)
Encode a frame of video.
Definition: encode.c:259
enum AVColorTransferCharacteristic color_trc
Color Transfer Characteristic.
Definition: avcodec.h:1147
int avcodec_parameters_from_context(AVCodecParameters *par, const AVCodecContext *codec)
Fill the parameters struct based on the values from the supplied codec context.
Definition: utils.c:2136
attribute_deprecated void av_codec_set_codec_descriptor(AVCodecContext *avctx, const AVCodecDescriptor *desc)
int sub_text_format
Control the form of AVSubtitle.rects[N]->ass.
Definition: avcodec.h:2237
cl_device_type type
AVMediaType
Definition: avutil.h:199
attribute_deprecated AVRational av_codec_get_pkt_timebase(const AVCodecContext *avctx)
Accessors for some AVCodecContext fields.
discard useless packets like 0 size packets in avi
Definition: avcodec.h:231
refcounted data buffer API
attribute_deprecated int av_codec_get_lowres(const AVCodecContext *avctx)
attribute_deprecated int brd_scale
Definition: avcodec.h:1099
char * codec_whitelist
&#39;,&#39; separated list of allowed decoders.
Definition: avcodec.h:2188
int avcodec_open2(AVCodecContext *avctx, const AVCodec *codec, AVDictionary **options)
Initialize the AVCodecContext to use the given AVCodec.
Definition: utils.c:574
attribute_deprecated int chromaoffset
Definition: avcodec.h:1119
float b_quant_offset
qscale offset between IP and B-frames
Definition: avcodec.h:808
#define AV_PARSER_PTS_NB
Definition: avcodec.h:3384
int av_get_audio_frame_duration(AVCodecContext *avctx, int frame_bytes)
Return audio frame duration.
Definition: utils.c:1808
float qcompress
amount of qscale change between easy & hard scenes (0.0-1.0)
Definition: avcodec.h:1364
attribute_deprecated int refcounted_frames
If non-zero, the decoded audio and video frames returned from avcodec_decode_video2() and avcodec_dec...
Definition: avcodec.h:1361
attribute_deprecated int p_tex_bits
Definition: avcodec.h:1529
uint16_t * inter_matrix
custom inter quantization matrix Must be allocated with the av_malloc() family of functions...
Definition: avcodec.h:1035
int end_frame
Definition: avcodec.h:257
mfxU16 profile
Definition: qsvenc.c:45
attribute_deprecated int64_t convergence_duration
Definition: avcodec.h:3413
This struct describes the properties of a single codec described by an AVCodecID. ...
Definition: codec_desc.h:38
float dark_masking
darkness masking (0-> disabled)
Definition: avcodec.h:873
int global_quality
Global quality for codecs which cannot change it per frame.
Definition: avcodec.h:592
static int64_t pts
int skip_bottom
Number of macroblock rows at the bottom which are skipped.
Definition: avcodec.h:1066
#define flags(name, subs,...)
Definition: cbs_av1.c:576
int output_picture_number
Picture number incremented in presentation or output order.
Definition: avcodec.h:3499
float temporal_cplx_masking
temporary complexity masking (0-> disabled)
Definition: avcodec.h:852
Pan Scan area.
Definition: avcodec.h:419
AVFieldOrder
Definition: codec_par.h:36
MpegEncContext.
Definition: mpegvideo.h:81
struct AVCodecContext * avctx
Definition: mpegvideo.h:98
int gop_size
the number of pictures in a group of pictures, or 0 for intra_only
Definition: avcodec.h:721
A reference to a data buffer.
Definition: buffer.h:81
discard all non reference
Definition: avcodec.h:232
static int op(uint8_t **dst, const uint8_t *dst_end, GetByteContext *gb, int pixel, int count, int *x, int width, int linesize)
Perform decode operation.
Definition: anm.c:75
int extra_hw_frames
Definition: avcodec.h:2332
int
int mb_cmp
macroblock comparison function (not supported yet)
Definition: avcodec.h:924
int avcodec_get_hw_frames_parameters(AVCodecContext *avctx, AVBufferRef *device_ref, enum AVPixelFormat hw_pix_fmt, AVBufferRef **out_frames_ref)
Create and return a AVHWFramesContext with values adequate for hardware decoding. ...
Definition: decode.c:1181
static enum AVPixelFormat hw_pix_fmt
Definition: hw_decode.c:46
const OptionDef options[]
Definition: ffmpeg_opt.c:3388
enum AVChromaLocation avcodec_chroma_pos_to_enum(int xpos, int ypos)
Converts swscale x/y chroma position to AVChromaLocation.
Definition: utils.c:384
Free mutex resources.
Definition: avcodec.h:4092
Utilties for rational number calculation.
attribute_deprecated void avpicture_free(AVPicture *picture)
Definition: avpicture.c:70
attribute_deprecated int rtp_payload_size
Definition: avcodec.h:1512
int nsse_weight
noise vs.
Definition: avcodec.h:1856
static double c[64]
static enum AVCodecID codec_ids[]
uint32_t start_display_time
Definition: avcodec.h:2700
void av_fast_padded_mallocz(void *ptr, unsigned int *size, size_t min_size)
Same behaviour av_fast_padded_malloc except that buffer will always be 0-initialized after call...
Definition: utils.c:82
attribute_deprecated AVFrame * coded_frame
the picture in the bitstream
Definition: avcodec.h:1780
int workaround_bugs
Work around bugs in encoders which sometimes cannot be detected automatically.
Definition: avcodec.h:1564
static const uint64_t c2
Definition: murmur3.c:50
unsigned properties
Properties of the stream that gets decoded.
Definition: avcodec.h:2195
enum AVDiscard skip_loop_filter
Skip loop filtering for selected frames.
Definition: avcodec.h:1994
int thread_safe_callbacks
Set by the client if its custom get_buffer() callback can be called synchronously from another thread...
Definition: avcodec.h:1818
int avcodec_get_context_defaults3(AVCodecContext *s, const AVCodec *codec)
Definition: options.c:151
AVPictureStructure
Definition: avcodec.h:3350
attribute_deprecated void av_picture_copy(AVPicture *dst, const AVPicture *src, enum AVPixelFormat pix_fmt, int width, int height)
Definition: avpicture.c:75
int trellis
trellis RD quantization
Definition: avcodec.h:1479
void avcodec_string(char *buf, int buf_size, AVCodecContext *enc, int encode)
Definition: utils.c:1255
static int lowres
Definition: ffplay.c:336
int slices
Number of slices.
Definition: avcodec.h:1177
void * priv_data
Definition: avcodec.h:553
int cutoff
Audio cutoff bandwidth (0 means "automatic")
Definition: avcodec.h:1230
This structure supplies correlation between a packet timestamp and a wall clock production time...
Definition: avcodec.h:498
attribute_deprecated size_t av_get_codec_tag_string(char *buf, size_t buf_size, unsigned int codec_tag)
Put a string representing the codec tag codec_tag in buf.
Definition: utils.c:1235
Formatted text, the ass field must be set by the decoder and is authoritative.
Definition: avcodec.h:2658
int64_t frame_offset
Definition: avcodec.h:3360
pixel format definitions
int dia_size
ME diamond size & shape.
Definition: avcodec.h:954
uint8_t * dump_separator
dump format separator.
Definition: avcodec.h:2180
attribute_deprecated int frame_bits
Definition: avcodec.h:1541
attribute_deprecated int me_penalty_compensation
Definition: avcodec.h:1087
attribute_deprecated int min_prediction_order
Definition: avcodec.h:1484
int avg_bitrate
Average bitrate of the stream, in bits per second.
Definition: avcodec.h:472
char * args
Internal default arguments, used if NULL is passed to av_bitstream_filter_filter().
Definition: avcodec.h:3988
int channels
number of audio channels
Definition: avcodec.h:1187
int frame_priv_data_size
Size of per-frame hardware accelerator private data.
Definition: avcodec.h:2524
int format
The format of the coded data, corresponds to enum AVPixelFormat for video and for enum AVSampleFormat...
Definition: avcodec.h:3521
unsigned avcodec_version(void)
Return the LIBAVCODEC_VERSION_INT constant.
Definition: utils.c:1478
char * ass
0 terminated ASS/SSA compatible event line.
Definition: avcodec.h:2693
attribute_deprecated int p_count
Definition: avcodec.h:1533
attribute_deprecated void(* rtp_callback)(struct AVCodecContext *avctx, void *data, int size, int mb_nb)
Definition: avcodec.h:1506
int mv0_threshold
Note: Value depends upon the compare function used for fullpel ME.
Definition: avcodec.h:1127
int flags2
AV_CODEC_FLAG2_*.
Definition: avcodec.h:613
AVDiscard
Definition: avcodec.h:227
attribute_deprecated void av_register_bitstream_filter(AVBitStreamFilter *bsf)
attribute_deprecated void av_codec_set_chroma_intra_matrix(AVCodecContext *avctx, uint16_t *val)
const struct AVBitStreamFilter * filter
Definition: avcodec.h:3981
int64_t pts_correction_last_dts
PTS of the last frame.
Definition: avcodec.h:2113
int * slice_offset
slice offsets in the frame in bytes
Definition: avcodec.h:896
int frame_number
Frame counter, set by libavcodec.
Definition: avcodec.h:1217
int repeat_pict
This field is used for proper frame duration computation in lavf.
Definition: avcodec.h:3375
int64_t pts_correction_num_faulty_pts
Current statistics for PTS correction.
Definition: avcodec.h:2110
enum AVFieldOrder field_order
Field order.
Definition: avcodec.h:1183
AVChromaLocation
Location of chroma samples.
Definition: pixfmt.h:554
int hwaccel_flags
Bit set of AV_HWACCEL_FLAG_* flags, which affect hardware accelerated decoding (if active)...
Definition: avcodec.h:2291
int nb_channels
int debug_mv
debug motion vectors
Definition: avcodec.h:2161
AVBufferRef * hw_device_ctx
A reference to the AVHWDeviceContext describing the device which will be used by a hardware encoder/d...
Definition: avcodec.h:2282
uint64_t request_channel_layout
Request decoder to use this channel layout if it can (0 for default)
Definition: avcodec.h:1244
int me_pre_cmp
motion estimation prepass comparison function
Definition: avcodec.h:974
enum AVCodecID id
AVPixelFormat
Pixel format.
Definition: pixfmt.h:64
static double val(void *priv, double ch)
Definition: aeval.c:76
This structure stores compressed data.
Definition: packet.h:332
const char * avcodec_profile_name(enum AVCodecID codec_id, int profile)
Return a name for the specified profile, if available.
Definition: utils.c:1463
int avcodec_encode_subtitle(AVCodecContext *avctx, uint8_t *buf, int buf_size, const AVSubtitle *sub)
Definition: encode.c:347
int key_frame
Set by parser to 1 for key frames and 0 for non-key frames.
Definition: avcodec.h:3406
int delay
Codec delay.
Definition: avcodec.h:682
int me_subpel_quality
subpel ME quality
Definition: avcodec.h:988
int strict_std_compliance
strictly follow the standard (MPEG-4, ...).
Definition: avcodec.h:1593
int dts_sync_point
Synchronization point for start of timestamp generation.
Definition: avcodec.h:3426
enum AVPixelFormat sw_pix_fmt
Nominal unaccelerated pixel format, see AV_PIX_FMT_xxx.
Definition: avcodec.h:2080
void * opaque
Private data of the user, can be used to carry app specific stuff.
Definition: avcodec.h:568
int thread_type
Which multithreading methods to use.
Definition: avcodec.h:1799
AVSubtitleType
Definition: avcodec.h:2643
int avcodec_default_execute(AVCodecContext *c, int(*func)(AVCodecContext *c2, void *arg2), void *arg, int *ret, int count, int size)
Definition: utils.c:460
discard nothing
Definition: avcodec.h:230
attribute_deprecated void av_codec_set_lowres(AVCodecContext *avctx, int val)
int64_t rc_max_rate
maximum bitrate
Definition: avcodec.h:1408
attribute_deprecated int pre_me
Definition: avcodec.h:966
uint8_t * subtitle_header
Header containing style information for text subtitles.
Definition: avcodec.h:2018
int keyint_min
minimum GOP size
Definition: avcodec.h:1107