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,
190 AV_CODEC_ID_TRUEMOTION2,
196 AV_CODEC_ID_SMACKVIDEO,
201 AV_CODEC_ID_JPEG2000,
207 AV_CODEC_ID_DSICINVIDEO,
208 AV_CODEC_ID_TIERTEXSEQVIDEO,
216 AV_CODEC_ID_BETHSOFTVID,
228 AV_CODEC_ID_ESCAPE124,
232 AV_CODEC_ID_MOTIONPIXELS,
244 AV_CODEC_ID_FLASHSV2,
245 AV_CODEC_ID_CDGRAPHICS,
248 AV_CODEC_ID_BINKVIDEO,
249 AV_CODEC_ID_IFF_ILBM,
250 AV_CODEC_ID_IFF_BYTERUN1,
256 AV_CODEC_ID_A64_MULTI,
257 AV_CODEC_ID_A64_MULTI5,
260 AV_CODEC_ID_LAGARITH,
264 AV_CODEC_ID_WMV3IMAGE,
265 AV_CODEC_ID_VC1IMAGE,
267 AV_CODEC_ID_BMV_VIDEO,
274 AV_CODEC_ID_ZEROCODEC,
283 AV_CODEC_ID_ESCAPE130_DEPRECATED,
284 AV_CODEC_ID_G2M_DEPRECATED,
285 AV_CODEC_ID_WEBP_DEPRECATED,
286 AV_CODEC_ID_HNM4_VIDEO,
287 AV_CODEC_ID_HEVC_DEPRECATED,
289 AV_CODEC_ID_ALIAS_PIX,
290 AV_CODEC_ID_BRENDER_PIX_DEPRECATED,
291 AV_CODEC_ID_PAF_VIDEO_DEPRECATED,
292 AV_CODEC_ID_EXR_DEPRECATED,
293 AV_CODEC_ID_VP7_DEPRECATED,
294 AV_CODEC_ID_SANM_DEPRECATED,
295 AV_CODEC_ID_SGIRLE_DEPRECATED,
296 AV_CODEC_ID_MVC1_DEPRECATED,
297 AV_CODEC_ID_MVC2_DEPRECATED,
299 AV_CODEC_ID_BRENDER_PIX= MKBETAG('B','P','I','X'),
300 AV_CODEC_ID_Y41P = MKBETAG('Y','4','1','P'),
301 AV_CODEC_ID_ESCAPE130 = MKBETAG('E','1','3','0'),
302 AV_CODEC_ID_EXR = MKBETAG('0','E','X','R'),
303 AV_CODEC_ID_AVRP = MKBETAG('A','V','R','P'),
305 AV_CODEC_ID_012V = MKBETAG('0','1','2','V'),
306 AV_CODEC_ID_G2M = MKBETAG( 0 ,'G','2','M'),
307 AV_CODEC_ID_AVUI = MKBETAG('A','V','U','I'),
308 AV_CODEC_ID_AYUV = MKBETAG('A','Y','U','V'),
309 AV_CODEC_ID_TARGA_Y216 = MKBETAG('T','2','1','6'),
310 AV_CODEC_ID_V308 = MKBETAG('V','3','0','8'),
311 AV_CODEC_ID_V408 = MKBETAG('V','4','0','8'),
312 AV_CODEC_ID_YUV4 = MKBETAG('Y','U','V','4'),
313 AV_CODEC_ID_SANM = MKBETAG('S','A','N','M'),
314 AV_CODEC_ID_PAF_VIDEO = MKBETAG('P','A','F','V'),
315 AV_CODEC_ID_AVRN = MKBETAG('A','V','R','n'),
316 AV_CODEC_ID_CPIA = MKBETAG('C','P','I','A'),
317 AV_CODEC_ID_XFACE = MKBETAG('X','F','A','C'),
318 AV_CODEC_ID_SGIRLE = MKBETAG('S','G','I','R'),
319 AV_CODEC_ID_MVC1 = MKBETAG('M','V','C','1'),
320 AV_CODEC_ID_MVC2 = MKBETAG('M','V','C','2'),
321 AV_CODEC_ID_SNOW = MKBETAG('S','N','O','W'),
322 AV_CODEC_ID_WEBP = MKBETAG('W','E','B','P'),
323 AV_CODEC_ID_SMVJPEG = MKBETAG('S','M','V','J'),
324 AV_CODEC_ID_HEVC = MKBETAG('H','2','6','5'),
325 #define AV_CODEC_ID_H265 AV_CODEC_ID_HEVC
326 AV_CODEC_ID_VP7 = MKBETAG('V','P','7','0'),
328 /* various PCM "codecs" */
329 AV_CODEC_ID_FIRST_AUDIO = 0x10000, ///< A dummy id pointing at the start of audio codecs
330 AV_CODEC_ID_PCM_S16LE = 0x10000,
331 AV_CODEC_ID_PCM_S16BE,
332 AV_CODEC_ID_PCM_U16LE,
333 AV_CODEC_ID_PCM_U16BE,
336 AV_CODEC_ID_PCM_MULAW,
337 AV_CODEC_ID_PCM_ALAW,
338 AV_CODEC_ID_PCM_S32LE,
339 AV_CODEC_ID_PCM_S32BE,
340 AV_CODEC_ID_PCM_U32LE,
341 AV_CODEC_ID_PCM_U32BE,
342 AV_CODEC_ID_PCM_S24LE,
343 AV_CODEC_ID_PCM_S24BE,
344 AV_CODEC_ID_PCM_U24LE,
345 AV_CODEC_ID_PCM_U24BE,
346 AV_CODEC_ID_PCM_S24DAUD,
347 AV_CODEC_ID_PCM_ZORK,
348 AV_CODEC_ID_PCM_S16LE_PLANAR,
350 AV_CODEC_ID_PCM_F32BE,
351 AV_CODEC_ID_PCM_F32LE,
352 AV_CODEC_ID_PCM_F64BE,
353 AV_CODEC_ID_PCM_F64LE,
354 AV_CODEC_ID_PCM_BLURAY,
357 AV_CODEC_ID_PCM_S8_PLANAR,
358 AV_CODEC_ID_PCM_S24LE_PLANAR_DEPRECATED,
359 AV_CODEC_ID_PCM_S32LE_PLANAR_DEPRECATED,
360 AV_CODEC_ID_PCM_S24LE_PLANAR = MKBETAG(24,'P','S','P'),
361 AV_CODEC_ID_PCM_S32LE_PLANAR = MKBETAG(32,'P','S','P'),
362 AV_CODEC_ID_PCM_S16BE_PLANAR = MKBETAG('P','S','P',16),
364 /* various ADPCM codecs */
365 AV_CODEC_ID_ADPCM_IMA_QT = 0x11000,
366 AV_CODEC_ID_ADPCM_IMA_WAV,
367 AV_CODEC_ID_ADPCM_IMA_DK3,
368 AV_CODEC_ID_ADPCM_IMA_DK4,
369 AV_CODEC_ID_ADPCM_IMA_WS,
370 AV_CODEC_ID_ADPCM_IMA_SMJPEG,
371 AV_CODEC_ID_ADPCM_MS,
372 AV_CODEC_ID_ADPCM_4XM,
373 AV_CODEC_ID_ADPCM_XA,
374 AV_CODEC_ID_ADPCM_ADX,
375 AV_CODEC_ID_ADPCM_EA,
376 AV_CODEC_ID_ADPCM_G726,
377 AV_CODEC_ID_ADPCM_CT,
378 AV_CODEC_ID_ADPCM_SWF,
379 AV_CODEC_ID_ADPCM_YAMAHA,
380 AV_CODEC_ID_ADPCM_SBPRO_4,
381 AV_CODEC_ID_ADPCM_SBPRO_3,
382 AV_CODEC_ID_ADPCM_SBPRO_2,
383 AV_CODEC_ID_ADPCM_THP,
384 AV_CODEC_ID_ADPCM_IMA_AMV,
385 AV_CODEC_ID_ADPCM_EA_R1,
386 AV_CODEC_ID_ADPCM_EA_R3,
387 AV_CODEC_ID_ADPCM_EA_R2,
388 AV_CODEC_ID_ADPCM_IMA_EA_SEAD,
389 AV_CODEC_ID_ADPCM_IMA_EA_EACS,
390 AV_CODEC_ID_ADPCM_EA_XAS,
391 AV_CODEC_ID_ADPCM_EA_MAXIS_XA,
392 AV_CODEC_ID_ADPCM_IMA_ISS,
393 AV_CODEC_ID_ADPCM_G722,
394 AV_CODEC_ID_ADPCM_IMA_APC,
395 AV_CODEC_ID_ADPCM_VIMA_DEPRECATED,
396 AV_CODEC_ID_ADPCM_VIMA = MKBETAG('V','I','M','A'),
397 AV_CODEC_ID_VIMA = MKBETAG('V','I','M','A'),
398 AV_CODEC_ID_ADPCM_AFC = MKBETAG('A','F','C',' '),
399 AV_CODEC_ID_ADPCM_IMA_OKI = MKBETAG('O','K','I',' '),
400 AV_CODEC_ID_ADPCM_DTK = MKBETAG('D','T','K',' '),
401 AV_CODEC_ID_ADPCM_IMA_RAD = MKBETAG('R','A','D',' '),
402 AV_CODEC_ID_ADPCM_G726LE = MKBETAG('6','2','7','G'),
405 AV_CODEC_ID_AMR_NB = 0x12000,
408 /* RealAudio codecs*/
409 AV_CODEC_ID_RA_144 = 0x13000,
412 /* various DPCM codecs */
413 AV_CODEC_ID_ROQ_DPCM = 0x14000,
414 AV_CODEC_ID_INTERPLAY_DPCM,
415 AV_CODEC_ID_XAN_DPCM,
416 AV_CODEC_ID_SOL_DPCM,
419 AV_CODEC_ID_MP2 = 0x15000,
420 AV_CODEC_ID_MP3, ///< preferred ID for decoding MPEG audio layer 1, 2 or 3
430 AV_CODEC_ID_VMDAUDIO,
436 AV_CODEC_ID_WESTWOOD_SND1,
437 AV_CODEC_ID_GSM, ///< as in Berlin toast format
440 AV_CODEC_ID_TRUESPEECH,
442 AV_CODEC_ID_SMACKAUDIO,
445 AV_CODEC_ID_DSICINAUDIO,
447 AV_CODEC_ID_MUSEPACK7,
449 AV_CODEC_ID_GSM_MS, /* as found in WAV */
455 AV_CODEC_ID_NELLYMOSER,
456 AV_CODEC_ID_MUSEPACK8,
458 AV_CODEC_ID_WMAVOICE,
460 AV_CODEC_ID_WMALOSSLESS,
469 AV_CODEC_ID_BINKAUDIO_RDFT,
470 AV_CODEC_ID_BINKAUDIO_DCT,
471 AV_CODEC_ID_AAC_LATM,
476 AV_CODEC_ID_8SVX_EXP,
477 AV_CODEC_ID_8SVX_FIB,
478 AV_CODEC_ID_BMV_AUDIO,
482 AV_CODEC_ID_OPUS_DEPRECATED,
483 AV_CODEC_ID_COMFORT_NOISE,
484 AV_CODEC_ID_TAK_DEPRECATED,
485 AV_CODEC_ID_METASOUND,
486 AV_CODEC_ID_PAF_AUDIO_DEPRECATED,
488 AV_CODEC_ID_FFWAVESYNTH = MKBETAG('F','F','W','S'),
489 AV_CODEC_ID_SONIC = MKBETAG('S','O','N','C'),
490 AV_CODEC_ID_SONIC_LS = MKBETAG('S','O','N','L'),
491 AV_CODEC_ID_PAF_AUDIO = MKBETAG('P','A','F','A'),
492 AV_CODEC_ID_OPUS = MKBETAG('O','P','U','S'),
493 AV_CODEC_ID_TAK = MKBETAG('t','B','a','K'),
494 AV_CODEC_ID_EVRC = MKBETAG('s','e','v','c'),
495 AV_CODEC_ID_SMV = MKBETAG('s','s','m','v'),
496 AV_CODEC_ID_DSD_LSBF = MKBETAG('D','S','D','L'),
497 AV_CODEC_ID_DSD_MSBF = MKBETAG('D','S','D','M'),
498 AV_CODEC_ID_DSD_LSBF_PLANAR = MKBETAG('D','S','D','1'),
499 AV_CODEC_ID_DSD_MSBF_PLANAR = MKBETAG('D','S','D','8'),
501 /* subtitle codecs */
502 AV_CODEC_ID_FIRST_SUBTITLE = 0x17000, ///< A dummy ID pointing at the start of subtitle codecs.
503 AV_CODEC_ID_DVD_SUBTITLE = 0x17000,
504 AV_CODEC_ID_DVB_SUBTITLE,
505 AV_CODEC_ID_TEXT, ///< raw UTF-8 text
508 AV_CODEC_ID_MOV_TEXT,
509 AV_CODEC_ID_HDMV_PGS_SUBTITLE,
510 AV_CODEC_ID_DVB_TELETEXT,
512 AV_CODEC_ID_MICRODVD = MKBETAG('m','D','V','D'),
513 AV_CODEC_ID_EIA_608 = MKBETAG('c','6','0','8'),
514 AV_CODEC_ID_JACOSUB = MKBETAG('J','S','U','B'),
515 AV_CODEC_ID_SAMI = MKBETAG('S','A','M','I'),
516 AV_CODEC_ID_REALTEXT = MKBETAG('R','T','X','T'),
517 AV_CODEC_ID_SUBVIEWER1 = MKBETAG('S','b','V','1'),
518 AV_CODEC_ID_SUBVIEWER = MKBETAG('S','u','b','V'),
519 AV_CODEC_ID_SUBRIP = MKBETAG('S','R','i','p'),
520 AV_CODEC_ID_WEBVTT = MKBETAG('W','V','T','T'),
521 AV_CODEC_ID_MPL2 = MKBETAG('M','P','L','2'),
522 AV_CODEC_ID_VPLAYER = MKBETAG('V','P','l','r'),
523 AV_CODEC_ID_PJS = MKBETAG('P','h','J','S'),
524 AV_CODEC_ID_ASS = MKBETAG('A','S','S',' '), ///< ASS as defined in Matroska
526 /* other specific kind of codecs (generally used for attachments) */
527 AV_CODEC_ID_FIRST_UNKNOWN = 0x18000, ///< A dummy ID pointing at the start of various fake codecs.
528 AV_CODEC_ID_TTF = 0x18000,
529 AV_CODEC_ID_BINTEXT = MKBETAG('B','T','X','T'),
530 AV_CODEC_ID_XBIN = MKBETAG('X','B','I','N'),
531 AV_CODEC_ID_IDF = MKBETAG( 0 ,'I','D','F'),
532 AV_CODEC_ID_OTF = MKBETAG( 0 ,'O','T','F'),
533 AV_CODEC_ID_SMPTE_KLV = MKBETAG('K','L','V','A'),
534 AV_CODEC_ID_DVD_NAV = MKBETAG('D','N','A','V'),
535 AV_CODEC_ID_TIMED_ID3 = MKBETAG('T','I','D','3'),
536 AV_CODEC_ID_BIN_DATA = MKBETAG('D','A','T','A'),
539 AV_CODEC_ID_PROBE = 0x19000, ///< codec_id is not known (like AV_CODEC_ID_NONE) but lavf should attempt to identify it
541 AV_CODEC_ID_MPEG2TS = 0x20000, /**< _FAKE_ codec to indicate a raw MPEG-2 TS
542 * stream (only used by libavformat) */
543 AV_CODEC_ID_MPEG4SYSTEMS = 0x20001, /**< _FAKE_ codec to indicate a MPEG-4 Systems
544 * stream (only used by libavformat) */
545 AV_CODEC_ID_FFMETADATA = 0x21000, ///< Dummy codec for streams containing only metadata information.
548 #include "old_codec_ids.h"
553 * This struct describes the properties of a single codec described by an
555 * @see avcodec_get_descriptor()
557 typedef struct AVCodecDescriptor {
559 enum AVMediaType type;
561 * Name of the codec described by this descriptor. It is non-empty and
562 * unique for each codec descriptor. It should contain alphanumeric
563 * characters and '_' only.
567 * A more descriptive name for this codec. May be NULL.
569 const char *long_name;
571 * Codec properties, a combination of AV_CODEC_PROP_* flags.
576 * MIME type(s) associated with the codec.
577 * May be NULL; if not, a NULL-terminated array of MIME types.
578 * The first item is always non-NULL and is the prefered MIME type.
580 const char *const *mime_types;
584 * Codec uses only intra compression.
587 #define AV_CODEC_PROP_INTRA_ONLY (1 << 0)
589 * Codec supports lossy compression. Audio and video codecs only.
590 * @note a codec may support both lossy and lossless
593 #define AV_CODEC_PROP_LOSSY (1 << 1)
595 * Codec supports lossless compression. Audio and video codecs only.
597 #define AV_CODEC_PROP_LOSSLESS (1 << 2)
599 * Subtitle codec is bitmap based
600 * Decoded AVSubtitle data can be read from the AVSubtitleRect->pict field.
602 #define AV_CODEC_PROP_BITMAP_SUB (1 << 16)
604 * Subtitle codec is text based.
605 * Decoded AVSubtitle data can be read from the AVSubtitleRect->ass field.
607 #define AV_CODEC_PROP_TEXT_SUB (1 << 17)
610 * @ingroup lavc_decoding
611 * Required number of additionally allocated bytes at the end of the input bitstream for decoding.
612 * This is mainly needed because some optimized bitstream readers read
613 * 32 or 64 bit at once and could read over the end.<br>
614 * Note: If the first 23 bits of the additional bytes are not 0, then damaged
615 * MPEG bitstreams could cause overread and segfault.
617 #define FF_INPUT_BUFFER_PADDING_SIZE 16
620 * @ingroup lavc_encoding
621 * minimum encoding buffer size
622 * Used to avoid some checks during header writing.
624 #define FF_MIN_BUFFER_SIZE 16384
628 * @ingroup lavc_encoding
629 * motion estimation type.
632 ME_ZERO = 1, ///< no search, that is use 0,0 vector whenever one is needed
636 ME_EPZS, ///< enhanced predictive zonal search
637 ME_X1, ///< reserved for experiments
638 ME_HEX, ///< hexagon based search
639 ME_UMH, ///< uneven multi-hexagon search
640 ME_TESA, ///< transformed exhaustive search algorithm
641 ME_ITER=50, ///< iterative search
645 * @ingroup lavc_decoding
648 /* We leave some space between them for extensions (drop some
649 * keyframes for intra-only or drop just some bidir frames). */
650 AVDISCARD_NONE =-16, ///< discard nothing
651 AVDISCARD_DEFAULT = 0, ///< discard useless packets like 0 size packets in avi
652 AVDISCARD_NONREF = 8, ///< discard all non reference
653 AVDISCARD_BIDIR = 16, ///< discard all bidirectional frames
654 AVDISCARD_NONKEY = 32, ///< discard all frames except keyframes
655 AVDISCARD_ALL = 48, ///< discard all
658 enum AVColorPrimaries{
659 AVCOL_PRI_BT709 = 1, ///< also ITU-R BT1361 / IEC 61966-2-4 / SMPTE RP177 Annex B
660 AVCOL_PRI_UNSPECIFIED = 2,
661 AVCOL_PRI_BT470M = 4,
662 AVCOL_PRI_BT470BG = 5, ///< also ITU-R BT601-6 625 / ITU-R BT1358 625 / ITU-R BT1700 625 PAL & SECAM
663 AVCOL_PRI_SMPTE170M = 6, ///< also ITU-R BT601-6 525 / ITU-R BT1358 525 / ITU-R BT1700 NTSC
664 AVCOL_PRI_SMPTE240M = 7, ///< functionally identical to above
666 AVCOL_PRI_BT2020 = 9, ///< ITU-R BT2020
667 AVCOL_PRI_NB , ///< Not part of ABI
670 enum AVColorTransferCharacteristic{
671 AVCOL_TRC_BT709 = 1, ///< also ITU-R BT1361
672 AVCOL_TRC_UNSPECIFIED = 2,
673 AVCOL_TRC_GAMMA22 = 4, ///< also ITU-R BT470M / ITU-R BT1700 625 PAL & SECAM
674 AVCOL_TRC_GAMMA28 = 5, ///< also ITU-R BT470BG
675 AVCOL_TRC_SMPTE170M = 6, ///< also ITU-R BT601-6 525 or 625 / ITU-R BT1358 525 or 625 / ITU-R BT1700 NTSC
676 AVCOL_TRC_SMPTE240M = 7,
677 AVCOL_TRC_LINEAR = 8, ///< "Linear transfer characteristics"
678 AVCOL_TRC_LOG = 9, ///< "Logarithmic transfer characteristic (100:1 range)"
679 AVCOL_TRC_LOG_SQRT = 10, ///< "Logarithmic transfer characteristic (100 * Sqrt( 10 ) : 1 range)"
680 AVCOL_TRC_IEC61966_2_4 = 11, ///< IEC 61966-2-4
681 AVCOL_TRC_BT1361_ECG = 12, ///< ITU-R BT1361 Extended Colour Gamut
682 AVCOL_TRC_IEC61966_2_1 = 13, ///< IEC 61966-2-1 (sRGB or sYCC)
683 AVCOL_TRC_BT2020_10 = 14, ///< ITU-R BT2020 for 10 bit system
684 AVCOL_TRC_BT2020_12 = 15, ///< ITU-R BT2020 for 12 bit system
685 AVCOL_TRC_NB , ///< Not part of ABI
689 * X X 3 4 X X are luma samples,
690 * 1 2 1-6 are possible chroma positions
691 * X X 5 6 X 0 is undefined/unknown position
693 enum AVChromaLocation{
694 AVCHROMA_LOC_UNSPECIFIED = 0,
695 AVCHROMA_LOC_LEFT = 1, ///< mpeg2/4, h264 default
696 AVCHROMA_LOC_CENTER = 2, ///< mpeg1, jpeg, h263
697 AVCHROMA_LOC_TOPLEFT = 3, ///< DV
698 AVCHROMA_LOC_TOP = 4,
699 AVCHROMA_LOC_BOTTOMLEFT = 5,
700 AVCHROMA_LOC_BOTTOM = 6,
701 AVCHROMA_LOC_NB , ///< Not part of ABI
704 enum AVAudioServiceType {
705 AV_AUDIO_SERVICE_TYPE_MAIN = 0,
706 AV_AUDIO_SERVICE_TYPE_EFFECTS = 1,
707 AV_AUDIO_SERVICE_TYPE_VISUALLY_IMPAIRED = 2,
708 AV_AUDIO_SERVICE_TYPE_HEARING_IMPAIRED = 3,
709 AV_AUDIO_SERVICE_TYPE_DIALOGUE = 4,
710 AV_AUDIO_SERVICE_TYPE_COMMENTARY = 5,
711 AV_AUDIO_SERVICE_TYPE_EMERGENCY = 6,
712 AV_AUDIO_SERVICE_TYPE_VOICE_OVER = 7,
713 AV_AUDIO_SERVICE_TYPE_KARAOKE = 8,
714 AV_AUDIO_SERVICE_TYPE_NB , ///< Not part of ABI
718 * @ingroup lavc_encoding
720 typedef struct RcOverride{
723 int qscale; // If this is 0 then quality_factor will be used instead.
724 float quality_factor;
727 #if FF_API_MAX_BFRAMES
729 * @deprecated there is no libavcodec-wide limit on the number of B-frames
731 #define FF_MAX_B_FRAMES 16
735 These flags can be passed in AVCodecContext.flags before initialization.
736 Note: Not everything is supported yet.
740 * Allow decoders to produce frames with data planes that are not aligned
741 * to CPU requirements (e.g. due to cropping).
743 #define CODEC_FLAG_UNALIGNED 0x0001
744 #define CODEC_FLAG_QSCALE 0x0002 ///< Use fixed qscale.
745 #define CODEC_FLAG_4MV 0x0004 ///< 4 MV per MB allowed / advanced prediction for H.263.
746 #define CODEC_FLAG_OUTPUT_CORRUPT 0x0008 ///< Output even those frames that might be corrupted
747 #define CODEC_FLAG_QPEL 0x0010 ///< Use qpel MC.
748 #define CODEC_FLAG_GMC 0x0020 ///< Use GMC.
749 #define CODEC_FLAG_MV0 0x0040 ///< Always try a MB with MV=<0,0>.
750 #if FF_API_INPUT_PRESERVED
752 * @deprecated passing reference-counted frames to the encoders replaces this
755 #define CODEC_FLAG_INPUT_PRESERVED 0x0100
757 #define CODEC_FLAG_PASS1 0x0200 ///< Use internal 2pass ratecontrol in first pass mode.
758 #define CODEC_FLAG_PASS2 0x0400 ///< Use internal 2pass ratecontrol in second pass mode.
759 #define CODEC_FLAG_GRAY 0x2000 ///< Only decode/encode grayscale.
762 * @deprecated edges are not used/required anymore. I.e. this flag is now always
765 #define CODEC_FLAG_EMU_EDGE 0x4000
767 #define CODEC_FLAG_PSNR 0x8000 ///< error[?] variables will be set during encoding.
768 #define CODEC_FLAG_TRUNCATED 0x00010000 /** Input bitstream might be truncated at a random
769 location instead of only at frame boundaries. */
770 #if FF_API_NORMALIZE_AQP
772 * @deprecated use the flag "naq" in the "mpv_flags" private option of the
775 #define CODEC_FLAG_NORMALIZE_AQP 0x00020000
777 #define CODEC_FLAG_INTERLACED_DCT 0x00040000 ///< Use interlaced DCT.
778 #define CODEC_FLAG_LOW_DELAY 0x00080000 ///< Force low delay.
779 #define CODEC_FLAG_GLOBAL_HEADER 0x00400000 ///< Place global headers in extradata instead of every keyframe.
780 #define CODEC_FLAG_BITEXACT 0x00800000 ///< Use only bitexact stuff (except (I)DCT).
781 /* Fx : Flag for h263+ extra options */
782 #define CODEC_FLAG_AC_PRED 0x01000000 ///< H.263 advanced intra coding / MPEG-4 AC prediction
783 #define CODEC_FLAG_LOOP_FILTER 0x00000800 ///< loop filter
784 #define CODEC_FLAG_INTERLACED_ME 0x20000000 ///< interlaced motion estimation
785 #define CODEC_FLAG_CLOSED_GOP 0x80000000
786 #define CODEC_FLAG2_FAST 0x00000001 ///< Allow non spec compliant speedup tricks.
787 #define CODEC_FLAG2_NO_OUTPUT 0x00000004 ///< Skip bitstream encoding.
788 #define CODEC_FLAG2_LOCAL_HEADER 0x00000008 ///< Place global headers at every keyframe instead of in extradata.
789 #define CODEC_FLAG2_DROP_FRAME_TIMECODE 0x00002000 ///< timecode is in drop frame format. DEPRECATED!!!!
790 #define CODEC_FLAG2_IGNORE_CROP 0x00010000 ///< Discard cropping information from SPS.
792 #define CODEC_FLAG2_CHUNKS 0x00008000 ///< Input bitstream might be truncated at a packet boundaries instead of only at frame boundaries.
793 #define CODEC_FLAG2_SHOW_ALL 0x00400000 ///< Show all frames before the first keyframe
795 /* Unsupported options :
796 * Syntax Arithmetic coding (SAC)
797 * Reference Picture Selection
798 * Independent Segment Decoding */
800 /* codec capabilities */
802 #define CODEC_CAP_DRAW_HORIZ_BAND 0x0001 ///< Decoder can use draw_horiz_band callback.
804 * Codec uses get_buffer() for allocating buffers and supports custom allocators.
805 * If not set, it might not use get_buffer() at all or use operations that
806 * assume the buffer was allocated by avcodec_default_get_buffer.
808 #define CODEC_CAP_DR1 0x0002
809 #define CODEC_CAP_TRUNCATED 0x0008
811 /* Codec can export data for HW decoding. This flag indicates that
812 * the codec would call get_format() with list that might contain HW accelerated
813 * pixel formats (XvMC, VDPAU, VAAPI, etc). The application can pick any of them
814 * including raw image format.
815 * The application can use the passed context to determine bitstream version,
816 * chroma format, resolution etc.
818 #define CODEC_CAP_HWACCEL 0x0010
819 #endif /* FF_API_XVMC */
821 * Encoder or decoder requires flushing with NULL input at the end in order to
822 * give the complete and correct output.
824 * NOTE: If this flag is not set, the codec is guaranteed to never be fed with
825 * with NULL data. The user can still send NULL data to the public encode
826 * or decode function, but libavcodec will not pass it along to the codec
827 * unless this flag is set.
830 * The decoder has a non-zero delay and needs to be fed with avpkt->data=NULL,
831 * avpkt->size=0 at the end to get the delayed data until the decoder no longer
835 * The encoder needs to be fed with NULL data at the end of encoding until the
836 * encoder no longer returns data.
838 * NOTE: For encoders implementing the AVCodec.encode2() function, setting this
839 * flag also means that the encoder must set the pts and duration for
840 * each output packet. If this flag is not set, the pts and duration will
841 * be determined by libavcodec from the input frame.
843 #define CODEC_CAP_DELAY 0x0020
845 * Codec can be fed a final frame with a smaller size.
846 * This can be used to prevent truncation of the last audio samples.
848 #define CODEC_CAP_SMALL_LAST_FRAME 0x0040
851 * Codec can export data for HW decoding (VDPAU).
853 #define CODEC_CAP_HWACCEL_VDPAU 0x0080
856 * Codec can output multiple frames per AVPacket
857 * Normally demuxers return one frame at a time, demuxers which do not do
858 * are connected to a parser to split what they return into proper frames.
859 * This flag is reserved to the very rare category of codecs which have a
860 * bitstream that cannot be split into frames without timeconsuming
861 * operations like full decoding. Demuxers carring such bitstreams thus
862 * may return multiple frames in a packet. This has many disadvantages like
863 * prohibiting stream copy in many cases thus it should only be considered
866 #define CODEC_CAP_SUBFRAMES 0x0100
868 * Codec is experimental and is thus avoided in favor of non experimental
871 #define CODEC_CAP_EXPERIMENTAL 0x0200
873 * Codec should fill in channel configuration and samplerate instead of container
875 #define CODEC_CAP_CHANNEL_CONF 0x0400
876 #if FF_API_NEG_LINESIZES
878 * @deprecated no codecs use this capability
880 #define CODEC_CAP_NEG_LINESIZES 0x0800
883 * Codec supports frame-level multithreading.
885 #define CODEC_CAP_FRAME_THREADS 0x1000
887 * Codec supports slice-based (or partition-based) multithreading.
889 #define CODEC_CAP_SLICE_THREADS 0x2000
891 * Codec supports changed parameters at any point.
893 #define CODEC_CAP_PARAM_CHANGE 0x4000
895 * Codec supports avctx->thread_count == 0 (auto).
897 #define CODEC_CAP_AUTO_THREADS 0x8000
899 * Audio encoder supports receiving a different number of samples in each call.
901 #define CODEC_CAP_VARIABLE_FRAME_SIZE 0x10000
903 * Codec is intra only.
905 #define CODEC_CAP_INTRA_ONLY 0x40000000
909 #define CODEC_CAP_LOSSLESS 0x80000000
912 //The following defines may change, don't expect compatibility if you use them.
913 #define MB_TYPE_INTRA4x4 0x0001
914 #define MB_TYPE_INTRA16x16 0x0002 //FIXME H.264-specific
915 #define MB_TYPE_INTRA_PCM 0x0004 //FIXME H.264-specific
916 #define MB_TYPE_16x16 0x0008
917 #define MB_TYPE_16x8 0x0010
918 #define MB_TYPE_8x16 0x0020
919 #define MB_TYPE_8x8 0x0040
920 #define MB_TYPE_INTERLACED 0x0080
921 #define MB_TYPE_DIRECT2 0x0100 //FIXME
922 #define MB_TYPE_ACPRED 0x0200
923 #define MB_TYPE_GMC 0x0400
924 #define MB_TYPE_SKIP 0x0800
925 #define MB_TYPE_P0L0 0x1000
926 #define MB_TYPE_P1L0 0x2000
927 #define MB_TYPE_P0L1 0x4000
928 #define MB_TYPE_P1L1 0x8000
929 #define MB_TYPE_L0 (MB_TYPE_P0L0 | MB_TYPE_P1L0)
930 #define MB_TYPE_L1 (MB_TYPE_P0L1 | MB_TYPE_P1L1)
931 #define MB_TYPE_L0L1 (MB_TYPE_L0 | MB_TYPE_L1)
932 #define MB_TYPE_QUANT 0x00010000
933 #define MB_TYPE_CBP 0x00020000
934 //Note bits 24-31 are reserved for codec specific use (h264 ref0, mpeg1 0mv, ...)
939 * This specifies the area which should be displayed.
940 * Note there may be multiple such areas for one frame.
942 typedef struct AVPanScan{
945 * - encoding: Set by user.
946 * - decoding: Set by libavcodec.
951 * width and height in 1/16 pel
952 * - encoding: Set by user.
953 * - decoding: Set by libavcodec.
959 * position of the top left corner in 1/16 pel for up to 3 fields/frames
960 * - encoding: Set by user.
961 * - decoding: Set by libavcodec.
963 int16_t position[3][2];
966 #if FF_API_QSCALE_TYPE
967 #define FF_QSCALE_TYPE_MPEG1 0
968 #define FF_QSCALE_TYPE_MPEG2 1
969 #define FF_QSCALE_TYPE_H264 2
970 #define FF_QSCALE_TYPE_VP56 3
973 #if FF_API_GET_BUFFER
974 #define FF_BUFFER_TYPE_INTERNAL 1
975 #define FF_BUFFER_TYPE_USER 2 ///< direct rendering buffers (image is (de)allocated by user)
976 #define FF_BUFFER_TYPE_SHARED 4 ///< Buffer from somewhere else; don't deallocate image (data/base), all other tables are not shared.
977 #define FF_BUFFER_TYPE_COPY 8 ///< Just a (modified) copy of some other buffer, don't deallocate anything.
979 #define FF_BUFFER_HINTS_VALID 0x01 // Buffer hints value is meaningful (if 0 ignore).
980 #define FF_BUFFER_HINTS_READABLE 0x02 // Codec will read from buffer.
981 #define FF_BUFFER_HINTS_PRESERVE 0x04 // User must not alter buffer content.
982 #define FF_BUFFER_HINTS_REUSABLE 0x08 // Codec will reuse the buffer (update).
986 * The decoder will keep a reference to the frame and may reuse it later.
988 #define AV_GET_BUFFER_FLAG_REF (1 << 0)
991 * @defgroup lavc_packet AVPacket
993 * Types and functions for working with AVPacket.
996 enum AVPacketSideDataType {
998 AV_PKT_DATA_NEW_EXTRADATA,
1001 * An AV_PKT_DATA_PARAM_CHANGE side data packet is laid out as follows:
1004 * if (param_flags & AV_SIDE_DATA_PARAM_CHANGE_CHANNEL_COUNT)
1005 * s32le channel_count
1006 * if (param_flags & AV_SIDE_DATA_PARAM_CHANGE_CHANNEL_LAYOUT)
1007 * u64le channel_layout
1008 * if (param_flags & AV_SIDE_DATA_PARAM_CHANGE_SAMPLE_RATE)
1010 * if (param_flags & AV_SIDE_DATA_PARAM_CHANGE_DIMENSIONS)
1015 AV_PKT_DATA_PARAM_CHANGE,
1018 * An AV_PKT_DATA_H263_MB_INFO side data packet contains a number of
1019 * structures with info about macroblocks relevant to splitting the
1020 * packet into smaller packets on macroblock edges (e.g. as for RFC 2190).
1021 * That is, it does not necessarily contain info about all macroblocks,
1022 * as long as the distance between macroblocks in the info is smaller
1023 * than the target payload size.
1024 * Each MB info structure is 12 bytes, and is laid out as follows:
1026 * u32le bit offset from the start of the packet
1027 * u8 current quantizer at the start of the macroblock
1029 * u16le macroblock address within the GOB
1030 * u8 horizontal MV predictor
1031 * u8 vertical MV predictor
1032 * u8 horizontal MV predictor for block number 3
1033 * u8 vertical MV predictor for block number 3
1036 AV_PKT_DATA_H263_MB_INFO,
1039 * This side data should be associated with an audio stream and contains
1040 * ReplayGain information in form of the AVReplayGain struct.
1042 AV_PKT_DATA_REPLAYGAIN,
1045 * Recommmends skipping the specified number of samples
1047 * u32le number of samples to skip from start of this packet
1048 * u32le number of samples to skip from end of this packet
1049 * u8 reason for start skip
1050 * u8 reason for end skip (0=padding silence, 1=convergence)
1053 AV_PKT_DATA_SKIP_SAMPLES=70,
1056 * An AV_PKT_DATA_JP_DUALMONO side data packet indicates that
1057 * the packet may contain "dual mono" audio specific to Japanese DTV
1058 * and if it is true, recommends only the selected channel to be used.
1060 * u8 selected channels (0=mail/left, 1=sub/right, 2=both)
1063 AV_PKT_DATA_JP_DUALMONO,
1066 * A list of zero terminated key/value strings. There is no end marker for
1067 * the list, so it is required to rely on the side data size to stop.
1069 AV_PKT_DATA_STRINGS_METADATA,
1072 * Subtitle event position
1080 AV_PKT_DATA_SUBTITLE_POSITION,
1083 * Data found in BlockAdditional element of matroska container. There is
1084 * no end marker for the data, so it is required to rely on the side data
1085 * size to recognize the end. 8 byte id (as found in BlockAddId) followed
1088 AV_PKT_DATA_MATROSKA_BLOCKADDITIONAL,
1091 * The optional first identifier line of a WebVTT cue.
1093 AV_PKT_DATA_WEBVTT_IDENTIFIER,
1096 * The optional settings (rendering instructions) that immediately
1097 * follow the timestamp specifier of a WebVTT cue.
1099 AV_PKT_DATA_WEBVTT_SETTINGS,
1102 * A list of zero terminated key/value strings. There is no end marker for
1103 * the list, so it is required to rely on the side data size to stop. This
1104 * side data includes updated metadata which appeared in the stream.
1106 AV_PKT_DATA_METADATA_UPDATE,
1109 typedef struct AVPacketSideData {
1112 enum AVPacketSideDataType type;
1116 * This structure stores compressed data. It is typically exported by demuxers
1117 * and then passed as input to decoders, or received as output from encoders and
1118 * then passed to muxers.
1120 * For video, it should typically contain one compressed frame. For audio it may
1121 * contain several compressed frames.
1123 * AVPacket is one of the few structs in FFmpeg, whose size is a part of public
1124 * ABI. Thus it may be allocated on stack and no new fields can be added to it
1125 * without libavcodec and libavformat major bump.
1127 * The semantics of data ownership depends on the buf or destruct (deprecated)
1128 * fields. If either is set, the packet data is dynamically allocated and is
1129 * valid indefinitely until av_free_packet() is called (which in turn calls
1130 * av_buffer_unref()/the destruct callback to free the data). If neither is set,
1131 * the packet data is typically backed by some static buffer somewhere and is
1132 * only valid for a limited time (e.g. until the next read call when demuxing).
1134 * The side data is always allocated with av_malloc() and is freed in
1137 typedef struct AVPacket {
1139 * A reference to the reference-counted buffer where the packet data is
1141 * May be NULL, then the packet data is not reference-counted.
1145 * Presentation timestamp in AVStream->time_base units; the time at which
1146 * the decompressed packet will be presented to the user.
1147 * Can be AV_NOPTS_VALUE if it is not stored in the file.
1148 * pts MUST be larger or equal to dts as presentation cannot happen before
1149 * decompression, unless one wants to view hex dumps. Some formats misuse
1150 * the terms dts and pts/cts to mean something different. Such timestamps
1151 * must be converted to true pts/dts before they are stored in AVPacket.
1155 * Decompression timestamp in AVStream->time_base units; the time at which
1156 * the packet is decompressed.
1157 * Can be AV_NOPTS_VALUE if it is not stored in the file.
1164 * A combination of AV_PKT_FLAG values
1168 * Additional packet data that can be provided by the container.
1169 * Packet can contain several types of side information.
1171 AVPacketSideData *side_data;
1172 int side_data_elems;
1175 * Duration of this packet in AVStream->time_base units, 0 if unknown.
1176 * Equals next_pts - this_pts in presentation order.
1179 #if FF_API_DESTRUCT_PACKET
1180 attribute_deprecated
1181 void (*destruct)(struct AVPacket *);
1182 attribute_deprecated
1185 int64_t pos; ///< byte position in stream, -1 if unknown
1188 * Time difference in AVStream->time_base units from the pts of this
1189 * packet to the point at which the output from the decoder has converged
1190 * independent from the availability of previous frames. That is, the
1191 * frames are virtually identical no matter if decoding started from
1192 * the very first frame or from this keyframe.
1193 * Is AV_NOPTS_VALUE if unknown.
1194 * This field is not the display duration of the current packet.
1195 * This field has no meaning if the packet does not have AV_PKT_FLAG_KEY
1198 * The purpose of this field is to allow seeking in streams that have no
1199 * keyframes in the conventional sense. It corresponds to the
1200 * recovery point SEI in H.264 and match_time_delta in NUT. It is also
1201 * essential for some types of subtitle streams to ensure that all
1202 * subtitles are correctly displayed after seeking.
1204 int64_t convergence_duration;
1206 #define AV_PKT_FLAG_KEY 0x0001 ///< The packet contains a keyframe
1207 #define AV_PKT_FLAG_CORRUPT 0x0002 ///< The packet content is corrupted
1209 enum AVSideDataParamChangeFlags {
1210 AV_SIDE_DATA_PARAM_CHANGE_CHANNEL_COUNT = 0x0001,
1211 AV_SIDE_DATA_PARAM_CHANGE_CHANNEL_LAYOUT = 0x0002,
1212 AV_SIDE_DATA_PARAM_CHANGE_SAMPLE_RATE = 0x0004,
1213 AV_SIDE_DATA_PARAM_CHANGE_DIMENSIONS = 0x0008,
1219 struct AVCodecInternal;
1223 AV_FIELD_PROGRESSIVE,
1224 AV_FIELD_TT, //< Top coded_first, top displayed first
1225 AV_FIELD_BB, //< Bottom coded first, bottom displayed first
1226 AV_FIELD_TB, //< Top coded first, bottom displayed first
1227 AV_FIELD_BT, //< Bottom coded first, top displayed first
1231 * main external API structure.
1232 * New fields can be added to the end with minor version bumps.
1233 * Removal, reordering and changes to existing fields require a major
1235 * Please use AVOptions (av_opt* / av_set/get*()) to access these fields from user
1237 * sizeof(AVCodecContext) must not be used outside libav*.
1239 typedef struct AVCodecContext {
1241 * information on struct for av_log
1242 * - set by avcodec_alloc_context3
1244 const AVClass *av_class;
1245 int log_level_offset;
1247 enum AVMediaType codec_type; /* see AVMEDIA_TYPE_xxx */
1248 const struct AVCodec *codec;
1249 char codec_name[32];
1250 enum AVCodecID codec_id; /* see AV_CODEC_ID_xxx */
1253 * fourcc (LSB first, so "ABCD" -> ('D'<<24) + ('C'<<16) + ('B'<<8) + 'A').
1254 * This is used to work around some encoder bugs.
1255 * A demuxer should set this to what is stored in the field used to identify the codec.
1256 * If there are multiple such fields in a container then the demuxer should choose the one
1257 * which maximizes the information about the used codec.
1258 * If the codec tag field in a container is larger than 32 bits then the demuxer should
1259 * remap the longer ID to 32 bits with a table or other structure. Alternatively a new
1260 * extra_codec_tag + size could be added but for this a clear advantage must be demonstrated
1262 * - encoding: Set by user, if not then the default based on codec_id will be used.
1263 * - decoding: Set by user, will be converted to uppercase by libavcodec during init.
1265 unsigned int codec_tag;
1268 * fourcc from the AVI stream header (LSB first, so "ABCD" -> ('D'<<24) + ('C'<<16) + ('B'<<8) + 'A').
1269 * This is used to work around some encoder bugs.
1270 * - encoding: unused
1271 * - decoding: Set by user, will be converted to uppercase by libavcodec during init.
1273 unsigned int stream_codec_tag;
1278 * Private context used for internal data.
1280 * Unlike priv_data, this is not codec-specific. It is used in general
1281 * libavcodec functions.
1283 struct AVCodecInternal *internal;
1286 * Private data of the user, can be used to carry app specific stuff.
1287 * - encoding: Set by user.
1288 * - decoding: Set by user.
1293 * the average bitrate
1294 * - encoding: Set by user; unused for constant quantizer encoding.
1295 * - decoding: Set by libavcodec. 0 or some bitrate if this info is available in the stream.
1300 * number of bits the bitstream is allowed to diverge from the reference.
1301 * the reference can be CBR (for CBR pass1) or VBR (for pass2)
1302 * - encoding: Set by user; unused for constant quantizer encoding.
1303 * - decoding: unused
1305 int bit_rate_tolerance;
1308 * Global quality for codecs which cannot change it per frame.
1309 * This should be proportional to MPEG-1/2/4 qscale.
1310 * - encoding: Set by user.
1311 * - decoding: unused
1316 * - encoding: Set by user.
1317 * - decoding: unused
1319 int compression_level;
1320 #define FF_COMPRESSION_DEFAULT -1
1324 * - encoding: Set by user.
1325 * - decoding: Set by user.
1331 * - encoding: Set by user.
1332 * - decoding: Set by user.
1337 * some codecs need / can use extradata like Huffman tables.
1338 * mjpeg: Huffman tables
1339 * rv10: additional flags
1340 * mpeg4: global headers (they can be in the bitstream or here)
1341 * The allocated memory should be FF_INPUT_BUFFER_PADDING_SIZE bytes larger
1342 * than extradata_size to avoid problems if it is read with the bitstream reader.
1343 * The bytewise contents of extradata must not depend on the architecture or CPU endianness.
1344 * - encoding: Set/allocated/freed by libavcodec.
1345 * - decoding: Set/allocated/freed by user.
1351 * This is the fundamental unit of time (in seconds) in terms
1352 * of which frame timestamps are represented. For fixed-fps content,
1353 * timebase should be 1/framerate and timestamp increments should be
1355 * - encoding: MUST be set by user.
1356 * - decoding: Set by libavcodec.
1358 AVRational time_base;
1361 * For some codecs, the time base is closer to the field rate than the frame rate.
1362 * Most notably, H.264 and MPEG-2 specify time_base as half of frame duration
1363 * if no telecine is used ...
1365 * Set to time_base ticks per frame. Default 1, e.g., H.264/MPEG-2 set it to 2.
1367 int ticks_per_frame;
1372 * Encoding: Number of frames delay there will be from the encoder input to
1373 * the decoder output. (we assume the decoder matches the spec)
1374 * Decoding: Number of frames delay in addition to what a standard decoder
1375 * as specified in the spec would produce.
1378 * Number of frames the decoded output will be delayed relative to the
1382 * For encoding, this is the number of "priming" samples added by the
1383 * encoder to the beginning of the stream. The decoded output will be
1384 * delayed by this many samples relative to the input to the encoder (or
1385 * more, if the decoder adds its own padding).
1386 * The timestamps on the output packets are adjusted by the encoder so
1387 * that they always refer to the first sample of the data actually
1388 * contained in the packet, including any added padding.
1389 * E.g. if the timebase is 1/samplerate and the timestamp of the first
1390 * input sample is 0, the timestamp of the first output packet will be
1393 * For decoding, this is the number of samples the decoder needs to
1394 * output before the decoder's output is valid. When seeking, you should
1395 * start decoding this many samples prior to your desired seek point.
1397 * - encoding: Set by libavcodec.
1398 * - decoding: Set by libavcodec.
1405 * picture width / height.
1406 * - encoding: MUST be set by user.
1407 * - decoding: May be set by the user before opening the decoder if known e.g.
1408 * from the container. Some decoders will require the dimensions
1409 * to be set by the caller. During decoding, the decoder may
1410 * overwrite those values as required.
1415 * Bitstream width / height, may be different from width/height e.g. when
1416 * the decoded frame is cropped before being output or lowres is enabled.
1417 * - encoding: unused
1418 * - decoding: May be set by the user before opening the decoder if known
1419 * e.g. from the container. During decoding, the decoder may
1420 * overwrite those values as required.
1422 int coded_width, coded_height;
1424 #if FF_API_ASPECT_EXTENDED
1425 #define FF_ASPECT_EXTENDED 15
1429 * the number of pictures in a group of pictures, or 0 for intra_only
1430 * - encoding: Set by user.
1431 * - decoding: unused
1436 * Pixel format, see AV_PIX_FMT_xxx.
1437 * May be set by the demuxer if known from headers.
1438 * May be overridden by the decoder if it knows better.
1439 * - encoding: Set by user.
1440 * - decoding: Set by user if known, overridden by libavcodec if known
1442 enum AVPixelFormat pix_fmt;
1445 * Motion estimation algorithm used for video coding.
1446 * 1 (zero), 2 (full), 3 (log), 4 (phods), 5 (epzs), 6 (x1), 7 (hex),
1447 * 8 (umh), 9 (iter), 10 (tesa) [7, 8, 10 are x264 specific, 9 is snow specific]
1448 * - encoding: MUST be set by user.
1449 * - decoding: unused
1454 * If non NULL, 'draw_horiz_band' is called by the libavcodec
1455 * decoder to draw a horizontal band. It improves cache usage. Not
1456 * all codecs can do that. You must check the codec capabilities
1458 * When multithreading is used, it may be called from multiple threads
1459 * at the same time; threads might draw different parts of the same AVFrame,
1460 * or multiple AVFrames, and there is no guarantee that slices will be drawn
1462 * The function is also used by hardware acceleration APIs.
1463 * It is called at least once during frame decoding to pass
1464 * the data needed for hardware render.
1465 * In that mode instead of pixel data, AVFrame points to
1466 * a structure specific to the acceleration API. The application
1467 * reads the structure and can change some fields to indicate progress
1469 * - encoding: unused
1470 * - decoding: Set by user.
1471 * @param height the height of the slice
1472 * @param y the y position of the slice
1473 * @param type 1->top field, 2->bottom field, 3->frame
1474 * @param offset offset into the AVFrame.data from which the slice should be read
1476 void (*draw_horiz_band)(struct AVCodecContext *s,
1477 const AVFrame *src, int offset[AV_NUM_DATA_POINTERS],
1478 int y, int type, int height);
1481 * callback to negotiate the pixelFormat
1482 * @param fmt is the list of formats which are supported by the codec,
1483 * it is terminated by -1 as 0 is a valid format, the formats are ordered by quality.
1484 * The first is always the native one.
1485 * @return the chosen format
1486 * - encoding: unused
1487 * - decoding: Set by user, if not set the native format will be chosen.
1489 enum AVPixelFormat (*get_format)(struct AVCodecContext *s, const enum AVPixelFormat * fmt);
1492 * maximum number of B-frames between non-B-frames
1493 * Note: The output will be delayed by max_b_frames+1 relative to the input.
1494 * - encoding: Set by user.
1495 * - decoding: unused
1500 * qscale factor between IP and B-frames
1501 * If > 0 then the last P-frame quantizer will be used (q= lastp_q*factor+offset).
1502 * If < 0 then normal ratecontrol will be done (q= -normal_q*factor+offset).
1503 * - encoding: Set by user.
1504 * - decoding: unused
1506 float b_quant_factor;
1508 /** obsolete FIXME remove */
1510 #define FF_RC_STRATEGY_XVID 1
1512 int b_frame_strategy;
1515 * qscale offset between IP and B-frames
1516 * - encoding: Set by user.
1517 * - decoding: unused
1519 float b_quant_offset;
1522 * Size of the frame reordering buffer in the decoder.
1523 * For MPEG-2 it is 1 IPB or 0 low delay IP.
1524 * - encoding: Set by libavcodec.
1525 * - decoding: Set by libavcodec.
1530 * 0-> h263 quant 1-> mpeg quant
1531 * - encoding: Set by user.
1532 * - decoding: unused
1537 * qscale factor between P and I-frames
1538 * If > 0 then the last p frame quantizer will be used (q= lastp_q*factor+offset).
1539 * If < 0 then normal ratecontrol will be done (q= -normal_q*factor+offset).
1540 * - encoding: Set by user.
1541 * - decoding: unused
1543 float i_quant_factor;
1546 * qscale offset between P and I-frames
1547 * - encoding: Set by user.
1548 * - decoding: unused
1550 float i_quant_offset;
1553 * luminance masking (0-> disabled)
1554 * - encoding: Set by user.
1555 * - decoding: unused
1560 * temporary complexity masking (0-> disabled)
1561 * - encoding: Set by user.
1562 * - decoding: unused
1564 float temporal_cplx_masking;
1567 * spatial complexity masking (0-> disabled)
1568 * - encoding: Set by user.
1569 * - decoding: unused
1571 float spatial_cplx_masking;
1574 * p block masking (0-> disabled)
1575 * - encoding: Set by user.
1576 * - decoding: unused
1581 * darkness masking (0-> disabled)
1582 * - encoding: Set by user.
1583 * - decoding: unused
1589 * - encoding: Set by libavcodec.
1590 * - decoding: Set by user (or 0).
1594 * prediction method (needed for huffyuv)
1595 * - encoding: Set by user.
1596 * - decoding: unused
1598 int prediction_method;
1599 #define FF_PRED_LEFT 0
1600 #define FF_PRED_PLANE 1
1601 #define FF_PRED_MEDIAN 2
1604 * slice offsets in the frame in bytes
1605 * - encoding: Set/allocated by libavcodec.
1606 * - decoding: Set/allocated by user (or NULL).
1611 * sample aspect ratio (0 if unknown)
1612 * That is the width of a pixel divided by the height of the pixel.
1613 * Numerator and denominator must be relatively prime and smaller than 256 for some video standards.
1614 * - encoding: Set by user.
1615 * - decoding: Set by libavcodec.
1617 AVRational sample_aspect_ratio;
1620 * motion estimation comparison function
1621 * - encoding: Set by user.
1622 * - decoding: unused
1626 * subpixel motion estimation comparison function
1627 * - encoding: Set by user.
1628 * - decoding: unused
1632 * macroblock comparison function (not supported yet)
1633 * - encoding: Set by user.
1634 * - decoding: unused
1638 * interlaced DCT comparison function
1639 * - encoding: Set by user.
1640 * - decoding: unused
1643 #define FF_CMP_SAD 0
1644 #define FF_CMP_SSE 1
1645 #define FF_CMP_SATD 2
1646 #define FF_CMP_DCT 3
1647 #define FF_CMP_PSNR 4
1648 #define FF_CMP_BIT 5
1650 #define FF_CMP_ZERO 7
1651 #define FF_CMP_VSAD 8
1652 #define FF_CMP_VSSE 9
1653 #define FF_CMP_NSSE 10
1654 #define FF_CMP_W53 11
1655 #define FF_CMP_W97 12
1656 #define FF_CMP_DCTMAX 13
1657 #define FF_CMP_DCT264 14
1658 #define FF_CMP_CHROMA 256
1661 * ME diamond size & shape
1662 * - encoding: Set by user.
1663 * - decoding: unused
1668 * amount of previous MV predictors (2a+1 x 2a+1 square)
1669 * - encoding: Set by user.
1670 * - decoding: unused
1672 int last_predictor_count;
1675 * prepass for motion estimation
1676 * - encoding: Set by user.
1677 * - decoding: unused
1682 * motion estimation prepass comparison function
1683 * - encoding: Set by user.
1684 * - decoding: unused
1689 * ME prepass diamond size & shape
1690 * - encoding: Set by user.
1691 * - decoding: unused
1697 * - encoding: Set by user.
1698 * - decoding: unused
1700 int me_subpel_quality;
1703 * DTG active format information (additional aspect ratio
1704 * information only used in DVB MPEG-2 transport streams)
1707 * - encoding: unused
1708 * - decoding: Set by decoder.
1710 int dtg_active_format;
1711 #define FF_DTG_AFD_SAME 8
1712 #define FF_DTG_AFD_4_3 9
1713 #define FF_DTG_AFD_16_9 10
1714 #define FF_DTG_AFD_14_9 11
1715 #define FF_DTG_AFD_4_3_SP_14_9 13
1716 #define FF_DTG_AFD_16_9_SP_14_9 14
1717 #define FF_DTG_AFD_SP_4_3 15
1720 * maximum motion estimation search range in subpel units
1721 * If 0 then no limit.
1723 * - encoding: Set by user.
1724 * - decoding: unused
1729 * intra quantizer bias
1730 * - encoding: Set by user.
1731 * - decoding: unused
1733 int intra_quant_bias;
1734 #define FF_DEFAULT_QUANT_BIAS 999999
1737 * inter quantizer bias
1738 * - encoding: Set by user.
1739 * - decoding: unused
1741 int inter_quant_bias;
1745 * - encoding: unused
1746 * - decoding: Set by user.
1749 #define SLICE_FLAG_CODED_ORDER 0x0001 ///< draw_horiz_band() is called in coded order instead of display
1750 #define SLICE_FLAG_ALLOW_FIELD 0x0002 ///< allow draw_horiz_band() with field slices (MPEG2 field pics)
1751 #define SLICE_FLAG_ALLOW_PLANE 0x0004 ///< allow draw_horiz_band() with 1 component at a time (SVQ1)
1755 * XVideo Motion Acceleration
1756 * - encoding: forbidden
1757 * - decoding: set by decoder
1758 * @deprecated XvMC doesn't need it anymore.
1760 attribute_deprecated int xvmc_acceleration;
1761 #endif /* FF_API_XVMC */
1764 * macroblock decision mode
1765 * - encoding: Set by user.
1766 * - decoding: unused
1769 #define FF_MB_DECISION_SIMPLE 0 ///< uses mb_cmp
1770 #define FF_MB_DECISION_BITS 1 ///< chooses the one which needs the fewest bits
1771 #define FF_MB_DECISION_RD 2 ///< rate distortion
1774 * custom intra quantization matrix
1775 * - encoding: Set by user, can be NULL.
1776 * - decoding: Set by libavcodec.
1778 uint16_t *intra_matrix;
1781 * custom inter quantization matrix
1782 * - encoding: Set by user, can be NULL.
1783 * - decoding: Set by libavcodec.
1785 uint16_t *inter_matrix;
1788 * scene change detection threshold
1789 * 0 is default, larger means fewer detected scene changes.
1790 * - encoding: Set by user.
1791 * - decoding: unused
1793 int scenechange_threshold;
1796 * noise reduction strength
1797 * - encoding: Set by user.
1798 * - decoding: unused
1800 int noise_reduction;
1803 * Motion estimation threshold below which no motion estimation is
1804 * performed, but instead the user specified motion vectors are used.
1806 * - encoding: Set by user.
1807 * - decoding: unused
1812 * Macroblock threshold below which the user specified macroblock types will be used.
1813 * - encoding: Set by user.
1814 * - decoding: unused
1819 * precision of the intra DC coefficient - 8
1820 * - encoding: Set by user.
1821 * - decoding: unused
1823 int intra_dc_precision;
1826 * Number of macroblock rows at the top which are skipped.
1827 * - encoding: unused
1828 * - decoding: Set by user.
1833 * Number of macroblock rows at the bottom which are skipped.
1834 * - encoding: unused
1835 * - decoding: Set by user.
1840 * Border processing masking, raises the quantizer for mbs on the borders
1842 * - encoding: Set by user.
1843 * - decoding: unused
1845 float border_masking;
1848 * minimum MB lagrange multipler
1849 * - encoding: Set by user.
1850 * - decoding: unused
1855 * maximum MB lagrange multipler
1856 * - encoding: Set by user.
1857 * - decoding: unused
1863 * - encoding: Set by user.
1864 * - decoding: unused
1866 int me_penalty_compensation;
1870 * - encoding: Set by user.
1871 * - decoding: unused
1877 * - encoding: Set by user.
1878 * - decoding: unused
1884 * - encoding: Set by user.
1885 * - decoding: unused
1890 * number of reference frames
1891 * - encoding: Set by user.
1892 * - decoding: Set by lavc.
1897 * chroma qp offset from luma
1898 * - encoding: Set by user.
1899 * - decoding: unused
1904 * Multiplied by qscale for each frame and added to scene_change_score.
1905 * - encoding: Set by user.
1906 * - decoding: unused
1908 int scenechange_factor;
1912 * Note: Value depends upon the compare function used for fullpel ME.
1913 * - encoding: Set by user.
1914 * - decoding: unused
1919 * Adjust sensitivity of b_frame_strategy 1.
1920 * - encoding: Set by user.
1921 * - decoding: unused
1926 * Chromaticity coordinates of the source primaries.
1927 * - encoding: Set by user
1928 * - decoding: Set by libavcodec
1930 enum AVColorPrimaries color_primaries;
1933 * Color Transfer Characteristic.
1934 * - encoding: Set by user
1935 * - decoding: Set by libavcodec
1937 enum AVColorTransferCharacteristic color_trc;
1940 * YUV colorspace type.
1941 * - encoding: Set by user
1942 * - decoding: Set by libavcodec
1944 enum AVColorSpace colorspace;
1947 * MPEG vs JPEG YUV range.
1948 * - encoding: Set by user
1949 * - decoding: Set by libavcodec
1951 enum AVColorRange color_range;
1954 * This defines the location of chroma samples.
1955 * - encoding: Set by user
1956 * - decoding: Set by libavcodec
1958 enum AVChromaLocation chroma_sample_location;
1962 * Indicates number of picture subdivisions. Used for parallelized
1964 * - encoding: Set by user
1965 * - decoding: unused
1970 * - encoding: set by libavcodec
1971 * - decoding: Set by user.
1973 enum AVFieldOrder field_order;
1976 int sample_rate; ///< samples per second
1977 int channels; ///< number of audio channels
1980 * audio sample format
1981 * - encoding: Set by user.
1982 * - decoding: Set by libavcodec.
1984 enum AVSampleFormat sample_fmt; ///< sample format
1986 /* The following data should not be initialized. */
1988 * Number of samples per channel in an audio frame.
1990 * - encoding: set by libavcodec in avcodec_open2(). Each submitted frame
1991 * except the last must contain exactly frame_size samples per channel.
1992 * May be 0 when the codec has CODEC_CAP_VARIABLE_FRAME_SIZE set, then the
1993 * frame size is not restricted.
1994 * - decoding: may be set by some decoders to indicate constant frame size
1999 * Frame counter, set by libavcodec.
2001 * - decoding: total number of frames returned from the decoder so far.
2002 * - encoding: total number of frames passed to the encoder so far.
2004 * @note the counter is not incremented if encoding/decoding resulted in
2010 * number of bytes per packet if constant and known or 0
2011 * Used by some WAV based audio codecs.
2016 * Audio cutoff bandwidth (0 means "automatic")
2017 * - encoding: Set by user.
2018 * - decoding: unused
2022 #if FF_API_REQUEST_CHANNELS
2024 * Decoder should decode to this many channels if it can (0 for default)
2025 * - encoding: unused
2026 * - decoding: Set by user.
2027 * @deprecated Deprecated in favor of request_channel_layout.
2029 attribute_deprecated int request_channels;
2033 * Audio channel layout.
2034 * - encoding: set by user.
2035 * - decoding: set by user, may be overwritten by libavcodec.
2037 uint64_t channel_layout;
2040 * Request decoder to use this channel layout if it can (0 for default)
2041 * - encoding: unused
2042 * - decoding: Set by user.
2044 uint64_t request_channel_layout;
2047 * Type of service that the audio stream conveys.
2048 * - encoding: Set by user.
2049 * - decoding: Set by libavcodec.
2051 enum AVAudioServiceType audio_service_type;
2054 * desired sample format
2055 * - encoding: Not used.
2056 * - decoding: Set by user.
2057 * Decoder will decode to this format if it can.
2059 enum AVSampleFormat request_sample_fmt;
2061 #if FF_API_GET_BUFFER
2063 * Called at the beginning of each frame to get a buffer for it.
2065 * The function will set AVFrame.data[], AVFrame.linesize[].
2066 * AVFrame.extended_data[] must also be set, but it should be the same as
2067 * AVFrame.data[] except for planar audio with more channels than can fit
2068 * in AVFrame.data[]. In that case, AVFrame.data[] shall still contain as
2069 * many data pointers as it can hold.
2071 * if CODEC_CAP_DR1 is not set then get_buffer() must call
2072 * avcodec_default_get_buffer() instead of providing buffers allocated by
2075 * AVFrame.data[] should be 32- or 16-byte-aligned unless the CPU doesn't
2076 * need it. avcodec_default_get_buffer() aligns the output buffer properly,
2077 * but if get_buffer() is overridden then alignment considerations should
2078 * be taken into account.
2080 * @see avcodec_default_get_buffer()
2084 * If pic.reference is set then the frame will be read later by libavcodec.
2085 * avcodec_align_dimensions2() should be used to find the required width and
2086 * height, as they normally need to be rounded up to the next multiple of 16.
2088 * If frame multithreading is used and thread_safe_callbacks is set,
2089 * it may be called from a different thread, but not from more than one at
2090 * once. Does not need to be reentrant.
2092 * @see release_buffer(), reget_buffer()
2093 * @see avcodec_align_dimensions2()
2097 * Decoders request a buffer of a particular size by setting
2098 * AVFrame.nb_samples prior to calling get_buffer(). The decoder may,
2099 * however, utilize only part of the buffer by setting AVFrame.nb_samples
2100 * to a smaller value in the output frame.
2102 * Decoders cannot use the buffer after returning from
2103 * avcodec_decode_audio4(), so they will not call release_buffer(), as it
2104 * is assumed to be released immediately upon return. In some rare cases,
2105 * a decoder may need to call get_buffer() more than once in a single
2106 * call to avcodec_decode_audio4(). In that case, when get_buffer() is
2107 * called again after it has already been called once, the previously
2108 * acquired buffer is assumed to be released at that time and may not be
2109 * reused by the decoder.
2111 * As a convenience, av_samples_get_buffer_size() and
2112 * av_samples_fill_arrays() in libavutil may be used by custom get_buffer()
2113 * functions to find the required data size and to fill data pointers and
2114 * linesize. In AVFrame.linesize, only linesize[0] may be set for audio
2115 * since all planes must be the same size.
2117 * @see av_samples_get_buffer_size(), av_samples_fill_arrays()
2119 * - encoding: unused
2120 * - decoding: Set by libavcodec, user can override.
2122 * @deprecated use get_buffer2()
2124 attribute_deprecated
2125 int (*get_buffer)(struct AVCodecContext *c, AVFrame *pic);
2128 * Called to release buffers which were allocated with get_buffer.
2129 * A released buffer can be reused in get_buffer().
2130 * pic.data[*] must be set to NULL.
2131 * May be called from a different thread if frame multithreading is used,
2132 * but not by more than one thread at once, so does not need to be reentrant.
2133 * - encoding: unused
2134 * - decoding: Set by libavcodec, user can override.
2136 * @deprecated custom freeing callbacks should be set from get_buffer2()
2138 attribute_deprecated
2139 void (*release_buffer)(struct AVCodecContext *c, AVFrame *pic);
2142 * Called at the beginning of a frame to get cr buffer for it.
2143 * Buffer type (size, hints) must be the same. libavcodec won't check it.
2144 * libavcodec will pass previous buffer in pic, function should return
2145 * same buffer or new buffer with old frame "painted" into it.
2146 * If pic.data[0] == NULL must behave like get_buffer().
2147 * if CODEC_CAP_DR1 is not set then reget_buffer() must call
2148 * avcodec_default_reget_buffer() instead of providing buffers allocated by
2150 * - encoding: unused
2151 * - decoding: Set by libavcodec, user can override.
2153 attribute_deprecated
2154 int (*reget_buffer)(struct AVCodecContext *c, AVFrame *pic);
2158 * This callback is called at the beginning of each frame to get data
2159 * buffer(s) for it. There may be one contiguous buffer for all the data or
2160 * there may be a buffer per each data plane or anything in between. What
2161 * this means is, you may set however many entries in buf[] you feel necessary.
2162 * Each buffer must be reference-counted using the AVBuffer API (see description
2165 * The following fields will be set in the frame before this callback is
2168 * - width, height (video only)
2169 * - sample_rate, channel_layout, nb_samples (audio only)
2170 * Their values may differ from the corresponding values in
2171 * AVCodecContext. This callback must use the frame values, not the codec
2172 * context values, to calculate the required buffer size.
2174 * This callback must fill the following fields in the frame:
2178 * * if the data is planar audio with more than 8 channels, then this
2179 * callback must allocate and fill extended_data to contain all pointers
2180 * to all data planes. data[] must hold as many pointers as it can.
2181 * extended_data must be allocated with av_malloc() and will be freed in
2183 * * otherwise exended_data must point to data
2184 * - buf[] must contain one or more pointers to AVBufferRef structures. Each of
2185 * the frame's data and extended_data pointers must be contained in these. That
2186 * is, one AVBufferRef for each allocated chunk of memory, not necessarily one
2187 * AVBufferRef per data[] entry. See: av_buffer_create(), av_buffer_alloc(),
2188 * and av_buffer_ref().
2189 * - extended_buf and nb_extended_buf must be allocated with av_malloc() by
2190 * this callback and filled with the extra buffers if there are more
2191 * buffers than buf[] can hold. extended_buf will be freed in
2194 * If CODEC_CAP_DR1 is not set then get_buffer2() must call
2195 * avcodec_default_get_buffer2() instead of providing buffers allocated by
2198 * Each data plane must be aligned to the maximum required by the target
2201 * @see avcodec_default_get_buffer2()
2205 * If AV_GET_BUFFER_FLAG_REF is set in flags then the frame may be reused
2206 * (read and/or written to if it is writable) later by libavcodec.
2208 * avcodec_align_dimensions2() should be used to find the required width and
2209 * height, as they normally need to be rounded up to the next multiple of 16.
2211 * Some decoders do not support linesizes changing between frames.
2213 * If frame multithreading is used and thread_safe_callbacks is set,
2214 * this callback may be called from a different thread, but not from more
2215 * than one at once. Does not need to be reentrant.
2217 * @see avcodec_align_dimensions2()
2221 * Decoders request a buffer of a particular size by setting
2222 * AVFrame.nb_samples prior to calling get_buffer2(). The decoder may,
2223 * however, utilize only part of the buffer by setting AVFrame.nb_samples
2224 * to a smaller value in the output frame.
2226 * As a convenience, av_samples_get_buffer_size() and
2227 * av_samples_fill_arrays() in libavutil may be used by custom get_buffer2()
2228 * functions to find the required data size and to fill data pointers and
2229 * linesize. In AVFrame.linesize, only linesize[0] may be set for audio
2230 * since all planes must be the same size.
2232 * @see av_samples_get_buffer_size(), av_samples_fill_arrays()
2234 * - encoding: unused
2235 * - decoding: Set by libavcodec, user can override.
2237 int (*get_buffer2)(struct AVCodecContext *s, AVFrame *frame, int flags);
2240 * If non-zero, the decoded audio and video frames returned from
2241 * avcodec_decode_video2() and avcodec_decode_audio4() are reference-counted
2242 * and are valid indefinitely. The caller must free them with
2243 * av_frame_unref() when they are not needed anymore.
2244 * Otherwise, the decoded frames must not be freed by the caller and are
2245 * only valid until the next decode call.
2247 * - encoding: unused
2248 * - decoding: set by the caller before avcodec_open2().
2250 int refcounted_frames;
2252 /* - encoding parameters */
2253 float qcompress; ///< amount of qscale change between easy & hard scenes (0.0-1.0)
2254 float qblur; ///< amount of qscale smoothing over time (0.0-1.0)
2258 * - encoding: Set by user.
2259 * - decoding: unused
2265 * - encoding: Set by user.
2266 * - decoding: unused
2271 * maximum quantizer difference between frames
2272 * - encoding: Set by user.
2273 * - decoding: unused
2278 * ratecontrol qmin qmax limiting method
2279 * 0-> clipping, 1-> use a nice continuous function to limit qscale within qmin/qmax.
2280 * - encoding: Set by user.
2281 * - decoding: unused
2289 * decoder bitstream buffer size
2290 * - encoding: Set by user.
2291 * - decoding: unused
2296 * ratecontrol override, see RcOverride
2297 * - encoding: Allocated/set/freed by user.
2298 * - decoding: unused
2300 int rc_override_count;
2301 RcOverride *rc_override;
2304 * rate control equation
2305 * - encoding: Set by user
2306 * - decoding: unused
2312 * - encoding: Set by user.
2313 * - decoding: unused
2319 * - encoding: Set by user.
2320 * - decoding: unused
2324 float rc_buffer_aggressivity;
2327 * initial complexity for pass1 ratecontrol
2328 * - encoding: Set by user.
2329 * - decoding: unused
2331 float rc_initial_cplx;
2334 * Ratecontrol attempt to use, at maximum, <value> of what can be used without an underflow.
2335 * - encoding: Set by user.
2336 * - decoding: unused.
2338 float rc_max_available_vbv_use;
2341 * Ratecontrol attempt to use, at least, <value> times the amount needed to prevent a vbv overflow.
2342 * - encoding: Set by user.
2343 * - decoding: unused.
2345 float rc_min_vbv_overflow_use;
2348 * Number of bits which should be loaded into the rc buffer before decoding starts.
2349 * - encoding: Set by user.
2350 * - decoding: unused
2352 int rc_initial_buffer_occupancy;
2354 #define FF_CODER_TYPE_VLC 0
2355 #define FF_CODER_TYPE_AC 1
2356 #define FF_CODER_TYPE_RAW 2
2357 #define FF_CODER_TYPE_RLE 3
2358 #define FF_CODER_TYPE_DEFLATE 4
2361 * - encoding: Set by user.
2362 * - decoding: unused
2368 * - encoding: Set by user.
2369 * - decoding: unused
2374 * minimum Lagrange multiplier
2375 * - encoding: Set by user.
2376 * - decoding: unused
2381 * maximum Lagrange multiplier
2382 * - encoding: Set by user.
2383 * - decoding: unused
2388 * frame skip threshold
2389 * - encoding: Set by user.
2390 * - decoding: unused
2392 int frame_skip_threshold;
2396 * - encoding: Set by user.
2397 * - decoding: unused
2399 int frame_skip_factor;
2402 * frame skip exponent
2403 * - encoding: Set by user.
2404 * - decoding: unused
2409 * frame skip comparison function
2410 * - encoding: Set by user.
2411 * - decoding: unused
2416 * trellis RD quantization
2417 * - encoding: Set by user.
2418 * - decoding: unused
2423 * - encoding: Set by user.
2424 * - decoding: unused
2426 int min_prediction_order;
2429 * - encoding: Set by user.
2430 * - decoding: unused
2432 int max_prediction_order;
2435 * GOP timecode frame start number
2436 * - encoding: Set by user, in non drop frame format
2437 * - decoding: Set by libavcodec (timecode in the 25 bits format, -1 if unset)
2439 int64_t timecode_frame_start;
2441 /* The RTP callback: This function is called */
2442 /* every time the encoder has a packet to send. */
2443 /* It depends on the encoder if the data starts */
2444 /* with a Start Code (it should). H.263 does. */
2445 /* mb_nb contains the number of macroblocks */
2446 /* encoded in the RTP payload. */
2447 void (*rtp_callback)(struct AVCodecContext *avctx, void *data, int size, int mb_nb);
2449 int rtp_payload_size; /* The size of the RTP payload: the coder will */
2450 /* do its best to deliver a chunk with size */
2451 /* below rtp_payload_size, the chunk will start */
2452 /* with a start code on some codecs like H.263. */
2453 /* This doesn't take account of any particular */
2454 /* headers inside the transmitted RTP payload. */
2456 /* statistics, used for 2-pass encoding */
2467 * number of bits used for the previously encoded frame
2468 * - encoding: Set by libavcodec.
2469 * - decoding: unused
2474 * pass1 encoding statistics output buffer
2475 * - encoding: Set by libavcodec.
2476 * - decoding: unused
2481 * pass2 encoding statistics input buffer
2482 * Concatenated stuff from stats_out of pass1 should be placed here.
2483 * - encoding: Allocated/set/freed by user.
2484 * - decoding: unused
2489 * Work around bugs in encoders which sometimes cannot be detected automatically.
2490 * - encoding: Set by user
2491 * - decoding: Set by user
2493 int workaround_bugs;
2494 #define FF_BUG_AUTODETECT 1 ///< autodetection
2495 #if FF_API_OLD_MSMPEG4
2496 #define FF_BUG_OLD_MSMPEG4 2
2498 #define FF_BUG_XVID_ILACE 4
2499 #define FF_BUG_UMP4 8
2500 #define FF_BUG_NO_PADDING 16
2501 #define FF_BUG_AMV 32
2503 #define FF_BUG_AC_VLC 0 ///< Will be removed, libavcodec can now handle these non-compliant files by default.
2505 #define FF_BUG_QPEL_CHROMA 64
2506 #define FF_BUG_STD_QPEL 128
2507 #define FF_BUG_QPEL_CHROMA2 256
2508 #define FF_BUG_DIRECT_BLOCKSIZE 512
2509 #define FF_BUG_EDGE 1024
2510 #define FF_BUG_HPEL_CHROMA 2048
2511 #define FF_BUG_DC_CLIP 4096
2512 #define FF_BUG_MS 8192 ///< Work around various bugs in Microsoft's broken decoders.
2513 #define FF_BUG_TRUNCATED 16384
2516 * strictly follow the standard (MPEG4, ...).
2517 * - encoding: Set by user.
2518 * - decoding: Set by user.
2519 * Setting this to STRICT or higher means the encoder and decoder will
2520 * generally do stupid things, whereas setting it to unofficial or lower
2521 * will mean the encoder might produce output that is not supported by all
2522 * spec-compliant decoders. Decoders don't differentiate between normal,
2523 * unofficial and experimental (that is, they always try to decode things
2524 * when they can) unless they are explicitly asked to behave stupidly
2525 * (=strictly conform to the specs)
2527 int strict_std_compliance;
2528 #define FF_COMPLIANCE_VERY_STRICT 2 ///< Strictly conform to an older more strict version of the spec or reference software.
2529 #define FF_COMPLIANCE_STRICT 1 ///< Strictly conform to all the things in the spec no matter what consequences.
2530 #define FF_COMPLIANCE_NORMAL 0
2531 #define FF_COMPLIANCE_UNOFFICIAL -1 ///< Allow unofficial extensions
2532 #define FF_COMPLIANCE_EXPERIMENTAL -2 ///< Allow nonstandardized experimental things.
2535 * error concealment flags
2536 * - encoding: unused
2537 * - decoding: Set by user.
2539 int error_concealment;
2540 #define FF_EC_GUESS_MVS 1
2541 #define FF_EC_DEBLOCK 2
2545 * - encoding: Set by user.
2546 * - decoding: Set by user.
2549 #define FF_DEBUG_PICT_INFO 1
2550 #define FF_DEBUG_RC 2
2551 #define FF_DEBUG_BITSTREAM 4
2552 #define FF_DEBUG_MB_TYPE 8
2553 #define FF_DEBUG_QP 16
2556 * @deprecated this option does nothing
2558 #define FF_DEBUG_MV 32
2560 #define FF_DEBUG_DCT_COEFF 0x00000040
2561 #define FF_DEBUG_SKIP 0x00000080
2562 #define FF_DEBUG_STARTCODE 0x00000100
2563 #define FF_DEBUG_PTS 0x00000200
2564 #define FF_DEBUG_ER 0x00000400
2565 #define FF_DEBUG_MMCO 0x00000800
2566 #define FF_DEBUG_BUGS 0x00001000
2568 #define FF_DEBUG_VIS_QP 0x00002000 ///< only access through AVOptions from outside libavcodec
2569 #define FF_DEBUG_VIS_MB_TYPE 0x00004000 ///< only access through AVOptions from outside libavcodec
2571 #define FF_DEBUG_BUFFERS 0x00008000
2572 #define FF_DEBUG_THREADS 0x00010000
2577 * Code outside libavcodec should access this field using AVOptions
2578 * - encoding: Set by user.
2579 * - decoding: Set by user.
2582 #define FF_DEBUG_VIS_MV_P_FOR 0x00000001 //visualize forward predicted MVs of P frames
2583 #define FF_DEBUG_VIS_MV_B_FOR 0x00000002 //visualize forward predicted MVs of B frames
2584 #define FF_DEBUG_VIS_MV_B_BACK 0x00000004 //visualize backward predicted MVs of B frames
2588 * Error recognition; may misdetect some more or less valid parts as errors.
2589 * - encoding: unused
2590 * - decoding: Set by user.
2592 int err_recognition;
2595 * Verify checksums embedded in the bitstream (could be of either encoded or
2596 * decoded data, depending on the codec) and print an error message on mismatch.
2597 * If AV_EF_EXPLODE is also set, a mismatching checksum will result in the
2598 * decoder returning an error.
2600 #define AV_EF_CRCCHECK (1<<0)
2601 #define AV_EF_BITSTREAM (1<<1) ///< detect bitstream specification deviations
2602 #define AV_EF_BUFFER (1<<2) ///< detect improper bitstream length
2603 #define AV_EF_EXPLODE (1<<3) ///< abort decoding on minor error detection
2605 #define AV_EF_CAREFUL (1<<16) ///< consider things that violate the spec, are fast to calculate and have not been seen in the wild as errors
2606 #define AV_EF_COMPLIANT (1<<17) ///< consider all spec non compliances as errors
2607 #define AV_EF_AGGRESSIVE (1<<18) ///< consider things that a sane encoder should not do as an error
2611 * opaque 64bit number (generally a PTS) that will be reordered and
2612 * output in AVFrame.reordered_opaque
2613 * @deprecated in favor of pkt_pts
2614 * - encoding: unused
2615 * - decoding: Set by user.
2617 int64_t reordered_opaque;
2620 * Hardware accelerator in use
2621 * - encoding: unused.
2622 * - decoding: Set by libavcodec
2624 struct AVHWAccel *hwaccel;
2627 * Hardware accelerator context.
2628 * For some hardware accelerators, a global context needs to be
2629 * provided by the user. In that case, this holds display-dependent
2630 * data FFmpeg cannot instantiate itself. Please refer to the
2631 * FFmpeg HW accelerator documentation to know how to fill this
2632 * is. e.g. for VA API, this is a struct vaapi_context.
2633 * - encoding: unused
2634 * - decoding: Set by user
2636 void *hwaccel_context;
2640 * - encoding: Set by libavcodec if flags&CODEC_FLAG_PSNR.
2641 * - decoding: unused
2643 uint64_t error[AV_NUM_DATA_POINTERS];
2646 * DCT algorithm, see FF_DCT_* below
2647 * - encoding: Set by user.
2648 * - decoding: unused
2651 #define FF_DCT_AUTO 0
2652 #define FF_DCT_FASTINT 1
2653 #define FF_DCT_INT 2
2654 #define FF_DCT_MMX 3
2655 #define FF_DCT_ALTIVEC 5
2656 #define FF_DCT_FAAN 6
2659 * IDCT algorithm, see FF_IDCT_* below.
2660 * - encoding: Set by user.
2661 * - decoding: Set by user.
2664 #define FF_IDCT_AUTO 0
2665 #define FF_IDCT_INT 1
2666 #define FF_IDCT_SIMPLE 2
2667 #define FF_IDCT_SIMPLEMMX 3
2668 #define FF_IDCT_ARM 7
2669 #define FF_IDCT_ALTIVEC 8
2671 #define FF_IDCT_SH4 9
2673 #define FF_IDCT_SIMPLEARM 10
2674 #define FF_IDCT_IPP 13
2675 #define FF_IDCT_XVIDMMX 14
2676 #define FF_IDCT_SIMPLEARMV5TE 16
2677 #define FF_IDCT_SIMPLEARMV6 17
2678 #if FF_API_ARCH_SPARC
2679 #define FF_IDCT_SIMPLEVIS 18
2681 #define FF_IDCT_FAAN 20
2682 #define FF_IDCT_SIMPLENEON 22
2683 #if FF_API_ARCH_ALPHA
2684 #define FF_IDCT_SIMPLEALPHA 23
2688 * bits per sample/pixel from the demuxer (needed for huffyuv).
2689 * - encoding: Set by libavcodec.
2690 * - decoding: Set by user.
2692 int bits_per_coded_sample;
2695 * Bits per sample/pixel of internal libavcodec pixel/sample format.
2696 * - encoding: set by user.
2697 * - decoding: set by libavcodec.
2699 int bits_per_raw_sample;
2703 * low resolution decoding, 1-> 1/2 size, 2->1/4 size
2704 * - encoding: unused
2705 * - decoding: Set by user.
2706 * Code outside libavcodec should access this field using:
2707 * av_codec_{get,set}_lowres(avctx)
2713 * the picture in the bitstream
2714 * - encoding: Set by libavcodec.
2715 * - decoding: unused
2717 AVFrame *coded_frame;
2721 * is used to decide how many independent tasks should be passed to execute()
2722 * - encoding: Set by user.
2723 * - decoding: Set by user.
2728 * Which multithreading methods to use.
2729 * Use of FF_THREAD_FRAME will increase decoding delay by one frame per thread,
2730 * so clients which cannot provide future frames should not use it.
2732 * - encoding: Set by user, otherwise the default is used.
2733 * - decoding: Set by user, otherwise the default is used.
2736 #define FF_THREAD_FRAME 1 ///< Decode more than one frame at once
2737 #define FF_THREAD_SLICE 2 ///< Decode more than one part of a single frame at once
2740 * Which multithreading methods are in use by the codec.
2741 * - encoding: Set by libavcodec.
2742 * - decoding: Set by libavcodec.
2744 int active_thread_type;
2747 * Set by the client if its custom get_buffer() callback can be called
2748 * synchronously from another thread, which allows faster multithreaded decoding.
2749 * draw_horiz_band() will be called from other threads regardless of this setting.
2750 * Ignored if the default get_buffer() is used.
2751 * - encoding: Set by user.
2752 * - decoding: Set by user.
2754 int thread_safe_callbacks;
2757 * The codec may call this to execute several independent things.
2758 * It will return only after finishing all tasks.
2759 * The user may replace this with some multithreaded implementation,
2760 * the default implementation will execute the parts serially.
2761 * @param count the number of things to execute
2762 * - encoding: Set by libavcodec, user can override.
2763 * - decoding: Set by libavcodec, user can override.
2765 int (*execute)(struct AVCodecContext *c, int (*func)(struct AVCodecContext *c2, void *arg), void *arg2, int *ret, int count, int size);
2768 * The codec may call this to execute several independent things.
2769 * It will return only after finishing all tasks.
2770 * The user may replace this with some multithreaded implementation,
2771 * the default implementation will execute the parts serially.
2772 * Also see avcodec_thread_init and e.g. the --enable-pthread configure option.
2773 * @param c context passed also to func
2774 * @param count the number of things to execute
2775 * @param arg2 argument passed unchanged to func
2776 * @param ret return values of executed functions, must have space for "count" values. May be NULL.
2777 * @param func function that will be called count times, with jobnr from 0 to count-1.
2778 * threadnr will be in the range 0 to c->thread_count-1 < MAX_THREADS and so that no
2779 * two instances of func executing at the same time will have the same threadnr.
2780 * @return always 0 currently, but code should handle a future improvement where when any call to func
2781 * returns < 0 no further calls to func may be done and < 0 is returned.
2782 * - encoding: Set by libavcodec, user can override.
2783 * - decoding: Set by libavcodec, user can override.
2785 int (*execute2)(struct AVCodecContext *c, int (*func)(struct AVCodecContext *c2, void *arg, int jobnr, int threadnr), void *arg2, int *ret, int count);
2787 #if FF_API_THREAD_OPAQUE
2789 * @deprecated this field should not be used from outside of lavc
2791 attribute_deprecated
2792 void *thread_opaque;
2796 * noise vs. sse weight for the nsse comparison function
2797 * - encoding: Set by user.
2798 * - decoding: unused
2804 * - encoding: Set by user.
2805 * - decoding: Set by libavcodec.
2808 #define FF_PROFILE_UNKNOWN -99
2809 #define FF_PROFILE_RESERVED -100
2811 #define FF_PROFILE_AAC_MAIN 0
2812 #define FF_PROFILE_AAC_LOW 1
2813 #define FF_PROFILE_AAC_SSR 2
2814 #define FF_PROFILE_AAC_LTP 3
2815 #define FF_PROFILE_AAC_HE 4
2816 #define FF_PROFILE_AAC_HE_V2 28
2817 #define FF_PROFILE_AAC_LD 22
2818 #define FF_PROFILE_AAC_ELD 38
2819 #define FF_PROFILE_MPEG2_AAC_LOW 128
2820 #define FF_PROFILE_MPEG2_AAC_HE 131
2822 #define FF_PROFILE_DTS 20
2823 #define FF_PROFILE_DTS_ES 30
2824 #define FF_PROFILE_DTS_96_24 40
2825 #define FF_PROFILE_DTS_HD_HRA 50
2826 #define FF_PROFILE_DTS_HD_MA 60
2828 #define FF_PROFILE_MPEG2_422 0
2829 #define FF_PROFILE_MPEG2_HIGH 1
2830 #define FF_PROFILE_MPEG2_SS 2
2831 #define FF_PROFILE_MPEG2_SNR_SCALABLE 3
2832 #define FF_PROFILE_MPEG2_MAIN 4
2833 #define FF_PROFILE_MPEG2_SIMPLE 5
2835 #define FF_PROFILE_H264_CONSTRAINED (1<<9) // 8+1; constraint_set1_flag
2836 #define FF_PROFILE_H264_INTRA (1<<11) // 8+3; constraint_set3_flag
2838 #define FF_PROFILE_H264_BASELINE 66
2839 #define FF_PROFILE_H264_CONSTRAINED_BASELINE (66|FF_PROFILE_H264_CONSTRAINED)
2840 #define FF_PROFILE_H264_MAIN 77
2841 #define FF_PROFILE_H264_EXTENDED 88
2842 #define FF_PROFILE_H264_HIGH 100
2843 #define FF_PROFILE_H264_HIGH_10 110
2844 #define FF_PROFILE_H264_HIGH_10_INTRA (110|FF_PROFILE_H264_INTRA)
2845 #define FF_PROFILE_H264_HIGH_422 122
2846 #define FF_PROFILE_H264_HIGH_422_INTRA (122|FF_PROFILE_H264_INTRA)
2847 #define FF_PROFILE_H264_HIGH_444 144
2848 #define FF_PROFILE_H264_HIGH_444_PREDICTIVE 244
2849 #define FF_PROFILE_H264_HIGH_444_INTRA (244|FF_PROFILE_H264_INTRA)
2850 #define FF_PROFILE_H264_CAVLC_444 44
2852 #define FF_PROFILE_VC1_SIMPLE 0
2853 #define FF_PROFILE_VC1_MAIN 1
2854 #define FF_PROFILE_VC1_COMPLEX 2
2855 #define FF_PROFILE_VC1_ADVANCED 3
2857 #define FF_PROFILE_MPEG4_SIMPLE 0
2858 #define FF_PROFILE_MPEG4_SIMPLE_SCALABLE 1
2859 #define FF_PROFILE_MPEG4_CORE 2
2860 #define FF_PROFILE_MPEG4_MAIN 3
2861 #define FF_PROFILE_MPEG4_N_BIT 4
2862 #define FF_PROFILE_MPEG4_SCALABLE_TEXTURE 5
2863 #define FF_PROFILE_MPEG4_SIMPLE_FACE_ANIMATION 6
2864 #define FF_PROFILE_MPEG4_BASIC_ANIMATED_TEXTURE 7
2865 #define FF_PROFILE_MPEG4_HYBRID 8
2866 #define FF_PROFILE_MPEG4_ADVANCED_REAL_TIME 9
2867 #define FF_PROFILE_MPEG4_CORE_SCALABLE 10
2868 #define FF_PROFILE_MPEG4_ADVANCED_CODING 11
2869 #define FF_PROFILE_MPEG4_ADVANCED_CORE 12
2870 #define FF_PROFILE_MPEG4_ADVANCED_SCALABLE_TEXTURE 13
2871 #define FF_PROFILE_MPEG4_SIMPLE_STUDIO 14
2872 #define FF_PROFILE_MPEG4_ADVANCED_SIMPLE 15
2874 #define FF_PROFILE_JPEG2000_CSTREAM_RESTRICTION_0 0
2875 #define FF_PROFILE_JPEG2000_CSTREAM_RESTRICTION_1 1
2876 #define FF_PROFILE_JPEG2000_CSTREAM_NO_RESTRICTION 2
2877 #define FF_PROFILE_JPEG2000_DCINEMA_2K 3
2878 #define FF_PROFILE_JPEG2000_DCINEMA_4K 4
2881 #define FF_PROFILE_HEVC_MAIN 1
2882 #define FF_PROFILE_HEVC_MAIN_10 2
2883 #define FF_PROFILE_HEVC_MAIN_STILL_PICTURE 3
2887 * - encoding: Set by user.
2888 * - decoding: Set by libavcodec.
2891 #define FF_LEVEL_UNKNOWN -99
2894 * Skip loop filtering for selected frames.
2895 * - encoding: unused
2896 * - decoding: Set by user.
2898 enum AVDiscard skip_loop_filter;
2901 * Skip IDCT/dequantization for selected frames.
2902 * - encoding: unused
2903 * - decoding: Set by user.
2905 enum AVDiscard skip_idct;
2908 * Skip decoding for selected frames.
2909 * - encoding: unused
2910 * - decoding: Set by user.
2912 enum AVDiscard skip_frame;
2915 * Header containing style information for text subtitles.
2916 * For SUBTITLE_ASS subtitle type, it should contain the whole ASS
2917 * [Script Info] and [V4+ Styles] section, plus the [Events] line and
2918 * the Format line following. It shouldn't include any Dialogue line.
2919 * - encoding: Set/allocated/freed by user (before avcodec_open2())
2920 * - decoding: Set/allocated/freed by libavcodec (by avcodec_open2())
2922 uint8_t *subtitle_header;
2923 int subtitle_header_size;
2925 #if FF_API_ERROR_RATE
2927 * @deprecated use the 'error_rate' private AVOption of the mpegvideo
2930 attribute_deprecated
2934 #if FF_API_CODEC_PKT
2936 * @deprecated this field is not supposed to be accessed from outside lavc
2938 attribute_deprecated
2943 * VBV delay coded in the last frame (in periods of a 27 MHz clock).
2944 * Used for compliant TS muxing.
2945 * - encoding: Set by libavcodec.
2946 * - decoding: unused.
2951 * Timebase in which pkt_dts/pts and AVPacket.dts/pts are.
2952 * Code outside libavcodec should access this field using:
2953 * av_codec_{get,set}_pkt_timebase(avctx)
2954 * - encoding unused.
2955 * - decoding set by user.
2957 AVRational pkt_timebase;
2961 * Code outside libavcodec should access this field using:
2962 * av_codec_{get,set}_codec_descriptor(avctx)
2963 * - encoding: unused.
2964 * - decoding: set by libavcodec.
2966 const AVCodecDescriptor *codec_descriptor;
2970 * low resolution decoding, 1-> 1/2 size, 2->1/4 size
2971 * - encoding: unused
2972 * - decoding: Set by user.
2973 * Code outside libavcodec should access this field using:
2974 * av_codec_{get,set}_lowres(avctx)
2980 * Current statistics for PTS correction.
2981 * - decoding: maintained and used by libavcodec, not intended to be used by user apps
2982 * - encoding: unused
2984 int64_t pts_correction_num_faulty_pts; /// Number of incorrect PTS values so far
2985 int64_t pts_correction_num_faulty_dts; /// Number of incorrect DTS values so far
2986 int64_t pts_correction_last_pts; /// PTS of the last frame
2987 int64_t pts_correction_last_dts; /// DTS of the last frame
2990 * Character encoding of the input subtitles file.
2991 * - decoding: set by user
2992 * - encoding: unused
2997 * Subtitles character encoding mode. Formats or codecs might be adjusting
2998 * this setting (if they are doing the conversion themselves for instance).
2999 * - decoding: set by libavcodec
3000 * - encoding: unused
3002 int sub_charenc_mode;
3003 #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)
3004 #define FF_SUB_CHARENC_MODE_AUTOMATIC 0 ///< libavcodec will select the mode itself
3005 #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
3008 * Skip processing alpha if supported by codec.
3009 * Note that if the format uses pre-multiplied alpha (common with VP6,
3010 * and recommended due to better video quality/compression)
3011 * the image will look as if alpha-blended onto a black background.
3012 * However for formats that do not use pre-multiplied alpha
3013 * there might be serious artefacts (though e.g. libswscale currently
3014 * assumes pre-multiplied alpha anyway).
3015 * Code outside libavcodec should access this field using AVOptions
3017 * - decoding: set by user
3018 * - encoding: unused
3023 * Number of samples to skip after a discontinuity
3024 * - decoding: unused
3025 * - encoding: set by libavcodec
3029 #if !FF_API_DEBUG_MV
3031 * debug motion vectors
3032 * Code outside libavcodec should access this field using AVOptions
3033 * - encoding: Set by user.
3034 * - decoding: Set by user.
3037 #define FF_DEBUG_VIS_MV_P_FOR 0x00000001 //visualize forward predicted MVs of P frames
3038 #define FF_DEBUG_VIS_MV_B_FOR 0x00000002 //visualize forward predicted MVs of B frames
3039 #define FF_DEBUG_VIS_MV_B_BACK 0x00000004 //visualize backward predicted MVs of B frames
3043 * custom intra quantization matrix
3044 * Code outside libavcodec should access this field using av_codec_g/set_chroma_intra_matrix()
3045 * - encoding: Set by user, can be NULL.
3046 * - decoding: unused.
3048 uint16_t *chroma_intra_matrix;
3051 AVRational av_codec_get_pkt_timebase (const AVCodecContext *avctx);
3052 void av_codec_set_pkt_timebase (AVCodecContext *avctx, AVRational val);
3054 const AVCodecDescriptor *av_codec_get_codec_descriptor(const AVCodecContext *avctx);
3055 void av_codec_set_codec_descriptor(AVCodecContext *avctx, const AVCodecDescriptor *desc);
3057 int av_codec_get_lowres(const AVCodecContext *avctx);
3058 void av_codec_set_lowres(AVCodecContext *avctx, int val);
3060 int av_codec_get_seek_preroll(const AVCodecContext *avctx);
3061 void av_codec_set_seek_preroll(AVCodecContext *avctx, int val);
3063 uint16_t *av_codec_get_chroma_intra_matrix(const AVCodecContext *avctx);
3064 void av_codec_set_chroma_intra_matrix(AVCodecContext *avctx, uint16_t *val);
3069 typedef struct AVProfile {
3071 const char *name; ///< short name for the profile
3074 typedef struct AVCodecDefault AVCodecDefault;
3081 typedef struct AVCodec {
3083 * Name of the codec implementation.
3084 * The name is globally unique among encoders and among decoders (but an
3085 * encoder and a decoder can share the same name).
3086 * This is the primary way to find a codec from the user perspective.
3090 * Descriptive name for the codec, meant to be more human readable than name.
3091 * You should use the NULL_IF_CONFIG_SMALL() macro to define it.
3093 const char *long_name;
3094 enum AVMediaType type;
3097 * Codec capabilities.
3101 const AVRational *supported_framerates; ///< array of supported framerates, or NULL if any, array is terminated by {0,0}
3102 const enum AVPixelFormat *pix_fmts; ///< array of supported pixel formats, or NULL if unknown, array is terminated by -1
3103 const int *supported_samplerates; ///< array of supported audio samplerates, or NULL if unknown, array is terminated by 0
3104 const enum AVSampleFormat *sample_fmts; ///< array of supported sample formats, or NULL if unknown, array is terminated by -1
3105 const uint64_t *channel_layouts; ///< array of support channel layouts, or NULL if unknown. array is terminated by 0
3107 uint8_t max_lowres; ///< maximum value for lowres supported by the decoder, no direct access, use av_codec_get_max_lowres()
3109 const AVClass *priv_class; ///< AVClass for the private context
3110 const AVProfile *profiles; ///< array of recognized profiles, or NULL if unknown, array is terminated by {FF_PROFILE_UNKNOWN}
3112 /*****************************************************************
3113 * No fields below this line are part of the public API. They
3114 * may not be used outside of libavcodec and can be changed and
3116 * New public fields should be added right above.
3117 *****************************************************************
3120 struct AVCodec *next;
3122 * @name Frame-level threading support functions
3126 * If defined, called on thread contexts when they are created.
3127 * If the codec allocates writable tables in init(), re-allocate them here.
3128 * priv_data will be set to a copy of the original.
3130 int (*init_thread_copy)(AVCodecContext *);
3132 * Copy necessary context variables from a previous thread context to the current one.
3133 * If not defined, the next thread will start automatically; otherwise, the codec
3134 * must call ff_thread_finish_setup().
3136 * dst and src will (rarely) point to the same context, in which case memcpy should be skipped.
3138 int (*update_thread_context)(AVCodecContext *dst, const AVCodecContext *src);
3142 * Private codec-specific defaults.
3144 const AVCodecDefault *defaults;
3147 * Initialize codec static data, called from avcodec_register().
3149 void (*init_static_data)(struct AVCodec *codec);
3151 int (*init)(AVCodecContext *);
3152 int (*encode_sub)(AVCodecContext *, uint8_t *buf, int buf_size,
3153 const struct AVSubtitle *sub);
3155 * Encode data to an AVPacket.
3157 * @param avctx codec context
3158 * @param avpkt output AVPacket (may contain a user-provided buffer)
3159 * @param[in] frame AVFrame containing the raw data to be encoded
3160 * @param[out] got_packet_ptr encoder sets to 0 or 1 to indicate that a
3161 * non-empty packet was returned in avpkt.
3162 * @return 0 on success, negative error code on failure
3164 int (*encode2)(AVCodecContext *avctx, AVPacket *avpkt, const AVFrame *frame,
3165 int *got_packet_ptr);
3166 int (*decode)(AVCodecContext *, void *outdata, int *outdata_size, AVPacket *avpkt);
3167 int (*close)(AVCodecContext *);
3170 * Will be called when seeking
3172 void (*flush)(AVCodecContext *);
3175 int av_codec_get_max_lowres(const AVCodec *codec);
3177 struct MpegEncContext;
3182 typedef struct AVHWAccel {
3184 * Name of the hardware accelerated codec.
3185 * The name is globally unique among encoders and among decoders (but an
3186 * encoder and a decoder can share the same name).
3191 * Type of codec implemented by the hardware accelerator.
3193 * See AVMEDIA_TYPE_xxx
3195 enum AVMediaType type;
3198 * Codec implemented by the hardware accelerator.
3200 * See AV_CODEC_ID_xxx
3205 * Supported pixel format.
3207 * Only hardware accelerated formats are supported here.
3209 enum AVPixelFormat pix_fmt;
3212 * Hardware accelerated codec capabilities.
3213 * see FF_HWACCEL_CODEC_CAP_*
3217 struct AVHWAccel *next;
3220 * Called at the beginning of each frame or field picture.
3222 * Meaningful frame information (codec specific) is guaranteed to
3223 * be parsed at this point. This function is mandatory.
3225 * Note that buf can be NULL along with buf_size set to 0.
3226 * Otherwise, this means the whole frame is available at this point.
3228 * @param avctx the codec context
3229 * @param buf the frame data buffer base
3230 * @param buf_size the size of the frame in bytes
3231 * @return zero if successful, a negative value otherwise
3233 int (*start_frame)(AVCodecContext *avctx, const uint8_t *buf, uint32_t buf_size);
3236 * Callback for each slice.
3238 * Meaningful slice information (codec specific) is guaranteed to
3239 * be parsed at this point. This function is mandatory.
3240 * The only exception is XvMC, that works on MB level.
3242 * @param avctx the codec context
3243 * @param buf the slice data buffer base
3244 * @param buf_size the size of the slice in bytes
3245 * @return zero if successful, a negative value otherwise
3247 int (*decode_slice)(AVCodecContext *avctx, const uint8_t *buf, uint32_t buf_size);
3250 * Called at the end of each frame or field picture.
3252 * The whole picture is parsed at this point and can now be sent
3253 * to the hardware accelerator. This function is mandatory.
3255 * @param avctx the codec context
3256 * @return zero if successful, a negative value otherwise
3258 int (*end_frame)(AVCodecContext *avctx);
3261 * Size of HW accelerator private data.
3263 * Private data is allocated with av_mallocz() before
3264 * AVCodecContext.get_buffer() and deallocated after
3265 * AVCodecContext.release_buffer().
3270 * Called for every Macroblock in a slice.
3272 * XvMC uses it to replace the ff_MPV_decode_mb().
3273 * Instead of decoding to raw picture, MB parameters are
3274 * stored in an array provided by the video driver.
3276 * @param s the mpeg context
3278 void (*decode_mb)(struct MpegEncContext *s);
3282 * @defgroup lavc_picture AVPicture
3284 * Functions for working with AVPicture
3289 * Picture data structure.
3291 * Up to four components can be stored into it, the last component is
3294 typedef struct AVPicture {
3295 uint8_t *data[AV_NUM_DATA_POINTERS]; ///< pointers to the image data planes
3296 int linesize[AV_NUM_DATA_POINTERS]; ///< number of bytes per line
3303 enum AVSubtitleType {
3306 SUBTITLE_BITMAP, ///< A bitmap, pict will be set
3309 * Plain text, the text field must be set by the decoder and is
3310 * authoritative. ass and pict fields may contain approximations.
3315 * Formatted text, the ass field must be set by the decoder and is
3316 * authoritative. pict and text fields may contain approximations.
3321 #define AV_SUBTITLE_FLAG_FORCED 0x00000001
3323 typedef struct AVSubtitleRect {
3324 int x; ///< top left corner of pict, undefined when pict is not set
3325 int y; ///< top left corner of pict, undefined when pict is not set
3326 int w; ///< width of pict, undefined when pict is not set
3327 int h; ///< height of pict, undefined when pict is not set
3328 int nb_colors; ///< number of colors in pict, undefined when pict is not set
3331 * data+linesize for the bitmap of this subtitle.
3332 * can be set for text/ass as well once they where rendered
3335 enum AVSubtitleType type;
3337 char *text; ///< 0 terminated plain UTF-8 text
3340 * 0 terminated ASS/SSA compatible event line.
3341 * The presentation of this is unaffected by the other values in this
3349 typedef struct AVSubtitle {
3350 uint16_t format; /* 0 = graphics */
3351 uint32_t start_display_time; /* relative to packet pts, in ms */
3352 uint32_t end_display_time; /* relative to packet pts, in ms */
3354 AVSubtitleRect **rects;
3355 int64_t pts; ///< Same as packet pts, in AV_TIME_BASE
3359 * If c is NULL, returns the first registered codec,
3360 * if c is non-NULL, returns the next registered codec after c,
3361 * or NULL if c is the last one.
3363 AVCodec *av_codec_next(const AVCodec *c);
3366 * Return the LIBAVCODEC_VERSION_INT constant.
3368 unsigned avcodec_version(void);
3371 * Return the libavcodec build-time configuration.
3373 const char *avcodec_configuration(void);
3376 * Return the libavcodec license.
3378 const char *avcodec_license(void);
3381 * Register the codec codec and initialize libavcodec.
3383 * @warning either this function or avcodec_register_all() must be called
3384 * before any other libavcodec functions.
3386 * @see avcodec_register_all()
3388 void avcodec_register(AVCodec *codec);
3391 * Register all the codecs, parsers and bitstream filters which were enabled at
3392 * configuration time. If you do not call this function you can select exactly
3393 * which formats you want to support, by using the individual registration
3396 * @see avcodec_register
3397 * @see av_register_codec_parser
3398 * @see av_register_bitstream_filter
3400 void avcodec_register_all(void);
3403 * Allocate an AVCodecContext and set its fields to default values. The
3404 * resulting struct can be deallocated by calling avcodec_close() on it followed
3407 * @param codec if non-NULL, allocate private data and initialize defaults
3408 * for the given codec. It is illegal to then call avcodec_open2()
3409 * with a different codec.
3410 * If NULL, then the codec-specific defaults won't be initialized,
3411 * which may result in suboptimal default settings (this is
3412 * important mainly for encoders, e.g. libx264).
3414 * @return An AVCodecContext filled with default values or NULL on failure.
3415 * @see avcodec_get_context_defaults
3417 AVCodecContext *avcodec_alloc_context3(const AVCodec *codec);
3420 * Set the fields of the given AVCodecContext to default values corresponding
3421 * to the given codec (defaults may be codec-dependent).
3423 * Do not call this function if a non-NULL codec has been passed
3424 * to avcodec_alloc_context3() that allocated this AVCodecContext.
3425 * If codec is non-NULL, it is illegal to call avcodec_open2() with a
3426 * different codec on this AVCodecContext.
3428 int avcodec_get_context_defaults3(AVCodecContext *s, const AVCodec *codec);
3431 * Get the AVClass for AVCodecContext. It can be used in combination with
3432 * AV_OPT_SEARCH_FAKE_OBJ for examining options.
3434 * @see av_opt_find().
3436 const AVClass *avcodec_get_class(void);
3439 * Get the AVClass for AVFrame. It can be used in combination with
3440 * AV_OPT_SEARCH_FAKE_OBJ for examining options.
3442 * @see av_opt_find().
3444 const AVClass *avcodec_get_frame_class(void);
3447 * Get the AVClass for AVSubtitleRect. It can be used in combination with
3448 * AV_OPT_SEARCH_FAKE_OBJ for examining options.
3450 * @see av_opt_find().
3452 const AVClass *avcodec_get_subtitle_rect_class(void);
3455 * Copy the settings of the source AVCodecContext into the destination
3456 * AVCodecContext. The resulting destination codec context will be
3457 * unopened, i.e. you are required to call avcodec_open2() before you
3458 * can use this AVCodecContext to decode/encode video/audio data.
3460 * @param dest target codec context, should be initialized with
3461 * avcodec_alloc_context3(NULL), but otherwise uninitialized
3462 * @param src source codec context
3463 * @return AVERROR() on error (e.g. memory allocation error), 0 on success
3465 int avcodec_copy_context(AVCodecContext *dest, const AVCodecContext *src);
3467 #if FF_API_AVFRAME_LAVC
3469 * @deprecated use av_frame_alloc()
3471 attribute_deprecated
3472 AVFrame *avcodec_alloc_frame(void);
3475 * Set the fields of the given AVFrame to default values.
3477 * @param frame The AVFrame of which the fields should be set to default values.
3479 * @deprecated use av_frame_unref()
3481 attribute_deprecated
3482 void avcodec_get_frame_defaults(AVFrame *frame);
3485 * Free the frame and any dynamically allocated objects in it,
3486 * e.g. extended_data.
3488 * @param frame frame to be freed. The pointer will be set to NULL.
3490 * @warning this function does NOT free the data buffers themselves
3491 * (it does not know how, since they might have been allocated with
3492 * a custom get_buffer()).
3494 * @deprecated use av_frame_free()
3496 attribute_deprecated
3497 void avcodec_free_frame(AVFrame **frame);
3501 * Initialize the AVCodecContext to use the given AVCodec. Prior to using this
3502 * function the context has to be allocated with avcodec_alloc_context3().
3504 * The functions avcodec_find_decoder_by_name(), avcodec_find_encoder_by_name(),
3505 * avcodec_find_decoder() and avcodec_find_encoder() provide an easy way for
3506 * retrieving a codec.
3508 * @warning This function is not thread safe!
3511 * avcodec_register_all();
3512 * av_dict_set(&opts, "b", "2.5M", 0);
3513 * codec = avcodec_find_decoder(AV_CODEC_ID_H264);
3517 * context = avcodec_alloc_context3(codec);
3519 * if (avcodec_open2(context, codec, opts) < 0)
3523 * @param avctx The context to initialize.
3524 * @param codec The codec to open this context for. If a non-NULL codec has been
3525 * previously passed to avcodec_alloc_context3() or
3526 * avcodec_get_context_defaults3() for this context, then this
3527 * parameter MUST be either NULL or equal to the previously passed
3529 * @param options A dictionary filled with AVCodecContext and codec-private options.
3530 * On return this object will be filled with options that were not found.
3532 * @return zero on success, a negative value on error
3533 * @see avcodec_alloc_context3(), avcodec_find_decoder(), avcodec_find_encoder(),
3534 * av_dict_set(), av_opt_find().
3536 int avcodec_open2(AVCodecContext *avctx, const AVCodec *codec, AVDictionary **options);
3539 * Close a given AVCodecContext and free all the data associated with it
3540 * (but not the AVCodecContext itself).
3542 * Calling this function on an AVCodecContext that hasn't been opened will free
3543 * the codec-specific data allocated in avcodec_alloc_context3() /
3544 * avcodec_get_context_defaults3() with a non-NULL codec. Subsequent calls will
3547 int avcodec_close(AVCodecContext *avctx);
3550 * Free all allocated data in the given subtitle struct.
3552 * @param sub AVSubtitle to free.
3554 void avsubtitle_free(AVSubtitle *sub);
3561 * @addtogroup lavc_packet
3565 #if FF_API_DESTRUCT_PACKET
3567 * Default packet destructor.
3568 * @deprecated use the AVBuffer API instead
3570 attribute_deprecated
3571 void av_destruct_packet(AVPacket *pkt);
3575 * Initialize optional fields of a packet with default values.
3577 * Note, this does not touch the data and size members, which have to be
3578 * initialized separately.
3582 void av_init_packet(AVPacket *pkt);
3585 * Allocate the payload of a packet and initialize its fields with
3589 * @param size wanted payload size
3590 * @return 0 if OK, AVERROR_xxx otherwise
3592 int av_new_packet(AVPacket *pkt, int size);
3595 * Reduce packet size, correctly zeroing padding
3598 * @param size new size
3600 void av_shrink_packet(AVPacket *pkt, int size);
3603 * Increase packet size, correctly zeroing padding
3606 * @param grow_by number of bytes by which to increase the size of the packet
3608 int av_grow_packet(AVPacket *pkt, int grow_by);
3611 * Initialize a reference-counted packet from av_malloc()ed data.
3613 * @param pkt packet to be initialized. This function will set the data, size,
3614 * buf and destruct fields, all others are left untouched.
3615 * @param data Data allocated by av_malloc() to be used as packet data. If this
3616 * function returns successfully, the data is owned by the underlying AVBuffer.
3617 * The caller may not access the data through other means.
3618 * @param size size of data in bytes, without the padding. I.e. the full buffer
3619 * size is assumed to be size + FF_INPUT_BUFFER_PADDING_SIZE.
3621 * @return 0 on success, a negative AVERROR on error
3623 int av_packet_from_data(AVPacket *pkt, uint8_t *data, int size);
3626 * @warning This is a hack - the packet memory allocation stuff is broken. The
3627 * packet is allocated if it was not really allocated.
3629 int av_dup_packet(AVPacket *pkt);
3632 * Copy packet, including contents
3634 * @return 0 on success, negative AVERROR on fail
3636 int av_copy_packet(AVPacket *dst, const AVPacket *src);
3639 * Copy packet side data
3641 * @return 0 on success, negative AVERROR on fail
3643 int av_copy_packet_side_data(AVPacket *dst, const AVPacket *src);
3648 * @param pkt packet to free
3650 void av_free_packet(AVPacket *pkt);
3653 * Allocate new information of a packet.
3656 * @param type side information type
3657 * @param size side information size
3658 * @return pointer to fresh allocated data or NULL otherwise
3660 uint8_t* av_packet_new_side_data(AVPacket *pkt, enum AVPacketSideDataType type,
3664 * Shrink the already allocated side data buffer
3667 * @param type side information type
3668 * @param size new side information size
3669 * @return 0 on success, < 0 on failure
3671 int av_packet_shrink_side_data(AVPacket *pkt, enum AVPacketSideDataType type,
3675 * Get side information from packet.
3678 * @param type desired side information type
3679 * @param size pointer for side information size to store (optional)
3680 * @return pointer to data if present or NULL otherwise
3682 uint8_t* av_packet_get_side_data(AVPacket *pkt, enum AVPacketSideDataType type,
3685 int av_packet_merge_side_data(AVPacket *pkt);
3687 int av_packet_split_side_data(AVPacket *pkt);
3690 * Pack a dictionary for use in side_data.
3692 * @param dict The dictionary to pack.
3693 * @param size pointer to store the size of the returned data
3694 * @return pointer to data if successful, NULL otherwise
3696 uint8_t *av_packet_pack_dictionary(AVDictionary *dict, int *size);
3698 * Unpack a dictionary from side_data.
3700 * @param data data from side_data
3701 * @param size size of the data
3702 * @param dict the metadata storage dictionary
3703 * @return 0 on success, < 0 on failure
3705 int av_packet_unpack_dictionary(const uint8_t *data, int size, AVDictionary **dict);
3709 * Convenience function to free all the side data stored.
3710 * All the other fields stay untouched.
3714 void av_packet_free_side_data(AVPacket *pkt);
3717 * Setup a new reference to the data described by a given packet
3719 * If src is reference-counted, setup dst as a new reference to the
3720 * buffer in src. Otherwise allocate a new buffer in dst and copy the
3721 * data from src into it.
3723 * All the other fields are copied from src.
3725 * @see av_packet_unref
3727 * @param dst Destination packet
3728 * @param src Source packet
3730 * @return 0 on success, a negative AVERROR on error.
3732 int av_packet_ref(AVPacket *dst, const AVPacket *src);
3737 * Unreference the buffer referenced by the packet and reset the
3738 * remaining packet fields to their default values.
3740 * @param pkt The packet to be unreferenced.
3742 void av_packet_unref(AVPacket *pkt);
3745 * Move every field in src to dst and reset src.
3747 * @see av_packet_unref
3749 * @param src Source packet, will be reset
3750 * @param dst Destination packet
3752 void av_packet_move_ref(AVPacket *dst, AVPacket *src);
3755 * Copy only "properties" fields from src to dst.
3757 * Properties for the purpose of this function are all the fields
3758 * beside those related to the packet data (buf, data, size)
3760 * @param dst Destination packet
3761 * @param src Source packet
3763 * @return 0 on success AVERROR on failure.
3766 int av_packet_copy_props(AVPacket *dst, const AVPacket *src);
3773 * @addtogroup lavc_decoding
3778 * Find a registered decoder with a matching codec ID.
3780 * @param id AVCodecID of the requested decoder
3781 * @return A decoder if one was found, NULL otherwise.
3783 AVCodec *avcodec_find_decoder(enum AVCodecID id);
3786 * Find a registered decoder with the specified name.
3788 * @param name name of the requested decoder
3789 * @return A decoder if one was found, NULL otherwise.
3791 AVCodec *avcodec_find_decoder_by_name(const char *name);
3793 #if FF_API_GET_BUFFER
3794 attribute_deprecated int avcodec_default_get_buffer(AVCodecContext *s, AVFrame *pic);
3795 attribute_deprecated void avcodec_default_release_buffer(AVCodecContext *s, AVFrame *pic);
3796 attribute_deprecated int avcodec_default_reget_buffer(AVCodecContext *s, AVFrame *pic);
3800 * The default callback for AVCodecContext.get_buffer2(). It is made public so
3801 * it can be called by custom get_buffer2() implementations for decoders without
3802 * CODEC_CAP_DR1 set.
3804 int avcodec_default_get_buffer2(AVCodecContext *s, AVFrame *frame, int flags);
3808 * Return the amount of padding in pixels which the get_buffer callback must
3809 * provide around the edge of the image for codecs which do not have the
3810 * CODEC_FLAG_EMU_EDGE flag.
3812 * @return Required padding in pixels.
3814 * @deprecated CODEC_FLAG_EMU_EDGE is deprecated, so this function is no longer
3817 attribute_deprecated
3818 unsigned avcodec_get_edge_width(void);
3822 * Modify width and height values so that they will result in a memory
3823 * buffer that is acceptable for the codec if you do not use any horizontal
3826 * May only be used if a codec with CODEC_CAP_DR1 has been opened.
3828 void avcodec_align_dimensions(AVCodecContext *s, int *width, int *height);
3831 * Modify width and height values so that they will result in a memory
3832 * buffer that is acceptable for the codec if you also ensure that all
3833 * line sizes are a multiple of the respective linesize_align[i].
3835 * May only be used if a codec with CODEC_CAP_DR1 has been opened.
3837 void avcodec_align_dimensions2(AVCodecContext *s, int *width, int *height,
3838 int linesize_align[AV_NUM_DATA_POINTERS]);
3841 * Converts AVChromaLocation to swscale x/y chroma position.
3843 * The positions represent the chroma (0,0) position in a coordinates system
3844 * with luma (0,0) representing the origin and luma(1,1) representing 256,256
3846 * @param xpos horizontal chroma sample position
3847 * @param ypos vertical chroma sample position
3849 int avcodec_enum_to_chroma_pos(int *xpos, int *ypos, enum AVChromaLocation pos);
3852 * Converts swscale x/y chroma position to AVChromaLocation.
3854 * The positions represent the chroma (0,0) position in a coordinates system
3855 * with luma (0,0) representing the origin and luma(1,1) representing 256,256
3857 * @param xpos horizontal chroma sample position
3858 * @param ypos vertical chroma sample position
3860 enum AVChromaLocation avcodec_chroma_pos_to_enum(int xpos, int ypos);
3862 #if FF_API_OLD_DECODE_AUDIO
3864 * Wrapper function which calls avcodec_decode_audio4.
3866 * @deprecated Use avcodec_decode_audio4 instead.
3868 * Decode the audio frame of size avpkt->size from avpkt->data into samples.
3869 * Some decoders may support multiple frames in a single AVPacket, such
3870 * decoders would then just decode the first frame. In this case,
3871 * avcodec_decode_audio3 has to be called again with an AVPacket that contains
3872 * the remaining data in order to decode the second frame etc.
3874 * could be outputted, frame_size_ptr is zero. Otherwise, it is the
3875 * decompressed frame size in bytes.
3877 * @warning You must set frame_size_ptr to the allocated size of the
3878 * output buffer before calling avcodec_decode_audio3().
3880 * @warning The input buffer must be FF_INPUT_BUFFER_PADDING_SIZE larger than
3881 * the actual read bytes because some optimized bitstream readers read 32 or 64
3882 * bits at once and could read over the end.
3884 * @warning The end of the input buffer avpkt->data should be set to 0 to ensure that
3885 * no overreading happens for damaged MPEG streams.
3887 * @warning You must not provide a custom get_buffer() when using
3888 * avcodec_decode_audio3(). Doing so will override it with
3889 * avcodec_default_get_buffer. Use avcodec_decode_audio4() instead,
3890 * which does allow the application to provide a custom get_buffer().
3892 * @note You might have to align the input buffer avpkt->data and output buffer
3893 * samples. The alignment requirements depend on the CPU: On some CPUs it isn't
3894 * necessary at all, on others it won't work at all if not aligned and on others
3895 * it will work but it will have an impact on performance.
3897 * In practice, avpkt->data should have 4 byte alignment at minimum and
3898 * samples should be 16 byte aligned unless the CPU doesn't need it
3899 * (AltiVec and SSE do).
3901 * @note Codecs which have the CODEC_CAP_DELAY capability set have a delay
3902 * between input and output, these need to be fed with avpkt->data=NULL,
3903 * avpkt->size=0 at the end to return the remaining frames.
3905 * @param avctx the codec context
3906 * @param[out] samples the output buffer, sample type in avctx->sample_fmt
3907 * If the sample format is planar, each channel plane will
3908 * be the same size, with no padding between channels.
3909 * @param[in,out] frame_size_ptr the output buffer size in bytes
3910 * @param[in] avpkt The input AVPacket containing the input buffer.
3911 * You can create such packet with av_init_packet() and by then setting
3912 * data and size, some decoders might in addition need other fields.
3913 * All decoders are designed to use the least fields possible though.
3914 * @return On error a negative value is returned, otherwise the number of bytes
3915 * used or zero if no frame data was decompressed (used) from the input AVPacket.
3917 attribute_deprecated int avcodec_decode_audio3(AVCodecContext *avctx, int16_t *samples,
3918 int *frame_size_ptr,
3923 * Decode the audio frame of size avpkt->size from avpkt->data into frame.
3925 * Some decoders may support multiple frames in a single AVPacket. Such
3926 * decoders would then just decode the first frame and the return value would be
3927 * less than the packet size. In this case, avcodec_decode_audio4 has to be
3928 * called again with an AVPacket containing the remaining data in order to
3929 * decode the second frame, etc... Even if no frames are returned, the packet
3930 * needs to be fed to the decoder with remaining data until it is completely
3931 * consumed or an error occurs.
3933 * Some decoders (those marked with CODEC_CAP_DELAY) have a delay between input
3934 * and output. This means that for some packets they will not immediately
3935 * produce decoded output and need to be flushed at the end of decoding to get
3936 * all the decoded data. Flushing is done by calling this function with packets
3937 * with avpkt->data set to NULL and avpkt->size set to 0 until it stops
3938 * returning samples. It is safe to flush even those decoders that are not
3939 * marked with CODEC_CAP_DELAY, then no samples will be returned.
3941 * @warning The input buffer, avpkt->data must be FF_INPUT_BUFFER_PADDING_SIZE
3942 * larger than the actual read bytes because some optimized bitstream
3943 * readers read 32 or 64 bits at once and could read over the end.
3945 * @param avctx the codec context
3946 * @param[out] frame The AVFrame in which to store decoded audio samples.
3947 * The decoder will allocate a buffer for the decoded frame by
3948 * calling the AVCodecContext.get_buffer2() callback.
3949 * When AVCodecContext.refcounted_frames is set to 1, the frame is
3950 * reference counted and the returned reference belongs to the
3951 * caller. The caller must release the frame using av_frame_unref()
3952 * when the frame is no longer needed. The caller may safely write
3953 * to the frame if av_frame_is_writable() returns 1.
3954 * When AVCodecContext.refcounted_frames is set to 0, the returned
3955 * reference belongs to the decoder and is valid only until the
3956 * next call to this function or until closing or flushing the
3957 * decoder. The caller may not write to it.
3958 * @param[out] got_frame_ptr Zero if no frame could be decoded, otherwise it is
3959 * non-zero. Note that this field being set to zero
3960 * does not mean that an error has occurred. For
3961 * decoders with CODEC_CAP_DELAY set, no given decode
3962 * call is guaranteed to produce a frame.
3963 * @param[in] avpkt The input AVPacket containing the input buffer.
3964 * At least avpkt->data and avpkt->size should be set. Some
3965 * decoders might also require additional fields to be set.
3966 * @return A negative error code is returned if an error occurred during
3967 * decoding, otherwise the number of bytes consumed from the input
3968 * AVPacket is returned.
3970 int avcodec_decode_audio4(AVCodecContext *avctx, AVFrame *frame,
3971 int *got_frame_ptr, const AVPacket *avpkt);
3974 * Decode the video frame of size avpkt->size from avpkt->data into picture.
3975 * Some decoders may support multiple frames in a single AVPacket, such
3976 * decoders would then just decode the first frame.
3978 * @warning The input buffer must be FF_INPUT_BUFFER_PADDING_SIZE larger than
3979 * the actual read bytes because some optimized bitstream readers read 32 or 64
3980 * bits at once and could read over the end.
3982 * @warning The end of the input buffer buf should be set to 0 to ensure that
3983 * no overreading happens for damaged MPEG streams.
3985 * @note Codecs which have the CODEC_CAP_DELAY capability set have a delay
3986 * between input and output, these need to be fed with avpkt->data=NULL,
3987 * avpkt->size=0 at the end to return the remaining frames.
3989 * @param avctx the codec context
3990 * @param[out] picture The AVFrame in which the decoded video frame will be stored.
3991 * Use av_frame_alloc() to get an AVFrame. The codec will
3992 * allocate memory for the actual bitmap by calling the
3993 * AVCodecContext.get_buffer2() callback.
3994 * When AVCodecContext.refcounted_frames is set to 1, the frame is
3995 * reference counted and the returned reference belongs to the
3996 * caller. The caller must release the frame using av_frame_unref()
3997 * when the frame is no longer needed. The caller may safely write
3998 * to the frame if av_frame_is_writable() returns 1.
3999 * When AVCodecContext.refcounted_frames is set to 0, the returned
4000 * reference belongs to the decoder and is valid only until the
4001 * next call to this function or until closing or flushing the
4002 * decoder. The caller may not write to it.
4004 * @param[in] avpkt The input AVPacket containing the input buffer.
4005 * You can create such packet with av_init_packet() and by then setting
4006 * data and size, some decoders might in addition need other fields like
4007 * flags&AV_PKT_FLAG_KEY. All decoders are designed to use the least
4009 * @param[in,out] got_picture_ptr Zero if no frame could be decompressed, otherwise, it is nonzero.
4010 * @return On error a negative value is returned, otherwise the number of bytes
4011 * used or zero if no frame could be decompressed.
4013 int avcodec_decode_video2(AVCodecContext *avctx, AVFrame *picture,
4014 int *got_picture_ptr,
4015 const AVPacket *avpkt);
4018 * Decode a subtitle message.
4019 * Return a negative value on error, otherwise return the number of bytes used.
4020 * If no subtitle could be decompressed, got_sub_ptr is zero.
4021 * Otherwise, the subtitle is stored in *sub.
4022 * Note that CODEC_CAP_DR1 is not available for subtitle codecs. This is for
4023 * simplicity, because the performance difference is expect to be negligible
4024 * and reusing a get_buffer written for video codecs would probably perform badly
4025 * due to a potentially very different allocation pattern.
4027 * Some decoders (those marked with CODEC_CAP_DELAY) have a delay between input
4028 * and output. This means that for some packets they will not immediately
4029 * produce decoded output and need to be flushed at the end of decoding to get
4030 * all the decoded data. Flushing is done by calling this function with packets
4031 * with avpkt->data set to NULL and avpkt->size set to 0 until it stops
4032 * returning subtitles. It is safe to flush even those decoders that are not
4033 * marked with CODEC_CAP_DELAY, then no subtitles will be returned.
4035 * @param avctx the codec context
4036 * @param[out] sub The AVSubtitle in which the decoded subtitle will be stored, must be
4037 freed with avsubtitle_free if *got_sub_ptr is set.
4038 * @param[in,out] got_sub_ptr Zero if no subtitle could be decompressed, otherwise, it is nonzero.
4039 * @param[in] avpkt The input AVPacket containing the input buffer.
4041 int avcodec_decode_subtitle2(AVCodecContext *avctx, AVSubtitle *sub,
4046 * @defgroup lavc_parsing Frame parsing
4050 enum AVPictureStructure {
4051 AV_PICTURE_STRUCTURE_UNKNOWN, //< unknown
4052 AV_PICTURE_STRUCTURE_TOP_FIELD, //< coded as top field
4053 AV_PICTURE_STRUCTURE_BOTTOM_FIELD, //< coded as bottom field
4054 AV_PICTURE_STRUCTURE_FRAME, //< coded as frame
4057 typedef struct AVCodecParserContext {
4059 struct AVCodecParser *parser;
4060 int64_t frame_offset; /* offset of the current frame */
4061 int64_t cur_offset; /* current offset
4062 (incremented by each av_parser_parse()) */
4063 int64_t next_frame_offset; /* offset of the next frame */
4065 int pict_type; /* XXX: Put it back in AVCodecContext. */
4067 * This field is used for proper frame duration computation in lavf.
4068 * It signals, how much longer the frame duration of the current frame
4069 * is compared to normal frame duration.
4071 * frame_duration = (1 + repeat_pict) * time_base
4073 * It is used by codecs like H.264 to display telecined material.
4075 int repeat_pict; /* XXX: Put it back in AVCodecContext. */
4076 int64_t pts; /* pts of the current frame */
4077 int64_t dts; /* dts of the current frame */
4082 int fetch_timestamp;
4084 #define AV_PARSER_PTS_NB 4
4085 int cur_frame_start_index;
4086 int64_t cur_frame_offset[AV_PARSER_PTS_NB];
4087 int64_t cur_frame_pts[AV_PARSER_PTS_NB];
4088 int64_t cur_frame_dts[AV_PARSER_PTS_NB];
4091 #define PARSER_FLAG_COMPLETE_FRAMES 0x0001
4092 #define PARSER_FLAG_ONCE 0x0002
4093 /// Set if the parser has a valid file offset
4094 #define PARSER_FLAG_FETCHED_OFFSET 0x0004
4095 #define PARSER_FLAG_USE_CODEC_TS 0x1000
4097 int64_t offset; ///< byte offset from starting packet start
4098 int64_t cur_frame_end[AV_PARSER_PTS_NB];
4101 * Set by parser to 1 for key frames and 0 for non-key frames.
4102 * It is initialized to -1, so if the parser doesn't set this flag,
4103 * old-style fallback using AV_PICTURE_TYPE_I picture type as key frames
4109 * Time difference in stream time base units from the pts of this
4110 * packet to the point at which the output from the decoder has converged
4111 * independent from the availability of previous frames. That is, the
4112 * frames are virtually identical no matter if decoding started from
4113 * the very first frame or from this keyframe.
4114 * Is AV_NOPTS_VALUE if unknown.
4115 * This field is not the display duration of the current frame.
4116 * This field has no meaning if the packet does not have AV_PKT_FLAG_KEY
4119 * The purpose of this field is to allow seeking in streams that have no
4120 * keyframes in the conventional sense. It corresponds to the
4121 * recovery point SEI in H.264 and match_time_delta in NUT. It is also
4122 * essential for some types of subtitle streams to ensure that all
4123 * subtitles are correctly displayed after seeking.
4125 int64_t convergence_duration;
4127 // Timestamp generation support:
4129 * Synchronization point for start of timestamp generation.
4131 * Set to >0 for sync point, 0 for no sync point and <0 for undefined
4134 * For example, this corresponds to presence of H.264 buffering period
4140 * Offset of the current timestamp against last timestamp sync point in
4141 * units of AVCodecContext.time_base.
4143 * Set to INT_MIN when dts_sync_point unused. Otherwise, it must
4144 * contain a valid timestamp offset.
4146 * Note that the timestamp of sync point has usually a nonzero
4147 * dts_ref_dts_delta, which refers to the previous sync point. Offset of
4148 * the next frame after timestamp sync point will be usually 1.
4150 * For example, this corresponds to H.264 cpb_removal_delay.
4152 int dts_ref_dts_delta;
4155 * Presentation delay of current frame in units of AVCodecContext.time_base.
4157 * Set to INT_MIN when dts_sync_point unused. Otherwise, it must
4158 * contain valid non-negative timestamp delta (presentation time of a frame
4159 * must not lie in the past).
4161 * This delay represents the difference between decoding and presentation
4162 * time of the frame.
4164 * For example, this corresponds to H.264 dpb_output_delay.
4169 * Position of the packet in file.
4171 * Analogous to cur_frame_pts/dts
4173 int64_t cur_frame_pos[AV_PARSER_PTS_NB];
4176 * Byte position of currently parsed frame in stream.
4181 * Previous frame byte position.
4186 * Duration of the current frame.
4187 * For audio, this is in units of 1 / AVCodecContext.sample_rate.
4188 * For all other types, this is in units of AVCodecContext.time_base.
4192 enum AVFieldOrder field_order;
4195 * Indicate whether a picture is coded as a frame, top field or bottom field.
4197 * For example, H.264 field_pic_flag equal to 0 corresponds to
4198 * AV_PICTURE_STRUCTURE_FRAME. An H.264 picture with field_pic_flag
4199 * equal to 1 and bottom_field_flag equal to 0 corresponds to
4200 * AV_PICTURE_STRUCTURE_TOP_FIELD.
4202 enum AVPictureStructure picture_structure;
4205 * Picture number incremented in presentation or output order.
4206 * This field may be reinitialized at the first picture of a new sequence.
4208 * For example, this corresponds to H.264 PicOrderCnt.
4210 int output_picture_number;
4211 } AVCodecParserContext;
4213 typedef struct AVCodecParser {
4214 int codec_ids[5]; /* several codec IDs are permitted */
4216 int (*parser_init)(AVCodecParserContext *s);
4217 int (*parser_parse)(AVCodecParserContext *s,
4218 AVCodecContext *avctx,
4219 const uint8_t **poutbuf, int *poutbuf_size,
4220 const uint8_t *buf, int buf_size);
4221 void (*parser_close)(AVCodecParserContext *s);
4222 int (*split)(AVCodecContext *avctx, const uint8_t *buf, int buf_size);
4223 struct AVCodecParser *next;
4226 AVCodecParser *av_parser_next(AVCodecParser *c);
4228 void av_register_codec_parser(AVCodecParser *parser);
4229 AVCodecParserContext *av_parser_init(int codec_id);
4234 * @param s parser context.
4235 * @param avctx codec context.
4236 * @param poutbuf set to pointer to parsed buffer or NULL if not yet finished.
4237 * @param poutbuf_size set to size of parsed buffer or zero if not yet finished.
4238 * @param buf input buffer.
4239 * @param buf_size input length, to signal EOF, this should be 0 (so that the last frame can be output).
4240 * @param pts input presentation timestamp.
4241 * @param dts input decoding timestamp.
4242 * @param pos input byte position in stream.
4243 * @return the number of bytes of the input bitstream used.
4248 * len = av_parser_parse2(myparser, AVCodecContext, &data, &size,
4255 * decode_frame(data, size);
4259 int av_parser_parse2(AVCodecParserContext *s,
4260 AVCodecContext *avctx,
4261 uint8_t **poutbuf, int *poutbuf_size,
4262 const uint8_t *buf, int buf_size,
4263 int64_t pts, int64_t dts,
4267 * @return 0 if the output buffer is a subset of the input, 1 if it is allocated and must be freed
4268 * @deprecated use AVBitStreamFilter
4270 int av_parser_change(AVCodecParserContext *s,
4271 AVCodecContext *avctx,
4272 uint8_t **poutbuf, int *poutbuf_size,
4273 const uint8_t *buf, int buf_size, int keyframe);
4274 void av_parser_close(AVCodecParserContext *s);
4282 * @addtogroup lavc_encoding
4287 * Find a registered encoder with a matching codec ID.
4289 * @param id AVCodecID of the requested encoder
4290 * @return An encoder if one was found, NULL otherwise.
4292 AVCodec *avcodec_find_encoder(enum AVCodecID id);
4295 * Find a registered encoder with the specified name.
4297 * @param name name of the requested encoder
4298 * @return An encoder if one was found, NULL otherwise.
4300 AVCodec *avcodec_find_encoder_by_name(const char *name);
4302 #if FF_API_OLD_ENCODE_AUDIO
4304 * Encode an audio frame from samples into buf.
4306 * @deprecated Use avcodec_encode_audio2 instead.
4308 * @note The output buffer should be at least FF_MIN_BUFFER_SIZE bytes large.
4309 * However, for codecs with avctx->frame_size equal to 0 (e.g. PCM) the user
4310 * will know how much space is needed because it depends on the value passed
4311 * in buf_size as described below. In that case a lower value can be used.
4313 * @param avctx the codec context
4314 * @param[out] buf the output buffer
4315 * @param[in] buf_size the output buffer size
4316 * @param[in] samples the input buffer containing the samples
4317 * The number of samples read from this buffer is frame_size*channels,
4318 * both of which are defined in avctx.
4319 * For codecs which have avctx->frame_size equal to 0 (e.g. PCM) the number of
4320 * samples read from samples is equal to:
4321 * buf_size * 8 / (avctx->channels * av_get_bits_per_sample(avctx->codec_id))
4322 * This also implies that av_get_bits_per_sample() must not return 0 for these
4324 * @return On error a negative value is returned, on success zero or the number
4325 * of bytes used to encode the data read from the input buffer.
4327 int attribute_deprecated avcodec_encode_audio(AVCodecContext *avctx,
4328 uint8_t *buf, int buf_size,
4329 const short *samples);
4333 * Encode a frame of audio.
4335 * Takes input samples from frame and writes the next output packet, if
4336 * available, to avpkt. The output packet does not necessarily contain data for
4337 * the most recent frame, as encoders can delay, split, and combine input frames
4338 * internally as needed.
4340 * @param avctx codec context
4341 * @param avpkt output AVPacket.
4342 * The user can supply an output buffer by setting
4343 * avpkt->data and avpkt->size prior to calling the
4344 * function, but if the size of the user-provided data is not
4345 * large enough, encoding will fail. If avpkt->data and
4346 * avpkt->size are set, avpkt->destruct must also be set. All
4347 * other AVPacket fields will be reset by the encoder using
4348 * av_init_packet(). If avpkt->data is NULL, the encoder will
4349 * allocate it. The encoder will set avpkt->size to the size
4350 * of the output packet.
4352 * If this function fails or produces no output, avpkt will be
4353 * freed using av_free_packet() (i.e. avpkt->destruct will be
4354 * called to free the user supplied buffer).
4355 * @param[in] frame AVFrame containing the raw audio data to be encoded.
4356 * May be NULL when flushing an encoder that has the
4357 * CODEC_CAP_DELAY capability set.
4358 * If CODEC_CAP_VARIABLE_FRAME_SIZE is set, then each frame
4359 * can have any number of samples.
4360 * If it is not set, frame->nb_samples must be equal to
4361 * avctx->frame_size for all frames except the last.
4362 * The final frame may be smaller than avctx->frame_size.
4363 * @param[out] got_packet_ptr This field is set to 1 by libavcodec if the
4364 * output packet is non-empty, and to 0 if it is
4365 * empty. If the function returns an error, the
4366 * packet can be assumed to be invalid, and the
4367 * value of got_packet_ptr is undefined and should
4369 * @return 0 on success, negative error code on failure
4371 int avcodec_encode_audio2(AVCodecContext *avctx, AVPacket *avpkt,
4372 const AVFrame *frame, int *got_packet_ptr);
4374 #if FF_API_OLD_ENCODE_VIDEO
4376 * @deprecated use avcodec_encode_video2() instead.
4378 * Encode a video frame from pict into buf.
4379 * The input picture should be
4380 * stored using a specific format, namely avctx.pix_fmt.
4382 * @param avctx the codec context
4383 * @param[out] buf the output buffer for the bitstream of encoded frame
4384 * @param[in] buf_size the size of the output buffer in bytes
4385 * @param[in] pict the input picture to encode
4386 * @return On error a negative value is returned, on success zero or the number
4387 * of bytes used from the output buffer.
4389 attribute_deprecated
4390 int avcodec_encode_video(AVCodecContext *avctx, uint8_t *buf, int buf_size,
4391 const AVFrame *pict);
4395 * Encode a frame of video.
4397 * Takes input raw video data from frame and writes the next output packet, if
4398 * available, to avpkt. The output packet does not necessarily contain data for
4399 * the most recent frame, as encoders can delay and reorder input frames
4400 * internally as needed.
4402 * @param avctx codec context
4403 * @param avpkt output AVPacket.
4404 * The user can supply an output buffer by setting
4405 * avpkt->data and avpkt->size prior to calling the
4406 * function, but if the size of the user-provided data is not
4407 * large enough, encoding will fail. All other AVPacket fields
4408 * will be reset by the encoder using av_init_packet(). If
4409 * avpkt->data is NULL, the encoder will allocate it.
4410 * The encoder will set avpkt->size to the size of the
4411 * output packet. The returned data (if any) belongs to the
4412 * caller, he is responsible for freeing it.
4414 * If this function fails or produces no output, avpkt will be
4415 * freed using av_free_packet() (i.e. avpkt->destruct will be
4416 * called to free the user supplied buffer).
4417 * @param[in] frame AVFrame containing the raw video data to be encoded.
4418 * May be NULL when flushing an encoder that has the
4419 * CODEC_CAP_DELAY capability set.
4420 * @param[out] got_packet_ptr This field is set to 1 by libavcodec if the
4421 * output packet is non-empty, and to 0 if it is
4422 * empty. If the function returns an error, the
4423 * packet can be assumed to be invalid, and the
4424 * value of got_packet_ptr is undefined and should
4426 * @return 0 on success, negative error code on failure
4428 int avcodec_encode_video2(AVCodecContext *avctx, AVPacket *avpkt,
4429 const AVFrame *frame, int *got_packet_ptr);
4431 int avcodec_encode_subtitle(AVCodecContext *avctx, uint8_t *buf, int buf_size,
4432 const AVSubtitle *sub);
4439 #if FF_API_AVCODEC_RESAMPLE
4441 * @defgroup lavc_resample Audio resampling
4443 * @deprecated use libswresample instead
4447 struct ReSampleContext;
4448 struct AVResampleContext;
4450 typedef struct ReSampleContext ReSampleContext;
4453 * Initialize audio resampling context.
4455 * @param output_channels number of output channels
4456 * @param input_channels number of input channels
4457 * @param output_rate output sample rate
4458 * @param input_rate input sample rate
4459 * @param sample_fmt_out requested output sample format
4460 * @param sample_fmt_in input sample format
4461 * @param filter_length length of each FIR filter in the filterbank relative to the cutoff frequency
4462 * @param log2_phase_count log2 of the number of entries in the polyphase filterbank
4463 * @param linear if 1 then the used FIR filter will be linearly interpolated
4464 between the 2 closest, if 0 the closest will be used
4465 * @param cutoff cutoff frequency, 1.0 corresponds to half the output sampling rate
4466 * @return allocated ReSampleContext, NULL if error occurred
4468 attribute_deprecated
4469 ReSampleContext *av_audio_resample_init(int output_channels, int input_channels,
4470 int output_rate, int input_rate,
4471 enum AVSampleFormat sample_fmt_out,
4472 enum AVSampleFormat sample_fmt_in,
4473 int filter_length, int log2_phase_count,
4474 int linear, double cutoff);
4476 attribute_deprecated
4477 int audio_resample(ReSampleContext *s, short *output, short *input, int nb_samples);
4480 * Free resample context.
4482 * @param s a non-NULL pointer to a resample context previously
4483 * created with av_audio_resample_init()
4485 attribute_deprecated
4486 void audio_resample_close(ReSampleContext *s);
4490 * Initialize an audio resampler.
4491 * Note, if either rate is not an integer then simply scale both rates up so they are.
4492 * @param filter_length length of each FIR filter in the filterbank relative to the cutoff freq
4493 * @param log2_phase_count log2 of the number of entries in the polyphase filterbank
4494 * @param linear If 1 then the used FIR filter will be linearly interpolated
4495 between the 2 closest, if 0 the closest will be used
4496 * @param cutoff cutoff frequency, 1.0 corresponds to half the output sampling rate
4498 attribute_deprecated
4499 struct AVResampleContext *av_resample_init(int out_rate, int in_rate, int filter_length, int log2_phase_count, int linear, double cutoff);
4502 * Resample an array of samples using a previously configured context.
4503 * @param src an array of unconsumed samples
4504 * @param consumed the number of samples of src which have been consumed are returned here
4505 * @param src_size the number of unconsumed samples available
4506 * @param dst_size the amount of space in samples available in dst
4507 * @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.
4508 * @return the number of samples written in dst or -1 if an error occurred
4510 attribute_deprecated
4511 int av_resample(struct AVResampleContext *c, short *dst, short *src, int *consumed, int src_size, int dst_size, int update_ctx);
4515 * Compensate samplerate/timestamp drift. The compensation is done by changing
4516 * the resampler parameters, so no audible clicks or similar distortions occur
4517 * @param compensation_distance distance in output samples over which the compensation should be performed
4518 * @param sample_delta number of output samples which should be output less
4520 * example: av_resample_compensate(c, 10, 500)
4521 * here instead of 510 samples only 500 samples would be output
4523 * note, due to rounding the actual compensation might be slightly different,
4524 * especially if the compensation_distance is large and the in_rate used during init is small
4526 attribute_deprecated
4527 void av_resample_compensate(struct AVResampleContext *c, int sample_delta, int compensation_distance);
4528 attribute_deprecated
4529 void av_resample_close(struct AVResampleContext *c);
4537 * @addtogroup lavc_picture
4542 * Allocate memory for the pixels of a picture and setup the AVPicture
4545 * Call avpicture_free() to free it.
4547 * @param picture the picture structure to be filled in
4548 * @param pix_fmt the pixel format of the picture
4549 * @param width the width of the picture
4550 * @param height the height of the picture
4551 * @return zero if successful, a negative error code otherwise
4553 * @see av_image_alloc(), avpicture_fill()
4555 int avpicture_alloc(AVPicture *picture, enum AVPixelFormat pix_fmt, int width, int height);
4558 * Free a picture previously allocated by avpicture_alloc().
4559 * The data buffer used by the AVPicture is freed, but the AVPicture structure
4562 * @param picture the AVPicture to be freed
4564 void avpicture_free(AVPicture *picture);
4567 * Setup the picture fields based on the specified image parameters
4568 * and the provided image data buffer.
4570 * The picture fields are filled in by using the image data buffer
4571 * pointed to by ptr.
4573 * If ptr is NULL, the function will fill only the picture linesize
4574 * array and return the required size for the image buffer.
4576 * To allocate an image buffer and fill the picture data in one call,
4577 * use avpicture_alloc().
4579 * @param picture the picture to be filled in
4580 * @param ptr buffer where the image data is stored, or NULL
4581 * @param pix_fmt the pixel format of the image
4582 * @param width the width of the image in pixels
4583 * @param height the height of the image in pixels
4584 * @return the size in bytes required for src, a negative error code
4585 * in case of failure
4587 * @see av_image_fill_arrays()
4589 int avpicture_fill(AVPicture *picture, const uint8_t *ptr,
4590 enum AVPixelFormat pix_fmt, int width, int height);
4593 * Copy pixel data from an AVPicture into a buffer.
4595 * avpicture_get_size() can be used to compute the required size for
4596 * the buffer to fill.
4598 * @param src source picture with filled data
4599 * @param pix_fmt picture pixel format
4600 * @param width picture width
4601 * @param height picture height
4602 * @param dest destination buffer
4603 * @param dest_size destination buffer size in bytes
4604 * @return the number of bytes written to dest, or a negative value
4605 * (error code) on error, for example if the destination buffer is not
4608 * @see av_image_copy_to_buffer()
4610 int avpicture_layout(const AVPicture *src, enum AVPixelFormat pix_fmt,
4611 int width, int height,
4612 unsigned char *dest, int dest_size);
4615 * Calculate the size in bytes that a picture of the given width and height
4616 * would occupy if stored in the given picture format.
4618 * @param pix_fmt picture pixel format
4619 * @param width picture width
4620 * @param height picture height
4621 * @return the computed picture buffer size or a negative error code
4624 * @see av_image_get_buffer_size().
4626 int avpicture_get_size(enum AVPixelFormat pix_fmt, int width, int height);
4628 #if FF_API_DEINTERLACE
4630 * deinterlace - if not supported return -1
4632 * @deprecated - use yadif (in libavfilter) instead
4634 attribute_deprecated
4635 int avpicture_deinterlace(AVPicture *dst, const AVPicture *src,
4636 enum AVPixelFormat pix_fmt, int width, int height);
4639 * Copy image src to dst. Wraps av_image_copy().
4641 void av_picture_copy(AVPicture *dst, const AVPicture *src,
4642 enum AVPixelFormat pix_fmt, int width, int height);
4645 * Crop image top and left side.
4647 int av_picture_crop(AVPicture *dst, const AVPicture *src,
4648 enum AVPixelFormat pix_fmt, int top_band, int left_band);
4653 int av_picture_pad(AVPicture *dst, const AVPicture *src, int height, int width, enum AVPixelFormat pix_fmt,
4654 int padtop, int padbottom, int padleft, int padright, int *color);
4661 * @defgroup lavc_misc Utility functions
4664 * Miscellaneous utility functions related to both encoding and decoding
4670 * @defgroup lavc_misc_pixfmt Pixel formats
4672 * Functions for working with pixel formats.
4677 * Utility function to access log2_chroma_w log2_chroma_h from
4678 * the pixel format AVPixFmtDescriptor.
4680 * This function asserts that pix_fmt is valid. See av_pix_fmt_get_chroma_sub_sample
4681 * for one that returns a failure code and continues in case of invalid
4684 * @param[in] pix_fmt the pixel format
4685 * @param[out] h_shift store log2_chroma_w
4686 * @param[out] v_shift store log2_chroma_h
4688 * @see av_pix_fmt_get_chroma_sub_sample
4691 void avcodec_get_chroma_sub_sample(enum AVPixelFormat pix_fmt, int *h_shift, int *v_shift);
4694 * Return a value representing the fourCC code associated to the
4695 * pixel format pix_fmt, or 0 if no associated fourCC code can be
4698 unsigned int avcodec_pix_fmt_to_codec_tag(enum AVPixelFormat pix_fmt);
4701 * @deprecated see av_get_pix_fmt_loss()
4703 int avcodec_get_pix_fmt_loss(enum AVPixelFormat dst_pix_fmt, enum AVPixelFormat src_pix_fmt,
4707 * Find the best pixel format to convert to given a certain source pixel
4708 * format. When converting from one pixel format to another, information loss
4709 * may occur. For example, when converting from RGB24 to GRAY, the color
4710 * information will be lost. Similarly, other losses occur when converting from
4711 * some formats to other formats. avcodec_find_best_pix_fmt_of_2() searches which of
4712 * the given pixel formats should be used to suffer the least amount of loss.
4713 * The pixel formats from which it chooses one, are determined by the
4714 * pix_fmt_list parameter.
4717 * @param[in] pix_fmt_list AV_PIX_FMT_NONE terminated array of pixel formats to choose from
4718 * @param[in] src_pix_fmt source pixel format
4719 * @param[in] has_alpha Whether the source pixel format alpha channel is used.
4720 * @param[out] loss_ptr Combination of flags informing you what kind of losses will occur.
4721 * @return The best pixel format to convert to or -1 if none was found.
4723 enum AVPixelFormat avcodec_find_best_pix_fmt_of_list(const enum AVPixelFormat *pix_fmt_list,
4724 enum AVPixelFormat src_pix_fmt,
4725 int has_alpha, int *loss_ptr);
4728 * @deprecated see av_find_best_pix_fmt_of_2()
4730 enum AVPixelFormat avcodec_find_best_pix_fmt_of_2(enum AVPixelFormat dst_pix_fmt1, enum AVPixelFormat dst_pix_fmt2,
4731 enum AVPixelFormat src_pix_fmt, int has_alpha, int *loss_ptr);
4733 attribute_deprecated
4734 #if AV_HAVE_INCOMPATIBLE_LIBAV_ABI
4735 enum AVPixelFormat avcodec_find_best_pix_fmt2(const enum AVPixelFormat *pix_fmt_list,
4736 enum AVPixelFormat src_pix_fmt,
4737 int has_alpha, int *loss_ptr);
4739 enum AVPixelFormat avcodec_find_best_pix_fmt2(enum AVPixelFormat dst_pix_fmt1, enum AVPixelFormat dst_pix_fmt2,
4740 enum AVPixelFormat src_pix_fmt, int has_alpha, int *loss_ptr);
4744 enum AVPixelFormat avcodec_default_get_format(struct AVCodecContext *s, const enum AVPixelFormat * fmt);
4750 #if FF_API_SET_DIMENSIONS
4752 * @deprecated this function is not supposed to be used from outside of lavc
4754 attribute_deprecated
4755 void avcodec_set_dimensions(AVCodecContext *s, int width, int height);
4759 * Put a string representing the codec tag codec_tag in buf.
4761 * @param buf buffer to place codec tag in
4762 * @param buf_size size in bytes of buf
4763 * @param codec_tag codec tag to assign
4764 * @return the length of the string that would have been generated if
4765 * enough space had been available, excluding the trailing null
4767 size_t av_get_codec_tag_string(char *buf, size_t buf_size, unsigned int codec_tag);
4769 void avcodec_string(char *buf, int buf_size, AVCodecContext *enc, int encode);
4772 * Return a name for the specified profile, if available.
4774 * @param codec the codec that is searched for the given profile
4775 * @param profile the profile value for which a name is requested
4776 * @return A name for the profile if found, NULL otherwise.
4778 const char *av_get_profile_name(const AVCodec *codec, int profile);
4780 int avcodec_default_execute(AVCodecContext *c, int (*func)(AVCodecContext *c2, void *arg2),void *arg, int *ret, int count, int size);
4781 int avcodec_default_execute2(AVCodecContext *c, int (*func)(AVCodecContext *c2, void *arg2, int, int),void *arg, int *ret, int count);
4782 //FIXME func typedef
4785 * Fill AVFrame audio data and linesize pointers.
4787 * The buffer buf must be a preallocated buffer with a size big enough
4788 * to contain the specified samples amount. The filled AVFrame data
4789 * pointers will point to this buffer.
4791 * AVFrame extended_data channel pointers are allocated if necessary for
4794 * @param frame the AVFrame
4795 * frame->nb_samples must be set prior to calling the
4796 * function. This function fills in frame->data,
4797 * frame->extended_data, frame->linesize[0].
4798 * @param nb_channels channel count
4799 * @param sample_fmt sample format
4800 * @param buf buffer to use for frame data
4801 * @param buf_size size of buffer
4802 * @param align plane size sample alignment (0 = default)
4803 * @return >=0 on success, negative error code on failure
4804 * @todo return the size in bytes required to store the samples in
4805 * case of success, at the next libavutil bump
4807 int avcodec_fill_audio_frame(AVFrame *frame, int nb_channels,
4808 enum AVSampleFormat sample_fmt, const uint8_t *buf,
4809 int buf_size, int align);
4812 * Reset the internal decoder state / flush internal buffers. Should be called
4813 * e.g. when seeking or when switching to a different stream.
4815 * @note when refcounted frames are not used (i.e. avctx->refcounted_frames is 0),
4816 * this invalidates the frames previously returned from the decoder. When
4817 * refcounted frames are used, the decoder just releases any references it might
4818 * keep internally, but the caller's reference remains valid.
4820 void avcodec_flush_buffers(AVCodecContext *avctx);
4823 * Return codec bits per sample.
4825 * @param[in] codec_id the codec
4826 * @return Number of bits per sample or zero if unknown for the given codec.
4828 int av_get_bits_per_sample(enum AVCodecID codec_id);
4831 * Return the PCM codec associated with a sample format.
4832 * @param be endianness, 0 for little, 1 for big,
4833 * -1 (or anything else) for native
4834 * @return AV_CODEC_ID_PCM_* or AV_CODEC_ID_NONE
4836 enum AVCodecID av_get_pcm_codec(enum AVSampleFormat fmt, int be);
4839 * Return codec bits per sample.
4840 * Only return non-zero if the bits per sample is exactly correct, not an
4843 * @param[in] codec_id the codec
4844 * @return Number of bits per sample or zero if unknown for the given codec.
4846 int av_get_exact_bits_per_sample(enum AVCodecID codec_id);
4849 * Return audio frame duration.
4851 * @param avctx codec context
4852 * @param frame_bytes size of the frame, or 0 if unknown
4853 * @return frame duration, in samples, if known. 0 if not able to
4856 int av_get_audio_frame_duration(AVCodecContext *avctx, int frame_bytes);
4859 typedef struct AVBitStreamFilterContext {
4861 struct AVBitStreamFilter *filter;
4862 AVCodecParserContext *parser;
4863 struct AVBitStreamFilterContext *next;
4864 } AVBitStreamFilterContext;
4867 typedef struct AVBitStreamFilter {
4870 int (*filter)(AVBitStreamFilterContext *bsfc,
4871 AVCodecContext *avctx, const char *args,
4872 uint8_t **poutbuf, int *poutbuf_size,
4873 const uint8_t *buf, int buf_size, int keyframe);
4874 void (*close)(AVBitStreamFilterContext *bsfc);
4875 struct AVBitStreamFilter *next;
4876 } AVBitStreamFilter;
4879 * Register a bitstream filter.
4881 * The filter will be accessible to the application code through
4882 * av_bitstream_filter_next() or can be directly initialized with
4883 * av_bitstream_filter_init().
4885 * @see avcodec_register_all()
4887 void av_register_bitstream_filter(AVBitStreamFilter *bsf);
4890 * Create and initialize a bitstream filter context given a bitstream
4893 * The returned context must be freed with av_bitstream_filter_close().
4895 * @param name the name of the bitstream filter
4896 * @return a bitstream filter context if a matching filter was found
4897 * and successfully initialized, NULL otherwise
4899 AVBitStreamFilterContext *av_bitstream_filter_init(const char *name);
4904 * This function filters the buffer buf with size buf_size, and places the
4905 * filtered buffer in the buffer pointed to by poutbuf.
4907 * The output buffer must be freed by the caller.
4909 * @param bsfc bitstream filter context created by av_bitstream_filter_init()
4910 * @param avctx AVCodecContext accessed by the filter, may be NULL.
4911 * If specified, this must point to the encoder context of the
4912 * output stream the packet is sent to.
4913 * @param args arguments which specify the filter configuration, may be NULL
4914 * @param poutbuf pointer which is updated to point to the filtered buffer
4915 * @param poutbuf_size pointer which is updated to the filtered buffer size in bytes
4916 * @param buf buffer containing the data to filter
4917 * @param buf_size size in bytes of buf
4918 * @param keyframe set to non-zero if the buffer to filter corresponds to a key-frame packet data
4919 * @return >= 0 in case of success, or a negative error code in case of failure
4921 * If the return value is positive, an output buffer is allocated and
4922 * is availble in *poutbuf, and is distinct from the input buffer.
4924 * If the return value is 0, the output buffer is not allocated and
4925 * should be considered identical to the input buffer, or in case
4926 * *poutbuf was set it points to the input buffer (not necessarily to
4927 * its starting address).
4929 int av_bitstream_filter_filter(AVBitStreamFilterContext *bsfc,
4930 AVCodecContext *avctx, const char *args,
4931 uint8_t **poutbuf, int *poutbuf_size,
4932 const uint8_t *buf, int buf_size, int keyframe);
4935 * Release bitstream filter context.
4937 * @param bsf the bitstream filter context created with
4938 * av_bitstream_filter_init(), can be NULL
4940 void av_bitstream_filter_close(AVBitStreamFilterContext *bsf);
4943 * If f is NULL, return the first registered bitstream filter,
4944 * if f is non-NULL, return the next registered bitstream filter
4945 * after f, or NULL if f is the last one.
4947 * This function can be used to iterate over all registered bitstream
4950 AVBitStreamFilter *av_bitstream_filter_next(AVBitStreamFilter *f);
4955 * Same behaviour av_fast_malloc but the buffer has additional
4956 * FF_INPUT_BUFFER_PADDING_SIZE at the end which will always be 0.
4958 * In addition the whole buffer will initially and after resizes
4959 * be 0-initialized so that no uninitialized data will ever appear.
4961 void av_fast_padded_malloc(void *ptr, unsigned int *size, size_t min_size);
4964 * Same behaviour av_fast_padded_malloc except that buffer will always
4965 * be 0-initialized after call.
4967 void av_fast_padded_mallocz(void *ptr, unsigned int *size, size_t min_size);
4970 * Encode extradata length to a buffer. Used by xiph codecs.
4972 * @param s buffer to write to; must be at least (v/255+1) bytes long
4973 * @param v size of extradata in bytes
4974 * @return number of bytes written to the buffer.
4976 unsigned int av_xiphlacing(unsigned char *s, unsigned int v);
4978 #if FF_API_MISSING_SAMPLE
4980 * Log a generic warning message about a missing feature. This function is
4981 * intended to be used internally by FFmpeg (libavcodec, libavformat, etc.)
4982 * only, and would normally not be used by applications.
4983 * @param[in] avc a pointer to an arbitrary struct of which the first field is
4984 * a pointer to an AVClass struct
4985 * @param[in] feature string containing the name of the missing feature
4986 * @param[in] want_sample indicates if samples are wanted which exhibit this feature.
4987 * If want_sample is non-zero, additional verbage will be added to the log
4988 * message which tells the user how to report samples to the development
4990 * @deprecated Use avpriv_report_missing_feature() instead.
4992 attribute_deprecated
4993 void av_log_missing_feature(void *avc, const char *feature, int want_sample);
4996 * Log a generic warning message asking for a sample. This function is
4997 * intended to be used internally by FFmpeg (libavcodec, libavformat, etc.)
4998 * only, and would normally not be used by applications.
4999 * @param[in] avc a pointer to an arbitrary struct of which the first field is
5000 * a pointer to an AVClass struct
5001 * @param[in] msg string containing an optional message, or NULL if no message
5002 * @deprecated Use avpriv_request_sample() instead.
5004 attribute_deprecated
5005 void av_log_ask_for_sample(void *avc, const char *msg, ...) av_printf_format(2, 3);
5006 #endif /* FF_API_MISSING_SAMPLE */
5009 * Register the hardware accelerator hwaccel.
5011 void av_register_hwaccel(AVHWAccel *hwaccel);
5014 * If hwaccel is NULL, returns the first registered hardware accelerator,
5015 * if hwaccel is non-NULL, returns the next registered hardware accelerator
5016 * after hwaccel, or NULL if hwaccel is the last one.
5018 AVHWAccel *av_hwaccel_next(AVHWAccel *hwaccel);
5022 * Lock operation used by lockmgr
5025 AV_LOCK_CREATE, ///< Create a mutex
5026 AV_LOCK_OBTAIN, ///< Lock the mutex
5027 AV_LOCK_RELEASE, ///< Unlock the mutex
5028 AV_LOCK_DESTROY, ///< Free mutex resources
5032 * Register a user provided lock manager supporting the operations
5033 * specified by AVLockOp. mutex points to a (void *) where the
5034 * lockmgr should store/get a pointer to a user allocated mutex. It's
5035 * NULL upon AV_LOCK_CREATE and != NULL for all other ops.
5037 * @param cb User defined callback. Note: FFmpeg may invoke calls to this
5038 * callback during the call to av_lockmgr_register().
5039 * Thus, the application must be prepared to handle that.
5040 * If cb is set to NULL the lockmgr will be unregistered.
5041 * Also note that during unregistration the previously registered
5042 * lockmgr callback may also be invoked.
5044 int av_lockmgr_register(int (*cb)(void **mutex, enum AVLockOp op));
5047 * Get the type of the given codec.
5049 enum AVMediaType avcodec_get_type(enum AVCodecID codec_id);
5052 * Get the name of a codec.
5053 * @return a static string identifying the codec; never NULL
5055 const char *avcodec_get_name(enum AVCodecID id);
5058 * @return a positive value if s is open (i.e. avcodec_open2() was called on it
5059 * with no corresponding avcodec_close()), 0 otherwise.
5061 int avcodec_is_open(AVCodecContext *s);
5064 * @return a non-zero number if codec is an encoder, zero otherwise
5066 int av_codec_is_encoder(const AVCodec *codec);
5069 * @return a non-zero number if codec is a decoder, zero otherwise
5071 int av_codec_is_decoder(const AVCodec *codec);
5074 * @return descriptor for given codec ID or NULL if no descriptor exists.
5076 const AVCodecDescriptor *avcodec_descriptor_get(enum AVCodecID id);
5079 * Iterate over all codec descriptors known to libavcodec.
5081 * @param prev previous descriptor. NULL to get the first descriptor.
5083 * @return next descriptor or NULL after the last descriptor
5085 const AVCodecDescriptor *avcodec_descriptor_next(const AVCodecDescriptor *prev);
5088 * @return codec descriptor with the given name or NULL if no such descriptor
5091 const AVCodecDescriptor *avcodec_descriptor_get_by_name(const char *name);
5097 #endif /* AVCODEC_AVCODEC_H */