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,
280 AV_CODEC_ID_BRENDER_PIX= MKBETAG('B','P','I','X'),
281 AV_CODEC_ID_Y41P = MKBETAG('Y','4','1','P'),
282 AV_CODEC_ID_ESCAPE130 = MKBETAG('E','1','3','0'),
283 AV_CODEC_ID_EXR = MKBETAG('0','E','X','R'),
284 AV_CODEC_ID_AVRP = MKBETAG('A','V','R','P'),
286 AV_CODEC_ID_012V = MKBETAG('0','1','2','V'),
287 AV_CODEC_ID_G2M = MKBETAG( 0 ,'G','2','M'),
288 AV_CODEC_ID_AVUI = MKBETAG('A','V','U','I'),
289 AV_CODEC_ID_AYUV = MKBETAG('A','Y','U','V'),
290 AV_CODEC_ID_TARGA_Y216 = MKBETAG('T','2','1','6'),
291 AV_CODEC_ID_V308 = MKBETAG('V','3','0','8'),
292 AV_CODEC_ID_V408 = MKBETAG('V','4','0','8'),
293 AV_CODEC_ID_YUV4 = MKBETAG('Y','U','V','4'),
294 AV_CODEC_ID_SANM = MKBETAG('S','A','N','M'),
295 AV_CODEC_ID_PAF_VIDEO = MKBETAG('P','A','F','V'),
296 AV_CODEC_ID_AVRN = MKBETAG('A','V','R','n'),
297 AV_CODEC_ID_CPIA = MKBETAG('C','P','I','A'),
298 AV_CODEC_ID_XFACE = MKBETAG('X','F','A','C'),
299 AV_CODEC_ID_SGIRLE = MKBETAG('S','G','I','R'),
300 AV_CODEC_ID_MVC1 = MKBETAG('M','V','C','1'),
301 AV_CODEC_ID_MVC2 = MKBETAG('M','V','C','2'),
302 AV_CODEC_ID_SNOW = MKBETAG('S','N','O','W'),
303 AV_CODEC_ID_WEBP = MKBETAG('W','E','B','P'),
304 AV_CODEC_ID_SMVJPEG = MKBETAG('S','M','V','J'),
305 AV_CODEC_ID_H265 = MKBETAG('H','2','6','5'),
307 /* various PCM "codecs" */
308 AV_CODEC_ID_FIRST_AUDIO = 0x10000, ///< A dummy id pointing at the start of audio codecs
309 AV_CODEC_ID_PCM_S16LE = 0x10000,
310 AV_CODEC_ID_PCM_S16BE,
311 AV_CODEC_ID_PCM_U16LE,
312 AV_CODEC_ID_PCM_U16BE,
315 AV_CODEC_ID_PCM_MULAW,
316 AV_CODEC_ID_PCM_ALAW,
317 AV_CODEC_ID_PCM_S32LE,
318 AV_CODEC_ID_PCM_S32BE,
319 AV_CODEC_ID_PCM_U32LE,
320 AV_CODEC_ID_PCM_U32BE,
321 AV_CODEC_ID_PCM_S24LE,
322 AV_CODEC_ID_PCM_S24BE,
323 AV_CODEC_ID_PCM_U24LE,
324 AV_CODEC_ID_PCM_U24BE,
325 AV_CODEC_ID_PCM_S24DAUD,
326 AV_CODEC_ID_PCM_ZORK,
327 AV_CODEC_ID_PCM_S16LE_PLANAR,
329 AV_CODEC_ID_PCM_F32BE,
330 AV_CODEC_ID_PCM_F32LE,
331 AV_CODEC_ID_PCM_F64BE,
332 AV_CODEC_ID_PCM_F64LE,
333 AV_CODEC_ID_PCM_BLURAY,
336 AV_CODEC_ID_PCM_S8_PLANAR,
337 AV_CODEC_ID_PCM_S24LE_PLANAR_DEPRECATED,
338 AV_CODEC_ID_PCM_S32LE_PLANAR_DEPRECATED,
339 AV_CODEC_ID_PCM_S24LE_PLANAR = MKBETAG(24,'P','S','P'),
340 AV_CODEC_ID_PCM_S32LE_PLANAR = MKBETAG(32,'P','S','P'),
341 AV_CODEC_ID_PCM_S16BE_PLANAR = MKBETAG('P','S','P',16),
343 /* various ADPCM codecs */
344 AV_CODEC_ID_ADPCM_IMA_QT = 0x11000,
345 AV_CODEC_ID_ADPCM_IMA_WAV,
346 AV_CODEC_ID_ADPCM_IMA_DK3,
347 AV_CODEC_ID_ADPCM_IMA_DK4,
348 AV_CODEC_ID_ADPCM_IMA_WS,
349 AV_CODEC_ID_ADPCM_IMA_SMJPEG,
350 AV_CODEC_ID_ADPCM_MS,
351 AV_CODEC_ID_ADPCM_4XM,
352 AV_CODEC_ID_ADPCM_XA,
353 AV_CODEC_ID_ADPCM_ADX,
354 AV_CODEC_ID_ADPCM_EA,
355 AV_CODEC_ID_ADPCM_G726,
356 AV_CODEC_ID_ADPCM_CT,
357 AV_CODEC_ID_ADPCM_SWF,
358 AV_CODEC_ID_ADPCM_YAMAHA,
359 AV_CODEC_ID_ADPCM_SBPRO_4,
360 AV_CODEC_ID_ADPCM_SBPRO_3,
361 AV_CODEC_ID_ADPCM_SBPRO_2,
362 AV_CODEC_ID_ADPCM_THP,
363 AV_CODEC_ID_ADPCM_IMA_AMV,
364 AV_CODEC_ID_ADPCM_EA_R1,
365 AV_CODEC_ID_ADPCM_EA_R3,
366 AV_CODEC_ID_ADPCM_EA_R2,
367 AV_CODEC_ID_ADPCM_IMA_EA_SEAD,
368 AV_CODEC_ID_ADPCM_IMA_EA_EACS,
369 AV_CODEC_ID_ADPCM_EA_XAS,
370 AV_CODEC_ID_ADPCM_EA_MAXIS_XA,
371 AV_CODEC_ID_ADPCM_IMA_ISS,
372 AV_CODEC_ID_ADPCM_G722,
373 AV_CODEC_ID_ADPCM_IMA_APC,
374 AV_CODEC_ID_VIMA = MKBETAG('V','I','M','A'),
375 AV_CODEC_ID_ADPCM_AFC = MKBETAG('A','F','C',' '),
376 AV_CODEC_ID_ADPCM_IMA_OKI = MKBETAG('O','K','I',' '),
377 AV_CODEC_ID_ADPCM_DTK = MKBETAG('D','T','K',' '),
378 AV_CODEC_ID_ADPCM_IMA_RAD = MKBETAG('R','A','D',' '),
381 AV_CODEC_ID_AMR_NB = 0x12000,
384 /* RealAudio codecs*/
385 AV_CODEC_ID_RA_144 = 0x13000,
388 /* various DPCM codecs */
389 AV_CODEC_ID_ROQ_DPCM = 0x14000,
390 AV_CODEC_ID_INTERPLAY_DPCM,
391 AV_CODEC_ID_XAN_DPCM,
392 AV_CODEC_ID_SOL_DPCM,
395 AV_CODEC_ID_MP2 = 0x15000,
396 AV_CODEC_ID_MP3, ///< preferred ID for decoding MPEG audio layer 1, 2 or 3
406 AV_CODEC_ID_VMDAUDIO,
412 AV_CODEC_ID_WESTWOOD_SND1,
413 AV_CODEC_ID_GSM, ///< as in Berlin toast format
416 AV_CODEC_ID_TRUESPEECH,
418 AV_CODEC_ID_SMACKAUDIO,
421 AV_CODEC_ID_DSICINAUDIO,
423 AV_CODEC_ID_MUSEPACK7,
425 AV_CODEC_ID_GSM_MS, /* as found in WAV */
431 AV_CODEC_ID_NELLYMOSER,
432 AV_CODEC_ID_MUSEPACK8,
434 AV_CODEC_ID_WMAVOICE,
436 AV_CODEC_ID_WMALOSSLESS,
445 AV_CODEC_ID_BINKAUDIO_RDFT,
446 AV_CODEC_ID_BINKAUDIO_DCT,
447 AV_CODEC_ID_AAC_LATM,
452 AV_CODEC_ID_8SVX_EXP,
453 AV_CODEC_ID_8SVX_FIB,
454 AV_CODEC_ID_BMV_AUDIO,
458 AV_CODEC_ID_OPUS_DEPRECATED,
459 AV_CODEC_ID_COMFORT_NOISE,
460 AV_CODEC_ID_TAK_DEPRECATED,
461 AV_CODEC_ID_METASOUND,
462 AV_CODEC_ID_FFWAVESYNTH = MKBETAG('F','F','W','S'),
463 AV_CODEC_ID_SONIC = MKBETAG('S','O','N','C'),
464 AV_CODEC_ID_SONIC_LS = MKBETAG('S','O','N','L'),
465 AV_CODEC_ID_PAF_AUDIO = MKBETAG('P','A','F','A'),
466 AV_CODEC_ID_OPUS = MKBETAG('O','P','U','S'),
467 AV_CODEC_ID_TAK = MKBETAG('t','B','a','K'),
468 AV_CODEC_ID_EVRC = MKBETAG('s','e','v','c'),
469 AV_CODEC_ID_SMV = MKBETAG('s','s','m','v'),
471 /* subtitle codecs */
472 AV_CODEC_ID_FIRST_SUBTITLE = 0x17000, ///< A dummy ID pointing at the start of subtitle codecs.
473 AV_CODEC_ID_DVD_SUBTITLE = 0x17000,
474 AV_CODEC_ID_DVB_SUBTITLE,
475 AV_CODEC_ID_TEXT, ///< raw UTF-8 text
478 AV_CODEC_ID_MOV_TEXT,
479 AV_CODEC_ID_HDMV_PGS_SUBTITLE,
480 AV_CODEC_ID_DVB_TELETEXT,
482 AV_CODEC_ID_MICRODVD = MKBETAG('m','D','V','D'),
483 AV_CODEC_ID_EIA_608 = MKBETAG('c','6','0','8'),
484 AV_CODEC_ID_JACOSUB = MKBETAG('J','S','U','B'),
485 AV_CODEC_ID_SAMI = MKBETAG('S','A','M','I'),
486 AV_CODEC_ID_REALTEXT = MKBETAG('R','T','X','T'),
487 AV_CODEC_ID_SUBVIEWER1 = MKBETAG('S','b','V','1'),
488 AV_CODEC_ID_SUBVIEWER = MKBETAG('S','u','b','V'),
489 AV_CODEC_ID_SUBRIP = MKBETAG('S','R','i','p'),
490 AV_CODEC_ID_WEBVTT = MKBETAG('W','V','T','T'),
491 AV_CODEC_ID_MPL2 = MKBETAG('M','P','L','2'),
492 AV_CODEC_ID_VPLAYER = MKBETAG('V','P','l','r'),
493 AV_CODEC_ID_PJS = MKBETAG('P','h','J','S'),
494 AV_CODEC_ID_ASS = MKBETAG('A','S','S',' '), ///< ASS as defined in Matroska
496 /* other specific kind of codecs (generally used for attachments) */
497 AV_CODEC_ID_FIRST_UNKNOWN = 0x18000, ///< A dummy ID pointing at the start of various fake codecs.
498 AV_CODEC_ID_TTF = 0x18000,
499 AV_CODEC_ID_BINTEXT = MKBETAG('B','T','X','T'),
500 AV_CODEC_ID_XBIN = MKBETAG('X','B','I','N'),
501 AV_CODEC_ID_IDF = MKBETAG( 0 ,'I','D','F'),
502 AV_CODEC_ID_OTF = MKBETAG( 0 ,'O','T','F'),
503 AV_CODEC_ID_SMPTE_KLV = MKBETAG('K','L','V','A'),
504 AV_CODEC_ID_DVD_NAV = MKBETAG('D','N','A','V'),
507 AV_CODEC_ID_PROBE = 0x19000, ///< codec_id is not known (like AV_CODEC_ID_NONE) but lavf should attempt to identify it
509 AV_CODEC_ID_MPEG2TS = 0x20000, /**< _FAKE_ codec to indicate a raw MPEG-2 TS
510 * stream (only used by libavformat) */
511 AV_CODEC_ID_MPEG4SYSTEMS = 0x20001, /**< _FAKE_ codec to indicate a MPEG-4 Systems
512 * stream (only used by libavformat) */
513 AV_CODEC_ID_FFMETADATA = 0x21000, ///< Dummy codec for streams containing only metadata information.
516 #include "old_codec_ids.h"
521 * This struct describes the properties of a single codec described by an
523 * @see avcodec_get_descriptor()
525 typedef struct AVCodecDescriptor {
527 enum AVMediaType type;
529 * Name of the codec described by this descriptor. It is non-empty and
530 * unique for each codec descriptor. It should contain alphanumeric
531 * characters and '_' only.
535 * A more descriptive name for this codec. May be NULL.
537 const char *long_name;
539 * Codec properties, a combination of AV_CODEC_PROP_* flags.
545 * Codec uses only intra compression.
548 #define AV_CODEC_PROP_INTRA_ONLY (1 << 0)
550 * Codec supports lossy compression. Audio and video codecs only.
551 * @note a codec may support both lossy and lossless
554 #define AV_CODEC_PROP_LOSSY (1 << 1)
556 * Codec supports lossless compression. Audio and video codecs only.
558 #define AV_CODEC_PROP_LOSSLESS (1 << 2)
560 * Subtitle codec is bitmap based
561 * Decoded AVSubtitle data can be read from the AVSubtitleRect->pict field.
563 #define AV_CODEC_PROP_BITMAP_SUB (1 << 16)
565 * Subtitle codec is text based.
566 * Decoded AVSubtitle data can be read from the AVSubtitleRect->ass field.
568 #define AV_CODEC_PROP_TEXT_SUB (1 << 17)
571 * @ingroup lavc_decoding
572 * Required number of additionally allocated bytes at the end of the input bitstream for decoding.
573 * This is mainly needed because some optimized bitstream readers read
574 * 32 or 64 bit at once and could read over the end.<br>
575 * Note: If the first 23 bits of the additional bytes are not 0, then damaged
576 * MPEG bitstreams could cause overread and segfault.
578 #define FF_INPUT_BUFFER_PADDING_SIZE 16
581 * @ingroup lavc_encoding
582 * minimum encoding buffer size
583 * Used to avoid some checks during header writing.
585 #define FF_MIN_BUFFER_SIZE 16384
589 * @ingroup lavc_encoding
590 * motion estimation type.
593 ME_ZERO = 1, ///< no search, that is use 0,0 vector whenever one is needed
597 ME_EPZS, ///< enhanced predictive zonal search
598 ME_X1, ///< reserved for experiments
599 ME_HEX, ///< hexagon based search
600 ME_UMH, ///< uneven multi-hexagon search
601 ME_TESA, ///< transformed exhaustive search algorithm
602 ME_ITER=50, ///< iterative search
606 * @ingroup lavc_decoding
609 /* We leave some space between them for extensions (drop some
610 * keyframes for intra-only or drop just some bidir frames). */
611 AVDISCARD_NONE =-16, ///< discard nothing
612 AVDISCARD_DEFAULT = 0, ///< discard useless packets like 0 size packets in avi
613 AVDISCARD_NONREF = 8, ///< discard all non reference
614 AVDISCARD_BIDIR = 16, ///< discard all bidirectional frames
615 AVDISCARD_NONKEY = 32, ///< discard all frames except keyframes
616 AVDISCARD_ALL = 48, ///< discard all
619 enum AVColorPrimaries{
620 AVCOL_PRI_BT709 = 1, ///< also ITU-R BT1361 / IEC 61966-2-4 / SMPTE RP177 Annex B
621 AVCOL_PRI_UNSPECIFIED = 2,
622 AVCOL_PRI_BT470M = 4,
623 AVCOL_PRI_BT470BG = 5, ///< also ITU-R BT601-6 625 / ITU-R BT1358 625 / ITU-R BT1700 625 PAL & SECAM
624 AVCOL_PRI_SMPTE170M = 6, ///< also ITU-R BT601-6 525 / ITU-R BT1358 525 / ITU-R BT1700 NTSC
625 AVCOL_PRI_SMPTE240M = 7, ///< functionally identical to above
627 AVCOL_PRI_NB , ///< Not part of ABI
630 enum AVColorTransferCharacteristic{
631 AVCOL_TRC_BT709 = 1, ///< also ITU-R BT1361
632 AVCOL_TRC_UNSPECIFIED = 2,
633 AVCOL_TRC_GAMMA22 = 4, ///< also ITU-R BT470M / ITU-R BT1700 625 PAL & SECAM
634 AVCOL_TRC_GAMMA28 = 5, ///< also ITU-R BT470BG
635 AVCOL_TRC_SMPTE240M = 7,
636 AVCOL_TRC_NB , ///< Not part of ABI
640 * X X 3 4 X X are luma samples,
641 * 1 2 1-6 are possible chroma positions
642 * X X 5 6 X 0 is undefined/unknown position
644 enum AVChromaLocation{
645 AVCHROMA_LOC_UNSPECIFIED = 0,
646 AVCHROMA_LOC_LEFT = 1, ///< mpeg2/4, h264 default
647 AVCHROMA_LOC_CENTER = 2, ///< mpeg1, jpeg, h263
648 AVCHROMA_LOC_TOPLEFT = 3, ///< DV
649 AVCHROMA_LOC_TOP = 4,
650 AVCHROMA_LOC_BOTTOMLEFT = 5,
651 AVCHROMA_LOC_BOTTOM = 6,
652 AVCHROMA_LOC_NB , ///< Not part of ABI
655 enum AVAudioServiceType {
656 AV_AUDIO_SERVICE_TYPE_MAIN = 0,
657 AV_AUDIO_SERVICE_TYPE_EFFECTS = 1,
658 AV_AUDIO_SERVICE_TYPE_VISUALLY_IMPAIRED = 2,
659 AV_AUDIO_SERVICE_TYPE_HEARING_IMPAIRED = 3,
660 AV_AUDIO_SERVICE_TYPE_DIALOGUE = 4,
661 AV_AUDIO_SERVICE_TYPE_COMMENTARY = 5,
662 AV_AUDIO_SERVICE_TYPE_EMERGENCY = 6,
663 AV_AUDIO_SERVICE_TYPE_VOICE_OVER = 7,
664 AV_AUDIO_SERVICE_TYPE_KARAOKE = 8,
665 AV_AUDIO_SERVICE_TYPE_NB , ///< Not part of ABI
669 * @ingroup lavc_encoding
671 typedef struct RcOverride{
674 int qscale; // If this is 0 then quality_factor will be used instead.
675 float quality_factor;
678 #define FF_MAX_B_FRAMES 16
681 These flags can be passed in AVCodecContext.flags before initialization.
682 Note: Not everything is supported yet.
686 * Allow decoders to produce frames with data planes that are not aligned
687 * to CPU requirements (e.g. due to cropping).
689 #define CODEC_FLAG_UNALIGNED 0x0001
690 #define CODEC_FLAG_QSCALE 0x0002 ///< Use fixed qscale.
691 #define CODEC_FLAG_4MV 0x0004 ///< 4 MV per MB allowed / advanced prediction for H.263.
692 #define CODEC_FLAG_QPEL 0x0010 ///< Use qpel MC.
693 #define CODEC_FLAG_GMC 0x0020 ///< Use GMC.
694 #define CODEC_FLAG_MV0 0x0040 ///< Always try a MB with MV=<0,0>.
696 * The parent program guarantees that the input for B-frames containing
697 * streams is not written to for at least s->max_b_frames+1 frames, if
698 * this is not set the input will be copied.
700 #define CODEC_FLAG_INPUT_PRESERVED 0x0100
701 #define CODEC_FLAG_PASS1 0x0200 ///< Use internal 2pass ratecontrol in first pass mode.
702 #define CODEC_FLAG_PASS2 0x0400 ///< Use internal 2pass ratecontrol in second pass mode.
703 #define CODEC_FLAG_GRAY 0x2000 ///< Only decode/encode grayscale.
704 #define CODEC_FLAG_EMU_EDGE 0x4000 ///< Don't draw edges.
705 #define CODEC_FLAG_PSNR 0x8000 ///< error[?] variables will be set during encoding.
706 #define CODEC_FLAG_TRUNCATED 0x00010000 /** Input bitstream might be truncated at a random
707 location instead of only at frame boundaries. */
708 #define CODEC_FLAG_NORMALIZE_AQP 0x00020000 ///< Normalize adaptive quantization.
709 #define CODEC_FLAG_INTERLACED_DCT 0x00040000 ///< Use interlaced DCT.
710 #define CODEC_FLAG_LOW_DELAY 0x00080000 ///< Force low delay.
711 #define CODEC_FLAG_GLOBAL_HEADER 0x00400000 ///< Place global headers in extradata instead of every keyframe.
712 #define CODEC_FLAG_BITEXACT 0x00800000 ///< Use only bitexact stuff (except (I)DCT).
713 /* Fx : Flag for h263+ extra options */
714 #define CODEC_FLAG_AC_PRED 0x01000000 ///< H.263 advanced intra coding / MPEG-4 AC prediction
715 #define CODEC_FLAG_LOOP_FILTER 0x00000800 ///< loop filter
716 #define CODEC_FLAG_INTERLACED_ME 0x20000000 ///< interlaced motion estimation
717 #define CODEC_FLAG_CLOSED_GOP 0x80000000
718 #define CODEC_FLAG2_FAST 0x00000001 ///< Allow non spec compliant speedup tricks.
719 #define CODEC_FLAG2_NO_OUTPUT 0x00000004 ///< Skip bitstream encoding.
720 #define CODEC_FLAG2_LOCAL_HEADER 0x00000008 ///< Place global headers at every keyframe instead of in extradata.
721 #define CODEC_FLAG2_DROP_FRAME_TIMECODE 0x00002000 ///< timecode is in drop frame format. DEPRECATED!!!!
722 #define CODEC_FLAG2_IGNORE_CROP 0x00010000 ///< Discard cropping information from SPS.
724 #define CODEC_FLAG2_CHUNKS 0x00008000 ///< Input bitstream might be truncated at a packet boundaries instead of only at frame boundaries.
725 #define CODEC_FLAG2_SHOW_ALL 0x00400000 ///< Show all frames before the first keyframe
727 /* Unsupported options :
728 * Syntax Arithmetic coding (SAC)
729 * Reference Picture Selection
730 * Independent Segment Decoding */
732 /* codec capabilities */
734 #define CODEC_CAP_DRAW_HORIZ_BAND 0x0001 ///< Decoder can use draw_horiz_band callback.
736 * Codec uses get_buffer() for allocating buffers and supports custom allocators.
737 * If not set, it might not use get_buffer() at all or use operations that
738 * assume the buffer was allocated by avcodec_default_get_buffer.
740 #define CODEC_CAP_DR1 0x0002
741 #define CODEC_CAP_TRUNCATED 0x0008
742 /* Codec can export data for HW decoding (XvMC). */
743 #define CODEC_CAP_HWACCEL 0x0010
745 * Encoder or decoder requires flushing with NULL input at the end in order to
746 * give the complete and correct output.
748 * NOTE: If this flag is not set, the codec is guaranteed to never be fed with
749 * with NULL data. The user can still send NULL data to the public encode
750 * or decode function, but libavcodec will not pass it along to the codec
751 * unless this flag is set.
754 * The decoder has a non-zero delay and needs to be fed with avpkt->data=NULL,
755 * avpkt->size=0 at the end to get the delayed data until the decoder no longer
759 * The encoder needs to be fed with NULL data at the end of encoding until the
760 * encoder no longer returns data.
762 * NOTE: For encoders implementing the AVCodec.encode2() function, setting this
763 * flag also means that the encoder must set the pts and duration for
764 * each output packet. If this flag is not set, the pts and duration will
765 * be determined by libavcodec from the input frame.
767 #define CODEC_CAP_DELAY 0x0020
769 * Codec can be fed a final frame with a smaller size.
770 * This can be used to prevent truncation of the last audio samples.
772 #define CODEC_CAP_SMALL_LAST_FRAME 0x0040
775 * Codec can export data for HW decoding (VDPAU).
777 #define CODEC_CAP_HWACCEL_VDPAU 0x0080
780 * Codec can output multiple frames per AVPacket
781 * Normally demuxers return one frame at a time, demuxers which do not do
782 * are connected to a parser to split what they return into proper frames.
783 * This flag is reserved to the very rare category of codecs which have a
784 * bitstream that cannot be split into frames without timeconsuming
785 * operations like full decoding. Demuxers carring such bitstreams thus
786 * may return multiple frames in a packet. This has many disadvantages like
787 * prohibiting stream copy in many cases thus it should only be considered
790 #define CODEC_CAP_SUBFRAMES 0x0100
792 * Codec is experimental and is thus avoided in favor of non experimental
795 #define CODEC_CAP_EXPERIMENTAL 0x0200
797 * Codec should fill in channel configuration and samplerate instead of container
799 #define CODEC_CAP_CHANNEL_CONF 0x0400
802 * Codec is able to deal with negative linesizes
804 #define CODEC_CAP_NEG_LINESIZES 0x0800
807 * Codec supports frame-level multithreading.
809 #define CODEC_CAP_FRAME_THREADS 0x1000
811 * Codec supports slice-based (or partition-based) multithreading.
813 #define CODEC_CAP_SLICE_THREADS 0x2000
815 * Codec supports changed parameters at any point.
817 #define CODEC_CAP_PARAM_CHANGE 0x4000
819 * Codec supports avctx->thread_count == 0 (auto).
821 #define CODEC_CAP_AUTO_THREADS 0x8000
823 * Audio encoder supports receiving a different number of samples in each call.
825 #define CODEC_CAP_VARIABLE_FRAME_SIZE 0x10000
827 * Codec is intra only.
829 #define CODEC_CAP_INTRA_ONLY 0x40000000
833 #define CODEC_CAP_LOSSLESS 0x80000000
835 //The following defines may change, don't expect compatibility if you use them.
836 #define MB_TYPE_INTRA4x4 0x0001
837 #define MB_TYPE_INTRA16x16 0x0002 //FIXME H.264-specific
838 #define MB_TYPE_INTRA_PCM 0x0004 //FIXME H.264-specific
839 #define MB_TYPE_16x16 0x0008
840 #define MB_TYPE_16x8 0x0010
841 #define MB_TYPE_8x16 0x0020
842 #define MB_TYPE_8x8 0x0040
843 #define MB_TYPE_INTERLACED 0x0080
844 #define MB_TYPE_DIRECT2 0x0100 //FIXME
845 #define MB_TYPE_ACPRED 0x0200
846 #define MB_TYPE_GMC 0x0400
847 #define MB_TYPE_SKIP 0x0800
848 #define MB_TYPE_P0L0 0x1000
849 #define MB_TYPE_P1L0 0x2000
850 #define MB_TYPE_P0L1 0x4000
851 #define MB_TYPE_P1L1 0x8000
852 #define MB_TYPE_L0 (MB_TYPE_P0L0 | MB_TYPE_P1L0)
853 #define MB_TYPE_L1 (MB_TYPE_P0L1 | MB_TYPE_P1L1)
854 #define MB_TYPE_L0L1 (MB_TYPE_L0 | MB_TYPE_L1)
855 #define MB_TYPE_QUANT 0x00010000
856 #define MB_TYPE_CBP 0x00020000
857 //Note bits 24-31 are reserved for codec specific use (h264 ref0, mpeg1 0mv, ...)
861 * This specifies the area which should be displayed.
862 * Note there may be multiple such areas for one frame.
864 typedef struct AVPanScan{
867 * - encoding: Set by user.
868 * - decoding: Set by libavcodec.
873 * width and height in 1/16 pel
874 * - encoding: Set by user.
875 * - decoding: Set by libavcodec.
881 * position of the top left corner in 1/16 pel for up to 3 fields/frames
882 * - encoding: Set by user.
883 * - decoding: Set by libavcodec.
885 int16_t position[3][2];
888 #define FF_QSCALE_TYPE_MPEG1 0
889 #define FF_QSCALE_TYPE_MPEG2 1
890 #define FF_QSCALE_TYPE_H264 2
891 #define FF_QSCALE_TYPE_VP56 3
893 #if FF_API_GET_BUFFER
894 #define FF_BUFFER_TYPE_INTERNAL 1
895 #define FF_BUFFER_TYPE_USER 2 ///< direct rendering buffers (image is (de)allocated by user)
896 #define FF_BUFFER_TYPE_SHARED 4 ///< Buffer from somewhere else; don't deallocate image (data/base), all other tables are not shared.
897 #define FF_BUFFER_TYPE_COPY 8 ///< Just a (modified) copy of some other buffer, don't deallocate anything.
899 #define FF_BUFFER_HINTS_VALID 0x01 // Buffer hints value is meaningful (if 0 ignore).
900 #define FF_BUFFER_HINTS_READABLE 0x02 // Codec will read from buffer.
901 #define FF_BUFFER_HINTS_PRESERVE 0x04 // User must not alter buffer content.
902 #define FF_BUFFER_HINTS_REUSABLE 0x08 // Codec will reuse the buffer (update).
906 * The decoder will keep a reference to the frame and may reuse it later.
908 #define AV_GET_BUFFER_FLAG_REF (1 << 0)
911 * @defgroup lavc_packet AVPacket
913 * Types and functions for working with AVPacket.
916 enum AVPacketSideDataType {
918 AV_PKT_DATA_NEW_EXTRADATA,
921 * An AV_PKT_DATA_PARAM_CHANGE side data packet is laid out as follows:
924 * if (param_flags & AV_SIDE_DATA_PARAM_CHANGE_CHANNEL_COUNT)
925 * s32le channel_count
926 * if (param_flags & AV_SIDE_DATA_PARAM_CHANGE_CHANNEL_LAYOUT)
927 * u64le channel_layout
928 * if (param_flags & AV_SIDE_DATA_PARAM_CHANGE_SAMPLE_RATE)
930 * if (param_flags & AV_SIDE_DATA_PARAM_CHANGE_DIMENSIONS)
935 AV_PKT_DATA_PARAM_CHANGE,
938 * An AV_PKT_DATA_H263_MB_INFO side data packet contains a number of
939 * structures with info about macroblocks relevant to splitting the
940 * packet into smaller packets on macroblock edges (e.g. as for RFC 2190).
941 * That is, it does not necessarily contain info about all macroblocks,
942 * as long as the distance between macroblocks in the info is smaller
943 * than the target payload size.
944 * Each MB info structure is 12 bytes, and is laid out as follows:
946 * u32le bit offset from the start of the packet
947 * u8 current quantizer at the start of the macroblock
949 * u16le macroblock address within the GOB
950 * u8 horizontal MV predictor
951 * u8 vertical MV predictor
952 * u8 horizontal MV predictor for block number 3
953 * u8 vertical MV predictor for block number 3
956 AV_PKT_DATA_H263_MB_INFO,
959 * Recommmends skipping the specified number of samples
961 * u32le number of samples to skip from start of this packet
962 * u32le number of samples to skip from end of this packet
963 * u8 reason for start skip
964 * u8 reason for end skip (0=padding silence, 1=convergence)
967 AV_PKT_DATA_SKIP_SAMPLES=70,
970 * An AV_PKT_DATA_JP_DUALMONO side data packet indicates that
971 * the packet may contain "dual mono" audio specific to Japanese DTV
972 * and if it is true, recommends only the selected channel to be used.
974 * u8 selected channels (0=mail/left, 1=sub/right, 2=both)
977 AV_PKT_DATA_JP_DUALMONO,
980 * A list of zero terminated key/value strings. There is no end marker for
981 * the list, so it is required to rely on the side data size to stop.
983 AV_PKT_DATA_STRINGS_METADATA,
986 * Subtitle event position
994 AV_PKT_DATA_SUBTITLE_POSITION,
997 * Data found in BlockAdditional element of matroska container. There is
998 * no end marker for the data, so it is required to rely on the side data
999 * size to recognize the end. 8 byte id (as found in BlockAddId) followed
1002 AV_PKT_DATA_MATROSKA_BLOCKADDITIONAL,
1005 * The optional first identifier line of a WebVTT cue.
1007 AV_PKT_DATA_WEBVTT_IDENTIFIER,
1010 * The optional settings (rendering instructions) that immediately
1011 * follow the timestamp specifier of a WebVTT cue.
1013 AV_PKT_DATA_WEBVTT_SETTINGS,
1017 * This structure stores compressed data. It is typically exported by demuxers
1018 * and then passed as input to decoders, or received as output from encoders and
1019 * then passed to muxers.
1021 * For video, it should typically contain one compressed frame. For audio it may
1022 * contain several compressed frames.
1024 * AVPacket is one of the few structs in FFmpeg, whose size is a part of public
1025 * ABI. Thus it may be allocated on stack and no new fields can be added to it
1026 * without libavcodec and libavformat major bump.
1028 * The semantics of data ownership depends on the buf or destruct (deprecated)
1029 * fields. If either is set, the packet data is dynamically allocated and is
1030 * valid indefinitely until av_free_packet() is called (which in turn calls
1031 * av_buffer_unref()/the destruct callback to free the data). If neither is set,
1032 * the packet data is typically backed by some static buffer somewhere and is
1033 * only valid for a limited time (e.g. until the next read call when demuxing).
1035 * The side data is always allocated with av_malloc() and is freed in
1038 typedef struct AVPacket {
1040 * A reference to the reference-counted buffer where the packet data is
1042 * May be NULL, then the packet data is not reference-counted.
1046 * Presentation timestamp in AVStream->time_base units; the time at which
1047 * the decompressed packet will be presented to the user.
1048 * Can be AV_NOPTS_VALUE if it is not stored in the file.
1049 * pts MUST be larger or equal to dts as presentation cannot happen before
1050 * decompression, unless one wants to view hex dumps. Some formats misuse
1051 * the terms dts and pts/cts to mean something different. Such timestamps
1052 * must be converted to true pts/dts before they are stored in AVPacket.
1056 * Decompression timestamp in AVStream->time_base units; the time at which
1057 * the packet is decompressed.
1058 * Can be AV_NOPTS_VALUE if it is not stored in the file.
1065 * A combination of AV_PKT_FLAG values
1069 * Additional packet data that can be provided by the container.
1070 * Packet can contain several types of side information.
1075 enum AVPacketSideDataType type;
1077 int side_data_elems;
1080 * Duration of this packet in AVStream->time_base units, 0 if unknown.
1081 * Equals next_pts - this_pts in presentation order.
1084 #if FF_API_DESTRUCT_PACKET
1085 attribute_deprecated
1086 void (*destruct)(struct AVPacket *);
1087 attribute_deprecated
1090 int64_t pos; ///< byte position in stream, -1 if unknown
1093 * Time difference in AVStream->time_base units from the pts of this
1094 * packet to the point at which the output from the decoder has converged
1095 * independent from the availability of previous frames. That is, the
1096 * frames are virtually identical no matter if decoding started from
1097 * the very first frame or from this keyframe.
1098 * Is AV_NOPTS_VALUE if unknown.
1099 * This field is not the display duration of the current packet.
1100 * This field has no meaning if the packet does not have AV_PKT_FLAG_KEY
1103 * The purpose of this field is to allow seeking in streams that have no
1104 * keyframes in the conventional sense. It corresponds to the
1105 * recovery point SEI in H.264 and match_time_delta in NUT. It is also
1106 * essential for some types of subtitle streams to ensure that all
1107 * subtitles are correctly displayed after seeking.
1109 int64_t convergence_duration;
1111 #define AV_PKT_FLAG_KEY 0x0001 ///< The packet contains a keyframe
1112 #define AV_PKT_FLAG_CORRUPT 0x0002 ///< The packet content is corrupted
1114 enum AVSideDataParamChangeFlags {
1115 AV_SIDE_DATA_PARAM_CHANGE_CHANNEL_COUNT = 0x0001,
1116 AV_SIDE_DATA_PARAM_CHANGE_CHANNEL_LAYOUT = 0x0002,
1117 AV_SIDE_DATA_PARAM_CHANGE_SAMPLE_RATE = 0x0004,
1118 AV_SIDE_DATA_PARAM_CHANGE_DIMENSIONS = 0x0008,
1124 struct AVCodecInternal;
1128 AV_FIELD_PROGRESSIVE,
1129 AV_FIELD_TT, //< Top coded_first, top displayed first
1130 AV_FIELD_BB, //< Bottom coded first, bottom displayed first
1131 AV_FIELD_TB, //< Top coded first, bottom displayed first
1132 AV_FIELD_BT, //< Bottom coded first, top displayed first
1136 * main external API structure.
1137 * New fields can be added to the end with minor version bumps.
1138 * Removal, reordering and changes to existing fields require a major
1140 * Please use AVOptions (av_opt* / av_set/get*()) to access these fields from user
1142 * sizeof(AVCodecContext) must not be used outside libav*.
1144 typedef struct AVCodecContext {
1146 * information on struct for av_log
1147 * - set by avcodec_alloc_context3
1149 const AVClass *av_class;
1150 int log_level_offset;
1152 enum AVMediaType codec_type; /* see AVMEDIA_TYPE_xxx */
1153 const struct AVCodec *codec;
1154 char codec_name[32];
1155 enum AVCodecID codec_id; /* see AV_CODEC_ID_xxx */
1158 * fourcc (LSB first, so "ABCD" -> ('D'<<24) + ('C'<<16) + ('B'<<8) + 'A').
1159 * This is used to work around some encoder bugs.
1160 * A demuxer should set this to what is stored in the field used to identify the codec.
1161 * If there are multiple such fields in a container then the demuxer should choose the one
1162 * which maximizes the information about the used codec.
1163 * If the codec tag field in a container is larger than 32 bits then the demuxer should
1164 * remap the longer ID to 32 bits with a table or other structure. Alternatively a new
1165 * extra_codec_tag + size could be added but for this a clear advantage must be demonstrated
1167 * - encoding: Set by user, if not then the default based on codec_id will be used.
1168 * - decoding: Set by user, will be converted to uppercase by libavcodec during init.
1170 unsigned int codec_tag;
1173 * fourcc from the AVI stream header (LSB first, so "ABCD" -> ('D'<<24) + ('C'<<16) + ('B'<<8) + 'A').
1174 * This is used to work around some encoder bugs.
1175 * - encoding: unused
1176 * - decoding: Set by user, will be converted to uppercase by libavcodec during init.
1178 unsigned int stream_codec_tag;
1183 * Private context used for internal data.
1185 * Unlike priv_data, this is not codec-specific. It is used in general
1186 * libavcodec functions.
1188 struct AVCodecInternal *internal;
1191 * Private data of the user, can be used to carry app specific stuff.
1192 * - encoding: Set by user.
1193 * - decoding: Set by user.
1198 * the average bitrate
1199 * - encoding: Set by user; unused for constant quantizer encoding.
1200 * - decoding: Set by libavcodec. 0 or some bitrate if this info is available in the stream.
1205 * number of bits the bitstream is allowed to diverge from the reference.
1206 * the reference can be CBR (for CBR pass1) or VBR (for pass2)
1207 * - encoding: Set by user; unused for constant quantizer encoding.
1208 * - decoding: unused
1210 int bit_rate_tolerance;
1213 * Global quality for codecs which cannot change it per frame.
1214 * This should be proportional to MPEG-1/2/4 qscale.
1215 * - encoding: Set by user.
1216 * - decoding: unused
1221 * - encoding: Set by user.
1222 * - decoding: unused
1224 int compression_level;
1225 #define FF_COMPRESSION_DEFAULT -1
1229 * - encoding: Set by user.
1230 * - decoding: Set by user.
1236 * - encoding: Set by user.
1237 * - decoding: Set by user.
1242 * some codecs need / can use extradata like Huffman tables.
1243 * mjpeg: Huffman tables
1244 * rv10: additional flags
1245 * mpeg4: global headers (they can be in the bitstream or here)
1246 * The allocated memory should be FF_INPUT_BUFFER_PADDING_SIZE bytes larger
1247 * than extradata_size to avoid problems if it is read with the bitstream reader.
1248 * The bytewise contents of extradata must not depend on the architecture or CPU endianness.
1249 * - encoding: Set/allocated/freed by libavcodec.
1250 * - decoding: Set/allocated/freed by user.
1256 * This is the fundamental unit of time (in seconds) in terms
1257 * of which frame timestamps are represented. For fixed-fps content,
1258 * timebase should be 1/framerate and timestamp increments should be
1260 * - encoding: MUST be set by user.
1261 * - decoding: Set by libavcodec.
1263 AVRational time_base;
1266 * For some codecs, the time base is closer to the field rate than the frame rate.
1267 * Most notably, H.264 and MPEG-2 specify time_base as half of frame duration
1268 * if no telecine is used ...
1270 * Set to time_base ticks per frame. Default 1, e.g., H.264/MPEG-2 set it to 2.
1272 int ticks_per_frame;
1277 * Encoding: Number of frames delay there will be from the encoder input to
1278 * the decoder output. (we assume the decoder matches the spec)
1279 * Decoding: Number of frames delay in addition to what a standard decoder
1280 * as specified in the spec would produce.
1283 * Number of frames the decoded output will be delayed relative to the
1287 * For encoding, this is the number of "priming" samples added to the
1288 * beginning of the stream. The decoded output will be delayed by this
1289 * many samples relative to the input to the encoder. Note that this
1290 * field is purely informational and does not directly affect the pts
1291 * output by the encoder, which should always be based on the actual
1292 * presentation time, including any delay.
1293 * For decoding, this is the number of samples the decoder needs to
1294 * output before the decoder's output is valid. When seeking, you should
1295 * start decoding this many samples prior to your desired seek point.
1297 * - encoding: Set by libavcodec.
1298 * - decoding: Set by libavcodec.
1305 * picture width / height.
1306 * - encoding: MUST be set by user.
1307 * - decoding: May be set by the user before opening the decoder if known e.g.
1308 * from the container. Some decoders will require the dimensions
1309 * to be set by the caller. During decoding, the decoder may
1310 * overwrite those values as required.
1315 * Bitstream width / height, may be different from width/height e.g. when
1316 * the decoded frame is cropped before being output or lowres is enabled.
1317 * - encoding: unused
1318 * - decoding: May be set by the user before opening the decoder if known
1319 * e.g. from the container. During decoding, the decoder may
1320 * overwrite those values as required.
1322 int coded_width, coded_height;
1324 #define FF_ASPECT_EXTENDED 15
1327 * the number of pictures in a group of pictures, or 0 for intra_only
1328 * - encoding: Set by user.
1329 * - decoding: unused
1334 * Pixel format, see AV_PIX_FMT_xxx.
1335 * May be set by the demuxer if known from headers.
1336 * May be overridden by the decoder if it knows better.
1337 * - encoding: Set by user.
1338 * - decoding: Set by user if known, overridden by libavcodec if known
1340 enum AVPixelFormat pix_fmt;
1343 * Motion estimation algorithm used for video coding.
1344 * 1 (zero), 2 (full), 3 (log), 4 (phods), 5 (epzs), 6 (x1), 7 (hex),
1345 * 8 (umh), 9 (iter), 10 (tesa) [7, 8, 10 are x264 specific, 9 is snow specific]
1346 * - encoding: MUST be set by user.
1347 * - decoding: unused
1352 * If non NULL, 'draw_horiz_band' is called by the libavcodec
1353 * decoder to draw a horizontal band. It improves cache usage. Not
1354 * all codecs can do that. You must check the codec capabilities
1356 * When multithreading is used, it may be called from multiple threads
1357 * at the same time; threads might draw different parts of the same AVFrame,
1358 * or multiple AVFrames, and there is no guarantee that slices will be drawn
1360 * The function is also used by hardware acceleration APIs.
1361 * It is called at least once during frame decoding to pass
1362 * the data needed for hardware render.
1363 * In that mode instead of pixel data, AVFrame points to
1364 * a structure specific to the acceleration API. The application
1365 * reads the structure and can change some fields to indicate progress
1367 * - encoding: unused
1368 * - decoding: Set by user.
1369 * @param height the height of the slice
1370 * @param y the y position of the slice
1371 * @param type 1->top field, 2->bottom field, 3->frame
1372 * @param offset offset into the AVFrame.data from which the slice should be read
1374 void (*draw_horiz_band)(struct AVCodecContext *s,
1375 const AVFrame *src, int offset[AV_NUM_DATA_POINTERS],
1376 int y, int type, int height);
1379 * callback to negotiate the pixelFormat
1380 * @param fmt is the list of formats which are supported by the codec,
1381 * it is terminated by -1 as 0 is a valid format, the formats are ordered by quality.
1382 * The first is always the native one.
1383 * @return the chosen format
1384 * - encoding: unused
1385 * - decoding: Set by user, if not set the native format will be chosen.
1387 enum AVPixelFormat (*get_format)(struct AVCodecContext *s, const enum AVPixelFormat * fmt);
1390 * maximum number of B-frames between non-B-frames
1391 * Note: The output will be delayed by max_b_frames+1 relative to the input.
1392 * - encoding: Set by user.
1393 * - decoding: unused
1398 * qscale factor between IP and B-frames
1399 * If > 0 then the last P-frame quantizer will be used (q= lastp_q*factor+offset).
1400 * If < 0 then normal ratecontrol will be done (q= -normal_q*factor+offset).
1401 * - encoding: Set by user.
1402 * - decoding: unused
1404 float b_quant_factor;
1406 /** obsolete FIXME remove */
1408 #define FF_RC_STRATEGY_XVID 1
1410 int b_frame_strategy;
1413 * qscale offset between IP and B-frames
1414 * - encoding: Set by user.
1415 * - decoding: unused
1417 float b_quant_offset;
1420 * Size of the frame reordering buffer in the decoder.
1421 * For MPEG-2 it is 1 IPB or 0 low delay IP.
1422 * - encoding: Set by libavcodec.
1423 * - decoding: Set by libavcodec.
1428 * 0-> h263 quant 1-> mpeg quant
1429 * - encoding: Set by user.
1430 * - decoding: unused
1435 * qscale factor between P and I-frames
1436 * If > 0 then the last p frame quantizer will be used (q= lastp_q*factor+offset).
1437 * If < 0 then normal ratecontrol will be done (q= -normal_q*factor+offset).
1438 * - encoding: Set by user.
1439 * - decoding: unused
1441 float i_quant_factor;
1444 * qscale offset between P and I-frames
1445 * - encoding: Set by user.
1446 * - decoding: unused
1448 float i_quant_offset;
1451 * luminance masking (0-> disabled)
1452 * - encoding: Set by user.
1453 * - decoding: unused
1458 * temporary complexity masking (0-> disabled)
1459 * - encoding: Set by user.
1460 * - decoding: unused
1462 float temporal_cplx_masking;
1465 * spatial complexity masking (0-> disabled)
1466 * - encoding: Set by user.
1467 * - decoding: unused
1469 float spatial_cplx_masking;
1472 * p block masking (0-> disabled)
1473 * - encoding: Set by user.
1474 * - decoding: unused
1479 * darkness masking (0-> disabled)
1480 * - encoding: Set by user.
1481 * - decoding: unused
1487 * - encoding: Set by libavcodec.
1488 * - decoding: Set by user (or 0).
1492 * prediction method (needed for huffyuv)
1493 * - encoding: Set by user.
1494 * - decoding: unused
1496 int prediction_method;
1497 #define FF_PRED_LEFT 0
1498 #define FF_PRED_PLANE 1
1499 #define FF_PRED_MEDIAN 2
1502 * slice offsets in the frame in bytes
1503 * - encoding: Set/allocated by libavcodec.
1504 * - decoding: Set/allocated by user (or NULL).
1509 * sample aspect ratio (0 if unknown)
1510 * That is the width of a pixel divided by the height of the pixel.
1511 * Numerator and denominator must be relatively prime and smaller than 256 for some video standards.
1512 * - encoding: Set by user.
1513 * - decoding: Set by libavcodec.
1515 AVRational sample_aspect_ratio;
1518 * motion estimation comparison function
1519 * - encoding: Set by user.
1520 * - decoding: unused
1524 * subpixel motion estimation comparison function
1525 * - encoding: Set by user.
1526 * - decoding: unused
1530 * macroblock comparison function (not supported yet)
1531 * - encoding: Set by user.
1532 * - decoding: unused
1536 * interlaced DCT comparison function
1537 * - encoding: Set by user.
1538 * - decoding: unused
1541 #define FF_CMP_SAD 0
1542 #define FF_CMP_SSE 1
1543 #define FF_CMP_SATD 2
1544 #define FF_CMP_DCT 3
1545 #define FF_CMP_PSNR 4
1546 #define FF_CMP_BIT 5
1548 #define FF_CMP_ZERO 7
1549 #define FF_CMP_VSAD 8
1550 #define FF_CMP_VSSE 9
1551 #define FF_CMP_NSSE 10
1552 #define FF_CMP_W53 11
1553 #define FF_CMP_W97 12
1554 #define FF_CMP_DCTMAX 13
1555 #define FF_CMP_DCT264 14
1556 #define FF_CMP_CHROMA 256
1559 * ME diamond size & shape
1560 * - encoding: Set by user.
1561 * - decoding: unused
1566 * amount of previous MV predictors (2a+1 x 2a+1 square)
1567 * - encoding: Set by user.
1568 * - decoding: unused
1570 int last_predictor_count;
1573 * prepass for motion estimation
1574 * - encoding: Set by user.
1575 * - decoding: unused
1580 * motion estimation prepass comparison function
1581 * - encoding: Set by user.
1582 * - decoding: unused
1587 * ME prepass diamond size & shape
1588 * - encoding: Set by user.
1589 * - decoding: unused
1595 * - encoding: Set by user.
1596 * - decoding: unused
1598 int me_subpel_quality;
1601 * DTG active format information (additional aspect ratio
1602 * information only used in DVB MPEG-2 transport streams)
1605 * - encoding: unused
1606 * - decoding: Set by decoder.
1608 int dtg_active_format;
1609 #define FF_DTG_AFD_SAME 8
1610 #define FF_DTG_AFD_4_3 9
1611 #define FF_DTG_AFD_16_9 10
1612 #define FF_DTG_AFD_14_9 11
1613 #define FF_DTG_AFD_4_3_SP_14_9 13
1614 #define FF_DTG_AFD_16_9_SP_14_9 14
1615 #define FF_DTG_AFD_SP_4_3 15
1618 * maximum motion estimation search range in subpel units
1619 * If 0 then no limit.
1621 * - encoding: Set by user.
1622 * - decoding: unused
1627 * intra quantizer bias
1628 * - encoding: Set by user.
1629 * - decoding: unused
1631 int intra_quant_bias;
1632 #define FF_DEFAULT_QUANT_BIAS 999999
1635 * inter quantizer bias
1636 * - encoding: Set by user.
1637 * - decoding: unused
1639 int inter_quant_bias;
1643 * - encoding: unused
1644 * - decoding: Set by user.
1647 #define SLICE_FLAG_CODED_ORDER 0x0001 ///< draw_horiz_band() is called in coded order instead of display
1648 #define SLICE_FLAG_ALLOW_FIELD 0x0002 ///< allow draw_horiz_band() with field slices (MPEG2 field pics)
1649 #define SLICE_FLAG_ALLOW_PLANE 0x0004 ///< allow draw_horiz_band() with 1 component at a time (SVQ1)
1652 * XVideo Motion Acceleration
1653 * - encoding: forbidden
1654 * - decoding: set by decoder
1656 int xvmc_acceleration;
1659 * macroblock decision mode
1660 * - encoding: Set by user.
1661 * - decoding: unused
1664 #define FF_MB_DECISION_SIMPLE 0 ///< uses mb_cmp
1665 #define FF_MB_DECISION_BITS 1 ///< chooses the one which needs the fewest bits
1666 #define FF_MB_DECISION_RD 2 ///< rate distortion
1669 * custom intra quantization matrix
1670 * - encoding: Set by user, can be NULL.
1671 * - decoding: Set by libavcodec.
1673 uint16_t *intra_matrix;
1676 * custom inter quantization matrix
1677 * - encoding: Set by user, can be NULL.
1678 * - decoding: Set by libavcodec.
1680 uint16_t *inter_matrix;
1683 * scene change detection threshold
1684 * 0 is default, larger means fewer detected scene changes.
1685 * - encoding: Set by user.
1686 * - decoding: unused
1688 int scenechange_threshold;
1691 * noise reduction strength
1692 * - encoding: Set by user.
1693 * - decoding: unused
1695 int noise_reduction;
1698 * Motion estimation threshold below which no motion estimation is
1699 * performed, but instead the user specified motion vectors are used.
1701 * - encoding: Set by user.
1702 * - decoding: unused
1707 * Macroblock threshold below which the user specified macroblock types will be used.
1708 * - encoding: Set by user.
1709 * - decoding: unused
1714 * precision of the intra DC coefficient - 8
1715 * - encoding: Set by user.
1716 * - decoding: unused
1718 int intra_dc_precision;
1721 * Number of macroblock rows at the top which are skipped.
1722 * - encoding: unused
1723 * - decoding: Set by user.
1728 * Number of macroblock rows at the bottom which are skipped.
1729 * - encoding: unused
1730 * - decoding: Set by user.
1735 * Border processing masking, raises the quantizer for mbs on the borders
1737 * - encoding: Set by user.
1738 * - decoding: unused
1740 float border_masking;
1743 * minimum MB lagrange multipler
1744 * - encoding: Set by user.
1745 * - decoding: unused
1750 * maximum MB lagrange multipler
1751 * - encoding: Set by user.
1752 * - decoding: unused
1758 * - encoding: Set by user.
1759 * - decoding: unused
1761 int me_penalty_compensation;
1765 * - encoding: Set by user.
1766 * - decoding: unused
1772 * - encoding: Set by user.
1773 * - decoding: unused
1779 * - encoding: Set by user.
1780 * - decoding: unused
1785 * number of reference frames
1786 * - encoding: Set by user.
1787 * - decoding: Set by lavc.
1792 * chroma qp offset from luma
1793 * - encoding: Set by user.
1794 * - decoding: unused
1799 * Multiplied by qscale for each frame and added to scene_change_score.
1800 * - encoding: Set by user.
1801 * - decoding: unused
1803 int scenechange_factor;
1807 * Note: Value depends upon the compare function used for fullpel ME.
1808 * - encoding: Set by user.
1809 * - decoding: unused
1814 * Adjust sensitivity of b_frame_strategy 1.
1815 * - encoding: Set by user.
1816 * - decoding: unused
1821 * Chromaticity coordinates of the source primaries.
1822 * - encoding: Set by user
1823 * - decoding: Set by libavcodec
1825 enum AVColorPrimaries color_primaries;
1828 * Color Transfer Characteristic.
1829 * - encoding: Set by user
1830 * - decoding: Set by libavcodec
1832 enum AVColorTransferCharacteristic color_trc;
1835 * YUV colorspace type.
1836 * - encoding: Set by user
1837 * - decoding: Set by libavcodec
1839 enum AVColorSpace colorspace;
1842 * MPEG vs JPEG YUV range.
1843 * - encoding: Set by user
1844 * - decoding: Set by libavcodec
1846 enum AVColorRange color_range;
1849 * This defines the location of chroma samples.
1850 * - encoding: Set by user
1851 * - decoding: Set by libavcodec
1853 enum AVChromaLocation chroma_sample_location;
1857 * Indicates number of picture subdivisions. Used for parallelized
1859 * - encoding: Set by user
1860 * - decoding: unused
1865 * - encoding: set by libavcodec
1866 * - decoding: Set by user.
1868 enum AVFieldOrder field_order;
1871 int sample_rate; ///< samples per second
1872 int channels; ///< number of audio channels
1875 * audio sample format
1876 * - encoding: Set by user.
1877 * - decoding: Set by libavcodec.
1879 enum AVSampleFormat sample_fmt; ///< sample format
1881 /* The following data should not be initialized. */
1883 * Number of samples per channel in an audio frame.
1885 * - encoding: set by libavcodec in avcodec_open2(). Each submitted frame
1886 * except the last must contain exactly frame_size samples per channel.
1887 * May be 0 when the codec has CODEC_CAP_VARIABLE_FRAME_SIZE set, then the
1888 * frame size is not restricted.
1889 * - decoding: may be set by some decoders to indicate constant frame size
1894 * Frame counter, set by libavcodec.
1896 * - decoding: total number of frames returned from the decoder so far.
1897 * - encoding: total number of frames passed to the encoder so far.
1899 * @note the counter is not incremented if encoding/decoding resulted in
1905 * number of bytes per packet if constant and known or 0
1906 * Used by some WAV based audio codecs.
1911 * Audio cutoff bandwidth (0 means "automatic")
1912 * - encoding: Set by user.
1913 * - decoding: unused
1917 #if FF_API_REQUEST_CHANNELS
1919 * Decoder should decode to this many channels if it can (0 for default)
1920 * - encoding: unused
1921 * - decoding: Set by user.
1922 * @deprecated Deprecated in favor of request_channel_layout.
1924 attribute_deprecated int request_channels;
1928 * Audio channel layout.
1929 * - encoding: set by user.
1930 * - decoding: set by user, may be overwritten by libavcodec.
1932 uint64_t channel_layout;
1935 * Request decoder to use this channel layout if it can (0 for default)
1936 * - encoding: unused
1937 * - decoding: Set by user.
1939 uint64_t request_channel_layout;
1942 * Type of service that the audio stream conveys.
1943 * - encoding: Set by user.
1944 * - decoding: Set by libavcodec.
1946 enum AVAudioServiceType audio_service_type;
1949 * desired sample format
1950 * - encoding: Not used.
1951 * - decoding: Set by user.
1952 * Decoder will decode to this format if it can.
1954 enum AVSampleFormat request_sample_fmt;
1956 #if FF_API_GET_BUFFER
1958 * Called at the beginning of each frame to get a buffer for it.
1960 * The function will set AVFrame.data[], AVFrame.linesize[].
1961 * AVFrame.extended_data[] must also be set, but it should be the same as
1962 * AVFrame.data[] except for planar audio with more channels than can fit
1963 * in AVFrame.data[]. In that case, AVFrame.data[] shall still contain as
1964 * many data pointers as it can hold.
1966 * if CODEC_CAP_DR1 is not set then get_buffer() must call
1967 * avcodec_default_get_buffer() instead of providing buffers allocated by
1970 * AVFrame.data[] should be 32- or 16-byte-aligned unless the CPU doesn't
1971 * need it. avcodec_default_get_buffer() aligns the output buffer properly,
1972 * but if get_buffer() is overridden then alignment considerations should
1973 * be taken into account.
1975 * @see avcodec_default_get_buffer()
1979 * If pic.reference is set then the frame will be read later by libavcodec.
1980 * avcodec_align_dimensions2() should be used to find the required width and
1981 * height, as they normally need to be rounded up to the next multiple of 16.
1983 * If frame multithreading is used and thread_safe_callbacks is set,
1984 * it may be called from a different thread, but not from more than one at
1985 * once. Does not need to be reentrant.
1987 * @see release_buffer(), reget_buffer()
1988 * @see avcodec_align_dimensions2()
1992 * Decoders request a buffer of a particular size by setting
1993 * AVFrame.nb_samples prior to calling get_buffer(). The decoder may,
1994 * however, utilize only part of the buffer by setting AVFrame.nb_samples
1995 * to a smaller value in the output frame.
1997 * Decoders cannot use the buffer after returning from
1998 * avcodec_decode_audio4(), so they will not call release_buffer(), as it
1999 * is assumed to be released immediately upon return. In some rare cases,
2000 * a decoder may need to call get_buffer() more than once in a single
2001 * call to avcodec_decode_audio4(). In that case, when get_buffer() is
2002 * called again after it has already been called once, the previously
2003 * acquired buffer is assumed to be released at that time and may not be
2004 * reused by the decoder.
2006 * As a convenience, av_samples_get_buffer_size() and
2007 * av_samples_fill_arrays() in libavutil may be used by custom get_buffer()
2008 * functions to find the required data size and to fill data pointers and
2009 * linesize. In AVFrame.linesize, only linesize[0] may be set for audio
2010 * since all planes must be the same size.
2012 * @see av_samples_get_buffer_size(), av_samples_fill_arrays()
2014 * - encoding: unused
2015 * - decoding: Set by libavcodec, user can override.
2017 * @deprecated use get_buffer2()
2019 attribute_deprecated
2020 int (*get_buffer)(struct AVCodecContext *c, AVFrame *pic);
2023 * Called to release buffers which were allocated with get_buffer.
2024 * A released buffer can be reused in get_buffer().
2025 * pic.data[*] must be set to NULL.
2026 * May be called from a different thread if frame multithreading is used,
2027 * but not by more than one thread at once, so does not need to be reentrant.
2028 * - encoding: unused
2029 * - decoding: Set by libavcodec, user can override.
2031 * @deprecated custom freeing callbacks should be set from get_buffer2()
2033 attribute_deprecated
2034 void (*release_buffer)(struct AVCodecContext *c, AVFrame *pic);
2037 * Called at the beginning of a frame to get cr buffer for it.
2038 * Buffer type (size, hints) must be the same. libavcodec won't check it.
2039 * libavcodec will pass previous buffer in pic, function should return
2040 * same buffer or new buffer with old frame "painted" into it.
2041 * If pic.data[0] == NULL must behave like get_buffer().
2042 * if CODEC_CAP_DR1 is not set then reget_buffer() must call
2043 * avcodec_default_reget_buffer() instead of providing buffers allocated by
2045 * - encoding: unused
2046 * - decoding: Set by libavcodec, user can override.
2048 attribute_deprecated
2049 int (*reget_buffer)(struct AVCodecContext *c, AVFrame *pic);
2053 * This callback is called at the beginning of each frame to get data
2054 * buffer(s) for it. There may be one contiguous buffer for all the data or
2055 * there may be a buffer per each data plane or anything in between. What
2056 * this means is, you may set however many entries in buf[] you feel necessary.
2057 * Each buffer must be reference-counted using the AVBuffer API (see description
2060 * The following fields will be set in the frame before this callback is
2063 * - width, height (video only)
2064 * - sample_rate, channel_layout, nb_samples (audio only)
2065 * Their values may differ from the corresponding values in
2066 * AVCodecContext. This callback must use the frame values, not the codec
2067 * context values, to calculate the required buffer size.
2069 * This callback must fill the following fields in the frame:
2073 * * if the data is planar audio with more than 8 channels, then this
2074 * callback must allocate and fill extended_data to contain all pointers
2075 * to all data planes. data[] must hold as many pointers as it can.
2076 * extended_data must be allocated with av_malloc() and will be freed in
2078 * * otherwise exended_data must point to data
2079 * - buf[] must contain one or more pointers to AVBufferRef structures. Each of
2080 * the frame's data and extended_data pointers must be contained in these. That
2081 * is, one AVBufferRef for each allocated chunk of memory, not necessarily one
2082 * AVBufferRef per data[] entry. See: av_buffer_create(), av_buffer_alloc(),
2083 * and av_buffer_ref().
2084 * - extended_buf and nb_extended_buf must be allocated with av_malloc() by
2085 * this callback and filled with the extra buffers if there are more
2086 * buffers than buf[] can hold. extended_buf will be freed in
2089 * If CODEC_CAP_DR1 is not set then get_buffer2() must call
2090 * avcodec_default_get_buffer2() instead of providing buffers allocated by
2093 * Each data plane must be aligned to the maximum required by the target
2096 * @see avcodec_default_get_buffer2()
2100 * If AV_GET_BUFFER_FLAG_REF is set in flags then the frame may be reused
2101 * (read and/or written to if it is writable) later by libavcodec.
2103 * If CODEC_FLAG_EMU_EDGE is not set in s->flags, the buffer must contain an
2104 * edge of the size returned by avcodec_get_edge_width() on all sides.
2106 * avcodec_align_dimensions2() should be used to find the required width and
2107 * height, as they normally need to be rounded up to the next multiple of 16.
2109 * If frame multithreading is used and thread_safe_callbacks is set,
2110 * this callback may be called from a different thread, but not from more
2111 * than one at once. Does not need to be reentrant.
2113 * @see avcodec_align_dimensions2()
2117 * Decoders request a buffer of a particular size by setting
2118 * AVFrame.nb_samples prior to calling get_buffer2(). The decoder may,
2119 * however, utilize only part of the buffer by setting AVFrame.nb_samples
2120 * to a smaller value in the output frame.
2122 * As a convenience, av_samples_get_buffer_size() and
2123 * av_samples_fill_arrays() in libavutil may be used by custom get_buffer2()
2124 * functions to find the required data size and to fill data pointers and
2125 * linesize. In AVFrame.linesize, only linesize[0] may be set for audio
2126 * since all planes must be the same size.
2128 * @see av_samples_get_buffer_size(), av_samples_fill_arrays()
2130 * - encoding: unused
2131 * - decoding: Set by libavcodec, user can override.
2133 int (*get_buffer2)(struct AVCodecContext *s, AVFrame *frame, int flags);
2136 * If non-zero, the decoded audio and video frames returned from
2137 * avcodec_decode_video2() and avcodec_decode_audio4() are reference-counted
2138 * and are valid indefinitely. The caller must free them with
2139 * av_frame_unref() when they are not needed anymore.
2140 * Otherwise, the decoded frames must not be freed by the caller and are
2141 * only valid until the next decode call.
2143 * - encoding: unused
2144 * - decoding: set by the caller before avcodec_open2().
2146 int refcounted_frames;
2148 /* - encoding parameters */
2149 float qcompress; ///< amount of qscale change between easy & hard scenes (0.0-1.0)
2150 float qblur; ///< amount of qscale smoothing over time (0.0-1.0)
2154 * - encoding: Set by user.
2155 * - decoding: unused
2161 * - encoding: Set by user.
2162 * - decoding: unused
2167 * maximum quantizer difference between frames
2168 * - encoding: Set by user.
2169 * - decoding: unused
2174 * ratecontrol qmin qmax limiting method
2175 * 0-> clipping, 1-> use a nice continuous function to limit qscale wthin qmin/qmax.
2176 * - encoding: Set by user.
2177 * - decoding: unused
2185 * decoder bitstream buffer size
2186 * - encoding: Set by user.
2187 * - decoding: unused
2192 * ratecontrol override, see RcOverride
2193 * - encoding: Allocated/set/freed by user.
2194 * - decoding: unused
2196 int rc_override_count;
2197 RcOverride *rc_override;
2200 * rate control equation
2201 * - encoding: Set by user
2202 * - decoding: unused
2208 * - encoding: Set by user.
2209 * - decoding: unused
2215 * - encoding: Set by user.
2216 * - decoding: unused
2220 float rc_buffer_aggressivity;
2223 * initial complexity for pass1 ratecontrol
2224 * - encoding: Set by user.
2225 * - decoding: unused
2227 float rc_initial_cplx;
2230 * Ratecontrol attempt to use, at maximum, <value> of what can be used without an underflow.
2231 * - encoding: Set by user.
2232 * - decoding: unused.
2234 float rc_max_available_vbv_use;
2237 * Ratecontrol attempt to use, at least, <value> times the amount needed to prevent a vbv overflow.
2238 * - encoding: Set by user.
2239 * - decoding: unused.
2241 float rc_min_vbv_overflow_use;
2244 * Number of bits which should be loaded into the rc buffer before decoding starts.
2245 * - encoding: Set by user.
2246 * - decoding: unused
2248 int rc_initial_buffer_occupancy;
2250 #define FF_CODER_TYPE_VLC 0
2251 #define FF_CODER_TYPE_AC 1
2252 #define FF_CODER_TYPE_RAW 2
2253 #define FF_CODER_TYPE_RLE 3
2254 #define FF_CODER_TYPE_DEFLATE 4
2257 * - encoding: Set by user.
2258 * - decoding: unused
2264 * - encoding: Set by user.
2265 * - decoding: unused
2270 * minimum Lagrange multipler
2271 * - encoding: Set by user.
2272 * - decoding: unused
2277 * maximum Lagrange multipler
2278 * - encoding: Set by user.
2279 * - decoding: unused
2284 * frame skip threshold
2285 * - encoding: Set by user.
2286 * - decoding: unused
2288 int frame_skip_threshold;
2292 * - encoding: Set by user.
2293 * - decoding: unused
2295 int frame_skip_factor;
2298 * frame skip exponent
2299 * - encoding: Set by user.
2300 * - decoding: unused
2305 * frame skip comparison function
2306 * - encoding: Set by user.
2307 * - decoding: unused
2312 * trellis RD quantization
2313 * - encoding: Set by user.
2314 * - decoding: unused
2319 * - encoding: Set by user.
2320 * - decoding: unused
2322 int min_prediction_order;
2325 * - encoding: Set by user.
2326 * - decoding: unused
2328 int max_prediction_order;
2331 * GOP timecode frame start number
2332 * - encoding: Set by user, in non drop frame format
2333 * - decoding: Set by libavcodec (timecode in the 25 bits format, -1 if unset)
2335 int64_t timecode_frame_start;
2337 /* The RTP callback: This function is called */
2338 /* every time the encoder has a packet to send. */
2339 /* It depends on the encoder if the data starts */
2340 /* with a Start Code (it should). H.263 does. */
2341 /* mb_nb contains the number of macroblocks */
2342 /* encoded in the RTP payload. */
2343 void (*rtp_callback)(struct AVCodecContext *avctx, void *data, int size, int mb_nb);
2345 int rtp_payload_size; /* The size of the RTP payload: the coder will */
2346 /* do its best to deliver a chunk with size */
2347 /* below rtp_payload_size, the chunk will start */
2348 /* with a start code on some codecs like H.263. */
2349 /* This doesn't take account of any particular */
2350 /* headers inside the transmitted RTP payload. */
2352 /* statistics, used for 2-pass encoding */
2363 * number of bits used for the previously encoded frame
2364 * - encoding: Set by libavcodec.
2365 * - decoding: unused
2370 * pass1 encoding statistics output buffer
2371 * - encoding: Set by libavcodec.
2372 * - decoding: unused
2377 * pass2 encoding statistics input buffer
2378 * Concatenated stuff from stats_out of pass1 should be placed here.
2379 * - encoding: Allocated/set/freed by user.
2380 * - decoding: unused
2385 * Work around bugs in encoders which sometimes cannot be detected automatically.
2386 * - encoding: Set by user
2387 * - decoding: Set by user
2389 int workaround_bugs;
2390 #define FF_BUG_AUTODETECT 1 ///< autodetection
2391 #define FF_BUG_OLD_MSMPEG4 2
2392 #define FF_BUG_XVID_ILACE 4
2393 #define FF_BUG_UMP4 8
2394 #define FF_BUG_NO_PADDING 16
2395 #define FF_BUG_AMV 32
2396 #define FF_BUG_AC_VLC 0 ///< Will be removed, libavcodec can now handle these non-compliant files by default.
2397 #define FF_BUG_QPEL_CHROMA 64
2398 #define FF_BUG_STD_QPEL 128
2399 #define FF_BUG_QPEL_CHROMA2 256
2400 #define FF_BUG_DIRECT_BLOCKSIZE 512
2401 #define FF_BUG_EDGE 1024
2402 #define FF_BUG_HPEL_CHROMA 2048
2403 #define FF_BUG_DC_CLIP 4096
2404 #define FF_BUG_MS 8192 ///< Work around various bugs in Microsoft's broken decoders.
2405 #define FF_BUG_TRUNCATED 16384
2408 * strictly follow the standard (MPEG4, ...).
2409 * - encoding: Set by user.
2410 * - decoding: Set by user.
2411 * Setting this to STRICT or higher means the encoder and decoder will
2412 * generally do stupid things, whereas setting it to unofficial or lower
2413 * will mean the encoder might produce output that is not supported by all
2414 * spec-compliant decoders. Decoders don't differentiate between normal,
2415 * unofficial and experimental (that is, they always try to decode things
2416 * when they can) unless they are explicitly asked to behave stupidly
2417 * (=strictly conform to the specs)
2419 int strict_std_compliance;
2420 #define FF_COMPLIANCE_VERY_STRICT 2 ///< Strictly conform to an older more strict version of the spec or reference software.
2421 #define FF_COMPLIANCE_STRICT 1 ///< Strictly conform to all the things in the spec no matter what consequences.
2422 #define FF_COMPLIANCE_NORMAL 0
2423 #define FF_COMPLIANCE_UNOFFICIAL -1 ///< Allow unofficial extensions
2424 #define FF_COMPLIANCE_EXPERIMENTAL -2 ///< Allow nonstandardized experimental things.
2427 * error concealment flags
2428 * - encoding: unused
2429 * - decoding: Set by user.
2431 int error_concealment;
2432 #define FF_EC_GUESS_MVS 1
2433 #define FF_EC_DEBLOCK 2
2437 * - encoding: Set by user.
2438 * - decoding: Set by user.
2441 #define FF_DEBUG_PICT_INFO 1
2442 #define FF_DEBUG_RC 2
2443 #define FF_DEBUG_BITSTREAM 4
2444 #define FF_DEBUG_MB_TYPE 8
2445 #define FF_DEBUG_QP 16
2446 #define FF_DEBUG_MV 32
2447 #define FF_DEBUG_DCT_COEFF 0x00000040
2448 #define FF_DEBUG_SKIP 0x00000080
2449 #define FF_DEBUG_STARTCODE 0x00000100
2450 #define FF_DEBUG_PTS 0x00000200
2451 #define FF_DEBUG_ER 0x00000400
2452 #define FF_DEBUG_MMCO 0x00000800
2453 #define FF_DEBUG_BUGS 0x00001000
2454 #define FF_DEBUG_VIS_QP 0x00002000
2455 #define FF_DEBUG_VIS_MB_TYPE 0x00004000
2456 #define FF_DEBUG_BUFFERS 0x00008000
2457 #define FF_DEBUG_THREADS 0x00010000
2461 * - encoding: Set by user.
2462 * - decoding: Set by user.
2465 #define FF_DEBUG_VIS_MV_P_FOR 0x00000001 //visualize forward predicted MVs of P frames
2466 #define FF_DEBUG_VIS_MV_B_FOR 0x00000002 //visualize forward predicted MVs of B frames
2467 #define FF_DEBUG_VIS_MV_B_BACK 0x00000004 //visualize backward predicted MVs of B frames
2470 * Error recognition; may misdetect some more or less valid parts as errors.
2471 * - encoding: unused
2472 * - decoding: Set by user.
2474 int err_recognition;
2475 #define AV_EF_CRCCHECK (1<<0)
2476 #define AV_EF_BITSTREAM (1<<1)
2477 #define AV_EF_BUFFER (1<<2)
2478 #define AV_EF_EXPLODE (1<<3)
2480 #define AV_EF_CAREFUL (1<<16)
2481 #define AV_EF_COMPLIANT (1<<17)
2482 #define AV_EF_AGGRESSIVE (1<<18)
2486 * opaque 64bit number (generally a PTS) that will be reordered and
2487 * output in AVFrame.reordered_opaque
2488 * @deprecated in favor of pkt_pts
2489 * - encoding: unused
2490 * - decoding: Set by user.
2492 int64_t reordered_opaque;
2495 * Hardware accelerator in use
2496 * - encoding: unused.
2497 * - decoding: Set by libavcodec
2499 struct AVHWAccel *hwaccel;
2502 * Hardware accelerator context.
2503 * For some hardware accelerators, a global context needs to be
2504 * provided by the user. In that case, this holds display-dependent
2505 * data FFmpeg cannot instantiate itself. Please refer to the
2506 * FFmpeg HW accelerator documentation to know how to fill this
2507 * is. e.g. for VA API, this is a struct vaapi_context.
2508 * - encoding: unused
2509 * - decoding: Set by user
2511 void *hwaccel_context;
2515 * - encoding: Set by libavcodec if flags&CODEC_FLAG_PSNR.
2516 * - decoding: unused
2518 uint64_t error[AV_NUM_DATA_POINTERS];
2521 * DCT algorithm, see FF_DCT_* below
2522 * - encoding: Set by user.
2523 * - decoding: unused
2526 #define FF_DCT_AUTO 0
2527 #define FF_DCT_FASTINT 1
2528 #define FF_DCT_INT 2
2529 #define FF_DCT_MMX 3
2530 #define FF_DCT_ALTIVEC 5
2531 #define FF_DCT_FAAN 6
2534 * IDCT algorithm, see FF_IDCT_* below.
2535 * - encoding: Set by user.
2536 * - decoding: Set by user.
2539 #define FF_IDCT_AUTO 0
2540 #define FF_IDCT_INT 1
2541 #define FF_IDCT_SIMPLE 2
2542 #define FF_IDCT_SIMPLEMMX 3
2543 #define FF_IDCT_ARM 7
2544 #define FF_IDCT_ALTIVEC 8
2545 #define FF_IDCT_SH4 9
2546 #define FF_IDCT_SIMPLEARM 10
2547 #define FF_IDCT_IPP 13
2548 #define FF_IDCT_XVIDMMX 14
2549 #define FF_IDCT_SIMPLEARMV5TE 16
2550 #define FF_IDCT_SIMPLEARMV6 17
2551 #define FF_IDCT_SIMPLEVIS 18
2552 #define FF_IDCT_FAAN 20
2553 #define FF_IDCT_SIMPLENEON 22
2554 #define FF_IDCT_SIMPLEALPHA 23
2557 * bits per sample/pixel from the demuxer (needed for huffyuv).
2558 * - encoding: Set by libavcodec.
2559 * - decoding: Set by user.
2561 int bits_per_coded_sample;
2564 * Bits per sample/pixel of internal libavcodec pixel/sample format.
2565 * - encoding: set by user.
2566 * - decoding: set by libavcodec.
2568 int bits_per_raw_sample;
2572 * low resolution decoding, 1-> 1/2 size, 2->1/4 size
2573 * - encoding: unused
2574 * - decoding: Set by user.
2575 * Code outside libavcodec should access this field using:
2576 * av_codec_{get,set}_lowres(avctx)
2582 * the picture in the bitstream
2583 * - encoding: Set by libavcodec.
2584 * - decoding: Set by libavcodec.
2586 AVFrame *coded_frame;
2590 * is used to decide how many independent tasks should be passed to execute()
2591 * - encoding: Set by user.
2592 * - decoding: Set by user.
2597 * Which multithreading methods to use.
2598 * Use of FF_THREAD_FRAME will increase decoding delay by one frame per thread,
2599 * so clients which cannot provide future frames should not use it.
2601 * - encoding: Set by user, otherwise the default is used.
2602 * - decoding: Set by user, otherwise the default is used.
2605 #define FF_THREAD_FRAME 1 ///< Decode more than one frame at once
2606 #define FF_THREAD_SLICE 2 ///< Decode more than one part of a single frame at once
2609 * Which multithreading methods are in use by the codec.
2610 * - encoding: Set by libavcodec.
2611 * - decoding: Set by libavcodec.
2613 int active_thread_type;
2616 * Set by the client if its custom get_buffer() callback can be called
2617 * synchronously from another thread, which allows faster multithreaded decoding.
2618 * draw_horiz_band() will be called from other threads regardless of this setting.
2619 * Ignored if the default get_buffer() is used.
2620 * - encoding: Set by user.
2621 * - decoding: Set by user.
2623 int thread_safe_callbacks;
2626 * The codec may call this to execute several independent things.
2627 * It will return only after finishing all tasks.
2628 * The user may replace this with some multithreaded implementation,
2629 * the default implementation will execute the parts serially.
2630 * @param count the number of things to execute
2631 * - encoding: Set by libavcodec, user can override.
2632 * - decoding: Set by libavcodec, user can override.
2634 int (*execute)(struct AVCodecContext *c, int (*func)(struct AVCodecContext *c2, void *arg), void *arg2, int *ret, int count, int size);
2637 * The codec may call this to execute several independent things.
2638 * It will return only after finishing all tasks.
2639 * The user may replace this with some multithreaded implementation,
2640 * the default implementation will execute the parts serially.
2641 * Also see avcodec_thread_init and e.g. the --enable-pthread configure option.
2642 * @param c context passed also to func
2643 * @param count the number of things to execute
2644 * @param arg2 argument passed unchanged to func
2645 * @param ret return values of executed functions, must have space for "count" values. May be NULL.
2646 * @param func function that will be called count times, with jobnr from 0 to count-1.
2647 * threadnr will be in the range 0 to c->thread_count-1 < MAX_THREADS and so that no
2648 * two instances of func executing at the same time will have the same threadnr.
2649 * @return always 0 currently, but code should handle a future improvement where when any call to func
2650 * returns < 0 no further calls to func may be done and < 0 is returned.
2651 * - encoding: Set by libavcodec, user can override.
2652 * - decoding: Set by libavcodec, user can override.
2654 int (*execute2)(struct AVCodecContext *c, int (*func)(struct AVCodecContext *c2, void *arg, int jobnr, int threadnr), void *arg2, int *ret, int count);
2658 * Can be used by execute() to store some per AVCodecContext stuff.
2659 * - encoding: set by execute()
2660 * - decoding: set by execute()
2662 void *thread_opaque;
2665 * noise vs. sse weight for the nsse comparsion function
2666 * - encoding: Set by user.
2667 * - decoding: unused
2673 * - encoding: Set by user.
2674 * - decoding: Set by libavcodec.
2677 #define FF_PROFILE_UNKNOWN -99
2678 #define FF_PROFILE_RESERVED -100
2680 #define FF_PROFILE_AAC_MAIN 0
2681 #define FF_PROFILE_AAC_LOW 1
2682 #define FF_PROFILE_AAC_SSR 2
2683 #define FF_PROFILE_AAC_LTP 3
2684 #define FF_PROFILE_AAC_HE 4
2685 #define FF_PROFILE_AAC_HE_V2 28
2686 #define FF_PROFILE_AAC_LD 22
2687 #define FF_PROFILE_AAC_ELD 38
2688 #define FF_PROFILE_MPEG2_AAC_LOW 128
2689 #define FF_PROFILE_MPEG2_AAC_HE 131
2691 #define FF_PROFILE_DTS 20
2692 #define FF_PROFILE_DTS_ES 30
2693 #define FF_PROFILE_DTS_96_24 40
2694 #define FF_PROFILE_DTS_HD_HRA 50
2695 #define FF_PROFILE_DTS_HD_MA 60
2697 #define FF_PROFILE_MPEG2_422 0
2698 #define FF_PROFILE_MPEG2_HIGH 1
2699 #define FF_PROFILE_MPEG2_SS 2
2700 #define FF_PROFILE_MPEG2_SNR_SCALABLE 3
2701 #define FF_PROFILE_MPEG2_MAIN 4
2702 #define FF_PROFILE_MPEG2_SIMPLE 5
2704 #define FF_PROFILE_H264_CONSTRAINED (1<<9) // 8+1; constraint_set1_flag
2705 #define FF_PROFILE_H264_INTRA (1<<11) // 8+3; constraint_set3_flag
2707 #define FF_PROFILE_H264_BASELINE 66
2708 #define FF_PROFILE_H264_CONSTRAINED_BASELINE (66|FF_PROFILE_H264_CONSTRAINED)
2709 #define FF_PROFILE_H264_MAIN 77
2710 #define FF_PROFILE_H264_EXTENDED 88
2711 #define FF_PROFILE_H264_HIGH 100
2712 #define FF_PROFILE_H264_HIGH_10 110
2713 #define FF_PROFILE_H264_HIGH_10_INTRA (110|FF_PROFILE_H264_INTRA)
2714 #define FF_PROFILE_H264_HIGH_422 122
2715 #define FF_PROFILE_H264_HIGH_422_INTRA (122|FF_PROFILE_H264_INTRA)
2716 #define FF_PROFILE_H264_HIGH_444 144
2717 #define FF_PROFILE_H264_HIGH_444_PREDICTIVE 244
2718 #define FF_PROFILE_H264_HIGH_444_INTRA (244|FF_PROFILE_H264_INTRA)
2719 #define FF_PROFILE_H264_CAVLC_444 44
2721 #define FF_PROFILE_VC1_SIMPLE 0
2722 #define FF_PROFILE_VC1_MAIN 1
2723 #define FF_PROFILE_VC1_COMPLEX 2
2724 #define FF_PROFILE_VC1_ADVANCED 3
2726 #define FF_PROFILE_MPEG4_SIMPLE 0
2727 #define FF_PROFILE_MPEG4_SIMPLE_SCALABLE 1
2728 #define FF_PROFILE_MPEG4_CORE 2
2729 #define FF_PROFILE_MPEG4_MAIN 3
2730 #define FF_PROFILE_MPEG4_N_BIT 4
2731 #define FF_PROFILE_MPEG4_SCALABLE_TEXTURE 5
2732 #define FF_PROFILE_MPEG4_SIMPLE_FACE_ANIMATION 6
2733 #define FF_PROFILE_MPEG4_BASIC_ANIMATED_TEXTURE 7
2734 #define FF_PROFILE_MPEG4_HYBRID 8
2735 #define FF_PROFILE_MPEG4_ADVANCED_REAL_TIME 9
2736 #define FF_PROFILE_MPEG4_CORE_SCALABLE 10
2737 #define FF_PROFILE_MPEG4_ADVANCED_CODING 11
2738 #define FF_PROFILE_MPEG4_ADVANCED_CORE 12
2739 #define FF_PROFILE_MPEG4_ADVANCED_SCALABLE_TEXTURE 13
2740 #define FF_PROFILE_MPEG4_SIMPLE_STUDIO 14
2741 #define FF_PROFILE_MPEG4_ADVANCED_SIMPLE 15
2743 #define FF_PROFILE_JPEG2000_CSTREAM_RESTRICTION_0 0
2744 #define FF_PROFILE_JPEG2000_CSTREAM_RESTRICTION_1 1
2745 #define FF_PROFILE_JPEG2000_CSTREAM_NO_RESTRICTION 2
2746 #define FF_PROFILE_JPEG2000_DCINEMA_2K 3
2747 #define FF_PROFILE_JPEG2000_DCINEMA_4K 4
2751 * - encoding: Set by user.
2752 * - decoding: Set by libavcodec.
2755 #define FF_LEVEL_UNKNOWN -99
2758 * Skip loop filtering for selected frames.
2759 * - encoding: unused
2760 * - decoding: Set by user.
2762 enum AVDiscard skip_loop_filter;
2765 * Skip IDCT/dequantization for selected frames.
2766 * - encoding: unused
2767 * - decoding: Set by user.
2769 enum AVDiscard skip_idct;
2772 * Skip decoding for selected frames.
2773 * - encoding: unused
2774 * - decoding: Set by user.
2776 enum AVDiscard skip_frame;
2779 * Header containing style information for text subtitles.
2780 * For SUBTITLE_ASS subtitle type, it should contain the whole ASS
2781 * [Script Info] and [V4+ Styles] section, plus the [Events] line and
2782 * the Format line following. It shouldn't include any Dialogue line.
2783 * - encoding: Set/allocated/freed by user (before avcodec_open2())
2784 * - decoding: Set/allocated/freed by libavcodec (by avcodec_open2())
2786 uint8_t *subtitle_header;
2787 int subtitle_header_size;
2790 * Simulates errors in the bitstream to test error concealment.
2791 * - encoding: Set by user.
2792 * - decoding: unused
2797 * Current packet as passed into the decoder, to avoid having
2798 * to pass the packet into every function. Currently only valid
2799 * inside lavc and get/release_buffer callbacks.
2800 * - decoding: set by avcodec_decode_*, read by get_buffer() for setting pkt_pts
2801 * - encoding: unused
2806 * VBV delay coded in the last frame (in periods of a 27 MHz clock).
2807 * Used for compliant TS muxing.
2808 * - encoding: Set by libavcodec.
2809 * - decoding: unused.
2814 * Timebase in which pkt_dts/pts and AVPacket.dts/pts are.
2815 * Code outside libavcodec should access this field using:
2816 * av_codec_{get,set}_pkt_timebase(avctx)
2817 * - encoding unused.
2818 * - decoding set by user.
2820 AVRational pkt_timebase;
2824 * Code outside libavcodec should access this field using:
2825 * av_codec_{get,set}_codec_descriptor(avctx)
2826 * - encoding: unused.
2827 * - decoding: set by libavcodec.
2829 const AVCodecDescriptor *codec_descriptor;
2833 * low resolution decoding, 1-> 1/2 size, 2->1/4 size
2834 * - encoding: unused
2835 * - decoding: Set by user.
2836 * Code outside libavcodec should access this field using:
2837 * av_codec_{get,set}_lowres(avctx)
2843 * Current statistics for PTS correction.
2844 * - decoding: maintained and used by libavcodec, not intended to be used by user apps
2845 * - encoding: unused
2847 int64_t pts_correction_num_faulty_pts; /// Number of incorrect PTS values so far
2848 int64_t pts_correction_num_faulty_dts; /// Number of incorrect DTS values so far
2849 int64_t pts_correction_last_pts; /// PTS of the last frame
2850 int64_t pts_correction_last_dts; /// DTS of the last frame
2853 * Character encoding of the input subtitles file.
2854 * - decoding: set by user
2855 * - encoding: unused
2860 * Subtitles character encoding mode. Formats or codecs might be adjusting
2861 * this setting (if they are doing the conversion themselves for instance).
2862 * - decoding: set by libavcodec
2863 * - encoding: unused
2865 int sub_charenc_mode;
2866 #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)
2867 #define FF_SUB_CHARENC_MODE_AUTOMATIC 0 ///< libavcodec will select the mode itself
2868 #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
2871 * Skip processing alpha if supported by codec.
2872 * Note that if the format uses pre-multiplied alpha (common with VP6,
2873 * and recommended due to better video quality/compression)
2874 * the image will look as if alpha-blended onto a black background.
2875 * However for formats that do not use pre-multiplied alpha
2876 * there might be serious artefacts (though e.g. libswscale currently
2877 * assumes pre-multiplied alpha anyway).
2878 * Code outside libavcodec should access this field using AVOptions
2880 * - decoding: set by user
2881 * - encoding: unused
2886 AVRational av_codec_get_pkt_timebase (const AVCodecContext *avctx);
2887 void av_codec_set_pkt_timebase (AVCodecContext *avctx, AVRational val);
2889 const AVCodecDescriptor *av_codec_get_codec_descriptor(const AVCodecContext *avctx);
2890 void av_codec_set_codec_descriptor(AVCodecContext *avctx, const AVCodecDescriptor *desc);
2892 int av_codec_get_lowres(const AVCodecContext *avctx);
2893 void av_codec_set_lowres(AVCodecContext *avctx, int val);
2898 typedef struct AVProfile {
2900 const char *name; ///< short name for the profile
2903 typedef struct AVCodecDefault AVCodecDefault;
2910 typedef struct AVCodec {
2912 * Name of the codec implementation.
2913 * The name is globally unique among encoders and among decoders (but an
2914 * encoder and a decoder can share the same name).
2915 * This is the primary way to find a codec from the user perspective.
2919 * Descriptive name for the codec, meant to be more human readable than name.
2920 * You should use the NULL_IF_CONFIG_SMALL() macro to define it.
2922 const char *long_name;
2923 enum AVMediaType type;
2926 * Codec capabilities.
2930 const AVRational *supported_framerates; ///< array of supported framerates, or NULL if any, array is terminated by {0,0}
2931 const enum AVPixelFormat *pix_fmts; ///< array of supported pixel formats, or NULL if unknown, array is terminated by -1
2932 const int *supported_samplerates; ///< array of supported audio samplerates, or NULL if unknown, array is terminated by 0
2933 const enum AVSampleFormat *sample_fmts; ///< array of supported sample formats, or NULL if unknown, array is terminated by -1
2934 const uint64_t *channel_layouts; ///< array of support channel layouts, or NULL if unknown. array is terminated by 0
2936 uint8_t max_lowres; ///< maximum value for lowres supported by the decoder, no direct access, use av_codec_get_max_lowres()
2938 const AVClass *priv_class; ///< AVClass for the private context
2939 const AVProfile *profiles; ///< array of recognized profiles, or NULL if unknown, array is terminated by {FF_PROFILE_UNKNOWN}
2941 /*****************************************************************
2942 * No fields below this line are part of the public API. They
2943 * may not be used outside of libavcodec and can be changed and
2945 * New public fields should be added right above.
2946 *****************************************************************
2949 struct AVCodec *next;
2951 * @name Frame-level threading support functions
2955 * If defined, called on thread contexts when they are created.
2956 * If the codec allocates writable tables in init(), re-allocate them here.
2957 * priv_data will be set to a copy of the original.
2959 int (*init_thread_copy)(AVCodecContext *);
2961 * Copy necessary context variables from a previous thread context to the current one.
2962 * If not defined, the next thread will start automatically; otherwise, the codec
2963 * must call ff_thread_finish_setup().
2965 * dst and src will (rarely) point to the same context, in which case memcpy should be skipped.
2967 int (*update_thread_context)(AVCodecContext *dst, const AVCodecContext *src);
2971 * Private codec-specific defaults.
2973 const AVCodecDefault *defaults;
2976 * Initialize codec static data, called from avcodec_register().
2978 void (*init_static_data)(struct AVCodec *codec);
2980 int (*init)(AVCodecContext *);
2981 int (*encode_sub)(AVCodecContext *, uint8_t *buf, int buf_size,
2982 const struct AVSubtitle *sub);
2984 * Encode data to an AVPacket.
2986 * @param avctx codec context
2987 * @param avpkt output AVPacket (may contain a user-provided buffer)
2988 * @param[in] frame AVFrame containing the raw data to be encoded
2989 * @param[out] got_packet_ptr encoder sets to 0 or 1 to indicate that a
2990 * non-empty packet was returned in avpkt.
2991 * @return 0 on success, negative error code on failure
2993 int (*encode2)(AVCodecContext *avctx, AVPacket *avpkt, const AVFrame *frame,
2994 int *got_packet_ptr);
2995 int (*decode)(AVCodecContext *, void *outdata, int *outdata_size, AVPacket *avpkt);
2996 int (*close)(AVCodecContext *);
2999 * Will be called when seeking
3001 void (*flush)(AVCodecContext *);
3004 int av_codec_get_max_lowres(const AVCodec *codec);
3009 typedef struct AVHWAccel {
3011 * Name of the hardware accelerated codec.
3012 * The name is globally unique among encoders and among decoders (but an
3013 * encoder and a decoder can share the same name).
3018 * Type of codec implemented by the hardware accelerator.
3020 * See AVMEDIA_TYPE_xxx
3022 enum AVMediaType type;
3025 * Codec implemented by the hardware accelerator.
3027 * See AV_CODEC_ID_xxx
3032 * Supported pixel format.
3034 * Only hardware accelerated formats are supported here.
3036 enum AVPixelFormat pix_fmt;
3039 * Hardware accelerated codec capabilities.
3040 * see FF_HWACCEL_CODEC_CAP_*
3044 struct AVHWAccel *next;
3047 * Called at the beginning of each frame or field picture.
3049 * Meaningful frame information (codec specific) is guaranteed to
3050 * be parsed at this point. This function is mandatory.
3052 * Note that buf can be NULL along with buf_size set to 0.
3053 * Otherwise, this means the whole frame is available at this point.
3055 * @param avctx the codec context
3056 * @param buf the frame data buffer base
3057 * @param buf_size the size of the frame in bytes
3058 * @return zero if successful, a negative value otherwise
3060 int (*start_frame)(AVCodecContext *avctx, const uint8_t *buf, uint32_t buf_size);
3063 * Callback for each slice.
3065 * Meaningful slice information (codec specific) is guaranteed to
3066 * be parsed at this point. This function is mandatory.
3068 * @param avctx the codec context
3069 * @param buf the slice data buffer base
3070 * @param buf_size the size of the slice in bytes
3071 * @return zero if successful, a negative value otherwise
3073 int (*decode_slice)(AVCodecContext *avctx, const uint8_t *buf, uint32_t buf_size);
3076 * Called at the end of each frame or field picture.
3078 * The whole picture is parsed at this point and can now be sent
3079 * to the hardware accelerator. This function is mandatory.
3081 * @param avctx the codec context
3082 * @return zero if successful, a negative value otherwise
3084 int (*end_frame)(AVCodecContext *avctx);
3087 * Size of HW accelerator private data.
3089 * Private data is allocated with av_mallocz() before
3090 * AVCodecContext.get_buffer() and deallocated after
3091 * AVCodecContext.release_buffer().
3097 * @defgroup lavc_picture AVPicture
3099 * Functions for working with AVPicture
3104 * Picture data structure.
3106 * Up to four components can be stored into it, the last component is
3109 typedef struct AVPicture {
3110 uint8_t *data[AV_NUM_DATA_POINTERS]; ///< pointers to the image data planes
3111 int linesize[AV_NUM_DATA_POINTERS]; ///< number of bytes per line
3118 enum AVSubtitleType {
3121 SUBTITLE_BITMAP, ///< A bitmap, pict will be set
3124 * Plain text, the text field must be set by the decoder and is
3125 * authoritative. ass and pict fields may contain approximations.
3130 * Formatted text, the ass field must be set by the decoder and is
3131 * authoritative. pict and text fields may contain approximations.
3136 #define AV_SUBTITLE_FLAG_FORCED 0x00000001
3138 typedef struct AVSubtitleRect {
3139 int x; ///< top left corner of pict, undefined when pict is not set
3140 int y; ///< top left corner of pict, undefined when pict is not set
3141 int w; ///< width of pict, undefined when pict is not set
3142 int h; ///< height of pict, undefined when pict is not set
3143 int nb_colors; ///< number of colors in pict, undefined when pict is not set
3146 * data+linesize for the bitmap of this subtitle.
3147 * can be set for text/ass as well once they where rendered
3150 enum AVSubtitleType type;
3152 char *text; ///< 0 terminated plain UTF-8 text
3155 * 0 terminated ASS/SSA compatible event line.
3156 * The presentation of this is unaffected by the other values in this
3164 typedef struct AVSubtitle {
3165 uint16_t format; /* 0 = graphics */
3166 uint32_t start_display_time; /* relative to packet pts, in ms */
3167 uint32_t end_display_time; /* relative to packet pts, in ms */
3169 AVSubtitleRect **rects;
3170 int64_t pts; ///< Same as packet pts, in AV_TIME_BASE
3174 * If c is NULL, returns the first registered codec,
3175 * if c is non-NULL, returns the next registered codec after c,
3176 * or NULL if c is the last one.
3178 AVCodec *av_codec_next(const AVCodec *c);
3181 * Return the LIBAVCODEC_VERSION_INT constant.
3183 unsigned avcodec_version(void);
3186 * Return the libavcodec build-time configuration.
3188 const char *avcodec_configuration(void);
3191 * Return the libavcodec license.
3193 const char *avcodec_license(void);
3196 * Register the codec codec and initialize libavcodec.
3198 * @warning either this function or avcodec_register_all() must be called
3199 * before any other libavcodec functions.
3201 * @see avcodec_register_all()
3203 void avcodec_register(AVCodec *codec);
3206 * Register all the codecs, parsers and bitstream filters which were enabled at
3207 * configuration time. If you do not call this function you can select exactly
3208 * which formats you want to support, by using the individual registration
3211 * @see avcodec_register
3212 * @see av_register_codec_parser
3213 * @see av_register_bitstream_filter
3215 void avcodec_register_all(void);
3218 #if FF_API_ALLOC_CONTEXT
3220 * Allocate an AVCodecContext and set its fields to default values. The
3221 * resulting struct can be deallocated by simply calling av_free().
3223 * @return An AVCodecContext filled with default values or NULL on failure.
3224 * @see avcodec_get_context_defaults
3226 * @deprecated use avcodec_alloc_context3()
3228 attribute_deprecated
3229 AVCodecContext *avcodec_alloc_context(void);
3231 /** THIS FUNCTION IS NOT YET PART OF THE PUBLIC API!
3232 * we WILL change its arguments and name a few times! */
3233 attribute_deprecated
3234 AVCodecContext *avcodec_alloc_context2(enum AVMediaType);
3237 * Set the fields of the given AVCodecContext to default values.
3239 * @param s The AVCodecContext of which the fields should be set to default values.
3240 * @deprecated use avcodec_get_context_defaults3
3242 attribute_deprecated
3243 void avcodec_get_context_defaults(AVCodecContext *s);
3245 /** THIS FUNCTION IS NOT YET PART OF THE PUBLIC API!
3246 * we WILL change its arguments and name a few times! */
3247 attribute_deprecated
3248 void avcodec_get_context_defaults2(AVCodecContext *s, enum AVMediaType);
3252 * Allocate an AVCodecContext and set its fields to default values. The
3253 * resulting struct can be deallocated by calling avcodec_close() on it followed
3256 * @param codec if non-NULL, allocate private data and initialize defaults
3257 * for the given codec. It is illegal to then call avcodec_open2()
3258 * with a different codec.
3259 * If NULL, then the codec-specific defaults won't be initialized,
3260 * which may result in suboptimal default settings (this is
3261 * important mainly for encoders, e.g. libx264).
3263 * @return An AVCodecContext filled with default values or NULL on failure.
3264 * @see avcodec_get_context_defaults
3266 AVCodecContext *avcodec_alloc_context3(const AVCodec *codec);
3269 * Set the fields of the given AVCodecContext to default values corresponding
3270 * to the given codec (defaults may be codec-dependent).
3272 * Do not call this function if a non-NULL codec has been passed
3273 * to avcodec_alloc_context3() that allocated this AVCodecContext.
3274 * If codec is non-NULL, it is illegal to call avcodec_open2() with a
3275 * different codec on this AVCodecContext.
3277 int avcodec_get_context_defaults3(AVCodecContext *s, const AVCodec *codec);
3280 * Get the AVClass for AVCodecContext. It can be used in combination with
3281 * AV_OPT_SEARCH_FAKE_OBJ for examining options.
3283 * @see av_opt_find().
3285 const AVClass *avcodec_get_class(void);
3288 * Get the AVClass for AVFrame. It can be used in combination with
3289 * AV_OPT_SEARCH_FAKE_OBJ for examining options.
3291 * @see av_opt_find().
3293 const AVClass *avcodec_get_frame_class(void);
3296 * Get the AVClass for AVSubtitleRect. It can be used in combination with
3297 * AV_OPT_SEARCH_FAKE_OBJ for examining options.
3299 * @see av_opt_find().
3301 const AVClass *avcodec_get_subtitle_rect_class(void);
3304 * Copy the settings of the source AVCodecContext into the destination
3305 * AVCodecContext. The resulting destination codec context will be
3306 * unopened, i.e. you are required to call avcodec_open2() before you
3307 * can use this AVCodecContext to decode/encode video/audio data.
3309 * @param dest target codec context, should be initialized with
3310 * avcodec_alloc_context3(NULL), but otherwise uninitialized
3311 * @param src source codec context
3312 * @return AVERROR() on error (e.g. memory allocation error), 0 on success
3314 int avcodec_copy_context(AVCodecContext *dest, const AVCodecContext *src);
3317 * Allocate an AVFrame and set its fields to default values. The resulting
3318 * struct must be freed using avcodec_free_frame().
3320 * @return An AVFrame filled with default values or NULL on failure.
3321 * @see avcodec_get_frame_defaults
3323 AVFrame *avcodec_alloc_frame(void);
3326 * Set the fields of the given AVFrame to default values.
3328 * @param frame The AVFrame of which the fields should be set to default values.
3330 void avcodec_get_frame_defaults(AVFrame *frame);
3333 * Free the frame and any dynamically allocated objects in it,
3334 * e.g. extended_data.
3336 * @param frame frame to be freed. The pointer will be set to NULL.
3338 * @warning this function does NOT free the data buffers themselves
3339 * (it does not know how, since they might have been allocated with
3340 * a custom get_buffer()).
3342 void avcodec_free_frame(AVFrame **frame);
3344 #if FF_API_AVCODEC_OPEN
3346 * Initialize the AVCodecContext to use the given AVCodec. Prior to using this
3347 * function the context has to be allocated.
3349 * The functions avcodec_find_decoder_by_name(), avcodec_find_encoder_by_name(),
3350 * avcodec_find_decoder() and avcodec_find_encoder() provide an easy way for
3351 * retrieving a codec.
3353 * @warning This function is not thread safe!
3356 * avcodec_register_all();
3357 * codec = avcodec_find_decoder(AV_CODEC_ID_H264);
3361 * context = avcodec_alloc_context3(codec);
3363 * if (avcodec_open(context, codec) < 0)
3367 * @param avctx The context which will be set up to use the given codec.
3368 * @param codec The codec to use within the context.
3369 * @return zero on success, a negative value on error
3370 * @see avcodec_alloc_context3, avcodec_find_decoder, avcodec_find_encoder, avcodec_close
3372 * @deprecated use avcodec_open2
3374 attribute_deprecated
3375 int avcodec_open(AVCodecContext *avctx, AVCodec *codec);
3379 * Initialize the AVCodecContext to use the given AVCodec. Prior to using this
3380 * function the context has to be allocated with avcodec_alloc_context3().
3382 * The functions avcodec_find_decoder_by_name(), avcodec_find_encoder_by_name(),
3383 * avcodec_find_decoder() and avcodec_find_encoder() provide an easy way for
3384 * retrieving a codec.
3386 * @warning This function is not thread safe!
3389 * avcodec_register_all();
3390 * av_dict_set(&opts, "b", "2.5M", 0);
3391 * codec = avcodec_find_decoder(AV_CODEC_ID_H264);
3395 * context = avcodec_alloc_context3(codec);
3397 * if (avcodec_open2(context, codec, opts) < 0)
3401 * @param avctx The context to initialize.
3402 * @param codec The codec to open this context for. If a non-NULL codec has been
3403 * previously passed to avcodec_alloc_context3() or
3404 * avcodec_get_context_defaults3() for this context, then this
3405 * parameter MUST be either NULL or equal to the previously passed
3407 * @param options A dictionary filled with AVCodecContext and codec-private options.
3408 * On return this object will be filled with options that were not found.
3410 * @return zero on success, a negative value on error
3411 * @see avcodec_alloc_context3(), avcodec_find_decoder(), avcodec_find_encoder(),
3412 * av_dict_set(), av_opt_find().
3414 int avcodec_open2(AVCodecContext *avctx, const AVCodec *codec, AVDictionary **options);
3417 * Close a given AVCodecContext and free all the data associated with it
3418 * (but not the AVCodecContext itself).
3420 * Calling this function on an AVCodecContext that hasn't been opened will free
3421 * the codec-specific data allocated in avcodec_alloc_context3() /
3422 * avcodec_get_context_defaults3() with a non-NULL codec. Subsequent calls will
3425 int avcodec_close(AVCodecContext *avctx);
3428 * Free all allocated data in the given subtitle struct.
3430 * @param sub AVSubtitle to free.
3432 void avsubtitle_free(AVSubtitle *sub);
3439 * @addtogroup lavc_packet
3443 #if FF_API_DESTRUCT_PACKET
3445 * Default packet destructor.
3446 * @deprecated use the AVBuffer API instead
3448 attribute_deprecated
3449 void av_destruct_packet(AVPacket *pkt);
3453 * Initialize optional fields of a packet with default values.
3455 * Note, this does not touch the data and size members, which have to be
3456 * initialized separately.
3460 void av_init_packet(AVPacket *pkt);
3463 * Allocate the payload of a packet and initialize its fields with
3467 * @param size wanted payload size
3468 * @return 0 if OK, AVERROR_xxx otherwise
3470 int av_new_packet(AVPacket *pkt, int size);
3473 * Reduce packet size, correctly zeroing padding
3476 * @param size new size
3478 void av_shrink_packet(AVPacket *pkt, int size);
3481 * Increase packet size, correctly zeroing padding
3484 * @param grow_by number of bytes by which to increase the size of the packet
3486 int av_grow_packet(AVPacket *pkt, int grow_by);
3489 * Initialize a reference-counted packet from av_malloc()ed data.
3491 * @param pkt packet to be initialized. This function will set the data, size,
3492 * buf and destruct fields, all others are left untouched.
3493 * @param data Data allocated by av_malloc() to be used as packet data. If this
3494 * function returns successfully, the data is owned by the underlying AVBuffer.
3495 * The caller may not access the data through other means.
3496 * @param size size of data in bytes, without the padding. I.e. the full buffer
3497 * size is assumed to be size + FF_INPUT_BUFFER_PADDING_SIZE.
3499 * @return 0 on success, a negative AVERROR on error
3501 int av_packet_from_data(AVPacket *pkt, uint8_t *data, int size);
3504 * @warning This is a hack - the packet memory allocation stuff is broken. The
3505 * packet is allocated if it was not really allocated.
3507 int av_dup_packet(AVPacket *pkt);
3510 * Copy packet, including contents
3512 * @return 0 on success, negative AVERROR on fail
3514 int av_copy_packet(AVPacket *dst, AVPacket *src);
3517 * Copy packet side data
3519 * @return 0 on success, negative AVERROR on fail
3521 int av_copy_packet_side_data(AVPacket *dst, AVPacket *src);
3526 * @param pkt packet to free
3528 void av_free_packet(AVPacket *pkt);
3531 * Allocate new information of a packet.
3534 * @param type side information type
3535 * @param size side information size
3536 * @return pointer to fresh allocated data or NULL otherwise
3538 uint8_t* av_packet_new_side_data(AVPacket *pkt, enum AVPacketSideDataType type,
3542 * Shrink the already allocated side data buffer
3545 * @param type side information type
3546 * @param size new side information size
3547 * @return 0 on success, < 0 on failure
3549 int av_packet_shrink_side_data(AVPacket *pkt, enum AVPacketSideDataType type,
3553 * Get side information from packet.
3556 * @param type desired side information type
3557 * @param size pointer for side information size to store (optional)
3558 * @return pointer to data if present or NULL otherwise
3560 uint8_t* av_packet_get_side_data(AVPacket *pkt, enum AVPacketSideDataType type,
3563 int av_packet_merge_side_data(AVPacket *pkt);
3565 int av_packet_split_side_data(AVPacket *pkt);
3569 * Convenience function to free all the side data stored.
3570 * All the other fields stay untouched.
3574 void av_packet_free_side_data(AVPacket *pkt);
3577 * Setup a new reference to the data described by a given packet
3579 * If src is reference-counted, setup dst as a new reference to the
3580 * buffer in src. Otherwise allocate a new buffer in dst and copy the
3581 * data from src into it.
3583 * All the other fields are copied from src.
3585 * @see av_packet_unref
3587 * @param dst Destination packet
3588 * @param src Source packet
3590 * @return 0 on success, a negative AVERROR on error.
3592 int av_packet_ref(AVPacket *dst, AVPacket *src);
3597 * Unreference the buffer referenced by the packet and reset the
3598 * remaining packet fields to their default values.
3600 * @param pkt The packet to be unreferenced.
3602 void av_packet_unref(AVPacket *pkt);
3605 * Move every field in src to dst and reset src.
3607 * @see av_packet_unref
3609 * @param src Source packet, will be reset
3610 * @param dst Destination packet
3612 void av_packet_move_ref(AVPacket *dst, AVPacket *src);
3615 * Copy only "properties" fields from src to dst.
3617 * Properties for the purpose of this function are all the fields
3618 * beside those related to the packet data (buf, data, size)
3620 * @param dst Destination packet
3621 * @param src Source packet
3623 * @return 0 on success AVERROR on failure.
3626 int av_packet_copy_props(AVPacket *dst, const AVPacket *src);
3633 * @addtogroup lavc_decoding
3638 * Find a registered decoder with a matching codec ID.
3640 * @param id AVCodecID of the requested decoder
3641 * @return A decoder if one was found, NULL otherwise.
3643 AVCodec *avcodec_find_decoder(enum AVCodecID id);
3646 * Find a registered decoder with the specified name.
3648 * @param name name of the requested decoder
3649 * @return A decoder if one was found, NULL otherwise.
3651 AVCodec *avcodec_find_decoder_by_name(const char *name);
3653 #if FF_API_GET_BUFFER
3654 attribute_deprecated int avcodec_default_get_buffer(AVCodecContext *s, AVFrame *pic);
3655 attribute_deprecated void avcodec_default_release_buffer(AVCodecContext *s, AVFrame *pic);
3656 attribute_deprecated int avcodec_default_reget_buffer(AVCodecContext *s, AVFrame *pic);
3660 * The default callback for AVCodecContext.get_buffer2(). It is made public so
3661 * it can be called by custom get_buffer2() implementations for decoders without
3662 * CODEC_CAP_DR1 set.
3664 int avcodec_default_get_buffer2(AVCodecContext *s, AVFrame *frame, int flags);
3667 * Return the amount of padding in pixels which the get_buffer callback must
3668 * provide around the edge of the image for codecs which do not have the
3669 * CODEC_FLAG_EMU_EDGE flag.
3671 * @return Required padding in pixels.
3673 unsigned avcodec_get_edge_width(void);
3676 * Modify width and height values so that they will result in a memory
3677 * buffer that is acceptable for the codec if you do not use any horizontal
3680 * May only be used if a codec with CODEC_CAP_DR1 has been opened.
3681 * If CODEC_FLAG_EMU_EDGE is not set, the dimensions must have been increased
3682 * according to avcodec_get_edge_width() before.
3684 void avcodec_align_dimensions(AVCodecContext *s, int *width, int *height);
3687 * Modify width and height values so that they will result in a memory
3688 * buffer that is acceptable for the codec if you also ensure that all
3689 * line sizes are a multiple of the respective linesize_align[i].
3691 * May only be used if a codec with CODEC_CAP_DR1 has been opened.
3692 * If CODEC_FLAG_EMU_EDGE is not set, the dimensions must have been increased
3693 * according to avcodec_get_edge_width() before.
3695 void avcodec_align_dimensions2(AVCodecContext *s, int *width, int *height,
3696 int linesize_align[AV_NUM_DATA_POINTERS]);
3699 * Converts AVChromaLocation to swscale x/y chroma position.
3701 * The positions represent the chroma (0,0) position in a coordinates system
3702 * with luma (0,0) representing the origin and luma(1,1) representing 256,256
3704 * @param xpos horizontal chroma sample position
3705 * @param ypos vertical chroma sample position
3707 int avcodec_enum_to_chroma_pos(int *xpos, int *ypos, enum AVChromaLocation pos);
3710 * Converts swscale x/y chroma position to AVChromaLocation.
3712 * The positions represent the chroma (0,0) position in a coordinates system
3713 * with luma (0,0) representing the origin and luma(1,1) representing 256,256
3715 * @param xpos horizontal chroma sample position
3716 * @param ypos vertical chroma sample position
3718 enum AVChromaLocation avcodec_chroma_pos_to_enum(int xpos, int ypos);
3720 #if FF_API_OLD_DECODE_AUDIO
3722 * Wrapper function which calls avcodec_decode_audio4.
3724 * @deprecated Use avcodec_decode_audio4 instead.
3726 * Decode the audio frame of size avpkt->size from avpkt->data into samples.
3727 * Some decoders may support multiple frames in a single AVPacket, such
3728 * decoders would then just decode the first frame. In this case,
3729 * avcodec_decode_audio3 has to be called again with an AVPacket that contains
3730 * the remaining data in order to decode the second frame etc.
3732 * could be outputted, frame_size_ptr is zero. Otherwise, it is the
3733 * decompressed frame size in bytes.
3735 * @warning You must set frame_size_ptr to the allocated size of the
3736 * output buffer before calling avcodec_decode_audio3().
3738 * @warning The input buffer must be FF_INPUT_BUFFER_PADDING_SIZE larger than
3739 * the actual read bytes because some optimized bitstream readers read 32 or 64
3740 * bits at once and could read over the end.
3742 * @warning The end of the input buffer avpkt->data should be set to 0 to ensure that
3743 * no overreading happens for damaged MPEG streams.
3745 * @warning You must not provide a custom get_buffer() when using
3746 * avcodec_decode_audio3(). Doing so will override it with
3747 * avcodec_default_get_buffer. Use avcodec_decode_audio4() instead,
3748 * which does allow the application to provide a custom get_buffer().
3750 * @note You might have to align the input buffer avpkt->data and output buffer
3751 * samples. The alignment requirements depend on the CPU: On some CPUs it isn't
3752 * necessary at all, on others it won't work at all if not aligned and on others
3753 * it will work but it will have an impact on performance.
3755 * In practice, avpkt->data should have 4 byte alignment at minimum and
3756 * samples should be 16 byte aligned unless the CPU doesn't need it
3757 * (AltiVec and SSE do).
3759 * @note Codecs which have the CODEC_CAP_DELAY capability set have a delay
3760 * between input and output, these need to be fed with avpkt->data=NULL,
3761 * avpkt->size=0 at the end to return the remaining frames.
3763 * @param avctx the codec context
3764 * @param[out] samples the output buffer, sample type in avctx->sample_fmt
3765 * If the sample format is planar, each channel plane will
3766 * be the same size, with no padding between channels.
3767 * @param[in,out] frame_size_ptr the output buffer size in bytes
3768 * @param[in] avpkt The input AVPacket containing the input buffer.
3769 * You can create such packet with av_init_packet() and by then setting
3770 * data and size, some decoders might in addition need other fields.
3771 * All decoders are designed to use the least fields possible though.
3772 * @return On error a negative value is returned, otherwise the number of bytes
3773 * used or zero if no frame data was decompressed (used) from the input AVPacket.
3775 attribute_deprecated int avcodec_decode_audio3(AVCodecContext *avctx, int16_t *samples,
3776 int *frame_size_ptr,
3781 * Decode the audio frame of size avpkt->size from avpkt->data into frame.
3783 * Some decoders may support multiple frames in a single AVPacket. Such
3784 * decoders would then just decode the first frame. In this case,
3785 * avcodec_decode_audio4 has to be called again with an AVPacket containing
3786 * the remaining data in order to decode the second frame, etc...
3787 * Even if no frames are returned, the packet needs to be fed to the decoder
3788 * with remaining data until it is completely consumed or an error occurs.
3790 * @warning The input buffer, avpkt->data must be FF_INPUT_BUFFER_PADDING_SIZE
3791 * larger than the actual read bytes because some optimized bitstream
3792 * readers read 32 or 64 bits at once and could read over the end.
3794 * @note You might have to align the input buffer. The alignment requirements
3795 * depend on the CPU and the decoder.
3797 * @param avctx the codec context
3798 * @param[out] frame The AVFrame in which to store decoded audio samples.
3799 * The decoder will allocate a buffer for the decoded frame by
3800 * calling the AVCodecContext.get_buffer2() callback.
3801 * When AVCodecContext.refcounted_frames is set to 1, the frame is
3802 * reference counted and the returned reference belongs to the
3803 * caller. The caller must release the frame using av_frame_unref()
3804 * when the frame is no longer needed. The caller may safely write
3805 * to the frame if av_frame_is_writable() returns 1.
3806 * When AVCodecContext.refcounted_frames is set to 0, the returned
3807 * reference belongs to the decoder and is valid only until the
3808 * next call to this function or until closing or flushing the
3809 * decoder. The caller may not write to it.
3810 * @param[out] got_frame_ptr Zero if no frame could be decoded, otherwise it is
3812 * @param[in] avpkt The input AVPacket containing the input buffer.
3813 * At least avpkt->data and avpkt->size should be set. Some
3814 * decoders might also require additional fields to be set.
3815 * @return A negative error code is returned if an error occurred during
3816 * decoding, otherwise the number of bytes consumed from the input
3817 * AVPacket is returned.
3819 int avcodec_decode_audio4(AVCodecContext *avctx, AVFrame *frame,
3820 int *got_frame_ptr, const AVPacket *avpkt);
3823 * Decode the video frame of size avpkt->size from avpkt->data into picture.
3824 * Some decoders may support multiple frames in a single AVPacket, such
3825 * decoders would then just decode the first frame.
3827 * @warning The input buffer must be FF_INPUT_BUFFER_PADDING_SIZE larger than
3828 * the actual read bytes because some optimized bitstream readers read 32 or 64
3829 * bits at once and could read over the end.
3831 * @warning The end of the input buffer buf should be set to 0 to ensure that
3832 * no overreading happens for damaged MPEG streams.
3834 * @note You might have to align the input buffer avpkt->data.
3835 * The alignment requirements depend on the CPU: on some CPUs it isn't
3836 * necessary at all, on others it won't work at all if not aligned and on others
3837 * it will work but it will have an impact on performance.
3839 * In practice, avpkt->data should have 4 byte alignment at minimum.
3841 * @note Codecs which have the CODEC_CAP_DELAY capability set have a delay
3842 * between input and output, these need to be fed with avpkt->data=NULL,
3843 * avpkt->size=0 at the end to return the remaining frames.
3845 * @param avctx the codec context
3846 * @param[out] picture The AVFrame in which the decoded video frame will be stored.
3847 * Use av_frame_alloc() to get an AVFrame. The codec will
3848 * allocate memory for the actual bitmap by calling the
3849 * AVCodecContext.get_buffer2() callback.
3850 * When AVCodecContext.refcounted_frames is set to 1, the frame is
3851 * reference counted and the returned reference belongs to the
3852 * caller. The caller must release the frame using av_frame_unref()
3853 * when the frame is no longer needed. The caller may safely write
3854 * to the frame if av_frame_is_writable() returns 1.
3855 * When AVCodecContext.refcounted_frames is set to 0, the returned
3856 * reference belongs to the decoder and is valid only until the
3857 * next call to this function or until closing or flushing the
3858 * decoder. The caller may not write to it.
3860 * @param[in] avpkt The input AVPacket containing the input buffer.
3861 * You can create such packet with av_init_packet() and by then setting
3862 * data and size, some decoders might in addition need other fields like
3863 * flags&AV_PKT_FLAG_KEY. All decoders are designed to use the least
3865 * @param[in,out] got_picture_ptr Zero if no frame could be decompressed, otherwise, it is nonzero.
3866 * @return On error a negative value is returned, otherwise the number of bytes
3867 * used or zero if no frame could be decompressed.
3869 int avcodec_decode_video2(AVCodecContext *avctx, AVFrame *picture,
3870 int *got_picture_ptr,
3871 const AVPacket *avpkt);
3874 * Decode a subtitle message.
3875 * Return a negative value on error, otherwise return the number of bytes used.
3876 * If no subtitle could be decompressed, got_sub_ptr is zero.
3877 * Otherwise, the subtitle is stored in *sub.
3878 * Note that CODEC_CAP_DR1 is not available for subtitle codecs. This is for
3879 * simplicity, because the performance difference is expect to be negligible
3880 * and reusing a get_buffer written for video codecs would probably perform badly
3881 * due to a potentially very different allocation pattern.
3883 * @param avctx the codec context
3884 * @param[out] sub The AVSubtitle in which the decoded subtitle will be stored, must be
3885 freed with avsubtitle_free if *got_sub_ptr is set.
3886 * @param[in,out] got_sub_ptr Zero if no subtitle could be decompressed, otherwise, it is nonzero.
3887 * @param[in] avpkt The input AVPacket containing the input buffer.
3889 int avcodec_decode_subtitle2(AVCodecContext *avctx, AVSubtitle *sub,
3894 * @defgroup lavc_parsing Frame parsing
3898 enum AVPictureStructure {
3899 AV_PICTURE_STRUCTURE_UNKNOWN, //< unknown
3900 AV_PICTURE_STRUCTURE_TOP_FIELD, //< coded as top field
3901 AV_PICTURE_STRUCTURE_BOTTOM_FIELD, //< coded as bottom field
3902 AV_PICTURE_STRUCTURE_FRAME, //< coded as frame
3905 typedef struct AVCodecParserContext {
3907 struct AVCodecParser *parser;
3908 int64_t frame_offset; /* offset of the current frame */
3909 int64_t cur_offset; /* current offset
3910 (incremented by each av_parser_parse()) */
3911 int64_t next_frame_offset; /* offset of the next frame */
3913 int pict_type; /* XXX: Put it back in AVCodecContext. */
3915 * This field is used for proper frame duration computation in lavf.
3916 * It signals, how much longer the frame duration of the current frame
3917 * is compared to normal frame duration.
3919 * frame_duration = (1 + repeat_pict) * time_base
3921 * It is used by codecs like H.264 to display telecined material.
3923 int repeat_pict; /* XXX: Put it back in AVCodecContext. */
3924 int64_t pts; /* pts of the current frame */
3925 int64_t dts; /* dts of the current frame */
3930 int fetch_timestamp;
3932 #define AV_PARSER_PTS_NB 4
3933 int cur_frame_start_index;
3934 int64_t cur_frame_offset[AV_PARSER_PTS_NB];
3935 int64_t cur_frame_pts[AV_PARSER_PTS_NB];
3936 int64_t cur_frame_dts[AV_PARSER_PTS_NB];
3939 #define PARSER_FLAG_COMPLETE_FRAMES 0x0001
3940 #define PARSER_FLAG_ONCE 0x0002
3941 /// Set if the parser has a valid file offset
3942 #define PARSER_FLAG_FETCHED_OFFSET 0x0004
3943 #define PARSER_FLAG_USE_CODEC_TS 0x1000
3945 int64_t offset; ///< byte offset from starting packet start
3946 int64_t cur_frame_end[AV_PARSER_PTS_NB];
3949 * Set by parser to 1 for key frames and 0 for non-key frames.
3950 * It is initialized to -1, so if the parser doesn't set this flag,
3951 * old-style fallback using AV_PICTURE_TYPE_I picture type as key frames
3957 * Time difference in stream time base units from the pts of this
3958 * packet to the point at which the output from the decoder has converged
3959 * independent from the availability of previous frames. That is, the
3960 * frames are virtually identical no matter if decoding started from
3961 * the very first frame or from this keyframe.
3962 * Is AV_NOPTS_VALUE if unknown.
3963 * This field is not the display duration of the current frame.
3964 * This field has no meaning if the packet does not have AV_PKT_FLAG_KEY
3967 * The purpose of this field is to allow seeking in streams that have no
3968 * keyframes in the conventional sense. It corresponds to the
3969 * recovery point SEI in H.264 and match_time_delta in NUT. It is also
3970 * essential for some types of subtitle streams to ensure that all
3971 * subtitles are correctly displayed after seeking.
3973 int64_t convergence_duration;
3975 // Timestamp generation support:
3977 * Synchronization point for start of timestamp generation.
3979 * Set to >0 for sync point, 0 for no sync point and <0 for undefined
3982 * For example, this corresponds to presence of H.264 buffering period
3988 * Offset of the current timestamp against last timestamp sync point in
3989 * units of AVCodecContext.time_base.
3991 * Set to INT_MIN when dts_sync_point unused. Otherwise, it must
3992 * contain a valid timestamp offset.
3994 * Note that the timestamp of sync point has usually a nonzero
3995 * dts_ref_dts_delta, which refers to the previous sync point. Offset of
3996 * the next frame after timestamp sync point will be usually 1.
3998 * For example, this corresponds to H.264 cpb_removal_delay.
4000 int dts_ref_dts_delta;
4003 * Presentation delay of current frame in units of AVCodecContext.time_base.
4005 * Set to INT_MIN when dts_sync_point unused. Otherwise, it must
4006 * contain valid non-negative timestamp delta (presentation time of a frame
4007 * must not lie in the past).
4009 * This delay represents the difference between decoding and presentation
4010 * time of the frame.
4012 * For example, this corresponds to H.264 dpb_output_delay.
4017 * Position of the packet in file.
4019 * Analogous to cur_frame_pts/dts
4021 int64_t cur_frame_pos[AV_PARSER_PTS_NB];
4024 * Byte position of currently parsed frame in stream.
4029 * Previous frame byte position.
4034 * Duration of the current frame.
4035 * For audio, this is in units of 1 / AVCodecContext.sample_rate.
4036 * For all other types, this is in units of AVCodecContext.time_base.
4040 enum AVFieldOrder field_order;
4043 * Indicate whether a picture is coded as a frame, top field or bottom field.
4045 * For example, H.264 field_pic_flag equal to 0 corresponds to
4046 * AV_PICTURE_STRUCTURE_FRAME. An H.264 picture with field_pic_flag
4047 * equal to 1 and bottom_field_flag equal to 0 corresponds to
4048 * AV_PICTURE_STRUCTURE_TOP_FIELD.
4050 enum AVPictureStructure picture_structure;
4053 * Picture number incremented in presentation or output order.
4054 * This field may be reinitialized at the first picture of a new sequence.
4056 * For example, this corresponds to H.264 PicOrderCnt.
4058 int output_picture_number;
4059 } AVCodecParserContext;
4061 typedef struct AVCodecParser {
4062 int codec_ids[5]; /* several codec IDs are permitted */
4064 int (*parser_init)(AVCodecParserContext *s);
4065 int (*parser_parse)(AVCodecParserContext *s,
4066 AVCodecContext *avctx,
4067 const uint8_t **poutbuf, int *poutbuf_size,
4068 const uint8_t *buf, int buf_size);
4069 void (*parser_close)(AVCodecParserContext *s);
4070 int (*split)(AVCodecContext *avctx, const uint8_t *buf, int buf_size);
4071 struct AVCodecParser *next;
4074 AVCodecParser *av_parser_next(AVCodecParser *c);
4076 void av_register_codec_parser(AVCodecParser *parser);
4077 AVCodecParserContext *av_parser_init(int codec_id);
4082 * @param s parser context.
4083 * @param avctx codec context.
4084 * @param poutbuf set to pointer to parsed buffer or NULL if not yet finished.
4085 * @param poutbuf_size set to size of parsed buffer or zero if not yet finished.
4086 * @param buf input buffer.
4087 * @param buf_size input length, to signal EOF, this should be 0 (so that the last frame can be output).
4088 * @param pts input presentation timestamp.
4089 * @param dts input decoding timestamp.
4090 * @param pos input byte position in stream.
4091 * @return the number of bytes of the input bitstream used.
4096 * len = av_parser_parse2(myparser, AVCodecContext, &data, &size,
4103 * decode_frame(data, size);
4107 int av_parser_parse2(AVCodecParserContext *s,
4108 AVCodecContext *avctx,
4109 uint8_t **poutbuf, int *poutbuf_size,
4110 const uint8_t *buf, int buf_size,
4111 int64_t pts, int64_t dts,
4115 * @return 0 if the output buffer is a subset of the input, 1 if it is allocated and must be freed
4116 * @deprecated use AVBitStreamFilter
4118 int av_parser_change(AVCodecParserContext *s,
4119 AVCodecContext *avctx,
4120 uint8_t **poutbuf, int *poutbuf_size,
4121 const uint8_t *buf, int buf_size, int keyframe);
4122 void av_parser_close(AVCodecParserContext *s);
4130 * @addtogroup lavc_encoding
4135 * Find a registered encoder with a matching codec ID.
4137 * @param id AVCodecID of the requested encoder
4138 * @return An encoder if one was found, NULL otherwise.
4140 AVCodec *avcodec_find_encoder(enum AVCodecID id);
4143 * Find a registered encoder with the specified name.
4145 * @param name name of the requested encoder
4146 * @return An encoder if one was found, NULL otherwise.
4148 AVCodec *avcodec_find_encoder_by_name(const char *name);
4150 #if FF_API_OLD_ENCODE_AUDIO
4152 * Encode an audio frame from samples into buf.
4154 * @deprecated Use avcodec_encode_audio2 instead.
4156 * @note The output buffer should be at least FF_MIN_BUFFER_SIZE bytes large.
4157 * However, for codecs with avctx->frame_size equal to 0 (e.g. PCM) the user
4158 * will know how much space is needed because it depends on the value passed
4159 * in buf_size as described below. In that case a lower value can be used.
4161 * @param avctx the codec context
4162 * @param[out] buf the output buffer
4163 * @param[in] buf_size the output buffer size
4164 * @param[in] samples the input buffer containing the samples
4165 * The number of samples read from this buffer is frame_size*channels,
4166 * both of which are defined in avctx.
4167 * For codecs which have avctx->frame_size equal to 0 (e.g. PCM) the number of
4168 * samples read from samples is equal to:
4169 * buf_size * 8 / (avctx->channels * av_get_bits_per_sample(avctx->codec_id))
4170 * This also implies that av_get_bits_per_sample() must not return 0 for these
4172 * @return On error a negative value is returned, on success zero or the number
4173 * of bytes used to encode the data read from the input buffer.
4175 int attribute_deprecated avcodec_encode_audio(AVCodecContext *avctx,
4176 uint8_t *buf, int buf_size,
4177 const short *samples);
4181 * Encode a frame of audio.
4183 * Takes input samples from frame and writes the next output packet, if
4184 * available, to avpkt. The output packet does not necessarily contain data for
4185 * the most recent frame, as encoders can delay, split, and combine input frames
4186 * internally as needed.
4188 * @param avctx codec context
4189 * @param avpkt output AVPacket.
4190 * The user can supply an output buffer by setting
4191 * avpkt->data and avpkt->size prior to calling the
4192 * function, but if the size of the user-provided data is not
4193 * large enough, encoding will fail. If avpkt->data and
4194 * avpkt->size are set, avpkt->destruct must also be set. All
4195 * other AVPacket fields will be reset by the encoder using
4196 * av_init_packet(). If avpkt->data is NULL, the encoder will
4197 * allocate it. The encoder will set avpkt->size to the size
4198 * of the output packet.
4200 * If this function fails or produces no output, avpkt will be
4201 * freed using av_free_packet() (i.e. avpkt->destruct will be
4202 * called to free the user supplied buffer).
4203 * @param[in] frame AVFrame containing the raw audio data to be encoded.
4204 * May be NULL when flushing an encoder that has the
4205 * CODEC_CAP_DELAY capability set.
4206 * If CODEC_CAP_VARIABLE_FRAME_SIZE is set, then each frame
4207 * can have any number of samples.
4208 * If it is not set, frame->nb_samples must be equal to
4209 * avctx->frame_size for all frames except the last.
4210 * The final frame may be smaller than avctx->frame_size.
4211 * @param[out] got_packet_ptr This field is set to 1 by libavcodec if the
4212 * output packet is non-empty, and to 0 if it is
4213 * empty. If the function returns an error, the
4214 * packet can be assumed to be invalid, and the
4215 * value of got_packet_ptr is undefined and should
4217 * @return 0 on success, negative error code on failure
4219 int avcodec_encode_audio2(AVCodecContext *avctx, AVPacket *avpkt,
4220 const AVFrame *frame, int *got_packet_ptr);
4222 #if FF_API_OLD_ENCODE_VIDEO
4224 * @deprecated use avcodec_encode_video2() instead.
4226 * Encode a video frame from pict into buf.
4227 * The input picture should be
4228 * stored using a specific format, namely avctx.pix_fmt.
4230 * @param avctx the codec context
4231 * @param[out] buf the output buffer for the bitstream of encoded frame
4232 * @param[in] buf_size the size of the output buffer in bytes
4233 * @param[in] pict the input picture to encode
4234 * @return On error a negative value is returned, on success zero or the number
4235 * of bytes used from the output buffer.
4237 attribute_deprecated
4238 int avcodec_encode_video(AVCodecContext *avctx, uint8_t *buf, int buf_size,
4239 const AVFrame *pict);
4243 * Encode a frame of video.
4245 * Takes input raw video data from frame and writes the next output packet, if
4246 * available, to avpkt. The output packet does not necessarily contain data for
4247 * the most recent frame, as encoders can delay and reorder input frames
4248 * internally as needed.
4250 * @param avctx codec context
4251 * @param avpkt output AVPacket.
4252 * The user can supply an output buffer by setting
4253 * avpkt->data and avpkt->size prior to calling the
4254 * function, but if the size of the user-provided data is not
4255 * large enough, encoding will fail. All other AVPacket fields
4256 * will be reset by the encoder using av_init_packet(). If
4257 * avpkt->data is NULL, the encoder will allocate it.
4258 * The encoder will set avpkt->size to the size of the
4259 * output packet. The returned data (if any) belongs to the
4260 * caller, he is responsible for freeing it.
4262 * If this function fails or produces no output, avpkt will be
4263 * freed using av_free_packet() (i.e. avpkt->destruct will be
4264 * called to free the user supplied buffer).
4265 * @param[in] frame AVFrame containing the raw video data to be encoded.
4266 * May be NULL when flushing an encoder that has the
4267 * CODEC_CAP_DELAY capability set.
4268 * @param[out] got_packet_ptr This field is set to 1 by libavcodec if the
4269 * output packet is non-empty, and to 0 if it is
4270 * empty. If the function returns an error, the
4271 * packet can be assumed to be invalid, and the
4272 * value of got_packet_ptr is undefined and should
4274 * @return 0 on success, negative error code on failure
4276 int avcodec_encode_video2(AVCodecContext *avctx, AVPacket *avpkt,
4277 const AVFrame *frame, int *got_packet_ptr);
4279 int avcodec_encode_subtitle(AVCodecContext *avctx, uint8_t *buf, int buf_size,
4280 const AVSubtitle *sub);
4287 #if FF_API_AVCODEC_RESAMPLE
4289 * @defgroup lavc_resample Audio resampling
4291 * @deprecated use libswresample instead
4295 struct ReSampleContext;
4296 struct AVResampleContext;
4298 typedef struct ReSampleContext ReSampleContext;
4301 * Initialize audio resampling context.
4303 * @param output_channels number of output channels
4304 * @param input_channels number of input channels
4305 * @param output_rate output sample rate
4306 * @param input_rate input sample rate
4307 * @param sample_fmt_out requested output sample format
4308 * @param sample_fmt_in input sample format
4309 * @param filter_length length of each FIR filter in the filterbank relative to the cutoff frequency
4310 * @param log2_phase_count log2 of the number of entries in the polyphase filterbank
4311 * @param linear if 1 then the used FIR filter will be linearly interpolated
4312 between the 2 closest, if 0 the closest will be used
4313 * @param cutoff cutoff frequency, 1.0 corresponds to half the output sampling rate
4314 * @return allocated ReSampleContext, NULL if error occurred
4316 attribute_deprecated
4317 ReSampleContext *av_audio_resample_init(int output_channels, int input_channels,
4318 int output_rate, int input_rate,
4319 enum AVSampleFormat sample_fmt_out,
4320 enum AVSampleFormat sample_fmt_in,
4321 int filter_length, int log2_phase_count,
4322 int linear, double cutoff);
4324 attribute_deprecated
4325 int audio_resample(ReSampleContext *s, short *output, short *input, int nb_samples);
4328 * Free resample context.
4330 * @param s a non-NULL pointer to a resample context previously
4331 * created with av_audio_resample_init()
4333 attribute_deprecated
4334 void audio_resample_close(ReSampleContext *s);
4338 * Initialize an audio resampler.
4339 * Note, if either rate is not an integer then simply scale both rates up so they are.
4340 * @param filter_length length of each FIR filter in the filterbank relative to the cutoff freq
4341 * @param log2_phase_count log2 of the number of entries in the polyphase filterbank
4342 * @param linear If 1 then the used FIR filter will be linearly interpolated
4343 between the 2 closest, if 0 the closest will be used
4344 * @param cutoff cutoff frequency, 1.0 corresponds to half the output sampling rate
4346 attribute_deprecated
4347 struct AVResampleContext *av_resample_init(int out_rate, int in_rate, int filter_length, int log2_phase_count, int linear, double cutoff);
4350 * Resample an array of samples using a previously configured context.
4351 * @param src an array of unconsumed samples
4352 * @param consumed the number of samples of src which have been consumed are returned here
4353 * @param src_size the number of unconsumed samples available
4354 * @param dst_size the amount of space in samples available in dst
4355 * @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.
4356 * @return the number of samples written in dst or -1 if an error occurred
4358 attribute_deprecated
4359 int av_resample(struct AVResampleContext *c, short *dst, short *src, int *consumed, int src_size, int dst_size, int update_ctx);
4363 * Compensate samplerate/timestamp drift. The compensation is done by changing
4364 * the resampler parameters, so no audible clicks or similar distortions occur
4365 * @param compensation_distance distance in output samples over which the compensation should be performed
4366 * @param sample_delta number of output samples which should be output less
4368 * example: av_resample_compensate(c, 10, 500)
4369 * here instead of 510 samples only 500 samples would be output
4371 * note, due to rounding the actual compensation might be slightly different,
4372 * especially if the compensation_distance is large and the in_rate used during init is small
4374 attribute_deprecated
4375 void av_resample_compensate(struct AVResampleContext *c, int sample_delta, int compensation_distance);
4376 attribute_deprecated
4377 void av_resample_close(struct AVResampleContext *c);
4385 * @addtogroup lavc_picture
4390 * Allocate memory for the pixels of a picture and setup the AVPicture
4393 * Call avpicture_free() to free it.
4395 * @param picture the picture structure to be filled in
4396 * @param pix_fmt the pixel format of the picture
4397 * @param width the width of the picture
4398 * @param height the height of the picture
4399 * @return zero if successful, a negative error code otherwise
4401 * @see av_image_alloc(), avpicture_fill()
4403 int avpicture_alloc(AVPicture *picture, enum AVPixelFormat pix_fmt, int width, int height);
4406 * Free a picture previously allocated by avpicture_alloc().
4407 * The data buffer used by the AVPicture is freed, but the AVPicture structure
4410 * @param picture the AVPicture to be freed
4412 void avpicture_free(AVPicture *picture);
4415 * Setup the picture fields based on the specified image parameters
4416 * and the provided image data buffer.
4418 * The picture fields are filled in by using the image data buffer
4419 * pointed to by ptr.
4421 * If ptr is NULL, the function will fill only the picture linesize
4422 * array and return the required size for the image buffer.
4424 * To allocate an image buffer and fill the picture data in one call,
4425 * use avpicture_alloc().
4427 * @param picture the picture to be filled in
4428 * @param ptr buffer where the image data is stored, or NULL
4429 * @param pix_fmt the pixel format of the image
4430 * @param width the width of the image in pixels
4431 * @param height the height of the image in pixels
4432 * @return the size in bytes required for src, a negative error code
4433 * in case of failure
4435 * @see av_image_fill_arrays()
4437 int avpicture_fill(AVPicture *picture, const uint8_t *ptr,
4438 enum AVPixelFormat pix_fmt, int width, int height);
4441 * Copy pixel data from an AVPicture into a buffer.
4443 * avpicture_get_size() can be used to compute the required size for
4444 * the buffer to fill.
4446 * @param src source picture with filled data
4447 * @param pix_fmt picture pixel format
4448 * @param width picture width
4449 * @param height picture height
4450 * @param dest destination buffer
4451 * @param dest_size destination buffer size in bytes
4452 * @return the number of bytes written to dest, or a negative value
4453 * (error code) on error, for example if the destination buffer is not
4456 * @see av_image_copy_to_buffer()
4458 int avpicture_layout(const AVPicture *src, enum AVPixelFormat pix_fmt,
4459 int width, int height,
4460 unsigned char *dest, int dest_size);
4463 * Calculate the size in bytes that a picture of the given width and height
4464 * would occupy if stored in the given picture format.
4466 * @param pix_fmt picture pixel format
4467 * @param width picture width
4468 * @param height picture height
4469 * @return the computed picture buffer size or a negative error code
4472 * @see av_image_get_buffer_size().
4474 int avpicture_get_size(enum AVPixelFormat pix_fmt, int width, int height);
4476 #if FF_API_DEINTERLACE
4478 * deinterlace - if not supported return -1
4480 * @deprecated - use yadif (in libavfilter) instead
4482 attribute_deprecated
4483 int avpicture_deinterlace(AVPicture *dst, const AVPicture *src,
4484 enum AVPixelFormat pix_fmt, int width, int height);
4487 * Copy image src to dst. Wraps av_image_copy().
4489 void av_picture_copy(AVPicture *dst, const AVPicture *src,
4490 enum AVPixelFormat pix_fmt, int width, int height);
4493 * Crop image top and left side.
4495 int av_picture_crop(AVPicture *dst, const AVPicture *src,
4496 enum AVPixelFormat pix_fmt, int top_band, int left_band);
4501 int av_picture_pad(AVPicture *dst, const AVPicture *src, int height, int width, enum AVPixelFormat pix_fmt,
4502 int padtop, int padbottom, int padleft, int padright, int *color);
4509 * @defgroup lavc_misc Utility functions
4512 * Miscellaneous utility functions related to both encoding and decoding
4518 * @defgroup lavc_misc_pixfmt Pixel formats
4520 * Functions for working with pixel formats.
4525 * Utility function to access log2_chroma_w log2_chroma_h from
4526 * the pixel format AVPixFmtDescriptor.
4528 * This function asserts that pix_fmt is valid. See av_pix_fmt_get_chroma_sub_sample
4529 * for one that returns a failure code and continues in case of invalid
4532 * @param[in] pix_fmt the pixel format
4533 * @param[out] h_shift store log2_chroma_w
4534 * @param[out] v_shift store log2_chroma_h
4536 * @see av_pix_fmt_get_chroma_sub_sample
4539 void avcodec_get_chroma_sub_sample(enum AVPixelFormat pix_fmt, int *h_shift, int *v_shift);
4542 * Return a value representing the fourCC code associated to the
4543 * pixel format pix_fmt, or 0 if no associated fourCC code can be
4546 unsigned int avcodec_pix_fmt_to_codec_tag(enum AVPixelFormat pix_fmt);
4548 #define FF_LOSS_RESOLUTION 0x0001 /**< loss due to resolution change */
4549 #define FF_LOSS_DEPTH 0x0002 /**< loss due to color depth change */
4550 #define FF_LOSS_COLORSPACE 0x0004 /**< loss due to color space conversion */
4551 #define FF_LOSS_ALPHA 0x0008 /**< loss of alpha bits */
4552 #define FF_LOSS_COLORQUANT 0x0010 /**< loss due to color quantization */
4553 #define FF_LOSS_CHROMA 0x0020 /**< loss of chroma (e.g. RGB to gray conversion) */
4556 * Compute what kind of losses will occur when converting from one specific
4557 * pixel format to another.
4558 * When converting from one pixel format to another, information loss may occur.
4559 * For example, when converting from RGB24 to GRAY, the color information will
4560 * be lost. Similarly, other losses occur when converting from some formats to
4561 * other formats. These losses can involve loss of chroma, but also loss of
4562 * resolution, loss of color depth, loss due to the color space conversion, loss
4563 * of the alpha bits or loss due to color quantization.
4564 * avcodec_get_fix_fmt_loss() informs you about the various types of losses
4565 * which will occur when converting from one pixel format to another.
4567 * @param[in] dst_pix_fmt destination pixel format
4568 * @param[in] src_pix_fmt source pixel format
4569 * @param[in] has_alpha Whether the source pixel format alpha channel is used.
4570 * @return Combination of flags informing you what kind of losses will occur
4571 * (maximum loss for an invalid dst_pix_fmt).
4573 int avcodec_get_pix_fmt_loss(enum AVPixelFormat dst_pix_fmt, enum AVPixelFormat src_pix_fmt,
4577 * Find the best pixel format to convert to given a certain source pixel
4578 * format. When converting from one pixel format to another, information loss
4579 * may occur. For example, when converting from RGB24 to GRAY, the color
4580 * information will be lost. Similarly, other losses occur when converting from
4581 * some formats to other formats. avcodec_find_best_pix_fmt_of_2() searches which of
4582 * the given pixel formats should be used to suffer the least amount of loss.
4583 * The pixel formats from which it chooses one, are determined by the
4584 * pix_fmt_list parameter.
4587 * @param[in] pix_fmt_list AV_PIX_FMT_NONE terminated array of pixel formats to choose from
4588 * @param[in] src_pix_fmt source pixel format
4589 * @param[in] has_alpha Whether the source pixel format alpha channel is used.
4590 * @param[out] loss_ptr Combination of flags informing you what kind of losses will occur.
4591 * @return The best pixel format to convert to or -1 if none was found.
4593 enum AVPixelFormat avcodec_find_best_pix_fmt_of_list(const enum AVPixelFormat *pix_fmt_list,
4594 enum AVPixelFormat src_pix_fmt,
4595 int has_alpha, int *loss_ptr);
4598 * Find the best pixel format to convert to given a certain source pixel
4599 * format and a selection of two destination pixel formats. When converting from
4600 * one pixel format to another, information loss may occur. For example, when converting
4601 * from RGB24 to GRAY, the color information will be lost. Similarly, other losses occur when
4602 * converting from some formats to other formats. avcodec_find_best_pix_fmt_of_2() selects which of
4603 * the given pixel formats should be used to suffer the least amount of loss.
4605 * If one of the destination formats is AV_PIX_FMT_NONE the other pixel format (if valid) will be
4609 * src_pix_fmt = AV_PIX_FMT_YUV420P;
4610 * dst_pix_fmt1= AV_PIX_FMT_RGB24;
4611 * dst_pix_fmt2= AV_PIX_FMT_GRAY8;
4612 * dst_pix_fmt3= AV_PIX_FMT_RGB8;
4613 * loss= FF_LOSS_CHROMA; // don't care about chroma loss, so chroma loss will be ignored.
4614 * dst_pix_fmt = avcodec_find_best_pix_fmt_of_2(dst_pix_fmt1, dst_pix_fmt2, src_pix_fmt, alpha, &loss);
4615 * dst_pix_fmt = avcodec_find_best_pix_fmt_of_2(dst_pix_fmt, dst_pix_fmt3, src_pix_fmt, alpha, &loss);
4618 * @param[in] dst_pix_fmt1 One of the two destination pixel formats to choose from
4619 * @param[in] dst_pix_fmt2 The other of the two destination pixel formats to choose from
4620 * @param[in] src_pix_fmt Source pixel format
4621 * @param[in] has_alpha Whether the source pixel format alpha channel is used.
4622 * @param[in, out] loss_ptr Combination of loss flags. In: selects which of the losses to ignore, i.e.
4623 * NULL or value of zero means we care about all losses. Out: the loss
4624 * that occurs when converting from src to selected dst pixel format.
4625 * @return The best pixel format to convert to or -1 if none was found.
4627 enum AVPixelFormat avcodec_find_best_pix_fmt_of_2(enum AVPixelFormat dst_pix_fmt1, enum AVPixelFormat dst_pix_fmt2,
4628 enum AVPixelFormat src_pix_fmt, int has_alpha, int *loss_ptr);
4630 attribute_deprecated
4631 #if AV_HAVE_INCOMPATIBLE_LIBAV_ABI
4632 enum AVPixelFormat avcodec_find_best_pix_fmt2(const enum AVPixelFormat *pix_fmt_list,
4633 enum AVPixelFormat src_pix_fmt,
4634 int has_alpha, int *loss_ptr);
4636 enum AVPixelFormat avcodec_find_best_pix_fmt2(enum AVPixelFormat dst_pix_fmt1, enum AVPixelFormat dst_pix_fmt2,
4637 enum AVPixelFormat src_pix_fmt, int has_alpha, int *loss_ptr);
4641 enum AVPixelFormat avcodec_default_get_format(struct AVCodecContext *s, const enum AVPixelFormat * fmt);
4647 void avcodec_set_dimensions(AVCodecContext *s, int width, int height);
4650 * Put a string representing the codec tag codec_tag in buf.
4652 * @param buf_size size in bytes of buf
4653 * @return the length of the string that would have been generated if
4654 * enough space had been available, excluding the trailing null
4656 size_t av_get_codec_tag_string(char *buf, size_t buf_size, unsigned int codec_tag);
4658 void avcodec_string(char *buf, int buf_size, AVCodecContext *enc, int encode);
4661 * Return a name for the specified profile, if available.
4663 * @param codec the codec that is searched for the given profile
4664 * @param profile the profile value for which a name is requested
4665 * @return A name for the profile if found, NULL otherwise.
4667 const char *av_get_profile_name(const AVCodec *codec, int profile);
4669 int avcodec_default_execute(AVCodecContext *c, int (*func)(AVCodecContext *c2, void *arg2),void *arg, int *ret, int count, int size);
4670 int avcodec_default_execute2(AVCodecContext *c, int (*func)(AVCodecContext *c2, void *arg2, int, int),void *arg, int *ret, int count);
4671 //FIXME func typedef
4674 * Fill AVFrame audio data and linesize pointers.
4676 * The buffer buf must be a preallocated buffer with a size big enough
4677 * to contain the specified samples amount. The filled AVFrame data
4678 * pointers will point to this buffer.
4680 * AVFrame extended_data channel pointers are allocated if necessary for
4683 * @param frame the AVFrame
4684 * frame->nb_samples must be set prior to calling the
4685 * function. This function fills in frame->data,
4686 * frame->extended_data, frame->linesize[0].
4687 * @param nb_channels channel count
4688 * @param sample_fmt sample format
4689 * @param buf buffer to use for frame data
4690 * @param buf_size size of buffer
4691 * @param align plane size sample alignment (0 = default)
4692 * @return >=0 on success, negative error code on failure
4693 * @todo return the size in bytes required to store the samples in
4694 * case of success, at the next libavutil bump
4696 int avcodec_fill_audio_frame(AVFrame *frame, int nb_channels,
4697 enum AVSampleFormat sample_fmt, const uint8_t *buf,
4698 int buf_size, int align);
4701 * Reset the internal decoder state / flush internal buffers. Should be called
4702 * e.g. when seeking or when switching to a different stream.
4704 * @note when refcounted frames are not used (i.e. avctx->refcounted_frames is 0),
4705 * this invalidates the frames previously returned from the decoder. When
4706 * refcounted frames are used, the decoder just releases any references it might
4707 * keep internally, but the caller's reference remains valid.
4709 void avcodec_flush_buffers(AVCodecContext *avctx);
4712 * Return codec bits per sample.
4714 * @param[in] codec_id the codec
4715 * @return Number of bits per sample or zero if unknown for the given codec.
4717 int av_get_bits_per_sample(enum AVCodecID codec_id);
4720 * Return the PCM codec associated with a sample format.
4721 * @param be endianness, 0 for little, 1 for big,
4722 * -1 (or anything else) for native
4723 * @return AV_CODEC_ID_PCM_* or AV_CODEC_ID_NONE
4725 enum AVCodecID av_get_pcm_codec(enum AVSampleFormat fmt, int be);
4728 * Return codec bits per sample.
4729 * Only return non-zero if the bits per sample is exactly correct, not an
4732 * @param[in] codec_id the codec
4733 * @return Number of bits per sample or zero if unknown for the given codec.
4735 int av_get_exact_bits_per_sample(enum AVCodecID codec_id);
4738 * Return audio frame duration.
4740 * @param avctx codec context
4741 * @param frame_bytes size of the frame, or 0 if unknown
4742 * @return frame duration, in samples, if known. 0 if not able to
4745 int av_get_audio_frame_duration(AVCodecContext *avctx, int frame_bytes);
4748 typedef struct AVBitStreamFilterContext {
4750 struct AVBitStreamFilter *filter;
4751 AVCodecParserContext *parser;
4752 struct AVBitStreamFilterContext *next;
4753 } AVBitStreamFilterContext;
4756 typedef struct AVBitStreamFilter {
4759 int (*filter)(AVBitStreamFilterContext *bsfc,
4760 AVCodecContext *avctx, const char *args,
4761 uint8_t **poutbuf, int *poutbuf_size,
4762 const uint8_t *buf, int buf_size, int keyframe);
4763 void (*close)(AVBitStreamFilterContext *bsfc);
4764 struct AVBitStreamFilter *next;
4765 } AVBitStreamFilter;
4768 * Register a bitstream filter.
4770 * The filter will be accessible to the application code through
4771 * av_bitstream_filter_next() or can be directly initialized with
4772 * av_bitstream_filter_init().
4774 * @see avcodec_register_all()
4776 void av_register_bitstream_filter(AVBitStreamFilter *bsf);
4779 * Create and initialize a bitstream filter context given a bitstream
4782 * The returned context must be freed with av_bitstream_filter_close().
4784 * @param name the name of the bitstream filter
4785 * @return a bitstream filter context if a matching filter was found
4786 * and successfully initialized, NULL otherwise
4788 AVBitStreamFilterContext *av_bitstream_filter_init(const char *name);
4793 * This function filters the buffer buf with size buf_size, and places the
4794 * filtered buffer in the buffer pointed to by poutbuf.
4796 * The output buffer must be freed by the caller.
4798 * @param bsfc bitstream filter context created by av_bitstream_filter_init()
4799 * @param avctx AVCodecContext accessed by the filter, may be NULL.
4800 * If specified, this must point to the encoder context of the
4801 * output stream the packet is sent to.
4802 * @param args arguments which specify the filter configuration, may be NULL
4803 * @param poutbuf pointer which is updated to point to the filtered buffer
4804 * @param poutbuf_size pointer which is updated to the filtered buffer size in bytes
4805 * @param buf buffer containing the data to filter
4806 * @param buf_size size in bytes of buf
4807 * @param keyframe set to non-zero if the buffer to filter corresponds to a key-frame packet data
4808 * @return >= 0 in case of success, or a negative error code in case of failure
4810 * If the return value is positive, an output buffer is allocated and
4811 * is availble in *poutbuf, and is distinct from the input buffer.
4813 * If the return value is 0, the output buffer is not allocated and
4814 * should be considered identical to the input buffer, or in case
4815 * *poutbuf was set it points to the input buffer (not necessarily to
4816 * its starting address).
4818 int av_bitstream_filter_filter(AVBitStreamFilterContext *bsfc,
4819 AVCodecContext *avctx, const char *args,
4820 uint8_t **poutbuf, int *poutbuf_size,
4821 const uint8_t *buf, int buf_size, int keyframe);
4824 * Release bitstream filter context.
4826 * @param bsf the bitstream filter context created with
4827 * av_bitstream_filter_init(), can be NULL
4829 void av_bitstream_filter_close(AVBitStreamFilterContext *bsf);
4832 * If f is NULL, return the first registered bitstream filter,
4833 * if f is non-NULL, return the next registered bitstream filter
4834 * after f, or NULL if f is the last one.
4836 * This function can be used to iterate over all registered bitstream
4839 AVBitStreamFilter *av_bitstream_filter_next(AVBitStreamFilter *f);
4844 * Reallocate the given block if it is not large enough, otherwise do nothing.
4848 void *av_fast_realloc(void *ptr, unsigned int *size, size_t min_size);
4851 * Allocate a buffer, reusing the given one if large enough.
4853 * Contrary to av_fast_realloc the current buffer contents might not be
4854 * preserved and on error the old buffer is freed, thus no special
4855 * handling to avoid memleaks is necessary.
4857 * @param ptr pointer to pointer to already allocated buffer, overwritten with pointer to new buffer
4858 * @param size size of the buffer *ptr points to
4859 * @param min_size minimum size of *ptr buffer after returning, *ptr will be NULL and
4860 * *size 0 if an error occurred.
4862 void av_fast_malloc(void *ptr, unsigned int *size, size_t min_size);
4865 * Same behaviour av_fast_malloc but the buffer has additional
4866 * FF_INPUT_BUFFER_PADDING_SIZE at the end which will always be 0.
4868 * In addition the whole buffer will initially and after resizes
4869 * be 0-initialized so that no uninitialized data will ever appear.
4871 void av_fast_padded_malloc(void *ptr, unsigned int *size, size_t min_size);
4874 * Same behaviour av_fast_padded_malloc except that buffer will always
4875 * be 0-initialized after call.
4877 void av_fast_padded_mallocz(void *ptr, unsigned int *size, size_t min_size);
4880 * Encode extradata length to a buffer. Used by xiph codecs.
4882 * @param s buffer to write to; must be at least (v/255+1) bytes long
4883 * @param v size of extradata in bytes
4884 * @return number of bytes written to the buffer.
4886 unsigned int av_xiphlacing(unsigned char *s, unsigned int v);
4888 #if FF_API_MISSING_SAMPLE
4890 * Log a generic warning message about a missing feature. This function is
4891 * intended to be used internally by FFmpeg (libavcodec, libavformat, etc.)
4892 * only, and would normally not be used by applications.
4893 * @param[in] avc a pointer to an arbitrary struct of which the first field is
4894 * a pointer to an AVClass struct
4895 * @param[in] feature string containing the name of the missing feature
4896 * @param[in] want_sample indicates if samples are wanted which exhibit this feature.
4897 * If want_sample is non-zero, additional verbage will be added to the log
4898 * message which tells the user how to report samples to the development
4900 * @deprecated Use avpriv_report_missing_feature() instead.
4902 attribute_deprecated
4903 void av_log_missing_feature(void *avc, const char *feature, int want_sample);
4906 * Log a generic warning message asking for a sample. This function is
4907 * intended to be used internally by FFmpeg (libavcodec, libavformat, etc.)
4908 * only, and would normally not be used by applications.
4909 * @param[in] avc a pointer to an arbitrary struct of which the first field is
4910 * a pointer to an AVClass struct
4911 * @param[in] msg string containing an optional message, or NULL if no message
4912 * @deprecated Use avpriv_request_sample() instead.
4914 attribute_deprecated
4915 void av_log_ask_for_sample(void *avc, const char *msg, ...) av_printf_format(2, 3);
4916 #endif /* FF_API_MISSING_SAMPLE */
4919 * Register the hardware accelerator hwaccel.
4921 void av_register_hwaccel(AVHWAccel *hwaccel);
4924 * If hwaccel is NULL, returns the first registered hardware accelerator,
4925 * if hwaccel is non-NULL, returns the next registered hardware accelerator
4926 * after hwaccel, or NULL if hwaccel is the last one.
4928 AVHWAccel *av_hwaccel_next(AVHWAccel *hwaccel);
4932 * Lock operation used by lockmgr
4935 AV_LOCK_CREATE, ///< Create a mutex
4936 AV_LOCK_OBTAIN, ///< Lock the mutex
4937 AV_LOCK_RELEASE, ///< Unlock the mutex
4938 AV_LOCK_DESTROY, ///< Free mutex resources
4942 * Register a user provided lock manager supporting the operations
4943 * specified by AVLockOp. mutex points to a (void *) where the
4944 * lockmgr should store/get a pointer to a user allocated mutex. It's
4945 * NULL upon AV_LOCK_CREATE and != NULL for all other ops.
4947 * @param cb User defined callback. Note: FFmpeg may invoke calls to this
4948 * callback during the call to av_lockmgr_register().
4949 * Thus, the application must be prepared to handle that.
4950 * If cb is set to NULL the lockmgr will be unregistered.
4951 * Also note that during unregistration the previously registered
4952 * lockmgr callback may also be invoked.
4954 int av_lockmgr_register(int (*cb)(void **mutex, enum AVLockOp op));
4957 * Get the type of the given codec.
4959 enum AVMediaType avcodec_get_type(enum AVCodecID codec_id);
4962 * Get the name of a codec.
4963 * @return a static string identifying the codec; never NULL
4965 const char *avcodec_get_name(enum AVCodecID id);
4968 * @return a positive value if s is open (i.e. avcodec_open2() was called on it
4969 * with no corresponding avcodec_close()), 0 otherwise.
4971 int avcodec_is_open(AVCodecContext *s);
4974 * @return a non-zero number if codec is an encoder, zero otherwise
4976 int av_codec_is_encoder(const AVCodec *codec);
4979 * @return a non-zero number if codec is a decoder, zero otherwise
4981 int av_codec_is_decoder(const AVCodec *codec);
4984 * @return descriptor for given codec ID or NULL if no descriptor exists.
4986 const AVCodecDescriptor *avcodec_descriptor_get(enum AVCodecID id);
4989 * Iterate over all codec descriptors known to libavcodec.
4991 * @param prev previous descriptor. NULL to get the first descriptor.
4993 * @return next descriptor or NULL after the last descriptor
4995 const AVCodecDescriptor *avcodec_descriptor_next(const AVCodecDescriptor *prev);
4998 * @return codec descriptor with the given name or NULL if no such descriptor
5001 const AVCodecDescriptor *avcodec_descriptor_get_by_name(const char *name);
5007 #endif /* AVCODEC_AVCODEC_H */