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/buffer.h"
33 #include "libavutil/cpu.h"
34 #include "libavutil/dict.h"
35 #include "libavutil/frame.h"
36 #include "libavutil/log.h"
37 #include "libavutil/pixfmt.h"
38 #include "libavutil/rational.h"
40 #include "libavcodec/version.h"
42 * @defgroup libavc Encoding/Decoding Library
45 * @defgroup lavc_decoding Decoding
49 * @defgroup lavc_encoding Encoding
53 * @defgroup lavc_codec Codecs
55 * @defgroup lavc_codec_native Native Codecs
58 * @defgroup lavc_codec_wrappers External library wrappers
61 * @defgroup lavc_codec_hwaccel Hardware Accelerators bridge
65 * @defgroup lavc_internal Internal
73 * @defgroup lavc_core Core functions/structures.
76 * Basic definitions, functions for querying libavcodec capabilities,
77 * allocating core structures, etc.
83 * Identify the syntax and semantics of the bitstream.
84 * The principle is roughly:
85 * Two decoders with the same ID can decode the same streams.
86 * Two encoders with the same ID can encode compatible streams.
87 * There may be slight deviations from the principle due to implementation
90 * If you add a codec ID to this list, add it so that
91 * 1. no value of a existing codec ID changes (that would break ABI),
92 * 2. it is as close as possible to similar codecs.
94 * After adding new codec IDs, do not forget to add an entry to the codec
95 * descriptor list and bump libavcodec minor version.
101 AV_CODEC_ID_MPEG1VIDEO,
102 AV_CODEC_ID_MPEG2VIDEO, ///< preferred ID for MPEG-1/2 video decoding
103 AV_CODEC_ID_MPEG2VIDEO_XVMC,
114 AV_CODEC_ID_RAWVIDEO,
115 AV_CODEC_ID_MSMPEG4V1,
116 AV_CODEC_ID_MSMPEG4V2,
117 AV_CODEC_ID_MSMPEG4V3,
140 AV_CODEC_ID_INTERPLAY_VIDEO,
147 AV_CODEC_ID_MSVIDEO1,
152 AV_CODEC_ID_TRUEMOTION1,
153 AV_CODEC_ID_VMDVIDEO,
181 AV_CODEC_ID_TRUEMOTION2,
187 AV_CODEC_ID_SMACKVIDEO,
192 AV_CODEC_ID_JPEG2000,
198 AV_CODEC_ID_DSICINVIDEO,
199 AV_CODEC_ID_TIERTEXSEQVIDEO,
207 AV_CODEC_ID_BETHSOFTVID,
219 AV_CODEC_ID_ESCAPE124,
223 AV_CODEC_ID_MOTIONPIXELS,
235 AV_CODEC_ID_FLASHSV2,
236 AV_CODEC_ID_CDGRAPHICS,
239 AV_CODEC_ID_BINKVIDEO,
240 AV_CODEC_ID_IFF_ILBM,
241 AV_CODEC_ID_IFF_BYTERUN1,
247 AV_CODEC_ID_A64_MULTI,
248 AV_CODEC_ID_A64_MULTI5,
251 AV_CODEC_ID_LAGARITH,
255 AV_CODEC_ID_WMV3IMAGE,
256 AV_CODEC_ID_VC1IMAGE,
258 AV_CODEC_ID_BMV_VIDEO,
265 AV_CODEC_ID_ZEROCODEC,
274 /* various PCM "codecs" */
275 AV_CODEC_ID_FIRST_AUDIO = 0x10000, ///< A dummy id pointing at the start of audio codecs
276 AV_CODEC_ID_PCM_S16LE = 0x10000,
277 AV_CODEC_ID_PCM_S16BE,
278 AV_CODEC_ID_PCM_U16LE,
279 AV_CODEC_ID_PCM_U16BE,
282 AV_CODEC_ID_PCM_MULAW,
283 AV_CODEC_ID_PCM_ALAW,
284 AV_CODEC_ID_PCM_S32LE,
285 AV_CODEC_ID_PCM_S32BE,
286 AV_CODEC_ID_PCM_U32LE,
287 AV_CODEC_ID_PCM_U32BE,
288 AV_CODEC_ID_PCM_S24LE,
289 AV_CODEC_ID_PCM_S24BE,
290 AV_CODEC_ID_PCM_U24LE,
291 AV_CODEC_ID_PCM_U24BE,
292 AV_CODEC_ID_PCM_S24DAUD,
293 AV_CODEC_ID_PCM_ZORK,
294 AV_CODEC_ID_PCM_S16LE_PLANAR,
296 AV_CODEC_ID_PCM_F32BE,
297 AV_CODEC_ID_PCM_F32LE,
298 AV_CODEC_ID_PCM_F64BE,
299 AV_CODEC_ID_PCM_F64LE,
300 AV_CODEC_ID_PCM_BLURAY,
303 AV_CODEC_ID_PCM_S8_PLANAR,
305 /* various ADPCM codecs */
306 AV_CODEC_ID_ADPCM_IMA_QT = 0x11000,
307 AV_CODEC_ID_ADPCM_IMA_WAV,
308 AV_CODEC_ID_ADPCM_IMA_DK3,
309 AV_CODEC_ID_ADPCM_IMA_DK4,
310 AV_CODEC_ID_ADPCM_IMA_WS,
311 AV_CODEC_ID_ADPCM_IMA_SMJPEG,
312 AV_CODEC_ID_ADPCM_MS,
313 AV_CODEC_ID_ADPCM_4XM,
314 AV_CODEC_ID_ADPCM_XA,
315 AV_CODEC_ID_ADPCM_ADX,
316 AV_CODEC_ID_ADPCM_EA,
317 AV_CODEC_ID_ADPCM_G726,
318 AV_CODEC_ID_ADPCM_CT,
319 AV_CODEC_ID_ADPCM_SWF,
320 AV_CODEC_ID_ADPCM_YAMAHA,
321 AV_CODEC_ID_ADPCM_SBPRO_4,
322 AV_CODEC_ID_ADPCM_SBPRO_3,
323 AV_CODEC_ID_ADPCM_SBPRO_2,
324 AV_CODEC_ID_ADPCM_THP,
325 AV_CODEC_ID_ADPCM_IMA_AMV,
326 AV_CODEC_ID_ADPCM_EA_R1,
327 AV_CODEC_ID_ADPCM_EA_R3,
328 AV_CODEC_ID_ADPCM_EA_R2,
329 AV_CODEC_ID_ADPCM_IMA_EA_SEAD,
330 AV_CODEC_ID_ADPCM_IMA_EA_EACS,
331 AV_CODEC_ID_ADPCM_EA_XAS,
332 AV_CODEC_ID_ADPCM_EA_MAXIS_XA,
333 AV_CODEC_ID_ADPCM_IMA_ISS,
334 AV_CODEC_ID_ADPCM_G722,
335 AV_CODEC_ID_ADPCM_IMA_APC,
338 AV_CODEC_ID_AMR_NB = 0x12000,
341 /* RealAudio codecs*/
342 AV_CODEC_ID_RA_144 = 0x13000,
345 /* various DPCM codecs */
346 AV_CODEC_ID_ROQ_DPCM = 0x14000,
347 AV_CODEC_ID_INTERPLAY_DPCM,
348 AV_CODEC_ID_XAN_DPCM,
349 AV_CODEC_ID_SOL_DPCM,
352 AV_CODEC_ID_MP2 = 0x15000,
353 AV_CODEC_ID_MP3, ///< preferred ID for decoding MPEG audio layer 1, 2 or 3
363 AV_CODEC_ID_VMDAUDIO,
369 AV_CODEC_ID_WESTWOOD_SND1,
370 AV_CODEC_ID_GSM, ///< as in Berlin toast format
373 AV_CODEC_ID_TRUESPEECH,
375 AV_CODEC_ID_SMACKAUDIO,
378 AV_CODEC_ID_DSICINAUDIO,
380 AV_CODEC_ID_MUSEPACK7,
382 AV_CODEC_ID_GSM_MS, /* as found in WAV */
386 AV_CODEC_ID_NELLYMOSER,
387 AV_CODEC_ID_MUSEPACK8,
389 AV_CODEC_ID_WMAVOICE,
391 AV_CODEC_ID_WMALOSSLESS,
400 AV_CODEC_ID_BINKAUDIO_RDFT,
401 AV_CODEC_ID_BINKAUDIO_DCT,
402 AV_CODEC_ID_AAC_LATM,
407 AV_CODEC_ID_8SVX_EXP,
408 AV_CODEC_ID_8SVX_FIB,
409 AV_CODEC_ID_BMV_AUDIO,
414 AV_CODEC_ID_COMFORT_NOISE,
417 /* subtitle codecs */
418 AV_CODEC_ID_FIRST_SUBTITLE = 0x17000, ///< A dummy ID pointing at the start of subtitle codecs.
419 AV_CODEC_ID_DVD_SUBTITLE = 0x17000,
420 AV_CODEC_ID_DVB_SUBTITLE,
421 AV_CODEC_ID_TEXT, ///< raw UTF-8 text
424 AV_CODEC_ID_MOV_TEXT,
425 AV_CODEC_ID_HDMV_PGS_SUBTITLE,
426 AV_CODEC_ID_DVB_TELETEXT,
429 /* other specific kind of codecs (generally used for attachments) */
430 AV_CODEC_ID_FIRST_UNKNOWN = 0x18000, ///< A dummy ID pointing at the start of various fake codecs.
431 AV_CODEC_ID_TTF = 0x18000,
433 AV_CODEC_ID_PROBE = 0x19000, ///< codec_id is not known (like AV_CODEC_ID_NONE) but lavf should attempt to identify it
435 AV_CODEC_ID_MPEG2TS = 0x20000, /**< _FAKE_ codec to indicate a raw MPEG-2 TS
436 * stream (only used by libavformat) */
437 AV_CODEC_ID_MPEG4SYSTEMS = 0x20001, /**< _FAKE_ codec to indicate a MPEG-4 Systems
438 * stream (only used by libavformat) */
439 AV_CODEC_ID_FFMETADATA = 0x21000, ///< Dummy codec for streams containing only metadata information.
442 #include "old_codec_ids.h"
447 #define CodecID AVCodecID
451 * This struct describes the properties of a single codec described by an
453 * @see avcodec_get_descriptor()
455 typedef struct AVCodecDescriptor {
457 enum AVMediaType type;
459 * Name of the codec described by this descriptor. It is non-empty and
460 * unique for each codec descriptor. It should contain alphanumeric
461 * characters and '_' only.
465 * A more descriptive name for this codec. May be NULL.
467 const char *long_name;
469 * Codec properties, a combination of AV_CODEC_PROP_* flags.
475 * Codec uses only intra compression.
478 #define AV_CODEC_PROP_INTRA_ONLY (1 << 0)
480 * Codec supports lossy compression. Audio and video codecs only.
481 * @note a codec may support both lossy and lossless
484 #define AV_CODEC_PROP_LOSSY (1 << 1)
486 * Codec supports lossless compression. Audio and video codecs only.
488 #define AV_CODEC_PROP_LOSSLESS (1 << 2)
491 * @ingroup lavc_decoding
492 * Required number of additionally allocated bytes at the end of the input bitstream for decoding.
493 * This is mainly needed because some optimized bitstream readers read
494 * 32 or 64 bit at once and could read over the end.<br>
495 * Note: If the first 23 bits of the additional bytes are not 0, then damaged
496 * MPEG bitstreams could cause overread and segfault.
498 #define FF_INPUT_BUFFER_PADDING_SIZE 8
501 * @ingroup lavc_encoding
502 * minimum encoding buffer size
503 * Used to avoid some checks during header writing.
505 #define FF_MIN_BUFFER_SIZE 16384
509 * @ingroup lavc_encoding
510 * motion estimation type.
513 ME_ZERO = 1, ///< no search, that is use 0,0 vector whenever one is needed
517 ME_EPZS, ///< enhanced predictive zonal search
518 ME_X1, ///< reserved for experiments
519 ME_HEX, ///< hexagon based search
520 ME_UMH, ///< uneven multi-hexagon search
522 ME_ITER, ///< iterative search
524 ME_TESA, ///< transformed exhaustive search algorithm
528 * @ingroup lavc_decoding
531 /* We leave some space between them for extensions (drop some
532 * keyframes for intra-only or drop just some bidir frames). */
533 AVDISCARD_NONE =-16, ///< discard nothing
534 AVDISCARD_DEFAULT = 0, ///< discard useless packets like 0 size packets in avi
535 AVDISCARD_NONREF = 8, ///< discard all non reference
536 AVDISCARD_BIDIR = 16, ///< discard all bidirectional frames
537 AVDISCARD_NONKEY = 32, ///< discard all frames except keyframes
538 AVDISCARD_ALL = 48, ///< discard all
541 enum AVColorPrimaries{
542 AVCOL_PRI_BT709 = 1, ///< also ITU-R BT1361 / IEC 61966-2-4 / SMPTE RP177 Annex B
543 AVCOL_PRI_UNSPECIFIED = 2,
544 AVCOL_PRI_BT470M = 4,
545 AVCOL_PRI_BT470BG = 5, ///< also ITU-R BT601-6 625 / ITU-R BT1358 625 / ITU-R BT1700 625 PAL & SECAM
546 AVCOL_PRI_SMPTE170M = 6, ///< also ITU-R BT601-6 525 / ITU-R BT1358 525 / ITU-R BT1700 NTSC
547 AVCOL_PRI_SMPTE240M = 7, ///< functionally identical to above
549 AVCOL_PRI_NB , ///< Not part of ABI
552 enum AVColorTransferCharacteristic{
553 AVCOL_TRC_BT709 = 1, ///< also ITU-R BT1361
554 AVCOL_TRC_UNSPECIFIED = 2,
555 AVCOL_TRC_GAMMA22 = 4, ///< also ITU-R BT470M / ITU-R BT1700 625 PAL & SECAM
556 AVCOL_TRC_GAMMA28 = 5, ///< also ITU-R BT470BG
557 AVCOL_TRC_SMPTE240M = 7,
558 AVCOL_TRC_NB , ///< Not part of ABI
563 AVCOL_SPC_BT709 = 1, ///< also ITU-R BT1361 / IEC 61966-2-4 xvYCC709 / SMPTE RP177 Annex B
564 AVCOL_SPC_UNSPECIFIED = 2,
566 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
567 AVCOL_SPC_SMPTE170M = 6, ///< also ITU-R BT601-6 525 / ITU-R BT1358 525 / ITU-R BT1700 NTSC / functionally identical to above
568 AVCOL_SPC_SMPTE240M = 7,
569 AVCOL_SPC_YCOCG = 8, ///< Used by Dirac / VC-2 and H.264 FRext, see ITU-T SG16
570 AVCOL_SPC_NB , ///< Not part of ABI
574 AVCOL_RANGE_UNSPECIFIED = 0,
575 AVCOL_RANGE_MPEG = 1, ///< the normal 219*2^(n-8) "MPEG" YUV ranges
576 AVCOL_RANGE_JPEG = 2, ///< the normal 2^n-1 "JPEG" YUV ranges
577 AVCOL_RANGE_NB , ///< Not part of ABI
581 * X X 3 4 X X are luma samples,
582 * 1 2 1-6 are possible chroma positions
583 * X X 5 6 X 0 is undefined/unknown position
585 enum AVChromaLocation{
586 AVCHROMA_LOC_UNSPECIFIED = 0,
587 AVCHROMA_LOC_LEFT = 1, ///< mpeg2/4, h264 default
588 AVCHROMA_LOC_CENTER = 2, ///< mpeg1, jpeg, h263
589 AVCHROMA_LOC_TOPLEFT = 3, ///< DV
590 AVCHROMA_LOC_TOP = 4,
591 AVCHROMA_LOC_BOTTOMLEFT = 5,
592 AVCHROMA_LOC_BOTTOM = 6,
593 AVCHROMA_LOC_NB , ///< Not part of ABI
596 enum AVAudioServiceType {
597 AV_AUDIO_SERVICE_TYPE_MAIN = 0,
598 AV_AUDIO_SERVICE_TYPE_EFFECTS = 1,
599 AV_AUDIO_SERVICE_TYPE_VISUALLY_IMPAIRED = 2,
600 AV_AUDIO_SERVICE_TYPE_HEARING_IMPAIRED = 3,
601 AV_AUDIO_SERVICE_TYPE_DIALOGUE = 4,
602 AV_AUDIO_SERVICE_TYPE_COMMENTARY = 5,
603 AV_AUDIO_SERVICE_TYPE_EMERGENCY = 6,
604 AV_AUDIO_SERVICE_TYPE_VOICE_OVER = 7,
605 AV_AUDIO_SERVICE_TYPE_KARAOKE = 8,
606 AV_AUDIO_SERVICE_TYPE_NB , ///< Not part of ABI
610 * @ingroup lavc_encoding
612 typedef struct RcOverride{
615 int qscale; // If this is 0 then quality_factor will be used instead.
616 float quality_factor;
619 #define FF_MAX_B_FRAMES 16
622 These flags can be passed in AVCodecContext.flags before initialization.
623 Note: Not everything is supported yet.
626 #define CODEC_FLAG_QSCALE 0x0002 ///< Use fixed qscale.
627 #define CODEC_FLAG_4MV 0x0004 ///< 4 MV per MB allowed / advanced prediction for H.263.
628 #define CODEC_FLAG_QPEL 0x0010 ///< Use qpel MC.
629 #define CODEC_FLAG_GMC 0x0020 ///< Use GMC.
630 #define CODEC_FLAG_MV0 0x0040 ///< Always try a MB with MV=<0,0>.
632 * The parent program guarantees that the input for B-frames containing
633 * streams is not written to for at least s->max_b_frames+1 frames, if
634 * this is not set the input will be copied.
636 #define CODEC_FLAG_INPUT_PRESERVED 0x0100
637 #define CODEC_FLAG_PASS1 0x0200 ///< Use internal 2pass ratecontrol in first pass mode.
638 #define CODEC_FLAG_PASS2 0x0400 ///< Use internal 2pass ratecontrol in second pass mode.
639 #define CODEC_FLAG_GRAY 0x2000 ///< Only decode/encode grayscale.
640 #define CODEC_FLAG_EMU_EDGE 0x4000 ///< Don't draw edges.
641 #define CODEC_FLAG_PSNR 0x8000 ///< error[?] variables will be set during encoding.
642 #define CODEC_FLAG_TRUNCATED 0x00010000 /** Input bitstream might be truncated at a random
643 location instead of only at frame boundaries. */
644 #define CODEC_FLAG_NORMALIZE_AQP 0x00020000 ///< Normalize adaptive quantization.
645 #define CODEC_FLAG_INTERLACED_DCT 0x00040000 ///< Use interlaced DCT.
646 #define CODEC_FLAG_LOW_DELAY 0x00080000 ///< Force low delay.
647 #define CODEC_FLAG_GLOBAL_HEADER 0x00400000 ///< Place global headers in extradata instead of every keyframe.
648 #define CODEC_FLAG_BITEXACT 0x00800000 ///< Use only bitexact stuff (except (I)DCT).
649 /* Fx : Flag for h263+ extra options */
650 #define CODEC_FLAG_AC_PRED 0x01000000 ///< H.263 advanced intra coding / MPEG-4 AC prediction
651 #define CODEC_FLAG_LOOP_FILTER 0x00000800 ///< loop filter
652 #define CODEC_FLAG_INTERLACED_ME 0x20000000 ///< interlaced motion estimation
653 #define CODEC_FLAG_CLOSED_GOP 0x80000000
654 #define CODEC_FLAG2_FAST 0x00000001 ///< Allow non spec compliant speedup tricks.
655 #define CODEC_FLAG2_NO_OUTPUT 0x00000004 ///< Skip bitstream encoding.
656 #define CODEC_FLAG2_LOCAL_HEADER 0x00000008 ///< Place global headers at every keyframe instead of in extradata.
657 #define CODEC_FLAG2_IGNORE_CROP 0x00010000 ///< Discard cropping information from SPS.
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 #if FF_API_GET_BUFFER
816 #define FF_BUFFER_TYPE_INTERNAL 1
817 #define FF_BUFFER_TYPE_USER 2 ///< direct rendering buffers (image is (de)allocated by user)
818 #define FF_BUFFER_TYPE_SHARED 4 ///< Buffer from somewhere else; don't deallocate image (data/base), all other tables are not shared.
819 #define FF_BUFFER_TYPE_COPY 8 ///< Just a (modified) copy of some other buffer, don't deallocate anything.
821 #define FF_BUFFER_HINTS_VALID 0x01 // Buffer hints value is meaningful (if 0 ignore).
822 #define FF_BUFFER_HINTS_READABLE 0x02 // Codec will read from buffer.
823 #define FF_BUFFER_HINTS_PRESERVE 0x04 // User must not alter buffer content.
824 #define FF_BUFFER_HINTS_REUSABLE 0x08 // Codec will reuse the buffer (update).
828 * The decoder will keep a reference to the frame and may reuse it later.
830 #define AV_GET_BUFFER_FLAG_REF (1 << 0)
833 * @defgroup lavc_packet AVPacket
835 * Types and functions for working with AVPacket.
838 enum AVPacketSideDataType {
840 AV_PKT_DATA_NEW_EXTRADATA,
843 * An AV_PKT_DATA_PARAM_CHANGE side data packet is laid out as follows:
846 * if (param_flags & AV_SIDE_DATA_PARAM_CHANGE_CHANNEL_COUNT)
847 * s32le channel_count
848 * if (param_flags & AV_SIDE_DATA_PARAM_CHANGE_CHANNEL_LAYOUT)
849 * u64le channel_layout
850 * if (param_flags & AV_SIDE_DATA_PARAM_CHANGE_SAMPLE_RATE)
852 * if (param_flags & AV_SIDE_DATA_PARAM_CHANGE_DIMENSIONS)
857 AV_PKT_DATA_PARAM_CHANGE,
860 * An AV_PKT_DATA_H263_MB_INFO side data packet contains a number of
861 * structures with info about macroblocks relevant to splitting the
862 * packet into smaller packets on macroblock edges (e.g. as for RFC 2190).
863 * That is, it does not necessarily contain info about all macroblocks,
864 * as long as the distance between macroblocks in the info is smaller
865 * than the target payload size.
866 * Each MB info structure is 12 bytes, and is laid out as follows:
868 * u32le bit offset from the start of the packet
869 * u8 current quantizer at the start of the macroblock
871 * u16le macroblock address within the GOB
872 * u8 horizontal MV predictor
873 * u8 vertical MV predictor
874 * u8 horizontal MV predictor for block number 3
875 * u8 vertical MV predictor for block number 3
878 AV_PKT_DATA_H263_MB_INFO,
882 * This structure stores compressed data. It is typically exported by demuxers
883 * and then passed as input to decoders, or received as output from encoders and
884 * then passed to muxers.
886 * For video, it should typically contain one compressed frame. For audio it may
887 * contain several compressed frames.
889 * AVPacket is one of the few structs in Libav, whose size is a part of public
890 * ABI. Thus it may be allocated on stack and no new fields can be added to it
891 * without libavcodec and libavformat major bump.
893 * The semantics of data ownership depends on the buf or destruct (deprecated)
894 * fields. If either is set, the packet data is dynamically allocated and is
895 * valid indefinitely until av_free_packet() is called (which in turn calls
896 * av_buffer_unref()/the destruct callback to free the data). If neither is set,
897 * the packet data is typically backed by some static buffer somewhere and is
898 * only valid for a limited time (e.g. until the next read call when demuxing).
900 * The side data is always allocated with av_malloc() and is freed in
903 typedef struct AVPacket {
905 * A reference to the reference-counted buffer where the packet data is
907 * May be NULL, then the packet data is not reference-counted.
911 * Presentation timestamp in AVStream->time_base units; the time at which
912 * the decompressed packet will be presented to the user.
913 * Can be AV_NOPTS_VALUE if it is not stored in the file.
914 * pts MUST be larger or equal to dts as presentation cannot happen before
915 * decompression, unless one wants to view hex dumps. Some formats misuse
916 * the terms dts and pts/cts to mean something different. Such timestamps
917 * must be converted to true pts/dts before they are stored in AVPacket.
921 * Decompression timestamp in AVStream->time_base units; the time at which
922 * the packet is decompressed.
923 * Can be AV_NOPTS_VALUE if it is not stored in the file.
930 * A combination of AV_PKT_FLAG values
934 * Additional packet data that can be provided by the container.
935 * Packet can contain several types of side information.
940 enum AVPacketSideDataType type;
945 * Duration of this packet in AVStream->time_base units, 0 if unknown.
946 * Equals next_pts - this_pts in presentation order.
949 #if FF_API_DESTRUCT_PACKET
951 void (*destruct)(struct AVPacket *);
955 int64_t pos; ///< byte position in stream, -1 if unknown
958 * Time difference in AVStream->time_base units from the pts of this
959 * packet to the point at which the output from the decoder has converged
960 * independent from the availability of previous frames. That is, the
961 * frames are virtually identical no matter if decoding started from
962 * the very first frame or from this keyframe.
963 * Is AV_NOPTS_VALUE if unknown.
964 * This field is not the display duration of the current packet.
965 * This field has no meaning if the packet does not have AV_PKT_FLAG_KEY
968 * The purpose of this field is to allow seeking in streams that have no
969 * keyframes in the conventional sense. It corresponds to the
970 * recovery point SEI in H.264 and match_time_delta in NUT. It is also
971 * essential for some types of subtitle streams to ensure that all
972 * subtitles are correctly displayed after seeking.
974 int64_t convergence_duration;
976 #define AV_PKT_FLAG_KEY 0x0001 ///< The packet contains a keyframe
977 #define AV_PKT_FLAG_CORRUPT 0x0002 ///< The packet content is corrupted
979 enum AVSideDataParamChangeFlags {
980 AV_SIDE_DATA_PARAM_CHANGE_CHANNEL_COUNT = 0x0001,
981 AV_SIDE_DATA_PARAM_CHANGE_CHANNEL_LAYOUT = 0x0002,
982 AV_SIDE_DATA_PARAM_CHANGE_SAMPLE_RATE = 0x0004,
983 AV_SIDE_DATA_PARAM_CHANGE_DIMENSIONS = 0x0008,
989 struct AVCodecInternal;
993 AV_FIELD_PROGRESSIVE,
994 AV_FIELD_TT, //< Top coded_first, top displayed first
995 AV_FIELD_BB, //< Bottom coded first, bottom displayed first
996 AV_FIELD_TB, //< Top coded first, bottom displayed first
997 AV_FIELD_BT, //< Bottom coded first, top displayed first
1001 * main external API structure.
1002 * New fields can be added to the end with minor version bumps.
1003 * Removal, reordering and changes to existing fields require a major
1005 * sizeof(AVCodecContext) must not be used outside libav*.
1007 typedef struct AVCodecContext {
1009 * information on struct for av_log
1010 * - set by avcodec_alloc_context3
1012 const AVClass *av_class;
1013 int log_level_offset;
1015 enum AVMediaType codec_type; /* see AVMEDIA_TYPE_xxx */
1016 const struct AVCodec *codec;
1017 char codec_name[32];
1018 enum AVCodecID codec_id; /* see AV_CODEC_ID_xxx */
1021 * fourcc (LSB first, so "ABCD" -> ('D'<<24) + ('C'<<16) + ('B'<<8) + 'A').
1022 * This is used to work around some encoder bugs.
1023 * A demuxer should set this to what is stored in the field used to identify the codec.
1024 * If there are multiple such fields in a container then the demuxer should choose the one
1025 * which maximizes the information about the used codec.
1026 * If the codec tag field in a container is larger than 32 bits then the demuxer should
1027 * remap the longer ID to 32 bits with a table or other structure. Alternatively a new
1028 * extra_codec_tag + size could be added but for this a clear advantage must be demonstrated
1030 * - encoding: Set by user, if not then the default based on codec_id will be used.
1031 * - decoding: Set by user, will be converted to uppercase by libavcodec during init.
1033 unsigned int codec_tag;
1036 * fourcc from the AVI stream header (LSB first, so "ABCD" -> ('D'<<24) + ('C'<<16) + ('B'<<8) + 'A').
1037 * This is used to work around some encoder bugs.
1038 * - encoding: unused
1039 * - decoding: Set by user, will be converted to uppercase by libavcodec during init.
1041 unsigned int stream_codec_tag;
1046 * Private context used for internal data.
1048 * Unlike priv_data, this is not codec-specific. It is used in general
1049 * libavcodec functions.
1051 struct AVCodecInternal *internal;
1054 * Private data of the user, can be used to carry app specific stuff.
1055 * - encoding: Set by user.
1056 * - decoding: Set by user.
1061 * the average bitrate
1062 * - encoding: Set by user; unused for constant quantizer encoding.
1063 * - decoding: Set by libavcodec. 0 or some bitrate if this info is available in the stream.
1068 * number of bits the bitstream is allowed to diverge from the reference.
1069 * the reference can be CBR (for CBR pass1) or VBR (for pass2)
1070 * - encoding: Set by user; unused for constant quantizer encoding.
1071 * - decoding: unused
1073 int bit_rate_tolerance;
1076 * Global quality for codecs which cannot change it per frame.
1077 * This should be proportional to MPEG-1/2/4 qscale.
1078 * - encoding: Set by user.
1079 * - decoding: unused
1084 * - encoding: Set by user.
1085 * - decoding: unused
1087 int compression_level;
1088 #define FF_COMPRESSION_DEFAULT -1
1092 * - encoding: Set by user.
1093 * - decoding: Set by user.
1099 * - encoding: Set by user.
1100 * - decoding: Set by user.
1105 * some codecs need / can use extradata like Huffman tables.
1106 * mjpeg: Huffman tables
1107 * rv10: additional flags
1108 * mpeg4: global headers (they can be in the bitstream or here)
1109 * The allocated memory should be FF_INPUT_BUFFER_PADDING_SIZE bytes larger
1110 * than extradata_size to avoid prolems if it is read with the bitstream reader.
1111 * The bytewise contents of extradata must not depend on the architecture or CPU endianness.
1112 * - encoding: Set/allocated/freed by libavcodec.
1113 * - decoding: Set/allocated/freed by user.
1119 * This is the fundamental unit of time (in seconds) in terms
1120 * of which frame timestamps are represented. For fixed-fps content,
1121 * timebase should be 1/framerate and timestamp increments should be
1123 * - encoding: MUST be set by user.
1124 * - decoding: Set by libavcodec.
1126 AVRational time_base;
1129 * For some codecs, the time base is closer to the field rate than the frame rate.
1130 * Most notably, H.264 and MPEG-2 specify time_base as half of frame duration
1131 * if no telecine is used ...
1133 * Set to time_base ticks per frame. Default 1, e.g., H.264/MPEG-2 set it to 2.
1135 int ticks_per_frame;
1141 * Number of frames the decoded output will be delayed relative to the
1145 * For encoding, this is the number of "priming" samples added to the
1146 * beginning of the stream. The decoded output will be delayed by this
1147 * many samples relative to the input to the encoder. Note that this
1148 * field is purely informational and does not directly affect the pts
1149 * output by the encoder, which should always be based on the actual
1150 * presentation time, including any delay.
1151 * For decoding, this is the number of samples the decoder needs to
1152 * output before the decoder's output is valid. When seeking, you should
1153 * start decoding this many samples prior to your desired seek point.
1155 * - encoding: Set by libavcodec.
1156 * - decoding: Set by libavcodec.
1163 * picture width / height.
1164 * - encoding: MUST be set by user.
1165 * - decoding: Set by libavcodec.
1166 * Note: For compatibility it is possible to set this instead of
1167 * coded_width/height before decoding.
1172 * Bitstream width / height, may be different from width/height.
1173 * - encoding: unused
1174 * - decoding: Set by user before init if known. Codec should override / dynamically change if needed.
1176 int coded_width, coded_height;
1178 #define FF_ASPECT_EXTENDED 15
1181 * the number of pictures in a group of pictures, or 0 for intra_only
1182 * - encoding: Set by user.
1183 * - decoding: unused
1188 * Pixel format, see AV_PIX_FMT_xxx.
1189 * May be set by the demuxer if known from headers.
1190 * May be overriden by the decoder if it knows better.
1191 * - encoding: Set by user.
1192 * - decoding: Set by user if known, overridden by libavcodec if known
1194 enum AVPixelFormat pix_fmt;
1197 * Motion estimation algorithm used for video coding.
1198 * 1 (zero), 2 (full), 3 (log), 4 (phods), 5 (epzs), 6 (x1), 7 (hex),
1199 * 8 (umh), 10 (tesa) [7, 8, 10 are x264 specific]
1200 * - encoding: MUST be set by user.
1201 * - decoding: unused
1206 * If non NULL, 'draw_horiz_band' is called by the libavcodec
1207 * decoder to draw a horizontal band. It improves cache usage. Not
1208 * all codecs can do that. You must check the codec capabilities
1210 * When multithreading is used, it may be called from multiple threads
1211 * at the same time; threads might draw different parts of the same AVFrame,
1212 * or multiple AVFrames, and there is no guarantee that slices will be drawn
1214 * The function is also used by hardware acceleration APIs.
1215 * It is called at least once during frame decoding to pass
1216 * the data needed for hardware render.
1217 * In that mode instead of pixel data, AVFrame points to
1218 * a structure specific to the acceleration API. The application
1219 * reads the structure and can change some fields to indicate progress
1221 * - encoding: unused
1222 * - decoding: Set by user.
1223 * @param height the height of the slice
1224 * @param y the y position of the slice
1225 * @param type 1->top field, 2->bottom field, 3->frame
1226 * @param offset offset into the AVFrame.data from which the slice should be read
1228 void (*draw_horiz_band)(struct AVCodecContext *s,
1229 const AVFrame *src, int offset[AV_NUM_DATA_POINTERS],
1230 int y, int type, int height);
1233 * callback to negotiate the pixelFormat
1234 * @param fmt is the list of formats which are supported by the codec,
1235 * it is terminated by -1 as 0 is a valid format, the formats are ordered by quality.
1236 * The first is always the native one.
1237 * @return the chosen format
1238 * - encoding: unused
1239 * - decoding: Set by user, if not set the native format will be chosen.
1241 enum AVPixelFormat (*get_format)(struct AVCodecContext *s, const enum AVPixelFormat * fmt);
1244 * maximum number of B-frames between non-B-frames
1245 * Note: The output will be delayed by max_b_frames+1 relative to the input.
1246 * - encoding: Set by user.
1247 * - decoding: unused
1252 * qscale factor between IP and B-frames
1253 * If > 0 then the last P-frame quantizer will be used (q= lastp_q*factor+offset).
1254 * If < 0 then normal ratecontrol will be done (q= -normal_q*factor+offset).
1255 * - encoding: Set by user.
1256 * - decoding: unused
1258 float b_quant_factor;
1260 /** obsolete FIXME remove */
1262 #define FF_RC_STRATEGY_XVID 1
1264 int b_frame_strategy;
1267 * qscale offset between IP and B-frames
1268 * - encoding: Set by user.
1269 * - decoding: unused
1271 float b_quant_offset;
1274 * Size of the frame reordering buffer in the decoder.
1275 * For MPEG-2 it is 1 IPB or 0 low delay IP.
1276 * - encoding: Set by libavcodec.
1277 * - decoding: Set by libavcodec.
1282 * 0-> h263 quant 1-> mpeg quant
1283 * - encoding: Set by user.
1284 * - decoding: unused
1289 * qscale factor between P and I-frames
1290 * If > 0 then the last p frame quantizer will be used (q= lastp_q*factor+offset).
1291 * If < 0 then normal ratecontrol will be done (q= -normal_q*factor+offset).
1292 * - encoding: Set by user.
1293 * - decoding: unused
1295 float i_quant_factor;
1298 * qscale offset between P and I-frames
1299 * - encoding: Set by user.
1300 * - decoding: unused
1302 float i_quant_offset;
1305 * luminance masking (0-> disabled)
1306 * - encoding: Set by user.
1307 * - decoding: unused
1312 * temporary complexity masking (0-> disabled)
1313 * - encoding: Set by user.
1314 * - decoding: unused
1316 float temporal_cplx_masking;
1319 * spatial complexity masking (0-> disabled)
1320 * - encoding: Set by user.
1321 * - decoding: unused
1323 float spatial_cplx_masking;
1326 * p block masking (0-> disabled)
1327 * - encoding: Set by user.
1328 * - decoding: unused
1333 * darkness masking (0-> disabled)
1334 * - encoding: Set by user.
1335 * - decoding: unused
1341 * - encoding: Set by libavcodec.
1342 * - decoding: Set by user (or 0).
1346 * prediction method (needed for huffyuv)
1347 * - encoding: Set by user.
1348 * - decoding: unused
1350 int prediction_method;
1351 #define FF_PRED_LEFT 0
1352 #define FF_PRED_PLANE 1
1353 #define FF_PRED_MEDIAN 2
1356 * slice offsets in the frame in bytes
1357 * - encoding: Set/allocated by libavcodec.
1358 * - decoding: Set/allocated by user (or NULL).
1363 * sample aspect ratio (0 if unknown)
1364 * That is the width of a pixel divided by the height of the pixel.
1365 * Numerator and denominator must be relatively prime and smaller than 256 for some video standards.
1366 * - encoding: Set by user.
1367 * - decoding: Set by libavcodec.
1369 AVRational sample_aspect_ratio;
1372 * motion estimation comparison function
1373 * - encoding: Set by user.
1374 * - decoding: unused
1378 * subpixel motion estimation comparison function
1379 * - encoding: Set by user.
1380 * - decoding: unused
1384 * macroblock comparison function (not supported yet)
1385 * - encoding: Set by user.
1386 * - decoding: unused
1390 * interlaced DCT comparison function
1391 * - encoding: Set by user.
1392 * - decoding: unused
1395 #define FF_CMP_SAD 0
1396 #define FF_CMP_SSE 1
1397 #define FF_CMP_SATD 2
1398 #define FF_CMP_DCT 3
1399 #define FF_CMP_PSNR 4
1400 #define FF_CMP_BIT 5
1402 #define FF_CMP_ZERO 7
1403 #define FF_CMP_VSAD 8
1404 #define FF_CMP_VSSE 9
1405 #define FF_CMP_NSSE 10
1407 #define FF_CMP_W53 11
1408 #define FF_CMP_W97 12
1410 #define FF_CMP_DCTMAX 13
1411 #define FF_CMP_DCT264 14
1412 #define FF_CMP_CHROMA 256
1415 * ME diamond size & shape
1416 * - encoding: Set by user.
1417 * - decoding: unused
1422 * amount of previous MV predictors (2a+1 x 2a+1 square)
1423 * - encoding: Set by user.
1424 * - decoding: unused
1426 int last_predictor_count;
1429 * prepass for motion estimation
1430 * - encoding: Set by user.
1431 * - decoding: unused
1436 * motion estimation prepass comparison function
1437 * - encoding: Set by user.
1438 * - decoding: unused
1443 * ME prepass diamond size & shape
1444 * - encoding: Set by user.
1445 * - decoding: unused
1451 * - encoding: Set by user.
1452 * - decoding: unused
1454 int me_subpel_quality;
1457 * DTG active format information (additional aspect ratio
1458 * information only used in DVB MPEG-2 transport streams)
1461 * - encoding: unused
1462 * - decoding: Set by decoder.
1464 int dtg_active_format;
1465 #define FF_DTG_AFD_SAME 8
1466 #define FF_DTG_AFD_4_3 9
1467 #define FF_DTG_AFD_16_9 10
1468 #define FF_DTG_AFD_14_9 11
1469 #define FF_DTG_AFD_4_3_SP_14_9 13
1470 #define FF_DTG_AFD_16_9_SP_14_9 14
1471 #define FF_DTG_AFD_SP_4_3 15
1474 * maximum motion estimation search range in subpel units
1475 * If 0 then no limit.
1477 * - encoding: Set by user.
1478 * - decoding: unused
1483 * intra quantizer bias
1484 * - encoding: Set by user.
1485 * - decoding: unused
1487 int intra_quant_bias;
1488 #define FF_DEFAULT_QUANT_BIAS 999999
1491 * inter quantizer bias
1492 * - encoding: Set by user.
1493 * - decoding: unused
1495 int inter_quant_bias;
1499 * - encoding: unused
1500 * - decoding: Set by user.
1503 #define SLICE_FLAG_CODED_ORDER 0x0001 ///< draw_horiz_band() is called in coded order instead of display
1504 #define SLICE_FLAG_ALLOW_FIELD 0x0002 ///< allow draw_horiz_band() with field slices (MPEG2 field pics)
1505 #define SLICE_FLAG_ALLOW_PLANE 0x0004 ///< allow draw_horiz_band() with 1 component at a time (SVQ1)
1508 * XVideo Motion Acceleration
1509 * - encoding: forbidden
1510 * - decoding: set by decoder
1512 int xvmc_acceleration;
1515 * macroblock decision mode
1516 * - encoding: Set by user.
1517 * - decoding: unused
1520 #define FF_MB_DECISION_SIMPLE 0 ///< uses mb_cmp
1521 #define FF_MB_DECISION_BITS 1 ///< chooses the one which needs the fewest bits
1522 #define FF_MB_DECISION_RD 2 ///< rate distortion
1525 * custom intra quantization matrix
1526 * - encoding: Set by user, can be NULL.
1527 * - decoding: Set by libavcodec.
1529 uint16_t *intra_matrix;
1532 * custom inter quantization matrix
1533 * - encoding: Set by user, can be NULL.
1534 * - decoding: Set by libavcodec.
1536 uint16_t *inter_matrix;
1539 * scene change detection threshold
1540 * 0 is default, larger means fewer detected scene changes.
1541 * - encoding: Set by user.
1542 * - decoding: unused
1544 int scenechange_threshold;
1547 * noise reduction strength
1548 * - encoding: Set by user.
1549 * - decoding: unused
1551 int noise_reduction;
1554 * Motion estimation threshold below which no motion estimation is
1555 * performed, but instead the user specified motion vectors are used.
1557 * - encoding: Set by user.
1558 * - decoding: unused
1563 * Macroblock threshold below which the user specified macroblock types will be used.
1564 * - encoding: Set by user.
1565 * - decoding: unused
1570 * precision of the intra DC coefficient - 8
1571 * - encoding: Set by user.
1572 * - decoding: unused
1574 int intra_dc_precision;
1577 * Number of macroblock rows at the top which are skipped.
1578 * - encoding: unused
1579 * - decoding: Set by user.
1584 * Number of macroblock rows at the bottom which are skipped.
1585 * - encoding: unused
1586 * - decoding: Set by user.
1591 * Border processing masking, raises the quantizer for mbs on the borders
1593 * - encoding: Set by user.
1594 * - decoding: unused
1596 float border_masking;
1599 * minimum MB lagrange multipler
1600 * - encoding: Set by user.
1601 * - decoding: unused
1606 * maximum MB lagrange multipler
1607 * - encoding: Set by user.
1608 * - decoding: unused
1614 * - encoding: Set by user.
1615 * - decoding: unused
1617 int me_penalty_compensation;
1621 * - encoding: Set by user.
1622 * - decoding: unused
1628 * - encoding: Set by user.
1629 * - decoding: unused
1635 * - encoding: Set by user.
1636 * - decoding: unused
1641 * number of reference frames
1642 * - encoding: Set by user.
1643 * - decoding: Set by lavc.
1648 * chroma qp offset from luma
1649 * - encoding: Set by user.
1650 * - decoding: unused
1655 * Multiplied by qscale for each frame and added to scene_change_score.
1656 * - encoding: Set by user.
1657 * - decoding: unused
1659 int scenechange_factor;
1663 * Note: Value depends upon the compare function used for fullpel ME.
1664 * - encoding: Set by user.
1665 * - decoding: unused
1670 * Adjust sensitivity of b_frame_strategy 1.
1671 * - encoding: Set by user.
1672 * - decoding: unused
1677 * Chromaticity coordinates of the source primaries.
1678 * - encoding: Set by user
1679 * - decoding: Set by libavcodec
1681 enum AVColorPrimaries color_primaries;
1684 * Color Transfer Characteristic.
1685 * - encoding: Set by user
1686 * - decoding: Set by libavcodec
1688 enum AVColorTransferCharacteristic color_trc;
1691 * YUV colorspace type.
1692 * - encoding: Set by user
1693 * - decoding: Set by libavcodec
1695 enum AVColorSpace colorspace;
1698 * MPEG vs JPEG YUV range.
1699 * - encoding: Set by user
1700 * - decoding: Set by libavcodec
1702 enum AVColorRange color_range;
1705 * This defines the location of chroma samples.
1706 * - encoding: Set by user
1707 * - decoding: Set by libavcodec
1709 enum AVChromaLocation chroma_sample_location;
1713 * Indicates number of picture subdivisions. Used for parallelized
1715 * - encoding: Set by user
1716 * - decoding: unused
1721 * - encoding: set by libavcodec
1722 * - decoding: Set by libavcodec
1724 enum AVFieldOrder field_order;
1727 int sample_rate; ///< samples per second
1728 int channels; ///< number of audio channels
1731 * audio sample format
1732 * - encoding: Set by user.
1733 * - decoding: Set by libavcodec.
1735 enum AVSampleFormat sample_fmt; ///< sample format
1737 /* The following data should not be initialized. */
1739 * Number of samples per channel in an audio frame.
1741 * - encoding: set by libavcodec in avcodec_open2(). Each submitted frame
1742 * except the last must contain exactly frame_size samples per channel.
1743 * May be 0 when the codec has CODEC_CAP_VARIABLE_FRAME_SIZE set, then the
1744 * frame size is not restricted.
1745 * - decoding: may be set by some decoders to indicate constant frame size
1750 * Frame counter, set by libavcodec.
1752 * - decoding: total number of frames returned from the decoder so far.
1753 * - encoding: total number of frames passed to the encoder so far.
1755 * @note the counter is not incremented if encoding/decoding resulted in
1761 * number of bytes per packet if constant and known or 0
1762 * Used by some WAV based audio codecs.
1767 * Audio cutoff bandwidth (0 means "automatic")
1768 * - encoding: Set by user.
1769 * - decoding: unused
1773 #if FF_API_REQUEST_CHANNELS
1775 * Decoder should decode to this many channels if it can (0 for default)
1776 * - encoding: unused
1777 * - decoding: Set by user.
1778 * @deprecated Deprecated in favor of request_channel_layout.
1780 int request_channels;
1784 * Audio channel layout.
1785 * - encoding: set by user.
1786 * - decoding: set by libavcodec.
1788 uint64_t channel_layout;
1791 * Request decoder to use this channel layout if it can (0 for default)
1792 * - encoding: unused
1793 * - decoding: Set by user.
1795 uint64_t request_channel_layout;
1798 * Type of service that the audio stream conveys.
1799 * - encoding: Set by user.
1800 * - decoding: Set by libavcodec.
1802 enum AVAudioServiceType audio_service_type;
1805 * Used to request a sample format from the decoder.
1806 * - encoding: unused.
1807 * - decoding: Set by user.
1809 enum AVSampleFormat request_sample_fmt;
1811 #if FF_API_GET_BUFFER
1813 * Called at the beginning of each frame to get a buffer for it.
1815 * The function will set AVFrame.data[], AVFrame.linesize[].
1816 * AVFrame.extended_data[] must also be set, but it should be the same as
1817 * AVFrame.data[] except for planar audio with more channels than can fit
1818 * in AVFrame.data[]. In that case, AVFrame.data[] shall still contain as
1819 * many data pointers as it can hold.
1821 * if CODEC_CAP_DR1 is not set then get_buffer() must call
1822 * avcodec_default_get_buffer() instead of providing buffers allocated by
1825 * AVFrame.data[] should be 32- or 16-byte-aligned unless the CPU doesn't
1826 * need it. avcodec_default_get_buffer() aligns the output buffer properly,
1827 * but if get_buffer() is overridden then alignment considerations should
1828 * be taken into account.
1830 * @see avcodec_default_get_buffer()
1834 * If pic.reference is set then the frame will be read later by libavcodec.
1835 * avcodec_align_dimensions2() should be used to find the required width and
1836 * height, as they normally need to be rounded up to the next multiple of 16.
1838 * If frame multithreading is used and thread_safe_callbacks is set,
1839 * it may be called from a different thread, but not from more than one at
1840 * once. Does not need to be reentrant.
1842 * @see release_buffer(), reget_buffer()
1843 * @see avcodec_align_dimensions2()
1847 * Decoders request a buffer of a particular size by setting
1848 * AVFrame.nb_samples prior to calling get_buffer(). The decoder may,
1849 * however, utilize only part of the buffer by setting AVFrame.nb_samples
1850 * to a smaller value in the output frame.
1852 * Decoders cannot use the buffer after returning from
1853 * avcodec_decode_audio4(), so they will not call release_buffer(), as it
1854 * is assumed to be released immediately upon return. In some rare cases,
1855 * a decoder may need to call get_buffer() more than once in a single
1856 * call to avcodec_decode_audio4(). In that case, when get_buffer() is
1857 * called again after it has already been called once, the previously
1858 * acquired buffer is assumed to be released at that time and may not be
1859 * reused by the decoder.
1861 * As a convenience, av_samples_get_buffer_size() and
1862 * av_samples_fill_arrays() in libavutil may be used by custom get_buffer()
1863 * functions to find the required data size and to fill data pointers and
1864 * linesize. In AVFrame.linesize, only linesize[0] may be set for audio
1865 * since all planes must be the same size.
1867 * @see av_samples_get_buffer_size(), av_samples_fill_arrays()
1869 * - encoding: unused
1870 * - decoding: Set by libavcodec, user can override.
1872 * @deprecated use get_buffer2()
1874 attribute_deprecated
1875 int (*get_buffer)(struct AVCodecContext *c, AVFrame *pic);
1878 * Called to release buffers which were allocated with get_buffer.
1879 * A released buffer can be reused in get_buffer().
1880 * pic.data[*] must be set to NULL.
1881 * May be called from a different thread if frame multithreading is used,
1882 * but not by more than one thread at once, so does not need to be reentrant.
1883 * - encoding: unused
1884 * - decoding: Set by libavcodec, user can override.
1886 * @deprecated custom freeing callbacks should be set from get_buffer2()
1888 attribute_deprecated
1889 void (*release_buffer)(struct AVCodecContext *c, AVFrame *pic);
1892 * Called at the beginning of a frame to get cr buffer for it.
1893 * Buffer type (size, hints) must be the same. libavcodec won't check it.
1894 * libavcodec will pass previous buffer in pic, function should return
1895 * same buffer or new buffer with old frame "painted" into it.
1896 * If pic.data[0] == NULL must behave like get_buffer().
1897 * if CODEC_CAP_DR1 is not set then reget_buffer() must call
1898 * avcodec_default_reget_buffer() instead of providing buffers allocated by
1900 * - encoding: unused
1901 * - decoding: Set by libavcodec, user can override.
1903 attribute_deprecated
1904 int (*reget_buffer)(struct AVCodecContext *c, AVFrame *pic);
1908 * This callback is called at the beginning of each frame to get data
1909 * buffer(s) for it. There may be one contiguous buffer for all the data or
1910 * there may be a buffer per each data plane or anything in between. Each
1911 * buffer must be reference-counted using the AVBuffer API.
1913 * The following fields will be set in the frame before this callback is
1916 * - width, height (video only)
1917 * - sample_rate, channel_layout, nb_samples (audio only)
1918 * Their values may differ from the corresponding values in
1919 * AVCodecContext. This callback must use the frame values, not the codec
1920 * context values, to calculate the required buffer size.
1922 * This callback must fill the following fields in the frame:
1926 * * if the data is planar audio with more than 8 channels, then this
1927 * callback must allocate and fill extended_data to contain all pointers
1928 * to all data planes. data[] must hold as many pointers as it can.
1929 * extended_data must be allocated with av_malloc() and will be freed in
1931 * * otherwise exended_data must point to data
1932 * - buf[] must contain references to the buffers that contain the frame
1934 * - extended_buf and nb_extended_buf must be allocated with av_malloc() by
1935 * this callback and filled with the extra buffers if there are more
1936 * buffers than buf[] can hold. extended_buf will be freed in
1939 * If CODEC_CAP_DR1 is not set then get_buffer2() must call
1940 * avcodec_default_get_buffer2() instead of providing buffers allocated by
1943 * Each data plane must be aligned to the maximum required by the target
1946 * @see avcodec_default_get_buffer2()
1950 * If AV_GET_BUFFER_FLAG_REF is set in flags then the frame may be reused
1951 * (read and/or written to if it is writable) later by libavcodec.
1953 * If CODEC_FLAG_EMU_EDGE is not set in s->flags, the buffer must contain an
1954 * edge of the size returned by avcodec_get_edge_width() on all sides.
1956 * avcodec_align_dimensions2() should be used to find the required width and
1957 * height, as they normally need to be rounded up to the next multiple of 16.
1959 * If frame multithreading is used and thread_safe_callbacks is set,
1960 * this callback may be called from a different thread, but not from more
1961 * than one at once. Does not need to be reentrant.
1963 * @see avcodec_align_dimensions2()
1967 * Decoders request a buffer of a particular size by setting
1968 * AVFrame.nb_samples prior to calling get_buffer2(). The decoder may,
1969 * however, utilize only part of the buffer by setting AVFrame.nb_samples
1970 * to a smaller value in the output frame.
1972 * As a convenience, av_samples_get_buffer_size() and
1973 * av_samples_fill_arrays() in libavutil may be used by custom get_buffer2()
1974 * functions to find the required data size and to fill data pointers and
1975 * linesize. In AVFrame.linesize, only linesize[0] may be set for audio
1976 * since all planes must be the same size.
1978 * @see av_samples_get_buffer_size(), av_samples_fill_arrays()
1980 * - encoding: unused
1981 * - decoding: Set by libavcodec, user can override.
1983 int (*get_buffer2)(struct AVCodecContext *s, AVFrame *frame, int flags);
1986 * If non-zero, the decoded audio and video frames returned from
1987 * avcodec_decode_video2() and avcodec_decode_audio4() are reference-counted
1988 * and are valid indefinitely. The caller must free them with
1989 * av_frame_unref() when they are not needed anymore.
1990 * Otherwise, the decoded frames must not be freed by the caller and are
1991 * only valid until the next decode call.
1993 * - encoding: unused
1994 * - decoding: set by the caller before avcodec_open2().
1996 int refcounted_frames;
1998 /* - encoding parameters */
1999 float qcompress; ///< amount of qscale change between easy & hard scenes (0.0-1.0)
2000 float qblur; ///< amount of qscale smoothing over time (0.0-1.0)
2004 * - encoding: Set by user.
2005 * - decoding: unused
2011 * - encoding: Set by user.
2012 * - decoding: unused
2017 * maximum quantizer difference between frames
2018 * - encoding: Set by user.
2019 * - decoding: unused
2024 * ratecontrol qmin qmax limiting method
2025 * 0-> clipping, 1-> use a nice continuous function to limit qscale wthin qmin/qmax.
2026 * - encoding: Set by user.
2027 * - decoding: unused
2035 * decoder bitstream buffer size
2036 * - encoding: Set by user.
2037 * - decoding: unused
2042 * ratecontrol override, see RcOverride
2043 * - encoding: Allocated/set/freed by user.
2044 * - decoding: unused
2046 int rc_override_count;
2047 RcOverride *rc_override;
2050 * rate control equation
2051 * - encoding: Set by user
2052 * - decoding: unused
2058 * - encoding: Set by user.
2059 * - decoding: unused
2065 * - encoding: Set by user.
2066 * - decoding: unused
2070 float rc_buffer_aggressivity;
2073 * initial complexity for pass1 ratecontrol
2074 * - encoding: Set by user.
2075 * - decoding: unused
2077 float rc_initial_cplx;
2080 * Ratecontrol attempt to use, at maximum, <value> of what can be used without an underflow.
2081 * - encoding: Set by user.
2082 * - decoding: unused.
2084 float rc_max_available_vbv_use;
2087 * Ratecontrol attempt to use, at least, <value> times the amount needed to prevent a vbv overflow.
2088 * - encoding: Set by user.
2089 * - decoding: unused.
2091 float rc_min_vbv_overflow_use;
2094 * Number of bits which should be loaded into the rc buffer before decoding starts.
2095 * - encoding: Set by user.
2096 * - decoding: unused
2098 int rc_initial_buffer_occupancy;
2100 #define FF_CODER_TYPE_VLC 0
2101 #define FF_CODER_TYPE_AC 1
2102 #define FF_CODER_TYPE_RAW 2
2103 #define FF_CODER_TYPE_RLE 3
2104 #define FF_CODER_TYPE_DEFLATE 4
2107 * - encoding: Set by user.
2108 * - decoding: unused
2114 * - encoding: Set by user.
2115 * - decoding: unused
2120 * minimum Lagrange multipler
2121 * - encoding: Set by user.
2122 * - decoding: unused
2127 * maximum Lagrange multipler
2128 * - encoding: Set by user.
2129 * - decoding: unused
2134 * frame skip threshold
2135 * - encoding: Set by user.
2136 * - decoding: unused
2138 int frame_skip_threshold;
2142 * - encoding: Set by user.
2143 * - decoding: unused
2145 int frame_skip_factor;
2148 * frame skip exponent
2149 * - encoding: Set by user.
2150 * - decoding: unused
2155 * frame skip comparison function
2156 * - encoding: Set by user.
2157 * - decoding: unused
2162 * trellis RD quantization
2163 * - encoding: Set by user.
2164 * - decoding: unused
2169 * - encoding: Set by user.
2170 * - decoding: unused
2172 int min_prediction_order;
2175 * - encoding: Set by user.
2176 * - decoding: unused
2178 int max_prediction_order;
2181 * GOP timecode frame start number, in non drop frame format
2182 * - encoding: Set by user.
2183 * - decoding: unused
2185 int64_t timecode_frame_start;
2187 /* The RTP callback: This function is called */
2188 /* every time the encoder has a packet to send. */
2189 /* It depends on the encoder if the data starts */
2190 /* with a Start Code (it should). H.263 does. */
2191 /* mb_nb contains the number of macroblocks */
2192 /* encoded in the RTP payload. */
2193 void (*rtp_callback)(struct AVCodecContext *avctx, void *data, int size, int mb_nb);
2195 int rtp_payload_size; /* The size of the RTP payload: the coder will */
2196 /* do its best to deliver a chunk with size */
2197 /* below rtp_payload_size, the chunk will start */
2198 /* with a start code on some codecs like H.263. */
2199 /* This doesn't take account of any particular */
2200 /* headers inside the transmitted RTP payload. */
2202 /* statistics, used for 2-pass encoding */
2213 * number of bits used for the previously encoded frame
2214 * - encoding: Set by libavcodec.
2215 * - decoding: unused
2220 * pass1 encoding statistics output buffer
2221 * - encoding: Set by libavcodec.
2222 * - decoding: unused
2227 * pass2 encoding statistics input buffer
2228 * Concatenated stuff from stats_out of pass1 should be placed here.
2229 * - encoding: Allocated/set/freed by user.
2230 * - decoding: unused
2235 * Work around bugs in encoders which sometimes cannot be detected automatically.
2236 * - encoding: Set by user
2237 * - decoding: Set by user
2239 int workaround_bugs;
2240 #define FF_BUG_AUTODETECT 1 ///< autodetection
2241 #define FF_BUG_OLD_MSMPEG4 2
2242 #define FF_BUG_XVID_ILACE 4
2243 #define FF_BUG_UMP4 8
2244 #define FF_BUG_NO_PADDING 16
2245 #define FF_BUG_AMV 32
2246 #define FF_BUG_AC_VLC 0 ///< Will be removed, libavcodec can now handle these non-compliant files by default.
2247 #define FF_BUG_QPEL_CHROMA 64
2248 #define FF_BUG_STD_QPEL 128
2249 #define FF_BUG_QPEL_CHROMA2 256
2250 #define FF_BUG_DIRECT_BLOCKSIZE 512
2251 #define FF_BUG_EDGE 1024
2252 #define FF_BUG_HPEL_CHROMA 2048
2253 #define FF_BUG_DC_CLIP 4096
2254 #define FF_BUG_MS 8192 ///< Work around various bugs in Microsoft's broken decoders.
2255 #define FF_BUG_TRUNCATED 16384
2258 * strictly follow the standard (MPEG4, ...).
2259 * - encoding: Set by user.
2260 * - decoding: Set by user.
2261 * Setting this to STRICT or higher means the encoder and decoder will
2262 * generally do stupid things, whereas setting it to unofficial or lower
2263 * will mean the encoder might produce output that is not supported by all
2264 * spec-compliant decoders. Decoders don't differentiate between normal,
2265 * unofficial and experimental (that is, they always try to decode things
2266 * when they can) unless they are explicitly asked to behave stupidly
2267 * (=strictly conform to the specs)
2269 int strict_std_compliance;
2270 #define FF_COMPLIANCE_VERY_STRICT 2 ///< Strictly conform to an older more strict version of the spec or reference software.
2271 #define FF_COMPLIANCE_STRICT 1 ///< Strictly conform to all the things in the spec no matter what consequences.
2272 #define FF_COMPLIANCE_NORMAL 0
2273 #define FF_COMPLIANCE_UNOFFICIAL -1 ///< Allow unofficial extensions
2274 #define FF_COMPLIANCE_EXPERIMENTAL -2 ///< Allow nonstandardized experimental things.
2277 * error concealment flags
2278 * - encoding: unused
2279 * - decoding: Set by user.
2281 int error_concealment;
2282 #define FF_EC_GUESS_MVS 1
2283 #define FF_EC_DEBLOCK 2
2287 * - encoding: Set by user.
2288 * - decoding: Set by user.
2291 #define FF_DEBUG_PICT_INFO 1
2292 #define FF_DEBUG_RC 2
2293 #define FF_DEBUG_BITSTREAM 4
2294 #define FF_DEBUG_MB_TYPE 8
2295 #define FF_DEBUG_QP 16
2296 #define FF_DEBUG_MV 32
2297 #define FF_DEBUG_DCT_COEFF 0x00000040
2298 #define FF_DEBUG_SKIP 0x00000080
2299 #define FF_DEBUG_STARTCODE 0x00000100
2300 #define FF_DEBUG_PTS 0x00000200
2301 #define FF_DEBUG_ER 0x00000400
2302 #define FF_DEBUG_MMCO 0x00000800
2303 #define FF_DEBUG_BUGS 0x00001000
2304 #define FF_DEBUG_VIS_QP 0x00002000
2305 #define FF_DEBUG_VIS_MB_TYPE 0x00004000
2306 #define FF_DEBUG_BUFFERS 0x00008000
2307 #define FF_DEBUG_THREADS 0x00010000
2311 * - encoding: Set by user.
2312 * - decoding: Set by user.
2315 #define FF_DEBUG_VIS_MV_P_FOR 0x00000001 //visualize forward predicted MVs of P frames
2316 #define FF_DEBUG_VIS_MV_B_FOR 0x00000002 //visualize forward predicted MVs of B frames
2317 #define FF_DEBUG_VIS_MV_B_BACK 0x00000004 //visualize backward predicted MVs of B frames
2320 * Error recognition; may misdetect some more or less valid parts as errors.
2321 * - encoding: unused
2322 * - decoding: Set by user.
2324 int err_recognition;
2325 #define AV_EF_CRCCHECK (1<<0)
2326 #define AV_EF_BITSTREAM (1<<1)
2327 #define AV_EF_BUFFER (1<<2)
2328 #define AV_EF_EXPLODE (1<<3)
2331 * opaque 64bit number (generally a PTS) that will be reordered and
2332 * output in AVFrame.reordered_opaque
2333 * @deprecated in favor of pkt_pts
2334 * - encoding: unused
2335 * - decoding: Set by user.
2337 int64_t reordered_opaque;
2340 * Hardware accelerator in use
2341 * - encoding: unused.
2342 * - decoding: Set by libavcodec
2344 struct AVHWAccel *hwaccel;
2347 * Hardware accelerator context.
2348 * For some hardware accelerators, a global context needs to be
2349 * provided by the user. In that case, this holds display-dependent
2350 * data Libav cannot instantiate itself. Please refer to the
2351 * Libav HW accelerator documentation to know how to fill this
2352 * is. e.g. for VA API, this is a struct vaapi_context.
2353 * - encoding: unused
2354 * - decoding: Set by user
2356 void *hwaccel_context;
2360 * - encoding: Set by libavcodec if flags&CODEC_FLAG_PSNR.
2361 * - decoding: unused
2363 uint64_t error[AV_NUM_DATA_POINTERS];
2366 * DCT algorithm, see FF_DCT_* below
2367 * - encoding: Set by user.
2368 * - decoding: unused
2371 #define FF_DCT_AUTO 0
2372 #define FF_DCT_FASTINT 1
2373 #define FF_DCT_INT 2
2374 #define FF_DCT_MMX 3
2375 #define FF_DCT_ALTIVEC 5
2376 #define FF_DCT_FAAN 6
2379 * IDCT algorithm, see FF_IDCT_* below.
2380 * - encoding: Set by user.
2381 * - decoding: Set by user.
2384 #define FF_IDCT_AUTO 0
2385 #define FF_IDCT_INT 1
2386 #define FF_IDCT_SIMPLE 2
2387 #define FF_IDCT_SIMPLEMMX 3
2389 #define FF_IDCT_LIBMPEG2MMX 4
2392 #define FF_IDCT_MMI 5
2394 #define FF_IDCT_ARM 7
2395 #define FF_IDCT_ALTIVEC 8
2396 #define FF_IDCT_SH4 9
2397 #define FF_IDCT_SIMPLEARM 10
2398 #define FF_IDCT_IPP 13
2399 #define FF_IDCT_XVIDMMX 14
2400 #define FF_IDCT_SIMPLEARMV5TE 16
2401 #define FF_IDCT_SIMPLEARMV6 17
2402 #define FF_IDCT_SIMPLEVIS 18
2403 #define FF_IDCT_FAAN 20
2404 #define FF_IDCT_SIMPLENEON 22
2405 #define FF_IDCT_SIMPLEALPHA 23
2407 #define FF_IDCT_H264 11
2408 #define FF_IDCT_VP3 12
2409 #define FF_IDCT_CAVS 15
2410 #define FF_IDCT_WMV2 19
2411 #define FF_IDCT_EA 21
2412 #define FF_IDCT_BINK 24
2416 * bits per sample/pixel from the demuxer (needed for huffyuv).
2417 * - encoding: Set by libavcodec.
2418 * - decoding: Set by user.
2420 int bits_per_coded_sample;
2423 * Bits per sample/pixel of internal libavcodec pixel/sample format.
2424 * - encoding: set by user.
2425 * - decoding: set by libavcodec.
2427 int bits_per_raw_sample;
2430 * low resolution decoding, 1-> 1/2 size, 2->1/4 size
2431 * - encoding: unused
2432 * - decoding: Set by user.
2434 attribute_deprecated int lowres;
2437 * the picture in the bitstream
2438 * - encoding: Set by libavcodec.
2439 * - decoding: Set by libavcodec.
2441 AVFrame *coded_frame;
2445 * is used to decide how many independent tasks should be passed to execute()
2446 * - encoding: Set by user.
2447 * - decoding: Set by user.
2452 * Which multithreading methods to use.
2453 * Use of FF_THREAD_FRAME will increase decoding delay by one frame per thread,
2454 * so clients which cannot provide future frames should not use it.
2456 * - encoding: Set by user, otherwise the default is used.
2457 * - decoding: Set by user, otherwise the default is used.
2460 #define FF_THREAD_FRAME 1 ///< Decode more than one frame at once
2461 #define FF_THREAD_SLICE 2 ///< Decode more than one part of a single frame at once
2464 * Which multithreading methods are in use by the codec.
2465 * - encoding: Set by libavcodec.
2466 * - decoding: Set by libavcodec.
2468 int active_thread_type;
2471 * Set by the client if its custom get_buffer() callback can be called
2472 * synchronously from another thread, which allows faster multithreaded decoding.
2473 * draw_horiz_band() will be called from other threads regardless of this setting.
2474 * Ignored if the default get_buffer() is used.
2475 * - encoding: Set by user.
2476 * - decoding: Set by user.
2478 int thread_safe_callbacks;
2481 * The codec may call this to execute several independent things.
2482 * It will return only after finishing all tasks.
2483 * The user may replace this with some multithreaded implementation,
2484 * the default implementation will execute the parts serially.
2485 * @param count the number of things to execute
2486 * - encoding: Set by libavcodec, user can override.
2487 * - decoding: Set by libavcodec, user can override.
2489 int (*execute)(struct AVCodecContext *c, int (*func)(struct AVCodecContext *c2, void *arg), void *arg2, int *ret, int count, int size);
2492 * The codec may call this to execute several independent things.
2493 * It will return only after finishing all tasks.
2494 * The user may replace this with some multithreaded implementation,
2495 * the default implementation will execute the parts serially.
2496 * Also see avcodec_thread_init and e.g. the --enable-pthread configure option.
2497 * @param c context passed also to func
2498 * @param count the number of things to execute
2499 * @param arg2 argument passed unchanged to func
2500 * @param ret return values of executed functions, must have space for "count" values. May be NULL.
2501 * @param func function that will be called count times, with jobnr from 0 to count-1.
2502 * threadnr will be in the range 0 to c->thread_count-1 < MAX_THREADS and so that no
2503 * two instances of func executing at the same time will have the same threadnr.
2504 * @return always 0 currently, but code should handle a future improvement where when any call to func
2505 * returns < 0 no further calls to func may be done and < 0 is returned.
2506 * - encoding: Set by libavcodec, user can override.
2507 * - decoding: Set by libavcodec, user can override.
2509 int (*execute2)(struct AVCodecContext *c, int (*func)(struct AVCodecContext *c2, void *arg, int jobnr, int threadnr), void *arg2, int *ret, int count);
2513 * Can be used by execute() to store some per AVCodecContext stuff.
2514 * - encoding: set by execute()
2515 * - decoding: set by execute()
2517 void *thread_opaque;
2520 * noise vs. sse weight for the nsse comparsion function
2521 * - encoding: Set by user.
2522 * - decoding: unused
2528 * - encoding: Set by user.
2529 * - decoding: Set by libavcodec.
2532 #define FF_PROFILE_UNKNOWN -99
2533 #define FF_PROFILE_RESERVED -100
2535 #define FF_PROFILE_AAC_MAIN 0
2536 #define FF_PROFILE_AAC_LOW 1
2537 #define FF_PROFILE_AAC_SSR 2
2538 #define FF_PROFILE_AAC_LTP 3
2539 #define FF_PROFILE_AAC_HE 4
2540 #define FF_PROFILE_AAC_HE_V2 28
2541 #define FF_PROFILE_AAC_LD 22
2542 #define FF_PROFILE_AAC_ELD 38
2544 #define FF_PROFILE_DTS 20
2545 #define FF_PROFILE_DTS_ES 30
2546 #define FF_PROFILE_DTS_96_24 40
2547 #define FF_PROFILE_DTS_HD_HRA 50
2548 #define FF_PROFILE_DTS_HD_MA 60
2550 #define FF_PROFILE_MPEG2_422 0
2551 #define FF_PROFILE_MPEG2_HIGH 1
2552 #define FF_PROFILE_MPEG2_SS 2
2553 #define FF_PROFILE_MPEG2_SNR_SCALABLE 3
2554 #define FF_PROFILE_MPEG2_MAIN 4
2555 #define FF_PROFILE_MPEG2_SIMPLE 5
2557 #define FF_PROFILE_H264_CONSTRAINED (1<<9) // 8+1; constraint_set1_flag
2558 #define FF_PROFILE_H264_INTRA (1<<11) // 8+3; constraint_set3_flag
2560 #define FF_PROFILE_H264_BASELINE 66
2561 #define FF_PROFILE_H264_CONSTRAINED_BASELINE (66|FF_PROFILE_H264_CONSTRAINED)
2562 #define FF_PROFILE_H264_MAIN 77
2563 #define FF_PROFILE_H264_EXTENDED 88
2564 #define FF_PROFILE_H264_HIGH 100
2565 #define FF_PROFILE_H264_HIGH_10 110
2566 #define FF_PROFILE_H264_HIGH_10_INTRA (110|FF_PROFILE_H264_INTRA)
2567 #define FF_PROFILE_H264_HIGH_422 122
2568 #define FF_PROFILE_H264_HIGH_422_INTRA (122|FF_PROFILE_H264_INTRA)
2569 #define FF_PROFILE_H264_HIGH_444 144
2570 #define FF_PROFILE_H264_HIGH_444_PREDICTIVE 244
2571 #define FF_PROFILE_H264_HIGH_444_INTRA (244|FF_PROFILE_H264_INTRA)
2572 #define FF_PROFILE_H264_CAVLC_444 44
2574 #define FF_PROFILE_VC1_SIMPLE 0
2575 #define FF_PROFILE_VC1_MAIN 1
2576 #define FF_PROFILE_VC1_COMPLEX 2
2577 #define FF_PROFILE_VC1_ADVANCED 3
2579 #define FF_PROFILE_MPEG4_SIMPLE 0
2580 #define FF_PROFILE_MPEG4_SIMPLE_SCALABLE 1
2581 #define FF_PROFILE_MPEG4_CORE 2
2582 #define FF_PROFILE_MPEG4_MAIN 3
2583 #define FF_PROFILE_MPEG4_N_BIT 4
2584 #define FF_PROFILE_MPEG4_SCALABLE_TEXTURE 5
2585 #define FF_PROFILE_MPEG4_SIMPLE_FACE_ANIMATION 6
2586 #define FF_PROFILE_MPEG4_BASIC_ANIMATED_TEXTURE 7
2587 #define FF_PROFILE_MPEG4_HYBRID 8
2588 #define FF_PROFILE_MPEG4_ADVANCED_REAL_TIME 9
2589 #define FF_PROFILE_MPEG4_CORE_SCALABLE 10
2590 #define FF_PROFILE_MPEG4_ADVANCED_CODING 11
2591 #define FF_PROFILE_MPEG4_ADVANCED_CORE 12
2592 #define FF_PROFILE_MPEG4_ADVANCED_SCALABLE_TEXTURE 13
2593 #define FF_PROFILE_MPEG4_SIMPLE_STUDIO 14
2594 #define FF_PROFILE_MPEG4_ADVANCED_SIMPLE 15
2598 * - encoding: Set by user.
2599 * - decoding: Set by libavcodec.
2602 #define FF_LEVEL_UNKNOWN -99
2606 * - encoding: unused
2607 * - decoding: Set by user.
2609 enum AVDiscard skip_loop_filter;
2613 * - encoding: unused
2614 * - decoding: Set by user.
2616 enum AVDiscard skip_idct;
2620 * - encoding: unused
2621 * - decoding: Set by user.
2623 enum AVDiscard skip_frame;
2626 * Header containing style information for text subtitles.
2627 * For SUBTITLE_ASS subtitle type, it should contain the whole ASS
2628 * [Script Info] and [V4+ Styles] section, plus the [Events] line and
2629 * the Format line following. It shouldn't include any Dialogue line.
2630 * - encoding: Set/allocated/freed by user (before avcodec_open2())
2631 * - decoding: Set/allocated/freed by libavcodec (by avcodec_open2())
2633 uint8_t *subtitle_header;
2634 int subtitle_header_size;
2637 * Simulates errors in the bitstream to test error concealment.
2638 * - encoding: Set by user.
2639 * - decoding: unused
2644 * Current packet as passed into the decoder, to avoid having
2645 * to pass the packet into every function. Currently only valid
2646 * inside lavc and get/release_buffer callbacks.
2647 * - decoding: set by avcodec_decode_*, read by get_buffer() for setting pkt_pts
2648 * - encoding: unused
2653 * VBV delay coded in the last frame (in periods of a 27 MHz clock).
2654 * Used for compliant TS muxing.
2655 * - encoding: Set by libavcodec.
2656 * - decoding: unused.
2664 typedef struct AVProfile {
2666 const char *name; ///< short name for the profile
2669 typedef struct AVCodecDefault AVCodecDefault;
2676 typedef struct AVCodec {
2678 * Name of the codec implementation.
2679 * The name is globally unique among encoders and among decoders (but an
2680 * encoder and a decoder can share the same name).
2681 * This is the primary way to find a codec from the user perspective.
2685 * Descriptive name for the codec, meant to be more human readable than name.
2686 * You should use the NULL_IF_CONFIG_SMALL() macro to define it.
2688 const char *long_name;
2689 enum AVMediaType type;
2692 * Codec capabilities.
2696 const AVRational *supported_framerates; ///< array of supported framerates, or NULL if any, array is terminated by {0,0}
2697 const enum AVPixelFormat *pix_fmts; ///< array of supported pixel formats, or NULL if unknown, array is terminated by -1
2698 const int *supported_samplerates; ///< array of supported audio samplerates, or NULL if unknown, array is terminated by 0
2699 const enum AVSampleFormat *sample_fmts; ///< array of supported sample formats, or NULL if unknown, array is terminated by -1
2700 const uint64_t *channel_layouts; ///< array of support channel layouts, or NULL if unknown. array is terminated by 0
2701 attribute_deprecated uint8_t max_lowres; ///< maximum value for lowres supported by the decoder
2702 const AVClass *priv_class; ///< AVClass for the private context
2703 const AVProfile *profiles; ///< array of recognized profiles, or NULL if unknown, array is terminated by {FF_PROFILE_UNKNOWN}
2705 /*****************************************************************
2706 * No fields below this line are part of the public API. They
2707 * may not be used outside of libavcodec and can be changed and
2709 * New public fields should be added right above.
2710 *****************************************************************
2713 struct AVCodec *next;
2715 * @name Frame-level threading support functions
2719 * If defined, called on thread contexts when they are created.
2720 * If the codec allocates writable tables in init(), re-allocate them here.
2721 * priv_data will be set to a copy of the original.
2723 int (*init_thread_copy)(AVCodecContext *);
2725 * Copy necessary context variables from a previous thread context to the current one.
2726 * If not defined, the next thread will start automatically; otherwise, the codec
2727 * must call ff_thread_finish_setup().
2729 * dst and src will (rarely) point to the same context, in which case memcpy should be skipped.
2731 int (*update_thread_context)(AVCodecContext *dst, const AVCodecContext *src);
2735 * Private codec-specific defaults.
2737 const AVCodecDefault *defaults;
2740 * Initialize codec static data, called from avcodec_register().
2742 void (*init_static_data)(struct AVCodec *codec);
2744 int (*init)(AVCodecContext *);
2745 int (*encode_sub)(AVCodecContext *, uint8_t *buf, int buf_size,
2746 const struct AVSubtitle *sub);
2748 * Encode data to an AVPacket.
2750 * @param avctx codec context
2751 * @param avpkt output AVPacket (may contain a user-provided buffer)
2752 * @param[in] frame AVFrame containing the raw data to be encoded
2753 * @param[out] got_packet_ptr encoder sets to 0 or 1 to indicate that a
2754 * non-empty packet was returned in avpkt.
2755 * @return 0 on success, negative error code on failure
2757 int (*encode2)(AVCodecContext *avctx, AVPacket *avpkt, const AVFrame *frame,
2758 int *got_packet_ptr);
2759 int (*decode)(AVCodecContext *, void *outdata, int *outdata_size, AVPacket *avpkt);
2760 int (*close)(AVCodecContext *);
2763 * Will be called when seeking
2765 void (*flush)(AVCodecContext *);
2771 typedef struct AVHWAccel {
2773 * Name of the hardware accelerated codec.
2774 * The name is globally unique among encoders and among decoders (but an
2775 * encoder and a decoder can share the same name).
2780 * Type of codec implemented by the hardware accelerator.
2782 * See AVMEDIA_TYPE_xxx
2784 enum AVMediaType type;
2787 * Codec implemented by the hardware accelerator.
2789 * See AV_CODEC_ID_xxx
2794 * Supported pixel format.
2796 * Only hardware accelerated formats are supported here.
2798 enum AVPixelFormat pix_fmt;
2801 * Hardware accelerated codec capabilities.
2802 * see FF_HWACCEL_CODEC_CAP_*
2806 struct AVHWAccel *next;
2809 * Called at the beginning of each frame or field picture.
2811 * Meaningful frame information (codec specific) is guaranteed to
2812 * be parsed at this point. This function is mandatory.
2814 * Note that buf can be NULL along with buf_size set to 0.
2815 * Otherwise, this means the whole frame is available at this point.
2817 * @param avctx the codec context
2818 * @param buf the frame data buffer base
2819 * @param buf_size the size of the frame in bytes
2820 * @return zero if successful, a negative value otherwise
2822 int (*start_frame)(AVCodecContext *avctx, const uint8_t *buf, uint32_t buf_size);
2825 * Callback for each slice.
2827 * Meaningful slice information (codec specific) is guaranteed to
2828 * be parsed at this point. This function is mandatory.
2830 * @param avctx the codec context
2831 * @param buf the slice data buffer base
2832 * @param buf_size the size of the slice in bytes
2833 * @return zero if successful, a negative value otherwise
2835 int (*decode_slice)(AVCodecContext *avctx, const uint8_t *buf, uint32_t buf_size);
2838 * Called at the end of each frame or field picture.
2840 * The whole picture is parsed at this point and can now be sent
2841 * to the hardware accelerator. This function is mandatory.
2843 * @param avctx the codec context
2844 * @return zero if successful, a negative value otherwise
2846 int (*end_frame)(AVCodecContext *avctx);
2849 * Size of HW accelerator private data.
2851 * Private data is allocated with av_mallocz() before
2852 * AVCodecContext.get_buffer() and deallocated after
2853 * AVCodecContext.release_buffer().
2859 * @defgroup lavc_picture AVPicture
2861 * Functions for working with AVPicture
2866 * four components are given, that's all.
2867 * the last component is alpha
2869 typedef struct AVPicture {
2870 uint8_t *data[AV_NUM_DATA_POINTERS];
2871 int linesize[AV_NUM_DATA_POINTERS]; ///< number of bytes per line
2878 #define AVPALETTE_SIZE 1024
2879 #define AVPALETTE_COUNT 256
2881 enum AVSubtitleType {
2884 SUBTITLE_BITMAP, ///< A bitmap, pict will be set
2887 * Plain text, the text field must be set by the decoder and is
2888 * authoritative. ass and pict fields may contain approximations.
2893 * Formatted text, the ass field must be set by the decoder and is
2894 * authoritative. pict and text fields may contain approximations.
2899 #define AV_SUBTITLE_FLAG_FORCED 0x00000001
2901 typedef struct AVSubtitleRect {
2902 int x; ///< top left corner of pict, undefined when pict is not set
2903 int y; ///< top left corner of pict, undefined when pict is not set
2904 int w; ///< width of pict, undefined when pict is not set
2905 int h; ///< height of pict, undefined when pict is not set
2906 int nb_colors; ///< number of colors in pict, undefined when pict is not set
2909 * data+linesize for the bitmap of this subtitle.
2910 * can be set for text/ass as well once they where rendered
2913 enum AVSubtitleType type;
2915 char *text; ///< 0 terminated plain UTF-8 text
2918 * 0 terminated ASS/SSA compatible event line.
2919 * The pressentation of this is unaffected by the other values in this
2926 typedef struct AVSubtitle {
2927 uint16_t format; /* 0 = graphics */
2928 uint32_t start_display_time; /* relative to packet pts, in ms */
2929 uint32_t end_display_time; /* relative to packet pts, in ms */
2931 AVSubtitleRect **rects;
2932 int64_t pts; ///< Same as packet pts, in AV_TIME_BASE
2936 * If c is NULL, returns the first registered codec,
2937 * if c is non-NULL, returns the next registered codec after c,
2938 * or NULL if c is the last one.
2940 AVCodec *av_codec_next(const AVCodec *c);
2943 * Return the LIBAVCODEC_VERSION_INT constant.
2945 unsigned avcodec_version(void);
2948 * Return the libavcodec build-time configuration.
2950 const char *avcodec_configuration(void);
2953 * Return the libavcodec license.
2955 const char *avcodec_license(void);
2958 * Register the codec codec and initialize libavcodec.
2960 * @warning either this function or avcodec_register_all() must be called
2961 * before any other libavcodec functions.
2963 * @see avcodec_register_all()
2965 void avcodec_register(AVCodec *codec);
2968 * Register all the codecs, parsers and bitstream filters which were enabled at
2969 * configuration time. If you do not call this function you can select exactly
2970 * which formats you want to support, by using the individual registration
2973 * @see avcodec_register
2974 * @see av_register_codec_parser
2975 * @see av_register_bitstream_filter
2977 void avcodec_register_all(void);
2980 * Allocate an AVCodecContext and set its fields to default values. The
2981 * resulting struct can be deallocated by calling avcodec_close() on it followed
2984 * @param codec if non-NULL, allocate private data and initialize defaults
2985 * for the given codec. It is illegal to then call avcodec_open2()
2986 * with a different codec.
2987 * If NULL, then the codec-specific defaults won't be initialized,
2988 * which may result in suboptimal default settings (this is
2989 * important mainly for encoders, e.g. libx264).
2991 * @return An AVCodecContext filled with default values or NULL on failure.
2992 * @see avcodec_get_context_defaults
2994 AVCodecContext *avcodec_alloc_context3(const AVCodec *codec);
2997 * Set the fields of the given AVCodecContext to default values corresponding
2998 * to the given codec (defaults may be codec-dependent).
3000 * Do not call this function if a non-NULL codec has been passed
3001 * to avcodec_alloc_context3() that allocated this AVCodecContext.
3002 * If codec is non-NULL, it is illegal to call avcodec_open2() with a
3003 * different codec on this AVCodecContext.
3005 int avcodec_get_context_defaults3(AVCodecContext *s, const AVCodec *codec);
3008 * Get the AVClass for AVCodecContext. It can be used in combination with
3009 * AV_OPT_SEARCH_FAKE_OBJ for examining options.
3011 * @see av_opt_find().
3013 const AVClass *avcodec_get_class(void);
3016 * Copy the settings of the source AVCodecContext into the destination
3017 * AVCodecContext. The resulting destination codec context will be
3018 * unopened, i.e. you are required to call avcodec_open2() before you
3019 * can use this AVCodecContext to decode/encode video/audio data.
3021 * @param dest target codec context, should be initialized with
3022 * avcodec_alloc_context3(), but otherwise uninitialized
3023 * @param src source codec context
3024 * @return AVERROR() on error (e.g. memory allocation error), 0 on success
3026 int avcodec_copy_context(AVCodecContext *dest, const AVCodecContext *src);
3029 * Allocate an AVFrame and set its fields to default values. The resulting
3030 * struct must be freed using avcodec_free_frame().
3032 * @return An AVFrame filled with default values or NULL on failure.
3033 * @see avcodec_get_frame_defaults
3035 AVFrame *avcodec_alloc_frame(void);
3038 * Set the fields of the given AVFrame to default values.
3040 * @param frame The AVFrame of which the fields should be set to default values.
3042 void avcodec_get_frame_defaults(AVFrame *frame);
3045 * Free the frame and any dynamically allocated objects in it,
3046 * e.g. extended_data.
3048 * @param frame frame to be freed. The pointer will be set to NULL.
3050 * @warning this function does NOT free the data buffers themselves
3051 * (it does not know how, since they might have been allocated with
3052 * a custom get_buffer()).
3054 void avcodec_free_frame(AVFrame **frame);
3057 * Initialize the AVCodecContext to use the given AVCodec. Prior to using this
3058 * function the context has to be allocated with avcodec_alloc_context3().
3060 * The functions avcodec_find_decoder_by_name(), avcodec_find_encoder_by_name(),
3061 * avcodec_find_decoder() and avcodec_find_encoder() provide an easy way for
3062 * retrieving a codec.
3064 * @warning This function is not thread safe!
3067 * avcodec_register_all();
3068 * av_dict_set(&opts, "b", "2.5M", 0);
3069 * codec = avcodec_find_decoder(AV_CODEC_ID_H264);
3073 * context = avcodec_alloc_context3(codec);
3075 * if (avcodec_open2(context, codec, opts) < 0)
3079 * @param avctx The context to initialize.
3080 * @param codec The codec to open this context for. If a non-NULL codec has been
3081 * previously passed to avcodec_alloc_context3() or
3082 * avcodec_get_context_defaults3() for this context, then this
3083 * parameter MUST be either NULL or equal to the previously passed
3085 * @param options A dictionary filled with AVCodecContext and codec-private options.
3086 * On return this object will be filled with options that were not found.
3088 * @return zero on success, a negative value on error
3089 * @see avcodec_alloc_context3(), avcodec_find_decoder(), avcodec_find_encoder(),
3090 * av_dict_set(), av_opt_find().
3092 int avcodec_open2(AVCodecContext *avctx, const AVCodec *codec, AVDictionary **options);
3095 * Close a given AVCodecContext and free all the data associated with it
3096 * (but not the AVCodecContext itself).
3098 * Calling this function on an AVCodecContext that hasn't been opened will free
3099 * the codec-specific data allocated in avcodec_alloc_context3() /
3100 * avcodec_get_context_defaults3() with a non-NULL codec. Subsequent calls will
3103 int avcodec_close(AVCodecContext *avctx);
3106 * Free all allocated data in the given subtitle struct.
3108 * @param sub AVSubtitle to free.
3110 void avsubtitle_free(AVSubtitle *sub);
3117 * @addtogroup lavc_packet
3121 #if FF_API_DESTRUCT_PACKET
3123 * Default packet destructor.
3124 * @deprecated use the AVBuffer API instead
3126 attribute_deprecated
3127 void av_destruct_packet(AVPacket *pkt);
3131 * Initialize optional fields of a packet with default values.
3133 * Note, this does not touch the data and size members, which have to be
3134 * initialized separately.
3138 void av_init_packet(AVPacket *pkt);
3141 * Allocate the payload of a packet and initialize its fields with
3145 * @param size wanted payload size
3146 * @return 0 if OK, AVERROR_xxx otherwise
3148 int av_new_packet(AVPacket *pkt, int size);
3151 * Reduce packet size, correctly zeroing padding
3154 * @param size new size
3156 void av_shrink_packet(AVPacket *pkt, int size);
3159 * Increase packet size, correctly zeroing padding
3162 * @param grow_by number of bytes by which to increase the size of the packet
3164 int av_grow_packet(AVPacket *pkt, int grow_by);
3167 * Initialize a reference-counted packet from av_malloc()ed data.
3169 * @param pkt packet to be initialized. This function will set the data, size,
3170 * buf and destruct fields, all others are left untouched.
3171 * @param data Data allocated by av_malloc() to be used as packet data. If this
3172 * function returns successfully, the data is owned by the underlying AVBuffer.
3173 * The caller may not access the data through other means.
3174 * @param size size of data in bytes, without the padding. I.e. the full buffer
3175 * size is assumed to be size + FF_INPUT_BUFFER_PADDING_SIZE.
3177 * @return 0 on success, a negative AVERROR on error
3179 int av_packet_from_data(AVPacket *pkt, uint8_t *data, int size);
3182 * @warning This is a hack - the packet memory allocation stuff is broken. The
3183 * packet is allocated if it was not really allocated.
3185 int av_dup_packet(AVPacket *pkt);
3190 * @param pkt packet to free
3192 void av_free_packet(AVPacket *pkt);
3195 * Allocate new information of a packet.
3198 * @param type side information type
3199 * @param size side information size
3200 * @return pointer to fresh allocated data or NULL otherwise
3202 uint8_t* av_packet_new_side_data(AVPacket *pkt, enum AVPacketSideDataType type,
3206 * Shrink the already allocated side data buffer
3209 * @param type side information type
3210 * @param size new side information size
3211 * @return 0 on success, < 0 on failure
3213 int av_packet_shrink_side_data(AVPacket *pkt, enum AVPacketSideDataType type,
3217 * Get side information from packet.
3220 * @param type desired side information type
3221 * @param size pointer for side information size to store (optional)
3222 * @return pointer to data if present or NULL otherwise
3224 uint8_t* av_packet_get_side_data(AVPacket *pkt, enum AVPacketSideDataType type,
3232 * @addtogroup lavc_decoding
3237 * Find a registered decoder with a matching codec ID.
3239 * @param id AVCodecID of the requested decoder
3240 * @return A decoder if one was found, NULL otherwise.
3242 AVCodec *avcodec_find_decoder(enum AVCodecID id);
3245 * Find a registered decoder with the specified name.
3247 * @param name name of the requested decoder
3248 * @return A decoder if one was found, NULL otherwise.
3250 AVCodec *avcodec_find_decoder_by_name(const char *name);
3252 #if FF_API_GET_BUFFER
3253 attribute_deprecated int avcodec_default_get_buffer(AVCodecContext *s, AVFrame *pic);
3254 attribute_deprecated void avcodec_default_release_buffer(AVCodecContext *s, AVFrame *pic);
3255 attribute_deprecated int avcodec_default_reget_buffer(AVCodecContext *s, AVFrame *pic);
3259 * The default callback for AVCodecContext.get_buffer2(). It is made public so
3260 * it can be called by custom get_buffer2() implementations for decoders without
3261 * CODEC_CAP_DR1 set.
3263 int avcodec_default_get_buffer2(AVCodecContext *s, AVFrame *frame, int flags);
3266 * Return the amount of padding in pixels which the get_buffer callback must
3267 * provide around the edge of the image for codecs which do not have the
3268 * CODEC_FLAG_EMU_EDGE flag.
3270 * @return Required padding in pixels.
3272 unsigned avcodec_get_edge_width(void);
3275 * Modify width and height values so that they will result in a memory
3276 * buffer that is acceptable for the codec if you do not use any horizontal
3279 * May only be used if a codec with CODEC_CAP_DR1 has been opened.
3280 * If CODEC_FLAG_EMU_EDGE is not set, the dimensions must have been increased
3281 * according to avcodec_get_edge_width() before.
3283 void avcodec_align_dimensions(AVCodecContext *s, int *width, int *height);
3286 * Modify width and height values so that they will result in a memory
3287 * buffer that is acceptable for the codec if you also ensure that all
3288 * line sizes are a multiple of the respective linesize_align[i].
3290 * May only be used if a codec with CODEC_CAP_DR1 has been opened.
3291 * If CODEC_FLAG_EMU_EDGE is not set, the dimensions must have been increased
3292 * according to avcodec_get_edge_width() before.
3294 void avcodec_align_dimensions2(AVCodecContext *s, int *width, int *height,
3295 int linesize_align[AV_NUM_DATA_POINTERS]);
3298 * Decode the audio frame of size avpkt->size from avpkt->data into frame.
3300 * Some decoders may support multiple frames in a single AVPacket. Such
3301 * decoders would then just decode the first frame. In this case,
3302 * avcodec_decode_audio4 has to be called again with an AVPacket containing
3303 * the remaining data in order to decode the second frame, etc...
3304 * Even if no frames are returned, the packet needs to be fed to the decoder
3305 * with remaining data until it is completely consumed or an error occurs.
3307 * @warning The input buffer, avpkt->data must be FF_INPUT_BUFFER_PADDING_SIZE
3308 * larger than the actual read bytes because some optimized bitstream
3309 * readers read 32 or 64 bits at once and could read over the end.
3311 * @note You might have to align the input buffer. The alignment requirements
3312 * depend on the CPU and the decoder.
3314 * @param avctx the codec context
3315 * @param[out] frame The AVFrame in which to store decoded audio samples.
3316 * Decoders request a buffer of a particular size by setting
3317 * AVFrame.nb_samples prior to calling get_buffer(). The
3318 * decoder may, however, only utilize part of the buffer by
3319 * setting AVFrame.nb_samples to a smaller value in the
3321 * @param[out] got_frame_ptr Zero if no frame could be decoded, otherwise it is
3323 * @param[in] avpkt The input AVPacket containing the input buffer.
3324 * At least avpkt->data and avpkt->size should be set. Some
3325 * decoders might also require additional fields to be set.
3326 * @return A negative error code is returned if an error occurred during
3327 * decoding, otherwise the number of bytes consumed from the input
3328 * AVPacket is returned.
3330 int avcodec_decode_audio4(AVCodecContext *avctx, AVFrame *frame,
3331 int *got_frame_ptr, AVPacket *avpkt);
3334 * Decode the video frame of size avpkt->size from avpkt->data into picture.
3335 * Some decoders may support multiple frames in a single AVPacket, such
3336 * decoders would then just decode the first frame.
3338 * @warning The input buffer must be FF_INPUT_BUFFER_PADDING_SIZE larger than
3339 * the actual read bytes because some optimized bitstream readers read 32 or 64
3340 * bits at once and could read over the end.
3342 * @warning The end of the input buffer buf should be set to 0 to ensure that
3343 * no overreading happens for damaged MPEG streams.
3345 * @note You might have to align the input buffer avpkt->data.
3346 * The alignment requirements depend on the CPU: on some CPUs it isn't
3347 * necessary at all, on others it won't work at all if not aligned and on others
3348 * it will work but it will have an impact on performance.
3350 * In practice, avpkt->data should have 4 byte alignment at minimum.
3352 * @note Codecs which have the CODEC_CAP_DELAY capability set have a delay
3353 * between input and output, these need to be fed with avpkt->data=NULL,
3354 * avpkt->size=0 at the end to return the remaining frames.
3356 * @param avctx the codec context
3357 * @param[out] picture The AVFrame in which the decoded video frame will be stored.
3358 * Use avcodec_alloc_frame to get an AVFrame, the codec will
3359 * allocate memory for the actual bitmap.
3360 * with default get/release_buffer(), the decoder frees/reuses the bitmap as it sees fit.
3361 * with overridden get/release_buffer() (needs CODEC_CAP_DR1) the user decides into what buffer the decoder
3362 * decodes and the decoder tells the user once it does not need the data anymore,
3363 * the user app can at this point free/reuse/keep the memory as it sees fit.
3365 * @param[in] avpkt The input AVpacket containing the input buffer.
3366 * You can create such packet with av_init_packet() and by then setting
3367 * data and size, some decoders might in addition need other fields like
3368 * flags&AV_PKT_FLAG_KEY. All decoders are designed to use the least
3370 * @param[in,out] got_picture_ptr Zero if no frame could be decompressed, otherwise, it is nonzero.
3371 * @return On error a negative value is returned, otherwise the number of bytes
3372 * used or zero if no frame could be decompressed.
3374 int avcodec_decode_video2(AVCodecContext *avctx, AVFrame *picture,
3375 int *got_picture_ptr,
3379 * Decode a subtitle message.
3380 * Return a negative value on error, otherwise return the number of bytes used.
3381 * If no subtitle could be decompressed, got_sub_ptr is zero.
3382 * Otherwise, the subtitle is stored in *sub.
3383 * Note that CODEC_CAP_DR1 is not available for subtitle codecs. This is for
3384 * simplicity, because the performance difference is expect to be negligible
3385 * and reusing a get_buffer written for video codecs would probably perform badly
3386 * due to a potentially very different allocation pattern.
3388 * @param avctx the codec context
3389 * @param[out] sub The AVSubtitle in which the decoded subtitle will be stored, must be
3390 freed with avsubtitle_free if *got_sub_ptr is set.
3391 * @param[in,out] got_sub_ptr Zero if no subtitle could be decompressed, otherwise, it is nonzero.
3392 * @param[in] avpkt The input AVPacket containing the input buffer.
3394 int avcodec_decode_subtitle2(AVCodecContext *avctx, AVSubtitle *sub,
3399 * @defgroup lavc_parsing Frame parsing
3403 typedef struct AVCodecParserContext {
3405 struct AVCodecParser *parser;
3406 int64_t frame_offset; /* offset of the current frame */
3407 int64_t cur_offset; /* current offset
3408 (incremented by each av_parser_parse()) */
3409 int64_t next_frame_offset; /* offset of the next frame */
3411 int pict_type; /* XXX: Put it back in AVCodecContext. */
3413 * This field is used for proper frame duration computation in lavf.
3414 * It signals, how much longer the frame duration of the current frame
3415 * is compared to normal frame duration.
3417 * frame_duration = (1 + repeat_pict) * time_base
3419 * It is used by codecs like H.264 to display telecined material.
3421 int repeat_pict; /* XXX: Put it back in AVCodecContext. */
3422 int64_t pts; /* pts of the current frame */
3423 int64_t dts; /* dts of the current frame */
3428 int fetch_timestamp;
3430 #define AV_PARSER_PTS_NB 4
3431 int cur_frame_start_index;
3432 int64_t cur_frame_offset[AV_PARSER_PTS_NB];
3433 int64_t cur_frame_pts[AV_PARSER_PTS_NB];
3434 int64_t cur_frame_dts[AV_PARSER_PTS_NB];
3437 #define PARSER_FLAG_COMPLETE_FRAMES 0x0001
3438 #define PARSER_FLAG_ONCE 0x0002
3439 /// Set if the parser has a valid file offset
3440 #define PARSER_FLAG_FETCHED_OFFSET 0x0004
3442 int64_t offset; ///< byte offset from starting packet start
3443 int64_t cur_frame_end[AV_PARSER_PTS_NB];
3446 * Set by parser to 1 for key frames and 0 for non-key frames.
3447 * It is initialized to -1, so if the parser doesn't set this flag,
3448 * old-style fallback using AV_PICTURE_TYPE_I picture type as key frames
3454 * Time difference in stream time base units from the pts of this
3455 * packet to the point at which the output from the decoder has converged
3456 * independent from the availability of previous frames. That is, the
3457 * frames are virtually identical no matter if decoding started from
3458 * the very first frame or from this keyframe.
3459 * Is AV_NOPTS_VALUE if unknown.
3460 * This field is not the display duration of the current frame.
3461 * This field has no meaning if the packet does not have AV_PKT_FLAG_KEY
3464 * The purpose of this field is to allow seeking in streams that have no
3465 * keyframes in the conventional sense. It corresponds to the
3466 * recovery point SEI in H.264 and match_time_delta in NUT. It is also
3467 * essential for some types of subtitle streams to ensure that all
3468 * subtitles are correctly displayed after seeking.
3470 int64_t convergence_duration;
3472 // Timestamp generation support:
3474 * Synchronization point for start of timestamp generation.
3476 * Set to >0 for sync point, 0 for no sync point and <0 for undefined
3479 * For example, this corresponds to presence of H.264 buffering period
3485 * Offset of the current timestamp against last timestamp sync point in
3486 * units of AVCodecContext.time_base.
3488 * Set to INT_MIN when dts_sync_point unused. Otherwise, it must
3489 * contain a valid timestamp offset.
3491 * Note that the timestamp of sync point has usually a nonzero
3492 * dts_ref_dts_delta, which refers to the previous sync point. Offset of
3493 * the next frame after timestamp sync point will be usually 1.
3495 * For example, this corresponds to H.264 cpb_removal_delay.
3497 int dts_ref_dts_delta;
3500 * Presentation delay of current frame in units of AVCodecContext.time_base.
3502 * Set to INT_MIN when dts_sync_point unused. Otherwise, it must
3503 * contain valid non-negative timestamp delta (presentation time of a frame
3504 * must not lie in the past).
3506 * This delay represents the difference between decoding and presentation
3507 * time of the frame.
3509 * For example, this corresponds to H.264 dpb_output_delay.
3514 * Position of the packet in file.
3516 * Analogous to cur_frame_pts/dts
3518 int64_t cur_frame_pos[AV_PARSER_PTS_NB];
3521 * Byte position of currently parsed frame in stream.
3526 * Previous frame byte position.
3531 * Duration of the current frame.
3532 * For audio, this is in units of 1 / AVCodecContext.sample_rate.
3533 * For all other types, this is in units of AVCodecContext.time_base.
3536 } AVCodecParserContext;
3538 typedef struct AVCodecParser {
3539 int codec_ids[5]; /* several codec IDs are permitted */
3541 int (*parser_init)(AVCodecParserContext *s);
3542 int (*parser_parse)(AVCodecParserContext *s,
3543 AVCodecContext *avctx,
3544 const uint8_t **poutbuf, int *poutbuf_size,
3545 const uint8_t *buf, int buf_size);
3546 void (*parser_close)(AVCodecParserContext *s);
3547 int (*split)(AVCodecContext *avctx, const uint8_t *buf, int buf_size);
3548 struct AVCodecParser *next;
3551 AVCodecParser *av_parser_next(AVCodecParser *c);
3553 void av_register_codec_parser(AVCodecParser *parser);
3554 AVCodecParserContext *av_parser_init(int codec_id);
3559 * @param s parser context.
3560 * @param avctx codec context.
3561 * @param poutbuf set to pointer to parsed buffer or NULL if not yet finished.
3562 * @param poutbuf_size set to size of parsed buffer or zero if not yet finished.
3563 * @param buf input buffer.
3564 * @param buf_size input length, to signal EOF, this should be 0 (so that the last frame can be output).
3565 * @param pts input presentation timestamp.
3566 * @param dts input decoding timestamp.
3567 * @param pos input byte position in stream.
3568 * @return the number of bytes of the input bitstream used.
3573 * len = av_parser_parse2(myparser, AVCodecContext, &data, &size,
3580 * decode_frame(data, size);
3584 int av_parser_parse2(AVCodecParserContext *s,
3585 AVCodecContext *avctx,
3586 uint8_t **poutbuf, int *poutbuf_size,
3587 const uint8_t *buf, int buf_size,
3588 int64_t pts, int64_t dts,
3592 * @return 0 if the output buffer is a subset of the input, 1 if it is allocated and must be freed
3593 * @deprecated use AVBitstreamFilter
3595 int av_parser_change(AVCodecParserContext *s,
3596 AVCodecContext *avctx,
3597 uint8_t **poutbuf, int *poutbuf_size,
3598 const uint8_t *buf, int buf_size, int keyframe);
3599 void av_parser_close(AVCodecParserContext *s);
3607 * @addtogroup lavc_encoding
3612 * Find a registered encoder with a matching codec ID.
3614 * @param id AVCodecID of the requested encoder
3615 * @return An encoder if one was found, NULL otherwise.
3617 AVCodec *avcodec_find_encoder(enum AVCodecID id);
3620 * Find a registered encoder with the specified name.
3622 * @param name name of the requested encoder
3623 * @return An encoder if one was found, NULL otherwise.
3625 AVCodec *avcodec_find_encoder_by_name(const char *name);
3628 * Encode a frame of audio.
3630 * Takes input samples from frame and writes the next output packet, if
3631 * available, to avpkt. The output packet does not necessarily contain data for
3632 * the most recent frame, as encoders can delay, split, and combine input frames
3633 * internally as needed.
3635 * @param avctx codec context
3636 * @param avpkt output AVPacket.
3637 * The user can supply an output buffer by setting
3638 * avpkt->data and avpkt->size prior to calling the
3639 * function, but if the size of the user-provided data is not
3640 * large enough, encoding will fail. All other AVPacket fields
3641 * will be reset by the encoder using av_init_packet(). If
3642 * avpkt->data is NULL, the encoder will allocate it.
3643 * The encoder will set avpkt->size to the size of the
3646 * If this function fails or produces no output, avpkt will be
3647 * freed using av_free_packet() (i.e. avpkt->destruct will be
3648 * called to free the user supplied buffer).
3649 * @param[in] frame AVFrame containing the raw audio data to be encoded.
3650 * May be NULL when flushing an encoder that has the
3651 * CODEC_CAP_DELAY capability set.
3652 * If CODEC_CAP_VARIABLE_FRAME_SIZE is set, then each frame
3653 * can have any number of samples.
3654 * If it is not set, frame->nb_samples must be equal to
3655 * avctx->frame_size for all frames except the last.
3656 * The final frame may be smaller than avctx->frame_size.
3657 * @param[out] got_packet_ptr This field is set to 1 by libavcodec if the
3658 * output packet is non-empty, and to 0 if it is
3659 * empty. If the function returns an error, the
3660 * packet can be assumed to be invalid, and the
3661 * value of got_packet_ptr is undefined and should
3663 * @return 0 on success, negative error code on failure
3665 int avcodec_encode_audio2(AVCodecContext *avctx, AVPacket *avpkt,
3666 const AVFrame *frame, int *got_packet_ptr);
3669 * Encode a frame of video.
3671 * Takes input raw video data from frame and writes the next output packet, if
3672 * available, to avpkt. The output packet does not necessarily contain data for
3673 * the most recent frame, as encoders can delay and reorder input frames
3674 * internally as needed.
3676 * @param avctx codec context
3677 * @param avpkt output AVPacket.
3678 * The user can supply an output buffer by setting
3679 * avpkt->data and avpkt->size prior to calling the
3680 * function, but if the size of the user-provided data is not
3681 * large enough, encoding will fail. All other AVPacket fields
3682 * will be reset by the encoder using av_init_packet(). If
3683 * avpkt->data is NULL, the encoder will allocate it.
3684 * The encoder will set avpkt->size to the size of the
3685 * output packet. The returned data (if any) belongs to the
3686 * caller, he is responsible for freeing it.
3688 * If this function fails or produces no output, avpkt will be
3689 * freed using av_free_packet() (i.e. avpkt->destruct will be
3690 * called to free the user supplied buffer).
3691 * @param[in] frame AVFrame containing the raw video data to be encoded.
3692 * May be NULL when flushing an encoder that has the
3693 * CODEC_CAP_DELAY capability set.
3694 * @param[out] got_packet_ptr This field is set to 1 by libavcodec if the
3695 * output packet is non-empty, and to 0 if it is
3696 * empty. If the function returns an error, the
3697 * packet can be assumed to be invalid, and the
3698 * value of got_packet_ptr is undefined and should
3700 * @return 0 on success, negative error code on failure
3702 int avcodec_encode_video2(AVCodecContext *avctx, AVPacket *avpkt,
3703 const AVFrame *frame, int *got_packet_ptr);
3705 int avcodec_encode_subtitle(AVCodecContext *avctx, uint8_t *buf, int buf_size,
3706 const AVSubtitle *sub);
3713 #if FF_API_AVCODEC_RESAMPLE
3715 * @defgroup lavc_resample Audio resampling
3717 * @deprecated use libavresample instead
3721 struct ReSampleContext;
3722 struct AVResampleContext;
3724 typedef struct ReSampleContext ReSampleContext;
3727 * Initialize audio resampling context.
3729 * @param output_channels number of output channels
3730 * @param input_channels number of input channels
3731 * @param output_rate output sample rate
3732 * @param input_rate input sample rate
3733 * @param sample_fmt_out requested output sample format
3734 * @param sample_fmt_in input sample format
3735 * @param filter_length length of each FIR filter in the filterbank relative to the cutoff frequency
3736 * @param log2_phase_count log2 of the number of entries in the polyphase filterbank
3737 * @param linear if 1 then the used FIR filter will be linearly interpolated
3738 between the 2 closest, if 0 the closest will be used
3739 * @param cutoff cutoff frequency, 1.0 corresponds to half the output sampling rate
3740 * @return allocated ReSampleContext, NULL if error occurred
3742 attribute_deprecated
3743 ReSampleContext *av_audio_resample_init(int output_channels, int input_channels,
3744 int output_rate, int input_rate,
3745 enum AVSampleFormat sample_fmt_out,
3746 enum AVSampleFormat sample_fmt_in,
3747 int filter_length, int log2_phase_count,
3748 int linear, double cutoff);
3750 attribute_deprecated
3751 int audio_resample(ReSampleContext *s, short *output, short *input, int nb_samples);
3754 * Free resample context.
3756 * @param s a non-NULL pointer to a resample context previously
3757 * created with av_audio_resample_init()
3759 attribute_deprecated
3760 void audio_resample_close(ReSampleContext *s);
3764 * Initialize an audio resampler.
3765 * Note, if either rate is not an integer then simply scale both rates up so they are.
3766 * @param filter_length length of each FIR filter in the filterbank relative to the cutoff freq
3767 * @param log2_phase_count log2 of the number of entries in the polyphase filterbank
3768 * @param linear If 1 then the used FIR filter will be linearly interpolated
3769 between the 2 closest, if 0 the closest will be used
3770 * @param cutoff cutoff frequency, 1.0 corresponds to half the output sampling rate
3772 attribute_deprecated
3773 struct AVResampleContext *av_resample_init(int out_rate, int in_rate, int filter_length, int log2_phase_count, int linear, double cutoff);
3776 * Resample an array of samples using a previously configured context.
3777 * @param src an array of unconsumed samples
3778 * @param consumed the number of samples of src which have been consumed are returned here
3779 * @param src_size the number of unconsumed samples available
3780 * @param dst_size the amount of space in samples available in dst
3781 * @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.
3782 * @return the number of samples written in dst or -1 if an error occurred
3784 attribute_deprecated
3785 int av_resample(struct AVResampleContext *c, short *dst, short *src, int *consumed, int src_size, int dst_size, int update_ctx);
3789 * Compensate samplerate/timestamp drift. The compensation is done by changing
3790 * the resampler parameters, so no audible clicks or similar distortions occur
3791 * @param compensation_distance distance in output samples over which the compensation should be performed
3792 * @param sample_delta number of output samples which should be output less
3794 * example: av_resample_compensate(c, 10, 500)
3795 * here instead of 510 samples only 500 samples would be output
3797 * note, due to rounding the actual compensation might be slightly different,
3798 * especially if the compensation_distance is large and the in_rate used during init is small
3800 attribute_deprecated
3801 void av_resample_compensate(struct AVResampleContext *c, int sample_delta, int compensation_distance);
3802 attribute_deprecated
3803 void av_resample_close(struct AVResampleContext *c);
3811 * @addtogroup lavc_picture
3816 * Allocate memory for a picture. Call avpicture_free() to free it.
3818 * @see avpicture_fill()
3820 * @param picture the picture to be filled in
3821 * @param pix_fmt the format of the picture
3822 * @param width the width of the picture
3823 * @param height the height of the picture
3824 * @return zero if successful, a negative value if not
3826 int avpicture_alloc(AVPicture *picture, enum AVPixelFormat pix_fmt, int width, int height);
3829 * Free a picture previously allocated by avpicture_alloc().
3830 * The data buffer used by the AVPicture is freed, but the AVPicture structure
3833 * @param picture the AVPicture to be freed
3835 void avpicture_free(AVPicture *picture);
3838 * Fill in the AVPicture fields.
3839 * The fields of the given AVPicture are filled in by using the 'ptr' address
3840 * which points to the image data buffer. Depending on the specified picture
3841 * format, one or multiple image data pointers and line sizes will be set.
3842 * If a planar format is specified, several pointers will be set pointing to
3843 * the different picture planes and the line sizes of the different planes
3844 * will be stored in the lines_sizes array.
3845 * Call with ptr == NULL to get the required size for the ptr buffer.
3847 * To allocate the buffer and fill in the AVPicture fields in one call,
3848 * use avpicture_alloc().
3850 * @param picture AVPicture whose fields are to be filled in
3851 * @param ptr Buffer which will contain or contains the actual image data
3852 * @param pix_fmt The format in which the picture data is stored.
3853 * @param width the width of the image in pixels
3854 * @param height the height of the image in pixels
3855 * @return size of the image data in bytes
3857 int avpicture_fill(AVPicture *picture, uint8_t *ptr,
3858 enum AVPixelFormat pix_fmt, int width, int height);
3861 * Copy pixel data from an AVPicture into a buffer.
3862 * The data is stored compactly, without any gaps for alignment or padding
3863 * which may be applied by avpicture_fill().
3865 * @see avpicture_get_size()
3867 * @param[in] src AVPicture containing image data
3868 * @param[in] pix_fmt The format in which the picture data is stored.
3869 * @param[in] width the width of the image in pixels.
3870 * @param[in] height the height of the image in pixels.
3871 * @param[out] dest A buffer into which picture data will be copied.
3872 * @param[in] dest_size The size of 'dest'.
3873 * @return The number of bytes written to dest, or a negative value (error code) on error.
3875 int avpicture_layout(const AVPicture* src, enum AVPixelFormat pix_fmt,
3876 int width, int height,
3877 unsigned char *dest, int dest_size);
3880 * Calculate the size in bytes that a picture of the given width and height
3881 * would occupy if stored in the given picture format.
3882 * Note that this returns the size of a compact representation as generated
3883 * by avpicture_layout(), which can be smaller than the size required for e.g.
3886 * @param pix_fmt the given picture format
3887 * @param width the width of the image
3888 * @param height the height of the image
3889 * @return Image data size in bytes or -1 on error (e.g. too large dimensions).
3891 int avpicture_get_size(enum AVPixelFormat pix_fmt, int width, int height);
3893 #if FF_API_DEINTERLACE
3895 * deinterlace - if not supported return -1
3897 * @deprecated - use yadif (in libavfilter) instead
3899 attribute_deprecated
3900 int avpicture_deinterlace(AVPicture *dst, const AVPicture *src,
3901 enum AVPixelFormat pix_fmt, int width, int height);
3904 * Copy image src to dst. Wraps av_picture_data_copy() above.
3906 void av_picture_copy(AVPicture *dst, const AVPicture *src,
3907 enum AVPixelFormat pix_fmt, int width, int height);
3910 * Crop image top and left side.
3912 int av_picture_crop(AVPicture *dst, const AVPicture *src,
3913 enum AVPixelFormat pix_fmt, int top_band, int left_band);
3918 int av_picture_pad(AVPicture *dst, const AVPicture *src, int height, int width, enum AVPixelFormat pix_fmt,
3919 int padtop, int padbottom, int padleft, int padright, int *color);
3926 * @defgroup lavc_misc Utility functions
3929 * Miscellaneous utility functions related to both encoding and decoding
3935 * @defgroup lavc_misc_pixfmt Pixel formats
3937 * Functions for working with pixel formats.
3942 * @deprecated Use av_pix_fmt_get_chroma_sub_sample
3945 void attribute_deprecated avcodec_get_chroma_sub_sample(enum AVPixelFormat pix_fmt, int *h_shift, int *v_shift);
3948 * Return a value representing the fourCC code associated to the
3949 * pixel format pix_fmt, or 0 if no associated fourCC code can be
3952 unsigned int avcodec_pix_fmt_to_codec_tag(enum AVPixelFormat pix_fmt);
3954 #define FF_LOSS_RESOLUTION 0x0001 /**< loss due to resolution change */
3955 #define FF_LOSS_DEPTH 0x0002 /**< loss due to color depth change */
3956 #define FF_LOSS_COLORSPACE 0x0004 /**< loss due to color space conversion */
3957 #define FF_LOSS_ALPHA 0x0008 /**< loss of alpha bits */
3958 #define FF_LOSS_COLORQUANT 0x0010 /**< loss due to color quantization */
3959 #define FF_LOSS_CHROMA 0x0020 /**< loss of chroma (e.g. RGB to gray conversion) */
3962 * Compute what kind of losses will occur when converting from one specific
3963 * pixel format to another.
3964 * When converting from one pixel format to another, information loss may occur.
3965 * For example, when converting from RGB24 to GRAY, the color information will
3966 * be lost. Similarly, other losses occur when converting from some formats to
3967 * other formats. These losses can involve loss of chroma, but also loss of
3968 * resolution, loss of color depth, loss due to the color space conversion, loss
3969 * of the alpha bits or loss due to color quantization.
3970 * avcodec_get_fix_fmt_loss() informs you about the various types of losses
3971 * which will occur when converting from one pixel format to another.
3973 * @param[in] dst_pix_fmt destination pixel format
3974 * @param[in] src_pix_fmt source pixel format
3975 * @param[in] has_alpha Whether the source pixel format alpha channel is used.
3976 * @return Combination of flags informing you what kind of losses will occur.
3978 int avcodec_get_pix_fmt_loss(enum AVPixelFormat dst_pix_fmt, enum AVPixelFormat src_pix_fmt,
3982 * Find the best pixel format to convert to given a certain source pixel
3983 * format. When converting from one pixel format to another, information loss
3984 * may occur. For example, when converting from RGB24 to GRAY, the color
3985 * information will be lost. Similarly, other losses occur when converting from
3986 * some formats to other formats. avcodec_find_best_pix_fmt2() searches which of
3987 * the given pixel formats should be used to suffer the least amount of loss.
3988 * The pixel formats from which it chooses one, are determined by the
3989 * pix_fmt_list parameter.
3992 * @param[in] pix_fmt_list AV_PIX_FMT_NONE terminated array of pixel formats to choose from
3993 * @param[in] src_pix_fmt source pixel format
3994 * @param[in] has_alpha Whether the source pixel format alpha channel is used.
3995 * @param[out] loss_ptr Combination of flags informing you what kind of losses will occur.
3996 * @return The best pixel format to convert to or -1 if none was found.
3998 enum AVPixelFormat avcodec_find_best_pix_fmt2(enum AVPixelFormat *pix_fmt_list,
3999 enum AVPixelFormat src_pix_fmt,
4000 int has_alpha, int *loss_ptr);
4002 enum AVPixelFormat avcodec_default_get_format(struct AVCodecContext *s, const enum AVPixelFormat * fmt);
4008 void avcodec_set_dimensions(AVCodecContext *s, int width, int height);
4011 * Put a string representing the codec tag codec_tag in buf.
4013 * @param buf_size size in bytes of buf
4014 * @return the length of the string that would have been generated if
4015 * enough space had been available, excluding the trailing null
4017 size_t av_get_codec_tag_string(char *buf, size_t buf_size, unsigned int codec_tag);
4019 void avcodec_string(char *buf, int buf_size, AVCodecContext *enc, int encode);
4022 * Return a name for the specified profile, if available.
4024 * @param codec the codec that is searched for the given profile
4025 * @param profile the profile value for which a name is requested
4026 * @return A name for the profile if found, NULL otherwise.
4028 const char *av_get_profile_name(const AVCodec *codec, int profile);
4030 int avcodec_default_execute(AVCodecContext *c, int (*func)(AVCodecContext *c2, void *arg2),void *arg, int *ret, int count, int size);
4031 int avcodec_default_execute2(AVCodecContext *c, int (*func)(AVCodecContext *c2, void *arg2, int, int),void *arg, int *ret, int count);
4032 //FIXME func typedef
4035 * Fill audio frame data and linesize.
4036 * AVFrame extended_data channel pointers are allocated if necessary for
4039 * @param frame the AVFrame
4040 * frame->nb_samples must be set prior to calling the
4041 * function. This function fills in frame->data,
4042 * frame->extended_data, frame->linesize[0].
4043 * @param nb_channels channel count
4044 * @param sample_fmt sample format
4045 * @param buf buffer to use for frame data
4046 * @param buf_size size of buffer
4047 * @param align plane size sample alignment (0 = default)
4048 * @return 0 on success, negative error code on failure
4050 int avcodec_fill_audio_frame(AVFrame *frame, int nb_channels,
4051 enum AVSampleFormat sample_fmt, const uint8_t *buf,
4052 int buf_size, int align);
4055 * Flush buffers, should be called when seeking or when switching to a different stream.
4057 void avcodec_flush_buffers(AVCodecContext *avctx);
4060 * Return codec bits per sample.
4062 * @param[in] codec_id the codec
4063 * @return Number of bits per sample or zero if unknown for the given codec.
4065 int av_get_bits_per_sample(enum AVCodecID codec_id);
4068 * Return codec bits per sample.
4069 * Only return non-zero if the bits per sample is exactly correct, not an
4072 * @param[in] codec_id the codec
4073 * @return Number of bits per sample or zero if unknown for the given codec.
4075 int av_get_exact_bits_per_sample(enum AVCodecID codec_id);
4078 * Return audio frame duration.
4080 * @param avctx codec context
4081 * @param frame_bytes size of the frame, or 0 if unknown
4082 * @return frame duration, in samples, if known. 0 if not able to
4085 int av_get_audio_frame_duration(AVCodecContext *avctx, int frame_bytes);
4088 typedef struct AVBitStreamFilterContext {
4090 struct AVBitStreamFilter *filter;
4091 AVCodecParserContext *parser;
4092 struct AVBitStreamFilterContext *next;
4093 } AVBitStreamFilterContext;
4096 typedef struct AVBitStreamFilter {
4099 int (*filter)(AVBitStreamFilterContext *bsfc,
4100 AVCodecContext *avctx, const char *args,
4101 uint8_t **poutbuf, int *poutbuf_size,
4102 const uint8_t *buf, int buf_size, int keyframe);
4103 void (*close)(AVBitStreamFilterContext *bsfc);
4104 struct AVBitStreamFilter *next;
4105 } AVBitStreamFilter;
4107 void av_register_bitstream_filter(AVBitStreamFilter *bsf);
4108 AVBitStreamFilterContext *av_bitstream_filter_init(const char *name);
4109 int av_bitstream_filter_filter(AVBitStreamFilterContext *bsfc,
4110 AVCodecContext *avctx, const char *args,
4111 uint8_t **poutbuf, int *poutbuf_size,
4112 const uint8_t *buf, int buf_size, int keyframe);
4113 void av_bitstream_filter_close(AVBitStreamFilterContext *bsf);
4115 AVBitStreamFilter *av_bitstream_filter_next(AVBitStreamFilter *f);
4120 * Reallocate the given block if it is not large enough, otherwise do nothing.
4124 void *av_fast_realloc(void *ptr, unsigned int *size, size_t min_size);
4127 * Allocate a buffer, reusing the given one if large enough.
4129 * Contrary to av_fast_realloc the current buffer contents might not be
4130 * preserved and on error the old buffer is freed, thus no special
4131 * handling to avoid memleaks is necessary.
4133 * @param ptr pointer to pointer to already allocated buffer, overwritten with pointer to new buffer
4134 * @param size size of the buffer *ptr points to
4135 * @param min_size minimum size of *ptr buffer after returning, *ptr will be NULL and
4136 * *size 0 if an error occurred.
4138 void av_fast_malloc(void *ptr, unsigned int *size, size_t min_size);
4141 * Allocate a buffer with padding, reusing the given one if large enough.
4143 * Same behaviour av_fast_malloc but the buffer has additional
4144 * FF_INPUT_PADDING_SIZE at the end which will always memset to 0.
4147 void av_fast_padded_malloc(void *ptr, unsigned int *size, size_t min_size);
4150 * Encode extradata length to a buffer. Used by xiph codecs.
4152 * @param s buffer to write to; must be at least (v/255+1) bytes long
4153 * @param v size of extradata in bytes
4154 * @return number of bytes written to the buffer.
4156 unsigned int av_xiphlacing(unsigned char *s, unsigned int v);
4159 * Log a generic warning message about a missing feature. This function is
4160 * intended to be used internally by Libav (libavcodec, libavformat, etc.)
4161 * only, and would normally not be used by applications.
4162 * @param[in] avc a pointer to an arbitrary struct of which the first field is
4163 * a pointer to an AVClass struct
4164 * @param[in] feature string containing the name of the missing feature
4165 * @param[in] want_sample indicates if samples are wanted which exhibit this feature.
4166 * If want_sample is non-zero, additional verbage will be added to the log
4167 * message which tells the user how to report samples to the development
4170 void av_log_missing_feature(void *avc, const char *feature, int want_sample);
4173 * Log a generic warning message asking for a sample. This function is
4174 * intended to be used internally by Libav (libavcodec, libavformat, etc.)
4175 * only, and would normally not be used by applications.
4176 * @param[in] avc a pointer to an arbitrary struct of which the first field is
4177 * a pointer to an AVClass struct
4178 * @param[in] msg string containing an optional message, or NULL if no message
4180 void av_log_ask_for_sample(void *avc, const char *msg, ...) av_printf_format(2, 3);
4183 * Register the hardware accelerator hwaccel.
4185 void av_register_hwaccel(AVHWAccel *hwaccel);
4188 * If hwaccel is NULL, returns the first registered hardware accelerator,
4189 * if hwaccel is non-NULL, returns the next registered hardware accelerator
4190 * after hwaccel, or NULL if hwaccel is the last one.
4192 AVHWAccel *av_hwaccel_next(AVHWAccel *hwaccel);
4196 * Lock operation used by lockmgr
4199 AV_LOCK_CREATE, ///< Create a mutex
4200 AV_LOCK_OBTAIN, ///< Lock the mutex
4201 AV_LOCK_RELEASE, ///< Unlock the mutex
4202 AV_LOCK_DESTROY, ///< Free mutex resources
4206 * Register a user provided lock manager supporting the operations
4207 * specified by AVLockOp. mutex points to a (void *) where the
4208 * lockmgr should store/get a pointer to a user allocated mutex. It's
4209 * NULL upon AV_LOCK_CREATE and != NULL for all other ops.
4211 * @param cb User defined callback. Note: Libav may invoke calls to this
4212 * callback during the call to av_lockmgr_register().
4213 * Thus, the application must be prepared to handle that.
4214 * If cb is set to NULL the lockmgr will be unregistered.
4215 * Also note that during unregistration the previously registered
4216 * lockmgr callback may also be invoked.
4218 int av_lockmgr_register(int (*cb)(void **mutex, enum AVLockOp op));
4221 * Get the type of the given codec.
4223 enum AVMediaType avcodec_get_type(enum AVCodecID codec_id);
4226 * @return a positive value if s is open (i.e. avcodec_open2() was called on it
4227 * with no corresponding avcodec_close()), 0 otherwise.
4229 int avcodec_is_open(AVCodecContext *s);
4232 * @return a non-zero number if codec is an encoder, zero otherwise
4234 int av_codec_is_encoder(const AVCodec *codec);
4237 * @return a non-zero number if codec is a decoder, zero otherwise
4239 int av_codec_is_decoder(const AVCodec *codec);
4242 * @return descriptor for given codec ID or NULL if no descriptor exists.
4244 const AVCodecDescriptor *avcodec_descriptor_get(enum AVCodecID id);
4247 * Iterate over all codec descriptors known to libavcodec.
4249 * @param prev previous descriptor. NULL to get the first descriptor.
4251 * @return next descriptor or NULL after the last descriptor
4253 const AVCodecDescriptor *avcodec_descriptor_next(const AVCodecDescriptor *prev);
4256 * @return codec descriptor with the given name or NULL if no such descriptor
4259 const AVCodecDescriptor *avcodec_descriptor_get_by_name(const char *name);
4265 #endif /* AVCODEC_AVCODEC_H */