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"
45 #if FF_API_FAST_MALLOC
46 // to provide fast_*alloc
47 #include "libavutil/mem.h"
51 * @defgroup libavc Encoding/Decoding Library
54 * @defgroup lavc_decoding Decoding
58 * @defgroup lavc_encoding Encoding
62 * @defgroup lavc_codec Codecs
64 * @defgroup lavc_codec_native Native Codecs
67 * @defgroup lavc_codec_wrappers External library wrappers
70 * @defgroup lavc_codec_hwaccel Hardware Accelerators bridge
74 * @defgroup lavc_internal Internal
82 * @defgroup lavc_core Core functions/structures.
85 * Basic definitions, functions for querying libavcodec capabilities,
86 * allocating core structures, etc.
92 * Identify the syntax and semantics of the bitstream.
93 * The principle is roughly:
94 * Two decoders with the same ID can decode the same streams.
95 * Two encoders with the same ID can encode compatible streams.
96 * There may be slight deviations from the principle due to implementation
99 * If you add a codec ID to this list, add it so that
100 * 1. no value of a existing codec ID changes (that would break ABI),
101 * 2. Give it a value which when taken as ASCII is recognized uniquely by a human as this specific codec.
102 * This ensures that 2 forks can independently add AVCodecIDs without producing conflicts.
104 * After adding new codec IDs, do not forget to add an entry to the codec
105 * descriptor list and bump libavcodec minor version.
111 AV_CODEC_ID_MPEG1VIDEO,
112 AV_CODEC_ID_MPEG2VIDEO, ///< preferred ID for MPEG-1/2 video decoding
114 AV_CODEC_ID_MPEG2VIDEO_XVMC,
115 #endif /* FF_API_XVMC */
126 AV_CODEC_ID_RAWVIDEO,
127 AV_CODEC_ID_MSMPEG4V1,
128 AV_CODEC_ID_MSMPEG4V2,
129 AV_CODEC_ID_MSMPEG4V3,
152 AV_CODEC_ID_INTERPLAY_VIDEO,
159 AV_CODEC_ID_MSVIDEO1,
164 AV_CODEC_ID_TRUEMOTION1,
165 AV_CODEC_ID_VMDVIDEO,
169 AV_CODEC_ID_SNOW_DEPRECATED,
191 AV_CODEC_ID_TRUEMOTION2,
197 AV_CODEC_ID_SMACKVIDEO,
202 AV_CODEC_ID_JPEG2000,
208 AV_CODEC_ID_DSICINVIDEO,
209 AV_CODEC_ID_TIERTEXSEQVIDEO,
217 AV_CODEC_ID_BETHSOFTVID,
229 AV_CODEC_ID_ESCAPE124,
233 AV_CODEC_ID_MOTIONPIXELS,
245 AV_CODEC_ID_FLASHSV2,
246 AV_CODEC_ID_CDGRAPHICS,
249 AV_CODEC_ID_BINKVIDEO,
250 AV_CODEC_ID_IFF_ILBM,
251 AV_CODEC_ID_IFF_BYTERUN1,
257 AV_CODEC_ID_A64_MULTI,
258 AV_CODEC_ID_A64_MULTI5,
261 AV_CODEC_ID_LAGARITH,
265 AV_CODEC_ID_WMV3IMAGE,
266 AV_CODEC_ID_VC1IMAGE,
268 AV_CODEC_ID_BMV_VIDEO,
275 AV_CODEC_ID_ZEROCODEC,
284 AV_CODEC_ID_ESCAPE130_DEPRECATED,
285 AV_CODEC_ID_G2M_DEPRECATED,
286 AV_CODEC_ID_WEBP_DEPRECATED,
287 AV_CODEC_ID_HNM4_VIDEO,
288 AV_CODEC_ID_HEVC_DEPRECATED,
290 AV_CODEC_ID_ALIAS_PIX,
291 AV_CODEC_ID_BRENDER_PIX_DEPRECATED,
292 AV_CODEC_ID_PAF_VIDEO_DEPRECATED,
293 AV_CODEC_ID_EXR_DEPRECATED,
294 AV_CODEC_ID_VP7_DEPRECATED,
295 AV_CODEC_ID_SANM_DEPRECATED,
296 AV_CODEC_ID_SGIRLE_DEPRECATED,
297 AV_CODEC_ID_MVC1_DEPRECATED,
298 AV_CODEC_ID_MVC2_DEPRECATED,
300 AV_CODEC_ID_BRENDER_PIX= MKBETAG('B','P','I','X'),
301 AV_CODEC_ID_Y41P = MKBETAG('Y','4','1','P'),
302 AV_CODEC_ID_ESCAPE130 = MKBETAG('E','1','3','0'),
303 AV_CODEC_ID_EXR = MKBETAG('0','E','X','R'),
304 AV_CODEC_ID_AVRP = MKBETAG('A','V','R','P'),
306 AV_CODEC_ID_012V = MKBETAG('0','1','2','V'),
307 AV_CODEC_ID_G2M = MKBETAG( 0 ,'G','2','M'),
308 AV_CODEC_ID_AVUI = MKBETAG('A','V','U','I'),
309 AV_CODEC_ID_AYUV = MKBETAG('A','Y','U','V'),
310 AV_CODEC_ID_TARGA_Y216 = MKBETAG('T','2','1','6'),
311 AV_CODEC_ID_V308 = MKBETAG('V','3','0','8'),
312 AV_CODEC_ID_V408 = MKBETAG('V','4','0','8'),
313 AV_CODEC_ID_YUV4 = MKBETAG('Y','U','V','4'),
314 AV_CODEC_ID_SANM = MKBETAG('S','A','N','M'),
315 AV_CODEC_ID_PAF_VIDEO = MKBETAG('P','A','F','V'),
316 AV_CODEC_ID_AVRN = MKBETAG('A','V','R','n'),
317 AV_CODEC_ID_CPIA = MKBETAG('C','P','I','A'),
318 AV_CODEC_ID_XFACE = MKBETAG('X','F','A','C'),
319 AV_CODEC_ID_SGIRLE = MKBETAG('S','G','I','R'),
320 AV_CODEC_ID_MVC1 = MKBETAG('M','V','C','1'),
321 AV_CODEC_ID_MVC2 = MKBETAG('M','V','C','2'),
322 AV_CODEC_ID_SNOW = MKBETAG('S','N','O','W'),
323 AV_CODEC_ID_WEBP = MKBETAG('W','E','B','P'),
324 AV_CODEC_ID_SMVJPEG = MKBETAG('S','M','V','J'),
325 AV_CODEC_ID_HEVC = MKBETAG('H','2','6','5'),
326 #define AV_CODEC_ID_H265 AV_CODEC_ID_HEVC
327 AV_CODEC_ID_VP7 = MKBETAG('V','P','7','0'),
329 /* various PCM "codecs" */
330 AV_CODEC_ID_FIRST_AUDIO = 0x10000, ///< A dummy id pointing at the start of audio codecs
331 AV_CODEC_ID_PCM_S16LE = 0x10000,
332 AV_CODEC_ID_PCM_S16BE,
333 AV_CODEC_ID_PCM_U16LE,
334 AV_CODEC_ID_PCM_U16BE,
337 AV_CODEC_ID_PCM_MULAW,
338 AV_CODEC_ID_PCM_ALAW,
339 AV_CODEC_ID_PCM_S32LE,
340 AV_CODEC_ID_PCM_S32BE,
341 AV_CODEC_ID_PCM_U32LE,
342 AV_CODEC_ID_PCM_U32BE,
343 AV_CODEC_ID_PCM_S24LE,
344 AV_CODEC_ID_PCM_S24BE,
345 AV_CODEC_ID_PCM_U24LE,
346 AV_CODEC_ID_PCM_U24BE,
347 AV_CODEC_ID_PCM_S24DAUD,
348 AV_CODEC_ID_PCM_ZORK,
349 AV_CODEC_ID_PCM_S16LE_PLANAR,
351 AV_CODEC_ID_PCM_F32BE,
352 AV_CODEC_ID_PCM_F32LE,
353 AV_CODEC_ID_PCM_F64BE,
354 AV_CODEC_ID_PCM_F64LE,
355 AV_CODEC_ID_PCM_BLURAY,
358 AV_CODEC_ID_PCM_S8_PLANAR,
359 AV_CODEC_ID_PCM_S24LE_PLANAR_DEPRECATED,
360 AV_CODEC_ID_PCM_S32LE_PLANAR_DEPRECATED,
361 AV_CODEC_ID_PCM_S24LE_PLANAR = MKBETAG(24,'P','S','P'),
362 AV_CODEC_ID_PCM_S32LE_PLANAR = MKBETAG(32,'P','S','P'),
363 AV_CODEC_ID_PCM_S16BE_PLANAR = MKBETAG('P','S','P',16),
365 /* various ADPCM codecs */
366 AV_CODEC_ID_ADPCM_IMA_QT = 0x11000,
367 AV_CODEC_ID_ADPCM_IMA_WAV,
368 AV_CODEC_ID_ADPCM_IMA_DK3,
369 AV_CODEC_ID_ADPCM_IMA_DK4,
370 AV_CODEC_ID_ADPCM_IMA_WS,
371 AV_CODEC_ID_ADPCM_IMA_SMJPEG,
372 AV_CODEC_ID_ADPCM_MS,
373 AV_CODEC_ID_ADPCM_4XM,
374 AV_CODEC_ID_ADPCM_XA,
375 AV_CODEC_ID_ADPCM_ADX,
376 AV_CODEC_ID_ADPCM_EA,
377 AV_CODEC_ID_ADPCM_G726,
378 AV_CODEC_ID_ADPCM_CT,
379 AV_CODEC_ID_ADPCM_SWF,
380 AV_CODEC_ID_ADPCM_YAMAHA,
381 AV_CODEC_ID_ADPCM_SBPRO_4,
382 AV_CODEC_ID_ADPCM_SBPRO_3,
383 AV_CODEC_ID_ADPCM_SBPRO_2,
384 AV_CODEC_ID_ADPCM_THP,
385 AV_CODEC_ID_ADPCM_IMA_AMV,
386 AV_CODEC_ID_ADPCM_EA_R1,
387 AV_CODEC_ID_ADPCM_EA_R3,
388 AV_CODEC_ID_ADPCM_EA_R2,
389 AV_CODEC_ID_ADPCM_IMA_EA_SEAD,
390 AV_CODEC_ID_ADPCM_IMA_EA_EACS,
391 AV_CODEC_ID_ADPCM_EA_XAS,
392 AV_CODEC_ID_ADPCM_EA_MAXIS_XA,
393 AV_CODEC_ID_ADPCM_IMA_ISS,
394 AV_CODEC_ID_ADPCM_G722,
395 AV_CODEC_ID_ADPCM_IMA_APC,
396 AV_CODEC_ID_ADPCM_VIMA_DEPRECATED,
397 AV_CODEC_ID_ADPCM_VIMA = MKBETAG('V','I','M','A'),
398 AV_CODEC_ID_VIMA = MKBETAG('V','I','M','A'),
399 AV_CODEC_ID_ADPCM_AFC = MKBETAG('A','F','C',' '),
400 AV_CODEC_ID_ADPCM_IMA_OKI = MKBETAG('O','K','I',' '),
401 AV_CODEC_ID_ADPCM_DTK = MKBETAG('D','T','K',' '),
402 AV_CODEC_ID_ADPCM_IMA_RAD = MKBETAG('R','A','D',' '),
403 AV_CODEC_ID_ADPCM_G726LE = MKBETAG('6','2','7','G'),
406 AV_CODEC_ID_AMR_NB = 0x12000,
409 /* RealAudio codecs*/
410 AV_CODEC_ID_RA_144 = 0x13000,
413 /* various DPCM codecs */
414 AV_CODEC_ID_ROQ_DPCM = 0x14000,
415 AV_CODEC_ID_INTERPLAY_DPCM,
416 AV_CODEC_ID_XAN_DPCM,
417 AV_CODEC_ID_SOL_DPCM,
420 AV_CODEC_ID_MP2 = 0x15000,
421 AV_CODEC_ID_MP3, ///< preferred ID for decoding MPEG audio layer 1, 2 or 3
431 AV_CODEC_ID_VMDAUDIO,
437 AV_CODEC_ID_WESTWOOD_SND1,
438 AV_CODEC_ID_GSM, ///< as in Berlin toast format
441 AV_CODEC_ID_TRUESPEECH,
443 AV_CODEC_ID_SMACKAUDIO,
446 AV_CODEC_ID_DSICINAUDIO,
448 AV_CODEC_ID_MUSEPACK7,
450 AV_CODEC_ID_GSM_MS, /* as found in WAV */
456 AV_CODEC_ID_NELLYMOSER,
457 AV_CODEC_ID_MUSEPACK8,
459 AV_CODEC_ID_WMAVOICE,
461 AV_CODEC_ID_WMALOSSLESS,
470 AV_CODEC_ID_BINKAUDIO_RDFT,
471 AV_CODEC_ID_BINKAUDIO_DCT,
472 AV_CODEC_ID_AAC_LATM,
477 AV_CODEC_ID_8SVX_EXP,
478 AV_CODEC_ID_8SVX_FIB,
479 AV_CODEC_ID_BMV_AUDIO,
483 AV_CODEC_ID_OPUS_DEPRECATED,
484 AV_CODEC_ID_COMFORT_NOISE,
485 AV_CODEC_ID_TAK_DEPRECATED,
486 AV_CODEC_ID_METASOUND,
487 AV_CODEC_ID_PAF_AUDIO_DEPRECATED,
489 AV_CODEC_ID_FFWAVESYNTH = MKBETAG('F','F','W','S'),
490 AV_CODEC_ID_SONIC = MKBETAG('S','O','N','C'),
491 AV_CODEC_ID_SONIC_LS = MKBETAG('S','O','N','L'),
492 AV_CODEC_ID_PAF_AUDIO = MKBETAG('P','A','F','A'),
493 AV_CODEC_ID_OPUS = MKBETAG('O','P','U','S'),
494 AV_CODEC_ID_TAK = MKBETAG('t','B','a','K'),
495 AV_CODEC_ID_EVRC = MKBETAG('s','e','v','c'),
496 AV_CODEC_ID_SMV = MKBETAG('s','s','m','v'),
497 AV_CODEC_ID_DSD_LSBF = MKBETAG('D','S','D','L'),
498 AV_CODEC_ID_DSD_MSBF = MKBETAG('D','S','D','M'),
499 AV_CODEC_ID_DSD_LSBF_PLANAR = MKBETAG('D','S','D','1'),
500 AV_CODEC_ID_DSD_MSBF_PLANAR = MKBETAG('D','S','D','8'),
502 /* subtitle codecs */
503 AV_CODEC_ID_FIRST_SUBTITLE = 0x17000, ///< A dummy ID pointing at the start of subtitle codecs.
504 AV_CODEC_ID_DVD_SUBTITLE = 0x17000,
505 AV_CODEC_ID_DVB_SUBTITLE,
506 AV_CODEC_ID_TEXT, ///< raw UTF-8 text
509 AV_CODEC_ID_MOV_TEXT,
510 AV_CODEC_ID_HDMV_PGS_SUBTITLE,
511 AV_CODEC_ID_DVB_TELETEXT,
513 AV_CODEC_ID_MICRODVD = MKBETAG('m','D','V','D'),
514 AV_CODEC_ID_EIA_608 = MKBETAG('c','6','0','8'),
515 AV_CODEC_ID_JACOSUB = MKBETAG('J','S','U','B'),
516 AV_CODEC_ID_SAMI = MKBETAG('S','A','M','I'),
517 AV_CODEC_ID_REALTEXT = MKBETAG('R','T','X','T'),
518 AV_CODEC_ID_SUBVIEWER1 = MKBETAG('S','b','V','1'),
519 AV_CODEC_ID_SUBVIEWER = MKBETAG('S','u','b','V'),
520 AV_CODEC_ID_SUBRIP = MKBETAG('S','R','i','p'),
521 AV_CODEC_ID_WEBVTT = MKBETAG('W','V','T','T'),
522 AV_CODEC_ID_MPL2 = MKBETAG('M','P','L','2'),
523 AV_CODEC_ID_VPLAYER = MKBETAG('V','P','l','r'),
524 AV_CODEC_ID_PJS = MKBETAG('P','h','J','S'),
525 AV_CODEC_ID_ASS = MKBETAG('A','S','S',' '), ///< ASS as defined in Matroska
527 /* other specific kind of codecs (generally used for attachments) */
528 AV_CODEC_ID_FIRST_UNKNOWN = 0x18000, ///< A dummy ID pointing at the start of various fake codecs.
529 AV_CODEC_ID_TTF = 0x18000,
530 AV_CODEC_ID_BINTEXT = MKBETAG('B','T','X','T'),
531 AV_CODEC_ID_XBIN = MKBETAG('X','B','I','N'),
532 AV_CODEC_ID_IDF = MKBETAG( 0 ,'I','D','F'),
533 AV_CODEC_ID_OTF = MKBETAG( 0 ,'O','T','F'),
534 AV_CODEC_ID_SMPTE_KLV = MKBETAG('K','L','V','A'),
535 AV_CODEC_ID_DVD_NAV = MKBETAG('D','N','A','V'),
536 AV_CODEC_ID_TIMED_ID3 = MKBETAG('T','I','D','3'),
537 AV_CODEC_ID_BIN_DATA = MKBETAG('D','A','T','A'),
540 AV_CODEC_ID_PROBE = 0x19000, ///< codec_id is not known (like AV_CODEC_ID_NONE) but lavf should attempt to identify it
542 AV_CODEC_ID_MPEG2TS = 0x20000, /**< _FAKE_ codec to indicate a raw MPEG-2 TS
543 * stream (only used by libavformat) */
544 AV_CODEC_ID_MPEG4SYSTEMS = 0x20001, /**< _FAKE_ codec to indicate a MPEG-4 Systems
545 * stream (only used by libavformat) */
546 AV_CODEC_ID_FFMETADATA = 0x21000, ///< Dummy codec for streams containing only metadata information.
549 #include "old_codec_ids.h"
554 * This struct describes the properties of a single codec described by an
556 * @see avcodec_get_descriptor()
558 typedef struct AVCodecDescriptor {
560 enum AVMediaType type;
562 * Name of the codec described by this descriptor. It is non-empty and
563 * unique for each codec descriptor. It should contain alphanumeric
564 * characters and '_' only.
568 * A more descriptive name for this codec. May be NULL.
570 const char *long_name;
572 * Codec properties, a combination of AV_CODEC_PROP_* flags.
577 * MIME type(s) associated with the codec.
578 * May be NULL; if not, a NULL-terminated array of MIME types.
579 * The first item is always non-NULL and is the preferred MIME type.
581 const char *const *mime_types;
585 * Codec uses only intra compression.
588 #define AV_CODEC_PROP_INTRA_ONLY (1 << 0)
590 * Codec supports lossy compression. Audio and video codecs only.
591 * @note a codec may support both lossy and lossless
594 #define AV_CODEC_PROP_LOSSY (1 << 1)
596 * Codec supports lossless compression. Audio and video codecs only.
598 #define AV_CODEC_PROP_LOSSLESS (1 << 2)
600 * Codec supports frame reordering. That is, the coded order (the order in which
601 * the encoded packets are output by the encoders / stored / input to the
602 * decoders) may be different from the presentation order of the corresponding
605 * For codecs that do not have this property set, PTS and DTS should always be
608 #define AV_CODEC_PROP_REORDER (1 << 3)
610 * Subtitle codec is bitmap based
611 * Decoded AVSubtitle data can be read from the AVSubtitleRect->pict field.
613 #define AV_CODEC_PROP_BITMAP_SUB (1 << 16)
615 * Subtitle codec is text based.
616 * Decoded AVSubtitle data can be read from the AVSubtitleRect->ass field.
618 #define AV_CODEC_PROP_TEXT_SUB (1 << 17)
621 * @ingroup lavc_decoding
622 * Required number of additionally allocated bytes at the end of the input bitstream for decoding.
623 * This is mainly needed because some optimized bitstream readers read
624 * 32 or 64 bit at once and could read over the end.<br>
625 * Note: If the first 23 bits of the additional bytes are not 0, then damaged
626 * MPEG bitstreams could cause overread and segfault.
628 #define FF_INPUT_BUFFER_PADDING_SIZE 32
631 * @ingroup lavc_encoding
632 * minimum encoding buffer size
633 * Used to avoid some checks during header writing.
635 #define FF_MIN_BUFFER_SIZE 16384
639 * @ingroup lavc_encoding
640 * motion estimation type.
643 ME_ZERO = 1, ///< no search, that is use 0,0 vector whenever one is needed
647 ME_EPZS, ///< enhanced predictive zonal search
648 ME_X1, ///< reserved for experiments
649 ME_HEX, ///< hexagon based search
650 ME_UMH, ///< uneven multi-hexagon search
651 ME_TESA, ///< transformed exhaustive search algorithm
652 ME_ITER=50, ///< iterative search
656 * @ingroup lavc_decoding
659 /* We leave some space between them for extensions (drop some
660 * keyframes for intra-only or drop just some bidir frames). */
661 AVDISCARD_NONE =-16, ///< discard nothing
662 AVDISCARD_DEFAULT = 0, ///< discard useless packets like 0 size packets in avi
663 AVDISCARD_NONREF = 8, ///< discard all non reference
664 AVDISCARD_BIDIR = 16, ///< discard all bidirectional frames
665 AVDISCARD_NONINTRA= 24, ///< discard all non intra frames
666 AVDISCARD_NONKEY = 32, ///< discard all frames except keyframes
667 AVDISCARD_ALL = 48, ///< discard all
670 enum AVAudioServiceType {
671 AV_AUDIO_SERVICE_TYPE_MAIN = 0,
672 AV_AUDIO_SERVICE_TYPE_EFFECTS = 1,
673 AV_AUDIO_SERVICE_TYPE_VISUALLY_IMPAIRED = 2,
674 AV_AUDIO_SERVICE_TYPE_HEARING_IMPAIRED = 3,
675 AV_AUDIO_SERVICE_TYPE_DIALOGUE = 4,
676 AV_AUDIO_SERVICE_TYPE_COMMENTARY = 5,
677 AV_AUDIO_SERVICE_TYPE_EMERGENCY = 6,
678 AV_AUDIO_SERVICE_TYPE_VOICE_OVER = 7,
679 AV_AUDIO_SERVICE_TYPE_KARAOKE = 8,
680 AV_AUDIO_SERVICE_TYPE_NB , ///< Not part of ABI
684 * @ingroup lavc_encoding
686 typedef struct RcOverride{
689 int qscale; // If this is 0 then quality_factor will be used instead.
690 float quality_factor;
693 #if FF_API_MAX_BFRAMES
695 * @deprecated there is no libavcodec-wide limit on the number of B-frames
697 #define FF_MAX_B_FRAMES 16
701 These flags can be passed in AVCodecContext.flags before initialization.
702 Note: Not everything is supported yet.
706 * Allow decoders to produce frames with data planes that are not aligned
707 * to CPU requirements (e.g. due to cropping).
709 #define CODEC_FLAG_UNALIGNED 0x0001
710 #define CODEC_FLAG_QSCALE 0x0002 ///< Use fixed qscale.
711 #define CODEC_FLAG_4MV 0x0004 ///< 4 MV per MB allowed / advanced prediction for H.263.
712 #define CODEC_FLAG_OUTPUT_CORRUPT 0x0008 ///< Output even those frames that might be corrupted
713 #define CODEC_FLAG_QPEL 0x0010 ///< Use qpel MC.
716 * @deprecated use the "gmc" private option of the libxvid encoder
718 #define CODEC_FLAG_GMC 0x0020 ///< Use GMC.
722 * @deprecated use the flag "mv0" in the "mpv_flags" private option of the
725 #define CODEC_FLAG_MV0 0x0040
727 #if FF_API_INPUT_PRESERVED
729 * @deprecated passing reference-counted frames to the encoders replaces this
732 #define CODEC_FLAG_INPUT_PRESERVED 0x0100
734 #define CODEC_FLAG_PASS1 0x0200 ///< Use internal 2pass ratecontrol in first pass mode.
735 #define CODEC_FLAG_PASS2 0x0400 ///< Use internal 2pass ratecontrol in second pass mode.
736 #define CODEC_FLAG_GRAY 0x2000 ///< Only decode/encode grayscale.
739 * @deprecated edges are not used/required anymore. I.e. this flag is now always
742 #define CODEC_FLAG_EMU_EDGE 0x4000
744 #define CODEC_FLAG_PSNR 0x8000 ///< error[?] variables will be set during encoding.
745 #define CODEC_FLAG_TRUNCATED 0x00010000 /** Input bitstream might be truncated at a random
746 location instead of only at frame boundaries. */
747 #if FF_API_NORMALIZE_AQP
749 * @deprecated use the flag "naq" in the "mpv_flags" private option of the
752 #define CODEC_FLAG_NORMALIZE_AQP 0x00020000
754 #define CODEC_FLAG_INTERLACED_DCT 0x00040000 ///< Use interlaced DCT.
755 #define CODEC_FLAG_LOW_DELAY 0x00080000 ///< Force low delay.
756 #define CODEC_FLAG_GLOBAL_HEADER 0x00400000 ///< Place global headers in extradata instead of every keyframe.
757 #define CODEC_FLAG_BITEXACT 0x00800000 ///< Use only bitexact stuff (except (I)DCT).
758 /* Fx : Flag for h263+ extra options */
759 #define CODEC_FLAG_AC_PRED 0x01000000 ///< H.263 advanced intra coding / MPEG-4 AC prediction
760 #define CODEC_FLAG_LOOP_FILTER 0x00000800 ///< loop filter
761 #define CODEC_FLAG_INTERLACED_ME 0x20000000 ///< interlaced motion estimation
762 #define CODEC_FLAG_CLOSED_GOP 0x80000000
763 #define CODEC_FLAG2_FAST 0x00000001 ///< Allow non spec compliant speedup tricks.
764 #define CODEC_FLAG2_NO_OUTPUT 0x00000004 ///< Skip bitstream encoding.
765 #define CODEC_FLAG2_LOCAL_HEADER 0x00000008 ///< Place global headers at every keyframe instead of in extradata.
766 #define CODEC_FLAG2_DROP_FRAME_TIMECODE 0x00002000 ///< timecode is in drop frame format. DEPRECATED!!!!
767 #define CODEC_FLAG2_IGNORE_CROP 0x00010000 ///< Discard cropping information from SPS.
769 #define CODEC_FLAG2_CHUNKS 0x00008000 ///< Input bitstream might be truncated at a packet boundaries instead of only at frame boundaries.
770 #define CODEC_FLAG2_SHOW_ALL 0x00400000 ///< Show all frames before the first keyframe
772 /* Unsupported options :
773 * Syntax Arithmetic coding (SAC)
774 * Reference Picture Selection
775 * Independent Segment Decoding */
777 /* codec capabilities */
779 #define CODEC_CAP_DRAW_HORIZ_BAND 0x0001 ///< Decoder can use draw_horiz_band callback.
781 * Codec uses get_buffer() for allocating buffers and supports custom allocators.
782 * If not set, it might not use get_buffer() at all or use operations that
783 * assume the buffer was allocated by avcodec_default_get_buffer.
785 #define CODEC_CAP_DR1 0x0002
786 #define CODEC_CAP_TRUNCATED 0x0008
788 /* Codec can export data for HW decoding. This flag indicates that
789 * the codec would call get_format() with list that might contain HW accelerated
790 * pixel formats (XvMC, VDPAU, VAAPI, etc). The application can pick any of them
791 * including raw image format.
792 * The application can use the passed context to determine bitstream version,
793 * chroma format, resolution etc.
795 #define CODEC_CAP_HWACCEL 0x0010
796 #endif /* FF_API_XVMC */
798 * Encoder or decoder requires flushing with NULL input at the end in order to
799 * give the complete and correct output.
801 * NOTE: If this flag is not set, the codec is guaranteed to never be fed with
802 * with NULL data. The user can still send NULL data to the public encode
803 * or decode function, but libavcodec will not pass it along to the codec
804 * unless this flag is set.
807 * The decoder has a non-zero delay and needs to be fed with avpkt->data=NULL,
808 * avpkt->size=0 at the end to get the delayed data until the decoder no longer
812 * The encoder needs to be fed with NULL data at the end of encoding until the
813 * encoder no longer returns data.
815 * NOTE: For encoders implementing the AVCodec.encode2() function, setting this
816 * flag also means that the encoder must set the pts and duration for
817 * each output packet. If this flag is not set, the pts and duration will
818 * be determined by libavcodec from the input frame.
820 #define CODEC_CAP_DELAY 0x0020
822 * Codec can be fed a final frame with a smaller size.
823 * This can be used to prevent truncation of the last audio samples.
825 #define CODEC_CAP_SMALL_LAST_FRAME 0x0040
828 * Codec can export data for HW decoding (VDPAU).
830 #define CODEC_CAP_HWACCEL_VDPAU 0x0080
833 * Codec can output multiple frames per AVPacket
834 * Normally demuxers return one frame at a time, demuxers which do not do
835 * are connected to a parser to split what they return into proper frames.
836 * This flag is reserved to the very rare category of codecs which have a
837 * bitstream that cannot be split into frames without timeconsuming
838 * operations like full decoding. Demuxers carring such bitstreams thus
839 * may return multiple frames in a packet. This has many disadvantages like
840 * prohibiting stream copy in many cases thus it should only be considered
843 #define CODEC_CAP_SUBFRAMES 0x0100
845 * Codec is experimental and is thus avoided in favor of non experimental
848 #define CODEC_CAP_EXPERIMENTAL 0x0200
850 * Codec should fill in channel configuration and samplerate instead of container
852 #define CODEC_CAP_CHANNEL_CONF 0x0400
853 #if FF_API_NEG_LINESIZES
855 * @deprecated no codecs use this capability
857 #define CODEC_CAP_NEG_LINESIZES 0x0800
860 * Codec supports frame-level multithreading.
862 #define CODEC_CAP_FRAME_THREADS 0x1000
864 * Codec supports slice-based (or partition-based) multithreading.
866 #define CODEC_CAP_SLICE_THREADS 0x2000
868 * Codec supports changed parameters at any point.
870 #define CODEC_CAP_PARAM_CHANGE 0x4000
872 * Codec supports avctx->thread_count == 0 (auto).
874 #define CODEC_CAP_AUTO_THREADS 0x8000
876 * Audio encoder supports receiving a different number of samples in each call.
878 #define CODEC_CAP_VARIABLE_FRAME_SIZE 0x10000
880 * Codec is intra only.
882 #define CODEC_CAP_INTRA_ONLY 0x40000000
886 #define CODEC_CAP_LOSSLESS 0x80000000
889 //The following defines may change, don't expect compatibility if you use them.
890 #define MB_TYPE_INTRA4x4 0x0001
891 #define MB_TYPE_INTRA16x16 0x0002 //FIXME H.264-specific
892 #define MB_TYPE_INTRA_PCM 0x0004 //FIXME H.264-specific
893 #define MB_TYPE_16x16 0x0008
894 #define MB_TYPE_16x8 0x0010
895 #define MB_TYPE_8x16 0x0020
896 #define MB_TYPE_8x8 0x0040
897 #define MB_TYPE_INTERLACED 0x0080
898 #define MB_TYPE_DIRECT2 0x0100 //FIXME
899 #define MB_TYPE_ACPRED 0x0200
900 #define MB_TYPE_GMC 0x0400
901 #define MB_TYPE_SKIP 0x0800
902 #define MB_TYPE_P0L0 0x1000
903 #define MB_TYPE_P1L0 0x2000
904 #define MB_TYPE_P0L1 0x4000
905 #define MB_TYPE_P1L1 0x8000
906 #define MB_TYPE_L0 (MB_TYPE_P0L0 | MB_TYPE_P1L0)
907 #define MB_TYPE_L1 (MB_TYPE_P0L1 | MB_TYPE_P1L1)
908 #define MB_TYPE_L0L1 (MB_TYPE_L0 | MB_TYPE_L1)
909 #define MB_TYPE_QUANT 0x00010000
910 #define MB_TYPE_CBP 0x00020000
911 //Note bits 24-31 are reserved for codec specific use (h264 ref0, mpeg1 0mv, ...)
916 * This specifies the area which should be displayed.
917 * Note there may be multiple such areas for one frame.
919 typedef struct AVPanScan{
922 * - encoding: Set by user.
923 * - decoding: Set by libavcodec.
928 * width and height in 1/16 pel
929 * - encoding: Set by user.
930 * - decoding: Set by libavcodec.
936 * position of the top left corner in 1/16 pel for up to 3 fields/frames
937 * - encoding: Set by user.
938 * - decoding: Set by libavcodec.
940 int16_t position[3][2];
943 #if FF_API_QSCALE_TYPE
944 #define FF_QSCALE_TYPE_MPEG1 0
945 #define FF_QSCALE_TYPE_MPEG2 1
946 #define FF_QSCALE_TYPE_H264 2
947 #define FF_QSCALE_TYPE_VP56 3
950 #if FF_API_GET_BUFFER
951 #define FF_BUFFER_TYPE_INTERNAL 1
952 #define FF_BUFFER_TYPE_USER 2 ///< direct rendering buffers (image is (de)allocated by user)
953 #define FF_BUFFER_TYPE_SHARED 4 ///< Buffer from somewhere else; don't deallocate image (data/base), all other tables are not shared.
954 #define FF_BUFFER_TYPE_COPY 8 ///< Just a (modified) copy of some other buffer, don't deallocate anything.
956 #define FF_BUFFER_HINTS_VALID 0x01 // Buffer hints value is meaningful (if 0 ignore).
957 #define FF_BUFFER_HINTS_READABLE 0x02 // Codec will read from buffer.
958 #define FF_BUFFER_HINTS_PRESERVE 0x04 // User must not alter buffer content.
959 #define FF_BUFFER_HINTS_REUSABLE 0x08 // Codec will reuse the buffer (update).
963 * The decoder will keep a reference to the frame and may reuse it later.
965 #define AV_GET_BUFFER_FLAG_REF (1 << 0)
968 * @defgroup lavc_packet AVPacket
970 * Types and functions for working with AVPacket.
973 enum AVPacketSideDataType {
975 AV_PKT_DATA_NEW_EXTRADATA,
978 * An AV_PKT_DATA_PARAM_CHANGE side data packet is laid out as follows:
981 * if (param_flags & AV_SIDE_DATA_PARAM_CHANGE_CHANNEL_COUNT)
982 * s32le channel_count
983 * if (param_flags & AV_SIDE_DATA_PARAM_CHANGE_CHANNEL_LAYOUT)
984 * u64le channel_layout
985 * if (param_flags & AV_SIDE_DATA_PARAM_CHANGE_SAMPLE_RATE)
987 * if (param_flags & AV_SIDE_DATA_PARAM_CHANGE_DIMENSIONS)
992 AV_PKT_DATA_PARAM_CHANGE,
995 * An AV_PKT_DATA_H263_MB_INFO side data packet contains a number of
996 * structures with info about macroblocks relevant to splitting the
997 * packet into smaller packets on macroblock edges (e.g. as for RFC 2190).
998 * That is, it does not necessarily contain info about all macroblocks,
999 * as long as the distance between macroblocks in the info is smaller
1000 * than the target payload size.
1001 * Each MB info structure is 12 bytes, and is laid out as follows:
1003 * u32le bit offset from the start of the packet
1004 * u8 current quantizer at the start of the macroblock
1006 * u16le macroblock address within the GOB
1007 * u8 horizontal MV predictor
1008 * u8 vertical MV predictor
1009 * u8 horizontal MV predictor for block number 3
1010 * u8 vertical MV predictor for block number 3
1013 AV_PKT_DATA_H263_MB_INFO,
1016 * This side data should be associated with an audio stream and contains
1017 * ReplayGain information in form of the AVReplayGain struct.
1019 AV_PKT_DATA_REPLAYGAIN,
1022 * This side data contains a 3x3 transformation matrix describing an affine
1023 * transformation that needs to be applied to the decoded video frames for
1024 * correct presentation.
1026 * See libavutil/display.h for a detailed description of the data.
1028 AV_PKT_DATA_DISPLAYMATRIX,
1031 * Recommmends skipping the specified number of samples
1033 * u32le number of samples to skip from start of this packet
1034 * u32le number of samples to skip from end of this packet
1035 * u8 reason for start skip
1036 * u8 reason for end skip (0=padding silence, 1=convergence)
1039 AV_PKT_DATA_SKIP_SAMPLES=70,
1042 * An AV_PKT_DATA_JP_DUALMONO side data packet indicates that
1043 * the packet may contain "dual mono" audio specific to Japanese DTV
1044 * and if it is true, recommends only the selected channel to be used.
1046 * u8 selected channels (0=mail/left, 1=sub/right, 2=both)
1049 AV_PKT_DATA_JP_DUALMONO,
1052 * A list of zero terminated key/value strings. There is no end marker for
1053 * the list, so it is required to rely on the side data size to stop.
1055 AV_PKT_DATA_STRINGS_METADATA,
1058 * Subtitle event position
1066 AV_PKT_DATA_SUBTITLE_POSITION,
1069 * Data found in BlockAdditional element of matroska container. There is
1070 * no end marker for the data, so it is required to rely on the side data
1071 * size to recognize the end. 8 byte id (as found in BlockAddId) followed
1074 AV_PKT_DATA_MATROSKA_BLOCKADDITIONAL,
1077 * The optional first identifier line of a WebVTT cue.
1079 AV_PKT_DATA_WEBVTT_IDENTIFIER,
1082 * The optional settings (rendering instructions) that immediately
1083 * follow the timestamp specifier of a WebVTT cue.
1085 AV_PKT_DATA_WEBVTT_SETTINGS,
1088 * A list of zero terminated key/value strings. There is no end marker for
1089 * the list, so it is required to rely on the side data size to stop. This
1090 * side data includes updated metadata which appeared in the stream.
1092 AV_PKT_DATA_METADATA_UPDATE,
1095 typedef struct AVPacketSideData {
1098 enum AVPacketSideDataType type;
1102 * This structure stores compressed data. It is typically exported by demuxers
1103 * and then passed as input to decoders, or received as output from encoders and
1104 * then passed to muxers.
1106 * For video, it should typically contain one compressed frame. For audio it may
1107 * contain several compressed frames.
1109 * AVPacket is one of the few structs in FFmpeg, whose size is a part of public
1110 * ABI. Thus it may be allocated on stack and no new fields can be added to it
1111 * without libavcodec and libavformat major bump.
1113 * The semantics of data ownership depends on the buf or destruct (deprecated)
1114 * fields. If either is set, the packet data is dynamically allocated and is
1115 * valid indefinitely until av_free_packet() is called (which in turn calls
1116 * av_buffer_unref()/the destruct callback to free the data). If neither is set,
1117 * the packet data is typically backed by some static buffer somewhere and is
1118 * only valid for a limited time (e.g. until the next read call when demuxing).
1120 * The side data is always allocated with av_malloc() and is freed in
1123 typedef struct AVPacket {
1125 * A reference to the reference-counted buffer where the packet data is
1127 * May be NULL, then the packet data is not reference-counted.
1131 * Presentation timestamp in AVStream->time_base units; the time at which
1132 * the decompressed packet will be presented to the user.
1133 * Can be AV_NOPTS_VALUE if it is not stored in the file.
1134 * pts MUST be larger or equal to dts as presentation cannot happen before
1135 * decompression, unless one wants to view hex dumps. Some formats misuse
1136 * the terms dts and pts/cts to mean something different. Such timestamps
1137 * must be converted to true pts/dts before they are stored in AVPacket.
1141 * Decompression timestamp in AVStream->time_base units; the time at which
1142 * the packet is decompressed.
1143 * Can be AV_NOPTS_VALUE if it is not stored in the file.
1150 * A combination of AV_PKT_FLAG values
1154 * Additional packet data that can be provided by the container.
1155 * Packet can contain several types of side information.
1157 AVPacketSideData *side_data;
1158 int side_data_elems;
1161 * Duration of this packet in AVStream->time_base units, 0 if unknown.
1162 * Equals next_pts - this_pts in presentation order.
1165 #if FF_API_DESTRUCT_PACKET
1166 attribute_deprecated
1167 void (*destruct)(struct AVPacket *);
1168 attribute_deprecated
1171 int64_t pos; ///< byte position in stream, -1 if unknown
1174 * Time difference in AVStream->time_base units from the pts of this
1175 * packet to the point at which the output from the decoder has converged
1176 * independent from the availability of previous frames. That is, the
1177 * frames are virtually identical no matter if decoding started from
1178 * the very first frame or from this keyframe.
1179 * Is AV_NOPTS_VALUE if unknown.
1180 * This field is not the display duration of the current packet.
1181 * This field has no meaning if the packet does not have AV_PKT_FLAG_KEY
1184 * The purpose of this field is to allow seeking in streams that have no
1185 * keyframes in the conventional sense. It corresponds to the
1186 * recovery point SEI in H.264 and match_time_delta in NUT. It is also
1187 * essential for some types of subtitle streams to ensure that all
1188 * subtitles are correctly displayed after seeking.
1190 int64_t convergence_duration;
1192 #define AV_PKT_FLAG_KEY 0x0001 ///< The packet contains a keyframe
1193 #define AV_PKT_FLAG_CORRUPT 0x0002 ///< The packet content is corrupted
1195 enum AVSideDataParamChangeFlags {
1196 AV_SIDE_DATA_PARAM_CHANGE_CHANNEL_COUNT = 0x0001,
1197 AV_SIDE_DATA_PARAM_CHANGE_CHANNEL_LAYOUT = 0x0002,
1198 AV_SIDE_DATA_PARAM_CHANGE_SAMPLE_RATE = 0x0004,
1199 AV_SIDE_DATA_PARAM_CHANGE_DIMENSIONS = 0x0008,
1205 struct AVCodecInternal;
1209 AV_FIELD_PROGRESSIVE,
1210 AV_FIELD_TT, //< Top coded_first, top displayed first
1211 AV_FIELD_BB, //< Bottom coded first, bottom displayed first
1212 AV_FIELD_TB, //< Top coded first, bottom displayed first
1213 AV_FIELD_BT, //< Bottom coded first, top displayed first
1217 * main external API structure.
1218 * New fields can be added to the end with minor version bumps.
1219 * Removal, reordering and changes to existing fields require a major
1221 * Please use AVOptions (av_opt* / av_set/get*()) to access these fields from user
1223 * sizeof(AVCodecContext) must not be used outside libav*.
1225 typedef struct AVCodecContext {
1227 * information on struct for av_log
1228 * - set by avcodec_alloc_context3
1230 const AVClass *av_class;
1231 int log_level_offset;
1233 enum AVMediaType codec_type; /* see AVMEDIA_TYPE_xxx */
1234 const struct AVCodec *codec;
1235 #if FF_API_CODEC_NAME
1237 * @deprecated this field is not used for anything in libavcodec
1239 attribute_deprecated
1240 char codec_name[32];
1242 enum AVCodecID codec_id; /* see AV_CODEC_ID_xxx */
1245 * fourcc (LSB first, so "ABCD" -> ('D'<<24) + ('C'<<16) + ('B'<<8) + 'A').
1246 * This is used to work around some encoder bugs.
1247 * A demuxer should set this to what is stored in the field used to identify the codec.
1248 * If there are multiple such fields in a container then the demuxer should choose the one
1249 * which maximizes the information about the used codec.
1250 * If the codec tag field in a container is larger than 32 bits then the demuxer should
1251 * remap the longer ID to 32 bits with a table or other structure. Alternatively a new
1252 * extra_codec_tag + size could be added but for this a clear advantage must be demonstrated
1254 * - encoding: Set by user, if not then the default based on codec_id will be used.
1255 * - decoding: Set by user, will be converted to uppercase by libavcodec during init.
1257 unsigned int codec_tag;
1260 * fourcc from the AVI stream header (LSB first, so "ABCD" -> ('D'<<24) + ('C'<<16) + ('B'<<8) + 'A').
1261 * This is used to work around some encoder bugs.
1262 * - encoding: unused
1263 * - decoding: Set by user, will be converted to uppercase by libavcodec during init.
1265 unsigned int stream_codec_tag;
1270 * Private context used for internal data.
1272 * Unlike priv_data, this is not codec-specific. It is used in general
1273 * libavcodec functions.
1275 struct AVCodecInternal *internal;
1278 * Private data of the user, can be used to carry app specific stuff.
1279 * - encoding: Set by user.
1280 * - decoding: Set by user.
1285 * the average bitrate
1286 * - encoding: Set by user; unused for constant quantizer encoding.
1287 * - decoding: Set by libavcodec. 0 or some bitrate if this info is available in the stream.
1292 * number of bits the bitstream is allowed to diverge from the reference.
1293 * the reference can be CBR (for CBR pass1) or VBR (for pass2)
1294 * - encoding: Set by user; unused for constant quantizer encoding.
1295 * - decoding: unused
1297 int bit_rate_tolerance;
1300 * Global quality for codecs which cannot change it per frame.
1301 * This should be proportional to MPEG-1/2/4 qscale.
1302 * - encoding: Set by user.
1303 * - decoding: unused
1308 * - encoding: Set by user.
1309 * - decoding: unused
1311 int compression_level;
1312 #define FF_COMPRESSION_DEFAULT -1
1316 * - encoding: Set by user.
1317 * - decoding: Set by user.
1323 * - encoding: Set by user.
1324 * - decoding: Set by user.
1329 * some codecs need / can use extradata like Huffman tables.
1330 * mjpeg: Huffman tables
1331 * rv10: additional flags
1332 * mpeg4: global headers (they can be in the bitstream or here)
1333 * The allocated memory should be FF_INPUT_BUFFER_PADDING_SIZE bytes larger
1334 * than extradata_size to avoid problems if it is read with the bitstream reader.
1335 * The bytewise contents of extradata must not depend on the architecture or CPU endianness.
1336 * - encoding: Set/allocated/freed by libavcodec.
1337 * - decoding: Set/allocated/freed by user.
1343 * This is the fundamental unit of time (in seconds) in terms
1344 * of which frame timestamps are represented. For fixed-fps content,
1345 * timebase should be 1/framerate and timestamp increments should be
1347 * - encoding: MUST be set by user.
1348 * - decoding: Set by libavcodec.
1350 AVRational time_base;
1353 * For some codecs, the time base is closer to the field rate than the frame rate.
1354 * Most notably, H.264 and MPEG-2 specify time_base as half of frame duration
1355 * if no telecine is used ...
1357 * Set to time_base ticks per frame. Default 1, e.g., H.264/MPEG-2 set it to 2.
1359 int ticks_per_frame;
1364 * Encoding: Number of frames delay there will be from the encoder input to
1365 * the decoder output. (we assume the decoder matches the spec)
1366 * Decoding: Number of frames delay in addition to what a standard decoder
1367 * as specified in the spec would produce.
1370 * Number of frames the decoded output will be delayed relative to the
1374 * For encoding, this is the number of "priming" samples added by the
1375 * encoder to the beginning of the stream. The decoded output will be
1376 * delayed by this many samples relative to the input to the encoder (or
1377 * more, if the decoder adds its own padding).
1378 * The timestamps on the output packets are adjusted by the encoder so
1379 * that they always refer to the first sample of the data actually
1380 * contained in the packet, including any added padding.
1381 * E.g. if the timebase is 1/samplerate and the timestamp of the first
1382 * input sample is 0, the timestamp of the first output packet will be
1385 * For decoding, this is the number of samples the decoder needs to
1386 * output before the decoder's output is valid. When seeking, you should
1387 * start decoding this many samples prior to your desired seek point.
1389 * - encoding: Set by libavcodec.
1390 * - decoding: Set by libavcodec.
1397 * picture width / height.
1398 * - encoding: MUST be set by user.
1399 * - decoding: May be set by the user before opening the decoder if known e.g.
1400 * from the container. Some decoders will require the dimensions
1401 * to be set by the caller. During decoding, the decoder may
1402 * overwrite those values as required.
1407 * Bitstream width / height, may be different from width/height e.g. when
1408 * the decoded frame is cropped before being output or lowres is enabled.
1409 * - encoding: unused
1410 * - decoding: May be set by the user before opening the decoder if known
1411 * e.g. from the container. During decoding, the decoder may
1412 * overwrite those values as required.
1414 int coded_width, coded_height;
1416 #if FF_API_ASPECT_EXTENDED
1417 #define FF_ASPECT_EXTENDED 15
1421 * the number of pictures in a group of pictures, or 0 for intra_only
1422 * - encoding: Set by user.
1423 * - decoding: unused
1428 * Pixel format, see AV_PIX_FMT_xxx.
1429 * May be set by the demuxer if known from headers.
1430 * May be overridden by the decoder if it knows better.
1431 * - encoding: Set by user.
1432 * - decoding: Set by user if known, overridden by libavcodec if known
1434 enum AVPixelFormat pix_fmt;
1437 * Motion estimation algorithm used for video coding.
1438 * 1 (zero), 2 (full), 3 (log), 4 (phods), 5 (epzs), 6 (x1), 7 (hex),
1439 * 8 (umh), 9 (iter), 10 (tesa) [7, 8, 10 are x264 specific, 9 is snow specific]
1440 * - encoding: MUST be set by user.
1441 * - decoding: unused
1446 * If non NULL, 'draw_horiz_band' is called by the libavcodec
1447 * decoder to draw a horizontal band. It improves cache usage. Not
1448 * all codecs can do that. You must check the codec capabilities
1450 * When multithreading is used, it may be called from multiple threads
1451 * at the same time; threads might draw different parts of the same AVFrame,
1452 * or multiple AVFrames, and there is no guarantee that slices will be drawn
1454 * The function is also used by hardware acceleration APIs.
1455 * It is called at least once during frame decoding to pass
1456 * the data needed for hardware render.
1457 * In that mode instead of pixel data, AVFrame points to
1458 * a structure specific to the acceleration API. The application
1459 * reads the structure and can change some fields to indicate progress
1461 * - encoding: unused
1462 * - decoding: Set by user.
1463 * @param height the height of the slice
1464 * @param y the y position of the slice
1465 * @param type 1->top field, 2->bottom field, 3->frame
1466 * @param offset offset into the AVFrame.data from which the slice should be read
1468 void (*draw_horiz_band)(struct AVCodecContext *s,
1469 const AVFrame *src, int offset[AV_NUM_DATA_POINTERS],
1470 int y, int type, int height);
1473 * callback to negotiate the pixelFormat
1474 * @param fmt is the list of formats which are supported by the codec,
1475 * it is terminated by -1 as 0 is a valid format, the formats are ordered by quality.
1476 * The first is always the native one.
1477 * @return the chosen format
1478 * - encoding: unused
1479 * - decoding: Set by user, if not set the native format will be chosen.
1481 enum AVPixelFormat (*get_format)(struct AVCodecContext *s, const enum AVPixelFormat * fmt);
1484 * maximum number of B-frames between non-B-frames
1485 * Note: The output will be delayed by max_b_frames+1 relative to the input.
1486 * - encoding: Set by user.
1487 * - decoding: unused
1492 * qscale factor between IP and B-frames
1493 * If > 0 then the last P-frame quantizer will be used (q= lastp_q*factor+offset).
1494 * If < 0 then normal ratecontrol will be done (q= -normal_q*factor+offset).
1495 * - encoding: Set by user.
1496 * - decoding: unused
1498 float b_quant_factor;
1500 /** obsolete FIXME remove */
1502 #define FF_RC_STRATEGY_XVID 1
1504 int b_frame_strategy;
1507 * qscale offset between IP and B-frames
1508 * - encoding: Set by user.
1509 * - decoding: unused
1511 float b_quant_offset;
1514 * Size of the frame reordering buffer in the decoder.
1515 * For MPEG-2 it is 1 IPB or 0 low delay IP.
1516 * - encoding: Set by libavcodec.
1517 * - decoding: Set by libavcodec.
1522 * 0-> h263 quant 1-> mpeg quant
1523 * - encoding: Set by user.
1524 * - decoding: unused
1529 * qscale factor between P and I-frames
1530 * If > 0 then the last p frame quantizer will be used (q= lastp_q*factor+offset).
1531 * If < 0 then normal ratecontrol will be done (q= -normal_q*factor+offset).
1532 * - encoding: Set by user.
1533 * - decoding: unused
1535 float i_quant_factor;
1538 * qscale offset between P and I-frames
1539 * - encoding: Set by user.
1540 * - decoding: unused
1542 float i_quant_offset;
1545 * luminance masking (0-> disabled)
1546 * - encoding: Set by user.
1547 * - decoding: unused
1552 * temporary complexity masking (0-> disabled)
1553 * - encoding: Set by user.
1554 * - decoding: unused
1556 float temporal_cplx_masking;
1559 * spatial complexity masking (0-> disabled)
1560 * - encoding: Set by user.
1561 * - decoding: unused
1563 float spatial_cplx_masking;
1566 * p block masking (0-> disabled)
1567 * - encoding: Set by user.
1568 * - decoding: unused
1573 * darkness masking (0-> disabled)
1574 * - encoding: Set by user.
1575 * - decoding: unused
1581 * - encoding: Set by libavcodec.
1582 * - decoding: Set by user (or 0).
1586 * prediction method (needed for huffyuv)
1587 * - encoding: Set by user.
1588 * - decoding: unused
1590 int prediction_method;
1591 #define FF_PRED_LEFT 0
1592 #define FF_PRED_PLANE 1
1593 #define FF_PRED_MEDIAN 2
1596 * slice offsets in the frame in bytes
1597 * - encoding: Set/allocated by libavcodec.
1598 * - decoding: Set/allocated by user (or NULL).
1603 * sample aspect ratio (0 if unknown)
1604 * That is the width of a pixel divided by the height of the pixel.
1605 * Numerator and denominator must be relatively prime and smaller than 256 for some video standards.
1606 * - encoding: Set by user.
1607 * - decoding: Set by libavcodec.
1609 AVRational sample_aspect_ratio;
1612 * motion estimation comparison function
1613 * - encoding: Set by user.
1614 * - decoding: unused
1618 * subpixel motion estimation comparison function
1619 * - encoding: Set by user.
1620 * - decoding: unused
1624 * macroblock comparison function (not supported yet)
1625 * - encoding: Set by user.
1626 * - decoding: unused
1630 * interlaced DCT comparison function
1631 * - encoding: Set by user.
1632 * - decoding: unused
1635 #define FF_CMP_SAD 0
1636 #define FF_CMP_SSE 1
1637 #define FF_CMP_SATD 2
1638 #define FF_CMP_DCT 3
1639 #define FF_CMP_PSNR 4
1640 #define FF_CMP_BIT 5
1642 #define FF_CMP_ZERO 7
1643 #define FF_CMP_VSAD 8
1644 #define FF_CMP_VSSE 9
1645 #define FF_CMP_NSSE 10
1646 #define FF_CMP_W53 11
1647 #define FF_CMP_W97 12
1648 #define FF_CMP_DCTMAX 13
1649 #define FF_CMP_DCT264 14
1650 #define FF_CMP_CHROMA 256
1653 * ME diamond size & shape
1654 * - encoding: Set by user.
1655 * - decoding: unused
1660 * amount of previous MV predictors (2a+1 x 2a+1 square)
1661 * - encoding: Set by user.
1662 * - decoding: unused
1664 int last_predictor_count;
1667 * prepass for motion estimation
1668 * - encoding: Set by user.
1669 * - decoding: unused
1674 * motion estimation prepass comparison function
1675 * - encoding: Set by user.
1676 * - decoding: unused
1681 * ME prepass diamond size & shape
1682 * - encoding: Set by user.
1683 * - decoding: unused
1689 * - encoding: Set by user.
1690 * - decoding: unused
1692 int me_subpel_quality;
1695 * DTG active format information (additional aspect ratio
1696 * information only used in DVB MPEG-2 transport streams)
1699 * - encoding: unused
1700 * - decoding: Set by decoder.
1702 int dtg_active_format;
1703 #define FF_DTG_AFD_SAME 8
1704 #define FF_DTG_AFD_4_3 9
1705 #define FF_DTG_AFD_16_9 10
1706 #define FF_DTG_AFD_14_9 11
1707 #define FF_DTG_AFD_4_3_SP_14_9 13
1708 #define FF_DTG_AFD_16_9_SP_14_9 14
1709 #define FF_DTG_AFD_SP_4_3 15
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
1896 * Multiplied by qscale for each frame and added to scene_change_score.
1897 * - encoding: Set by user.
1898 * - decoding: unused
1900 int scenechange_factor;
1904 * Note: Value depends upon the compare function used for fullpel ME.
1905 * - encoding: Set by user.
1906 * - decoding: unused
1911 * Adjust sensitivity of b_frame_strategy 1.
1912 * - encoding: Set by user.
1913 * - decoding: unused
1918 * Chromaticity coordinates of the source primaries.
1919 * - encoding: Set by user
1920 * - decoding: Set by libavcodec
1922 enum AVColorPrimaries color_primaries;
1925 * Color Transfer Characteristic.
1926 * - encoding: Set by user
1927 * - decoding: Set by libavcodec
1929 enum AVColorTransferCharacteristic color_trc;
1932 * YUV colorspace type.
1933 * - encoding: Set by user
1934 * - decoding: Set by libavcodec
1936 enum AVColorSpace colorspace;
1939 * MPEG vs JPEG YUV range.
1940 * - encoding: Set by user
1941 * - decoding: Set by libavcodec
1943 enum AVColorRange color_range;
1946 * This defines the location of chroma samples.
1947 * - encoding: Set by user
1948 * - decoding: Set by libavcodec
1950 enum AVChromaLocation chroma_sample_location;
1954 * Indicates number of picture subdivisions. Used for parallelized
1956 * - encoding: Set by user
1957 * - decoding: unused
1962 * - encoding: set by libavcodec
1963 * - decoding: Set by user.
1965 enum AVFieldOrder field_order;
1968 int sample_rate; ///< samples per second
1969 int channels; ///< number of audio channels
1972 * audio sample format
1973 * - encoding: Set by user.
1974 * - decoding: Set by libavcodec.
1976 enum AVSampleFormat sample_fmt; ///< sample format
1978 /* The following data should not be initialized. */
1980 * Number of samples per channel in an audio frame.
1982 * - encoding: set by libavcodec in avcodec_open2(). Each submitted frame
1983 * except the last must contain exactly frame_size samples per channel.
1984 * May be 0 when the codec has CODEC_CAP_VARIABLE_FRAME_SIZE set, then the
1985 * frame size is not restricted.
1986 * - decoding: may be set by some decoders to indicate constant frame size
1991 * Frame counter, set by libavcodec.
1993 * - decoding: total number of frames returned from the decoder so far.
1994 * - encoding: total number of frames passed to the encoder so far.
1996 * @note the counter is not incremented if encoding/decoding resulted in
2002 * number of bytes per packet if constant and known or 0
2003 * Used by some WAV based audio codecs.
2008 * Audio cutoff bandwidth (0 means "automatic")
2009 * - encoding: Set by user.
2010 * - decoding: unused
2014 #if FF_API_REQUEST_CHANNELS
2016 * Decoder should decode to this many channels if it can (0 for default)
2017 * - encoding: unused
2018 * - decoding: Set by user.
2019 * @deprecated Deprecated in favor of request_channel_layout.
2021 attribute_deprecated int request_channels;
2025 * Audio channel layout.
2026 * - encoding: set by user.
2027 * - decoding: set by user, may be overwritten by libavcodec.
2029 uint64_t channel_layout;
2032 * Request decoder to use this channel layout if it can (0 for default)
2033 * - encoding: unused
2034 * - decoding: Set by user.
2036 uint64_t request_channel_layout;
2039 * Type of service that the audio stream conveys.
2040 * - encoding: Set by user.
2041 * - decoding: Set by libavcodec.
2043 enum AVAudioServiceType audio_service_type;
2046 * desired sample format
2047 * - encoding: Not used.
2048 * - decoding: Set by user.
2049 * Decoder will decode to this format if it can.
2051 enum AVSampleFormat request_sample_fmt;
2053 #if FF_API_GET_BUFFER
2055 * Called at the beginning of each frame to get a buffer for it.
2057 * The function will set AVFrame.data[], AVFrame.linesize[].
2058 * AVFrame.extended_data[] must also be set, but it should be the same as
2059 * AVFrame.data[] except for planar audio with more channels than can fit
2060 * in AVFrame.data[]. In that case, AVFrame.data[] shall still contain as
2061 * many data pointers as it can hold.
2063 * if CODEC_CAP_DR1 is not set then get_buffer() must call
2064 * avcodec_default_get_buffer() instead of providing buffers allocated by
2067 * AVFrame.data[] should be 32- or 16-byte-aligned unless the CPU doesn't
2068 * need it. avcodec_default_get_buffer() aligns the output buffer properly,
2069 * but if get_buffer() is overridden then alignment considerations should
2070 * be taken into account.
2072 * @see avcodec_default_get_buffer()
2076 * If pic.reference is set then the frame will be read later by libavcodec.
2077 * avcodec_align_dimensions2() should be used to find the required width and
2078 * height, as they normally need to be rounded up to the next multiple of 16.
2080 * If frame multithreading is used and thread_safe_callbacks is set,
2081 * it may be called from a different thread, but not from more than one at
2082 * once. Does not need to be reentrant.
2084 * @see release_buffer(), reget_buffer()
2085 * @see avcodec_align_dimensions2()
2089 * Decoders request a buffer of a particular size by setting
2090 * AVFrame.nb_samples prior to calling get_buffer(). The decoder may,
2091 * however, utilize only part of the buffer by setting AVFrame.nb_samples
2092 * to a smaller value in the output frame.
2094 * Decoders cannot use the buffer after returning from
2095 * avcodec_decode_audio4(), so they will not call release_buffer(), as it
2096 * is assumed to be released immediately upon return. In some rare cases,
2097 * a decoder may need to call get_buffer() more than once in a single
2098 * call to avcodec_decode_audio4(). In that case, when get_buffer() is
2099 * called again after it has already been called once, the previously
2100 * acquired buffer is assumed to be released at that time and may not be
2101 * reused by the decoder.
2103 * As a convenience, av_samples_get_buffer_size() and
2104 * av_samples_fill_arrays() in libavutil may be used by custom get_buffer()
2105 * functions to find the required data size and to fill data pointers and
2106 * linesize. In AVFrame.linesize, only linesize[0] may be set for audio
2107 * since all planes must be the same size.
2109 * @see av_samples_get_buffer_size(), av_samples_fill_arrays()
2111 * - encoding: unused
2112 * - decoding: Set by libavcodec, user can override.
2114 * @deprecated use get_buffer2()
2116 attribute_deprecated
2117 int (*get_buffer)(struct AVCodecContext *c, AVFrame *pic);
2120 * Called to release buffers which were allocated with get_buffer.
2121 * A released buffer can be reused in get_buffer().
2122 * pic.data[*] must be set to NULL.
2123 * May be called from a different thread if frame multithreading is used,
2124 * but not by more than one thread at once, so does not need to be reentrant.
2125 * - encoding: unused
2126 * - decoding: Set by libavcodec, user can override.
2128 * @deprecated custom freeing callbacks should be set from get_buffer2()
2130 attribute_deprecated
2131 void (*release_buffer)(struct AVCodecContext *c, AVFrame *pic);
2134 * Called at the beginning of a frame to get cr buffer for it.
2135 * Buffer type (size, hints) must be the same. libavcodec won't check it.
2136 * libavcodec will pass previous buffer in pic, function should return
2137 * same buffer or new buffer with old frame "painted" into it.
2138 * If pic.data[0] == NULL must behave like get_buffer().
2139 * if CODEC_CAP_DR1 is not set then reget_buffer() must call
2140 * avcodec_default_reget_buffer() instead of providing buffers allocated by
2142 * - encoding: unused
2143 * - decoding: Set by libavcodec, user can override.
2145 attribute_deprecated
2146 int (*reget_buffer)(struct AVCodecContext *c, AVFrame *pic);
2150 * This callback is called at the beginning of each frame to get data
2151 * buffer(s) for it. There may be one contiguous buffer for all the data or
2152 * there may be a buffer per each data plane or anything in between. What
2153 * this means is, you may set however many entries in buf[] you feel necessary.
2154 * Each buffer must be reference-counted using the AVBuffer API (see description
2157 * The following fields will be set in the frame before this callback is
2160 * - width, height (video only)
2161 * - sample_rate, channel_layout, nb_samples (audio only)
2162 * Their values may differ from the corresponding values in
2163 * AVCodecContext. This callback must use the frame values, not the codec
2164 * context values, to calculate the required buffer size.
2166 * This callback must fill the following fields in the frame:
2170 * * if the data is planar audio with more than 8 channels, then this
2171 * callback must allocate and fill extended_data to contain all pointers
2172 * to all data planes. data[] must hold as many pointers as it can.
2173 * extended_data must be allocated with av_malloc() and will be freed in
2175 * * otherwise exended_data must point to data
2176 * - buf[] must contain one or more pointers to AVBufferRef structures. Each of
2177 * the frame's data and extended_data pointers must be contained in these. That
2178 * is, one AVBufferRef for each allocated chunk of memory, not necessarily one
2179 * AVBufferRef per data[] entry. See: av_buffer_create(), av_buffer_alloc(),
2180 * and av_buffer_ref().
2181 * - extended_buf and nb_extended_buf must be allocated with av_malloc() by
2182 * this callback and filled with the extra buffers if there are more
2183 * buffers than buf[] can hold. extended_buf will be freed in
2186 * If CODEC_CAP_DR1 is not set then get_buffer2() must call
2187 * avcodec_default_get_buffer2() instead of providing buffers allocated by
2190 * Each data plane must be aligned to the maximum required by the target
2193 * @see avcodec_default_get_buffer2()
2197 * If AV_GET_BUFFER_FLAG_REF is set in flags then the frame may be reused
2198 * (read and/or written to if it is writable) later by libavcodec.
2200 * avcodec_align_dimensions2() should be used to find the required width and
2201 * height, as they normally need to be rounded up to the next multiple of 16.
2203 * Some decoders do not support linesizes changing between frames.
2205 * If frame multithreading is used and thread_safe_callbacks is set,
2206 * this callback may be called from a different thread, but not from more
2207 * than one at once. Does not need to be reentrant.
2209 * @see avcodec_align_dimensions2()
2213 * Decoders request a buffer of a particular size by setting
2214 * AVFrame.nb_samples prior to calling get_buffer2(). The decoder may,
2215 * however, utilize only part of the buffer by setting AVFrame.nb_samples
2216 * to a smaller value in the output frame.
2218 * As a convenience, av_samples_get_buffer_size() and
2219 * av_samples_fill_arrays() in libavutil may be used by custom get_buffer2()
2220 * functions to find the required data size and to fill data pointers and
2221 * linesize. In AVFrame.linesize, only linesize[0] may be set for audio
2222 * since all planes must be the same size.
2224 * @see av_samples_get_buffer_size(), av_samples_fill_arrays()
2226 * - encoding: unused
2227 * - decoding: Set by libavcodec, user can override.
2229 int (*get_buffer2)(struct AVCodecContext *s, AVFrame *frame, int flags);
2232 * If non-zero, the decoded audio and video frames returned from
2233 * avcodec_decode_video2() and avcodec_decode_audio4() are reference-counted
2234 * and are valid indefinitely. The caller must free them with
2235 * av_frame_unref() when they are not needed anymore.
2236 * Otherwise, the decoded frames must not be freed by the caller and are
2237 * only valid until the next decode call.
2239 * - encoding: unused
2240 * - decoding: set by the caller before avcodec_open2().
2242 int refcounted_frames;
2244 /* - encoding parameters */
2245 float qcompress; ///< amount of qscale change between easy & hard scenes (0.0-1.0)
2246 float qblur; ///< amount of qscale smoothing over time (0.0-1.0)
2250 * - encoding: Set by user.
2251 * - decoding: unused
2257 * - encoding: Set by user.
2258 * - decoding: unused
2263 * maximum quantizer difference between frames
2264 * - encoding: Set by user.
2265 * - decoding: unused
2270 * ratecontrol qmin qmax limiting method
2271 * 0-> clipping, 1-> use a nice continuous function to limit qscale within qmin/qmax.
2272 * - encoding: Set by user.
2273 * - decoding: unused
2281 * decoder bitstream buffer size
2282 * - encoding: Set by user.
2283 * - decoding: unused
2288 * ratecontrol override, see RcOverride
2289 * - encoding: Allocated/set/freed by user.
2290 * - decoding: unused
2292 int rc_override_count;
2293 RcOverride *rc_override;
2296 * rate control equation
2297 * - encoding: Set by user
2298 * - decoding: unused
2304 * - encoding: Set by user.
2305 * - decoding: Set by libavcodec.
2311 * - encoding: Set by user.
2312 * - decoding: unused
2316 float rc_buffer_aggressivity;
2319 * initial complexity for pass1 ratecontrol
2320 * - encoding: Set by user.
2321 * - decoding: unused
2323 float rc_initial_cplx;
2326 * Ratecontrol attempt to use, at maximum, <value> of what can be used without an underflow.
2327 * - encoding: Set by user.
2328 * - decoding: unused.
2330 float rc_max_available_vbv_use;
2333 * Ratecontrol attempt to use, at least, <value> times the amount needed to prevent a vbv overflow.
2334 * - encoding: Set by user.
2335 * - decoding: unused.
2337 float rc_min_vbv_overflow_use;
2340 * Number of bits which should be loaded into the rc buffer before decoding starts.
2341 * - encoding: Set by user.
2342 * - decoding: unused
2344 int rc_initial_buffer_occupancy;
2346 #define FF_CODER_TYPE_VLC 0
2347 #define FF_CODER_TYPE_AC 1
2348 #define FF_CODER_TYPE_RAW 2
2349 #define FF_CODER_TYPE_RLE 3
2350 #define FF_CODER_TYPE_DEFLATE 4
2353 * - encoding: Set by user.
2354 * - decoding: unused
2360 * - encoding: Set by user.
2361 * - decoding: unused
2366 * minimum Lagrange multiplier
2367 * - encoding: Set by user.
2368 * - decoding: unused
2373 * maximum Lagrange multiplier
2374 * - encoding: Set by user.
2375 * - decoding: unused
2380 * frame skip threshold
2381 * - encoding: Set by user.
2382 * - decoding: unused
2384 int frame_skip_threshold;
2388 * - encoding: Set by user.
2389 * - decoding: unused
2391 int frame_skip_factor;
2394 * frame skip exponent
2395 * - encoding: Set by user.
2396 * - decoding: unused
2401 * frame skip comparison function
2402 * - encoding: Set by user.
2403 * - decoding: unused
2408 * trellis RD quantization
2409 * - encoding: Set by user.
2410 * - decoding: unused
2415 * - encoding: Set by user.
2416 * - decoding: unused
2418 int min_prediction_order;
2421 * - encoding: Set by user.
2422 * - decoding: unused
2424 int max_prediction_order;
2427 * GOP timecode frame start number
2428 * - encoding: Set by user, in non drop frame format
2429 * - decoding: Set by libavcodec (timecode in the 25 bits format, -1 if unset)
2431 int64_t timecode_frame_start;
2433 /* The RTP callback: This function is called */
2434 /* every time the encoder has a packet to send. */
2435 /* It depends on the encoder if the data starts */
2436 /* with a Start Code (it should). H.263 does. */
2437 /* mb_nb contains the number of macroblocks */
2438 /* encoded in the RTP payload. */
2439 void (*rtp_callback)(struct AVCodecContext *avctx, void *data, int size, int mb_nb);
2441 int rtp_payload_size; /* The size of the RTP payload: the coder will */
2442 /* do its best to deliver a chunk with size */
2443 /* below rtp_payload_size, the chunk will start */
2444 /* with a start code on some codecs like H.263. */
2445 /* This doesn't take account of any particular */
2446 /* headers inside the transmitted RTP payload. */
2448 /* statistics, used for 2-pass encoding */
2459 * number of bits used for the previously encoded frame
2460 * - encoding: Set by libavcodec.
2461 * - decoding: unused
2466 * pass1 encoding statistics output buffer
2467 * - encoding: Set by libavcodec.
2468 * - decoding: unused
2473 * pass2 encoding statistics input buffer
2474 * Concatenated stuff from stats_out of pass1 should be placed here.
2475 * - encoding: Allocated/set/freed by user.
2476 * - decoding: unused
2481 * Work around bugs in encoders which sometimes cannot be detected automatically.
2482 * - encoding: Set by user
2483 * - decoding: Set by user
2485 int workaround_bugs;
2486 #define FF_BUG_AUTODETECT 1 ///< autodetection
2487 #if FF_API_OLD_MSMPEG4
2488 #define FF_BUG_OLD_MSMPEG4 2
2490 #define FF_BUG_XVID_ILACE 4
2491 #define FF_BUG_UMP4 8
2492 #define FF_BUG_NO_PADDING 16
2493 #define FF_BUG_AMV 32
2495 #define FF_BUG_AC_VLC 0 ///< Will be removed, libavcodec can now handle these non-compliant files by default.
2497 #define FF_BUG_QPEL_CHROMA 64
2498 #define FF_BUG_STD_QPEL 128
2499 #define FF_BUG_QPEL_CHROMA2 256
2500 #define FF_BUG_DIRECT_BLOCKSIZE 512
2501 #define FF_BUG_EDGE 1024
2502 #define FF_BUG_HPEL_CHROMA 2048
2503 #define FF_BUG_DC_CLIP 4096
2504 #define FF_BUG_MS 8192 ///< Work around various bugs in Microsoft's broken decoders.
2505 #define FF_BUG_TRUNCATED 16384
2508 * strictly follow the standard (MPEG4, ...).
2509 * - encoding: Set by user.
2510 * - decoding: Set by user.
2511 * Setting this to STRICT or higher means the encoder and decoder will
2512 * generally do stupid things, whereas setting it to unofficial or lower
2513 * will mean the encoder might produce output that is not supported by all
2514 * spec-compliant decoders. Decoders don't differentiate between normal,
2515 * unofficial and experimental (that is, they always try to decode things
2516 * when they can) unless they are explicitly asked to behave stupidly
2517 * (=strictly conform to the specs)
2519 int strict_std_compliance;
2520 #define FF_COMPLIANCE_VERY_STRICT 2 ///< Strictly conform to an older more strict version of the spec or reference software.
2521 #define FF_COMPLIANCE_STRICT 1 ///< Strictly conform to all the things in the spec no matter what consequences.
2522 #define FF_COMPLIANCE_NORMAL 0
2523 #define FF_COMPLIANCE_UNOFFICIAL -1 ///< Allow unofficial extensions
2524 #define FF_COMPLIANCE_EXPERIMENTAL -2 ///< Allow nonstandardized experimental things.
2527 * error concealment flags
2528 * - encoding: unused
2529 * - decoding: Set by user.
2531 int error_concealment;
2532 #define FF_EC_GUESS_MVS 1
2533 #define FF_EC_DEBLOCK 2
2534 #define FF_EC_FAVOR_INTER 256
2538 * - encoding: Set by user.
2539 * - decoding: Set by user.
2542 #define FF_DEBUG_PICT_INFO 1
2543 #define FF_DEBUG_RC 2
2544 #define FF_DEBUG_BITSTREAM 4
2545 #define FF_DEBUG_MB_TYPE 8
2546 #define FF_DEBUG_QP 16
2549 * @deprecated this option does nothing
2551 #define FF_DEBUG_MV 32
2553 #define FF_DEBUG_DCT_COEFF 0x00000040
2554 #define FF_DEBUG_SKIP 0x00000080
2555 #define FF_DEBUG_STARTCODE 0x00000100
2556 #define FF_DEBUG_PTS 0x00000200
2557 #define FF_DEBUG_ER 0x00000400
2558 #define FF_DEBUG_MMCO 0x00000800
2559 #define FF_DEBUG_BUGS 0x00001000
2561 #define FF_DEBUG_VIS_QP 0x00002000 ///< only access through AVOptions from outside libavcodec
2562 #define FF_DEBUG_VIS_MB_TYPE 0x00004000 ///< only access through AVOptions from outside libavcodec
2564 #define FF_DEBUG_BUFFERS 0x00008000
2565 #define FF_DEBUG_THREADS 0x00010000
2566 #define FF_DEBUG_NOMC 0x01000000
2571 * Code outside libavcodec should access this field using AVOptions
2572 * - encoding: Set by user.
2573 * - decoding: Set by user.
2576 #define FF_DEBUG_VIS_MV_P_FOR 0x00000001 //visualize forward predicted MVs of P frames
2577 #define FF_DEBUG_VIS_MV_B_FOR 0x00000002 //visualize forward predicted MVs of B frames
2578 #define FF_DEBUG_VIS_MV_B_BACK 0x00000004 //visualize backward predicted MVs of B frames
2582 * Error recognition; may misdetect some more or less valid parts as errors.
2583 * - encoding: unused
2584 * - decoding: Set by user.
2586 int err_recognition;
2589 * Verify checksums embedded in the bitstream (could be of either encoded or
2590 * decoded data, depending on the codec) and print an error message on mismatch.
2591 * If AV_EF_EXPLODE is also set, a mismatching checksum will result in the
2592 * decoder returning an error.
2594 #define AV_EF_CRCCHECK (1<<0)
2595 #define AV_EF_BITSTREAM (1<<1) ///< detect bitstream specification deviations
2596 #define AV_EF_BUFFER (1<<2) ///< detect improper bitstream length
2597 #define AV_EF_EXPLODE (1<<3) ///< abort decoding on minor error detection
2599 #define AV_EF_IGNORE_ERR (1<<15) ///< ignore errors and continue
2600 #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
2601 #define AV_EF_COMPLIANT (1<<17) ///< consider all spec non compliances as errors
2602 #define AV_EF_AGGRESSIVE (1<<18) ///< consider things that a sane encoder should not do as an error
2606 * opaque 64bit number (generally a PTS) that will be reordered and
2607 * output in AVFrame.reordered_opaque
2608 * @deprecated in favor of pkt_pts
2609 * - encoding: unused
2610 * - decoding: Set by user.
2612 int64_t reordered_opaque;
2615 * Hardware accelerator in use
2616 * - encoding: unused.
2617 * - decoding: Set by libavcodec
2619 struct AVHWAccel *hwaccel;
2622 * Hardware accelerator context.
2623 * For some hardware accelerators, a global context needs to be
2624 * provided by the user. In that case, this holds display-dependent
2625 * data FFmpeg cannot instantiate itself. Please refer to the
2626 * FFmpeg HW accelerator documentation to know how to fill this
2627 * is. e.g. for VA API, this is a struct vaapi_context.
2628 * - encoding: unused
2629 * - decoding: Set by user
2631 void *hwaccel_context;
2635 * - encoding: Set by libavcodec if flags&CODEC_FLAG_PSNR.
2636 * - decoding: unused
2638 uint64_t error[AV_NUM_DATA_POINTERS];
2641 * DCT algorithm, see FF_DCT_* below
2642 * - encoding: Set by user.
2643 * - decoding: unused
2646 #define FF_DCT_AUTO 0
2647 #define FF_DCT_FASTINT 1
2648 #define FF_DCT_INT 2
2649 #define FF_DCT_MMX 3
2650 #define FF_DCT_ALTIVEC 5
2651 #define FF_DCT_FAAN 6
2654 * IDCT algorithm, see FF_IDCT_* below.
2655 * - encoding: Set by user.
2656 * - decoding: Set by user.
2659 #define FF_IDCT_AUTO 0
2660 #define FF_IDCT_INT 1
2661 #define FF_IDCT_SIMPLE 2
2662 #define FF_IDCT_SIMPLEMMX 3
2663 #define FF_IDCT_ARM 7
2664 #define FF_IDCT_ALTIVEC 8
2666 #define FF_IDCT_SH4 9
2668 #define FF_IDCT_SIMPLEARM 10
2669 #define FF_IDCT_IPP 13
2670 #define FF_IDCT_XVIDMMX 14
2671 #define FF_IDCT_SIMPLEARMV5TE 16
2672 #define FF_IDCT_SIMPLEARMV6 17
2673 #if FF_API_ARCH_SPARC
2674 #define FF_IDCT_SIMPLEVIS 18
2676 #define FF_IDCT_FAAN 20
2677 #define FF_IDCT_SIMPLENEON 22
2678 #if FF_API_ARCH_ALPHA
2679 #define FF_IDCT_SIMPLEALPHA 23
2681 #define FF_IDCT_SIMPLEAUTO 128
2684 * bits per sample/pixel from the demuxer (needed for huffyuv).
2685 * - encoding: Set by libavcodec.
2686 * - decoding: Set by user.
2688 int bits_per_coded_sample;
2691 * Bits per sample/pixel of internal libavcodec pixel/sample format.
2692 * - encoding: set by user.
2693 * - decoding: set by libavcodec.
2695 int bits_per_raw_sample;
2699 * low resolution decoding, 1-> 1/2 size, 2->1/4 size
2700 * - encoding: unused
2701 * - decoding: Set by user.
2702 * Code outside libavcodec should access this field using:
2703 * av_codec_{get,set}_lowres(avctx)
2709 * the picture in the bitstream
2710 * - encoding: Set by libavcodec.
2711 * - decoding: unused
2713 AVFrame *coded_frame;
2717 * is used to decide how many independent tasks should be passed to execute()
2718 * - encoding: Set by user.
2719 * - decoding: Set by user.
2724 * Which multithreading methods to use.
2725 * Use of FF_THREAD_FRAME will increase decoding delay by one frame per thread,
2726 * so clients which cannot provide future frames should not use it.
2728 * - encoding: Set by user, otherwise the default is used.
2729 * - decoding: Set by user, otherwise the default is used.
2732 #define FF_THREAD_FRAME 1 ///< Decode more than one frame at once
2733 #define FF_THREAD_SLICE 2 ///< Decode more than one part of a single frame at once
2736 * Which multithreading methods are in use by the codec.
2737 * - encoding: Set by libavcodec.
2738 * - decoding: Set by libavcodec.
2740 int active_thread_type;
2743 * Set by the client if its custom get_buffer() callback can be called
2744 * synchronously from another thread, which allows faster multithreaded decoding.
2745 * draw_horiz_band() will be called from other threads regardless of this setting.
2746 * Ignored if the default get_buffer() is used.
2747 * - encoding: Set by user.
2748 * - decoding: Set by user.
2750 int thread_safe_callbacks;
2753 * The codec may call this to execute several independent things.
2754 * It will return only after finishing all tasks.
2755 * The user may replace this with some multithreaded implementation,
2756 * the default implementation will execute the parts serially.
2757 * @param count the number of things to execute
2758 * - encoding: Set by libavcodec, user can override.
2759 * - decoding: Set by libavcodec, user can override.
2761 int (*execute)(struct AVCodecContext *c, int (*func)(struct AVCodecContext *c2, void *arg), void *arg2, int *ret, int count, int size);
2764 * The codec may call this to execute several independent things.
2765 * It will return only after finishing all tasks.
2766 * The user may replace this with some multithreaded implementation,
2767 * the default implementation will execute the parts serially.
2768 * Also see avcodec_thread_init and e.g. the --enable-pthread configure option.
2769 * @param c context passed also to func
2770 * @param count the number of things to execute
2771 * @param arg2 argument passed unchanged to func
2772 * @param ret return values of executed functions, must have space for "count" values. May be NULL.
2773 * @param func function that will be called count times, with jobnr from 0 to count-1.
2774 * threadnr will be in the range 0 to c->thread_count-1 < MAX_THREADS and so that no
2775 * two instances of func executing at the same time will have the same threadnr.
2776 * @return always 0 currently, but code should handle a future improvement where when any call to func
2777 * returns < 0 no further calls to func may be done and < 0 is returned.
2778 * - encoding: Set by libavcodec, user can override.
2779 * - decoding: Set by libavcodec, user can override.
2781 int (*execute2)(struct AVCodecContext *c, int (*func)(struct AVCodecContext *c2, void *arg, int jobnr, int threadnr), void *arg2, int *ret, int count);
2783 #if FF_API_THREAD_OPAQUE
2785 * @deprecated this field should not be used from outside of lavc
2787 attribute_deprecated
2788 void *thread_opaque;
2792 * noise vs. sse weight for the nsse comparison function
2793 * - encoding: Set by user.
2794 * - decoding: unused
2800 * - encoding: Set by user.
2801 * - decoding: Set by libavcodec.
2804 #define FF_PROFILE_UNKNOWN -99
2805 #define FF_PROFILE_RESERVED -100
2807 #define FF_PROFILE_AAC_MAIN 0
2808 #define FF_PROFILE_AAC_LOW 1
2809 #define FF_PROFILE_AAC_SSR 2
2810 #define FF_PROFILE_AAC_LTP 3
2811 #define FF_PROFILE_AAC_HE 4
2812 #define FF_PROFILE_AAC_HE_V2 28
2813 #define FF_PROFILE_AAC_LD 22
2814 #define FF_PROFILE_AAC_ELD 38
2815 #define FF_PROFILE_MPEG2_AAC_LOW 128
2816 #define FF_PROFILE_MPEG2_AAC_HE 131
2818 #define FF_PROFILE_DTS 20
2819 #define FF_PROFILE_DTS_ES 30
2820 #define FF_PROFILE_DTS_96_24 40
2821 #define FF_PROFILE_DTS_HD_HRA 50
2822 #define FF_PROFILE_DTS_HD_MA 60
2824 #define FF_PROFILE_MPEG2_422 0
2825 #define FF_PROFILE_MPEG2_HIGH 1
2826 #define FF_PROFILE_MPEG2_SS 2
2827 #define FF_PROFILE_MPEG2_SNR_SCALABLE 3
2828 #define FF_PROFILE_MPEG2_MAIN 4
2829 #define FF_PROFILE_MPEG2_SIMPLE 5
2831 #define FF_PROFILE_H264_CONSTRAINED (1<<9) // 8+1; constraint_set1_flag
2832 #define FF_PROFILE_H264_INTRA (1<<11) // 8+3; constraint_set3_flag
2834 #define FF_PROFILE_H264_BASELINE 66
2835 #define FF_PROFILE_H264_CONSTRAINED_BASELINE (66|FF_PROFILE_H264_CONSTRAINED)
2836 #define FF_PROFILE_H264_MAIN 77
2837 #define FF_PROFILE_H264_EXTENDED 88
2838 #define FF_PROFILE_H264_HIGH 100
2839 #define FF_PROFILE_H264_HIGH_10 110
2840 #define FF_PROFILE_H264_HIGH_10_INTRA (110|FF_PROFILE_H264_INTRA)
2841 #define FF_PROFILE_H264_HIGH_422 122
2842 #define FF_PROFILE_H264_HIGH_422_INTRA (122|FF_PROFILE_H264_INTRA)
2843 #define FF_PROFILE_H264_HIGH_444 144
2844 #define FF_PROFILE_H264_HIGH_444_PREDICTIVE 244
2845 #define FF_PROFILE_H264_HIGH_444_INTRA (244|FF_PROFILE_H264_INTRA)
2846 #define FF_PROFILE_H264_CAVLC_444 44
2848 #define FF_PROFILE_VC1_SIMPLE 0
2849 #define FF_PROFILE_VC1_MAIN 1
2850 #define FF_PROFILE_VC1_COMPLEX 2
2851 #define FF_PROFILE_VC1_ADVANCED 3
2853 #define FF_PROFILE_MPEG4_SIMPLE 0
2854 #define FF_PROFILE_MPEG4_SIMPLE_SCALABLE 1
2855 #define FF_PROFILE_MPEG4_CORE 2
2856 #define FF_PROFILE_MPEG4_MAIN 3
2857 #define FF_PROFILE_MPEG4_N_BIT 4
2858 #define FF_PROFILE_MPEG4_SCALABLE_TEXTURE 5
2859 #define FF_PROFILE_MPEG4_SIMPLE_FACE_ANIMATION 6
2860 #define FF_PROFILE_MPEG4_BASIC_ANIMATED_TEXTURE 7
2861 #define FF_PROFILE_MPEG4_HYBRID 8
2862 #define FF_PROFILE_MPEG4_ADVANCED_REAL_TIME 9
2863 #define FF_PROFILE_MPEG4_CORE_SCALABLE 10
2864 #define FF_PROFILE_MPEG4_ADVANCED_CODING 11
2865 #define FF_PROFILE_MPEG4_ADVANCED_CORE 12
2866 #define FF_PROFILE_MPEG4_ADVANCED_SCALABLE_TEXTURE 13
2867 #define FF_PROFILE_MPEG4_SIMPLE_STUDIO 14
2868 #define FF_PROFILE_MPEG4_ADVANCED_SIMPLE 15
2870 #define FF_PROFILE_JPEG2000_CSTREAM_RESTRICTION_0 0
2871 #define FF_PROFILE_JPEG2000_CSTREAM_RESTRICTION_1 1
2872 #define FF_PROFILE_JPEG2000_CSTREAM_NO_RESTRICTION 2
2873 #define FF_PROFILE_JPEG2000_DCINEMA_2K 3
2874 #define FF_PROFILE_JPEG2000_DCINEMA_4K 4
2877 #define FF_PROFILE_HEVC_MAIN 1
2878 #define FF_PROFILE_HEVC_MAIN_10 2
2879 #define FF_PROFILE_HEVC_MAIN_STILL_PICTURE 3
2880 #define FF_PROFILE_HEVC_REXT 4
2884 * - encoding: Set by user.
2885 * - decoding: Set by libavcodec.
2888 #define FF_LEVEL_UNKNOWN -99
2891 * Skip loop filtering for selected frames.
2892 * - encoding: unused
2893 * - decoding: Set by user.
2895 enum AVDiscard skip_loop_filter;
2898 * Skip IDCT/dequantization for selected frames.
2899 * - encoding: unused
2900 * - decoding: Set by user.
2902 enum AVDiscard skip_idct;
2905 * Skip decoding for selected frames.
2906 * - encoding: unused
2907 * - decoding: Set by user.
2909 enum AVDiscard skip_frame;
2912 * Header containing style information for text subtitles.
2913 * For SUBTITLE_ASS subtitle type, it should contain the whole ASS
2914 * [Script Info] and [V4+ Styles] section, plus the [Events] line and
2915 * the Format line following. It shouldn't include any Dialogue line.
2916 * - encoding: Set/allocated/freed by user (before avcodec_open2())
2917 * - decoding: Set/allocated/freed by libavcodec (by avcodec_open2())
2919 uint8_t *subtitle_header;
2920 int subtitle_header_size;
2922 #if FF_API_ERROR_RATE
2924 * @deprecated use the 'error_rate' private AVOption of the mpegvideo
2927 attribute_deprecated
2931 #if FF_API_CODEC_PKT
2933 * @deprecated this field is not supposed to be accessed from outside lavc
2935 attribute_deprecated
2940 * VBV delay coded in the last frame (in periods of a 27 MHz clock).
2941 * Used for compliant TS muxing.
2942 * - encoding: Set by libavcodec.
2943 * - decoding: unused.
2948 * Encoding only. Allow encoders to output packets that do not contain any
2949 * encoded data, only side data.
2951 * Some encoders need to output such packets, e.g. to update some stream
2952 * parameters at the end of encoding.
2954 * All callers are strongly recommended to set this option to 1 and update
2955 * their code to deal with such packets, since this behaviour may become
2956 * always enabled in the future (then this option will be deprecated and
2957 * later removed). To avoid ABI issues when this happens, the callers should
2958 * use AVOptions to set this field.
2960 int side_data_only_packets;
2963 * Timebase in which pkt_dts/pts and AVPacket.dts/pts are.
2964 * Code outside libavcodec should access this field using:
2965 * av_codec_{get,set}_pkt_timebase(avctx)
2966 * - encoding unused.
2967 * - decoding set by user.
2969 AVRational pkt_timebase;
2973 * Code outside libavcodec should access this field using:
2974 * av_codec_{get,set}_codec_descriptor(avctx)
2975 * - encoding: unused.
2976 * - decoding: set by libavcodec.
2978 const AVCodecDescriptor *codec_descriptor;
2982 * low resolution decoding, 1-> 1/2 size, 2->1/4 size
2983 * - encoding: unused
2984 * - decoding: Set by user.
2985 * Code outside libavcodec should access this field using:
2986 * av_codec_{get,set}_lowres(avctx)
2992 * Current statistics for PTS correction.
2993 * - decoding: maintained and used by libavcodec, not intended to be used by user apps
2994 * - encoding: unused
2996 int64_t pts_correction_num_faulty_pts; /// Number of incorrect PTS values so far
2997 int64_t pts_correction_num_faulty_dts; /// Number of incorrect DTS values so far
2998 int64_t pts_correction_last_pts; /// PTS of the last frame
2999 int64_t pts_correction_last_dts; /// DTS of the last frame
3002 * Character encoding of the input subtitles file.
3003 * - decoding: set by user
3004 * - encoding: unused
3009 * Subtitles character encoding mode. Formats or codecs might be adjusting
3010 * this setting (if they are doing the conversion themselves for instance).
3011 * - decoding: set by libavcodec
3012 * - encoding: unused
3014 int sub_charenc_mode;
3015 #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)
3016 #define FF_SUB_CHARENC_MODE_AUTOMATIC 0 ///< libavcodec will select the mode itself
3017 #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
3020 * Skip processing alpha if supported by codec.
3021 * Note that if the format uses pre-multiplied alpha (common with VP6,
3022 * and recommended due to better video quality/compression)
3023 * the image will look as if alpha-blended onto a black background.
3024 * However for formats that do not use pre-multiplied alpha
3025 * there might be serious artefacts (though e.g. libswscale currently
3026 * assumes pre-multiplied alpha anyway).
3027 * Code outside libavcodec should access this field using AVOptions
3029 * - decoding: set by user
3030 * - encoding: unused
3035 * Number of samples to skip after a discontinuity
3036 * - decoding: unused
3037 * - encoding: set by libavcodec
3041 #if !FF_API_DEBUG_MV
3043 * debug motion vectors
3044 * Code outside libavcodec should access this field using AVOptions
3045 * - encoding: Set by user.
3046 * - decoding: Set by user.
3049 #define FF_DEBUG_VIS_MV_P_FOR 0x00000001 //visualize forward predicted MVs of P frames
3050 #define FF_DEBUG_VIS_MV_B_FOR 0x00000002 //visualize forward predicted MVs of B frames
3051 #define FF_DEBUG_VIS_MV_B_BACK 0x00000004 //visualize backward predicted MVs of B frames
3055 * custom intra quantization matrix
3056 * Code outside libavcodec should access this field using av_codec_g/set_chroma_intra_matrix()
3057 * - encoding: Set by user, can be NULL.
3058 * - decoding: unused.
3060 uint16_t *chroma_intra_matrix;
3063 AVRational av_codec_get_pkt_timebase (const AVCodecContext *avctx);
3064 void av_codec_set_pkt_timebase (AVCodecContext *avctx, AVRational val);
3066 const AVCodecDescriptor *av_codec_get_codec_descriptor(const AVCodecContext *avctx);
3067 void av_codec_set_codec_descriptor(AVCodecContext *avctx, const AVCodecDescriptor *desc);
3069 int av_codec_get_lowres(const AVCodecContext *avctx);
3070 void av_codec_set_lowres(AVCodecContext *avctx, int val);
3072 int av_codec_get_seek_preroll(const AVCodecContext *avctx);
3073 void av_codec_set_seek_preroll(AVCodecContext *avctx, int val);
3075 uint16_t *av_codec_get_chroma_intra_matrix(const AVCodecContext *avctx);
3076 void av_codec_set_chroma_intra_matrix(AVCodecContext *avctx, uint16_t *val);
3081 typedef struct AVProfile {
3083 const char *name; ///< short name for the profile
3086 typedef struct AVCodecDefault AVCodecDefault;
3093 typedef struct AVCodec {
3095 * Name of the codec implementation.
3096 * The name is globally unique among encoders and among decoders (but an
3097 * encoder and a decoder can share the same name).
3098 * This is the primary way to find a codec from the user perspective.
3102 * Descriptive name for the codec, meant to be more human readable than name.
3103 * You should use the NULL_IF_CONFIG_SMALL() macro to define it.
3105 const char *long_name;
3106 enum AVMediaType type;
3109 * Codec capabilities.
3113 const AVRational *supported_framerates; ///< array of supported framerates, or NULL if any, array is terminated by {0,0}
3114 const enum AVPixelFormat *pix_fmts; ///< array of supported pixel formats, or NULL if unknown, array is terminated by -1
3115 const int *supported_samplerates; ///< array of supported audio samplerates, or NULL if unknown, array is terminated by 0
3116 const enum AVSampleFormat *sample_fmts; ///< array of supported sample formats, or NULL if unknown, array is terminated by -1
3117 const uint64_t *channel_layouts; ///< array of support channel layouts, or NULL if unknown. array is terminated by 0
3119 uint8_t max_lowres; ///< maximum value for lowres supported by the decoder, no direct access, use av_codec_get_max_lowres()
3121 const AVClass *priv_class; ///< AVClass for the private context
3122 const AVProfile *profiles; ///< array of recognized profiles, or NULL if unknown, array is terminated by {FF_PROFILE_UNKNOWN}
3124 /*****************************************************************
3125 * No fields below this line are part of the public API. They
3126 * may not be used outside of libavcodec and can be changed and
3128 * New public fields should be added right above.
3129 *****************************************************************
3132 struct AVCodec *next;
3134 * @name Frame-level threading support functions
3138 * If defined, called on thread contexts when they are created.
3139 * If the codec allocates writable tables in init(), re-allocate them here.
3140 * priv_data will be set to a copy of the original.
3142 int (*init_thread_copy)(AVCodecContext *);
3144 * Copy necessary context variables from a previous thread context to the current one.
3145 * If not defined, the next thread will start automatically; otherwise, the codec
3146 * must call ff_thread_finish_setup().
3148 * dst and src will (rarely) point to the same context, in which case memcpy should be skipped.
3150 int (*update_thread_context)(AVCodecContext *dst, const AVCodecContext *src);
3154 * Private codec-specific defaults.
3156 const AVCodecDefault *defaults;
3159 * Initialize codec static data, called from avcodec_register().
3161 void (*init_static_data)(struct AVCodec *codec);
3163 int (*init)(AVCodecContext *);
3164 int (*encode_sub)(AVCodecContext *, uint8_t *buf, int buf_size,
3165 const struct AVSubtitle *sub);
3167 * Encode data to an AVPacket.
3169 * @param avctx codec context
3170 * @param avpkt output AVPacket (may contain a user-provided buffer)
3171 * @param[in] frame AVFrame containing the raw data to be encoded
3172 * @param[out] got_packet_ptr encoder sets to 0 or 1 to indicate that a
3173 * non-empty packet was returned in avpkt.
3174 * @return 0 on success, negative error code on failure
3176 int (*encode2)(AVCodecContext *avctx, AVPacket *avpkt, const AVFrame *frame,
3177 int *got_packet_ptr);
3178 int (*decode)(AVCodecContext *, void *outdata, int *outdata_size, AVPacket *avpkt);
3179 int (*close)(AVCodecContext *);
3182 * Will be called when seeking
3184 void (*flush)(AVCodecContext *);
3187 int av_codec_get_max_lowres(const AVCodec *codec);
3189 struct MpegEncContext;
3194 typedef struct AVHWAccel {
3196 * Name of the hardware accelerated codec.
3197 * The name is globally unique among encoders and among decoders (but an
3198 * encoder and a decoder can share the same name).
3203 * Type of codec implemented by the hardware accelerator.
3205 * See AVMEDIA_TYPE_xxx
3207 enum AVMediaType type;
3210 * Codec implemented by the hardware accelerator.
3212 * See AV_CODEC_ID_xxx
3217 * Supported pixel format.
3219 * Only hardware accelerated formats are supported here.
3221 enum AVPixelFormat pix_fmt;
3224 * Hardware accelerated codec capabilities.
3225 * see FF_HWACCEL_CODEC_CAP_*
3229 /*****************************************************************
3230 * No fields below this line are part of the public API. They
3231 * may not be used outside of libavcodec and can be changed and
3233 * New public fields should be added right above.
3234 *****************************************************************
3236 struct AVHWAccel *next;
3239 * Allocate a custom buffer
3241 int (*alloc_frame)(AVCodecContext *avctx, AVFrame *frame);
3244 * Called at the beginning of each frame or field picture.
3246 * Meaningful frame information (codec specific) is guaranteed to
3247 * be parsed at this point. This function is mandatory.
3249 * Note that buf can be NULL along with buf_size set to 0.
3250 * Otherwise, this means the whole frame is available at this point.
3252 * @param avctx the codec context
3253 * @param buf the frame data buffer base
3254 * @param buf_size the size of the frame in bytes
3255 * @return zero if successful, a negative value otherwise
3257 int (*start_frame)(AVCodecContext *avctx, const uint8_t *buf, uint32_t buf_size);
3260 * Callback for each slice.
3262 * Meaningful slice information (codec specific) is guaranteed to
3263 * be parsed at this point. This function is mandatory.
3264 * The only exception is XvMC, that works on MB level.
3266 * @param avctx the codec context
3267 * @param buf the slice data buffer base
3268 * @param buf_size the size of the slice in bytes
3269 * @return zero if successful, a negative value otherwise
3271 int (*decode_slice)(AVCodecContext *avctx, const uint8_t *buf, uint32_t buf_size);
3274 * Called at the end of each frame or field picture.
3276 * The whole picture is parsed at this point and can now be sent
3277 * to the hardware accelerator. This function is mandatory.
3279 * @param avctx the codec context
3280 * @return zero if successful, a negative value otherwise
3282 int (*end_frame)(AVCodecContext *avctx);
3285 * Size of per-frame hardware accelerator private data.
3287 * Private data is allocated with av_mallocz() before
3288 * AVCodecContext.get_buffer() and deallocated after
3289 * AVCodecContext.release_buffer().
3291 int frame_priv_data_size;
3294 * Called for every Macroblock in a slice.
3296 * XvMC uses it to replace the ff_MPV_decode_mb().
3297 * Instead of decoding to raw picture, MB parameters are
3298 * stored in an array provided by the video driver.
3300 * @param s the mpeg context
3302 void (*decode_mb)(struct MpegEncContext *s);
3305 * Initialize the hwaccel private data.
3307 * This will be called from ff_get_format(), after hwaccel and
3308 * hwaccel_context are set and the hwaccel private data in AVCodecInternal
3311 int (*init)(AVCodecContext *avctx);
3314 * Uninitialize the hwaccel private data.
3316 * This will be called from get_format() or avcodec_close(), after hwaccel
3317 * and hwaccel_context are already uninitialized.
3319 int (*uninit)(AVCodecContext *avctx);
3322 * Size of the private data to allocate in
3323 * AVCodecInternal.hwaccel_priv_data.
3329 * @defgroup lavc_picture AVPicture
3331 * Functions for working with AVPicture
3336 * Picture data structure.
3338 * Up to four components can be stored into it, the last component is
3341 typedef struct AVPicture {
3342 uint8_t *data[AV_NUM_DATA_POINTERS]; ///< pointers to the image data planes
3343 int linesize[AV_NUM_DATA_POINTERS]; ///< number of bytes per line
3350 enum AVSubtitleType {
3353 SUBTITLE_BITMAP, ///< A bitmap, pict will be set
3356 * Plain text, the text field must be set by the decoder and is
3357 * authoritative. ass and pict fields may contain approximations.
3362 * Formatted text, the ass field must be set by the decoder and is
3363 * authoritative. pict and text fields may contain approximations.
3368 #define AV_SUBTITLE_FLAG_FORCED 0x00000001
3370 typedef struct AVSubtitleRect {
3371 int x; ///< top left corner of pict, undefined when pict is not set
3372 int y; ///< top left corner of pict, undefined when pict is not set
3373 int w; ///< width of pict, undefined when pict is not set
3374 int h; ///< height of pict, undefined when pict is not set
3375 int nb_colors; ///< number of colors in pict, undefined when pict is not set
3378 * data+linesize for the bitmap of this subtitle.
3379 * can be set for text/ass as well once they where rendered
3382 enum AVSubtitleType type;
3384 char *text; ///< 0 terminated plain UTF-8 text
3387 * 0 terminated ASS/SSA compatible event line.
3388 * The presentation of this is unaffected by the other values in this
3396 typedef struct AVSubtitle {
3397 uint16_t format; /* 0 = graphics */
3398 uint32_t start_display_time; /* relative to packet pts, in ms */
3399 uint32_t end_display_time; /* relative to packet pts, in ms */
3401 AVSubtitleRect **rects;
3402 int64_t pts; ///< Same as packet pts, in AV_TIME_BASE
3406 * If c is NULL, returns the first registered codec,
3407 * if c is non-NULL, returns the next registered codec after c,
3408 * or NULL if c is the last one.
3410 AVCodec *av_codec_next(const AVCodec *c);
3413 * Return the LIBAVCODEC_VERSION_INT constant.
3415 unsigned avcodec_version(void);
3418 * Return the libavcodec build-time configuration.
3420 const char *avcodec_configuration(void);
3423 * Return the libavcodec license.
3425 const char *avcodec_license(void);
3428 * Register the codec codec and initialize libavcodec.
3430 * @warning either this function or avcodec_register_all() must be called
3431 * before any other libavcodec functions.
3433 * @see avcodec_register_all()
3435 void avcodec_register(AVCodec *codec);
3438 * Register all the codecs, parsers and bitstream filters which were enabled at
3439 * configuration time. If you do not call this function you can select exactly
3440 * which formats you want to support, by using the individual registration
3443 * @see avcodec_register
3444 * @see av_register_codec_parser
3445 * @see av_register_bitstream_filter
3447 void avcodec_register_all(void);
3450 * Allocate an AVCodecContext and set its fields to default values. The
3451 * resulting struct should be freed with avcodec_free_context().
3453 * @param codec if non-NULL, allocate private data and initialize defaults
3454 * for the given codec. It is illegal to then call avcodec_open2()
3455 * with a different codec.
3456 * If NULL, then the codec-specific defaults won't be initialized,
3457 * which may result in suboptimal default settings (this is
3458 * important mainly for encoders, e.g. libx264).
3460 * @return An AVCodecContext filled with default values or NULL on failure.
3461 * @see avcodec_get_context_defaults
3463 AVCodecContext *avcodec_alloc_context3(const AVCodec *codec);
3466 * Free the codec context and everything associated with it and write NULL to
3467 * the provided pointer.
3469 void avcodec_free_context(AVCodecContext **avctx);
3472 * Set the fields of the given AVCodecContext to default values corresponding
3473 * to the given codec (defaults may be codec-dependent).
3475 * Do not call this function if a non-NULL codec has been passed
3476 * to avcodec_alloc_context3() that allocated this AVCodecContext.
3477 * If codec is non-NULL, it is illegal to call avcodec_open2() with a
3478 * different codec on this AVCodecContext.
3480 int avcodec_get_context_defaults3(AVCodecContext *s, const AVCodec *codec);
3483 * Get the AVClass for AVCodecContext. It can be used in combination with
3484 * AV_OPT_SEARCH_FAKE_OBJ for examining options.
3486 * @see av_opt_find().
3488 const AVClass *avcodec_get_class(void);
3491 * Get the AVClass for AVFrame. It can be used in combination with
3492 * AV_OPT_SEARCH_FAKE_OBJ for examining options.
3494 * @see av_opt_find().
3496 const AVClass *avcodec_get_frame_class(void);
3499 * Get the AVClass for AVSubtitleRect. It can be used in combination with
3500 * AV_OPT_SEARCH_FAKE_OBJ for examining options.
3502 * @see av_opt_find().
3504 const AVClass *avcodec_get_subtitle_rect_class(void);
3507 * Copy the settings of the source AVCodecContext into the destination
3508 * AVCodecContext. The resulting destination codec context will be
3509 * unopened, i.e. you are required to call avcodec_open2() before you
3510 * can use this AVCodecContext to decode/encode video/audio data.
3512 * @param dest target codec context, should be initialized with
3513 * avcodec_alloc_context3(NULL), but otherwise uninitialized
3514 * @param src source codec context
3515 * @return AVERROR() on error (e.g. memory allocation error), 0 on success
3517 int avcodec_copy_context(AVCodecContext *dest, const AVCodecContext *src);
3519 #if FF_API_AVFRAME_LAVC
3521 * @deprecated use av_frame_alloc()
3523 attribute_deprecated
3524 AVFrame *avcodec_alloc_frame(void);
3527 * Set the fields of the given AVFrame to default values.
3529 * @param frame The AVFrame of which the fields should be set to default values.
3531 * @deprecated use av_frame_unref()
3533 attribute_deprecated
3534 void avcodec_get_frame_defaults(AVFrame *frame);
3537 * Free the frame and any dynamically allocated objects in it,
3538 * e.g. extended_data.
3540 * @param frame frame to be freed. The pointer will be set to NULL.
3542 * @warning this function does NOT free the data buffers themselves
3543 * (it does not know how, since they might have been allocated with
3544 * a custom get_buffer()).
3546 * @deprecated use av_frame_free()
3548 attribute_deprecated
3549 void avcodec_free_frame(AVFrame **frame);
3553 * Initialize the AVCodecContext to use the given AVCodec. Prior to using this
3554 * function the context has to be allocated with avcodec_alloc_context3().
3556 * The functions avcodec_find_decoder_by_name(), avcodec_find_encoder_by_name(),
3557 * avcodec_find_decoder() and avcodec_find_encoder() provide an easy way for
3558 * retrieving a codec.
3560 * @warning This function is not thread safe!
3563 * avcodec_register_all();
3564 * av_dict_set(&opts, "b", "2.5M", 0);
3565 * codec = avcodec_find_decoder(AV_CODEC_ID_H264);
3569 * context = avcodec_alloc_context3(codec);
3571 * if (avcodec_open2(context, codec, opts) < 0)
3575 * @param avctx The context to initialize.
3576 * @param codec The codec to open this context for. If a non-NULL codec has been
3577 * previously passed to avcodec_alloc_context3() or
3578 * avcodec_get_context_defaults3() for this context, then this
3579 * parameter MUST be either NULL or equal to the previously passed
3581 * @param options A dictionary filled with AVCodecContext and codec-private options.
3582 * On return this object will be filled with options that were not found.
3584 * @return zero on success, a negative value on error
3585 * @see avcodec_alloc_context3(), avcodec_find_decoder(), avcodec_find_encoder(),
3586 * av_dict_set(), av_opt_find().
3588 int avcodec_open2(AVCodecContext *avctx, const AVCodec *codec, AVDictionary **options);
3591 * Close a given AVCodecContext and free all the data associated with it
3592 * (but not the AVCodecContext itself).
3594 * Calling this function on an AVCodecContext that hasn't been opened will free
3595 * the codec-specific data allocated in avcodec_alloc_context3() /
3596 * avcodec_get_context_defaults3() with a non-NULL codec. Subsequent calls will
3599 int avcodec_close(AVCodecContext *avctx);
3602 * Free all allocated data in the given subtitle struct.
3604 * @param sub AVSubtitle to free.
3606 void avsubtitle_free(AVSubtitle *sub);
3613 * @addtogroup lavc_packet
3617 #if FF_API_DESTRUCT_PACKET
3619 * Default packet destructor.
3620 * @deprecated use the AVBuffer API instead
3622 attribute_deprecated
3623 void av_destruct_packet(AVPacket *pkt);
3627 * Initialize optional fields of a packet with default values.
3629 * Note, this does not touch the data and size members, which have to be
3630 * initialized separately.
3634 void av_init_packet(AVPacket *pkt);
3637 * Allocate the payload of a packet and initialize its fields with
3641 * @param size wanted payload size
3642 * @return 0 if OK, AVERROR_xxx otherwise
3644 int av_new_packet(AVPacket *pkt, int size);
3647 * Reduce packet size, correctly zeroing padding
3650 * @param size new size
3652 void av_shrink_packet(AVPacket *pkt, int size);
3655 * Increase packet size, correctly zeroing padding
3658 * @param grow_by number of bytes by which to increase the size of the packet
3660 int av_grow_packet(AVPacket *pkt, int grow_by);
3663 * Initialize a reference-counted packet from av_malloc()ed data.
3665 * @param pkt packet to be initialized. This function will set the data, size,
3666 * buf and destruct fields, all others are left untouched.
3667 * @param data Data allocated by av_malloc() to be used as packet data. If this
3668 * function returns successfully, the data is owned by the underlying AVBuffer.
3669 * The caller may not access the data through other means.
3670 * @param size size of data in bytes, without the padding. I.e. the full buffer
3671 * size is assumed to be size + FF_INPUT_BUFFER_PADDING_SIZE.
3673 * @return 0 on success, a negative AVERROR on error
3675 int av_packet_from_data(AVPacket *pkt, uint8_t *data, int size);
3678 * @warning This is a hack - the packet memory allocation stuff is broken. The
3679 * packet is allocated if it was not really allocated.
3681 int av_dup_packet(AVPacket *pkt);
3684 * Copy packet, including contents
3686 * @return 0 on success, negative AVERROR on fail
3688 int av_copy_packet(AVPacket *dst, const AVPacket *src);
3691 * Copy packet side data
3693 * @return 0 on success, negative AVERROR on fail
3695 int av_copy_packet_side_data(AVPacket *dst, const AVPacket *src);
3700 * @param pkt packet to free
3702 void av_free_packet(AVPacket *pkt);
3705 * Allocate new information of a packet.
3708 * @param type side information type
3709 * @param size side information size
3710 * @return pointer to fresh allocated data or NULL otherwise
3712 uint8_t* av_packet_new_side_data(AVPacket *pkt, enum AVPacketSideDataType type,
3716 * Shrink the already allocated side data buffer
3719 * @param type side information type
3720 * @param size new side information size
3721 * @return 0 on success, < 0 on failure
3723 int av_packet_shrink_side_data(AVPacket *pkt, enum AVPacketSideDataType type,
3727 * Get side information from packet.
3730 * @param type desired side information type
3731 * @param size pointer for side information size to store (optional)
3732 * @return pointer to data if present or NULL otherwise
3734 uint8_t* av_packet_get_side_data(AVPacket *pkt, enum AVPacketSideDataType type,
3737 int av_packet_merge_side_data(AVPacket *pkt);
3739 int av_packet_split_side_data(AVPacket *pkt);
3742 * Pack a dictionary for use in side_data.
3744 * @param dict The dictionary to pack.
3745 * @param size pointer to store the size of the returned data
3746 * @return pointer to data if successful, NULL otherwise
3748 uint8_t *av_packet_pack_dictionary(AVDictionary *dict, int *size);
3750 * Unpack a dictionary from side_data.
3752 * @param data data from side_data
3753 * @param size size of the data
3754 * @param dict the metadata storage dictionary
3755 * @return 0 on success, < 0 on failure
3757 int av_packet_unpack_dictionary(const uint8_t *data, int size, AVDictionary **dict);
3761 * Convenience function to free all the side data stored.
3762 * All the other fields stay untouched.
3766 void av_packet_free_side_data(AVPacket *pkt);
3769 * Setup a new reference to the data described by a given packet
3771 * If src is reference-counted, setup dst as a new reference to the
3772 * buffer in src. Otherwise allocate a new buffer in dst and copy the
3773 * data from src into it.
3775 * All the other fields are copied from src.
3777 * @see av_packet_unref
3779 * @param dst Destination packet
3780 * @param src Source packet
3782 * @return 0 on success, a negative AVERROR on error.
3784 int av_packet_ref(AVPacket *dst, const AVPacket *src);
3789 * Unreference the buffer referenced by the packet and reset the
3790 * remaining packet fields to their default values.
3792 * @param pkt The packet to be unreferenced.
3794 void av_packet_unref(AVPacket *pkt);
3797 * Move every field in src to dst and reset src.
3799 * @see av_packet_unref
3801 * @param src Source packet, will be reset
3802 * @param dst Destination packet
3804 void av_packet_move_ref(AVPacket *dst, AVPacket *src);
3807 * Copy only "properties" fields from src to dst.
3809 * Properties for the purpose of this function are all the fields
3810 * beside those related to the packet data (buf, data, size)
3812 * @param dst Destination packet
3813 * @param src Source packet
3815 * @return 0 on success AVERROR on failure.
3818 int av_packet_copy_props(AVPacket *dst, const AVPacket *src);
3821 * Convert valid timing fields (timestamps / durations) in a packet from one
3822 * timebase to another. Timestamps with unknown values (AV_NOPTS_VALUE) will be
3825 * @param pkt packet on which the conversion will be performed
3826 * @param tb_src source timebase, in which the timing fields in pkt are
3828 * @param tb_dst destination timebase, to which the timing fields will be
3831 void av_packet_rescale_ts(AVPacket *pkt, AVRational tb_src, AVRational tb_dst);
3838 * @addtogroup lavc_decoding
3843 * Find a registered decoder with a matching codec ID.
3845 * @param id AVCodecID of the requested decoder
3846 * @return A decoder if one was found, NULL otherwise.
3848 AVCodec *avcodec_find_decoder(enum AVCodecID id);
3851 * Find a registered decoder with the specified name.
3853 * @param name name of the requested decoder
3854 * @return A decoder if one was found, NULL otherwise.
3856 AVCodec *avcodec_find_decoder_by_name(const char *name);
3858 #if FF_API_GET_BUFFER
3859 attribute_deprecated int avcodec_default_get_buffer(AVCodecContext *s, AVFrame *pic);
3860 attribute_deprecated void avcodec_default_release_buffer(AVCodecContext *s, AVFrame *pic);
3861 attribute_deprecated int avcodec_default_reget_buffer(AVCodecContext *s, AVFrame *pic);
3865 * The default callback for AVCodecContext.get_buffer2(). It is made public so
3866 * it can be called by custom get_buffer2() implementations for decoders without
3867 * CODEC_CAP_DR1 set.
3869 int avcodec_default_get_buffer2(AVCodecContext *s, AVFrame *frame, int flags);
3873 * Return the amount of padding in pixels which the get_buffer callback must
3874 * provide around the edge of the image for codecs which do not have the
3875 * CODEC_FLAG_EMU_EDGE flag.
3877 * @return Required padding in pixels.
3879 * @deprecated CODEC_FLAG_EMU_EDGE is deprecated, so this function is no longer
3882 attribute_deprecated
3883 unsigned avcodec_get_edge_width(void);
3887 * Modify width and height values so that they will result in a memory
3888 * buffer that is acceptable for the codec if you do not use any horizontal
3891 * May only be used if a codec with CODEC_CAP_DR1 has been opened.
3893 void avcodec_align_dimensions(AVCodecContext *s, int *width, int *height);
3896 * Modify width and height values so that they will result in a memory
3897 * buffer that is acceptable for the codec if you also ensure that all
3898 * line sizes are a multiple of the respective linesize_align[i].
3900 * May only be used if a codec with CODEC_CAP_DR1 has been opened.
3902 void avcodec_align_dimensions2(AVCodecContext *s, int *width, int *height,
3903 int linesize_align[AV_NUM_DATA_POINTERS]);
3906 * Converts AVChromaLocation to swscale x/y chroma position.
3908 * The positions represent the chroma (0,0) position in a coordinates system
3909 * with luma (0,0) representing the origin and luma(1,1) representing 256,256
3911 * @param xpos horizontal chroma sample position
3912 * @param ypos vertical chroma sample position
3914 int avcodec_enum_to_chroma_pos(int *xpos, int *ypos, enum AVChromaLocation pos);
3917 * Converts swscale x/y chroma position to AVChromaLocation.
3919 * The positions represent the chroma (0,0) position in a coordinates system
3920 * with luma (0,0) representing the origin and luma(1,1) representing 256,256
3922 * @param xpos horizontal chroma sample position
3923 * @param ypos vertical chroma sample position
3925 enum AVChromaLocation avcodec_chroma_pos_to_enum(int xpos, int ypos);
3927 #if FF_API_OLD_DECODE_AUDIO
3929 * Wrapper function which calls avcodec_decode_audio4.
3931 * @deprecated Use avcodec_decode_audio4 instead.
3933 * Decode the audio frame of size avpkt->size from avpkt->data into samples.
3934 * Some decoders may support multiple frames in a single AVPacket, such
3935 * decoders would then just decode the first frame. In this case,
3936 * avcodec_decode_audio3 has to be called again with an AVPacket that contains
3937 * the remaining data in order to decode the second frame etc.
3939 * could be outputted, frame_size_ptr is zero. Otherwise, it is the
3940 * decompressed frame size in bytes.
3942 * @warning You must set frame_size_ptr to the allocated size of the
3943 * output buffer before calling avcodec_decode_audio3().
3945 * @warning The input buffer must be FF_INPUT_BUFFER_PADDING_SIZE larger than
3946 * the actual read bytes because some optimized bitstream readers read 32 or 64
3947 * bits at once and could read over the end.
3949 * @warning The end of the input buffer avpkt->data should be set to 0 to ensure that
3950 * no overreading happens for damaged MPEG streams.
3952 * @warning You must not provide a custom get_buffer() when using
3953 * avcodec_decode_audio3(). Doing so will override it with
3954 * avcodec_default_get_buffer. Use avcodec_decode_audio4() instead,
3955 * which does allow the application to provide a custom get_buffer().
3957 * @note You might have to align the input buffer avpkt->data and output buffer
3958 * samples. The alignment requirements depend on the CPU: On some CPUs it isn't
3959 * necessary at all, on others it won't work at all if not aligned and on others
3960 * it will work but it will have an impact on performance.
3962 * In practice, avpkt->data should have 4 byte alignment at minimum and
3963 * samples should be 16 byte aligned unless the CPU doesn't need it
3964 * (AltiVec and SSE do).
3966 * @note Codecs which have the CODEC_CAP_DELAY capability set have a delay
3967 * between input and output, these need to be fed with avpkt->data=NULL,
3968 * avpkt->size=0 at the end to return the remaining frames.
3970 * @param avctx the codec context
3971 * @param[out] samples the output buffer, sample type in avctx->sample_fmt
3972 * If the sample format is planar, each channel plane will
3973 * be the same size, with no padding between channels.
3974 * @param[in,out] frame_size_ptr the output buffer size in bytes
3975 * @param[in] avpkt The input AVPacket containing the input buffer.
3976 * You can create such packet with av_init_packet() and by then setting
3977 * data and size, some decoders might in addition need other fields.
3978 * All decoders are designed to use the least fields possible though.
3979 * @return On error a negative value is returned, otherwise the number of bytes
3980 * used or zero if no frame data was decompressed (used) from the input AVPacket.
3982 attribute_deprecated int avcodec_decode_audio3(AVCodecContext *avctx, int16_t *samples,
3983 int *frame_size_ptr,
3988 * Decode the audio frame of size avpkt->size from avpkt->data into frame.
3990 * Some decoders may support multiple frames in a single AVPacket. Such
3991 * decoders would then just decode the first frame and the return value would be
3992 * less than the packet size. In this case, avcodec_decode_audio4 has to be
3993 * called again with an AVPacket containing the remaining data in order to
3994 * decode the second frame, etc... Even if no frames are returned, the packet
3995 * needs to be fed to the decoder with remaining data until it is completely
3996 * consumed or an error occurs.
3998 * Some decoders (those marked with CODEC_CAP_DELAY) have a delay between input
3999 * and output. This means that for some packets they will not immediately
4000 * produce decoded output and need to be flushed at the end of decoding to get
4001 * all the decoded data. Flushing is done by calling this function with packets
4002 * with avpkt->data set to NULL and avpkt->size set to 0 until it stops
4003 * returning samples. It is safe to flush even those decoders that are not
4004 * marked with CODEC_CAP_DELAY, then no samples will be returned.
4006 * @warning The input buffer, avpkt->data must be FF_INPUT_BUFFER_PADDING_SIZE
4007 * larger than the actual read bytes because some optimized bitstream
4008 * readers read 32 or 64 bits at once and could read over the end.
4010 * @param avctx the codec context
4011 * @param[out] frame The AVFrame in which to store decoded audio samples.
4012 * The decoder will allocate a buffer for the decoded frame by
4013 * calling the AVCodecContext.get_buffer2() callback.
4014 * When AVCodecContext.refcounted_frames is set to 1, the frame is
4015 * reference counted and the returned reference belongs to the
4016 * caller. The caller must release the frame using av_frame_unref()
4017 * when the frame is no longer needed. The caller may safely write
4018 * to the frame if av_frame_is_writable() returns 1.
4019 * When AVCodecContext.refcounted_frames is set to 0, the returned
4020 * reference belongs to the decoder and is valid only until the
4021 * next call to this function or until closing or flushing the
4022 * decoder. The caller may not write to it.
4023 * @param[out] got_frame_ptr Zero if no frame could be decoded, otherwise it is
4024 * non-zero. Note that this field being set to zero
4025 * does not mean that an error has occurred. For
4026 * decoders with CODEC_CAP_DELAY set, no given decode
4027 * call is guaranteed to produce a frame.
4028 * @param[in] avpkt The input AVPacket containing the input buffer.
4029 * At least avpkt->data and avpkt->size should be set. Some
4030 * decoders might also require additional fields to be set.
4031 * @return A negative error code is returned if an error occurred during
4032 * decoding, otherwise the number of bytes consumed from the input
4033 * AVPacket is returned.
4035 int avcodec_decode_audio4(AVCodecContext *avctx, AVFrame *frame,
4036 int *got_frame_ptr, const AVPacket *avpkt);
4039 * Decode the video frame of size avpkt->size from avpkt->data into picture.
4040 * Some decoders may support multiple frames in a single AVPacket, such
4041 * decoders would then just decode the first frame.
4043 * @warning The input buffer must be FF_INPUT_BUFFER_PADDING_SIZE larger than
4044 * the actual read bytes because some optimized bitstream readers read 32 or 64
4045 * bits at once and could read over the end.
4047 * @warning The end of the input buffer buf should be set to 0 to ensure that
4048 * no overreading happens for damaged MPEG streams.
4050 * @note Codecs which have the CODEC_CAP_DELAY capability set have a delay
4051 * between input and output, these need to be fed with avpkt->data=NULL,
4052 * avpkt->size=0 at the end to return the remaining frames.
4054 * @param avctx the codec context
4055 * @param[out] picture The AVFrame in which the decoded video frame will be stored.
4056 * Use av_frame_alloc() to get an AVFrame. The codec will
4057 * allocate memory for the actual bitmap by calling the
4058 * AVCodecContext.get_buffer2() callback.
4059 * When AVCodecContext.refcounted_frames is set to 1, the frame is
4060 * reference counted and the returned reference belongs to the
4061 * caller. The caller must release the frame using av_frame_unref()
4062 * when the frame is no longer needed. The caller may safely write
4063 * to the frame if av_frame_is_writable() returns 1.
4064 * When AVCodecContext.refcounted_frames is set to 0, the returned
4065 * reference belongs to the decoder and is valid only until the
4066 * next call to this function or until closing or flushing the
4067 * decoder. The caller may not write to it.
4069 * @param[in] avpkt The input AVPacket containing the input buffer.
4070 * You can create such packet with av_init_packet() and by then setting
4071 * data and size, some decoders might in addition need other fields like
4072 * flags&AV_PKT_FLAG_KEY. All decoders are designed to use the least
4074 * @param[in,out] got_picture_ptr Zero if no frame could be decompressed, otherwise, it is nonzero.
4075 * @return On error a negative value is returned, otherwise the number of bytes
4076 * used or zero if no frame could be decompressed.
4078 int avcodec_decode_video2(AVCodecContext *avctx, AVFrame *picture,
4079 int *got_picture_ptr,
4080 const AVPacket *avpkt);
4083 * Decode a subtitle message.
4084 * Return a negative value on error, otherwise return the number of bytes used.
4085 * If no subtitle could be decompressed, got_sub_ptr is zero.
4086 * Otherwise, the subtitle is stored in *sub.
4087 * Note that CODEC_CAP_DR1 is not available for subtitle codecs. This is for
4088 * simplicity, because the performance difference is expect to be negligible
4089 * and reusing a get_buffer written for video codecs would probably perform badly
4090 * due to a potentially very different allocation pattern.
4092 * Some decoders (those marked with CODEC_CAP_DELAY) have a delay between input
4093 * and output. This means that for some packets they will not immediately
4094 * produce decoded output and need to be flushed at the end of decoding to get
4095 * all the decoded data. Flushing is done by calling this function with packets
4096 * with avpkt->data set to NULL and avpkt->size set to 0 until it stops
4097 * returning subtitles. It is safe to flush even those decoders that are not
4098 * marked with CODEC_CAP_DELAY, then no subtitles will be returned.
4100 * @param avctx the codec context
4101 * @param[out] sub The Preallocated AVSubtitle in which the decoded subtitle will be stored,
4102 * must be freed with avsubtitle_free if *got_sub_ptr is set.
4103 * @param[in,out] got_sub_ptr Zero if no subtitle could be decompressed, otherwise, it is nonzero.
4104 * @param[in] avpkt The input AVPacket containing the input buffer.
4106 int avcodec_decode_subtitle2(AVCodecContext *avctx, AVSubtitle *sub,
4111 * @defgroup lavc_parsing Frame parsing
4115 enum AVPictureStructure {
4116 AV_PICTURE_STRUCTURE_UNKNOWN, //< unknown
4117 AV_PICTURE_STRUCTURE_TOP_FIELD, //< coded as top field
4118 AV_PICTURE_STRUCTURE_BOTTOM_FIELD, //< coded as bottom field
4119 AV_PICTURE_STRUCTURE_FRAME, //< coded as frame
4122 typedef struct AVCodecParserContext {
4124 struct AVCodecParser *parser;
4125 int64_t frame_offset; /* offset of the current frame */
4126 int64_t cur_offset; /* current offset
4127 (incremented by each av_parser_parse()) */
4128 int64_t next_frame_offset; /* offset of the next frame */
4130 int pict_type; /* XXX: Put it back in AVCodecContext. */
4132 * This field is used for proper frame duration computation in lavf.
4133 * It signals, how much longer the frame duration of the current frame
4134 * is compared to normal frame duration.
4136 * frame_duration = (1 + repeat_pict) * time_base
4138 * It is used by codecs like H.264 to display telecined material.
4140 int repeat_pict; /* XXX: Put it back in AVCodecContext. */
4141 int64_t pts; /* pts of the current frame */
4142 int64_t dts; /* dts of the current frame */
4147 int fetch_timestamp;
4149 #define AV_PARSER_PTS_NB 4
4150 int cur_frame_start_index;
4151 int64_t cur_frame_offset[AV_PARSER_PTS_NB];
4152 int64_t cur_frame_pts[AV_PARSER_PTS_NB];
4153 int64_t cur_frame_dts[AV_PARSER_PTS_NB];
4156 #define PARSER_FLAG_COMPLETE_FRAMES 0x0001
4157 #define PARSER_FLAG_ONCE 0x0002
4158 /// Set if the parser has a valid file offset
4159 #define PARSER_FLAG_FETCHED_OFFSET 0x0004
4160 #define PARSER_FLAG_USE_CODEC_TS 0x1000
4162 int64_t offset; ///< byte offset from starting packet start
4163 int64_t cur_frame_end[AV_PARSER_PTS_NB];
4166 * Set by parser to 1 for key frames and 0 for non-key frames.
4167 * It is initialized to -1, so if the parser doesn't set this flag,
4168 * old-style fallback using AV_PICTURE_TYPE_I picture type as key frames
4174 * Time difference in stream time base units from the pts of this
4175 * packet to the point at which the output from the decoder has converged
4176 * independent from the availability of previous frames. That is, the
4177 * frames are virtually identical no matter if decoding started from
4178 * the very first frame or from this keyframe.
4179 * Is AV_NOPTS_VALUE if unknown.
4180 * This field is not the display duration of the current frame.
4181 * This field has no meaning if the packet does not have AV_PKT_FLAG_KEY
4184 * The purpose of this field is to allow seeking in streams that have no
4185 * keyframes in the conventional sense. It corresponds to the
4186 * recovery point SEI in H.264 and match_time_delta in NUT. It is also
4187 * essential for some types of subtitle streams to ensure that all
4188 * subtitles are correctly displayed after seeking.
4190 int64_t convergence_duration;
4192 // Timestamp generation support:
4194 * Synchronization point for start of timestamp generation.
4196 * Set to >0 for sync point, 0 for no sync point and <0 for undefined
4199 * For example, this corresponds to presence of H.264 buffering period
4205 * Offset of the current timestamp against last timestamp sync point in
4206 * units of AVCodecContext.time_base.
4208 * Set to INT_MIN when dts_sync_point unused. Otherwise, it must
4209 * contain a valid timestamp offset.
4211 * Note that the timestamp of sync point has usually a nonzero
4212 * dts_ref_dts_delta, which refers to the previous sync point. Offset of
4213 * the next frame after timestamp sync point will be usually 1.
4215 * For example, this corresponds to H.264 cpb_removal_delay.
4217 int dts_ref_dts_delta;
4220 * Presentation delay of current frame in units of AVCodecContext.time_base.
4222 * Set to INT_MIN when dts_sync_point unused. Otherwise, it must
4223 * contain valid non-negative timestamp delta (presentation time of a frame
4224 * must not lie in the past).
4226 * This delay represents the difference between decoding and presentation
4227 * time of the frame.
4229 * For example, this corresponds to H.264 dpb_output_delay.
4234 * Position of the packet in file.
4236 * Analogous to cur_frame_pts/dts
4238 int64_t cur_frame_pos[AV_PARSER_PTS_NB];
4241 * Byte position of currently parsed frame in stream.
4246 * Previous frame byte position.
4251 * Duration of the current frame.
4252 * For audio, this is in units of 1 / AVCodecContext.sample_rate.
4253 * For all other types, this is in units of AVCodecContext.time_base.
4257 enum AVFieldOrder field_order;
4260 * Indicate whether a picture is coded as a frame, top field or bottom field.
4262 * For example, H.264 field_pic_flag equal to 0 corresponds to
4263 * AV_PICTURE_STRUCTURE_FRAME. An H.264 picture with field_pic_flag
4264 * equal to 1 and bottom_field_flag equal to 0 corresponds to
4265 * AV_PICTURE_STRUCTURE_TOP_FIELD.
4267 enum AVPictureStructure picture_structure;
4270 * Picture number incremented in presentation or output order.
4271 * This field may be reinitialized at the first picture of a new sequence.
4273 * For example, this corresponds to H.264 PicOrderCnt.
4275 int output_picture_number;
4276 } AVCodecParserContext;
4278 typedef struct AVCodecParser {
4279 int codec_ids[5]; /* several codec IDs are permitted */
4281 int (*parser_init)(AVCodecParserContext *s);
4282 int (*parser_parse)(AVCodecParserContext *s,
4283 AVCodecContext *avctx,
4284 const uint8_t **poutbuf, int *poutbuf_size,
4285 const uint8_t *buf, int buf_size);
4286 void (*parser_close)(AVCodecParserContext *s);
4287 int (*split)(AVCodecContext *avctx, const uint8_t *buf, int buf_size);
4288 struct AVCodecParser *next;
4291 AVCodecParser *av_parser_next(const AVCodecParser *c);
4293 void av_register_codec_parser(AVCodecParser *parser);
4294 AVCodecParserContext *av_parser_init(int codec_id);
4299 * @param s parser context.
4300 * @param avctx codec context.
4301 * @param poutbuf set to pointer to parsed buffer or NULL if not yet finished.
4302 * @param poutbuf_size set to size of parsed buffer or zero if not yet finished.
4303 * @param buf input buffer.
4304 * @param buf_size input length, to signal EOF, this should be 0 (so that the last frame can be output).
4305 * @param pts input presentation timestamp.
4306 * @param dts input decoding timestamp.
4307 * @param pos input byte position in stream.
4308 * @return the number of bytes of the input bitstream used.
4313 * len = av_parser_parse2(myparser, AVCodecContext, &data, &size,
4320 * decode_frame(data, size);
4324 int av_parser_parse2(AVCodecParserContext *s,
4325 AVCodecContext *avctx,
4326 uint8_t **poutbuf, int *poutbuf_size,
4327 const uint8_t *buf, int buf_size,
4328 int64_t pts, int64_t dts,
4332 * @return 0 if the output buffer is a subset of the input, 1 if it is allocated and must be freed
4333 * @deprecated use AVBitStreamFilter
4335 int av_parser_change(AVCodecParserContext *s,
4336 AVCodecContext *avctx,
4337 uint8_t **poutbuf, int *poutbuf_size,
4338 const uint8_t *buf, int buf_size, int keyframe);
4339 void av_parser_close(AVCodecParserContext *s);
4347 * @addtogroup lavc_encoding
4352 * Find a registered encoder with a matching codec ID.
4354 * @param id AVCodecID of the requested encoder
4355 * @return An encoder if one was found, NULL otherwise.
4357 AVCodec *avcodec_find_encoder(enum AVCodecID id);
4360 * Find a registered encoder with the specified name.
4362 * @param name name of the requested encoder
4363 * @return An encoder if one was found, NULL otherwise.
4365 AVCodec *avcodec_find_encoder_by_name(const char *name);
4367 #if FF_API_OLD_ENCODE_AUDIO
4369 * Encode an audio frame from samples into buf.
4371 * @deprecated Use avcodec_encode_audio2 instead.
4373 * @note The output buffer should be at least FF_MIN_BUFFER_SIZE bytes large.
4374 * However, for codecs with avctx->frame_size equal to 0 (e.g. PCM) the user
4375 * will know how much space is needed because it depends on the value passed
4376 * in buf_size as described below. In that case a lower value can be used.
4378 * @param avctx the codec context
4379 * @param[out] buf the output buffer
4380 * @param[in] buf_size the output buffer size
4381 * @param[in] samples the input buffer containing the samples
4382 * The number of samples read from this buffer is frame_size*channels,
4383 * both of which are defined in avctx.
4384 * For codecs which have avctx->frame_size equal to 0 (e.g. PCM) the number of
4385 * samples read from samples is equal to:
4386 * buf_size * 8 / (avctx->channels * av_get_bits_per_sample(avctx->codec_id))
4387 * This also implies that av_get_bits_per_sample() must not return 0 for these
4389 * @return On error a negative value is returned, on success zero or the number
4390 * of bytes used to encode the data read from the input buffer.
4392 int attribute_deprecated avcodec_encode_audio(AVCodecContext *avctx,
4393 uint8_t *buf, int buf_size,
4394 const short *samples);
4398 * Encode a frame of audio.
4400 * Takes input samples from frame and writes the next output packet, if
4401 * available, to avpkt. The output packet does not necessarily contain data for
4402 * the most recent frame, as encoders can delay, split, and combine input frames
4403 * internally as needed.
4405 * @param avctx codec context
4406 * @param avpkt output AVPacket.
4407 * The user can supply an output buffer by setting
4408 * avpkt->data and avpkt->size prior to calling the
4409 * function, but if the size of the user-provided data is not
4410 * large enough, encoding will fail. If avpkt->data and
4411 * avpkt->size are set, avpkt->destruct must also be set. All
4412 * other AVPacket fields will be reset by the encoder using
4413 * av_init_packet(). If avpkt->data is NULL, the encoder will
4414 * allocate it. The encoder will set avpkt->size to the size
4415 * of the output packet.
4417 * If this function fails or produces no output, avpkt will be
4418 * freed using av_free_packet() (i.e. avpkt->destruct will be
4419 * called to free the user supplied buffer).
4420 * @param[in] frame AVFrame containing the raw audio data to be encoded.
4421 * May be NULL when flushing an encoder that has the
4422 * CODEC_CAP_DELAY capability set.
4423 * If CODEC_CAP_VARIABLE_FRAME_SIZE is set, then each frame
4424 * can have any number of samples.
4425 * If it is not set, frame->nb_samples must be equal to
4426 * avctx->frame_size for all frames except the last.
4427 * The final frame may be smaller than avctx->frame_size.
4428 * @param[out] got_packet_ptr This field is set to 1 by libavcodec if the
4429 * output packet is non-empty, and to 0 if it is
4430 * empty. If the function returns an error, the
4431 * packet can be assumed to be invalid, and the
4432 * value of got_packet_ptr is undefined and should
4434 * @return 0 on success, negative error code on failure
4436 int avcodec_encode_audio2(AVCodecContext *avctx, AVPacket *avpkt,
4437 const AVFrame *frame, int *got_packet_ptr);
4439 #if FF_API_OLD_ENCODE_VIDEO
4441 * @deprecated use avcodec_encode_video2() instead.
4443 * Encode a video frame from pict into buf.
4444 * The input picture should be
4445 * stored using a specific format, namely avctx.pix_fmt.
4447 * @param avctx the codec context
4448 * @param[out] buf the output buffer for the bitstream of encoded frame
4449 * @param[in] buf_size the size of the output buffer in bytes
4450 * @param[in] pict the input picture to encode
4451 * @return On error a negative value is returned, on success zero or the number
4452 * of bytes used from the output buffer.
4454 attribute_deprecated
4455 int avcodec_encode_video(AVCodecContext *avctx, uint8_t *buf, int buf_size,
4456 const AVFrame *pict);
4460 * Encode a frame of video.
4462 * Takes input raw video data from frame and writes the next output packet, if
4463 * available, to avpkt. The output packet does not necessarily contain data for
4464 * the most recent frame, as encoders can delay and reorder input frames
4465 * internally as needed.
4467 * @param avctx codec context
4468 * @param avpkt output AVPacket.
4469 * The user can supply an output buffer by setting
4470 * avpkt->data and avpkt->size prior to calling the
4471 * function, but if the size of the user-provided data is not
4472 * large enough, encoding will fail. All other AVPacket fields
4473 * will be reset by the encoder using av_init_packet(). If
4474 * avpkt->data is NULL, the encoder will allocate it.
4475 * The encoder will set avpkt->size to the size of the
4476 * output packet. The returned data (if any) belongs to the
4477 * caller, he is responsible for freeing it.
4479 * If this function fails or produces no output, avpkt will be
4480 * freed using av_free_packet() (i.e. avpkt->destruct will be
4481 * called to free the user supplied buffer).
4482 * @param[in] frame AVFrame containing the raw video data to be encoded.
4483 * May be NULL when flushing an encoder that has the
4484 * CODEC_CAP_DELAY capability set.
4485 * @param[out] got_packet_ptr This field is set to 1 by libavcodec if the
4486 * output packet is non-empty, and to 0 if it is
4487 * empty. If the function returns an error, the
4488 * packet can be assumed to be invalid, and the
4489 * value of got_packet_ptr is undefined and should
4491 * @return 0 on success, negative error code on failure
4493 int avcodec_encode_video2(AVCodecContext *avctx, AVPacket *avpkt,
4494 const AVFrame *frame, int *got_packet_ptr);
4496 int avcodec_encode_subtitle(AVCodecContext *avctx, uint8_t *buf, int buf_size,
4497 const AVSubtitle *sub);
4504 #if FF_API_AVCODEC_RESAMPLE
4506 * @defgroup lavc_resample Audio resampling
4508 * @deprecated use libswresample instead
4512 struct ReSampleContext;
4513 struct AVResampleContext;
4515 typedef struct ReSampleContext ReSampleContext;
4518 * Initialize audio resampling context.
4520 * @param output_channels number of output channels
4521 * @param input_channels number of input channels
4522 * @param output_rate output sample rate
4523 * @param input_rate input sample rate
4524 * @param sample_fmt_out requested output sample format
4525 * @param sample_fmt_in input sample format
4526 * @param filter_length length of each FIR filter in the filterbank relative to the cutoff frequency
4527 * @param log2_phase_count log2 of the number of entries in the polyphase filterbank
4528 * @param linear if 1 then the used FIR filter will be linearly interpolated
4529 between the 2 closest, if 0 the closest will be used
4530 * @param cutoff cutoff frequency, 1.0 corresponds to half the output sampling rate
4531 * @return allocated ReSampleContext, NULL if error occurred
4533 attribute_deprecated
4534 ReSampleContext *av_audio_resample_init(int output_channels, int input_channels,
4535 int output_rate, int input_rate,
4536 enum AVSampleFormat sample_fmt_out,
4537 enum AVSampleFormat sample_fmt_in,
4538 int filter_length, int log2_phase_count,
4539 int linear, double cutoff);
4541 attribute_deprecated
4542 int audio_resample(ReSampleContext *s, short *output, short *input, int nb_samples);
4545 * Free resample context.
4547 * @param s a non-NULL pointer to a resample context previously
4548 * created with av_audio_resample_init()
4550 attribute_deprecated
4551 void audio_resample_close(ReSampleContext *s);
4555 * Initialize an audio resampler.
4556 * Note, if either rate is not an integer then simply scale both rates up so they are.
4557 * @param filter_length length of each FIR filter in the filterbank relative to the cutoff freq
4558 * @param log2_phase_count log2 of the number of entries in the polyphase filterbank
4559 * @param linear If 1 then the used FIR filter will be linearly interpolated
4560 between the 2 closest, if 0 the closest will be used
4561 * @param cutoff cutoff frequency, 1.0 corresponds to half the output sampling rate
4563 attribute_deprecated
4564 struct AVResampleContext *av_resample_init(int out_rate, int in_rate, int filter_length, int log2_phase_count, int linear, double cutoff);
4567 * Resample an array of samples using a previously configured context.
4568 * @param src an array of unconsumed samples
4569 * @param consumed the number of samples of src which have been consumed are returned here
4570 * @param src_size the number of unconsumed samples available
4571 * @param dst_size the amount of space in samples available in dst
4572 * @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.
4573 * @return the number of samples written in dst or -1 if an error occurred
4575 attribute_deprecated
4576 int av_resample(struct AVResampleContext *c, short *dst, short *src, int *consumed, int src_size, int dst_size, int update_ctx);
4580 * Compensate samplerate/timestamp drift. The compensation is done by changing
4581 * the resampler parameters, so no audible clicks or similar distortions occur
4582 * @param compensation_distance distance in output samples over which the compensation should be performed
4583 * @param sample_delta number of output samples which should be output less
4585 * example: av_resample_compensate(c, 10, 500)
4586 * here instead of 510 samples only 500 samples would be output
4588 * note, due to rounding the actual compensation might be slightly different,
4589 * especially if the compensation_distance is large and the in_rate used during init is small
4591 attribute_deprecated
4592 void av_resample_compensate(struct AVResampleContext *c, int sample_delta, int compensation_distance);
4593 attribute_deprecated
4594 void av_resample_close(struct AVResampleContext *c);
4602 * @addtogroup lavc_picture
4607 * Allocate memory for the pixels of a picture and setup the AVPicture
4610 * Call avpicture_free() to free it.
4612 * @param picture the picture structure to be filled in
4613 * @param pix_fmt the pixel format of the picture
4614 * @param width the width of the picture
4615 * @param height the height of the picture
4616 * @return zero if successful, a negative error code otherwise
4618 * @see av_image_alloc(), avpicture_fill()
4620 int avpicture_alloc(AVPicture *picture, enum AVPixelFormat pix_fmt, int width, int height);
4623 * Free a picture previously allocated by avpicture_alloc().
4624 * The data buffer used by the AVPicture is freed, but the AVPicture structure
4627 * @param picture the AVPicture to be freed
4629 void avpicture_free(AVPicture *picture);
4632 * Setup the picture fields based on the specified image parameters
4633 * and the provided image data buffer.
4635 * The picture fields are filled in by using the image data buffer
4636 * pointed to by ptr.
4638 * If ptr is NULL, the function will fill only the picture linesize
4639 * array and return the required size for the image buffer.
4641 * To allocate an image buffer and fill the picture data in one call,
4642 * use avpicture_alloc().
4644 * @param picture the picture to be filled in
4645 * @param ptr buffer where the image data is stored, or NULL
4646 * @param pix_fmt the pixel format of the image
4647 * @param width the width of the image in pixels
4648 * @param height the height of the image in pixels
4649 * @return the size in bytes required for src, a negative error code
4650 * in case of failure
4652 * @see av_image_fill_arrays()
4654 int avpicture_fill(AVPicture *picture, const uint8_t *ptr,
4655 enum AVPixelFormat pix_fmt, int width, int height);
4658 * Copy pixel data from an AVPicture into a buffer.
4660 * avpicture_get_size() can be used to compute the required size for
4661 * the buffer to fill.
4663 * @param src source picture with filled data
4664 * @param pix_fmt picture pixel format
4665 * @param width picture width
4666 * @param height picture height
4667 * @param dest destination buffer
4668 * @param dest_size destination buffer size in bytes
4669 * @return the number of bytes written to dest, or a negative value
4670 * (error code) on error, for example if the destination buffer is not
4673 * @see av_image_copy_to_buffer()
4675 int avpicture_layout(const AVPicture *src, enum AVPixelFormat pix_fmt,
4676 int width, int height,
4677 unsigned char *dest, int dest_size);
4680 * Calculate the size in bytes that a picture of the given width and height
4681 * would occupy if stored in the given picture format.
4683 * @param pix_fmt picture pixel format
4684 * @param width picture width
4685 * @param height picture height
4686 * @return the computed picture buffer size or a negative error code
4689 * @see av_image_get_buffer_size().
4691 int avpicture_get_size(enum AVPixelFormat pix_fmt, int width, int height);
4693 #if FF_API_DEINTERLACE
4695 * deinterlace - if not supported return -1
4697 * @deprecated - use yadif (in libavfilter) instead
4699 attribute_deprecated
4700 int avpicture_deinterlace(AVPicture *dst, const AVPicture *src,
4701 enum AVPixelFormat pix_fmt, int width, int height);
4704 * Copy image src to dst. Wraps av_image_copy().
4706 void av_picture_copy(AVPicture *dst, const AVPicture *src,
4707 enum AVPixelFormat pix_fmt, int width, int height);
4710 * Crop image top and left side.
4712 int av_picture_crop(AVPicture *dst, const AVPicture *src,
4713 enum AVPixelFormat pix_fmt, int top_band, int left_band);
4718 int av_picture_pad(AVPicture *dst, const AVPicture *src, int height, int width, enum AVPixelFormat pix_fmt,
4719 int padtop, int padbottom, int padleft, int padright, int *color);
4726 * @defgroup lavc_misc Utility functions
4729 * Miscellaneous utility functions related to both encoding and decoding
4735 * @defgroup lavc_misc_pixfmt Pixel formats
4737 * Functions for working with pixel formats.
4742 * Utility function to access log2_chroma_w log2_chroma_h from
4743 * the pixel format AVPixFmtDescriptor.
4745 * This function asserts that pix_fmt is valid. See av_pix_fmt_get_chroma_sub_sample
4746 * for one that returns a failure code and continues in case of invalid
4749 * @param[in] pix_fmt the pixel format
4750 * @param[out] h_shift store log2_chroma_w
4751 * @param[out] v_shift store log2_chroma_h
4753 * @see av_pix_fmt_get_chroma_sub_sample
4756 void avcodec_get_chroma_sub_sample(enum AVPixelFormat pix_fmt, int *h_shift, int *v_shift);
4759 * Return a value representing the fourCC code associated to the
4760 * pixel format pix_fmt, or 0 if no associated fourCC code can be
4763 unsigned int avcodec_pix_fmt_to_codec_tag(enum AVPixelFormat pix_fmt);
4766 * @deprecated see av_get_pix_fmt_loss()
4768 int avcodec_get_pix_fmt_loss(enum AVPixelFormat dst_pix_fmt, enum AVPixelFormat src_pix_fmt,
4772 * Find the best pixel format to convert to given a certain source pixel
4773 * format. When converting from one pixel format to another, information loss
4774 * may occur. For example, when converting from RGB24 to GRAY, the color
4775 * information will be lost. Similarly, other losses occur when converting from
4776 * some formats to other formats. avcodec_find_best_pix_fmt_of_2() searches which of
4777 * the given pixel formats should be used to suffer the least amount of loss.
4778 * The pixel formats from which it chooses one, are determined by the
4779 * pix_fmt_list parameter.
4782 * @param[in] pix_fmt_list AV_PIX_FMT_NONE terminated array of pixel formats to choose from
4783 * @param[in] src_pix_fmt source pixel format
4784 * @param[in] has_alpha Whether the source pixel format alpha channel is used.
4785 * @param[out] loss_ptr Combination of flags informing you what kind of losses will occur.
4786 * @return The best pixel format to convert to or -1 if none was found.
4788 enum AVPixelFormat avcodec_find_best_pix_fmt_of_list(const enum AVPixelFormat *pix_fmt_list,
4789 enum AVPixelFormat src_pix_fmt,
4790 int has_alpha, int *loss_ptr);
4793 * @deprecated see av_find_best_pix_fmt_of_2()
4795 enum AVPixelFormat avcodec_find_best_pix_fmt_of_2(enum AVPixelFormat dst_pix_fmt1, enum AVPixelFormat dst_pix_fmt2,
4796 enum AVPixelFormat src_pix_fmt, int has_alpha, int *loss_ptr);
4798 attribute_deprecated
4799 #if AV_HAVE_INCOMPATIBLE_LIBAV_ABI
4800 enum AVPixelFormat avcodec_find_best_pix_fmt2(const enum AVPixelFormat *pix_fmt_list,
4801 enum AVPixelFormat src_pix_fmt,
4802 int has_alpha, int *loss_ptr);
4804 enum AVPixelFormat avcodec_find_best_pix_fmt2(enum AVPixelFormat dst_pix_fmt1, enum AVPixelFormat dst_pix_fmt2,
4805 enum AVPixelFormat src_pix_fmt, int has_alpha, int *loss_ptr);
4809 enum AVPixelFormat avcodec_default_get_format(struct AVCodecContext *s, const enum AVPixelFormat * fmt);
4815 #if FF_API_SET_DIMENSIONS
4817 * @deprecated this function is not supposed to be used from outside of lavc
4819 attribute_deprecated
4820 void avcodec_set_dimensions(AVCodecContext *s, int width, int height);
4824 * Put a string representing the codec tag codec_tag in buf.
4826 * @param buf buffer to place codec tag in
4827 * @param buf_size size in bytes of buf
4828 * @param codec_tag codec tag to assign
4829 * @return the length of the string that would have been generated if
4830 * enough space had been available, excluding the trailing null
4832 size_t av_get_codec_tag_string(char *buf, size_t buf_size, unsigned int codec_tag);
4834 void avcodec_string(char *buf, int buf_size, AVCodecContext *enc, int encode);
4837 * Return a name for the specified profile, if available.
4839 * @param codec the codec that is searched for the given profile
4840 * @param profile the profile value for which a name is requested
4841 * @return A name for the profile if found, NULL otherwise.
4843 const char *av_get_profile_name(const AVCodec *codec, int profile);
4845 int avcodec_default_execute(AVCodecContext *c, int (*func)(AVCodecContext *c2, void *arg2),void *arg, int *ret, int count, int size);
4846 int avcodec_default_execute2(AVCodecContext *c, int (*func)(AVCodecContext *c2, void *arg2, int, int),void *arg, int *ret, int count);
4847 //FIXME func typedef
4850 * Fill AVFrame audio data and linesize pointers.
4852 * The buffer buf must be a preallocated buffer with a size big enough
4853 * to contain the specified samples amount. The filled AVFrame data
4854 * pointers will point to this buffer.
4856 * AVFrame extended_data channel pointers are allocated if necessary for
4859 * @param frame the AVFrame
4860 * frame->nb_samples must be set prior to calling the
4861 * function. This function fills in frame->data,
4862 * frame->extended_data, frame->linesize[0].
4863 * @param nb_channels channel count
4864 * @param sample_fmt sample format
4865 * @param buf buffer to use for frame data
4866 * @param buf_size size of buffer
4867 * @param align plane size sample alignment (0 = default)
4868 * @return >=0 on success, negative error code on failure
4869 * @todo return the size in bytes required to store the samples in
4870 * case of success, at the next libavutil bump
4872 int avcodec_fill_audio_frame(AVFrame *frame, int nb_channels,
4873 enum AVSampleFormat sample_fmt, const uint8_t *buf,
4874 int buf_size, int align);
4877 * Reset the internal decoder state / flush internal buffers. Should be called
4878 * e.g. when seeking or when switching to a different stream.
4880 * @note when refcounted frames are not used (i.e. avctx->refcounted_frames is 0),
4881 * this invalidates the frames previously returned from the decoder. When
4882 * refcounted frames are used, the decoder just releases any references it might
4883 * keep internally, but the caller's reference remains valid.
4885 void avcodec_flush_buffers(AVCodecContext *avctx);
4888 * Return codec bits per sample.
4890 * @param[in] codec_id the codec
4891 * @return Number of bits per sample or zero if unknown for the given codec.
4893 int av_get_bits_per_sample(enum AVCodecID codec_id);
4896 * Return the PCM codec associated with a sample format.
4897 * @param be endianness, 0 for little, 1 for big,
4898 * -1 (or anything else) for native
4899 * @return AV_CODEC_ID_PCM_* or AV_CODEC_ID_NONE
4901 enum AVCodecID av_get_pcm_codec(enum AVSampleFormat fmt, int be);
4904 * Return codec bits per sample.
4905 * Only return non-zero if the bits per sample is exactly correct, not an
4908 * @param[in] codec_id the codec
4909 * @return Number of bits per sample or zero if unknown for the given codec.
4911 int av_get_exact_bits_per_sample(enum AVCodecID codec_id);
4914 * Return audio frame duration.
4916 * @param avctx codec context
4917 * @param frame_bytes size of the frame, or 0 if unknown
4918 * @return frame duration, in samples, if known. 0 if not able to
4921 int av_get_audio_frame_duration(AVCodecContext *avctx, int frame_bytes);
4924 typedef struct AVBitStreamFilterContext {
4926 struct AVBitStreamFilter *filter;
4927 AVCodecParserContext *parser;
4928 struct AVBitStreamFilterContext *next;
4929 } AVBitStreamFilterContext;
4932 typedef struct AVBitStreamFilter {
4935 int (*filter)(AVBitStreamFilterContext *bsfc,
4936 AVCodecContext *avctx, const char *args,
4937 uint8_t **poutbuf, int *poutbuf_size,
4938 const uint8_t *buf, int buf_size, int keyframe);
4939 void (*close)(AVBitStreamFilterContext *bsfc);
4940 struct AVBitStreamFilter *next;
4941 } AVBitStreamFilter;
4944 * Register a bitstream filter.
4946 * The filter will be accessible to the application code through
4947 * av_bitstream_filter_next() or can be directly initialized with
4948 * av_bitstream_filter_init().
4950 * @see avcodec_register_all()
4952 void av_register_bitstream_filter(AVBitStreamFilter *bsf);
4955 * Create and initialize a bitstream filter context given a bitstream
4958 * The returned context must be freed with av_bitstream_filter_close().
4960 * @param name the name of the bitstream filter
4961 * @return a bitstream filter context if a matching filter was found
4962 * and successfully initialized, NULL otherwise
4964 AVBitStreamFilterContext *av_bitstream_filter_init(const char *name);
4969 * This function filters the buffer buf with size buf_size, and places the
4970 * filtered buffer in the buffer pointed to by poutbuf.
4972 * The output buffer must be freed by the caller.
4974 * @param bsfc bitstream filter context created by av_bitstream_filter_init()
4975 * @param avctx AVCodecContext accessed by the filter, may be NULL.
4976 * If specified, this must point to the encoder context of the
4977 * output stream the packet is sent to.
4978 * @param args arguments which specify the filter configuration, may be NULL
4979 * @param poutbuf pointer which is updated to point to the filtered buffer
4980 * @param poutbuf_size pointer which is updated to the filtered buffer size in bytes
4981 * @param buf buffer containing the data to filter
4982 * @param buf_size size in bytes of buf
4983 * @param keyframe set to non-zero if the buffer to filter corresponds to a key-frame packet data
4984 * @return >= 0 in case of success, or a negative error code in case of failure
4986 * If the return value is positive, an output buffer is allocated and
4987 * is available in *poutbuf, and is distinct from the input buffer.
4989 * If the return value is 0, the output buffer is not allocated and
4990 * should be considered identical to the input buffer, or in case
4991 * *poutbuf was set it points to the input buffer (not necessarily to
4992 * its starting address).
4994 int av_bitstream_filter_filter(AVBitStreamFilterContext *bsfc,
4995 AVCodecContext *avctx, const char *args,
4996 uint8_t **poutbuf, int *poutbuf_size,
4997 const uint8_t *buf, int buf_size, int keyframe);
5000 * Release bitstream filter context.
5002 * @param bsf the bitstream filter context created with
5003 * av_bitstream_filter_init(), can be NULL
5005 void av_bitstream_filter_close(AVBitStreamFilterContext *bsf);
5008 * If f is NULL, return the first registered bitstream filter,
5009 * if f is non-NULL, return the next registered bitstream filter
5010 * after f, or NULL if f is the last one.
5012 * This function can be used to iterate over all registered bitstream
5015 AVBitStreamFilter *av_bitstream_filter_next(const AVBitStreamFilter *f);
5020 * Same behaviour av_fast_malloc but the buffer has additional
5021 * FF_INPUT_BUFFER_PADDING_SIZE at the end which will always be 0.
5023 * In addition the whole buffer will initially and after resizes
5024 * be 0-initialized so that no uninitialized data will ever appear.
5026 void av_fast_padded_malloc(void *ptr, unsigned int *size, size_t min_size);
5029 * Same behaviour av_fast_padded_malloc except that buffer will always
5030 * be 0-initialized after call.
5032 void av_fast_padded_mallocz(void *ptr, unsigned int *size, size_t min_size);
5035 * Encode extradata length to a buffer. Used by xiph codecs.
5037 * @param s buffer to write to; must be at least (v/255+1) bytes long
5038 * @param v size of extradata in bytes
5039 * @return number of bytes written to the buffer.
5041 unsigned int av_xiphlacing(unsigned char *s, unsigned int v);
5043 #if FF_API_MISSING_SAMPLE
5045 * Log a generic warning message about a missing feature. This function is
5046 * intended to be used internally by FFmpeg (libavcodec, libavformat, etc.)
5047 * only, and would normally not be used by applications.
5048 * @param[in] avc a pointer to an arbitrary struct of which the first field is
5049 * a pointer to an AVClass struct
5050 * @param[in] feature string containing the name of the missing feature
5051 * @param[in] want_sample indicates if samples are wanted which exhibit this feature.
5052 * If want_sample is non-zero, additional verbage will be added to the log
5053 * message which tells the user how to report samples to the development
5055 * @deprecated Use avpriv_report_missing_feature() instead.
5057 attribute_deprecated
5058 void av_log_missing_feature(void *avc, const char *feature, int want_sample);
5061 * Log a generic warning message asking for a sample. This function is
5062 * intended to be used internally by FFmpeg (libavcodec, libavformat, etc.)
5063 * only, and would normally not be used by applications.
5064 * @param[in] avc a pointer to an arbitrary struct of which the first field is
5065 * a pointer to an AVClass struct
5066 * @param[in] msg string containing an optional message, or NULL if no message
5067 * @deprecated Use avpriv_request_sample() instead.
5069 attribute_deprecated
5070 void av_log_ask_for_sample(void *avc, const char *msg, ...) av_printf_format(2, 3);
5071 #endif /* FF_API_MISSING_SAMPLE */
5074 * Register the hardware accelerator hwaccel.
5076 void av_register_hwaccel(AVHWAccel *hwaccel);
5079 * If hwaccel is NULL, returns the first registered hardware accelerator,
5080 * if hwaccel is non-NULL, returns the next registered hardware accelerator
5081 * after hwaccel, or NULL if hwaccel is the last one.
5083 AVHWAccel *av_hwaccel_next(const AVHWAccel *hwaccel);
5087 * Lock operation used by lockmgr
5090 AV_LOCK_CREATE, ///< Create a mutex
5091 AV_LOCK_OBTAIN, ///< Lock the mutex
5092 AV_LOCK_RELEASE, ///< Unlock the mutex
5093 AV_LOCK_DESTROY, ///< Free mutex resources
5097 * Register a user provided lock manager supporting the operations
5098 * specified by AVLockOp. mutex points to a (void *) where the
5099 * lockmgr should store/get a pointer to a user allocated mutex. It's
5100 * NULL upon AV_LOCK_CREATE and != NULL for all other ops.
5102 * @param cb User defined callback. Note: FFmpeg may invoke calls to this
5103 * callback during the call to av_lockmgr_register().
5104 * Thus, the application must be prepared to handle that.
5105 * If cb is set to NULL the lockmgr will be unregistered.
5106 * Also note that during unregistration the previously registered
5107 * lockmgr callback may also be invoked.
5109 int av_lockmgr_register(int (*cb)(void **mutex, enum AVLockOp op));
5112 * Get the type of the given codec.
5114 enum AVMediaType avcodec_get_type(enum AVCodecID codec_id);
5117 * Get the name of a codec.
5118 * @return a static string identifying the codec; never NULL
5120 const char *avcodec_get_name(enum AVCodecID id);
5123 * @return a positive value if s is open (i.e. avcodec_open2() was called on it
5124 * with no corresponding avcodec_close()), 0 otherwise.
5126 int avcodec_is_open(AVCodecContext *s);
5129 * @return a non-zero number if codec is an encoder, zero otherwise
5131 int av_codec_is_encoder(const AVCodec *codec);
5134 * @return a non-zero number if codec is a decoder, zero otherwise
5136 int av_codec_is_decoder(const AVCodec *codec);
5139 * @return descriptor for given codec ID or NULL if no descriptor exists.
5141 const AVCodecDescriptor *avcodec_descriptor_get(enum AVCodecID id);
5144 * Iterate over all codec descriptors known to libavcodec.
5146 * @param prev previous descriptor. NULL to get the first descriptor.
5148 * @return next descriptor or NULL after the last descriptor
5150 const AVCodecDescriptor *avcodec_descriptor_next(const AVCodecDescriptor *prev);
5153 * @return codec descriptor with the given name or NULL if no such descriptor
5156 const AVCodecDescriptor *avcodec_descriptor_get_by_name(const char *name);
5162 #endif /* AVCODEC_AVCODEC_H */