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
30 #include "libavutil/samplefmt.h"
31 #include "libavutil/avutil.h"
32 #include "libavutil/buffer.h"
33 #include "libavutil/cpu.h"
34 #include "libavutil/channel_layout.h"
35 #include "libavutil/dict.h"
36 #include "libavutil/frame.h"
37 #include "libavutil/log.h"
38 #include "libavutil/pixfmt.h"
39 #include "libavutil/rational.h"
41 #include "libavcodec/version.h"
43 * @defgroup libavc Encoding/Decoding Library
46 * @defgroup lavc_decoding Decoding
50 * @defgroup lavc_encoding Encoding
54 * @defgroup lavc_codec Codecs
56 * @defgroup lavc_codec_native Native Codecs
59 * @defgroup lavc_codec_wrappers External library wrappers
62 * @defgroup lavc_codec_hwaccel Hardware Accelerators bridge
66 * @defgroup lavc_internal Internal
74 * @defgroup lavc_core Core functions/structures.
77 * Basic definitions, functions for querying libavcodec capabilities,
78 * allocating core structures, etc.
84 * Identify the syntax and semantics of the bitstream.
85 * The principle is roughly:
86 * Two decoders with the same ID can decode the same streams.
87 * Two encoders with the same ID can encode compatible streams.
88 * There may be slight deviations from the principle due to implementation
91 * If you add a codec ID to this list, add it so that
92 * 1. no value of a existing codec ID changes (that would break ABI),
93 * 2. Give it a value which when taken as ASCII is recognized uniquely by a human as this specific codec.
94 * This ensures that 2 forks can independently add AVCodecIDs without producing conflicts.
96 * After adding new codec IDs, do not forget to add an entry to the codec
97 * descriptor list and bump libavcodec minor version.
103 AV_CODEC_ID_MPEG1VIDEO,
104 AV_CODEC_ID_MPEG2VIDEO, ///< preferred ID for MPEG-1/2 video decoding
105 AV_CODEC_ID_MPEG2VIDEO_XVMC,
116 AV_CODEC_ID_RAWVIDEO,
117 AV_CODEC_ID_MSMPEG4V1,
118 AV_CODEC_ID_MSMPEG4V2,
119 AV_CODEC_ID_MSMPEG4V3,
142 AV_CODEC_ID_INTERPLAY_VIDEO,
149 AV_CODEC_ID_MSVIDEO1,
154 AV_CODEC_ID_TRUEMOTION1,
155 AV_CODEC_ID_VMDVIDEO,
180 AV_CODEC_ID_TRUEMOTION2,
186 AV_CODEC_ID_SMACKVIDEO,
191 AV_CODEC_ID_JPEG2000,
197 AV_CODEC_ID_DSICINVIDEO,
198 AV_CODEC_ID_TIERTEXSEQVIDEO,
206 AV_CODEC_ID_BETHSOFTVID,
218 AV_CODEC_ID_ESCAPE124,
222 AV_CODEC_ID_MOTIONPIXELS,
234 AV_CODEC_ID_FLASHSV2,
235 AV_CODEC_ID_CDGRAPHICS,
238 AV_CODEC_ID_BINKVIDEO,
239 AV_CODEC_ID_IFF_ILBM,
240 AV_CODEC_ID_IFF_BYTERUN1,
246 AV_CODEC_ID_A64_MULTI,
247 AV_CODEC_ID_A64_MULTI5,
250 AV_CODEC_ID_LAGARITH,
254 AV_CODEC_ID_WMV3IMAGE,
255 AV_CODEC_ID_VC1IMAGE,
257 AV_CODEC_ID_BMV_VIDEO,
264 AV_CODEC_ID_ZEROCODEC,
274 AV_CODEC_ID_BRENDER_PIX= MKBETAG('B','P','I','X'),
275 AV_CODEC_ID_Y41P = MKBETAG('Y','4','1','P'),
276 AV_CODEC_ID_ESCAPE130 = MKBETAG('E','1','3','0'),
277 AV_CODEC_ID_EXR = MKBETAG('0','E','X','R'),
278 AV_CODEC_ID_AVRP = MKBETAG('A','V','R','P'),
280 AV_CODEC_ID_012V = MKBETAG('0','1','2','V'),
281 AV_CODEC_ID_G2M = MKBETAG( 0 ,'G','2','M'),
282 AV_CODEC_ID_AVUI = MKBETAG('A','V','U','I'),
283 AV_CODEC_ID_AYUV = MKBETAG('A','Y','U','V'),
284 AV_CODEC_ID_TARGA_Y216 = MKBETAG('T','2','1','6'),
285 AV_CODEC_ID_V308 = MKBETAG('V','3','0','8'),
286 AV_CODEC_ID_V408 = MKBETAG('V','4','0','8'),
287 AV_CODEC_ID_YUV4 = MKBETAG('Y','U','V','4'),
288 AV_CODEC_ID_SANM = MKBETAG('S','A','N','M'),
289 AV_CODEC_ID_PAF_VIDEO = MKBETAG('P','A','F','V'),
290 AV_CODEC_ID_AVRN = MKBETAG('A','V','R','n'),
291 AV_CODEC_ID_CPIA = MKBETAG('C','P','I','A'),
292 AV_CODEC_ID_XFACE = MKBETAG('X','F','A','C'),
293 AV_CODEC_ID_SGIRLE = MKBETAG('S','G','I','R'),
294 AV_CODEC_ID_MVC1 = MKBETAG('M','V','C','1'),
295 AV_CODEC_ID_MVC2 = MKBETAG('M','V','C','2'),
296 AV_CODEC_ID_SNOW = MKBETAG('S','N','O','W'),
297 AV_CODEC_ID_WEBP = MKBETAG('W','E','B','P'),
299 /* various PCM "codecs" */
300 AV_CODEC_ID_FIRST_AUDIO = 0x10000, ///< A dummy id pointing at the start of audio codecs
301 AV_CODEC_ID_PCM_S16LE = 0x10000,
302 AV_CODEC_ID_PCM_S16BE,
303 AV_CODEC_ID_PCM_U16LE,
304 AV_CODEC_ID_PCM_U16BE,
307 AV_CODEC_ID_PCM_MULAW,
308 AV_CODEC_ID_PCM_ALAW,
309 AV_CODEC_ID_PCM_S32LE,
310 AV_CODEC_ID_PCM_S32BE,
311 AV_CODEC_ID_PCM_U32LE,
312 AV_CODEC_ID_PCM_U32BE,
313 AV_CODEC_ID_PCM_S24LE,
314 AV_CODEC_ID_PCM_S24BE,
315 AV_CODEC_ID_PCM_U24LE,
316 AV_CODEC_ID_PCM_U24BE,
317 AV_CODEC_ID_PCM_S24DAUD,
318 AV_CODEC_ID_PCM_ZORK,
319 AV_CODEC_ID_PCM_S16LE_PLANAR,
321 AV_CODEC_ID_PCM_F32BE,
322 AV_CODEC_ID_PCM_F32LE,
323 AV_CODEC_ID_PCM_F64BE,
324 AV_CODEC_ID_PCM_F64LE,
325 AV_CODEC_ID_PCM_BLURAY,
328 AV_CODEC_ID_PCM_S8_PLANAR,
329 AV_CODEC_ID_PCM_S24LE_PLANAR = MKBETAG(24,'P','S','P'),
330 AV_CODEC_ID_PCM_S32LE_PLANAR = MKBETAG(32,'P','S','P'),
331 AV_CODEC_ID_PCM_S16BE_PLANAR = MKBETAG('P','S','P',16),
333 /* various ADPCM codecs */
334 AV_CODEC_ID_ADPCM_IMA_QT = 0x11000,
335 AV_CODEC_ID_ADPCM_IMA_WAV,
336 AV_CODEC_ID_ADPCM_IMA_DK3,
337 AV_CODEC_ID_ADPCM_IMA_DK4,
338 AV_CODEC_ID_ADPCM_IMA_WS,
339 AV_CODEC_ID_ADPCM_IMA_SMJPEG,
340 AV_CODEC_ID_ADPCM_MS,
341 AV_CODEC_ID_ADPCM_4XM,
342 AV_CODEC_ID_ADPCM_XA,
343 AV_CODEC_ID_ADPCM_ADX,
344 AV_CODEC_ID_ADPCM_EA,
345 AV_CODEC_ID_ADPCM_G726,
346 AV_CODEC_ID_ADPCM_CT,
347 AV_CODEC_ID_ADPCM_SWF,
348 AV_CODEC_ID_ADPCM_YAMAHA,
349 AV_CODEC_ID_ADPCM_SBPRO_4,
350 AV_CODEC_ID_ADPCM_SBPRO_3,
351 AV_CODEC_ID_ADPCM_SBPRO_2,
352 AV_CODEC_ID_ADPCM_THP,
353 AV_CODEC_ID_ADPCM_IMA_AMV,
354 AV_CODEC_ID_ADPCM_EA_R1,
355 AV_CODEC_ID_ADPCM_EA_R3,
356 AV_CODEC_ID_ADPCM_EA_R2,
357 AV_CODEC_ID_ADPCM_IMA_EA_SEAD,
358 AV_CODEC_ID_ADPCM_IMA_EA_EACS,
359 AV_CODEC_ID_ADPCM_EA_XAS,
360 AV_CODEC_ID_ADPCM_EA_MAXIS_XA,
361 AV_CODEC_ID_ADPCM_IMA_ISS,
362 AV_CODEC_ID_ADPCM_G722,
363 AV_CODEC_ID_ADPCM_IMA_APC,
364 AV_CODEC_ID_VIMA = MKBETAG('V','I','M','A'),
365 AV_CODEC_ID_ADPCM_AFC = MKBETAG('A','F','C',' '),
366 AV_CODEC_ID_ADPCM_IMA_OKI = MKBETAG('O','K','I',' '),
367 AV_CODEC_ID_ADPCM_DTK = MKBETAG('D','T','K',' '),
368 AV_CODEC_ID_ADPCM_IMA_RAD = MKBETAG('R','A','D',' '),
371 AV_CODEC_ID_AMR_NB = 0x12000,
374 /* RealAudio codecs*/
375 AV_CODEC_ID_RA_144 = 0x13000,
378 /* various DPCM codecs */
379 AV_CODEC_ID_ROQ_DPCM = 0x14000,
380 AV_CODEC_ID_INTERPLAY_DPCM,
381 AV_CODEC_ID_XAN_DPCM,
382 AV_CODEC_ID_SOL_DPCM,
385 AV_CODEC_ID_MP2 = 0x15000,
386 AV_CODEC_ID_MP3, ///< preferred ID for decoding MPEG audio layer 1, 2 or 3
396 AV_CODEC_ID_VMDAUDIO,
402 AV_CODEC_ID_WESTWOOD_SND1,
403 AV_CODEC_ID_GSM, ///< as in Berlin toast format
406 AV_CODEC_ID_TRUESPEECH,
408 AV_CODEC_ID_SMACKAUDIO,
411 AV_CODEC_ID_DSICINAUDIO,
413 AV_CODEC_ID_MUSEPACK7,
415 AV_CODEC_ID_GSM_MS, /* as found in WAV */
419 AV_CODEC_ID_NELLYMOSER,
420 AV_CODEC_ID_MUSEPACK8,
422 AV_CODEC_ID_WMAVOICE,
424 AV_CODEC_ID_WMALOSSLESS,
433 AV_CODEC_ID_BINKAUDIO_RDFT,
434 AV_CODEC_ID_BINKAUDIO_DCT,
435 AV_CODEC_ID_AAC_LATM,
440 AV_CODEC_ID_8SVX_EXP,
441 AV_CODEC_ID_8SVX_FIB,
442 AV_CODEC_ID_BMV_AUDIO,
446 AV_CODEC_ID_OPUS_DEPRECATED,
447 AV_CODEC_ID_COMFORT_NOISE,
448 AV_CODEC_ID_TAK_DEPRECATED,
449 AV_CODEC_ID_FFWAVESYNTH = MKBETAG('F','F','W','S'),
450 AV_CODEC_ID_SONIC = MKBETAG('S','O','N','C'),
451 AV_CODEC_ID_SONIC_LS = MKBETAG('S','O','N','L'),
452 AV_CODEC_ID_PAF_AUDIO = MKBETAG('P','A','F','A'),
453 AV_CODEC_ID_OPUS = MKBETAG('O','P','U','S'),
454 AV_CODEC_ID_TAK = MKBETAG('t','B','a','K'),
455 AV_CODEC_ID_EVRC = MKBETAG('s','e','v','c'),
456 AV_CODEC_ID_SMV = MKBETAG('s','s','m','v'),
458 /* subtitle codecs */
459 AV_CODEC_ID_FIRST_SUBTITLE = 0x17000, ///< A dummy ID pointing at the start of subtitle codecs.
460 AV_CODEC_ID_DVD_SUBTITLE = 0x17000,
461 AV_CODEC_ID_DVB_SUBTITLE,
462 AV_CODEC_ID_TEXT, ///< raw UTF-8 text
465 AV_CODEC_ID_MOV_TEXT,
466 AV_CODEC_ID_HDMV_PGS_SUBTITLE,
467 AV_CODEC_ID_DVB_TELETEXT,
469 AV_CODEC_ID_MICRODVD = MKBETAG('m','D','V','D'),
470 AV_CODEC_ID_EIA_608 = MKBETAG('c','6','0','8'),
471 AV_CODEC_ID_JACOSUB = MKBETAG('J','S','U','B'),
472 AV_CODEC_ID_SAMI = MKBETAG('S','A','M','I'),
473 AV_CODEC_ID_REALTEXT = MKBETAG('R','T','X','T'),
474 AV_CODEC_ID_SUBVIEWER1 = MKBETAG('S','b','V','1'),
475 AV_CODEC_ID_SUBVIEWER = MKBETAG('S','u','b','V'),
476 AV_CODEC_ID_SUBRIP = MKBETAG('S','R','i','p'),
477 AV_CODEC_ID_WEBVTT = MKBETAG('W','V','T','T'),
478 AV_CODEC_ID_MPL2 = MKBETAG('M','P','L','2'),
479 AV_CODEC_ID_VPLAYER = MKBETAG('V','P','l','r'),
480 AV_CODEC_ID_PJS = MKBETAG('P','h','J','S'),
481 AV_CODEC_ID_ASS = MKBETAG('A','S','S',' '), ///< ASS as defined in Matroska
483 /* other specific kind of codecs (generally used for attachments) */
484 AV_CODEC_ID_FIRST_UNKNOWN = 0x18000, ///< A dummy ID pointing at the start of various fake codecs.
485 AV_CODEC_ID_TTF = 0x18000,
486 AV_CODEC_ID_BINTEXT = MKBETAG('B','T','X','T'),
487 AV_CODEC_ID_XBIN = MKBETAG('X','B','I','N'),
488 AV_CODEC_ID_IDF = MKBETAG( 0 ,'I','D','F'),
489 AV_CODEC_ID_OTF = MKBETAG( 0 ,'O','T','F'),
490 AV_CODEC_ID_SMPTE_KLV = MKBETAG('K','L','V','A'),
491 AV_CODEC_ID_DVD_NAV = MKBETAG('D','N','A','V'),
494 AV_CODEC_ID_PROBE = 0x19000, ///< codec_id is not known (like AV_CODEC_ID_NONE) but lavf should attempt to identify it
496 AV_CODEC_ID_MPEG2TS = 0x20000, /**< _FAKE_ codec to indicate a raw MPEG-2 TS
497 * stream (only used by libavformat) */
498 AV_CODEC_ID_MPEG4SYSTEMS = 0x20001, /**< _FAKE_ codec to indicate a MPEG-4 Systems
499 * stream (only used by libavformat) */
500 AV_CODEC_ID_FFMETADATA = 0x21000, ///< Dummy codec for streams containing only metadata information.
503 #include "old_codec_ids.h"
508 * This struct describes the properties of a single codec described by an
510 * @see avcodec_get_descriptor()
512 typedef struct AVCodecDescriptor {
514 enum AVMediaType type;
516 * Name of the codec described by this descriptor. It is non-empty and
517 * unique for each codec descriptor. It should contain alphanumeric
518 * characters and '_' only.
522 * A more descriptive name for this codec. May be NULL.
524 const char *long_name;
526 * Codec properties, a combination of AV_CODEC_PROP_* flags.
532 * Codec uses only intra compression.
535 #define AV_CODEC_PROP_INTRA_ONLY (1 << 0)
537 * Codec supports lossy compression. Audio and video codecs only.
538 * @note a codec may support both lossy and lossless
541 #define AV_CODEC_PROP_LOSSY (1 << 1)
543 * Codec supports lossless compression. Audio and video codecs only.
545 #define AV_CODEC_PROP_LOSSLESS (1 << 2)
547 * Subtitle codec is bitmap based
548 * Decoded AVSubtitle data can be read from the AVSubtitleRect->pict field.
550 #define AV_CODEC_PROP_BITMAP_SUB (1 << 16)
552 * Subtitle codec is text based.
553 * Decoded AVSubtitle data can be read from the AVSubtitleRect->ass field.
555 #define AV_CODEC_PROP_TEXT_SUB (1 << 17)
558 * @ingroup lavc_decoding
559 * Required number of additionally allocated bytes at the end of the input bitstream for decoding.
560 * This is mainly needed because some optimized bitstream readers read
561 * 32 or 64 bit at once and could read over the end.<br>
562 * Note: If the first 23 bits of the additional bytes are not 0, then damaged
563 * MPEG bitstreams could cause overread and segfault.
565 #define FF_INPUT_BUFFER_PADDING_SIZE 16
568 * @ingroup lavc_encoding
569 * minimum encoding buffer size
570 * Used to avoid some checks during header writing.
572 #define FF_MIN_BUFFER_SIZE 16384
576 * @ingroup lavc_encoding
577 * motion estimation type.
580 ME_ZERO = 1, ///< no search, that is use 0,0 vector whenever one is needed
584 ME_EPZS, ///< enhanced predictive zonal search
585 ME_X1, ///< reserved for experiments
586 ME_HEX, ///< hexagon based search
587 ME_UMH, ///< uneven multi-hexagon search
588 ME_TESA, ///< transformed exhaustive search algorithm
589 ME_ITER=50, ///< iterative search
593 * @ingroup lavc_decoding
596 /* We leave some space between them for extensions (drop some
597 * keyframes for intra-only or drop just some bidir frames). */
598 AVDISCARD_NONE =-16, ///< discard nothing
599 AVDISCARD_DEFAULT = 0, ///< discard useless packets like 0 size packets in avi
600 AVDISCARD_NONREF = 8, ///< discard all non reference
601 AVDISCARD_BIDIR = 16, ///< discard all bidirectional frames
602 AVDISCARD_NONKEY = 32, ///< discard all frames except keyframes
603 AVDISCARD_ALL = 48, ///< discard all
606 enum AVColorPrimaries{
607 AVCOL_PRI_BT709 = 1, ///< also ITU-R BT1361 / IEC 61966-2-4 / SMPTE RP177 Annex B
608 AVCOL_PRI_UNSPECIFIED = 2,
609 AVCOL_PRI_BT470M = 4,
610 AVCOL_PRI_BT470BG = 5, ///< also ITU-R BT601-6 625 / ITU-R BT1358 625 / ITU-R BT1700 625 PAL & SECAM
611 AVCOL_PRI_SMPTE170M = 6, ///< also ITU-R BT601-6 525 / ITU-R BT1358 525 / ITU-R BT1700 NTSC
612 AVCOL_PRI_SMPTE240M = 7, ///< functionally identical to above
614 AVCOL_PRI_NB , ///< Not part of ABI
617 enum AVColorTransferCharacteristic{
618 AVCOL_TRC_BT709 = 1, ///< also ITU-R BT1361
619 AVCOL_TRC_UNSPECIFIED = 2,
620 AVCOL_TRC_GAMMA22 = 4, ///< also ITU-R BT470M / ITU-R BT1700 625 PAL & SECAM
621 AVCOL_TRC_GAMMA28 = 5, ///< also ITU-R BT470BG
622 AVCOL_TRC_SMPTE240M = 7,
623 AVCOL_TRC_NB , ///< Not part of ABI
628 AVCOL_SPC_BT709 = 1, ///< also ITU-R BT1361 / IEC 61966-2-4 xvYCC709 / SMPTE RP177 Annex B
629 AVCOL_SPC_UNSPECIFIED = 2,
631 AVCOL_SPC_BT470BG = 5, ///< also ITU-R BT601-6 625 / ITU-R BT1358 625 / ITU-R BT1700 625 PAL & SECAM / IEC 61966-2-4 xvYCC601
632 AVCOL_SPC_SMPTE170M = 6, ///< also ITU-R BT601-6 525 / ITU-R BT1358 525 / ITU-R BT1700 NTSC / functionally identical to above
633 AVCOL_SPC_SMPTE240M = 7,
634 AVCOL_SPC_YCOCG = 8, ///< Used by Dirac / VC-2 and H.264 FRext, see ITU-T SG16
635 AVCOL_SPC_NB , ///< Not part of ABI
637 #define AVCOL_SPC_YCGCO AVCOL_SPC_YCOCG
640 AVCOL_RANGE_UNSPECIFIED = 0,
641 AVCOL_RANGE_MPEG = 1, ///< the normal 219*2^(n-8) "MPEG" YUV ranges
642 AVCOL_RANGE_JPEG = 2, ///< the normal 2^n-1 "JPEG" YUV ranges
643 AVCOL_RANGE_NB , ///< Not part of ABI
647 * X X 3 4 X X are luma samples,
648 * 1 2 1-6 are possible chroma positions
649 * X X 5 6 X 0 is undefined/unknown position
651 enum AVChromaLocation{
652 AVCHROMA_LOC_UNSPECIFIED = 0,
653 AVCHROMA_LOC_LEFT = 1, ///< mpeg2/4, h264 default
654 AVCHROMA_LOC_CENTER = 2, ///< mpeg1, jpeg, h263
655 AVCHROMA_LOC_TOPLEFT = 3, ///< DV
656 AVCHROMA_LOC_TOP = 4,
657 AVCHROMA_LOC_BOTTOMLEFT = 5,
658 AVCHROMA_LOC_BOTTOM = 6,
659 AVCHROMA_LOC_NB , ///< Not part of ABI
662 enum AVAudioServiceType {
663 AV_AUDIO_SERVICE_TYPE_MAIN = 0,
664 AV_AUDIO_SERVICE_TYPE_EFFECTS = 1,
665 AV_AUDIO_SERVICE_TYPE_VISUALLY_IMPAIRED = 2,
666 AV_AUDIO_SERVICE_TYPE_HEARING_IMPAIRED = 3,
667 AV_AUDIO_SERVICE_TYPE_DIALOGUE = 4,
668 AV_AUDIO_SERVICE_TYPE_COMMENTARY = 5,
669 AV_AUDIO_SERVICE_TYPE_EMERGENCY = 6,
670 AV_AUDIO_SERVICE_TYPE_VOICE_OVER = 7,
671 AV_AUDIO_SERVICE_TYPE_KARAOKE = 8,
672 AV_AUDIO_SERVICE_TYPE_NB , ///< Not part of ABI
676 * @ingroup lavc_encoding
678 typedef struct RcOverride{
681 int qscale; // If this is 0 then quality_factor will be used instead.
682 float quality_factor;
685 #define FF_MAX_B_FRAMES 16
688 These flags can be passed in AVCodecContext.flags before initialization.
689 Note: Not everything is supported yet.
693 * Allow decoders to produce frames with data planes that are not aligned
694 * to CPU requirements (e.g. due to cropping).
696 #define CODEC_FLAG_UNALIGNED 0x0001
697 #define CODEC_FLAG_QSCALE 0x0002 ///< Use fixed qscale.
698 #define CODEC_FLAG_4MV 0x0004 ///< 4 MV per MB allowed / advanced prediction for H.263.
699 #define CODEC_FLAG_QPEL 0x0010 ///< Use qpel MC.
700 #define CODEC_FLAG_GMC 0x0020 ///< Use GMC.
701 #define CODEC_FLAG_MV0 0x0040 ///< Always try a MB with MV=<0,0>.
703 * The parent program guarantees that the input for B-frames containing
704 * streams is not written to for at least s->max_b_frames+1 frames, if
705 * this is not set the input will be copied.
707 #define CODEC_FLAG_INPUT_PRESERVED 0x0100
708 #define CODEC_FLAG_PASS1 0x0200 ///< Use internal 2pass ratecontrol in first pass mode.
709 #define CODEC_FLAG_PASS2 0x0400 ///< Use internal 2pass ratecontrol in second pass mode.
710 #define CODEC_FLAG_GRAY 0x2000 ///< Only decode/encode grayscale.
711 #define CODEC_FLAG_EMU_EDGE 0x4000 ///< Don't draw edges.
712 #define CODEC_FLAG_PSNR 0x8000 ///< error[?] variables will be set during encoding.
713 #define CODEC_FLAG_TRUNCATED 0x00010000 /** Input bitstream might be truncated at a random
714 location instead of only at frame boundaries. */
715 #define CODEC_FLAG_NORMALIZE_AQP 0x00020000 ///< Normalize adaptive quantization.
716 #define CODEC_FLAG_INTERLACED_DCT 0x00040000 ///< Use interlaced DCT.
717 #define CODEC_FLAG_LOW_DELAY 0x00080000 ///< Force low delay.
718 #define CODEC_FLAG_GLOBAL_HEADER 0x00400000 ///< Place global headers in extradata instead of every keyframe.
719 #define CODEC_FLAG_BITEXACT 0x00800000 ///< Use only bitexact stuff (except (I)DCT).
720 /* Fx : Flag for h263+ extra options */
721 #define CODEC_FLAG_AC_PRED 0x01000000 ///< H.263 advanced intra coding / MPEG-4 AC prediction
722 #define CODEC_FLAG_LOOP_FILTER 0x00000800 ///< loop filter
723 #define CODEC_FLAG_INTERLACED_ME 0x20000000 ///< interlaced motion estimation
724 #define CODEC_FLAG_CLOSED_GOP 0x80000000
725 #define CODEC_FLAG2_FAST 0x00000001 ///< Allow non spec compliant speedup tricks.
726 #define CODEC_FLAG2_NO_OUTPUT 0x00000004 ///< Skip bitstream encoding.
727 #define CODEC_FLAG2_LOCAL_HEADER 0x00000008 ///< Place global headers at every keyframe instead of in extradata.
728 #define CODEC_FLAG2_DROP_FRAME_TIMECODE 0x00002000 ///< timecode is in drop frame format. DEPRECATED!!!!
729 #define CODEC_FLAG2_IGNORE_CROP 0x00010000 ///< Discard cropping information from SPS.
731 #define CODEC_FLAG2_CHUNKS 0x00008000 ///< Input bitstream might be truncated at a packet boundaries instead of only at frame boundaries.
732 #define CODEC_FLAG2_SHOW_ALL 0x00400000 ///< Show all frames before the first keyframe
734 /* Unsupported options :
735 * Syntax Arithmetic coding (SAC)
736 * Reference Picture Selection
737 * Independent Segment Decoding */
739 /* codec capabilities */
741 #define CODEC_CAP_DRAW_HORIZ_BAND 0x0001 ///< Decoder can use draw_horiz_band callback.
743 * Codec uses get_buffer() for allocating buffers and supports custom allocators.
744 * If not set, it might not use get_buffer() at all or use operations that
745 * assume the buffer was allocated by avcodec_default_get_buffer.
747 #define CODEC_CAP_DR1 0x0002
748 #define CODEC_CAP_TRUNCATED 0x0008
749 /* Codec can export data for HW decoding (XvMC). */
750 #define CODEC_CAP_HWACCEL 0x0010
752 * Encoder or decoder requires flushing with NULL input at the end in order to
753 * give the complete and correct output.
755 * NOTE: If this flag is not set, the codec is guaranteed to never be fed with
756 * with NULL data. The user can still send NULL data to the public encode
757 * or decode function, but libavcodec will not pass it along to the codec
758 * unless this flag is set.
761 * The decoder has a non-zero delay and needs to be fed with avpkt->data=NULL,
762 * avpkt->size=0 at the end to get the delayed data until the decoder no longer
766 * The encoder needs to be fed with NULL data at the end of encoding until the
767 * encoder no longer returns data.
769 * NOTE: For encoders implementing the AVCodec.encode2() function, setting this
770 * flag also means that the encoder must set the pts and duration for
771 * each output packet. If this flag is not set, the pts and duration will
772 * be determined by libavcodec from the input frame.
774 #define CODEC_CAP_DELAY 0x0020
776 * Codec can be fed a final frame with a smaller size.
777 * This can be used to prevent truncation of the last audio samples.
779 #define CODEC_CAP_SMALL_LAST_FRAME 0x0040
781 * Codec can export data for HW decoding (VDPAU).
783 #define CODEC_CAP_HWACCEL_VDPAU 0x0080
785 * Codec can output multiple frames per AVPacket
786 * Normally demuxers return one frame at a time, demuxers which do not do
787 * are connected to a parser to split what they return into proper frames.
788 * This flag is reserved to the very rare category of codecs which have a
789 * bitstream that cannot be split into frames without timeconsuming
790 * operations like full decoding. Demuxers carring such bitstreams thus
791 * may return multiple frames in a packet. This has many disadvantages like
792 * prohibiting stream copy in many cases thus it should only be considered
795 #define CODEC_CAP_SUBFRAMES 0x0100
797 * Codec is experimental and is thus avoided in favor of non experimental
800 #define CODEC_CAP_EXPERIMENTAL 0x0200
802 * Codec should fill in channel configuration and samplerate instead of container
804 #define CODEC_CAP_CHANNEL_CONF 0x0400
807 * Codec is able to deal with negative linesizes
809 #define CODEC_CAP_NEG_LINESIZES 0x0800
812 * Codec supports frame-level multithreading.
814 #define CODEC_CAP_FRAME_THREADS 0x1000
816 * Codec supports slice-based (or partition-based) multithreading.
818 #define CODEC_CAP_SLICE_THREADS 0x2000
820 * Codec supports changed parameters at any point.
822 #define CODEC_CAP_PARAM_CHANGE 0x4000
824 * Codec supports avctx->thread_count == 0 (auto).
826 #define CODEC_CAP_AUTO_THREADS 0x8000
828 * Audio encoder supports receiving a different number of samples in each call.
830 #define CODEC_CAP_VARIABLE_FRAME_SIZE 0x10000
832 * Codec is intra only.
834 #define CODEC_CAP_INTRA_ONLY 0x40000000
838 #define CODEC_CAP_LOSSLESS 0x80000000
840 //The following defines may change, don't expect compatibility if you use them.
841 #define MB_TYPE_INTRA4x4 0x0001
842 #define MB_TYPE_INTRA16x16 0x0002 //FIXME H.264-specific
843 #define MB_TYPE_INTRA_PCM 0x0004 //FIXME H.264-specific
844 #define MB_TYPE_16x16 0x0008
845 #define MB_TYPE_16x8 0x0010
846 #define MB_TYPE_8x16 0x0020
847 #define MB_TYPE_8x8 0x0040
848 #define MB_TYPE_INTERLACED 0x0080
849 #define MB_TYPE_DIRECT2 0x0100 //FIXME
850 #define MB_TYPE_ACPRED 0x0200
851 #define MB_TYPE_GMC 0x0400
852 #define MB_TYPE_SKIP 0x0800
853 #define MB_TYPE_P0L0 0x1000
854 #define MB_TYPE_P1L0 0x2000
855 #define MB_TYPE_P0L1 0x4000
856 #define MB_TYPE_P1L1 0x8000
857 #define MB_TYPE_L0 (MB_TYPE_P0L0 | MB_TYPE_P1L0)
858 #define MB_TYPE_L1 (MB_TYPE_P0L1 | MB_TYPE_P1L1)
859 #define MB_TYPE_L0L1 (MB_TYPE_L0 | MB_TYPE_L1)
860 #define MB_TYPE_QUANT 0x00010000
861 #define MB_TYPE_CBP 0x00020000
862 //Note bits 24-31 are reserved for codec specific use (h264 ref0, mpeg1 0mv, ...)
866 * This specifies the area which should be displayed.
867 * Note there may be multiple such areas for one frame.
869 typedef struct AVPanScan{
872 * - encoding: Set by user.
873 * - decoding: Set by libavcodec.
878 * width and height in 1/16 pel
879 * - encoding: Set by user.
880 * - decoding: Set by libavcodec.
886 * position of the top left corner in 1/16 pel for up to 3 fields/frames
887 * - encoding: Set by user.
888 * - decoding: Set by libavcodec.
890 int16_t position[3][2];
893 #define FF_QSCALE_TYPE_MPEG1 0
894 #define FF_QSCALE_TYPE_MPEG2 1
895 #define FF_QSCALE_TYPE_H264 2
896 #define FF_QSCALE_TYPE_VP56 3
898 #if FF_API_GET_BUFFER
899 #define FF_BUFFER_TYPE_INTERNAL 1
900 #define FF_BUFFER_TYPE_USER 2 ///< direct rendering buffers (image is (de)allocated by user)
901 #define FF_BUFFER_TYPE_SHARED 4 ///< Buffer from somewhere else; don't deallocate image (data/base), all other tables are not shared.
902 #define FF_BUFFER_TYPE_COPY 8 ///< Just a (modified) copy of some other buffer, don't deallocate anything.
904 #define FF_BUFFER_HINTS_VALID 0x01 // Buffer hints value is meaningful (if 0 ignore).
905 #define FF_BUFFER_HINTS_READABLE 0x02 // Codec will read from buffer.
906 #define FF_BUFFER_HINTS_PRESERVE 0x04 // User must not alter buffer content.
907 #define FF_BUFFER_HINTS_REUSABLE 0x08 // Codec will reuse the buffer (update).
911 * The decoder will keep a reference to the frame and may reuse it later.
913 #define AV_GET_BUFFER_FLAG_REF (1 << 0)
916 * @defgroup lavc_packet AVPacket
918 * Types and functions for working with AVPacket.
921 enum AVPacketSideDataType {
923 AV_PKT_DATA_NEW_EXTRADATA,
926 * An AV_PKT_DATA_PARAM_CHANGE side data packet is laid out as follows:
929 * if (param_flags & AV_SIDE_DATA_PARAM_CHANGE_CHANNEL_COUNT)
930 * s32le channel_count
931 * if (param_flags & AV_SIDE_DATA_PARAM_CHANGE_CHANNEL_LAYOUT)
932 * u64le channel_layout
933 * if (param_flags & AV_SIDE_DATA_PARAM_CHANGE_SAMPLE_RATE)
935 * if (param_flags & AV_SIDE_DATA_PARAM_CHANGE_DIMENSIONS)
940 AV_PKT_DATA_PARAM_CHANGE,
943 * An AV_PKT_DATA_H263_MB_INFO side data packet contains a number of
944 * structures with info about macroblocks relevant to splitting the
945 * packet into smaller packets on macroblock edges (e.g. as for RFC 2190).
946 * That is, it does not necessarily contain info about all macroblocks,
947 * as long as the distance between macroblocks in the info is smaller
948 * than the target payload size.
949 * Each MB info structure is 12 bytes, and is laid out as follows:
951 * u32le bit offset from the start of the packet
952 * u8 current quantizer at the start of the macroblock
954 * u16le macroblock address within the GOB
955 * u8 horizontal MV predictor
956 * u8 vertical MV predictor
957 * u8 horizontal MV predictor for block number 3
958 * u8 vertical MV predictor for block number 3
961 AV_PKT_DATA_H263_MB_INFO,
964 * Recommmends skipping the specified number of samples
966 * u32le number of samples to skip from start of this packet
967 * u32le number of samples to skip from end of this packet
968 * u8 reason for start skip
969 * u8 reason for end skip (0=padding silence, 1=convergence)
972 AV_PKT_DATA_SKIP_SAMPLES=70,
975 * An AV_PKT_DATA_JP_DUALMONO side data packet indicates that
976 * the packet may contain "dual mono" audio specific to Japanese DTV
977 * and if it is true, recommends only the selected channel to be used.
979 * u8 selected channels (0=mail/left, 1=sub/right, 2=both)
982 AV_PKT_DATA_JP_DUALMONO,
985 * A list of zero terminated key/value strings. There is no end marker for
986 * the list, so it is required to rely on the side data size to stop.
988 AV_PKT_DATA_STRINGS_METADATA,
991 * Subtitle event position
999 AV_PKT_DATA_SUBTITLE_POSITION,
1002 * Data found in BlockAdditional element of matroska container. There is
1003 * no end marker for the data, so it is required to rely on the side data
1004 * size to recognize the end. 8 byte id (as found in BlockAddId) followed
1007 AV_PKT_DATA_MATROSKA_BLOCKADDITIONAL,
1011 * This structure stores compressed data. It is typically exported by demuxers
1012 * and then passed as input to decoders, or received as output from encoders and
1013 * then passed to muxers.
1015 * For video, it should typically contain one compressed frame. For audio it may
1016 * contain several compressed frames.
1018 * AVPacket is one of the few structs in FFmpeg, whose size is a part of public
1019 * ABI. Thus it may be allocated on stack and no new fields can be added to it
1020 * without libavcodec and libavformat major bump.
1022 * The semantics of data ownership depends on the buf or destruct (deprecated)
1023 * fields. If either is set, the packet data is dynamically allocated and is
1024 * valid indefinitely until av_free_packet() is called (which in turn calls
1025 * av_buffer_unref()/the destruct callback to free the data). If neither is set,
1026 * the packet data is typically backed by some static buffer somewhere and is
1027 * only valid for a limited time (e.g. until the next read call when demuxing).
1029 * The side data is always allocated with av_malloc() and is freed in
1032 typedef struct AVPacket {
1034 * A reference to the reference-counted buffer where the packet data is
1036 * May be NULL, then the packet data is not reference-counted.
1040 * Presentation timestamp in AVStream->time_base units; the time at which
1041 * the decompressed packet will be presented to the user.
1042 * Can be AV_NOPTS_VALUE if it is not stored in the file.
1043 * pts MUST be larger or equal to dts as presentation cannot happen before
1044 * decompression, unless one wants to view hex dumps. Some formats misuse
1045 * the terms dts and pts/cts to mean something different. Such timestamps
1046 * must be converted to true pts/dts before they are stored in AVPacket.
1050 * Decompression timestamp in AVStream->time_base units; the time at which
1051 * the packet is decompressed.
1052 * Can be AV_NOPTS_VALUE if it is not stored in the file.
1059 * A combination of AV_PKT_FLAG values
1063 * Additional packet data that can be provided by the container.
1064 * Packet can contain several types of side information.
1069 enum AVPacketSideDataType type;
1071 int side_data_elems;
1074 * Duration of this packet in AVStream->time_base units, 0 if unknown.
1075 * Equals next_pts - this_pts in presentation order.
1078 #if FF_API_DESTRUCT_PACKET
1079 attribute_deprecated
1080 void (*destruct)(struct AVPacket *);
1081 attribute_deprecated
1084 int64_t pos; ///< byte position in stream, -1 if unknown
1087 * Time difference in AVStream->time_base units from the pts of this
1088 * packet to the point at which the output from the decoder has converged
1089 * independent from the availability of previous frames. That is, the
1090 * frames are virtually identical no matter if decoding started from
1091 * the very first frame or from this keyframe.
1092 * Is AV_NOPTS_VALUE if unknown.
1093 * This field is not the display duration of the current packet.
1094 * This field has no meaning if the packet does not have AV_PKT_FLAG_KEY
1097 * The purpose of this field is to allow seeking in streams that have no
1098 * keyframes in the conventional sense. It corresponds to the
1099 * recovery point SEI in H.264 and match_time_delta in NUT. It is also
1100 * essential for some types of subtitle streams to ensure that all
1101 * subtitles are correctly displayed after seeking.
1103 int64_t convergence_duration;
1105 #define AV_PKT_FLAG_KEY 0x0001 ///< The packet contains a keyframe
1106 #define AV_PKT_FLAG_CORRUPT 0x0002 ///< The packet content is corrupted
1108 enum AVSideDataParamChangeFlags {
1109 AV_SIDE_DATA_PARAM_CHANGE_CHANNEL_COUNT = 0x0001,
1110 AV_SIDE_DATA_PARAM_CHANGE_CHANNEL_LAYOUT = 0x0002,
1111 AV_SIDE_DATA_PARAM_CHANGE_SAMPLE_RATE = 0x0004,
1112 AV_SIDE_DATA_PARAM_CHANGE_DIMENSIONS = 0x0008,
1118 struct AVCodecInternal;
1122 AV_FIELD_PROGRESSIVE,
1123 AV_FIELD_TT, //< Top coded_first, top displayed first
1124 AV_FIELD_BB, //< Bottom coded first, bottom displayed first
1125 AV_FIELD_TB, //< Top coded first, bottom displayed first
1126 AV_FIELD_BT, //< Bottom coded first, top displayed first
1130 * main external API structure.
1131 * New fields can be added to the end with minor version bumps.
1132 * Removal, reordering and changes to existing fields require a major
1134 * Please use AVOptions (av_opt* / av_set/get*()) to access these fields from user
1136 * sizeof(AVCodecContext) must not be used outside libav*.
1138 typedef struct AVCodecContext {
1140 * information on struct for av_log
1141 * - set by avcodec_alloc_context3
1143 const AVClass *av_class;
1144 int log_level_offset;
1146 enum AVMediaType codec_type; /* see AVMEDIA_TYPE_xxx */
1147 const struct AVCodec *codec;
1148 char codec_name[32];
1149 enum AVCodecID codec_id; /* see AV_CODEC_ID_xxx */
1152 * fourcc (LSB first, so "ABCD" -> ('D'<<24) + ('C'<<16) + ('B'<<8) + 'A').
1153 * This is used to work around some encoder bugs.
1154 * A demuxer should set this to what is stored in the field used to identify the codec.
1155 * If there are multiple such fields in a container then the demuxer should choose the one
1156 * which maximizes the information about the used codec.
1157 * If the codec tag field in a container is larger than 32 bits then the demuxer should
1158 * remap the longer ID to 32 bits with a table or other structure. Alternatively a new
1159 * extra_codec_tag + size could be added but for this a clear advantage must be demonstrated
1161 * - encoding: Set by user, if not then the default based on codec_id will be used.
1162 * - decoding: Set by user, will be converted to uppercase by libavcodec during init.
1164 unsigned int codec_tag;
1167 * fourcc from the AVI stream header (LSB first, so "ABCD" -> ('D'<<24) + ('C'<<16) + ('B'<<8) + 'A').
1168 * This is used to work around some encoder bugs.
1169 * - encoding: unused
1170 * - decoding: Set by user, will be converted to uppercase by libavcodec during init.
1172 unsigned int stream_codec_tag;
1177 * Private context used for internal data.
1179 * Unlike priv_data, this is not codec-specific. It is used in general
1180 * libavcodec functions.
1182 struct AVCodecInternal *internal;
1185 * Private data of the user, can be used to carry app specific stuff.
1186 * - encoding: Set by user.
1187 * - decoding: Set by user.
1192 * the average bitrate
1193 * - encoding: Set by user; unused for constant quantizer encoding.
1194 * - decoding: Set by libavcodec. 0 or some bitrate if this info is available in the stream.
1199 * number of bits the bitstream is allowed to diverge from the reference.
1200 * the reference can be CBR (for CBR pass1) or VBR (for pass2)
1201 * - encoding: Set by user; unused for constant quantizer encoding.
1202 * - decoding: unused
1204 int bit_rate_tolerance;
1207 * Global quality for codecs which cannot change it per frame.
1208 * This should be proportional to MPEG-1/2/4 qscale.
1209 * - encoding: Set by user.
1210 * - decoding: unused
1215 * - encoding: Set by user.
1216 * - decoding: unused
1218 int compression_level;
1219 #define FF_COMPRESSION_DEFAULT -1
1223 * - encoding: Set by user.
1224 * - decoding: Set by user.
1230 * - encoding: Set by user.
1231 * - decoding: Set by user.
1236 * some codecs need / can use extradata like Huffman tables.
1237 * mjpeg: Huffman tables
1238 * rv10: additional flags
1239 * mpeg4: global headers (they can be in the bitstream or here)
1240 * The allocated memory should be FF_INPUT_BUFFER_PADDING_SIZE bytes larger
1241 * than extradata_size to avoid prolems if it is read with the bitstream reader.
1242 * The bytewise contents of extradata must not depend on the architecture or CPU endianness.
1243 * - encoding: Set/allocated/freed by libavcodec.
1244 * - decoding: Set/allocated/freed by user.
1250 * This is the fundamental unit of time (in seconds) in terms
1251 * of which frame timestamps are represented. For fixed-fps content,
1252 * timebase should be 1/framerate and timestamp increments should be
1254 * - encoding: MUST be set by user.
1255 * - decoding: Set by libavcodec.
1257 AVRational time_base;
1260 * For some codecs, the time base is closer to the field rate than the frame rate.
1261 * Most notably, H.264 and MPEG-2 specify time_base as half of frame duration
1262 * if no telecine is used ...
1264 * Set to time_base ticks per frame. Default 1, e.g., H.264/MPEG-2 set it to 2.
1266 int ticks_per_frame;
1271 * Encoding: Number of frames delay there will be from the encoder input to
1272 * the decoder output. (we assume the decoder matches the spec)
1273 * Decoding: Number of frames delay in addition to what a standard decoder
1274 * as specified in the spec would produce.
1277 * Number of frames the decoded output will be delayed relative to the
1281 * For encoding, this is the number of "priming" samples added to the
1282 * beginning of the stream. The decoded output will be delayed by this
1283 * many samples relative to the input to the encoder. Note that this
1284 * field is purely informational and does not directly affect the pts
1285 * output by the encoder, which should always be based on the actual
1286 * presentation time, including any delay.
1287 * For decoding, this is the number of samples the decoder needs to
1288 * output before the decoder's output is valid. When seeking, you should
1289 * start decoding this many samples prior to your desired seek point.
1291 * - encoding: Set by libavcodec.
1292 * - decoding: Set by libavcodec.
1299 * picture width / height.
1300 * - encoding: MUST be set by user.
1301 * - decoding: May be set by the user before opening the decoder if known e.g.
1302 * from the container. Some decoders will require the dimensions
1303 * to be set by the caller. During decoding, the decoder may
1304 * overwrite those values as required.
1309 * Bitstream width / height, may be different from width/height e.g. when
1310 * the decoded frame is cropped before being output or lowres is enabled.
1311 * - encoding: unused
1312 * - decoding: May be set by the user before opening the decoder if known
1313 * e.g. from the container. During decoding, the decoder may
1314 * overwrite those values as required.
1316 int coded_width, coded_height;
1318 #define FF_ASPECT_EXTENDED 15
1321 * the number of pictures in a group of pictures, or 0 for intra_only
1322 * - encoding: Set by user.
1323 * - decoding: unused
1328 * Pixel format, see AV_PIX_FMT_xxx.
1329 * May be set by the demuxer if known from headers.
1330 * May be overridden by the decoder if it knows better.
1331 * - encoding: Set by user.
1332 * - decoding: Set by user if known, overridden by libavcodec if known
1334 enum AVPixelFormat pix_fmt;
1337 * Motion estimation algorithm used for video coding.
1338 * 1 (zero), 2 (full), 3 (log), 4 (phods), 5 (epzs), 6 (x1), 7 (hex),
1339 * 8 (umh), 9 (iter), 10 (tesa) [7, 8, 10 are x264 specific, 9 is snow specific]
1340 * - encoding: MUST be set by user.
1341 * - decoding: unused
1346 * If non NULL, 'draw_horiz_band' is called by the libavcodec
1347 * decoder to draw a horizontal band. It improves cache usage. Not
1348 * all codecs can do that. You must check the codec capabilities
1350 * When multithreading is used, it may be called from multiple threads
1351 * at the same time; threads might draw different parts of the same AVFrame,
1352 * or multiple AVFrames, and there is no guarantee that slices will be drawn
1354 * The function is also used by hardware acceleration APIs.
1355 * It is called at least once during frame decoding to pass
1356 * the data needed for hardware render.
1357 * In that mode instead of pixel data, AVFrame points to
1358 * a structure specific to the acceleration API. The application
1359 * reads the structure and can change some fields to indicate progress
1361 * - encoding: unused
1362 * - decoding: Set by user.
1363 * @param height the height of the slice
1364 * @param y the y position of the slice
1365 * @param type 1->top field, 2->bottom field, 3->frame
1366 * @param offset offset into the AVFrame.data from which the slice should be read
1368 void (*draw_horiz_band)(struct AVCodecContext *s,
1369 const AVFrame *src, int offset[AV_NUM_DATA_POINTERS],
1370 int y, int type, int height);
1373 * callback to negotiate the pixelFormat
1374 * @param fmt is the list of formats which are supported by the codec,
1375 * it is terminated by -1 as 0 is a valid format, the formats are ordered by quality.
1376 * The first is always the native one.
1377 * @return the chosen format
1378 * - encoding: unused
1379 * - decoding: Set by user, if not set the native format will be chosen.
1381 enum AVPixelFormat (*get_format)(struct AVCodecContext *s, const enum AVPixelFormat * fmt);
1384 * maximum number of B-frames between non-B-frames
1385 * Note: The output will be delayed by max_b_frames+1 relative to the input.
1386 * - encoding: Set by user.
1387 * - decoding: unused
1392 * qscale factor between IP and B-frames
1393 * If > 0 then the last P-frame quantizer will be used (q= lastp_q*factor+offset).
1394 * If < 0 then normal ratecontrol will be done (q= -normal_q*factor+offset).
1395 * - encoding: Set by user.
1396 * - decoding: unused
1398 float b_quant_factor;
1400 /** obsolete FIXME remove */
1402 #define FF_RC_STRATEGY_XVID 1
1404 int b_frame_strategy;
1407 * qscale offset between IP and B-frames
1408 * - encoding: Set by user.
1409 * - decoding: unused
1411 float b_quant_offset;
1414 * Size of the frame reordering buffer in the decoder.
1415 * For MPEG-2 it is 1 IPB or 0 low delay IP.
1416 * - encoding: Set by libavcodec.
1417 * - decoding: Set by libavcodec.
1422 * 0-> h263 quant 1-> mpeg quant
1423 * - encoding: Set by user.
1424 * - decoding: unused
1429 * qscale factor between P and I-frames
1430 * If > 0 then the last p frame quantizer will be used (q= lastp_q*factor+offset).
1431 * If < 0 then normal ratecontrol will be done (q= -normal_q*factor+offset).
1432 * - encoding: Set by user.
1433 * - decoding: unused
1435 float i_quant_factor;
1438 * qscale offset between P and I-frames
1439 * - encoding: Set by user.
1440 * - decoding: unused
1442 float i_quant_offset;
1445 * luminance masking (0-> disabled)
1446 * - encoding: Set by user.
1447 * - decoding: unused
1452 * temporary complexity masking (0-> disabled)
1453 * - encoding: Set by user.
1454 * - decoding: unused
1456 float temporal_cplx_masking;
1459 * spatial complexity masking (0-> disabled)
1460 * - encoding: Set by user.
1461 * - decoding: unused
1463 float spatial_cplx_masking;
1466 * p block masking (0-> disabled)
1467 * - encoding: Set by user.
1468 * - decoding: unused
1473 * darkness masking (0-> disabled)
1474 * - encoding: Set by user.
1475 * - decoding: unused
1481 * - encoding: Set by libavcodec.
1482 * - decoding: Set by user (or 0).
1486 * prediction method (needed for huffyuv)
1487 * - encoding: Set by user.
1488 * - decoding: unused
1490 int prediction_method;
1491 #define FF_PRED_LEFT 0
1492 #define FF_PRED_PLANE 1
1493 #define FF_PRED_MEDIAN 2
1496 * slice offsets in the frame in bytes
1497 * - encoding: Set/allocated by libavcodec.
1498 * - decoding: Set/allocated by user (or NULL).
1503 * sample aspect ratio (0 if unknown)
1504 * That is the width of a pixel divided by the height of the pixel.
1505 * Numerator and denominator must be relatively prime and smaller than 256 for some video standards.
1506 * - encoding: Set by user.
1507 * - decoding: Set by libavcodec.
1509 AVRational sample_aspect_ratio;
1512 * motion estimation comparison function
1513 * - encoding: Set by user.
1514 * - decoding: unused
1518 * subpixel motion estimation comparison function
1519 * - encoding: Set by user.
1520 * - decoding: unused
1524 * macroblock comparison function (not supported yet)
1525 * - encoding: Set by user.
1526 * - decoding: unused
1530 * interlaced DCT comparison function
1531 * - encoding: Set by user.
1532 * - decoding: unused
1535 #define FF_CMP_SAD 0
1536 #define FF_CMP_SSE 1
1537 #define FF_CMP_SATD 2
1538 #define FF_CMP_DCT 3
1539 #define FF_CMP_PSNR 4
1540 #define FF_CMP_BIT 5
1542 #define FF_CMP_ZERO 7
1543 #define FF_CMP_VSAD 8
1544 #define FF_CMP_VSSE 9
1545 #define FF_CMP_NSSE 10
1546 #define FF_CMP_W53 11
1547 #define FF_CMP_W97 12
1548 #define FF_CMP_DCTMAX 13
1549 #define FF_CMP_DCT264 14
1550 #define FF_CMP_CHROMA 256
1553 * ME diamond size & shape
1554 * - encoding: Set by user.
1555 * - decoding: unused
1560 * amount of previous MV predictors (2a+1 x 2a+1 square)
1561 * - encoding: Set by user.
1562 * - decoding: unused
1564 int last_predictor_count;
1567 * prepass for motion estimation
1568 * - encoding: Set by user.
1569 * - decoding: unused
1574 * motion estimation prepass comparison function
1575 * - encoding: Set by user.
1576 * - decoding: unused
1581 * ME prepass diamond size & shape
1582 * - encoding: Set by user.
1583 * - decoding: unused
1589 * - encoding: Set by user.
1590 * - decoding: unused
1592 int me_subpel_quality;
1595 * DTG active format information (additional aspect ratio
1596 * information only used in DVB MPEG-2 transport streams)
1599 * - encoding: unused
1600 * - decoding: Set by decoder.
1602 int dtg_active_format;
1603 #define FF_DTG_AFD_SAME 8
1604 #define FF_DTG_AFD_4_3 9
1605 #define FF_DTG_AFD_16_9 10
1606 #define FF_DTG_AFD_14_9 11
1607 #define FF_DTG_AFD_4_3_SP_14_9 13
1608 #define FF_DTG_AFD_16_9_SP_14_9 14
1609 #define FF_DTG_AFD_SP_4_3 15
1612 * maximum motion estimation search range in subpel units
1613 * If 0 then no limit.
1615 * - encoding: Set by user.
1616 * - decoding: unused
1621 * intra quantizer bias
1622 * - encoding: Set by user.
1623 * - decoding: unused
1625 int intra_quant_bias;
1626 #define FF_DEFAULT_QUANT_BIAS 999999
1629 * inter quantizer bias
1630 * - encoding: Set by user.
1631 * - decoding: unused
1633 int inter_quant_bias;
1637 * - encoding: unused
1638 * - decoding: Set by user.
1641 #define SLICE_FLAG_CODED_ORDER 0x0001 ///< draw_horiz_band() is called in coded order instead of display
1642 #define SLICE_FLAG_ALLOW_FIELD 0x0002 ///< allow draw_horiz_band() with field slices (MPEG2 field pics)
1643 #define SLICE_FLAG_ALLOW_PLANE 0x0004 ///< allow draw_horiz_band() with 1 component at a time (SVQ1)
1646 * XVideo Motion Acceleration
1647 * - encoding: forbidden
1648 * - decoding: set by decoder
1650 int xvmc_acceleration;
1653 * macroblock decision mode
1654 * - encoding: Set by user.
1655 * - decoding: unused
1658 #define FF_MB_DECISION_SIMPLE 0 ///< uses mb_cmp
1659 #define FF_MB_DECISION_BITS 1 ///< chooses the one which needs the fewest bits
1660 #define FF_MB_DECISION_RD 2 ///< rate distortion
1663 * custom intra quantization matrix
1664 * - encoding: Set by user, can be NULL.
1665 * - decoding: Set by libavcodec.
1667 uint16_t *intra_matrix;
1670 * custom inter quantization matrix
1671 * - encoding: Set by user, can be NULL.
1672 * - decoding: Set by libavcodec.
1674 uint16_t *inter_matrix;
1677 * scene change detection threshold
1678 * 0 is default, larger means fewer detected scene changes.
1679 * - encoding: Set by user.
1680 * - decoding: unused
1682 int scenechange_threshold;
1685 * noise reduction strength
1686 * - encoding: Set by user.
1687 * - decoding: unused
1689 int noise_reduction;
1692 * Motion estimation threshold below which no motion estimation is
1693 * performed, but instead the user specified motion vectors are used.
1695 * - encoding: Set by user.
1696 * - decoding: unused
1701 * Macroblock threshold below which the user specified macroblock types will be used.
1702 * - encoding: Set by user.
1703 * - decoding: unused
1708 * precision of the intra DC coefficient - 8
1709 * - encoding: Set by user.
1710 * - decoding: unused
1712 int intra_dc_precision;
1715 * Number of macroblock rows at the top which are skipped.
1716 * - encoding: unused
1717 * - decoding: Set by user.
1722 * Number of macroblock rows at the bottom which are skipped.
1723 * - encoding: unused
1724 * - decoding: Set by user.
1729 * Border processing masking, raises the quantizer for mbs on the borders
1731 * - encoding: Set by user.
1732 * - decoding: unused
1734 float border_masking;
1737 * minimum MB lagrange multipler
1738 * - encoding: Set by user.
1739 * - decoding: unused
1744 * maximum MB lagrange multipler
1745 * - encoding: Set by user.
1746 * - decoding: unused
1752 * - encoding: Set by user.
1753 * - decoding: unused
1755 int me_penalty_compensation;
1759 * - encoding: Set by user.
1760 * - decoding: unused
1766 * - encoding: Set by user.
1767 * - decoding: unused
1773 * - encoding: Set by user.
1774 * - decoding: unused
1779 * number of reference frames
1780 * - encoding: Set by user.
1781 * - decoding: Set by lavc.
1786 * chroma qp offset from luma
1787 * - encoding: Set by user.
1788 * - decoding: unused
1793 * Multiplied by qscale for each frame and added to scene_change_score.
1794 * - encoding: Set by user.
1795 * - decoding: unused
1797 int scenechange_factor;
1801 * Note: Value depends upon the compare function used for fullpel ME.
1802 * - encoding: Set by user.
1803 * - decoding: unused
1808 * Adjust sensitivity of b_frame_strategy 1.
1809 * - encoding: Set by user.
1810 * - decoding: unused
1815 * Chromaticity coordinates of the source primaries.
1816 * - encoding: Set by user
1817 * - decoding: Set by libavcodec
1819 enum AVColorPrimaries color_primaries;
1822 * Color Transfer Characteristic.
1823 * - encoding: Set by user
1824 * - decoding: Set by libavcodec
1826 enum AVColorTransferCharacteristic color_trc;
1829 * YUV colorspace type.
1830 * - encoding: Set by user
1831 * - decoding: Set by libavcodec
1833 enum AVColorSpace colorspace;
1836 * MPEG vs JPEG YUV range.
1837 * - encoding: Set by user
1838 * - decoding: Set by libavcodec
1840 enum AVColorRange color_range;
1843 * This defines the location of chroma samples.
1844 * - encoding: Set by user
1845 * - decoding: Set by libavcodec
1847 enum AVChromaLocation chroma_sample_location;
1851 * Indicates number of picture subdivisions. Used for parallelized
1853 * - encoding: Set by user
1854 * - decoding: unused
1859 * - encoding: set by libavcodec
1860 * - decoding: Set by user.
1862 enum AVFieldOrder field_order;
1865 int sample_rate; ///< samples per second
1866 int channels; ///< number of audio channels
1869 * audio sample format
1870 * - encoding: Set by user.
1871 * - decoding: Set by libavcodec.
1873 enum AVSampleFormat sample_fmt; ///< sample format
1875 /* The following data should not be initialized. */
1877 * Number of samples per channel in an audio frame.
1879 * - encoding: set by libavcodec in avcodec_open2(). Each submitted frame
1880 * except the last must contain exactly frame_size samples per channel.
1881 * May be 0 when the codec has CODEC_CAP_VARIABLE_FRAME_SIZE set, then the
1882 * frame size is not restricted.
1883 * - decoding: may be set by some decoders to indicate constant frame size
1888 * Frame counter, set by libavcodec.
1890 * - decoding: total number of frames returned from the decoder so far.
1891 * - encoding: total number of frames passed to the encoder so far.
1893 * @note the counter is not incremented if encoding/decoding resulted in
1899 * number of bytes per packet if constant and known or 0
1900 * Used by some WAV based audio codecs.
1905 * Audio cutoff bandwidth (0 means "automatic")
1906 * - encoding: Set by user.
1907 * - decoding: unused
1911 #if FF_API_REQUEST_CHANNELS
1913 * Decoder should decode to this many channels if it can (0 for default)
1914 * - encoding: unused
1915 * - decoding: Set by user.
1916 * @deprecated Deprecated in favor of request_channel_layout.
1918 int request_channels;
1922 * Audio channel layout.
1923 * - encoding: set by user.
1924 * - decoding: set by user, may be overwritten by libavcodec.
1926 uint64_t channel_layout;
1929 * Request decoder to use this channel layout if it can (0 for default)
1930 * - encoding: unused
1931 * - decoding: Set by user.
1933 uint64_t request_channel_layout;
1936 * Type of service that the audio stream conveys.
1937 * - encoding: Set by user.
1938 * - decoding: Set by libavcodec.
1940 enum AVAudioServiceType audio_service_type;
1943 * desired sample format
1944 * - encoding: Not used.
1945 * - decoding: Set by user.
1946 * Decoder will decode to this format if it can.
1948 enum AVSampleFormat request_sample_fmt;
1950 #if FF_API_GET_BUFFER
1952 * Called at the beginning of each frame to get a buffer for it.
1954 * The function will set AVFrame.data[], AVFrame.linesize[].
1955 * AVFrame.extended_data[] must also be set, but it should be the same as
1956 * AVFrame.data[] except for planar audio with more channels than can fit
1957 * in AVFrame.data[]. In that case, AVFrame.data[] shall still contain as
1958 * many data pointers as it can hold.
1960 * if CODEC_CAP_DR1 is not set then get_buffer() must call
1961 * avcodec_default_get_buffer() instead of providing buffers allocated by
1964 * AVFrame.data[] should be 32- or 16-byte-aligned unless the CPU doesn't
1965 * need it. avcodec_default_get_buffer() aligns the output buffer properly,
1966 * but if get_buffer() is overridden then alignment considerations should
1967 * be taken into account.
1969 * @see avcodec_default_get_buffer()
1973 * If pic.reference is set then the frame will be read later by libavcodec.
1974 * avcodec_align_dimensions2() should be used to find the required width and
1975 * height, as they normally need to be rounded up to the next multiple of 16.
1977 * If frame multithreading is used and thread_safe_callbacks is set,
1978 * it may be called from a different thread, but not from more than one at
1979 * once. Does not need to be reentrant.
1981 * @see release_buffer(), reget_buffer()
1982 * @see avcodec_align_dimensions2()
1986 * Decoders request a buffer of a particular size by setting
1987 * AVFrame.nb_samples prior to calling get_buffer(). The decoder may,
1988 * however, utilize only part of the buffer by setting AVFrame.nb_samples
1989 * to a smaller value in the output frame.
1991 * Decoders cannot use the buffer after returning from
1992 * avcodec_decode_audio4(), so they will not call release_buffer(), as it
1993 * is assumed to be released immediately upon return. In some rare cases,
1994 * a decoder may need to call get_buffer() more than once in a single
1995 * call to avcodec_decode_audio4(). In that case, when get_buffer() is
1996 * called again after it has already been called once, the previously
1997 * acquired buffer is assumed to be released at that time and may not be
1998 * reused by the decoder.
2000 * As a convenience, av_samples_get_buffer_size() and
2001 * av_samples_fill_arrays() in libavutil may be used by custom get_buffer()
2002 * functions to find the required data size and to fill data pointers and
2003 * linesize. In AVFrame.linesize, only linesize[0] may be set for audio
2004 * since all planes must be the same size.
2006 * @see av_samples_get_buffer_size(), av_samples_fill_arrays()
2008 * - encoding: unused
2009 * - decoding: Set by libavcodec, user can override.
2011 * @deprecated use get_buffer2()
2013 attribute_deprecated
2014 int (*get_buffer)(struct AVCodecContext *c, AVFrame *pic);
2017 * Called to release buffers which were allocated with get_buffer.
2018 * A released buffer can be reused in get_buffer().
2019 * pic.data[*] must be set to NULL.
2020 * May be called from a different thread if frame multithreading is used,
2021 * but not by more than one thread at once, so does not need to be reentrant.
2022 * - encoding: unused
2023 * - decoding: Set by libavcodec, user can override.
2025 * @deprecated custom freeing callbacks should be set from get_buffer2()
2027 attribute_deprecated
2028 void (*release_buffer)(struct AVCodecContext *c, AVFrame *pic);
2031 * Called at the beginning of a frame to get cr buffer for it.
2032 * Buffer type (size, hints) must be the same. libavcodec won't check it.
2033 * libavcodec will pass previous buffer in pic, function should return
2034 * same buffer or new buffer with old frame "painted" into it.
2035 * If pic.data[0] == NULL must behave like get_buffer().
2036 * if CODEC_CAP_DR1 is not set then reget_buffer() must call
2037 * avcodec_default_reget_buffer() instead of providing buffers allocated by
2039 * - encoding: unused
2040 * - decoding: Set by libavcodec, user can override.
2042 attribute_deprecated
2043 int (*reget_buffer)(struct AVCodecContext *c, AVFrame *pic);
2047 * This callback is called at the beginning of each frame to get data
2048 * buffer(s) for it. There may be one contiguous buffer for all the data or
2049 * there may be a buffer per each data plane or anything in between. What
2050 * this means is, you may set however many entries in buf[] you feel necessary.
2051 * Each buffer must be reference-counted using the AVBuffer API (see description
2054 * The following fields will be set in the frame before this callback is
2057 * - width, height (video only)
2058 * - sample_rate, channel_layout, nb_samples (audio only)
2059 * Their values may differ from the corresponding values in
2060 * AVCodecContext. This callback must use the frame values, not the codec
2061 * context values, to calculate the required buffer size.
2063 * This callback must fill the following fields in the frame:
2067 * * if the data is planar audio with more than 8 channels, then this
2068 * callback must allocate and fill extended_data to contain all pointers
2069 * to all data planes. data[] must hold as many pointers as it can.
2070 * extended_data must be allocated with av_malloc() and will be freed in
2072 * * otherwise exended_data must point to data
2073 * - buf[] must contain one or more pointers to AVBufferRef structures. Each of
2074 * the frame's data and extended_data pointers must be contained in these. That
2075 * is, one AVBufferRef for each allocated chunk of memory, not necessarily one
2076 * AVBufferRef per data[] entry. See: av_buffer_create(), av_buffer_alloc(),
2077 * and av_buffer_ref().
2078 * - extended_buf and nb_extended_buf must be allocated with av_malloc() by
2079 * this callback and filled with the extra buffers if there are more
2080 * buffers than buf[] can hold. extended_buf will be freed in
2083 * If CODEC_CAP_DR1 is not set then get_buffer2() must call
2084 * avcodec_default_get_buffer2() instead of providing buffers allocated by
2087 * Each data plane must be aligned to the maximum required by the target
2090 * @see avcodec_default_get_buffer2()
2094 * If AV_GET_BUFFER_FLAG_REF is set in flags then the frame may be reused
2095 * (read and/or written to if it is writable) later by libavcodec.
2097 * If CODEC_FLAG_EMU_EDGE is not set in s->flags, the buffer must contain an
2098 * edge of the size returned by avcodec_get_edge_width() on all sides.
2100 * avcodec_align_dimensions2() should be used to find the required width and
2101 * height, as they normally need to be rounded up to the next multiple of 16.
2103 * If frame multithreading is used and thread_safe_callbacks is set,
2104 * this callback may be called from a different thread, but not from more
2105 * than one at once. Does not need to be reentrant.
2107 * @see avcodec_align_dimensions2()
2111 * Decoders request a buffer of a particular size by setting
2112 * AVFrame.nb_samples prior to calling get_buffer2(). The decoder may,
2113 * however, utilize only part of the buffer by setting AVFrame.nb_samples
2114 * to a smaller value in the output frame.
2116 * As a convenience, av_samples_get_buffer_size() and
2117 * av_samples_fill_arrays() in libavutil may be used by custom get_buffer2()
2118 * functions to find the required data size and to fill data pointers and
2119 * linesize. In AVFrame.linesize, only linesize[0] may be set for audio
2120 * since all planes must be the same size.
2122 * @see av_samples_get_buffer_size(), av_samples_fill_arrays()
2124 * - encoding: unused
2125 * - decoding: Set by libavcodec, user can override.
2127 int (*get_buffer2)(struct AVCodecContext *s, AVFrame *frame, int flags);
2130 * If non-zero, the decoded audio and video frames returned from
2131 * avcodec_decode_video2() and avcodec_decode_audio4() are reference-counted
2132 * and are valid indefinitely. The caller must free them with
2133 * av_frame_unref() when they are not needed anymore.
2134 * Otherwise, the decoded frames must not be freed by the caller and are
2135 * only valid until the next decode call.
2137 * - encoding: unused
2138 * - decoding: set by the caller before avcodec_open2().
2140 int refcounted_frames;
2142 /* - encoding parameters */
2143 float qcompress; ///< amount of qscale change between easy & hard scenes (0.0-1.0)
2144 float qblur; ///< amount of qscale smoothing over time (0.0-1.0)
2148 * - encoding: Set by user.
2149 * - decoding: unused
2155 * - encoding: Set by user.
2156 * - decoding: unused
2161 * maximum quantizer difference between frames
2162 * - encoding: Set by user.
2163 * - decoding: unused
2168 * ratecontrol qmin qmax limiting method
2169 * 0-> clipping, 1-> use a nice continuous function to limit qscale wthin qmin/qmax.
2170 * - encoding: Set by user.
2171 * - decoding: unused
2179 * decoder bitstream buffer size
2180 * - encoding: Set by user.
2181 * - decoding: unused
2186 * ratecontrol override, see RcOverride
2187 * - encoding: Allocated/set/freed by user.
2188 * - decoding: unused
2190 int rc_override_count;
2191 RcOverride *rc_override;
2194 * rate control equation
2195 * - encoding: Set by user
2196 * - decoding: unused
2202 * - encoding: Set by user.
2203 * - decoding: unused
2209 * - encoding: Set by user.
2210 * - decoding: unused
2214 float rc_buffer_aggressivity;
2217 * initial complexity for pass1 ratecontrol
2218 * - encoding: Set by user.
2219 * - decoding: unused
2221 float rc_initial_cplx;
2224 * Ratecontrol attempt to use, at maximum, <value> of what can be used without an underflow.
2225 * - encoding: Set by user.
2226 * - decoding: unused.
2228 float rc_max_available_vbv_use;
2231 * Ratecontrol attempt to use, at least, <value> times the amount needed to prevent a vbv overflow.
2232 * - encoding: Set by user.
2233 * - decoding: unused.
2235 float rc_min_vbv_overflow_use;
2238 * Number of bits which should be loaded into the rc buffer before decoding starts.
2239 * - encoding: Set by user.
2240 * - decoding: unused
2242 int rc_initial_buffer_occupancy;
2244 #define FF_CODER_TYPE_VLC 0
2245 #define FF_CODER_TYPE_AC 1
2246 #define FF_CODER_TYPE_RAW 2
2247 #define FF_CODER_TYPE_RLE 3
2248 #define FF_CODER_TYPE_DEFLATE 4
2251 * - encoding: Set by user.
2252 * - decoding: unused
2258 * - encoding: Set by user.
2259 * - decoding: unused
2264 * minimum Lagrange multipler
2265 * - encoding: Set by user.
2266 * - decoding: unused
2271 * maximum Lagrange multipler
2272 * - encoding: Set by user.
2273 * - decoding: unused
2278 * frame skip threshold
2279 * - encoding: Set by user.
2280 * - decoding: unused
2282 int frame_skip_threshold;
2286 * - encoding: Set by user.
2287 * - decoding: unused
2289 int frame_skip_factor;
2292 * frame skip exponent
2293 * - encoding: Set by user.
2294 * - decoding: unused
2299 * frame skip comparison function
2300 * - encoding: Set by user.
2301 * - decoding: unused
2306 * trellis RD quantization
2307 * - encoding: Set by user.
2308 * - decoding: unused
2313 * - encoding: Set by user.
2314 * - decoding: unused
2316 int min_prediction_order;
2319 * - encoding: Set by user.
2320 * - decoding: unused
2322 int max_prediction_order;
2325 * GOP timecode frame start number
2326 * - encoding: Set by user, in non drop frame format
2327 * - decoding: Set by libavcodec (timecode in the 25 bits format, -1 if unset)
2329 int64_t timecode_frame_start;
2331 /* The RTP callback: This function is called */
2332 /* every time the encoder has a packet to send. */
2333 /* It depends on the encoder if the data starts */
2334 /* with a Start Code (it should). H.263 does. */
2335 /* mb_nb contains the number of macroblocks */
2336 /* encoded in the RTP payload. */
2337 void (*rtp_callback)(struct AVCodecContext *avctx, void *data, int size, int mb_nb);
2339 int rtp_payload_size; /* The size of the RTP payload: the coder will */
2340 /* do its best to deliver a chunk with size */
2341 /* below rtp_payload_size, the chunk will start */
2342 /* with a start code on some codecs like H.263. */
2343 /* This doesn't take account of any particular */
2344 /* headers inside the transmitted RTP payload. */
2346 /* statistics, used for 2-pass encoding */
2357 * number of bits used for the previously encoded frame
2358 * - encoding: Set by libavcodec.
2359 * - decoding: unused
2364 * pass1 encoding statistics output buffer
2365 * - encoding: Set by libavcodec.
2366 * - decoding: unused
2371 * pass2 encoding statistics input buffer
2372 * Concatenated stuff from stats_out of pass1 should be placed here.
2373 * - encoding: Allocated/set/freed by user.
2374 * - decoding: unused
2379 * Work around bugs in encoders which sometimes cannot be detected automatically.
2380 * - encoding: Set by user
2381 * - decoding: Set by user
2383 int workaround_bugs;
2384 #define FF_BUG_AUTODETECT 1 ///< autodetection
2385 #define FF_BUG_OLD_MSMPEG4 2
2386 #define FF_BUG_XVID_ILACE 4
2387 #define FF_BUG_UMP4 8
2388 #define FF_BUG_NO_PADDING 16
2389 #define FF_BUG_AMV 32
2390 #define FF_BUG_AC_VLC 0 ///< Will be removed, libavcodec can now handle these non-compliant files by default.
2391 #define FF_BUG_QPEL_CHROMA 64
2392 #define FF_BUG_STD_QPEL 128
2393 #define FF_BUG_QPEL_CHROMA2 256
2394 #define FF_BUG_DIRECT_BLOCKSIZE 512
2395 #define FF_BUG_EDGE 1024
2396 #define FF_BUG_HPEL_CHROMA 2048
2397 #define FF_BUG_DC_CLIP 4096
2398 #define FF_BUG_MS 8192 ///< Work around various bugs in Microsoft's broken decoders.
2399 #define FF_BUG_TRUNCATED 16384
2402 * strictly follow the standard (MPEG4, ...).
2403 * - encoding: Set by user.
2404 * - decoding: Set by user.
2405 * Setting this to STRICT or higher means the encoder and decoder will
2406 * generally do stupid things, whereas setting it to unofficial or lower
2407 * will mean the encoder might produce output that is not supported by all
2408 * spec-compliant decoders. Decoders don't differentiate between normal,
2409 * unofficial and experimental (that is, they always try to decode things
2410 * when they can) unless they are explicitly asked to behave stupidly
2411 * (=strictly conform to the specs)
2413 int strict_std_compliance;
2414 #define FF_COMPLIANCE_VERY_STRICT 2 ///< Strictly conform to an older more strict version of the spec or reference software.
2415 #define FF_COMPLIANCE_STRICT 1 ///< Strictly conform to all the things in the spec no matter what consequences.
2416 #define FF_COMPLIANCE_NORMAL 0
2417 #define FF_COMPLIANCE_UNOFFICIAL -1 ///< Allow unofficial extensions
2418 #define FF_COMPLIANCE_EXPERIMENTAL -2 ///< Allow nonstandardized experimental things.
2421 * error concealment flags
2422 * - encoding: unused
2423 * - decoding: Set by user.
2425 int error_concealment;
2426 #define FF_EC_GUESS_MVS 1
2427 #define FF_EC_DEBLOCK 2
2431 * - encoding: Set by user.
2432 * - decoding: Set by user.
2435 #define FF_DEBUG_PICT_INFO 1
2436 #define FF_DEBUG_RC 2
2437 #define FF_DEBUG_BITSTREAM 4
2438 #define FF_DEBUG_MB_TYPE 8
2439 #define FF_DEBUG_QP 16
2440 #define FF_DEBUG_MV 32
2441 #define FF_DEBUG_DCT_COEFF 0x00000040
2442 #define FF_DEBUG_SKIP 0x00000080
2443 #define FF_DEBUG_STARTCODE 0x00000100
2444 #define FF_DEBUG_PTS 0x00000200
2445 #define FF_DEBUG_ER 0x00000400
2446 #define FF_DEBUG_MMCO 0x00000800
2447 #define FF_DEBUG_BUGS 0x00001000
2448 #define FF_DEBUG_VIS_QP 0x00002000
2449 #define FF_DEBUG_VIS_MB_TYPE 0x00004000
2450 #define FF_DEBUG_BUFFERS 0x00008000
2451 #define FF_DEBUG_THREADS 0x00010000
2455 * - encoding: Set by user.
2456 * - decoding: Set by user.
2459 #define FF_DEBUG_VIS_MV_P_FOR 0x00000001 //visualize forward predicted MVs of P frames
2460 #define FF_DEBUG_VIS_MV_B_FOR 0x00000002 //visualize forward predicted MVs of B frames
2461 #define FF_DEBUG_VIS_MV_B_BACK 0x00000004 //visualize backward predicted MVs of B frames
2464 * Error recognition; may misdetect some more or less valid parts as errors.
2465 * - encoding: unused
2466 * - decoding: Set by user.
2468 int err_recognition;
2469 #define AV_EF_CRCCHECK (1<<0)
2470 #define AV_EF_BITSTREAM (1<<1)
2471 #define AV_EF_BUFFER (1<<2)
2472 #define AV_EF_EXPLODE (1<<3)
2474 #define AV_EF_CAREFUL (1<<16)
2475 #define AV_EF_COMPLIANT (1<<17)
2476 #define AV_EF_AGGRESSIVE (1<<18)
2480 * opaque 64bit number (generally a PTS) that will be reordered and
2481 * output in AVFrame.reordered_opaque
2482 * @deprecated in favor of pkt_pts
2483 * - encoding: unused
2484 * - decoding: Set by user.
2486 int64_t reordered_opaque;
2489 * Hardware accelerator in use
2490 * - encoding: unused.
2491 * - decoding: Set by libavcodec
2493 struct AVHWAccel *hwaccel;
2496 * Hardware accelerator context.
2497 * For some hardware accelerators, a global context needs to be
2498 * provided by the user. In that case, this holds display-dependent
2499 * data FFmpeg cannot instantiate itself. Please refer to the
2500 * FFmpeg HW accelerator documentation to know how to fill this
2501 * is. e.g. for VA API, this is a struct vaapi_context.
2502 * - encoding: unused
2503 * - decoding: Set by user
2505 void *hwaccel_context;
2509 * - encoding: Set by libavcodec if flags&CODEC_FLAG_PSNR.
2510 * - decoding: unused
2512 uint64_t error[AV_NUM_DATA_POINTERS];
2515 * DCT algorithm, see FF_DCT_* below
2516 * - encoding: Set by user.
2517 * - decoding: unused
2520 #define FF_DCT_AUTO 0
2521 #define FF_DCT_FASTINT 1
2522 #define FF_DCT_INT 2
2523 #define FF_DCT_MMX 3
2524 #define FF_DCT_ALTIVEC 5
2525 #define FF_DCT_FAAN 6
2528 * IDCT algorithm, see FF_IDCT_* below.
2529 * - encoding: Set by user.
2530 * - decoding: Set by user.
2533 #define FF_IDCT_AUTO 0
2534 #define FF_IDCT_INT 1
2535 #define FF_IDCT_SIMPLE 2
2536 #define FF_IDCT_SIMPLEMMX 3
2537 #define FF_IDCT_ARM 7
2538 #define FF_IDCT_ALTIVEC 8
2539 #define FF_IDCT_SH4 9
2540 #define FF_IDCT_SIMPLEARM 10
2541 #define FF_IDCT_IPP 13
2542 #define FF_IDCT_XVIDMMX 14
2543 #define FF_IDCT_SIMPLEARMV5TE 16
2544 #define FF_IDCT_SIMPLEARMV6 17
2545 #define FF_IDCT_SIMPLEVIS 18
2546 #define FF_IDCT_FAAN 20
2547 #define FF_IDCT_SIMPLENEON 22
2548 #define FF_IDCT_SIMPLEALPHA 23
2551 * bits per sample/pixel from the demuxer (needed for huffyuv).
2552 * - encoding: Set by libavcodec.
2553 * - decoding: Set by user.
2555 int bits_per_coded_sample;
2558 * Bits per sample/pixel of internal libavcodec pixel/sample format.
2559 * - encoding: set by user.
2560 * - decoding: set by libavcodec.
2562 int bits_per_raw_sample;
2566 * low resolution decoding, 1-> 1/2 size, 2->1/4 size
2567 * - encoding: unused
2568 * - decoding: Set by user.
2569 * Code outside libavcodec should access this field using:
2570 * av_codec_{get,set}_lowres(avctx)
2576 * the picture in the bitstream
2577 * - encoding: Set by libavcodec.
2578 * - decoding: Set by libavcodec.
2580 AVFrame *coded_frame;
2584 * is used to decide how many independent tasks should be passed to execute()
2585 * - encoding: Set by user.
2586 * - decoding: Set by user.
2591 * Which multithreading methods to use.
2592 * Use of FF_THREAD_FRAME will increase decoding delay by one frame per thread,
2593 * so clients which cannot provide future frames should not use it.
2595 * - encoding: Set by user, otherwise the default is used.
2596 * - decoding: Set by user, otherwise the default is used.
2599 #define FF_THREAD_FRAME 1 ///< Decode more than one frame at once
2600 #define FF_THREAD_SLICE 2 ///< Decode more than one part of a single frame at once
2603 * Which multithreading methods are in use by the codec.
2604 * - encoding: Set by libavcodec.
2605 * - decoding: Set by libavcodec.
2607 int active_thread_type;
2610 * Set by the client if its custom get_buffer() callback can be called
2611 * synchronously from another thread, which allows faster multithreaded decoding.
2612 * draw_horiz_band() will be called from other threads regardless of this setting.
2613 * Ignored if the default get_buffer() is used.
2614 * - encoding: Set by user.
2615 * - decoding: Set by user.
2617 int thread_safe_callbacks;
2620 * The codec may call this to execute several independent things.
2621 * It will return only after finishing all tasks.
2622 * The user may replace this with some multithreaded implementation,
2623 * the default implementation will execute the parts serially.
2624 * @param count the number of things to execute
2625 * - encoding: Set by libavcodec, user can override.
2626 * - decoding: Set by libavcodec, user can override.
2628 int (*execute)(struct AVCodecContext *c, int (*func)(struct AVCodecContext *c2, void *arg), void *arg2, int *ret, int count, int size);
2631 * The codec may call this to execute several independent things.
2632 * It will return only after finishing all tasks.
2633 * The user may replace this with some multithreaded implementation,
2634 * the default implementation will execute the parts serially.
2635 * Also see avcodec_thread_init and e.g. the --enable-pthread configure option.
2636 * @param c context passed also to func
2637 * @param count the number of things to execute
2638 * @param arg2 argument passed unchanged to func
2639 * @param ret return values of executed functions, must have space for "count" values. May be NULL.
2640 * @param func function that will be called count times, with jobnr from 0 to count-1.
2641 * threadnr will be in the range 0 to c->thread_count-1 < MAX_THREADS and so that no
2642 * two instances of func executing at the same time will have the same threadnr.
2643 * @return always 0 currently, but code should handle a future improvement where when any call to func
2644 * returns < 0 no further calls to func may be done and < 0 is returned.
2645 * - encoding: Set by libavcodec, user can override.
2646 * - decoding: Set by libavcodec, user can override.
2648 int (*execute2)(struct AVCodecContext *c, int (*func)(struct AVCodecContext *c2, void *arg, int jobnr, int threadnr), void *arg2, int *ret, int count);
2652 * Can be used by execute() to store some per AVCodecContext stuff.
2653 * - encoding: set by execute()
2654 * - decoding: set by execute()
2656 void *thread_opaque;
2659 * noise vs. sse weight for the nsse comparsion function
2660 * - encoding: Set by user.
2661 * - decoding: unused
2667 * - encoding: Set by user.
2668 * - decoding: Set by libavcodec.
2671 #define FF_PROFILE_UNKNOWN -99
2672 #define FF_PROFILE_RESERVED -100
2674 #define FF_PROFILE_AAC_MAIN 0
2675 #define FF_PROFILE_AAC_LOW 1
2676 #define FF_PROFILE_AAC_SSR 2
2677 #define FF_PROFILE_AAC_LTP 3
2678 #define FF_PROFILE_AAC_HE 4
2679 #define FF_PROFILE_AAC_HE_V2 28
2680 #define FF_PROFILE_AAC_LD 22
2681 #define FF_PROFILE_AAC_ELD 38
2683 #define FF_PROFILE_DTS 20
2684 #define FF_PROFILE_DTS_ES 30
2685 #define FF_PROFILE_DTS_96_24 40
2686 #define FF_PROFILE_DTS_HD_HRA 50
2687 #define FF_PROFILE_DTS_HD_MA 60
2689 #define FF_PROFILE_MPEG2_422 0
2690 #define FF_PROFILE_MPEG2_HIGH 1
2691 #define FF_PROFILE_MPEG2_SS 2
2692 #define FF_PROFILE_MPEG2_SNR_SCALABLE 3
2693 #define FF_PROFILE_MPEG2_MAIN 4
2694 #define FF_PROFILE_MPEG2_SIMPLE 5
2696 #define FF_PROFILE_H264_CONSTRAINED (1<<9) // 8+1; constraint_set1_flag
2697 #define FF_PROFILE_H264_INTRA (1<<11) // 8+3; constraint_set3_flag
2699 #define FF_PROFILE_H264_BASELINE 66
2700 #define FF_PROFILE_H264_CONSTRAINED_BASELINE (66|FF_PROFILE_H264_CONSTRAINED)
2701 #define FF_PROFILE_H264_MAIN 77
2702 #define FF_PROFILE_H264_EXTENDED 88
2703 #define FF_PROFILE_H264_HIGH 100
2704 #define FF_PROFILE_H264_HIGH_10 110
2705 #define FF_PROFILE_H264_HIGH_10_INTRA (110|FF_PROFILE_H264_INTRA)
2706 #define FF_PROFILE_H264_HIGH_422 122
2707 #define FF_PROFILE_H264_HIGH_422_INTRA (122|FF_PROFILE_H264_INTRA)
2708 #define FF_PROFILE_H264_HIGH_444 144
2709 #define FF_PROFILE_H264_HIGH_444_PREDICTIVE 244
2710 #define FF_PROFILE_H264_HIGH_444_INTRA (244|FF_PROFILE_H264_INTRA)
2711 #define FF_PROFILE_H264_CAVLC_444 44
2713 #define FF_PROFILE_VC1_SIMPLE 0
2714 #define FF_PROFILE_VC1_MAIN 1
2715 #define FF_PROFILE_VC1_COMPLEX 2
2716 #define FF_PROFILE_VC1_ADVANCED 3
2718 #define FF_PROFILE_MPEG4_SIMPLE 0
2719 #define FF_PROFILE_MPEG4_SIMPLE_SCALABLE 1
2720 #define FF_PROFILE_MPEG4_CORE 2
2721 #define FF_PROFILE_MPEG4_MAIN 3
2722 #define FF_PROFILE_MPEG4_N_BIT 4
2723 #define FF_PROFILE_MPEG4_SCALABLE_TEXTURE 5
2724 #define FF_PROFILE_MPEG4_SIMPLE_FACE_ANIMATION 6
2725 #define FF_PROFILE_MPEG4_BASIC_ANIMATED_TEXTURE 7
2726 #define FF_PROFILE_MPEG4_HYBRID 8
2727 #define FF_PROFILE_MPEG4_ADVANCED_REAL_TIME 9
2728 #define FF_PROFILE_MPEG4_CORE_SCALABLE 10
2729 #define FF_PROFILE_MPEG4_ADVANCED_CODING 11
2730 #define FF_PROFILE_MPEG4_ADVANCED_CORE 12
2731 #define FF_PROFILE_MPEG4_ADVANCED_SCALABLE_TEXTURE 13
2732 #define FF_PROFILE_MPEG4_SIMPLE_STUDIO 14
2733 #define FF_PROFILE_MPEG4_ADVANCED_SIMPLE 15
2735 #define FF_PROFILE_JPEG2000_CSTREAM_RESTRICTION_0 0
2736 #define FF_PROFILE_JPEG2000_CSTREAM_RESTRICTION_1 1
2737 #define FF_PROFILE_JPEG2000_CSTREAM_NO_RESTRICTION 2
2738 #define FF_PROFILE_JPEG2000_DCINEMA_2K 3
2739 #define FF_PROFILE_JPEG2000_DCINEMA_4K 4
2743 * - encoding: Set by user.
2744 * - decoding: Set by libavcodec.
2747 #define FF_LEVEL_UNKNOWN -99
2750 * Skip loop filtering for selected frames.
2751 * - encoding: unused
2752 * - decoding: Set by user.
2754 enum AVDiscard skip_loop_filter;
2757 * Skip IDCT/dequantization for selected frames.
2758 * - encoding: unused
2759 * - decoding: Set by user.
2761 enum AVDiscard skip_idct;
2764 * Skip decoding for selected frames.
2765 * - encoding: unused
2766 * - decoding: Set by user.
2768 enum AVDiscard skip_frame;
2771 * Header containing style information for text subtitles.
2772 * For SUBTITLE_ASS subtitle type, it should contain the whole ASS
2773 * [Script Info] and [V4+ Styles] section, plus the [Events] line and
2774 * the Format line following. It shouldn't include any Dialogue line.
2775 * - encoding: Set/allocated/freed by user (before avcodec_open2())
2776 * - decoding: Set/allocated/freed by libavcodec (by avcodec_open2())
2778 uint8_t *subtitle_header;
2779 int subtitle_header_size;
2782 * Simulates errors in the bitstream to test error concealment.
2783 * - encoding: Set by user.
2784 * - decoding: unused
2789 * Current packet as passed into the decoder, to avoid having
2790 * to pass the packet into every function. Currently only valid
2791 * inside lavc and get/release_buffer callbacks.
2792 * - decoding: set by avcodec_decode_*, read by get_buffer() for setting pkt_pts
2793 * - encoding: unused
2798 * VBV delay coded in the last frame (in periods of a 27 MHz clock).
2799 * Used for compliant TS muxing.
2800 * - encoding: Set by libavcodec.
2801 * - decoding: unused.
2806 * Timebase in which pkt_dts/pts and AVPacket.dts/pts are.
2807 * Code outside libavcodec should access this field using:
2808 * av_codec_{get,set}_pkt_timebase(avctx)
2809 * - encoding unused.
2810 * - decodimg set by user
2812 AVRational pkt_timebase;
2816 * Code outside libavcodec should access this field using:
2817 * av_codec_{get,set}_codec_descriptor(avctx)
2818 * - encoding: unused.
2819 * - decoding: set by libavcodec.
2821 const AVCodecDescriptor *codec_descriptor;
2825 * low resolution decoding, 1-> 1/2 size, 2->1/4 size
2826 * - encoding: unused
2827 * - decoding: Set by user.
2828 * Code outside libavcodec should access this field using:
2829 * av_codec_{get,set}_lowres(avctx)
2835 * Current statistics for PTS correction.
2836 * - decoding: maintained and used by libavcodec, not intended to be used by user apps
2837 * - encoding: unused
2839 int64_t pts_correction_num_faulty_pts; /// Number of incorrect PTS values so far
2840 int64_t pts_correction_num_faulty_dts; /// Number of incorrect DTS values so far
2841 int64_t pts_correction_last_pts; /// PTS of the last frame
2842 int64_t pts_correction_last_dts; /// DTS of the last frame
2845 * Character encoding of the input subtitles file.
2846 * - decoding: set by user
2847 * - encoding: unused
2852 * Subtitles character encoding mode. Formats or codecs might be adjusting
2853 * this setting (if they are doing the conversion themselves for instance).
2854 * - decoding: set by libavcodec
2855 * - encoding: unused
2857 int sub_charenc_mode;
2858 #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)
2859 #define FF_SUB_CHARENC_MODE_AUTOMATIC 0 ///< libavcodec will select the mode itself
2860 #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
2864 AVRational av_codec_get_pkt_timebase (const AVCodecContext *avctx);
2865 void av_codec_set_pkt_timebase (AVCodecContext *avctx, AVRational val);
2867 const AVCodecDescriptor *av_codec_get_codec_descriptor(const AVCodecContext *avctx);
2868 void av_codec_set_codec_descriptor(AVCodecContext *avctx, const AVCodecDescriptor *desc);
2870 int av_codec_get_lowres(const AVCodecContext *avctx);
2871 void av_codec_set_lowres(AVCodecContext *avctx, int val);
2876 typedef struct AVProfile {
2878 const char *name; ///< short name for the profile
2881 typedef struct AVCodecDefault AVCodecDefault;
2888 typedef struct AVCodec {
2890 * Name of the codec implementation.
2891 * The name is globally unique among encoders and among decoders (but an
2892 * encoder and a decoder can share the same name).
2893 * This is the primary way to find a codec from the user perspective.
2897 * Descriptive name for the codec, meant to be more human readable than name.
2898 * You should use the NULL_IF_CONFIG_SMALL() macro to define it.
2900 const char *long_name;
2901 enum AVMediaType type;
2904 * Codec capabilities.
2908 const AVRational *supported_framerates; ///< array of supported framerates, or NULL if any, array is terminated by {0,0}
2909 const enum AVPixelFormat *pix_fmts; ///< array of supported pixel formats, or NULL if unknown, array is terminated by -1
2910 const int *supported_samplerates; ///< array of supported audio samplerates, or NULL if unknown, array is terminated by 0
2911 const enum AVSampleFormat *sample_fmts; ///< array of supported sample formats, or NULL if unknown, array is terminated by -1
2912 const uint64_t *channel_layouts; ///< array of support channel layouts, or NULL if unknown. array is terminated by 0
2913 uint8_t max_lowres; ///< maximum value for lowres supported by the decoder
2914 const AVClass *priv_class; ///< AVClass for the private context
2915 const AVProfile *profiles; ///< array of recognized profiles, or NULL if unknown, array is terminated by {FF_PROFILE_UNKNOWN}
2917 /*****************************************************************
2918 * No fields below this line are part of the public API. They
2919 * may not be used outside of libavcodec and can be changed and
2921 * New public fields should be added right above.
2922 *****************************************************************
2925 struct AVCodec *next;
2927 * @name Frame-level threading support functions
2931 * If defined, called on thread contexts when they are created.
2932 * If the codec allocates writable tables in init(), re-allocate them here.
2933 * priv_data will be set to a copy of the original.
2935 int (*init_thread_copy)(AVCodecContext *);
2937 * Copy necessary context variables from a previous thread context to the current one.
2938 * If not defined, the next thread will start automatically; otherwise, the codec
2939 * must call ff_thread_finish_setup().
2941 * dst and src will (rarely) point to the same context, in which case memcpy should be skipped.
2943 int (*update_thread_context)(AVCodecContext *dst, const AVCodecContext *src);
2947 * Private codec-specific defaults.
2949 const AVCodecDefault *defaults;
2952 * Initialize codec static data, called from avcodec_register().
2954 void (*init_static_data)(struct AVCodec *codec);
2956 int (*init)(AVCodecContext *);
2957 int (*encode_sub)(AVCodecContext *, uint8_t *buf, int buf_size,
2958 const struct AVSubtitle *sub);
2960 * Encode data to an AVPacket.
2962 * @param avctx codec context
2963 * @param avpkt output AVPacket (may contain a user-provided buffer)
2964 * @param[in] frame AVFrame containing the raw data to be encoded
2965 * @param[out] got_packet_ptr encoder sets to 0 or 1 to indicate that a
2966 * non-empty packet was returned in avpkt.
2967 * @return 0 on success, negative error code on failure
2969 int (*encode2)(AVCodecContext *avctx, AVPacket *avpkt, const AVFrame *frame,
2970 int *got_packet_ptr);
2971 int (*decode)(AVCodecContext *, void *outdata, int *outdata_size, AVPacket *avpkt);
2972 int (*close)(AVCodecContext *);
2975 * Will be called when seeking
2977 void (*flush)(AVCodecContext *);
2983 typedef struct AVHWAccel {
2985 * Name of the hardware accelerated codec.
2986 * The name is globally unique among encoders and among decoders (but an
2987 * encoder and a decoder can share the same name).
2992 * Type of codec implemented by the hardware accelerator.
2994 * See AVMEDIA_TYPE_xxx
2996 enum AVMediaType type;
2999 * Codec implemented by the hardware accelerator.
3001 * See AV_CODEC_ID_xxx
3006 * Supported pixel format.
3008 * Only hardware accelerated formats are supported here.
3010 enum AVPixelFormat pix_fmt;
3013 * Hardware accelerated codec capabilities.
3014 * see FF_HWACCEL_CODEC_CAP_*
3018 struct AVHWAccel *next;
3021 * Called at the beginning of each frame or field picture.
3023 * Meaningful frame information (codec specific) is guaranteed to
3024 * be parsed at this point. This function is mandatory.
3026 * Note that buf can be NULL along with buf_size set to 0.
3027 * Otherwise, this means the whole frame is available at this point.
3029 * @param avctx the codec context
3030 * @param buf the frame data buffer base
3031 * @param buf_size the size of the frame in bytes
3032 * @return zero if successful, a negative value otherwise
3034 int (*start_frame)(AVCodecContext *avctx, const uint8_t *buf, uint32_t buf_size);
3037 * Callback for each slice.
3039 * Meaningful slice information (codec specific) is guaranteed to
3040 * be parsed at this point. This function is mandatory.
3042 * @param avctx the codec context
3043 * @param buf the slice data buffer base
3044 * @param buf_size the size of the slice in bytes
3045 * @return zero if successful, a negative value otherwise
3047 int (*decode_slice)(AVCodecContext *avctx, const uint8_t *buf, uint32_t buf_size);
3050 * Called at the end of each frame or field picture.
3052 * The whole picture is parsed at this point and can now be sent
3053 * to the hardware accelerator. This function is mandatory.
3055 * @param avctx the codec context
3056 * @return zero if successful, a negative value otherwise
3058 int (*end_frame)(AVCodecContext *avctx);
3061 * Size of HW accelerator private data.
3063 * Private data is allocated with av_mallocz() before
3064 * AVCodecContext.get_buffer() and deallocated after
3065 * AVCodecContext.release_buffer().
3071 * @defgroup lavc_picture AVPicture
3073 * Functions for working with AVPicture
3078 * four components are given, that's all.
3079 * the last component is alpha
3081 typedef struct AVPicture {
3082 uint8_t *data[AV_NUM_DATA_POINTERS];
3083 int linesize[AV_NUM_DATA_POINTERS]; ///< number of bytes per line
3090 enum AVSubtitleType {
3093 SUBTITLE_BITMAP, ///< A bitmap, pict will be set
3096 * Plain text, the text field must be set by the decoder and is
3097 * authoritative. ass and pict fields may contain approximations.
3102 * Formatted text, the ass field must be set by the decoder and is
3103 * authoritative. pict and text fields may contain approximations.
3108 #define AV_SUBTITLE_FLAG_FORCED 0x00000001
3110 typedef struct AVSubtitleRect {
3111 int x; ///< top left corner of pict, undefined when pict is not set
3112 int y; ///< top left corner of pict, undefined when pict is not set
3113 int w; ///< width of pict, undefined when pict is not set
3114 int h; ///< height of pict, undefined when pict is not set
3115 int nb_colors; ///< number of colors in pict, undefined when pict is not set
3118 * data+linesize for the bitmap of this subtitle.
3119 * can be set for text/ass as well once they where rendered
3122 enum AVSubtitleType type;
3124 char *text; ///< 0 terminated plain UTF-8 text
3127 * 0 terminated ASS/SSA compatible event line.
3128 * The presentation of this is unaffected by the other values in this
3136 typedef struct AVSubtitle {
3137 uint16_t format; /* 0 = graphics */
3138 uint32_t start_display_time; /* relative to packet pts, in ms */
3139 uint32_t end_display_time; /* relative to packet pts, in ms */
3141 AVSubtitleRect **rects;
3142 int64_t pts; ///< Same as packet pts, in AV_TIME_BASE
3146 * If c is NULL, returns the first registered codec,
3147 * if c is non-NULL, returns the next registered codec after c,
3148 * or NULL if c is the last one.
3150 AVCodec *av_codec_next(const AVCodec *c);
3153 * Return the LIBAVCODEC_VERSION_INT constant.
3155 unsigned avcodec_version(void);
3158 * Return the libavcodec build-time configuration.
3160 const char *avcodec_configuration(void);
3163 * Return the libavcodec license.
3165 const char *avcodec_license(void);
3168 * Register the codec codec and initialize libavcodec.
3170 * @warning either this function or avcodec_register_all() must be called
3171 * before any other libavcodec functions.
3173 * @see avcodec_register_all()
3175 void avcodec_register(AVCodec *codec);
3178 * Register all the codecs, parsers and bitstream filters which were enabled at
3179 * configuration time. If you do not call this function you can select exactly
3180 * which formats you want to support, by using the individual registration
3183 * @see avcodec_register
3184 * @see av_register_codec_parser
3185 * @see av_register_bitstream_filter
3187 void avcodec_register_all(void);
3190 #if FF_API_ALLOC_CONTEXT
3192 * Allocate an AVCodecContext and set its fields to default values. The
3193 * resulting struct can be deallocated by simply calling av_free().
3195 * @return An AVCodecContext filled with default values or NULL on failure.
3196 * @see avcodec_get_context_defaults
3198 * @deprecated use avcodec_alloc_context3()
3200 attribute_deprecated
3201 AVCodecContext *avcodec_alloc_context(void);
3203 /** THIS FUNCTION IS NOT YET PART OF THE PUBLIC API!
3204 * we WILL change its arguments and name a few times! */
3205 attribute_deprecated
3206 AVCodecContext *avcodec_alloc_context2(enum AVMediaType);
3209 * Set the fields of the given AVCodecContext to default values.
3211 * @param s The AVCodecContext of which the fields should be set to default values.
3212 * @deprecated use avcodec_get_context_defaults3
3214 attribute_deprecated
3215 void avcodec_get_context_defaults(AVCodecContext *s);
3217 /** THIS FUNCTION IS NOT YET PART OF THE PUBLIC API!
3218 * we WILL change its arguments and name a few times! */
3219 attribute_deprecated
3220 void avcodec_get_context_defaults2(AVCodecContext *s, enum AVMediaType);
3224 * Allocate an AVCodecContext and set its fields to default values. The
3225 * resulting struct can be deallocated by calling avcodec_close() on it followed
3228 * @param codec if non-NULL, allocate private data and initialize defaults
3229 * for the given codec. It is illegal to then call avcodec_open2()
3230 * with a different codec.
3231 * If NULL, then the codec-specific defaults won't be initialized,
3232 * which may result in suboptimal default settings (this is
3233 * important mainly for encoders, e.g. libx264).
3235 * @return An AVCodecContext filled with default values or NULL on failure.
3236 * @see avcodec_get_context_defaults
3238 AVCodecContext *avcodec_alloc_context3(const AVCodec *codec);
3241 * Set the fields of the given AVCodecContext to default values corresponding
3242 * to the given codec (defaults may be codec-dependent).
3244 * Do not call this function if a non-NULL codec has been passed
3245 * to avcodec_alloc_context3() that allocated this AVCodecContext.
3246 * If codec is non-NULL, it is illegal to call avcodec_open2() with a
3247 * different codec on this AVCodecContext.
3249 int avcodec_get_context_defaults3(AVCodecContext *s, const AVCodec *codec);
3252 * Get the AVClass for AVCodecContext. It can be used in combination with
3253 * AV_OPT_SEARCH_FAKE_OBJ for examining options.
3255 * @see av_opt_find().
3257 const AVClass *avcodec_get_class(void);
3260 * Get the AVClass for AVFrame. It can be used in combination with
3261 * AV_OPT_SEARCH_FAKE_OBJ for examining options.
3263 * @see av_opt_find().
3265 const AVClass *avcodec_get_frame_class(void);
3268 * Get the AVClass for AVSubtitleRect. It can be used in combination with
3269 * AV_OPT_SEARCH_FAKE_OBJ for examining options.
3271 * @see av_opt_find().
3273 const AVClass *avcodec_get_subtitle_rect_class(void);
3276 * Copy the settings of the source AVCodecContext into the destination
3277 * AVCodecContext. The resulting destination codec context will be
3278 * unopened, i.e. you are required to call avcodec_open2() before you
3279 * can use this AVCodecContext to decode/encode video/audio data.
3281 * @param dest target codec context, should be initialized with
3282 * avcodec_alloc_context3(), but otherwise uninitialized
3283 * @param src source codec context
3284 * @return AVERROR() on error (e.g. memory allocation error), 0 on success
3286 int avcodec_copy_context(AVCodecContext *dest, const AVCodecContext *src);
3289 * Allocate an AVFrame and set its fields to default values. The resulting
3290 * struct must be freed using avcodec_free_frame().
3292 * @return An AVFrame filled with default values or NULL on failure.
3293 * @see avcodec_get_frame_defaults
3295 AVFrame *avcodec_alloc_frame(void);
3298 * Set the fields of the given AVFrame to default values.
3300 * @param frame The AVFrame of which the fields should be set to default values.
3302 void avcodec_get_frame_defaults(AVFrame *frame);
3305 * Free the frame and any dynamically allocated objects in it,
3306 * e.g. extended_data.
3308 * @param frame frame to be freed. The pointer will be set to NULL.
3310 * @warning this function does NOT free the data buffers themselves
3311 * (it does not know how, since they might have been allocated with
3312 * a custom get_buffer()).
3314 void avcodec_free_frame(AVFrame **frame);
3316 #if FF_API_AVCODEC_OPEN
3318 * Initialize the AVCodecContext to use the given AVCodec. Prior to using this
3319 * function the context has to be allocated.
3321 * The functions avcodec_find_decoder_by_name(), avcodec_find_encoder_by_name(),
3322 * avcodec_find_decoder() and avcodec_find_encoder() provide an easy way for
3323 * retrieving a codec.
3325 * @warning This function is not thread safe!
3328 * avcodec_register_all();
3329 * codec = avcodec_find_decoder(AV_CODEC_ID_H264);
3333 * context = avcodec_alloc_context3(codec);
3335 * if (avcodec_open(context, codec) < 0)
3339 * @param avctx The context which will be set up to use the given codec.
3340 * @param codec The codec to use within the context.
3341 * @return zero on success, a negative value on error
3342 * @see avcodec_alloc_context3, avcodec_find_decoder, avcodec_find_encoder, avcodec_close
3344 * @deprecated use avcodec_open2
3346 attribute_deprecated
3347 int avcodec_open(AVCodecContext *avctx, AVCodec *codec);
3351 * Initialize the AVCodecContext to use the given AVCodec. Prior to using this
3352 * function the context has to be allocated with avcodec_alloc_context3().
3354 * The functions avcodec_find_decoder_by_name(), avcodec_find_encoder_by_name(),
3355 * avcodec_find_decoder() and avcodec_find_encoder() provide an easy way for
3356 * retrieving a codec.
3358 * @warning This function is not thread safe!
3361 * avcodec_register_all();
3362 * av_dict_set(&opts, "b", "2.5M", 0);
3363 * codec = avcodec_find_decoder(AV_CODEC_ID_H264);
3367 * context = avcodec_alloc_context3(codec);
3369 * if (avcodec_open2(context, codec, opts) < 0)
3373 * @param avctx The context to initialize.
3374 * @param codec The codec to open this context for. If a non-NULL codec has been
3375 * previously passed to avcodec_alloc_context3() or
3376 * avcodec_get_context_defaults3() for this context, then this
3377 * parameter MUST be either NULL or equal to the previously passed
3379 * @param options A dictionary filled with AVCodecContext and codec-private options.
3380 * On return this object will be filled with options that were not found.
3382 * @return zero on success, a negative value on error
3383 * @see avcodec_alloc_context3(), avcodec_find_decoder(), avcodec_find_encoder(),
3384 * av_dict_set(), av_opt_find().
3386 int avcodec_open2(AVCodecContext *avctx, const AVCodec *codec, AVDictionary **options);
3389 * Close a given AVCodecContext and free all the data associated with it
3390 * (but not the AVCodecContext itself).
3392 * Calling this function on an AVCodecContext that hasn't been opened will free
3393 * the codec-specific data allocated in avcodec_alloc_context3() /
3394 * avcodec_get_context_defaults3() with a non-NULL codec. Subsequent calls will
3397 int avcodec_close(AVCodecContext *avctx);
3400 * Free all allocated data in the given subtitle struct.
3402 * @param sub AVSubtitle to free.
3404 void avsubtitle_free(AVSubtitle *sub);
3411 * @addtogroup lavc_packet
3415 #if FF_API_DESTRUCT_PACKET
3417 * Default packet destructor.
3418 * @deprecated use the AVBuffer API instead
3420 attribute_deprecated
3421 void av_destruct_packet(AVPacket *pkt);
3425 * Initialize optional fields of a packet with default values.
3427 * Note, this does not touch the data and size members, which have to be
3428 * initialized separately.
3432 void av_init_packet(AVPacket *pkt);
3435 * Allocate the payload of a packet and initialize its fields with
3439 * @param size wanted payload size
3440 * @return 0 if OK, AVERROR_xxx otherwise
3442 int av_new_packet(AVPacket *pkt, int size);
3445 * Reduce packet size, correctly zeroing padding
3448 * @param size new size
3450 void av_shrink_packet(AVPacket *pkt, int size);
3453 * Increase packet size, correctly zeroing padding
3456 * @param grow_by number of bytes by which to increase the size of the packet
3458 int av_grow_packet(AVPacket *pkt, int grow_by);
3461 * Initialize a reference-counted packet from av_malloc()ed data.
3463 * @param pkt packet to be initialized. This function will set the data, size,
3464 * buf and destruct fields, all others are left untouched.
3465 * @param data Data allocated by av_malloc() to be used as packet data. If this
3466 * function returns successfully, the data is owned by the underlying AVBuffer.
3467 * The caller may not access the data through other means.
3468 * @param size size of data in bytes, without the padding. I.e. the full buffer
3469 * size is assumed to be size + FF_INPUT_BUFFER_PADDING_SIZE.
3471 * @return 0 on success, a negative AVERROR on error
3473 int av_packet_from_data(AVPacket *pkt, uint8_t *data, int size);
3476 * @warning This is a hack - the packet memory allocation stuff is broken. The
3477 * packet is allocated if it was not really allocated.
3479 int av_dup_packet(AVPacket *pkt);
3482 * Copy packet, including contents
3484 * @return 0 on success, negative AVERROR on fail
3486 int av_copy_packet(AVPacket *dst, AVPacket *src);
3489 * Copy packet side data
3491 * @return 0 on success, negative AVERROR on fail
3493 int av_copy_packet_side_data(AVPacket *dst, AVPacket *src);
3498 * @param pkt packet to free
3500 void av_free_packet(AVPacket *pkt);
3503 * Allocate new information of a packet.
3506 * @param type side information type
3507 * @param size side information size
3508 * @return pointer to fresh allocated data or NULL otherwise
3510 uint8_t* av_packet_new_side_data(AVPacket *pkt, enum AVPacketSideDataType type,
3514 * Shrink the already allocated side data buffer
3517 * @param type side information type
3518 * @param size new side information size
3519 * @return 0 on success, < 0 on failure
3521 int av_packet_shrink_side_data(AVPacket *pkt, enum AVPacketSideDataType type,
3525 * Get side information from packet.
3528 * @param type desired side information type
3529 * @param size pointer for side information size to store (optional)
3530 * @return pointer to data if present or NULL otherwise
3532 uint8_t* av_packet_get_side_data(AVPacket *pkt, enum AVPacketSideDataType type,
3535 int av_packet_merge_side_data(AVPacket *pkt);
3537 int av_packet_split_side_data(AVPacket *pkt);
3545 * @addtogroup lavc_decoding
3550 * Find a registered decoder with a matching codec ID.
3552 * @param id AVCodecID of the requested decoder
3553 * @return A decoder if one was found, NULL otherwise.
3555 AVCodec *avcodec_find_decoder(enum AVCodecID id);
3558 * Find a registered decoder with the specified name.
3560 * @param name name of the requested decoder
3561 * @return A decoder if one was found, NULL otherwise.
3563 AVCodec *avcodec_find_decoder_by_name(const char *name);
3565 #if FF_API_GET_BUFFER
3566 attribute_deprecated int avcodec_default_get_buffer(AVCodecContext *s, AVFrame *pic);
3567 attribute_deprecated void avcodec_default_release_buffer(AVCodecContext *s, AVFrame *pic);
3568 attribute_deprecated int avcodec_default_reget_buffer(AVCodecContext *s, AVFrame *pic);
3572 * The default callback for AVCodecContext.get_buffer2(). It is made public so
3573 * it can be called by custom get_buffer2() implementations for decoders without
3574 * CODEC_CAP_DR1 set.
3576 int avcodec_default_get_buffer2(AVCodecContext *s, AVFrame *frame, int flags);
3579 * Return the amount of padding in pixels which the get_buffer callback must
3580 * provide around the edge of the image for codecs which do not have the
3581 * CODEC_FLAG_EMU_EDGE flag.
3583 * @return Required padding in pixels.
3585 unsigned avcodec_get_edge_width(void);
3588 * Modify width and height values so that they will result in a memory
3589 * buffer that is acceptable for the codec if you do not use any horizontal
3592 * May only be used if a codec with CODEC_CAP_DR1 has been opened.
3593 * If CODEC_FLAG_EMU_EDGE is not set, the dimensions must have been increased
3594 * according to avcodec_get_edge_width() before.
3596 void avcodec_align_dimensions(AVCodecContext *s, int *width, int *height);
3599 * Modify width and height values so that they will result in a memory
3600 * buffer that is acceptable for the codec if you also ensure that all
3601 * line sizes are a multiple of the respective linesize_align[i].
3603 * May only be used if a codec with CODEC_CAP_DR1 has been opened.
3604 * If CODEC_FLAG_EMU_EDGE is not set, the dimensions must have been increased
3605 * according to avcodec_get_edge_width() before.
3607 void avcodec_align_dimensions2(AVCodecContext *s, int *width, int *height,
3608 int linesize_align[AV_NUM_DATA_POINTERS]);
3610 #if FF_API_OLD_DECODE_AUDIO
3612 * Wrapper function which calls avcodec_decode_audio4.
3614 * @deprecated Use avcodec_decode_audio4 instead.
3616 * Decode the audio frame of size avpkt->size from avpkt->data into samples.
3617 * Some decoders may support multiple frames in a single AVPacket, such
3618 * decoders would then just decode the first frame. In this case,
3619 * avcodec_decode_audio3 has to be called again with an AVPacket that contains
3620 * the remaining data in order to decode the second frame etc.
3622 * could be outputted, frame_size_ptr is zero. Otherwise, it is the
3623 * decompressed frame size in bytes.
3625 * @warning You must set frame_size_ptr to the allocated size of the
3626 * output buffer before calling avcodec_decode_audio3().
3628 * @warning The input buffer must be FF_INPUT_BUFFER_PADDING_SIZE larger than
3629 * the actual read bytes because some optimized bitstream readers read 32 or 64
3630 * bits at once and could read over the end.
3632 * @warning The end of the input buffer avpkt->data should be set to 0 to ensure that
3633 * no overreading happens for damaged MPEG streams.
3635 * @warning You must not provide a custom get_buffer() when using
3636 * avcodec_decode_audio3(). Doing so will override it with
3637 * avcodec_default_get_buffer. Use avcodec_decode_audio4() instead,
3638 * which does allow the application to provide a custom get_buffer().
3640 * @note You might have to align the input buffer avpkt->data and output buffer
3641 * samples. The alignment requirements depend on the CPU: On some CPUs it isn't
3642 * necessary at all, on others it won't work at all if not aligned and on others
3643 * it will work but it will have an impact on performance.
3645 * In practice, avpkt->data should have 4 byte alignment at minimum and
3646 * samples should be 16 byte aligned unless the CPU doesn't need it
3647 * (AltiVec and SSE do).
3649 * @note Codecs which have the CODEC_CAP_DELAY capability set have a delay
3650 * between input and output, these need to be fed with avpkt->data=NULL,
3651 * avpkt->size=0 at the end to return the remaining frames.
3653 * @param avctx the codec context
3654 * @param[out] samples the output buffer, sample type in avctx->sample_fmt
3655 * If the sample format is planar, each channel plane will
3656 * be the same size, with no padding between channels.
3657 * @param[in,out] frame_size_ptr the output buffer size in bytes
3658 * @param[in] avpkt The input AVPacket containing the input buffer.
3659 * You can create such packet with av_init_packet() and by then setting
3660 * data and size, some decoders might in addition need other fields.
3661 * All decoders are designed to use the least fields possible though.
3662 * @return On error a negative value is returned, otherwise the number of bytes
3663 * used or zero if no frame data was decompressed (used) from the input AVPacket.
3665 attribute_deprecated int avcodec_decode_audio3(AVCodecContext *avctx, int16_t *samples,
3666 int *frame_size_ptr,
3671 * Decode the audio frame of size avpkt->size from avpkt->data into frame.
3673 * Some decoders may support multiple frames in a single AVPacket. Such
3674 * decoders would then just decode the first frame. In this case,
3675 * avcodec_decode_audio4 has to be called again with an AVPacket containing
3676 * the remaining data in order to decode the second frame, etc...
3677 * Even if no frames are returned, the packet needs to be fed to the decoder
3678 * with remaining data until it is completely consumed or an error occurs.
3680 * @warning The input buffer, avpkt->data must be FF_INPUT_BUFFER_PADDING_SIZE
3681 * larger than the actual read bytes because some optimized bitstream
3682 * readers read 32 or 64 bits at once and could read over the end.
3684 * @note You might have to align the input buffer. The alignment requirements
3685 * depend on the CPU and the decoder.
3687 * @param avctx the codec context
3688 * @param[out] frame The AVFrame in which to store decoded audio samples.
3689 * The decoder will allocate a buffer for the decoded frame by
3690 * calling the AVCodecContext.get_buffer2() callback.
3691 * When AVCodecContext.refcounted_frames is set to 1, the frame is
3692 * reference counted and the returned reference belongs to the
3693 * caller. The caller must release the frame using av_frame_unref()
3694 * when the frame is no longer needed. The caller may safely write
3695 * to the frame if av_frame_is_writable() returns 1.
3696 * When AVCodecContext.refcounted_frames is set to 0, the returned
3697 * reference belongs to the decoder and is valid only until the
3698 * next call to this function or until closing the decoder.
3699 * The caller may not write to it.
3700 * @param[out] got_frame_ptr Zero if no frame could be decoded, otherwise it is
3702 * @param[in] avpkt The input AVPacket containing the input buffer.
3703 * At least avpkt->data and avpkt->size should be set. Some
3704 * decoders might also require additional fields to be set.
3705 * @return A negative error code is returned if an error occurred during
3706 * decoding, otherwise the number of bytes consumed from the input
3707 * AVPacket is returned.
3709 int avcodec_decode_audio4(AVCodecContext *avctx, AVFrame *frame,
3710 int *got_frame_ptr, const AVPacket *avpkt);
3713 * Decode the video frame of size avpkt->size from avpkt->data into picture.
3714 * Some decoders may support multiple frames in a single AVPacket, such
3715 * decoders would then just decode the first frame.
3717 * @warning The input buffer must be FF_INPUT_BUFFER_PADDING_SIZE larger than
3718 * the actual read bytes because some optimized bitstream readers read 32 or 64
3719 * bits at once and could read over the end.
3721 * @warning The end of the input buffer buf should be set to 0 to ensure that
3722 * no overreading happens for damaged MPEG streams.
3724 * @note You might have to align the input buffer avpkt->data.
3725 * The alignment requirements depend on the CPU: on some CPUs it isn't
3726 * necessary at all, on others it won't work at all if not aligned and on others
3727 * it will work but it will have an impact on performance.
3729 * In practice, avpkt->data should have 4 byte alignment at minimum.
3731 * @note Codecs which have the CODEC_CAP_DELAY capability set have a delay
3732 * between input and output, these need to be fed with avpkt->data=NULL,
3733 * avpkt->size=0 at the end to return the remaining frames.
3735 * @param avctx the codec context
3736 * @param[out] picture The AVFrame in which the decoded video frame will be stored.
3737 * Use av_frame_alloc() to get an AVFrame. The codec will
3738 * allocate memory for the actual bitmap by calling the
3739 * AVCodecContext.get_buffer2() callback.
3740 * When AVCodecContext.refcounted_frames is set to 1, the frame is
3741 * reference counted and the returned reference belongs to the
3742 * caller. The caller must release the frame using av_frame_unref()
3743 * when the frame is no longer needed. The caller may safely write
3744 * to the frame if av_frame_is_writable() returns 1.
3745 * When AVCodecContext.refcounted_frames is set to 0, the returned
3746 * reference belongs to the decoder and is valid only until the
3747 * next call to this function or until closing the decoder. The
3748 * caller may not write to it.
3750 * @param[in] avpkt The input AVpacket containing the input buffer.
3751 * You can create such packet with av_init_packet() and by then setting
3752 * data and size, some decoders might in addition need other fields like
3753 * flags&AV_PKT_FLAG_KEY. All decoders are designed to use the least
3755 * @param[in,out] got_picture_ptr Zero if no frame could be decompressed, otherwise, it is nonzero.
3756 * @return On error a negative value is returned, otherwise the number of bytes
3757 * used or zero if no frame could be decompressed.
3759 int avcodec_decode_video2(AVCodecContext *avctx, AVFrame *picture,
3760 int *got_picture_ptr,
3761 const AVPacket *avpkt);
3764 * Decode a subtitle message.
3765 * Return a negative value on error, otherwise return the number of bytes used.
3766 * If no subtitle could be decompressed, got_sub_ptr is zero.
3767 * Otherwise, the subtitle is stored in *sub.
3768 * Note that CODEC_CAP_DR1 is not available for subtitle codecs. This is for
3769 * simplicity, because the performance difference is expect to be negligible
3770 * and reusing a get_buffer written for video codecs would probably perform badly
3771 * due to a potentially very different allocation pattern.
3773 * @param avctx the codec context
3774 * @param[out] sub The AVSubtitle in which the decoded subtitle will be stored, must be
3775 freed with avsubtitle_free if *got_sub_ptr is set.
3776 * @param[in,out] got_sub_ptr Zero if no subtitle could be decompressed, otherwise, it is nonzero.
3777 * @param[in] avpkt The input AVPacket containing the input buffer.
3779 int avcodec_decode_subtitle2(AVCodecContext *avctx, AVSubtitle *sub,
3784 * @defgroup lavc_parsing Frame parsing
3788 typedef struct AVCodecParserContext {
3790 struct AVCodecParser *parser;
3791 int64_t frame_offset; /* offset of the current frame */
3792 int64_t cur_offset; /* current offset
3793 (incremented by each av_parser_parse()) */
3794 int64_t next_frame_offset; /* offset of the next frame */
3796 int pict_type; /* XXX: Put it back in AVCodecContext. */
3798 * This field is used for proper frame duration computation in lavf.
3799 * It signals, how much longer the frame duration of the current frame
3800 * is compared to normal frame duration.
3802 * frame_duration = (1 + repeat_pict) * time_base
3804 * It is used by codecs like H.264 to display telecined material.
3806 int repeat_pict; /* XXX: Put it back in AVCodecContext. */
3807 int64_t pts; /* pts of the current frame */
3808 int64_t dts; /* dts of the current frame */
3813 int fetch_timestamp;
3815 #define AV_PARSER_PTS_NB 4
3816 int cur_frame_start_index;
3817 int64_t cur_frame_offset[AV_PARSER_PTS_NB];
3818 int64_t cur_frame_pts[AV_PARSER_PTS_NB];
3819 int64_t cur_frame_dts[AV_PARSER_PTS_NB];
3822 #define PARSER_FLAG_COMPLETE_FRAMES 0x0001
3823 #define PARSER_FLAG_ONCE 0x0002
3824 /// Set if the parser has a valid file offset
3825 #define PARSER_FLAG_FETCHED_OFFSET 0x0004
3826 #define PARSER_FLAG_USE_CODEC_TS 0x1000
3828 int64_t offset; ///< byte offset from starting packet start
3829 int64_t cur_frame_end[AV_PARSER_PTS_NB];
3832 * Set by parser to 1 for key frames and 0 for non-key frames.
3833 * It is initialized to -1, so if the parser doesn't set this flag,
3834 * old-style fallback using AV_PICTURE_TYPE_I picture type as key frames
3840 * Time difference in stream time base units from the pts of this
3841 * packet to the point at which the output from the decoder has converged
3842 * independent from the availability of previous frames. That is, the
3843 * frames are virtually identical no matter if decoding started from
3844 * the very first frame or from this keyframe.
3845 * Is AV_NOPTS_VALUE if unknown.
3846 * This field is not the display duration of the current frame.
3847 * This field has no meaning if the packet does not have AV_PKT_FLAG_KEY
3850 * The purpose of this field is to allow seeking in streams that have no
3851 * keyframes in the conventional sense. It corresponds to the
3852 * recovery point SEI in H.264 and match_time_delta in NUT. It is also
3853 * essential for some types of subtitle streams to ensure that all
3854 * subtitles are correctly displayed after seeking.
3856 int64_t convergence_duration;
3858 // Timestamp generation support:
3860 * Synchronization point for start of timestamp generation.
3862 * Set to >0 for sync point, 0 for no sync point and <0 for undefined
3865 * For example, this corresponds to presence of H.264 buffering period
3871 * Offset of the current timestamp against last timestamp sync point in
3872 * units of AVCodecContext.time_base.
3874 * Set to INT_MIN when dts_sync_point unused. Otherwise, it must
3875 * contain a valid timestamp offset.
3877 * Note that the timestamp of sync point has usually a nonzero
3878 * dts_ref_dts_delta, which refers to the previous sync point. Offset of
3879 * the next frame after timestamp sync point will be usually 1.
3881 * For example, this corresponds to H.264 cpb_removal_delay.
3883 int dts_ref_dts_delta;
3886 * Presentation delay of current frame in units of AVCodecContext.time_base.
3888 * Set to INT_MIN when dts_sync_point unused. Otherwise, it must
3889 * contain valid non-negative timestamp delta (presentation time of a frame
3890 * must not lie in the past).
3892 * This delay represents the difference between decoding and presentation
3893 * time of the frame.
3895 * For example, this corresponds to H.264 dpb_output_delay.
3900 * Position of the packet in file.
3902 * Analogous to cur_frame_pts/dts
3904 int64_t cur_frame_pos[AV_PARSER_PTS_NB];
3907 * Byte position of currently parsed frame in stream.
3912 * Previous frame byte position.
3917 * Duration of the current frame.
3918 * For audio, this is in units of 1 / AVCodecContext.sample_rate.
3919 * For all other types, this is in units of AVCodecContext.time_base.
3923 enum AVFieldOrder field_order;
3924 } AVCodecParserContext;
3926 typedef struct AVCodecParser {
3927 int codec_ids[5]; /* several codec IDs are permitted */
3929 int (*parser_init)(AVCodecParserContext *s);
3930 int (*parser_parse)(AVCodecParserContext *s,
3931 AVCodecContext *avctx,
3932 const uint8_t **poutbuf, int *poutbuf_size,
3933 const uint8_t *buf, int buf_size);
3934 void (*parser_close)(AVCodecParserContext *s);
3935 int (*split)(AVCodecContext *avctx, const uint8_t *buf, int buf_size);
3936 struct AVCodecParser *next;
3939 AVCodecParser *av_parser_next(AVCodecParser *c);
3941 void av_register_codec_parser(AVCodecParser *parser);
3942 AVCodecParserContext *av_parser_init(int codec_id);
3947 * @param s parser context.
3948 * @param avctx codec context.
3949 * @param poutbuf set to pointer to parsed buffer or NULL if not yet finished.
3950 * @param poutbuf_size set to size of parsed buffer or zero if not yet finished.
3951 * @param buf input buffer.
3952 * @param buf_size input length, to signal EOF, this should be 0 (so that the last frame can be output).
3953 * @param pts input presentation timestamp.
3954 * @param dts input decoding timestamp.
3955 * @param pos input byte position in stream.
3956 * @return the number of bytes of the input bitstream used.
3961 * len = av_parser_parse2(myparser, AVCodecContext, &data, &size,
3968 * decode_frame(data, size);
3972 int av_parser_parse2(AVCodecParserContext *s,
3973 AVCodecContext *avctx,
3974 uint8_t **poutbuf, int *poutbuf_size,
3975 const uint8_t *buf, int buf_size,
3976 int64_t pts, int64_t dts,
3980 * @return 0 if the output buffer is a subset of the input, 1 if it is allocated and must be freed
3981 * @deprecated use AVBitStreamFilter
3983 int av_parser_change(AVCodecParserContext *s,
3984 AVCodecContext *avctx,
3985 uint8_t **poutbuf, int *poutbuf_size,
3986 const uint8_t *buf, int buf_size, int keyframe);
3987 void av_parser_close(AVCodecParserContext *s);
3995 * @addtogroup lavc_encoding
4000 * Find a registered encoder with a matching codec ID.
4002 * @param id AVCodecID of the requested encoder
4003 * @return An encoder if one was found, NULL otherwise.
4005 AVCodec *avcodec_find_encoder(enum AVCodecID id);
4008 * Find a registered encoder with the specified name.
4010 * @param name name of the requested encoder
4011 * @return An encoder if one was found, NULL otherwise.
4013 AVCodec *avcodec_find_encoder_by_name(const char *name);
4015 #if FF_API_OLD_ENCODE_AUDIO
4017 * Encode an audio frame from samples into buf.
4019 * @deprecated Use avcodec_encode_audio2 instead.
4021 * @note The output buffer should be at least FF_MIN_BUFFER_SIZE bytes large.
4022 * However, for codecs with avctx->frame_size equal to 0 (e.g. PCM) the user
4023 * will know how much space is needed because it depends on the value passed
4024 * in buf_size as described below. In that case a lower value can be used.
4026 * @param avctx the codec context
4027 * @param[out] buf the output buffer
4028 * @param[in] buf_size the output buffer size
4029 * @param[in] samples the input buffer containing the samples
4030 * The number of samples read from this buffer is frame_size*channels,
4031 * both of which are defined in avctx.
4032 * For codecs which have avctx->frame_size equal to 0 (e.g. PCM) the number of
4033 * samples read from samples is equal to:
4034 * buf_size * 8 / (avctx->channels * av_get_bits_per_sample(avctx->codec_id))
4035 * This also implies that av_get_bits_per_sample() must not return 0 for these
4037 * @return On error a negative value is returned, on success zero or the number
4038 * of bytes used to encode the data read from the input buffer.
4040 int attribute_deprecated avcodec_encode_audio(AVCodecContext *avctx,
4041 uint8_t *buf, int buf_size,
4042 const short *samples);
4046 * Encode a frame of audio.
4048 * Takes input samples from frame and writes the next output packet, if
4049 * available, to avpkt. The output packet does not necessarily contain data for
4050 * the most recent frame, as encoders can delay, split, and combine input frames
4051 * internally as needed.
4053 * @param avctx codec context
4054 * @param avpkt output AVPacket.
4055 * The user can supply an output buffer by setting
4056 * avpkt->data and avpkt->size prior to calling the
4057 * function, but if the size of the user-provided data is not
4058 * large enough, encoding will fail. If avpkt->data and
4059 * avpkt->size are set, avpkt->destruct must also be set. All
4060 * other AVPacket fields will be reset by the encoder using
4061 * av_init_packet(). If avpkt->data is NULL, the encoder will
4062 * allocate it. The encoder will set avpkt->size to the size
4063 * of the output packet.
4065 * If this function fails or produces no output, avpkt will be
4066 * freed using av_free_packet() (i.e. avpkt->destruct will be
4067 * called to free the user supplied buffer).
4068 * @param[in] frame AVFrame containing the raw audio data to be encoded.
4069 * May be NULL when flushing an encoder that has the
4070 * CODEC_CAP_DELAY capability set.
4071 * If CODEC_CAP_VARIABLE_FRAME_SIZE is set, then each frame
4072 * can have any number of samples.
4073 * If it is not set, frame->nb_samples must be equal to
4074 * avctx->frame_size for all frames except the last.
4075 * The final frame may be smaller than avctx->frame_size.
4076 * @param[out] got_packet_ptr This field is set to 1 by libavcodec if the
4077 * output packet is non-empty, and to 0 if it is
4078 * empty. If the function returns an error, the
4079 * packet can be assumed to be invalid, and the
4080 * value of got_packet_ptr is undefined and should
4082 * @return 0 on success, negative error code on failure
4084 int avcodec_encode_audio2(AVCodecContext *avctx, AVPacket *avpkt,
4085 const AVFrame *frame, int *got_packet_ptr);
4087 #if FF_API_OLD_ENCODE_VIDEO
4089 * @deprecated use avcodec_encode_video2() instead.
4091 * Encode a video frame from pict into buf.
4092 * The input picture should be
4093 * stored using a specific format, namely avctx.pix_fmt.
4095 * @param avctx the codec context
4096 * @param[out] buf the output buffer for the bitstream of encoded frame
4097 * @param[in] buf_size the size of the output buffer in bytes
4098 * @param[in] pict the input picture to encode
4099 * @return On error a negative value is returned, on success zero or the number
4100 * of bytes used from the output buffer.
4102 attribute_deprecated
4103 int avcodec_encode_video(AVCodecContext *avctx, uint8_t *buf, int buf_size,
4104 const AVFrame *pict);
4108 * Encode a frame of video.
4110 * Takes input raw video data from frame and writes the next output packet, if
4111 * available, to avpkt. The output packet does not necessarily contain data for
4112 * the most recent frame, as encoders can delay and reorder input frames
4113 * internally as needed.
4115 * @param avctx codec context
4116 * @param avpkt output AVPacket.
4117 * The user can supply an output buffer by setting
4118 * avpkt->data and avpkt->size prior to calling the
4119 * function, but if the size of the user-provided data is not
4120 * large enough, encoding will fail. All other AVPacket fields
4121 * will be reset by the encoder using av_init_packet(). If
4122 * avpkt->data is NULL, the encoder will allocate it.
4123 * The encoder will set avpkt->size to the size of the
4124 * output packet. The returned data (if any) belongs to the
4125 * caller, he is responsible for freeing it.
4127 * If this function fails or produces no output, avpkt will be
4128 * freed using av_free_packet() (i.e. avpkt->destruct will be
4129 * called to free the user supplied buffer).
4130 * @param[in] frame AVFrame containing the raw video data to be encoded.
4131 * May be NULL when flushing an encoder that has the
4132 * CODEC_CAP_DELAY capability set.
4133 * @param[out] got_packet_ptr This field is set to 1 by libavcodec if the
4134 * output packet is non-empty, and to 0 if it is
4135 * empty. If the function returns an error, the
4136 * packet can be assumed to be invalid, and the
4137 * value of got_packet_ptr is undefined and should
4139 * @return 0 on success, negative error code on failure
4141 int avcodec_encode_video2(AVCodecContext *avctx, AVPacket *avpkt,
4142 const AVFrame *frame, int *got_packet_ptr);
4144 int avcodec_encode_subtitle(AVCodecContext *avctx, uint8_t *buf, int buf_size,
4145 const AVSubtitle *sub);
4152 #if FF_API_AVCODEC_RESAMPLE
4154 * @defgroup lavc_resample Audio resampling
4156 * @deprecated use libswresample instead
4160 struct ReSampleContext;
4161 struct AVResampleContext;
4163 typedef struct ReSampleContext ReSampleContext;
4166 * Initialize audio resampling context.
4168 * @param output_channels number of output channels
4169 * @param input_channels number of input channels
4170 * @param output_rate output sample rate
4171 * @param input_rate input sample rate
4172 * @param sample_fmt_out requested output sample format
4173 * @param sample_fmt_in input sample format
4174 * @param filter_length length of each FIR filter in the filterbank relative to the cutoff frequency
4175 * @param log2_phase_count log2 of the number of entries in the polyphase filterbank
4176 * @param linear if 1 then the used FIR filter will be linearly interpolated
4177 between the 2 closest, if 0 the closest will be used
4178 * @param cutoff cutoff frequency, 1.0 corresponds to half the output sampling rate
4179 * @return allocated ReSampleContext, NULL if error occurred
4181 attribute_deprecated
4182 ReSampleContext *av_audio_resample_init(int output_channels, int input_channels,
4183 int output_rate, int input_rate,
4184 enum AVSampleFormat sample_fmt_out,
4185 enum AVSampleFormat sample_fmt_in,
4186 int filter_length, int log2_phase_count,
4187 int linear, double cutoff);
4189 attribute_deprecated
4190 int audio_resample(ReSampleContext *s, short *output, short *input, int nb_samples);
4193 * Free resample context.
4195 * @param s a non-NULL pointer to a resample context previously
4196 * created with av_audio_resample_init()
4198 attribute_deprecated
4199 void audio_resample_close(ReSampleContext *s);
4203 * Initialize an audio resampler.
4204 * Note, if either rate is not an integer then simply scale both rates up so they are.
4205 * @param filter_length length of each FIR filter in the filterbank relative to the cutoff freq
4206 * @param log2_phase_count log2 of the number of entries in the polyphase filterbank
4207 * @param linear If 1 then the used FIR filter will be linearly interpolated
4208 between the 2 closest, if 0 the closest will be used
4209 * @param cutoff cutoff frequency, 1.0 corresponds to half the output sampling rate
4211 attribute_deprecated
4212 struct AVResampleContext *av_resample_init(int out_rate, int in_rate, int filter_length, int log2_phase_count, int linear, double cutoff);
4215 * Resample an array of samples using a previously configured context.
4216 * @param src an array of unconsumed samples
4217 * @param consumed the number of samples of src which have been consumed are returned here
4218 * @param src_size the number of unconsumed samples available
4219 * @param dst_size the amount of space in samples available in dst
4220 * @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.
4221 * @return the number of samples written in dst or -1 if an error occurred
4223 attribute_deprecated
4224 int av_resample(struct AVResampleContext *c, short *dst, short *src, int *consumed, int src_size, int dst_size, int update_ctx);
4228 * Compensate samplerate/timestamp drift. The compensation is done by changing
4229 * the resampler parameters, so no audible clicks or similar distortions occur
4230 * @param compensation_distance distance in output samples over which the compensation should be performed
4231 * @param sample_delta number of output samples which should be output less
4233 * example: av_resample_compensate(c, 10, 500)
4234 * here instead of 510 samples only 500 samples would be output
4236 * note, due to rounding the actual compensation might be slightly different,
4237 * especially if the compensation_distance is large and the in_rate used during init is small
4239 attribute_deprecated
4240 void av_resample_compensate(struct AVResampleContext *c, int sample_delta, int compensation_distance);
4241 attribute_deprecated
4242 void av_resample_close(struct AVResampleContext *c);
4250 * @addtogroup lavc_picture
4255 * Allocate memory for a picture. Call avpicture_free() to free it.
4257 * @see avpicture_fill()
4259 * @param picture the picture to be filled in
4260 * @param pix_fmt the format of the picture
4261 * @param width the width of the picture
4262 * @param height the height of the picture
4263 * @return zero if successful, a negative value if not
4265 int avpicture_alloc(AVPicture *picture, enum AVPixelFormat pix_fmt, int width, int height);
4268 * Free a picture previously allocated by avpicture_alloc().
4269 * The data buffer used by the AVPicture is freed, but the AVPicture structure
4272 * @param picture the AVPicture to be freed
4274 void avpicture_free(AVPicture *picture);
4277 * Fill in the AVPicture fields, always assume a linesize alignment of
4280 * @see av_image_fill_arrays()
4282 int avpicture_fill(AVPicture *picture, const uint8_t *ptr,
4283 enum AVPixelFormat pix_fmt, int width, int height);
4286 * Copy pixel data from an AVPicture into a buffer, always assume a
4287 * linesize alignment of 1.
4289 * @see av_image_copy_to_buffer()
4291 int avpicture_layout(const AVPicture* src, enum AVPixelFormat pix_fmt,
4292 int width, int height,
4293 unsigned char *dest, int dest_size);
4296 * Calculate the size in bytes that a picture of the given width and height
4297 * would occupy if stored in the given picture format.
4298 * Always assume a linesize alignment of 1.
4300 * @see av_image_get_buffer_size().
4302 int avpicture_get_size(enum AVPixelFormat pix_fmt, int width, int height);
4304 #if FF_API_DEINTERLACE
4306 * deinterlace - if not supported return -1
4308 * @deprecated - use yadif (in libavfilter) instead
4310 attribute_deprecated
4311 int avpicture_deinterlace(AVPicture *dst, const AVPicture *src,
4312 enum AVPixelFormat pix_fmt, int width, int height);
4315 * Copy image src to dst. Wraps av_image_copy().
4317 void av_picture_copy(AVPicture *dst, const AVPicture *src,
4318 enum AVPixelFormat pix_fmt, int width, int height);
4321 * Crop image top and left side.
4323 int av_picture_crop(AVPicture *dst, const AVPicture *src,
4324 enum AVPixelFormat pix_fmt, int top_band, int left_band);
4329 int av_picture_pad(AVPicture *dst, const AVPicture *src, int height, int width, enum AVPixelFormat pix_fmt,
4330 int padtop, int padbottom, int padleft, int padright, int *color);
4337 * @defgroup lavc_misc Utility functions
4340 * Miscellaneous utility functions related to both encoding and decoding
4346 * @defgroup lavc_misc_pixfmt Pixel formats
4348 * Functions for working with pixel formats.
4353 * Utility function to access log2_chroma_w log2_chroma_h from
4354 * the pixel format AVPixFmtDescriptor.
4356 * This function asserts that pix_fmt is valid. See av_pix_fmt_get_chroma_sub_sample
4357 * for one that returns a failure code and continues in case of invalid
4360 * @param[in] pix_fmt the pixel format
4361 * @param[out] h_shift store log2_chroma_w
4362 * @param[out] v_shift store log2_chroma_h
4364 * @see av_pix_fmt_get_chroma_sub_sample
4367 void avcodec_get_chroma_sub_sample(enum AVPixelFormat pix_fmt, int *h_shift, int *v_shift);
4370 * Return a value representing the fourCC code associated to the
4371 * pixel format pix_fmt, or 0 if no associated fourCC code can be
4374 unsigned int avcodec_pix_fmt_to_codec_tag(enum AVPixelFormat pix_fmt);
4376 #define FF_LOSS_RESOLUTION 0x0001 /**< loss due to resolution change */
4377 #define FF_LOSS_DEPTH 0x0002 /**< loss due to color depth change */
4378 #define FF_LOSS_COLORSPACE 0x0004 /**< loss due to color space conversion */
4379 #define FF_LOSS_ALPHA 0x0008 /**< loss of alpha bits */
4380 #define FF_LOSS_COLORQUANT 0x0010 /**< loss due to color quantization */
4381 #define FF_LOSS_CHROMA 0x0020 /**< loss of chroma (e.g. RGB to gray conversion) */
4384 * Compute what kind of losses will occur when converting from one specific
4385 * pixel format to another.
4386 * When converting from one pixel format to another, information loss may occur.
4387 * For example, when converting from RGB24 to GRAY, the color information will
4388 * be lost. Similarly, other losses occur when converting from some formats to
4389 * other formats. These losses can involve loss of chroma, but also loss of
4390 * resolution, loss of color depth, loss due to the color space conversion, loss
4391 * of the alpha bits or loss due to color quantization.
4392 * avcodec_get_fix_fmt_loss() informs you about the various types of losses
4393 * which will occur when converting from one pixel format to another.
4395 * @param[in] dst_pix_fmt destination pixel format
4396 * @param[in] src_pix_fmt source pixel format
4397 * @param[in] has_alpha Whether the source pixel format alpha channel is used.
4398 * @return Combination of flags informing you what kind of losses will occur
4399 * (maximum loss for an invalid dst_pix_fmt).
4401 int avcodec_get_pix_fmt_loss(enum AVPixelFormat dst_pix_fmt, enum AVPixelFormat src_pix_fmt,
4405 * Find the best pixel format to convert to given a certain source pixel
4406 * format. When converting from one pixel format to another, information loss
4407 * may occur. For example, when converting from RGB24 to GRAY, the color
4408 * information will be lost. Similarly, other losses occur when converting from
4409 * some formats to other formats. avcodec_find_best_pix_fmt_of_2() searches which of
4410 * the given pixel formats should be used to suffer the least amount of loss.
4411 * The pixel formats from which it chooses one, are determined by the
4412 * pix_fmt_list parameter.
4415 * @param[in] pix_fmt_list AV_PIX_FMT_NONE terminated array of pixel formats to choose from
4416 * @param[in] src_pix_fmt source pixel format
4417 * @param[in] has_alpha Whether the source pixel format alpha channel is used.
4418 * @param[out] loss_ptr Combination of flags informing you what kind of losses will occur.
4419 * @return The best pixel format to convert to or -1 if none was found.
4421 enum AVPixelFormat avcodec_find_best_pix_fmt_of_list(enum AVPixelFormat *pix_fmt_list,
4422 enum AVPixelFormat src_pix_fmt,
4423 int has_alpha, int *loss_ptr);
4426 * Find the best pixel format to convert to given a certain source pixel
4427 * format and a selection of two destination pixel formats. When converting from
4428 * one pixel format to another, information loss may occur. For example, when converting
4429 * from RGB24 to GRAY, the color information will be lost. Similarly, other losses occur when
4430 * converting from some formats to other formats. avcodec_find_best_pix_fmt_of_2() selects which of
4431 * the given pixel formats should be used to suffer the least amount of loss.
4433 * If one of the destination formats is AV_PIX_FMT_NONE the other pixel format (if valid) will be
4437 * src_pix_fmt = AV_PIX_FMT_YUV420P;
4438 * dst_pix_fmt1= AV_PIX_FMT_RGB24;
4439 * dst_pix_fmt2= AV_PIX_FMT_GRAY8;
4440 * dst_pix_fmt3= AV_PIX_FMT_RGB8;
4441 * loss= FF_LOSS_CHROMA; // don't care about chroma loss, so chroma loss will be ignored.
4442 * dst_pix_fmt = avcodec_find_best_pix_fmt_of_2(dst_pix_fmt1, dst_pix_fmt2, src_pix_fmt, alpha, &loss);
4443 * dst_pix_fmt = avcodec_find_best_pix_fmt_of_2(dst_pix_fmt, dst_pix_fmt3, src_pix_fmt, alpha, &loss);
4446 * @param[in] dst_pix_fmt1 One of the two destination pixel formats to choose from
4447 * @param[in] dst_pix_fmt2 The other of the two destination pixel formats to choose from
4448 * @param[in] src_pix_fmt Source pixel format
4449 * @param[in] has_alpha Whether the source pixel format alpha channel is used.
4450 * @param[in, out] loss_ptr Combination of loss flags. In: selects which of the losses to ignore, i.e.
4451 * NULL or value of zero means we care about all losses. Out: the loss
4452 * that occurs when converting from src to selected dst pixel format.
4453 * @return The best pixel format to convert to or -1 if none was found.
4455 enum AVPixelFormat avcodec_find_best_pix_fmt_of_2(enum AVPixelFormat dst_pix_fmt1, enum AVPixelFormat dst_pix_fmt2,
4456 enum AVPixelFormat src_pix_fmt, int has_alpha, int *loss_ptr);
4458 attribute_deprecated
4459 #if AV_HAVE_INCOMPATIBLE_FORK_ABI
4460 enum AVPixelFormat avcodec_find_best_pix_fmt2(enum AVPixelFormat *pix_fmt_list,
4461 enum AVPixelFormat src_pix_fmt,
4462 int has_alpha, int *loss_ptr);
4464 enum AVPixelFormat avcodec_find_best_pix_fmt2(enum AVPixelFormat dst_pix_fmt1, enum AVPixelFormat dst_pix_fmt2,
4465 enum AVPixelFormat src_pix_fmt, int has_alpha, int *loss_ptr);
4469 enum AVPixelFormat avcodec_default_get_format(struct AVCodecContext *s, const enum AVPixelFormat * fmt);
4475 void avcodec_set_dimensions(AVCodecContext *s, int width, int height);
4478 * Put a string representing the codec tag codec_tag in buf.
4480 * @param buf_size size in bytes of buf
4481 * @return the length of the string that would have been generated if
4482 * enough space had been available, excluding the trailing null
4484 size_t av_get_codec_tag_string(char *buf, size_t buf_size, unsigned int codec_tag);
4486 void avcodec_string(char *buf, int buf_size, AVCodecContext *enc, int encode);
4489 * Return a name for the specified profile, if available.
4491 * @param codec the codec that is searched for the given profile
4492 * @param profile the profile value for which a name is requested
4493 * @return A name for the profile if found, NULL otherwise.
4495 const char *av_get_profile_name(const AVCodec *codec, int profile);
4497 int avcodec_default_execute(AVCodecContext *c, int (*func)(AVCodecContext *c2, void *arg2),void *arg, int *ret, int count, int size);
4498 int avcodec_default_execute2(AVCodecContext *c, int (*func)(AVCodecContext *c2, void *arg2, int, int),void *arg, int *ret, int count);
4499 //FIXME func typedef
4502 * Fill AVFrame audio data and linesize pointers.
4504 * The buffer buf must be a preallocated buffer with a size big enough
4505 * to contain the specified samples amount. The filled AVFrame data
4506 * pointers will point to this buffer.
4508 * AVFrame extended_data channel pointers are allocated if necessary for
4511 * @param frame the AVFrame
4512 * frame->nb_samples must be set prior to calling the
4513 * function. This function fills in frame->data,
4514 * frame->extended_data, frame->linesize[0].
4515 * @param nb_channels channel count
4516 * @param sample_fmt sample format
4517 * @param buf buffer to use for frame data
4518 * @param buf_size size of buffer
4519 * @param align plane size sample alignment (0 = default)
4520 * @return >=0 on success, negative error code on failure
4521 * @todo return the size in bytes required to store the samples in
4522 * case of success, at the next libavutil bump
4524 int avcodec_fill_audio_frame(AVFrame *frame, int nb_channels,
4525 enum AVSampleFormat sample_fmt, const uint8_t *buf,
4526 int buf_size, int align);
4529 * Flush buffers, should be called when seeking or when switching to a different stream.
4531 void avcodec_flush_buffers(AVCodecContext *avctx);
4534 * Return codec bits per sample.
4536 * @param[in] codec_id the codec
4537 * @return Number of bits per sample or zero if unknown for the given codec.
4539 int av_get_bits_per_sample(enum AVCodecID codec_id);
4542 * Return the PCM codec associated with a sample format.
4543 * @param be endianness, 0 for little, 1 for big,
4544 * -1 (or anything else) for native
4545 * @return AV_CODEC_ID_PCM_* or AV_CODEC_ID_NONE
4547 enum AVCodecID av_get_pcm_codec(enum AVSampleFormat fmt, int be);
4550 * Return codec bits per sample.
4551 * Only return non-zero if the bits per sample is exactly correct, not an
4554 * @param[in] codec_id the codec
4555 * @return Number of bits per sample or zero if unknown for the given codec.
4557 int av_get_exact_bits_per_sample(enum AVCodecID codec_id);
4560 * Return audio frame duration.
4562 * @param avctx codec context
4563 * @param frame_bytes size of the frame, or 0 if unknown
4564 * @return frame duration, in samples, if known. 0 if not able to
4567 int av_get_audio_frame_duration(AVCodecContext *avctx, int frame_bytes);
4570 typedef struct AVBitStreamFilterContext {
4572 struct AVBitStreamFilter *filter;
4573 AVCodecParserContext *parser;
4574 struct AVBitStreamFilterContext *next;
4575 } AVBitStreamFilterContext;
4578 typedef struct AVBitStreamFilter {
4581 int (*filter)(AVBitStreamFilterContext *bsfc,
4582 AVCodecContext *avctx, const char *args,
4583 uint8_t **poutbuf, int *poutbuf_size,
4584 const uint8_t *buf, int buf_size, int keyframe);
4585 void (*close)(AVBitStreamFilterContext *bsfc);
4586 struct AVBitStreamFilter *next;
4587 } AVBitStreamFilter;
4589 void av_register_bitstream_filter(AVBitStreamFilter *bsf);
4590 AVBitStreamFilterContext *av_bitstream_filter_init(const char *name);
4591 int av_bitstream_filter_filter(AVBitStreamFilterContext *bsfc,
4592 AVCodecContext *avctx, const char *args,
4593 uint8_t **poutbuf, int *poutbuf_size,
4594 const uint8_t *buf, int buf_size, int keyframe);
4595 void av_bitstream_filter_close(AVBitStreamFilterContext *bsf);
4597 AVBitStreamFilter *av_bitstream_filter_next(AVBitStreamFilter *f);
4602 * Reallocate the given block if it is not large enough, otherwise do nothing.
4606 void *av_fast_realloc(void *ptr, unsigned int *size, size_t min_size);
4609 * Allocate a buffer, reusing the given one if large enough.
4611 * Contrary to av_fast_realloc the current buffer contents might not be
4612 * preserved and on error the old buffer is freed, thus no special
4613 * handling to avoid memleaks is necessary.
4615 * @param ptr pointer to pointer to already allocated buffer, overwritten with pointer to new buffer
4616 * @param size size of the buffer *ptr points to
4617 * @param min_size minimum size of *ptr buffer after returning, *ptr will be NULL and
4618 * *size 0 if an error occurred.
4620 void av_fast_malloc(void *ptr, unsigned int *size, size_t min_size);
4623 * Same behaviour av_fast_malloc but the buffer has additional
4624 * FF_INPUT_BUFFER_PADDING_SIZE at the end which will will always be 0.
4626 * In addition the whole buffer will initially and after resizes
4627 * be 0-initialized so that no uninitialized data will ever appear.
4629 void av_fast_padded_malloc(void *ptr, unsigned int *size, size_t min_size);
4632 * Same behaviour av_fast_padded_malloc except that buffer will always
4633 * be 0-initialized after call.
4635 void av_fast_padded_mallocz(void *ptr, unsigned int *size, size_t min_size);
4638 * Encode extradata length to a buffer. Used by xiph codecs.
4640 * @param s buffer to write to; must be at least (v/255+1) bytes long
4641 * @param v size of extradata in bytes
4642 * @return number of bytes written to the buffer.
4644 unsigned int av_xiphlacing(unsigned char *s, unsigned int v);
4646 #if FF_API_MISSING_SAMPLE
4648 * Log a generic warning message about a missing feature. This function is
4649 * intended to be used internally by FFmpeg (libavcodec, libavformat, etc.)
4650 * only, and would normally not be used by applications.
4651 * @param[in] avc a pointer to an arbitrary struct of which the first field is
4652 * a pointer to an AVClass struct
4653 * @param[in] feature string containing the name of the missing feature
4654 * @param[in] want_sample indicates if samples are wanted which exhibit this feature.
4655 * If want_sample is non-zero, additional verbage will be added to the log
4656 * message which tells the user how to report samples to the development
4658 * @deprecated Use avpriv_report_missing_feature() instead.
4660 attribute_deprecated
4661 void av_log_missing_feature(void *avc, const char *feature, int want_sample);
4664 * Log a generic warning message asking for a sample. This function is
4665 * intended to be used internally by FFmpeg (libavcodec, libavformat, etc.)
4666 * only, and would normally not be used by applications.
4667 * @param[in] avc a pointer to an arbitrary struct of which the first field is
4668 * a pointer to an AVClass struct
4669 * @param[in] msg string containing an optional message, or NULL if no message
4670 * @deprecated Use avpriv_request_sample() instead.
4672 attribute_deprecated
4673 void av_log_ask_for_sample(void *avc, const char *msg, ...) av_printf_format(2, 3);
4674 #endif /* FF_API_MISSING_SAMPLE */
4677 * Register the hardware accelerator hwaccel.
4679 void av_register_hwaccel(AVHWAccel *hwaccel);
4682 * If hwaccel is NULL, returns the first registered hardware accelerator,
4683 * if hwaccel is non-NULL, returns the next registered hardware accelerator
4684 * after hwaccel, or NULL if hwaccel is the last one.
4686 AVHWAccel *av_hwaccel_next(AVHWAccel *hwaccel);
4690 * Lock operation used by lockmgr
4693 AV_LOCK_CREATE, ///< Create a mutex
4694 AV_LOCK_OBTAIN, ///< Lock the mutex
4695 AV_LOCK_RELEASE, ///< Unlock the mutex
4696 AV_LOCK_DESTROY, ///< Free mutex resources
4700 * Register a user provided lock manager supporting the operations
4701 * specified by AVLockOp. mutex points to a (void *) where the
4702 * lockmgr should store/get a pointer to a user allocated mutex. It's
4703 * NULL upon AV_LOCK_CREATE and != NULL for all other ops.
4705 * @param cb User defined callback. Note: FFmpeg may invoke calls to this
4706 * callback during the call to av_lockmgr_register().
4707 * Thus, the application must be prepared to handle that.
4708 * If cb is set to NULL the lockmgr will be unregistered.
4709 * Also note that during unregistration the previously registered
4710 * lockmgr callback may also be invoked.
4712 int av_lockmgr_register(int (*cb)(void **mutex, enum AVLockOp op));
4715 * Get the type of the given codec.
4717 enum AVMediaType avcodec_get_type(enum AVCodecID codec_id);
4720 * Get the name of a codec.
4721 * @return a static string identifying the codec; never NULL
4723 const char *avcodec_get_name(enum AVCodecID id);
4726 * @return a positive value if s is open (i.e. avcodec_open2() was called on it
4727 * with no corresponding avcodec_close()), 0 otherwise.
4729 int avcodec_is_open(AVCodecContext *s);
4732 * @return a non-zero number if codec is an encoder, zero otherwise
4734 int av_codec_is_encoder(const AVCodec *codec);
4737 * @return a non-zero number if codec is a decoder, zero otherwise
4739 int av_codec_is_decoder(const AVCodec *codec);
4742 * @return descriptor for given codec ID or NULL if no descriptor exists.
4744 const AVCodecDescriptor *avcodec_descriptor_get(enum AVCodecID id);
4747 * Iterate over all codec descriptors known to libavcodec.
4749 * @param prev previous descriptor. NULL to get the first descriptor.
4751 * @return next descriptor or NULL after the last descriptor
4753 const AVCodecDescriptor *avcodec_descriptor_next(const AVCodecDescriptor *prev);
4756 * @return codec descriptor with the given name or NULL if no such descriptor
4759 const AVCodecDescriptor *avcodec_descriptor_get_by_name(const char *name);
4765 #endif /* AVCODEC_AVCODEC_H */