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/cpu.h"
33 #include "libavutil/channel_layout.h"
34 #include "libavutil/dict.h"
35 #include "libavutil/log.h"
36 #include "libavutil/pixfmt.h"
37 #include "libavutil/rational.h"
39 #include "libavcodec/version.h"
41 * @defgroup libavc Encoding/Decoding Library
44 * @defgroup lavc_decoding Decoding
48 * @defgroup lavc_encoding Encoding
52 * @defgroup lavc_codec Codecs
54 * @defgroup lavc_codec_native Native Codecs
57 * @defgroup lavc_codec_wrappers External library wrappers
60 * @defgroup lavc_codec_hwaccel Hardware Accelerators bridge
64 * @defgroup lavc_internal Internal
72 * @defgroup lavc_core Core functions/structures.
75 * Basic definitions, functions for querying libavcodec capabilities,
76 * allocating core structures, etc.
82 * Identify the syntax and semantics of the bitstream.
83 * The principle is roughly:
84 * Two decoders with the same ID can decode the same streams.
85 * Two encoders with the same ID can encode compatible streams.
86 * There may be slight deviations from the principle due to implementation
89 * If you add a codec ID to this list, add it so that
90 * 1. no value of a existing codec ID changes (that would break ABI),
91 * 2. Give it a value which when taken as ASCII is recognized uniquely by a human as this specific codec.
92 * This ensures that 2 forks can independently add AVCodecIDs without producing conflicts.
94 * After adding new codec IDs, do not forget to add an entry to the codec
95 * descriptor list and bump libavcodec minor version.
101 AV_CODEC_ID_MPEG1VIDEO,
102 AV_CODEC_ID_MPEG2VIDEO, ///< preferred ID for MPEG-1/2 video decoding
103 AV_CODEC_ID_MPEG2VIDEO_XVMC,
114 AV_CODEC_ID_RAWVIDEO,
115 AV_CODEC_ID_MSMPEG4V1,
116 AV_CODEC_ID_MSMPEG4V2,
117 AV_CODEC_ID_MSMPEG4V3,
140 AV_CODEC_ID_INTERPLAY_VIDEO,
147 AV_CODEC_ID_MSVIDEO1,
152 AV_CODEC_ID_TRUEMOTION1,
153 AV_CODEC_ID_VMDVIDEO,
179 AV_CODEC_ID_TRUEMOTION2,
185 AV_CODEC_ID_SMACKVIDEO,
190 AV_CODEC_ID_JPEG2000,
196 AV_CODEC_ID_DSICINVIDEO,
197 AV_CODEC_ID_TIERTEXSEQVIDEO,
205 AV_CODEC_ID_BETHSOFTVID,
217 AV_CODEC_ID_ESCAPE124,
221 AV_CODEC_ID_MOTIONPIXELS,
233 AV_CODEC_ID_FLASHSV2,
234 AV_CODEC_ID_CDGRAPHICS,
237 AV_CODEC_ID_BINKVIDEO,
238 AV_CODEC_ID_IFF_ILBM,
239 AV_CODEC_ID_IFF_BYTERUN1,
245 AV_CODEC_ID_A64_MULTI,
246 AV_CODEC_ID_A64_MULTI5,
249 AV_CODEC_ID_LAGARITH,
253 AV_CODEC_ID_WMV3IMAGE,
254 AV_CODEC_ID_VC1IMAGE,
256 AV_CODEC_ID_BMV_VIDEO,
263 AV_CODEC_ID_ZEROCODEC,
270 AV_CODEC_ID_BRENDER_PIX= MKBETAG('B','P','I','X'),
271 AV_CODEC_ID_Y41P = MKBETAG('Y','4','1','P'),
272 AV_CODEC_ID_ESCAPE130 = MKBETAG('E','1','3','0'),
273 AV_CODEC_ID_EXR = MKBETAG('0','E','X','R'),
274 AV_CODEC_ID_AVRP = MKBETAG('A','V','R','P'),
276 AV_CODEC_ID_G2M = MKBETAG( 0 ,'G','2','M'),
277 AV_CODEC_ID_AVUI = MKBETAG('A','V','U','I'),
278 AV_CODEC_ID_AYUV = MKBETAG('A','Y','U','V'),
279 AV_CODEC_ID_TARGA_Y216 = MKBETAG('T','2','1','6'),
280 AV_CODEC_ID_V308 = MKBETAG('V','3','0','8'),
281 AV_CODEC_ID_V408 = MKBETAG('V','4','0','8'),
282 AV_CODEC_ID_YUV4 = MKBETAG('Y','U','V','4'),
283 AV_CODEC_ID_SANM = MKBETAG('S','A','N','M'),
284 AV_CODEC_ID_PAF_VIDEO = MKBETAG('P','A','F','V'),
285 AV_CODEC_ID_AVRN = MKBETAG('A','V','R','n'),
286 AV_CODEC_ID_CPIA = MKBETAG('C','P','I','A'),
287 AV_CODEC_ID_XFACE = MKBETAG('X','F','A','C'),
289 /* various PCM "codecs" */
290 AV_CODEC_ID_FIRST_AUDIO = 0x10000, ///< A dummy id pointing at the start of audio codecs
291 AV_CODEC_ID_PCM_S16LE = 0x10000,
292 AV_CODEC_ID_PCM_S16BE,
293 AV_CODEC_ID_PCM_U16LE,
294 AV_CODEC_ID_PCM_U16BE,
297 AV_CODEC_ID_PCM_MULAW,
298 AV_CODEC_ID_PCM_ALAW,
299 AV_CODEC_ID_PCM_S32LE,
300 AV_CODEC_ID_PCM_S32BE,
301 AV_CODEC_ID_PCM_U32LE,
302 AV_CODEC_ID_PCM_U32BE,
303 AV_CODEC_ID_PCM_S24LE,
304 AV_CODEC_ID_PCM_S24BE,
305 AV_CODEC_ID_PCM_U24LE,
306 AV_CODEC_ID_PCM_U24BE,
307 AV_CODEC_ID_PCM_S24DAUD,
308 AV_CODEC_ID_PCM_ZORK,
309 AV_CODEC_ID_PCM_S16LE_PLANAR,
311 AV_CODEC_ID_PCM_F32BE,
312 AV_CODEC_ID_PCM_F32LE,
313 AV_CODEC_ID_PCM_F64BE,
314 AV_CODEC_ID_PCM_F64LE,
315 AV_CODEC_ID_PCM_BLURAY,
318 AV_CODEC_ID_PCM_S8_PLANAR,
319 AV_CODEC_ID_PCM_S24LE_PLANAR = MKBETAG(24,'P','S','P'),
320 AV_CODEC_ID_PCM_S32LE_PLANAR = MKBETAG(32,'P','S','P'),
321 AV_CODEC_ID_PCM_S16BE_PLANAR = MKBETAG('P','S','P',16),
323 /* various ADPCM codecs */
324 AV_CODEC_ID_ADPCM_IMA_QT = 0x11000,
325 AV_CODEC_ID_ADPCM_IMA_WAV,
326 AV_CODEC_ID_ADPCM_IMA_DK3,
327 AV_CODEC_ID_ADPCM_IMA_DK4,
328 AV_CODEC_ID_ADPCM_IMA_WS,
329 AV_CODEC_ID_ADPCM_IMA_SMJPEG,
330 AV_CODEC_ID_ADPCM_MS,
331 AV_CODEC_ID_ADPCM_4XM,
332 AV_CODEC_ID_ADPCM_XA,
333 AV_CODEC_ID_ADPCM_ADX,
334 AV_CODEC_ID_ADPCM_EA,
335 AV_CODEC_ID_ADPCM_G726,
336 AV_CODEC_ID_ADPCM_CT,
337 AV_CODEC_ID_ADPCM_SWF,
338 AV_CODEC_ID_ADPCM_YAMAHA,
339 AV_CODEC_ID_ADPCM_SBPRO_4,
340 AV_CODEC_ID_ADPCM_SBPRO_3,
341 AV_CODEC_ID_ADPCM_SBPRO_2,
342 AV_CODEC_ID_ADPCM_THP,
343 AV_CODEC_ID_ADPCM_IMA_AMV,
344 AV_CODEC_ID_ADPCM_EA_R1,
345 AV_CODEC_ID_ADPCM_EA_R3,
346 AV_CODEC_ID_ADPCM_EA_R2,
347 AV_CODEC_ID_ADPCM_IMA_EA_SEAD,
348 AV_CODEC_ID_ADPCM_IMA_EA_EACS,
349 AV_CODEC_ID_ADPCM_EA_XAS,
350 AV_CODEC_ID_ADPCM_EA_MAXIS_XA,
351 AV_CODEC_ID_ADPCM_IMA_ISS,
352 AV_CODEC_ID_ADPCM_G722,
353 AV_CODEC_ID_ADPCM_IMA_APC,
354 AV_CODEC_ID_VIMA = MKBETAG('V','I','M','A'),
355 AV_CODEC_ID_ADPCM_AFC = MKBETAG('A','F','C',' '),
356 AV_CODEC_ID_ADPCM_IMA_OKI = MKBETAG('O','K','I',' '),
359 AV_CODEC_ID_AMR_NB = 0x12000,
362 /* RealAudio codecs*/
363 AV_CODEC_ID_RA_144 = 0x13000,
366 /* various DPCM codecs */
367 AV_CODEC_ID_ROQ_DPCM = 0x14000,
368 AV_CODEC_ID_INTERPLAY_DPCM,
369 AV_CODEC_ID_XAN_DPCM,
370 AV_CODEC_ID_SOL_DPCM,
373 AV_CODEC_ID_MP2 = 0x15000,
374 AV_CODEC_ID_MP3, ///< preferred ID for decoding MPEG audio layer 1, 2 or 3
384 AV_CODEC_ID_VMDAUDIO,
390 AV_CODEC_ID_WESTWOOD_SND1,
391 AV_CODEC_ID_GSM, ///< as in Berlin toast format
394 AV_CODEC_ID_TRUESPEECH,
396 AV_CODEC_ID_SMACKAUDIO,
399 AV_CODEC_ID_DSICINAUDIO,
401 AV_CODEC_ID_MUSEPACK7,
403 AV_CODEC_ID_GSM_MS, /* as found in WAV */
407 AV_CODEC_ID_NELLYMOSER,
408 AV_CODEC_ID_MUSEPACK8,
410 AV_CODEC_ID_WMAVOICE,
412 AV_CODEC_ID_WMALOSSLESS,
421 AV_CODEC_ID_BINKAUDIO_RDFT,
422 AV_CODEC_ID_BINKAUDIO_DCT,
423 AV_CODEC_ID_AAC_LATM,
428 AV_CODEC_ID_8SVX_EXP,
429 AV_CODEC_ID_8SVX_FIB,
430 AV_CODEC_ID_BMV_AUDIO,
434 AV_CODEC_ID_OPUS_DEPRECATED,
435 AV_CODEC_ID_COMFORT_NOISE,
436 AV_CODEC_ID_TAK_DEPRECATED,
437 AV_CODEC_ID_FFWAVESYNTH = MKBETAG('F','F','W','S'),
438 AV_CODEC_ID_8SVX_RAW = MKBETAG('8','S','V','X'),
439 AV_CODEC_ID_SONIC = MKBETAG('S','O','N','C'),
440 AV_CODEC_ID_SONIC_LS = MKBETAG('S','O','N','L'),
441 AV_CODEC_ID_PAF_AUDIO = MKBETAG('P','A','F','A'),
442 AV_CODEC_ID_OPUS = MKBETAG('O','P','U','S'),
443 AV_CODEC_ID_TAK = MKBETAG('t','B','a','K'),
445 /* subtitle codecs */
446 AV_CODEC_ID_FIRST_SUBTITLE = 0x17000, ///< A dummy ID pointing at the start of subtitle codecs.
447 AV_CODEC_ID_DVD_SUBTITLE = 0x17000,
448 AV_CODEC_ID_DVB_SUBTITLE,
449 AV_CODEC_ID_TEXT, ///< raw UTF-8 text
452 AV_CODEC_ID_MOV_TEXT,
453 AV_CODEC_ID_HDMV_PGS_SUBTITLE,
454 AV_CODEC_ID_DVB_TELETEXT,
456 AV_CODEC_ID_MICRODVD = MKBETAG('m','D','V','D'),
457 AV_CODEC_ID_EIA_608 = MKBETAG('c','6','0','8'),
458 AV_CODEC_ID_JACOSUB = MKBETAG('J','S','U','B'),
459 AV_CODEC_ID_SAMI = MKBETAG('S','A','M','I'),
460 AV_CODEC_ID_REALTEXT = MKBETAG('R','T','X','T'),
461 AV_CODEC_ID_SUBVIEWER = MKBETAG('S','u','b','V'),
462 AV_CODEC_ID_SUBRIP = MKBETAG('S','R','i','p'),
463 AV_CODEC_ID_WEBVTT = MKBETAG('W','V','T','T'),
465 /* other specific kind of codecs (generally used for attachments) */
466 AV_CODEC_ID_FIRST_UNKNOWN = 0x18000, ///< A dummy ID pointing at the start of various fake codecs.
467 AV_CODEC_ID_TTF = 0x18000,
468 AV_CODEC_ID_BINTEXT = MKBETAG('B','T','X','T'),
469 AV_CODEC_ID_XBIN = MKBETAG('X','B','I','N'),
470 AV_CODEC_ID_IDF = MKBETAG( 0 ,'I','D','F'),
471 AV_CODEC_ID_OTF = MKBETAG( 0 ,'O','T','F'),
472 AV_CODEC_ID_SMPTE_KLV = MKBETAG('K','L','V','A'),
474 AV_CODEC_ID_PROBE = 0x19000, ///< codec_id is not known (like AV_CODEC_ID_NONE) but lavf should attempt to identify it
476 AV_CODEC_ID_MPEG2TS = 0x20000, /**< _FAKE_ codec to indicate a raw MPEG-2 TS
477 * stream (only used by libavformat) */
478 AV_CODEC_ID_MPEG4SYSTEMS = 0x20001, /**< _FAKE_ codec to indicate a MPEG-4 Systems
479 * stream (only used by libavformat) */
480 AV_CODEC_ID_FFMETADATA = 0x21000, ///< Dummy codec for streams containing only metadata information.
483 #include "old_codec_ids.h"
488 #define CodecID AVCodecID
492 * This struct describes the properties of a single codec described by an
494 * @see avcodec_get_descriptor()
496 typedef struct AVCodecDescriptor {
498 enum AVMediaType type;
500 * Name of the codec described by this descriptor. It is non-empty and
501 * unique for each codec descriptor. It should contain alphanumeric
502 * characters and '_' only.
506 * A more descriptive name for this codec. May be NULL.
508 const char *long_name;
510 * Codec properties, a combination of AV_CODEC_PROP_* flags.
516 * Codec uses only intra compression.
519 #define AV_CODEC_PROP_INTRA_ONLY (1 << 0)
521 * Codec supports lossy compression. Audio and video codecs only.
522 * @note a codec may support both lossy and lossless
525 #define AV_CODEC_PROP_LOSSY (1 << 1)
527 * Codec supports lossless compression. Audio and video codecs only.
529 #define AV_CODEC_PROP_LOSSLESS (1 << 2)
531 #if FF_API_OLD_DECODE_AUDIO
533 #define AVCODEC_MAX_AUDIO_FRAME_SIZE 192000 // 1 second of 48khz 32bit audio
537 * @ingroup lavc_decoding
538 * Required number of additionally allocated bytes at the end of the input bitstream for decoding.
539 * This is mainly needed because some optimized bitstream readers read
540 * 32 or 64 bit at once and could read over the end.<br>
541 * Note: If the first 23 bits of the additional bytes are not 0, then damaged
542 * MPEG bitstreams could cause overread and segfault.
544 #define FF_INPUT_BUFFER_PADDING_SIZE 16
547 * @ingroup lavc_encoding
548 * minimum encoding buffer size
549 * Used to avoid some checks during header writing.
551 #define FF_MIN_BUFFER_SIZE 16384
555 * @ingroup lavc_encoding
556 * motion estimation type.
559 ME_ZERO = 1, ///< no search, that is use 0,0 vector whenever one is needed
563 ME_EPZS, ///< enhanced predictive zonal search
564 ME_X1, ///< reserved for experiments
565 ME_HEX, ///< hexagon based search
566 ME_UMH, ///< uneven multi-hexagon search
567 ME_ITER, ///< iterative search
568 ME_TESA, ///< transformed exhaustive search algorithm
572 * @ingroup lavc_decoding
575 /* We leave some space between them for extensions (drop some
576 * keyframes for intra-only or drop just some bidir frames). */
577 AVDISCARD_NONE =-16, ///< discard nothing
578 AVDISCARD_DEFAULT = 0, ///< discard useless packets like 0 size packets in avi
579 AVDISCARD_NONREF = 8, ///< discard all non reference
580 AVDISCARD_BIDIR = 16, ///< discard all bidirectional frames
581 AVDISCARD_NONKEY = 32, ///< discard all frames except keyframes
582 AVDISCARD_ALL = 48, ///< discard all
585 enum AVColorPrimaries{
586 AVCOL_PRI_BT709 = 1, ///< also ITU-R BT1361 / IEC 61966-2-4 / SMPTE RP177 Annex B
587 AVCOL_PRI_UNSPECIFIED = 2,
588 AVCOL_PRI_BT470M = 4,
589 AVCOL_PRI_BT470BG = 5, ///< also ITU-R BT601-6 625 / ITU-R BT1358 625 / ITU-R BT1700 625 PAL & SECAM
590 AVCOL_PRI_SMPTE170M = 6, ///< also ITU-R BT601-6 525 / ITU-R BT1358 525 / ITU-R BT1700 NTSC
591 AVCOL_PRI_SMPTE240M = 7, ///< functionally identical to above
593 AVCOL_PRI_NB , ///< Not part of ABI
596 enum AVColorTransferCharacteristic{
597 AVCOL_TRC_BT709 = 1, ///< also ITU-R BT1361
598 AVCOL_TRC_UNSPECIFIED = 2,
599 AVCOL_TRC_GAMMA22 = 4, ///< also ITU-R BT470M / ITU-R BT1700 625 PAL & SECAM
600 AVCOL_TRC_GAMMA28 = 5, ///< also ITU-R BT470BG
601 AVCOL_TRC_SMPTE240M = 7,
602 AVCOL_TRC_NB , ///< Not part of ABI
607 AVCOL_SPC_BT709 = 1, ///< also ITU-R BT1361 / IEC 61966-2-4 xvYCC709 / SMPTE RP177 Annex B
608 AVCOL_SPC_UNSPECIFIED = 2,
610 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
611 AVCOL_SPC_SMPTE170M = 6, ///< also ITU-R BT601-6 525 / ITU-R BT1358 525 / ITU-R BT1700 NTSC / functionally identical to above
612 AVCOL_SPC_SMPTE240M = 7,
613 AVCOL_SPC_YCOCG = 8, ///< Used by Dirac / VC-2 and H.264 FRext, see ITU-T SG16
614 AVCOL_SPC_NB , ///< Not part of ABI
616 #define AVCOL_SPC_YCGCO AVCOL_SPC_YCOCG
619 AVCOL_RANGE_UNSPECIFIED = 0,
620 AVCOL_RANGE_MPEG = 1, ///< the normal 219*2^(n-8) "MPEG" YUV ranges
621 AVCOL_RANGE_JPEG = 2, ///< the normal 2^n-1 "JPEG" YUV ranges
622 AVCOL_RANGE_NB , ///< Not part of ABI
626 * X X 3 4 X X are luma samples,
627 * 1 2 1-6 are possible chroma positions
628 * X X 5 6 X 0 is undefined/unknown position
630 enum AVChromaLocation{
631 AVCHROMA_LOC_UNSPECIFIED = 0,
632 AVCHROMA_LOC_LEFT = 1, ///< mpeg2/4, h264 default
633 AVCHROMA_LOC_CENTER = 2, ///< mpeg1, jpeg, h263
634 AVCHROMA_LOC_TOPLEFT = 3, ///< DV
635 AVCHROMA_LOC_TOP = 4,
636 AVCHROMA_LOC_BOTTOMLEFT = 5,
637 AVCHROMA_LOC_BOTTOM = 6,
638 AVCHROMA_LOC_NB , ///< Not part of ABI
641 enum AVAudioServiceType {
642 AV_AUDIO_SERVICE_TYPE_MAIN = 0,
643 AV_AUDIO_SERVICE_TYPE_EFFECTS = 1,
644 AV_AUDIO_SERVICE_TYPE_VISUALLY_IMPAIRED = 2,
645 AV_AUDIO_SERVICE_TYPE_HEARING_IMPAIRED = 3,
646 AV_AUDIO_SERVICE_TYPE_DIALOGUE = 4,
647 AV_AUDIO_SERVICE_TYPE_COMMENTARY = 5,
648 AV_AUDIO_SERVICE_TYPE_EMERGENCY = 6,
649 AV_AUDIO_SERVICE_TYPE_VOICE_OVER = 7,
650 AV_AUDIO_SERVICE_TYPE_KARAOKE = 8,
651 AV_AUDIO_SERVICE_TYPE_NB , ///< Not part of ABI
655 * @ingroup lavc_encoding
657 typedef struct RcOverride{
660 int qscale; // If this is 0 then quality_factor will be used instead.
661 float quality_factor;
664 #define FF_MAX_B_FRAMES 16
667 These flags can be passed in AVCodecContext.flags before initialization.
668 Note: Not everything is supported yet.
671 #define CODEC_FLAG_QSCALE 0x0002 ///< Use fixed qscale.
672 #define CODEC_FLAG_4MV 0x0004 ///< 4 MV per MB allowed / advanced prediction for H.263.
673 #define CODEC_FLAG_QPEL 0x0010 ///< Use qpel MC.
674 #define CODEC_FLAG_GMC 0x0020 ///< Use GMC.
675 #define CODEC_FLAG_MV0 0x0040 ///< Always try a MB with MV=<0,0>.
677 * The parent program guarantees that the input for B-frames containing
678 * streams is not written to for at least s->max_b_frames+1 frames, if
679 * this is not set the input will be copied.
681 #define CODEC_FLAG_INPUT_PRESERVED 0x0100
682 #define CODEC_FLAG_PASS1 0x0200 ///< Use internal 2pass ratecontrol in first pass mode.
683 #define CODEC_FLAG_PASS2 0x0400 ///< Use internal 2pass ratecontrol in second pass mode.
684 #define CODEC_FLAG_GRAY 0x2000 ///< Only decode/encode grayscale.
685 #define CODEC_FLAG_EMU_EDGE 0x4000 ///< Don't draw edges.
686 #define CODEC_FLAG_PSNR 0x8000 ///< error[?] variables will be set during encoding.
687 #define CODEC_FLAG_TRUNCATED 0x00010000 /** Input bitstream might be truncated at a random
688 location instead of only at frame boundaries. */
689 #define CODEC_FLAG_NORMALIZE_AQP 0x00020000 ///< Normalize adaptive quantization.
690 #define CODEC_FLAG_INTERLACED_DCT 0x00040000 ///< Use interlaced DCT.
691 #define CODEC_FLAG_LOW_DELAY 0x00080000 ///< Force low delay.
692 #define CODEC_FLAG_GLOBAL_HEADER 0x00400000 ///< Place global headers in extradata instead of every keyframe.
693 #define CODEC_FLAG_BITEXACT 0x00800000 ///< Use only bitexact stuff (except (I)DCT).
694 /* Fx : Flag for h263+ extra options */
695 #define CODEC_FLAG_AC_PRED 0x01000000 ///< H.263 advanced intra coding / MPEG-4 AC prediction
696 #define CODEC_FLAG_LOOP_FILTER 0x00000800 ///< loop filter
697 #define CODEC_FLAG_INTERLACED_ME 0x20000000 ///< interlaced motion estimation
698 #define CODEC_FLAG_CLOSED_GOP 0x80000000
699 #define CODEC_FLAG2_FAST 0x00000001 ///< Allow non spec compliant speedup tricks.
700 #define CODEC_FLAG2_NO_OUTPUT 0x00000004 ///< Skip bitstream encoding.
701 #define CODEC_FLAG2_LOCAL_HEADER 0x00000008 ///< Place global headers at every keyframe instead of in extradata.
702 #define CODEC_FLAG2_DROP_FRAME_TIMECODE 0x00002000 ///< timecode is in drop frame format. DEPRECATED!!!!
703 #if FF_API_MPV_GLOBAL_OPTS
704 #define CODEC_FLAG_CBP_RD 0x04000000 ///< Use rate distortion optimization for cbp.
705 #define CODEC_FLAG_QP_RD 0x08000000 ///< Use rate distortion optimization for qp selectioon.
706 #define CODEC_FLAG2_STRICT_GOP 0x00000002 ///< Strictly enforce GOP size.
707 #define CODEC_FLAG2_SKIP_RD 0x00004000 ///< RD optimal MB level residual skipping
709 #define CODEC_FLAG2_CHUNKS 0x00008000 ///< Input bitstream might be truncated at a packet boundaries instead of only at frame boundaries.
710 #define CODEC_FLAG2_SHOW_ALL 0x00400000 ///< Show all frames before the first keyframe
712 /* Unsupported options :
713 * Syntax Arithmetic coding (SAC)
714 * Reference Picture Selection
715 * Independent Segment Decoding */
717 /* codec capabilities */
719 #define CODEC_CAP_DRAW_HORIZ_BAND 0x0001 ///< Decoder can use draw_horiz_band callback.
721 * Codec uses get_buffer() for allocating buffers and supports custom allocators.
722 * If not set, it might not use get_buffer() at all or use operations that
723 * assume the buffer was allocated by avcodec_default_get_buffer.
725 #define CODEC_CAP_DR1 0x0002
726 #define CODEC_CAP_TRUNCATED 0x0008
727 /* Codec can export data for HW decoding (XvMC). */
728 #define CODEC_CAP_HWACCEL 0x0010
730 * Encoder or decoder requires flushing with NULL input at the end in order to
731 * give the complete and correct output.
733 * NOTE: If this flag is not set, the codec is guaranteed to never be fed with
734 * with NULL data. The user can still send NULL data to the public encode
735 * or decode function, but libavcodec will not pass it along to the codec
736 * unless this flag is set.
739 * The decoder has a non-zero delay and needs to be fed with avpkt->data=NULL,
740 * avpkt->size=0 at the end to get the delayed data until the decoder no longer
744 * The encoder needs to be fed with NULL data at the end of encoding until the
745 * encoder no longer returns data.
747 * NOTE: For encoders implementing the AVCodec.encode2() function, setting this
748 * flag also means that the encoder must set the pts and duration for
749 * each output packet. If this flag is not set, the pts and duration will
750 * be determined by libavcodec from the input frame.
752 #define CODEC_CAP_DELAY 0x0020
754 * Codec can be fed a final frame with a smaller size.
755 * This can be used to prevent truncation of the last audio samples.
757 #define CODEC_CAP_SMALL_LAST_FRAME 0x0040
759 * Codec can export data for HW decoding (VDPAU).
761 #define CODEC_CAP_HWACCEL_VDPAU 0x0080
763 * Codec can output multiple frames per AVPacket
764 * Normally demuxers return one frame at a time, demuxers which do not do
765 * are connected to a parser to split what they return into proper frames.
766 * This flag is reserved to the very rare category of codecs which have a
767 * bitstream that cannot be split into frames without timeconsuming
768 * operations like full decoding. Demuxers carring such bitstreams thus
769 * may return multiple frames in a packet. This has many disadvantages like
770 * prohibiting stream copy in many cases thus it should only be considered
773 #define CODEC_CAP_SUBFRAMES 0x0100
775 * Codec is experimental and is thus avoided in favor of non experimental
778 #define CODEC_CAP_EXPERIMENTAL 0x0200
780 * Codec should fill in channel configuration and samplerate instead of container
782 #define CODEC_CAP_CHANNEL_CONF 0x0400
785 * Codec is able to deal with negative linesizes
787 #define CODEC_CAP_NEG_LINESIZES 0x0800
790 * Codec supports frame-level multithreading.
792 #define CODEC_CAP_FRAME_THREADS 0x1000
794 * Codec supports slice-based (or partition-based) multithreading.
796 #define CODEC_CAP_SLICE_THREADS 0x2000
798 * Codec supports changed parameters at any point.
800 #define CODEC_CAP_PARAM_CHANGE 0x4000
802 * Codec supports avctx->thread_count == 0 (auto).
804 #define CODEC_CAP_AUTO_THREADS 0x8000
806 * Audio encoder supports receiving a different number of samples in each call.
808 #define CODEC_CAP_VARIABLE_FRAME_SIZE 0x10000
810 * Codec is intra only.
812 #define CODEC_CAP_INTRA_ONLY 0x40000000
816 #define CODEC_CAP_LOSSLESS 0x80000000
818 //The following defines may change, don't expect compatibility if you use them.
819 #define MB_TYPE_INTRA4x4 0x0001
820 #define MB_TYPE_INTRA16x16 0x0002 //FIXME H.264-specific
821 #define MB_TYPE_INTRA_PCM 0x0004 //FIXME H.264-specific
822 #define MB_TYPE_16x16 0x0008
823 #define MB_TYPE_16x8 0x0010
824 #define MB_TYPE_8x16 0x0020
825 #define MB_TYPE_8x8 0x0040
826 #define MB_TYPE_INTERLACED 0x0080
827 #define MB_TYPE_DIRECT2 0x0100 //FIXME
828 #define MB_TYPE_ACPRED 0x0200
829 #define MB_TYPE_GMC 0x0400
830 #define MB_TYPE_SKIP 0x0800
831 #define MB_TYPE_P0L0 0x1000
832 #define MB_TYPE_P1L0 0x2000
833 #define MB_TYPE_P0L1 0x4000
834 #define MB_TYPE_P1L1 0x8000
835 #define MB_TYPE_L0 (MB_TYPE_P0L0 | MB_TYPE_P1L0)
836 #define MB_TYPE_L1 (MB_TYPE_P0L1 | MB_TYPE_P1L1)
837 #define MB_TYPE_L0L1 (MB_TYPE_L0 | MB_TYPE_L1)
838 #define MB_TYPE_QUANT 0x00010000
839 #define MB_TYPE_CBP 0x00020000
840 //Note bits 24-31 are reserved for codec specific use (h264 ref0, mpeg1 0mv, ...)
844 * This specifies the area which should be displayed.
845 * Note there may be multiple such areas for one frame.
847 typedef struct AVPanScan{
850 * - encoding: Set by user.
851 * - decoding: Set by libavcodec.
856 * width and height in 1/16 pel
857 * - encoding: Set by user.
858 * - decoding: Set by libavcodec.
864 * position of the top left corner in 1/16 pel for up to 3 fields/frames
865 * - encoding: Set by user.
866 * - decoding: Set by libavcodec.
868 int16_t position[3][2];
871 #define FF_QSCALE_TYPE_MPEG1 0
872 #define FF_QSCALE_TYPE_MPEG2 1
873 #define FF_QSCALE_TYPE_H264 2
874 #define FF_QSCALE_TYPE_VP56 3
876 #define FF_BUFFER_TYPE_INTERNAL 1
877 #define FF_BUFFER_TYPE_USER 2 ///< direct rendering buffers (image is (de)allocated by user)
878 #define FF_BUFFER_TYPE_SHARED 4 ///< Buffer from somewhere else; don't deallocate image (data/base), all other tables are not shared.
879 #define FF_BUFFER_TYPE_COPY 8 ///< Just a (modified) copy of some other buffer, don't deallocate anything.
881 #define FF_BUFFER_HINTS_VALID 0x01 // Buffer hints value is meaningful (if 0 ignore).
882 #define FF_BUFFER_HINTS_READABLE 0x02 // Codec will read from buffer.
883 #define FF_BUFFER_HINTS_PRESERVE 0x04 // User must not alter buffer content.
884 #define FF_BUFFER_HINTS_REUSABLE 0x08 // Codec will reuse the buffer (update).
887 * @defgroup lavc_packet AVPacket
889 * Types and functions for working with AVPacket.
892 enum AVPacketSideDataType {
894 AV_PKT_DATA_NEW_EXTRADATA,
897 * An AV_PKT_DATA_PARAM_CHANGE side data packet is laid out as follows:
900 * if (param_flags & AV_SIDE_DATA_PARAM_CHANGE_CHANNEL_COUNT)
901 * s32le channel_count
902 * if (param_flags & AV_SIDE_DATA_PARAM_CHANGE_CHANNEL_LAYOUT)
903 * u64le channel_layout
904 * if (param_flags & AV_SIDE_DATA_PARAM_CHANGE_SAMPLE_RATE)
906 * if (param_flags & AV_SIDE_DATA_PARAM_CHANGE_DIMENSIONS)
911 AV_PKT_DATA_PARAM_CHANGE,
914 * An AV_PKT_DATA_H263_MB_INFO side data packet contains a number of
915 * structures with info about macroblocks relevant to splitting the
916 * packet into smaller packets on macroblock edges (e.g. as for RFC 2190).
917 * That is, it does not necessarily contain info about all macroblocks,
918 * as long as the distance between macroblocks in the info is smaller
919 * than the target payload size.
920 * Each MB info structure is 12 bytes, and is laid out as follows:
922 * u32le bit offset from the start of the packet
923 * u8 current quantizer at the start of the macroblock
925 * u16le macroblock address within the GOB
926 * u8 horizontal MV predictor
927 * u8 vertical MV predictor
928 * u8 horizontal MV predictor for block number 3
929 * u8 vertical MV predictor for block number 3
932 AV_PKT_DATA_H263_MB_INFO,
935 * Recommmends skipping the specified number of samples
937 * u32le number of samples to skip from start of this packet
938 * u32le number of samples to skip from end of this packet
939 * u8 reason for start skip
940 * u8 reason for end skip (0=padding silence, 1=convergence)
943 AV_PKT_DATA_SKIP_SAMPLES=70,
946 * An AV_PKT_DATA_JP_DUALMONO side data packet indicates that
947 * the packet may contain "dual mono" audio specific to Japanese DTV
948 * and if it is true, recommends only the selected channel to be used.
950 * u8 selected channels (0=mail/left, 1=sub/right, 2=both)
953 AV_PKT_DATA_JP_DUALMONO,
956 * A list of zero terminated key/value strings. There is no end marker for
957 * the list, so it is required to rely on the side data size to stop.
959 AV_PKT_DATA_STRINGS_METADATA,
962 * Subtitle event position
970 AV_PKT_DATA_SUBTITLE_POSITION,
974 * This structure stores compressed data. It is typically exported by demuxers
975 * and then passed as input to decoders, or received as output from encoders and
976 * then passed to muxers.
978 * For video, it should typically contain one compressed frame. For audio it may
979 * contain several compressed frames.
981 * AVPacket is one of the few structs in FFmpeg, whose size is a part of public
982 * ABI. Thus it may be allocated on stack and no new fields can be added to it
983 * without libavcodec and libavformat major bump.
985 * The semantics of data ownership depends on the destruct field.
986 * If it is set, the packet data is dynamically allocated and is valid
987 * indefinitely until av_free_packet() is called (which in turn calls the
988 * destruct callback to free the data). If destruct is not set, the packet data
989 * is typically backed by some static buffer somewhere and is only valid for a
990 * limited time (e.g. until the next read call when demuxing).
992 * The side data is always allocated with av_malloc() and is freed in
995 typedef struct AVPacket {
997 * Presentation timestamp in AVStream->time_base units; the time at which
998 * the decompressed packet will be presented to the user.
999 * Can be AV_NOPTS_VALUE if it is not stored in the file.
1000 * pts MUST be larger or equal to dts as presentation cannot happen before
1001 * decompression, unless one wants to view hex dumps. Some formats misuse
1002 * the terms dts and pts/cts to mean something different. Such timestamps
1003 * must be converted to true pts/dts before they are stored in AVPacket.
1007 * Decompression timestamp in AVStream->time_base units; the time at which
1008 * the packet is decompressed.
1009 * Can be AV_NOPTS_VALUE if it is not stored in the file.
1016 * A combination of AV_PKT_FLAG values
1020 * Additional packet data that can be provided by the container.
1021 * Packet can contain several types of side information.
1026 enum AVPacketSideDataType type;
1028 int side_data_elems;
1031 * Duration of this packet in AVStream->time_base units, 0 if unknown.
1032 * Equals next_pts - this_pts in presentation order.
1035 void (*destruct)(struct AVPacket *);
1037 int64_t pos; ///< byte position in stream, -1 if unknown
1040 * Time difference in AVStream->time_base units from the pts of this
1041 * packet to the point at which the output from the decoder has converged
1042 * independent from the availability of previous frames. That is, the
1043 * frames are virtually identical no matter if decoding started from
1044 * the very first frame or from this keyframe.
1045 * Is AV_NOPTS_VALUE if unknown.
1046 * This field is not the display duration of the current packet.
1047 * This field has no meaning if the packet does not have AV_PKT_FLAG_KEY
1050 * The purpose of this field is to allow seeking in streams that have no
1051 * keyframes in the conventional sense. It corresponds to the
1052 * recovery point SEI in H.264 and match_time_delta in NUT. It is also
1053 * essential for some types of subtitle streams to ensure that all
1054 * subtitles are correctly displayed after seeking.
1056 int64_t convergence_duration;
1058 #define AV_PKT_FLAG_KEY 0x0001 ///< The packet contains a keyframe
1059 #define AV_PKT_FLAG_CORRUPT 0x0002 ///< The packet content is corrupted
1061 enum AVSideDataParamChangeFlags {
1062 AV_SIDE_DATA_PARAM_CHANGE_CHANNEL_COUNT = 0x0001,
1063 AV_SIDE_DATA_PARAM_CHANGE_CHANNEL_LAYOUT = 0x0002,
1064 AV_SIDE_DATA_PARAM_CHANGE_SAMPLE_RATE = 0x0004,
1065 AV_SIDE_DATA_PARAM_CHANGE_DIMENSIONS = 0x0008,
1072 * Audio Video Frame.
1073 * New fields can be added to the end of AVFRAME with minor version
1074 * bumps. Similarly fields that are marked as to be only accessed by
1075 * av_opt_ptr() can be reordered. This allows 2 forks to add fields
1076 * without breaking compatibility with each other.
1077 * Removal, reordering and changes in the remaining cases require
1078 * a major version bump.
1079 * sizeof(AVFrame) must not be used outside libavcodec.
1081 typedef struct AVFrame {
1082 #define AV_NUM_DATA_POINTERS 8
1084 * pointer to the picture/channel planes.
1085 * This might be different from the first allocated byte
1086 * - encoding: Set by user
1087 * - decoding: set by AVCodecContext.get_buffer()
1089 uint8_t *data[AV_NUM_DATA_POINTERS];
1092 * Size, in bytes, of the data for each picture/channel plane.
1094 * For audio, only linesize[0] may be set. For planar audio, each channel
1095 * plane must be the same size.
1097 * - encoding: Set by user
1098 * - decoding: set by AVCodecContext.get_buffer()
1100 int linesize[AV_NUM_DATA_POINTERS];
1103 * pointers to the data planes/channels.
1105 * For video, this should simply point to data[].
1107 * For planar audio, each channel has a separate data pointer, and
1108 * linesize[0] contains the size of each channel buffer.
1109 * For packed audio, there is just one data pointer, and linesize[0]
1110 * contains the total size of the buffer for all channels.
1112 * Note: Both data and extended_data will always be set by get_buffer(),
1113 * but for planar audio with more channels that can fit in data,
1114 * extended_data must be used by the decoder in order to access all
1117 * encoding: set by user
1118 * decoding: set by AVCodecContext.get_buffer()
1120 uint8_t **extended_data;
1123 * width and height of the video frame
1124 * - encoding: unused
1125 * - decoding: Read by user.
1130 * number of audio samples (per channel) described by this frame
1131 * - encoding: Set by user
1132 * - decoding: Set by libavcodec
1137 * format of the frame, -1 if unknown or unset
1138 * Values correspond to enum AVPixelFormat for video frames,
1139 * enum AVSampleFormat for audio)
1140 * - encoding: unused
1141 * - decoding: Read by user.
1146 * 1 -> keyframe, 0-> not
1147 * - encoding: Set by libavcodec.
1148 * - decoding: Set by libavcodec.
1153 * Picture type of the frame, see ?_TYPE below.
1154 * - encoding: Set by libavcodec. for coded_picture (and set by user for input).
1155 * - decoding: Set by libavcodec.
1157 enum AVPictureType pict_type;
1160 * pointer to the first allocated byte of the picture. Can be used in get_buffer/release_buffer.
1161 * This isn't used by libavcodec unless the default get/release_buffer() is used.
1165 uint8_t *base[AV_NUM_DATA_POINTERS];
1168 * sample aspect ratio for the video frame, 0/1 if unknown/unspecified
1169 * - encoding: unused
1170 * - decoding: Read by user.
1172 AVRational sample_aspect_ratio;
1175 * presentation timestamp in time_base units (time when frame should be shown to user)
1176 * If AV_NOPTS_VALUE then frame_rate = 1/time_base will be assumed.
1177 * - encoding: MUST be set by user.
1178 * - decoding: Set by libavcodec.
1183 * reordered pts from the last AVPacket that has been input into the decoder
1184 * - encoding: unused
1185 * - decoding: Read by user.
1190 * dts from the last AVPacket that has been input into the decoder
1191 * - encoding: unused
1192 * - decoding: Read by user.
1197 * picture number in bitstream order
1198 * - encoding: set by
1199 * - decoding: Set by libavcodec.
1201 int coded_picture_number;
1203 * picture number in display order
1204 * - encoding: set by
1205 * - decoding: Set by libavcodec.
1207 int display_picture_number;
1210 * quality (between 1 (good) and FF_LAMBDA_MAX (bad))
1211 * - encoding: Set by libavcodec. for coded_picture (and set by user for input).
1212 * - decoding: Set by libavcodec.
1217 * is this picture used as reference
1218 * The values for this are the same as the MpegEncContext.picture_structure
1219 * variable, that is 1->top field, 2->bottom field, 3->frame/both fields.
1220 * Set to 4 for delayed, non-reference frames.
1221 * - encoding: unused
1222 * - decoding: Set by libavcodec. (before get_buffer() call)).
1228 * - encoding: unused
1229 * - decoding: Set by libavcodec.
1231 int8_t *qscale_table;
1234 * - encoding: unused
1235 * - decoding: Set by libavcodec.
1245 * mbskip_table[mb]>=1 if MB didn't change
1246 * stride= mb_width = (width+15)>>4
1247 * - encoding: unused
1248 * - decoding: Set by libavcodec.
1250 uint8_t *mbskip_table;
1253 * motion vector table
1256 * int mv_sample_log2= 4 - motion_subsample_log2;
1257 * int mb_width= (width+15)>>4;
1258 * int mv_stride= (mb_width << mv_sample_log2) + 1;
1259 * motion_val[direction][x + y*mv_stride][0->mv_x, 1->mv_y];
1261 * - encoding: Set by user.
1262 * - decoding: Set by libavcodec.
1264 int16_t (*motion_val[2])[2];
1267 * macroblock type table
1268 * mb_type_base + mb_width + 2
1269 * - encoding: Set by user.
1270 * - decoding: Set by libavcodec.
1276 * - encoding: unused
1277 * - decoding: Set by libavcodec.
1282 * motion reference frame index
1283 * the order in which these are stored can depend on the codec.
1284 * - encoding: Set by user.
1285 * - decoding: Set by libavcodec.
1287 int8_t *ref_index[2];
1290 * for some private data of the user
1291 * - encoding: unused
1292 * - decoding: Set by user.
1298 * - encoding: Set by libavcodec. if flags&CODEC_FLAG_PSNR.
1299 * - decoding: unused
1301 uint64_t error[AV_NUM_DATA_POINTERS];
1304 * type of the buffer (to keep track of who has to deallocate data[*])
1305 * - encoding: Set by the one who allocates it.
1306 * - decoding: Set by the one who allocates it.
1307 * Note: User allocated (direct rendering) & internal buffers cannot coexist currently.
1312 * When decoding, this signals how much the picture must be delayed.
1313 * extra_delay = repeat_pict / (2*fps)
1314 * - encoding: unused
1315 * - decoding: Set by libavcodec.
1320 * The content of the picture is interlaced.
1321 * - encoding: Set by user.
1322 * - decoding: Set by libavcodec. (default 0)
1324 int interlaced_frame;
1327 * If the content is interlaced, is top field displayed first.
1328 * - encoding: Set by user.
1329 * - decoding: Set by libavcodec.
1331 int top_field_first;
1334 * Tell user application that palette has changed from previous frame.
1335 * - encoding: ??? (no palette-enabled encoder yet)
1336 * - decoding: Set by libavcodec. (default 0).
1338 int palette_has_changed;
1341 * codec suggestion on buffer type if != 0
1342 * - encoding: unused
1343 * - decoding: Set by libavcodec. (before get_buffer() call)).
1349 * - encoding: Set by user.
1350 * - decoding: Set by libavcodec.
1352 AVPanScan *pan_scan;
1355 * reordered opaque 64bit (generally an integer or a double precision float
1356 * PTS but can be anything).
1357 * The user sets AVCodecContext.reordered_opaque to represent the input at
1359 * the decoder reorders values as needed and sets AVFrame.reordered_opaque
1360 * to exactly one of the values provided by the user through AVCodecContext.reordered_opaque
1361 * @deprecated in favor of pkt_pts
1362 * - encoding: unused
1363 * - decoding: Read by user.
1365 int64_t reordered_opaque;
1368 * hardware accelerator private data (FFmpeg-allocated)
1369 * - encoding: unused
1370 * - decoding: Set by libavcodec
1372 void *hwaccel_picture_private;
1375 * the AVCodecContext which ff_thread_get_buffer() was last called on
1376 * - encoding: Set by libavcodec.
1377 * - decoding: Set by libavcodec.
1379 struct AVCodecContext *owner;
1382 * used by multithreading to store frame-specific info
1383 * - encoding: Set by libavcodec.
1384 * - decoding: Set by libavcodec.
1386 void *thread_opaque;
1389 * log2 of the size of the block which a single vector in motion_val represents:
1390 * (4->16x16, 3->8x8, 2-> 4x4, 1-> 2x2)
1391 * - encoding: unused
1392 * - decoding: Set by libavcodec.
1394 uint8_t motion_subsample_log2;
1397 * Sample rate of the audio data.
1399 * - encoding: unused
1400 * - decoding: read by user
1405 * Channel layout of the audio data.
1407 * - encoding: unused
1408 * - decoding: read by user.
1410 uint64_t channel_layout;
1413 * frame timestamp estimated using various heuristics, in stream time base
1414 * Code outside libavcodec should access this field using:
1415 * av_frame_get_best_effort_timestamp(frame)
1416 * - encoding: unused
1417 * - decoding: set by libavcodec, read by user.
1419 int64_t best_effort_timestamp;
1422 * reordered pos from the last AVPacket that has been input into the decoder
1423 * Code outside libavcodec should access this field using:
1424 * av_frame_get_pkt_pos(frame)
1425 * - encoding: unused
1426 * - decoding: Read by user.
1431 * duration of the corresponding packet, expressed in
1432 * AVStream->time_base units, 0 if unknown.
1433 * Code outside libavcodec should access this field using:
1434 * av_frame_get_pkt_duration(frame)
1435 * - encoding: unused
1436 * - decoding: Read by user.
1438 int64_t pkt_duration;
1442 * Code outside libavcodec should access this field using:
1443 * av_frame_get_metadata(frame)
1444 * - encoding: Set by user.
1445 * - decoding: Set by libavcodec.
1447 AVDictionary *metadata;
1450 * decode error flags of the frame, set to a combination of
1451 * FF_DECODE_ERROR_xxx flags if the decoder produced a frame, but there
1452 * were errors during the decoding.
1453 * Code outside libavcodec should access this field using:
1454 * av_frame_get_decode_error_flags(frame)
1455 * - encoding: unused
1456 * - decoding: set by libavcodec, read by user.
1458 int decode_error_flags;
1459 #define FF_DECODE_ERROR_INVALID_BITSTREAM 1
1460 #define FF_DECODE_ERROR_MISSING_REFERENCE 2
1463 * number of audio channels, only used for audio.
1464 * Code outside libavcodec should access this field using:
1465 * av_frame_get_channels(frame)
1466 * - encoding: unused
1467 * - decoding: Read by user.
1473 * Accessors for some AVFrame fields.
1474 * The position of these field in the structure is not part of the ABI,
1475 * they should not be accessed directly outside libavcodec.
1477 int64_t av_frame_get_best_effort_timestamp(const AVFrame *frame);
1478 void av_frame_set_best_effort_timestamp(AVFrame *frame, int64_t val);
1479 int64_t av_frame_get_pkt_duration (const AVFrame *frame);
1480 void av_frame_set_pkt_duration (AVFrame *frame, int64_t val);
1481 int64_t av_frame_get_pkt_pos (const AVFrame *frame);
1482 void av_frame_set_pkt_pos (AVFrame *frame, int64_t val);
1483 int64_t av_frame_get_channel_layout (const AVFrame *frame);
1484 void av_frame_set_channel_layout (AVFrame *frame, int64_t val);
1485 int av_frame_get_channels (const AVFrame *frame);
1486 void av_frame_set_channels (AVFrame *frame, int val);
1487 int av_frame_get_sample_rate (const AVFrame *frame);
1488 void av_frame_set_sample_rate (AVFrame *frame, int val);
1489 AVDictionary *av_frame_get_metadata (const AVFrame *frame);
1490 void av_frame_set_metadata (AVFrame *frame, AVDictionary *val);
1491 int av_frame_get_decode_error_flags (const AVFrame *frame);
1492 void av_frame_set_decode_error_flags (AVFrame *frame, int val);
1494 struct AVCodecInternal;
1498 AV_FIELD_PROGRESSIVE,
1499 AV_FIELD_TT, //< Top coded_first, top displayed first
1500 AV_FIELD_BB, //< Bottom coded first, bottom displayed first
1501 AV_FIELD_TB, //< Top coded first, bottom displayed first
1502 AV_FIELD_BT, //< Bottom coded first, top displayed first
1506 * main external API structure.
1507 * New fields can be added to the end with minor version bumps.
1508 * Removal, reordering and changes to existing fields require a major
1510 * Please use AVOptions (av_opt* / av_set/get*()) to access these fields from user
1512 * sizeof(AVCodecContext) must not be used outside libav*.
1514 typedef struct AVCodecContext {
1516 * information on struct for av_log
1517 * - set by avcodec_alloc_context3
1519 const AVClass *av_class;
1520 int log_level_offset;
1522 enum AVMediaType codec_type; /* see AVMEDIA_TYPE_xxx */
1523 const struct AVCodec *codec;
1524 char codec_name[32];
1525 enum AVCodecID codec_id; /* see AV_CODEC_ID_xxx */
1528 * fourcc (LSB first, so "ABCD" -> ('D'<<24) + ('C'<<16) + ('B'<<8) + 'A').
1529 * This is used to work around some encoder bugs.
1530 * A demuxer should set this to what is stored in the field used to identify the codec.
1531 * If there are multiple such fields in a container then the demuxer should choose the one
1532 * which maximizes the information about the used codec.
1533 * If the codec tag field in a container is larger than 32 bits then the demuxer should
1534 * remap the longer ID to 32 bits with a table or other structure. Alternatively a new
1535 * extra_codec_tag + size could be added but for this a clear advantage must be demonstrated
1537 * - encoding: Set by user, if not then the default based on codec_id will be used.
1538 * - decoding: Set by user, will be converted to uppercase by libavcodec during init.
1540 unsigned int codec_tag;
1543 * fourcc from the AVI stream header (LSB first, so "ABCD" -> ('D'<<24) + ('C'<<16) + ('B'<<8) + 'A').
1544 * This is used to work around some encoder bugs.
1545 * - encoding: unused
1546 * - decoding: Set by user, will be converted to uppercase by libavcodec during init.
1548 unsigned int stream_codec_tag;
1552 * @deprecated this field is unused
1554 attribute_deprecated int sub_id;
1560 * Private context used for internal data.
1562 * Unlike priv_data, this is not codec-specific. It is used in general
1563 * libavcodec functions.
1565 struct AVCodecInternal *internal;
1568 * Private data of the user, can be used to carry app specific stuff.
1569 * - encoding: Set by user.
1570 * - decoding: Set by user.
1575 * the average bitrate
1576 * - encoding: Set by user; unused for constant quantizer encoding.
1577 * - decoding: Set by libavcodec. 0 or some bitrate if this info is available in the stream.
1582 * number of bits the bitstream is allowed to diverge from the reference.
1583 * the reference can be CBR (for CBR pass1) or VBR (for pass2)
1584 * - encoding: Set by user; unused for constant quantizer encoding.
1585 * - decoding: unused
1587 int bit_rate_tolerance;
1590 * Global quality for codecs which cannot change it per frame.
1591 * This should be proportional to MPEG-1/2/4 qscale.
1592 * - encoding: Set by user.
1593 * - decoding: unused
1598 * - encoding: Set by user.
1599 * - decoding: unused
1601 int compression_level;
1602 #define FF_COMPRESSION_DEFAULT -1
1606 * - encoding: Set by user.
1607 * - decoding: Set by user.
1613 * - encoding: Set by user.
1614 * - decoding: Set by user.
1619 * some codecs need / can use extradata like Huffman tables.
1620 * mjpeg: Huffman tables
1621 * rv10: additional flags
1622 * mpeg4: global headers (they can be in the bitstream or here)
1623 * The allocated memory should be FF_INPUT_BUFFER_PADDING_SIZE bytes larger
1624 * than extradata_size to avoid prolems if it is read with the bitstream reader.
1625 * The bytewise contents of extradata must not depend on the architecture or CPU endianness.
1626 * - encoding: Set/allocated/freed by libavcodec.
1627 * - decoding: Set/allocated/freed by user.
1633 * This is the fundamental unit of time (in seconds) in terms
1634 * of which frame timestamps are represented. For fixed-fps content,
1635 * timebase should be 1/framerate and timestamp increments should be
1637 * - encoding: MUST be set by user.
1638 * - decoding: Set by libavcodec.
1640 AVRational time_base;
1643 * For some codecs, the time base is closer to the field rate than the frame rate.
1644 * Most notably, H.264 and MPEG-2 specify time_base as half of frame duration
1645 * if no telecine is used ...
1647 * Set to time_base ticks per frame. Default 1, e.g., H.264/MPEG-2 set it to 2.
1649 int ticks_per_frame;
1654 * Encoding: Number of frames delay there will be from the encoder input to
1655 * the decoder output. (we assume the decoder matches the spec)
1656 * Decoding: Number of frames delay in addition to what a standard decoder
1657 * as specified in the spec would produce.
1660 * Number of frames the decoded output will be delayed relative to the
1664 * For encoding, this is the number of "priming" samples added to the
1665 * beginning of the stream. The decoded output will be delayed by this
1666 * many samples relative to the input to the encoder. Note that this
1667 * field is purely informational and does not directly affect the pts
1668 * output by the encoder, which should always be based on the actual
1669 * presentation time, including any delay.
1670 * For decoding, this is the number of samples the decoder needs to
1671 * output before the decoder's output is valid. When seeking, you should
1672 * start decoding this many samples prior to your desired seek point.
1674 * - encoding: Set by libavcodec.
1675 * - decoding: Set by libavcodec.
1682 * picture width / height.
1683 * - encoding: MUST be set by user.
1684 * - decoding: Set by libavcodec.
1685 * Note: For compatibility it is possible to set this instead of
1686 * coded_width/height before decoding.
1691 * Bitstream width / height, may be different from width/height if lowres enabled.
1692 * - encoding: unused
1693 * - decoding: Set by user before init if known. Codec should override / dynamically change if needed.
1695 int coded_width, coded_height;
1697 #define FF_ASPECT_EXTENDED 15
1700 * the number of pictures in a group of pictures, or 0 for intra_only
1701 * - encoding: Set by user.
1702 * - decoding: unused
1707 * Pixel format, see AV_PIX_FMT_xxx.
1708 * May be set by the demuxer if known from headers.
1709 * May be overridden by the decoder if it knows better.
1710 * - encoding: Set by user.
1711 * - decoding: Set by user if known, overridden by libavcodec if known
1713 enum AVPixelFormat pix_fmt;
1716 * Motion estimation algorithm used for video coding.
1717 * 1 (zero), 2 (full), 3 (log), 4 (phods), 5 (epzs), 6 (x1), 7 (hex),
1718 * 8 (umh), 9 (iter), 10 (tesa) [7, 8, 10 are x264 specific, 9 is snow specific]
1719 * - encoding: MUST be set by user.
1720 * - decoding: unused
1725 * If non NULL, 'draw_horiz_band' is called by the libavcodec
1726 * decoder to draw a horizontal band. It improves cache usage. Not
1727 * all codecs can do that. You must check the codec capabilities
1729 * When multithreading is used, it may be called from multiple threads
1730 * at the same time; threads might draw different parts of the same AVFrame,
1731 * or multiple AVFrames, and there is no guarantee that slices will be drawn
1733 * The function is also used by hardware acceleration APIs.
1734 * It is called at least once during frame decoding to pass
1735 * the data needed for hardware render.
1736 * In that mode instead of pixel data, AVFrame points to
1737 * a structure specific to the acceleration API. The application
1738 * reads the structure and can change some fields to indicate progress
1740 * - encoding: unused
1741 * - decoding: Set by user.
1742 * @param height the height of the slice
1743 * @param y the y position of the slice
1744 * @param type 1->top field, 2->bottom field, 3->frame
1745 * @param offset offset into the AVFrame.data from which the slice should be read
1747 void (*draw_horiz_band)(struct AVCodecContext *s,
1748 const AVFrame *src, int offset[AV_NUM_DATA_POINTERS],
1749 int y, int type, int height);
1752 * callback to negotiate the pixelFormat
1753 * @param fmt is the list of formats which are supported by the codec,
1754 * it is terminated by -1 as 0 is a valid format, the formats are ordered by quality.
1755 * The first is always the native one.
1756 * @return the chosen format
1757 * - encoding: unused
1758 * - decoding: Set by user, if not set the native format will be chosen.
1760 enum AVPixelFormat (*get_format)(struct AVCodecContext *s, const enum AVPixelFormat * fmt);
1763 * maximum number of B-frames between non-B-frames
1764 * Note: The output will be delayed by max_b_frames+1 relative to the input.
1765 * - encoding: Set by user.
1766 * - decoding: unused
1771 * qscale factor between IP and B-frames
1772 * If > 0 then the last P-frame quantizer will be used (q= lastp_q*factor+offset).
1773 * If < 0 then normal ratecontrol will be done (q= -normal_q*factor+offset).
1774 * - encoding: Set by user.
1775 * - decoding: unused
1777 float b_quant_factor;
1779 /** obsolete FIXME remove */
1781 #define FF_RC_STRATEGY_XVID 1
1783 int b_frame_strategy;
1785 #if FF_API_MPV_GLOBAL_OPTS
1787 * luma single coefficient elimination threshold
1788 * - encoding: Set by user.
1789 * - decoding: unused
1791 attribute_deprecated int luma_elim_threshold;
1794 * chroma single coeff elimination threshold
1795 * - encoding: Set by user.
1796 * - decoding: unused
1798 attribute_deprecated int chroma_elim_threshold;
1802 * qscale offset between IP and B-frames
1803 * - encoding: Set by user.
1804 * - decoding: unused
1806 float b_quant_offset;
1809 * Size of the frame reordering buffer in the decoder.
1810 * For MPEG-2 it is 1 IPB or 0 low delay IP.
1811 * - encoding: Set by libavcodec.
1812 * - decoding: Set by libavcodec.
1817 * 0-> h263 quant 1-> mpeg quant
1818 * - encoding: Set by user.
1819 * - decoding: unused
1824 * qscale factor between P and I-frames
1825 * If > 0 then the last p frame quantizer will be used (q= lastp_q*factor+offset).
1826 * If < 0 then normal ratecontrol will be done (q= -normal_q*factor+offset).
1827 * - encoding: Set by user.
1828 * - decoding: unused
1830 float i_quant_factor;
1833 * qscale offset between P and I-frames
1834 * - encoding: Set by user.
1835 * - decoding: unused
1837 float i_quant_offset;
1840 * luminance masking (0-> disabled)
1841 * - encoding: Set by user.
1842 * - decoding: unused
1847 * temporary complexity masking (0-> disabled)
1848 * - encoding: Set by user.
1849 * - decoding: unused
1851 float temporal_cplx_masking;
1854 * spatial complexity masking (0-> disabled)
1855 * - encoding: Set by user.
1856 * - decoding: unused
1858 float spatial_cplx_masking;
1861 * p block masking (0-> disabled)
1862 * - encoding: Set by user.
1863 * - decoding: unused
1868 * darkness masking (0-> disabled)
1869 * - encoding: Set by user.
1870 * - decoding: unused
1876 * - encoding: Set by libavcodec.
1877 * - decoding: Set by user (or 0).
1881 * prediction method (needed for huffyuv)
1882 * - encoding: Set by user.
1883 * - decoding: unused
1885 int prediction_method;
1886 #define FF_PRED_LEFT 0
1887 #define FF_PRED_PLANE 1
1888 #define FF_PRED_MEDIAN 2
1891 * slice offsets in the frame in bytes
1892 * - encoding: Set/allocated by libavcodec.
1893 * - decoding: Set/allocated by user (or NULL).
1898 * sample aspect ratio (0 if unknown)
1899 * That is the width of a pixel divided by the height of the pixel.
1900 * Numerator and denominator must be relatively prime and smaller than 256 for some video standards.
1901 * - encoding: Set by user.
1902 * - decoding: Set by libavcodec.
1904 AVRational sample_aspect_ratio;
1907 * motion estimation comparison function
1908 * - encoding: Set by user.
1909 * - decoding: unused
1913 * subpixel motion estimation comparison function
1914 * - encoding: Set by user.
1915 * - decoding: unused
1919 * macroblock comparison function (not supported yet)
1920 * - encoding: Set by user.
1921 * - decoding: unused
1925 * interlaced DCT comparison function
1926 * - encoding: Set by user.
1927 * - decoding: unused
1930 #define FF_CMP_SAD 0
1931 #define FF_CMP_SSE 1
1932 #define FF_CMP_SATD 2
1933 #define FF_CMP_DCT 3
1934 #define FF_CMP_PSNR 4
1935 #define FF_CMP_BIT 5
1937 #define FF_CMP_ZERO 7
1938 #define FF_CMP_VSAD 8
1939 #define FF_CMP_VSSE 9
1940 #define FF_CMP_NSSE 10
1941 #define FF_CMP_W53 11
1942 #define FF_CMP_W97 12
1943 #define FF_CMP_DCTMAX 13
1944 #define FF_CMP_DCT264 14
1945 #define FF_CMP_CHROMA 256
1948 * ME diamond size & shape
1949 * - encoding: Set by user.
1950 * - decoding: unused
1955 * amount of previous MV predictors (2a+1 x 2a+1 square)
1956 * - encoding: Set by user.
1957 * - decoding: unused
1959 int last_predictor_count;
1962 * prepass for motion estimation
1963 * - encoding: Set by user.
1964 * - decoding: unused
1969 * motion estimation prepass comparison function
1970 * - encoding: Set by user.
1971 * - decoding: unused
1976 * ME prepass diamond size & shape
1977 * - encoding: Set by user.
1978 * - decoding: unused
1984 * - encoding: Set by user.
1985 * - decoding: unused
1987 int me_subpel_quality;
1990 * DTG active format information (additional aspect ratio
1991 * information only used in DVB MPEG-2 transport streams)
1994 * - encoding: unused
1995 * - decoding: Set by decoder.
1997 int dtg_active_format;
1998 #define FF_DTG_AFD_SAME 8
1999 #define FF_DTG_AFD_4_3 9
2000 #define FF_DTG_AFD_16_9 10
2001 #define FF_DTG_AFD_14_9 11
2002 #define FF_DTG_AFD_4_3_SP_14_9 13
2003 #define FF_DTG_AFD_16_9_SP_14_9 14
2004 #define FF_DTG_AFD_SP_4_3 15
2007 * maximum motion estimation search range in subpel units
2008 * If 0 then no limit.
2010 * - encoding: Set by user.
2011 * - decoding: unused
2016 * intra quantizer bias
2017 * - encoding: Set by user.
2018 * - decoding: unused
2020 int intra_quant_bias;
2021 #define FF_DEFAULT_QUANT_BIAS 999999
2024 * inter quantizer bias
2025 * - encoding: Set by user.
2026 * - decoding: unused
2028 int inter_quant_bias;
2030 #if FF_API_COLOR_TABLE_ID
2033 * - encoding: unused
2034 * - decoding: Which clrtable should be used for 8bit RGB images.
2035 * Tables have to be stored somewhere. FIXME
2037 attribute_deprecated int color_table_id;
2042 * - encoding: unused
2043 * - decoding: Set by user.
2046 #define SLICE_FLAG_CODED_ORDER 0x0001 ///< draw_horiz_band() is called in coded order instead of display
2047 #define SLICE_FLAG_ALLOW_FIELD 0x0002 ///< allow draw_horiz_band() with field slices (MPEG2 field pics)
2048 #define SLICE_FLAG_ALLOW_PLANE 0x0004 ///< allow draw_horiz_band() with 1 component at a time (SVQ1)
2051 * XVideo Motion Acceleration
2052 * - encoding: forbidden
2053 * - decoding: set by decoder
2055 int xvmc_acceleration;
2058 * macroblock decision mode
2059 * - encoding: Set by user.
2060 * - decoding: unused
2063 #define FF_MB_DECISION_SIMPLE 0 ///< uses mb_cmp
2064 #define FF_MB_DECISION_BITS 1 ///< chooses the one which needs the fewest bits
2065 #define FF_MB_DECISION_RD 2 ///< rate distortion
2068 * custom intra quantization matrix
2069 * - encoding: Set by user, can be NULL.
2070 * - decoding: Set by libavcodec.
2072 uint16_t *intra_matrix;
2075 * custom inter quantization matrix
2076 * - encoding: Set by user, can be NULL.
2077 * - decoding: Set by libavcodec.
2079 uint16_t *inter_matrix;
2082 * scene change detection threshold
2083 * 0 is default, larger means fewer detected scene changes.
2084 * - encoding: Set by user.
2085 * - decoding: unused
2087 int scenechange_threshold;
2090 * noise reduction strength
2091 * - encoding: Set by user.
2092 * - decoding: unused
2094 int noise_reduction;
2096 #if FF_API_INTER_THRESHOLD
2098 * @deprecated this field is unused
2100 attribute_deprecated int inter_threshold;
2103 #if FF_API_MPV_GLOBAL_OPTS
2105 * @deprecated use mpegvideo private options instead
2107 attribute_deprecated int quantizer_noise_shaping;
2111 * Motion estimation threshold below which no motion estimation is
2112 * performed, but instead the user specified motion vectors are used.
2114 * - encoding: Set by user.
2115 * - decoding: unused
2120 * Macroblock threshold below which the user specified macroblock types will be used.
2121 * - encoding: Set by user.
2122 * - decoding: unused
2127 * precision of the intra DC coefficient - 8
2128 * - encoding: Set by user.
2129 * - decoding: unused
2131 int intra_dc_precision;
2134 * Number of macroblock rows at the top which are skipped.
2135 * - encoding: unused
2136 * - decoding: Set by user.
2141 * Number of macroblock rows at the bottom which are skipped.
2142 * - encoding: unused
2143 * - decoding: Set by user.
2148 * Border processing masking, raises the quantizer for mbs on the borders
2150 * - encoding: Set by user.
2151 * - decoding: unused
2153 float border_masking;
2156 * minimum MB lagrange multipler
2157 * - encoding: Set by user.
2158 * - decoding: unused
2163 * maximum MB lagrange multipler
2164 * - encoding: Set by user.
2165 * - decoding: unused
2171 * - encoding: Set by user.
2172 * - decoding: unused
2174 int me_penalty_compensation;
2178 * - encoding: Set by user.
2179 * - decoding: unused
2185 * - encoding: Set by user.
2186 * - decoding: unused
2192 * - encoding: Set by user.
2193 * - decoding: unused
2198 * number of reference frames
2199 * - encoding: Set by user.
2200 * - decoding: Set by lavc.
2205 * chroma qp offset from luma
2206 * - encoding: Set by user.
2207 * - decoding: unused
2212 * Multiplied by qscale for each frame and added to scene_change_score.
2213 * - encoding: Set by user.
2214 * - decoding: unused
2216 int scenechange_factor;
2220 * Note: Value depends upon the compare function used for fullpel ME.
2221 * - encoding: Set by user.
2222 * - decoding: unused
2227 * Adjust sensitivity of b_frame_strategy 1.
2228 * - encoding: Set by user.
2229 * - decoding: unused
2234 * Chromaticity coordinates of the source primaries.
2235 * - encoding: Set by user
2236 * - decoding: Set by libavcodec
2238 enum AVColorPrimaries color_primaries;
2241 * Color Transfer Characteristic.
2242 * - encoding: Set by user
2243 * - decoding: Set by libavcodec
2245 enum AVColorTransferCharacteristic color_trc;
2248 * YUV colorspace type.
2249 * - encoding: Set by user
2250 * - decoding: Set by libavcodec
2252 enum AVColorSpace colorspace;
2255 * MPEG vs JPEG YUV range.
2256 * - encoding: Set by user
2257 * - decoding: Set by libavcodec
2259 enum AVColorRange color_range;
2262 * This defines the location of chroma samples.
2263 * - encoding: Set by user
2264 * - decoding: Set by libavcodec
2266 enum AVChromaLocation chroma_sample_location;
2270 * Indicates number of picture subdivisions. Used for parallelized
2272 * - encoding: Set by user
2273 * - decoding: unused
2278 * - encoding: set by libavcodec
2279 * - decoding: Set by user.
2281 enum AVFieldOrder field_order;
2284 int sample_rate; ///< samples per second
2285 int channels; ///< number of audio channels
2288 * audio sample format
2289 * - encoding: Set by user.
2290 * - decoding: Set by libavcodec.
2292 enum AVSampleFormat sample_fmt; ///< sample format
2294 /* The following data should not be initialized. */
2296 * Number of samples per channel in an audio frame.
2298 * - encoding: set by libavcodec in avcodec_open2(). Each submitted frame
2299 * except the last must contain exactly frame_size samples per channel.
2300 * May be 0 when the codec has CODEC_CAP_VARIABLE_FRAME_SIZE set, then the
2301 * frame size is not restricted.
2302 * - decoding: may be set by some decoders to indicate constant frame size
2307 * Frame counter, set by libavcodec.
2309 * - decoding: total number of frames returned from the decoder so far.
2310 * - encoding: total number of frames passed to the encoder so far.
2312 * @note the counter is not incremented if encoding/decoding resulted in
2318 * number of bytes per packet if constant and known or 0
2319 * Used by some WAV based audio codecs.
2324 * Audio cutoff bandwidth (0 means "automatic")
2325 * - encoding: Set by user.
2326 * - decoding: unused
2330 #if FF_API_REQUEST_CHANNELS
2332 * Decoder should decode to this many channels if it can (0 for default)
2333 * - encoding: unused
2334 * - decoding: Set by user.
2335 * @deprecated Deprecated in favor of request_channel_layout.
2337 int request_channels;
2341 * Audio channel layout.
2342 * - encoding: set by user.
2343 * - decoding: set by user, may be overwritten by libavcodec.
2345 uint64_t channel_layout;
2348 * Request decoder to use this channel layout if it can (0 for default)
2349 * - encoding: unused
2350 * - decoding: Set by user.
2352 uint64_t request_channel_layout;
2355 * Type of service that the audio stream conveys.
2356 * - encoding: Set by user.
2357 * - decoding: Set by libavcodec.
2359 enum AVAudioServiceType audio_service_type;
2362 * desired sample format
2363 * - encoding: Not used.
2364 * - decoding: Set by user.
2365 * Decoder will decode to this format if it can.
2367 enum AVSampleFormat request_sample_fmt;
2370 * Called at the beginning of each frame to get a buffer for it.
2372 * The function will set AVFrame.data[], AVFrame.linesize[].
2373 * AVFrame.extended_data[] must also be set, but it should be the same as
2374 * AVFrame.data[] except for planar audio with more channels than can fit
2375 * in AVFrame.data[]. In that case, AVFrame.data[] shall still contain as
2376 * many data pointers as it can hold.
2378 * if CODEC_CAP_DR1 is not set then get_buffer() must call
2379 * avcodec_default_get_buffer() instead of providing buffers allocated by
2382 * AVFrame.data[] should be 32- or 16-byte-aligned unless the CPU doesn't
2383 * need it. avcodec_default_get_buffer() aligns the output buffer properly,
2384 * but if get_buffer() is overridden then alignment considerations should
2385 * be taken into account.
2387 * @see avcodec_default_get_buffer()
2391 * If pic.reference is set then the frame will be read later by libavcodec.
2392 * avcodec_align_dimensions2() should be used to find the required width and
2393 * height, as they normally need to be rounded up to the next multiple of 16.
2395 * If frame multithreading is used and thread_safe_callbacks is set,
2396 * it may be called from a different thread, but not from more than one at
2397 * once. Does not need to be reentrant.
2399 * @see release_buffer(), reget_buffer()
2400 * @see avcodec_align_dimensions2()
2404 * Decoders request a buffer of a particular size by setting
2405 * AVFrame.nb_samples prior to calling get_buffer(). The decoder may,
2406 * however, utilize only part of the buffer by setting AVFrame.nb_samples
2407 * to a smaller value in the output frame.
2409 * Decoders cannot use the buffer after returning from
2410 * avcodec_decode_audio4(), so they will not call release_buffer(), as it
2411 * is assumed to be released immediately upon return. In some rare cases,
2412 * a decoder may need to call get_buffer() more than once in a single
2413 * call to avcodec_decode_audio4(). In that case, when get_buffer() is
2414 * called again after it has already been called once, the previously
2415 * acquired buffer is assumed to be released at that time and may not be
2416 * reused by the decoder.
2418 * As a convenience, av_samples_get_buffer_size() and
2419 * av_samples_fill_arrays() in libavutil may be used by custom get_buffer()
2420 * functions to find the required data size and to fill data pointers and
2421 * linesize. In AVFrame.linesize, only linesize[0] may be set for audio
2422 * since all planes must be the same size.
2424 * @see av_samples_get_buffer_size(), av_samples_fill_arrays()
2426 * - encoding: unused
2427 * - decoding: Set by libavcodec, user can override.
2429 int (*get_buffer)(struct AVCodecContext *c, AVFrame *pic);
2432 * Called to release buffers which were allocated with get_buffer.
2433 * A released buffer can be reused in get_buffer().
2434 * pic.data[*] must be set to NULL.
2435 * May be called from a different thread if frame multithreading is used,
2436 * but not by more than one thread at once, so does not need to be reentrant.
2437 * - encoding: unused
2438 * - decoding: Set by libavcodec, user can override.
2440 void (*release_buffer)(struct AVCodecContext *c, AVFrame *pic);
2443 * Called at the beginning of a frame to get cr buffer for it.
2444 * Buffer type (size, hints) must be the same. libavcodec won't check it.
2445 * libavcodec will pass previous buffer in pic, function should return
2446 * same buffer or new buffer with old frame "painted" into it.
2447 * If pic.data[0] == NULL must behave like get_buffer().
2448 * if CODEC_CAP_DR1 is not set then reget_buffer() must call
2449 * avcodec_default_reget_buffer() instead of providing buffers allocated by
2451 * - encoding: unused
2452 * - decoding: Set by libavcodec, user can override.
2454 int (*reget_buffer)(struct AVCodecContext *c, AVFrame *pic);
2457 /* - encoding parameters */
2458 float qcompress; ///< amount of qscale change between easy & hard scenes (0.0-1.0)
2459 float qblur; ///< amount of qscale smoothing over time (0.0-1.0)
2463 * - encoding: Set by user.
2464 * - decoding: unused
2470 * - encoding: Set by user.
2471 * - decoding: unused
2476 * maximum quantizer difference between frames
2477 * - encoding: Set by user.
2478 * - decoding: unused
2483 * ratecontrol qmin qmax limiting method
2484 * 0-> clipping, 1-> use a nice continuous function to limit qscale wthin qmin/qmax.
2485 * - encoding: Set by user.
2486 * - decoding: unused
2494 * decoder bitstream buffer size
2495 * - encoding: Set by user.
2496 * - decoding: unused
2501 * ratecontrol override, see RcOverride
2502 * - encoding: Allocated/set/freed by user.
2503 * - decoding: unused
2505 int rc_override_count;
2506 RcOverride *rc_override;
2509 * rate control equation
2510 * - encoding: Set by user
2511 * - decoding: unused
2517 * - encoding: Set by user.
2518 * - decoding: unused
2524 * - encoding: Set by user.
2525 * - decoding: unused
2529 float rc_buffer_aggressivity;
2532 * initial complexity for pass1 ratecontrol
2533 * - encoding: Set by user.
2534 * - decoding: unused
2536 float rc_initial_cplx;
2539 * Ratecontrol attempt to use, at maximum, <value> of what can be used without an underflow.
2540 * - encoding: Set by user.
2541 * - decoding: unused.
2543 float rc_max_available_vbv_use;
2546 * Ratecontrol attempt to use, at least, <value> times the amount needed to prevent a vbv overflow.
2547 * - encoding: Set by user.
2548 * - decoding: unused.
2550 float rc_min_vbv_overflow_use;
2553 * Number of bits which should be loaded into the rc buffer before decoding starts.
2554 * - encoding: Set by user.
2555 * - decoding: unused
2557 int rc_initial_buffer_occupancy;
2559 #define FF_CODER_TYPE_VLC 0
2560 #define FF_CODER_TYPE_AC 1
2561 #define FF_CODER_TYPE_RAW 2
2562 #define FF_CODER_TYPE_RLE 3
2563 #define FF_CODER_TYPE_DEFLATE 4
2566 * - encoding: Set by user.
2567 * - decoding: unused
2573 * - encoding: Set by user.
2574 * - decoding: unused
2579 * minimum Lagrange multipler
2580 * - encoding: Set by user.
2581 * - decoding: unused
2586 * maximum Lagrange multipler
2587 * - encoding: Set by user.
2588 * - decoding: unused
2593 * frame skip threshold
2594 * - encoding: Set by user.
2595 * - decoding: unused
2597 int frame_skip_threshold;
2601 * - encoding: Set by user.
2602 * - decoding: unused
2604 int frame_skip_factor;
2607 * frame skip exponent
2608 * - encoding: Set by user.
2609 * - decoding: unused
2614 * frame skip comparison function
2615 * - encoding: Set by user.
2616 * - decoding: unused
2621 * trellis RD quantization
2622 * - encoding: Set by user.
2623 * - decoding: unused
2628 * - encoding: Set by user.
2629 * - decoding: unused
2631 int min_prediction_order;
2634 * - encoding: Set by user.
2635 * - decoding: unused
2637 int max_prediction_order;
2640 * GOP timecode frame start number
2641 * - encoding: Set by user, in non drop frame format
2642 * - decoding: Set by libavcodec (timecode in the 25 bits format, -1 if unset)
2644 int64_t timecode_frame_start;
2646 /* The RTP callback: This function is called */
2647 /* every time the encoder has a packet to send. */
2648 /* It depends on the encoder if the data starts */
2649 /* with a Start Code (it should). H.263 does. */
2650 /* mb_nb contains the number of macroblocks */
2651 /* encoded in the RTP payload. */
2652 void (*rtp_callback)(struct AVCodecContext *avctx, void *data, int size, int mb_nb);
2654 int rtp_payload_size; /* The size of the RTP payload: the coder will */
2655 /* do its best to deliver a chunk with size */
2656 /* below rtp_payload_size, the chunk will start */
2657 /* with a start code on some codecs like H.263. */
2658 /* This doesn't take account of any particular */
2659 /* headers inside the transmitted RTP payload. */
2661 /* statistics, used for 2-pass encoding */
2672 * number of bits used for the previously encoded frame
2673 * - encoding: Set by libavcodec.
2674 * - decoding: unused
2679 * pass1 encoding statistics output buffer
2680 * - encoding: Set by libavcodec.
2681 * - decoding: unused
2686 * pass2 encoding statistics input buffer
2687 * Concatenated stuff from stats_out of pass1 should be placed here.
2688 * - encoding: Allocated/set/freed by user.
2689 * - decoding: unused
2694 * Work around bugs in encoders which sometimes cannot be detected automatically.
2695 * - encoding: Set by user
2696 * - decoding: Set by user
2698 int workaround_bugs;
2699 #define FF_BUG_AUTODETECT 1 ///< autodetection
2700 #define FF_BUG_OLD_MSMPEG4 2
2701 #define FF_BUG_XVID_ILACE 4
2702 #define FF_BUG_UMP4 8
2703 #define FF_BUG_NO_PADDING 16
2704 #define FF_BUG_AMV 32
2705 #define FF_BUG_AC_VLC 0 ///< Will be removed, libavcodec can now handle these non-compliant files by default.
2706 #define FF_BUG_QPEL_CHROMA 64
2707 #define FF_BUG_STD_QPEL 128
2708 #define FF_BUG_QPEL_CHROMA2 256
2709 #define FF_BUG_DIRECT_BLOCKSIZE 512
2710 #define FF_BUG_EDGE 1024
2711 #define FF_BUG_HPEL_CHROMA 2048
2712 #define FF_BUG_DC_CLIP 4096
2713 #define FF_BUG_MS 8192 ///< Work around various bugs in Microsoft's broken decoders.
2714 #define FF_BUG_TRUNCATED 16384
2717 * strictly follow the standard (MPEG4, ...).
2718 * - encoding: Set by user.
2719 * - decoding: Set by user.
2720 * Setting this to STRICT or higher means the encoder and decoder will
2721 * generally do stupid things, whereas setting it to unofficial or lower
2722 * will mean the encoder might produce output that is not supported by all
2723 * spec-compliant decoders. Decoders don't differentiate between normal,
2724 * unofficial and experimental (that is, they always try to decode things
2725 * when they can) unless they are explicitly asked to behave stupidly
2726 * (=strictly conform to the specs)
2728 int strict_std_compliance;
2729 #define FF_COMPLIANCE_VERY_STRICT 2 ///< Strictly conform to an older more strict version of the spec or reference software.
2730 #define FF_COMPLIANCE_STRICT 1 ///< Strictly conform to all the things in the spec no matter what consequences.
2731 #define FF_COMPLIANCE_NORMAL 0
2732 #define FF_COMPLIANCE_UNOFFICIAL -1 ///< Allow unofficial extensions
2733 #define FF_COMPLIANCE_EXPERIMENTAL -2 ///< Allow nonstandardized experimental things.
2736 * error concealment flags
2737 * - encoding: unused
2738 * - decoding: Set by user.
2740 int error_concealment;
2741 #define FF_EC_GUESS_MVS 1
2742 #define FF_EC_DEBLOCK 2
2746 * - encoding: Set by user.
2747 * - decoding: Set by user.
2750 #define FF_DEBUG_PICT_INFO 1
2751 #define FF_DEBUG_RC 2
2752 #define FF_DEBUG_BITSTREAM 4
2753 #define FF_DEBUG_MB_TYPE 8
2754 #define FF_DEBUG_QP 16
2755 #define FF_DEBUG_MV 32
2756 #define FF_DEBUG_DCT_COEFF 0x00000040
2757 #define FF_DEBUG_SKIP 0x00000080
2758 #define FF_DEBUG_STARTCODE 0x00000100
2759 #define FF_DEBUG_PTS 0x00000200
2760 #define FF_DEBUG_ER 0x00000400
2761 #define FF_DEBUG_MMCO 0x00000800
2762 #define FF_DEBUG_BUGS 0x00001000
2763 #define FF_DEBUG_VIS_QP 0x00002000
2764 #define FF_DEBUG_VIS_MB_TYPE 0x00004000
2765 #define FF_DEBUG_BUFFERS 0x00008000
2766 #define FF_DEBUG_THREADS 0x00010000
2770 * - encoding: Set by user.
2771 * - decoding: Set by user.
2774 #define FF_DEBUG_VIS_MV_P_FOR 0x00000001 //visualize forward predicted MVs of P frames
2775 #define FF_DEBUG_VIS_MV_B_FOR 0x00000002 //visualize forward predicted MVs of B frames
2776 #define FF_DEBUG_VIS_MV_B_BACK 0x00000004 //visualize backward predicted MVs of B frames
2779 * Error recognition; may misdetect some more or less valid parts as errors.
2780 * - encoding: unused
2781 * - decoding: Set by user.
2783 int err_recognition;
2784 #define AV_EF_CRCCHECK (1<<0)
2785 #define AV_EF_BITSTREAM (1<<1)
2786 #define AV_EF_BUFFER (1<<2)
2787 #define AV_EF_EXPLODE (1<<3)
2789 #define AV_EF_CAREFUL (1<<16)
2790 #define AV_EF_COMPLIANT (1<<17)
2791 #define AV_EF_AGGRESSIVE (1<<18)
2795 * opaque 64bit number (generally a PTS) that will be reordered and
2796 * output in AVFrame.reordered_opaque
2797 * @deprecated in favor of pkt_pts
2798 * - encoding: unused
2799 * - decoding: Set by user.
2801 int64_t reordered_opaque;
2804 * Hardware accelerator in use
2805 * - encoding: unused.
2806 * - decoding: Set by libavcodec
2808 struct AVHWAccel *hwaccel;
2811 * Hardware accelerator context.
2812 * For some hardware accelerators, a global context needs to be
2813 * provided by the user. In that case, this holds display-dependent
2814 * data FFmpeg cannot instantiate itself. Please refer to the
2815 * FFmpeg HW accelerator documentation to know how to fill this
2816 * is. e.g. for VA API, this is a struct vaapi_context.
2817 * - encoding: unused
2818 * - decoding: Set by user
2820 void *hwaccel_context;
2824 * - encoding: Set by libavcodec if flags&CODEC_FLAG_PSNR.
2825 * - decoding: unused
2827 uint64_t error[AV_NUM_DATA_POINTERS];
2830 * DCT algorithm, see FF_DCT_* below
2831 * - encoding: Set by user.
2832 * - decoding: unused
2835 #define FF_DCT_AUTO 0
2836 #define FF_DCT_FASTINT 1
2837 #define FF_DCT_INT 2
2838 #define FF_DCT_MMX 3
2839 #define FF_DCT_ALTIVEC 5
2840 #define FF_DCT_FAAN 6
2843 * IDCT algorithm, see FF_IDCT_* below.
2844 * - encoding: Set by user.
2845 * - decoding: Set by user.
2848 #define FF_IDCT_AUTO 0
2849 #define FF_IDCT_INT 1
2850 #define FF_IDCT_SIMPLE 2
2851 #define FF_IDCT_SIMPLEMMX 3
2852 #define FF_IDCT_LIBMPEG2MMX 4
2854 #define FF_IDCT_MMI 5
2856 #define FF_IDCT_ARM 7
2857 #define FF_IDCT_ALTIVEC 8
2858 #define FF_IDCT_SH4 9
2859 #define FF_IDCT_SIMPLEARM 10
2860 #define FF_IDCT_H264 11
2861 #define FF_IDCT_VP3 12
2862 #define FF_IDCT_IPP 13
2863 #define FF_IDCT_XVIDMMX 14
2864 #define FF_IDCT_CAVS 15
2865 #define FF_IDCT_SIMPLEARMV5TE 16
2866 #define FF_IDCT_SIMPLEARMV6 17
2867 #define FF_IDCT_SIMPLEVIS 18
2868 #define FF_IDCT_WMV2 19
2869 #define FF_IDCT_FAAN 20
2870 #define FF_IDCT_EA 21
2871 #define FF_IDCT_SIMPLENEON 22
2872 #define FF_IDCT_SIMPLEALPHA 23
2873 #define FF_IDCT_BINK 24
2878 * @deprecated use av_set_cpu_flags_mask() instead.
2880 attribute_deprecated unsigned dsp_mask;
2884 * bits per sample/pixel from the demuxer (needed for huffyuv).
2885 * - encoding: Set by libavcodec.
2886 * - decoding: Set by user.
2888 int bits_per_coded_sample;
2891 * Bits per sample/pixel of internal libavcodec pixel/sample format.
2892 * - encoding: set by user.
2893 * - decoding: set by libavcodec.
2895 int bits_per_raw_sample;
2898 * low resolution decoding, 1-> 1/2 size, 2->1/4 size
2899 * - encoding: unused
2900 * - decoding: Set by user.
2905 * the picture in the bitstream
2906 * - encoding: Set by libavcodec.
2907 * - decoding: Set by libavcodec.
2909 AVFrame *coded_frame;
2913 * is used to decide how many independent tasks should be passed to execute()
2914 * - encoding: Set by user.
2915 * - decoding: Set by user.
2920 * Which multithreading methods to use.
2921 * Use of FF_THREAD_FRAME will increase decoding delay by one frame per thread,
2922 * so clients which cannot provide future frames should not use it.
2924 * - encoding: Set by user, otherwise the default is used.
2925 * - decoding: Set by user, otherwise the default is used.
2928 #define FF_THREAD_FRAME 1 ///< Decode more than one frame at once
2929 #define FF_THREAD_SLICE 2 ///< Decode more than one part of a single frame at once
2932 * Which multithreading methods are in use by the codec.
2933 * - encoding: Set by libavcodec.
2934 * - decoding: Set by libavcodec.
2936 int active_thread_type;
2939 * Set by the client if its custom get_buffer() callback can be called
2940 * synchronously from another thread, which allows faster multithreaded decoding.
2941 * draw_horiz_band() will be called from other threads regardless of this setting.
2942 * Ignored if the default get_buffer() is used.
2943 * - encoding: Set by user.
2944 * - decoding: Set by user.
2946 int thread_safe_callbacks;
2949 * The codec may call this to execute several independent things.
2950 * It will return only after finishing all tasks.
2951 * The user may replace this with some multithreaded implementation,
2952 * the default implementation will execute the parts serially.
2953 * @param count the number of things to execute
2954 * - encoding: Set by libavcodec, user can override.
2955 * - decoding: Set by libavcodec, user can override.
2957 int (*execute)(struct AVCodecContext *c, int (*func)(struct AVCodecContext *c2, void *arg), void *arg2, int *ret, int count, int size);
2960 * The codec may call this to execute several independent things.
2961 * It will return only after finishing all tasks.
2962 * The user may replace this with some multithreaded implementation,
2963 * the default implementation will execute the parts serially.
2964 * Also see avcodec_thread_init and e.g. the --enable-pthread configure option.
2965 * @param c context passed also to func
2966 * @param count the number of things to execute
2967 * @param arg2 argument passed unchanged to func
2968 * @param ret return values of executed functions, must have space for "count" values. May be NULL.
2969 * @param func function that will be called count times, with jobnr from 0 to count-1.
2970 * threadnr will be in the range 0 to c->thread_count-1 < MAX_THREADS and so that no
2971 * two instances of func executing at the same time will have the same threadnr.
2972 * @return always 0 currently, but code should handle a future improvement where when any call to func
2973 * returns < 0 no further calls to func may be done and < 0 is returned.
2974 * - encoding: Set by libavcodec, user can override.
2975 * - decoding: Set by libavcodec, user can override.
2977 int (*execute2)(struct AVCodecContext *c, int (*func)(struct AVCodecContext *c2, void *arg, int jobnr, int threadnr), void *arg2, int *ret, int count);
2981 * Can be used by execute() to store some per AVCodecContext stuff.
2982 * - encoding: set by execute()
2983 * - decoding: set by execute()
2985 void *thread_opaque;
2988 * noise vs. sse weight for the nsse comparsion function
2989 * - encoding: Set by user.
2990 * - decoding: unused
2996 * - encoding: Set by user.
2997 * - decoding: Set by libavcodec.
3000 #define FF_PROFILE_UNKNOWN -99
3001 #define FF_PROFILE_RESERVED -100
3003 #define FF_PROFILE_AAC_MAIN 0
3004 #define FF_PROFILE_AAC_LOW 1
3005 #define FF_PROFILE_AAC_SSR 2
3006 #define FF_PROFILE_AAC_LTP 3
3007 #define FF_PROFILE_AAC_HE 4
3008 #define FF_PROFILE_AAC_HE_V2 28
3009 #define FF_PROFILE_AAC_LD 22
3010 #define FF_PROFILE_AAC_ELD 38
3012 #define FF_PROFILE_DTS 20
3013 #define FF_PROFILE_DTS_ES 30
3014 #define FF_PROFILE_DTS_96_24 40
3015 #define FF_PROFILE_DTS_HD_HRA 50
3016 #define FF_PROFILE_DTS_HD_MA 60
3018 #define FF_PROFILE_MPEG2_422 0
3019 #define FF_PROFILE_MPEG2_HIGH 1
3020 #define FF_PROFILE_MPEG2_SS 2
3021 #define FF_PROFILE_MPEG2_SNR_SCALABLE 3
3022 #define FF_PROFILE_MPEG2_MAIN 4
3023 #define FF_PROFILE_MPEG2_SIMPLE 5
3025 #define FF_PROFILE_H264_CONSTRAINED (1<<9) // 8+1; constraint_set1_flag
3026 #define FF_PROFILE_H264_INTRA (1<<11) // 8+3; constraint_set3_flag
3028 #define FF_PROFILE_H264_BASELINE 66
3029 #define FF_PROFILE_H264_CONSTRAINED_BASELINE (66|FF_PROFILE_H264_CONSTRAINED)
3030 #define FF_PROFILE_H264_MAIN 77
3031 #define FF_PROFILE_H264_EXTENDED 88
3032 #define FF_PROFILE_H264_HIGH 100
3033 #define FF_PROFILE_H264_HIGH_10 110
3034 #define FF_PROFILE_H264_HIGH_10_INTRA (110|FF_PROFILE_H264_INTRA)
3035 #define FF_PROFILE_H264_HIGH_422 122
3036 #define FF_PROFILE_H264_HIGH_422_INTRA (122|FF_PROFILE_H264_INTRA)
3037 #define FF_PROFILE_H264_HIGH_444 144
3038 #define FF_PROFILE_H264_HIGH_444_PREDICTIVE 244
3039 #define FF_PROFILE_H264_HIGH_444_INTRA (244|FF_PROFILE_H264_INTRA)
3040 #define FF_PROFILE_H264_CAVLC_444 44
3042 #define FF_PROFILE_VC1_SIMPLE 0
3043 #define FF_PROFILE_VC1_MAIN 1
3044 #define FF_PROFILE_VC1_COMPLEX 2
3045 #define FF_PROFILE_VC1_ADVANCED 3
3047 #define FF_PROFILE_MPEG4_SIMPLE 0
3048 #define FF_PROFILE_MPEG4_SIMPLE_SCALABLE 1
3049 #define FF_PROFILE_MPEG4_CORE 2
3050 #define FF_PROFILE_MPEG4_MAIN 3
3051 #define FF_PROFILE_MPEG4_N_BIT 4
3052 #define FF_PROFILE_MPEG4_SCALABLE_TEXTURE 5
3053 #define FF_PROFILE_MPEG4_SIMPLE_FACE_ANIMATION 6
3054 #define FF_PROFILE_MPEG4_BASIC_ANIMATED_TEXTURE 7
3055 #define FF_PROFILE_MPEG4_HYBRID 8
3056 #define FF_PROFILE_MPEG4_ADVANCED_REAL_TIME 9
3057 #define FF_PROFILE_MPEG4_CORE_SCALABLE 10
3058 #define FF_PROFILE_MPEG4_ADVANCED_CODING 11
3059 #define FF_PROFILE_MPEG4_ADVANCED_CORE 12
3060 #define FF_PROFILE_MPEG4_ADVANCED_SCALABLE_TEXTURE 13
3061 #define FF_PROFILE_MPEG4_SIMPLE_STUDIO 14
3062 #define FF_PROFILE_MPEG4_ADVANCED_SIMPLE 15
3066 * - encoding: Set by user.
3067 * - decoding: Set by libavcodec.
3070 #define FF_LEVEL_UNKNOWN -99
3074 * - encoding: unused
3075 * - decoding: Set by user.
3077 enum AVDiscard skip_loop_filter;
3081 * - encoding: unused
3082 * - decoding: Set by user.
3084 enum AVDiscard skip_idct;
3088 * - encoding: unused
3089 * - decoding: Set by user.
3091 enum AVDiscard skip_frame;
3094 * Header containing style information for text subtitles.
3095 * For SUBTITLE_ASS subtitle type, it should contain the whole ASS
3096 * [Script Info] and [V4+ Styles] section, plus the [Events] line and
3097 * the Format line following. It shouldn't include any Dialogue line.
3098 * - encoding: Set/allocated/freed by user (before avcodec_open2())
3099 * - decoding: Set/allocated/freed by libavcodec (by avcodec_open2())
3101 uint8_t *subtitle_header;
3102 int subtitle_header_size;
3105 * Simulates errors in the bitstream to test error concealment.
3106 * - encoding: Set by user.
3107 * - decoding: unused
3112 * Current packet as passed into the decoder, to avoid having
3113 * to pass the packet into every function. Currently only valid
3114 * inside lavc and get/release_buffer callbacks.
3115 * - decoding: set by avcodec_decode_*, read by get_buffer() for setting pkt_pts
3116 * - encoding: unused
3121 * VBV delay coded in the last frame (in periods of a 27 MHz clock).
3122 * Used for compliant TS muxing.
3123 * - encoding: Set by libavcodec.
3124 * - decoding: unused.
3129 * Timebase in which pkt_dts/pts and AVPacket.dts/pts are.
3130 * Code outside libavcodec should access this field using:
3131 * avcodec_set_pkt_timebase(avctx)
3132 * - encoding unused.
3133 * - decodimg set by user
3135 AVRational pkt_timebase;
3139 * Code outside libavcodec should access this field using:
3140 * avcodec_get_codec_descriptior(avctx)
3141 * - encoding: unused.
3142 * - decoding: set by libavcodec.
3144 const AVCodecDescriptor *codec_descriptor;
3147 * Current statistics for PTS correction.
3148 * - decoding: maintained and used by libavcodec, not intended to be used by user apps
3149 * - encoding: unused
3151 int64_t pts_correction_num_faulty_pts; /// Number of incorrect PTS values so far
3152 int64_t pts_correction_num_faulty_dts; /// Number of incorrect DTS values so far
3153 int64_t pts_correction_last_pts; /// PTS of the last frame
3154 int64_t pts_correction_last_dts; /// DTS of the last frame
3157 * Current frame metadata.
3158 * - decoding: maintained and used by libavcodec, not intended to be used by user apps
3159 * - encoding: unused
3161 AVDictionary *metadata;
3164 AVRational av_codec_get_pkt_timebase (const AVCodecContext *avctx);
3165 void av_codec_set_pkt_timebase (AVCodecContext *avctx, AVRational val);
3167 const AVCodecDescriptor *av_codec_get_codec_descriptor(const AVCodecContext *avctx);
3168 void av_codec_set_codec_descriptor(AVCodecContext *avctx, const AVCodecDescriptor *desc);
3173 typedef struct AVProfile {
3175 const char *name; ///< short name for the profile
3178 typedef struct AVCodecDefault AVCodecDefault;
3185 typedef struct AVCodec {
3187 * Name of the codec implementation.
3188 * The name is globally unique among encoders and among decoders (but an
3189 * encoder and a decoder can share the same name).
3190 * This is the primary way to find a codec from the user perspective.
3194 * Descriptive name for the codec, meant to be more human readable than name.
3195 * You should use the NULL_IF_CONFIG_SMALL() macro to define it.
3197 const char *long_name;
3198 enum AVMediaType type;
3201 * Codec capabilities.
3205 const AVRational *supported_framerates; ///< array of supported framerates, or NULL if any, array is terminated by {0,0}
3206 const enum AVPixelFormat *pix_fmts; ///< array of supported pixel formats, or NULL if unknown, array is terminated by -1
3207 const int *supported_samplerates; ///< array of supported audio samplerates, or NULL if unknown, array is terminated by 0
3208 const enum AVSampleFormat *sample_fmts; ///< array of supported sample formats, or NULL if unknown, array is terminated by -1
3209 const uint64_t *channel_layouts; ///< array of support channel layouts, or NULL if unknown. array is terminated by 0
3210 uint8_t max_lowres; ///< maximum value for lowres supported by the decoder
3211 const AVClass *priv_class; ///< AVClass for the private context
3212 const AVProfile *profiles; ///< array of recognized profiles, or NULL if unknown, array is terminated by {FF_PROFILE_UNKNOWN}
3214 /*****************************************************************
3215 * No fields below this line are part of the public API. They
3216 * may not be used outside of libavcodec and can be changed and
3218 * New public fields should be added right above.
3219 *****************************************************************
3222 struct AVCodec *next;
3224 * @name Frame-level threading support functions
3228 * If defined, called on thread contexts when they are created.
3229 * If the codec allocates writable tables in init(), re-allocate them here.
3230 * priv_data will be set to a copy of the original.
3232 int (*init_thread_copy)(AVCodecContext *);
3234 * Copy necessary context variables from a previous thread context to the current one.
3235 * If not defined, the next thread will start automatically; otherwise, the codec
3236 * must call ff_thread_finish_setup().
3238 * dst and src will (rarely) point to the same context, in which case memcpy should be skipped.
3240 int (*update_thread_context)(AVCodecContext *dst, const AVCodecContext *src);
3244 * Private codec-specific defaults.
3246 const AVCodecDefault *defaults;
3249 * Initialize codec static data, called from avcodec_register().
3251 void (*init_static_data)(struct AVCodec *codec);
3253 int (*init)(AVCodecContext *);
3254 int (*encode_sub)(AVCodecContext *, uint8_t *buf, int buf_size,
3255 const struct AVSubtitle *sub);
3257 * Encode data to an AVPacket.
3259 * @param avctx codec context
3260 * @param avpkt output AVPacket (may contain a user-provided buffer)
3261 * @param[in] frame AVFrame containing the raw data to be encoded
3262 * @param[out] got_packet_ptr encoder sets to 0 or 1 to indicate that a
3263 * non-empty packet was returned in avpkt.
3264 * @return 0 on success, negative error code on failure
3266 int (*encode2)(AVCodecContext *avctx, AVPacket *avpkt, const AVFrame *frame,
3267 int *got_packet_ptr);
3268 int (*decode)(AVCodecContext *, void *outdata, int *outdata_size, AVPacket *avpkt);
3269 int (*close)(AVCodecContext *);
3272 * Will be called when seeking
3274 void (*flush)(AVCodecContext *);
3280 typedef struct AVHWAccel {
3282 * Name of the hardware accelerated codec.
3283 * The name is globally unique among encoders and among decoders (but an
3284 * encoder and a decoder can share the same name).
3289 * Type of codec implemented by the hardware accelerator.
3291 * See AVMEDIA_TYPE_xxx
3293 enum AVMediaType type;
3296 * Codec implemented by the hardware accelerator.
3298 * See AV_CODEC_ID_xxx
3303 * Supported pixel format.
3305 * Only hardware accelerated formats are supported here.
3307 enum AVPixelFormat pix_fmt;
3310 * Hardware accelerated codec capabilities.
3311 * see FF_HWACCEL_CODEC_CAP_*
3315 struct AVHWAccel *next;
3318 * Called at the beginning of each frame or field picture.
3320 * Meaningful frame information (codec specific) is guaranteed to
3321 * be parsed at this point. This function is mandatory.
3323 * Note that buf can be NULL along with buf_size set to 0.
3324 * Otherwise, this means the whole frame is available at this point.
3326 * @param avctx the codec context
3327 * @param buf the frame data buffer base
3328 * @param buf_size the size of the frame in bytes
3329 * @return zero if successful, a negative value otherwise
3331 int (*start_frame)(AVCodecContext *avctx, const uint8_t *buf, uint32_t buf_size);
3334 * Callback for each slice.
3336 * Meaningful slice information (codec specific) is guaranteed to
3337 * be parsed at this point. This function is mandatory.
3339 * @param avctx the codec context
3340 * @param buf the slice data buffer base
3341 * @param buf_size the size of the slice in bytes
3342 * @return zero if successful, a negative value otherwise
3344 int (*decode_slice)(AVCodecContext *avctx, const uint8_t *buf, uint32_t buf_size);
3347 * Called at the end of each frame or field picture.
3349 * The whole picture is parsed at this point and can now be sent
3350 * to the hardware accelerator. This function is mandatory.
3352 * @param avctx the codec context
3353 * @return zero if successful, a negative value otherwise
3355 int (*end_frame)(AVCodecContext *avctx);
3358 * Size of HW accelerator private data.
3360 * Private data is allocated with av_mallocz() before
3361 * AVCodecContext.get_buffer() and deallocated after
3362 * AVCodecContext.release_buffer().
3368 * @defgroup lavc_picture AVPicture
3370 * Functions for working with AVPicture
3375 * four components are given, that's all.
3376 * the last component is alpha
3378 typedef struct AVPicture {
3379 uint8_t *data[AV_NUM_DATA_POINTERS];
3380 int linesize[AV_NUM_DATA_POINTERS]; ///< number of bytes per line
3387 enum AVSubtitleType {
3390 SUBTITLE_BITMAP, ///< A bitmap, pict will be set
3393 * Plain text, the text field must be set by the decoder and is
3394 * authoritative. ass and pict fields may contain approximations.
3399 * Formatted text, the ass field must be set by the decoder and is
3400 * authoritative. pict and text fields may contain approximations.
3405 #define AV_SUBTITLE_FLAG_FORCED 0x00000001
3407 typedef struct AVSubtitleRect {
3408 int x; ///< top left corner of pict, undefined when pict is not set
3409 int y; ///< top left corner of pict, undefined when pict is not set
3410 int w; ///< width of pict, undefined when pict is not set
3411 int h; ///< height of pict, undefined when pict is not set
3412 int nb_colors; ///< number of colors in pict, undefined when pict is not set
3415 * data+linesize for the bitmap of this subtitle.
3416 * can be set for text/ass as well once they where rendered
3419 enum AVSubtitleType type;
3421 char *text; ///< 0 terminated plain UTF-8 text
3424 * 0 terminated ASS/SSA compatible event line.
3425 * The presentation of this is unaffected by the other values in this
3433 typedef struct AVSubtitle {
3434 uint16_t format; /* 0 = graphics */
3435 uint32_t start_display_time; /* relative to packet pts, in ms */
3436 uint32_t end_display_time; /* relative to packet pts, in ms */
3438 AVSubtitleRect **rects;
3439 int64_t pts; ///< Same as packet pts, in AV_TIME_BASE
3443 * If c is NULL, returns the first registered codec,
3444 * if c is non-NULL, returns the next registered codec after c,
3445 * or NULL if c is the last one.
3447 AVCodec *av_codec_next(const AVCodec *c);
3450 * Return the LIBAVCODEC_VERSION_INT constant.
3452 unsigned avcodec_version(void);
3455 * Return the libavcodec build-time configuration.
3457 const char *avcodec_configuration(void);
3460 * Return the libavcodec license.
3462 const char *avcodec_license(void);
3465 * Register the codec codec and initialize libavcodec.
3467 * @warning either this function or avcodec_register_all() must be called
3468 * before any other libavcodec functions.
3470 * @see avcodec_register_all()
3472 void avcodec_register(AVCodec *codec);
3475 * Register all the codecs, parsers and bitstream filters which were enabled at
3476 * configuration time. If you do not call this function you can select exactly
3477 * which formats you want to support, by using the individual registration
3480 * @see avcodec_register
3481 * @see av_register_codec_parser
3482 * @see av_register_bitstream_filter
3484 void avcodec_register_all(void);
3487 #if FF_API_ALLOC_CONTEXT
3489 * Allocate an AVCodecContext and set its fields to default values. The
3490 * resulting struct can be deallocated by simply calling av_free().
3492 * @return An AVCodecContext filled with default values or NULL on failure.
3493 * @see avcodec_get_context_defaults
3495 * @deprecated use avcodec_alloc_context3()
3497 attribute_deprecated
3498 AVCodecContext *avcodec_alloc_context(void);
3500 /** THIS FUNCTION IS NOT YET PART OF THE PUBLIC API!
3501 * we WILL change its arguments and name a few times! */
3502 attribute_deprecated
3503 AVCodecContext *avcodec_alloc_context2(enum AVMediaType);
3506 * Set the fields of the given AVCodecContext to default values.
3508 * @param s The AVCodecContext of which the fields should be set to default values.
3509 * @deprecated use avcodec_get_context_defaults3
3511 attribute_deprecated
3512 void avcodec_get_context_defaults(AVCodecContext *s);
3514 /** THIS FUNCTION IS NOT YET PART OF THE PUBLIC API!
3515 * we WILL change its arguments and name a few times! */
3516 attribute_deprecated
3517 void avcodec_get_context_defaults2(AVCodecContext *s, enum AVMediaType);
3521 * Allocate an AVCodecContext and set its fields to default values. The
3522 * resulting struct can be deallocated by calling avcodec_close() on it followed
3525 * @param codec if non-NULL, allocate private data and initialize defaults
3526 * for the given codec. It is illegal to then call avcodec_open2()
3527 * with a different codec.
3528 * If NULL, then the codec-specific defaults won't be initialized,
3529 * which may result in suboptimal default settings (this is
3530 * important mainly for encoders, e.g. libx264).
3532 * @return An AVCodecContext filled with default values or NULL on failure.
3533 * @see avcodec_get_context_defaults
3535 AVCodecContext *avcodec_alloc_context3(const AVCodec *codec);
3538 * Set the fields of the given AVCodecContext to default values corresponding
3539 * to the given codec (defaults may be codec-dependent).
3541 * Do not call this function if a non-NULL codec has been passed
3542 * to avcodec_alloc_context3() that allocated this AVCodecContext.
3543 * If codec is non-NULL, it is illegal to call avcodec_open2() with a
3544 * different codec on this AVCodecContext.
3546 int avcodec_get_context_defaults3(AVCodecContext *s, const AVCodec *codec);
3549 * Get the AVClass for AVCodecContext. It can be used in combination with
3550 * AV_OPT_SEARCH_FAKE_OBJ for examining options.
3552 * @see av_opt_find().
3554 const AVClass *avcodec_get_class(void);
3557 * Get the AVClass for AVFrame. It can be used in combination with
3558 * AV_OPT_SEARCH_FAKE_OBJ for examining options.
3560 * @see av_opt_find().
3562 const AVClass *avcodec_get_frame_class(void);
3565 * Get the AVClass for AVSubtitleRect. It can be used in combination with
3566 * AV_OPT_SEARCH_FAKE_OBJ for examining options.
3568 * @see av_opt_find().
3570 const AVClass *avcodec_get_subtitle_rect_class(void);
3573 * Copy the settings of the source AVCodecContext into the destination
3574 * AVCodecContext. The resulting destination codec context will be
3575 * unopened, i.e. you are required to call avcodec_open2() before you
3576 * can use this AVCodecContext to decode/encode video/audio data.
3578 * @param dest target codec context, should be initialized with
3579 * avcodec_alloc_context3(), but otherwise uninitialized
3580 * @param src source codec context
3581 * @return AVERROR() on error (e.g. memory allocation error), 0 on success
3583 int avcodec_copy_context(AVCodecContext *dest, const AVCodecContext *src);
3586 * Allocate an AVFrame and set its fields to default values. The resulting
3587 * struct must be freed using avcodec_free_frame().
3589 * @return An AVFrame filled with default values or NULL on failure.
3590 * @see avcodec_get_frame_defaults
3592 AVFrame *avcodec_alloc_frame(void);
3595 * Set the fields of the given AVFrame to default values.
3597 * @param frame The AVFrame of which the fields should be set to default values.
3599 void avcodec_get_frame_defaults(AVFrame *frame);
3602 * Free the frame and any dynamically allocated objects in it,
3603 * e.g. extended_data.
3605 * @param frame frame to be freed. The pointer will be set to NULL.
3607 * @warning this function does NOT free the data buffers themselves
3608 * (it does not know how, since they might have been allocated with
3609 * a custom get_buffer()).
3611 void avcodec_free_frame(AVFrame **frame);
3613 #if FF_API_AVCODEC_OPEN
3615 * Initialize the AVCodecContext to use the given AVCodec. Prior to using this
3616 * function the context has to be allocated.
3618 * The functions avcodec_find_decoder_by_name(), avcodec_find_encoder_by_name(),
3619 * avcodec_find_decoder() and avcodec_find_encoder() provide an easy way for
3620 * retrieving a codec.
3622 * @warning This function is not thread safe!
3625 * avcodec_register_all();
3626 * codec = avcodec_find_decoder(AV_CODEC_ID_H264);
3630 * context = avcodec_alloc_context3(codec);
3632 * if (avcodec_open(context, codec) < 0)
3636 * @param avctx The context which will be set up to use the given codec.
3637 * @param codec The codec to use within the context.
3638 * @return zero on success, a negative value on error
3639 * @see avcodec_alloc_context3, avcodec_find_decoder, avcodec_find_encoder, avcodec_close
3641 * @deprecated use avcodec_open2
3643 attribute_deprecated
3644 int avcodec_open(AVCodecContext *avctx, AVCodec *codec);
3648 * Initialize the AVCodecContext to use the given AVCodec. Prior to using this
3649 * function the context has to be allocated with avcodec_alloc_context3().
3651 * The functions avcodec_find_decoder_by_name(), avcodec_find_encoder_by_name(),
3652 * avcodec_find_decoder() and avcodec_find_encoder() provide an easy way for
3653 * retrieving a codec.
3655 * @warning This function is not thread safe!
3658 * avcodec_register_all();
3659 * av_dict_set(&opts, "b", "2.5M", 0);
3660 * codec = avcodec_find_decoder(AV_CODEC_ID_H264);
3664 * context = avcodec_alloc_context3(codec);
3666 * if (avcodec_open2(context, codec, opts) < 0)
3670 * @param avctx The context to initialize.
3671 * @param codec The codec to open this context for. If a non-NULL codec has been
3672 * previously passed to avcodec_alloc_context3() or
3673 * avcodec_get_context_defaults3() for this context, then this
3674 * parameter MUST be either NULL or equal to the previously passed
3676 * @param options A dictionary filled with AVCodecContext and codec-private options.
3677 * On return this object will be filled with options that were not found.
3679 * @return zero on success, a negative value on error
3680 * @see avcodec_alloc_context3(), avcodec_find_decoder(), avcodec_find_encoder(),
3681 * av_dict_set(), av_opt_find().
3683 int avcodec_open2(AVCodecContext *avctx, const AVCodec *codec, AVDictionary **options);
3686 * Close a given AVCodecContext and free all the data associated with it
3687 * (but not the AVCodecContext itself).
3689 * Calling this function on an AVCodecContext that hasn't been opened will free
3690 * the codec-specific data allocated in avcodec_alloc_context3() /
3691 * avcodec_get_context_defaults3() with a non-NULL codec. Subsequent calls will
3694 int avcodec_close(AVCodecContext *avctx);
3697 * Free all allocated data in the given subtitle struct.
3699 * @param sub AVSubtitle to free.
3701 void avsubtitle_free(AVSubtitle *sub);
3708 * @addtogroup lavc_packet
3713 * Default packet destructor.
3715 void av_destruct_packet(AVPacket *pkt);
3718 * Initialize optional fields of a packet with default values.
3720 * Note, this does not touch the data and size members, which have to be
3721 * initialized separately.
3725 void av_init_packet(AVPacket *pkt);
3728 * Allocate the payload of a packet and initialize its fields with
3732 * @param size wanted payload size
3733 * @return 0 if OK, AVERROR_xxx otherwise
3735 int av_new_packet(AVPacket *pkt, int size);
3738 * Reduce packet size, correctly zeroing padding
3741 * @param size new size
3743 void av_shrink_packet(AVPacket *pkt, int size);
3746 * Increase packet size, correctly zeroing padding
3749 * @param grow_by number of bytes by which to increase the size of the packet
3751 int av_grow_packet(AVPacket *pkt, int grow_by);
3754 * @warning This is a hack - the packet memory allocation stuff is broken. The
3755 * packet is allocated if it was not really allocated.
3757 int av_dup_packet(AVPacket *pkt);
3760 * Copy packet, including contents
3762 * @return 0 on success, negative AVERROR on fail
3764 int av_copy_packet(AVPacket *dst, AVPacket *src);
3769 * @param pkt packet to free
3771 void av_free_packet(AVPacket *pkt);
3774 * Allocate new information of a packet.
3777 * @param type side information type
3778 * @param size side information size
3779 * @return pointer to fresh allocated data or NULL otherwise
3781 uint8_t* av_packet_new_side_data(AVPacket *pkt, enum AVPacketSideDataType type,
3785 * Shrink the already allocated side data buffer
3788 * @param type side information type
3789 * @param size new side information size
3790 * @return 0 on success, < 0 on failure
3792 int av_packet_shrink_side_data(AVPacket *pkt, enum AVPacketSideDataType type,
3796 * Get side information from packet.
3799 * @param type desired side information type
3800 * @param size pointer for side information size to store (optional)
3801 * @return pointer to data if present or NULL otherwise
3803 uint8_t* av_packet_get_side_data(AVPacket *pkt, enum AVPacketSideDataType type,
3806 int av_packet_merge_side_data(AVPacket *pkt);
3808 int av_packet_split_side_data(AVPacket *pkt);
3816 * @addtogroup lavc_decoding
3821 * Find a registered decoder with a matching codec ID.
3823 * @param id AVCodecID of the requested decoder
3824 * @return A decoder if one was found, NULL otherwise.
3826 AVCodec *avcodec_find_decoder(enum AVCodecID id);
3829 * Find a registered decoder with the specified name.
3831 * @param name name of the requested decoder
3832 * @return A decoder if one was found, NULL otherwise.
3834 AVCodec *avcodec_find_decoder_by_name(const char *name);
3836 int avcodec_default_get_buffer(AVCodecContext *s, AVFrame *pic);
3837 void avcodec_default_release_buffer(AVCodecContext *s, AVFrame *pic);
3838 int avcodec_default_reget_buffer(AVCodecContext *s, AVFrame *pic);
3841 * Return the amount of padding in pixels which the get_buffer callback must
3842 * provide around the edge of the image for codecs which do not have the
3843 * CODEC_FLAG_EMU_EDGE flag.
3845 * @return Required padding in pixels.
3847 unsigned avcodec_get_edge_width(void);
3850 * Modify width and height values so that they will result in a memory
3851 * buffer that is acceptable for the codec if you do not use any horizontal
3854 * May only be used if a codec with CODEC_CAP_DR1 has been opened.
3855 * If CODEC_FLAG_EMU_EDGE is not set, the dimensions must have been increased
3856 * according to avcodec_get_edge_width() before.
3858 void avcodec_align_dimensions(AVCodecContext *s, int *width, int *height);
3861 * Modify width and height values so that they will result in a memory
3862 * buffer that is acceptable for the codec if you also ensure that all
3863 * line sizes are a multiple of the respective linesize_align[i].
3865 * May only be used if a codec with CODEC_CAP_DR1 has been opened.
3866 * If CODEC_FLAG_EMU_EDGE is not set, the dimensions must have been increased
3867 * according to avcodec_get_edge_width() before.
3869 void avcodec_align_dimensions2(AVCodecContext *s, int *width, int *height,
3870 int linesize_align[AV_NUM_DATA_POINTERS]);
3872 #if FF_API_OLD_DECODE_AUDIO
3874 * Wrapper function which calls avcodec_decode_audio4.
3876 * @deprecated Use avcodec_decode_audio4 instead.
3878 * Decode the audio frame of size avpkt->size from avpkt->data into samples.
3879 * Some decoders may support multiple frames in a single AVPacket, such
3880 * decoders would then just decode the first frame. In this case,
3881 * avcodec_decode_audio3 has to be called again with an AVPacket that contains
3882 * the remaining data in order to decode the second frame etc.
3884 * could be outputted, frame_size_ptr is zero. Otherwise, it is the
3885 * decompressed frame size in bytes.
3887 * @warning You must set frame_size_ptr to the allocated size of the
3888 * output buffer before calling avcodec_decode_audio3().
3890 * @warning The input buffer must be FF_INPUT_BUFFER_PADDING_SIZE larger than
3891 * the actual read bytes because some optimized bitstream readers read 32 or 64
3892 * bits at once and could read over the end.
3894 * @warning The end of the input buffer avpkt->data should be set to 0 to ensure that
3895 * no overreading happens for damaged MPEG streams.
3897 * @warning You must not provide a custom get_buffer() when using
3898 * avcodec_decode_audio3(). Doing so will override it with
3899 * avcodec_default_get_buffer. Use avcodec_decode_audio4() instead,
3900 * which does allow the application to provide a custom get_buffer().
3902 * @note You might have to align the input buffer avpkt->data and output buffer
3903 * samples. The alignment requirements depend on the CPU: On some CPUs it isn't
3904 * necessary at all, on others it won't work at all if not aligned and on others
3905 * it will work but it will have an impact on performance.
3907 * In practice, avpkt->data should have 4 byte alignment at minimum and
3908 * samples should be 16 byte aligned unless the CPU doesn't need it
3909 * (AltiVec and SSE do).
3911 * @note Codecs which have the CODEC_CAP_DELAY capability set have a delay
3912 * between input and output, these need to be fed with avpkt->data=NULL,
3913 * avpkt->size=0 at the end to return the remaining frames.
3915 * @param avctx the codec context
3916 * @param[out] samples the output buffer, sample type in avctx->sample_fmt
3917 * If the sample format is planar, each channel plane will
3918 * be the same size, with no padding between channels.
3919 * @param[in,out] frame_size_ptr the output buffer size in bytes
3920 * @param[in] avpkt The input AVPacket containing the input buffer.
3921 * You can create such packet with av_init_packet() and by then setting
3922 * data and size, some decoders might in addition need other fields.
3923 * All decoders are designed to use the least fields possible though.
3924 * @return On error a negative value is returned, otherwise the number of bytes
3925 * used or zero if no frame data was decompressed (used) from the input AVPacket.
3927 attribute_deprecated int avcodec_decode_audio3(AVCodecContext *avctx, int16_t *samples,
3928 int *frame_size_ptr,
3933 * Decode the audio frame of size avpkt->size from avpkt->data into frame.
3935 * Some decoders may support multiple frames in a single AVPacket. Such
3936 * decoders would then just decode the first frame. In this case,
3937 * avcodec_decode_audio4 has to be called again with an AVPacket containing
3938 * the remaining data in order to decode the second frame, etc...
3939 * Even if no frames are returned, the packet needs to be fed to the decoder
3940 * with remaining data until it is completely consumed or an error occurs.
3942 * @warning The input buffer, avpkt->data must be FF_INPUT_BUFFER_PADDING_SIZE
3943 * larger than the actual read bytes because some optimized bitstream
3944 * readers read 32 or 64 bits at once and could read over the end.
3946 * @note You might have to align the input buffer. The alignment requirements
3947 * depend on the CPU and the decoder.
3949 * @param avctx the codec context
3950 * @param[out] frame The AVFrame in which to store decoded audio samples.
3951 * Decoders request a buffer of a particular size by setting
3952 * AVFrame.nb_samples prior to calling get_buffer(). The
3953 * decoder may, however, only utilize part of the buffer by
3954 * setting AVFrame.nb_samples to a smaller value in the
3956 * @param[out] got_frame_ptr Zero if no frame could be decoded, otherwise it is
3958 * @param[in] avpkt The input AVPacket containing the input buffer.
3959 * At least avpkt->data and avpkt->size should be set. Some
3960 * decoders might also require additional fields to be set.
3961 * @return A negative error code is returned if an error occurred during
3962 * decoding, otherwise the number of bytes consumed from the input
3963 * AVPacket is returned.
3965 int avcodec_decode_audio4(AVCodecContext *avctx, AVFrame *frame,
3966 int *got_frame_ptr, const AVPacket *avpkt);
3969 * Decode the video frame of size avpkt->size from avpkt->data into picture.
3970 * Some decoders may support multiple frames in a single AVPacket, such
3971 * decoders would then just decode the first frame.
3973 * @warning The input buffer must be FF_INPUT_BUFFER_PADDING_SIZE larger than
3974 * the actual read bytes because some optimized bitstream readers read 32 or 64
3975 * bits at once and could read over the end.
3977 * @warning The end of the input buffer buf should be set to 0 to ensure that
3978 * no overreading happens for damaged MPEG streams.
3980 * @note You might have to align the input buffer avpkt->data.
3981 * The alignment requirements depend on the CPU: on some CPUs it isn't
3982 * necessary at all, on others it won't work at all if not aligned and on others
3983 * it will work but it will have an impact on performance.
3985 * In practice, avpkt->data should have 4 byte alignment at minimum.
3987 * @note Codecs which have the CODEC_CAP_DELAY capability set have a delay
3988 * between input and output, these need to be fed with avpkt->data=NULL,
3989 * avpkt->size=0 at the end to return the remaining frames.
3991 * @param avctx the codec context
3992 * @param[out] picture The AVFrame in which the decoded video frame will be stored.
3993 * Use avcodec_alloc_frame to get an AVFrame, the codec will
3994 * allocate memory for the actual bitmap.
3995 * with default get/release_buffer(), the decoder frees/reuses the bitmap as it sees fit.
3996 * with overridden get/release_buffer() (needs CODEC_CAP_DR1) the user decides into what buffer the decoder
3997 * decodes and the decoder tells the user once it does not need the data anymore,
3998 * the user app can at this point free/reuse/keep the memory as it sees fit.
4000 * @param[in] avpkt The input AVpacket containing the input buffer.
4001 * You can create such packet with av_init_packet() and by then setting
4002 * data and size, some decoders might in addition need other fields like
4003 * flags&AV_PKT_FLAG_KEY. All decoders are designed to use the least
4005 * @param[in,out] got_picture_ptr Zero if no frame could be decompressed, otherwise, it is nonzero.
4006 * @return On error a negative value is returned, otherwise the number of bytes
4007 * used or zero if no frame could be decompressed.
4009 int avcodec_decode_video2(AVCodecContext *avctx, AVFrame *picture,
4010 int *got_picture_ptr,
4011 const AVPacket *avpkt);
4014 * Decode a subtitle message.
4015 * Return a negative value on error, otherwise return the number of bytes used.
4016 * If no subtitle could be decompressed, got_sub_ptr is zero.
4017 * Otherwise, the subtitle is stored in *sub.
4018 * Note that CODEC_CAP_DR1 is not available for subtitle codecs. This is for
4019 * simplicity, because the performance difference is expect to be negligible
4020 * and reusing a get_buffer written for video codecs would probably perform badly
4021 * due to a potentially very different allocation pattern.
4023 * @param avctx the codec context
4024 * @param[out] sub The AVSubtitle in which the decoded subtitle will be stored, must be
4025 freed with avsubtitle_free if *got_sub_ptr is set.
4026 * @param[in,out] got_sub_ptr Zero if no subtitle could be decompressed, otherwise, it is nonzero.
4027 * @param[in] avpkt The input AVPacket containing the input buffer.
4029 int avcodec_decode_subtitle2(AVCodecContext *avctx, AVSubtitle *sub,
4034 * @defgroup lavc_parsing Frame parsing
4038 typedef struct AVCodecParserContext {
4040 struct AVCodecParser *parser;
4041 int64_t frame_offset; /* offset of the current frame */
4042 int64_t cur_offset; /* current offset
4043 (incremented by each av_parser_parse()) */
4044 int64_t next_frame_offset; /* offset of the next frame */
4046 int pict_type; /* XXX: Put it back in AVCodecContext. */
4048 * This field is used for proper frame duration computation in lavf.
4049 * It signals, how much longer the frame duration of the current frame
4050 * is compared to normal frame duration.
4052 * frame_duration = (1 + repeat_pict) * time_base
4054 * It is used by codecs like H.264 to display telecined material.
4056 int repeat_pict; /* XXX: Put it back in AVCodecContext. */
4057 int64_t pts; /* pts of the current frame */
4058 int64_t dts; /* dts of the current frame */
4063 int fetch_timestamp;
4065 #define AV_PARSER_PTS_NB 4
4066 int cur_frame_start_index;
4067 int64_t cur_frame_offset[AV_PARSER_PTS_NB];
4068 int64_t cur_frame_pts[AV_PARSER_PTS_NB];
4069 int64_t cur_frame_dts[AV_PARSER_PTS_NB];
4072 #define PARSER_FLAG_COMPLETE_FRAMES 0x0001
4073 #define PARSER_FLAG_ONCE 0x0002
4074 /// Set if the parser has a valid file offset
4075 #define PARSER_FLAG_FETCHED_OFFSET 0x0004
4076 #define PARSER_FLAG_USE_CODEC_TS 0x1000
4078 int64_t offset; ///< byte offset from starting packet start
4079 int64_t cur_frame_end[AV_PARSER_PTS_NB];
4082 * Set by parser to 1 for key frames and 0 for non-key frames.
4083 * It is initialized to -1, so if the parser doesn't set this flag,
4084 * old-style fallback using AV_PICTURE_TYPE_I picture type as key frames
4090 * Time difference in stream time base units from the pts of this
4091 * packet to the point at which the output from the decoder has converged
4092 * independent from the availability of previous frames. That is, the
4093 * frames are virtually identical no matter if decoding started from
4094 * the very first frame or from this keyframe.
4095 * Is AV_NOPTS_VALUE if unknown.
4096 * This field is not the display duration of the current frame.
4097 * This field has no meaning if the packet does not have AV_PKT_FLAG_KEY
4100 * The purpose of this field is to allow seeking in streams that have no
4101 * keyframes in the conventional sense. It corresponds to the
4102 * recovery point SEI in H.264 and match_time_delta in NUT. It is also
4103 * essential for some types of subtitle streams to ensure that all
4104 * subtitles are correctly displayed after seeking.
4106 int64_t convergence_duration;
4108 // Timestamp generation support:
4110 * Synchronization point for start of timestamp generation.
4112 * Set to >0 for sync point, 0 for no sync point and <0 for undefined
4115 * For example, this corresponds to presence of H.264 buffering period
4121 * Offset of the current timestamp against last timestamp sync point in
4122 * units of AVCodecContext.time_base.
4124 * Set to INT_MIN when dts_sync_point unused. Otherwise, it must
4125 * contain a valid timestamp offset.
4127 * Note that the timestamp of sync point has usually a nonzero
4128 * dts_ref_dts_delta, which refers to the previous sync point. Offset of
4129 * the next frame after timestamp sync point will be usually 1.
4131 * For example, this corresponds to H.264 cpb_removal_delay.
4133 int dts_ref_dts_delta;
4136 * Presentation delay of current frame in units of AVCodecContext.time_base.
4138 * Set to INT_MIN when dts_sync_point unused. Otherwise, it must
4139 * contain valid non-negative timestamp delta (presentation time of a frame
4140 * must not lie in the past).
4142 * This delay represents the difference between decoding and presentation
4143 * time of the frame.
4145 * For example, this corresponds to H.264 dpb_output_delay.
4150 * Position of the packet in file.
4152 * Analogous to cur_frame_pts/dts
4154 int64_t cur_frame_pos[AV_PARSER_PTS_NB];
4157 * Byte position of currently parsed frame in stream.
4162 * Previous frame byte position.
4167 * Duration of the current frame.
4168 * For audio, this is in units of 1 / AVCodecContext.sample_rate.
4169 * For all other types, this is in units of AVCodecContext.time_base.
4172 } AVCodecParserContext;
4174 typedef struct AVCodecParser {
4175 int codec_ids[5]; /* several codec IDs are permitted */
4177 int (*parser_init)(AVCodecParserContext *s);
4178 int (*parser_parse)(AVCodecParserContext *s,
4179 AVCodecContext *avctx,
4180 const uint8_t **poutbuf, int *poutbuf_size,
4181 const uint8_t *buf, int buf_size);
4182 void (*parser_close)(AVCodecParserContext *s);
4183 int (*split)(AVCodecContext *avctx, const uint8_t *buf, int buf_size);
4184 struct AVCodecParser *next;
4187 AVCodecParser *av_parser_next(AVCodecParser *c);
4189 void av_register_codec_parser(AVCodecParser *parser);
4190 AVCodecParserContext *av_parser_init(int codec_id);
4195 * @param s parser context.
4196 * @param avctx codec context.
4197 * @param poutbuf set to pointer to parsed buffer or NULL if not yet finished.
4198 * @param poutbuf_size set to size of parsed buffer or zero if not yet finished.
4199 * @param buf input buffer.
4200 * @param buf_size input length, to signal EOF, this should be 0 (so that the last frame can be output).
4201 * @param pts input presentation timestamp.
4202 * @param dts input decoding timestamp.
4203 * @param pos input byte position in stream.
4204 * @return the number of bytes of the input bitstream used.
4209 * len = av_parser_parse2(myparser, AVCodecContext, &data, &size,
4216 * decode_frame(data, size);
4220 int av_parser_parse2(AVCodecParserContext *s,
4221 AVCodecContext *avctx,
4222 uint8_t **poutbuf, int *poutbuf_size,
4223 const uint8_t *buf, int buf_size,
4224 int64_t pts, int64_t dts,
4228 * @return 0 if the output buffer is a subset of the input, 1 if it is allocated and must be freed
4229 * @deprecated use AVBitstreamFilter
4231 int av_parser_change(AVCodecParserContext *s,
4232 AVCodecContext *avctx,
4233 uint8_t **poutbuf, int *poutbuf_size,
4234 const uint8_t *buf, int buf_size, int keyframe);
4235 void av_parser_close(AVCodecParserContext *s);
4243 * @addtogroup lavc_encoding
4248 * Find a registered encoder with a matching codec ID.
4250 * @param id AVCodecID of the requested encoder
4251 * @return An encoder if one was found, NULL otherwise.
4253 AVCodec *avcodec_find_encoder(enum AVCodecID id);
4256 * Find a registered encoder with the specified name.
4258 * @param name name of the requested encoder
4259 * @return An encoder if one was found, NULL otherwise.
4261 AVCodec *avcodec_find_encoder_by_name(const char *name);
4263 #if FF_API_OLD_ENCODE_AUDIO
4265 * Encode an audio frame from samples into buf.
4267 * @deprecated Use avcodec_encode_audio2 instead.
4269 * @note The output buffer should be at least FF_MIN_BUFFER_SIZE bytes large.
4270 * However, for codecs with avctx->frame_size equal to 0 (e.g. PCM) the user
4271 * will know how much space is needed because it depends on the value passed
4272 * in buf_size as described below. In that case a lower value can be used.
4274 * @param avctx the codec context
4275 * @param[out] buf the output buffer
4276 * @param[in] buf_size the output buffer size
4277 * @param[in] samples the input buffer containing the samples
4278 * The number of samples read from this buffer is frame_size*channels,
4279 * both of which are defined in avctx.
4280 * For codecs which have avctx->frame_size equal to 0 (e.g. PCM) the number of
4281 * samples read from samples is equal to:
4282 * buf_size * 8 / (avctx->channels * av_get_bits_per_sample(avctx->codec_id))
4283 * This also implies that av_get_bits_per_sample() must not return 0 for these
4285 * @return On error a negative value is returned, on success zero or the number
4286 * of bytes used to encode the data read from the input buffer.
4288 int attribute_deprecated avcodec_encode_audio(AVCodecContext *avctx,
4289 uint8_t *buf, int buf_size,
4290 const short *samples);
4294 * Encode a frame of audio.
4296 * Takes input samples from frame and writes the next output packet, if
4297 * available, to avpkt. The output packet does not necessarily contain data for
4298 * the most recent frame, as encoders can delay, split, and combine input frames
4299 * internally as needed.
4301 * @param avctx codec context
4302 * @param avpkt output AVPacket.
4303 * The user can supply an output buffer by setting
4304 * avpkt->data and avpkt->size prior to calling the
4305 * function, but if the size of the user-provided data is not
4306 * large enough, encoding will fail. If avpkt->data and
4307 * avpkt->size are set, avpkt->destruct must also be set. All
4308 * other AVPacket fields will be reset by the encoder using
4309 * av_init_packet(). If avpkt->data is NULL, the encoder will
4310 * allocate it. The encoder will set avpkt->size to the size
4311 * of the output packet.
4313 * If this function fails or produces no output, avpkt will be
4314 * freed using av_free_packet() (i.e. avpkt->destruct will be
4315 * called to free the user supplied buffer).
4316 * @param[in] frame AVFrame containing the raw audio data to be encoded.
4317 * May be NULL when flushing an encoder that has the
4318 * CODEC_CAP_DELAY capability set.
4319 * If CODEC_CAP_VARIABLE_FRAME_SIZE is set, then each frame
4320 * can have any number of samples.
4321 * If it is not set, frame->nb_samples must be equal to
4322 * avctx->frame_size for all frames except the last.
4323 * The final frame may be smaller than avctx->frame_size.
4324 * @param[out] got_packet_ptr This field is set to 1 by libavcodec if the
4325 * output packet is non-empty, and to 0 if it is
4326 * empty. If the function returns an error, the
4327 * packet can be assumed to be invalid, and the
4328 * value of got_packet_ptr is undefined and should
4330 * @return 0 on success, negative error code on failure
4332 int avcodec_encode_audio2(AVCodecContext *avctx, AVPacket *avpkt,
4333 const AVFrame *frame, int *got_packet_ptr);
4335 #if FF_API_OLD_ENCODE_VIDEO
4337 * @deprecated use avcodec_encode_video2() instead.
4339 * Encode a video frame from pict into buf.
4340 * The input picture should be
4341 * stored using a specific format, namely avctx.pix_fmt.
4343 * @param avctx the codec context
4344 * @param[out] buf the output buffer for the bitstream of encoded frame
4345 * @param[in] buf_size the size of the output buffer in bytes
4346 * @param[in] pict the input picture to encode
4347 * @return On error a negative value is returned, on success zero or the number
4348 * of bytes used from the output buffer.
4350 attribute_deprecated
4351 int avcodec_encode_video(AVCodecContext *avctx, uint8_t *buf, int buf_size,
4352 const AVFrame *pict);
4356 * Encode a frame of video.
4358 * Takes input raw video data from frame and writes the next output packet, if
4359 * available, to avpkt. The output packet does not necessarily contain data for
4360 * the most recent frame, as encoders can delay and reorder input frames
4361 * internally as needed.
4363 * @param avctx codec context
4364 * @param avpkt output AVPacket.
4365 * The user can supply an output buffer by setting
4366 * avpkt->data and avpkt->size prior to calling the
4367 * function, but if the size of the user-provided data is not
4368 * large enough, encoding will fail. All other AVPacket fields
4369 * will be reset by the encoder using av_init_packet(). If
4370 * avpkt->data is NULL, the encoder will allocate it.
4371 * The encoder will set avpkt->size to the size of the
4372 * output packet. The returned data (if any) belongs to the
4373 * caller, he is responsible for freeing it.
4375 * If this function fails or produces no output, avpkt will be
4376 * freed using av_free_packet() (i.e. avpkt->destruct will be
4377 * called to free the user supplied buffer).
4378 * @param[in] frame AVFrame containing the raw video data to be encoded.
4379 * May be NULL when flushing an encoder that has the
4380 * CODEC_CAP_DELAY capability set.
4381 * @param[out] got_packet_ptr This field is set to 1 by libavcodec if the
4382 * output packet is non-empty, and to 0 if it is
4383 * empty. If the function returns an error, the
4384 * packet can be assumed to be invalid, and the
4385 * value of got_packet_ptr is undefined and should
4387 * @return 0 on success, negative error code on failure
4389 int avcodec_encode_video2(AVCodecContext *avctx, AVPacket *avpkt,
4390 const AVFrame *frame, int *got_packet_ptr);
4392 int avcodec_encode_subtitle(AVCodecContext *avctx, uint8_t *buf, int buf_size,
4393 const AVSubtitle *sub);
4400 #if FF_API_AVCODEC_RESAMPLE
4402 * @defgroup lavc_resample Audio resampling
4404 * @deprecated use libswresample instead
4408 struct ReSampleContext;
4409 struct AVResampleContext;
4411 typedef struct ReSampleContext ReSampleContext;
4414 * Initialize audio resampling context.
4416 * @param output_channels number of output channels
4417 * @param input_channels number of input channels
4418 * @param output_rate output sample rate
4419 * @param input_rate input sample rate
4420 * @param sample_fmt_out requested output sample format
4421 * @param sample_fmt_in input sample format
4422 * @param filter_length length of each FIR filter in the filterbank relative to the cutoff frequency
4423 * @param log2_phase_count log2 of the number of entries in the polyphase filterbank
4424 * @param linear if 1 then the used FIR filter will be linearly interpolated
4425 between the 2 closest, if 0 the closest will be used
4426 * @param cutoff cutoff frequency, 1.0 corresponds to half the output sampling rate
4427 * @return allocated ReSampleContext, NULL if error occurred
4429 attribute_deprecated
4430 ReSampleContext *av_audio_resample_init(int output_channels, int input_channels,
4431 int output_rate, int input_rate,
4432 enum AVSampleFormat sample_fmt_out,
4433 enum AVSampleFormat sample_fmt_in,
4434 int filter_length, int log2_phase_count,
4435 int linear, double cutoff);
4437 attribute_deprecated
4438 int audio_resample(ReSampleContext *s, short *output, short *input, int nb_samples);
4441 * Free resample context.
4443 * @param s a non-NULL pointer to a resample context previously
4444 * created with av_audio_resample_init()
4446 attribute_deprecated
4447 void audio_resample_close(ReSampleContext *s);
4451 * Initialize an audio resampler.
4452 * Note, if either rate is not an integer then simply scale both rates up so they are.
4453 * @param filter_length length of each FIR filter in the filterbank relative to the cutoff freq
4454 * @param log2_phase_count log2 of the number of entries in the polyphase filterbank
4455 * @param linear If 1 then the used FIR filter will be linearly interpolated
4456 between the 2 closest, if 0 the closest will be used
4457 * @param cutoff cutoff frequency, 1.0 corresponds to half the output sampling rate
4459 attribute_deprecated
4460 struct AVResampleContext *av_resample_init(int out_rate, int in_rate, int filter_length, int log2_phase_count, int linear, double cutoff);
4463 * Resample an array of samples using a previously configured context.
4464 * @param src an array of unconsumed samples
4465 * @param consumed the number of samples of src which have been consumed are returned here
4466 * @param src_size the number of unconsumed samples available
4467 * @param dst_size the amount of space in samples available in dst
4468 * @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.
4469 * @return the number of samples written in dst or -1 if an error occurred
4471 attribute_deprecated
4472 int av_resample(struct AVResampleContext *c, short *dst, short *src, int *consumed, int src_size, int dst_size, int update_ctx);
4476 * Compensate samplerate/timestamp drift. The compensation is done by changing
4477 * the resampler parameters, so no audible clicks or similar distortions occur
4478 * @param compensation_distance distance in output samples over which the compensation should be performed
4479 * @param sample_delta number of output samples which should be output less
4481 * example: av_resample_compensate(c, 10, 500)
4482 * here instead of 510 samples only 500 samples would be output
4484 * note, due to rounding the actual compensation might be slightly different,
4485 * especially if the compensation_distance is large and the in_rate used during init is small
4487 attribute_deprecated
4488 void av_resample_compensate(struct AVResampleContext *c, int sample_delta, int compensation_distance);
4489 attribute_deprecated
4490 void av_resample_close(struct AVResampleContext *c);
4498 * @addtogroup lavc_picture
4503 * Allocate memory for a picture. Call avpicture_free() to free it.
4505 * @see avpicture_fill()
4507 * @param picture the picture to be filled in
4508 * @param pix_fmt the format of the picture
4509 * @param width the width of the picture
4510 * @param height the height of the picture
4511 * @return zero if successful, a negative value if not
4513 int avpicture_alloc(AVPicture *picture, enum AVPixelFormat pix_fmt, int width, int height);
4516 * Free a picture previously allocated by avpicture_alloc().
4517 * The data buffer used by the AVPicture is freed, but the AVPicture structure
4520 * @param picture the AVPicture to be freed
4522 void avpicture_free(AVPicture *picture);
4525 * Fill in the AVPicture fields, always assume a linesize alignment of
4528 * @see av_image_fill_arrays()
4530 int avpicture_fill(AVPicture *picture, const uint8_t *ptr,
4531 enum AVPixelFormat pix_fmt, int width, int height);
4534 * Copy pixel data from an AVPicture into a buffer, always assume a
4535 * linesize alignment of 1.
4537 * @see av_image_copy_to_buffer()
4539 int avpicture_layout(const AVPicture* src, enum AVPixelFormat pix_fmt,
4540 int width, int height,
4541 unsigned char *dest, int dest_size);
4544 * Calculate the size in bytes that a picture of the given width and height
4545 * would occupy if stored in the given picture format.
4546 * Always assume a linesize alignment of 1.
4548 * @see av_image_get_buffer_size().
4550 int avpicture_get_size(enum AVPixelFormat pix_fmt, int width, int height);
4553 * deinterlace - if not supported return -1
4555 int avpicture_deinterlace(AVPicture *dst, const AVPicture *src,
4556 enum AVPixelFormat pix_fmt, int width, int height);
4558 * Copy image src to dst. Wraps av_image_copy().
4560 void av_picture_copy(AVPicture *dst, const AVPicture *src,
4561 enum AVPixelFormat pix_fmt, int width, int height);
4564 * Crop image top and left side.
4566 int av_picture_crop(AVPicture *dst, const AVPicture *src,
4567 enum AVPixelFormat pix_fmt, int top_band, int left_band);
4572 int av_picture_pad(AVPicture *dst, const AVPicture *src, int height, int width, enum AVPixelFormat pix_fmt,
4573 int padtop, int padbottom, int padleft, int padright, int *color);
4580 * @defgroup lavc_misc Utility functions
4583 * Miscellaneous utility functions related to both encoding and decoding
4589 * @defgroup lavc_misc_pixfmt Pixel formats
4591 * Functions for working with pixel formats.
4596 * Utility function to access log2_chroma_w log2_chroma_h from
4597 * the pixel format AVPixFmtDescriptor.
4599 * This function asserts that pix_fmt is valid. See av_pix_fmt_get_chroma_sub_sample
4600 * for one that returns a failure code and continues in case of invalid
4603 * @param[in] pix_fmt the pixel format
4604 * @param[out] h_shift store log2_chroma_h
4605 * @param[out] v_shift store log2_chroma_w
4607 * @see av_pix_fmt_get_chroma_sub_sample
4610 void avcodec_get_chroma_sub_sample(enum AVPixelFormat pix_fmt, int *h_shift, int *v_shift);
4613 * Return a value representing the fourCC code associated to the
4614 * pixel format pix_fmt, or 0 if no associated fourCC code can be
4617 unsigned int avcodec_pix_fmt_to_codec_tag(enum AVPixelFormat pix_fmt);
4619 #define FF_LOSS_RESOLUTION 0x0001 /**< loss due to resolution change */
4620 #define FF_LOSS_DEPTH 0x0002 /**< loss due to color depth change */
4621 #define FF_LOSS_COLORSPACE 0x0004 /**< loss due to color space conversion */
4622 #define FF_LOSS_ALPHA 0x0008 /**< loss of alpha bits */
4623 #define FF_LOSS_COLORQUANT 0x0010 /**< loss due to color quantization */
4624 #define FF_LOSS_CHROMA 0x0020 /**< loss of chroma (e.g. RGB to gray conversion) */
4627 * Compute what kind of losses will occur when converting from one specific
4628 * pixel format to another.
4629 * When converting from one pixel format to another, information loss may occur.
4630 * For example, when converting from RGB24 to GRAY, the color information will
4631 * be lost. Similarly, other losses occur when converting from some formats to
4632 * other formats. These losses can involve loss of chroma, but also loss of
4633 * resolution, loss of color depth, loss due to the color space conversion, loss
4634 * of the alpha bits or loss due to color quantization.
4635 * avcodec_get_fix_fmt_loss() informs you about the various types of losses
4636 * which will occur when converting from one pixel format to another.
4638 * @param[in] dst_pix_fmt destination pixel format
4639 * @param[in] src_pix_fmt source pixel format
4640 * @param[in] has_alpha Whether the source pixel format alpha channel is used.
4641 * @return Combination of flags informing you what kind of losses will occur
4642 * (maximum loss for an invalid dst_pix_fmt).
4644 int avcodec_get_pix_fmt_loss(enum AVPixelFormat dst_pix_fmt, enum AVPixelFormat src_pix_fmt,
4647 #if FF_API_FIND_BEST_PIX_FMT
4649 * @deprecated use avcodec_find_best_pix_fmt_of_2() instead.
4651 * Find the best pixel format to convert to given a certain source pixel
4652 * format. When converting from one pixel format to another, information loss
4653 * may occur. For example, when converting from RGB24 to GRAY, the color
4654 * information will be lost. Similarly, other losses occur when converting from
4655 * some formats to other formats. avcodec_find_best_pix_fmt() searches which of
4656 * the given pixel formats should be used to suffer the least amount of loss.
4657 * The pixel formats from which it chooses one, are determined by the
4658 * pix_fmt_mask parameter.
4660 * Note, only the first 64 pixel formats will fit in pix_fmt_mask.
4663 * src_pix_fmt = AV_PIX_FMT_YUV420P;
4664 * pix_fmt_mask = (1 << AV_PIX_FMT_YUV422P) | (1 << AV_PIX_FMT_RGB24);
4665 * dst_pix_fmt = avcodec_find_best_pix_fmt(pix_fmt_mask, src_pix_fmt, alpha, &loss);
4668 * @param[in] pix_fmt_mask bitmask determining which pixel format to choose from
4669 * @param[in] src_pix_fmt source pixel format
4670 * @param[in] has_alpha Whether the source pixel format alpha channel is used.
4671 * @param[out] loss_ptr Combination of flags informing you what kind of losses will occur.
4672 * @return The best pixel format to convert to or -1 if none was found.
4674 attribute_deprecated
4675 enum AVPixelFormat avcodec_find_best_pix_fmt(int64_t pix_fmt_mask, enum AVPixelFormat src_pix_fmt,
4676 int has_alpha, int *loss_ptr);
4677 #endif /* FF_API_FIND_BEST_PIX_FMT */
4680 * Find the best pixel format to convert to given a certain source pixel
4681 * format. When converting from one pixel format to another, information loss
4682 * may occur. For example, when converting from RGB24 to GRAY, the color
4683 * information will be lost. Similarly, other losses occur when converting from
4684 * some formats to other formats. avcodec_find_best_pix_fmt_of_2() searches which of
4685 * the given pixel formats should be used to suffer the least amount of loss.
4686 * The pixel formats from which it chooses one, are determined by the
4687 * pix_fmt_list parameter.
4690 * @param[in] pix_fmt_list AV_PIX_FMT_NONE terminated array of pixel formats to choose from
4691 * @param[in] src_pix_fmt source pixel format
4692 * @param[in] has_alpha Whether the source pixel format alpha channel is used.
4693 * @param[out] loss_ptr Combination of flags informing you what kind of losses will occur.
4694 * @return The best pixel format to convert to or -1 if none was found.
4696 enum AVPixelFormat avcodec_find_best_pix_fmt_of_list(enum AVPixelFormat *pix_fmt_list,
4697 enum AVPixelFormat src_pix_fmt,
4698 int has_alpha, int *loss_ptr);
4701 * Find the best pixel format to convert to given a certain source pixel
4702 * format and a selection of two destination pixel formats. When converting from
4703 * one pixel format to another, information loss may occur. For example, when converting
4704 * from RGB24 to GRAY, the color information will be lost. Similarly, other losses occur when
4705 * converting from some formats to other formats. avcodec_find_best_pix_fmt_of_2() selects which of
4706 * the given pixel formats should be used to suffer the least amount of loss.
4708 * If one of the destination formats is AV_PIX_FMT_NONE the other pixel format (if valid) will be
4712 * src_pix_fmt = AV_PIX_FMT_YUV420P;
4713 * dst_pix_fmt1= AV_PIX_FMT_RGB24;
4714 * dst_pix_fmt2= AV_PIX_FMT_GRAY8;
4715 * dst_pix_fmt3= AV_PIX_FMT_RGB8;
4716 * loss= FF_LOSS_CHROMA; // don't care about chroma loss, so chroma loss will be ignored.
4717 * dst_pix_fmt = avcodec_find_best_pix_fmt_of_2(dst_pix_fmt1, dst_pix_fmt2, src_pix_fmt, alpha, &loss);
4718 * dst_pix_fmt = avcodec_find_best_pix_fmt_of_2(dst_pix_fmt, dst_pix_fmt3, src_pix_fmt, alpha, &loss);
4721 * @param[in] dst_pix_fmt1 One of the two destination pixel formats to choose from
4722 * @param[in] dst_pix_fmt2 The other of the two destination pixel formats to choose from
4723 * @param[in] src_pix_fmt Source pixel format
4724 * @param[in] has_alpha Whether the source pixel format alpha channel is used.
4725 * @param[in, out] loss_ptr Combination of loss flags. In: selects which of the losses to ignore, i.e.
4726 * NULL or value of zero means we care about all losses. Out: the loss
4727 * that occurs when converting from src to selected dst pixel format.
4728 * @return The best pixel format to convert to or -1 if none was found.
4730 enum AVPixelFormat avcodec_find_best_pix_fmt_of_2(enum AVPixelFormat dst_pix_fmt1, enum AVPixelFormat dst_pix_fmt2,
4731 enum AVPixelFormat src_pix_fmt, int has_alpha, int *loss_ptr);
4733 attribute_deprecated
4734 #if AV_HAVE_INCOMPATIBLE_FORK_ABI
4735 enum AVPixelFormat avcodec_find_best_pix_fmt2(enum AVPixelFormat *pix_fmt_list,
4736 enum AVPixelFormat src_pix_fmt,
4737 int has_alpha, int *loss_ptr);
4739 enum AVPixelFormat avcodec_find_best_pix_fmt2(enum AVPixelFormat dst_pix_fmt1, enum AVPixelFormat dst_pix_fmt2,
4740 enum AVPixelFormat src_pix_fmt, int has_alpha, int *loss_ptr);
4744 enum AVPixelFormat avcodec_default_get_format(struct AVCodecContext *s, const enum AVPixelFormat * fmt);
4750 void avcodec_set_dimensions(AVCodecContext *s, int width, int height);
4753 * Put a string representing the codec tag codec_tag in buf.
4755 * @param buf_size size in bytes of buf
4756 * @return the length of the string that would have been generated if
4757 * enough space had been available, excluding the trailing null
4759 size_t av_get_codec_tag_string(char *buf, size_t buf_size, unsigned int codec_tag);
4761 void avcodec_string(char *buf, int buf_size, AVCodecContext *enc, int encode);
4764 * Return a name for the specified profile, if available.
4766 * @param codec the codec that is searched for the given profile
4767 * @param profile the profile value for which a name is requested
4768 * @return A name for the profile if found, NULL otherwise.
4770 const char *av_get_profile_name(const AVCodec *codec, int profile);
4772 int avcodec_default_execute(AVCodecContext *c, int (*func)(AVCodecContext *c2, void *arg2),void *arg, int *ret, int count, int size);
4773 int avcodec_default_execute2(AVCodecContext *c, int (*func)(AVCodecContext *c2, void *arg2, int, int),void *arg, int *ret, int count);
4774 //FIXME func typedef
4777 * Fill AVFrame audio data and linesize pointers.
4779 * The buffer buf must be a preallocated buffer with a size big enough
4780 * to contain the specified samples amount. The filled AVFrame data
4781 * pointers will point to this buffer.
4783 * AVFrame extended_data channel pointers are allocated if necessary for
4786 * @param frame the AVFrame
4787 * frame->nb_samples must be set prior to calling the
4788 * function. This function fills in frame->data,
4789 * frame->extended_data, frame->linesize[0].
4790 * @param nb_channels channel count
4791 * @param sample_fmt sample format
4792 * @param buf buffer to use for frame data
4793 * @param buf_size size of buffer
4794 * @param align plane size sample alignment (0 = default)
4795 * @return >=0 on success, negative error code on failure
4796 * @todo return the size in bytes required to store the samples in
4797 * case of success, at the next libavutil bump
4799 int avcodec_fill_audio_frame(AVFrame *frame, int nb_channels,
4800 enum AVSampleFormat sample_fmt, const uint8_t *buf,
4801 int buf_size, int align);
4804 * Flush buffers, should be called when seeking or when switching to a different stream.
4806 void avcodec_flush_buffers(AVCodecContext *avctx);
4808 void avcodec_default_free_buffers(AVCodecContext *s);
4811 * Return codec bits per sample.
4813 * @param[in] codec_id the codec
4814 * @return Number of bits per sample or zero if unknown for the given codec.
4816 int av_get_bits_per_sample(enum AVCodecID codec_id);
4819 * Return the PCM codec associated with a sample format.
4820 * @param be endianness, 0 for little, 1 for big,
4821 * -1 (or anything else) for native
4822 * @return AV_CODEC_ID_PCM_* or AV_CODEC_ID_NONE
4824 enum AVCodecID av_get_pcm_codec(enum AVSampleFormat fmt, int be);
4827 * Return codec bits per sample.
4828 * Only return non-zero if the bits per sample is exactly correct, not an
4831 * @param[in] codec_id the codec
4832 * @return Number of bits per sample or zero if unknown for the given codec.
4834 int av_get_exact_bits_per_sample(enum AVCodecID codec_id);
4837 * Return audio frame duration.
4839 * @param avctx codec context
4840 * @param frame_bytes size of the frame, or 0 if unknown
4841 * @return frame duration, in samples, if known. 0 if not able to
4844 int av_get_audio_frame_duration(AVCodecContext *avctx, int frame_bytes);
4847 typedef struct AVBitStreamFilterContext {
4849 struct AVBitStreamFilter *filter;
4850 AVCodecParserContext *parser;
4851 struct AVBitStreamFilterContext *next;
4852 } AVBitStreamFilterContext;
4855 typedef struct AVBitStreamFilter {
4858 int (*filter)(AVBitStreamFilterContext *bsfc,
4859 AVCodecContext *avctx, const char *args,
4860 uint8_t **poutbuf, int *poutbuf_size,
4861 const uint8_t *buf, int buf_size, int keyframe);
4862 void (*close)(AVBitStreamFilterContext *bsfc);
4863 struct AVBitStreamFilter *next;
4864 } AVBitStreamFilter;
4866 void av_register_bitstream_filter(AVBitStreamFilter *bsf);
4867 AVBitStreamFilterContext *av_bitstream_filter_init(const char *name);
4868 int av_bitstream_filter_filter(AVBitStreamFilterContext *bsfc,
4869 AVCodecContext *avctx, const char *args,
4870 uint8_t **poutbuf, int *poutbuf_size,
4871 const uint8_t *buf, int buf_size, int keyframe);
4872 void av_bitstream_filter_close(AVBitStreamFilterContext *bsf);
4874 AVBitStreamFilter *av_bitstream_filter_next(AVBitStreamFilter *f);
4879 * Reallocate the given block if it is not large enough, otherwise do nothing.
4883 void *av_fast_realloc(void *ptr, unsigned int *size, size_t min_size);
4886 * Allocate a buffer, reusing the given one if large enough.
4888 * Contrary to av_fast_realloc the current buffer contents might not be
4889 * preserved and on error the old buffer is freed, thus no special
4890 * handling to avoid memleaks is necessary.
4892 * @param ptr pointer to pointer to already allocated buffer, overwritten with pointer to new buffer
4893 * @param size size of the buffer *ptr points to
4894 * @param min_size minimum size of *ptr buffer after returning, *ptr will be NULL and
4895 * *size 0 if an error occurred.
4897 void av_fast_malloc(void *ptr, unsigned int *size, size_t min_size);
4900 * Same behaviour av_fast_malloc but the buffer has additional
4901 * FF_INPUT_PADDING_SIZE at the end which will will always be 0.
4903 * In addition the whole buffer will initially and after resizes
4904 * be 0-initialized so that no uninitialized data will ever appear.
4906 void av_fast_padded_malloc(void *ptr, unsigned int *size, size_t min_size);
4909 * Same behaviour av_fast_padded_malloc except that buffer will always
4910 * be 0-initialized after call.
4912 void av_fast_padded_mallocz(void *ptr, unsigned int *size, size_t min_size);
4915 * Encode extradata length to a buffer. Used by xiph codecs.
4917 * @param s buffer to write to; must be at least (v/255+1) bytes long
4918 * @param v size of extradata in bytes
4919 * @return number of bytes written to the buffer.
4921 unsigned int av_xiphlacing(unsigned char *s, unsigned int v);
4924 * Log a generic warning message about a missing feature. This function is
4925 * intended to be used internally by FFmpeg (libavcodec, libavformat, etc.)
4926 * only, and would normally not be used by applications.
4927 * @param[in] avc a pointer to an arbitrary struct of which the first field is
4928 * a pointer to an AVClass struct
4929 * @param[in] feature string containing the name of the missing feature
4930 * @param[in] want_sample indicates if samples are wanted which exhibit this feature.
4931 * If want_sample is non-zero, additional verbage will be added to the log
4932 * message which tells the user how to report samples to the development
4935 void av_log_missing_feature(void *avc, const char *feature, int want_sample);
4938 * Log a generic warning message asking for a sample. This function is
4939 * intended to be used internally by FFmpeg (libavcodec, libavformat, etc.)
4940 * only, and would normally not be used by applications.
4941 * @param[in] avc a pointer to an arbitrary struct of which the first field is
4942 * a pointer to an AVClass struct
4943 * @param[in] msg string containing an optional message, or NULL if no message
4945 void av_log_ask_for_sample(void *avc, const char *msg, ...) av_printf_format(2, 3);
4948 * Register the hardware accelerator hwaccel.
4950 void av_register_hwaccel(AVHWAccel *hwaccel);
4953 * If hwaccel is NULL, returns the first registered hardware accelerator,
4954 * if hwaccel is non-NULL, returns the next registered hardware accelerator
4955 * after hwaccel, or NULL if hwaccel is the last one.
4957 AVHWAccel *av_hwaccel_next(AVHWAccel *hwaccel);
4961 * Lock operation used by lockmgr
4964 AV_LOCK_CREATE, ///< Create a mutex
4965 AV_LOCK_OBTAIN, ///< Lock the mutex
4966 AV_LOCK_RELEASE, ///< Unlock the mutex
4967 AV_LOCK_DESTROY, ///< Free mutex resources
4971 * Register a user provided lock manager supporting the operations
4972 * specified by AVLockOp. mutex points to a (void *) where the
4973 * lockmgr should store/get a pointer to a user allocated mutex. It's
4974 * NULL upon AV_LOCK_CREATE and != NULL for all other ops.
4976 * @param cb User defined callback. Note: FFmpeg may invoke calls to this
4977 * callback during the call to av_lockmgr_register().
4978 * Thus, the application must be prepared to handle that.
4979 * If cb is set to NULL the lockmgr will be unregistered.
4980 * Also note that during unregistration the previously registered
4981 * lockmgr callback may also be invoked.
4983 int av_lockmgr_register(int (*cb)(void **mutex, enum AVLockOp op));
4986 * Get the type of the given codec.
4988 enum AVMediaType avcodec_get_type(enum AVCodecID codec_id);
4991 * Get the name of a codec.
4992 * @return a static string identifying the codec; never NULL
4994 const char *avcodec_get_name(enum AVCodecID id);
4997 * @return a positive value if s is open (i.e. avcodec_open2() was called on it
4998 * with no corresponding avcodec_close()), 0 otherwise.
5000 int avcodec_is_open(AVCodecContext *s);
5003 * @return a non-zero number if codec is an encoder, zero otherwise
5005 int av_codec_is_encoder(const AVCodec *codec);
5008 * @return a non-zero number if codec is a decoder, zero otherwise
5010 int av_codec_is_decoder(const AVCodec *codec);
5013 * @return descriptor for given codec ID or NULL if no descriptor exists.
5015 const AVCodecDescriptor *avcodec_descriptor_get(enum AVCodecID id);
5018 * Iterate over all codec descriptors known to libavcodec.
5020 * @param prev previous descriptor. NULL to get the first descriptor.
5022 * @return next descriptor or NULL after the last descriptor
5024 const AVCodecDescriptor *avcodec_descriptor_next(const AVCodecDescriptor *prev);
5027 * @return codec descriptor with the given name or NULL if no such descriptor
5030 const AVCodecDescriptor *avcodec_descriptor_get_by_name(const char *name);
5036 #endif /* AVCODEC_AVCODEC_H */