2 * copyright (c) 2001 Fabrice Bellard
4 * This file is part of FFmpeg.
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.
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.
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
21 #ifndef AVCODEC_AVCODEC_H
22 #define AVCODEC_AVCODEC_H
27 * Libavcodec external API header
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"
36 #include "libavutil/channel_layout.h"
37 #include "libavutil/dict.h"
38 #include "libavutil/frame.h"
39 #include "libavutil/log.h"
40 #include "libavutil/pixfmt.h"
41 #include "libavutil/rational.h"
46 * @defgroup libavc Encoding/Decoding Library
49 * @defgroup lavc_decoding Decoding
53 * @defgroup lavc_encoding Encoding
57 * @defgroup lavc_codec Codecs
59 * @defgroup lavc_codec_native Native Codecs
62 * @defgroup lavc_codec_wrappers External library wrappers
65 * @defgroup lavc_codec_hwaccel Hardware Accelerators bridge
69 * @defgroup lavc_internal Internal
77 * @defgroup lavc_core Core functions/structures.
80 * Basic definitions, functions for querying libavcodec capabilities,
81 * allocating core structures, etc.
87 * Identify the syntax and semantics of the bitstream.
88 * The principle is roughly:
89 * Two decoders with the same ID can decode the same streams.
90 * Two encoders with the same ID can encode compatible streams.
91 * There may be slight deviations from the principle due to implementation
94 * If you add a codec ID to this list, add it so that
95 * 1. no value of a existing codec ID changes (that would break ABI),
96 * 2. Give it a value which when taken as ASCII is recognized uniquely by a human as this specific codec.
97 * This ensures that 2 forks can independently add AVCodecIDs without producing conflicts.
99 * After adding new codec IDs, do not forget to add an entry to the codec
100 * descriptor list and bump libavcodec minor version.
106 AV_CODEC_ID_MPEG1VIDEO,
107 AV_CODEC_ID_MPEG2VIDEO, ///< preferred ID for MPEG-1/2 video decoding
109 AV_CODEC_ID_MPEG2VIDEO_XVMC,
110 #endif /* FF_API_XVMC */
121 AV_CODEC_ID_RAWVIDEO,
122 AV_CODEC_ID_MSMPEG4V1,
123 AV_CODEC_ID_MSMPEG4V2,
124 AV_CODEC_ID_MSMPEG4V3,
147 AV_CODEC_ID_INTERPLAY_VIDEO,
154 AV_CODEC_ID_MSVIDEO1,
159 AV_CODEC_ID_TRUEMOTION1,
160 AV_CODEC_ID_VMDVIDEO,
185 AV_CODEC_ID_TRUEMOTION2,
191 AV_CODEC_ID_SMACKVIDEO,
196 AV_CODEC_ID_JPEG2000,
202 AV_CODEC_ID_DSICINVIDEO,
203 AV_CODEC_ID_TIERTEXSEQVIDEO,
211 AV_CODEC_ID_BETHSOFTVID,
223 AV_CODEC_ID_ESCAPE124,
227 AV_CODEC_ID_MOTIONPIXELS,
239 AV_CODEC_ID_FLASHSV2,
240 AV_CODEC_ID_CDGRAPHICS,
243 AV_CODEC_ID_BINKVIDEO,
244 AV_CODEC_ID_IFF_ILBM,
245 AV_CODEC_ID_IFF_BYTERUN1,
251 AV_CODEC_ID_A64_MULTI,
252 AV_CODEC_ID_A64_MULTI5,
255 AV_CODEC_ID_LAGARITH,
259 AV_CODEC_ID_WMV3IMAGE,
260 AV_CODEC_ID_VC1IMAGE,
262 AV_CODEC_ID_BMV_VIDEO,
269 AV_CODEC_ID_ZEROCODEC,
278 AV_CODEC_ID_ESCAPE130_DEPRECATED,
279 AV_CODEC_ID_G2M_DEPRECATED,
280 AV_CODEC_ID_WEBP_DEPRECATED,
281 AV_CODEC_ID_HNM4_VIDEO,
282 AV_CODEC_ID_HEVC_DEPRECATED,
284 AV_CODEC_ID_ALIAS_PIX,
285 AV_CODEC_ID_BRENDER_PIX_DEPRECATED,
286 AV_CODEC_ID_PAF_VIDEO_DEPRECATED,
287 AV_CODEC_ID_EXR_DEPRECATED,
288 AV_CODEC_ID_VP7_DEPRECATED,
289 AV_CODEC_ID_SANM_DEPRECATED,
290 AV_CODEC_ID_SGIRLE_DEPRECATED,
291 AV_CODEC_ID_MVC1_DEPRECATED,
292 AV_CODEC_ID_MVC2_DEPRECATED,
294 AV_CODEC_ID_BRENDER_PIX= MKBETAG('B','P','I','X'),
295 AV_CODEC_ID_Y41P = MKBETAG('Y','4','1','P'),
296 AV_CODEC_ID_ESCAPE130 = MKBETAG('E','1','3','0'),
297 AV_CODEC_ID_EXR = MKBETAG('0','E','X','R'),
298 AV_CODEC_ID_AVRP = MKBETAG('A','V','R','P'),
300 AV_CODEC_ID_012V = MKBETAG('0','1','2','V'),
301 AV_CODEC_ID_G2M = MKBETAG( 0 ,'G','2','M'),
302 AV_CODEC_ID_AVUI = MKBETAG('A','V','U','I'),
303 AV_CODEC_ID_AYUV = MKBETAG('A','Y','U','V'),
304 AV_CODEC_ID_TARGA_Y216 = MKBETAG('T','2','1','6'),
305 AV_CODEC_ID_V308 = MKBETAG('V','3','0','8'),
306 AV_CODEC_ID_V408 = MKBETAG('V','4','0','8'),
307 AV_CODEC_ID_YUV4 = MKBETAG('Y','U','V','4'),
308 AV_CODEC_ID_SANM = MKBETAG('S','A','N','M'),
309 AV_CODEC_ID_PAF_VIDEO = MKBETAG('P','A','F','V'),
310 AV_CODEC_ID_AVRN = MKBETAG('A','V','R','n'),
311 AV_CODEC_ID_CPIA = MKBETAG('C','P','I','A'),
312 AV_CODEC_ID_XFACE = MKBETAG('X','F','A','C'),
313 AV_CODEC_ID_SGIRLE = MKBETAG('S','G','I','R'),
314 AV_CODEC_ID_MVC1 = MKBETAG('M','V','C','1'),
315 AV_CODEC_ID_MVC2 = MKBETAG('M','V','C','2'),
316 AV_CODEC_ID_SNOW = MKBETAG('S','N','O','W'),
317 AV_CODEC_ID_WEBP = MKBETAG('W','E','B','P'),
318 AV_CODEC_ID_SMVJPEG = MKBETAG('S','M','V','J'),
319 AV_CODEC_ID_HEVC = MKBETAG('H','2','6','5'),
320 #define AV_CODEC_ID_H265 AV_CODEC_ID_HEVC
321 AV_CODEC_ID_VP7 = MKBETAG('V','P','7','0'),
323 /* various PCM "codecs" */
324 AV_CODEC_ID_FIRST_AUDIO = 0x10000, ///< A dummy id pointing at the start of audio codecs
325 AV_CODEC_ID_PCM_S16LE = 0x10000,
326 AV_CODEC_ID_PCM_S16BE,
327 AV_CODEC_ID_PCM_U16LE,
328 AV_CODEC_ID_PCM_U16BE,
331 AV_CODEC_ID_PCM_MULAW,
332 AV_CODEC_ID_PCM_ALAW,
333 AV_CODEC_ID_PCM_S32LE,
334 AV_CODEC_ID_PCM_S32BE,
335 AV_CODEC_ID_PCM_U32LE,
336 AV_CODEC_ID_PCM_U32BE,
337 AV_CODEC_ID_PCM_S24LE,
338 AV_CODEC_ID_PCM_S24BE,
339 AV_CODEC_ID_PCM_U24LE,
340 AV_CODEC_ID_PCM_U24BE,
341 AV_CODEC_ID_PCM_S24DAUD,
342 AV_CODEC_ID_PCM_ZORK,
343 AV_CODEC_ID_PCM_S16LE_PLANAR,
345 AV_CODEC_ID_PCM_F32BE,
346 AV_CODEC_ID_PCM_F32LE,
347 AV_CODEC_ID_PCM_F64BE,
348 AV_CODEC_ID_PCM_F64LE,
349 AV_CODEC_ID_PCM_BLURAY,
352 AV_CODEC_ID_PCM_S8_PLANAR,
353 AV_CODEC_ID_PCM_S24LE_PLANAR_DEPRECATED,
354 AV_CODEC_ID_PCM_S32LE_PLANAR_DEPRECATED,
355 AV_CODEC_ID_PCM_S24LE_PLANAR = MKBETAG(24,'P','S','P'),
356 AV_CODEC_ID_PCM_S32LE_PLANAR = MKBETAG(32,'P','S','P'),
357 AV_CODEC_ID_PCM_S16BE_PLANAR = MKBETAG('P','S','P',16),
359 /* various ADPCM codecs */
360 AV_CODEC_ID_ADPCM_IMA_QT = 0x11000,
361 AV_CODEC_ID_ADPCM_IMA_WAV,
362 AV_CODEC_ID_ADPCM_IMA_DK3,
363 AV_CODEC_ID_ADPCM_IMA_DK4,
364 AV_CODEC_ID_ADPCM_IMA_WS,
365 AV_CODEC_ID_ADPCM_IMA_SMJPEG,
366 AV_CODEC_ID_ADPCM_MS,
367 AV_CODEC_ID_ADPCM_4XM,
368 AV_CODEC_ID_ADPCM_XA,
369 AV_CODEC_ID_ADPCM_ADX,
370 AV_CODEC_ID_ADPCM_EA,
371 AV_CODEC_ID_ADPCM_G726,
372 AV_CODEC_ID_ADPCM_CT,
373 AV_CODEC_ID_ADPCM_SWF,
374 AV_CODEC_ID_ADPCM_YAMAHA,
375 AV_CODEC_ID_ADPCM_SBPRO_4,
376 AV_CODEC_ID_ADPCM_SBPRO_3,
377 AV_CODEC_ID_ADPCM_SBPRO_2,
378 AV_CODEC_ID_ADPCM_THP,
379 AV_CODEC_ID_ADPCM_IMA_AMV,
380 AV_CODEC_ID_ADPCM_EA_R1,
381 AV_CODEC_ID_ADPCM_EA_R3,
382 AV_CODEC_ID_ADPCM_EA_R2,
383 AV_CODEC_ID_ADPCM_IMA_EA_SEAD,
384 AV_CODEC_ID_ADPCM_IMA_EA_EACS,
385 AV_CODEC_ID_ADPCM_EA_XAS,
386 AV_CODEC_ID_ADPCM_EA_MAXIS_XA,
387 AV_CODEC_ID_ADPCM_IMA_ISS,
388 AV_CODEC_ID_ADPCM_G722,
389 AV_CODEC_ID_ADPCM_IMA_APC,
390 AV_CODEC_ID_ADPCM_VIMA_DEPRECATED,
391 AV_CODEC_ID_ADPCM_VIMA = MKBETAG('V','I','M','A'),
392 AV_CODEC_ID_VIMA = MKBETAG('V','I','M','A'),
393 AV_CODEC_ID_ADPCM_AFC = MKBETAG('A','F','C',' '),
394 AV_CODEC_ID_ADPCM_IMA_OKI = MKBETAG('O','K','I',' '),
395 AV_CODEC_ID_ADPCM_DTK = MKBETAG('D','T','K',' '),
396 AV_CODEC_ID_ADPCM_IMA_RAD = MKBETAG('R','A','D',' '),
397 AV_CODEC_ID_ADPCM_G726LE = MKBETAG('6','2','7','G'),
400 AV_CODEC_ID_AMR_NB = 0x12000,
403 /* RealAudio codecs*/
404 AV_CODEC_ID_RA_144 = 0x13000,
407 /* various DPCM codecs */
408 AV_CODEC_ID_ROQ_DPCM = 0x14000,
409 AV_CODEC_ID_INTERPLAY_DPCM,
410 AV_CODEC_ID_XAN_DPCM,
411 AV_CODEC_ID_SOL_DPCM,
414 AV_CODEC_ID_MP2 = 0x15000,
415 AV_CODEC_ID_MP3, ///< preferred ID for decoding MPEG audio layer 1, 2 or 3
425 AV_CODEC_ID_VMDAUDIO,
431 AV_CODEC_ID_WESTWOOD_SND1,
432 AV_CODEC_ID_GSM, ///< as in Berlin toast format
435 AV_CODEC_ID_TRUESPEECH,
437 AV_CODEC_ID_SMACKAUDIO,
440 AV_CODEC_ID_DSICINAUDIO,
442 AV_CODEC_ID_MUSEPACK7,
444 AV_CODEC_ID_GSM_MS, /* as found in WAV */
450 AV_CODEC_ID_NELLYMOSER,
451 AV_CODEC_ID_MUSEPACK8,
453 AV_CODEC_ID_WMAVOICE,
455 AV_CODEC_ID_WMALOSSLESS,
464 AV_CODEC_ID_BINKAUDIO_RDFT,
465 AV_CODEC_ID_BINKAUDIO_DCT,
466 AV_CODEC_ID_AAC_LATM,
471 AV_CODEC_ID_8SVX_EXP,
472 AV_CODEC_ID_8SVX_FIB,
473 AV_CODEC_ID_BMV_AUDIO,
477 AV_CODEC_ID_OPUS_DEPRECATED,
478 AV_CODEC_ID_COMFORT_NOISE,
479 AV_CODEC_ID_TAK_DEPRECATED,
480 AV_CODEC_ID_METASOUND,
481 AV_CODEC_ID_PAF_AUDIO_DEPRECATED,
483 AV_CODEC_ID_FFWAVESYNTH = MKBETAG('F','F','W','S'),
484 AV_CODEC_ID_SONIC = MKBETAG('S','O','N','C'),
485 AV_CODEC_ID_SONIC_LS = MKBETAG('S','O','N','L'),
486 AV_CODEC_ID_PAF_AUDIO = MKBETAG('P','A','F','A'),
487 AV_CODEC_ID_OPUS = MKBETAG('O','P','U','S'),
488 AV_CODEC_ID_TAK = MKBETAG('t','B','a','K'),
489 AV_CODEC_ID_EVRC = MKBETAG('s','e','v','c'),
490 AV_CODEC_ID_SMV = MKBETAG('s','s','m','v'),
491 AV_CODEC_ID_DSD_LSBF = MKBETAG('D','S','D','L'),
492 AV_CODEC_ID_DSD_MSBF = MKBETAG('D','S','D','M'),
493 AV_CODEC_ID_DSD_LSBF_PLANAR = MKBETAG('D','S','D','1'),
494 AV_CODEC_ID_DSD_MSBF_PLANAR = MKBETAG('D','S','D','8'),
496 /* subtitle codecs */
497 AV_CODEC_ID_FIRST_SUBTITLE = 0x17000, ///< A dummy ID pointing at the start of subtitle codecs.
498 AV_CODEC_ID_DVD_SUBTITLE = 0x17000,
499 AV_CODEC_ID_DVB_SUBTITLE,
500 AV_CODEC_ID_TEXT, ///< raw UTF-8 text
503 AV_CODEC_ID_MOV_TEXT,
504 AV_CODEC_ID_HDMV_PGS_SUBTITLE,
505 AV_CODEC_ID_DVB_TELETEXT,
507 AV_CODEC_ID_MICRODVD = MKBETAG('m','D','V','D'),
508 AV_CODEC_ID_EIA_608 = MKBETAG('c','6','0','8'),
509 AV_CODEC_ID_JACOSUB = MKBETAG('J','S','U','B'),
510 AV_CODEC_ID_SAMI = MKBETAG('S','A','M','I'),
511 AV_CODEC_ID_REALTEXT = MKBETAG('R','T','X','T'),
512 AV_CODEC_ID_SUBVIEWER1 = MKBETAG('S','b','V','1'),
513 AV_CODEC_ID_SUBVIEWER = MKBETAG('S','u','b','V'),
514 AV_CODEC_ID_SUBRIP = MKBETAG('S','R','i','p'),
515 AV_CODEC_ID_WEBVTT = MKBETAG('W','V','T','T'),
516 AV_CODEC_ID_MPL2 = MKBETAG('M','P','L','2'),
517 AV_CODEC_ID_VPLAYER = MKBETAG('V','P','l','r'),
518 AV_CODEC_ID_PJS = MKBETAG('P','h','J','S'),
519 AV_CODEC_ID_ASS = MKBETAG('A','S','S',' '), ///< ASS as defined in Matroska
521 /* other specific kind of codecs (generally used for attachments) */
522 AV_CODEC_ID_FIRST_UNKNOWN = 0x18000, ///< A dummy ID pointing at the start of various fake codecs.
523 AV_CODEC_ID_TTF = 0x18000,
524 AV_CODEC_ID_BINTEXT = MKBETAG('B','T','X','T'),
525 AV_CODEC_ID_XBIN = MKBETAG('X','B','I','N'),
526 AV_CODEC_ID_IDF = MKBETAG( 0 ,'I','D','F'),
527 AV_CODEC_ID_OTF = MKBETAG( 0 ,'O','T','F'),
528 AV_CODEC_ID_SMPTE_KLV = MKBETAG('K','L','V','A'),
529 AV_CODEC_ID_DVD_NAV = MKBETAG('D','N','A','V'),
530 AV_CODEC_ID_TIMED_ID3 = MKBETAG('T','I','D','3'),
531 AV_CODEC_ID_BIN_DATA = MKBETAG('D','A','T','A'),
534 AV_CODEC_ID_PROBE = 0x19000, ///< codec_id is not known (like AV_CODEC_ID_NONE) but lavf should attempt to identify it
536 AV_CODEC_ID_MPEG2TS = 0x20000, /**< _FAKE_ codec to indicate a raw MPEG-2 TS
537 * stream (only used by libavformat) */
538 AV_CODEC_ID_MPEG4SYSTEMS = 0x20001, /**< _FAKE_ codec to indicate a MPEG-4 Systems
539 * stream (only used by libavformat) */
540 AV_CODEC_ID_FFMETADATA = 0x21000, ///< Dummy codec for streams containing only metadata information.
543 #include "old_codec_ids.h"
548 * This struct describes the properties of a single codec described by an
550 * @see avcodec_descriptor_get()
552 typedef struct AVCodecDescriptor {
554 enum AVMediaType type;
556 * Name of the codec described by this descriptor. It is non-empty and
557 * unique for each codec descriptor. It should contain alphanumeric
558 * characters and '_' only.
562 * A more descriptive name for this codec. May be NULL.
564 const char *long_name;
566 * Codec properties, a combination of AV_CODEC_PROP_* flags.
571 * MIME type(s) associated with the codec.
572 * May be NULL; if not, a NULL-terminated array of MIME types.
573 * The first item is always non-NULL and is the preferred MIME type.
575 const char *const *mime_types;
579 * Codec uses only intra compression.
582 #define AV_CODEC_PROP_INTRA_ONLY (1 << 0)
584 * Codec supports lossy compression. Audio and video codecs only.
585 * @note a codec may support both lossy and lossless
588 #define AV_CODEC_PROP_LOSSY (1 << 1)
590 * Codec supports lossless compression. Audio and video codecs only.
592 #define AV_CODEC_PROP_LOSSLESS (1 << 2)
594 * Codec supports frame reordering. That is, the coded order (the order in which
595 * the encoded packets are output by the encoders / stored / input to the
596 * decoders) may be different from the presentation order of the corresponding
599 * For codecs that do not have this property set, PTS and DTS should always be
602 #define AV_CODEC_PROP_REORDER (1 << 3)
604 * Subtitle codec is bitmap based
605 * Decoded AVSubtitle data can be read from the AVSubtitleRect->pict field.
607 #define AV_CODEC_PROP_BITMAP_SUB (1 << 16)
609 * Subtitle codec is text based.
610 * Decoded AVSubtitle data can be read from the AVSubtitleRect->ass field.
612 #define AV_CODEC_PROP_TEXT_SUB (1 << 17)
615 * @ingroup lavc_decoding
616 * Required number of additionally allocated bytes at the end of the input bitstream for decoding.
617 * This is mainly needed because some optimized bitstream readers read
618 * 32 or 64 bit at once and could read over the end.<br>
619 * Note: If the first 23 bits of the additional bytes are not 0, then damaged
620 * MPEG bitstreams could cause overread and segfault.
622 #define FF_INPUT_BUFFER_PADDING_SIZE 32
625 * @ingroup lavc_encoding
626 * minimum encoding buffer size
627 * Used to avoid some checks during header writing.
629 #define FF_MIN_BUFFER_SIZE 16384
633 * @ingroup lavc_encoding
634 * motion estimation type.
637 ME_ZERO = 1, ///< no search, that is use 0,0 vector whenever one is needed
641 ME_EPZS, ///< enhanced predictive zonal search
642 ME_X1, ///< reserved for experiments
643 ME_HEX, ///< hexagon based search
644 ME_UMH, ///< uneven multi-hexagon search
645 ME_TESA, ///< transformed exhaustive search algorithm
646 ME_ITER=50, ///< iterative search
650 * @ingroup lavc_decoding
653 /* We leave some space between them for extensions (drop some
654 * keyframes for intra-only or drop just some bidir frames). */
655 AVDISCARD_NONE =-16, ///< discard nothing
656 AVDISCARD_DEFAULT = 0, ///< discard useless packets like 0 size packets in avi
657 AVDISCARD_NONREF = 8, ///< discard all non reference
658 AVDISCARD_BIDIR = 16, ///< discard all bidirectional frames
659 AVDISCARD_NONINTRA= 24, ///< discard all non intra frames
660 AVDISCARD_NONKEY = 32, ///< discard all frames except keyframes
661 AVDISCARD_ALL = 48, ///< discard all
664 enum AVAudioServiceType {
665 AV_AUDIO_SERVICE_TYPE_MAIN = 0,
666 AV_AUDIO_SERVICE_TYPE_EFFECTS = 1,
667 AV_AUDIO_SERVICE_TYPE_VISUALLY_IMPAIRED = 2,
668 AV_AUDIO_SERVICE_TYPE_HEARING_IMPAIRED = 3,
669 AV_AUDIO_SERVICE_TYPE_DIALOGUE = 4,
670 AV_AUDIO_SERVICE_TYPE_COMMENTARY = 5,
671 AV_AUDIO_SERVICE_TYPE_EMERGENCY = 6,
672 AV_AUDIO_SERVICE_TYPE_VOICE_OVER = 7,
673 AV_AUDIO_SERVICE_TYPE_KARAOKE = 8,
674 AV_AUDIO_SERVICE_TYPE_NB , ///< Not part of ABI
678 * @ingroup lavc_encoding
680 typedef struct RcOverride{
683 int qscale; // If this is 0 then quality_factor will be used instead.
684 float quality_factor;
687 #if FF_API_MAX_BFRAMES
689 * @deprecated there is no libavcodec-wide limit on the number of B-frames
691 #define FF_MAX_B_FRAMES 16
695 These flags can be passed in AVCodecContext.flags before initialization.
696 Note: Not everything is supported yet.
700 * Allow decoders to produce frames with data planes that are not aligned
701 * to CPU requirements (e.g. due to cropping).
703 #define CODEC_FLAG_UNALIGNED 0x0001
704 #define CODEC_FLAG_QSCALE 0x0002 ///< Use fixed qscale.
705 #define CODEC_FLAG_4MV 0x0004 ///< 4 MV per MB allowed / advanced prediction for H.263.
706 #define CODEC_FLAG_OUTPUT_CORRUPT 0x0008 ///< Output even those frames that might be corrupted
707 #define CODEC_FLAG_QPEL 0x0010 ///< Use qpel MC.
710 * @deprecated use the "gmc" private option of the libxvid encoder
712 #define CODEC_FLAG_GMC 0x0020 ///< Use GMC.
716 * @deprecated use the flag "mv0" in the "mpv_flags" private option of the
719 #define CODEC_FLAG_MV0 0x0040
721 #if FF_API_INPUT_PRESERVED
723 * @deprecated passing reference-counted frames to the encoders replaces this
726 #define CODEC_FLAG_INPUT_PRESERVED 0x0100
728 #define CODEC_FLAG_PASS1 0x0200 ///< Use internal 2pass ratecontrol in first pass mode.
729 #define CODEC_FLAG_PASS2 0x0400 ///< Use internal 2pass ratecontrol in second pass mode.
730 #define CODEC_FLAG_GRAY 0x2000 ///< Only decode/encode grayscale.
733 * @deprecated edges are not used/required anymore. I.e. this flag is now always
736 #define CODEC_FLAG_EMU_EDGE 0x4000
738 #define CODEC_FLAG_PSNR 0x8000 ///< error[?] variables will be set during encoding.
739 #define CODEC_FLAG_TRUNCATED 0x00010000 /** Input bitstream might be truncated at a random
740 location instead of only at frame boundaries. */
741 #if FF_API_NORMALIZE_AQP
743 * @deprecated use the flag "naq" in the "mpv_flags" private option of the
746 #define CODEC_FLAG_NORMALIZE_AQP 0x00020000
748 #define CODEC_FLAG_INTERLACED_DCT 0x00040000 ///< Use interlaced DCT.
749 #define CODEC_FLAG_LOW_DELAY 0x00080000 ///< Force low delay.
750 #define CODEC_FLAG_GLOBAL_HEADER 0x00400000 ///< Place global headers in extradata instead of every keyframe.
751 #define CODEC_FLAG_BITEXACT 0x00800000 ///< Use only bitexact stuff (except (I)DCT).
752 /* Fx : Flag for h263+ extra options */
753 #define CODEC_FLAG_AC_PRED 0x01000000 ///< H.263 advanced intra coding / MPEG-4 AC prediction
754 #define CODEC_FLAG_LOOP_FILTER 0x00000800 ///< loop filter
755 #define CODEC_FLAG_INTERLACED_ME 0x20000000 ///< interlaced motion estimation
756 #define CODEC_FLAG_CLOSED_GOP 0x80000000
757 #define CODEC_FLAG2_FAST 0x00000001 ///< Allow non spec compliant speedup tricks.
758 #define CODEC_FLAG2_NO_OUTPUT 0x00000004 ///< Skip bitstream encoding.
759 #define CODEC_FLAG2_LOCAL_HEADER 0x00000008 ///< Place global headers at every keyframe instead of in extradata.
760 #define CODEC_FLAG2_DROP_FRAME_TIMECODE 0x00002000 ///< timecode is in drop frame format. DEPRECATED!!!!
761 #define CODEC_FLAG2_IGNORE_CROP 0x00010000 ///< Discard cropping information from SPS.
763 #define CODEC_FLAG2_CHUNKS 0x00008000 ///< Input bitstream might be truncated at a packet boundaries instead of only at frame boundaries.
764 #define CODEC_FLAG2_SHOW_ALL 0x00400000 ///< Show all frames before the first keyframe
765 #define CODEC_FLAG2_EXPORT_MVS 0x10000000 ///< Export motion vectors through frame side data
766 #define CODEC_FLAG2_SKIP_MANUAL 0x20000000 ///< Do not skip samples and export skip information as frame side data
768 /* Unsupported options :
769 * Syntax Arithmetic coding (SAC)
770 * Reference Picture Selection
771 * Independent Segment Decoding */
773 /* codec capabilities */
775 #define CODEC_CAP_DRAW_HORIZ_BAND 0x0001 ///< Decoder can use draw_horiz_band callback.
777 * Codec uses get_buffer() for allocating buffers and supports custom allocators.
778 * If not set, it might not use get_buffer() at all or use operations that
779 * assume the buffer was allocated by avcodec_default_get_buffer.
781 #define CODEC_CAP_DR1 0x0002
782 #define CODEC_CAP_TRUNCATED 0x0008
784 /* Codec can export data for HW decoding. This flag indicates that
785 * the codec would call get_format() with list that might contain HW accelerated
786 * pixel formats (XvMC, VDPAU, VAAPI, etc). The application can pick any of them
787 * including raw image format.
788 * The application can use the passed context to determine bitstream version,
789 * chroma format, resolution etc.
791 #define CODEC_CAP_HWACCEL 0x0010
792 #endif /* FF_API_XVMC */
794 * Encoder or decoder requires flushing with NULL input at the end in order to
795 * give the complete and correct output.
797 * NOTE: If this flag is not set, the codec is guaranteed to never be fed with
798 * with NULL data. The user can still send NULL data to the public encode
799 * or decode function, but libavcodec will not pass it along to the codec
800 * unless this flag is set.
803 * The decoder has a non-zero delay and needs to be fed with avpkt->data=NULL,
804 * avpkt->size=0 at the end to get the delayed data until the decoder no longer
808 * The encoder needs to be fed with NULL data at the end of encoding until the
809 * encoder no longer returns data.
811 * NOTE: For encoders implementing the AVCodec.encode2() function, setting this
812 * flag also means that the encoder must set the pts and duration for
813 * each output packet. If this flag is not set, the pts and duration will
814 * be determined by libavcodec from the input frame.
816 #define CODEC_CAP_DELAY 0x0020
818 * Codec can be fed a final frame with a smaller size.
819 * This can be used to prevent truncation of the last audio samples.
821 #define CODEC_CAP_SMALL_LAST_FRAME 0x0040
824 * Codec can export data for HW decoding (VDPAU).
826 #define CODEC_CAP_HWACCEL_VDPAU 0x0080
829 * Codec can output multiple frames per AVPacket
830 * Normally demuxers return one frame at a time, demuxers which do not do
831 * are connected to a parser to split what they return into proper frames.
832 * This flag is reserved to the very rare category of codecs which have a
833 * bitstream that cannot be split into frames without timeconsuming
834 * operations like full decoding. Demuxers carring such bitstreams thus
835 * may return multiple frames in a packet. This has many disadvantages like
836 * prohibiting stream copy in many cases thus it should only be considered
839 #define CODEC_CAP_SUBFRAMES 0x0100
841 * Codec is experimental and is thus avoided in favor of non experimental
844 #define CODEC_CAP_EXPERIMENTAL 0x0200
846 * Codec should fill in channel configuration and samplerate instead of container
848 #define CODEC_CAP_CHANNEL_CONF 0x0400
849 #if FF_API_NEG_LINESIZES
851 * @deprecated no codecs use this capability
853 #define CODEC_CAP_NEG_LINESIZES 0x0800
856 * Codec supports frame-level multithreading.
858 #define CODEC_CAP_FRAME_THREADS 0x1000
860 * Codec supports slice-based (or partition-based) multithreading.
862 #define CODEC_CAP_SLICE_THREADS 0x2000
864 * Codec supports changed parameters at any point.
866 #define CODEC_CAP_PARAM_CHANGE 0x4000
868 * Codec supports avctx->thread_count == 0 (auto).
870 #define CODEC_CAP_AUTO_THREADS 0x8000
872 * Audio encoder supports receiving a different number of samples in each call.
874 #define CODEC_CAP_VARIABLE_FRAME_SIZE 0x10000
876 * Codec is intra only.
878 #define CODEC_CAP_INTRA_ONLY 0x40000000
882 #define CODEC_CAP_LOSSLESS 0x80000000
885 //The following defines may change, don't expect compatibility if you use them.
886 #define MB_TYPE_INTRA4x4 0x0001
887 #define MB_TYPE_INTRA16x16 0x0002 //FIXME H.264-specific
888 #define MB_TYPE_INTRA_PCM 0x0004 //FIXME H.264-specific
889 #define MB_TYPE_16x16 0x0008
890 #define MB_TYPE_16x8 0x0010
891 #define MB_TYPE_8x16 0x0020
892 #define MB_TYPE_8x8 0x0040
893 #define MB_TYPE_INTERLACED 0x0080
894 #define MB_TYPE_DIRECT2 0x0100 //FIXME
895 #define MB_TYPE_ACPRED 0x0200
896 #define MB_TYPE_GMC 0x0400
897 #define MB_TYPE_SKIP 0x0800
898 #define MB_TYPE_P0L0 0x1000
899 #define MB_TYPE_P1L0 0x2000
900 #define MB_TYPE_P0L1 0x4000
901 #define MB_TYPE_P1L1 0x8000
902 #define MB_TYPE_L0 (MB_TYPE_P0L0 | MB_TYPE_P1L0)
903 #define MB_TYPE_L1 (MB_TYPE_P0L1 | MB_TYPE_P1L1)
904 #define MB_TYPE_L0L1 (MB_TYPE_L0 | MB_TYPE_L1)
905 #define MB_TYPE_QUANT 0x00010000
906 #define MB_TYPE_CBP 0x00020000
907 //Note bits 24-31 are reserved for codec specific use (h264 ref0, mpeg1 0mv, ...)
912 * This specifies the area which should be displayed.
913 * Note there may be multiple such areas for one frame.
915 typedef struct AVPanScan{
918 * - encoding: Set by user.
919 * - decoding: Set by libavcodec.
924 * width and height in 1/16 pel
925 * - encoding: Set by user.
926 * - decoding: Set by libavcodec.
932 * position of the top left corner in 1/16 pel for up to 3 fields/frames
933 * - encoding: Set by user.
934 * - decoding: Set by libavcodec.
936 int16_t position[3][2];
939 #if FF_API_QSCALE_TYPE
940 #define FF_QSCALE_TYPE_MPEG1 0
941 #define FF_QSCALE_TYPE_MPEG2 1
942 #define FF_QSCALE_TYPE_H264 2
943 #define FF_QSCALE_TYPE_VP56 3
946 #if FF_API_GET_BUFFER
947 #define FF_BUFFER_TYPE_INTERNAL 1
948 #define FF_BUFFER_TYPE_USER 2 ///< direct rendering buffers (image is (de)allocated by user)
949 #define FF_BUFFER_TYPE_SHARED 4 ///< Buffer from somewhere else; don't deallocate image (data/base), all other tables are not shared.
950 #define FF_BUFFER_TYPE_COPY 8 ///< Just a (modified) copy of some other buffer, don't deallocate anything.
952 #define FF_BUFFER_HINTS_VALID 0x01 // Buffer hints value is meaningful (if 0 ignore).
953 #define FF_BUFFER_HINTS_READABLE 0x02 // Codec will read from buffer.
954 #define FF_BUFFER_HINTS_PRESERVE 0x04 // User must not alter buffer content.
955 #define FF_BUFFER_HINTS_REUSABLE 0x08 // Codec will reuse the buffer (update).
959 * The decoder will keep a reference to the frame and may reuse it later.
961 #define AV_GET_BUFFER_FLAG_REF (1 << 0)
964 * @defgroup lavc_packet AVPacket
966 * Types and functions for working with AVPacket.
969 enum AVPacketSideDataType {
971 AV_PKT_DATA_NEW_EXTRADATA,
974 * An AV_PKT_DATA_PARAM_CHANGE side data packet is laid out as follows:
977 * if (param_flags & AV_SIDE_DATA_PARAM_CHANGE_CHANNEL_COUNT)
978 * s32le channel_count
979 * if (param_flags & AV_SIDE_DATA_PARAM_CHANGE_CHANNEL_LAYOUT)
980 * u64le channel_layout
981 * if (param_flags & AV_SIDE_DATA_PARAM_CHANGE_SAMPLE_RATE)
983 * if (param_flags & AV_SIDE_DATA_PARAM_CHANGE_DIMENSIONS)
988 AV_PKT_DATA_PARAM_CHANGE,
991 * An AV_PKT_DATA_H263_MB_INFO side data packet contains a number of
992 * structures with info about macroblocks relevant to splitting the
993 * packet into smaller packets on macroblock edges (e.g. as for RFC 2190).
994 * That is, it does not necessarily contain info about all macroblocks,
995 * as long as the distance between macroblocks in the info is smaller
996 * than the target payload size.
997 * Each MB info structure is 12 bytes, and is laid out as follows:
999 * u32le bit offset from the start of the packet
1000 * u8 current quantizer at the start of the macroblock
1002 * u16le macroblock address within the GOB
1003 * u8 horizontal MV predictor
1004 * u8 vertical MV predictor
1005 * u8 horizontal MV predictor for block number 3
1006 * u8 vertical MV predictor for block number 3
1009 AV_PKT_DATA_H263_MB_INFO,
1012 * This side data should be associated with an audio stream and contains
1013 * ReplayGain information in form of the AVReplayGain struct.
1015 AV_PKT_DATA_REPLAYGAIN,
1018 * This side data contains a 3x3 transformation matrix describing an affine
1019 * transformation that needs to be applied to the decoded video frames for
1020 * correct presentation.
1022 * See libavutil/display.h for a detailed description of the data.
1024 AV_PKT_DATA_DISPLAYMATRIX,
1027 * This side data should be associated with a video stream and contains
1028 * Stereoscopic 3D information in form of the AVStereo3D struct.
1030 AV_PKT_DATA_STEREO3D,
1033 * Recommmends skipping the specified number of samples
1035 * u32le number of samples to skip from start of this packet
1036 * u32le number of samples to skip from end of this packet
1037 * u8 reason for start skip
1038 * u8 reason for end skip (0=padding silence, 1=convergence)
1041 AV_PKT_DATA_SKIP_SAMPLES=70,
1044 * An AV_PKT_DATA_JP_DUALMONO side data packet indicates that
1045 * the packet may contain "dual mono" audio specific to Japanese DTV
1046 * and if it is true, recommends only the selected channel to be used.
1048 * u8 selected channels (0=mail/left, 1=sub/right, 2=both)
1051 AV_PKT_DATA_JP_DUALMONO,
1054 * A list of zero terminated key/value strings. There is no end marker for
1055 * the list, so it is required to rely on the side data size to stop.
1057 AV_PKT_DATA_STRINGS_METADATA,
1060 * Subtitle event position
1068 AV_PKT_DATA_SUBTITLE_POSITION,
1071 * Data found in BlockAdditional element of matroska container. There is
1072 * no end marker for the data, so it is required to rely on the side data
1073 * size to recognize the end. 8 byte id (as found in BlockAddId) followed
1076 AV_PKT_DATA_MATROSKA_BLOCKADDITIONAL,
1079 * The optional first identifier line of a WebVTT cue.
1081 AV_PKT_DATA_WEBVTT_IDENTIFIER,
1084 * The optional settings (rendering instructions) that immediately
1085 * follow the timestamp specifier of a WebVTT cue.
1087 AV_PKT_DATA_WEBVTT_SETTINGS,
1090 * A list of zero terminated key/value strings. There is no end marker for
1091 * the list, so it is required to rely on the side data size to stop. This
1092 * side data includes updated metadata which appeared in the stream.
1094 AV_PKT_DATA_METADATA_UPDATE,
1097 typedef struct AVPacketSideData {
1100 enum AVPacketSideDataType type;
1104 * This structure stores compressed data. It is typically exported by demuxers
1105 * and then passed as input to decoders, or received as output from encoders and
1106 * then passed to muxers.
1108 * For video, it should typically contain one compressed frame. For audio it may
1109 * contain several compressed frames.
1111 * AVPacket is one of the few structs in FFmpeg, whose size is a part of public
1112 * ABI. Thus it may be allocated on stack and no new fields can be added to it
1113 * without libavcodec and libavformat major bump.
1115 * The semantics of data ownership depends on the buf or destruct (deprecated)
1116 * fields. If either is set, the packet data is dynamically allocated and is
1117 * valid indefinitely until av_free_packet() is called (which in turn calls
1118 * av_buffer_unref()/the destruct callback to free the data). If neither is set,
1119 * the packet data is typically backed by some static buffer somewhere and is
1120 * only valid for a limited time (e.g. until the next read call when demuxing).
1122 * The side data is always allocated with av_malloc() and is freed in
1125 typedef struct AVPacket {
1127 * A reference to the reference-counted buffer where the packet data is
1129 * May be NULL, then the packet data is not reference-counted.
1133 * Presentation timestamp in AVStream->time_base units; the time at which
1134 * the decompressed packet will be presented to the user.
1135 * Can be AV_NOPTS_VALUE if it is not stored in the file.
1136 * pts MUST be larger or equal to dts as presentation cannot happen before
1137 * decompression, unless one wants to view hex dumps. Some formats misuse
1138 * the terms dts and pts/cts to mean something different. Such timestamps
1139 * must be converted to true pts/dts before they are stored in AVPacket.
1143 * Decompression timestamp in AVStream->time_base units; the time at which
1144 * the packet is decompressed.
1145 * Can be AV_NOPTS_VALUE if it is not stored in the file.
1152 * A combination of AV_PKT_FLAG values
1156 * Additional packet data that can be provided by the container.
1157 * Packet can contain several types of side information.
1159 AVPacketSideData *side_data;
1160 int side_data_elems;
1163 * Duration of this packet in AVStream->time_base units, 0 if unknown.
1164 * Equals next_pts - this_pts in presentation order.
1167 #if FF_API_DESTRUCT_PACKET
1168 attribute_deprecated
1169 void (*destruct)(struct AVPacket *);
1170 attribute_deprecated
1173 int64_t pos; ///< byte position in stream, -1 if unknown
1176 * Time difference in AVStream->time_base units from the pts of this
1177 * packet to the point at which the output from the decoder has converged
1178 * independent from the availability of previous frames. That is, the
1179 * frames are virtually identical no matter if decoding started from
1180 * the very first frame or from this keyframe.
1181 * Is AV_NOPTS_VALUE if unknown.
1182 * This field is not the display duration of the current packet.
1183 * This field has no meaning if the packet does not have AV_PKT_FLAG_KEY
1186 * The purpose of this field is to allow seeking in streams that have no
1187 * keyframes in the conventional sense. It corresponds to the
1188 * recovery point SEI in H.264 and match_time_delta in NUT. It is also
1189 * essential for some types of subtitle streams to ensure that all
1190 * subtitles are correctly displayed after seeking.
1192 int64_t convergence_duration;
1194 #define AV_PKT_FLAG_KEY 0x0001 ///< The packet contains a keyframe
1195 #define AV_PKT_FLAG_CORRUPT 0x0002 ///< The packet content is corrupted
1197 enum AVSideDataParamChangeFlags {
1198 AV_SIDE_DATA_PARAM_CHANGE_CHANNEL_COUNT = 0x0001,
1199 AV_SIDE_DATA_PARAM_CHANGE_CHANNEL_LAYOUT = 0x0002,
1200 AV_SIDE_DATA_PARAM_CHANGE_SAMPLE_RATE = 0x0004,
1201 AV_SIDE_DATA_PARAM_CHANGE_DIMENSIONS = 0x0008,
1207 struct AVCodecInternal;
1211 AV_FIELD_PROGRESSIVE,
1212 AV_FIELD_TT, //< Top coded_first, top displayed first
1213 AV_FIELD_BB, //< Bottom coded first, bottom displayed first
1214 AV_FIELD_TB, //< Top coded first, bottom displayed first
1215 AV_FIELD_BT, //< Bottom coded first, top displayed first
1219 * main external API structure.
1220 * New fields can be added to the end with minor version bumps.
1221 * Removal, reordering and changes to existing fields require a major
1223 * Please use AVOptions (av_opt* / av_set/get*()) to access these fields from user
1225 * sizeof(AVCodecContext) must not be used outside libav*.
1227 typedef struct AVCodecContext {
1229 * information on struct for av_log
1230 * - set by avcodec_alloc_context3
1232 const AVClass *av_class;
1233 int log_level_offset;
1235 enum AVMediaType codec_type; /* see AVMEDIA_TYPE_xxx */
1236 const struct AVCodec *codec;
1237 #if FF_API_CODEC_NAME
1239 * @deprecated this field is not used for anything in libavcodec
1241 attribute_deprecated
1242 char codec_name[32];
1244 enum AVCodecID codec_id; /* see AV_CODEC_ID_xxx */
1247 * fourcc (LSB first, so "ABCD" -> ('D'<<24) + ('C'<<16) + ('B'<<8) + 'A').
1248 * This is used to work around some encoder bugs.
1249 * A demuxer should set this to what is stored in the field used to identify the codec.
1250 * If there are multiple such fields in a container then the demuxer should choose the one
1251 * which maximizes the information about the used codec.
1252 * If the codec tag field in a container is larger than 32 bits then the demuxer should
1253 * remap the longer ID to 32 bits with a table or other structure. Alternatively a new
1254 * extra_codec_tag + size could be added but for this a clear advantage must be demonstrated
1256 * - encoding: Set by user, if not then the default based on codec_id will be used.
1257 * - decoding: Set by user, will be converted to uppercase by libavcodec during init.
1259 unsigned int codec_tag;
1262 * fourcc from the AVI stream header (LSB first, so "ABCD" -> ('D'<<24) + ('C'<<16) + ('B'<<8) + 'A').
1263 * This is used to work around some encoder bugs.
1264 * - encoding: unused
1265 * - decoding: Set by user, will be converted to uppercase by libavcodec during init.
1267 unsigned int stream_codec_tag;
1272 * Private context used for internal data.
1274 * Unlike priv_data, this is not codec-specific. It is used in general
1275 * libavcodec functions.
1277 struct AVCodecInternal *internal;
1280 * Private data of the user, can be used to carry app specific stuff.
1281 * - encoding: Set by user.
1282 * - decoding: Set by user.
1287 * the average bitrate
1288 * - encoding: Set by user; unused for constant quantizer encoding.
1289 * - decoding: Set by libavcodec. 0 or some bitrate if this info is available in the stream.
1294 * number of bits the bitstream is allowed to diverge from the reference.
1295 * the reference can be CBR (for CBR pass1) or VBR (for pass2)
1296 * - encoding: Set by user; unused for constant quantizer encoding.
1297 * - decoding: unused
1299 int bit_rate_tolerance;
1302 * Global quality for codecs which cannot change it per frame.
1303 * This should be proportional to MPEG-1/2/4 qscale.
1304 * - encoding: Set by user.
1305 * - decoding: unused
1310 * - encoding: Set by user.
1311 * - decoding: unused
1313 int compression_level;
1314 #define FF_COMPRESSION_DEFAULT -1
1318 * - encoding: Set by user.
1319 * - decoding: Set by user.
1325 * - encoding: Set by user.
1326 * - decoding: Set by user.
1331 * some codecs need / can use extradata like Huffman tables.
1332 * mjpeg: Huffman tables
1333 * rv10: additional flags
1334 * mpeg4: global headers (they can be in the bitstream or here)
1335 * The allocated memory should be FF_INPUT_BUFFER_PADDING_SIZE bytes larger
1336 * than extradata_size to avoid problems if it is read with the bitstream reader.
1337 * The bytewise contents of extradata must not depend on the architecture or CPU endianness.
1338 * - encoding: Set/allocated/freed by libavcodec.
1339 * - decoding: Set/allocated/freed by user.
1345 * This is the fundamental unit of time (in seconds) in terms
1346 * of which frame timestamps are represented. For fixed-fps content,
1347 * timebase should be 1/framerate and timestamp increments should be
1349 * - encoding: MUST be set by user.
1350 * - decoding: Set by libavcodec.
1352 AVRational time_base;
1355 * For some codecs, the time base is closer to the field rate than the frame rate.
1356 * Most notably, H.264 and MPEG-2 specify time_base as half of frame duration
1357 * if no telecine is used ...
1359 * Set to time_base ticks per frame. Default 1, e.g., H.264/MPEG-2 set it to 2.
1361 int ticks_per_frame;
1366 * Encoding: Number of frames delay there will be from the encoder input to
1367 * the decoder output. (we assume the decoder matches the spec)
1368 * Decoding: Number of frames delay in addition to what a standard decoder
1369 * as specified in the spec would produce.
1372 * Number of frames the decoded output will be delayed relative to the
1376 * For encoding, this field is unused (see initial_padding).
1378 * For decoding, this is the number of samples the decoder needs to
1379 * output before the decoder's output is valid. When seeking, you should
1380 * start decoding this many samples prior to your desired seek point.
1382 * - encoding: Set by libavcodec.
1383 * - decoding: Set by libavcodec.
1390 * picture width / height.
1391 * - encoding: MUST be set by user.
1392 * - decoding: May be set by the user before opening the decoder if known e.g.
1393 * from the container. Some decoders will require the dimensions
1394 * to be set by the caller. During decoding, the decoder may
1395 * overwrite those values as required.
1400 * Bitstream width / height, may be different from width/height e.g. when
1401 * the decoded frame is cropped before being output or lowres is enabled.
1402 * - encoding: unused
1403 * - decoding: May be set by the user before opening the decoder if known
1404 * e.g. from the container. During decoding, the decoder may
1405 * overwrite those values as required.
1407 int coded_width, coded_height;
1409 #if FF_API_ASPECT_EXTENDED
1410 #define FF_ASPECT_EXTENDED 15
1414 * the number of pictures in a group of pictures, or 0 for intra_only
1415 * - encoding: Set by user.
1416 * - decoding: unused
1421 * Pixel format, see AV_PIX_FMT_xxx.
1422 * May be set by the demuxer if known from headers.
1423 * May be overridden by the decoder if it knows better.
1424 * - encoding: Set by user.
1425 * - decoding: Set by user if known, overridden by libavcodec if known
1427 enum AVPixelFormat pix_fmt;
1430 * Motion estimation algorithm used for video coding.
1431 * 1 (zero), 2 (full), 3 (log), 4 (phods), 5 (epzs), 6 (x1), 7 (hex),
1432 * 8 (umh), 9 (iter), 10 (tesa) [7, 8, 10 are x264 specific, 9 is snow specific]
1433 * - encoding: MUST be set by user.
1434 * - decoding: unused
1439 * If non NULL, 'draw_horiz_band' is called by the libavcodec
1440 * decoder to draw a horizontal band. It improves cache usage. Not
1441 * all codecs can do that. You must check the codec capabilities
1443 * When multithreading is used, it may be called from multiple threads
1444 * at the same time; threads might draw different parts of the same AVFrame,
1445 * or multiple AVFrames, and there is no guarantee that slices will be drawn
1447 * The function is also used by hardware acceleration APIs.
1448 * It is called at least once during frame decoding to pass
1449 * the data needed for hardware render.
1450 * In that mode instead of pixel data, AVFrame points to
1451 * a structure specific to the acceleration API. The application
1452 * reads the structure and can change some fields to indicate progress
1454 * - encoding: unused
1455 * - decoding: Set by user.
1456 * @param height the height of the slice
1457 * @param y the y position of the slice
1458 * @param type 1->top field, 2->bottom field, 3->frame
1459 * @param offset offset into the AVFrame.data from which the slice should be read
1461 void (*draw_horiz_band)(struct AVCodecContext *s,
1462 const AVFrame *src, int offset[AV_NUM_DATA_POINTERS],
1463 int y, int type, int height);
1466 * callback to negotiate the pixelFormat
1467 * @param fmt is the list of formats which are supported by the codec,
1468 * it is terminated by -1 as 0 is a valid format, the formats are ordered by quality.
1469 * The first is always the native one.
1470 * @note The callback may be called again immediately if initialization for
1471 * the selected (hardware-accelerated) pixel format failed.
1472 * @warning Behavior is undefined if the callback returns a value not
1473 * in the fmt list of formats.
1474 * @return the chosen format
1475 * - encoding: unused
1476 * - decoding: Set by user, if not set the native format will be chosen.
1478 enum AVPixelFormat (*get_format)(struct AVCodecContext *s, const enum AVPixelFormat * fmt);
1481 * maximum number of B-frames between non-B-frames
1482 * Note: The output will be delayed by max_b_frames+1 relative to the input.
1483 * - encoding: Set by user.
1484 * - decoding: unused
1489 * qscale factor between IP and B-frames
1490 * If > 0 then the last P-frame quantizer will be used (q= lastp_q*factor+offset).
1491 * If < 0 then normal ratecontrol will be done (q= -normal_q*factor+offset).
1492 * - encoding: Set by user.
1493 * - decoding: unused
1495 float b_quant_factor;
1497 /** obsolete FIXME remove */
1499 #define FF_RC_STRATEGY_XVID 1
1501 int b_frame_strategy;
1504 * qscale offset between IP and B-frames
1505 * - encoding: Set by user.
1506 * - decoding: unused
1508 float b_quant_offset;
1511 * Size of the frame reordering buffer in the decoder.
1512 * For MPEG-2 it is 1 IPB or 0 low delay IP.
1513 * - encoding: Set by libavcodec.
1514 * - decoding: Set by libavcodec.
1519 * 0-> h263 quant 1-> mpeg quant
1520 * - encoding: Set by user.
1521 * - decoding: unused
1526 * qscale factor between P and I-frames
1527 * If > 0 then the last p frame quantizer will be used (q= lastp_q*factor+offset).
1528 * If < 0 then normal ratecontrol will be done (q= -normal_q*factor+offset).
1529 * - encoding: Set by user.
1530 * - decoding: unused
1532 float i_quant_factor;
1535 * qscale offset between P and I-frames
1536 * - encoding: Set by user.
1537 * - decoding: unused
1539 float i_quant_offset;
1542 * luminance masking (0-> disabled)
1543 * - encoding: Set by user.
1544 * - decoding: unused
1549 * temporary complexity masking (0-> disabled)
1550 * - encoding: Set by user.
1551 * - decoding: unused
1553 float temporal_cplx_masking;
1556 * spatial complexity masking (0-> disabled)
1557 * - encoding: Set by user.
1558 * - decoding: unused
1560 float spatial_cplx_masking;
1563 * p block masking (0-> disabled)
1564 * - encoding: Set by user.
1565 * - decoding: unused
1570 * darkness masking (0-> disabled)
1571 * - encoding: Set by user.
1572 * - decoding: unused
1578 * - encoding: Set by libavcodec.
1579 * - decoding: Set by user (or 0).
1583 * prediction method (needed for huffyuv)
1584 * - encoding: Set by user.
1585 * - decoding: unused
1587 int prediction_method;
1588 #define FF_PRED_LEFT 0
1589 #define FF_PRED_PLANE 1
1590 #define FF_PRED_MEDIAN 2
1593 * slice offsets in the frame in bytes
1594 * - encoding: Set/allocated by libavcodec.
1595 * - decoding: Set/allocated by user (or NULL).
1600 * sample aspect ratio (0 if unknown)
1601 * That is the width of a pixel divided by the height of the pixel.
1602 * Numerator and denominator must be relatively prime and smaller than 256 for some video standards.
1603 * - encoding: Set by user.
1604 * - decoding: Set by libavcodec.
1606 AVRational sample_aspect_ratio;
1609 * motion estimation comparison function
1610 * - encoding: Set by user.
1611 * - decoding: unused
1615 * subpixel motion estimation comparison function
1616 * - encoding: Set by user.
1617 * - decoding: unused
1621 * macroblock comparison function (not supported yet)
1622 * - encoding: Set by user.
1623 * - decoding: unused
1627 * interlaced DCT comparison function
1628 * - encoding: Set by user.
1629 * - decoding: unused
1632 #define FF_CMP_SAD 0
1633 #define FF_CMP_SSE 1
1634 #define FF_CMP_SATD 2
1635 #define FF_CMP_DCT 3
1636 #define FF_CMP_PSNR 4
1637 #define FF_CMP_BIT 5
1639 #define FF_CMP_ZERO 7
1640 #define FF_CMP_VSAD 8
1641 #define FF_CMP_VSSE 9
1642 #define FF_CMP_NSSE 10
1643 #define FF_CMP_W53 11
1644 #define FF_CMP_W97 12
1645 #define FF_CMP_DCTMAX 13
1646 #define FF_CMP_DCT264 14
1647 #define FF_CMP_CHROMA 256
1650 * ME diamond size & shape
1651 * - encoding: Set by user.
1652 * - decoding: unused
1657 * amount of previous MV predictors (2a+1 x 2a+1 square)
1658 * - encoding: Set by user.
1659 * - decoding: unused
1661 int last_predictor_count;
1664 * prepass for motion estimation
1665 * - encoding: Set by user.
1666 * - decoding: unused
1671 * motion estimation prepass comparison function
1672 * - encoding: Set by user.
1673 * - decoding: unused
1678 * ME prepass diamond size & shape
1679 * - encoding: Set by user.
1680 * - decoding: unused
1686 * - encoding: Set by user.
1687 * - decoding: unused
1689 int me_subpel_quality;
1693 * DTG active format information (additional aspect ratio
1694 * information only used in DVB MPEG-2 transport streams)
1697 * - encoding: unused
1698 * - decoding: Set by decoder.
1699 * @deprecated Deprecated in favor of AVSideData
1701 attribute_deprecated int dtg_active_format;
1702 #define FF_DTG_AFD_SAME 8
1703 #define FF_DTG_AFD_4_3 9
1704 #define FF_DTG_AFD_16_9 10
1705 #define FF_DTG_AFD_14_9 11
1706 #define FF_DTG_AFD_4_3_SP_14_9 13
1707 #define FF_DTG_AFD_16_9_SP_14_9 14
1708 #define FF_DTG_AFD_SP_4_3 15
1709 #endif /* FF_API_AFD */
1712 * maximum motion estimation search range in subpel units
1713 * If 0 then no limit.
1715 * - encoding: Set by user.
1716 * - decoding: unused
1721 * intra quantizer bias
1722 * - encoding: Set by user.
1723 * - decoding: unused
1725 int intra_quant_bias;
1726 #define FF_DEFAULT_QUANT_BIAS 999999
1729 * inter quantizer bias
1730 * - encoding: Set by user.
1731 * - decoding: unused
1733 int inter_quant_bias;
1737 * - encoding: unused
1738 * - decoding: Set by user.
1741 #define SLICE_FLAG_CODED_ORDER 0x0001 ///< draw_horiz_band() is called in coded order instead of display
1742 #define SLICE_FLAG_ALLOW_FIELD 0x0002 ///< allow draw_horiz_band() with field slices (MPEG2 field pics)
1743 #define SLICE_FLAG_ALLOW_PLANE 0x0004 ///< allow draw_horiz_band() with 1 component at a time (SVQ1)
1747 * XVideo Motion Acceleration
1748 * - encoding: forbidden
1749 * - decoding: set by decoder
1750 * @deprecated XvMC doesn't need it anymore.
1752 attribute_deprecated int xvmc_acceleration;
1753 #endif /* FF_API_XVMC */
1756 * macroblock decision mode
1757 * - encoding: Set by user.
1758 * - decoding: unused
1761 #define FF_MB_DECISION_SIMPLE 0 ///< uses mb_cmp
1762 #define FF_MB_DECISION_BITS 1 ///< chooses the one which needs the fewest bits
1763 #define FF_MB_DECISION_RD 2 ///< rate distortion
1766 * custom intra quantization matrix
1767 * - encoding: Set by user, can be NULL.
1768 * - decoding: Set by libavcodec.
1770 uint16_t *intra_matrix;
1773 * custom inter quantization matrix
1774 * - encoding: Set by user, can be NULL.
1775 * - decoding: Set by libavcodec.
1777 uint16_t *inter_matrix;
1780 * scene change detection threshold
1781 * 0 is default, larger means fewer detected scene changes.
1782 * - encoding: Set by user.
1783 * - decoding: unused
1785 int scenechange_threshold;
1788 * noise reduction strength
1789 * - encoding: Set by user.
1790 * - decoding: unused
1792 int noise_reduction;
1795 * Motion estimation threshold below which no motion estimation is
1796 * performed, but instead the user specified motion vectors are used.
1798 * - encoding: Set by user.
1799 * - decoding: unused
1804 * Macroblock threshold below which the user specified macroblock types will be used.
1805 * - encoding: Set by user.
1806 * - decoding: unused
1811 * precision of the intra DC coefficient - 8
1812 * - encoding: Set by user.
1813 * - decoding: unused
1815 int intra_dc_precision;
1818 * Number of macroblock rows at the top which are skipped.
1819 * - encoding: unused
1820 * - decoding: Set by user.
1825 * Number of macroblock rows at the bottom which are skipped.
1826 * - encoding: unused
1827 * - decoding: Set by user.
1832 * Border processing masking, raises the quantizer for mbs on the borders
1834 * - encoding: Set by user.
1835 * - decoding: unused
1837 float border_masking;
1840 * minimum MB lagrange multipler
1841 * - encoding: Set by user.
1842 * - decoding: unused
1847 * maximum MB lagrange multipler
1848 * - encoding: Set by user.
1849 * - decoding: unused
1855 * - encoding: Set by user.
1856 * - decoding: unused
1858 int me_penalty_compensation;
1862 * - encoding: Set by user.
1863 * - decoding: unused
1869 * - encoding: Set by user.
1870 * - decoding: unused
1876 * - encoding: Set by user.
1877 * - decoding: unused
1882 * number of reference frames
1883 * - encoding: Set by user.
1884 * - decoding: Set by lavc.
1889 * chroma qp offset from luma
1890 * - encoding: Set by user.
1891 * - decoding: unused
1895 #if FF_API_UNUSED_MEMBERS
1897 * Multiplied by qscale for each frame and added to scene_change_score.
1898 * - encoding: Set by user.
1899 * - decoding: unused
1901 attribute_deprecated int scenechange_factor;
1906 * Note: Value depends upon the compare function used for fullpel ME.
1907 * - encoding: Set by user.
1908 * - decoding: unused
1913 * Adjust sensitivity of b_frame_strategy 1.
1914 * - encoding: Set by user.
1915 * - decoding: unused
1920 * Chromaticity coordinates of the source primaries.
1921 * - encoding: Set by user
1922 * - decoding: Set by libavcodec
1924 enum AVColorPrimaries color_primaries;
1927 * Color Transfer Characteristic.
1928 * - encoding: Set by user
1929 * - decoding: Set by libavcodec
1931 enum AVColorTransferCharacteristic color_trc;
1934 * YUV colorspace type.
1935 * - encoding: Set by user
1936 * - decoding: Set by libavcodec
1938 enum AVColorSpace colorspace;
1941 * MPEG vs JPEG YUV range.
1942 * - encoding: Set by user
1943 * - decoding: Set by libavcodec
1945 enum AVColorRange color_range;
1948 * This defines the location of chroma samples.
1949 * - encoding: Set by user
1950 * - decoding: Set by libavcodec
1952 enum AVChromaLocation chroma_sample_location;
1956 * Indicates number of picture subdivisions. Used for parallelized
1958 * - encoding: Set by user
1959 * - decoding: unused
1964 * - encoding: set by libavcodec
1965 * - decoding: Set by user.
1967 enum AVFieldOrder field_order;
1970 int sample_rate; ///< samples per second
1971 int channels; ///< number of audio channels
1974 * audio sample format
1975 * - encoding: Set by user.
1976 * - decoding: Set by libavcodec.
1978 enum AVSampleFormat sample_fmt; ///< sample format
1980 /* The following data should not be initialized. */
1982 * Number of samples per channel in an audio frame.
1984 * - encoding: set by libavcodec in avcodec_open2(). Each submitted frame
1985 * except the last must contain exactly frame_size samples per channel.
1986 * May be 0 when the codec has CODEC_CAP_VARIABLE_FRAME_SIZE set, then the
1987 * frame size is not restricted.
1988 * - decoding: may be set by some decoders to indicate constant frame size
1993 * Frame counter, set by libavcodec.
1995 * - decoding: total number of frames returned from the decoder so far.
1996 * - encoding: total number of frames passed to the encoder so far.
1998 * @note the counter is not incremented if encoding/decoding resulted in
2004 * number of bytes per packet if constant and known or 0
2005 * Used by some WAV based audio codecs.
2010 * Audio cutoff bandwidth (0 means "automatic")
2011 * - encoding: Set by user.
2012 * - decoding: unused
2016 #if FF_API_REQUEST_CHANNELS
2018 * Decoder should decode to this many channels if it can (0 for default)
2019 * - encoding: unused
2020 * - decoding: Set by user.
2021 * @deprecated Deprecated in favor of request_channel_layout.
2023 attribute_deprecated int request_channels;
2027 * Audio channel layout.
2028 * - encoding: set by user.
2029 * - decoding: set by user, may be overwritten by libavcodec.
2031 uint64_t channel_layout;
2034 * Request decoder to use this channel layout if it can (0 for default)
2035 * - encoding: unused
2036 * - decoding: Set by user.
2038 uint64_t request_channel_layout;
2041 * Type of service that the audio stream conveys.
2042 * - encoding: Set by user.
2043 * - decoding: Set by libavcodec.
2045 enum AVAudioServiceType audio_service_type;
2048 * desired sample format
2049 * - encoding: Not used.
2050 * - decoding: Set by user.
2051 * Decoder will decode to this format if it can.
2053 enum AVSampleFormat request_sample_fmt;
2055 #if FF_API_GET_BUFFER
2057 * Called at the beginning of each frame to get a buffer for it.
2059 * The function will set AVFrame.data[], AVFrame.linesize[].
2060 * AVFrame.extended_data[] must also be set, but it should be the same as
2061 * AVFrame.data[] except for planar audio with more channels than can fit
2062 * in AVFrame.data[]. In that case, AVFrame.data[] shall still contain as
2063 * many data pointers as it can hold.
2065 * if CODEC_CAP_DR1 is not set then get_buffer() must call
2066 * avcodec_default_get_buffer() instead of providing buffers allocated by
2069 * AVFrame.data[] should be 32- or 16-byte-aligned unless the CPU doesn't
2070 * need it. avcodec_default_get_buffer() aligns the output buffer properly,
2071 * but if get_buffer() is overridden then alignment considerations should
2072 * be taken into account.
2074 * @see avcodec_default_get_buffer()
2078 * If pic.reference is set then the frame will be read later by libavcodec.
2079 * avcodec_align_dimensions2() should be used to find the required width and
2080 * height, as they normally need to be rounded up to the next multiple of 16.
2082 * If frame multithreading is used and thread_safe_callbacks is set,
2083 * it may be called from a different thread, but not from more than one at
2084 * once. Does not need to be reentrant.
2086 * @see release_buffer(), reget_buffer()
2087 * @see avcodec_align_dimensions2()
2091 * Decoders request a buffer of a particular size by setting
2092 * AVFrame.nb_samples prior to calling get_buffer(). The decoder may,
2093 * however, utilize only part of the buffer by setting AVFrame.nb_samples
2094 * to a smaller value in the output frame.
2096 * Decoders cannot use the buffer after returning from
2097 * avcodec_decode_audio4(), so they will not call release_buffer(), as it
2098 * is assumed to be released immediately upon return. In some rare cases,
2099 * a decoder may need to call get_buffer() more than once in a single
2100 * call to avcodec_decode_audio4(). In that case, when get_buffer() is
2101 * called again after it has already been called once, the previously
2102 * acquired buffer is assumed to be released at that time and may not be
2103 * reused by the decoder.
2105 * As a convenience, av_samples_get_buffer_size() and
2106 * av_samples_fill_arrays() in libavutil may be used by custom get_buffer()
2107 * functions to find the required data size and to fill data pointers and
2108 * linesize. In AVFrame.linesize, only linesize[0] may be set for audio
2109 * since all planes must be the same size.
2111 * @see av_samples_get_buffer_size(), av_samples_fill_arrays()
2113 * - encoding: unused
2114 * - decoding: Set by libavcodec, user can override.
2116 * @deprecated use get_buffer2()
2118 attribute_deprecated
2119 int (*get_buffer)(struct AVCodecContext *c, AVFrame *pic);
2122 * Called to release buffers which were allocated with get_buffer.
2123 * A released buffer can be reused in get_buffer().
2124 * pic.data[*] must be set to NULL.
2125 * May be called from a different thread if frame multithreading is used,
2126 * but not by more than one thread at once, so does not need to be reentrant.
2127 * - encoding: unused
2128 * - decoding: Set by libavcodec, user can override.
2130 * @deprecated custom freeing callbacks should be set from get_buffer2()
2132 attribute_deprecated
2133 void (*release_buffer)(struct AVCodecContext *c, AVFrame *pic);
2136 * Called at the beginning of a frame to get cr buffer for it.
2137 * Buffer type (size, hints) must be the same. libavcodec won't check it.
2138 * libavcodec will pass previous buffer in pic, function should return
2139 * same buffer or new buffer with old frame "painted" into it.
2140 * If pic.data[0] == NULL must behave like get_buffer().
2141 * if CODEC_CAP_DR1 is not set then reget_buffer() must call
2142 * avcodec_default_reget_buffer() instead of providing buffers allocated by
2144 * - encoding: unused
2145 * - decoding: Set by libavcodec, user can override.
2147 attribute_deprecated
2148 int (*reget_buffer)(struct AVCodecContext *c, AVFrame *pic);
2152 * This callback is called at the beginning of each frame to get data
2153 * buffer(s) for it. There may be one contiguous buffer for all the data or
2154 * there may be a buffer per each data plane or anything in between. What
2155 * this means is, you may set however many entries in buf[] you feel necessary.
2156 * Each buffer must be reference-counted using the AVBuffer API (see description
2159 * The following fields will be set in the frame before this callback is
2162 * - width, height (video only)
2163 * - sample_rate, channel_layout, nb_samples (audio only)
2164 * Their values may differ from the corresponding values in
2165 * AVCodecContext. This callback must use the frame values, not the codec
2166 * context values, to calculate the required buffer size.
2168 * This callback must fill the following fields in the frame:
2172 * * if the data is planar audio with more than 8 channels, then this
2173 * callback must allocate and fill extended_data to contain all pointers
2174 * to all data planes. data[] must hold as many pointers as it can.
2175 * extended_data must be allocated with av_malloc() and will be freed in
2177 * * otherwise exended_data must point to data
2178 * - buf[] must contain one or more pointers to AVBufferRef structures. Each of
2179 * the frame's data and extended_data pointers must be contained in these. That
2180 * is, one AVBufferRef for each allocated chunk of memory, not necessarily one
2181 * AVBufferRef per data[] entry. See: av_buffer_create(), av_buffer_alloc(),
2182 * and av_buffer_ref().
2183 * - extended_buf and nb_extended_buf must be allocated with av_malloc() by
2184 * this callback and filled with the extra buffers if there are more
2185 * buffers than buf[] can hold. extended_buf will be freed in
2188 * If CODEC_CAP_DR1 is not set then get_buffer2() must call
2189 * avcodec_default_get_buffer2() instead of providing buffers allocated by
2192 * Each data plane must be aligned to the maximum required by the target
2195 * @see avcodec_default_get_buffer2()
2199 * If AV_GET_BUFFER_FLAG_REF is set in flags then the frame may be reused
2200 * (read and/or written to if it is writable) later by libavcodec.
2202 * avcodec_align_dimensions2() should be used to find the required width and
2203 * height, as they normally need to be rounded up to the next multiple of 16.
2205 * Some decoders do not support linesizes changing between frames.
2207 * If frame multithreading is used and thread_safe_callbacks is set,
2208 * this callback may be called from a different thread, but not from more
2209 * than one at once. Does not need to be reentrant.
2211 * @see avcodec_align_dimensions2()
2215 * Decoders request a buffer of a particular size by setting
2216 * AVFrame.nb_samples prior to calling get_buffer2(). The decoder may,
2217 * however, utilize only part of the buffer by setting AVFrame.nb_samples
2218 * to a smaller value in the output frame.
2220 * As a convenience, av_samples_get_buffer_size() and
2221 * av_samples_fill_arrays() in libavutil may be used by custom get_buffer2()
2222 * functions to find the required data size and to fill data pointers and
2223 * linesize. In AVFrame.linesize, only linesize[0] may be set for audio
2224 * since all planes must be the same size.
2226 * @see av_samples_get_buffer_size(), av_samples_fill_arrays()
2228 * - encoding: unused
2229 * - decoding: Set by libavcodec, user can override.
2231 int (*get_buffer2)(struct AVCodecContext *s, AVFrame *frame, int flags);
2234 * If non-zero, the decoded audio and video frames returned from
2235 * avcodec_decode_video2() and avcodec_decode_audio4() are reference-counted
2236 * and are valid indefinitely. The caller must free them with
2237 * av_frame_unref() when they are not needed anymore.
2238 * Otherwise, the decoded frames must not be freed by the caller and are
2239 * only valid until the next decode call.
2241 * - encoding: unused
2242 * - decoding: set by the caller before avcodec_open2().
2244 int refcounted_frames;
2246 /* - encoding parameters */
2247 float qcompress; ///< amount of qscale change between easy & hard scenes (0.0-1.0)
2248 float qblur; ///< amount of qscale smoothing over time (0.0-1.0)
2252 * - encoding: Set by user.
2253 * - decoding: unused
2259 * - encoding: Set by user.
2260 * - decoding: unused
2265 * maximum quantizer difference between frames
2266 * - encoding: Set by user.
2267 * - decoding: unused
2272 * ratecontrol qmin qmax limiting method
2273 * 0-> clipping, 1-> use a nice continuous function to limit qscale within qmin/qmax.
2274 * - encoding: Set by user.
2275 * - decoding: unused
2283 * decoder bitstream buffer size
2284 * - encoding: Set by user.
2285 * - decoding: unused
2290 * ratecontrol override, see RcOverride
2291 * - encoding: Allocated/set/freed by user.
2292 * - decoding: unused
2294 int rc_override_count;
2295 RcOverride *rc_override;
2298 * rate control equation
2299 * - encoding: Set by user
2300 * - decoding: unused
2306 * - encoding: Set by user.
2307 * - decoding: Set by libavcodec.
2313 * - encoding: Set by user.
2314 * - decoding: unused
2318 float rc_buffer_aggressivity;
2321 * initial complexity for pass1 ratecontrol
2322 * - encoding: Set by user.
2323 * - decoding: unused
2325 float rc_initial_cplx;
2328 * Ratecontrol attempt to use, at maximum, <value> of what can be used without an underflow.
2329 * - encoding: Set by user.
2330 * - decoding: unused.
2332 float rc_max_available_vbv_use;
2335 * Ratecontrol attempt to use, at least, <value> times the amount needed to prevent a vbv overflow.
2336 * - encoding: Set by user.
2337 * - decoding: unused.
2339 float rc_min_vbv_overflow_use;
2342 * Number of bits which should be loaded into the rc buffer before decoding starts.
2343 * - encoding: Set by user.
2344 * - decoding: unused
2346 int rc_initial_buffer_occupancy;
2348 #define FF_CODER_TYPE_VLC 0
2349 #define FF_CODER_TYPE_AC 1
2350 #define FF_CODER_TYPE_RAW 2
2351 #define FF_CODER_TYPE_RLE 3
2352 #if FF_API_UNUSED_MEMBERS
2353 #define FF_CODER_TYPE_DEFLATE 4
2354 #endif /* FF_API_UNUSED_MEMBERS */
2357 * - encoding: Set by user.
2358 * - decoding: unused
2364 * - encoding: Set by user.
2365 * - decoding: unused
2370 * minimum Lagrange multiplier
2371 * - encoding: Set by user.
2372 * - decoding: unused
2377 * maximum Lagrange multiplier
2378 * - encoding: Set by user.
2379 * - decoding: unused
2384 * frame skip threshold
2385 * - encoding: Set by user.
2386 * - decoding: unused
2388 int frame_skip_threshold;
2392 * - encoding: Set by user.
2393 * - decoding: unused
2395 int frame_skip_factor;
2398 * frame skip exponent
2399 * - encoding: Set by user.
2400 * - decoding: unused
2405 * frame skip comparison function
2406 * - encoding: Set by user.
2407 * - decoding: unused
2412 * trellis RD quantization
2413 * - encoding: Set by user.
2414 * - decoding: unused
2419 * - encoding: Set by user.
2420 * - decoding: unused
2422 int min_prediction_order;
2425 * - encoding: Set by user.
2426 * - decoding: unused
2428 int max_prediction_order;
2431 * GOP timecode frame start number
2432 * - encoding: Set by user, in non drop frame format
2433 * - decoding: Set by libavcodec (timecode in the 25 bits format, -1 if unset)
2435 int64_t timecode_frame_start;
2437 /* The RTP callback: This function is called */
2438 /* every time the encoder has a packet to send. */
2439 /* It depends on the encoder if the data starts */
2440 /* with a Start Code (it should). H.263 does. */
2441 /* mb_nb contains the number of macroblocks */
2442 /* encoded in the RTP payload. */
2443 void (*rtp_callback)(struct AVCodecContext *avctx, void *data, int size, int mb_nb);
2445 int rtp_payload_size; /* The size of the RTP payload: the coder will */
2446 /* do its best to deliver a chunk with size */
2447 /* below rtp_payload_size, the chunk will start */
2448 /* with a start code on some codecs like H.263. */
2449 /* This doesn't take account of any particular */
2450 /* headers inside the transmitted RTP payload. */
2452 /* statistics, used for 2-pass encoding */
2463 * number of bits used for the previously encoded frame
2464 * - encoding: Set by libavcodec.
2465 * - decoding: unused
2470 * pass1 encoding statistics output buffer
2471 * - encoding: Set by libavcodec.
2472 * - decoding: unused
2477 * pass2 encoding statistics input buffer
2478 * Concatenated stuff from stats_out of pass1 should be placed here.
2479 * - encoding: Allocated/set/freed by user.
2480 * - decoding: unused
2485 * Work around bugs in encoders which sometimes cannot be detected automatically.
2486 * - encoding: Set by user
2487 * - decoding: Set by user
2489 int workaround_bugs;
2490 #define FF_BUG_AUTODETECT 1 ///< autodetection
2491 #if FF_API_OLD_MSMPEG4
2492 #define FF_BUG_OLD_MSMPEG4 2
2494 #define FF_BUG_XVID_ILACE 4
2495 #define FF_BUG_UMP4 8
2496 #define FF_BUG_NO_PADDING 16
2497 #define FF_BUG_AMV 32
2499 #define FF_BUG_AC_VLC 0 ///< Will be removed, libavcodec can now handle these non-compliant files by default.
2501 #define FF_BUG_QPEL_CHROMA 64
2502 #define FF_BUG_STD_QPEL 128
2503 #define FF_BUG_QPEL_CHROMA2 256
2504 #define FF_BUG_DIRECT_BLOCKSIZE 512
2505 #define FF_BUG_EDGE 1024
2506 #define FF_BUG_HPEL_CHROMA 2048
2507 #define FF_BUG_DC_CLIP 4096
2508 #define FF_BUG_MS 8192 ///< Work around various bugs in Microsoft's broken decoders.
2509 #define FF_BUG_TRUNCATED 16384
2512 * strictly follow the standard (MPEG4, ...).
2513 * - encoding: Set by user.
2514 * - decoding: Set by user.
2515 * Setting this to STRICT or higher means the encoder and decoder will
2516 * generally do stupid things, whereas setting it to unofficial or lower
2517 * will mean the encoder might produce output that is not supported by all
2518 * spec-compliant decoders. Decoders don't differentiate between normal,
2519 * unofficial and experimental (that is, they always try to decode things
2520 * when they can) unless they are explicitly asked to behave stupidly
2521 * (=strictly conform to the specs)
2523 int strict_std_compliance;
2524 #define FF_COMPLIANCE_VERY_STRICT 2 ///< Strictly conform to an older more strict version of the spec or reference software.
2525 #define FF_COMPLIANCE_STRICT 1 ///< Strictly conform to all the things in the spec no matter what consequences.
2526 #define FF_COMPLIANCE_NORMAL 0
2527 #define FF_COMPLIANCE_UNOFFICIAL -1 ///< Allow unofficial extensions
2528 #define FF_COMPLIANCE_EXPERIMENTAL -2 ///< Allow nonstandardized experimental things.
2531 * error concealment flags
2532 * - encoding: unused
2533 * - decoding: Set by user.
2535 int error_concealment;
2536 #define FF_EC_GUESS_MVS 1
2537 #define FF_EC_DEBLOCK 2
2538 #define FF_EC_FAVOR_INTER 256
2542 * - encoding: Set by user.
2543 * - decoding: Set by user.
2546 #define FF_DEBUG_PICT_INFO 1
2547 #define FF_DEBUG_RC 2
2548 #define FF_DEBUG_BITSTREAM 4
2549 #define FF_DEBUG_MB_TYPE 8
2550 #define FF_DEBUG_QP 16
2553 * @deprecated this option does nothing
2555 #define FF_DEBUG_MV 32
2557 #define FF_DEBUG_DCT_COEFF 0x00000040
2558 #define FF_DEBUG_SKIP 0x00000080
2559 #define FF_DEBUG_STARTCODE 0x00000100
2560 #if FF_API_UNUSED_MEMBERS
2561 #define FF_DEBUG_PTS 0x00000200
2562 #endif /* FF_API_UNUSED_MEMBERS */
2563 #define FF_DEBUG_ER 0x00000400
2564 #define FF_DEBUG_MMCO 0x00000800
2565 #define FF_DEBUG_BUGS 0x00001000
2567 #define FF_DEBUG_VIS_QP 0x00002000 ///< only access through AVOptions from outside libavcodec
2568 #define FF_DEBUG_VIS_MB_TYPE 0x00004000 ///< only access through AVOptions from outside libavcodec
2570 #define FF_DEBUG_BUFFERS 0x00008000
2571 #define FF_DEBUG_THREADS 0x00010000
2572 #define FF_DEBUG_NOMC 0x01000000
2577 * Code outside libavcodec should access this field using AVOptions
2578 * - encoding: Set by user.
2579 * - decoding: Set by user.
2582 #define FF_DEBUG_VIS_MV_P_FOR 0x00000001 //visualize forward predicted MVs of P frames
2583 #define FF_DEBUG_VIS_MV_B_FOR 0x00000002 //visualize forward predicted MVs of B frames
2584 #define FF_DEBUG_VIS_MV_B_BACK 0x00000004 //visualize backward predicted MVs of B frames
2588 * Error recognition; may misdetect some more or less valid parts as errors.
2589 * - encoding: unused
2590 * - decoding: Set by user.
2592 int err_recognition;
2595 * Verify checksums embedded in the bitstream (could be of either encoded or
2596 * decoded data, depending on the codec) and print an error message on mismatch.
2597 * If AV_EF_EXPLODE is also set, a mismatching checksum will result in the
2598 * decoder returning an error.
2600 #define AV_EF_CRCCHECK (1<<0)
2601 #define AV_EF_BITSTREAM (1<<1) ///< detect bitstream specification deviations
2602 #define AV_EF_BUFFER (1<<2) ///< detect improper bitstream length
2603 #define AV_EF_EXPLODE (1<<3) ///< abort decoding on minor error detection
2605 #define AV_EF_IGNORE_ERR (1<<15) ///< ignore errors and continue
2606 #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
2607 #define AV_EF_COMPLIANT (1<<17) ///< consider all spec non compliances as errors
2608 #define AV_EF_AGGRESSIVE (1<<18) ///< consider things that a sane encoder should not do as an error
2612 * opaque 64bit number (generally a PTS) that will be reordered and
2613 * output in AVFrame.reordered_opaque
2614 * - encoding: unused
2615 * - decoding: Set by user.
2617 int64_t reordered_opaque;
2620 * Hardware accelerator in use
2621 * - encoding: unused.
2622 * - decoding: Set by libavcodec
2624 struct AVHWAccel *hwaccel;
2627 * Hardware accelerator context.
2628 * For some hardware accelerators, a global context needs to be
2629 * provided by the user. In that case, this holds display-dependent
2630 * data FFmpeg cannot instantiate itself. Please refer to the
2631 * FFmpeg HW accelerator documentation to know how to fill this
2632 * is. e.g. for VA API, this is a struct vaapi_context.
2633 * - encoding: unused
2634 * - decoding: Set by user
2636 void *hwaccel_context;
2640 * - encoding: Set by libavcodec if flags&CODEC_FLAG_PSNR.
2641 * - decoding: unused
2643 uint64_t error[AV_NUM_DATA_POINTERS];
2646 * DCT algorithm, see FF_DCT_* below
2647 * - encoding: Set by user.
2648 * - decoding: unused
2651 #define FF_DCT_AUTO 0
2652 #define FF_DCT_FASTINT 1
2653 #if FF_API_UNUSED_MEMBERS
2654 #define FF_DCT_INT 2
2655 #endif /* FF_API_UNUSED_MEMBERS */
2656 #define FF_DCT_MMX 3
2657 #define FF_DCT_ALTIVEC 5
2658 #define FF_DCT_FAAN 6
2661 * IDCT algorithm, see FF_IDCT_* below.
2662 * - encoding: Set by user.
2663 * - decoding: Set by user.
2666 #define FF_IDCT_AUTO 0
2667 #define FF_IDCT_INT 1
2668 #define FF_IDCT_SIMPLE 2
2669 #define FF_IDCT_SIMPLEMMX 3
2670 #define FF_IDCT_ARM 7
2671 #define FF_IDCT_ALTIVEC 8
2673 #define FF_IDCT_SH4 9
2675 #define FF_IDCT_SIMPLEARM 10
2676 #if FF_API_UNUSED_MEMBERS
2677 #define FF_IDCT_IPP 13
2678 #endif /* FF_API_UNUSED_MEMBERS */
2679 #define FF_IDCT_XVID 14
2680 #if FF_API_IDCT_XVIDMMX
2681 #define FF_IDCT_XVIDMMX 14
2682 #endif /* FF_API_IDCT_XVIDMMX */
2683 #define FF_IDCT_SIMPLEARMV5TE 16
2684 #define FF_IDCT_SIMPLEARMV6 17
2685 #if FF_API_ARCH_SPARC
2686 #define FF_IDCT_SIMPLEVIS 18
2688 #define FF_IDCT_FAAN 20
2689 #define FF_IDCT_SIMPLENEON 22
2690 #if FF_API_ARCH_ALPHA
2691 #define FF_IDCT_SIMPLEALPHA 23
2693 #define FF_IDCT_SIMPLEAUTO 128
2696 * bits per sample/pixel from the demuxer (needed for huffyuv).
2697 * - encoding: Set by libavcodec.
2698 * - decoding: Set by user.
2700 int bits_per_coded_sample;
2703 * Bits per sample/pixel of internal libavcodec pixel/sample format.
2704 * - encoding: set by user.
2705 * - decoding: set by libavcodec.
2707 int bits_per_raw_sample;
2711 * low resolution decoding, 1-> 1/2 size, 2->1/4 size
2712 * - encoding: unused
2713 * - decoding: Set by user.
2714 * Code outside libavcodec should access this field using:
2715 * av_codec_{get,set}_lowres(avctx)
2721 * the picture in the bitstream
2722 * - encoding: Set by libavcodec.
2723 * - decoding: unused
2725 AVFrame *coded_frame;
2729 * is used to decide how many independent tasks should be passed to execute()
2730 * - encoding: Set by user.
2731 * - decoding: Set by user.
2736 * Which multithreading methods to use.
2737 * Use of FF_THREAD_FRAME will increase decoding delay by one frame per thread,
2738 * so clients which cannot provide future frames should not use it.
2740 * - encoding: Set by user, otherwise the default is used.
2741 * - decoding: Set by user, otherwise the default is used.
2744 #define FF_THREAD_FRAME 1 ///< Decode more than one frame at once
2745 #define FF_THREAD_SLICE 2 ///< Decode more than one part of a single frame at once
2748 * Which multithreading methods are in use by the codec.
2749 * - encoding: Set by libavcodec.
2750 * - decoding: Set by libavcodec.
2752 int active_thread_type;
2755 * Set by the client if its custom get_buffer() callback can be called
2756 * synchronously from another thread, which allows faster multithreaded decoding.
2757 * draw_horiz_band() will be called from other threads regardless of this setting.
2758 * Ignored if the default get_buffer() is used.
2759 * - encoding: Set by user.
2760 * - decoding: Set by user.
2762 int thread_safe_callbacks;
2765 * The codec may call this to execute several independent things.
2766 * It will return only after finishing all tasks.
2767 * The user may replace this with some multithreaded implementation,
2768 * the default implementation will execute the parts serially.
2769 * @param count the number of things to execute
2770 * - encoding: Set by libavcodec, user can override.
2771 * - decoding: Set by libavcodec, user can override.
2773 int (*execute)(struct AVCodecContext *c, int (*func)(struct AVCodecContext *c2, void *arg), void *arg2, int *ret, int count, int size);
2776 * The codec may call this to execute several independent things.
2777 * It will return only after finishing all tasks.
2778 * The user may replace this with some multithreaded implementation,
2779 * the default implementation will execute the parts serially.
2780 * Also see avcodec_thread_init and e.g. the --enable-pthread configure option.
2781 * @param c context passed also to func
2782 * @param count the number of things to execute
2783 * @param arg2 argument passed unchanged to func
2784 * @param ret return values of executed functions, must have space for "count" values. May be NULL.
2785 * @param func function that will be called count times, with jobnr from 0 to count-1.
2786 * threadnr will be in the range 0 to c->thread_count-1 < MAX_THREADS and so that no
2787 * two instances of func executing at the same time will have the same threadnr.
2788 * @return always 0 currently, but code should handle a future improvement where when any call to func
2789 * returns < 0 no further calls to func may be done and < 0 is returned.
2790 * - encoding: Set by libavcodec, user can override.
2791 * - decoding: Set by libavcodec, user can override.
2793 int (*execute2)(struct AVCodecContext *c, int (*func)(struct AVCodecContext *c2, void *arg, int jobnr, int threadnr), void *arg2, int *ret, int count);
2795 #if FF_API_THREAD_OPAQUE
2797 * @deprecated this field should not be used from outside of lavc
2799 attribute_deprecated
2800 void *thread_opaque;
2804 * noise vs. sse weight for the nsse comparison function
2805 * - encoding: Set by user.
2806 * - decoding: unused
2812 * - encoding: Set by user.
2813 * - decoding: Set by libavcodec.
2816 #define FF_PROFILE_UNKNOWN -99
2817 #define FF_PROFILE_RESERVED -100
2819 #define FF_PROFILE_AAC_MAIN 0
2820 #define FF_PROFILE_AAC_LOW 1
2821 #define FF_PROFILE_AAC_SSR 2
2822 #define FF_PROFILE_AAC_LTP 3
2823 #define FF_PROFILE_AAC_HE 4
2824 #define FF_PROFILE_AAC_HE_V2 28
2825 #define FF_PROFILE_AAC_LD 22
2826 #define FF_PROFILE_AAC_ELD 38
2827 #define FF_PROFILE_MPEG2_AAC_LOW 128
2828 #define FF_PROFILE_MPEG2_AAC_HE 131
2830 #define FF_PROFILE_DTS 20
2831 #define FF_PROFILE_DTS_ES 30
2832 #define FF_PROFILE_DTS_96_24 40
2833 #define FF_PROFILE_DTS_HD_HRA 50
2834 #define FF_PROFILE_DTS_HD_MA 60
2836 #define FF_PROFILE_MPEG2_422 0
2837 #define FF_PROFILE_MPEG2_HIGH 1
2838 #define FF_PROFILE_MPEG2_SS 2
2839 #define FF_PROFILE_MPEG2_SNR_SCALABLE 3
2840 #define FF_PROFILE_MPEG2_MAIN 4
2841 #define FF_PROFILE_MPEG2_SIMPLE 5
2843 #define FF_PROFILE_H264_CONSTRAINED (1<<9) // 8+1; constraint_set1_flag
2844 #define FF_PROFILE_H264_INTRA (1<<11) // 8+3; constraint_set3_flag
2846 #define FF_PROFILE_H264_BASELINE 66
2847 #define FF_PROFILE_H264_CONSTRAINED_BASELINE (66|FF_PROFILE_H264_CONSTRAINED)
2848 #define FF_PROFILE_H264_MAIN 77
2849 #define FF_PROFILE_H264_EXTENDED 88
2850 #define FF_PROFILE_H264_HIGH 100
2851 #define FF_PROFILE_H264_HIGH_10 110
2852 #define FF_PROFILE_H264_HIGH_10_INTRA (110|FF_PROFILE_H264_INTRA)
2853 #define FF_PROFILE_H264_HIGH_422 122
2854 #define FF_PROFILE_H264_HIGH_422_INTRA (122|FF_PROFILE_H264_INTRA)
2855 #define FF_PROFILE_H264_HIGH_444 144
2856 #define FF_PROFILE_H264_HIGH_444_PREDICTIVE 244
2857 #define FF_PROFILE_H264_HIGH_444_INTRA (244|FF_PROFILE_H264_INTRA)
2858 #define FF_PROFILE_H264_CAVLC_444 44
2860 #define FF_PROFILE_VC1_SIMPLE 0
2861 #define FF_PROFILE_VC1_MAIN 1
2862 #define FF_PROFILE_VC1_COMPLEX 2
2863 #define FF_PROFILE_VC1_ADVANCED 3
2865 #define FF_PROFILE_MPEG4_SIMPLE 0
2866 #define FF_PROFILE_MPEG4_SIMPLE_SCALABLE 1
2867 #define FF_PROFILE_MPEG4_CORE 2
2868 #define FF_PROFILE_MPEG4_MAIN 3
2869 #define FF_PROFILE_MPEG4_N_BIT 4
2870 #define FF_PROFILE_MPEG4_SCALABLE_TEXTURE 5
2871 #define FF_PROFILE_MPEG4_SIMPLE_FACE_ANIMATION 6
2872 #define FF_PROFILE_MPEG4_BASIC_ANIMATED_TEXTURE 7
2873 #define FF_PROFILE_MPEG4_HYBRID 8
2874 #define FF_PROFILE_MPEG4_ADVANCED_REAL_TIME 9
2875 #define FF_PROFILE_MPEG4_CORE_SCALABLE 10
2876 #define FF_PROFILE_MPEG4_ADVANCED_CODING 11
2877 #define FF_PROFILE_MPEG4_ADVANCED_CORE 12
2878 #define FF_PROFILE_MPEG4_ADVANCED_SCALABLE_TEXTURE 13
2879 #define FF_PROFILE_MPEG4_SIMPLE_STUDIO 14
2880 #define FF_PROFILE_MPEG4_ADVANCED_SIMPLE 15
2882 #define FF_PROFILE_JPEG2000_CSTREAM_RESTRICTION_0 0
2883 #define FF_PROFILE_JPEG2000_CSTREAM_RESTRICTION_1 1
2884 #define FF_PROFILE_JPEG2000_CSTREAM_NO_RESTRICTION 2
2885 #define FF_PROFILE_JPEG2000_DCINEMA_2K 3
2886 #define FF_PROFILE_JPEG2000_DCINEMA_4K 4
2889 #define FF_PROFILE_HEVC_MAIN 1
2890 #define FF_PROFILE_HEVC_MAIN_10 2
2891 #define FF_PROFILE_HEVC_MAIN_STILL_PICTURE 3
2892 #define FF_PROFILE_HEVC_REXT 4
2896 * - encoding: Set by user.
2897 * - decoding: Set by libavcodec.
2900 #define FF_LEVEL_UNKNOWN -99
2903 * Skip loop filtering for selected frames.
2904 * - encoding: unused
2905 * - decoding: Set by user.
2907 enum AVDiscard skip_loop_filter;
2910 * Skip IDCT/dequantization for selected frames.
2911 * - encoding: unused
2912 * - decoding: Set by user.
2914 enum AVDiscard skip_idct;
2917 * Skip decoding for selected frames.
2918 * - encoding: unused
2919 * - decoding: Set by user.
2921 enum AVDiscard skip_frame;
2924 * Header containing style information for text subtitles.
2925 * For SUBTITLE_ASS subtitle type, it should contain the whole ASS
2926 * [Script Info] and [V4+ Styles] section, plus the [Events] line and
2927 * the Format line following. It shouldn't include any Dialogue line.
2928 * - encoding: Set/allocated/freed by user (before avcodec_open2())
2929 * - decoding: Set/allocated/freed by libavcodec (by avcodec_open2())
2931 uint8_t *subtitle_header;
2932 int subtitle_header_size;
2934 #if FF_API_ERROR_RATE
2936 * @deprecated use the 'error_rate' private AVOption of the mpegvideo
2939 attribute_deprecated
2943 #if FF_API_CODEC_PKT
2945 * @deprecated this field is not supposed to be accessed from outside lavc
2947 attribute_deprecated
2952 * VBV delay coded in the last frame (in periods of a 27 MHz clock).
2953 * Used for compliant TS muxing.
2954 * - encoding: Set by libavcodec.
2955 * - decoding: unused.
2960 * Encoding only. Allow encoders to output packets that do not contain any
2961 * encoded data, only side data.
2963 * Some encoders need to output such packets, e.g. to update some stream
2964 * parameters at the end of encoding.
2966 * All callers are strongly recommended to set this option to 1 and update
2967 * their code to deal with such packets, since this behaviour may become
2968 * always enabled in the future (then this option will be deprecated and
2969 * later removed). To avoid ABI issues when this happens, the callers should
2970 * use AVOptions to set this field.
2972 int side_data_only_packets;
2975 * Audio only. The number of "priming" samples (padding) inserted by the
2976 * encoder at the beginning of the audio. I.e. this number of leading
2977 * decoded samples must be discarded by the caller to get the original audio
2978 * without leading padding.
2980 * - decoding: unused
2981 * - encoding: Set by libavcodec. The timestamps on the output packets are
2982 * adjusted by the encoder so that they always refer to the
2983 * first sample of the data actually contained in the packet,
2984 * including any added padding. E.g. if the timebase is
2985 * 1/samplerate and the timestamp of the first input sample is
2986 * 0, the timestamp of the first output packet will be
2989 int initial_padding;
2992 * Timebase in which pkt_dts/pts and AVPacket.dts/pts are.
2993 * Code outside libavcodec should access this field using:
2994 * av_codec_{get,set}_pkt_timebase(avctx)
2995 * - encoding unused.
2996 * - decoding set by user.
2998 AVRational pkt_timebase;
3002 * Code outside libavcodec should access this field using:
3003 * av_codec_{get,set}_codec_descriptor(avctx)
3004 * - encoding: unused.
3005 * - decoding: set by libavcodec.
3007 const AVCodecDescriptor *codec_descriptor;
3011 * low resolution decoding, 1-> 1/2 size, 2->1/4 size
3012 * - encoding: unused
3013 * - decoding: Set by user.
3014 * Code outside libavcodec should access this field using:
3015 * av_codec_{get,set}_lowres(avctx)
3021 * Current statistics for PTS correction.
3022 * - decoding: maintained and used by libavcodec, not intended to be used by user apps
3023 * - encoding: unused
3025 int64_t pts_correction_num_faulty_pts; /// Number of incorrect PTS values so far
3026 int64_t pts_correction_num_faulty_dts; /// Number of incorrect DTS values so far
3027 int64_t pts_correction_last_pts; /// PTS of the last frame
3028 int64_t pts_correction_last_dts; /// DTS of the last frame
3031 * Character encoding of the input subtitles file.
3032 * - decoding: set by user
3033 * - encoding: unused
3038 * Subtitles character encoding mode. Formats or codecs might be adjusting
3039 * this setting (if they are doing the conversion themselves for instance).
3040 * - decoding: set by libavcodec
3041 * - encoding: unused
3043 int sub_charenc_mode;
3044 #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)
3045 #define FF_SUB_CHARENC_MODE_AUTOMATIC 0 ///< libavcodec will select the mode itself
3046 #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
3049 * Skip processing alpha if supported by codec.
3050 * Note that if the format uses pre-multiplied alpha (common with VP6,
3051 * and recommended due to better video quality/compression)
3052 * the image will look as if alpha-blended onto a black background.
3053 * However for formats that do not use pre-multiplied alpha
3054 * there might be serious artefacts (though e.g. libswscale currently
3055 * assumes pre-multiplied alpha anyway).
3056 * Code outside libavcodec should access this field using AVOptions
3058 * - decoding: set by user
3059 * - encoding: unused
3064 * Number of samples to skip after a discontinuity
3065 * - decoding: unused
3066 * - encoding: set by libavcodec
3070 #if !FF_API_DEBUG_MV
3072 * debug motion vectors
3073 * Code outside libavcodec should access this field using AVOptions
3074 * - encoding: Set by user.
3075 * - decoding: Set by user.
3078 #define FF_DEBUG_VIS_MV_P_FOR 0x00000001 //visualize forward predicted MVs of P frames
3079 #define FF_DEBUG_VIS_MV_B_FOR 0x00000002 //visualize forward predicted MVs of B frames
3080 #define FF_DEBUG_VIS_MV_B_BACK 0x00000004 //visualize backward predicted MVs of B frames
3084 * custom intra quantization matrix
3085 * Code outside libavcodec should access this field using av_codec_g/set_chroma_intra_matrix()
3086 * - encoding: Set by user, can be NULL.
3087 * - decoding: unused.
3089 uint16_t *chroma_intra_matrix;
3092 * dump format separator.
3093 * can be ", " or "\n " or anything else
3094 * Code outside libavcodec should access this field using AVOptions
3095 * (NO direct access).
3096 * - encoding: Set by user.
3097 * - decoding: Set by user.
3099 uint8_t *dump_separator;
3103 AVRational av_codec_get_pkt_timebase (const AVCodecContext *avctx);
3104 void av_codec_set_pkt_timebase (AVCodecContext *avctx, AVRational val);
3106 const AVCodecDescriptor *av_codec_get_codec_descriptor(const AVCodecContext *avctx);
3107 void av_codec_set_codec_descriptor(AVCodecContext *avctx, const AVCodecDescriptor *desc);
3109 int av_codec_get_lowres(const AVCodecContext *avctx);
3110 void av_codec_set_lowres(AVCodecContext *avctx, int val);
3112 int av_codec_get_seek_preroll(const AVCodecContext *avctx);
3113 void av_codec_set_seek_preroll(AVCodecContext *avctx, int val);
3115 uint16_t *av_codec_get_chroma_intra_matrix(const AVCodecContext *avctx);
3116 void av_codec_set_chroma_intra_matrix(AVCodecContext *avctx, uint16_t *val);
3121 typedef struct AVProfile {
3123 const char *name; ///< short name for the profile
3126 typedef struct AVCodecDefault AVCodecDefault;
3133 typedef struct AVCodec {
3135 * Name of the codec implementation.
3136 * The name is globally unique among encoders and among decoders (but an
3137 * encoder and a decoder can share the same name).
3138 * This is the primary way to find a codec from the user perspective.
3142 * Descriptive name for the codec, meant to be more human readable than name.
3143 * You should use the NULL_IF_CONFIG_SMALL() macro to define it.
3145 const char *long_name;
3146 enum AVMediaType type;
3149 * Codec capabilities.
3153 const AVRational *supported_framerates; ///< array of supported framerates, or NULL if any, array is terminated by {0,0}
3154 const enum AVPixelFormat *pix_fmts; ///< array of supported pixel formats, or NULL if unknown, array is terminated by -1
3155 const int *supported_samplerates; ///< array of supported audio samplerates, or NULL if unknown, array is terminated by 0
3156 const enum AVSampleFormat *sample_fmts; ///< array of supported sample formats, or NULL if unknown, array is terminated by -1
3157 const uint64_t *channel_layouts; ///< array of support channel layouts, or NULL if unknown. array is terminated by 0
3159 uint8_t max_lowres; ///< maximum value for lowres supported by the decoder, no direct access, use av_codec_get_max_lowres()
3161 const AVClass *priv_class; ///< AVClass for the private context
3162 const AVProfile *profiles; ///< array of recognized profiles, or NULL if unknown, array is terminated by {FF_PROFILE_UNKNOWN}
3164 /*****************************************************************
3165 * No fields below this line are part of the public API. They
3166 * may not be used outside of libavcodec and can be changed and
3168 * New public fields should be added right above.
3169 *****************************************************************
3172 struct AVCodec *next;
3174 * @name Frame-level threading support functions
3178 * If defined, called on thread contexts when they are created.
3179 * If the codec allocates writable tables in init(), re-allocate them here.
3180 * priv_data will be set to a copy of the original.
3182 int (*init_thread_copy)(AVCodecContext *);
3184 * Copy necessary context variables from a previous thread context to the current one.
3185 * If not defined, the next thread will start automatically; otherwise, the codec
3186 * must call ff_thread_finish_setup().
3188 * dst and src will (rarely) point to the same context, in which case memcpy should be skipped.
3190 int (*update_thread_context)(AVCodecContext *dst, const AVCodecContext *src);
3194 * Private codec-specific defaults.
3196 const AVCodecDefault *defaults;
3199 * Initialize codec static data, called from avcodec_register().
3201 void (*init_static_data)(struct AVCodec *codec);
3203 int (*init)(AVCodecContext *);
3204 int (*encode_sub)(AVCodecContext *, uint8_t *buf, int buf_size,
3205 const struct AVSubtitle *sub);
3207 * Encode data to an AVPacket.
3209 * @param avctx codec context
3210 * @param avpkt output AVPacket (may contain a user-provided buffer)
3211 * @param[in] frame AVFrame containing the raw data to be encoded
3212 * @param[out] got_packet_ptr encoder sets to 0 or 1 to indicate that a
3213 * non-empty packet was returned in avpkt.
3214 * @return 0 on success, negative error code on failure
3216 int (*encode2)(AVCodecContext *avctx, AVPacket *avpkt, const AVFrame *frame,
3217 int *got_packet_ptr);
3218 int (*decode)(AVCodecContext *, void *outdata, int *outdata_size, AVPacket *avpkt);
3219 int (*close)(AVCodecContext *);
3222 * Will be called when seeking
3224 void (*flush)(AVCodecContext *);
3227 int av_codec_get_max_lowres(const AVCodec *codec);
3229 struct MpegEncContext;
3232 * @defgroup lavc_hwaccel AVHWAccel
3235 typedef struct AVHWAccel {
3237 * Name of the hardware accelerated codec.
3238 * The name is globally unique among encoders and among decoders (but an
3239 * encoder and a decoder can share the same name).
3244 * Type of codec implemented by the hardware accelerator.
3246 * See AVMEDIA_TYPE_xxx
3248 enum AVMediaType type;
3251 * Codec implemented by the hardware accelerator.
3253 * See AV_CODEC_ID_xxx
3258 * Supported pixel format.
3260 * Only hardware accelerated formats are supported here.
3262 enum AVPixelFormat pix_fmt;
3265 * Hardware accelerated codec capabilities.
3266 * see FF_HWACCEL_CODEC_CAP_*
3270 /*****************************************************************
3271 * No fields below this line are part of the public API. They
3272 * may not be used outside of libavcodec and can be changed and
3274 * New public fields should be added right above.
3275 *****************************************************************
3277 struct AVHWAccel *next;
3280 * Allocate a custom buffer
3282 int (*alloc_frame)(AVCodecContext *avctx, AVFrame *frame);
3285 * Called at the beginning of each frame or field picture.
3287 * Meaningful frame information (codec specific) is guaranteed to
3288 * be parsed at this point. This function is mandatory.
3290 * Note that buf can be NULL along with buf_size set to 0.
3291 * Otherwise, this means the whole frame is available at this point.
3293 * @param avctx the codec context
3294 * @param buf the frame data buffer base
3295 * @param buf_size the size of the frame in bytes
3296 * @return zero if successful, a negative value otherwise
3298 int (*start_frame)(AVCodecContext *avctx, const uint8_t *buf, uint32_t buf_size);
3301 * Callback for each slice.
3303 * Meaningful slice information (codec specific) is guaranteed to
3304 * be parsed at this point. This function is mandatory.
3305 * The only exception is XvMC, that works on MB level.
3307 * @param avctx the codec context
3308 * @param buf the slice data buffer base
3309 * @param buf_size the size of the slice in bytes
3310 * @return zero if successful, a negative value otherwise
3312 int (*decode_slice)(AVCodecContext *avctx, const uint8_t *buf, uint32_t buf_size);
3315 * Called at the end of each frame or field picture.
3317 * The whole picture is parsed at this point and can now be sent
3318 * to the hardware accelerator. This function is mandatory.
3320 * @param avctx the codec context
3321 * @return zero if successful, a negative value otherwise
3323 int (*end_frame)(AVCodecContext *avctx);
3326 * Size of per-frame hardware accelerator private data.
3328 * Private data is allocated with av_mallocz() before
3329 * AVCodecContext.get_buffer() and deallocated after
3330 * AVCodecContext.release_buffer().
3332 int frame_priv_data_size;
3335 * Called for every Macroblock in a slice.
3337 * XvMC uses it to replace the ff_mpv_decode_mb().
3338 * Instead of decoding to raw picture, MB parameters are
3339 * stored in an array provided by the video driver.
3341 * @param s the mpeg context
3343 void (*decode_mb)(struct MpegEncContext *s);
3346 * Initialize the hwaccel private data.
3348 * This will be called from ff_get_format(), after hwaccel and
3349 * hwaccel_context are set and the hwaccel private data in AVCodecInternal
3352 int (*init)(AVCodecContext *avctx);
3355 * Uninitialize the hwaccel private data.
3357 * This will be called from get_format() or avcodec_close(), after hwaccel
3358 * and hwaccel_context are already uninitialized.
3360 int (*uninit)(AVCodecContext *avctx);
3363 * Size of the private data to allocate in
3364 * AVCodecInternal.hwaccel_priv_data.
3370 * Hardware acceleration should be used for decoding even if the codec level
3371 * used is unknown or higher than the maximum supported level reported by the
3374 #define AV_HWACCEL_FLAG_IGNORE_LEVEL (1 << 0)
3381 * @defgroup lavc_picture AVPicture
3383 * Functions for working with AVPicture
3388 * Picture data structure.
3390 * Up to four components can be stored into it, the last component is
3393 typedef struct AVPicture {
3394 uint8_t *data[AV_NUM_DATA_POINTERS]; ///< pointers to the image data planes
3395 int linesize[AV_NUM_DATA_POINTERS]; ///< number of bytes per line
3402 enum AVSubtitleType {
3405 SUBTITLE_BITMAP, ///< A bitmap, pict will be set
3408 * Plain text, the text field must be set by the decoder and is
3409 * authoritative. ass and pict fields may contain approximations.
3414 * Formatted text, the ass field must be set by the decoder and is
3415 * authoritative. pict and text fields may contain approximations.
3420 #define AV_SUBTITLE_FLAG_FORCED 0x00000001
3422 typedef struct AVSubtitleRect {
3423 int x; ///< top left corner of pict, undefined when pict is not set
3424 int y; ///< top left corner of pict, undefined when pict is not set
3425 int w; ///< width of pict, undefined when pict is not set
3426 int h; ///< height of pict, undefined when pict is not set
3427 int nb_colors; ///< number of colors in pict, undefined when pict is not set
3430 * data+linesize for the bitmap of this subtitle.
3431 * can be set for text/ass as well once they where rendered
3434 enum AVSubtitleType type;
3436 char *text; ///< 0 terminated plain UTF-8 text
3439 * 0 terminated ASS/SSA compatible event line.
3440 * The presentation of this is unaffected by the other values in this
3448 typedef struct AVSubtitle {
3449 uint16_t format; /* 0 = graphics */
3450 uint32_t start_display_time; /* relative to packet pts, in ms */
3451 uint32_t end_display_time; /* relative to packet pts, in ms */
3453 AVSubtitleRect **rects;
3454 int64_t pts; ///< Same as packet pts, in AV_TIME_BASE
3458 * If c is NULL, returns the first registered codec,
3459 * if c is non-NULL, returns the next registered codec after c,
3460 * or NULL if c is the last one.
3462 AVCodec *av_codec_next(const AVCodec *c);
3465 * Return the LIBAVCODEC_VERSION_INT constant.
3467 unsigned avcodec_version(void);
3470 * Return the libavcodec build-time configuration.
3472 const char *avcodec_configuration(void);
3475 * Return the libavcodec license.
3477 const char *avcodec_license(void);
3480 * Register the codec codec and initialize libavcodec.
3482 * @warning either this function or avcodec_register_all() must be called
3483 * before any other libavcodec functions.
3485 * @see avcodec_register_all()
3487 void avcodec_register(AVCodec *codec);
3490 * Register all the codecs, parsers and bitstream filters which were enabled at
3491 * configuration time. If you do not call this function you can select exactly
3492 * which formats you want to support, by using the individual registration
3495 * @see avcodec_register
3496 * @see av_register_codec_parser
3497 * @see av_register_bitstream_filter
3499 void avcodec_register_all(void);
3502 * Allocate an AVCodecContext and set its fields to default values. The
3503 * resulting struct should be freed with avcodec_free_context().
3505 * @param codec if non-NULL, allocate private data and initialize defaults
3506 * for the given codec. It is illegal to then call avcodec_open2()
3507 * with a different codec.
3508 * If NULL, then the codec-specific defaults won't be initialized,
3509 * which may result in suboptimal default settings (this is
3510 * important mainly for encoders, e.g. libx264).
3512 * @return An AVCodecContext filled with default values or NULL on failure.
3513 * @see avcodec_get_context_defaults
3515 AVCodecContext *avcodec_alloc_context3(const AVCodec *codec);
3518 * Free the codec context and everything associated with it and write NULL to
3519 * the provided pointer.
3521 void avcodec_free_context(AVCodecContext **avctx);
3524 * Set the fields of the given AVCodecContext to default values corresponding
3525 * to the given codec (defaults may be codec-dependent).
3527 * Do not call this function if a non-NULL codec has been passed
3528 * to avcodec_alloc_context3() that allocated this AVCodecContext.
3529 * If codec is non-NULL, it is illegal to call avcodec_open2() with a
3530 * different codec on this AVCodecContext.
3532 int avcodec_get_context_defaults3(AVCodecContext *s, const AVCodec *codec);
3535 * Get the AVClass for AVCodecContext. It can be used in combination with
3536 * AV_OPT_SEARCH_FAKE_OBJ for examining options.
3538 * @see av_opt_find().
3540 const AVClass *avcodec_get_class(void);
3543 * Get the AVClass for AVFrame. It can be used in combination with
3544 * AV_OPT_SEARCH_FAKE_OBJ for examining options.
3546 * @see av_opt_find().
3548 const AVClass *avcodec_get_frame_class(void);
3551 * Get the AVClass for AVSubtitleRect. It can be used in combination with
3552 * AV_OPT_SEARCH_FAKE_OBJ for examining options.
3554 * @see av_opt_find().
3556 const AVClass *avcodec_get_subtitle_rect_class(void);
3559 * Copy the settings of the source AVCodecContext into the destination
3560 * AVCodecContext. The resulting destination codec context will be
3561 * unopened, i.e. you are required to call avcodec_open2() before you
3562 * can use this AVCodecContext to decode/encode video/audio data.
3564 * @param dest target codec context, should be initialized with
3565 * avcodec_alloc_context3(NULL), but otherwise uninitialized
3566 * @param src source codec context
3567 * @return AVERROR() on error (e.g. memory allocation error), 0 on success
3569 int avcodec_copy_context(AVCodecContext *dest, const AVCodecContext *src);
3571 #if FF_API_AVFRAME_LAVC
3573 * @deprecated use av_frame_alloc()
3575 attribute_deprecated
3576 AVFrame *avcodec_alloc_frame(void);
3579 * Set the fields of the given AVFrame to default values.
3581 * @param frame The AVFrame of which the fields should be set to default values.
3583 * @deprecated use av_frame_unref()
3585 attribute_deprecated
3586 void avcodec_get_frame_defaults(AVFrame *frame);
3589 * Free the frame and any dynamically allocated objects in it,
3590 * e.g. extended_data.
3592 * @param frame frame to be freed. The pointer will be set to NULL.
3594 * @warning this function does NOT free the data buffers themselves
3595 * (it does not know how, since they might have been allocated with
3596 * a custom get_buffer()).
3598 * @deprecated use av_frame_free()
3600 attribute_deprecated
3601 void avcodec_free_frame(AVFrame **frame);
3605 * Initialize the AVCodecContext to use the given AVCodec. Prior to using this
3606 * function the context has to be allocated with avcodec_alloc_context3().
3608 * The functions avcodec_find_decoder_by_name(), avcodec_find_encoder_by_name(),
3609 * avcodec_find_decoder() and avcodec_find_encoder() provide an easy way for
3610 * retrieving a codec.
3612 * @warning This function is not thread safe!
3615 * avcodec_register_all();
3616 * av_dict_set(&opts, "b", "2.5M", 0);
3617 * codec = avcodec_find_decoder(AV_CODEC_ID_H264);
3621 * context = avcodec_alloc_context3(codec);
3623 * if (avcodec_open2(context, codec, opts) < 0)
3627 * @param avctx The context to initialize.
3628 * @param codec The codec to open this context for. If a non-NULL codec has been
3629 * previously passed to avcodec_alloc_context3() or
3630 * avcodec_get_context_defaults3() for this context, then this
3631 * parameter MUST be either NULL or equal to the previously passed
3633 * @param options A dictionary filled with AVCodecContext and codec-private options.
3634 * On return this object will be filled with options that were not found.
3636 * @return zero on success, a negative value on error
3637 * @see avcodec_alloc_context3(), avcodec_find_decoder(), avcodec_find_encoder(),
3638 * av_dict_set(), av_opt_find().
3640 int avcodec_open2(AVCodecContext *avctx, const AVCodec *codec, AVDictionary **options);
3643 * Close a given AVCodecContext and free all the data associated with it
3644 * (but not the AVCodecContext itself).
3646 * Calling this function on an AVCodecContext that hasn't been opened will free
3647 * the codec-specific data allocated in avcodec_alloc_context3() /
3648 * avcodec_get_context_defaults3() with a non-NULL codec. Subsequent calls will
3651 int avcodec_close(AVCodecContext *avctx);
3654 * Free all allocated data in the given subtitle struct.
3656 * @param sub AVSubtitle to free.
3658 void avsubtitle_free(AVSubtitle *sub);
3665 * @addtogroup lavc_packet
3669 #if FF_API_DESTRUCT_PACKET
3671 * Default packet destructor.
3672 * @deprecated use the AVBuffer API instead
3674 attribute_deprecated
3675 void av_destruct_packet(AVPacket *pkt);
3679 * Initialize optional fields of a packet with default values.
3681 * Note, this does not touch the data and size members, which have to be
3682 * initialized separately.
3686 void av_init_packet(AVPacket *pkt);
3689 * Allocate the payload of a packet and initialize its fields with
3693 * @param size wanted payload size
3694 * @return 0 if OK, AVERROR_xxx otherwise
3696 int av_new_packet(AVPacket *pkt, int size);
3699 * Reduce packet size, correctly zeroing padding
3702 * @param size new size
3704 void av_shrink_packet(AVPacket *pkt, int size);
3707 * Increase packet size, correctly zeroing padding
3710 * @param grow_by number of bytes by which to increase the size of the packet
3712 int av_grow_packet(AVPacket *pkt, int grow_by);
3715 * Initialize a reference-counted packet from av_malloc()ed data.
3717 * @param pkt packet to be initialized. This function will set the data, size,
3718 * buf and destruct fields, all others are left untouched.
3719 * @param data Data allocated by av_malloc() to be used as packet data. If this
3720 * function returns successfully, the data is owned by the underlying AVBuffer.
3721 * The caller may not access the data through other means.
3722 * @param size size of data in bytes, without the padding. I.e. the full buffer
3723 * size is assumed to be size + FF_INPUT_BUFFER_PADDING_SIZE.
3725 * @return 0 on success, a negative AVERROR on error
3727 int av_packet_from_data(AVPacket *pkt, uint8_t *data, int size);
3730 * @warning This is a hack - the packet memory allocation stuff is broken. The
3731 * packet is allocated if it was not really allocated.
3733 int av_dup_packet(AVPacket *pkt);
3736 * Copy packet, including contents
3738 * @return 0 on success, negative AVERROR on fail
3740 int av_copy_packet(AVPacket *dst, const AVPacket *src);
3743 * Copy packet side data
3745 * @return 0 on success, negative AVERROR on fail
3747 int av_copy_packet_side_data(AVPacket *dst, const AVPacket *src);
3752 * @param pkt packet to free
3754 void av_free_packet(AVPacket *pkt);
3757 * Allocate new information of a packet.
3760 * @param type side information type
3761 * @param size side information size
3762 * @return pointer to fresh allocated data or NULL otherwise
3764 uint8_t* av_packet_new_side_data(AVPacket *pkt, enum AVPacketSideDataType type,
3768 * Shrink the already allocated side data buffer
3771 * @param type side information type
3772 * @param size new side information size
3773 * @return 0 on success, < 0 on failure
3775 int av_packet_shrink_side_data(AVPacket *pkt, enum AVPacketSideDataType type,
3779 * Get side information from packet.
3782 * @param type desired side information type
3783 * @param size pointer for side information size to store (optional)
3784 * @return pointer to data if present or NULL otherwise
3786 uint8_t* av_packet_get_side_data(AVPacket *pkt, enum AVPacketSideDataType type,
3789 int av_packet_merge_side_data(AVPacket *pkt);
3791 int av_packet_split_side_data(AVPacket *pkt);
3794 * Pack a dictionary for use in side_data.
3796 * @param dict The dictionary to pack.
3797 * @param size pointer to store the size of the returned data
3798 * @return pointer to data if successful, NULL otherwise
3800 uint8_t *av_packet_pack_dictionary(AVDictionary *dict, int *size);
3802 * Unpack a dictionary from side_data.
3804 * @param data data from side_data
3805 * @param size size of the data
3806 * @param dict the metadata storage dictionary
3807 * @return 0 on success, < 0 on failure
3809 int av_packet_unpack_dictionary(const uint8_t *data, int size, AVDictionary **dict);
3813 * Convenience function to free all the side data stored.
3814 * All the other fields stay untouched.
3818 void av_packet_free_side_data(AVPacket *pkt);
3821 * Setup a new reference to the data described by a given packet
3823 * If src is reference-counted, setup dst as a new reference to the
3824 * buffer in src. Otherwise allocate a new buffer in dst and copy the
3825 * data from src into it.
3827 * All the other fields are copied from src.
3829 * @see av_packet_unref
3831 * @param dst Destination packet
3832 * @param src Source packet
3834 * @return 0 on success, a negative AVERROR on error.
3836 int av_packet_ref(AVPacket *dst, const AVPacket *src);
3841 * Unreference the buffer referenced by the packet and reset the
3842 * remaining packet fields to their default values.
3844 * @param pkt The packet to be unreferenced.
3846 void av_packet_unref(AVPacket *pkt);
3849 * Move every field in src to dst and reset src.
3851 * @see av_packet_unref
3853 * @param src Source packet, will be reset
3854 * @param dst Destination packet
3856 void av_packet_move_ref(AVPacket *dst, AVPacket *src);
3859 * Copy only "properties" fields from src to dst.
3861 * Properties for the purpose of this function are all the fields
3862 * beside those related to the packet data (buf, data, size)
3864 * @param dst Destination packet
3865 * @param src Source packet
3867 * @return 0 on success AVERROR on failure.
3870 int av_packet_copy_props(AVPacket *dst, const AVPacket *src);
3873 * Convert valid timing fields (timestamps / durations) in a packet from one
3874 * timebase to another. Timestamps with unknown values (AV_NOPTS_VALUE) will be
3877 * @param pkt packet on which the conversion will be performed
3878 * @param tb_src source timebase, in which the timing fields in pkt are
3880 * @param tb_dst destination timebase, to which the timing fields will be
3883 void av_packet_rescale_ts(AVPacket *pkt, AVRational tb_src, AVRational tb_dst);
3890 * @addtogroup lavc_decoding
3895 * Find a registered decoder with a matching codec ID.
3897 * @param id AVCodecID of the requested decoder
3898 * @return A decoder if one was found, NULL otherwise.
3900 AVCodec *avcodec_find_decoder(enum AVCodecID id);
3903 * Find a registered decoder with the specified name.
3905 * @param name name of the requested decoder
3906 * @return A decoder if one was found, NULL otherwise.
3908 AVCodec *avcodec_find_decoder_by_name(const char *name);
3910 #if FF_API_GET_BUFFER
3911 attribute_deprecated int avcodec_default_get_buffer(AVCodecContext *s, AVFrame *pic);
3912 attribute_deprecated void avcodec_default_release_buffer(AVCodecContext *s, AVFrame *pic);
3913 attribute_deprecated int avcodec_default_reget_buffer(AVCodecContext *s, AVFrame *pic);
3917 * The default callback for AVCodecContext.get_buffer2(). It is made public so
3918 * it can be called by custom get_buffer2() implementations for decoders without
3919 * CODEC_CAP_DR1 set.
3921 int avcodec_default_get_buffer2(AVCodecContext *s, AVFrame *frame, int flags);
3925 * Return the amount of padding in pixels which the get_buffer callback must
3926 * provide around the edge of the image for codecs which do not have the
3927 * CODEC_FLAG_EMU_EDGE flag.
3929 * @return Required padding in pixels.
3931 * @deprecated CODEC_FLAG_EMU_EDGE is deprecated, so this function is no longer
3934 attribute_deprecated
3935 unsigned avcodec_get_edge_width(void);
3939 * Modify width and height values so that they will result in a memory
3940 * buffer that is acceptable for the codec if you do not use any horizontal
3943 * May only be used if a codec with CODEC_CAP_DR1 has been opened.
3945 void avcodec_align_dimensions(AVCodecContext *s, int *width, int *height);
3948 * Modify width and height values so that they will result in a memory
3949 * buffer that is acceptable for the codec if you also ensure that all
3950 * line sizes are a multiple of the respective linesize_align[i].
3952 * May only be used if a codec with CODEC_CAP_DR1 has been opened.
3954 void avcodec_align_dimensions2(AVCodecContext *s, int *width, int *height,
3955 int linesize_align[AV_NUM_DATA_POINTERS]);
3958 * Converts AVChromaLocation to swscale x/y chroma position.
3960 * The positions represent the chroma (0,0) position in a coordinates system
3961 * with luma (0,0) representing the origin and luma(1,1) representing 256,256
3963 * @param xpos horizontal chroma sample position
3964 * @param ypos vertical chroma sample position
3966 int avcodec_enum_to_chroma_pos(int *xpos, int *ypos, enum AVChromaLocation pos);
3969 * Converts swscale x/y chroma position to AVChromaLocation.
3971 * The positions represent the chroma (0,0) position in a coordinates system
3972 * with luma (0,0) representing the origin and luma(1,1) representing 256,256
3974 * @param xpos horizontal chroma sample position
3975 * @param ypos vertical chroma sample position
3977 enum AVChromaLocation avcodec_chroma_pos_to_enum(int xpos, int ypos);
3979 #if FF_API_OLD_DECODE_AUDIO
3981 * Wrapper function which calls avcodec_decode_audio4.
3983 * @deprecated Use avcodec_decode_audio4 instead.
3985 * Decode the audio frame of size avpkt->size from avpkt->data into samples.
3986 * Some decoders may support multiple frames in a single AVPacket, such
3987 * decoders would then just decode the first frame. In this case,
3988 * avcodec_decode_audio3 has to be called again with an AVPacket that contains
3989 * the remaining data in order to decode the second frame etc.
3991 * could be outputted, frame_size_ptr is zero. Otherwise, it is the
3992 * decompressed frame size in bytes.
3994 * @warning You must set frame_size_ptr to the allocated size of the
3995 * output buffer before calling avcodec_decode_audio3().
3997 * @warning The input buffer must be FF_INPUT_BUFFER_PADDING_SIZE larger than
3998 * the actual read bytes because some optimized bitstream readers read 32 or 64
3999 * bits at once and could read over the end.
4001 * @warning The end of the input buffer avpkt->data should be set to 0 to ensure that
4002 * no overreading happens for damaged MPEG streams.
4004 * @warning You must not provide a custom get_buffer() when using
4005 * avcodec_decode_audio3(). Doing so will override it with
4006 * avcodec_default_get_buffer. Use avcodec_decode_audio4() instead,
4007 * which does allow the application to provide a custom get_buffer().
4009 * @note You might have to align the input buffer avpkt->data and output buffer
4010 * samples. The alignment requirements depend on the CPU: On some CPUs it isn't
4011 * necessary at all, on others it won't work at all if not aligned and on others
4012 * it will work but it will have an impact on performance.
4014 * In practice, avpkt->data should have 4 byte alignment at minimum and
4015 * samples should be 16 byte aligned unless the CPU doesn't need it
4016 * (AltiVec and SSE do).
4018 * @note Codecs which have the CODEC_CAP_DELAY capability set have a delay
4019 * between input and output, these need to be fed with avpkt->data=NULL,
4020 * avpkt->size=0 at the end to return the remaining frames.
4022 * @param avctx the codec context
4023 * @param[out] samples the output buffer, sample type in avctx->sample_fmt
4024 * If the sample format is planar, each channel plane will
4025 * be the same size, with no padding between channels.
4026 * @param[in,out] frame_size_ptr the output buffer size in bytes
4027 * @param[in] avpkt The input AVPacket containing the input buffer.
4028 * You can create such packet with av_init_packet() and by then setting
4029 * data and size, some decoders might in addition need other fields.
4030 * All decoders are designed to use the least fields possible though.
4031 * @return On error a negative value is returned, otherwise the number of bytes
4032 * used or zero if no frame data was decompressed (used) from the input AVPacket.
4034 attribute_deprecated int avcodec_decode_audio3(AVCodecContext *avctx, int16_t *samples,
4035 int *frame_size_ptr,
4040 * Decode the audio frame of size avpkt->size from avpkt->data into frame.
4042 * Some decoders may support multiple frames in a single AVPacket. Such
4043 * decoders would then just decode the first frame and the return value would be
4044 * less than the packet size. In this case, avcodec_decode_audio4 has to be
4045 * called again with an AVPacket containing the remaining data in order to
4046 * decode the second frame, etc... Even if no frames are returned, the packet
4047 * needs to be fed to the decoder with remaining data until it is completely
4048 * consumed or an error occurs.
4050 * Some decoders (those marked with CODEC_CAP_DELAY) have a delay between input
4051 * and output. This means that for some packets they will not immediately
4052 * produce decoded output and need to be flushed at the end of decoding to get
4053 * all the decoded data. Flushing is done by calling this function with packets
4054 * with avpkt->data set to NULL and avpkt->size set to 0 until it stops
4055 * returning samples. It is safe to flush even those decoders that are not
4056 * marked with CODEC_CAP_DELAY, then no samples will be returned.
4058 * @warning The input buffer, avpkt->data must be FF_INPUT_BUFFER_PADDING_SIZE
4059 * larger than the actual read bytes because some optimized bitstream
4060 * readers read 32 or 64 bits at once and could read over the end.
4062 * @param avctx the codec context
4063 * @param[out] frame The AVFrame in which to store decoded audio samples.
4064 * The decoder will allocate a buffer for the decoded frame by
4065 * calling the AVCodecContext.get_buffer2() callback.
4066 * When AVCodecContext.refcounted_frames is set to 1, the frame is
4067 * reference counted and the returned reference belongs to the
4068 * caller. The caller must release the frame using av_frame_unref()
4069 * when the frame is no longer needed. The caller may safely write
4070 * to the frame if av_frame_is_writable() returns 1.
4071 * When AVCodecContext.refcounted_frames is set to 0, the returned
4072 * reference belongs to the decoder and is valid only until the
4073 * next call to this function or until closing or flushing the
4074 * decoder. The caller may not write to it.
4075 * @param[out] got_frame_ptr Zero if no frame could be decoded, otherwise it is
4076 * non-zero. Note that this field being set to zero
4077 * does not mean that an error has occurred. For
4078 * decoders with CODEC_CAP_DELAY set, no given decode
4079 * call is guaranteed to produce a frame.
4080 * @param[in] avpkt The input AVPacket containing the input buffer.
4081 * At least avpkt->data and avpkt->size should be set. Some
4082 * decoders might also require additional fields to be set.
4083 * @return A negative error code is returned if an error occurred during
4084 * decoding, otherwise the number of bytes consumed from the input
4085 * AVPacket is returned.
4087 int avcodec_decode_audio4(AVCodecContext *avctx, AVFrame *frame,
4088 int *got_frame_ptr, const AVPacket *avpkt);
4091 * Decode the video frame of size avpkt->size from avpkt->data into picture.
4092 * Some decoders may support multiple frames in a single AVPacket, such
4093 * decoders would then just decode the first frame.
4095 * @warning The input buffer must be FF_INPUT_BUFFER_PADDING_SIZE larger than
4096 * the actual read bytes because some optimized bitstream readers read 32 or 64
4097 * bits at once and could read over the end.
4099 * @warning The end of the input buffer buf should be set to 0 to ensure that
4100 * no overreading happens for damaged MPEG streams.
4102 * @note Codecs which have the CODEC_CAP_DELAY capability set have a delay
4103 * between input and output, these need to be fed with avpkt->data=NULL,
4104 * avpkt->size=0 at the end to return the remaining frames.
4106 * @param avctx the codec context
4107 * @param[out] picture The AVFrame in which the decoded video frame will be stored.
4108 * Use av_frame_alloc() to get an AVFrame. The codec will
4109 * allocate memory for the actual bitmap by calling the
4110 * AVCodecContext.get_buffer2() callback.
4111 * When AVCodecContext.refcounted_frames is set to 1, the frame is
4112 * reference counted and the returned reference belongs to the
4113 * caller. The caller must release the frame using av_frame_unref()
4114 * when the frame is no longer needed. The caller may safely write
4115 * to the frame if av_frame_is_writable() returns 1.
4116 * When AVCodecContext.refcounted_frames is set to 0, the returned
4117 * reference belongs to the decoder and is valid only until the
4118 * next call to this function or until closing or flushing the
4119 * decoder. The caller may not write to it.
4121 * @param[in] avpkt The input AVPacket containing the input buffer.
4122 * You can create such packet with av_init_packet() and by then setting
4123 * data and size, some decoders might in addition need other fields like
4124 * flags&AV_PKT_FLAG_KEY. All decoders are designed to use the least
4126 * @param[in,out] got_picture_ptr Zero if no frame could be decompressed, otherwise, it is nonzero.
4127 * @return On error a negative value is returned, otherwise the number of bytes
4128 * used or zero if no frame could be decompressed.
4130 int avcodec_decode_video2(AVCodecContext *avctx, AVFrame *picture,
4131 int *got_picture_ptr,
4132 const AVPacket *avpkt);
4135 * Decode a subtitle message.
4136 * Return a negative value on error, otherwise return the number of bytes used.
4137 * If no subtitle could be decompressed, got_sub_ptr is zero.
4138 * Otherwise, the subtitle is stored in *sub.
4139 * Note that CODEC_CAP_DR1 is not available for subtitle codecs. This is for
4140 * simplicity, because the performance difference is expect to be negligible
4141 * and reusing a get_buffer written for video codecs would probably perform badly
4142 * due to a potentially very different allocation pattern.
4144 * Some decoders (those marked with CODEC_CAP_DELAY) have a delay between input
4145 * and output. This means that for some packets they will not immediately
4146 * produce decoded output and need to be flushed at the end of decoding to get
4147 * all the decoded data. Flushing is done by calling this function with packets
4148 * with avpkt->data set to NULL and avpkt->size set to 0 until it stops
4149 * returning subtitles. It is safe to flush even those decoders that are not
4150 * marked with CODEC_CAP_DELAY, then no subtitles will be returned.
4152 * @param avctx the codec context
4153 * @param[out] sub The Preallocated AVSubtitle in which the decoded subtitle will be stored,
4154 * must be freed with avsubtitle_free if *got_sub_ptr is set.
4155 * @param[in,out] got_sub_ptr Zero if no subtitle could be decompressed, otherwise, it is nonzero.
4156 * @param[in] avpkt The input AVPacket containing the input buffer.
4158 int avcodec_decode_subtitle2(AVCodecContext *avctx, AVSubtitle *sub,
4163 * @defgroup lavc_parsing Frame parsing
4167 enum AVPictureStructure {
4168 AV_PICTURE_STRUCTURE_UNKNOWN, //< unknown
4169 AV_PICTURE_STRUCTURE_TOP_FIELD, //< coded as top field
4170 AV_PICTURE_STRUCTURE_BOTTOM_FIELD, //< coded as bottom field
4171 AV_PICTURE_STRUCTURE_FRAME, //< coded as frame
4174 typedef struct AVCodecParserContext {
4176 struct AVCodecParser *parser;
4177 int64_t frame_offset; /* offset of the current frame */
4178 int64_t cur_offset; /* current offset
4179 (incremented by each av_parser_parse()) */
4180 int64_t next_frame_offset; /* offset of the next frame */
4182 int pict_type; /* XXX: Put it back in AVCodecContext. */
4184 * This field is used for proper frame duration computation in lavf.
4185 * It signals, how much longer the frame duration of the current frame
4186 * is compared to normal frame duration.
4188 * frame_duration = (1 + repeat_pict) * time_base
4190 * It is used by codecs like H.264 to display telecined material.
4192 int repeat_pict; /* XXX: Put it back in AVCodecContext. */
4193 int64_t pts; /* pts of the current frame */
4194 int64_t dts; /* dts of the current frame */
4199 int fetch_timestamp;
4201 #define AV_PARSER_PTS_NB 4
4202 int cur_frame_start_index;
4203 int64_t cur_frame_offset[AV_PARSER_PTS_NB];
4204 int64_t cur_frame_pts[AV_PARSER_PTS_NB];
4205 int64_t cur_frame_dts[AV_PARSER_PTS_NB];
4208 #define PARSER_FLAG_COMPLETE_FRAMES 0x0001
4209 #define PARSER_FLAG_ONCE 0x0002
4210 /// Set if the parser has a valid file offset
4211 #define PARSER_FLAG_FETCHED_OFFSET 0x0004
4212 #define PARSER_FLAG_USE_CODEC_TS 0x1000
4214 int64_t offset; ///< byte offset from starting packet start
4215 int64_t cur_frame_end[AV_PARSER_PTS_NB];
4218 * Set by parser to 1 for key frames and 0 for non-key frames.
4219 * It is initialized to -1, so if the parser doesn't set this flag,
4220 * old-style fallback using AV_PICTURE_TYPE_I picture type as key frames
4226 * Time difference in stream time base units from the pts of this
4227 * packet to the point at which the output from the decoder has converged
4228 * independent from the availability of previous frames. That is, the
4229 * frames are virtually identical no matter if decoding started from
4230 * the very first frame or from this keyframe.
4231 * Is AV_NOPTS_VALUE if unknown.
4232 * This field is not the display duration of the current frame.
4233 * This field has no meaning if the packet does not have AV_PKT_FLAG_KEY
4236 * The purpose of this field is to allow seeking in streams that have no
4237 * keyframes in the conventional sense. It corresponds to the
4238 * recovery point SEI in H.264 and match_time_delta in NUT. It is also
4239 * essential for some types of subtitle streams to ensure that all
4240 * subtitles are correctly displayed after seeking.
4242 int64_t convergence_duration;
4244 // Timestamp generation support:
4246 * Synchronization point for start of timestamp generation.
4248 * Set to >0 for sync point, 0 for no sync point and <0 for undefined
4251 * For example, this corresponds to presence of H.264 buffering period
4257 * Offset of the current timestamp against last timestamp sync point in
4258 * units of AVCodecContext.time_base.
4260 * Set to INT_MIN when dts_sync_point unused. Otherwise, it must
4261 * contain a valid timestamp offset.
4263 * Note that the timestamp of sync point has usually a nonzero
4264 * dts_ref_dts_delta, which refers to the previous sync point. Offset of
4265 * the next frame after timestamp sync point will be usually 1.
4267 * For example, this corresponds to H.264 cpb_removal_delay.
4269 int dts_ref_dts_delta;
4272 * Presentation delay of current frame in units of AVCodecContext.time_base.
4274 * Set to INT_MIN when dts_sync_point unused. Otherwise, it must
4275 * contain valid non-negative timestamp delta (presentation time of a frame
4276 * must not lie in the past).
4278 * This delay represents the difference between decoding and presentation
4279 * time of the frame.
4281 * For example, this corresponds to H.264 dpb_output_delay.
4286 * Position of the packet in file.
4288 * Analogous to cur_frame_pts/dts
4290 int64_t cur_frame_pos[AV_PARSER_PTS_NB];
4293 * Byte position of currently parsed frame in stream.
4298 * Previous frame byte position.
4303 * Duration of the current frame.
4304 * For audio, this is in units of 1 / AVCodecContext.sample_rate.
4305 * For all other types, this is in units of AVCodecContext.time_base.
4309 enum AVFieldOrder field_order;
4312 * Indicate whether a picture is coded as a frame, top field or bottom field.
4314 * For example, H.264 field_pic_flag equal to 0 corresponds to
4315 * AV_PICTURE_STRUCTURE_FRAME. An H.264 picture with field_pic_flag
4316 * equal to 1 and bottom_field_flag equal to 0 corresponds to
4317 * AV_PICTURE_STRUCTURE_TOP_FIELD.
4319 enum AVPictureStructure picture_structure;
4322 * Picture number incremented in presentation or output order.
4323 * This field may be reinitialized at the first picture of a new sequence.
4325 * For example, this corresponds to H.264 PicOrderCnt.
4327 int output_picture_number;
4328 } AVCodecParserContext;
4330 typedef struct AVCodecParser {
4331 int codec_ids[5]; /* several codec IDs are permitted */
4333 int (*parser_init)(AVCodecParserContext *s);
4334 int (*parser_parse)(AVCodecParserContext *s,
4335 AVCodecContext *avctx,
4336 const uint8_t **poutbuf, int *poutbuf_size,
4337 const uint8_t *buf, int buf_size);
4338 void (*parser_close)(AVCodecParserContext *s);
4339 int (*split)(AVCodecContext *avctx, const uint8_t *buf, int buf_size);
4340 struct AVCodecParser *next;
4343 AVCodecParser *av_parser_next(const AVCodecParser *c);
4345 void av_register_codec_parser(AVCodecParser *parser);
4346 AVCodecParserContext *av_parser_init(int codec_id);
4351 * @param s parser context.
4352 * @param avctx codec context.
4353 * @param poutbuf set to pointer to parsed buffer or NULL if not yet finished.
4354 * @param poutbuf_size set to size of parsed buffer or zero if not yet finished.
4355 * @param buf input buffer.
4356 * @param buf_size input length, to signal EOF, this should be 0 (so that the last frame can be output).
4357 * @param pts input presentation timestamp.
4358 * @param dts input decoding timestamp.
4359 * @param pos input byte position in stream.
4360 * @return the number of bytes of the input bitstream used.
4365 * len = av_parser_parse2(myparser, AVCodecContext, &data, &size,
4372 * decode_frame(data, size);
4376 int av_parser_parse2(AVCodecParserContext *s,
4377 AVCodecContext *avctx,
4378 uint8_t **poutbuf, int *poutbuf_size,
4379 const uint8_t *buf, int buf_size,
4380 int64_t pts, int64_t dts,
4384 * @return 0 if the output buffer is a subset of the input, 1 if it is allocated and must be freed
4385 * @deprecated use AVBitStreamFilter
4387 int av_parser_change(AVCodecParserContext *s,
4388 AVCodecContext *avctx,
4389 uint8_t **poutbuf, int *poutbuf_size,
4390 const uint8_t *buf, int buf_size, int keyframe);
4391 void av_parser_close(AVCodecParserContext *s);
4399 * @addtogroup lavc_encoding
4404 * Find a registered encoder with a matching codec ID.
4406 * @param id AVCodecID of the requested encoder
4407 * @return An encoder if one was found, NULL otherwise.
4409 AVCodec *avcodec_find_encoder(enum AVCodecID id);
4412 * Find a registered encoder with the specified name.
4414 * @param name name of the requested encoder
4415 * @return An encoder if one was found, NULL otherwise.
4417 AVCodec *avcodec_find_encoder_by_name(const char *name);
4419 #if FF_API_OLD_ENCODE_AUDIO
4421 * Encode an audio frame from samples into buf.
4423 * @deprecated Use avcodec_encode_audio2 instead.
4425 * @note The output buffer should be at least FF_MIN_BUFFER_SIZE bytes large.
4426 * However, for codecs with avctx->frame_size equal to 0 (e.g. PCM) the user
4427 * will know how much space is needed because it depends on the value passed
4428 * in buf_size as described below. In that case a lower value can be used.
4430 * @param avctx the codec context
4431 * @param[out] buf the output buffer
4432 * @param[in] buf_size the output buffer size
4433 * @param[in] samples the input buffer containing the samples
4434 * The number of samples read from this buffer is frame_size*channels,
4435 * both of which are defined in avctx.
4436 * For codecs which have avctx->frame_size equal to 0 (e.g. PCM) the number of
4437 * samples read from samples is equal to:
4438 * buf_size * 8 / (avctx->channels * av_get_bits_per_sample(avctx->codec_id))
4439 * This also implies that av_get_bits_per_sample() must not return 0 for these
4441 * @return On error a negative value is returned, on success zero or the number
4442 * of bytes used to encode the data read from the input buffer.
4444 int attribute_deprecated avcodec_encode_audio(AVCodecContext *avctx,
4445 uint8_t *buf, int buf_size,
4446 const short *samples);
4450 * Encode a frame of audio.
4452 * Takes input samples from frame and writes the next output packet, if
4453 * available, to avpkt. The output packet does not necessarily contain data for
4454 * the most recent frame, as encoders can delay, split, and combine input frames
4455 * internally as needed.
4457 * @param avctx codec context
4458 * @param avpkt output AVPacket.
4459 * The user can supply an output buffer by setting
4460 * avpkt->data and avpkt->size prior to calling the
4461 * function, but if the size of the user-provided data is not
4462 * large enough, encoding will fail. If avpkt->data and
4463 * avpkt->size are set, avpkt->destruct must also be set. All
4464 * other AVPacket fields will be reset by the encoder using
4465 * av_init_packet(). If avpkt->data is NULL, the encoder will
4466 * allocate it. The encoder will set avpkt->size to the size
4467 * of the output packet.
4469 * If this function fails or produces no output, avpkt will be
4470 * freed using av_free_packet() (i.e. avpkt->destruct will be
4471 * called to free the user supplied buffer).
4472 * @param[in] frame AVFrame containing the raw audio data to be encoded.
4473 * May be NULL when flushing an encoder that has the
4474 * CODEC_CAP_DELAY capability set.
4475 * If CODEC_CAP_VARIABLE_FRAME_SIZE is set, then each frame
4476 * can have any number of samples.
4477 * If it is not set, frame->nb_samples must be equal to
4478 * avctx->frame_size for all frames except the last.
4479 * The final frame may be smaller than avctx->frame_size.
4480 * @param[out] got_packet_ptr This field is set to 1 by libavcodec if the
4481 * output packet is non-empty, and to 0 if it is
4482 * empty. If the function returns an error, the
4483 * packet can be assumed to be invalid, and the
4484 * value of got_packet_ptr is undefined and should
4486 * @return 0 on success, negative error code on failure
4488 int avcodec_encode_audio2(AVCodecContext *avctx, AVPacket *avpkt,
4489 const AVFrame *frame, int *got_packet_ptr);
4491 #if FF_API_OLD_ENCODE_VIDEO
4493 * @deprecated use avcodec_encode_video2() instead.
4495 * Encode a video frame from pict into buf.
4496 * The input picture should be
4497 * stored using a specific format, namely avctx.pix_fmt.
4499 * @param avctx the codec context
4500 * @param[out] buf the output buffer for the bitstream of encoded frame
4501 * @param[in] buf_size the size of the output buffer in bytes
4502 * @param[in] pict the input picture to encode
4503 * @return On error a negative value is returned, on success zero or the number
4504 * of bytes used from the output buffer.
4506 attribute_deprecated
4507 int avcodec_encode_video(AVCodecContext *avctx, uint8_t *buf, int buf_size,
4508 const AVFrame *pict);
4512 * Encode a frame of video.
4514 * Takes input raw video data from frame and writes the next output packet, if
4515 * available, to avpkt. The output packet does not necessarily contain data for
4516 * the most recent frame, as encoders can delay and reorder input frames
4517 * internally as needed.
4519 * @param avctx codec context
4520 * @param avpkt output AVPacket.
4521 * The user can supply an output buffer by setting
4522 * avpkt->data and avpkt->size prior to calling the
4523 * function, but if the size of the user-provided data is not
4524 * large enough, encoding will fail. All other AVPacket fields
4525 * will be reset by the encoder using av_init_packet(). If
4526 * avpkt->data is NULL, the encoder will allocate it.
4527 * The encoder will set avpkt->size to the size of the
4528 * output packet. The returned data (if any) belongs to the
4529 * caller, he is responsible for freeing it.
4531 * If this function fails or produces no output, avpkt will be
4532 * freed using av_free_packet() (i.e. avpkt->destruct will be
4533 * called to free the user supplied buffer).
4534 * @param[in] frame AVFrame containing the raw video data to be encoded.
4535 * May be NULL when flushing an encoder that has the
4536 * CODEC_CAP_DELAY capability set.
4537 * @param[out] got_packet_ptr This field is set to 1 by libavcodec if the
4538 * output packet is non-empty, and to 0 if it is
4539 * empty. If the function returns an error, the
4540 * packet can be assumed to be invalid, and the
4541 * value of got_packet_ptr is undefined and should
4543 * @return 0 on success, negative error code on failure
4545 int avcodec_encode_video2(AVCodecContext *avctx, AVPacket *avpkt,
4546 const AVFrame *frame, int *got_packet_ptr);
4548 int avcodec_encode_subtitle(AVCodecContext *avctx, uint8_t *buf, int buf_size,
4549 const AVSubtitle *sub);
4556 #if FF_API_AVCODEC_RESAMPLE
4558 * @defgroup lavc_resample Audio resampling
4560 * @deprecated use libswresample instead
4564 struct ReSampleContext;
4565 struct AVResampleContext;
4567 typedef struct ReSampleContext ReSampleContext;
4570 * Initialize audio resampling context.
4572 * @param output_channels number of output channels
4573 * @param input_channels number of input channels
4574 * @param output_rate output sample rate
4575 * @param input_rate input sample rate
4576 * @param sample_fmt_out requested output sample format
4577 * @param sample_fmt_in input sample format
4578 * @param filter_length length of each FIR filter in the filterbank relative to the cutoff frequency
4579 * @param log2_phase_count log2 of the number of entries in the polyphase filterbank
4580 * @param linear if 1 then the used FIR filter will be linearly interpolated
4581 between the 2 closest, if 0 the closest will be used
4582 * @param cutoff cutoff frequency, 1.0 corresponds to half the output sampling rate
4583 * @return allocated ReSampleContext, NULL if error occurred
4585 attribute_deprecated
4586 ReSampleContext *av_audio_resample_init(int output_channels, int input_channels,
4587 int output_rate, int input_rate,
4588 enum AVSampleFormat sample_fmt_out,
4589 enum AVSampleFormat sample_fmt_in,
4590 int filter_length, int log2_phase_count,
4591 int linear, double cutoff);
4593 attribute_deprecated
4594 int audio_resample(ReSampleContext *s, short *output, short *input, int nb_samples);
4597 * Free resample context.
4599 * @param s a non-NULL pointer to a resample context previously
4600 * created with av_audio_resample_init()
4602 attribute_deprecated
4603 void audio_resample_close(ReSampleContext *s);
4607 * Initialize an audio resampler.
4608 * Note, if either rate is not an integer then simply scale both rates up so they are.
4609 * @param filter_length length of each FIR filter in the filterbank relative to the cutoff freq
4610 * @param log2_phase_count log2 of the number of entries in the polyphase filterbank
4611 * @param linear If 1 then the used FIR filter will be linearly interpolated
4612 between the 2 closest, if 0 the closest will be used
4613 * @param cutoff cutoff frequency, 1.0 corresponds to half the output sampling rate
4615 attribute_deprecated
4616 struct AVResampleContext *av_resample_init(int out_rate, int in_rate, int filter_length, int log2_phase_count, int linear, double cutoff);
4619 * Resample an array of samples using a previously configured context.
4620 * @param src an array of unconsumed samples
4621 * @param consumed the number of samples of src which have been consumed are returned here
4622 * @param src_size the number of unconsumed samples available
4623 * @param dst_size the amount of space in samples available in dst
4624 * @param update_ctx If this is 0 then the context will not be modified, that way several channels can be resampled with the same context.
4625 * @return the number of samples written in dst or -1 if an error occurred
4627 attribute_deprecated
4628 int av_resample(struct AVResampleContext *c, short *dst, short *src, int *consumed, int src_size, int dst_size, int update_ctx);
4632 * Compensate samplerate/timestamp drift. The compensation is done by changing
4633 * the resampler parameters, so no audible clicks or similar distortions occur
4634 * @param compensation_distance distance in output samples over which the compensation should be performed
4635 * @param sample_delta number of output samples which should be output less
4637 * example: av_resample_compensate(c, 10, 500)
4638 * here instead of 510 samples only 500 samples would be output
4640 * note, due to rounding the actual compensation might be slightly different,
4641 * especially if the compensation_distance is large and the in_rate used during init is small
4643 attribute_deprecated
4644 void av_resample_compensate(struct AVResampleContext *c, int sample_delta, int compensation_distance);
4645 attribute_deprecated
4646 void av_resample_close(struct AVResampleContext *c);
4654 * @addtogroup lavc_picture
4659 * Allocate memory for the pixels of a picture and setup the AVPicture
4662 * Call avpicture_free() to free it.
4664 * @param picture the picture structure to be filled in
4665 * @param pix_fmt the pixel format of the picture
4666 * @param width the width of the picture
4667 * @param height the height of the picture
4668 * @return zero if successful, a negative error code otherwise
4670 * @see av_image_alloc(), avpicture_fill()
4672 int avpicture_alloc(AVPicture *picture, enum AVPixelFormat pix_fmt, int width, int height);
4675 * Free a picture previously allocated by avpicture_alloc().
4676 * The data buffer used by the AVPicture is freed, but the AVPicture structure
4679 * @param picture the AVPicture to be freed
4681 void avpicture_free(AVPicture *picture);
4684 * Setup the picture fields based on the specified image parameters
4685 * and the provided image data buffer.
4687 * The picture fields are filled in by using the image data buffer
4688 * pointed to by ptr.
4690 * If ptr is NULL, the function will fill only the picture linesize
4691 * array and return the required size for the image buffer.
4693 * To allocate an image buffer and fill the picture data in one call,
4694 * use avpicture_alloc().
4696 * @param picture the picture to be filled in
4697 * @param ptr buffer where the image data is stored, or NULL
4698 * @param pix_fmt the pixel format of the image
4699 * @param width the width of the image in pixels
4700 * @param height the height of the image in pixels
4701 * @return the size in bytes required for src, a negative error code
4702 * in case of failure
4704 * @see av_image_fill_arrays()
4706 int avpicture_fill(AVPicture *picture, const uint8_t *ptr,
4707 enum AVPixelFormat pix_fmt, int width, int height);
4710 * Copy pixel data from an AVPicture into a buffer.
4712 * avpicture_get_size() can be used to compute the required size for
4713 * the buffer to fill.
4715 * @param src source picture with filled data
4716 * @param pix_fmt picture pixel format
4717 * @param width picture width
4718 * @param height picture height
4719 * @param dest destination buffer
4720 * @param dest_size destination buffer size in bytes
4721 * @return the number of bytes written to dest, or a negative value
4722 * (error code) on error, for example if the destination buffer is not
4725 * @see av_image_copy_to_buffer()
4727 int avpicture_layout(const AVPicture *src, enum AVPixelFormat pix_fmt,
4728 int width, int height,
4729 unsigned char *dest, int dest_size);
4732 * Calculate the size in bytes that a picture of the given width and height
4733 * would occupy if stored in the given picture format.
4735 * @param pix_fmt picture pixel format
4736 * @param width picture width
4737 * @param height picture height
4738 * @return the computed picture buffer size or a negative error code
4741 * @see av_image_get_buffer_size().
4743 int avpicture_get_size(enum AVPixelFormat pix_fmt, int width, int height);
4745 #if FF_API_DEINTERLACE
4747 * deinterlace - if not supported return -1
4749 * @deprecated - use yadif (in libavfilter) instead
4751 attribute_deprecated
4752 int avpicture_deinterlace(AVPicture *dst, const AVPicture *src,
4753 enum AVPixelFormat pix_fmt, int width, int height);
4756 * Copy image src to dst. Wraps av_image_copy().
4758 void av_picture_copy(AVPicture *dst, const AVPicture *src,
4759 enum AVPixelFormat pix_fmt, int width, int height);
4762 * Crop image top and left side.
4764 int av_picture_crop(AVPicture *dst, const AVPicture *src,
4765 enum AVPixelFormat pix_fmt, int top_band, int left_band);
4770 int av_picture_pad(AVPicture *dst, const AVPicture *src, int height, int width, enum AVPixelFormat pix_fmt,
4771 int padtop, int padbottom, int padleft, int padright, int *color);
4778 * @defgroup lavc_misc Utility functions
4781 * Miscellaneous utility functions related to both encoding and decoding
4787 * @defgroup lavc_misc_pixfmt Pixel formats
4789 * Functions for working with pixel formats.
4794 * Utility function to access log2_chroma_w log2_chroma_h from
4795 * the pixel format AVPixFmtDescriptor.
4797 * This function asserts that pix_fmt is valid. See av_pix_fmt_get_chroma_sub_sample
4798 * for one that returns a failure code and continues in case of invalid
4801 * @param[in] pix_fmt the pixel format
4802 * @param[out] h_shift store log2_chroma_w
4803 * @param[out] v_shift store log2_chroma_h
4805 * @see av_pix_fmt_get_chroma_sub_sample
4808 void avcodec_get_chroma_sub_sample(enum AVPixelFormat pix_fmt, int *h_shift, int *v_shift);
4811 * Return a value representing the fourCC code associated to the
4812 * pixel format pix_fmt, or 0 if no associated fourCC code can be
4815 unsigned int avcodec_pix_fmt_to_codec_tag(enum AVPixelFormat pix_fmt);
4818 * @deprecated see av_get_pix_fmt_loss()
4820 int avcodec_get_pix_fmt_loss(enum AVPixelFormat dst_pix_fmt, enum AVPixelFormat src_pix_fmt,
4824 * Find the best pixel format to convert to given a certain source pixel
4825 * format. When converting from one pixel format to another, information loss
4826 * may occur. For example, when converting from RGB24 to GRAY, the color
4827 * information will be lost. Similarly, other losses occur when converting from
4828 * some formats to other formats. avcodec_find_best_pix_fmt_of_2() searches which of
4829 * the given pixel formats should be used to suffer the least amount of loss.
4830 * The pixel formats from which it chooses one, are determined by the
4831 * pix_fmt_list parameter.
4834 * @param[in] pix_fmt_list AV_PIX_FMT_NONE terminated array of pixel formats to choose from
4835 * @param[in] src_pix_fmt source pixel format
4836 * @param[in] has_alpha Whether the source pixel format alpha channel is used.
4837 * @param[out] loss_ptr Combination of flags informing you what kind of losses will occur.
4838 * @return The best pixel format to convert to or -1 if none was found.
4840 enum AVPixelFormat avcodec_find_best_pix_fmt_of_list(const enum AVPixelFormat *pix_fmt_list,
4841 enum AVPixelFormat src_pix_fmt,
4842 int has_alpha, int *loss_ptr);
4845 * @deprecated see av_find_best_pix_fmt_of_2()
4847 enum AVPixelFormat avcodec_find_best_pix_fmt_of_2(enum AVPixelFormat dst_pix_fmt1, enum AVPixelFormat dst_pix_fmt2,
4848 enum AVPixelFormat src_pix_fmt, int has_alpha, int *loss_ptr);
4850 attribute_deprecated
4851 #if AV_HAVE_INCOMPATIBLE_LIBAV_ABI
4852 enum AVPixelFormat avcodec_find_best_pix_fmt2(const enum AVPixelFormat *pix_fmt_list,
4853 enum AVPixelFormat src_pix_fmt,
4854 int has_alpha, int *loss_ptr);
4856 enum AVPixelFormat avcodec_find_best_pix_fmt2(enum AVPixelFormat dst_pix_fmt1, enum AVPixelFormat dst_pix_fmt2,
4857 enum AVPixelFormat src_pix_fmt, int has_alpha, int *loss_ptr);
4861 enum AVPixelFormat avcodec_default_get_format(struct AVCodecContext *s, const enum AVPixelFormat * fmt);
4867 #if FF_API_SET_DIMENSIONS
4869 * @deprecated this function is not supposed to be used from outside of lavc
4871 attribute_deprecated
4872 void avcodec_set_dimensions(AVCodecContext *s, int width, int height);
4876 * Put a string representing the codec tag codec_tag in buf.
4878 * @param buf buffer to place codec tag in
4879 * @param buf_size size in bytes of buf
4880 * @param codec_tag codec tag to assign
4881 * @return the length of the string that would have been generated if
4882 * enough space had been available, excluding the trailing null
4884 size_t av_get_codec_tag_string(char *buf, size_t buf_size, unsigned int codec_tag);
4886 void avcodec_string(char *buf, int buf_size, AVCodecContext *enc, int encode);
4889 * Return a name for the specified profile, if available.
4891 * @param codec the codec that is searched for the given profile
4892 * @param profile the profile value for which a name is requested
4893 * @return A name for the profile if found, NULL otherwise.
4895 const char *av_get_profile_name(const AVCodec *codec, int profile);
4897 int avcodec_default_execute(AVCodecContext *c, int (*func)(AVCodecContext *c2, void *arg2),void *arg, int *ret, int count, int size);
4898 int avcodec_default_execute2(AVCodecContext *c, int (*func)(AVCodecContext *c2, void *arg2, int, int),void *arg, int *ret, int count);
4899 //FIXME func typedef
4902 * Fill AVFrame audio data and linesize pointers.
4904 * The buffer buf must be a preallocated buffer with a size big enough
4905 * to contain the specified samples amount. The filled AVFrame data
4906 * pointers will point to this buffer.
4908 * AVFrame extended_data channel pointers are allocated if necessary for
4911 * @param frame the AVFrame
4912 * frame->nb_samples must be set prior to calling the
4913 * function. This function fills in frame->data,
4914 * frame->extended_data, frame->linesize[0].
4915 * @param nb_channels channel count
4916 * @param sample_fmt sample format
4917 * @param buf buffer to use for frame data
4918 * @param buf_size size of buffer
4919 * @param align plane size sample alignment (0 = default)
4920 * @return >=0 on success, negative error code on failure
4921 * @todo return the size in bytes required to store the samples in
4922 * case of success, at the next libavutil bump
4924 int avcodec_fill_audio_frame(AVFrame *frame, int nb_channels,
4925 enum AVSampleFormat sample_fmt, const uint8_t *buf,
4926 int buf_size, int align);
4929 * Reset the internal decoder state / flush internal buffers. Should be called
4930 * e.g. when seeking or when switching to a different stream.
4932 * @note when refcounted frames are not used (i.e. avctx->refcounted_frames is 0),
4933 * this invalidates the frames previously returned from the decoder. When
4934 * refcounted frames are used, the decoder just releases any references it might
4935 * keep internally, but the caller's reference remains valid.
4937 void avcodec_flush_buffers(AVCodecContext *avctx);
4940 * Return codec bits per sample.
4942 * @param[in] codec_id the codec
4943 * @return Number of bits per sample or zero if unknown for the given codec.
4945 int av_get_bits_per_sample(enum AVCodecID codec_id);
4948 * Return the PCM codec associated with a sample format.
4949 * @param be endianness, 0 for little, 1 for big,
4950 * -1 (or anything else) for native
4951 * @return AV_CODEC_ID_PCM_* or AV_CODEC_ID_NONE
4953 enum AVCodecID av_get_pcm_codec(enum AVSampleFormat fmt, int be);
4956 * Return codec bits per sample.
4957 * Only return non-zero if the bits per sample is exactly correct, not an
4960 * @param[in] codec_id the codec
4961 * @return Number of bits per sample or zero if unknown for the given codec.
4963 int av_get_exact_bits_per_sample(enum AVCodecID codec_id);
4966 * Return audio frame duration.
4968 * @param avctx codec context
4969 * @param frame_bytes size of the frame, or 0 if unknown
4970 * @return frame duration, in samples, if known. 0 if not able to
4973 int av_get_audio_frame_duration(AVCodecContext *avctx, int frame_bytes);
4976 typedef struct AVBitStreamFilterContext {
4978 struct AVBitStreamFilter *filter;
4979 AVCodecParserContext *parser;
4980 struct AVBitStreamFilterContext *next;
4981 } AVBitStreamFilterContext;
4984 typedef struct AVBitStreamFilter {
4987 int (*filter)(AVBitStreamFilterContext *bsfc,
4988 AVCodecContext *avctx, const char *args,
4989 uint8_t **poutbuf, int *poutbuf_size,
4990 const uint8_t *buf, int buf_size, int keyframe);
4991 void (*close)(AVBitStreamFilterContext *bsfc);
4992 struct AVBitStreamFilter *next;
4993 } AVBitStreamFilter;
4996 * Register a bitstream filter.
4998 * The filter will be accessible to the application code through
4999 * av_bitstream_filter_next() or can be directly initialized with
5000 * av_bitstream_filter_init().
5002 * @see avcodec_register_all()
5004 void av_register_bitstream_filter(AVBitStreamFilter *bsf);
5007 * Create and initialize a bitstream filter context given a bitstream
5010 * The returned context must be freed with av_bitstream_filter_close().
5012 * @param name the name of the bitstream filter
5013 * @return a bitstream filter context if a matching filter was found
5014 * and successfully initialized, NULL otherwise
5016 AVBitStreamFilterContext *av_bitstream_filter_init(const char *name);
5021 * This function filters the buffer buf with size buf_size, and places the
5022 * filtered buffer in the buffer pointed to by poutbuf.
5024 * The output buffer must be freed by the caller.
5026 * @param bsfc bitstream filter context created by av_bitstream_filter_init()
5027 * @param avctx AVCodecContext accessed by the filter, may be NULL.
5028 * If specified, this must point to the encoder context of the
5029 * output stream the packet is sent to.
5030 * @param args arguments which specify the filter configuration, may be NULL
5031 * @param poutbuf pointer which is updated to point to the filtered buffer
5032 * @param poutbuf_size pointer which is updated to the filtered buffer size in bytes
5033 * @param buf buffer containing the data to filter
5034 * @param buf_size size in bytes of buf
5035 * @param keyframe set to non-zero if the buffer to filter corresponds to a key-frame packet data
5036 * @return >= 0 in case of success, or a negative error code in case of failure
5038 * If the return value is positive, an output buffer is allocated and
5039 * is available in *poutbuf, and is distinct from the input buffer.
5041 * If the return value is 0, the output buffer is not allocated and
5042 * should be considered identical to the input buffer, or in case
5043 * *poutbuf was set it points to the input buffer (not necessarily to
5044 * its starting address).
5046 int av_bitstream_filter_filter(AVBitStreamFilterContext *bsfc,
5047 AVCodecContext *avctx, const char *args,
5048 uint8_t **poutbuf, int *poutbuf_size,
5049 const uint8_t *buf, int buf_size, int keyframe);
5052 * Release bitstream filter context.
5054 * @param bsf the bitstream filter context created with
5055 * av_bitstream_filter_init(), can be NULL
5057 void av_bitstream_filter_close(AVBitStreamFilterContext *bsf);
5060 * If f is NULL, return the first registered bitstream filter,
5061 * if f is non-NULL, return the next registered bitstream filter
5062 * after f, or NULL if f is the last one.
5064 * This function can be used to iterate over all registered bitstream
5067 AVBitStreamFilter *av_bitstream_filter_next(const AVBitStreamFilter *f);
5072 * Same behaviour av_fast_malloc but the buffer has additional
5073 * FF_INPUT_BUFFER_PADDING_SIZE at the end which will always be 0.
5075 * In addition the whole buffer will initially and after resizes
5076 * be 0-initialized so that no uninitialized data will ever appear.
5078 void av_fast_padded_malloc(void *ptr, unsigned int *size, size_t min_size);
5081 * Same behaviour av_fast_padded_malloc except that buffer will always
5082 * be 0-initialized after call.
5084 void av_fast_padded_mallocz(void *ptr, unsigned int *size, size_t min_size);
5087 * Encode extradata length to a buffer. Used by xiph codecs.
5089 * @param s buffer to write to; must be at least (v/255+1) bytes long
5090 * @param v size of extradata in bytes
5091 * @return number of bytes written to the buffer.
5093 unsigned int av_xiphlacing(unsigned char *s, unsigned int v);
5095 #if FF_API_MISSING_SAMPLE
5097 * Log a generic warning message about a missing feature. This function is
5098 * intended to be used internally by FFmpeg (libavcodec, libavformat, etc.)
5099 * only, and would normally not be used by applications.
5100 * @param[in] avc a pointer to an arbitrary struct of which the first field is
5101 * a pointer to an AVClass struct
5102 * @param[in] feature string containing the name of the missing feature
5103 * @param[in] want_sample indicates if samples are wanted which exhibit this feature.
5104 * If want_sample is non-zero, additional verbage will be added to the log
5105 * message which tells the user how to report samples to the development
5107 * @deprecated Use avpriv_report_missing_feature() instead.
5109 attribute_deprecated
5110 void av_log_missing_feature(void *avc, const char *feature, int want_sample);
5113 * Log a generic warning message asking for a sample. This function is
5114 * intended to be used internally by FFmpeg (libavcodec, libavformat, etc.)
5115 * only, and would normally not be used by applications.
5116 * @param[in] avc a pointer to an arbitrary struct of which the first field is
5117 * a pointer to an AVClass struct
5118 * @param[in] msg string containing an optional message, or NULL if no message
5119 * @deprecated Use avpriv_request_sample() instead.
5121 attribute_deprecated
5122 void av_log_ask_for_sample(void *avc, const char *msg, ...) av_printf_format(2, 3);
5123 #endif /* FF_API_MISSING_SAMPLE */
5126 * Register the hardware accelerator hwaccel.
5128 void av_register_hwaccel(AVHWAccel *hwaccel);
5131 * If hwaccel is NULL, returns the first registered hardware accelerator,
5132 * if hwaccel is non-NULL, returns the next registered hardware accelerator
5133 * after hwaccel, or NULL if hwaccel is the last one.
5135 AVHWAccel *av_hwaccel_next(const AVHWAccel *hwaccel);
5139 * Lock operation used by lockmgr
5142 AV_LOCK_CREATE, ///< Create a mutex
5143 AV_LOCK_OBTAIN, ///< Lock the mutex
5144 AV_LOCK_RELEASE, ///< Unlock the mutex
5145 AV_LOCK_DESTROY, ///< Free mutex resources
5149 * Register a user provided lock manager supporting the operations
5150 * specified by AVLockOp. The "mutex" argument to the function points
5151 * to a (void *) where the lockmgr should store/get a pointer to a user
5152 * allocated mutex. It is NULL upon AV_LOCK_CREATE and equal to the
5153 * value left by the last call for all other ops. If the lock manager is
5154 * unable to perform the op then it should leave the mutex in the same
5155 * state as when it was called and return a non-zero value. However,
5156 * when called with AV_LOCK_DESTROY the mutex will always be assumed to
5157 * have been successfully destroyed. If av_lockmgr_register succeeds
5158 * it will return a non-negative value, if it fails it will return a
5159 * negative value and destroy all mutex and unregister all callbacks.
5160 * av_lockmgr_register is not thread-safe, it must be called from a
5161 * single thread before any calls which make use of locking are used.
5163 * @param cb User defined callback. av_lockmgr_register invokes calls
5164 * to this callback and the previously registered callback.
5165 * The callback will be used to create more than one mutex
5166 * each of which must be backed by its own underlying locking
5167 * mechanism (i.e. do not use a single static object to
5168 * implement your lock manager). If cb is set to NULL the
5169 * lockmgr will be unregistered.
5171 int av_lockmgr_register(int (*cb)(void **mutex, enum AVLockOp op));
5174 * Get the type of the given codec.
5176 enum AVMediaType avcodec_get_type(enum AVCodecID codec_id);
5179 * Get the name of a codec.
5180 * @return a static string identifying the codec; never NULL
5182 const char *avcodec_get_name(enum AVCodecID id);
5185 * @return a positive value if s is open (i.e. avcodec_open2() was called on it
5186 * with no corresponding avcodec_close()), 0 otherwise.
5188 int avcodec_is_open(AVCodecContext *s);
5191 * @return a non-zero number if codec is an encoder, zero otherwise
5193 int av_codec_is_encoder(const AVCodec *codec);
5196 * @return a non-zero number if codec is a decoder, zero otherwise
5198 int av_codec_is_decoder(const AVCodec *codec);
5201 * @return descriptor for given codec ID or NULL if no descriptor exists.
5203 const AVCodecDescriptor *avcodec_descriptor_get(enum AVCodecID id);
5206 * Iterate over all codec descriptors known to libavcodec.
5208 * @param prev previous descriptor. NULL to get the first descriptor.
5210 * @return next descriptor or NULL after the last descriptor
5212 const AVCodecDescriptor *avcodec_descriptor_next(const AVCodecDescriptor *prev);
5215 * @return codec descriptor with the given name or NULL if no such descriptor
5218 const AVCodecDescriptor *avcodec_descriptor_get_by_name(const char *name);
5224 #endif /* AVCODEC_AVCODEC_H */