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 FF_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 FF_MIN_BUFFER_SIZE 16384
646 * @ingroup lavc_encoding
647 * motion estimation type.
650 ME_ZERO = 1, ///< no search, that is use 0,0 vector whenever one is needed
654 ME_EPZS, ///< enhanced predictive zonal search
655 ME_X1, ///< reserved for experiments
656 ME_HEX, ///< hexagon based search
657 ME_UMH, ///< uneven multi-hexagon search
658 ME_TESA, ///< transformed exhaustive search algorithm
659 ME_ITER=50, ///< iterative search
663 * @ingroup lavc_decoding
666 /* We leave some space between them for extensions (drop some
667 * keyframes for intra-only or drop just some bidir frames). */
668 AVDISCARD_NONE =-16, ///< discard nothing
669 AVDISCARD_DEFAULT = 0, ///< discard useless packets like 0 size packets in avi
670 AVDISCARD_NONREF = 8, ///< discard all non reference
671 AVDISCARD_BIDIR = 16, ///< discard all bidirectional frames
672 AVDISCARD_NONINTRA= 24, ///< discard all non intra frames
673 AVDISCARD_NONKEY = 32, ///< discard all frames except keyframes
674 AVDISCARD_ALL = 48, ///< discard all
677 enum AVAudioServiceType {
678 AV_AUDIO_SERVICE_TYPE_MAIN = 0,
679 AV_AUDIO_SERVICE_TYPE_EFFECTS = 1,
680 AV_AUDIO_SERVICE_TYPE_VISUALLY_IMPAIRED = 2,
681 AV_AUDIO_SERVICE_TYPE_HEARING_IMPAIRED = 3,
682 AV_AUDIO_SERVICE_TYPE_DIALOGUE = 4,
683 AV_AUDIO_SERVICE_TYPE_COMMENTARY = 5,
684 AV_AUDIO_SERVICE_TYPE_EMERGENCY = 6,
685 AV_AUDIO_SERVICE_TYPE_VOICE_OVER = 7,
686 AV_AUDIO_SERVICE_TYPE_KARAOKE = 8,
687 AV_AUDIO_SERVICE_TYPE_NB , ///< Not part of ABI
691 * @ingroup lavc_encoding
693 typedef struct RcOverride{
696 int qscale; // If this is 0 then quality_factor will be used instead.
697 float quality_factor;
700 #if FF_API_MAX_BFRAMES
702 * @deprecated there is no libavcodec-wide limit on the number of B-frames
704 #define FF_MAX_B_FRAMES 16
708 These flags can be passed in AVCodecContext.flags before initialization.
709 Note: Not everything is supported yet.
713 * Allow decoders to produce frames with data planes that are not aligned
714 * to CPU requirements (e.g. due to cropping).
716 #define CODEC_FLAG_UNALIGNED 0x0001
717 #define CODEC_FLAG_QSCALE 0x0002 ///< Use fixed qscale.
718 #define CODEC_FLAG_4MV 0x0004 ///< 4 MV per MB allowed / advanced prediction for H.263.
719 #define CODEC_FLAG_OUTPUT_CORRUPT 0x0008 ///< Output even those frames that might be corrupted
720 #define CODEC_FLAG_QPEL 0x0010 ///< Use qpel MC.
723 * @deprecated use the "gmc" private option of the libxvid encoder
725 #define CODEC_FLAG_GMC 0x0020 ///< Use GMC.
729 * @deprecated use the flag "mv0" in the "mpv_flags" private option of the
732 #define CODEC_FLAG_MV0 0x0040
734 #if FF_API_INPUT_PRESERVED
736 * @deprecated passing reference-counted frames to the encoders replaces this
739 #define CODEC_FLAG_INPUT_PRESERVED 0x0100
741 #define CODEC_FLAG_PASS1 0x0200 ///< Use internal 2pass ratecontrol in first pass mode.
742 #define CODEC_FLAG_PASS2 0x0400 ///< Use internal 2pass ratecontrol in second pass mode.
743 #define CODEC_FLAG_GRAY 0x2000 ///< Only decode/encode grayscale.
746 * @deprecated edges are not used/required anymore. I.e. this flag is now always
749 #define CODEC_FLAG_EMU_EDGE 0x4000
751 #define CODEC_FLAG_PSNR 0x8000 ///< error[?] variables will be set during encoding.
752 #define CODEC_FLAG_TRUNCATED 0x00010000 /** Input bitstream might be truncated at a random
753 location instead of only at frame boundaries. */
754 #if FF_API_NORMALIZE_AQP
756 * @deprecated use the flag "naq" in the "mpv_flags" private option of the
759 #define CODEC_FLAG_NORMALIZE_AQP 0x00020000
761 #define CODEC_FLAG_INTERLACED_DCT 0x00040000 ///< Use interlaced DCT.
762 #define CODEC_FLAG_LOW_DELAY 0x00080000 ///< Force low delay.
763 #define CODEC_FLAG_GLOBAL_HEADER 0x00400000 ///< Place global headers in extradata instead of every keyframe.
764 #define CODEC_FLAG_BITEXACT 0x00800000 ///< Use only bitexact stuff (except (I)DCT).
765 /* Fx : Flag for h263+ extra options */
766 #define CODEC_FLAG_AC_PRED 0x01000000 ///< H.263 advanced intra coding / MPEG-4 AC prediction
767 #define CODEC_FLAG_LOOP_FILTER 0x00000800 ///< loop filter
768 #define CODEC_FLAG_INTERLACED_ME 0x20000000 ///< interlaced motion estimation
769 #define CODEC_FLAG_CLOSED_GOP 0x80000000
770 #define CODEC_FLAG2_FAST 0x00000001 ///< Allow non spec compliant speedup tricks.
771 #define CODEC_FLAG2_NO_OUTPUT 0x00000004 ///< Skip bitstream encoding.
772 #define CODEC_FLAG2_LOCAL_HEADER 0x00000008 ///< Place global headers at every keyframe instead of in extradata.
773 #define CODEC_FLAG2_DROP_FRAME_TIMECODE 0x00002000 ///< timecode is in drop frame format. DEPRECATED!!!!
774 #define CODEC_FLAG2_IGNORE_CROP 0x00010000 ///< Discard cropping information from SPS.
776 #define CODEC_FLAG2_CHUNKS 0x00008000 ///< Input bitstream might be truncated at a packet boundaries instead of only at frame boundaries.
777 #define CODEC_FLAG2_SHOW_ALL 0x00400000 ///< Show all frames before the first keyframe
778 #define CODEC_FLAG2_EXPORT_MVS 0x10000000 ///< Export motion vectors through frame side data
779 #define CODEC_FLAG2_SKIP_MANUAL 0x20000000 ///< Do not skip samples and export skip information as frame side data
781 /* Unsupported options :
782 * Syntax Arithmetic coding (SAC)
783 * Reference Picture Selection
784 * Independent Segment Decoding */
786 /* codec capabilities */
788 #define CODEC_CAP_DRAW_HORIZ_BAND 0x0001 ///< Decoder can use draw_horiz_band callback.
790 * Codec uses get_buffer() for allocating buffers and supports custom allocators.
791 * If not set, it might not use get_buffer() at all or use operations that
792 * assume the buffer was allocated by avcodec_default_get_buffer.
794 #define CODEC_CAP_DR1 0x0002
795 #define CODEC_CAP_TRUNCATED 0x0008
797 /* Codec can export data for HW decoding. This flag indicates that
798 * the codec would call get_format() with list that might contain HW accelerated
799 * pixel formats (XvMC, VDPAU, VAAPI, etc). The application can pick any of them
800 * including raw image format.
801 * The application can use the passed context to determine bitstream version,
802 * chroma format, resolution etc.
804 #define CODEC_CAP_HWACCEL 0x0010
805 #endif /* FF_API_XVMC */
807 * Encoder or decoder requires flushing with NULL input at the end in order to
808 * give the complete and correct output.
810 * NOTE: If this flag is not set, the codec is guaranteed to never be fed with
811 * with NULL data. The user can still send NULL data to the public encode
812 * or decode function, but libavcodec will not pass it along to the codec
813 * unless this flag is set.
816 * The decoder has a non-zero delay and needs to be fed with avpkt->data=NULL,
817 * avpkt->size=0 at the end to get the delayed data until the decoder no longer
821 * The encoder needs to be fed with NULL data at the end of encoding until the
822 * encoder no longer returns data.
824 * NOTE: For encoders implementing the AVCodec.encode2() function, setting this
825 * flag also means that the encoder must set the pts and duration for
826 * each output packet. If this flag is not set, the pts and duration will
827 * be determined by libavcodec from the input frame.
829 #define CODEC_CAP_DELAY 0x0020
831 * Codec can be fed a final frame with a smaller size.
832 * This can be used to prevent truncation of the last audio samples.
834 #define CODEC_CAP_SMALL_LAST_FRAME 0x0040
837 * Codec can export data for HW decoding (VDPAU).
839 #define CODEC_CAP_HWACCEL_VDPAU 0x0080
842 * Codec can output multiple frames per AVPacket
843 * Normally demuxers return one frame at a time, demuxers which do not do
844 * are connected to a parser to split what they return into proper frames.
845 * This flag is reserved to the very rare category of codecs which have a
846 * bitstream that cannot be split into frames without timeconsuming
847 * operations like full decoding. Demuxers carring such bitstreams thus
848 * may return multiple frames in a packet. This has many disadvantages like
849 * prohibiting stream copy in many cases thus it should only be considered
852 #define CODEC_CAP_SUBFRAMES 0x0100
854 * Codec is experimental and is thus avoided in favor of non experimental
857 #define CODEC_CAP_EXPERIMENTAL 0x0200
859 * Codec should fill in channel configuration and samplerate instead of container
861 #define CODEC_CAP_CHANNEL_CONF 0x0400
862 #if FF_API_NEG_LINESIZES
864 * @deprecated no codecs use this capability
866 #define CODEC_CAP_NEG_LINESIZES 0x0800
869 * Codec supports frame-level multithreading.
871 #define CODEC_CAP_FRAME_THREADS 0x1000
873 * Codec supports slice-based (or partition-based) multithreading.
875 #define CODEC_CAP_SLICE_THREADS 0x2000
877 * Codec supports changed parameters at any point.
879 #define CODEC_CAP_PARAM_CHANGE 0x4000
881 * Codec supports avctx->thread_count == 0 (auto).
883 #define CODEC_CAP_AUTO_THREADS 0x8000
885 * Audio encoder supports receiving a different number of samples in each call.
887 #define CODEC_CAP_VARIABLE_FRAME_SIZE 0x10000
889 * Codec is intra only.
891 #define CODEC_CAP_INTRA_ONLY 0x40000000
895 #define CODEC_CAP_LOSSLESS 0x80000000
898 * HWAccel is experimental and is thus avoided in favor of non experimental
901 #define HWACCEL_CODEC_CAP_EXPERIMENTAL 0x0200
904 //The following defines may change, don't expect compatibility if you use them.
905 #define MB_TYPE_INTRA4x4 0x0001
906 #define MB_TYPE_INTRA16x16 0x0002 //FIXME H.264-specific
907 #define MB_TYPE_INTRA_PCM 0x0004 //FIXME H.264-specific
908 #define MB_TYPE_16x16 0x0008
909 #define MB_TYPE_16x8 0x0010
910 #define MB_TYPE_8x16 0x0020
911 #define MB_TYPE_8x8 0x0040
912 #define MB_TYPE_INTERLACED 0x0080
913 #define MB_TYPE_DIRECT2 0x0100 //FIXME
914 #define MB_TYPE_ACPRED 0x0200
915 #define MB_TYPE_GMC 0x0400
916 #define MB_TYPE_SKIP 0x0800
917 #define MB_TYPE_P0L0 0x1000
918 #define MB_TYPE_P1L0 0x2000
919 #define MB_TYPE_P0L1 0x4000
920 #define MB_TYPE_P1L1 0x8000
921 #define MB_TYPE_L0 (MB_TYPE_P0L0 | MB_TYPE_P1L0)
922 #define MB_TYPE_L1 (MB_TYPE_P0L1 | MB_TYPE_P1L1)
923 #define MB_TYPE_L0L1 (MB_TYPE_L0 | MB_TYPE_L1)
924 #define MB_TYPE_QUANT 0x00010000
925 #define MB_TYPE_CBP 0x00020000
926 //Note bits 24-31 are reserved for codec specific use (h264 ref0, mpeg1 0mv, ...)
931 * This specifies the area which should be displayed.
932 * Note there may be multiple such areas for one frame.
934 typedef struct AVPanScan{
937 * - encoding: Set by user.
938 * - decoding: Set by libavcodec.
943 * width and height in 1/16 pel
944 * - encoding: Set by user.
945 * - decoding: Set by libavcodec.
951 * position of the top left corner in 1/16 pel for up to 3 fields/frames
952 * - encoding: Set by user.
953 * - decoding: Set by libavcodec.
955 int16_t position[3][2];
958 #if FF_API_QSCALE_TYPE
959 #define FF_QSCALE_TYPE_MPEG1 0
960 #define FF_QSCALE_TYPE_MPEG2 1
961 #define FF_QSCALE_TYPE_H264 2
962 #define FF_QSCALE_TYPE_VP56 3
965 #if FF_API_GET_BUFFER
966 #define FF_BUFFER_TYPE_INTERNAL 1
967 #define FF_BUFFER_TYPE_USER 2 ///< direct rendering buffers (image is (de)allocated by user)
968 #define FF_BUFFER_TYPE_SHARED 4 ///< Buffer from somewhere else; don't deallocate image (data/base), all other tables are not shared.
969 #define FF_BUFFER_TYPE_COPY 8 ///< Just a (modified) copy of some other buffer, don't deallocate anything.
971 #define FF_BUFFER_HINTS_VALID 0x01 // Buffer hints value is meaningful (if 0 ignore).
972 #define FF_BUFFER_HINTS_READABLE 0x02 // Codec will read from buffer.
973 #define FF_BUFFER_HINTS_PRESERVE 0x04 // User must not alter buffer content.
974 #define FF_BUFFER_HINTS_REUSABLE 0x08 // Codec will reuse the buffer (update).
978 * The decoder will keep a reference to the frame and may reuse it later.
980 #define AV_GET_BUFFER_FLAG_REF (1 << 0)
983 * @defgroup lavc_packet AVPacket
985 * Types and functions for working with AVPacket.
988 enum AVPacketSideDataType {
990 AV_PKT_DATA_NEW_EXTRADATA,
993 * An AV_PKT_DATA_PARAM_CHANGE side data packet is laid out as follows:
996 * if (param_flags & AV_SIDE_DATA_PARAM_CHANGE_CHANNEL_COUNT)
997 * s32le channel_count
998 * if (param_flags & AV_SIDE_DATA_PARAM_CHANGE_CHANNEL_LAYOUT)
999 * u64le channel_layout
1000 * if (param_flags & AV_SIDE_DATA_PARAM_CHANGE_SAMPLE_RATE)
1002 * if (param_flags & AV_SIDE_DATA_PARAM_CHANGE_DIMENSIONS)
1007 AV_PKT_DATA_PARAM_CHANGE,
1010 * An AV_PKT_DATA_H263_MB_INFO side data packet contains a number of
1011 * structures with info about macroblocks relevant to splitting the
1012 * packet into smaller packets on macroblock edges (e.g. as for RFC 2190).
1013 * That is, it does not necessarily contain info about all macroblocks,
1014 * as long as the distance between macroblocks in the info is smaller
1015 * than the target payload size.
1016 * Each MB info structure is 12 bytes, and is laid out as follows:
1018 * u32le bit offset from the start of the packet
1019 * u8 current quantizer at the start of the macroblock
1021 * u16le macroblock address within the GOB
1022 * u8 horizontal MV predictor
1023 * u8 vertical MV predictor
1024 * u8 horizontal MV predictor for block number 3
1025 * u8 vertical MV predictor for block number 3
1028 AV_PKT_DATA_H263_MB_INFO,
1031 * This side data should be associated with an audio stream and contains
1032 * ReplayGain information in form of the AVReplayGain struct.
1034 AV_PKT_DATA_REPLAYGAIN,
1037 * This side data contains a 3x3 transformation matrix describing an affine
1038 * transformation that needs to be applied to the decoded video frames for
1039 * correct presentation.
1041 * See libavutil/display.h for a detailed description of the data.
1043 AV_PKT_DATA_DISPLAYMATRIX,
1046 * This side data should be associated with a video stream and contains
1047 * Stereoscopic 3D information in form of the AVStereo3D struct.
1049 AV_PKT_DATA_STEREO3D,
1052 * This side data should be associated with an audio stream and corresponds
1053 * to enum AVAudioServiceType.
1055 AV_PKT_DATA_AUDIO_SERVICE_TYPE,
1058 * Recommmends skipping the specified number of samples
1060 * u32le number of samples to skip from start of this packet
1061 * u32le number of samples to skip from end of this packet
1062 * u8 reason for start skip
1063 * u8 reason for end skip (0=padding silence, 1=convergence)
1066 AV_PKT_DATA_SKIP_SAMPLES=70,
1069 * An AV_PKT_DATA_JP_DUALMONO side data packet indicates that
1070 * the packet may contain "dual mono" audio specific to Japanese DTV
1071 * and if it is true, recommends only the selected channel to be used.
1073 * u8 selected channels (0=mail/left, 1=sub/right, 2=both)
1076 AV_PKT_DATA_JP_DUALMONO,
1079 * A list of zero terminated key/value strings. There is no end marker for
1080 * the list, so it is required to rely on the side data size to stop.
1082 AV_PKT_DATA_STRINGS_METADATA,
1085 * Subtitle event position
1093 AV_PKT_DATA_SUBTITLE_POSITION,
1096 * Data found in BlockAdditional element of matroska container. There is
1097 * no end marker for the data, so it is required to rely on the side data
1098 * size to recognize the end. 8 byte id (as found in BlockAddId) followed
1101 AV_PKT_DATA_MATROSKA_BLOCKADDITIONAL,
1104 * The optional first identifier line of a WebVTT cue.
1106 AV_PKT_DATA_WEBVTT_IDENTIFIER,
1109 * The optional settings (rendering instructions) that immediately
1110 * follow the timestamp specifier of a WebVTT cue.
1112 AV_PKT_DATA_WEBVTT_SETTINGS,
1115 * A list of zero terminated key/value strings. There is no end marker for
1116 * the list, so it is required to rely on the side data size to stop. This
1117 * side data includes updated metadata which appeared in the stream.
1119 AV_PKT_DATA_METADATA_UPDATE,
1122 typedef struct AVPacketSideData {
1125 enum AVPacketSideDataType type;
1129 * This structure stores compressed data. It is typically exported by demuxers
1130 * and then passed as input to decoders, or received as output from encoders and
1131 * then passed to muxers.
1133 * For video, it should typically contain one compressed frame. For audio it may
1134 * contain several compressed frames.
1136 * AVPacket is one of the few structs in FFmpeg, whose size is a part of public
1137 * ABI. Thus it may be allocated on stack and no new fields can be added to it
1138 * without libavcodec and libavformat major bump.
1140 * The semantics of data ownership depends on the buf or destruct (deprecated)
1141 * fields. If either is set, the packet data is dynamically allocated and is
1142 * valid indefinitely until av_free_packet() is called (which in turn calls
1143 * av_buffer_unref()/the destruct callback to free the data). If neither is set,
1144 * the packet data is typically backed by some static buffer somewhere and is
1145 * only valid for a limited time (e.g. until the next read call when demuxing).
1147 * The side data is always allocated with av_malloc() and is freed in
1150 typedef struct AVPacket {
1152 * A reference to the reference-counted buffer where the packet data is
1154 * May be NULL, then the packet data is not reference-counted.
1158 * Presentation timestamp in AVStream->time_base units; the time at which
1159 * the decompressed packet will be presented to the user.
1160 * Can be AV_NOPTS_VALUE if it is not stored in the file.
1161 * pts MUST be larger or equal to dts as presentation cannot happen before
1162 * decompression, unless one wants to view hex dumps. Some formats misuse
1163 * the terms dts and pts/cts to mean something different. Such timestamps
1164 * must be converted to true pts/dts before they are stored in AVPacket.
1168 * Decompression timestamp in AVStream->time_base units; the time at which
1169 * the packet is decompressed.
1170 * Can be AV_NOPTS_VALUE if it is not stored in the file.
1177 * A combination of AV_PKT_FLAG values
1181 * Additional packet data that can be provided by the container.
1182 * Packet can contain several types of side information.
1184 AVPacketSideData *side_data;
1185 int side_data_elems;
1188 * Duration of this packet in AVStream->time_base units, 0 if unknown.
1189 * Equals next_pts - this_pts in presentation order.
1192 #if FF_API_DESTRUCT_PACKET
1193 attribute_deprecated
1194 void (*destruct)(struct AVPacket *);
1195 attribute_deprecated
1198 int64_t pos; ///< byte position in stream, -1 if unknown
1201 * Time difference in AVStream->time_base units from the pts of this
1202 * packet to the point at which the output from the decoder has converged
1203 * independent from the availability of previous frames. That is, the
1204 * frames are virtually identical no matter if decoding started from
1205 * the very first frame or from this keyframe.
1206 * Is AV_NOPTS_VALUE if unknown.
1207 * This field is not the display duration of the current packet.
1208 * This field has no meaning if the packet does not have AV_PKT_FLAG_KEY
1211 * The purpose of this field is to allow seeking in streams that have no
1212 * keyframes in the conventional sense. It corresponds to the
1213 * recovery point SEI in H.264 and match_time_delta in NUT. It is also
1214 * essential for some types of subtitle streams to ensure that all
1215 * subtitles are correctly displayed after seeking.
1217 int64_t convergence_duration;
1219 #define AV_PKT_FLAG_KEY 0x0001 ///< The packet contains a keyframe
1220 #define AV_PKT_FLAG_CORRUPT 0x0002 ///< The packet content is corrupted
1222 enum AVSideDataParamChangeFlags {
1223 AV_SIDE_DATA_PARAM_CHANGE_CHANNEL_COUNT = 0x0001,
1224 AV_SIDE_DATA_PARAM_CHANGE_CHANNEL_LAYOUT = 0x0002,
1225 AV_SIDE_DATA_PARAM_CHANGE_SAMPLE_RATE = 0x0004,
1226 AV_SIDE_DATA_PARAM_CHANGE_DIMENSIONS = 0x0008,
1232 struct AVCodecInternal;
1236 AV_FIELD_PROGRESSIVE,
1237 AV_FIELD_TT, //< Top coded_first, top displayed first
1238 AV_FIELD_BB, //< Bottom coded first, bottom displayed first
1239 AV_FIELD_TB, //< Top coded first, bottom displayed first
1240 AV_FIELD_BT, //< Bottom coded first, top displayed first
1244 * main external API structure.
1245 * New fields can be added to the end with minor version bumps.
1246 * Removal, reordering and changes to existing fields require a major
1248 * Please use AVOptions (av_opt* / av_set/get*()) to access these fields from user
1250 * sizeof(AVCodecContext) must not be used outside libav*.
1252 typedef struct AVCodecContext {
1254 * information on struct for av_log
1255 * - set by avcodec_alloc_context3
1257 const AVClass *av_class;
1258 int log_level_offset;
1260 enum AVMediaType codec_type; /* see AVMEDIA_TYPE_xxx */
1261 const struct AVCodec *codec;
1262 #if FF_API_CODEC_NAME
1264 * @deprecated this field is not used for anything in libavcodec
1266 attribute_deprecated
1267 char codec_name[32];
1269 enum AVCodecID codec_id; /* see AV_CODEC_ID_xxx */
1272 * fourcc (LSB first, so "ABCD" -> ('D'<<24) + ('C'<<16) + ('B'<<8) + 'A').
1273 * This is used to work around some encoder bugs.
1274 * A demuxer should set this to what is stored in the field used to identify the codec.
1275 * If there are multiple such fields in a container then the demuxer should choose the one
1276 * which maximizes the information about the used codec.
1277 * If the codec tag field in a container is larger than 32 bits then the demuxer should
1278 * remap the longer ID to 32 bits with a table or other structure. Alternatively a new
1279 * extra_codec_tag + size could be added but for this a clear advantage must be demonstrated
1281 * - encoding: Set by user, if not then the default based on codec_id will be used.
1282 * - decoding: Set by user, will be converted to uppercase by libavcodec during init.
1284 unsigned int codec_tag;
1286 #if FF_API_STREAM_CODEC_TAG
1288 * @deprecated this field is unused
1290 attribute_deprecated
1291 unsigned int stream_codec_tag;
1297 * Private context used for internal data.
1299 * Unlike priv_data, this is not codec-specific. It is used in general
1300 * libavcodec functions.
1302 struct AVCodecInternal *internal;
1305 * Private data of the user, can be used to carry app specific stuff.
1306 * - encoding: Set by user.
1307 * - decoding: Set by user.
1312 * the average bitrate
1313 * - encoding: Set by user; unused for constant quantizer encoding.
1314 * - decoding: Set by libavcodec. 0 or some bitrate if this info is available in the stream.
1319 * number of bits the bitstream is allowed to diverge from the reference.
1320 * the reference can be CBR (for CBR pass1) or VBR (for pass2)
1321 * - encoding: Set by user; unused for constant quantizer encoding.
1322 * - decoding: unused
1324 int bit_rate_tolerance;
1327 * Global quality for codecs which cannot change it per frame.
1328 * This should be proportional to MPEG-1/2/4 qscale.
1329 * - encoding: Set by user.
1330 * - decoding: unused
1335 * - encoding: Set by user.
1336 * - decoding: unused
1338 int compression_level;
1339 #define FF_COMPRESSION_DEFAULT -1
1343 * - encoding: Set by user.
1344 * - decoding: Set by user.
1350 * - encoding: Set by user.
1351 * - decoding: Set by user.
1356 * some codecs need / can use extradata like Huffman tables.
1357 * mjpeg: Huffman tables
1358 * rv10: additional flags
1359 * mpeg4: global headers (they can be in the bitstream or here)
1360 * The allocated memory should be FF_INPUT_BUFFER_PADDING_SIZE bytes larger
1361 * than extradata_size to avoid problems if it is read with the bitstream reader.
1362 * The bytewise contents of extradata must not depend on the architecture or CPU endianness.
1363 * - encoding: Set/allocated/freed by libavcodec.
1364 * - decoding: Set/allocated/freed by user.
1370 * This is the fundamental unit of time (in seconds) in terms
1371 * of which frame timestamps are represented. For fixed-fps content,
1372 * timebase should be 1/framerate and timestamp increments should be
1374 * This often, but not always is the inverse of the frame rate or field rate
1376 * - encoding: MUST be set by user.
1377 * - decoding: the use of this field for decoding is deprecated.
1378 * Use framerate instead.
1380 AVRational time_base;
1383 * For some codecs, the time base is closer to the field rate than the frame rate.
1384 * Most notably, H.264 and MPEG-2 specify time_base as half of frame duration
1385 * if no telecine is used ...
1387 * Set to time_base ticks per frame. Default 1, e.g., H.264/MPEG-2 set it to 2.
1389 int ticks_per_frame;
1394 * Encoding: Number of frames delay there will be from the encoder input to
1395 * the decoder output. (we assume the decoder matches the spec)
1396 * Decoding: Number of frames delay in addition to what a standard decoder
1397 * as specified in the spec would produce.
1400 * Number of frames the decoded output will be delayed relative to the
1404 * For encoding, this field is unused (see initial_padding).
1406 * For decoding, this is the number of samples the decoder needs to
1407 * output before the decoder's output is valid. When seeking, you should
1408 * start decoding this many samples prior to your desired seek point.
1410 * - encoding: Set by libavcodec.
1411 * - decoding: Set by libavcodec.
1418 * picture width / height.
1420 * @note Those fields may not match the values of the last
1421 * AVFrame outputted by avcodec_decode_video2 due frame
1424 * - encoding: MUST be set by user.
1425 * - decoding: May be set by the user before opening the decoder if known e.g.
1426 * from the container. Some decoders will require the dimensions
1427 * to be set by the caller. During decoding, the decoder may
1428 * overwrite those values as required while parsing the data.
1433 * Bitstream width / height, may be different from width/height e.g. when
1434 * the decoded frame is cropped before being output or lowres is enabled.
1436 * @note Those field may not match the value of the last
1437 * AVFrame outputted by avcodec_decode_video2 due frame
1440 * - encoding: unused
1441 * - decoding: May be set by the user before opening the decoder if known
1442 * e.g. from the container. During decoding, the decoder may
1443 * overwrite those values as required while parsing the data.
1445 int coded_width, coded_height;
1447 #if FF_API_ASPECT_EXTENDED
1448 #define FF_ASPECT_EXTENDED 15
1452 * the number of pictures in a group of pictures, or 0 for intra_only
1453 * - encoding: Set by user.
1454 * - decoding: unused
1459 * Pixel format, see AV_PIX_FMT_xxx.
1460 * May be set by the demuxer if known from headers.
1461 * May be overridden by the decoder if it knows better.
1463 * @note This field may not match the value of the last
1464 * AVFrame outputted by avcodec_decode_video2 due frame
1467 * - encoding: Set by user.
1468 * - decoding: Set by user if known, overridden by libavcodec while
1471 enum AVPixelFormat pix_fmt;
1474 * Motion estimation algorithm used for video coding.
1475 * 1 (zero), 2 (full), 3 (log), 4 (phods), 5 (epzs), 6 (x1), 7 (hex),
1476 * 8 (umh), 9 (iter), 10 (tesa) [7, 8, 10 are x264 specific, 9 is snow specific]
1477 * - encoding: MUST be set by user.
1478 * - decoding: unused
1483 * If non NULL, 'draw_horiz_band' is called by the libavcodec
1484 * decoder to draw a horizontal band. It improves cache usage. Not
1485 * all codecs can do that. You must check the codec capabilities
1487 * When multithreading is used, it may be called from multiple threads
1488 * at the same time; threads might draw different parts of the same AVFrame,
1489 * or multiple AVFrames, and there is no guarantee that slices will be drawn
1491 * The function is also used by hardware acceleration APIs.
1492 * It is called at least once during frame decoding to pass
1493 * the data needed for hardware render.
1494 * In that mode instead of pixel data, AVFrame points to
1495 * a structure specific to the acceleration API. The application
1496 * reads the structure and can change some fields to indicate progress
1498 * - encoding: unused
1499 * - decoding: Set by user.
1500 * @param height the height of the slice
1501 * @param y the y position of the slice
1502 * @param type 1->top field, 2->bottom field, 3->frame
1503 * @param offset offset into the AVFrame.data from which the slice should be read
1505 void (*draw_horiz_band)(struct AVCodecContext *s,
1506 const AVFrame *src, int offset[AV_NUM_DATA_POINTERS],
1507 int y, int type, int height);
1510 * callback to negotiate the pixelFormat
1511 * @param fmt is the list of formats which are supported by the codec,
1512 * it is terminated by -1 as 0 is a valid format, the formats are ordered by quality.
1513 * The first is always the native one.
1514 * @note The callback may be called again immediately if initialization for
1515 * the selected (hardware-accelerated) pixel format failed.
1516 * @warning Behavior is undefined if the callback returns a value not
1517 * in the fmt list of formats.
1518 * @return the chosen format
1519 * - encoding: unused
1520 * - decoding: Set by user, if not set the native format will be chosen.
1522 enum AVPixelFormat (*get_format)(struct AVCodecContext *s, const enum AVPixelFormat * fmt);
1525 * maximum number of B-frames between non-B-frames
1526 * Note: The output will be delayed by max_b_frames+1 relative to the input.
1527 * - encoding: Set by user.
1528 * - decoding: unused
1533 * qscale factor between IP and B-frames
1534 * If > 0 then the last P-frame quantizer will be used (q= lastp_q*factor+offset).
1535 * If < 0 then normal ratecontrol will be done (q= -normal_q*factor+offset).
1536 * - encoding: Set by user.
1537 * - decoding: unused
1539 float b_quant_factor;
1541 #if FF_API_RC_STRATEGY
1542 /** @deprecated use codec private option instead */
1543 attribute_deprecated int rc_strategy;
1544 #define FF_RC_STRATEGY_XVID 1
1547 int b_frame_strategy;
1550 * qscale offset between IP and B-frames
1551 * - encoding: Set by user.
1552 * - decoding: unused
1554 float b_quant_offset;
1557 * Size of the frame reordering buffer in the decoder.
1558 * For MPEG-2 it is 1 IPB or 0 low delay IP.
1559 * - encoding: Set by libavcodec.
1560 * - decoding: Set by libavcodec.
1565 * 0-> h263 quant 1-> mpeg quant
1566 * - encoding: Set by user.
1567 * - decoding: unused
1572 * qscale factor between P and I-frames
1573 * If > 0 then the last p frame quantizer will be used (q= lastp_q*factor+offset).
1574 * If < 0 then normal ratecontrol will be done (q= -normal_q*factor+offset).
1575 * - encoding: Set by user.
1576 * - decoding: unused
1578 float i_quant_factor;
1581 * qscale offset between P and I-frames
1582 * - encoding: Set by user.
1583 * - decoding: unused
1585 float i_quant_offset;
1588 * luminance masking (0-> disabled)
1589 * - encoding: Set by user.
1590 * - decoding: unused
1595 * temporary complexity masking (0-> disabled)
1596 * - encoding: Set by user.
1597 * - decoding: unused
1599 float temporal_cplx_masking;
1602 * spatial complexity masking (0-> disabled)
1603 * - encoding: Set by user.
1604 * - decoding: unused
1606 float spatial_cplx_masking;
1609 * p block masking (0-> disabled)
1610 * - encoding: Set by user.
1611 * - decoding: unused
1616 * darkness masking (0-> disabled)
1617 * - encoding: Set by user.
1618 * - decoding: unused
1624 * - encoding: Set by libavcodec.
1625 * - decoding: Set by user (or 0).
1629 * prediction method (needed for huffyuv)
1630 * - encoding: Set by user.
1631 * - decoding: unused
1633 int prediction_method;
1634 #define FF_PRED_LEFT 0
1635 #define FF_PRED_PLANE 1
1636 #define FF_PRED_MEDIAN 2
1639 * slice offsets in the frame in bytes
1640 * - encoding: Set/allocated by libavcodec.
1641 * - decoding: Set/allocated by user (or NULL).
1646 * sample aspect ratio (0 if unknown)
1647 * That is the width of a pixel divided by the height of the pixel.
1648 * Numerator and denominator must be relatively prime and smaller than 256 for some video standards.
1649 * - encoding: Set by user.
1650 * - decoding: Set by libavcodec.
1652 AVRational sample_aspect_ratio;
1655 * motion estimation comparison function
1656 * - encoding: Set by user.
1657 * - decoding: unused
1661 * subpixel motion estimation comparison function
1662 * - encoding: Set by user.
1663 * - decoding: unused
1667 * macroblock comparison function (not supported yet)
1668 * - encoding: Set by user.
1669 * - decoding: unused
1673 * interlaced DCT comparison function
1674 * - encoding: Set by user.
1675 * - decoding: unused
1678 #define FF_CMP_SAD 0
1679 #define FF_CMP_SSE 1
1680 #define FF_CMP_SATD 2
1681 #define FF_CMP_DCT 3
1682 #define FF_CMP_PSNR 4
1683 #define FF_CMP_BIT 5
1685 #define FF_CMP_ZERO 7
1686 #define FF_CMP_VSAD 8
1687 #define FF_CMP_VSSE 9
1688 #define FF_CMP_NSSE 10
1689 #define FF_CMP_W53 11
1690 #define FF_CMP_W97 12
1691 #define FF_CMP_DCTMAX 13
1692 #define FF_CMP_DCT264 14
1693 #define FF_CMP_CHROMA 256
1696 * ME diamond size & shape
1697 * - encoding: Set by user.
1698 * - decoding: unused
1703 * amount of previous MV predictors (2a+1 x 2a+1 square)
1704 * - encoding: Set by user.
1705 * - decoding: unused
1707 int last_predictor_count;
1710 * prepass for motion estimation
1711 * - encoding: Set by user.
1712 * - decoding: unused
1717 * motion estimation prepass comparison function
1718 * - encoding: Set by user.
1719 * - decoding: unused
1724 * ME prepass diamond size & shape
1725 * - encoding: Set by user.
1726 * - decoding: unused
1732 * - encoding: Set by user.
1733 * - decoding: unused
1735 int me_subpel_quality;
1739 * DTG active format information (additional aspect ratio
1740 * information only used in DVB MPEG-2 transport streams)
1743 * - encoding: unused
1744 * - decoding: Set by decoder.
1745 * @deprecated Deprecated in favor of AVSideData
1747 attribute_deprecated int dtg_active_format;
1748 #define FF_DTG_AFD_SAME 8
1749 #define FF_DTG_AFD_4_3 9
1750 #define FF_DTG_AFD_16_9 10
1751 #define FF_DTG_AFD_14_9 11
1752 #define FF_DTG_AFD_4_3_SP_14_9 13
1753 #define FF_DTG_AFD_16_9_SP_14_9 14
1754 #define FF_DTG_AFD_SP_4_3 15
1755 #endif /* FF_API_AFD */
1758 * maximum motion estimation search range in subpel units
1759 * If 0 then no limit.
1761 * - encoding: Set by user.
1762 * - decoding: unused
1766 #if FF_API_QUANT_BIAS
1768 * @deprecated use encoder private option instead
1770 attribute_deprecated int intra_quant_bias;
1771 #define FF_DEFAULT_QUANT_BIAS 999999
1774 * @deprecated use encoder private option instead
1776 attribute_deprecated int inter_quant_bias;
1781 * - encoding: unused
1782 * - decoding: Set by user.
1785 #define SLICE_FLAG_CODED_ORDER 0x0001 ///< draw_horiz_band() is called in coded order instead of display
1786 #define SLICE_FLAG_ALLOW_FIELD 0x0002 ///< allow draw_horiz_band() with field slices (MPEG2 field pics)
1787 #define SLICE_FLAG_ALLOW_PLANE 0x0004 ///< allow draw_horiz_band() with 1 component at a time (SVQ1)
1791 * XVideo Motion Acceleration
1792 * - encoding: forbidden
1793 * - decoding: set by decoder
1794 * @deprecated XvMC doesn't need it anymore.
1796 attribute_deprecated int xvmc_acceleration;
1797 #endif /* FF_API_XVMC */
1800 * macroblock decision mode
1801 * - encoding: Set by user.
1802 * - decoding: unused
1805 #define FF_MB_DECISION_SIMPLE 0 ///< uses mb_cmp
1806 #define FF_MB_DECISION_BITS 1 ///< chooses the one which needs the fewest bits
1807 #define FF_MB_DECISION_RD 2 ///< rate distortion
1810 * custom intra quantization matrix
1811 * - encoding: Set by user, can be NULL.
1812 * - decoding: Set by libavcodec.
1814 uint16_t *intra_matrix;
1817 * custom inter quantization matrix
1818 * - encoding: Set by user, can be NULL.
1819 * - decoding: Set by libavcodec.
1821 uint16_t *inter_matrix;
1824 * scene change detection threshold
1825 * 0 is default, larger means fewer detected scene changes.
1826 * - encoding: Set by user.
1827 * - decoding: unused
1829 int scenechange_threshold;
1832 * noise reduction strength
1833 * - encoding: Set by user.
1834 * - decoding: unused
1836 int noise_reduction;
1840 * @deprecated this field is unused
1842 attribute_deprecated
1846 * @deprecated this field is unused
1848 attribute_deprecated
1853 * precision of the intra DC coefficient - 8
1854 * - encoding: Set by user.
1855 * - decoding: Set by libavcodec
1857 int intra_dc_precision;
1860 * Number of macroblock rows at the top which are skipped.
1861 * - encoding: unused
1862 * - decoding: Set by user.
1867 * Number of macroblock rows at the bottom which are skipped.
1868 * - encoding: unused
1869 * - decoding: Set by user.
1875 * @deprecated use encoder private options instead
1877 attribute_deprecated
1878 float border_masking;
1882 * minimum MB lagrange multipler
1883 * - encoding: Set by user.
1884 * - decoding: unused
1889 * maximum MB lagrange multipler
1890 * - encoding: Set by user.
1891 * - decoding: unused
1897 * - encoding: Set by user.
1898 * - decoding: unused
1900 int me_penalty_compensation;
1904 * - encoding: Set by user.
1905 * - decoding: unused
1911 * - encoding: Set by user.
1912 * - decoding: unused
1918 * - encoding: Set by user.
1919 * - decoding: unused
1924 * number of reference frames
1925 * - encoding: Set by user.
1926 * - decoding: Set by lavc.
1931 * chroma qp offset from luma
1932 * - encoding: Set by user.
1933 * - decoding: unused
1937 #if FF_API_UNUSED_MEMBERS
1939 * Multiplied by qscale for each frame and added to scene_change_score.
1940 * - encoding: Set by user.
1941 * - decoding: unused
1943 attribute_deprecated int scenechange_factor;
1948 * Note: Value depends upon the compare function used for fullpel ME.
1949 * - encoding: Set by user.
1950 * - decoding: unused
1955 * Adjust sensitivity of b_frame_strategy 1.
1956 * - encoding: Set by user.
1957 * - decoding: unused
1962 * Chromaticity coordinates of the source primaries.
1963 * - encoding: Set by user
1964 * - decoding: Set by libavcodec
1966 enum AVColorPrimaries color_primaries;
1969 * Color Transfer Characteristic.
1970 * - encoding: Set by user
1971 * - decoding: Set by libavcodec
1973 enum AVColorTransferCharacteristic color_trc;
1976 * YUV colorspace type.
1977 * - encoding: Set by user
1978 * - decoding: Set by libavcodec
1980 enum AVColorSpace colorspace;
1983 * MPEG vs JPEG YUV range.
1984 * - encoding: Set by user
1985 * - decoding: Set by libavcodec
1987 enum AVColorRange color_range;
1990 * This defines the location of chroma samples.
1991 * - encoding: Set by user
1992 * - decoding: Set by libavcodec
1994 enum AVChromaLocation chroma_sample_location;
1998 * Indicates number of picture subdivisions. Used for parallelized
2000 * - encoding: Set by user
2001 * - decoding: unused
2006 * - encoding: set by libavcodec
2007 * - decoding: Set by user.
2009 enum AVFieldOrder field_order;
2012 int sample_rate; ///< samples per second
2013 int channels; ///< number of audio channels
2016 * audio sample format
2017 * - encoding: Set by user.
2018 * - decoding: Set by libavcodec.
2020 enum AVSampleFormat sample_fmt; ///< sample format
2022 /* The following data should not be initialized. */
2024 * Number of samples per channel in an audio frame.
2026 * - encoding: set by libavcodec in avcodec_open2(). Each submitted frame
2027 * except the last must contain exactly frame_size samples per channel.
2028 * May be 0 when the codec has CODEC_CAP_VARIABLE_FRAME_SIZE set, then the
2029 * frame size is not restricted.
2030 * - decoding: may be set by some decoders to indicate constant frame size
2035 * Frame counter, set by libavcodec.
2037 * - decoding: total number of frames returned from the decoder so far.
2038 * - encoding: total number of frames passed to the encoder so far.
2040 * @note the counter is not incremented if encoding/decoding resulted in
2046 * number of bytes per packet if constant and known or 0
2047 * Used by some WAV based audio codecs.
2052 * Audio cutoff bandwidth (0 means "automatic")
2053 * - encoding: Set by user.
2054 * - decoding: unused
2058 #if FF_API_REQUEST_CHANNELS
2060 * Decoder should decode to this many channels if it can (0 for default)
2061 * - encoding: unused
2062 * - decoding: Set by user.
2063 * @deprecated Deprecated in favor of request_channel_layout.
2065 attribute_deprecated int request_channels;
2069 * Audio channel layout.
2070 * - encoding: set by user.
2071 * - decoding: set by user, may be overwritten by libavcodec.
2073 uint64_t channel_layout;
2076 * Request decoder to use this channel layout if it can (0 for default)
2077 * - encoding: unused
2078 * - decoding: Set by user.
2080 uint64_t request_channel_layout;
2083 * Type of service that the audio stream conveys.
2084 * - encoding: Set by user.
2085 * - decoding: Set by libavcodec.
2087 enum AVAudioServiceType audio_service_type;
2090 * desired sample format
2091 * - encoding: Not used.
2092 * - decoding: Set by user.
2093 * Decoder will decode to this format if it can.
2095 enum AVSampleFormat request_sample_fmt;
2097 #if FF_API_GET_BUFFER
2099 * Called at the beginning of each frame to get a buffer for it.
2101 * The function will set AVFrame.data[], AVFrame.linesize[].
2102 * AVFrame.extended_data[] must also be set, but it should be the same as
2103 * AVFrame.data[] except for planar audio with more channels than can fit
2104 * in AVFrame.data[]. In that case, AVFrame.data[] shall still contain as
2105 * many data pointers as it can hold.
2107 * if CODEC_CAP_DR1 is not set then get_buffer() must call
2108 * avcodec_default_get_buffer() instead of providing buffers allocated by
2111 * AVFrame.data[] should be 32- or 16-byte-aligned unless the CPU doesn't
2112 * need it. avcodec_default_get_buffer() aligns the output buffer properly,
2113 * but if get_buffer() is overridden then alignment considerations should
2114 * be taken into account.
2116 * @see avcodec_default_get_buffer()
2120 * If pic.reference is set then the frame will be read later by libavcodec.
2121 * avcodec_align_dimensions2() should be used to find the required width and
2122 * height, as they normally need to be rounded up to the next multiple of 16.
2124 * If frame multithreading is used and thread_safe_callbacks is set,
2125 * it may be called from a different thread, but not from more than one at
2126 * once. Does not need to be reentrant.
2128 * @see release_buffer(), reget_buffer()
2129 * @see avcodec_align_dimensions2()
2133 * Decoders request a buffer of a particular size by setting
2134 * AVFrame.nb_samples prior to calling get_buffer(). The decoder may,
2135 * however, utilize only part of the buffer by setting AVFrame.nb_samples
2136 * to a smaller value in the output frame.
2138 * Decoders cannot use the buffer after returning from
2139 * avcodec_decode_audio4(), so they will not call release_buffer(), as it
2140 * is assumed to be released immediately upon return. In some rare cases,
2141 * a decoder may need to call get_buffer() more than once in a single
2142 * call to avcodec_decode_audio4(). In that case, when get_buffer() is
2143 * called again after it has already been called once, the previously
2144 * acquired buffer is assumed to be released at that time and may not be
2145 * reused by the decoder.
2147 * As a convenience, av_samples_get_buffer_size() and
2148 * av_samples_fill_arrays() in libavutil may be used by custom get_buffer()
2149 * functions to find the required data size and to fill data pointers and
2150 * linesize. In AVFrame.linesize, only linesize[0] may be set for audio
2151 * since all planes must be the same size.
2153 * @see av_samples_get_buffer_size(), av_samples_fill_arrays()
2155 * - encoding: unused
2156 * - decoding: Set by libavcodec, user can override.
2158 * @deprecated use get_buffer2()
2160 attribute_deprecated
2161 int (*get_buffer)(struct AVCodecContext *c, AVFrame *pic);
2164 * Called to release buffers which were allocated with get_buffer.
2165 * A released buffer can be reused in get_buffer().
2166 * pic.data[*] must be set to NULL.
2167 * May be called from a different thread if frame multithreading is used,
2168 * but not by more than one thread at once, so does not need to be reentrant.
2169 * - encoding: unused
2170 * - decoding: Set by libavcodec, user can override.
2172 * @deprecated custom freeing callbacks should be set from get_buffer2()
2174 attribute_deprecated
2175 void (*release_buffer)(struct AVCodecContext *c, AVFrame *pic);
2178 * Called at the beginning of a frame to get cr buffer for it.
2179 * Buffer type (size, hints) must be the same. libavcodec won't check it.
2180 * libavcodec will pass previous buffer in pic, function should return
2181 * same buffer or new buffer with old frame "painted" into it.
2182 * If pic.data[0] == NULL must behave like get_buffer().
2183 * if CODEC_CAP_DR1 is not set then reget_buffer() must call
2184 * avcodec_default_reget_buffer() instead of providing buffers allocated by
2186 * - encoding: unused
2187 * - decoding: Set by libavcodec, user can override.
2189 attribute_deprecated
2190 int (*reget_buffer)(struct AVCodecContext *c, AVFrame *pic);
2194 * This callback is called at the beginning of each frame to get data
2195 * buffer(s) for it. There may be one contiguous buffer for all the data or
2196 * there may be a buffer per each data plane or anything in between. What
2197 * this means is, you may set however many entries in buf[] you feel necessary.
2198 * Each buffer must be reference-counted using the AVBuffer API (see description
2201 * The following fields will be set in the frame before this callback is
2204 * - width, height (video only)
2205 * - sample_rate, channel_layout, nb_samples (audio only)
2206 * Their values may differ from the corresponding values in
2207 * AVCodecContext. This callback must use the frame values, not the codec
2208 * context values, to calculate the required buffer size.
2210 * This callback must fill the following fields in the frame:
2214 * * if the data is planar audio with more than 8 channels, then this
2215 * callback must allocate and fill extended_data to contain all pointers
2216 * to all data planes. data[] must hold as many pointers as it can.
2217 * extended_data must be allocated with av_malloc() and will be freed in
2219 * * otherwise exended_data must point to data
2220 * - buf[] must contain one or more pointers to AVBufferRef structures. Each of
2221 * the frame's data and extended_data pointers must be contained in these. That
2222 * is, one AVBufferRef for each allocated chunk of memory, not necessarily one
2223 * AVBufferRef per data[] entry. See: av_buffer_create(), av_buffer_alloc(),
2224 * and av_buffer_ref().
2225 * - extended_buf and nb_extended_buf must be allocated with av_malloc() by
2226 * this callback and filled with the extra buffers if there are more
2227 * buffers than buf[] can hold. extended_buf will be freed in
2230 * If CODEC_CAP_DR1 is not set then get_buffer2() must call
2231 * avcodec_default_get_buffer2() instead of providing buffers allocated by
2234 * Each data plane must be aligned to the maximum required by the target
2237 * @see avcodec_default_get_buffer2()
2241 * If AV_GET_BUFFER_FLAG_REF is set in flags then the frame may be reused
2242 * (read and/or written to if it is writable) later by libavcodec.
2244 * avcodec_align_dimensions2() should be used to find the required width and
2245 * height, as they normally need to be rounded up to the next multiple of 16.
2247 * Some decoders do not support linesizes changing between frames.
2249 * If frame multithreading is used and thread_safe_callbacks is set,
2250 * this callback may be called from a different thread, but not from more
2251 * than one at once. Does not need to be reentrant.
2253 * @see avcodec_align_dimensions2()
2257 * Decoders request a buffer of a particular size by setting
2258 * AVFrame.nb_samples prior to calling get_buffer2(). The decoder may,
2259 * however, utilize only part of the buffer by setting AVFrame.nb_samples
2260 * to a smaller value in the output frame.
2262 * As a convenience, av_samples_get_buffer_size() and
2263 * av_samples_fill_arrays() in libavutil may be used by custom get_buffer2()
2264 * functions to find the required data size and to fill data pointers and
2265 * linesize. In AVFrame.linesize, only linesize[0] may be set for audio
2266 * since all planes must be the same size.
2268 * @see av_samples_get_buffer_size(), av_samples_fill_arrays()
2270 * - encoding: unused
2271 * - decoding: Set by libavcodec, user can override.
2273 int (*get_buffer2)(struct AVCodecContext *s, AVFrame *frame, int flags);
2276 * If non-zero, the decoded audio and video frames returned from
2277 * avcodec_decode_video2() and avcodec_decode_audio4() are reference-counted
2278 * and are valid indefinitely. The caller must free them with
2279 * av_frame_unref() when they are not needed anymore.
2280 * Otherwise, the decoded frames must not be freed by the caller and are
2281 * only valid until the next decode call.
2283 * - encoding: unused
2284 * - decoding: set by the caller before avcodec_open2().
2286 int refcounted_frames;
2288 /* - encoding parameters */
2289 float qcompress; ///< amount of qscale change between easy & hard scenes (0.0-1.0)
2290 float qblur; ///< amount of qscale smoothing over time (0.0-1.0)
2294 * - encoding: Set by user.
2295 * - decoding: unused
2301 * - encoding: Set by user.
2302 * - decoding: unused
2307 * maximum quantizer difference between frames
2308 * - encoding: Set by user.
2309 * - decoding: unused
2315 * @deprecated use encoder private options instead
2317 attribute_deprecated
2320 attribute_deprecated
2322 attribute_deprecated
2327 * decoder bitstream buffer size
2328 * - encoding: Set by user.
2329 * - decoding: unused
2334 * ratecontrol override, see RcOverride
2335 * - encoding: Allocated/set/freed by user.
2336 * - decoding: unused
2338 int rc_override_count;
2339 RcOverride *rc_override;
2343 * @deprecated use encoder private options instead
2345 attribute_deprecated
2351 * - encoding: Set by user.
2352 * - decoding: Set by libavcodec.
2358 * - encoding: Set by user.
2359 * - decoding: unused
2365 * @deprecated use encoder private options instead
2367 attribute_deprecated
2368 float rc_buffer_aggressivity;
2370 attribute_deprecated
2371 float rc_initial_cplx;
2375 * Ratecontrol attempt to use, at maximum, <value> of what can be used without an underflow.
2376 * - encoding: Set by user.
2377 * - decoding: unused.
2379 float rc_max_available_vbv_use;
2382 * Ratecontrol attempt to use, at least, <value> times the amount needed to prevent a vbv overflow.
2383 * - encoding: Set by user.
2384 * - decoding: unused.
2386 float rc_min_vbv_overflow_use;
2389 * Number of bits which should be loaded into the rc buffer before decoding starts.
2390 * - encoding: Set by user.
2391 * - decoding: unused
2393 int rc_initial_buffer_occupancy;
2395 #define FF_CODER_TYPE_VLC 0
2396 #define FF_CODER_TYPE_AC 1
2397 #define FF_CODER_TYPE_RAW 2
2398 #define FF_CODER_TYPE_RLE 3
2399 #if FF_API_UNUSED_MEMBERS
2400 #define FF_CODER_TYPE_DEFLATE 4
2401 #endif /* FF_API_UNUSED_MEMBERS */
2404 * - encoding: Set by user.
2405 * - decoding: unused
2411 * - encoding: Set by user.
2412 * - decoding: unused
2418 * @deprecated use encoder private options instead
2420 attribute_deprecated
2424 * @deprecated use encoder private options instead
2426 attribute_deprecated
2431 * frame skip threshold
2432 * - encoding: Set by user.
2433 * - decoding: unused
2435 int frame_skip_threshold;
2439 * - encoding: Set by user.
2440 * - decoding: unused
2442 int frame_skip_factor;
2445 * frame skip exponent
2446 * - encoding: Set by user.
2447 * - decoding: unused
2452 * frame skip comparison function
2453 * - encoding: Set by user.
2454 * - decoding: unused
2459 * trellis RD quantization
2460 * - encoding: Set by user.
2461 * - decoding: unused
2466 * - encoding: Set by user.
2467 * - decoding: unused
2469 int min_prediction_order;
2472 * - encoding: Set by user.
2473 * - decoding: unused
2475 int max_prediction_order;
2478 * GOP timecode frame start number
2479 * - encoding: Set by user, in non drop frame format
2480 * - decoding: Set by libavcodec (timecode in the 25 bits format, -1 if unset)
2482 int64_t timecode_frame_start;
2484 /* The RTP callback: This function is called */
2485 /* every time the encoder has a packet to send. */
2486 /* It depends on the encoder if the data starts */
2487 /* with a Start Code (it should). H.263 does. */
2488 /* mb_nb contains the number of macroblocks */
2489 /* encoded in the RTP payload. */
2490 void (*rtp_callback)(struct AVCodecContext *avctx, void *data, int size, int mb_nb);
2492 int rtp_payload_size; /* The size of the RTP payload: the coder will */
2493 /* do its best to deliver a chunk with size */
2494 /* below rtp_payload_size, the chunk will start */
2495 /* with a start code on some codecs like H.263. */
2496 /* This doesn't take account of any particular */
2497 /* headers inside the transmitted RTP payload. */
2499 /* statistics, used for 2-pass encoding */
2510 * number of bits used for the previously encoded frame
2511 * - encoding: Set by libavcodec.
2512 * - decoding: unused
2517 * pass1 encoding statistics output buffer
2518 * - encoding: Set by libavcodec.
2519 * - decoding: unused
2524 * pass2 encoding statistics input buffer
2525 * Concatenated stuff from stats_out of pass1 should be placed here.
2526 * - encoding: Allocated/set/freed by user.
2527 * - decoding: unused
2532 * Work around bugs in encoders which sometimes cannot be detected automatically.
2533 * - encoding: Set by user
2534 * - decoding: Set by user
2536 int workaround_bugs;
2537 #define FF_BUG_AUTODETECT 1 ///< autodetection
2538 #if FF_API_OLD_MSMPEG4
2539 #define FF_BUG_OLD_MSMPEG4 2
2541 #define FF_BUG_XVID_ILACE 4
2542 #define FF_BUG_UMP4 8
2543 #define FF_BUG_NO_PADDING 16
2544 #define FF_BUG_AMV 32
2546 #define FF_BUG_AC_VLC 0 ///< Will be removed, libavcodec can now handle these non-compliant files by default.
2548 #define FF_BUG_QPEL_CHROMA 64
2549 #define FF_BUG_STD_QPEL 128
2550 #define FF_BUG_QPEL_CHROMA2 256
2551 #define FF_BUG_DIRECT_BLOCKSIZE 512
2552 #define FF_BUG_EDGE 1024
2553 #define FF_BUG_HPEL_CHROMA 2048
2554 #define FF_BUG_DC_CLIP 4096
2555 #define FF_BUG_MS 8192 ///< Work around various bugs in Microsoft's broken decoders.
2556 #define FF_BUG_TRUNCATED 16384
2559 * strictly follow the standard (MPEG4, ...).
2560 * - encoding: Set by user.
2561 * - decoding: Set by user.
2562 * Setting this to STRICT or higher means the encoder and decoder will
2563 * generally do stupid things, whereas setting it to unofficial or lower
2564 * will mean the encoder might produce output that is not supported by all
2565 * spec-compliant decoders. Decoders don't differentiate between normal,
2566 * unofficial and experimental (that is, they always try to decode things
2567 * when they can) unless they are explicitly asked to behave stupidly
2568 * (=strictly conform to the specs)
2570 int strict_std_compliance;
2571 #define FF_COMPLIANCE_VERY_STRICT 2 ///< Strictly conform to an older more strict version of the spec or reference software.
2572 #define FF_COMPLIANCE_STRICT 1 ///< Strictly conform to all the things in the spec no matter what consequences.
2573 #define FF_COMPLIANCE_NORMAL 0
2574 #define FF_COMPLIANCE_UNOFFICIAL -1 ///< Allow unofficial extensions
2575 #define FF_COMPLIANCE_EXPERIMENTAL -2 ///< Allow nonstandardized experimental things.
2578 * error concealment flags
2579 * - encoding: unused
2580 * - decoding: Set by user.
2582 int error_concealment;
2583 #define FF_EC_GUESS_MVS 1
2584 #define FF_EC_DEBLOCK 2
2585 #define FF_EC_FAVOR_INTER 256
2589 * - encoding: Set by user.
2590 * - decoding: Set by user.
2593 #define FF_DEBUG_PICT_INFO 1
2594 #define FF_DEBUG_RC 2
2595 #define FF_DEBUG_BITSTREAM 4
2596 #define FF_DEBUG_MB_TYPE 8
2597 #define FF_DEBUG_QP 16
2600 * @deprecated this option does nothing
2602 #define FF_DEBUG_MV 32
2604 #define FF_DEBUG_DCT_COEFF 0x00000040
2605 #define FF_DEBUG_SKIP 0x00000080
2606 #define FF_DEBUG_STARTCODE 0x00000100
2607 #if FF_API_UNUSED_MEMBERS
2608 #define FF_DEBUG_PTS 0x00000200
2609 #endif /* FF_API_UNUSED_MEMBERS */
2610 #define FF_DEBUG_ER 0x00000400
2611 #define FF_DEBUG_MMCO 0x00000800
2612 #define FF_DEBUG_BUGS 0x00001000
2614 #define FF_DEBUG_VIS_QP 0x00002000 ///< only access through AVOptions from outside libavcodec
2615 #define FF_DEBUG_VIS_MB_TYPE 0x00004000 ///< only access through AVOptions from outside libavcodec
2617 #define FF_DEBUG_BUFFERS 0x00008000
2618 #define FF_DEBUG_THREADS 0x00010000
2619 #define FF_DEBUG_GREEN_MD 0x00800000
2620 #define FF_DEBUG_NOMC 0x01000000
2625 * Code outside libavcodec should access this field using AVOptions
2626 * - encoding: Set by user.
2627 * - decoding: Set by user.
2630 #define FF_DEBUG_VIS_MV_P_FOR 0x00000001 //visualize forward predicted MVs of P frames
2631 #define FF_DEBUG_VIS_MV_B_FOR 0x00000002 //visualize forward predicted MVs of B frames
2632 #define FF_DEBUG_VIS_MV_B_BACK 0x00000004 //visualize backward predicted MVs of B frames
2636 * Error recognition; may misdetect some more or less valid parts as errors.
2637 * - encoding: unused
2638 * - decoding: Set by user.
2640 int err_recognition;
2643 * Verify checksums embedded in the bitstream (could be of either encoded or
2644 * decoded data, depending on the codec) and print an error message on mismatch.
2645 * If AV_EF_EXPLODE is also set, a mismatching checksum will result in the
2646 * decoder returning an error.
2648 #define AV_EF_CRCCHECK (1<<0)
2649 #define AV_EF_BITSTREAM (1<<1) ///< detect bitstream specification deviations
2650 #define AV_EF_BUFFER (1<<2) ///< detect improper bitstream length
2651 #define AV_EF_EXPLODE (1<<3) ///< abort decoding on minor error detection
2653 #define AV_EF_IGNORE_ERR (1<<15) ///< ignore errors and continue
2654 #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
2655 #define AV_EF_COMPLIANT (1<<17) ///< consider all spec non compliances as errors
2656 #define AV_EF_AGGRESSIVE (1<<18) ///< consider things that a sane encoder should not do as an error
2660 * opaque 64bit number (generally a PTS) that will be reordered and
2661 * output in AVFrame.reordered_opaque
2662 * - encoding: unused
2663 * - decoding: Set by user.
2665 int64_t reordered_opaque;
2668 * Hardware accelerator in use
2669 * - encoding: unused.
2670 * - decoding: Set by libavcodec
2672 struct AVHWAccel *hwaccel;
2675 * Hardware accelerator context.
2676 * For some hardware accelerators, a global context needs to be
2677 * provided by the user. In that case, this holds display-dependent
2678 * data FFmpeg cannot instantiate itself. Please refer to the
2679 * FFmpeg HW accelerator documentation to know how to fill this
2680 * is. e.g. for VA API, this is a struct vaapi_context.
2681 * - encoding: unused
2682 * - decoding: Set by user
2684 void *hwaccel_context;
2688 * - encoding: Set by libavcodec if flags&CODEC_FLAG_PSNR.
2689 * - decoding: unused
2691 uint64_t error[AV_NUM_DATA_POINTERS];
2694 * DCT algorithm, see FF_DCT_* below
2695 * - encoding: Set by user.
2696 * - decoding: unused
2699 #define FF_DCT_AUTO 0
2700 #define FF_DCT_FASTINT 1
2701 #if FF_API_UNUSED_MEMBERS
2702 #define FF_DCT_INT 2
2703 #endif /* FF_API_UNUSED_MEMBERS */
2704 #define FF_DCT_MMX 3
2705 #define FF_DCT_ALTIVEC 5
2706 #define FF_DCT_FAAN 6
2709 * IDCT algorithm, see FF_IDCT_* below.
2710 * - encoding: Set by user.
2711 * - decoding: Set by user.
2714 #define FF_IDCT_AUTO 0
2715 #define FF_IDCT_INT 1
2716 #define FF_IDCT_SIMPLE 2
2717 #define FF_IDCT_SIMPLEMMX 3
2718 #define FF_IDCT_ARM 7
2719 #define FF_IDCT_ALTIVEC 8
2721 #define FF_IDCT_SH4 9
2723 #define FF_IDCT_SIMPLEARM 10
2724 #if FF_API_UNUSED_MEMBERS
2725 #define FF_IDCT_IPP 13
2726 #endif /* FF_API_UNUSED_MEMBERS */
2727 #define FF_IDCT_XVID 14
2728 #if FF_API_IDCT_XVIDMMX
2729 #define FF_IDCT_XVIDMMX 14
2730 #endif /* FF_API_IDCT_XVIDMMX */
2731 #define FF_IDCT_SIMPLEARMV5TE 16
2732 #define FF_IDCT_SIMPLEARMV6 17
2733 #if FF_API_ARCH_SPARC
2734 #define FF_IDCT_SIMPLEVIS 18
2736 #define FF_IDCT_FAAN 20
2737 #define FF_IDCT_SIMPLENEON 22
2738 #if FF_API_ARCH_ALPHA
2739 #define FF_IDCT_SIMPLEALPHA 23
2741 #define FF_IDCT_SIMPLEAUTO 128
2744 * bits per sample/pixel from the demuxer (needed for huffyuv).
2745 * - encoding: Set by libavcodec.
2746 * - decoding: Set by user.
2748 int bits_per_coded_sample;
2751 * Bits per sample/pixel of internal libavcodec pixel/sample format.
2752 * - encoding: set by user.
2753 * - decoding: set by libavcodec.
2755 int bits_per_raw_sample;
2759 * low resolution decoding, 1-> 1/2 size, 2->1/4 size
2760 * - encoding: unused
2761 * - decoding: Set by user.
2762 * Code outside libavcodec should access this field using:
2763 * av_codec_{get,set}_lowres(avctx)
2769 * the picture in the bitstream
2770 * - encoding: Set by libavcodec.
2771 * - decoding: unused
2773 AVFrame *coded_frame;
2777 * is used to decide how many independent tasks should be passed to execute()
2778 * - encoding: Set by user.
2779 * - decoding: Set by user.
2784 * Which multithreading methods to use.
2785 * Use of FF_THREAD_FRAME will increase decoding delay by one frame per thread,
2786 * so clients which cannot provide future frames should not use it.
2788 * - encoding: Set by user, otherwise the default is used.
2789 * - decoding: Set by user, otherwise the default is used.
2792 #define FF_THREAD_FRAME 1 ///< Decode more than one frame at once
2793 #define FF_THREAD_SLICE 2 ///< Decode more than one part of a single frame at once
2796 * Which multithreading methods are in use by the codec.
2797 * - encoding: Set by libavcodec.
2798 * - decoding: Set by libavcodec.
2800 int active_thread_type;
2803 * Set by the client if its custom get_buffer() callback can be called
2804 * synchronously from another thread, which allows faster multithreaded decoding.
2805 * draw_horiz_band() will be called from other threads regardless of this setting.
2806 * Ignored if the default get_buffer() is used.
2807 * - encoding: Set by user.
2808 * - decoding: Set by user.
2810 int thread_safe_callbacks;
2813 * The codec may call this to execute several independent things.
2814 * It will return only after finishing all tasks.
2815 * The user may replace this with some multithreaded implementation,
2816 * the default implementation will execute the parts serially.
2817 * @param count the number of things to execute
2818 * - encoding: Set by libavcodec, user can override.
2819 * - decoding: Set by libavcodec, user can override.
2821 int (*execute)(struct AVCodecContext *c, int (*func)(struct AVCodecContext *c2, void *arg), void *arg2, int *ret, int count, int size);
2824 * The codec may call this to execute several independent things.
2825 * It will return only after finishing all tasks.
2826 * The user may replace this with some multithreaded implementation,
2827 * the default implementation will execute the parts serially.
2828 * Also see avcodec_thread_init and e.g. the --enable-pthread configure option.
2829 * @param c context passed also to func
2830 * @param count the number of things to execute
2831 * @param arg2 argument passed unchanged to func
2832 * @param ret return values of executed functions, must have space for "count" values. May be NULL.
2833 * @param func function that will be called count times, with jobnr from 0 to count-1.
2834 * threadnr will be in the range 0 to c->thread_count-1 < MAX_THREADS and so that no
2835 * two instances of func executing at the same time will have the same threadnr.
2836 * @return always 0 currently, but code should handle a future improvement where when any call to func
2837 * returns < 0 no further calls to func may be done and < 0 is returned.
2838 * - encoding: Set by libavcodec, user can override.
2839 * - decoding: Set by libavcodec, user can override.
2841 int (*execute2)(struct AVCodecContext *c, int (*func)(struct AVCodecContext *c2, void *arg, int jobnr, int threadnr), void *arg2, int *ret, int count);
2843 #if FF_API_THREAD_OPAQUE
2845 * @deprecated this field should not be used from outside of lavc
2847 attribute_deprecated
2848 void *thread_opaque;
2852 * noise vs. sse weight for the nsse comparison function
2853 * - encoding: Set by user.
2854 * - decoding: unused
2860 * - encoding: Set by user.
2861 * - decoding: Set by libavcodec.
2864 #define FF_PROFILE_UNKNOWN -99
2865 #define FF_PROFILE_RESERVED -100
2867 #define FF_PROFILE_AAC_MAIN 0
2868 #define FF_PROFILE_AAC_LOW 1
2869 #define FF_PROFILE_AAC_SSR 2
2870 #define FF_PROFILE_AAC_LTP 3
2871 #define FF_PROFILE_AAC_HE 4
2872 #define FF_PROFILE_AAC_HE_V2 28
2873 #define FF_PROFILE_AAC_LD 22
2874 #define FF_PROFILE_AAC_ELD 38
2875 #define FF_PROFILE_MPEG2_AAC_LOW 128
2876 #define FF_PROFILE_MPEG2_AAC_HE 131
2878 #define FF_PROFILE_DTS 20
2879 #define FF_PROFILE_DTS_ES 30
2880 #define FF_PROFILE_DTS_96_24 40
2881 #define FF_PROFILE_DTS_HD_HRA 50
2882 #define FF_PROFILE_DTS_HD_MA 60
2883 #define FF_PROFILE_DTS_EXPRESS 70
2885 #define FF_PROFILE_MPEG2_422 0
2886 #define FF_PROFILE_MPEG2_HIGH 1
2887 #define FF_PROFILE_MPEG2_SS 2
2888 #define FF_PROFILE_MPEG2_SNR_SCALABLE 3
2889 #define FF_PROFILE_MPEG2_MAIN 4
2890 #define FF_PROFILE_MPEG2_SIMPLE 5
2892 #define FF_PROFILE_H264_CONSTRAINED (1<<9) // 8+1; constraint_set1_flag
2893 #define FF_PROFILE_H264_INTRA (1<<11) // 8+3; constraint_set3_flag
2895 #define FF_PROFILE_H264_BASELINE 66
2896 #define FF_PROFILE_H264_CONSTRAINED_BASELINE (66|FF_PROFILE_H264_CONSTRAINED)
2897 #define FF_PROFILE_H264_MAIN 77
2898 #define FF_PROFILE_H264_EXTENDED 88
2899 #define FF_PROFILE_H264_HIGH 100
2900 #define FF_PROFILE_H264_HIGH_10 110
2901 #define FF_PROFILE_H264_HIGH_10_INTRA (110|FF_PROFILE_H264_INTRA)
2902 #define FF_PROFILE_H264_HIGH_422 122
2903 #define FF_PROFILE_H264_HIGH_422_INTRA (122|FF_PROFILE_H264_INTRA)
2904 #define FF_PROFILE_H264_HIGH_444 144
2905 #define FF_PROFILE_H264_HIGH_444_PREDICTIVE 244
2906 #define FF_PROFILE_H264_HIGH_444_INTRA (244|FF_PROFILE_H264_INTRA)
2907 #define FF_PROFILE_H264_CAVLC_444 44
2909 #define FF_PROFILE_VC1_SIMPLE 0
2910 #define FF_PROFILE_VC1_MAIN 1
2911 #define FF_PROFILE_VC1_COMPLEX 2
2912 #define FF_PROFILE_VC1_ADVANCED 3
2914 #define FF_PROFILE_MPEG4_SIMPLE 0
2915 #define FF_PROFILE_MPEG4_SIMPLE_SCALABLE 1
2916 #define FF_PROFILE_MPEG4_CORE 2
2917 #define FF_PROFILE_MPEG4_MAIN 3
2918 #define FF_PROFILE_MPEG4_N_BIT 4
2919 #define FF_PROFILE_MPEG4_SCALABLE_TEXTURE 5
2920 #define FF_PROFILE_MPEG4_SIMPLE_FACE_ANIMATION 6
2921 #define FF_PROFILE_MPEG4_BASIC_ANIMATED_TEXTURE 7
2922 #define FF_PROFILE_MPEG4_HYBRID 8
2923 #define FF_PROFILE_MPEG4_ADVANCED_REAL_TIME 9
2924 #define FF_PROFILE_MPEG4_CORE_SCALABLE 10
2925 #define FF_PROFILE_MPEG4_ADVANCED_CODING 11
2926 #define FF_PROFILE_MPEG4_ADVANCED_CORE 12
2927 #define FF_PROFILE_MPEG4_ADVANCED_SCALABLE_TEXTURE 13
2928 #define FF_PROFILE_MPEG4_SIMPLE_STUDIO 14
2929 #define FF_PROFILE_MPEG4_ADVANCED_SIMPLE 15
2931 #define FF_PROFILE_JPEG2000_CSTREAM_RESTRICTION_0 0
2932 #define FF_PROFILE_JPEG2000_CSTREAM_RESTRICTION_1 1
2933 #define FF_PROFILE_JPEG2000_CSTREAM_NO_RESTRICTION 2
2934 #define FF_PROFILE_JPEG2000_DCINEMA_2K 3
2935 #define FF_PROFILE_JPEG2000_DCINEMA_4K 4
2937 #define FF_PROFILE_VP9_0 0
2938 #define FF_PROFILE_VP9_1 1
2939 #define FF_PROFILE_VP9_2 2
2940 #define FF_PROFILE_VP9_3 3
2942 #define FF_PROFILE_HEVC_MAIN 1
2943 #define FF_PROFILE_HEVC_MAIN_10 2
2944 #define FF_PROFILE_HEVC_MAIN_STILL_PICTURE 3
2945 #define FF_PROFILE_HEVC_REXT 4
2949 * - encoding: Set by user.
2950 * - decoding: Set by libavcodec.
2953 #define FF_LEVEL_UNKNOWN -99
2956 * Skip loop filtering for selected frames.
2957 * - encoding: unused
2958 * - decoding: Set by user.
2960 enum AVDiscard skip_loop_filter;
2963 * Skip IDCT/dequantization for selected frames.
2964 * - encoding: unused
2965 * - decoding: Set by user.
2967 enum AVDiscard skip_idct;
2970 * Skip decoding for selected frames.
2971 * - encoding: unused
2972 * - decoding: Set by user.
2974 enum AVDiscard skip_frame;
2977 * Header containing style information for text subtitles.
2978 * For SUBTITLE_ASS subtitle type, it should contain the whole ASS
2979 * [Script Info] and [V4+ Styles] section, plus the [Events] line and
2980 * the Format line following. It shouldn't include any Dialogue line.
2981 * - encoding: Set/allocated/freed by user (before avcodec_open2())
2982 * - decoding: Set/allocated/freed by libavcodec (by avcodec_open2())
2984 uint8_t *subtitle_header;
2985 int subtitle_header_size;
2987 #if FF_API_ERROR_RATE
2989 * @deprecated use the 'error_rate' private AVOption of the mpegvideo
2992 attribute_deprecated
2996 #if FF_API_CODEC_PKT
2998 * @deprecated this field is not supposed to be accessed from outside lavc
3000 attribute_deprecated
3005 * VBV delay coded in the last frame (in periods of a 27 MHz clock).
3006 * Used for compliant TS muxing.
3007 * - encoding: Set by libavcodec.
3008 * - decoding: unused.
3013 * Encoding only. Allow encoders to output packets that do not contain any
3014 * encoded data, only side data.
3016 * Some encoders need to output such packets, e.g. to update some stream
3017 * parameters at the end of encoding.
3019 * All callers are strongly recommended to set this option to 1 and update
3020 * their code to deal with such packets, since this behaviour may become
3021 * always enabled in the future (then this option will be deprecated and
3022 * later removed). To avoid ABI issues when this happens, the callers should
3023 * use AVOptions to set this field.
3025 int side_data_only_packets;
3028 * Audio only. The number of "priming" samples (padding) inserted by the
3029 * encoder at the beginning of the audio. I.e. this number of leading
3030 * decoded samples must be discarded by the caller to get the original audio
3031 * without leading padding.
3033 * - decoding: unused
3034 * - encoding: Set by libavcodec. The timestamps on the output packets are
3035 * adjusted by the encoder so that they always refer to the
3036 * first sample of the data actually contained in the packet,
3037 * including any added padding. E.g. if the timebase is
3038 * 1/samplerate and the timestamp of the first input sample is
3039 * 0, the timestamp of the first output packet will be
3042 int initial_padding;
3045 * - decoding: For codecs that store a framerate value in the compressed
3046 * bitstream, the decoder may export it here. { 0, 1} when
3048 * - encoding: unused
3050 AVRational framerate;
3053 * Nominal unaccelerated pixel format, see AV_PIX_FMT_xxx.
3054 * - encoding: unused.
3055 * - decoding: Set by libavcodec before calling get_format()
3057 enum AVPixelFormat sw_pix_fmt;
3060 * Timebase in which pkt_dts/pts and AVPacket.dts/pts are.
3061 * Code outside libavcodec should access this field using:
3062 * av_codec_{get,set}_pkt_timebase(avctx)
3063 * - encoding unused.
3064 * - decoding set by user.
3066 AVRational pkt_timebase;
3070 * Code outside libavcodec should access this field using:
3071 * av_codec_{get,set}_codec_descriptor(avctx)
3072 * - encoding: unused.
3073 * - decoding: set by libavcodec.
3075 const AVCodecDescriptor *codec_descriptor;
3079 * low resolution decoding, 1-> 1/2 size, 2->1/4 size
3080 * - encoding: unused
3081 * - decoding: Set by user.
3082 * Code outside libavcodec should access this field using:
3083 * av_codec_{get,set}_lowres(avctx)
3089 * Current statistics for PTS correction.
3090 * - decoding: maintained and used by libavcodec, not intended to be used by user apps
3091 * - encoding: unused
3093 int64_t pts_correction_num_faulty_pts; /// Number of incorrect PTS values so far
3094 int64_t pts_correction_num_faulty_dts; /// Number of incorrect DTS values so far
3095 int64_t pts_correction_last_pts; /// PTS of the last frame
3096 int64_t pts_correction_last_dts; /// DTS of the last frame
3099 * Character encoding of the input subtitles file.
3100 * - decoding: set by user
3101 * - encoding: unused
3106 * Subtitles character encoding mode. Formats or codecs might be adjusting
3107 * this setting (if they are doing the conversion themselves for instance).
3108 * - decoding: set by libavcodec
3109 * - encoding: unused
3111 int sub_charenc_mode;
3112 #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)
3113 #define FF_SUB_CHARENC_MODE_AUTOMATIC 0 ///< libavcodec will select the mode itself
3114 #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
3117 * Skip processing alpha if supported by codec.
3118 * Note that if the format uses pre-multiplied alpha (common with VP6,
3119 * and recommended due to better video quality/compression)
3120 * the image will look as if alpha-blended onto a black background.
3121 * However for formats that do not use pre-multiplied alpha
3122 * there might be serious artefacts (though e.g. libswscale currently
3123 * assumes pre-multiplied alpha anyway).
3124 * Code outside libavcodec should access this field using AVOptions
3126 * - decoding: set by user
3127 * - encoding: unused
3132 * Number of samples to skip after a discontinuity
3133 * - decoding: unused
3134 * - encoding: set by libavcodec
3138 #if !FF_API_DEBUG_MV
3140 * debug motion vectors
3141 * Code outside libavcodec should access this field using AVOptions
3142 * - encoding: Set by user.
3143 * - decoding: Set by user.
3146 #define FF_DEBUG_VIS_MV_P_FOR 0x00000001 //visualize forward predicted MVs of P frames
3147 #define FF_DEBUG_VIS_MV_B_FOR 0x00000002 //visualize forward predicted MVs of B frames
3148 #define FF_DEBUG_VIS_MV_B_BACK 0x00000004 //visualize backward predicted MVs of B frames
3152 * custom intra quantization matrix
3153 * Code outside libavcodec should access this field using av_codec_g/set_chroma_intra_matrix()
3154 * - encoding: Set by user, can be NULL.
3155 * - decoding: unused.
3157 uint16_t *chroma_intra_matrix;
3160 * dump format separator.
3161 * can be ", " or "\n " or anything else
3162 * Code outside libavcodec should access this field using AVOptions
3163 * (NO direct access).
3164 * - encoding: Set by user.
3165 * - decoding: Set by user.
3167 uint8_t *dump_separator;
3170 * ',' separated list of allowed decoders.
3171 * If NULL then all are allowed
3172 * - encoding: unused
3173 * - decoding: set by user through AVOPtions (NO direct access)
3175 char *codec_whitelist;
3178 * Properties of the stream that gets decoded
3179 * To be accessed through av_codec_get_properties() (NO direct access)
3180 * - encoding: unused
3181 * - decoding: set by libavcodec
3183 unsigned properties;
3184 #define FF_CODEC_PROPERTY_LOSSLESS 0x00000001
3185 #define FF_CODEC_PROPERTY_CLOSED_CAPTIONS 0x00000002
3188 AVRational av_codec_get_pkt_timebase (const AVCodecContext *avctx);
3189 void av_codec_set_pkt_timebase (AVCodecContext *avctx, AVRational val);
3191 const AVCodecDescriptor *av_codec_get_codec_descriptor(const AVCodecContext *avctx);
3192 void av_codec_set_codec_descriptor(AVCodecContext *avctx, const AVCodecDescriptor *desc);
3194 unsigned av_codec_get_codec_properties(const AVCodecContext *avctx);
3196 int av_codec_get_lowres(const AVCodecContext *avctx);
3197 void av_codec_set_lowres(AVCodecContext *avctx, int val);
3199 int av_codec_get_seek_preroll(const AVCodecContext *avctx);
3200 void av_codec_set_seek_preroll(AVCodecContext *avctx, int val);
3202 uint16_t *av_codec_get_chroma_intra_matrix(const AVCodecContext *avctx);
3203 void av_codec_set_chroma_intra_matrix(AVCodecContext *avctx, uint16_t *val);
3208 typedef struct AVProfile {
3210 const char *name; ///< short name for the profile
3213 typedef struct AVCodecDefault AVCodecDefault;
3220 typedef struct AVCodec {
3222 * Name of the codec implementation.
3223 * The name is globally unique among encoders and among decoders (but an
3224 * encoder and a decoder can share the same name).
3225 * This is the primary way to find a codec from the user perspective.
3229 * Descriptive name for the codec, meant to be more human readable than name.
3230 * You should use the NULL_IF_CONFIG_SMALL() macro to define it.
3232 const char *long_name;
3233 enum AVMediaType type;
3236 * Codec capabilities.
3240 const AVRational *supported_framerates; ///< array of supported framerates, or NULL if any, array is terminated by {0,0}
3241 const enum AVPixelFormat *pix_fmts; ///< array of supported pixel formats, or NULL if unknown, array is terminated by -1
3242 const int *supported_samplerates; ///< array of supported audio samplerates, or NULL if unknown, array is terminated by 0
3243 const enum AVSampleFormat *sample_fmts; ///< array of supported sample formats, or NULL if unknown, array is terminated by -1
3244 const uint64_t *channel_layouts; ///< array of support channel layouts, or NULL if unknown. array is terminated by 0
3246 uint8_t max_lowres; ///< maximum value for lowres supported by the decoder, no direct access, use av_codec_get_max_lowres()
3248 const AVClass *priv_class; ///< AVClass for the private context
3249 const AVProfile *profiles; ///< array of recognized profiles, or NULL if unknown, array is terminated by {FF_PROFILE_UNKNOWN}
3251 /*****************************************************************
3252 * No fields below this line are part of the public API. They
3253 * may not be used outside of libavcodec and can be changed and
3255 * New public fields should be added right above.
3256 *****************************************************************
3259 struct AVCodec *next;
3261 * @name Frame-level threading support functions
3265 * If defined, called on thread contexts when they are created.
3266 * If the codec allocates writable tables in init(), re-allocate them here.
3267 * priv_data will be set to a copy of the original.
3269 int (*init_thread_copy)(AVCodecContext *);
3271 * Copy necessary context variables from a previous thread context to the current one.
3272 * If not defined, the next thread will start automatically; otherwise, the codec
3273 * must call ff_thread_finish_setup().
3275 * dst and src will (rarely) point to the same context, in which case memcpy should be skipped.
3277 int (*update_thread_context)(AVCodecContext *dst, const AVCodecContext *src);
3281 * Private codec-specific defaults.
3283 const AVCodecDefault *defaults;
3286 * Initialize codec static data, called from avcodec_register().
3288 void (*init_static_data)(struct AVCodec *codec);
3290 int (*init)(AVCodecContext *);
3291 int (*encode_sub)(AVCodecContext *, uint8_t *buf, int buf_size,
3292 const struct AVSubtitle *sub);
3294 * Encode data to an AVPacket.
3296 * @param avctx codec context
3297 * @param avpkt output AVPacket (may contain a user-provided buffer)
3298 * @param[in] frame AVFrame containing the raw data to be encoded
3299 * @param[out] got_packet_ptr encoder sets to 0 or 1 to indicate that a
3300 * non-empty packet was returned in avpkt.
3301 * @return 0 on success, negative error code on failure
3303 int (*encode2)(AVCodecContext *avctx, AVPacket *avpkt, const AVFrame *frame,
3304 int *got_packet_ptr);
3305 int (*decode)(AVCodecContext *, void *outdata, int *outdata_size, AVPacket *avpkt);
3306 int (*close)(AVCodecContext *);
3309 * Will be called when seeking
3311 void (*flush)(AVCodecContext *);
3313 * Internal codec capabilities.
3314 * See FF_CODEC_CAP_* in internal.h
3319 int av_codec_get_max_lowres(const AVCodec *codec);
3321 struct MpegEncContext;
3324 * @defgroup lavc_hwaccel AVHWAccel
3327 typedef struct AVHWAccel {
3329 * Name of the hardware accelerated codec.
3330 * The name is globally unique among encoders and among decoders (but an
3331 * encoder and a decoder can share the same name).
3336 * Type of codec implemented by the hardware accelerator.
3338 * See AVMEDIA_TYPE_xxx
3340 enum AVMediaType type;
3343 * Codec implemented by the hardware accelerator.
3345 * See AV_CODEC_ID_xxx
3350 * Supported pixel format.
3352 * Only hardware accelerated formats are supported here.
3354 enum AVPixelFormat pix_fmt;
3357 * Hardware accelerated codec capabilities.
3358 * see HWACCEL_CODEC_CAP_*
3362 /*****************************************************************
3363 * No fields below this line are part of the public API. They
3364 * may not be used outside of libavcodec and can be changed and
3366 * New public fields should be added right above.
3367 *****************************************************************
3369 struct AVHWAccel *next;
3372 * Allocate a custom buffer
3374 int (*alloc_frame)(AVCodecContext *avctx, AVFrame *frame);
3377 * Called at the beginning of each frame or field picture.
3379 * Meaningful frame information (codec specific) is guaranteed to
3380 * be parsed at this point. This function is mandatory.
3382 * Note that buf can be NULL along with buf_size set to 0.
3383 * Otherwise, this means the whole frame is available at this point.
3385 * @param avctx the codec context
3386 * @param buf the frame data buffer base
3387 * @param buf_size the size of the frame in bytes
3388 * @return zero if successful, a negative value otherwise
3390 int (*start_frame)(AVCodecContext *avctx, const uint8_t *buf, uint32_t buf_size);
3393 * Callback for each slice.
3395 * Meaningful slice information (codec specific) is guaranteed to
3396 * be parsed at this point. This function is mandatory.
3397 * The only exception is XvMC, that works on MB level.
3399 * @param avctx the codec context
3400 * @param buf the slice data buffer base
3401 * @param buf_size the size of the slice in bytes
3402 * @return zero if successful, a negative value otherwise
3404 int (*decode_slice)(AVCodecContext *avctx, const uint8_t *buf, uint32_t buf_size);
3407 * Called at the end of each frame or field picture.
3409 * The whole picture is parsed at this point and can now be sent
3410 * to the hardware accelerator. This function is mandatory.
3412 * @param avctx the codec context
3413 * @return zero if successful, a negative value otherwise
3415 int (*end_frame)(AVCodecContext *avctx);
3418 * Size of per-frame hardware accelerator private data.
3420 * Private data is allocated with av_mallocz() before
3421 * AVCodecContext.get_buffer() and deallocated after
3422 * AVCodecContext.release_buffer().
3424 int frame_priv_data_size;
3427 * Called for every Macroblock in a slice.
3429 * XvMC uses it to replace the ff_mpv_decode_mb().
3430 * Instead of decoding to raw picture, MB parameters are
3431 * stored in an array provided by the video driver.
3433 * @param s the mpeg context
3435 void (*decode_mb)(struct MpegEncContext *s);
3438 * Initialize the hwaccel private data.
3440 * This will be called from ff_get_format(), after hwaccel and
3441 * hwaccel_context are set and the hwaccel private data in AVCodecInternal
3444 int (*init)(AVCodecContext *avctx);
3447 * Uninitialize the hwaccel private data.
3449 * This will be called from get_format() or avcodec_close(), after hwaccel
3450 * and hwaccel_context are already uninitialized.
3452 int (*uninit)(AVCodecContext *avctx);
3455 * Size of the private data to allocate in
3456 * AVCodecInternal.hwaccel_priv_data.
3462 * Hardware acceleration should be used for decoding even if the codec level
3463 * used is unknown or higher than the maximum supported level reported by the
3466 #define AV_HWACCEL_FLAG_IGNORE_LEVEL (1 << 0)
3469 * Hardware acceleration can output YUV pixel formats with a different chroma
3470 * sampling than 4:2:0 and/or other than 8 bits per component.
3472 #define AV_HWACCEL_FLAG_ALLOW_HIGH_DEPTH (1 << 1)
3479 * @defgroup lavc_picture AVPicture
3481 * Functions for working with AVPicture
3486 * Picture data structure.
3488 * Up to four components can be stored into it, the last component is
3491 typedef struct AVPicture {
3492 uint8_t *data[AV_NUM_DATA_POINTERS]; ///< pointers to the image data planes
3493 int linesize[AV_NUM_DATA_POINTERS]; ///< number of bytes per line
3500 enum AVSubtitleType {
3503 SUBTITLE_BITMAP, ///< A bitmap, pict will be set
3506 * Plain text, the text field must be set by the decoder and is
3507 * authoritative. ass and pict fields may contain approximations.
3512 * Formatted text, the ass field must be set by the decoder and is
3513 * authoritative. pict and text fields may contain approximations.
3518 #define AV_SUBTITLE_FLAG_FORCED 0x00000001
3520 typedef struct AVSubtitleRect {
3521 int x; ///< top left corner of pict, undefined when pict is not set
3522 int y; ///< top left corner of pict, undefined when pict is not set
3523 int w; ///< width of pict, undefined when pict is not set
3524 int h; ///< height of pict, undefined when pict is not set
3525 int nb_colors; ///< number of colors in pict, undefined when pict is not set
3528 * data+linesize for the bitmap of this subtitle.
3529 * can be set for text/ass as well once they are rendered
3532 enum AVSubtitleType type;
3534 char *text; ///< 0 terminated plain UTF-8 text
3537 * 0 terminated ASS/SSA compatible event line.
3538 * The presentation of this is unaffected by the other values in this
3546 typedef struct AVSubtitle {
3547 uint16_t format; /* 0 = graphics */
3548 uint32_t start_display_time; /* relative to packet pts, in ms */
3549 uint32_t end_display_time; /* relative to packet pts, in ms */
3551 AVSubtitleRect **rects;
3552 int64_t pts; ///< Same as packet pts, in AV_TIME_BASE
3556 * If c is NULL, returns the first registered codec,
3557 * if c is non-NULL, returns the next registered codec after c,
3558 * or NULL if c is the last one.
3560 AVCodec *av_codec_next(const AVCodec *c);
3563 * Return the LIBAVCODEC_VERSION_INT constant.
3565 unsigned avcodec_version(void);
3568 * Return the libavcodec build-time configuration.
3570 const char *avcodec_configuration(void);
3573 * Return the libavcodec license.
3575 const char *avcodec_license(void);
3578 * Register the codec codec and initialize libavcodec.
3580 * @warning either this function or avcodec_register_all() must be called
3581 * before any other libavcodec functions.
3583 * @see avcodec_register_all()
3585 void avcodec_register(AVCodec *codec);
3588 * Register all the codecs, parsers and bitstream filters which were enabled at
3589 * configuration time. If you do not call this function you can select exactly
3590 * which formats you want to support, by using the individual registration
3593 * @see avcodec_register
3594 * @see av_register_codec_parser
3595 * @see av_register_bitstream_filter
3597 void avcodec_register_all(void);
3600 * Allocate an AVCodecContext and set its fields to default values. The
3601 * resulting struct should be freed with avcodec_free_context().
3603 * @param codec if non-NULL, allocate private data and initialize defaults
3604 * for the given codec. It is illegal to then call avcodec_open2()
3605 * with a different codec.
3606 * If NULL, then the codec-specific defaults won't be initialized,
3607 * which may result in suboptimal default settings (this is
3608 * important mainly for encoders, e.g. libx264).
3610 * @return An AVCodecContext filled with default values or NULL on failure.
3611 * @see avcodec_get_context_defaults
3613 AVCodecContext *avcodec_alloc_context3(const AVCodec *codec);
3616 * Free the codec context and everything associated with it and write NULL to
3617 * the provided pointer.
3619 void avcodec_free_context(AVCodecContext **avctx);
3622 * Set the fields of the given AVCodecContext to default values corresponding
3623 * to the given codec (defaults may be codec-dependent).
3625 * Do not call this function if a non-NULL codec has been passed
3626 * to avcodec_alloc_context3() that allocated this AVCodecContext.
3627 * If codec is non-NULL, it is illegal to call avcodec_open2() with a
3628 * different codec on this AVCodecContext.
3630 int avcodec_get_context_defaults3(AVCodecContext *s, const AVCodec *codec);
3633 * Get the AVClass for AVCodecContext. It can be used in combination with
3634 * AV_OPT_SEARCH_FAKE_OBJ for examining options.
3636 * @see av_opt_find().
3638 const AVClass *avcodec_get_class(void);
3641 * Get the AVClass for AVFrame. It can be used in combination with
3642 * AV_OPT_SEARCH_FAKE_OBJ for examining options.
3644 * @see av_opt_find().
3646 const AVClass *avcodec_get_frame_class(void);
3649 * Get the AVClass for AVSubtitleRect. It can be used in combination with
3650 * AV_OPT_SEARCH_FAKE_OBJ for examining options.
3652 * @see av_opt_find().
3654 const AVClass *avcodec_get_subtitle_rect_class(void);
3657 * Copy the settings of the source AVCodecContext into the destination
3658 * AVCodecContext. The resulting destination codec context will be
3659 * unopened, i.e. you are required to call avcodec_open2() before you
3660 * can use this AVCodecContext to decode/encode video/audio data.
3662 * @param dest target codec context, should be initialized with
3663 * avcodec_alloc_context3(NULL), but otherwise uninitialized
3664 * @param src source codec context
3665 * @return AVERROR() on error (e.g. memory allocation error), 0 on success
3667 int avcodec_copy_context(AVCodecContext *dest, const AVCodecContext *src);
3669 #if FF_API_AVFRAME_LAVC
3671 * @deprecated use av_frame_alloc()
3673 attribute_deprecated
3674 AVFrame *avcodec_alloc_frame(void);
3677 * Set the fields of the given AVFrame to default values.
3679 * @param frame The AVFrame of which the fields should be set to default values.
3681 * @deprecated use av_frame_unref()
3683 attribute_deprecated
3684 void avcodec_get_frame_defaults(AVFrame *frame);
3687 * Free the frame and any dynamically allocated objects in it,
3688 * e.g. extended_data.
3690 * @param frame frame to be freed. The pointer will be set to NULL.
3692 * @warning this function does NOT free the data buffers themselves
3693 * (it does not know how, since they might have been allocated with
3694 * a custom get_buffer()).
3696 * @deprecated use av_frame_free()
3698 attribute_deprecated
3699 void avcodec_free_frame(AVFrame **frame);
3703 * Initialize the AVCodecContext to use the given AVCodec. Prior to using this
3704 * function the context has to be allocated with avcodec_alloc_context3().
3706 * The functions avcodec_find_decoder_by_name(), avcodec_find_encoder_by_name(),
3707 * avcodec_find_decoder() and avcodec_find_encoder() provide an easy way for
3708 * retrieving a codec.
3710 * @warning This function is not thread safe!
3712 * @note Always call this function before using decoding routines (such as
3713 * @ref avcodec_decode_video2()).
3716 * avcodec_register_all();
3717 * av_dict_set(&opts, "b", "2.5M", 0);
3718 * codec = avcodec_find_decoder(AV_CODEC_ID_H264);
3722 * context = avcodec_alloc_context3(codec);
3724 * if (avcodec_open2(context, codec, opts) < 0)
3728 * @param avctx The context to initialize.
3729 * @param codec The codec to open this context for. If a non-NULL codec has been
3730 * previously passed to avcodec_alloc_context3() or
3731 * avcodec_get_context_defaults3() for this context, then this
3732 * parameter MUST be either NULL or equal to the previously passed
3734 * @param options A dictionary filled with AVCodecContext and codec-private options.
3735 * On return this object will be filled with options that were not found.
3737 * @return zero on success, a negative value on error
3738 * @see avcodec_alloc_context3(), avcodec_find_decoder(), avcodec_find_encoder(),
3739 * av_dict_set(), av_opt_find().
3741 int avcodec_open2(AVCodecContext *avctx, const AVCodec *codec, AVDictionary **options);
3744 * Close a given AVCodecContext and free all the data associated with it
3745 * (but not the AVCodecContext itself).
3747 * Calling this function on an AVCodecContext that hasn't been opened will free
3748 * the codec-specific data allocated in avcodec_alloc_context3() /
3749 * avcodec_get_context_defaults3() with a non-NULL codec. Subsequent calls will
3752 int avcodec_close(AVCodecContext *avctx);
3755 * Free all allocated data in the given subtitle struct.
3757 * @param sub AVSubtitle to free.
3759 void avsubtitle_free(AVSubtitle *sub);
3766 * @addtogroup lavc_packet
3770 #if FF_API_DESTRUCT_PACKET
3772 * Default packet destructor.
3773 * @deprecated use the AVBuffer API instead
3775 attribute_deprecated
3776 void av_destruct_packet(AVPacket *pkt);
3780 * Initialize optional fields of a packet with default values.
3782 * Note, this does not touch the data and size members, which have to be
3783 * initialized separately.
3787 void av_init_packet(AVPacket *pkt);
3790 * Allocate the payload of a packet and initialize its fields with
3794 * @param size wanted payload size
3795 * @return 0 if OK, AVERROR_xxx otherwise
3797 int av_new_packet(AVPacket *pkt, int size);
3800 * Reduce packet size, correctly zeroing padding
3803 * @param size new size
3805 void av_shrink_packet(AVPacket *pkt, int size);
3808 * Increase packet size, correctly zeroing padding
3811 * @param grow_by number of bytes by which to increase the size of the packet
3813 int av_grow_packet(AVPacket *pkt, int grow_by);
3816 * Initialize a reference-counted packet from av_malloc()ed data.
3818 * @param pkt packet to be initialized. This function will set the data, size,
3819 * buf and destruct fields, all others are left untouched.
3820 * @param data Data allocated by av_malloc() to be used as packet data. If this
3821 * function returns successfully, the data is owned by the underlying AVBuffer.
3822 * The caller may not access the data through other means.
3823 * @param size size of data in bytes, without the padding. I.e. the full buffer
3824 * size is assumed to be size + FF_INPUT_BUFFER_PADDING_SIZE.
3826 * @return 0 on success, a negative AVERROR on error
3828 int av_packet_from_data(AVPacket *pkt, uint8_t *data, int size);
3831 * @warning This is a hack - the packet memory allocation stuff is broken. The
3832 * packet is allocated if it was not really allocated.
3834 int av_dup_packet(AVPacket *pkt);
3837 * Copy packet, including contents
3839 * @return 0 on success, negative AVERROR on fail
3841 int av_copy_packet(AVPacket *dst, const AVPacket *src);
3844 * Copy packet side data
3846 * @return 0 on success, negative AVERROR on fail
3848 int av_copy_packet_side_data(AVPacket *dst, const AVPacket *src);
3853 * @param pkt packet to free
3855 void av_free_packet(AVPacket *pkt);
3858 * Allocate new information of a packet.
3861 * @param type side information type
3862 * @param size side information size
3863 * @return pointer to fresh allocated data or NULL otherwise
3865 uint8_t* av_packet_new_side_data(AVPacket *pkt, enum AVPacketSideDataType type,
3869 * Shrink the already allocated side data buffer
3872 * @param type side information type
3873 * @param size new side information size
3874 * @return 0 on success, < 0 on failure
3876 int av_packet_shrink_side_data(AVPacket *pkt, enum AVPacketSideDataType type,
3880 * Get side information from packet.
3883 * @param type desired side information type
3884 * @param size pointer for side information size to store (optional)
3885 * @return pointer to data if present or NULL otherwise
3887 uint8_t* av_packet_get_side_data(AVPacket *pkt, enum AVPacketSideDataType type,
3890 int av_packet_merge_side_data(AVPacket *pkt);
3892 int av_packet_split_side_data(AVPacket *pkt);
3894 const char *av_packet_side_data_name(enum AVPacketSideDataType type);
3897 * Pack a dictionary for use in side_data.
3899 * @param dict The dictionary to pack.
3900 * @param size pointer to store the size of the returned data
3901 * @return pointer to data if successful, NULL otherwise
3903 uint8_t *av_packet_pack_dictionary(AVDictionary *dict, int *size);
3905 * Unpack a dictionary from side_data.
3907 * @param data data from side_data
3908 * @param size size of the data
3909 * @param dict the metadata storage dictionary
3910 * @return 0 on success, < 0 on failure
3912 int av_packet_unpack_dictionary(const uint8_t *data, int size, AVDictionary **dict);
3916 * Convenience function to free all the side data stored.
3917 * All the other fields stay untouched.
3921 void av_packet_free_side_data(AVPacket *pkt);
3924 * Setup a new reference to the data described by a given packet
3926 * If src is reference-counted, setup dst as a new reference to the
3927 * buffer in src. Otherwise allocate a new buffer in dst and copy the
3928 * data from src into it.
3930 * All the other fields are copied from src.
3932 * @see av_packet_unref
3934 * @param dst Destination packet
3935 * @param src Source packet
3937 * @return 0 on success, a negative AVERROR on error.
3939 int av_packet_ref(AVPacket *dst, const AVPacket *src);
3944 * Unreference the buffer referenced by the packet and reset the
3945 * remaining packet fields to their default values.
3947 * @param pkt The packet to be unreferenced.
3949 void av_packet_unref(AVPacket *pkt);
3952 * Move every field in src to dst and reset src.
3954 * @see av_packet_unref
3956 * @param src Source packet, will be reset
3957 * @param dst Destination packet
3959 void av_packet_move_ref(AVPacket *dst, AVPacket *src);
3962 * Copy only "properties" fields from src to dst.
3964 * Properties for the purpose of this function are all the fields
3965 * beside those related to the packet data (buf, data, size)
3967 * @param dst Destination packet
3968 * @param src Source packet
3970 * @return 0 on success AVERROR on failure.
3973 int av_packet_copy_props(AVPacket *dst, const AVPacket *src);
3976 * Convert valid timing fields (timestamps / durations) in a packet from one
3977 * timebase to another. Timestamps with unknown values (AV_NOPTS_VALUE) will be
3980 * @param pkt packet on which the conversion will be performed
3981 * @param tb_src source timebase, in which the timing fields in pkt are
3983 * @param tb_dst destination timebase, to which the timing fields will be
3986 void av_packet_rescale_ts(AVPacket *pkt, AVRational tb_src, AVRational tb_dst);
3993 * @addtogroup lavc_decoding
3998 * Find a registered decoder with a matching codec ID.
4000 * @param id AVCodecID of the requested decoder
4001 * @return A decoder if one was found, NULL otherwise.
4003 AVCodec *avcodec_find_decoder(enum AVCodecID id);
4006 * Find a registered decoder with the specified name.
4008 * @param name name of the requested decoder
4009 * @return A decoder if one was found, NULL otherwise.
4011 AVCodec *avcodec_find_decoder_by_name(const char *name);
4013 #if FF_API_GET_BUFFER
4014 attribute_deprecated int avcodec_default_get_buffer(AVCodecContext *s, AVFrame *pic);
4015 attribute_deprecated void avcodec_default_release_buffer(AVCodecContext *s, AVFrame *pic);
4016 attribute_deprecated int avcodec_default_reget_buffer(AVCodecContext *s, AVFrame *pic);
4020 * The default callback for AVCodecContext.get_buffer2(). It is made public so
4021 * it can be called by custom get_buffer2() implementations for decoders without
4022 * CODEC_CAP_DR1 set.
4024 int avcodec_default_get_buffer2(AVCodecContext *s, AVFrame *frame, int flags);
4028 * Return the amount of padding in pixels which the get_buffer callback must
4029 * provide around the edge of the image for codecs which do not have the
4030 * CODEC_FLAG_EMU_EDGE flag.
4032 * @return Required padding in pixels.
4034 * @deprecated CODEC_FLAG_EMU_EDGE is deprecated, so this function is no longer
4037 attribute_deprecated
4038 unsigned avcodec_get_edge_width(void);
4042 * Modify width and height values so that they will result in a memory
4043 * buffer that is acceptable for the codec if you do not use any horizontal
4046 * May only be used if a codec with CODEC_CAP_DR1 has been opened.
4048 void avcodec_align_dimensions(AVCodecContext *s, int *width, int *height);
4051 * Modify width and height values so that they will result in a memory
4052 * buffer that is acceptable for the codec if you also ensure that all
4053 * line sizes are a multiple of the respective linesize_align[i].
4055 * May only be used if a codec with CODEC_CAP_DR1 has been opened.
4057 void avcodec_align_dimensions2(AVCodecContext *s, int *width, int *height,
4058 int linesize_align[AV_NUM_DATA_POINTERS]);
4061 * Converts AVChromaLocation to swscale x/y chroma position.
4063 * The positions represent the chroma (0,0) position in a coordinates system
4064 * with luma (0,0) representing the origin and luma(1,1) representing 256,256
4066 * @param xpos horizontal chroma sample position
4067 * @param ypos vertical chroma sample position
4069 int avcodec_enum_to_chroma_pos(int *xpos, int *ypos, enum AVChromaLocation pos);
4072 * Converts swscale x/y chroma position to AVChromaLocation.
4074 * The positions represent the chroma (0,0) position in a coordinates system
4075 * with luma (0,0) representing the origin and luma(1,1) representing 256,256
4077 * @param xpos horizontal chroma sample position
4078 * @param ypos vertical chroma sample position
4080 enum AVChromaLocation avcodec_chroma_pos_to_enum(int xpos, int ypos);
4082 #if FF_API_OLD_DECODE_AUDIO
4084 * Wrapper function which calls avcodec_decode_audio4.
4086 * @deprecated Use avcodec_decode_audio4 instead.
4088 * Decode the audio frame of size avpkt->size from avpkt->data into samples.
4089 * Some decoders may support multiple frames in a single AVPacket, such
4090 * decoders would then just decode the first frame. In this case,
4091 * avcodec_decode_audio3 has to be called again with an AVPacket that contains
4092 * the remaining data in order to decode the second frame etc.
4094 * could be outputted, frame_size_ptr is zero. Otherwise, it is the
4095 * decompressed frame size in bytes.
4097 * @warning You must set frame_size_ptr to the allocated size of the
4098 * output buffer before calling avcodec_decode_audio3().
4100 * @warning The input buffer must be FF_INPUT_BUFFER_PADDING_SIZE larger than
4101 * the actual read bytes because some optimized bitstream readers read 32 or 64
4102 * bits at once and could read over the end.
4104 * @warning The end of the input buffer avpkt->data should be set to 0 to ensure that
4105 * no overreading happens for damaged MPEG streams.
4107 * @warning You must not provide a custom get_buffer() when using
4108 * avcodec_decode_audio3(). Doing so will override it with
4109 * avcodec_default_get_buffer. Use avcodec_decode_audio4() instead,
4110 * which does allow the application to provide a custom get_buffer().
4112 * @note You might have to align the input buffer avpkt->data and output buffer
4113 * samples. The alignment requirements depend on the CPU: On some CPUs it isn't
4114 * necessary at all, on others it won't work at all if not aligned and on others
4115 * it will work but it will have an impact on performance.
4117 * In practice, avpkt->data should have 4 byte alignment at minimum and
4118 * samples should be 16 byte aligned unless the CPU doesn't need it
4119 * (AltiVec and SSE do).
4121 * @note Codecs which have the CODEC_CAP_DELAY capability set have a delay
4122 * between input and output, these need to be fed with avpkt->data=NULL,
4123 * avpkt->size=0 at the end to return the remaining frames.
4125 * @param avctx the codec context
4126 * @param[out] samples the output buffer, sample type in avctx->sample_fmt
4127 * If the sample format is planar, each channel plane will
4128 * be the same size, with no padding between channels.
4129 * @param[in,out] frame_size_ptr the output buffer size in bytes
4130 * @param[in] avpkt The input AVPacket containing the input buffer.
4131 * You can create such packet with av_init_packet() and by then setting
4132 * data and size, some decoders might in addition need other fields.
4133 * All decoders are designed to use the least fields possible though.
4134 * @return On error a negative value is returned, otherwise the number of bytes
4135 * used or zero if no frame data was decompressed (used) from the input AVPacket.
4137 attribute_deprecated int avcodec_decode_audio3(AVCodecContext *avctx, int16_t *samples,
4138 int *frame_size_ptr,
4143 * Decode the audio frame of size avpkt->size from avpkt->data into frame.
4145 * Some decoders may support multiple frames in a single AVPacket. Such
4146 * decoders would then just decode the first frame and the return value would be
4147 * less than the packet size. In this case, avcodec_decode_audio4 has to be
4148 * called again with an AVPacket containing the remaining data in order to
4149 * decode the second frame, etc... Even if no frames are returned, the packet
4150 * needs to be fed to the decoder with remaining data until it is completely
4151 * consumed or an error occurs.
4153 * Some decoders (those marked with CODEC_CAP_DELAY) have a delay between input
4154 * and output. This means that for some packets they will not immediately
4155 * produce decoded output and need to be flushed at the end of decoding to get
4156 * all the decoded data. Flushing is done by calling this function with packets
4157 * with avpkt->data set to NULL and avpkt->size set to 0 until it stops
4158 * returning samples. It is safe to flush even those decoders that are not
4159 * marked with CODEC_CAP_DELAY, then no samples will be returned.
4161 * @warning The input buffer, avpkt->data must be FF_INPUT_BUFFER_PADDING_SIZE
4162 * larger than the actual read bytes because some optimized bitstream
4163 * readers read 32 or 64 bits at once and could read over the end.
4165 * @note The AVCodecContext MUST have been opened with @ref avcodec_open2()
4166 * before packets may be fed to the decoder.
4168 * @param avctx the codec context
4169 * @param[out] frame The AVFrame in which to store decoded audio samples.
4170 * The decoder will allocate a buffer for the decoded frame by
4171 * calling the AVCodecContext.get_buffer2() callback.
4172 * When AVCodecContext.refcounted_frames is set to 1, the frame is
4173 * reference counted and the returned reference belongs to the
4174 * caller. The caller must release the frame using av_frame_unref()
4175 * when the frame is no longer needed. The caller may safely write
4176 * to the frame if av_frame_is_writable() returns 1.
4177 * When AVCodecContext.refcounted_frames is set to 0, the returned
4178 * reference belongs to the decoder and is valid only until the
4179 * next call to this function or until closing or flushing the
4180 * decoder. The caller may not write to it.
4181 * @param[out] got_frame_ptr Zero if no frame could be decoded, otherwise it is
4182 * non-zero. Note that this field being set to zero
4183 * does not mean that an error has occurred. For
4184 * decoders with CODEC_CAP_DELAY set, no given decode
4185 * call is guaranteed to produce a frame.
4186 * @param[in] avpkt The input AVPacket containing the input buffer.
4187 * At least avpkt->data and avpkt->size should be set. Some
4188 * decoders might also require additional fields to be set.
4189 * @return A negative error code is returned if an error occurred during
4190 * decoding, otherwise the number of bytes consumed from the input
4191 * AVPacket is returned.
4193 int avcodec_decode_audio4(AVCodecContext *avctx, AVFrame *frame,
4194 int *got_frame_ptr, const AVPacket *avpkt);
4197 * Decode the video frame of size avpkt->size from avpkt->data into picture.
4198 * Some decoders may support multiple frames in a single AVPacket, such
4199 * decoders would then just decode the first frame.
4201 * @warning The input buffer must be FF_INPUT_BUFFER_PADDING_SIZE larger than
4202 * the actual read bytes because some optimized bitstream readers read 32 or 64
4203 * bits at once and could read over the end.
4205 * @warning The end of the input buffer buf should be set to 0 to ensure that
4206 * no overreading happens for damaged MPEG streams.
4208 * @note Codecs which have the CODEC_CAP_DELAY capability set have a delay
4209 * between input and output, these need to be fed with avpkt->data=NULL,
4210 * avpkt->size=0 at the end to return the remaining frames.
4212 * @note The AVCodecContext MUST have been opened with @ref avcodec_open2()
4213 * before packets may be fed to the decoder.
4215 * @param avctx the codec context
4216 * @param[out] picture The AVFrame in which the decoded video frame will be stored.
4217 * Use av_frame_alloc() to get an AVFrame. The codec will
4218 * allocate memory for the actual bitmap by calling the
4219 * AVCodecContext.get_buffer2() callback.
4220 * When AVCodecContext.refcounted_frames is set to 1, the frame is
4221 * reference counted and the returned reference belongs to the
4222 * caller. The caller must release the frame using av_frame_unref()
4223 * when the frame is no longer needed. The caller may safely write
4224 * to the frame if av_frame_is_writable() returns 1.
4225 * When AVCodecContext.refcounted_frames is set to 0, the returned
4226 * reference belongs to the decoder and is valid only until the
4227 * next call to this function or until closing or flushing the
4228 * decoder. The caller may not write to it.
4230 * @param[in] avpkt The input AVPacket containing the input buffer.
4231 * You can create such packet with av_init_packet() and by then setting
4232 * data and size, some decoders might in addition need other fields like
4233 * flags&AV_PKT_FLAG_KEY. All decoders are designed to use the least
4235 * @param[in,out] got_picture_ptr Zero if no frame could be decompressed, otherwise, it is nonzero.
4236 * @return On error a negative value is returned, otherwise the number of bytes
4237 * used or zero if no frame could be decompressed.
4239 int avcodec_decode_video2(AVCodecContext *avctx, AVFrame *picture,
4240 int *got_picture_ptr,
4241 const AVPacket *avpkt);
4244 * Decode a subtitle message.
4245 * Return a negative value on error, otherwise return the number of bytes used.
4246 * If no subtitle could be decompressed, got_sub_ptr is zero.
4247 * Otherwise, the subtitle is stored in *sub.
4248 * Note that CODEC_CAP_DR1 is not available for subtitle codecs. This is for
4249 * simplicity, because the performance difference is expect to be negligible
4250 * and reusing a get_buffer written for video codecs would probably perform badly
4251 * due to a potentially very different allocation pattern.
4253 * Some decoders (those marked with CODEC_CAP_DELAY) have a delay between input
4254 * and output. This means that for some packets they will not immediately
4255 * produce decoded output and need to be flushed at the end of decoding to get
4256 * all the decoded data. Flushing is done by calling this function with packets
4257 * with avpkt->data set to NULL and avpkt->size set to 0 until it stops
4258 * returning subtitles. It is safe to flush even those decoders that are not
4259 * marked with CODEC_CAP_DELAY, then no subtitles will be returned.
4261 * @note The AVCodecContext MUST have been opened with @ref avcodec_open2()
4262 * before packets may be fed to the decoder.
4264 * @param avctx the codec context
4265 * @param[out] sub The Preallocated AVSubtitle in which the decoded subtitle will be stored,
4266 * must be freed with avsubtitle_free if *got_sub_ptr is set.
4267 * @param[in,out] got_sub_ptr Zero if no subtitle could be decompressed, otherwise, it is nonzero.
4268 * @param[in] avpkt The input AVPacket containing the input buffer.
4270 int avcodec_decode_subtitle2(AVCodecContext *avctx, AVSubtitle *sub,
4275 * @defgroup lavc_parsing Frame parsing
4279 enum AVPictureStructure {
4280 AV_PICTURE_STRUCTURE_UNKNOWN, //< unknown
4281 AV_PICTURE_STRUCTURE_TOP_FIELD, //< coded as top field
4282 AV_PICTURE_STRUCTURE_BOTTOM_FIELD, //< coded as bottom field
4283 AV_PICTURE_STRUCTURE_FRAME, //< coded as frame
4286 typedef struct AVCodecParserContext {
4288 struct AVCodecParser *parser;
4289 int64_t frame_offset; /* offset of the current frame */
4290 int64_t cur_offset; /* current offset
4291 (incremented by each av_parser_parse()) */
4292 int64_t next_frame_offset; /* offset of the next frame */
4294 int pict_type; /* XXX: Put it back in AVCodecContext. */
4296 * This field is used for proper frame duration computation in lavf.
4297 * It signals, how much longer the frame duration of the current frame
4298 * is compared to normal frame duration.
4300 * frame_duration = (1 + repeat_pict) * time_base
4302 * It is used by codecs like H.264 to display telecined material.
4304 int repeat_pict; /* XXX: Put it back in AVCodecContext. */
4305 int64_t pts; /* pts of the current frame */
4306 int64_t dts; /* dts of the current frame */
4311 int fetch_timestamp;
4313 #define AV_PARSER_PTS_NB 4
4314 int cur_frame_start_index;
4315 int64_t cur_frame_offset[AV_PARSER_PTS_NB];
4316 int64_t cur_frame_pts[AV_PARSER_PTS_NB];
4317 int64_t cur_frame_dts[AV_PARSER_PTS_NB];
4320 #define PARSER_FLAG_COMPLETE_FRAMES 0x0001
4321 #define PARSER_FLAG_ONCE 0x0002
4322 /// Set if the parser has a valid file offset
4323 #define PARSER_FLAG_FETCHED_OFFSET 0x0004
4324 #define PARSER_FLAG_USE_CODEC_TS 0x1000
4326 int64_t offset; ///< byte offset from starting packet start
4327 int64_t cur_frame_end[AV_PARSER_PTS_NB];
4330 * Set by parser to 1 for key frames and 0 for non-key frames.
4331 * It is initialized to -1, so if the parser doesn't set this flag,
4332 * old-style fallback using AV_PICTURE_TYPE_I picture type as key frames
4338 * Time difference in stream time base units from the pts of this
4339 * packet to the point at which the output from the decoder has converged
4340 * independent from the availability of previous frames. That is, the
4341 * frames are virtually identical no matter if decoding started from
4342 * the very first frame or from this keyframe.
4343 * Is AV_NOPTS_VALUE if unknown.
4344 * This field is not the display duration of the current frame.
4345 * This field has no meaning if the packet does not have AV_PKT_FLAG_KEY
4348 * The purpose of this field is to allow seeking in streams that have no
4349 * keyframes in the conventional sense. It corresponds to the
4350 * recovery point SEI in H.264 and match_time_delta in NUT. It is also
4351 * essential for some types of subtitle streams to ensure that all
4352 * subtitles are correctly displayed after seeking.
4354 int64_t convergence_duration;
4356 // Timestamp generation support:
4358 * Synchronization point for start of timestamp generation.
4360 * Set to >0 for sync point, 0 for no sync point and <0 for undefined
4363 * For example, this corresponds to presence of H.264 buffering period
4369 * Offset of the current timestamp against last timestamp sync point in
4370 * units of AVCodecContext.time_base.
4372 * Set to INT_MIN when dts_sync_point unused. Otherwise, it must
4373 * contain a valid timestamp offset.
4375 * Note that the timestamp of sync point has usually a nonzero
4376 * dts_ref_dts_delta, which refers to the previous sync point. Offset of
4377 * the next frame after timestamp sync point will be usually 1.
4379 * For example, this corresponds to H.264 cpb_removal_delay.
4381 int dts_ref_dts_delta;
4384 * Presentation delay of current frame in units of AVCodecContext.time_base.
4386 * Set to INT_MIN when dts_sync_point unused. Otherwise, it must
4387 * contain valid non-negative timestamp delta (presentation time of a frame
4388 * must not lie in the past).
4390 * This delay represents the difference between decoding and presentation
4391 * time of the frame.
4393 * For example, this corresponds to H.264 dpb_output_delay.
4398 * Position of the packet in file.
4400 * Analogous to cur_frame_pts/dts
4402 int64_t cur_frame_pos[AV_PARSER_PTS_NB];
4405 * Byte position of currently parsed frame in stream.
4410 * Previous frame byte position.
4415 * Duration of the current frame.
4416 * For audio, this is in units of 1 / AVCodecContext.sample_rate.
4417 * For all other types, this is in units of AVCodecContext.time_base.
4421 enum AVFieldOrder field_order;
4424 * Indicate whether a picture is coded as a frame, top field or bottom field.
4426 * For example, H.264 field_pic_flag equal to 0 corresponds to
4427 * AV_PICTURE_STRUCTURE_FRAME. An H.264 picture with field_pic_flag
4428 * equal to 1 and bottom_field_flag equal to 0 corresponds to
4429 * AV_PICTURE_STRUCTURE_TOP_FIELD.
4431 enum AVPictureStructure picture_structure;
4434 * Picture number incremented in presentation or output order.
4435 * This field may be reinitialized at the first picture of a new sequence.
4437 * For example, this corresponds to H.264 PicOrderCnt.
4439 int output_picture_number;
4442 * Dimensions of the decoded video intended for presentation.
4448 * Dimensions of the coded video.
4454 * The format of the coded data, corresponds to enum AVPixelFormat for video
4455 * and for enum AVSampleFormat for audio.
4457 * Note that a decoder can have considerable freedom in how exactly it
4458 * decodes the data, so the format reported here might be different from the
4459 * one returned by a decoder.
4462 } AVCodecParserContext;
4464 typedef struct AVCodecParser {
4465 int codec_ids[5]; /* several codec IDs are permitted */
4467 int (*parser_init)(AVCodecParserContext *s);
4468 /* This callback never returns an error, a negative value means that
4469 * the frame start was in a previous packet. */
4470 int (*parser_parse)(AVCodecParserContext *s,
4471 AVCodecContext *avctx,
4472 const uint8_t **poutbuf, int *poutbuf_size,
4473 const uint8_t *buf, int buf_size);
4474 void (*parser_close)(AVCodecParserContext *s);
4475 int (*split)(AVCodecContext *avctx, const uint8_t *buf, int buf_size);
4476 struct AVCodecParser *next;
4479 AVCodecParser *av_parser_next(const AVCodecParser *c);
4481 void av_register_codec_parser(AVCodecParser *parser);
4482 AVCodecParserContext *av_parser_init(int codec_id);
4487 * @param s parser context.
4488 * @param avctx codec context.
4489 * @param poutbuf set to pointer to parsed buffer or NULL if not yet finished.
4490 * @param poutbuf_size set to size of parsed buffer or zero if not yet finished.
4491 * @param buf input buffer.
4492 * @param buf_size input length, to signal EOF, this should be 0 (so that the last frame can be output).
4493 * @param pts input presentation timestamp.
4494 * @param dts input decoding timestamp.
4495 * @param pos input byte position in stream.
4496 * @return the number of bytes of the input bitstream used.
4501 * len = av_parser_parse2(myparser, AVCodecContext, &data, &size,
4508 * decode_frame(data, size);
4512 int av_parser_parse2(AVCodecParserContext *s,
4513 AVCodecContext *avctx,
4514 uint8_t **poutbuf, int *poutbuf_size,
4515 const uint8_t *buf, int buf_size,
4516 int64_t pts, int64_t dts,
4520 * @return 0 if the output buffer is a subset of the input, 1 if it is allocated and must be freed
4521 * @deprecated use AVBitStreamFilter
4523 int av_parser_change(AVCodecParserContext *s,
4524 AVCodecContext *avctx,
4525 uint8_t **poutbuf, int *poutbuf_size,
4526 const uint8_t *buf, int buf_size, int keyframe);
4527 void av_parser_close(AVCodecParserContext *s);
4535 * @addtogroup lavc_encoding
4540 * Find a registered encoder with a matching codec ID.
4542 * @param id AVCodecID of the requested encoder
4543 * @return An encoder if one was found, NULL otherwise.
4545 AVCodec *avcodec_find_encoder(enum AVCodecID id);
4548 * Find a registered encoder with the specified name.
4550 * @param name name of the requested encoder
4551 * @return An encoder if one was found, NULL otherwise.
4553 AVCodec *avcodec_find_encoder_by_name(const char *name);
4555 #if FF_API_OLD_ENCODE_AUDIO
4557 * Encode an audio frame from samples into buf.
4559 * @deprecated Use avcodec_encode_audio2 instead.
4561 * @note The output buffer should be at least FF_MIN_BUFFER_SIZE bytes large.
4562 * However, for codecs with avctx->frame_size equal to 0 (e.g. PCM) the user
4563 * will know how much space is needed because it depends on the value passed
4564 * in buf_size as described below. In that case a lower value can be used.
4566 * @param avctx the codec context
4567 * @param[out] buf the output buffer
4568 * @param[in] buf_size the output buffer size
4569 * @param[in] samples the input buffer containing the samples
4570 * The number of samples read from this buffer is frame_size*channels,
4571 * both of which are defined in avctx.
4572 * For codecs which have avctx->frame_size equal to 0 (e.g. PCM) the number of
4573 * samples read from samples is equal to:
4574 * buf_size * 8 / (avctx->channels * av_get_bits_per_sample(avctx->codec_id))
4575 * This also implies that av_get_bits_per_sample() must not return 0 for these
4577 * @return On error a negative value is returned, on success zero or the number
4578 * of bytes used to encode the data read from the input buffer.
4580 int attribute_deprecated avcodec_encode_audio(AVCodecContext *avctx,
4581 uint8_t *buf, int buf_size,
4582 const short *samples);
4586 * Encode a frame of audio.
4588 * Takes input samples from frame and writes the next output packet, if
4589 * available, to avpkt. The output packet does not necessarily contain data for
4590 * the most recent frame, as encoders can delay, split, and combine input frames
4591 * internally as needed.
4593 * @param avctx codec context
4594 * @param avpkt output AVPacket.
4595 * The user can supply an output buffer by setting
4596 * avpkt->data and avpkt->size prior to calling the
4597 * function, but if the size of the user-provided data is not
4598 * large enough, encoding will fail. If avpkt->data and
4599 * avpkt->size are set, avpkt->destruct must also be set. All
4600 * other AVPacket fields will be reset by the encoder using
4601 * av_init_packet(). If avpkt->data is NULL, the encoder will
4602 * allocate it. The encoder will set avpkt->size to the size
4603 * of the output packet.
4605 * If this function fails or produces no output, avpkt will be
4606 * freed using av_free_packet() (i.e. avpkt->destruct will be
4607 * called to free the user supplied buffer).
4608 * @param[in] frame AVFrame containing the raw audio data to be encoded.
4609 * May be NULL when flushing an encoder that has the
4610 * CODEC_CAP_DELAY capability set.
4611 * If CODEC_CAP_VARIABLE_FRAME_SIZE is set, then each frame
4612 * can have any number of samples.
4613 * If it is not set, frame->nb_samples must be equal to
4614 * avctx->frame_size for all frames except the last.
4615 * The final frame may be smaller than avctx->frame_size.
4616 * @param[out] got_packet_ptr This field is set to 1 by libavcodec if the
4617 * output packet is non-empty, and to 0 if it is
4618 * empty. If the function returns an error, the
4619 * packet can be assumed to be invalid, and the
4620 * value of got_packet_ptr is undefined and should
4622 * @return 0 on success, negative error code on failure
4624 int avcodec_encode_audio2(AVCodecContext *avctx, AVPacket *avpkt,
4625 const AVFrame *frame, int *got_packet_ptr);
4627 #if FF_API_OLD_ENCODE_VIDEO
4629 * @deprecated use avcodec_encode_video2() instead.
4631 * Encode a video frame from pict into buf.
4632 * The input picture should be
4633 * stored using a specific format, namely avctx.pix_fmt.
4635 * @param avctx the codec context
4636 * @param[out] buf the output buffer for the bitstream of encoded frame
4637 * @param[in] buf_size the size of the output buffer in bytes
4638 * @param[in] pict the input picture to encode
4639 * @return On error a negative value is returned, on success zero or the number
4640 * of bytes used from the output buffer.
4642 attribute_deprecated
4643 int avcodec_encode_video(AVCodecContext *avctx, uint8_t *buf, int buf_size,
4644 const AVFrame *pict);
4648 * Encode a frame of video.
4650 * Takes input raw video data from frame and writes the next output packet, if
4651 * available, to avpkt. The output packet does not necessarily contain data for
4652 * the most recent frame, as encoders can delay and reorder input frames
4653 * internally as needed.
4655 * @param avctx codec context
4656 * @param avpkt output AVPacket.
4657 * The user can supply an output buffer by setting
4658 * avpkt->data and avpkt->size prior to calling the
4659 * function, but if the size of the user-provided data is not
4660 * large enough, encoding will fail. All other AVPacket fields
4661 * will be reset by the encoder using av_init_packet(). If
4662 * avpkt->data is NULL, the encoder will allocate it.
4663 * The encoder will set avpkt->size to the size of the
4664 * output packet. The returned data (if any) belongs to the
4665 * caller, he is responsible for freeing it.
4667 * If this function fails or produces no output, avpkt will be
4668 * freed using av_free_packet() (i.e. avpkt->destruct will be
4669 * called to free the user supplied buffer).
4670 * @param[in] frame AVFrame containing the raw video data to be encoded.
4671 * May be NULL when flushing an encoder that has the
4672 * CODEC_CAP_DELAY capability set.
4673 * @param[out] got_packet_ptr This field is set to 1 by libavcodec if the
4674 * output packet is non-empty, and to 0 if it is
4675 * empty. If the function returns an error, the
4676 * packet can be assumed to be invalid, and the
4677 * value of got_packet_ptr is undefined and should
4679 * @return 0 on success, negative error code on failure
4681 int avcodec_encode_video2(AVCodecContext *avctx, AVPacket *avpkt,
4682 const AVFrame *frame, int *got_packet_ptr);
4684 int avcodec_encode_subtitle(AVCodecContext *avctx, uint8_t *buf, int buf_size,
4685 const AVSubtitle *sub);
4692 #if FF_API_AVCODEC_RESAMPLE
4694 * @defgroup lavc_resample Audio resampling
4696 * @deprecated use libswresample instead
4700 struct ReSampleContext;
4701 struct AVResampleContext;
4703 typedef struct ReSampleContext ReSampleContext;
4706 * Initialize audio resampling context.
4708 * @param output_channels number of output channels
4709 * @param input_channels number of input channels
4710 * @param output_rate output sample rate
4711 * @param input_rate input sample rate
4712 * @param sample_fmt_out requested output sample format
4713 * @param sample_fmt_in input sample format
4714 * @param filter_length length of each FIR filter in the filterbank relative to the cutoff frequency
4715 * @param log2_phase_count log2 of the number of entries in the polyphase filterbank
4716 * @param linear if 1 then the used FIR filter will be linearly interpolated
4717 between the 2 closest, if 0 the closest will be used
4718 * @param cutoff cutoff frequency, 1.0 corresponds to half the output sampling rate
4719 * @return allocated ReSampleContext, NULL if error occurred
4721 attribute_deprecated
4722 ReSampleContext *av_audio_resample_init(int output_channels, int input_channels,
4723 int output_rate, int input_rate,
4724 enum AVSampleFormat sample_fmt_out,
4725 enum AVSampleFormat sample_fmt_in,
4726 int filter_length, int log2_phase_count,
4727 int linear, double cutoff);
4729 attribute_deprecated
4730 int audio_resample(ReSampleContext *s, short *output, short *input, int nb_samples);
4733 * Free resample context.
4735 * @param s a non-NULL pointer to a resample context previously
4736 * created with av_audio_resample_init()
4738 attribute_deprecated
4739 void audio_resample_close(ReSampleContext *s);
4743 * Initialize an audio resampler.
4744 * Note, if either rate is not an integer then simply scale both rates up so they are.
4745 * @param filter_length length of each FIR filter in the filterbank relative to the cutoff freq
4746 * @param log2_phase_count log2 of the number of entries in the polyphase filterbank
4747 * @param linear If 1 then the used FIR filter will be linearly interpolated
4748 between the 2 closest, if 0 the closest will be used
4749 * @param cutoff cutoff frequency, 1.0 corresponds to half the output sampling rate
4751 attribute_deprecated
4752 struct AVResampleContext *av_resample_init(int out_rate, int in_rate, int filter_length, int log2_phase_count, int linear, double cutoff);
4755 * Resample an array of samples using a previously configured context.
4756 * @param src an array of unconsumed samples
4757 * @param consumed the number of samples of src which have been consumed are returned here
4758 * @param src_size the number of unconsumed samples available
4759 * @param dst_size the amount of space in samples available in dst
4760 * @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.
4761 * @return the number of samples written in dst or -1 if an error occurred
4763 attribute_deprecated
4764 int av_resample(struct AVResampleContext *c, short *dst, short *src, int *consumed, int src_size, int dst_size, int update_ctx);
4768 * Compensate samplerate/timestamp drift. The compensation is done by changing
4769 * the resampler parameters, so no audible clicks or similar distortions occur
4770 * @param compensation_distance distance in output samples over which the compensation should be performed
4771 * @param sample_delta number of output samples which should be output less
4773 * example: av_resample_compensate(c, 10, 500)
4774 * here instead of 510 samples only 500 samples would be output
4776 * note, due to rounding the actual compensation might be slightly different,
4777 * especially if the compensation_distance is large and the in_rate used during init is small
4779 attribute_deprecated
4780 void av_resample_compensate(struct AVResampleContext *c, int sample_delta, int compensation_distance);
4781 attribute_deprecated
4782 void av_resample_close(struct AVResampleContext *c);
4790 * @addtogroup lavc_picture
4795 * Allocate memory for the pixels of a picture and setup the AVPicture
4798 * Call avpicture_free() to free it.
4800 * @param picture the picture structure to be filled in
4801 * @param pix_fmt the pixel format of the picture
4802 * @param width the width of the picture
4803 * @param height the height of the picture
4804 * @return zero if successful, a negative error code otherwise
4806 * @see av_image_alloc(), avpicture_fill()
4808 int avpicture_alloc(AVPicture *picture, enum AVPixelFormat pix_fmt, int width, int height);
4811 * Free a picture previously allocated by avpicture_alloc().
4812 * The data buffer used by the AVPicture is freed, but the AVPicture structure
4815 * @param picture the AVPicture to be freed
4817 void avpicture_free(AVPicture *picture);
4820 * Setup the picture fields based on the specified image parameters
4821 * and the provided image data buffer.
4823 * The picture fields are filled in by using the image data buffer
4824 * pointed to by ptr.
4826 * If ptr is NULL, the function will fill only the picture linesize
4827 * array and return the required size for the image buffer.
4829 * To allocate an image buffer and fill the picture data in one call,
4830 * use avpicture_alloc().
4832 * @param picture the picture to be filled in
4833 * @param ptr buffer where the image data is stored, or NULL
4834 * @param pix_fmt the pixel format of the image
4835 * @param width the width of the image in pixels
4836 * @param height the height of the image in pixels
4837 * @return the size in bytes required for src, a negative error code
4838 * in case of failure
4840 * @see av_image_fill_arrays()
4842 int avpicture_fill(AVPicture *picture, const uint8_t *ptr,
4843 enum AVPixelFormat pix_fmt, int width, int height);
4846 * Copy pixel data from an AVPicture into a buffer.
4848 * avpicture_get_size() can be used to compute the required size for
4849 * the buffer to fill.
4851 * @param src source picture with filled data
4852 * @param pix_fmt picture pixel format
4853 * @param width picture width
4854 * @param height picture height
4855 * @param dest destination buffer
4856 * @param dest_size destination buffer size in bytes
4857 * @return the number of bytes written to dest, or a negative value
4858 * (error code) on error, for example if the destination buffer is not
4861 * @see av_image_copy_to_buffer()
4863 int avpicture_layout(const AVPicture *src, enum AVPixelFormat pix_fmt,
4864 int width, int height,
4865 unsigned char *dest, int dest_size);
4868 * Calculate the size in bytes that a picture of the given width and height
4869 * would occupy if stored in the given picture format.
4871 * @param pix_fmt picture pixel format
4872 * @param width picture width
4873 * @param height picture height
4874 * @return the computed picture buffer size or a negative error code
4877 * @see av_image_get_buffer_size().
4879 int avpicture_get_size(enum AVPixelFormat pix_fmt, int width, int height);
4881 #if FF_API_DEINTERLACE
4883 * deinterlace - if not supported return -1
4885 * @deprecated - use yadif (in libavfilter) instead
4887 attribute_deprecated
4888 int avpicture_deinterlace(AVPicture *dst, const AVPicture *src,
4889 enum AVPixelFormat pix_fmt, int width, int height);
4892 * Copy image src to dst. Wraps av_image_copy().
4894 void av_picture_copy(AVPicture *dst, const AVPicture *src,
4895 enum AVPixelFormat pix_fmt, int width, int height);
4898 * Crop image top and left side.
4900 int av_picture_crop(AVPicture *dst, const AVPicture *src,
4901 enum AVPixelFormat pix_fmt, int top_band, int left_band);
4906 int av_picture_pad(AVPicture *dst, const AVPicture *src, int height, int width, enum AVPixelFormat pix_fmt,
4907 int padtop, int padbottom, int padleft, int padright, int *color);
4914 * @defgroup lavc_misc Utility functions
4917 * Miscellaneous utility functions related to both encoding and decoding
4923 * @defgroup lavc_misc_pixfmt Pixel formats
4925 * Functions for working with pixel formats.
4930 * Utility function to access log2_chroma_w log2_chroma_h from
4931 * the pixel format AVPixFmtDescriptor.
4933 * This function asserts that pix_fmt is valid. See av_pix_fmt_get_chroma_sub_sample
4934 * for one that returns a failure code and continues in case of invalid
4937 * @param[in] pix_fmt the pixel format
4938 * @param[out] h_shift store log2_chroma_w
4939 * @param[out] v_shift store log2_chroma_h
4941 * @see av_pix_fmt_get_chroma_sub_sample
4944 void avcodec_get_chroma_sub_sample(enum AVPixelFormat pix_fmt, int *h_shift, int *v_shift);
4947 * Return a value representing the fourCC code associated to the
4948 * pixel format pix_fmt, or 0 if no associated fourCC code can be
4951 unsigned int avcodec_pix_fmt_to_codec_tag(enum AVPixelFormat pix_fmt);
4954 * @deprecated see av_get_pix_fmt_loss()
4956 int avcodec_get_pix_fmt_loss(enum AVPixelFormat dst_pix_fmt, enum AVPixelFormat src_pix_fmt,
4960 * Find the best pixel format to convert to given a certain source pixel
4961 * format. When converting from one pixel format to another, information loss
4962 * may occur. For example, when converting from RGB24 to GRAY, the color
4963 * information will be lost. Similarly, other losses occur when converting from
4964 * some formats to other formats. avcodec_find_best_pix_fmt_of_2() searches which of
4965 * the given pixel formats should be used to suffer the least amount of loss.
4966 * The pixel formats from which it chooses one, are determined by the
4967 * pix_fmt_list parameter.
4970 * @param[in] pix_fmt_list AV_PIX_FMT_NONE terminated array of pixel formats to choose from
4971 * @param[in] src_pix_fmt source pixel format
4972 * @param[in] has_alpha Whether the source pixel format alpha channel is used.
4973 * @param[out] loss_ptr Combination of flags informing you what kind of losses will occur.
4974 * @return The best pixel format to convert to or -1 if none was found.
4976 enum AVPixelFormat avcodec_find_best_pix_fmt_of_list(const enum AVPixelFormat *pix_fmt_list,
4977 enum AVPixelFormat src_pix_fmt,
4978 int has_alpha, int *loss_ptr);
4981 * @deprecated see av_find_best_pix_fmt_of_2()
4983 enum AVPixelFormat avcodec_find_best_pix_fmt_of_2(enum AVPixelFormat dst_pix_fmt1, enum AVPixelFormat dst_pix_fmt2,
4984 enum AVPixelFormat src_pix_fmt, int has_alpha, int *loss_ptr);
4986 attribute_deprecated
4987 #if AV_HAVE_INCOMPATIBLE_LIBAV_ABI
4988 enum AVPixelFormat avcodec_find_best_pix_fmt2(const enum AVPixelFormat *pix_fmt_list,
4989 enum AVPixelFormat src_pix_fmt,
4990 int has_alpha, int *loss_ptr);
4992 enum AVPixelFormat avcodec_find_best_pix_fmt2(enum AVPixelFormat dst_pix_fmt1, enum AVPixelFormat dst_pix_fmt2,
4993 enum AVPixelFormat src_pix_fmt, int has_alpha, int *loss_ptr);
4997 enum AVPixelFormat avcodec_default_get_format(struct AVCodecContext *s, const enum AVPixelFormat * fmt);
5003 #if FF_API_SET_DIMENSIONS
5005 * @deprecated this function is not supposed to be used from outside of lavc
5007 attribute_deprecated
5008 void avcodec_set_dimensions(AVCodecContext *s, int width, int height);
5012 * Put a string representing the codec tag codec_tag in buf.
5014 * @param buf buffer to place codec tag in
5015 * @param buf_size size in bytes of buf
5016 * @param codec_tag codec tag to assign
5017 * @return the length of the string that would have been generated if
5018 * enough space had been available, excluding the trailing null
5020 size_t av_get_codec_tag_string(char *buf, size_t buf_size, unsigned int codec_tag);
5022 void avcodec_string(char *buf, int buf_size, AVCodecContext *enc, int encode);
5025 * Return a name for the specified profile, if available.
5027 * @param codec the codec that is searched for the given profile
5028 * @param profile the profile value for which a name is requested
5029 * @return A name for the profile if found, NULL otherwise.
5031 const char *av_get_profile_name(const AVCodec *codec, int profile);
5033 int avcodec_default_execute(AVCodecContext *c, int (*func)(AVCodecContext *c2, void *arg2),void *arg, int *ret, int count, int size);
5034 int avcodec_default_execute2(AVCodecContext *c, int (*func)(AVCodecContext *c2, void *arg2, int, int),void *arg, int *ret, int count);
5035 //FIXME func typedef
5038 * Fill AVFrame audio data and linesize pointers.
5040 * The buffer buf must be a preallocated buffer with a size big enough
5041 * to contain the specified samples amount. The filled AVFrame data
5042 * pointers will point to this buffer.
5044 * AVFrame extended_data channel pointers are allocated if necessary for
5047 * @param frame the AVFrame
5048 * frame->nb_samples must be set prior to calling the
5049 * function. This function fills in frame->data,
5050 * frame->extended_data, frame->linesize[0].
5051 * @param nb_channels channel count
5052 * @param sample_fmt sample format
5053 * @param buf buffer to use for frame data
5054 * @param buf_size size of buffer
5055 * @param align plane size sample alignment (0 = default)
5056 * @return >=0 on success, negative error code on failure
5057 * @todo return the size in bytes required to store the samples in
5058 * case of success, at the next libavutil bump
5060 int avcodec_fill_audio_frame(AVFrame *frame, int nb_channels,
5061 enum AVSampleFormat sample_fmt, const uint8_t *buf,
5062 int buf_size, int align);
5065 * Reset the internal decoder state / flush internal buffers. Should be called
5066 * e.g. when seeking or when switching to a different stream.
5068 * @note when refcounted frames are not used (i.e. avctx->refcounted_frames is 0),
5069 * this invalidates the frames previously returned from the decoder. When
5070 * refcounted frames are used, the decoder just releases any references it might
5071 * keep internally, but the caller's reference remains valid.
5073 void avcodec_flush_buffers(AVCodecContext *avctx);
5076 * Return codec bits per sample.
5078 * @param[in] codec_id the codec
5079 * @return Number of bits per sample or zero if unknown for the given codec.
5081 int av_get_bits_per_sample(enum AVCodecID codec_id);
5084 * Return the PCM codec associated with a sample format.
5085 * @param be endianness, 0 for little, 1 for big,
5086 * -1 (or anything else) for native
5087 * @return AV_CODEC_ID_PCM_* or AV_CODEC_ID_NONE
5089 enum AVCodecID av_get_pcm_codec(enum AVSampleFormat fmt, int be);
5092 * Return codec bits per sample.
5093 * Only return non-zero if the bits per sample is exactly correct, not an
5096 * @param[in] codec_id the codec
5097 * @return Number of bits per sample or zero if unknown for the given codec.
5099 int av_get_exact_bits_per_sample(enum AVCodecID codec_id);
5102 * Return audio frame duration.
5104 * @param avctx codec context
5105 * @param frame_bytes size of the frame, or 0 if unknown
5106 * @return frame duration, in samples, if known. 0 if not able to
5109 int av_get_audio_frame_duration(AVCodecContext *avctx, int frame_bytes);
5112 typedef struct AVBitStreamFilterContext {
5114 struct AVBitStreamFilter *filter;
5115 AVCodecParserContext *parser;
5116 struct AVBitStreamFilterContext *next;
5117 } AVBitStreamFilterContext;
5120 typedef struct AVBitStreamFilter {
5123 int (*filter)(AVBitStreamFilterContext *bsfc,
5124 AVCodecContext *avctx, const char *args,
5125 uint8_t **poutbuf, int *poutbuf_size,
5126 const uint8_t *buf, int buf_size, int keyframe);
5127 void (*close)(AVBitStreamFilterContext *bsfc);
5128 struct AVBitStreamFilter *next;
5129 } AVBitStreamFilter;
5132 * Register a bitstream filter.
5134 * The filter will be accessible to the application code through
5135 * av_bitstream_filter_next() or can be directly initialized with
5136 * av_bitstream_filter_init().
5138 * @see avcodec_register_all()
5140 void av_register_bitstream_filter(AVBitStreamFilter *bsf);
5143 * Create and initialize a bitstream filter context given a bitstream
5146 * The returned context must be freed with av_bitstream_filter_close().
5148 * @param name the name of the bitstream filter
5149 * @return a bitstream filter context if a matching filter was found
5150 * and successfully initialized, NULL otherwise
5152 AVBitStreamFilterContext *av_bitstream_filter_init(const char *name);
5157 * This function filters the buffer buf with size buf_size, and places the
5158 * filtered buffer in the buffer pointed to by poutbuf.
5160 * The output buffer must be freed by the caller.
5162 * @param bsfc bitstream filter context created by av_bitstream_filter_init()
5163 * @param avctx AVCodecContext accessed by the filter, may be NULL.
5164 * If specified, this must point to the encoder context of the
5165 * output stream the packet is sent to.
5166 * @param args arguments which specify the filter configuration, may be NULL
5167 * @param poutbuf pointer which is updated to point to the filtered buffer
5168 * @param poutbuf_size pointer which is updated to the filtered buffer size in bytes
5169 * @param buf buffer containing the data to filter
5170 * @param buf_size size in bytes of buf
5171 * @param keyframe set to non-zero if the buffer to filter corresponds to a key-frame packet data
5172 * @return >= 0 in case of success, or a negative error code in case of failure
5174 * If the return value is positive, an output buffer is allocated and
5175 * is available in *poutbuf, and is distinct from the input buffer.
5177 * If the return value is 0, the output buffer is not allocated and
5178 * should be considered identical to the input buffer, or in case
5179 * *poutbuf was set it points to the input buffer (not necessarily to
5180 * its starting address).
5182 int av_bitstream_filter_filter(AVBitStreamFilterContext *bsfc,
5183 AVCodecContext *avctx, const char *args,
5184 uint8_t **poutbuf, int *poutbuf_size,
5185 const uint8_t *buf, int buf_size, int keyframe);
5188 * Release bitstream filter context.
5190 * @param bsf the bitstream filter context created with
5191 * av_bitstream_filter_init(), can be NULL
5193 void av_bitstream_filter_close(AVBitStreamFilterContext *bsf);
5196 * If f is NULL, return the first registered bitstream filter,
5197 * if f is non-NULL, return the next registered bitstream filter
5198 * after f, or NULL if f is the last one.
5200 * This function can be used to iterate over all registered bitstream
5203 AVBitStreamFilter *av_bitstream_filter_next(const AVBitStreamFilter *f);
5208 * Same behaviour av_fast_malloc but the buffer has additional
5209 * FF_INPUT_BUFFER_PADDING_SIZE at the end which will always be 0.
5211 * In addition the whole buffer will initially and after resizes
5212 * be 0-initialized so that no uninitialized data will ever appear.
5214 void av_fast_padded_malloc(void *ptr, unsigned int *size, size_t min_size);
5217 * Same behaviour av_fast_padded_malloc except that buffer will always
5218 * be 0-initialized after call.
5220 void av_fast_padded_mallocz(void *ptr, unsigned int *size, size_t min_size);
5223 * Encode extradata length to a buffer. Used by xiph codecs.
5225 * @param s buffer to write to; must be at least (v/255+1) bytes long
5226 * @param v size of extradata in bytes
5227 * @return number of bytes written to the buffer.
5229 unsigned int av_xiphlacing(unsigned char *s, unsigned int v);
5231 #if FF_API_MISSING_SAMPLE
5233 * Log a generic warning message about a missing feature. This function is
5234 * intended to be used internally by FFmpeg (libavcodec, libavformat, etc.)
5235 * only, and would normally not be used by applications.
5236 * @param[in] avc a pointer to an arbitrary struct of which the first field is
5237 * a pointer to an AVClass struct
5238 * @param[in] feature string containing the name of the missing feature
5239 * @param[in] want_sample indicates if samples are wanted which exhibit this feature.
5240 * If want_sample is non-zero, additional verbage will be added to the log
5241 * message which tells the user how to report samples to the development
5243 * @deprecated Use avpriv_report_missing_feature() instead.
5245 attribute_deprecated
5246 void av_log_missing_feature(void *avc, const char *feature, int want_sample);
5249 * Log a generic warning message asking for a sample. This function is
5250 * intended to be used internally by FFmpeg (libavcodec, libavformat, etc.)
5251 * only, and would normally not be used by applications.
5252 * @param[in] avc a pointer to an arbitrary struct of which the first field is
5253 * a pointer to an AVClass struct
5254 * @param[in] msg string containing an optional message, or NULL if no message
5255 * @deprecated Use avpriv_request_sample() instead.
5257 attribute_deprecated
5258 void av_log_ask_for_sample(void *avc, const char *msg, ...) av_printf_format(2, 3);
5259 #endif /* FF_API_MISSING_SAMPLE */
5262 * Register the hardware accelerator hwaccel.
5264 void av_register_hwaccel(AVHWAccel *hwaccel);
5267 * If hwaccel is NULL, returns the first registered hardware accelerator,
5268 * if hwaccel is non-NULL, returns the next registered hardware accelerator
5269 * after hwaccel, or NULL if hwaccel is the last one.
5271 AVHWAccel *av_hwaccel_next(const AVHWAccel *hwaccel);
5275 * Lock operation used by lockmgr
5278 AV_LOCK_CREATE, ///< Create a mutex
5279 AV_LOCK_OBTAIN, ///< Lock the mutex
5280 AV_LOCK_RELEASE, ///< Unlock the mutex
5281 AV_LOCK_DESTROY, ///< Free mutex resources
5285 * Register a user provided lock manager supporting the operations
5286 * specified by AVLockOp. The "mutex" argument to the function points
5287 * to a (void *) where the lockmgr should store/get a pointer to a user
5288 * allocated mutex. It is NULL upon AV_LOCK_CREATE and equal to the
5289 * value left by the last call for all other ops. If the lock manager is
5290 * unable to perform the op then it should leave the mutex in the same
5291 * state as when it was called and return a non-zero value. However,
5292 * when called with AV_LOCK_DESTROY the mutex will always be assumed to
5293 * have been successfully destroyed. If av_lockmgr_register succeeds
5294 * it will return a non-negative value, if it fails it will return a
5295 * negative value and destroy all mutex and unregister all callbacks.
5296 * av_lockmgr_register is not thread-safe, it must be called from a
5297 * single thread before any calls which make use of locking are used.
5299 * @param cb User defined callback. av_lockmgr_register invokes calls
5300 * to this callback and the previously registered callback.
5301 * The callback will be used to create more than one mutex
5302 * each of which must be backed by its own underlying locking
5303 * mechanism (i.e. do not use a single static object to
5304 * implement your lock manager). If cb is set to NULL the
5305 * lockmgr will be unregistered.
5307 int av_lockmgr_register(int (*cb)(void **mutex, enum AVLockOp op));
5310 * Get the type of the given codec.
5312 enum AVMediaType avcodec_get_type(enum AVCodecID codec_id);
5315 * Get the name of a codec.
5316 * @return a static string identifying the codec; never NULL
5318 const char *avcodec_get_name(enum AVCodecID id);
5321 * @return a positive value if s is open (i.e. avcodec_open2() was called on it
5322 * with no corresponding avcodec_close()), 0 otherwise.
5324 int avcodec_is_open(AVCodecContext *s);
5327 * @return a non-zero number if codec is an encoder, zero otherwise
5329 int av_codec_is_encoder(const AVCodec *codec);
5332 * @return a non-zero number if codec is a decoder, zero otherwise
5334 int av_codec_is_decoder(const AVCodec *codec);
5337 * @return descriptor for given codec ID or NULL if no descriptor exists.
5339 const AVCodecDescriptor *avcodec_descriptor_get(enum AVCodecID id);
5342 * Iterate over all codec descriptors known to libavcodec.
5344 * @param prev previous descriptor. NULL to get the first descriptor.
5346 * @return next descriptor or NULL after the last descriptor
5348 const AVCodecDescriptor *avcodec_descriptor_next(const AVCodecDescriptor *prev);
5351 * @return codec descriptor with the given name or NULL if no such descriptor
5354 const AVCodecDescriptor *avcodec_descriptor_get_by_name(const char *name);
5360 #endif /* AVCODEC_AVCODEC_H */