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