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/dict.h"
34 #include "libavutil/log.h"
35 #include "libavutil/pixfmt.h"
36 #include "libavutil/rational.h"
37 #include "libavutil/audioconvert.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_Y41P = MKBETAG('Y','4','1','P'),
271 AV_CODEC_ID_ESCAPE130 = MKBETAG('E','1','3','0'),
272 AV_CODEC_ID_EXR = MKBETAG('0','E','X','R'),
273 AV_CODEC_ID_AVRP = MKBETAG('A','V','R','P'),
275 AV_CODEC_ID_G2M = MKBETAG( 0 ,'G','2','M'),
276 AV_CODEC_ID_AVUI = MKBETAG('A','V','U','I'),
277 AV_CODEC_ID_AYUV = MKBETAG('A','Y','U','V'),
278 AV_CODEC_ID_TARGA_Y216 = MKBETAG('T','2','1','6'),
279 AV_CODEC_ID_V308 = MKBETAG('V','3','0','8'),
280 AV_CODEC_ID_V408 = MKBETAG('V','4','0','8'),
281 AV_CODEC_ID_YUV4 = MKBETAG('Y','U','V','4'),
282 AV_CODEC_ID_SANM = MKBETAG('S','A','N','M'),
283 AV_CODEC_ID_PAF_VIDEO = MKBETAG('P','A','F','V'),
284 AV_CODEC_ID_AVRN = MKBETAG('A','V','R','n'),
285 AV_CODEC_ID_CPIA = MKBETAG('C','P','I','A'),
286 AV_CODEC_ID_XFACE = MKBETAG('X','F','A','C'),
288 /* various PCM "codecs" */
289 AV_CODEC_ID_FIRST_AUDIO = 0x10000, ///< A dummy id pointing at the start of audio codecs
290 AV_CODEC_ID_PCM_S16LE = 0x10000,
291 AV_CODEC_ID_PCM_S16BE,
292 AV_CODEC_ID_PCM_U16LE,
293 AV_CODEC_ID_PCM_U16BE,
296 AV_CODEC_ID_PCM_MULAW,
297 AV_CODEC_ID_PCM_ALAW,
298 AV_CODEC_ID_PCM_S32LE,
299 AV_CODEC_ID_PCM_S32BE,
300 AV_CODEC_ID_PCM_U32LE,
301 AV_CODEC_ID_PCM_U32BE,
302 AV_CODEC_ID_PCM_S24LE,
303 AV_CODEC_ID_PCM_S24BE,
304 AV_CODEC_ID_PCM_U24LE,
305 AV_CODEC_ID_PCM_U24BE,
306 AV_CODEC_ID_PCM_S24DAUD,
307 AV_CODEC_ID_PCM_ZORK,
308 AV_CODEC_ID_PCM_S16LE_PLANAR,
310 AV_CODEC_ID_PCM_F32BE,
311 AV_CODEC_ID_PCM_F32LE,
312 AV_CODEC_ID_PCM_F64BE,
313 AV_CODEC_ID_PCM_F64LE,
314 AV_CODEC_ID_PCM_BLURAY,
317 AV_CODEC_ID_PCM_S8_PLANAR,
319 /* various ADPCM codecs */
320 AV_CODEC_ID_ADPCM_IMA_QT = 0x11000,
321 AV_CODEC_ID_ADPCM_IMA_WAV,
322 AV_CODEC_ID_ADPCM_IMA_DK3,
323 AV_CODEC_ID_ADPCM_IMA_DK4,
324 AV_CODEC_ID_ADPCM_IMA_WS,
325 AV_CODEC_ID_ADPCM_IMA_SMJPEG,
326 AV_CODEC_ID_ADPCM_MS,
327 AV_CODEC_ID_ADPCM_4XM,
328 AV_CODEC_ID_ADPCM_XA,
329 AV_CODEC_ID_ADPCM_ADX,
330 AV_CODEC_ID_ADPCM_EA,
331 AV_CODEC_ID_ADPCM_G726,
332 AV_CODEC_ID_ADPCM_CT,
333 AV_CODEC_ID_ADPCM_SWF,
334 AV_CODEC_ID_ADPCM_YAMAHA,
335 AV_CODEC_ID_ADPCM_SBPRO_4,
336 AV_CODEC_ID_ADPCM_SBPRO_3,
337 AV_CODEC_ID_ADPCM_SBPRO_2,
338 AV_CODEC_ID_ADPCM_THP,
339 AV_CODEC_ID_ADPCM_IMA_AMV,
340 AV_CODEC_ID_ADPCM_EA_R1,
341 AV_CODEC_ID_ADPCM_EA_R3,
342 AV_CODEC_ID_ADPCM_EA_R2,
343 AV_CODEC_ID_ADPCM_IMA_EA_SEAD,
344 AV_CODEC_ID_ADPCM_IMA_EA_EACS,
345 AV_CODEC_ID_ADPCM_EA_XAS,
346 AV_CODEC_ID_ADPCM_EA_MAXIS_XA,
347 AV_CODEC_ID_ADPCM_IMA_ISS,
348 AV_CODEC_ID_ADPCM_G722,
349 AV_CODEC_ID_ADPCM_IMA_APC,
350 AV_CODEC_ID_VIMA = MKBETAG('V','I','M','A'),
353 AV_CODEC_ID_AMR_NB = 0x12000,
356 /* RealAudio codecs*/
357 AV_CODEC_ID_RA_144 = 0x13000,
360 /* various DPCM codecs */
361 AV_CODEC_ID_ROQ_DPCM = 0x14000,
362 AV_CODEC_ID_INTERPLAY_DPCM,
363 AV_CODEC_ID_XAN_DPCM,
364 AV_CODEC_ID_SOL_DPCM,
367 AV_CODEC_ID_MP2 = 0x15000,
368 AV_CODEC_ID_MP3, ///< preferred ID for decoding MPEG audio layer 1, 2 or 3
378 AV_CODEC_ID_VMDAUDIO,
384 AV_CODEC_ID_WESTWOOD_SND1,
385 AV_CODEC_ID_GSM, ///< as in Berlin toast format
388 AV_CODEC_ID_TRUESPEECH,
390 AV_CODEC_ID_SMACKAUDIO,
393 AV_CODEC_ID_DSICINAUDIO,
395 AV_CODEC_ID_MUSEPACK7,
397 AV_CODEC_ID_GSM_MS, /* as found in WAV */
401 AV_CODEC_ID_NELLYMOSER,
402 AV_CODEC_ID_MUSEPACK8,
404 AV_CODEC_ID_WMAVOICE,
406 AV_CODEC_ID_WMALOSSLESS,
415 AV_CODEC_ID_BINKAUDIO_RDFT,
416 AV_CODEC_ID_BINKAUDIO_DCT,
417 AV_CODEC_ID_AAC_LATM,
422 AV_CODEC_ID_8SVX_EXP,
423 AV_CODEC_ID_8SVX_FIB,
424 AV_CODEC_ID_BMV_AUDIO,
428 AV_CODEC_ID_OPUS_DEPRECATED,
429 AV_CODEC_ID_FFWAVESYNTH = MKBETAG('F','F','W','S'),
430 AV_CODEC_ID_8SVX_RAW = MKBETAG('8','S','V','X'),
431 AV_CODEC_ID_SONIC = MKBETAG('S','O','N','C'),
432 AV_CODEC_ID_SONIC_LS = MKBETAG('S','O','N','L'),
433 AV_CODEC_ID_PAF_AUDIO = MKBETAG('P','A','F','A'),
434 AV_CODEC_ID_OPUS = MKBETAG('O','P','U','S'),
435 AV_CODEC_ID_TAK = MKBETAG('t','B','a','K'),
437 /* subtitle codecs */
438 AV_CODEC_ID_FIRST_SUBTITLE = 0x17000, ///< A dummy ID pointing at the start of subtitle codecs.
439 AV_CODEC_ID_DVD_SUBTITLE = 0x17000,
440 AV_CODEC_ID_DVB_SUBTITLE,
441 AV_CODEC_ID_TEXT, ///< raw UTF-8 text
444 AV_CODEC_ID_MOV_TEXT,
445 AV_CODEC_ID_HDMV_PGS_SUBTITLE,
446 AV_CODEC_ID_DVB_TELETEXT,
448 AV_CODEC_ID_MICRODVD = MKBETAG('m','D','V','D'),
449 AV_CODEC_ID_EIA_608 = MKBETAG('c','6','0','8'),
450 AV_CODEC_ID_JACOSUB = MKBETAG('J','S','U','B'),
451 AV_CODEC_ID_SAMI = MKBETAG('S','A','M','I'),
452 AV_CODEC_ID_REALTEXT = MKBETAG('R','T','X','T'),
453 AV_CODEC_ID_SUBVIEWER = MKBETAG('S','u','b','V'),
454 AV_CODEC_ID_SUBRIP = MKBETAG('S','R','i','p'),
455 AV_CODEC_ID_WEBVTT = MKBETAG('W','V','T','T'),
457 /* other specific kind of codecs (generally used for attachments) */
458 AV_CODEC_ID_FIRST_UNKNOWN = 0x18000, ///< A dummy ID pointing at the start of various fake codecs.
459 AV_CODEC_ID_TTF = 0x18000,
460 AV_CODEC_ID_BINTEXT = MKBETAG('B','T','X','T'),
461 AV_CODEC_ID_XBIN = MKBETAG('X','B','I','N'),
462 AV_CODEC_ID_IDF = MKBETAG( 0 ,'I','D','F'),
463 AV_CODEC_ID_OTF = MKBETAG( 0 ,'O','T','F'),
465 AV_CODEC_ID_PROBE = 0x19000, ///< codec_id is not known (like AV_CODEC_ID_NONE) but lavf should attempt to identify it
467 AV_CODEC_ID_MPEG2TS = 0x20000, /**< _FAKE_ codec to indicate a raw MPEG-2 TS
468 * stream (only used by libavformat) */
469 AV_CODEC_ID_MPEG4SYSTEMS = 0x20001, /**< _FAKE_ codec to indicate a MPEG-4 Systems
470 * stream (only used by libavformat) */
471 AV_CODEC_ID_FFMETADATA = 0x21000, ///< Dummy codec for streams containing only metadata information.
474 #include "old_codec_ids.h"
479 #define CodecID AVCodecID
483 * This struct describes the properties of a single codec described by an
485 * @see avcodec_get_descriptor()
487 typedef struct AVCodecDescriptor {
489 enum AVMediaType type;
491 * Name of the codec described by this descriptor. It is non-empty and
492 * unique for each codec descriptor. It should contain alphanumeric
493 * characters and '_' only.
497 * A more descriptive name for this codec. May be NULL.
499 const char *long_name;
501 * Codec properties, a combination of AV_CODEC_PROP_* flags.
507 * Codec uses only intra compression.
510 #define AV_CODEC_PROP_INTRA_ONLY (1 << 0)
512 * Codec supports lossy compression. Audio and video codecs only.
513 * @note a codec may support both lossy and lossless
516 #define AV_CODEC_PROP_LOSSY (1 << 1)
518 * Codec supports lossless compression. Audio and video codecs only.
520 #define AV_CODEC_PROP_LOSSLESS (1 << 2)
522 #if FF_API_OLD_DECODE_AUDIO
524 #define AVCODEC_MAX_AUDIO_FRAME_SIZE 192000 // 1 second of 48khz 32bit audio
528 * @ingroup lavc_decoding
529 * Required number of additionally allocated bytes at the end of the input bitstream for decoding.
530 * This is mainly needed because some optimized bitstream readers read
531 * 32 or 64 bit at once and could read over the end.<br>
532 * Note: If the first 23 bits of the additional bytes are not 0, then damaged
533 * MPEG bitstreams could cause overread and segfault.
535 #define FF_INPUT_BUFFER_PADDING_SIZE 16
538 * @ingroup lavc_encoding
539 * minimum encoding buffer size
540 * Used to avoid some checks during header writing.
542 #define FF_MIN_BUFFER_SIZE 16384
546 * @ingroup lavc_encoding
547 * motion estimation type.
550 ME_ZERO = 1, ///< no search, that is use 0,0 vector whenever one is needed
554 ME_EPZS, ///< enhanced predictive zonal search
555 ME_X1, ///< reserved for experiments
556 ME_HEX, ///< hexagon based search
557 ME_UMH, ///< uneven multi-hexagon search
558 ME_ITER, ///< iterative search
559 ME_TESA, ///< transformed exhaustive search algorithm
563 * @ingroup lavc_decoding
566 /* We leave some space between them for extensions (drop some
567 * keyframes for intra-only or drop just some bidir frames). */
568 AVDISCARD_NONE =-16, ///< discard nothing
569 AVDISCARD_DEFAULT = 0, ///< discard useless packets like 0 size packets in avi
570 AVDISCARD_NONREF = 8, ///< discard all non reference
571 AVDISCARD_BIDIR = 16, ///< discard all bidirectional frames
572 AVDISCARD_NONKEY = 32, ///< discard all frames except keyframes
573 AVDISCARD_ALL = 48, ///< discard all
576 enum AVColorPrimaries{
577 AVCOL_PRI_BT709 = 1, ///< also ITU-R BT1361 / IEC 61966-2-4 / SMPTE RP177 Annex B
578 AVCOL_PRI_UNSPECIFIED = 2,
579 AVCOL_PRI_BT470M = 4,
580 AVCOL_PRI_BT470BG = 5, ///< also ITU-R BT601-6 625 / ITU-R BT1358 625 / ITU-R BT1700 625 PAL & SECAM
581 AVCOL_PRI_SMPTE170M = 6, ///< also ITU-R BT601-6 525 / ITU-R BT1358 525 / ITU-R BT1700 NTSC
582 AVCOL_PRI_SMPTE240M = 7, ///< functionally identical to above
584 AVCOL_PRI_NB , ///< Not part of ABI
587 enum AVColorTransferCharacteristic{
588 AVCOL_TRC_BT709 = 1, ///< also ITU-R BT1361
589 AVCOL_TRC_UNSPECIFIED = 2,
590 AVCOL_TRC_GAMMA22 = 4, ///< also ITU-R BT470M / ITU-R BT1700 625 PAL & SECAM
591 AVCOL_TRC_GAMMA28 = 5, ///< also ITU-R BT470BG
592 AVCOL_TRC_SMPTE240M = 7,
593 AVCOL_TRC_NB , ///< Not part of ABI
598 AVCOL_SPC_BT709 = 1, ///< also ITU-R BT1361 / IEC 61966-2-4 xvYCC709 / SMPTE RP177 Annex B
599 AVCOL_SPC_UNSPECIFIED = 2,
601 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
602 AVCOL_SPC_SMPTE170M = 6, ///< also ITU-R BT601-6 525 / ITU-R BT1358 525 / ITU-R BT1700 NTSC / functionally identical to above
603 AVCOL_SPC_SMPTE240M = 7,
604 AVCOL_SPC_YCOCG = 8, ///< Used by Dirac / VC-2 and H.264 FRext, see ITU-T SG16
605 AVCOL_SPC_NB , ///< Not part of ABI
607 #define AVCOL_SPC_YCGCO AVCOL_SPC_YCOCG
610 AVCOL_RANGE_UNSPECIFIED = 0,
611 AVCOL_RANGE_MPEG = 1, ///< the normal 219*2^(n-8) "MPEG" YUV ranges
612 AVCOL_RANGE_JPEG = 2, ///< the normal 2^n-1 "JPEG" YUV ranges
613 AVCOL_RANGE_NB , ///< Not part of ABI
617 * X X 3 4 X X are luma samples,
618 * 1 2 1-6 are possible chroma positions
619 * X X 5 6 X 0 is undefined/unknown position
621 enum AVChromaLocation{
622 AVCHROMA_LOC_UNSPECIFIED = 0,
623 AVCHROMA_LOC_LEFT = 1, ///< mpeg2/4, h264 default
624 AVCHROMA_LOC_CENTER = 2, ///< mpeg1, jpeg, h263
625 AVCHROMA_LOC_TOPLEFT = 3, ///< DV
626 AVCHROMA_LOC_TOP = 4,
627 AVCHROMA_LOC_BOTTOMLEFT = 5,
628 AVCHROMA_LOC_BOTTOM = 6,
629 AVCHROMA_LOC_NB , ///< Not part of ABI
632 enum AVAudioServiceType {
633 AV_AUDIO_SERVICE_TYPE_MAIN = 0,
634 AV_AUDIO_SERVICE_TYPE_EFFECTS = 1,
635 AV_AUDIO_SERVICE_TYPE_VISUALLY_IMPAIRED = 2,
636 AV_AUDIO_SERVICE_TYPE_HEARING_IMPAIRED = 3,
637 AV_AUDIO_SERVICE_TYPE_DIALOGUE = 4,
638 AV_AUDIO_SERVICE_TYPE_COMMENTARY = 5,
639 AV_AUDIO_SERVICE_TYPE_EMERGENCY = 6,
640 AV_AUDIO_SERVICE_TYPE_VOICE_OVER = 7,
641 AV_AUDIO_SERVICE_TYPE_KARAOKE = 8,
642 AV_AUDIO_SERVICE_TYPE_NB , ///< Not part of ABI
646 * @ingroup lavc_encoding
648 typedef struct RcOverride{
651 int qscale; // If this is 0 then quality_factor will be used instead.
652 float quality_factor;
655 #define FF_MAX_B_FRAMES 16
658 These flags can be passed in AVCodecContext.flags before initialization.
659 Note: Not everything is supported yet.
662 #define CODEC_FLAG_QSCALE 0x0002 ///< Use fixed qscale.
663 #define CODEC_FLAG_4MV 0x0004 ///< 4 MV per MB allowed / advanced prediction for H.263.
664 #define CODEC_FLAG_QPEL 0x0010 ///< Use qpel MC.
665 #define CODEC_FLAG_GMC 0x0020 ///< Use GMC.
666 #define CODEC_FLAG_MV0 0x0040 ///< Always try a MB with MV=<0,0>.
668 * The parent program guarantees that the input for B-frames containing
669 * streams is not written to for at least s->max_b_frames+1 frames, if
670 * this is not set the input will be copied.
672 #define CODEC_FLAG_INPUT_PRESERVED 0x0100
673 #define CODEC_FLAG_PASS1 0x0200 ///< Use internal 2pass ratecontrol in first pass mode.
674 #define CODEC_FLAG_PASS2 0x0400 ///< Use internal 2pass ratecontrol in second pass mode.
675 #define CODEC_FLAG_GRAY 0x2000 ///< Only decode/encode grayscale.
676 #define CODEC_FLAG_EMU_EDGE 0x4000 ///< Don't draw edges.
677 #define CODEC_FLAG_PSNR 0x8000 ///< error[?] variables will be set during encoding.
678 #define CODEC_FLAG_TRUNCATED 0x00010000 /** Input bitstream might be truncated at a random
679 location instead of only at frame boundaries. */
680 #define CODEC_FLAG_NORMALIZE_AQP 0x00020000 ///< Normalize adaptive quantization.
681 #define CODEC_FLAG_INTERLACED_DCT 0x00040000 ///< Use interlaced DCT.
682 #define CODEC_FLAG_LOW_DELAY 0x00080000 ///< Force low delay.
683 #define CODEC_FLAG_GLOBAL_HEADER 0x00400000 ///< Place global headers in extradata instead of every keyframe.
684 #define CODEC_FLAG_BITEXACT 0x00800000 ///< Use only bitexact stuff (except (I)DCT).
685 /* Fx : Flag for h263+ extra options */
686 #define CODEC_FLAG_AC_PRED 0x01000000 ///< H.263 advanced intra coding / MPEG-4 AC prediction
687 #define CODEC_FLAG_LOOP_FILTER 0x00000800 ///< loop filter
688 #define CODEC_FLAG_INTERLACED_ME 0x20000000 ///< interlaced motion estimation
689 #define CODEC_FLAG_CLOSED_GOP 0x80000000
690 #define CODEC_FLAG2_FAST 0x00000001 ///< Allow non spec compliant speedup tricks.
691 #define CODEC_FLAG2_NO_OUTPUT 0x00000004 ///< Skip bitstream encoding.
692 #define CODEC_FLAG2_LOCAL_HEADER 0x00000008 ///< Place global headers at every keyframe instead of in extradata.
693 #define CODEC_FLAG2_DROP_FRAME_TIMECODE 0x00002000 ///< timecode is in drop frame format. DEPRECATED!!!!
694 #if FF_API_MPV_GLOBAL_OPTS
695 #define CODEC_FLAG_CBP_RD 0x04000000 ///< Use rate distortion optimization for cbp.
696 #define CODEC_FLAG_QP_RD 0x08000000 ///< Use rate distortion optimization for qp selectioon.
697 #define CODEC_FLAG2_STRICT_GOP 0x00000002 ///< Strictly enforce GOP size.
698 #define CODEC_FLAG2_SKIP_RD 0x00004000 ///< RD optimal MB level residual skipping
700 #define CODEC_FLAG2_CHUNKS 0x00008000 ///< Input bitstream might be truncated at a packet boundaries instead of only at frame boundaries.
701 #define CODEC_FLAG2_SHOW_ALL 0x00400000 ///< Show all frames before the first keyframe
703 /* Unsupported options :
704 * Syntax Arithmetic coding (SAC)
705 * Reference Picture Selection
706 * Independent Segment Decoding */
708 /* codec capabilities */
710 #define CODEC_CAP_DRAW_HORIZ_BAND 0x0001 ///< Decoder can use draw_horiz_band callback.
712 * Codec uses get_buffer() for allocating buffers and supports custom allocators.
713 * If not set, it might not use get_buffer() at all or use operations that
714 * assume the buffer was allocated by avcodec_default_get_buffer.
716 #define CODEC_CAP_DR1 0x0002
717 #define CODEC_CAP_TRUNCATED 0x0008
718 /* Codec can export data for HW decoding (XvMC). */
719 #define CODEC_CAP_HWACCEL 0x0010
721 * Encoder or decoder requires flushing with NULL input at the end in order to
722 * give the complete and correct output.
724 * NOTE: If this flag is not set, the codec is guaranteed to never be fed with
725 * with NULL data. The user can still send NULL data to the public encode
726 * or decode function, but libavcodec will not pass it along to the codec
727 * unless this flag is set.
730 * The decoder has a non-zero delay and needs to be fed with avpkt->data=NULL,
731 * avpkt->size=0 at the end to get the delayed data until the decoder no longer
735 * The encoder needs to be fed with NULL data at the end of encoding until the
736 * encoder no longer returns data.
738 * NOTE: For encoders implementing the AVCodec.encode2() function, setting this
739 * flag also means that the encoder must set the pts and duration for
740 * each output packet. If this flag is not set, the pts and duration will
741 * be determined by libavcodec from the input frame.
743 #define CODEC_CAP_DELAY 0x0020
745 * Codec can be fed a final frame with a smaller size.
746 * This can be used to prevent truncation of the last audio samples.
748 #define CODEC_CAP_SMALL_LAST_FRAME 0x0040
750 * Codec can export data for HW decoding (VDPAU).
752 #define CODEC_CAP_HWACCEL_VDPAU 0x0080
754 * Codec can output multiple frames per AVPacket
755 * Normally demuxers return one frame at a time, demuxers which do not do
756 * are connected to a parser to split what they return into proper frames.
757 * This flag is reserved to the very rare category of codecs which have a
758 * bitstream that cannot be split into frames without timeconsuming
759 * operations like full decoding. Demuxers carring such bitstreams thus
760 * may return multiple frames in a packet. This has many disadvantages like
761 * prohibiting stream copy in many cases thus it should only be considered
764 #define CODEC_CAP_SUBFRAMES 0x0100
766 * Codec is experimental and is thus avoided in favor of non experimental
769 #define CODEC_CAP_EXPERIMENTAL 0x0200
771 * Codec should fill in channel configuration and samplerate instead of container
773 #define CODEC_CAP_CHANNEL_CONF 0x0400
776 * Codec is able to deal with negative linesizes
778 #define CODEC_CAP_NEG_LINESIZES 0x0800
781 * Codec supports frame-level multithreading.
783 #define CODEC_CAP_FRAME_THREADS 0x1000
785 * Codec supports slice-based (or partition-based) multithreading.
787 #define CODEC_CAP_SLICE_THREADS 0x2000
789 * Codec supports changed parameters at any point.
791 #define CODEC_CAP_PARAM_CHANGE 0x4000
793 * Codec supports avctx->thread_count == 0 (auto).
795 #define CODEC_CAP_AUTO_THREADS 0x8000
797 * Audio encoder supports receiving a different number of samples in each call.
799 #define CODEC_CAP_VARIABLE_FRAME_SIZE 0x10000
801 * Codec is intra only.
803 #define CODEC_CAP_INTRA_ONLY 0x40000000
807 #define CODEC_CAP_LOSSLESS 0x80000000
809 //The following defines may change, don't expect compatibility if you use them.
810 #define MB_TYPE_INTRA4x4 0x0001
811 #define MB_TYPE_INTRA16x16 0x0002 //FIXME H.264-specific
812 #define MB_TYPE_INTRA_PCM 0x0004 //FIXME H.264-specific
813 #define MB_TYPE_16x16 0x0008
814 #define MB_TYPE_16x8 0x0010
815 #define MB_TYPE_8x16 0x0020
816 #define MB_TYPE_8x8 0x0040
817 #define MB_TYPE_INTERLACED 0x0080
818 #define MB_TYPE_DIRECT2 0x0100 //FIXME
819 #define MB_TYPE_ACPRED 0x0200
820 #define MB_TYPE_GMC 0x0400
821 #define MB_TYPE_SKIP 0x0800
822 #define MB_TYPE_P0L0 0x1000
823 #define MB_TYPE_P1L0 0x2000
824 #define MB_TYPE_P0L1 0x4000
825 #define MB_TYPE_P1L1 0x8000
826 #define MB_TYPE_L0 (MB_TYPE_P0L0 | MB_TYPE_P1L0)
827 #define MB_TYPE_L1 (MB_TYPE_P0L1 | MB_TYPE_P1L1)
828 #define MB_TYPE_L0L1 (MB_TYPE_L0 | MB_TYPE_L1)
829 #define MB_TYPE_QUANT 0x00010000
830 #define MB_TYPE_CBP 0x00020000
831 //Note bits 24-31 are reserved for codec specific use (h264 ref0, mpeg1 0mv, ...)
835 * This specifies the area which should be displayed.
836 * Note there may be multiple such areas for one frame.
838 typedef struct AVPanScan{
841 * - encoding: Set by user.
842 * - decoding: Set by libavcodec.
847 * width and height in 1/16 pel
848 * - encoding: Set by user.
849 * - decoding: Set by libavcodec.
855 * position of the top left corner in 1/16 pel for up to 3 fields/frames
856 * - encoding: Set by user.
857 * - decoding: Set by libavcodec.
859 int16_t position[3][2];
862 #define FF_QSCALE_TYPE_MPEG1 0
863 #define FF_QSCALE_TYPE_MPEG2 1
864 #define FF_QSCALE_TYPE_H264 2
865 #define FF_QSCALE_TYPE_VP56 3
867 #define FF_BUFFER_TYPE_INTERNAL 1
868 #define FF_BUFFER_TYPE_USER 2 ///< direct rendering buffers (image is (de)allocated by user)
869 #define FF_BUFFER_TYPE_SHARED 4 ///< Buffer from somewhere else; don't deallocate image (data/base), all other tables are not shared.
870 #define FF_BUFFER_TYPE_COPY 8 ///< Just a (modified) copy of some other buffer, don't deallocate anything.
872 #define FF_BUFFER_HINTS_VALID 0x01 // Buffer hints value is meaningful (if 0 ignore).
873 #define FF_BUFFER_HINTS_READABLE 0x02 // Codec will read from buffer.
874 #define FF_BUFFER_HINTS_PRESERVE 0x04 // User must not alter buffer content.
875 #define FF_BUFFER_HINTS_REUSABLE 0x08 // Codec will reuse the buffer (update).
878 * @defgroup lavc_packet AVPacket
880 * Types and functions for working with AVPacket.
883 enum AVPacketSideDataType {
885 AV_PKT_DATA_NEW_EXTRADATA,
888 * An AV_PKT_DATA_PARAM_CHANGE side data packet is laid out as follows:
891 * if (param_flags & AV_SIDE_DATA_PARAM_CHANGE_CHANNEL_COUNT)
892 * s32le channel_count
893 * if (param_flags & AV_SIDE_DATA_PARAM_CHANGE_CHANNEL_LAYOUT)
894 * u64le channel_layout
895 * if (param_flags & AV_SIDE_DATA_PARAM_CHANGE_SAMPLE_RATE)
897 * if (param_flags & AV_SIDE_DATA_PARAM_CHANGE_DIMENSIONS)
902 AV_PKT_DATA_PARAM_CHANGE,
905 * An AV_PKT_DATA_H263_MB_INFO side data packet contains a number of
906 * structures with info about macroblocks relevant to splitting the
907 * packet into smaller packets on macroblock edges (e.g. as for RFC 2190).
908 * That is, it does not necessarily contain info about all macroblocks,
909 * as long as the distance between macroblocks in the info is smaller
910 * than the target payload size.
911 * Each MB info structure is 12 bytes, and is laid out as follows:
913 * u32le bit offset from the start of the packet
914 * u8 current quantizer at the start of the macroblock
916 * u16le macroblock address within the GOB
917 * u8 horizontal MV predictor
918 * u8 vertical MV predictor
919 * u8 horizontal MV predictor for block number 3
920 * u8 vertical MV predictor for block number 3
923 AV_PKT_DATA_H263_MB_INFO,
926 * Recommmends skipping the specified number of samples
928 * u32le number of samples to skip from start of this packet
929 * u32le number of samples to skip from end of this packet
930 * u8 reason for start skip
931 * u8 reason for end skip (0=padding silence, 1=convergence)
934 AV_PKT_DATA_SKIP_SAMPLES=70,
937 * An AV_PKT_DATA_JP_DUALMONO side data packet indicates that
938 * the packet may contain "dual mono" audio specific to Japanese DTV
939 * and if it is true, recommends only the selected channel to be used.
941 * u8 selected channels (0=mail/left, 1=sub/right, 2=both)
944 AV_PKT_DATA_JP_DUALMONO,
947 typedef struct AVPacket {
949 * Presentation timestamp in AVStream->time_base units; the time at which
950 * the decompressed packet will be presented to the user.
951 * Can be AV_NOPTS_VALUE if it is not stored in the file.
952 * pts MUST be larger or equal to dts as presentation cannot happen before
953 * decompression, unless one wants to view hex dumps. Some formats misuse
954 * the terms dts and pts/cts to mean something different. Such timestamps
955 * must be converted to true pts/dts before they are stored in AVPacket.
959 * Decompression timestamp in AVStream->time_base units; the time at which
960 * the packet is decompressed.
961 * Can be AV_NOPTS_VALUE if it is not stored in the file.
968 * A combination of AV_PKT_FLAG values
972 * Additional packet data that can be provided by the container.
973 * Packet can contain several types of side information.
978 enum AVPacketSideDataType type;
983 * Duration of this packet in AVStream->time_base units, 0 if unknown.
984 * Equals next_pts - this_pts in presentation order.
987 void (*destruct)(struct AVPacket *);
989 int64_t pos; ///< byte position in stream, -1 if unknown
992 * Time difference in AVStream->time_base units from the pts of this
993 * packet to the point at which the output from the decoder has converged
994 * independent from the availability of previous frames. That is, the
995 * frames are virtually identical no matter if decoding started from
996 * the very first frame or from this keyframe.
997 * Is AV_NOPTS_VALUE if unknown.
998 * This field is not the display duration of the current packet.
999 * This field has no meaning if the packet does not have AV_PKT_FLAG_KEY
1002 * The purpose of this field is to allow seeking in streams that have no
1003 * keyframes in the conventional sense. It corresponds to the
1004 * recovery point SEI in H.264 and match_time_delta in NUT. It is also
1005 * essential for some types of subtitle streams to ensure that all
1006 * subtitles are correctly displayed after seeking.
1008 int64_t convergence_duration;
1010 #define AV_PKT_FLAG_KEY 0x0001 ///< The packet contains a keyframe
1011 #define AV_PKT_FLAG_CORRUPT 0x0002 ///< The packet content is corrupted
1013 enum AVSideDataParamChangeFlags {
1014 AV_SIDE_DATA_PARAM_CHANGE_CHANNEL_COUNT = 0x0001,
1015 AV_SIDE_DATA_PARAM_CHANGE_CHANNEL_LAYOUT = 0x0002,
1016 AV_SIDE_DATA_PARAM_CHANGE_SAMPLE_RATE = 0x0004,
1017 AV_SIDE_DATA_PARAM_CHANGE_DIMENSIONS = 0x0008,
1024 * Audio Video Frame.
1025 * New fields can be added to the end of AVFRAME with minor version
1026 * bumps. Similarly fields that are marked as to be only accessed by
1027 * av_opt_ptr() can be reordered. This allows 2 forks to add fields
1028 * without breaking compatibility with each other.
1029 * Removal, reordering and changes in the remaining cases require
1030 * a major version bump.
1031 * sizeof(AVFrame) must not be used outside libavcodec.
1033 typedef struct AVFrame {
1034 #define AV_NUM_DATA_POINTERS 8
1036 * pointer to the picture/channel planes.
1037 * This might be different from the first allocated byte
1038 * - encoding: Set by user
1039 * - decoding: set by AVCodecContext.get_buffer()
1041 uint8_t *data[AV_NUM_DATA_POINTERS];
1044 * Size, in bytes, of the data for each picture/channel plane.
1046 * For audio, only linesize[0] may be set. For planar audio, each channel
1047 * plane must be the same size.
1049 * - encoding: Set by user
1050 * - decoding: set by AVCodecContext.get_buffer()
1052 int linesize[AV_NUM_DATA_POINTERS];
1055 * pointers to the data planes/channels.
1057 * For video, this should simply point to data[].
1059 * For planar audio, each channel has a separate data pointer, and
1060 * linesize[0] contains the size of each channel buffer.
1061 * For packed audio, there is just one data pointer, and linesize[0]
1062 * contains the total size of the buffer for all channels.
1064 * Note: Both data and extended_data will always be set by get_buffer(),
1065 * but for planar audio with more channels that can fit in data,
1066 * extended_data must be used by the decoder in order to access all
1069 * encoding: set by user
1070 * decoding: set by AVCodecContext.get_buffer()
1072 uint8_t **extended_data;
1075 * width and height of the video frame
1076 * - encoding: unused
1077 * - decoding: Read by user.
1082 * number of audio samples (per channel) described by this frame
1083 * - encoding: Set by user
1084 * - decoding: Set by libavcodec
1089 * format of the frame, -1 if unknown or unset
1090 * Values correspond to enum AVPixelFormat for video frames,
1091 * enum AVSampleFormat for audio)
1092 * - encoding: unused
1093 * - decoding: Read by user.
1098 * 1 -> keyframe, 0-> not
1099 * - encoding: Set by libavcodec.
1100 * - decoding: Set by libavcodec.
1105 * Picture type of the frame, see ?_TYPE below.
1106 * - encoding: Set by libavcodec. for coded_picture (and set by user for input).
1107 * - decoding: Set by libavcodec.
1109 enum AVPictureType pict_type;
1112 * pointer to the first allocated byte of the picture. Can be used in get_buffer/release_buffer.
1113 * This isn't used by libavcodec unless the default get/release_buffer() is used.
1117 uint8_t *base[AV_NUM_DATA_POINTERS];
1120 * sample aspect ratio for the video frame, 0/1 if unknown/unspecified
1121 * - encoding: unused
1122 * - decoding: Read by user.
1124 AVRational sample_aspect_ratio;
1127 * presentation timestamp in time_base units (time when frame should be shown to user)
1128 * If AV_NOPTS_VALUE then frame_rate = 1/time_base will be assumed.
1129 * - encoding: MUST be set by user.
1130 * - decoding: Set by libavcodec.
1135 * reordered pts from the last AVPacket that has been input into the decoder
1136 * - encoding: unused
1137 * - decoding: Read by user.
1142 * dts from the last AVPacket that has been input into the decoder
1143 * - encoding: unused
1144 * - decoding: Read by user.
1149 * picture number in bitstream order
1150 * - encoding: set by
1151 * - decoding: Set by libavcodec.
1153 int coded_picture_number;
1155 * picture number in display order
1156 * - encoding: set by
1157 * - decoding: Set by libavcodec.
1159 int display_picture_number;
1162 * quality (between 1 (good) and FF_LAMBDA_MAX (bad))
1163 * - encoding: Set by libavcodec. for coded_picture (and set by user for input).
1164 * - decoding: Set by libavcodec.
1169 * is this picture used as reference
1170 * The values for this are the same as the MpegEncContext.picture_structure
1171 * variable, that is 1->top field, 2->bottom field, 3->frame/both fields.
1172 * Set to 4 for delayed, non-reference frames.
1173 * - encoding: unused
1174 * - decoding: Set by libavcodec. (before get_buffer() call)).
1180 * - encoding: unused
1181 * - decoding: Set by libavcodec.
1183 int8_t *qscale_table;
1186 * - encoding: unused
1187 * - decoding: Set by libavcodec.
1197 * mbskip_table[mb]>=1 if MB didn't change
1198 * stride= mb_width = (width+15)>>4
1199 * - encoding: unused
1200 * - decoding: Set by libavcodec.
1202 uint8_t *mbskip_table;
1205 * motion vector table
1208 * int mv_sample_log2= 4 - motion_subsample_log2;
1209 * int mb_width= (width+15)>>4;
1210 * int mv_stride= (mb_width << mv_sample_log2) + 1;
1211 * motion_val[direction][x + y*mv_stride][0->mv_x, 1->mv_y];
1213 * - encoding: Set by user.
1214 * - decoding: Set by libavcodec.
1216 int16_t (*motion_val[2])[2];
1219 * macroblock type table
1220 * mb_type_base + mb_width + 2
1221 * - encoding: Set by user.
1222 * - decoding: Set by libavcodec.
1228 * - encoding: unused
1229 * - decoding: Set by libavcodec.
1234 * motion reference frame index
1235 * the order in which these are stored can depend on the codec.
1236 * - encoding: Set by user.
1237 * - decoding: Set by libavcodec.
1239 int8_t *ref_index[2];
1242 * for some private data of the user
1243 * - encoding: unused
1244 * - decoding: Set by user.
1250 * - encoding: Set by libavcodec. if flags&CODEC_FLAG_PSNR.
1251 * - decoding: unused
1253 uint64_t error[AV_NUM_DATA_POINTERS];
1256 * type of the buffer (to keep track of who has to deallocate data[*])
1257 * - encoding: Set by the one who allocates it.
1258 * - decoding: Set by the one who allocates it.
1259 * Note: User allocated (direct rendering) & internal buffers cannot coexist currently.
1264 * When decoding, this signals how much the picture must be delayed.
1265 * extra_delay = repeat_pict / (2*fps)
1266 * - encoding: unused
1267 * - decoding: Set by libavcodec.
1272 * The content of the picture is interlaced.
1273 * - encoding: Set by user.
1274 * - decoding: Set by libavcodec. (default 0)
1276 int interlaced_frame;
1279 * If the content is interlaced, is top field displayed first.
1280 * - encoding: Set by user.
1281 * - decoding: Set by libavcodec.
1283 int top_field_first;
1286 * Tell user application that palette has changed from previous frame.
1287 * - encoding: ??? (no palette-enabled encoder yet)
1288 * - decoding: Set by libavcodec. (default 0).
1290 int palette_has_changed;
1293 * codec suggestion on buffer type if != 0
1294 * - encoding: unused
1295 * - decoding: Set by libavcodec. (before get_buffer() call)).
1301 * - encoding: Set by user.
1302 * - decoding: Set by libavcodec.
1304 AVPanScan *pan_scan;
1307 * reordered opaque 64bit (generally an integer or a double precision float
1308 * PTS but can be anything).
1309 * The user sets AVCodecContext.reordered_opaque to represent the input at
1311 * the decoder reorders values as needed and sets AVFrame.reordered_opaque
1312 * to exactly one of the values provided by the user through AVCodecContext.reordered_opaque
1313 * @deprecated in favor of pkt_pts
1314 * - encoding: unused
1315 * - decoding: Read by user.
1317 int64_t reordered_opaque;
1320 * hardware accelerator private data (FFmpeg-allocated)
1321 * - encoding: unused
1322 * - decoding: Set by libavcodec
1324 void *hwaccel_picture_private;
1327 * the AVCodecContext which ff_thread_get_buffer() was last called on
1328 * - encoding: Set by libavcodec.
1329 * - decoding: Set by libavcodec.
1331 struct AVCodecContext *owner;
1334 * used by multithreading to store frame-specific info
1335 * - encoding: Set by libavcodec.
1336 * - decoding: Set by libavcodec.
1338 void *thread_opaque;
1341 * log2 of the size of the block which a single vector in motion_val represents:
1342 * (4->16x16, 3->8x8, 2-> 4x4, 1-> 2x2)
1343 * - encoding: unused
1344 * - decoding: Set by libavcodec.
1346 uint8_t motion_subsample_log2;
1349 * Sample rate of the audio data.
1351 * - encoding: unused
1352 * - decoding: read by user
1357 * Channel layout of the audio data.
1359 * - encoding: unused
1360 * - decoding: read by user.
1362 uint64_t channel_layout;
1365 * frame timestamp estimated using various heuristics, in stream time base
1366 * Code outside libavcodec should access this field using:
1367 * av_frame_get_best_effort_timestamp(frame)
1368 * - encoding: unused
1369 * - decoding: set by libavcodec, read by user.
1371 int64_t best_effort_timestamp;
1374 * reordered pos from the last AVPacket that has been input into the decoder
1375 * Code outside libavcodec should access this field using:
1376 * av_frame_get_pkt_pos(frame)
1377 * - encoding: unused
1378 * - decoding: Read by user.
1383 * duration of the corresponding packet, expressed in
1384 * AVStream->time_base units, 0 if unknown.
1385 * Code outside libavcodec should access this field using:
1386 * av_frame_get_pkt_duration(frame)
1387 * - encoding: unused
1388 * - decoding: Read by user.
1390 int64_t pkt_duration;
1394 * Code outside libavcodec should access this field using:
1395 * av_frame_get_metadata(frame)
1396 * - encoding: Set by user.
1397 * - decoding: Set by libavcodec.
1399 AVDictionary *metadata;
1402 * decode error flags of the frame, set to a combination of
1403 * FF_DECODE_ERROR_xxx flags if the decoder produced a frame, but there
1404 * were errors during the decoding.
1405 * Code outside libavcodec should access this field using:
1406 * av_frame_get_decode_error_flags(frame)
1407 * - encoding: unused
1408 * - decoding: set by libavcodec, read by user.
1410 int decode_error_flags;
1411 #define FF_DECODE_ERROR_INVALID_BITSTREAM 1
1412 #define FF_DECODE_ERROR_MISSING_REFERENCE 2
1415 * number of audio channels, only used for audio.
1416 * Code outside libavcodec should access this field using:
1417 * av_frame_get_channels(frame)
1418 * - encoding: unused
1419 * - decoding: Read by user.
1425 * Accessors for some AVFrame fields.
1426 * The position of these field in the structure is not part of the ABI,
1427 * they should not be accessed directly outside libavcodec.
1429 int64_t av_frame_get_best_effort_timestamp(const AVFrame *frame);
1430 void av_frame_set_best_effort_timestamp(AVFrame *frame, int64_t val);
1431 int64_t av_frame_get_pkt_duration (const AVFrame *frame);
1432 void av_frame_set_pkt_duration (AVFrame *frame, int64_t val);
1433 int64_t av_frame_get_pkt_pos (const AVFrame *frame);
1434 void av_frame_set_pkt_pos (AVFrame *frame, int64_t val);
1435 int64_t av_frame_get_channel_layout (const AVFrame *frame);
1436 void av_frame_set_channel_layout (AVFrame *frame, int64_t val);
1437 int av_frame_get_channels (const AVFrame *frame);
1438 void av_frame_set_channels (AVFrame *frame, int val);
1439 int av_frame_get_sample_rate (const AVFrame *frame);
1440 void av_frame_set_sample_rate (AVFrame *frame, int val);
1441 AVDictionary *av_frame_get_metadata (const AVFrame *frame);
1442 void av_frame_set_metadata (AVFrame *frame, AVDictionary *val);
1443 int av_frame_get_decode_error_flags (const AVFrame *frame);
1444 void av_frame_set_decode_error_flags (AVFrame *frame, int val);
1446 struct AVCodecInternal;
1450 AV_FIELD_PROGRESSIVE,
1451 AV_FIELD_TT, //< Top coded_first, top displayed first
1452 AV_FIELD_BB, //< Bottom coded first, bottom displayed first
1453 AV_FIELD_TB, //< Top coded first, bottom displayed first
1454 AV_FIELD_BT, //< Bottom coded first, top displayed first
1458 * main external API structure.
1459 * New fields can be added to the end with minor version bumps.
1460 * Removal, reordering and changes to existing fields require a major
1462 * Please use AVOptions (av_opt* / av_set/get*()) to access these fields from user
1464 * sizeof(AVCodecContext) must not be used outside libav*.
1466 typedef struct AVCodecContext {
1468 * information on struct for av_log
1469 * - set by avcodec_alloc_context3
1471 const AVClass *av_class;
1472 int log_level_offset;
1474 enum AVMediaType codec_type; /* see AVMEDIA_TYPE_xxx */
1475 const struct AVCodec *codec;
1476 char codec_name[32];
1477 enum AVCodecID codec_id; /* see AV_CODEC_ID_xxx */
1480 * fourcc (LSB first, so "ABCD" -> ('D'<<24) + ('C'<<16) + ('B'<<8) + 'A').
1481 * This is used to work around some encoder bugs.
1482 * A demuxer should set this to what is stored in the field used to identify the codec.
1483 * If there are multiple such fields in a container then the demuxer should choose the one
1484 * which maximizes the information about the used codec.
1485 * If the codec tag field in a container is larger than 32 bits then the demuxer should
1486 * remap the longer ID to 32 bits with a table or other structure. Alternatively a new
1487 * extra_codec_tag + size could be added but for this a clear advantage must be demonstrated
1489 * - encoding: Set by user, if not then the default based on codec_id will be used.
1490 * - decoding: Set by user, will be converted to uppercase by libavcodec during init.
1492 unsigned int codec_tag;
1495 * fourcc from the AVI stream header (LSB first, so "ABCD" -> ('D'<<24) + ('C'<<16) + ('B'<<8) + 'A').
1496 * This is used to work around some encoder bugs.
1497 * - encoding: unused
1498 * - decoding: Set by user, will be converted to uppercase by libavcodec during init.
1500 unsigned int stream_codec_tag;
1504 * @deprecated this field is unused
1506 attribute_deprecated int sub_id;
1512 * Private context used for internal data.
1514 * Unlike priv_data, this is not codec-specific. It is used in general
1515 * libavcodec functions.
1517 struct AVCodecInternal *internal;
1520 * Private data of the user, can be used to carry app specific stuff.
1521 * - encoding: Set by user.
1522 * - decoding: Set by user.
1527 * the average bitrate
1528 * - encoding: Set by user; unused for constant quantizer encoding.
1529 * - decoding: Set by libavcodec. 0 or some bitrate if this info is available in the stream.
1534 * number of bits the bitstream is allowed to diverge from the reference.
1535 * the reference can be CBR (for CBR pass1) or VBR (for pass2)
1536 * - encoding: Set by user; unused for constant quantizer encoding.
1537 * - decoding: unused
1539 int bit_rate_tolerance;
1542 * Global quality for codecs which cannot change it per frame.
1543 * This should be proportional to MPEG-1/2/4 qscale.
1544 * - encoding: Set by user.
1545 * - decoding: unused
1550 * - encoding: Set by user.
1551 * - decoding: unused
1553 int compression_level;
1554 #define FF_COMPRESSION_DEFAULT -1
1558 * - encoding: Set by user.
1559 * - decoding: Set by user.
1565 * - encoding: Set by user.
1566 * - decoding: Set by user.
1571 * some codecs need / can use extradata like Huffman tables.
1572 * mjpeg: Huffman tables
1573 * rv10: additional flags
1574 * mpeg4: global headers (they can be in the bitstream or here)
1575 * The allocated memory should be FF_INPUT_BUFFER_PADDING_SIZE bytes larger
1576 * than extradata_size to avoid prolems if it is read with the bitstream reader.
1577 * The bytewise contents of extradata must not depend on the architecture or CPU endianness.
1578 * - encoding: Set/allocated/freed by libavcodec.
1579 * - decoding: Set/allocated/freed by user.
1585 * This is the fundamental unit of time (in seconds) in terms
1586 * of which frame timestamps are represented. For fixed-fps content,
1587 * timebase should be 1/framerate and timestamp increments should be
1589 * - encoding: MUST be set by user.
1590 * - decoding: Set by libavcodec.
1592 AVRational time_base;
1595 * For some codecs, the time base is closer to the field rate than the frame rate.
1596 * Most notably, H.264 and MPEG-2 specify time_base as half of frame duration
1597 * if no telecine is used ...
1599 * Set to time_base ticks per frame. Default 1, e.g., H.264/MPEG-2 set it to 2.
1601 int ticks_per_frame;
1604 * Encoding: Number of frames delay there will be from the encoder input to
1605 * the decoder output. (we assume the decoder matches the spec)
1606 * Decoding: Number of frames delay in addition to what a standard decoder
1607 * as specified in the spec would produce.
1610 * Number of frames the decoded output will be delayed relative to the
1614 * For encoding, this is the number of "priming" samples added to the
1615 * beginning of the stream. The decoded output will be delayed by this
1616 * many samples relative to the input to the encoder. Note that this
1617 * field is purely informational and does not directly affect the pts
1618 * output by the encoder, which should always be based on the actual
1619 * presentation time, including any delay.
1620 * For decoding, this is the number of samples the decoder needs to
1621 * output before the decoder's output is valid. When seeking, you should
1622 * start decoding this many samples prior to your desired seek point.
1624 * - encoding: Set by libavcodec.
1625 * - decoding: Set by libavcodec.
1632 * picture width / height.
1633 * - encoding: MUST be set by user.
1634 * - decoding: Set by libavcodec.
1635 * Note: For compatibility it is possible to set this instead of
1636 * coded_width/height before decoding.
1641 * Bitstream width / height, may be different from width/height if lowres enabled.
1642 * - encoding: unused
1643 * - decoding: Set by user before init if known. Codec should override / dynamically change if needed.
1645 int coded_width, coded_height;
1647 #define FF_ASPECT_EXTENDED 15
1650 * the number of pictures in a group of pictures, or 0 for intra_only
1651 * - encoding: Set by user.
1652 * - decoding: unused
1657 * Pixel format, see AV_PIX_FMT_xxx.
1658 * May be set by the demuxer if known from headers.
1659 * May be overridden by the decoder if it knows better.
1660 * - encoding: Set by user.
1661 * - decoding: Set by user if known, overridden by libavcodec if known
1663 enum AVPixelFormat pix_fmt;
1666 * Motion estimation algorithm used for video coding.
1667 * 1 (zero), 2 (full), 3 (log), 4 (phods), 5 (epzs), 6 (x1), 7 (hex),
1668 * 8 (umh), 9 (iter), 10 (tesa) [7, 8, 10 are x264 specific, 9 is snow specific]
1669 * - encoding: MUST be set by user.
1670 * - decoding: unused
1675 * If non NULL, 'draw_horiz_band' is called by the libavcodec
1676 * decoder to draw a horizontal band. It improves cache usage. Not
1677 * all codecs can do that. You must check the codec capabilities
1679 * When multithreading is used, it may be called from multiple threads
1680 * at the same time; threads might draw different parts of the same AVFrame,
1681 * or multiple AVFrames, and there is no guarantee that slices will be drawn
1683 * The function is also used by hardware acceleration APIs.
1684 * It is called at least once during frame decoding to pass
1685 * the data needed for hardware render.
1686 * In that mode instead of pixel data, AVFrame points to
1687 * a structure specific to the acceleration API. The application
1688 * reads the structure and can change some fields to indicate progress
1690 * - encoding: unused
1691 * - decoding: Set by user.
1692 * @param height the height of the slice
1693 * @param y the y position of the slice
1694 * @param type 1->top field, 2->bottom field, 3->frame
1695 * @param offset offset into the AVFrame.data from which the slice should be read
1697 void (*draw_horiz_band)(struct AVCodecContext *s,
1698 const AVFrame *src, int offset[AV_NUM_DATA_POINTERS],
1699 int y, int type, int height);
1702 * callback to negotiate the pixelFormat
1703 * @param fmt is the list of formats which are supported by the codec,
1704 * it is terminated by -1 as 0 is a valid format, the formats are ordered by quality.
1705 * The first is always the native one.
1706 * @return the chosen format
1707 * - encoding: unused
1708 * - decoding: Set by user, if not set the native format will be chosen.
1710 enum AVPixelFormat (*get_format)(struct AVCodecContext *s, const enum AVPixelFormat * fmt);
1713 * maximum number of B-frames between non-B-frames
1714 * Note: The output will be delayed by max_b_frames+1 relative to the input.
1715 * - encoding: Set by user.
1716 * - decoding: unused
1721 * qscale factor between IP and B-frames
1722 * If > 0 then the last P-frame quantizer will be used (q= lastp_q*factor+offset).
1723 * If < 0 then normal ratecontrol will be done (q= -normal_q*factor+offset).
1724 * - encoding: Set by user.
1725 * - decoding: unused
1727 float b_quant_factor;
1729 /** obsolete FIXME remove */
1731 #define FF_RC_STRATEGY_XVID 1
1733 int b_frame_strategy;
1735 #if FF_API_MPV_GLOBAL_OPTS
1737 * luma single coefficient elimination threshold
1738 * - encoding: Set by user.
1739 * - decoding: unused
1741 attribute_deprecated int luma_elim_threshold;
1744 * chroma single coeff elimination threshold
1745 * - encoding: Set by user.
1746 * - decoding: unused
1748 attribute_deprecated int chroma_elim_threshold;
1752 * qscale offset between IP and B-frames
1753 * - encoding: Set by user.
1754 * - decoding: unused
1756 float b_quant_offset;
1759 * Size of the frame reordering buffer in the decoder.
1760 * For MPEG-2 it is 1 IPB or 0 low delay IP.
1761 * - encoding: Set by libavcodec.
1762 * - decoding: Set by libavcodec.
1767 * 0-> h263 quant 1-> mpeg quant
1768 * - encoding: Set by user.
1769 * - decoding: unused
1774 * qscale factor between P and I-frames
1775 * If > 0 then the last p frame quantizer will be used (q= lastp_q*factor+offset).
1776 * If < 0 then normal ratecontrol will be done (q= -normal_q*factor+offset).
1777 * - encoding: Set by user.
1778 * - decoding: unused
1780 float i_quant_factor;
1783 * qscale offset between P and I-frames
1784 * - encoding: Set by user.
1785 * - decoding: unused
1787 float i_quant_offset;
1790 * luminance masking (0-> disabled)
1791 * - encoding: Set by user.
1792 * - decoding: unused
1797 * temporary complexity masking (0-> disabled)
1798 * - encoding: Set by user.
1799 * - decoding: unused
1801 float temporal_cplx_masking;
1804 * spatial complexity masking (0-> disabled)
1805 * - encoding: Set by user.
1806 * - decoding: unused
1808 float spatial_cplx_masking;
1811 * p block masking (0-> disabled)
1812 * - encoding: Set by user.
1813 * - decoding: unused
1818 * darkness masking (0-> disabled)
1819 * - encoding: Set by user.
1820 * - decoding: unused
1826 * - encoding: Set by libavcodec.
1827 * - decoding: Set by user (or 0).
1831 * prediction method (needed for huffyuv)
1832 * - encoding: Set by user.
1833 * - decoding: unused
1835 int prediction_method;
1836 #define FF_PRED_LEFT 0
1837 #define FF_PRED_PLANE 1
1838 #define FF_PRED_MEDIAN 2
1841 * slice offsets in the frame in bytes
1842 * - encoding: Set/allocated by libavcodec.
1843 * - decoding: Set/allocated by user (or NULL).
1848 * sample aspect ratio (0 if unknown)
1849 * That is the width of a pixel divided by the height of the pixel.
1850 * Numerator and denominator must be relatively prime and smaller than 256 for some video standards.
1851 * - encoding: Set by user.
1852 * - decoding: Set by libavcodec.
1854 AVRational sample_aspect_ratio;
1857 * motion estimation comparison function
1858 * - encoding: Set by user.
1859 * - decoding: unused
1863 * subpixel motion estimation comparison function
1864 * - encoding: Set by user.
1865 * - decoding: unused
1869 * macroblock comparison function (not supported yet)
1870 * - encoding: Set by user.
1871 * - decoding: unused
1875 * interlaced DCT comparison function
1876 * - encoding: Set by user.
1877 * - decoding: unused
1880 #define FF_CMP_SAD 0
1881 #define FF_CMP_SSE 1
1882 #define FF_CMP_SATD 2
1883 #define FF_CMP_DCT 3
1884 #define FF_CMP_PSNR 4
1885 #define FF_CMP_BIT 5
1887 #define FF_CMP_ZERO 7
1888 #define FF_CMP_VSAD 8
1889 #define FF_CMP_VSSE 9
1890 #define FF_CMP_NSSE 10
1891 #define FF_CMP_W53 11
1892 #define FF_CMP_W97 12
1893 #define FF_CMP_DCTMAX 13
1894 #define FF_CMP_DCT264 14
1895 #define FF_CMP_CHROMA 256
1898 * ME diamond size & shape
1899 * - encoding: Set by user.
1900 * - decoding: unused
1905 * amount of previous MV predictors (2a+1 x 2a+1 square)
1906 * - encoding: Set by user.
1907 * - decoding: unused
1909 int last_predictor_count;
1912 * prepass for motion estimation
1913 * - encoding: Set by user.
1914 * - decoding: unused
1919 * motion estimation prepass comparison function
1920 * - encoding: Set by user.
1921 * - decoding: unused
1926 * ME prepass diamond size & shape
1927 * - encoding: Set by user.
1928 * - decoding: unused
1934 * - encoding: Set by user.
1935 * - decoding: unused
1937 int me_subpel_quality;
1940 * DTG active format information (additional aspect ratio
1941 * information only used in DVB MPEG-2 transport streams)
1944 * - encoding: unused
1945 * - decoding: Set by decoder.
1947 int dtg_active_format;
1948 #define FF_DTG_AFD_SAME 8
1949 #define FF_DTG_AFD_4_3 9
1950 #define FF_DTG_AFD_16_9 10
1951 #define FF_DTG_AFD_14_9 11
1952 #define FF_DTG_AFD_4_3_SP_14_9 13
1953 #define FF_DTG_AFD_16_9_SP_14_9 14
1954 #define FF_DTG_AFD_SP_4_3 15
1957 * maximum motion estimation search range in subpel units
1958 * If 0 then no limit.
1960 * - encoding: Set by user.
1961 * - decoding: unused
1966 * intra quantizer bias
1967 * - encoding: Set by user.
1968 * - decoding: unused
1970 int intra_quant_bias;
1971 #define FF_DEFAULT_QUANT_BIAS 999999
1974 * inter quantizer bias
1975 * - encoding: Set by user.
1976 * - decoding: unused
1978 int inter_quant_bias;
1980 #if FF_API_COLOR_TABLE_ID
1983 * - encoding: unused
1984 * - decoding: Which clrtable should be used for 8bit RGB images.
1985 * Tables have to be stored somewhere. FIXME
1987 attribute_deprecated int color_table_id;
1992 * - encoding: unused
1993 * - decoding: Set by user.
1996 #define SLICE_FLAG_CODED_ORDER 0x0001 ///< draw_horiz_band() is called in coded order instead of display
1997 #define SLICE_FLAG_ALLOW_FIELD 0x0002 ///< allow draw_horiz_band() with field slices (MPEG2 field pics)
1998 #define SLICE_FLAG_ALLOW_PLANE 0x0004 ///< allow draw_horiz_band() with 1 component at a time (SVQ1)
2001 * XVideo Motion Acceleration
2002 * - encoding: forbidden
2003 * - decoding: set by decoder
2005 int xvmc_acceleration;
2008 * macroblock decision mode
2009 * - encoding: Set by user.
2010 * - decoding: unused
2013 #define FF_MB_DECISION_SIMPLE 0 ///< uses mb_cmp
2014 #define FF_MB_DECISION_BITS 1 ///< chooses the one which needs the fewest bits
2015 #define FF_MB_DECISION_RD 2 ///< rate distortion
2018 * custom intra quantization matrix
2019 * - encoding: Set by user, can be NULL.
2020 * - decoding: Set by libavcodec.
2022 uint16_t *intra_matrix;
2025 * custom inter quantization matrix
2026 * - encoding: Set by user, can be NULL.
2027 * - decoding: Set by libavcodec.
2029 uint16_t *inter_matrix;
2032 * scene change detection threshold
2033 * 0 is default, larger means fewer detected scene changes.
2034 * - encoding: Set by user.
2035 * - decoding: unused
2037 int scenechange_threshold;
2040 * noise reduction strength
2041 * - encoding: Set by user.
2042 * - decoding: unused
2044 int noise_reduction;
2046 #if FF_API_INTER_THRESHOLD
2048 * @deprecated this field is unused
2050 attribute_deprecated int inter_threshold;
2053 #if FF_API_MPV_GLOBAL_OPTS
2055 * @deprecated use mpegvideo private options instead
2057 attribute_deprecated int quantizer_noise_shaping;
2061 * Motion estimation threshold below which no motion estimation is
2062 * performed, but instead the user specified motion vectors are used.
2064 * - encoding: Set by user.
2065 * - decoding: unused
2070 * Macroblock threshold below which the user specified macroblock types will be used.
2071 * - encoding: Set by user.
2072 * - decoding: unused
2077 * precision of the intra DC coefficient - 8
2078 * - encoding: Set by user.
2079 * - decoding: unused
2081 int intra_dc_precision;
2084 * Number of macroblock rows at the top which are skipped.
2085 * - encoding: unused
2086 * - decoding: Set by user.
2091 * Number of macroblock rows at the bottom which are skipped.
2092 * - encoding: unused
2093 * - decoding: Set by user.
2098 * Border processing masking, raises the quantizer for mbs on the borders
2100 * - encoding: Set by user.
2101 * - decoding: unused
2103 float border_masking;
2106 * minimum MB lagrange multipler
2107 * - encoding: Set by user.
2108 * - decoding: unused
2113 * maximum MB lagrange multipler
2114 * - encoding: Set by user.
2115 * - decoding: unused
2121 * - encoding: Set by user.
2122 * - decoding: unused
2124 int me_penalty_compensation;
2128 * - encoding: Set by user.
2129 * - decoding: unused
2135 * - encoding: Set by user.
2136 * - decoding: unused
2142 * - encoding: Set by user.
2143 * - decoding: unused
2148 * number of reference frames
2149 * - encoding: Set by user.
2150 * - decoding: Set by lavc.
2155 * chroma qp offset from luma
2156 * - encoding: Set by user.
2157 * - decoding: unused
2162 * Multiplied by qscale for each frame and added to scene_change_score.
2163 * - encoding: Set by user.
2164 * - decoding: unused
2166 int scenechange_factor;
2170 * Note: Value depends upon the compare function used for fullpel ME.
2171 * - encoding: Set by user.
2172 * - decoding: unused
2177 * Adjust sensitivity of b_frame_strategy 1.
2178 * - encoding: Set by user.
2179 * - decoding: unused
2184 * Chromaticity coordinates of the source primaries.
2185 * - encoding: Set by user
2186 * - decoding: Set by libavcodec
2188 enum AVColorPrimaries color_primaries;
2191 * Color Transfer Characteristic.
2192 * - encoding: Set by user
2193 * - decoding: Set by libavcodec
2195 enum AVColorTransferCharacteristic color_trc;
2198 * YUV colorspace type.
2199 * - encoding: Set by user
2200 * - decoding: Set by libavcodec
2202 enum AVColorSpace colorspace;
2205 * MPEG vs JPEG YUV range.
2206 * - encoding: Set by user
2207 * - decoding: Set by libavcodec
2209 enum AVColorRange color_range;
2212 * This defines the location of chroma samples.
2213 * - encoding: Set by user
2214 * - decoding: Set by libavcodec
2216 enum AVChromaLocation chroma_sample_location;
2220 * Indicates number of picture subdivisions. Used for parallelized
2222 * - encoding: Set by user
2223 * - decoding: unused
2228 * - encoding: set by libavcodec
2229 * - decoding: Set by user.
2231 enum AVFieldOrder field_order;
2234 int sample_rate; ///< samples per second
2235 int channels; ///< number of audio channels
2238 * audio sample format
2239 * - encoding: Set by user.
2240 * - decoding: Set by libavcodec.
2242 enum AVSampleFormat sample_fmt; ///< sample format
2244 /* The following data should not be initialized. */
2246 * Samples per packet, initialized when calling 'init'.
2251 * Frame counter, set by libavcodec.
2253 * - decoding: total number of frames returned from the decoder so far.
2254 * - encoding: total number of frames passed to the encoder so far.
2256 * @note the counter is not incremented if encoding/decoding resulted in
2262 * number of bytes per packet if constant and known or 0
2263 * Used by some WAV based audio codecs.
2268 * Audio cutoff bandwidth (0 means "automatic")
2269 * - encoding: Set by user.
2270 * - decoding: unused
2274 #if FF_API_REQUEST_CHANNELS
2276 * Decoder should decode to this many channels if it can (0 for default)
2277 * - encoding: unused
2278 * - decoding: Set by user.
2279 * @deprecated Deprecated in favor of request_channel_layout.
2281 int request_channels;
2285 * Audio channel layout.
2286 * - encoding: set by user.
2287 * - decoding: set by user, may be overwritten by libavcodec.
2289 uint64_t channel_layout;
2292 * Request decoder to use this channel layout if it can (0 for default)
2293 * - encoding: unused
2294 * - decoding: Set by user.
2296 uint64_t request_channel_layout;
2299 * Type of service that the audio stream conveys.
2300 * - encoding: Set by user.
2301 * - decoding: Set by libavcodec.
2303 enum AVAudioServiceType audio_service_type;
2306 * desired sample format
2307 * - encoding: Not used.
2308 * - decoding: Set by user.
2309 * Decoder will decode to this format if it can.
2311 enum AVSampleFormat request_sample_fmt;
2314 * Called at the beginning of each frame to get a buffer for it.
2316 * The function will set AVFrame.data[], AVFrame.linesize[].
2317 * AVFrame.extended_data[] must also be set, but it should be the same as
2318 * AVFrame.data[] except for planar audio with more channels than can fit
2319 * in AVFrame.data[]. In that case, AVFrame.data[] shall still contain as
2320 * many data pointers as it can hold.
2322 * if CODEC_CAP_DR1 is not set then get_buffer() must call
2323 * avcodec_default_get_buffer() instead of providing buffers allocated by
2326 * AVFrame.data[] should be 32- or 16-byte-aligned unless the CPU doesn't
2327 * need it. avcodec_default_get_buffer() aligns the output buffer properly,
2328 * but if get_buffer() is overridden then alignment considerations should
2329 * be taken into account.
2331 * @see avcodec_default_get_buffer()
2335 * If pic.reference is set then the frame will be read later by libavcodec.
2336 * avcodec_align_dimensions2() should be used to find the required width and
2337 * height, as they normally need to be rounded up to the next multiple of 16.
2339 * If frame multithreading is used and thread_safe_callbacks is set,
2340 * it may be called from a different thread, but not from more than one at
2341 * once. Does not need to be reentrant.
2343 * @see release_buffer(), reget_buffer()
2344 * @see avcodec_align_dimensions2()
2348 * Decoders request a buffer of a particular size by setting
2349 * AVFrame.nb_samples prior to calling get_buffer(). The decoder may,
2350 * however, utilize only part of the buffer by setting AVFrame.nb_samples
2351 * to a smaller value in the output frame.
2353 * Decoders cannot use the buffer after returning from
2354 * avcodec_decode_audio4(), so they will not call release_buffer(), as it
2355 * is assumed to be released immediately upon return.
2357 * As a convenience, av_samples_get_buffer_size() and
2358 * av_samples_fill_arrays() in libavutil may be used by custom get_buffer()
2359 * functions to find the required data size and to fill data pointers and
2360 * linesize. In AVFrame.linesize, only linesize[0] may be set for audio
2361 * since all planes must be the same size.
2363 * @see av_samples_get_buffer_size(), av_samples_fill_arrays()
2365 * - encoding: unused
2366 * - decoding: Set by libavcodec, user can override.
2368 int (*get_buffer)(struct AVCodecContext *c, AVFrame *pic);
2371 * Called to release buffers which were allocated with get_buffer.
2372 * A released buffer can be reused in get_buffer().
2373 * pic.data[*] must be set to NULL.
2374 * May be called from a different thread if frame multithreading is used,
2375 * but not by more than one thread at once, so does not need to be reentrant.
2376 * - encoding: unused
2377 * - decoding: Set by libavcodec, user can override.
2379 void (*release_buffer)(struct AVCodecContext *c, AVFrame *pic);
2382 * Called at the beginning of a frame to get cr buffer for it.
2383 * Buffer type (size, hints) must be the same. libavcodec won't check it.
2384 * libavcodec will pass previous buffer in pic, function should return
2385 * same buffer or new buffer with old frame "painted" into it.
2386 * If pic.data[0] == NULL must behave like get_buffer().
2387 * if CODEC_CAP_DR1 is not set then reget_buffer() must call
2388 * avcodec_default_reget_buffer() instead of providing buffers allocated by
2390 * - encoding: unused
2391 * - decoding: Set by libavcodec, user can override.
2393 int (*reget_buffer)(struct AVCodecContext *c, AVFrame *pic);
2396 /* - encoding parameters */
2397 float qcompress; ///< amount of qscale change between easy & hard scenes (0.0-1.0)
2398 float qblur; ///< amount of qscale smoothing over time (0.0-1.0)
2402 * - encoding: Set by user.
2403 * - decoding: unused
2409 * - encoding: Set by user.
2410 * - decoding: unused
2415 * maximum quantizer difference between frames
2416 * - encoding: Set by user.
2417 * - decoding: unused
2422 * ratecontrol qmin qmax limiting method
2423 * 0-> clipping, 1-> use a nice continuous function to limit qscale wthin qmin/qmax.
2424 * - encoding: Set by user.
2425 * - decoding: unused
2433 * decoder bitstream buffer size
2434 * - encoding: Set by user.
2435 * - decoding: unused
2440 * ratecontrol override, see RcOverride
2441 * - encoding: Allocated/set/freed by user.
2442 * - decoding: unused
2444 int rc_override_count;
2445 RcOverride *rc_override;
2448 * rate control equation
2449 * - encoding: Set by user
2450 * - decoding: unused
2456 * - encoding: Set by user.
2457 * - decoding: unused
2463 * - encoding: Set by user.
2464 * - decoding: unused
2468 float rc_buffer_aggressivity;
2471 * initial complexity for pass1 ratecontrol
2472 * - encoding: Set by user.
2473 * - decoding: unused
2475 float rc_initial_cplx;
2478 * Ratecontrol attempt to use, at maximum, <value> of what can be used without an underflow.
2479 * - encoding: Set by user.
2480 * - decoding: unused.
2482 float rc_max_available_vbv_use;
2485 * Ratecontrol attempt to use, at least, <value> times the amount needed to prevent a vbv overflow.
2486 * - encoding: Set by user.
2487 * - decoding: unused.
2489 float rc_min_vbv_overflow_use;
2492 * Number of bits which should be loaded into the rc buffer before decoding starts.
2493 * - encoding: Set by user.
2494 * - decoding: unused
2496 int rc_initial_buffer_occupancy;
2498 #define FF_CODER_TYPE_VLC 0
2499 #define FF_CODER_TYPE_AC 1
2500 #define FF_CODER_TYPE_RAW 2
2501 #define FF_CODER_TYPE_RLE 3
2502 #define FF_CODER_TYPE_DEFLATE 4
2505 * - encoding: Set by user.
2506 * - decoding: unused
2512 * - encoding: Set by user.
2513 * - decoding: unused
2518 * minimum Lagrange multipler
2519 * - encoding: Set by user.
2520 * - decoding: unused
2525 * maximum Lagrange multipler
2526 * - encoding: Set by user.
2527 * - decoding: unused
2532 * frame skip threshold
2533 * - encoding: Set by user.
2534 * - decoding: unused
2536 int frame_skip_threshold;
2540 * - encoding: Set by user.
2541 * - decoding: unused
2543 int frame_skip_factor;
2546 * frame skip exponent
2547 * - encoding: Set by user.
2548 * - decoding: unused
2553 * frame skip comparison function
2554 * - encoding: Set by user.
2555 * - decoding: unused
2560 * trellis RD quantization
2561 * - encoding: Set by user.
2562 * - decoding: unused
2567 * - encoding: Set by user.
2568 * - decoding: unused
2570 int min_prediction_order;
2573 * - encoding: Set by user.
2574 * - decoding: unused
2576 int max_prediction_order;
2579 * GOP timecode frame start number
2580 * - encoding: Set by user, in non drop frame format
2581 * - decoding: Set by libavcodec (timecode in the 25 bits format, -1 if unset)
2583 int64_t timecode_frame_start;
2585 /* The RTP callback: This function is called */
2586 /* every time the encoder has a packet to send. */
2587 /* It depends on the encoder if the data starts */
2588 /* with a Start Code (it should). H.263 does. */
2589 /* mb_nb contains the number of macroblocks */
2590 /* encoded in the RTP payload. */
2591 void (*rtp_callback)(struct AVCodecContext *avctx, void *data, int size, int mb_nb);
2593 int rtp_payload_size; /* The size of the RTP payload: the coder will */
2594 /* do its best to deliver a chunk with size */
2595 /* below rtp_payload_size, the chunk will start */
2596 /* with a start code on some codecs like H.263. */
2597 /* This doesn't take account of any particular */
2598 /* headers inside the transmitted RTP payload. */
2600 /* statistics, used for 2-pass encoding */
2611 * number of bits used for the previously encoded frame
2612 * - encoding: Set by libavcodec.
2613 * - decoding: unused
2618 * pass1 encoding statistics output buffer
2619 * - encoding: Set by libavcodec.
2620 * - decoding: unused
2625 * pass2 encoding statistics input buffer
2626 * Concatenated stuff from stats_out of pass1 should be placed here.
2627 * - encoding: Allocated/set/freed by user.
2628 * - decoding: unused
2633 * Work around bugs in encoders which sometimes cannot be detected automatically.
2634 * - encoding: Set by user
2635 * - decoding: Set by user
2637 int workaround_bugs;
2638 #define FF_BUG_AUTODETECT 1 ///< autodetection
2639 #define FF_BUG_OLD_MSMPEG4 2
2640 #define FF_BUG_XVID_ILACE 4
2641 #define FF_BUG_UMP4 8
2642 #define FF_BUG_NO_PADDING 16
2643 #define FF_BUG_AMV 32
2644 #define FF_BUG_AC_VLC 0 ///< Will be removed, libavcodec can now handle these non-compliant files by default.
2645 #define FF_BUG_QPEL_CHROMA 64
2646 #define FF_BUG_STD_QPEL 128
2647 #define FF_BUG_QPEL_CHROMA2 256
2648 #define FF_BUG_DIRECT_BLOCKSIZE 512
2649 #define FF_BUG_EDGE 1024
2650 #define FF_BUG_HPEL_CHROMA 2048
2651 #define FF_BUG_DC_CLIP 4096
2652 #define FF_BUG_MS 8192 ///< Work around various bugs in Microsoft's broken decoders.
2653 #define FF_BUG_TRUNCATED 16384
2656 * strictly follow the standard (MPEG4, ...).
2657 * - encoding: Set by user.
2658 * - decoding: Set by user.
2659 * Setting this to STRICT or higher means the encoder and decoder will
2660 * generally do stupid things, whereas setting it to unofficial or lower
2661 * will mean the encoder might produce output that is not supported by all
2662 * spec-compliant decoders. Decoders don't differentiate between normal,
2663 * unofficial and experimental (that is, they always try to decode things
2664 * when they can) unless they are explicitly asked to behave stupidly
2665 * (=strictly conform to the specs)
2667 int strict_std_compliance;
2668 #define FF_COMPLIANCE_VERY_STRICT 2 ///< Strictly conform to an older more strict version of the spec or reference software.
2669 #define FF_COMPLIANCE_STRICT 1 ///< Strictly conform to all the things in the spec no matter what consequences.
2670 #define FF_COMPLIANCE_NORMAL 0
2671 #define FF_COMPLIANCE_UNOFFICIAL -1 ///< Allow unofficial extensions
2672 #define FF_COMPLIANCE_EXPERIMENTAL -2 ///< Allow nonstandardized experimental things.
2675 * error concealment flags
2676 * - encoding: unused
2677 * - decoding: Set by user.
2679 int error_concealment;
2680 #define FF_EC_GUESS_MVS 1
2681 #define FF_EC_DEBLOCK 2
2685 * - encoding: Set by user.
2686 * - decoding: Set by user.
2689 #define FF_DEBUG_PICT_INFO 1
2690 #define FF_DEBUG_RC 2
2691 #define FF_DEBUG_BITSTREAM 4
2692 #define FF_DEBUG_MB_TYPE 8
2693 #define FF_DEBUG_QP 16
2694 #define FF_DEBUG_MV 32
2695 #define FF_DEBUG_DCT_COEFF 0x00000040
2696 #define FF_DEBUG_SKIP 0x00000080
2697 #define FF_DEBUG_STARTCODE 0x00000100
2698 #define FF_DEBUG_PTS 0x00000200
2699 #define FF_DEBUG_ER 0x00000400
2700 #define FF_DEBUG_MMCO 0x00000800
2701 #define FF_DEBUG_BUGS 0x00001000
2702 #define FF_DEBUG_VIS_QP 0x00002000
2703 #define FF_DEBUG_VIS_MB_TYPE 0x00004000
2704 #define FF_DEBUG_BUFFERS 0x00008000
2705 #define FF_DEBUG_THREADS 0x00010000
2709 * - encoding: Set by user.
2710 * - decoding: Set by user.
2713 #define FF_DEBUG_VIS_MV_P_FOR 0x00000001 //visualize forward predicted MVs of P frames
2714 #define FF_DEBUG_VIS_MV_B_FOR 0x00000002 //visualize forward predicted MVs of B frames
2715 #define FF_DEBUG_VIS_MV_B_BACK 0x00000004 //visualize backward predicted MVs of B frames
2718 * Error recognition; may misdetect some more or less valid parts as errors.
2719 * - encoding: unused
2720 * - decoding: Set by user.
2722 int err_recognition;
2723 #define AV_EF_CRCCHECK (1<<0)
2724 #define AV_EF_BITSTREAM (1<<1)
2725 #define AV_EF_BUFFER (1<<2)
2726 #define AV_EF_EXPLODE (1<<3)
2728 #define AV_EF_CAREFUL (1<<16)
2729 #define AV_EF_COMPLIANT (1<<17)
2730 #define AV_EF_AGGRESSIVE (1<<18)
2734 * opaque 64bit number (generally a PTS) that will be reordered and
2735 * output in AVFrame.reordered_opaque
2736 * @deprecated in favor of pkt_pts
2737 * - encoding: unused
2738 * - decoding: Set by user.
2740 int64_t reordered_opaque;
2743 * Hardware accelerator in use
2744 * - encoding: unused.
2745 * - decoding: Set by libavcodec
2747 struct AVHWAccel *hwaccel;
2750 * Hardware accelerator context.
2751 * For some hardware accelerators, a global context needs to be
2752 * provided by the user. In that case, this holds display-dependent
2753 * data FFmpeg cannot instantiate itself. Please refer to the
2754 * FFmpeg HW accelerator documentation to know how to fill this
2755 * is. e.g. for VA API, this is a struct vaapi_context.
2756 * - encoding: unused
2757 * - decoding: Set by user
2759 void *hwaccel_context;
2763 * - encoding: Set by libavcodec if flags&CODEC_FLAG_PSNR.
2764 * - decoding: unused
2766 uint64_t error[AV_NUM_DATA_POINTERS];
2769 * DCT algorithm, see FF_DCT_* below
2770 * - encoding: Set by user.
2771 * - decoding: unused
2774 #define FF_DCT_AUTO 0
2775 #define FF_DCT_FASTINT 1
2776 #define FF_DCT_INT 2
2777 #define FF_DCT_MMX 3
2778 #define FF_DCT_ALTIVEC 5
2779 #define FF_DCT_FAAN 6
2782 * IDCT algorithm, see FF_IDCT_* below.
2783 * - encoding: Set by user.
2784 * - decoding: Set by user.
2787 #define FF_IDCT_AUTO 0
2788 #define FF_IDCT_INT 1
2789 #define FF_IDCT_SIMPLE 2
2790 #define FF_IDCT_SIMPLEMMX 3
2791 #define FF_IDCT_LIBMPEG2MMX 4
2793 #define FF_IDCT_MMI 5
2795 #define FF_IDCT_ARM 7
2796 #define FF_IDCT_ALTIVEC 8
2797 #define FF_IDCT_SH4 9
2798 #define FF_IDCT_SIMPLEARM 10
2799 #define FF_IDCT_H264 11
2800 #define FF_IDCT_VP3 12
2801 #define FF_IDCT_IPP 13
2802 #define FF_IDCT_XVIDMMX 14
2803 #define FF_IDCT_CAVS 15
2804 #define FF_IDCT_SIMPLEARMV5TE 16
2805 #define FF_IDCT_SIMPLEARMV6 17
2806 #define FF_IDCT_SIMPLEVIS 18
2807 #define FF_IDCT_WMV2 19
2808 #define FF_IDCT_FAAN 20
2809 #define FF_IDCT_EA 21
2810 #define FF_IDCT_SIMPLENEON 22
2811 #define FF_IDCT_SIMPLEALPHA 23
2812 #define FF_IDCT_BINK 24
2817 * @deprecated use av_set_cpu_flags_mask() instead.
2819 attribute_deprecated unsigned dsp_mask;
2823 * bits per sample/pixel from the demuxer (needed for huffyuv).
2824 * - encoding: Set by libavcodec.
2825 * - decoding: Set by user.
2827 int bits_per_coded_sample;
2830 * Bits per sample/pixel of internal libavcodec pixel/sample format.
2831 * - encoding: set by user.
2832 * - decoding: set by libavcodec.
2834 int bits_per_raw_sample;
2837 * low resolution decoding, 1-> 1/2 size, 2->1/4 size
2838 * - encoding: unused
2839 * - decoding: Set by user.
2844 * the picture in the bitstream
2845 * - encoding: Set by libavcodec.
2846 * - decoding: Set by libavcodec.
2848 AVFrame *coded_frame;
2852 * is used to decide how many independent tasks should be passed to execute()
2853 * - encoding: Set by user.
2854 * - decoding: Set by user.
2859 * Which multithreading methods to use.
2860 * Use of FF_THREAD_FRAME will increase decoding delay by one frame per thread,
2861 * so clients which cannot provide future frames should not use it.
2863 * - encoding: Set by user, otherwise the default is used.
2864 * - decoding: Set by user, otherwise the default is used.
2867 #define FF_THREAD_FRAME 1 ///< Decode more than one frame at once
2868 #define FF_THREAD_SLICE 2 ///< Decode more than one part of a single frame at once
2871 * Which multithreading methods are in use by the codec.
2872 * - encoding: Set by libavcodec.
2873 * - decoding: Set by libavcodec.
2875 int active_thread_type;
2878 * Set by the client if its custom get_buffer() callback can be called
2879 * synchronously from another thread, which allows faster multithreaded decoding.
2880 * draw_horiz_band() will be called from other threads regardless of this setting.
2881 * Ignored if the default get_buffer() is used.
2882 * - encoding: Set by user.
2883 * - decoding: Set by user.
2885 int thread_safe_callbacks;
2888 * The codec may call this to execute several independent things.
2889 * It will return only after finishing all tasks.
2890 * The user may replace this with some multithreaded implementation,
2891 * the default implementation will execute the parts serially.
2892 * @param count the number of things to execute
2893 * - encoding: Set by libavcodec, user can override.
2894 * - decoding: Set by libavcodec, user can override.
2896 int (*execute)(struct AVCodecContext *c, int (*func)(struct AVCodecContext *c2, void *arg), void *arg2, int *ret, int count, int size);
2899 * The codec may call this to execute several independent things.
2900 * It will return only after finishing all tasks.
2901 * The user may replace this with some multithreaded implementation,
2902 * the default implementation will execute the parts serially.
2903 * Also see avcodec_thread_init and e.g. the --enable-pthread configure option.
2904 * @param c context passed also to func
2905 * @param count the number of things to execute
2906 * @param arg2 argument passed unchanged to func
2907 * @param ret return values of executed functions, must have space for "count" values. May be NULL.
2908 * @param func function that will be called count times, with jobnr from 0 to count-1.
2909 * threadnr will be in the range 0 to c->thread_count-1 < MAX_THREADS and so that no
2910 * two instances of func executing at the same time will have the same threadnr.
2911 * @return always 0 currently, but code should handle a future improvement where when any call to func
2912 * returns < 0 no further calls to func may be done and < 0 is returned.
2913 * - encoding: Set by libavcodec, user can override.
2914 * - decoding: Set by libavcodec, user can override.
2916 int (*execute2)(struct AVCodecContext *c, int (*func)(struct AVCodecContext *c2, void *arg, int jobnr, int threadnr), void *arg2, int *ret, int count);
2920 * Can be used by execute() to store some per AVCodecContext stuff.
2921 * - encoding: set by execute()
2922 * - decoding: set by execute()
2924 void *thread_opaque;
2927 * noise vs. sse weight for the nsse comparsion function
2928 * - encoding: Set by user.
2929 * - decoding: unused
2935 * - encoding: Set by user.
2936 * - decoding: Set by libavcodec.
2939 #define FF_PROFILE_UNKNOWN -99
2940 #define FF_PROFILE_RESERVED -100
2942 #define FF_PROFILE_AAC_MAIN 0
2943 #define FF_PROFILE_AAC_LOW 1
2944 #define FF_PROFILE_AAC_SSR 2
2945 #define FF_PROFILE_AAC_LTP 3
2946 #define FF_PROFILE_AAC_HE 4
2947 #define FF_PROFILE_AAC_HE_V2 28
2948 #define FF_PROFILE_AAC_LD 22
2949 #define FF_PROFILE_AAC_ELD 38
2951 #define FF_PROFILE_DTS 20
2952 #define FF_PROFILE_DTS_ES 30
2953 #define FF_PROFILE_DTS_96_24 40
2954 #define FF_PROFILE_DTS_HD_HRA 50
2955 #define FF_PROFILE_DTS_HD_MA 60
2957 #define FF_PROFILE_MPEG2_422 0
2958 #define FF_PROFILE_MPEG2_HIGH 1
2959 #define FF_PROFILE_MPEG2_SS 2
2960 #define FF_PROFILE_MPEG2_SNR_SCALABLE 3
2961 #define FF_PROFILE_MPEG2_MAIN 4
2962 #define FF_PROFILE_MPEG2_SIMPLE 5
2964 #define FF_PROFILE_H264_CONSTRAINED (1<<9) // 8+1; constraint_set1_flag
2965 #define FF_PROFILE_H264_INTRA (1<<11) // 8+3; constraint_set3_flag
2967 #define FF_PROFILE_H264_BASELINE 66
2968 #define FF_PROFILE_H264_CONSTRAINED_BASELINE (66|FF_PROFILE_H264_CONSTRAINED)
2969 #define FF_PROFILE_H264_MAIN 77
2970 #define FF_PROFILE_H264_EXTENDED 88
2971 #define FF_PROFILE_H264_HIGH 100
2972 #define FF_PROFILE_H264_HIGH_10 110
2973 #define FF_PROFILE_H264_HIGH_10_INTRA (110|FF_PROFILE_H264_INTRA)
2974 #define FF_PROFILE_H264_HIGH_422 122
2975 #define FF_PROFILE_H264_HIGH_422_INTRA (122|FF_PROFILE_H264_INTRA)
2976 #define FF_PROFILE_H264_HIGH_444 144
2977 #define FF_PROFILE_H264_HIGH_444_PREDICTIVE 244
2978 #define FF_PROFILE_H264_HIGH_444_INTRA (244|FF_PROFILE_H264_INTRA)
2979 #define FF_PROFILE_H264_CAVLC_444 44
2981 #define FF_PROFILE_VC1_SIMPLE 0
2982 #define FF_PROFILE_VC1_MAIN 1
2983 #define FF_PROFILE_VC1_COMPLEX 2
2984 #define FF_PROFILE_VC1_ADVANCED 3
2986 #define FF_PROFILE_MPEG4_SIMPLE 0
2987 #define FF_PROFILE_MPEG4_SIMPLE_SCALABLE 1
2988 #define FF_PROFILE_MPEG4_CORE 2
2989 #define FF_PROFILE_MPEG4_MAIN 3
2990 #define FF_PROFILE_MPEG4_N_BIT 4
2991 #define FF_PROFILE_MPEG4_SCALABLE_TEXTURE 5
2992 #define FF_PROFILE_MPEG4_SIMPLE_FACE_ANIMATION 6
2993 #define FF_PROFILE_MPEG4_BASIC_ANIMATED_TEXTURE 7
2994 #define FF_PROFILE_MPEG4_HYBRID 8
2995 #define FF_PROFILE_MPEG4_ADVANCED_REAL_TIME 9
2996 #define FF_PROFILE_MPEG4_CORE_SCALABLE 10
2997 #define FF_PROFILE_MPEG4_ADVANCED_CODING 11
2998 #define FF_PROFILE_MPEG4_ADVANCED_CORE 12
2999 #define FF_PROFILE_MPEG4_ADVANCED_SCALABLE_TEXTURE 13
3000 #define FF_PROFILE_MPEG4_SIMPLE_STUDIO 14
3001 #define FF_PROFILE_MPEG4_ADVANCED_SIMPLE 15
3005 * - encoding: Set by user.
3006 * - decoding: Set by libavcodec.
3009 #define FF_LEVEL_UNKNOWN -99
3013 * - encoding: unused
3014 * - decoding: Set by user.
3016 enum AVDiscard skip_loop_filter;
3020 * - encoding: unused
3021 * - decoding: Set by user.
3023 enum AVDiscard skip_idct;
3027 * - encoding: unused
3028 * - decoding: Set by user.
3030 enum AVDiscard skip_frame;
3033 * Header containing style information for text subtitles.
3034 * For SUBTITLE_ASS subtitle type, it should contain the whole ASS
3035 * [Script Info] and [V4+ Styles] section, plus the [Events] line and
3036 * the Format line following. It shouldn't include any Dialogue line.
3037 * - encoding: Set/allocated/freed by user (before avcodec_open2())
3038 * - decoding: Set/allocated/freed by libavcodec (by avcodec_open2())
3040 uint8_t *subtitle_header;
3041 int subtitle_header_size;
3044 * Simulates errors in the bitstream to test error concealment.
3045 * - encoding: Set by user.
3046 * - decoding: unused
3051 * Current packet as passed into the decoder, to avoid having
3052 * to pass the packet into every function. Currently only valid
3053 * inside lavc and get/release_buffer callbacks.
3054 * - decoding: set by avcodec_decode_*, read by get_buffer() for setting pkt_pts
3055 * - encoding: unused
3060 * VBV delay coded in the last frame (in periods of a 27 MHz clock).
3061 * Used for compliant TS muxing.
3062 * - encoding: Set by libavcodec.
3063 * - decoding: unused.
3068 * Timebase in which pkt_dts/pts and AVPacket.dts/pts are.
3069 * Code outside libavcodec should access this field using:
3070 * avcodec_set_pkt_timebase(avctx)
3071 * - encoding unused.
3072 * - decodimg set by user
3074 AVRational pkt_timebase;
3078 * Code outside libavcodec should access this field using:
3079 * avcodec_get_codec_descriptior(avctx)
3080 * - encoding: unused.
3081 * - decoding: set by libavcodec.
3083 const AVCodecDescriptor *codec_descriptor;
3086 * Current statistics for PTS correction.
3087 * - decoding: maintained and used by libavcodec, not intended to be used by user apps
3088 * - encoding: unused
3090 int64_t pts_correction_num_faulty_pts; /// Number of incorrect PTS values so far
3091 int64_t pts_correction_num_faulty_dts; /// Number of incorrect DTS values so far
3092 int64_t pts_correction_last_pts; /// PTS of the last frame
3093 int64_t pts_correction_last_dts; /// DTS of the last frame
3096 AVRational av_codec_get_pkt_timebase (const AVCodecContext *avctx);
3097 void av_codec_set_pkt_timebase (AVCodecContext *avctx, AVRational val);
3099 const AVCodecDescriptor *av_codec_get_codec_descriptor(const AVCodecContext *avctx);
3100 void av_codec_set_codec_descriptor(AVCodecContext *avctx, const AVCodecDescriptor *desc);
3105 typedef struct AVProfile {
3107 const char *name; ///< short name for the profile
3110 typedef struct AVCodecDefault AVCodecDefault;
3117 typedef struct AVCodec {
3119 * Name of the codec implementation.
3120 * The name is globally unique among encoders and among decoders (but an
3121 * encoder and a decoder can share the same name).
3122 * This is the primary way to find a codec from the user perspective.
3126 * Descriptive name for the codec, meant to be more human readable than name.
3127 * You should use the NULL_IF_CONFIG_SMALL() macro to define it.
3129 const char *long_name;
3130 enum AVMediaType type;
3133 * Codec capabilities.
3137 const AVRational *supported_framerates; ///< array of supported framerates, or NULL if any, array is terminated by {0,0}
3138 const enum AVPixelFormat *pix_fmts; ///< array of supported pixel formats, or NULL if unknown, array is terminated by -1
3139 const int *supported_samplerates; ///< array of supported audio samplerates, or NULL if unknown, array is terminated by 0
3140 const enum AVSampleFormat *sample_fmts; ///< array of supported sample formats, or NULL if unknown, array is terminated by -1
3141 const uint64_t *channel_layouts; ///< array of support channel layouts, or NULL if unknown. array is terminated by 0
3142 uint8_t max_lowres; ///< maximum value for lowres supported by the decoder
3143 const AVClass *priv_class; ///< AVClass for the private context
3144 const AVProfile *profiles; ///< array of recognized profiles, or NULL if unknown, array is terminated by {FF_PROFILE_UNKNOWN}
3146 /*****************************************************************
3147 * No fields below this line are part of the public API. They
3148 * may not be used outside of libavcodec and can be changed and
3150 * New public fields should be added right above.
3151 *****************************************************************
3154 struct AVCodec *next;
3156 * @name Frame-level threading support functions
3160 * If defined, called on thread contexts when they are created.
3161 * If the codec allocates writable tables in init(), re-allocate them here.
3162 * priv_data will be set to a copy of the original.
3164 int (*init_thread_copy)(AVCodecContext *);
3166 * Copy necessary context variables from a previous thread context to the current one.
3167 * If not defined, the next thread will start automatically; otherwise, the codec
3168 * must call ff_thread_finish_setup().
3170 * dst and src will (rarely) point to the same context, in which case memcpy should be skipped.
3172 int (*update_thread_context)(AVCodecContext *dst, const AVCodecContext *src);
3176 * Private codec-specific defaults.
3178 const AVCodecDefault *defaults;
3181 * Initialize codec static data, called from avcodec_register().
3183 void (*init_static_data)(struct AVCodec *codec);
3185 int (*init)(AVCodecContext *);
3186 int (*encode_sub)(AVCodecContext *, uint8_t *buf, int buf_size,
3187 const struct AVSubtitle *sub);
3189 * Encode data to an AVPacket.
3191 * @param avctx codec context
3192 * @param avpkt output AVPacket (may contain a user-provided buffer)
3193 * @param[in] frame AVFrame containing the raw data to be encoded
3194 * @param[out] got_packet_ptr encoder sets to 0 or 1 to indicate that a
3195 * non-empty packet was returned in avpkt.
3196 * @return 0 on success, negative error code on failure
3198 int (*encode2)(AVCodecContext *avctx, AVPacket *avpkt, const AVFrame *frame,
3199 int *got_packet_ptr);
3200 int (*decode)(AVCodecContext *, void *outdata, int *outdata_size, AVPacket *avpkt);
3201 int (*close)(AVCodecContext *);
3204 * Will be called when seeking
3206 void (*flush)(AVCodecContext *);
3212 typedef struct AVHWAccel {
3214 * Name of the hardware accelerated codec.
3215 * The name is globally unique among encoders and among decoders (but an
3216 * encoder and a decoder can share the same name).
3221 * Type of codec implemented by the hardware accelerator.
3223 * See AVMEDIA_TYPE_xxx
3225 enum AVMediaType type;
3228 * Codec implemented by the hardware accelerator.
3230 * See AV_CODEC_ID_xxx
3235 * Supported pixel format.
3237 * Only hardware accelerated formats are supported here.
3239 enum AVPixelFormat pix_fmt;
3242 * Hardware accelerated codec capabilities.
3243 * see FF_HWACCEL_CODEC_CAP_*
3247 struct AVHWAccel *next;
3250 * Called at the beginning of each frame or field picture.
3252 * Meaningful frame information (codec specific) is guaranteed to
3253 * be parsed at this point. This function is mandatory.
3255 * Note that buf can be NULL along with buf_size set to 0.
3256 * Otherwise, this means the whole frame is available at this point.
3258 * @param avctx the codec context
3259 * @param buf the frame data buffer base
3260 * @param buf_size the size of the frame in bytes
3261 * @return zero if successful, a negative value otherwise
3263 int (*start_frame)(AVCodecContext *avctx, const uint8_t *buf, uint32_t buf_size);
3266 * Callback for each slice.
3268 * Meaningful slice information (codec specific) is guaranteed to
3269 * be parsed at this point. This function is mandatory.
3271 * @param avctx the codec context
3272 * @param buf the slice data buffer base
3273 * @param buf_size the size of the slice in bytes
3274 * @return zero if successful, a negative value otherwise
3276 int (*decode_slice)(AVCodecContext *avctx, const uint8_t *buf, uint32_t buf_size);
3279 * Called at the end of each frame or field picture.
3281 * The whole picture is parsed at this point and can now be sent
3282 * to the hardware accelerator. This function is mandatory.
3284 * @param avctx the codec context
3285 * @return zero if successful, a negative value otherwise
3287 int (*end_frame)(AVCodecContext *avctx);
3290 * Size of HW accelerator private data.
3292 * Private data is allocated with av_mallocz() before
3293 * AVCodecContext.get_buffer() and deallocated after
3294 * AVCodecContext.release_buffer().
3300 * @defgroup lavc_picture AVPicture
3302 * Functions for working with AVPicture
3307 * four components are given, that's all.
3308 * the last component is alpha
3310 typedef struct AVPicture {
3311 uint8_t *data[AV_NUM_DATA_POINTERS];
3312 int linesize[AV_NUM_DATA_POINTERS]; ///< number of bytes per line
3319 enum AVSubtitleType {
3322 SUBTITLE_BITMAP, ///< A bitmap, pict will be set
3325 * Plain text, the text field must be set by the decoder and is
3326 * authoritative. ass and pict fields may contain approximations.
3331 * Formatted text, the ass field must be set by the decoder and is
3332 * authoritative. pict and text fields may contain approximations.
3337 typedef struct AVSubtitleRect {
3338 int x; ///< top left corner of pict, undefined when pict is not set
3339 int y; ///< top left corner of pict, undefined when pict is not set
3340 int w; ///< width of pict, undefined when pict is not set
3341 int h; ///< height of pict, undefined when pict is not set
3342 int nb_colors; ///< number of colors in pict, undefined when pict is not set
3345 * data+linesize for the bitmap of this subtitle.
3346 * can be set for text/ass as well once they where rendered
3349 enum AVSubtitleType type;
3351 char *text; ///< 0 terminated plain UTF-8 text
3354 * 0 terminated ASS/SSA compatible event line.
3355 * The presentation of this is unaffected by the other values in this
3361 * 1 indicates this subtitle is a forced subtitle.
3362 * A forced subtitle should be displayed even when subtitles are hidden.
3367 typedef struct AVSubtitle {
3368 uint16_t format; /* 0 = graphics */
3369 uint32_t start_display_time; /* relative to packet pts, in ms */
3370 uint32_t end_display_time; /* relative to packet pts, in ms */
3372 AVSubtitleRect **rects;
3373 int64_t pts; ///< Same as packet pts, in AV_TIME_BASE
3377 * If c is NULL, returns the first registered codec,
3378 * if c is non-NULL, returns the next registered codec after c,
3379 * or NULL if c is the last one.
3381 AVCodec *av_codec_next(const AVCodec *c);
3384 * Return the LIBAVCODEC_VERSION_INT constant.
3386 unsigned avcodec_version(void);
3389 * Return the libavcodec build-time configuration.
3391 const char *avcodec_configuration(void);
3394 * Return the libavcodec license.
3396 const char *avcodec_license(void);
3399 * Register the codec codec and initialize libavcodec.
3401 * @warning either this function or avcodec_register_all() must be called
3402 * before any other libavcodec functions.
3404 * @see avcodec_register_all()
3406 void avcodec_register(AVCodec *codec);
3409 * Register all the codecs, parsers and bitstream filters which were enabled at
3410 * configuration time. If you do not call this function you can select exactly
3411 * which formats you want to support, by using the individual registration
3414 * @see avcodec_register
3415 * @see av_register_codec_parser
3416 * @see av_register_bitstream_filter
3418 void avcodec_register_all(void);
3421 #if FF_API_ALLOC_CONTEXT
3423 * Allocate an AVCodecContext and set its fields to default values. The
3424 * resulting struct can be deallocated by simply calling av_free().
3426 * @return An AVCodecContext filled with default values or NULL on failure.
3427 * @see avcodec_get_context_defaults
3429 * @deprecated use avcodec_alloc_context3()
3431 attribute_deprecated
3432 AVCodecContext *avcodec_alloc_context(void);
3434 /** THIS FUNCTION IS NOT YET PART OF THE PUBLIC API!
3435 * we WILL change its arguments and name a few times! */
3436 attribute_deprecated
3437 AVCodecContext *avcodec_alloc_context2(enum AVMediaType);
3440 * Set the fields of the given AVCodecContext to default values.
3442 * @param s The AVCodecContext of which the fields should be set to default values.
3443 * @deprecated use avcodec_get_context_defaults3
3445 attribute_deprecated
3446 void avcodec_get_context_defaults(AVCodecContext *s);
3448 /** THIS FUNCTION IS NOT YET PART OF THE PUBLIC API!
3449 * we WILL change its arguments and name a few times! */
3450 attribute_deprecated
3451 void avcodec_get_context_defaults2(AVCodecContext *s, enum AVMediaType);
3455 * Allocate an AVCodecContext and set its fields to default values. The
3456 * resulting struct can be deallocated by calling avcodec_close() on it followed
3459 * @param codec if non-NULL, allocate private data and initialize defaults
3460 * for the given codec. It is illegal to then call avcodec_open2()
3461 * with a different codec.
3462 * If NULL, then the codec-specific defaults won't be initialized,
3463 * which may result in suboptimal default settings (this is
3464 * important mainly for encoders, e.g. libx264).
3466 * @return An AVCodecContext filled with default values or NULL on failure.
3467 * @see avcodec_get_context_defaults
3469 AVCodecContext *avcodec_alloc_context3(const AVCodec *codec);
3472 * Set the fields of the given AVCodecContext to default values corresponding
3473 * to the given codec (defaults may be codec-dependent).
3475 * Do not call this function if a non-NULL codec has been passed
3476 * to avcodec_alloc_context3() that allocated this AVCodecContext.
3477 * If codec is non-NULL, it is illegal to call avcodec_open2() with a
3478 * different codec on this AVCodecContext.
3480 int avcodec_get_context_defaults3(AVCodecContext *s, const AVCodec *codec);
3483 * Get the AVClass for AVCodecContext. It can be used in combination with
3484 * AV_OPT_SEARCH_FAKE_OBJ for examining options.
3486 * @see av_opt_find().
3488 const AVClass *avcodec_get_class(void);
3491 * Get the AVClass for AVFrame. It can be used in combination with
3492 * AV_OPT_SEARCH_FAKE_OBJ for examining options.
3494 * @see av_opt_find().
3496 const AVClass *avcodec_get_frame_class(void);
3499 * Get the AVClass for AVSubtitleRect. It can be used in combination with
3500 * AV_OPT_SEARCH_FAKE_OBJ for examining options.
3502 * @see av_opt_find().
3504 const AVClass *avcodec_get_subtitle_rect_class(void);
3507 * Copy the settings of the source AVCodecContext into the destination
3508 * AVCodecContext. The resulting destination codec context will be
3509 * unopened, i.e. you are required to call avcodec_open2() before you
3510 * can use this AVCodecContext to decode/encode video/audio data.
3512 * @param dest target codec context, should be initialized with
3513 * avcodec_alloc_context3(), but otherwise uninitialized
3514 * @param src source codec context
3515 * @return AVERROR() on error (e.g. memory allocation error), 0 on success
3517 int avcodec_copy_context(AVCodecContext *dest, const AVCodecContext *src);
3520 * Allocate an AVFrame and set its fields to default values. The resulting
3521 * struct must be freed using avcodec_free_frame().
3523 * @return An AVFrame filled with default values or NULL on failure.
3524 * @see avcodec_get_frame_defaults
3526 AVFrame *avcodec_alloc_frame(void);
3529 * Set the fields of the given AVFrame to default values.
3531 * @param frame The AVFrame of which the fields should be set to default values.
3533 void avcodec_get_frame_defaults(AVFrame *frame);
3536 * Free the frame and any dynamically allocated objects in it,
3537 * e.g. extended_data.
3539 * @param frame frame to be freed. The pointer will be set to NULL.
3541 * @warning this function does NOT free the data buffers themselves
3542 * (it does not know how, since they might have been allocated with
3543 * a custom get_buffer()).
3545 void avcodec_free_frame(AVFrame **frame);
3547 #if FF_API_AVCODEC_OPEN
3549 * Initialize the AVCodecContext to use the given AVCodec. Prior to using this
3550 * function the context has to be allocated.
3552 * The functions avcodec_find_decoder_by_name(), avcodec_find_encoder_by_name(),
3553 * avcodec_find_decoder() and avcodec_find_encoder() provide an easy way for
3554 * retrieving a codec.
3556 * @warning This function is not thread safe!
3559 * avcodec_register_all();
3560 * codec = avcodec_find_decoder(AV_CODEC_ID_H264);
3564 * context = avcodec_alloc_context3(codec);
3566 * if (avcodec_open(context, codec) < 0)
3570 * @param avctx The context which will be set up to use the given codec.
3571 * @param codec The codec to use within the context.
3572 * @return zero on success, a negative value on error
3573 * @see avcodec_alloc_context3, avcodec_find_decoder, avcodec_find_encoder, avcodec_close
3575 * @deprecated use avcodec_open2
3577 attribute_deprecated
3578 int avcodec_open(AVCodecContext *avctx, AVCodec *codec);
3582 * Initialize the AVCodecContext to use the given AVCodec. Prior to using this
3583 * function the context has to be allocated with avcodec_alloc_context3().
3585 * The functions avcodec_find_decoder_by_name(), avcodec_find_encoder_by_name(),
3586 * avcodec_find_decoder() and avcodec_find_encoder() provide an easy way for
3587 * retrieving a codec.
3589 * @warning This function is not thread safe!
3592 * avcodec_register_all();
3593 * av_dict_set(&opts, "b", "2.5M", 0);
3594 * codec = avcodec_find_decoder(AV_CODEC_ID_H264);
3598 * context = avcodec_alloc_context3(codec);
3600 * if (avcodec_open2(context, codec, opts) < 0)
3604 * @param avctx The context to initialize.
3605 * @param codec The codec to open this context for. If a non-NULL codec has been
3606 * previously passed to avcodec_alloc_context3() or
3607 * avcodec_get_context_defaults3() for this context, then this
3608 * parameter MUST be either NULL or equal to the previously passed
3610 * @param options A dictionary filled with AVCodecContext and codec-private options.
3611 * On return this object will be filled with options that were not found.
3613 * @return zero on success, a negative value on error
3614 * @see avcodec_alloc_context3(), avcodec_find_decoder(), avcodec_find_encoder(),
3615 * av_dict_set(), av_opt_find().
3617 int avcodec_open2(AVCodecContext *avctx, const AVCodec *codec, AVDictionary **options);
3620 * Close a given AVCodecContext and free all the data associated with it
3621 * (but not the AVCodecContext itself).
3623 * Calling this function on an AVCodecContext that hasn't been opened will free
3624 * the codec-specific data allocated in avcodec_alloc_context3() /
3625 * avcodec_get_context_defaults3() with a non-NULL codec. Subsequent calls will
3628 int avcodec_close(AVCodecContext *avctx);
3631 * Free all allocated data in the given subtitle struct.
3633 * @param sub AVSubtitle to free.
3635 void avsubtitle_free(AVSubtitle *sub);
3642 * @addtogroup lavc_packet
3647 * Default packet destructor.
3649 void av_destruct_packet(AVPacket *pkt);
3652 * Initialize optional fields of a packet with default values.
3654 * Note, this does not touch the data and size members, which have to be
3655 * initialized separately.
3659 void av_init_packet(AVPacket *pkt);
3662 * Allocate the payload of a packet and initialize its fields with
3666 * @param size wanted payload size
3667 * @return 0 if OK, AVERROR_xxx otherwise
3669 int av_new_packet(AVPacket *pkt, int size);
3672 * Reduce packet size, correctly zeroing padding
3675 * @param size new size
3677 void av_shrink_packet(AVPacket *pkt, int size);
3680 * Increase packet size, correctly zeroing padding
3683 * @param grow_by number of bytes by which to increase the size of the packet
3685 int av_grow_packet(AVPacket *pkt, int grow_by);
3688 * @warning This is a hack - the packet memory allocation stuff is broken. The
3689 * packet is allocated if it was not really allocated.
3691 int av_dup_packet(AVPacket *pkt);
3694 * Copy packet, including contents
3696 * @return 0 on success, negative AVERROR on fail
3698 int av_copy_packet(AVPacket *dst, AVPacket *src);
3703 * @param pkt packet to free
3705 void av_free_packet(AVPacket *pkt);
3708 * Allocate new information of a packet.
3711 * @param type side information type
3712 * @param size side information size
3713 * @return pointer to fresh allocated data or NULL otherwise
3715 uint8_t* av_packet_new_side_data(AVPacket *pkt, enum AVPacketSideDataType type,
3719 * Shrink the already allocated side data buffer
3722 * @param type side information type
3723 * @param size new side information size
3724 * @return 0 on success, < 0 on failure
3726 int av_packet_shrink_side_data(AVPacket *pkt, enum AVPacketSideDataType type,
3730 * Get side information from packet.
3733 * @param type desired side information type
3734 * @param size pointer for side information size to store (optional)
3735 * @return pointer to data if present or NULL otherwise
3737 uint8_t* av_packet_get_side_data(AVPacket *pkt, enum AVPacketSideDataType type,
3740 int av_packet_merge_side_data(AVPacket *pkt);
3742 int av_packet_split_side_data(AVPacket *pkt);
3750 * @addtogroup lavc_decoding
3755 * Find a registered decoder with a matching codec ID.
3757 * @param id AVCodecID of the requested decoder
3758 * @return A decoder if one was found, NULL otherwise.
3760 AVCodec *avcodec_find_decoder(enum AVCodecID id);
3763 * Find a registered decoder with the specified name.
3765 * @param name name of the requested decoder
3766 * @return A decoder if one was found, NULL otherwise.
3768 AVCodec *avcodec_find_decoder_by_name(const char *name);
3770 int avcodec_default_get_buffer(AVCodecContext *s, AVFrame *pic);
3771 void avcodec_default_release_buffer(AVCodecContext *s, AVFrame *pic);
3772 int avcodec_default_reget_buffer(AVCodecContext *s, AVFrame *pic);
3775 * Return the amount of padding in pixels which the get_buffer callback must
3776 * provide around the edge of the image for codecs which do not have the
3777 * CODEC_FLAG_EMU_EDGE flag.
3779 * @return Required padding in pixels.
3781 unsigned avcodec_get_edge_width(void);
3784 * Modify width and height values so that they will result in a memory
3785 * buffer that is acceptable for the codec if you do not use any horizontal
3788 * May only be used if a codec with CODEC_CAP_DR1 has been opened.
3789 * If CODEC_FLAG_EMU_EDGE is not set, the dimensions must have been increased
3790 * according to avcodec_get_edge_width() before.
3792 void avcodec_align_dimensions(AVCodecContext *s, int *width, int *height);
3795 * Modify width and height values so that they will result in a memory
3796 * buffer that is acceptable for the codec if you also ensure that all
3797 * line sizes are a multiple of the respective linesize_align[i].
3799 * May only be used if a codec with CODEC_CAP_DR1 has been opened.
3800 * If CODEC_FLAG_EMU_EDGE is not set, the dimensions must have been increased
3801 * according to avcodec_get_edge_width() before.
3803 void avcodec_align_dimensions2(AVCodecContext *s, int *width, int *height,
3804 int linesize_align[AV_NUM_DATA_POINTERS]);
3806 #if FF_API_OLD_DECODE_AUDIO
3808 * Wrapper function which calls avcodec_decode_audio4.
3810 * @deprecated Use avcodec_decode_audio4 instead.
3812 * Decode the audio frame of size avpkt->size from avpkt->data into samples.
3813 * Some decoders may support multiple frames in a single AVPacket, such
3814 * decoders would then just decode the first frame. In this case,
3815 * avcodec_decode_audio3 has to be called again with an AVPacket that contains
3816 * the remaining data in order to decode the second frame etc.
3818 * could be outputted, frame_size_ptr is zero. Otherwise, it is the
3819 * decompressed frame size in bytes.
3821 * @warning You must set frame_size_ptr to the allocated size of the
3822 * output buffer before calling avcodec_decode_audio3().
3824 * @warning The input buffer must be FF_INPUT_BUFFER_PADDING_SIZE larger than
3825 * the actual read bytes because some optimized bitstream readers read 32 or 64
3826 * bits at once and could read over the end.
3828 * @warning The end of the input buffer avpkt->data should be set to 0 to ensure that
3829 * no overreading happens for damaged MPEG streams.
3831 * @warning You must not provide a custom get_buffer() when using
3832 * avcodec_decode_audio3(). Doing so will override it with
3833 * avcodec_default_get_buffer. Use avcodec_decode_audio4() instead,
3834 * which does allow the application to provide a custom get_buffer().
3836 * @note You might have to align the input buffer avpkt->data and output buffer
3837 * samples. The alignment requirements depend on the CPU: On some CPUs it isn't
3838 * necessary at all, on others it won't work at all if not aligned and on others
3839 * it will work but it will have an impact on performance.
3841 * In practice, avpkt->data should have 4 byte alignment at minimum and
3842 * samples should be 16 byte aligned unless the CPU doesn't need it
3843 * (AltiVec and SSE do).
3845 * @note Codecs which have the CODEC_CAP_DELAY capability set have a delay
3846 * between input and output, these need to be fed with avpkt->data=NULL,
3847 * avpkt->size=0 at the end to return the remaining frames.
3849 * @param avctx the codec context
3850 * @param[out] samples the output buffer, sample type in avctx->sample_fmt
3851 * If the sample format is planar, each channel plane will
3852 * be the same size, with no padding between channels.
3853 * @param[in,out] frame_size_ptr the output buffer size in bytes
3854 * @param[in] avpkt The input AVPacket containing the input buffer.
3855 * You can create such packet with av_init_packet() and by then setting
3856 * data and size, some decoders might in addition need other fields.
3857 * All decoders are designed to use the least fields possible though.
3858 * @return On error a negative value is returned, otherwise the number of bytes
3859 * used or zero if no frame data was decompressed (used) from the input AVPacket.
3861 attribute_deprecated int avcodec_decode_audio3(AVCodecContext *avctx, int16_t *samples,
3862 int *frame_size_ptr,
3867 * Decode the audio frame of size avpkt->size from avpkt->data into frame.
3869 * Some decoders may support multiple frames in a single AVPacket. Such
3870 * decoders would then just decode the first frame. In this case,
3871 * avcodec_decode_audio4 has to be called again with an AVPacket containing
3872 * the remaining data in order to decode the second frame, etc...
3873 * Even if no frames are returned, the packet needs to be fed to the decoder
3874 * with remaining data until it is completely consumed or an error occurs.
3876 * @warning The input buffer, avpkt->data must be FF_INPUT_BUFFER_PADDING_SIZE
3877 * larger than the actual read bytes because some optimized bitstream
3878 * readers read 32 or 64 bits at once and could read over the end.
3880 * @note You might have to align the input buffer. The alignment requirements
3881 * depend on the CPU and the decoder.
3883 * @param avctx the codec context
3884 * @param[out] frame The AVFrame in which to store decoded audio samples.
3885 * Decoders request a buffer of a particular size by setting
3886 * AVFrame.nb_samples prior to calling get_buffer(). The
3887 * decoder may, however, only utilize part of the buffer by
3888 * setting AVFrame.nb_samples to a smaller value in the
3890 * @param[out] got_frame_ptr Zero if no frame could be decoded, otherwise it is
3892 * @param[in] avpkt The input AVPacket containing the input buffer.
3893 * At least avpkt->data and avpkt->size should be set. Some
3894 * decoders might also require additional fields to be set.
3895 * @return A negative error code is returned if an error occurred during
3896 * decoding, otherwise the number of bytes consumed from the input
3897 * AVPacket is returned.
3899 int avcodec_decode_audio4(AVCodecContext *avctx, AVFrame *frame,
3900 int *got_frame_ptr, const AVPacket *avpkt);
3903 * Decode the video frame of size avpkt->size from avpkt->data into picture.
3904 * Some decoders may support multiple frames in a single AVPacket, such
3905 * decoders would then just decode the first frame.
3907 * @warning The input buffer must be FF_INPUT_BUFFER_PADDING_SIZE larger than
3908 * the actual read bytes because some optimized bitstream readers read 32 or 64
3909 * bits at once and could read over the end.
3911 * @warning The end of the input buffer buf should be set to 0 to ensure that
3912 * no overreading happens for damaged MPEG streams.
3914 * @note You might have to align the input buffer avpkt->data.
3915 * The alignment requirements depend on the CPU: on some CPUs it isn't
3916 * necessary at all, on others it won't work at all if not aligned and on others
3917 * it will work but it will have an impact on performance.
3919 * In practice, avpkt->data should have 4 byte alignment at minimum.
3921 * @note Codecs which have the CODEC_CAP_DELAY capability set have a delay
3922 * between input and output, these need to be fed with avpkt->data=NULL,
3923 * avpkt->size=0 at the end to return the remaining frames.
3925 * @param avctx the codec context
3926 * @param[out] picture The AVFrame in which the decoded video frame will be stored.
3927 * Use avcodec_alloc_frame to get an AVFrame, the codec will
3928 * allocate memory for the actual bitmap.
3929 * with default get/release_buffer(), the decoder frees/reuses the bitmap as it sees fit.
3930 * with overridden get/release_buffer() (needs CODEC_CAP_DR1) the user decides into what buffer the decoder
3931 * decodes and the decoder tells the user once it does not need the data anymore,
3932 * the user app can at this point free/reuse/keep the memory as it sees fit.
3934 * @param[in] avpkt The input AVpacket containing the input buffer.
3935 * You can create such packet with av_init_packet() and by then setting
3936 * data and size, some decoders might in addition need other fields like
3937 * flags&AV_PKT_FLAG_KEY. All decoders are designed to use the least
3939 * @param[in,out] got_picture_ptr Zero if no frame could be decompressed, otherwise, it is nonzero.
3940 * @return On error a negative value is returned, otherwise the number of bytes
3941 * used or zero if no frame could be decompressed.
3943 int avcodec_decode_video2(AVCodecContext *avctx, AVFrame *picture,
3944 int *got_picture_ptr,
3945 const AVPacket *avpkt);
3948 * Decode a subtitle message.
3949 * Return a negative value on error, otherwise return the number of bytes used.
3950 * If no subtitle could be decompressed, got_sub_ptr is zero.
3951 * Otherwise, the subtitle is stored in *sub.
3952 * Note that CODEC_CAP_DR1 is not available for subtitle codecs. This is for
3953 * simplicity, because the performance difference is expect to be negligible
3954 * and reusing a get_buffer written for video codecs would probably perform badly
3955 * due to a potentially very different allocation pattern.
3957 * @param avctx the codec context
3958 * @param[out] sub The AVSubtitle in which the decoded subtitle will be stored, must be
3959 freed with avsubtitle_free if *got_sub_ptr is set.
3960 * @param[in,out] got_sub_ptr Zero if no subtitle could be decompressed, otherwise, it is nonzero.
3961 * @param[in] avpkt The input AVPacket containing the input buffer.
3963 int avcodec_decode_subtitle2(AVCodecContext *avctx, AVSubtitle *sub,
3968 * @defgroup lavc_parsing Frame parsing
3972 typedef struct AVCodecParserContext {
3974 struct AVCodecParser *parser;
3975 int64_t frame_offset; /* offset of the current frame */
3976 int64_t cur_offset; /* current offset
3977 (incremented by each av_parser_parse()) */
3978 int64_t next_frame_offset; /* offset of the next frame */
3980 int pict_type; /* XXX: Put it back in AVCodecContext. */
3982 * This field is used for proper frame duration computation in lavf.
3983 * It signals, how much longer the frame duration of the current frame
3984 * is compared to normal frame duration.
3986 * frame_duration = (1 + repeat_pict) * time_base
3988 * It is used by codecs like H.264 to display telecined material.
3990 int repeat_pict; /* XXX: Put it back in AVCodecContext. */
3991 int64_t pts; /* pts of the current frame */
3992 int64_t dts; /* dts of the current frame */
3997 int fetch_timestamp;
3999 #define AV_PARSER_PTS_NB 4
4000 int cur_frame_start_index;
4001 int64_t cur_frame_offset[AV_PARSER_PTS_NB];
4002 int64_t cur_frame_pts[AV_PARSER_PTS_NB];
4003 int64_t cur_frame_dts[AV_PARSER_PTS_NB];
4006 #define PARSER_FLAG_COMPLETE_FRAMES 0x0001
4007 #define PARSER_FLAG_ONCE 0x0002
4008 /// Set if the parser has a valid file offset
4009 #define PARSER_FLAG_FETCHED_OFFSET 0x0004
4010 #define PARSER_FLAG_USE_CODEC_TS 0x1000
4012 int64_t offset; ///< byte offset from starting packet start
4013 int64_t cur_frame_end[AV_PARSER_PTS_NB];
4016 * Set by parser to 1 for key frames and 0 for non-key frames.
4017 * It is initialized to -1, so if the parser doesn't set this flag,
4018 * old-style fallback using AV_PICTURE_TYPE_I picture type as key frames
4024 * Time difference in stream time base units from the pts of this
4025 * packet to the point at which the output from the decoder has converged
4026 * independent from the availability of previous frames. That is, the
4027 * frames are virtually identical no matter if decoding started from
4028 * the very first frame or from this keyframe.
4029 * Is AV_NOPTS_VALUE if unknown.
4030 * This field is not the display duration of the current frame.
4031 * This field has no meaning if the packet does not have AV_PKT_FLAG_KEY
4034 * The purpose of this field is to allow seeking in streams that have no
4035 * keyframes in the conventional sense. It corresponds to the
4036 * recovery point SEI in H.264 and match_time_delta in NUT. It is also
4037 * essential for some types of subtitle streams to ensure that all
4038 * subtitles are correctly displayed after seeking.
4040 int64_t convergence_duration;
4042 // Timestamp generation support:
4044 * Synchronization point for start of timestamp generation.
4046 * Set to >0 for sync point, 0 for no sync point and <0 for undefined
4049 * For example, this corresponds to presence of H.264 buffering period
4055 * Offset of the current timestamp against last timestamp sync point in
4056 * units of AVCodecContext.time_base.
4058 * Set to INT_MIN when dts_sync_point unused. Otherwise, it must
4059 * contain a valid timestamp offset.
4061 * Note that the timestamp of sync point has usually a nonzero
4062 * dts_ref_dts_delta, which refers to the previous sync point. Offset of
4063 * the next frame after timestamp sync point will be usually 1.
4065 * For example, this corresponds to H.264 cpb_removal_delay.
4067 int dts_ref_dts_delta;
4070 * Presentation delay of current frame in units of AVCodecContext.time_base.
4072 * Set to INT_MIN when dts_sync_point unused. Otherwise, it must
4073 * contain valid non-negative timestamp delta (presentation time of a frame
4074 * must not lie in the past).
4076 * This delay represents the difference between decoding and presentation
4077 * time of the frame.
4079 * For example, this corresponds to H.264 dpb_output_delay.
4084 * Position of the packet in file.
4086 * Analogous to cur_frame_pts/dts
4088 int64_t cur_frame_pos[AV_PARSER_PTS_NB];
4091 * Byte position of currently parsed frame in stream.
4096 * Previous frame byte position.
4101 * Duration of the current frame.
4102 * For audio, this is in units of 1 / AVCodecContext.sample_rate.
4103 * For all other types, this is in units of AVCodecContext.time_base.
4106 } AVCodecParserContext;
4108 typedef struct AVCodecParser {
4109 int codec_ids[5]; /* several codec IDs are permitted */
4111 int (*parser_init)(AVCodecParserContext *s);
4112 int (*parser_parse)(AVCodecParserContext *s,
4113 AVCodecContext *avctx,
4114 const uint8_t **poutbuf, int *poutbuf_size,
4115 const uint8_t *buf, int buf_size);
4116 void (*parser_close)(AVCodecParserContext *s);
4117 int (*split)(AVCodecContext *avctx, const uint8_t *buf, int buf_size);
4118 struct AVCodecParser *next;
4121 AVCodecParser *av_parser_next(AVCodecParser *c);
4123 void av_register_codec_parser(AVCodecParser *parser);
4124 AVCodecParserContext *av_parser_init(int codec_id);
4129 * @param s parser context.
4130 * @param avctx codec context.
4131 * @param poutbuf set to pointer to parsed buffer or NULL if not yet finished.
4132 * @param poutbuf_size set to size of parsed buffer or zero if not yet finished.
4133 * @param buf input buffer.
4134 * @param buf_size input length, to signal EOF, this should be 0 (so that the last frame can be output).
4135 * @param pts input presentation timestamp.
4136 * @param dts input decoding timestamp.
4137 * @param pos input byte position in stream.
4138 * @return the number of bytes of the input bitstream used.
4143 * len = av_parser_parse2(myparser, AVCodecContext, &data, &size,
4150 * decode_frame(data, size);
4154 int av_parser_parse2(AVCodecParserContext *s,
4155 AVCodecContext *avctx,
4156 uint8_t **poutbuf, int *poutbuf_size,
4157 const uint8_t *buf, int buf_size,
4158 int64_t pts, int64_t dts,
4161 int av_parser_change(AVCodecParserContext *s,
4162 AVCodecContext *avctx,
4163 uint8_t **poutbuf, int *poutbuf_size,
4164 const uint8_t *buf, int buf_size, int keyframe);
4165 void av_parser_close(AVCodecParserContext *s);
4173 * @addtogroup lavc_encoding
4178 * Find a registered encoder with a matching codec ID.
4180 * @param id AVCodecID of the requested encoder
4181 * @return An encoder if one was found, NULL otherwise.
4183 AVCodec *avcodec_find_encoder(enum AVCodecID id);
4186 * Find a registered encoder with the specified name.
4188 * @param name name of the requested encoder
4189 * @return An encoder if one was found, NULL otherwise.
4191 AVCodec *avcodec_find_encoder_by_name(const char *name);
4193 #if FF_API_OLD_ENCODE_AUDIO
4195 * Encode an audio frame from samples into buf.
4197 * @deprecated Use avcodec_encode_audio2 instead.
4199 * @note The output buffer should be at least FF_MIN_BUFFER_SIZE bytes large.
4200 * However, for codecs with avctx->frame_size equal to 0 (e.g. PCM) the user
4201 * will know how much space is needed because it depends on the value passed
4202 * in buf_size as described below. In that case a lower value can be used.
4204 * @param avctx the codec context
4205 * @param[out] buf the output buffer
4206 * @param[in] buf_size the output buffer size
4207 * @param[in] samples the input buffer containing the samples
4208 * The number of samples read from this buffer is frame_size*channels,
4209 * both of which are defined in avctx.
4210 * For codecs which have avctx->frame_size equal to 0 (e.g. PCM) the number of
4211 * samples read from samples is equal to:
4212 * buf_size * 8 / (avctx->channels * av_get_bits_per_sample(avctx->codec_id))
4213 * This also implies that av_get_bits_per_sample() must not return 0 for these
4215 * @return On error a negative value is returned, on success zero or the number
4216 * of bytes used to encode the data read from the input buffer.
4218 int attribute_deprecated avcodec_encode_audio(AVCodecContext *avctx,
4219 uint8_t *buf, int buf_size,
4220 const short *samples);
4224 * Encode a frame of audio.
4226 * Takes input samples from frame and writes the next output packet, if
4227 * available, to avpkt. The output packet does not necessarily contain data for
4228 * the most recent frame, as encoders can delay, split, and combine input frames
4229 * internally as needed.
4231 * @param avctx codec context
4232 * @param avpkt output AVPacket.
4233 * The user can supply an output buffer by setting
4234 * avpkt->data and avpkt->size prior to calling the
4235 * function, but if the size of the user-provided data is not
4236 * large enough, encoding will fail. If avpkt->data and
4237 * avpkt->size are set, avpkt->destruct must also be set. All
4238 * other AVPacket fields will be reset by the encoder using
4239 * av_init_packet(). If avpkt->data is NULL, the encoder will
4240 * allocate it. The encoder will set avpkt->size to the size
4241 * of the output packet.
4243 * If this function fails or produces no output, avpkt will be
4244 * freed using av_free_packet() (i.e. avpkt->destruct will be
4245 * called to free the user supplied buffer).
4246 * @param[in] frame AVFrame containing the raw audio data to be encoded.
4247 * May be NULL when flushing an encoder that has the
4248 * CODEC_CAP_DELAY capability set.
4249 * If CODEC_CAP_VARIABLE_FRAME_SIZE is set, then each frame
4250 * can have any number of samples.
4251 * If it is not set, frame->nb_samples must be equal to
4252 * avctx->frame_size for all frames except the last.
4253 * The final frame may be smaller than avctx->frame_size.
4254 * @param[out] got_packet_ptr This field is set to 1 by libavcodec if the
4255 * output packet is non-empty, and to 0 if it is
4256 * empty. If the function returns an error, the
4257 * packet can be assumed to be invalid, and the
4258 * value of got_packet_ptr is undefined and should
4260 * @return 0 on success, negative error code on failure
4262 int avcodec_encode_audio2(AVCodecContext *avctx, AVPacket *avpkt,
4263 const AVFrame *frame, int *got_packet_ptr);
4265 #if FF_API_OLD_ENCODE_VIDEO
4267 * @deprecated use avcodec_encode_video2() instead.
4269 * Encode a video frame from pict into buf.
4270 * The input picture should be
4271 * stored using a specific format, namely avctx.pix_fmt.
4273 * @param avctx the codec context
4274 * @param[out] buf the output buffer for the bitstream of encoded frame
4275 * @param[in] buf_size the size of the output buffer in bytes
4276 * @param[in] pict the input picture to encode
4277 * @return On error a negative value is returned, on success zero or the number
4278 * of bytes used from the output buffer.
4280 attribute_deprecated
4281 int avcodec_encode_video(AVCodecContext *avctx, uint8_t *buf, int buf_size,
4282 const AVFrame *pict);
4286 * Encode a frame of video.
4288 * Takes input raw video data from frame and writes the next output packet, if
4289 * available, to avpkt. The output packet does not necessarily contain data for
4290 * the most recent frame, as encoders can delay and reorder input frames
4291 * internally as needed.
4293 * @param avctx codec context
4294 * @param avpkt output AVPacket.
4295 * The user can supply an output buffer by setting
4296 * avpkt->data and avpkt->size prior to calling the
4297 * function, but if the size of the user-provided data is not
4298 * large enough, encoding will fail. All other AVPacket fields
4299 * will be reset by the encoder using av_init_packet(). If
4300 * avpkt->data is NULL, the encoder will allocate it.
4301 * The encoder will set avpkt->size to the size of the
4302 * output packet. The returned data (if any) belongs to the
4303 * caller, he is responsible for freeing it.
4305 * If this function fails or produces no output, avpkt will be
4306 * freed using av_free_packet() (i.e. avpkt->destruct will be
4307 * called to free the user supplied buffer).
4308 * @param[in] frame AVFrame containing the raw video data to be encoded.
4309 * May be NULL when flushing an encoder that has the
4310 * CODEC_CAP_DELAY capability set.
4311 * @param[out] got_packet_ptr This field is set to 1 by libavcodec if the
4312 * output packet is non-empty, and to 0 if it is
4313 * empty. If the function returns an error, the
4314 * packet can be assumed to be invalid, and the
4315 * value of got_packet_ptr is undefined and should
4317 * @return 0 on success, negative error code on failure
4319 int avcodec_encode_video2(AVCodecContext *avctx, AVPacket *avpkt,
4320 const AVFrame *frame, int *got_packet_ptr);
4322 int avcodec_encode_subtitle(AVCodecContext *avctx, uint8_t *buf, int buf_size,
4323 const AVSubtitle *sub);
4330 #if FF_API_AVCODEC_RESAMPLE
4332 * @defgroup lavc_resample Audio resampling
4334 * @deprecated use libswresample instead
4338 struct ReSampleContext;
4339 struct AVResampleContext;
4341 typedef struct ReSampleContext ReSampleContext;
4344 * Initialize audio resampling context.
4346 * @param output_channels number of output channels
4347 * @param input_channels number of input channels
4348 * @param output_rate output sample rate
4349 * @param input_rate input sample rate
4350 * @param sample_fmt_out requested output sample format
4351 * @param sample_fmt_in input sample format
4352 * @param filter_length length of each FIR filter in the filterbank relative to the cutoff frequency
4353 * @param log2_phase_count log2 of the number of entries in the polyphase filterbank
4354 * @param linear if 1 then the used FIR filter will be linearly interpolated
4355 between the 2 closest, if 0 the closest will be used
4356 * @param cutoff cutoff frequency, 1.0 corresponds to half the output sampling rate
4357 * @return allocated ReSampleContext, NULL if error occurred
4359 attribute_deprecated
4360 ReSampleContext *av_audio_resample_init(int output_channels, int input_channels,
4361 int output_rate, int input_rate,
4362 enum AVSampleFormat sample_fmt_out,
4363 enum AVSampleFormat sample_fmt_in,
4364 int filter_length, int log2_phase_count,
4365 int linear, double cutoff);
4367 attribute_deprecated
4368 int audio_resample(ReSampleContext *s, short *output, short *input, int nb_samples);
4371 * Free resample context.
4373 * @param s a non-NULL pointer to a resample context previously
4374 * created with av_audio_resample_init()
4376 attribute_deprecated
4377 void audio_resample_close(ReSampleContext *s);
4381 * Initialize an audio resampler.
4382 * Note, if either rate is not an integer then simply scale both rates up so they are.
4383 * @param filter_length length of each FIR filter in the filterbank relative to the cutoff freq
4384 * @param log2_phase_count log2 of the number of entries in the polyphase filterbank
4385 * @param linear If 1 then the used FIR filter will be linearly interpolated
4386 between the 2 closest, if 0 the closest will be used
4387 * @param cutoff cutoff frequency, 1.0 corresponds to half the output sampling rate
4389 attribute_deprecated
4390 struct AVResampleContext *av_resample_init(int out_rate, int in_rate, int filter_length, int log2_phase_count, int linear, double cutoff);
4393 * Resample an array of samples using a previously configured context.
4394 * @param src an array of unconsumed samples
4395 * @param consumed the number of samples of src which have been consumed are returned here
4396 * @param src_size the number of unconsumed samples available
4397 * @param dst_size the amount of space in samples available in dst
4398 * @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.
4399 * @return the number of samples written in dst or -1 if an error occurred
4401 attribute_deprecated
4402 int av_resample(struct AVResampleContext *c, short *dst, short *src, int *consumed, int src_size, int dst_size, int update_ctx);
4406 * Compensate samplerate/timestamp drift. The compensation is done by changing
4407 * the resampler parameters, so no audible clicks or similar distortions occur
4408 * @param compensation_distance distance in output samples over which the compensation should be performed
4409 * @param sample_delta number of output samples which should be output less
4411 * example: av_resample_compensate(c, 10, 500)
4412 * here instead of 510 samples only 500 samples would be output
4414 * note, due to rounding the actual compensation might be slightly different,
4415 * especially if the compensation_distance is large and the in_rate used during init is small
4417 attribute_deprecated
4418 void av_resample_compensate(struct AVResampleContext *c, int sample_delta, int compensation_distance);
4419 attribute_deprecated
4420 void av_resample_close(struct AVResampleContext *c);
4428 * @addtogroup lavc_picture
4433 * Allocate memory for a picture. Call avpicture_free() to free it.
4435 * @see avpicture_fill()
4437 * @param picture the picture to be filled in
4438 * @param pix_fmt the format of the picture
4439 * @param width the width of the picture
4440 * @param height the height of the picture
4441 * @return zero if successful, a negative value if not
4443 int avpicture_alloc(AVPicture *picture, enum AVPixelFormat pix_fmt, int width, int height);
4446 * Free a picture previously allocated by avpicture_alloc().
4447 * The data buffer used by the AVPicture is freed, but the AVPicture structure
4450 * @param picture the AVPicture to be freed
4452 void avpicture_free(AVPicture *picture);
4455 * Fill in the AVPicture fields, always assume a linesize alignment of
4458 * @see av_image_fill_arrays()
4460 int avpicture_fill(AVPicture *picture, uint8_t *ptr,
4461 enum AVPixelFormat pix_fmt, int width, int height);
4464 * Copy pixel data from an AVPicture into a buffer, always assume a
4465 * linesize alignment of 1.
4467 * @see av_image_copy_to_buffer()
4469 int avpicture_layout(const AVPicture* src, enum AVPixelFormat pix_fmt,
4470 int width, int height,
4471 unsigned char *dest, int dest_size);
4474 * Calculate the size in bytes that a picture of the given width and height
4475 * would occupy if stored in the given picture format.
4476 * Always assume a linesize alignment of 1.
4478 * @see av_image_get_buffer_size().
4480 int avpicture_get_size(enum AVPixelFormat pix_fmt, int width, int height);
4483 * deinterlace - if not supported return -1
4485 int avpicture_deinterlace(AVPicture *dst, const AVPicture *src,
4486 enum AVPixelFormat pix_fmt, int width, int height);
4488 * Copy image src to dst. Wraps av_image_copy().
4490 void av_picture_copy(AVPicture *dst, const AVPicture *src,
4491 enum AVPixelFormat pix_fmt, int width, int height);
4494 * Crop image top and left side.
4496 int av_picture_crop(AVPicture *dst, const AVPicture *src,
4497 enum AVPixelFormat pix_fmt, int top_band, int left_band);
4502 int av_picture_pad(AVPicture *dst, const AVPicture *src, int height, int width, enum AVPixelFormat pix_fmt,
4503 int padtop, int padbottom, int padleft, int padright, int *color);
4510 * @defgroup lavc_misc Utility functions
4513 * Miscellaneous utility functions related to both encoding and decoding
4519 * @defgroup lavc_misc_pixfmt Pixel formats
4521 * Functions for working with pixel formats.
4525 void avcodec_get_chroma_sub_sample(enum AVPixelFormat pix_fmt, int *h_shift, int *v_shift);
4528 * Return a value representing the fourCC code associated to the
4529 * pixel format pix_fmt, or 0 if no associated fourCC code can be
4532 unsigned int avcodec_pix_fmt_to_codec_tag(enum AVPixelFormat pix_fmt);
4534 #define FF_LOSS_RESOLUTION 0x0001 /**< loss due to resolution change */
4535 #define FF_LOSS_DEPTH 0x0002 /**< loss due to color depth change */
4536 #define FF_LOSS_COLORSPACE 0x0004 /**< loss due to color space conversion */
4537 #define FF_LOSS_ALPHA 0x0008 /**< loss of alpha bits */
4538 #define FF_LOSS_COLORQUANT 0x0010 /**< loss due to color quantization */
4539 #define FF_LOSS_CHROMA 0x0020 /**< loss of chroma (e.g. RGB to gray conversion) */
4542 * Compute what kind of losses will occur when converting from one specific
4543 * pixel format to another.
4544 * When converting from one pixel format to another, information loss may occur.
4545 * For example, when converting from RGB24 to GRAY, the color information will
4546 * be lost. Similarly, other losses occur when converting from some formats to
4547 * other formats. These losses can involve loss of chroma, but also loss of
4548 * resolution, loss of color depth, loss due to the color space conversion, loss
4549 * of the alpha bits or loss due to color quantization.
4550 * avcodec_get_fix_fmt_loss() informs you about the various types of losses
4551 * which will occur when converting from one pixel format to another.
4553 * @param[in] dst_pix_fmt destination pixel format
4554 * @param[in] src_pix_fmt source pixel format
4555 * @param[in] has_alpha Whether the source pixel format alpha channel is used.
4556 * @return Combination of flags informing you what kind of losses will occur
4557 * (maximum loss for an invalid dst_pix_fmt).
4559 int avcodec_get_pix_fmt_loss(enum AVPixelFormat dst_pix_fmt, enum AVPixelFormat src_pix_fmt,
4562 #if FF_API_FIND_BEST_PIX_FMT
4564 * @deprecated use avcodec_find_best_pix_fmt_of_2() instead.
4566 * Find the best pixel format to convert to given a certain source pixel
4567 * format. When converting from one pixel format to another, information loss
4568 * may occur. For example, when converting from RGB24 to GRAY, the color
4569 * information will be lost. Similarly, other losses occur when converting from
4570 * some formats to other formats. avcodec_find_best_pix_fmt() searches which of
4571 * the given pixel formats should be used to suffer the least amount of loss.
4572 * The pixel formats from which it chooses one, are determined by the
4573 * pix_fmt_mask parameter.
4575 * Note, only the first 64 pixel formats will fit in pix_fmt_mask.
4578 * src_pix_fmt = AV_PIX_FMT_YUV420P;
4579 * pix_fmt_mask = (1 << AV_PIX_FMT_YUV422P) | (1 << AV_PIX_FMT_RGB24);
4580 * dst_pix_fmt = avcodec_find_best_pix_fmt(pix_fmt_mask, src_pix_fmt, alpha, &loss);
4583 * @param[in] pix_fmt_mask bitmask determining which pixel format to choose from
4584 * @param[in] src_pix_fmt source pixel format
4585 * @param[in] has_alpha Whether the source pixel format alpha channel is used.
4586 * @param[out] loss_ptr Combination of flags informing you what kind of losses will occur.
4587 * @return The best pixel format to convert to or -1 if none was found.
4589 attribute_deprecated
4590 enum AVPixelFormat avcodec_find_best_pix_fmt(int64_t pix_fmt_mask, enum AVPixelFormat src_pix_fmt,
4591 int has_alpha, int *loss_ptr);
4592 #endif /* FF_API_FIND_BEST_PIX_FMT */
4595 * Find the best pixel format to convert to given a certain source pixel
4596 * format. When converting from one pixel format to another, information loss
4597 * may occur. For example, when converting from RGB24 to GRAY, the color
4598 * information will be lost. Similarly, other losses occur when converting from
4599 * some formats to other formats. avcodec_find_best_pix_fmt_of_2() searches which of
4600 * the given pixel formats should be used to suffer the least amount of loss.
4601 * The pixel formats from which it chooses one, are determined by the
4602 * pix_fmt_list parameter.
4605 * @param[in] pix_fmt_list AV_PIX_FMT_NONE terminated array of pixel formats to choose from
4606 * @param[in] src_pix_fmt source pixel format
4607 * @param[in] has_alpha Whether the source pixel format alpha channel is used.
4608 * @param[out] loss_ptr Combination of flags informing you what kind of losses will occur.
4609 * @return The best pixel format to convert to or -1 if none was found.
4611 enum AVPixelFormat avcodec_find_best_pix_fmt_of_list(enum AVPixelFormat *pix_fmt_list,
4612 enum AVPixelFormat src_pix_fmt,
4613 int has_alpha, int *loss_ptr);
4616 * Find the best pixel format to convert to given a certain source pixel
4617 * format and a selection of two destination pixel formats. When converting from
4618 * one pixel format to another, information loss may occur. For example, when converting
4619 * from RGB24 to GRAY, the color information will be lost. Similarly, other losses occur when
4620 * converting from some formats to other formats. avcodec_find_best_pix_fmt_of_2() selects which of
4621 * the given pixel formats should be used to suffer the least amount of loss.
4623 * If one of the destination formats is AV_PIX_FMT_NONE the other pixel format (if valid) will be
4627 * src_pix_fmt = AV_PIX_FMT_YUV420P;
4628 * dst_pix_fmt1= AV_PIX_FMT_RGB24;
4629 * dst_pix_fmt2= AV_PIX_FMT_GRAY8;
4630 * dst_pix_fmt3= AV_PIX_FMT_RGB8;
4631 * loss= FF_LOSS_CHROMA; // don't care about chroma loss, so chroma loss will be ignored.
4632 * dst_pix_fmt = avcodec_find_best_pix_fmt_of_2(dst_pix_fmt1, dst_pix_fmt2, src_pix_fmt, alpha, &loss);
4633 * dst_pix_fmt = avcodec_find_best_pix_fmt_of_2(dst_pix_fmt, dst_pix_fmt3, src_pix_fmt, alpha, &loss);
4636 * @param[in] dst_pix_fmt1 One of the two destination pixel formats to choose from
4637 * @param[in] dst_pix_fmt2 The other of the two destination pixel formats to choose from
4638 * @param[in] src_pix_fmt Source pixel format
4639 * @param[in] has_alpha Whether the source pixel format alpha channel is used.
4640 * @param[in, out] loss_ptr Combination of loss flags. In: selects which of the losses to ignore, i.e.
4641 * NULL or value of zero means we care about all losses. Out: the loss
4642 * that occurs when converting from src to selected dst pixel format.
4643 * @return The best pixel format to convert to or -1 if none was found.
4645 enum AVPixelFormat avcodec_find_best_pix_fmt_of_2(enum AVPixelFormat dst_pix_fmt1, enum AVPixelFormat dst_pix_fmt2,
4646 enum AVPixelFormat src_pix_fmt, int has_alpha, int *loss_ptr);
4648 attribute_deprecated
4649 #if AV_HAVE_INCOMPATIBLE_FORK_ABI
4650 enum AVPixelFormat avcodec_find_best_pix_fmt2(enum AVPixelFormat *pix_fmt_list,
4651 enum AVPixelFormat src_pix_fmt,
4652 int has_alpha, int *loss_ptr);
4654 enum AVPixelFormat avcodec_find_best_pix_fmt2(enum AVPixelFormat dst_pix_fmt1, enum AVPixelFormat dst_pix_fmt2,
4655 enum AVPixelFormat src_pix_fmt, int has_alpha, int *loss_ptr);
4659 enum AVPixelFormat avcodec_default_get_format(struct AVCodecContext *s, const enum AVPixelFormat * fmt);
4665 void avcodec_set_dimensions(AVCodecContext *s, int width, int height);
4668 * Put a string representing the codec tag codec_tag in buf.
4670 * @param buf_size size in bytes of buf
4671 * @return the length of the string that would have been generated if
4672 * enough space had been available, excluding the trailing null
4674 size_t av_get_codec_tag_string(char *buf, size_t buf_size, unsigned int codec_tag);
4676 void avcodec_string(char *buf, int buf_size, AVCodecContext *enc, int encode);
4679 * Return a name for the specified profile, if available.
4681 * @param codec the codec that is searched for the given profile
4682 * @param profile the profile value for which a name is requested
4683 * @return A name for the profile if found, NULL otherwise.
4685 const char *av_get_profile_name(const AVCodec *codec, int profile);
4687 int avcodec_default_execute(AVCodecContext *c, int (*func)(AVCodecContext *c2, void *arg2),void *arg, int *ret, int count, int size);
4688 int avcodec_default_execute2(AVCodecContext *c, int (*func)(AVCodecContext *c2, void *arg2, int, int),void *arg, int *ret, int count);
4689 //FIXME func typedef
4692 * Fill audio frame data and linesize.
4693 * AVFrame extended_data channel pointers are allocated if necessary for
4696 * @param frame the AVFrame
4697 * frame->nb_samples must be set prior to calling the
4698 * function. This function fills in frame->data,
4699 * frame->extended_data, frame->linesize[0].
4700 * @param nb_channels channel count
4701 * @param sample_fmt sample format
4702 * @param buf buffer to use for frame data
4703 * @param buf_size size of buffer
4704 * @param align plane size sample alignment (0 = default)
4705 * @return 0 on success, negative error code on failure
4707 int avcodec_fill_audio_frame(AVFrame *frame, int nb_channels,
4708 enum AVSampleFormat sample_fmt, const uint8_t *buf,
4709 int buf_size, int align);
4712 * Flush buffers, should be called when seeking or when switching to a different stream.
4714 void avcodec_flush_buffers(AVCodecContext *avctx);
4716 void avcodec_default_free_buffers(AVCodecContext *s);
4719 * Return codec bits per sample.
4721 * @param[in] codec_id the codec
4722 * @return Number of bits per sample or zero if unknown for the given codec.
4724 int av_get_bits_per_sample(enum AVCodecID codec_id);
4727 * Return the PCM codec associated with a sample format.
4728 * @param be endianness, 0 for little, 1 for big,
4729 * -1 (or anything else) for native
4730 * @return AV_CODEC_ID_PCM_* or AV_CODEC_ID_NONE
4732 enum AVCodecID av_get_pcm_codec(enum AVSampleFormat fmt, int be);
4735 * Return codec bits per sample.
4736 * Only return non-zero if the bits per sample is exactly correct, not an
4739 * @param[in] codec_id the codec
4740 * @return Number of bits per sample or zero if unknown for the given codec.
4742 int av_get_exact_bits_per_sample(enum AVCodecID codec_id);
4745 * Return audio frame duration.
4747 * @param avctx codec context
4748 * @param frame_bytes size of the frame, or 0 if unknown
4749 * @return frame duration, in samples, if known. 0 if not able to
4752 int av_get_audio_frame_duration(AVCodecContext *avctx, int frame_bytes);
4755 typedef struct AVBitStreamFilterContext {
4757 struct AVBitStreamFilter *filter;
4758 AVCodecParserContext *parser;
4759 struct AVBitStreamFilterContext *next;
4760 } AVBitStreamFilterContext;
4763 typedef struct AVBitStreamFilter {
4766 int (*filter)(AVBitStreamFilterContext *bsfc,
4767 AVCodecContext *avctx, const char *args,
4768 uint8_t **poutbuf, int *poutbuf_size,
4769 const uint8_t *buf, int buf_size, int keyframe);
4770 void (*close)(AVBitStreamFilterContext *bsfc);
4771 struct AVBitStreamFilter *next;
4772 } AVBitStreamFilter;
4774 void av_register_bitstream_filter(AVBitStreamFilter *bsf);
4775 AVBitStreamFilterContext *av_bitstream_filter_init(const char *name);
4776 int av_bitstream_filter_filter(AVBitStreamFilterContext *bsfc,
4777 AVCodecContext *avctx, const char *args,
4778 uint8_t **poutbuf, int *poutbuf_size,
4779 const uint8_t *buf, int buf_size, int keyframe);
4780 void av_bitstream_filter_close(AVBitStreamFilterContext *bsf);
4782 AVBitStreamFilter *av_bitstream_filter_next(AVBitStreamFilter *f);
4787 * Reallocate the given block if it is not large enough, otherwise do nothing.
4791 void *av_fast_realloc(void *ptr, unsigned int *size, size_t min_size);
4794 * Allocate a buffer, reusing the given one if large enough.
4796 * Contrary to av_fast_realloc the current buffer contents might not be
4797 * preserved and on error the old buffer is freed, thus no special
4798 * handling to avoid memleaks is necessary.
4800 * @param ptr pointer to pointer to already allocated buffer, overwritten with pointer to new buffer
4801 * @param size size of the buffer *ptr points to
4802 * @param min_size minimum size of *ptr buffer after returning, *ptr will be NULL and
4803 * *size 0 if an error occurred.
4805 void av_fast_malloc(void *ptr, unsigned int *size, size_t min_size);
4808 * Same behaviour av_fast_malloc but the buffer has additional
4809 * FF_INPUT_PADDING_SIZE at the end which will will always be 0.
4811 * In addition the whole buffer will initially and after resizes
4812 * be 0-initialized so that no uninitialized data will ever appear.
4814 void av_fast_padded_malloc(void *ptr, unsigned int *size, size_t min_size);
4817 * Same behaviour av_fast_padded_malloc except that buffer will always
4818 * be 0-initialized after call.
4820 void av_fast_padded_mallocz(void *ptr, unsigned int *size, size_t min_size);
4823 * Encode extradata length to a buffer. Used by xiph codecs.
4825 * @param s buffer to write to; must be at least (v/255+1) bytes long
4826 * @param v size of extradata in bytes
4827 * @return number of bytes written to the buffer.
4829 unsigned int av_xiphlacing(unsigned char *s, unsigned int v);
4832 * Log a generic warning message about a missing feature. This function is
4833 * intended to be used internally by FFmpeg (libavcodec, libavformat, etc.)
4834 * only, and would normally not be used by applications.
4835 * @param[in] avc a pointer to an arbitrary struct of which the first field is
4836 * a pointer to an AVClass struct
4837 * @param[in] feature string containing the name of the missing feature
4838 * @param[in] want_sample indicates if samples are wanted which exhibit this feature.
4839 * If want_sample is non-zero, additional verbage will be added to the log
4840 * message which tells the user how to report samples to the development
4843 void av_log_missing_feature(void *avc, const char *feature, int want_sample);
4846 * Log a generic warning message asking for a sample. This function is
4847 * intended to be used internally by FFmpeg (libavcodec, libavformat, etc.)
4848 * only, and would normally not be used by applications.
4849 * @param[in] avc a pointer to an arbitrary struct of which the first field is
4850 * a pointer to an AVClass struct
4851 * @param[in] msg string containing an optional message, or NULL if no message
4853 void av_log_ask_for_sample(void *avc, const char *msg, ...) av_printf_format(2, 3);
4856 * Register the hardware accelerator hwaccel.
4858 void av_register_hwaccel(AVHWAccel *hwaccel);
4861 * If hwaccel is NULL, returns the first registered hardware accelerator,
4862 * if hwaccel is non-NULL, returns the next registered hardware accelerator
4863 * after hwaccel, or NULL if hwaccel is the last one.
4865 AVHWAccel *av_hwaccel_next(AVHWAccel *hwaccel);
4869 * Lock operation used by lockmgr
4872 AV_LOCK_CREATE, ///< Create a mutex
4873 AV_LOCK_OBTAIN, ///< Lock the mutex
4874 AV_LOCK_RELEASE, ///< Unlock the mutex
4875 AV_LOCK_DESTROY, ///< Free mutex resources
4879 * Register a user provided lock manager supporting the operations
4880 * specified by AVLockOp. mutex points to a (void *) where the
4881 * lockmgr should store/get a pointer to a user allocated mutex. It's
4882 * NULL upon AV_LOCK_CREATE and != NULL for all other ops.
4884 * @param cb User defined callback. Note: FFmpeg may invoke calls to this
4885 * callback during the call to av_lockmgr_register().
4886 * Thus, the application must be prepared to handle that.
4887 * If cb is set to NULL the lockmgr will be unregistered.
4888 * Also note that during unregistration the previously registered
4889 * lockmgr callback may also be invoked.
4891 int av_lockmgr_register(int (*cb)(void **mutex, enum AVLockOp op));
4894 * Get the type of the given codec.
4896 enum AVMediaType avcodec_get_type(enum AVCodecID codec_id);
4899 * Get the name of a codec.
4900 * @return a static string identifying the codec; never NULL
4902 const char *avcodec_get_name(enum AVCodecID id);
4905 * @return a positive value if s is open (i.e. avcodec_open2() was called on it
4906 * with no corresponding avcodec_close()), 0 otherwise.
4908 int avcodec_is_open(AVCodecContext *s);
4911 * @return a non-zero number if codec is an encoder, zero otherwise
4913 int av_codec_is_encoder(const AVCodec *codec);
4916 * @return a non-zero number if codec is a decoder, zero otherwise
4918 int av_codec_is_decoder(const AVCodec *codec);
4921 * @return descriptor for given codec ID or NULL if no descriptor exists.
4923 const AVCodecDescriptor *avcodec_descriptor_get(enum AVCodecID id);
4926 * Iterate over all codec descriptors known to libavcodec.
4928 * @param prev previous descriptor. NULL to get the first descriptor.
4930 * @return next descriptor or NULL after the last descriptor
4932 const AVCodecDescriptor *avcodec_descriptor_next(const AVCodecDescriptor *prev);
4935 * @return codec descriptor with the given name or NULL if no such descriptor
4938 const AVCodecDescriptor *avcodec_descriptor_get_by_name(const char *name);
4944 #endif /* AVCODEC_AVCODEC_H */