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'),
287 /* various PCM "codecs" */
288 AV_CODEC_ID_FIRST_AUDIO = 0x10000, ///< A dummy id pointing at the start of audio codecs
289 AV_CODEC_ID_PCM_S16LE = 0x10000,
290 AV_CODEC_ID_PCM_S16BE,
291 AV_CODEC_ID_PCM_U16LE,
292 AV_CODEC_ID_PCM_U16BE,
295 AV_CODEC_ID_PCM_MULAW,
296 AV_CODEC_ID_PCM_ALAW,
297 AV_CODEC_ID_PCM_S32LE,
298 AV_CODEC_ID_PCM_S32BE,
299 AV_CODEC_ID_PCM_U32LE,
300 AV_CODEC_ID_PCM_U32BE,
301 AV_CODEC_ID_PCM_S24LE,
302 AV_CODEC_ID_PCM_S24BE,
303 AV_CODEC_ID_PCM_U24LE,
304 AV_CODEC_ID_PCM_U24BE,
305 AV_CODEC_ID_PCM_S24DAUD,
306 AV_CODEC_ID_PCM_ZORK,
307 AV_CODEC_ID_PCM_S16LE_PLANAR,
309 AV_CODEC_ID_PCM_F32BE,
310 AV_CODEC_ID_PCM_F32LE,
311 AV_CODEC_ID_PCM_F64BE,
312 AV_CODEC_ID_PCM_F64LE,
313 AV_CODEC_ID_PCM_BLURAY,
316 AV_CODEC_ID_PCM_S8_PLANAR,
318 /* various ADPCM codecs */
319 AV_CODEC_ID_ADPCM_IMA_QT = 0x11000,
320 AV_CODEC_ID_ADPCM_IMA_WAV,
321 AV_CODEC_ID_ADPCM_IMA_DK3,
322 AV_CODEC_ID_ADPCM_IMA_DK4,
323 AV_CODEC_ID_ADPCM_IMA_WS,
324 AV_CODEC_ID_ADPCM_IMA_SMJPEG,
325 AV_CODEC_ID_ADPCM_MS,
326 AV_CODEC_ID_ADPCM_4XM,
327 AV_CODEC_ID_ADPCM_XA,
328 AV_CODEC_ID_ADPCM_ADX,
329 AV_CODEC_ID_ADPCM_EA,
330 AV_CODEC_ID_ADPCM_G726,
331 AV_CODEC_ID_ADPCM_CT,
332 AV_CODEC_ID_ADPCM_SWF,
333 AV_CODEC_ID_ADPCM_YAMAHA,
334 AV_CODEC_ID_ADPCM_SBPRO_4,
335 AV_CODEC_ID_ADPCM_SBPRO_3,
336 AV_CODEC_ID_ADPCM_SBPRO_2,
337 AV_CODEC_ID_ADPCM_THP,
338 AV_CODEC_ID_ADPCM_IMA_AMV,
339 AV_CODEC_ID_ADPCM_EA_R1,
340 AV_CODEC_ID_ADPCM_EA_R3,
341 AV_CODEC_ID_ADPCM_EA_R2,
342 AV_CODEC_ID_ADPCM_IMA_EA_SEAD,
343 AV_CODEC_ID_ADPCM_IMA_EA_EACS,
344 AV_CODEC_ID_ADPCM_EA_XAS,
345 AV_CODEC_ID_ADPCM_EA_MAXIS_XA,
346 AV_CODEC_ID_ADPCM_IMA_ISS,
347 AV_CODEC_ID_ADPCM_G722,
348 AV_CODEC_ID_ADPCM_IMA_APC,
349 AV_CODEC_ID_VIMA = MKBETAG('V','I','M','A'),
352 AV_CODEC_ID_AMR_NB = 0x12000,
355 /* RealAudio codecs*/
356 AV_CODEC_ID_RA_144 = 0x13000,
359 /* various DPCM codecs */
360 AV_CODEC_ID_ROQ_DPCM = 0x14000,
361 AV_CODEC_ID_INTERPLAY_DPCM,
362 AV_CODEC_ID_XAN_DPCM,
363 AV_CODEC_ID_SOL_DPCM,
366 AV_CODEC_ID_MP2 = 0x15000,
367 AV_CODEC_ID_MP3, ///< preferred ID for decoding MPEG audio layer 1, 2 or 3
377 AV_CODEC_ID_VMDAUDIO,
383 AV_CODEC_ID_WESTWOOD_SND1,
384 AV_CODEC_ID_GSM, ///< as in Berlin toast format
387 AV_CODEC_ID_TRUESPEECH,
389 AV_CODEC_ID_SMACKAUDIO,
392 AV_CODEC_ID_DSICINAUDIO,
394 AV_CODEC_ID_MUSEPACK7,
396 AV_CODEC_ID_GSM_MS, /* as found in WAV */
400 AV_CODEC_ID_NELLYMOSER,
401 AV_CODEC_ID_MUSEPACK8,
403 AV_CODEC_ID_WMAVOICE,
405 AV_CODEC_ID_WMALOSSLESS,
414 AV_CODEC_ID_BINKAUDIO_RDFT,
415 AV_CODEC_ID_BINKAUDIO_DCT,
416 AV_CODEC_ID_AAC_LATM,
421 AV_CODEC_ID_8SVX_EXP,
422 AV_CODEC_ID_8SVX_FIB,
423 AV_CODEC_ID_BMV_AUDIO,
427 AV_CODEC_ID_OPUS_DEPRECATED,
428 AV_CODEC_ID_FFWAVESYNTH = MKBETAG('F','F','W','S'),
429 AV_CODEC_ID_8SVX_RAW = MKBETAG('8','S','V','X'),
430 AV_CODEC_ID_SONIC = MKBETAG('S','O','N','C'),
431 AV_CODEC_ID_SONIC_LS = MKBETAG('S','O','N','L'),
432 AV_CODEC_ID_PAF_AUDIO = MKBETAG('P','A','F','A'),
433 AV_CODEC_ID_OPUS = MKBETAG('O','P','U','S'),
434 AV_CODEC_ID_TAK = MKBETAG('t','B','a','K'),
436 /* subtitle codecs */
437 AV_CODEC_ID_FIRST_SUBTITLE = 0x17000, ///< A dummy ID pointing at the start of subtitle codecs.
438 AV_CODEC_ID_DVD_SUBTITLE = 0x17000,
439 AV_CODEC_ID_DVB_SUBTITLE,
440 AV_CODEC_ID_TEXT, ///< raw UTF-8 text
443 AV_CODEC_ID_MOV_TEXT,
444 AV_CODEC_ID_HDMV_PGS_SUBTITLE,
445 AV_CODEC_ID_DVB_TELETEXT,
447 AV_CODEC_ID_MICRODVD = MKBETAG('m','D','V','D'),
448 AV_CODEC_ID_EIA_608 = MKBETAG('c','6','0','8'),
449 AV_CODEC_ID_JACOSUB = MKBETAG('J','S','U','B'),
450 AV_CODEC_ID_SAMI = MKBETAG('S','A','M','I'),
451 AV_CODEC_ID_REALTEXT = MKBETAG('R','T','X','T'),
452 AV_CODEC_ID_SUBVIEWER = MKBETAG('S','u','b','V'),
453 AV_CODEC_ID_SUBRIP = MKBETAG('S','R','i','p'),
454 AV_CODEC_ID_WEBVTT = MKBETAG('W','V','T','T'),
456 /* other specific kind of codecs (generally used for attachments) */
457 AV_CODEC_ID_FIRST_UNKNOWN = 0x18000, ///< A dummy ID pointing at the start of various fake codecs.
458 AV_CODEC_ID_TTF = 0x18000,
459 AV_CODEC_ID_BINTEXT = MKBETAG('B','T','X','T'),
460 AV_CODEC_ID_XBIN = MKBETAG('X','B','I','N'),
461 AV_CODEC_ID_IDF = MKBETAG( 0 ,'I','D','F'),
462 AV_CODEC_ID_OTF = MKBETAG( 0 ,'O','T','F'),
464 AV_CODEC_ID_PROBE = 0x19000, ///< codec_id is not known (like AV_CODEC_ID_NONE) but lavf should attempt to identify it
466 AV_CODEC_ID_MPEG2TS = 0x20000, /**< _FAKE_ codec to indicate a raw MPEG-2 TS
467 * stream (only used by libavformat) */
468 AV_CODEC_ID_MPEG4SYSTEMS = 0x20001, /**< _FAKE_ codec to indicate a MPEG-4 Systems
469 * stream (only used by libavformat) */
470 AV_CODEC_ID_FFMETADATA = 0x21000, ///< Dummy codec for streams containing only metadata information.
473 #include "old_codec_ids.h"
478 #define CodecID AVCodecID
482 * This struct describes the properties of a single codec described by an
484 * @see avcodec_get_descriptor()
486 typedef struct AVCodecDescriptor {
488 enum AVMediaType type;
490 * Name of the codec described by this descriptor. It is non-empty and
491 * unique for each codec descriptor. It should contain alphanumeric
492 * characters and '_' only.
496 * A more descriptive name for this codec. May be NULL.
498 const char *long_name;
500 * Codec properties, a combination of AV_CODEC_PROP_* flags.
506 * Codec uses only intra compression.
509 #define AV_CODEC_PROP_INTRA_ONLY (1 << 0)
511 * Codec supports lossy compression. Audio and video codecs only.
512 * @note a codec may support both lossy and lossless
515 #define AV_CODEC_PROP_LOSSY (1 << 1)
517 * Codec supports lossless compression. Audio and video codecs only.
519 #define AV_CODEC_PROP_LOSSLESS (1 << 2)
521 #if FF_API_OLD_DECODE_AUDIO
523 #define AVCODEC_MAX_AUDIO_FRAME_SIZE 192000 // 1 second of 48khz 32bit audio
527 * @ingroup lavc_decoding
528 * Required number of additionally allocated bytes at the end of the input bitstream for decoding.
529 * This is mainly needed because some optimized bitstream readers read
530 * 32 or 64 bit at once and could read over the end.<br>
531 * Note: If the first 23 bits of the additional bytes are not 0, then damaged
532 * MPEG bitstreams could cause overread and segfault.
534 #define FF_INPUT_BUFFER_PADDING_SIZE 16
537 * @ingroup lavc_encoding
538 * minimum encoding buffer size
539 * Used to avoid some checks during header writing.
541 #define FF_MIN_BUFFER_SIZE 16384
545 * @ingroup lavc_encoding
546 * motion estimation type.
549 ME_ZERO = 1, ///< no search, that is use 0,0 vector whenever one is needed
553 ME_EPZS, ///< enhanced predictive zonal search
554 ME_X1, ///< reserved for experiments
555 ME_HEX, ///< hexagon based search
556 ME_UMH, ///< uneven multi-hexagon search
557 ME_ITER, ///< iterative search
558 ME_TESA, ///< transformed exhaustive search algorithm
562 * @ingroup lavc_decoding
565 /* We leave some space between them for extensions (drop some
566 * keyframes for intra-only or drop just some bidir frames). */
567 AVDISCARD_NONE =-16, ///< discard nothing
568 AVDISCARD_DEFAULT = 0, ///< discard useless packets like 0 size packets in avi
569 AVDISCARD_NONREF = 8, ///< discard all non reference
570 AVDISCARD_BIDIR = 16, ///< discard all bidirectional frames
571 AVDISCARD_NONKEY = 32, ///< discard all frames except keyframes
572 AVDISCARD_ALL = 48, ///< discard all
575 enum AVColorPrimaries{
576 AVCOL_PRI_BT709 = 1, ///< also ITU-R BT1361 / IEC 61966-2-4 / SMPTE RP177 Annex B
577 AVCOL_PRI_UNSPECIFIED = 2,
578 AVCOL_PRI_BT470M = 4,
579 AVCOL_PRI_BT470BG = 5, ///< also ITU-R BT601-6 625 / ITU-R BT1358 625 / ITU-R BT1700 625 PAL & SECAM
580 AVCOL_PRI_SMPTE170M = 6, ///< also ITU-R BT601-6 525 / ITU-R BT1358 525 / ITU-R BT1700 NTSC
581 AVCOL_PRI_SMPTE240M = 7, ///< functionally identical to above
583 AVCOL_PRI_NB , ///< Not part of ABI
586 enum AVColorTransferCharacteristic{
587 AVCOL_TRC_BT709 = 1, ///< also ITU-R BT1361
588 AVCOL_TRC_UNSPECIFIED = 2,
589 AVCOL_TRC_GAMMA22 = 4, ///< also ITU-R BT470M / ITU-R BT1700 625 PAL & SECAM
590 AVCOL_TRC_GAMMA28 = 5, ///< also ITU-R BT470BG
591 AVCOL_TRC_SMPTE240M = 7,
592 AVCOL_TRC_NB , ///< Not part of ABI
597 AVCOL_SPC_BT709 = 1, ///< also ITU-R BT1361 / IEC 61966-2-4 xvYCC709 / SMPTE RP177 Annex B
598 AVCOL_SPC_UNSPECIFIED = 2,
600 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
601 AVCOL_SPC_SMPTE170M = 6, ///< also ITU-R BT601-6 525 / ITU-R BT1358 525 / ITU-R BT1700 NTSC / functionally identical to above
602 AVCOL_SPC_SMPTE240M = 7,
603 AVCOL_SPC_YCOCG = 8, ///< Used by Dirac / VC-2 and H.264 FRext, see ITU-T SG16
604 AVCOL_SPC_NB , ///< Not part of ABI
606 #define AVCOL_SPC_YCGCO AVCOL_SPC_YCOCG
609 AVCOL_RANGE_UNSPECIFIED = 0,
610 AVCOL_RANGE_MPEG = 1, ///< the normal 219*2^(n-8) "MPEG" YUV ranges
611 AVCOL_RANGE_JPEG = 2, ///< the normal 2^n-1 "JPEG" YUV ranges
612 AVCOL_RANGE_NB , ///< Not part of ABI
616 * X X 3 4 X X are luma samples,
617 * 1 2 1-6 are possible chroma positions
618 * X X 5 6 X 0 is undefined/unknown position
620 enum AVChromaLocation{
621 AVCHROMA_LOC_UNSPECIFIED = 0,
622 AVCHROMA_LOC_LEFT = 1, ///< mpeg2/4, h264 default
623 AVCHROMA_LOC_CENTER = 2, ///< mpeg1, jpeg, h263
624 AVCHROMA_LOC_TOPLEFT = 3, ///< DV
625 AVCHROMA_LOC_TOP = 4,
626 AVCHROMA_LOC_BOTTOMLEFT = 5,
627 AVCHROMA_LOC_BOTTOM = 6,
628 AVCHROMA_LOC_NB , ///< Not part of ABI
631 enum AVAudioServiceType {
632 AV_AUDIO_SERVICE_TYPE_MAIN = 0,
633 AV_AUDIO_SERVICE_TYPE_EFFECTS = 1,
634 AV_AUDIO_SERVICE_TYPE_VISUALLY_IMPAIRED = 2,
635 AV_AUDIO_SERVICE_TYPE_HEARING_IMPAIRED = 3,
636 AV_AUDIO_SERVICE_TYPE_DIALOGUE = 4,
637 AV_AUDIO_SERVICE_TYPE_COMMENTARY = 5,
638 AV_AUDIO_SERVICE_TYPE_EMERGENCY = 6,
639 AV_AUDIO_SERVICE_TYPE_VOICE_OVER = 7,
640 AV_AUDIO_SERVICE_TYPE_KARAOKE = 8,
641 AV_AUDIO_SERVICE_TYPE_NB , ///< Not part of ABI
645 * @ingroup lavc_encoding
647 typedef struct RcOverride{
650 int qscale; // If this is 0 then quality_factor will be used instead.
651 float quality_factor;
654 #define FF_MAX_B_FRAMES 16
657 These flags can be passed in AVCodecContext.flags before initialization.
658 Note: Not everything is supported yet.
661 #define CODEC_FLAG_QSCALE 0x0002 ///< Use fixed qscale.
662 #define CODEC_FLAG_4MV 0x0004 ///< 4 MV per MB allowed / advanced prediction for H.263.
663 #define CODEC_FLAG_QPEL 0x0010 ///< Use qpel MC.
664 #define CODEC_FLAG_GMC 0x0020 ///< Use GMC.
665 #define CODEC_FLAG_MV0 0x0040 ///< Always try a MB with MV=<0,0>.
667 * The parent program guarantees that the input for B-frames containing
668 * streams is not written to for at least s->max_b_frames+1 frames, if
669 * this is not set the input will be copied.
671 #define CODEC_FLAG_INPUT_PRESERVED 0x0100
672 #define CODEC_FLAG_PASS1 0x0200 ///< Use internal 2pass ratecontrol in first pass mode.
673 #define CODEC_FLAG_PASS2 0x0400 ///< Use internal 2pass ratecontrol in second pass mode.
674 #define CODEC_FLAG_GRAY 0x2000 ///< Only decode/encode grayscale.
675 #define CODEC_FLAG_EMU_EDGE 0x4000 ///< Don't draw edges.
676 #define CODEC_FLAG_PSNR 0x8000 ///< error[?] variables will be set during encoding.
677 #define CODEC_FLAG_TRUNCATED 0x00010000 /** Input bitstream might be truncated at a random
678 location instead of only at frame boundaries. */
679 #define CODEC_FLAG_NORMALIZE_AQP 0x00020000 ///< Normalize adaptive quantization.
680 #define CODEC_FLAG_INTERLACED_DCT 0x00040000 ///< Use interlaced DCT.
681 #define CODEC_FLAG_LOW_DELAY 0x00080000 ///< Force low delay.
682 #define CODEC_FLAG_GLOBAL_HEADER 0x00400000 ///< Place global headers in extradata instead of every keyframe.
683 #define CODEC_FLAG_BITEXACT 0x00800000 ///< Use only bitexact stuff (except (I)DCT).
684 /* Fx : Flag for h263+ extra options */
685 #define CODEC_FLAG_AC_PRED 0x01000000 ///< H.263 advanced intra coding / MPEG-4 AC prediction
686 #define CODEC_FLAG_LOOP_FILTER 0x00000800 ///< loop filter
687 #define CODEC_FLAG_INTERLACED_ME 0x20000000 ///< interlaced motion estimation
688 #define CODEC_FLAG_CLOSED_GOP 0x80000000
689 #define CODEC_FLAG2_FAST 0x00000001 ///< Allow non spec compliant speedup tricks.
690 #define CODEC_FLAG2_NO_OUTPUT 0x00000004 ///< Skip bitstream encoding.
691 #define CODEC_FLAG2_LOCAL_HEADER 0x00000008 ///< Place global headers at every keyframe instead of in extradata.
692 #define CODEC_FLAG2_DROP_FRAME_TIMECODE 0x00002000 ///< timecode is in drop frame format. DEPRECATED!!!!
693 #if FF_API_MPV_GLOBAL_OPTS
694 #define CODEC_FLAG_CBP_RD 0x04000000 ///< Use rate distortion optimization for cbp.
695 #define CODEC_FLAG_QP_RD 0x08000000 ///< Use rate distortion optimization for qp selectioon.
696 #define CODEC_FLAG2_STRICT_GOP 0x00000002 ///< Strictly enforce GOP size.
697 #define CODEC_FLAG2_SKIP_RD 0x00004000 ///< RD optimal MB level residual skipping
699 #define CODEC_FLAG2_CHUNKS 0x00008000 ///< Input bitstream might be truncated at a packet boundaries instead of only at frame boundaries.
700 #define CODEC_FLAG2_SHOW_ALL 0x00400000 ///< Show all frames before the first keyframe
702 /* Unsupported options :
703 * Syntax Arithmetic coding (SAC)
704 * Reference Picture Selection
705 * Independent Segment Decoding */
707 /* codec capabilities */
709 #define CODEC_CAP_DRAW_HORIZ_BAND 0x0001 ///< Decoder can use draw_horiz_band callback.
711 * Codec uses get_buffer() for allocating buffers and supports custom allocators.
712 * If not set, it might not use get_buffer() at all or use operations that
713 * assume the buffer was allocated by avcodec_default_get_buffer.
715 #define CODEC_CAP_DR1 0x0002
716 #define CODEC_CAP_TRUNCATED 0x0008
717 /* Codec can export data for HW decoding (XvMC). */
718 #define CODEC_CAP_HWACCEL 0x0010
720 * Encoder or decoder requires flushing with NULL input at the end in order to
721 * give the complete and correct output.
723 * NOTE: If this flag is not set, the codec is guaranteed to never be fed with
724 * with NULL data. The user can still send NULL data to the public encode
725 * or decode function, but libavcodec will not pass it along to the codec
726 * unless this flag is set.
729 * The decoder has a non-zero delay and needs to be fed with avpkt->data=NULL,
730 * avpkt->size=0 at the end to get the delayed data until the decoder no longer
734 * The encoder needs to be fed with NULL data at the end of encoding until the
735 * encoder no longer returns data.
737 * NOTE: For encoders implementing the AVCodec.encode2() function, setting this
738 * flag also means that the encoder must set the pts and duration for
739 * each output packet. If this flag is not set, the pts and duration will
740 * be determined by libavcodec from the input frame.
742 #define CODEC_CAP_DELAY 0x0020
744 * Codec can be fed a final frame with a smaller size.
745 * This can be used to prevent truncation of the last audio samples.
747 #define CODEC_CAP_SMALL_LAST_FRAME 0x0040
749 * Codec can export data for HW decoding (VDPAU).
751 #define CODEC_CAP_HWACCEL_VDPAU 0x0080
753 * Codec can output multiple frames per AVPacket
754 * Normally demuxers return one frame at a time, demuxers which do not do
755 * are connected to a parser to split what they return into proper frames.
756 * This flag is reserved to the very rare category of codecs which have a
757 * bitstream that cannot be split into frames without timeconsuming
758 * operations like full decoding. Demuxers carring such bitstreams thus
759 * may return multiple frames in a packet. This has many disadvantages like
760 * prohibiting stream copy in many cases thus it should only be considered
763 #define CODEC_CAP_SUBFRAMES 0x0100
765 * Codec is experimental and is thus avoided in favor of non experimental
768 #define CODEC_CAP_EXPERIMENTAL 0x0200
770 * Codec should fill in channel configuration and samplerate instead of container
772 #define CODEC_CAP_CHANNEL_CONF 0x0400
775 * Codec is able to deal with negative linesizes
777 #define CODEC_CAP_NEG_LINESIZES 0x0800
780 * Codec supports frame-level multithreading.
782 #define CODEC_CAP_FRAME_THREADS 0x1000
784 * Codec supports slice-based (or partition-based) multithreading.
786 #define CODEC_CAP_SLICE_THREADS 0x2000
788 * Codec supports changed parameters at any point.
790 #define CODEC_CAP_PARAM_CHANGE 0x4000
792 * Codec supports avctx->thread_count == 0 (auto).
794 #define CODEC_CAP_AUTO_THREADS 0x8000
796 * Audio encoder supports receiving a different number of samples in each call.
798 #define CODEC_CAP_VARIABLE_FRAME_SIZE 0x10000
800 * Codec is intra only.
802 #define CODEC_CAP_INTRA_ONLY 0x40000000
806 #define CODEC_CAP_LOSSLESS 0x80000000
808 //The following defines may change, don't expect compatibility if you use them.
809 #define MB_TYPE_INTRA4x4 0x0001
810 #define MB_TYPE_INTRA16x16 0x0002 //FIXME H.264-specific
811 #define MB_TYPE_INTRA_PCM 0x0004 //FIXME H.264-specific
812 #define MB_TYPE_16x16 0x0008
813 #define MB_TYPE_16x8 0x0010
814 #define MB_TYPE_8x16 0x0020
815 #define MB_TYPE_8x8 0x0040
816 #define MB_TYPE_INTERLACED 0x0080
817 #define MB_TYPE_DIRECT2 0x0100 //FIXME
818 #define MB_TYPE_ACPRED 0x0200
819 #define MB_TYPE_GMC 0x0400
820 #define MB_TYPE_SKIP 0x0800
821 #define MB_TYPE_P0L0 0x1000
822 #define MB_TYPE_P1L0 0x2000
823 #define MB_TYPE_P0L1 0x4000
824 #define MB_TYPE_P1L1 0x8000
825 #define MB_TYPE_L0 (MB_TYPE_P0L0 | MB_TYPE_P1L0)
826 #define MB_TYPE_L1 (MB_TYPE_P0L1 | MB_TYPE_P1L1)
827 #define MB_TYPE_L0L1 (MB_TYPE_L0 | MB_TYPE_L1)
828 #define MB_TYPE_QUANT 0x00010000
829 #define MB_TYPE_CBP 0x00020000
830 //Note bits 24-31 are reserved for codec specific use (h264 ref0, mpeg1 0mv, ...)
834 * This specifies the area which should be displayed.
835 * Note there may be multiple such areas for one frame.
837 typedef struct AVPanScan{
840 * - encoding: Set by user.
841 * - decoding: Set by libavcodec.
846 * width and height in 1/16 pel
847 * - encoding: Set by user.
848 * - decoding: Set by libavcodec.
854 * position of the top left corner in 1/16 pel for up to 3 fields/frames
855 * - encoding: Set by user.
856 * - decoding: Set by libavcodec.
858 int16_t position[3][2];
861 #define FF_QSCALE_TYPE_MPEG1 0
862 #define FF_QSCALE_TYPE_MPEG2 1
863 #define FF_QSCALE_TYPE_H264 2
864 #define FF_QSCALE_TYPE_VP56 3
866 #define FF_BUFFER_TYPE_INTERNAL 1
867 #define FF_BUFFER_TYPE_USER 2 ///< direct rendering buffers (image is (de)allocated by user)
868 #define FF_BUFFER_TYPE_SHARED 4 ///< Buffer from somewhere else; don't deallocate image (data/base), all other tables are not shared.
869 #define FF_BUFFER_TYPE_COPY 8 ///< Just a (modified) copy of some other buffer, don't deallocate anything.
871 #define FF_BUFFER_HINTS_VALID 0x01 // Buffer hints value is meaningful (if 0 ignore).
872 #define FF_BUFFER_HINTS_READABLE 0x02 // Codec will read from buffer.
873 #define FF_BUFFER_HINTS_PRESERVE 0x04 // User must not alter buffer content.
874 #define FF_BUFFER_HINTS_REUSABLE 0x08 // Codec will reuse the buffer (update).
877 * @defgroup lavc_packet AVPacket
879 * Types and functions for working with AVPacket.
882 enum AVPacketSideDataType {
884 AV_PKT_DATA_NEW_EXTRADATA,
887 * An AV_PKT_DATA_PARAM_CHANGE side data packet is laid out as follows:
890 * if (param_flags & AV_SIDE_DATA_PARAM_CHANGE_CHANNEL_COUNT)
891 * s32le channel_count
892 * if (param_flags & AV_SIDE_DATA_PARAM_CHANGE_CHANNEL_LAYOUT)
893 * u64le channel_layout
894 * if (param_flags & AV_SIDE_DATA_PARAM_CHANGE_SAMPLE_RATE)
896 * if (param_flags & AV_SIDE_DATA_PARAM_CHANGE_DIMENSIONS)
901 AV_PKT_DATA_PARAM_CHANGE,
904 * An AV_PKT_DATA_H263_MB_INFO side data packet contains a number of
905 * structures with info about macroblocks relevant to splitting the
906 * packet into smaller packets on macroblock edges (e.g. as for RFC 2190).
907 * That is, it does not necessarily contain info about all macroblocks,
908 * as long as the distance between macroblocks in the info is smaller
909 * than the target payload size.
910 * Each MB info structure is 12 bytes, and is laid out as follows:
912 * u32le bit offset from the start of the packet
913 * u8 current quantizer at the start of the macroblock
915 * u16le macroblock address within the GOB
916 * u8 horizontal MV predictor
917 * u8 vertical MV predictor
918 * u8 horizontal MV predictor for block number 3
919 * u8 vertical MV predictor for block number 3
922 AV_PKT_DATA_H263_MB_INFO,
925 * Recommmends skipping the specified number of samples
927 * u32le number of samples to skip from start of this packet
928 * u32le number of samples to skip from end of this packet
929 * u8 reason for start skip
930 * u8 reason for end skip (0=padding silence, 1=convergence)
933 AV_PKT_DATA_SKIP_SAMPLES=70,
936 * An AV_PKT_DATA_JP_DUALMONO side data packet indicates that
937 * the packet may contain "dual mono" audio specific to Japanese DTV
938 * and if it is true, recommends only the selected channel to be used.
940 * u8 selected channels (0=mail/left, 1=sub/right, 2=both)
943 AV_PKT_DATA_JP_DUALMONO,
946 typedef struct AVPacket {
948 * Presentation timestamp in AVStream->time_base units; the time at which
949 * the decompressed packet will be presented to the user.
950 * Can be AV_NOPTS_VALUE if it is not stored in the file.
951 * pts MUST be larger or equal to dts as presentation cannot happen before
952 * decompression, unless one wants to view hex dumps. Some formats misuse
953 * the terms dts and pts/cts to mean something different. Such timestamps
954 * must be converted to true pts/dts before they are stored in AVPacket.
958 * Decompression timestamp in AVStream->time_base units; the time at which
959 * the packet is decompressed.
960 * Can be AV_NOPTS_VALUE if it is not stored in the file.
967 * A combination of AV_PKT_FLAG values
971 * Additional packet data that can be provided by the container.
972 * Packet can contain several types of side information.
977 enum AVPacketSideDataType type;
982 * Duration of this packet in AVStream->time_base units, 0 if unknown.
983 * Equals next_pts - this_pts in presentation order.
986 void (*destruct)(struct AVPacket *);
988 int64_t pos; ///< byte position in stream, -1 if unknown
991 * Time difference in AVStream->time_base units from the pts of this
992 * packet to the point at which the output from the decoder has converged
993 * independent from the availability of previous frames. That is, the
994 * frames are virtually identical no matter if decoding started from
995 * the very first frame or from this keyframe.
996 * Is AV_NOPTS_VALUE if unknown.
997 * This field is not the display duration of the current packet.
998 * This field has no meaning if the packet does not have AV_PKT_FLAG_KEY
1001 * The purpose of this field is to allow seeking in streams that have no
1002 * keyframes in the conventional sense. It corresponds to the
1003 * recovery point SEI in H.264 and match_time_delta in NUT. It is also
1004 * essential for some types of subtitle streams to ensure that all
1005 * subtitles are correctly displayed after seeking.
1007 int64_t convergence_duration;
1009 #define AV_PKT_FLAG_KEY 0x0001 ///< The packet contains a keyframe
1010 #define AV_PKT_FLAG_CORRUPT 0x0002 ///< The packet content is corrupted
1012 enum AVSideDataParamChangeFlags {
1013 AV_SIDE_DATA_PARAM_CHANGE_CHANNEL_COUNT = 0x0001,
1014 AV_SIDE_DATA_PARAM_CHANGE_CHANNEL_LAYOUT = 0x0002,
1015 AV_SIDE_DATA_PARAM_CHANGE_SAMPLE_RATE = 0x0004,
1016 AV_SIDE_DATA_PARAM_CHANGE_DIMENSIONS = 0x0008,
1023 * Audio Video Frame.
1024 * New fields can be added to the end of AVFRAME with minor version
1025 * bumps. Similarly fields that are marked as to be only accessed by
1026 * av_opt_ptr() can be reordered. This allows 2 forks to add fields
1027 * without breaking compatibility with each other.
1028 * Removal, reordering and changes in the remaining cases require
1029 * a major version bump.
1030 * sizeof(AVFrame) must not be used outside libavcodec.
1032 typedef struct AVFrame {
1033 #define AV_NUM_DATA_POINTERS 8
1035 * pointer to the picture/channel planes.
1036 * This might be different from the first allocated byte
1037 * - encoding: Set by user
1038 * - decoding: set by AVCodecContext.get_buffer()
1040 uint8_t *data[AV_NUM_DATA_POINTERS];
1043 * Size, in bytes, of the data for each picture/channel plane.
1045 * For audio, only linesize[0] may be set. For planar audio, each channel
1046 * plane must be the same size.
1048 * - encoding: Set by user
1049 * - decoding: set by AVCodecContext.get_buffer()
1051 int linesize[AV_NUM_DATA_POINTERS];
1054 * pointers to the data planes/channels.
1056 * For video, this should simply point to data[].
1058 * For planar audio, each channel has a separate data pointer, and
1059 * linesize[0] contains the size of each channel buffer.
1060 * For packed audio, there is just one data pointer, and linesize[0]
1061 * contains the total size of the buffer for all channels.
1063 * Note: Both data and extended_data will always be set by get_buffer(),
1064 * but for planar audio with more channels that can fit in data,
1065 * extended_data must be used by the decoder in order to access all
1069 * decoding: set by AVCodecContext.get_buffer()
1071 uint8_t **extended_data;
1074 * width and height of the video frame
1075 * - encoding: unused
1076 * - decoding: Read by user.
1081 * number of audio samples (per channel) described by this frame
1082 * - encoding: Set by user
1083 * - decoding: Set by libavcodec
1088 * format of the frame, -1 if unknown or unset
1089 * Values correspond to enum AVPixelFormat for video frames,
1090 * enum AVSampleFormat for audio)
1091 * - encoding: unused
1092 * - decoding: Read by user.
1097 * 1 -> keyframe, 0-> not
1098 * - encoding: Set by libavcodec.
1099 * - decoding: Set by libavcodec.
1104 * Picture type of the frame, see ?_TYPE below.
1105 * - encoding: Set by libavcodec. for coded_picture (and set by user for input).
1106 * - decoding: Set by libavcodec.
1108 enum AVPictureType pict_type;
1111 * pointer to the first allocated byte of the picture. Can be used in get_buffer/release_buffer.
1112 * This isn't used by libavcodec unless the default get/release_buffer() is used.
1116 uint8_t *base[AV_NUM_DATA_POINTERS];
1119 * sample aspect ratio for the video frame, 0/1 if unknown/unspecified
1120 * - encoding: unused
1121 * - decoding: Read by user.
1123 AVRational sample_aspect_ratio;
1126 * presentation timestamp in time_base units (time when frame should be shown to user)
1127 * If AV_NOPTS_VALUE then frame_rate = 1/time_base will be assumed.
1128 * - encoding: MUST be set by user.
1129 * - decoding: Set by libavcodec.
1134 * reordered pts from the last AVPacket that has been input into the decoder
1135 * - encoding: unused
1136 * - decoding: Read by user.
1141 * dts from the last AVPacket that has been input into the decoder
1142 * - encoding: unused
1143 * - decoding: Read by user.
1148 * picture number in bitstream order
1149 * - encoding: set by
1150 * - decoding: Set by libavcodec.
1152 int coded_picture_number;
1154 * picture number in display order
1155 * - encoding: set by
1156 * - decoding: Set by libavcodec.
1158 int display_picture_number;
1161 * quality (between 1 (good) and FF_LAMBDA_MAX (bad))
1162 * - encoding: Set by libavcodec. for coded_picture (and set by user for input).
1163 * - decoding: Set by libavcodec.
1168 * is this picture used as reference
1169 * The values for this are the same as the MpegEncContext.picture_structure
1170 * variable, that is 1->top field, 2->bottom field, 3->frame/both fields.
1171 * Set to 4 for delayed, non-reference frames.
1172 * - encoding: unused
1173 * - decoding: Set by libavcodec. (before get_buffer() call)).
1179 * - encoding: unused
1180 * - decoding: Set by libavcodec.
1182 int8_t *qscale_table;
1185 * - encoding: unused
1186 * - decoding: Set by libavcodec.
1196 * mbskip_table[mb]>=1 if MB didn't change
1197 * stride= mb_width = (width+15)>>4
1198 * - encoding: unused
1199 * - decoding: Set by libavcodec.
1201 uint8_t *mbskip_table;
1204 * motion vector table
1207 * int mv_sample_log2= 4 - motion_subsample_log2;
1208 * int mb_width= (width+15)>>4;
1209 * int mv_stride= (mb_width << mv_sample_log2) + 1;
1210 * motion_val[direction][x + y*mv_stride][0->mv_x, 1->mv_y];
1212 * - encoding: Set by user.
1213 * - decoding: Set by libavcodec.
1215 int16_t (*motion_val[2])[2];
1218 * macroblock type table
1219 * mb_type_base + mb_width + 2
1220 * - encoding: Set by user.
1221 * - decoding: Set by libavcodec.
1227 * - encoding: unused
1228 * - decoding: Set by libavcodec.
1233 * motion reference frame index
1234 * the order in which these are stored can depend on the codec.
1235 * - encoding: Set by user.
1236 * - decoding: Set by libavcodec.
1238 int8_t *ref_index[2];
1241 * for some private data of the user
1242 * - encoding: unused
1243 * - decoding: Set by user.
1249 * - encoding: Set by libavcodec. if flags&CODEC_FLAG_PSNR.
1250 * - decoding: unused
1252 uint64_t error[AV_NUM_DATA_POINTERS];
1255 * type of the buffer (to keep track of who has to deallocate data[*])
1256 * - encoding: Set by the one who allocates it.
1257 * - decoding: Set by the one who allocates it.
1258 * Note: User allocated (direct rendering) & internal buffers cannot coexist currently.
1263 * When decoding, this signals how much the picture must be delayed.
1264 * extra_delay = repeat_pict / (2*fps)
1265 * - encoding: unused
1266 * - decoding: Set by libavcodec.
1271 * The content of the picture is interlaced.
1272 * - encoding: Set by user.
1273 * - decoding: Set by libavcodec. (default 0)
1275 int interlaced_frame;
1278 * If the content is interlaced, is top field displayed first.
1279 * - encoding: Set by user.
1280 * - decoding: Set by libavcodec.
1282 int top_field_first;
1285 * Tell user application that palette has changed from previous frame.
1286 * - encoding: ??? (no palette-enabled encoder yet)
1287 * - decoding: Set by libavcodec. (default 0).
1289 int palette_has_changed;
1292 * codec suggestion on buffer type if != 0
1293 * - encoding: unused
1294 * - decoding: Set by libavcodec. (before get_buffer() call)).
1300 * - encoding: Set by user.
1301 * - decoding: Set by libavcodec.
1303 AVPanScan *pan_scan;
1306 * reordered opaque 64bit (generally an integer or a double precision float
1307 * PTS but can be anything).
1308 * The user sets AVCodecContext.reordered_opaque to represent the input at
1310 * the decoder reorders values as needed and sets AVFrame.reordered_opaque
1311 * to exactly one of the values provided by the user through AVCodecContext.reordered_opaque
1312 * @deprecated in favor of pkt_pts
1313 * - encoding: unused
1314 * - decoding: Read by user.
1316 int64_t reordered_opaque;
1319 * hardware accelerator private data (FFmpeg-allocated)
1320 * - encoding: unused
1321 * - decoding: Set by libavcodec
1323 void *hwaccel_picture_private;
1326 * the AVCodecContext which ff_thread_get_buffer() was last called on
1327 * - encoding: Set by libavcodec.
1328 * - decoding: Set by libavcodec.
1330 struct AVCodecContext *owner;
1333 * used by multithreading to store frame-specific info
1334 * - encoding: Set by libavcodec.
1335 * - decoding: Set by libavcodec.
1337 void *thread_opaque;
1340 * log2 of the size of the block which a single vector in motion_val represents:
1341 * (4->16x16, 3->8x8, 2-> 4x4, 1-> 2x2)
1342 * - encoding: unused
1343 * - decoding: Set by libavcodec.
1345 uint8_t motion_subsample_log2;
1348 * Sample rate of the audio data.
1350 * - encoding: unused
1351 * - decoding: read by user
1356 * Channel layout of the audio data.
1358 * - encoding: unused
1359 * - decoding: read by user.
1361 uint64_t channel_layout;
1364 * frame timestamp estimated using various heuristics, in stream time base
1365 * Code outside libavcodec should access this field using:
1366 * av_frame_get_best_effort_timestamp(frame)
1367 * - encoding: unused
1368 * - decoding: set by libavcodec, read by user.
1370 int64_t best_effort_timestamp;
1373 * reordered pos from the last AVPacket that has been input into the decoder
1374 * Code outside libavcodec should access this field using:
1375 * av_frame_get_pkt_pos(frame)
1376 * - encoding: unused
1377 * - decoding: Read by user.
1382 * duration of the corresponding packet, expressed in
1383 * AVStream->time_base units, 0 if unknown.
1384 * Code outside libavcodec should access this field using:
1385 * av_frame_get_pkt_duration(frame)
1386 * - encoding: unused
1387 * - decoding: Read by user.
1389 int64_t pkt_duration;
1393 * Code outside libavcodec should access this field using:
1394 * av_frame_get_metadata(frame)
1395 * - encoding: Set by user.
1396 * - decoding: Set by libavcodec.
1398 AVDictionary *metadata;
1401 * decode error flags of the frame, set to a combination of
1402 * FF_DECODE_ERROR_xxx flags if the decoder produced a frame, but there
1403 * were errors during the decoding.
1404 * Code outside libavcodec should access this field using:
1405 * av_frame_get_decode_error_flags(frame)
1406 * - encoding: unused
1407 * - decoding: set by libavcodec, read by user.
1409 int decode_error_flags;
1410 #define FF_DECODE_ERROR_INVALID_BITSTREAM 1
1411 #define FF_DECODE_ERROR_MISSING_REFERENCE 2
1414 * number of audio channels, only used for audio.
1415 * Code outside libavcodec should access this field using:
1416 * av_frame_get_channels(frame)
1417 * - encoding: unused
1418 * - decoding: Read by user.
1424 * Accessors for some AVFrame fields.
1425 * The position of these field in the structure is not part of the ABI,
1426 * they should not be accessed directly outside libavcodec.
1428 int64_t av_frame_get_best_effort_timestamp(const AVFrame *frame);
1429 void av_frame_set_best_effort_timestamp(AVFrame *frame, int64_t val);
1430 int64_t av_frame_get_pkt_duration (const AVFrame *frame);
1431 void av_frame_set_pkt_duration (AVFrame *frame, int64_t val);
1432 int64_t av_frame_get_pkt_pos (const AVFrame *frame);
1433 void av_frame_set_pkt_pos (AVFrame *frame, int64_t val);
1434 int64_t av_frame_get_channel_layout (const AVFrame *frame);
1435 void av_frame_set_channel_layout (AVFrame *frame, int64_t val);
1436 int av_frame_get_channels (const AVFrame *frame);
1437 void av_frame_set_channels (AVFrame *frame, int val);
1438 int av_frame_get_sample_rate (const AVFrame *frame);
1439 void av_frame_set_sample_rate (AVFrame *frame, int val);
1440 AVDictionary *av_frame_get_metadata (const AVFrame *frame);
1441 void av_frame_set_metadata (AVFrame *frame, AVDictionary *val);
1442 int av_frame_get_decode_error_flags (const AVFrame *frame);
1443 void av_frame_set_decode_error_flags (AVFrame *frame, int val);
1445 struct AVCodecInternal;
1449 AV_FIELD_PROGRESSIVE,
1450 AV_FIELD_TT, //< Top coded_first, top displayed first
1451 AV_FIELD_BB, //< Bottom coded first, bottom displayed first
1452 AV_FIELD_TB, //< Top coded first, bottom displayed first
1453 AV_FIELD_BT, //< Bottom coded first, top displayed first
1457 * main external API structure.
1458 * New fields can be added to the end with minor version bumps.
1459 * Removal, reordering and changes to existing fields require a major
1461 * Please use AVOptions (av_opt* / av_set/get*()) to access these fields from user
1463 * sizeof(AVCodecContext) must not be used outside libav*.
1465 typedef struct AVCodecContext {
1467 * information on struct for av_log
1468 * - set by avcodec_alloc_context3
1470 const AVClass *av_class;
1471 int log_level_offset;
1473 enum AVMediaType codec_type; /* see AVMEDIA_TYPE_xxx */
1474 const struct AVCodec *codec;
1475 char codec_name[32];
1476 enum AVCodecID codec_id; /* see AV_CODEC_ID_xxx */
1479 * fourcc (LSB first, so "ABCD" -> ('D'<<24) + ('C'<<16) + ('B'<<8) + 'A').
1480 * This is used to work around some encoder bugs.
1481 * A demuxer should set this to what is stored in the field used to identify the codec.
1482 * If there are multiple such fields in a container then the demuxer should choose the one
1483 * which maximizes the information about the used codec.
1484 * If the codec tag field in a container is larger than 32 bits then the demuxer should
1485 * remap the longer ID to 32 bits with a table or other structure. Alternatively a new
1486 * extra_codec_tag + size could be added but for this a clear advantage must be demonstrated
1488 * - encoding: Set by user, if not then the default based on codec_id will be used.
1489 * - decoding: Set by user, will be converted to uppercase by libavcodec during init.
1491 unsigned int codec_tag;
1494 * fourcc from the AVI stream header (LSB first, so "ABCD" -> ('D'<<24) + ('C'<<16) + ('B'<<8) + 'A').
1495 * This is used to work around some encoder bugs.
1496 * - encoding: unused
1497 * - decoding: Set by user, will be converted to uppercase by libavcodec during init.
1499 unsigned int stream_codec_tag;
1503 * @deprecated this field is unused
1505 attribute_deprecated int sub_id;
1511 * Private context used for internal data.
1513 * Unlike priv_data, this is not codec-specific. It is used in general
1514 * libavcodec functions.
1516 struct AVCodecInternal *internal;
1519 * Private data of the user, can be used to carry app specific stuff.
1520 * - encoding: Set by user.
1521 * - decoding: Set by user.
1526 * the average bitrate
1527 * - encoding: Set by user; unused for constant quantizer encoding.
1528 * - decoding: Set by libavcodec. 0 or some bitrate if this info is available in the stream.
1533 * number of bits the bitstream is allowed to diverge from the reference.
1534 * the reference can be CBR (for CBR pass1) or VBR (for pass2)
1535 * - encoding: Set by user; unused for constant quantizer encoding.
1536 * - decoding: unused
1538 int bit_rate_tolerance;
1541 * Global quality for codecs which cannot change it per frame.
1542 * This should be proportional to MPEG-1/2/4 qscale.
1543 * - encoding: Set by user.
1544 * - decoding: unused
1549 * - encoding: Set by user.
1550 * - decoding: unused
1552 int compression_level;
1553 #define FF_COMPRESSION_DEFAULT -1
1557 * - encoding: Set by user.
1558 * - decoding: Set by user.
1564 * - encoding: Set by user.
1565 * - decoding: Set by user.
1570 * some codecs need / can use extradata like Huffman tables.
1571 * mjpeg: Huffman tables
1572 * rv10: additional flags
1573 * mpeg4: global headers (they can be in the bitstream or here)
1574 * The allocated memory should be FF_INPUT_BUFFER_PADDING_SIZE bytes larger
1575 * than extradata_size to avoid prolems if it is read with the bitstream reader.
1576 * The bytewise contents of extradata must not depend on the architecture or CPU endianness.
1577 * - encoding: Set/allocated/freed by libavcodec.
1578 * - decoding: Set/allocated/freed by user.
1584 * This is the fundamental unit of time (in seconds) in terms
1585 * of which frame timestamps are represented. For fixed-fps content,
1586 * timebase should be 1/framerate and timestamp increments should be
1588 * - encoding: MUST be set by user.
1589 * - decoding: Set by libavcodec.
1591 AVRational time_base;
1594 * For some codecs, the time base is closer to the field rate than the frame rate.
1595 * Most notably, H.264 and MPEG-2 specify time_base as half of frame duration
1596 * if no telecine is used ...
1598 * Set to time_base ticks per frame. Default 1, e.g., H.264/MPEG-2 set it to 2.
1600 int ticks_per_frame;
1603 * Encoding: Number of frames delay there will be from the encoder input to
1604 * the decoder output. (we assume the decoder matches the spec)
1605 * Decoding: Number of frames delay in addition to what a standard decoder
1606 * as specified in the spec would produce.
1609 * Number of frames the decoded output will be delayed relative to the
1613 * For encoding, this is the number of "priming" samples added to the
1614 * beginning of the stream. The decoded output will be delayed by this
1615 * many samples relative to the input to the encoder. Note that this
1616 * field is purely informational and does not directly affect the pts
1617 * output by the encoder, which should always be based on the actual
1618 * presentation time, including any delay.
1619 * For decoding, this is the number of samples the decoder needs to
1620 * output before the decoder's output is valid. When seeking, you should
1621 * start decoding this many samples prior to your desired seek point.
1623 * - encoding: Set by libavcodec.
1624 * - decoding: Set by libavcodec.
1631 * picture width / height.
1632 * - encoding: MUST be set by user.
1633 * - decoding: Set by libavcodec.
1634 * Note: For compatibility it is possible to set this instead of
1635 * coded_width/height before decoding.
1640 * Bitstream width / height, may be different from width/height if lowres enabled.
1641 * - encoding: unused
1642 * - decoding: Set by user before init if known. Codec should override / dynamically change if needed.
1644 int coded_width, coded_height;
1646 #define FF_ASPECT_EXTENDED 15
1649 * the number of pictures in a group of pictures, or 0 for intra_only
1650 * - encoding: Set by user.
1651 * - decoding: unused
1656 * Pixel format, see AV_PIX_FMT_xxx.
1657 * May be set by the demuxer if known from headers.
1658 * May be overridden by the decoder if it knows better.
1659 * - encoding: Set by user.
1660 * - decoding: Set by user if known, overridden by libavcodec if known
1662 enum AVPixelFormat pix_fmt;
1665 * Motion estimation algorithm used for video coding.
1666 * 1 (zero), 2 (full), 3 (log), 4 (phods), 5 (epzs), 6 (x1), 7 (hex),
1667 * 8 (umh), 9 (iter), 10 (tesa) [7, 8, 10 are x264 specific, 9 is snow specific]
1668 * - encoding: MUST be set by user.
1669 * - decoding: unused
1674 * If non NULL, 'draw_horiz_band' is called by the libavcodec
1675 * decoder to draw a horizontal band. It improves cache usage. Not
1676 * all codecs can do that. You must check the codec capabilities
1678 * When multithreading is used, it may be called from multiple threads
1679 * at the same time; threads might draw different parts of the same AVFrame,
1680 * or multiple AVFrames, and there is no guarantee that slices will be drawn
1682 * The function is also used by hardware acceleration APIs.
1683 * It is called at least once during frame decoding to pass
1684 * the data needed for hardware render.
1685 * In that mode instead of pixel data, AVFrame points to
1686 * a structure specific to the acceleration API. The application
1687 * reads the structure and can change some fields to indicate progress
1689 * - encoding: unused
1690 * - decoding: Set by user.
1691 * @param height the height of the slice
1692 * @param y the y position of the slice
1693 * @param type 1->top field, 2->bottom field, 3->frame
1694 * @param offset offset into the AVFrame.data from which the slice should be read
1696 void (*draw_horiz_band)(struct AVCodecContext *s,
1697 const AVFrame *src, int offset[AV_NUM_DATA_POINTERS],
1698 int y, int type, int height);
1701 * callback to negotiate the pixelFormat
1702 * @param fmt is the list of formats which are supported by the codec,
1703 * it is terminated by -1 as 0 is a valid format, the formats are ordered by quality.
1704 * The first is always the native one.
1705 * @return the chosen format
1706 * - encoding: unused
1707 * - decoding: Set by user, if not set the native format will be chosen.
1709 enum AVPixelFormat (*get_format)(struct AVCodecContext *s, const enum AVPixelFormat * fmt);
1712 * maximum number of B-frames between non-B-frames
1713 * Note: The output will be delayed by max_b_frames+1 relative to the input.
1714 * - encoding: Set by user.
1715 * - decoding: unused
1720 * qscale factor between IP and B-frames
1721 * If > 0 then the last P-frame quantizer will be used (q= lastp_q*factor+offset).
1722 * If < 0 then normal ratecontrol will be done (q= -normal_q*factor+offset).
1723 * - encoding: Set by user.
1724 * - decoding: unused
1726 float b_quant_factor;
1728 /** obsolete FIXME remove */
1730 #define FF_RC_STRATEGY_XVID 1
1732 int b_frame_strategy;
1734 #if FF_API_MPV_GLOBAL_OPTS
1736 * luma single coefficient elimination threshold
1737 * - encoding: Set by user.
1738 * - decoding: unused
1740 attribute_deprecated int luma_elim_threshold;
1743 * chroma single coeff elimination threshold
1744 * - encoding: Set by user.
1745 * - decoding: unused
1747 attribute_deprecated int chroma_elim_threshold;
1751 * qscale offset between IP and B-frames
1752 * - encoding: Set by user.
1753 * - decoding: unused
1755 float b_quant_offset;
1758 * Size of the frame reordering buffer in the decoder.
1759 * For MPEG-2 it is 1 IPB or 0 low delay IP.
1760 * - encoding: Set by libavcodec.
1761 * - decoding: Set by libavcodec.
1766 * 0-> h263 quant 1-> mpeg quant
1767 * - encoding: Set by user.
1768 * - decoding: unused
1773 * qscale factor between P and I-frames
1774 * If > 0 then the last p frame quantizer will be used (q= lastp_q*factor+offset).
1775 * If < 0 then normal ratecontrol will be done (q= -normal_q*factor+offset).
1776 * - encoding: Set by user.
1777 * - decoding: unused
1779 float i_quant_factor;
1782 * qscale offset between P and I-frames
1783 * - encoding: Set by user.
1784 * - decoding: unused
1786 float i_quant_offset;
1789 * luminance masking (0-> disabled)
1790 * - encoding: Set by user.
1791 * - decoding: unused
1796 * temporary complexity masking (0-> disabled)
1797 * - encoding: Set by user.
1798 * - decoding: unused
1800 float temporal_cplx_masking;
1803 * spatial complexity masking (0-> disabled)
1804 * - encoding: Set by user.
1805 * - decoding: unused
1807 float spatial_cplx_masking;
1810 * p block masking (0-> disabled)
1811 * - encoding: Set by user.
1812 * - decoding: unused
1817 * darkness masking (0-> disabled)
1818 * - encoding: Set by user.
1819 * - decoding: unused
1825 * - encoding: Set by libavcodec.
1826 * - decoding: Set by user (or 0).
1830 * prediction method (needed for huffyuv)
1831 * - encoding: Set by user.
1832 * - decoding: unused
1834 int prediction_method;
1835 #define FF_PRED_LEFT 0
1836 #define FF_PRED_PLANE 1
1837 #define FF_PRED_MEDIAN 2
1840 * slice offsets in the frame in bytes
1841 * - encoding: Set/allocated by libavcodec.
1842 * - decoding: Set/allocated by user (or NULL).
1847 * sample aspect ratio (0 if unknown)
1848 * That is the width of a pixel divided by the height of the pixel.
1849 * Numerator and denominator must be relatively prime and smaller than 256 for some video standards.
1850 * - encoding: Set by user.
1851 * - decoding: Set by libavcodec.
1853 AVRational sample_aspect_ratio;
1856 * motion estimation comparison function
1857 * - encoding: Set by user.
1858 * - decoding: unused
1862 * subpixel motion estimation comparison function
1863 * - encoding: Set by user.
1864 * - decoding: unused
1868 * macroblock comparison function (not supported yet)
1869 * - encoding: Set by user.
1870 * - decoding: unused
1874 * interlaced DCT comparison function
1875 * - encoding: Set by user.
1876 * - decoding: unused
1879 #define FF_CMP_SAD 0
1880 #define FF_CMP_SSE 1
1881 #define FF_CMP_SATD 2
1882 #define FF_CMP_DCT 3
1883 #define FF_CMP_PSNR 4
1884 #define FF_CMP_BIT 5
1886 #define FF_CMP_ZERO 7
1887 #define FF_CMP_VSAD 8
1888 #define FF_CMP_VSSE 9
1889 #define FF_CMP_NSSE 10
1890 #define FF_CMP_W53 11
1891 #define FF_CMP_W97 12
1892 #define FF_CMP_DCTMAX 13
1893 #define FF_CMP_DCT264 14
1894 #define FF_CMP_CHROMA 256
1897 * ME diamond size & shape
1898 * - encoding: Set by user.
1899 * - decoding: unused
1904 * amount of previous MV predictors (2a+1 x 2a+1 square)
1905 * - encoding: Set by user.
1906 * - decoding: unused
1908 int last_predictor_count;
1911 * prepass for motion estimation
1912 * - encoding: Set by user.
1913 * - decoding: unused
1918 * motion estimation prepass comparison function
1919 * - encoding: Set by user.
1920 * - decoding: unused
1925 * ME prepass diamond size & shape
1926 * - encoding: Set by user.
1927 * - decoding: unused
1933 * - encoding: Set by user.
1934 * - decoding: unused
1936 int me_subpel_quality;
1939 * DTG active format information (additional aspect ratio
1940 * information only used in DVB MPEG-2 transport streams)
1943 * - encoding: unused
1944 * - decoding: Set by decoder.
1946 int dtg_active_format;
1947 #define FF_DTG_AFD_SAME 8
1948 #define FF_DTG_AFD_4_3 9
1949 #define FF_DTG_AFD_16_9 10
1950 #define FF_DTG_AFD_14_9 11
1951 #define FF_DTG_AFD_4_3_SP_14_9 13
1952 #define FF_DTG_AFD_16_9_SP_14_9 14
1953 #define FF_DTG_AFD_SP_4_3 15
1956 * maximum motion estimation search range in subpel units
1957 * If 0 then no limit.
1959 * - encoding: Set by user.
1960 * - decoding: unused
1965 * intra quantizer bias
1966 * - encoding: Set by user.
1967 * - decoding: unused
1969 int intra_quant_bias;
1970 #define FF_DEFAULT_QUANT_BIAS 999999
1973 * inter quantizer bias
1974 * - encoding: Set by user.
1975 * - decoding: unused
1977 int inter_quant_bias;
1979 #if FF_API_COLOR_TABLE_ID
1982 * - encoding: unused
1983 * - decoding: Which clrtable should be used for 8bit RGB images.
1984 * Tables have to be stored somewhere. FIXME
1986 attribute_deprecated int color_table_id;
1991 * - encoding: unused
1992 * - decoding: Set by user.
1995 #define SLICE_FLAG_CODED_ORDER 0x0001 ///< draw_horiz_band() is called in coded order instead of display
1996 #define SLICE_FLAG_ALLOW_FIELD 0x0002 ///< allow draw_horiz_band() with field slices (MPEG2 field pics)
1997 #define SLICE_FLAG_ALLOW_PLANE 0x0004 ///< allow draw_horiz_band() with 1 component at a time (SVQ1)
2000 * XVideo Motion Acceleration
2001 * - encoding: forbidden
2002 * - decoding: set by decoder
2004 int xvmc_acceleration;
2007 * macroblock decision mode
2008 * - encoding: Set by user.
2009 * - decoding: unused
2012 #define FF_MB_DECISION_SIMPLE 0 ///< uses mb_cmp
2013 #define FF_MB_DECISION_BITS 1 ///< chooses the one which needs the fewest bits
2014 #define FF_MB_DECISION_RD 2 ///< rate distortion
2017 * custom intra quantization matrix
2018 * - encoding: Set by user, can be NULL.
2019 * - decoding: Set by libavcodec.
2021 uint16_t *intra_matrix;
2024 * custom inter quantization matrix
2025 * - encoding: Set by user, can be NULL.
2026 * - decoding: Set by libavcodec.
2028 uint16_t *inter_matrix;
2031 * scene change detection threshold
2032 * 0 is default, larger means fewer detected scene changes.
2033 * - encoding: Set by user.
2034 * - decoding: unused
2036 int scenechange_threshold;
2039 * noise reduction strength
2040 * - encoding: Set by user.
2041 * - decoding: unused
2043 int noise_reduction;
2045 #if FF_API_INTER_THRESHOLD
2047 * @deprecated this field is unused
2049 attribute_deprecated int inter_threshold;
2052 #if FF_API_MPV_GLOBAL_OPTS
2054 * @deprecated use mpegvideo private options instead
2056 attribute_deprecated int quantizer_noise_shaping;
2060 * Motion estimation threshold below which no motion estimation is
2061 * performed, but instead the user specified motion vectors are used.
2063 * - encoding: Set by user.
2064 * - decoding: unused
2069 * Macroblock threshold below which the user specified macroblock types will be used.
2070 * - encoding: Set by user.
2071 * - decoding: unused
2076 * precision of the intra DC coefficient - 8
2077 * - encoding: Set by user.
2078 * - decoding: unused
2080 int intra_dc_precision;
2083 * Number of macroblock rows at the top which are skipped.
2084 * - encoding: unused
2085 * - decoding: Set by user.
2090 * Number of macroblock rows at the bottom which are skipped.
2091 * - encoding: unused
2092 * - decoding: Set by user.
2097 * Border processing masking, raises the quantizer for mbs on the borders
2099 * - encoding: Set by user.
2100 * - decoding: unused
2102 float border_masking;
2105 * minimum MB lagrange multipler
2106 * - encoding: Set by user.
2107 * - decoding: unused
2112 * maximum MB lagrange multipler
2113 * - encoding: Set by user.
2114 * - decoding: unused
2120 * - encoding: Set by user.
2121 * - decoding: unused
2123 int me_penalty_compensation;
2127 * - encoding: Set by user.
2128 * - decoding: unused
2134 * - encoding: Set by user.
2135 * - decoding: unused
2141 * - encoding: Set by user.
2142 * - decoding: unused
2147 * number of reference frames
2148 * - encoding: Set by user.
2149 * - decoding: Set by lavc.
2154 * chroma qp offset from luma
2155 * - encoding: Set by user.
2156 * - decoding: unused
2161 * Multiplied by qscale for each frame and added to scene_change_score.
2162 * - encoding: Set by user.
2163 * - decoding: unused
2165 int scenechange_factor;
2169 * Note: Value depends upon the compare function used for fullpel ME.
2170 * - encoding: Set by user.
2171 * - decoding: unused
2176 * Adjust sensitivity of b_frame_strategy 1.
2177 * - encoding: Set by user.
2178 * - decoding: unused
2183 * Chromaticity coordinates of the source primaries.
2184 * - encoding: Set by user
2185 * - decoding: Set by libavcodec
2187 enum AVColorPrimaries color_primaries;
2190 * Color Transfer Characteristic.
2191 * - encoding: Set by user
2192 * - decoding: Set by libavcodec
2194 enum AVColorTransferCharacteristic color_trc;
2197 * YUV colorspace type.
2198 * - encoding: Set by user
2199 * - decoding: Set by libavcodec
2201 enum AVColorSpace colorspace;
2204 * MPEG vs JPEG YUV range.
2205 * - encoding: Set by user
2206 * - decoding: Set by libavcodec
2208 enum AVColorRange color_range;
2211 * This defines the location of chroma samples.
2212 * - encoding: Set by user
2213 * - decoding: Set by libavcodec
2215 enum AVChromaLocation chroma_sample_location;
2219 * Indicates number of picture subdivisions. Used for parallelized
2221 * - encoding: Set by user
2222 * - decoding: unused
2227 * - encoding: set by libavcodec
2228 * - decoding: Set by libavcodec
2230 enum AVFieldOrder field_order;
2233 int sample_rate; ///< samples per second
2234 int channels; ///< number of audio channels
2237 * audio sample format
2238 * - encoding: Set by user.
2239 * - decoding: Set by libavcodec.
2241 enum AVSampleFormat sample_fmt; ///< sample format
2243 /* The following data should not be initialized. */
2245 * Samples per packet, initialized when calling 'init'.
2250 * Frame counter, set by libavcodec.
2252 * - decoding: total number of frames returned from the decoder so far.
2253 * - encoding: total number of frames passed to the encoder so far.
2255 * @note the counter is not incremented if encoding/decoding resulted in
2261 * number of bytes per packet if constant and known or 0
2262 * Used by some WAV based audio codecs.
2267 * Audio cutoff bandwidth (0 means "automatic")
2268 * - encoding: Set by user.
2269 * - decoding: unused
2273 #if FF_API_REQUEST_CHANNELS
2275 * Decoder should decode to this many channels if it can (0 for default)
2276 * - encoding: unused
2277 * - decoding: Set by user.
2278 * @deprecated Deprecated in favor of request_channel_layout.
2280 int request_channels;
2284 * Audio channel layout.
2285 * - encoding: set by user.
2286 * - decoding: set by user, may be overwritten by libavcodec.
2288 uint64_t channel_layout;
2291 * Request decoder to use this channel layout if it can (0 for default)
2292 * - encoding: unused
2293 * - decoding: Set by user.
2295 uint64_t request_channel_layout;
2298 * Type of service that the audio stream conveys.
2299 * - encoding: Set by user.
2300 * - decoding: Set by libavcodec.
2302 enum AVAudioServiceType audio_service_type;
2305 * desired sample format
2306 * - encoding: Not used.
2307 * - decoding: Set by user.
2308 * Decoder will decode to this format if it can.
2310 enum AVSampleFormat request_sample_fmt;
2313 * Called at the beginning of each frame to get a buffer for it.
2315 * The function will set AVFrame.data[], AVFrame.linesize[].
2316 * AVFrame.extended_data[] must also be set, but it should be the same as
2317 * AVFrame.data[] except for planar audio with more channels than can fit
2318 * in AVFrame.data[]. In that case, AVFrame.data[] shall still contain as
2319 * many data pointers as it can hold.
2321 * if CODEC_CAP_DR1 is not set then get_buffer() must call
2322 * avcodec_default_get_buffer() instead of providing buffers allocated by
2325 * AVFrame.data[] should be 32- or 16-byte-aligned unless the CPU doesn't
2326 * need it. avcodec_default_get_buffer() aligns the output buffer properly,
2327 * but if get_buffer() is overridden then alignment considerations should
2328 * be taken into account.
2330 * @see avcodec_default_get_buffer()
2334 * If pic.reference is set then the frame will be read later by libavcodec.
2335 * avcodec_align_dimensions2() should be used to find the required width and
2336 * height, as they normally need to be rounded up to the next multiple of 16.
2338 * If frame multithreading is used and thread_safe_callbacks is set,
2339 * it may be called from a different thread, but not from more than one at
2340 * once. Does not need to be reentrant.
2342 * @see release_buffer(), reget_buffer()
2343 * @see avcodec_align_dimensions2()
2347 * Decoders request a buffer of a particular size by setting
2348 * AVFrame.nb_samples prior to calling get_buffer(). The decoder may,
2349 * however, utilize only part of the buffer by setting AVFrame.nb_samples
2350 * to a smaller value in the output frame.
2352 * Decoders cannot use the buffer after returning from
2353 * avcodec_decode_audio4(), so they will not call release_buffer(), as it
2354 * is assumed to be released immediately upon return.
2356 * As a convenience, av_samples_get_buffer_size() and
2357 * av_samples_fill_arrays() in libavutil may be used by custom get_buffer()
2358 * functions to find the required data size and to fill data pointers and
2359 * linesize. In AVFrame.linesize, only linesize[0] may be set for audio
2360 * since all planes must be the same size.
2362 * @see av_samples_get_buffer_size(), av_samples_fill_arrays()
2364 * - encoding: unused
2365 * - decoding: Set by libavcodec, user can override.
2367 int (*get_buffer)(struct AVCodecContext *c, AVFrame *pic);
2370 * Called to release buffers which were allocated with get_buffer.
2371 * A released buffer can be reused in get_buffer().
2372 * pic.data[*] must be set to NULL.
2373 * May be called from a different thread if frame multithreading is used,
2374 * but not by more than one thread at once, so does not need to be reentrant.
2375 * - encoding: unused
2376 * - decoding: Set by libavcodec, user can override.
2378 void (*release_buffer)(struct AVCodecContext *c, AVFrame *pic);
2381 * Called at the beginning of a frame to get cr buffer for it.
2382 * Buffer type (size, hints) must be the same. libavcodec won't check it.
2383 * libavcodec will pass previous buffer in pic, function should return
2384 * same buffer or new buffer with old frame "painted" into it.
2385 * If pic.data[0] == NULL must behave like get_buffer().
2386 * if CODEC_CAP_DR1 is not set then reget_buffer() must call
2387 * avcodec_default_reget_buffer() instead of providing buffers allocated by
2389 * - encoding: unused
2390 * - decoding: Set by libavcodec, user can override.
2392 int (*reget_buffer)(struct AVCodecContext *c, AVFrame *pic);
2395 /* - encoding parameters */
2396 float qcompress; ///< amount of qscale change between easy & hard scenes (0.0-1.0)
2397 float qblur; ///< amount of qscale smoothing over time (0.0-1.0)
2401 * - encoding: Set by user.
2402 * - decoding: unused
2408 * - encoding: Set by user.
2409 * - decoding: unused
2414 * maximum quantizer difference between frames
2415 * - encoding: Set by user.
2416 * - decoding: unused
2421 * ratecontrol qmin qmax limiting method
2422 * 0-> clipping, 1-> use a nice continuous function to limit qscale wthin qmin/qmax.
2423 * - encoding: Set by user.
2424 * - decoding: unused
2432 * decoder bitstream buffer size
2433 * - encoding: Set by user.
2434 * - decoding: unused
2439 * ratecontrol override, see RcOverride
2440 * - encoding: Allocated/set/freed by user.
2441 * - decoding: unused
2443 int rc_override_count;
2444 RcOverride *rc_override;
2447 * rate control equation
2448 * - encoding: Set by user
2449 * - decoding: unused
2455 * - encoding: Set by user.
2456 * - decoding: unused
2462 * - encoding: Set by user.
2463 * - decoding: unused
2467 float rc_buffer_aggressivity;
2470 * initial complexity for pass1 ratecontrol
2471 * - encoding: Set by user.
2472 * - decoding: unused
2474 float rc_initial_cplx;
2477 * Ratecontrol attempt to use, at maximum, <value> of what can be used without an underflow.
2478 * - encoding: Set by user.
2479 * - decoding: unused.
2481 float rc_max_available_vbv_use;
2484 * Ratecontrol attempt to use, at least, <value> times the amount needed to prevent a vbv overflow.
2485 * - encoding: Set by user.
2486 * - decoding: unused.
2488 float rc_min_vbv_overflow_use;
2491 * Number of bits which should be loaded into the rc buffer before decoding starts.
2492 * - encoding: Set by user.
2493 * - decoding: unused
2495 int rc_initial_buffer_occupancy;
2497 #define FF_CODER_TYPE_VLC 0
2498 #define FF_CODER_TYPE_AC 1
2499 #define FF_CODER_TYPE_RAW 2
2500 #define FF_CODER_TYPE_RLE 3
2501 #define FF_CODER_TYPE_DEFLATE 4
2504 * - encoding: Set by user.
2505 * - decoding: unused
2511 * - encoding: Set by user.
2512 * - decoding: unused
2517 * minimum Lagrange multipler
2518 * - encoding: Set by user.
2519 * - decoding: unused
2524 * maximum Lagrange multipler
2525 * - encoding: Set by user.
2526 * - decoding: unused
2531 * frame skip threshold
2532 * - encoding: Set by user.
2533 * - decoding: unused
2535 int frame_skip_threshold;
2539 * - encoding: Set by user.
2540 * - decoding: unused
2542 int frame_skip_factor;
2545 * frame skip exponent
2546 * - encoding: Set by user.
2547 * - decoding: unused
2552 * frame skip comparison function
2553 * - encoding: Set by user.
2554 * - decoding: unused
2559 * trellis RD quantization
2560 * - encoding: Set by user.
2561 * - decoding: unused
2566 * - encoding: Set by user.
2567 * - decoding: unused
2569 int min_prediction_order;
2572 * - encoding: Set by user.
2573 * - decoding: unused
2575 int max_prediction_order;
2578 * GOP timecode frame start number
2579 * - encoding: Set by user, in non drop frame format
2580 * - decoding: Set by libavcodec (timecode in the 25 bits format, -1 if unset)
2582 int64_t timecode_frame_start;
2584 /* The RTP callback: This function is called */
2585 /* every time the encoder has a packet to send. */
2586 /* It depends on the encoder if the data starts */
2587 /* with a Start Code (it should). H.263 does. */
2588 /* mb_nb contains the number of macroblocks */
2589 /* encoded in the RTP payload. */
2590 void (*rtp_callback)(struct AVCodecContext *avctx, void *data, int size, int mb_nb);
2592 int rtp_payload_size; /* The size of the RTP payload: the coder will */
2593 /* do its best to deliver a chunk with size */
2594 /* below rtp_payload_size, the chunk will start */
2595 /* with a start code on some codecs like H.263. */
2596 /* This doesn't take account of any particular */
2597 /* headers inside the transmitted RTP payload. */
2599 /* statistics, used for 2-pass encoding */
2610 * number of bits used for the previously encoded frame
2611 * - encoding: Set by libavcodec.
2612 * - decoding: unused
2617 * pass1 encoding statistics output buffer
2618 * - encoding: Set by libavcodec.
2619 * - decoding: unused
2624 * pass2 encoding statistics input buffer
2625 * Concatenated stuff from stats_out of pass1 should be placed here.
2626 * - encoding: Allocated/set/freed by user.
2627 * - decoding: unused
2632 * Work around bugs in encoders which sometimes cannot be detected automatically.
2633 * - encoding: Set by user
2634 * - decoding: Set by user
2636 int workaround_bugs;
2637 #define FF_BUG_AUTODETECT 1 ///< autodetection
2638 #define FF_BUG_OLD_MSMPEG4 2
2639 #define FF_BUG_XVID_ILACE 4
2640 #define FF_BUG_UMP4 8
2641 #define FF_BUG_NO_PADDING 16
2642 #define FF_BUG_AMV 32
2643 #define FF_BUG_AC_VLC 0 ///< Will be removed, libavcodec can now handle these non-compliant files by default.
2644 #define FF_BUG_QPEL_CHROMA 64
2645 #define FF_BUG_STD_QPEL 128
2646 #define FF_BUG_QPEL_CHROMA2 256
2647 #define FF_BUG_DIRECT_BLOCKSIZE 512
2648 #define FF_BUG_EDGE 1024
2649 #define FF_BUG_HPEL_CHROMA 2048
2650 #define FF_BUG_DC_CLIP 4096
2651 #define FF_BUG_MS 8192 ///< Work around various bugs in Microsoft's broken decoders.
2652 #define FF_BUG_TRUNCATED 16384
2655 * strictly follow the standard (MPEG4, ...).
2656 * - encoding: Set by user.
2657 * - decoding: Set by user.
2658 * Setting this to STRICT or higher means the encoder and decoder will
2659 * generally do stupid things, whereas setting it to unofficial or lower
2660 * will mean the encoder might produce output that is not supported by all
2661 * spec-compliant decoders. Decoders don't differentiate between normal,
2662 * unofficial and experimental (that is, they always try to decode things
2663 * when they can) unless they are explicitly asked to behave stupidly
2664 * (=strictly conform to the specs)
2666 int strict_std_compliance;
2667 #define FF_COMPLIANCE_VERY_STRICT 2 ///< Strictly conform to an older more strict version of the spec or reference software.
2668 #define FF_COMPLIANCE_STRICT 1 ///< Strictly conform to all the things in the spec no matter what consequences.
2669 #define FF_COMPLIANCE_NORMAL 0
2670 #define FF_COMPLIANCE_UNOFFICIAL -1 ///< Allow unofficial extensions
2671 #define FF_COMPLIANCE_EXPERIMENTAL -2 ///< Allow nonstandardized experimental things.
2674 * error concealment flags
2675 * - encoding: unused
2676 * - decoding: Set by user.
2678 int error_concealment;
2679 #define FF_EC_GUESS_MVS 1
2680 #define FF_EC_DEBLOCK 2
2684 * - encoding: Set by user.
2685 * - decoding: Set by user.
2688 #define FF_DEBUG_PICT_INFO 1
2689 #define FF_DEBUG_RC 2
2690 #define FF_DEBUG_BITSTREAM 4
2691 #define FF_DEBUG_MB_TYPE 8
2692 #define FF_DEBUG_QP 16
2693 #define FF_DEBUG_MV 32
2694 #define FF_DEBUG_DCT_COEFF 0x00000040
2695 #define FF_DEBUG_SKIP 0x00000080
2696 #define FF_DEBUG_STARTCODE 0x00000100
2697 #define FF_DEBUG_PTS 0x00000200
2698 #define FF_DEBUG_ER 0x00000400
2699 #define FF_DEBUG_MMCO 0x00000800
2700 #define FF_DEBUG_BUGS 0x00001000
2701 #define FF_DEBUG_VIS_QP 0x00002000
2702 #define FF_DEBUG_VIS_MB_TYPE 0x00004000
2703 #define FF_DEBUG_BUFFERS 0x00008000
2704 #define FF_DEBUG_THREADS 0x00010000
2708 * - encoding: Set by user.
2709 * - decoding: Set by user.
2712 #define FF_DEBUG_VIS_MV_P_FOR 0x00000001 //visualize forward predicted MVs of P frames
2713 #define FF_DEBUG_VIS_MV_B_FOR 0x00000002 //visualize forward predicted MVs of B frames
2714 #define FF_DEBUG_VIS_MV_B_BACK 0x00000004 //visualize backward predicted MVs of B frames
2717 * Error recognition; may misdetect some more or less valid parts as errors.
2718 * - encoding: unused
2719 * - decoding: Set by user.
2721 int err_recognition;
2722 #define AV_EF_CRCCHECK (1<<0)
2723 #define AV_EF_BITSTREAM (1<<1)
2724 #define AV_EF_BUFFER (1<<2)
2725 #define AV_EF_EXPLODE (1<<3)
2727 #define AV_EF_CAREFUL (1<<16)
2728 #define AV_EF_COMPLIANT (1<<17)
2729 #define AV_EF_AGGRESSIVE (1<<18)
2733 * opaque 64bit number (generally a PTS) that will be reordered and
2734 * output in AVFrame.reordered_opaque
2735 * @deprecated in favor of pkt_pts
2736 * - encoding: unused
2737 * - decoding: Set by user.
2739 int64_t reordered_opaque;
2742 * Hardware accelerator in use
2743 * - encoding: unused.
2744 * - decoding: Set by libavcodec
2746 struct AVHWAccel *hwaccel;
2749 * Hardware accelerator context.
2750 * For some hardware accelerators, a global context needs to be
2751 * provided by the user. In that case, this holds display-dependent
2752 * data FFmpeg cannot instantiate itself. Please refer to the
2753 * FFmpeg HW accelerator documentation to know how to fill this
2754 * is. e.g. for VA API, this is a struct vaapi_context.
2755 * - encoding: unused
2756 * - decoding: Set by user
2758 void *hwaccel_context;
2762 * - encoding: Set by libavcodec if flags&CODEC_FLAG_PSNR.
2763 * - decoding: unused
2765 uint64_t error[AV_NUM_DATA_POINTERS];
2768 * DCT algorithm, see FF_DCT_* below
2769 * - encoding: Set by user.
2770 * - decoding: unused
2773 #define FF_DCT_AUTO 0
2774 #define FF_DCT_FASTINT 1
2775 #define FF_DCT_INT 2
2776 #define FF_DCT_MMX 3
2777 #define FF_DCT_ALTIVEC 5
2778 #define FF_DCT_FAAN 6
2781 * IDCT algorithm, see FF_IDCT_* below.
2782 * - encoding: Set by user.
2783 * - decoding: Set by user.
2786 #define FF_IDCT_AUTO 0
2787 #define FF_IDCT_INT 1
2788 #define FF_IDCT_SIMPLE 2
2789 #define FF_IDCT_SIMPLEMMX 3
2790 #define FF_IDCT_LIBMPEG2MMX 4
2791 #define FF_IDCT_MMI 5
2792 #define FF_IDCT_ARM 7
2793 #define FF_IDCT_ALTIVEC 8
2794 #define FF_IDCT_SH4 9
2795 #define FF_IDCT_SIMPLEARM 10
2796 #define FF_IDCT_H264 11
2797 #define FF_IDCT_VP3 12
2798 #define FF_IDCT_IPP 13
2799 #define FF_IDCT_XVIDMMX 14
2800 #define FF_IDCT_CAVS 15
2801 #define FF_IDCT_SIMPLEARMV5TE 16
2802 #define FF_IDCT_SIMPLEARMV6 17
2803 #define FF_IDCT_SIMPLEVIS 18
2804 #define FF_IDCT_WMV2 19
2805 #define FF_IDCT_FAAN 20
2806 #define FF_IDCT_EA 21
2807 #define FF_IDCT_SIMPLENEON 22
2808 #define FF_IDCT_SIMPLEALPHA 23
2809 #define FF_IDCT_BINK 24
2814 * @deprecated use av_set_cpu_flags_mask() instead.
2816 attribute_deprecated unsigned dsp_mask;
2820 * bits per sample/pixel from the demuxer (needed for huffyuv).
2821 * - encoding: Set by libavcodec.
2822 * - decoding: Set by user.
2824 int bits_per_coded_sample;
2827 * Bits per sample/pixel of internal libavcodec pixel/sample format.
2828 * - encoding: set by user.
2829 * - decoding: set by libavcodec.
2831 int bits_per_raw_sample;
2834 * low resolution decoding, 1-> 1/2 size, 2->1/4 size
2835 * - encoding: unused
2836 * - decoding: Set by user.
2841 * the picture in the bitstream
2842 * - encoding: Set by libavcodec.
2843 * - decoding: Set by libavcodec.
2845 AVFrame *coded_frame;
2849 * is used to decide how many independent tasks should be passed to execute()
2850 * - encoding: Set by user.
2851 * - decoding: Set by user.
2856 * Which multithreading methods to use.
2857 * Use of FF_THREAD_FRAME will increase decoding delay by one frame per thread,
2858 * so clients which cannot provide future frames should not use it.
2860 * - encoding: Set by user, otherwise the default is used.
2861 * - decoding: Set by user, otherwise the default is used.
2864 #define FF_THREAD_FRAME 1 ///< Decode more than one frame at once
2865 #define FF_THREAD_SLICE 2 ///< Decode more than one part of a single frame at once
2868 * Which multithreading methods are in use by the codec.
2869 * - encoding: Set by libavcodec.
2870 * - decoding: Set by libavcodec.
2872 int active_thread_type;
2875 * Set by the client if its custom get_buffer() callback can be called
2876 * synchronously from another thread, which allows faster multithreaded decoding.
2877 * draw_horiz_band() will be called from other threads regardless of this setting.
2878 * Ignored if the default get_buffer() is used.
2879 * - encoding: Set by user.
2880 * - decoding: Set by user.
2882 int thread_safe_callbacks;
2885 * The codec may call this to execute several independent things.
2886 * It will return only after finishing all tasks.
2887 * The user may replace this with some multithreaded implementation,
2888 * the default implementation will execute the parts serially.
2889 * @param count the number of things to execute
2890 * - encoding: Set by libavcodec, user can override.
2891 * - decoding: Set by libavcodec, user can override.
2893 int (*execute)(struct AVCodecContext *c, int (*func)(struct AVCodecContext *c2, void *arg), void *arg2, int *ret, int count, int size);
2896 * The codec may call this to execute several independent things.
2897 * It will return only after finishing all tasks.
2898 * The user may replace this with some multithreaded implementation,
2899 * the default implementation will execute the parts serially.
2900 * Also see avcodec_thread_init and e.g. the --enable-pthread configure option.
2901 * @param c context passed also to func
2902 * @param count the number of things to execute
2903 * @param arg2 argument passed unchanged to func
2904 * @param ret return values of executed functions, must have space for "count" values. May be NULL.
2905 * @param func function that will be called count times, with jobnr from 0 to count-1.
2906 * threadnr will be in the range 0 to c->thread_count-1 < MAX_THREADS and so that no
2907 * two instances of func executing at the same time will have the same threadnr.
2908 * @return always 0 currently, but code should handle a future improvement where when any call to func
2909 * returns < 0 no further calls to func may be done and < 0 is returned.
2910 * - encoding: Set by libavcodec, user can override.
2911 * - decoding: Set by libavcodec, user can override.
2913 int (*execute2)(struct AVCodecContext *c, int (*func)(struct AVCodecContext *c2, void *arg, int jobnr, int threadnr), void *arg2, int *ret, int count);
2917 * Can be used by execute() to store some per AVCodecContext stuff.
2918 * - encoding: set by execute()
2919 * - decoding: set by execute()
2921 void *thread_opaque;
2924 * noise vs. sse weight for the nsse comparsion function
2925 * - encoding: Set by user.
2926 * - decoding: unused
2932 * - encoding: Set by user.
2933 * - decoding: Set by libavcodec.
2936 #define FF_PROFILE_UNKNOWN -99
2937 #define FF_PROFILE_RESERVED -100
2939 #define FF_PROFILE_AAC_MAIN 0
2940 #define FF_PROFILE_AAC_LOW 1
2941 #define FF_PROFILE_AAC_SSR 2
2942 #define FF_PROFILE_AAC_LTP 3
2943 #define FF_PROFILE_AAC_HE 4
2944 #define FF_PROFILE_AAC_HE_V2 28
2945 #define FF_PROFILE_AAC_LD 22
2946 #define FF_PROFILE_AAC_ELD 38
2948 #define FF_PROFILE_DTS 20
2949 #define FF_PROFILE_DTS_ES 30
2950 #define FF_PROFILE_DTS_96_24 40
2951 #define FF_PROFILE_DTS_HD_HRA 50
2952 #define FF_PROFILE_DTS_HD_MA 60
2954 #define FF_PROFILE_MPEG2_422 0
2955 #define FF_PROFILE_MPEG2_HIGH 1
2956 #define FF_PROFILE_MPEG2_SS 2
2957 #define FF_PROFILE_MPEG2_SNR_SCALABLE 3
2958 #define FF_PROFILE_MPEG2_MAIN 4
2959 #define FF_PROFILE_MPEG2_SIMPLE 5
2961 #define FF_PROFILE_H264_CONSTRAINED (1<<9) // 8+1; constraint_set1_flag
2962 #define FF_PROFILE_H264_INTRA (1<<11) // 8+3; constraint_set3_flag
2964 #define FF_PROFILE_H264_BASELINE 66
2965 #define FF_PROFILE_H264_CONSTRAINED_BASELINE (66|FF_PROFILE_H264_CONSTRAINED)
2966 #define FF_PROFILE_H264_MAIN 77
2967 #define FF_PROFILE_H264_EXTENDED 88
2968 #define FF_PROFILE_H264_HIGH 100
2969 #define FF_PROFILE_H264_HIGH_10 110
2970 #define FF_PROFILE_H264_HIGH_10_INTRA (110|FF_PROFILE_H264_INTRA)
2971 #define FF_PROFILE_H264_HIGH_422 122
2972 #define FF_PROFILE_H264_HIGH_422_INTRA (122|FF_PROFILE_H264_INTRA)
2973 #define FF_PROFILE_H264_HIGH_444 144
2974 #define FF_PROFILE_H264_HIGH_444_PREDICTIVE 244
2975 #define FF_PROFILE_H264_HIGH_444_INTRA (244|FF_PROFILE_H264_INTRA)
2976 #define FF_PROFILE_H264_CAVLC_444 44
2978 #define FF_PROFILE_VC1_SIMPLE 0
2979 #define FF_PROFILE_VC1_MAIN 1
2980 #define FF_PROFILE_VC1_COMPLEX 2
2981 #define FF_PROFILE_VC1_ADVANCED 3
2983 #define FF_PROFILE_MPEG4_SIMPLE 0
2984 #define FF_PROFILE_MPEG4_SIMPLE_SCALABLE 1
2985 #define FF_PROFILE_MPEG4_CORE 2
2986 #define FF_PROFILE_MPEG4_MAIN 3
2987 #define FF_PROFILE_MPEG4_N_BIT 4
2988 #define FF_PROFILE_MPEG4_SCALABLE_TEXTURE 5
2989 #define FF_PROFILE_MPEG4_SIMPLE_FACE_ANIMATION 6
2990 #define FF_PROFILE_MPEG4_BASIC_ANIMATED_TEXTURE 7
2991 #define FF_PROFILE_MPEG4_HYBRID 8
2992 #define FF_PROFILE_MPEG4_ADVANCED_REAL_TIME 9
2993 #define FF_PROFILE_MPEG4_CORE_SCALABLE 10
2994 #define FF_PROFILE_MPEG4_ADVANCED_CODING 11
2995 #define FF_PROFILE_MPEG4_ADVANCED_CORE 12
2996 #define FF_PROFILE_MPEG4_ADVANCED_SCALABLE_TEXTURE 13
2997 #define FF_PROFILE_MPEG4_SIMPLE_STUDIO 14
2998 #define FF_PROFILE_MPEG4_ADVANCED_SIMPLE 15
3002 * - encoding: Set by user.
3003 * - decoding: Set by libavcodec.
3006 #define FF_LEVEL_UNKNOWN -99
3010 * - encoding: unused
3011 * - decoding: Set by user.
3013 enum AVDiscard skip_loop_filter;
3017 * - encoding: unused
3018 * - decoding: Set by user.
3020 enum AVDiscard skip_idct;
3024 * - encoding: unused
3025 * - decoding: Set by user.
3027 enum AVDiscard skip_frame;
3030 * Header containing style information for text subtitles.
3031 * For SUBTITLE_ASS subtitle type, it should contain the whole ASS
3032 * [Script Info] and [V4+ Styles] section, plus the [Events] line and
3033 * the Format line following. It shouldn't include any Dialogue line.
3034 * - encoding: Set/allocated/freed by user (before avcodec_open2())
3035 * - decoding: Set/allocated/freed by libavcodec (by avcodec_open2())
3037 uint8_t *subtitle_header;
3038 int subtitle_header_size;
3041 * Simulates errors in the bitstream to test error concealment.
3042 * - encoding: Set by user.
3043 * - decoding: unused
3048 * Current packet as passed into the decoder, to avoid having
3049 * to pass the packet into every function. Currently only valid
3050 * inside lavc and get/release_buffer callbacks.
3051 * - decoding: set by avcodec_decode_*, read by get_buffer() for setting pkt_pts
3052 * - encoding: unused
3057 * VBV delay coded in the last frame (in periods of a 27 MHz clock).
3058 * Used for compliant TS muxing.
3059 * - encoding: Set by libavcodec.
3060 * - decoding: unused.
3065 * Timebase in which pkt_dts/pts and AVPacket.dts/pts are.
3066 * Code outside libavcodec should access this field using:
3067 * avcodec_set_pkt_timebase(avctx)
3068 * - encoding unused.
3069 * - decodimg set by user
3071 AVRational pkt_timebase;
3075 * Code outside libavcodec should access this field using:
3076 * avcodec_get_codec_descriptior(avctx)
3077 * - encoding: unused.
3078 * - decoding: set by libavcodec.
3080 const AVCodecDescriptor *codec_descriptor;
3083 * Current statistics for PTS correction.
3084 * - decoding: maintained and used by libavcodec, not intended to be used by user apps
3085 * - encoding: unused
3087 int64_t pts_correction_num_faulty_pts; /// Number of incorrect PTS values so far
3088 int64_t pts_correction_num_faulty_dts; /// Number of incorrect DTS values so far
3089 int64_t pts_correction_last_pts; /// PTS of the last frame
3090 int64_t pts_correction_last_dts; /// DTS of the last frame
3093 AVRational av_codec_get_pkt_timebase (const AVCodecContext *avctx);
3094 void av_codec_set_pkt_timebase (AVCodecContext *avctx, AVRational val);
3096 const AVCodecDescriptor *av_codec_get_codec_descriptor(const AVCodecContext *avctx);
3097 void av_codec_set_codec_descriptor(AVCodecContext *avctx, const AVCodecDescriptor *desc);
3102 typedef struct AVProfile {
3104 const char *name; ///< short name for the profile
3107 typedef struct AVCodecDefault AVCodecDefault;
3114 typedef struct AVCodec {
3116 * Name of the codec implementation.
3117 * The name is globally unique among encoders and among decoders (but an
3118 * encoder and a decoder can share the same name).
3119 * This is the primary way to find a codec from the user perspective.
3123 * Descriptive name for the codec, meant to be more human readable than name.
3124 * You should use the NULL_IF_CONFIG_SMALL() macro to define it.
3126 const char *long_name;
3127 enum AVMediaType type;
3130 * Codec capabilities.
3134 const AVRational *supported_framerates; ///< array of supported framerates, or NULL if any, array is terminated by {0,0}
3135 const enum AVPixelFormat *pix_fmts; ///< array of supported pixel formats, or NULL if unknown, array is terminated by -1
3136 const int *supported_samplerates; ///< array of supported audio samplerates, or NULL if unknown, array is terminated by 0
3137 const enum AVSampleFormat *sample_fmts; ///< array of supported sample formats, or NULL if unknown, array is terminated by -1
3138 const uint64_t *channel_layouts; ///< array of support channel layouts, or NULL if unknown. array is terminated by 0
3139 uint8_t max_lowres; ///< maximum value for lowres supported by the decoder
3140 const AVClass *priv_class; ///< AVClass for the private context
3141 const AVProfile *profiles; ///< array of recognized profiles, or NULL if unknown, array is terminated by {FF_PROFILE_UNKNOWN}
3143 /*****************************************************************
3144 * No fields below this line are part of the public API. They
3145 * may not be used outside of libavcodec and can be changed and
3147 * New public fields should be added right above.
3148 *****************************************************************
3151 struct AVCodec *next;
3153 * @name Frame-level threading support functions
3157 * If defined, called on thread contexts when they are created.
3158 * If the codec allocates writable tables in init(), re-allocate them here.
3159 * priv_data will be set to a copy of the original.
3161 int (*init_thread_copy)(AVCodecContext *);
3163 * Copy necessary context variables from a previous thread context to the current one.
3164 * If not defined, the next thread will start automatically; otherwise, the codec
3165 * must call ff_thread_finish_setup().
3167 * dst and src will (rarely) point to the same context, in which case memcpy should be skipped.
3169 int (*update_thread_context)(AVCodecContext *dst, const AVCodecContext *src);
3173 * Private codec-specific defaults.
3175 const AVCodecDefault *defaults;
3178 * Initialize codec static data, called from avcodec_register().
3180 void (*init_static_data)(struct AVCodec *codec);
3182 int (*init)(AVCodecContext *);
3183 int (*encode_sub)(AVCodecContext *, uint8_t *buf, int buf_size,
3184 const struct AVSubtitle *sub);
3186 * Encode data to an AVPacket.
3188 * @param avctx codec context
3189 * @param avpkt output AVPacket (may contain a user-provided buffer)
3190 * @param[in] frame AVFrame containing the raw data to be encoded
3191 * @param[out] got_packet_ptr encoder sets to 0 or 1 to indicate that a
3192 * non-empty packet was returned in avpkt.
3193 * @return 0 on success, negative error code on failure
3195 int (*encode2)(AVCodecContext *avctx, AVPacket *avpkt, const AVFrame *frame,
3196 int *got_packet_ptr);
3197 int (*decode)(AVCodecContext *, void *outdata, int *outdata_size, AVPacket *avpkt);
3198 int (*close)(AVCodecContext *);
3201 * Will be called when seeking
3203 void (*flush)(AVCodecContext *);
3209 typedef struct AVHWAccel {
3211 * Name of the hardware accelerated codec.
3212 * The name is globally unique among encoders and among decoders (but an
3213 * encoder and a decoder can share the same name).
3218 * Type of codec implemented by the hardware accelerator.
3220 * See AVMEDIA_TYPE_xxx
3222 enum AVMediaType type;
3225 * Codec implemented by the hardware accelerator.
3227 * See AV_CODEC_ID_xxx
3232 * Supported pixel format.
3234 * Only hardware accelerated formats are supported here.
3236 enum AVPixelFormat pix_fmt;
3239 * Hardware accelerated codec capabilities.
3240 * see FF_HWACCEL_CODEC_CAP_*
3244 struct AVHWAccel *next;
3247 * Called at the beginning of each frame or field picture.
3249 * Meaningful frame information (codec specific) is guaranteed to
3250 * be parsed at this point. This function is mandatory.
3252 * Note that buf can be NULL along with buf_size set to 0.
3253 * Otherwise, this means the whole frame is available at this point.
3255 * @param avctx the codec context
3256 * @param buf the frame data buffer base
3257 * @param buf_size the size of the frame in bytes
3258 * @return zero if successful, a negative value otherwise
3260 int (*start_frame)(AVCodecContext *avctx, const uint8_t *buf, uint32_t buf_size);
3263 * Callback for each slice.
3265 * Meaningful slice information (codec specific) is guaranteed to
3266 * be parsed at this point. This function is mandatory.
3268 * @param avctx the codec context
3269 * @param buf the slice data buffer base
3270 * @param buf_size the size of the slice in bytes
3271 * @return zero if successful, a negative value otherwise
3273 int (*decode_slice)(AVCodecContext *avctx, const uint8_t *buf, uint32_t buf_size);
3276 * Called at the end of each frame or field picture.
3278 * The whole picture is parsed at this point and can now be sent
3279 * to the hardware accelerator. This function is mandatory.
3281 * @param avctx the codec context
3282 * @return zero if successful, a negative value otherwise
3284 int (*end_frame)(AVCodecContext *avctx);
3287 * Size of HW accelerator private data.
3289 * Private data is allocated with av_mallocz() before
3290 * AVCodecContext.get_buffer() and deallocated after
3291 * AVCodecContext.release_buffer().
3297 * @defgroup lavc_picture AVPicture
3299 * Functions for working with AVPicture
3304 * four components are given, that's all.
3305 * the last component is alpha
3307 typedef struct AVPicture {
3308 uint8_t *data[AV_NUM_DATA_POINTERS];
3309 int linesize[AV_NUM_DATA_POINTERS]; ///< number of bytes per line
3316 enum AVSubtitleType {
3319 SUBTITLE_BITMAP, ///< A bitmap, pict will be set
3322 * Plain text, the text field must be set by the decoder and is
3323 * authoritative. ass and pict fields may contain approximations.
3328 * Formatted text, the ass field must be set by the decoder and is
3329 * authoritative. pict and text fields may contain approximations.
3334 typedef struct AVSubtitleRect {
3335 int x; ///< top left corner of pict, undefined when pict is not set
3336 int y; ///< top left corner of pict, undefined when pict is not set
3337 int w; ///< width of pict, undefined when pict is not set
3338 int h; ///< height of pict, undefined when pict is not set
3339 int nb_colors; ///< number of colors in pict, undefined when pict is not set
3342 * data+linesize for the bitmap of this subtitle.
3343 * can be set for text/ass as well once they where rendered
3346 enum AVSubtitleType type;
3348 char *text; ///< 0 terminated plain UTF-8 text
3351 * 0 terminated ASS/SSA compatible event line.
3352 * The presentation of this is unaffected by the other values in this
3358 * 1 indicates this subtitle is a forced subtitle.
3359 * A forced subtitle should be displayed even when subtitles are hidden.
3364 typedef struct AVSubtitle {
3365 uint16_t format; /* 0 = graphics */
3366 uint32_t start_display_time; /* relative to packet pts, in ms */
3367 uint32_t end_display_time; /* relative to packet pts, in ms */
3369 AVSubtitleRect **rects;
3370 int64_t pts; ///< Same as packet pts, in AV_TIME_BASE
3374 * If c is NULL, returns the first registered codec,
3375 * if c is non-NULL, returns the next registered codec after c,
3376 * or NULL if c is the last one.
3378 AVCodec *av_codec_next(const AVCodec *c);
3381 * Return the LIBAVCODEC_VERSION_INT constant.
3383 unsigned avcodec_version(void);
3386 * Return the libavcodec build-time configuration.
3388 const char *avcodec_configuration(void);
3391 * Return the libavcodec license.
3393 const char *avcodec_license(void);
3396 * Register the codec codec and initialize libavcodec.
3398 * @warning either this function or avcodec_register_all() must be called
3399 * before any other libavcodec functions.
3401 * @see avcodec_register_all()
3403 void avcodec_register(AVCodec *codec);
3406 * Register all the codecs, parsers and bitstream filters which were enabled at
3407 * configuration time. If you do not call this function you can select exactly
3408 * which formats you want to support, by using the individual registration
3411 * @see avcodec_register
3412 * @see av_register_codec_parser
3413 * @see av_register_bitstream_filter
3415 void avcodec_register_all(void);
3418 #if FF_API_ALLOC_CONTEXT
3420 * Allocate an AVCodecContext and set its fields to default values. The
3421 * resulting struct can be deallocated by simply calling av_free().
3423 * @return An AVCodecContext filled with default values or NULL on failure.
3424 * @see avcodec_get_context_defaults
3426 * @deprecated use avcodec_alloc_context3()
3428 attribute_deprecated
3429 AVCodecContext *avcodec_alloc_context(void);
3431 /** THIS FUNCTION IS NOT YET PART OF THE PUBLIC API!
3432 * we WILL change its arguments and name a few times! */
3433 attribute_deprecated
3434 AVCodecContext *avcodec_alloc_context2(enum AVMediaType);
3437 * Set the fields of the given AVCodecContext to default values.
3439 * @param s The AVCodecContext of which the fields should be set to default values.
3440 * @deprecated use avcodec_get_context_defaults3
3442 attribute_deprecated
3443 void avcodec_get_context_defaults(AVCodecContext *s);
3445 /** THIS FUNCTION IS NOT YET PART OF THE PUBLIC API!
3446 * we WILL change its arguments and name a few times! */
3447 attribute_deprecated
3448 void avcodec_get_context_defaults2(AVCodecContext *s, enum AVMediaType);
3452 * Allocate an AVCodecContext and set its fields to default values. The
3453 * resulting struct can be deallocated by calling avcodec_close() on it followed
3456 * @param codec if non-NULL, allocate private data and initialize defaults
3457 * for the given codec. It is illegal to then call avcodec_open2()
3458 * with a different codec.
3459 * If NULL, then the codec-specific defaults won't be initialized,
3460 * which may result in suboptimal default settings (this is
3461 * important mainly for encoders, e.g. libx264).
3463 * @return An AVCodecContext filled with default values or NULL on failure.
3464 * @see avcodec_get_context_defaults
3466 AVCodecContext *avcodec_alloc_context3(const AVCodec *codec);
3469 * Set the fields of the given AVCodecContext to default values corresponding
3470 * to the given codec (defaults may be codec-dependent).
3472 * Do not call this function if a non-NULL codec has been passed
3473 * to avcodec_alloc_context3() that allocated this AVCodecContext.
3474 * If codec is non-NULL, it is illegal to call avcodec_open2() with a
3475 * different codec on this AVCodecContext.
3477 int avcodec_get_context_defaults3(AVCodecContext *s, const AVCodec *codec);
3480 * Get the AVClass for AVCodecContext. It can be used in combination with
3481 * AV_OPT_SEARCH_FAKE_OBJ for examining options.
3483 * @see av_opt_find().
3485 const AVClass *avcodec_get_class(void);
3488 * Get the AVClass for AVFrame. It can be used in combination with
3489 * AV_OPT_SEARCH_FAKE_OBJ for examining options.
3491 * @see av_opt_find().
3493 const AVClass *avcodec_get_frame_class(void);
3496 * Get the AVClass for AVSubtitleRect. It can be used in combination with
3497 * AV_OPT_SEARCH_FAKE_OBJ for examining options.
3499 * @see av_opt_find().
3501 const AVClass *avcodec_get_subtitle_rect_class(void);
3504 * Copy the settings of the source AVCodecContext into the destination
3505 * AVCodecContext. The resulting destination codec context will be
3506 * unopened, i.e. you are required to call avcodec_open2() before you
3507 * can use this AVCodecContext to decode/encode video/audio data.
3509 * @param dest target codec context, should be initialized with
3510 * avcodec_alloc_context3(), but otherwise uninitialized
3511 * @param src source codec context
3512 * @return AVERROR() on error (e.g. memory allocation error), 0 on success
3514 int avcodec_copy_context(AVCodecContext *dest, const AVCodecContext *src);
3517 * Allocate an AVFrame and set its fields to default values. The resulting
3518 * struct must be freed using avcodec_free_frame().
3520 * @return An AVFrame filled with default values or NULL on failure.
3521 * @see avcodec_get_frame_defaults
3523 AVFrame *avcodec_alloc_frame(void);
3526 * Set the fields of the given AVFrame to default values.
3528 * @param frame The AVFrame of which the fields should be set to default values.
3530 void avcodec_get_frame_defaults(AVFrame *frame);
3533 * Free the frame and any dynamically allocated objects in it,
3534 * e.g. extended_data.
3536 * @param frame frame to be freed. The pointer will be set to NULL.
3538 * @warning this function does NOT free the data buffers themselves
3539 * (it does not know how, since they might have been allocated with
3540 * a custom get_buffer()).
3542 void avcodec_free_frame(AVFrame **frame);
3544 #if FF_API_AVCODEC_OPEN
3546 * Initialize the AVCodecContext to use the given AVCodec. Prior to using this
3547 * function the context has to be allocated.
3549 * The functions avcodec_find_decoder_by_name(), avcodec_find_encoder_by_name(),
3550 * avcodec_find_decoder() and avcodec_find_encoder() provide an easy way for
3551 * retrieving a codec.
3553 * @warning This function is not thread safe!
3556 * avcodec_register_all();
3557 * codec = avcodec_find_decoder(AV_CODEC_ID_H264);
3561 * context = avcodec_alloc_context3(codec);
3563 * if (avcodec_open(context, codec) < 0)
3567 * @param avctx The context which will be set up to use the given codec.
3568 * @param codec The codec to use within the context.
3569 * @return zero on success, a negative value on error
3570 * @see avcodec_alloc_context3, avcodec_find_decoder, avcodec_find_encoder, avcodec_close
3572 * @deprecated use avcodec_open2
3574 attribute_deprecated
3575 int avcodec_open(AVCodecContext *avctx, AVCodec *codec);
3579 * Initialize the AVCodecContext to use the given AVCodec. Prior to using this
3580 * function the context has to be allocated with avcodec_alloc_context3().
3582 * The functions avcodec_find_decoder_by_name(), avcodec_find_encoder_by_name(),
3583 * avcodec_find_decoder() and avcodec_find_encoder() provide an easy way for
3584 * retrieving a codec.
3586 * @warning This function is not thread safe!
3589 * avcodec_register_all();
3590 * av_dict_set(&opts, "b", "2.5M", 0);
3591 * codec = avcodec_find_decoder(AV_CODEC_ID_H264);
3595 * context = avcodec_alloc_context3(codec);
3597 * if (avcodec_open2(context, codec, opts) < 0)
3601 * @param avctx The context to initialize.
3602 * @param codec The codec to open this context for. If a non-NULL codec has been
3603 * previously passed to avcodec_alloc_context3() or
3604 * avcodec_get_context_defaults3() for this context, then this
3605 * parameter MUST be either NULL or equal to the previously passed
3607 * @param options A dictionary filled with AVCodecContext and codec-private options.
3608 * On return this object will be filled with options that were not found.
3610 * @return zero on success, a negative value on error
3611 * @see avcodec_alloc_context3(), avcodec_find_decoder(), avcodec_find_encoder(),
3612 * av_dict_set(), av_opt_find().
3614 int avcodec_open2(AVCodecContext *avctx, const AVCodec *codec, AVDictionary **options);
3617 * Close a given AVCodecContext and free all the data associated with it
3618 * (but not the AVCodecContext itself).
3620 * Calling this function on an AVCodecContext that hasn't been opened will free
3621 * the codec-specific data allocated in avcodec_alloc_context3() /
3622 * avcodec_get_context_defaults3() with a non-NULL codec. Subsequent calls will
3625 int avcodec_close(AVCodecContext *avctx);
3628 * Free all allocated data in the given subtitle struct.
3630 * @param sub AVSubtitle to free.
3632 void avsubtitle_free(AVSubtitle *sub);
3639 * @addtogroup lavc_packet
3644 * Default packet destructor.
3646 void av_destruct_packet(AVPacket *pkt);
3649 * Initialize optional fields of a packet with default values.
3651 * Note, this does not touch the data and size members, which have to be
3652 * initialized separately.
3656 void av_init_packet(AVPacket *pkt);
3659 * Allocate the payload of a packet and initialize its fields with
3663 * @param size wanted payload size
3664 * @return 0 if OK, AVERROR_xxx otherwise
3666 int av_new_packet(AVPacket *pkt, int size);
3669 * Reduce packet size, correctly zeroing padding
3672 * @param size new size
3674 void av_shrink_packet(AVPacket *pkt, int size);
3677 * Increase packet size, correctly zeroing padding
3680 * @param grow_by number of bytes by which to increase the size of the packet
3682 int av_grow_packet(AVPacket *pkt, int grow_by);
3685 * @warning This is a hack - the packet memory allocation stuff is broken. The
3686 * packet is allocated if it was not really allocated.
3688 int av_dup_packet(AVPacket *pkt);
3691 * Copy packet, including contents
3693 * @return 0 on success, negative AVERROR on fail
3695 int av_copy_packet(AVPacket *dst, AVPacket *src);
3700 * @param pkt packet to free
3702 void av_free_packet(AVPacket *pkt);
3705 * Allocate new information of a packet.
3708 * @param type side information type
3709 * @param size side information size
3710 * @return pointer to fresh allocated data or NULL otherwise
3712 uint8_t* av_packet_new_side_data(AVPacket *pkt, enum AVPacketSideDataType type,
3716 * Shrink the already allocated side data buffer
3719 * @param type side information type
3720 * @param size new side information size
3721 * @return 0 on success, < 0 on failure
3723 int av_packet_shrink_side_data(AVPacket *pkt, enum AVPacketSideDataType type,
3727 * Get side information from packet.
3730 * @param type desired side information type
3731 * @param size pointer for side information size to store (optional)
3732 * @return pointer to data if present or NULL otherwise
3734 uint8_t* av_packet_get_side_data(AVPacket *pkt, enum AVPacketSideDataType type,
3737 int av_packet_merge_side_data(AVPacket *pkt);
3739 int av_packet_split_side_data(AVPacket *pkt);
3747 * @addtogroup lavc_decoding
3752 * Find a registered decoder with a matching codec ID.
3754 * @param id AVCodecID of the requested decoder
3755 * @return A decoder if one was found, NULL otherwise.
3757 AVCodec *avcodec_find_decoder(enum AVCodecID id);
3760 * Find a registered decoder with the specified name.
3762 * @param name name of the requested decoder
3763 * @return A decoder if one was found, NULL otherwise.
3765 AVCodec *avcodec_find_decoder_by_name(const char *name);
3767 int avcodec_default_get_buffer(AVCodecContext *s, AVFrame *pic);
3768 void avcodec_default_release_buffer(AVCodecContext *s, AVFrame *pic);
3769 int avcodec_default_reget_buffer(AVCodecContext *s, AVFrame *pic);
3772 * Return the amount of padding in pixels which the get_buffer callback must
3773 * provide around the edge of the image for codecs which do not have the
3774 * CODEC_FLAG_EMU_EDGE flag.
3776 * @return Required padding in pixels.
3778 unsigned avcodec_get_edge_width(void);
3781 * Modify width and height values so that they will result in a memory
3782 * buffer that is acceptable for the codec if you do not use any horizontal
3785 * May only be used if a codec with CODEC_CAP_DR1 has been opened.
3786 * If CODEC_FLAG_EMU_EDGE is not set, the dimensions must have been increased
3787 * according to avcodec_get_edge_width() before.
3789 void avcodec_align_dimensions(AVCodecContext *s, int *width, int *height);
3792 * Modify width and height values so that they will result in a memory
3793 * buffer that is acceptable for the codec if you also ensure that all
3794 * line sizes are a multiple of the respective linesize_align[i].
3796 * May only be used if a codec with CODEC_CAP_DR1 has been opened.
3797 * If CODEC_FLAG_EMU_EDGE is not set, the dimensions must have been increased
3798 * according to avcodec_get_edge_width() before.
3800 void avcodec_align_dimensions2(AVCodecContext *s, int *width, int *height,
3801 int linesize_align[AV_NUM_DATA_POINTERS]);
3803 #if FF_API_OLD_DECODE_AUDIO
3805 * Wrapper function which calls avcodec_decode_audio4.
3807 * @deprecated Use avcodec_decode_audio4 instead.
3809 * Decode the audio frame of size avpkt->size from avpkt->data into samples.
3810 * Some decoders may support multiple frames in a single AVPacket, such
3811 * decoders would then just decode the first frame. In this case,
3812 * avcodec_decode_audio3 has to be called again with an AVPacket that contains
3813 * the remaining data in order to decode the second frame etc.
3815 * could be outputted, frame_size_ptr is zero. Otherwise, it is the
3816 * decompressed frame size in bytes.
3818 * @warning You must set frame_size_ptr to the allocated size of the
3819 * output buffer before calling avcodec_decode_audio3().
3821 * @warning The input buffer must be FF_INPUT_BUFFER_PADDING_SIZE larger than
3822 * the actual read bytes because some optimized bitstream readers read 32 or 64
3823 * bits at once and could read over the end.
3825 * @warning The end of the input buffer avpkt->data should be set to 0 to ensure that
3826 * no overreading happens for damaged MPEG streams.
3828 * @warning You must not provide a custom get_buffer() when using
3829 * avcodec_decode_audio3(). Doing so will override it with
3830 * avcodec_default_get_buffer. Use avcodec_decode_audio4() instead,
3831 * which does allow the application to provide a custom get_buffer().
3833 * @note You might have to align the input buffer avpkt->data and output buffer
3834 * samples. The alignment requirements depend on the CPU: On some CPUs it isn't
3835 * necessary at all, on others it won't work at all if not aligned and on others
3836 * it will work but it will have an impact on performance.
3838 * In practice, avpkt->data should have 4 byte alignment at minimum and
3839 * samples should be 16 byte aligned unless the CPU doesn't need it
3840 * (AltiVec and SSE do).
3842 * @note Codecs which have the CODEC_CAP_DELAY capability set have a delay
3843 * between input and output, these need to be fed with avpkt->data=NULL,
3844 * avpkt->size=0 at the end to return the remaining frames.
3846 * @param avctx the codec context
3847 * @param[out] samples the output buffer, sample type in avctx->sample_fmt
3848 * If the sample format is planar, each channel plane will
3849 * be the same size, with no padding between channels.
3850 * @param[in,out] frame_size_ptr the output buffer size in bytes
3851 * @param[in] avpkt The input AVPacket containing the input buffer.
3852 * You can create such packet with av_init_packet() and by then setting
3853 * data and size, some decoders might in addition need other fields.
3854 * All decoders are designed to use the least fields possible though.
3855 * @return On error a negative value is returned, otherwise the number of bytes
3856 * used or zero if no frame data was decompressed (used) from the input AVPacket.
3858 attribute_deprecated int avcodec_decode_audio3(AVCodecContext *avctx, int16_t *samples,
3859 int *frame_size_ptr,
3864 * Decode the audio frame of size avpkt->size from avpkt->data into frame.
3866 * Some decoders may support multiple frames in a single AVPacket. Such
3867 * decoders would then just decode the first frame. In this case,
3868 * avcodec_decode_audio4 has to be called again with an AVPacket containing
3869 * the remaining data in order to decode the second frame, etc...
3870 * Even if no frames are returned, the packet needs to be fed to the decoder
3871 * with remaining data until it is completely consumed or an error occurs.
3873 * @warning The input buffer, avpkt->data must be FF_INPUT_BUFFER_PADDING_SIZE
3874 * larger than the actual read bytes because some optimized bitstream
3875 * readers read 32 or 64 bits at once and could read over the end.
3877 * @note You might have to align the input buffer. The alignment requirements
3878 * depend on the CPU and the decoder.
3880 * @param avctx the codec context
3881 * @param[out] frame The AVFrame in which to store decoded audio samples.
3882 * Decoders request a buffer of a particular size by setting
3883 * AVFrame.nb_samples prior to calling get_buffer(). The
3884 * decoder may, however, only utilize part of the buffer by
3885 * setting AVFrame.nb_samples to a smaller value in the
3887 * @param[out] got_frame_ptr Zero if no frame could be decoded, otherwise it is
3889 * @param[in] avpkt The input AVPacket containing the input buffer.
3890 * At least avpkt->data and avpkt->size should be set. Some
3891 * decoders might also require additional fields to be set.
3892 * @return A negative error code is returned if an error occurred during
3893 * decoding, otherwise the number of bytes consumed from the input
3894 * AVPacket is returned.
3896 int avcodec_decode_audio4(AVCodecContext *avctx, AVFrame *frame,
3897 int *got_frame_ptr, const AVPacket *avpkt);
3900 * Decode the video frame of size avpkt->size from avpkt->data into picture.
3901 * Some decoders may support multiple frames in a single AVPacket, such
3902 * decoders would then just decode the first frame.
3904 * @warning The input buffer must be FF_INPUT_BUFFER_PADDING_SIZE larger than
3905 * the actual read bytes because some optimized bitstream readers read 32 or 64
3906 * bits at once and could read over the end.
3908 * @warning The end of the input buffer buf should be set to 0 to ensure that
3909 * no overreading happens for damaged MPEG streams.
3911 * @note You might have to align the input buffer avpkt->data.
3912 * The alignment requirements depend on the CPU: on some CPUs it isn't
3913 * necessary at all, on others it won't work at all if not aligned and on others
3914 * it will work but it will have an impact on performance.
3916 * In practice, avpkt->data should have 4 byte alignment at minimum.
3918 * @note Codecs which have the CODEC_CAP_DELAY capability set have a delay
3919 * between input and output, these need to be fed with avpkt->data=NULL,
3920 * avpkt->size=0 at the end to return the remaining frames.
3922 * @param avctx the codec context
3923 * @param[out] picture The AVFrame in which the decoded video frame will be stored.
3924 * Use avcodec_alloc_frame to get an AVFrame, the codec will
3925 * allocate memory for the actual bitmap.
3926 * with default get/release_buffer(), the decoder frees/reuses the bitmap as it sees fit.
3927 * with overridden get/release_buffer() (needs CODEC_CAP_DR1) the user decides into what buffer the decoder
3928 * decodes and the decoder tells the user once it does not need the data anymore,
3929 * the user app can at this point free/reuse/keep the memory as it sees fit.
3931 * @param[in] avpkt The input AVpacket containing the input buffer.
3932 * You can create such packet with av_init_packet() and by then setting
3933 * data and size, some decoders might in addition need other fields like
3934 * flags&AV_PKT_FLAG_KEY. All decoders are designed to use the least
3936 * @param[in,out] got_picture_ptr Zero if no frame could be decompressed, otherwise, it is nonzero.
3937 * @return On error a negative value is returned, otherwise the number of bytes
3938 * used or zero if no frame could be decompressed.
3940 int avcodec_decode_video2(AVCodecContext *avctx, AVFrame *picture,
3941 int *got_picture_ptr,
3942 const AVPacket *avpkt);
3945 * Decode a subtitle message.
3946 * Return a negative value on error, otherwise return the number of bytes used.
3947 * If no subtitle could be decompressed, got_sub_ptr is zero.
3948 * Otherwise, the subtitle is stored in *sub.
3949 * Note that CODEC_CAP_DR1 is not available for subtitle codecs. This is for
3950 * simplicity, because the performance difference is expect to be negligible
3951 * and reusing a get_buffer written for video codecs would probably perform badly
3952 * due to a potentially very different allocation pattern.
3954 * @param avctx the codec context
3955 * @param[out] sub The AVSubtitle in which the decoded subtitle will be stored, must be
3956 freed with avsubtitle_free if *got_sub_ptr is set.
3957 * @param[in,out] got_sub_ptr Zero if no subtitle could be decompressed, otherwise, it is nonzero.
3958 * @param[in] avpkt The input AVPacket containing the input buffer.
3960 int avcodec_decode_subtitle2(AVCodecContext *avctx, AVSubtitle *sub,
3965 * @defgroup lavc_parsing Frame parsing
3969 typedef struct AVCodecParserContext {
3971 struct AVCodecParser *parser;
3972 int64_t frame_offset; /* offset of the current frame */
3973 int64_t cur_offset; /* current offset
3974 (incremented by each av_parser_parse()) */
3975 int64_t next_frame_offset; /* offset of the next frame */
3977 int pict_type; /* XXX: Put it back in AVCodecContext. */
3979 * This field is used for proper frame duration computation in lavf.
3980 * It signals, how much longer the frame duration of the current frame
3981 * is compared to normal frame duration.
3983 * frame_duration = (1 + repeat_pict) * time_base
3985 * It is used by codecs like H.264 to display telecined material.
3987 int repeat_pict; /* XXX: Put it back in AVCodecContext. */
3988 int64_t pts; /* pts of the current frame */
3989 int64_t dts; /* dts of the current frame */
3994 int fetch_timestamp;
3996 #define AV_PARSER_PTS_NB 4
3997 int cur_frame_start_index;
3998 int64_t cur_frame_offset[AV_PARSER_PTS_NB];
3999 int64_t cur_frame_pts[AV_PARSER_PTS_NB];
4000 int64_t cur_frame_dts[AV_PARSER_PTS_NB];
4003 #define PARSER_FLAG_COMPLETE_FRAMES 0x0001
4004 #define PARSER_FLAG_ONCE 0x0002
4005 /// Set if the parser has a valid file offset
4006 #define PARSER_FLAG_FETCHED_OFFSET 0x0004
4007 #define PARSER_FLAG_USE_CODEC_TS 0x1000
4009 int64_t offset; ///< byte offset from starting packet start
4010 int64_t cur_frame_end[AV_PARSER_PTS_NB];
4013 * Set by parser to 1 for key frames and 0 for non-key frames.
4014 * It is initialized to -1, so if the parser doesn't set this flag,
4015 * old-style fallback using AV_PICTURE_TYPE_I picture type as key frames
4021 * Time difference in stream time base units from the pts of this
4022 * packet to the point at which the output from the decoder has converged
4023 * independent from the availability of previous frames. That is, the
4024 * frames are virtually identical no matter if decoding started from
4025 * the very first frame or from this keyframe.
4026 * Is AV_NOPTS_VALUE if unknown.
4027 * This field is not the display duration of the current frame.
4028 * This field has no meaning if the packet does not have AV_PKT_FLAG_KEY
4031 * The purpose of this field is to allow seeking in streams that have no
4032 * keyframes in the conventional sense. It corresponds to the
4033 * recovery point SEI in H.264 and match_time_delta in NUT. It is also
4034 * essential for some types of subtitle streams to ensure that all
4035 * subtitles are correctly displayed after seeking.
4037 int64_t convergence_duration;
4039 // Timestamp generation support:
4041 * Synchronization point for start of timestamp generation.
4043 * Set to >0 for sync point, 0 for no sync point and <0 for undefined
4046 * For example, this corresponds to presence of H.264 buffering period
4052 * Offset of the current timestamp against last timestamp sync point in
4053 * units of AVCodecContext.time_base.
4055 * Set to INT_MIN when dts_sync_point unused. Otherwise, it must
4056 * contain a valid timestamp offset.
4058 * Note that the timestamp of sync point has usually a nonzero
4059 * dts_ref_dts_delta, which refers to the previous sync point. Offset of
4060 * the next frame after timestamp sync point will be usually 1.
4062 * For example, this corresponds to H.264 cpb_removal_delay.
4064 int dts_ref_dts_delta;
4067 * Presentation delay of current frame in units of AVCodecContext.time_base.
4069 * Set to INT_MIN when dts_sync_point unused. Otherwise, it must
4070 * contain valid non-negative timestamp delta (presentation time of a frame
4071 * must not lie in the past).
4073 * This delay represents the difference between decoding and presentation
4074 * time of the frame.
4076 * For example, this corresponds to H.264 dpb_output_delay.
4081 * Position of the packet in file.
4083 * Analogous to cur_frame_pts/dts
4085 int64_t cur_frame_pos[AV_PARSER_PTS_NB];
4088 * Byte position of currently parsed frame in stream.
4093 * Previous frame byte position.
4098 * Duration of the current frame.
4099 * For audio, this is in units of 1 / AVCodecContext.sample_rate.
4100 * For all other types, this is in units of AVCodecContext.time_base.
4103 } AVCodecParserContext;
4105 typedef struct AVCodecParser {
4106 int codec_ids[5]; /* several codec IDs are permitted */
4108 int (*parser_init)(AVCodecParserContext *s);
4109 int (*parser_parse)(AVCodecParserContext *s,
4110 AVCodecContext *avctx,
4111 const uint8_t **poutbuf, int *poutbuf_size,
4112 const uint8_t *buf, int buf_size);
4113 void (*parser_close)(AVCodecParserContext *s);
4114 int (*split)(AVCodecContext *avctx, const uint8_t *buf, int buf_size);
4115 struct AVCodecParser *next;
4118 AVCodecParser *av_parser_next(AVCodecParser *c);
4120 void av_register_codec_parser(AVCodecParser *parser);
4121 AVCodecParserContext *av_parser_init(int codec_id);
4126 * @param s parser context.
4127 * @param avctx codec context.
4128 * @param poutbuf set to pointer to parsed buffer or NULL if not yet finished.
4129 * @param poutbuf_size set to size of parsed buffer or zero if not yet finished.
4130 * @param buf input buffer.
4131 * @param buf_size input length, to signal EOF, this should be 0 (so that the last frame can be output).
4132 * @param pts input presentation timestamp.
4133 * @param dts input decoding timestamp.
4134 * @param pos input byte position in stream.
4135 * @return the number of bytes of the input bitstream used.
4140 * len = av_parser_parse2(myparser, AVCodecContext, &data, &size,
4147 * decode_frame(data, size);
4151 int av_parser_parse2(AVCodecParserContext *s,
4152 AVCodecContext *avctx,
4153 uint8_t **poutbuf, int *poutbuf_size,
4154 const uint8_t *buf, int buf_size,
4155 int64_t pts, int64_t dts,
4158 int av_parser_change(AVCodecParserContext *s,
4159 AVCodecContext *avctx,
4160 uint8_t **poutbuf, int *poutbuf_size,
4161 const uint8_t *buf, int buf_size, int keyframe);
4162 void av_parser_close(AVCodecParserContext *s);
4170 * @addtogroup lavc_encoding
4175 * Find a registered encoder with a matching codec ID.
4177 * @param id AVCodecID of the requested encoder
4178 * @return An encoder if one was found, NULL otherwise.
4180 AVCodec *avcodec_find_encoder(enum AVCodecID id);
4183 * Find a registered encoder with the specified name.
4185 * @param name name of the requested encoder
4186 * @return An encoder if one was found, NULL otherwise.
4188 AVCodec *avcodec_find_encoder_by_name(const char *name);
4190 #if FF_API_OLD_ENCODE_AUDIO
4192 * Encode an audio frame from samples into buf.
4194 * @deprecated Use avcodec_encode_audio2 instead.
4196 * @note The output buffer should be at least FF_MIN_BUFFER_SIZE bytes large.
4197 * However, for codecs with avctx->frame_size equal to 0 (e.g. PCM) the user
4198 * will know how much space is needed because it depends on the value passed
4199 * in buf_size as described below. In that case a lower value can be used.
4201 * @param avctx the codec context
4202 * @param[out] buf the output buffer
4203 * @param[in] buf_size the output buffer size
4204 * @param[in] samples the input buffer containing the samples
4205 * The number of samples read from this buffer is frame_size*channels,
4206 * both of which are defined in avctx.
4207 * For codecs which have avctx->frame_size equal to 0 (e.g. PCM) the number of
4208 * samples read from samples is equal to:
4209 * buf_size * 8 / (avctx->channels * av_get_bits_per_sample(avctx->codec_id))
4210 * This also implies that av_get_bits_per_sample() must not return 0 for these
4212 * @return On error a negative value is returned, on success zero or the number
4213 * of bytes used to encode the data read from the input buffer.
4215 int attribute_deprecated avcodec_encode_audio(AVCodecContext *avctx,
4216 uint8_t *buf, int buf_size,
4217 const short *samples);
4221 * Encode a frame of audio.
4223 * Takes input samples from frame and writes the next output packet, if
4224 * available, to avpkt. The output packet does not necessarily contain data for
4225 * the most recent frame, as encoders can delay, split, and combine input frames
4226 * internally as needed.
4228 * @param avctx codec context
4229 * @param avpkt output AVPacket.
4230 * The user can supply an output buffer by setting
4231 * avpkt->data and avpkt->size prior to calling the
4232 * function, but if the size of the user-provided data is not
4233 * large enough, encoding will fail. If avpkt->data and
4234 * avpkt->size are set, avpkt->destruct must also be set. All
4235 * other AVPacket fields will be reset by the encoder using
4236 * av_init_packet(). If avpkt->data is NULL, the encoder will
4237 * allocate it. The encoder will set avpkt->size to the size
4238 * of the output packet.
4240 * If this function fails or produces no output, avpkt will be
4241 * freed using av_free_packet() (i.e. avpkt->destruct will be
4242 * called to free the user supplied buffer).
4243 * @param[in] frame AVFrame containing the raw audio data to be encoded.
4244 * May be NULL when flushing an encoder that has the
4245 * CODEC_CAP_DELAY capability set.
4246 * If CODEC_CAP_VARIABLE_FRAME_SIZE is set, then each frame
4247 * can have any number of samples.
4248 * If it is not set, frame->nb_samples must be equal to
4249 * avctx->frame_size for all frames except the last.
4250 * The final frame may be smaller than avctx->frame_size.
4251 * @param[out] got_packet_ptr This field is set to 1 by libavcodec if the
4252 * output packet is non-empty, and to 0 if it is
4253 * empty. If the function returns an error, the
4254 * packet can be assumed to be invalid, and the
4255 * value of got_packet_ptr is undefined and should
4257 * @return 0 on success, negative error code on failure
4259 int avcodec_encode_audio2(AVCodecContext *avctx, AVPacket *avpkt,
4260 const AVFrame *frame, int *got_packet_ptr);
4262 #if FF_API_OLD_ENCODE_VIDEO
4264 * @deprecated use avcodec_encode_video2() instead.
4266 * Encode a video frame from pict into buf.
4267 * The input picture should be
4268 * stored using a specific format, namely avctx.pix_fmt.
4270 * @param avctx the codec context
4271 * @param[out] buf the output buffer for the bitstream of encoded frame
4272 * @param[in] buf_size the size of the output buffer in bytes
4273 * @param[in] pict the input picture to encode
4274 * @return On error a negative value is returned, on success zero or the number
4275 * of bytes used from the output buffer.
4277 attribute_deprecated
4278 int avcodec_encode_video(AVCodecContext *avctx, uint8_t *buf, int buf_size,
4279 const AVFrame *pict);
4283 * Encode a frame of video.
4285 * Takes input raw video data from frame and writes the next output packet, if
4286 * available, to avpkt. The output packet does not necessarily contain data for
4287 * the most recent frame, as encoders can delay and reorder input frames
4288 * internally as needed.
4290 * @param avctx codec context
4291 * @param avpkt output AVPacket.
4292 * The user can supply an output buffer by setting
4293 * avpkt->data and avpkt->size prior to calling the
4294 * function, but if the size of the user-provided data is not
4295 * large enough, encoding will fail. All other AVPacket fields
4296 * will be reset by the encoder using av_init_packet(). If
4297 * avpkt->data is NULL, the encoder will allocate it.
4298 * The encoder will set avpkt->size to the size of the
4299 * output packet. The returned data (if any) belongs to the
4300 * caller, he is responsible for freeing it.
4302 * If this function fails or produces no output, avpkt will be
4303 * freed using av_free_packet() (i.e. avpkt->destruct will be
4304 * called to free the user supplied buffer).
4305 * @param[in] frame AVFrame containing the raw video data to be encoded.
4306 * May be NULL when flushing an encoder that has the
4307 * CODEC_CAP_DELAY capability set.
4308 * @param[out] got_packet_ptr This field is set to 1 by libavcodec if the
4309 * output packet is non-empty, and to 0 if it is
4310 * empty. If the function returns an error, the
4311 * packet can be assumed to be invalid, and the
4312 * value of got_packet_ptr is undefined and should
4314 * @return 0 on success, negative error code on failure
4316 int avcodec_encode_video2(AVCodecContext *avctx, AVPacket *avpkt,
4317 const AVFrame *frame, int *got_packet_ptr);
4319 int avcodec_encode_subtitle(AVCodecContext *avctx, uint8_t *buf, int buf_size,
4320 const AVSubtitle *sub);
4327 #if FF_API_AVCODEC_RESAMPLE
4329 * @defgroup lavc_resample Audio resampling
4331 * @deprecated use libswresample instead
4335 struct ReSampleContext;
4336 struct AVResampleContext;
4338 typedef struct ReSampleContext ReSampleContext;
4341 * Initialize audio resampling context.
4343 * @param output_channels number of output channels
4344 * @param input_channels number of input channels
4345 * @param output_rate output sample rate
4346 * @param input_rate input sample rate
4347 * @param sample_fmt_out requested output sample format
4348 * @param sample_fmt_in input sample format
4349 * @param filter_length length of each FIR filter in the filterbank relative to the cutoff frequency
4350 * @param log2_phase_count log2 of the number of entries in the polyphase filterbank
4351 * @param linear if 1 then the used FIR filter will be linearly interpolated
4352 between the 2 closest, if 0 the closest will be used
4353 * @param cutoff cutoff frequency, 1.0 corresponds to half the output sampling rate
4354 * @return allocated ReSampleContext, NULL if error occurred
4356 attribute_deprecated
4357 ReSampleContext *av_audio_resample_init(int output_channels, int input_channels,
4358 int output_rate, int input_rate,
4359 enum AVSampleFormat sample_fmt_out,
4360 enum AVSampleFormat sample_fmt_in,
4361 int filter_length, int log2_phase_count,
4362 int linear, double cutoff);
4364 attribute_deprecated
4365 int audio_resample(ReSampleContext *s, short *output, short *input, int nb_samples);
4368 * Free resample context.
4370 * @param s a non-NULL pointer to a resample context previously
4371 * created with av_audio_resample_init()
4373 attribute_deprecated
4374 void audio_resample_close(ReSampleContext *s);
4378 * Initialize an audio resampler.
4379 * Note, if either rate is not an integer then simply scale both rates up so they are.
4380 * @param filter_length length of each FIR filter in the filterbank relative to the cutoff freq
4381 * @param log2_phase_count log2 of the number of entries in the polyphase filterbank
4382 * @param linear If 1 then the used FIR filter will be linearly interpolated
4383 between the 2 closest, if 0 the closest will be used
4384 * @param cutoff cutoff frequency, 1.0 corresponds to half the output sampling rate
4386 attribute_deprecated
4387 struct AVResampleContext *av_resample_init(int out_rate, int in_rate, int filter_length, int log2_phase_count, int linear, double cutoff);
4390 * Resample an array of samples using a previously configured context.
4391 * @param src an array of unconsumed samples
4392 * @param consumed the number of samples of src which have been consumed are returned here
4393 * @param src_size the number of unconsumed samples available
4394 * @param dst_size the amount of space in samples available in dst
4395 * @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.
4396 * @return the number of samples written in dst or -1 if an error occurred
4398 attribute_deprecated
4399 int av_resample(struct AVResampleContext *c, short *dst, short *src, int *consumed, int src_size, int dst_size, int update_ctx);
4403 * Compensate samplerate/timestamp drift. The compensation is done by changing
4404 * the resampler parameters, so no audible clicks or similar distortions occur
4405 * @param compensation_distance distance in output samples over which the compensation should be performed
4406 * @param sample_delta number of output samples which should be output less
4408 * example: av_resample_compensate(c, 10, 500)
4409 * here instead of 510 samples only 500 samples would be output
4411 * note, due to rounding the actual compensation might be slightly different,
4412 * especially if the compensation_distance is large and the in_rate used during init is small
4414 attribute_deprecated
4415 void av_resample_compensate(struct AVResampleContext *c, int sample_delta, int compensation_distance);
4416 attribute_deprecated
4417 void av_resample_close(struct AVResampleContext *c);
4425 * @addtogroup lavc_picture
4430 * Allocate memory for a picture. Call avpicture_free() to free it.
4432 * @see avpicture_fill()
4434 * @param picture the picture to be filled in
4435 * @param pix_fmt the format of the picture
4436 * @param width the width of the picture
4437 * @param height the height of the picture
4438 * @return zero if successful, a negative value if not
4440 int avpicture_alloc(AVPicture *picture, enum AVPixelFormat pix_fmt, int width, int height);
4443 * Free a picture previously allocated by avpicture_alloc().
4444 * The data buffer used by the AVPicture is freed, but the AVPicture structure
4447 * @param picture the AVPicture to be freed
4449 void avpicture_free(AVPicture *picture);
4452 * Fill in the AVPicture fields, always assume a linesize alignment of
4455 * @see av_image_fill_arrays()
4457 int avpicture_fill(AVPicture *picture, uint8_t *ptr,
4458 enum AVPixelFormat pix_fmt, int width, int height);
4461 * Copy pixel data from an AVPicture into a buffer, always assume a
4462 * linesize alignment of 1.
4464 * @see av_image_copy_to_buffer()
4466 int avpicture_layout(const AVPicture* src, enum AVPixelFormat pix_fmt,
4467 int width, int height,
4468 unsigned char *dest, int dest_size);
4471 * Calculate the size in bytes that a picture of the given width and height
4472 * would occupy if stored in the given picture format.
4473 * Always assume a linesize alignment of 1.
4475 * @see av_image_get_buffer_size().
4477 int avpicture_get_size(enum AVPixelFormat pix_fmt, int width, int height);
4480 * deinterlace - if not supported return -1
4482 int avpicture_deinterlace(AVPicture *dst, const AVPicture *src,
4483 enum AVPixelFormat pix_fmt, int width, int height);
4485 * Copy image src to dst. Wraps av_image_copy().
4487 void av_picture_copy(AVPicture *dst, const AVPicture *src,
4488 enum AVPixelFormat pix_fmt, int width, int height);
4491 * Crop image top and left side.
4493 int av_picture_crop(AVPicture *dst, const AVPicture *src,
4494 enum AVPixelFormat pix_fmt, int top_band, int left_band);
4499 int av_picture_pad(AVPicture *dst, const AVPicture *src, int height, int width, enum AVPixelFormat pix_fmt,
4500 int padtop, int padbottom, int padleft, int padright, int *color);
4507 * @defgroup lavc_misc Utility functions
4510 * Miscellaneous utility functions related to both encoding and decoding
4516 * @defgroup lavc_misc_pixfmt Pixel formats
4518 * Functions for working with pixel formats.
4522 void avcodec_get_chroma_sub_sample(enum AVPixelFormat pix_fmt, int *h_shift, int *v_shift);
4525 * Return a value representing the fourCC code associated to the
4526 * pixel format pix_fmt, or 0 if no associated fourCC code can be
4529 unsigned int avcodec_pix_fmt_to_codec_tag(enum AVPixelFormat pix_fmt);
4531 #define FF_LOSS_RESOLUTION 0x0001 /**< loss due to resolution change */
4532 #define FF_LOSS_DEPTH 0x0002 /**< loss due to color depth change */
4533 #define FF_LOSS_COLORSPACE 0x0004 /**< loss due to color space conversion */
4534 #define FF_LOSS_ALPHA 0x0008 /**< loss of alpha bits */
4535 #define FF_LOSS_COLORQUANT 0x0010 /**< loss due to color quantization */
4536 #define FF_LOSS_CHROMA 0x0020 /**< loss of chroma (e.g. RGB to gray conversion) */
4539 * Compute what kind of losses will occur when converting from one specific
4540 * pixel format to another.
4541 * When converting from one pixel format to another, information loss may occur.
4542 * For example, when converting from RGB24 to GRAY, the color information will
4543 * be lost. Similarly, other losses occur when converting from some formats to
4544 * other formats. These losses can involve loss of chroma, but also loss of
4545 * resolution, loss of color depth, loss due to the color space conversion, loss
4546 * of the alpha bits or loss due to color quantization.
4547 * avcodec_get_fix_fmt_loss() informs you about the various types of losses
4548 * which will occur when converting from one pixel format to another.
4550 * @param[in] dst_pix_fmt destination pixel format
4551 * @param[in] src_pix_fmt source pixel format
4552 * @param[in] has_alpha Whether the source pixel format alpha channel is used.
4553 * @return Combination of flags informing you what kind of losses will occur
4554 * (maximum loss for an invalid dst_pix_fmt).
4556 int avcodec_get_pix_fmt_loss(enum AVPixelFormat dst_pix_fmt, enum AVPixelFormat src_pix_fmt,
4559 #if FF_API_FIND_BEST_PIX_FMT
4561 * @deprecated use avcodec_find_best_pix_fmt_of_2() instead.
4563 * Find the best pixel format to convert to given a certain source pixel
4564 * format. When converting from one pixel format to another, information loss
4565 * may occur. For example, when converting from RGB24 to GRAY, the color
4566 * information will be lost. Similarly, other losses occur when converting from
4567 * some formats to other formats. avcodec_find_best_pix_fmt() searches which of
4568 * the given pixel formats should be used to suffer the least amount of loss.
4569 * The pixel formats from which it chooses one, are determined by the
4570 * pix_fmt_mask parameter.
4572 * Note, only the first 64 pixel formats will fit in pix_fmt_mask.
4575 * src_pix_fmt = AV_PIX_FMT_YUV420P;
4576 * pix_fmt_mask = (1 << AV_PIX_FMT_YUV422P) | (1 << AV_PIX_FMT_RGB24);
4577 * dst_pix_fmt = avcodec_find_best_pix_fmt(pix_fmt_mask, src_pix_fmt, alpha, &loss);
4580 * @param[in] pix_fmt_mask bitmask determining which pixel format to choose from
4581 * @param[in] src_pix_fmt source pixel format
4582 * @param[in] has_alpha Whether the source pixel format alpha channel is used.
4583 * @param[out] loss_ptr Combination of flags informing you what kind of losses will occur.
4584 * @return The best pixel format to convert to or -1 if none was found.
4586 attribute_deprecated
4587 enum AVPixelFormat avcodec_find_best_pix_fmt(int64_t pix_fmt_mask, enum AVPixelFormat src_pix_fmt,
4588 int has_alpha, int *loss_ptr);
4589 #endif /* FF_API_FIND_BEST_PIX_FMT */
4592 * Find the best pixel format to convert to given a certain source pixel
4593 * format. When converting from one pixel format to another, information loss
4594 * may occur. For example, when converting from RGB24 to GRAY, the color
4595 * information will be lost. Similarly, other losses occur when converting from
4596 * some formats to other formats. avcodec_find_best_pix_fmt_of_2() searches which of
4597 * the given pixel formats should be used to suffer the least amount of loss.
4598 * The pixel formats from which it chooses one, are determined by the
4599 * pix_fmt_list parameter.
4602 * @param[in] pix_fmt_list AV_PIX_FMT_NONE terminated array of pixel formats to choose from
4603 * @param[in] src_pix_fmt source pixel format
4604 * @param[in] has_alpha Whether the source pixel format alpha channel is used.
4605 * @param[out] loss_ptr Combination of flags informing you what kind of losses will occur.
4606 * @return The best pixel format to convert to or -1 if none was found.
4608 enum AVPixelFormat avcodec_find_best_pix_fmt_of_list(enum AVPixelFormat *pix_fmt_list,
4609 enum AVPixelFormat src_pix_fmt,
4610 int has_alpha, int *loss_ptr);
4613 * Find the best pixel format to convert to given a certain source pixel
4614 * format and a selection of two destination pixel formats. When converting from
4615 * one pixel format to another, information loss may occur. For example, when converting
4616 * from RGB24 to GRAY, the color information will be lost. Similarly, other losses occur when
4617 * converting from some formats to other formats. avcodec_find_best_pix_fmt_of_2() selects which of
4618 * the given pixel formats should be used to suffer the least amount of loss.
4620 * If one of the destination formats is AV_PIX_FMT_NONE the other pixel format (if valid) will be
4624 * src_pix_fmt = AV_PIX_FMT_YUV420P;
4625 * dst_pix_fmt1= AV_PIX_FMT_RGB24;
4626 * dst_pix_fmt2= AV_PIX_FMT_GRAY8;
4627 * dst_pix_fmt3= AV_PIX_FMT_RGB8;
4628 * loss= FF_LOSS_CHROMA; // don't care about chroma loss, so chroma loss will be ignored.
4629 * dst_pix_fmt = avcodec_find_best_pix_fmt_of_2(dst_pix_fmt1, dst_pix_fmt2, src_pix_fmt, alpha, &loss);
4630 * dst_pix_fmt = avcodec_find_best_pix_fmt_of_2(dst_pix_fmt, dst_pix_fmt3, src_pix_fmt, alpha, &loss);
4633 * @param[in] dst_pix_fmt1 One of the two destination pixel formats to choose from
4634 * @param[in] dst_pix_fmt2 The other of the two destination pixel formats to choose from
4635 * @param[in] src_pix_fmt Source pixel format
4636 * @param[in] has_alpha Whether the source pixel format alpha channel is used.
4637 * @param[in, out] loss_ptr Combination of loss flags. In: selects which of the losses to ignore, i.e.
4638 * NULL or value of zero means we care about all losses. Out: the loss
4639 * that occurs when converting from src to selected dst pixel format.
4640 * @return The best pixel format to convert to or -1 if none was found.
4642 enum AVPixelFormat avcodec_find_best_pix_fmt_of_2(enum AVPixelFormat dst_pix_fmt1, enum AVPixelFormat dst_pix_fmt2,
4643 enum AVPixelFormat src_pix_fmt, int has_alpha, int *loss_ptr);
4645 attribute_deprecated
4646 #if AV_HAVE_INCOMPATIBLE_FORK_ABI
4647 enum AVPixelFormat avcodec_find_best_pix_fmt2(enum AVPixelFormat *pix_fmt_list,
4648 enum AVPixelFormat src_pix_fmt,
4649 int has_alpha, int *loss_ptr);
4651 enum AVPixelFormat avcodec_find_best_pix_fmt2(enum AVPixelFormat dst_pix_fmt1, enum AVPixelFormat dst_pix_fmt2,
4652 enum AVPixelFormat src_pix_fmt, int has_alpha, int *loss_ptr);
4656 enum AVPixelFormat avcodec_default_get_format(struct AVCodecContext *s, const enum AVPixelFormat * fmt);
4662 void avcodec_set_dimensions(AVCodecContext *s, int width, int height);
4665 * Put a string representing the codec tag codec_tag in buf.
4667 * @param buf_size size in bytes of buf
4668 * @return the length of the string that would have been generated if
4669 * enough space had been available, excluding the trailing null
4671 size_t av_get_codec_tag_string(char *buf, size_t buf_size, unsigned int codec_tag);
4673 void avcodec_string(char *buf, int buf_size, AVCodecContext *enc, int encode);
4676 * Return a name for the specified profile, if available.
4678 * @param codec the codec that is searched for the given profile
4679 * @param profile the profile value for which a name is requested
4680 * @return A name for the profile if found, NULL otherwise.
4682 const char *av_get_profile_name(const AVCodec *codec, int profile);
4684 int avcodec_default_execute(AVCodecContext *c, int (*func)(AVCodecContext *c2, void *arg2),void *arg, int *ret, int count, int size);
4685 int avcodec_default_execute2(AVCodecContext *c, int (*func)(AVCodecContext *c2, void *arg2, int, int),void *arg, int *ret, int count);
4686 //FIXME func typedef
4689 * Fill audio frame data and linesize.
4690 * AVFrame extended_data channel pointers are allocated if necessary for
4693 * @param frame the AVFrame
4694 * frame->nb_samples must be set prior to calling the
4695 * function. This function fills in frame->data,
4696 * frame->extended_data, frame->linesize[0].
4697 * @param nb_channels channel count
4698 * @param sample_fmt sample format
4699 * @param buf buffer to use for frame data
4700 * @param buf_size size of buffer
4701 * @param align plane size sample alignment (0 = default)
4702 * @return 0 on success, negative error code on failure
4704 int avcodec_fill_audio_frame(AVFrame *frame, int nb_channels,
4705 enum AVSampleFormat sample_fmt, const uint8_t *buf,
4706 int buf_size, int align);
4709 * Flush buffers, should be called when seeking or when switching to a different stream.
4711 void avcodec_flush_buffers(AVCodecContext *avctx);
4713 void avcodec_default_free_buffers(AVCodecContext *s);
4716 * Return codec bits per sample.
4718 * @param[in] codec_id the codec
4719 * @return Number of bits per sample or zero if unknown for the given codec.
4721 int av_get_bits_per_sample(enum AVCodecID codec_id);
4724 * Return the PCM codec associated with a sample format.
4725 * @param be endianness, 0 for little, 1 for big,
4726 * -1 (or anything else) for native
4727 * @return AV_CODEC_ID_PCM_* or AV_CODEC_ID_NONE
4729 enum AVCodecID av_get_pcm_codec(enum AVSampleFormat fmt, int be);
4732 * Return codec bits per sample.
4733 * Only return non-zero if the bits per sample is exactly correct, not an
4736 * @param[in] codec_id the codec
4737 * @return Number of bits per sample or zero if unknown for the given codec.
4739 int av_get_exact_bits_per_sample(enum AVCodecID codec_id);
4742 * Return audio frame duration.
4744 * @param avctx codec context
4745 * @param frame_bytes size of the frame, or 0 if unknown
4746 * @return frame duration, in samples, if known. 0 if not able to
4749 int av_get_audio_frame_duration(AVCodecContext *avctx, int frame_bytes);
4752 typedef struct AVBitStreamFilterContext {
4754 struct AVBitStreamFilter *filter;
4755 AVCodecParserContext *parser;
4756 struct AVBitStreamFilterContext *next;
4757 } AVBitStreamFilterContext;
4760 typedef struct AVBitStreamFilter {
4763 int (*filter)(AVBitStreamFilterContext *bsfc,
4764 AVCodecContext *avctx, const char *args,
4765 uint8_t **poutbuf, int *poutbuf_size,
4766 const uint8_t *buf, int buf_size, int keyframe);
4767 void (*close)(AVBitStreamFilterContext *bsfc);
4768 struct AVBitStreamFilter *next;
4769 } AVBitStreamFilter;
4771 void av_register_bitstream_filter(AVBitStreamFilter *bsf);
4772 AVBitStreamFilterContext *av_bitstream_filter_init(const char *name);
4773 int av_bitstream_filter_filter(AVBitStreamFilterContext *bsfc,
4774 AVCodecContext *avctx, const char *args,
4775 uint8_t **poutbuf, int *poutbuf_size,
4776 const uint8_t *buf, int buf_size, int keyframe);
4777 void av_bitstream_filter_close(AVBitStreamFilterContext *bsf);
4779 AVBitStreamFilter *av_bitstream_filter_next(AVBitStreamFilter *f);
4784 * Reallocate the given block if it is not large enough, otherwise do nothing.
4788 void *av_fast_realloc(void *ptr, unsigned int *size, size_t min_size);
4791 * Allocate a buffer, reusing the given one if large enough.
4793 * Contrary to av_fast_realloc the current buffer contents might not be
4794 * preserved and on error the old buffer is freed, thus no special
4795 * handling to avoid memleaks is necessary.
4797 * @param ptr pointer to pointer to already allocated buffer, overwritten with pointer to new buffer
4798 * @param size size of the buffer *ptr points to
4799 * @param min_size minimum size of *ptr buffer after returning, *ptr will be NULL and
4800 * *size 0 if an error occurred.
4802 void av_fast_malloc(void *ptr, unsigned int *size, size_t min_size);
4805 * Same behaviour av_fast_malloc but the buffer has additional
4806 * FF_INPUT_PADDING_SIZE at the end which will will always be 0.
4808 * In addition the whole buffer will initially and after resizes
4809 * be 0-initialized so that no uninitialized data will ever appear.
4811 void av_fast_padded_malloc(void *ptr, unsigned int *size, size_t min_size);
4814 * Same behaviour av_fast_padded_malloc except that buffer will always
4815 * be 0-initialized after call.
4817 void av_fast_padded_mallocz(void *ptr, unsigned int *size, size_t min_size);
4820 * Encode extradata length to a buffer. Used by xiph codecs.
4822 * @param s buffer to write to; must be at least (v/255+1) bytes long
4823 * @param v size of extradata in bytes
4824 * @return number of bytes written to the buffer.
4826 unsigned int av_xiphlacing(unsigned char *s, unsigned int v);
4829 * Log a generic warning message about a missing feature. This function is
4830 * intended to be used internally by FFmpeg (libavcodec, libavformat, etc.)
4831 * only, and would normally not be used by applications.
4832 * @param[in] avc a pointer to an arbitrary struct of which the first field is
4833 * a pointer to an AVClass struct
4834 * @param[in] feature string containing the name of the missing feature
4835 * @param[in] want_sample indicates if samples are wanted which exhibit this feature.
4836 * If want_sample is non-zero, additional verbage will be added to the log
4837 * message which tells the user how to report samples to the development
4840 void av_log_missing_feature(void *avc, const char *feature, int want_sample);
4843 * Log a generic warning message asking for a sample. This function is
4844 * intended to be used internally by FFmpeg (libavcodec, libavformat, etc.)
4845 * only, and would normally not be used by applications.
4846 * @param[in] avc a pointer to an arbitrary struct of which the first field is
4847 * a pointer to an AVClass struct
4848 * @param[in] msg string containing an optional message, or NULL if no message
4850 void av_log_ask_for_sample(void *avc, const char *msg, ...) av_printf_format(2, 3);
4853 * Register the hardware accelerator hwaccel.
4855 void av_register_hwaccel(AVHWAccel *hwaccel);
4858 * If hwaccel is NULL, returns the first registered hardware accelerator,
4859 * if hwaccel is non-NULL, returns the next registered hardware accelerator
4860 * after hwaccel, or NULL if hwaccel is the last one.
4862 AVHWAccel *av_hwaccel_next(AVHWAccel *hwaccel);
4866 * Lock operation used by lockmgr
4869 AV_LOCK_CREATE, ///< Create a mutex
4870 AV_LOCK_OBTAIN, ///< Lock the mutex
4871 AV_LOCK_RELEASE, ///< Unlock the mutex
4872 AV_LOCK_DESTROY, ///< Free mutex resources
4876 * Register a user provided lock manager supporting the operations
4877 * specified by AVLockOp. mutex points to a (void *) where the
4878 * lockmgr should store/get a pointer to a user allocated mutex. It's
4879 * NULL upon AV_LOCK_CREATE and != NULL for all other ops.
4881 * @param cb User defined callback. Note: FFmpeg may invoke calls to this
4882 * callback during the call to av_lockmgr_register().
4883 * Thus, the application must be prepared to handle that.
4884 * If cb is set to NULL the lockmgr will be unregistered.
4885 * Also note that during unregistration the previously registered
4886 * lockmgr callback may also be invoked.
4888 int av_lockmgr_register(int (*cb)(void **mutex, enum AVLockOp op));
4891 * Get the type of the given codec.
4893 enum AVMediaType avcodec_get_type(enum AVCodecID codec_id);
4896 * Get the name of a codec.
4897 * @return a static string identifying the codec; never NULL
4899 const char *avcodec_get_name(enum AVCodecID id);
4902 * @return a positive value if s is open (i.e. avcodec_open2() was called on it
4903 * with no corresponding avcodec_close()), 0 otherwise.
4905 int avcodec_is_open(AVCodecContext *s);
4908 * @return a non-zero number if codec is an encoder, zero otherwise
4910 int av_codec_is_encoder(const AVCodec *codec);
4913 * @return a non-zero number if codec is a decoder, zero otherwise
4915 int av_codec_is_decoder(const AVCodec *codec);
4918 * @return descriptor for given codec ID or NULL if no descriptor exists.
4920 const AVCodecDescriptor *avcodec_descriptor_get(enum AVCodecID id);
4923 * Iterate over all codec descriptors known to libavcodec.
4925 * @param prev previous descriptor. NULL to get the first descriptor.
4927 * @return next descriptor or NULL after the last descriptor
4929 const AVCodecDescriptor *avcodec_descriptor_next(const AVCodecDescriptor *prev);
4932 * @return codec descriptor with the given name or NULL if no such descriptor
4935 const AVCodecDescriptor *avcodec_descriptor_get_by_name(const char *name);
4941 #endif /* AVCODEC_AVCODEC_H */