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_BRENDER_PIX= MKBETAG('B','P','I','X'),
290 AV_CODEC_ID_Y41P = MKBETAG('Y','4','1','P'),
291 AV_CODEC_ID_ESCAPE130 = MKBETAG('E','1','3','0'),
292 AV_CODEC_ID_EXR = MKBETAG('0','E','X','R'),
293 AV_CODEC_ID_AVRP = MKBETAG('A','V','R','P'),
295 AV_CODEC_ID_012V = MKBETAG('0','1','2','V'),
296 AV_CODEC_ID_G2M = MKBETAG( 0 ,'G','2','M'),
297 AV_CODEC_ID_AVUI = MKBETAG('A','V','U','I'),
298 AV_CODEC_ID_AYUV = MKBETAG('A','Y','U','V'),
299 AV_CODEC_ID_TARGA_Y216 = MKBETAG('T','2','1','6'),
300 AV_CODEC_ID_V308 = MKBETAG('V','3','0','8'),
301 AV_CODEC_ID_V408 = MKBETAG('V','4','0','8'),
302 AV_CODEC_ID_YUV4 = MKBETAG('Y','U','V','4'),
303 AV_CODEC_ID_SANM = MKBETAG('S','A','N','M'),
304 AV_CODEC_ID_PAF_VIDEO = MKBETAG('P','A','F','V'),
305 AV_CODEC_ID_AVRN = MKBETAG('A','V','R','n'),
306 AV_CODEC_ID_CPIA = MKBETAG('C','P','I','A'),
307 AV_CODEC_ID_XFACE = MKBETAG('X','F','A','C'),
308 AV_CODEC_ID_SGIRLE = MKBETAG('S','G','I','R'),
309 AV_CODEC_ID_MVC1 = MKBETAG('M','V','C','1'),
310 AV_CODEC_ID_MVC2 = MKBETAG('M','V','C','2'),
311 AV_CODEC_ID_SNOW = MKBETAG('S','N','O','W'),
312 AV_CODEC_ID_WEBP = MKBETAG('W','E','B','P'),
313 AV_CODEC_ID_SMVJPEG = MKBETAG('S','M','V','J'),
314 AV_CODEC_ID_HEVC = MKBETAG('H','2','6','5'),
315 #define AV_CODEC_ID_H265 AV_CODEC_ID_HEVC
317 /* various PCM "codecs" */
318 AV_CODEC_ID_FIRST_AUDIO = 0x10000, ///< A dummy id pointing at the start of audio codecs
319 AV_CODEC_ID_PCM_S16LE = 0x10000,
320 AV_CODEC_ID_PCM_S16BE,
321 AV_CODEC_ID_PCM_U16LE,
322 AV_CODEC_ID_PCM_U16BE,
325 AV_CODEC_ID_PCM_MULAW,
326 AV_CODEC_ID_PCM_ALAW,
327 AV_CODEC_ID_PCM_S32LE,
328 AV_CODEC_ID_PCM_S32BE,
329 AV_CODEC_ID_PCM_U32LE,
330 AV_CODEC_ID_PCM_U32BE,
331 AV_CODEC_ID_PCM_S24LE,
332 AV_CODEC_ID_PCM_S24BE,
333 AV_CODEC_ID_PCM_U24LE,
334 AV_CODEC_ID_PCM_U24BE,
335 AV_CODEC_ID_PCM_S24DAUD,
336 AV_CODEC_ID_PCM_ZORK,
337 AV_CODEC_ID_PCM_S16LE_PLANAR,
339 AV_CODEC_ID_PCM_F32BE,
340 AV_CODEC_ID_PCM_F32LE,
341 AV_CODEC_ID_PCM_F64BE,
342 AV_CODEC_ID_PCM_F64LE,
343 AV_CODEC_ID_PCM_BLURAY,
346 AV_CODEC_ID_PCM_S8_PLANAR,
347 AV_CODEC_ID_PCM_S24LE_PLANAR_DEPRECATED,
348 AV_CODEC_ID_PCM_S32LE_PLANAR_DEPRECATED,
349 AV_CODEC_ID_PCM_S24LE_PLANAR = MKBETAG(24,'P','S','P'),
350 AV_CODEC_ID_PCM_S32LE_PLANAR = MKBETAG(32,'P','S','P'),
351 AV_CODEC_ID_PCM_S16BE_PLANAR = MKBETAG('P','S','P',16),
353 /* various ADPCM codecs */
354 AV_CODEC_ID_ADPCM_IMA_QT = 0x11000,
355 AV_CODEC_ID_ADPCM_IMA_WAV,
356 AV_CODEC_ID_ADPCM_IMA_DK3,
357 AV_CODEC_ID_ADPCM_IMA_DK4,
358 AV_CODEC_ID_ADPCM_IMA_WS,
359 AV_CODEC_ID_ADPCM_IMA_SMJPEG,
360 AV_CODEC_ID_ADPCM_MS,
361 AV_CODEC_ID_ADPCM_4XM,
362 AV_CODEC_ID_ADPCM_XA,
363 AV_CODEC_ID_ADPCM_ADX,
364 AV_CODEC_ID_ADPCM_EA,
365 AV_CODEC_ID_ADPCM_G726,
366 AV_CODEC_ID_ADPCM_CT,
367 AV_CODEC_ID_ADPCM_SWF,
368 AV_CODEC_ID_ADPCM_YAMAHA,
369 AV_CODEC_ID_ADPCM_SBPRO_4,
370 AV_CODEC_ID_ADPCM_SBPRO_3,
371 AV_CODEC_ID_ADPCM_SBPRO_2,
372 AV_CODEC_ID_ADPCM_THP,
373 AV_CODEC_ID_ADPCM_IMA_AMV,
374 AV_CODEC_ID_ADPCM_EA_R1,
375 AV_CODEC_ID_ADPCM_EA_R3,
376 AV_CODEC_ID_ADPCM_EA_R2,
377 AV_CODEC_ID_ADPCM_IMA_EA_SEAD,
378 AV_CODEC_ID_ADPCM_IMA_EA_EACS,
379 AV_CODEC_ID_ADPCM_EA_XAS,
380 AV_CODEC_ID_ADPCM_EA_MAXIS_XA,
381 AV_CODEC_ID_ADPCM_IMA_ISS,
382 AV_CODEC_ID_ADPCM_G722,
383 AV_CODEC_ID_ADPCM_IMA_APC,
384 AV_CODEC_ID_VIMA = MKBETAG('V','I','M','A'),
385 AV_CODEC_ID_ADPCM_AFC = MKBETAG('A','F','C',' '),
386 AV_CODEC_ID_ADPCM_IMA_OKI = MKBETAG('O','K','I',' '),
387 AV_CODEC_ID_ADPCM_DTK = MKBETAG('D','T','K',' '),
388 AV_CODEC_ID_ADPCM_IMA_RAD = MKBETAG('R','A','D',' '),
389 AV_CODEC_ID_ADPCM_G726LE = MKBETAG('6','2','7','G'),
392 AV_CODEC_ID_AMR_NB = 0x12000,
395 /* RealAudio codecs*/
396 AV_CODEC_ID_RA_144 = 0x13000,
399 /* various DPCM codecs */
400 AV_CODEC_ID_ROQ_DPCM = 0x14000,
401 AV_CODEC_ID_INTERPLAY_DPCM,
402 AV_CODEC_ID_XAN_DPCM,
403 AV_CODEC_ID_SOL_DPCM,
406 AV_CODEC_ID_MP2 = 0x15000,
407 AV_CODEC_ID_MP3, ///< preferred ID for decoding MPEG audio layer 1, 2 or 3
417 AV_CODEC_ID_VMDAUDIO,
423 AV_CODEC_ID_WESTWOOD_SND1,
424 AV_CODEC_ID_GSM, ///< as in Berlin toast format
427 AV_CODEC_ID_TRUESPEECH,
429 AV_CODEC_ID_SMACKAUDIO,
432 AV_CODEC_ID_DSICINAUDIO,
434 AV_CODEC_ID_MUSEPACK7,
436 AV_CODEC_ID_GSM_MS, /* as found in WAV */
442 AV_CODEC_ID_NELLYMOSER,
443 AV_CODEC_ID_MUSEPACK8,
445 AV_CODEC_ID_WMAVOICE,
447 AV_CODEC_ID_WMALOSSLESS,
456 AV_CODEC_ID_BINKAUDIO_RDFT,
457 AV_CODEC_ID_BINKAUDIO_DCT,
458 AV_CODEC_ID_AAC_LATM,
463 AV_CODEC_ID_8SVX_EXP,
464 AV_CODEC_ID_8SVX_FIB,
465 AV_CODEC_ID_BMV_AUDIO,
469 AV_CODEC_ID_OPUS_DEPRECATED,
470 AV_CODEC_ID_COMFORT_NOISE,
471 AV_CODEC_ID_TAK_DEPRECATED,
472 AV_CODEC_ID_METASOUND,
473 AV_CODEC_ID_FFWAVESYNTH = MKBETAG('F','F','W','S'),
474 AV_CODEC_ID_SONIC = MKBETAG('S','O','N','C'),
475 AV_CODEC_ID_SONIC_LS = MKBETAG('S','O','N','L'),
476 AV_CODEC_ID_PAF_AUDIO = MKBETAG('P','A','F','A'),
477 AV_CODEC_ID_OPUS = MKBETAG('O','P','U','S'),
478 AV_CODEC_ID_TAK = MKBETAG('t','B','a','K'),
479 AV_CODEC_ID_EVRC = MKBETAG('s','e','v','c'),
480 AV_CODEC_ID_SMV = MKBETAG('s','s','m','v'),
482 /* subtitle codecs */
483 AV_CODEC_ID_FIRST_SUBTITLE = 0x17000, ///< A dummy ID pointing at the start of subtitle codecs.
484 AV_CODEC_ID_DVD_SUBTITLE = 0x17000,
485 AV_CODEC_ID_DVB_SUBTITLE,
486 AV_CODEC_ID_TEXT, ///< raw UTF-8 text
489 AV_CODEC_ID_MOV_TEXT,
490 AV_CODEC_ID_HDMV_PGS_SUBTITLE,
491 AV_CODEC_ID_DVB_TELETEXT,
493 AV_CODEC_ID_MICRODVD = MKBETAG('m','D','V','D'),
494 AV_CODEC_ID_EIA_608 = MKBETAG('c','6','0','8'),
495 AV_CODEC_ID_JACOSUB = MKBETAG('J','S','U','B'),
496 AV_CODEC_ID_SAMI = MKBETAG('S','A','M','I'),
497 AV_CODEC_ID_REALTEXT = MKBETAG('R','T','X','T'),
498 AV_CODEC_ID_SUBVIEWER1 = MKBETAG('S','b','V','1'),
499 AV_CODEC_ID_SUBVIEWER = MKBETAG('S','u','b','V'),
500 AV_CODEC_ID_SUBRIP = MKBETAG('S','R','i','p'),
501 AV_CODEC_ID_WEBVTT = MKBETAG('W','V','T','T'),
502 AV_CODEC_ID_MPL2 = MKBETAG('M','P','L','2'),
503 AV_CODEC_ID_VPLAYER = MKBETAG('V','P','l','r'),
504 AV_CODEC_ID_PJS = MKBETAG('P','h','J','S'),
505 AV_CODEC_ID_ASS = MKBETAG('A','S','S',' '), ///< ASS as defined in Matroska
507 /* other specific kind of codecs (generally used for attachments) */
508 AV_CODEC_ID_FIRST_UNKNOWN = 0x18000, ///< A dummy ID pointing at the start of various fake codecs.
509 AV_CODEC_ID_TTF = 0x18000,
510 AV_CODEC_ID_BINTEXT = MKBETAG('B','T','X','T'),
511 AV_CODEC_ID_XBIN = MKBETAG('X','B','I','N'),
512 AV_CODEC_ID_IDF = MKBETAG( 0 ,'I','D','F'),
513 AV_CODEC_ID_OTF = MKBETAG( 0 ,'O','T','F'),
514 AV_CODEC_ID_SMPTE_KLV = MKBETAG('K','L','V','A'),
515 AV_CODEC_ID_DVD_NAV = MKBETAG('D','N','A','V'),
518 AV_CODEC_ID_PROBE = 0x19000, ///< codec_id is not known (like AV_CODEC_ID_NONE) but lavf should attempt to identify it
520 AV_CODEC_ID_MPEG2TS = 0x20000, /**< _FAKE_ codec to indicate a raw MPEG-2 TS
521 * stream (only used by libavformat) */
522 AV_CODEC_ID_MPEG4SYSTEMS = 0x20001, /**< _FAKE_ codec to indicate a MPEG-4 Systems
523 * stream (only used by libavformat) */
524 AV_CODEC_ID_FFMETADATA = 0x21000, ///< Dummy codec for streams containing only metadata information.
527 #include "old_codec_ids.h"
532 * This struct describes the properties of a single codec described by an
534 * @see avcodec_get_descriptor()
536 typedef struct AVCodecDescriptor {
538 enum AVMediaType type;
540 * Name of the codec described by this descriptor. It is non-empty and
541 * unique for each codec descriptor. It should contain alphanumeric
542 * characters and '_' only.
546 * A more descriptive name for this codec. May be NULL.
548 const char *long_name;
550 * Codec properties, a combination of AV_CODEC_PROP_* flags.
556 * Codec uses only intra compression.
559 #define AV_CODEC_PROP_INTRA_ONLY (1 << 0)
561 * Codec supports lossy compression. Audio and video codecs only.
562 * @note a codec may support both lossy and lossless
565 #define AV_CODEC_PROP_LOSSY (1 << 1)
567 * Codec supports lossless compression. Audio and video codecs only.
569 #define AV_CODEC_PROP_LOSSLESS (1 << 2)
571 * Subtitle codec is bitmap based
572 * Decoded AVSubtitle data can be read from the AVSubtitleRect->pict field.
574 #define AV_CODEC_PROP_BITMAP_SUB (1 << 16)
576 * Subtitle codec is text based.
577 * Decoded AVSubtitle data can be read from the AVSubtitleRect->ass field.
579 #define AV_CODEC_PROP_TEXT_SUB (1 << 17)
582 * @ingroup lavc_decoding
583 * Required number of additionally allocated bytes at the end of the input bitstream for decoding.
584 * This is mainly needed because some optimized bitstream readers read
585 * 32 or 64 bit at once and could read over the end.<br>
586 * Note: If the first 23 bits of the additional bytes are not 0, then damaged
587 * MPEG bitstreams could cause overread and segfault.
589 #define FF_INPUT_BUFFER_PADDING_SIZE 16
592 * @ingroup lavc_encoding
593 * minimum encoding buffer size
594 * Used to avoid some checks during header writing.
596 #define FF_MIN_BUFFER_SIZE 16384
600 * @ingroup lavc_encoding
601 * motion estimation type.
604 ME_ZERO = 1, ///< no search, that is use 0,0 vector whenever one is needed
608 ME_EPZS, ///< enhanced predictive zonal search
609 ME_X1, ///< reserved for experiments
610 ME_HEX, ///< hexagon based search
611 ME_UMH, ///< uneven multi-hexagon search
612 ME_TESA, ///< transformed exhaustive search algorithm
613 ME_ITER=50, ///< iterative search
617 * @ingroup lavc_decoding
620 /* We leave some space between them for extensions (drop some
621 * keyframes for intra-only or drop just some bidir frames). */
622 AVDISCARD_NONE =-16, ///< discard nothing
623 AVDISCARD_DEFAULT = 0, ///< discard useless packets like 0 size packets in avi
624 AVDISCARD_NONREF = 8, ///< discard all non reference
625 AVDISCARD_BIDIR = 16, ///< discard all bidirectional frames
626 AVDISCARD_NONKEY = 32, ///< discard all frames except keyframes
627 AVDISCARD_ALL = 48, ///< discard all
630 enum AVColorPrimaries{
631 AVCOL_PRI_BT709 = 1, ///< also ITU-R BT1361 / IEC 61966-2-4 / SMPTE RP177 Annex B
632 AVCOL_PRI_UNSPECIFIED = 2,
633 AVCOL_PRI_BT470M = 4,
634 AVCOL_PRI_BT470BG = 5, ///< also ITU-R BT601-6 625 / ITU-R BT1358 625 / ITU-R BT1700 625 PAL & SECAM
635 AVCOL_PRI_SMPTE170M = 6, ///< also ITU-R BT601-6 525 / ITU-R BT1358 525 / ITU-R BT1700 NTSC
636 AVCOL_PRI_SMPTE240M = 7, ///< functionally identical to above
638 AVCOL_PRI_BT2020 = 9, ///< ITU-R BT2020
639 AVCOL_PRI_NB , ///< Not part of ABI
642 enum AVColorTransferCharacteristic{
643 AVCOL_TRC_BT709 = 1, ///< also ITU-R BT1361
644 AVCOL_TRC_UNSPECIFIED = 2,
645 AVCOL_TRC_GAMMA22 = 4, ///< also ITU-R BT470M / ITU-R BT1700 625 PAL & SECAM
646 AVCOL_TRC_GAMMA28 = 5, ///< also ITU-R BT470BG
647 AVCOL_TRC_SMPTE170M = 6, ///< also ITU-R BT601-6 525 or 625 / ITU-R BT1358 525 or 625 / ITU-R BT1700 NTSC
648 AVCOL_TRC_SMPTE240M = 7,
649 AVCOL_TRC_LINEAR = 8, ///< "Linear transfer characteristics"
650 AVCOL_TRC_LOG = 9, ///< "Logarithmic transfer characteristic (100:1 range)"
651 AVCOL_TRC_LOG_SQRT = 10, ///< "Logarithmic transfer characteristic (100 * Sqrt( 10 ) : 1 range)"
652 AVCOL_TRC_IEC61966_2_4 = 11, ///< IEC 61966-2-4
653 AVCOL_TRC_BT1361_ECG = 12, ///< ITU-R BT1361 Extended Colour Gamut
654 AVCOL_TRC_IEC61966_2_1 = 13, ///< IEC 61966-2-1 (sRGB or sYCC)
655 AVCOL_TRC_BT2020_10 = 14, ///< ITU-R BT2020 for 10 bit system
656 AVCOL_TRC_BT2020_12 = 15, ///< ITU-R BT2020 for 12 bit system
657 AVCOL_TRC_NB , ///< Not part of ABI
661 * X X 3 4 X X are luma samples,
662 * 1 2 1-6 are possible chroma positions
663 * X X 5 6 X 0 is undefined/unknown position
665 enum AVChromaLocation{
666 AVCHROMA_LOC_UNSPECIFIED = 0,
667 AVCHROMA_LOC_LEFT = 1, ///< mpeg2/4, h264 default
668 AVCHROMA_LOC_CENTER = 2, ///< mpeg1, jpeg, h263
669 AVCHROMA_LOC_TOPLEFT = 3, ///< DV
670 AVCHROMA_LOC_TOP = 4,
671 AVCHROMA_LOC_BOTTOMLEFT = 5,
672 AVCHROMA_LOC_BOTTOM = 6,
673 AVCHROMA_LOC_NB , ///< Not part of ABI
676 enum AVAudioServiceType {
677 AV_AUDIO_SERVICE_TYPE_MAIN = 0,
678 AV_AUDIO_SERVICE_TYPE_EFFECTS = 1,
679 AV_AUDIO_SERVICE_TYPE_VISUALLY_IMPAIRED = 2,
680 AV_AUDIO_SERVICE_TYPE_HEARING_IMPAIRED = 3,
681 AV_AUDIO_SERVICE_TYPE_DIALOGUE = 4,
682 AV_AUDIO_SERVICE_TYPE_COMMENTARY = 5,
683 AV_AUDIO_SERVICE_TYPE_EMERGENCY = 6,
684 AV_AUDIO_SERVICE_TYPE_VOICE_OVER = 7,
685 AV_AUDIO_SERVICE_TYPE_KARAOKE = 8,
686 AV_AUDIO_SERVICE_TYPE_NB , ///< Not part of ABI
690 * @ingroup lavc_encoding
692 typedef struct RcOverride{
695 int qscale; // If this is 0 then quality_factor will be used instead.
696 float quality_factor;
699 #if FF_API_MAX_BFRAMES
701 * @deprecated there is no libavcodec-wide limit on the number of B-frames
703 #define FF_MAX_B_FRAMES 16
707 These flags can be passed in AVCodecContext.flags before initialization.
708 Note: Not everything is supported yet.
712 * Allow decoders to produce frames with data planes that are not aligned
713 * to CPU requirements (e.g. due to cropping).
715 #define CODEC_FLAG_UNALIGNED 0x0001
716 #define CODEC_FLAG_QSCALE 0x0002 ///< Use fixed qscale.
717 #define CODEC_FLAG_4MV 0x0004 ///< 4 MV per MB allowed / advanced prediction for H.263.
718 #define CODEC_FLAG_OUTPUT_CORRUPT 0x0008 ///< Output even those frames that might be corrupted
719 #define CODEC_FLAG_QPEL 0x0010 ///< Use qpel MC.
720 #define CODEC_FLAG_GMC 0x0020 ///< Use GMC.
721 #define CODEC_FLAG_MV0 0x0040 ///< Always try a MB with MV=<0,0>.
723 * The parent program guarantees that the input for B-frames containing
724 * streams is not written to for at least s->max_b_frames+1 frames, if
725 * this is not set the input will be copied.
727 #define CODEC_FLAG_INPUT_PRESERVED 0x0100
728 #define CODEC_FLAG_PASS1 0x0200 ///< Use internal 2pass ratecontrol in first pass mode.
729 #define CODEC_FLAG_PASS2 0x0400 ///< Use internal 2pass ratecontrol in second pass mode.
730 #define CODEC_FLAG_GRAY 0x2000 ///< Only decode/encode grayscale.
731 #define CODEC_FLAG_EMU_EDGE 0x4000 ///< Don't draw edges.
732 #define CODEC_FLAG_PSNR 0x8000 ///< error[?] variables will be set during encoding.
733 #define CODEC_FLAG_TRUNCATED 0x00010000 /** Input bitstream might be truncated at a random
734 location instead of only at frame boundaries. */
735 #define CODEC_FLAG_NORMALIZE_AQP 0x00020000 ///< Normalize adaptive quantization.
736 #define CODEC_FLAG_INTERLACED_DCT 0x00040000 ///< Use interlaced DCT.
737 #define CODEC_FLAG_LOW_DELAY 0x00080000 ///< Force low delay.
738 #define CODEC_FLAG_GLOBAL_HEADER 0x00400000 ///< Place global headers in extradata instead of every keyframe.
739 #define CODEC_FLAG_BITEXACT 0x00800000 ///< Use only bitexact stuff (except (I)DCT).
740 /* Fx : Flag for h263+ extra options */
741 #define CODEC_FLAG_AC_PRED 0x01000000 ///< H.263 advanced intra coding / MPEG-4 AC prediction
742 #define CODEC_FLAG_LOOP_FILTER 0x00000800 ///< loop filter
743 #define CODEC_FLAG_INTERLACED_ME 0x20000000 ///< interlaced motion estimation
744 #define CODEC_FLAG_CLOSED_GOP 0x80000000
745 #define CODEC_FLAG2_FAST 0x00000001 ///< Allow non spec compliant speedup tricks.
746 #define CODEC_FLAG2_NO_OUTPUT 0x00000004 ///< Skip bitstream encoding.
747 #define CODEC_FLAG2_LOCAL_HEADER 0x00000008 ///< Place global headers at every keyframe instead of in extradata.
748 #define CODEC_FLAG2_DROP_FRAME_TIMECODE 0x00002000 ///< timecode is in drop frame format. DEPRECATED!!!!
749 #define CODEC_FLAG2_IGNORE_CROP 0x00010000 ///< Discard cropping information from SPS.
751 #define CODEC_FLAG2_CHUNKS 0x00008000 ///< Input bitstream might be truncated at a packet boundaries instead of only at frame boundaries.
752 #define CODEC_FLAG2_SHOW_ALL 0x00400000 ///< Show all frames before the first keyframe
754 /* Unsupported options :
755 * Syntax Arithmetic coding (SAC)
756 * Reference Picture Selection
757 * Independent Segment Decoding */
759 /* codec capabilities */
761 #define CODEC_CAP_DRAW_HORIZ_BAND 0x0001 ///< Decoder can use draw_horiz_band callback.
763 * Codec uses get_buffer() for allocating buffers and supports custom allocators.
764 * If not set, it might not use get_buffer() at all or use operations that
765 * assume the buffer was allocated by avcodec_default_get_buffer.
767 #define CODEC_CAP_DR1 0x0002
768 #define CODEC_CAP_TRUNCATED 0x0008
770 /* Codec can export data for HW decoding (XvMC). */
771 #define CODEC_CAP_HWACCEL 0x0010
772 #endif /* FF_API_XVMC */
774 * Encoder or decoder requires flushing with NULL input at the end in order to
775 * give the complete and correct output.
777 * NOTE: If this flag is not set, the codec is guaranteed to never be fed with
778 * with NULL data. The user can still send NULL data to the public encode
779 * or decode function, but libavcodec will not pass it along to the codec
780 * unless this flag is set.
783 * The decoder has a non-zero delay and needs to be fed with avpkt->data=NULL,
784 * avpkt->size=0 at the end to get the delayed data until the decoder no longer
788 * The encoder needs to be fed with NULL data at the end of encoding until the
789 * encoder no longer returns data.
791 * NOTE: For encoders implementing the AVCodec.encode2() function, setting this
792 * flag also means that the encoder must set the pts and duration for
793 * each output packet. If this flag is not set, the pts and duration will
794 * be determined by libavcodec from the input frame.
796 #define CODEC_CAP_DELAY 0x0020
798 * Codec can be fed a final frame with a smaller size.
799 * This can be used to prevent truncation of the last audio samples.
801 #define CODEC_CAP_SMALL_LAST_FRAME 0x0040
804 * Codec can export data for HW decoding (VDPAU).
806 #define CODEC_CAP_HWACCEL_VDPAU 0x0080
809 * Codec can output multiple frames per AVPacket
810 * Normally demuxers return one frame at a time, demuxers which do not do
811 * are connected to a parser to split what they return into proper frames.
812 * This flag is reserved to the very rare category of codecs which have a
813 * bitstream that cannot be split into frames without timeconsuming
814 * operations like full decoding. Demuxers carring such bitstreams thus
815 * may return multiple frames in a packet. This has many disadvantages like
816 * prohibiting stream copy in many cases thus it should only be considered
819 #define CODEC_CAP_SUBFRAMES 0x0100
821 * Codec is experimental and is thus avoided in favor of non experimental
824 #define CODEC_CAP_EXPERIMENTAL 0x0200
826 * Codec should fill in channel configuration and samplerate instead of container
828 #define CODEC_CAP_CHANNEL_CONF 0x0400
829 #if FF_API_NEG_LINESIZES
831 * @deprecated no codecs use this capability
833 #define CODEC_CAP_NEG_LINESIZES 0x0800
836 * Codec supports frame-level multithreading.
838 #define CODEC_CAP_FRAME_THREADS 0x1000
840 * Codec supports slice-based (or partition-based) multithreading.
842 #define CODEC_CAP_SLICE_THREADS 0x2000
844 * Codec supports changed parameters at any point.
846 #define CODEC_CAP_PARAM_CHANGE 0x4000
848 * Codec supports avctx->thread_count == 0 (auto).
850 #define CODEC_CAP_AUTO_THREADS 0x8000
852 * Audio encoder supports receiving a different number of samples in each call.
854 #define CODEC_CAP_VARIABLE_FRAME_SIZE 0x10000
856 * Codec is intra only.
858 #define CODEC_CAP_INTRA_ONLY 0x40000000
862 #define CODEC_CAP_LOSSLESS 0x80000000
865 //The following defines may change, don't expect compatibility if you use them.
866 #define MB_TYPE_INTRA4x4 0x0001
867 #define MB_TYPE_INTRA16x16 0x0002 //FIXME H.264-specific
868 #define MB_TYPE_INTRA_PCM 0x0004 //FIXME H.264-specific
869 #define MB_TYPE_16x16 0x0008
870 #define MB_TYPE_16x8 0x0010
871 #define MB_TYPE_8x16 0x0020
872 #define MB_TYPE_8x8 0x0040
873 #define MB_TYPE_INTERLACED 0x0080
874 #define MB_TYPE_DIRECT2 0x0100 //FIXME
875 #define MB_TYPE_ACPRED 0x0200
876 #define MB_TYPE_GMC 0x0400
877 #define MB_TYPE_SKIP 0x0800
878 #define MB_TYPE_P0L0 0x1000
879 #define MB_TYPE_P1L0 0x2000
880 #define MB_TYPE_P0L1 0x4000
881 #define MB_TYPE_P1L1 0x8000
882 #define MB_TYPE_L0 (MB_TYPE_P0L0 | MB_TYPE_P1L0)
883 #define MB_TYPE_L1 (MB_TYPE_P0L1 | MB_TYPE_P1L1)
884 #define MB_TYPE_L0L1 (MB_TYPE_L0 | MB_TYPE_L1)
885 #define MB_TYPE_QUANT 0x00010000
886 #define MB_TYPE_CBP 0x00020000
887 //Note bits 24-31 are reserved for codec specific use (h264 ref0, mpeg1 0mv, ...)
892 * This specifies the area which should be displayed.
893 * Note there may be multiple such areas for one frame.
895 typedef struct AVPanScan{
898 * - encoding: Set by user.
899 * - decoding: Set by libavcodec.
904 * width and height in 1/16 pel
905 * - encoding: Set by user.
906 * - decoding: Set by libavcodec.
912 * position of the top left corner in 1/16 pel for up to 3 fields/frames
913 * - encoding: Set by user.
914 * - decoding: Set by libavcodec.
916 int16_t position[3][2];
919 #if FF_API_QSCALE_TYPE
920 #define FF_QSCALE_TYPE_MPEG1 0
921 #define FF_QSCALE_TYPE_MPEG2 1
922 #define FF_QSCALE_TYPE_H264 2
923 #define FF_QSCALE_TYPE_VP56 3
926 #if FF_API_GET_BUFFER
927 #define FF_BUFFER_TYPE_INTERNAL 1
928 #define FF_BUFFER_TYPE_USER 2 ///< direct rendering buffers (image is (de)allocated by user)
929 #define FF_BUFFER_TYPE_SHARED 4 ///< Buffer from somewhere else; don't deallocate image (data/base), all other tables are not shared.
930 #define FF_BUFFER_TYPE_COPY 8 ///< Just a (modified) copy of some other buffer, don't deallocate anything.
932 #define FF_BUFFER_HINTS_VALID 0x01 // Buffer hints value is meaningful (if 0 ignore).
933 #define FF_BUFFER_HINTS_READABLE 0x02 // Codec will read from buffer.
934 #define FF_BUFFER_HINTS_PRESERVE 0x04 // User must not alter buffer content.
935 #define FF_BUFFER_HINTS_REUSABLE 0x08 // Codec will reuse the buffer (update).
939 * The decoder will keep a reference to the frame and may reuse it later.
941 #define AV_GET_BUFFER_FLAG_REF (1 << 0)
944 * @defgroup lavc_packet AVPacket
946 * Types and functions for working with AVPacket.
949 enum AVPacketSideDataType {
951 AV_PKT_DATA_NEW_EXTRADATA,
954 * An AV_PKT_DATA_PARAM_CHANGE side data packet is laid out as follows:
957 * if (param_flags & AV_SIDE_DATA_PARAM_CHANGE_CHANNEL_COUNT)
958 * s32le channel_count
959 * if (param_flags & AV_SIDE_DATA_PARAM_CHANGE_CHANNEL_LAYOUT)
960 * u64le channel_layout
961 * if (param_flags & AV_SIDE_DATA_PARAM_CHANGE_SAMPLE_RATE)
963 * if (param_flags & AV_SIDE_DATA_PARAM_CHANGE_DIMENSIONS)
968 AV_PKT_DATA_PARAM_CHANGE,
971 * An AV_PKT_DATA_H263_MB_INFO side data packet contains a number of
972 * structures with info about macroblocks relevant to splitting the
973 * packet into smaller packets on macroblock edges (e.g. as for RFC 2190).
974 * That is, it does not necessarily contain info about all macroblocks,
975 * as long as the distance between macroblocks in the info is smaller
976 * than the target payload size.
977 * Each MB info structure is 12 bytes, and is laid out as follows:
979 * u32le bit offset from the start of the packet
980 * u8 current quantizer at the start of the macroblock
982 * u16le macroblock address within the GOB
983 * u8 horizontal MV predictor
984 * u8 vertical MV predictor
985 * u8 horizontal MV predictor for block number 3
986 * u8 vertical MV predictor for block number 3
989 AV_PKT_DATA_H263_MB_INFO,
992 * Recommmends skipping the specified number of samples
994 * u32le number of samples to skip from start of this packet
995 * u32le number of samples to skip from end of this packet
996 * u8 reason for start skip
997 * u8 reason for end skip (0=padding silence, 1=convergence)
1000 AV_PKT_DATA_SKIP_SAMPLES=70,
1003 * An AV_PKT_DATA_JP_DUALMONO side data packet indicates that
1004 * the packet may contain "dual mono" audio specific to Japanese DTV
1005 * and if it is true, recommends only the selected channel to be used.
1007 * u8 selected channels (0=mail/left, 1=sub/right, 2=both)
1010 AV_PKT_DATA_JP_DUALMONO,
1013 * A list of zero terminated key/value strings. There is no end marker for
1014 * the list, so it is required to rely on the side data size to stop.
1016 AV_PKT_DATA_STRINGS_METADATA,
1019 * Subtitle event position
1027 AV_PKT_DATA_SUBTITLE_POSITION,
1030 * Data found in BlockAdditional element of matroska container. There is
1031 * no end marker for the data, so it is required to rely on the side data
1032 * size to recognize the end. 8 byte id (as found in BlockAddId) followed
1035 AV_PKT_DATA_MATROSKA_BLOCKADDITIONAL,
1038 * The optional first identifier line of a WebVTT cue.
1040 AV_PKT_DATA_WEBVTT_IDENTIFIER,
1043 * The optional settings (rendering instructions) that immediately
1044 * follow the timestamp specifier of a WebVTT cue.
1046 AV_PKT_DATA_WEBVTT_SETTINGS,
1049 * A list of zero terminated key/value strings. There is no end marker for
1050 * the list, so it is required to rely on the side data size to stop. This
1051 * side data includes updated metadata which appeared in the stream.
1053 AV_PKT_DATA_METADATA_UPDATE,
1057 * This structure stores compressed data. It is typically exported by demuxers
1058 * and then passed as input to decoders, or received as output from encoders and
1059 * then passed to muxers.
1061 * For video, it should typically contain one compressed frame. For audio it may
1062 * contain several compressed frames.
1064 * AVPacket is one of the few structs in FFmpeg, whose size is a part of public
1065 * ABI. Thus it may be allocated on stack and no new fields can be added to it
1066 * without libavcodec and libavformat major bump.
1068 * The semantics of data ownership depends on the buf or destruct (deprecated)
1069 * fields. If either is set, the packet data is dynamically allocated and is
1070 * valid indefinitely until av_free_packet() is called (which in turn calls
1071 * av_buffer_unref()/the destruct callback to free the data). If neither is set,
1072 * the packet data is typically backed by some static buffer somewhere and is
1073 * only valid for a limited time (e.g. until the next read call when demuxing).
1075 * The side data is always allocated with av_malloc() and is freed in
1078 typedef struct AVPacket {
1080 * A reference to the reference-counted buffer where the packet data is
1082 * May be NULL, then the packet data is not reference-counted.
1086 * Presentation timestamp in AVStream->time_base units; the time at which
1087 * the decompressed packet will be presented to the user.
1088 * Can be AV_NOPTS_VALUE if it is not stored in the file.
1089 * pts MUST be larger or equal to dts as presentation cannot happen before
1090 * decompression, unless one wants to view hex dumps. Some formats misuse
1091 * the terms dts and pts/cts to mean something different. Such timestamps
1092 * must be converted to true pts/dts before they are stored in AVPacket.
1096 * Decompression timestamp in AVStream->time_base units; the time at which
1097 * the packet is decompressed.
1098 * Can be AV_NOPTS_VALUE if it is not stored in the file.
1105 * A combination of AV_PKT_FLAG values
1109 * Additional packet data that can be provided by the container.
1110 * Packet can contain several types of side information.
1115 enum AVPacketSideDataType type;
1117 int side_data_elems;
1120 * Duration of this packet in AVStream->time_base units, 0 if unknown.
1121 * Equals next_pts - this_pts in presentation order.
1124 #if FF_API_DESTRUCT_PACKET
1125 attribute_deprecated
1126 void (*destruct)(struct AVPacket *);
1127 attribute_deprecated
1130 int64_t pos; ///< byte position in stream, -1 if unknown
1133 * Time difference in AVStream->time_base units from the pts of this
1134 * packet to the point at which the output from the decoder has converged
1135 * independent from the availability of previous frames. That is, the
1136 * frames are virtually identical no matter if decoding started from
1137 * the very first frame or from this keyframe.
1138 * Is AV_NOPTS_VALUE if unknown.
1139 * This field is not the display duration of the current packet.
1140 * This field has no meaning if the packet does not have AV_PKT_FLAG_KEY
1143 * The purpose of this field is to allow seeking in streams that have no
1144 * keyframes in the conventional sense. It corresponds to the
1145 * recovery point SEI in H.264 and match_time_delta in NUT. It is also
1146 * essential for some types of subtitle streams to ensure that all
1147 * subtitles are correctly displayed after seeking.
1149 int64_t convergence_duration;
1151 #define AV_PKT_FLAG_KEY 0x0001 ///< The packet contains a keyframe
1152 #define AV_PKT_FLAG_CORRUPT 0x0002 ///< The packet content is corrupted
1154 enum AVSideDataParamChangeFlags {
1155 AV_SIDE_DATA_PARAM_CHANGE_CHANNEL_COUNT = 0x0001,
1156 AV_SIDE_DATA_PARAM_CHANGE_CHANNEL_LAYOUT = 0x0002,
1157 AV_SIDE_DATA_PARAM_CHANGE_SAMPLE_RATE = 0x0004,
1158 AV_SIDE_DATA_PARAM_CHANGE_DIMENSIONS = 0x0008,
1164 struct AVCodecInternal;
1168 AV_FIELD_PROGRESSIVE,
1169 AV_FIELD_TT, //< Top coded_first, top displayed first
1170 AV_FIELD_BB, //< Bottom coded first, bottom displayed first
1171 AV_FIELD_TB, //< Top coded first, bottom displayed first
1172 AV_FIELD_BT, //< Bottom coded first, top displayed first
1176 * main external API structure.
1177 * New fields can be added to the end with minor version bumps.
1178 * Removal, reordering and changes to existing fields require a major
1180 * Please use AVOptions (av_opt* / av_set/get*()) to access these fields from user
1182 * sizeof(AVCodecContext) must not be used outside libav*.
1184 typedef struct AVCodecContext {
1186 * information on struct for av_log
1187 * - set by avcodec_alloc_context3
1189 const AVClass *av_class;
1190 int log_level_offset;
1192 enum AVMediaType codec_type; /* see AVMEDIA_TYPE_xxx */
1193 const struct AVCodec *codec;
1194 char codec_name[32];
1195 enum AVCodecID codec_id; /* see AV_CODEC_ID_xxx */
1198 * fourcc (LSB first, so "ABCD" -> ('D'<<24) + ('C'<<16) + ('B'<<8) + 'A').
1199 * This is used to work around some encoder bugs.
1200 * A demuxer should set this to what is stored in the field used to identify the codec.
1201 * If there are multiple such fields in a container then the demuxer should choose the one
1202 * which maximizes the information about the used codec.
1203 * If the codec tag field in a container is larger than 32 bits then the demuxer should
1204 * remap the longer ID to 32 bits with a table or other structure. Alternatively a new
1205 * extra_codec_tag + size could be added but for this a clear advantage must be demonstrated
1207 * - encoding: Set by user, if not then the default based on codec_id will be used.
1208 * - decoding: Set by user, will be converted to uppercase by libavcodec during init.
1210 unsigned int codec_tag;
1213 * fourcc from the AVI stream header (LSB first, so "ABCD" -> ('D'<<24) + ('C'<<16) + ('B'<<8) + 'A').
1214 * This is used to work around some encoder bugs.
1215 * - encoding: unused
1216 * - decoding: Set by user, will be converted to uppercase by libavcodec during init.
1218 unsigned int stream_codec_tag;
1223 * Private context used for internal data.
1225 * Unlike priv_data, this is not codec-specific. It is used in general
1226 * libavcodec functions.
1228 struct AVCodecInternal *internal;
1231 * Private data of the user, can be used to carry app specific stuff.
1232 * - encoding: Set by user.
1233 * - decoding: Set by user.
1238 * the average bitrate
1239 * - encoding: Set by user; unused for constant quantizer encoding.
1240 * - decoding: Set by libavcodec. 0 or some bitrate if this info is available in the stream.
1245 * number of bits the bitstream is allowed to diverge from the reference.
1246 * the reference can be CBR (for CBR pass1) or VBR (for pass2)
1247 * - encoding: Set by user; unused for constant quantizer encoding.
1248 * - decoding: unused
1250 int bit_rate_tolerance;
1253 * Global quality for codecs which cannot change it per frame.
1254 * This should be proportional to MPEG-1/2/4 qscale.
1255 * - encoding: Set by user.
1256 * - decoding: unused
1261 * - encoding: Set by user.
1262 * - decoding: unused
1264 int compression_level;
1265 #define FF_COMPRESSION_DEFAULT -1
1269 * - encoding: Set by user.
1270 * - decoding: Set by user.
1276 * - encoding: Set by user.
1277 * - decoding: Set by user.
1282 * some codecs need / can use extradata like Huffman tables.
1283 * mjpeg: Huffman tables
1284 * rv10: additional flags
1285 * mpeg4: global headers (they can be in the bitstream or here)
1286 * The allocated memory should be FF_INPUT_BUFFER_PADDING_SIZE bytes larger
1287 * than extradata_size to avoid problems if it is read with the bitstream reader.
1288 * The bytewise contents of extradata must not depend on the architecture or CPU endianness.
1289 * - encoding: Set/allocated/freed by libavcodec.
1290 * - decoding: Set/allocated/freed by user.
1296 * This is the fundamental unit of time (in seconds) in terms
1297 * of which frame timestamps are represented. For fixed-fps content,
1298 * timebase should be 1/framerate and timestamp increments should be
1300 * - encoding: MUST be set by user.
1301 * - decoding: Set by libavcodec.
1303 AVRational time_base;
1306 * For some codecs, the time base is closer to the field rate than the frame rate.
1307 * Most notably, H.264 and MPEG-2 specify time_base as half of frame duration
1308 * if no telecine is used ...
1310 * Set to time_base ticks per frame. Default 1, e.g., H.264/MPEG-2 set it to 2.
1312 int ticks_per_frame;
1317 * Encoding: Number of frames delay there will be from the encoder input to
1318 * the decoder output. (we assume the decoder matches the spec)
1319 * Decoding: Number of frames delay in addition to what a standard decoder
1320 * as specified in the spec would produce.
1323 * Number of frames the decoded output will be delayed relative to the
1327 * For encoding, this is the number of "priming" samples added to the
1328 * beginning of the stream. The decoded output will be delayed by this
1329 * many samples relative to the input to the encoder. Note that this
1330 * field is purely informational and does not directly affect the pts
1331 * output by the encoder, which should always be based on the actual
1332 * presentation time, including any delay.
1333 * For decoding, this is the number of samples the decoder needs to
1334 * output before the decoder's output is valid. When seeking, you should
1335 * start decoding this many samples prior to your desired seek point.
1337 * - encoding: Set by libavcodec.
1338 * - decoding: Set by libavcodec.
1345 * picture width / height.
1346 * - encoding: MUST be set by user.
1347 * - decoding: May be set by the user before opening the decoder if known e.g.
1348 * from the container. Some decoders will require the dimensions
1349 * to be set by the caller. During decoding, the decoder may
1350 * overwrite those values as required.
1355 * Bitstream width / height, may be different from width/height e.g. when
1356 * the decoded frame is cropped before being output or lowres is enabled.
1357 * - encoding: unused
1358 * - decoding: May be set by the user before opening the decoder if known
1359 * e.g. from the container. During decoding, the decoder may
1360 * overwrite those values as required.
1362 int coded_width, coded_height;
1364 #if FF_API_ASPECT_EXTENDED
1365 #define FF_ASPECT_EXTENDED 15
1369 * the number of pictures in a group of pictures, or 0 for intra_only
1370 * - encoding: Set by user.
1371 * - decoding: unused
1376 * Pixel format, see AV_PIX_FMT_xxx.
1377 * May be set by the demuxer if known from headers.
1378 * May be overridden by the decoder if it knows better.
1379 * - encoding: Set by user.
1380 * - decoding: Set by user if known, overridden by libavcodec if known
1382 enum AVPixelFormat pix_fmt;
1385 * Motion estimation algorithm used for video coding.
1386 * 1 (zero), 2 (full), 3 (log), 4 (phods), 5 (epzs), 6 (x1), 7 (hex),
1387 * 8 (umh), 9 (iter), 10 (tesa) [7, 8, 10 are x264 specific, 9 is snow specific]
1388 * - encoding: MUST be set by user.
1389 * - decoding: unused
1394 * If non NULL, 'draw_horiz_band' is called by the libavcodec
1395 * decoder to draw a horizontal band. It improves cache usage. Not
1396 * all codecs can do that. You must check the codec capabilities
1398 * When multithreading is used, it may be called from multiple threads
1399 * at the same time; threads might draw different parts of the same AVFrame,
1400 * or multiple AVFrames, and there is no guarantee that slices will be drawn
1402 * The function is also used by hardware acceleration APIs.
1403 * It is called at least once during frame decoding to pass
1404 * the data needed for hardware render.
1405 * In that mode instead of pixel data, AVFrame points to
1406 * a structure specific to the acceleration API. The application
1407 * reads the structure and can change some fields to indicate progress
1409 * - encoding: unused
1410 * - decoding: Set by user.
1411 * @param height the height of the slice
1412 * @param y the y position of the slice
1413 * @param type 1->top field, 2->bottom field, 3->frame
1414 * @param offset offset into the AVFrame.data from which the slice should be read
1416 void (*draw_horiz_band)(struct AVCodecContext *s,
1417 const AVFrame *src, int offset[AV_NUM_DATA_POINTERS],
1418 int y, int type, int height);
1421 * callback to negotiate the pixelFormat
1422 * @param fmt is the list of formats which are supported by the codec,
1423 * it is terminated by -1 as 0 is a valid format, the formats are ordered by quality.
1424 * The first is always the native one.
1425 * @return the chosen format
1426 * - encoding: unused
1427 * - decoding: Set by user, if not set the native format will be chosen.
1429 enum AVPixelFormat (*get_format)(struct AVCodecContext *s, const enum AVPixelFormat * fmt);
1432 * maximum number of B-frames between non-B-frames
1433 * Note: The output will be delayed by max_b_frames+1 relative to the input.
1434 * - encoding: Set by user.
1435 * - decoding: unused
1440 * qscale factor between IP and B-frames
1441 * If > 0 then the last P-frame quantizer will be used (q= lastp_q*factor+offset).
1442 * If < 0 then normal ratecontrol will be done (q= -normal_q*factor+offset).
1443 * - encoding: Set by user.
1444 * - decoding: unused
1446 float b_quant_factor;
1448 /** obsolete FIXME remove */
1450 #define FF_RC_STRATEGY_XVID 1
1452 int b_frame_strategy;
1455 * qscale offset between IP and B-frames
1456 * - encoding: Set by user.
1457 * - decoding: unused
1459 float b_quant_offset;
1462 * Size of the frame reordering buffer in the decoder.
1463 * For MPEG-2 it is 1 IPB or 0 low delay IP.
1464 * - encoding: Set by libavcodec.
1465 * - decoding: Set by libavcodec.
1470 * 0-> h263 quant 1-> mpeg quant
1471 * - encoding: Set by user.
1472 * - decoding: unused
1477 * qscale factor between P and I-frames
1478 * If > 0 then the last p frame quantizer will be used (q= lastp_q*factor+offset).
1479 * If < 0 then normal ratecontrol will be done (q= -normal_q*factor+offset).
1480 * - encoding: Set by user.
1481 * - decoding: unused
1483 float i_quant_factor;
1486 * qscale offset between P and I-frames
1487 * - encoding: Set by user.
1488 * - decoding: unused
1490 float i_quant_offset;
1493 * luminance masking (0-> disabled)
1494 * - encoding: Set by user.
1495 * - decoding: unused
1500 * temporary complexity masking (0-> disabled)
1501 * - encoding: Set by user.
1502 * - decoding: unused
1504 float temporal_cplx_masking;
1507 * spatial complexity masking (0-> disabled)
1508 * - encoding: Set by user.
1509 * - decoding: unused
1511 float spatial_cplx_masking;
1514 * p block masking (0-> disabled)
1515 * - encoding: Set by user.
1516 * - decoding: unused
1521 * darkness masking (0-> disabled)
1522 * - encoding: Set by user.
1523 * - decoding: unused
1529 * - encoding: Set by libavcodec.
1530 * - decoding: Set by user (or 0).
1534 * prediction method (needed for huffyuv)
1535 * - encoding: Set by user.
1536 * - decoding: unused
1538 int prediction_method;
1539 #define FF_PRED_LEFT 0
1540 #define FF_PRED_PLANE 1
1541 #define FF_PRED_MEDIAN 2
1544 * slice offsets in the frame in bytes
1545 * - encoding: Set/allocated by libavcodec.
1546 * - decoding: Set/allocated by user (or NULL).
1551 * sample aspect ratio (0 if unknown)
1552 * That is the width of a pixel divided by the height of the pixel.
1553 * Numerator and denominator must be relatively prime and smaller than 256 for some video standards.
1554 * - encoding: Set by user.
1555 * - decoding: Set by libavcodec.
1557 AVRational sample_aspect_ratio;
1560 * motion estimation comparison function
1561 * - encoding: Set by user.
1562 * - decoding: unused
1566 * subpixel motion estimation comparison function
1567 * - encoding: Set by user.
1568 * - decoding: unused
1572 * macroblock comparison function (not supported yet)
1573 * - encoding: Set by user.
1574 * - decoding: unused
1578 * interlaced DCT comparison function
1579 * - encoding: Set by user.
1580 * - decoding: unused
1583 #define FF_CMP_SAD 0
1584 #define FF_CMP_SSE 1
1585 #define FF_CMP_SATD 2
1586 #define FF_CMP_DCT 3
1587 #define FF_CMP_PSNR 4
1588 #define FF_CMP_BIT 5
1590 #define FF_CMP_ZERO 7
1591 #define FF_CMP_VSAD 8
1592 #define FF_CMP_VSSE 9
1593 #define FF_CMP_NSSE 10
1594 #define FF_CMP_W53 11
1595 #define FF_CMP_W97 12
1596 #define FF_CMP_DCTMAX 13
1597 #define FF_CMP_DCT264 14
1598 #define FF_CMP_CHROMA 256
1601 * ME diamond size & shape
1602 * - encoding: Set by user.
1603 * - decoding: unused
1608 * amount of previous MV predictors (2a+1 x 2a+1 square)
1609 * - encoding: Set by user.
1610 * - decoding: unused
1612 int last_predictor_count;
1615 * prepass for motion estimation
1616 * - encoding: Set by user.
1617 * - decoding: unused
1622 * motion estimation prepass comparison function
1623 * - encoding: Set by user.
1624 * - decoding: unused
1629 * ME prepass diamond size & shape
1630 * - encoding: Set by user.
1631 * - decoding: unused
1637 * - encoding: Set by user.
1638 * - decoding: unused
1640 int me_subpel_quality;
1643 * DTG active format information (additional aspect ratio
1644 * information only used in DVB MPEG-2 transport streams)
1647 * - encoding: unused
1648 * - decoding: Set by decoder.
1650 int dtg_active_format;
1651 #define FF_DTG_AFD_SAME 8
1652 #define FF_DTG_AFD_4_3 9
1653 #define FF_DTG_AFD_16_9 10
1654 #define FF_DTG_AFD_14_9 11
1655 #define FF_DTG_AFD_4_3_SP_14_9 13
1656 #define FF_DTG_AFD_16_9_SP_14_9 14
1657 #define FF_DTG_AFD_SP_4_3 15
1660 * maximum motion estimation search range in subpel units
1661 * If 0 then no limit.
1663 * - encoding: Set by user.
1664 * - decoding: unused
1669 * intra quantizer bias
1670 * - encoding: Set by user.
1671 * - decoding: unused
1673 int intra_quant_bias;
1674 #define FF_DEFAULT_QUANT_BIAS 999999
1677 * inter quantizer bias
1678 * - encoding: Set by user.
1679 * - decoding: unused
1681 int inter_quant_bias;
1685 * - encoding: unused
1686 * - decoding: Set by user.
1689 #define SLICE_FLAG_CODED_ORDER 0x0001 ///< draw_horiz_band() is called in coded order instead of display
1690 #define SLICE_FLAG_ALLOW_FIELD 0x0002 ///< allow draw_horiz_band() with field slices (MPEG2 field pics)
1691 #define SLICE_FLAG_ALLOW_PLANE 0x0004 ///< allow draw_horiz_band() with 1 component at a time (SVQ1)
1695 * XVideo Motion Acceleration
1696 * - encoding: forbidden
1697 * - decoding: set by decoder
1698 * @deprecated XvMC support is slated for removal.
1700 attribute_deprecated int xvmc_acceleration;
1701 #endif /* FF_API_XVMC */
1704 * macroblock decision mode
1705 * - encoding: Set by user.
1706 * - decoding: unused
1709 #define FF_MB_DECISION_SIMPLE 0 ///< uses mb_cmp
1710 #define FF_MB_DECISION_BITS 1 ///< chooses the one which needs the fewest bits
1711 #define FF_MB_DECISION_RD 2 ///< rate distortion
1714 * custom intra quantization matrix
1715 * - encoding: Set by user, can be NULL.
1716 * - decoding: Set by libavcodec.
1718 uint16_t *intra_matrix;
1721 * custom inter quantization matrix
1722 * - encoding: Set by user, can be NULL.
1723 * - decoding: Set by libavcodec.
1725 uint16_t *inter_matrix;
1728 * scene change detection threshold
1729 * 0 is default, larger means fewer detected scene changes.
1730 * - encoding: Set by user.
1731 * - decoding: unused
1733 int scenechange_threshold;
1736 * noise reduction strength
1737 * - encoding: Set by user.
1738 * - decoding: unused
1740 int noise_reduction;
1743 * Motion estimation threshold below which no motion estimation is
1744 * performed, but instead the user specified motion vectors are used.
1746 * - encoding: Set by user.
1747 * - decoding: unused
1752 * Macroblock threshold below which the user specified macroblock types will be used.
1753 * - encoding: Set by user.
1754 * - decoding: unused
1759 * precision of the intra DC coefficient - 8
1760 * - encoding: Set by user.
1761 * - decoding: unused
1763 int intra_dc_precision;
1766 * Number of macroblock rows at the top which are skipped.
1767 * - encoding: unused
1768 * - decoding: Set by user.
1773 * Number of macroblock rows at the bottom which are skipped.
1774 * - encoding: unused
1775 * - decoding: Set by user.
1780 * Border processing masking, raises the quantizer for mbs on the borders
1782 * - encoding: Set by user.
1783 * - decoding: unused
1785 float border_masking;
1788 * minimum MB lagrange multipler
1789 * - encoding: Set by user.
1790 * - decoding: unused
1795 * maximum MB lagrange multipler
1796 * - encoding: Set by user.
1797 * - decoding: unused
1803 * - encoding: Set by user.
1804 * - decoding: unused
1806 int me_penalty_compensation;
1810 * - encoding: Set by user.
1811 * - decoding: unused
1817 * - encoding: Set by user.
1818 * - decoding: unused
1824 * - encoding: Set by user.
1825 * - decoding: unused
1830 * number of reference frames
1831 * - encoding: Set by user.
1832 * - decoding: Set by lavc.
1837 * chroma qp offset from luma
1838 * - encoding: Set by user.
1839 * - decoding: unused
1844 * Multiplied by qscale for each frame and added to scene_change_score.
1845 * - encoding: Set by user.
1846 * - decoding: unused
1848 int scenechange_factor;
1852 * Note: Value depends upon the compare function used for fullpel ME.
1853 * - encoding: Set by user.
1854 * - decoding: unused
1859 * Adjust sensitivity of b_frame_strategy 1.
1860 * - encoding: Set by user.
1861 * - decoding: unused
1866 * Chromaticity coordinates of the source primaries.
1867 * - encoding: Set by user
1868 * - decoding: Set by libavcodec
1870 enum AVColorPrimaries color_primaries;
1873 * Color Transfer Characteristic.
1874 * - encoding: Set by user
1875 * - decoding: Set by libavcodec
1877 enum AVColorTransferCharacteristic color_trc;
1880 * YUV colorspace type.
1881 * - encoding: Set by user
1882 * - decoding: Set by libavcodec
1884 enum AVColorSpace colorspace;
1887 * MPEG vs JPEG YUV range.
1888 * - encoding: Set by user
1889 * - decoding: Set by libavcodec
1891 enum AVColorRange color_range;
1894 * This defines the location of chroma samples.
1895 * - encoding: Set by user
1896 * - decoding: Set by libavcodec
1898 enum AVChromaLocation chroma_sample_location;
1902 * Indicates number of picture subdivisions. Used for parallelized
1904 * - encoding: Set by user
1905 * - decoding: unused
1910 * - encoding: set by libavcodec
1911 * - decoding: Set by user.
1913 enum AVFieldOrder field_order;
1916 int sample_rate; ///< samples per second
1917 int channels; ///< number of audio channels
1920 * audio sample format
1921 * - encoding: Set by user.
1922 * - decoding: Set by libavcodec.
1924 enum AVSampleFormat sample_fmt; ///< sample format
1926 /* The following data should not be initialized. */
1928 * Number of samples per channel in an audio frame.
1930 * - encoding: set by libavcodec in avcodec_open2(). Each submitted frame
1931 * except the last must contain exactly frame_size samples per channel.
1932 * May be 0 when the codec has CODEC_CAP_VARIABLE_FRAME_SIZE set, then the
1933 * frame size is not restricted.
1934 * - decoding: may be set by some decoders to indicate constant frame size
1939 * Frame counter, set by libavcodec.
1941 * - decoding: total number of frames returned from the decoder so far.
1942 * - encoding: total number of frames passed to the encoder so far.
1944 * @note the counter is not incremented if encoding/decoding resulted in
1950 * number of bytes per packet if constant and known or 0
1951 * Used by some WAV based audio codecs.
1956 * Audio cutoff bandwidth (0 means "automatic")
1957 * - encoding: Set by user.
1958 * - decoding: unused
1962 #if FF_API_REQUEST_CHANNELS
1964 * Decoder should decode to this many channels if it can (0 for default)
1965 * - encoding: unused
1966 * - decoding: Set by user.
1967 * @deprecated Deprecated in favor of request_channel_layout.
1969 attribute_deprecated int request_channels;
1973 * Audio channel layout.
1974 * - encoding: set by user.
1975 * - decoding: set by user, may be overwritten by libavcodec.
1977 uint64_t channel_layout;
1980 * Request decoder to use this channel layout if it can (0 for default)
1981 * - encoding: unused
1982 * - decoding: Set by user.
1984 uint64_t request_channel_layout;
1987 * Type of service that the audio stream conveys.
1988 * - encoding: Set by user.
1989 * - decoding: Set by libavcodec.
1991 enum AVAudioServiceType audio_service_type;
1994 * desired sample format
1995 * - encoding: Not used.
1996 * - decoding: Set by user.
1997 * Decoder will decode to this format if it can.
1999 enum AVSampleFormat request_sample_fmt;
2001 #if FF_API_GET_BUFFER
2003 * Called at the beginning of each frame to get a buffer for it.
2005 * The function will set AVFrame.data[], AVFrame.linesize[].
2006 * AVFrame.extended_data[] must also be set, but it should be the same as
2007 * AVFrame.data[] except for planar audio with more channels than can fit
2008 * in AVFrame.data[]. In that case, AVFrame.data[] shall still contain as
2009 * many data pointers as it can hold.
2011 * if CODEC_CAP_DR1 is not set then get_buffer() must call
2012 * avcodec_default_get_buffer() instead of providing buffers allocated by
2015 * AVFrame.data[] should be 32- or 16-byte-aligned unless the CPU doesn't
2016 * need it. avcodec_default_get_buffer() aligns the output buffer properly,
2017 * but if get_buffer() is overridden then alignment considerations should
2018 * be taken into account.
2020 * @see avcodec_default_get_buffer()
2024 * If pic.reference is set then the frame will be read later by libavcodec.
2025 * avcodec_align_dimensions2() should be used to find the required width and
2026 * height, as they normally need to be rounded up to the next multiple of 16.
2028 * If frame multithreading is used and thread_safe_callbacks is set,
2029 * it may be called from a different thread, but not from more than one at
2030 * once. Does not need to be reentrant.
2032 * @see release_buffer(), reget_buffer()
2033 * @see avcodec_align_dimensions2()
2037 * Decoders request a buffer of a particular size by setting
2038 * AVFrame.nb_samples prior to calling get_buffer(). The decoder may,
2039 * however, utilize only part of the buffer by setting AVFrame.nb_samples
2040 * to a smaller value in the output frame.
2042 * Decoders cannot use the buffer after returning from
2043 * avcodec_decode_audio4(), so they will not call release_buffer(), as it
2044 * is assumed to be released immediately upon return. In some rare cases,
2045 * a decoder may need to call get_buffer() more than once in a single
2046 * call to avcodec_decode_audio4(). In that case, when get_buffer() is
2047 * called again after it has already been called once, the previously
2048 * acquired buffer is assumed to be released at that time and may not be
2049 * reused by the decoder.
2051 * As a convenience, av_samples_get_buffer_size() and
2052 * av_samples_fill_arrays() in libavutil may be used by custom get_buffer()
2053 * functions to find the required data size and to fill data pointers and
2054 * linesize. In AVFrame.linesize, only linesize[0] may be set for audio
2055 * since all planes must be the same size.
2057 * @see av_samples_get_buffer_size(), av_samples_fill_arrays()
2059 * - encoding: unused
2060 * - decoding: Set by libavcodec, user can override.
2062 * @deprecated use get_buffer2()
2064 attribute_deprecated
2065 int (*get_buffer)(struct AVCodecContext *c, AVFrame *pic);
2068 * Called to release buffers which were allocated with get_buffer.
2069 * A released buffer can be reused in get_buffer().
2070 * pic.data[*] must be set to NULL.
2071 * May be called from a different thread if frame multithreading is used,
2072 * but not by more than one thread at once, so does not need to be reentrant.
2073 * - encoding: unused
2074 * - decoding: Set by libavcodec, user can override.
2076 * @deprecated custom freeing callbacks should be set from get_buffer2()
2078 attribute_deprecated
2079 void (*release_buffer)(struct AVCodecContext *c, AVFrame *pic);
2082 * Called at the beginning of a frame to get cr buffer for it.
2083 * Buffer type (size, hints) must be the same. libavcodec won't check it.
2084 * libavcodec will pass previous buffer in pic, function should return
2085 * same buffer or new buffer with old frame "painted" into it.
2086 * If pic.data[0] == NULL must behave like get_buffer().
2087 * if CODEC_CAP_DR1 is not set then reget_buffer() must call
2088 * avcodec_default_reget_buffer() instead of providing buffers allocated by
2090 * - encoding: unused
2091 * - decoding: Set by libavcodec, user can override.
2093 attribute_deprecated
2094 int (*reget_buffer)(struct AVCodecContext *c, AVFrame *pic);
2098 * This callback is called at the beginning of each frame to get data
2099 * buffer(s) for it. There may be one contiguous buffer for all the data or
2100 * there may be a buffer per each data plane or anything in between. What
2101 * this means is, you may set however many entries in buf[] you feel necessary.
2102 * Each buffer must be reference-counted using the AVBuffer API (see description
2105 * The following fields will be set in the frame before this callback is
2108 * - width, height (video only)
2109 * - sample_rate, channel_layout, nb_samples (audio only)
2110 * Their values may differ from the corresponding values in
2111 * AVCodecContext. This callback must use the frame values, not the codec
2112 * context values, to calculate the required buffer size.
2114 * This callback must fill the following fields in the frame:
2118 * * if the data is planar audio with more than 8 channels, then this
2119 * callback must allocate and fill extended_data to contain all pointers
2120 * to all data planes. data[] must hold as many pointers as it can.
2121 * extended_data must be allocated with av_malloc() and will be freed in
2123 * * otherwise exended_data must point to data
2124 * - buf[] must contain one or more pointers to AVBufferRef structures. Each of
2125 * the frame's data and extended_data pointers must be contained in these. That
2126 * is, one AVBufferRef for each allocated chunk of memory, not necessarily one
2127 * AVBufferRef per data[] entry. See: av_buffer_create(), av_buffer_alloc(),
2128 * and av_buffer_ref().
2129 * - extended_buf and nb_extended_buf must be allocated with av_malloc() by
2130 * this callback and filled with the extra buffers if there are more
2131 * buffers than buf[] can hold. extended_buf will be freed in
2134 * If CODEC_CAP_DR1 is not set then get_buffer2() must call
2135 * avcodec_default_get_buffer2() instead of providing buffers allocated by
2138 * Each data plane must be aligned to the maximum required by the target
2141 * @see avcodec_default_get_buffer2()
2145 * If AV_GET_BUFFER_FLAG_REF is set in flags then the frame may be reused
2146 * (read and/or written to if it is writable) later by libavcodec.
2148 * If CODEC_FLAG_EMU_EDGE is not set in s->flags, the buffer must contain an
2149 * edge of the size returned by avcodec_get_edge_width() on all sides.
2151 * avcodec_align_dimensions2() should be used to find the required width and
2152 * height, as they normally need to be rounded up to the next multiple of 16.
2154 * If frame multithreading is used and thread_safe_callbacks is set,
2155 * this callback may be called from a different thread, but not from more
2156 * than one at once. Does not need to be reentrant.
2158 * @see avcodec_align_dimensions2()
2162 * Decoders request a buffer of a particular size by setting
2163 * AVFrame.nb_samples prior to calling get_buffer2(). The decoder may,
2164 * however, utilize only part of the buffer by setting AVFrame.nb_samples
2165 * to a smaller value in the output frame.
2167 * As a convenience, av_samples_get_buffer_size() and
2168 * av_samples_fill_arrays() in libavutil may be used by custom get_buffer2()
2169 * functions to find the required data size and to fill data pointers and
2170 * linesize. In AVFrame.linesize, only linesize[0] may be set for audio
2171 * since all planes must be the same size.
2173 * @see av_samples_get_buffer_size(), av_samples_fill_arrays()
2175 * - encoding: unused
2176 * - decoding: Set by libavcodec, user can override.
2178 int (*get_buffer2)(struct AVCodecContext *s, AVFrame *frame, int flags);
2181 * If non-zero, the decoded audio and video frames returned from
2182 * avcodec_decode_video2() and avcodec_decode_audio4() are reference-counted
2183 * and are valid indefinitely. The caller must free them with
2184 * av_frame_unref() when they are not needed anymore.
2185 * Otherwise, the decoded frames must not be freed by the caller and are
2186 * only valid until the next decode call.
2188 * - encoding: unused
2189 * - decoding: set by the caller before avcodec_open2().
2191 int refcounted_frames;
2193 /* - encoding parameters */
2194 float qcompress; ///< amount of qscale change between easy & hard scenes (0.0-1.0)
2195 float qblur; ///< amount of qscale smoothing over time (0.0-1.0)
2199 * - encoding: Set by user.
2200 * - decoding: unused
2206 * - encoding: Set by user.
2207 * - decoding: unused
2212 * maximum quantizer difference between frames
2213 * - encoding: Set by user.
2214 * - decoding: unused
2219 * ratecontrol qmin qmax limiting method
2220 * 0-> clipping, 1-> use a nice continuous function to limit qscale wthin qmin/qmax.
2221 * - encoding: Set by user.
2222 * - decoding: unused
2230 * decoder bitstream buffer size
2231 * - encoding: Set by user.
2232 * - decoding: unused
2237 * ratecontrol override, see RcOverride
2238 * - encoding: Allocated/set/freed by user.
2239 * - decoding: unused
2241 int rc_override_count;
2242 RcOverride *rc_override;
2245 * rate control equation
2246 * - encoding: Set by user
2247 * - decoding: unused
2253 * - encoding: Set by user.
2254 * - decoding: unused
2260 * - encoding: Set by user.
2261 * - decoding: unused
2265 float rc_buffer_aggressivity;
2268 * initial complexity for pass1 ratecontrol
2269 * - encoding: Set by user.
2270 * - decoding: unused
2272 float rc_initial_cplx;
2275 * Ratecontrol attempt to use, at maximum, <value> of what can be used without an underflow.
2276 * - encoding: Set by user.
2277 * - decoding: unused.
2279 float rc_max_available_vbv_use;
2282 * Ratecontrol attempt to use, at least, <value> times the amount needed to prevent a vbv overflow.
2283 * - encoding: Set by user.
2284 * - decoding: unused.
2286 float rc_min_vbv_overflow_use;
2289 * Number of bits which should be loaded into the rc buffer before decoding starts.
2290 * - encoding: Set by user.
2291 * - decoding: unused
2293 int rc_initial_buffer_occupancy;
2295 #define FF_CODER_TYPE_VLC 0
2296 #define FF_CODER_TYPE_AC 1
2297 #define FF_CODER_TYPE_RAW 2
2298 #define FF_CODER_TYPE_RLE 3
2299 #define FF_CODER_TYPE_DEFLATE 4
2302 * - encoding: Set by user.
2303 * - decoding: unused
2309 * - encoding: Set by user.
2310 * - decoding: unused
2315 * minimum Lagrange multipler
2316 * - encoding: Set by user.
2317 * - decoding: unused
2322 * maximum Lagrange multipler
2323 * - encoding: Set by user.
2324 * - decoding: unused
2329 * frame skip threshold
2330 * - encoding: Set by user.
2331 * - decoding: unused
2333 int frame_skip_threshold;
2337 * - encoding: Set by user.
2338 * - decoding: unused
2340 int frame_skip_factor;
2343 * frame skip exponent
2344 * - encoding: Set by user.
2345 * - decoding: unused
2350 * frame skip comparison function
2351 * - encoding: Set by user.
2352 * - decoding: unused
2357 * trellis RD quantization
2358 * - encoding: Set by user.
2359 * - decoding: unused
2364 * - encoding: Set by user.
2365 * - decoding: unused
2367 int min_prediction_order;
2370 * - encoding: Set by user.
2371 * - decoding: unused
2373 int max_prediction_order;
2376 * GOP timecode frame start number
2377 * - encoding: Set by user, in non drop frame format
2378 * - decoding: Set by libavcodec (timecode in the 25 bits format, -1 if unset)
2380 int64_t timecode_frame_start;
2382 /* The RTP callback: This function is called */
2383 /* every time the encoder has a packet to send. */
2384 /* It depends on the encoder if the data starts */
2385 /* with a Start Code (it should). H.263 does. */
2386 /* mb_nb contains the number of macroblocks */
2387 /* encoded in the RTP payload. */
2388 void (*rtp_callback)(struct AVCodecContext *avctx, void *data, int size, int mb_nb);
2390 int rtp_payload_size; /* The size of the RTP payload: the coder will */
2391 /* do its best to deliver a chunk with size */
2392 /* below rtp_payload_size, the chunk will start */
2393 /* with a start code on some codecs like H.263. */
2394 /* This doesn't take account of any particular */
2395 /* headers inside the transmitted RTP payload. */
2397 /* statistics, used for 2-pass encoding */
2408 * number of bits used for the previously encoded frame
2409 * - encoding: Set by libavcodec.
2410 * - decoding: unused
2415 * pass1 encoding statistics output buffer
2416 * - encoding: Set by libavcodec.
2417 * - decoding: unused
2422 * pass2 encoding statistics input buffer
2423 * Concatenated stuff from stats_out of pass1 should be placed here.
2424 * - encoding: Allocated/set/freed by user.
2425 * - decoding: unused
2430 * Work around bugs in encoders which sometimes cannot be detected automatically.
2431 * - encoding: Set by user
2432 * - decoding: Set by user
2434 int workaround_bugs;
2435 #define FF_BUG_AUTODETECT 1 ///< autodetection
2436 #if FF_API_OLD_MSMPEG4
2437 #define FF_BUG_OLD_MSMPEG4 2
2439 #define FF_BUG_XVID_ILACE 4
2440 #define FF_BUG_UMP4 8
2441 #define FF_BUG_NO_PADDING 16
2442 #define FF_BUG_AMV 32
2444 #define FF_BUG_AC_VLC 0 ///< Will be removed, libavcodec can now handle these non-compliant files by default.
2446 #define FF_BUG_QPEL_CHROMA 64
2447 #define FF_BUG_STD_QPEL 128
2448 #define FF_BUG_QPEL_CHROMA2 256
2449 #define FF_BUG_DIRECT_BLOCKSIZE 512
2450 #define FF_BUG_EDGE 1024
2451 #define FF_BUG_HPEL_CHROMA 2048
2452 #define FF_BUG_DC_CLIP 4096
2453 #define FF_BUG_MS 8192 ///< Work around various bugs in Microsoft's broken decoders.
2454 #define FF_BUG_TRUNCATED 16384
2457 * strictly follow the standard (MPEG4, ...).
2458 * - encoding: Set by user.
2459 * - decoding: Set by user.
2460 * Setting this to STRICT or higher means the encoder and decoder will
2461 * generally do stupid things, whereas setting it to unofficial or lower
2462 * will mean the encoder might produce output that is not supported by all
2463 * spec-compliant decoders. Decoders don't differentiate between normal,
2464 * unofficial and experimental (that is, they always try to decode things
2465 * when they can) unless they are explicitly asked to behave stupidly
2466 * (=strictly conform to the specs)
2468 int strict_std_compliance;
2469 #define FF_COMPLIANCE_VERY_STRICT 2 ///< Strictly conform to an older more strict version of the spec or reference software.
2470 #define FF_COMPLIANCE_STRICT 1 ///< Strictly conform to all the things in the spec no matter what consequences.
2471 #define FF_COMPLIANCE_NORMAL 0
2472 #define FF_COMPLIANCE_UNOFFICIAL -1 ///< Allow unofficial extensions
2473 #define FF_COMPLIANCE_EXPERIMENTAL -2 ///< Allow nonstandardized experimental things.
2476 * error concealment flags
2477 * - encoding: unused
2478 * - decoding: Set by user.
2480 int error_concealment;
2481 #define FF_EC_GUESS_MVS 1
2482 #define FF_EC_DEBLOCK 2
2486 * - encoding: Set by user.
2487 * - decoding: Set by user.
2490 #define FF_DEBUG_PICT_INFO 1
2491 #define FF_DEBUG_RC 2
2492 #define FF_DEBUG_BITSTREAM 4
2493 #define FF_DEBUG_MB_TYPE 8
2494 #define FF_DEBUG_QP 16
2497 * @deprecated this option does nothing
2499 #define FF_DEBUG_MV 32
2501 #define FF_DEBUG_DCT_COEFF 0x00000040
2502 #define FF_DEBUG_SKIP 0x00000080
2503 #define FF_DEBUG_STARTCODE 0x00000100
2504 #define FF_DEBUG_PTS 0x00000200
2505 #define FF_DEBUG_ER 0x00000400
2506 #define FF_DEBUG_MMCO 0x00000800
2507 #define FF_DEBUG_BUGS 0x00001000
2509 #define FF_DEBUG_VIS_QP 0x00002000 ///< only access through AVOptions from outside libavcodec
2510 #define FF_DEBUG_VIS_MB_TYPE 0x00004000 ///< only access through AVOptions from outside libavcodec
2512 #define FF_DEBUG_BUFFERS 0x00008000
2513 #define FF_DEBUG_THREADS 0x00010000
2518 * Code outside libavcodec should access this field using AVOptions
2519 * - encoding: Set by user.
2520 * - decoding: Set by user.
2523 #define FF_DEBUG_VIS_MV_P_FOR 0x00000001 //visualize forward predicted MVs of P frames
2524 #define FF_DEBUG_VIS_MV_B_FOR 0x00000002 //visualize forward predicted MVs of B frames
2525 #define FF_DEBUG_VIS_MV_B_BACK 0x00000004 //visualize backward predicted MVs of B frames
2529 * Error recognition; may misdetect some more or less valid parts as errors.
2530 * - encoding: unused
2531 * - decoding: Set by user.
2533 int err_recognition;
2536 * Verify checksums embedded in the bitstream (could be of either encoded or
2537 * decoded data, depending on the codec) and print an error message on mismatch.
2538 * If AV_EF_EXPLODE is also set, a mismatching checksum will result in the
2539 * decoder returning an error.
2541 #define AV_EF_CRCCHECK (1<<0)
2542 #define AV_EF_BITSTREAM (1<<1) ///< detect bitstream specification deviations
2543 #define AV_EF_BUFFER (1<<2) ///< detect improper bitstream length
2544 #define AV_EF_EXPLODE (1<<3) ///< abort decoding on minor error detection
2546 #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
2547 #define AV_EF_COMPLIANT (1<<17) ///< consider all spec non compliancies as errors
2548 #define AV_EF_AGGRESSIVE (1<<18) ///< consider things that a sane encoder should not do as an error
2552 * opaque 64bit number (generally a PTS) that will be reordered and
2553 * output in AVFrame.reordered_opaque
2554 * @deprecated in favor of pkt_pts
2555 * - encoding: unused
2556 * - decoding: Set by user.
2558 int64_t reordered_opaque;
2561 * Hardware accelerator in use
2562 * - encoding: unused.
2563 * - decoding: Set by libavcodec
2565 struct AVHWAccel *hwaccel;
2568 * Hardware accelerator context.
2569 * For some hardware accelerators, a global context needs to be
2570 * provided by the user. In that case, this holds display-dependent
2571 * data FFmpeg cannot instantiate itself. Please refer to the
2572 * FFmpeg HW accelerator documentation to know how to fill this
2573 * is. e.g. for VA API, this is a struct vaapi_context.
2574 * - encoding: unused
2575 * - decoding: Set by user
2577 void *hwaccel_context;
2581 * - encoding: Set by libavcodec if flags&CODEC_FLAG_PSNR.
2582 * - decoding: unused
2584 uint64_t error[AV_NUM_DATA_POINTERS];
2587 * DCT algorithm, see FF_DCT_* below
2588 * - encoding: Set by user.
2589 * - decoding: unused
2592 #define FF_DCT_AUTO 0
2593 #define FF_DCT_FASTINT 1
2594 #define FF_DCT_INT 2
2595 #define FF_DCT_MMX 3
2596 #define FF_DCT_ALTIVEC 5
2597 #define FF_DCT_FAAN 6
2600 * IDCT algorithm, see FF_IDCT_* below.
2601 * - encoding: Set by user.
2602 * - decoding: Set by user.
2605 #define FF_IDCT_AUTO 0
2606 #define FF_IDCT_INT 1
2607 #define FF_IDCT_SIMPLE 2
2608 #define FF_IDCT_SIMPLEMMX 3
2609 #define FF_IDCT_ARM 7
2610 #define FF_IDCT_ALTIVEC 8
2611 #define FF_IDCT_SH4 9
2612 #define FF_IDCT_SIMPLEARM 10
2613 #define FF_IDCT_IPP 13
2614 #define FF_IDCT_XVIDMMX 14
2615 #define FF_IDCT_SIMPLEARMV5TE 16
2616 #define FF_IDCT_SIMPLEARMV6 17
2617 #define FF_IDCT_SIMPLEVIS 18
2618 #define FF_IDCT_FAAN 20
2619 #define FF_IDCT_SIMPLENEON 22
2620 #if FF_API_ARCH_ALPHA
2621 #define FF_IDCT_SIMPLEALPHA 23
2625 * bits per sample/pixel from the demuxer (needed for huffyuv).
2626 * - encoding: Set by libavcodec.
2627 * - decoding: Set by user.
2629 int bits_per_coded_sample;
2632 * Bits per sample/pixel of internal libavcodec pixel/sample format.
2633 * - encoding: set by user.
2634 * - decoding: set by libavcodec.
2636 int bits_per_raw_sample;
2640 * low resolution decoding, 1-> 1/2 size, 2->1/4 size
2641 * - encoding: unused
2642 * - decoding: Set by user.
2643 * Code outside libavcodec should access this field using:
2644 * av_codec_{get,set}_lowres(avctx)
2650 * the picture in the bitstream
2651 * - encoding: Set by libavcodec.
2652 * - decoding: unused
2654 AVFrame *coded_frame;
2658 * is used to decide how many independent tasks should be passed to execute()
2659 * - encoding: Set by user.
2660 * - decoding: Set by user.
2665 * Which multithreading methods to use.
2666 * Use of FF_THREAD_FRAME will increase decoding delay by one frame per thread,
2667 * so clients which cannot provide future frames should not use it.
2669 * - encoding: Set by user, otherwise the default is used.
2670 * - decoding: Set by user, otherwise the default is used.
2673 #define FF_THREAD_FRAME 1 ///< Decode more than one frame at once
2674 #define FF_THREAD_SLICE 2 ///< Decode more than one part of a single frame at once
2677 * Which multithreading methods are in use by the codec.
2678 * - encoding: Set by libavcodec.
2679 * - decoding: Set by libavcodec.
2681 int active_thread_type;
2684 * Set by the client if its custom get_buffer() callback can be called
2685 * synchronously from another thread, which allows faster multithreaded decoding.
2686 * draw_horiz_band() will be called from other threads regardless of this setting.
2687 * Ignored if the default get_buffer() is used.
2688 * - encoding: Set by user.
2689 * - decoding: Set by user.
2691 int thread_safe_callbacks;
2694 * The codec may call this to execute several independent things.
2695 * It will return only after finishing all tasks.
2696 * The user may replace this with some multithreaded implementation,
2697 * the default implementation will execute the parts serially.
2698 * @param count the number of things to execute
2699 * - encoding: Set by libavcodec, user can override.
2700 * - decoding: Set by libavcodec, user can override.
2702 int (*execute)(struct AVCodecContext *c, int (*func)(struct AVCodecContext *c2, void *arg), void *arg2, int *ret, int count, int size);
2705 * The codec may call this to execute several independent things.
2706 * It will return only after finishing all tasks.
2707 * The user may replace this with some multithreaded implementation,
2708 * the default implementation will execute the parts serially.
2709 * Also see avcodec_thread_init and e.g. the --enable-pthread configure option.
2710 * @param c context passed also to func
2711 * @param count the number of things to execute
2712 * @param arg2 argument passed unchanged to func
2713 * @param ret return values of executed functions, must have space for "count" values. May be NULL.
2714 * @param func function that will be called count times, with jobnr from 0 to count-1.
2715 * threadnr will be in the range 0 to c->thread_count-1 < MAX_THREADS and so that no
2716 * two instances of func executing at the same time will have the same threadnr.
2717 * @return always 0 currently, but code should handle a future improvement where when any call to func
2718 * returns < 0 no further calls to func may be done and < 0 is returned.
2719 * - encoding: Set by libavcodec, user can override.
2720 * - decoding: Set by libavcodec, user can override.
2722 int (*execute2)(struct AVCodecContext *c, int (*func)(struct AVCodecContext *c2, void *arg, int jobnr, int threadnr), void *arg2, int *ret, int count);
2724 #if FF_API_THREAD_OPAQUE
2726 * @deprecated this field should not be used from outside of lavc
2728 attribute_deprecated
2729 void *thread_opaque;
2733 * noise vs. sse weight for the nsse comparsion function
2734 * - encoding: Set by user.
2735 * - decoding: unused
2741 * - encoding: Set by user.
2742 * - decoding: Set by libavcodec.
2745 #define FF_PROFILE_UNKNOWN -99
2746 #define FF_PROFILE_RESERVED -100
2748 #define FF_PROFILE_AAC_MAIN 0
2749 #define FF_PROFILE_AAC_LOW 1
2750 #define FF_PROFILE_AAC_SSR 2
2751 #define FF_PROFILE_AAC_LTP 3
2752 #define FF_PROFILE_AAC_HE 4
2753 #define FF_PROFILE_AAC_HE_V2 28
2754 #define FF_PROFILE_AAC_LD 22
2755 #define FF_PROFILE_AAC_ELD 38
2756 #define FF_PROFILE_MPEG2_AAC_LOW 128
2757 #define FF_PROFILE_MPEG2_AAC_HE 131
2759 #define FF_PROFILE_DTS 20
2760 #define FF_PROFILE_DTS_ES 30
2761 #define FF_PROFILE_DTS_96_24 40
2762 #define FF_PROFILE_DTS_HD_HRA 50
2763 #define FF_PROFILE_DTS_HD_MA 60
2765 #define FF_PROFILE_MPEG2_422 0
2766 #define FF_PROFILE_MPEG2_HIGH 1
2767 #define FF_PROFILE_MPEG2_SS 2
2768 #define FF_PROFILE_MPEG2_SNR_SCALABLE 3
2769 #define FF_PROFILE_MPEG2_MAIN 4
2770 #define FF_PROFILE_MPEG2_SIMPLE 5
2772 #define FF_PROFILE_H264_CONSTRAINED (1<<9) // 8+1; constraint_set1_flag
2773 #define FF_PROFILE_H264_INTRA (1<<11) // 8+3; constraint_set3_flag
2775 #define FF_PROFILE_H264_BASELINE 66
2776 #define FF_PROFILE_H264_CONSTRAINED_BASELINE (66|FF_PROFILE_H264_CONSTRAINED)
2777 #define FF_PROFILE_H264_MAIN 77
2778 #define FF_PROFILE_H264_EXTENDED 88
2779 #define FF_PROFILE_H264_HIGH 100
2780 #define FF_PROFILE_H264_HIGH_10 110
2781 #define FF_PROFILE_H264_HIGH_10_INTRA (110|FF_PROFILE_H264_INTRA)
2782 #define FF_PROFILE_H264_HIGH_422 122
2783 #define FF_PROFILE_H264_HIGH_422_INTRA (122|FF_PROFILE_H264_INTRA)
2784 #define FF_PROFILE_H264_HIGH_444 144
2785 #define FF_PROFILE_H264_HIGH_444_PREDICTIVE 244
2786 #define FF_PROFILE_H264_HIGH_444_INTRA (244|FF_PROFILE_H264_INTRA)
2787 #define FF_PROFILE_H264_CAVLC_444 44
2789 #define FF_PROFILE_VC1_SIMPLE 0
2790 #define FF_PROFILE_VC1_MAIN 1
2791 #define FF_PROFILE_VC1_COMPLEX 2
2792 #define FF_PROFILE_VC1_ADVANCED 3
2794 #define FF_PROFILE_MPEG4_SIMPLE 0
2795 #define FF_PROFILE_MPEG4_SIMPLE_SCALABLE 1
2796 #define FF_PROFILE_MPEG4_CORE 2
2797 #define FF_PROFILE_MPEG4_MAIN 3
2798 #define FF_PROFILE_MPEG4_N_BIT 4
2799 #define FF_PROFILE_MPEG4_SCALABLE_TEXTURE 5
2800 #define FF_PROFILE_MPEG4_SIMPLE_FACE_ANIMATION 6
2801 #define FF_PROFILE_MPEG4_BASIC_ANIMATED_TEXTURE 7
2802 #define FF_PROFILE_MPEG4_HYBRID 8
2803 #define FF_PROFILE_MPEG4_ADVANCED_REAL_TIME 9
2804 #define FF_PROFILE_MPEG4_CORE_SCALABLE 10
2805 #define FF_PROFILE_MPEG4_ADVANCED_CODING 11
2806 #define FF_PROFILE_MPEG4_ADVANCED_CORE 12
2807 #define FF_PROFILE_MPEG4_ADVANCED_SCALABLE_TEXTURE 13
2808 #define FF_PROFILE_MPEG4_SIMPLE_STUDIO 14
2809 #define FF_PROFILE_MPEG4_ADVANCED_SIMPLE 15
2811 #define FF_PROFILE_JPEG2000_CSTREAM_RESTRICTION_0 0
2812 #define FF_PROFILE_JPEG2000_CSTREAM_RESTRICTION_1 1
2813 #define FF_PROFILE_JPEG2000_CSTREAM_NO_RESTRICTION 2
2814 #define FF_PROFILE_JPEG2000_DCINEMA_2K 3
2815 #define FF_PROFILE_JPEG2000_DCINEMA_4K 4
2818 #define FF_PROFILE_HEVC_MAIN 1
2819 #define FF_PROFILE_HEVC_MAIN_10 2
2820 #define FF_PROFILE_HEVC_MAIN_STILL_PICTURE 3
2824 * - encoding: Set by user.
2825 * - decoding: Set by libavcodec.
2828 #define FF_LEVEL_UNKNOWN -99
2831 * Skip loop filtering for selected frames.
2832 * - encoding: unused
2833 * - decoding: Set by user.
2835 enum AVDiscard skip_loop_filter;
2838 * Skip IDCT/dequantization for selected frames.
2839 * - encoding: unused
2840 * - decoding: Set by user.
2842 enum AVDiscard skip_idct;
2845 * Skip decoding for selected frames.
2846 * - encoding: unused
2847 * - decoding: Set by user.
2849 enum AVDiscard skip_frame;
2852 * Header containing style information for text subtitles.
2853 * For SUBTITLE_ASS subtitle type, it should contain the whole ASS
2854 * [Script Info] and [V4+ Styles] section, plus the [Events] line and
2855 * the Format line following. It shouldn't include any Dialogue line.
2856 * - encoding: Set/allocated/freed by user (before avcodec_open2())
2857 * - decoding: Set/allocated/freed by libavcodec (by avcodec_open2())
2859 uint8_t *subtitle_header;
2860 int subtitle_header_size;
2862 #if FF_API_ERROR_RATE
2864 * @deprecated use the 'error_rate' private AVOption of the mpegvideo
2867 attribute_deprecated
2871 #if FF_API_CODEC_PKT
2873 * @deprecated this field is not supposed to be accessed from outside lavc
2875 attribute_deprecated
2880 * VBV delay coded in the last frame (in periods of a 27 MHz clock).
2881 * Used for compliant TS muxing.
2882 * - encoding: Set by libavcodec.
2883 * - decoding: unused.
2888 * Timebase in which pkt_dts/pts and AVPacket.dts/pts are.
2889 * Code outside libavcodec should access this field using:
2890 * av_codec_{get,set}_pkt_timebase(avctx)
2891 * - encoding unused.
2892 * - decoding set by user.
2894 AVRational pkt_timebase;
2898 * Code outside libavcodec should access this field using:
2899 * av_codec_{get,set}_codec_descriptor(avctx)
2900 * - encoding: unused.
2901 * - decoding: set by libavcodec.
2903 const AVCodecDescriptor *codec_descriptor;
2907 * low resolution decoding, 1-> 1/2 size, 2->1/4 size
2908 * - encoding: unused
2909 * - decoding: Set by user.
2910 * Code outside libavcodec should access this field using:
2911 * av_codec_{get,set}_lowres(avctx)
2917 * Current statistics for PTS correction.
2918 * - decoding: maintained and used by libavcodec, not intended to be used by user apps
2919 * - encoding: unused
2921 int64_t pts_correction_num_faulty_pts; /// Number of incorrect PTS values so far
2922 int64_t pts_correction_num_faulty_dts; /// Number of incorrect DTS values so far
2923 int64_t pts_correction_last_pts; /// PTS of the last frame
2924 int64_t pts_correction_last_dts; /// DTS of the last frame
2927 * Character encoding of the input subtitles file.
2928 * - decoding: set by user
2929 * - encoding: unused
2934 * Subtitles character encoding mode. Formats or codecs might be adjusting
2935 * this setting (if they are doing the conversion themselves for instance).
2936 * - decoding: set by libavcodec
2937 * - encoding: unused
2939 int sub_charenc_mode;
2940 #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)
2941 #define FF_SUB_CHARENC_MODE_AUTOMATIC 0 ///< libavcodec will select the mode itself
2942 #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
2945 * Skip processing alpha if supported by codec.
2946 * Note that if the format uses pre-multiplied alpha (common with VP6,
2947 * and recommended due to better video quality/compression)
2948 * the image will look as if alpha-blended onto a black background.
2949 * However for formats that do not use pre-multiplied alpha
2950 * there might be serious artefacts (though e.g. libswscale currently
2951 * assumes pre-multiplied alpha anyway).
2952 * Code outside libavcodec should access this field using AVOptions
2954 * - decoding: set by user
2955 * - encoding: unused
2960 * Number of samples to skip after a discontinuity
2961 * - decoding: unused
2962 * - encoding: set by libavcodec
2966 #if !FF_API_DEBUG_MV
2968 * debug motion vectors
2969 * Code outside libavcodec should access this field using AVOptions
2970 * - encoding: Set by user.
2971 * - decoding: Set by user.
2974 #define FF_DEBUG_VIS_MV_P_FOR 0x00000001 //visualize forward predicted MVs of P frames
2975 #define FF_DEBUG_VIS_MV_B_FOR 0x00000002 //visualize forward predicted MVs of B frames
2976 #define FF_DEBUG_VIS_MV_B_BACK 0x00000004 //visualize backward predicted MVs of B frames
2980 AVRational av_codec_get_pkt_timebase (const AVCodecContext *avctx);
2981 void av_codec_set_pkt_timebase (AVCodecContext *avctx, AVRational val);
2983 const AVCodecDescriptor *av_codec_get_codec_descriptor(const AVCodecContext *avctx);
2984 void av_codec_set_codec_descriptor(AVCodecContext *avctx, const AVCodecDescriptor *desc);
2986 int av_codec_get_lowres(const AVCodecContext *avctx);
2987 void av_codec_set_lowres(AVCodecContext *avctx, int val);
2989 int av_codec_get_seek_preroll(const AVCodecContext *avctx);
2990 void av_codec_set_seek_preroll(AVCodecContext *avctx, int val);
2995 typedef struct AVProfile {
2997 const char *name; ///< short name for the profile
3000 typedef struct AVCodecDefault AVCodecDefault;
3007 typedef struct AVCodec {
3009 * Name of the codec implementation.
3010 * The name is globally unique among encoders and among decoders (but an
3011 * encoder and a decoder can share the same name).
3012 * This is the primary way to find a codec from the user perspective.
3016 * Descriptive name for the codec, meant to be more human readable than name.
3017 * You should use the NULL_IF_CONFIG_SMALL() macro to define it.
3019 const char *long_name;
3020 enum AVMediaType type;
3023 * Codec capabilities.
3027 const AVRational *supported_framerates; ///< array of supported framerates, or NULL if any, array is terminated by {0,0}
3028 const enum AVPixelFormat *pix_fmts; ///< array of supported pixel formats, or NULL if unknown, array is terminated by -1
3029 const int *supported_samplerates; ///< array of supported audio samplerates, or NULL if unknown, array is terminated by 0
3030 const enum AVSampleFormat *sample_fmts; ///< array of supported sample formats, or NULL if unknown, array is terminated by -1
3031 const uint64_t *channel_layouts; ///< array of support channel layouts, or NULL if unknown. array is terminated by 0
3033 uint8_t max_lowres; ///< maximum value for lowres supported by the decoder, no direct access, use av_codec_get_max_lowres()
3035 const AVClass *priv_class; ///< AVClass for the private context
3036 const AVProfile *profiles; ///< array of recognized profiles, or NULL if unknown, array is terminated by {FF_PROFILE_UNKNOWN}
3038 /*****************************************************************
3039 * No fields below this line are part of the public API. They
3040 * may not be used outside of libavcodec and can be changed and
3042 * New public fields should be added right above.
3043 *****************************************************************
3046 struct AVCodec *next;
3048 * @name Frame-level threading support functions
3052 * If defined, called on thread contexts when they are created.
3053 * If the codec allocates writable tables in init(), re-allocate them here.
3054 * priv_data will be set to a copy of the original.
3056 int (*init_thread_copy)(AVCodecContext *);
3058 * Copy necessary context variables from a previous thread context to the current one.
3059 * If not defined, the next thread will start automatically; otherwise, the codec
3060 * must call ff_thread_finish_setup().
3062 * dst and src will (rarely) point to the same context, in which case memcpy should be skipped.
3064 int (*update_thread_context)(AVCodecContext *dst, const AVCodecContext *src);
3068 * Private codec-specific defaults.
3070 const AVCodecDefault *defaults;
3073 * Initialize codec static data, called from avcodec_register().
3075 void (*init_static_data)(struct AVCodec *codec);
3077 int (*init)(AVCodecContext *);
3078 int (*encode_sub)(AVCodecContext *, uint8_t *buf, int buf_size,
3079 const struct AVSubtitle *sub);
3081 * Encode data to an AVPacket.
3083 * @param avctx codec context
3084 * @param avpkt output AVPacket (may contain a user-provided buffer)
3085 * @param[in] frame AVFrame containing the raw data to be encoded
3086 * @param[out] got_packet_ptr encoder sets to 0 or 1 to indicate that a
3087 * non-empty packet was returned in avpkt.
3088 * @return 0 on success, negative error code on failure
3090 int (*encode2)(AVCodecContext *avctx, AVPacket *avpkt, const AVFrame *frame,
3091 int *got_packet_ptr);
3092 int (*decode)(AVCodecContext *, void *outdata, int *outdata_size, AVPacket *avpkt);
3093 int (*close)(AVCodecContext *);
3096 * Will be called when seeking
3098 void (*flush)(AVCodecContext *);
3101 int av_codec_get_max_lowres(const AVCodec *codec);
3106 typedef struct AVHWAccel {
3108 * Name of the hardware accelerated codec.
3109 * The name is globally unique among encoders and among decoders (but an
3110 * encoder and a decoder can share the same name).
3115 * Type of codec implemented by the hardware accelerator.
3117 * See AVMEDIA_TYPE_xxx
3119 enum AVMediaType type;
3122 * Codec implemented by the hardware accelerator.
3124 * See AV_CODEC_ID_xxx
3129 * Supported pixel format.
3131 * Only hardware accelerated formats are supported here.
3133 enum AVPixelFormat pix_fmt;
3136 * Hardware accelerated codec capabilities.
3137 * see FF_HWACCEL_CODEC_CAP_*
3141 struct AVHWAccel *next;
3144 * Called at the beginning of each frame or field picture.
3146 * Meaningful frame information (codec specific) is guaranteed to
3147 * be parsed at this point. This function is mandatory.
3149 * Note that buf can be NULL along with buf_size set to 0.
3150 * Otherwise, this means the whole frame is available at this point.
3152 * @param avctx the codec context
3153 * @param buf the frame data buffer base
3154 * @param buf_size the size of the frame in bytes
3155 * @return zero if successful, a negative value otherwise
3157 int (*start_frame)(AVCodecContext *avctx, const uint8_t *buf, uint32_t buf_size);
3160 * Callback for each slice.
3162 * Meaningful slice information (codec specific) is guaranteed to
3163 * be parsed at this point. This function is mandatory.
3165 * @param avctx the codec context
3166 * @param buf the slice data buffer base
3167 * @param buf_size the size of the slice in bytes
3168 * @return zero if successful, a negative value otherwise
3170 int (*decode_slice)(AVCodecContext *avctx, const uint8_t *buf, uint32_t buf_size);
3173 * Called at the end of each frame or field picture.
3175 * The whole picture is parsed at this point and can now be sent
3176 * to the hardware accelerator. This function is mandatory.
3178 * @param avctx the codec context
3179 * @return zero if successful, a negative value otherwise
3181 int (*end_frame)(AVCodecContext *avctx);
3184 * Size of HW accelerator private data.
3186 * Private data is allocated with av_mallocz() before
3187 * AVCodecContext.get_buffer() and deallocated after
3188 * AVCodecContext.release_buffer().
3194 * @defgroup lavc_picture AVPicture
3196 * Functions for working with AVPicture
3201 * Picture data structure.
3203 * Up to four components can be stored into it, the last component is
3206 typedef struct AVPicture {
3207 uint8_t *data[AV_NUM_DATA_POINTERS]; ///< pointers to the image data planes
3208 int linesize[AV_NUM_DATA_POINTERS]; ///< number of bytes per line
3215 enum AVSubtitleType {
3218 SUBTITLE_BITMAP, ///< A bitmap, pict will be set
3221 * Plain text, the text field must be set by the decoder and is
3222 * authoritative. ass and pict fields may contain approximations.
3227 * Formatted text, the ass field must be set by the decoder and is
3228 * authoritative. pict and text fields may contain approximations.
3233 #define AV_SUBTITLE_FLAG_FORCED 0x00000001
3235 typedef struct AVSubtitleRect {
3236 int x; ///< top left corner of pict, undefined when pict is not set
3237 int y; ///< top left corner of pict, undefined when pict is not set
3238 int w; ///< width of pict, undefined when pict is not set
3239 int h; ///< height of pict, undefined when pict is not set
3240 int nb_colors; ///< number of colors in pict, undefined when pict is not set
3243 * data+linesize for the bitmap of this subtitle.
3244 * can be set for text/ass as well once they where rendered
3247 enum AVSubtitleType type;
3249 char *text; ///< 0 terminated plain UTF-8 text
3252 * 0 terminated ASS/SSA compatible event line.
3253 * The presentation of this is unaffected by the other values in this
3261 typedef struct AVSubtitle {
3262 uint16_t format; /* 0 = graphics */
3263 uint32_t start_display_time; /* relative to packet pts, in ms */
3264 uint32_t end_display_time; /* relative to packet pts, in ms */
3266 AVSubtitleRect **rects;
3267 int64_t pts; ///< Same as packet pts, in AV_TIME_BASE
3271 * If c is NULL, returns the first registered codec,
3272 * if c is non-NULL, returns the next registered codec after c,
3273 * or NULL if c is the last one.
3275 AVCodec *av_codec_next(const AVCodec *c);
3278 * Return the LIBAVCODEC_VERSION_INT constant.
3280 unsigned avcodec_version(void);
3283 * Return the libavcodec build-time configuration.
3285 const char *avcodec_configuration(void);
3288 * Return the libavcodec license.
3290 const char *avcodec_license(void);
3293 * Register the codec codec and initialize libavcodec.
3295 * @warning either this function or avcodec_register_all() must be called
3296 * before any other libavcodec functions.
3298 * @see avcodec_register_all()
3300 void avcodec_register(AVCodec *codec);
3303 * Register all the codecs, parsers and bitstream filters which were enabled at
3304 * configuration time. If you do not call this function you can select exactly
3305 * which formats you want to support, by using the individual registration
3308 * @see avcodec_register
3309 * @see av_register_codec_parser
3310 * @see av_register_bitstream_filter
3312 void avcodec_register_all(void);
3315 * Allocate an AVCodecContext and set its fields to default values. The
3316 * resulting struct can be deallocated by calling avcodec_close() on it followed
3319 * @param codec if non-NULL, allocate private data and initialize defaults
3320 * for the given codec. It is illegal to then call avcodec_open2()
3321 * with a different codec.
3322 * If NULL, then the codec-specific defaults won't be initialized,
3323 * which may result in suboptimal default settings (this is
3324 * important mainly for encoders, e.g. libx264).
3326 * @return An AVCodecContext filled with default values or NULL on failure.
3327 * @see avcodec_get_context_defaults
3329 AVCodecContext *avcodec_alloc_context3(const AVCodec *codec);
3332 * Set the fields of the given AVCodecContext to default values corresponding
3333 * to the given codec (defaults may be codec-dependent).
3335 * Do not call this function if a non-NULL codec has been passed
3336 * to avcodec_alloc_context3() that allocated this AVCodecContext.
3337 * If codec is non-NULL, it is illegal to call avcodec_open2() with a
3338 * different codec on this AVCodecContext.
3340 int avcodec_get_context_defaults3(AVCodecContext *s, const AVCodec *codec);
3343 * Get the AVClass for AVCodecContext. It can be used in combination with
3344 * AV_OPT_SEARCH_FAKE_OBJ for examining options.
3346 * @see av_opt_find().
3348 const AVClass *avcodec_get_class(void);
3351 * Get the AVClass for AVFrame. It can be used in combination with
3352 * AV_OPT_SEARCH_FAKE_OBJ for examining options.
3354 * @see av_opt_find().
3356 const AVClass *avcodec_get_frame_class(void);
3359 * Get the AVClass for AVSubtitleRect. It can be used in combination with
3360 * AV_OPT_SEARCH_FAKE_OBJ for examining options.
3362 * @see av_opt_find().
3364 const AVClass *avcodec_get_subtitle_rect_class(void);
3367 * Copy the settings of the source AVCodecContext into the destination
3368 * AVCodecContext. The resulting destination codec context will be
3369 * unopened, i.e. you are required to call avcodec_open2() before you
3370 * can use this AVCodecContext to decode/encode video/audio data.
3372 * @param dest target codec context, should be initialized with
3373 * avcodec_alloc_context3(NULL), but otherwise uninitialized
3374 * @param src source codec context
3375 * @return AVERROR() on error (e.g. memory allocation error), 0 on success
3377 int avcodec_copy_context(AVCodecContext *dest, const AVCodecContext *src);
3379 #if FF_API_AVFRAME_LAVC
3381 * @deprecated use av_frame_alloc()
3383 attribute_deprecated
3384 AVFrame *avcodec_alloc_frame(void);
3388 * Set the fields of the given AVFrame to default values.
3390 * @param frame The AVFrame of which the fields should be set to default values.
3392 void avcodec_get_frame_defaults(AVFrame *frame);
3395 * Free the frame and any dynamically allocated objects in it,
3396 * e.g. extended_data.
3398 * @param frame frame to be freed. The pointer will be set to NULL.
3400 * @warning this function does NOT free the data buffers themselves
3401 * (it does not know how, since they might have been allocated with
3402 * a custom get_buffer()).
3404 void avcodec_free_frame(AVFrame **frame);
3407 * Initialize the AVCodecContext to use the given AVCodec. Prior to using this
3408 * function the context has to be allocated with avcodec_alloc_context3().
3410 * The functions avcodec_find_decoder_by_name(), avcodec_find_encoder_by_name(),
3411 * avcodec_find_decoder() and avcodec_find_encoder() provide an easy way for
3412 * retrieving a codec.
3414 * @warning This function is not thread safe!
3417 * avcodec_register_all();
3418 * av_dict_set(&opts, "b", "2.5M", 0);
3419 * codec = avcodec_find_decoder(AV_CODEC_ID_H264);
3423 * context = avcodec_alloc_context3(codec);
3425 * if (avcodec_open2(context, codec, opts) < 0)
3429 * @param avctx The context to initialize.
3430 * @param codec The codec to open this context for. If a non-NULL codec has been
3431 * previously passed to avcodec_alloc_context3() or
3432 * avcodec_get_context_defaults3() for this context, then this
3433 * parameter MUST be either NULL or equal to the previously passed
3435 * @param options A dictionary filled with AVCodecContext and codec-private options.
3436 * On return this object will be filled with options that were not found.
3438 * @return zero on success, a negative value on error
3439 * @see avcodec_alloc_context3(), avcodec_find_decoder(), avcodec_find_encoder(),
3440 * av_dict_set(), av_opt_find().
3442 int avcodec_open2(AVCodecContext *avctx, const AVCodec *codec, AVDictionary **options);
3445 * Close a given AVCodecContext and free all the data associated with it
3446 * (but not the AVCodecContext itself).
3448 * Calling this function on an AVCodecContext that hasn't been opened will free
3449 * the codec-specific data allocated in avcodec_alloc_context3() /
3450 * avcodec_get_context_defaults3() with a non-NULL codec. Subsequent calls will
3453 int avcodec_close(AVCodecContext *avctx);
3456 * Free all allocated data in the given subtitle struct.
3458 * @param sub AVSubtitle to free.
3460 void avsubtitle_free(AVSubtitle *sub);
3467 * @addtogroup lavc_packet
3471 #if FF_API_DESTRUCT_PACKET
3473 * Default packet destructor.
3474 * @deprecated use the AVBuffer API instead
3476 attribute_deprecated
3477 void av_destruct_packet(AVPacket *pkt);
3481 * Initialize optional fields of a packet with default values.
3483 * Note, this does not touch the data and size members, which have to be
3484 * initialized separately.
3488 void av_init_packet(AVPacket *pkt);
3491 * Allocate the payload of a packet and initialize its fields with
3495 * @param size wanted payload size
3496 * @return 0 if OK, AVERROR_xxx otherwise
3498 int av_new_packet(AVPacket *pkt, int size);
3501 * Reduce packet size, correctly zeroing padding
3504 * @param size new size
3506 void av_shrink_packet(AVPacket *pkt, int size);
3509 * Increase packet size, correctly zeroing padding
3512 * @param grow_by number of bytes by which to increase the size of the packet
3514 int av_grow_packet(AVPacket *pkt, int grow_by);
3517 * Initialize a reference-counted packet from av_malloc()ed data.
3519 * @param pkt packet to be initialized. This function will set the data, size,
3520 * buf and destruct fields, all others are left untouched.
3521 * @param data Data allocated by av_malloc() to be used as packet data. If this
3522 * function returns successfully, the data is owned by the underlying AVBuffer.
3523 * The caller may not access the data through other means.
3524 * @param size size of data in bytes, without the padding. I.e. the full buffer
3525 * size is assumed to be size + FF_INPUT_BUFFER_PADDING_SIZE.
3527 * @return 0 on success, a negative AVERROR on error
3529 int av_packet_from_data(AVPacket *pkt, uint8_t *data, int size);
3532 * @warning This is a hack - the packet memory allocation stuff is broken. The
3533 * packet is allocated if it was not really allocated.
3535 int av_dup_packet(AVPacket *pkt);
3538 * Copy packet, including contents
3540 * @return 0 on success, negative AVERROR on fail
3542 int av_copy_packet(AVPacket *dst, AVPacket *src);
3545 * Copy packet side data
3547 * @return 0 on success, negative AVERROR on fail
3549 int av_copy_packet_side_data(AVPacket *dst, AVPacket *src);
3554 * @param pkt packet to free
3556 void av_free_packet(AVPacket *pkt);
3559 * Allocate new information of a packet.
3562 * @param type side information type
3563 * @param size side information size
3564 * @return pointer to fresh allocated data or NULL otherwise
3566 uint8_t* av_packet_new_side_data(AVPacket *pkt, enum AVPacketSideDataType type,
3570 * Shrink the already allocated side data buffer
3573 * @param type side information type
3574 * @param size new side information size
3575 * @return 0 on success, < 0 on failure
3577 int av_packet_shrink_side_data(AVPacket *pkt, enum AVPacketSideDataType type,
3581 * Get side information from packet.
3584 * @param type desired side information type
3585 * @param size pointer for side information size to store (optional)
3586 * @return pointer to data if present or NULL otherwise
3588 uint8_t* av_packet_get_side_data(AVPacket *pkt, enum AVPacketSideDataType type,
3591 int av_packet_merge_side_data(AVPacket *pkt);
3593 int av_packet_split_side_data(AVPacket *pkt);
3596 * Pack a dictionary for use in side_data.
3598 * @param dict The dictionary to pack.
3599 * @param size pointer to store the size of the returned data
3600 * @return pointer to data if successful, NULL otherwise
3602 uint8_t *av_packet_pack_dictionary(AVDictionary *dict, int *size);
3604 * Unpack a dictionary from side_data.
3606 * @param data data from side_data
3607 * @param size size of the data
3608 * @param dict the metadata storage dictionary
3609 * @return 0 on success, < 0 on failure
3611 int av_packet_unpack_dictionary(const uint8_t *data, int size, AVDictionary **dict);
3615 * Convenience function to free all the side data stored.
3616 * All the other fields stay untouched.
3620 void av_packet_free_side_data(AVPacket *pkt);
3623 * Setup a new reference to the data described by a given packet
3625 * If src is reference-counted, setup dst as a new reference to the
3626 * buffer in src. Otherwise allocate a new buffer in dst and copy the
3627 * data from src into it.
3629 * All the other fields are copied from src.
3631 * @see av_packet_unref
3633 * @param dst Destination packet
3634 * @param src Source packet
3636 * @return 0 on success, a negative AVERROR on error.
3638 int av_packet_ref(AVPacket *dst, AVPacket *src);
3643 * Unreference the buffer referenced by the packet and reset the
3644 * remaining packet fields to their default values.
3646 * @param pkt The packet to be unreferenced.
3648 void av_packet_unref(AVPacket *pkt);
3651 * Move every field in src to dst and reset src.
3653 * @see av_packet_unref
3655 * @param src Source packet, will be reset
3656 * @param dst Destination packet
3658 void av_packet_move_ref(AVPacket *dst, AVPacket *src);
3661 * Copy only "properties" fields from src to dst.
3663 * Properties for the purpose of this function are all the fields
3664 * beside those related to the packet data (buf, data, size)
3666 * @param dst Destination packet
3667 * @param src Source packet
3669 * @return 0 on success AVERROR on failure.
3672 int av_packet_copy_props(AVPacket *dst, const AVPacket *src);
3679 * @addtogroup lavc_decoding
3684 * Find a registered decoder with a matching codec ID.
3686 * @param id AVCodecID of the requested decoder
3687 * @return A decoder if one was found, NULL otherwise.
3689 AVCodec *avcodec_find_decoder(enum AVCodecID id);
3692 * Find a registered decoder with the specified name.
3694 * @param name name of the requested decoder
3695 * @return A decoder if one was found, NULL otherwise.
3697 AVCodec *avcodec_find_decoder_by_name(const char *name);
3699 #if FF_API_GET_BUFFER
3700 attribute_deprecated int avcodec_default_get_buffer(AVCodecContext *s, AVFrame *pic);
3701 attribute_deprecated void avcodec_default_release_buffer(AVCodecContext *s, AVFrame *pic);
3702 attribute_deprecated int avcodec_default_reget_buffer(AVCodecContext *s, AVFrame *pic);
3706 * The default callback for AVCodecContext.get_buffer2(). It is made public so
3707 * it can be called by custom get_buffer2() implementations for decoders without
3708 * CODEC_CAP_DR1 set.
3710 int avcodec_default_get_buffer2(AVCodecContext *s, AVFrame *frame, int flags);
3713 * Return the amount of padding in pixels which the get_buffer callback must
3714 * provide around the edge of the image for codecs which do not have the
3715 * CODEC_FLAG_EMU_EDGE flag.
3717 * @return Required padding in pixels.
3719 unsigned avcodec_get_edge_width(void);
3722 * Modify width and height values so that they will result in a memory
3723 * buffer that is acceptable for the codec if you do not use any horizontal
3726 * May only be used if a codec with CODEC_CAP_DR1 has been opened.
3727 * If CODEC_FLAG_EMU_EDGE is not set, the dimensions must have been increased
3728 * according to avcodec_get_edge_width() before.
3730 void avcodec_align_dimensions(AVCodecContext *s, int *width, int *height);
3733 * Modify width and height values so that they will result in a memory
3734 * buffer that is acceptable for the codec if you also ensure that all
3735 * line sizes are a multiple of the respective linesize_align[i].
3737 * May only be used if a codec with CODEC_CAP_DR1 has been opened.
3738 * If CODEC_FLAG_EMU_EDGE is not set, the dimensions must have been increased
3739 * according to avcodec_get_edge_width() before.
3741 void avcodec_align_dimensions2(AVCodecContext *s, int *width, int *height,
3742 int linesize_align[AV_NUM_DATA_POINTERS]);
3745 * Converts AVChromaLocation to swscale x/y chroma position.
3747 * The positions represent the chroma (0,0) position in a coordinates system
3748 * with luma (0,0) representing the origin and luma(1,1) representing 256,256
3750 * @param xpos horizontal chroma sample position
3751 * @param ypos vertical chroma sample position
3753 int avcodec_enum_to_chroma_pos(int *xpos, int *ypos, enum AVChromaLocation pos);
3756 * Converts swscale x/y chroma position to AVChromaLocation.
3758 * The positions represent the chroma (0,0) position in a coordinates system
3759 * with luma (0,0) representing the origin and luma(1,1) representing 256,256
3761 * @param xpos horizontal chroma sample position
3762 * @param ypos vertical chroma sample position
3764 enum AVChromaLocation avcodec_chroma_pos_to_enum(int xpos, int ypos);
3766 #if FF_API_OLD_DECODE_AUDIO
3768 * Wrapper function which calls avcodec_decode_audio4.
3770 * @deprecated Use avcodec_decode_audio4 instead.
3772 * Decode the audio frame of size avpkt->size from avpkt->data into samples.
3773 * Some decoders may support multiple frames in a single AVPacket, such
3774 * decoders would then just decode the first frame. In this case,
3775 * avcodec_decode_audio3 has to be called again with an AVPacket that contains
3776 * the remaining data in order to decode the second frame etc.
3778 * could be outputted, frame_size_ptr is zero. Otherwise, it is the
3779 * decompressed frame size in bytes.
3781 * @warning You must set frame_size_ptr to the allocated size of the
3782 * output buffer before calling avcodec_decode_audio3().
3784 * @warning The input buffer must be FF_INPUT_BUFFER_PADDING_SIZE larger than
3785 * the actual read bytes because some optimized bitstream readers read 32 or 64
3786 * bits at once and could read over the end.
3788 * @warning The end of the input buffer avpkt->data should be set to 0 to ensure that
3789 * no overreading happens for damaged MPEG streams.
3791 * @warning You must not provide a custom get_buffer() when using
3792 * avcodec_decode_audio3(). Doing so will override it with
3793 * avcodec_default_get_buffer. Use avcodec_decode_audio4() instead,
3794 * which does allow the application to provide a custom get_buffer().
3796 * @note You might have to align the input buffer avpkt->data and output buffer
3797 * samples. The alignment requirements depend on the CPU: On some CPUs it isn't
3798 * necessary at all, on others it won't work at all if not aligned and on others
3799 * it will work but it will have an impact on performance.
3801 * In practice, avpkt->data should have 4 byte alignment at minimum and
3802 * samples should be 16 byte aligned unless the CPU doesn't need it
3803 * (AltiVec and SSE do).
3805 * @note Codecs which have the CODEC_CAP_DELAY capability set have a delay
3806 * between input and output, these need to be fed with avpkt->data=NULL,
3807 * avpkt->size=0 at the end to return the remaining frames.
3809 * @param avctx the codec context
3810 * @param[out] samples the output buffer, sample type in avctx->sample_fmt
3811 * If the sample format is planar, each channel plane will
3812 * be the same size, with no padding between channels.
3813 * @param[in,out] frame_size_ptr the output buffer size in bytes
3814 * @param[in] avpkt The input AVPacket containing the input buffer.
3815 * You can create such packet with av_init_packet() and by then setting
3816 * data and size, some decoders might in addition need other fields.
3817 * All decoders are designed to use the least fields possible though.
3818 * @return On error a negative value is returned, otherwise the number of bytes
3819 * used or zero if no frame data was decompressed (used) from the input AVPacket.
3821 attribute_deprecated int avcodec_decode_audio3(AVCodecContext *avctx, int16_t *samples,
3822 int *frame_size_ptr,
3827 * Decode the audio frame of size avpkt->size from avpkt->data into frame.
3829 * Some decoders may support multiple frames in a single AVPacket. Such
3830 * decoders would then just decode the first frame and the return value would be
3831 * less than the packet size. In this case, avcodec_decode_audio4 has to be
3832 * called again with an AVPacket containing the remaining data in order to
3833 * decode the second frame, etc... Even if no frames are returned, the packet
3834 * needs to be fed to the decoder with remaining data until it is completely
3835 * consumed or an error occurs.
3837 * Some decoders (those marked with CODEC_CAP_DELAY) have a delay between input
3838 * and output. This means that for some packets they will not immediately
3839 * produce decoded output and need to be flushed at the end of decoding to get
3840 * all the decoded data. Flushing is done by calling this function with packets
3841 * with avpkt->data set to NULL and avpkt->size set to 0 until it stops
3842 * returning samples. It is safe to flush even those decoders that are not
3843 * marked with CODEC_CAP_DELAY, then no samples will be returned.
3845 * @warning The input buffer, avpkt->data must be FF_INPUT_BUFFER_PADDING_SIZE
3846 * larger than the actual read bytes because some optimized bitstream
3847 * readers read 32 or 64 bits at once and could read over the end.
3849 * @param avctx the codec context
3850 * @param[out] frame The AVFrame in which to store decoded audio samples.
3851 * The decoder will allocate a buffer for the decoded frame by
3852 * calling the AVCodecContext.get_buffer2() callback.
3853 * When AVCodecContext.refcounted_frames is set to 1, the frame is
3854 * reference counted and the returned reference belongs to the
3855 * caller. The caller must release the frame using av_frame_unref()
3856 * when the frame is no longer needed. The caller may safely write
3857 * to the frame if av_frame_is_writable() returns 1.
3858 * When AVCodecContext.refcounted_frames is set to 0, the returned
3859 * reference belongs to the decoder and is valid only until the
3860 * next call to this function or until closing or flushing the
3861 * decoder. The caller may not write to it.
3862 * @param[out] got_frame_ptr Zero if no frame could be decoded, otherwise it is
3863 * non-zero. Note that this field being set to zero
3864 * does not mean that an error has occurred. For
3865 * decoders with CODEC_CAP_DELAY set, no given decode
3866 * call is guaranteed to produce a frame.
3867 * @param[in] avpkt The input AVPacket containing the input buffer.
3868 * At least avpkt->data and avpkt->size should be set. Some
3869 * decoders might also require additional fields to be set.
3870 * @return A negative error code is returned if an error occurred during
3871 * decoding, otherwise the number of bytes consumed from the input
3872 * AVPacket is returned.
3874 int avcodec_decode_audio4(AVCodecContext *avctx, AVFrame *frame,
3875 int *got_frame_ptr, const AVPacket *avpkt);
3878 * Decode the video frame of size avpkt->size from avpkt->data into picture.
3879 * Some decoders may support multiple frames in a single AVPacket, such
3880 * decoders would then just decode the first frame.
3882 * @warning The input buffer must be FF_INPUT_BUFFER_PADDING_SIZE larger than
3883 * the actual read bytes because some optimized bitstream readers read 32 or 64
3884 * bits at once and could read over the end.
3886 * @warning The end of the input buffer buf should be set to 0 to ensure that
3887 * no overreading happens for damaged MPEG streams.
3889 * @note Codecs which have the CODEC_CAP_DELAY capability set have a delay
3890 * between input and output, these need to be fed with avpkt->data=NULL,
3891 * avpkt->size=0 at the end to return the remaining frames.
3893 * @param avctx the codec context
3894 * @param[out] picture The AVFrame in which the decoded video frame will be stored.
3895 * Use av_frame_alloc() to get an AVFrame. The codec will
3896 * allocate memory for the actual bitmap by calling the
3897 * AVCodecContext.get_buffer2() callback.
3898 * When AVCodecContext.refcounted_frames is set to 1, the frame is
3899 * reference counted and the returned reference belongs to the
3900 * caller. The caller must release the frame using av_frame_unref()
3901 * when the frame is no longer needed. The caller may safely write
3902 * to the frame if av_frame_is_writable() returns 1.
3903 * When AVCodecContext.refcounted_frames is set to 0, the returned
3904 * reference belongs to the decoder and is valid only until the
3905 * next call to this function or until closing or flushing the
3906 * decoder. The caller may not write to it.
3908 * @param[in] avpkt The input AVPacket containing the input buffer.
3909 * You can create such packet with av_init_packet() and by then setting
3910 * data and size, some decoders might in addition need other fields like
3911 * flags&AV_PKT_FLAG_KEY. All decoders are designed to use the least
3913 * @param[in,out] got_picture_ptr Zero if no frame could be decompressed, otherwise, it is nonzero.
3914 * @return On error a negative value is returned, otherwise the number of bytes
3915 * used or zero if no frame could be decompressed.
3917 int avcodec_decode_video2(AVCodecContext *avctx, AVFrame *picture,
3918 int *got_picture_ptr,
3919 const AVPacket *avpkt);
3922 * Decode a subtitle message.
3923 * Return a negative value on error, otherwise return the number of bytes used.
3924 * If no subtitle could be decompressed, got_sub_ptr is zero.
3925 * Otherwise, the subtitle is stored in *sub.
3926 * Note that CODEC_CAP_DR1 is not available for subtitle codecs. This is for
3927 * simplicity, because the performance difference is expect to be negligible
3928 * and reusing a get_buffer written for video codecs would probably perform badly
3929 * due to a potentially very different allocation pattern.
3931 * Some decoders (those marked with CODEC_CAP_DELAY) have a delay between input
3932 * and output. This means that for some packets they will not immediately
3933 * produce decoded output and need to be flushed at the end of decoding to get
3934 * all the decoded data. Flushing is done by calling this function with packets
3935 * with avpkt->data set to NULL and avpkt->size set to 0 until it stops
3936 * returning subtitles. It is safe to flush even those decoders that are not
3937 * marked with CODEC_CAP_DELAY, then no subtitles will be returned.
3939 * @param avctx the codec context
3940 * @param[out] sub The AVSubtitle in which the decoded subtitle will be stored, must be
3941 freed with avsubtitle_free if *got_sub_ptr is set.
3942 * @param[in,out] got_sub_ptr Zero if no subtitle could be decompressed, otherwise, it is nonzero.
3943 * @param[in] avpkt The input AVPacket containing the input buffer.
3945 int avcodec_decode_subtitle2(AVCodecContext *avctx, AVSubtitle *sub,
3950 * @defgroup lavc_parsing Frame parsing
3954 enum AVPictureStructure {
3955 AV_PICTURE_STRUCTURE_UNKNOWN, //< unknown
3956 AV_PICTURE_STRUCTURE_TOP_FIELD, //< coded as top field
3957 AV_PICTURE_STRUCTURE_BOTTOM_FIELD, //< coded as bottom field
3958 AV_PICTURE_STRUCTURE_FRAME, //< coded as frame
3961 typedef struct AVCodecParserContext {
3963 struct AVCodecParser *parser;
3964 int64_t frame_offset; /* offset of the current frame */
3965 int64_t cur_offset; /* current offset
3966 (incremented by each av_parser_parse()) */
3967 int64_t next_frame_offset; /* offset of the next frame */
3969 int pict_type; /* XXX: Put it back in AVCodecContext. */
3971 * This field is used for proper frame duration computation in lavf.
3972 * It signals, how much longer the frame duration of the current frame
3973 * is compared to normal frame duration.
3975 * frame_duration = (1 + repeat_pict) * time_base
3977 * It is used by codecs like H.264 to display telecined material.
3979 int repeat_pict; /* XXX: Put it back in AVCodecContext. */
3980 int64_t pts; /* pts of the current frame */
3981 int64_t dts; /* dts of the current frame */
3986 int fetch_timestamp;
3988 #define AV_PARSER_PTS_NB 4
3989 int cur_frame_start_index;
3990 int64_t cur_frame_offset[AV_PARSER_PTS_NB];
3991 int64_t cur_frame_pts[AV_PARSER_PTS_NB];
3992 int64_t cur_frame_dts[AV_PARSER_PTS_NB];
3995 #define PARSER_FLAG_COMPLETE_FRAMES 0x0001
3996 #define PARSER_FLAG_ONCE 0x0002
3997 /// Set if the parser has a valid file offset
3998 #define PARSER_FLAG_FETCHED_OFFSET 0x0004
3999 #define PARSER_FLAG_USE_CODEC_TS 0x1000
4001 int64_t offset; ///< byte offset from starting packet start
4002 int64_t cur_frame_end[AV_PARSER_PTS_NB];
4005 * Set by parser to 1 for key frames and 0 for non-key frames.
4006 * It is initialized to -1, so if the parser doesn't set this flag,
4007 * old-style fallback using AV_PICTURE_TYPE_I picture type as key frames
4013 * Time difference in stream time base units from the pts of this
4014 * packet to the point at which the output from the decoder has converged
4015 * independent from the availability of previous frames. That is, the
4016 * frames are virtually identical no matter if decoding started from
4017 * the very first frame or from this keyframe.
4018 * Is AV_NOPTS_VALUE if unknown.
4019 * This field is not the display duration of the current frame.
4020 * This field has no meaning if the packet does not have AV_PKT_FLAG_KEY
4023 * The purpose of this field is to allow seeking in streams that have no
4024 * keyframes in the conventional sense. It corresponds to the
4025 * recovery point SEI in H.264 and match_time_delta in NUT. It is also
4026 * essential for some types of subtitle streams to ensure that all
4027 * subtitles are correctly displayed after seeking.
4029 int64_t convergence_duration;
4031 // Timestamp generation support:
4033 * Synchronization point for start of timestamp generation.
4035 * Set to >0 for sync point, 0 for no sync point and <0 for undefined
4038 * For example, this corresponds to presence of H.264 buffering period
4044 * Offset of the current timestamp against last timestamp sync point in
4045 * units of AVCodecContext.time_base.
4047 * Set to INT_MIN when dts_sync_point unused. Otherwise, it must
4048 * contain a valid timestamp offset.
4050 * Note that the timestamp of sync point has usually a nonzero
4051 * dts_ref_dts_delta, which refers to the previous sync point. Offset of
4052 * the next frame after timestamp sync point will be usually 1.
4054 * For example, this corresponds to H.264 cpb_removal_delay.
4056 int dts_ref_dts_delta;
4059 * Presentation delay of current frame in units of AVCodecContext.time_base.
4061 * Set to INT_MIN when dts_sync_point unused. Otherwise, it must
4062 * contain valid non-negative timestamp delta (presentation time of a frame
4063 * must not lie in the past).
4065 * This delay represents the difference between decoding and presentation
4066 * time of the frame.
4068 * For example, this corresponds to H.264 dpb_output_delay.
4073 * Position of the packet in file.
4075 * Analogous to cur_frame_pts/dts
4077 int64_t cur_frame_pos[AV_PARSER_PTS_NB];
4080 * Byte position of currently parsed frame in stream.
4085 * Previous frame byte position.
4090 * Duration of the current frame.
4091 * For audio, this is in units of 1 / AVCodecContext.sample_rate.
4092 * For all other types, this is in units of AVCodecContext.time_base.
4096 enum AVFieldOrder field_order;
4099 * Indicate whether a picture is coded as a frame, top field or bottom field.
4101 * For example, H.264 field_pic_flag equal to 0 corresponds to
4102 * AV_PICTURE_STRUCTURE_FRAME. An H.264 picture with field_pic_flag
4103 * equal to 1 and bottom_field_flag equal to 0 corresponds to
4104 * AV_PICTURE_STRUCTURE_TOP_FIELD.
4106 enum AVPictureStructure picture_structure;
4109 * Picture number incremented in presentation or output order.
4110 * This field may be reinitialized at the first picture of a new sequence.
4112 * For example, this corresponds to H.264 PicOrderCnt.
4114 int output_picture_number;
4115 } AVCodecParserContext;
4117 typedef struct AVCodecParser {
4118 int codec_ids[5]; /* several codec IDs are permitted */
4120 int (*parser_init)(AVCodecParserContext *s);
4121 int (*parser_parse)(AVCodecParserContext *s,
4122 AVCodecContext *avctx,
4123 const uint8_t **poutbuf, int *poutbuf_size,
4124 const uint8_t *buf, int buf_size);
4125 void (*parser_close)(AVCodecParserContext *s);
4126 int (*split)(AVCodecContext *avctx, const uint8_t *buf, int buf_size);
4127 struct AVCodecParser *next;
4130 AVCodecParser *av_parser_next(AVCodecParser *c);
4132 void av_register_codec_parser(AVCodecParser *parser);
4133 AVCodecParserContext *av_parser_init(int codec_id);
4138 * @param s parser context.
4139 * @param avctx codec context.
4140 * @param poutbuf set to pointer to parsed buffer or NULL if not yet finished.
4141 * @param poutbuf_size set to size of parsed buffer or zero if not yet finished.
4142 * @param buf input buffer.
4143 * @param buf_size input length, to signal EOF, this should be 0 (so that the last frame can be output).
4144 * @param pts input presentation timestamp.
4145 * @param dts input decoding timestamp.
4146 * @param pos input byte position in stream.
4147 * @return the number of bytes of the input bitstream used.
4152 * len = av_parser_parse2(myparser, AVCodecContext, &data, &size,
4159 * decode_frame(data, size);
4163 int av_parser_parse2(AVCodecParserContext *s,
4164 AVCodecContext *avctx,
4165 uint8_t **poutbuf, int *poutbuf_size,
4166 const uint8_t *buf, int buf_size,
4167 int64_t pts, int64_t dts,
4171 * @return 0 if the output buffer is a subset of the input, 1 if it is allocated and must be freed
4172 * @deprecated use AVBitStreamFilter
4174 int av_parser_change(AVCodecParserContext *s,
4175 AVCodecContext *avctx,
4176 uint8_t **poutbuf, int *poutbuf_size,
4177 const uint8_t *buf, int buf_size, int keyframe);
4178 void av_parser_close(AVCodecParserContext *s);
4186 * @addtogroup lavc_encoding
4191 * Find a registered encoder with a matching codec ID.
4193 * @param id AVCodecID of the requested encoder
4194 * @return An encoder if one was found, NULL otherwise.
4196 AVCodec *avcodec_find_encoder(enum AVCodecID id);
4199 * Find a registered encoder with the specified name.
4201 * @param name name of the requested encoder
4202 * @return An encoder if one was found, NULL otherwise.
4204 AVCodec *avcodec_find_encoder_by_name(const char *name);
4206 #if FF_API_OLD_ENCODE_AUDIO
4208 * Encode an audio frame from samples into buf.
4210 * @deprecated Use avcodec_encode_audio2 instead.
4212 * @note The output buffer should be at least FF_MIN_BUFFER_SIZE bytes large.
4213 * However, for codecs with avctx->frame_size equal to 0 (e.g. PCM) the user
4214 * will know how much space is needed because it depends on the value passed
4215 * in buf_size as described below. In that case a lower value can be used.
4217 * @param avctx the codec context
4218 * @param[out] buf the output buffer
4219 * @param[in] buf_size the output buffer size
4220 * @param[in] samples the input buffer containing the samples
4221 * The number of samples read from this buffer is frame_size*channels,
4222 * both of which are defined in avctx.
4223 * For codecs which have avctx->frame_size equal to 0 (e.g. PCM) the number of
4224 * samples read from samples is equal to:
4225 * buf_size * 8 / (avctx->channels * av_get_bits_per_sample(avctx->codec_id))
4226 * This also implies that av_get_bits_per_sample() must not return 0 for these
4228 * @return On error a negative value is returned, on success zero or the number
4229 * of bytes used to encode the data read from the input buffer.
4231 int attribute_deprecated avcodec_encode_audio(AVCodecContext *avctx,
4232 uint8_t *buf, int buf_size,
4233 const short *samples);
4237 * Encode a frame of audio.
4239 * Takes input samples from frame and writes the next output packet, if
4240 * available, to avpkt. The output packet does not necessarily contain data for
4241 * the most recent frame, as encoders can delay, split, and combine input frames
4242 * internally as needed.
4244 * @param avctx codec context
4245 * @param avpkt output AVPacket.
4246 * The user can supply an output buffer by setting
4247 * avpkt->data and avpkt->size prior to calling the
4248 * function, but if the size of the user-provided data is not
4249 * large enough, encoding will fail. If avpkt->data and
4250 * avpkt->size are set, avpkt->destruct must also be set. All
4251 * other AVPacket fields will be reset by the encoder using
4252 * av_init_packet(). If avpkt->data is NULL, the encoder will
4253 * allocate it. The encoder will set avpkt->size to the size
4254 * of the output packet.
4256 * If this function fails or produces no output, avpkt will be
4257 * freed using av_free_packet() (i.e. avpkt->destruct will be
4258 * called to free the user supplied buffer).
4259 * @param[in] frame AVFrame containing the raw audio data to be encoded.
4260 * May be NULL when flushing an encoder that has the
4261 * CODEC_CAP_DELAY capability set.
4262 * If CODEC_CAP_VARIABLE_FRAME_SIZE is set, then each frame
4263 * can have any number of samples.
4264 * If it is not set, frame->nb_samples must be equal to
4265 * avctx->frame_size for all frames except the last.
4266 * The final frame may be smaller than avctx->frame_size.
4267 * @param[out] got_packet_ptr This field is set to 1 by libavcodec if the
4268 * output packet is non-empty, and to 0 if it is
4269 * empty. If the function returns an error, the
4270 * packet can be assumed to be invalid, and the
4271 * value of got_packet_ptr is undefined and should
4273 * @return 0 on success, negative error code on failure
4275 int avcodec_encode_audio2(AVCodecContext *avctx, AVPacket *avpkt,
4276 const AVFrame *frame, int *got_packet_ptr);
4278 #if FF_API_OLD_ENCODE_VIDEO
4280 * @deprecated use avcodec_encode_video2() instead.
4282 * Encode a video frame from pict into buf.
4283 * The input picture should be
4284 * stored using a specific format, namely avctx.pix_fmt.
4286 * @param avctx the codec context
4287 * @param[out] buf the output buffer for the bitstream of encoded frame
4288 * @param[in] buf_size the size of the output buffer in bytes
4289 * @param[in] pict the input picture to encode
4290 * @return On error a negative value is returned, on success zero or the number
4291 * of bytes used from the output buffer.
4293 attribute_deprecated
4294 int avcodec_encode_video(AVCodecContext *avctx, uint8_t *buf, int buf_size,
4295 const AVFrame *pict);
4299 * Encode a frame of video.
4301 * Takes input raw video data from frame and writes the next output packet, if
4302 * available, to avpkt. The output packet does not necessarily contain data for
4303 * the most recent frame, as encoders can delay and reorder input frames
4304 * internally as needed.
4306 * @param avctx codec context
4307 * @param avpkt output AVPacket.
4308 * The user can supply an output buffer by setting
4309 * avpkt->data and avpkt->size prior to calling the
4310 * function, but if the size of the user-provided data is not
4311 * large enough, encoding will fail. All other AVPacket fields
4312 * will be reset by the encoder using av_init_packet(). If
4313 * avpkt->data is NULL, the encoder will allocate it.
4314 * The encoder will set avpkt->size to the size of the
4315 * output packet. The returned data (if any) belongs to the
4316 * caller, he is responsible for freeing it.
4318 * If this function fails or produces no output, avpkt will be
4319 * freed using av_free_packet() (i.e. avpkt->destruct will be
4320 * called to free the user supplied buffer).
4321 * @param[in] frame AVFrame containing the raw video data to be encoded.
4322 * May be NULL when flushing an encoder that has the
4323 * CODEC_CAP_DELAY capability set.
4324 * @param[out] got_packet_ptr This field is set to 1 by libavcodec if the
4325 * output packet is non-empty, and to 0 if it is
4326 * empty. If the function returns an error, the
4327 * packet can be assumed to be invalid, and the
4328 * value of got_packet_ptr is undefined and should
4330 * @return 0 on success, negative error code on failure
4332 int avcodec_encode_video2(AVCodecContext *avctx, AVPacket *avpkt,
4333 const AVFrame *frame, int *got_packet_ptr);
4335 int avcodec_encode_subtitle(AVCodecContext *avctx, uint8_t *buf, int buf_size,
4336 const AVSubtitle *sub);
4343 #if FF_API_AVCODEC_RESAMPLE
4345 * @defgroup lavc_resample Audio resampling
4347 * @deprecated use libswresample instead
4351 struct ReSampleContext;
4352 struct AVResampleContext;
4354 typedef struct ReSampleContext ReSampleContext;
4357 * Initialize audio resampling context.
4359 * @param output_channels number of output channels
4360 * @param input_channels number of input channels
4361 * @param output_rate output sample rate
4362 * @param input_rate input sample rate
4363 * @param sample_fmt_out requested output sample format
4364 * @param sample_fmt_in input sample format
4365 * @param filter_length length of each FIR filter in the filterbank relative to the cutoff frequency
4366 * @param log2_phase_count log2 of the number of entries in the polyphase filterbank
4367 * @param linear if 1 then the used FIR filter will be linearly interpolated
4368 between the 2 closest, if 0 the closest will be used
4369 * @param cutoff cutoff frequency, 1.0 corresponds to half the output sampling rate
4370 * @return allocated ReSampleContext, NULL if error occurred
4372 attribute_deprecated
4373 ReSampleContext *av_audio_resample_init(int output_channels, int input_channels,
4374 int output_rate, int input_rate,
4375 enum AVSampleFormat sample_fmt_out,
4376 enum AVSampleFormat sample_fmt_in,
4377 int filter_length, int log2_phase_count,
4378 int linear, double cutoff);
4380 attribute_deprecated
4381 int audio_resample(ReSampleContext *s, short *output, short *input, int nb_samples);
4384 * Free resample context.
4386 * @param s a non-NULL pointer to a resample context previously
4387 * created with av_audio_resample_init()
4389 attribute_deprecated
4390 void audio_resample_close(ReSampleContext *s);
4394 * Initialize an audio resampler.
4395 * Note, if either rate is not an integer then simply scale both rates up so they are.
4396 * @param filter_length length of each FIR filter in the filterbank relative to the cutoff freq
4397 * @param log2_phase_count log2 of the number of entries in the polyphase filterbank
4398 * @param linear If 1 then the used FIR filter will be linearly interpolated
4399 between the 2 closest, if 0 the closest will be used
4400 * @param cutoff cutoff frequency, 1.0 corresponds to half the output sampling rate
4402 attribute_deprecated
4403 struct AVResampleContext *av_resample_init(int out_rate, int in_rate, int filter_length, int log2_phase_count, int linear, double cutoff);
4406 * Resample an array of samples using a previously configured context.
4407 * @param src an array of unconsumed samples
4408 * @param consumed the number of samples of src which have been consumed are returned here
4409 * @param src_size the number of unconsumed samples available
4410 * @param dst_size the amount of space in samples available in dst
4411 * @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.
4412 * @return the number of samples written in dst or -1 if an error occurred
4414 attribute_deprecated
4415 int av_resample(struct AVResampleContext *c, short *dst, short *src, int *consumed, int src_size, int dst_size, int update_ctx);
4419 * Compensate samplerate/timestamp drift. The compensation is done by changing
4420 * the resampler parameters, so no audible clicks or similar distortions occur
4421 * @param compensation_distance distance in output samples over which the compensation should be performed
4422 * @param sample_delta number of output samples which should be output less
4424 * example: av_resample_compensate(c, 10, 500)
4425 * here instead of 510 samples only 500 samples would be output
4427 * note, due to rounding the actual compensation might be slightly different,
4428 * especially if the compensation_distance is large and the in_rate used during init is small
4430 attribute_deprecated
4431 void av_resample_compensate(struct AVResampleContext *c, int sample_delta, int compensation_distance);
4432 attribute_deprecated
4433 void av_resample_close(struct AVResampleContext *c);
4441 * @addtogroup lavc_picture
4446 * Allocate memory for the pixels of a picture and setup the AVPicture
4449 * Call avpicture_free() to free it.
4451 * @param picture the picture structure to be filled in
4452 * @param pix_fmt the pixel format of the picture
4453 * @param width the width of the picture
4454 * @param height the height of the picture
4455 * @return zero if successful, a negative error code otherwise
4457 * @see av_image_alloc(), avpicture_fill()
4459 int avpicture_alloc(AVPicture *picture, enum AVPixelFormat pix_fmt, int width, int height);
4462 * Free a picture previously allocated by avpicture_alloc().
4463 * The data buffer used by the AVPicture is freed, but the AVPicture structure
4466 * @param picture the AVPicture to be freed
4468 void avpicture_free(AVPicture *picture);
4471 * Setup the picture fields based on the specified image parameters
4472 * and the provided image data buffer.
4474 * The picture fields are filled in by using the image data buffer
4475 * pointed to by ptr.
4477 * If ptr is NULL, the function will fill only the picture linesize
4478 * array and return the required size for the image buffer.
4480 * To allocate an image buffer and fill the picture data in one call,
4481 * use avpicture_alloc().
4483 * @param picture the picture to be filled in
4484 * @param ptr buffer where the image data is stored, or NULL
4485 * @param pix_fmt the pixel format of the image
4486 * @param width the width of the image in pixels
4487 * @param height the height of the image in pixels
4488 * @return the size in bytes required for src, a negative error code
4489 * in case of failure
4491 * @see av_image_fill_arrays()
4493 int avpicture_fill(AVPicture *picture, const uint8_t *ptr,
4494 enum AVPixelFormat pix_fmt, int width, int height);
4497 * Copy pixel data from an AVPicture into a buffer.
4499 * avpicture_get_size() can be used to compute the required size for
4500 * the buffer to fill.
4502 * @param src source picture with filled data
4503 * @param pix_fmt picture pixel format
4504 * @param width picture width
4505 * @param height picture height
4506 * @param dest destination buffer
4507 * @param dest_size destination buffer size in bytes
4508 * @return the number of bytes written to dest, or a negative value
4509 * (error code) on error, for example if the destination buffer is not
4512 * @see av_image_copy_to_buffer()
4514 int avpicture_layout(const AVPicture *src, enum AVPixelFormat pix_fmt,
4515 int width, int height,
4516 unsigned char *dest, int dest_size);
4519 * Calculate the size in bytes that a picture of the given width and height
4520 * would occupy if stored in the given picture format.
4522 * @param pix_fmt picture pixel format
4523 * @param width picture width
4524 * @param height picture height
4525 * @return the computed picture buffer size or a negative error code
4528 * @see av_image_get_buffer_size().
4530 int avpicture_get_size(enum AVPixelFormat pix_fmt, int width, int height);
4532 #if FF_API_DEINTERLACE
4534 * deinterlace - if not supported return -1
4536 * @deprecated - use yadif (in libavfilter) instead
4538 attribute_deprecated
4539 int avpicture_deinterlace(AVPicture *dst, const AVPicture *src,
4540 enum AVPixelFormat pix_fmt, int width, int height);
4543 * Copy image src to dst. Wraps av_image_copy().
4545 void av_picture_copy(AVPicture *dst, const AVPicture *src,
4546 enum AVPixelFormat pix_fmt, int width, int height);
4549 * Crop image top and left side.
4551 int av_picture_crop(AVPicture *dst, const AVPicture *src,
4552 enum AVPixelFormat pix_fmt, int top_band, int left_band);
4557 int av_picture_pad(AVPicture *dst, const AVPicture *src, int height, int width, enum AVPixelFormat pix_fmt,
4558 int padtop, int padbottom, int padleft, int padright, int *color);
4565 * @defgroup lavc_misc Utility functions
4568 * Miscellaneous utility functions related to both encoding and decoding
4574 * @defgroup lavc_misc_pixfmt Pixel formats
4576 * Functions for working with pixel formats.
4581 * Utility function to access log2_chroma_w log2_chroma_h from
4582 * the pixel format AVPixFmtDescriptor.
4584 * This function asserts that pix_fmt is valid. See av_pix_fmt_get_chroma_sub_sample
4585 * for one that returns a failure code and continues in case of invalid
4588 * @param[in] pix_fmt the pixel format
4589 * @param[out] h_shift store log2_chroma_w
4590 * @param[out] v_shift store log2_chroma_h
4592 * @see av_pix_fmt_get_chroma_sub_sample
4595 void avcodec_get_chroma_sub_sample(enum AVPixelFormat pix_fmt, int *h_shift, int *v_shift);
4598 * Return a value representing the fourCC code associated to the
4599 * pixel format pix_fmt, or 0 if no associated fourCC code can be
4602 unsigned int avcodec_pix_fmt_to_codec_tag(enum AVPixelFormat pix_fmt);
4604 #define FF_LOSS_RESOLUTION 0x0001 /**< loss due to resolution change */
4605 #define FF_LOSS_DEPTH 0x0002 /**< loss due to color depth change */
4606 #define FF_LOSS_COLORSPACE 0x0004 /**< loss due to color space conversion */
4607 #define FF_LOSS_ALPHA 0x0008 /**< loss of alpha bits */
4608 #define FF_LOSS_COLORQUANT 0x0010 /**< loss due to color quantization */
4609 #define FF_LOSS_CHROMA 0x0020 /**< loss of chroma (e.g. RGB to gray conversion) */
4612 * Compute what kind of losses will occur when converting from one specific
4613 * pixel format to another.
4614 * When converting from one pixel format to another, information loss may occur.
4615 * For example, when converting from RGB24 to GRAY, the color information will
4616 * be lost. Similarly, other losses occur when converting from some formats to
4617 * other formats. These losses can involve loss of chroma, but also loss of
4618 * resolution, loss of color depth, loss due to the color space conversion, loss
4619 * of the alpha bits or loss due to color quantization.
4620 * avcodec_get_fix_fmt_loss() informs you about the various types of losses
4621 * which will occur when converting from one pixel format to another.
4623 * @param[in] dst_pix_fmt destination pixel format
4624 * @param[in] src_pix_fmt source pixel format
4625 * @param[in] has_alpha Whether the source pixel format alpha channel is used.
4626 * @return Combination of flags informing you what kind of losses will occur
4627 * (maximum loss for an invalid dst_pix_fmt).
4629 int avcodec_get_pix_fmt_loss(enum AVPixelFormat dst_pix_fmt, enum AVPixelFormat src_pix_fmt,
4633 * Find the best pixel format to convert to given a certain source pixel
4634 * format. When converting from one pixel format to another, information loss
4635 * may occur. For example, when converting from RGB24 to GRAY, the color
4636 * information will be lost. Similarly, other losses occur when converting from
4637 * some formats to other formats. avcodec_find_best_pix_fmt_of_2() searches which of
4638 * the given pixel formats should be used to suffer the least amount of loss.
4639 * The pixel formats from which it chooses one, are determined by the
4640 * pix_fmt_list parameter.
4643 * @param[in] pix_fmt_list AV_PIX_FMT_NONE terminated array of pixel formats to choose from
4644 * @param[in] src_pix_fmt source pixel format
4645 * @param[in] has_alpha Whether the source pixel format alpha channel is used.
4646 * @param[out] loss_ptr Combination of flags informing you what kind of losses will occur.
4647 * @return The best pixel format to convert to or -1 if none was found.
4649 enum AVPixelFormat avcodec_find_best_pix_fmt_of_list(const enum AVPixelFormat *pix_fmt_list,
4650 enum AVPixelFormat src_pix_fmt,
4651 int has_alpha, int *loss_ptr);
4654 * Find the best pixel format to convert to given a certain source pixel
4655 * format and a selection of two destination pixel formats. When converting from
4656 * one pixel format to another, information loss may occur. For example, when converting
4657 * from RGB24 to GRAY, the color information will be lost. Similarly, other losses occur when
4658 * converting from some formats to other formats. avcodec_find_best_pix_fmt_of_2() selects which of
4659 * the given pixel formats should be used to suffer the least amount of loss.
4661 * If one of the destination formats is AV_PIX_FMT_NONE the other pixel format (if valid) will be
4665 * src_pix_fmt = AV_PIX_FMT_YUV420P;
4666 * dst_pix_fmt1= AV_PIX_FMT_RGB24;
4667 * dst_pix_fmt2= AV_PIX_FMT_GRAY8;
4668 * dst_pix_fmt3= AV_PIX_FMT_RGB8;
4669 * loss= FF_LOSS_CHROMA; // don't care about chroma loss, so chroma loss will be ignored.
4670 * dst_pix_fmt = avcodec_find_best_pix_fmt_of_2(dst_pix_fmt1, dst_pix_fmt2, src_pix_fmt, alpha, &loss);
4671 * dst_pix_fmt = avcodec_find_best_pix_fmt_of_2(dst_pix_fmt, dst_pix_fmt3, src_pix_fmt, alpha, &loss);
4674 * @param[in] dst_pix_fmt1 One of the two destination pixel formats to choose from
4675 * @param[in] dst_pix_fmt2 The other of the two destination pixel formats to choose from
4676 * @param[in] src_pix_fmt Source pixel format
4677 * @param[in] has_alpha Whether the source pixel format alpha channel is used.
4678 * @param[in, out] loss_ptr Combination of loss flags. In: selects which of the losses to ignore, i.e.
4679 * NULL or value of zero means we care about all losses. Out: the loss
4680 * that occurs when converting from src to selected dst pixel format.
4681 * @return The best pixel format to convert to or -1 if none was found.
4683 enum AVPixelFormat avcodec_find_best_pix_fmt_of_2(enum AVPixelFormat dst_pix_fmt1, enum AVPixelFormat dst_pix_fmt2,
4684 enum AVPixelFormat src_pix_fmt, int has_alpha, int *loss_ptr);
4686 attribute_deprecated
4687 #if AV_HAVE_INCOMPATIBLE_LIBAV_ABI
4688 enum AVPixelFormat avcodec_find_best_pix_fmt2(const enum AVPixelFormat *pix_fmt_list,
4689 enum AVPixelFormat src_pix_fmt,
4690 int has_alpha, int *loss_ptr);
4692 enum AVPixelFormat avcodec_find_best_pix_fmt2(enum AVPixelFormat dst_pix_fmt1, enum AVPixelFormat dst_pix_fmt2,
4693 enum AVPixelFormat src_pix_fmt, int has_alpha, int *loss_ptr);
4697 enum AVPixelFormat avcodec_default_get_format(struct AVCodecContext *s, const enum AVPixelFormat * fmt);
4703 #if FF_API_SET_DIMENSIONS
4705 * @deprecated this function is not supposed to be used from outside of lavc
4707 attribute_deprecated
4708 void avcodec_set_dimensions(AVCodecContext *s, int width, int height);
4712 * Put a string representing the codec tag codec_tag in buf.
4714 * @param buf_size size in bytes of buf
4715 * @return the length of the string that would have been generated if
4716 * enough space had been available, excluding the trailing null
4718 size_t av_get_codec_tag_string(char *buf, size_t buf_size, unsigned int codec_tag);
4720 void avcodec_string(char *buf, int buf_size, AVCodecContext *enc, int encode);
4723 * Return a name for the specified profile, if available.
4725 * @param codec the codec that is searched for the given profile
4726 * @param profile the profile value for which a name is requested
4727 * @return A name for the profile if found, NULL otherwise.
4729 const char *av_get_profile_name(const AVCodec *codec, int profile);
4731 int avcodec_default_execute(AVCodecContext *c, int (*func)(AVCodecContext *c2, void *arg2),void *arg, int *ret, int count, int size);
4732 int avcodec_default_execute2(AVCodecContext *c, int (*func)(AVCodecContext *c2, void *arg2, int, int),void *arg, int *ret, int count);
4733 //FIXME func typedef
4736 * Fill AVFrame audio data and linesize pointers.
4738 * The buffer buf must be a preallocated buffer with a size big enough
4739 * to contain the specified samples amount. The filled AVFrame data
4740 * pointers will point to this buffer.
4742 * AVFrame extended_data channel pointers are allocated if necessary for
4745 * @param frame the AVFrame
4746 * frame->nb_samples must be set prior to calling the
4747 * function. This function fills in frame->data,
4748 * frame->extended_data, frame->linesize[0].
4749 * @param nb_channels channel count
4750 * @param sample_fmt sample format
4751 * @param buf buffer to use for frame data
4752 * @param buf_size size of buffer
4753 * @param align plane size sample alignment (0 = default)
4754 * @return >=0 on success, negative error code on failure
4755 * @todo return the size in bytes required to store the samples in
4756 * case of success, at the next libavutil bump
4758 int avcodec_fill_audio_frame(AVFrame *frame, int nb_channels,
4759 enum AVSampleFormat sample_fmt, const uint8_t *buf,
4760 int buf_size, int align);
4763 * Reset the internal decoder state / flush internal buffers. Should be called
4764 * e.g. when seeking or when switching to a different stream.
4766 * @note when refcounted frames are not used (i.e. avctx->refcounted_frames is 0),
4767 * this invalidates the frames previously returned from the decoder. When
4768 * refcounted frames are used, the decoder just releases any references it might
4769 * keep internally, but the caller's reference remains valid.
4771 void avcodec_flush_buffers(AVCodecContext *avctx);
4774 * Return codec bits per sample.
4776 * @param[in] codec_id the codec
4777 * @return Number of bits per sample or zero if unknown for the given codec.
4779 int av_get_bits_per_sample(enum AVCodecID codec_id);
4782 * Return the PCM codec associated with a sample format.
4783 * @param be endianness, 0 for little, 1 for big,
4784 * -1 (or anything else) for native
4785 * @return AV_CODEC_ID_PCM_* or AV_CODEC_ID_NONE
4787 enum AVCodecID av_get_pcm_codec(enum AVSampleFormat fmt, int be);
4790 * Return codec bits per sample.
4791 * Only return non-zero if the bits per sample is exactly correct, not an
4794 * @param[in] codec_id the codec
4795 * @return Number of bits per sample or zero if unknown for the given codec.
4797 int av_get_exact_bits_per_sample(enum AVCodecID codec_id);
4800 * Return audio frame duration.
4802 * @param avctx codec context
4803 * @param frame_bytes size of the frame, or 0 if unknown
4804 * @return frame duration, in samples, if known. 0 if not able to
4807 int av_get_audio_frame_duration(AVCodecContext *avctx, int frame_bytes);
4810 typedef struct AVBitStreamFilterContext {
4812 struct AVBitStreamFilter *filter;
4813 AVCodecParserContext *parser;
4814 struct AVBitStreamFilterContext *next;
4815 } AVBitStreamFilterContext;
4818 typedef struct AVBitStreamFilter {
4821 int (*filter)(AVBitStreamFilterContext *bsfc,
4822 AVCodecContext *avctx, const char *args,
4823 uint8_t **poutbuf, int *poutbuf_size,
4824 const uint8_t *buf, int buf_size, int keyframe);
4825 void (*close)(AVBitStreamFilterContext *bsfc);
4826 struct AVBitStreamFilter *next;
4827 } AVBitStreamFilter;
4830 * Register a bitstream filter.
4832 * The filter will be accessible to the application code through
4833 * av_bitstream_filter_next() or can be directly initialized with
4834 * av_bitstream_filter_init().
4836 * @see avcodec_register_all()
4838 void av_register_bitstream_filter(AVBitStreamFilter *bsf);
4841 * Create and initialize a bitstream filter context given a bitstream
4844 * The returned context must be freed with av_bitstream_filter_close().
4846 * @param name the name of the bitstream filter
4847 * @return a bitstream filter context if a matching filter was found
4848 * and successfully initialized, NULL otherwise
4850 AVBitStreamFilterContext *av_bitstream_filter_init(const char *name);
4855 * This function filters the buffer buf with size buf_size, and places the
4856 * filtered buffer in the buffer pointed to by poutbuf.
4858 * The output buffer must be freed by the caller.
4860 * @param bsfc bitstream filter context created by av_bitstream_filter_init()
4861 * @param avctx AVCodecContext accessed by the filter, may be NULL.
4862 * If specified, this must point to the encoder context of the
4863 * output stream the packet is sent to.
4864 * @param args arguments which specify the filter configuration, may be NULL
4865 * @param poutbuf pointer which is updated to point to the filtered buffer
4866 * @param poutbuf_size pointer which is updated to the filtered buffer size in bytes
4867 * @param buf buffer containing the data to filter
4868 * @param buf_size size in bytes of buf
4869 * @param keyframe set to non-zero if the buffer to filter corresponds to a key-frame packet data
4870 * @return >= 0 in case of success, or a negative error code in case of failure
4872 * If the return value is positive, an output buffer is allocated and
4873 * is availble in *poutbuf, and is distinct from the input buffer.
4875 * If the return value is 0, the output buffer is not allocated and
4876 * should be considered identical to the input buffer, or in case
4877 * *poutbuf was set it points to the input buffer (not necessarily to
4878 * its starting address).
4880 int av_bitstream_filter_filter(AVBitStreamFilterContext *bsfc,
4881 AVCodecContext *avctx, const char *args,
4882 uint8_t **poutbuf, int *poutbuf_size,
4883 const uint8_t *buf, int buf_size, int keyframe);
4886 * Release bitstream filter context.
4888 * @param bsf the bitstream filter context created with
4889 * av_bitstream_filter_init(), can be NULL
4891 void av_bitstream_filter_close(AVBitStreamFilterContext *bsf);
4894 * If f is NULL, return the first registered bitstream filter,
4895 * if f is non-NULL, return the next registered bitstream filter
4896 * after f, or NULL if f is the last one.
4898 * This function can be used to iterate over all registered bitstream
4901 AVBitStreamFilter *av_bitstream_filter_next(AVBitStreamFilter *f);
4906 * Same behaviour av_fast_malloc but the buffer has additional
4907 * FF_INPUT_BUFFER_PADDING_SIZE at the end which will always be 0.
4909 * In addition the whole buffer will initially and after resizes
4910 * be 0-initialized so that no uninitialized data will ever appear.
4912 void av_fast_padded_malloc(void *ptr, unsigned int *size, size_t min_size);
4915 * Same behaviour av_fast_padded_malloc except that buffer will always
4916 * be 0-initialized after call.
4918 void av_fast_padded_mallocz(void *ptr, unsigned int *size, size_t min_size);
4921 * Encode extradata length to a buffer. Used by xiph codecs.
4923 * @param s buffer to write to; must be at least (v/255+1) bytes long
4924 * @param v size of extradata in bytes
4925 * @return number of bytes written to the buffer.
4927 unsigned int av_xiphlacing(unsigned char *s, unsigned int v);
4929 #if FF_API_MISSING_SAMPLE
4931 * Log a generic warning message about a missing feature. This function is
4932 * intended to be used internally by FFmpeg (libavcodec, libavformat, etc.)
4933 * only, and would normally not be used by applications.
4934 * @param[in] avc a pointer to an arbitrary struct of which the first field is
4935 * a pointer to an AVClass struct
4936 * @param[in] feature string containing the name of the missing feature
4937 * @param[in] want_sample indicates if samples are wanted which exhibit this feature.
4938 * If want_sample is non-zero, additional verbage will be added to the log
4939 * message which tells the user how to report samples to the development
4941 * @deprecated Use avpriv_report_missing_feature() instead.
4943 attribute_deprecated
4944 void av_log_missing_feature(void *avc, const char *feature, int want_sample);
4947 * Log a generic warning message asking for a sample. This function is
4948 * intended to be used internally by FFmpeg (libavcodec, libavformat, etc.)
4949 * only, and would normally not be used by applications.
4950 * @param[in] avc a pointer to an arbitrary struct of which the first field is
4951 * a pointer to an AVClass struct
4952 * @param[in] msg string containing an optional message, or NULL if no message
4953 * @deprecated Use avpriv_request_sample() instead.
4955 attribute_deprecated
4956 void av_log_ask_for_sample(void *avc, const char *msg, ...) av_printf_format(2, 3);
4957 #endif /* FF_API_MISSING_SAMPLE */
4960 * Register the hardware accelerator hwaccel.
4962 void av_register_hwaccel(AVHWAccel *hwaccel);
4965 * If hwaccel is NULL, returns the first registered hardware accelerator,
4966 * if hwaccel is non-NULL, returns the next registered hardware accelerator
4967 * after hwaccel, or NULL if hwaccel is the last one.
4969 AVHWAccel *av_hwaccel_next(AVHWAccel *hwaccel);
4973 * Lock operation used by lockmgr
4976 AV_LOCK_CREATE, ///< Create a mutex
4977 AV_LOCK_OBTAIN, ///< Lock the mutex
4978 AV_LOCK_RELEASE, ///< Unlock the mutex
4979 AV_LOCK_DESTROY, ///< Free mutex resources
4983 * Register a user provided lock manager supporting the operations
4984 * specified by AVLockOp. mutex points to a (void *) where the
4985 * lockmgr should store/get a pointer to a user allocated mutex. It's
4986 * NULL upon AV_LOCK_CREATE and != NULL for all other ops.
4988 * @param cb User defined callback. Note: FFmpeg may invoke calls to this
4989 * callback during the call to av_lockmgr_register().
4990 * Thus, the application must be prepared to handle that.
4991 * If cb is set to NULL the lockmgr will be unregistered.
4992 * Also note that during unregistration the previously registered
4993 * lockmgr callback may also be invoked.
4995 int av_lockmgr_register(int (*cb)(void **mutex, enum AVLockOp op));
4998 * Get the type of the given codec.
5000 enum AVMediaType avcodec_get_type(enum AVCodecID codec_id);
5003 * Get the name of a codec.
5004 * @return a static string identifying the codec; never NULL
5006 const char *avcodec_get_name(enum AVCodecID id);
5009 * @return a positive value if s is open (i.e. avcodec_open2() was called on it
5010 * with no corresponding avcodec_close()), 0 otherwise.
5012 int avcodec_is_open(AVCodecContext *s);
5015 * @return a non-zero number if codec is an encoder, zero otherwise
5017 int av_codec_is_encoder(const AVCodec *codec);
5020 * @return a non-zero number if codec is a decoder, zero otherwise
5022 int av_codec_is_decoder(const AVCodec *codec);
5025 * @return descriptor for given codec ID or NULL if no descriptor exists.
5027 const AVCodecDescriptor *avcodec_descriptor_get(enum AVCodecID id);
5030 * Iterate over all codec descriptors known to libavcodec.
5032 * @param prev previous descriptor. NULL to get the first descriptor.
5034 * @return next descriptor or NULL after the last descriptor
5036 const AVCodecDescriptor *avcodec_descriptor_next(const AVCodecDescriptor *prev);
5039 * @return codec descriptor with the given name or NULL if no such descriptor
5042 const AVCodecDescriptor *avcodec_descriptor_get_by_name(const char *name);
5048 #endif /* AVCODEC_AVCODEC_H */