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
108 AV_CODEC_ID_MPEG2VIDEO_XVMC,
119 AV_CODEC_ID_RAWVIDEO,
120 AV_CODEC_ID_MSMPEG4V1,
121 AV_CODEC_ID_MSMPEG4V2,
122 AV_CODEC_ID_MSMPEG4V3,
145 AV_CODEC_ID_INTERPLAY_VIDEO,
152 AV_CODEC_ID_MSVIDEO1,
157 AV_CODEC_ID_TRUEMOTION1,
158 AV_CODEC_ID_VMDVIDEO,
183 AV_CODEC_ID_TRUEMOTION2,
189 AV_CODEC_ID_SMACKVIDEO,
194 AV_CODEC_ID_JPEG2000,
200 AV_CODEC_ID_DSICINVIDEO,
201 AV_CODEC_ID_TIERTEXSEQVIDEO,
209 AV_CODEC_ID_BETHSOFTVID,
221 AV_CODEC_ID_ESCAPE124,
225 AV_CODEC_ID_MOTIONPIXELS,
237 AV_CODEC_ID_FLASHSV2,
238 AV_CODEC_ID_CDGRAPHICS,
241 AV_CODEC_ID_BINKVIDEO,
242 AV_CODEC_ID_IFF_ILBM,
243 AV_CODEC_ID_IFF_BYTERUN1,
249 AV_CODEC_ID_A64_MULTI,
250 AV_CODEC_ID_A64_MULTI5,
253 AV_CODEC_ID_LAGARITH,
257 AV_CODEC_ID_WMV3IMAGE,
258 AV_CODEC_ID_VC1IMAGE,
260 AV_CODEC_ID_BMV_VIDEO,
267 AV_CODEC_ID_ZEROCODEC,
276 AV_CODEC_ID_ESCAPE130_DEPRECATED,
277 AV_CODEC_ID_G2M_DEPRECATED,
278 AV_CODEC_ID_WEBP_DEPRECATED,
279 AV_CODEC_ID_HNM4_VIDEO,
280 AV_CODEC_ID_HEVC_DEPRECATED,
282 AV_CODEC_ID_BRENDER_PIX= MKBETAG('B','P','I','X'),
283 AV_CODEC_ID_Y41P = MKBETAG('Y','4','1','P'),
284 AV_CODEC_ID_ESCAPE130 = MKBETAG('E','1','3','0'),
285 AV_CODEC_ID_EXR = MKBETAG('0','E','X','R'),
286 AV_CODEC_ID_AVRP = MKBETAG('A','V','R','P'),
288 AV_CODEC_ID_012V = MKBETAG('0','1','2','V'),
289 AV_CODEC_ID_G2M = MKBETAG( 0 ,'G','2','M'),
290 AV_CODEC_ID_AVUI = MKBETAG('A','V','U','I'),
291 AV_CODEC_ID_AYUV = MKBETAG('A','Y','U','V'),
292 AV_CODEC_ID_TARGA_Y216 = MKBETAG('T','2','1','6'),
293 AV_CODEC_ID_V308 = MKBETAG('V','3','0','8'),
294 AV_CODEC_ID_V408 = MKBETAG('V','4','0','8'),
295 AV_CODEC_ID_YUV4 = MKBETAG('Y','U','V','4'),
296 AV_CODEC_ID_SANM = MKBETAG('S','A','N','M'),
297 AV_CODEC_ID_PAF_VIDEO = MKBETAG('P','A','F','V'),
298 AV_CODEC_ID_AVRN = MKBETAG('A','V','R','n'),
299 AV_CODEC_ID_CPIA = MKBETAG('C','P','I','A'),
300 AV_CODEC_ID_XFACE = MKBETAG('X','F','A','C'),
301 AV_CODEC_ID_SGIRLE = MKBETAG('S','G','I','R'),
302 AV_CODEC_ID_MVC1 = MKBETAG('M','V','C','1'),
303 AV_CODEC_ID_MVC2 = MKBETAG('M','V','C','2'),
304 AV_CODEC_ID_SNOW = MKBETAG('S','N','O','W'),
305 AV_CODEC_ID_WEBP = MKBETAG('W','E','B','P'),
306 AV_CODEC_ID_SMVJPEG = MKBETAG('S','M','V','J'),
307 AV_CODEC_ID_HEVC = MKBETAG('H','2','6','5'),
308 #define AV_CODEC_ID_H265 AV_CODEC_ID_HEVC
310 /* various PCM "codecs" */
311 AV_CODEC_ID_FIRST_AUDIO = 0x10000, ///< A dummy id pointing at the start of audio codecs
312 AV_CODEC_ID_PCM_S16LE = 0x10000,
313 AV_CODEC_ID_PCM_S16BE,
314 AV_CODEC_ID_PCM_U16LE,
315 AV_CODEC_ID_PCM_U16BE,
318 AV_CODEC_ID_PCM_MULAW,
319 AV_CODEC_ID_PCM_ALAW,
320 AV_CODEC_ID_PCM_S32LE,
321 AV_CODEC_ID_PCM_S32BE,
322 AV_CODEC_ID_PCM_U32LE,
323 AV_CODEC_ID_PCM_U32BE,
324 AV_CODEC_ID_PCM_S24LE,
325 AV_CODEC_ID_PCM_S24BE,
326 AV_CODEC_ID_PCM_U24LE,
327 AV_CODEC_ID_PCM_U24BE,
328 AV_CODEC_ID_PCM_S24DAUD,
329 AV_CODEC_ID_PCM_ZORK,
330 AV_CODEC_ID_PCM_S16LE_PLANAR,
332 AV_CODEC_ID_PCM_F32BE,
333 AV_CODEC_ID_PCM_F32LE,
334 AV_CODEC_ID_PCM_F64BE,
335 AV_CODEC_ID_PCM_F64LE,
336 AV_CODEC_ID_PCM_BLURAY,
339 AV_CODEC_ID_PCM_S8_PLANAR,
340 AV_CODEC_ID_PCM_S24LE_PLANAR_DEPRECATED,
341 AV_CODEC_ID_PCM_S32LE_PLANAR_DEPRECATED,
342 AV_CODEC_ID_PCM_S24LE_PLANAR = MKBETAG(24,'P','S','P'),
343 AV_CODEC_ID_PCM_S32LE_PLANAR = MKBETAG(32,'P','S','P'),
344 AV_CODEC_ID_PCM_S16BE_PLANAR = MKBETAG('P','S','P',16),
346 /* various ADPCM codecs */
347 AV_CODEC_ID_ADPCM_IMA_QT = 0x11000,
348 AV_CODEC_ID_ADPCM_IMA_WAV,
349 AV_CODEC_ID_ADPCM_IMA_DK3,
350 AV_CODEC_ID_ADPCM_IMA_DK4,
351 AV_CODEC_ID_ADPCM_IMA_WS,
352 AV_CODEC_ID_ADPCM_IMA_SMJPEG,
353 AV_CODEC_ID_ADPCM_MS,
354 AV_CODEC_ID_ADPCM_4XM,
355 AV_CODEC_ID_ADPCM_XA,
356 AV_CODEC_ID_ADPCM_ADX,
357 AV_CODEC_ID_ADPCM_EA,
358 AV_CODEC_ID_ADPCM_G726,
359 AV_CODEC_ID_ADPCM_CT,
360 AV_CODEC_ID_ADPCM_SWF,
361 AV_CODEC_ID_ADPCM_YAMAHA,
362 AV_CODEC_ID_ADPCM_SBPRO_4,
363 AV_CODEC_ID_ADPCM_SBPRO_3,
364 AV_CODEC_ID_ADPCM_SBPRO_2,
365 AV_CODEC_ID_ADPCM_THP,
366 AV_CODEC_ID_ADPCM_IMA_AMV,
367 AV_CODEC_ID_ADPCM_EA_R1,
368 AV_CODEC_ID_ADPCM_EA_R3,
369 AV_CODEC_ID_ADPCM_EA_R2,
370 AV_CODEC_ID_ADPCM_IMA_EA_SEAD,
371 AV_CODEC_ID_ADPCM_IMA_EA_EACS,
372 AV_CODEC_ID_ADPCM_EA_XAS,
373 AV_CODEC_ID_ADPCM_EA_MAXIS_XA,
374 AV_CODEC_ID_ADPCM_IMA_ISS,
375 AV_CODEC_ID_ADPCM_G722,
376 AV_CODEC_ID_ADPCM_IMA_APC,
377 AV_CODEC_ID_VIMA = MKBETAG('V','I','M','A'),
378 AV_CODEC_ID_ADPCM_AFC = MKBETAG('A','F','C',' '),
379 AV_CODEC_ID_ADPCM_IMA_OKI = MKBETAG('O','K','I',' '),
380 AV_CODEC_ID_ADPCM_DTK = MKBETAG('D','T','K',' '),
381 AV_CODEC_ID_ADPCM_IMA_RAD = MKBETAG('R','A','D',' '),
382 AV_CODEC_ID_ADPCM_G726LE = MKBETAG('6','2','7','G'),
385 AV_CODEC_ID_AMR_NB = 0x12000,
388 /* RealAudio codecs*/
389 AV_CODEC_ID_RA_144 = 0x13000,
392 /* various DPCM codecs */
393 AV_CODEC_ID_ROQ_DPCM = 0x14000,
394 AV_CODEC_ID_INTERPLAY_DPCM,
395 AV_CODEC_ID_XAN_DPCM,
396 AV_CODEC_ID_SOL_DPCM,
399 AV_CODEC_ID_MP2 = 0x15000,
400 AV_CODEC_ID_MP3, ///< preferred ID for decoding MPEG audio layer 1, 2 or 3
410 AV_CODEC_ID_VMDAUDIO,
416 AV_CODEC_ID_WESTWOOD_SND1,
417 AV_CODEC_ID_GSM, ///< as in Berlin toast format
420 AV_CODEC_ID_TRUESPEECH,
422 AV_CODEC_ID_SMACKAUDIO,
425 AV_CODEC_ID_DSICINAUDIO,
427 AV_CODEC_ID_MUSEPACK7,
429 AV_CODEC_ID_GSM_MS, /* as found in WAV */
435 AV_CODEC_ID_NELLYMOSER,
436 AV_CODEC_ID_MUSEPACK8,
438 AV_CODEC_ID_WMAVOICE,
440 AV_CODEC_ID_WMALOSSLESS,
449 AV_CODEC_ID_BINKAUDIO_RDFT,
450 AV_CODEC_ID_BINKAUDIO_DCT,
451 AV_CODEC_ID_AAC_LATM,
456 AV_CODEC_ID_8SVX_EXP,
457 AV_CODEC_ID_8SVX_FIB,
458 AV_CODEC_ID_BMV_AUDIO,
462 AV_CODEC_ID_OPUS_DEPRECATED,
463 AV_CODEC_ID_COMFORT_NOISE,
464 AV_CODEC_ID_TAK_DEPRECATED,
465 AV_CODEC_ID_METASOUND,
466 AV_CODEC_ID_FFWAVESYNTH = MKBETAG('F','F','W','S'),
467 AV_CODEC_ID_SONIC = MKBETAG('S','O','N','C'),
468 AV_CODEC_ID_SONIC_LS = MKBETAG('S','O','N','L'),
469 AV_CODEC_ID_PAF_AUDIO = MKBETAG('P','A','F','A'),
470 AV_CODEC_ID_OPUS = MKBETAG('O','P','U','S'),
471 AV_CODEC_ID_TAK = MKBETAG('t','B','a','K'),
472 AV_CODEC_ID_EVRC = MKBETAG('s','e','v','c'),
473 AV_CODEC_ID_SMV = MKBETAG('s','s','m','v'),
475 /* subtitle codecs */
476 AV_CODEC_ID_FIRST_SUBTITLE = 0x17000, ///< A dummy ID pointing at the start of subtitle codecs.
477 AV_CODEC_ID_DVD_SUBTITLE = 0x17000,
478 AV_CODEC_ID_DVB_SUBTITLE,
479 AV_CODEC_ID_TEXT, ///< raw UTF-8 text
482 AV_CODEC_ID_MOV_TEXT,
483 AV_CODEC_ID_HDMV_PGS_SUBTITLE,
484 AV_CODEC_ID_DVB_TELETEXT,
486 AV_CODEC_ID_MICRODVD = MKBETAG('m','D','V','D'),
487 AV_CODEC_ID_EIA_608 = MKBETAG('c','6','0','8'),
488 AV_CODEC_ID_JACOSUB = MKBETAG('J','S','U','B'),
489 AV_CODEC_ID_SAMI = MKBETAG('S','A','M','I'),
490 AV_CODEC_ID_REALTEXT = MKBETAG('R','T','X','T'),
491 AV_CODEC_ID_SUBVIEWER1 = MKBETAG('S','b','V','1'),
492 AV_CODEC_ID_SUBVIEWER = MKBETAG('S','u','b','V'),
493 AV_CODEC_ID_SUBRIP = MKBETAG('S','R','i','p'),
494 AV_CODEC_ID_WEBVTT = MKBETAG('W','V','T','T'),
495 AV_CODEC_ID_MPL2 = MKBETAG('M','P','L','2'),
496 AV_CODEC_ID_VPLAYER = MKBETAG('V','P','l','r'),
497 AV_CODEC_ID_PJS = MKBETAG('P','h','J','S'),
498 AV_CODEC_ID_ASS = MKBETAG('A','S','S',' '), ///< ASS as defined in Matroska
500 /* other specific kind of codecs (generally used for attachments) */
501 AV_CODEC_ID_FIRST_UNKNOWN = 0x18000, ///< A dummy ID pointing at the start of various fake codecs.
502 AV_CODEC_ID_TTF = 0x18000,
503 AV_CODEC_ID_BINTEXT = MKBETAG('B','T','X','T'),
504 AV_CODEC_ID_XBIN = MKBETAG('X','B','I','N'),
505 AV_CODEC_ID_IDF = MKBETAG( 0 ,'I','D','F'),
506 AV_CODEC_ID_OTF = MKBETAG( 0 ,'O','T','F'),
507 AV_CODEC_ID_SMPTE_KLV = MKBETAG('K','L','V','A'),
508 AV_CODEC_ID_DVD_NAV = MKBETAG('D','N','A','V'),
511 AV_CODEC_ID_PROBE = 0x19000, ///< codec_id is not known (like AV_CODEC_ID_NONE) but lavf should attempt to identify it
513 AV_CODEC_ID_MPEG2TS = 0x20000, /**< _FAKE_ codec to indicate a raw MPEG-2 TS
514 * stream (only used by libavformat) */
515 AV_CODEC_ID_MPEG4SYSTEMS = 0x20001, /**< _FAKE_ codec to indicate a MPEG-4 Systems
516 * stream (only used by libavformat) */
517 AV_CODEC_ID_FFMETADATA = 0x21000, ///< Dummy codec for streams containing only metadata information.
520 #include "old_codec_ids.h"
525 * This struct describes the properties of a single codec described by an
527 * @see avcodec_get_descriptor()
529 typedef struct AVCodecDescriptor {
531 enum AVMediaType type;
533 * Name of the codec described by this descriptor. It is non-empty and
534 * unique for each codec descriptor. It should contain alphanumeric
535 * characters and '_' only.
539 * A more descriptive name for this codec. May be NULL.
541 const char *long_name;
543 * Codec properties, a combination of AV_CODEC_PROP_* flags.
549 * Codec uses only intra compression.
552 #define AV_CODEC_PROP_INTRA_ONLY (1 << 0)
554 * Codec supports lossy compression. Audio and video codecs only.
555 * @note a codec may support both lossy and lossless
558 #define AV_CODEC_PROP_LOSSY (1 << 1)
560 * Codec supports lossless compression. Audio and video codecs only.
562 #define AV_CODEC_PROP_LOSSLESS (1 << 2)
564 * Subtitle codec is bitmap based
565 * Decoded AVSubtitle data can be read from the AVSubtitleRect->pict field.
567 #define AV_CODEC_PROP_BITMAP_SUB (1 << 16)
569 * Subtitle codec is text based.
570 * Decoded AVSubtitle data can be read from the AVSubtitleRect->ass field.
572 #define AV_CODEC_PROP_TEXT_SUB (1 << 17)
575 * @ingroup lavc_decoding
576 * Required number of additionally allocated bytes at the end of the input bitstream for decoding.
577 * This is mainly needed because some optimized bitstream readers read
578 * 32 or 64 bit at once and could read over the end.<br>
579 * Note: If the first 23 bits of the additional bytes are not 0, then damaged
580 * MPEG bitstreams could cause overread and segfault.
582 #define FF_INPUT_BUFFER_PADDING_SIZE 16
585 * @ingroup lavc_encoding
586 * minimum encoding buffer size
587 * Used to avoid some checks during header writing.
589 #define FF_MIN_BUFFER_SIZE 16384
593 * @ingroup lavc_encoding
594 * motion estimation type.
597 ME_ZERO = 1, ///< no search, that is use 0,0 vector whenever one is needed
601 ME_EPZS, ///< enhanced predictive zonal search
602 ME_X1, ///< reserved for experiments
603 ME_HEX, ///< hexagon based search
604 ME_UMH, ///< uneven multi-hexagon search
605 ME_TESA, ///< transformed exhaustive search algorithm
606 ME_ITER=50, ///< iterative search
610 * @ingroup lavc_decoding
613 /* We leave some space between them for extensions (drop some
614 * keyframes for intra-only or drop just some bidir frames). */
615 AVDISCARD_NONE =-16, ///< discard nothing
616 AVDISCARD_DEFAULT = 0, ///< discard useless packets like 0 size packets in avi
617 AVDISCARD_NONREF = 8, ///< discard all non reference
618 AVDISCARD_BIDIR = 16, ///< discard all bidirectional frames
619 AVDISCARD_NONKEY = 32, ///< discard all frames except keyframes
620 AVDISCARD_ALL = 48, ///< discard all
623 enum AVColorPrimaries{
624 AVCOL_PRI_BT709 = 1, ///< also ITU-R BT1361 / IEC 61966-2-4 / SMPTE RP177 Annex B
625 AVCOL_PRI_UNSPECIFIED = 2,
626 AVCOL_PRI_BT470M = 4,
627 AVCOL_PRI_BT470BG = 5, ///< also ITU-R BT601-6 625 / ITU-R BT1358 625 / ITU-R BT1700 625 PAL & SECAM
628 AVCOL_PRI_SMPTE170M = 6, ///< also ITU-R BT601-6 525 / ITU-R BT1358 525 / ITU-R BT1700 NTSC
629 AVCOL_PRI_SMPTE240M = 7, ///< functionally identical to above
631 AVCOL_PRI_NB , ///< Not part of ABI
634 enum AVColorTransferCharacteristic{
635 AVCOL_TRC_BT709 = 1, ///< also ITU-R BT1361
636 AVCOL_TRC_UNSPECIFIED = 2,
637 AVCOL_TRC_GAMMA22 = 4, ///< also ITU-R BT470M / ITU-R BT1700 625 PAL & SECAM
638 AVCOL_TRC_GAMMA28 = 5, ///< also ITU-R BT470BG
639 AVCOL_TRC_SMPTE240M = 7,
640 AVCOL_TRC_NB , ///< Not part of ABI
644 * X X 3 4 X X are luma samples,
645 * 1 2 1-6 are possible chroma positions
646 * X X 5 6 X 0 is undefined/unknown position
648 enum AVChromaLocation{
649 AVCHROMA_LOC_UNSPECIFIED = 0,
650 AVCHROMA_LOC_LEFT = 1, ///< mpeg2/4, h264 default
651 AVCHROMA_LOC_CENTER = 2, ///< mpeg1, jpeg, h263
652 AVCHROMA_LOC_TOPLEFT = 3, ///< DV
653 AVCHROMA_LOC_TOP = 4,
654 AVCHROMA_LOC_BOTTOMLEFT = 5,
655 AVCHROMA_LOC_BOTTOM = 6,
656 AVCHROMA_LOC_NB , ///< Not part of ABI
659 enum AVAudioServiceType {
660 AV_AUDIO_SERVICE_TYPE_MAIN = 0,
661 AV_AUDIO_SERVICE_TYPE_EFFECTS = 1,
662 AV_AUDIO_SERVICE_TYPE_VISUALLY_IMPAIRED = 2,
663 AV_AUDIO_SERVICE_TYPE_HEARING_IMPAIRED = 3,
664 AV_AUDIO_SERVICE_TYPE_DIALOGUE = 4,
665 AV_AUDIO_SERVICE_TYPE_COMMENTARY = 5,
666 AV_AUDIO_SERVICE_TYPE_EMERGENCY = 6,
667 AV_AUDIO_SERVICE_TYPE_VOICE_OVER = 7,
668 AV_AUDIO_SERVICE_TYPE_KARAOKE = 8,
669 AV_AUDIO_SERVICE_TYPE_NB , ///< Not part of ABI
673 * @ingroup lavc_encoding
675 typedef struct RcOverride{
678 int qscale; // If this is 0 then quality_factor will be used instead.
679 float quality_factor;
682 #define FF_MAX_B_FRAMES 16
685 These flags can be passed in AVCodecContext.flags before initialization.
686 Note: Not everything is supported yet.
690 * Allow decoders to produce frames with data planes that are not aligned
691 * to CPU requirements (e.g. due to cropping).
693 #define CODEC_FLAG_UNALIGNED 0x0001
694 #define CODEC_FLAG_QSCALE 0x0002 ///< Use fixed qscale.
695 #define CODEC_FLAG_4MV 0x0004 ///< 4 MV per MB allowed / advanced prediction for H.263.
696 #define CODEC_FLAG_OUTPUT_CORRUPT 0x0008 ///< Output even those frames that might be corrupted
697 #define CODEC_FLAG_QPEL 0x0010 ///< Use qpel MC.
698 #define CODEC_FLAG_GMC 0x0020 ///< Use GMC.
699 #define CODEC_FLAG_MV0 0x0040 ///< Always try a MB with MV=<0,0>.
701 * The parent program guarantees that the input for B-frames containing
702 * streams is not written to for at least s->max_b_frames+1 frames, if
703 * this is not set the input will be copied.
705 #define CODEC_FLAG_INPUT_PRESERVED 0x0100
706 #define CODEC_FLAG_PASS1 0x0200 ///< Use internal 2pass ratecontrol in first pass mode.
707 #define CODEC_FLAG_PASS2 0x0400 ///< Use internal 2pass ratecontrol in second pass mode.
708 #define CODEC_FLAG_GRAY 0x2000 ///< Only decode/encode grayscale.
709 #define CODEC_FLAG_EMU_EDGE 0x4000 ///< Don't draw edges.
710 #define CODEC_FLAG_PSNR 0x8000 ///< error[?] variables will be set during encoding.
711 #define CODEC_FLAG_TRUNCATED 0x00010000 /** Input bitstream might be truncated at a random
712 location instead of only at frame boundaries. */
713 #define CODEC_FLAG_NORMALIZE_AQP 0x00020000 ///< Normalize adaptive quantization.
714 #define CODEC_FLAG_INTERLACED_DCT 0x00040000 ///< Use interlaced DCT.
715 #define CODEC_FLAG_LOW_DELAY 0x00080000 ///< Force low delay.
716 #define CODEC_FLAG_GLOBAL_HEADER 0x00400000 ///< Place global headers in extradata instead of every keyframe.
717 #define CODEC_FLAG_BITEXACT 0x00800000 ///< Use only bitexact stuff (except (I)DCT).
718 /* Fx : Flag for h263+ extra options */
719 #define CODEC_FLAG_AC_PRED 0x01000000 ///< H.263 advanced intra coding / MPEG-4 AC prediction
720 #define CODEC_FLAG_LOOP_FILTER 0x00000800 ///< loop filter
721 #define CODEC_FLAG_INTERLACED_ME 0x20000000 ///< interlaced motion estimation
722 #define CODEC_FLAG_CLOSED_GOP 0x80000000
723 #define CODEC_FLAG2_FAST 0x00000001 ///< Allow non spec compliant speedup tricks.
724 #define CODEC_FLAG2_NO_OUTPUT 0x00000004 ///< Skip bitstream encoding.
725 #define CODEC_FLAG2_LOCAL_HEADER 0x00000008 ///< Place global headers at every keyframe instead of in extradata.
726 #define CODEC_FLAG2_DROP_FRAME_TIMECODE 0x00002000 ///< timecode is in drop frame format. DEPRECATED!!!!
727 #define CODEC_FLAG2_IGNORE_CROP 0x00010000 ///< Discard cropping information from SPS.
729 #define CODEC_FLAG2_CHUNKS 0x00008000 ///< Input bitstream might be truncated at a packet boundaries instead of only at frame boundaries.
730 #define CODEC_FLAG2_SHOW_ALL 0x00400000 ///< Show all frames before the first keyframe
732 /* Unsupported options :
733 * Syntax Arithmetic coding (SAC)
734 * Reference Picture Selection
735 * Independent Segment Decoding */
737 /* codec capabilities */
739 #define CODEC_CAP_DRAW_HORIZ_BAND 0x0001 ///< Decoder can use draw_horiz_band callback.
741 * Codec uses get_buffer() for allocating buffers and supports custom allocators.
742 * If not set, it might not use get_buffer() at all or use operations that
743 * assume the buffer was allocated by avcodec_default_get_buffer.
745 #define CODEC_CAP_DR1 0x0002
746 #define CODEC_CAP_TRUNCATED 0x0008
747 /* Codec can export data for HW decoding (XvMC). */
748 #define CODEC_CAP_HWACCEL 0x0010
750 * Encoder or decoder requires flushing with NULL input at the end in order to
751 * give the complete and correct output.
753 * NOTE: If this flag is not set, the codec is guaranteed to never be fed with
754 * with NULL data. The user can still send NULL data to the public encode
755 * or decode function, but libavcodec will not pass it along to the codec
756 * unless this flag is set.
759 * The decoder has a non-zero delay and needs to be fed with avpkt->data=NULL,
760 * avpkt->size=0 at the end to get the delayed data until the decoder no longer
764 * The encoder needs to be fed with NULL data at the end of encoding until the
765 * encoder no longer returns data.
767 * NOTE: For encoders implementing the AVCodec.encode2() function, setting this
768 * flag also means that the encoder must set the pts and duration for
769 * each output packet. If this flag is not set, the pts and duration will
770 * be determined by libavcodec from the input frame.
772 #define CODEC_CAP_DELAY 0x0020
774 * Codec can be fed a final frame with a smaller size.
775 * This can be used to prevent truncation of the last audio samples.
777 #define CODEC_CAP_SMALL_LAST_FRAME 0x0040
780 * Codec can export data for HW decoding (VDPAU).
782 #define CODEC_CAP_HWACCEL_VDPAU 0x0080
785 * Codec can output multiple frames per AVPacket
786 * Normally demuxers return one frame at a time, demuxers which do not do
787 * are connected to a parser to split what they return into proper frames.
788 * This flag is reserved to the very rare category of codecs which have a
789 * bitstream that cannot be split into frames without timeconsuming
790 * operations like full decoding. Demuxers carring such bitstreams thus
791 * may return multiple frames in a packet. This has many disadvantages like
792 * prohibiting stream copy in many cases thus it should only be considered
795 #define CODEC_CAP_SUBFRAMES 0x0100
797 * Codec is experimental and is thus avoided in favor of non experimental
800 #define CODEC_CAP_EXPERIMENTAL 0x0200
802 * Codec should fill in channel configuration and samplerate instead of container
804 #define CODEC_CAP_CHANNEL_CONF 0x0400
807 * Codec is able to deal with negative linesizes
809 #define CODEC_CAP_NEG_LINESIZES 0x0800
812 * Codec supports frame-level multithreading.
814 #define CODEC_CAP_FRAME_THREADS 0x1000
816 * Codec supports slice-based (or partition-based) multithreading.
818 #define CODEC_CAP_SLICE_THREADS 0x2000
820 * Codec supports changed parameters at any point.
822 #define CODEC_CAP_PARAM_CHANGE 0x4000
824 * Codec supports avctx->thread_count == 0 (auto).
826 #define CODEC_CAP_AUTO_THREADS 0x8000
828 * Audio encoder supports receiving a different number of samples in each call.
830 #define CODEC_CAP_VARIABLE_FRAME_SIZE 0x10000
832 * Codec is intra only.
834 #define CODEC_CAP_INTRA_ONLY 0x40000000
838 #define CODEC_CAP_LOSSLESS 0x80000000
840 //The following defines may change, don't expect compatibility if you use them.
841 #define MB_TYPE_INTRA4x4 0x0001
842 #define MB_TYPE_INTRA16x16 0x0002 //FIXME H.264-specific
843 #define MB_TYPE_INTRA_PCM 0x0004 //FIXME H.264-specific
844 #define MB_TYPE_16x16 0x0008
845 #define MB_TYPE_16x8 0x0010
846 #define MB_TYPE_8x16 0x0020
847 #define MB_TYPE_8x8 0x0040
848 #define MB_TYPE_INTERLACED 0x0080
849 #define MB_TYPE_DIRECT2 0x0100 //FIXME
850 #define MB_TYPE_ACPRED 0x0200
851 #define MB_TYPE_GMC 0x0400
852 #define MB_TYPE_SKIP 0x0800
853 #define MB_TYPE_P0L0 0x1000
854 #define MB_TYPE_P1L0 0x2000
855 #define MB_TYPE_P0L1 0x4000
856 #define MB_TYPE_P1L1 0x8000
857 #define MB_TYPE_L0 (MB_TYPE_P0L0 | MB_TYPE_P1L0)
858 #define MB_TYPE_L1 (MB_TYPE_P0L1 | MB_TYPE_P1L1)
859 #define MB_TYPE_L0L1 (MB_TYPE_L0 | MB_TYPE_L1)
860 #define MB_TYPE_QUANT 0x00010000
861 #define MB_TYPE_CBP 0x00020000
862 //Note bits 24-31 are reserved for codec specific use (h264 ref0, mpeg1 0mv, ...)
866 * This specifies the area which should be displayed.
867 * Note there may be multiple such areas for one frame.
869 typedef struct AVPanScan{
872 * - encoding: Set by user.
873 * - decoding: Set by libavcodec.
878 * width and height in 1/16 pel
879 * - encoding: Set by user.
880 * - decoding: Set by libavcodec.
886 * position of the top left corner in 1/16 pel for up to 3 fields/frames
887 * - encoding: Set by user.
888 * - decoding: Set by libavcodec.
890 int16_t position[3][2];
893 #define FF_QSCALE_TYPE_MPEG1 0
894 #define FF_QSCALE_TYPE_MPEG2 1
895 #define FF_QSCALE_TYPE_H264 2
896 #define FF_QSCALE_TYPE_VP56 3
898 #if FF_API_GET_BUFFER
899 #define FF_BUFFER_TYPE_INTERNAL 1
900 #define FF_BUFFER_TYPE_USER 2 ///< direct rendering buffers (image is (de)allocated by user)
901 #define FF_BUFFER_TYPE_SHARED 4 ///< Buffer from somewhere else; don't deallocate image (data/base), all other tables are not shared.
902 #define FF_BUFFER_TYPE_COPY 8 ///< Just a (modified) copy of some other buffer, don't deallocate anything.
904 #define FF_BUFFER_HINTS_VALID 0x01 // Buffer hints value is meaningful (if 0 ignore).
905 #define FF_BUFFER_HINTS_READABLE 0x02 // Codec will read from buffer.
906 #define FF_BUFFER_HINTS_PRESERVE 0x04 // User must not alter buffer content.
907 #define FF_BUFFER_HINTS_REUSABLE 0x08 // Codec will reuse the buffer (update).
911 * The decoder will keep a reference to the frame and may reuse it later.
913 #define AV_GET_BUFFER_FLAG_REF (1 << 0)
916 * @defgroup lavc_packet AVPacket
918 * Types and functions for working with AVPacket.
921 enum AVPacketSideDataType {
923 AV_PKT_DATA_NEW_EXTRADATA,
926 * An AV_PKT_DATA_PARAM_CHANGE side data packet is laid out as follows:
929 * if (param_flags & AV_SIDE_DATA_PARAM_CHANGE_CHANNEL_COUNT)
930 * s32le channel_count
931 * if (param_flags & AV_SIDE_DATA_PARAM_CHANGE_CHANNEL_LAYOUT)
932 * u64le channel_layout
933 * if (param_flags & AV_SIDE_DATA_PARAM_CHANGE_SAMPLE_RATE)
935 * if (param_flags & AV_SIDE_DATA_PARAM_CHANGE_DIMENSIONS)
940 AV_PKT_DATA_PARAM_CHANGE,
943 * An AV_PKT_DATA_H263_MB_INFO side data packet contains a number of
944 * structures with info about macroblocks relevant to splitting the
945 * packet into smaller packets on macroblock edges (e.g. as for RFC 2190).
946 * That is, it does not necessarily contain info about all macroblocks,
947 * as long as the distance between macroblocks in the info is smaller
948 * than the target payload size.
949 * Each MB info structure is 12 bytes, and is laid out as follows:
951 * u32le bit offset from the start of the packet
952 * u8 current quantizer at the start of the macroblock
954 * u16le macroblock address within the GOB
955 * u8 horizontal MV predictor
956 * u8 vertical MV predictor
957 * u8 horizontal MV predictor for block number 3
958 * u8 vertical MV predictor for block number 3
961 AV_PKT_DATA_H263_MB_INFO,
964 * Recommmends skipping the specified number of samples
966 * u32le number of samples to skip from start of this packet
967 * u32le number of samples to skip from end of this packet
968 * u8 reason for start skip
969 * u8 reason for end skip (0=padding silence, 1=convergence)
972 AV_PKT_DATA_SKIP_SAMPLES=70,
975 * An AV_PKT_DATA_JP_DUALMONO side data packet indicates that
976 * the packet may contain "dual mono" audio specific to Japanese DTV
977 * and if it is true, recommends only the selected channel to be used.
979 * u8 selected channels (0=mail/left, 1=sub/right, 2=both)
982 AV_PKT_DATA_JP_DUALMONO,
985 * A list of zero terminated key/value strings. There is no end marker for
986 * the list, so it is required to rely on the side data size to stop.
988 AV_PKT_DATA_STRINGS_METADATA,
991 * Subtitle event position
999 AV_PKT_DATA_SUBTITLE_POSITION,
1002 * Data found in BlockAdditional element of matroska container. There is
1003 * no end marker for the data, so it is required to rely on the side data
1004 * size to recognize the end. 8 byte id (as found in BlockAddId) followed
1007 AV_PKT_DATA_MATROSKA_BLOCKADDITIONAL,
1010 * The optional first identifier line of a WebVTT cue.
1012 AV_PKT_DATA_WEBVTT_IDENTIFIER,
1015 * The optional settings (rendering instructions) that immediately
1016 * follow the timestamp specifier of a WebVTT cue.
1018 AV_PKT_DATA_WEBVTT_SETTINGS,
1022 * This structure stores compressed data. It is typically exported by demuxers
1023 * and then passed as input to decoders, or received as output from encoders and
1024 * then passed to muxers.
1026 * For video, it should typically contain one compressed frame. For audio it may
1027 * contain several compressed frames.
1029 * AVPacket is one of the few structs in FFmpeg, whose size is a part of public
1030 * ABI. Thus it may be allocated on stack and no new fields can be added to it
1031 * without libavcodec and libavformat major bump.
1033 * The semantics of data ownership depends on the buf or destruct (deprecated)
1034 * fields. If either is set, the packet data is dynamically allocated and is
1035 * valid indefinitely until av_free_packet() is called (which in turn calls
1036 * av_buffer_unref()/the destruct callback to free the data). If neither is set,
1037 * the packet data is typically backed by some static buffer somewhere and is
1038 * only valid for a limited time (e.g. until the next read call when demuxing).
1040 * The side data is always allocated with av_malloc() and is freed in
1043 typedef struct AVPacket {
1045 * A reference to the reference-counted buffer where the packet data is
1047 * May be NULL, then the packet data is not reference-counted.
1051 * Presentation timestamp in AVStream->time_base units; the time at which
1052 * the decompressed packet will be presented to the user.
1053 * Can be AV_NOPTS_VALUE if it is not stored in the file.
1054 * pts MUST be larger or equal to dts as presentation cannot happen before
1055 * decompression, unless one wants to view hex dumps. Some formats misuse
1056 * the terms dts and pts/cts to mean something different. Such timestamps
1057 * must be converted to true pts/dts before they are stored in AVPacket.
1061 * Decompression timestamp in AVStream->time_base units; the time at which
1062 * the packet is decompressed.
1063 * Can be AV_NOPTS_VALUE if it is not stored in the file.
1070 * A combination of AV_PKT_FLAG values
1074 * Additional packet data that can be provided by the container.
1075 * Packet can contain several types of side information.
1080 enum AVPacketSideDataType type;
1082 int side_data_elems;
1085 * Duration of this packet in AVStream->time_base units, 0 if unknown.
1086 * Equals next_pts - this_pts in presentation order.
1089 #if FF_API_DESTRUCT_PACKET
1090 attribute_deprecated
1091 void (*destruct)(struct AVPacket *);
1092 attribute_deprecated
1095 int64_t pos; ///< byte position in stream, -1 if unknown
1098 * Time difference in AVStream->time_base units from the pts of this
1099 * packet to the point at which the output from the decoder has converged
1100 * independent from the availability of previous frames. That is, the
1101 * frames are virtually identical no matter if decoding started from
1102 * the very first frame or from this keyframe.
1103 * Is AV_NOPTS_VALUE if unknown.
1104 * This field is not the display duration of the current packet.
1105 * This field has no meaning if the packet does not have AV_PKT_FLAG_KEY
1108 * The purpose of this field is to allow seeking in streams that have no
1109 * keyframes in the conventional sense. It corresponds to the
1110 * recovery point SEI in H.264 and match_time_delta in NUT. It is also
1111 * essential for some types of subtitle streams to ensure that all
1112 * subtitles are correctly displayed after seeking.
1114 int64_t convergence_duration;
1116 #define AV_PKT_FLAG_KEY 0x0001 ///< The packet contains a keyframe
1117 #define AV_PKT_FLAG_CORRUPT 0x0002 ///< The packet content is corrupted
1119 enum AVSideDataParamChangeFlags {
1120 AV_SIDE_DATA_PARAM_CHANGE_CHANNEL_COUNT = 0x0001,
1121 AV_SIDE_DATA_PARAM_CHANGE_CHANNEL_LAYOUT = 0x0002,
1122 AV_SIDE_DATA_PARAM_CHANGE_SAMPLE_RATE = 0x0004,
1123 AV_SIDE_DATA_PARAM_CHANGE_DIMENSIONS = 0x0008,
1129 struct AVCodecInternal;
1133 AV_FIELD_PROGRESSIVE,
1134 AV_FIELD_TT, //< Top coded_first, top displayed first
1135 AV_FIELD_BB, //< Bottom coded first, bottom displayed first
1136 AV_FIELD_TB, //< Top coded first, bottom displayed first
1137 AV_FIELD_BT, //< Bottom coded first, top displayed first
1141 * main external API structure.
1142 * New fields can be added to the end with minor version bumps.
1143 * Removal, reordering and changes to existing fields require a major
1145 * Please use AVOptions (av_opt* / av_set/get*()) to access these fields from user
1147 * sizeof(AVCodecContext) must not be used outside libav*.
1149 typedef struct AVCodecContext {
1151 * information on struct for av_log
1152 * - set by avcodec_alloc_context3
1154 const AVClass *av_class;
1155 int log_level_offset;
1157 enum AVMediaType codec_type; /* see AVMEDIA_TYPE_xxx */
1158 const struct AVCodec *codec;
1159 char codec_name[32];
1160 enum AVCodecID codec_id; /* see AV_CODEC_ID_xxx */
1163 * fourcc (LSB first, so "ABCD" -> ('D'<<24) + ('C'<<16) + ('B'<<8) + 'A').
1164 * This is used to work around some encoder bugs.
1165 * A demuxer should set this to what is stored in the field used to identify the codec.
1166 * If there are multiple such fields in a container then the demuxer should choose the one
1167 * which maximizes the information about the used codec.
1168 * If the codec tag field in a container is larger than 32 bits then the demuxer should
1169 * remap the longer ID to 32 bits with a table or other structure. Alternatively a new
1170 * extra_codec_tag + size could be added but for this a clear advantage must be demonstrated
1172 * - encoding: Set by user, if not then the default based on codec_id will be used.
1173 * - decoding: Set by user, will be converted to uppercase by libavcodec during init.
1175 unsigned int codec_tag;
1178 * fourcc from the AVI stream header (LSB first, so "ABCD" -> ('D'<<24) + ('C'<<16) + ('B'<<8) + 'A').
1179 * This is used to work around some encoder bugs.
1180 * - encoding: unused
1181 * - decoding: Set by user, will be converted to uppercase by libavcodec during init.
1183 unsigned int stream_codec_tag;
1188 * Private context used for internal data.
1190 * Unlike priv_data, this is not codec-specific. It is used in general
1191 * libavcodec functions.
1193 struct AVCodecInternal *internal;
1196 * Private data of the user, can be used to carry app specific stuff.
1197 * - encoding: Set by user.
1198 * - decoding: Set by user.
1203 * the average bitrate
1204 * - encoding: Set by user; unused for constant quantizer encoding.
1205 * - decoding: Set by libavcodec. 0 or some bitrate if this info is available in the stream.
1210 * number of bits the bitstream is allowed to diverge from the reference.
1211 * the reference can be CBR (for CBR pass1) or VBR (for pass2)
1212 * - encoding: Set by user; unused for constant quantizer encoding.
1213 * - decoding: unused
1215 int bit_rate_tolerance;
1218 * Global quality for codecs which cannot change it per frame.
1219 * This should be proportional to MPEG-1/2/4 qscale.
1220 * - encoding: Set by user.
1221 * - decoding: unused
1226 * - encoding: Set by user.
1227 * - decoding: unused
1229 int compression_level;
1230 #define FF_COMPRESSION_DEFAULT -1
1234 * - encoding: Set by user.
1235 * - decoding: Set by user.
1241 * - encoding: Set by user.
1242 * - decoding: Set by user.
1247 * some codecs need / can use extradata like Huffman tables.
1248 * mjpeg: Huffman tables
1249 * rv10: additional flags
1250 * mpeg4: global headers (they can be in the bitstream or here)
1251 * The allocated memory should be FF_INPUT_BUFFER_PADDING_SIZE bytes larger
1252 * than extradata_size to avoid problems if it is read with the bitstream reader.
1253 * The bytewise contents of extradata must not depend on the architecture or CPU endianness.
1254 * - encoding: Set/allocated/freed by libavcodec.
1255 * - decoding: Set/allocated/freed by user.
1261 * This is the fundamental unit of time (in seconds) in terms
1262 * of which frame timestamps are represented. For fixed-fps content,
1263 * timebase should be 1/framerate and timestamp increments should be
1265 * - encoding: MUST be set by user.
1266 * - decoding: Set by libavcodec.
1268 AVRational time_base;
1271 * For some codecs, the time base is closer to the field rate than the frame rate.
1272 * Most notably, H.264 and MPEG-2 specify time_base as half of frame duration
1273 * if no telecine is used ...
1275 * Set to time_base ticks per frame. Default 1, e.g., H.264/MPEG-2 set it to 2.
1277 int ticks_per_frame;
1282 * Encoding: Number of frames delay there will be from the encoder input to
1283 * the decoder output. (we assume the decoder matches the spec)
1284 * Decoding: Number of frames delay in addition to what a standard decoder
1285 * as specified in the spec would produce.
1288 * Number of frames the decoded output will be delayed relative to the
1292 * For encoding, this is the number of "priming" samples added to the
1293 * beginning of the stream. The decoded output will be delayed by this
1294 * many samples relative to the input to the encoder. Note that this
1295 * field is purely informational and does not directly affect the pts
1296 * output by the encoder, which should always be based on the actual
1297 * presentation time, including any delay.
1298 * For decoding, this is the number of samples the decoder needs to
1299 * output before the decoder's output is valid. When seeking, you should
1300 * start decoding this many samples prior to your desired seek point.
1302 * - encoding: Set by libavcodec.
1303 * - decoding: Set by libavcodec.
1310 * picture width / height.
1311 * - encoding: MUST be set by user.
1312 * - decoding: May be set by the user before opening the decoder if known e.g.
1313 * from the container. Some decoders will require the dimensions
1314 * to be set by the caller. During decoding, the decoder may
1315 * overwrite those values as required.
1320 * Bitstream width / height, may be different from width/height e.g. when
1321 * the decoded frame is cropped before being output or lowres is enabled.
1322 * - encoding: unused
1323 * - decoding: May be set by the user before opening the decoder if known
1324 * e.g. from the container. During decoding, the decoder may
1325 * overwrite those values as required.
1327 int coded_width, coded_height;
1329 #if FF_API_ASPECT_EXTENDED
1330 #define FF_ASPECT_EXTENDED 15
1334 * the number of pictures in a group of pictures, or 0 for intra_only
1335 * - encoding: Set by user.
1336 * - decoding: unused
1341 * Pixel format, see AV_PIX_FMT_xxx.
1342 * May be set by the demuxer if known from headers.
1343 * May be overridden by the decoder if it knows better.
1344 * - encoding: Set by user.
1345 * - decoding: Set by user if known, overridden by libavcodec if known
1347 enum AVPixelFormat pix_fmt;
1350 * Motion estimation algorithm used for video coding.
1351 * 1 (zero), 2 (full), 3 (log), 4 (phods), 5 (epzs), 6 (x1), 7 (hex),
1352 * 8 (umh), 9 (iter), 10 (tesa) [7, 8, 10 are x264 specific, 9 is snow specific]
1353 * - encoding: MUST be set by user.
1354 * - decoding: unused
1359 * If non NULL, 'draw_horiz_band' is called by the libavcodec
1360 * decoder to draw a horizontal band. It improves cache usage. Not
1361 * all codecs can do that. You must check the codec capabilities
1363 * When multithreading is used, it may be called from multiple threads
1364 * at the same time; threads might draw different parts of the same AVFrame,
1365 * or multiple AVFrames, and there is no guarantee that slices will be drawn
1367 * The function is also used by hardware acceleration APIs.
1368 * It is called at least once during frame decoding to pass
1369 * the data needed for hardware render.
1370 * In that mode instead of pixel data, AVFrame points to
1371 * a structure specific to the acceleration API. The application
1372 * reads the structure and can change some fields to indicate progress
1374 * - encoding: unused
1375 * - decoding: Set by user.
1376 * @param height the height of the slice
1377 * @param y the y position of the slice
1378 * @param type 1->top field, 2->bottom field, 3->frame
1379 * @param offset offset into the AVFrame.data from which the slice should be read
1381 void (*draw_horiz_band)(struct AVCodecContext *s,
1382 const AVFrame *src, int offset[AV_NUM_DATA_POINTERS],
1383 int y, int type, int height);
1386 * callback to negotiate the pixelFormat
1387 * @param fmt is the list of formats which are supported by the codec,
1388 * it is terminated by -1 as 0 is a valid format, the formats are ordered by quality.
1389 * The first is always the native one.
1390 * @return the chosen format
1391 * - encoding: unused
1392 * - decoding: Set by user, if not set the native format will be chosen.
1394 enum AVPixelFormat (*get_format)(struct AVCodecContext *s, const enum AVPixelFormat * fmt);
1397 * maximum number of B-frames between non-B-frames
1398 * Note: The output will be delayed by max_b_frames+1 relative to the input.
1399 * - encoding: Set by user.
1400 * - decoding: unused
1405 * qscale factor between IP and B-frames
1406 * If > 0 then the last P-frame quantizer will be used (q= lastp_q*factor+offset).
1407 * If < 0 then normal ratecontrol will be done (q= -normal_q*factor+offset).
1408 * - encoding: Set by user.
1409 * - decoding: unused
1411 float b_quant_factor;
1413 /** obsolete FIXME remove */
1415 #define FF_RC_STRATEGY_XVID 1
1417 int b_frame_strategy;
1420 * qscale offset between IP and B-frames
1421 * - encoding: Set by user.
1422 * - decoding: unused
1424 float b_quant_offset;
1427 * Size of the frame reordering buffer in the decoder.
1428 * For MPEG-2 it is 1 IPB or 0 low delay IP.
1429 * - encoding: Set by libavcodec.
1430 * - decoding: Set by libavcodec.
1435 * 0-> h263 quant 1-> mpeg quant
1436 * - encoding: Set by user.
1437 * - decoding: unused
1442 * qscale factor between P and I-frames
1443 * If > 0 then the last p frame quantizer will be used (q= lastp_q*factor+offset).
1444 * If < 0 then normal ratecontrol will be done (q= -normal_q*factor+offset).
1445 * - encoding: Set by user.
1446 * - decoding: unused
1448 float i_quant_factor;
1451 * qscale offset between P and I-frames
1452 * - encoding: Set by user.
1453 * - decoding: unused
1455 float i_quant_offset;
1458 * luminance masking (0-> disabled)
1459 * - encoding: Set by user.
1460 * - decoding: unused
1465 * temporary complexity masking (0-> disabled)
1466 * - encoding: Set by user.
1467 * - decoding: unused
1469 float temporal_cplx_masking;
1472 * spatial complexity masking (0-> disabled)
1473 * - encoding: Set by user.
1474 * - decoding: unused
1476 float spatial_cplx_masking;
1479 * p block masking (0-> disabled)
1480 * - encoding: Set by user.
1481 * - decoding: unused
1486 * darkness masking (0-> disabled)
1487 * - encoding: Set by user.
1488 * - decoding: unused
1494 * - encoding: Set by libavcodec.
1495 * - decoding: Set by user (or 0).
1499 * prediction method (needed for huffyuv)
1500 * - encoding: Set by user.
1501 * - decoding: unused
1503 int prediction_method;
1504 #define FF_PRED_LEFT 0
1505 #define FF_PRED_PLANE 1
1506 #define FF_PRED_MEDIAN 2
1509 * slice offsets in the frame in bytes
1510 * - encoding: Set/allocated by libavcodec.
1511 * - decoding: Set/allocated by user (or NULL).
1516 * sample aspect ratio (0 if unknown)
1517 * That is the width of a pixel divided by the height of the pixel.
1518 * Numerator and denominator must be relatively prime and smaller than 256 for some video standards.
1519 * - encoding: Set by user.
1520 * - decoding: Set by libavcodec.
1522 AVRational sample_aspect_ratio;
1525 * motion estimation comparison function
1526 * - encoding: Set by user.
1527 * - decoding: unused
1531 * subpixel motion estimation comparison function
1532 * - encoding: Set by user.
1533 * - decoding: unused
1537 * macroblock comparison function (not supported yet)
1538 * - encoding: Set by user.
1539 * - decoding: unused
1543 * interlaced DCT comparison function
1544 * - encoding: Set by user.
1545 * - decoding: unused
1548 #define FF_CMP_SAD 0
1549 #define FF_CMP_SSE 1
1550 #define FF_CMP_SATD 2
1551 #define FF_CMP_DCT 3
1552 #define FF_CMP_PSNR 4
1553 #define FF_CMP_BIT 5
1555 #define FF_CMP_ZERO 7
1556 #define FF_CMP_VSAD 8
1557 #define FF_CMP_VSSE 9
1558 #define FF_CMP_NSSE 10
1559 #define FF_CMP_W53 11
1560 #define FF_CMP_W97 12
1561 #define FF_CMP_DCTMAX 13
1562 #define FF_CMP_DCT264 14
1563 #define FF_CMP_CHROMA 256
1566 * ME diamond size & shape
1567 * - encoding: Set by user.
1568 * - decoding: unused
1573 * amount of previous MV predictors (2a+1 x 2a+1 square)
1574 * - encoding: Set by user.
1575 * - decoding: unused
1577 int last_predictor_count;
1580 * prepass for motion estimation
1581 * - encoding: Set by user.
1582 * - decoding: unused
1587 * motion estimation prepass comparison function
1588 * - encoding: Set by user.
1589 * - decoding: unused
1594 * ME prepass diamond size & shape
1595 * - encoding: Set by user.
1596 * - decoding: unused
1602 * - encoding: Set by user.
1603 * - decoding: unused
1605 int me_subpel_quality;
1608 * DTG active format information (additional aspect ratio
1609 * information only used in DVB MPEG-2 transport streams)
1612 * - encoding: unused
1613 * - decoding: Set by decoder.
1615 int dtg_active_format;
1616 #define FF_DTG_AFD_SAME 8
1617 #define FF_DTG_AFD_4_3 9
1618 #define FF_DTG_AFD_16_9 10
1619 #define FF_DTG_AFD_14_9 11
1620 #define FF_DTG_AFD_4_3_SP_14_9 13
1621 #define FF_DTG_AFD_16_9_SP_14_9 14
1622 #define FF_DTG_AFD_SP_4_3 15
1625 * maximum motion estimation search range in subpel units
1626 * If 0 then no limit.
1628 * - encoding: Set by user.
1629 * - decoding: unused
1634 * intra quantizer bias
1635 * - encoding: Set by user.
1636 * - decoding: unused
1638 int intra_quant_bias;
1639 #define FF_DEFAULT_QUANT_BIAS 999999
1642 * inter quantizer bias
1643 * - encoding: Set by user.
1644 * - decoding: unused
1646 int inter_quant_bias;
1650 * - encoding: unused
1651 * - decoding: Set by user.
1654 #define SLICE_FLAG_CODED_ORDER 0x0001 ///< draw_horiz_band() is called in coded order instead of display
1655 #define SLICE_FLAG_ALLOW_FIELD 0x0002 ///< allow draw_horiz_band() with field slices (MPEG2 field pics)
1656 #define SLICE_FLAG_ALLOW_PLANE 0x0004 ///< allow draw_horiz_band() with 1 component at a time (SVQ1)
1659 * XVideo Motion Acceleration
1660 * - encoding: forbidden
1661 * - decoding: set by decoder
1663 int xvmc_acceleration;
1666 * macroblock decision mode
1667 * - encoding: Set by user.
1668 * - decoding: unused
1671 #define FF_MB_DECISION_SIMPLE 0 ///< uses mb_cmp
1672 #define FF_MB_DECISION_BITS 1 ///< chooses the one which needs the fewest bits
1673 #define FF_MB_DECISION_RD 2 ///< rate distortion
1676 * custom intra quantization matrix
1677 * - encoding: Set by user, can be NULL.
1678 * - decoding: Set by libavcodec.
1680 uint16_t *intra_matrix;
1683 * custom inter quantization matrix
1684 * - encoding: Set by user, can be NULL.
1685 * - decoding: Set by libavcodec.
1687 uint16_t *inter_matrix;
1690 * scene change detection threshold
1691 * 0 is default, larger means fewer detected scene changes.
1692 * - encoding: Set by user.
1693 * - decoding: unused
1695 int scenechange_threshold;
1698 * noise reduction strength
1699 * - encoding: Set by user.
1700 * - decoding: unused
1702 int noise_reduction;
1705 * Motion estimation threshold below which no motion estimation is
1706 * performed, but instead the user specified motion vectors are used.
1708 * - encoding: Set by user.
1709 * - decoding: unused
1714 * Macroblock threshold below which the user specified macroblock types will be used.
1715 * - encoding: Set by user.
1716 * - decoding: unused
1721 * precision of the intra DC coefficient - 8
1722 * - encoding: Set by user.
1723 * - decoding: unused
1725 int intra_dc_precision;
1728 * Number of macroblock rows at the top which are skipped.
1729 * - encoding: unused
1730 * - decoding: Set by user.
1735 * Number of macroblock rows at the bottom which are skipped.
1736 * - encoding: unused
1737 * - decoding: Set by user.
1742 * Border processing masking, raises the quantizer for mbs on the borders
1744 * - encoding: Set by user.
1745 * - decoding: unused
1747 float border_masking;
1750 * minimum MB lagrange multipler
1751 * - encoding: Set by user.
1752 * - decoding: unused
1757 * maximum MB lagrange multipler
1758 * - encoding: Set by user.
1759 * - decoding: unused
1765 * - encoding: Set by user.
1766 * - decoding: unused
1768 int me_penalty_compensation;
1772 * - encoding: Set by user.
1773 * - decoding: unused
1779 * - encoding: Set by user.
1780 * - decoding: unused
1786 * - encoding: Set by user.
1787 * - decoding: unused
1792 * number of reference frames
1793 * - encoding: Set by user.
1794 * - decoding: Set by lavc.
1799 * chroma qp offset from luma
1800 * - encoding: Set by user.
1801 * - decoding: unused
1806 * Multiplied by qscale for each frame and added to scene_change_score.
1807 * - encoding: Set by user.
1808 * - decoding: unused
1810 int scenechange_factor;
1814 * Note: Value depends upon the compare function used for fullpel ME.
1815 * - encoding: Set by user.
1816 * - decoding: unused
1821 * Adjust sensitivity of b_frame_strategy 1.
1822 * - encoding: Set by user.
1823 * - decoding: unused
1828 * Chromaticity coordinates of the source primaries.
1829 * - encoding: Set by user
1830 * - decoding: Set by libavcodec
1832 enum AVColorPrimaries color_primaries;
1835 * Color Transfer Characteristic.
1836 * - encoding: Set by user
1837 * - decoding: Set by libavcodec
1839 enum AVColorTransferCharacteristic color_trc;
1842 * YUV colorspace type.
1843 * - encoding: Set by user
1844 * - decoding: Set by libavcodec
1846 enum AVColorSpace colorspace;
1849 * MPEG vs JPEG YUV range.
1850 * - encoding: Set by user
1851 * - decoding: Set by libavcodec
1853 enum AVColorRange color_range;
1856 * This defines the location of chroma samples.
1857 * - encoding: Set by user
1858 * - decoding: Set by libavcodec
1860 enum AVChromaLocation chroma_sample_location;
1864 * Indicates number of picture subdivisions. Used for parallelized
1866 * - encoding: Set by user
1867 * - decoding: unused
1872 * - encoding: set by libavcodec
1873 * - decoding: Set by user.
1875 enum AVFieldOrder field_order;
1878 int sample_rate; ///< samples per second
1879 int channels; ///< number of audio channels
1882 * audio sample format
1883 * - encoding: Set by user.
1884 * - decoding: Set by libavcodec.
1886 enum AVSampleFormat sample_fmt; ///< sample format
1888 /* The following data should not be initialized. */
1890 * Number of samples per channel in an audio frame.
1892 * - encoding: set by libavcodec in avcodec_open2(). Each submitted frame
1893 * except the last must contain exactly frame_size samples per channel.
1894 * May be 0 when the codec has CODEC_CAP_VARIABLE_FRAME_SIZE set, then the
1895 * frame size is not restricted.
1896 * - decoding: may be set by some decoders to indicate constant frame size
1901 * Frame counter, set by libavcodec.
1903 * - decoding: total number of frames returned from the decoder so far.
1904 * - encoding: total number of frames passed to the encoder so far.
1906 * @note the counter is not incremented if encoding/decoding resulted in
1912 * number of bytes per packet if constant and known or 0
1913 * Used by some WAV based audio codecs.
1918 * Audio cutoff bandwidth (0 means "automatic")
1919 * - encoding: Set by user.
1920 * - decoding: unused
1924 #if FF_API_REQUEST_CHANNELS
1926 * Decoder should decode to this many channels if it can (0 for default)
1927 * - encoding: unused
1928 * - decoding: Set by user.
1929 * @deprecated Deprecated in favor of request_channel_layout.
1931 attribute_deprecated int request_channels;
1935 * Audio channel layout.
1936 * - encoding: set by user.
1937 * - decoding: set by user, may be overwritten by libavcodec.
1939 uint64_t channel_layout;
1942 * Request decoder to use this channel layout if it can (0 for default)
1943 * - encoding: unused
1944 * - decoding: Set by user.
1946 uint64_t request_channel_layout;
1949 * Type of service that the audio stream conveys.
1950 * - encoding: Set by user.
1951 * - decoding: Set by libavcodec.
1953 enum AVAudioServiceType audio_service_type;
1956 * desired sample format
1957 * - encoding: Not used.
1958 * - decoding: Set by user.
1959 * Decoder will decode to this format if it can.
1961 enum AVSampleFormat request_sample_fmt;
1963 #if FF_API_GET_BUFFER
1965 * Called at the beginning of each frame to get a buffer for it.
1967 * The function will set AVFrame.data[], AVFrame.linesize[].
1968 * AVFrame.extended_data[] must also be set, but it should be the same as
1969 * AVFrame.data[] except for planar audio with more channels than can fit
1970 * in AVFrame.data[]. In that case, AVFrame.data[] shall still contain as
1971 * many data pointers as it can hold.
1973 * if CODEC_CAP_DR1 is not set then get_buffer() must call
1974 * avcodec_default_get_buffer() instead of providing buffers allocated by
1977 * AVFrame.data[] should be 32- or 16-byte-aligned unless the CPU doesn't
1978 * need it. avcodec_default_get_buffer() aligns the output buffer properly,
1979 * but if get_buffer() is overridden then alignment considerations should
1980 * be taken into account.
1982 * @see avcodec_default_get_buffer()
1986 * If pic.reference is set then the frame will be read later by libavcodec.
1987 * avcodec_align_dimensions2() should be used to find the required width and
1988 * height, as they normally need to be rounded up to the next multiple of 16.
1990 * If frame multithreading is used and thread_safe_callbacks is set,
1991 * it may be called from a different thread, but not from more than one at
1992 * once. Does not need to be reentrant.
1994 * @see release_buffer(), reget_buffer()
1995 * @see avcodec_align_dimensions2()
1999 * Decoders request a buffer of a particular size by setting
2000 * AVFrame.nb_samples prior to calling get_buffer(). The decoder may,
2001 * however, utilize only part of the buffer by setting AVFrame.nb_samples
2002 * to a smaller value in the output frame.
2004 * Decoders cannot use the buffer after returning from
2005 * avcodec_decode_audio4(), so they will not call release_buffer(), as it
2006 * is assumed to be released immediately upon return. In some rare cases,
2007 * a decoder may need to call get_buffer() more than once in a single
2008 * call to avcodec_decode_audio4(). In that case, when get_buffer() is
2009 * called again after it has already been called once, the previously
2010 * acquired buffer is assumed to be released at that time and may not be
2011 * reused by the decoder.
2013 * As a convenience, av_samples_get_buffer_size() and
2014 * av_samples_fill_arrays() in libavutil may be used by custom get_buffer()
2015 * functions to find the required data size and to fill data pointers and
2016 * linesize. In AVFrame.linesize, only linesize[0] may be set for audio
2017 * since all planes must be the same size.
2019 * @see av_samples_get_buffer_size(), av_samples_fill_arrays()
2021 * - encoding: unused
2022 * - decoding: Set by libavcodec, user can override.
2024 * @deprecated use get_buffer2()
2026 attribute_deprecated
2027 int (*get_buffer)(struct AVCodecContext *c, AVFrame *pic);
2030 * Called to release buffers which were allocated with get_buffer.
2031 * A released buffer can be reused in get_buffer().
2032 * pic.data[*] must be set to NULL.
2033 * May be called from a different thread if frame multithreading is used,
2034 * but not by more than one thread at once, so does not need to be reentrant.
2035 * - encoding: unused
2036 * - decoding: Set by libavcodec, user can override.
2038 * @deprecated custom freeing callbacks should be set from get_buffer2()
2040 attribute_deprecated
2041 void (*release_buffer)(struct AVCodecContext *c, AVFrame *pic);
2044 * Called at the beginning of a frame to get cr buffer for it.
2045 * Buffer type (size, hints) must be the same. libavcodec won't check it.
2046 * libavcodec will pass previous buffer in pic, function should return
2047 * same buffer or new buffer with old frame "painted" into it.
2048 * If pic.data[0] == NULL must behave like get_buffer().
2049 * if CODEC_CAP_DR1 is not set then reget_buffer() must call
2050 * avcodec_default_reget_buffer() instead of providing buffers allocated by
2052 * - encoding: unused
2053 * - decoding: Set by libavcodec, user can override.
2055 attribute_deprecated
2056 int (*reget_buffer)(struct AVCodecContext *c, AVFrame *pic);
2060 * This callback is called at the beginning of each frame to get data
2061 * buffer(s) for it. There may be one contiguous buffer for all the data or
2062 * there may be a buffer per each data plane or anything in between. What
2063 * this means is, you may set however many entries in buf[] you feel necessary.
2064 * Each buffer must be reference-counted using the AVBuffer API (see description
2067 * The following fields will be set in the frame before this callback is
2070 * - width, height (video only)
2071 * - sample_rate, channel_layout, nb_samples (audio only)
2072 * Their values may differ from the corresponding values in
2073 * AVCodecContext. This callback must use the frame values, not the codec
2074 * context values, to calculate the required buffer size.
2076 * This callback must fill the following fields in the frame:
2080 * * if the data is planar audio with more than 8 channels, then this
2081 * callback must allocate and fill extended_data to contain all pointers
2082 * to all data planes. data[] must hold as many pointers as it can.
2083 * extended_data must be allocated with av_malloc() and will be freed in
2085 * * otherwise exended_data must point to data
2086 * - buf[] must contain one or more pointers to AVBufferRef structures. Each of
2087 * the frame's data and extended_data pointers must be contained in these. That
2088 * is, one AVBufferRef for each allocated chunk of memory, not necessarily one
2089 * AVBufferRef per data[] entry. See: av_buffer_create(), av_buffer_alloc(),
2090 * and av_buffer_ref().
2091 * - extended_buf and nb_extended_buf must be allocated with av_malloc() by
2092 * this callback and filled with the extra buffers if there are more
2093 * buffers than buf[] can hold. extended_buf will be freed in
2096 * If CODEC_CAP_DR1 is not set then get_buffer2() must call
2097 * avcodec_default_get_buffer2() instead of providing buffers allocated by
2100 * Each data plane must be aligned to the maximum required by the target
2103 * @see avcodec_default_get_buffer2()
2107 * If AV_GET_BUFFER_FLAG_REF is set in flags then the frame may be reused
2108 * (read and/or written to if it is writable) later by libavcodec.
2110 * If CODEC_FLAG_EMU_EDGE is not set in s->flags, the buffer must contain an
2111 * edge of the size returned by avcodec_get_edge_width() on all sides.
2113 * avcodec_align_dimensions2() should be used to find the required width and
2114 * height, as they normally need to be rounded up to the next multiple of 16.
2116 * If frame multithreading is used and thread_safe_callbacks is set,
2117 * this callback may be called from a different thread, but not from more
2118 * than one at once. Does not need to be reentrant.
2120 * @see avcodec_align_dimensions2()
2124 * Decoders request a buffer of a particular size by setting
2125 * AVFrame.nb_samples prior to calling get_buffer2(). The decoder may,
2126 * however, utilize only part of the buffer by setting AVFrame.nb_samples
2127 * to a smaller value in the output frame.
2129 * As a convenience, av_samples_get_buffer_size() and
2130 * av_samples_fill_arrays() in libavutil may be used by custom get_buffer2()
2131 * functions to find the required data size and to fill data pointers and
2132 * linesize. In AVFrame.linesize, only linesize[0] may be set for audio
2133 * since all planes must be the same size.
2135 * @see av_samples_get_buffer_size(), av_samples_fill_arrays()
2137 * - encoding: unused
2138 * - decoding: Set by libavcodec, user can override.
2140 int (*get_buffer2)(struct AVCodecContext *s, AVFrame *frame, int flags);
2143 * If non-zero, the decoded audio and video frames returned from
2144 * avcodec_decode_video2() and avcodec_decode_audio4() are reference-counted
2145 * and are valid indefinitely. The caller must free them with
2146 * av_frame_unref() when they are not needed anymore.
2147 * Otherwise, the decoded frames must not be freed by the caller and are
2148 * only valid until the next decode call.
2150 * - encoding: unused
2151 * - decoding: set by the caller before avcodec_open2().
2153 int refcounted_frames;
2155 /* - encoding parameters */
2156 float qcompress; ///< amount of qscale change between easy & hard scenes (0.0-1.0)
2157 float qblur; ///< amount of qscale smoothing over time (0.0-1.0)
2161 * - encoding: Set by user.
2162 * - decoding: unused
2168 * - encoding: Set by user.
2169 * - decoding: unused
2174 * maximum quantizer difference between frames
2175 * - encoding: Set by user.
2176 * - decoding: unused
2181 * ratecontrol qmin qmax limiting method
2182 * 0-> clipping, 1-> use a nice continuous function to limit qscale wthin qmin/qmax.
2183 * - encoding: Set by user.
2184 * - decoding: unused
2192 * decoder bitstream buffer size
2193 * - encoding: Set by user.
2194 * - decoding: unused
2199 * ratecontrol override, see RcOverride
2200 * - encoding: Allocated/set/freed by user.
2201 * - decoding: unused
2203 int rc_override_count;
2204 RcOverride *rc_override;
2207 * rate control equation
2208 * - encoding: Set by user
2209 * - decoding: unused
2215 * - encoding: Set by user.
2216 * - decoding: unused
2222 * - encoding: Set by user.
2223 * - decoding: unused
2227 float rc_buffer_aggressivity;
2230 * initial complexity for pass1 ratecontrol
2231 * - encoding: Set by user.
2232 * - decoding: unused
2234 float rc_initial_cplx;
2237 * Ratecontrol attempt to use, at maximum, <value> of what can be used without an underflow.
2238 * - encoding: Set by user.
2239 * - decoding: unused.
2241 float rc_max_available_vbv_use;
2244 * Ratecontrol attempt to use, at least, <value> times the amount needed to prevent a vbv overflow.
2245 * - encoding: Set by user.
2246 * - decoding: unused.
2248 float rc_min_vbv_overflow_use;
2251 * Number of bits which should be loaded into the rc buffer before decoding starts.
2252 * - encoding: Set by user.
2253 * - decoding: unused
2255 int rc_initial_buffer_occupancy;
2257 #define FF_CODER_TYPE_VLC 0
2258 #define FF_CODER_TYPE_AC 1
2259 #define FF_CODER_TYPE_RAW 2
2260 #define FF_CODER_TYPE_RLE 3
2261 #define FF_CODER_TYPE_DEFLATE 4
2264 * - encoding: Set by user.
2265 * - decoding: unused
2271 * - encoding: Set by user.
2272 * - decoding: unused
2277 * minimum Lagrange multipler
2278 * - encoding: Set by user.
2279 * - decoding: unused
2284 * maximum Lagrange multipler
2285 * - encoding: Set by user.
2286 * - decoding: unused
2291 * frame skip threshold
2292 * - encoding: Set by user.
2293 * - decoding: unused
2295 int frame_skip_threshold;
2299 * - encoding: Set by user.
2300 * - decoding: unused
2302 int frame_skip_factor;
2305 * frame skip exponent
2306 * - encoding: Set by user.
2307 * - decoding: unused
2312 * frame skip comparison function
2313 * - encoding: Set by user.
2314 * - decoding: unused
2319 * trellis RD quantization
2320 * - encoding: Set by user.
2321 * - decoding: unused
2326 * - encoding: Set by user.
2327 * - decoding: unused
2329 int min_prediction_order;
2332 * - encoding: Set by user.
2333 * - decoding: unused
2335 int max_prediction_order;
2338 * GOP timecode frame start number
2339 * - encoding: Set by user, in non drop frame format
2340 * - decoding: Set by libavcodec (timecode in the 25 bits format, -1 if unset)
2342 int64_t timecode_frame_start;
2344 /* The RTP callback: This function is called */
2345 /* every time the encoder has a packet to send. */
2346 /* It depends on the encoder if the data starts */
2347 /* with a Start Code (it should). H.263 does. */
2348 /* mb_nb contains the number of macroblocks */
2349 /* encoded in the RTP payload. */
2350 void (*rtp_callback)(struct AVCodecContext *avctx, void *data, int size, int mb_nb);
2352 int rtp_payload_size; /* The size of the RTP payload: the coder will */
2353 /* do its best to deliver a chunk with size */
2354 /* below rtp_payload_size, the chunk will start */
2355 /* with a start code on some codecs like H.263. */
2356 /* This doesn't take account of any particular */
2357 /* headers inside the transmitted RTP payload. */
2359 /* statistics, used for 2-pass encoding */
2370 * number of bits used for the previously encoded frame
2371 * - encoding: Set by libavcodec.
2372 * - decoding: unused
2377 * pass1 encoding statistics output buffer
2378 * - encoding: Set by libavcodec.
2379 * - decoding: unused
2384 * pass2 encoding statistics input buffer
2385 * Concatenated stuff from stats_out of pass1 should be placed here.
2386 * - encoding: Allocated/set/freed by user.
2387 * - decoding: unused
2392 * Work around bugs in encoders which sometimes cannot be detected automatically.
2393 * - encoding: Set by user
2394 * - decoding: Set by user
2396 int workaround_bugs;
2397 #define FF_BUG_AUTODETECT 1 ///< autodetection
2398 #if FF_API_OLD_MSMPEG4
2399 #define FF_BUG_OLD_MSMPEG4 2
2401 #define FF_BUG_XVID_ILACE 4
2402 #define FF_BUG_UMP4 8
2403 #define FF_BUG_NO_PADDING 16
2404 #define FF_BUG_AMV 32
2406 #define FF_BUG_AC_VLC 0 ///< Will be removed, libavcodec can now handle these non-compliant files by default.
2408 #define FF_BUG_QPEL_CHROMA 64
2409 #define FF_BUG_STD_QPEL 128
2410 #define FF_BUG_QPEL_CHROMA2 256
2411 #define FF_BUG_DIRECT_BLOCKSIZE 512
2412 #define FF_BUG_EDGE 1024
2413 #define FF_BUG_HPEL_CHROMA 2048
2414 #define FF_BUG_DC_CLIP 4096
2415 #define FF_BUG_MS 8192 ///< Work around various bugs in Microsoft's broken decoders.
2416 #define FF_BUG_TRUNCATED 16384
2419 * strictly follow the standard (MPEG4, ...).
2420 * - encoding: Set by user.
2421 * - decoding: Set by user.
2422 * Setting this to STRICT or higher means the encoder and decoder will
2423 * generally do stupid things, whereas setting it to unofficial or lower
2424 * will mean the encoder might produce output that is not supported by all
2425 * spec-compliant decoders. Decoders don't differentiate between normal,
2426 * unofficial and experimental (that is, they always try to decode things
2427 * when they can) unless they are explicitly asked to behave stupidly
2428 * (=strictly conform to the specs)
2430 int strict_std_compliance;
2431 #define FF_COMPLIANCE_VERY_STRICT 2 ///< Strictly conform to an older more strict version of the spec or reference software.
2432 #define FF_COMPLIANCE_STRICT 1 ///< Strictly conform to all the things in the spec no matter what consequences.
2433 #define FF_COMPLIANCE_NORMAL 0
2434 #define FF_COMPLIANCE_UNOFFICIAL -1 ///< Allow unofficial extensions
2435 #define FF_COMPLIANCE_EXPERIMENTAL -2 ///< Allow nonstandardized experimental things.
2438 * error concealment flags
2439 * - encoding: unused
2440 * - decoding: Set by user.
2442 int error_concealment;
2443 #define FF_EC_GUESS_MVS 1
2444 #define FF_EC_DEBLOCK 2
2448 * - encoding: Set by user.
2449 * - decoding: Set by user.
2452 #define FF_DEBUG_PICT_INFO 1
2453 #define FF_DEBUG_RC 2
2454 #define FF_DEBUG_BITSTREAM 4
2455 #define FF_DEBUG_MB_TYPE 8
2456 #define FF_DEBUG_QP 16
2459 * @deprecated this option does nothing
2461 #define FF_DEBUG_MV 32
2463 #define FF_DEBUG_DCT_COEFF 0x00000040
2464 #define FF_DEBUG_SKIP 0x00000080
2465 #define FF_DEBUG_STARTCODE 0x00000100
2466 #define FF_DEBUG_PTS 0x00000200
2467 #define FF_DEBUG_ER 0x00000400
2468 #define FF_DEBUG_MMCO 0x00000800
2469 #define FF_DEBUG_BUGS 0x00001000
2471 #define FF_DEBUG_VIS_QP 0x00002000 ///< only access through AVOptions from outside libavcodec
2472 #define FF_DEBUG_VIS_MB_TYPE 0x00004000 ///< only access through AVOptions from outside libavcodec
2474 #define FF_DEBUG_BUFFERS 0x00008000
2475 #define FF_DEBUG_THREADS 0x00010000
2480 * Code outside libavcodec should access this field using AVOptions
2481 * - encoding: Set by user.
2482 * - decoding: Set by user.
2485 #define FF_DEBUG_VIS_MV_P_FOR 0x00000001 //visualize forward predicted MVs of P frames
2486 #define FF_DEBUG_VIS_MV_B_FOR 0x00000002 //visualize forward predicted MVs of B frames
2487 #define FF_DEBUG_VIS_MV_B_BACK 0x00000004 //visualize backward predicted MVs of B frames
2491 * Error recognition; may misdetect some more or less valid parts as errors.
2492 * - encoding: unused
2493 * - decoding: Set by user.
2495 int err_recognition;
2498 * Verify checksums embedded in the bitstream (could be of either encoded or
2499 * decoded data, depending on the codec) and print an error message on mismatch.
2500 * If AV_EF_EXPLODE is also set, a mismatching checksum will result in the
2501 * decoder returning an error.
2503 #define AV_EF_CRCCHECK (1<<0)
2504 #define AV_EF_BITSTREAM (1<<1) ///< detect bitstream specification deviations
2505 #define AV_EF_BUFFER (1<<2) ///< detect improper bitstream length
2506 #define AV_EF_EXPLODE (1<<3) ///< abort decoding on minor error detection
2508 #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
2509 #define AV_EF_COMPLIANT (1<<17) ///< consider all spec non compliancies as errors
2510 #define AV_EF_AGGRESSIVE (1<<18) ///< consider things that a sane encoder should not do as an error
2514 * opaque 64bit number (generally a PTS) that will be reordered and
2515 * output in AVFrame.reordered_opaque
2516 * @deprecated in favor of pkt_pts
2517 * - encoding: unused
2518 * - decoding: Set by user.
2520 int64_t reordered_opaque;
2523 * Hardware accelerator in use
2524 * - encoding: unused.
2525 * - decoding: Set by libavcodec
2527 struct AVHWAccel *hwaccel;
2530 * Hardware accelerator context.
2531 * For some hardware accelerators, a global context needs to be
2532 * provided by the user. In that case, this holds display-dependent
2533 * data FFmpeg cannot instantiate itself. Please refer to the
2534 * FFmpeg HW accelerator documentation to know how to fill this
2535 * is. e.g. for VA API, this is a struct vaapi_context.
2536 * - encoding: unused
2537 * - decoding: Set by user
2539 void *hwaccel_context;
2543 * - encoding: Set by libavcodec if flags&CODEC_FLAG_PSNR.
2544 * - decoding: unused
2546 uint64_t error[AV_NUM_DATA_POINTERS];
2549 * DCT algorithm, see FF_DCT_* below
2550 * - encoding: Set by user.
2551 * - decoding: unused
2554 #define FF_DCT_AUTO 0
2555 #define FF_DCT_FASTINT 1
2556 #define FF_DCT_INT 2
2557 #define FF_DCT_MMX 3
2558 #define FF_DCT_ALTIVEC 5
2559 #define FF_DCT_FAAN 6
2562 * IDCT algorithm, see FF_IDCT_* below.
2563 * - encoding: Set by user.
2564 * - decoding: Set by user.
2567 #define FF_IDCT_AUTO 0
2568 #define FF_IDCT_INT 1
2569 #define FF_IDCT_SIMPLE 2
2570 #define FF_IDCT_SIMPLEMMX 3
2571 #define FF_IDCT_ARM 7
2572 #define FF_IDCT_ALTIVEC 8
2573 #define FF_IDCT_SH4 9
2574 #define FF_IDCT_SIMPLEARM 10
2575 #define FF_IDCT_IPP 13
2576 #define FF_IDCT_XVIDMMX 14
2577 #define FF_IDCT_SIMPLEARMV5TE 16
2578 #define FF_IDCT_SIMPLEARMV6 17
2579 #define FF_IDCT_SIMPLEVIS 18
2580 #define FF_IDCT_FAAN 20
2581 #define FF_IDCT_SIMPLENEON 22
2582 #define FF_IDCT_SIMPLEALPHA 23
2585 * bits per sample/pixel from the demuxer (needed for huffyuv).
2586 * - encoding: Set by libavcodec.
2587 * - decoding: Set by user.
2589 int bits_per_coded_sample;
2592 * Bits per sample/pixel of internal libavcodec pixel/sample format.
2593 * - encoding: set by user.
2594 * - decoding: set by libavcodec.
2596 int bits_per_raw_sample;
2600 * low resolution decoding, 1-> 1/2 size, 2->1/4 size
2601 * - encoding: unused
2602 * - decoding: Set by user.
2603 * Code outside libavcodec should access this field using:
2604 * av_codec_{get,set}_lowres(avctx)
2610 * the picture in the bitstream
2611 * - encoding: Set by libavcodec.
2612 * - decoding: Set by libavcodec.
2614 AVFrame *coded_frame;
2618 * is used to decide how many independent tasks should be passed to execute()
2619 * - encoding: Set by user.
2620 * - decoding: Set by user.
2625 * Which multithreading methods to use.
2626 * Use of FF_THREAD_FRAME will increase decoding delay by one frame per thread,
2627 * so clients which cannot provide future frames should not use it.
2629 * - encoding: Set by user, otherwise the default is used.
2630 * - decoding: Set by user, otherwise the default is used.
2633 #define FF_THREAD_FRAME 1 ///< Decode more than one frame at once
2634 #define FF_THREAD_SLICE 2 ///< Decode more than one part of a single frame at once
2637 * Which multithreading methods are in use by the codec.
2638 * - encoding: Set by libavcodec.
2639 * - decoding: Set by libavcodec.
2641 int active_thread_type;
2644 * Set by the client if its custom get_buffer() callback can be called
2645 * synchronously from another thread, which allows faster multithreaded decoding.
2646 * draw_horiz_band() will be called from other threads regardless of this setting.
2647 * Ignored if the default get_buffer() is used.
2648 * - encoding: Set by user.
2649 * - decoding: Set by user.
2651 int thread_safe_callbacks;
2654 * The codec may call this to execute several independent things.
2655 * It will return only after finishing all tasks.
2656 * The user may replace this with some multithreaded implementation,
2657 * the default implementation will execute the parts serially.
2658 * @param count the number of things to execute
2659 * - encoding: Set by libavcodec, user can override.
2660 * - decoding: Set by libavcodec, user can override.
2662 int (*execute)(struct AVCodecContext *c, int (*func)(struct AVCodecContext *c2, void *arg), void *arg2, int *ret, int count, int size);
2665 * The codec may call this to execute several independent things.
2666 * It will return only after finishing all tasks.
2667 * The user may replace this with some multithreaded implementation,
2668 * the default implementation will execute the parts serially.
2669 * Also see avcodec_thread_init and e.g. the --enable-pthread configure option.
2670 * @param c context passed also to func
2671 * @param count the number of things to execute
2672 * @param arg2 argument passed unchanged to func
2673 * @param ret return values of executed functions, must have space for "count" values. May be NULL.
2674 * @param func function that will be called count times, with jobnr from 0 to count-1.
2675 * threadnr will be in the range 0 to c->thread_count-1 < MAX_THREADS and so that no
2676 * two instances of func executing at the same time will have the same threadnr.
2677 * @return always 0 currently, but code should handle a future improvement where when any call to func
2678 * returns < 0 no further calls to func may be done and < 0 is returned.
2679 * - encoding: Set by libavcodec, user can override.
2680 * - decoding: Set by libavcodec, user can override.
2682 int (*execute2)(struct AVCodecContext *c, int (*func)(struct AVCodecContext *c2, void *arg, int jobnr, int threadnr), void *arg2, int *ret, int count);
2686 * Can be used by execute() to store some per AVCodecContext stuff.
2687 * - encoding: set by execute()
2688 * - decoding: set by execute()
2690 void *thread_opaque;
2693 * noise vs. sse weight for the nsse comparsion function
2694 * - encoding: Set by user.
2695 * - decoding: unused
2701 * - encoding: Set by user.
2702 * - decoding: Set by libavcodec.
2705 #define FF_PROFILE_UNKNOWN -99
2706 #define FF_PROFILE_RESERVED -100
2708 #define FF_PROFILE_AAC_MAIN 0
2709 #define FF_PROFILE_AAC_LOW 1
2710 #define FF_PROFILE_AAC_SSR 2
2711 #define FF_PROFILE_AAC_LTP 3
2712 #define FF_PROFILE_AAC_HE 4
2713 #define FF_PROFILE_AAC_HE_V2 28
2714 #define FF_PROFILE_AAC_LD 22
2715 #define FF_PROFILE_AAC_ELD 38
2716 #define FF_PROFILE_MPEG2_AAC_LOW 128
2717 #define FF_PROFILE_MPEG2_AAC_HE 131
2719 #define FF_PROFILE_DTS 20
2720 #define FF_PROFILE_DTS_ES 30
2721 #define FF_PROFILE_DTS_96_24 40
2722 #define FF_PROFILE_DTS_HD_HRA 50
2723 #define FF_PROFILE_DTS_HD_MA 60
2725 #define FF_PROFILE_MPEG2_422 0
2726 #define FF_PROFILE_MPEG2_HIGH 1
2727 #define FF_PROFILE_MPEG2_SS 2
2728 #define FF_PROFILE_MPEG2_SNR_SCALABLE 3
2729 #define FF_PROFILE_MPEG2_MAIN 4
2730 #define FF_PROFILE_MPEG2_SIMPLE 5
2732 #define FF_PROFILE_H264_CONSTRAINED (1<<9) // 8+1; constraint_set1_flag
2733 #define FF_PROFILE_H264_INTRA (1<<11) // 8+3; constraint_set3_flag
2735 #define FF_PROFILE_H264_BASELINE 66
2736 #define FF_PROFILE_H264_CONSTRAINED_BASELINE (66|FF_PROFILE_H264_CONSTRAINED)
2737 #define FF_PROFILE_H264_MAIN 77
2738 #define FF_PROFILE_H264_EXTENDED 88
2739 #define FF_PROFILE_H264_HIGH 100
2740 #define FF_PROFILE_H264_HIGH_10 110
2741 #define FF_PROFILE_H264_HIGH_10_INTRA (110|FF_PROFILE_H264_INTRA)
2742 #define FF_PROFILE_H264_HIGH_422 122
2743 #define FF_PROFILE_H264_HIGH_422_INTRA (122|FF_PROFILE_H264_INTRA)
2744 #define FF_PROFILE_H264_HIGH_444 144
2745 #define FF_PROFILE_H264_HIGH_444_PREDICTIVE 244
2746 #define FF_PROFILE_H264_HIGH_444_INTRA (244|FF_PROFILE_H264_INTRA)
2747 #define FF_PROFILE_H264_CAVLC_444 44
2749 #define FF_PROFILE_VC1_SIMPLE 0
2750 #define FF_PROFILE_VC1_MAIN 1
2751 #define FF_PROFILE_VC1_COMPLEX 2
2752 #define FF_PROFILE_VC1_ADVANCED 3
2754 #define FF_PROFILE_MPEG4_SIMPLE 0
2755 #define FF_PROFILE_MPEG4_SIMPLE_SCALABLE 1
2756 #define FF_PROFILE_MPEG4_CORE 2
2757 #define FF_PROFILE_MPEG4_MAIN 3
2758 #define FF_PROFILE_MPEG4_N_BIT 4
2759 #define FF_PROFILE_MPEG4_SCALABLE_TEXTURE 5
2760 #define FF_PROFILE_MPEG4_SIMPLE_FACE_ANIMATION 6
2761 #define FF_PROFILE_MPEG4_BASIC_ANIMATED_TEXTURE 7
2762 #define FF_PROFILE_MPEG4_HYBRID 8
2763 #define FF_PROFILE_MPEG4_ADVANCED_REAL_TIME 9
2764 #define FF_PROFILE_MPEG4_CORE_SCALABLE 10
2765 #define FF_PROFILE_MPEG4_ADVANCED_CODING 11
2766 #define FF_PROFILE_MPEG4_ADVANCED_CORE 12
2767 #define FF_PROFILE_MPEG4_ADVANCED_SCALABLE_TEXTURE 13
2768 #define FF_PROFILE_MPEG4_SIMPLE_STUDIO 14
2769 #define FF_PROFILE_MPEG4_ADVANCED_SIMPLE 15
2771 #define FF_PROFILE_JPEG2000_CSTREAM_RESTRICTION_0 0
2772 #define FF_PROFILE_JPEG2000_CSTREAM_RESTRICTION_1 1
2773 #define FF_PROFILE_JPEG2000_CSTREAM_NO_RESTRICTION 2
2774 #define FF_PROFILE_JPEG2000_DCINEMA_2K 3
2775 #define FF_PROFILE_JPEG2000_DCINEMA_4K 4
2779 * - encoding: Set by user.
2780 * - decoding: Set by libavcodec.
2783 #define FF_LEVEL_UNKNOWN -99
2786 * Skip loop filtering for selected frames.
2787 * - encoding: unused
2788 * - decoding: Set by user.
2790 enum AVDiscard skip_loop_filter;
2793 * Skip IDCT/dequantization for selected frames.
2794 * - encoding: unused
2795 * - decoding: Set by user.
2797 enum AVDiscard skip_idct;
2800 * Skip decoding for selected frames.
2801 * - encoding: unused
2802 * - decoding: Set by user.
2804 enum AVDiscard skip_frame;
2807 * Header containing style information for text subtitles.
2808 * For SUBTITLE_ASS subtitle type, it should contain the whole ASS
2809 * [Script Info] and [V4+ Styles] section, plus the [Events] line and
2810 * the Format line following. It shouldn't include any Dialogue line.
2811 * - encoding: Set/allocated/freed by user (before avcodec_open2())
2812 * - decoding: Set/allocated/freed by libavcodec (by avcodec_open2())
2814 uint8_t *subtitle_header;
2815 int subtitle_header_size;
2818 * Simulates errors in the bitstream to test error concealment.
2819 * - encoding: Set by user.
2820 * - decoding: unused
2825 * Current packet as passed into the decoder, to avoid having
2826 * to pass the packet into every function. Currently only valid
2827 * inside lavc and get/release_buffer callbacks.
2828 * - decoding: set by avcodec_decode_*, read by get_buffer() for setting pkt_pts
2829 * - encoding: unused
2834 * VBV delay coded in the last frame (in periods of a 27 MHz clock).
2835 * Used for compliant TS muxing.
2836 * - encoding: Set by libavcodec.
2837 * - decoding: unused.
2842 * Timebase in which pkt_dts/pts and AVPacket.dts/pts are.
2843 * Code outside libavcodec should access this field using:
2844 * av_codec_{get,set}_pkt_timebase(avctx)
2845 * - encoding unused.
2846 * - decoding set by user.
2848 AVRational pkt_timebase;
2852 * Code outside libavcodec should access this field using:
2853 * av_codec_{get,set}_codec_descriptor(avctx)
2854 * - encoding: unused.
2855 * - decoding: set by libavcodec.
2857 const AVCodecDescriptor *codec_descriptor;
2861 * low resolution decoding, 1-> 1/2 size, 2->1/4 size
2862 * - encoding: unused
2863 * - decoding: Set by user.
2864 * Code outside libavcodec should access this field using:
2865 * av_codec_{get,set}_lowres(avctx)
2871 * Current statistics for PTS correction.
2872 * - decoding: maintained and used by libavcodec, not intended to be used by user apps
2873 * - encoding: unused
2875 int64_t pts_correction_num_faulty_pts; /// Number of incorrect PTS values so far
2876 int64_t pts_correction_num_faulty_dts; /// Number of incorrect DTS values so far
2877 int64_t pts_correction_last_pts; /// PTS of the last frame
2878 int64_t pts_correction_last_dts; /// DTS of the last frame
2881 * Character encoding of the input subtitles file.
2882 * - decoding: set by user
2883 * - encoding: unused
2888 * Subtitles character encoding mode. Formats or codecs might be adjusting
2889 * this setting (if they are doing the conversion themselves for instance).
2890 * - decoding: set by libavcodec
2891 * - encoding: unused
2893 int sub_charenc_mode;
2894 #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)
2895 #define FF_SUB_CHARENC_MODE_AUTOMATIC 0 ///< libavcodec will select the mode itself
2896 #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
2899 * Skip processing alpha if supported by codec.
2900 * Note that if the format uses pre-multiplied alpha (common with VP6,
2901 * and recommended due to better video quality/compression)
2902 * the image will look as if alpha-blended onto a black background.
2903 * However for formats that do not use pre-multiplied alpha
2904 * there might be serious artefacts (though e.g. libswscale currently
2905 * assumes pre-multiplied alpha anyway).
2906 * Code outside libavcodec should access this field using AVOptions
2908 * - decoding: set by user
2909 * - encoding: unused
2914 * Number of samples to skip after a discontinuity
2915 * - decoding: unused
2916 * - encoding: set by libavcodec
2920 #if !FF_API_DEBUG_MV
2922 * debug motion vectors
2923 * Code outside libavcodec should access this field using AVOptions
2924 * - encoding: Set by user.
2925 * - decoding: Set by user.
2928 #define FF_DEBUG_VIS_MV_P_FOR 0x00000001 //visualize forward predicted MVs of P frames
2929 #define FF_DEBUG_VIS_MV_B_FOR 0x00000002 //visualize forward predicted MVs of B frames
2930 #define FF_DEBUG_VIS_MV_B_BACK 0x00000004 //visualize backward predicted MVs of B frames
2934 AVRational av_codec_get_pkt_timebase (const AVCodecContext *avctx);
2935 void av_codec_set_pkt_timebase (AVCodecContext *avctx, AVRational val);
2937 const AVCodecDescriptor *av_codec_get_codec_descriptor(const AVCodecContext *avctx);
2938 void av_codec_set_codec_descriptor(AVCodecContext *avctx, const AVCodecDescriptor *desc);
2940 int av_codec_get_lowres(const AVCodecContext *avctx);
2941 void av_codec_set_lowres(AVCodecContext *avctx, int val);
2943 int av_codec_get_seek_preroll(const AVCodecContext *avctx);
2944 void av_codec_set_seek_preroll(AVCodecContext *avctx, int val);
2949 typedef struct AVProfile {
2951 const char *name; ///< short name for the profile
2954 typedef struct AVCodecDefault AVCodecDefault;
2961 typedef struct AVCodec {
2963 * Name of the codec implementation.
2964 * The name is globally unique among encoders and among decoders (but an
2965 * encoder and a decoder can share the same name).
2966 * This is the primary way to find a codec from the user perspective.
2970 * Descriptive name for the codec, meant to be more human readable than name.
2971 * You should use the NULL_IF_CONFIG_SMALL() macro to define it.
2973 const char *long_name;
2974 enum AVMediaType type;
2977 * Codec capabilities.
2981 const AVRational *supported_framerates; ///< array of supported framerates, or NULL if any, array is terminated by {0,0}
2982 const enum AVPixelFormat *pix_fmts; ///< array of supported pixel formats, or NULL if unknown, array is terminated by -1
2983 const int *supported_samplerates; ///< array of supported audio samplerates, or NULL if unknown, array is terminated by 0
2984 const enum AVSampleFormat *sample_fmts; ///< array of supported sample formats, or NULL if unknown, array is terminated by -1
2985 const uint64_t *channel_layouts; ///< array of support channel layouts, or NULL if unknown. array is terminated by 0
2987 uint8_t max_lowres; ///< maximum value for lowres supported by the decoder, no direct access, use av_codec_get_max_lowres()
2989 const AVClass *priv_class; ///< AVClass for the private context
2990 const AVProfile *profiles; ///< array of recognized profiles, or NULL if unknown, array is terminated by {FF_PROFILE_UNKNOWN}
2992 /*****************************************************************
2993 * No fields below this line are part of the public API. They
2994 * may not be used outside of libavcodec and can be changed and
2996 * New public fields should be added right above.
2997 *****************************************************************
3000 struct AVCodec *next;
3002 * @name Frame-level threading support functions
3006 * If defined, called on thread contexts when they are created.
3007 * If the codec allocates writable tables in init(), re-allocate them here.
3008 * priv_data will be set to a copy of the original.
3010 int (*init_thread_copy)(AVCodecContext *);
3012 * Copy necessary context variables from a previous thread context to the current one.
3013 * If not defined, the next thread will start automatically; otherwise, the codec
3014 * must call ff_thread_finish_setup().
3016 * dst and src will (rarely) point to the same context, in which case memcpy should be skipped.
3018 int (*update_thread_context)(AVCodecContext *dst, const AVCodecContext *src);
3022 * Private codec-specific defaults.
3024 const AVCodecDefault *defaults;
3027 * Initialize codec static data, called from avcodec_register().
3029 void (*init_static_data)(struct AVCodec *codec);
3031 int (*init)(AVCodecContext *);
3032 int (*encode_sub)(AVCodecContext *, uint8_t *buf, int buf_size,
3033 const struct AVSubtitle *sub);
3035 * Encode data to an AVPacket.
3037 * @param avctx codec context
3038 * @param avpkt output AVPacket (may contain a user-provided buffer)
3039 * @param[in] frame AVFrame containing the raw data to be encoded
3040 * @param[out] got_packet_ptr encoder sets to 0 or 1 to indicate that a
3041 * non-empty packet was returned in avpkt.
3042 * @return 0 on success, negative error code on failure
3044 int (*encode2)(AVCodecContext *avctx, AVPacket *avpkt, const AVFrame *frame,
3045 int *got_packet_ptr);
3046 int (*decode)(AVCodecContext *, void *outdata, int *outdata_size, AVPacket *avpkt);
3047 int (*close)(AVCodecContext *);
3050 * Will be called when seeking
3052 void (*flush)(AVCodecContext *);
3055 int av_codec_get_max_lowres(const AVCodec *codec);
3060 typedef struct AVHWAccel {
3062 * Name of the hardware accelerated codec.
3063 * The name is globally unique among encoders and among decoders (but an
3064 * encoder and a decoder can share the same name).
3069 * Type of codec implemented by the hardware accelerator.
3071 * See AVMEDIA_TYPE_xxx
3073 enum AVMediaType type;
3076 * Codec implemented by the hardware accelerator.
3078 * See AV_CODEC_ID_xxx
3083 * Supported pixel format.
3085 * Only hardware accelerated formats are supported here.
3087 enum AVPixelFormat pix_fmt;
3090 * Hardware accelerated codec capabilities.
3091 * see FF_HWACCEL_CODEC_CAP_*
3095 struct AVHWAccel *next;
3098 * Called at the beginning of each frame or field picture.
3100 * Meaningful frame information (codec specific) is guaranteed to
3101 * be parsed at this point. This function is mandatory.
3103 * Note that buf can be NULL along with buf_size set to 0.
3104 * Otherwise, this means the whole frame is available at this point.
3106 * @param avctx the codec context
3107 * @param buf the frame data buffer base
3108 * @param buf_size the size of the frame in bytes
3109 * @return zero if successful, a negative value otherwise
3111 int (*start_frame)(AVCodecContext *avctx, const uint8_t *buf, uint32_t buf_size);
3114 * Callback for each slice.
3116 * Meaningful slice information (codec specific) is guaranteed to
3117 * be parsed at this point. This function is mandatory.
3119 * @param avctx the codec context
3120 * @param buf the slice data buffer base
3121 * @param buf_size the size of the slice in bytes
3122 * @return zero if successful, a negative value otherwise
3124 int (*decode_slice)(AVCodecContext *avctx, const uint8_t *buf, uint32_t buf_size);
3127 * Called at the end of each frame or field picture.
3129 * The whole picture is parsed at this point and can now be sent
3130 * to the hardware accelerator. This function is mandatory.
3132 * @param avctx the codec context
3133 * @return zero if successful, a negative value otherwise
3135 int (*end_frame)(AVCodecContext *avctx);
3138 * Size of HW accelerator private data.
3140 * Private data is allocated with av_mallocz() before
3141 * AVCodecContext.get_buffer() and deallocated after
3142 * AVCodecContext.release_buffer().
3148 * @defgroup lavc_picture AVPicture
3150 * Functions for working with AVPicture
3155 * Picture data structure.
3157 * Up to four components can be stored into it, the last component is
3160 typedef struct AVPicture {
3161 uint8_t *data[AV_NUM_DATA_POINTERS]; ///< pointers to the image data planes
3162 int linesize[AV_NUM_DATA_POINTERS]; ///< number of bytes per line
3169 enum AVSubtitleType {
3172 SUBTITLE_BITMAP, ///< A bitmap, pict will be set
3175 * Plain text, the text field must be set by the decoder and is
3176 * authoritative. ass and pict fields may contain approximations.
3181 * Formatted text, the ass field must be set by the decoder and is
3182 * authoritative. pict and text fields may contain approximations.
3187 #define AV_SUBTITLE_FLAG_FORCED 0x00000001
3189 typedef struct AVSubtitleRect {
3190 int x; ///< top left corner of pict, undefined when pict is not set
3191 int y; ///< top left corner of pict, undefined when pict is not set
3192 int w; ///< width of pict, undefined when pict is not set
3193 int h; ///< height of pict, undefined when pict is not set
3194 int nb_colors; ///< number of colors in pict, undefined when pict is not set
3197 * data+linesize for the bitmap of this subtitle.
3198 * can be set for text/ass as well once they where rendered
3201 enum AVSubtitleType type;
3203 char *text; ///< 0 terminated plain UTF-8 text
3206 * 0 terminated ASS/SSA compatible event line.
3207 * The presentation of this is unaffected by the other values in this
3215 typedef struct AVSubtitle {
3216 uint16_t format; /* 0 = graphics */
3217 uint32_t start_display_time; /* relative to packet pts, in ms */
3218 uint32_t end_display_time; /* relative to packet pts, in ms */
3220 AVSubtitleRect **rects;
3221 int64_t pts; ///< Same as packet pts, in AV_TIME_BASE
3225 * If c is NULL, returns the first registered codec,
3226 * if c is non-NULL, returns the next registered codec after c,
3227 * or NULL if c is the last one.
3229 AVCodec *av_codec_next(const AVCodec *c);
3232 * Return the LIBAVCODEC_VERSION_INT constant.
3234 unsigned avcodec_version(void);
3237 * Return the libavcodec build-time configuration.
3239 const char *avcodec_configuration(void);
3242 * Return the libavcodec license.
3244 const char *avcodec_license(void);
3247 * Register the codec codec and initialize libavcodec.
3249 * @warning either this function or avcodec_register_all() must be called
3250 * before any other libavcodec functions.
3252 * @see avcodec_register_all()
3254 void avcodec_register(AVCodec *codec);
3257 * Register all the codecs, parsers and bitstream filters which were enabled at
3258 * configuration time. If you do not call this function you can select exactly
3259 * which formats you want to support, by using the individual registration
3262 * @see avcodec_register
3263 * @see av_register_codec_parser
3264 * @see av_register_bitstream_filter
3266 void avcodec_register_all(void);
3269 #if FF_API_ALLOC_CONTEXT
3271 * Allocate an AVCodecContext and set its fields to default values. The
3272 * resulting struct can be deallocated by simply calling av_free().
3274 * @return An AVCodecContext filled with default values or NULL on failure.
3275 * @see avcodec_get_context_defaults
3277 * @deprecated use avcodec_alloc_context3()
3279 attribute_deprecated
3280 AVCodecContext *avcodec_alloc_context(void);
3282 /** THIS FUNCTION IS NOT YET PART OF THE PUBLIC API!
3283 * we WILL change its arguments and name a few times! */
3284 attribute_deprecated
3285 AVCodecContext *avcodec_alloc_context2(enum AVMediaType);
3288 * Set the fields of the given AVCodecContext to default values.
3290 * @param s The AVCodecContext of which the fields should be set to default values.
3291 * @deprecated use avcodec_get_context_defaults3
3293 attribute_deprecated
3294 void avcodec_get_context_defaults(AVCodecContext *s);
3296 /** THIS FUNCTION IS NOT YET PART OF THE PUBLIC API!
3297 * we WILL change its arguments and name a few times! */
3298 attribute_deprecated
3299 void avcodec_get_context_defaults2(AVCodecContext *s, enum AVMediaType);
3303 * Allocate an AVCodecContext and set its fields to default values. The
3304 * resulting struct can be deallocated by calling avcodec_close() on it followed
3307 * @param codec if non-NULL, allocate private data and initialize defaults
3308 * for the given codec. It is illegal to then call avcodec_open2()
3309 * with a different codec.
3310 * If NULL, then the codec-specific defaults won't be initialized,
3311 * which may result in suboptimal default settings (this is
3312 * important mainly for encoders, e.g. libx264).
3314 * @return An AVCodecContext filled with default values or NULL on failure.
3315 * @see avcodec_get_context_defaults
3317 AVCodecContext *avcodec_alloc_context3(const AVCodec *codec);
3320 * Set the fields of the given AVCodecContext to default values corresponding
3321 * to the given codec (defaults may be codec-dependent).
3323 * Do not call this function if a non-NULL codec has been passed
3324 * to avcodec_alloc_context3() that allocated this AVCodecContext.
3325 * If codec is non-NULL, it is illegal to call avcodec_open2() with a
3326 * different codec on this AVCodecContext.
3328 int avcodec_get_context_defaults3(AVCodecContext *s, const AVCodec *codec);
3331 * Get the AVClass for AVCodecContext. It can be used in combination with
3332 * AV_OPT_SEARCH_FAKE_OBJ for examining options.
3334 * @see av_opt_find().
3336 const AVClass *avcodec_get_class(void);
3339 * Get the AVClass for AVFrame. It can be used in combination with
3340 * AV_OPT_SEARCH_FAKE_OBJ for examining options.
3342 * @see av_opt_find().
3344 const AVClass *avcodec_get_frame_class(void);
3347 * Get the AVClass for AVSubtitleRect. It can be used in combination with
3348 * AV_OPT_SEARCH_FAKE_OBJ for examining options.
3350 * @see av_opt_find().
3352 const AVClass *avcodec_get_subtitle_rect_class(void);
3355 * Copy the settings of the source AVCodecContext into the destination
3356 * AVCodecContext. The resulting destination codec context will be
3357 * unopened, i.e. you are required to call avcodec_open2() before you
3358 * can use this AVCodecContext to decode/encode video/audio data.
3360 * @param dest target codec context, should be initialized with
3361 * avcodec_alloc_context3(NULL), but otherwise uninitialized
3362 * @param src source codec context
3363 * @return AVERROR() on error (e.g. memory allocation error), 0 on success
3365 int avcodec_copy_context(AVCodecContext *dest, const AVCodecContext *src);
3368 * Allocate an AVFrame and set its fields to default values. The resulting
3369 * struct must be freed using avcodec_free_frame().
3371 * @return An AVFrame filled with default values or NULL on failure.
3372 * @see avcodec_get_frame_defaults
3374 AVFrame *avcodec_alloc_frame(void);
3377 * Set the fields of the given AVFrame to default values.
3379 * @param frame The AVFrame of which the fields should be set to default values.
3381 void avcodec_get_frame_defaults(AVFrame *frame);
3384 * Free the frame and any dynamically allocated objects in it,
3385 * e.g. extended_data.
3387 * @param frame frame to be freed. The pointer will be set to NULL.
3389 * @warning this function does NOT free the data buffers themselves
3390 * (it does not know how, since they might have been allocated with
3391 * a custom get_buffer()).
3393 void avcodec_free_frame(AVFrame **frame);
3395 #if FF_API_AVCODEC_OPEN
3397 * Initialize the AVCodecContext to use the given AVCodec. Prior to using this
3398 * function the context has to be allocated.
3400 * The functions avcodec_find_decoder_by_name(), avcodec_find_encoder_by_name(),
3401 * avcodec_find_decoder() and avcodec_find_encoder() provide an easy way for
3402 * retrieving a codec.
3404 * @warning This function is not thread safe!
3407 * avcodec_register_all();
3408 * codec = avcodec_find_decoder(AV_CODEC_ID_H264);
3412 * context = avcodec_alloc_context3(codec);
3414 * if (avcodec_open(context, codec) < 0)
3418 * @param avctx The context which will be set up to use the given codec.
3419 * @param codec The codec to use within the context.
3420 * @return zero on success, a negative value on error
3421 * @see avcodec_alloc_context3, avcodec_find_decoder, avcodec_find_encoder, avcodec_close
3423 * @deprecated use avcodec_open2
3425 attribute_deprecated
3426 int avcodec_open(AVCodecContext *avctx, AVCodec *codec);
3430 * Initialize the AVCodecContext to use the given AVCodec. Prior to using this
3431 * function the context has to be allocated with avcodec_alloc_context3().
3433 * The functions avcodec_find_decoder_by_name(), avcodec_find_encoder_by_name(),
3434 * avcodec_find_decoder() and avcodec_find_encoder() provide an easy way for
3435 * retrieving a codec.
3437 * @warning This function is not thread safe!
3440 * avcodec_register_all();
3441 * av_dict_set(&opts, "b", "2.5M", 0);
3442 * codec = avcodec_find_decoder(AV_CODEC_ID_H264);
3446 * context = avcodec_alloc_context3(codec);
3448 * if (avcodec_open2(context, codec, opts) < 0)
3452 * @param avctx The context to initialize.
3453 * @param codec The codec to open this context for. If a non-NULL codec has been
3454 * previously passed to avcodec_alloc_context3() or
3455 * avcodec_get_context_defaults3() for this context, then this
3456 * parameter MUST be either NULL or equal to the previously passed
3458 * @param options A dictionary filled with AVCodecContext and codec-private options.
3459 * On return this object will be filled with options that were not found.
3461 * @return zero on success, a negative value on error
3462 * @see avcodec_alloc_context3(), avcodec_find_decoder(), avcodec_find_encoder(),
3463 * av_dict_set(), av_opt_find().
3465 int avcodec_open2(AVCodecContext *avctx, const AVCodec *codec, AVDictionary **options);
3468 * Close a given AVCodecContext and free all the data associated with it
3469 * (but not the AVCodecContext itself).
3471 * Calling this function on an AVCodecContext that hasn't been opened will free
3472 * the codec-specific data allocated in avcodec_alloc_context3() /
3473 * avcodec_get_context_defaults3() with a non-NULL codec. Subsequent calls will
3476 int avcodec_close(AVCodecContext *avctx);
3479 * Free all allocated data in the given subtitle struct.
3481 * @param sub AVSubtitle to free.
3483 void avsubtitle_free(AVSubtitle *sub);
3490 * @addtogroup lavc_packet
3494 #if FF_API_DESTRUCT_PACKET
3496 * Default packet destructor.
3497 * @deprecated use the AVBuffer API instead
3499 attribute_deprecated
3500 void av_destruct_packet(AVPacket *pkt);
3504 * Initialize optional fields of a packet with default values.
3506 * Note, this does not touch the data and size members, which have to be
3507 * initialized separately.
3511 void av_init_packet(AVPacket *pkt);
3514 * Allocate the payload of a packet and initialize its fields with
3518 * @param size wanted payload size
3519 * @return 0 if OK, AVERROR_xxx otherwise
3521 int av_new_packet(AVPacket *pkt, int size);
3524 * Reduce packet size, correctly zeroing padding
3527 * @param size new size
3529 void av_shrink_packet(AVPacket *pkt, int size);
3532 * Increase packet size, correctly zeroing padding
3535 * @param grow_by number of bytes by which to increase the size of the packet
3537 int av_grow_packet(AVPacket *pkt, int grow_by);
3540 * Initialize a reference-counted packet from av_malloc()ed data.
3542 * @param pkt packet to be initialized. This function will set the data, size,
3543 * buf and destruct fields, all others are left untouched.
3544 * @param data Data allocated by av_malloc() to be used as packet data. If this
3545 * function returns successfully, the data is owned by the underlying AVBuffer.
3546 * The caller may not access the data through other means.
3547 * @param size size of data in bytes, without the padding. I.e. the full buffer
3548 * size is assumed to be size + FF_INPUT_BUFFER_PADDING_SIZE.
3550 * @return 0 on success, a negative AVERROR on error
3552 int av_packet_from_data(AVPacket *pkt, uint8_t *data, int size);
3555 * @warning This is a hack - the packet memory allocation stuff is broken. The
3556 * packet is allocated if it was not really allocated.
3558 int av_dup_packet(AVPacket *pkt);
3561 * Copy packet, including contents
3563 * @return 0 on success, negative AVERROR on fail
3565 int av_copy_packet(AVPacket *dst, AVPacket *src);
3568 * Copy packet side data
3570 * @return 0 on success, negative AVERROR on fail
3572 int av_copy_packet_side_data(AVPacket *dst, AVPacket *src);
3577 * @param pkt packet to free
3579 void av_free_packet(AVPacket *pkt);
3582 * Allocate new information of a packet.
3585 * @param type side information type
3586 * @param size side information size
3587 * @return pointer to fresh allocated data or NULL otherwise
3589 uint8_t* av_packet_new_side_data(AVPacket *pkt, enum AVPacketSideDataType type,
3593 * Shrink the already allocated side data buffer
3596 * @param type side information type
3597 * @param size new side information size
3598 * @return 0 on success, < 0 on failure
3600 int av_packet_shrink_side_data(AVPacket *pkt, enum AVPacketSideDataType type,
3604 * Get side information from packet.
3607 * @param type desired side information type
3608 * @param size pointer for side information size to store (optional)
3609 * @return pointer to data if present or NULL otherwise
3611 uint8_t* av_packet_get_side_data(AVPacket *pkt, enum AVPacketSideDataType type,
3614 int av_packet_merge_side_data(AVPacket *pkt);
3616 int av_packet_split_side_data(AVPacket *pkt);
3620 * Convenience function to free all the side data stored.
3621 * All the other fields stay untouched.
3625 void av_packet_free_side_data(AVPacket *pkt);
3628 * Setup a new reference to the data described by a given packet
3630 * If src is reference-counted, setup dst as a new reference to the
3631 * buffer in src. Otherwise allocate a new buffer in dst and copy the
3632 * data from src into it.
3634 * All the other fields are copied from src.
3636 * @see av_packet_unref
3638 * @param dst Destination packet
3639 * @param src Source packet
3641 * @return 0 on success, a negative AVERROR on error.
3643 int av_packet_ref(AVPacket *dst, AVPacket *src);
3648 * Unreference the buffer referenced by the packet and reset the
3649 * remaining packet fields to their default values.
3651 * @param pkt The packet to be unreferenced.
3653 void av_packet_unref(AVPacket *pkt);
3656 * Move every field in src to dst and reset src.
3658 * @see av_packet_unref
3660 * @param src Source packet, will be reset
3661 * @param dst Destination packet
3663 void av_packet_move_ref(AVPacket *dst, AVPacket *src);
3666 * Copy only "properties" fields from src to dst.
3668 * Properties for the purpose of this function are all the fields
3669 * beside those related to the packet data (buf, data, size)
3671 * @param dst Destination packet
3672 * @param src Source packet
3674 * @return 0 on success AVERROR on failure.
3677 int av_packet_copy_props(AVPacket *dst, const AVPacket *src);
3684 * @addtogroup lavc_decoding
3689 * Find a registered decoder with a matching codec ID.
3691 * @param id AVCodecID of the requested decoder
3692 * @return A decoder if one was found, NULL otherwise.
3694 AVCodec *avcodec_find_decoder(enum AVCodecID id);
3697 * Find a registered decoder with the specified name.
3699 * @param name name of the requested decoder
3700 * @return A decoder if one was found, NULL otherwise.
3702 AVCodec *avcodec_find_decoder_by_name(const char *name);
3704 #if FF_API_GET_BUFFER
3705 attribute_deprecated int avcodec_default_get_buffer(AVCodecContext *s, AVFrame *pic);
3706 attribute_deprecated void avcodec_default_release_buffer(AVCodecContext *s, AVFrame *pic);
3707 attribute_deprecated int avcodec_default_reget_buffer(AVCodecContext *s, AVFrame *pic);
3711 * The default callback for AVCodecContext.get_buffer2(). It is made public so
3712 * it can be called by custom get_buffer2() implementations for decoders without
3713 * CODEC_CAP_DR1 set.
3715 int avcodec_default_get_buffer2(AVCodecContext *s, AVFrame *frame, int flags);
3718 * Return the amount of padding in pixels which the get_buffer callback must
3719 * provide around the edge of the image for codecs which do not have the
3720 * CODEC_FLAG_EMU_EDGE flag.
3722 * @return Required padding in pixels.
3724 unsigned avcodec_get_edge_width(void);
3727 * Modify width and height values so that they will result in a memory
3728 * buffer that is acceptable for the codec if you do not use any horizontal
3731 * May only be used if a codec with CODEC_CAP_DR1 has been opened.
3732 * If CODEC_FLAG_EMU_EDGE is not set, the dimensions must have been increased
3733 * according to avcodec_get_edge_width() before.
3735 void avcodec_align_dimensions(AVCodecContext *s, int *width, int *height);
3738 * Modify width and height values so that they will result in a memory
3739 * buffer that is acceptable for the codec if you also ensure that all
3740 * line sizes are a multiple of the respective linesize_align[i].
3742 * May only be used if a codec with CODEC_CAP_DR1 has been opened.
3743 * If CODEC_FLAG_EMU_EDGE is not set, the dimensions must have been increased
3744 * according to avcodec_get_edge_width() before.
3746 void avcodec_align_dimensions2(AVCodecContext *s, int *width, int *height,
3747 int linesize_align[AV_NUM_DATA_POINTERS]);
3750 * Converts AVChromaLocation to swscale x/y chroma position.
3752 * The positions represent the chroma (0,0) position in a coordinates system
3753 * with luma (0,0) representing the origin and luma(1,1) representing 256,256
3755 * @param xpos horizontal chroma sample position
3756 * @param ypos vertical chroma sample position
3758 int avcodec_enum_to_chroma_pos(int *xpos, int *ypos, enum AVChromaLocation pos);
3761 * Converts swscale x/y chroma position to AVChromaLocation.
3763 * The positions represent the chroma (0,0) position in a coordinates system
3764 * with luma (0,0) representing the origin and luma(1,1) representing 256,256
3766 * @param xpos horizontal chroma sample position
3767 * @param ypos vertical chroma sample position
3769 enum AVChromaLocation avcodec_chroma_pos_to_enum(int xpos, int ypos);
3771 #if FF_API_OLD_DECODE_AUDIO
3773 * Wrapper function which calls avcodec_decode_audio4.
3775 * @deprecated Use avcodec_decode_audio4 instead.
3777 * Decode the audio frame of size avpkt->size from avpkt->data into samples.
3778 * Some decoders may support multiple frames in a single AVPacket, such
3779 * decoders would then just decode the first frame. In this case,
3780 * avcodec_decode_audio3 has to be called again with an AVPacket that contains
3781 * the remaining data in order to decode the second frame etc.
3783 * could be outputted, frame_size_ptr is zero. Otherwise, it is the
3784 * decompressed frame size in bytes.
3786 * @warning You must set frame_size_ptr to the allocated size of the
3787 * output buffer before calling avcodec_decode_audio3().
3789 * @warning The input buffer must be FF_INPUT_BUFFER_PADDING_SIZE larger than
3790 * the actual read bytes because some optimized bitstream readers read 32 or 64
3791 * bits at once and could read over the end.
3793 * @warning The end of the input buffer avpkt->data should be set to 0 to ensure that
3794 * no overreading happens for damaged MPEG streams.
3796 * @warning You must not provide a custom get_buffer() when using
3797 * avcodec_decode_audio3(). Doing so will override it with
3798 * avcodec_default_get_buffer. Use avcodec_decode_audio4() instead,
3799 * which does allow the application to provide a custom get_buffer().
3801 * @note You might have to align the input buffer avpkt->data and output buffer
3802 * samples. The alignment requirements depend on the CPU: On some CPUs it isn't
3803 * necessary at all, on others it won't work at all if not aligned and on others
3804 * it will work but it will have an impact on performance.
3806 * In practice, avpkt->data should have 4 byte alignment at minimum and
3807 * samples should be 16 byte aligned unless the CPU doesn't need it
3808 * (AltiVec and SSE do).
3810 * @note Codecs which have the CODEC_CAP_DELAY capability set have a delay
3811 * between input and output, these need to be fed with avpkt->data=NULL,
3812 * avpkt->size=0 at the end to return the remaining frames.
3814 * @param avctx the codec context
3815 * @param[out] samples the output buffer, sample type in avctx->sample_fmt
3816 * If the sample format is planar, each channel plane will
3817 * be the same size, with no padding between channels.
3818 * @param[in,out] frame_size_ptr the output buffer size in bytes
3819 * @param[in] avpkt The input AVPacket containing the input buffer.
3820 * You can create such packet with av_init_packet() and by then setting
3821 * data and size, some decoders might in addition need other fields.
3822 * All decoders are designed to use the least fields possible though.
3823 * @return On error a negative value is returned, otherwise the number of bytes
3824 * used or zero if no frame data was decompressed (used) from the input AVPacket.
3826 attribute_deprecated int avcodec_decode_audio3(AVCodecContext *avctx, int16_t *samples,
3827 int *frame_size_ptr,
3832 * Decode the audio frame of size avpkt->size from avpkt->data into frame.
3834 * Some decoders may support multiple frames in a single AVPacket. Such
3835 * decoders would then just decode the first frame and the return value would be
3836 * less than the packet size. In this case, avcodec_decode_audio4 has to be
3837 * called again with an AVPacket containing the remaining data in order to
3838 * decode the second frame, etc... Even if no frames are returned, the packet
3839 * needs to be fed to the decoder with remaining data until it is completely
3840 * consumed or an error occurs.
3842 * Some decoders (those marked with CODEC_CAP_DELAY) have a delay between input
3843 * and output. This means that for some packets they will not immediately
3844 * produce decoded output and need to be flushed at the end of decoding to get
3845 * all the decoded data. Flushing is done by calling this function with packets
3846 * with avpkt->data set to NULL and avpkt->size set to 0 until it stops
3847 * returning samples. It is safe to flush even those decoders that are not
3848 * marked with CODEC_CAP_DELAY, then no samples will be returned.
3850 * @warning The input buffer, avpkt->data must be FF_INPUT_BUFFER_PADDING_SIZE
3851 * larger than the actual read bytes because some optimized bitstream
3852 * readers read 32 or 64 bits at once and could read over the end.
3854 * @param avctx the codec context
3855 * @param[out] frame The AVFrame in which to store decoded audio samples.
3856 * The decoder will allocate a buffer for the decoded frame by
3857 * calling the AVCodecContext.get_buffer2() callback.
3858 * When AVCodecContext.refcounted_frames is set to 1, the frame is
3859 * reference counted and the returned reference belongs to the
3860 * caller. The caller must release the frame using av_frame_unref()
3861 * when the frame is no longer needed. The caller may safely write
3862 * to the frame if av_frame_is_writable() returns 1.
3863 * When AVCodecContext.refcounted_frames is set to 0, the returned
3864 * reference belongs to the decoder and is valid only until the
3865 * next call to this function or until closing or flushing the
3866 * decoder. The caller may not write to it.
3867 * @param[out] got_frame_ptr Zero if no frame could be decoded, otherwise it is
3868 * non-zero. Note that this field being set to zero
3869 * does not mean that an error has occurred. For
3870 * decoders with CODEC_CAP_DELAY set, no given decode
3871 * call is guaranteed to produce a frame.
3872 * @param[in] avpkt The input AVPacket containing the input buffer.
3873 * At least avpkt->data and avpkt->size should be set. Some
3874 * decoders might also require additional fields to be set.
3875 * @return A negative error code is returned if an error occurred during
3876 * decoding, otherwise the number of bytes consumed from the input
3877 * AVPacket is returned.
3879 int avcodec_decode_audio4(AVCodecContext *avctx, AVFrame *frame,
3880 int *got_frame_ptr, const AVPacket *avpkt);
3883 * Decode the video frame of size avpkt->size from avpkt->data into picture.
3884 * Some decoders may support multiple frames in a single AVPacket, such
3885 * decoders would then just decode the first frame.
3887 * @warning The input buffer must be FF_INPUT_BUFFER_PADDING_SIZE larger than
3888 * the actual read bytes because some optimized bitstream readers read 32 or 64
3889 * bits at once and could read over the end.
3891 * @warning The end of the input buffer buf should be set to 0 to ensure that
3892 * no overreading happens for damaged MPEG streams.
3894 * @note Codecs which have the CODEC_CAP_DELAY capability set have a delay
3895 * between input and output, these need to be fed with avpkt->data=NULL,
3896 * avpkt->size=0 at the end to return the remaining frames.
3898 * @param avctx the codec context
3899 * @param[out] picture The AVFrame in which the decoded video frame will be stored.
3900 * Use av_frame_alloc() to get an AVFrame. The codec will
3901 * allocate memory for the actual bitmap by calling the
3902 * AVCodecContext.get_buffer2() callback.
3903 * When AVCodecContext.refcounted_frames is set to 1, the frame is
3904 * reference counted and the returned reference belongs to the
3905 * caller. The caller must release the frame using av_frame_unref()
3906 * when the frame is no longer needed. The caller may safely write
3907 * to the frame if av_frame_is_writable() returns 1.
3908 * When AVCodecContext.refcounted_frames is set to 0, the returned
3909 * reference belongs to the decoder and is valid only until the
3910 * next call to this function or until closing or flushing the
3911 * decoder. The caller may not write to it.
3913 * @param[in] avpkt The input AVPacket containing the input buffer.
3914 * You can create such packet with av_init_packet() and by then setting
3915 * data and size, some decoders might in addition need other fields like
3916 * flags&AV_PKT_FLAG_KEY. All decoders are designed to use the least
3918 * @param[in,out] got_picture_ptr Zero if no frame could be decompressed, otherwise, it is nonzero.
3919 * @return On error a negative value is returned, otherwise the number of bytes
3920 * used or zero if no frame could be decompressed.
3922 int avcodec_decode_video2(AVCodecContext *avctx, AVFrame *picture,
3923 int *got_picture_ptr,
3924 const AVPacket *avpkt);
3927 * Decode a subtitle message.
3928 * Return a negative value on error, otherwise return the number of bytes used.
3929 * If no subtitle could be decompressed, got_sub_ptr is zero.
3930 * Otherwise, the subtitle is stored in *sub.
3931 * Note that CODEC_CAP_DR1 is not available for subtitle codecs. This is for
3932 * simplicity, because the performance difference is expect to be negligible
3933 * and reusing a get_buffer written for video codecs would probably perform badly
3934 * due to a potentially very different allocation pattern.
3936 * Some decoders (those marked with CODEC_CAP_DELAY) have a delay between input
3937 * and output. This means that for some packets they will not immediately
3938 * produce decoded output and need to be flushed at the end of decoding to get
3939 * all the decoded data. Flushing is done by calling this function with packets
3940 * with avpkt->data set to NULL and avpkt->size set to 0 until it stops
3941 * returning subtitles. It is safe to flush even those decoders that are not
3942 * marked with CODEC_CAP_DELAY, then no subtitles will be returned.
3944 * @param avctx the codec context
3945 * @param[out] sub The AVSubtitle in which the decoded subtitle will be stored, must be
3946 freed with avsubtitle_free if *got_sub_ptr is set.
3947 * @param[in,out] got_sub_ptr Zero if no subtitle could be decompressed, otherwise, it is nonzero.
3948 * @param[in] avpkt The input AVPacket containing the input buffer.
3950 int avcodec_decode_subtitle2(AVCodecContext *avctx, AVSubtitle *sub,
3955 * @defgroup lavc_parsing Frame parsing
3959 enum AVPictureStructure {
3960 AV_PICTURE_STRUCTURE_UNKNOWN, //< unknown
3961 AV_PICTURE_STRUCTURE_TOP_FIELD, //< coded as top field
3962 AV_PICTURE_STRUCTURE_BOTTOM_FIELD, //< coded as bottom field
3963 AV_PICTURE_STRUCTURE_FRAME, //< coded as frame
3966 typedef struct AVCodecParserContext {
3968 struct AVCodecParser *parser;
3969 int64_t frame_offset; /* offset of the current frame */
3970 int64_t cur_offset; /* current offset
3971 (incremented by each av_parser_parse()) */
3972 int64_t next_frame_offset; /* offset of the next frame */
3974 int pict_type; /* XXX: Put it back in AVCodecContext. */
3976 * This field is used for proper frame duration computation in lavf.
3977 * It signals, how much longer the frame duration of the current frame
3978 * is compared to normal frame duration.
3980 * frame_duration = (1 + repeat_pict) * time_base
3982 * It is used by codecs like H.264 to display telecined material.
3984 int repeat_pict; /* XXX: Put it back in AVCodecContext. */
3985 int64_t pts; /* pts of the current frame */
3986 int64_t dts; /* dts of the current frame */
3991 int fetch_timestamp;
3993 #define AV_PARSER_PTS_NB 4
3994 int cur_frame_start_index;
3995 int64_t cur_frame_offset[AV_PARSER_PTS_NB];
3996 int64_t cur_frame_pts[AV_PARSER_PTS_NB];
3997 int64_t cur_frame_dts[AV_PARSER_PTS_NB];
4000 #define PARSER_FLAG_COMPLETE_FRAMES 0x0001
4001 #define PARSER_FLAG_ONCE 0x0002
4002 /// Set if the parser has a valid file offset
4003 #define PARSER_FLAG_FETCHED_OFFSET 0x0004
4004 #define PARSER_FLAG_USE_CODEC_TS 0x1000
4006 int64_t offset; ///< byte offset from starting packet start
4007 int64_t cur_frame_end[AV_PARSER_PTS_NB];
4010 * Set by parser to 1 for key frames and 0 for non-key frames.
4011 * It is initialized to -1, so if the parser doesn't set this flag,
4012 * old-style fallback using AV_PICTURE_TYPE_I picture type as key frames
4018 * Time difference in stream time base units from the pts of this
4019 * packet to the point at which the output from the decoder has converged
4020 * independent from the availability of previous frames. That is, the
4021 * frames are virtually identical no matter if decoding started from
4022 * the very first frame or from this keyframe.
4023 * Is AV_NOPTS_VALUE if unknown.
4024 * This field is not the display duration of the current frame.
4025 * This field has no meaning if the packet does not have AV_PKT_FLAG_KEY
4028 * The purpose of this field is to allow seeking in streams that have no
4029 * keyframes in the conventional sense. It corresponds to the
4030 * recovery point SEI in H.264 and match_time_delta in NUT. It is also
4031 * essential for some types of subtitle streams to ensure that all
4032 * subtitles are correctly displayed after seeking.
4034 int64_t convergence_duration;
4036 // Timestamp generation support:
4038 * Synchronization point for start of timestamp generation.
4040 * Set to >0 for sync point, 0 for no sync point and <0 for undefined
4043 * For example, this corresponds to presence of H.264 buffering period
4049 * Offset of the current timestamp against last timestamp sync point in
4050 * units of AVCodecContext.time_base.
4052 * Set to INT_MIN when dts_sync_point unused. Otherwise, it must
4053 * contain a valid timestamp offset.
4055 * Note that the timestamp of sync point has usually a nonzero
4056 * dts_ref_dts_delta, which refers to the previous sync point. Offset of
4057 * the next frame after timestamp sync point will be usually 1.
4059 * For example, this corresponds to H.264 cpb_removal_delay.
4061 int dts_ref_dts_delta;
4064 * Presentation delay of current frame in units of AVCodecContext.time_base.
4066 * Set to INT_MIN when dts_sync_point unused. Otherwise, it must
4067 * contain valid non-negative timestamp delta (presentation time of a frame
4068 * must not lie in the past).
4070 * This delay represents the difference between decoding and presentation
4071 * time of the frame.
4073 * For example, this corresponds to H.264 dpb_output_delay.
4078 * Position of the packet in file.
4080 * Analogous to cur_frame_pts/dts
4082 int64_t cur_frame_pos[AV_PARSER_PTS_NB];
4085 * Byte position of currently parsed frame in stream.
4090 * Previous frame byte position.
4095 * Duration of the current frame.
4096 * For audio, this is in units of 1 / AVCodecContext.sample_rate.
4097 * For all other types, this is in units of AVCodecContext.time_base.
4101 enum AVFieldOrder field_order;
4104 * Indicate whether a picture is coded as a frame, top field or bottom field.
4106 * For example, H.264 field_pic_flag equal to 0 corresponds to
4107 * AV_PICTURE_STRUCTURE_FRAME. An H.264 picture with field_pic_flag
4108 * equal to 1 and bottom_field_flag equal to 0 corresponds to
4109 * AV_PICTURE_STRUCTURE_TOP_FIELD.
4111 enum AVPictureStructure picture_structure;
4114 * Picture number incremented in presentation or output order.
4115 * This field may be reinitialized at the first picture of a new sequence.
4117 * For example, this corresponds to H.264 PicOrderCnt.
4119 int output_picture_number;
4120 } AVCodecParserContext;
4122 typedef struct AVCodecParser {
4123 int codec_ids[5]; /* several codec IDs are permitted */
4125 int (*parser_init)(AVCodecParserContext *s);
4126 int (*parser_parse)(AVCodecParserContext *s,
4127 AVCodecContext *avctx,
4128 const uint8_t **poutbuf, int *poutbuf_size,
4129 const uint8_t *buf, int buf_size);
4130 void (*parser_close)(AVCodecParserContext *s);
4131 int (*split)(AVCodecContext *avctx, const uint8_t *buf, int buf_size);
4132 struct AVCodecParser *next;
4135 AVCodecParser *av_parser_next(AVCodecParser *c);
4137 void av_register_codec_parser(AVCodecParser *parser);
4138 AVCodecParserContext *av_parser_init(int codec_id);
4143 * @param s parser context.
4144 * @param avctx codec context.
4145 * @param poutbuf set to pointer to parsed buffer or NULL if not yet finished.
4146 * @param poutbuf_size set to size of parsed buffer or zero if not yet finished.
4147 * @param buf input buffer.
4148 * @param buf_size input length, to signal EOF, this should be 0 (so that the last frame can be output).
4149 * @param pts input presentation timestamp.
4150 * @param dts input decoding timestamp.
4151 * @param pos input byte position in stream.
4152 * @return the number of bytes of the input bitstream used.
4157 * len = av_parser_parse2(myparser, AVCodecContext, &data, &size,
4164 * decode_frame(data, size);
4168 int av_parser_parse2(AVCodecParserContext *s,
4169 AVCodecContext *avctx,
4170 uint8_t **poutbuf, int *poutbuf_size,
4171 const uint8_t *buf, int buf_size,
4172 int64_t pts, int64_t dts,
4176 * @return 0 if the output buffer is a subset of the input, 1 if it is allocated and must be freed
4177 * @deprecated use AVBitStreamFilter
4179 int av_parser_change(AVCodecParserContext *s,
4180 AVCodecContext *avctx,
4181 uint8_t **poutbuf, int *poutbuf_size,
4182 const uint8_t *buf, int buf_size, int keyframe);
4183 void av_parser_close(AVCodecParserContext *s);
4191 * @addtogroup lavc_encoding
4196 * Find a registered encoder with a matching codec ID.
4198 * @param id AVCodecID of the requested encoder
4199 * @return An encoder if one was found, NULL otherwise.
4201 AVCodec *avcodec_find_encoder(enum AVCodecID id);
4204 * Find a registered encoder with the specified name.
4206 * @param name name of the requested encoder
4207 * @return An encoder if one was found, NULL otherwise.
4209 AVCodec *avcodec_find_encoder_by_name(const char *name);
4211 #if FF_API_OLD_ENCODE_AUDIO
4213 * Encode an audio frame from samples into buf.
4215 * @deprecated Use avcodec_encode_audio2 instead.
4217 * @note The output buffer should be at least FF_MIN_BUFFER_SIZE bytes large.
4218 * However, for codecs with avctx->frame_size equal to 0 (e.g. PCM) the user
4219 * will know how much space is needed because it depends on the value passed
4220 * in buf_size as described below. In that case a lower value can be used.
4222 * @param avctx the codec context
4223 * @param[out] buf the output buffer
4224 * @param[in] buf_size the output buffer size
4225 * @param[in] samples the input buffer containing the samples
4226 * The number of samples read from this buffer is frame_size*channels,
4227 * both of which are defined in avctx.
4228 * For codecs which have avctx->frame_size equal to 0 (e.g. PCM) the number of
4229 * samples read from samples is equal to:
4230 * buf_size * 8 / (avctx->channels * av_get_bits_per_sample(avctx->codec_id))
4231 * This also implies that av_get_bits_per_sample() must not return 0 for these
4233 * @return On error a negative value is returned, on success zero or the number
4234 * of bytes used to encode the data read from the input buffer.
4236 int attribute_deprecated avcodec_encode_audio(AVCodecContext *avctx,
4237 uint8_t *buf, int buf_size,
4238 const short *samples);
4242 * Encode a frame of audio.
4244 * Takes input samples from frame and writes the next output packet, if
4245 * available, to avpkt. The output packet does not necessarily contain data for
4246 * the most recent frame, as encoders can delay, split, and combine input frames
4247 * internally as needed.
4249 * @param avctx codec context
4250 * @param avpkt output AVPacket.
4251 * The user can supply an output buffer by setting
4252 * avpkt->data and avpkt->size prior to calling the
4253 * function, but if the size of the user-provided data is not
4254 * large enough, encoding will fail. If avpkt->data and
4255 * avpkt->size are set, avpkt->destruct must also be set. All
4256 * other AVPacket fields will be reset by the encoder using
4257 * av_init_packet(). If avpkt->data is NULL, the encoder will
4258 * allocate it. The encoder will set avpkt->size to the size
4259 * of the output packet.
4261 * If this function fails or produces no output, avpkt will be
4262 * freed using av_free_packet() (i.e. avpkt->destruct will be
4263 * called to free the user supplied buffer).
4264 * @param[in] frame AVFrame containing the raw audio data to be encoded.
4265 * May be NULL when flushing an encoder that has the
4266 * CODEC_CAP_DELAY capability set.
4267 * If CODEC_CAP_VARIABLE_FRAME_SIZE is set, then each frame
4268 * can have any number of samples.
4269 * If it is not set, frame->nb_samples must be equal to
4270 * avctx->frame_size for all frames except the last.
4271 * The final frame may be smaller than avctx->frame_size.
4272 * @param[out] got_packet_ptr This field is set to 1 by libavcodec if the
4273 * output packet is non-empty, and to 0 if it is
4274 * empty. If the function returns an error, the
4275 * packet can be assumed to be invalid, and the
4276 * value of got_packet_ptr is undefined and should
4278 * @return 0 on success, negative error code on failure
4280 int avcodec_encode_audio2(AVCodecContext *avctx, AVPacket *avpkt,
4281 const AVFrame *frame, int *got_packet_ptr);
4283 #if FF_API_OLD_ENCODE_VIDEO
4285 * @deprecated use avcodec_encode_video2() instead.
4287 * Encode a video frame from pict into buf.
4288 * The input picture should be
4289 * stored using a specific format, namely avctx.pix_fmt.
4291 * @param avctx the codec context
4292 * @param[out] buf the output buffer for the bitstream of encoded frame
4293 * @param[in] buf_size the size of the output buffer in bytes
4294 * @param[in] pict the input picture to encode
4295 * @return On error a negative value is returned, on success zero or the number
4296 * of bytes used from the output buffer.
4298 attribute_deprecated
4299 int avcodec_encode_video(AVCodecContext *avctx, uint8_t *buf, int buf_size,
4300 const AVFrame *pict);
4304 * Encode a frame of video.
4306 * Takes input raw video data from frame and writes the next output packet, if
4307 * available, to avpkt. The output packet does not necessarily contain data for
4308 * the most recent frame, as encoders can delay and reorder input frames
4309 * internally as needed.
4311 * @param avctx codec context
4312 * @param avpkt output AVPacket.
4313 * The user can supply an output buffer by setting
4314 * avpkt->data and avpkt->size prior to calling the
4315 * function, but if the size of the user-provided data is not
4316 * large enough, encoding will fail. All other AVPacket fields
4317 * will be reset by the encoder using av_init_packet(). If
4318 * avpkt->data is NULL, the encoder will allocate it.
4319 * The encoder will set avpkt->size to the size of the
4320 * output packet. The returned data (if any) belongs to the
4321 * caller, he is responsible for freeing it.
4323 * If this function fails or produces no output, avpkt will be
4324 * freed using av_free_packet() (i.e. avpkt->destruct will be
4325 * called to free the user supplied buffer).
4326 * @param[in] frame AVFrame containing the raw video data to be encoded.
4327 * May be NULL when flushing an encoder that has the
4328 * CODEC_CAP_DELAY capability set.
4329 * @param[out] got_packet_ptr This field is set to 1 by libavcodec if the
4330 * output packet is non-empty, and to 0 if it is
4331 * empty. If the function returns an error, the
4332 * packet can be assumed to be invalid, and the
4333 * value of got_packet_ptr is undefined and should
4335 * @return 0 on success, negative error code on failure
4337 int avcodec_encode_video2(AVCodecContext *avctx, AVPacket *avpkt,
4338 const AVFrame *frame, int *got_packet_ptr);
4340 int avcodec_encode_subtitle(AVCodecContext *avctx, uint8_t *buf, int buf_size,
4341 const AVSubtitle *sub);
4348 #if FF_API_AVCODEC_RESAMPLE
4350 * @defgroup lavc_resample Audio resampling
4352 * @deprecated use libswresample instead
4356 struct ReSampleContext;
4357 struct AVResampleContext;
4359 typedef struct ReSampleContext ReSampleContext;
4362 * Initialize audio resampling context.
4364 * @param output_channels number of output channels
4365 * @param input_channels number of input channels
4366 * @param output_rate output sample rate
4367 * @param input_rate input sample rate
4368 * @param sample_fmt_out requested output sample format
4369 * @param sample_fmt_in input sample format
4370 * @param filter_length length of each FIR filter in the filterbank relative to the cutoff frequency
4371 * @param log2_phase_count log2 of the number of entries in the polyphase filterbank
4372 * @param linear if 1 then the used FIR filter will be linearly interpolated
4373 between the 2 closest, if 0 the closest will be used
4374 * @param cutoff cutoff frequency, 1.0 corresponds to half the output sampling rate
4375 * @return allocated ReSampleContext, NULL if error occurred
4377 attribute_deprecated
4378 ReSampleContext *av_audio_resample_init(int output_channels, int input_channels,
4379 int output_rate, int input_rate,
4380 enum AVSampleFormat sample_fmt_out,
4381 enum AVSampleFormat sample_fmt_in,
4382 int filter_length, int log2_phase_count,
4383 int linear, double cutoff);
4385 attribute_deprecated
4386 int audio_resample(ReSampleContext *s, short *output, short *input, int nb_samples);
4389 * Free resample context.
4391 * @param s a non-NULL pointer to a resample context previously
4392 * created with av_audio_resample_init()
4394 attribute_deprecated
4395 void audio_resample_close(ReSampleContext *s);
4399 * Initialize an audio resampler.
4400 * Note, if either rate is not an integer then simply scale both rates up so they are.
4401 * @param filter_length length of each FIR filter in the filterbank relative to the cutoff freq
4402 * @param log2_phase_count log2 of the number of entries in the polyphase filterbank
4403 * @param linear If 1 then the used FIR filter will be linearly interpolated
4404 between the 2 closest, if 0 the closest will be used
4405 * @param cutoff cutoff frequency, 1.0 corresponds to half the output sampling rate
4407 attribute_deprecated
4408 struct AVResampleContext *av_resample_init(int out_rate, int in_rate, int filter_length, int log2_phase_count, int linear, double cutoff);
4411 * Resample an array of samples using a previously configured context.
4412 * @param src an array of unconsumed samples
4413 * @param consumed the number of samples of src which have been consumed are returned here
4414 * @param src_size the number of unconsumed samples available
4415 * @param dst_size the amount of space in samples available in dst
4416 * @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.
4417 * @return the number of samples written in dst or -1 if an error occurred
4419 attribute_deprecated
4420 int av_resample(struct AVResampleContext *c, short *dst, short *src, int *consumed, int src_size, int dst_size, int update_ctx);
4424 * Compensate samplerate/timestamp drift. The compensation is done by changing
4425 * the resampler parameters, so no audible clicks or similar distortions occur
4426 * @param compensation_distance distance in output samples over which the compensation should be performed
4427 * @param sample_delta number of output samples which should be output less
4429 * example: av_resample_compensate(c, 10, 500)
4430 * here instead of 510 samples only 500 samples would be output
4432 * note, due to rounding the actual compensation might be slightly different,
4433 * especially if the compensation_distance is large and the in_rate used during init is small
4435 attribute_deprecated
4436 void av_resample_compensate(struct AVResampleContext *c, int sample_delta, int compensation_distance);
4437 attribute_deprecated
4438 void av_resample_close(struct AVResampleContext *c);
4446 * @addtogroup lavc_picture
4451 * Allocate memory for the pixels of a picture and setup the AVPicture
4454 * Call avpicture_free() to free it.
4456 * @param picture the picture structure to be filled in
4457 * @param pix_fmt the pixel format of the picture
4458 * @param width the width of the picture
4459 * @param height the height of the picture
4460 * @return zero if successful, a negative error code otherwise
4462 * @see av_image_alloc(), avpicture_fill()
4464 int avpicture_alloc(AVPicture *picture, enum AVPixelFormat pix_fmt, int width, int height);
4467 * Free a picture previously allocated by avpicture_alloc().
4468 * The data buffer used by the AVPicture is freed, but the AVPicture structure
4471 * @param picture the AVPicture to be freed
4473 void avpicture_free(AVPicture *picture);
4476 * Setup the picture fields based on the specified image parameters
4477 * and the provided image data buffer.
4479 * The picture fields are filled in by using the image data buffer
4480 * pointed to by ptr.
4482 * If ptr is NULL, the function will fill only the picture linesize
4483 * array and return the required size for the image buffer.
4485 * To allocate an image buffer and fill the picture data in one call,
4486 * use avpicture_alloc().
4488 * @param picture the picture to be filled in
4489 * @param ptr buffer where the image data is stored, or NULL
4490 * @param pix_fmt the pixel format of the image
4491 * @param width the width of the image in pixels
4492 * @param height the height of the image in pixels
4493 * @return the size in bytes required for src, a negative error code
4494 * in case of failure
4496 * @see av_image_fill_arrays()
4498 int avpicture_fill(AVPicture *picture, const uint8_t *ptr,
4499 enum AVPixelFormat pix_fmt, int width, int height);
4502 * Copy pixel data from an AVPicture into a buffer.
4504 * avpicture_get_size() can be used to compute the required size for
4505 * the buffer to fill.
4507 * @param src source picture with filled data
4508 * @param pix_fmt picture pixel format
4509 * @param width picture width
4510 * @param height picture height
4511 * @param dest destination buffer
4512 * @param dest_size destination buffer size in bytes
4513 * @return the number of bytes written to dest, or a negative value
4514 * (error code) on error, for example if the destination buffer is not
4517 * @see av_image_copy_to_buffer()
4519 int avpicture_layout(const AVPicture *src, enum AVPixelFormat pix_fmt,
4520 int width, int height,
4521 unsigned char *dest, int dest_size);
4524 * Calculate the size in bytes that a picture of the given width and height
4525 * would occupy if stored in the given picture format.
4527 * @param pix_fmt picture pixel format
4528 * @param width picture width
4529 * @param height picture height
4530 * @return the computed picture buffer size or a negative error code
4533 * @see av_image_get_buffer_size().
4535 int avpicture_get_size(enum AVPixelFormat pix_fmt, int width, int height);
4537 #if FF_API_DEINTERLACE
4539 * deinterlace - if not supported return -1
4541 * @deprecated - use yadif (in libavfilter) instead
4543 attribute_deprecated
4544 int avpicture_deinterlace(AVPicture *dst, const AVPicture *src,
4545 enum AVPixelFormat pix_fmt, int width, int height);
4548 * Copy image src to dst. Wraps av_image_copy().
4550 void av_picture_copy(AVPicture *dst, const AVPicture *src,
4551 enum AVPixelFormat pix_fmt, int width, int height);
4554 * Crop image top and left side.
4556 int av_picture_crop(AVPicture *dst, const AVPicture *src,
4557 enum AVPixelFormat pix_fmt, int top_band, int left_band);
4562 int av_picture_pad(AVPicture *dst, const AVPicture *src, int height, int width, enum AVPixelFormat pix_fmt,
4563 int padtop, int padbottom, int padleft, int padright, int *color);
4570 * @defgroup lavc_misc Utility functions
4573 * Miscellaneous utility functions related to both encoding and decoding
4579 * @defgroup lavc_misc_pixfmt Pixel formats
4581 * Functions for working with pixel formats.
4586 * Utility function to access log2_chroma_w log2_chroma_h from
4587 * the pixel format AVPixFmtDescriptor.
4589 * This function asserts that pix_fmt is valid. See av_pix_fmt_get_chroma_sub_sample
4590 * for one that returns a failure code and continues in case of invalid
4593 * @param[in] pix_fmt the pixel format
4594 * @param[out] h_shift store log2_chroma_w
4595 * @param[out] v_shift store log2_chroma_h
4597 * @see av_pix_fmt_get_chroma_sub_sample
4600 void avcodec_get_chroma_sub_sample(enum AVPixelFormat pix_fmt, int *h_shift, int *v_shift);
4603 * Return a value representing the fourCC code associated to the
4604 * pixel format pix_fmt, or 0 if no associated fourCC code can be
4607 unsigned int avcodec_pix_fmt_to_codec_tag(enum AVPixelFormat pix_fmt);
4609 #define FF_LOSS_RESOLUTION 0x0001 /**< loss due to resolution change */
4610 #define FF_LOSS_DEPTH 0x0002 /**< loss due to color depth change */
4611 #define FF_LOSS_COLORSPACE 0x0004 /**< loss due to color space conversion */
4612 #define FF_LOSS_ALPHA 0x0008 /**< loss of alpha bits */
4613 #define FF_LOSS_COLORQUANT 0x0010 /**< loss due to color quantization */
4614 #define FF_LOSS_CHROMA 0x0020 /**< loss of chroma (e.g. RGB to gray conversion) */
4617 * Compute what kind of losses will occur when converting from one specific
4618 * pixel format to another.
4619 * When converting from one pixel format to another, information loss may occur.
4620 * For example, when converting from RGB24 to GRAY, the color information will
4621 * be lost. Similarly, other losses occur when converting from some formats to
4622 * other formats. These losses can involve loss of chroma, but also loss of
4623 * resolution, loss of color depth, loss due to the color space conversion, loss
4624 * of the alpha bits or loss due to color quantization.
4625 * avcodec_get_fix_fmt_loss() informs you about the various types of losses
4626 * which will occur when converting from one pixel format to another.
4628 * @param[in] dst_pix_fmt destination pixel format
4629 * @param[in] src_pix_fmt source pixel format
4630 * @param[in] has_alpha Whether the source pixel format alpha channel is used.
4631 * @return Combination of flags informing you what kind of losses will occur
4632 * (maximum loss for an invalid dst_pix_fmt).
4634 int avcodec_get_pix_fmt_loss(enum AVPixelFormat dst_pix_fmt, enum AVPixelFormat src_pix_fmt,
4638 * Find the best pixel format to convert to given a certain source pixel
4639 * format. When converting from one pixel format to another, information loss
4640 * may occur. For example, when converting from RGB24 to GRAY, the color
4641 * information will be lost. Similarly, other losses occur when converting from
4642 * some formats to other formats. avcodec_find_best_pix_fmt_of_2() searches which of
4643 * the given pixel formats should be used to suffer the least amount of loss.
4644 * The pixel formats from which it chooses one, are determined by the
4645 * pix_fmt_list parameter.
4648 * @param[in] pix_fmt_list AV_PIX_FMT_NONE terminated array of pixel formats to choose from
4649 * @param[in] src_pix_fmt source pixel format
4650 * @param[in] has_alpha Whether the source pixel format alpha channel is used.
4651 * @param[out] loss_ptr Combination of flags informing you what kind of losses will occur.
4652 * @return The best pixel format to convert to or -1 if none was found.
4654 enum AVPixelFormat avcodec_find_best_pix_fmt_of_list(const enum AVPixelFormat *pix_fmt_list,
4655 enum AVPixelFormat src_pix_fmt,
4656 int has_alpha, int *loss_ptr);
4659 * Find the best pixel format to convert to given a certain source pixel
4660 * format and a selection of two destination pixel formats. When converting from
4661 * one pixel format to another, information loss may occur. For example, when converting
4662 * from RGB24 to GRAY, the color information will be lost. Similarly, other losses occur when
4663 * converting from some formats to other formats. avcodec_find_best_pix_fmt_of_2() selects which of
4664 * the given pixel formats should be used to suffer the least amount of loss.
4666 * If one of the destination formats is AV_PIX_FMT_NONE the other pixel format (if valid) will be
4670 * src_pix_fmt = AV_PIX_FMT_YUV420P;
4671 * dst_pix_fmt1= AV_PIX_FMT_RGB24;
4672 * dst_pix_fmt2= AV_PIX_FMT_GRAY8;
4673 * dst_pix_fmt3= AV_PIX_FMT_RGB8;
4674 * loss= FF_LOSS_CHROMA; // don't care about chroma loss, so chroma loss will be ignored.
4675 * dst_pix_fmt = avcodec_find_best_pix_fmt_of_2(dst_pix_fmt1, dst_pix_fmt2, src_pix_fmt, alpha, &loss);
4676 * dst_pix_fmt = avcodec_find_best_pix_fmt_of_2(dst_pix_fmt, dst_pix_fmt3, src_pix_fmt, alpha, &loss);
4679 * @param[in] dst_pix_fmt1 One of the two destination pixel formats to choose from
4680 * @param[in] dst_pix_fmt2 The other of the two destination pixel formats to choose from
4681 * @param[in] src_pix_fmt Source pixel format
4682 * @param[in] has_alpha Whether the source pixel format alpha channel is used.
4683 * @param[in, out] loss_ptr Combination of loss flags. In: selects which of the losses to ignore, i.e.
4684 * NULL or value of zero means we care about all losses. Out: the loss
4685 * that occurs when converting from src to selected dst pixel format.
4686 * @return The best pixel format to convert to or -1 if none was found.
4688 enum AVPixelFormat avcodec_find_best_pix_fmt_of_2(enum AVPixelFormat dst_pix_fmt1, enum AVPixelFormat dst_pix_fmt2,
4689 enum AVPixelFormat src_pix_fmt, int has_alpha, int *loss_ptr);
4691 attribute_deprecated
4692 #if AV_HAVE_INCOMPATIBLE_LIBAV_ABI
4693 enum AVPixelFormat avcodec_find_best_pix_fmt2(const enum AVPixelFormat *pix_fmt_list,
4694 enum AVPixelFormat src_pix_fmt,
4695 int has_alpha, int *loss_ptr);
4697 enum AVPixelFormat avcodec_find_best_pix_fmt2(enum AVPixelFormat dst_pix_fmt1, enum AVPixelFormat dst_pix_fmt2,
4698 enum AVPixelFormat src_pix_fmt, int has_alpha, int *loss_ptr);
4702 enum AVPixelFormat avcodec_default_get_format(struct AVCodecContext *s, const enum AVPixelFormat * fmt);
4708 #if FF_API_SET_DIMENSIONS
4710 * @deprecated this function is not supposed to be used from outside of lavc
4712 attribute_deprecated
4713 void avcodec_set_dimensions(AVCodecContext *s, int width, int height);
4717 * Put a string representing the codec tag codec_tag in buf.
4719 * @param buf_size size in bytes of buf
4720 * @return the length of the string that would have been generated if
4721 * enough space had been available, excluding the trailing null
4723 size_t av_get_codec_tag_string(char *buf, size_t buf_size, unsigned int codec_tag);
4725 void avcodec_string(char *buf, int buf_size, AVCodecContext *enc, int encode);
4728 * Return a name for the specified profile, if available.
4730 * @param codec the codec that is searched for the given profile
4731 * @param profile the profile value for which a name is requested
4732 * @return A name for the profile if found, NULL otherwise.
4734 const char *av_get_profile_name(const AVCodec *codec, int profile);
4736 int avcodec_default_execute(AVCodecContext *c, int (*func)(AVCodecContext *c2, void *arg2),void *arg, int *ret, int count, int size);
4737 int avcodec_default_execute2(AVCodecContext *c, int (*func)(AVCodecContext *c2, void *arg2, int, int),void *arg, int *ret, int count);
4738 //FIXME func typedef
4741 * Fill AVFrame audio data and linesize pointers.
4743 * The buffer buf must be a preallocated buffer with a size big enough
4744 * to contain the specified samples amount. The filled AVFrame data
4745 * pointers will point to this buffer.
4747 * AVFrame extended_data channel pointers are allocated if necessary for
4750 * @param frame the AVFrame
4751 * frame->nb_samples must be set prior to calling the
4752 * function. This function fills in frame->data,
4753 * frame->extended_data, frame->linesize[0].
4754 * @param nb_channels channel count
4755 * @param sample_fmt sample format
4756 * @param buf buffer to use for frame data
4757 * @param buf_size size of buffer
4758 * @param align plane size sample alignment (0 = default)
4759 * @return >=0 on success, negative error code on failure
4760 * @todo return the size in bytes required to store the samples in
4761 * case of success, at the next libavutil bump
4763 int avcodec_fill_audio_frame(AVFrame *frame, int nb_channels,
4764 enum AVSampleFormat sample_fmt, const uint8_t *buf,
4765 int buf_size, int align);
4768 * Reset the internal decoder state / flush internal buffers. Should be called
4769 * e.g. when seeking or when switching to a different stream.
4771 * @note when refcounted frames are not used (i.e. avctx->refcounted_frames is 0),
4772 * this invalidates the frames previously returned from the decoder. When
4773 * refcounted frames are used, the decoder just releases any references it might
4774 * keep internally, but the caller's reference remains valid.
4776 void avcodec_flush_buffers(AVCodecContext *avctx);
4779 * Return codec bits per sample.
4781 * @param[in] codec_id the codec
4782 * @return Number of bits per sample or zero if unknown for the given codec.
4784 int av_get_bits_per_sample(enum AVCodecID codec_id);
4787 * Return the PCM codec associated with a sample format.
4788 * @param be endianness, 0 for little, 1 for big,
4789 * -1 (or anything else) for native
4790 * @return AV_CODEC_ID_PCM_* or AV_CODEC_ID_NONE
4792 enum AVCodecID av_get_pcm_codec(enum AVSampleFormat fmt, int be);
4795 * Return codec bits per sample.
4796 * Only return non-zero if the bits per sample is exactly correct, not an
4799 * @param[in] codec_id the codec
4800 * @return Number of bits per sample or zero if unknown for the given codec.
4802 int av_get_exact_bits_per_sample(enum AVCodecID codec_id);
4805 * Return audio frame duration.
4807 * @param avctx codec context
4808 * @param frame_bytes size of the frame, or 0 if unknown
4809 * @return frame duration, in samples, if known. 0 if not able to
4812 int av_get_audio_frame_duration(AVCodecContext *avctx, int frame_bytes);
4815 typedef struct AVBitStreamFilterContext {
4817 struct AVBitStreamFilter *filter;
4818 AVCodecParserContext *parser;
4819 struct AVBitStreamFilterContext *next;
4820 } AVBitStreamFilterContext;
4823 typedef struct AVBitStreamFilter {
4826 int (*filter)(AVBitStreamFilterContext *bsfc,
4827 AVCodecContext *avctx, const char *args,
4828 uint8_t **poutbuf, int *poutbuf_size,
4829 const uint8_t *buf, int buf_size, int keyframe);
4830 void (*close)(AVBitStreamFilterContext *bsfc);
4831 struct AVBitStreamFilter *next;
4832 } AVBitStreamFilter;
4835 * Register a bitstream filter.
4837 * The filter will be accessible to the application code through
4838 * av_bitstream_filter_next() or can be directly initialized with
4839 * av_bitstream_filter_init().
4841 * @see avcodec_register_all()
4843 void av_register_bitstream_filter(AVBitStreamFilter *bsf);
4846 * Create and initialize a bitstream filter context given a bitstream
4849 * The returned context must be freed with av_bitstream_filter_close().
4851 * @param name the name of the bitstream filter
4852 * @return a bitstream filter context if a matching filter was found
4853 * and successfully initialized, NULL otherwise
4855 AVBitStreamFilterContext *av_bitstream_filter_init(const char *name);
4860 * This function filters the buffer buf with size buf_size, and places the
4861 * filtered buffer in the buffer pointed to by poutbuf.
4863 * The output buffer must be freed by the caller.
4865 * @param bsfc bitstream filter context created by av_bitstream_filter_init()
4866 * @param avctx AVCodecContext accessed by the filter, may be NULL.
4867 * If specified, this must point to the encoder context of the
4868 * output stream the packet is sent to.
4869 * @param args arguments which specify the filter configuration, may be NULL
4870 * @param poutbuf pointer which is updated to point to the filtered buffer
4871 * @param poutbuf_size pointer which is updated to the filtered buffer size in bytes
4872 * @param buf buffer containing the data to filter
4873 * @param buf_size size in bytes of buf
4874 * @param keyframe set to non-zero if the buffer to filter corresponds to a key-frame packet data
4875 * @return >= 0 in case of success, or a negative error code in case of failure
4877 * If the return value is positive, an output buffer is allocated and
4878 * is availble in *poutbuf, and is distinct from the input buffer.
4880 * If the return value is 0, the output buffer is not allocated and
4881 * should be considered identical to the input buffer, or in case
4882 * *poutbuf was set it points to the input buffer (not necessarily to
4883 * its starting address).
4885 int av_bitstream_filter_filter(AVBitStreamFilterContext *bsfc,
4886 AVCodecContext *avctx, const char *args,
4887 uint8_t **poutbuf, int *poutbuf_size,
4888 const uint8_t *buf, int buf_size, int keyframe);
4891 * Release bitstream filter context.
4893 * @param bsf the bitstream filter context created with
4894 * av_bitstream_filter_init(), can be NULL
4896 void av_bitstream_filter_close(AVBitStreamFilterContext *bsf);
4899 * If f is NULL, return the first registered bitstream filter,
4900 * if f is non-NULL, return the next registered bitstream filter
4901 * after f, or NULL if f is the last one.
4903 * This function can be used to iterate over all registered bitstream
4906 AVBitStreamFilter *av_bitstream_filter_next(AVBitStreamFilter *f);
4911 * Reallocate the given block if it is not large enough, otherwise do nothing.
4915 void *av_fast_realloc(void *ptr, unsigned int *size, size_t min_size);
4918 * Allocate a buffer, reusing the given one if large enough.
4920 * Contrary to av_fast_realloc the current buffer contents might not be
4921 * preserved and on error the old buffer is freed, thus no special
4922 * handling to avoid memleaks is necessary.
4924 * @param ptr pointer to pointer to already allocated buffer, overwritten with pointer to new buffer
4925 * @param size size of the buffer *ptr points to
4926 * @param min_size minimum size of *ptr buffer after returning, *ptr will be NULL and
4927 * *size 0 if an error occurred.
4929 void av_fast_malloc(void *ptr, unsigned int *size, size_t min_size);
4932 * Same behaviour av_fast_malloc but the buffer has additional
4933 * FF_INPUT_BUFFER_PADDING_SIZE at the end which will always be 0.
4935 * In addition the whole buffer will initially and after resizes
4936 * be 0-initialized so that no uninitialized data will ever appear.
4938 void av_fast_padded_malloc(void *ptr, unsigned int *size, size_t min_size);
4941 * Same behaviour av_fast_padded_malloc except that buffer will always
4942 * be 0-initialized after call.
4944 void av_fast_padded_mallocz(void *ptr, unsigned int *size, size_t min_size);
4947 * Encode extradata length to a buffer. Used by xiph codecs.
4949 * @param s buffer to write to; must be at least (v/255+1) bytes long
4950 * @param v size of extradata in bytes
4951 * @return number of bytes written to the buffer.
4953 unsigned int av_xiphlacing(unsigned char *s, unsigned int v);
4955 #if FF_API_MISSING_SAMPLE
4957 * Log a generic warning message about a missing feature. This function is
4958 * intended to be used internally by FFmpeg (libavcodec, libavformat, etc.)
4959 * only, and would normally not be used by applications.
4960 * @param[in] avc a pointer to an arbitrary struct of which the first field is
4961 * a pointer to an AVClass struct
4962 * @param[in] feature string containing the name of the missing feature
4963 * @param[in] want_sample indicates if samples are wanted which exhibit this feature.
4964 * If want_sample is non-zero, additional verbage will be added to the log
4965 * message which tells the user how to report samples to the development
4967 * @deprecated Use avpriv_report_missing_feature() instead.
4969 attribute_deprecated
4970 void av_log_missing_feature(void *avc, const char *feature, int want_sample);
4973 * Log a generic warning message asking for a sample. This function is
4974 * intended to be used internally by FFmpeg (libavcodec, libavformat, etc.)
4975 * only, and would normally not be used by applications.
4976 * @param[in] avc a pointer to an arbitrary struct of which the first field is
4977 * a pointer to an AVClass struct
4978 * @param[in] msg string containing an optional message, or NULL if no message
4979 * @deprecated Use avpriv_request_sample() instead.
4981 attribute_deprecated
4982 void av_log_ask_for_sample(void *avc, const char *msg, ...) av_printf_format(2, 3);
4983 #endif /* FF_API_MISSING_SAMPLE */
4986 * Register the hardware accelerator hwaccel.
4988 void av_register_hwaccel(AVHWAccel *hwaccel);
4991 * If hwaccel is NULL, returns the first registered hardware accelerator,
4992 * if hwaccel is non-NULL, returns the next registered hardware accelerator
4993 * after hwaccel, or NULL if hwaccel is the last one.
4995 AVHWAccel *av_hwaccel_next(AVHWAccel *hwaccel);
4999 * Lock operation used by lockmgr
5002 AV_LOCK_CREATE, ///< Create a mutex
5003 AV_LOCK_OBTAIN, ///< Lock the mutex
5004 AV_LOCK_RELEASE, ///< Unlock the mutex
5005 AV_LOCK_DESTROY, ///< Free mutex resources
5009 * Register a user provided lock manager supporting the operations
5010 * specified by AVLockOp. mutex points to a (void *) where the
5011 * lockmgr should store/get a pointer to a user allocated mutex. It's
5012 * NULL upon AV_LOCK_CREATE and != NULL for all other ops.
5014 * @param cb User defined callback. Note: FFmpeg may invoke calls to this
5015 * callback during the call to av_lockmgr_register().
5016 * Thus, the application must be prepared to handle that.
5017 * If cb is set to NULL the lockmgr will be unregistered.
5018 * Also note that during unregistration the previously registered
5019 * lockmgr callback may also be invoked.
5021 int av_lockmgr_register(int (*cb)(void **mutex, enum AVLockOp op));
5024 * Get the type of the given codec.
5026 enum AVMediaType avcodec_get_type(enum AVCodecID codec_id);
5029 * Get the name of a codec.
5030 * @return a static string identifying the codec; never NULL
5032 const char *avcodec_get_name(enum AVCodecID id);
5035 * @return a positive value if s is open (i.e. avcodec_open2() was called on it
5036 * with no corresponding avcodec_close()), 0 otherwise.
5038 int avcodec_is_open(AVCodecContext *s);
5041 * @return a non-zero number if codec is an encoder, zero otherwise
5043 int av_codec_is_encoder(const AVCodec *codec);
5046 * @return a non-zero number if codec is a decoder, zero otherwise
5048 int av_codec_is_decoder(const AVCodec *codec);
5051 * @return descriptor for given codec ID or NULL if no descriptor exists.
5053 const AVCodecDescriptor *avcodec_descriptor_get(enum AVCodecID id);
5056 * Iterate over all codec descriptors known to libavcodec.
5058 * @param prev previous descriptor. NULL to get the first descriptor.
5060 * @return next descriptor or NULL after the last descriptor
5062 const AVCodecDescriptor *avcodec_descriptor_next(const AVCodecDescriptor *prev);
5065 * @return codec descriptor with the given name or NULL if no such descriptor
5068 const AVCodecDescriptor *avcodec_descriptor_get_by_name(const char *name);
5074 #endif /* AVCODEC_AVCODEC_H */