2 * copyright (c) 2001 Fabrice Bellard
4 * This file is part of FFmpeg.
6 * FFmpeg is free software; you can redistribute it and/or
7 * modify it under the terms of the GNU Lesser General Public
8 * License as published by the Free Software Foundation; either
9 * version 2.1 of the License, or (at your option) any later version.
11 * FFmpeg is distributed in the hope that it will be useful,
12 * but WITHOUT ANY WARRANTY; without even the implied warranty of
13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
14 * Lesser General Public License for more details.
16 * You should have received a copy of the GNU Lesser General Public
17 * License along with FFmpeg; if not, write to the Free Software
18 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
21 #ifndef AVCODEC_AVCODEC_H
22 #define AVCODEC_AVCODEC_H
27 * Libavcodec external API header
31 #include "libavutil/samplefmt.h"
32 #include "libavutil/attributes.h"
33 #include "libavutil/avutil.h"
34 #include "libavutil/buffer.h"
35 #include "libavutil/cpu.h"
36 #include "libavutil/channel_layout.h"
37 #include "libavutil/dict.h"
38 #include "libavutil/frame.h"
39 #include "libavutil/log.h"
40 #include "libavutil/pixfmt.h"
41 #include "libavutil/rational.h"
46 * @defgroup libavc Encoding/Decoding Library
49 * @defgroup lavc_decoding Decoding
53 * @defgroup lavc_encoding Encoding
57 * @defgroup lavc_codec Codecs
59 * @defgroup lavc_codec_native Native Codecs
62 * @defgroup lavc_codec_wrappers External library wrappers
65 * @defgroup lavc_codec_hwaccel Hardware Accelerators bridge
69 * @defgroup lavc_internal Internal
77 * @defgroup lavc_core Core functions/structures.
80 * Basic definitions, functions for querying libavcodec capabilities,
81 * allocating core structures, etc.
87 * Identify the syntax and semantics of the bitstream.
88 * The principle is roughly:
89 * Two decoders with the same ID can decode the same streams.
90 * Two encoders with the same ID can encode compatible streams.
91 * There may be slight deviations from the principle due to implementation
94 * If you add a codec ID to this list, add it so that
95 * 1. no value of a existing codec ID changes (that would break ABI),
96 * 2. Give it a value which when taken as ASCII is recognized uniquely by a human as this specific codec.
97 * This ensures that 2 forks can independently add AVCodecIDs without producing conflicts.
99 * After adding new codec IDs, do not forget to add an entry to the codec
100 * descriptor list and bump libavcodec minor version.
106 AV_CODEC_ID_MPEG1VIDEO,
107 AV_CODEC_ID_MPEG2VIDEO, ///< preferred ID for MPEG-1/2 video decoding
109 AV_CODEC_ID_MPEG2VIDEO_XVMC,
110 #endif /* FF_API_XVMC */
121 AV_CODEC_ID_RAWVIDEO,
122 AV_CODEC_ID_MSMPEG4V1,
123 AV_CODEC_ID_MSMPEG4V2,
124 AV_CODEC_ID_MSMPEG4V3,
147 AV_CODEC_ID_INTERPLAY_VIDEO,
154 AV_CODEC_ID_MSVIDEO1,
159 AV_CODEC_ID_TRUEMOTION1,
160 AV_CODEC_ID_VMDVIDEO,
185 AV_CODEC_ID_TRUEMOTION2,
191 AV_CODEC_ID_SMACKVIDEO,
196 AV_CODEC_ID_JPEG2000,
202 AV_CODEC_ID_DSICINVIDEO,
203 AV_CODEC_ID_TIERTEXSEQVIDEO,
211 AV_CODEC_ID_BETHSOFTVID,
223 AV_CODEC_ID_ESCAPE124,
227 AV_CODEC_ID_MOTIONPIXELS,
239 AV_CODEC_ID_FLASHSV2,
240 AV_CODEC_ID_CDGRAPHICS,
243 AV_CODEC_ID_BINKVIDEO,
244 AV_CODEC_ID_IFF_ILBM,
245 AV_CODEC_ID_IFF_BYTERUN1,
251 AV_CODEC_ID_A64_MULTI,
252 AV_CODEC_ID_A64_MULTI5,
255 AV_CODEC_ID_LAGARITH,
259 AV_CODEC_ID_WMV3IMAGE,
260 AV_CODEC_ID_VC1IMAGE,
262 AV_CODEC_ID_BMV_VIDEO,
269 AV_CODEC_ID_ZEROCODEC,
278 AV_CODEC_ID_ESCAPE130_DEPRECATED,
279 AV_CODEC_ID_G2M_DEPRECATED,
280 AV_CODEC_ID_WEBP_DEPRECATED,
281 AV_CODEC_ID_HNM4_VIDEO,
282 AV_CODEC_ID_HEVC_DEPRECATED,
284 AV_CODEC_ID_ALIAS_PIX,
285 AV_CODEC_ID_BRENDER_PIX_DEPRECATED,
286 AV_CODEC_ID_PAF_VIDEO_DEPRECATED,
287 AV_CODEC_ID_EXR_DEPRECATED,
288 AV_CODEC_ID_VP7_DEPRECATED,
289 AV_CODEC_ID_SANM_DEPRECATED,
290 AV_CODEC_ID_SGIRLE_DEPRECATED,
291 AV_CODEC_ID_MVC1_DEPRECATED,
292 AV_CODEC_ID_MVC2_DEPRECATED,
299 AV_CODEC_ID_BRENDER_PIX= MKBETAG('B','P','I','X'),
300 AV_CODEC_ID_Y41P = MKBETAG('Y','4','1','P'),
301 AV_CODEC_ID_ESCAPE130 = MKBETAG('E','1','3','0'),
302 AV_CODEC_ID_EXR = MKBETAG('0','E','X','R'),
303 AV_CODEC_ID_AVRP = MKBETAG('A','V','R','P'),
305 AV_CODEC_ID_012V = MKBETAG('0','1','2','V'),
306 AV_CODEC_ID_G2M = MKBETAG( 0 ,'G','2','M'),
307 AV_CODEC_ID_AVUI = MKBETAG('A','V','U','I'),
308 AV_CODEC_ID_AYUV = MKBETAG('A','Y','U','V'),
309 AV_CODEC_ID_TARGA_Y216 = MKBETAG('T','2','1','6'),
310 AV_CODEC_ID_V308 = MKBETAG('V','3','0','8'),
311 AV_CODEC_ID_V408 = MKBETAG('V','4','0','8'),
312 AV_CODEC_ID_YUV4 = MKBETAG('Y','U','V','4'),
313 AV_CODEC_ID_SANM = MKBETAG('S','A','N','M'),
314 AV_CODEC_ID_PAF_VIDEO = MKBETAG('P','A','F','V'),
315 AV_CODEC_ID_AVRN = MKBETAG('A','V','R','n'),
316 AV_CODEC_ID_CPIA = MKBETAG('C','P','I','A'),
317 AV_CODEC_ID_XFACE = MKBETAG('X','F','A','C'),
318 AV_CODEC_ID_SGIRLE = MKBETAG('S','G','I','R'),
319 AV_CODEC_ID_MVC1 = MKBETAG('M','V','C','1'),
320 AV_CODEC_ID_MVC2 = MKBETAG('M','V','C','2'),
321 AV_CODEC_ID_SNOW = MKBETAG('S','N','O','W'),
322 AV_CODEC_ID_WEBP = MKBETAG('W','E','B','P'),
323 AV_CODEC_ID_SMVJPEG = MKBETAG('S','M','V','J'),
324 AV_CODEC_ID_HEVC = MKBETAG('H','2','6','5'),
325 #define AV_CODEC_ID_H265 AV_CODEC_ID_HEVC
326 AV_CODEC_ID_VP7 = MKBETAG('V','P','7','0'),
327 AV_CODEC_ID_APNG = MKBETAG('A','P','N','G'),
329 /* various PCM "codecs" */
330 AV_CODEC_ID_FIRST_AUDIO = 0x10000, ///< A dummy id pointing at the start of audio codecs
331 AV_CODEC_ID_PCM_S16LE = 0x10000,
332 AV_CODEC_ID_PCM_S16BE,
333 AV_CODEC_ID_PCM_U16LE,
334 AV_CODEC_ID_PCM_U16BE,
337 AV_CODEC_ID_PCM_MULAW,
338 AV_CODEC_ID_PCM_ALAW,
339 AV_CODEC_ID_PCM_S32LE,
340 AV_CODEC_ID_PCM_S32BE,
341 AV_CODEC_ID_PCM_U32LE,
342 AV_CODEC_ID_PCM_U32BE,
343 AV_CODEC_ID_PCM_S24LE,
344 AV_CODEC_ID_PCM_S24BE,
345 AV_CODEC_ID_PCM_U24LE,
346 AV_CODEC_ID_PCM_U24BE,
347 AV_CODEC_ID_PCM_S24DAUD,
348 AV_CODEC_ID_PCM_ZORK,
349 AV_CODEC_ID_PCM_S16LE_PLANAR,
351 AV_CODEC_ID_PCM_F32BE,
352 AV_CODEC_ID_PCM_F32LE,
353 AV_CODEC_ID_PCM_F64BE,
354 AV_CODEC_ID_PCM_F64LE,
355 AV_CODEC_ID_PCM_BLURAY,
358 AV_CODEC_ID_PCM_S8_PLANAR,
359 AV_CODEC_ID_PCM_S24LE_PLANAR_DEPRECATED,
360 AV_CODEC_ID_PCM_S32LE_PLANAR_DEPRECATED,
361 AV_CODEC_ID_PCM_S16BE_PLANAR_DEPRECATED,
362 AV_CODEC_ID_PCM_S24LE_PLANAR = MKBETAG(24,'P','S','P'),
363 AV_CODEC_ID_PCM_S32LE_PLANAR = MKBETAG(32,'P','S','P'),
364 AV_CODEC_ID_PCM_S16BE_PLANAR = MKBETAG('P','S','P',16),
366 /* various ADPCM codecs */
367 AV_CODEC_ID_ADPCM_IMA_QT = 0x11000,
368 AV_CODEC_ID_ADPCM_IMA_WAV,
369 AV_CODEC_ID_ADPCM_IMA_DK3,
370 AV_CODEC_ID_ADPCM_IMA_DK4,
371 AV_CODEC_ID_ADPCM_IMA_WS,
372 AV_CODEC_ID_ADPCM_IMA_SMJPEG,
373 AV_CODEC_ID_ADPCM_MS,
374 AV_CODEC_ID_ADPCM_4XM,
375 AV_CODEC_ID_ADPCM_XA,
376 AV_CODEC_ID_ADPCM_ADX,
377 AV_CODEC_ID_ADPCM_EA,
378 AV_CODEC_ID_ADPCM_G726,
379 AV_CODEC_ID_ADPCM_CT,
380 AV_CODEC_ID_ADPCM_SWF,
381 AV_CODEC_ID_ADPCM_YAMAHA,
382 AV_CODEC_ID_ADPCM_SBPRO_4,
383 AV_CODEC_ID_ADPCM_SBPRO_3,
384 AV_CODEC_ID_ADPCM_SBPRO_2,
385 AV_CODEC_ID_ADPCM_THP,
386 AV_CODEC_ID_ADPCM_IMA_AMV,
387 AV_CODEC_ID_ADPCM_EA_R1,
388 AV_CODEC_ID_ADPCM_EA_R3,
389 AV_CODEC_ID_ADPCM_EA_R2,
390 AV_CODEC_ID_ADPCM_IMA_EA_SEAD,
391 AV_CODEC_ID_ADPCM_IMA_EA_EACS,
392 AV_CODEC_ID_ADPCM_EA_XAS,
393 AV_CODEC_ID_ADPCM_EA_MAXIS_XA,
394 AV_CODEC_ID_ADPCM_IMA_ISS,
395 AV_CODEC_ID_ADPCM_G722,
396 AV_CODEC_ID_ADPCM_IMA_APC,
397 AV_CODEC_ID_ADPCM_VIMA_DEPRECATED,
398 AV_CODEC_ID_ADPCM_VIMA = MKBETAG('V','I','M','A'),
399 #if FF_API_VIMA_DECODER
400 AV_CODEC_ID_VIMA = MKBETAG('V','I','M','A'),
402 AV_CODEC_ID_ADPCM_AFC = MKBETAG('A','F','C',' '),
403 AV_CODEC_ID_ADPCM_IMA_OKI = MKBETAG('O','K','I',' '),
404 AV_CODEC_ID_ADPCM_DTK = MKBETAG('D','T','K',' '),
405 AV_CODEC_ID_ADPCM_IMA_RAD = MKBETAG('R','A','D',' '),
406 AV_CODEC_ID_ADPCM_G726LE = MKBETAG('6','2','7','G'),
407 AV_CODEC_ID_ADPCM_THP_LE = MKBETAG('T','H','P','L'),
410 AV_CODEC_ID_AMR_NB = 0x12000,
413 /* RealAudio codecs*/
414 AV_CODEC_ID_RA_144 = 0x13000,
417 /* various DPCM codecs */
418 AV_CODEC_ID_ROQ_DPCM = 0x14000,
419 AV_CODEC_ID_INTERPLAY_DPCM,
420 AV_CODEC_ID_XAN_DPCM,
421 AV_CODEC_ID_SOL_DPCM,
424 AV_CODEC_ID_MP2 = 0x15000,
425 AV_CODEC_ID_MP3, ///< preferred ID for decoding MPEG audio layer 1, 2 or 3
435 AV_CODEC_ID_VMDAUDIO,
441 AV_CODEC_ID_WESTWOOD_SND1,
442 AV_CODEC_ID_GSM, ///< as in Berlin toast format
445 AV_CODEC_ID_TRUESPEECH,
447 AV_CODEC_ID_SMACKAUDIO,
450 AV_CODEC_ID_DSICINAUDIO,
452 AV_CODEC_ID_MUSEPACK7,
454 AV_CODEC_ID_GSM_MS, /* as found in WAV */
460 AV_CODEC_ID_NELLYMOSER,
461 AV_CODEC_ID_MUSEPACK8,
463 AV_CODEC_ID_WMAVOICE,
465 AV_CODEC_ID_WMALOSSLESS,
474 AV_CODEC_ID_BINKAUDIO_RDFT,
475 AV_CODEC_ID_BINKAUDIO_DCT,
476 AV_CODEC_ID_AAC_LATM,
481 AV_CODEC_ID_8SVX_EXP,
482 AV_CODEC_ID_8SVX_FIB,
483 AV_CODEC_ID_BMV_AUDIO,
487 AV_CODEC_ID_OPUS_DEPRECATED,
488 AV_CODEC_ID_COMFORT_NOISE,
489 AV_CODEC_ID_TAK_DEPRECATED,
490 AV_CODEC_ID_METASOUND,
491 AV_CODEC_ID_PAF_AUDIO_DEPRECATED,
494 AV_CODEC_ID_FFWAVESYNTH = MKBETAG('F','F','W','S'),
495 AV_CODEC_ID_SONIC = MKBETAG('S','O','N','C'),
496 AV_CODEC_ID_SONIC_LS = MKBETAG('S','O','N','L'),
497 AV_CODEC_ID_PAF_AUDIO = MKBETAG('P','A','F','A'),
498 AV_CODEC_ID_OPUS = MKBETAG('O','P','U','S'),
499 AV_CODEC_ID_TAK = MKBETAG('t','B','a','K'),
500 AV_CODEC_ID_EVRC = MKBETAG('s','e','v','c'),
501 AV_CODEC_ID_SMV = MKBETAG('s','s','m','v'),
502 AV_CODEC_ID_DSD_LSBF = MKBETAG('D','S','D','L'),
503 AV_CODEC_ID_DSD_MSBF = MKBETAG('D','S','D','M'),
504 AV_CODEC_ID_DSD_LSBF_PLANAR = MKBETAG('D','S','D','1'),
505 AV_CODEC_ID_DSD_MSBF_PLANAR = MKBETAG('D','S','D','8'),
506 AV_CODEC_ID_4GV = MKBETAG('s','4','g','v'),
508 /* subtitle codecs */
509 AV_CODEC_ID_FIRST_SUBTITLE = 0x17000, ///< A dummy ID pointing at the start of subtitle codecs.
510 AV_CODEC_ID_DVD_SUBTITLE = 0x17000,
511 AV_CODEC_ID_DVB_SUBTITLE,
512 AV_CODEC_ID_TEXT, ///< raw UTF-8 text
515 AV_CODEC_ID_MOV_TEXT,
516 AV_CODEC_ID_HDMV_PGS_SUBTITLE,
517 AV_CODEC_ID_DVB_TELETEXT,
519 AV_CODEC_ID_MICRODVD = MKBETAG('m','D','V','D'),
520 AV_CODEC_ID_EIA_608 = MKBETAG('c','6','0','8'),
521 AV_CODEC_ID_JACOSUB = MKBETAG('J','S','U','B'),
522 AV_CODEC_ID_SAMI = MKBETAG('S','A','M','I'),
523 AV_CODEC_ID_REALTEXT = MKBETAG('R','T','X','T'),
524 AV_CODEC_ID_STL = MKBETAG('S','p','T','L'),
525 AV_CODEC_ID_SUBVIEWER1 = MKBETAG('S','b','V','1'),
526 AV_CODEC_ID_SUBVIEWER = MKBETAG('S','u','b','V'),
527 AV_CODEC_ID_SUBRIP = MKBETAG('S','R','i','p'),
528 AV_CODEC_ID_WEBVTT = MKBETAG('W','V','T','T'),
529 AV_CODEC_ID_MPL2 = MKBETAG('M','P','L','2'),
530 AV_CODEC_ID_VPLAYER = MKBETAG('V','P','l','r'),
531 AV_CODEC_ID_PJS = MKBETAG('P','h','J','S'),
532 AV_CODEC_ID_ASS = MKBETAG('A','S','S',' '), ///< ASS as defined in Matroska
534 /* other specific kind of codecs (generally used for attachments) */
535 AV_CODEC_ID_FIRST_UNKNOWN = 0x18000, ///< A dummy ID pointing at the start of various fake codecs.
536 AV_CODEC_ID_TTF = 0x18000,
537 AV_CODEC_ID_BINTEXT = MKBETAG('B','T','X','T'),
538 AV_CODEC_ID_XBIN = MKBETAG('X','B','I','N'),
539 AV_CODEC_ID_IDF = MKBETAG( 0 ,'I','D','F'),
540 AV_CODEC_ID_OTF = MKBETAG( 0 ,'O','T','F'),
541 AV_CODEC_ID_SMPTE_KLV = MKBETAG('K','L','V','A'),
542 AV_CODEC_ID_DVD_NAV = MKBETAG('D','N','A','V'),
543 AV_CODEC_ID_TIMED_ID3 = MKBETAG('T','I','D','3'),
544 AV_CODEC_ID_BIN_DATA = MKBETAG('D','A','T','A'),
547 AV_CODEC_ID_PROBE = 0x19000, ///< codec_id is not known (like AV_CODEC_ID_NONE) but lavf should attempt to identify it
549 AV_CODEC_ID_MPEG2TS = 0x20000, /**< _FAKE_ codec to indicate a raw MPEG-2 TS
550 * stream (only used by libavformat) */
551 AV_CODEC_ID_MPEG4SYSTEMS = 0x20001, /**< _FAKE_ codec to indicate a MPEG-4 Systems
552 * stream (only used by libavformat) */
553 AV_CODEC_ID_FFMETADATA = 0x21000, ///< Dummy codec for streams containing only metadata information.
556 #include "old_codec_ids.h"
561 * This struct describes the properties of a single codec described by an
563 * @see avcodec_descriptor_get()
565 typedef struct AVCodecDescriptor {
567 enum AVMediaType type;
569 * Name of the codec described by this descriptor. It is non-empty and
570 * unique for each codec descriptor. It should contain alphanumeric
571 * characters and '_' only.
575 * A more descriptive name for this codec. May be NULL.
577 const char *long_name;
579 * Codec properties, a combination of AV_CODEC_PROP_* flags.
584 * MIME type(s) associated with the codec.
585 * May be NULL; if not, a NULL-terminated array of MIME types.
586 * The first item is always non-NULL and is the preferred MIME type.
588 const char *const *mime_types;
592 * Codec uses only intra compression.
595 #define AV_CODEC_PROP_INTRA_ONLY (1 << 0)
597 * Codec supports lossy compression. Audio and video codecs only.
598 * @note a codec may support both lossy and lossless
601 #define AV_CODEC_PROP_LOSSY (1 << 1)
603 * Codec supports lossless compression. Audio and video codecs only.
605 #define AV_CODEC_PROP_LOSSLESS (1 << 2)
607 * Codec supports frame reordering. That is, the coded order (the order in which
608 * the encoded packets are output by the encoders / stored / input to the
609 * decoders) may be different from the presentation order of the corresponding
612 * For codecs that do not have this property set, PTS and DTS should always be
615 #define AV_CODEC_PROP_REORDER (1 << 3)
617 * Subtitle codec is bitmap based
618 * Decoded AVSubtitle data can be read from the AVSubtitleRect->pict field.
620 #define AV_CODEC_PROP_BITMAP_SUB (1 << 16)
622 * Subtitle codec is text based.
623 * Decoded AVSubtitle data can be read from the AVSubtitleRect->ass field.
625 #define AV_CODEC_PROP_TEXT_SUB (1 << 17)
628 * @ingroup lavc_decoding
629 * Required number of additionally allocated bytes at the end of the input bitstream for decoding.
630 * This is mainly needed because some optimized bitstream readers read
631 * 32 or 64 bit at once and could read over the end.<br>
632 * Note: If the first 23 bits of the additional bytes are not 0, then damaged
633 * MPEG bitstreams could cause overread and segfault.
635 #define AV_INPUT_BUFFER_PADDING_SIZE 32
638 * @ingroup lavc_encoding
639 * minimum encoding buffer size
640 * Used to avoid some checks during header writing.
642 #define AV_INPUT_BUFFER_MIN_SIZE 16384
644 #if FF_API_WITHOUT_PREFIX
646 * @deprecated use AV_INPUT_BUFFER_PADDING_SIZE instead
648 #define FF_INPUT_BUFFER_PADDING_SIZE 32
651 * @deprecated use AV_INPUT_BUFFER_MIN_SIZE instead
653 #define FF_MIN_BUFFER_SIZE 16384
654 #endif /* FF_API_WITHOUT_PREFIX */
657 * @ingroup lavc_encoding
658 * motion estimation type.
659 * @deprecated use codec private option instead
661 #if FF_API_MOTION_EST
663 ME_ZERO = 1, ///< no search, that is use 0,0 vector whenever one is needed
667 ME_EPZS, ///< enhanced predictive zonal search
668 ME_X1, ///< reserved for experiments
669 ME_HEX, ///< hexagon based search
670 ME_UMH, ///< uneven multi-hexagon search
671 ME_TESA, ///< transformed exhaustive search algorithm
672 ME_ITER=50, ///< iterative search
677 * @ingroup lavc_decoding
680 /* We leave some space between them for extensions (drop some
681 * keyframes for intra-only or drop just some bidir frames). */
682 AVDISCARD_NONE =-16, ///< discard nothing
683 AVDISCARD_DEFAULT = 0, ///< discard useless packets like 0 size packets in avi
684 AVDISCARD_NONREF = 8, ///< discard all non reference
685 AVDISCARD_BIDIR = 16, ///< discard all bidirectional frames
686 AVDISCARD_NONINTRA= 24, ///< discard all non intra frames
687 AVDISCARD_NONKEY = 32, ///< discard all frames except keyframes
688 AVDISCARD_ALL = 48, ///< discard all
691 enum AVAudioServiceType {
692 AV_AUDIO_SERVICE_TYPE_MAIN = 0,
693 AV_AUDIO_SERVICE_TYPE_EFFECTS = 1,
694 AV_AUDIO_SERVICE_TYPE_VISUALLY_IMPAIRED = 2,
695 AV_AUDIO_SERVICE_TYPE_HEARING_IMPAIRED = 3,
696 AV_AUDIO_SERVICE_TYPE_DIALOGUE = 4,
697 AV_AUDIO_SERVICE_TYPE_COMMENTARY = 5,
698 AV_AUDIO_SERVICE_TYPE_EMERGENCY = 6,
699 AV_AUDIO_SERVICE_TYPE_VOICE_OVER = 7,
700 AV_AUDIO_SERVICE_TYPE_KARAOKE = 8,
701 AV_AUDIO_SERVICE_TYPE_NB , ///< Not part of ABI
705 * @ingroup lavc_encoding
707 typedef struct RcOverride{
710 int qscale; // If this is 0 then quality_factor will be used instead.
711 float quality_factor;
714 #if FF_API_MAX_BFRAMES
716 * @deprecated there is no libavcodec-wide limit on the number of B-frames
718 #define FF_MAX_B_FRAMES 16
722 These flags can be passed in AVCodecContext.flags before initialization.
723 Note: Not everything is supported yet.
727 * Allow decoders to produce frames with data planes that are not aligned
728 * to CPU requirements (e.g. due to cropping).
730 #define AV_CODEC_FLAG_UNALIGNED (1 << 0)
734 #define AV_CODEC_FLAG_QSCALE (1 << 1)
736 * 4 MV per MB allowed / advanced prediction for H.263.
738 #define AV_CODEC_FLAG_4MV (1 << 2)
740 * Output even those frames that might be corrupted.
742 #define AV_CODEC_FLAG_OUTPUT_CORRUPT (1 << 3)
746 #define AV_CODEC_FLAG_QPEL (1 << 4)
748 * Use internal 2pass ratecontrol in first pass mode.
750 #define AV_CODEC_FLAG_PASS1 (1 << 9)
752 * Use internal 2pass ratecontrol in second pass mode.
754 #define AV_CODEC_FLAG_PASS2 (1 << 10)
758 #define AV_CODEC_FLAG_LOOP_FILTER (1 << 11)
760 * Only decode/encode grayscale.
762 #define AV_CODEC_FLAG_GRAY (1 << 13)
764 * error[?] variables will be set during encoding.
766 #define AV_CODEC_FLAG_PSNR (1 << 15)
768 * Input bitstream might be truncated at a random location
769 * instead of only at frame boundaries.
771 #define AV_CODEC_FLAG_TRUNCATED (1 << 16)
773 * Use interlaced DCT.
775 #define AV_CODEC_FLAG_INTERLACED_DCT (1 << 18)
779 #define AV_CODEC_FLAG_LOW_DELAY (1 << 19)
781 * Place global headers in extradata instead of every keyframe.
783 #define AV_CODEC_FLAG_GLOBAL_HEADER (1 << 22)
785 * Use only bitexact stuff (except (I)DCT).
787 #define AV_CODEC_FLAG_BITEXACT (1 << 23)
788 /* Fx : Flag for h263+ extra options */
790 * H.263 advanced intra coding / MPEG-4 AC prediction
792 #define AV_CODEC_FLAG_AC_PRED (1 << 24)
794 * interlaced motion estimation
796 #define AV_CODEC_FLAG_INTERLACED_ME (1 << 29)
798 * Allow non spec compliant speedup tricks.
800 #define AV_CODEC_FLAG_CLOSED_GOP (1U << 31)
802 #define AV_CODEC_FLAG2_FAST (1 << 0)
804 * Skip bitstream encoding.
806 #define AV_CODEC_FLAG2_NO_OUTPUT (1 << 2)
808 * Place global headers at every keyframe instead of in extradata.
810 #define AV_CODEC_FLAG2_LOCAL_HEADER (1 << 3)
813 * timecode is in drop frame format. DEPRECATED!!!!
815 #define AV_CODEC_FLAG2_DROP_FRAME_TIMECODE (1 << 13)
818 * Input bitstream might be truncated at a packet boundaries
819 * instead of only at frame boundaries.
821 #define AV_CODEC_FLAG2_CHUNKS (1 << 15)
823 * Discard cropping information from SPS.
825 #define AV_CODEC_FLAG2_IGNORE_CROP (1 << 16)
828 * Show all frames before the first keyframe
830 #define AV_CODEC_FLAG2_SHOW_ALL (1 << 22)
832 * Export motion vectors through frame side data
834 #define AV_CODEC_FLAG2_EXPORT_MVS (1 << 28)
836 * Do not skip samples and export skip information as frame side data
838 #define AV_CODEC_FLAG2_SKIP_MANUAL (1 << 29)
840 /* Unsupported options :
841 * Syntax Arithmetic coding (SAC)
842 * Reference Picture Selection
843 * Independent Segment Decoding */
845 /* codec capabilities */
848 * Decoder can use draw_horiz_band callback.
850 #define AV_CODEC_CAP_DRAW_HORIZ_BAND (1 << 0)
852 * Codec uses get_buffer() for allocating buffers and supports custom allocators.
853 * If not set, it might not use get_buffer() at all or use operations that
854 * assume the buffer was allocated by avcodec_default_get_buffer.
856 #define AV_CODEC_CAP_DR1 (1 << 1)
857 #define AV_CODEC_CAP_TRUNCATED (1 << 3)
859 * Encoder or decoder requires flushing with NULL input at the end in order to
860 * give the complete and correct output.
862 * NOTE: If this flag is not set, the codec is guaranteed to never be fed with
863 * with NULL data. The user can still send NULL data to the public encode
864 * or decode function, but libavcodec will not pass it along to the codec
865 * unless this flag is set.
868 * The decoder has a non-zero delay and needs to be fed with avpkt->data=NULL,
869 * avpkt->size=0 at the end to get the delayed data until the decoder no longer
873 * The encoder needs to be fed with NULL data at the end of encoding until the
874 * encoder no longer returns data.
876 * NOTE: For encoders implementing the AVCodec.encode2() function, setting this
877 * flag also means that the encoder must set the pts and duration for
878 * each output packet. If this flag is not set, the pts and duration will
879 * be determined by libavcodec from the input frame.
881 #define AV_CODEC_CAP_DELAY (1 << 5)
883 * Codec can be fed a final frame with a smaller size.
884 * This can be used to prevent truncation of the last audio samples.
886 #define AV_CODEC_CAP_SMALL_LAST_FRAME (1 << 6)
890 * Codec can export data for HW decoding (VDPAU).
892 #define AV_CODEC_CAP_HWACCEL_VDPAU (1 << 7)
896 * Codec can output multiple frames per AVPacket
897 * Normally demuxers return one frame at a time, demuxers which do not do
898 * are connected to a parser to split what they return into proper frames.
899 * This flag is reserved to the very rare category of codecs which have a
900 * bitstream that cannot be split into frames without timeconsuming
901 * operations like full decoding. Demuxers carring such bitstreams thus
902 * may return multiple frames in a packet. This has many disadvantages like
903 * prohibiting stream copy in many cases thus it should only be considered
906 #define AV_CODEC_CAP_SUBFRAMES (1 << 8)
908 * Codec is experimental and is thus avoided in favor of non experimental
911 #define AV_CODEC_CAP_EXPERIMENTAL (1 << 9)
913 * Codec should fill in channel configuration and samplerate instead of container
915 #define AV_CODEC_CAP_CHANNEL_CONF (1 << 10)
917 * Codec supports frame-level multithreading.
919 #define AV_CODEC_CAP_FRAME_THREADS (1 << 12)
921 * Codec supports slice-based (or partition-based) multithreading.
923 #define AV_CODEC_CAP_SLICE_THREADS (1 << 13)
925 * Codec supports changed parameters at any point.
927 #define AV_CODEC_CAP_PARAM_CHANGE (1 << 14)
929 * Codec supports avctx->thread_count == 0 (auto).
931 #define AV_CODEC_CAP_AUTO_THREADS (1 << 15)
933 * Audio encoder supports receiving a different number of samples in each call.
935 #define AV_CODEC_CAP_VARIABLE_FRAME_SIZE (1 << 16)
937 * Codec is intra only.
939 #define AV_CODEC_CAP_INTRA_ONLY 0x40000000
943 #define AV_CODEC_CAP_LOSSLESS 0x80000000
946 #if FF_API_WITHOUT_PREFIX
948 * Allow decoders to produce frames with data planes that are not aligned
949 * to CPU requirements (e.g. due to cropping).
951 #define CODEC_FLAG_UNALIGNED AV_CODEC_FLAG_UNALIGNED
952 #define CODEC_FLAG_QSCALE AV_CODEC_FLAG_QSCALE
953 #define CODEC_FLAG_4MV AV_CODEC_FLAG_4MV
954 #define CODEC_FLAG_OUTPUT_CORRUPT AV_CODEC_FLAG_OUTPUT_CORRUPT
955 #define CODEC_FLAG_QPEL AV_CODEC_FLAG_QPEL
958 * @deprecated use the "gmc" private option of the libxvid encoder
960 #define CODEC_FLAG_GMC 0x0020 ///< Use GMC.
964 * @deprecated use the flag "mv0" in the "mpv_flags" private option of the
967 #define CODEC_FLAG_MV0 0x0040
969 #if FF_API_INPUT_PRESERVED
971 * @deprecated passing reference-counted frames to the encoders replaces this
974 #define CODEC_FLAG_INPUT_PRESERVED 0x0100
976 #define CODEC_FLAG_PASS1 AV_CODEC_FLAG_PASS1
977 #define CODEC_FLAG_PASS2 AV_CODEC_FLAG_PASS2
978 #define CODEC_FLAG_GRAY AV_CODEC_FLAG_GRAY
981 * @deprecated edges are not used/required anymore. I.e. this flag is now always
984 #define CODEC_FLAG_EMU_EDGE 0x4000
986 #define CODEC_FLAG_PSNR AV_CODEC_FLAG_PSNR
987 #define CODEC_FLAG_TRUNCATED AV_CODEC_FLAG_TRUNCATED
989 #if FF_API_NORMALIZE_AQP
991 * @deprecated use the flag "naq" in the "mpv_flags" private option of the
994 #define CODEC_FLAG_NORMALIZE_AQP 0x00020000
996 #define CODEC_FLAG_INTERLACED_DCT AV_CODEC_FLAG_INTERLACED_DCT
997 #define CODEC_FLAG_LOW_DELAY AV_CODEC_FLAG_LOW_DELAY
998 #define CODEC_FLAG_GLOBAL_HEADER AV_CODEC_FLAG_GLOBAL_HEADER
999 #define CODEC_FLAG_BITEXACT AV_CODEC_FLAG_BITEXACT
1000 #define CODEC_FLAG_AC_PRED AV_CODEC_FLAG_AC_PRED
1001 #define CODEC_FLAG_LOOP_FILTER AV_CODEC_FLAG_LOOP_FILTER
1002 #define CODEC_FLAG_INTERLACED_ME AV_CODEC_FLAG_INTERLACED_ME
1003 #define CODEC_FLAG_CLOSED_GOP AV_CODEC_FLAG_CLOSED_GOP
1004 #define CODEC_FLAG2_FAST AV_CODEC_FLAG2_FAST
1005 #define CODEC_FLAG2_NO_OUTPUT AV_CODEC_FLAG2_NO_OUTPUT
1006 #define CODEC_FLAG2_LOCAL_HEADER AV_CODEC_FLAG2_LOCAL_HEADER
1007 #define CODEC_FLAG2_DROP_FRAME_TIMECODE AV_CODEC_FLAG2_DROP_FRAME_TIMECODE
1008 #define CODEC_FLAG2_IGNORE_CROP AV_CODEC_FLAG2_IGNORE_CROP
1010 #define CODEC_FLAG2_CHUNKS AV_CODEC_FLAG2_CHUNKS
1011 #define CODEC_FLAG2_SHOW_ALL AV_CODEC_FLAG2_SHOW_ALL
1012 #define CODEC_FLAG2_EXPORT_MVS AV_CODEC_FLAG2_EXPORT_MVS
1013 #define CODEC_FLAG2_SKIP_MANUAL AV_CODEC_FLAG2_SKIP_MANUAL
1015 /* Unsupported options :
1016 * Syntax Arithmetic coding (SAC)
1017 * Reference Picture Selection
1018 * Independent Segment Decoding */
1020 /* codec capabilities */
1022 #define CODEC_CAP_DRAW_HORIZ_BAND AV_CODEC_CAP_DRAW_HORIZ_BAND ///< Decoder can use draw_horiz_band callback.
1024 * Codec uses get_buffer() for allocating buffers and supports custom allocators.
1025 * If not set, it might not use get_buffer() at all or use operations that
1026 * assume the buffer was allocated by avcodec_default_get_buffer.
1028 #define CODEC_CAP_DR1 AV_CODEC_CAP_DR1
1029 #define CODEC_CAP_TRUNCATED AV_CODEC_CAP_TRUNCATED
1031 /* Codec can export data for HW decoding. This flag indicates that
1032 * the codec would call get_format() with list that might contain HW accelerated
1033 * pixel formats (XvMC, VDPAU, VAAPI, etc). The application can pick any of them
1034 * including raw image format.
1035 * The application can use the passed context to determine bitstream version,
1036 * chroma format, resolution etc.
1038 #define CODEC_CAP_HWACCEL 0x0010
1039 #endif /* FF_API_XVMC */
1041 * Encoder or decoder requires flushing with NULL input at the end in order to
1042 * give the complete and correct output.
1044 * NOTE: If this flag is not set, the codec is guaranteed to never be fed with
1045 * with NULL data. The user can still send NULL data to the public encode
1046 * or decode function, but libavcodec will not pass it along to the codec
1047 * unless this flag is set.
1050 * The decoder has a non-zero delay and needs to be fed with avpkt->data=NULL,
1051 * avpkt->size=0 at the end to get the delayed data until the decoder no longer
1055 * The encoder needs to be fed with NULL data at the end of encoding until the
1056 * encoder no longer returns data.
1058 * NOTE: For encoders implementing the AVCodec.encode2() function, setting this
1059 * flag also means that the encoder must set the pts and duration for
1060 * each output packet. If this flag is not set, the pts and duration will
1061 * be determined by libavcodec from the input frame.
1063 #define CODEC_CAP_DELAY AV_CODEC_CAP_DELAY
1065 * Codec can be fed a final frame with a smaller size.
1066 * This can be used to prevent truncation of the last audio samples.
1068 #define CODEC_CAP_SMALL_LAST_FRAME AV_CODEC_CAP_SMALL_LAST_FRAME
1069 #if FF_API_CAP_VDPAU
1071 * Codec can export data for HW decoding (VDPAU).
1073 #define CODEC_CAP_HWACCEL_VDPAU AV_CODEC_CAP_HWACCEL_VDPAU
1076 * Codec can output multiple frames per AVPacket
1077 * Normally demuxers return one frame at a time, demuxers which do not do
1078 * are connected to a parser to split what they return into proper frames.
1079 * This flag is reserved to the very rare category of codecs which have a
1080 * bitstream that cannot be split into frames without timeconsuming
1081 * operations like full decoding. Demuxers carring such bitstreams thus
1082 * may return multiple frames in a packet. This has many disadvantages like
1083 * prohibiting stream copy in many cases thus it should only be considered
1086 #define CODEC_CAP_SUBFRAMES AV_CODEC_CAP_SUBFRAMES
1088 * Codec is experimental and is thus avoided in favor of non experimental
1091 #define CODEC_CAP_EXPERIMENTAL AV_CODEC_CAP_EXPERIMENTAL
1093 * Codec should fill in channel configuration and samplerate instead of container
1095 #define CODEC_CAP_CHANNEL_CONF AV_CODEC_CAP_CHANNEL_CONF
1096 #if FF_API_NEG_LINESIZES
1098 * @deprecated no codecs use this capability
1100 #define CODEC_CAP_NEG_LINESIZES 0x0800
1103 * Codec supports frame-level multithreading.
1105 #define CODEC_CAP_FRAME_THREADS AV_CODEC_CAP_FRAME_THREADS
1107 * Codec supports slice-based (or partition-based) multithreading.
1109 #define CODEC_CAP_SLICE_THREADS AV_CODEC_CAP_SLICE_THREADS
1111 * Codec supports changed parameters at any point.
1113 #define CODEC_CAP_PARAM_CHANGE AV_CODEC_CAP_PARAM_CHANGE
1115 * Codec supports avctx->thread_count == 0 (auto).
1117 #define CODEC_CAP_AUTO_THREADS AV_CODEC_CAP_AUTO_THREADS
1119 * Audio encoder supports receiving a different number of samples in each call.
1121 #define CODEC_CAP_VARIABLE_FRAME_SIZE AV_CODEC_CAP_VARIABLE_FRAME_SIZE
1123 * Codec is intra only.
1125 #define CODEC_CAP_INTRA_ONLY AV_CODEC_CAP_INTRA_ONLY
1127 * Codec is lossless.
1129 #define CODEC_CAP_LOSSLESS AV_CODEC_CAP_LOSSLESS
1132 * HWAccel is experimental and is thus avoided in favor of non experimental
1135 #define HWACCEL_CODEC_CAP_EXPERIMENTAL 0x0200
1136 #endif /* FF_API_WITHOUT_PREFIX */
1139 //The following defines may change, don't expect compatibility if you use them.
1140 #define MB_TYPE_INTRA4x4 0x0001
1141 #define MB_TYPE_INTRA16x16 0x0002 //FIXME H.264-specific
1142 #define MB_TYPE_INTRA_PCM 0x0004 //FIXME H.264-specific
1143 #define MB_TYPE_16x16 0x0008
1144 #define MB_TYPE_16x8 0x0010
1145 #define MB_TYPE_8x16 0x0020
1146 #define MB_TYPE_8x8 0x0040
1147 #define MB_TYPE_INTERLACED 0x0080
1148 #define MB_TYPE_DIRECT2 0x0100 //FIXME
1149 #define MB_TYPE_ACPRED 0x0200
1150 #define MB_TYPE_GMC 0x0400
1151 #define MB_TYPE_SKIP 0x0800
1152 #define MB_TYPE_P0L0 0x1000
1153 #define MB_TYPE_P1L0 0x2000
1154 #define MB_TYPE_P0L1 0x4000
1155 #define MB_TYPE_P1L1 0x8000
1156 #define MB_TYPE_L0 (MB_TYPE_P0L0 | MB_TYPE_P1L0)
1157 #define MB_TYPE_L1 (MB_TYPE_P0L1 | MB_TYPE_P1L1)
1158 #define MB_TYPE_L0L1 (MB_TYPE_L0 | MB_TYPE_L1)
1159 #define MB_TYPE_QUANT 0x00010000
1160 #define MB_TYPE_CBP 0x00020000
1161 //Note bits 24-31 are reserved for codec specific use (h264 ref0, mpeg1 0mv, ...)
1166 * This specifies the area which should be displayed.
1167 * Note there may be multiple such areas for one frame.
1169 typedef struct AVPanScan{
1172 * - encoding: Set by user.
1173 * - decoding: Set by libavcodec.
1178 * width and height in 1/16 pel
1179 * - encoding: Set by user.
1180 * - decoding: Set by libavcodec.
1186 * position of the top left corner in 1/16 pel for up to 3 fields/frames
1187 * - encoding: Set by user.
1188 * - decoding: Set by libavcodec.
1190 int16_t position[3][2];
1193 #if FF_API_QSCALE_TYPE
1194 #define FF_QSCALE_TYPE_MPEG1 0
1195 #define FF_QSCALE_TYPE_MPEG2 1
1196 #define FF_QSCALE_TYPE_H264 2
1197 #define FF_QSCALE_TYPE_VP56 3
1200 #if FF_API_GET_BUFFER
1201 #define FF_BUFFER_TYPE_INTERNAL 1
1202 #define FF_BUFFER_TYPE_USER 2 ///< direct rendering buffers (image is (de)allocated by user)
1203 #define FF_BUFFER_TYPE_SHARED 4 ///< Buffer from somewhere else; don't deallocate image (data/base), all other tables are not shared.
1204 #define FF_BUFFER_TYPE_COPY 8 ///< Just a (modified) copy of some other buffer, don't deallocate anything.
1206 #define FF_BUFFER_HINTS_VALID 0x01 // Buffer hints value is meaningful (if 0 ignore).
1207 #define FF_BUFFER_HINTS_READABLE 0x02 // Codec will read from buffer.
1208 #define FF_BUFFER_HINTS_PRESERVE 0x04 // User must not alter buffer content.
1209 #define FF_BUFFER_HINTS_REUSABLE 0x08 // Codec will reuse the buffer (update).
1213 * The decoder will keep a reference to the frame and may reuse it later.
1215 #define AV_GET_BUFFER_FLAG_REF (1 << 0)
1218 * @defgroup lavc_packet AVPacket
1220 * Types and functions for working with AVPacket.
1223 enum AVPacketSideDataType {
1224 AV_PKT_DATA_PALETTE,
1225 AV_PKT_DATA_NEW_EXTRADATA,
1228 * An AV_PKT_DATA_PARAM_CHANGE side data packet is laid out as follows:
1231 * if (param_flags & AV_SIDE_DATA_PARAM_CHANGE_CHANNEL_COUNT)
1232 * s32le channel_count
1233 * if (param_flags & AV_SIDE_DATA_PARAM_CHANGE_CHANNEL_LAYOUT)
1234 * u64le channel_layout
1235 * if (param_flags & AV_SIDE_DATA_PARAM_CHANGE_SAMPLE_RATE)
1237 * if (param_flags & AV_SIDE_DATA_PARAM_CHANGE_DIMENSIONS)
1242 AV_PKT_DATA_PARAM_CHANGE,
1245 * An AV_PKT_DATA_H263_MB_INFO side data packet contains a number of
1246 * structures with info about macroblocks relevant to splitting the
1247 * packet into smaller packets on macroblock edges (e.g. as for RFC 2190).
1248 * That is, it does not necessarily contain info about all macroblocks,
1249 * as long as the distance between macroblocks in the info is smaller
1250 * than the target payload size.
1251 * Each MB info structure is 12 bytes, and is laid out as follows:
1253 * u32le bit offset from the start of the packet
1254 * u8 current quantizer at the start of the macroblock
1256 * u16le macroblock address within the GOB
1257 * u8 horizontal MV predictor
1258 * u8 vertical MV predictor
1259 * u8 horizontal MV predictor for block number 3
1260 * u8 vertical MV predictor for block number 3
1263 AV_PKT_DATA_H263_MB_INFO,
1266 * This side data should be associated with an audio stream and contains
1267 * ReplayGain information in form of the AVReplayGain struct.
1269 AV_PKT_DATA_REPLAYGAIN,
1272 * This side data contains a 3x3 transformation matrix describing an affine
1273 * transformation that needs to be applied to the decoded video frames for
1274 * correct presentation.
1276 * See libavutil/display.h for a detailed description of the data.
1278 AV_PKT_DATA_DISPLAYMATRIX,
1281 * This side data should be associated with a video stream and contains
1282 * Stereoscopic 3D information in form of the AVStereo3D struct.
1284 AV_PKT_DATA_STEREO3D,
1287 * This side data should be associated with an audio stream and corresponds
1288 * to enum AVAudioServiceType.
1290 AV_PKT_DATA_AUDIO_SERVICE_TYPE,
1293 * This side data contains quality related information from the encoder.
1295 * u32le quality factor of the compressed frame. Allowed range is between 1 (good) and FF_LAMBDA_MAX (bad).
1299 * u64le[error count] sum of squared differences between encoder in and output
1302 AV_PKT_DATA_QUALITY_STATS,
1305 * Recommmends skipping the specified number of samples
1307 * u32le number of samples to skip from start of this packet
1308 * u32le number of samples to skip from end of this packet
1309 * u8 reason for start skip
1310 * u8 reason for end skip (0=padding silence, 1=convergence)
1313 AV_PKT_DATA_SKIP_SAMPLES=70,
1316 * An AV_PKT_DATA_JP_DUALMONO side data packet indicates that
1317 * the packet may contain "dual mono" audio specific to Japanese DTV
1318 * and if it is true, recommends only the selected channel to be used.
1320 * u8 selected channels (0=mail/left, 1=sub/right, 2=both)
1323 AV_PKT_DATA_JP_DUALMONO,
1326 * A list of zero terminated key/value strings. There is no end marker for
1327 * the list, so it is required to rely on the side data size to stop.
1329 AV_PKT_DATA_STRINGS_METADATA,
1332 * Subtitle event position
1340 AV_PKT_DATA_SUBTITLE_POSITION,
1343 * Data found in BlockAdditional element of matroska container. There is
1344 * no end marker for the data, so it is required to rely on the side data
1345 * size to recognize the end. 8 byte id (as found in BlockAddId) followed
1348 AV_PKT_DATA_MATROSKA_BLOCKADDITIONAL,
1351 * The optional first identifier line of a WebVTT cue.
1353 AV_PKT_DATA_WEBVTT_IDENTIFIER,
1356 * The optional settings (rendering instructions) that immediately
1357 * follow the timestamp specifier of a WebVTT cue.
1359 AV_PKT_DATA_WEBVTT_SETTINGS,
1362 * A list of zero terminated key/value strings. There is no end marker for
1363 * the list, so it is required to rely on the side data size to stop. This
1364 * side data includes updated metadata which appeared in the stream.
1366 AV_PKT_DATA_METADATA_UPDATE,
1369 #define AV_PKT_DATA_QUALITY_FACTOR AV_PKT_DATA_QUALITY_STATS //DEPRECATED
1371 typedef struct AVPacketSideData {
1374 enum AVPacketSideDataType type;
1378 * This structure stores compressed data. It is typically exported by demuxers
1379 * and then passed as input to decoders, or received as output from encoders and
1380 * then passed to muxers.
1382 * For video, it should typically contain one compressed frame. For audio it may
1383 * contain several compressed frames.
1385 * AVPacket is one of the few structs in FFmpeg, whose size is a part of public
1386 * ABI. Thus it may be allocated on stack and no new fields can be added to it
1387 * without libavcodec and libavformat major bump.
1389 * The semantics of data ownership depends on the buf or destruct (deprecated)
1390 * fields. If either is set, the packet data is dynamically allocated and is
1391 * valid indefinitely until av_free_packet() is called (which in turn calls
1392 * av_buffer_unref()/the destruct callback to free the data). If neither is set,
1393 * the packet data is typically backed by some static buffer somewhere and is
1394 * only valid for a limited time (e.g. until the next read call when demuxing).
1396 * The side data is always allocated with av_malloc() and is freed in
1399 typedef struct AVPacket {
1401 * A reference to the reference-counted buffer where the packet data is
1403 * May be NULL, then the packet data is not reference-counted.
1407 * Presentation timestamp in AVStream->time_base units; the time at which
1408 * the decompressed packet will be presented to the user.
1409 * Can be AV_NOPTS_VALUE if it is not stored in the file.
1410 * pts MUST be larger or equal to dts as presentation cannot happen before
1411 * decompression, unless one wants to view hex dumps. Some formats misuse
1412 * the terms dts and pts/cts to mean something different. Such timestamps
1413 * must be converted to true pts/dts before they are stored in AVPacket.
1417 * Decompression timestamp in AVStream->time_base units; the time at which
1418 * the packet is decompressed.
1419 * Can be AV_NOPTS_VALUE if it is not stored in the file.
1426 * A combination of AV_PKT_FLAG values
1430 * Additional packet data that can be provided by the container.
1431 * Packet can contain several types of side information.
1433 AVPacketSideData *side_data;
1434 int side_data_elems;
1437 * Duration of this packet in AVStream->time_base units, 0 if unknown.
1438 * Equals next_pts - this_pts in presentation order.
1441 #if FF_API_DESTRUCT_PACKET
1442 attribute_deprecated
1443 void (*destruct)(struct AVPacket *);
1444 attribute_deprecated
1447 int64_t pos; ///< byte position in stream, -1 if unknown
1450 * Time difference in AVStream->time_base units from the pts of this
1451 * packet to the point at which the output from the decoder has converged
1452 * independent from the availability of previous frames. That is, the
1453 * frames are virtually identical no matter if decoding started from
1454 * the very first frame or from this keyframe.
1455 * Is AV_NOPTS_VALUE if unknown.
1456 * This field is not the display duration of the current packet.
1457 * This field has no meaning if the packet does not have AV_PKT_FLAG_KEY
1460 * The purpose of this field is to allow seeking in streams that have no
1461 * keyframes in the conventional sense. It corresponds to the
1462 * recovery point SEI in H.264 and match_time_delta in NUT. It is also
1463 * essential for some types of subtitle streams to ensure that all
1464 * subtitles are correctly displayed after seeking.
1466 int64_t convergence_duration;
1468 #define AV_PKT_FLAG_KEY 0x0001 ///< The packet contains a keyframe
1469 #define AV_PKT_FLAG_CORRUPT 0x0002 ///< The packet content is corrupted
1471 enum AVSideDataParamChangeFlags {
1472 AV_SIDE_DATA_PARAM_CHANGE_CHANNEL_COUNT = 0x0001,
1473 AV_SIDE_DATA_PARAM_CHANGE_CHANNEL_LAYOUT = 0x0002,
1474 AV_SIDE_DATA_PARAM_CHANGE_SAMPLE_RATE = 0x0004,
1475 AV_SIDE_DATA_PARAM_CHANGE_DIMENSIONS = 0x0008,
1481 struct AVCodecInternal;
1485 AV_FIELD_PROGRESSIVE,
1486 AV_FIELD_TT, //< Top coded_first, top displayed first
1487 AV_FIELD_BB, //< Bottom coded first, bottom displayed first
1488 AV_FIELD_TB, //< Top coded first, bottom displayed first
1489 AV_FIELD_BT, //< Bottom coded first, top displayed first
1493 * main external API structure.
1494 * New fields can be added to the end with minor version bumps.
1495 * Removal, reordering and changes to existing fields require a major
1497 * Please use AVOptions (av_opt* / av_set/get*()) to access these fields from user
1499 * sizeof(AVCodecContext) must not be used outside libav*.
1501 typedef struct AVCodecContext {
1503 * information on struct for av_log
1504 * - set by avcodec_alloc_context3
1506 const AVClass *av_class;
1507 int log_level_offset;
1509 enum AVMediaType codec_type; /* see AVMEDIA_TYPE_xxx */
1510 const struct AVCodec *codec;
1511 #if FF_API_CODEC_NAME
1513 * @deprecated this field is not used for anything in libavcodec
1515 attribute_deprecated
1516 char codec_name[32];
1518 enum AVCodecID codec_id; /* see AV_CODEC_ID_xxx */
1521 * fourcc (LSB first, so "ABCD" -> ('D'<<24) + ('C'<<16) + ('B'<<8) + 'A').
1522 * This is used to work around some encoder bugs.
1523 * A demuxer should set this to what is stored in the field used to identify the codec.
1524 * If there are multiple such fields in a container then the demuxer should choose the one
1525 * which maximizes the information about the used codec.
1526 * If the codec tag field in a container is larger than 32 bits then the demuxer should
1527 * remap the longer ID to 32 bits with a table or other structure. Alternatively a new
1528 * extra_codec_tag + size could be added but for this a clear advantage must be demonstrated
1530 * - encoding: Set by user, if not then the default based on codec_id will be used.
1531 * - decoding: Set by user, will be converted to uppercase by libavcodec during init.
1533 unsigned int codec_tag;
1535 #if FF_API_STREAM_CODEC_TAG
1537 * @deprecated this field is unused
1539 attribute_deprecated
1540 unsigned int stream_codec_tag;
1546 * Private context used for internal data.
1548 * Unlike priv_data, this is not codec-specific. It is used in general
1549 * libavcodec functions.
1551 struct AVCodecInternal *internal;
1554 * Private data of the user, can be used to carry app specific stuff.
1555 * - encoding: Set by user.
1556 * - decoding: Set by user.
1561 * the average bitrate
1562 * - encoding: Set by user; unused for constant quantizer encoding.
1563 * - decoding: Set by user, may be overwritten by libavcodec
1564 * if this info is available in the stream
1569 * number of bits the bitstream is allowed to diverge from the reference.
1570 * the reference can be CBR (for CBR pass1) or VBR (for pass2)
1571 * - encoding: Set by user; unused for constant quantizer encoding.
1572 * - decoding: unused
1574 int bit_rate_tolerance;
1577 * Global quality for codecs which cannot change it per frame.
1578 * This should be proportional to MPEG-1/2/4 qscale.
1579 * - encoding: Set by user.
1580 * - decoding: unused
1585 * - encoding: Set by user.
1586 * - decoding: unused
1588 int compression_level;
1589 #define FF_COMPRESSION_DEFAULT -1
1593 * - encoding: Set by user.
1594 * - decoding: Set by user.
1600 * - encoding: Set by user.
1601 * - decoding: Set by user.
1606 * some codecs need / can use extradata like Huffman tables.
1607 * mjpeg: Huffman tables
1608 * rv10: additional flags
1609 * mpeg4: global headers (they can be in the bitstream or here)
1610 * The allocated memory should be AV_INPUT_BUFFER_PADDING_SIZE bytes larger
1611 * than extradata_size to avoid problems if it is read with the bitstream reader.
1612 * The bytewise contents of extradata must not depend on the architecture or CPU endianness.
1613 * - encoding: Set/allocated/freed by libavcodec.
1614 * - decoding: Set/allocated/freed by user.
1620 * This is the fundamental unit of time (in seconds) in terms
1621 * of which frame timestamps are represented. For fixed-fps content,
1622 * timebase should be 1/framerate and timestamp increments should be
1624 * This often, but not always is the inverse of the frame rate or field rate
1626 * - encoding: MUST be set by user.
1627 * - decoding: the use of this field for decoding is deprecated.
1628 * Use framerate instead.
1630 AVRational time_base;
1633 * For some codecs, the time base is closer to the field rate than the frame rate.
1634 * Most notably, H.264 and MPEG-2 specify time_base as half of frame duration
1635 * if no telecine is used ...
1637 * Set to time_base ticks per frame. Default 1, e.g., H.264/MPEG-2 set it to 2.
1639 int ticks_per_frame;
1644 * Encoding: Number of frames delay there will be from the encoder input to
1645 * the decoder output. (we assume the decoder matches the spec)
1646 * Decoding: Number of frames delay in addition to what a standard decoder
1647 * as specified in the spec would produce.
1650 * Number of frames the decoded output will be delayed relative to the
1654 * For encoding, this field is unused (see initial_padding).
1656 * For decoding, this is the number of samples the decoder needs to
1657 * output before the decoder's output is valid. When seeking, you should
1658 * start decoding this many samples prior to your desired seek point.
1660 * - encoding: Set by libavcodec.
1661 * - decoding: Set by libavcodec.
1668 * picture width / height.
1670 * @note Those fields may not match the values of the last
1671 * AVFrame outputted by avcodec_decode_video2 due frame
1674 * - encoding: MUST be set by user.
1675 * - decoding: May be set by the user before opening the decoder if known e.g.
1676 * from the container. Some decoders will require the dimensions
1677 * to be set by the caller. During decoding, the decoder may
1678 * overwrite those values as required while parsing the data.
1683 * Bitstream width / height, may be different from width/height e.g. when
1684 * the decoded frame is cropped before being output or lowres is enabled.
1686 * @note Those field may not match the value of the last
1687 * AVFrame outputted by avcodec_decode_video2 due frame
1690 * - encoding: unused
1691 * - decoding: May be set by the user before opening the decoder if known
1692 * e.g. from the container. During decoding, the decoder may
1693 * overwrite those values as required while parsing the data.
1695 int coded_width, coded_height;
1697 #if FF_API_ASPECT_EXTENDED
1698 #define FF_ASPECT_EXTENDED 15
1702 * the number of pictures in a group of pictures, or 0 for intra_only
1703 * - encoding: Set by user.
1704 * - decoding: unused
1709 * Pixel format, see AV_PIX_FMT_xxx.
1710 * May be set by the demuxer if known from headers.
1711 * May be overridden by the decoder if it knows better.
1713 * @note This field may not match the value of the last
1714 * AVFrame outputted by avcodec_decode_video2 due frame
1717 * - encoding: Set by user.
1718 * - decoding: Set by user if known, overridden by libavcodec while
1721 enum AVPixelFormat pix_fmt;
1723 #if FF_API_MOTION_EST
1725 * This option does nothing
1726 * @deprecated use codec private options instead
1728 attribute_deprecated int me_method;
1732 * If non NULL, 'draw_horiz_band' is called by the libavcodec
1733 * decoder to draw a horizontal band. It improves cache usage. Not
1734 * all codecs can do that. You must check the codec capabilities
1736 * When multithreading is used, it may be called from multiple threads
1737 * at the same time; threads might draw different parts of the same AVFrame,
1738 * or multiple AVFrames, and there is no guarantee that slices will be drawn
1740 * The function is also used by hardware acceleration APIs.
1741 * It is called at least once during frame decoding to pass
1742 * the data needed for hardware render.
1743 * In that mode instead of pixel data, AVFrame points to
1744 * a structure specific to the acceleration API. The application
1745 * reads the structure and can change some fields to indicate progress
1747 * - encoding: unused
1748 * - decoding: Set by user.
1749 * @param height the height of the slice
1750 * @param y the y position of the slice
1751 * @param type 1->top field, 2->bottom field, 3->frame
1752 * @param offset offset into the AVFrame.data from which the slice should be read
1754 void (*draw_horiz_band)(struct AVCodecContext *s,
1755 const AVFrame *src, int offset[AV_NUM_DATA_POINTERS],
1756 int y, int type, int height);
1759 * callback to negotiate the pixelFormat
1760 * @param fmt is the list of formats which are supported by the codec,
1761 * it is terminated by -1 as 0 is a valid format, the formats are ordered by quality.
1762 * The first is always the native one.
1763 * @note The callback may be called again immediately if initialization for
1764 * the selected (hardware-accelerated) pixel format failed.
1765 * @warning Behavior is undefined if the callback returns a value not
1766 * in the fmt list of formats.
1767 * @return the chosen format
1768 * - encoding: unused
1769 * - decoding: Set by user, if not set the native format will be chosen.
1771 enum AVPixelFormat (*get_format)(struct AVCodecContext *s, const enum AVPixelFormat * fmt);
1774 * maximum number of B-frames between non-B-frames
1775 * Note: The output will be delayed by max_b_frames+1 relative to the input.
1776 * - encoding: Set by user.
1777 * - decoding: unused
1782 * qscale factor between IP and B-frames
1783 * If > 0 then the last P-frame quantizer will be used (q= lastp_q*factor+offset).
1784 * If < 0 then normal ratecontrol will be done (q= -normal_q*factor+offset).
1785 * - encoding: Set by user.
1786 * - decoding: unused
1788 float b_quant_factor;
1790 #if FF_API_RC_STRATEGY
1791 /** @deprecated use codec private option instead */
1792 attribute_deprecated int rc_strategy;
1793 #define FF_RC_STRATEGY_XVID 1
1796 int b_frame_strategy;
1799 * qscale offset between IP and B-frames
1800 * - encoding: Set by user.
1801 * - decoding: unused
1803 float b_quant_offset;
1806 * Size of the frame reordering buffer in the decoder.
1807 * For MPEG-2 it is 1 IPB or 0 low delay IP.
1808 * - encoding: Set by libavcodec.
1809 * - decoding: Set by libavcodec.
1814 * 0-> h263 quant 1-> mpeg quant
1815 * - encoding: Set by user.
1816 * - decoding: unused
1821 * qscale factor between P and I-frames
1822 * If > 0 then the last p frame quantizer will be used (q= lastp_q*factor+offset).
1823 * If < 0 then normal ratecontrol will be done (q= -normal_q*factor+offset).
1824 * - encoding: Set by user.
1825 * - decoding: unused
1827 float i_quant_factor;
1830 * qscale offset between P and I-frames
1831 * - encoding: Set by user.
1832 * - decoding: unused
1834 float i_quant_offset;
1837 * luminance masking (0-> disabled)
1838 * - encoding: Set by user.
1839 * - decoding: unused
1844 * temporary complexity masking (0-> disabled)
1845 * - encoding: Set by user.
1846 * - decoding: unused
1848 float temporal_cplx_masking;
1851 * spatial complexity masking (0-> disabled)
1852 * - encoding: Set by user.
1853 * - decoding: unused
1855 float spatial_cplx_masking;
1858 * p block masking (0-> disabled)
1859 * - encoding: Set by user.
1860 * - decoding: unused
1865 * darkness masking (0-> disabled)
1866 * - encoding: Set by user.
1867 * - decoding: unused
1873 * - encoding: Set by libavcodec.
1874 * - decoding: Set by user (or 0).
1878 * prediction method (needed for huffyuv)
1879 * - encoding: Set by user.
1880 * - decoding: unused
1882 int prediction_method;
1883 #define FF_PRED_LEFT 0
1884 #define FF_PRED_PLANE 1
1885 #define FF_PRED_MEDIAN 2
1888 * slice offsets in the frame in bytes
1889 * - encoding: Set/allocated by libavcodec.
1890 * - decoding: Set/allocated by user (or NULL).
1895 * sample aspect ratio (0 if unknown)
1896 * That is the width of a pixel divided by the height of the pixel.
1897 * Numerator and denominator must be relatively prime and smaller than 256 for some video standards.
1898 * - encoding: Set by user.
1899 * - decoding: Set by libavcodec.
1901 AVRational sample_aspect_ratio;
1904 * motion estimation comparison function
1905 * - encoding: Set by user.
1906 * - decoding: unused
1910 * subpixel motion estimation comparison function
1911 * - encoding: Set by user.
1912 * - decoding: unused
1916 * macroblock comparison function (not supported yet)
1917 * - encoding: Set by user.
1918 * - decoding: unused
1922 * interlaced DCT comparison function
1923 * - encoding: Set by user.
1924 * - decoding: unused
1927 #define FF_CMP_SAD 0
1928 #define FF_CMP_SSE 1
1929 #define FF_CMP_SATD 2
1930 #define FF_CMP_DCT 3
1931 #define FF_CMP_PSNR 4
1932 #define FF_CMP_BIT 5
1934 #define FF_CMP_ZERO 7
1935 #define FF_CMP_VSAD 8
1936 #define FF_CMP_VSSE 9
1937 #define FF_CMP_NSSE 10
1938 #define FF_CMP_W53 11
1939 #define FF_CMP_W97 12
1940 #define FF_CMP_DCTMAX 13
1941 #define FF_CMP_DCT264 14
1942 #define FF_CMP_CHROMA 256
1945 * ME diamond size & shape
1946 * - encoding: Set by user.
1947 * - decoding: unused
1952 * amount of previous MV predictors (2a+1 x 2a+1 square)
1953 * - encoding: Set by user.
1954 * - decoding: unused
1956 int last_predictor_count;
1959 * prepass for motion estimation
1960 * - encoding: Set by user.
1961 * - decoding: unused
1966 * motion estimation prepass comparison function
1967 * - encoding: Set by user.
1968 * - decoding: unused
1973 * ME prepass diamond size & shape
1974 * - encoding: Set by user.
1975 * - decoding: unused
1981 * - encoding: Set by user.
1982 * - decoding: unused
1984 int me_subpel_quality;
1988 * DTG active format information (additional aspect ratio
1989 * information only used in DVB MPEG-2 transport streams)
1992 * - encoding: unused
1993 * - decoding: Set by decoder.
1994 * @deprecated Deprecated in favor of AVSideData
1996 attribute_deprecated int dtg_active_format;
1997 #define FF_DTG_AFD_SAME 8
1998 #define FF_DTG_AFD_4_3 9
1999 #define FF_DTG_AFD_16_9 10
2000 #define FF_DTG_AFD_14_9 11
2001 #define FF_DTG_AFD_4_3_SP_14_9 13
2002 #define FF_DTG_AFD_16_9_SP_14_9 14
2003 #define FF_DTG_AFD_SP_4_3 15
2004 #endif /* FF_API_AFD */
2007 * maximum motion estimation search range in subpel units
2008 * If 0 then no limit.
2010 * - encoding: Set by user.
2011 * - decoding: unused
2015 #if FF_API_QUANT_BIAS
2017 * @deprecated use encoder private option instead
2019 attribute_deprecated int intra_quant_bias;
2020 #define FF_DEFAULT_QUANT_BIAS 999999
2023 * @deprecated use encoder private option instead
2025 attribute_deprecated int inter_quant_bias;
2030 * - encoding: unused
2031 * - decoding: Set by user.
2034 #define SLICE_FLAG_CODED_ORDER 0x0001 ///< draw_horiz_band() is called in coded order instead of display
2035 #define SLICE_FLAG_ALLOW_FIELD 0x0002 ///< allow draw_horiz_band() with field slices (MPEG2 field pics)
2036 #define SLICE_FLAG_ALLOW_PLANE 0x0004 ///< allow draw_horiz_band() with 1 component at a time (SVQ1)
2040 * XVideo Motion Acceleration
2041 * - encoding: forbidden
2042 * - decoding: set by decoder
2043 * @deprecated XvMC doesn't need it anymore.
2045 attribute_deprecated int xvmc_acceleration;
2046 #endif /* FF_API_XVMC */
2049 * macroblock decision mode
2050 * - encoding: Set by user.
2051 * - decoding: unused
2054 #define FF_MB_DECISION_SIMPLE 0 ///< uses mb_cmp
2055 #define FF_MB_DECISION_BITS 1 ///< chooses the one which needs the fewest bits
2056 #define FF_MB_DECISION_RD 2 ///< rate distortion
2059 * custom intra quantization matrix
2060 * - encoding: Set by user, can be NULL.
2061 * - decoding: Set by libavcodec.
2063 uint16_t *intra_matrix;
2066 * custom inter quantization matrix
2067 * - encoding: Set by user, can be NULL.
2068 * - decoding: Set by libavcodec.
2070 uint16_t *inter_matrix;
2073 * scene change detection threshold
2074 * 0 is default, larger means fewer detected scene changes.
2075 * - encoding: Set by user.
2076 * - decoding: unused
2078 int scenechange_threshold;
2081 * noise reduction strength
2082 * - encoding: Set by user.
2083 * - decoding: unused
2085 int noise_reduction;
2089 * @deprecated this field is unused
2091 attribute_deprecated
2095 * @deprecated this field is unused
2097 attribute_deprecated
2102 * precision of the intra DC coefficient - 8
2103 * - encoding: Set by user.
2104 * - decoding: Set by libavcodec
2106 int intra_dc_precision;
2109 * Number of macroblock rows at the top which are skipped.
2110 * - encoding: unused
2111 * - decoding: Set by user.
2116 * Number of macroblock rows at the bottom which are skipped.
2117 * - encoding: unused
2118 * - decoding: Set by user.
2124 * @deprecated use encoder private options instead
2126 attribute_deprecated
2127 float border_masking;
2131 * minimum MB lagrange multipler
2132 * - encoding: Set by user.
2133 * - decoding: unused
2138 * maximum MB lagrange multipler
2139 * - encoding: Set by user.
2140 * - decoding: unused
2146 * - encoding: Set by user.
2147 * - decoding: unused
2149 int me_penalty_compensation;
2153 * - encoding: Set by user.
2154 * - decoding: unused
2160 * - encoding: Set by user.
2161 * - decoding: unused
2167 * - encoding: Set by user.
2168 * - decoding: unused
2173 * number of reference frames
2174 * - encoding: Set by user.
2175 * - decoding: Set by lavc.
2180 * chroma qp offset from luma
2181 * - encoding: Set by user.
2182 * - decoding: unused
2186 #if FF_API_UNUSED_MEMBERS
2188 * Multiplied by qscale for each frame and added to scene_change_score.
2189 * - encoding: Set by user.
2190 * - decoding: unused
2192 attribute_deprecated int scenechange_factor;
2197 * Note: Value depends upon the compare function used for fullpel ME.
2198 * - encoding: Set by user.
2199 * - decoding: unused
2204 * Adjust sensitivity of b_frame_strategy 1.
2205 * - encoding: Set by user.
2206 * - decoding: unused
2211 * Chromaticity coordinates of the source primaries.
2212 * - encoding: Set by user
2213 * - decoding: Set by libavcodec
2215 enum AVColorPrimaries color_primaries;
2218 * Color Transfer Characteristic.
2219 * - encoding: Set by user
2220 * - decoding: Set by libavcodec
2222 enum AVColorTransferCharacteristic color_trc;
2225 * YUV colorspace type.
2226 * - encoding: Set by user
2227 * - decoding: Set by libavcodec
2229 enum AVColorSpace colorspace;
2232 * MPEG vs JPEG YUV range.
2233 * - encoding: Set by user
2234 * - decoding: Set by libavcodec
2236 enum AVColorRange color_range;
2239 * This defines the location of chroma samples.
2240 * - encoding: Set by user
2241 * - decoding: Set by libavcodec
2243 enum AVChromaLocation chroma_sample_location;
2247 * Indicates number of picture subdivisions. Used for parallelized
2249 * - encoding: Set by user
2250 * - decoding: unused
2255 * - encoding: set by libavcodec
2256 * - decoding: Set by user.
2258 enum AVFieldOrder field_order;
2261 int sample_rate; ///< samples per second
2262 int channels; ///< number of audio channels
2265 * audio sample format
2266 * - encoding: Set by user.
2267 * - decoding: Set by libavcodec.
2269 enum AVSampleFormat sample_fmt; ///< sample format
2271 /* The following data should not be initialized. */
2273 * Number of samples per channel in an audio frame.
2275 * - encoding: set by libavcodec in avcodec_open2(). Each submitted frame
2276 * except the last must contain exactly frame_size samples per channel.
2277 * May be 0 when the codec has AV_CODEC_CAP_VARIABLE_FRAME_SIZE set, then the
2278 * frame size is not restricted.
2279 * - decoding: may be set by some decoders to indicate constant frame size
2284 * Frame counter, set by libavcodec.
2286 * - decoding: total number of frames returned from the decoder so far.
2287 * - encoding: total number of frames passed to the encoder so far.
2289 * @note the counter is not incremented if encoding/decoding resulted in
2295 * number of bytes per packet if constant and known or 0
2296 * Used by some WAV based audio codecs.
2301 * Audio cutoff bandwidth (0 means "automatic")
2302 * - encoding: Set by user.
2303 * - decoding: unused
2307 #if FF_API_REQUEST_CHANNELS
2309 * Decoder should decode to this many channels if it can (0 for default)
2310 * - encoding: unused
2311 * - decoding: Set by user.
2312 * @deprecated Deprecated in favor of request_channel_layout.
2314 attribute_deprecated int request_channels;
2318 * Audio channel layout.
2319 * - encoding: set by user.
2320 * - decoding: set by user, may be overwritten by libavcodec.
2322 uint64_t channel_layout;
2325 * Request decoder to use this channel layout if it can (0 for default)
2326 * - encoding: unused
2327 * - decoding: Set by user.
2329 uint64_t request_channel_layout;
2332 * Type of service that the audio stream conveys.
2333 * - encoding: Set by user.
2334 * - decoding: Set by libavcodec.
2336 enum AVAudioServiceType audio_service_type;
2339 * desired sample format
2340 * - encoding: Not used.
2341 * - decoding: Set by user.
2342 * Decoder will decode to this format if it can.
2344 enum AVSampleFormat request_sample_fmt;
2346 #if FF_API_GET_BUFFER
2348 * Called at the beginning of each frame to get a buffer for it.
2350 * The function will set AVFrame.data[], AVFrame.linesize[].
2351 * AVFrame.extended_data[] must also be set, but it should be the same as
2352 * AVFrame.data[] except for planar audio with more channels than can fit
2353 * in AVFrame.data[]. In that case, AVFrame.data[] shall still contain as
2354 * many data pointers as it can hold.
2356 * if CODEC_CAP_DR1 is not set then get_buffer() must call
2357 * avcodec_default_get_buffer() instead of providing buffers allocated by
2360 * AVFrame.data[] should be 32- or 16-byte-aligned unless the CPU doesn't
2361 * need it. avcodec_default_get_buffer() aligns the output buffer properly,
2362 * but if get_buffer() is overridden then alignment considerations should
2363 * be taken into account.
2365 * @see avcodec_default_get_buffer()
2369 * If pic.reference is set then the frame will be read later by libavcodec.
2370 * avcodec_align_dimensions2() should be used to find the required width and
2371 * height, as they normally need to be rounded up to the next multiple of 16.
2373 * If frame multithreading is used and thread_safe_callbacks is set,
2374 * it may be called from a different thread, but not from more than one at
2375 * once. Does not need to be reentrant.
2377 * @see release_buffer(), reget_buffer()
2378 * @see avcodec_align_dimensions2()
2382 * Decoders request a buffer of a particular size by setting
2383 * AVFrame.nb_samples prior to calling get_buffer(). The decoder may,
2384 * however, utilize only part of the buffer by setting AVFrame.nb_samples
2385 * to a smaller value in the output frame.
2387 * Decoders cannot use the buffer after returning from
2388 * avcodec_decode_audio4(), so they will not call release_buffer(), as it
2389 * is assumed to be released immediately upon return. In some rare cases,
2390 * a decoder may need to call get_buffer() more than once in a single
2391 * call to avcodec_decode_audio4(). In that case, when get_buffer() is
2392 * called again after it has already been called once, the previously
2393 * acquired buffer is assumed to be released at that time and may not be
2394 * reused by the decoder.
2396 * As a convenience, av_samples_get_buffer_size() and
2397 * av_samples_fill_arrays() in libavutil may be used by custom get_buffer()
2398 * functions to find the required data size and to fill data pointers and
2399 * linesize. In AVFrame.linesize, only linesize[0] may be set for audio
2400 * since all planes must be the same size.
2402 * @see av_samples_get_buffer_size(), av_samples_fill_arrays()
2404 * - encoding: unused
2405 * - decoding: Set by libavcodec, user can override.
2407 * @deprecated use get_buffer2()
2409 attribute_deprecated
2410 int (*get_buffer)(struct AVCodecContext *c, AVFrame *pic);
2413 * Called to release buffers which were allocated with get_buffer.
2414 * A released buffer can be reused in get_buffer().
2415 * pic.data[*] must be set to NULL.
2416 * May be called from a different thread if frame multithreading is used,
2417 * but not by more than one thread at once, so does not need to be reentrant.
2418 * - encoding: unused
2419 * - decoding: Set by libavcodec, user can override.
2421 * @deprecated custom freeing callbacks should be set from get_buffer2()
2423 attribute_deprecated
2424 void (*release_buffer)(struct AVCodecContext *c, AVFrame *pic);
2427 * Called at the beginning of a frame to get cr buffer for it.
2428 * Buffer type (size, hints) must be the same. libavcodec won't check it.
2429 * libavcodec will pass previous buffer in pic, function should return
2430 * same buffer or new buffer with old frame "painted" into it.
2431 * If pic.data[0] == NULL must behave like get_buffer().
2432 * if CODEC_CAP_DR1 is not set then reget_buffer() must call
2433 * avcodec_default_reget_buffer() instead of providing buffers allocated by
2435 * - encoding: unused
2436 * - decoding: Set by libavcodec, user can override.
2438 attribute_deprecated
2439 int (*reget_buffer)(struct AVCodecContext *c, AVFrame *pic);
2443 * This callback is called at the beginning of each frame to get data
2444 * buffer(s) for it. There may be one contiguous buffer for all the data or
2445 * there may be a buffer per each data plane or anything in between. What
2446 * this means is, you may set however many entries in buf[] you feel necessary.
2447 * Each buffer must be reference-counted using the AVBuffer API (see description
2450 * The following fields will be set in the frame before this callback is
2453 * - width, height (video only)
2454 * - sample_rate, channel_layout, nb_samples (audio only)
2455 * Their values may differ from the corresponding values in
2456 * AVCodecContext. This callback must use the frame values, not the codec
2457 * context values, to calculate the required buffer size.
2459 * This callback must fill the following fields in the frame:
2463 * * if the data is planar audio with more than 8 channels, then this
2464 * callback must allocate and fill extended_data to contain all pointers
2465 * to all data planes. data[] must hold as many pointers as it can.
2466 * extended_data must be allocated with av_malloc() and will be freed in
2468 * * otherwise exended_data must point to data
2469 * - buf[] must contain one or more pointers to AVBufferRef structures. Each of
2470 * the frame's data and extended_data pointers must be contained in these. That
2471 * is, one AVBufferRef for each allocated chunk of memory, not necessarily one
2472 * AVBufferRef per data[] entry. See: av_buffer_create(), av_buffer_alloc(),
2473 * and av_buffer_ref().
2474 * - extended_buf and nb_extended_buf must be allocated with av_malloc() by
2475 * this callback and filled with the extra buffers if there are more
2476 * buffers than buf[] can hold. extended_buf will be freed in
2479 * If AV_CODEC_CAP_DR1 is not set then get_buffer2() must call
2480 * avcodec_default_get_buffer2() instead of providing buffers allocated by
2483 * Each data plane must be aligned to the maximum required by the target
2486 * @see avcodec_default_get_buffer2()
2490 * If AV_GET_BUFFER_FLAG_REF is set in flags then the frame may be reused
2491 * (read and/or written to if it is writable) later by libavcodec.
2493 * avcodec_align_dimensions2() should be used to find the required width and
2494 * height, as they normally need to be rounded up to the next multiple of 16.
2496 * Some decoders do not support linesizes changing between frames.
2498 * If frame multithreading is used and thread_safe_callbacks is set,
2499 * this callback may be called from a different thread, but not from more
2500 * than one at once. Does not need to be reentrant.
2502 * @see avcodec_align_dimensions2()
2506 * Decoders request a buffer of a particular size by setting
2507 * AVFrame.nb_samples prior to calling get_buffer2(). The decoder may,
2508 * however, utilize only part of the buffer by setting AVFrame.nb_samples
2509 * to a smaller value in the output frame.
2511 * As a convenience, av_samples_get_buffer_size() and
2512 * av_samples_fill_arrays() in libavutil may be used by custom get_buffer2()
2513 * functions to find the required data size and to fill data pointers and
2514 * linesize. In AVFrame.linesize, only linesize[0] may be set for audio
2515 * since all planes must be the same size.
2517 * @see av_samples_get_buffer_size(), av_samples_fill_arrays()
2519 * - encoding: unused
2520 * - decoding: Set by libavcodec, user can override.
2522 int (*get_buffer2)(struct AVCodecContext *s, AVFrame *frame, int flags);
2525 * If non-zero, the decoded audio and video frames returned from
2526 * avcodec_decode_video2() and avcodec_decode_audio4() are reference-counted
2527 * and are valid indefinitely. The caller must free them with
2528 * av_frame_unref() when they are not needed anymore.
2529 * Otherwise, the decoded frames must not be freed by the caller and are
2530 * only valid until the next decode call.
2532 * - encoding: unused
2533 * - decoding: set by the caller before avcodec_open2().
2535 int refcounted_frames;
2537 /* - encoding parameters */
2538 float qcompress; ///< amount of qscale change between easy & hard scenes (0.0-1.0)
2539 float qblur; ///< amount of qscale smoothing over time (0.0-1.0)
2543 * - encoding: Set by user.
2544 * - decoding: unused
2550 * - encoding: Set by user.
2551 * - decoding: unused
2556 * maximum quantizer difference between frames
2557 * - encoding: Set by user.
2558 * - decoding: unused
2564 * @deprecated use encoder private options instead
2566 attribute_deprecated
2569 attribute_deprecated
2571 attribute_deprecated
2576 * decoder bitstream buffer size
2577 * - encoding: Set by user.
2578 * - decoding: unused
2583 * ratecontrol override, see RcOverride
2584 * - encoding: Allocated/set/freed by user.
2585 * - decoding: unused
2587 int rc_override_count;
2588 RcOverride *rc_override;
2592 * @deprecated use encoder private options instead
2594 attribute_deprecated
2600 * - encoding: Set by user.
2601 * - decoding: Set by user, may be overwritten by libavcodec.
2607 * - encoding: Set by user.
2608 * - decoding: unused
2614 * @deprecated use encoder private options instead
2616 attribute_deprecated
2617 float rc_buffer_aggressivity;
2619 attribute_deprecated
2620 float rc_initial_cplx;
2624 * Ratecontrol attempt to use, at maximum, <value> of what can be used without an underflow.
2625 * - encoding: Set by user.
2626 * - decoding: unused.
2628 float rc_max_available_vbv_use;
2631 * Ratecontrol attempt to use, at least, <value> times the amount needed to prevent a vbv overflow.
2632 * - encoding: Set by user.
2633 * - decoding: unused.
2635 float rc_min_vbv_overflow_use;
2638 * Number of bits which should be loaded into the rc buffer before decoding starts.
2639 * - encoding: Set by user.
2640 * - decoding: unused
2642 int rc_initial_buffer_occupancy;
2644 #define FF_CODER_TYPE_VLC 0
2645 #define FF_CODER_TYPE_AC 1
2646 #define FF_CODER_TYPE_RAW 2
2647 #define FF_CODER_TYPE_RLE 3
2648 #if FF_API_UNUSED_MEMBERS
2649 #define FF_CODER_TYPE_DEFLATE 4
2650 #endif /* FF_API_UNUSED_MEMBERS */
2653 * - encoding: Set by user.
2654 * - decoding: unused
2660 * - encoding: Set by user.
2661 * - decoding: unused
2667 * @deprecated use encoder private options instead
2669 attribute_deprecated
2673 * @deprecated use encoder private options instead
2675 attribute_deprecated
2680 * frame skip threshold
2681 * - encoding: Set by user.
2682 * - decoding: unused
2684 int frame_skip_threshold;
2688 * - encoding: Set by user.
2689 * - decoding: unused
2691 int frame_skip_factor;
2694 * frame skip exponent
2695 * - encoding: Set by user.
2696 * - decoding: unused
2701 * frame skip comparison function
2702 * - encoding: Set by user.
2703 * - decoding: unused
2708 * trellis RD quantization
2709 * - encoding: Set by user.
2710 * - decoding: unused
2715 * - encoding: Set by user.
2716 * - decoding: unused
2718 int min_prediction_order;
2721 * - encoding: Set by user.
2722 * - decoding: unused
2724 int max_prediction_order;
2727 * GOP timecode frame start number
2728 * - encoding: Set by user, in non drop frame format
2729 * - decoding: Set by libavcodec (timecode in the 25 bits format, -1 if unset)
2731 int64_t timecode_frame_start;
2733 /* The RTP callback: This function is called */
2734 /* every time the encoder has a packet to send. */
2735 /* It depends on the encoder if the data starts */
2736 /* with a Start Code (it should). H.263 does. */
2737 /* mb_nb contains the number of macroblocks */
2738 /* encoded in the RTP payload. */
2739 void (*rtp_callback)(struct AVCodecContext *avctx, void *data, int size, int mb_nb);
2741 int rtp_payload_size; /* The size of the RTP payload: the coder will */
2742 /* do its best to deliver a chunk with size */
2743 /* below rtp_payload_size, the chunk will start */
2744 /* with a start code on some codecs like H.263. */
2745 /* This doesn't take account of any particular */
2746 /* headers inside the transmitted RTP payload. */
2748 /* statistics, used for 2-pass encoding */
2759 * number of bits used for the previously encoded frame
2760 * - encoding: Set by libavcodec.
2761 * - decoding: unused
2766 * pass1 encoding statistics output buffer
2767 * - encoding: Set by libavcodec.
2768 * - decoding: unused
2773 * pass2 encoding statistics input buffer
2774 * Concatenated stuff from stats_out of pass1 should be placed here.
2775 * - encoding: Allocated/set/freed by user.
2776 * - decoding: unused
2781 * Work around bugs in encoders which sometimes cannot be detected automatically.
2782 * - encoding: Set by user
2783 * - decoding: Set by user
2785 int workaround_bugs;
2786 #define FF_BUG_AUTODETECT 1 ///< autodetection
2787 #if FF_API_OLD_MSMPEG4
2788 #define FF_BUG_OLD_MSMPEG4 2
2790 #define FF_BUG_XVID_ILACE 4
2791 #define FF_BUG_UMP4 8
2792 #define FF_BUG_NO_PADDING 16
2793 #define FF_BUG_AMV 32
2795 #define FF_BUG_AC_VLC 0 ///< Will be removed, libavcodec can now handle these non-compliant files by default.
2797 #define FF_BUG_QPEL_CHROMA 64
2798 #define FF_BUG_STD_QPEL 128
2799 #define FF_BUG_QPEL_CHROMA2 256
2800 #define FF_BUG_DIRECT_BLOCKSIZE 512
2801 #define FF_BUG_EDGE 1024
2802 #define FF_BUG_HPEL_CHROMA 2048
2803 #define FF_BUG_DC_CLIP 4096
2804 #define FF_BUG_MS 8192 ///< Work around various bugs in Microsoft's broken decoders.
2805 #define FF_BUG_TRUNCATED 16384
2808 * strictly follow the standard (MPEG4, ...).
2809 * - encoding: Set by user.
2810 * - decoding: Set by user.
2811 * Setting this to STRICT or higher means the encoder and decoder will
2812 * generally do stupid things, whereas setting it to unofficial or lower
2813 * will mean the encoder might produce output that is not supported by all
2814 * spec-compliant decoders. Decoders don't differentiate between normal,
2815 * unofficial and experimental (that is, they always try to decode things
2816 * when they can) unless they are explicitly asked to behave stupidly
2817 * (=strictly conform to the specs)
2819 int strict_std_compliance;
2820 #define FF_COMPLIANCE_VERY_STRICT 2 ///< Strictly conform to an older more strict version of the spec or reference software.
2821 #define FF_COMPLIANCE_STRICT 1 ///< Strictly conform to all the things in the spec no matter what consequences.
2822 #define FF_COMPLIANCE_NORMAL 0
2823 #define FF_COMPLIANCE_UNOFFICIAL -1 ///< Allow unofficial extensions
2824 #define FF_COMPLIANCE_EXPERIMENTAL -2 ///< Allow nonstandardized experimental things.
2827 * error concealment flags
2828 * - encoding: unused
2829 * - decoding: Set by user.
2831 int error_concealment;
2832 #define FF_EC_GUESS_MVS 1
2833 #define FF_EC_DEBLOCK 2
2834 #define FF_EC_FAVOR_INTER 256
2838 * - encoding: Set by user.
2839 * - decoding: Set by user.
2842 #define FF_DEBUG_PICT_INFO 1
2843 #define FF_DEBUG_RC 2
2844 #define FF_DEBUG_BITSTREAM 4
2845 #define FF_DEBUG_MB_TYPE 8
2846 #define FF_DEBUG_QP 16
2849 * @deprecated this option does nothing
2851 #define FF_DEBUG_MV 32
2853 #define FF_DEBUG_DCT_COEFF 0x00000040
2854 #define FF_DEBUG_SKIP 0x00000080
2855 #define FF_DEBUG_STARTCODE 0x00000100
2856 #if FF_API_UNUSED_MEMBERS
2857 #define FF_DEBUG_PTS 0x00000200
2858 #endif /* FF_API_UNUSED_MEMBERS */
2859 #define FF_DEBUG_ER 0x00000400
2860 #define FF_DEBUG_MMCO 0x00000800
2861 #define FF_DEBUG_BUGS 0x00001000
2863 #define FF_DEBUG_VIS_QP 0x00002000 ///< only access through AVOptions from outside libavcodec
2864 #define FF_DEBUG_VIS_MB_TYPE 0x00004000 ///< only access through AVOptions from outside libavcodec
2866 #define FF_DEBUG_BUFFERS 0x00008000
2867 #define FF_DEBUG_THREADS 0x00010000
2868 #define FF_DEBUG_GREEN_MD 0x00800000
2869 #define FF_DEBUG_NOMC 0x01000000
2874 * Code outside libavcodec should access this field using AVOptions
2875 * - encoding: Set by user.
2876 * - decoding: Set by user.
2879 #define FF_DEBUG_VIS_MV_P_FOR 0x00000001 //visualize forward predicted MVs of P frames
2880 #define FF_DEBUG_VIS_MV_B_FOR 0x00000002 //visualize forward predicted MVs of B frames
2881 #define FF_DEBUG_VIS_MV_B_BACK 0x00000004 //visualize backward predicted MVs of B frames
2885 * Error recognition; may misdetect some more or less valid parts as errors.
2886 * - encoding: unused
2887 * - decoding: Set by user.
2889 int err_recognition;
2892 * Verify checksums embedded in the bitstream (could be of either encoded or
2893 * decoded data, depending on the codec) and print an error message on mismatch.
2894 * If AV_EF_EXPLODE is also set, a mismatching checksum will result in the
2895 * decoder returning an error.
2897 #define AV_EF_CRCCHECK (1<<0)
2898 #define AV_EF_BITSTREAM (1<<1) ///< detect bitstream specification deviations
2899 #define AV_EF_BUFFER (1<<2) ///< detect improper bitstream length
2900 #define AV_EF_EXPLODE (1<<3) ///< abort decoding on minor error detection
2902 #define AV_EF_IGNORE_ERR (1<<15) ///< ignore errors and continue
2903 #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
2904 #define AV_EF_COMPLIANT (1<<17) ///< consider all spec non compliances as errors
2905 #define AV_EF_AGGRESSIVE (1<<18) ///< consider things that a sane encoder should not do as an error
2909 * opaque 64bit number (generally a PTS) that will be reordered and
2910 * output in AVFrame.reordered_opaque
2911 * - encoding: unused
2912 * - decoding: Set by user.
2914 int64_t reordered_opaque;
2917 * Hardware accelerator in use
2918 * - encoding: unused.
2919 * - decoding: Set by libavcodec
2921 struct AVHWAccel *hwaccel;
2924 * Hardware accelerator context.
2925 * For some hardware accelerators, a global context needs to be
2926 * provided by the user. In that case, this holds display-dependent
2927 * data FFmpeg cannot instantiate itself. Please refer to the
2928 * FFmpeg HW accelerator documentation to know how to fill this
2929 * is. e.g. for VA API, this is a struct vaapi_context.
2930 * - encoding: unused
2931 * - decoding: Set by user
2933 void *hwaccel_context;
2937 * - encoding: Set by libavcodec if flags & AV_CODEC_FLAG_PSNR.
2938 * - decoding: unused
2940 uint64_t error[AV_NUM_DATA_POINTERS];
2943 * DCT algorithm, see FF_DCT_* below
2944 * - encoding: Set by user.
2945 * - decoding: unused
2948 #define FF_DCT_AUTO 0
2949 #define FF_DCT_FASTINT 1
2950 #define FF_DCT_INT 2
2951 #define FF_DCT_MMX 3
2952 #define FF_DCT_ALTIVEC 5
2953 #define FF_DCT_FAAN 6
2956 * IDCT algorithm, see FF_IDCT_* below.
2957 * - encoding: Set by user.
2958 * - decoding: Set by user.
2961 #define FF_IDCT_AUTO 0
2962 #define FF_IDCT_INT 1
2963 #define FF_IDCT_SIMPLE 2
2964 #define FF_IDCT_SIMPLEMMX 3
2965 #define FF_IDCT_ARM 7
2966 #define FF_IDCT_ALTIVEC 8
2968 #define FF_IDCT_SH4 9
2970 #define FF_IDCT_SIMPLEARM 10
2971 #if FF_API_UNUSED_MEMBERS
2972 #define FF_IDCT_IPP 13
2973 #endif /* FF_API_UNUSED_MEMBERS */
2974 #define FF_IDCT_XVID 14
2975 #if FF_API_IDCT_XVIDMMX
2976 #define FF_IDCT_XVIDMMX 14
2977 #endif /* FF_API_IDCT_XVIDMMX */
2978 #define FF_IDCT_SIMPLEARMV5TE 16
2979 #define FF_IDCT_SIMPLEARMV6 17
2980 #if FF_API_ARCH_SPARC
2981 #define FF_IDCT_SIMPLEVIS 18
2983 #define FF_IDCT_FAAN 20
2984 #define FF_IDCT_SIMPLENEON 22
2985 #if FF_API_ARCH_ALPHA
2986 #define FF_IDCT_SIMPLEALPHA 23
2988 #define FF_IDCT_SIMPLEAUTO 128
2991 * bits per sample/pixel from the demuxer (needed for huffyuv).
2992 * - encoding: Set by libavcodec.
2993 * - decoding: Set by user.
2995 int bits_per_coded_sample;
2998 * Bits per sample/pixel of internal libavcodec pixel/sample format.
2999 * - encoding: set by user.
3000 * - decoding: set by libavcodec.
3002 int bits_per_raw_sample;
3006 * low resolution decoding, 1-> 1/2 size, 2->1/4 size
3007 * - encoding: unused
3008 * - decoding: Set by user.
3009 * Code outside libavcodec should access this field using:
3010 * av_codec_{get,set}_lowres(avctx)
3015 #if FF_API_CODED_FRAME
3017 * the picture in the bitstream
3018 * - encoding: Set by libavcodec.
3019 * - decoding: unused
3021 * @deprecated use the quality factor packet side data instead
3023 attribute_deprecated AVFrame *coded_frame;
3028 * is used to decide how many independent tasks should be passed to execute()
3029 * - encoding: Set by user.
3030 * - decoding: Set by user.
3035 * Which multithreading methods to use.
3036 * Use of FF_THREAD_FRAME will increase decoding delay by one frame per thread,
3037 * so clients which cannot provide future frames should not use it.
3039 * - encoding: Set by user, otherwise the default is used.
3040 * - decoding: Set by user, otherwise the default is used.
3043 #define FF_THREAD_FRAME 1 ///< Decode more than one frame at once
3044 #define FF_THREAD_SLICE 2 ///< Decode more than one part of a single frame at once
3047 * Which multithreading methods are in use by the codec.
3048 * - encoding: Set by libavcodec.
3049 * - decoding: Set by libavcodec.
3051 int active_thread_type;
3054 * Set by the client if its custom get_buffer() callback can be called
3055 * synchronously from another thread, which allows faster multithreaded decoding.
3056 * draw_horiz_band() will be called from other threads regardless of this setting.
3057 * Ignored if the default get_buffer() is used.
3058 * - encoding: Set by user.
3059 * - decoding: Set by user.
3061 int thread_safe_callbacks;
3064 * The codec may call this to execute several independent things.
3065 * It will return only after finishing all tasks.
3066 * The user may replace this with some multithreaded implementation,
3067 * the default implementation will execute the parts serially.
3068 * @param count the number of things to execute
3069 * - encoding: Set by libavcodec, user can override.
3070 * - decoding: Set by libavcodec, user can override.
3072 int (*execute)(struct AVCodecContext *c, int (*func)(struct AVCodecContext *c2, void *arg), void *arg2, int *ret, int count, int size);
3075 * The codec may call this to execute several independent things.
3076 * It will return only after finishing all tasks.
3077 * The user may replace this with some multithreaded implementation,
3078 * the default implementation will execute the parts serially.
3079 * Also see avcodec_thread_init and e.g. the --enable-pthread configure option.
3080 * @param c context passed also to func
3081 * @param count the number of things to execute
3082 * @param arg2 argument passed unchanged to func
3083 * @param ret return values of executed functions, must have space for "count" values. May be NULL.
3084 * @param func function that will be called count times, with jobnr from 0 to count-1.
3085 * threadnr will be in the range 0 to c->thread_count-1 < MAX_THREADS and so that no
3086 * two instances of func executing at the same time will have the same threadnr.
3087 * @return always 0 currently, but code should handle a future improvement where when any call to func
3088 * returns < 0 no further calls to func may be done and < 0 is returned.
3089 * - encoding: Set by libavcodec, user can override.
3090 * - decoding: Set by libavcodec, user can override.
3092 int (*execute2)(struct AVCodecContext *c, int (*func)(struct AVCodecContext *c2, void *arg, int jobnr, int threadnr), void *arg2, int *ret, int count);
3094 #if FF_API_THREAD_OPAQUE
3096 * @deprecated this field should not be used from outside of lavc
3098 attribute_deprecated
3099 void *thread_opaque;
3103 * noise vs. sse weight for the nsse comparison function
3104 * - encoding: Set by user.
3105 * - decoding: unused
3111 * - encoding: Set by user.
3112 * - decoding: Set by libavcodec.
3115 #define FF_PROFILE_UNKNOWN -99
3116 #define FF_PROFILE_RESERVED -100
3118 #define FF_PROFILE_AAC_MAIN 0
3119 #define FF_PROFILE_AAC_LOW 1
3120 #define FF_PROFILE_AAC_SSR 2
3121 #define FF_PROFILE_AAC_LTP 3
3122 #define FF_PROFILE_AAC_HE 4
3123 #define FF_PROFILE_AAC_HE_V2 28
3124 #define FF_PROFILE_AAC_LD 22
3125 #define FF_PROFILE_AAC_ELD 38
3126 #define FF_PROFILE_MPEG2_AAC_LOW 128
3127 #define FF_PROFILE_MPEG2_AAC_HE 131
3129 #define FF_PROFILE_DTS 20
3130 #define FF_PROFILE_DTS_ES 30
3131 #define FF_PROFILE_DTS_96_24 40
3132 #define FF_PROFILE_DTS_HD_HRA 50
3133 #define FF_PROFILE_DTS_HD_MA 60
3134 #define FF_PROFILE_DTS_EXPRESS 70
3136 #define FF_PROFILE_MPEG2_422 0
3137 #define FF_PROFILE_MPEG2_HIGH 1
3138 #define FF_PROFILE_MPEG2_SS 2
3139 #define FF_PROFILE_MPEG2_SNR_SCALABLE 3
3140 #define FF_PROFILE_MPEG2_MAIN 4
3141 #define FF_PROFILE_MPEG2_SIMPLE 5
3143 #define FF_PROFILE_H264_CONSTRAINED (1<<9) // 8+1; constraint_set1_flag
3144 #define FF_PROFILE_H264_INTRA (1<<11) // 8+3; constraint_set3_flag
3146 #define FF_PROFILE_H264_BASELINE 66
3147 #define FF_PROFILE_H264_CONSTRAINED_BASELINE (66|FF_PROFILE_H264_CONSTRAINED)
3148 #define FF_PROFILE_H264_MAIN 77
3149 #define FF_PROFILE_H264_EXTENDED 88
3150 #define FF_PROFILE_H264_HIGH 100
3151 #define FF_PROFILE_H264_HIGH_10 110
3152 #define FF_PROFILE_H264_HIGH_10_INTRA (110|FF_PROFILE_H264_INTRA)
3153 #define FF_PROFILE_H264_HIGH_422 122
3154 #define FF_PROFILE_H264_HIGH_422_INTRA (122|FF_PROFILE_H264_INTRA)
3155 #define FF_PROFILE_H264_HIGH_444 144
3156 #define FF_PROFILE_H264_HIGH_444_PREDICTIVE 244
3157 #define FF_PROFILE_H264_HIGH_444_INTRA (244|FF_PROFILE_H264_INTRA)
3158 #define FF_PROFILE_H264_CAVLC_444 44
3160 #define FF_PROFILE_VC1_SIMPLE 0
3161 #define FF_PROFILE_VC1_MAIN 1
3162 #define FF_PROFILE_VC1_COMPLEX 2
3163 #define FF_PROFILE_VC1_ADVANCED 3
3165 #define FF_PROFILE_MPEG4_SIMPLE 0
3166 #define FF_PROFILE_MPEG4_SIMPLE_SCALABLE 1
3167 #define FF_PROFILE_MPEG4_CORE 2
3168 #define FF_PROFILE_MPEG4_MAIN 3
3169 #define FF_PROFILE_MPEG4_N_BIT 4
3170 #define FF_PROFILE_MPEG4_SCALABLE_TEXTURE 5
3171 #define FF_PROFILE_MPEG4_SIMPLE_FACE_ANIMATION 6
3172 #define FF_PROFILE_MPEG4_BASIC_ANIMATED_TEXTURE 7
3173 #define FF_PROFILE_MPEG4_HYBRID 8
3174 #define FF_PROFILE_MPEG4_ADVANCED_REAL_TIME 9
3175 #define FF_PROFILE_MPEG4_CORE_SCALABLE 10
3176 #define FF_PROFILE_MPEG4_ADVANCED_CODING 11
3177 #define FF_PROFILE_MPEG4_ADVANCED_CORE 12
3178 #define FF_PROFILE_MPEG4_ADVANCED_SCALABLE_TEXTURE 13
3179 #define FF_PROFILE_MPEG4_SIMPLE_STUDIO 14
3180 #define FF_PROFILE_MPEG4_ADVANCED_SIMPLE 15
3182 #define FF_PROFILE_JPEG2000_CSTREAM_RESTRICTION_0 0
3183 #define FF_PROFILE_JPEG2000_CSTREAM_RESTRICTION_1 1
3184 #define FF_PROFILE_JPEG2000_CSTREAM_NO_RESTRICTION 2
3185 #define FF_PROFILE_JPEG2000_DCINEMA_2K 3
3186 #define FF_PROFILE_JPEG2000_DCINEMA_4K 4
3188 #define FF_PROFILE_VP9_0 0
3189 #define FF_PROFILE_VP9_1 1
3190 #define FF_PROFILE_VP9_2 2
3191 #define FF_PROFILE_VP9_3 3
3193 #define FF_PROFILE_HEVC_MAIN 1
3194 #define FF_PROFILE_HEVC_MAIN_10 2
3195 #define FF_PROFILE_HEVC_MAIN_STILL_PICTURE 3
3196 #define FF_PROFILE_HEVC_REXT 4
3200 * - encoding: Set by user.
3201 * - decoding: Set by libavcodec.
3204 #define FF_LEVEL_UNKNOWN -99
3207 * Skip loop filtering for selected frames.
3208 * - encoding: unused
3209 * - decoding: Set by user.
3211 enum AVDiscard skip_loop_filter;
3214 * Skip IDCT/dequantization for selected frames.
3215 * - encoding: unused
3216 * - decoding: Set by user.
3218 enum AVDiscard skip_idct;
3221 * Skip decoding for selected frames.
3222 * - encoding: unused
3223 * - decoding: Set by user.
3225 enum AVDiscard skip_frame;
3228 * Header containing style information for text subtitles.
3229 * For SUBTITLE_ASS subtitle type, it should contain the whole ASS
3230 * [Script Info] and [V4+ Styles] section, plus the [Events] line and
3231 * the Format line following. It shouldn't include any Dialogue line.
3232 * - encoding: Set/allocated/freed by user (before avcodec_open2())
3233 * - decoding: Set/allocated/freed by libavcodec (by avcodec_open2())
3235 uint8_t *subtitle_header;
3236 int subtitle_header_size;
3238 #if FF_API_ERROR_RATE
3240 * @deprecated use the 'error_rate' private AVOption of the mpegvideo
3243 attribute_deprecated
3247 #if FF_API_CODEC_PKT
3249 * @deprecated this field is not supposed to be accessed from outside lavc
3251 attribute_deprecated
3256 * VBV delay coded in the last frame (in periods of a 27 MHz clock).
3257 * Used for compliant TS muxing.
3258 * - encoding: Set by libavcodec.
3259 * - decoding: unused.
3264 * Encoding only. Allow encoders to output packets that do not contain any
3265 * encoded data, only side data.
3267 * Some encoders need to output such packets, e.g. to update some stream
3268 * parameters at the end of encoding.
3270 * All callers are strongly recommended to set this option to 1 and update
3271 * their code to deal with such packets, since this behaviour may become
3272 * always enabled in the future (then this option will be deprecated and
3273 * later removed). To avoid ABI issues when this happens, the callers should
3274 * use AVOptions to set this field.
3276 int side_data_only_packets;
3279 * Audio only. The number of "priming" samples (padding) inserted by the
3280 * encoder at the beginning of the audio. I.e. this number of leading
3281 * decoded samples must be discarded by the caller to get the original audio
3282 * without leading padding.
3284 * - decoding: unused
3285 * - encoding: Set by libavcodec. The timestamps on the output packets are
3286 * adjusted by the encoder so that they always refer to the
3287 * first sample of the data actually contained in the packet,
3288 * including any added padding. E.g. if the timebase is
3289 * 1/samplerate and the timestamp of the first input sample is
3290 * 0, the timestamp of the first output packet will be
3293 int initial_padding;
3296 * - decoding: For codecs that store a framerate value in the compressed
3297 * bitstream, the decoder may export it here. { 0, 1} when
3299 * - encoding: unused
3301 AVRational framerate;
3304 * Nominal unaccelerated pixel format, see AV_PIX_FMT_xxx.
3305 * - encoding: unused.
3306 * - decoding: Set by libavcodec before calling get_format()
3308 enum AVPixelFormat sw_pix_fmt;
3311 * Timebase in which pkt_dts/pts and AVPacket.dts/pts are.
3312 * Code outside libavcodec should access this field using:
3313 * av_codec_{get,set}_pkt_timebase(avctx)
3314 * - encoding unused.
3315 * - decoding set by user.
3317 AVRational pkt_timebase;
3321 * Code outside libavcodec should access this field using:
3322 * av_codec_{get,set}_codec_descriptor(avctx)
3323 * - encoding: unused.
3324 * - decoding: set by libavcodec.
3326 const AVCodecDescriptor *codec_descriptor;
3330 * low resolution decoding, 1-> 1/2 size, 2->1/4 size
3331 * - encoding: unused
3332 * - decoding: Set by user.
3333 * Code outside libavcodec should access this field using:
3334 * av_codec_{get,set}_lowres(avctx)
3340 * Current statistics for PTS correction.
3341 * - decoding: maintained and used by libavcodec, not intended to be used by user apps
3342 * - encoding: unused
3344 int64_t pts_correction_num_faulty_pts; /// Number of incorrect PTS values so far
3345 int64_t pts_correction_num_faulty_dts; /// Number of incorrect DTS values so far
3346 int64_t pts_correction_last_pts; /// PTS of the last frame
3347 int64_t pts_correction_last_dts; /// DTS of the last frame
3350 * Character encoding of the input subtitles file.
3351 * - decoding: set by user
3352 * - encoding: unused
3357 * Subtitles character encoding mode. Formats or codecs might be adjusting
3358 * this setting (if they are doing the conversion themselves for instance).
3359 * - decoding: set by libavcodec
3360 * - encoding: unused
3362 int sub_charenc_mode;
3363 #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)
3364 #define FF_SUB_CHARENC_MODE_AUTOMATIC 0 ///< libavcodec will select the mode itself
3365 #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
3368 * Skip processing alpha if supported by codec.
3369 * Note that if the format uses pre-multiplied alpha (common with VP6,
3370 * and recommended due to better video quality/compression)
3371 * the image will look as if alpha-blended onto a black background.
3372 * However for formats that do not use pre-multiplied alpha
3373 * there might be serious artefacts (though e.g. libswscale currently
3374 * assumes pre-multiplied alpha anyway).
3375 * Code outside libavcodec should access this field using AVOptions
3377 * - decoding: set by user
3378 * - encoding: unused
3383 * Number of samples to skip after a discontinuity
3384 * - decoding: unused
3385 * - encoding: set by libavcodec
3389 #if !FF_API_DEBUG_MV
3391 * debug motion vectors
3392 * Code outside libavcodec should access this field using AVOptions
3393 * - encoding: Set by user.
3394 * - decoding: Set by user.
3397 #define FF_DEBUG_VIS_MV_P_FOR 0x00000001 //visualize forward predicted MVs of P frames
3398 #define FF_DEBUG_VIS_MV_B_FOR 0x00000002 //visualize forward predicted MVs of B frames
3399 #define FF_DEBUG_VIS_MV_B_BACK 0x00000004 //visualize backward predicted MVs of B frames
3403 * custom intra quantization matrix
3404 * Code outside libavcodec should access this field using av_codec_g/set_chroma_intra_matrix()
3405 * - encoding: Set by user, can be NULL.
3406 * - decoding: unused.
3408 uint16_t *chroma_intra_matrix;
3411 * dump format separator.
3412 * can be ", " or "\n " or anything else
3413 * Code outside libavcodec should access this field using AVOptions
3414 * (NO direct access).
3415 * - encoding: Set by user.
3416 * - decoding: Set by user.
3418 uint8_t *dump_separator;
3421 * ',' separated list of allowed decoders.
3422 * If NULL then all are allowed
3423 * - encoding: unused
3424 * - decoding: set by user through AVOPtions (NO direct access)
3426 char *codec_whitelist;
3429 * Properties of the stream that gets decoded
3430 * To be accessed through av_codec_get_properties() (NO direct access)
3431 * - encoding: unused
3432 * - decoding: set by libavcodec
3434 unsigned properties;
3435 #define FF_CODEC_PROPERTY_LOSSLESS 0x00000001
3436 #define FF_CODEC_PROPERTY_CLOSED_CAPTIONS 0x00000002
3439 AVRational av_codec_get_pkt_timebase (const AVCodecContext *avctx);
3440 void av_codec_set_pkt_timebase (AVCodecContext *avctx, AVRational val);
3442 const AVCodecDescriptor *av_codec_get_codec_descriptor(const AVCodecContext *avctx);
3443 void av_codec_set_codec_descriptor(AVCodecContext *avctx, const AVCodecDescriptor *desc);
3445 unsigned av_codec_get_codec_properties(const AVCodecContext *avctx);
3447 int av_codec_get_lowres(const AVCodecContext *avctx);
3448 void av_codec_set_lowres(AVCodecContext *avctx, int val);
3450 int av_codec_get_seek_preroll(const AVCodecContext *avctx);
3451 void av_codec_set_seek_preroll(AVCodecContext *avctx, int val);
3453 uint16_t *av_codec_get_chroma_intra_matrix(const AVCodecContext *avctx);
3454 void av_codec_set_chroma_intra_matrix(AVCodecContext *avctx, uint16_t *val);
3459 typedef struct AVProfile {
3461 const char *name; ///< short name for the profile
3464 typedef struct AVCodecDefault AVCodecDefault;
3471 typedef struct AVCodec {
3473 * Name of the codec implementation.
3474 * The name is globally unique among encoders and among decoders (but an
3475 * encoder and a decoder can share the same name).
3476 * This is the primary way to find a codec from the user perspective.
3480 * Descriptive name for the codec, meant to be more human readable than name.
3481 * You should use the NULL_IF_CONFIG_SMALL() macro to define it.
3483 const char *long_name;
3484 enum AVMediaType type;
3487 * Codec capabilities.
3488 * see AV_CODEC_CAP_*
3491 const AVRational *supported_framerates; ///< array of supported framerates, or NULL if any, array is terminated by {0,0}
3492 const enum AVPixelFormat *pix_fmts; ///< array of supported pixel formats, or NULL if unknown, array is terminated by -1
3493 const int *supported_samplerates; ///< array of supported audio samplerates, or NULL if unknown, array is terminated by 0
3494 const enum AVSampleFormat *sample_fmts; ///< array of supported sample formats, or NULL if unknown, array is terminated by -1
3495 const uint64_t *channel_layouts; ///< array of support channel layouts, or NULL if unknown. array is terminated by 0
3496 uint8_t max_lowres; ///< maximum value for lowres supported by the decoder, no direct access, use av_codec_get_max_lowres()
3497 const AVClass *priv_class; ///< AVClass for the private context
3498 const AVProfile *profiles; ///< array of recognized profiles, or NULL if unknown, array is terminated by {FF_PROFILE_UNKNOWN}
3500 /*****************************************************************
3501 * No fields below this line are part of the public API. They
3502 * may not be used outside of libavcodec and can be changed and
3504 * New public fields should be added right above.
3505 *****************************************************************
3508 struct AVCodec *next;
3510 * @name Frame-level threading support functions
3514 * If defined, called on thread contexts when they are created.
3515 * If the codec allocates writable tables in init(), re-allocate them here.
3516 * priv_data will be set to a copy of the original.
3518 int (*init_thread_copy)(AVCodecContext *);
3520 * Copy necessary context variables from a previous thread context to the current one.
3521 * If not defined, the next thread will start automatically; otherwise, the codec
3522 * must call ff_thread_finish_setup().
3524 * dst and src will (rarely) point to the same context, in which case memcpy should be skipped.
3526 int (*update_thread_context)(AVCodecContext *dst, const AVCodecContext *src);
3530 * Private codec-specific defaults.
3532 const AVCodecDefault *defaults;
3535 * Initialize codec static data, called from avcodec_register().
3537 void (*init_static_data)(struct AVCodec *codec);
3539 int (*init)(AVCodecContext *);
3540 int (*encode_sub)(AVCodecContext *, uint8_t *buf, int buf_size,
3541 const struct AVSubtitle *sub);
3543 * Encode data to an AVPacket.
3545 * @param avctx codec context
3546 * @param avpkt output AVPacket (may contain a user-provided buffer)
3547 * @param[in] frame AVFrame containing the raw data to be encoded
3548 * @param[out] got_packet_ptr encoder sets to 0 or 1 to indicate that a
3549 * non-empty packet was returned in avpkt.
3550 * @return 0 on success, negative error code on failure
3552 int (*encode2)(AVCodecContext *avctx, AVPacket *avpkt, const AVFrame *frame,
3553 int *got_packet_ptr);
3554 int (*decode)(AVCodecContext *, void *outdata, int *outdata_size, AVPacket *avpkt);
3555 int (*close)(AVCodecContext *);
3558 * Will be called when seeking
3560 void (*flush)(AVCodecContext *);
3562 * Internal codec capabilities.
3563 * See FF_CODEC_CAP_* in internal.h
3568 int av_codec_get_max_lowres(const AVCodec *codec);
3570 struct MpegEncContext;
3573 * @defgroup lavc_hwaccel AVHWAccel
3576 typedef struct AVHWAccel {
3578 * Name of the hardware accelerated codec.
3579 * The name is globally unique among encoders and among decoders (but an
3580 * encoder and a decoder can share the same name).
3585 * Type of codec implemented by the hardware accelerator.
3587 * See AVMEDIA_TYPE_xxx
3589 enum AVMediaType type;
3592 * Codec implemented by the hardware accelerator.
3594 * See AV_CODEC_ID_xxx
3599 * Supported pixel format.
3601 * Only hardware accelerated formats are supported here.
3603 enum AVPixelFormat pix_fmt;
3606 * Hardware accelerated codec capabilities.
3607 * see HWACCEL_CODEC_CAP_*
3611 /*****************************************************************
3612 * No fields below this line are part of the public API. They
3613 * may not be used outside of libavcodec and can be changed and
3615 * New public fields should be added right above.
3616 *****************************************************************
3618 struct AVHWAccel *next;
3621 * Allocate a custom buffer
3623 int (*alloc_frame)(AVCodecContext *avctx, AVFrame *frame);
3626 * Called at the beginning of each frame or field picture.
3628 * Meaningful frame information (codec specific) is guaranteed to
3629 * be parsed at this point. This function is mandatory.
3631 * Note that buf can be NULL along with buf_size set to 0.
3632 * Otherwise, this means the whole frame is available at this point.
3634 * @param avctx the codec context
3635 * @param buf the frame data buffer base
3636 * @param buf_size the size of the frame in bytes
3637 * @return zero if successful, a negative value otherwise
3639 int (*start_frame)(AVCodecContext *avctx, const uint8_t *buf, uint32_t buf_size);
3642 * Callback for each slice.
3644 * Meaningful slice information (codec specific) is guaranteed to
3645 * be parsed at this point. This function is mandatory.
3646 * The only exception is XvMC, that works on MB level.
3648 * @param avctx the codec context
3649 * @param buf the slice data buffer base
3650 * @param buf_size the size of the slice in bytes
3651 * @return zero if successful, a negative value otherwise
3653 int (*decode_slice)(AVCodecContext *avctx, const uint8_t *buf, uint32_t buf_size);
3656 * Called at the end of each frame or field picture.
3658 * The whole picture is parsed at this point and can now be sent
3659 * to the hardware accelerator. This function is mandatory.
3661 * @param avctx the codec context
3662 * @return zero if successful, a negative value otherwise
3664 int (*end_frame)(AVCodecContext *avctx);
3667 * Size of per-frame hardware accelerator private data.
3669 * Private data is allocated with av_mallocz() before
3670 * AVCodecContext.get_buffer() and deallocated after
3671 * AVCodecContext.release_buffer().
3673 int frame_priv_data_size;
3676 * Called for every Macroblock in a slice.
3678 * XvMC uses it to replace the ff_mpv_decode_mb().
3679 * Instead of decoding to raw picture, MB parameters are
3680 * stored in an array provided by the video driver.
3682 * @param s the mpeg context
3684 void (*decode_mb)(struct MpegEncContext *s);
3687 * Initialize the hwaccel private data.
3689 * This will be called from ff_get_format(), after hwaccel and
3690 * hwaccel_context are set and the hwaccel private data in AVCodecInternal
3693 int (*init)(AVCodecContext *avctx);
3696 * Uninitialize the hwaccel private data.
3698 * This will be called from get_format() or avcodec_close(), after hwaccel
3699 * and hwaccel_context are already uninitialized.
3701 int (*uninit)(AVCodecContext *avctx);
3704 * Size of the private data to allocate in
3705 * AVCodecInternal.hwaccel_priv_data.
3711 * Hardware acceleration should be used for decoding even if the codec level
3712 * used is unknown or higher than the maximum supported level reported by the
3715 * It's generally a good idea to pass this flag unless you have a specific
3716 * reason not to, as hardware tends to under-report supported levels.
3718 #define AV_HWACCEL_FLAG_IGNORE_LEVEL (1 << 0)
3721 * Hardware acceleration can output YUV pixel formats with a different chroma
3722 * sampling than 4:2:0 and/or other than 8 bits per component.
3724 #define AV_HWACCEL_FLAG_ALLOW_HIGH_DEPTH (1 << 1)
3731 * @defgroup lavc_picture AVPicture
3733 * Functions for working with AVPicture
3738 * Picture data structure.
3740 * Up to four components can be stored into it, the last component is
3743 typedef struct AVPicture {
3744 uint8_t *data[AV_NUM_DATA_POINTERS]; ///< pointers to the image data planes
3745 int linesize[AV_NUM_DATA_POINTERS]; ///< number of bytes per line
3752 enum AVSubtitleType {
3755 SUBTITLE_BITMAP, ///< A bitmap, pict will be set
3758 * Plain text, the text field must be set by the decoder and is
3759 * authoritative. ass and pict fields may contain approximations.
3764 * Formatted text, the ass field must be set by the decoder and is
3765 * authoritative. pict and text fields may contain approximations.
3770 #define AV_SUBTITLE_FLAG_FORCED 0x00000001
3772 typedef struct AVSubtitleRect {
3773 int x; ///< top left corner of pict, undefined when pict is not set
3774 int y; ///< top left corner of pict, undefined when pict is not set
3775 int w; ///< width of pict, undefined when pict is not set
3776 int h; ///< height of pict, undefined when pict is not set
3777 int nb_colors; ///< number of colors in pict, undefined when pict is not set
3780 * data+linesize for the bitmap of this subtitle.
3781 * can be set for text/ass as well once they are rendered
3784 enum AVSubtitleType type;
3786 char *text; ///< 0 terminated plain UTF-8 text
3789 * 0 terminated ASS/SSA compatible event line.
3790 * The presentation of this is unaffected by the other values in this
3798 typedef struct AVSubtitle {
3799 uint16_t format; /* 0 = graphics */
3800 uint32_t start_display_time; /* relative to packet pts, in ms */
3801 uint32_t end_display_time; /* relative to packet pts, in ms */
3803 AVSubtitleRect **rects;
3804 int64_t pts; ///< Same as packet pts, in AV_TIME_BASE
3808 * If c is NULL, returns the first registered codec,
3809 * if c is non-NULL, returns the next registered codec after c,
3810 * or NULL if c is the last one.
3812 AVCodec *av_codec_next(const AVCodec *c);
3815 * Return the LIBAVCODEC_VERSION_INT constant.
3817 unsigned avcodec_version(void);
3820 * Return the libavcodec build-time configuration.
3822 const char *avcodec_configuration(void);
3825 * Return the libavcodec license.
3827 const char *avcodec_license(void);
3830 * Register the codec codec and initialize libavcodec.
3832 * @warning either this function or avcodec_register_all() must be called
3833 * before any other libavcodec functions.
3835 * @see avcodec_register_all()
3837 void avcodec_register(AVCodec *codec);
3840 * Register all the codecs, parsers and bitstream filters which were enabled at
3841 * configuration time. If you do not call this function you can select exactly
3842 * which formats you want to support, by using the individual registration
3845 * @see avcodec_register
3846 * @see av_register_codec_parser
3847 * @see av_register_bitstream_filter
3849 void avcodec_register_all(void);
3852 * Allocate an AVCodecContext and set its fields to default values. The
3853 * resulting struct should be freed with avcodec_free_context().
3855 * @param codec if non-NULL, allocate private data and initialize defaults
3856 * for the given codec. It is illegal to then call avcodec_open2()
3857 * with a different codec.
3858 * If NULL, then the codec-specific defaults won't be initialized,
3859 * which may result in suboptimal default settings (this is
3860 * important mainly for encoders, e.g. libx264).
3862 * @return An AVCodecContext filled with default values or NULL on failure.
3863 * @see avcodec_get_context_defaults
3865 AVCodecContext *avcodec_alloc_context3(const AVCodec *codec);
3868 * Free the codec context and everything associated with it and write NULL to
3869 * the provided pointer.
3871 void avcodec_free_context(AVCodecContext **avctx);
3874 * Set the fields of the given AVCodecContext to default values corresponding
3875 * to the given codec (defaults may be codec-dependent).
3877 * Do not call this function if a non-NULL codec has been passed
3878 * to avcodec_alloc_context3() that allocated this AVCodecContext.
3879 * If codec is non-NULL, it is illegal to call avcodec_open2() with a
3880 * different codec on this AVCodecContext.
3882 int avcodec_get_context_defaults3(AVCodecContext *s, const AVCodec *codec);
3885 * Get the AVClass for AVCodecContext. It can be used in combination with
3886 * AV_OPT_SEARCH_FAKE_OBJ for examining options.
3888 * @see av_opt_find().
3890 const AVClass *avcodec_get_class(void);
3893 * Get the AVClass for AVFrame. It can be used in combination with
3894 * AV_OPT_SEARCH_FAKE_OBJ for examining options.
3896 * @see av_opt_find().
3898 const AVClass *avcodec_get_frame_class(void);
3901 * Get the AVClass for AVSubtitleRect. It can be used in combination with
3902 * AV_OPT_SEARCH_FAKE_OBJ for examining options.
3904 * @see av_opt_find().
3906 const AVClass *avcodec_get_subtitle_rect_class(void);
3909 * Copy the settings of the source AVCodecContext into the destination
3910 * AVCodecContext. The resulting destination codec context will be
3911 * unopened, i.e. you are required to call avcodec_open2() before you
3912 * can use this AVCodecContext to decode/encode video/audio data.
3914 * @param dest target codec context, should be initialized with
3915 * avcodec_alloc_context3(NULL), but otherwise uninitialized
3916 * @param src source codec context
3917 * @return AVERROR() on error (e.g. memory allocation error), 0 on success
3919 int avcodec_copy_context(AVCodecContext *dest, const AVCodecContext *src);
3921 #if FF_API_AVFRAME_LAVC
3923 * @deprecated use av_frame_alloc()
3925 attribute_deprecated
3926 AVFrame *avcodec_alloc_frame(void);
3929 * Set the fields of the given AVFrame to default values.
3931 * @param frame The AVFrame of which the fields should be set to default values.
3933 * @deprecated use av_frame_unref()
3935 attribute_deprecated
3936 void avcodec_get_frame_defaults(AVFrame *frame);
3939 * Free the frame and any dynamically allocated objects in it,
3940 * e.g. extended_data.
3942 * @param frame frame to be freed. The pointer will be set to NULL.
3944 * @warning this function does NOT free the data buffers themselves
3945 * (it does not know how, since they might have been allocated with
3946 * a custom get_buffer()).
3948 * @deprecated use av_frame_free()
3950 attribute_deprecated
3951 void avcodec_free_frame(AVFrame **frame);
3955 * Initialize the AVCodecContext to use the given AVCodec. Prior to using this
3956 * function the context has to be allocated with avcodec_alloc_context3().
3958 * The functions avcodec_find_decoder_by_name(), avcodec_find_encoder_by_name(),
3959 * avcodec_find_decoder() and avcodec_find_encoder() provide an easy way for
3960 * retrieving a codec.
3962 * @warning This function is not thread safe!
3964 * @note Always call this function before using decoding routines (such as
3965 * @ref avcodec_decode_video2()).
3968 * avcodec_register_all();
3969 * av_dict_set(&opts, "b", "2.5M", 0);
3970 * codec = avcodec_find_decoder(AV_CODEC_ID_H264);
3974 * context = avcodec_alloc_context3(codec);
3976 * if (avcodec_open2(context, codec, opts) < 0)
3980 * @param avctx The context to initialize.
3981 * @param codec The codec to open this context for. If a non-NULL codec has been
3982 * previously passed to avcodec_alloc_context3() or
3983 * avcodec_get_context_defaults3() for this context, then this
3984 * parameter MUST be either NULL or equal to the previously passed
3986 * @param options A dictionary filled with AVCodecContext and codec-private options.
3987 * On return this object will be filled with options that were not found.
3989 * @return zero on success, a negative value on error
3990 * @see avcodec_alloc_context3(), avcodec_find_decoder(), avcodec_find_encoder(),
3991 * av_dict_set(), av_opt_find().
3993 int avcodec_open2(AVCodecContext *avctx, const AVCodec *codec, AVDictionary **options);
3996 * Close a given AVCodecContext and free all the data associated with it
3997 * (but not the AVCodecContext itself).
3999 * Calling this function on an AVCodecContext that hasn't been opened will free
4000 * the codec-specific data allocated in avcodec_alloc_context3() /
4001 * avcodec_get_context_defaults3() with a non-NULL codec. Subsequent calls will
4004 int avcodec_close(AVCodecContext *avctx);
4007 * Free all allocated data in the given subtitle struct.
4009 * @param sub AVSubtitle to free.
4011 void avsubtitle_free(AVSubtitle *sub);
4018 * @addtogroup lavc_packet
4022 #if FF_API_DESTRUCT_PACKET
4024 * Default packet destructor.
4025 * @deprecated use the AVBuffer API instead
4027 attribute_deprecated
4028 void av_destruct_packet(AVPacket *pkt);
4032 * Initialize optional fields of a packet with default values.
4034 * Note, this does not touch the data and size members, which have to be
4035 * initialized separately.
4039 void av_init_packet(AVPacket *pkt);
4042 * Allocate the payload of a packet and initialize its fields with
4046 * @param size wanted payload size
4047 * @return 0 if OK, AVERROR_xxx otherwise
4049 int av_new_packet(AVPacket *pkt, int size);
4052 * Reduce packet size, correctly zeroing padding
4055 * @param size new size
4057 void av_shrink_packet(AVPacket *pkt, int size);
4060 * Increase packet size, correctly zeroing padding
4063 * @param grow_by number of bytes by which to increase the size of the packet
4065 int av_grow_packet(AVPacket *pkt, int grow_by);
4068 * Initialize a reference-counted packet from av_malloc()ed data.
4070 * @param pkt packet to be initialized. This function will set the data, size,
4071 * buf and destruct fields, all others are left untouched.
4072 * @param data Data allocated by av_malloc() to be used as packet data. If this
4073 * function returns successfully, the data is owned by the underlying AVBuffer.
4074 * The caller may not access the data through other means.
4075 * @param size size of data in bytes, without the padding. I.e. the full buffer
4076 * size is assumed to be size + AV_INPUT_BUFFER_PADDING_SIZE.
4078 * @return 0 on success, a negative AVERROR on error
4080 int av_packet_from_data(AVPacket *pkt, uint8_t *data, int size);
4083 * @warning This is a hack - the packet memory allocation stuff is broken. The
4084 * packet is allocated if it was not really allocated.
4086 int av_dup_packet(AVPacket *pkt);
4089 * Copy packet, including contents
4091 * @return 0 on success, negative AVERROR on fail
4093 int av_copy_packet(AVPacket *dst, const AVPacket *src);
4096 * Copy packet side data
4098 * @return 0 on success, negative AVERROR on fail
4100 int av_copy_packet_side_data(AVPacket *dst, const AVPacket *src);
4105 * @param pkt packet to free
4107 void av_free_packet(AVPacket *pkt);
4110 * Allocate new information of a packet.
4113 * @param type side information type
4114 * @param size side information size
4115 * @return pointer to fresh allocated data or NULL otherwise
4117 uint8_t* av_packet_new_side_data(AVPacket *pkt, enum AVPacketSideDataType type,
4121 * Shrink the already allocated side data buffer
4124 * @param type side information type
4125 * @param size new side information size
4126 * @return 0 on success, < 0 on failure
4128 int av_packet_shrink_side_data(AVPacket *pkt, enum AVPacketSideDataType type,
4132 * Get side information from packet.
4135 * @param type desired side information type
4136 * @param size pointer for side information size to store (optional)
4137 * @return pointer to data if present or NULL otherwise
4139 uint8_t* av_packet_get_side_data(AVPacket *pkt, enum AVPacketSideDataType type,
4142 int av_packet_merge_side_data(AVPacket *pkt);
4144 int av_packet_split_side_data(AVPacket *pkt);
4146 const char *av_packet_side_data_name(enum AVPacketSideDataType type);
4149 * Pack a dictionary for use in side_data.
4151 * @param dict The dictionary to pack.
4152 * @param size pointer to store the size of the returned data
4153 * @return pointer to data if successful, NULL otherwise
4155 uint8_t *av_packet_pack_dictionary(AVDictionary *dict, int *size);
4157 * Unpack a dictionary from side_data.
4159 * @param data data from side_data
4160 * @param size size of the data
4161 * @param dict the metadata storage dictionary
4162 * @return 0 on success, < 0 on failure
4164 int av_packet_unpack_dictionary(const uint8_t *data, int size, AVDictionary **dict);
4168 * Convenience function to free all the side data stored.
4169 * All the other fields stay untouched.
4173 void av_packet_free_side_data(AVPacket *pkt);
4176 * Setup a new reference to the data described by a given packet
4178 * If src is reference-counted, setup dst as a new reference to the
4179 * buffer in src. Otherwise allocate a new buffer in dst and copy the
4180 * data from src into it.
4182 * All the other fields are copied from src.
4184 * @see av_packet_unref
4186 * @param dst Destination packet
4187 * @param src Source packet
4189 * @return 0 on success, a negative AVERROR on error.
4191 int av_packet_ref(AVPacket *dst, const AVPacket *src);
4196 * Unreference the buffer referenced by the packet and reset the
4197 * remaining packet fields to their default values.
4199 * @param pkt The packet to be unreferenced.
4201 void av_packet_unref(AVPacket *pkt);
4204 * Move every field in src to dst and reset src.
4206 * @see av_packet_unref
4208 * @param src Source packet, will be reset
4209 * @param dst Destination packet
4211 void av_packet_move_ref(AVPacket *dst, AVPacket *src);
4214 * Copy only "properties" fields from src to dst.
4216 * Properties for the purpose of this function are all the fields
4217 * beside those related to the packet data (buf, data, size)
4219 * @param dst Destination packet
4220 * @param src Source packet
4222 * @return 0 on success AVERROR on failure.
4225 int av_packet_copy_props(AVPacket *dst, const AVPacket *src);
4228 * Convert valid timing fields (timestamps / durations) in a packet from one
4229 * timebase to another. Timestamps with unknown values (AV_NOPTS_VALUE) will be
4232 * @param pkt packet on which the conversion will be performed
4233 * @param tb_src source timebase, in which the timing fields in pkt are
4235 * @param tb_dst destination timebase, to which the timing fields will be
4238 void av_packet_rescale_ts(AVPacket *pkt, AVRational tb_src, AVRational tb_dst);
4245 * @addtogroup lavc_decoding
4250 * Find a registered decoder with a matching codec ID.
4252 * @param id AVCodecID of the requested decoder
4253 * @return A decoder if one was found, NULL otherwise.
4255 AVCodec *avcodec_find_decoder(enum AVCodecID id);
4258 * Find a registered decoder with the specified name.
4260 * @param name name of the requested decoder
4261 * @return A decoder if one was found, NULL otherwise.
4263 AVCodec *avcodec_find_decoder_by_name(const char *name);
4265 #if FF_API_GET_BUFFER
4266 attribute_deprecated int avcodec_default_get_buffer(AVCodecContext *s, AVFrame *pic);
4267 attribute_deprecated void avcodec_default_release_buffer(AVCodecContext *s, AVFrame *pic);
4268 attribute_deprecated int avcodec_default_reget_buffer(AVCodecContext *s, AVFrame *pic);
4272 * The default callback for AVCodecContext.get_buffer2(). It is made public so
4273 * it can be called by custom get_buffer2() implementations for decoders without
4274 * AV_CODEC_CAP_DR1 set.
4276 int avcodec_default_get_buffer2(AVCodecContext *s, AVFrame *frame, int flags);
4280 * Return the amount of padding in pixels which the get_buffer callback must
4281 * provide around the edge of the image for codecs which do not have the
4282 * CODEC_FLAG_EMU_EDGE flag.
4284 * @return Required padding in pixels.
4286 * @deprecated CODEC_FLAG_EMU_EDGE is deprecated, so this function is no longer
4289 attribute_deprecated
4290 unsigned avcodec_get_edge_width(void);
4294 * Modify width and height values so that they will result in a memory
4295 * buffer that is acceptable for the codec if you do not use any horizontal
4298 * May only be used if a codec with AV_CODEC_CAP_DR1 has been opened.
4300 void avcodec_align_dimensions(AVCodecContext *s, int *width, int *height);
4303 * Modify width and height values so that they will result in a memory
4304 * buffer that is acceptable for the codec if you also ensure that all
4305 * line sizes are a multiple of the respective linesize_align[i].
4307 * May only be used if a codec with AV_CODEC_CAP_DR1 has been opened.
4309 void avcodec_align_dimensions2(AVCodecContext *s, int *width, int *height,
4310 int linesize_align[AV_NUM_DATA_POINTERS]);
4313 * Converts AVChromaLocation to swscale x/y chroma position.
4315 * The positions represent the chroma (0,0) position in a coordinates system
4316 * with luma (0,0) representing the origin and luma(1,1) representing 256,256
4318 * @param xpos horizontal chroma sample position
4319 * @param ypos vertical chroma sample position
4321 int avcodec_enum_to_chroma_pos(int *xpos, int *ypos, enum AVChromaLocation pos);
4324 * Converts swscale x/y chroma position to AVChromaLocation.
4326 * The positions represent the chroma (0,0) position in a coordinates system
4327 * with luma (0,0) representing the origin and luma(1,1) representing 256,256
4329 * @param xpos horizontal chroma sample position
4330 * @param ypos vertical chroma sample position
4332 enum AVChromaLocation avcodec_chroma_pos_to_enum(int xpos, int ypos);
4334 #if FF_API_OLD_DECODE_AUDIO
4336 * Wrapper function which calls avcodec_decode_audio4.
4338 * @deprecated Use avcodec_decode_audio4 instead.
4340 * Decode the audio frame of size avpkt->size from avpkt->data into samples.
4341 * Some decoders may support multiple frames in a single AVPacket, such
4342 * decoders would then just decode the first frame. In this case,
4343 * avcodec_decode_audio3 has to be called again with an AVPacket that contains
4344 * the remaining data in order to decode the second frame etc.
4346 * could be outputted, frame_size_ptr is zero. Otherwise, it is the
4347 * decompressed frame size in bytes.
4349 * @warning You must set frame_size_ptr to the allocated size of the
4350 * output buffer before calling avcodec_decode_audio3().
4352 * @warning The input buffer must be FF_INPUT_BUFFER_PADDING_SIZE larger than
4353 * the actual read bytes because some optimized bitstream readers read 32 or 64
4354 * bits at once and could read over the end.
4356 * @warning The end of the input buffer avpkt->data should be set to 0 to ensure that
4357 * no overreading happens for damaged MPEG streams.
4359 * @warning You must not provide a custom get_buffer() when using
4360 * avcodec_decode_audio3(). Doing so will override it with
4361 * avcodec_default_get_buffer. Use avcodec_decode_audio4() instead,
4362 * which does allow the application to provide a custom get_buffer().
4364 * @note You might have to align the input buffer avpkt->data and output buffer
4365 * samples. The alignment requirements depend on the CPU: On some CPUs it isn't
4366 * necessary at all, on others it won't work at all if not aligned and on others
4367 * it will work but it will have an impact on performance.
4369 * In practice, avpkt->data should have 4 byte alignment at minimum and
4370 * samples should be 16 byte aligned unless the CPU doesn't need it
4371 * (AltiVec and SSE do).
4373 * @note Codecs which have the CODEC_CAP_DELAY capability set have a delay
4374 * between input and output, these need to be fed with avpkt->data=NULL,
4375 * avpkt->size=0 at the end to return the remaining frames.
4377 * @param avctx the codec context
4378 * @param[out] samples the output buffer, sample type in avctx->sample_fmt
4379 * If the sample format is planar, each channel plane will
4380 * be the same size, with no padding between channels.
4381 * @param[in,out] frame_size_ptr the output buffer size in bytes
4382 * @param[in] avpkt The input AVPacket containing the input buffer.
4383 * You can create such packet with av_init_packet() and by then setting
4384 * data and size, some decoders might in addition need other fields.
4385 * All decoders are designed to use the least fields possible though.
4386 * @return On error a negative value is returned, otherwise the number of bytes
4387 * used or zero if no frame data was decompressed (used) from the input AVPacket.
4389 attribute_deprecated int avcodec_decode_audio3(AVCodecContext *avctx, int16_t *samples,
4390 int *frame_size_ptr,
4395 * Decode the audio frame of size avpkt->size from avpkt->data into frame.
4397 * Some decoders may support multiple frames in a single AVPacket. Such
4398 * decoders would then just decode the first frame and the return value would be
4399 * less than the packet size. In this case, avcodec_decode_audio4 has to be
4400 * called again with an AVPacket containing the remaining data in order to
4401 * decode the second frame, etc... Even if no frames are returned, the packet
4402 * needs to be fed to the decoder with remaining data until it is completely
4403 * consumed or an error occurs.
4405 * Some decoders (those marked with AV_CODEC_CAP_DELAY) have a delay between input
4406 * and output. This means that for some packets they will not immediately
4407 * produce decoded output and need to be flushed at the end of decoding to get
4408 * all the decoded data. Flushing is done by calling this function with packets
4409 * with avpkt->data set to NULL and avpkt->size set to 0 until it stops
4410 * returning samples. It is safe to flush even those decoders that are not
4411 * marked with AV_CODEC_CAP_DELAY, then no samples will be returned.
4413 * @warning The input buffer, avpkt->data must be AV_INPUT_BUFFER_PADDING_SIZE
4414 * larger than the actual read bytes because some optimized bitstream
4415 * readers read 32 or 64 bits at once and could read over the end.
4417 * @note The AVCodecContext MUST have been opened with @ref avcodec_open2()
4418 * before packets may be fed to the decoder.
4420 * @param avctx the codec context
4421 * @param[out] frame The AVFrame in which to store decoded audio samples.
4422 * The decoder will allocate a buffer for the decoded frame by
4423 * calling the AVCodecContext.get_buffer2() callback.
4424 * When AVCodecContext.refcounted_frames is set to 1, the frame is
4425 * reference counted and the returned reference belongs to the
4426 * caller. The caller must release the frame using av_frame_unref()
4427 * when the frame is no longer needed. The caller may safely write
4428 * to the frame if av_frame_is_writable() returns 1.
4429 * When AVCodecContext.refcounted_frames is set to 0, the returned
4430 * reference belongs to the decoder and is valid only until the
4431 * next call to this function or until closing or flushing the
4432 * decoder. The caller may not write to it.
4433 * @param[out] got_frame_ptr Zero if no frame could be decoded, otherwise it is
4434 * non-zero. Note that this field being set to zero
4435 * does not mean that an error has occurred. For
4436 * decoders with AV_CODEC_CAP_DELAY set, no given decode
4437 * call is guaranteed to produce a frame.
4438 * @param[in] avpkt The input AVPacket containing the input buffer.
4439 * At least avpkt->data and avpkt->size should be set. Some
4440 * decoders might also require additional fields to be set.
4441 * @return A negative error code is returned if an error occurred during
4442 * decoding, otherwise the number of bytes consumed from the input
4443 * AVPacket is returned.
4445 int avcodec_decode_audio4(AVCodecContext *avctx, AVFrame *frame,
4446 int *got_frame_ptr, const AVPacket *avpkt);
4449 * Decode the video frame of size avpkt->size from avpkt->data into picture.
4450 * Some decoders may support multiple frames in a single AVPacket, such
4451 * decoders would then just decode the first frame.
4453 * @warning The input buffer must be AV_INPUT_BUFFER_PADDING_SIZE larger than
4454 * the actual read bytes because some optimized bitstream readers read 32 or 64
4455 * bits at once and could read over the end.
4457 * @warning The end of the input buffer buf should be set to 0 to ensure that
4458 * no overreading happens for damaged MPEG streams.
4460 * @note Codecs which have the AV_CODEC_CAP_DELAY capability set have a delay
4461 * between input and output, these need to be fed with avpkt->data=NULL,
4462 * avpkt->size=0 at the end to return the remaining frames.
4464 * @note The AVCodecContext MUST have been opened with @ref avcodec_open2()
4465 * before packets may be fed to the decoder.
4467 * @param avctx the codec context
4468 * @param[out] picture The AVFrame in which the decoded video frame will be stored.
4469 * Use av_frame_alloc() to get an AVFrame. The codec will
4470 * allocate memory for the actual bitmap by calling the
4471 * AVCodecContext.get_buffer2() callback.
4472 * When AVCodecContext.refcounted_frames is set to 1, the frame is
4473 * reference counted and the returned reference belongs to the
4474 * caller. The caller must release the frame using av_frame_unref()
4475 * when the frame is no longer needed. The caller may safely write
4476 * to the frame if av_frame_is_writable() returns 1.
4477 * When AVCodecContext.refcounted_frames is set to 0, the returned
4478 * reference belongs to the decoder and is valid only until the
4479 * next call to this function or until closing or flushing the
4480 * decoder. The caller may not write to it.
4482 * @param[in] avpkt The input AVPacket containing the input buffer.
4483 * You can create such packet with av_init_packet() and by then setting
4484 * data and size, some decoders might in addition need other fields like
4485 * flags&AV_PKT_FLAG_KEY. All decoders are designed to use the least
4487 * @param[in,out] got_picture_ptr Zero if no frame could be decompressed, otherwise, it is nonzero.
4488 * @return On error a negative value is returned, otherwise the number of bytes
4489 * used or zero if no frame could be decompressed.
4491 int avcodec_decode_video2(AVCodecContext *avctx, AVFrame *picture,
4492 int *got_picture_ptr,
4493 const AVPacket *avpkt);
4496 * Decode a subtitle message.
4497 * Return a negative value on error, otherwise return the number of bytes used.
4498 * If no subtitle could be decompressed, got_sub_ptr is zero.
4499 * Otherwise, the subtitle is stored in *sub.
4500 * Note that AV_CODEC_CAP_DR1 is not available for subtitle codecs. This is for
4501 * simplicity, because the performance difference is expect to be negligible
4502 * and reusing a get_buffer written for video codecs would probably perform badly
4503 * due to a potentially very different allocation pattern.
4505 * Some decoders (those marked with CODEC_CAP_DELAY) have a delay between input
4506 * and output. This means that for some packets they will not immediately
4507 * produce decoded output and need to be flushed at the end of decoding to get
4508 * all the decoded data. Flushing is done by calling this function with packets
4509 * with avpkt->data set to NULL and avpkt->size set to 0 until it stops
4510 * returning subtitles. It is safe to flush even those decoders that are not
4511 * marked with CODEC_CAP_DELAY, then no subtitles will be returned.
4513 * @note The AVCodecContext MUST have been opened with @ref avcodec_open2()
4514 * before packets may be fed to the decoder.
4516 * @param avctx the codec context
4517 * @param[out] sub The Preallocated AVSubtitle in which the decoded subtitle will be stored,
4518 * must be freed with avsubtitle_free if *got_sub_ptr is set.
4519 * @param[in,out] got_sub_ptr Zero if no subtitle could be decompressed, otherwise, it is nonzero.
4520 * @param[in] avpkt The input AVPacket containing the input buffer.
4522 int avcodec_decode_subtitle2(AVCodecContext *avctx, AVSubtitle *sub,
4527 * @defgroup lavc_parsing Frame parsing
4531 enum AVPictureStructure {
4532 AV_PICTURE_STRUCTURE_UNKNOWN, //< unknown
4533 AV_PICTURE_STRUCTURE_TOP_FIELD, //< coded as top field
4534 AV_PICTURE_STRUCTURE_BOTTOM_FIELD, //< coded as bottom field
4535 AV_PICTURE_STRUCTURE_FRAME, //< coded as frame
4538 typedef struct AVCodecParserContext {
4540 struct AVCodecParser *parser;
4541 int64_t frame_offset; /* offset of the current frame */
4542 int64_t cur_offset; /* current offset
4543 (incremented by each av_parser_parse()) */
4544 int64_t next_frame_offset; /* offset of the next frame */
4546 int pict_type; /* XXX: Put it back in AVCodecContext. */
4548 * This field is used for proper frame duration computation in lavf.
4549 * It signals, how much longer the frame duration of the current frame
4550 * is compared to normal frame duration.
4552 * frame_duration = (1 + repeat_pict) * time_base
4554 * It is used by codecs like H.264 to display telecined material.
4556 int repeat_pict; /* XXX: Put it back in AVCodecContext. */
4557 int64_t pts; /* pts of the current frame */
4558 int64_t dts; /* dts of the current frame */
4563 int fetch_timestamp;
4565 #define AV_PARSER_PTS_NB 4
4566 int cur_frame_start_index;
4567 int64_t cur_frame_offset[AV_PARSER_PTS_NB];
4568 int64_t cur_frame_pts[AV_PARSER_PTS_NB];
4569 int64_t cur_frame_dts[AV_PARSER_PTS_NB];
4572 #define PARSER_FLAG_COMPLETE_FRAMES 0x0001
4573 #define PARSER_FLAG_ONCE 0x0002
4574 /// Set if the parser has a valid file offset
4575 #define PARSER_FLAG_FETCHED_OFFSET 0x0004
4576 #define PARSER_FLAG_USE_CODEC_TS 0x1000
4578 int64_t offset; ///< byte offset from starting packet start
4579 int64_t cur_frame_end[AV_PARSER_PTS_NB];
4582 * Set by parser to 1 for key frames and 0 for non-key frames.
4583 * It is initialized to -1, so if the parser doesn't set this flag,
4584 * old-style fallback using AV_PICTURE_TYPE_I picture type as key frames
4590 * Time difference in stream time base units from the pts of this
4591 * packet to the point at which the output from the decoder has converged
4592 * independent from the availability of previous frames. That is, the
4593 * frames are virtually identical no matter if decoding started from
4594 * the very first frame or from this keyframe.
4595 * Is AV_NOPTS_VALUE if unknown.
4596 * This field is not the display duration of the current frame.
4597 * This field has no meaning if the packet does not have AV_PKT_FLAG_KEY
4600 * The purpose of this field is to allow seeking in streams that have no
4601 * keyframes in the conventional sense. It corresponds to the
4602 * recovery point SEI in H.264 and match_time_delta in NUT. It is also
4603 * essential for some types of subtitle streams to ensure that all
4604 * subtitles are correctly displayed after seeking.
4606 int64_t convergence_duration;
4608 // Timestamp generation support:
4610 * Synchronization point for start of timestamp generation.
4612 * Set to >0 for sync point, 0 for no sync point and <0 for undefined
4615 * For example, this corresponds to presence of H.264 buffering period
4621 * Offset of the current timestamp against last timestamp sync point in
4622 * units of AVCodecContext.time_base.
4624 * Set to INT_MIN when dts_sync_point unused. Otherwise, it must
4625 * contain a valid timestamp offset.
4627 * Note that the timestamp of sync point has usually a nonzero
4628 * dts_ref_dts_delta, which refers to the previous sync point. Offset of
4629 * the next frame after timestamp sync point will be usually 1.
4631 * For example, this corresponds to H.264 cpb_removal_delay.
4633 int dts_ref_dts_delta;
4636 * Presentation delay of current frame in units of AVCodecContext.time_base.
4638 * Set to INT_MIN when dts_sync_point unused. Otherwise, it must
4639 * contain valid non-negative timestamp delta (presentation time of a frame
4640 * must not lie in the past).
4642 * This delay represents the difference between decoding and presentation
4643 * time of the frame.
4645 * For example, this corresponds to H.264 dpb_output_delay.
4650 * Position of the packet in file.
4652 * Analogous to cur_frame_pts/dts
4654 int64_t cur_frame_pos[AV_PARSER_PTS_NB];
4657 * Byte position of currently parsed frame in stream.
4662 * Previous frame byte position.
4667 * Duration of the current frame.
4668 * For audio, this is in units of 1 / AVCodecContext.sample_rate.
4669 * For all other types, this is in units of AVCodecContext.time_base.
4673 enum AVFieldOrder field_order;
4676 * Indicate whether a picture is coded as a frame, top field or bottom field.
4678 * For example, H.264 field_pic_flag equal to 0 corresponds to
4679 * AV_PICTURE_STRUCTURE_FRAME. An H.264 picture with field_pic_flag
4680 * equal to 1 and bottom_field_flag equal to 0 corresponds to
4681 * AV_PICTURE_STRUCTURE_TOP_FIELD.
4683 enum AVPictureStructure picture_structure;
4686 * Picture number incremented in presentation or output order.
4687 * This field may be reinitialized at the first picture of a new sequence.
4689 * For example, this corresponds to H.264 PicOrderCnt.
4691 int output_picture_number;
4694 * Dimensions of the decoded video intended for presentation.
4700 * Dimensions of the coded video.
4706 * The format of the coded data, corresponds to enum AVPixelFormat for video
4707 * and for enum AVSampleFormat for audio.
4709 * Note that a decoder can have considerable freedom in how exactly it
4710 * decodes the data, so the format reported here might be different from the
4711 * one returned by a decoder.
4714 } AVCodecParserContext;
4716 typedef struct AVCodecParser {
4717 int codec_ids[5]; /* several codec IDs are permitted */
4719 int (*parser_init)(AVCodecParserContext *s);
4720 /* This callback never returns an error, a negative value means that
4721 * the frame start was in a previous packet. */
4722 int (*parser_parse)(AVCodecParserContext *s,
4723 AVCodecContext *avctx,
4724 const uint8_t **poutbuf, int *poutbuf_size,
4725 const uint8_t *buf, int buf_size);
4726 void (*parser_close)(AVCodecParserContext *s);
4727 int (*split)(AVCodecContext *avctx, const uint8_t *buf, int buf_size);
4728 struct AVCodecParser *next;
4731 AVCodecParser *av_parser_next(const AVCodecParser *c);
4733 void av_register_codec_parser(AVCodecParser *parser);
4734 AVCodecParserContext *av_parser_init(int codec_id);
4739 * @param s parser context.
4740 * @param avctx codec context.
4741 * @param poutbuf set to pointer to parsed buffer or NULL if not yet finished.
4742 * @param poutbuf_size set to size of parsed buffer or zero if not yet finished.
4743 * @param buf input buffer.
4744 * @param buf_size input length, to signal EOF, this should be 0 (so that the last frame can be output).
4745 * @param pts input presentation timestamp.
4746 * @param dts input decoding timestamp.
4747 * @param pos input byte position in stream.
4748 * @return the number of bytes of the input bitstream used.
4753 * len = av_parser_parse2(myparser, AVCodecContext, &data, &size,
4760 * decode_frame(data, size);
4764 int av_parser_parse2(AVCodecParserContext *s,
4765 AVCodecContext *avctx,
4766 uint8_t **poutbuf, int *poutbuf_size,
4767 const uint8_t *buf, int buf_size,
4768 int64_t pts, int64_t dts,
4772 * @return 0 if the output buffer is a subset of the input, 1 if it is allocated and must be freed
4773 * @deprecated use AVBitStreamFilter
4775 int av_parser_change(AVCodecParserContext *s,
4776 AVCodecContext *avctx,
4777 uint8_t **poutbuf, int *poutbuf_size,
4778 const uint8_t *buf, int buf_size, int keyframe);
4779 void av_parser_close(AVCodecParserContext *s);
4787 * @addtogroup lavc_encoding
4792 * Find a registered encoder with a matching codec ID.
4794 * @param id AVCodecID of the requested encoder
4795 * @return An encoder if one was found, NULL otherwise.
4797 AVCodec *avcodec_find_encoder(enum AVCodecID id);
4800 * Find a registered encoder with the specified name.
4802 * @param name name of the requested encoder
4803 * @return An encoder if one was found, NULL otherwise.
4805 AVCodec *avcodec_find_encoder_by_name(const char *name);
4807 #if FF_API_OLD_ENCODE_AUDIO
4809 * Encode an audio frame from samples into buf.
4811 * @deprecated Use avcodec_encode_audio2 instead.
4813 * @note The output buffer should be at least FF_MIN_BUFFER_SIZE bytes large.
4814 * However, for codecs with avctx->frame_size equal to 0 (e.g. PCM) the user
4815 * will know how much space is needed because it depends on the value passed
4816 * in buf_size as described below. In that case a lower value can be used.
4818 * @param avctx the codec context
4819 * @param[out] buf the output buffer
4820 * @param[in] buf_size the output buffer size
4821 * @param[in] samples the input buffer containing the samples
4822 * The number of samples read from this buffer is frame_size*channels,
4823 * both of which are defined in avctx.
4824 * For codecs which have avctx->frame_size equal to 0 (e.g. PCM) the number of
4825 * samples read from samples is equal to:
4826 * buf_size * 8 / (avctx->channels * av_get_bits_per_sample(avctx->codec_id))
4827 * This also implies that av_get_bits_per_sample() must not return 0 for these
4829 * @return On error a negative value is returned, on success zero or the number
4830 * of bytes used to encode the data read from the input buffer.
4832 int attribute_deprecated avcodec_encode_audio(AVCodecContext *avctx,
4833 uint8_t *buf, int buf_size,
4834 const short *samples);
4838 * Encode a frame of audio.
4840 * Takes input samples from frame and writes the next output packet, if
4841 * available, to avpkt. The output packet does not necessarily contain data for
4842 * the most recent frame, as encoders can delay, split, and combine input frames
4843 * internally as needed.
4845 * @param avctx codec context
4846 * @param avpkt output AVPacket.
4847 * The user can supply an output buffer by setting
4848 * avpkt->data and avpkt->size prior to calling the
4849 * function, but if the size of the user-provided data is not
4850 * large enough, encoding will fail. If avpkt->data and
4851 * avpkt->size are set, avpkt->destruct must also be set. All
4852 * other AVPacket fields will be reset by the encoder using
4853 * av_init_packet(). If avpkt->data is NULL, the encoder will
4854 * allocate it. The encoder will set avpkt->size to the size
4855 * of the output packet.
4857 * If this function fails or produces no output, avpkt will be
4858 * freed using av_free_packet() (i.e. avpkt->destruct will be
4859 * called to free the user supplied buffer).
4860 * @param[in] frame AVFrame containing the raw audio data to be encoded.
4861 * May be NULL when flushing an encoder that has the
4862 * AV_CODEC_CAP_DELAY capability set.
4863 * If AV_CODEC_CAP_VARIABLE_FRAME_SIZE is set, then each frame
4864 * can have any number of samples.
4865 * If it is not set, frame->nb_samples must be equal to
4866 * avctx->frame_size for all frames except the last.
4867 * The final frame may be smaller than avctx->frame_size.
4868 * @param[out] got_packet_ptr This field is set to 1 by libavcodec if the
4869 * output packet is non-empty, and to 0 if it is
4870 * empty. If the function returns an error, the
4871 * packet can be assumed to be invalid, and the
4872 * value of got_packet_ptr is undefined and should
4874 * @return 0 on success, negative error code on failure
4876 int avcodec_encode_audio2(AVCodecContext *avctx, AVPacket *avpkt,
4877 const AVFrame *frame, int *got_packet_ptr);
4879 #if FF_API_OLD_ENCODE_VIDEO
4881 * @deprecated use avcodec_encode_video2() instead.
4883 * Encode a video frame from pict into buf.
4884 * The input picture should be
4885 * stored using a specific format, namely avctx.pix_fmt.
4887 * @param avctx the codec context
4888 * @param[out] buf the output buffer for the bitstream of encoded frame
4889 * @param[in] buf_size the size of the output buffer in bytes
4890 * @param[in] pict the input picture to encode
4891 * @return On error a negative value is returned, on success zero or the number
4892 * of bytes used from the output buffer.
4894 attribute_deprecated
4895 int avcodec_encode_video(AVCodecContext *avctx, uint8_t *buf, int buf_size,
4896 const AVFrame *pict);
4900 * Encode a frame of video.
4902 * Takes input raw video data from frame and writes the next output packet, if
4903 * available, to avpkt. The output packet does not necessarily contain data for
4904 * the most recent frame, as encoders can delay and reorder input frames
4905 * internally as needed.
4907 * @param avctx codec context
4908 * @param avpkt output AVPacket.
4909 * The user can supply an output buffer by setting
4910 * avpkt->data and avpkt->size prior to calling the
4911 * function, but if the size of the user-provided data is not
4912 * large enough, encoding will fail. All other AVPacket fields
4913 * will be reset by the encoder using av_init_packet(). If
4914 * avpkt->data is NULL, the encoder will allocate it.
4915 * The encoder will set avpkt->size to the size of the
4916 * output packet. The returned data (if any) belongs to the
4917 * caller, he is responsible for freeing it.
4919 * If this function fails or produces no output, avpkt will be
4920 * freed using av_free_packet() (i.e. avpkt->destruct will be
4921 * called to free the user supplied buffer).
4922 * @param[in] frame AVFrame containing the raw video data to be encoded.
4923 * May be NULL when flushing an encoder that has the
4924 * AV_CODEC_CAP_DELAY capability set.
4925 * @param[out] got_packet_ptr This field is set to 1 by libavcodec if the
4926 * output packet is non-empty, and to 0 if it is
4927 * empty. If the function returns an error, the
4928 * packet can be assumed to be invalid, and the
4929 * value of got_packet_ptr is undefined and should
4931 * @return 0 on success, negative error code on failure
4933 int avcodec_encode_video2(AVCodecContext *avctx, AVPacket *avpkt,
4934 const AVFrame *frame, int *got_packet_ptr);
4936 int avcodec_encode_subtitle(AVCodecContext *avctx, uint8_t *buf, int buf_size,
4937 const AVSubtitle *sub);
4944 #if FF_API_AVCODEC_RESAMPLE
4946 * @defgroup lavc_resample Audio resampling
4948 * @deprecated use libswresample instead
4952 struct ReSampleContext;
4953 struct AVResampleContext;
4955 typedef struct ReSampleContext ReSampleContext;
4958 * Initialize audio resampling context.
4960 * @param output_channels number of output channels
4961 * @param input_channels number of input channels
4962 * @param output_rate output sample rate
4963 * @param input_rate input sample rate
4964 * @param sample_fmt_out requested output sample format
4965 * @param sample_fmt_in input sample format
4966 * @param filter_length length of each FIR filter in the filterbank relative to the cutoff frequency
4967 * @param log2_phase_count log2 of the number of entries in the polyphase filterbank
4968 * @param linear if 1 then the used FIR filter will be linearly interpolated
4969 between the 2 closest, if 0 the closest will be used
4970 * @param cutoff cutoff frequency, 1.0 corresponds to half the output sampling rate
4971 * @return allocated ReSampleContext, NULL if error occurred
4973 attribute_deprecated
4974 ReSampleContext *av_audio_resample_init(int output_channels, int input_channels,
4975 int output_rate, int input_rate,
4976 enum AVSampleFormat sample_fmt_out,
4977 enum AVSampleFormat sample_fmt_in,
4978 int filter_length, int log2_phase_count,
4979 int linear, double cutoff);
4981 attribute_deprecated
4982 int audio_resample(ReSampleContext *s, short *output, short *input, int nb_samples);
4985 * Free resample context.
4987 * @param s a non-NULL pointer to a resample context previously
4988 * created with av_audio_resample_init()
4990 attribute_deprecated
4991 void audio_resample_close(ReSampleContext *s);
4995 * Initialize an audio resampler.
4996 * Note, if either rate is not an integer then simply scale both rates up so they are.
4997 * @param filter_length length of each FIR filter in the filterbank relative to the cutoff freq
4998 * @param log2_phase_count log2 of the number of entries in the polyphase filterbank
4999 * @param linear If 1 then the used FIR filter will be linearly interpolated
5000 between the 2 closest, if 0 the closest will be used
5001 * @param cutoff cutoff frequency, 1.0 corresponds to half the output sampling rate
5003 attribute_deprecated
5004 struct AVResampleContext *av_resample_init(int out_rate, int in_rate, int filter_length, int log2_phase_count, int linear, double cutoff);
5007 * Resample an array of samples using a previously configured context.
5008 * @param src an array of unconsumed samples
5009 * @param consumed the number of samples of src which have been consumed are returned here
5010 * @param src_size the number of unconsumed samples available
5011 * @param dst_size the amount of space in samples available in dst
5012 * @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.
5013 * @return the number of samples written in dst or -1 if an error occurred
5015 attribute_deprecated
5016 int av_resample(struct AVResampleContext *c, short *dst, short *src, int *consumed, int src_size, int dst_size, int update_ctx);
5020 * Compensate samplerate/timestamp drift. The compensation is done by changing
5021 * the resampler parameters, so no audible clicks or similar distortions occur
5022 * @param compensation_distance distance in output samples over which the compensation should be performed
5023 * @param sample_delta number of output samples which should be output less
5025 * example: av_resample_compensate(c, 10, 500)
5026 * here instead of 510 samples only 500 samples would be output
5028 * note, due to rounding the actual compensation might be slightly different,
5029 * especially if the compensation_distance is large and the in_rate used during init is small
5031 attribute_deprecated
5032 void av_resample_compensate(struct AVResampleContext *c, int sample_delta, int compensation_distance);
5033 attribute_deprecated
5034 void av_resample_close(struct AVResampleContext *c);
5042 * @addtogroup lavc_picture
5047 * Allocate memory for the pixels of a picture and setup the AVPicture
5050 * Call avpicture_free() to free it.
5052 * @param picture the picture structure to be filled in
5053 * @param pix_fmt the pixel format of the picture
5054 * @param width the width of the picture
5055 * @param height the height of the picture
5056 * @return zero if successful, a negative error code otherwise
5058 * @see av_image_alloc(), avpicture_fill()
5060 int avpicture_alloc(AVPicture *picture, enum AVPixelFormat pix_fmt, int width, int height);
5063 * Free a picture previously allocated by avpicture_alloc().
5064 * The data buffer used by the AVPicture is freed, but the AVPicture structure
5067 * @param picture the AVPicture to be freed
5069 void avpicture_free(AVPicture *picture);
5072 * Setup the picture fields based on the specified image parameters
5073 * and the provided image data buffer.
5075 * The picture fields are filled in by using the image data buffer
5076 * pointed to by ptr.
5078 * If ptr is NULL, the function will fill only the picture linesize
5079 * array and return the required size for the image buffer.
5081 * To allocate an image buffer and fill the picture data in one call,
5082 * use avpicture_alloc().
5084 * @param picture the picture to be filled in
5085 * @param ptr buffer where the image data is stored, or NULL
5086 * @param pix_fmt the pixel format of the image
5087 * @param width the width of the image in pixels
5088 * @param height the height of the image in pixels
5089 * @return the size in bytes required for src, a negative error code
5090 * in case of failure
5092 * @see av_image_fill_arrays()
5094 int avpicture_fill(AVPicture *picture, const uint8_t *ptr,
5095 enum AVPixelFormat pix_fmt, int width, int height);
5098 * Copy pixel data from an AVPicture into a buffer.
5100 * avpicture_get_size() can be used to compute the required size for
5101 * the buffer to fill.
5103 * @param src source picture with filled data
5104 * @param pix_fmt picture pixel format
5105 * @param width picture width
5106 * @param height picture height
5107 * @param dest destination buffer
5108 * @param dest_size destination buffer size in bytes
5109 * @return the number of bytes written to dest, or a negative value
5110 * (error code) on error, for example if the destination buffer is not
5113 * @see av_image_copy_to_buffer()
5115 int avpicture_layout(const AVPicture *src, enum AVPixelFormat pix_fmt,
5116 int width, int height,
5117 unsigned char *dest, int dest_size);
5120 * Calculate the size in bytes that a picture of the given width and height
5121 * would occupy if stored in the given picture format.
5123 * @param pix_fmt picture pixel format
5124 * @param width picture width
5125 * @param height picture height
5126 * @return the computed picture buffer size or a negative error code
5129 * @see av_image_get_buffer_size().
5131 int avpicture_get_size(enum AVPixelFormat pix_fmt, int width, int height);
5133 #if FF_API_DEINTERLACE
5135 * deinterlace - if not supported return -1
5137 * @deprecated - use yadif (in libavfilter) instead
5139 attribute_deprecated
5140 int avpicture_deinterlace(AVPicture *dst, const AVPicture *src,
5141 enum AVPixelFormat pix_fmt, int width, int height);
5144 * Copy image src to dst. Wraps av_image_copy().
5146 void av_picture_copy(AVPicture *dst, const AVPicture *src,
5147 enum AVPixelFormat pix_fmt, int width, int height);
5150 * Crop image top and left side.
5152 int av_picture_crop(AVPicture *dst, const AVPicture *src,
5153 enum AVPixelFormat pix_fmt, int top_band, int left_band);
5158 int av_picture_pad(AVPicture *dst, const AVPicture *src, int height, int width, enum AVPixelFormat pix_fmt,
5159 int padtop, int padbottom, int padleft, int padright, int *color);
5166 * @defgroup lavc_misc Utility functions
5169 * Miscellaneous utility functions related to both encoding and decoding
5175 * @defgroup lavc_misc_pixfmt Pixel formats
5177 * Functions for working with pixel formats.
5182 * Utility function to access log2_chroma_w log2_chroma_h from
5183 * the pixel format AVPixFmtDescriptor.
5185 * This function asserts that pix_fmt is valid. See av_pix_fmt_get_chroma_sub_sample
5186 * for one that returns a failure code and continues in case of invalid
5189 * @param[in] pix_fmt the pixel format
5190 * @param[out] h_shift store log2_chroma_w
5191 * @param[out] v_shift store log2_chroma_h
5193 * @see av_pix_fmt_get_chroma_sub_sample
5196 void avcodec_get_chroma_sub_sample(enum AVPixelFormat pix_fmt, int *h_shift, int *v_shift);
5199 * Return a value representing the fourCC code associated to the
5200 * pixel format pix_fmt, or 0 if no associated fourCC code can be
5203 unsigned int avcodec_pix_fmt_to_codec_tag(enum AVPixelFormat pix_fmt);
5206 * @deprecated see av_get_pix_fmt_loss()
5208 int avcodec_get_pix_fmt_loss(enum AVPixelFormat dst_pix_fmt, enum AVPixelFormat src_pix_fmt,
5212 * Find the best pixel format to convert to given a certain source pixel
5213 * format. When converting from one pixel format to another, information loss
5214 * may occur. For example, when converting from RGB24 to GRAY, the color
5215 * information will be lost. Similarly, other losses occur when converting from
5216 * some formats to other formats. avcodec_find_best_pix_fmt_of_2() searches which of
5217 * the given pixel formats should be used to suffer the least amount of loss.
5218 * The pixel formats from which it chooses one, are determined by the
5219 * pix_fmt_list parameter.
5222 * @param[in] pix_fmt_list AV_PIX_FMT_NONE terminated array of pixel formats to choose from
5223 * @param[in] src_pix_fmt source pixel format
5224 * @param[in] has_alpha Whether the source pixel format alpha channel is used.
5225 * @param[out] loss_ptr Combination of flags informing you what kind of losses will occur.
5226 * @return The best pixel format to convert to or -1 if none was found.
5228 enum AVPixelFormat avcodec_find_best_pix_fmt_of_list(const enum AVPixelFormat *pix_fmt_list,
5229 enum AVPixelFormat src_pix_fmt,
5230 int has_alpha, int *loss_ptr);
5233 * @deprecated see av_find_best_pix_fmt_of_2()
5235 enum AVPixelFormat avcodec_find_best_pix_fmt_of_2(enum AVPixelFormat dst_pix_fmt1, enum AVPixelFormat dst_pix_fmt2,
5236 enum AVPixelFormat src_pix_fmt, int has_alpha, int *loss_ptr);
5238 attribute_deprecated
5239 #if AV_HAVE_INCOMPATIBLE_LIBAV_ABI
5240 enum AVPixelFormat avcodec_find_best_pix_fmt2(const enum AVPixelFormat *pix_fmt_list,
5241 enum AVPixelFormat src_pix_fmt,
5242 int has_alpha, int *loss_ptr);
5244 enum AVPixelFormat avcodec_find_best_pix_fmt2(enum AVPixelFormat dst_pix_fmt1, enum AVPixelFormat dst_pix_fmt2,
5245 enum AVPixelFormat src_pix_fmt, int has_alpha, int *loss_ptr);
5249 enum AVPixelFormat avcodec_default_get_format(struct AVCodecContext *s, const enum AVPixelFormat * fmt);
5255 #if FF_API_SET_DIMENSIONS
5257 * @deprecated this function is not supposed to be used from outside of lavc
5259 attribute_deprecated
5260 void avcodec_set_dimensions(AVCodecContext *s, int width, int height);
5264 * Put a string representing the codec tag codec_tag in buf.
5266 * @param buf buffer to place codec tag in
5267 * @param buf_size size in bytes of buf
5268 * @param codec_tag codec tag to assign
5269 * @return the length of the string that would have been generated if
5270 * enough space had been available, excluding the trailing null
5272 size_t av_get_codec_tag_string(char *buf, size_t buf_size, unsigned int codec_tag);
5274 void avcodec_string(char *buf, int buf_size, AVCodecContext *enc, int encode);
5277 * Return a name for the specified profile, if available.
5279 * @param codec the codec that is searched for the given profile
5280 * @param profile the profile value for which a name is requested
5281 * @return A name for the profile if found, NULL otherwise.
5283 const char *av_get_profile_name(const AVCodec *codec, int profile);
5285 int avcodec_default_execute(AVCodecContext *c, int (*func)(AVCodecContext *c2, void *arg2),void *arg, int *ret, int count, int size);
5286 int avcodec_default_execute2(AVCodecContext *c, int (*func)(AVCodecContext *c2, void *arg2, int, int),void *arg, int *ret, int count);
5287 //FIXME func typedef
5290 * Fill AVFrame audio data and linesize pointers.
5292 * The buffer buf must be a preallocated buffer with a size big enough
5293 * to contain the specified samples amount. The filled AVFrame data
5294 * pointers will point to this buffer.
5296 * AVFrame extended_data channel pointers are allocated if necessary for
5299 * @param frame the AVFrame
5300 * frame->nb_samples must be set prior to calling the
5301 * function. This function fills in frame->data,
5302 * frame->extended_data, frame->linesize[0].
5303 * @param nb_channels channel count
5304 * @param sample_fmt sample format
5305 * @param buf buffer to use for frame data
5306 * @param buf_size size of buffer
5307 * @param align plane size sample alignment (0 = default)
5308 * @return >=0 on success, negative error code on failure
5309 * @todo return the size in bytes required to store the samples in
5310 * case of success, at the next libavutil bump
5312 int avcodec_fill_audio_frame(AVFrame *frame, int nb_channels,
5313 enum AVSampleFormat sample_fmt, const uint8_t *buf,
5314 int buf_size, int align);
5317 * Reset the internal decoder state / flush internal buffers. Should be called
5318 * e.g. when seeking or when switching to a different stream.
5320 * @note when refcounted frames are not used (i.e. avctx->refcounted_frames is 0),
5321 * this invalidates the frames previously returned from the decoder. When
5322 * refcounted frames are used, the decoder just releases any references it might
5323 * keep internally, but the caller's reference remains valid.
5325 void avcodec_flush_buffers(AVCodecContext *avctx);
5328 * Return codec bits per sample.
5330 * @param[in] codec_id the codec
5331 * @return Number of bits per sample or zero if unknown for the given codec.
5333 int av_get_bits_per_sample(enum AVCodecID codec_id);
5336 * Return the PCM codec associated with a sample format.
5337 * @param be endianness, 0 for little, 1 for big,
5338 * -1 (or anything else) for native
5339 * @return AV_CODEC_ID_PCM_* or AV_CODEC_ID_NONE
5341 enum AVCodecID av_get_pcm_codec(enum AVSampleFormat fmt, int be);
5344 * Return codec bits per sample.
5345 * Only return non-zero if the bits per sample is exactly correct, not an
5348 * @param[in] codec_id the codec
5349 * @return Number of bits per sample or zero if unknown for the given codec.
5351 int av_get_exact_bits_per_sample(enum AVCodecID codec_id);
5354 * Return audio frame duration.
5356 * @param avctx codec context
5357 * @param frame_bytes size of the frame, or 0 if unknown
5358 * @return frame duration, in samples, if known. 0 if not able to
5361 int av_get_audio_frame_duration(AVCodecContext *avctx, int frame_bytes);
5364 typedef struct AVBitStreamFilterContext {
5366 struct AVBitStreamFilter *filter;
5367 AVCodecParserContext *parser;
5368 struct AVBitStreamFilterContext *next;
5369 } AVBitStreamFilterContext;
5372 typedef struct AVBitStreamFilter {
5375 int (*filter)(AVBitStreamFilterContext *bsfc,
5376 AVCodecContext *avctx, const char *args,
5377 uint8_t **poutbuf, int *poutbuf_size,
5378 const uint8_t *buf, int buf_size, int keyframe);
5379 void (*close)(AVBitStreamFilterContext *bsfc);
5380 struct AVBitStreamFilter *next;
5381 } AVBitStreamFilter;
5384 * Register a bitstream filter.
5386 * The filter will be accessible to the application code through
5387 * av_bitstream_filter_next() or can be directly initialized with
5388 * av_bitstream_filter_init().
5390 * @see avcodec_register_all()
5392 void av_register_bitstream_filter(AVBitStreamFilter *bsf);
5395 * Create and initialize a bitstream filter context given a bitstream
5398 * The returned context must be freed with av_bitstream_filter_close().
5400 * @param name the name of the bitstream filter
5401 * @return a bitstream filter context if a matching filter was found
5402 * and successfully initialized, NULL otherwise
5404 AVBitStreamFilterContext *av_bitstream_filter_init(const char *name);
5409 * This function filters the buffer buf with size buf_size, and places the
5410 * filtered buffer in the buffer pointed to by poutbuf.
5412 * The output buffer must be freed by the caller.
5414 * @param bsfc bitstream filter context created by av_bitstream_filter_init()
5415 * @param avctx AVCodecContext accessed by the filter, may be NULL.
5416 * If specified, this must point to the encoder context of the
5417 * output stream the packet is sent to.
5418 * @param args arguments which specify the filter configuration, may be NULL
5419 * @param poutbuf pointer which is updated to point to the filtered buffer
5420 * @param poutbuf_size pointer which is updated to the filtered buffer size in bytes
5421 * @param buf buffer containing the data to filter
5422 * @param buf_size size in bytes of buf
5423 * @param keyframe set to non-zero if the buffer to filter corresponds to a key-frame packet data
5424 * @return >= 0 in case of success, or a negative error code in case of failure
5426 * If the return value is positive, an output buffer is allocated and
5427 * is available in *poutbuf, and is distinct from the input buffer.
5429 * If the return value is 0, the output buffer is not allocated and
5430 * should be considered identical to the input buffer, or in case
5431 * *poutbuf was set it points to the input buffer (not necessarily to
5432 * its starting address).
5434 int av_bitstream_filter_filter(AVBitStreamFilterContext *bsfc,
5435 AVCodecContext *avctx, const char *args,
5436 uint8_t **poutbuf, int *poutbuf_size,
5437 const uint8_t *buf, int buf_size, int keyframe);
5440 * Release bitstream filter context.
5442 * @param bsf the bitstream filter context created with
5443 * av_bitstream_filter_init(), can be NULL
5445 void av_bitstream_filter_close(AVBitStreamFilterContext *bsf);
5448 * If f is NULL, return the first registered bitstream filter,
5449 * if f is non-NULL, return the next registered bitstream filter
5450 * after f, or NULL if f is the last one.
5452 * This function can be used to iterate over all registered bitstream
5455 AVBitStreamFilter *av_bitstream_filter_next(const AVBitStreamFilter *f);
5460 * Same behaviour av_fast_malloc but the buffer has additional
5461 * AV_INPUT_BUFFER_PADDING_SIZE at the end which will always be 0.
5463 * In addition the whole buffer will initially and after resizes
5464 * be 0-initialized so that no uninitialized data will ever appear.
5466 void av_fast_padded_malloc(void *ptr, unsigned int *size, size_t min_size);
5469 * Same behaviour av_fast_padded_malloc except that buffer will always
5470 * be 0-initialized after call.
5472 void av_fast_padded_mallocz(void *ptr, unsigned int *size, size_t min_size);
5475 * Encode extradata length to a buffer. Used by xiph codecs.
5477 * @param s buffer to write to; must be at least (v/255+1) bytes long
5478 * @param v size of extradata in bytes
5479 * @return number of bytes written to the buffer.
5481 unsigned int av_xiphlacing(unsigned char *s, unsigned int v);
5483 #if FF_API_MISSING_SAMPLE
5485 * Log a generic warning message about a missing feature. This function is
5486 * intended to be used internally by FFmpeg (libavcodec, libavformat, etc.)
5487 * only, and would normally not be used by applications.
5488 * @param[in] avc a pointer to an arbitrary struct of which the first field is
5489 * a pointer to an AVClass struct
5490 * @param[in] feature string containing the name of the missing feature
5491 * @param[in] want_sample indicates if samples are wanted which exhibit this feature.
5492 * If want_sample is non-zero, additional verbage will be added to the log
5493 * message which tells the user how to report samples to the development
5495 * @deprecated Use avpriv_report_missing_feature() instead.
5497 attribute_deprecated
5498 void av_log_missing_feature(void *avc, const char *feature, int want_sample);
5501 * Log a generic warning message asking for a sample. This function is
5502 * intended to be used internally by FFmpeg (libavcodec, libavformat, etc.)
5503 * only, and would normally not be used by applications.
5504 * @param[in] avc a pointer to an arbitrary struct of which the first field is
5505 * a pointer to an AVClass struct
5506 * @param[in] msg string containing an optional message, or NULL if no message
5507 * @deprecated Use avpriv_request_sample() instead.
5509 attribute_deprecated
5510 void av_log_ask_for_sample(void *avc, const char *msg, ...) av_printf_format(2, 3);
5511 #endif /* FF_API_MISSING_SAMPLE */
5514 * Register the hardware accelerator hwaccel.
5516 void av_register_hwaccel(AVHWAccel *hwaccel);
5519 * If hwaccel is NULL, returns the first registered hardware accelerator,
5520 * if hwaccel is non-NULL, returns the next registered hardware accelerator
5521 * after hwaccel, or NULL if hwaccel is the last one.
5523 AVHWAccel *av_hwaccel_next(const AVHWAccel *hwaccel);
5527 * Lock operation used by lockmgr
5530 AV_LOCK_CREATE, ///< Create a mutex
5531 AV_LOCK_OBTAIN, ///< Lock the mutex
5532 AV_LOCK_RELEASE, ///< Unlock the mutex
5533 AV_LOCK_DESTROY, ///< Free mutex resources
5537 * Register a user provided lock manager supporting the operations
5538 * specified by AVLockOp. The "mutex" argument to the function points
5539 * to a (void *) where the lockmgr should store/get a pointer to a user
5540 * allocated mutex. It is NULL upon AV_LOCK_CREATE and equal to the
5541 * value left by the last call for all other ops. If the lock manager is
5542 * unable to perform the op then it should leave the mutex in the same
5543 * state as when it was called and return a non-zero value. However,
5544 * when called with AV_LOCK_DESTROY the mutex will always be assumed to
5545 * have been successfully destroyed. If av_lockmgr_register succeeds
5546 * it will return a non-negative value, if it fails it will return a
5547 * negative value and destroy all mutex and unregister all callbacks.
5548 * av_lockmgr_register is not thread-safe, it must be called from a
5549 * single thread before any calls which make use of locking are used.
5551 * @param cb User defined callback. av_lockmgr_register invokes calls
5552 * to this callback and the previously registered callback.
5553 * The callback will be used to create more than one mutex
5554 * each of which must be backed by its own underlying locking
5555 * mechanism (i.e. do not use a single static object to
5556 * implement your lock manager). If cb is set to NULL the
5557 * lockmgr will be unregistered.
5559 int av_lockmgr_register(int (*cb)(void **mutex, enum AVLockOp op));
5562 * Get the type of the given codec.
5564 enum AVMediaType avcodec_get_type(enum AVCodecID codec_id);
5567 * Get the name of a codec.
5568 * @return a static string identifying the codec; never NULL
5570 const char *avcodec_get_name(enum AVCodecID id);
5573 * @return a positive value if s is open (i.e. avcodec_open2() was called on it
5574 * with no corresponding avcodec_close()), 0 otherwise.
5576 int avcodec_is_open(AVCodecContext *s);
5579 * @return a non-zero number if codec is an encoder, zero otherwise
5581 int av_codec_is_encoder(const AVCodec *codec);
5584 * @return a non-zero number if codec is a decoder, zero otherwise
5586 int av_codec_is_decoder(const AVCodec *codec);
5589 * @return descriptor for given codec ID or NULL if no descriptor exists.
5591 const AVCodecDescriptor *avcodec_descriptor_get(enum AVCodecID id);
5594 * Iterate over all codec descriptors known to libavcodec.
5596 * @param prev previous descriptor. NULL to get the first descriptor.
5598 * @return next descriptor or NULL after the last descriptor
5600 const AVCodecDescriptor *avcodec_descriptor_next(const AVCodecDescriptor *prev);
5603 * @return codec descriptor with the given name or NULL if no such descriptor
5606 const AVCodecDescriptor *avcodec_descriptor_get_by_name(const char *name);
5612 #endif /* AVCODEC_AVCODEC_H */