2 * copyright (c) 2001 Fabrice Bellard
4 * This file is part of Libav.
6 * Libav 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 * Libav 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 Libav; 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"
38 #include "libavcodec/version.h"
40 * @defgroup libavc Encoding/Decoding Library
43 * @defgroup lavc_decoding Decoding
47 * @defgroup lavc_encoding Encoding
51 * @defgroup lavc_codec Codecs
53 * @defgroup lavc_codec_native Native Codecs
56 * @defgroup lavc_codec_wrappers External library wrappers
59 * @defgroup lavc_codec_hwaccel Hardware Accelerators bridge
63 * @defgroup lavc_internal Internal
71 * @defgroup lavc_core Core functions/structures.
74 * Basic definitions, functions for querying libavcodec capabilities,
75 * allocating core structures, etc.
81 * Identify the syntax and semantics of the bitstream.
82 * The principle is roughly:
83 * Two decoders with the same ID can decode the same streams.
84 * Two encoders with the same ID can encode compatible streams.
85 * There may be slight deviations from the principle due to implementation
88 * If you add a codec ID to this list, add it so that
89 * 1. no value of a existing codec ID changes (that would break ABI),
90 * 2. it is as close as possible to similar codecs.
92 * After adding new codec IDs, do not forget to add an entry to the codec
93 * descriptor list and bump libavcodec minor version.
99 AV_CODEC_ID_MPEG1VIDEO,
100 AV_CODEC_ID_MPEG2VIDEO, ///< preferred ID for MPEG-1/2 video decoding
101 AV_CODEC_ID_MPEG2VIDEO_XVMC,
112 AV_CODEC_ID_RAWVIDEO,
113 AV_CODEC_ID_MSMPEG4V1,
114 AV_CODEC_ID_MSMPEG4V2,
115 AV_CODEC_ID_MSMPEG4V3,
138 AV_CODEC_ID_INTERPLAY_VIDEO,
145 AV_CODEC_ID_MSVIDEO1,
150 AV_CODEC_ID_TRUEMOTION1,
151 AV_CODEC_ID_VMDVIDEO,
177 AV_CODEC_ID_TRUEMOTION2,
183 AV_CODEC_ID_SMACKVIDEO,
188 AV_CODEC_ID_JPEG2000,
194 AV_CODEC_ID_DSICINVIDEO,
195 AV_CODEC_ID_TIERTEXSEQVIDEO,
203 AV_CODEC_ID_BETHSOFTVID,
215 AV_CODEC_ID_ESCAPE124,
219 AV_CODEC_ID_MOTIONPIXELS,
231 AV_CODEC_ID_FLASHSV2,
232 AV_CODEC_ID_CDGRAPHICS,
235 AV_CODEC_ID_BINKVIDEO,
236 AV_CODEC_ID_IFF_ILBM,
237 AV_CODEC_ID_IFF_BYTERUN1,
243 AV_CODEC_ID_A64_MULTI,
244 AV_CODEC_ID_A64_MULTI5,
247 AV_CODEC_ID_LAGARITH,
251 AV_CODEC_ID_WMV3IMAGE,
252 AV_CODEC_ID_VC1IMAGE,
254 AV_CODEC_ID_BMV_VIDEO,
261 AV_CODEC_ID_ZEROCODEC,
269 /* various PCM "codecs" */
270 AV_CODEC_ID_FIRST_AUDIO = 0x10000, ///< A dummy id pointing at the start of audio codecs
271 AV_CODEC_ID_PCM_S16LE = 0x10000,
272 AV_CODEC_ID_PCM_S16BE,
273 AV_CODEC_ID_PCM_U16LE,
274 AV_CODEC_ID_PCM_U16BE,
277 AV_CODEC_ID_PCM_MULAW,
278 AV_CODEC_ID_PCM_ALAW,
279 AV_CODEC_ID_PCM_S32LE,
280 AV_CODEC_ID_PCM_S32BE,
281 AV_CODEC_ID_PCM_U32LE,
282 AV_CODEC_ID_PCM_U32BE,
283 AV_CODEC_ID_PCM_S24LE,
284 AV_CODEC_ID_PCM_S24BE,
285 AV_CODEC_ID_PCM_U24LE,
286 AV_CODEC_ID_PCM_U24BE,
287 AV_CODEC_ID_PCM_S24DAUD,
288 AV_CODEC_ID_PCM_ZORK,
289 AV_CODEC_ID_PCM_S16LE_PLANAR,
291 AV_CODEC_ID_PCM_F32BE,
292 AV_CODEC_ID_PCM_F32LE,
293 AV_CODEC_ID_PCM_F64BE,
294 AV_CODEC_ID_PCM_F64LE,
295 AV_CODEC_ID_PCM_BLURAY,
298 AV_CODEC_ID_PCM_S8_PLANAR,
300 /* various ADPCM codecs */
301 AV_CODEC_ID_ADPCM_IMA_QT = 0x11000,
302 AV_CODEC_ID_ADPCM_IMA_WAV,
303 AV_CODEC_ID_ADPCM_IMA_DK3,
304 AV_CODEC_ID_ADPCM_IMA_DK4,
305 AV_CODEC_ID_ADPCM_IMA_WS,
306 AV_CODEC_ID_ADPCM_IMA_SMJPEG,
307 AV_CODEC_ID_ADPCM_MS,
308 AV_CODEC_ID_ADPCM_4XM,
309 AV_CODEC_ID_ADPCM_XA,
310 AV_CODEC_ID_ADPCM_ADX,
311 AV_CODEC_ID_ADPCM_EA,
312 AV_CODEC_ID_ADPCM_G726,
313 AV_CODEC_ID_ADPCM_CT,
314 AV_CODEC_ID_ADPCM_SWF,
315 AV_CODEC_ID_ADPCM_YAMAHA,
316 AV_CODEC_ID_ADPCM_SBPRO_4,
317 AV_CODEC_ID_ADPCM_SBPRO_3,
318 AV_CODEC_ID_ADPCM_SBPRO_2,
319 AV_CODEC_ID_ADPCM_THP,
320 AV_CODEC_ID_ADPCM_IMA_AMV,
321 AV_CODEC_ID_ADPCM_EA_R1,
322 AV_CODEC_ID_ADPCM_EA_R3,
323 AV_CODEC_ID_ADPCM_EA_R2,
324 AV_CODEC_ID_ADPCM_IMA_EA_SEAD,
325 AV_CODEC_ID_ADPCM_IMA_EA_EACS,
326 AV_CODEC_ID_ADPCM_EA_XAS,
327 AV_CODEC_ID_ADPCM_EA_MAXIS_XA,
328 AV_CODEC_ID_ADPCM_IMA_ISS,
329 AV_CODEC_ID_ADPCM_G722,
330 AV_CODEC_ID_ADPCM_IMA_APC,
333 AV_CODEC_ID_AMR_NB = 0x12000,
336 /* RealAudio codecs*/
337 AV_CODEC_ID_RA_144 = 0x13000,
340 /* various DPCM codecs */
341 AV_CODEC_ID_ROQ_DPCM = 0x14000,
342 AV_CODEC_ID_INTERPLAY_DPCM,
343 AV_CODEC_ID_XAN_DPCM,
344 AV_CODEC_ID_SOL_DPCM,
347 AV_CODEC_ID_MP2 = 0x15000,
348 AV_CODEC_ID_MP3, ///< preferred ID for decoding MPEG audio layer 1, 2 or 3
358 AV_CODEC_ID_VMDAUDIO,
364 AV_CODEC_ID_WESTWOOD_SND1,
365 AV_CODEC_ID_GSM, ///< as in Berlin toast format
368 AV_CODEC_ID_TRUESPEECH,
370 AV_CODEC_ID_SMACKAUDIO,
373 AV_CODEC_ID_DSICINAUDIO,
375 AV_CODEC_ID_MUSEPACK7,
377 AV_CODEC_ID_GSM_MS, /* as found in WAV */
381 AV_CODEC_ID_NELLYMOSER,
382 AV_CODEC_ID_MUSEPACK8,
384 AV_CODEC_ID_WMAVOICE,
386 AV_CODEC_ID_WMALOSSLESS,
395 AV_CODEC_ID_BINKAUDIO_RDFT,
396 AV_CODEC_ID_BINKAUDIO_DCT,
397 AV_CODEC_ID_AAC_LATM,
402 AV_CODEC_ID_8SVX_EXP,
403 AV_CODEC_ID_8SVX_FIB,
404 AV_CODEC_ID_BMV_AUDIO,
410 /* subtitle codecs */
411 AV_CODEC_ID_FIRST_SUBTITLE = 0x17000, ///< A dummy ID pointing at the start of subtitle codecs.
412 AV_CODEC_ID_DVD_SUBTITLE = 0x17000,
413 AV_CODEC_ID_DVB_SUBTITLE,
414 AV_CODEC_ID_TEXT, ///< raw UTF-8 text
417 AV_CODEC_ID_MOV_TEXT,
418 AV_CODEC_ID_HDMV_PGS_SUBTITLE,
419 AV_CODEC_ID_DVB_TELETEXT,
422 /* other specific kind of codecs (generally used for attachments) */
423 AV_CODEC_ID_FIRST_UNKNOWN = 0x18000, ///< A dummy ID pointing at the start of various fake codecs.
424 AV_CODEC_ID_TTF = 0x18000,
426 AV_CODEC_ID_PROBE = 0x19000, ///< codec_id is not known (like AV_CODEC_ID_NONE) but lavf should attempt to identify it
428 AV_CODEC_ID_MPEG2TS = 0x20000, /**< _FAKE_ codec to indicate a raw MPEG-2 TS
429 * stream (only used by libavformat) */
430 AV_CODEC_ID_MPEG4SYSTEMS = 0x20001, /**< _FAKE_ codec to indicate a MPEG-4 Systems
431 * stream (only used by libavformat) */
432 AV_CODEC_ID_FFMETADATA = 0x21000, ///< Dummy codec for streams containing only metadata information.
435 #include "old_codec_ids.h"
440 #define CodecID AVCodecID
444 * This struct describes the properties of a single codec described by an
446 * @see avcodec_get_descriptor()
448 typedef struct AVCodecDescriptor {
450 enum AVMediaType type;
452 * Name of the codec described by this descriptor. It is non-empty and
453 * unique for each codec descriptor. It should contain alphanumeric
454 * characters and '_' only.
458 * A more descriptive name for this codec. May be NULL.
460 const char *long_name;
462 * Codec properties, a combination of AV_CODEC_PROP_* flags.
468 * Codec uses only intra compression.
471 #define AV_CODEC_PROP_INTRA_ONLY (1 << 0)
473 * Codec supports lossy compression. Audio and video codecs only.
474 * @note a codec may support both lossy and lossless
477 #define AV_CODEC_PROP_LOSSY (1 << 1)
479 * Codec supports lossless compression. Audio and video codecs only.
481 #define AV_CODEC_PROP_LOSSLESS (1 << 2)
483 #if FF_API_OLD_DECODE_AUDIO
485 #define AVCODEC_MAX_AUDIO_FRAME_SIZE 192000 // 1 second of 48khz 32bit audio
489 * @ingroup lavc_decoding
490 * Required number of additionally allocated bytes at the end of the input bitstream for decoding.
491 * This is mainly needed because some optimized bitstream readers read
492 * 32 or 64 bit at once and could read over the end.<br>
493 * Note: If the first 23 bits of the additional bytes are not 0, then damaged
494 * MPEG bitstreams could cause overread and segfault.
496 #define FF_INPUT_BUFFER_PADDING_SIZE 8
499 * @ingroup lavc_encoding
500 * minimum encoding buffer size
501 * Used to avoid some checks during header writing.
503 #define FF_MIN_BUFFER_SIZE 16384
507 * @ingroup lavc_encoding
508 * motion estimation type.
511 ME_ZERO = 1, ///< no search, that is use 0,0 vector whenever one is needed
515 ME_EPZS, ///< enhanced predictive zonal search
516 ME_X1, ///< reserved for experiments
517 ME_HEX, ///< hexagon based search
518 ME_UMH, ///< uneven multi-hexagon search
519 ME_ITER, ///< iterative search
520 ME_TESA, ///< transformed exhaustive search algorithm
524 * @ingroup lavc_decoding
527 /* We leave some space between them for extensions (drop some
528 * keyframes for intra-only or drop just some bidir frames). */
529 AVDISCARD_NONE =-16, ///< discard nothing
530 AVDISCARD_DEFAULT = 0, ///< discard useless packets like 0 size packets in avi
531 AVDISCARD_NONREF = 8, ///< discard all non reference
532 AVDISCARD_BIDIR = 16, ///< discard all bidirectional frames
533 AVDISCARD_NONKEY = 32, ///< discard all frames except keyframes
534 AVDISCARD_ALL = 48, ///< discard all
537 enum AVColorPrimaries{
538 AVCOL_PRI_BT709 = 1, ///< also ITU-R BT1361 / IEC 61966-2-4 / SMPTE RP177 Annex B
539 AVCOL_PRI_UNSPECIFIED = 2,
540 AVCOL_PRI_BT470M = 4,
541 AVCOL_PRI_BT470BG = 5, ///< also ITU-R BT601-6 625 / ITU-R BT1358 625 / ITU-R BT1700 625 PAL & SECAM
542 AVCOL_PRI_SMPTE170M = 6, ///< also ITU-R BT601-6 525 / ITU-R BT1358 525 / ITU-R BT1700 NTSC
543 AVCOL_PRI_SMPTE240M = 7, ///< functionally identical to above
545 AVCOL_PRI_NB , ///< Not part of ABI
548 enum AVColorTransferCharacteristic{
549 AVCOL_TRC_BT709 = 1, ///< also ITU-R BT1361
550 AVCOL_TRC_UNSPECIFIED = 2,
551 AVCOL_TRC_GAMMA22 = 4, ///< also ITU-R BT470M / ITU-R BT1700 625 PAL & SECAM
552 AVCOL_TRC_GAMMA28 = 5, ///< also ITU-R BT470BG
553 AVCOL_TRC_SMPTE240M = 7,
554 AVCOL_TRC_NB , ///< Not part of ABI
559 AVCOL_SPC_BT709 = 1, ///< also ITU-R BT1361 / IEC 61966-2-4 xvYCC709 / SMPTE RP177 Annex B
560 AVCOL_SPC_UNSPECIFIED = 2,
562 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
563 AVCOL_SPC_SMPTE170M = 6, ///< also ITU-R BT601-6 525 / ITU-R BT1358 525 / ITU-R BT1700 NTSC / functionally identical to above
564 AVCOL_SPC_SMPTE240M = 7,
565 AVCOL_SPC_YCOCG = 8, ///< Used by Dirac / VC-2 and H.264 FRext, see ITU-T SG16
566 AVCOL_SPC_NB , ///< Not part of ABI
570 AVCOL_RANGE_UNSPECIFIED = 0,
571 AVCOL_RANGE_MPEG = 1, ///< the normal 219*2^(n-8) "MPEG" YUV ranges
572 AVCOL_RANGE_JPEG = 2, ///< the normal 2^n-1 "JPEG" YUV ranges
573 AVCOL_RANGE_NB , ///< Not part of ABI
577 * X X 3 4 X X are luma samples,
578 * 1 2 1-6 are possible chroma positions
579 * X X 5 6 X 0 is undefined/unknown position
581 enum AVChromaLocation{
582 AVCHROMA_LOC_UNSPECIFIED = 0,
583 AVCHROMA_LOC_LEFT = 1, ///< mpeg2/4, h264 default
584 AVCHROMA_LOC_CENTER = 2, ///< mpeg1, jpeg, h263
585 AVCHROMA_LOC_TOPLEFT = 3, ///< DV
586 AVCHROMA_LOC_TOP = 4,
587 AVCHROMA_LOC_BOTTOMLEFT = 5,
588 AVCHROMA_LOC_BOTTOM = 6,
589 AVCHROMA_LOC_NB , ///< Not part of ABI
592 enum AVAudioServiceType {
593 AV_AUDIO_SERVICE_TYPE_MAIN = 0,
594 AV_AUDIO_SERVICE_TYPE_EFFECTS = 1,
595 AV_AUDIO_SERVICE_TYPE_VISUALLY_IMPAIRED = 2,
596 AV_AUDIO_SERVICE_TYPE_HEARING_IMPAIRED = 3,
597 AV_AUDIO_SERVICE_TYPE_DIALOGUE = 4,
598 AV_AUDIO_SERVICE_TYPE_COMMENTARY = 5,
599 AV_AUDIO_SERVICE_TYPE_EMERGENCY = 6,
600 AV_AUDIO_SERVICE_TYPE_VOICE_OVER = 7,
601 AV_AUDIO_SERVICE_TYPE_KARAOKE = 8,
602 AV_AUDIO_SERVICE_TYPE_NB , ///< Not part of ABI
606 * @ingroup lavc_encoding
608 typedef struct RcOverride{
611 int qscale; // If this is 0 then quality_factor will be used instead.
612 float quality_factor;
615 #define FF_MAX_B_FRAMES 16
618 These flags can be passed in AVCodecContext.flags before initialization.
619 Note: Not everything is supported yet.
622 #define CODEC_FLAG_QSCALE 0x0002 ///< Use fixed qscale.
623 #define CODEC_FLAG_4MV 0x0004 ///< 4 MV per MB allowed / advanced prediction for H.263.
624 #define CODEC_FLAG_QPEL 0x0010 ///< Use qpel MC.
625 #define CODEC_FLAG_GMC 0x0020 ///< Use GMC.
626 #define CODEC_FLAG_MV0 0x0040 ///< Always try a MB with MV=<0,0>.
628 * The parent program guarantees that the input for B-frames containing
629 * streams is not written to for at least s->max_b_frames+1 frames, if
630 * this is not set the input will be copied.
632 #define CODEC_FLAG_INPUT_PRESERVED 0x0100
633 #define CODEC_FLAG_PASS1 0x0200 ///< Use internal 2pass ratecontrol in first pass mode.
634 #define CODEC_FLAG_PASS2 0x0400 ///< Use internal 2pass ratecontrol in second pass mode.
635 #define CODEC_FLAG_GRAY 0x2000 ///< Only decode/encode grayscale.
636 #define CODEC_FLAG_EMU_EDGE 0x4000 ///< Don't draw edges.
637 #define CODEC_FLAG_PSNR 0x8000 ///< error[?] variables will be set during encoding.
638 #define CODEC_FLAG_TRUNCATED 0x00010000 /** Input bitstream might be truncated at a random
639 location instead of only at frame boundaries. */
640 #define CODEC_FLAG_NORMALIZE_AQP 0x00020000 ///< Normalize adaptive quantization.
641 #define CODEC_FLAG_INTERLACED_DCT 0x00040000 ///< Use interlaced DCT.
642 #define CODEC_FLAG_LOW_DELAY 0x00080000 ///< Force low delay.
643 #define CODEC_FLAG_GLOBAL_HEADER 0x00400000 ///< Place global headers in extradata instead of every keyframe.
644 #define CODEC_FLAG_BITEXACT 0x00800000 ///< Use only bitexact stuff (except (I)DCT).
645 /* Fx : Flag for h263+ extra options */
646 #define CODEC_FLAG_AC_PRED 0x01000000 ///< H.263 advanced intra coding / MPEG-4 AC prediction
647 #define CODEC_FLAG_LOOP_FILTER 0x00000800 ///< loop filter
648 #define CODEC_FLAG_INTERLACED_ME 0x20000000 ///< interlaced motion estimation
649 #define CODEC_FLAG_CLOSED_GOP 0x80000000
650 #define CODEC_FLAG2_FAST 0x00000001 ///< Allow non spec compliant speedup tricks.
651 #define CODEC_FLAG2_NO_OUTPUT 0x00000004 ///< Skip bitstream encoding.
652 #define CODEC_FLAG2_LOCAL_HEADER 0x00000008 ///< Place global headers at every keyframe instead of in extradata.
653 #if FF_API_MPV_GLOBAL_OPTS
654 #define CODEC_FLAG_CBP_RD 0x04000000 ///< Use rate distortion optimization for cbp.
655 #define CODEC_FLAG_QP_RD 0x08000000 ///< Use rate distortion optimization for qp selectioon.
656 #define CODEC_FLAG2_STRICT_GOP 0x00000002 ///< Strictly enforce GOP size.
657 #define CODEC_FLAG2_SKIP_RD 0x00004000 ///< RD optimal MB level residual skipping
659 #define CODEC_FLAG2_CHUNKS 0x00008000 ///< Input bitstream might be truncated at a packet boundaries instead of only at frame boundaries.
661 /* Unsupported options :
662 * Syntax Arithmetic coding (SAC)
663 * Reference Picture Selection
664 * Independent Segment Decoding */
666 /* codec capabilities */
668 #define CODEC_CAP_DRAW_HORIZ_BAND 0x0001 ///< Decoder can use draw_horiz_band callback.
670 * Codec uses get_buffer() for allocating buffers and supports custom allocators.
671 * If not set, it might not use get_buffer() at all or use operations that
672 * assume the buffer was allocated by avcodec_default_get_buffer.
674 #define CODEC_CAP_DR1 0x0002
675 #define CODEC_CAP_TRUNCATED 0x0008
676 /* Codec can export data for HW decoding (XvMC). */
677 #define CODEC_CAP_HWACCEL 0x0010
679 * Encoder or decoder requires flushing with NULL input at the end in order to
680 * give the complete and correct output.
682 * NOTE: If this flag is not set, the codec is guaranteed to never be fed with
683 * with NULL data. The user can still send NULL data to the public encode
684 * or decode function, but libavcodec will not pass it along to the codec
685 * unless this flag is set.
688 * The decoder has a non-zero delay and needs to be fed with avpkt->data=NULL,
689 * avpkt->size=0 at the end to get the delayed data until the decoder no longer
693 * The encoder needs to be fed with NULL data at the end of encoding until the
694 * encoder no longer returns data.
696 * NOTE: For encoders implementing the AVCodec.encode2() function, setting this
697 * flag also means that the encoder must set the pts and duration for
698 * each output packet. If this flag is not set, the pts and duration will
699 * be determined by libavcodec from the input frame.
701 #define CODEC_CAP_DELAY 0x0020
703 * Codec can be fed a final frame with a smaller size.
704 * This can be used to prevent truncation of the last audio samples.
706 #define CODEC_CAP_SMALL_LAST_FRAME 0x0040
708 * Codec can export data for HW decoding (VDPAU).
710 #define CODEC_CAP_HWACCEL_VDPAU 0x0080
712 * Codec can output multiple frames per AVPacket
713 * Normally demuxers return one frame at a time, demuxers which do not do
714 * are connected to a parser to split what they return into proper frames.
715 * This flag is reserved to the very rare category of codecs which have a
716 * bitstream that cannot be split into frames without timeconsuming
717 * operations like full decoding. Demuxers carring such bitstreams thus
718 * may return multiple frames in a packet. This has many disadvantages like
719 * prohibiting stream copy in many cases thus it should only be considered
722 #define CODEC_CAP_SUBFRAMES 0x0100
724 * Codec is experimental and is thus avoided in favor of non experimental
727 #define CODEC_CAP_EXPERIMENTAL 0x0200
729 * Codec should fill in channel configuration and samplerate instead of container
731 #define CODEC_CAP_CHANNEL_CONF 0x0400
733 * Codec is able to deal with negative linesizes
735 #define CODEC_CAP_NEG_LINESIZES 0x0800
737 * Codec supports frame-level multithreading.
739 #define CODEC_CAP_FRAME_THREADS 0x1000
741 * Codec supports slice-based (or partition-based) multithreading.
743 #define CODEC_CAP_SLICE_THREADS 0x2000
745 * Codec supports changed parameters at any point.
747 #define CODEC_CAP_PARAM_CHANGE 0x4000
749 * Codec supports avctx->thread_count == 0 (auto).
751 #define CODEC_CAP_AUTO_THREADS 0x8000
753 * Audio encoder supports receiving a different number of samples in each call.
755 #define CODEC_CAP_VARIABLE_FRAME_SIZE 0x10000
757 //The following defines may change, don't expect compatibility if you use them.
758 #define MB_TYPE_INTRA4x4 0x0001
759 #define MB_TYPE_INTRA16x16 0x0002 //FIXME H.264-specific
760 #define MB_TYPE_INTRA_PCM 0x0004 //FIXME H.264-specific
761 #define MB_TYPE_16x16 0x0008
762 #define MB_TYPE_16x8 0x0010
763 #define MB_TYPE_8x16 0x0020
764 #define MB_TYPE_8x8 0x0040
765 #define MB_TYPE_INTERLACED 0x0080
766 #define MB_TYPE_DIRECT2 0x0100 //FIXME
767 #define MB_TYPE_ACPRED 0x0200
768 #define MB_TYPE_GMC 0x0400
769 #define MB_TYPE_SKIP 0x0800
770 #define MB_TYPE_P0L0 0x1000
771 #define MB_TYPE_P1L0 0x2000
772 #define MB_TYPE_P0L1 0x4000
773 #define MB_TYPE_P1L1 0x8000
774 #define MB_TYPE_L0 (MB_TYPE_P0L0 | MB_TYPE_P1L0)
775 #define MB_TYPE_L1 (MB_TYPE_P0L1 | MB_TYPE_P1L1)
776 #define MB_TYPE_L0L1 (MB_TYPE_L0 | MB_TYPE_L1)
777 #define MB_TYPE_QUANT 0x00010000
778 #define MB_TYPE_CBP 0x00020000
779 //Note bits 24-31 are reserved for codec specific use (h264 ref0, mpeg1 0mv, ...)
783 * This specifies the area which should be displayed.
784 * Note there may be multiple such areas for one frame.
786 typedef struct AVPanScan{
789 * - encoding: Set by user.
790 * - decoding: Set by libavcodec.
795 * width and height in 1/16 pel
796 * - encoding: Set by user.
797 * - decoding: Set by libavcodec.
803 * position of the top left corner in 1/16 pel for up to 3 fields/frames
804 * - encoding: Set by user.
805 * - decoding: Set by libavcodec.
807 int16_t position[3][2];
810 #define FF_QSCALE_TYPE_MPEG1 0
811 #define FF_QSCALE_TYPE_MPEG2 1
812 #define FF_QSCALE_TYPE_H264 2
813 #define FF_QSCALE_TYPE_VP56 3
815 #define FF_BUFFER_TYPE_INTERNAL 1
816 #define FF_BUFFER_TYPE_USER 2 ///< direct rendering buffers (image is (de)allocated by user)
817 #define FF_BUFFER_TYPE_SHARED 4 ///< Buffer from somewhere else; don't deallocate image (data/base), all other tables are not shared.
818 #define FF_BUFFER_TYPE_COPY 8 ///< Just a (modified) copy of some other buffer, don't deallocate anything.
820 #define FF_BUFFER_HINTS_VALID 0x01 // Buffer hints value is meaningful (if 0 ignore).
821 #define FF_BUFFER_HINTS_READABLE 0x02 // Codec will read from buffer.
822 #define FF_BUFFER_HINTS_PRESERVE 0x04 // User must not alter buffer content.
823 #define FF_BUFFER_HINTS_REUSABLE 0x08 // Codec will reuse the buffer (update).
826 * @defgroup lavc_packet AVPacket
828 * Types and functions for working with AVPacket.
831 enum AVPacketSideDataType {
833 AV_PKT_DATA_NEW_EXTRADATA,
836 * An AV_PKT_DATA_PARAM_CHANGE side data packet is laid out as follows:
839 * if (param_flags & AV_SIDE_DATA_PARAM_CHANGE_CHANNEL_COUNT)
840 * s32le channel_count
841 * if (param_flags & AV_SIDE_DATA_PARAM_CHANGE_CHANNEL_LAYOUT)
842 * u64le channel_layout
843 * if (param_flags & AV_SIDE_DATA_PARAM_CHANGE_SAMPLE_RATE)
845 * if (param_flags & AV_SIDE_DATA_PARAM_CHANGE_DIMENSIONS)
850 AV_PKT_DATA_PARAM_CHANGE,
853 * An AV_PKT_DATA_H263_MB_INFO side data packet contains a number of
854 * structures with info about macroblocks relevant to splitting the
855 * packet into smaller packets on macroblock edges (e.g. as for RFC 2190).
856 * That is, it does not necessarily contain info about all macroblocks,
857 * as long as the distance between macroblocks in the info is smaller
858 * than the target payload size.
859 * Each MB info structure is 12 bytes, and is laid out as follows:
861 * u32le bit offset from the start of the packet
862 * u8 current quantizer at the start of the macroblock
864 * u16le macroblock address within the GOB
865 * u8 horizontal MV predictor
866 * u8 vertical MV predictor
867 * u8 horizontal MV predictor for block number 3
868 * u8 vertical MV predictor for block number 3
871 AV_PKT_DATA_H263_MB_INFO,
874 typedef struct AVPacket {
876 * Presentation timestamp in AVStream->time_base units; the time at which
877 * the decompressed packet will be presented to the user.
878 * Can be AV_NOPTS_VALUE if it is not stored in the file.
879 * pts MUST be larger or equal to dts as presentation cannot happen before
880 * decompression, unless one wants to view hex dumps. Some formats misuse
881 * the terms dts and pts/cts to mean something different. Such timestamps
882 * must be converted to true pts/dts before they are stored in AVPacket.
886 * Decompression timestamp in AVStream->time_base units; the time at which
887 * the packet is decompressed.
888 * Can be AV_NOPTS_VALUE if it is not stored in the file.
895 * A combination of AV_PKT_FLAG values
899 * Additional packet data that can be provided by the container.
900 * Packet can contain several types of side information.
905 enum AVPacketSideDataType type;
910 * Duration of this packet in AVStream->time_base units, 0 if unknown.
911 * Equals next_pts - this_pts in presentation order.
914 void (*destruct)(struct AVPacket *);
916 int64_t pos; ///< byte position in stream, -1 if unknown
919 * Time difference in AVStream->time_base units from the pts of this
920 * packet to the point at which the output from the decoder has converged
921 * independent from the availability of previous frames. That is, the
922 * frames are virtually identical no matter if decoding started from
923 * the very first frame or from this keyframe.
924 * Is AV_NOPTS_VALUE if unknown.
925 * This field is not the display duration of the current packet.
926 * This field has no meaning if the packet does not have AV_PKT_FLAG_KEY
929 * The purpose of this field is to allow seeking in streams that have no
930 * keyframes in the conventional sense. It corresponds to the
931 * recovery point SEI in H.264 and match_time_delta in NUT. It is also
932 * essential for some types of subtitle streams to ensure that all
933 * subtitles are correctly displayed after seeking.
935 int64_t convergence_duration;
937 #define AV_PKT_FLAG_KEY 0x0001 ///< The packet contains a keyframe
938 #define AV_PKT_FLAG_CORRUPT 0x0002 ///< The packet content is corrupted
940 enum AVSideDataParamChangeFlags {
941 AV_SIDE_DATA_PARAM_CHANGE_CHANNEL_COUNT = 0x0001,
942 AV_SIDE_DATA_PARAM_CHANGE_CHANNEL_LAYOUT = 0x0002,
943 AV_SIDE_DATA_PARAM_CHANGE_SAMPLE_RATE = 0x0004,
944 AV_SIDE_DATA_PARAM_CHANGE_DIMENSIONS = 0x0008,
952 * New fields can be added to the end of AVFRAME with minor version
953 * bumps. Removal, reordering and changes to existing fields require
954 * a major version bump.
955 * sizeof(AVFrame) must not be used outside libav*.
957 typedef struct AVFrame {
958 #define AV_NUM_DATA_POINTERS 8
960 * pointer to the picture/channel planes.
961 * This might be different from the first allocated byte
962 * - encoding: Set by user
963 * - decoding: set by AVCodecContext.get_buffer()
965 uint8_t *data[AV_NUM_DATA_POINTERS];
968 * Size, in bytes, of the data for each picture/channel plane.
970 * For audio, only linesize[0] may be set. For planar audio, each channel
971 * plane must be the same size.
973 * - encoding: Set by user
974 * - decoding: set by AVCodecContext.get_buffer()
976 int linesize[AV_NUM_DATA_POINTERS];
979 * pointers to the data planes/channels.
981 * For video, this should simply point to data[].
983 * For planar audio, each channel has a separate data pointer, and
984 * linesize[0] contains the size of each channel buffer.
985 * For packed audio, there is just one data pointer, and linesize[0]
986 * contains the total size of the buffer for all channels.
988 * Note: Both data and extended_data will always be set by get_buffer(),
989 * but for planar audio with more channels that can fit in data,
990 * extended_data must be used by the decoder in order to access all
994 * decoding: set by AVCodecContext.get_buffer()
996 uint8_t **extended_data;
999 * width and height of the video frame
1000 * - encoding: unused
1001 * - decoding: Read by user.
1006 * number of audio samples (per channel) described by this frame
1007 * - encoding: Set by user
1008 * - decoding: Set by libavcodec
1013 * format of the frame, -1 if unknown or unset
1014 * Values correspond to enum PixelFormat for video frames,
1015 * enum AVSampleFormat for audio)
1016 * - encoding: unused
1017 * - decoding: Read by user.
1022 * 1 -> keyframe, 0-> not
1023 * - encoding: Set by libavcodec.
1024 * - decoding: Set by libavcodec.
1029 * Picture type of the frame, see ?_TYPE below.
1030 * - encoding: Set by libavcodec. for coded_picture (and set by user for input).
1031 * - decoding: Set by libavcodec.
1033 enum AVPictureType pict_type;
1036 * pointer to the first allocated byte of the picture. Can be used in get_buffer/release_buffer.
1037 * This isn't used by libavcodec unless the default get/release_buffer() is used.
1041 uint8_t *base[AV_NUM_DATA_POINTERS];
1044 * sample aspect ratio for the video frame, 0/1 if unknown/unspecified
1045 * - encoding: unused
1046 * - decoding: Read by user.
1048 AVRational sample_aspect_ratio;
1051 * presentation timestamp in time_base units (time when frame should be shown to user)
1052 * If AV_NOPTS_VALUE then frame_rate = 1/time_base will be assumed.
1053 * - encoding: MUST be set by user.
1054 * - decoding: Set by libavcodec.
1059 * reordered pts from the last AVPacket that has been input into the decoder
1060 * - encoding: unused
1061 * - decoding: Read by user.
1066 * dts from the last AVPacket that has been input into the decoder
1067 * - encoding: unused
1068 * - decoding: Read by user.
1073 * picture number in bitstream order
1074 * - encoding: set by
1075 * - decoding: Set by libavcodec.
1077 int coded_picture_number;
1079 * picture number in display order
1080 * - encoding: set by
1081 * - decoding: Set by libavcodec.
1083 int display_picture_number;
1086 * quality (between 1 (good) and FF_LAMBDA_MAX (bad))
1087 * - encoding: Set by libavcodec. for coded_picture (and set by user for input).
1088 * - decoding: Set by libavcodec.
1093 * is this picture used as reference
1094 * The values for this are the same as the MpegEncContext.picture_structure
1095 * variable, that is 1->top field, 2->bottom field, 3->frame/both fields.
1096 * Set to 4 for delayed, non-reference frames.
1097 * - encoding: unused
1098 * - decoding: Set by libavcodec. (before get_buffer() call)).
1104 * - encoding: unused
1105 * - decoding: Set by libavcodec.
1107 int8_t *qscale_table;
1110 * - encoding: unused
1111 * - decoding: Set by libavcodec.
1121 * mbskip_table[mb]>=1 if MB didn't change
1122 * stride= mb_width = (width+15)>>4
1123 * - encoding: unused
1124 * - decoding: Set by libavcodec.
1126 uint8_t *mbskip_table;
1129 * motion vector table
1132 * int mv_sample_log2= 4 - motion_subsample_log2;
1133 * int mb_width= (width+15)>>4;
1134 * int mv_stride= (mb_width << mv_sample_log2) + 1;
1135 * motion_val[direction][x + y*mv_stride][0->mv_x, 1->mv_y];
1137 * - encoding: Set by user.
1138 * - decoding: Set by libavcodec.
1140 int16_t (*motion_val[2])[2];
1143 * macroblock type table
1144 * mb_type_base + mb_width + 2
1145 * - encoding: Set by user.
1146 * - decoding: Set by libavcodec.
1152 * - encoding: unused
1153 * - decoding: Set by libavcodec.
1158 * motion reference frame index
1159 * the order in which these are stored can depend on the codec.
1160 * - encoding: Set by user.
1161 * - decoding: Set by libavcodec.
1163 int8_t *ref_index[2];
1166 * for some private data of the user
1167 * - encoding: unused
1168 * - decoding: Set by user.
1174 * - encoding: Set by libavcodec. if flags&CODEC_FLAG_PSNR.
1175 * - decoding: unused
1177 uint64_t error[AV_NUM_DATA_POINTERS];
1180 * type of the buffer (to keep track of who has to deallocate data[*])
1181 * - encoding: Set by the one who allocates it.
1182 * - decoding: Set by the one who allocates it.
1183 * Note: User allocated (direct rendering) & internal buffers cannot coexist currently.
1188 * When decoding, this signals how much the picture must be delayed.
1189 * extra_delay = repeat_pict / (2*fps)
1190 * - encoding: unused
1191 * - decoding: Set by libavcodec.
1196 * The content of the picture is interlaced.
1197 * - encoding: Set by user.
1198 * - decoding: Set by libavcodec. (default 0)
1200 int interlaced_frame;
1203 * If the content is interlaced, is top field displayed first.
1204 * - encoding: Set by user.
1205 * - decoding: Set by libavcodec.
1207 int top_field_first;
1210 * Tell user application that palette has changed from previous frame.
1211 * - encoding: ??? (no palette-enabled encoder yet)
1212 * - decoding: Set by libavcodec. (default 0).
1214 int palette_has_changed;
1217 * codec suggestion on buffer type if != 0
1218 * - encoding: unused
1219 * - decoding: Set by libavcodec. (before get_buffer() call)).
1225 * - encoding: Set by user.
1226 * - decoding: Set by libavcodec.
1228 AVPanScan *pan_scan;
1231 * reordered opaque 64bit (generally an integer or a double precision float
1232 * PTS but can be anything).
1233 * The user sets AVCodecContext.reordered_opaque to represent the input at
1235 * the decoder reorders values as needed and sets AVFrame.reordered_opaque
1236 * to exactly one of the values provided by the user through AVCodecContext.reordered_opaque
1237 * @deprecated in favor of pkt_pts
1238 * - encoding: unused
1239 * - decoding: Read by user.
1241 int64_t reordered_opaque;
1244 * hardware accelerator private data (Libav-allocated)
1245 * - encoding: unused
1246 * - decoding: Set by libavcodec
1248 void *hwaccel_picture_private;
1251 * the AVCodecContext which ff_thread_get_buffer() was last called on
1252 * - encoding: Set by libavcodec.
1253 * - decoding: Set by libavcodec.
1255 struct AVCodecContext *owner;
1258 * used by multithreading to store frame-specific info
1259 * - encoding: Set by libavcodec.
1260 * - decoding: Set by libavcodec.
1262 void *thread_opaque;
1265 * log2 of the size of the block which a single vector in motion_val represents:
1266 * (4->16x16, 3->8x8, 2-> 4x4, 1-> 2x2)
1267 * - encoding: unused
1268 * - decoding: Set by libavcodec.
1270 uint8_t motion_subsample_log2;
1273 * Sample rate of the audio data.
1275 * - encoding: unused
1276 * - decoding: set by get_buffer()
1281 * Channel layout of the audio data.
1283 * - encoding: unused
1284 * - decoding: set by get_buffer()
1286 uint64_t channel_layout;
1289 struct AVCodecInternal;
1293 AV_FIELD_PROGRESSIVE,
1294 AV_FIELD_TT, //< Top coded_first, top displayed first
1295 AV_FIELD_BB, //< Bottom coded first, bottom displayed first
1296 AV_FIELD_TB, //< Top coded first, bottom displayed first
1297 AV_FIELD_BT, //< Bottom coded first, top displayed first
1301 * main external API structure.
1302 * New fields can be added to the end with minor version bumps.
1303 * Removal, reordering and changes to existing fields require a major
1305 * sizeof(AVCodecContext) must not be used outside libav*.
1307 typedef struct AVCodecContext {
1309 * information on struct for av_log
1310 * - set by avcodec_alloc_context3
1312 const AVClass *av_class;
1313 int log_level_offset;
1315 enum AVMediaType codec_type; /* see AVMEDIA_TYPE_xxx */
1316 const struct AVCodec *codec;
1317 char codec_name[32];
1318 enum AVCodecID codec_id; /* see AV_CODEC_ID_xxx */
1321 * fourcc (LSB first, so "ABCD" -> ('D'<<24) + ('C'<<16) + ('B'<<8) + 'A').
1322 * This is used to work around some encoder bugs.
1323 * A demuxer should set this to what is stored in the field used to identify the codec.
1324 * If there are multiple such fields in a container then the demuxer should choose the one
1325 * which maximizes the information about the used codec.
1326 * If the codec tag field in a container is larger than 32 bits then the demuxer should
1327 * remap the longer ID to 32 bits with a table or other structure. Alternatively a new
1328 * extra_codec_tag + size could be added but for this a clear advantage must be demonstrated
1330 * - encoding: Set by user, if not then the default based on codec_id will be used.
1331 * - decoding: Set by user, will be converted to uppercase by libavcodec during init.
1333 unsigned int codec_tag;
1336 * fourcc from the AVI stream header (LSB first, so "ABCD" -> ('D'<<24) + ('C'<<16) + ('B'<<8) + 'A').
1337 * This is used to work around some encoder bugs.
1338 * - encoding: unused
1339 * - decoding: Set by user, will be converted to uppercase by libavcodec during init.
1341 unsigned int stream_codec_tag;
1345 * @deprecated this field is unused
1347 attribute_deprecated int sub_id;
1353 * Private context used for internal data.
1355 * Unlike priv_data, this is not codec-specific. It is used in general
1356 * libavcodec functions.
1358 struct AVCodecInternal *internal;
1361 * Private data of the user, can be used to carry app specific stuff.
1362 * - encoding: Set by user.
1363 * - decoding: Set by user.
1368 * the average bitrate
1369 * - encoding: Set by user; unused for constant quantizer encoding.
1370 * - decoding: Set by libavcodec. 0 or some bitrate if this info is available in the stream.
1375 * number of bits the bitstream is allowed to diverge from the reference.
1376 * the reference can be CBR (for CBR pass1) or VBR (for pass2)
1377 * - encoding: Set by user; unused for constant quantizer encoding.
1378 * - decoding: unused
1380 int bit_rate_tolerance;
1383 * Global quality for codecs which cannot change it per frame.
1384 * This should be proportional to MPEG-1/2/4 qscale.
1385 * - encoding: Set by user.
1386 * - decoding: unused
1391 * - encoding: Set by user.
1392 * - decoding: unused
1394 int compression_level;
1395 #define FF_COMPRESSION_DEFAULT -1
1399 * - encoding: Set by user.
1400 * - decoding: Set by user.
1406 * - encoding: Set by user.
1407 * - decoding: Set by user.
1412 * some codecs need / can use extradata like Huffman tables.
1413 * mjpeg: Huffman tables
1414 * rv10: additional flags
1415 * mpeg4: global headers (they can be in the bitstream or here)
1416 * The allocated memory should be FF_INPUT_BUFFER_PADDING_SIZE bytes larger
1417 * than extradata_size to avoid prolems if it is read with the bitstream reader.
1418 * The bytewise contents of extradata must not depend on the architecture or CPU endianness.
1419 * - encoding: Set/allocated/freed by libavcodec.
1420 * - decoding: Set/allocated/freed by user.
1426 * This is the fundamental unit of time (in seconds) in terms
1427 * of which frame timestamps are represented. For fixed-fps content,
1428 * timebase should be 1/framerate and timestamp increments should be
1430 * - encoding: MUST be set by user.
1431 * - decoding: Set by libavcodec.
1433 AVRational time_base;
1436 * For some codecs, the time base is closer to the field rate than the frame rate.
1437 * Most notably, H.264 and MPEG-2 specify time_base as half of frame duration
1438 * if no telecine is used ...
1440 * Set to time_base ticks per frame. Default 1, e.g., H.264/MPEG-2 set it to 2.
1442 int ticks_per_frame;
1448 * Number of frames the decoded output will be delayed relative to the
1452 * Number of "priming" samples added to the beginning of the stream
1453 * during encoding. The decoded output will be delayed by this many
1454 * samples relative to the input to the encoder. Note that this field is
1455 * purely informational and does not directly affect the pts output by
1456 * the encoder, which should always be based on the actual presentation
1457 * time, including any delay.
1459 * - encoding: Set by libavcodec.
1460 * - decoding: unused
1467 * picture width / height.
1468 * - encoding: MUST be set by user.
1469 * - decoding: Set by libavcodec.
1470 * Note: For compatibility it is possible to set this instead of
1471 * coded_width/height before decoding.
1476 * Bitstream width / height, may be different from width/height.
1477 * - encoding: unused
1478 * - decoding: Set by user before init if known. Codec should override / dynamically change if needed.
1480 int coded_width, coded_height;
1482 #define FF_ASPECT_EXTENDED 15
1485 * the number of pictures in a group of pictures, or 0 for intra_only
1486 * - encoding: Set by user.
1487 * - decoding: unused
1492 * Pixel format, see PIX_FMT_xxx.
1493 * May be set by the demuxer if known from headers.
1494 * May be overriden by the decoder if it knows better.
1495 * - encoding: Set by user.
1496 * - decoding: Set by user if known, overridden by libavcodec if known
1498 enum PixelFormat pix_fmt;
1501 * Motion estimation algorithm used for video coding.
1502 * 1 (zero), 2 (full), 3 (log), 4 (phods), 5 (epzs), 6 (x1), 7 (hex),
1503 * 8 (umh), 9 (iter), 10 (tesa) [7, 8, 10 are x264 specific, 9 is snow specific]
1504 * - encoding: MUST be set by user.
1505 * - decoding: unused
1510 * If non NULL, 'draw_horiz_band' is called by the libavcodec
1511 * decoder to draw a horizontal band. It improves cache usage. Not
1512 * all codecs can do that. You must check the codec capabilities
1514 * When multithreading is used, it may be called from multiple threads
1515 * at the same time; threads might draw different parts of the same AVFrame,
1516 * or multiple AVFrames, and there is no guarantee that slices will be drawn
1518 * The function is also used by hardware acceleration APIs.
1519 * It is called at least once during frame decoding to pass
1520 * the data needed for hardware render.
1521 * In that mode instead of pixel data, AVFrame points to
1522 * a structure specific to the acceleration API. The application
1523 * reads the structure and can change some fields to indicate progress
1525 * - encoding: unused
1526 * - decoding: Set by user.
1527 * @param height the height of the slice
1528 * @param y the y position of the slice
1529 * @param type 1->top field, 2->bottom field, 3->frame
1530 * @param offset offset into the AVFrame.data from which the slice should be read
1532 void (*draw_horiz_band)(struct AVCodecContext *s,
1533 const AVFrame *src, int offset[AV_NUM_DATA_POINTERS],
1534 int y, int type, int height);
1537 * callback to negotiate the pixelFormat
1538 * @param fmt is the list of formats which are supported by the codec,
1539 * it is terminated by -1 as 0 is a valid format, the formats are ordered by quality.
1540 * The first is always the native one.
1541 * @return the chosen format
1542 * - encoding: unused
1543 * - decoding: Set by user, if not set the native format will be chosen.
1545 enum PixelFormat (*get_format)(struct AVCodecContext *s, const enum PixelFormat * fmt);
1548 * maximum number of B-frames between non-B-frames
1549 * Note: The output will be delayed by max_b_frames+1 relative to the input.
1550 * - encoding: Set by user.
1551 * - decoding: unused
1556 * qscale factor between IP and B-frames
1557 * If > 0 then the last P-frame quantizer will be used (q= lastp_q*factor+offset).
1558 * If < 0 then normal ratecontrol will be done (q= -normal_q*factor+offset).
1559 * - encoding: Set by user.
1560 * - decoding: unused
1562 float b_quant_factor;
1564 /** obsolete FIXME remove */
1566 #define FF_RC_STRATEGY_XVID 1
1568 int b_frame_strategy;
1570 #if FF_API_MPV_GLOBAL_OPTS
1572 * luma single coefficient elimination threshold
1573 * - encoding: Set by user.
1574 * - decoding: unused
1576 attribute_deprecated int luma_elim_threshold;
1579 * chroma single coeff elimination threshold
1580 * - encoding: Set by user.
1581 * - decoding: unused
1583 attribute_deprecated int chroma_elim_threshold;
1587 * qscale offset between IP and B-frames
1588 * - encoding: Set by user.
1589 * - decoding: unused
1591 float b_quant_offset;
1594 * Size of the frame reordering buffer in the decoder.
1595 * For MPEG-2 it is 1 IPB or 0 low delay IP.
1596 * - encoding: Set by libavcodec.
1597 * - decoding: Set by libavcodec.
1602 * 0-> h263 quant 1-> mpeg quant
1603 * - encoding: Set by user.
1604 * - decoding: unused
1609 * qscale factor between P and I-frames
1610 * If > 0 then the last p frame quantizer will be used (q= lastp_q*factor+offset).
1611 * If < 0 then normal ratecontrol will be done (q= -normal_q*factor+offset).
1612 * - encoding: Set by user.
1613 * - decoding: unused
1615 float i_quant_factor;
1618 * qscale offset between P and I-frames
1619 * - encoding: Set by user.
1620 * - decoding: unused
1622 float i_quant_offset;
1625 * luminance masking (0-> disabled)
1626 * - encoding: Set by user.
1627 * - decoding: unused
1632 * temporary complexity masking (0-> disabled)
1633 * - encoding: Set by user.
1634 * - decoding: unused
1636 float temporal_cplx_masking;
1639 * spatial complexity masking (0-> disabled)
1640 * - encoding: Set by user.
1641 * - decoding: unused
1643 float spatial_cplx_masking;
1646 * p block masking (0-> disabled)
1647 * - encoding: Set by user.
1648 * - decoding: unused
1653 * darkness masking (0-> disabled)
1654 * - encoding: Set by user.
1655 * - decoding: unused
1661 * - encoding: Set by libavcodec.
1662 * - decoding: Set by user (or 0).
1666 * prediction method (needed for huffyuv)
1667 * - encoding: Set by user.
1668 * - decoding: unused
1670 int prediction_method;
1671 #define FF_PRED_LEFT 0
1672 #define FF_PRED_PLANE 1
1673 #define FF_PRED_MEDIAN 2
1676 * slice offsets in the frame in bytes
1677 * - encoding: Set/allocated by libavcodec.
1678 * - decoding: Set/allocated by user (or NULL).
1683 * sample aspect ratio (0 if unknown)
1684 * That is the width of a pixel divided by the height of the pixel.
1685 * Numerator and denominator must be relatively prime and smaller than 256 for some video standards.
1686 * - encoding: Set by user.
1687 * - decoding: Set by libavcodec.
1689 AVRational sample_aspect_ratio;
1692 * motion estimation comparison function
1693 * - encoding: Set by user.
1694 * - decoding: unused
1698 * subpixel motion estimation comparison function
1699 * - encoding: Set by user.
1700 * - decoding: unused
1704 * macroblock comparison function (not supported yet)
1705 * - encoding: Set by user.
1706 * - decoding: unused
1710 * interlaced DCT comparison function
1711 * - encoding: Set by user.
1712 * - decoding: unused
1715 #define FF_CMP_SAD 0
1716 #define FF_CMP_SSE 1
1717 #define FF_CMP_SATD 2
1718 #define FF_CMP_DCT 3
1719 #define FF_CMP_PSNR 4
1720 #define FF_CMP_BIT 5
1722 #define FF_CMP_ZERO 7
1723 #define FF_CMP_VSAD 8
1724 #define FF_CMP_VSSE 9
1725 #define FF_CMP_NSSE 10
1726 #define FF_CMP_W53 11
1727 #define FF_CMP_W97 12
1728 #define FF_CMP_DCTMAX 13
1729 #define FF_CMP_DCT264 14
1730 #define FF_CMP_CHROMA 256
1733 * ME diamond size & shape
1734 * - encoding: Set by user.
1735 * - decoding: unused
1740 * amount of previous MV predictors (2a+1 x 2a+1 square)
1741 * - encoding: Set by user.
1742 * - decoding: unused
1744 int last_predictor_count;
1747 * prepass for motion estimation
1748 * - encoding: Set by user.
1749 * - decoding: unused
1754 * motion estimation prepass comparison function
1755 * - encoding: Set by user.
1756 * - decoding: unused
1761 * ME prepass diamond size & shape
1762 * - encoding: Set by user.
1763 * - decoding: unused
1769 * - encoding: Set by user.
1770 * - decoding: unused
1772 int me_subpel_quality;
1775 * DTG active format information (additional aspect ratio
1776 * information only used in DVB MPEG-2 transport streams)
1779 * - encoding: unused
1780 * - decoding: Set by decoder.
1782 int dtg_active_format;
1783 #define FF_DTG_AFD_SAME 8
1784 #define FF_DTG_AFD_4_3 9
1785 #define FF_DTG_AFD_16_9 10
1786 #define FF_DTG_AFD_14_9 11
1787 #define FF_DTG_AFD_4_3_SP_14_9 13
1788 #define FF_DTG_AFD_16_9_SP_14_9 14
1789 #define FF_DTG_AFD_SP_4_3 15
1792 * maximum motion estimation search range in subpel units
1793 * If 0 then no limit.
1795 * - encoding: Set by user.
1796 * - decoding: unused
1801 * intra quantizer bias
1802 * - encoding: Set by user.
1803 * - decoding: unused
1805 int intra_quant_bias;
1806 #define FF_DEFAULT_QUANT_BIAS 999999
1809 * inter quantizer bias
1810 * - encoding: Set by user.
1811 * - decoding: unused
1813 int inter_quant_bias;
1815 #if FF_API_COLOR_TABLE_ID
1818 * - encoding: unused
1819 * - decoding: Which clrtable should be used for 8bit RGB images.
1820 * Tables have to be stored somewhere. FIXME
1822 attribute_deprecated int color_table_id;
1827 * - encoding: unused
1828 * - decoding: Set by user.
1831 #define SLICE_FLAG_CODED_ORDER 0x0001 ///< draw_horiz_band() is called in coded order instead of display
1832 #define SLICE_FLAG_ALLOW_FIELD 0x0002 ///< allow draw_horiz_band() with field slices (MPEG2 field pics)
1833 #define SLICE_FLAG_ALLOW_PLANE 0x0004 ///< allow draw_horiz_band() with 1 component at a time (SVQ1)
1836 * XVideo Motion Acceleration
1837 * - encoding: forbidden
1838 * - decoding: set by decoder
1840 int xvmc_acceleration;
1843 * macroblock decision mode
1844 * - encoding: Set by user.
1845 * - decoding: unused
1848 #define FF_MB_DECISION_SIMPLE 0 ///< uses mb_cmp
1849 #define FF_MB_DECISION_BITS 1 ///< chooses the one which needs the fewest bits
1850 #define FF_MB_DECISION_RD 2 ///< rate distortion
1853 * custom intra quantization matrix
1854 * - encoding: Set by user, can be NULL.
1855 * - decoding: Set by libavcodec.
1857 uint16_t *intra_matrix;
1860 * custom inter quantization matrix
1861 * - encoding: Set by user, can be NULL.
1862 * - decoding: Set by libavcodec.
1864 uint16_t *inter_matrix;
1867 * scene change detection threshold
1868 * 0 is default, larger means fewer detected scene changes.
1869 * - encoding: Set by user.
1870 * - decoding: unused
1872 int scenechange_threshold;
1875 * noise reduction strength
1876 * - encoding: Set by user.
1877 * - decoding: unused
1879 int noise_reduction;
1881 #if FF_API_INTER_THRESHOLD
1883 * @deprecated this field is unused
1885 attribute_deprecated int inter_threshold;
1888 #if FF_API_MPV_GLOBAL_OPTS
1890 * @deprecated use mpegvideo private options instead
1892 attribute_deprecated int quantizer_noise_shaping;
1896 * Motion estimation threshold below which no motion estimation is
1897 * performed, but instead the user specified motion vectors are used.
1899 * - encoding: Set by user.
1900 * - decoding: unused
1905 * Macroblock threshold below which the user specified macroblock types will be used.
1906 * - encoding: Set by user.
1907 * - decoding: unused
1912 * precision of the intra DC coefficient - 8
1913 * - encoding: Set by user.
1914 * - decoding: unused
1916 int intra_dc_precision;
1919 * Number of macroblock rows at the top which are skipped.
1920 * - encoding: unused
1921 * - decoding: Set by user.
1926 * Number of macroblock rows at the bottom which are skipped.
1927 * - encoding: unused
1928 * - decoding: Set by user.
1933 * Border processing masking, raises the quantizer for mbs on the borders
1935 * - encoding: Set by user.
1936 * - decoding: unused
1938 float border_masking;
1941 * minimum MB lagrange multipler
1942 * - encoding: Set by user.
1943 * - decoding: unused
1948 * maximum MB lagrange multipler
1949 * - encoding: Set by user.
1950 * - decoding: unused
1956 * - encoding: Set by user.
1957 * - decoding: unused
1959 int me_penalty_compensation;
1963 * - encoding: Set by user.
1964 * - decoding: unused
1970 * - encoding: Set by user.
1971 * - decoding: unused
1977 * - encoding: Set by user.
1978 * - decoding: unused
1983 * number of reference frames
1984 * - encoding: Set by user.
1985 * - decoding: Set by lavc.
1990 * chroma qp offset from luma
1991 * - encoding: Set by user.
1992 * - decoding: unused
1997 * Multiplied by qscale for each frame and added to scene_change_score.
1998 * - encoding: Set by user.
1999 * - decoding: unused
2001 int scenechange_factor;
2005 * Note: Value depends upon the compare function used for fullpel ME.
2006 * - encoding: Set by user.
2007 * - decoding: unused
2012 * Adjust sensitivity of b_frame_strategy 1.
2013 * - encoding: Set by user.
2014 * - decoding: unused
2019 * Chromaticity coordinates of the source primaries.
2020 * - encoding: Set by user
2021 * - decoding: Set by libavcodec
2023 enum AVColorPrimaries color_primaries;
2026 * Color Transfer Characteristic.
2027 * - encoding: Set by user
2028 * - decoding: Set by libavcodec
2030 enum AVColorTransferCharacteristic color_trc;
2033 * YUV colorspace type.
2034 * - encoding: Set by user
2035 * - decoding: Set by libavcodec
2037 enum AVColorSpace colorspace;
2040 * MPEG vs JPEG YUV range.
2041 * - encoding: Set by user
2042 * - decoding: Set by libavcodec
2044 enum AVColorRange color_range;
2047 * This defines the location of chroma samples.
2048 * - encoding: Set by user
2049 * - decoding: Set by libavcodec
2051 enum AVChromaLocation chroma_sample_location;
2055 * Indicates number of picture subdivisions. Used for parallelized
2057 * - encoding: Set by user
2058 * - decoding: unused
2063 * - encoding: set by libavcodec
2064 * - decoding: Set by libavcodec
2066 enum AVFieldOrder field_order;
2069 int sample_rate; ///< samples per second
2070 int channels; ///< number of audio channels
2073 * audio sample format
2074 * - encoding: Set by user.
2075 * - decoding: Set by libavcodec.
2077 enum AVSampleFormat sample_fmt; ///< sample format
2079 /* The following data should not be initialized. */
2081 * Samples per packet, initialized when calling 'init'.
2086 * Frame counter, set by libavcodec.
2088 * - decoding: total number of frames returned from the decoder so far.
2089 * - encoding: total number of frames passed to the encoder so far.
2091 * @note the counter is not incremented if encoding/decoding resulted in
2097 * number of bytes per packet if constant and known or 0
2098 * Used by some WAV based audio codecs.
2103 * Audio cutoff bandwidth (0 means "automatic")
2104 * - encoding: Set by user.
2105 * - decoding: unused
2109 #if FF_API_REQUEST_CHANNELS
2111 * Decoder should decode to this many channels if it can (0 for default)
2112 * - encoding: unused
2113 * - decoding: Set by user.
2114 * @deprecated Deprecated in favor of request_channel_layout.
2116 int request_channels;
2120 * Audio channel layout.
2121 * - encoding: set by user.
2122 * - decoding: set by libavcodec.
2124 uint64_t channel_layout;
2127 * Request decoder to use this channel layout if it can (0 for default)
2128 * - encoding: unused
2129 * - decoding: Set by user.
2131 uint64_t request_channel_layout;
2134 * Type of service that the audio stream conveys.
2135 * - encoding: Set by user.
2136 * - decoding: Set by libavcodec.
2138 enum AVAudioServiceType audio_service_type;
2141 * Used to request a sample format from the decoder.
2142 * - encoding: unused.
2143 * - decoding: Set by user.
2145 enum AVSampleFormat request_sample_fmt;
2148 * Called at the beginning of each frame to get a buffer for it.
2150 * The function will set AVFrame.data[], AVFrame.linesize[].
2151 * AVFrame.extended_data[] must also be set, but it should be the same as
2152 * AVFrame.data[] except for planar audio with more channels than can fit
2153 * in AVFrame.data[]. In that case, AVFrame.data[] shall still contain as
2154 * many data pointers as it can hold.
2156 * if CODEC_CAP_DR1 is not set then get_buffer() must call
2157 * avcodec_default_get_buffer() instead of providing buffers allocated by
2160 * AVFrame.data[] should be 32- or 16-byte-aligned unless the CPU doesn't
2161 * need it. avcodec_default_get_buffer() aligns the output buffer properly,
2162 * but if get_buffer() is overridden then alignment considerations should
2163 * be taken into account.
2165 * @see avcodec_default_get_buffer()
2169 * If pic.reference is set then the frame will be read later by libavcodec.
2170 * avcodec_align_dimensions2() should be used to find the required width and
2171 * height, as they normally need to be rounded up to the next multiple of 16.
2173 * If frame multithreading is used and thread_safe_callbacks is set,
2174 * it may be called from a different thread, but not from more than one at
2175 * once. Does not need to be reentrant.
2177 * @see release_buffer(), reget_buffer()
2178 * @see avcodec_align_dimensions2()
2182 * Decoders request a buffer of a particular size by setting
2183 * AVFrame.nb_samples prior to calling get_buffer(). The decoder may,
2184 * however, utilize only part of the buffer by setting AVFrame.nb_samples
2185 * to a smaller value in the output frame.
2187 * Decoders cannot use the buffer after returning from
2188 * avcodec_decode_audio4(), so they will not call release_buffer(), as it
2189 * is assumed to be released immediately upon return.
2191 * As a convenience, av_samples_get_buffer_size() and
2192 * av_samples_fill_arrays() in libavutil may be used by custom get_buffer()
2193 * functions to find the required data size and to fill data pointers and
2194 * linesize. In AVFrame.linesize, only linesize[0] may be set for audio
2195 * since all planes must be the same size.
2197 * @see av_samples_get_buffer_size(), av_samples_fill_arrays()
2199 * - encoding: unused
2200 * - decoding: Set by libavcodec, user can override.
2202 int (*get_buffer)(struct AVCodecContext *c, AVFrame *pic);
2205 * Called to release buffers which were allocated with get_buffer.
2206 * A released buffer can be reused in get_buffer().
2207 * pic.data[*] must be set to NULL.
2208 * May be called from a different thread if frame multithreading is used,
2209 * but not by more than one thread at once, so does not need to be reentrant.
2210 * - encoding: unused
2211 * - decoding: Set by libavcodec, user can override.
2213 void (*release_buffer)(struct AVCodecContext *c, AVFrame *pic);
2216 * Called at the beginning of a frame to get cr buffer for it.
2217 * Buffer type (size, hints) must be the same. libavcodec won't check it.
2218 * libavcodec will pass previous buffer in pic, function should return
2219 * same buffer or new buffer with old frame "painted" into it.
2220 * If pic.data[0] == NULL must behave like get_buffer().
2221 * if CODEC_CAP_DR1 is not set then reget_buffer() must call
2222 * avcodec_default_reget_buffer() instead of providing buffers allocated by
2224 * - encoding: unused
2225 * - decoding: Set by libavcodec, user can override.
2227 int (*reget_buffer)(struct AVCodecContext *c, AVFrame *pic);
2230 /* - encoding parameters */
2231 float qcompress; ///< amount of qscale change between easy & hard scenes (0.0-1.0)
2232 float qblur; ///< amount of qscale smoothing over time (0.0-1.0)
2236 * - encoding: Set by user.
2237 * - decoding: unused
2243 * - encoding: Set by user.
2244 * - decoding: unused
2249 * maximum quantizer difference between frames
2250 * - encoding: Set by user.
2251 * - decoding: unused
2256 * ratecontrol qmin qmax limiting method
2257 * 0-> clipping, 1-> use a nice continous function to limit qscale wthin qmin/qmax.
2258 * - encoding: Set by user.
2259 * - decoding: unused
2267 * decoder bitstream buffer size
2268 * - encoding: Set by user.
2269 * - decoding: unused
2274 * ratecontrol override, see RcOverride
2275 * - encoding: Allocated/set/freed by user.
2276 * - decoding: unused
2278 int rc_override_count;
2279 RcOverride *rc_override;
2282 * rate control equation
2283 * - encoding: Set by user
2284 * - decoding: unused
2290 * - encoding: Set by user.
2291 * - decoding: unused
2297 * - encoding: Set by user.
2298 * - decoding: unused
2302 float rc_buffer_aggressivity;
2305 * initial complexity for pass1 ratecontrol
2306 * - encoding: Set by user.
2307 * - decoding: unused
2309 float rc_initial_cplx;
2312 * Ratecontrol attempt to use, at maximum, <value> of what can be used without an underflow.
2313 * - encoding: Set by user.
2314 * - decoding: unused.
2316 float rc_max_available_vbv_use;
2319 * Ratecontrol attempt to use, at least, <value> times the amount needed to prevent a vbv overflow.
2320 * - encoding: Set by user.
2321 * - decoding: unused.
2323 float rc_min_vbv_overflow_use;
2326 * Number of bits which should be loaded into the rc buffer before decoding starts.
2327 * - encoding: Set by user.
2328 * - decoding: unused
2330 int rc_initial_buffer_occupancy;
2332 #define FF_CODER_TYPE_VLC 0
2333 #define FF_CODER_TYPE_AC 1
2334 #define FF_CODER_TYPE_RAW 2
2335 #define FF_CODER_TYPE_RLE 3
2336 #define FF_CODER_TYPE_DEFLATE 4
2339 * - encoding: Set by user.
2340 * - decoding: unused
2346 * - encoding: Set by user.
2347 * - decoding: unused
2352 * minimum Lagrange multipler
2353 * - encoding: Set by user.
2354 * - decoding: unused
2359 * maximum Lagrange multipler
2360 * - encoding: Set by user.
2361 * - decoding: unused
2366 * frame skip threshold
2367 * - encoding: Set by user.
2368 * - decoding: unused
2370 int frame_skip_threshold;
2374 * - encoding: Set by user.
2375 * - decoding: unused
2377 int frame_skip_factor;
2380 * frame skip exponent
2381 * - encoding: Set by user.
2382 * - decoding: unused
2387 * frame skip comparison function
2388 * - encoding: Set by user.
2389 * - decoding: unused
2394 * trellis RD quantization
2395 * - encoding: Set by user.
2396 * - decoding: unused
2401 * - encoding: Set by user.
2402 * - decoding: unused
2404 int min_prediction_order;
2407 * - encoding: Set by user.
2408 * - decoding: unused
2410 int max_prediction_order;
2413 * GOP timecode frame start number, in non drop frame format
2414 * - encoding: Set by user.
2415 * - decoding: unused
2417 int64_t timecode_frame_start;
2419 /* The RTP callback: This function is called */
2420 /* every time the encoder has a packet to send. */
2421 /* It depends on the encoder if the data starts */
2422 /* with a Start Code (it should). H.263 does. */
2423 /* mb_nb contains the number of macroblocks */
2424 /* encoded in the RTP payload. */
2425 void (*rtp_callback)(struct AVCodecContext *avctx, void *data, int size, int mb_nb);
2427 int rtp_payload_size; /* The size of the RTP payload: the coder will */
2428 /* do its best to deliver a chunk with size */
2429 /* below rtp_payload_size, the chunk will start */
2430 /* with a start code on some codecs like H.263. */
2431 /* This doesn't take account of any particular */
2432 /* headers inside the transmitted RTP payload. */
2434 /* statistics, used for 2-pass encoding */
2445 * number of bits used for the previously encoded frame
2446 * - encoding: Set by libavcodec.
2447 * - decoding: unused
2452 * pass1 encoding statistics output buffer
2453 * - encoding: Set by libavcodec.
2454 * - decoding: unused
2459 * pass2 encoding statistics input buffer
2460 * Concatenated stuff from stats_out of pass1 should be placed here.
2461 * - encoding: Allocated/set/freed by user.
2462 * - decoding: unused
2467 * Work around bugs in encoders which sometimes cannot be detected automatically.
2468 * - encoding: Set by user
2469 * - decoding: Set by user
2471 int workaround_bugs;
2472 #define FF_BUG_AUTODETECT 1 ///< autodetection
2473 #define FF_BUG_OLD_MSMPEG4 2
2474 #define FF_BUG_XVID_ILACE 4
2475 #define FF_BUG_UMP4 8
2476 #define FF_BUG_NO_PADDING 16
2477 #define FF_BUG_AMV 32
2478 #define FF_BUG_AC_VLC 0 ///< Will be removed, libavcodec can now handle these non-compliant files by default.
2479 #define FF_BUG_QPEL_CHROMA 64
2480 #define FF_BUG_STD_QPEL 128
2481 #define FF_BUG_QPEL_CHROMA2 256
2482 #define FF_BUG_DIRECT_BLOCKSIZE 512
2483 #define FF_BUG_EDGE 1024
2484 #define FF_BUG_HPEL_CHROMA 2048
2485 #define FF_BUG_DC_CLIP 4096
2486 #define FF_BUG_MS 8192 ///< Work around various bugs in Microsoft's broken decoders.
2487 #define FF_BUG_TRUNCATED 16384
2490 * strictly follow the standard (MPEG4, ...).
2491 * - encoding: Set by user.
2492 * - decoding: Set by user.
2493 * Setting this to STRICT or higher means the encoder and decoder will
2494 * generally do stupid things, whereas setting it to unofficial or lower
2495 * will mean the encoder might produce output that is not supported by all
2496 * spec-compliant decoders. Decoders don't differentiate between normal,
2497 * unofficial and experimental (that is, they always try to decode things
2498 * when they can) unless they are explicitly asked to behave stupidly
2499 * (=strictly conform to the specs)
2501 int strict_std_compliance;
2502 #define FF_COMPLIANCE_VERY_STRICT 2 ///< Strictly conform to an older more strict version of the spec or reference software.
2503 #define FF_COMPLIANCE_STRICT 1 ///< Strictly conform to all the things in the spec no matter what consequences.
2504 #define FF_COMPLIANCE_NORMAL 0
2505 #define FF_COMPLIANCE_UNOFFICIAL -1 ///< Allow unofficial extensions
2506 #define FF_COMPLIANCE_EXPERIMENTAL -2 ///< Allow nonstandardized experimental things.
2509 * error concealment flags
2510 * - encoding: unused
2511 * - decoding: Set by user.
2513 int error_concealment;
2514 #define FF_EC_GUESS_MVS 1
2515 #define FF_EC_DEBLOCK 2
2519 * - encoding: Set by user.
2520 * - decoding: Set by user.
2523 #define FF_DEBUG_PICT_INFO 1
2524 #define FF_DEBUG_RC 2
2525 #define FF_DEBUG_BITSTREAM 4
2526 #define FF_DEBUG_MB_TYPE 8
2527 #define FF_DEBUG_QP 16
2528 #define FF_DEBUG_MV 32
2529 #define FF_DEBUG_DCT_COEFF 0x00000040
2530 #define FF_DEBUG_SKIP 0x00000080
2531 #define FF_DEBUG_STARTCODE 0x00000100
2532 #define FF_DEBUG_PTS 0x00000200
2533 #define FF_DEBUG_ER 0x00000400
2534 #define FF_DEBUG_MMCO 0x00000800
2535 #define FF_DEBUG_BUGS 0x00001000
2536 #define FF_DEBUG_VIS_QP 0x00002000
2537 #define FF_DEBUG_VIS_MB_TYPE 0x00004000
2538 #define FF_DEBUG_BUFFERS 0x00008000
2539 #define FF_DEBUG_THREADS 0x00010000
2543 * - encoding: Set by user.
2544 * - decoding: Set by user.
2547 #define FF_DEBUG_VIS_MV_P_FOR 0x00000001 //visualize forward predicted MVs of P frames
2548 #define FF_DEBUG_VIS_MV_B_FOR 0x00000002 //visualize forward predicted MVs of B frames
2549 #define FF_DEBUG_VIS_MV_B_BACK 0x00000004 //visualize backward predicted MVs of B frames
2552 * Error recognition; may misdetect some more or less valid parts as errors.
2553 * - encoding: unused
2554 * - decoding: Set by user.
2556 int err_recognition;
2557 #define AV_EF_CRCCHECK (1<<0)
2558 #define AV_EF_BITSTREAM (1<<1)
2559 #define AV_EF_BUFFER (1<<2)
2560 #define AV_EF_EXPLODE (1<<3)
2563 * opaque 64bit number (generally a PTS) that will be reordered and
2564 * output in AVFrame.reordered_opaque
2565 * @deprecated in favor of pkt_pts
2566 * - encoding: unused
2567 * - decoding: Set by user.
2569 int64_t reordered_opaque;
2572 * Hardware accelerator in use
2573 * - encoding: unused.
2574 * - decoding: Set by libavcodec
2576 struct AVHWAccel *hwaccel;
2579 * Hardware accelerator context.
2580 * For some hardware accelerators, a global context needs to be
2581 * provided by the user. In that case, this holds display-dependent
2582 * data Libav cannot instantiate itself. Please refer to the
2583 * Libav HW accelerator documentation to know how to fill this
2584 * is. e.g. for VA API, this is a struct vaapi_context.
2585 * - encoding: unused
2586 * - decoding: Set by user
2588 void *hwaccel_context;
2592 * - encoding: Set by libavcodec if flags&CODEC_FLAG_PSNR.
2593 * - decoding: unused
2595 uint64_t error[AV_NUM_DATA_POINTERS];
2598 * DCT algorithm, see FF_DCT_* below
2599 * - encoding: Set by user.
2600 * - decoding: unused
2603 #define FF_DCT_AUTO 0
2604 #define FF_DCT_FASTINT 1
2605 #define FF_DCT_INT 2
2606 #define FF_DCT_MMX 3
2607 #define FF_DCT_ALTIVEC 5
2608 #define FF_DCT_FAAN 6
2611 * IDCT algorithm, see FF_IDCT_* below.
2612 * - encoding: Set by user.
2613 * - decoding: Set by user.
2616 #define FF_IDCT_AUTO 0
2617 #define FF_IDCT_INT 1
2618 #define FF_IDCT_SIMPLE 2
2619 #define FF_IDCT_SIMPLEMMX 3
2620 #define FF_IDCT_LIBMPEG2MMX 4
2621 #define FF_IDCT_MMI 5
2622 #define FF_IDCT_ARM 7
2623 #define FF_IDCT_ALTIVEC 8
2624 #define FF_IDCT_SH4 9
2625 #define FF_IDCT_SIMPLEARM 10
2626 #define FF_IDCT_H264 11
2627 #define FF_IDCT_VP3 12
2628 #define FF_IDCT_IPP 13
2629 #define FF_IDCT_XVIDMMX 14
2630 #define FF_IDCT_CAVS 15
2631 #define FF_IDCT_SIMPLEARMV5TE 16
2632 #define FF_IDCT_SIMPLEARMV6 17
2633 #define FF_IDCT_SIMPLEVIS 18
2634 #define FF_IDCT_WMV2 19
2635 #define FF_IDCT_FAAN 20
2636 #define FF_IDCT_EA 21
2637 #define FF_IDCT_SIMPLENEON 22
2638 #define FF_IDCT_SIMPLEALPHA 23
2639 #define FF_IDCT_BINK 24
2644 * @deprecated use av_set_cpu_flags_mask() instead.
2646 attribute_deprecated unsigned dsp_mask;
2650 * bits per sample/pixel from the demuxer (needed for huffyuv).
2651 * - encoding: Set by libavcodec.
2652 * - decoding: Set by user.
2654 int bits_per_coded_sample;
2657 * Bits per sample/pixel of internal libavcodec pixel/sample format.
2658 * - encoding: set by user.
2659 * - decoding: set by libavcodec.
2661 int bits_per_raw_sample;
2664 * low resolution decoding, 1-> 1/2 size, 2->1/4 size
2665 * - encoding: unused
2666 * - decoding: Set by user.
2668 attribute_deprecated int lowres;
2671 * the picture in the bitstream
2672 * - encoding: Set by libavcodec.
2673 * - decoding: Set by libavcodec.
2675 AVFrame *coded_frame;
2679 * is used to decide how many independent tasks should be passed to execute()
2680 * - encoding: Set by user.
2681 * - decoding: Set by user.
2686 * Which multithreading methods to use.
2687 * Use of FF_THREAD_FRAME will increase decoding delay by one frame per thread,
2688 * so clients which cannot provide future frames should not use it.
2690 * - encoding: Set by user, otherwise the default is used.
2691 * - decoding: Set by user, otherwise the default is used.
2694 #define FF_THREAD_FRAME 1 ///< Decode more than one frame at once
2695 #define FF_THREAD_SLICE 2 ///< Decode more than one part of a single frame at once
2698 * Which multithreading methods are in use by the codec.
2699 * - encoding: Set by libavcodec.
2700 * - decoding: Set by libavcodec.
2702 int active_thread_type;
2705 * Set by the client if its custom get_buffer() callback can be called
2706 * synchronously from another thread, which allows faster multithreaded decoding.
2707 * draw_horiz_band() will be called from other threads regardless of this setting.
2708 * Ignored if the default get_buffer() is used.
2709 * - encoding: Set by user.
2710 * - decoding: Set by user.
2712 int thread_safe_callbacks;
2715 * The codec may call this to execute several independent things.
2716 * It will return only after finishing all tasks.
2717 * The user may replace this with some multithreaded implementation,
2718 * the default implementation will execute the parts serially.
2719 * @param count the number of things to execute
2720 * - encoding: Set by libavcodec, user can override.
2721 * - decoding: Set by libavcodec, user can override.
2723 int (*execute)(struct AVCodecContext *c, int (*func)(struct AVCodecContext *c2, void *arg), void *arg2, int *ret, int count, int size);
2726 * The codec may call this to execute several independent things.
2727 * It will return only after finishing all tasks.
2728 * The user may replace this with some multithreaded implementation,
2729 * the default implementation will execute the parts serially.
2730 * Also see avcodec_thread_init and e.g. the --enable-pthread configure option.
2731 * @param c context passed also to func
2732 * @param count the number of things to execute
2733 * @param arg2 argument passed unchanged to func
2734 * @param ret return values of executed functions, must have space for "count" values. May be NULL.
2735 * @param func function that will be called count times, with jobnr from 0 to count-1.
2736 * threadnr will be in the range 0 to c->thread_count-1 < MAX_THREADS and so that no
2737 * two instances of func executing at the same time will have the same threadnr.
2738 * @return always 0 currently, but code should handle a future improvement where when any call to func
2739 * returns < 0 no further calls to func may be done and < 0 is returned.
2740 * - encoding: Set by libavcodec, user can override.
2741 * - decoding: Set by libavcodec, user can override.
2743 int (*execute2)(struct AVCodecContext *c, int (*func)(struct AVCodecContext *c2, void *arg, int jobnr, int threadnr), void *arg2, int *ret, int count);
2747 * Can be used by execute() to store some per AVCodecContext stuff.
2748 * - encoding: set by execute()
2749 * - decoding: set by execute()
2751 void *thread_opaque;
2754 * noise vs. sse weight for the nsse comparsion function
2755 * - encoding: Set by user.
2756 * - decoding: unused
2762 * - encoding: Set by user.
2763 * - decoding: Set by libavcodec.
2766 #define FF_PROFILE_UNKNOWN -99
2767 #define FF_PROFILE_RESERVED -100
2769 #define FF_PROFILE_AAC_MAIN 0
2770 #define FF_PROFILE_AAC_LOW 1
2771 #define FF_PROFILE_AAC_SSR 2
2772 #define FF_PROFILE_AAC_LTP 3
2773 #define FF_PROFILE_AAC_HE 4
2774 #define FF_PROFILE_AAC_HE_V2 28
2775 #define FF_PROFILE_AAC_LD 22
2776 #define FF_PROFILE_AAC_ELD 38
2778 #define FF_PROFILE_DTS 20
2779 #define FF_PROFILE_DTS_ES 30
2780 #define FF_PROFILE_DTS_96_24 40
2781 #define FF_PROFILE_DTS_HD_HRA 50
2782 #define FF_PROFILE_DTS_HD_MA 60
2784 #define FF_PROFILE_MPEG2_422 0
2785 #define FF_PROFILE_MPEG2_HIGH 1
2786 #define FF_PROFILE_MPEG2_SS 2
2787 #define FF_PROFILE_MPEG2_SNR_SCALABLE 3
2788 #define FF_PROFILE_MPEG2_MAIN 4
2789 #define FF_PROFILE_MPEG2_SIMPLE 5
2791 #define FF_PROFILE_H264_CONSTRAINED (1<<9) // 8+1; constraint_set1_flag
2792 #define FF_PROFILE_H264_INTRA (1<<11) // 8+3; constraint_set3_flag
2794 #define FF_PROFILE_H264_BASELINE 66
2795 #define FF_PROFILE_H264_CONSTRAINED_BASELINE (66|FF_PROFILE_H264_CONSTRAINED)
2796 #define FF_PROFILE_H264_MAIN 77
2797 #define FF_PROFILE_H264_EXTENDED 88
2798 #define FF_PROFILE_H264_HIGH 100
2799 #define FF_PROFILE_H264_HIGH_10 110
2800 #define FF_PROFILE_H264_HIGH_10_INTRA (110|FF_PROFILE_H264_INTRA)
2801 #define FF_PROFILE_H264_HIGH_422 122
2802 #define FF_PROFILE_H264_HIGH_422_INTRA (122|FF_PROFILE_H264_INTRA)
2803 #define FF_PROFILE_H264_HIGH_444 144
2804 #define FF_PROFILE_H264_HIGH_444_PREDICTIVE 244
2805 #define FF_PROFILE_H264_HIGH_444_INTRA (244|FF_PROFILE_H264_INTRA)
2806 #define FF_PROFILE_H264_CAVLC_444 44
2808 #define FF_PROFILE_VC1_SIMPLE 0
2809 #define FF_PROFILE_VC1_MAIN 1
2810 #define FF_PROFILE_VC1_COMPLEX 2
2811 #define FF_PROFILE_VC1_ADVANCED 3
2813 #define FF_PROFILE_MPEG4_SIMPLE 0
2814 #define FF_PROFILE_MPEG4_SIMPLE_SCALABLE 1
2815 #define FF_PROFILE_MPEG4_CORE 2
2816 #define FF_PROFILE_MPEG4_MAIN 3
2817 #define FF_PROFILE_MPEG4_N_BIT 4
2818 #define FF_PROFILE_MPEG4_SCALABLE_TEXTURE 5
2819 #define FF_PROFILE_MPEG4_SIMPLE_FACE_ANIMATION 6
2820 #define FF_PROFILE_MPEG4_BASIC_ANIMATED_TEXTURE 7
2821 #define FF_PROFILE_MPEG4_HYBRID 8
2822 #define FF_PROFILE_MPEG4_ADVANCED_REAL_TIME 9
2823 #define FF_PROFILE_MPEG4_CORE_SCALABLE 10
2824 #define FF_PROFILE_MPEG4_ADVANCED_CODING 11
2825 #define FF_PROFILE_MPEG4_ADVANCED_CORE 12
2826 #define FF_PROFILE_MPEG4_ADVANCED_SCALABLE_TEXTURE 13
2827 #define FF_PROFILE_MPEG4_SIMPLE_STUDIO 14
2828 #define FF_PROFILE_MPEG4_ADVANCED_SIMPLE 15
2832 * - encoding: Set by user.
2833 * - decoding: Set by libavcodec.
2836 #define FF_LEVEL_UNKNOWN -99
2840 * - encoding: unused
2841 * - decoding: Set by user.
2843 enum AVDiscard skip_loop_filter;
2847 * - encoding: unused
2848 * - decoding: Set by user.
2850 enum AVDiscard skip_idct;
2854 * - encoding: unused
2855 * - decoding: Set by user.
2857 enum AVDiscard skip_frame;
2860 * Header containing style information for text subtitles.
2861 * For SUBTITLE_ASS subtitle type, it should contain the whole ASS
2862 * [Script Info] and [V4+ Styles] section, plus the [Events] line and
2863 * the Format line following. It shouldn't include any Dialogue line.
2864 * - encoding: Set/allocated/freed by user (before avcodec_open2())
2865 * - decoding: Set/allocated/freed by libavcodec (by avcodec_open2())
2867 uint8_t *subtitle_header;
2868 int subtitle_header_size;
2871 * Simulates errors in the bitstream to test error concealment.
2872 * - encoding: Set by user.
2873 * - decoding: unused
2878 * Current packet as passed into the decoder, to avoid having
2879 * to pass the packet into every function. Currently only valid
2880 * inside lavc and get/release_buffer callbacks.
2881 * - decoding: set by avcodec_decode_*, read by get_buffer() for setting pkt_pts
2882 * - encoding: unused
2887 * VBV delay coded in the last frame (in periods of a 27 MHz clock).
2888 * Used for compliant TS muxing.
2889 * - encoding: Set by libavcodec.
2890 * - decoding: unused.
2898 typedef struct AVProfile {
2900 const char *name; ///< short name for the profile
2903 typedef struct AVCodecDefault AVCodecDefault;
2910 typedef struct AVCodec {
2912 * Name of the codec implementation.
2913 * The name is globally unique among encoders and among decoders (but an
2914 * encoder and a decoder can share the same name).
2915 * This is the primary way to find a codec from the user perspective.
2919 * Descriptive name for the codec, meant to be more human readable than name.
2920 * You should use the NULL_IF_CONFIG_SMALL() macro to define it.
2922 const char *long_name;
2923 enum AVMediaType type;
2926 * Codec capabilities.
2930 const AVRational *supported_framerates; ///< array of supported framerates, or NULL if any, array is terminated by {0,0}
2931 const enum PixelFormat *pix_fmts; ///< array of supported pixel formats, or NULL if unknown, array is terminated by -1
2932 const int *supported_samplerates; ///< array of supported audio samplerates, or NULL if unknown, array is terminated by 0
2933 const enum AVSampleFormat *sample_fmts; ///< array of supported sample formats, or NULL if unknown, array is terminated by -1
2934 const uint64_t *channel_layouts; ///< array of support channel layouts, or NULL if unknown. array is terminated by 0
2935 attribute_deprecated uint8_t max_lowres; ///< maximum value for lowres supported by the decoder
2936 const AVClass *priv_class; ///< AVClass for the private context
2937 const AVProfile *profiles; ///< array of recognized profiles, or NULL if unknown, array is terminated by {FF_PROFILE_UNKNOWN}
2939 /*****************************************************************
2940 * No fields below this line are part of the public API. They
2941 * may not be used outside of libavcodec and can be changed and
2943 * New public fields should be added right above.
2944 *****************************************************************
2947 struct AVCodec *next;
2949 * @name Frame-level threading support functions
2953 * If defined, called on thread contexts when they are created.
2954 * If the codec allocates writable tables in init(), re-allocate them here.
2955 * priv_data will be set to a copy of the original.
2957 int (*init_thread_copy)(AVCodecContext *);
2959 * Copy necessary context variables from a previous thread context to the current one.
2960 * If not defined, the next thread will start automatically; otherwise, the codec
2961 * must call ff_thread_finish_setup().
2963 * dst and src will (rarely) point to the same context, in which case memcpy should be skipped.
2965 int (*update_thread_context)(AVCodecContext *dst, const AVCodecContext *src);
2969 * Private codec-specific defaults.
2971 const AVCodecDefault *defaults;
2974 * Initialize codec static data, called from avcodec_register().
2976 void (*init_static_data)(struct AVCodec *codec);
2978 int (*init)(AVCodecContext *);
2979 int (*encode_sub)(AVCodecContext *, uint8_t *buf, int buf_size,
2980 const struct AVSubtitle *sub);
2982 * Encode data to an AVPacket.
2984 * @param avctx codec context
2985 * @param avpkt output AVPacket (may contain a user-provided buffer)
2986 * @param[in] frame AVFrame containing the raw data to be encoded
2987 * @param[out] got_packet_ptr encoder sets to 0 or 1 to indicate that a
2988 * non-empty packet was returned in avpkt.
2989 * @return 0 on success, negative error code on failure
2991 int (*encode2)(AVCodecContext *avctx, AVPacket *avpkt, const AVFrame *frame,
2992 int *got_packet_ptr);
2993 int (*decode)(AVCodecContext *, void *outdata, int *outdata_size, AVPacket *avpkt);
2994 int (*close)(AVCodecContext *);
2997 * Will be called when seeking
2999 void (*flush)(AVCodecContext *);
3005 typedef struct AVHWAccel {
3007 * Name of the hardware accelerated codec.
3008 * The name is globally unique among encoders and among decoders (but an
3009 * encoder and a decoder can share the same name).
3014 * Type of codec implemented by the hardware accelerator.
3016 * See AVMEDIA_TYPE_xxx
3018 enum AVMediaType type;
3021 * Codec implemented by the hardware accelerator.
3023 * See AV_CODEC_ID_xxx
3028 * Supported pixel format.
3030 * Only hardware accelerated formats are supported here.
3032 enum PixelFormat pix_fmt;
3035 * Hardware accelerated codec capabilities.
3036 * see FF_HWACCEL_CODEC_CAP_*
3040 struct AVHWAccel *next;
3043 * Called at the beginning of each frame or field picture.
3045 * Meaningful frame information (codec specific) is guaranteed to
3046 * be parsed at this point. This function is mandatory.
3048 * Note that buf can be NULL along with buf_size set to 0.
3049 * Otherwise, this means the whole frame is available at this point.
3051 * @param avctx the codec context
3052 * @param buf the frame data buffer base
3053 * @param buf_size the size of the frame in bytes
3054 * @return zero if successful, a negative value otherwise
3056 int (*start_frame)(AVCodecContext *avctx, const uint8_t *buf, uint32_t buf_size);
3059 * Callback for each slice.
3061 * Meaningful slice information (codec specific) is guaranteed to
3062 * be parsed at this point. This function is mandatory.
3064 * @param avctx the codec context
3065 * @param buf the slice data buffer base
3066 * @param buf_size the size of the slice in bytes
3067 * @return zero if successful, a negative value otherwise
3069 int (*decode_slice)(AVCodecContext *avctx, const uint8_t *buf, uint32_t buf_size);
3072 * Called at the end of each frame or field picture.
3074 * The whole picture is parsed at this point and can now be sent
3075 * to the hardware accelerator. This function is mandatory.
3077 * @param avctx the codec context
3078 * @return zero if successful, a negative value otherwise
3080 int (*end_frame)(AVCodecContext *avctx);
3083 * Size of HW accelerator private data.
3085 * Private data is allocated with av_mallocz() before
3086 * AVCodecContext.get_buffer() and deallocated after
3087 * AVCodecContext.release_buffer().
3093 * @defgroup lavc_picture AVPicture
3095 * Functions for working with AVPicture
3100 * four components are given, that's all.
3101 * the last component is alpha
3103 typedef struct AVPicture {
3104 uint8_t *data[AV_NUM_DATA_POINTERS];
3105 int linesize[AV_NUM_DATA_POINTERS]; ///< number of bytes per line
3112 #define AVPALETTE_SIZE 1024
3113 #define AVPALETTE_COUNT 256
3115 enum AVSubtitleType {
3118 SUBTITLE_BITMAP, ///< A bitmap, pict will be set
3121 * Plain text, the text field must be set by the decoder and is
3122 * authoritative. ass and pict fields may contain approximations.
3127 * Formatted text, the ass field must be set by the decoder and is
3128 * authoritative. pict and text fields may contain approximations.
3133 typedef struct AVSubtitleRect {
3134 int x; ///< top left corner of pict, undefined when pict is not set
3135 int y; ///< top left corner of pict, undefined when pict is not set
3136 int w; ///< width of pict, undefined when pict is not set
3137 int h; ///< height of pict, undefined when pict is not set
3138 int nb_colors; ///< number of colors in pict, undefined when pict is not set
3141 * data+linesize for the bitmap of this subtitle.
3142 * can be set for text/ass as well once they where rendered
3145 enum AVSubtitleType type;
3147 char *text; ///< 0 terminated plain UTF-8 text
3150 * 0 terminated ASS/SSA compatible event line.
3151 * The pressentation of this is unaffected by the other values in this
3157 typedef struct AVSubtitle {
3158 uint16_t format; /* 0 = graphics */
3159 uint32_t start_display_time; /* relative to packet pts, in ms */
3160 uint32_t end_display_time; /* relative to packet pts, in ms */
3162 AVSubtitleRect **rects;
3163 int64_t pts; ///< Same as packet pts, in AV_TIME_BASE
3167 * If c is NULL, returns the first registered codec,
3168 * if c is non-NULL, returns the next registered codec after c,
3169 * or NULL if c is the last one.
3171 AVCodec *av_codec_next(const AVCodec *c);
3174 * Return the LIBAVCODEC_VERSION_INT constant.
3176 unsigned avcodec_version(void);
3179 * Return the libavcodec build-time configuration.
3181 const char *avcodec_configuration(void);
3184 * Return the libavcodec license.
3186 const char *avcodec_license(void);
3189 * Register the codec codec and initialize libavcodec.
3191 * @warning either this function or avcodec_register_all() must be called
3192 * before any other libavcodec functions.
3194 * @see avcodec_register_all()
3196 void avcodec_register(AVCodec *codec);
3199 * Register all the codecs, parsers and bitstream filters which were enabled at
3200 * configuration time. If you do not call this function you can select exactly
3201 * which formats you want to support, by using the individual registration
3204 * @see avcodec_register
3205 * @see av_register_codec_parser
3206 * @see av_register_bitstream_filter
3208 void avcodec_register_all(void);
3211 * Allocate an AVCodecContext and set its fields to default values. The
3212 * resulting struct can be deallocated by calling avcodec_close() on it followed
3215 * @param codec if non-NULL, allocate private data and initialize defaults
3216 * for the given codec. It is illegal to then call avcodec_open2()
3217 * with a different codec.
3218 * If NULL, then the codec-specific defaults won't be initialized,
3219 * which may result in suboptimal default settings (this is
3220 * important mainly for encoders, e.g. libx264).
3222 * @return An AVCodecContext filled with default values or NULL on failure.
3223 * @see avcodec_get_context_defaults
3225 AVCodecContext *avcodec_alloc_context3(const AVCodec *codec);
3228 * Set the fields of the given AVCodecContext to default values corresponding
3229 * to the given codec (defaults may be codec-dependent).
3231 * Do not call this function if a non-NULL codec has been passed
3232 * to avcodec_alloc_context3() that allocated this AVCodecContext.
3233 * If codec is non-NULL, it is illegal to call avcodec_open2() with a
3234 * different codec on this AVCodecContext.
3236 int avcodec_get_context_defaults3(AVCodecContext *s, const AVCodec *codec);
3239 * Get the AVClass for AVCodecContext. It can be used in combination with
3240 * AV_OPT_SEARCH_FAKE_OBJ for examining options.
3242 * @see av_opt_find().
3244 const AVClass *avcodec_get_class(void);
3247 * Copy the settings of the source AVCodecContext into the destination
3248 * AVCodecContext. The resulting destination codec context will be
3249 * unopened, i.e. you are required to call avcodec_open2() before you
3250 * can use this AVCodecContext to decode/encode video/audio data.
3252 * @param dest target codec context, should be initialized with
3253 * avcodec_alloc_context3(), but otherwise uninitialized
3254 * @param src source codec context
3255 * @return AVERROR() on error (e.g. memory allocation error), 0 on success
3257 int avcodec_copy_context(AVCodecContext *dest, const AVCodecContext *src);
3260 * Allocate an AVFrame and set its fields to default values. The resulting
3261 * struct must be freed using avcodec_free_frame().
3263 * @return An AVFrame filled with default values or NULL on failure.
3264 * @see avcodec_get_frame_defaults
3266 AVFrame *avcodec_alloc_frame(void);
3269 * Set the fields of the given AVFrame to default values.
3271 * @param frame The AVFrame of which the fields should be set to default values.
3273 void avcodec_get_frame_defaults(AVFrame *frame);
3276 * Free the frame and any dynamically allocated objects in it,
3277 * e.g. extended_data.
3279 * @param frame frame to be freed. The pointer will be set to NULL.
3281 * @warning this function does NOT free the data buffers themselves
3282 * (it does not know how, since they might have been allocated with
3283 * a custom get_buffer()).
3285 void avcodec_free_frame(AVFrame **frame);
3288 * Initialize the AVCodecContext to use the given AVCodec. Prior to using this
3289 * function the context has to be allocated with avcodec_alloc_context3().
3291 * The functions avcodec_find_decoder_by_name(), avcodec_find_encoder_by_name(),
3292 * avcodec_find_decoder() and avcodec_find_encoder() provide an easy way for
3293 * retrieving a codec.
3295 * @warning This function is not thread safe!
3298 * avcodec_register_all();
3299 * av_dict_set(&opts, "b", "2.5M", 0);
3300 * codec = avcodec_find_decoder(AV_CODEC_ID_H264);
3304 * context = avcodec_alloc_context3(codec);
3306 * if (avcodec_open2(context, codec, opts) < 0)
3310 * @param avctx The context to initialize.
3311 * @param codec The codec to open this context for. If a non-NULL codec has been
3312 * previously passed to avcodec_alloc_context3() or
3313 * avcodec_get_context_defaults3() for this context, then this
3314 * parameter MUST be either NULL or equal to the previously passed
3316 * @param options A dictionary filled with AVCodecContext and codec-private options.
3317 * On return this object will be filled with options that were not found.
3319 * @return zero on success, a negative value on error
3320 * @see avcodec_alloc_context3(), avcodec_find_decoder(), avcodec_find_encoder(),
3321 * av_dict_set(), av_opt_find().
3323 int avcodec_open2(AVCodecContext *avctx, const AVCodec *codec, AVDictionary **options);
3326 * Close a given AVCodecContext and free all the data associated with it
3327 * (but not the AVCodecContext itself).
3329 * Calling this function on an AVCodecContext that hasn't been opened will free
3330 * the codec-specific data allocated in avcodec_alloc_context3() /
3331 * avcodec_get_context_defaults3() with a non-NULL codec. Subsequent calls will
3334 int avcodec_close(AVCodecContext *avctx);
3337 * Free all allocated data in the given subtitle struct.
3339 * @param sub AVSubtitle to free.
3341 void avsubtitle_free(AVSubtitle *sub);
3348 * @addtogroup lavc_packet
3353 * Default packet destructor.
3355 void av_destruct_packet(AVPacket *pkt);
3358 * Initialize optional fields of a packet with default values.
3360 * Note, this does not touch the data and size members, which have to be
3361 * initialized separately.
3365 void av_init_packet(AVPacket *pkt);
3368 * Allocate the payload of a packet and initialize its fields with
3372 * @param size wanted payload size
3373 * @return 0 if OK, AVERROR_xxx otherwise
3375 int av_new_packet(AVPacket *pkt, int size);
3378 * Reduce packet size, correctly zeroing padding
3381 * @param size new size
3383 void av_shrink_packet(AVPacket *pkt, int size);
3386 * Increase packet size, correctly zeroing padding
3389 * @param grow_by number of bytes by which to increase the size of the packet
3391 int av_grow_packet(AVPacket *pkt, int grow_by);
3394 * @warning This is a hack - the packet memory allocation stuff is broken. The
3395 * packet is allocated if it was not really allocated.
3397 int av_dup_packet(AVPacket *pkt);
3402 * @param pkt packet to free
3404 void av_free_packet(AVPacket *pkt);
3407 * Allocate new information of a packet.
3410 * @param type side information type
3411 * @param size side information size
3412 * @return pointer to fresh allocated data or NULL otherwise
3414 uint8_t* av_packet_new_side_data(AVPacket *pkt, enum AVPacketSideDataType type,
3418 * Shrink the already allocated side data buffer
3421 * @param type side information type
3422 * @param size new side information size
3423 * @return 0 on success, < 0 on failure
3425 int av_packet_shrink_side_data(AVPacket *pkt, enum AVPacketSideDataType type,
3429 * Get side information from packet.
3432 * @param type desired side information type
3433 * @param size pointer for side information size to store (optional)
3434 * @return pointer to data if present or NULL otherwise
3436 uint8_t* av_packet_get_side_data(AVPacket *pkt, enum AVPacketSideDataType type,
3444 * @addtogroup lavc_decoding
3449 * Find a registered decoder with a matching codec ID.
3451 * @param id AVCodecID of the requested decoder
3452 * @return A decoder if one was found, NULL otherwise.
3454 AVCodec *avcodec_find_decoder(enum AVCodecID id);
3457 * Find a registered decoder with the specified name.
3459 * @param name name of the requested decoder
3460 * @return A decoder if one was found, NULL otherwise.
3462 AVCodec *avcodec_find_decoder_by_name(const char *name);
3464 int avcodec_default_get_buffer(AVCodecContext *s, AVFrame *pic);
3465 void avcodec_default_release_buffer(AVCodecContext *s, AVFrame *pic);
3466 int avcodec_default_reget_buffer(AVCodecContext *s, AVFrame *pic);
3469 * Return the amount of padding in pixels which the get_buffer callback must
3470 * provide around the edge of the image for codecs which do not have the
3471 * CODEC_FLAG_EMU_EDGE flag.
3473 * @return Required padding in pixels.
3475 unsigned avcodec_get_edge_width(void);
3478 * Modify width and height values so that they will result in a memory
3479 * buffer that is acceptable for the codec if you do not use any horizontal
3482 * May only be used if a codec with CODEC_CAP_DR1 has been opened.
3483 * If CODEC_FLAG_EMU_EDGE is not set, the dimensions must have been increased
3484 * according to avcodec_get_edge_width() before.
3486 void avcodec_align_dimensions(AVCodecContext *s, int *width, int *height);
3489 * Modify width and height values so that they will result in a memory
3490 * buffer that is acceptable for the codec if you also ensure that all
3491 * line sizes are a multiple of the respective linesize_align[i].
3493 * May only be used if a codec with CODEC_CAP_DR1 has been opened.
3494 * If CODEC_FLAG_EMU_EDGE is not set, the dimensions must have been increased
3495 * according to avcodec_get_edge_width() before.
3497 void avcodec_align_dimensions2(AVCodecContext *s, int *width, int *height,
3498 int linesize_align[AV_NUM_DATA_POINTERS]);
3500 #if FF_API_OLD_DECODE_AUDIO
3502 * Wrapper function which calls avcodec_decode_audio4.
3504 * @deprecated Use avcodec_decode_audio4 instead.
3506 * Decode the audio frame of size avpkt->size from avpkt->data into samples.
3507 * Some decoders may support multiple frames in a single AVPacket, such
3508 * decoders would then just decode the first frame. In this case,
3509 * avcodec_decode_audio3 has to be called again with an AVPacket that contains
3510 * the remaining data in order to decode the second frame etc.
3512 * could be outputted, frame_size_ptr is zero. Otherwise, it is the
3513 * decompressed frame size in bytes.
3515 * @warning You must set frame_size_ptr to the allocated size of the
3516 * output buffer before calling avcodec_decode_audio3().
3518 * @warning The input buffer must be FF_INPUT_BUFFER_PADDING_SIZE larger than
3519 * the actual read bytes because some optimized bitstream readers read 32 or 64
3520 * bits at once and could read over the end.
3522 * @warning The end of the input buffer avpkt->data should be set to 0 to ensure that
3523 * no overreading happens for damaged MPEG streams.
3525 * @warning You must not provide a custom get_buffer() when using
3526 * avcodec_decode_audio3(). Doing so will override it with
3527 * avcodec_default_get_buffer. Use avcodec_decode_audio4() instead,
3528 * which does allow the application to provide a custom get_buffer().
3530 * @note You might have to align the input buffer avpkt->data and output buffer
3531 * samples. The alignment requirements depend on the CPU: On some CPUs it isn't
3532 * necessary at all, on others it won't work at all if not aligned and on others
3533 * it will work but it will have an impact on performance.
3535 * In practice, avpkt->data should have 4 byte alignment at minimum and
3536 * samples should be 16 byte aligned unless the CPU doesn't need it
3537 * (AltiVec and SSE do).
3539 * @note Codecs which have the CODEC_CAP_DELAY capability set have a delay
3540 * between input and output, these need to be fed with avpkt->data=NULL,
3541 * avpkt->size=0 at the end to return the remaining frames.
3543 * @param avctx the codec context
3544 * @param[out] samples the output buffer, sample type in avctx->sample_fmt
3545 * If the sample format is planar, each channel plane will
3546 * be the same size, with no padding between channels.
3547 * @param[in,out] frame_size_ptr the output buffer size in bytes
3548 * @param[in] avpkt The input AVPacket containing the input buffer.
3549 * You can create such packet with av_init_packet() and by then setting
3550 * data and size, some decoders might in addition need other fields.
3551 * All decoders are designed to use the least fields possible though.
3552 * @return On error a negative value is returned, otherwise the number of bytes
3553 * used or zero if no frame data was decompressed (used) from the input AVPacket.
3555 attribute_deprecated int avcodec_decode_audio3(AVCodecContext *avctx, int16_t *samples,
3556 int *frame_size_ptr,
3561 * Decode the audio frame of size avpkt->size from avpkt->data into frame.
3563 * Some decoders may support multiple frames in a single AVPacket. Such
3564 * decoders would then just decode the first frame. In this case,
3565 * avcodec_decode_audio4 has to be called again with an AVPacket containing
3566 * the remaining data in order to decode the second frame, etc...
3567 * Even if no frames are returned, the packet needs to be fed to the decoder
3568 * with remaining data until it is completely consumed or an error occurs.
3570 * @warning The input buffer, avpkt->data must be FF_INPUT_BUFFER_PADDING_SIZE
3571 * larger than the actual read bytes because some optimized bitstream
3572 * readers read 32 or 64 bits at once and could read over the end.
3574 * @note You might have to align the input buffer. The alignment requirements
3575 * depend on the CPU and the decoder.
3577 * @param avctx the codec context
3578 * @param[out] frame The AVFrame in which to store decoded audio samples.
3579 * Decoders request a buffer of a particular size by setting
3580 * AVFrame.nb_samples prior to calling get_buffer(). The
3581 * decoder may, however, only utilize part of the buffer by
3582 * setting AVFrame.nb_samples to a smaller value in the
3584 * @param[out] got_frame_ptr Zero if no frame could be decoded, otherwise it is
3586 * @param[in] avpkt The input AVPacket containing the input buffer.
3587 * At least avpkt->data and avpkt->size should be set. Some
3588 * decoders might also require additional fields to be set.
3589 * @return A negative error code is returned if an error occurred during
3590 * decoding, otherwise the number of bytes consumed from the input
3591 * AVPacket is returned.
3593 int avcodec_decode_audio4(AVCodecContext *avctx, AVFrame *frame,
3594 int *got_frame_ptr, AVPacket *avpkt);
3597 * Decode the video frame of size avpkt->size from avpkt->data into picture.
3598 * Some decoders may support multiple frames in a single AVPacket, such
3599 * decoders would then just decode the first frame.
3601 * @warning The input buffer must be FF_INPUT_BUFFER_PADDING_SIZE larger than
3602 * the actual read bytes because some optimized bitstream readers read 32 or 64
3603 * bits at once and could read over the end.
3605 * @warning The end of the input buffer buf should be set to 0 to ensure that
3606 * no overreading happens for damaged MPEG streams.
3608 * @note You might have to align the input buffer avpkt->data.
3609 * The alignment requirements depend on the CPU: on some CPUs it isn't
3610 * necessary at all, on others it won't work at all if not aligned and on others
3611 * it will work but it will have an impact on performance.
3613 * In practice, avpkt->data should have 4 byte alignment at minimum.
3615 * @note Codecs which have the CODEC_CAP_DELAY capability set have a delay
3616 * between input and output, these need to be fed with avpkt->data=NULL,
3617 * avpkt->size=0 at the end to return the remaining frames.
3619 * @param avctx the codec context
3620 * @param[out] picture The AVFrame in which the decoded video frame will be stored.
3621 * Use avcodec_alloc_frame to get an AVFrame, the codec will
3622 * allocate memory for the actual bitmap.
3623 * with default get/release_buffer(), the decoder frees/reuses the bitmap as it sees fit.
3624 * with overridden get/release_buffer() (needs CODEC_CAP_DR1) the user decides into what buffer the decoder
3625 * decodes and the decoder tells the user once it does not need the data anymore,
3626 * the user app can at this point free/reuse/keep the memory as it sees fit.
3628 * @param[in] avpkt The input AVpacket containing the input buffer.
3629 * You can create such packet with av_init_packet() and by then setting
3630 * data and size, some decoders might in addition need other fields like
3631 * flags&AV_PKT_FLAG_KEY. All decoders are designed to use the least
3633 * @param[in,out] got_picture_ptr Zero if no frame could be decompressed, otherwise, it is nonzero.
3634 * @return On error a negative value is returned, otherwise the number of bytes
3635 * used or zero if no frame could be decompressed.
3637 int avcodec_decode_video2(AVCodecContext *avctx, AVFrame *picture,
3638 int *got_picture_ptr,
3642 * Decode a subtitle message.
3643 * Return a negative value on error, otherwise return the number of bytes used.
3644 * If no subtitle could be decompressed, got_sub_ptr is zero.
3645 * Otherwise, the subtitle is stored in *sub.
3646 * Note that CODEC_CAP_DR1 is not available for subtitle codecs. This is for
3647 * simplicity, because the performance difference is expect to be negligible
3648 * and reusing a get_buffer written for video codecs would probably perform badly
3649 * due to a potentially very different allocation pattern.
3651 * @param avctx the codec context
3652 * @param[out] sub The AVSubtitle in which the decoded subtitle will be stored, must be
3653 freed with avsubtitle_free if *got_sub_ptr is set.
3654 * @param[in,out] got_sub_ptr Zero if no subtitle could be decompressed, otherwise, it is nonzero.
3655 * @param[in] avpkt The input AVPacket containing the input buffer.
3657 int avcodec_decode_subtitle2(AVCodecContext *avctx, AVSubtitle *sub,
3662 * @defgroup lavc_parsing Frame parsing
3666 typedef struct AVCodecParserContext {
3668 struct AVCodecParser *parser;
3669 int64_t frame_offset; /* offset of the current frame */
3670 int64_t cur_offset; /* current offset
3671 (incremented by each av_parser_parse()) */
3672 int64_t next_frame_offset; /* offset of the next frame */
3674 int pict_type; /* XXX: Put it back in AVCodecContext. */
3676 * This field is used for proper frame duration computation in lavf.
3677 * It signals, how much longer the frame duration of the current frame
3678 * is compared to normal frame duration.
3680 * frame_duration = (1 + repeat_pict) * time_base
3682 * It is used by codecs like H.264 to display telecined material.
3684 int repeat_pict; /* XXX: Put it back in AVCodecContext. */
3685 int64_t pts; /* pts of the current frame */
3686 int64_t dts; /* dts of the current frame */
3691 int fetch_timestamp;
3693 #define AV_PARSER_PTS_NB 4
3694 int cur_frame_start_index;
3695 int64_t cur_frame_offset[AV_PARSER_PTS_NB];
3696 int64_t cur_frame_pts[AV_PARSER_PTS_NB];
3697 int64_t cur_frame_dts[AV_PARSER_PTS_NB];
3700 #define PARSER_FLAG_COMPLETE_FRAMES 0x0001
3701 #define PARSER_FLAG_ONCE 0x0002
3702 /// Set if the parser has a valid file offset
3703 #define PARSER_FLAG_FETCHED_OFFSET 0x0004
3705 int64_t offset; ///< byte offset from starting packet start
3706 int64_t cur_frame_end[AV_PARSER_PTS_NB];
3709 * Set by parser to 1 for key frames and 0 for non-key frames.
3710 * It is initialized to -1, so if the parser doesn't set this flag,
3711 * old-style fallback using AV_PICTURE_TYPE_I picture type as key frames
3717 * Time difference in stream time base units from the pts of this
3718 * packet to the point at which the output from the decoder has converged
3719 * independent from the availability of previous frames. That is, the
3720 * frames are virtually identical no matter if decoding started from
3721 * the very first frame or from this keyframe.
3722 * Is AV_NOPTS_VALUE if unknown.
3723 * This field is not the display duration of the current frame.
3724 * This field has no meaning if the packet does not have AV_PKT_FLAG_KEY
3727 * The purpose of this field is to allow seeking in streams that have no
3728 * keyframes in the conventional sense. It corresponds to the
3729 * recovery point SEI in H.264 and match_time_delta in NUT. It is also
3730 * essential for some types of subtitle streams to ensure that all
3731 * subtitles are correctly displayed after seeking.
3733 int64_t convergence_duration;
3735 // Timestamp generation support:
3737 * Synchronization point for start of timestamp generation.
3739 * Set to >0 for sync point, 0 for no sync point and <0 for undefined
3742 * For example, this corresponds to presence of H.264 buffering period
3748 * Offset of the current timestamp against last timestamp sync point in
3749 * units of AVCodecContext.time_base.
3751 * Set to INT_MIN when dts_sync_point unused. Otherwise, it must
3752 * contain a valid timestamp offset.
3754 * Note that the timestamp of sync point has usually a nonzero
3755 * dts_ref_dts_delta, which refers to the previous sync point. Offset of
3756 * the next frame after timestamp sync point will be usually 1.
3758 * For example, this corresponds to H.264 cpb_removal_delay.
3760 int dts_ref_dts_delta;
3763 * Presentation delay of current frame in units of AVCodecContext.time_base.
3765 * Set to INT_MIN when dts_sync_point unused. Otherwise, it must
3766 * contain valid non-negative timestamp delta (presentation time of a frame
3767 * must not lie in the past).
3769 * This delay represents the difference between decoding and presentation
3770 * time of the frame.
3772 * For example, this corresponds to H.264 dpb_output_delay.
3777 * Position of the packet in file.
3779 * Analogous to cur_frame_pts/dts
3781 int64_t cur_frame_pos[AV_PARSER_PTS_NB];
3784 * Byte position of currently parsed frame in stream.
3789 * Previous frame byte position.
3794 * Duration of the current frame.
3795 * For audio, this is in units of 1 / AVCodecContext.sample_rate.
3796 * For all other types, this is in units of AVCodecContext.time_base.
3799 } AVCodecParserContext;
3801 typedef struct AVCodecParser {
3802 int codec_ids[5]; /* several codec IDs are permitted */
3804 int (*parser_init)(AVCodecParserContext *s);
3805 int (*parser_parse)(AVCodecParserContext *s,
3806 AVCodecContext *avctx,
3807 const uint8_t **poutbuf, int *poutbuf_size,
3808 const uint8_t *buf, int buf_size);
3809 void (*parser_close)(AVCodecParserContext *s);
3810 int (*split)(AVCodecContext *avctx, const uint8_t *buf, int buf_size);
3811 struct AVCodecParser *next;
3814 AVCodecParser *av_parser_next(AVCodecParser *c);
3816 void av_register_codec_parser(AVCodecParser *parser);
3817 AVCodecParserContext *av_parser_init(int codec_id);
3822 * @param s parser context.
3823 * @param avctx codec context.
3824 * @param poutbuf set to pointer to parsed buffer or NULL if not yet finished.
3825 * @param poutbuf_size set to size of parsed buffer or zero if not yet finished.
3826 * @param buf input buffer.
3827 * @param buf_size input length, to signal EOF, this should be 0 (so that the last frame can be output).
3828 * @param pts input presentation timestamp.
3829 * @param dts input decoding timestamp.
3830 * @param pos input byte position in stream.
3831 * @return the number of bytes of the input bitstream used.
3836 * len = av_parser_parse2(myparser, AVCodecContext, &data, &size,
3843 * decode_frame(data, size);
3847 int av_parser_parse2(AVCodecParserContext *s,
3848 AVCodecContext *avctx,
3849 uint8_t **poutbuf, int *poutbuf_size,
3850 const uint8_t *buf, int buf_size,
3851 int64_t pts, int64_t dts,
3854 int av_parser_change(AVCodecParserContext *s,
3855 AVCodecContext *avctx,
3856 uint8_t **poutbuf, int *poutbuf_size,
3857 const uint8_t *buf, int buf_size, int keyframe);
3858 void av_parser_close(AVCodecParserContext *s);
3866 * @addtogroup lavc_encoding
3871 * Find a registered encoder with a matching codec ID.
3873 * @param id AVCodecID of the requested encoder
3874 * @return An encoder if one was found, NULL otherwise.
3876 AVCodec *avcodec_find_encoder(enum AVCodecID id);
3879 * Find a registered encoder with the specified name.
3881 * @param name name of the requested encoder
3882 * @return An encoder if one was found, NULL otherwise.
3884 AVCodec *avcodec_find_encoder_by_name(const char *name);
3886 #if FF_API_OLD_ENCODE_AUDIO
3888 * Encode an audio frame from samples into buf.
3890 * @deprecated Use avcodec_encode_audio2 instead.
3892 * @note The output buffer should be at least FF_MIN_BUFFER_SIZE bytes large.
3893 * However, for codecs with avctx->frame_size equal to 0 (e.g. PCM) the user
3894 * will know how much space is needed because it depends on the value passed
3895 * in buf_size as described below. In that case a lower value can be used.
3897 * @param avctx the codec context
3898 * @param[out] buf the output buffer
3899 * @param[in] buf_size the output buffer size
3900 * @param[in] samples the input buffer containing the samples
3901 * The number of samples read from this buffer is frame_size*channels,
3902 * both of which are defined in avctx.
3903 * For codecs which have avctx->frame_size equal to 0 (e.g. PCM) the number of
3904 * samples read from samples is equal to:
3905 * buf_size * 8 / (avctx->channels * av_get_bits_per_sample(avctx->codec_id))
3906 * This also implies that av_get_bits_per_sample() must not return 0 for these
3908 * @return On error a negative value is returned, on success zero or the number
3909 * of bytes used to encode the data read from the input buffer.
3911 int attribute_deprecated avcodec_encode_audio(AVCodecContext *avctx,
3912 uint8_t *buf, int buf_size,
3913 const short *samples);
3917 * Encode a frame of audio.
3919 * Takes input samples from frame and writes the next output packet, if
3920 * available, to avpkt. The output packet does not necessarily contain data for
3921 * the most recent frame, as encoders can delay, split, and combine input frames
3922 * internally as needed.
3924 * @param avctx codec context
3925 * @param avpkt output AVPacket.
3926 * The user can supply an output buffer by setting
3927 * avpkt->data and avpkt->size prior to calling the
3928 * function, but if the size of the user-provided data is not
3929 * large enough, encoding will fail. All other AVPacket fields
3930 * will be reset by the encoder using av_init_packet(). If
3931 * avpkt->data is NULL, the encoder will allocate it.
3932 * The encoder will set avpkt->size to the size of the
3935 * If this function fails or produces no output, avpkt will be
3936 * freed using av_free_packet() (i.e. avpkt->destruct will be
3937 * called to free the user supplied buffer).
3938 * @param[in] frame AVFrame containing the raw audio data to be encoded.
3939 * May be NULL when flushing an encoder that has the
3940 * CODEC_CAP_DELAY capability set.
3941 * If CODEC_CAP_VARIABLE_FRAME_SIZE is set, then each frame
3942 * can have any number of samples.
3943 * If it is not set, frame->nb_samples must be equal to
3944 * avctx->frame_size for all frames except the last.
3945 * The final frame may be smaller than avctx->frame_size.
3946 * @param[out] got_packet_ptr This field is set to 1 by libavcodec if the
3947 * output packet is non-empty, and to 0 if it is
3948 * empty. If the function returns an error, the
3949 * packet can be assumed to be invalid, and the
3950 * value of got_packet_ptr is undefined and should
3952 * @return 0 on success, negative error code on failure
3954 int avcodec_encode_audio2(AVCodecContext *avctx, AVPacket *avpkt,
3955 const AVFrame *frame, int *got_packet_ptr);
3957 #if FF_API_OLD_ENCODE_VIDEO
3959 * @deprecated use avcodec_encode_video2() instead.
3961 * Encode a video frame from pict into buf.
3962 * The input picture should be
3963 * stored using a specific format, namely avctx.pix_fmt.
3965 * @param avctx the codec context
3966 * @param[out] buf the output buffer for the bitstream of encoded frame
3967 * @param[in] buf_size the size of the output buffer in bytes
3968 * @param[in] pict the input picture to encode
3969 * @return On error a negative value is returned, on success zero or the number
3970 * of bytes used from the output buffer.
3972 attribute_deprecated
3973 int avcodec_encode_video(AVCodecContext *avctx, uint8_t *buf, int buf_size,
3974 const AVFrame *pict);
3978 * Encode a frame of video.
3980 * Takes input raw video data from frame and writes the next output packet, if
3981 * available, to avpkt. The output packet does not necessarily contain data for
3982 * the most recent frame, as encoders can delay and reorder input frames
3983 * internally as needed.
3985 * @param avctx codec context
3986 * @param avpkt output AVPacket.
3987 * The user can supply an output buffer by setting
3988 * avpkt->data and avpkt->size prior to calling the
3989 * function, but if the size of the user-provided data is not
3990 * large enough, encoding will fail. All other AVPacket fields
3991 * will be reset by the encoder using av_init_packet(). If
3992 * avpkt->data is NULL, the encoder will allocate it.
3993 * The encoder will set avpkt->size to the size of the
3994 * output packet. The returned data (if any) belongs to the
3995 * caller, he is responsible for freeing it.
3997 * If this function fails or produces no output, avpkt will be
3998 * freed using av_free_packet() (i.e. avpkt->destruct will be
3999 * called to free the user supplied buffer).
4000 * @param[in] frame AVFrame containing the raw video data to be encoded.
4001 * May be NULL when flushing an encoder that has the
4002 * CODEC_CAP_DELAY capability set.
4003 * @param[out] got_packet_ptr This field is set to 1 by libavcodec if the
4004 * output packet is non-empty, and to 0 if it is
4005 * empty. If the function returns an error, the
4006 * packet can be assumed to be invalid, and the
4007 * value of got_packet_ptr is undefined and should
4009 * @return 0 on success, negative error code on failure
4011 int avcodec_encode_video2(AVCodecContext *avctx, AVPacket *avpkt,
4012 const AVFrame *frame, int *got_packet_ptr);
4014 int avcodec_encode_subtitle(AVCodecContext *avctx, uint8_t *buf, int buf_size,
4015 const AVSubtitle *sub);
4023 * @defgroup lavc_resample Audio resampling
4028 struct ReSampleContext;
4029 struct AVResampleContext;
4031 typedef struct ReSampleContext ReSampleContext;
4034 * Initialize audio resampling context.
4036 * @param output_channels number of output channels
4037 * @param input_channels number of input channels
4038 * @param output_rate output sample rate
4039 * @param input_rate input sample rate
4040 * @param sample_fmt_out requested output sample format
4041 * @param sample_fmt_in input sample format
4042 * @param filter_length length of each FIR filter in the filterbank relative to the cutoff frequency
4043 * @param log2_phase_count log2 of the number of entries in the polyphase filterbank
4044 * @param linear if 1 then the used FIR filter will be linearly interpolated
4045 between the 2 closest, if 0 the closest will be used
4046 * @param cutoff cutoff frequency, 1.0 corresponds to half the output sampling rate
4047 * @return allocated ReSampleContext, NULL if error occurred
4049 ReSampleContext *av_audio_resample_init(int output_channels, int input_channels,
4050 int output_rate, int input_rate,
4051 enum AVSampleFormat sample_fmt_out,
4052 enum AVSampleFormat sample_fmt_in,
4053 int filter_length, int log2_phase_count,
4054 int linear, double cutoff);
4056 int audio_resample(ReSampleContext *s, short *output, short *input, int nb_samples);
4059 * Free resample context.
4061 * @param s a non-NULL pointer to a resample context previously
4062 * created with av_audio_resample_init()
4064 void audio_resample_close(ReSampleContext *s);
4068 * Initialize an audio resampler.
4069 * Note, if either rate is not an integer then simply scale both rates up so they are.
4070 * @param filter_length length of each FIR filter in the filterbank relative to the cutoff freq
4071 * @param log2_phase_count log2 of the number of entries in the polyphase filterbank
4072 * @param linear If 1 then the used FIR filter will be linearly interpolated
4073 between the 2 closest, if 0 the closest will be used
4074 * @param cutoff cutoff frequency, 1.0 corresponds to half the output sampling rate
4076 struct AVResampleContext *av_resample_init(int out_rate, int in_rate, int filter_length, int log2_phase_count, int linear, double cutoff);
4079 * Resample an array of samples using a previously configured context.
4080 * @param src an array of unconsumed samples
4081 * @param consumed the number of samples of src which have been consumed are returned here
4082 * @param src_size the number of unconsumed samples available
4083 * @param dst_size the amount of space in samples available in dst
4084 * @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.
4085 * @return the number of samples written in dst or -1 if an error occurred
4087 int av_resample(struct AVResampleContext *c, short *dst, short *src, int *consumed, int src_size, int dst_size, int update_ctx);
4091 * Compensate samplerate/timestamp drift. The compensation is done by changing
4092 * the resampler parameters, so no audible clicks or similar distortions occur
4093 * @param compensation_distance distance in output samples over which the compensation should be performed
4094 * @param sample_delta number of output samples which should be output less
4096 * example: av_resample_compensate(c, 10, 500)
4097 * here instead of 510 samples only 500 samples would be output
4099 * note, due to rounding the actual compensation might be slightly different,
4100 * especially if the compensation_distance is large and the in_rate used during init is small
4102 void av_resample_compensate(struct AVResampleContext *c, int sample_delta, int compensation_distance);
4103 void av_resample_close(struct AVResampleContext *c);
4110 * @addtogroup lavc_picture
4115 * Allocate memory for a picture. Call avpicture_free() to free it.
4117 * @see avpicture_fill()
4119 * @param picture the picture to be filled in
4120 * @param pix_fmt the format of the picture
4121 * @param width the width of the picture
4122 * @param height the height of the picture
4123 * @return zero if successful, a negative value if not
4125 int avpicture_alloc(AVPicture *picture, enum PixelFormat pix_fmt, int width, int height);
4128 * Free a picture previously allocated by avpicture_alloc().
4129 * The data buffer used by the AVPicture is freed, but the AVPicture structure
4132 * @param picture the AVPicture to be freed
4134 void avpicture_free(AVPicture *picture);
4137 * Fill in the AVPicture fields.
4138 * The fields of the given AVPicture are filled in by using the 'ptr' address
4139 * which points to the image data buffer. Depending on the specified picture
4140 * format, one or multiple image data pointers and line sizes will be set.
4141 * If a planar format is specified, several pointers will be set pointing to
4142 * the different picture planes and the line sizes of the different planes
4143 * will be stored in the lines_sizes array.
4144 * Call with ptr == NULL to get the required size for the ptr buffer.
4146 * To allocate the buffer and fill in the AVPicture fields in one call,
4147 * use avpicture_alloc().
4149 * @param picture AVPicture whose fields are to be filled in
4150 * @param ptr Buffer which will contain or contains the actual image data
4151 * @param pix_fmt The format in which the picture data is stored.
4152 * @param width the width of the image in pixels
4153 * @param height the height of the image in pixels
4154 * @return size of the image data in bytes
4156 int avpicture_fill(AVPicture *picture, uint8_t *ptr,
4157 enum PixelFormat pix_fmt, int width, int height);
4160 * Copy pixel data from an AVPicture into a buffer.
4161 * The data is stored compactly, without any gaps for alignment or padding
4162 * which may be applied by avpicture_fill().
4164 * @see avpicture_get_size()
4166 * @param[in] src AVPicture containing image data
4167 * @param[in] pix_fmt The format in which the picture data is stored.
4168 * @param[in] width the width of the image in pixels.
4169 * @param[in] height the height of the image in pixels.
4170 * @param[out] dest A buffer into which picture data will be copied.
4171 * @param[in] dest_size The size of 'dest'.
4172 * @return The number of bytes written to dest, or a negative value (error code) on error.
4174 int avpicture_layout(const AVPicture* src, enum PixelFormat pix_fmt, int width, int height,
4175 unsigned char *dest, int dest_size);
4178 * Calculate the size in bytes that a picture of the given width and height
4179 * would occupy if stored in the given picture format.
4180 * Note that this returns the size of a compact representation as generated
4181 * by avpicture_layout(), which can be smaller than the size required for e.g.
4184 * @param pix_fmt the given picture format
4185 * @param width the width of the image
4186 * @param height the height of the image
4187 * @return Image data size in bytes or -1 on error (e.g. too large dimensions).
4189 int avpicture_get_size(enum PixelFormat pix_fmt, int width, int height);
4192 * deinterlace - if not supported return -1
4194 int avpicture_deinterlace(AVPicture *dst, const AVPicture *src,
4195 enum PixelFormat pix_fmt, int width, int height);
4197 * Copy image src to dst. Wraps av_picture_data_copy() above.
4199 void av_picture_copy(AVPicture *dst, const AVPicture *src,
4200 enum PixelFormat pix_fmt, int width, int height);
4203 * Crop image top and left side.
4205 int av_picture_crop(AVPicture *dst, const AVPicture *src,
4206 enum PixelFormat pix_fmt, int top_band, int left_band);
4211 int av_picture_pad(AVPicture *dst, const AVPicture *src, int height, int width, enum PixelFormat pix_fmt,
4212 int padtop, int padbottom, int padleft, int padright, int *color);
4219 * @defgroup lavc_misc Utility functions
4222 * Miscellaneous utility functions related to both encoding and decoding
4228 * @defgroup lavc_misc_pixfmt Pixel formats
4230 * Functions for working with pixel formats.
4234 void avcodec_get_chroma_sub_sample(enum PixelFormat pix_fmt, int *h_shift, int *v_shift);
4237 * Return a value representing the fourCC code associated to the
4238 * pixel format pix_fmt, or 0 if no associated fourCC code can be
4241 unsigned int avcodec_pix_fmt_to_codec_tag(enum PixelFormat pix_fmt);
4243 #define FF_LOSS_RESOLUTION 0x0001 /**< loss due to resolution change */
4244 #define FF_LOSS_DEPTH 0x0002 /**< loss due to color depth change */
4245 #define FF_LOSS_COLORSPACE 0x0004 /**< loss due to color space conversion */
4246 #define FF_LOSS_ALPHA 0x0008 /**< loss of alpha bits */
4247 #define FF_LOSS_COLORQUANT 0x0010 /**< loss due to color quantization */
4248 #define FF_LOSS_CHROMA 0x0020 /**< loss of chroma (e.g. RGB to gray conversion) */
4251 * Compute what kind of losses will occur when converting from one specific
4252 * pixel format to another.
4253 * When converting from one pixel format to another, information loss may occur.
4254 * For example, when converting from RGB24 to GRAY, the color information will
4255 * be lost. Similarly, other losses occur when converting from some formats to
4256 * other formats. These losses can involve loss of chroma, but also loss of
4257 * resolution, loss of color depth, loss due to the color space conversion, loss
4258 * of the alpha bits or loss due to color quantization.
4259 * avcodec_get_fix_fmt_loss() informs you about the various types of losses
4260 * which will occur when converting from one pixel format to another.
4262 * @param[in] dst_pix_fmt destination pixel format
4263 * @param[in] src_pix_fmt source pixel format
4264 * @param[in] has_alpha Whether the source pixel format alpha channel is used.
4265 * @return Combination of flags informing you what kind of losses will occur.
4267 int avcodec_get_pix_fmt_loss(enum PixelFormat dst_pix_fmt, enum PixelFormat src_pix_fmt,
4270 #if FF_API_FIND_BEST_PIX_FMT
4272 * @deprecated use avcodec_find_best_pix_fmt2() instead.
4274 * Find the best pixel format to convert to given a certain source pixel
4275 * format. When converting from one pixel format to another, information loss
4276 * may occur. For example, when converting from RGB24 to GRAY, the color
4277 * information will be lost. Similarly, other losses occur when converting from
4278 * some formats to other formats. avcodec_find_best_pix_fmt() searches which of
4279 * the given pixel formats should be used to suffer the least amount of loss.
4280 * The pixel formats from which it chooses one, are determined by the
4281 * pix_fmt_mask parameter.
4284 * src_pix_fmt = PIX_FMT_YUV420P;
4285 * pix_fmt_mask = (1 << PIX_FMT_YUV422P) || (1 << PIX_FMT_RGB24);
4286 * dst_pix_fmt = avcodec_find_best_pix_fmt(pix_fmt_mask, src_pix_fmt, alpha, &loss);
4289 * @param[in] pix_fmt_mask bitmask determining which pixel format to choose from
4290 * @param[in] src_pix_fmt source pixel format
4291 * @param[in] has_alpha Whether the source pixel format alpha channel is used.
4292 * @param[out] loss_ptr Combination of flags informing you what kind of losses will occur.
4293 * @return The best pixel format to convert to or -1 if none was found.
4295 attribute_deprecated
4296 enum PixelFormat avcodec_find_best_pix_fmt(int64_t pix_fmt_mask, enum PixelFormat src_pix_fmt,
4297 int has_alpha, int *loss_ptr);
4298 #endif /* FF_API_FIND_BEST_PIX_FMT */
4301 * Find the best pixel format to convert to given a certain source pixel
4302 * format. When converting from one pixel format to another, information loss
4303 * may occur. For example, when converting from RGB24 to GRAY, the color
4304 * information will be lost. Similarly, other losses occur when converting from
4305 * some formats to other formats. avcodec_find_best_pix_fmt2() searches which of
4306 * the given pixel formats should be used to suffer the least amount of loss.
4307 * The pixel formats from which it chooses one, are determined by the
4308 * pix_fmt_list parameter.
4311 * @param[in] pix_fmt_list PIX_FMT_NONE terminated array of pixel formats to choose from
4312 * @param[in] src_pix_fmt source pixel format
4313 * @param[in] has_alpha Whether the source pixel format alpha channel is used.
4314 * @param[out] loss_ptr Combination of flags informing you what kind of losses will occur.
4315 * @return The best pixel format to convert to or -1 if none was found.
4317 enum PixelFormat avcodec_find_best_pix_fmt2(enum PixelFormat *pix_fmt_list,
4318 enum PixelFormat src_pix_fmt,
4319 int has_alpha, int *loss_ptr);
4321 enum PixelFormat avcodec_default_get_format(struct AVCodecContext *s, const enum PixelFormat * fmt);
4327 void avcodec_set_dimensions(AVCodecContext *s, int width, int height);
4330 * Put a string representing the codec tag codec_tag in buf.
4332 * @param buf_size size in bytes of buf
4333 * @return the length of the string that would have been generated if
4334 * enough space had been available, excluding the trailing null
4336 size_t av_get_codec_tag_string(char *buf, size_t buf_size, unsigned int codec_tag);
4338 void avcodec_string(char *buf, int buf_size, AVCodecContext *enc, int encode);
4341 * Return a name for the specified profile, if available.
4343 * @param codec the codec that is searched for the given profile
4344 * @param profile the profile value for which a name is requested
4345 * @return A name for the profile if found, NULL otherwise.
4347 const char *av_get_profile_name(const AVCodec *codec, int profile);
4349 int avcodec_default_execute(AVCodecContext *c, int (*func)(AVCodecContext *c2, void *arg2),void *arg, int *ret, int count, int size);
4350 int avcodec_default_execute2(AVCodecContext *c, int (*func)(AVCodecContext *c2, void *arg2, int, int),void *arg, int *ret, int count);
4351 //FIXME func typedef
4354 * Fill audio frame data and linesize.
4355 * AVFrame extended_data channel pointers are allocated if necessary for
4358 * @param frame the AVFrame
4359 * frame->nb_samples must be set prior to calling the
4360 * function. This function fills in frame->data,
4361 * frame->extended_data, frame->linesize[0].
4362 * @param nb_channels channel count
4363 * @param sample_fmt sample format
4364 * @param buf buffer to use for frame data
4365 * @param buf_size size of buffer
4366 * @param align plane size sample alignment (0 = default)
4367 * @return 0 on success, negative error code on failure
4369 int avcodec_fill_audio_frame(AVFrame *frame, int nb_channels,
4370 enum AVSampleFormat sample_fmt, const uint8_t *buf,
4371 int buf_size, int align);
4374 * Flush buffers, should be called when seeking or when switching to a different stream.
4376 void avcodec_flush_buffers(AVCodecContext *avctx);
4378 void avcodec_default_free_buffers(AVCodecContext *s);
4381 * Return codec bits per sample.
4383 * @param[in] codec_id the codec
4384 * @return Number of bits per sample or zero if unknown for the given codec.
4386 int av_get_bits_per_sample(enum AVCodecID codec_id);
4389 * Return codec bits per sample.
4390 * Only return non-zero if the bits per sample is exactly correct, not an
4393 * @param[in] codec_id the codec
4394 * @return Number of bits per sample or zero if unknown for the given codec.
4396 int av_get_exact_bits_per_sample(enum AVCodecID codec_id);
4399 * Return audio frame duration.
4401 * @param avctx codec context
4402 * @param frame_bytes size of the frame, or 0 if unknown
4403 * @return frame duration, in samples, if known. 0 if not able to
4406 int av_get_audio_frame_duration(AVCodecContext *avctx, int frame_bytes);
4409 typedef struct AVBitStreamFilterContext {
4411 struct AVBitStreamFilter *filter;
4412 AVCodecParserContext *parser;
4413 struct AVBitStreamFilterContext *next;
4414 } AVBitStreamFilterContext;
4417 typedef struct AVBitStreamFilter {
4420 int (*filter)(AVBitStreamFilterContext *bsfc,
4421 AVCodecContext *avctx, const char *args,
4422 uint8_t **poutbuf, int *poutbuf_size,
4423 const uint8_t *buf, int buf_size, int keyframe);
4424 void (*close)(AVBitStreamFilterContext *bsfc);
4425 struct AVBitStreamFilter *next;
4426 } AVBitStreamFilter;
4428 void av_register_bitstream_filter(AVBitStreamFilter *bsf);
4429 AVBitStreamFilterContext *av_bitstream_filter_init(const char *name);
4430 int av_bitstream_filter_filter(AVBitStreamFilterContext *bsfc,
4431 AVCodecContext *avctx, const char *args,
4432 uint8_t **poutbuf, int *poutbuf_size,
4433 const uint8_t *buf, int buf_size, int keyframe);
4434 void av_bitstream_filter_close(AVBitStreamFilterContext *bsf);
4436 AVBitStreamFilter *av_bitstream_filter_next(AVBitStreamFilter *f);
4441 * Reallocate the given block if it is not large enough, otherwise do nothing.
4445 void *av_fast_realloc(void *ptr, unsigned int *size, size_t min_size);
4448 * Allocate a buffer, reusing the given one if large enough.
4450 * Contrary to av_fast_realloc the current buffer contents might not be
4451 * preserved and on error the old buffer is freed, thus no special
4452 * handling to avoid memleaks is necessary.
4454 * @param ptr pointer to pointer to already allocated buffer, overwritten with pointer to new buffer
4455 * @param size size of the buffer *ptr points to
4456 * @param min_size minimum size of *ptr buffer after returning, *ptr will be NULL and
4457 * *size 0 if an error occurred.
4459 void av_fast_malloc(void *ptr, unsigned int *size, size_t min_size);
4462 * Allocate a buffer with padding, reusing the given one if large enough.
4464 * Same behaviour av_fast_malloc but the buffer has additional
4465 * FF_INPUT_PADDING_SIZE at the end which will always memset to 0.
4468 void av_fast_padded_malloc(void *ptr, unsigned int *size, size_t min_size);
4471 * Encode extradata length to a buffer. Used by xiph codecs.
4473 * @param s buffer to write to; must be at least (v/255+1) bytes long
4474 * @param v size of extradata in bytes
4475 * @return number of bytes written to the buffer.
4477 unsigned int av_xiphlacing(unsigned char *s, unsigned int v);
4480 * Log a generic warning message about a missing feature. This function is
4481 * intended to be used internally by Libav (libavcodec, libavformat, etc.)
4482 * only, and would normally not be used by applications.
4483 * @param[in] avc a pointer to an arbitrary struct of which the first field is
4484 * a pointer to an AVClass struct
4485 * @param[in] feature string containing the name of the missing feature
4486 * @param[in] want_sample indicates if samples are wanted which exhibit this feature.
4487 * If want_sample is non-zero, additional verbage will be added to the log
4488 * message which tells the user how to report samples to the development
4491 void av_log_missing_feature(void *avc, const char *feature, int want_sample);
4494 * Log a generic warning message asking for a sample. This function is
4495 * intended to be used internally by Libav (libavcodec, libavformat, etc.)
4496 * only, and would normally not be used by applications.
4497 * @param[in] avc a pointer to an arbitrary struct of which the first field is
4498 * a pointer to an AVClass struct
4499 * @param[in] msg string containing an optional message, or NULL if no message
4501 void av_log_ask_for_sample(void *avc, const char *msg, ...) av_printf_format(2, 3);
4504 * Register the hardware accelerator hwaccel.
4506 void av_register_hwaccel(AVHWAccel *hwaccel);
4509 * If hwaccel is NULL, returns the first registered hardware accelerator,
4510 * if hwaccel is non-NULL, returns the next registered hardware accelerator
4511 * after hwaccel, or NULL if hwaccel is the last one.
4513 AVHWAccel *av_hwaccel_next(AVHWAccel *hwaccel);
4517 * Lock operation used by lockmgr
4520 AV_LOCK_CREATE, ///< Create a mutex
4521 AV_LOCK_OBTAIN, ///< Lock the mutex
4522 AV_LOCK_RELEASE, ///< Unlock the mutex
4523 AV_LOCK_DESTROY, ///< Free mutex resources
4527 * Register a user provided lock manager supporting the operations
4528 * specified by AVLockOp. mutex points to a (void *) where the
4529 * lockmgr should store/get a pointer to a user allocated mutex. It's
4530 * NULL upon AV_LOCK_CREATE and != NULL for all other ops.
4532 * @param cb User defined callback. Note: Libav may invoke calls to this
4533 * callback during the call to av_lockmgr_register().
4534 * Thus, the application must be prepared to handle that.
4535 * If cb is set to NULL the lockmgr will be unregistered.
4536 * Also note that during unregistration the previously registered
4537 * lockmgr callback may also be invoked.
4539 int av_lockmgr_register(int (*cb)(void **mutex, enum AVLockOp op));
4542 * Get the type of the given codec.
4544 enum AVMediaType avcodec_get_type(enum AVCodecID codec_id);
4547 * @return a positive value if s is open (i.e. avcodec_open2() was called on it
4548 * with no corresponding avcodec_close()), 0 otherwise.
4550 int avcodec_is_open(AVCodecContext *s);
4553 * @return a non-zero number if codec is an encoder, zero otherwise
4555 int av_codec_is_encoder(const AVCodec *codec);
4558 * @return a non-zero number if codec is a decoder, zero otherwise
4560 int av_codec_is_decoder(const AVCodec *codec);
4563 * @return descriptor for given codec ID or NULL if no descriptor exists.
4565 const AVCodecDescriptor *avcodec_descriptor_get(enum AVCodecID id);
4568 * Iterate over all codec descriptors known to libavcodec.
4570 * @param prev previous descriptor. NULL to get the first descriptor.
4572 * @return next descriptor or NULL after the last descriptor
4574 const AVCodecDescriptor *avcodec_descriptor_next(const AVCodecDescriptor *prev);
4577 * @return codec descriptor with the given name or NULL if no such descriptor
4580 const AVCodecDescriptor *avcodec_descriptor_get_by_name(const char *name);
4586 #endif /* AVCODEC_AVCODEC_H */