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 * This side data contains an integer value representing the quality
1059 * factor of the compressed frame. Allowed range is between 1 (good)
1060 * and FF_LAMBDA_MAX (bad).
1062 AV_PKT_DATA_QUALITY_FACTOR,
1065 * Recommmends skipping the specified number of samples
1067 * u32le number of samples to skip from start of this packet
1068 * u32le number of samples to skip from end of this packet
1069 * u8 reason for start skip
1070 * u8 reason for end skip (0=padding silence, 1=convergence)
1073 AV_PKT_DATA_SKIP_SAMPLES=70,
1076 * An AV_PKT_DATA_JP_DUALMONO side data packet indicates that
1077 * the packet may contain "dual mono" audio specific to Japanese DTV
1078 * and if it is true, recommends only the selected channel to be used.
1080 * u8 selected channels (0=mail/left, 1=sub/right, 2=both)
1083 AV_PKT_DATA_JP_DUALMONO,
1086 * A list of zero terminated key/value strings. There is no end marker for
1087 * the list, so it is required to rely on the side data size to stop.
1089 AV_PKT_DATA_STRINGS_METADATA,
1092 * Subtitle event position
1100 AV_PKT_DATA_SUBTITLE_POSITION,
1103 * Data found in BlockAdditional element of matroska container. There is
1104 * no end marker for the data, so it is required to rely on the side data
1105 * size to recognize the end. 8 byte id (as found in BlockAddId) followed
1108 AV_PKT_DATA_MATROSKA_BLOCKADDITIONAL,
1111 * The optional first identifier line of a WebVTT cue.
1113 AV_PKT_DATA_WEBVTT_IDENTIFIER,
1116 * The optional settings (rendering instructions) that immediately
1117 * follow the timestamp specifier of a WebVTT cue.
1119 AV_PKT_DATA_WEBVTT_SETTINGS,
1122 * A list of zero terminated key/value strings. There is no end marker for
1123 * the list, so it is required to rely on the side data size to stop. This
1124 * side data includes updated metadata which appeared in the stream.
1126 AV_PKT_DATA_METADATA_UPDATE,
1129 typedef struct AVPacketSideData {
1132 enum AVPacketSideDataType type;
1136 * This structure stores compressed data. It is typically exported by demuxers
1137 * and then passed as input to decoders, or received as output from encoders and
1138 * then passed to muxers.
1140 * For video, it should typically contain one compressed frame. For audio it may
1141 * contain several compressed frames.
1143 * AVPacket is one of the few structs in FFmpeg, whose size is a part of public
1144 * ABI. Thus it may be allocated on stack and no new fields can be added to it
1145 * without libavcodec and libavformat major bump.
1147 * The semantics of data ownership depends on the buf or destruct (deprecated)
1148 * fields. If either is set, the packet data is dynamically allocated and is
1149 * valid indefinitely until av_free_packet() is called (which in turn calls
1150 * av_buffer_unref()/the destruct callback to free the data). If neither is set,
1151 * the packet data is typically backed by some static buffer somewhere and is
1152 * only valid for a limited time (e.g. until the next read call when demuxing).
1154 * The side data is always allocated with av_malloc() and is freed in
1157 typedef struct AVPacket {
1159 * A reference to the reference-counted buffer where the packet data is
1161 * May be NULL, then the packet data is not reference-counted.
1165 * Presentation timestamp in AVStream->time_base units; the time at which
1166 * the decompressed packet will be presented to the user.
1167 * Can be AV_NOPTS_VALUE if it is not stored in the file.
1168 * pts MUST be larger or equal to dts as presentation cannot happen before
1169 * decompression, unless one wants to view hex dumps. Some formats misuse
1170 * the terms dts and pts/cts to mean something different. Such timestamps
1171 * must be converted to true pts/dts before they are stored in AVPacket.
1175 * Decompression timestamp in AVStream->time_base units; the time at which
1176 * the packet is decompressed.
1177 * Can be AV_NOPTS_VALUE if it is not stored in the file.
1184 * A combination of AV_PKT_FLAG values
1188 * Additional packet data that can be provided by the container.
1189 * Packet can contain several types of side information.
1191 AVPacketSideData *side_data;
1192 int side_data_elems;
1195 * Duration of this packet in AVStream->time_base units, 0 if unknown.
1196 * Equals next_pts - this_pts in presentation order.
1199 #if FF_API_DESTRUCT_PACKET
1200 attribute_deprecated
1201 void (*destruct)(struct AVPacket *);
1202 attribute_deprecated
1205 int64_t pos; ///< byte position in stream, -1 if unknown
1208 * Time difference in AVStream->time_base units from the pts of this
1209 * packet to the point at which the output from the decoder has converged
1210 * independent from the availability of previous frames. That is, the
1211 * frames are virtually identical no matter if decoding started from
1212 * the very first frame or from this keyframe.
1213 * Is AV_NOPTS_VALUE if unknown.
1214 * This field is not the display duration of the current packet.
1215 * This field has no meaning if the packet does not have AV_PKT_FLAG_KEY
1218 * The purpose of this field is to allow seeking in streams that have no
1219 * keyframes in the conventional sense. It corresponds to the
1220 * recovery point SEI in H.264 and match_time_delta in NUT. It is also
1221 * essential for some types of subtitle streams to ensure that all
1222 * subtitles are correctly displayed after seeking.
1224 int64_t convergence_duration;
1226 #define AV_PKT_FLAG_KEY 0x0001 ///< The packet contains a keyframe
1227 #define AV_PKT_FLAG_CORRUPT 0x0002 ///< The packet content is corrupted
1229 enum AVSideDataParamChangeFlags {
1230 AV_SIDE_DATA_PARAM_CHANGE_CHANNEL_COUNT = 0x0001,
1231 AV_SIDE_DATA_PARAM_CHANGE_CHANNEL_LAYOUT = 0x0002,
1232 AV_SIDE_DATA_PARAM_CHANGE_SAMPLE_RATE = 0x0004,
1233 AV_SIDE_DATA_PARAM_CHANGE_DIMENSIONS = 0x0008,
1239 struct AVCodecInternal;
1243 AV_FIELD_PROGRESSIVE,
1244 AV_FIELD_TT, //< Top coded_first, top displayed first
1245 AV_FIELD_BB, //< Bottom coded first, bottom displayed first
1246 AV_FIELD_TB, //< Top coded first, bottom displayed first
1247 AV_FIELD_BT, //< Bottom coded first, top displayed first
1251 * main external API structure.
1252 * New fields can be added to the end with minor version bumps.
1253 * Removal, reordering and changes to existing fields require a major
1255 * Please use AVOptions (av_opt* / av_set/get*()) to access these fields from user
1257 * sizeof(AVCodecContext) must not be used outside libav*.
1259 typedef struct AVCodecContext {
1261 * information on struct for av_log
1262 * - set by avcodec_alloc_context3
1264 const AVClass *av_class;
1265 int log_level_offset;
1267 enum AVMediaType codec_type; /* see AVMEDIA_TYPE_xxx */
1268 const struct AVCodec *codec;
1269 #if FF_API_CODEC_NAME
1271 * @deprecated this field is not used for anything in libavcodec
1273 attribute_deprecated
1274 char codec_name[32];
1276 enum AVCodecID codec_id; /* see AV_CODEC_ID_xxx */
1279 * fourcc (LSB first, so "ABCD" -> ('D'<<24) + ('C'<<16) + ('B'<<8) + 'A').
1280 * This is used to work around some encoder bugs.
1281 * A demuxer should set this to what is stored in the field used to identify the codec.
1282 * If there are multiple such fields in a container then the demuxer should choose the one
1283 * which maximizes the information about the used codec.
1284 * If the codec tag field in a container is larger than 32 bits then the demuxer should
1285 * remap the longer ID to 32 bits with a table or other structure. Alternatively a new
1286 * extra_codec_tag + size could be added but for this a clear advantage must be demonstrated
1288 * - encoding: Set by user, if not then the default based on codec_id will be used.
1289 * - decoding: Set by user, will be converted to uppercase by libavcodec during init.
1291 unsigned int codec_tag;
1293 #if FF_API_STREAM_CODEC_TAG
1295 * @deprecated this field is unused
1297 attribute_deprecated
1298 unsigned int stream_codec_tag;
1304 * Private context used for internal data.
1306 * Unlike priv_data, this is not codec-specific. It is used in general
1307 * libavcodec functions.
1309 struct AVCodecInternal *internal;
1312 * Private data of the user, can be used to carry app specific stuff.
1313 * - encoding: Set by user.
1314 * - decoding: Set by user.
1319 * the average bitrate
1320 * - encoding: Set by user; unused for constant quantizer encoding.
1321 * - decoding: Set by user, may be overwritten by libavcodec
1322 * if this info is available in the stream
1327 * number of bits the bitstream is allowed to diverge from the reference.
1328 * the reference can be CBR (for CBR pass1) or VBR (for pass2)
1329 * - encoding: Set by user; unused for constant quantizer encoding.
1330 * - decoding: unused
1332 int bit_rate_tolerance;
1335 * Global quality for codecs which cannot change it per frame.
1336 * This should be proportional to MPEG-1/2/4 qscale.
1337 * - encoding: Set by user.
1338 * - decoding: unused
1343 * - encoding: Set by user.
1344 * - decoding: unused
1346 int compression_level;
1347 #define FF_COMPRESSION_DEFAULT -1
1351 * - encoding: Set by user.
1352 * - decoding: Set by user.
1358 * - encoding: Set by user.
1359 * - decoding: Set by user.
1364 * some codecs need / can use extradata like Huffman tables.
1365 * mjpeg: Huffman tables
1366 * rv10: additional flags
1367 * mpeg4: global headers (they can be in the bitstream or here)
1368 * The allocated memory should be FF_INPUT_BUFFER_PADDING_SIZE bytes larger
1369 * than extradata_size to avoid problems if it is read with the bitstream reader.
1370 * The bytewise contents of extradata must not depend on the architecture or CPU endianness.
1371 * - encoding: Set/allocated/freed by libavcodec.
1372 * - decoding: Set/allocated/freed by user.
1378 * This is the fundamental unit of time (in seconds) in terms
1379 * of which frame timestamps are represented. For fixed-fps content,
1380 * timebase should be 1/framerate and timestamp increments should be
1382 * This often, but not always is the inverse of the frame rate or field rate
1384 * - encoding: MUST be set by user.
1385 * - decoding: the use of this field for decoding is deprecated.
1386 * Use framerate instead.
1388 AVRational time_base;
1391 * For some codecs, the time base is closer to the field rate than the frame rate.
1392 * Most notably, H.264 and MPEG-2 specify time_base as half of frame duration
1393 * if no telecine is used ...
1395 * Set to time_base ticks per frame. Default 1, e.g., H.264/MPEG-2 set it to 2.
1397 int ticks_per_frame;
1402 * Encoding: Number of frames delay there will be from the encoder input to
1403 * the decoder output. (we assume the decoder matches the spec)
1404 * Decoding: Number of frames delay in addition to what a standard decoder
1405 * as specified in the spec would produce.
1408 * Number of frames the decoded output will be delayed relative to the
1412 * For encoding, this field is unused (see initial_padding).
1414 * For decoding, this is the number of samples the decoder needs to
1415 * output before the decoder's output is valid. When seeking, you should
1416 * start decoding this many samples prior to your desired seek point.
1418 * - encoding: Set by libavcodec.
1419 * - decoding: Set by libavcodec.
1426 * picture width / height.
1428 * @note Those fields may not match the values of the last
1429 * AVFrame outputted by avcodec_decode_video2 due frame
1432 * - encoding: MUST be set by user.
1433 * - decoding: May be set by the user before opening the decoder if known e.g.
1434 * from the container. Some decoders will require the dimensions
1435 * to be set by the caller. During decoding, the decoder may
1436 * overwrite those values as required while parsing the data.
1441 * Bitstream width / height, may be different from width/height e.g. when
1442 * the decoded frame is cropped before being output or lowres is enabled.
1444 * @note Those field may not match the value of the last
1445 * AVFrame outputted by avcodec_decode_video2 due frame
1448 * - encoding: unused
1449 * - decoding: May be set by the user before opening the decoder if known
1450 * e.g. from the container. During decoding, the decoder may
1451 * overwrite those values as required while parsing the data.
1453 int coded_width, coded_height;
1455 #if FF_API_ASPECT_EXTENDED
1456 #define FF_ASPECT_EXTENDED 15
1460 * the number of pictures in a group of pictures, or 0 for intra_only
1461 * - encoding: Set by user.
1462 * - decoding: unused
1467 * Pixel format, see AV_PIX_FMT_xxx.
1468 * May be set by the demuxer if known from headers.
1469 * May be overridden by the decoder if it knows better.
1471 * @note This field may not match the value of the last
1472 * AVFrame outputted by avcodec_decode_video2 due frame
1475 * - encoding: Set by user.
1476 * - decoding: Set by user if known, overridden by libavcodec while
1479 enum AVPixelFormat pix_fmt;
1482 * Motion estimation algorithm used for video coding.
1483 * 1 (zero), 2 (full), 3 (log), 4 (phods), 5 (epzs), 6 (x1), 7 (hex),
1484 * 8 (umh), 9 (iter), 10 (tesa) [7, 8, 10 are x264 specific, 9 is snow specific]
1485 * - encoding: MUST be set by user.
1486 * - decoding: unused
1491 * If non NULL, 'draw_horiz_band' is called by the libavcodec
1492 * decoder to draw a horizontal band. It improves cache usage. Not
1493 * all codecs can do that. You must check the codec capabilities
1495 * When multithreading is used, it may be called from multiple threads
1496 * at the same time; threads might draw different parts of the same AVFrame,
1497 * or multiple AVFrames, and there is no guarantee that slices will be drawn
1499 * The function is also used by hardware acceleration APIs.
1500 * It is called at least once during frame decoding to pass
1501 * the data needed for hardware render.
1502 * In that mode instead of pixel data, AVFrame points to
1503 * a structure specific to the acceleration API. The application
1504 * reads the structure and can change some fields to indicate progress
1506 * - encoding: unused
1507 * - decoding: Set by user.
1508 * @param height the height of the slice
1509 * @param y the y position of the slice
1510 * @param type 1->top field, 2->bottom field, 3->frame
1511 * @param offset offset into the AVFrame.data from which the slice should be read
1513 void (*draw_horiz_band)(struct AVCodecContext *s,
1514 const AVFrame *src, int offset[AV_NUM_DATA_POINTERS],
1515 int y, int type, int height);
1518 * callback to negotiate the pixelFormat
1519 * @param fmt is the list of formats which are supported by the codec,
1520 * it is terminated by -1 as 0 is a valid format, the formats are ordered by quality.
1521 * The first is always the native one.
1522 * @note The callback may be called again immediately if initialization for
1523 * the selected (hardware-accelerated) pixel format failed.
1524 * @warning Behavior is undefined if the callback returns a value not
1525 * in the fmt list of formats.
1526 * @return the chosen format
1527 * - encoding: unused
1528 * - decoding: Set by user, if not set the native format will be chosen.
1530 enum AVPixelFormat (*get_format)(struct AVCodecContext *s, const enum AVPixelFormat * fmt);
1533 * maximum number of B-frames between non-B-frames
1534 * Note: The output will be delayed by max_b_frames+1 relative to the input.
1535 * - encoding: Set by user.
1536 * - decoding: unused
1541 * qscale factor between IP and B-frames
1542 * If > 0 then the last P-frame quantizer will be used (q= lastp_q*factor+offset).
1543 * If < 0 then normal ratecontrol will be done (q= -normal_q*factor+offset).
1544 * - encoding: Set by user.
1545 * - decoding: unused
1547 float b_quant_factor;
1549 #if FF_API_RC_STRATEGY
1550 /** @deprecated use codec private option instead */
1551 attribute_deprecated int rc_strategy;
1552 #define FF_RC_STRATEGY_XVID 1
1555 int b_frame_strategy;
1558 * qscale offset between IP and B-frames
1559 * - encoding: Set by user.
1560 * - decoding: unused
1562 float b_quant_offset;
1565 * Size of the frame reordering buffer in the decoder.
1566 * For MPEG-2 it is 1 IPB or 0 low delay IP.
1567 * - encoding: Set by libavcodec.
1568 * - decoding: Set by libavcodec.
1573 * 0-> h263 quant 1-> mpeg quant
1574 * - encoding: Set by user.
1575 * - decoding: unused
1580 * qscale factor between P and I-frames
1581 * If > 0 then the last p frame quantizer will be used (q= lastp_q*factor+offset).
1582 * If < 0 then normal ratecontrol will be done (q= -normal_q*factor+offset).
1583 * - encoding: Set by user.
1584 * - decoding: unused
1586 float i_quant_factor;
1589 * qscale offset between P and I-frames
1590 * - encoding: Set by user.
1591 * - decoding: unused
1593 float i_quant_offset;
1596 * luminance masking (0-> disabled)
1597 * - encoding: Set by user.
1598 * - decoding: unused
1603 * temporary complexity masking (0-> disabled)
1604 * - encoding: Set by user.
1605 * - decoding: unused
1607 float temporal_cplx_masking;
1610 * spatial complexity masking (0-> disabled)
1611 * - encoding: Set by user.
1612 * - decoding: unused
1614 float spatial_cplx_masking;
1617 * p block masking (0-> disabled)
1618 * - encoding: Set by user.
1619 * - decoding: unused
1624 * darkness masking (0-> disabled)
1625 * - encoding: Set by user.
1626 * - decoding: unused
1632 * - encoding: Set by libavcodec.
1633 * - decoding: Set by user (or 0).
1637 * prediction method (needed for huffyuv)
1638 * - encoding: Set by user.
1639 * - decoding: unused
1641 int prediction_method;
1642 #define FF_PRED_LEFT 0
1643 #define FF_PRED_PLANE 1
1644 #define FF_PRED_MEDIAN 2
1647 * slice offsets in the frame in bytes
1648 * - encoding: Set/allocated by libavcodec.
1649 * - decoding: Set/allocated by user (or NULL).
1654 * sample aspect ratio (0 if unknown)
1655 * That is the width of a pixel divided by the height of the pixel.
1656 * Numerator and denominator must be relatively prime and smaller than 256 for some video standards.
1657 * - encoding: Set by user.
1658 * - decoding: Set by libavcodec.
1660 AVRational sample_aspect_ratio;
1663 * motion estimation comparison function
1664 * - encoding: Set by user.
1665 * - decoding: unused
1669 * subpixel motion estimation comparison function
1670 * - encoding: Set by user.
1671 * - decoding: unused
1675 * macroblock comparison function (not supported yet)
1676 * - encoding: Set by user.
1677 * - decoding: unused
1681 * interlaced DCT comparison function
1682 * - encoding: Set by user.
1683 * - decoding: unused
1686 #define FF_CMP_SAD 0
1687 #define FF_CMP_SSE 1
1688 #define FF_CMP_SATD 2
1689 #define FF_CMP_DCT 3
1690 #define FF_CMP_PSNR 4
1691 #define FF_CMP_BIT 5
1693 #define FF_CMP_ZERO 7
1694 #define FF_CMP_VSAD 8
1695 #define FF_CMP_VSSE 9
1696 #define FF_CMP_NSSE 10
1697 #define FF_CMP_W53 11
1698 #define FF_CMP_W97 12
1699 #define FF_CMP_DCTMAX 13
1700 #define FF_CMP_DCT264 14
1701 #define FF_CMP_CHROMA 256
1704 * ME diamond size & shape
1705 * - encoding: Set by user.
1706 * - decoding: unused
1711 * amount of previous MV predictors (2a+1 x 2a+1 square)
1712 * - encoding: Set by user.
1713 * - decoding: unused
1715 int last_predictor_count;
1718 * prepass for motion estimation
1719 * - encoding: Set by user.
1720 * - decoding: unused
1725 * motion estimation prepass comparison function
1726 * - encoding: Set by user.
1727 * - decoding: unused
1732 * ME prepass diamond size & shape
1733 * - encoding: Set by user.
1734 * - decoding: unused
1740 * - encoding: Set by user.
1741 * - decoding: unused
1743 int me_subpel_quality;
1747 * DTG active format information (additional aspect ratio
1748 * information only used in DVB MPEG-2 transport streams)
1751 * - encoding: unused
1752 * - decoding: Set by decoder.
1753 * @deprecated Deprecated in favor of AVSideData
1755 attribute_deprecated int dtg_active_format;
1756 #define FF_DTG_AFD_SAME 8
1757 #define FF_DTG_AFD_4_3 9
1758 #define FF_DTG_AFD_16_9 10
1759 #define FF_DTG_AFD_14_9 11
1760 #define FF_DTG_AFD_4_3_SP_14_9 13
1761 #define FF_DTG_AFD_16_9_SP_14_9 14
1762 #define FF_DTG_AFD_SP_4_3 15
1763 #endif /* FF_API_AFD */
1766 * maximum motion estimation search range in subpel units
1767 * If 0 then no limit.
1769 * - encoding: Set by user.
1770 * - decoding: unused
1774 #if FF_API_QUANT_BIAS
1776 * @deprecated use encoder private option instead
1778 attribute_deprecated int intra_quant_bias;
1779 #define FF_DEFAULT_QUANT_BIAS 999999
1782 * @deprecated use encoder private option instead
1784 attribute_deprecated int inter_quant_bias;
1789 * - encoding: unused
1790 * - decoding: Set by user.
1793 #define SLICE_FLAG_CODED_ORDER 0x0001 ///< draw_horiz_band() is called in coded order instead of display
1794 #define SLICE_FLAG_ALLOW_FIELD 0x0002 ///< allow draw_horiz_band() with field slices (MPEG2 field pics)
1795 #define SLICE_FLAG_ALLOW_PLANE 0x0004 ///< allow draw_horiz_band() with 1 component at a time (SVQ1)
1799 * XVideo Motion Acceleration
1800 * - encoding: forbidden
1801 * - decoding: set by decoder
1802 * @deprecated XvMC doesn't need it anymore.
1804 attribute_deprecated int xvmc_acceleration;
1805 #endif /* FF_API_XVMC */
1808 * macroblock decision mode
1809 * - encoding: Set by user.
1810 * - decoding: unused
1813 #define FF_MB_DECISION_SIMPLE 0 ///< uses mb_cmp
1814 #define FF_MB_DECISION_BITS 1 ///< chooses the one which needs the fewest bits
1815 #define FF_MB_DECISION_RD 2 ///< rate distortion
1818 * custom intra quantization matrix
1819 * - encoding: Set by user, can be NULL.
1820 * - decoding: Set by libavcodec.
1822 uint16_t *intra_matrix;
1825 * custom inter quantization matrix
1826 * - encoding: Set by user, can be NULL.
1827 * - decoding: Set by libavcodec.
1829 uint16_t *inter_matrix;
1832 * scene change detection threshold
1833 * 0 is default, larger means fewer detected scene changes.
1834 * - encoding: Set by user.
1835 * - decoding: unused
1837 int scenechange_threshold;
1840 * noise reduction strength
1841 * - encoding: Set by user.
1842 * - decoding: unused
1844 int noise_reduction;
1848 * @deprecated this field is unused
1850 attribute_deprecated
1854 * @deprecated this field is unused
1856 attribute_deprecated
1861 * precision of the intra DC coefficient - 8
1862 * - encoding: Set by user.
1863 * - decoding: Set by libavcodec
1865 int intra_dc_precision;
1868 * Number of macroblock rows at the top which are skipped.
1869 * - encoding: unused
1870 * - decoding: Set by user.
1875 * Number of macroblock rows at the bottom which are skipped.
1876 * - encoding: unused
1877 * - decoding: Set by user.
1883 * @deprecated use encoder private options instead
1885 attribute_deprecated
1886 float border_masking;
1890 * minimum MB lagrange multipler
1891 * - encoding: Set by user.
1892 * - decoding: unused
1897 * maximum MB lagrange multipler
1898 * - encoding: Set by user.
1899 * - decoding: unused
1905 * - encoding: Set by user.
1906 * - decoding: unused
1908 int me_penalty_compensation;
1912 * - encoding: Set by user.
1913 * - decoding: unused
1919 * - encoding: Set by user.
1920 * - decoding: unused
1926 * - encoding: Set by user.
1927 * - decoding: unused
1932 * number of reference frames
1933 * - encoding: Set by user.
1934 * - decoding: Set by lavc.
1939 * chroma qp offset from luma
1940 * - encoding: Set by user.
1941 * - decoding: unused
1945 #if FF_API_UNUSED_MEMBERS
1947 * Multiplied by qscale for each frame and added to scene_change_score.
1948 * - encoding: Set by user.
1949 * - decoding: unused
1951 attribute_deprecated int scenechange_factor;
1956 * Note: Value depends upon the compare function used for fullpel ME.
1957 * - encoding: Set by user.
1958 * - decoding: unused
1963 * Adjust sensitivity of b_frame_strategy 1.
1964 * - encoding: Set by user.
1965 * - decoding: unused
1970 * Chromaticity coordinates of the source primaries.
1971 * - encoding: Set by user
1972 * - decoding: Set by libavcodec
1974 enum AVColorPrimaries color_primaries;
1977 * Color Transfer Characteristic.
1978 * - encoding: Set by user
1979 * - decoding: Set by libavcodec
1981 enum AVColorTransferCharacteristic color_trc;
1984 * YUV colorspace type.
1985 * - encoding: Set by user
1986 * - decoding: Set by libavcodec
1988 enum AVColorSpace colorspace;
1991 * MPEG vs JPEG YUV range.
1992 * - encoding: Set by user
1993 * - decoding: Set by libavcodec
1995 enum AVColorRange color_range;
1998 * This defines the location of chroma samples.
1999 * - encoding: Set by user
2000 * - decoding: Set by libavcodec
2002 enum AVChromaLocation chroma_sample_location;
2006 * Indicates number of picture subdivisions. Used for parallelized
2008 * - encoding: Set by user
2009 * - decoding: unused
2014 * - encoding: set by libavcodec
2015 * - decoding: Set by user.
2017 enum AVFieldOrder field_order;
2020 int sample_rate; ///< samples per second
2021 int channels; ///< number of audio channels
2024 * audio sample format
2025 * - encoding: Set by user.
2026 * - decoding: Set by libavcodec.
2028 enum AVSampleFormat sample_fmt; ///< sample format
2030 /* The following data should not be initialized. */
2032 * Number of samples per channel in an audio frame.
2034 * - encoding: set by libavcodec in avcodec_open2(). Each submitted frame
2035 * except the last must contain exactly frame_size samples per channel.
2036 * May be 0 when the codec has CODEC_CAP_VARIABLE_FRAME_SIZE set, then the
2037 * frame size is not restricted.
2038 * - decoding: may be set by some decoders to indicate constant frame size
2043 * Frame counter, set by libavcodec.
2045 * - decoding: total number of frames returned from the decoder so far.
2046 * - encoding: total number of frames passed to the encoder so far.
2048 * @note the counter is not incremented if encoding/decoding resulted in
2054 * number of bytes per packet if constant and known or 0
2055 * Used by some WAV based audio codecs.
2060 * Audio cutoff bandwidth (0 means "automatic")
2061 * - encoding: Set by user.
2062 * - decoding: unused
2066 #if FF_API_REQUEST_CHANNELS
2068 * Decoder should decode to this many channels if it can (0 for default)
2069 * - encoding: unused
2070 * - decoding: Set by user.
2071 * @deprecated Deprecated in favor of request_channel_layout.
2073 attribute_deprecated int request_channels;
2077 * Audio channel layout.
2078 * - encoding: set by user.
2079 * - decoding: set by user, may be overwritten by libavcodec.
2081 uint64_t channel_layout;
2084 * Request decoder to use this channel layout if it can (0 for default)
2085 * - encoding: unused
2086 * - decoding: Set by user.
2088 uint64_t request_channel_layout;
2091 * Type of service that the audio stream conveys.
2092 * - encoding: Set by user.
2093 * - decoding: Set by libavcodec.
2095 enum AVAudioServiceType audio_service_type;
2098 * desired sample format
2099 * - encoding: Not used.
2100 * - decoding: Set by user.
2101 * Decoder will decode to this format if it can.
2103 enum AVSampleFormat request_sample_fmt;
2105 #if FF_API_GET_BUFFER
2107 * Called at the beginning of each frame to get a buffer for it.
2109 * The function will set AVFrame.data[], AVFrame.linesize[].
2110 * AVFrame.extended_data[] must also be set, but it should be the same as
2111 * AVFrame.data[] except for planar audio with more channels than can fit
2112 * in AVFrame.data[]. In that case, AVFrame.data[] shall still contain as
2113 * many data pointers as it can hold.
2115 * if CODEC_CAP_DR1 is not set then get_buffer() must call
2116 * avcodec_default_get_buffer() instead of providing buffers allocated by
2119 * AVFrame.data[] should be 32- or 16-byte-aligned unless the CPU doesn't
2120 * need it. avcodec_default_get_buffer() aligns the output buffer properly,
2121 * but if get_buffer() is overridden then alignment considerations should
2122 * be taken into account.
2124 * @see avcodec_default_get_buffer()
2128 * If pic.reference is set then the frame will be read later by libavcodec.
2129 * avcodec_align_dimensions2() should be used to find the required width and
2130 * height, as they normally need to be rounded up to the next multiple of 16.
2132 * If frame multithreading is used and thread_safe_callbacks is set,
2133 * it may be called from a different thread, but not from more than one at
2134 * once. Does not need to be reentrant.
2136 * @see release_buffer(), reget_buffer()
2137 * @see avcodec_align_dimensions2()
2141 * Decoders request a buffer of a particular size by setting
2142 * AVFrame.nb_samples prior to calling get_buffer(). The decoder may,
2143 * however, utilize only part of the buffer by setting AVFrame.nb_samples
2144 * to a smaller value in the output frame.
2146 * Decoders cannot use the buffer after returning from
2147 * avcodec_decode_audio4(), so they will not call release_buffer(), as it
2148 * is assumed to be released immediately upon return. In some rare cases,
2149 * a decoder may need to call get_buffer() more than once in a single
2150 * call to avcodec_decode_audio4(). In that case, when get_buffer() is
2151 * called again after it has already been called once, the previously
2152 * acquired buffer is assumed to be released at that time and may not be
2153 * reused by the decoder.
2155 * As a convenience, av_samples_get_buffer_size() and
2156 * av_samples_fill_arrays() in libavutil may be used by custom get_buffer()
2157 * functions to find the required data size and to fill data pointers and
2158 * linesize. In AVFrame.linesize, only linesize[0] may be set for audio
2159 * since all planes must be the same size.
2161 * @see av_samples_get_buffer_size(), av_samples_fill_arrays()
2163 * - encoding: unused
2164 * - decoding: Set by libavcodec, user can override.
2166 * @deprecated use get_buffer2()
2168 attribute_deprecated
2169 int (*get_buffer)(struct AVCodecContext *c, AVFrame *pic);
2172 * Called to release buffers which were allocated with get_buffer.
2173 * A released buffer can be reused in get_buffer().
2174 * pic.data[*] must be set to NULL.
2175 * May be called from a different thread if frame multithreading is used,
2176 * but not by more than one thread at once, so does not need to be reentrant.
2177 * - encoding: unused
2178 * - decoding: Set by libavcodec, user can override.
2180 * @deprecated custom freeing callbacks should be set from get_buffer2()
2182 attribute_deprecated
2183 void (*release_buffer)(struct AVCodecContext *c, AVFrame *pic);
2186 * Called at the beginning of a frame to get cr buffer for it.
2187 * Buffer type (size, hints) must be the same. libavcodec won't check it.
2188 * libavcodec will pass previous buffer in pic, function should return
2189 * same buffer or new buffer with old frame "painted" into it.
2190 * If pic.data[0] == NULL must behave like get_buffer().
2191 * if CODEC_CAP_DR1 is not set then reget_buffer() must call
2192 * avcodec_default_reget_buffer() instead of providing buffers allocated by
2194 * - encoding: unused
2195 * - decoding: Set by libavcodec, user can override.
2197 attribute_deprecated
2198 int (*reget_buffer)(struct AVCodecContext *c, AVFrame *pic);
2202 * This callback is called at the beginning of each frame to get data
2203 * buffer(s) for it. There may be one contiguous buffer for all the data or
2204 * there may be a buffer per each data plane or anything in between. What
2205 * this means is, you may set however many entries in buf[] you feel necessary.
2206 * Each buffer must be reference-counted using the AVBuffer API (see description
2209 * The following fields will be set in the frame before this callback is
2212 * - width, height (video only)
2213 * - sample_rate, channel_layout, nb_samples (audio only)
2214 * Their values may differ from the corresponding values in
2215 * AVCodecContext. This callback must use the frame values, not the codec
2216 * context values, to calculate the required buffer size.
2218 * This callback must fill the following fields in the frame:
2222 * * if the data is planar audio with more than 8 channels, then this
2223 * callback must allocate and fill extended_data to contain all pointers
2224 * to all data planes. data[] must hold as many pointers as it can.
2225 * extended_data must be allocated with av_malloc() and will be freed in
2227 * * otherwise exended_data must point to data
2228 * - buf[] must contain one or more pointers to AVBufferRef structures. Each of
2229 * the frame's data and extended_data pointers must be contained in these. That
2230 * is, one AVBufferRef for each allocated chunk of memory, not necessarily one
2231 * AVBufferRef per data[] entry. See: av_buffer_create(), av_buffer_alloc(),
2232 * and av_buffer_ref().
2233 * - extended_buf and nb_extended_buf must be allocated with av_malloc() by
2234 * this callback and filled with the extra buffers if there are more
2235 * buffers than buf[] can hold. extended_buf will be freed in
2238 * If CODEC_CAP_DR1 is not set then get_buffer2() must call
2239 * avcodec_default_get_buffer2() instead of providing buffers allocated by
2242 * Each data plane must be aligned to the maximum required by the target
2245 * @see avcodec_default_get_buffer2()
2249 * If AV_GET_BUFFER_FLAG_REF is set in flags then the frame may be reused
2250 * (read and/or written to if it is writable) later by libavcodec.
2252 * avcodec_align_dimensions2() should be used to find the required width and
2253 * height, as they normally need to be rounded up to the next multiple of 16.
2255 * Some decoders do not support linesizes changing between frames.
2257 * If frame multithreading is used and thread_safe_callbacks is set,
2258 * this callback may be called from a different thread, but not from more
2259 * than one at once. Does not need to be reentrant.
2261 * @see avcodec_align_dimensions2()
2265 * Decoders request a buffer of a particular size by setting
2266 * AVFrame.nb_samples prior to calling get_buffer2(). The decoder may,
2267 * however, utilize only part of the buffer by setting AVFrame.nb_samples
2268 * to a smaller value in the output frame.
2270 * As a convenience, av_samples_get_buffer_size() and
2271 * av_samples_fill_arrays() in libavutil may be used by custom get_buffer2()
2272 * functions to find the required data size and to fill data pointers and
2273 * linesize. In AVFrame.linesize, only linesize[0] may be set for audio
2274 * since all planes must be the same size.
2276 * @see av_samples_get_buffer_size(), av_samples_fill_arrays()
2278 * - encoding: unused
2279 * - decoding: Set by libavcodec, user can override.
2281 int (*get_buffer2)(struct AVCodecContext *s, AVFrame *frame, int flags);
2284 * If non-zero, the decoded audio and video frames returned from
2285 * avcodec_decode_video2() and avcodec_decode_audio4() are reference-counted
2286 * and are valid indefinitely. The caller must free them with
2287 * av_frame_unref() when they are not needed anymore.
2288 * Otherwise, the decoded frames must not be freed by the caller and are
2289 * only valid until the next decode call.
2291 * - encoding: unused
2292 * - decoding: set by the caller before avcodec_open2().
2294 int refcounted_frames;
2296 /* - encoding parameters */
2297 float qcompress; ///< amount of qscale change between easy & hard scenes (0.0-1.0)
2298 float qblur; ///< amount of qscale smoothing over time (0.0-1.0)
2302 * - encoding: Set by user.
2303 * - decoding: unused
2309 * - encoding: Set by user.
2310 * - decoding: unused
2315 * maximum quantizer difference between frames
2316 * - encoding: Set by user.
2317 * - decoding: unused
2323 * @deprecated use encoder private options instead
2325 attribute_deprecated
2328 attribute_deprecated
2330 attribute_deprecated
2335 * decoder bitstream buffer size
2336 * - encoding: Set by user.
2337 * - decoding: unused
2342 * ratecontrol override, see RcOverride
2343 * - encoding: Allocated/set/freed by user.
2344 * - decoding: unused
2346 int rc_override_count;
2347 RcOverride *rc_override;
2351 * @deprecated use encoder private options instead
2353 attribute_deprecated
2359 * - encoding: Set by user.
2360 * - decoding: Set by user, may be overwritten by libavcodec.
2366 * - encoding: Set by user.
2367 * - decoding: unused
2373 * @deprecated use encoder private options instead
2375 attribute_deprecated
2376 float rc_buffer_aggressivity;
2378 attribute_deprecated
2379 float rc_initial_cplx;
2383 * Ratecontrol attempt to use, at maximum, <value> of what can be used without an underflow.
2384 * - encoding: Set by user.
2385 * - decoding: unused.
2387 float rc_max_available_vbv_use;
2390 * Ratecontrol attempt to use, at least, <value> times the amount needed to prevent a vbv overflow.
2391 * - encoding: Set by user.
2392 * - decoding: unused.
2394 float rc_min_vbv_overflow_use;
2397 * Number of bits which should be loaded into the rc buffer before decoding starts.
2398 * - encoding: Set by user.
2399 * - decoding: unused
2401 int rc_initial_buffer_occupancy;
2403 #define FF_CODER_TYPE_VLC 0
2404 #define FF_CODER_TYPE_AC 1
2405 #define FF_CODER_TYPE_RAW 2
2406 #define FF_CODER_TYPE_RLE 3
2407 #if FF_API_UNUSED_MEMBERS
2408 #define FF_CODER_TYPE_DEFLATE 4
2409 #endif /* FF_API_UNUSED_MEMBERS */
2412 * - encoding: Set by user.
2413 * - decoding: unused
2419 * - encoding: Set by user.
2420 * - decoding: unused
2426 * @deprecated use encoder private options instead
2428 attribute_deprecated
2432 * @deprecated use encoder private options instead
2434 attribute_deprecated
2439 * frame skip threshold
2440 * - encoding: Set by user.
2441 * - decoding: unused
2443 int frame_skip_threshold;
2447 * - encoding: Set by user.
2448 * - decoding: unused
2450 int frame_skip_factor;
2453 * frame skip exponent
2454 * - encoding: Set by user.
2455 * - decoding: unused
2460 * frame skip comparison function
2461 * - encoding: Set by user.
2462 * - decoding: unused
2467 * trellis RD quantization
2468 * - encoding: Set by user.
2469 * - decoding: unused
2474 * - encoding: Set by user.
2475 * - decoding: unused
2477 int min_prediction_order;
2480 * - encoding: Set by user.
2481 * - decoding: unused
2483 int max_prediction_order;
2486 * GOP timecode frame start number
2487 * - encoding: Set by user, in non drop frame format
2488 * - decoding: Set by libavcodec (timecode in the 25 bits format, -1 if unset)
2490 int64_t timecode_frame_start;
2492 /* The RTP callback: This function is called */
2493 /* every time the encoder has a packet to send. */
2494 /* It depends on the encoder if the data starts */
2495 /* with a Start Code (it should). H.263 does. */
2496 /* mb_nb contains the number of macroblocks */
2497 /* encoded in the RTP payload. */
2498 void (*rtp_callback)(struct AVCodecContext *avctx, void *data, int size, int mb_nb);
2500 int rtp_payload_size; /* The size of the RTP payload: the coder will */
2501 /* do its best to deliver a chunk with size */
2502 /* below rtp_payload_size, the chunk will start */
2503 /* with a start code on some codecs like H.263. */
2504 /* This doesn't take account of any particular */
2505 /* headers inside the transmitted RTP payload. */
2507 /* statistics, used for 2-pass encoding */
2518 * number of bits used for the previously encoded frame
2519 * - encoding: Set by libavcodec.
2520 * - decoding: unused
2525 * pass1 encoding statistics output buffer
2526 * - encoding: Set by libavcodec.
2527 * - decoding: unused
2532 * pass2 encoding statistics input buffer
2533 * Concatenated stuff from stats_out of pass1 should be placed here.
2534 * - encoding: Allocated/set/freed by user.
2535 * - decoding: unused
2540 * Work around bugs in encoders which sometimes cannot be detected automatically.
2541 * - encoding: Set by user
2542 * - decoding: Set by user
2544 int workaround_bugs;
2545 #define FF_BUG_AUTODETECT 1 ///< autodetection
2546 #if FF_API_OLD_MSMPEG4
2547 #define FF_BUG_OLD_MSMPEG4 2
2549 #define FF_BUG_XVID_ILACE 4
2550 #define FF_BUG_UMP4 8
2551 #define FF_BUG_NO_PADDING 16
2552 #define FF_BUG_AMV 32
2554 #define FF_BUG_AC_VLC 0 ///< Will be removed, libavcodec can now handle these non-compliant files by default.
2556 #define FF_BUG_QPEL_CHROMA 64
2557 #define FF_BUG_STD_QPEL 128
2558 #define FF_BUG_QPEL_CHROMA2 256
2559 #define FF_BUG_DIRECT_BLOCKSIZE 512
2560 #define FF_BUG_EDGE 1024
2561 #define FF_BUG_HPEL_CHROMA 2048
2562 #define FF_BUG_DC_CLIP 4096
2563 #define FF_BUG_MS 8192 ///< Work around various bugs in Microsoft's broken decoders.
2564 #define FF_BUG_TRUNCATED 16384
2567 * strictly follow the standard (MPEG4, ...).
2568 * - encoding: Set by user.
2569 * - decoding: Set by user.
2570 * Setting this to STRICT or higher means the encoder and decoder will
2571 * generally do stupid things, whereas setting it to unofficial or lower
2572 * will mean the encoder might produce output that is not supported by all
2573 * spec-compliant decoders. Decoders don't differentiate between normal,
2574 * unofficial and experimental (that is, they always try to decode things
2575 * when they can) unless they are explicitly asked to behave stupidly
2576 * (=strictly conform to the specs)
2578 int strict_std_compliance;
2579 #define FF_COMPLIANCE_VERY_STRICT 2 ///< Strictly conform to an older more strict version of the spec or reference software.
2580 #define FF_COMPLIANCE_STRICT 1 ///< Strictly conform to all the things in the spec no matter what consequences.
2581 #define FF_COMPLIANCE_NORMAL 0
2582 #define FF_COMPLIANCE_UNOFFICIAL -1 ///< Allow unofficial extensions
2583 #define FF_COMPLIANCE_EXPERIMENTAL -2 ///< Allow nonstandardized experimental things.
2586 * error concealment flags
2587 * - encoding: unused
2588 * - decoding: Set by user.
2590 int error_concealment;
2591 #define FF_EC_GUESS_MVS 1
2592 #define FF_EC_DEBLOCK 2
2593 #define FF_EC_FAVOR_INTER 256
2597 * - encoding: Set by user.
2598 * - decoding: Set by user.
2601 #define FF_DEBUG_PICT_INFO 1
2602 #define FF_DEBUG_RC 2
2603 #define FF_DEBUG_BITSTREAM 4
2604 #define FF_DEBUG_MB_TYPE 8
2605 #define FF_DEBUG_QP 16
2608 * @deprecated this option does nothing
2610 #define FF_DEBUG_MV 32
2612 #define FF_DEBUG_DCT_COEFF 0x00000040
2613 #define FF_DEBUG_SKIP 0x00000080
2614 #define FF_DEBUG_STARTCODE 0x00000100
2615 #if FF_API_UNUSED_MEMBERS
2616 #define FF_DEBUG_PTS 0x00000200
2617 #endif /* FF_API_UNUSED_MEMBERS */
2618 #define FF_DEBUG_ER 0x00000400
2619 #define FF_DEBUG_MMCO 0x00000800
2620 #define FF_DEBUG_BUGS 0x00001000
2622 #define FF_DEBUG_VIS_QP 0x00002000 ///< only access through AVOptions from outside libavcodec
2623 #define FF_DEBUG_VIS_MB_TYPE 0x00004000 ///< only access through AVOptions from outside libavcodec
2625 #define FF_DEBUG_BUFFERS 0x00008000
2626 #define FF_DEBUG_THREADS 0x00010000
2627 #define FF_DEBUG_GREEN_MD 0x00800000
2628 #define FF_DEBUG_NOMC 0x01000000
2633 * Code outside libavcodec should access this field using AVOptions
2634 * - encoding: Set by user.
2635 * - decoding: Set by user.
2638 #define FF_DEBUG_VIS_MV_P_FOR 0x00000001 //visualize forward predicted MVs of P frames
2639 #define FF_DEBUG_VIS_MV_B_FOR 0x00000002 //visualize forward predicted MVs of B frames
2640 #define FF_DEBUG_VIS_MV_B_BACK 0x00000004 //visualize backward predicted MVs of B frames
2644 * Error recognition; may misdetect some more or less valid parts as errors.
2645 * - encoding: unused
2646 * - decoding: Set by user.
2648 int err_recognition;
2651 * Verify checksums embedded in the bitstream (could be of either encoded or
2652 * decoded data, depending on the codec) and print an error message on mismatch.
2653 * If AV_EF_EXPLODE is also set, a mismatching checksum will result in the
2654 * decoder returning an error.
2656 #define AV_EF_CRCCHECK (1<<0)
2657 #define AV_EF_BITSTREAM (1<<1) ///< detect bitstream specification deviations
2658 #define AV_EF_BUFFER (1<<2) ///< detect improper bitstream length
2659 #define AV_EF_EXPLODE (1<<3) ///< abort decoding on minor error detection
2661 #define AV_EF_IGNORE_ERR (1<<15) ///< ignore errors and continue
2662 #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
2663 #define AV_EF_COMPLIANT (1<<17) ///< consider all spec non compliances as errors
2664 #define AV_EF_AGGRESSIVE (1<<18) ///< consider things that a sane encoder should not do as an error
2668 * opaque 64bit number (generally a PTS) that will be reordered and
2669 * output in AVFrame.reordered_opaque
2670 * - encoding: unused
2671 * - decoding: Set by user.
2673 int64_t reordered_opaque;
2676 * Hardware accelerator in use
2677 * - encoding: unused.
2678 * - decoding: Set by libavcodec
2680 struct AVHWAccel *hwaccel;
2683 * Hardware accelerator context.
2684 * For some hardware accelerators, a global context needs to be
2685 * provided by the user. In that case, this holds display-dependent
2686 * data FFmpeg cannot instantiate itself. Please refer to the
2687 * FFmpeg HW accelerator documentation to know how to fill this
2688 * is. e.g. for VA API, this is a struct vaapi_context.
2689 * - encoding: unused
2690 * - decoding: Set by user
2692 void *hwaccel_context;
2696 * - encoding: Set by libavcodec if flags&CODEC_FLAG_PSNR.
2697 * - decoding: unused
2699 uint64_t error[AV_NUM_DATA_POINTERS];
2702 * DCT algorithm, see FF_DCT_* below
2703 * - encoding: Set by user.
2704 * - decoding: unused
2707 #define FF_DCT_AUTO 0
2708 #define FF_DCT_FASTINT 1
2709 #if FF_API_UNUSED_MEMBERS
2710 #define FF_DCT_INT 2
2711 #endif /* FF_API_UNUSED_MEMBERS */
2712 #define FF_DCT_MMX 3
2713 #define FF_DCT_ALTIVEC 5
2714 #define FF_DCT_FAAN 6
2717 * IDCT algorithm, see FF_IDCT_* below.
2718 * - encoding: Set by user.
2719 * - decoding: Set by user.
2722 #define FF_IDCT_AUTO 0
2723 #define FF_IDCT_INT 1
2724 #define FF_IDCT_SIMPLE 2
2725 #define FF_IDCT_SIMPLEMMX 3
2726 #define FF_IDCT_ARM 7
2727 #define FF_IDCT_ALTIVEC 8
2729 #define FF_IDCT_SH4 9
2731 #define FF_IDCT_SIMPLEARM 10
2732 #if FF_API_UNUSED_MEMBERS
2733 #define FF_IDCT_IPP 13
2734 #endif /* FF_API_UNUSED_MEMBERS */
2735 #define FF_IDCT_XVID 14
2736 #if FF_API_IDCT_XVIDMMX
2737 #define FF_IDCT_XVIDMMX 14
2738 #endif /* FF_API_IDCT_XVIDMMX */
2739 #define FF_IDCT_SIMPLEARMV5TE 16
2740 #define FF_IDCT_SIMPLEARMV6 17
2741 #if FF_API_ARCH_SPARC
2742 #define FF_IDCT_SIMPLEVIS 18
2744 #define FF_IDCT_FAAN 20
2745 #define FF_IDCT_SIMPLENEON 22
2746 #if FF_API_ARCH_ALPHA
2747 #define FF_IDCT_SIMPLEALPHA 23
2749 #define FF_IDCT_SIMPLEAUTO 128
2752 * bits per sample/pixel from the demuxer (needed for huffyuv).
2753 * - encoding: Set by libavcodec.
2754 * - decoding: Set by user.
2756 int bits_per_coded_sample;
2759 * Bits per sample/pixel of internal libavcodec pixel/sample format.
2760 * - encoding: set by user.
2761 * - decoding: set by libavcodec.
2763 int bits_per_raw_sample;
2767 * low resolution decoding, 1-> 1/2 size, 2->1/4 size
2768 * - encoding: unused
2769 * - decoding: Set by user.
2770 * Code outside libavcodec should access this field using:
2771 * av_codec_{get,set}_lowres(avctx)
2776 #if FF_API_CODED_FRAME
2778 * the picture in the bitstream
2779 * - encoding: Set by libavcodec.
2780 * - decoding: unused
2782 * @deprecated use the quality factor packet side data instead
2784 attribute_deprecated AVFrame *coded_frame;
2789 * is used to decide how many independent tasks should be passed to execute()
2790 * - encoding: Set by user.
2791 * - decoding: Set by user.
2796 * Which multithreading methods to use.
2797 * Use of FF_THREAD_FRAME will increase decoding delay by one frame per thread,
2798 * so clients which cannot provide future frames should not use it.
2800 * - encoding: Set by user, otherwise the default is used.
2801 * - decoding: Set by user, otherwise the default is used.
2804 #define FF_THREAD_FRAME 1 ///< Decode more than one frame at once
2805 #define FF_THREAD_SLICE 2 ///< Decode more than one part of a single frame at once
2808 * Which multithreading methods are in use by the codec.
2809 * - encoding: Set by libavcodec.
2810 * - decoding: Set by libavcodec.
2812 int active_thread_type;
2815 * Set by the client if its custom get_buffer() callback can be called
2816 * synchronously from another thread, which allows faster multithreaded decoding.
2817 * draw_horiz_band() will be called from other threads regardless of this setting.
2818 * Ignored if the default get_buffer() is used.
2819 * - encoding: Set by user.
2820 * - decoding: Set by user.
2822 int thread_safe_callbacks;
2825 * The codec may call this to execute several independent things.
2826 * It will return only after finishing all tasks.
2827 * The user may replace this with some multithreaded implementation,
2828 * the default implementation will execute the parts serially.
2829 * @param count the number of things to execute
2830 * - encoding: Set by libavcodec, user can override.
2831 * - decoding: Set by libavcodec, user can override.
2833 int (*execute)(struct AVCodecContext *c, int (*func)(struct AVCodecContext *c2, void *arg), void *arg2, int *ret, int count, int size);
2836 * The codec may call this to execute several independent things.
2837 * It will return only after finishing all tasks.
2838 * The user may replace this with some multithreaded implementation,
2839 * the default implementation will execute the parts serially.
2840 * Also see avcodec_thread_init and e.g. the --enable-pthread configure option.
2841 * @param c context passed also to func
2842 * @param count the number of things to execute
2843 * @param arg2 argument passed unchanged to func
2844 * @param ret return values of executed functions, must have space for "count" values. May be NULL.
2845 * @param func function that will be called count times, with jobnr from 0 to count-1.
2846 * threadnr will be in the range 0 to c->thread_count-1 < MAX_THREADS and so that no
2847 * two instances of func executing at the same time will have the same threadnr.
2848 * @return always 0 currently, but code should handle a future improvement where when any call to func
2849 * returns < 0 no further calls to func may be done and < 0 is returned.
2850 * - encoding: Set by libavcodec, user can override.
2851 * - decoding: Set by libavcodec, user can override.
2853 int (*execute2)(struct AVCodecContext *c, int (*func)(struct AVCodecContext *c2, void *arg, int jobnr, int threadnr), void *arg2, int *ret, int count);
2855 #if FF_API_THREAD_OPAQUE
2857 * @deprecated this field should not be used from outside of lavc
2859 attribute_deprecated
2860 void *thread_opaque;
2864 * noise vs. sse weight for the nsse comparison function
2865 * - encoding: Set by user.
2866 * - decoding: unused
2872 * - encoding: Set by user.
2873 * - decoding: Set by libavcodec.
2876 #define FF_PROFILE_UNKNOWN -99
2877 #define FF_PROFILE_RESERVED -100
2879 #define FF_PROFILE_AAC_MAIN 0
2880 #define FF_PROFILE_AAC_LOW 1
2881 #define FF_PROFILE_AAC_SSR 2
2882 #define FF_PROFILE_AAC_LTP 3
2883 #define FF_PROFILE_AAC_HE 4
2884 #define FF_PROFILE_AAC_HE_V2 28
2885 #define FF_PROFILE_AAC_LD 22
2886 #define FF_PROFILE_AAC_ELD 38
2887 #define FF_PROFILE_MPEG2_AAC_LOW 128
2888 #define FF_PROFILE_MPEG2_AAC_HE 131
2890 #define FF_PROFILE_DTS 20
2891 #define FF_PROFILE_DTS_ES 30
2892 #define FF_PROFILE_DTS_96_24 40
2893 #define FF_PROFILE_DTS_HD_HRA 50
2894 #define FF_PROFILE_DTS_HD_MA 60
2895 #define FF_PROFILE_DTS_EXPRESS 70
2897 #define FF_PROFILE_MPEG2_422 0
2898 #define FF_PROFILE_MPEG2_HIGH 1
2899 #define FF_PROFILE_MPEG2_SS 2
2900 #define FF_PROFILE_MPEG2_SNR_SCALABLE 3
2901 #define FF_PROFILE_MPEG2_MAIN 4
2902 #define FF_PROFILE_MPEG2_SIMPLE 5
2904 #define FF_PROFILE_H264_CONSTRAINED (1<<9) // 8+1; constraint_set1_flag
2905 #define FF_PROFILE_H264_INTRA (1<<11) // 8+3; constraint_set3_flag
2907 #define FF_PROFILE_H264_BASELINE 66
2908 #define FF_PROFILE_H264_CONSTRAINED_BASELINE (66|FF_PROFILE_H264_CONSTRAINED)
2909 #define FF_PROFILE_H264_MAIN 77
2910 #define FF_PROFILE_H264_EXTENDED 88
2911 #define FF_PROFILE_H264_HIGH 100
2912 #define FF_PROFILE_H264_HIGH_10 110
2913 #define FF_PROFILE_H264_HIGH_10_INTRA (110|FF_PROFILE_H264_INTRA)
2914 #define FF_PROFILE_H264_HIGH_422 122
2915 #define FF_PROFILE_H264_HIGH_422_INTRA (122|FF_PROFILE_H264_INTRA)
2916 #define FF_PROFILE_H264_HIGH_444 144
2917 #define FF_PROFILE_H264_HIGH_444_PREDICTIVE 244
2918 #define FF_PROFILE_H264_HIGH_444_INTRA (244|FF_PROFILE_H264_INTRA)
2919 #define FF_PROFILE_H264_CAVLC_444 44
2921 #define FF_PROFILE_VC1_SIMPLE 0
2922 #define FF_PROFILE_VC1_MAIN 1
2923 #define FF_PROFILE_VC1_COMPLEX 2
2924 #define FF_PROFILE_VC1_ADVANCED 3
2926 #define FF_PROFILE_MPEG4_SIMPLE 0
2927 #define FF_PROFILE_MPEG4_SIMPLE_SCALABLE 1
2928 #define FF_PROFILE_MPEG4_CORE 2
2929 #define FF_PROFILE_MPEG4_MAIN 3
2930 #define FF_PROFILE_MPEG4_N_BIT 4
2931 #define FF_PROFILE_MPEG4_SCALABLE_TEXTURE 5
2932 #define FF_PROFILE_MPEG4_SIMPLE_FACE_ANIMATION 6
2933 #define FF_PROFILE_MPEG4_BASIC_ANIMATED_TEXTURE 7
2934 #define FF_PROFILE_MPEG4_HYBRID 8
2935 #define FF_PROFILE_MPEG4_ADVANCED_REAL_TIME 9
2936 #define FF_PROFILE_MPEG4_CORE_SCALABLE 10
2937 #define FF_PROFILE_MPEG4_ADVANCED_CODING 11
2938 #define FF_PROFILE_MPEG4_ADVANCED_CORE 12
2939 #define FF_PROFILE_MPEG4_ADVANCED_SCALABLE_TEXTURE 13
2940 #define FF_PROFILE_MPEG4_SIMPLE_STUDIO 14
2941 #define FF_PROFILE_MPEG4_ADVANCED_SIMPLE 15
2943 #define FF_PROFILE_JPEG2000_CSTREAM_RESTRICTION_0 0
2944 #define FF_PROFILE_JPEG2000_CSTREAM_RESTRICTION_1 1
2945 #define FF_PROFILE_JPEG2000_CSTREAM_NO_RESTRICTION 2
2946 #define FF_PROFILE_JPEG2000_DCINEMA_2K 3
2947 #define FF_PROFILE_JPEG2000_DCINEMA_4K 4
2949 #define FF_PROFILE_VP9_0 0
2950 #define FF_PROFILE_VP9_1 1
2951 #define FF_PROFILE_VP9_2 2
2952 #define FF_PROFILE_VP9_3 3
2954 #define FF_PROFILE_HEVC_MAIN 1
2955 #define FF_PROFILE_HEVC_MAIN_10 2
2956 #define FF_PROFILE_HEVC_MAIN_STILL_PICTURE 3
2957 #define FF_PROFILE_HEVC_REXT 4
2961 * - encoding: Set by user.
2962 * - decoding: Set by libavcodec.
2965 #define FF_LEVEL_UNKNOWN -99
2968 * Skip loop filtering for selected frames.
2969 * - encoding: unused
2970 * - decoding: Set by user.
2972 enum AVDiscard skip_loop_filter;
2975 * Skip IDCT/dequantization for selected frames.
2976 * - encoding: unused
2977 * - decoding: Set by user.
2979 enum AVDiscard skip_idct;
2982 * Skip decoding for selected frames.
2983 * - encoding: unused
2984 * - decoding: Set by user.
2986 enum AVDiscard skip_frame;
2989 * Header containing style information for text subtitles.
2990 * For SUBTITLE_ASS subtitle type, it should contain the whole ASS
2991 * [Script Info] and [V4+ Styles] section, plus the [Events] line and
2992 * the Format line following. It shouldn't include any Dialogue line.
2993 * - encoding: Set/allocated/freed by user (before avcodec_open2())
2994 * - decoding: Set/allocated/freed by libavcodec (by avcodec_open2())
2996 uint8_t *subtitle_header;
2997 int subtitle_header_size;
2999 #if FF_API_ERROR_RATE
3001 * @deprecated use the 'error_rate' private AVOption of the mpegvideo
3004 attribute_deprecated
3008 #if FF_API_CODEC_PKT
3010 * @deprecated this field is not supposed to be accessed from outside lavc
3012 attribute_deprecated
3017 * VBV delay coded in the last frame (in periods of a 27 MHz clock).
3018 * Used for compliant TS muxing.
3019 * - encoding: Set by libavcodec.
3020 * - decoding: unused.
3025 * Encoding only. Allow encoders to output packets that do not contain any
3026 * encoded data, only side data.
3028 * Some encoders need to output such packets, e.g. to update some stream
3029 * parameters at the end of encoding.
3031 * All callers are strongly recommended to set this option to 1 and update
3032 * their code to deal with such packets, since this behaviour may become
3033 * always enabled in the future (then this option will be deprecated and
3034 * later removed). To avoid ABI issues when this happens, the callers should
3035 * use AVOptions to set this field.
3037 int side_data_only_packets;
3040 * Audio only. The number of "priming" samples (padding) inserted by the
3041 * encoder at the beginning of the audio. I.e. this number of leading
3042 * decoded samples must be discarded by the caller to get the original audio
3043 * without leading padding.
3045 * - decoding: unused
3046 * - encoding: Set by libavcodec. The timestamps on the output packets are
3047 * adjusted by the encoder so that they always refer to the
3048 * first sample of the data actually contained in the packet,
3049 * including any added padding. E.g. if the timebase is
3050 * 1/samplerate and the timestamp of the first input sample is
3051 * 0, the timestamp of the first output packet will be
3054 int initial_padding;
3057 * - decoding: For codecs that store a framerate value in the compressed
3058 * bitstream, the decoder may export it here. { 0, 1} when
3060 * - encoding: unused
3062 AVRational framerate;
3065 * Nominal unaccelerated pixel format, see AV_PIX_FMT_xxx.
3066 * - encoding: unused.
3067 * - decoding: Set by libavcodec before calling get_format()
3069 enum AVPixelFormat sw_pix_fmt;
3072 * Timebase in which pkt_dts/pts and AVPacket.dts/pts are.
3073 * Code outside libavcodec should access this field using:
3074 * av_codec_{get,set}_pkt_timebase(avctx)
3075 * - encoding unused.
3076 * - decoding set by user.
3078 AVRational pkt_timebase;
3082 * Code outside libavcodec should access this field using:
3083 * av_codec_{get,set}_codec_descriptor(avctx)
3084 * - encoding: unused.
3085 * - decoding: set by libavcodec.
3087 const AVCodecDescriptor *codec_descriptor;
3091 * low resolution decoding, 1-> 1/2 size, 2->1/4 size
3092 * - encoding: unused
3093 * - decoding: Set by user.
3094 * Code outside libavcodec should access this field using:
3095 * av_codec_{get,set}_lowres(avctx)
3101 * Current statistics for PTS correction.
3102 * - decoding: maintained and used by libavcodec, not intended to be used by user apps
3103 * - encoding: unused
3105 int64_t pts_correction_num_faulty_pts; /// Number of incorrect PTS values so far
3106 int64_t pts_correction_num_faulty_dts; /// Number of incorrect DTS values so far
3107 int64_t pts_correction_last_pts; /// PTS of the last frame
3108 int64_t pts_correction_last_dts; /// DTS of the last frame
3111 * Character encoding of the input subtitles file.
3112 * - decoding: set by user
3113 * - encoding: unused
3118 * Subtitles character encoding mode. Formats or codecs might be adjusting
3119 * this setting (if they are doing the conversion themselves for instance).
3120 * - decoding: set by libavcodec
3121 * - encoding: unused
3123 int sub_charenc_mode;
3124 #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)
3125 #define FF_SUB_CHARENC_MODE_AUTOMATIC 0 ///< libavcodec will select the mode itself
3126 #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
3129 * Skip processing alpha if supported by codec.
3130 * Note that if the format uses pre-multiplied alpha (common with VP6,
3131 * and recommended due to better video quality/compression)
3132 * the image will look as if alpha-blended onto a black background.
3133 * However for formats that do not use pre-multiplied alpha
3134 * there might be serious artefacts (though e.g. libswscale currently
3135 * assumes pre-multiplied alpha anyway).
3136 * Code outside libavcodec should access this field using AVOptions
3138 * - decoding: set by user
3139 * - encoding: unused
3144 * Number of samples to skip after a discontinuity
3145 * - decoding: unused
3146 * - encoding: set by libavcodec
3150 #if !FF_API_DEBUG_MV
3152 * debug motion vectors
3153 * Code outside libavcodec should access this field using AVOptions
3154 * - encoding: Set by user.
3155 * - decoding: Set by user.
3158 #define FF_DEBUG_VIS_MV_P_FOR 0x00000001 //visualize forward predicted MVs of P frames
3159 #define FF_DEBUG_VIS_MV_B_FOR 0x00000002 //visualize forward predicted MVs of B frames
3160 #define FF_DEBUG_VIS_MV_B_BACK 0x00000004 //visualize backward predicted MVs of B frames
3164 * custom intra quantization matrix
3165 * Code outside libavcodec should access this field using av_codec_g/set_chroma_intra_matrix()
3166 * - encoding: Set by user, can be NULL.
3167 * - decoding: unused.
3169 uint16_t *chroma_intra_matrix;
3172 * dump format separator.
3173 * can be ", " or "\n " or anything else
3174 * Code outside libavcodec should access this field using AVOptions
3175 * (NO direct access).
3176 * - encoding: Set by user.
3177 * - decoding: Set by user.
3179 uint8_t *dump_separator;
3182 * ',' separated list of allowed decoders.
3183 * If NULL then all are allowed
3184 * - encoding: unused
3185 * - decoding: set by user through AVOPtions (NO direct access)
3187 char *codec_whitelist;
3190 * Properties of the stream that gets decoded
3191 * To be accessed through av_codec_get_properties() (NO direct access)
3192 * - encoding: unused
3193 * - decoding: set by libavcodec
3195 unsigned properties;
3196 #define FF_CODEC_PROPERTY_LOSSLESS 0x00000001
3197 #define FF_CODEC_PROPERTY_CLOSED_CAPTIONS 0x00000002
3200 AVRational av_codec_get_pkt_timebase (const AVCodecContext *avctx);
3201 void av_codec_set_pkt_timebase (AVCodecContext *avctx, AVRational val);
3203 const AVCodecDescriptor *av_codec_get_codec_descriptor(const AVCodecContext *avctx);
3204 void av_codec_set_codec_descriptor(AVCodecContext *avctx, const AVCodecDescriptor *desc);
3206 unsigned av_codec_get_codec_properties(const AVCodecContext *avctx);
3208 int av_codec_get_lowres(const AVCodecContext *avctx);
3209 void av_codec_set_lowres(AVCodecContext *avctx, int val);
3211 int av_codec_get_seek_preroll(const AVCodecContext *avctx);
3212 void av_codec_set_seek_preroll(AVCodecContext *avctx, int val);
3214 uint16_t *av_codec_get_chroma_intra_matrix(const AVCodecContext *avctx);
3215 void av_codec_set_chroma_intra_matrix(AVCodecContext *avctx, uint16_t *val);
3220 typedef struct AVProfile {
3222 const char *name; ///< short name for the profile
3225 typedef struct AVCodecDefault AVCodecDefault;
3232 typedef struct AVCodec {
3234 * Name of the codec implementation.
3235 * The name is globally unique among encoders and among decoders (but an
3236 * encoder and a decoder can share the same name).
3237 * This is the primary way to find a codec from the user perspective.
3241 * Descriptive name for the codec, meant to be more human readable than name.
3242 * You should use the NULL_IF_CONFIG_SMALL() macro to define it.
3244 const char *long_name;
3245 enum AVMediaType type;
3248 * Codec capabilities.
3252 const AVRational *supported_framerates; ///< array of supported framerates, or NULL if any, array is terminated by {0,0}
3253 const enum AVPixelFormat *pix_fmts; ///< array of supported pixel formats, or NULL if unknown, array is terminated by -1
3254 const int *supported_samplerates; ///< array of supported audio samplerates, or NULL if unknown, array is terminated by 0
3255 const enum AVSampleFormat *sample_fmts; ///< array of supported sample formats, or NULL if unknown, array is terminated by -1
3256 const uint64_t *channel_layouts; ///< array of support channel layouts, or NULL if unknown. array is terminated by 0
3258 uint8_t max_lowres; ///< maximum value for lowres supported by the decoder, no direct access, use av_codec_get_max_lowres()
3260 const AVClass *priv_class; ///< AVClass for the private context
3261 const AVProfile *profiles; ///< array of recognized profiles, or NULL if unknown, array is terminated by {FF_PROFILE_UNKNOWN}
3263 /*****************************************************************
3264 * No fields below this line are part of the public API. They
3265 * may not be used outside of libavcodec and can be changed and
3267 * New public fields should be added right above.
3268 *****************************************************************
3271 struct AVCodec *next;
3273 * @name Frame-level threading support functions
3277 * If defined, called on thread contexts when they are created.
3278 * If the codec allocates writable tables in init(), re-allocate them here.
3279 * priv_data will be set to a copy of the original.
3281 int (*init_thread_copy)(AVCodecContext *);
3283 * Copy necessary context variables from a previous thread context to the current one.
3284 * If not defined, the next thread will start automatically; otherwise, the codec
3285 * must call ff_thread_finish_setup().
3287 * dst and src will (rarely) point to the same context, in which case memcpy should be skipped.
3289 int (*update_thread_context)(AVCodecContext *dst, const AVCodecContext *src);
3293 * Private codec-specific defaults.
3295 const AVCodecDefault *defaults;
3298 * Initialize codec static data, called from avcodec_register().
3300 void (*init_static_data)(struct AVCodec *codec);
3302 int (*init)(AVCodecContext *);
3303 int (*encode_sub)(AVCodecContext *, uint8_t *buf, int buf_size,
3304 const struct AVSubtitle *sub);
3306 * Encode data to an AVPacket.
3308 * @param avctx codec context
3309 * @param avpkt output AVPacket (may contain a user-provided buffer)
3310 * @param[in] frame AVFrame containing the raw data to be encoded
3311 * @param[out] got_packet_ptr encoder sets to 0 or 1 to indicate that a
3312 * non-empty packet was returned in avpkt.
3313 * @return 0 on success, negative error code on failure
3315 int (*encode2)(AVCodecContext *avctx, AVPacket *avpkt, const AVFrame *frame,
3316 int *got_packet_ptr);
3317 int (*decode)(AVCodecContext *, void *outdata, int *outdata_size, AVPacket *avpkt);
3318 int (*close)(AVCodecContext *);
3321 * Will be called when seeking
3323 void (*flush)(AVCodecContext *);
3325 * Internal codec capabilities.
3326 * See FF_CODEC_CAP_* in internal.h
3331 int av_codec_get_max_lowres(const AVCodec *codec);
3333 struct MpegEncContext;
3336 * @defgroup lavc_hwaccel AVHWAccel
3339 typedef struct AVHWAccel {
3341 * Name of the hardware accelerated codec.
3342 * The name is globally unique among encoders and among decoders (but an
3343 * encoder and a decoder can share the same name).
3348 * Type of codec implemented by the hardware accelerator.
3350 * See AVMEDIA_TYPE_xxx
3352 enum AVMediaType type;
3355 * Codec implemented by the hardware accelerator.
3357 * See AV_CODEC_ID_xxx
3362 * Supported pixel format.
3364 * Only hardware accelerated formats are supported here.
3366 enum AVPixelFormat pix_fmt;
3369 * Hardware accelerated codec capabilities.
3370 * see HWACCEL_CODEC_CAP_*
3374 /*****************************************************************
3375 * No fields below this line are part of the public API. They
3376 * may not be used outside of libavcodec and can be changed and
3378 * New public fields should be added right above.
3379 *****************************************************************
3381 struct AVHWAccel *next;
3384 * Allocate a custom buffer
3386 int (*alloc_frame)(AVCodecContext *avctx, AVFrame *frame);
3389 * Called at the beginning of each frame or field picture.
3391 * Meaningful frame information (codec specific) is guaranteed to
3392 * be parsed at this point. This function is mandatory.
3394 * Note that buf can be NULL along with buf_size set to 0.
3395 * Otherwise, this means the whole frame is available at this point.
3397 * @param avctx the codec context
3398 * @param buf the frame data buffer base
3399 * @param buf_size the size of the frame in bytes
3400 * @return zero if successful, a negative value otherwise
3402 int (*start_frame)(AVCodecContext *avctx, const uint8_t *buf, uint32_t buf_size);
3405 * Callback for each slice.
3407 * Meaningful slice information (codec specific) is guaranteed to
3408 * be parsed at this point. This function is mandatory.
3409 * The only exception is XvMC, that works on MB level.
3411 * @param avctx the codec context
3412 * @param buf the slice data buffer base
3413 * @param buf_size the size of the slice in bytes
3414 * @return zero if successful, a negative value otherwise
3416 int (*decode_slice)(AVCodecContext *avctx, const uint8_t *buf, uint32_t buf_size);
3419 * Called at the end of each frame or field picture.
3421 * The whole picture is parsed at this point and can now be sent
3422 * to the hardware accelerator. This function is mandatory.
3424 * @param avctx the codec context
3425 * @return zero if successful, a negative value otherwise
3427 int (*end_frame)(AVCodecContext *avctx);
3430 * Size of per-frame hardware accelerator private data.
3432 * Private data is allocated with av_mallocz() before
3433 * AVCodecContext.get_buffer() and deallocated after
3434 * AVCodecContext.release_buffer().
3436 int frame_priv_data_size;
3439 * Called for every Macroblock in a slice.
3441 * XvMC uses it to replace the ff_mpv_decode_mb().
3442 * Instead of decoding to raw picture, MB parameters are
3443 * stored in an array provided by the video driver.
3445 * @param s the mpeg context
3447 void (*decode_mb)(struct MpegEncContext *s);
3450 * Initialize the hwaccel private data.
3452 * This will be called from ff_get_format(), after hwaccel and
3453 * hwaccel_context are set and the hwaccel private data in AVCodecInternal
3456 int (*init)(AVCodecContext *avctx);
3459 * Uninitialize the hwaccel private data.
3461 * This will be called from get_format() or avcodec_close(), after hwaccel
3462 * and hwaccel_context are already uninitialized.
3464 int (*uninit)(AVCodecContext *avctx);
3467 * Size of the private data to allocate in
3468 * AVCodecInternal.hwaccel_priv_data.
3474 * Hardware acceleration should be used for decoding even if the codec level
3475 * used is unknown or higher than the maximum supported level reported by the
3478 #define AV_HWACCEL_FLAG_IGNORE_LEVEL (1 << 0)
3481 * Hardware acceleration can output YUV pixel formats with a different chroma
3482 * sampling than 4:2:0 and/or other than 8 bits per component.
3484 #define AV_HWACCEL_FLAG_ALLOW_HIGH_DEPTH (1 << 1)
3491 * @defgroup lavc_picture AVPicture
3493 * Functions for working with AVPicture
3498 * Picture data structure.
3500 * Up to four components can be stored into it, the last component is
3503 typedef struct AVPicture {
3504 uint8_t *data[AV_NUM_DATA_POINTERS]; ///< pointers to the image data planes
3505 int linesize[AV_NUM_DATA_POINTERS]; ///< number of bytes per line
3512 enum AVSubtitleType {
3515 SUBTITLE_BITMAP, ///< A bitmap, pict will be set
3518 * Plain text, the text field must be set by the decoder and is
3519 * authoritative. ass and pict fields may contain approximations.
3524 * Formatted text, the ass field must be set by the decoder and is
3525 * authoritative. pict and text fields may contain approximations.
3530 #define AV_SUBTITLE_FLAG_FORCED 0x00000001
3532 typedef struct AVSubtitleRect {
3533 int x; ///< top left corner of pict, undefined when pict is not set
3534 int y; ///< top left corner of pict, undefined when pict is not set
3535 int w; ///< width of pict, undefined when pict is not set
3536 int h; ///< height of pict, undefined when pict is not set
3537 int nb_colors; ///< number of colors in pict, undefined when pict is not set
3540 * data+linesize for the bitmap of this subtitle.
3541 * can be set for text/ass as well once they are rendered
3544 enum AVSubtitleType type;
3546 char *text; ///< 0 terminated plain UTF-8 text
3549 * 0 terminated ASS/SSA compatible event line.
3550 * The presentation of this is unaffected by the other values in this
3558 typedef struct AVSubtitle {
3559 uint16_t format; /* 0 = graphics */
3560 uint32_t start_display_time; /* relative to packet pts, in ms */
3561 uint32_t end_display_time; /* relative to packet pts, in ms */
3563 AVSubtitleRect **rects;
3564 int64_t pts; ///< Same as packet pts, in AV_TIME_BASE
3568 * If c is NULL, returns the first registered codec,
3569 * if c is non-NULL, returns the next registered codec after c,
3570 * or NULL if c is the last one.
3572 AVCodec *av_codec_next(const AVCodec *c);
3575 * Return the LIBAVCODEC_VERSION_INT constant.
3577 unsigned avcodec_version(void);
3580 * Return the libavcodec build-time configuration.
3582 const char *avcodec_configuration(void);
3585 * Return the libavcodec license.
3587 const char *avcodec_license(void);
3590 * Register the codec codec and initialize libavcodec.
3592 * @warning either this function or avcodec_register_all() must be called
3593 * before any other libavcodec functions.
3595 * @see avcodec_register_all()
3597 void avcodec_register(AVCodec *codec);
3600 * Register all the codecs, parsers and bitstream filters which were enabled at
3601 * configuration time. If you do not call this function you can select exactly
3602 * which formats you want to support, by using the individual registration
3605 * @see avcodec_register
3606 * @see av_register_codec_parser
3607 * @see av_register_bitstream_filter
3609 void avcodec_register_all(void);
3612 * Allocate an AVCodecContext and set its fields to default values. The
3613 * resulting struct should be freed with avcodec_free_context().
3615 * @param codec if non-NULL, allocate private data and initialize defaults
3616 * for the given codec. It is illegal to then call avcodec_open2()
3617 * with a different codec.
3618 * If NULL, then the codec-specific defaults won't be initialized,
3619 * which may result in suboptimal default settings (this is
3620 * important mainly for encoders, e.g. libx264).
3622 * @return An AVCodecContext filled with default values or NULL on failure.
3623 * @see avcodec_get_context_defaults
3625 AVCodecContext *avcodec_alloc_context3(const AVCodec *codec);
3628 * Free the codec context and everything associated with it and write NULL to
3629 * the provided pointer.
3631 void avcodec_free_context(AVCodecContext **avctx);
3634 * Set the fields of the given AVCodecContext to default values corresponding
3635 * to the given codec (defaults may be codec-dependent).
3637 * Do not call this function if a non-NULL codec has been passed
3638 * to avcodec_alloc_context3() that allocated this AVCodecContext.
3639 * If codec is non-NULL, it is illegal to call avcodec_open2() with a
3640 * different codec on this AVCodecContext.
3642 int avcodec_get_context_defaults3(AVCodecContext *s, const AVCodec *codec);
3645 * Get the AVClass for AVCodecContext. It can be used in combination with
3646 * AV_OPT_SEARCH_FAKE_OBJ for examining options.
3648 * @see av_opt_find().
3650 const AVClass *avcodec_get_class(void);
3653 * Get the AVClass for AVFrame. It can be used in combination with
3654 * AV_OPT_SEARCH_FAKE_OBJ for examining options.
3656 * @see av_opt_find().
3658 const AVClass *avcodec_get_frame_class(void);
3661 * Get the AVClass for AVSubtitleRect. It can be used in combination with
3662 * AV_OPT_SEARCH_FAKE_OBJ for examining options.
3664 * @see av_opt_find().
3666 const AVClass *avcodec_get_subtitle_rect_class(void);
3669 * Copy the settings of the source AVCodecContext into the destination
3670 * AVCodecContext. The resulting destination codec context will be
3671 * unopened, i.e. you are required to call avcodec_open2() before you
3672 * can use this AVCodecContext to decode/encode video/audio data.
3674 * @param dest target codec context, should be initialized with
3675 * avcodec_alloc_context3(NULL), but otherwise uninitialized
3676 * @param src source codec context
3677 * @return AVERROR() on error (e.g. memory allocation error), 0 on success
3679 int avcodec_copy_context(AVCodecContext *dest, const AVCodecContext *src);
3681 #if FF_API_AVFRAME_LAVC
3683 * @deprecated use av_frame_alloc()
3685 attribute_deprecated
3686 AVFrame *avcodec_alloc_frame(void);
3689 * Set the fields of the given AVFrame to default values.
3691 * @param frame The AVFrame of which the fields should be set to default values.
3693 * @deprecated use av_frame_unref()
3695 attribute_deprecated
3696 void avcodec_get_frame_defaults(AVFrame *frame);
3699 * Free the frame and any dynamically allocated objects in it,
3700 * e.g. extended_data.
3702 * @param frame frame to be freed. The pointer will be set to NULL.
3704 * @warning this function does NOT free the data buffers themselves
3705 * (it does not know how, since they might have been allocated with
3706 * a custom get_buffer()).
3708 * @deprecated use av_frame_free()
3710 attribute_deprecated
3711 void avcodec_free_frame(AVFrame **frame);
3715 * Initialize the AVCodecContext to use the given AVCodec. Prior to using this
3716 * function the context has to be allocated with avcodec_alloc_context3().
3718 * The functions avcodec_find_decoder_by_name(), avcodec_find_encoder_by_name(),
3719 * avcodec_find_decoder() and avcodec_find_encoder() provide an easy way for
3720 * retrieving a codec.
3722 * @warning This function is not thread safe!
3724 * @note Always call this function before using decoding routines (such as
3725 * @ref avcodec_decode_video2()).
3728 * avcodec_register_all();
3729 * av_dict_set(&opts, "b", "2.5M", 0);
3730 * codec = avcodec_find_decoder(AV_CODEC_ID_H264);
3734 * context = avcodec_alloc_context3(codec);
3736 * if (avcodec_open2(context, codec, opts) < 0)
3740 * @param avctx The context to initialize.
3741 * @param codec The codec to open this context for. If a non-NULL codec has been
3742 * previously passed to avcodec_alloc_context3() or
3743 * avcodec_get_context_defaults3() for this context, then this
3744 * parameter MUST be either NULL or equal to the previously passed
3746 * @param options A dictionary filled with AVCodecContext and codec-private options.
3747 * On return this object will be filled with options that were not found.
3749 * @return zero on success, a negative value on error
3750 * @see avcodec_alloc_context3(), avcodec_find_decoder(), avcodec_find_encoder(),
3751 * av_dict_set(), av_opt_find().
3753 int avcodec_open2(AVCodecContext *avctx, const AVCodec *codec, AVDictionary **options);
3756 * Close a given AVCodecContext and free all the data associated with it
3757 * (but not the AVCodecContext itself).
3759 * Calling this function on an AVCodecContext that hasn't been opened will free
3760 * the codec-specific data allocated in avcodec_alloc_context3() /
3761 * avcodec_get_context_defaults3() with a non-NULL codec. Subsequent calls will
3764 int avcodec_close(AVCodecContext *avctx);
3767 * Free all allocated data in the given subtitle struct.
3769 * @param sub AVSubtitle to free.
3771 void avsubtitle_free(AVSubtitle *sub);
3778 * @addtogroup lavc_packet
3782 #if FF_API_DESTRUCT_PACKET
3784 * Default packet destructor.
3785 * @deprecated use the AVBuffer API instead
3787 attribute_deprecated
3788 void av_destruct_packet(AVPacket *pkt);
3792 * Initialize optional fields of a packet with default values.
3794 * Note, this does not touch the data and size members, which have to be
3795 * initialized separately.
3799 void av_init_packet(AVPacket *pkt);
3802 * Allocate the payload of a packet and initialize its fields with
3806 * @param size wanted payload size
3807 * @return 0 if OK, AVERROR_xxx otherwise
3809 int av_new_packet(AVPacket *pkt, int size);
3812 * Reduce packet size, correctly zeroing padding
3815 * @param size new size
3817 void av_shrink_packet(AVPacket *pkt, int size);
3820 * Increase packet size, correctly zeroing padding
3823 * @param grow_by number of bytes by which to increase the size of the packet
3825 int av_grow_packet(AVPacket *pkt, int grow_by);
3828 * Initialize a reference-counted packet from av_malloc()ed data.
3830 * @param pkt packet to be initialized. This function will set the data, size,
3831 * buf and destruct fields, all others are left untouched.
3832 * @param data Data allocated by av_malloc() to be used as packet data. If this
3833 * function returns successfully, the data is owned by the underlying AVBuffer.
3834 * The caller may not access the data through other means.
3835 * @param size size of data in bytes, without the padding. I.e. the full buffer
3836 * size is assumed to be size + FF_INPUT_BUFFER_PADDING_SIZE.
3838 * @return 0 on success, a negative AVERROR on error
3840 int av_packet_from_data(AVPacket *pkt, uint8_t *data, int size);
3843 * @warning This is a hack - the packet memory allocation stuff is broken. The
3844 * packet is allocated if it was not really allocated.
3846 int av_dup_packet(AVPacket *pkt);
3849 * Copy packet, including contents
3851 * @return 0 on success, negative AVERROR on fail
3853 int av_copy_packet(AVPacket *dst, const AVPacket *src);
3856 * Copy packet side data
3858 * @return 0 on success, negative AVERROR on fail
3860 int av_copy_packet_side_data(AVPacket *dst, const AVPacket *src);
3865 * @param pkt packet to free
3867 void av_free_packet(AVPacket *pkt);
3870 * Allocate new information of a packet.
3873 * @param type side information type
3874 * @param size side information size
3875 * @return pointer to fresh allocated data or NULL otherwise
3877 uint8_t* av_packet_new_side_data(AVPacket *pkt, enum AVPacketSideDataType type,
3881 * Shrink the already allocated side data buffer
3884 * @param type side information type
3885 * @param size new side information size
3886 * @return 0 on success, < 0 on failure
3888 int av_packet_shrink_side_data(AVPacket *pkt, enum AVPacketSideDataType type,
3892 * Get side information from packet.
3895 * @param type desired side information type
3896 * @param size pointer for side information size to store (optional)
3897 * @return pointer to data if present or NULL otherwise
3899 uint8_t* av_packet_get_side_data(AVPacket *pkt, enum AVPacketSideDataType type,
3902 int av_packet_merge_side_data(AVPacket *pkt);
3904 int av_packet_split_side_data(AVPacket *pkt);
3906 const char *av_packet_side_data_name(enum AVPacketSideDataType type);
3909 * Pack a dictionary for use in side_data.
3911 * @param dict The dictionary to pack.
3912 * @param size pointer to store the size of the returned data
3913 * @return pointer to data if successful, NULL otherwise
3915 uint8_t *av_packet_pack_dictionary(AVDictionary *dict, int *size);
3917 * Unpack a dictionary from side_data.
3919 * @param data data from side_data
3920 * @param size size of the data
3921 * @param dict the metadata storage dictionary
3922 * @return 0 on success, < 0 on failure
3924 int av_packet_unpack_dictionary(const uint8_t *data, int size, AVDictionary **dict);
3928 * Convenience function to free all the side data stored.
3929 * All the other fields stay untouched.
3933 void av_packet_free_side_data(AVPacket *pkt);
3936 * Setup a new reference to the data described by a given packet
3938 * If src is reference-counted, setup dst as a new reference to the
3939 * buffer in src. Otherwise allocate a new buffer in dst and copy the
3940 * data from src into it.
3942 * All the other fields are copied from src.
3944 * @see av_packet_unref
3946 * @param dst Destination packet
3947 * @param src Source packet
3949 * @return 0 on success, a negative AVERROR on error.
3951 int av_packet_ref(AVPacket *dst, const AVPacket *src);
3956 * Unreference the buffer referenced by the packet and reset the
3957 * remaining packet fields to their default values.
3959 * @param pkt The packet to be unreferenced.
3961 void av_packet_unref(AVPacket *pkt);
3964 * Move every field in src to dst and reset src.
3966 * @see av_packet_unref
3968 * @param src Source packet, will be reset
3969 * @param dst Destination packet
3971 void av_packet_move_ref(AVPacket *dst, AVPacket *src);
3974 * Copy only "properties" fields from src to dst.
3976 * Properties for the purpose of this function are all the fields
3977 * beside those related to the packet data (buf, data, size)
3979 * @param dst Destination packet
3980 * @param src Source packet
3982 * @return 0 on success AVERROR on failure.
3985 int av_packet_copy_props(AVPacket *dst, const AVPacket *src);
3988 * Convert valid timing fields (timestamps / durations) in a packet from one
3989 * timebase to another. Timestamps with unknown values (AV_NOPTS_VALUE) will be
3992 * @param pkt packet on which the conversion will be performed
3993 * @param tb_src source timebase, in which the timing fields in pkt are
3995 * @param tb_dst destination timebase, to which the timing fields will be
3998 void av_packet_rescale_ts(AVPacket *pkt, AVRational tb_src, AVRational tb_dst);
4005 * @addtogroup lavc_decoding
4010 * Find a registered decoder with a matching codec ID.
4012 * @param id AVCodecID of the requested decoder
4013 * @return A decoder if one was found, NULL otherwise.
4015 AVCodec *avcodec_find_decoder(enum AVCodecID id);
4018 * Find a registered decoder with the specified name.
4020 * @param name name of the requested decoder
4021 * @return A decoder if one was found, NULL otherwise.
4023 AVCodec *avcodec_find_decoder_by_name(const char *name);
4025 #if FF_API_GET_BUFFER
4026 attribute_deprecated int avcodec_default_get_buffer(AVCodecContext *s, AVFrame *pic);
4027 attribute_deprecated void avcodec_default_release_buffer(AVCodecContext *s, AVFrame *pic);
4028 attribute_deprecated int avcodec_default_reget_buffer(AVCodecContext *s, AVFrame *pic);
4032 * The default callback for AVCodecContext.get_buffer2(). It is made public so
4033 * it can be called by custom get_buffer2() implementations for decoders without
4034 * CODEC_CAP_DR1 set.
4036 int avcodec_default_get_buffer2(AVCodecContext *s, AVFrame *frame, int flags);
4040 * Return the amount of padding in pixels which the get_buffer callback must
4041 * provide around the edge of the image for codecs which do not have the
4042 * CODEC_FLAG_EMU_EDGE flag.
4044 * @return Required padding in pixels.
4046 * @deprecated CODEC_FLAG_EMU_EDGE is deprecated, so this function is no longer
4049 attribute_deprecated
4050 unsigned avcodec_get_edge_width(void);
4054 * Modify width and height values so that they will result in a memory
4055 * buffer that is acceptable for the codec if you do not use any horizontal
4058 * May only be used if a codec with CODEC_CAP_DR1 has been opened.
4060 void avcodec_align_dimensions(AVCodecContext *s, int *width, int *height);
4063 * Modify width and height values so that they will result in a memory
4064 * buffer that is acceptable for the codec if you also ensure that all
4065 * line sizes are a multiple of the respective linesize_align[i].
4067 * May only be used if a codec with CODEC_CAP_DR1 has been opened.
4069 void avcodec_align_dimensions2(AVCodecContext *s, int *width, int *height,
4070 int linesize_align[AV_NUM_DATA_POINTERS]);
4073 * Converts AVChromaLocation to swscale x/y chroma position.
4075 * The positions represent the chroma (0,0) position in a coordinates system
4076 * with luma (0,0) representing the origin and luma(1,1) representing 256,256
4078 * @param xpos horizontal chroma sample position
4079 * @param ypos vertical chroma sample position
4081 int avcodec_enum_to_chroma_pos(int *xpos, int *ypos, enum AVChromaLocation pos);
4084 * Converts swscale x/y chroma position to AVChromaLocation.
4086 * The positions represent the chroma (0,0) position in a coordinates system
4087 * with luma (0,0) representing the origin and luma(1,1) representing 256,256
4089 * @param xpos horizontal chroma sample position
4090 * @param ypos vertical chroma sample position
4092 enum AVChromaLocation avcodec_chroma_pos_to_enum(int xpos, int ypos);
4094 #if FF_API_OLD_DECODE_AUDIO
4096 * Wrapper function which calls avcodec_decode_audio4.
4098 * @deprecated Use avcodec_decode_audio4 instead.
4100 * Decode the audio frame of size avpkt->size from avpkt->data into samples.
4101 * Some decoders may support multiple frames in a single AVPacket, such
4102 * decoders would then just decode the first frame. In this case,
4103 * avcodec_decode_audio3 has to be called again with an AVPacket that contains
4104 * the remaining data in order to decode the second frame etc.
4106 * could be outputted, frame_size_ptr is zero. Otherwise, it is the
4107 * decompressed frame size in bytes.
4109 * @warning You must set frame_size_ptr to the allocated size of the
4110 * output buffer before calling avcodec_decode_audio3().
4112 * @warning The input buffer must be FF_INPUT_BUFFER_PADDING_SIZE larger than
4113 * the actual read bytes because some optimized bitstream readers read 32 or 64
4114 * bits at once and could read over the end.
4116 * @warning The end of the input buffer avpkt->data should be set to 0 to ensure that
4117 * no overreading happens for damaged MPEG streams.
4119 * @warning You must not provide a custom get_buffer() when using
4120 * avcodec_decode_audio3(). Doing so will override it with
4121 * avcodec_default_get_buffer. Use avcodec_decode_audio4() instead,
4122 * which does allow the application to provide a custom get_buffer().
4124 * @note You might have to align the input buffer avpkt->data and output buffer
4125 * samples. The alignment requirements depend on the CPU: On some CPUs it isn't
4126 * necessary at all, on others it won't work at all if not aligned and on others
4127 * it will work but it will have an impact on performance.
4129 * In practice, avpkt->data should have 4 byte alignment at minimum and
4130 * samples should be 16 byte aligned unless the CPU doesn't need it
4131 * (AltiVec and SSE do).
4133 * @note Codecs which have the CODEC_CAP_DELAY capability set have a delay
4134 * between input and output, these need to be fed with avpkt->data=NULL,
4135 * avpkt->size=0 at the end to return the remaining frames.
4137 * @param avctx the codec context
4138 * @param[out] samples the output buffer, sample type in avctx->sample_fmt
4139 * If the sample format is planar, each channel plane will
4140 * be the same size, with no padding between channels.
4141 * @param[in,out] frame_size_ptr the output buffer size in bytes
4142 * @param[in] avpkt The input AVPacket containing the input buffer.
4143 * You can create such packet with av_init_packet() and by then setting
4144 * data and size, some decoders might in addition need other fields.
4145 * All decoders are designed to use the least fields possible though.
4146 * @return On error a negative value is returned, otherwise the number of bytes
4147 * used or zero if no frame data was decompressed (used) from the input AVPacket.
4149 attribute_deprecated int avcodec_decode_audio3(AVCodecContext *avctx, int16_t *samples,
4150 int *frame_size_ptr,
4155 * Decode the audio frame of size avpkt->size from avpkt->data into frame.
4157 * Some decoders may support multiple frames in a single AVPacket. Such
4158 * decoders would then just decode the first frame and the return value would be
4159 * less than the packet size. In this case, avcodec_decode_audio4 has to be
4160 * called again with an AVPacket containing the remaining data in order to
4161 * decode the second frame, etc... Even if no frames are returned, the packet
4162 * needs to be fed to the decoder with remaining data until it is completely
4163 * consumed or an error occurs.
4165 * Some decoders (those marked with CODEC_CAP_DELAY) have a delay between input
4166 * and output. This means that for some packets they will not immediately
4167 * produce decoded output and need to be flushed at the end of decoding to get
4168 * all the decoded data. Flushing is done by calling this function with packets
4169 * with avpkt->data set to NULL and avpkt->size set to 0 until it stops
4170 * returning samples. It is safe to flush even those decoders that are not
4171 * marked with CODEC_CAP_DELAY, then no samples will be returned.
4173 * @warning The input buffer, avpkt->data must be FF_INPUT_BUFFER_PADDING_SIZE
4174 * larger than the actual read bytes because some optimized bitstream
4175 * readers read 32 or 64 bits at once and could read over the end.
4177 * @note The AVCodecContext MUST have been opened with @ref avcodec_open2()
4178 * before packets may be fed to the decoder.
4180 * @param avctx the codec context
4181 * @param[out] frame The AVFrame in which to store decoded audio samples.
4182 * The decoder will allocate a buffer for the decoded frame by
4183 * calling the AVCodecContext.get_buffer2() callback.
4184 * When AVCodecContext.refcounted_frames is set to 1, the frame is
4185 * reference counted and the returned reference belongs to the
4186 * caller. The caller must release the frame using av_frame_unref()
4187 * when the frame is no longer needed. The caller may safely write
4188 * to the frame if av_frame_is_writable() returns 1.
4189 * When AVCodecContext.refcounted_frames is set to 0, the returned
4190 * reference belongs to the decoder and is valid only until the
4191 * next call to this function or until closing or flushing the
4192 * decoder. The caller may not write to it.
4193 * @param[out] got_frame_ptr Zero if no frame could be decoded, otherwise it is
4194 * non-zero. Note that this field being set to zero
4195 * does not mean that an error has occurred. For
4196 * decoders with CODEC_CAP_DELAY set, no given decode
4197 * call is guaranteed to produce a frame.
4198 * @param[in] avpkt The input AVPacket containing the input buffer.
4199 * At least avpkt->data and avpkt->size should be set. Some
4200 * decoders might also require additional fields to be set.
4201 * @return A negative error code is returned if an error occurred during
4202 * decoding, otherwise the number of bytes consumed from the input
4203 * AVPacket is returned.
4205 int avcodec_decode_audio4(AVCodecContext *avctx, AVFrame *frame,
4206 int *got_frame_ptr, const AVPacket *avpkt);
4209 * Decode the video frame of size avpkt->size from avpkt->data into picture.
4210 * Some decoders may support multiple frames in a single AVPacket, such
4211 * decoders would then just decode the first frame.
4213 * @warning The input buffer must be FF_INPUT_BUFFER_PADDING_SIZE larger than
4214 * the actual read bytes because some optimized bitstream readers read 32 or 64
4215 * bits at once and could read over the end.
4217 * @warning The end of the input buffer buf should be set to 0 to ensure that
4218 * no overreading happens for damaged MPEG streams.
4220 * @note Codecs which have the CODEC_CAP_DELAY capability set have a delay
4221 * between input and output, these need to be fed with avpkt->data=NULL,
4222 * avpkt->size=0 at the end to return the remaining frames.
4224 * @note The AVCodecContext MUST have been opened with @ref avcodec_open2()
4225 * before packets may be fed to the decoder.
4227 * @param avctx the codec context
4228 * @param[out] picture The AVFrame in which the decoded video frame will be stored.
4229 * Use av_frame_alloc() to get an AVFrame. The codec will
4230 * allocate memory for the actual bitmap by calling the
4231 * AVCodecContext.get_buffer2() callback.
4232 * When AVCodecContext.refcounted_frames is set to 1, the frame is
4233 * reference counted and the returned reference belongs to the
4234 * caller. The caller must release the frame using av_frame_unref()
4235 * when the frame is no longer needed. The caller may safely write
4236 * to the frame if av_frame_is_writable() returns 1.
4237 * When AVCodecContext.refcounted_frames is set to 0, the returned
4238 * reference belongs to the decoder and is valid only until the
4239 * next call to this function or until closing or flushing the
4240 * decoder. The caller may not write to it.
4242 * @param[in] avpkt The input AVPacket containing the input buffer.
4243 * You can create such packet with av_init_packet() and by then setting
4244 * data and size, some decoders might in addition need other fields like
4245 * flags&AV_PKT_FLAG_KEY. All decoders are designed to use the least
4247 * @param[in,out] got_picture_ptr Zero if no frame could be decompressed, otherwise, it is nonzero.
4248 * @return On error a negative value is returned, otherwise the number of bytes
4249 * used or zero if no frame could be decompressed.
4251 int avcodec_decode_video2(AVCodecContext *avctx, AVFrame *picture,
4252 int *got_picture_ptr,
4253 const AVPacket *avpkt);
4256 * Decode a subtitle message.
4257 * Return a negative value on error, otherwise return the number of bytes used.
4258 * If no subtitle could be decompressed, got_sub_ptr is zero.
4259 * Otherwise, the subtitle is stored in *sub.
4260 * Note that CODEC_CAP_DR1 is not available for subtitle codecs. This is for
4261 * simplicity, because the performance difference is expect to be negligible
4262 * and reusing a get_buffer written for video codecs would probably perform badly
4263 * due to a potentially very different allocation pattern.
4265 * Some decoders (those marked with CODEC_CAP_DELAY) have a delay between input
4266 * and output. This means that for some packets they will not immediately
4267 * produce decoded output and need to be flushed at the end of decoding to get
4268 * all the decoded data. Flushing is done by calling this function with packets
4269 * with avpkt->data set to NULL and avpkt->size set to 0 until it stops
4270 * returning subtitles. It is safe to flush even those decoders that are not
4271 * marked with CODEC_CAP_DELAY, then no subtitles will be returned.
4273 * @note The AVCodecContext MUST have been opened with @ref avcodec_open2()
4274 * before packets may be fed to the decoder.
4276 * @param avctx the codec context
4277 * @param[out] sub The Preallocated AVSubtitle in which the decoded subtitle will be stored,
4278 * must be freed with avsubtitle_free if *got_sub_ptr is set.
4279 * @param[in,out] got_sub_ptr Zero if no subtitle could be decompressed, otherwise, it is nonzero.
4280 * @param[in] avpkt The input AVPacket containing the input buffer.
4282 int avcodec_decode_subtitle2(AVCodecContext *avctx, AVSubtitle *sub,
4287 * @defgroup lavc_parsing Frame parsing
4291 enum AVPictureStructure {
4292 AV_PICTURE_STRUCTURE_UNKNOWN, //< unknown
4293 AV_PICTURE_STRUCTURE_TOP_FIELD, //< coded as top field
4294 AV_PICTURE_STRUCTURE_BOTTOM_FIELD, //< coded as bottom field
4295 AV_PICTURE_STRUCTURE_FRAME, //< coded as frame
4298 typedef struct AVCodecParserContext {
4300 struct AVCodecParser *parser;
4301 int64_t frame_offset; /* offset of the current frame */
4302 int64_t cur_offset; /* current offset
4303 (incremented by each av_parser_parse()) */
4304 int64_t next_frame_offset; /* offset of the next frame */
4306 int pict_type; /* XXX: Put it back in AVCodecContext. */
4308 * This field is used for proper frame duration computation in lavf.
4309 * It signals, how much longer the frame duration of the current frame
4310 * is compared to normal frame duration.
4312 * frame_duration = (1 + repeat_pict) * time_base
4314 * It is used by codecs like H.264 to display telecined material.
4316 int repeat_pict; /* XXX: Put it back in AVCodecContext. */
4317 int64_t pts; /* pts of the current frame */
4318 int64_t dts; /* dts of the current frame */
4323 int fetch_timestamp;
4325 #define AV_PARSER_PTS_NB 4
4326 int cur_frame_start_index;
4327 int64_t cur_frame_offset[AV_PARSER_PTS_NB];
4328 int64_t cur_frame_pts[AV_PARSER_PTS_NB];
4329 int64_t cur_frame_dts[AV_PARSER_PTS_NB];
4332 #define PARSER_FLAG_COMPLETE_FRAMES 0x0001
4333 #define PARSER_FLAG_ONCE 0x0002
4334 /// Set if the parser has a valid file offset
4335 #define PARSER_FLAG_FETCHED_OFFSET 0x0004
4336 #define PARSER_FLAG_USE_CODEC_TS 0x1000
4338 int64_t offset; ///< byte offset from starting packet start
4339 int64_t cur_frame_end[AV_PARSER_PTS_NB];
4342 * Set by parser to 1 for key frames and 0 for non-key frames.
4343 * It is initialized to -1, so if the parser doesn't set this flag,
4344 * old-style fallback using AV_PICTURE_TYPE_I picture type as key frames
4350 * Time difference in stream time base units from the pts of this
4351 * packet to the point at which the output from the decoder has converged
4352 * independent from the availability of previous frames. That is, the
4353 * frames are virtually identical no matter if decoding started from
4354 * the very first frame or from this keyframe.
4355 * Is AV_NOPTS_VALUE if unknown.
4356 * This field is not the display duration of the current frame.
4357 * This field has no meaning if the packet does not have AV_PKT_FLAG_KEY
4360 * The purpose of this field is to allow seeking in streams that have no
4361 * keyframes in the conventional sense. It corresponds to the
4362 * recovery point SEI in H.264 and match_time_delta in NUT. It is also
4363 * essential for some types of subtitle streams to ensure that all
4364 * subtitles are correctly displayed after seeking.
4366 int64_t convergence_duration;
4368 // Timestamp generation support:
4370 * Synchronization point for start of timestamp generation.
4372 * Set to >0 for sync point, 0 for no sync point and <0 for undefined
4375 * For example, this corresponds to presence of H.264 buffering period
4381 * Offset of the current timestamp against last timestamp sync point in
4382 * units of AVCodecContext.time_base.
4384 * Set to INT_MIN when dts_sync_point unused. Otherwise, it must
4385 * contain a valid timestamp offset.
4387 * Note that the timestamp of sync point has usually a nonzero
4388 * dts_ref_dts_delta, which refers to the previous sync point. Offset of
4389 * the next frame after timestamp sync point will be usually 1.
4391 * For example, this corresponds to H.264 cpb_removal_delay.
4393 int dts_ref_dts_delta;
4396 * Presentation delay of current frame in units of AVCodecContext.time_base.
4398 * Set to INT_MIN when dts_sync_point unused. Otherwise, it must
4399 * contain valid non-negative timestamp delta (presentation time of a frame
4400 * must not lie in the past).
4402 * This delay represents the difference between decoding and presentation
4403 * time of the frame.
4405 * For example, this corresponds to H.264 dpb_output_delay.
4410 * Position of the packet in file.
4412 * Analogous to cur_frame_pts/dts
4414 int64_t cur_frame_pos[AV_PARSER_PTS_NB];
4417 * Byte position of currently parsed frame in stream.
4422 * Previous frame byte position.
4427 * Duration of the current frame.
4428 * For audio, this is in units of 1 / AVCodecContext.sample_rate.
4429 * For all other types, this is in units of AVCodecContext.time_base.
4433 enum AVFieldOrder field_order;
4436 * Indicate whether a picture is coded as a frame, top field or bottom field.
4438 * For example, H.264 field_pic_flag equal to 0 corresponds to
4439 * AV_PICTURE_STRUCTURE_FRAME. An H.264 picture with field_pic_flag
4440 * equal to 1 and bottom_field_flag equal to 0 corresponds to
4441 * AV_PICTURE_STRUCTURE_TOP_FIELD.
4443 enum AVPictureStructure picture_structure;
4446 * Picture number incremented in presentation or output order.
4447 * This field may be reinitialized at the first picture of a new sequence.
4449 * For example, this corresponds to H.264 PicOrderCnt.
4451 int output_picture_number;
4454 * Dimensions of the decoded video intended for presentation.
4460 * Dimensions of the coded video.
4466 * The format of the coded data, corresponds to enum AVPixelFormat for video
4467 * and for enum AVSampleFormat for audio.
4469 * Note that a decoder can have considerable freedom in how exactly it
4470 * decodes the data, so the format reported here might be different from the
4471 * one returned by a decoder.
4474 } AVCodecParserContext;
4476 typedef struct AVCodecParser {
4477 int codec_ids[5]; /* several codec IDs are permitted */
4479 int (*parser_init)(AVCodecParserContext *s);
4480 /* This callback never returns an error, a negative value means that
4481 * the frame start was in a previous packet. */
4482 int (*parser_parse)(AVCodecParserContext *s,
4483 AVCodecContext *avctx,
4484 const uint8_t **poutbuf, int *poutbuf_size,
4485 const uint8_t *buf, int buf_size);
4486 void (*parser_close)(AVCodecParserContext *s);
4487 int (*split)(AVCodecContext *avctx, const uint8_t *buf, int buf_size);
4488 struct AVCodecParser *next;
4491 AVCodecParser *av_parser_next(const AVCodecParser *c);
4493 void av_register_codec_parser(AVCodecParser *parser);
4494 AVCodecParserContext *av_parser_init(int codec_id);
4499 * @param s parser context.
4500 * @param avctx codec context.
4501 * @param poutbuf set to pointer to parsed buffer or NULL if not yet finished.
4502 * @param poutbuf_size set to size of parsed buffer or zero if not yet finished.
4503 * @param buf input buffer.
4504 * @param buf_size input length, to signal EOF, this should be 0 (so that the last frame can be output).
4505 * @param pts input presentation timestamp.
4506 * @param dts input decoding timestamp.
4507 * @param pos input byte position in stream.
4508 * @return the number of bytes of the input bitstream used.
4513 * len = av_parser_parse2(myparser, AVCodecContext, &data, &size,
4520 * decode_frame(data, size);
4524 int av_parser_parse2(AVCodecParserContext *s,
4525 AVCodecContext *avctx,
4526 uint8_t **poutbuf, int *poutbuf_size,
4527 const uint8_t *buf, int buf_size,
4528 int64_t pts, int64_t dts,
4532 * @return 0 if the output buffer is a subset of the input, 1 if it is allocated and must be freed
4533 * @deprecated use AVBitStreamFilter
4535 int av_parser_change(AVCodecParserContext *s,
4536 AVCodecContext *avctx,
4537 uint8_t **poutbuf, int *poutbuf_size,
4538 const uint8_t *buf, int buf_size, int keyframe);
4539 void av_parser_close(AVCodecParserContext *s);
4547 * @addtogroup lavc_encoding
4552 * Find a registered encoder with a matching codec ID.
4554 * @param id AVCodecID of the requested encoder
4555 * @return An encoder if one was found, NULL otherwise.
4557 AVCodec *avcodec_find_encoder(enum AVCodecID id);
4560 * Find a registered encoder with the specified name.
4562 * @param name name of the requested encoder
4563 * @return An encoder if one was found, NULL otherwise.
4565 AVCodec *avcodec_find_encoder_by_name(const char *name);
4567 #if FF_API_OLD_ENCODE_AUDIO
4569 * Encode an audio frame from samples into buf.
4571 * @deprecated Use avcodec_encode_audio2 instead.
4573 * @note The output buffer should be at least FF_MIN_BUFFER_SIZE bytes large.
4574 * However, for codecs with avctx->frame_size equal to 0 (e.g. PCM) the user
4575 * will know how much space is needed because it depends on the value passed
4576 * in buf_size as described below. In that case a lower value can be used.
4578 * @param avctx the codec context
4579 * @param[out] buf the output buffer
4580 * @param[in] buf_size the output buffer size
4581 * @param[in] samples the input buffer containing the samples
4582 * The number of samples read from this buffer is frame_size*channels,
4583 * both of which are defined in avctx.
4584 * For codecs which have avctx->frame_size equal to 0 (e.g. PCM) the number of
4585 * samples read from samples is equal to:
4586 * buf_size * 8 / (avctx->channels * av_get_bits_per_sample(avctx->codec_id))
4587 * This also implies that av_get_bits_per_sample() must not return 0 for these
4589 * @return On error a negative value is returned, on success zero or the number
4590 * of bytes used to encode the data read from the input buffer.
4592 int attribute_deprecated avcodec_encode_audio(AVCodecContext *avctx,
4593 uint8_t *buf, int buf_size,
4594 const short *samples);
4598 * Encode a frame of audio.
4600 * Takes input samples from frame and writes the next output packet, if
4601 * available, to avpkt. The output packet does not necessarily contain data for
4602 * the most recent frame, as encoders can delay, split, and combine input frames
4603 * internally as needed.
4605 * @param avctx codec context
4606 * @param avpkt output AVPacket.
4607 * The user can supply an output buffer by setting
4608 * avpkt->data and avpkt->size prior to calling the
4609 * function, but if the size of the user-provided data is not
4610 * large enough, encoding will fail. If avpkt->data and
4611 * avpkt->size are set, avpkt->destruct must also be set. All
4612 * other AVPacket fields will be reset by the encoder using
4613 * av_init_packet(). If avpkt->data is NULL, the encoder will
4614 * allocate it. The encoder will set avpkt->size to the size
4615 * of the output packet.
4617 * If this function fails or produces no output, avpkt will be
4618 * freed using av_free_packet() (i.e. avpkt->destruct will be
4619 * called to free the user supplied buffer).
4620 * @param[in] frame AVFrame containing the raw audio data to be encoded.
4621 * May be NULL when flushing an encoder that has the
4622 * CODEC_CAP_DELAY capability set.
4623 * If CODEC_CAP_VARIABLE_FRAME_SIZE is set, then each frame
4624 * can have any number of samples.
4625 * If it is not set, frame->nb_samples must be equal to
4626 * avctx->frame_size for all frames except the last.
4627 * The final frame may be smaller than avctx->frame_size.
4628 * @param[out] got_packet_ptr This field is set to 1 by libavcodec if the
4629 * output packet is non-empty, and to 0 if it is
4630 * empty. If the function returns an error, the
4631 * packet can be assumed to be invalid, and the
4632 * value of got_packet_ptr is undefined and should
4634 * @return 0 on success, negative error code on failure
4636 int avcodec_encode_audio2(AVCodecContext *avctx, AVPacket *avpkt,
4637 const AVFrame *frame, int *got_packet_ptr);
4639 #if FF_API_OLD_ENCODE_VIDEO
4641 * @deprecated use avcodec_encode_video2() instead.
4643 * Encode a video frame from pict into buf.
4644 * The input picture should be
4645 * stored using a specific format, namely avctx.pix_fmt.
4647 * @param avctx the codec context
4648 * @param[out] buf the output buffer for the bitstream of encoded frame
4649 * @param[in] buf_size the size of the output buffer in bytes
4650 * @param[in] pict the input picture to encode
4651 * @return On error a negative value is returned, on success zero or the number
4652 * of bytes used from the output buffer.
4654 attribute_deprecated
4655 int avcodec_encode_video(AVCodecContext *avctx, uint8_t *buf, int buf_size,
4656 const AVFrame *pict);
4660 * Encode a frame of video.
4662 * Takes input raw video data from frame and writes the next output packet, if
4663 * available, to avpkt. The output packet does not necessarily contain data for
4664 * the most recent frame, as encoders can delay and reorder input frames
4665 * internally as needed.
4667 * @param avctx codec context
4668 * @param avpkt output AVPacket.
4669 * The user can supply an output buffer by setting
4670 * avpkt->data and avpkt->size prior to calling the
4671 * function, but if the size of the user-provided data is not
4672 * large enough, encoding will fail. All other AVPacket fields
4673 * will be reset by the encoder using av_init_packet(). If
4674 * avpkt->data is NULL, the encoder will allocate it.
4675 * The encoder will set avpkt->size to the size of the
4676 * output packet. The returned data (if any) belongs to the
4677 * caller, he is responsible for freeing it.
4679 * If this function fails or produces no output, avpkt will be
4680 * freed using av_free_packet() (i.e. avpkt->destruct will be
4681 * called to free the user supplied buffer).
4682 * @param[in] frame AVFrame containing the raw video data to be encoded.
4683 * May be NULL when flushing an encoder that has the
4684 * CODEC_CAP_DELAY capability set.
4685 * @param[out] got_packet_ptr This field is set to 1 by libavcodec if the
4686 * output packet is non-empty, and to 0 if it is
4687 * empty. If the function returns an error, the
4688 * packet can be assumed to be invalid, and the
4689 * value of got_packet_ptr is undefined and should
4691 * @return 0 on success, negative error code on failure
4693 int avcodec_encode_video2(AVCodecContext *avctx, AVPacket *avpkt,
4694 const AVFrame *frame, int *got_packet_ptr);
4696 int avcodec_encode_subtitle(AVCodecContext *avctx, uint8_t *buf, int buf_size,
4697 const AVSubtitle *sub);
4704 #if FF_API_AVCODEC_RESAMPLE
4706 * @defgroup lavc_resample Audio resampling
4708 * @deprecated use libswresample instead
4712 struct ReSampleContext;
4713 struct AVResampleContext;
4715 typedef struct ReSampleContext ReSampleContext;
4718 * Initialize audio resampling context.
4720 * @param output_channels number of output channels
4721 * @param input_channels number of input channels
4722 * @param output_rate output sample rate
4723 * @param input_rate input sample rate
4724 * @param sample_fmt_out requested output sample format
4725 * @param sample_fmt_in input sample format
4726 * @param filter_length length of each FIR filter in the filterbank relative to the cutoff frequency
4727 * @param log2_phase_count log2 of the number of entries in the polyphase filterbank
4728 * @param linear if 1 then the used FIR filter will be linearly interpolated
4729 between the 2 closest, if 0 the closest will be used
4730 * @param cutoff cutoff frequency, 1.0 corresponds to half the output sampling rate
4731 * @return allocated ReSampleContext, NULL if error occurred
4733 attribute_deprecated
4734 ReSampleContext *av_audio_resample_init(int output_channels, int input_channels,
4735 int output_rate, int input_rate,
4736 enum AVSampleFormat sample_fmt_out,
4737 enum AVSampleFormat sample_fmt_in,
4738 int filter_length, int log2_phase_count,
4739 int linear, double cutoff);
4741 attribute_deprecated
4742 int audio_resample(ReSampleContext *s, short *output, short *input, int nb_samples);
4745 * Free resample context.
4747 * @param s a non-NULL pointer to a resample context previously
4748 * created with av_audio_resample_init()
4750 attribute_deprecated
4751 void audio_resample_close(ReSampleContext *s);
4755 * Initialize an audio resampler.
4756 * Note, if either rate is not an integer then simply scale both rates up so they are.
4757 * @param filter_length length of each FIR filter in the filterbank relative to the cutoff freq
4758 * @param log2_phase_count log2 of the number of entries in the polyphase filterbank
4759 * @param linear If 1 then the used FIR filter will be linearly interpolated
4760 between the 2 closest, if 0 the closest will be used
4761 * @param cutoff cutoff frequency, 1.0 corresponds to half the output sampling rate
4763 attribute_deprecated
4764 struct AVResampleContext *av_resample_init(int out_rate, int in_rate, int filter_length, int log2_phase_count, int linear, double cutoff);
4767 * Resample an array of samples using a previously configured context.
4768 * @param src an array of unconsumed samples
4769 * @param consumed the number of samples of src which have been consumed are returned here
4770 * @param src_size the number of unconsumed samples available
4771 * @param dst_size the amount of space in samples available in dst
4772 * @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.
4773 * @return the number of samples written in dst or -1 if an error occurred
4775 attribute_deprecated
4776 int av_resample(struct AVResampleContext *c, short *dst, short *src, int *consumed, int src_size, int dst_size, int update_ctx);
4780 * Compensate samplerate/timestamp drift. The compensation is done by changing
4781 * the resampler parameters, so no audible clicks or similar distortions occur
4782 * @param compensation_distance distance in output samples over which the compensation should be performed
4783 * @param sample_delta number of output samples which should be output less
4785 * example: av_resample_compensate(c, 10, 500)
4786 * here instead of 510 samples only 500 samples would be output
4788 * note, due to rounding the actual compensation might be slightly different,
4789 * especially if the compensation_distance is large and the in_rate used during init is small
4791 attribute_deprecated
4792 void av_resample_compensate(struct AVResampleContext *c, int sample_delta, int compensation_distance);
4793 attribute_deprecated
4794 void av_resample_close(struct AVResampleContext *c);
4802 * @addtogroup lavc_picture
4807 * Allocate memory for the pixels of a picture and setup the AVPicture
4810 * Call avpicture_free() to free it.
4812 * @param picture the picture structure to be filled in
4813 * @param pix_fmt the pixel format of the picture
4814 * @param width the width of the picture
4815 * @param height the height of the picture
4816 * @return zero if successful, a negative error code otherwise
4818 * @see av_image_alloc(), avpicture_fill()
4820 int avpicture_alloc(AVPicture *picture, enum AVPixelFormat pix_fmt, int width, int height);
4823 * Free a picture previously allocated by avpicture_alloc().
4824 * The data buffer used by the AVPicture is freed, but the AVPicture structure
4827 * @param picture the AVPicture to be freed
4829 void avpicture_free(AVPicture *picture);
4832 * Setup the picture fields based on the specified image parameters
4833 * and the provided image data buffer.
4835 * The picture fields are filled in by using the image data buffer
4836 * pointed to by ptr.
4838 * If ptr is NULL, the function will fill only the picture linesize
4839 * array and return the required size for the image buffer.
4841 * To allocate an image buffer and fill the picture data in one call,
4842 * use avpicture_alloc().
4844 * @param picture the picture to be filled in
4845 * @param ptr buffer where the image data is stored, or NULL
4846 * @param pix_fmt the pixel format of the image
4847 * @param width the width of the image in pixels
4848 * @param height the height of the image in pixels
4849 * @return the size in bytes required for src, a negative error code
4850 * in case of failure
4852 * @see av_image_fill_arrays()
4854 int avpicture_fill(AVPicture *picture, const uint8_t *ptr,
4855 enum AVPixelFormat pix_fmt, int width, int height);
4858 * Copy pixel data from an AVPicture into a buffer.
4860 * avpicture_get_size() can be used to compute the required size for
4861 * the buffer to fill.
4863 * @param src source picture with filled data
4864 * @param pix_fmt picture pixel format
4865 * @param width picture width
4866 * @param height picture height
4867 * @param dest destination buffer
4868 * @param dest_size destination buffer size in bytes
4869 * @return the number of bytes written to dest, or a negative value
4870 * (error code) on error, for example if the destination buffer is not
4873 * @see av_image_copy_to_buffer()
4875 int avpicture_layout(const AVPicture *src, enum AVPixelFormat pix_fmt,
4876 int width, int height,
4877 unsigned char *dest, int dest_size);
4880 * Calculate the size in bytes that a picture of the given width and height
4881 * would occupy if stored in the given picture format.
4883 * @param pix_fmt picture pixel format
4884 * @param width picture width
4885 * @param height picture height
4886 * @return the computed picture buffer size or a negative error code
4889 * @see av_image_get_buffer_size().
4891 int avpicture_get_size(enum AVPixelFormat pix_fmt, int width, int height);
4893 #if FF_API_DEINTERLACE
4895 * deinterlace - if not supported return -1
4897 * @deprecated - use yadif (in libavfilter) instead
4899 attribute_deprecated
4900 int avpicture_deinterlace(AVPicture *dst, const AVPicture *src,
4901 enum AVPixelFormat pix_fmt, int width, int height);
4904 * Copy image src to dst. Wraps av_image_copy().
4906 void av_picture_copy(AVPicture *dst, const AVPicture *src,
4907 enum AVPixelFormat pix_fmt, int width, int height);
4910 * Crop image top and left side.
4912 int av_picture_crop(AVPicture *dst, const AVPicture *src,
4913 enum AVPixelFormat pix_fmt, int top_band, int left_band);
4918 int av_picture_pad(AVPicture *dst, const AVPicture *src, int height, int width, enum AVPixelFormat pix_fmt,
4919 int padtop, int padbottom, int padleft, int padright, int *color);
4926 * @defgroup lavc_misc Utility functions
4929 * Miscellaneous utility functions related to both encoding and decoding
4935 * @defgroup lavc_misc_pixfmt Pixel formats
4937 * Functions for working with pixel formats.
4942 * Utility function to access log2_chroma_w log2_chroma_h from
4943 * the pixel format AVPixFmtDescriptor.
4945 * This function asserts that pix_fmt is valid. See av_pix_fmt_get_chroma_sub_sample
4946 * for one that returns a failure code and continues in case of invalid
4949 * @param[in] pix_fmt the pixel format
4950 * @param[out] h_shift store log2_chroma_w
4951 * @param[out] v_shift store log2_chroma_h
4953 * @see av_pix_fmt_get_chroma_sub_sample
4956 void avcodec_get_chroma_sub_sample(enum AVPixelFormat pix_fmt, int *h_shift, int *v_shift);
4959 * Return a value representing the fourCC code associated to the
4960 * pixel format pix_fmt, or 0 if no associated fourCC code can be
4963 unsigned int avcodec_pix_fmt_to_codec_tag(enum AVPixelFormat pix_fmt);
4966 * @deprecated see av_get_pix_fmt_loss()
4968 int avcodec_get_pix_fmt_loss(enum AVPixelFormat dst_pix_fmt, enum AVPixelFormat src_pix_fmt,
4972 * Find the best pixel format to convert to given a certain source pixel
4973 * format. When converting from one pixel format to another, information loss
4974 * may occur. For example, when converting from RGB24 to GRAY, the color
4975 * information will be lost. Similarly, other losses occur when converting from
4976 * some formats to other formats. avcodec_find_best_pix_fmt_of_2() searches which of
4977 * the given pixel formats should be used to suffer the least amount of loss.
4978 * The pixel formats from which it chooses one, are determined by the
4979 * pix_fmt_list parameter.
4982 * @param[in] pix_fmt_list AV_PIX_FMT_NONE terminated array of pixel formats to choose from
4983 * @param[in] src_pix_fmt source pixel format
4984 * @param[in] has_alpha Whether the source pixel format alpha channel is used.
4985 * @param[out] loss_ptr Combination of flags informing you what kind of losses will occur.
4986 * @return The best pixel format to convert to or -1 if none was found.
4988 enum AVPixelFormat avcodec_find_best_pix_fmt_of_list(const enum AVPixelFormat *pix_fmt_list,
4989 enum AVPixelFormat src_pix_fmt,
4990 int has_alpha, int *loss_ptr);
4993 * @deprecated see av_find_best_pix_fmt_of_2()
4995 enum AVPixelFormat avcodec_find_best_pix_fmt_of_2(enum AVPixelFormat dst_pix_fmt1, enum AVPixelFormat dst_pix_fmt2,
4996 enum AVPixelFormat src_pix_fmt, int has_alpha, int *loss_ptr);
4998 attribute_deprecated
4999 #if AV_HAVE_INCOMPATIBLE_LIBAV_ABI
5000 enum AVPixelFormat avcodec_find_best_pix_fmt2(const enum AVPixelFormat *pix_fmt_list,
5001 enum AVPixelFormat src_pix_fmt,
5002 int has_alpha, int *loss_ptr);
5004 enum AVPixelFormat avcodec_find_best_pix_fmt2(enum AVPixelFormat dst_pix_fmt1, enum AVPixelFormat dst_pix_fmt2,
5005 enum AVPixelFormat src_pix_fmt, int has_alpha, int *loss_ptr);
5009 enum AVPixelFormat avcodec_default_get_format(struct AVCodecContext *s, const enum AVPixelFormat * fmt);
5015 #if FF_API_SET_DIMENSIONS
5017 * @deprecated this function is not supposed to be used from outside of lavc
5019 attribute_deprecated
5020 void avcodec_set_dimensions(AVCodecContext *s, int width, int height);
5024 * Put a string representing the codec tag codec_tag in buf.
5026 * @param buf buffer to place codec tag in
5027 * @param buf_size size in bytes of buf
5028 * @param codec_tag codec tag to assign
5029 * @return the length of the string that would have been generated if
5030 * enough space had been available, excluding the trailing null
5032 size_t av_get_codec_tag_string(char *buf, size_t buf_size, unsigned int codec_tag);
5034 void avcodec_string(char *buf, int buf_size, AVCodecContext *enc, int encode);
5037 * Return a name for the specified profile, if available.
5039 * @param codec the codec that is searched for the given profile
5040 * @param profile the profile value for which a name is requested
5041 * @return A name for the profile if found, NULL otherwise.
5043 const char *av_get_profile_name(const AVCodec *codec, int profile);
5045 int avcodec_default_execute(AVCodecContext *c, int (*func)(AVCodecContext *c2, void *arg2),void *arg, int *ret, int count, int size);
5046 int avcodec_default_execute2(AVCodecContext *c, int (*func)(AVCodecContext *c2, void *arg2, int, int),void *arg, int *ret, int count);
5047 //FIXME func typedef
5050 * Fill AVFrame audio data and linesize pointers.
5052 * The buffer buf must be a preallocated buffer with a size big enough
5053 * to contain the specified samples amount. The filled AVFrame data
5054 * pointers will point to this buffer.
5056 * AVFrame extended_data channel pointers are allocated if necessary for
5059 * @param frame the AVFrame
5060 * frame->nb_samples must be set prior to calling the
5061 * function. This function fills in frame->data,
5062 * frame->extended_data, frame->linesize[0].
5063 * @param nb_channels channel count
5064 * @param sample_fmt sample format
5065 * @param buf buffer to use for frame data
5066 * @param buf_size size of buffer
5067 * @param align plane size sample alignment (0 = default)
5068 * @return >=0 on success, negative error code on failure
5069 * @todo return the size in bytes required to store the samples in
5070 * case of success, at the next libavutil bump
5072 int avcodec_fill_audio_frame(AVFrame *frame, int nb_channels,
5073 enum AVSampleFormat sample_fmt, const uint8_t *buf,
5074 int buf_size, int align);
5077 * Reset the internal decoder state / flush internal buffers. Should be called
5078 * e.g. when seeking or when switching to a different stream.
5080 * @note when refcounted frames are not used (i.e. avctx->refcounted_frames is 0),
5081 * this invalidates the frames previously returned from the decoder. When
5082 * refcounted frames are used, the decoder just releases any references it might
5083 * keep internally, but the caller's reference remains valid.
5085 void avcodec_flush_buffers(AVCodecContext *avctx);
5088 * Return codec bits per sample.
5090 * @param[in] codec_id the codec
5091 * @return Number of bits per sample or zero if unknown for the given codec.
5093 int av_get_bits_per_sample(enum AVCodecID codec_id);
5096 * Return the PCM codec associated with a sample format.
5097 * @param be endianness, 0 for little, 1 for big,
5098 * -1 (or anything else) for native
5099 * @return AV_CODEC_ID_PCM_* or AV_CODEC_ID_NONE
5101 enum AVCodecID av_get_pcm_codec(enum AVSampleFormat fmt, int be);
5104 * Return codec bits per sample.
5105 * Only return non-zero if the bits per sample is exactly correct, not an
5108 * @param[in] codec_id the codec
5109 * @return Number of bits per sample or zero if unknown for the given codec.
5111 int av_get_exact_bits_per_sample(enum AVCodecID codec_id);
5114 * Return audio frame duration.
5116 * @param avctx codec context
5117 * @param frame_bytes size of the frame, or 0 if unknown
5118 * @return frame duration, in samples, if known. 0 if not able to
5121 int av_get_audio_frame_duration(AVCodecContext *avctx, int frame_bytes);
5124 typedef struct AVBitStreamFilterContext {
5126 struct AVBitStreamFilter *filter;
5127 AVCodecParserContext *parser;
5128 struct AVBitStreamFilterContext *next;
5129 } AVBitStreamFilterContext;
5132 typedef struct AVBitStreamFilter {
5135 int (*filter)(AVBitStreamFilterContext *bsfc,
5136 AVCodecContext *avctx, const char *args,
5137 uint8_t **poutbuf, int *poutbuf_size,
5138 const uint8_t *buf, int buf_size, int keyframe);
5139 void (*close)(AVBitStreamFilterContext *bsfc);
5140 struct AVBitStreamFilter *next;
5141 } AVBitStreamFilter;
5144 * Register a bitstream filter.
5146 * The filter will be accessible to the application code through
5147 * av_bitstream_filter_next() or can be directly initialized with
5148 * av_bitstream_filter_init().
5150 * @see avcodec_register_all()
5152 void av_register_bitstream_filter(AVBitStreamFilter *bsf);
5155 * Create and initialize a bitstream filter context given a bitstream
5158 * The returned context must be freed with av_bitstream_filter_close().
5160 * @param name the name of the bitstream filter
5161 * @return a bitstream filter context if a matching filter was found
5162 * and successfully initialized, NULL otherwise
5164 AVBitStreamFilterContext *av_bitstream_filter_init(const char *name);
5169 * This function filters the buffer buf with size buf_size, and places the
5170 * filtered buffer in the buffer pointed to by poutbuf.
5172 * The output buffer must be freed by the caller.
5174 * @param bsfc bitstream filter context created by av_bitstream_filter_init()
5175 * @param avctx AVCodecContext accessed by the filter, may be NULL.
5176 * If specified, this must point to the encoder context of the
5177 * output stream the packet is sent to.
5178 * @param args arguments which specify the filter configuration, may be NULL
5179 * @param poutbuf pointer which is updated to point to the filtered buffer
5180 * @param poutbuf_size pointer which is updated to the filtered buffer size in bytes
5181 * @param buf buffer containing the data to filter
5182 * @param buf_size size in bytes of buf
5183 * @param keyframe set to non-zero if the buffer to filter corresponds to a key-frame packet data
5184 * @return >= 0 in case of success, or a negative error code in case of failure
5186 * If the return value is positive, an output buffer is allocated and
5187 * is available in *poutbuf, and is distinct from the input buffer.
5189 * If the return value is 0, the output buffer is not allocated and
5190 * should be considered identical to the input buffer, or in case
5191 * *poutbuf was set it points to the input buffer (not necessarily to
5192 * its starting address).
5194 int av_bitstream_filter_filter(AVBitStreamFilterContext *bsfc,
5195 AVCodecContext *avctx, const char *args,
5196 uint8_t **poutbuf, int *poutbuf_size,
5197 const uint8_t *buf, int buf_size, int keyframe);
5200 * Release bitstream filter context.
5202 * @param bsf the bitstream filter context created with
5203 * av_bitstream_filter_init(), can be NULL
5205 void av_bitstream_filter_close(AVBitStreamFilterContext *bsf);
5208 * If f is NULL, return the first registered bitstream filter,
5209 * if f is non-NULL, return the next registered bitstream filter
5210 * after f, or NULL if f is the last one.
5212 * This function can be used to iterate over all registered bitstream
5215 AVBitStreamFilter *av_bitstream_filter_next(const AVBitStreamFilter *f);
5220 * Same behaviour av_fast_malloc but the buffer has additional
5221 * FF_INPUT_BUFFER_PADDING_SIZE at the end which will always be 0.
5223 * In addition the whole buffer will initially and after resizes
5224 * be 0-initialized so that no uninitialized data will ever appear.
5226 void av_fast_padded_malloc(void *ptr, unsigned int *size, size_t min_size);
5229 * Same behaviour av_fast_padded_malloc except that buffer will always
5230 * be 0-initialized after call.
5232 void av_fast_padded_mallocz(void *ptr, unsigned int *size, size_t min_size);
5235 * Encode extradata length to a buffer. Used by xiph codecs.
5237 * @param s buffer to write to; must be at least (v/255+1) bytes long
5238 * @param v size of extradata in bytes
5239 * @return number of bytes written to the buffer.
5241 unsigned int av_xiphlacing(unsigned char *s, unsigned int v);
5243 #if FF_API_MISSING_SAMPLE
5245 * Log a generic warning message about a missing feature. This function is
5246 * intended to be used internally by FFmpeg (libavcodec, libavformat, etc.)
5247 * only, and would normally not be used by applications.
5248 * @param[in] avc a pointer to an arbitrary struct of which the first field is
5249 * a pointer to an AVClass struct
5250 * @param[in] feature string containing the name of the missing feature
5251 * @param[in] want_sample indicates if samples are wanted which exhibit this feature.
5252 * If want_sample is non-zero, additional verbage will be added to the log
5253 * message which tells the user how to report samples to the development
5255 * @deprecated Use avpriv_report_missing_feature() instead.
5257 attribute_deprecated
5258 void av_log_missing_feature(void *avc, const char *feature, int want_sample);
5261 * Log a generic warning message asking for a sample. This function is
5262 * intended to be used internally by FFmpeg (libavcodec, libavformat, etc.)
5263 * only, and would normally not be used by applications.
5264 * @param[in] avc a pointer to an arbitrary struct of which the first field is
5265 * a pointer to an AVClass struct
5266 * @param[in] msg string containing an optional message, or NULL if no message
5267 * @deprecated Use avpriv_request_sample() instead.
5269 attribute_deprecated
5270 void av_log_ask_for_sample(void *avc, const char *msg, ...) av_printf_format(2, 3);
5271 #endif /* FF_API_MISSING_SAMPLE */
5274 * Register the hardware accelerator hwaccel.
5276 void av_register_hwaccel(AVHWAccel *hwaccel);
5279 * If hwaccel is NULL, returns the first registered hardware accelerator,
5280 * if hwaccel is non-NULL, returns the next registered hardware accelerator
5281 * after hwaccel, or NULL if hwaccel is the last one.
5283 AVHWAccel *av_hwaccel_next(const AVHWAccel *hwaccel);
5287 * Lock operation used by lockmgr
5290 AV_LOCK_CREATE, ///< Create a mutex
5291 AV_LOCK_OBTAIN, ///< Lock the mutex
5292 AV_LOCK_RELEASE, ///< Unlock the mutex
5293 AV_LOCK_DESTROY, ///< Free mutex resources
5297 * Register a user provided lock manager supporting the operations
5298 * specified by AVLockOp. The "mutex" argument to the function points
5299 * to a (void *) where the lockmgr should store/get a pointer to a user
5300 * allocated mutex. It is NULL upon AV_LOCK_CREATE and equal to the
5301 * value left by the last call for all other ops. If the lock manager is
5302 * unable to perform the op then it should leave the mutex in the same
5303 * state as when it was called and return a non-zero value. However,
5304 * when called with AV_LOCK_DESTROY the mutex will always be assumed to
5305 * have been successfully destroyed. If av_lockmgr_register succeeds
5306 * it will return a non-negative value, if it fails it will return a
5307 * negative value and destroy all mutex and unregister all callbacks.
5308 * av_lockmgr_register is not thread-safe, it must be called from a
5309 * single thread before any calls which make use of locking are used.
5311 * @param cb User defined callback. av_lockmgr_register invokes calls
5312 * to this callback and the previously registered callback.
5313 * The callback will be used to create more than one mutex
5314 * each of which must be backed by its own underlying locking
5315 * mechanism (i.e. do not use a single static object to
5316 * implement your lock manager). If cb is set to NULL the
5317 * lockmgr will be unregistered.
5319 int av_lockmgr_register(int (*cb)(void **mutex, enum AVLockOp op));
5322 * Get the type of the given codec.
5324 enum AVMediaType avcodec_get_type(enum AVCodecID codec_id);
5327 * Get the name of a codec.
5328 * @return a static string identifying the codec; never NULL
5330 const char *avcodec_get_name(enum AVCodecID id);
5333 * @return a positive value if s is open (i.e. avcodec_open2() was called on it
5334 * with no corresponding avcodec_close()), 0 otherwise.
5336 int avcodec_is_open(AVCodecContext *s);
5339 * @return a non-zero number if codec is an encoder, zero otherwise
5341 int av_codec_is_encoder(const AVCodec *codec);
5344 * @return a non-zero number if codec is a decoder, zero otherwise
5346 int av_codec_is_decoder(const AVCodec *codec);
5349 * @return descriptor for given codec ID or NULL if no descriptor exists.
5351 const AVCodecDescriptor *avcodec_descriptor_get(enum AVCodecID id);
5354 * Iterate over all codec descriptors known to libavcodec.
5356 * @param prev previous descriptor. NULL to get the first descriptor.
5358 * @return next descriptor or NULL after the last descriptor
5360 const AVCodecDescriptor *avcodec_descriptor_next(const AVCodecDescriptor *prev);
5363 * @return codec descriptor with the given name or NULL if no such descriptor
5366 const AVCodecDescriptor *avcodec_descriptor_get_by_name(const char *name);
5372 #endif /* AVCODEC_AVCODEC_H */